\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename python.info
@documentencoding UTF-8
@ifinfo
@*Generated by Sphinx 8.2.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.13.11, fevereiro 01, 2026

Author name not set

Copyright @copyright{} 2001-2026, 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{135}
@menu
* O que há de novo no Python:: 
* O tutorial do Python:: 
* Configurações e Uso do Python:: 
* A Referência da Linguagem Python:: 
* A Biblioteca Padrão do Python:: 
* Estendendo e incorporando o interpretador Python:: 
* Manual de referência da API Python/C:: 
* Instalando módulos Python:: 
* Python HOWTOs:: 
* Perguntas Frequentes Sobre Python:: 
* Descontinuações:: 
* Glossário:: 
* Sobre esta documentação:: 
* Lidando com bugs:: 
* Direitos autorais:: 
* História e Licença:: 
* Índice de Módulos Python:: 
* Índice:: 

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

O que há de novo no Python

* O que há de novo no Python 3.13: O que há de novo no Python 3 13. 
* O que há de novo no Python 3.12: O que há de novo no Python 3 12. 
* O que há de novo no Python 3.11: O que há de novo no Python 3 11. 
* O que há de novo no Python 3.10: O que há de novo no Python 3 10. 
* O que há de novo no Python 3.9: O que há de novo no Python 3 9. 
* O que há de novo no Python 3.8: O que há de novo no Python 3 8. 
* O que há de novo no Python 3.7: O que há de novo no Python 3 7. 
* What’s New In Python 3.6: What’s New In Python 3 6. 
* O que há de novo no Python 3.5: O que há de novo no Python 3 5. 
* O que há de novo no Python 3.4: O que há de novo no Python 3 4. 
* O que há de novo no Python 3.3: O que há de novo no Python 3 3. 
* O que há de novo no Python 3.2: O que há de novo no Python 3 2. 
* O que há de novo no Python 3.1: O que há de novo no Python 3 1. 
* O que há de novo no Python 3.0: O que há de novo no Python 3 0. 
* O que há de novo no Python 2.7: O que há de novo no Python 2 7. 
* O que há de novo no Python 2.6: O que há de novo no Python 2 6. 
* What’s New in Python 2.5: What’s New in Python 2 5. 
* What’s New in Python 2.4: What’s New in Python 2 4. 
* What’s New in Python 2.3: What’s New in Python 2 3. 
* What’s New in Python 2.2: What’s New in Python 2 2. 
* What’s New in Python 2.1: What’s New in Python 2 1. 
* What’s New in Python 2.0: What’s New in Python 2 0. 
* Changelog:: 

O que há de novo no Python 3.13

* Resumo – Destaques da versão:: 
* Novas funcionalidades:: 
* Outras mudanças na linguagem:: 
* Novos módulos:: 
* Módulos melhorados:: 
* Otimizações:: 
* Módulos e APIs removidas:: 
* Novas descontinuações:: 
* Alterações de bytecode do CPython:: 
* Alterações na API C:: 
* Mudanças na construção:: 
* Portando para o Python 3.13: Portando para o Python 3 13. 
* Mudanças em teste de regressão:: 
* Alterações notáveis no 3.13.1: Alterações notáveis no 3 13 1. 
* Alterações notáveis no 3.13.4: Alterações notáveis no 3 13 4. 

Novas funcionalidades

* Um melhor interpretador interativo:: 
* Mensagens de erro melhoradas:: 
* CPython com threads livres:: 
* Um compilador just-in-time (JIT) experimental: Um compilador just-in-time JIT experimental. 
* Definidas semânticas de mutação para locals(): Definidas semânticas de mutação para locals. 
* Suporte para plataformas móveis:: 

Módulos melhorados

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

Módulos e APIs removidas

* PEP 594; remove “baterias descarregadas” da biblioteca padrão: PEP 594 remove “baterias descarregadas” da biblioteca padrão. 
* 2to3:: 
* builtins:: 
* configparser: configparser<2>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* optparse:: 
* pathlib: pathlib<2>. 
* re: re<2>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<2>. 
* unittest:: 
* urllib:: 
* webbrowser:: 

Novas descontinuações

* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17. 
* Remoção pendente no Python 3.18: Remoção pendente no Python 3 18. 
* Remoção pendente em versões futuras:: 

Alterações na API C

* Novas funcionalidades: Novas funcionalidades<2>. 
* Alterações na API C: Alterações na API C<2>. 
* Mudanças na API C Limitada:: 
* APIs C removidas:: 
* APIs C descontinuadas:: 

APIs C descontinuadas

* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<2>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<2>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<2>. 

Portando para o Python 3.13

* Alterações na API Python:: 
* Alterações na API C: Alterações na API C<3>. 

Alterações notáveis no 3.13.1

* sys: sys<2>. 

Alterações notáveis no 3.13.4

* os.path: os path<2>. 
* tarfile:: 

O que há de novo no Python 3.12

* Resumo – Destaques da versão: Resumo – Destaques da versão<2>. 
* Novas funcionalidades: Novas funcionalidades<3>. 
* Novos recursos relacionados a dicas de tipo:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<2>. 
* Novos módulos: Novos módulos<2>. 
* Módulos melhorados: Módulos melhorados<2>. 
* Otimizações: Otimizações<2>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<2>. 
* Ferramentas e daemons:: 
* Descontinuados:: 
* Removidos:: 
* Portando para Python 3.12: Portando para Python 3 12. 
* Mudanças na construção: Mudanças na construção<2>. 
* Alterações na API C: Alterações na API C<4>. 

Novas funcionalidades

* PEP 695; Sintaxe do parâmetro de tipo: PEP 695 Sintaxe do parâmetro de tipo. 
* PEP 701; Formalização sintática de f-strings: PEP 701 Formalização sintática de f-strings. 
* PEP 684; Uma GIL por interpretador: PEP 684 Uma GIL por interpretador. 
* PEP 669; Monitoramento de baixo impacto para CPython: PEP 669 Monitoramento de baixo impacto para CPython. 
* PEP 688; Tornando o protocolo de buffer acessível no Python: PEP 688 Tornando o protocolo de buffer acessível no Python. 
* PEP 709; Fazendo inline de compreensão: PEP 709 Fazendo inline de compreensão. 
* Mensagens de erro melhoradas: Mensagens de erro melhoradas<2>. 

Novos recursos relacionados a dicas de tipo

* PEP 692; Usando TypedDict para tipagem mais precisa de **kwargs: PEP 692 Usando TypedDict para tipagem mais precisa de **kwargs. 
* PEP 698; Substitui decorador para tipagem estática: PEP 698 Substitui decorador para tipagem estática. 

Módulos melhorados

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

Descontinuados

* Remoção pendente no Python 3.13: Remoção pendente no Python 3 13. 
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<3>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<3>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<3>. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<3>. 

Removidos

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

Portando para Python 3.12

* Alterações na API Python: Alterações na API Python<2>. 

Alterações na API C

* Novas funcionalidades: Novas funcionalidades<4>. 
* Portando para Python 3.12: Portando para Python 3 12<2>. 
* Descontinuados: Descontinuados<2>. 
* Removidos: Removidos<2>. 

Descontinuados

* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<4>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<4>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<4>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<4>. 

O que há de novo no Python 3.11

* Resumo – Destaques da versão: Resumo – Destaques da versão<3>. 
* Novas funcionalidades: Novas funcionalidades<5>. 
* Novos recursos relacionados a dicas de tipo: Novos recursos relacionados a dicas de tipo<2>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<3>. 
* Outras mudanças na implementação do CPython:: 
* Novos módulos: Novos módulos<3>. 
* Módulos melhorados: Módulos melhorados<3>. 
* Otimizações: Otimizações<3>. 
* CPython mais rápido:: 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<3>. 
* Descontinuados: Descontinuados<3>. 
* Pendente remoção no Python 3.12: Pendente remoção no Python 3 12. 
* Removidos: Removidos<3>. 
* Portando para Python 3.11: Portando para Python 3 11. 
* Mudanças na construção: Mudanças na construção<3>. 
* Alterações na API C: Alterações na API C<5>. 
* Alterações notáveis no 3.11.4: Alterações notáveis no 3 11 4. 
* Alterações notáveis no 3.11.5: Alterações notáveis no 3 11 5. 

Novas funcionalidades

* PEP 657; Localizações de erros refinadas em tracebacks: PEP 657 Localizações de erros refinadas em tracebacks. 
* PEP 654; Grupos de exceção e except*: PEP 654 Grupos de exceção e except*. 
* PEP 678; Exceções podem ser enriquecidas com notas: PEP 678 Exceções podem ser enriquecidas com notas. 
* Melhorias no inicializador py.exe do Windows: Melhorias no inicializador py exe do Windows. 

Novos recursos relacionados a dicas de tipo

* PEP 646; Genéricos variádicos: PEP 646 Genéricos variádicos. 
* PEP 655; Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios: PEP 655 Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios. 
* PEP 673; Tipo Self: PEP 673 Tipo Self. 
* PEP 675; Tipo de string literal arbitrário: PEP 675 Tipo de string literal arbitrário. 
* PEP 681; Transformações de classe de dados: PEP 681 Transformações de classe de dados. 
* PEP 563 pode não ser o futuro:: 

Módulos melhorados

* asyncio: asyncio<3>. 
* contextlib:: 
* dataclasses:: 
* datetime:: 
* enum: enum<3>. 
* fcntl:: 
* fractions: fractions<3>. 
* functools:: 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE e idlelib:: 
* inspect: inspect<2>. 
* locale: locale<3>. 
* logging:: 
* math: math<3>. 
* operador:: 
* os: os<3>. 
* pathlib: pathlib<4>. 
* re: re<3>. 
* shutil: shutil<3>. 
* socket:: 
* sqlite3: sqlite3<4>. 
* string:: 
* sys: sys<4>. 
* sysconfig:: 
* tempfile: tempfile<3>. 
* threading: threading<2>. 
* time: time<2>. 
* tkinter: tkinter<3>. 
* traceback: traceback<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<4>. 
* venv: venv<2>. 
* avisos: avisos<2>. 
* zipfile:: 

CPython mais rápido

* Inicialização mais rápida:: 
* Tempo de execução mais rápido:: 
* Diversos:: 
* FAQ:: 
* Sobre:: 

Inicialização mais rápida

* Importações congeladas/objetos de código estático:: 

Tempo de execução mais rápido

* Quadros Python menos custosos e mais preguiçosos:: 
* Chamadas de função Python em linha:: 
* PEP 659; Interpretador adaptativo especializado: PEP 659 Interpretador adaptativo especializado. 

FAQ

* Como devo escrever meu código para utilizar esses aceleradores?:: 
* O CPython 3.11 usará mais memória?: O CPython 3 11 usará mais memória?. 
* Não vejo nenhuma aceleração em minha carga de trabalho. Por que?: Não vejo nenhuma aceleração em minha carga de trabalho Por que?. 
* Existe um compilador JIT?:: 

Alterações de bytecode do CPython

* Novos opcodes:: 
* Opcodes substituídos:: 
* Opcodes alterados/removidos:: 

Descontinuados

* Linguagem/Embutidos:: 
* Módulos:: 
* Biblioteca Padrão:: 

Alterações na API C

* Novas funcionalidades: Novas funcionalidades<6>. 
* Portando para Python 3.11: Portando para Python 3 11<2>. 
* Descontinuados: Descontinuados<4>. 
* Pendente remoção no Python 3.12: Pendente remoção no Python 3 12<2>. 
* Removidos: Removidos<4>. 

Alterações notáveis no 3.11.4

* tarfile: tarfile<2>. 

Alterações notáveis no 3.11.5

* OpenSSL:: 

O que há de novo no Python 3.10

* Resumo – Destaques da versão: Resumo – Destaques da versão<4>. 
* Novas funcionalidades: Novas funcionalidades<7>. 
* Novos recursos relacionados a dicas de tipo: Novos recursos relacionados a dicas de tipo<3>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<4>. 
* Novos módulos: Novos módulos<4>. 
* Módulos melhorados: Módulos melhorados<4>. 
* Otimizações: Otimizações<4>. 
* Descontinuados: Descontinuados<5>. 
* Removidos: Removidos<5>. 
* Portando para Python 3.10: Portando para Python 3 10. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<4>. 
* Mudanças na construção: Mudanças na construção<4>. 
* Alterações na API C: Alterações na API C<7>. 
* Recursos de segurança notáveis no 3.10.7: Recursos de segurança notáveis no 3 10 7. 
* Recursos de segurança notáveis no 3.10.8: Recursos de segurança notáveis no 3 10 8. 
* Alterações notáveis no 3.10.12: Alterações notáveis no 3 10 12. 

Novas funcionalidades

* Gerenciadores de contexto entre parênteses:: 
* Melhores mensagens de erro:: 
* PEP 626; Números de linha precisos para depuração e outras ferramentas: PEP 626 Números de linha precisos para depuração e outras ferramentas. 
* PEP 634; Correspondência de padrão estrutural: PEP 634 Correspondência de padrão estrutural. 
* EncodingWarning opcional e opção encoding="locale":: 

Melhores mensagens de erro

* SyntaxErrors:: 
* IndentationErrors:: 
* AttributeErrors:: 
* NameErrors:: 

PEP 634: Correspondência de padrão estrutural

* Sintaxe e operações:: 
* Abordagem declarativa:: 
* Padrão simples; corresponder a um literal: Padrão simples corresponder a um literal. 
* Padrões com uma literal e variável:: 
* Padrões e classes:: 
* Padrões aninhados:: 
* Padrões complexos e o curinga:: 
* Guarda:: 
* Outros recursos-chave:: 

Padrão simples: corresponder a um literal

* Comportamento sem o curinga:: 

Padrões e classes

* Padrões com parâmetros posicionais:: 

Novos recursos relacionados a dicas de tipo

* PEP 604; novo operador de união de tipo: PEP 604 novo operador de união de tipo. 
* PEP 612; variáveis de especificação de parâmetros: PEP 612 variáveis de especificação de parâmetros. 
* PEP 613; TypeAlias: PEP 613 TypeAlias. 
* PEP 647; guardas de tipo definidas pelo usuário: PEP 647 guardas de tipo definidas pelo usuário. 

Módulos melhorados

* asyncio: asyncio<4>. 
* argparse: argparse<2>. 
* array: array<3>. 
* asynchat@comma{} asyncore@comma{} smtpd: asynchat asyncore smtpd. 
* base64: base64<2>. 
* bdb:: 
* bisect:: 
* codecs:: 
* collections.abc: collections abc. 
* contextlib: contextlib<2>. 
* curses:: 
* dataclasses: dataclasses<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* encodings:: 
* enum: enum<4>. 
* fileinput:: 
* faulthandler:: 
* gc:: 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac:: 
* IDLE e idlelib: IDLE e idlelib<2>. 
* importlib.metadata: importlib metadata<2>. 
* inspect: inspect<3>. 
* itertools: itertools<3>. 
* linecache:: 
* os: os<4>. 
* os.path: os path<4>. 
* pathlib: pathlib<5>. 
* platform: platform<2>. 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* shelve:: 
* statistics: statistics<3>. 
* site: site<2>. 
* socket: socket<2>. 
* ssl: ssl<3>. 
* sqlite3: sqlite3<5>. 
* sys: sys<5>. 
* _thread:: 
* threading: threading<3>. 
* traceback: traceback<3>. 
* types: types<3>. 
* typing: typing<5>. 
* unittest: unittest<5>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

dataclasses

* __slots__:: 
* Campos somente-nomeados:: 

Portando para Python 3.10

* Alterações na sintaxe Python:: 
* Alterações na API Python: Alterações na API Python<3>. 
* Alterações na API C: Alterações na API C<6>. 

Alterações na API C

* PEP 652; Mantendo a ABI estável: PEP 652 Mantendo a ABI estável. 
* Novas funcionalidades: Novas funcionalidades<8>. 
* Portando para Python 3.10: Portando para Python 3 10<2>. 
* Descontinuados: Descontinuados<6>. 
* Removidos: Removidos<6>. 

Alterações notáveis no 3.10.12

* tarfile: tarfile<3>. 

O que há de novo no Python 3.9

* Resumo – Destaques da versão: Resumo – Destaques da versão<5>. 
* Você deve verificar DeprecationWarning no seu código:: 
* Novas funcionalidades: Novas funcionalidades<9>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<5>. 
* Novos módulos: Novos módulos<5>. 
* Módulos melhorados: Módulos melhorados<5>. 
* Otimizações: Otimizações<5>. 
* Descontinuados: Descontinuados<7>. 
* Removidos: Removidos<7>. 
* Portando para Python 3.9: Portando para Python 3 9. 
* Mudanças na construção: Mudanças na construção<5>. 
* Alterações na API C: Alterações na API C<9>. 
* Alterações notáveis no Python 3.9.1: Alterações notáveis no Python 3 9 1. 
* Alterações notáveis no Python 3.9.2: Alterações notáveis no Python 3 9 2. 
* Alterações notáveis no Python 3.9.3: Alterações notáveis no Python 3 9 3. 
* Alterações notáveis no Python 3.9.5: Alterações notáveis no Python 3 9 5. 
* Recursos de segurança notáveis no 3.9.14: Recursos de segurança notáveis no 3 9 14. 
* Alterações notáveis no 3.9.17: Alterações notáveis no 3 9 17. 

Novas funcionalidades

* Operadores de mesclagem & atualização de dicionário:: 
* Novos métodos de strings para remover prefixos e sufixos:: 
* Type hinting genéricos nas coleções padrão:: 
* Novo analisador sintático:: 

Novos módulos

* zoneinfo:: 
* graphlib:: 

Módulos melhorados

* ast: ast<2>. 
* asyncio: asyncio<5>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<2>. 
* curses: curses<2>. 
* datetime: datetime<2>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* gc: gc<2>. 
* hashlib: hashlib<4>. 
* http:: 
* IDLE e idlelib: IDLE e idlelib<3>. 
* imaplib:: 
* importlib: importlib<3>. 
* inspect: inspect<4>. 
* ipaddress: ipaddress<2>. 
* math: math<4>. 
* multiprocessing: multiprocessing<2>. 
* nntplib:: 
* os: os<5>. 
* pathlib: pathlib<6>. 
* pdb: pdb<3>. 
* poplib:: 
* pprint: pprint<2>. 
* pydoc:: 
* random: random<3>. 
* signal:: 
* smtplib:: 
* socket: socket<3>. 
* time: time<3>. 
* sys: sys<6>. 
* tracemalloc:: 
* typing: typing<6>. 
* unicodedata: unicodedata<4>. 
* venv: venv<3>. 
* xml: xml<3>. 

Portando para Python 3.9

* Alterações na API Python: Alterações na API Python<4>. 
* Alterações na API C: Alterações na API C<8>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<5>. 

Alterações na API C

* Novas funcionalidades: Novas funcionalidades<10>. 
* Portando para Python 3.9: Portando para Python 3 9<2>. 
* Removidos: Removidos<8>. 

Alterações notáveis no Python 3.9.1

* typing: typing<7>. 
* Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac: Suporte a macOS 11 0 Big Sur e Apple Silicon Mac. 

Alterações notáveis no Python 3.9.2

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

Alterações notáveis no Python 3.9.5

* urllib.parse: urllib parse<3>. 

Alterações notáveis no 3.9.17

* tarfile: tarfile<4>. 

O que há de novo no Python 3.8

* Resumo – Destaques da versão: Resumo – Destaques da versão<6>. 
* Novas funcionalidades: Novas funcionalidades<11>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<6>. 
* Novos módulos: Novos módulos<6>. 
* Módulos melhorados: Módulos melhorados<6>. 
* Otimizações: Otimizações<6>. 
* Mudanças a construções e API C:: 
* Descontinuados: Descontinuados<8>. 
* Remoção de APIs e recursos:: 
* Portando para o Python 3.8: Portando para o Python 3 8. 
* Alterações notáveis no Python 3.8.1: Alterações notáveis no Python 3 8 1. 
* Alterações notáveis no Python 3.8.2: Alterações notáveis no Python 3 8 2. 
* Alterações notáveis no Python 3.8.3: Alterações notáveis no Python 3 8 3. 
* Alterações notáveis no Python 3.8.8: Alterações notáveis no Python 3 8 8. 
* Alterações notáveis no Python 3.8.9: Alterações notáveis no Python 3 8 9. 
* Alterações notáveis no Python 3.8.10: Alterações notáveis no Python 3 8 10. 
* Alterações notáveis no Python 3.8.10: Alterações notáveis no Python 3 8 10<2>. 
* Alterações notáveis no Python 3.8.12: Alterações notáveis no Python 3 8 12. 
* Recursos de segurança notáveis no 3.8.14: Recursos de segurança notáveis no 3 8 14. 
* Alterações notáveis no 3.8.17: Alterações notáveis no 3 8 17. 

Novas funcionalidades

* Expressões de atribuição:: 
* Parâmetros somente-posicionais:: 
* Cache do sistema de arquivos paralelo para arquivos de bytecode compilados:: 
* A compilação de depuração usa a mesma ABI da compilação de lançamento:: 
* O suporte a f-strings = para expressões de auto-documentação e depuração:: 
* PEP 578; Ganchos de auditoria em tempo de execução Python: PEP 578 Ganchos de auditoria em tempo de execução Python. 
* PEP 587; Configuração de Inicialização do Python: PEP 587 Configuração de Inicialização do Python. 
* PEP 590; Vectorcall; um protocolo de chamada rápida para CPython: PEP 590 Vectorcall um protocolo de chamada rápida para CPython. 
* Protocolo de Pickle 5 com buffers de dados fora da banda:: 

Módulos melhorados

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

Portando para o Python 3.8

* Alterações no comportamento do Python:: 
* Alterações na API Python: Alterações na API Python<5>. 
* Alterações na API C: Alterações na API C<10>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<6>. 
* Ferramentas e daemons: Ferramentas e daemons<2>. 

Alterações notáveis no Python 3.8.10

* Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac: Suporte a macOS 11 0 Big Sur e Apple Silicon Mac<2>. 

Alterações notáveis no Python 3.8.10

* urllib.parse: urllib parse<4>. 

Alterações notáveis no Python 3.8.12

* Alterações na API Python: Alterações na API Python<6>. 

Alterações notáveis no 3.8.17

* tarfile: tarfile<6>. 

O que há de novo no Python 3.7

* Resumo – Destaques da versão: Resumo – Destaques da versão<7>. 
* Novas funcionalidades: Novas funcionalidades<12>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<7>. 
* Novos módulos: Novos módulos<7>. 
* Módulos melhorados: Módulos melhorados<7>. 
* Alterações na API C: Alterações na API C<11>. 
* Mudanças na construção: Mudanças na construção<6>. 
* Otimizações: Otimizações<7>. 
* Outras mudanças na implementação do CPython: Outras mudanças na implementação do CPython<2>. 
* Comportamento do Python descontinuado:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods. 
* Deprecated functions and types of the C API:: 
* Platform Support Removals:: 
* Remoção de APIs e recursos: Remoção de APIs e recursos<2>. 
* Module Removals:: 
* Windows-only Changes:: 
* Porting to Python 3.7: Porting to Python 3 7. 
* Notable changes in Python 3.7.1: Notable changes in Python 3 7 1. 
* Notable changes in Python 3.7.2: Notable changes in Python 3 7 2. 
* Notable changes in Python 3.7.6: Notable changes in Python 3 7 6. 
* Notable changes in Python 3.7.10: Notable changes in 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. 

Novas funcionalidades

* PEP 563; Avaliação Postergada de Anotações: PEP 563 Avaliação Postergada de Anotações. 
* PEP 538; Coerção de localidade C legada: PEP 538 Coerção de localidade C legada. 
* PEP 540; Modo de tempo de execução UTF-8 forçado: PEP 540 Modo de tempo de execução UTF-8 forçado. 
* PEP 553; breakpoint() embutida: PEP 553 breakpoint embutida. 
* PEP 539; Nova API C para armazenamento local de thread: PEP 539 Nova API C para armazenamento local de thread. 
* PEP 562; Personalização de acesso aos atributos do módulo: PEP 562 Personalização de acesso aos atributos do módulo. 
* PEP 564; Novas funções de tempo com resolução de nanossegundos: PEP 564 Novas funções de tempo com resolução de nanossegundos. 
* PEP 565; Mostra DeprecationWarning em __main__: PEP 565 Mostra DeprecationWarning em __main__. 
* PEP 560; Suporte básico para módulo typing e tipos genéricos: PEP 560 Suporte básico para módulo typing e tipos genéricos. 
* PEP 552; Arquivos .pyc baseados em hash: PEP 552 Arquivos pyc baseados em hash. 
* PEP 545; Traduções da documentação do Python: PEP 545 Traduções da documentação do Python. 
* Modo de Desenvolvimento do Python (-X dev): Modo de Desenvolvimento do Python -X dev. 

Novos módulos

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

Módulos melhorados

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

Deprecated Python modules, functions and methods

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

Porting to Python 3.7

* Changes in Python Behavior:: 
* Alterações na API Python: Alterações na API Python<7>. 
* Alterações na API C: Alterações na API C<12>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<7>. 
* Windows-only Changes: Windows-only Changes<2>. 
* Other CPython implementation changes:: 

What’s New In Python 3.6

* Resumo – Destaques da versão: Resumo – Destaques da versão<8>. 
* Novas funcionalidades: Novas funcionalidades<13>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<8>. 
* Novos módulos: Novos módulos<8>. 
* Módulos melhorados: Módulos melhorados<8>. 
* Otimizações: Otimizações<8>. 
* Mudanças a construções e API C: Mudanças a construções e API C<2>. 
* Other Improvements:: 
* Descontinuados: Descontinuados<9>. 
* Removidos: Removidos<9>. 
* Porting to Python 3.6: Porting to Python 3 6. 
* Notable changes in Python 3.6.2: Notable changes in Python 3 6 2. 
* Notable changes in Python 3.6.4: Notable changes in Python 3 6 4. 
* Notable changes in Python 3.6.5: Notable changes in Python 3 6 5. 
* Notable changes in Python 3.6.7: Notable changes in Python 3 6 7. 
* Notable changes in Python 3.6.10: Notable changes in Python 3 6 10. 
* Notable changes in Python 3.6.13: Notable changes in Python 3 6 13. 
* Notable changes in Python 3.6.14: Notable changes in Python 3 6 14. 

Novas funcionalidades

* PEP 498; Formatted string literals: PEP 498 Formatted string literals. 
* PEP 526; Syntax for variable annotations: PEP 526 Syntax for variable annotations. 
* PEP 515; Underscores in Numeric Literals: PEP 515 Underscores in Numeric Literals. 
* PEP 525; Asynchronous Generators: PEP 525 Asynchronous Generators. 
* PEP 530; Asynchronous Comprehensions: PEP 530 Asynchronous Comprehensions. 
* PEP 487; Simpler customization of class creation: PEP 487 Simpler customization of class creation. 
* PEP 487; Descriptor Protocol Enhancements: PEP 487 Descriptor Protocol Enhancements. 
* PEP 519; Adding a file system path protocol: PEP 519 Adding a file system path protocol. 
* PEP 495; Local Time Disambiguation: PEP 495 Local Time Disambiguation. 
* PEP 529; Change Windows filesystem encoding to UTF-8: PEP 529 Change Windows filesystem encoding to UTF-8. 
* PEP 528; Change Windows console encoding to UTF-8: PEP 528 Change Windows console encoding to UTF-8. 
* PEP 520; Preserving Class Attribute Definition Order: PEP 520 Preserving Class Attribute Definition Order. 
* PEP 468; Preserving Keyword Argument Order: PEP 468 Preserving Keyword Argument Order. 
* New dict implementation:: 
* PEP 523; Adding a frame evaluation API to CPython: PEP 523 Adding a frame evaluation API to CPython. 
* PYTHONMALLOC environment variable:: 
* DTrace and SystemTap probing support:: 

Novos módulos

* segredos:: 

Módulos melhorados

* array: array<4>. 
* ast: ast<4>. 
* asyncio: asyncio<9>. 
* binascii: binascii<2>. 
* cmath:: 
* collections: collections<4>. 
* concurrent.futures: concurrent futures<4>. 
* contextlib: contextlib<4>. 
* datetime: datetime<5>. 
* decimal: decimal<2>. 
* distutils: distutils<5>. 
* email: email<2>. 
* encodings: encodings<2>. 
* enum: enum<7>. 
* faulthandler: faulthandler<2>. 
* fileinput: fileinput<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib e IDLE: idlelib e IDLE<2>. 
* importlib: importlib<6>. 
* inspect: inspect<6>. 
* json:: 
* logging: logging<4>. 
* math: math<7>. 
* multiprocessing: multiprocessing<5>. 
* os: os<8>. 
* pathlib: pathlib<9>. 
* pdb: pdb<5>. 
* pickle: pickle<2>. 
* pickletools:: 
* pydoc: pydoc<3>. 
* random: random<4>. 
* re: re<5>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* site: site<3>. 
* sqlite3: sqlite3<7>. 
* socket: socket<7>. 
* socketserver: socketserver<2>. 
* ssl: ssl<7>. 
* statistics: statistics<5>. 
* struct:: 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* telnetlib:: 
* time: time<6>. 
* timeit:: 
* tkinter: tkinter<6>. 
* traceback: traceback<4>. 
* tracemalloc: tracemalloc<3>. 
* typing: typing<9>. 
* unicodedata: unicodedata<7>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* avisos: avisos<4>. 
* winreg:: 
* winsound:: 
* xmlrpc.client: xmlrpc client. 
* zipfile: zipfile<3>. 
* zlib:: 

Descontinuados

* New Keywords:: 
* Deprecated Python behavior:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<2>. 
* xml: xml<6>. 
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<2>. 
* Deprecated Build Options:: 

Deprecated Python modules, functions and methods

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

Removidos

* Remoção de APIs e recursos: Remoção de APIs e recursos<3>. 

Porting to Python 3.6

* Changes in ‘python’ Command Behavior:: 
* Alterações na API Python: Alterações na API Python<8>. 
* Alterações na API C: Alterações na API C<13>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<8>. 

Notable changes in Python 3.6.2

* Novo alvo de construção make regen-all:: 
* Remoção do alvo de construção make touch:: 

O que há de novo no Python 3.5

* Resumo – Destaques da versão: Resumo – Destaques da versão<9>. 
* Novas funcionalidades: Novas funcionalidades<14>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<9>. 
* Novos módulos: Novos módulos<9>. 
* Módulos melhorados: Módulos melhorados<9>. 
* Other module-level changes:: 
* Otimizações: Otimizações<9>. 
* Mudanças a construções e API C: Mudanças a construções e API C<3>. 
* Descontinuados: Descontinuados<10>. 
* Removidos: Removidos<10>. 
* Porting to Python 3.5: Porting to Python 3 5. 
* Notable changes in Python 3.5.4: Notable changes in Python 3 5 4. 

Novas funcionalidades

* PEP 492 - Coroutines with async and await syntax:: 
* PEP 465 - A dedicated infix operator for matrix multiplication:: 
* PEP 448 - Additional Unpacking Generalizations:: 
* PEP 461 - percent formatting support for bytes and bytearray:: 
* PEP 484 - Type Hints:: 
* PEP 471 - os.scandir() function – a better and faster directory iterator: PEP 471 - os scandir function – a better and faster directory iterator. 
* PEP 475; Retry system calls failing with EINTR: PEP 475 Retry system calls failing with EINTR. 
* PEP 479; Change StopIteration handling inside generators: PEP 479 Change StopIteration handling inside generators. 
* PEP 485; A function for testing approximate equality: PEP 485 A function for testing approximate equality. 
* PEP 486; Make the Python Launcher aware of virtual environments: PEP 486 Make the Python Launcher aware of virtual environments. 
* PEP 488; Elimination of PYO files: PEP 488 Elimination of PYO files. 
* PEP 489; Multi-phase extension module initialization: PEP 489 Multi-phase extension module initialization. 

Novos módulos

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

Módulos melhorados

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

ssl

* Підтримка BIO пам’яті:: 
* Application-Layer Protocol Negotiation Support:: 
* Other Changes:: 

Descontinuados

* New Keywords: New Keywords<2>. 
* Comportamento do Python descontinuado: Comportamento do Python descontinuado<2>. 
* Unsupported Operating Systems:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<3>. 

Removidos

* Remoção de APIs e recursos: Remoção de APIs e recursos<4>. 

Porting to Python 3.5

* Alterações no comportamento do Python: Alterações no comportamento do Python<2>. 
* Alterações na API Python: Alterações na API Python<9>. 
* Alterações na API C: Alterações na API C<14>. 

Notable changes in Python 3.5.4

* Novo alvo de construção make regen-all: Novo alvo de construção make regen-all<2>. 
* Remoção do alvo de construção make touch: Remoção do alvo de construção make touch<2>. 

O que há de novo no Python 3.4

* Resumo – Destaques da versão: Resumo – Destaques da versão<10>. 
* Novas funcionalidades: Novas funcionalidades<15>. 
* Novos módulos: Novos módulos<10>. 
* Módulos melhorados: Módulos melhorados<10>. 
* CPython Implementation Changes:: 
* Descontinuados: Descontinuados<11>. 
* Removidos: Removidos<11>. 
* Porting to Python 3.4: Porting to Python 3 4. 
* Alterado em 3.4.3: Alterado em 3 4 3. 

Novas funcionalidades

* PEP 453; Explicit Bootstrapping of PIP in Python Installations: PEP 453 Explicit Bootstrapping of PIP in Python Installations. 
* PEP 446; Newly Created File Descriptors Are Non-Inheritable: PEP 446 Newly Created File Descriptors Are Non-Inheritable. 
* Melhorias no manuseio de Codecs:: 
* PEP 451; A ModuleSpec Type for the Import System: PEP 451 A ModuleSpec Type for the Import System. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<10>. 

PEP 453: Explicit Bootstrapping of PIP in Python Installations

* Bootstrapping pip By Default:: 
* Mudanças na documentação:: 

Novos módulos

* asyncio: asyncio<11>. 
* ensurepip: ensurepip<2>. 
* enum: enum<9>. 
* pathlib: pathlib<11>. 
* selectors: selectors<2>. 
* statistics: statistics<6>. 
* tracemalloc: tracemalloc<4>. 

Módulos melhorados

* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<5>. 
* audioop:: 
* base64: base64<3>. 
* collections: collections<6>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<4>. 
* doctest: doctest<4>. 
* email: email<4>. 
* filecmp:: 
* functools: functools<5>. 
* gc: gc<5>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<3>. 
* html:: 
* http: http<3>. 
* idlelib e IDLE: idlelib e IDLE<4>. 
* importlib: importlib<9>. 
* inspect: inspect<8>. 
* ipaddress: ipaddress<5>. 
* logging: logging<6>. 
* marshal: marshal<2>. 
* mmap: mmap<3>. 
* multiprocessing: multiprocessing<7>. 
* operador: operador<3>. 
* os: os<11>. 
* pdb: pdb<6>. 
* pickle: pickle<4>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty:: 
* pydoc: pydoc<4>. 
* re: re<8>. 
* resource:: 
* select:: 
* shelve: shelve<2>. 
* shutil: shutil<6>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* socket: socket<9>. 
* sqlite3: sqlite3<9>. 
* ssl: ssl<10>. 
* stat:: 
* struct: struct<2>. 
* subprocess: subprocess<5>. 
* sunau: sunau<2>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* textwrap:: 
* threading: threading<7>. 
* traceback: traceback<6>. 
* types: types<6>. 
* urllib: urllib<3>. 
* unittest: unittest<9>. 
* venv: venv<7>. 
* wave: wave<2>. 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* zipfile: zipfile<5>. 

CPython Implementation Changes

* PEP 445; Customization of CPython Memory Allocators: PEP 445 Customization of CPython Memory Allocators. 
* PEP 442; Safe Object Finalization: PEP 442 Safe Object Finalization. 
* PEP 456; Secure and Interchangeable Hash Algorithm: PEP 456 Secure and Interchangeable Hash Algorithm. 
* PEP 436; Argument Clinic: PEP 436 Argument Clinic. 
* Other Alterações a compilações e API C:: 
* Other Improvements: Other Improvements<2>. 
* Otimizações Relevantes:: 

Descontinuados

* Deprecations in the Python API:: 
* Deprecated Features:: 

Removidos

* Operating Systems No Longer Supported:: 
* Remoção de APIs e recursos: Remoção de APIs e recursos<5>. 
* Code Cleanups:: 

Porting to Python 3.4

* Changes in ‘python’ Command Behavior: Changes in ‘python’ Command Behavior<2>. 
* Alterações na API Python: Alterações na API Python<10>. 
* Alterações na API C: Alterações na API C<15>. 

Alterado em 3.4.3

* PEP 476; Habilitando verificação de certificado por padrão para clientes http stdlib: PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib. 

O que há de novo no Python 3.3

* Resumo – Destaques da versão: Resumo – Destaques da versão<11>. 
* PEP 405; Ambientes Virtuais: PEP 405 Ambientes Virtuais. 
* PEP 420; Implicit Namespace Packages: PEP 420 Implicit Namespace Packages. 
* PEP 3118; New memoryview implementation and buffer protocol documentation: PEP 3118 New memoryview implementation and buffer protocol documentation. 
* PEP 393; Flexible String Representation: PEP 393 Flexible String Representation. 
* PEP 397; Python Launcher for Windows: PEP 397 Python Launcher for Windows. 
* PEP 3151; Reworking the OS and IO exception hierarchy: PEP 3151 Reworking the OS and IO exception hierarchy. 
* PEP 380; Syntax for Delegating to a Subgenerator: PEP 380 Syntax for Delegating to a Subgenerator. 
* PEP 409; Suppressing exception context: PEP 409 Suppressing exception context. 
* PEP 414; Explicit Unicode literals: PEP 414 Explicit Unicode literals. 
* PEP 3155; Qualified name for classes and functions: PEP 3155 Qualified name for classes and functions. 
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary. 
* PEP 362; Function Signature Object: PEP 362 Function Signature Object. 
* PEP 421; Adding sys.implementation: PEP 421 Adding sys implementation. 
* Using importlib as the Implementation of Import:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<11>. 
* A Finer-Grained Import Lock:: 
* Builtin functions and types:: 
* Novos módulos: Novos módulos<11>. 
* Módulos melhorados: Módulos melhorados<11>. 
* Otimizações: Otimizações<10>. 
* Mudanças a construções e API C: Mudanças a construções e API C<4>. 
* Descontinuados: Descontinuados<12>. 
* Porting to Python 3.3: Porting to Python 3 3. 

PEP 3118: New memoryview implementation and buffer protocol documentation

* Recursos:: 
* Mudanças na API:: 

PEP 393: Flexible String Representation

* Funcionalidade:: 
* Desempenho e utilização de recursos:: 

PEP 421: Adding sys.implementation

* SimpleNamespace:: 

Using importlib as the Implementation of Import

* New APIs:: 
* Visible Changes:: 

Novos módulos

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

Módulos melhorados

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

decimal

* Recursos: Recursos<2>. 
* Mudanças na API: Mudanças na API<2>. 

email

* Policy Framework:: 
* Provisional Policy with New Header API:: 
* Other API Changes:: 

Descontinuados

* Unsupported Operating Systems: Unsupported Operating Systems<2>. 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<4>. 
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<3>. 
* Deprecated features:: 

Porting to Python 3.3

* Porting Python code:: 
* Porting C code:: 
* Building C extensions:: 
* Command Line Switch Changes:: 

O que há de novo no Python 3.2

* PEP 384; Defining a Stable ABI: PEP 384 Defining a Stable ABI. 
* PEP 389; Argparse Command Line Parsing Module: PEP 389 Argparse Command Line Parsing Module. 
* PEP 391; Dictionary Based Configuration for Logging: PEP 391 Dictionary Based Configuration for Logging. 
* PEP 3148; The concurrent.futures module: PEP 3148 The concurrent futures module. 
* PEP 3147; PYC Repository Directories: PEP 3147 PYC Repository Directories. 
* PEP 3149; ABI Version Tagged .so Files: PEP 3149 ABI Version Tagged so Files. 
* PEP 3333; Python Web Server Gateway Interface v1.0.1: PEP 3333 Python Web Server Gateway Interface v1 0 1. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<12>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules. 
* Multi-threading:: 
* Otimizações: Otimizações<11>. 
* Unicode:: 
* Codecs:: 
* Documentação:: 
* IDLE:: 
* Code Repository:: 
* Mudanças a construções e API C: Mudanças a construções e API C<5>. 
* Porting to Python 3.2: Porting to Python 3 2. 

New, Improved, and Deprecated Modules

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

O que há de novo no Python 3.1

* PEP 372; Dicionários ordenados: PEP 372 Dicionários ordenados. 
* PEP 378; Especificador de formato para separador de milhares: PEP 378 Especificador de formato para separador de milhares. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<13>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<2>. 
* Otimizações: Otimizações<12>. 
* IDLE: IDLE<2>. 
* Mudanças a construções e API C: Mudanças a construções e API C<6>. 
* Porting to Python 3.1: Porting to Python 3 1. 

O que há de novo no Python 3.0

* Obstáculos comuns:: 
* Visão geral das alterações da sintaxe:: 
* Mudanças já presentes no Python 2.6: Mudanças já presentes no Python 2 6. 
* Mudanças na biblioteca:: 
* PEP 3101; Uma nova abordagem para formatação de strings: PEP 3101 Uma nova abordagem para formatação de strings. 
* Mudanças para exceções:: 
* Outras mudanças diversas:: 
* Mudanças a construções e API C: Mudanças a construções e API C<7>. 
* Desempenho:: 
* Portando para o Python 3.0: Portando para o Python 3 0. 

Obstáculos comuns

* print é uma função:: 
* Visualizações e iteradores em vez de listas:: 
* Comparações de ordenação:: 
* Inteiros:: 
* Texto vs. Dados em vez de Unicode vs. 8 bits: Texto vs Dados em vez de Unicode vs 8 bits. 

Visão geral das alterações da sintaxe

* Nova sintaxe:: 
* Sintaxe alterada:: 
* Sintaxe removida:: 

Outras mudanças diversas

* Operadores e métodos especiais:: 
* Funções embutidas:: 

O que há de novo no Python 2.7

* O futuro para o Python 2.x: O futuro para o Python 2 x. 
* Mudanças no tratamento de avisos de descontinuação:: 
* Recursos do Python 3.1: Recursos do Python 3 1. 
* PEP 372; Adicionando um dicionário ordenado a coleções: PEP 372 Adicionando um dicionário ordenado a coleções. 
* PEP 378; Especificador de formato para separador de milhares: PEP 378 Especificador de formato para separador de milhares<2>. 
* PEP 389; O módulo argparse para analisar linhas de comando: PEP 389 O módulo argparse para analisar linhas de comando. 
* PEP 391; Configuração baseada em dicionário para logging: PEP 391 Configuração baseada em dicionário para logging. 
* PEP 3106; Views de dicionário: PEP 3106 Views de dicionário. 
* PEP 3137; O objeto memoryview: PEP 3137 O objeto memoryview. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<14>. 
* Módulos Novos ou Aprimorados:: 
* Mudanças a construções e API C: Mudanças a construções e API C<8>. 
* Outras alterações e correções:: 
* Portando para Python 2.7: Portando para Python 2 7. 
* Novos recursos adicionados às versões de manutenção do Python 2.7: Novos recursos adicionados às versões de manutenção do Python 2 7. 
* Reconhecimentos:: 

Outras mudanças na linguagem

* Alterações no interpretador:: 
* Otimizações: Otimizações<13>. 

Módulos Novos ou Aprimorados

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

Mudanças a construções e API C

* Capsules:: 
* Alterações específicas da porta; Windows: Alterações específicas da porta Windows. 
* Alterações específicas da porta; Mac OS X: Alterações específicas da porta Mac OS X. 
* Alterações específicas da porta; FreeBSD: Alterações específicas da porta FreeBSD. 

Novos recursos adicionados às versões de manutenção do Python 2.7

* Duas novas variáveis de ambiente para modo de depuração:: 
* PEP 434; Exceção de aprimoramento do IDLE para todos os branches: PEP 434 Exceção de aprimoramento do IDLE para todos os branches. 
* PEP 466; Aprimoramentos de segurança de rede do Python 2.7: PEP 466 Aprimoramentos de segurança de rede do Python 2 7. 
* PEP 477; Backport do ensurepip (PEP 453) para o Python 2.7: PEP 477 Backport do ensurepip PEP 453 para o Python 2 7. 
* PEP 476; Habilitando verificação de certificado por padrão para clientes http stdlib: PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib<2>. 
* PEP 493; Ferramentas de migração de verificação HTTPS para Python 2.7: PEP 493 Ferramentas de migração de verificação HTTPS para Python 2 7. 
* Novo alvo de construção make regen-all: Novo alvo de construção make regen-all<3>. 
* Remoção do alvo de construção make touch: Remoção do alvo de construção make touch<3>. 

PEP 477: Backport do ensurepip (PEP 453) para o Python 2.7

* Bootstrapping pip By Default: Bootstrapping pip By Default<2>. 
* Mudanças na documentação: Mudanças na documentação<2>. 

O que há de novo no Python 2.6

* Python 3.0: Python 3 0. 
* Changes to the Development Process:: 
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement. 
* PEP 366; Explicit Relative Imports From a Main Module: PEP 366 Explicit Relative Imports From a Main Module. 
* PEP 370; Per-user site-packages Directory: PEP 370 Per-user site-packages Directory. 
* PEP 371; The multiprocessing Package: PEP 371 The multiprocessing Package. 
* PEP 3101; Advanced String Formatting: PEP 3101 Advanced String Formatting. 
* PEP 3105; print As a Function: PEP 3105 print As a Function. 
* PEP 3110; Exception-Handling Changes: PEP 3110 Exception-Handling Changes. 
* PEP 3112; Byte Literals: PEP 3112 Byte Literals. 
* PEP 3116; New I/O Library: PEP 3116 New I/O Library. 
* PEP 3118; Revised Buffer Protocol: PEP 3118 Revised Buffer Protocol. 
* PEP 3119; Abstract Base Classes: PEP 3119 Abstract Base Classes. 
* PEP 3127; Integer Literal Support and Syntax: PEP 3127 Integer Literal Support and Syntax. 
* PEP 3129; Class Decorators: PEP 3129 Class Decorators. 
* PEP 3141; A Type Hierarchy for Numbers: PEP 3141 A Type Hierarchy for Numbers. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<15>. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<2>. 
* Deprecations and Removals:: 
* Mudanças a construções e API C: Mudanças a construções e API C<9>. 
* Porting to Python 2.6: Porting to Python 2 6. 
* Reconhecimentos: Reconhecimentos<2>. 

Changes to the Development Process

* New Issue Tracker; Roundup: New Issue Tracker Roundup. 
* New Documentation Format; reStructuredText Using Sphinx: New Documentation Format reStructuredText Using Sphinx. 

PEP 343: The ‘with’ statement

* Writing Context Managers:: 
* The contextlib module:: 

PEP 3141: A Type Hierarchy for Numbers

* The fractions Module:: 

Outras mudanças na linguagem

* Otimizações: Otimizações<14>. 
* Alterações no interpretador: Alterações no interpretador<2>. 

Módulos Novos ou Aprimorados

* The ast module:: 
* The future_builtins module:: 
* The json module; JavaScript Object Notation: The json module JavaScript Object Notation. 
* The plistlib module; A Property-List Parser: The plistlib module A Property-List Parser. 
* ctypes Enhancements:: 
* Improved SSL Support:: 

Mudanças a construções e API C

* Alterações específicas da porta; Windows: Alterações específicas da porta Windows<2>. 
* Alterações específicas da porta; Mac OS X: Alterações específicas da porta Mac OS X<2>. 
* Port-Specific Changes; IRIX: Port-Specific Changes IRIX. 

What’s New in Python 2.5

* PEP 308; Conditional Expressions: PEP 308 Conditional Expressions. 
* PEP 309; Partial Function Application: PEP 309 Partial Function Application. 
* PEP 314; Metadata for Python Software Packages v1.1: PEP 314 Metadata for Python Software Packages v1 1. 
* PEP 328; Absolute and Relative Imports: PEP 328 Absolute and Relative Imports. 
* PEP 338; Executing Modules as Scripts: PEP 338 Executing Modules as Scripts. 
* PEP 341; Unified try/except/finally: PEP 341 Unified try/except/finally. 
* PEP 342; New Generator Features: PEP 342 New Generator Features. 
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement<2>. 
* PEP 352; Exceptions as New-Style Classes: PEP 352 Exceptions as New-Style Classes. 
* PEP 353; Using ssize_t as the index type: PEP 353 Using ssize_t as the index type. 
* PEP 357; The ‘__index__’ method: PEP 357 The ‘__index__’ method. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<16>. 
* New@comma{} Improved@comma{} and Removed Modules: New Improved and Removed Modules. 
* Mudanças a construções e API C: Mudanças a construções e API C<10>. 
* Porting to Python 2.5: Porting to Python 2 5. 
* Reconhecimentos: Reconhecimentos<3>. 

PEP 343: The ‘with’ statement

* Writing Context Managers: Writing Context Managers<2>. 
* The contextlib module: The contextlib module<2>. 

Outras mudanças na linguagem

* Interactive Interpreter Changes:: 
* Otimizações: Otimizações<15>. 

New, Improved, and Removed Modules

* The ctypes package:: 
* The ElementTree package:: 
* The hashlib package:: 
* The sqlite3 package:: 
* The wsgiref package:: 

Mudanças a construções e API C

* Port-Specific Changes:: 

What’s New in Python 2.4

* PEP 218; Built-In Set Objects: PEP 218 Built-In Set Objects. 
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers. 
* PEP 289; Generator Expressions: PEP 289 Generator Expressions. 
* PEP 292; Simpler String Substitutions: PEP 292 Simpler String Substitutions. 
* PEP 318; Decorators for Functions and Methods: PEP 318 Decorators for Functions and Methods. 
* PEP 322; Reverse Iteration: PEP 322 Reverse Iteration. 
* PEP 324; New subprocess Module: PEP 324 New subprocess Module. 
* PEP 327; Decimal Data Type: PEP 327 Decimal Data Type. 
* PEP 328; Multi-line Imports: PEP 328 Multi-line Imports. 
* PEP 331; Locale-Independent Float/String Conversions: PEP 331 Locale-Independent Float/String Conversions. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<17>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<3>. 
* Mudanças a construções e API C: Mudanças a construções e API C<11>. 
* Porting to Python 2.4: Porting to Python 2 4. 
* Reconhecimentos: Reconhecimentos<4>. 

PEP 327: Decimal Data Type

* Why is Decimal needed?:: 
* The Decimal type:: 
* The Context type:: 

Outras mudanças na linguagem

* Otimizações: Otimizações<16>. 

New, Improved, and Deprecated Modules

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

Mudanças a construções e API C

* Port-Specific Changes: Port-Specific Changes<2>. 

What’s New in Python 2.3

* PEP 218; A Standard Set Datatype: PEP 218 A Standard Set Datatype. 
* PEP 255; Simple Generators: PEP 255 Simple Generators. 
* PEP 263; Source Code Encodings: PEP 263 Source Code Encodings. 
* PEP 273; Importing Modules from ZIP Archives: PEP 273 Importing Modules from ZIP Archives. 
* PEP 277; Unicode file name support for Windows NT: PEP 277 Unicode file name support for Windows NT. 
* PEP 278; Universal Newline Support: PEP 278 Universal Newline Support. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; The logging Package: PEP 282 The logging Package. 
* PEP 285; A Boolean Type: PEP 285 A Boolean Type. 
* PEP 293; Codec Error Handling Callbacks: PEP 293 Codec Error Handling Callbacks. 
* PEP 301; Package Index and Metadata for Distutils: PEP 301 Package Index and Metadata for Distutils. 
* PEP 302; New Import Hooks: PEP 302 New Import Hooks. 
* PEP 305; Comma-separated Files: PEP 305 Comma-separated Files. 
* PEP 307; Pickle Enhancements: PEP 307 Pickle Enhancements. 
* Extended Slices:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<18>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<4>. 
* Pymalloc; A Specialized Object Allocator: Pymalloc A Specialized Object Allocator. 
* Mudanças a construções e API C: Mudanças a construções e API C<12>. 
* Outras alterações e correções: Outras alterações e correções<2>. 
* Porting to Python 2.3: Porting to Python 2 3. 
* Reconhecimentos: Reconhecimentos<5>. 

Outras mudanças na linguagem

* String Changes:: 
* Otimizações: Otimizações<17>. 

New, Improved, and Deprecated Modules

* Date/Time Type:: 
* The optparse Module:: 

Mudanças a construções e API C

* Port-Specific Changes: Port-Specific Changes<3>. 

What’s New in Python 2.2

* Introdução:: 
* PEPs 252 and 253; Type and Class Changes: PEPs 252 and 253 Type and Class Changes. 
* PEP 234; Iterators: PEP 234 Iterators. 
* PEP 255; Simple Generators: PEP 255 Simple Generators<2>. 
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers<2>. 
* PEP 238; Changing the Division Operator: PEP 238 Changing the Division Operator. 
* Unicode Changes:: 
* PEP 227; Nested Scopes: PEP 227 Nested Scopes. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<3>. 
* Interpreter Changes and Fixes:: 
* Outras alterações e correções: Outras alterações e correções<3>. 
* Reconhecimentos: Reconhecimentos<6>. 

PEPs 252 and 253: Type and Class Changes

* Old and New Classes:: 
* Descriptors:: 
* Multiple Inheritance; The Diamond Rule: Multiple Inheritance The Diamond Rule. 
* Attribute Access:: 
* Related Links:: 

What’s New in Python 2.1

* Introdução: Introdução<2>. 
* PEP 227; Nested Scopes: PEP 227 Nested Scopes<2>. 
* PEP 236; __future__ Directives: PEP 236 __future__ Directives. 
* PEP 207; Rich Comparisons: PEP 207 Rich Comparisons. 
* PEP 230; Warning Framework: PEP 230 Warning Framework. 
* PEP 229; New Build System: PEP 229 New Build System. 
* PEP 205; Weak References: PEP 205 Weak References. 
* PEP 232; Function Attributes: PEP 232 Function Attributes. 
* PEP 235; Importing Modules on Case-Insensitive Platforms: PEP 235 Importing Modules on Case-Insensitive Platforms. 
* PEP 217; Interactive Display Hook: PEP 217 Interactive Display Hook. 
* PEP 208; New Coercion Model: PEP 208 New Coercion Model. 
* PEP 241; Metadata in Python Packages: PEP 241 Metadata in Python Packages. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<4>. 
* Outras alterações e correções: Outras alterações e correções<4>. 
* Reconhecimentos: Reconhecimentos<7>. 

What’s New in Python 2.0

* Introdução: Introdução<3>. 
* What About Python 1.6?: What About Python 1 6?. 
* New Development Process:: 
* Unicode: Unicode<2>. 
* Compreensões de lista:: 
* Augmented Assignment:: 
* String Methods:: 
* Garbage Collection of Cycles:: 
* Other Core Changes:: 
* Porting to 2.0: Porting to 2 0. 
* Extending/Embedding Changes:: 
* Distutils; Making Modules Easy to Install: Distutils Making Modules Easy to Install. 
* XML Modules:: 
* Module changes:: 
* Novos módulos: Novos módulos<12>. 
* IDLE Improvements:: 
* Deleted and Deprecated Modules:: 
* Reconhecimentos: Reconhecimentos<8>. 

Other Core Changes

* Minor Language Changes:: 
* Changes to Built-in Functions:: 

XML Modules

* SAX2 Support:: 
* DOM Support:: 
* Relationship to PyXML:: 

Changelog

* Python seguinte:: 
* Python 3.13.11 final: Python 3 13 11 final. 
* Python 3.13.10 final: Python 3 13 10 final. 
* Python 3.13.9 final: Python 3 13 9 final. 
* Python 3.13.8 final: Python 3 13 8 final. 
* Python 3.13.7 final: Python 3 13 7 final. 
* Python 3.13.6 final: Python 3 13 6 final. 
* Python 3.13.5 final: Python 3 13 5 final. 
* Python 3.13.4 final: Python 3 13 4 final. 
* Python 3.13.3 final: Python 3 13 3 final. 
* Python 3.13.2 final: Python 3 13 2 final. 
* Python 3.13.1 final: Python 3 13 1 final. 
* Python 3.13.0 final: Python 3 13 0 final. 
* Python 3.13.0 release candidate 3: Python 3 13 0 release candidate 3. 
* Python 3.13.0 release candidate 2: Python 3 13 0 release candidate 2. 
* Python 3.13.0 release candidate 1: Python 3 13 0 release candidate 1. 
* Python 3.13.0 beta 4: Python 3 13 0 beta 4. 
* Python 3.13.0 beta 3: Python 3 13 0 beta 3. 
* Python 3.13.0 beta 2: Python 3 13 0 beta 2. 
* 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 seguinte

* Windows:: 
* Ferramentas/Demos:: 
* Testes:: 
* Segurança:: 
* Biblioteca:: 
* IDLE: IDLE<3>. 
* Núcleo e embutidos:: 
* API C:: 
* Construção:: 

Python 3.13.11 final

* Segurança: Segurança<2>. 
* Biblioteca: Biblioteca<2>. 
* Núcleo e embutidos: Núcleo e embutidos<2>. 

Python 3.13.10 final

* Ferramentas/Demos: Ferramentas/Demos<2>. 
* Testes: Testes<2>. 
* Segurança: Segurança<3>. 
* Biblioteca: Biblioteca<3>. 
* IDLE: IDLE<4>. 
* Documentação: Documentação<2>. 
* Núcleo e embutidos: Núcleo e embutidos<3>. 
* API C: API C<2>. 

Python 3.13.9 final

* Biblioteca: Biblioteca<4>. 

Python 3.13.8 final

* macOS:: 
* Windows: Windows<2>. 
* Ferramentas/Demos: Ferramentas/Demos<3>. 
* Testes: Testes<3>. 
* Segurança: Segurança<4>. 
* Biblioteca: Biblioteca<5>. 
* Núcleo e embutidos: Núcleo e embutidos<4>. 
* API C: API C<3>. 
* Construção: Construção<2>. 

Python 3.13.7 final

* Biblioteca: Biblioteca<6>. 
* Documentação: Documentação<3>. 
* Núcleo e embutidos: Núcleo e embutidos<5>. 

Python 3.13.6 final

* macOS: macOS<2>. 
* Windows: Windows<3>. 
* Ferramentas/Demos: Ferramentas/Demos<4>. 
* Testes: Testes<4>. 
* Segurança: Segurança<5>. 
* Biblioteca: Biblioteca<7>. 
* Documentação: Documentação<4>. 
* Núcleo e embutidos: Núcleo e embutidos<6>. 
* Construção: Construção<3>. 

Python 3.13.5 final

* Windows: Windows<4>. 
* Testes: Testes<5>. 
* Biblioteca: Biblioteca<8>. 
* Núcleo e embutidos: Núcleo e embutidos<7>. 
* API C: API C<4>. 

Python 3.13.4 final

* Windows: Windows<5>. 
* Testes: Testes<6>. 
* Segurança: Segurança<6>. 
* Biblioteca: Biblioteca<9>. 
* IDLE: IDLE<5>. 
* Documentação: Documentação<5>. 
* Biblioteca: Biblioteca<10>. 
* Núcleo e embutidos: Núcleo e embutidos<8>. 
* Biblioteca: Biblioteca<11>. 
* Núcleo e embutidos: Núcleo e embutidos<9>. 
* API C: API C<5>. 
* Construção: Construção<4>. 

Python 3.13.3 final

* macOS: macOS<3>. 
* Windows: Windows<6>. 
* Ferramentas/Demos: Ferramentas/Demos<5>. 
* Testes: Testes<7>. 
* Segurança: Segurança<7>. 
* Biblioteca: Biblioteca<12>. 
* IDLE: IDLE<6>. 
* Documentação: Documentação<6>. 
* Núcleo e embutidos: Núcleo e embutidos<10>. 
* Biblioteca: Biblioteca<13>. 
* Núcleo e embutidos: Núcleo e embutidos<11>. 
* API C: API C<6>. 
* Construção: Construção<5>. 

Python 3.13.2 final

* macOS: macOS<4>. 
* Windows: Windows<7>. 
* Ferramentas/Demos: Ferramentas/Demos<6>. 
* Testes: Testes<8>. 
* Segurança: Segurança<8>. 
* Biblioteca: Biblioteca<14>. 
* Documentação: Documentação<7>. 
* Biblioteca: Biblioteca<15>. 
* Núcleo e embutidos: Núcleo e embutidos<12>. 
* API C: API C<7>. 
* Construção: Construção<6>. 

Python 3.13.1 final

* macOS: macOS<5>. 
* Windows: Windows<8>. 
* Ferramentas/Demos: Ferramentas/Demos<7>. 
* Testes: Testes<9>. 
* Segurança: Segurança<9>. 
* Biblioteca: Biblioteca<16>. 
* IDLE: IDLE<7>. 
* Documentação: Documentação<8>. 
* Núcleo e embutidos: Núcleo e embutidos<13>. 
* Biblioteca: Biblioteca<17>. 
* Núcleo e embutidos: Núcleo e embutidos<14>. 
* Biblioteca: Biblioteca<18>. 
* Núcleo e embutidos: Núcleo e embutidos<15>. 
* API C: API C<8>. 
* Construção: Construção<7>. 

Python 3.13.0 final

* Biblioteca: Biblioteca<19>. 
* Núcleo e embutidos: Núcleo e embutidos<16>. 

Python 3.13.0 release candidate 3

* macOS: macOS<6>. 
* Windows: Windows<9>. 
* Testes: Testes<10>. 
* Biblioteca: Biblioteca<20>. 
* IDLE: IDLE<8>. 
* Documentação: Documentação<9>. 
* Núcleo e embutidos: Núcleo e embutidos<17>. 
* API C: API C<9>. 
* Construção: Construção<8>. 

Python 3.13.0 release candidate 2

* macOS: macOS<7>. 
* Windows: Windows<10>. 
* Ferramentas/Demos: Ferramentas/Demos<8>. 
* Testes: Testes<11>. 
* Segurança: Segurança<10>. 
* Biblioteca: Biblioteca<21>. 
* IDLE: IDLE<9>. 
* Biblioteca: Biblioteca<22>. 
* Núcleo e embutidos: Núcleo e embutidos<18>. 
* API C: API C<10>. 
* Construção: Construção<9>. 

Python 3.13.0 release candidate 1

* Testes: Testes<12>. 
* Segurança: Segurança<11>. 
* Biblioteca: Biblioteca<23>. 
* IDLE: IDLE<10>. 
* Núcleo e embutidos: Núcleo e embutidos<19>. 
* API C: API C<11>. 
* Construção: Construção<10>. 

Python 3.13.0 beta 4

* Testes: Testes<13>. 
* Biblioteca: Biblioteca<24>. 
* IDLE: IDLE<11>. 
* Documentação: Documentação<10>. 
* Núcleo e embutidos: Núcleo e embutidos<20>. 
* API C: API C<12>. 
* Construção: Construção<11>. 

Python 3.13.0 beta 3

* Núcleo e embutidos: Núcleo e embutidos<21>. 
* Biblioteca: Biblioteca<25>. 
* Núcleo e embutidos: Núcleo e embutidos<22>. 
* Biblioteca: Biblioteca<26>. 
* Construção: Construção<12>. 
* API C: API C<13>. 

Python 3.13.0 beta 2

* Segurança: Segurança<12>. 
* Núcleo e embutidos: Núcleo e embutidos<23>. 
* Biblioteca: Biblioteca<27>. 
* Testes: Testes<14>. 
* Construção: Construção<13>. 
* Windows: Windows<11>. 
* API C: API C<14>. 

Python 3.13.0 beta 1

* Segurança: Segurança<13>. 
* Núcleo e embutidos: Núcleo e embutidos<24>. 
* Biblioteca: Biblioteca<28>. 
* Núcleo e embutidos: Núcleo e embutidos<25>. 
* Biblioteca: Biblioteca<29>. 
* Documentação: Documentação<11>. 
* Construção: Construção<14>. 
* Windows: Windows<12>. 
* macOS: macOS<8>. 
* IDLE: IDLE<12>. 
* API C: API C<15>. 

Python 3.13.0 alpha 6

* Núcleo e embutidos: Núcleo e embutidos<26>. 
* Biblioteca: Biblioteca<30>. 
* Núcleo e embutidos: Núcleo e embutidos<27>. 
* Biblioteca: Biblioteca<31>. 
* Documentação: Documentação<12>. 
* Testes: Testes<15>. 
* Construção: Construção<15>. 
* Windows: Windows<13>. 
* API C: API C<16>. 

Python 3.13.0 alpha 5

* Segurança: Segurança<14>. 
* Núcleo e embutidos: Núcleo e embutidos<28>. 
* Biblioteca: Biblioteca<32>. 
* Núcleo e embutidos: Núcleo e embutidos<29>. 
* Biblioteca: Biblioteca<33>. 
* Núcleo e embutidos: Núcleo e embutidos<30>. 
* Biblioteca: Biblioteca<34>. 
* Documentação: Documentação<13>. 
* Testes: Testes<16>. 
* Construção: Construção<16>. 
* Windows: Windows<14>. 
* macOS: macOS<9>. 
* IDLE: IDLE<13>. 
* Ferramentas/Demos: Ferramentas/Demos<9>. 
* API C: API C<17>. 

Python 3.13.0 alpha 4

* Segurança: Segurança<15>. 
* Núcleo e embutidos: Núcleo e embutidos<31>. 
* Biblioteca: Biblioteca<35>. 
* Documentação: Documentação<14>. 
* Testes: Testes<17>. 
* Construção: Construção<17>. 
* Windows: Windows<15>. 
* macOS: macOS<10>. 
* IDLE: IDLE<14>. 
* Ferramentas/Demos: Ferramentas/Demos<10>. 
* API C: API C<18>. 

Python 3.13.0 alpha 3

* Segurança: Segurança<16>. 
* Núcleo e embutidos: Núcleo e embutidos<32>. 
* Biblioteca: Biblioteca<36>. 
* Documentação: Documentação<15>. 
* Testes: Testes<18>. 
* Construção: Construção<18>. 
* Windows: Windows<16>. 
* macOS: macOS<11>. 
* IDLE: IDLE<15>. 
* API C: API C<19>. 

Python 3.13.0 alpha 2

* Núcleo e embutidos: Núcleo e embutidos<33>. 
* Biblioteca: Biblioteca<37>. 
* Testes: Testes<19>. 
* Construção: Construção<19>. 
* Windows: Windows<17>. 
* macOS: macOS<12>. 
* IDLE: IDLE<16>. 
* Ferramentas/Demos: Ferramentas/Demos<11>. 
* API C: API C<20>. 

Python 3.13.0 alpha 1

* Segurança: Segurança<17>. 
* Núcleo e embutidos: Núcleo e embutidos<34>. 
* Biblioteca: Biblioteca<38>. 
* Documentação: Documentação<16>. 
* Testes: Testes<20>. 
* Construção: Construção<20>. 
* Windows: Windows<18>. 
* macOS: macOS<13>. 
* IDLE: IDLE<17>. 
* Ferramentas/Demos: Ferramentas/Demos<12>. 
* API C: API C<21>. 

Python 3.12.0 beta 1

* Segurança: Segurança<18>. 
* Biblioteca: Biblioteca<39>. 
* Núcleo e embutidos: Núcleo e embutidos<35>. 
* Biblioteca: Biblioteca<40>. 
* Núcleo e embutidos: Núcleo e embutidos<36>. 
* Biblioteca: Biblioteca<41>. 
* Núcleo e embutidos: Núcleo e embutidos<37>. 
* Biblioteca: Biblioteca<42>. 
* Documentação: Documentação<17>. 
* Testes: Testes<21>. 
* Construção: Construção<21>. 
* Windows: Windows<19>. 
* macOS: macOS<14>. 
* IDLE: IDLE<18>. 
* Ferramentas/Demos: Ferramentas/Demos<13>. 
* API C: API C<22>. 

Python 3.12.0 alpha 7

* Núcleo e embutidos: Núcleo e embutidos<38>. 
* Biblioteca: Biblioteca<43>. 
* Núcleo e embutidos: Núcleo e embutidos<39>. 
* Construção: Construção<22>. 
* Núcleo e embutidos: Núcleo e embutidos<40>. 
* Biblioteca: Biblioteca<44>. 
* Documentação: Documentação<18>. 
* Testes: Testes<22>. 
* Construção: Construção<23>. 
* Windows: Windows<20>. 
* Ferramentas/Demos: Ferramentas/Demos<14>. 
* API C: API C<23>. 

Python 3.12.0 alpha 6

* Segurança: Segurança<19>. 
* Núcleo e embutidos: Núcleo e embutidos<41>. 
* Biblioteca: Biblioteca<45>. 
* Documentação: Documentação<19>. 
* Testes: Testes<23>. 
* Construção: Construção<24>. 
* Windows: Windows<21>. 
* macOS: macOS<15>. 
* API C: API C<24>. 

Python 3.12.0 alpha 5

* Segurança: Segurança<20>. 
* Núcleo e embutidos: Núcleo e embutidos<42>. 
* Biblioteca: Biblioteca<46>. 
* Documentação: Documentação<20>. 
* Testes: Testes<24>. 
* Construção: Construção<25>. 
* Windows: Windows<22>. 

Python 3.12.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<43>. 
* Biblioteca: Biblioteca<47>. 
* Núcleo e embutidos: Núcleo e embutidos<44>. 
* Biblioteca: Biblioteca<48>. 
* Núcleo e embutidos: Núcleo e embutidos<45>. 
* Biblioteca: Biblioteca<49>. 
* Documentação: Documentação<21>. 
* Testes: Testes<25>. 
* Construção: Construção<26>. 
* Windows: Windows<23>. 
* macOS: macOS<16>. 
* Ferramentas/Demos: Ferramentas/Demos<15>. 
* API C: API C<25>. 

Python 3.12.0 alpha 3

* Segurança: Segurança<21>. 
* Núcleo e embutidos: Núcleo e embutidos<46>. 
* Biblioteca: Biblioteca<50>. 
* Núcleo e embutidos: Núcleo e embutidos<47>. 
* Biblioteca: Biblioteca<51>. 
* Documentação: Documentação<22>. 
* Testes: Testes<26>. 
* Construção: Construção<27>. 
* Windows: Windows<24>. 
* macOS: macOS<17>. 
* Ferramentas/Demos: Ferramentas/Demos<16>. 
* API C: API C<26>. 

Python 3.12.0 alpha 2

* Segurança: Segurança<22>. 
* Núcleo e embutidos: Núcleo e embutidos<48>. 
* Construção: Construção<28>. 
* Núcleo e embutidos: Núcleo e embutidos<49>. 
* Biblioteca: Biblioteca<52>. 
* Documentação: Documentação<23>. 
* Testes: Testes<27>. 
* Construção: Construção<29>. 
* Windows: Windows<25>. 
* macOS: macOS<18>. 
* API C: API C<27>. 

Python 3.12.0 alpha 1

* Segurança: Segurança<23>. 
* Núcleo e embutidos: Núcleo e embutidos<50>. 
* Biblioteca: Biblioteca<53>. 
* Núcleo e embutidos: Núcleo e embutidos<51>. 
* Biblioteca: Biblioteca<54>. 
* Núcleo e embutidos: Núcleo e embutidos<52>. 
* Biblioteca: Biblioteca<55>. 
* Núcleo e embutidos: Núcleo e embutidos<53>. 
* Biblioteca: Biblioteca<56>. 
* Núcleo e embutidos: Núcleo e embutidos<54>. 
* Biblioteca: Biblioteca<57>. 
* Núcleo e embutidos: Núcleo e embutidos<55>. 
* Biblioteca: Biblioteca<58>. 
* Núcleo e embutidos: Núcleo e embutidos<56>. 
* Biblioteca: Biblioteca<59>. 
* Núcleo e embutidos: Núcleo e embutidos<57>. 
* Biblioteca: Biblioteca<60>. 
* Núcleo e embutidos: Núcleo e embutidos<58>. 
* Biblioteca: Biblioteca<61>. 
* Núcleo e embutidos: Núcleo e embutidos<59>. 
* Biblioteca: Biblioteca<62>. 
* Documentação: Documentação<24>. 
* Testes: Testes<28>. 
* Construção: Construção<30>. 
* Windows: Windows<26>. 
* macOS: macOS<19>. 
* IDLE: IDLE<19>. 
* Ferramentas/Demos: Ferramentas/Demos<17>. 
* API C: API C<28>. 

Python 3.11.0 beta 1

* Segurança: Segurança<24>. 
* Núcleo e embutidos: Núcleo e embutidos<60>. 
* Biblioteca: Biblioteca<63>. 
* Núcleo e embutidos: Núcleo e embutidos<61>. 
* Construção: Construção<31>. 
* Núcleo e embutidos: Núcleo e embutidos<62>. 
* Biblioteca: Biblioteca<64>. 
* Documentação: Documentação<25>. 
* Testes: Testes<29>. 
* Construção: Construção<32>. 
* Windows: Windows<27>. 
* macOS: macOS<20>. 
* Ferramentas/Demos: Ferramentas/Demos<18>. 
* API C: API C<29>. 

Python 3.11.0 alpha 7

* Núcleo e embutidos: Núcleo e embutidos<63>. 
* Biblioteca: Biblioteca<65>. 
* Núcleo e embutidos: Núcleo e embutidos<64>. 
* Biblioteca: Biblioteca<66>. 
* Núcleo e embutidos: Núcleo e embutidos<65>. 
* Biblioteca: Biblioteca<67>. 
* Documentação: Documentação<26>. 
* Testes: Testes<30>. 
* Construção: Construção<33>. 
* Windows: Windows<28>. 
* macOS: macOS<21>. 
* Ferramentas/Demos: Ferramentas/Demos<19>. 
* API C: API C<30>. 

Python 3.11.0 alpha 6

* Núcleo e embutidos: Núcleo e embutidos<66>. 
* Biblioteca: Biblioteca<68>. 
* Núcleo e embutidos: Núcleo e embutidos<67>. 
* Biblioteca: Biblioteca<69>. 
* Núcleo e embutidos: Núcleo e embutidos<68>. 
* Biblioteca: Biblioteca<70>. 
* Núcleo e embutidos: Núcleo e embutidos<69>. 
* Biblioteca: Biblioteca<71>. 
* Documentação: Documentação<27>. 
* Testes: Testes<31>. 
* Construção: Construção<34>. 
* Windows: Windows<29>. 
* IDLE: IDLE<20>. 
* API C: API C<31>. 

Python 3.11.0 alpha 5

* Núcleo e embutidos: Núcleo e embutidos<70>. 
* Biblioteca: Biblioteca<72>. 
* Núcleo e embutidos: Núcleo e embutidos<71>. 
* Biblioteca: Biblioteca<73>. 
* Construção: Construção<35>. 
* Núcleo e embutidos: Núcleo e embutidos<72>. 
* Biblioteca: Biblioteca<74>. 
* Documentação: Documentação<28>. 
* Testes: Testes<32>. 
* Construção: Construção<36>. 
* Windows: Windows<30>. 
* macOS: macOS<22>. 
* IDLE: IDLE<21>. 
* API C: API C<32>. 

Python 3.11.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<73>. 
* Biblioteca: Biblioteca<75>. 
* Núcleo e embutidos: Núcleo e embutidos<74>. 
* Biblioteca: Biblioteca<76>. 
* Núcleo e embutidos: Núcleo e embutidos<75>. 
* Biblioteca: Biblioteca<77>. 
* Núcleo e embutidos: Núcleo e embutidos<76>. 
* Biblioteca: Biblioteca<78>. 
* Documentação: Documentação<29>. 
* Testes: Testes<33>. 
* Construção: Construção<37>. 
* Windows: Windows<31>. 
* macOS: macOS<23>. 
* API C: API C<33>. 

Python 3.11.0 alpha 3

* Núcleo e embutidos: Núcleo e embutidos<77>. 
* Biblioteca: Biblioteca<79>. 
* Núcleo e embutidos: Núcleo e embutidos<78>. 
* Biblioteca: Biblioteca<80>. 
* Documentação: Documentação<30>. 
* Testes: Testes<34>. 
* Construção: Construção<38>. 
* Windows: Windows<32>. 
* macOS: macOS<24>. 
* API C: API C<34>. 

Python 3.11.0 alpha 2

* Núcleo e embutidos: Núcleo e embutidos<79>. 
* Biblioteca: Biblioteca<81>. 
* Documentação: Documentação<31>. 
* Testes: Testes<35>. 
* Construção: Construção<39>. 
* Windows: Windows<33>. 
* macOS: macOS<25>. 
* IDLE: IDLE<22>. 
* API C: API C<35>. 

Python 3.11.0 alpha 1

* Segurança: Segurança<25>. 
* Núcleo e embutidos: Núcleo e embutidos<80>. 
* Biblioteca: Biblioteca<82>. 
* Núcleo e embutidos: Núcleo e embutidos<81>. 
* Biblioteca: Biblioteca<83>. 
* Núcleo e embutidos: Núcleo e embutidos<82>. 
* Biblioteca: Biblioteca<84>. 
* Núcleo e embutidos: Núcleo e embutidos<83>. 
* Biblioteca: Biblioteca<85>. 
* Núcleo e embutidos: Núcleo e embutidos<84>. 
* Biblioteca: Biblioteca<86>. 
* Núcleo e embutidos: Núcleo e embutidos<85>. 
* Biblioteca: Biblioteca<87>. 
* Núcleo e embutidos: Núcleo e embutidos<86>. 
* Biblioteca: Biblioteca<88>. 
* Núcleo e embutidos: Núcleo e embutidos<87>. 
* Biblioteca: Biblioteca<89>. 
* Núcleo e embutidos: Núcleo e embutidos<88>. 
* Biblioteca: Biblioteca<90>. 
* Núcleo e embutidos: Núcleo e embutidos<89>. 
* Biblioteca: Biblioteca<91>. 
* Documentação: Documentação<32>. 
* Testes: Testes<36>. 
* Construção: Construção<40>. 
* Windows: Windows<34>. 
* macOS: macOS<26>. 
* IDLE: IDLE<23>. 
* Ferramentas/Demos: Ferramentas/Demos<20>. 
* API C: API C<36>. 

Python 3.10.0 beta 1

* Segurança: Segurança<26>. 
* Núcleo e embutidos: Núcleo e embutidos<90>. 
* Biblioteca: Biblioteca<92>. 
* Núcleo e embutidos: Núcleo e embutidos<91>. 
* Biblioteca: Biblioteca<93>. 
* Núcleo e embutidos: Núcleo e embutidos<92>. 
* Biblioteca: Biblioteca<94>. 
* Documentação: Documentação<33>. 
* Testes: Testes<37>. 
* Construção: Construção<41>. 
* Windows: Windows<35>. 
* macOS: macOS<27>. 
* IDLE: IDLE<24>. 
* API C: API C<37>. 

Python 3.10.0 alpha 7

* Segurança: Segurança<27>. 
* Núcleo e embutidos: Núcleo e embutidos<93>. 
* Biblioteca: Biblioteca<95>. 
* Núcleo e embutidos: Núcleo e embutidos<94>. 
* Biblioteca: Biblioteca<96>. 
* Documentação: Documentação<34>. 
* Testes: Testes<38>. 
* Construção: Construção<42>. 
* Windows: Windows<36>. 
* IDLE: IDLE<25>. 
* API C: API C<38>. 

Python 3.10.0 alpha 6

* Segurança: Segurança<28>. 
* Núcleo e embutidos: Núcleo e embutidos<95>. 
* Biblioteca: Biblioteca<97>. 
* Núcleo e embutidos: Núcleo e embutidos<96>. 
* Biblioteca: Biblioteca<98>. 
* Núcleo e embutidos: Núcleo e embutidos<97>. 
* Biblioteca: Biblioteca<99>. 
* Documentação: Documentação<35>. 
* Testes: Testes<39>. 
* Construção: Construção<43>. 
* Windows: Windows<37>. 
* macOS: macOS<28>. 
* IDLE: IDLE<26>. 
* API C: API C<39>. 

Python 3.10.0 alpha 5

* Segurança: Segurança<29>. 
* Núcleo e embutidos: Núcleo e embutidos<98>. 
* Biblioteca: Biblioteca<100>. 
* Núcleo e embutidos: Núcleo e embutidos<99>. 
* Biblioteca: Biblioteca<101>. 
* Documentação: Documentação<36>. 
* Testes: Testes<40>. 
* Construção: Construção<44>. 
* Windows: Windows<38>. 
* macOS: macOS<29>. 
* IDLE: IDLE<27>. 
* API C: API C<40>. 

Python 3.10.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<100>. 
* Biblioteca: Biblioteca<102>. 
* Núcleo e embutidos: Núcleo e embutidos<101>. 
* Biblioteca: Biblioteca<103>. 
* Núcleo e embutidos: Núcleo e embutidos<102>. 
* Biblioteca: Biblioteca<104>. 
* Documentação: Documentação<37>. 
* Testes: Testes<41>. 
* Construção: Construção<45>. 
* macOS: macOS<30>. 
* Ferramentas/Demos: Ferramentas/Demos<21>. 
* API C: API C<41>. 

Python 3.10.0 alpha 3

* Segurança: Segurança<30>. 
* Núcleo e embutidos: Núcleo e embutidos<103>. 
* Biblioteca: Biblioteca<105>. 
* Núcleo e embutidos: Núcleo e embutidos<104>. 
* Biblioteca: Biblioteca<106>. 
* Núcleo e embutidos: Núcleo e embutidos<105>. 
* Biblioteca: Biblioteca<107>. 
* Núcleo e embutidos: Núcleo e embutidos<106>. 
* Biblioteca: Biblioteca<108>. 
* Documentação: Documentação<38>. 
* Testes: Testes<42>. 
* Construção: Construção<46>. 
* Windows: Windows<39>. 
* macOS: macOS<31>. 
* IDLE: IDLE<28>. 
* Ferramentas/Demos: Ferramentas/Demos<22>. 
* API C: API C<42>. 

Python 3.10.0 alpha 2

* Segurança: Segurança<31>. 
* Núcleo e embutidos: Núcleo e embutidos<107>. 
* Biblioteca: Biblioteca<109>. 
* Núcleo e embutidos: Núcleo e embutidos<108>. 
* Biblioteca: Biblioteca<110>. 
* Documentação: Documentação<39>. 
* Testes: Testes<43>. 
* Construção: Construção<47>. 
* Windows: Windows<40>. 
* macOS: macOS<32>. 
* IDLE: IDLE<29>. 
* API C: API C<43>. 

Python 3.10.0 alpha 1

* Segurança: Segurança<32>. 
* Núcleo e embutidos: Núcleo e embutidos<109>. 
* Biblioteca: Biblioteca<111>. 
* Núcleo e embutidos: Núcleo e embutidos<110>. 
* Biblioteca: Biblioteca<112>. 
* Núcleo e embutidos: Núcleo e embutidos<111>. 
* Biblioteca: Biblioteca<113>. 
* Núcleo e embutidos: Núcleo e embutidos<112>. 
* Biblioteca: Biblioteca<114>. 
* Núcleo e embutidos: Núcleo e embutidos<113>. 
* Biblioteca: Biblioteca<115>. 
* Núcleo e embutidos: Núcleo e embutidos<114>. 
* Biblioteca: Biblioteca<116>. 
* Núcleo e embutidos: Núcleo e embutidos<115>. 
* Biblioteca: Biblioteca<117>. 
* Núcleo e embutidos: Núcleo e embutidos<116>. 
* Biblioteca: Biblioteca<118>. 
* Núcleo e embutidos: Núcleo e embutidos<117>. 
* Biblioteca: Biblioteca<119>. 
* Núcleo e embutidos: Núcleo e embutidos<118>. 
* Biblioteca: Biblioteca<120>. 
* Núcleo e embutidos: Núcleo e embutidos<119>. 
* Biblioteca: Biblioteca<121>. 
* Núcleo e embutidos: Núcleo e embutidos<120>. 
* Biblioteca: Biblioteca<122>. 
* Núcleo e embutidos: Núcleo e embutidos<121>. 
* Biblioteca: Biblioteca<123>. 
* Núcleo e embutidos: Núcleo e embutidos<122>. 
* Biblioteca: Biblioteca<124>. 
* Núcleo e embutidos: Núcleo e embutidos<123>. 
* Biblioteca: Biblioteca<125>. 
* Documentação: Documentação<40>. 
* Testes: Testes<44>. 
* Construção: Construção<48>. 
* Windows: Windows<41>. 
* macOS: macOS<33>. 
* IDLE: IDLE<30>. 
* API C: API C<44>. 

Python 3.9.0 beta 1

* Segurança: Segurança<33>. 
* Núcleo e embutidos: Núcleo e embutidos<124>. 
* Biblioteca: Biblioteca<126>. 
* Documentação: Documentação<41>. 
* Testes: Testes<45>. 
* Construção: Construção<49>. 
* Windows: Windows<42>. 
* macOS: macOS<34>. 
* Ferramentas/Demos: Ferramentas/Demos<23>. 
* API C: API C<45>. 

Python 3.9.0 alpha 6

* Segurança: Segurança<34>. 
* Núcleo e embutidos: Núcleo e embutidos<125>. 
* Biblioteca: Biblioteca<127>. 
* Documentação: Documentação<42>. 
* Testes: Testes<46>. 
* Construção: Construção<50>. 
* Windows: Windows<43>. 
* macOS: macOS<35>. 
* IDLE: IDLE<31>. 
* Ferramentas/Demos: Ferramentas/Demos<24>. 
* API C: API C<46>. 

Python 3.9.0 alpha 5

* Segurança: Segurança<35>. 
* Núcleo e embutidos: Núcleo e embutidos<126>. 
* Biblioteca: Biblioteca<128>. 
* Documentação: Documentação<43>. 
* Testes: Testes<47>. 
* Construção: Construção<51>. 
* Windows: Windows<44>. 
* macOS: macOS<36>. 
* IDLE: IDLE<32>. 
* Ferramentas/Demos: Ferramentas/Demos<25>. 
* API C: API C<47>. 

Python 3.9.0 alpha 4

* Segurança: Segurança<36>. 
* Núcleo e embutidos: Núcleo e embutidos<127>. 
* Biblioteca: Biblioteca<129>. 
* Documentação: Documentação<44>. 
* Testes: Testes<48>. 
* Construção: Construção<52>. 
* Windows: Windows<45>. 
* IDLE: IDLE<33>. 
* API C: API C<48>. 

Python 3.9.0 alpha 3

* Núcleo e embutidos: Núcleo e embutidos<128>. 
* Biblioteca: Biblioteca<130>. 
* Documentação: Documentação<45>. 
* Construção: Construção<53>. 
* IDLE: IDLE<34>. 
* API C: API C<49>. 

Python 3.9.0 alpha 2

* Segurança: Segurança<37>. 
* Núcleo e embutidos: Núcleo e embutidos<129>. 
* Biblioteca: Biblioteca<131>. 
* Documentação: Documentação<46>. 
* Testes: Testes<49>. 
* Construção: Construção<54>. 
* Windows: Windows<46>. 
* macOS: macOS<37>. 
* IDLE: IDLE<35>. 
* API C: API C<50>. 

Python 3.9.0 alpha 1

* Segurança: Segurança<38>. 
* Núcleo e embutidos: Núcleo e embutidos<130>. 
* Biblioteca: Biblioteca<132>. 
* Documentação: Documentação<47>. 
* Testes: Testes<50>. 
* Construção: Construção<55>. 
* Windows: Windows<47>. 
* macOS: macOS<38>. 
* IDLE: IDLE<36>. 
* Ferramentas/Demos: Ferramentas/Demos<26>. 
* API C: API C<51>. 

Python 3.8.0 beta 1

* Segurança: Segurança<39>. 
* Núcleo e embutidos: Núcleo e embutidos<131>. 
* Biblioteca: Biblioteca<133>. 
* Documentação: Documentação<48>. 
* Testes: Testes<51>. 
* Construção: Construção<56>. 
* Windows: Windows<48>. 
* macOS: macOS<39>. 
* IDLE: IDLE<37>. 
* Ferramentas/Demos: Ferramentas/Demos<27>. 
* API C: API C<52>. 

Python 3.8.0 alpha 4

* Segurança: Segurança<40>. 
* Núcleo e embutidos: Núcleo e embutidos<132>. 
* Biblioteca: Biblioteca<134>. 
* Documentação: Documentação<49>. 
* Testes: Testes<52>. 
* Construção: Construção<57>. 
* Windows: Windows<49>. 
* macOS: macOS<40>. 
* IDLE: IDLE<38>. 
* Ferramentas/Demos: Ferramentas/Demos<28>. 
* API C: API C<53>. 

Python 3.8.0 alpha 3

* Segurança: Segurança<41>. 
* Núcleo e embutidos: Núcleo e embutidos<133>. 
* Biblioteca: Biblioteca<135>. 
* Documentação: Documentação<50>. 
* Testes: Testes<53>. 
* Construção: Construção<58>. 
* Windows: Windows<50>. 
* IDLE: IDLE<39>. 
* Ferramentas/Demos: Ferramentas/Demos<29>. 
* API C: API C<54>. 

Python 3.8.0 alpha 2

* Núcleo e embutidos: Núcleo e embutidos<134>. 
* Biblioteca: Biblioteca<136>. 
* Documentação: Documentação<51>. 
* Testes: Testes<54>. 
* Windows: Windows<51>. 
* IDLE: IDLE<40>. 

Python 3.8.0 alpha 1

* Segurança: Segurança<42>. 
* Núcleo e embutidos: Núcleo e embutidos<135>. 
* Biblioteca: Biblioteca<137>. 
* Documentação: Documentação<52>. 
* Testes: Testes<55>. 
* Construção: Construção<59>. 
* Windows: Windows<52>. 
* macOS: macOS<41>. 
* IDLE: IDLE<41>. 
* Ferramentas/Demos: Ferramentas/Demos<30>. 
* API C: API C<55>. 

Python 3.7.0 final

* Biblioteca: Biblioteca<138>. 
* API C: API C<56>. 

Python 3.7.0 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<136>. 
* Biblioteca: Biblioteca<139>. 
* Documentação: Documentação<53>. 
* Construção: Construção<60>. 
* Windows: Windows<53>. 
* IDLE: IDLE<42>. 

Python 3.7.0 beta 5

* Núcleo e embutidos: Núcleo e embutidos<137>. 
* Biblioteca: Biblioteca<140>. 
* Documentação: Documentação<54>. 
* Testes: Testes<56>. 
* Construção: Construção<61>. 
* macOS: macOS<42>. 
* IDLE: IDLE<43>. 

Python 3.7.0 beta 4

* Núcleo e embutidos: Núcleo e embutidos<138>. 
* Biblioteca: Biblioteca<141>. 
* Documentação: Documentação<55>. 
* Testes: Testes<57>. 
* Construção: Construção<62>. 
* Windows: Windows<54>. 
* macOS: macOS<43>. 
* IDLE: IDLE<44>. 
* Ferramentas/Demos: Ferramentas/Demos<31>. 

Python 3.7.0 beta 3

* Segurança: Segurança<43>. 
* Núcleo e embutidos: Núcleo e embutidos<139>. 
* Biblioteca: Biblioteca<142>. 
* Documentação: Documentação<56>. 
* Testes: Testes<58>. 
* Construção: Construção<63>. 
* Windows: Windows<55>. 
* macOS: macOS<44>. 
* IDLE: IDLE<45>. 
* Ferramentas/Demos: Ferramentas/Demos<32>. 
* API C: API C<57>. 

Python 3.7.0 beta 2

* Segurança: Segurança<44>. 
* Núcleo e embutidos: Núcleo e embutidos<140>. 
* Biblioteca: Biblioteca<143>. 
* Documentação: Documentação<57>. 
* Testes: Testes<59>. 
* Construção: Construção<64>. 
* Windows: Windows<56>. 
* macOS: macOS<45>. 
* IDLE: IDLE<46>. 
* Ferramentas/Demos: Ferramentas/Demos<33>. 

Python 3.7.0 beta 1

* Núcleo e embutidos: Núcleo e embutidos<141>. 
* Biblioteca: Biblioteca<144>. 
* Documentação: Documentação<58>. 
* Testes: Testes<60>. 
* Construção: Construção<65>. 
* Windows: Windows<57>. 
* macOS: macOS<46>. 
* API C: API C<58>. 

Python 3.7.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<142>. 
* Biblioteca: Biblioteca<145>. 
* Documentação: Documentação<59>. 
* Testes: Testes<61>. 
* Windows: Windows<58>. 
* Ferramentas/Demos: Ferramentas/Demos<34>. 
* API C: API C<59>. 

Python 3.7.0 alpha 3

* Núcleo e embutidos: Núcleo e embutidos<143>. 
* Biblioteca: Biblioteca<146>. 
* Documentação: Documentação<60>. 
* Testes: Testes<62>. 
* Construção: Construção<66>. 
* Windows: Windows<59>. 
* macOS: macOS<47>. 
* IDLE: IDLE<47>. 
* Ferramentas/Demos: Ferramentas/Demos<35>. 
* API C: API C<60>. 

Python 3.7.0 alpha 2

* Núcleo e embutidos: Núcleo e embutidos<144>. 
* Biblioteca: Biblioteca<147>. 
* Documentação: Documentação<61>. 
* Construção: Construção<67>. 
* IDLE: IDLE<48>. 
* API C: API C<61>. 

Python 3.7.0 alpha 1

* Segurança: Segurança<45>. 
* Núcleo e embutidos: Núcleo e embutidos<145>. 
* Biblioteca: Biblioteca<148>. 
* Documentação: Documentação<62>. 
* Testes: Testes<63>. 
* Construção: Construção<68>. 
* Windows: Windows<60>. 
* IDLE: IDLE<49>. 
* Ferramentas/Demos: Ferramentas/Demos<36>. 
* API C: API C<62>. 

Python 3.6.6 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<146>. 
* Biblioteca: Biblioteca<149>. 
* Documentação: Documentação<63>. 
* Testes: Testes<64>. 
* Construção: Construção<69>. 
* Windows: Windows<61>. 
* macOS: macOS<48>. 
* IDLE: IDLE<50>. 
* Ferramentas/Demos: Ferramentas/Demos<37>. 
* API C: API C<63>. 

Python 3.6.5 final

* Testes: Testes<65>. 
* Construção: Construção<70>. 

Python 3.6.5 release candidate 1

* Segurança: Segurança<46>. 
* Núcleo e embutidos: Núcleo e embutidos<147>. 
* Biblioteca: Biblioteca<150>. 
* Documentação: Documentação<64>. 
* Testes: Testes<66>. 
* Construção: Construção<71>. 
* Windows: Windows<62>. 
* macOS: macOS<49>. 
* IDLE: IDLE<51>. 
* Ferramentas/Demos: Ferramentas/Demos<38>. 
* API C: API C<64>. 

Python 3.6.4 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<148>. 
* Biblioteca: Biblioteca<151>. 
* Documentação: Documentação<65>. 
* Testes: Testes<67>. 
* Construção: Construção<72>. 
* Windows: Windows<63>. 
* macOS: macOS<50>. 
* IDLE: IDLE<52>. 
* Ferramentas/Demos: Ferramentas/Demos<39>. 
* API C: API C<65>. 

Python 3.6.3 final

* Biblioteca: Biblioteca<152>. 
* Construção: Construção<73>. 

Python 3.6.3 release candidate 1

* Segurança: Segurança<47>. 
* Núcleo e embutidos: Núcleo e embutidos<149>. 
* Biblioteca: Biblioteca<153>. 
* Documentação: Documentação<66>. 
* Testes: Testes<68>. 
* Construção: Construção<74>. 
* Windows: Windows<64>. 
* IDLE: IDLE<53>. 
* Ferramentas/Demos: Ferramentas/Demos<40>. 

Python 3.6.2 release candidate 2

* Segurança: Segurança<48>. 

Python 3.6.2 release candidate 1

* Segurança: Segurança<49>. 
* Núcleo e embutidos: Núcleo e embutidos<150>. 
* Biblioteca: Biblioteca<154>. 
* IDLE: IDLE<54>. 
* API C: API C<66>. 
* Construção: Construção<75>. 
* Documentação: Documentação<67>. 
* Ferramentas/Demos: Ferramentas/Demos<41>. 
* Testes: Testes<69>. 
* Windows: Windows<65>. 

Python 3.6.1 final

* Núcleo e embutidos: Núcleo e embutidos<151>. 
* Construção: Construção<76>. 

Python 3.6.1 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<152>. 
* Biblioteca: Biblioteca<155>. 
* IDLE: IDLE<55>. 
* Windows: Windows<66>. 
* API C: API C<67>. 
* Documentação: Documentação<68>. 
* Testes: Testes<70>. 
* Construção: Construção<77>. 

Python 3.6.0 release candidate 2

* Núcleo e embutidos: Núcleo e embutidos<153>. 
* Ferramentas/Demos: Ferramentas/Demos<42>. 
* Windows: Windows<67>. 
* Construção: Construção<78>. 

Python 3.6.0 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<154>. 
* Biblioteca: Biblioteca<156>. 
* API C: API C<68>. 
* Documentação: Documentação<69>. 
* Ferramentas/Demos: Ferramentas/Demos<43>. 

Python 3.6.0 beta 4

* Núcleo e embutidos: Núcleo e embutidos<155>. 
* Biblioteca: Biblioteca<157>. 
* Documentação: Documentação<70>. 
* Testes: Testes<71>. 
* Construção: Construção<79>. 

Python 3.6.0 beta 3

* Núcleo e embutidos: Núcleo e embutidos<156>. 
* Biblioteca: Biblioteca<158>. 
* Windows: Windows<68>. 
* Construção: Construção<80>. 
* Testes: Testes<72>. 

Python 3.6.0 beta 2

* Núcleo e embutidos: Núcleo e embutidos<157>. 
* Biblioteca: Biblioteca<159>. 
* Windows: Windows<69>. 
* API C: API C<69>. 
* Construção: Construção<81>. 
* Testes: Testes<73>. 

Python 3.6.0 beta 1

* Núcleo e embutidos: Núcleo e embutidos<158>. 
* Biblioteca: Biblioteca<160>. 
* IDLE: IDLE<56>. 
* API C: API C<70>. 
* Testes: Testes<74>. 
* Construção: Construção<82>. 
* Ferramentas/Demos: Ferramentas/Demos<44>. 
* Windows: Windows<70>. 

Python 3.6.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<159>. 
* Biblioteca: Biblioteca<161>. 
* IDLE: IDLE<57>. 
* Testes: Testes<75>. 
* Windows: Windows<71>. 
* Construção: Construção<83>. 

Python 3.6.0 alpha 3

* Segurança: Segurança<50>. 
* Núcleo e embutidos: Núcleo e embutidos<160>. 
* Biblioteca: Biblioteca<162>. 
* IDLE: IDLE<58>. 
* API C: API C<71>. 
* Construção: Construção<84>. 
* Ferramentas/Demos: Ferramentas/Demos<45>. 
* Documentação: Documentação<71>. 
* Testes: Testes<76>. 

Python 3.6.0 alpha 2

* Segurança: Segurança<51>. 
* Núcleo e embutidos: Núcleo e embutidos<161>. 
* Biblioteca: Biblioteca<163>. 
* IDLE: IDLE<59>. 
* Documentação: Documentação<72>. 
* Testes: Testes<77>. 
* Windows: Windows<72>. 
* Construção: Construção<85>. 
* API C: API C<72>. 
* Ferramentas/Demos: Ferramentas/Demos<46>. 

Python 3.6.0 alpha 1

* Segurança: Segurança<52>. 
* Núcleo e embutidos: Núcleo e embutidos<162>. 
* Biblioteca: Biblioteca<164>. 
* IDLE: IDLE<60>. 
* Documentação: Documentação<73>. 
* Testes: Testes<78>. 
* Construção: Construção<86>. 
* Windows: Windows<73>. 
* Ferramentas/Demos: Ferramentas/Demos<47>. 
* API C: API C<73>. 

Python 3.5.5 release candidate 1

* Segurança: Segurança<53>. 
* Núcleo e embutidos: Núcleo e embutidos<163>. 
* Biblioteca: Biblioteca<165>. 

Python 3.5.4 final

* Biblioteca: Biblioteca<166>. 

Python 3.5.4 release candidate 1

* Segurança: Segurança<54>. 
* Núcleo e embutidos: Núcleo e embutidos<164>. 
* Biblioteca: Biblioteca<167>. 
* Documentação: Documentação<74>. 
* Testes: Testes<79>. 
* Construção: Construção<87>. 
* Windows: Windows<74>. 
* API C: API C<74>. 

Python 3.5.3 release candidate 1

* Segurança: Segurança<55>. 
* Núcleo e embutidos: Núcleo e embutidos<165>. 
* Biblioteca: Biblioteca<168>. 
* IDLE: IDLE<61>. 
* API C: API C<75>. 
* Documentação: Documentação<75>. 
* Testes: Testes<80>. 
* Ferramentas/Demos: Ferramentas/Demos<48>. 
* Windows: Windows<75>. 
* Construção: Construção<88>. 

Python 3.5.2 final

* Núcleo e embutidos: Núcleo e embutidos<166>. 
* Testes: Testes<81>. 
* IDLE: IDLE<62>. 

Python 3.5.2 release candidate 1

* Segurança: Segurança<56>. 
* Núcleo e embutidos: Núcleo e embutidos<167>. 
* Biblioteca: Biblioteca<169>. 
* IDLE: IDLE<63>. 
* Documentação: Documentação<76>. 
* Testes: Testes<82>. 
* Construção: Construção<89>. 
* Windows: Windows<76>. 
* Ferramentas/Demos: Ferramentas/Demos<49>. 

Python 3.5.1 final

* Núcleo e embutidos: Núcleo e embutidos<168>. 
* Windows: Windows<77>. 

Python 3.5.1 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<169>. 
* Biblioteca: Biblioteca<170>. 
* IDLE: IDLE<64>. 
* Documentação: Documentação<77>. 
* Testes: Testes<83>. 
* Construção: Construção<90>. 
* Windows: Windows<78>. 
* Ferramentas/Demos: Ferramentas/Demos<50>. 

Python 3.5.0 final

* Construção: Construção<91>. 

Python 3.5.0 release candidate 4

* Biblioteca: Biblioteca<171>. 
* Construção: Construção<92>. 

Python 3.5.0 release candidate 3

* Núcleo e embutidos: Núcleo e embutidos<170>. 
* Biblioteca: Biblioteca<172>. 

Python 3.5.0 release candidate 2

* Núcleo e embutidos: Núcleo e embutidos<171>. 
* Biblioteca: Biblioteca<173>. 

Python 3.5.0 release candidate 1

* Núcleo e embutidos: Núcleo e embutidos<172>. 
* Biblioteca: Biblioteca<174>. 
* IDLE: IDLE<65>. 
* Documentação: Documentação<78>. 
* Testes: Testes<84>. 

Python 3.5.0 beta 4

* Núcleo e embutidos: Núcleo e embutidos<173>. 
* Biblioteca: Biblioteca<175>. 
* Construção: Construção<93>. 

Python 3.5.0 beta 3

* Núcleo e embutidos: Núcleo e embutidos<174>. 
* Biblioteca: Biblioteca<176>. 
* Testes: Testes<85>. 
* Documentação: Documentação<79>. 
* Construção: Construção<94>. 

Python 3.5.0 beta 2

* Núcleo e embutidos: Núcleo e embutidos<175>. 
* Biblioteca: Biblioteca<177>. 

Python 3.5.0 beta 1

* Núcleo e embutidos: Núcleo e embutidos<176>. 
* Biblioteca: Biblioteca<178>. 
* IDLE: IDLE<66>. 
* Testes: Testes<86>. 
* Documentação: Documentação<80>. 
* Ferramentas/Demos: Ferramentas/Demos<51>. 

Python 3.5.0 alpha 4

* Núcleo e embutidos: Núcleo e embutidos<177>. 
* Biblioteca: Biblioteca<179>. 
* Construção: Construção<95>. 
* Testes: Testes<87>. 
* Ferramentas/Demos: Ferramentas/Demos<52>. 
* API C: API C<76>. 

Python 3.5.0 alpha 3

* Núcleo e embutidos: Núcleo e embutidos<178>. 
* Biblioteca: Biblioteca<180>. 
* Construção: Construção<96>. 
* Testes: Testes<88>. 
* Ferramentas/Demos: Ferramentas/Demos<53>. 

Python 3.5.0 alpha 2

* Núcleo e embutidos: Núcleo e embutidos<179>. 
* Biblioteca: Biblioteca<181>. 
* Construção: Construção<97>. 
* API C: API C<77>. 
* Windows: Windows<79>. 

Python 3.5.0 alpha 1

* Núcleo e embutidos: Núcleo e embutidos<180>. 
* Biblioteca: Biblioteca<182>. 
* IDLE: IDLE<67>. 
* Construção: Construção<98>. 
* API C: API C<78>. 
* Documentação: Documentação<81>. 
* Testes: Testes<89>. 
* Ferramentas/Demos: Ferramentas/Demos<54>. 
* Windows: Windows<80>. 

O tutorial do Python

* Abrindo seu apetite:: 
* Utilizando o interpretador Python:: 
* Uma introdução informal ao Python:: 
* Mais ferramentas de controle de fluxo:: 
* Estruturas de dados:: 
* Módulos: Módulos<2>. 
* Entrada e Saída:: 
* Erros e exceções:: 
* Classes:: 
* Um breve passeio pela biblioteca padrão:: 
* Um breve passeio pela biblioteca padrão — parte II:: 
* Ambientes virtuais e pacotes:: 
* E agora?:: 
* Edição de entrada interativa e substituição de histórico:: 
* Aritmética de ponto flutuante; problemas e limitações: Aritmética de ponto flutuante problemas e limitações. 
* Anexo:: 

Utilizando o interpretador Python

* Chamando o interpretador:: 
* O interpretador e seu ambiente:: 

Chamando o interpretador

* Passagem de argumentos:: 
* Modo interativo:: 

O interpretador e seu ambiente

* Edição de código-fonte:: 

Uma introdução informal ao Python

* Usando Python como uma calculadora:: 
* Primeiros passos para a programação:: 

Usando Python como uma calculadora

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

Mais ferramentas de controle de fluxo

* Instruções if:: 
* Instruções for:: 
* A função range(): A função range. 
* Instruções break e continue:: 
* Cláusulas else em laços:: 
* Instruções pass:: 
* Instruções match:: 
* Definindo funções:: 
* Mais sobre definição de funções:: 
* Intermezzo; estilo de codificação: Intermezzo estilo de codificação. 

Mais sobre definição de funções

* Argumentos com valor padrão:: 
* Argumentos nomeados:: 
* Parâmetros especiais:: 
* Listas de argumentos arbitrárias:: 
* Desempacotando listas de argumentos:: 
* Expressões lambda:: 
* Strings de documentação:: 
* Anotações de função:: 

Parâmetros especiais

* Argumentos posicional-ou-nomeados:: 
* Parâmetros somente-posicionais: Parâmetros somente-posicionais<2>. 
* Argumentos somente-nomeados:: 
* Exemplos de funções:: 
* Recapitulando:: 

Estruturas de dados

* Mais sobre listas:: 
* A instrução del:: 
* Tuplas e Sequências:: 
* Conjuntos:: 
* Dicionários:: 
* Técnicas de iteração:: 
* Mais sobre condições:: 
* Comparando sequências e outros tipos:: 

Mais sobre listas

* Usando listas como pilhas:: 
* Usando listas como filas:: 
* Compreensões de lista: Compreensões de lista<2>. 
* Compreensões de lista aninhadas:: 

Módulos

* Mais sobre módulos:: 
* Módulos padrões:: 
* A função dir(): A função dir. 
* Pacotes:: 

Mais sobre módulos

* Executando módulos como scripts:: 
* O caminho de busca dos módulos:: 
* Arquivos Python “compilados”:: 

Pacotes

* Importando * de um pacote:: 
* Referências em um mesmo pacote:: 
* Pacotes em múltiplos diretórios:: 

Entrada e Saída

* Refinando a formatação de saída:: 
* Leitura e escrita de arquivos:: 

Refinando a formatação de saída

* Strings literais formatadas:: 
* O método format(): O método format. 
* Formatação manual de string:: 
* Formatação de strings à moda antiga:: 

Leitura e escrita de arquivos

* Métodos de objetos arquivo:: 
* Gravando dados estruturados com json:: 

Erros e exceções

* Erros de sintaxe:: 
* Exceções:: 
* Tratamento de exceções:: 
* Levantando exceções:: 
* Encadeamento de exceções:: 
* Exceções definidas pelo usuário:: 
* Definindo ações de limpeza:: 
* Ações de limpeza predefinidas:: 
* Criando e tratando várias exceções não relacionadas:: 
* Enriquecendo exceções com notas:: 

Classes

* Uma palavra sobre nomes e objetos:: 
* Escopos e espaços de nomes do Python:: 
* Uma primeira olhada nas classes:: 
* Observações aleatórias:: 
* Herança:: 
* Variáveis privadas:: 
* Curiosidades e conclusões:: 
* Iteradores:: 
* Geradores:: 
* Expressões geradoras:: 

Escopos e espaços de nomes do Python

* Exemplo de escopos e espaço de nomes:: 

Uma primeira olhada nas classes

* Sintaxe da definição de classe:: 
* Objetos classe:: 
* Objetos instância:: 
* Objetos método:: 
* Variáveis de classe e instância:: 

Herança

* Herança múltipla:: 

Um breve passeio pela biblioteca padrão

* Interface com o sistema operacional:: 
* Caracteres curinga:: 
* Argumentos de linha de comando:: 
* Redirecionamento de erros e encerramento do programa:: 
* Reconhecimento de padrões em strings:: 
* Matemática:: 
* Acesso à internet:: 
* Data e hora:: 
* Compressão de dados:: 
* Medição de desempenho:: 
* Controle de qualidade:: 
* Baterias incluídas:: 

Um breve passeio pela biblioteca padrão — parte II

* Formatando a saída:: 
* Usando templates:: 
* Trabalhando com formatos binários de dados:: 
* Multi-threading: Multi-threading<2>. 
* Gerando logs:: 
* Referências fracas:: 
* Ferramentas para trabalhar com listas:: 
* Aritmética decimal com ponto flutuante:: 

Ambientes virtuais e pacotes

* Introdução: Introdução<4>. 
* Criando ambientes virtuais:: 
* Gerenciando pacotes com o pip:: 

Edição de entrada interativa e substituição de histórico

* Tab completion e histórico de edição:: 
* Alternativas ao interpretador interativo:: 

Aritmética de ponto flutuante: problemas e limitações

* Erro de representação:: 

Anexo

* Modo interativo: Modo interativo<2>. 

Modo interativo

* Tratamento de erros:: 
* Scripts Python executáveis:: 
* Arquivo de inicialização do modo interativo:: 
* Módulos de customização:: 

Configurações e Uso do Python

* Linha de comando e ambiente:: 
* Utilizando Python em plataformas Unix:: 
* Configurando o Python:: 
* Utilizando Python no Windows:: 
* Usando Python em macOS:: 
* Utilizando Python no Android:: 
* Usando Python no iOS:: 
* Editores e IDEs:: 

Linha de comando e ambiente

* Linha de comando:: 
* Variáveis de ambiente:: 

Linha de comando

* Opções de interface:: 
* Opções genéricas:: 
* Opções diversas:: 
* Controlando cores:: 
* Opções que você não deve usar:: 

Variáveis de ambiente

* Variáveis de modo de depuração:: 

Utilizando Python em plataformas Unix

* Obtendo e instalando a versão mais recente do Python:: 
* Compilando o Python:: 
* Paths e arquivos relacionados com o Python:: 
* Diversos: Diversos<2>. 
* OpenSSL personalizado:: 

Obtendo e instalando a versão mais recente do Python

* No Linux:: 
* No FreeBSD e OpenBSD:: 

No Linux

* Instalação do IDLE:: 

Configurando o Python

* Requisitos de construção:: 
* Arquivos gerados:: 
* Opções de configuração:: 
* Sistema de Construção Python:: 
* Sinalizadores do compilador e do vinculador:: 

Arquivos gerados

* Script configure:: 

Opções de configuração

* Opções gerais:: 
* Opções do compilador C:: 
* Opções da ligação:: 
* Opções para dependências de terceiros:: 
* Opções de WebAssembly:: 
* Opções de instalação:: 
* Opções de desempenho:: 
* Compilação de depuração do Python:: 
* Opções de depuração:: 
* Opções da ligação: Opções da ligação<2>. 
* Opções da biblioteca:: 
* Opções de segurança:: 
* Opções do macOS:: 
* Opções do iOS:: 
* Opções de compilação cruzada:: 

Sistema de Construção Python

* Arquivos principais do sistema de construção:: 
* Principais etapas de construção:: 
* Alvos principais do Makefile:: 
* Extensões C:: 

Alvos principais do Makefile

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

Sinalizadores do compilador e do vinculador

* Sinalizadores do pré-processador:: 
* Sinalizadores do compilador:: 
* Sinalizadores do vinculador:: 

Utilizando Python no Windows

* O instalador completo:: 
* O pacote Microsoft Store:: 
* Os pacotes nuget.org: Os pacotes nuget org. 
* O pacote embutível:: 
* Pacotes Alternativos:: 
* Configurando o Python: Configurando o Python<2>. 
* Modo UTF-8:: 
* Inicializador Python para Windows:: 
* Encontrando módulos:: 
* Módulos adicionais:: 
* Compilando Python no Windows:: 
* Outras plataformas:: 

O instalador completo

* Etapas de instalação:: 
* Removendo a Limitação do MAX_PATH:: 
* Instalando sem UI:: 
* Instalando Sem Download:: 
* Modificando uma instalação:: 
* Instalando binários com threads livres:: 

O pacote Microsoft Store

* Problemas conhecidos:: 

Problemas conhecidos

* Redirecionamento de dados locais@comma{} registro e caminhos temporários: Redirecionamento de dados locais registro e caminhos temporários. 

Os pacotes nuget.org

* Pacotes com threads livres:: 

O pacote embutível

* Aplicação Python:: 
* Incorporando Python:: 

Configurando o Python

* Excursus; Configurando variáveis de ambiente: Excursus Configurando variáveis de ambiente. 
* Encontrando o executável do Python:: 

Inicializador Python para Windows

* Começando:: 
* Linhas Shebang:: 
* Argumentos em linhas shebang:: 
* Personalização:: 
* Diagnósticos:: 
* Teste de simulação:: 
* Instalar sob demanda:: 
* Códigos de retorno:: 

Começando

* Pela linha de comando:: 
* Ambientes virtuais:: 
* Por um script:: 
* Por associação de arquivos:: 

Personalização

* Personalização via arquivos INI:: 
* Personalizando versões padrão do Python:: 

Módulos adicionais

* PyWin32:: 
* cx_Freeze:: 

Usando Python em macOS

* Usando Python para macOS do python.org: Usando Python para macOS do python org. 
* Distribuições alternativas:: 
* Instalando pacotes adicionais ao python:: 
* Programação de GUI:: 
* Tópicos Avançados:: 
* Outros recursos:: 

Usando Python para macOS do python.org

* Etapas de instalação: Etapas de instalação<2>. 
* Como executar um script Python:: 

Tópicos Avançados

* Instalando binários com threads livres: Instalando binários com threads livres<2>. 
* Instalação usando a linha de comando:: 
* Distribuindo aplicações Python:: 
* Conformidade com a App Store:: 

Utilizando Python no Android

* Adicionando Python a uma aplicação Android:: 
* Construindo um pacote Python para Android:: 

Usando Python no iOS

* Python em tempo de execução no iOS:: 
* Instalando Python no iOS:: 
* Conformidade com a App Store: Conformidade com a App Store<2>. 

Python em tempo de execução no iOS

* Compatibilidade com a versão do iOS:: 
* Identificação da plataforma:: 
* Disponibilidade da biblioteca padrão:: 
* Módulos de extensão binária:: 
* Binários stub do compilador:: 

Instalando Python no iOS

* Ferramentas para construir aplicações de iOS:: 
* Adicionando Python a um projeto iOS:: 
* Testando um pacote Python:: 

Editores e IDEs

* IDLE — editor e console Python:: 
* Outros editores e IDEs:: 

A Referência da Linguagem Python

* Introdução: Introdução<5>. 
* Análise léxica:: 
* Modelo de dados:: 
* Modelo de execução:: 
* O sistema de importação:: 
* Expressões:: 
* Instruções simples:: 
* Instruções compostas:: 
* Componentes de Alto Nível:: 
* Especificação completa da gramática:: 

Introdução

* Implementações Alternativas:: 
* Notação:: 

Análise léxica

* Estrutura das linhas:: 
* Outros tokens:: 
* Identificadores e palavras-chave:: 
* Literais:: 
* Operadores:: 
* Delimitadores:: 

Estrutura das linhas

* Linhas lógicas:: 
* Linhas físicas:: 
* Comentários:: 
* Declarações de codificação:: 
* Junção de linha explícita:: 
* Junção de linha implícita:: 
* Linhas em branco:: 
* Indentação:: 
* Espaços em branco entre tokens:: 

Identificadores e palavras-chave

* Palavras reservadas:: 
* Palavras reservadas contextuais:: 
* Classes reservadas de identificadores:: 

Literais

* Literais de string e bytes:: 
* Concatenação de literal de string:: 
* f-strings:: 
* Literais numéricos:: 
* Inteiros literais:: 
* Literais de ponto flutuante:: 
* Literais imaginários:: 

Literais de string e bytes

* Sequências de escape:: 

Modelo de dados

* Objetos@comma{} valores e tipos: Objetos valores e tipos. 
* A hierarquia de tipos padrão:: 
* Nomes de métodos especiais:: 
* Corrotinas:: 

A hierarquia de tipos padrão

* None:: 
* NotImplemented:: 
* Ellipsis:: 
* numbers.Number: numbers Number. 
* Sequências:: 
* Tipos de conjuntos:: 
* Mapeamentos:: 
* Tipos chamáveis:: 
* Módulos: Módulos<3>. 
* Classes personalizadas:: 
* Instâncias de classe: Instâncias de classe<2>. 
* Objetos de E/S (também conhecidos como objetos arquivo): Objetos de E/S também conhecidos como objetos arquivo. 
* Tipos internos:: 

numbers.Number

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

Sequências

* Sequências imutáveis:: 
* Sequências mutáveis:: 

Mapeamentos

* Dicionários: Dicionários<2>. 

Tipos chamáveis

* Funções definidas pelo usuário:: 
* Métodos de instância:: 
* Funções geradoras:: 
* Funções de corrotina:: 
* Funções geradoras assíncronas:: 
* Funções embutidas: Funções embutidas<2>. 
* Métodos embutidos:: 
* Classes: Classes<2>. 
* Instâncias de classe:: 

Funções definidas pelo usuário

* Atributos especiais de somente leitura:: 
* Atributos especiais graváveis:: 

Módulos

* Atributos relacionados à importação em objetos de módulo:: 
* Outros atributos graváveis em objetos de módulo:: 
* Dicionários do módulo:: 

Classes personalizadas

* Atributos especiais:: 
* Métodos especiais:: 

Instâncias de classe

* Atributos especiais: Atributos especiais<2>. 

Tipos internos

* Objetos código:: 
* Objetos quadro:: 
* Objetos traceback:: 
* Objetos slice:: 
* Objetos método estático:: 
* Objetos método de classe:: 

Objetos código

* Atributos especiais de somente leitura: Atributos especiais de somente leitura<2>. 
* Métodos de objetos código:: 

Objetos quadro

* Atributos especiais de somente leitura: Atributos especiais de somente leitura<3>. 
* Atributos especiais graváveis: Atributos especiais graváveis<2>. 
* Métodos de objetos quadro:: 

Nomes de métodos especiais

* Personalização básica:: 
* Personalizando o acesso aos atributos:: 
* Personalizando a criação de classe:: 
* Personalizando verificações de instância e subclasse:: 
* Emulando tipos genéricos:: 
* Emulando objetos chamáveis:: 
* Emulando tipos contêineres:: 
* Emulando tipos numéricos:: 
* Gerenciadores de contexto da instrução with:: 
* Customizando argumentos posicionais na classe correspondência de padrão:: 
* Emulando tipos buffer:: 
* Pesquisa de método especial:: 

Personalizando o acesso aos atributos

* Personalizando acesso a atributos de módulos:: 
* Implementando descritores:: 
* Invocando descritores:: 
* __slots__: __slots__<2>. 

Personalizando a criação de classe

* Metaclasses:: 
* Resolvendo entradas de MRO:: 
* Determinando a metaclasse apropriada:: 
* Preparando o espaço de nomes da classe:: 
* Executando o corpo da classe:: 
* Criando o objeto classe:: 
* Usos para metaclasses:: 

Emulando tipos genéricos

* O propósito de __class_getitem__:: 
* __class_getitem__ versus __getitem__:: 

Corrotinas

* Objetos aguardáveis:: 
* Objetos corrotina:: 
* Iteradores assíncronos:: 
* Gerenciadores de contexto assíncronos:: 

Modelo de execução

* Estrutura de um programa:: 
* Nomeação e ligação:: 
* Exceções: Exceções<2>. 

Nomeação e ligação

* Ligação de nomes:: 
* Resolução de nomes:: 
* Escopos de anotação:: 
* Avaliação preguiçosa:: 
* Builtins e execução restrita:: 
* Interação com recursos dinâmicos:: 

O sistema de importação

* importlib: importlib<10>. 
* Pacotes: Pacotes<2>. 
* Caminho de busca:: 
* Carregando:: 
* O localizador baseado no caminho:: 
* Substituindo o sistema de importação padrão:: 
* Importações relativas ao pacote:: 
* Considerações especiais para __main__:: 
* Referências:: 

Pacotes

* Pacotes regulares:: 
* Pacotes de espaço de nomes:: 

Caminho de busca

* O cache de módulos:: 
* Localizadores e carregadores:: 
* Ganchos de importação:: 
* O metacaminho:: 

Carregando

* Carregadores:: 
* Submódulos:: 
* Especificações de módulo:: 
* Atributo __path__ dos módulos:: 
* Representações do módulo:: 
* Invalidação de bytecode em cache:: 

O localizador baseado no caminho

* Localizadores de entrada de caminho:: 
* Protocolo do localizador de entrada de caminho:: 

Considerações especiais para __main__

* __main__.__spec__: __main__ __spec__. 

Expressões

* Conversões aritméticas:: 
* Átomos:: 
* Primárias:: 
* Expressão await:: 
* O operador de potência:: 
* Operações aritméticas unárias e bit a bit:: 
* Operações binárias aritméticas:: 
* Operações de deslocamento:: 
* Operações binárias bit a bit:: 
* Comparações:: 
* Operações booleanas:: 
* Expressões de atribuição: Expressões de atribuição<2>. 
* Expressões condicionais:: 
* Lambdas:: 
* Listas de expressões:: 
* Ordem de avaliação:: 
* Precedência de operadores:: 

Átomos

* Identificadores (Nomes): Identificadores Nomes. 
* Literais: Literais<2>. 
* Formas de parênteses:: 
* Sintaxe de criação de listas@comma{} conjuntos e dicionários: Sintaxe de criação de listas conjuntos e dicionários. 
* Sintaxes de criação de lista:: 
* Sintaxes de criação de conjunto:: 
* Sintaxes de criação de dicionário:: 
* Expressões geradoras: Expressões geradoras<2>. 
* Expressões yield:: 

Identificadores (Nomes)

* Desfiguração de nome privado:: 

Expressões yield

* Métodos de iterador gerador:: 
* Exemplos:: 
* Funções geradoras assíncronas: Funções geradoras assíncronas<2>. 
* Métodos geradores-iteradores assíncronos:: 

Primárias

* Referências de atributo:: 
* Subscrições:: 
* Fatiamentos:: 
* Chamadas:: 

Comparações

* Comparações de valor:: 
* Operações de teste de pertinência:: 
* Comparações de identidade:: 

Instruções simples

* Instruções de expressão:: 
* Instruções de atribuição:: 
* A instrução assert:: 
* A instrução pass:: 
* A instrução del: A instrução del<2>. 
* A instrução return:: 
* A instrução yield:: 
* A instrução raise:: 
* A instrução break:: 
* A instrução continue:: 
* A instrução import:: 
* A instrução global:: 
* A instrução nonlocal:: 
* A instrução type:: 

Instruções de atribuição

* Instruções de atribuição aumentada:: 
* instruções de atribuição anotado:: 

A instrução import

* Instruções future:: 

Instruções compostas

* A instrução if:: 
* A instrução while:: 
* A instrução for:: 
* A instrução try:: 
* A instrução with:: 
* A instrução match:: 
* Definições de função:: 
* Definições de classe:: 
* Corrotinas: Corrotinas<2>. 
* Listas de parâmetros de tipo:: 

A instrução try

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

A instrução match

* Visão Geral:: 
* Guards:: 
* Blocos irrefutáveis de case:: 
* Padrões:: 

Padrões

* Padrões OR:: 
* Padrões AS:: 
* Padrões literais:: 
* Padrões de captura:: 
* Padrões curingas:: 
* Padrões de valor:: 
* Padrões de grupo:: 
* Padrões de sequência:: 
* Padrões de mapeamento:: 
* Padrões de classe:: 

Corrotinas

* Definição de função de corrotina:: 
* A instrução async for:: 
* A instrução async with:: 

Listas de parâmetros de tipo

* Funções genéricas:: 
* Classes genéricas:: 
* Apelidos de tipo genérico:: 

Componentes de Alto Nível

* Programas Python completos:: 
* Entrada de arquivo:: 
* Entrada interativa:: 
* Entrada de expressão:: 

A Biblioteca Padrão do Python

* Introdução: Introdução<6>. 
* Funções embutidas: Funções embutidas<3>. 
* Constantes embutidas:: 
* Tipos embutidos:: 
* Exceções embutidas:: 
* Serviços de Processamento de Texto:: 
* Serviços de Dados Binários:: 
* Tipos de Dados:: 
* Módulos Matemáticos e Numéricos:: 
* Módulos de Programação Funcional:: 
* Acesso a arquivos e diretórios:: 
* Persistência de Dados:: 
* Compressão de Dados e Arquivamento:: 
* Formatos de Arquivo:: 
* Serviços Criptográficos:: 
* Serviços Genéricos do Sistema Operacional:: 
* Bibliotecas de interface de linha de comando:: 
* Execução Concorrente:: 
* Comunicação em Rede e Interprocesso:: 
* Manuseio de Dados na Internet:: 
* Ferramentas de Processamento de Markup Estruturado:: 
* Protocolos de Internet e Suporte:: 
* Serviços Multimídia:: 
* Internacionalização:: 
* Interfaces gráficas de usuário com Tk:: 
* Ferramentas de Desenvolvimento:: 
* Depuração e perfilamento:: 
* Empacotamento e Distribuição de Software:: 
* Serviços de Tempo de Execução Python:: 
* Interpretadores Python Personalizados:: 
* Importando módulos:: 
* Serviços da Linguagem Python:: 
* Serviços Específicos do MS Windows:: 
* Serviços específicos do Unix:: 
* Interface de linha de comando (CLI) de módulos: Interface de linha de comando CLI de módulos. 
* Módulos substituídos:: 
* Módulos removidos:: 
* Considerações de Segurança: Considerações de Segurança<3>. 

Introdução

* Observações sobre disponibilidade:: 

Observações sobre disponibilidade

* Plataformas WebAssembly:: 
* Plataformas móveis:: 

Constantes embutidas

* Constantes adicionadas pelo módulo site:: 

Tipos embutidos

* Teste do valor verdade:: 
* Operações booleanas — and@comma{} or@comma{} not: Operações booleanas — and or not. 
* Comparações: Comparações<2>. 
* Tipos numéricos — int@comma{} float@comma{} complex: Tipos numéricos — int float complex. 
* Tipo booleano - bool:: 
* Tipos iteradores:: 
* Tipos sequências — list@comma{} tuple@comma{} range: Tipos sequências — list tuple range. 
* Tipo sequência de texto — str:: 
* Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview: Tipos de sequência binária — bytes bytearray memoryview. 
* Tipo conjuntos — set@comma{} frozenset: Tipo conjuntos — set frozenset. 
* Tipo mapeamento — dict:: 
* Tipos de Gerenciador de Contexto:: 
* Tipos de anotação de tipo — Apelido genérico@comma{} União: Tipos de anotação de tipo — Apelido genérico União. 
* Outros tipos embutidos:: 
* Atributos Especiais:: 
* Limitação de comprimento de string na conversão para inteiro:: 

Tipos numéricos — int, float, complex

* Operações de bits em tipos inteiros:: 
* Métodos adicionais em tipos inteiros:: 
* Métodos adicionais em ponto flutuante:: 
* Hashing de tipos numéricos:: 

Tipos iteradores

* Tipos geradores:: 

Tipos sequências — list, tuple, range

* Operações comuns de sequências:: 
* Tipos sequência imutáveis:: 
* Tipos sequências mutáveis:: 
* Listas: Listas<2>. 
* Tuplas:: 
* Intervalos:: 

Tipo sequência de texto — str

* String Methods: String Methods<2>. 
* Strings literais formatadas (f-strings): Strings literais formatadas f-strings. 
* Formatação de string no estilo printf:: 

Tipos de sequência binária — bytes, bytearray, memoryview

* Objetos bytes:: 
* Objetos Bytearray:: 
* Operações com Bytes e Bytearray:: 
* Estilo de Formatação de bytes printf-style:: 
* Memory Views:: 

Tipo mapeamento — dict

* Objetos de visão de dicionário:: 

Tipos de anotação de tipo — Apelido genérico, União

* Tipo Generic Alias:: 
* Tipo União:: 

Tipo Generic Alias

* Classes genéricas padrão:: 
* Atributos especiais de objetos GenericAlias:: 

Outros tipos embutidos

* Módulos: Módulos<4>. 
* Classes e Instâncias de Classes:: 
* Funções:: 
* Métodos:: 
* Objetos código: Objetos código<2>. 
* Objetos tipo:: 
* O objeto nulo:: 
* O Objeto Ellipsis:: 
* O Objeto NotImplemented:: 
* Objetos Internos:: 

Limitação de comprimento de string na conversão para inteiro

* APIs afetadas:: 
* Configurando o limiter:: 
* Configuração recomendada:: 

Exceções embutidas

* Contexto da exceção:: 
* Herdando de exceções embutidas:: 
* Classes base:: 
* Exceções concretas:: 
* Avisos:: 
* Grupos de exceções:: 
* Hierarquia das exceções:: 

Exceções concretas

* Exceções de sistema operacional:: 

Serviços de Processamento de Texto

* string — Operações comuns de strings:: 
* re — Operações com expressões regulares:: 
* difflib — Helpers for computing deltas:: 
* textwrap — Quebra automática e preenchimento de texto:: 
* unicodedata — Banco de dados de Unicode:: 
* stringprep — Preparação de string para internet:: 
* readline — Interface para o GNU readline:: 
* rlcompleter — Função de autocomplemento para GNU readline:: 

string — Operações comuns de strings

* Constantes de strings:: 
* Formatação personalizada de strings:: 
* Sintaxe das strings de formato:: 
* Strings template:: 
* Funções auxiliares:: 

Sintaxe das strings de formato

* Minilinguagem de especificação de formato:: 
* Exemplos de formato:: 

re — Operações com expressões regulares

* Sintaxe de expressão regular:: 
* Conteúdo do módulo:: 
* Objetos expressão regular:: 
* Objetos correspondência:: 
* Exemplos de expressão regular:: 

Conteúdo do módulo

* Sinalizadores:: 
* Funções: Funções<2>. 
* Exceções: Exceções<3>. 

Exemplos de expressão regular

* Verificando por um par:: 
* Simulando scanf(): Simulando scanf. 
* search() vs. match(): search vs match. 
* Criando uma lista telefônica:: 
* Mastigando texto:: 
* Encontrando todos os advérbios:: 
* Encontrando todos os advérbios e suas posições:: 
* Notação de string bruta:: 
* Escrevendo um tokenizador:: 

difflib — Helpers for computing deltas

* SequenceMatcher Objects:: 
* SequenceMatcher Examples:: 
* Differ Objects:: 
* Differ Example:: 
* A command-line interface to difflib:: 
* ndiff example:: 

readline — Interface para o GNU readline

* Arquivo init:: 
* Buffer de linha:: 
* Arquivo de histórico:: 
* Lista de histórico:: 
* Ganchos de inicialização:: 
* Autocomplemento:: 
* Exemplo:: 

Serviços de Dados Binários

* struct — Interpreta bytes como dados binários empacotados:: 
* codecs — Codec registry and base classes:: 

struct — Interpreta bytes como dados binários empacotados

* Funções e exceções:: 
* Format Strings:: 
* Applications:: 
* Classes: Classes<3>. 

Format Strings

* Byte Order@comma{} Size@comma{} and Alignment: Byte Order Size and Alignment. 
* Caracteres Formatados:: 
* Exemplos: Exemplos<2>. 

Applications

* Native Formats:: 
* Standard Formats:: 

codecs — Codec registry and base classes

* Codec Base Classes:: 
* Encodings and Unicode:: 
* Standard Encodings:: 
* Python Specific Encodings:: 
* encodings — Encodings package:: 
* encodings.idna — Internationalized Domain Names in Applications: encodings idna — Internationalized Domain Names in Applications. 
* encodings.mbcs — Windows ANSI codepage: encodings mbcs — Windows ANSI codepage. 
* encodings.utf_8_sig — UTF-8 codec with BOM signature: encodings utf_8_sig — UTF-8 codec with BOM signature. 

Codec Base Classes

* Error Handlers:: 
* Stateless Encoding and Decoding:: 
* Incremental Encoding and Decoding:: 
* Stream Encoding and Decoding:: 

Incremental Encoding and Decoding

* IncrementalEncoder Objects:: 
* IncrementalDecoder Objects:: 

Stream Encoding and Decoding

* StreamWriter Objects:: 
* StreamReader Objects:: 
* StreamReaderWriter Objects:: 
* StreamRecoder Objects:: 

Python Specific Encodings

* Text Encodings:: 
* Binary Transforms:: 
* Standalone Codec Functions:: 
* Text Transforms:: 

Tipos de Dados

* datetime — Tipos básicos de data e hora:: 
* zoneinfo — Suporte a fuso horário da IANA:: 
* calendar — Funções gerais relacionadas ao calendário:: 
* collections — Tipos de dados de contêineres:: 
* collections.abc — Classes Base Abstratas para Contêineres: collections abc — Classes Base Abstratas para Contêineres. 
* heapq — Algoritmo de fila heap:: 
* bisect — Algoritmo de bisseção de vetor:: 
* array— Vetores eficientes de valores numéricos:: 
* weakref — Referências fracas:: 
* types — Criação de tipos dinâmicos e nomes para tipos embutidos:: 
* copy — Operações de cópia profunda e cópia rasa:: 
* pprint — Impressão bonita de dados:: 
* reprlib — Implementação alternativa à repr(): reprlib — Implementação alternativa à repr. 
* enum — Suporte a enumerações:: 
* graphlib — Funcionalidade para operar com estruturas do tipo grafo:: 

datetime — Tipos básicos de data e hora

* Objetos Conscientes e Ingênuos:: 
* Constantes:: 
* Tipos disponíveis:: 
* Objetos timedelta:: 
* Objetos date:: 
* Objetos datetime:: 
* Objetos time:: 
* Objetos tzinfo:: 
* Objetos timezone:: 
* Comportamento de strftime() e strptime(): Comportamento de strftime e strptime. 

Tipos disponíveis

* Propriedades Comuns:: 
* Determinando se um Objeto é Consciente ou Ingênuo:: 

Objetos timedelta

* Exemplos de uso; timedelta: Exemplos de uso timedelta. 

Objetos date

* Exemplos de uso; date: Exemplos de uso date. 

Objetos datetime

* Exemplos de uso; datetime: Exemplos de uso datetime. 

Objetos time

* Exemplos de uso; time: Exemplos de uso time. 

Comportamento de strftime() e strptime()

* Códigos de formato strftime() e strptime(): Códigos de formato strftime e strptime. 
* Detalhes técnicos:: 

zoneinfo — Suporte a fuso horário da IANA

* Usando ZoneInfo:: 
* Fontes de dados:: 
* A classe ZoneInfo:: 
* Funções: Funções<3>. 
* Globals:: 
* Exceptions and warnings:: 

Fontes de dados

* Configurando as fontes de dados:: 

Configurando as fontes de dados

* Configuração em tempo de compilação:: 
* Configuração do ambiente:: 
* Configuração em tempo de execução:: 

A classe ZoneInfo

* String representations:: 
* Pickle serialization:: 

calendar — Funções gerais relacionadas ao calendário

* Uso na linha de comando:: 

collections — Tipos de dados de contêineres

* Objetos ChainMap:: 
* Objetos Counter:: 
* Objetos deque:: 
* Objetos defaultdict:: 
* Função de fábrica para tuplas com campos nomeados namedtuple(): Função de fábrica para tuplas com campos nomeados namedtuple. 
* Objetos OrderedDict:: 
* Objetos UserDict:: 
* Objetos UserList:: 
* Objetos UserString:: 

Objetos ChainMap

* Exemplos e Receitas de ChainMap:: 

Objetos deque

* Receitas de deque:: 

Objetos defaultdict

* Exemplos de defaultdict:: 

Objetos OrderedDict

* Exemplos e receitas de OrderedDict:: 

collections.abc — Classes Base Abstratas para Contêineres

* Classes Base Abstratas de Coleções:: 
* Classes Base Abstrata de Coleções – Descrições Detalhadas:: 
* Exemplos e receitas:: 

heapq — Algoritmo de fila heap

* Exemplos básicos:: 
* Notas de implementação da fila de prioridade:: 
* Teoria:: 

bisect — Algoritmo de bisseção de vetor

* Observações sobre desempenho:: 
* Buscando em listas ordenadas:: 
* Exemplos: Exemplos<3>. 

weakref — Referências fracas

* Objetos referência fraca:: 
* Exemplo: Exemplo<2>. 
* Objetos finalizadores:: 
* Comparando finalizadores com métodos __del__(): Comparando finalizadores com métodos __del__. 

types — Criação de tipos dinâmicos e nomes para tipos embutidos

* Criação de tipos dinâmicos:: 
* Tipos padrão do interpretador:: 
* Classes e funções de utilidades adicionais:: 
* Funções de utilidade de corrotina:: 

pprint — Impressão bonita de dados

* Funções: Funções<4>. 
* Objetos PrettyPrinter:: 
* Exemplo: Exemplo<3>. 

reprlib — Implementação alternativa à repr()

* Objetos Repr:: 
* Estendendo objetos Repr:: 

enum — Suporte a enumerações

* Conteúdo do módulo: Conteúdo do módulo<2>. 
* Tipos de Dados: Tipos de Dados<2>. 
* Utilities and Decorators:: 
* Notas:: 

Tipos de Dados

* Nomes __dunder__ suportados:: 
* Nomes _sunder_ suportados:: 

graphlib — Funcionalidade para operar com estruturas do tipo grafo

* Exceções: Exceções<4>. 

Módulos Matemáticos e Numéricos

* numbers — Classes base abstratas numéricas:: 
* math — Funções matemáticas:: 
* cmath — Funções matemáticas para números complexos:: 
* decimal — Aritmética de ponto fixo decimal e ponto flutuante:: 
* fractions — Números racionais:: 
* random — Gera números pseudoaleatórios:: 
* statistics — Funções estatísticas:: 

numbers — Classes base abstratas numéricas

* A torre numérica:: 
* Notas para implementadores de tipos:: 

Notas para implementadores de tipos

* Adicionando mais ABCs numéricas:: 
* Implementando as operações aritméticas:: 

math — Funções matemáticas

* Funções de teoria dos números:: 
* Arimética de ponto flutuante:: 
* Funções de manipulação de ponto flutuante:: 
* Funções de potências@comma{} exponenciais e logarítmicas: Funções de potências exponenciais e logarítmicas. 
* Funções de soma e produto:: 
* Conversão angular:: 
* Funções trigonométricas:: 
* Funções hiperbólicas:: 
* Funções especiais:: 
* Constantes: Constantes<2>. 

cmath — Funções matemáticas para números complexos

* Conversões de e para coordenadas polares:: 
* Funções de potência e logarítmicas:: 
* Funções trigonométricas: Funções trigonométricas<2>. 
* Funções hiperbólicas: Funções hiperbólicas<2>. 
* Funções de classificação:: 
* Constantes: Constantes<3>. 

decimal — Aritmética de ponto fixo decimal e ponto flutuante

* Tutorial de início rápido:: 
* Objetos de Decimal:: 
* Objetos de contexto:: 
* Constantes: Constantes<4>. 
* Modos de arredondamento:: 
* Sinais:: 
* Observações sobre ponto flutuante:: 
* Trabalhando com threads:: 
* Receitas:: 
* FAQ sobre Decimal:: 

Objetos de Decimal

* Operandos lógicos:: 

Observações sobre ponto flutuante

* Atenuando o erro de arredondamento com maior precisão:: 
* Valores especiais:: 

random — Gera números pseudoaleatórios

* Funções de contabilidade:: 
* Funções para bytes:: 
* Funções para inteiros:: 
* Funções para sequências:: 
* Distribuições discretas:: 
* Distribuições com valor real:: 
* Gerador alternativo:: 
* Notas sobre reprodutibilidade:: 
* Exemplos: Exemplos<4>. 
* Receitas: Receitas<2>. 
* Uso na linha de comando: Uso na linha de comando<2>. 
* Exemplos na linha de comando:: 

statistics — Funções estatísticas

* Médias e medidas de valor central:: 
* Medidas de espalhamento:: 
* Estatísticas para relações entre duas entradas:: 
* Detalhes das funções:: 
* Exceções: Exceções<5>. 
* Objetos NormalDist:: 
* Exemplos e receitas: Exemplos e receitas<2>. 

Exemplos e receitas

* Problemas clássicos de probabilidade:: 
* Entradas de Monte Carlo para simulações:: 
* Aproximação de distribuições binomiais:: 
* Classificador bayesiano ingênuo:: 

Módulos de Programação Funcional

* itertools — Funções que criam iteradores para laços eficientes:: 
* functools — Funções e operações de ordem superior em objetos chamáveis:: 
* operator — Operadores padrões como funções:: 

itertools — Funções que criam iteradores para laços eficientes

* Funções do intertools:: 
* Receitas com itertools:: 

functools — Funções e operações de ordem superior em objetos chamáveis

* Objetos partial:: 

operator — Operadores padrões como funções

* Mapeando os operadores para suas respectivas funções:: 
* Operadores in-place:: 

Acesso a arquivos e diretórios

* pathlib — Caminhos do sistema de arquivos orientados a objetos:: 
* os.path — Manipulações comuns de nomes de caminhos: os path — Manipulações comuns de nomes de caminhos. 
* stat — Interpretando resultados de stat(): stat — Interpretando resultados de stat. 
* filecmp — Comparações de arquivos e diretórios:: 
* tempfile — Generate temporary files and directories:: 
* glob — Expansão de padrão de nome de arquivo no estilo Unix:: 
* fnmatch — Correspondência de padrões de nome de arquivo Unix:: 
* linecache — Acesso aleatório a linhas de texto:: 
* shutil — Operações de arquivo de alto nível:: 

pathlib — Caminhos do sistema de arquivos orientados a objetos

* Uso básico:: 
* Exceções: Exceções<6>. 
* Caminhos puros:: 
* Caminhos concretos:: 
* Linguagem de padrões:: 
* Comparação com o módulo glob:: 
* Comparação com os módulos os e os.path: Comparação com os módulos os e os path. 

Caminhos puros

* Propriedades gerais:: 
* Operadores: Operadores<2>. 
* Acessando partes individuais:: 
* Métodos e propriedades:: 

Caminhos concretos

* Analisando e gerando URIs:: 
* Expandindo e resolvendo caminhos:: 
* Consultando tipo de arquivo e status:: 
* Lendo e escrevendo arquivos:: 
* Lendo diretórios:: 
* Criando arquivos e diretórios:: 
* Renomeando e excluindo:: 
* Permissões e propriedade:: 

Comparação com os módulos os e os.path

* Ferramentas correspondentes:: 

filecmp — Comparações de arquivos e diretórios

* A classe dircmp:: 

tempfile — Generate temporary files and directories

* Exemplos: Exemplos<5>. 
* Deprecated functions and variables:: 

glob — Expansão de padrão de nome de arquivo no estilo Unix

* Exemplos: Exemplos<6>. 

shutil — Operações de arquivo de alto nível

* Operações de diretório e arquivos:: 
* Operações de arquivamento:: 
* Consultando o tamanho do terminal de saída:: 

Operações de diretório e arquivos

* Operações de cópia eficientes dependentes da plataforma:: 
* Exemplo de copytree:: 
* exemplo rmtree:: 

Operações de arquivamento

* Exemplo de arquivo:: 
* Exemplo de arquivamento com base_dir:: 

Persistência de Dados

* pickle — Serialização de objetos Python:: 
* copyreg — Registra funções de suporte pickle:: 
* shelve — Python object persistence:: 
* marshal — Serialização interna de objetos Python:: 
* dbm — Interfaces para “banco de dados” Unix:: 
* sqlite3 —- interface DB-API 2.0 interface para bancos de dados SQLite: sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite. 

pickle — Serialização de objetos Python

* Relacionamento com outros módulos Python:: 
* Formato de fluxo de dados:: 
* Interface do módulo:: 
* O que pode ser serializado e desserializado com pickle?:: 
* Serializando com pickle instâncias de classes:: 
* Redução personalizada para tipos@comma{} funções e outros objetos: Redução personalizada para tipos funções e outros objetos. 
* Buffers fora da banda:: 
* Restringindo globais:: 
* Desempenho: Desempenho<2>. 
* Exemplos: Exemplos<7>. 

Relacionamento com outros módulos Python

* Comparação com marshal:: 
* Comparação com json:: 

Serializando com pickle instâncias de classes

* Persistência de objetos externos:: 
* Tabelas de despacho:: 
* Manipulação de objetos com estado:: 

Buffers fora da banda

* API de provedor:: 
* API de consumidor:: 
* Exemplo: Exemplo<4>. 

copyreg — Registra funções de suporte pickle

* Exemplo: Exemplo<5>. 

shelve — Python object persistence

* Restrições:: 
* Exemplo: Exemplo<6>. 

dbm — Interfaces para “banco de dados” Unix

* dbm.sqlite3 — Backend de SQLite para dbm: dbm sqlite3 — Backend de SQLite para dbm. 
* dbm.gnu — Gerenciador de banco de dados do GNU: dbm gnu — Gerenciador de banco de dados do GNU. 
* dbm.ndbm — New Database Manager: dbm ndbm — New Database Manager. 
* dbm.dumb — Implementação portátil do DBM: dbm dumb — Implementação portátil do DBM. 

sqlite3 —- interface DB-API 2.0 interface para bancos de dados SQLite

* Tutorial:: 
* Referência:: 
* Guias de como fazer:: 
* Explicação:: 

Referência

* Funções do módulo:: 
* Constantes do módulo:: 
* Connection objects:: 
* Cursor objects:: 
* Row objects:: 
* Blob objects:: 
* PrepareProtocol objects:: 
* Exceções: Exceções<7>. 
* SQLite and Python types:: 
* Default adapters and converters (deprecated): Default adapters and converters deprecated. 
* Interface de linha de comando:: 

Guias de como fazer

* How to use placeholders to bind values in SQL queries:: 
* How to adapt custom Python types to SQLite values:: 
* How to convert SQLite values to custom Python types:: 
* Adapter and converter recipes:: 
* How to use connection shortcut methods:: 
* How to use the connection context manager:: 
* How to work with SQLite URIs:: 
* How to create and use row factories:: 
* How to handle non-UTF-8 text encodings:: 

How to adapt custom Python types to SQLite values

* How to write adaptable objects:: 
* How to register adapter callables:: 

Explicação

* Controle de transações:: 

Controle de transações

* Controle de transações através do atributo autocommit:: 
* Controle de transação através do atributo isolation_level:: 

Compressão de Dados e Arquivamento

* zlib — Compactação compatível com gzip:: 
* gzip — Suporte para arquivos gzip:: 
* bz2 — Suporte para compressão bzip2:: 
* lzma — Compressão usando o algoritmo LZMA:: 
* zipfile — Trabalha com arquivos ZIP:: 
* tarfile — Ler e gravar arquivos do tipo tar:: 

gzip — Suporte para arquivos gzip

* Exemplos de uso:: 
* Interface de linha de comando: Interface de linha de comando<2>. 

Interface de linha de comando

* Opções de linha de comando:: 

bz2 — Suporte para compressão bzip2

* (Des)compressão de arquivos: Des compressão de arquivos. 
* (Des)compressão incremental: Des compressão incremental. 
* (De)compressão de uma só vez (one-shot): De compressão de uma só vez one-shot. 
* Exemplos de uso: Exemplos de uso<2>. 

lzma — Compressão usando o algoritmo LZMA

* Lendo e escrevendo arquivos comprimidos:: 
* Comprimindo e descomprimindo dados na memória:: 
* Diversos: Diversos<3>. 
* Especificando cadeias de filtros personalizadas:: 
* Exemplos: Exemplos<8>. 

zipfile — Trabalha com arquivos ZIP

* Objetos ZipFile:: 
* Objetos Path:: 
* Objetos PyZipFile:: 
* Objetos ZipInfo:: 
* Interface de linha de comando: Interface de linha de comando<3>. 
* Armadilhas de descompressão:: 

Interface de linha de comando

* Opções de linha de comando: Opções de linha de comando<2>. 

Armadilhas de descompressão

* Do próprio arquivo:: 
* Limitações do sistema de arquivos:: 
* Limitações de recursos:: 
* Interrupção:: 
* Comportamentos padrão da extração:: 

tarfile — Ler e gravar arquivos do tipo tar

* Objetos TarFile:: 
* Objetos TarInfo:: 
* Filtros de extração:: 
* Interface de linha de comando: Interface de linha de comando<4>. 
* Exemplos: Exemplos<9>. 
* Formatos tar suportados:: 
* Problemas de Unicode:: 

Filtros de extração

* Default named filters:: 
* Filter errors:: 
* Dicas para verificação adicional:: 
* Suporte a versões mais antigas do Python:: 
* Stateful extraction filter example:: 

Interface de linha de comando

* Opções de linha de comando: Opções de linha de comando<3>. 

Exemplos

* Reading examples:: 
* Writing examples:: 

Formatos de Arquivo

* csv — Leitura e escrita de arquivos CSV:: 
* configparser — Analisador sintático de arquivo de configuração:: 
* tomllib — Analisa arquivos TOML:: 
* netrc — Arquivo de processamento netrc:: 
* plistlib — Gera e analisa arquivos Apple .plist: plistlib — Gera e analisa arquivos Apple plist. 

csv — Leitura e escrita de arquivos CSV

* Conteúdo do módulo: Conteúdo do módulo<3>. 
* Dialetos e parâmetros de formatação:: 
* Objetos Reader:: 
* Objetos Writer:: 
* Exemplos: Exemplos<10>. 

configparser — Analisador sintático de arquivo de configuração

* Início rápido:: 
* Tipos de dados suportados:: 
* Valores reservas:: 
* Estrutura dos arquivos INI:: 
* Seções não nomeadas:: 
* Interpolação de valores:: 
* Acesso através do protocolo de mapeamento:: 
* Personalizando o comportamento do analisador sintático:: 
* Exemplos de APIs legadas:: 
* Objetos ConfigParser:: 
* Objetos RawConfigParser:: 
* Exceções: Exceções<8>. 

tomllib — Analisa arquivos TOML

* Exemplos: Exemplos<11>. 
* Tabela de conversão:: 

netrc — Arquivo de processamento netrc

* Objetos netrc:: 

plistlib — Gera e analisa arquivos Apple .plist

* Exemplos: Exemplos<12>. 

Serviços Criptográficos

* hashlib — Resumos de mensagens e hashes seguros:: 
* hmac — Código de autenticação de mensagem com chave hash:: 
* secrets — Gera números aleatórios seguros para gerenciar segredos:: 

hashlib — Resumos de mensagens e hashes seguros

* Algoritmos de hash:: 
* Uso:: 
* Construtores:: 
* Atributos:: 
* Objetos hash:: 
* Resumos de comprimento variável de SHAKE:: 
* Hash de arquivo:: 
* Derivação de chave:: 
* BLAKE2:: 

BLAKE2

* Criando objetos hash:: 
* Constantes: Constantes<5>. 
* Exemplos: Exemplos<13>. 
* Credits:: 

Exemplos

* Simple hashing:: 
* Using different digest sizes:: 
* Keyed hashing:: 
* Randomized hashing:: 
* Personalization:: 
* Modo árvore:: 

secrets — Gera números aleatórios seguros para gerenciar segredos

* Números aleatórios:: 
* Gerando tokens:: 
* Outras funções:: 
* Receitas e melhores práticas:: 

Gerando tokens

* Quantos bytes os tokens devem usar?:: 

Serviços Genéricos do Sistema Operacional

* os — Diversas interfaces de sistema operacional:: 
* io — Ferramentas essenciais para trabalhar com fluxos:: 
* time — Acesso ao horário e conversões:: 
* logging — Recursos de registro de eventos para Python:: 
* logging.config — Configuração do módulo logging: logging config — Configuração do módulo logging. 
* logging.handlers — Manipuladores de logging: logging handlers — Manipuladores de logging. 
* platform — Acesso aos dados de identificação da plataforma subjacente:: 
* errno — Símbolos padrão do sistema errno:: 
* ctypes — Uma biblioteca de funções externas para Python:: 

os — Diversas interfaces de sistema operacional

* Nomes de arquivos@comma{} argumentos de linha de comando e variáveis de ambiente: Nomes de arquivos argumentos de linha de comando e variáveis de ambiente. 
* Modo UTF-8 do Python:: 
* Parâmetros de processo:: 
* Criação de objetos arquivos:: 
* Operações dos descritores de arquivos:: 
* Arquivos e diretórios:: 
* Gerenciamento de processo:: 
* Interface do agendador:: 
* Diversas informações de sistema:: 
* Números aleatórios: Números aleatórios<2>. 

Operações dos descritores de arquivos

* Consultando o tamanho de um terminal:: 
* Herança de descritores de arquivos:: 

Arquivos e diretórios

* Descritores de arquivo de temporizador:: 
* Atributos estendidos do Linux:: 

io — Ferramentas essenciais para trabalhar com fluxos

* Visão Geral: Visão Geral<2>. 
* Codificação do texto:: 
* Interface de alto nível do módulo:: 
* hierarquia de classe:: 
* Desempenho: Desempenho<3>. 

Visão Geral

* E/S de texto:: 
* E/S binária:: 
* E/S bruta:: 

Codificação do texto

* Ativar EncodingWarning:: 

hierarquia de classe

* I/O Base Classes:: 
* Raw File I/O:: 
* Buffered Streams:: 
* E/S de texto: E/S de texto<2>. 

Desempenho

* E/S binária: E/S binária<2>. 
* E/S de texto: E/S de texto<3>. 
* Multi-threading: Multi-threading<3>. 
* Reentrancy:: 

time — Acesso ao horário e conversões

* Funções: Funções<5>. 
* Constantes de ID de Relógio:: 
* Constantes de Fuso Horário:: 

logging — Recursos de registro de eventos para Python

* Objetos Logger:: 
* Níveis de Logging:: 
* Objetos Handler:: 
* Formatter Objects:: 
* Filter Objects:: 
* LogRecord Objects:: 
* Atributos LogRecord:: 
* LoggerAdapter Objects:: 
* Thread Safety:: 
* Funções de nível de módulo:: 
* Module-Level Attributes:: 
* Integration with the warnings module:: 

logging.config — Configuração do módulo logging

* Funções de configuração:: 
* Considerações de segurança:: 
* Esquema do Dicionário de Configuração:: 
* Formato do arquivo de configuração:: 

Esquema do Dicionário de Configuração

* Detalhes do Esquema de Dicionário:: 
* Configuração Incremental:: 
* Conexões de objeto:: 
* Objetos definidos pelo usuário:: 
* Ordem de configuração de manipuladores:: 
* Acesso a objetos externos:: 
* Acesso a objetos internos:: 
* Resolução de importações e importadores personalizados:: 
* Configurando QueueHandler e QueueListener:: 

logging.handlers — Manipuladores de logging

* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* SysLogHandler:: 
* NTEventLogHandler:: 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

platform —  Acesso aos dados de identificação da plataforma subjacente

* Multiplataforma:: 
* Plataforma Java:: 
* Plataforma Windows:: 
* Plataforma macOS:: 
* Plataforma iOS:: 
* Plataformas Unix:: 
* Plataformas Linux:: 
* Plataforma Android:: 
* Uso na linha de comando: Uso na linha de comando<3>. 

ctypes — Uma biblioteca de funções externas para Python

* Tutorial ctypes:: 
* Referência ctypes:: 

Tutorial ctypes

* Carregando bibliotecas de links dinâmicos:: 
* Acessando funções de dlls carregadas:: 
* Chamando funções:: 
* Tipos de dados fundamentais:: 
* Chamando funções@comma{} continuação: Chamando funções continuação. 
* Chamando funções variadas:: 
* Chamando funções com seus próprios tipos de dados personalizados:: 
* Especificando os tipos de argumentos necessários (protótipos de função): Especificando os tipos de argumentos necessários protótipos de função. 
* Tipos de Retorno:: 
* Passando ponteiros (ou; passando parâmetros por referência): Passando ponteiros ou passando parâmetros por referência. 
* Estruturas e uniões:: 
* Structure/union alignment and byte order:: 
* Campos de bit em estruturas e uniões:: 
* Vetores:: 
* Ponteiros:: 
* Conversão de Tipos:: 
* Tipos Incompletos:: 
* Funções Callbacks:: 
* Acessando valores exportados de dlls:: 
* Surpresas:: 
* Tipos de dados de tamanho variável:: 

Referência ctypes

* Encontrando bibliotecas compartilhadas:: 
* Loading shared libraries:: 
* Foreign functions:: 
* Function prototypes:: 
* Funções utilitárias:: 
* Data types:: 
* Tipos de dados fundamentais: Tipos de dados fundamentais<2>. 
* Tipos de dados estruturados:: 
* Arrays and pointers:: 

Bibliotecas de interface de linha de comando

* argparse — Analisador sintático para opções de linha de comando@comma{} argumentos e subcomandos: argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos. 
* optparse — Analisador sintático para opções de linha de comando:: 
* getpass — Entrada de senha portátil:: 
* fileinput — Itera sobre linhas de múltiplos fluxos de entrada:: 
* curses — Gerenciador de terminal para visualizadores de células de caracteres.: curses — Gerenciador de terminal para visualizadores de células de caracteres. 
* curses.textpad — Text input widget for curses programs: curses textpad — Text input widget for curses programs. 
* curses.ascii — Utilitários para caracteres ASCII: curses ascii — Utilitários para caracteres ASCII. 
* curses.panel — Uma extensão de pilha de painéis para o curses: curses panel — Uma extensão de pilha de painéis para o curses. 
* cmd — Suporte para interpretadores de comando orientado a linhas:: 

argparse — Analisador sintático para opções de linha de comando, argumentos e subcomandos

* Objetos ArgumentParser:: 
* O método add_argument(): O método add_argument. 
* O método parse_args(): O método parse_args. 
* Outros utilitários:: 
* Exceções: Exceções<9>. 

Objetos ArgumentParser

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

O método add_argument()

* name ou flags:: 
* ação:: 
* nargs:: 
* const:: 
* default:: 
* tipo:: 
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Classes de ação:: 

O método parse_args()

* Sintaxe de valores da opção:: 
* Argumentos inválidos:: 
* Argumentos contendo -:: 
* Abreviações de argumento (correspondência de prefixo): Abreviações de argumento correspondência de prefixo. 
* Além do sys.argv: Além do sys argv. 
* O objeto Namespace:: 

Outros utilitários

* Subcomandos:: 
* Objetos FileType:: 
* Grupos de argumentos:: 
* Exclusão mútua:: 
* Padrões do analisador sintático:: 
* Imprimindo a ajuda:: 
* Análise parcial:: 
* Personalizando a análise de arquivos:: 
* Métodos de saída:: 
* Análise misturada:: 
* Registrando ações e tipos personalizados:: 

Exceções

* Tutorial de Argparse:: 
* Migrando código optparse para argparse:: 

Tutorial de Argparse

* Conceitos:: 
* O básico:: 
* Apresentando os argumentos posicionais:: 
* Apresentando os argumentos opcionais:: 
* Combinando argumentos posicionais e opcionais:: 
* Avançando um pouco mais:: 
* Como traduzir a saída do argparse:: 
* Conversores de tipo personalizados:: 
* Conclusão:: 

Apresentando os argumentos opcionais

* Opções curtas:: 

Avançando um pouco mais

* Especificando argumentos ambíguos:: 
* Opções conflitantes:: 

optparse — Analisador sintático para opções de linha de comando

* Escolhendo uma biblioteca de análise de linha de comando:: 
* Introdução: Introdução<7>. 
* Contexto:: 
* Tutorial: Tutorial<2>. 
* Guia de referência:: 
* Funções de retorno de opção:: 
* Estendendo optparse:: 
* Exceções: Exceções<10>. 

Contexto

* Terminologia:: 
* Para que servem as opções?:: 
* Para que servem os argumentos posicionais?:: 

Tutorial

* Compreendendo as ações de opções:: 
* A ação store:: 
* Manipulando opções (sinalizadores) booleanas: Manipulando opções sinalizadores booleanas. 
* Outras ações:: 
* Valores padrão:: 
* Gerando texto de ajuda:: 
* Exibindo uma string de versão:: 
* Como optparse trata erros:: 
* Juntando tudo:: 

Gerando texto de ajuda

* Agrupando opções:: 

Guia de referência

* Criando o analisador sintático:: 
* Preenchendo o analisador sintático:: 
* Definindo as opções:: 
* Atributos da classe Option:: 
* Ações de opção padrão:: 
* Tipos de opção padrão:: 
* Análise de argumentos:: 
* Consultando e manipulando seu analisador sintático de opções:: 
* Conflitos entre opções:: 
* Limpeza:: 
* Outros métodos:: 

Funções de retorno de opção

* Definindo uma opção de retorno de chamada:: 
* Como os retornos de chamada são chamados:: 
* Levantando erros em uma função de retorno:: 
* Exemplo de função de retorno 1; retorno de chamada trivial: Exemplo de função de retorno 1 retorno de chamada trivial. 
* Exemplo de função de retorno 2; verificar a ordem das opções: Exemplo de função de retorno 2 verificar a ordem das opções. 
* Exemplo 3 de função de retorno; verificar a ordem das opções (generalizada): Exemplo 3 de função de retorno verificar a ordem das opções generalizada. 
* Exemplo de função de retorno 4; verificar uma condição arbitrária: Exemplo de função de retorno 4 verificar uma condição arbitrária. 
* Exemplo de função de retorno 5; argumentos fixos: Exemplo de função de retorno 5 argumentos fixos. 
* Exemplo de função de retorno 6; argumentos variáveis: Exemplo de função de retorno 6 argumentos variáveis. 

Estendendo optparse

* Adicionando novos tipos:: 
* Adicionando novas ações:: 

curses — Gerenciador de terminal para visualizadores de células de caracteres.

* Funções: Funções<6>. 
* Window Objects:: 
* Constantes: Constantes<6>. 

curses.textpad — Text input widget for curses programs

* Textbox objects:: 

curses.panel — Uma extensão de pilha de painéis para o curses

* Funções: Funções<7>. 
* Objetos painel:: 

cmd — Suporte para interpretadores de comando orientado a linhas

* Objetos Cmd:: 
* Exemplo do Cmd:: 

Execução Concorrente

* threading — Paralelismo baseado em threads:: 
* multiprocessing — Paralelismo baseado em processo:: 
* multiprocessing.shared_memory — Memória compartilhada para acesso direto entre processos: multiprocessing shared_memory — Memória compartilhada para acesso direto entre processos. 
* O pacote concurrent:: 
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks. 
* subprocess — Gerenciamento de subprocessos:: 
* sched — Agendador de eventos:: 
* queue — A synchronized queue class:: 
* contextvars — Variáveis de contexto:: 
* _thread— API de segmentação de baixo nível:: 

threading — Paralelismo baseado em threads

* Introdução: Introdução<8>. 
* GIL and performance considerations:: 
* Referência: Referência<2>. 
* Using locks@comma{} conditions@comma{} and semaphores in the with statement: Using locks conditions and semaphores in the with statement. 

Referência

* Thread-local data:: 
* Thread objects:: 
* Lock objects:: 
* RLock objects:: 
* Condition objects:: 
* Semaphore objects:: 
* Semaphore example:: 
* Event objects:: 
* Timer objects:: 
* Barrier objects:: 

multiprocessing — Paralelismo baseado em processo

* Introdução: Introdução<9>. 
* Referência: Referência<3>. 
* Programming guidelines:: 
* Exemplos: Exemplos<14>. 

Introdução

* A classe Process:: 
* Contextos e métodos de inicialização:: 
* Trocando objetos entre processos:: 
* Sincronização entre processos:: 
* Compartilhando estado entre processos:: 
* Usando um pool de workers:: 

Referência

* Global start method:: 
* Process e exceções:: 
* Encadeamentos e filas:: 
* Diversos: Diversos<4>. 
* Objetos de conexão:: 
* Primitivas de sincronização:: 
* Objetos ctypes compartilhados:: 
* Gerenciadores:: 
* Objetos proxies:: 
* Process Pools:: 
* Listeners and Clients:: 
* Authentication keys:: 
* Gerando logs: Gerando logs<2>. 
* The multiprocessing.dummy module: The multiprocessing dummy module. 

Objetos ctypes compartilhados

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

Gerenciadores

* Customized managers:: 
* Using a remote manager:: 

Objetos proxies

* Limpeza: Limpeza<2>. 

Listeners and Clients

* Formatos de Endereços:: 

Programming guidelines

* All start methods:: 
* The spawn and forkserver start methods:: 

concurrent.futures — Launching parallel tasks

* Executor Objects:: 
* ThreadPoolExecutor:: 
* ProcessPoolExecutor:: 
* Future Objects:: 
* Module Functions:: 
* Exception classes:: 

ThreadPoolExecutor

* Exemplo de ThreadPoolExecutor:: 

ProcessPoolExecutor

* ProcessPoolExecutor Example:: 

subprocess — Gerenciamento de subprocessos

* Usando o módulo subprocess:: 
* Considerações de Segurança:: 
* Objetos Popen:: 
* Windows Popen Helpers:: 
* API de alto nível mais antiga:: 
* Replacing Older Functions with the subprocess Module:: 
* Legacy Shell Invocation Functions:: 
* Notas: Notas<2>. 

Usando o módulo subprocess

* Argumentos usados frequentemente:: 
* Construtor Popen:: 
* Exceções: Exceções<11>. 

Windows Popen Helpers

* Constantes do Windows:: 

Replacing Older Functions with the subprocess Module

* Replacing /bin/sh shell command substitution:: 
* Replacing shell pipeline:: 
* Substituindo os.system(): Substituindo os system. 
* Replacing the os.spawn family: Replacing the os spawn family. 
* Replacing os.popen()@comma{} os.popen2()@comma{} os.popen3(): Replacing os popen os popen2 os popen3. 
* Replacing functions from the popen2 module:: 

Notas

* Timeout Behavior:: 
* Converter uma sequência de argumentos em uma string no Windows:: 
* Disabling use of vfork() or posix_spawn(): Disabling use of vfork or posix_spawn. 

sched — Agendador de eventos

* Objetos Scheduler:: 

queue — A synchronized queue class

* Objetos Queue:: 
* Objetos SimpleQueue:: 

Objetos Queue

* Waiting for task completion:: 
* Terminating queues:: 

contextvars — Variáveis de contexto

* Variáveis de contexto:: 
* Gerenciamento de contexto manual:: 
* Suporte a asyncio:: 

Comunicação em Rede e Interprocesso

* asyncio — E/S assíncrona:: 
* socket — Interface de rede de baixo nível:: 
* ssl — Invólucro de TLS/SSL para objetos socket:: 
* select — Waiting for I/O completion:: 
* selectors — High-level I/O multiplexing:: 
* signal — Define manipuladores para eventos assíncronos:: 
* mmap — Suporte a arquivos mapeados na memória:: 

asyncio — E/S assíncrona

* Runners:: 
* Corrotinas e tarefas:: 
* Streams:: 
* Synchronization Primitives:: 
* Subprocessos:: 
* Filas:: 
* Exceções: Exceções<13>. 
* Laço de eventos:: 
* Futuros:: 
* Transports e Protocols:: 
* Políticas:: 
* Suporte a plataformas:: 
* Extensão:: 
* Índice da API de alto nível:: 
* Índice de APIs de baixo nível:: 
* Desenvolvendo com asyncio:: 

Runners

* Executando um programa asyncio:: 
* Runner context manager:: 
* Handling Keyboard Interruption:: 

Corrotinas e tarefas

* Corrotinas: Corrotinas<3>. 
* Aguardáveis:: 
* Criando tarefas:: 
* Cancelamento de tarefas:: 
* Grupos de tarefas:: 
* Dormindo:: 
* Executando tarefas concorrentemente:: 
* Fábrica de tarefas ansiosas:: 
* Protegendo contra cancelamento:: 
* Tempo limite:: 
* Primitivas de espera:: 
* Executando em threads:: 
* Agendando a partir de outras threads:: 
* Introspecção:: 
* Objeto Task:: 

Grupos de tarefas

* Encerrando um grupo de tarefas:: 

Streams

* StreamReader:: 
* StreamWriter:: 
* Exemplos: Exemplos<15>. 

Exemplos

* Cliente para eco TCP usando streams:: 
* Servidor eco TCP usando streams:: 
* Obtém headers HTTP:: 
* Registra um soquete aberto para aguardar por dados usando streams:: 

Synchronization Primitives

* Lock:: 
* Evento:: 
* Condição:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrier:: 

Subprocessos

* Criando subprocessos:: 
* Constantes: Constantes<7>. 
* Interagindo com subprocessos:: 

Interagindo com subprocessos

* Subprocesso e Threads:: 
* Exemplos: Exemplos<16>. 

Filas

* Queue:: 
* Fila de prioridade:: 
* Filas LIFO (último a entrar@comma{} primeiro a sair): Filas LIFO último a entrar primeiro a sair. 
* Exceções: Exceções<12>. 
* Exemplos: Exemplos<17>. 

Laço de eventos

* Métodos do laço de eventos:: 
* Tratadores de função de retorno:: 
* Objetos Server:: 
* Implementações do laço de eventos:: 
* Exemplos: Exemplos<18>. 

Métodos do laço de eventos

* Executar e interromper o laço:: 
* Agendando funções de retorno:: 
* Agendando funções de retorno atrasadas:: 
* Criando Futures e Tasks:: 
* Abrindo conexões de rede:: 
* Criando servidores de rede:: 
* Transferindo arquivos:: 
* Atualizando TLS:: 
* Observando descritores de arquivo:: 
* Trabalhando com objetos soquete diretamente:: 
* DNS:: 
* Trabalhando com encadeamentos:: 
* Sinais Unix:: 
* Executando código em conjuntos de threads ou processos:: 
* Tratando erros da API:: 
* Habilitando o modo de debug:: 
* Executando subprocessos:: 

Exemplos

* Hello World com call_soon(): Hello World com call_soon. 
* Exibe a data atual com call_later(): Exibe a data atual com call_later. 
* Observa um descritor de arquivo por eventos de leitura:: 
* Define tratadores de sinais para SIGINT e SIGTERM:: 

Futuros

* Funções Future:: 
* Objeto Future:: 

Transports e Protocols

* Transportes:: 
* Protocolos:: 
* Exemplos: Exemplos<19>. 

Transportes

* Transports Hierarchy:: 
* Base Transport:: 
* Read-only Transports:: 
* Write-only Transports:: 
* Transportes de datagrama:: 
* Transportes de Subprocesso:: 

Protocolos

* Protocolos de Base:: 
* Base Protocol:: 
* Streaming Protocols:: 
* Protocolos de Streaming Bufferizados:: 
* Protocolos de Datagramas:: 
* Protocolos de Subprocesso:: 

Exemplos

* TCP Echo Server:: 
* TCP Echo Client:: 
* UDP Echo Server:: 
* UDP Echo Client:: 
* Connecting Existing Sockets:: 
* loop.subprocess_exec() and SubprocessProtocol: loop subprocess_exec and SubprocessProtocol. 

Políticas

* Getting and Setting the Policy:: 
* Policy Objects:: 
* Monitores de processos:: 
* Custom Policies:: 

Suporte a plataformas

* Todas as plataformas:: 
* Windows: Windows<81>. 
* macOS: macOS<51>. 

Windows

* Suporte para subprocesso no Windows:: 

Extensão

* Escrevendo um laço de eventos personalizado:: 
* Construtores privados de Future e Task:: 
* Suporte ao ciclo de vida de tarefas:: 

Índice da API de alto nível

* Tarefas:: 
* Filas: Filas<2>. 
* Subprocessos: Subprocessos<2>. 
* Streams: Streams<2>. 
* Sincronização:: 
* Exceções: Exceções<14>. 

Índice de APIs de baixo nível

* Obtendo o laço de eventos:: 
* Métodos do laço de eventos: Métodos do laço de eventos<2>. 
* Transportes: Transportes<2>. 
* Protocolos: Protocolos<2>. 
* Políticas de laço de eventos:: 

Desenvolvendo com asyncio

* Modo de Depuração:: 
* Concorrência e Múltiplas Threads:: 
* Executando código bloqueante:: 
* Gerando logs: Gerando logs<3>. 
* Detectar corrotinas nunca aguardadas:: 
* Detectar exceções nunca recuperadas:: 

socket — Interface de rede de baixo nível

* Famílias de soquete:: 
* Conteúdo do módulo: Conteúdo do módulo<4>. 
* Socket Objects:: 
* Notas sobre tempo limite de soquete:: 
* Exemplo: Exemplo<7>. 

Conteúdo do módulo

* Exceções: Exceções<15>. 
* Constantes: Constantes<8>. 
* Funções: Funções<8>. 

Funções

* Criação de sockets:: 
* Outras funções: Outras funções<2>. 

Notas sobre tempo limite de soquete

* Timeouts and the connect method:: 
* Timeouts and the accept method:: 

ssl — Invólucro de TLS/SSL para objetos socket

* Funções@comma{} constantes e exceções.: Funções constantes e exceções. 
* SSL Sockets:: 
* SSL Contexts:: 
* Certificados:: 
* Exemplos: Exemplos<20>. 
* Notes on non-blocking sockets:: 
* Підтримка BIO пам’яті: Підтримка BIO пам’яті<2>. 
* SSL session:: 
* Considerações de segurança: Considerações de segurança<2>. 
* TLS 1.3: TLS 1 3. 

Funções, constantes e exceções.

* Criação de socket:: 
* Criação de contexto:: 
* Exceções: Exceções<16>. 
* Random generation:: 
* Manipulação de certificados:: 
* Constantes: Constantes<9>. 

Certificados

* Certificate chains:: 
* CA certificates:: 
* Combined key and certificate:: 
* Self-signed certificates:: 

Exemplos

* Testing for SSL support:: 
* Client-side operation:: 
* Server-side operation:: 

Considerações de segurança

* Best defaults:: 
* Manual settings:: 
* Multi-processing:: 

Manual settings

* Verifying certificates:: 
* Protocol versions:: 
* Cipher selection:: 

select — Waiting for I/O completion

* /dev/poll Polling Objects:: 
* Edge and Level Trigger Polling (epoll) Objects: Edge and Level Trigger Polling epoll Objects. 
* Polling Objects:: 
* Kqueue Objects:: 
* Kevent Objects:: 

selectors — High-level I/O multiplexing

* Introdução: Introdução<10>. 
* Classes: Classes<4>. 
* Exemplos: Exemplos<21>. 

signal — Define manipuladores para eventos assíncronos

* Regras gerais:: 
* Conteúdo do módulo: Conteúdo do módulo<5>. 
* Exemplos: Exemplos<22>. 
* Nota sobre SIGPIPE:: 
* Nota sobre manipuladores de sinais e exceções:: 

Regras gerais

* Execução de manipuladores de sinais Python:: 
* Sinais e threads:: 

mmap — Suporte a arquivos mapeados na memória

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

Manuseio de Dados na Internet

* email — Um e-mail e um pacote MIME manipulável:: 
* json — Codificador e decodificador JSON:: 
* mailbox — Manipule caixas de entradas em vários formatos:: 
* mimetypes — Mapeia nomes de arquivos para tipos MIME:: 
* base64 — Base16@comma{} Base32@comma{} Base64@comma{} Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings. 
* binascii — Converte entre binário e ASCII:: 
* quopri — Codifica e decodifica dados MIME imprimidos entre aspas:: 

email — Um e-mail e um pacote MIME manipulável

* email.message; Representing an email message: email message Representing an email message. 
* email.parser; Parsing email messages: email parser Parsing email messages. 
* email.generator; Geração de documentos MIME: email generator Geração de documentos MIME. 
* email.policy; Policy Objects: email policy Policy Objects. 
* email.errors; Classes de Exceção e Defeito.: email errors Classes de Exceção e Defeito. 
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects. 
* email.contentmanager; Gerenciando conteúdo MIME: email contentmanager Gerenciando conteúdo MIME. 
* email; Exemplos: email Exemplos. 
* email.message.Message; Representing an email message using the compat32 API: email message Message Representing an email message using the compat32 API. 
* email.mimeemail.mime; Criando e-mail e objetos MIME do zero: email mimeemail mime Criando e-mail e objetos MIME do zero. 
* email.header; Internationalized headers: email header Internationalized headers. 
* email.charset; Representando conjuntos de caracteres: email charset Representando conjuntos de caracteres. 
* email.encoders; Codificadores: email encoders Codificadores. 
* email.utils; Utilitários diversos: email utils Utilitários diversos. 
* email.iterators; Iteradores: email iterators Iteradores. 

email.parser: Parsing email messages

* API do FeedParser:: 
* Parser API:: 
* Additional notes:: 

email.contentmanager: Gerenciando conteúdo MIME

* Content Manager Instances:: 

json — Codificador e decodificador JSON

* Uso básico: Uso básico<2>. 
* Codificadores e decodificadores:: 
* Exceções: Exceções<17>. 
* Conformidade e interoperabilidade entre padrões:: 
* Interface de linha de comando: Interface de linha de comando<5>. 

Conformidade e interoperabilidade entre padrões

* Codificações de caracteres:: 
* Valores numéricos infinitos e NaN:: 
* Nomes repetidos dentro de um objeto:: 
* Valores não objeto e não vetor de nível superior:: 
* Limitações de implementação:: 

Interface de linha de comando

* Opções da linha de comando:: 

mailbox — Manipule caixas de entradas em vários formatos

* Objetos Mailbox:: 
* Message objects:: 
* Exceções: Exceções<18>. 
* Exemplos: Exemplos<23>. 

Objetos Mailbox

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

Message objects

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

mimetypes — Mapeia nomes de arquivos para tipos MIME

* Objetos MimeTypes:: 

base64 — Base16, Base32, Base64, Base85 Data Encodings

* RFC 4648 Encodings:: 
* Base85 Encodings:: 
* Legacy Interface:: 
* Considerações de Segurança: Considerações de Segurança<2>. 

Ferramentas de Processamento de Markup Estruturado

* html — Suporte HTML (HyperText Markup Language): html — Suporte HTML HyperText Markup Language. 
* html.parser — Analisador simples de HTML e XHTML: html parser — Analisador simples de HTML e XHTML. 
* html.entities — Definições de entidades gerais de HTML: html entities — Definições de entidades gerais de HTML. 
* Módulos de Processamento de XML:: 
* xml.etree.ElementTree — A API XML ElementTree: xml etree ElementTree — A API XML ElementTree. 
* 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 — Suporte para construir árvores parciais de DOM: xml dom pulldom — Suporte para construir árvores parciais de DOM. 
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers. 
* xml.sax.handler — Classes base para manipuladores de SAX: xml sax handler — Classes base para manipuladores de SAX. 
* xml.sax.saxutils — Utilitários de SAX: xml sax saxutils — Utilitários de SAX. 
* 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 — Analisador simples de HTML e XHTML

* Exemplo de aplicação para análise de HTML:: 
* Métodos HTMLParser:: 
* Exemplos: Exemplos<24>. 

Módulos de Processamento de XML

* Segurança no XML:: 

xml.etree.ElementTree — A API XML ElementTree

* Tutorial: Tutorial<3>. 
* Suporte a XPath:: 
* Referência: Referência<4>. 
* Suporte a XInclude:: 
* Referência: Referência<5>. 

Tutorial

* Árvore e elementos XML:: 
* Analisando XML:: 
* A API de pull para análise sem bloqueio:: 
* Encontrando elementos interessantes:: 
* Modificando um arquivo XML:: 
* Construindo documentos XML:: 
* Analisando XML com espaços de nomes:: 

Suporte a XPath

* Exemplo: Exemplo<8>. 
* Supported XPath syntax:: 

Referência

* Funções: Funções<9>. 

Suporte a XInclude

* Exemplo: Exemplo<9>. 

Referência

* Funções: Funções<10>. 
* Element Objects:: 
* ElementTree Objects:: 
* QName Objects:: 
* TreeBuilder Objects:: 
* Objetos XMLParser:: 
* XMLPullParser Objects:: 
* Exceções: Exceções<19>. 

xml.dom — The Document Object Model API

* Conteúdo do módulo: Conteúdo do módulo<6>. 
* Objects in the DOM:: 
* Conformance:: 

Objects in the DOM

* DOMImplementation Objects:: 
* Objetos Node:: 
* Objetos NodeList:: 
* DocumentType Objects:: 
* Document Objects:: 
* Element Objects: Element Objects<2>. 
* Attr Objects:: 
* NamedNodeMap Objects:: 
* Comment Objects:: 
* Text and CDATASection Objects:: 
* Objetos ProcessingInstruction:: 
* Exceções: Exceções<20>. 

Conformance

* Type Mapping:: 
* Accessor Methods:: 

xml.dom.minidom — Minimal DOM implementation

* Objetos DOM:: 
* DOM Example:: 
* minidom e o padrão DOM:: 

xml.dom.pulldom — Suporte para construir árvores parciais de DOM

* Objetos DOMEventStream:: 

xml.sax — Support for SAX2 parsers

* SAXException Objects:: 

xml.sax.handler — Classes base para manipuladores de SAX

* ContentHandler Objects:: 
* DTDHandler Objects:: 
* EntityResolver Objects:: 
* ErrorHandler Objects:: 
* LexicalHandler Objects:: 

xml.sax.xmlreader — Interface for XML parsers

* XMLReader Objects:: 
* IncrementalParser Objects:: 
* Locator Objects:: 
* InputSource Objects:: 
* The Attributes Interface:: 
* The AttributesNS Interface:: 

xml.parsers.expat — Fast XML parsing using Expat

* Objetos XMLParser: Objetos XMLParser<2>. 
* Exceções ExpatError:: 
* Exemplo: Exemplo<10>. 
* Content Model Descriptions:: 
* Constantes de erro de expatriados:: 

Protocolos de Internet e Suporte

* webbrowser — Controlador de navegador web conveniente:: 
* wsgiref — Implementação de referência e utilitários WSGI:: 
* urllib — Módulos de manipulação de URL:: 
* urllib.request — Biblioteca extensível para abrir URLs: urllib request — Biblioteca extensível para abrir URLs. 
* urllib.response — Response classes used by urllib: urllib response — Response classes used by urllib. 
* urllib.parse — Analisa URLs para componentes: urllib parse — Analisa URLs para componentes. 
* urllib.error — Classes de exceção levantadas por urllib.request: urllib error — Classes de exceção levantadas por urllib request. 
* urllib.robotparser — Analisador sintático de robots.txt: urllib robotparser — Analisador sintático de robots txt. 
* http — módulos HTTP:: 
* http.client — HTTP protocol client: http client — HTTP protocol client. 
* ftplib — FTP protocol client:: 
* poplib — Cliente de protocolo POP3:: 
* imaplib — IMAP4 protocol client:: 
* smtplib — Cliente de protocolo SMTP:: 
* uuid — Objetos UUID conforme RFC 4122:: 
* socketserver — Um framework para servidores de rede:: 
* 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 de servidor e cliente XMLRPC:: 
* xmlrpc.client — Cliente XML-RPC: xmlrpc client — Cliente XML-RPC. 
* xmlrpc.server — Servidores XML-RPC básicos: xmlrpc server — Servidores XML-RPC básicos. 
* ipaddress — Biblioteca de manipulação de IPv4/IPv6:: 

webbrowser — Controlador de navegador web conveniente

* Interface de linha de comando: Interface de linha de comando<6>. 
* Objetos controladores de navegador:: 

wsgiref — Implementação de referência e utilitários WSGI

* wsgiref.util – Utilidades do ambiente WSGI: wsgiref util – Utilidades do ambiente WSGI. 
* wsgiref.headers – Ferramentas de cabeçalho de resposta WSGI: wsgiref headers – Ferramentas de cabeçalho de resposta WSGI. 
* wsgiref.simple_server – um servidor HTTP WSGI simples: wsgiref simple_server – um servidor HTTP WSGI simples. 
* wsgiref.validate — Verificador de conformidade WSGI: wsgiref validate — Verificador de conformidade WSGI. 
* wsgiref.handlers – classes base de servidor/gateway: wsgiref handlers – classes base de servidor/gateway. 
* wsgiref.types – WSGI types for static type checking: wsgiref types – WSGI types for static type checking. 
* Exemplos: Exemplos<25>. 

urllib.request — Biblioteca extensível para abrir URLs

* Objeto Request:: 
* OpenerDirector Objects:: 
* BaseHandler Objects:: 
* HTTPRedirectHandler Objects:: 
* HTTPCookieProcessor Objects:: 
* ProxyHandler Objects:: 
* HTTPPasswordMgr Objects:: 
* HTTPPasswordMgrWithPriorAuth Objects:: 
* AbstractBasicAuthHandler Objects:: 
* HTTPBasicAuthHandler Objects:: 
* ProxyBasicAuthHandler Objects:: 
* AbstractDigestAuthHandler Objects:: 
* HTTPDigestAuthHandler Objects:: 
* ProxyDigestAuthHandler Objects:: 
* HTTPHandler Objects:: 
* Objetos HTTPSHandler:: 
* FileHandler Objects:: 
* DataHandler Objects:: 
* FTPHandler Objects:: 
* CacheFTPHandler Objects:: 
* Objetos UnknownHandler:: 
* HTTPErrorProcessor Objects:: 
* Exemplos: Exemplos<26>. 
* Legacy interface:: 
* urllib.request Restrictions: urllib request Restrictions. 

urllib.parse — Analisa URLs para componentes

* Análise de URL:: 
* Segurança ao analisar URLs:: 
* Analisando bytes codificados em ASCII:: 
* Structured Parse Results:: 
* URL Quoting:: 

http — módulos HTTP

* códigos de status HTTP:: 
* Categorias de HTTP status:: 
* Métodos HTTP:: 

http.client — HTTP protocol client

* Objetos de HTTPConnection:: 
* Objetos HTTPResponse:: 
* Exemplos: Exemplos<27>. 
* HTTPMessage Objects:: 

ftplib — FTP protocol client

* Referência: Referência<6>. 

Referência

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

poplib — Cliente de protocolo POP3

* Objetos POP3:: 
* Exemplo POP3:: 

imaplib — IMAP4 protocol client

* Objetos IMAP4:: 
* Exemplo IMAP4:: 

smtplib — Cliente de protocolo SMTP

* Objetos SMTP:: 
* Exemplo SMTP:: 

uuid — Objetos UUID conforme RFC 4122

* Uso na linha de comando: Uso na linha de comando<4>. 
* Exemplo: Exemplo<11>. 
* Exemplo de linha de comando:: 

socketserver — Um framework para servidores de rede

* Notas sobre criação do servidor:: 
* Objetos Server: Objetos Server<2>. 
* Objetos manipulador de requisições:: 
* Exemplos: Exemplos<28>. 

Exemplos

* Exemplo de socketserver.TCPServer: Exemplo de socketserver TCPServer. 
* Exemplo socketserver.UDPServer: Exemplo socketserver UDPServer. 
* Mixins assíncronos:: 

http.server — HTTP servers

* Interface de linha de comando: Interface de linha de comando<7>. 
* Considerações de segurança: Considerações de segurança<3>. 

http.cookies — HTTP state management

* Objetos Cookie:: 
* Objetos Morsel:: 
* Exemplo: Exemplo<12>. 

http.cookiejar — Cookie handling for HTTP clients

* CookieJar and FileCookieJar Objects:: 
* FileCookieJar subclasses and co-operation with web browsers:: 
* Objeto CookiePolicy:: 
* DefaultCookiePolicy Objects:: 
* Objetos Cookie: Objetos Cookie<2>. 
* Exemplos: Exemplos<29>. 

xmlrpc.client — Cliente XML-RPC

* Objetos ServerProxy:: 
* Objetos DateTime:: 
* Objetos Binários:: 
* Objetos Fault:: 
* Objetos ProtocolError:: 
* Objetos MultiCall:: 
* Convenience Functions:: 
* Exemplo de uso do cliente:: 
* Example of Client and Server Usage:: 

xmlrpc.server — Servidores XML-RPC básicos

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

Objetos de SimpleXMLRPCServer

* Exemplo de SimpleXMLRPCServer:: 

ipaddress — Biblioteca de manipulação de IPv4/IPv6

* Funções de fábrica de conveniência:: 
* Endereços IP:: 
* Definições de rede IP:: 
* Objetos de interface:: 
* Outras funções de nível de módulo:: 
* Exceções personalizadas:: 

Endereços IP

* Objetos de endereço:: 
* Conversão para strings e inteiros:: 
* Operadores: Operadores<3>. 

Operadores

* Operadores de comparação:: 
* Operadores aritméticos:: 

Definições de rede IP

* Prefixo@comma{} máscara de rede e máscara de host: Prefixo máscara de rede e máscara de host. 
* Objetos de rede:: 
* Operadores: Operadores<4>. 

Operadores

* Operadores lógicos:: 
* Iteração:: 
* Redes como contêineres de endereços:: 

Objetos de interface

* Operadores: Operadores<5>. 

Operadores

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

Serviços Multimídia

* wave — Read and write WAV files:: 
* colorsys — Conversões entre sistemas de cores:: 

wave — Read and write WAV files

* Objetos Wave_read:: 
* Objetos Wave_write:: 

Internacionalização

* gettext — Serviços de internacionalização multilíngues:: 
* locale — Serviços de internacionalização:: 

gettext — Serviços de internacionalização multilíngues

* API do GNU gettext:: 
* API baseada em classe:: 
* Internacionalizando seus programas e módulos:: 
* Reconhecimentos: Reconhecimentos<9>. 

API baseada em classe

* A classe NullTranslations:: 
* A classe GNUTranslations:: 
* Suporte a catálogo de mensagens do Solaris:: 
* O construtor Catalog:: 

Internacionalizando seus programas e módulos

* Localizando seu módulo:: 
* Localizando sua aplicação:: 
* Alterando os idiomas durante o uso:: 
* Traduções adiadas:: 

locale — Serviços de internacionalização

* Histórico@comma{} detalhes@comma{} dicas@comma{} dicas e advertências: Histórico detalhes dicas dicas e advertências. 
* Nomes de localidades:: 
* Para escritores de extensão e programas que incorporam Python:: 
* Acesso a catálogos de mensagens:: 

Interfaces gráficas de usuário com Tk

* tkinter — Interface Python para Tcl/Tk:: 
* tkinter.colorchooser — Diálogo de escolha de cor: tkinter colorchooser — Diálogo de escolha de cor. 
* tkinter.font — Invólucro de fontes Tkinter: tkinter font — Invólucro de fontes Tkinter. 
* Diálogos Tkinter:: 
* tkinter.messagebox — Prompts de mensagem do Tkinter: tkinter messagebox — Prompts de mensagem do Tkinter. 
* tkinter.scrolledtext — Widget de texto de rolado: tkinter scrolledtext — Widget de texto de rolado. 
* tkinter.dnd — Suporte para arrastar e soltar: tkinter dnd — Suporte para arrastar e soltar. 
* tkinter.ttk — Widgets temáticos do Tk: tkinter ttk — Widgets temáticos do Tk. 
* IDLE — editor e console Python: IDLE — editor e console Python<2>. 
* turtle — Gráficos tartaruga:: 

tkinter — Interface Python para Tcl/Tk

* Arquitetura:: 
* Módulos Tkinter:: 
* Preservador de vida Tkinter:: 
* Modelo de threading:: 
* Referência Útil:: 
* Tratadores de arquivos:: 

Preservador de vida Tkinter

* Um programa Olá Mundo:: 
* Conceitos importantes do Tk:: 
* Entendendo como Tkinter envolve Tcl/Tk:: 
* Como é que eu…? Que opção faz…?:: 
* Navegando no Manual de Referência Tcl/Tk:: 

Referência Útil

* Opções de Definição:: 
* O Empacotador:: 
* Opções do Empacotador:: 
* Acoplando Variáveis de Widgets:: 
* O Gerenciador de Janela:: 
* Opções de Tipos de Dados do Tk:: 
* Ligações e Eventos:: 
* O Parâmetro index:: 
* Imagens:: 

Diálogos Tkinter

* tkinter.simpledialog — Diálogos de entrada padrão do Tkinter: tkinter simpledialog — Diálogos de entrada padrão do Tkinter. 
* tkinter.filedialog — Caixas de diálogo de seleção de arquivo: tkinter filedialog — Caixas de diálogo de seleção de arquivo. 
* tkinter.commondialog — Modelos de janela de diálogo: tkinter commondialog — Modelos de janela de diálogo. 

tkinter.filedialog — Caixas de diálogo de seleção de arquivo

* Caixas de diálogo nativos de carregar/salvar:: 

tkinter.ttk — Widgets temáticos do Tk

* Usando Ttk:: 
* Widgets Ttk:: 
* Widget:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk Styling:: 

Widget

* Opções padrão:: 
* Opções de ferramenta rolável:: 
* Opções de rótulo:: 
* Opções de compatibilidade:: 
* Estados de Widget:: 
* ttk.Widget: ttk Widget. 

Combobox

* Opções:: 
* Eventos virtuais:: 
* ttk.Combobox: ttk Combobox. 

Spinbox

* Opções: Opções<2>. 
* Eventos virtuais: Eventos virtuais<2>. 
* ttk.Spinbox: ttk Spinbox. 

Notebook

* Opções: Opções<3>. 
* Tab Options:: 
* Tab Identifiers:: 
* Virtual Events:: 
* ttk.Notebook: ttk Notebook. 

Progressbar

* Opções: Opções<4>. 
* ttk.Progressbar: ttk Progressbar. 

Separator

* Opções: Opções<5>. 

Sizegrip

* Platform-specific notes:: 
* Bugs:: 

Treeview

* Opções: Opções<6>. 
* Item Options:: 
* Tag Options:: 
* Column Identifiers:: 
* Virtual Events: Virtual Events<2>. 
* ttk.Treeview: ttk Treeview. 

Ttk Styling

* Layouts:: 

IDLE — editor e console Python

* Menus:: 
* Editing and Navigation:: 
* Startup and Code Execution:: 
* Help and Preferences:: 
* idlelib — implementation of IDLE application:: 

Menus

* Menu File (Console e editor): Menu File Console e editor. 
* Menu Edit (Shell e Editor): Menu Edit Shell e Editor. 
* Menu Format (Somente na janela do Editor): Menu Format Somente na janela do Editor. 
* Run menu (Editor window only): Run menu Editor window only. 
* Shell menu (Shell window only): Shell menu Shell window only. 
* Debug menu (Shell window only): Debug menu Shell window only. 
* Options menu (Shell and Editor): Options menu Shell and Editor. 
* Window menu (Shell and Editor): Window menu Shell and Editor. 
* Help menu (Shell and Editor): Help menu Shell and Editor. 
* Context menus:: 

Editing and Navigation

* Editor windows:: 
* Teclas de atalho:: 
* Indentação automática:: 
* Busca e Substituição:: 
* Completions:: 
* Dicas de chamada:: 
* Format block:: 
* Code Context:: 
* Shell window:: 
* Text colors:: 

Startup and Code Execution

* Uso na linha de comando: Uso na linha de comando<5>. 
* Startup failure:: 
* Running user code:: 
* User output in Shell:: 
* Developing tkinter applications:: 
* Running without a subprocess:: 

Help and Preferences

* Help sources:: 
* Setting preferences:: 
* IDLE on macOS:: 
* Extensions:: 

turtle — Gráficos tartaruga

* Introdução: Introdução<11>. 
* Começando: Começando<2>. 
* Tutorial: Tutorial<4>. 
* Como fazer…:: 
* Referência Gráficos de Tartaruga:: 
* Métodos de RawTurtle/Turtle e funções correspondentes:: 
* métodos do TurtleScreen/Screen e as funções correspondentes:: 
* Classes Públicas:: 
* Explicação: Explicação<2>. 
* Ajuda e Configuração:: 
* turtledemo — Scripts de Demonstração:: 
* Modificações desde a versão do Python 2.6: Modificações desde a versão do Python 2 6. 
* Modificações desde a versão do Python 3.0: Modificações desde a versão do Python 3 0. 

Tutorial

* Iniciando um ambiente da tartaruga:: 
* Desenho básico:: 
* Criação de padrões algorítmicos:: 

Desenho básico

* Controle da Caneta:: 
* A posição da tartaruga:: 

Como fazer…

* Comece o mais rápido possível:: 
* Use o espaço de nomes do módulo turtle:: 
* Use o módulo gráfico de tartaruga dentro de um script com código específico:: 
* Use o módulo gráficos da tartaruga orientado a objetos:: 

Referência Gráficos de Tartaruga

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

Métodos de RawTurtle/Turtle e funções correspondentes

* Movimentos de Turtle:: 
* Fala o estado de Turtle:: 
* Configurações de medida:: 
* Controle da Caneta: Controle da Caneta<2>. 
* Estado da tartaruga:: 
* Eventos Utilizados:: 
* Métodos Especiais da Tartaruga:: 
* Formas compostas:: 

Controle da Caneta

* Estado do Desenho:: 
* Controle da Cor:: 
* Preenchimento:: 
* Mais sobre o Controle do Desenho:: 

Estado da tartaruga

* Visibilidade:: 
* Aparência:: 

métodos do TurtleScreen/Screen e as funções correspondentes

* Controle da Janela:: 
* Controle da animação:: 
* Usando os eventos de tela:: 
* Métodos de entrada:: 
* Configurações e métodos especiais:: 
* Métodos específico do Screen@comma{} estes métodos não são herdados do TurtleScreen: Métodos específico do Screen estes métodos não são herdados do TurtleScreen. 

Ajuda e Configuração

* Como usar a Ajuda:: 
* Tradução de docstrings em diferentes idiomas:: 
* Como configurar Screen and Turtles:: 

Ferramentas de Desenvolvimento

* typing — Suporte para dicas de tipo:: 
* pydoc — Gerador de documentação e sistema de ajuda online:: 
* Modo de Desenvolvimento do Python:: 
* doctest — Teste exemplos interativos de Python:: 
* unittest — Framework de testes unitários:: 
* unittest.mock — mock object library: unittest mock — mock object library. 
* unittest.mock — primeiros passos: unittest mock — primeiros passos. 
* test — Pacote de Testes de Regressão do Python:: 
* test.support — Utilitários para o conjunto de teste do Python: test support — Utilitários para o conjunto de teste do Python. 
* test.support.socket_helper — Utilities for socket tests: test support socket_helper — Utilities for socket tests. 
* test.support.script_helper — Utilities for the Python execution tests: test support script_helper — Utilities for the Python execution tests. 
* test.support.bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode: test support bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode. 
* test.support.threading_helper — Utilities for threading tests: test support threading_helper — Utilities for threading tests. 
* test.support.os_helper — Utilities for os tests: test support os_helper — Utilities for os tests. 
* test.support.import_helper — Utilities for import tests: test support import_helper — Utilities for import tests. 
* test.support.warnings_helper — Utilities for warnings tests: test support warnings_helper — Utilities for warnings tests. 

typing — Suporte para dicas de tipo

* Especificação para o sistema de tipos do Python:: 
* Apelidos de tipo:: 
* NewType:: 
* Anotações de objetos chamáveis:: 
* Genéricos:: 
* Anotando tuplas:: 
* O tipo de objetos de classe:: 
* Anotando geradores e corrotinas:: 
* Tipos genéricos definidos pelo usuário:: 
* O tipo Any:: 
* Subtipagem nominal vs estrutural:: 
* Conteúdo do módulo: Conteúdo do módulo<7>. 
* Cronograma de descontinuação dos principais recursos:: 

Conteúdo do módulo

* Tipos primitivos especiais:: 
* Protocolos: Protocolos<3>. 
* ABCs para trabalhar com E/S:: 
* Funções e decoradores:: 
* Auxiliares de introspecção:: 
* Constante:: 
* Apelidos descontinuados:: 

Tipos primitivos especiais

* Tipos especiais:: 
* Formas especiais:: 
* Criando tipos genéricos e apelidos de tipo:: 
* Outras diretivas especiais:: 

Apelidos descontinuados

* Apelidos de tipos embutidos:: 
* Apelidos para tipos em collections:: 
* Apelidos de outros tipos concretos:: 
* Apelidos de contêineres ABC em collections.abc.: Apelidos de contêineres ABC em collections abc. 
* Apelidos para ABCs assíncronas em collections.abc: Apelidos para ABCs assíncronas em collections abc. 
* Apelidos para outros ABCs em collections.abc.: Apelidos para outros ABCs em collections abc. 
* Apelidos de ABCs da contextlib:: 

Modo de Desenvolvimento do Python

* Efeitos do Modo de Desenvolvimento do Python:: 
* Exemplo de ResourceWarning:: 
* Exemplo de erro de descritor de arquivo inválido:: 

doctest — Teste exemplos interativos de Python

* Uso simples; verificando exemplos em Docstrings: Uso simples verificando exemplos em Docstrings. 
* Utilização comum; Verificando exemplos em um arquivo texto: Utilização comum Verificando exemplos em um arquivo texto. 
* Uso na linha de comando: Uso na linha de comando<6>. 
* Como ele funciona:: 
* Basic API:: 
* API do Unittest:: 
* Advanced API:: 
* Depuração:: 
* Soapbox:: 

Como ele funciona

* Quais docstrings são examinadas?:: 
* Como os exemplos de docstrings são reconhecidos?:: 
* Qual é o contexto de execução?:: 
* E quanto às exceções?:: 
* Flags opcionais:: 
* Directives:: 
* Avisos: Avisos<2>. 

Advanced API

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

unittest — Framework de testes unitários

* Exemplo Básico:: 
* Interface de linha de comando: Interface de linha de comando<8>. 
* Test Discovery:: 
* Organizando código teste:: 
* Reutilizando códigos de teste antigos:: 
* Ignorando testes e falhas esperadas:: 
* Distinguindo iterações de teste utilizando subtestes:: 
* Classes e funções:: 
* Classes e Módulos de Definição de Contexto:: 
* Tratamento de sinal:: 

Interface de linha de comando

* Opções de linha de comando: Opções de linha de comando<4>. 

Classes e funções

* Casos de teste:: 
* Grouping tests:: 
* Carregando e executando testes:: 

Carregando e executando testes

* load_tests Protocol:: 

Classes e Módulos de Definição de Contexto

* setUpClass and tearDownClass:: 
* setUpModule and tearDownModule:: 

unittest.mock — mock object library

* Guia Rápido:: 
* A classe Mock:: 
* Os criadores de patches:: 
* MagicMock and magic method support:: 
* Ajudantes:: 
* Order of precedence of side_effect@comma{} return_value and wraps: Order of precedence of side_effect return_value and wraps. 

A classe Mock

* Fazendo chamadas:: 
* Deletando Atributos:: 
* Nomes de Mock e o atributo name:: 
* Anexando Mocks como Atributos:: 

Os criadores de patches

* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* métodos do patch; start e stop: métodos do patch start e stop. 
* patch de embutidos:: 
* TEST_PREFIX:: 
* Aninhando Decoradores Patch:: 
* Onde fazer patch:: 
* Patching Descriptors and Proxy Objects:: 

MagicMock and magic method support

* Simulando Métodos Mágicos:: 
* Magic Mock:: 

Ajudantes

* sentinel:: 
* DEFAULT:: 
* chamada:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* Especificação automática:: 
* Vedando mocks:: 

unittest.mock — primeiros passos

* Usando Mock:: 
* Patch Decorators:: 
* Further Examples:: 

Usando Mock

* Métodos de aplicação de patches em Mock:: 
* Mock de chamadas de métodos em um objeto:: 
* Mocking Classes:: 
* Nomeando os mocks:: 
* Rastreando todas as chamadas:: 
* Setting Return Values and Attributes:: 
* Raising exceptions with mocks:: 
* Side effect functions and iterables:: 
* Mocking asynchronous iterators:: 
* Mocking asynchronous context manager:: 
* Creating a Mock from an Existing Object:: 
* Using side_effect to return per file content:: 

Further Examples

* Mocking chained calls:: 
* Partial mocking:: 
* Mocking a Generator Method:: 
* Applying the same patch to every test method:: 
* Mocking Unbound Methods:: 
* Checking multiple calls with mock:: 
* Coping with mutable arguments:: 
* Nesting Patches:: 
* Mocking a dictionary with MagicMock:: 
* Mock subclasses and their attributes:: 
* Mocking imports with patch.dict: Mocking imports with patch dict. 
* Tracking order of calls and less verbose call assertions:: 
* More complex argument matching:: 

test — Pacote de Testes de Regressão do Python

* Escrever testes unitários para o pacote test:: 
* Executando testes usando a interface de linha de comando:: 

Depuração e perfilamento

* Tabela de eventos de auditoria:: 
* bdb — Framework do depurador:: 
* faulthandler — Dump the Python traceback:: 
* pdb — O depurador do Python:: 
* Os Profilers do Python:: 
* timeit — Mede o tempo de execução de pequenos trechos de código:: 
* trace — Rastreia ou acompanha a execução de instruções Python:: 
* tracemalloc — Trace memory allocations:: 

faulthandler — Dump the Python traceback

* Dumping the traceback:: 
* Fault handler state:: 
* Dumping the tracebacks after a timeout:: 
* Dumping the traceback on a user signal:: 
* Issue with file descriptors:: 
* Exemplo: Exemplo<13>. 

pdb — O depurador do Python

* Interface de linha de comando: Interface de linha de comando<9>. 
* Comandos de depuração:: 

Os Profilers do Python

* Introdução aos profilers:: 
* Instant User’s Manual:: 
* profile and cProfile Module Reference:: 
* A classe Stats:: 
* What Is Deterministic Profiling?:: 
* Limitações:: 
* Calibration:: 
* Using a custom timer:: 

timeit — Mede o tempo de execução de pequenos trechos de código

* Exemplos básicos: Exemplos básicos<2>. 
* Interface em Python:: 
* Interface de linha de comando: Interface de linha de comando<10>. 
* Exemplos: Exemplos<30>. 

trace — Rastreia ou acompanha a execução de instruções Python

* Uso na linha de comando: Uso na linha de comando<7>. 
* Interface programática:: 

Uso na linha de comando

* Opções principais:: 
* Modificadores:: 
* Filtros:: 

tracemalloc — Trace memory allocations

* Exemplos: Exemplos<31>. 
* API:: 

Exemplos

* Exibe o top 10:: 
* Compute differences:: 
* Get the traceback of a memory block:: 
* Pretty top:: 

Pretty top

* Record the current and peak size of all traced memory blocks:: 

API

* Funções: Funções<11>. 
* DomainFilter:: 
* Filter:: 
* Frame:: 
* Snapshot:: 
* Statistic:: 
* StatisticDiff:: 
* Trace:: 
* Traceback:: 

Empacotamento e Distribuição de Software

* ensurepip — Inicialização do instalador do pip:: 
* venv — Criação de ambientes virtuais:: 
* zipapp — Gerencia arquivos zip executáveis do Python:: 

ensurepip — Inicialização do instalador do pip

* Interface de linha de comando: Interface de linha de comando<11>. 
* API do módulo:: 

venv — Criação de ambientes virtuais

* Criando ambientes virtuais: Criando ambientes virtuais<2>. 
* Como funcionam os venvs:: 
* API: API<2>. 
* Um exemplo de extensão de EnvBuilder:: 

zipapp — Gerencia arquivos zip executáveis do Python

* Exemplo básico:: 
* Interface de linha de comando: Interface de linha de comando<12>. 
* API do Python:: 
* Exemplos: Exemplos<32>. 
* Especificando o interpretador:: 
* Criando aplicações autônomas com zipapp:: 
* O formato de arquivo da aplicação zip Python:: 

Criando aplicações autônomas com zipapp

* Advertência:: 

Serviços de Tempo de Execução Python

* sys — Parâmetros e funções específicas do sistema:: 
* sys.monitoring — Monitoramento de eventos de execução: sys monitoring — Monitoramento de eventos de execução. 
* sysconfig — Fornece acesso às informações de configuração do Python:: 
* builtins — Objetos embutidos:: 
* __main__ — Ambiente de código principal:: 
* warnings — Controle de avisos:: 
* dataclasses — Data Classes:: 
* contextlib — Utilitários para contextos da instrução with:: 
* abc — Classes base abstratas:: 
* atexit — Manipuladores de saída:: 
* traceback — Imprime ou recupera um traceback da pilha:: 
* __future__ — Definições de instruções future:: 
* gc — Interface para o coletor de lixo:: 
* inspect — Inspecione objetos vivos:: 
* site — Gancho de configuração específico do site:: 

sys.monitoring — Monitoramento de eventos de execução

* Identificadores de ferramenta:: 
* Eventos:: 
* Ativação e desativação de eventos:: 
* Registro de funções de retorno de chamada:: 

Identificadores de ferramenta

* Registro e uso de ferramentas:: 

Eventos

* Eventos locais:: 
* Eventos auxiliares:: 
* Outros eventos:: 
* O evento STOP_ITERATION:: 

Ativação e desativação de eventos

* Definir eventos globalmente:: 
* Eventos por objeto código:: 
* Desativação de eventos:: 

Registro de funções de retorno de chamada

* Argumentos da função de retorno de chamada:: 

sysconfig — Fornece acesso às informações de configuração do Python

* Variáveis de configuração:: 
* Caminhos de instalação:: 
* Esquema de usuário:: 
* Esquema de home:: 
* Esquema de prefixo:: 
* Funções de caminho de instalação:: 
* Outras funções: Outras funções<3>. 
* Uso na linha de comando: Uso na linha de comando<8>. 

Esquema de usuário

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

Esquema de home

* posix_home:: 

Esquema de prefixo

* posix_prefix:: 
* nt:: 

__main__ — Ambiente de código principal

* __name__ == '__main__':: 
* __main__.py em pacotes Python: __main__ py em pacotes Python. 
* import __main__:: 

__name__ == '__main__'

* O que é o “ambiente de código principal”?:: 
* Uso idiomático:: 
* Considerações sobre pacotes:: 

__main__.py em pacotes Python

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

warnings — Controle de avisos

* Categorias de avisos:: 
* O filtro de avisos:: 
* Temporarily Suppressing Warnings:: 
* Testing Warnings:: 
* Updating Code For New Versions of Dependencies:: 
* Funções disponíveis:: 
* Gerenciadores de contexto disponíveis:: 

O filtro de avisos

* Critérios de supressão de avisos repetidos:: 
* Descrevendo filtros de aviso:: 
* Filtro de avisos padrão:: 
* Overriding the default filter:: 

dataclasses — Data Classes

* Conteúdo do módulo: Conteúdo do módulo<8>. 
* Processamento pós-inicialização:: 
* Variáveis de classe:: 
* Variáveis de inicialização apenas:: 
* Frozen instances:: 
* Herança: Herança<2>. 
* Re-ordering of keyword-only parameters in __init__(): Re-ordering of keyword-only parameters in __init__. 
* Funções padrão de fábrica:: 
* Valores padrão mutáveis:: 
* Descriptor-typed fields:: 

contextlib — Utilitários para contextos da instrução with

* Utilitários:: 
* Exemplos e receitas: Exemplos e receitas<3>. 
* Single use@comma{} reusable and reentrant context managers: Single use reusable and reentrant context managers. 

Exemplos e receitas

* Supporting a variable number of context managers:: 
* Catching exceptions from __enter__ methods:: 
* Cleaning up in an __enter__ implementation:: 
* Replacing any use of try-finally and flag variables:: 
* Using a context manager as a function decorator:: 

Single use, reusable and reentrant context managers

* Reentrant context managers:: 
* Gerenciadores de contexto reutilizáveis:: 

atexit — Manipuladores de saída

* Exemplo do atexit:: 

traceback — Imprime ou recupera um traceback da pilha

* Funções de nível de módulo: Funções de nível de módulo<2>. 
* TracebackException Objects:: 
* StackSummary Objects:: 
* FrameSummary Objects:: 
* Examples of Using the Module-Level Functions:: 
* Examples of Using TracebackException:: 

__future__ — Definições de instruções future

* Conteúdo do módulo: Conteúdo do módulo<9>. 

inspect — Inspecione objetos vivos

* Tipos e membros:: 
* Retrieving source code:: 
* Introspecting callables with the Signature object:: 
* Classes e funções: Classes e funções<2>. 
* A pilha to interpretador:: 
* Fetching attributes statically:: 
* Current State of Generators@comma{} Coroutines@comma{} and Asynchronous Generators: Current State of Generators Coroutines and Asynchronous Generators. 
* Code Objects Bit Flags:: 
* Buffer flags:: 
* Interface de linha de comando: Interface de linha de comando<13>. 

site — Gancho de configuração específico do site

* sitecustomize:: 
* usercustomize:: 
* Configuração Readline:: 
* Conteúdo do módulo: Conteúdo do módulo<10>. 
* Interface de linha de comando: Interface de linha de comando<14>. 

Interpretadores Python Personalizados

* code — Classes bases do interpretador:: 
* codeop — Compila código Python:: 

code — Classes bases do interpretador

* Objetos de interpretador interativo:: 
* Objetos de console Interativo:: 

Importando módulos

* zipimport - Importa módulos de arquivos Zip:: 
* pkgutil — Utilitário de extensão de pacote:: 
* modulefinder — Procura módulos usados por um script:: 
* runpy — Localizando e executando módulos Python:: 
* importlib — A implementação de import:: 
* importlib.resources – Leitura@comma{} abertura e acesso a recursos de pacotes: importlib resources – Leitura abertura e acesso a recursos de pacotes. 
* importlib.resources.abc – Classes base abstratas para recursos: importlib resources abc – Classes base abstratas para recursos. 
* importlib.metadata – Acessando metadados do pacote: importlib metadata – Acessando metadados do pacote. 
* A inicialização do caminho de pesquisa de módulos sys.path: A inicialização do caminho de pesquisa de módulos sys path. 

zipimport - Importa módulos de arquivos Zip

* Objetos zipimporter:: 
* Exemplos: Exemplos<33>. 

modulefinder — Procura módulos usados por um script

* Exemplo de uso de ModuleFinder:: 

importlib — A implementação de import

* Introdução: Introdução<12>. 
* Funções: Funções<12>. 
* importlib.abc – classes base abstratas relacionadas a importação: importlib abc – classes base abstratas relacionadas a importação. 
* importlib.machinery – Importadores e ganchos de caminho: importlib machinery – Importadores e ganchos de caminho. 
* importlib.util – Utility code for importers: importlib util – Utility code for importers. 
* Exemplos: Exemplos<34>. 

Exemplos

* Importing programmatically:: 
* Checando se o módulo pode ser importado:: 
* Importa o arquivo de origem diretamente:: 
* Implementing lazy imports:: 
* Setting up an importer:: 
* Approximating importlib.import_module(): Approximating importlib import_module. 

importlib.resources – Leitura, abertura e acesso a recursos de pacotes

* API funcional:: 

importlib.metadata – Acessando metadados do pacote

* Visão Geral: Visão Geral<3>. 
* API funcional: API funcional<2>. 
* Distribuições:: 
* Descoberta de distribuição:: 
* Estendendo o algoritmo de pesquisa:: 

API funcional

* Pontos de entrada:: 
* Metadados de distribuição:: 
* Versões de distribuição:: 
* Arquivos de distribuição:: 
* Requisitos de distribuição:: 
* Mapeando importação pra pacotes de distribuição:: 

Estendendo o algoritmo de pesquisa

* Exemplo: Exemplo<14>. 

A inicialização do caminho de pesquisa de módulos sys.path

* Ambientes virtuais: Ambientes virtuais<2>. 
* Arquivos _pth:: 
* Python embarcado:: 

Serviços da Linguagem Python

* ast — Árvores de Sintaxe Abstrata:: 
* symtable — Acesso a tabela de símbolos do compilador:: 
* token — Constantes usadas com árvores de análises do Python:: 
* keyword — Testando palavras reservadas do Python:: 
* tokenize — Tokenizador para código-fonte Python:: 
* tabnanny — Detecção de indentação ambígua:: 
* pyclbr — Suporte a navegador de módulos do Python:: 
* py_compile — Compila arquivos fonte do Python:: 
* compileall — Compilar bibliotecas do Python para bytecode:: 
* dis — Disassembler de bytecode do Python:: 
* pickletools — Ferramentas para desenvolvedores pickle:: 

ast — Árvores de Sintaxe Abstrata

* Gramática Abstrata:: 
* Classes de nós:: 
* Auxiliares de ast:: 
* Sinalizadores do compilador: Sinalizadores do compilador<2>. 
* Uso na linha de comando: Uso na linha de comando<9>. 

Classes de nós

* Nós raízes:: 
* Literais: Literais<3>. 
* Variáveis:: 
* Expressões: Expressões<2>. 
* Instruções:: 
* Fluxo de controle:: 
* Correspondência de padrões:: 
* Anotações de tipos:: 
* Parâmetros de tipo:: 
* Definições de função e classe:: 
* Async e await:: 

Expressões

* Subscrição:: 
* Compreensões:: 

Instruções

* Importações:: 

symtable — Acesso a tabela de símbolos do compilador

* Generating Symbol Tables:: 
* Examining Symbol Tables:: 
* Uso na linha de comando: Uso na linha de comando<10>. 

tokenize — Tokenizador para código-fonte Python

* Tokenizando entradas:: 
* Uso na linha de comando: Uso na linha de comando<11>. 
* Exemplos: Exemplos<35>. 

pyclbr — Suporte a navegador de módulos do Python

* Objetos Function:: 
* Objetos classe: Objetos classe<2>. 

py_compile — Compila arquivos fonte do Python

* Interface de linha de comando: Interface de linha de comando<15>. 

compileall — Compilar bibliotecas do Python para bytecode

* Uso na linha de comando: Uso na linha de comando<12>. 
* Funções públicas:: 

dis — Disassembler de bytecode do Python

* Interface de linha de comando: Interface de linha de comando<16>. 
* Análise de bytecode:: 
* Funções de análise:: 
* Instruções em bytecode do Python:: 
* Opcode collections:: 

pickletools — Ferramentas para desenvolvedores pickle

* Uso na linha de comando: Uso na linha de comando<13>. 
* Interface programática: Interface programática<2>. 

Uso na linha de comando

* Opções da linha de comando: Opções da linha de comando<2>. 

Serviços Específicos do MS Windows

* msvcrt — Rotinas úteis do runtime MS VC++:: 
* winreg — Acesso aos registros do Windows:: 
* winsound — Interface de reprodução de som para o Windows:: 

msvcrt — Rotinas úteis do runtime MS VC++

* Operações com arquivos:: 
* E/S de console:: 
* Outras funções: Outras funções<4>. 

winreg — Acesso aos registros do Windows

* Funções: Funções<13>. 
* Constantes: Constantes<10>. 
* Objetos identificador de registro:: 

Constantes

* Constantes HKEY_*:: 
* Direitos de acesso:: 
* Tipos de valores:: 

Direitos de acesso

* Específico de 64 bits:: 

Serviços específicos do Unix

* shlex — Simple lexical analysis:: 
* posix — As chamadas de sistema mais comuns do POSIX:: 
* pwd — A senha do banco de dados:: 
* grp — O banco de dados de grupos:: 
* termios — Controle de tty no estilo POSIX:: 
* tty — Funções de controle de terminal:: 
* pty — Utilitários de pseudoterminal:: 
* fcntl — as chamadas de sistema fcntl e ioctl:: 
* resource — Informação de uso de recursos:: 
* syslog — Rotinas da biblioteca syslog do Unix:: 

shlex — Simple lexical analysis

* shlex Objects:: 
* Regras de análise:: 
* Improved Compatibility with Shells:: 

posix — As chamadas de sistema mais comuns do POSIX

* Suporte a arquivos grandes:: 
* Conteúdo notável do módulo:: 

termios — Controle de tty no estilo POSIX

* Exemplo: Exemplo<15>. 

pty — Utilitários de pseudoterminal

* Exemplo: Exemplo<16>. 

resource — Informação de uso de recursos

* Limites de recursos:: 
* Uso de recursos:: 

syslog — Rotinas da biblioteca syslog do Unix

* Exemplos: Exemplos<36>. 

Exemplos

* Exemplo simples:: 

Módulos substituídos

* getopt — Analisador sintático no estilo C para opções de linha de comando:: 

Módulos removidos

* aifc — Lê e escreve arquivos AIFF e AIFC:: 
* asynchat — Manipulador de comando/resposta de socket assíncrono:: 
* asyncore — Manipulador de socket assíncrono:: 
* audioop — Manipulando dados de áudio original:: 
* cgi — Suporte a Common Gateway Interface:: 
* cgitb — Gerenciador de traceback para scripts de CGI:: 
* chunk — Lê dados em blocos IFF:: 
* crypt — Função para verificar senhas Unix:: 
* distutils — Criação e instalação de módulos do Python:: 
* imghdr — Determina o tipo de uma imagem:: 
* imp — Acessa os componentes internos de importação:: 
* mailcap — Manipulação de arquivo Mailcap:: 
* msilib — Lê e escreve arquivos do Microsoft Installer:: 
* nis — Interface para NIS da Sun (Yellow Pages): nis — Interface para NIS da Sun Yellow Pages. 
* nntplib — Cliente de protocolo NNTP:: 
* ossaudiodev — Acesso a dispositivos de áudio compatíveis com OSS:: 
* pipes — Interface para pipelines do shell:: 
* smtpd — Serviços SMTP:: 
* sndhdr — Determina o tipo de arquivos de som:: 
* spwd — O banco de dados de senhas shadow:: 
* sunau — Lê e escreve arquivos AU da Sun:: 
* telnetlib — cliente Telnet:: 
* uu — Codifica e decodifica arquivos uuencode:: 
* xdrlib — Codifica e decodifica dados XDR:: 

Estendendo e incorporando o interpretador Python

* Ferramentas de terceiros recomendadas:: 
* Criando extensões sem ferramentas de terceiros:: 
* Incorporando o tempo de execução do CPython em uma aplicação maior:: 

Criando extensões sem ferramentas de terceiros

* Estendendo Python com C ou C++:: 
* Definindo Tipos de Extensão; Tutorial: Definindo Tipos de Extensão Tutorial. 
* Defining Extension Types; Assorted Topics: Defining Extension Types Assorted Topics. 
* Construindo extensões C e C++:: 
* Construindo Extensões C e C++ no Windows:: 

Estendendo Python com C ou C++

* Um Exemplo Simples:: 
* Intermezzo; erros e exceções: Intermezzo erros e exceções. 
* De volta ao exemplo:: 
* A tabela de métodos e a função de inicialização do módulo:: 
* Compilação e vinculação:: 
* Chamando funções Python de C:: 
* Extraindo parâmetros em funções de extensão:: 
* Parâmetros nomeados para funções de extensão:: 
* Construindo valores arbitrários:: 
* Contagens de referências:: 
* Escrevendo extensões em C++:: 
* Fornecendo uma API C para um módulo de extensão:: 

Contagens de referências

* Contagem de referências no Python:: 
* Regras de propriedade:: 
* Gelo fino:: 
* Ponteiros NULL:: 

Definindo Tipos de Extensão: Tutorial

* O básico: O básico<2>. 
* Adicionando dados e métodos ao exemplo básico:: 
* Fornecendo controle mais preciso sobre atributos de dados:: 
* Apoiando a coleta de lixo cíclica:: 
* Criando subclasses de outros tipos:: 

Defining Extension Types: Assorted Topics

* Finalization and De-allocation:: 
* Object Presentation:: 
* Attribute Management:: 
* Object Comparison:: 
* Abstract Protocol Support:: 
* Weak Reference Support:: 
* More Suggestions:: 

Attribute Management

* Generic Attribute Management:: 
* Type-specific Attribute Management:: 

Construindo extensões C e C++

* Construindo extensões C e C ++ com setuptools:: 

Construindo Extensões C e C++ no Windows

* Uma abordagem de livro de receitas:: 
* Diferenças entre o Unix e o Windows:: 
* Usando DLLs na prática:: 

Incorporando o tempo de execução do CPython em uma aplicação maior

* Incorporando o Python numa Outra Aplicação:: 

Incorporando o Python numa Outra Aplicação

* Very High Level Embedding:: 
* Beyond Very High Level Embedding; An overview: Beyond Very High Level Embedding An overview. 
* Pure Embedding:: 
* Extending Embedded Python:: 
* Embedding Python in C++:: 
* Compiling and Linking under Unix-like systems:: 

Manual de referência da API Python/C

* Introdução: Introdução<13>. 
* Estabilidade da API C:: 
* A camada de nível muito alto:: 
* Contagem de referências:: 
* Tratamento de exceções: Tratamento de exceções<2>. 
* Utilitários: Utilitários<2>. 
* Camada de Objetos Abstratos:: 
* Camada de Objetos Concretos:: 
* Inicialização@comma{} finalização e threads: Inicialização finalização e threads. 
* Configuração de inicialização do Python:: 
* Gerenciamento de Memória:: 
* Suporte a implementação de Objetos:: 
* API e Versionamento de ABI:: 
* API C de monitoramento:: 
* Gerando eventos de execução:: 

Introdução

* Padrões de codificação:: 
* Arquivos de inclusão:: 
* Macros úteis:: 
* Objetos@comma{} tipos e contagens de referências: Objetos tipos e contagens de referências. 
* Exceções: Exceções<21>. 
* Incorporando Python: Incorporando Python<2>. 
* Compilações de depuração:: 
* Ferramentas de terceiros recomendadas: Ferramentas de terceiros recomendadas<2>. 

Objetos, tipos e contagens de referências

* Contagens de referências: Contagens de referências<2>. 
* Tipos:: 

Contagens de referências

* Detalhes da contagem de referências:: 

Estabilidade da API C

* API C Instável:: 
* Interface Binária de Aplicação Estável:: 
* Considerações da plataforma:: 
* Conteúdo da API Limitada:: 

Interface Binária de Aplicação Estável

* API C Limitada:: 
* ABI Estável:: 
* Escopo e Desempenho da API Limitada:: 
* Limitações da API Limitada:: 

A camada de nível muito alto

* Símbolos iniciais disponíveis:: 
* Stack Effects:: 

Tratamento de exceções

* Impressão e limpeza:: 
* Levantando exceções: Levantando exceções<2>. 
* Emitindo avisos:: 
* Consultando o indicador de erro:: 
* Tratamento de sinal: Tratamento de sinal<2>. 
* Classes de exceção:: 
* Objeto Exceção:: 
* Objetos de exceção Unicode:: 
* Controle de recursão:: 
* Exception and warning types:: 
* Tracebacks:: 

Exception and warning types

* Tipos de exceção:: 
* OSError aliases:: 
* Warning types:: 

Utilitários

* Utilitários do sistema operacional:: 
* Funções de sistema:: 
* Controle de processos:: 
* Importando módulos: Importando módulos<2>. 
* Suporte a marshalling de dados:: 
* Análise de argumentos e construção de valores:: 
* Conversão e formação de strings:: 
* Classificação e conversão de caracteres:: 
* API do PyHash:: 
* Reflexão:: 
* Registro de codec e funções de suporte:: 
* API C PyTime:: 
* Suporte a Mapas do Perf:: 

Análise de argumentos e construção de valores

* Análise de argumentos: Análise de argumentos<2>. 
* Construindo valores:: 

Análise de argumentos

* Strings e buffers:: 
* Números: Números<2>. 
* Outros objetos:: 
* Funções da API:: 

Registro de codec e funções de suporte

* API de pesquisa de codec:: 
* API de registro de tratamentos de erros de decodificação Unicode:: 
* Variáveis utilitárias de codec:: 

API C PyTime

* Tipos: Tipos<2>. 
* Funções de relógio:: 
* Funções de relógio brutas:: 
* Funções de conversão:: 

Camada de Objetos Abstratos

* Protocolo de objeto:: 
* Protocolo de chamada:: 
* Protocolo de número:: 
* Protocolo de sequência:: 
* Protocolo de mapeamento:: 
* Protocolo Iterador:: 
* Protocolo de buffer:: 

Protocolo de chamada

* O protocolo tp_call:: 
* O protocolo vectorcall:: 
* API de chamada de objetos:: 
* API de suporte a chamadas:: 

O protocolo vectorcall

* Controle de recursão: Controle de recursão<2>. 
* API de suporte à chamada de vetores:: 

Protocolo de buffer

* Estrutura de Buffer:: 
* Tipos de solicitação do buffer:: 
* Vetores Complexos:: 
* Funções relacionadas ao Buffer:: 

Tipos de solicitação do buffer

* campos independentes do pedido:: 
* apenas em formato:: 
* forma@comma{} avanços@comma{} suboffsets: forma avanços suboffsets. 
* requisições contíguas:: 
* requisições compostas:: 

Vetores Complexos

* Estilo NumPy; forma e avanços: Estilo NumPy forma e avanços. 
* Estilo-PIL; forma@comma{} avanços e suboffsets: Estilo-PIL forma avanços e suboffsets. 

Camada de Objetos Concretos

* Objetos Fundamentais:: 
* Objetos Numéricos:: 
* Objetos Sequência:: 
* Coleções:: 
* Objetos Function: Objetos Function<2>. 
* Outros Objetos:: 
* API C para módulos de extensão:: 

Objetos Fundamentais

* Objetos tipo: Objetos tipo<2>. 
* O Objeto None:: 

Objetos tipo

* Creating Heap-Allocated Types:: 

Objetos Numéricos

* Objetos Inteiros:: 
* Objetos Booleanos:: 
* Objetos de ponto flutuante:: 
* Objetos números complexos:: 

Objetos de ponto flutuante

* As funções Pack e Unpack:: 

As funções Pack e Unpack

* Funções Pack:: 
* Funções de Unpack:: 

Objetos números complexos

* Números complexos como estruturas C.: Números complexos como estruturas C. 
* Números complexos como objetos Python:: 

Objetos Sequência

* Objetos bytes: Objetos bytes<2>. 
* Objetos byte array:: 
* Objetos Unicode e Codecs:: 
* Objeto tupla:: 
* Objetos sequência de estrutura:: 
* Objeto List:: 

Objetos byte array

* Macros para verificação de tipo:: 
* Funções diretas da API:: 
* Macros:: 

Objetos Unicode e Codecs

* Objetos Unicode:: 
* Built-in Codecs:: 
* Methods and Slot Functions:: 

Objetos Unicode

* Tipo Unicode:: 
* Propriedade de caracteres Unicode:: 
* Creating and accessing Unicode strings:: 
* Locale Encoding:: 
* File System Encoding:: 
* wchar_t Support:: 

Built-in Codecs

* Generic Codecs:: 
* UTF-8 Codecs:: 
* UTF-32 Codecs:: 
* UTF-16 Codecs:: 
* UTF-7 Codecs:: 
* Unicode-Escape Codecs:: 
* Raw-Unicode-Escape Codecs:: 
* Latin-1 Codecs:: 
* ASCII Codecs:: 
* Character Map Codecs:: 
* MBCS codecs for Windows:: 

Coleções

* Objetos dicionários:: 
* Objeto Set:: 

Objetos dicionários

* Objetos visão de dicionário:: 
* Dicionários ordenados:: 

Objetos Function

* Objetos Function: Objetos Function<3>. 
* Objetos de Método de Instância:: 
* Objetos método: Objetos método<2>. 
* Objeto célula:: 
* Objetos código: Objetos código<3>. 
* Sinalizadores de objetos código:: 
* Informação adicional:: 

Outros Objetos

* Objetos arquivos:: 
* Objetos do Módulo:: 
* Objetos Iteradores:: 
* Objetos descritores:: 
* Objetos Slice:: 
* Objetos MemoryView:: 
* Objetos buffer serializados com pickle:: 
* Objetos referência fraca: Objetos referência fraca<2>. 
* Capsules: Capsules<2>. 
* Objetos Frame:: 
* Objetos Geradores:: 
* Objetos corrotina: Objetos corrotina<2>. 
* Objetos de variáveis de contexto:: 
* Objetos de indicação de tipos:: 

Objetos do Módulo

* Inicializando módulos C:: 
* Pesquisa por módulos:: 

Inicializando módulos C

* inicialização de fase única:: 
* Inicialização multifásica:: 
* Funções de criação de módulo de baixo nível:: 
* Support functions:: 

Objetos Iteradores

* Objetos intervalo:: 
* Tipos de iteradores embutidos:: 
* Outros objetos iteradores:: 

Objetos descritores

* Descritores embutidos:: 

Objetos Slice

* Objeto Ellipsis:: 

Objetos Frame

* Proxies locais de quadro:: 
* Legacy Local Variable APIs:: 
* Internal Frames:: 

Objetos Geradores

* Objetos geradores assíncronos:: 

API C para módulos de extensão

* API C de curses:: 
* Dados internos:: 
* Objetos DateTime: Objetos DateTime<2>. 
* Dados internos: Dados internos<2>. 

Inicialização, finalização e threads

* Antes da inicialização do Python:: 
* Variáveis de configuração global:: 
* Inicializando e encerrando o interpretador:: 
* Parâmetros de todo o processo:: 
* Estado de thread e a trava global do interpretador:: 
* Sub-interpreter support:: 
* Notificações assíncronas:: 
* Profiling and Tracing:: 
* Reference tracing:: 
* Advanced Debugger Support:: 
* Thread Local Storage Support:: 
* Synchronization Primitives: Synchronization Primitives<2>. 
* Operating System Thread APIs:: 

Estado de thread e a trava global do interpretador

* Releasing the GIL from extension code:: 
* Threads não-Python criadas:: 
* Cuidados com o uso de fork(): Cuidados com o uso de fork. 
* Cautions regarding runtime finalization:: 
* High-level API:: 
* Low-level API:: 

Sub-interpreter support

* A Per-Interpreter GIL:: 
* Bugs and caveats:: 

Thread Local Storage Support

* Thread Specific Storage (TSS) API: Thread Specific Storage TSS API. 
* Thread Local Storage (TLS) API: Thread Local Storage TLS API. 

Thread Specific Storage (TSS) API

* Alocação dinâmica:: 
* Métodos: Métodos<2>. 

Synchronization Primitives

* Python Critical Section API:: 
* Legacy Locking APIs:: 

Configuração de inicialização do Python

* Exemplo: Exemplo<17>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* Pré-inicializar Python com PyPreConfig:: 
* PyConfig:: 
* Initialization with PyConfig:: 
* Isolated Configuration:: 
* Configuração do Python:: 
* Python Path Configuration:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* Multi-Phase Initialization Private Provisional API:: 

Gerenciamento de Memória

* Visão Geral: Visão Geral<4>. 
* Allocator Domains:: 
* Raw Memory Interface:: 
* Interface da Memória:: 
* Alocadores de objeto:: 
* Alocadores de memória padrão:: 
* Alocadores de memória:: 
* Debug hooks on the Python memory allocators:: 
* The pymalloc allocator:: 
* The mimalloc allocator:: 
* tracemalloc C API:: 
* Exemplos: Exemplos<37>. 

Interface da Memória

* Apelidos descontinuados: Apelidos descontinuados<2>. 

The pymalloc allocator

* Customize pymalloc Arena Allocator:: 

Suporte a implementação de Objetos

* Alocando objetos na heap:: 
* Estruturas comuns de objetos:: 
* Estruturas de objetos tipo:: 
* Suporte a Coleta Cíclica de Lixo:: 

Alocando objetos na heap

* Apelidos descontinuados: Apelidos descontinuados<3>. 

Estruturas comuns de objetos

* Macros e tipos de objetos base:: 
* Implementing functions and methods:: 
* Accessing attributes of extension types:: 

Accessing attributes of extension types

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

Estruturas de objetos tipo

* Referências rápidas:: 
* PyTypeObject Definition:: 
* PyObject Slots:: 
* PyVarObject Slots:: 
* PyTypeObject Slots:: 
* Static Types:: 
* Tipos no heap:: 
* Number Object Structures:: 
* Mapping Object Structures:: 
* Sequence Object Structures:: 
* Buffer Object Structures:: 
* Async Object Structures:: 
* Slot Type typedefs:: 
* Exemplos: Exemplos<38>. 

Referências rápidas

* “slots tp”:: 
* sub-slots:: 
* slot typedefs:: 

Suporte a Coleta Cíclica de Lixo

* Controlando o estado do coletor de lixo:: 
* Querying Garbage Collector State:: 

Gerando eventos de execução

* Gerenciando o Estado de um Monitoramento:: 

Instalando módulos Python

* Termos chave:: 
* Uso básico: Uso básico<3>. 
* Como eu …?:: 
* Problemas comuns de instalação:: 

Como eu …?

* … instalo pip em versões do Python anteriores ao Python 3.4?: … instalo pip em versões do Python anteriores ao Python 3 4?. 
* … instalo pacotes apenas para o usuário atual?:: 
* … instalo pacotes científicos do Python?:: 
* … trabalho com várias versões do Python instaladas em paralelo?:: 

Problemas comuns de instalação

* Instalando no sistema Python no Linux:: 
* Pip não instalado:: 
* Instalando extensões binárias:: 

Python HOWTOs

* Uma visão geral conceitual de asyncio:: 
* Portando módulos de extensão para o Python 3:: 
* Programação em Curses com Python:: 
* Guia de descritores:: 
* Depurando extensões de API C e internos do CPython com GDB:: 
* Enum:: 
* Programação Funcional:: 
* Logging:: 
* Livro de receitas do logging:: 
* Expressões Regulares:: 
* Programação de Soquetes:: 
* Técnicas de ordenação:: 
* Unicode: Unicode<3>. 
* Como buscar recursos da Internet usando o pacote urllib:: 
* Uma introdução ao módulo ipaddress:: 
* Instrumentando o CPython com DTrace e SystemTap:: 
* Suporte do Python ao perfilador perf do Linux:: 
* Boas práticas para anotações:: 
* Isolando módulos de extensão:: 
* Descritor de arquivo de temporizador:: 
* A Ordem de Resolução de Métodos do Python 2.3: A Ordem de Resolução de Métodos do Python 2 3. 
* Suporte experimental do Python para threads livres:: 
* Suporte a extensões da API C para threads livres:: 

Uma visão geral conceitual de asyncio

* Uma visão geral conceitual parte 1; o alto nível: Uma visão geral conceitual parte 1 o alto nível. 
* Uma visão geral conceitual@comma{} parte 2; os detalhes: Uma visão geral conceitual parte 2 os detalhes. 

Uma visão geral conceitual parte 1: o alto nível

* Laço de eventos: Laço de eventos<2>. 
* Funções assíncronas e corrotinas:: 
* Tarefas: Tarefas<2>. 
* await:: 

Uma visão geral conceitual, parte 2: os detalhes

* O funcionamento interno das corrotinas:: 
* Futuros: Futuros<2>. 
* Um asyncio.sleep caseiro: Um asyncio sleep caseiro. 

Programação em Curses com Python

* O que é curses?:: 
* Começando e terminando uma aplicação curses:: 
* Janelas e Pads:: 
* Exibindo texto:: 
* Entrada de usuário:: 
* Para mais informações:: 

O que é curses?

* O módulo curses de Python:: 

Exibindo texto

* Atributos e Cor:: 

Guia de descritores

* Introdução: Introdução<14>. 
* Exemplo completamente prático:: 
* Tutorial técnico:: 
* Equivalentes de Python puro:: 

Introdução

* Exemplo simples; um descritor que retorna uma constante: Exemplo simples um descritor que retorna uma constante. 
* Pesquisas dinâmicas:: 
* Atributos gerenciados:: 
* Nomes personalizados:: 
* Pensamentos finais:: 

Exemplo completamente prático

* Classe Validator:: 
* Validadores personalizados:: 
* Aplicação prática:: 

Tutorial técnico

* Resumo:: 
* Definição e introdução:: 
* Protocolo Descriptor:: 
* Visão geral da invocação do descritor:: 
* Invocação de uma instância:: 
* Invocação de uma classe:: 
* Invocação de super:: 
* Resumo da lógica de invocação:: 
* Notificação automática de nome:: 
* Exemplo de ORM:: 

Equivalentes de Python puro

* Propriedades:: 
* Funções e métodos:: 
* Tipos de métodos:: 
* Métodos estáticos:: 
* Métodos de classe:: 
* Member objects and __slots__:: 

Depurando extensões de API C e internos do CPython com GDB

* Pré-requisitos:: 
* Usando a compilação de depuração e o modo de desenvolvimento:: 
* Usando a extensão python-gdb:: 
* Uso com comandos do GDB:: 

Pré-requisitos

* Configuração com Python construído a partir do código-fonte:: 
* Configuração para Python a partir de uma distribuição Linux:: 

Usando a extensão python-gdb

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

Enum

* Acesso programático aos membros da enumeração e seus atributos.: Acesso programático aos membros da enumeração e seus atributos. 
* Membros e valores duplicados em enums:: 
* Garantindo valores únicos na enumeração:: 
* Usando valores automáticos:: 
* Iteração: Iteração<2>. 
* Comparações: Comparações<3>. 
* Membros e atributos permitidos em enumerações:: 
* Herança restrita de Enum:: 
* Suporte a dataclass:: 
* Pickling:: 
* API funcional: API funcional<3>. 
* Derived Enumerations:: 
* When to use __new__() vs. __init__(): When to use __new__ vs __init__. 
* How are Enums and Flags different?:: 
* Enum Cookbook:: 
* Subclassing EnumType:: 

Derived Enumerations

* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Sinalizador:: 
* Outros: Outros<2>. 

When to use __new__() vs. __init__()

* Finer Points:: 

Finer Points

* Nomes __dunder__ suportados: Nomes __dunder__ suportados<2>. 
* Nomes _sunder_ suportados: Nomes _sunder_ suportados<2>. 
* _Private__names:: 
* Enum member type:: 
* Creating members that are mixed with other data types:: 
* Boolean value of Enum classes and members:: 
* Enum classes with methods:: 
* Combining members of Flag:: 
* Flag and IntFlag minutia:: 

How are Enums and Flags different?

* Enum Classes:: 
* Flag Classes:: 
* Enum Members (aka instances): Enum Members aka instances. 
* Flag Members:: 

Enum Cookbook

* Omitting values:: 
* OrderedEnum:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planet:: 
* TimePeriod:: 

Omitting values

* Using auto:: 
* Using object:: 
* Using a descriptive string:: 
* Using a custom __new__(): Using a custom __new__. 

Programação Funcional

* Introdução: Introdução<15>. 
* Iteradores: Iteradores<2>. 
* Expressões do gerador e compreensões de lista:: 
* Geradores: Geradores<2>. 
* Funções embutidas: Funções embutidas<4>. 
* O módulo itertools:: 
* O módulo functools:: 
* Pequenas funções e as expressões lambda:: 
* Histórico de Revisão e Reconhecimentos:: 
* Referências: Referências<2>. 

Introdução

* Probabilidade formal:: 
* Modularidade:: 
* Fácil de depurar e testar:: 
* Componibilidade:: 

Iteradores

* Tipos de Dados que Suportam Iteradores:: 

Geradores

* Passando valores para um gerador:: 

O módulo itertools

* Criando novos iteradores:: 
* Calling functions on elements:: 
* Selecionando elementos:: 
* Combinatoric functions:: 
* Agrupando elementos:: 

O módulo functools

* O módulo operator:: 

Referências

* Geral:: 
* Python-specific:: 
* Documentação do Python:: 

Logging

* Tutorial Básico de Logging:: 
* Tutorial Avançado do Logging:: 
* Níveis de Logging: Níveis de Logging<2>. 
* Handlers úteis:: 
* Exceções levantadas durante logging:: 
* Usando objetos arbitrários como mensagens:: 
* Optimização:: 
* Outros recursos: Outros recursos<2>. 

Tutorial Básico de Logging

* Quando usar logging:: 
* Um exemplo simples:: 
* Logging em um arquivo:: 
* Logging de variáveis dinâmicas:: 
* Alterar o formato das mensagens exibidas:: 
* Exibindo data/hora em mensagens:: 
* Próximos Passos:: 

Tutorial Avançado do Logging

* Fluxo de Logging:: 
* Registradores:: 
* Manipuladores:: 
* Formatadores:: 
* Configurando Logging:: 
* O que acontece se nenhuma configuração é fornecida:: 
* Configurando logging para uma biblioteca:: 

Níveis de Logging

* Níveis personalizados:: 

Livro de receitas do logging

* Usando logging em vários módulos:: 
* Registro de eventos de várias threads:: 
* Múltiplos manipuladores e formatadores:: 
* Logging to multiple destinations:: 
* Custom handling of levels:: 
* Configuration server example:: 
* Dealing with handlers that block:: 
* Sending and receiving logging events across a network:: 
* Adding contextual information to your logging output:: 
* Use of contextvars:: 
* Imparting contextual information in handlers:: 
* Logging to a single file from multiple processes:: 
* Using file rotation:: 
* Use of alternative formatting styles:: 
* Personalizando o LogRecord:: 
* Subclassing QueueHandler and QueueListener- a ZeroMQ example:: 
* Subclassing QueueHandler and QueueListener- a pynng example:: 
* An example dictionary-based configuration:: 
* Using a rotator and namer to customize log rotation processing:: 
* A more elaborate multiprocessing example:: 
* Inserting a BOM into messages sent to a SysLogHandler:: 
* Implementing structured logging:: 
* Customizing handlers with dictConfig(): Customizing handlers with dictConfig. 
* Using particular formatting styles throughout your application:: 
* Configuring filters with dictConfig(): Configuring filters with dictConfig. 
* Customized exception formatting:: 
* Speaking logging messages:: 
* Buffering logging messages and outputting them conditionally:: 
* Sending logging messages to email@comma{} with buffering: Sending logging messages to email with buffering. 
* Formatting times using UTC (GMT) via configuration: Formatting times using UTC GMT via configuration. 
* Using a context manager for selective logging:: 
* A CLI application starter template:: 
* A Qt GUI for logging:: 
* Logging to syslog with RFC5424 support:: 
* How to treat a logger like an output stream:: 
* How to uniformly handle newlines in logging output:: 
* Patterns to avoid:: 
* Outros recursos: Outros recursos<3>. 

Sending and receiving logging events across a network

* Running a logging socket listener in production:: 

Adding contextual information to your logging output

* Using LoggerAdapters to impart contextual information:: 
* Using Filters to impart contextual information:: 

Using LoggerAdapters to impart contextual information

* Using objects other than dicts to pass contextual information:: 

Logging to a single file from multiple processes

* Using concurrent.futures.ProcessPoolExecutor: Using concurrent futures ProcessPoolExecutor. 
* Deploying Web applications using Gunicorn and 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>. 

Using particular formatting styles throughout your application

* Using LogRecord factories:: 
* Using custom message objects:: 

Patterns to avoid

* Opening the same log file multiple times:: 
* Using loggers as attributes in a class or passing them as parameters:: 
* Adding handlers other than NullHandler to a logger in a library:: 
* Creating a lot of loggers:: 

Expressões Regulares

* Introdução: Introdução<16>. 
* Padrões simples:: 
* Usando expressões regulares:: 
* Mais poder dos padrões:: 
* Modificando strings:: 
* Problemas comuns:: 
* Comentários: Comentários<2>. 

Padrões simples

* Correspondendo caracteres:: 
* Repetindo coisas:: 

Usando expressões regulares

* Compilando expressões regulares:: 
* A praga da contrabarra:: 
* Executando correspondências:: 
* Funções de nível de módulo: Funções de nível de módulo<3>. 
* Sinalizadores de compilação:: 

Mais poder dos padrões

* Mais metacaracteres:: 
* Agrupamento:: 
* Não captura e grupos nomeados:: 
* Asserções lookahead:: 

Modificando strings

* Dividindo as strings:: 
* Busca e Substituição: Busca e Substituição<2>. 

Problemas comuns

* Usando métodos de string:: 
* match() versus search(): match versus search. 
* Gulosos versus não-gulosos:: 
* Usando re.VERBOSE: Usando re VERBOSE. 

Programação de Soquetes

* Soquetes:: 
* Criando um Soquete:: 
* Usando um Soquete:: 
* Desconectando:: 
* Soquetes não-bloqueantes:: 

Soquetes

* História:: 

Criando um Soquete

* IPC:: 

Usando um Soquete

* Dados Binários:: 

Desconectando

* Quando o Soquete Morre:: 

Técnicas de ordenação

* Básico de ordenação:: 
* Funções chave:: 
* Operator Module Functions and Partial Function Evaluation:: 
* Ascendente e descendente:: 
* Estabilidade de Ordenação e Ordenações Complexas:: 
* Decorate-Sort-Undecorate:: 
* Funções de comparação:: 
* Curiosidades e conclusões: Curiosidades e conclusões<2>. 
* Ordenações parciais:: 

Unicode

* Introdução ao Unicode:: 
* Suporte a Unicode no Python:: 
* Reading and Writing Unicode Data:: 
* Reconhecimentos: Reconhecimentos<10>. 

Introdução ao Unicode

* Definições:: 
* Codificações:: 
* Referências: Referências<3>. 

Suporte a Unicode no Python

* O Tipo String:: 
* Convertendo para Bytes:: 
* Unicode Literals in Python Source Code:: 
* Propriedades Unicode:: 
* Comparando Strings:: 
* Expressões Regulares Unicode:: 
* Referências: Referências<4>. 

Reading and Writing Unicode Data

* Nomes de arquivos Unicode:: 
* Tips for Writing Unicode-aware Programs:: 
* Referências: Referências<5>. 

Tips for Writing Unicode-aware Programs

* Converting Between File Encodings:: 
* Files in an Unknown Encoding:: 

Como buscar recursos da Internet usando o pacote urllib

* Introdução: Introdução<17>. 
* Acessando URLs:: 
* Tratamento de exceções: Tratamento de exceções<3>. 
* info e geturl:: 
* Abridores e tratadores:: 
* Autenticação básica:: 
* Proxies:: 
* Socekts e camadas:: 
* Notas de rodapé:: 

Acessando URLs

* Dados:: 
* Cabeçalhos:: 

Tratamento de exceções

* URLError:: 
* HTTPError:: 
* Resumindo:: 

HTTPError

* Códigos de erro:: 

Resumindo

* Número 1:: 
* Número 2:: 

Uma introdução ao módulo ipaddress

* Criando objetos de Endereço/Rede/Interface:: 
* Inspecionando objetos endereço/rede/interface:: 
* Redes como listas de Addresses:: 
* Comparações: Comparações<4>. 
* Usando endereços IP com outros módulos:: 
* Obtendo mais detalhes quando a criação da instância falha:: 

Criando objetos de Endereço/Rede/Interface

* Uma observação sobre versões do IP:: 
* Endereços IP de host:: 
* Definindo redes:: 
* Interfaces do host:: 

Instrumentando o CPython com DTrace e SystemTap

* Habilitando os marcadores estáticos:: 
* Sondas estáticas do DTtrace:: 
* Marcadores estáticos do SystemTap:: 
* Marcadores estáticos disponíveis:: 
* Tapsets de SystemTap:: 
* Exemplos: Exemplos<39>. 

Suporte do Python ao perfilador perf do Linux

* Como habilitar o suporte a perfilação com perf:: 
* Como obter os melhores resultados:: 
* Como trabalhar sem ponteiros de quadro:: 

Boas práticas para anotações

* Acessando o dicionário de anotações de um objeto no Python 3.10 e nas versões mais recentes: Acessando o dicionário de anotações de um objeto no Python 3 10 e nas versões mais recentes. 
* Acessando o dicionário de anotações de um objeto no Python 3.9 e nas versões mais antigas: Acessando o dicionário de anotações de um objeto no Python 3 9 e nas versões mais antigas. 
* Recuperando manualmente anotações transformadas em strings:: 
* Melhores práticas para __annotations__ em qualquer versão Python:: 
* Peculiaridades de __annotations__:: 

Isolando módulos de extensão

* Quem deveria ler isto:: 
* Contexto: Contexto<2>. 
* Fazendo módulos seguros com múltiplos interpretadores:: 
* Tipos no heap: Tipos no heap<2>. 
* Problemas em aberto:: 

Contexto

* Entra o estado por módulo:: 
* Objetos de módulo isolados:: 
* Casos particulares surpreendentes:: 

Fazendo módulos seguros com múltiplos interpretadores

* Gerenciando estado global:: 
* Gerenciando estado por módulo:: 
* Exclusão voluntária; limitando a um objeto de módulo por processo: Exclusão voluntária limitando a um objeto de módulo por processo. 
* Acesso ao estado de módulo a partir de funções:: 

Tipos no heap

* Mudando tipos estáticos para tipos no heap:: 
* Definindo tipos no heap:: 
* Protocolo de recolhimento de lixo:: 
* Acessando o estado do módulo a partir de classes:: 
* Acesso ao estado do módulo a partir de métodos regulares:: 
* Acesso ao estado do módulo a partir de métodos slot@comma{} getters e setters: Acesso ao estado do módulo a partir de métodos slot getters e setters. 
* Tempo de vida do estado do módulo:: 

Protocolo de recolhimento de lixo

* tp_traverse no Python 3.8 e anteriores: tp_traverse no Python 3 8 e anteriores. 
* Delegando a função tp_traverse:: 
* Definindo tp_dealloc:: 
* Evitar substituir tp_free:: 
* Evitar PyObject_New:: 

Problemas em aberto

* Escopo por classe:: 
* Conversão sem perdas para tipos no heap:: 

Descritor de arquivo de temporizador

* Exemplos: Exemplos<40>. 

A Ordem de Resolução de Métodos do Python 2.3

* O início:: 
* A ordem de resolução de métodos C3:: 
* Exemplos: Exemplos<41>. 
* Ordens de resolução de métodos ruins:: 
* O fim:: 
* Recursos: Recursos<3>. 

Suporte experimental do Python para threads livres

* Instalação:: 
* Identificando um Python com threads livres:: 
* A trava global do interpretador no Python com threads livres:: 
* Segurança nas threads:: 
* Limitações conhecidas:: 

Limitações conhecidas

* Imortalização:: 
* Objetos quadro: Objetos quadro<2>. 
* Iteradores: Iteradores<3>. 
* Desempenho com thread única:: 

Suporte a extensões da API C para threads livres

* Identificando a construção com threads livres em C:: 
* Inicialização de módulo:: 
* Diretrizes gerais de API:: 
* Referências emprestadas:: 
* APIs de alocação de memória:: 
* APIs da GIL e de estado de threads:: 
* Protegendo o estado interno das extensões:: 
* Construindo extensões para a construção com threads livres:: 

Inicialização de módulo

* Inicialização multifásica: Inicialização multifásica<2>. 
* Inicialização monofásica:: 

Diretrizes gerais de API

* Segurança de threads de contêineres:: 

Segurança de threads de contêineres

* PyDict_Next:: 

Construindo extensões para a construção com threads livres

* API C limitada e ABI estável:: 
* Windows: Windows<82>. 

Perguntas Frequentes Sobre Python

* Python Geral:: 
* FAQ sobre programação:: 
* FAQ sobre design e histórico:: 
* FAQ de Bibliotecas e Extensões:: 
* FAQ sobre Extensão/Incorporação:: 
* Python no Windows:: 
* FAQ da Interface Gráfica do Usuário:: 
* FAD de “Por que o Python está instalado em meu computador?”:: 

Python Geral

* Informações gerais:: 
* Python no mundo real:: 

Informações gerais

* O que é Python?:: 
* O que é a Python Software Foundation?:: 
* Existem restrições de direitos autorais sobre o uso de Python?:: 
* Em primeiro lugar@comma{} por que o Python foi desenvolvido?: Em primeiro lugar por que o Python foi desenvolvido?. 
* Para o que Python é excelente?:: 
* Como funciona o esquema de numeração de versões do Python?:: 
* Como faço para obter uma cópia dos fonte do Python?:: 
* Como faço para obter a documentação do Python?:: 
* Eu nunca programei antes. Existe um tutorial básico do Python?: Eu nunca programei antes Existe um tutorial básico do Python?. 
* Existe um grupo de discussão ou lista de discussão dedicada ao Python?:: 
* Como faço para obter uma versão de teste beta do Python?:: 
* Como eu envio um relatório de erros e correções para o Python?:: 
* Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?:: 
* Existem alguns livros sobre o Python?:: 
* Onde está armazenado o site www.python.org?: Onde está armazenado o site www python org?. 
* Por que o nome Python?:: 
* Eu tenho que gostar de “Monty Python’s Flying Circus”?:: 

Python no mundo real

* Quão estável é o Python?:: 
* Quantas pessoas usam o Python?:: 
* Existe algum projeto significativo feito em Python?:: 
* Quais são os novos desenvolvimentos esperados para o Python no futuro?:: 
* É razoável propor mudanças incompatíveis com o Python?:: 
* O Python é uma boa linguagem para quem está começando na programação agora?:: 

FAQ sobre programação

* Perguntas gerais:: 
* Núcleo da linguagem:: 
* Números e strings:: 
* Desempenho: Desempenho<4>. 
* Sequencias (Tuplas/Listas): Sequencias Tuplas/Listas. 
* Objetos:: 
* Módulos: Módulos<5>. 

Perguntas gerais

* Existe um depurador a nível de código-fonte que possua pontos de interrupção (breakpoints)@comma{} single-stepping@comma{} etc.?: Existe um depurador a nível de código-fonte que possua pontos de interrupção breakpoints single-stepping etc ?. 
* Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?:: 
* Como posso criar um binário independente a partir de um script Python?:: 
* Existem padrões para a codificação ou um guia de estilo utilizado pela comunidade Python?:: 

Núcleo da linguagem

* Porque recebo o erro UnboundLocalError quando a variável possui um valor associado?:: 
* Quais são as regras para variáveis locais e globais em Python?:: 
* Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?:: 
* Como definir variáveis globais dentro de módulos?:: 
* Quais são as “melhores práticas” quando fazemos uso da importação de módulos?:: 
* Por que os valores padrão são compartilhados entre objetos?:: 
* Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?:: 
* Qual a diferença entre argumentos e parâmetros?:: 
* Por que ao alterar a lista ‘y’ também altera a lista ‘x’?:: 
* Como escrevo uma função com parâmetros de saída (chamada por referência)?: Como escrevo uma função com parâmetros de saída chamada por referência ?. 
* Como fazer uma função de ordem superior em Python?:: 
* Como faço para copiar um objeto no Python?:: 
* Como posso encontrar os métodos ou atributos de um objeto?:: 
* Como que o meu código pode descobrir o nome de um objeto?:: 
* O que há com a precedência do operador vírgula?:: 
* Existe um equivalente ao operador ternário “?;” do C?: Existe um equivalente ao operador ternário “? ” do C?. 
* É possível escrever instruções de uma só linha ofuscadas em Python?:: 
* O que a barra(/) na lista de parâmetros de uma função significa?: O que a barra / na lista de parâmetros de uma função significa?. 

Números e strings

* Como faço para especificar números inteiros hexadecimais e octais?:: 
* Por que -22 // 10 retorna -3?:: 
* Como obtenho um atributo de um literal int em vez de SyntaxError?:: 
* Como faço para converter uma string em um número?:: 
* Como faço para converter um número em uma string?:: 
* Como faço para modificar uma string internamente?:: 
* Como faço para invocar funções/métodos através de strings?:: 
* Existe um equivalente em Perl chomp() para remover linhas novas ao final de strings?: Existe um equivalente em Perl chomp para remover linhas novas ao final de strings?. 
* Existe uma função scanf() ou sscanf() ou algo equivalente?: Existe uma função scanf ou sscanf ou algo equivalente?. 
* O que significa o erro UnicodeDecodeError ou UnicodeEncodeError?:: 
* Posso terminar uma string bruta com um número ímpar de contrabarras?:: 

Desempenho

* Meu programa está muito lento. Como faço para melhorar o desempenho?: Meu programa está muito lento Como faço para melhorar o desempenho?. 
* Qual é a maneira mais eficiente de concatenar muitas strings?:: 

Sequencias (Tuplas/Listas)

* Como faço para converter tuplas em listas?:: 
* O que é um índice negativo?:: 
* Como que eu itero uma sequência na ordem inversa?:: 
* Como que removo itens duplicados de uma lista?:: 
* How do you remove multiple items from a list?:: 
* Como fazer um vetor em Python?:: 
* Como faço para criar uma lista multidimensional?:: 
* Como eu aplico um método ou função para uma sequência de objetos?:: 
* Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?:: 
* Quero fazer uma ordenação confusa; você pode fazer uma transformação schwartziana em Python?: Quero fazer uma ordenação confusa você pode fazer uma transformação schwartziana em Python?. 
* Como eu posso ordenar uma lista pelos valores de outra lista?:: 

Objetos

* O que é uma classe?:: 
* O que é um método?:: 
* O que é o self?:: 
* Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?:: 
* O que é delegação?:: 
* Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?:: 
* Como eu posso organizar meu código para facilitar a troca da classe base?:: 
* Como faço para criar dados de classe estáticos e métodos de classe estáticos?:: 
* Como eu posso sobrecarregar construtores (ou métodos) em Python?: Como eu posso sobrecarregar construtores ou métodos em Python?. 
* Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam.: Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam. 
* Minha classe define __del__@comma{} mas o mesmo não é chamado quando eu excluo o objeto.: Minha classe define __del__ mas o mesmo não é chamado quando eu excluo o objeto. 
* Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?:: 
* Por que o resultado de id() aparenta não ser único?: Por que o resultado de id aparenta não ser único?. 
* Quando eu posso depender dos testes de identidade com o operador is?:: 
* Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?:: 
* Como faço para armazenar em cache as chamadas de um método?:: 

Módulos

* Como faço para criar um arquivo .pyc?: Como faço para criar um arquivo pyc?. 
* Como encontro o nome do módulo atual?:: 
* Como posso ter módulos que se importam mutuamente?:: 
* __import__(‘x.y.z’) retorna <módulo ‘x’>; como faço para obter z?: __import__ ‘x y z’ retorna <módulo ‘x’>; como faço para obter z?. 
* Quando eu edito um módulo importado e o reimporto@comma{} as mudanças não aparecem. Por que isso acontece?: Quando eu edito um módulo importado e o reimporto as mudanças não aparecem Por que isso acontece?. 

FAQ sobre design e histórico

* Por que o Python usa indentação para agrupamento de instruções?:: 
* Por que eu estou recebendo resultados estranhos com simples operações aritméticas?:: 
* Por que o cálculo de pontos flutuantes são tão imprecisos?:: 
* Por que strings do Python são imutáveis?:: 
* Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?:: 
* Por que não posso usar uma atribuição em uma expressão?:: 
* Por que o Python usa métodos para algumas funcionalidades (ex; lista.index()) mas funções para outras (ex; len(lista))?: Por que o Python usa métodos para algumas funcionalidades ex lista index mas funções para outras ex len lista ?. 
* Por que o join() é um método de string em vez de ser um método de lista ou tupla?: Por que o join é um método de string em vez de ser um método de lista ou tupla?. 
* Quão rápidas são as exceções?:: 
* Por que não existe uma instrução de switch ou case no Python?:: 
* Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?:: 
* Por que expressões lambda não podem conter instruções?:: 
* O Python pode ser compilado para linguagem de máquina@comma{} C ou alguma outra linguagem?: O Python pode ser compilado para linguagem de máquina C ou alguma outra linguagem?. 
* Como o Python gerencia memória?:: 
* Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?:: 
* Por que toda memória não é liberada quando o CPython fecha?:: 
* Por que existem tipos de dados separados para tuplas e listas?:: 
* Como as listas são implementadas no CPython?:: 
* Como são os dicionários implementados no CPython?:: 
* Por que chaves de dicionário devem ser imutáveis?:: 
* Por que lista.sort() não retorna a lista ordenada?: Por que lista sort não retorna a lista ordenada?. 
* Como você especifica e aplica um spec de interface no Python?:: 
* Por que não há goto?:: 
* Por que strings brutas (r-strings) não podem terminar com uma contrabarra?: Por que strings brutas r-strings não podem terminar com uma contrabarra?. 
* Por que o Python não tem uma instrução “with” para atribuição de atributos?:: 
* Por que os geradores não suportam a instrução with?:: 
* Por que dois pontos são necessários para as instruções de if/while/def/class?:: 
* Por que o Python permite vírgulas ao final de listas e tuplas?:: 

FAQ de Bibliotecas e Extensões

* Questões gerais sobre bibliotecas:: 
* Tarefas comuns:: 
* Threads:: 
* Entrada e Saída: Entrada e Saída<2>. 
* Programação Rede / Internet:: 
* Base de Dados:: 
* Matemáticos e Numéricos:: 

Questões gerais sobre bibliotecas

* Como encontrar um módulo ou aplicação para realizar uma tarefa X?:: 
* Onde está o código-fonte do math.py (socket.py@comma{} regex.py@comma{} etc.)?: Onde está o código-fonte do math py socket py regex py etc ?. 
* Como tornar um script Python executável no Unix?:: 
* Existe um pacote de curses/termcap para Python?:: 
* Existe a função onexit() equivalente ao C no Python?: Existe a função onexit equivalente ao C no Python?. 
* Por que o meu manipulador de sinal não funciona?:: 

Tarefas comuns

* Como testar um programa ou componente Python?:: 
* Como faço para criar uma documentação de doc strings?:: 
* Como faço para pressionar uma tecla de cada vez?:: 

Threads

* Como faço para programar usando threads?:: 
* Nenhuma de minhas threads parece funcionar@comma{} por que?: Nenhuma de minhas threads parece funcionar por que?. 
* Como distribuo o trabalho entre várias threads de trabalho?:: 
* Que tipos de variáveis globais mutáveis são seguras para thread?:: 
* Não podemos remover a Trava Global do interpretador?:: 

Entrada e Saída

* Como faço para excluir um arquivo? (E outras perguntas sobre arquivos): Como faço para excluir um arquivo? E outras perguntas sobre arquivos. 
* Como eu copio um arquivo?:: 
* Como leio (ou escrevo) dados binários?: Como leio ou escrevo dados binários?. 
* Por que não consigo usar os.read() em um encadeamento com os.popen()?: Por que não consigo usar os read em um encadeamento com os popen ?. 
* Como acesso a porta serial (RS232)?: Como acesso a porta serial RS232 ?. 
* Por que o sys.stdout (stdin@comma{} stderr) não fecha?: Por que o sys stdout stdin stderr não fecha?. 

Programação Rede / Internet

* Quais ferramentas para WWW existem no Python?:: 
* Qual módulo devo usar para ajudar na geração do HTML?:: 
* Como envio um e-mail de um script Python?:: 
* Como evito um bloqueio no método connect() de um soquete?: Como evito um bloqueio no método connect de um soquete?. 

Base de Dados

* Existem interfaces para banco de dados em Python?:: 
* Como você implementa objetos persistentes no Python?:: 

Matemáticos e Numéricos

* Como gero número aleatórios no Python?:: 

FAQ sobre Extensão/Incorporação

* Posso criar minhas próprias funções em C?:: 
* Posso criar minhas próprias funções em C++?:: 
* Escrever C é difícil; há alguma alternativa?:: 
* Como posso executar instruções arbitrárias de Python a partir de C?:: 
* Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?:: 
* Como extraio valores em C a partir de um objeto Python?:: 
* Como posso utilizar Py_BuildValue() para criar uma tupla de comprimento arbitrário?: Como posso utilizar Py_BuildValue para criar uma tupla de comprimento arbitrário?. 
* Como eu chamo um método de um objeto a partir do C?:: 
* Como posso capturar a saída da função PyErr_Print() (ou qualquer outra coisa que escreva para stdout/stderr)?: Como posso capturar a saída da função PyErr_Print ou qualquer outra coisa que escreva para stdout/stderr ?. 
* Como faço para acessar a partir do C um módulo escrito em Python?:: 
* Como posso interagir com objetos C++ a partir do Python?:: 
* Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?:: 
* Como eu depuro uma extensão?:: 
* Quero compilar um módulo Python no meu sistema Linux@comma{} mas alguns arquivos estão faltando. Por quê?: Quero compilar um módulo Python no meu sistema Linux mas alguns arquivos estão faltando Por quê?. 
* Como posso distinguir “entrada incompleta” de “entrada inválida”?:: 
* Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?:: 
* Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python (por exemplo@comma{} via herança)?: Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python por exemplo via herança ?. 

Python no Windows

* Como faço para executar um programa Python no Windows?:: 
* Como eu faço para criar programas Python executáveis?:: 
* Por que Python às vezes demora tanto para iniciar?:: 
* Como eu faço para criar um executável a partir de um código Python?:: 
* Um arquivo *.pyd é o mesmo que um DLL?: Um arquivo * pyd é o mesmo que um DLL?. 
* Como eu posso embutir Python dentro de uma aplicação do Windows?:: 
* Como eu impeço editores de adicionarem tabulações na minha source do Python?:: 
* Como faço para verificar uma tecla pressionada sem bloquear?:: 
* Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0.dll ausente?: Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0 dll ausente?. 

FAQ da Interface Gráfica do Usuário

* Perguntas Gerais sobre a GUI:: 
* Quais toolkits de GUI existem para o Python?:: 
* Perguntas do Tkinter:: 

Perguntas do Tkinter

* Como eu congelo as aplicações Tkinter?:: 
* Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?:: 
* Não consigo fazer as ligações de tecla funcionarem no Tkinter; por que?: Não consigo fazer as ligações de tecla funcionarem no Tkinter por que?. 

FAD de “Por que o Python está instalado em meu computador?”

* O que é Python?: O que é Python?<2>. 
* Porque Python está instalado em minha máquina?:: 
* Eu posso apagar o Python?:: 

Descontinuações

* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<5>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<5>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<5>. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17<3>. 
* Remoção pendente no Python 3.18: Remoção pendente no Python 3 18<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<5>. 
* Descontinuações na API C:: 

Descontinuações na API C

* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<6>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<6>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<6>. 

Sobre esta documentação

* Contribuidores da documentação do Python:: 

Lidando com bugs

* Bugs na documentação:: 
* Usando o rastreador de problemas do Python:: 
* Começando a contribuir com o Python por conta própria:: 

História e Licença

* História do software:: 
* Termos e condições para acessar ou usar Python:: 
* Licenças e Reconhecimentos para Software Incorporado:: 

Termos e condições para acessar ou usar Python

* PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2:: 
* ACORDO DE LICENCIAMENTO DA BEOPEN.COM PARA PYTHON 2.0: ACORDO DE LICENCIAMENTO DA BEOPEN COM PARA PYTHON 2 0. 
* CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1.6.1: CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1 6 1. 
* ACORDO DE LICENÇA DA CWI PARA PYTHON 0.9.0 A 1.2: ACORDO DE LICENÇA DA CWI PARA PYTHON 0 9 0 A 1 2. 
* ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION:: 

Licenças e Reconhecimentos para Software Incorporado

* Mersenne Twister:: 
* Soquetes: Soquetes<2>. 
* Serviços de soquete assíncrono:: 
* Gerenciamento de cookies:: 
* Rastreamento de execução:: 
* Funções UUencode e UUdecode:: 
* Chamadas de procedimento remoto XML:: 
* test_epoll:: 
* kqueue de seleção:: 
* SipHash24:: 
* strtod e dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<3>. 
* cfuhash:: 
* libmpdec:: 
* Conjunto de testes C14N do W3C:: 
* mimalloc:: 
* asyncio: asyncio<12>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 

@end detailmenu
@end menu

@node O que há de novo no Python,O tutorial do Python,Top,Top
@anchor{whatsnew/index doc}@anchor{136}@anchor{whatsnew/index python-documentation-contents}@anchor{137}@anchor{whatsnew/index what-s-new-in-python}@anchor{138}@anchor{whatsnew/index whatsnew-index}@anchor{139}
@chapter O que há de novo no Python


A série “O que há de novo no Python” é uma série de ensaios que nos guia através das mudanças mais importantes entre as principais versões do Python. Ela é imprescindível para aqueles que desejam manter-se atualizados a cada novo lançamento.

@menu
* O que há de novo no Python 3.13: O que há de novo no Python 3 13. 
* O que há de novo no Python 3.12: O que há de novo no Python 3 12. 
* O que há de novo no Python 3.11: O que há de novo no Python 3 11. 
* O que há de novo no Python 3.10: O que há de novo no Python 3 10. 
* O que há de novo no Python 3.9: O que há de novo no Python 3 9. 
* O que há de novo no Python 3.8: O que há de novo no Python 3 8. 
* O que há de novo no Python 3.7: O que há de novo no Python 3 7. 
* What’s New In Python 3.6: What’s New In Python 3 6. 
* O que há de novo no Python 3.5: O que há de novo no Python 3 5. 
* O que há de novo no Python 3.4: O que há de novo no Python 3 4. 
* O que há de novo no Python 3.3: O que há de novo no Python 3 3. 
* O que há de novo no Python 3.2: O que há de novo no Python 3 2. 
* O que há de novo no Python 3.1: O que há de novo no Python 3 1. 
* O que há de novo no Python 3.0: O que há de novo no Python 3 0. 
* O que há de novo no Python 2.7: O que há de novo no Python 2 7. 
* O que há de novo no Python 2.6: O que há de novo no Python 2 6. 
* What’s New in Python 2.5: What’s New in Python 2 5. 
* What’s New in Python 2.4: What’s New in Python 2 4. 
* What’s New in Python 2.3: What’s New in Python 2 3. 
* What’s New in Python 2.2: What’s New in Python 2 2. 
* What’s New in Python 2.1: What’s New in Python 2 1. 
* What’s New in Python 2.0: What’s New in Python 2 0. 
* Changelog:: 

@end menu

@node O que há de novo no Python 3 13,O que há de novo no Python 3 12,,O que há de novo no Python
@anchor{whatsnew/3 13 doc}@anchor{13a}@anchor{whatsnew/3 13 what-s-new-in-python-3-13}@anchor{13b}
@section O que há de novo no Python 3.13


@*Editores: 
Adam Turner e 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.

Este artigo explica os novos recursos no Python 3.13, em comparação com 3.12. Python 3.13 foi lançado em 7 de outubro de 2024. Veja @ref{13c,,changelog} para uma lista completa de mudanças.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 719
PEP 719@footnote{https://peps.python.org/pep-0719/} – Cronograma de lançamento do Python 3.13


@menu
* Resumo – Destaques da versão:: 
* Novas funcionalidades:: 
* Outras mudanças na linguagem:: 
* Novos módulos:: 
* Módulos melhorados:: 
* Otimizações:: 
* Módulos e APIs removidas:: 
* Novas descontinuações:: 
* Alterações de bytecode do CPython:: 
* Alterações na API C:: 
* Mudanças na construção:: 
* Portando para o Python 3.13: Portando para o Python 3 13. 
* Mudanças em teste de regressão:: 
* Alterações notáveis no 3.13.1: Alterações notáveis no 3 13 1. 
* Alterações notáveis no 3.13.4: Alterações notáveis no 3 13 4. 

@end menu

@node Resumo – Destaques da versão,Novas funcionalidades,,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 summary-release-highlights}@anchor{13d}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.13.
@c Brevity is key.

O Python 3.13 é a versão estável mais recente da linguagem de programação Python, com uma mistura de mudanças na linguagem, na implementação e na biblioteca padrão. As maiores mudanças incluem um novo @ref{13e,,interpretador interativo}, suporte experimental para execução em um @ref{13f,,modo de threads livres} (
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}) e um @ref{140,,compilador Just-In-Time} (
@geindex Propostas de Melhorias do Python; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}).

As mensagens de erro continuam a melhorar, com tracebacks (situação da pilha de execução) agora realçados em cores por padrão. A função embutida @ref{141,,locals()} agora tem @ref{142,,semânticas definidas} para alterar o mapeamento retornado, e os parâmetros de tipo agora oferecem suporte a valores padrão.

As alterações da biblioteca contêm a remoção de APIs e módulos descontinuados, bem como as melhorias usuais em facilidade de uso e correção. Vários módulos da biblioteca padrão legados agora @ref{143,,foram removidos} após sua descontinuação no Python 3.11 (
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}).

Este artigo não tenta fornecer uma especificação completa de todos os novos recursos, mas fornece uma visão geral conveniente. Para detalhes completos, consulte a documentação, como @ref{144,,Referência da Biblioteca} e @ref{145,,Referência da Linguagem}. Para entender a implementação completa e a justificativa do design para uma mudança, consulte a PEP para um novo recurso específico; mas observe que as PEPs geralmente não são mantidas atualizadas depois que um recurso é totalmente implementado. Veja @ref{146,,Portando para o Python 3.13} para orientação sobre atualização a partir de versões anteriores do Python.


__________________________________________________________________


@c PEP-sized items next.

Melhorias no interpretador:


@itemize *

@item 
Um @ref{13e,,interpretador interativo} bastante aprimorado e @ref{147,,mensagens de erro aprimoradas}.

@item 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}: a função embutida @ref{141,,locals()} agora tem @ref{142,,semântica definida} ao fazer a mutação do mapeamento retornado. Os depuradores do Python e ferramentas semelhantes agora podem atualizar variáveis locais de maneira mais confiável em escopos otimizados, mesmo durante a execução simultânea de código.

@item 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}: CPython 3.13 tem suporte experimental para ser executado com a @ref{148,,trava global do interpretador}, ou GIL, desabilitada. Veja @ref{13f,,CPython com threads livres} para mais detalhes.

@item 
@geindex Propostas de Melhorias do Python; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}: um @ref{140,,compilador JIT} básico foi adicionado. Atualmente está desativado por padrão (embora possamos ativá-lo mais tarde). As melhorias de desempenho são modestas – esperamos melhorar isso nas próximas versões.

@item 
Suporte a cores no novo @ref{13e,,interpretador interativo}, bem como na saída de @ref{147,,tracebacks} e de @ref{149,,doctest}. Isso pode ser desabilitado através das variáveis de ambiente 
@geindex PYTHON_COLORS
@geindex variável de ambiente; PYTHON_COLORS
@ref{14a,,PYTHON_COLORS} e NO_COLOR@footnote{https://no-color.org/}.
@end itemize

Melhorias no modelo de dados Python:


@itemize *

@item 
@ref{14b,,__static_attributes__} armazena os nomes dos atributos acessados por meio de @code{self.X} em qualquer função no corpo da classe.

@item 
@ref{14c,,__firstlineno__} registra o número da primeira linha da definição de classe.
@end itemize

Melhorias significativas na biblioteca padrão:


@itemize *

@item 
Adiciona uma nova exceção @ref{14d,,PythonFinalizationError}, levantada quando uma operação é bloqueada durante a @ref{14e,,finalização}.

@item 
O módulo @ref{6,,argparse} agora oferece suporte a descontinuar opções de linha de comando, argumentos posicionais e subcomandos.

@item 
As novas funções @ref{14f,,base64.z85encode()} e @ref{150,,base64.z85decode()} oferecem suporte à codificação e decodificação de dados Z85@footnote{https://rfc.zeromq.org/spec/32/}.

@item 
O módulo @ref{25,,copy} agora tem uma função @ref{151,,copy.replace()}, com suporte para muitos tipos embutidos e qualquer classe que defina o método @ref{152,,__replace__()}.

@item 
O novo módulo @ref{35,,dbm.sqlite3} agora é o backend @ref{31,,dbm} padrão.

@item 
O módulo @ref{a1,,os} tem um @ref{153,,conjunto de novas funções} para trabalhar com os descritores de arquivo de notificação de temporizador do Linux.

@item 
O módulo @ref{b8,,random} agora tem uma @ref{154,,interface de linha de comando}.
@end itemize

Melhorias de Segurança:


@itemize *

@item 
@ref{155,,ssl.create_default_context()} define @ref{156,,ssl.VERIFY_X509_PARTIAL_CHAIN} e @ref{157,,ssl.VERIFY_X509_STRICT} como sinalizadores padrão.
@end itemize

Melhorias na API C:


@itemize *

@item 
O slot @ref{158,,Py_mod_gil} agora é usado para indicar que um módulo de extensão oferece suporte à execução com a @ref{159,,GIL} desabilitada.

@item 
A @ref{15a,,API C PyTime} foi adicionada, fornecendo acesso aos relógios do sistema.

@item 
@ref{15b,,PyMutex} é um novo mutex leve que ocupa um único byte.

@item 
Há um novo @ref{15c,,conjunto de funções} para gerar eventos de monitoramento da 
@geindex Propostas de Melhorias do Python; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} na API C.
@end itemize

Novos recursos de tipagem:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}: parâmetros de tipo (@ref{15d,,typing.TypeVar}, @ref{15e,,typing.ParamSpec} e @ref{15f,,typing.TypeVarTuple}) agora oferecem suporte a valores padrão.

@item 
@geindex Propostas de Melhorias do Python; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: o novo decorador @ref{160,,warnings.deprecated()} adiciona suporte para marcar descontinuações no sistema de tipos e ambiente de execução.

@item 
@geindex Propostas de Melhorias do Python; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: @ref{161,,typing.ReadOnly} pode ser usado para marcar um item de @ref{162,,typing.TypedDict} como somente leitura para verificadores de tipo.

@item 
@geindex Propostas de Melhorias do Python; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: @ref{163,,typing.TypeIs} fornece um comportamento de estreitamento de tipo mais intuitivo, como uma alternativa ao @ref{164,,typing.TypeGuard}.
@end itemize

Suporte à plataforma:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: iOS da Apple agora é uma @ref{165,,plataforma oficialmente com suporte}, no 
@geindex Propostas de Melhorias do Python; PEP 11#tier-3
tier 3@footnote{https://peps.python.org/pep-0011/#tier-3}.

@item 
@geindex Propostas de Melhorias do Python; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: Android é agora uma  @ref{165,,plataforma oficialmente com suporte}, no 
@geindex Propostas de Melhorias do Python; PEP 11#tier-3
tier 3@footnote{https://peps.python.org/pep-0011/#tier-3}.

@item 
@code{wasm32-wasi} agora é uma plataforma com suporte 
@geindex Propostas de Melhorias do Python; PEP 11#tier-2
tier 2@footnote{https://peps.python.org/pep-0011/#tier-2}.

@item 
@code{wasm32-emscripten} não é mais uma plataforma oficialmente com suporte.
@end itemize

Remoções importantes:


@itemize *

@item 
@ref{143,,PEP 594}: as 19 “baterias descarregadas” (módulos legados da biblioteca padrão) restantes foram removidas da biblioteca padrão: @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} e @code{xdrlib}.

@item 
Remove a ferramenta @code{2to3} e o módulo @code{lib2to3} (descontinuados no Python 3.11).

@item 
Remove o módulo @code{tkinter.tix} (descontinuado no Python 3.6).

@item 
Remove a função @code{locale.resetlocale()}.

@item 
Remove os espaços de nomes @code{typing.io} e @code{typing.re}.

@item 
Remove descritores encadeados de @ref{166,,classmethod}.
@end itemize

Mudanças no cronograma de lançamento:

@geindex Propostas de Melhorias do Python; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/} (“Ciclo de Lançamento Anual para Python”) foi atualizado para estender o período de suporte total (“bugfix”) para novos lançamentos para dois anos. Esta política atualizada significa que:


@itemize *

@item 
O Python 3.9–3.12 tem um ano e meio de suporte total, seguido por três anos e meio de correções de segurança.

@item 
Python 3.13 e posteriores têm dois anos de suporte total, seguidos de três anos de correções de segurança.
@end itemize

@node Novas funcionalidades,Outras mudanças na linguagem,Resumo – Destaques da versão,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 new-features}@anchor{167}
@subsection Novas funcionalidades


@menu
* Um melhor interpretador interativo:: 
* Mensagens de erro melhoradas:: 
* CPython com threads livres:: 
* Um compilador just-in-time (JIT) experimental: Um compilador just-in-time JIT experimental. 
* Definidas semânticas de mutação para locals(): Definidas semânticas de mutação para locals. 
* Suporte para plataformas móveis:: 

@end menu

@node Um melhor interpretador interativo,Mensagens de erro melhoradas,,Novas funcionalidades
@anchor{whatsnew/3 13 a-better-interactive-interpreter}@anchor{168}@anchor{whatsnew/3 13 whatsnew313-better-interactive-interpreter}@anchor{13e}
@subsubsection Um melhor interpretador interativo


Python agora usa um novo console @ref{169,,interativo} por padrão, com base no código do projeto PyPy@footnote{https://pypy.org/}. Quando o usuário inicia o @ref{16a,,REPL} de um terminal interativo, agora os seguintes novos recursos estão disponíveis:


@itemize *

@item 
Edição multilinha com preservação do histórico.

@item 
Suporte direto para comandos específicos do REPL, como @code{help}, @code{exit} e @code{quit}, sem a necessidade de chamá-los como funções.

@item 
Prompts e tracebacks com @ref{16b,,cores habilitadas por padrão}.

@item 
Ajuda interativa para navegar usando @code{F1} com um histórico de comandos separado.

@item 
Navegação no histórico usando @code{F2} que ignora a saída, bem como os prompts @ref{16c,,>>>} e @ref{16d,,…}.

@item 
“Modo de colagem” com @code{F3} que facilita colar blocos de código maiores (pressione @code{F3} novamente para retornar ao prompt normal).
@end itemize

Para desabilitar o novo console interativo, defina a variável de ambiente 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL}. Para mais informações sobre o modo interativo, veja @ref{16f,,Modo interativo}.

(Contribuição de Pablo Galindo Salgado, Łukasz Langa e Lysandros Nikolaou em gh-111201@footnote{https://github.com/python/cpython/issues/111201} baseado no código do projeto PyPy. Suporte ao Windows foi uma contribuição de Dino Viehland e Anthony Shaw.)

@node Mensagens de erro melhoradas,CPython com threads livres,Um melhor interpretador interativo,Novas funcionalidades
@anchor{whatsnew/3 13 improved-error-messages}@anchor{170}@anchor{whatsnew/3 13 whatsnew313-improved-error-messages}@anchor{147}
@subsubsection Mensagens de erro melhoradas



@itemize *

@item 
O interpretador agora usa cores por padrão ao exibir tracebacks no terminal. Este recurso @ref{16b,,pode ser controlado} por meio da nova variável de ambiente 
@geindex PYTHON_COLORS
@geindex variável de ambiente; PYTHON_COLORS
@ref{14a,,PYTHON_COLORS}, bem como das variáveis de ambiente canônicas NO_COLOR@footnote{https://no-color.org/} e FORCE_COLOR@footnote{https://force-color.org/}. (Contribuição de Pablo Galindo Salgado em 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 
Um erro comum é escrever um script com o mesmo nome de um módulo de biblioteca padrão. Quando isso resulta em erros, agora exibimos uma mensagem de erro mais útil:

@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

Da mesma forma, se um script tiver o mesmo nome de um módulo de terceiros que ele tentar importar e isso resultar em erros, também exibiremos uma mensagem de erro mais útil:

@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

(Contribuição de Shantanu Jain em gh-95754@footnote{https://github.com/python/cpython/issues/95754}.)

@item 
A mensagem de erro agora tenta sugerir o argumento nomeado correto quando um argumento nomeado incorreto é passado para uma função.

@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

(Contribuição de Pablo Galindo Salgado e Shantanu Jain em gh-107944@footnote{https://github.com/python/cpython/issues/107944}.)
@end itemize

@node CPython com threads livres,Um compilador just-in-time JIT experimental,Mensagens de erro melhoradas,Novas funcionalidades
@anchor{whatsnew/3 13 free-threaded-cpython}@anchor{171}@anchor{whatsnew/3 13 whatsnew313-free-threaded-cpython}@anchor{13f}
@subsubsection CPython com threads livres


O CPython agora tem suporte experimental para execução em modo de threads livres, com a @ref{148,,trava global do interpretador} (GIL) desabilitada. Este é um recurso experimental e, portanto, não é habilitado por padrão. O modo de threads livres requer um executável diferente, geralmente chamado de @code{python3.13t} ou @code{python3.13t.exe}. Binários pré-construídos marcados como `free-threaded' podem ser instalados como parte dos instaladores oficiais @ref{172,,Windows} e @ref{173,,macOS}, ou o CPython pode ser construído a partir da fonte com a opção @ref{174,,--disable-gil}.

A execução de threads livres permite a utilização total do poder de processamento disponível ao executar threads em paralelo nos núcleos de CPU disponíveis. Embora nem todos os softwares se beneficiem disso automaticamente, programas projetados com threading em mente serão executados mais rapidamente em hardware multi-core. `O modo de threads livres é experimental' e o trabalho está em andamento para melhorá-lo: espere alguns bugs e um impacto substancial no desempenho de thread único. As construções com threads livres do CPython oferecem suporte à execução opcional com a GIL habilitada no tempo de execução usando a variável de ambiente 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL} ou a opção de linha de comando @ref{176,,-X gil=1}.

Para verificar se o interpretador atual oferece suporte a threads livres, @ref{177,,python -VV} e @ref{178,,sys.version} contêm “experimental free-threading build”. A nova função @code{sys._is_gil_enabled()} pode ser usada para verificar se a GIL está realmente desabilitada no processo em execução.

Os módulos de extensão da API C precisam ser construídos especificamente para a construção com threads livres. Extensões que oferecem suporte à execução com @ref{159,,GIL} desabilitada devem usar o slot @ref{158,,Py_mod_gil}. Extensões que usam inicialização monofásica devem usar @ref{179,,PyUnstable_Module_SetGIL()} para indicar se oferecem suporte à execução com a GIL desabilitada. A importação de extensões C que não usam esses mecanismos fará com que a GIL seja habilitada, a menos que a GIL tenha sido explicitamente desabilitada com a variável de ambiente 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL} ou a opção @ref{176,,-X gil=0}. pip 24.1 ou mais recentes é necessário para instalar pacotes com extensões C na construção com threads livres.

Este trabalho foi possível graças a muitos indivíduos e organizações, incluindo a grande comunidade de colaboradores do Python e projetos de terceiros para testar e habilitar o suporte para threads livres. Colaboradores notáveis incluem: Sam Gross, Ken Jin, Donghee Na, Itamar Oren, Matt Page, Brett Simmers, Dino Viehland, Carl Meyer, Nathan Goldbaum, Ralf Gommers, Lysandros Nikolaou e muitos outros. Muitos desses colaboradores são empregados pela Meta, que forneceu recursos de engenharia significativos para dar suporte a este projeto.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} “Tornando a trava global do interpretador opcional no CPython” contém justificativa e informações sobre este trabalho.

Portando módulos de extensão para oferecer suporte a threads livres@footnote{https://py-free-threading.github.io/porting/}: um guia de portabilidade mantido pela comunidade para autores de extensões.


@node Um compilador just-in-time JIT experimental,Definidas semânticas de mutação para locals,CPython com threads livres,Novas funcionalidades
@anchor{whatsnew/3 13 an-experimental-just-in-time-jit-compiler}@anchor{17a}@anchor{whatsnew/3 13 whatsnew313-jit-compiler}@anchor{140}
@subsubsection Um compilador just-in-time (JIT) experimental


Quando o CPython é configurado e construído usando a opção @code{--enable-experimental-jit}, um compilador just-in-time (JIT) é adicionado, o que pode acelerar alguns programas Python. No Windows, use @code{PCbuild/build.bat --experimental-jit} para habilitar o JIT ou @code{--experimental-jit-interpreter} para habilitar o interpretador Tier 2. Os requisitos de construção e outras informações de suporte estão contidos em@footnote{https://github.com/python/cpython/blob/main/Tools/jit/README.md} @code{Tools/jit/README.md}.

A opção @code{--enable-experimental-jit} aceita esses valores (opcionais), assumindo como padrão @code{yes} se @code{--enable-experimental-jit} estiver presente sem o valor opcional.


@itemize *

@item 
@code{no}: desativa todo o pipeline de Tier 2 e JIT.

@item 
@code{yes}: habilita o JIT. Para desabilitar o JIT em tempo de execução, passe a variável de ambiente 
@geindex PYTHON_JIT
@geindex variável de ambiente; PYTHON_JIT
@ref{17b,,PYTHON_JIT=0}.

@item 
@code{yes-off}: constrói o JIT, mas desabilita-o por padrão. Para habilitar o JIT em tempo de execução, passe a variável de ambiente 
@geindex PYTHON_JIT
@geindex variável de ambiente; PYTHON_JIT
@ref{17b,,PYTHON_JIT=1}.

@item 
@code{interpreter}: habilita o interpretador Tier 2, mas desabilita o JIT. O interpretador pode ser desabilitado executando com 
@geindex PYTHON_JIT
@geindex variável de ambiente; PYTHON_JIT
@ref{17b,,PYTHON_JIT=0}.
@end itemize

A arquitetura interna é aproximadamente a seguinte:


@itemize *

@item 
Começamos com especializado `bytecode de Tier 1'. Veja @ref{17c,,O que há de novo no 3.11} para detalhes.

@item 
Quando o bytecode Tier 1 fica quente o suficiente, ele é traduzido para uma nova representação intermediária (IR) puramente interna, também chamado de `IR Tier 2', e às vezes chamada de micro-ops (“uops”).

@item 
O IR Tier 2 usa a mesma máquina virtual baseada em pilha que o Tier 1, mas o formato de instrução é mais adequado para tradução em código de máquina.

@item 
Temos vários passes de otimização para IR Tier 2, que são aplicados antes de serem interpretados ou traduzidos em código de máquina.

@item 
Existe um interpretador de Tier 2, mas ele se destina principalmente à depuração dos estágios iniciais do pipeline de otimização. O interpretador Tier 2 pode ser habilitado configurando o Python com @code{--enable-experimental-jit=interpreter}.

@item 
Quando o JIT está habilitado, o IR Tier 2 otimizado é traduzido em código de máquina, que é então executado.

@item 
O processo de tradução de código de máquina usa uma técnica chamada `copiar e corrigir'. Não possui dependências de tempo de execução, mas há uma nova dependência de tempo de construção no LLVM.
@end itemize


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}


(JIT de Brandt Bucher, inspirado em um artigo de Haoran Xu e Fredrik Kjolstad. Tier 2 IR de Mark Shannon e Guido van Rossum. Otimizador Tier 2 de Ken Jin.)

@node Definidas semânticas de mutação para locals,Suporte para plataformas móveis,Um compilador just-in-time JIT experimental,Novas funcionalidades
@anchor{whatsnew/3 13 defined-mutation-semantics-for-locals}@anchor{17d}@anchor{whatsnew/3 13 whatsnew313-locals-semantics}@anchor{142}
@subsubsection Definidas semânticas de mutação para @code{locals()}


Historicamente, o resultado esperado da mutação do valor de retorno de @ref{141,,locals()} foi deixada para as implementações individuais de Python definirem. A partir do Python 3.13, 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} padroniza o comportamento histórico do CPython para a maioria dos escopos de execução de código, mas altera @ref{17e,,escopos otimizados} (funções, geradores, corrotinas, compreensões e expressões geradoras) para retornar explicitamente instantâneos independentes das variáveis locais atualmente atribuídas, incluindo variáveis não locais referenciadas localmente capturadas em encerramentos.

Esta mudança na semântica de @ref{141,,locals()} em escopos otimizados também afeta o comportamento padrão das funções de execução de código que visam implicitamente @code{locals()} se nenhum espaço de nomes explícito for fornecido (como @ref{17f,,exec()} e @ref{180,,eval()}). Nas versões anteriores, se as alterações podiam ou não ser acessadas chamando @code{locals()} após chamar a função de execução de código dependia da implementação. Especificamente no CPython, esse código normalmente parece funcionar conforme desejado, mas às vezes pode falhar em escopos otimizados com base em outro código (incluindo depuradores e ferramentas de rastreamento de execução de código), redefinindo potencialmente o instantâneo compartilhado nesse escopo. Agora, o código sempre será executado em um instantâneo independente das variáveis locais em escopos otimizados e, portanto, as alterações nunca serão visíveis em chamadas subsequentes para @code{locals()}. Para acessar as alterações feitas nesses casos, uma referência explícita de espaço de nomes deve agora ser passada para a função relevante. Alternativamente, pode fazer sentido atualizar o código afetado para usar uma API de execução de código de nível mais alto que retorne o espaço de nomes de execução de código resultante (por exemplo, @ref{181,,runpy.run_path()} ao executar arquivos Python do disco).

Para garantir que depuradores e ferramentas semelhantes possam atualizar de forma confiável variáveis locais em escopos afetados por esta mudança, @ref{182,,FrameType.f_locals} agora retorna um proxy write-through para as variáveis locais e não locais referenciadas localmente do quadro nesses escopos, em vez de retornar uma instância @code{dict} compartilhada atualizada inconsistentemente com semântica de tempo de execução indefinida.

Veja 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} para mais detalhes, incluindo alterações e descontinuações relacionadas à API C. Notas de portabilidade também são fornecidas abaixo para as @ref{183,,APIs de Python} e as @ref{184,,APIs de C} afetadas.

(PEP e implementação são contribuição de Mark Shannon e Tian Gao em gh-74929@footnote{https://github.com/python/cpython/issues/74929}. Atualizações da documentação fornecidas por Guido van Rossum e Alyssa Coghlan.)

@node Suporte para plataformas móveis,,Definidas semânticas de mutação para locals,Novas funcionalidades
@anchor{whatsnew/3 13 support-for-mobile-platforms}@anchor{185}@anchor{whatsnew/3 13 whatsnew313-platform-support}@anchor{165}
@subsubsection Suporte para plataformas móveis


@geindex Propostas de Melhorias do Python; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: iOS agora é uma plataforma com suporte conforme a 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, com os alvos @code{arm64-apple-ios} e @code{arm64-apple-ios-simulator} no nível 3 (dispositivos iPhone e iPad lançados após 2013 e o simulador Xcode iOS sendo executado em hardware Apple Silicon, respectivamente). @code{x86_64-apple-ios-simulator} (o simulador Xcode iOS sendo executado em hardware @code{x86_64} mais antigo) não é uma plataforma com suporte nível 3, mas terá o melhor suporte possível. (PEP escrita e implementação como contribuição de Russell Keith-Magee em gh-114099@footnote{https://github.com/python/cpython/issues/114099}.)

@geindex Propostas de Melhorias do Python; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: Android agora é uma plataforma com suporte conforme a 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, com os alvos @code{aarch64-linux-android} e @code{x86_64-linux-android} no nível 3. Os alvos de 32 bits @code{arm-linux-androideabi} e @code{i686-linux-android} não são plataformas com suporte de nível 3, mas terão o melhor suporte possível. (PEP escrita e implementação como contribuição de Malcolm Smith em gh-116622@footnote{https://github.com/python/cpython/issues/116622}.)


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}, 
@geindex Propostas de Melhorias do Python; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}


@node Outras mudanças na linguagem,Novos módulos,Novas funcionalidades,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 other-language-changes}@anchor{186}
@subsection Outras mudanças na linguagem



@itemize *

@item 
O compilador agora remove espaços em branco comuns de cada linha em uma docstring. Isso reduz o tamanho do @ref{187,,cache de bytecode} (como arquivos @code{.pyc}), com reduções no tamanho do arquivo de cerca de 5%, por exemplo, em @code{sqlalchemy.orm.session} do SQLAlchemy 2.0. Essa alteração afeta ferramentas que usam docstrings, como @ref{3a,,doctest}.

@example
>>> def spam():
...     """
...         Esta é uma docstring com
...           espaços em branco no começo.
...
...         Ela atém mesmo tem vários parágrafos!
...     """
...
>>> spam.__doc__
'\n\nEsta é uma docstring com\n\n espaços em branco no começo.\n\n\nEla atém mesmo tem vários parágrafos!\n\n'
@end example

(Contribuição de Inada Naoki em gh-81283@footnote{https://github.com/python/cpython/issues/81283}.)

@item 
@ref{188,,Escopos de anotação} dentro dos escopos de classe agora pode conter lambdas e compreensões. As compreensões localizadas nos escopos de classe não são incorporadas ao escopo pai.

@example
class C[T]:
    type Alias = lambda: T
@end example

(Contribuição de Jelle Zijlstra em gh-109118@footnote{https://github.com/python/cpython/issues/109118} e gh-118160@footnote{https://github.com/python/cpython/issues/118160}.)

@item 
@ref{189,,Instruções future} não são mais acionadas por importações relativas do módulo @ref{0,,__future__}, o que significa que instruções no formato @code{from .__future__ import ...} agora são simplesmente importações relativas padrão, sem recursos especiais ativados. (Contribuição de Jeremiah Gabriel Pascual em gh-118216@footnote{https://github.com/python/cpython/issues/118216}.)

@item 
Declarações @ref{18a,,global} agora são permitidas em blocos @ref{18b,,except} quando esse global é usado no bloco @ref{18c,,else}. Anteriormente, isso erroneamente levantava uma exceção @ref{18d,,SyntaxError}. (Contribuição de Irit Katriel em gh-111123@footnote{https://github.com/python/cpython/issues/111123}.)

@item 
Adiciona 
@geindex PYTHON_FROZEN_MODULES
@geindex variável de ambiente; PYTHON_FROZEN_MODULES
@ref{18e,,PYTHON_FROZEN_MODULES}, uma nova variável de ambiente que determina se os módulos congelados são ignorados pelo maquinário de importação, equivalente à opção de linha de comando @ref{176,,-X frozen_modules}. (Contribuição de Yilei Yang em gh-111374@footnote{https://github.com/python/cpython/issues/111374}.)

@item 
Adicionado @ref{18f,,suporte ao perfilador perf} funcionando sem ponteiros de quadro@footnote{https://pt.wikipedia.org/wiki/Pilha_de_chamada} através da nova variável de ambiente 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@ref{190,,PYTHON_PERF_JIT_SUPPORT} e opção de linha de comando @ref{176,,-X perf_jit}. (Contribuição de Pablo Galindo em gh-118518@footnote{https://github.com/python/cpython/issues/118518}.)

@item 
A localização de um arquivo @code{.python_history} pode ser alterada por meio da nova variável de ambiente 
@geindex PYTHON_HISTORY
@geindex variável de ambiente; PYTHON_HISTORY
@ref{191,,PYTHON_HISTORY}. (Contribuição de Levi Sabah, Zackery Spytz e Hugo van Kemenade em gh-73965@footnote{https://github.com/python/cpython/issues/73965}.)

@item 
As classes têm um novo atributo @ref{14b,,__static_attributes__}. Isso é preenchido pelo compilador, com uma tupla de nomes de atributos da classe que são atribuídos através de @code{self.<name>} de qualquer função em seu corpo. (Contribuição de Irit Katriel em gh-115775@footnote{https://github.com/python/cpython/issues/115775}.)

@item 
O compilador agora cria um atributo @code{__firstlineno__} em classes com o número da primeira linha da definição de classe. (Contribuição de Serhiy Storchaka em gh-118465@footnote{https://github.com/python/cpython/issues/118465}.)

@item 
As funções embutidas @ref{17f,,exec()} e @ref{180,,eval()} agora aceitam os argumentos `globals' e `locals' como nomeados. (Contribuição de Raphael Gaschignard em gh-105879@footnote{https://github.com/python/cpython/issues/105879})

@item 
A função embutida @ref{192,,compile()} agora aceita um novo sinalizador, @code{ast.PyCF_OPTIMIZED_AST}, que é semelhante a @code{ast.PyCF_ONLY_AST} exceto que a AST retornada é otimizada de acordo com o valor do argumento `optimize'. (Contribuição de Irit Katriel em gh-108113@footnote{https://github.com/python/cpython/issues/108113}).

@item 
Adiciona um atributo @ref{193,,__name__} em objetos @ref{194,,property}. (Contribuição de Eugene Toder em gh-101860@footnote{https://github.com/python/cpython/issues/101860}.)

@item 
Adiciona @ref{14d,,PythonFinalizationError}, uma nova exceção derivada de @ref{195,,RuntimeError} e usada para sinalizar quando as operações são bloqueadas durante a @ref{14e,,finalização}. Os seguintes chamáveis agora levantam @code{PythonFinalizationError}, em vez de @ref{195,,RuntimeError}:


@itemize *

@item 
@ref{196,,_thread.start_new_thread()}

@item 
@ref{197,,os.fork()}

@item 
@ref{198,,os.forkpty()}

@item 
@ref{199,,subprocess.Popen}
@end itemize

(Contribuição de Victor Stinner em gh-114570@footnote{https://github.com/python/cpython/issues/114570}.)

@item 
Permite que o argumento `count' de @ref{19a,,str.replace()} seja um argumento nomeado. (Contribuição de Hugo van Kemenade em gh-106487@footnote{https://github.com/python/cpython/issues/106487}.)

@item 
Muitas funções agora emitem um aviso se um valor booleano for passado como argumento do descritor de arquivo. Isso pode ajudar a detectar alguns erros mais cedo. (Contribuição de Serhiy Storchaka em gh-82626@footnote{https://github.com/python/cpython/issues/82626}.)

@item 
Adicionados atributos @code{name} e @code{mode} para objetos arquivo ou similares compactados e arquivados nos módulos @ref{13,,bz2}, @ref{8a,,lzma}, @ref{de,,tarfile} e @ref{131,,zipfile}. (Contribuição de Serhiy Storchaka em gh-115961@footnote{https://github.com/python/cpython/issues/115961}.)
@end itemize

@node Novos módulos,Módulos melhorados,Outras mudanças na linguagem,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 new-modules}@anchor{19b}
@subsection Novos módulos



@itemize *

@item 
@ref{35,,dbm.sqlite3}: um backend SQLite para @ref{31,,dbm}. (Contribuição de Raymond Hettinger e Erlend E. Aasland em gh-100414@footnote{https://github.com/python/cpython/issues/100414}.)
@end itemize

@node Módulos melhorados,Otimizações,Novos módulos,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 improved-modules}@anchor{19c}
@subsection Módulos melhorados


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

@end menu

@node argparse,array,,Módulos melhorados
@anchor{whatsnew/3 13 argparse}@anchor{19d}
@subsubsection argparse



@itemize *

@item 
Adiciona o parâmetro `deprecated' aos métodos @ref{19e,,add_argument()} e @code{add_parser()}, o qual permite descontinuar opções de linha de comando, argumentos posicionais e subcomandos. (Contribuição de Serhiy Storchaka em gh-83648@footnote{https://github.com/python/cpython/issues/83648}.)
@end itemize

@node array,ast,argparse,Módulos melhorados
@anchor{whatsnew/3 13 array}@anchor{19f}
@subsubsection array



@itemize *

@item 
Adiciona o código do tipo @code{'w'} (@code{Py_UCS4}) para caracteres Unicode. Ele deve ser usado no lugar do código do tipo @code{'u'} descontinuado. (Contribuição de Inada Naoki em gh-80480@footnote{https://github.com/python/cpython/issues/80480}.)

@item 
Registra @ref{1a0,,array.array} como @ref{1a1,,MutableSequence} implementando o método @ref{1a2,,clear()}. (Contribuição de Mike Zimin em gh-114894@footnote{https://github.com/python/cpython/issues/114894}.)
@end itemize

@node ast,asyncio,array,Módulos melhorados
@anchor{whatsnew/3 13 ast}@anchor{1a3}
@subsubsection ast



@itemize *

@item 
Os construtores dos tipos de nós no módulo @ref{8,,ast} agora são mais rígidos nos argumentos que aceitam, com um comportamento mais intuitivo quando os argumentos são omitidos.

Se um campo opcional em um nó da AST não for incluído como argumento ao construir uma instância, o campo agora será definido como @code{None}. Da mesma forma, se um campo de lista for omitido, esse campo será agora definido como uma lista vazia, e se um campo @code{expr_context} for omitido, o padrão será @ref{1a4,,Load()}. (Anteriormente, em todos os casos, o atributo estaria ausente na instância do nó da AST recém-construída.)

Em todos os outros casos, nos quais um argumento é omitido, o construtor de nós vai emitir uma @ref{1a5,,DeprecationWarning}. Isso vai levantar uma exceção no Python 3.15. Da mesma forma, passar um argumento nomeado para o construtor que não mapeia para um campo no nó da AST agora está descontinuado e vai levantar uma exceção no Python 3.15.

Estas mudanças não se aplicam às subclasses de @ref{1a6,,ast.AST} definidas pelo usuário, a menos que a classe opte pelo novo comportamento definindo o mapeamento @ref{1a7,,AST._field_types}.

(Contribuição de Jelle Zijlstra em gh-105858@footnote{https://github.com/python/cpython/issues/105858}, gh-117486@footnote{https://github.com/python/cpython/issues/117486} e gh-118851@footnote{https://github.com/python/cpython/issues/118851}.)

@item 
@ref{1a8,,ast.parse()} agora aceita um argumento opcional `optimize' que é passado para @ref{192,,compile()}. Isto torna possível obter uma AST otimizada. (Contribuição de Irit Katriel em gh-108113@footnote{https://github.com/python/cpython/issues/108113}.)
@end itemize

@node asyncio,base64,ast,Módulos melhorados
@anchor{whatsnew/3 13 asyncio}@anchor{1a9}
@subsubsection asyncio



@itemize *

@item 
@ref{1aa,,asyncio.as_completed()} agora retorna um objeto que é ao mesmo tempo um @ref{1ab,,iterador assíncrono} e um @ref{1ac,,iterator} simples de @ref{1ad,,aguardáveis}. Os aguardáveis gerados pela iteração assíncrona incluem tarefas originais ou objetos futuros que foram passados, facilitando a associação dos resultados às tarefas que estão sendo concluídas. (Contribuição de Justin Arthur em gh-77714@footnote{https://github.com/python/cpython/issues/77714}.)

@item 
@ref{1ae,,asyncio.loop.create_unix_server()} agora removerá automaticamente o soquete Unix quando o servidor for fechado. (Contribuição de Pierre Ossman em gh-111246@footnote{https://github.com/python/cpython/issues/111246}.)

@item 
@ref{1af,,DatagramTransport.sendto()} agora enviará datagramas de comprimento zero se for chamado com um objeto de bytes vazios. O controle de fluxo de transporte agora também leva em conta o cabeçalho do datagrama ao calcular o tamanho do buffer. (Contribuição de Jamie Phan em gh-115199@footnote{https://github.com/python/cpython/issues/115199}.)

@item 
Adiciona @ref{1b0,,Queue.shutdown} e @ref{1b1,,QueueShutDown} para gerenciar a terminação da fila. (Contribuição de Laurie Opperman e Yves Duprat em gh-104228@footnote{https://github.com/python/cpython/issues/104228}.)

@item 
Adiciona os métodos @ref{1b2,,Server.close_clients()} e @ref{1b3,,Server.abort_clients()}, que fecham de forma mais forçada um servidor asyncio. (Contribuição de Pierre Ossman em gh-113538@footnote{https://github.com/python/cpython/issues/113538}.)

@item 
Aceita uma tupla de separadores em @ref{1b4,,StreamReader.readuntil()}, parando quando qualquer um deles for encontrado. (Contribuição de Bruce Merry em gh-81322@footnote{https://github.com/python/cpython/issues/81322}.)

@item 
Melhora o comportamento de @ref{1b5,,TaskGroup} quando um cancelamento externo colide com um cancelamento interno. Por exemplo, quando dois grupos de tarefas estão aninhados e ambos experimentam uma exceção em uma tarefa filho simultaneamente, é possível que o grupo de tarefas externo seja interrompido, porque seu cancelamento interno foi engolido pelo grupo de tarefas interno.

No caso em que um grupo de tarefas é cancelado externamente e também deve levantar @ref{1b6,,ExceptionGroup}, ele agora chamará o método @ref{1b7,,cancel()} da tarefa pai. Isso garante que uma @ref{1b8,,CancelledError} será levantada no próximo @ref{1b9,,await}, para que o cancelamento não seja perdido.

Um benefício adicional dessas mudanças é que os grupos de tarefas agora preservam a contagem de cancelamentos (@ref{1ba,,cancelling()}).

Para lidar com alguns casos extremos, @ref{1bb,,uncancel()} agora pode redefinir o sinalizador não documentado @code{_must_cancel} quando a contagem de cancelamentos chegar a zero.

(Inspirado por um relatório de problema enviado por Arthur Tacca em gh-116720@footnote{https://github.com/python/cpython/issues/116720}.)

@item 
Quando @ref{1bc,,TaskGroup.create_task()} é chamado em um @ref{1b5,,TaskGroup} inativo, a corrotina fornecida será fechada (o que evita um @ref{1bd,,RuntimeWarning} sobre uma corrotina que nunca foi aguardada). (Contribuição de Arthur Tacca e Jason Zhang em gh-115957@footnote{https://github.com/python/cpython/issues/115957}.)

@item 
A função e os métodos @code{create_task} receberam um novo argumento @code{**kwargs} que é passado para o construtor da tarefa. Essa alteração foi adicionada acidentalmente na versão 3.13.3 e quebrou o contrato da API para fábricas de tarefas personalizadas. Várias fábricas de tarefas de terceiros implementaram soluções alternativas para isso. Na versão 3.13.4 e versões posteriores, o antigo contrato de fábrica é mantido novamente (até a versão 3.14). Para manter as soluções alternativas funcionando, o argumento extra @code{**kwargs} ainda permite a passagem de argumentos nomeados adicionais para @ref{1be,,Task} e para fábricas de tarefas personalizadas.

Isso afeta as seguintes funções e métodos: @ref{1bf,,asyncio.create_task()}, @ref{1c0,,asyncio.loop.create_task()}, @ref{1bc,,asyncio.TaskGroup.create_task()}. (Contribuição de Thomas Grainger em gh-128307@footnote{https://github.com/python/cpython/issues/128307}.)
@end itemize

@node base64,compileall,asyncio,Módulos melhorados
@anchor{whatsnew/3 13 base64}@anchor{1c1}
@subsubsection base64



@itemize *

@item 
Adiciona as funções @ref{14f,,z85encode()} e @ref{150,,z85decode()} para codificar @ref{1c2,,bytes} como dados Z85@footnote{https://rfc.zeromq.org/spec/32/} e decodificar dados codificados em Z85 para @code{bytes}. (Contribuição de Matan Perelman em gh-75299@footnote{https://github.com/python/cpython/issues/75299}.)
@end itemize

@node compileall,concurrent futures,base64,Módulos melhorados
@anchor{whatsnew/3 13 compileall}@anchor{1c3}
@subsubsection compileall



@itemize *

@item 
O número padrão de threads e processos de trabalho é agora selecionado usando @ref{1c4,,os.process_cpu_count()} em vez de @ref{1c5,,os.cpu_count()}. (Contribuição de Victor Stinner em gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node concurrent futures,configparser,compileall,Módulos melhorados
@anchor{whatsnew/3 13 concurrent-futures}@anchor{1c6}
@subsubsection concurrent.futures



@itemize *

@item 
O número padrão de threads e processos de trabalho é agora selecionado usando @ref{1c4,,os.process_cpu_count()} em vez de @ref{1c5,,os.cpu_count()}. (Contribuição de Victor Stinner em gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node configparser,copy,concurrent futures,Módulos melhorados
@anchor{whatsnew/3 13 configparser}@anchor{1c7}
@subsubsection configparser



@itemize *

@item 
@ref{1c8,,ConfigParser} agora tem suporte para seções sem nome, o que permite pares de chave-valor de nível superior. Isso pode ser habilitado com o novo parâmetro `allow_unnamed_section'. (Contribuição de Pedro Sousa Lacerda em gh-66449@footnote{https://github.com/python/cpython/issues/66449}.)
@end itemize

@node copy,ctypes,configparser,Módulos melhorados
@anchor{whatsnew/3 13 copy}@anchor{1c9}
@subsubsection copy



@itemize *

@item 
A nova função @ref{151,,replace()} e o protocolo @ref{152,,replace} tornam a criação de cópias modificadas de objetos muito mais simples. Isso é especialmente útil ao trabalhar com objetos imutáveis. Os seguintes tipos dão suporte à função @ref{151,,replace()} e implementam o protocolo replace:


@itemize *

@item 
@ref{1ca,,collections.namedtuple()}

@item 
@ref{1cb,,dataclasses.dataclass}

@item 
@ref{1cc,,datetime.datetime}, @ref{1cd,,datetime.date}, @ref{1ce,,datetime.time}

@item 
@ref{1cf,,inspect.Signature}, @ref{1d0,,inspect.Parameter}

@item 
@ref{1d1,,types.SimpleNamespace}

@item 
@ref{1d2,,objetos código}
@end itemize

Qualquer classe definida pelo usuário também pode ter suporte a @ref{151,,copy.replace()} definindo o método @ref{152,,__replace__()}. (Contribuição de Serhiy Storchaka em gh-108751@footnote{https://github.com/python/cpython/issues/108751}.)
@end itemize

@node ctypes,dbm,copy,Módulos melhorados
@anchor{whatsnew/3 13 ctypes}@anchor{1d3}
@subsubsection ctypes



@itemize *

@item 
Como consequência da refatoração interna necessária, a inicialização de metaclasses internas agora acontece em @code{__init__} em vez de @code{__new__}. Isso afeta projetos que fazem subclasse dessas metaclasses internas para fornecer inicialização personalizada. De forma geral:


@itemize -

@item 
A lógica personalizada que foi feita em @code{__new__} após chamar @code{super().__new__} deve ser movida para @code{__init__}.

@item 
Para criar uma classe, chame a metaclasse, não apenas o método @code{__new__} da metaclasse.
@end itemize

Veja gh-124520@footnote{https://github.com/python/cpython/issues/124520} para discussão e links para mudanças em alguns projetos afetados.

@item 
Os objetos @ref{1d4,,ctypes.Structure} têm um novo atributo @ref{1d5,,_align_} que permite que o alinhamento da estrutura que está sendo empacotada para/da memória seja especificado explicitamente. (Contribuição de Matt Sanderson em gh-112433@footnote{https://github.com/python/cpython/issues/112433})
@end itemize

@node dbm,dis,ctypes,Módulos melhorados
@anchor{whatsnew/3 13 dbm}@anchor{1d6}
@subsubsection dbm



@itemize *

@item 
Adiciona @ref{35,,dbm.sqlite3}, um novo módulo que implementa um backend SQLite, e torna-o o backend padrão @code{dbm}. (Contribuição de Raymond Hettinger e Erlend E. Aasland em gh-100414@footnote{https://github.com/python/cpython/issues/100414}.)

@item 
Permite a remoção de todos os itens do banco de dados por meio dos novos métodos @code{clear()} dos objetos de banco de dados GDBM e NDBM. (Contribuição de Donghee Na em gh-107122@footnote{https://github.com/python/cpython/issues/107122}.)
@end itemize

@node dis,doctest,dbm,Módulos melhorados
@anchor{whatsnew/3 13 dis}@anchor{1d7}
@subsubsection dis



@itemize *

@item 
Altera a saída das funções do módulo @ref{38,,dis} para mostrar rótulos lógicos para alvos de salto e manipuladores de exceção, em vez de deslocamentos. Os deslocamentos podem ser adicionados com a nova opção de linha de comando @ref{1d8,,-O} ou o argumento `show_offsets'. (Contribuição de Irit Katriel em gh-112137@footnote{https://github.com/python/cpython/issues/112137}.)

@item 
@ref{1d9,,get_instructions()} não representa mais entradas de cache como instruções separadas. Em vez disso, ele os retorna como parte de @ref{1da,,Instruction}, no novo campo `cache_info'. O argumento `show_caches' para @ref{1d9,,get_instructions()} foi descontinuado e não tem mais nenhum efeito. (Contribuição de Irit Katriel em gh-112962@footnote{https://github.com/python/cpython/issues/112962}.)
@end itemize

@node doctest,email,dis,Módulos melhorados
@anchor{whatsnew/3 13 doctest}@anchor{1db}@anchor{whatsnew/3 13 whatsnew313-doctest}@anchor{149}
@subsubsection doctest



@itemize *

@item 
A saída do @ref{3a,,doctest} é agora colorida por padrão. Isso pode ser controlado através da nova variável de ambiente 
@geindex PYTHON_COLORS
@geindex variável de ambiente; PYTHON_COLORS
@ref{14a,,PYTHON_COLORS}, bem como das variáveis de ambiente canônicas NO_COLOR@footnote{https://no-color.org/} e FORCE_COLOR@footnote{https://force-color.org/}. Veja também @ref{16b,,Controlando cores}. (Contribuição de Hugo van Kemenade em gh-117225@footnote{https://github.com/python/cpython/issues/117225}.)

@item 
O método @ref{1dc,,DocTestRunner.run()} agora conta o número de testes ignorados. Adiciona os atributos @ref{1dd,,DocTestRunner.skips} e @ref{1de,,TestResults.skipped}. (Contribuição de Victor Stinner em gh-108794@footnote{https://github.com/python/cpython/issues/108794}.)
@end itemize

@node email,enum,doctest,Módulos melhorados
@anchor{whatsnew/3 13 email}@anchor{1df}
@subsubsection email



@itemize *

@item 
Cabeçalhos com novas linhas embutidas são agora colocadas entre aspas na saída. O @ref{40,,generator} agora se recusará a serializar (escrever) cabeçalhos que estão dobrados ou delimitados incorretamente, de modo que eles seriam analisados como vários cabeçalhos ou unidos a dados adjacentes. Se você precisar desativar esse recurso de segurança, defina @ref{1e0,,verify_generated_headers}. (Contribuição de Bas Bloemsaat e Petr Viktorin em gh-121650@footnote{https://github.com/python/cpython/issues/121650}.)

@item 
@ref{1e1,,getaddresses()} e @ref{1e2,,parseaddr()} agora retornam pares @code{('@w{'}, '@w{'})} em mais situações onde endereços de e-mail inválidos são encontrados em vez de valores potencialmente imprecisos. As duas funções têm agora um novo parâmetro opcional `strict' (padrão @code{True}). Para obter o comportamento antigo (aceitar entrada malformada), @code{strict=False}. @code{getattr(email.utils, 'supports_strict_parsing', False)} pode ser usado para verificar se o parâmetro `strict' está disponível. (Contribuição de Thomas Dwyer e Victor Stinner para gh-102988@footnote{https://github.com/python/cpython/issues/102988} para melhorar a correção 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043}.)
@end itemize

@node enum,fractions,email,Módulos melhorados
@anchor{whatsnew/3 13 enum}@anchor{1e3}
@subsubsection enum



@itemize *

@item 
@ref{1e4,,EnumDict} foi tornada pública para melhor suporte às subclasses de @ref{1e5,,EnumType}.
@end itemize

@node fractions,glob,enum,Módulos melhorados
@anchor{whatsnew/3 13 fractions}@anchor{1e6}
@subsubsection fractions



@itemize *

@item 
Os objetos @ref{1e7,,Fraction} agora oferecem suporte às regras padrões da @ref{1e8,,minilinguagem de especificação de formato} para preenchimento, alinhamento, manipulação de sinais, largura mínima e agrupamento. (Contribuição de Mark Dickinson em gh-111320@footnote{https://github.com/python/cpython/issues/111320}.)
@end itemize

@node glob,importlib,fractions,Módulos melhorados
@anchor{whatsnew/3 13 glob}@anchor{1e9}
@subsubsection glob



@itemize *

@item 
Adiciona @ref{1ea,,translate()}, uma função que converte uma especificação de caminho com curingas estilo shell em uma expressão regular. (Contribuição de Barney Gale em gh-72904@footnote{https://github.com/python/cpython/issues/72904}.)
@end itemize

@node importlib,io,glob,Módulos melhorados
@anchor{whatsnew/3 13 importlib}@anchor{1eb}
@subsubsection importlib



@itemize *

@item 
As seguintes funções em @ref{7b,,importlib.resources} agora permitem acessar um diretório (ou árvore) de recursos, usando múltiplos argumentos posicionais (os argumentos `encoding' e `errors' nas funções de leitura de texto agora são somente-nomeados):


@itemize *

@item 
@ref{1ec,,is_resource()}

@item 
@ref{1ed,,open_binary()}

@item 
@ref{1ee,,open_text()}

@item 
@ref{1ef,,path()}

@item 
@ref{1f0,,read_binary()}

@item 
@ref{1f1,,read_text()}
@end itemize

Essas funções não estão mais descontinuadas e não estão programadas para remoção. (Contribuição de Petr Viktorin em gh-116608@footnote{https://github.com/python/cpython/issues/116608}.)

@item 
A função @ref{1f2,,contents()} permanece descontinuada em favor da API completa @ref{1f3,,Traversable}. No entanto, agora não há planos para removê-la. (Contribuição de Petr Viktorin em gh-116608@footnote{https://github.com/python/cpython/issues/116608}.)
@end itemize

@node io,ipaddress,importlib,Módulos melhorados
@anchor{whatsnew/3 13 io}@anchor{1f4}
@subsubsection io



@itemize *

@item 
O finalizador @ref{1f5,,IOBase} agora registra quaisquer erros levantados pelo método @ref{1f6,,close()} com @ref{1f7,,sys.unraisablehook}. Anteriormente, os erros eram ignorados silenciosamente por padrão e registrados apenas em @ref{1f8,,Modo de Desenvolvimento do Python} ou ao usar uma @ref{1f9,,construção de depuração do Python}. (Contribuição de Victor Stinner em gh-62948@footnote{https://github.com/python/cpython/issues/62948}.)
@end itemize

@node ipaddress,itertools,io,Módulos melhorados
@anchor{whatsnew/3 13 ipaddress}@anchor{1fa}
@subsubsection ipaddress



@itemize *

@item 
Adiciona a propriedade @ref{1fb,,IPv4Address.ipv6_mapped}, que retorna o endereço IPv6 mapeado para IPv4. (Contribuição de Charles Machalow em gh-109466@footnote{https://github.com/python/cpython/issues/109466}.)

@item 
Corrige os comportamentos de @code{is_global} e @code{is_private} em @ref{1fc,,IPv4Address}, @ref{1fd,,IPv6Address}, @ref{1fe,,IPv4Network} e @ref{1ff,,IPv6Network}. (Contribuição de Jakub Stasiak em gh-113171@footnote{https://github.com/python/cpython/issues/113171}.)
@end itemize

@node itertools,marshal,ipaddress,Módulos melhorados
@anchor{whatsnew/3 13 itertools}@anchor{200}
@subsubsection itertools



@itemize *

@item 
@ref{201,,batched()} tem um novo parâmetro `strict', que levanta uma @ref{202,,ValueError} se o lote final for menor que o tamanho do lote especificado. (Contribuição de Raymond Hettinger em gh-113202@footnote{https://github.com/python/cpython/issues/113202}.)
@end itemize

@node marshal,math,itertools,Módulos melhorados
@anchor{whatsnew/3 13 marshal}@anchor{203}
@subsubsection marshal



@itemize *

@item 
Adiciona o parâmetro `allow_code' nas funções do módulo. Passar @code{allow_code=False} evita a serialização e desserialização de objetos de código que são incompatíveis entre versões do Python. (Contribuição de Serhiy Storchaka em gh-113626@footnote{https://github.com/python/cpython/issues/113626}.)
@end itemize

@node math,mimetypes,marshal,Módulos melhorados
@anchor{whatsnew/3 13 math}@anchor{204}
@subsubsection math



@itemize *

@item 
A nova função @ref{205,,fma()} realiza operações fundidas de multiplicação e adição. Ela calcula @code{x * y + z} com apenas uma única rodada e, portanto, evita qualquer perda intermediária de precisão. Ele envolve a função @code{fma()} fornecida pelo C99 e segue a especificação da operação IEEE 754 “fusedMultiplyAdd” para casos especiais. (Contribuição de Mark Dickinson e Victor Stinner em gh-73468@footnote{https://github.com/python/cpython/issues/73468}.)
@end itemize

@node mimetypes,mmap,math,Módulos melhorados
@anchor{whatsnew/3 13 mimetypes}@anchor{206}
@subsubsection mimetypes



@itemize *

@item 
Adiciona a função @ref{207,,guess_file_type()} para adivinhar um tipo MIME de um caminho do sistema de arquivos. Usar caminhos com @ref{208,,guess_type()} agora está @ref{209,,suavemente descontinuada}. (Contribuição de Serhiy Storchaka em gh-66543@footnote{https://github.com/python/cpython/issues/66543}.)
@end itemize

@node mmap,multiprocessing,mimetypes,Módulos melhorados
@anchor{whatsnew/3 13 mmap}@anchor{20a}
@subsubsection mmap



@itemize *

@item 
@ref{20b,,mmap} agora está protegida contra travamentos no Windows quando a memória mapeada está inacessível devido a erros no sistema de arquivos ou violações de acesso. (Contribuição de Jannis Weigend em gh-118209@footnote{https://github.com/python/cpython/issues/118209}.)

@item 
@ref{20b,,mmap} tem um novo método @ref{20c,,seekable()} que pode ser usado quando um objeto arquivo ou similar pesquisável é necessário. O método @ref{20d,,seek()} agora retorna a nova posição absoluta. (Contribuição de Donghee Na e Sylvie Liberman em gh-111835@footnote{https://github.com/python/cpython/issues/111835}.)

@item 
O novo parâmetro `trackfd' somente para UNIX para @ref{20b,,mmap} controla a duplicação do descritor de arquivo; se falso, o descritor de arquivo especificado por `fileno' não será duplicado. (Contribuição de Zackery Spytz e Petr Viktorin em gh-78502@footnote{https://github.com/python/cpython/issues/78502}.)
@end itemize

@node multiprocessing,os,mmap,Módulos melhorados
@anchor{whatsnew/3 13 multiprocessing}@anchor{20e}
@subsubsection multiprocessing



@itemize *

@item 
O número padrão de threads e processos de trabalho é agora selecionado usando @ref{1c4,,os.process_cpu_count()} em vez de @ref{1c5,,os.cpu_count()}. (Contribuição de Victor Stinner em gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)
@end itemize

@node os,os path,multiprocessing,Módulos melhorados
@anchor{whatsnew/3 13 os}@anchor{20f}
@subsubsection os



@itemize *

@item 
Adiciona a função @ref{1c4,,process_cpu_count()} para obter o número de núcleos lógicos de CPU utilizáveis pela thread de chamada do processo atual. (Contribuição de Victor Stinner em gh-109649@footnote{https://github.com/python/cpython/issues/109649}.)

@item 
@ref{1c5,,cpu_count()} e @ref{1c4,,process_cpu_count()} podem ser substituídos através da nova variável de ambiente 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT} ou da nova opção de linha de comando @ref{176,,-X cpu_count}. Esta opção é útil para usuários que precisam limitar os recursos da CPU de um sistema contêiner sem precisar modificar código da aplicação ou o contêiner em si. (Contribuição de Donghee Na em gh-109595@footnote{https://github.com/python/cpython/issues/109595}.)

@item 
Adiciona uma @ref{153,,interface de baixo nível} aos @code{descritores de arquivo de temporizador@footnote{https://manpages.debian.org/timerfd_create(2)}} do Linux via @ref{211,,timerfd_create()}, @ref{212,,timerfd_settime()}, @ref{213,,timerfd_settime_ns()}, @ref{214,,timerfd_gettime()}, @ref{215,,timerfd_gettime_ns()}, @ref{216,,TFD_NONBLOCK}, @ref{217,,TFD_CLOEXEC}, @ref{218,,TFD_TIMER_ABSTIME} e @ref{219,,TFD_TIMER_CANCEL_ON_SET} (Contribuição de Masaru Tsuchiyama em gh-108277@footnote{https://github.com/python/cpython/issues/108277}.)

@item 
@ref{21a,,lchmod()} e o argumento `follow_symlinks' em @ref{21b,,chmod()} estão agora disponíveis no Windows. Observe que o valor padrão de `follow_symlinks' em @code{lchmod()} é @code{False} no Windows. (Contribuição de Serhiy Storchaka em gh-59616@footnote{https://github.com/python/cpython/issues/59616}.)

@item 
@ref{21c,,fchmod()} e suporte para descritores de arquivo em @ref{21b,,chmod()} estão agora disponíveis no Windows. (Contribuição de Serhiy Storchaka em gh-113191@footnote{https://github.com/python/cpython/issues/113191}.)

@item 
No Windows, @ref{21d,,mkdir()} e @ref{21e,,makedirs()} agora oferecem suporte a passar um valor `mode' de @code{0o700} para aplicar controle de acesso ao novo diretório. Isso afeta implicitamente @ref{21f,,tempfile.mkdtemp()} e é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}. Outros valores para `mode' continuam a ser ignorados. (Contribuição de Steve Dower em gh-118486@footnote{https://github.com/python/cpython/issues/118486}.)

@item 
@ref{220,,posix_spawn()} agora aceita @code{None} para o argumento `env', o que faz com que o processo recém-gerado use o ambiente de processo atual. (Contribuição de Jakub Kulik em gh-113119@footnote{https://github.com/python/cpython/issues/113119}.)

@item 
@ref{220,,posix_spawn()} agora pode usar o atributo @ref{221,,POSIX_SPAWN_CLOSEFROM} no parâmetro `file_actions' em plataformas que oferecem suporte a @code{posix_spawn_file_actions_addclosefrom_np()}. (Contribuição de Jakub Kulik em gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node os path,pathlib,os,Módulos melhorados
@anchor{whatsnew/3 13 os-path}@anchor{222}
@subsubsection os.path



@itemize *

@item 
Adiciona @ref{223,,isreserved()} para verificar se um caminho está reservado no sistema atual. Esta função está disponível apenas no Windows. (Contribuição de Barney Gale em gh-88569@footnote{https://github.com/python/cpython/issues/88569}.)

@item 
No Windows, @ref{224,,isabs()} não considera mais caminhos que começam com exatamente uma barra (@code{\} ou @code{/}) como absolutos. (Contribuição de Barney Gale e Jon Foster em gh-44626@footnote{https://github.com/python/cpython/issues/44626}.)

@item 
@ref{225,,realpath()} agora resolve nomes de arquivos no estilo MS-DOS, mesmo que o arquivo não esteja acessível. (Contribuição de Moonsik Park em gh-82367@footnote{https://github.com/python/cpython/issues/82367}.)
@end itemize

@node pathlib,pdb,os path,Módulos melhorados
@anchor{whatsnew/3 13 pathlib}@anchor{226}
@subsubsection pathlib



@itemize *

@item 
Adiciona @ref{227,,UnsupportedOperation}, que é levantada em vez de @ref{228,,NotImplementedError} quando uma operação de caminho não é possível. (Contribuição de Barney Gale em gh-89812@footnote{https://github.com/python/cpython/issues/89812}.)

@item 
Adiciona um novo construtor para criar objetos @ref{229,,Path} a partir de URIs ‘file’ (@code{file:///}), @ref{22a,,Path.from_uri()}. (Contribuição de Barney Gale em gh-107465@footnote{https://github.com/python/cpython/issues/107465}.)

@item 
Adiciona @ref{22b,,PurePath.full_match()} para corresponder caminhos com curingas do tipo shell, incluindo o curinga recursivo “@code{**}”. (Contribuição de Barney Gale em gh-73435@footnote{https://github.com/python/cpython/issues/73435}.)

@item 
Adiciona o atributo de classe @ref{22c,,PurePath.parser} para armazenar a implementação de @ref{a2,,os.path} usada para análise e junção de caminhos de baixo nível. Isso vai ser @code{posixpath} ou @code{ntpath}.

@item 
Adiciona o argumento somente-nomeado `recurse_symlinks' a @ref{22d,,Path.glob()} e @ref{22e,,rglob()}. (Contribuição de Barney Gale em gh-77609@footnote{https://github.com/python/cpython/issues/77609}.)

@item 
@ref{22d,,Path.glob()} e @ref{22e,,rglob()} agora retornam arquivos e diretórios quando recebem um padrão que termina com “@code{**}”. Anteriormente, apenas os diretórios eram retornados. (Contribuição de Barney Gale em gh-70303@footnote{https://github.com/python/cpython/issues/70303}.)

@item 
Adiciona o argumento somente-nomeado `follow_symlinks' a @ref{22f,,Path.is_file}, @ref{230,,Path.is_dir}, @ref{231,,Path.owner()} e @ref{232,,Path.group()}. (Contribuição de Barney Gale em gh-105793@footnote{https://github.com/python/cpython/issues/105793} e Kamil Turek em gh-107962@footnote{https://github.com/python/cpython/issues/107962}.)
@end itemize

@node pdb,queue,pathlib,Módulos melhorados
@anchor{whatsnew/3 13 pdb}@anchor{233}
@subsubsection pdb



@itemize *

@item 
@ref{234,,breakpoint()} e @ref{235,,set_trace()} agora entram no depurador imediatamente em vez de na próxima linha de código a ser executada. Esta mudança evita que o depurador quebre fora do contexto quando @code{breakpoint()} estiver posicionado no final do contexto. (Contribuição de Tian Gao em gh-118579@footnote{https://github.com/python/cpython/issues/118579}.)

@item 
@code{sys.path[0]} não mais é substituído pelo diretório do script que está sendo depurado quando @ref{236,,sys.flags.safe_path} está definido.(Contribuição de Tian Gao e Christian Walther em gh-111762@footnote{https://github.com/python/cpython/issues/111762}.)

@item 
@ref{130,,zipapp} agora é aceito como alvo de depuração. (Contribuição de Tian Gao em gh-118501@footnote{https://github.com/python/cpython/issues/118501}.)

@item 
Adiciona a capacidade de mover entre exceções encadeadas durante a depuração post-mortem em @ref{237,,pm()} usando o novo comando @ref{238,,exceptions [número_exc]} para Pdb. (Contribuição de Matthias Bussonnier em gh-106676@footnote{https://github.com/python/cpython/issues/106676}.)

@item 
Expressões e instruções cujo prefixo é um comando pdb agora são identificadas e executadas corretamente. (Contribuição de Tian Gao em gh-108464@footnote{https://github.com/python/cpython/issues/108464}.)
@end itemize

@node queue,random,pdb,Módulos melhorados
@anchor{whatsnew/3 13 queue}@anchor{239}
@subsubsection queue



@itemize *

@item 
Adiciona @ref{23a,,Queue.shutdown} e @ref{23b,,ShutDown} para gerenciar a finalização da fila. (Contribuição de Laurie Opperman e Yves Duprat em gh-104750@footnote{https://github.com/python/cpython/issues/104750}.)
@end itemize

@node random,re,queue,Módulos melhorados
@anchor{whatsnew/3 13 random}@anchor{23c}
@subsubsection random



@itemize *

@item 
Adiciona uma @ref{154,,interface de linha de comando}. (Contribuição de Hugo van Kemenade em gh-118131@footnote{https://github.com/python/cpython/issues/118131}.)
@end itemize

@node re,shutil,random,Módulos melhorados
@anchor{whatsnew/3 13 re}@anchor{23d}
@subsubsection re



@itemize *

@item 
Renomeia @code{re.error} para @ref{23e,,PatternError} para maior clareza. @code{re.error} é mantido para compatibilidade com versões anteriores.
@end itemize

@node shutil,site,re,Módulos melhorados
@anchor{whatsnew/3 13 shutil}@anchor{23f}
@subsubsection shutil



@itemize *

@item 
Suporte aos argumentos nomeados `dir_fd' e `follow_symlinks' em @ref{240,,chown()}. (Contribuição de Berker Peksag e Tahia K em gh-62308@footnote{https://github.com/python/cpython/issues/62308})
@end itemize

@node site,sqlite3,shutil,Módulos melhorados
@anchor{whatsnew/3 13 site}@anchor{241}
@subsubsection site



@itemize *

@item 
Os arquivos @code{.pth} agora são decodificados primeiro usando UTF-8 e depois usando @ref{242,,codificação da localidade} se a decodificação UTF-8 falhar. (Contribuição de Inada Naoki em gh-117802@footnote{https://github.com/python/cpython/issues/117802}.)
@end itemize

@node sqlite3,ssl,site,Módulos melhorados
@anchor{whatsnew/3 13 sqlite3}@anchor{243}
@subsubsection sqlite3



@itemize *

@item 
Uma @ref{244,,ResourceWarning} agora é emitida se um objeto @ref{245,,Connection} não for explicitamente @ref{246,,fechado}. (Contribuição de Erlend E. Aasland em gh-105539@footnote{https://github.com/python/cpython/issues/105539}.)

@item 
Adiciona o parâmetro somente-nomeado `filter' a @ref{247,,Connection.iterdump()} para filtrar objetos de banco de dados para despejo. (Contribuição de Mariusz Felisiak em gh-91602@footnote{https://github.com/python/cpython/issues/91602}.)
@end itemize

@node ssl,statistics,sqlite3,Módulos melhorados
@anchor{whatsnew/3 13 ssl}@anchor{248}
@subsubsection ssl



@itemize *

@item 
A API @ref{155,,create_default_context()} agora inclui @ref{156,,VERIFY_X509_PARTIAL_CHAIN} e @ref{157,,VERIFY_X509_STRICT} em seus sinalizadores padrão.

@cartouche
@quotation Nota 
@ref{157,,VERIFY_X509_STRICT} pode rejeitar certificados pré-
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html} ou malformados que a implementação OpenSSL subjacente poderia aceitar. Embora não seja recomendado desativar isso, você pode fazer isso usando:

@example
import ssl

ctx = ssl.create_default_context()
ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
@end example
@end quotation
@end cartouche

(Contribuição de William Woodruff em gh-112389@footnote{https://github.com/python/cpython/issues/112389}.)
@end itemize

@node statistics,subprocess,ssl,Módulos melhorados
@anchor{whatsnew/3 13 statistics}@anchor{249}
@subsubsection statistics



@itemize *

@item 
Adiciona @ref{24a,,kde()} para estimativa de densidade do núcleo. Isto torna possível estimar uma função de densidade de probabilidade contínua a partir de um número fixo de amostras discretas. (Contribuição de Raymond Hettinger em gh-115863@footnote{https://github.com/python/cpython/issues/115863}.)

@item 
Adiciona @ref{24b,,kde_random()} para amostragem de uma função de densidade de probabilidade estimada criada por @ref{24a,,kde()}. (Contribuição de Raymond Hettinger em gh-115863@footnote{https://github.com/python/cpython/issues/115863}.)
@end itemize

@node subprocess,sys,statistics,Módulos melhorados
@anchor{whatsnew/3 13 subprocess}@anchor{24c}@anchor{whatsnew/3 13 whatsnew313-subprocess}@anchor{24d}
@subsubsection subprocess



@itemize *

@item 
O módulo @ref{d6,,subprocess} agora usa a função @ref{220,,posix_spawn()} em mais situações.

Notavelmente, quando `close_fds' é @code{True} (o padrão), @ref{220,,posix_spawn()} será usado quando a biblioteca C fornecer @code{posix_spawn_file_actions_addclosefrom_np()}, que inclui versões recentes do Linux, FreeBSD e Solaris. No Linux, isso deve ter um desempenho semelhante ao código existente baseado em @code{vfork()} do Linux.

Um botão de controle privado @code{subprocess._USE_POSIX_SPAWN} pode ser definido como @code{False} se você precisar forçar @ref{d6,,subprocess} a nunca usar @ref{220,,posix_spawn()}. Por favor, informe o motivo e os detalhes da plataforma no @ref{24e,,rastreador de problemas} se você definir isso para que possamos melhorar nossa lógica de seleção de API para todos. (Contribuído por Jakub Kulik em gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node sys,tempfile,subprocess,Módulos melhorados
@anchor{whatsnew/3 13 sys}@anchor{24f}
@subsubsection sys



@itemize *

@item 
Adiciona a função @ref{250,,_is_interned()} para testar se uma string foi internada. Não há garantia de que esta função exista em todas as implementações do Python. (Contribuição de Serhiy Storchaka em gh-78573@footnote{https://github.com/python/cpython/issues/78573}.)
@end itemize

@node tempfile,time,sys,Módulos melhorados
@anchor{whatsnew/3 13 tempfile}@anchor{251}
@subsubsection tempfile



@itemize *

@item 
No Windows, o modo padrão @code{0o700} usado por @ref{21f,,tempfile.mkdtemp()} agora limita o acesso ao novo diretório devido a alterações em @ref{21d,,os.mkdir()}. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}. (Contribuição de Steve Dower em gh-118486@footnote{https://github.com/python/cpython/issues/118486}.)
@end itemize

@node time,tkinter,tempfile,Módulos melhorados
@anchor{whatsnew/3 13 time}@anchor{252}
@subsubsection time



@itemize *

@item 
No Windows, @ref{253,,monotonic()} agora usa o relógio @code{QueryPerformanceCounter()} para uma resolução de 1 microssegundo, em vez do relógio @code{GetTickCount64()} que tem uma resolução de 15.6 milissegundos. (Contribuição de Victor Stinner em gh-88494@footnote{https://github.com/python/cpython/issues/88494}.)

@item 
No Windows, @ref{254,,time()} agora usa o relógio @code{GetSystemTimePreciseAsFileTime()} para uma resolução de 1 microssegundo, em vez do relógio @code{GetSystemTimeAsFileTime()} que tem uma resolução de 15.6 milissegundos. (Contribuição de Victor Stinner em gh-63207@footnote{https://github.com/python/cpython/issues/63207}.)
@end itemize

@node tkinter,traceback,time,Módulos melhorados
@anchor{whatsnew/3 13 tkinter}@anchor{255}
@subsubsection tkinter



@itemize *

@item 
Adiciona métodos de widget @ref{f0,,tkinter}: @code{tk_busy_hold()}, @code{tk_busy_configure()}, @code{tk_busy_cget()}, @code{tk_busy_forget()}, @code{tk_busy_current()} e @code{tk_busy_status()}. (Contribuição de Miguel, klappnase e Serhiy Storchaka em gh-72684@footnote{https://github.com/python/cpython/issues/72684}.)

@item 
O método @code{wm_attributes()} de widget @ref{f0,,tkinter} agora aceita o nome do atributo sem o prefixo negativo para obter atributos de janela (por exemplo, @code{w.wm_attributes('alpha')}) e permite especificar atributos e valores para definir como argumentos nomeados (por exemplo, @code{w.wm_attributes(alpha=0.5)}). (Contribuição de Serhiy Storchaka em gh-43457@footnote{https://github.com/python/cpython/issues/43457}.)

@item 
@code{wm_attributes()} agora pode retornar atributos como um @ref{256,,dict}, usando o novo parâmetro somente-nomeado opcional `return_python_dict'. (Contribuição de Serhiy Storchaka em gh-43457@footnote{https://github.com/python/cpython/issues/43457}.)

@item 
@code{Text.count()} agora pode retornar um @ref{257,,int} simples quando o novo parâmetro somente-nomeado opcional `return_ints' é usado. Caso contrário, a contagem única é retornada como uma tupla de 1 elemento ou @code{None}. (Contribuição de Serhiy Storchaka em gh-97928@footnote{https://github.com/python/cpython/issues/97928}.)

@item 
Suporte ao tipo de elemento “vsapi” no método @ref{258,,element_create()} de @ref{259,,tkinter.ttk.Style}. (Contribuição de Serhiy Storchaka em gh-68166@footnote{https://github.com/python/cpython/issues/68166}.)

@item 
Adiciona o método @code{after_info()} para widgets do Tkinter. (Contribuição de Cheryl Sabella em gh-77020@footnote{https://github.com/python/cpython/issues/77020}.)

@item 
Adiciona um novo método @code{copy_replace()} a @code{PhotoImage} para copiar uma região de uma imagem para outra, possivelmente com zoom de pixel, subamostragem ou ambos. (Contribuição de Serhiy Storchaka em gh-118225@footnote{https://github.com/python/cpython/issues/118225}.)

@item 
Adiciona parâmetro `from_coords' para os métodos @code{copy()}, @code{zoom()} e @code{subsample()} da classe @code{PhotoImage}. Adiciona parâmetros `zoom' e `subsample' para o método @code{copy()} da classe @code{PhotoImage}. (Contribuição de Serhiy Storchaka em gh-118225@footnote{https://github.com/python/cpython/issues/118225}.)

@item 
Adiciona os métodos @code{PhotoImage} @code{read()} para ler uma imagem de um arquivo e @code{data()} para obter os dados da imagem. Adiciona os parâmetros `background' e `grayscale' ao método @code{write()}. (Contribuição de Serhiy Storchaka em gh-118271@footnote{https://github.com/python/cpython/issues/118271}.)
@end itemize

@node traceback,types,tkinter,Módulos melhorados
@anchor{whatsnew/3 13 traceback}@anchor{25a}
@subsubsection traceback



@itemize *

@item 
Adiciona o atributo @ref{25b,,exc_type_str} a @ref{25c,,TracebackException}, que contém uma exibição de string do `exc_type'. Descontinua o atributo @ref{25d,,exc_type}, que contém o próprio objeto de tipo. Adicione o parâmetro `save_exc_type' (padrão @code{True}) para indicar se @code{exc_type} deve ser salvo. (Contribuição de Irit Katriel em gh-112332@footnote{https://github.com/python/cpython/issues/112332}.)

@item 
Adiciona um novo parâmetro somente-nomeado `show_group' a @ref{25e,,TracebackException.format_exception_only()} para formatar (recursivamente) as exceções aninhadas de uma instância @ref{25f,,BaseExceptionGroup}. (Contribuição de Irit Katriel em gh-105292@footnote{https://github.com/python/cpython/issues/105292}.)
@end itemize

@node types,typing,traceback,Módulos melhorados
@anchor{whatsnew/3 13 types}@anchor{260}
@subsubsection types



@itemize *

@item 
@ref{1d1,,SimpleNamespace} agora pode receber um único argumento posicional para inicializar os argumentos do espaço de nomes. Este argumento deve ser um mapeamento ou um iterável de pares chave-valor. (Contribuição de Serhiy Storchaka em gh-108191@footnote{https://github.com/python/cpython/issues/108191}.)
@end itemize

@node typing,unicodedata,types,Módulos melhorados
@anchor{whatsnew/3 13 typing}@anchor{261}
@subsubsection typing



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: adiciona @ref{161,,ReadOnly}, uma construção especial de tipagem para marcar um item @ref{162,,TypedDict} como somente leitura para verificadores de tipo.

@item 
@geindex Propostas de Melhorias do Python; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: adiciona @ref{163,,TypeIs}, uma construção de tipagem que pode ser usada para instruir um verificador de tipos sobre como restringir um tipo.

@item 
Adiciona @ref{262,,NoDefault}, um objeto sinalizador usado para representar os padrões de alguns parâmetros no módulo @ref{104,,typing}. (Contribuição de Jelle Zijlstra em gh-116126@footnote{https://github.com/python/cpython/issues/116126}.)

@item 
Adicione @ref{263,,get_protocol_members()} para retornar o conjunto de membros que definem uma @ref{264,,typing.Protocol}. (Contribuição de Jelle Zijlstra em gh-104873@footnote{https://github.com/python/cpython/issues/104873}.)

@item 
Adiciona @ref{265,,is_protocol()} para verificar se uma classe é uma @ref{264,,Protocol}. (Contribuição de Jelle Zijlstra em gh-104873@footnote{https://github.com/python/cpython/issues/104873}.)

@item 
@ref{266,,ClassVar} agora pode ser aninhado em @ref{267,,Final}, e vice-versa. (Contribuição de Mehdi Drissi em gh-89547@footnote{https://github.com/python/cpython/issues/89547}.)
@end itemize

@node unicodedata,venv,typing,Módulos melhorados
@anchor{whatsnew/3 13 unicodedata}@anchor{268}
@subsubsection unicodedata



@itemize *

@item 
Atualiza o banco de dados Unicode para a versão 15.1.0@footnote{https://www.unicode.org/versions/Unicode15.1.0/}. (Contribuição de James Gerity em gh-109559@footnote{https://github.com/python/cpython/issues/109559}.)
@end itemize

@node venv,avisos,unicodedata,Módulos melhorados
@anchor{whatsnew/3 13 venv}@anchor{269}
@subsubsection venv



@itemize *

@item 
Adiciona suporte para criar arquivos ignorados pelo gerenciamento de controle de fontes (SCM) no diretório de um ambiente virtual. Por padrão, o Git é compatível. Isso está implementado como ativado por padrão por meio da API, que pode ser estendido para oferecer suporte a outros SCMs (@ref{26a,,EnvBuilder} e @ref{26b,,create()}) e desativado por padrão por meio da CLI, usando @code{--without-scm-ignore-files}. (Contribuição de Brett Cannon em gh-108125@footnote{https://github.com/python/cpython/issues/108125}.)
@end itemize

@node avisos,xml,venv,Módulos melhorados
@anchor{whatsnew/3 13 warnings}@anchor{26c}
@subsubsection avisos



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: O novo decorador @ref{160,,warnings.deprecated()} fornece uma maneira de comunicar descontinuações para um @ref{26d,,verificador de tipo estático} e avisar sobre o uso de classes e funções obsoletas. Um @ref{1a5,,DeprecationWarning} também pode ser emitido quando uma função ou classe decorada é usada em tempo de execução. (Contribuição de Jelle Zijlstra em gh-104003@footnote{https://github.com/python/cpython/issues/104003}.)
@end itemize

@node xml,zipimport,avisos,Módulos melhorados
@anchor{whatsnew/3 13 xml}@anchor{26e}
@subsubsection xml



@itemize *

@item 
Permite controlar o adiamento da nova análise do Expat >=2.6.0 (
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}) adicionando cinco novos métodos:


@itemize *

@item 
@ref{26f,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{270,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{271,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{272,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()}

@item 
@code{xml.sax.expatreader.ExpatParser.flush()}
@end itemize

(Contribuição de Sebastian Pipping em gh-115623@footnote{https://github.com/python/cpython/issues/115623}.)

@item 
Adiciona o método @code{close()} para o iterador retornado por @ref{273,,iterparse()} para limpeza explícita. (Contribuição de Serhiy Storchaka em gh-69893@footnote{https://github.com/python/cpython/issues/69893}.)
@end itemize

@node zipimport,,xml,Módulos melhorados
@anchor{whatsnew/3 13 zipimport}@anchor{274}
@subsubsection zipimport



@itemize *

@item 
Adiciona suporte para arquivos no formato ZIP64@footnote{https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64}. Todo mundo adora dados enormes, certo? (Contribuição de Tim Hatch em gh-94146@footnote{https://github.com/python/cpython/issues/94146}.)
@end itemize

@node Otimizações,Módulos e APIs removidas,Módulos melhorados,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 optimizations}@anchor{275}
@subsection Otimizações



@itemize *

@item 
Vários módulos de biblioteca padrão tiveram seus tempos de importação significativamente melhorados. Por exemplo, o tempo de importação do módulo @ref{104,,typing} foi reduzido em cerca de um terço pela remoção de dependências em @ref{b9,,re} e @ref{23,,contextlib}. Outros módulos para aproveitar a aceleração no tempo de importação incluem @ref{50,,email.utils}, @ref{56,,enum}, @ref{5f,,functools}, @ref{7a,,importlib.metadata} e @ref{ed,,threading}. (Contribuição de Alex Waygood, Shantanu Jain, Adam Turner, Daniel Hollas e outros em gh-109653@footnote{https://github.com/python/cpython/issues/109653}.)

@item 
@ref{276,,textwrap.indent()} agora é cerca de 30% mais rápido do que antes para entradas grandes. (Contribuição de Inada Naoki em gh-107369@footnote{https://github.com/python/cpython/issues/107369}.)

@item 
O módulo @ref{d6,,subprocess} agora a função @ref{220,,posix_spawn()} em mais situações, incluindo quando `close_fds' é @code{True} (o padrão) em muitas plataformas. Isto deve fornecer um aumento notável de desempenho ao iniciar processos no FreeBSD e Solaris. Veja a seção de @ref{24d,,subprocess} acima para detalhes. (Contribuição de Jakub Kulik em gh-113117@footnote{https://github.com/python/cpython/issues/113117}.)
@end itemize

@node Módulos e APIs removidas,Novas descontinuações,Otimizações,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 removed-modules-and-apis}@anchor{277}
@subsection Módulos e APIs removidas


@menu
* PEP 594; remove “baterias descarregadas” da biblioteca padrão: PEP 594 remove “baterias descarregadas” da biblioteca padrão. 
* 2to3:: 
* builtins:: 
* configparser: configparser<2>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* optparse:: 
* pathlib: pathlib<2>. 
* re: re<2>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<2>. 
* unittest:: 
* urllib:: 
* webbrowser:: 

@end menu

@node PEP 594 remove “baterias descarregadas” da biblioteca padrão,2to3,,Módulos e APIs removidas
@anchor{whatsnew/3 13 pep-594-remove-dead-batteries-from-the-standard-library}@anchor{278}@anchor{whatsnew/3 13 whatsnew313-pep594}@anchor{143}
@subsubsection PEP 594: remove “baterias descarregadas” da biblioteca padrão


@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} propôs remover 19 módulos da biblioteca padrão, coloquialmente chamados de “baterias descarregadas” devido ao seu status histórico, obsoleto ou inseguro. Todos os módulos a seguir foram descontinuados no Python 3.11 e agora foram removidos:


@itemize *

@item 
@code{aifc}


@itemize *

@item 
standard-aifc@footnote{https://pypi.org/project/standard-aifc/}: Use a redistribuição da biblioteca @code{aifc} do PyPI.
@end itemize

@item 
@code{audioop}


@itemize *

@item 
audioop-lts@footnote{https://pypi.org/project/audioop-lts/}: Use a biblioteca @code{audioop-lts} do PyPI.
@end itemize

@item 
@code{chunk}


@itemize *

@item 
standard-chunk@footnote{https://pypi.org/project/standard-chunk/}: Use a redistribuição da biblioteca @code{chunk} do PyPI.
@end itemize

@item 
@code{cgi} e @code{cgitb}


@itemize *

@item 
@code{cgi.FieldStorage} normalmente pode ser substituído por @ref{279,,urllib.parse.parse_qsl()} para solicitações @code{GET} e @code{HEAD}, e o módulo @ref{44,,email.message} ou a biblioteca multipart@footnote{https://pypi.org/project/multipart/} para solicitações @code{POST} e @code{PUT}.

@item 
@code{cgi.parse()} pode ser substituído chamando @ref{27a,,urllib.parse.parse_qs()} diretamente na string de consulta desejada, a menos que a entrada seja @code{multipart/form-data}, que deve ser substituída conforme descrito abaixo para @code{cgi.parse_multipart()}.

@item 
@code{cgi.parse_header()} pode ser substituído pela funcionalidade do pacote @ref{3b,,email}, que implementa os mesmos RFCs MIME. Por exemplo, com @ref{27b,,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()} pode ser substituído pela funcionalidade no pacote @ref{3b,,email}, que implementa os mesmos RFCs de MIME, ou pela biblioteca multipart@footnote{https://pypi.org/project/multipart/}. Por exemplo, as classes @ref{27b,,email.message.EmailMessage} e @ref{27c,,email.message.Message}.

@item 
standard-cgi@footnote{https://pypi.org/project/standard-cgi/}: e standard-cgitb@footnote{https://pypi.org/project/standard-cgitb/}: Use a redistribuição das bibliotecas @code{cgi} e @code{cgitb} do PyPI.
@end itemize

@item 
@code{crypt} e a extensão privada @code{_crypt}. O módulo @ref{68,,hashlib} pode ser uma substituição apropriada quando simplesmente fazer hash de um valor é necessário. Caso contrário, várias bibliotecas de terceiros no PyPI estão disponíveis:


@itemize *

@item 
bcrypt@footnote{https://pypi.org/project/bcrypt/}: hashing de senha moderno para seu software e servidores.

@item 
argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}: algoritmo seguro de hashing de senha Argon2.

@item 
legacycrypt@footnote{https://pypi.org/project/legacycrypt/}: envólucro ao @ref{2a,,ctypes} para a chamada POSIX da biblioteca de criptografia e funcionalidade associada.

@item 
crypt_r@footnote{https://pypi.org/project/crypt_r/}: fork do módulo @code{crypt}, um envólucro para a chamada da biblioteca @code{crypt_r(3)@footnote{https://manpages.debian.org/crypt_r(3)}} e funcionalidade associada.

@item 
standard-crypt@footnote{https://pypi.org/project/standard-crypt/} e deprecated-crypt-alternative@footnote{https://pypi.org/project/deprecated-crypt-alternative/}: Use a redistribuição de @code{crypt} e a reimplementação das bibliotecas @code{_crypt} do PyPI.
@end itemize

@item 
@code{imghdr}: as bibliotecas filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} ou python-magic@footnote{https://pypi.org/project/python-magic/} devem ser usadas como substituições. Por exemplo, a função @code{puremagic.what()} pode ser usada para substituir a função @code{imghdr.what()} para todos os formatos de arquivo que tinham suporte de @code{imghdr}.


@itemize *

@item 
standard-imghdr@footnote{https://pypi.org/project/standard-imghdr/}: Use a redistribuição da biblioteca @code{imghdr} do PyPI.
@end itemize

@item 
@code{mailcap}: use o módulo @ref{8f,,mimetypes}.


@itemize *

@item 
standard-mailcap@footnote{https://pypi.org/project/standard-mailcap/}: Use a redistribuição da biblioteca @code{mailcap} do PyPI.
@end itemize

@item 
@code{msilib}

@item 
@code{nis}

@item 
@code{nntplib}: use a biblioteca pynntp@footnote{https://pypi.org/project/pynntp/} do PyPI.


@itemize *

@item 
standard-nntplib@footnote{https://pypi.org/project/standard-nntplib/}: Use a redistribuição da biblioteca @code{nntplib} do PyPI.
@end itemize

@item 
@code{ossaudiodev}: para reprodução de áudio, use a biblioteca pygame@footnote{https://pypi.org/project/pygame/} do PyPI.

@item 
@code{pipes}: Use o módulo @ref{d6,,subprocess} em vez disso. Use @ref{27d,,shlex.quote()} para substituir a função não documentada @code{pipes.quote}.


@itemize *

@item 
standard-pipes@footnote{https://pypi.org/project/standard-pipes/}: Use a redistribuição da biblioteca @code{pipes} do PyPI.
@end itemize

@item 
@code{sndhdr}: as bibliotecas filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} ou python-magic@footnote{https://pypi.org/project/python-magic/} devem ser usadas como substitutas.


@itemize *

@item 
standard-sndhdr@footnote{https://pypi.org/project/standard-sndhdr/}: Use a redistribuição da biblioteca @code{sndhdr} do PyPI.
@end itemize

@item 
@code{spwd}: use a biblioteca python-pam@footnote{https://pypi.org/project/python-pam/} do PyPI.

@item 
@code{sunau}


@itemize *

@item 
standard-sunau@footnote{https://pypi.org/project/standard-sunau/}: Use a redistribuição da biblioteca @code{sunau} do PyPI.
@end itemize

@item 
@code{telnetlib}: use as bibliotecas telnetlib3@footnote{https://pypi.org/project/telnetlib3/} ou Exscript@footnote{https://pypi.org/project/Exscript/} do PyPI.


@itemize *

@item 
standard-telnetlib@footnote{https://pypi.org/project/standard-telnetlib/}: Use a redistribuição da biblioteca @code{telnetlib} do PyPI.
@end itemize

@item 
@code{uu}: use o módulo @ref{e,,base64} como uma alternativa moderna.


@itemize *

@item 
standard-uu@footnote{https://pypi.org/project/standard-uu/}: Use a redistribuição da biblioteca @code{uu} do PyPI.
@end itemize

@item 
@code{xdrlib}


@itemize *

@item 
standard-xdrlib@footnote{https://pypi.org/project/standard-xdrlib/}: Use a redistribuição da biblioteca @code{xdrlib} do PyPI.
@end itemize
@end itemize

(Contribuição de Victor Stinner e Zachary Ware em gh-104773@footnote{https://github.com/python/cpython/issues/104773} e gh-104780@footnote{https://github.com/python/cpython/issues/104780}.)

@node 2to3,builtins,PEP 594 remove “baterias descarregadas” da biblioteca padrão,Módulos e APIs removidas
@anchor{whatsnew/3 13 to3}@anchor{27e}
@subsubsection 2to3



@itemize *

@item 
Remove o programa @code{2to3} e o módulo @code{lib2to3}, já descontinuados no Python 3.11. (Contribuição de Victor Stinner em gh-104780@footnote{https://github.com/python/cpython/issues/104780}.)
@end itemize

@node builtins,configparser<2>,2to3,Módulos e APIs removidas
@anchor{whatsnew/3 13 builtins}@anchor{27f}
@subsubsection builtins



@itemize *

@item 
Remove suporte aos descritores @ref{166,,classmethod} encadeados (introduzidos em gh-63272@footnote{https://github.com/python/cpython/issues/63272}). Eles não podem mais serem usados para agrupar outros descritores como @ref{194,,property}. O design central desse recurso apresentava falhas e levou a problemas. Para “passar” um @ref{166,,classmethod}, considere usar o atributo @code{__wrapped__} que foi adicionado no Python 3.10. (Contribuição de Raymond Hettinger em gh-89519@footnote{https://github.com/python/cpython/issues/89519}.)

@item 
Chamar @ref{280,,frame.clear()} em um quadro suspenso levanta @ref{195,,RuntimeError} (como sempre foi o caso para um quadro em execução). (Contribuição de Irit Katriel em gh-79932@footnote{https://github.com/python/cpython/issues/79932}.)
@end itemize

@node configparser<2>,importlib metadata,builtins,Módulos e APIs removidas
@anchor{whatsnew/3 13 id3}@anchor{281}
@subsubsection configparser



@itemize *

@item 
Remove a classe não documentada @code{LegacyInterpolation}, descontinuada na docstring desde Python 3.2 e em tempo de execução desde Python 3.11. (Contribuição de Hugo van Kemenade em gh-104886@footnote{https://github.com/python/cpython/issues/104886}.)
@end itemize

@node importlib metadata,locale,configparser<2>,Módulos e APIs removidas
@anchor{whatsnew/3 13 importlib-metadata}@anchor{282}
@subsubsection importlib.metadata



@itemize *

@item 
Remove o acesso descontinuado a subscrito (@ref{283,,__getitem__()}) para objetos @ref{284,,EntryPoint}. (Contribuição de Jason R. Coombs em gh-113175@footnote{https://github.com/python/cpython/issues/113175}.)
@end itemize

@node locale,opcode,importlib metadata,Módulos e APIs removidas
@anchor{whatsnew/3 13 locale}@anchor{285}
@subsubsection locale



@itemize *

@item 
Remove a função @code{locale.resetlocale()}, descontinuada no Python 3.11. Use @code{locale.setlocale(locale.LC_ALL, "")}. (Contribuição de Victor Stinner em gh-104783@footnote{https://github.com/python/cpython/issues/104783}.)
@end itemize

@node opcode,optparse,locale,Módulos e APIs removidas
@anchor{whatsnew/3 13 opcode}@anchor{286}
@subsubsection opcode



@itemize *

@item 
Move @code{opcode.ENABLE_SPECIALIZATION} para @code{_opcode.ENABLE_SPECIALIZATION}. Este campo foi adicionado na versão 3.12, nunca foi documentado e não se destina ao uso externo. (Contribuição de Irit Katriel em gh-105481@footnote{https://github.com/python/cpython/issues/105481}.)

@item 
Remove @code{opcode.is_pseudo()}, @code{opcode.MIN_PSEUDO_OPCODE} e @code{opcode.MAX_PSEUDO_OPCODE}, que foram adicionados no Python 3.12, mas nunca foram documentados nem expostos através de @ref{38,,dis}, e não foram planejados para serem usados externamente. (Contribuição de Irit Katriel em gh-105481@footnote{https://github.com/python/cpython/issues/105481}.)
@end itemize

@node optparse,pathlib<2>,opcode,Módulos e APIs removidas
@anchor{whatsnew/3 13 optparse}@anchor{287}
@subsubsection optparse



@itemize *

@item 
Este módulo não é mais considerado @ref{209,,suavemente descontinuado}. Enquanto o @ref{6,,argparse} continua sendo o preferido para novos projetos que não estão usando uma biblioteca de processamento de argumentos de linha de comando de terceiros, há aspectos da maneira como @code{argparse} funciona que significam que o módulo @code{optparse} de nível inferior pode fornecer uma base melhor para `escrever' bibliotecas de processamento de argumentos e para implementar aplicações de linha de comando que aderem mais estritamente do que @code{argparse} a várias convenções de processamento de linha de comando Unix que se originam no comportamento da função C @code{getopt()}. (Contribuição de Alyssa Coghlan e Serhiy Storchaka em gh-126180@footnote{https://github.com/python/cpython/issues/126180}.)
@end itemize

@node pathlib<2>,re<2>,optparse,Módulos e APIs removidas
@anchor{whatsnew/3 13 id4}@anchor{288}
@subsubsection pathlib



@itemize *

@item 
Remove a capacidade de usar objetos @ref{229,,Path} como gerenciadores de contexto. Essa funcionalidade foi descontinuada e não tinha efeito desde o Python 3.9. (Contribuição de Barney Gale em gh-83863@footnote{https://github.com/python/cpython/issues/83863}.)
@end itemize

@node re<2>,tkinter tix,pathlib<2>,Módulos e APIs removidas
@anchor{whatsnew/3 13 id5}@anchor{289}
@subsubsection re



@itemize *

@item 
Remove a função @code{re.template()} não documentada, descontinuada e quebrada e o sinalizador @code{re.TEMPLATE} / @code{re.T}. (Contribuição de Serhiy Storchaka e Nikita Sobolev em gh-105687@footnote{https://github.com/python/cpython/issues/105687}.)
@end itemize

@node tkinter tix,turtle,re<2>,Módulos e APIs removidas
@anchor{whatsnew/3 13 tkinter-tix}@anchor{28a}
@subsubsection tkinter.tix



@itemize *

@item 
Remove o módulo @code{tkinter.tix}, descontinuado no Python 3.6. A biblioteca Tix de terceiros que o módulo empacota não é mantida. (Contribuição de Zachary Ware em gh-75552@footnote{https://github.com/python/cpython/issues/75552}.)
@end itemize

@node turtle,typing<2>,tkinter tix,Módulos e APIs removidas
@anchor{whatsnew/3 13 turtle}@anchor{28b}
@subsubsection turtle



@itemize *

@item 
Remove o método @code{RawTurtle.settiltangle()}, descontinuado na documentação desde o Python 3.1 e em tempo de execução desde o Python 3.11. (Contribuição de Hugo van Kemenade em gh-104876@footnote{https://github.com/python/cpython/issues/104876}.)
@end itemize

@node typing<2>,unittest,turtle,Módulos e APIs removidas
@anchor{whatsnew/3 13 id6}@anchor{28c}
@subsubsection typing



@itemize *

@item 
Remove os espaços de nomes @code{typing.io} e @code{typing.re}, descontinuados desde o Python 3.8. Os itens nesses espaços de nomes podem ser importados diretamente do módulo @ref{104,,typing}. (Contribuição de Sebastian Rittau em gh-92871@footnote{https://github.com/python/cpython/issues/92871}.)

@item 
Remove o método de argumento nomeado de criação de tipos @ref{162,,TypedDict}, descontinuados no Python 3.11. (Contribuição de Tomas Roun em gh-104786@footnote{https://github.com/python/cpython/issues/104786}.)
@end itemize

@node unittest,urllib,typing<2>,Módulos e APIs removidas
@anchor{whatsnew/3 13 unittest}@anchor{28d}
@subsubsection unittest



@itemize *

@item 
Remove as seguintes funções @ref{106,,unittest}, descontinuadas no Python 3.11:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Em vez delas, use os métodos de @ref{28e,,TestLoader}:


@itemize *

@item 
@ref{28f,,loadTestsFromModule()}

@item 
@ref{290,,loadTestsFromTestCase()}

@item 
@ref{291,,getTestCaseNames()}
@end itemize

(Contribuição de Hugo van Kemenade em gh-104835@footnote{https://github.com/python/cpython/issues/104835}.)

@item 
Remove o método @code{TestProgram.usageExit()} não testado e não documentado, descontinuado no Python 3.11. (Contribuição de Hugo van Kemenade em gh-104992@footnote{https://github.com/python/cpython/issues/104992}.)
@end itemize

@node urllib,webbrowser,unittest,Módulos e APIs removidas
@anchor{whatsnew/3 13 urllib}@anchor{292}
@subsubsection urllib



@itemize *

@item 
Remove os parâmetros `cafile', `capath' e `cadefault' da função @ref{293,,urllib.request.urlopen()}, descontinuada no Python 3.6. Em vez disso, use o parâmetro `context' com uma instância de @ref{294,,SSLContext}. A função @ref{295,,ssl.SSLContext.load_cert_chain()} pode ser usada para carregar certificados específicos ou deixe @ref{155,,ssl.create_default_context()} selecionar os certificados de autoridade certificadora (AC) confiável do sistema operacional. (Contribuição de Victor Stinner em gh-105382@footnote{https://github.com/python/cpython/issues/105382}.)
@end itemize

@node webbrowser,,urllib,Módulos e APIs removidas
@anchor{whatsnew/3 13 webbrowser}@anchor{296}
@subsubsection webbrowser



@itemize *

@item 
Remove a classe @code{MacOSX} não testada e não documentada, descontinuada no Python 3.11. Use a classe @code{MacOSXOSAScript} (introduzida no Python 3.2). (Contribuição de Hugo van Kemenade em gh-104804@footnote{https://github.com/python/cpython/issues/104804}.)

@item 
Remove o atributo descontinuado @code{MacOSXOSAScript._name}. Use o atributo @ref{297,,MacOSXOSAScript.name}. (Contribuição de Nikita Sobolev em gh-105546@footnote{https://github.com/python/cpython/issues/105546}.)
@end itemize

@node Novas descontinuações,Alterações de bytecode do CPython,Módulos e APIs removidas,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 new-deprecations}@anchor{298}
@subsection Novas descontinuações



@itemize *

@item 
@ref{299,,Funções definidas pelo usuário}:


@itemize *

@item 
A atribuição ao atributo @ref{29a,,__code__} de uma função onde o tipo do novo objeto código não corresponde ao tipo da função está descontinuada. Os diferentes tipos são: função simples, gerador, gerador assíncrono e corrotina. (Contribuição de Irit Katriel em gh-81137@footnote{https://github.com/python/cpython/issues/81137}.)
@end itemize

@item 
@ref{7,,array}:


@itemize *

@item 
Descontinua o código de formato @code{'u'} (@code{wchar_t}). Este código de formato foi descontinuado na documentação desde o Python 3.3 e será removido no Python 3.16. Use o código de formato @code{'w'} (@ref{29b,,Py_UCS4}) para caracteres Unicode. (Contribuição de Hugo van Kemenade em gh-80480@footnote{https://github.com/python/cpython/issues/80480}.)
@end itemize

@item 
@ref{2a,,ctypes}:


@itemize *

@item 
Descontinua a função não documentada @code{SetPointerType()}, que será removida no Python 3.15. (Contribuição de Victor Stinner em gh-105733@footnote{https://github.com/python/cpython/issues/105733}.)

@item 
@ref{209,,Descontinua suavemente} a função @ref{29c,,ARRAY()} em favor da multiplicação @code{type * length}. (Contribuição de Victor Stinner em gh-105733@footnote{https://github.com/python/cpython/issues/105733}.)
@end itemize

@item 
@ref{36,,decimal}:


@itemize *

@item 
Deprecate the non-standard and undocumented @ref{29d,,Decimal}
format specifier @code{'N'},
which is only supported in the @code{decimal} module’s C implementation.
Scheduled to be removed in Python 3.18.
(Contributed by Serhiy Storchaka in gh-89902@footnote{https://github.com/python/cpython/issues/89902}.)
@end itemize

@item 
@ref{38,,dis}:


@itemize *

@item 
Descontinua o separador @code{HAVE_ARGUMENT}. Em vez disso, Verifique a associação em @ref{29e,,hasarg}. (Contribuição de Irit Katriel em gh-109319@footnote{https://github.com/python/cpython/issues/109319}.)
@end itemize

@item 
@ref{63,,gettext}:


@itemize *

@item 
Descontinua números não inteiros como argumentos para funções e métodos que consideram formas plurais no módulo @code{gettext}, ainda que nenhuma tradução tenha sido encontrada. (Contribuição de Serhiy Storchaka em gh-88434@footnote{https://github.com/python/cpython/issues/88434}.)
@end itemize

@item 
@ref{64,,glob}:


@itemize *

@item 
Descontinua as funções não documentadas @code{glob0()} e @code{glob1()}. Em vez disso, use @ref{29f,,glob()} e passe um @ref{2a0,,objeto caminho ou similar} especificando o diretório raiz para o parâmetro `root_dir'. (Contribuição de Barney Gale em gh-117337@footnote{https://github.com/python/cpython/issues/117337}.)
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
Descontinua @ref{2a1,,CGIHTTPRequestHandler}, a ser removido no Python 3.15. Servidores HTTP CGI baseados em processos estão fora de moda há muito tempo. Este código estava desatualizado, sem manutenção e raramente era usado. Ele tem um alto potencial para bugs de segurança e funcionalidade. (Contribuição de Gregory P. Smith em gh-109096@footnote{https://github.com/python/cpython/issues/109096}.)

@item 
Descontinua o sinalizador @code{--cgi} para a interface de linha de comando @code{python -m http.server}, a ser removido no Python 3.15. (Contribuição de Gregory P. Smith em gh-109096@footnote{https://github.com/python/cpython/issues/109096}.)
@end itemize

@item 
@ref{8f,,mimetypes}:


@itemize *

@item 
@ref{209,,Descontinua suavemente} argumentos caminho de arquivo para @ref{208,,guess_type()}, use @ref{207,,guess_file_type()} em vez disso. (Contribuição de Serhiy Storchaka em gh-66543@footnote{https://github.com/python/cpython/issues/66543}.)
@end itemize

@item 
@ref{b9,,re}:


@itemize *

@item 
Descontinua a passagem dos argumentos opcionais `maxsplit', `count' ou `flags' como argumentos posicionais para as funções de nível de módulo @ref{2a2,,split()}, @ref{2a3,,sub()} e @ref{2a4,,subn()}. Esses parâmetros se tornarão @ref{2a5,,somente-nomeados} em uma versão futura do Python. (Contribuição de Serhiy Storchaka em gh-56166@footnote{https://github.com/python/cpython/issues/56166}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
Descontinua @ref{2a6,,PurePath.is_reserved()}, a ser removido no Python 3.15. Use @ref{223,,os.path.isreserved()} para detectar caminhos reservados no Windows. (Contribuição de Barney Gale em gh-88569@footnote{https://github.com/python/cpython/issues/88569}.)
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
Descontinua @ref{2a7,,java_ver()}, a ser removida no Python 3.15. Esta função é útil apenas para suporte a Jython, tem uma API confusa e é amplamente não testada. (Contribuição de Nikita Sobolev em gh-116349@footnote{https://github.com/python/cpython/issues/116349}.)
@end itemize

@item 
@ref{b5,,pydoc}:


@itemize *

@item 
Descontinua a função não documentada @code{ispackage()}. (Contribuição de Zackery Spytz em gh-64020@footnote{https://github.com/python/cpython/issues/64020}.)
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
Descontinua a passagem de mais de um argumento posicional para a função @ref{2a8,,connect()} e o construtor @ref{245,,Connection}. Os parâmetros restantes se tornarão somente-nomeados no Python 3.15. (Contribuição de Erlend E. Aasland em gh-107948@footnote{https://github.com/python/cpython/issues/107948}.)

@item 
Descontinua a passagem de nome, número de argumentos e o chamável como argumentos nomeados para @ref{2a9,,Connection.create_function()} e @ref{2aa,,Connection.create_aggregate()} Esses parâmetros se tornarão somente-posicionais no Python 3.15. (Contribuição de Erlend E. Aasland em gh-108278@footnote{https://github.com/python/cpython/issues/108278}.)

@item 
Descontinua a passagem do chamável de função de retorno como argumento nomeado para os métodos @ref{2ab,,set_authorizer()}, @ref{2ac,,set_progress_handler()} e @ref{2ad,,set_trace_callback()} da classe @ref{245,,Connection}. Os chamáveis de função de retorno se tornarão somente-posicionais no Python 3.15. (Contribuição de Erlend E. Aasland em gh-108278@footnote{https://github.com/python/cpython/issues/108278}.)
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
Descontinua a função @ref{2ae,,_enablelegacywindowsfsencoding()}, para ser removida no Python 3.16. Em vez disso, use a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING}. (Contribuição de Inada Naoki em gh-73427@footnote{https://github.com/python/cpython/issues/73427}.)
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
Descontinua o atributo @code{TarFile.tarfile} não documentado e não utilizado, a ser removido no Python 3.16. (Contribuição em gh-115256@footnote{https://github.com/python/cpython/issues/115256}.)
@end itemize

@item 
@ref{fe,,traceback}:


@itemize *

@item 
Descontinua o atributo @ref{25d,,TracebackException.exc_type}. Em vez disso, use @ref{25b,,TracebackException.exc_type_str}. (Contribuição de Irit Katriel em gh-112332@footnote{https://github.com/python/cpython/issues/112332}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
Descontinua a não-documentada sintaxe de argumento nomeado para criação de classes @ref{2b0,,NamedTuple} (por exemplo, @code{Point = NamedTuple("Point", x=int, y=int)}), para ser removido no Python 3.15. Em vez disso, use as sintaxes baseada em classe ou a funcional. (Contribuição de Alex Waygood in gh-105566@footnote{https://github.com/python/cpython/issues/105566}.)

@item 
Descontinua a omissão do parâmetro `fields' ao criar uma classe @ref{2b0,,NamedTuple} ou @ref{162,,typing.TypedDict} e descontinua a passagem de @code{None} para o parâmetro `fields' de ambos os tipos. O Python 3.15 exigirá uma sequência válida para o parâmetro `fields'. Para criar uma classe NamedTuple com zero campos, use @code{class NT(NamedTuple): pass} ou @code{NT = NamedTuple("NT", ())}. Para criar uma classe TypedDict com zero campos, use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})}. (Contribuição de Alex Waygood em gh-105566@footnote{https://github.com/python/cpython/issues/105566} e gh-105570@footnote{https://github.com/python/cpython/issues/105570}.)

@item 
Descontinua o decorador de função @ref{2b1,,typing.no_type_check_decorator()} para ser removido no Python 3.15. Depois de oito anos no módulo @ref{104,,typing}, ele ainda não foi implementado por nenhum dos principais verificadores de tipos. (Contribuição de Alex Waygood em gh-106309@footnote{https://github.com/python/cpython/issues/106309}.)

@item 
Descontinua @ref{2b2,,typing.AnyStr}. No Python 3.16, isso será removido de @code{typing.__all__}, e uma @ref{1a5,,DeprecationWarning} será levantada em tempo de execução quando isso for importado ou acessado. Será removido completamente em Python 3.18. Em vez disso, use a nova @ref{2b3,,sintaxe de parâmetro de tipo}. (Contribuição de Michael The em gh-107116@footnote{https://github.com/python/cpython/issues/107116}.)
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
Descontinua os métodos @ref{2b4,,getmark()}, @code{setmark()} e @ref{2b5,,getmarkers()} das classes @ref{2b6,,Wave_read} e @ref{2b7,,Wave_write}, a serem removidos no Python 3.15. (Contribuição de Victor Stinner em 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
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17. 
* Remoção pendente no Python 3.18: Remoção pendente no Python 3 18. 
* Remoção pendente em versões futuras:: 

@end menu

@node Remoção pendente no Python 3 14,Remoção pendente no Python 3 15,,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-python-3-14}@anchor{2b8}
@subsubsection Remoção pendente no Python 3.14



@itemize *

@item 
@ref{6,,argparse}: Os parâmetros `type', `choices' e `metavar' de @code{argparse.BooleanOptionalAction} foram descontinuados e serão removidos na versão 3.14. (Contribuição de Nikita Sobolev em gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{8,,ast}: os seguintes recursos foram descontinuados na documentação desde Python 3.8, agora fazem com que um @ref{1a5,,DeprecationWarning} seja emitido em tempo de execução quando eles são acessados ou usados, e serão removidos no 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

Em vez disso, use @ref{2b9,,ast.Constant}. (Contribuição de Serhiy Storchaka em gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{a,,asyncio}:


@itemize *

@item 
As classes filhas dos observadores @ref{2ba,,MultiLoopChildWatcher}, @ref{2bb,,FastChildWatcher}, @ref{2bc,,AbstractChildWatcher} e @ref{2bd,,SafeChildWatcher} foram descontinuadas e serão removidas no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@ref{2be,,asyncio.set_child_watcher()}, @ref{2bf,,asyncio.get_child_watcher()}, @ref{2c0,,asyncio.AbstractEventLoopPolicy.set_child_watcher()} e @ref{2c1,,asyncio.AbstractEventLoopPolicy.get_child_watcher()} foram descontinuados e serão removidos no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
O método @ref{2c2,,get_event_loop()} da política de laço de eventos padrão agora emite um @ref{1a5,,DeprecationWarning} se não houver nenhum laço de eventos atual definido e decidir criar um. (Contribuição de Serhiy Storchaka e Guido van Rossum em gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{12,,builtins}: @code{bool(NotImplemented)} now emits a @ref{1a5,,DeprecationWarning}
and will raise a @ref{2c3,,TypeError} in Python 3.14.
(Contributed by Jelle Zijlstra in gh-118767@footnote{https://github.com/python/cpython/issues/118767}.)

@item 
@ref{3b,,email}: Descontinua o parâmetro `isdst' em @ref{2c4,,email.utils.localtime()}. (Contribuição de Alan Williams em gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc} descontinuou as classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Em vez disso, use classes de @ref{7c,,importlib.resources.abc}:


@itemize *

@item 
@ref{1f3,,importlib.resources.abc.Traversable}

@item 
@ref{2c5,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribuição de Jason R. Coombs e Hugo van Kemenade em gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools} tinha suporte não documentado, ineficiente, historicamente cheio de bugs e inconsistente para operações de cópia, cópia profunda e serialização com pickle. Isso será removido na versão 3.14 para uma redução significativa no volume de código e na carga de manutenção. (Contribuição de Raymond Hettinger em gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: o método de inicialização padrão será alterado para um mais seguro no Linux, BSDs e outras plataformas POSIX não-macOS onde @code{'fork'} é atualmente o padrão (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adicionar um aviso de tempo de execução sobre isso foi considerado muito perturbador, pois não se espera que a maior parte do código se importe. Use as APIs @ref{2c6,,get_context()} ou @ref{2c7,,set_start_method()} para especificar explicitamente quando seu código `requer' @code{'fork'}. Veja @ref{2c8,,Contextos e métodos de inicialização}.

@item 
@ref{a4,,pathlib}: @ref{2c9,,is_relative_to()} e @ref{2ca,,relative_to()}: passar argumentos adicionais foi descontinuado.

@item 
@ref{a9,,pkgutil}: @ref{2cb,,find_loader()} e @ref{2cc,,get_loader()} agora levantam @ref{1a5,,DeprecationWarning}; use @ref{2cd,,importlib.util.find_spec()}. (Contribuição de Nikita Sobolev em gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}:


@itemize *

@item 
@code{master_open()}: use @ref{2ce,,pty.openpty()}.

@item 
@code{slave_open()}: use @ref{2ce,,pty.openpty()}.
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@ref{2cf,,version} e @ref{2d0,,version_info}.

@item 
@ref{2d1,,execute()} e @ref{2d2,,executemany()} se @ref{2d3,,espaços reservados nomeados} forem usados e `parameters' for uma sequência em vez de um @ref{256,,dict} .
@end itemize

@item 
@ref{108,,urllib}: @code{urllib.parse.Quoter} está obsoleto: não foi planejado para ser uma API pública. (Contribuição de Gregory P. Smith em gh-88168@footnote{https://github.com/python/cpython/issues/88168}.)
@end itemize

@node Remoção pendente no Python 3 15,Remoção pendente no Python 3 16,Remoção pendente no Python 3 14,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-python-3-15}@anchor{2d4}
@subsubsection Remoção pendente no Python 3.15



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2d5,,__cached__} em um módulo enquanto falha na definição de @ref{2d6,,__spec__.cached} está descontinuado. No Python 3.15, @code{__cached__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
A definição de @ref{2d7,,__package__} em um módulo enquanto falha na definição de @ref{2d8,,__spec__.parent} está descontinuado. No Python 3.15, @code{__package__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2a,,ctypes}:


@itemize *

@item 
A função não documentada @code{ctypes.SetPointerType()} foi descontinuada desde o Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
A classe obsoleta e raramente usada @ref{2a1,,CGIHTTPRequestHandler} foi descontinuada desde o Python 3.13. Não existe substituição direta. `Qualquer coisa' é melhor que CGI para fazer a interface de um servidor web com um manipulador de requisição.

@item 
O sinalizador @code{--cgi} para a interface de linha de comando @code{python -m http.server} foi descontinuado desde o Python 3.13.
@end itemize

@item 
@ref{77,,importlib}:


@itemize *

@item 
Método @code{load_module()}: use @code{exec_module()}.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
A função @ref{2d9,,getdefaultlocale()} foi descontinuada desde o Python 3.11. Sua remoção foi planejada originalmente para o Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}), mas foi adiada para o Python 3.15. Em vez disso, use @ref{2da,,getlocale()}, @ref{2db,,setlocale()} e @ref{2dc,,getencoding()}. (Contribuição de Hugo van Kemenade em gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{2a6,,PurePath.is_reserved()} foi descontinuado desde o Python 3.13. Use @ref{223,,os.path.isreserved()} para detectar caminhos reservados no Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{2a7,,java_ver()} foi descontinuada desde o Python 3.13. Esta função é útil apenas para suporte Jython, tem uma API confusa e é amplamente não testada.
@end itemize

@item 
@ref{db,,sysconfig}:


@itemize *

@item 
O argumento `check_home' de @ref{2dd,,sysconfig.is_python_build()} foi descontinuado desde o Python 3.12.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{2de,,RLock()} não aceitará argumentos no Python 3.15. A passagem quaisquer argumentos foi descontinuada desde o Python 3.14, pois a versão Python não permite nenhum argumento, mas a versão C permite qualquer número de argumentos posicionais ou nomeados, ignorando todos os argumentos.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{2df,,types.CodeType}: o acesso a @ref{2e0,,co_lnotab} foi descontinuado na 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} desde 3.10 e foi planejado para ser removido em 3.12, mas só recebeu uma @ref{1a5,,DeprecationWarning} adequada em 3.12. Pode ser removido em 3.15. (Contribuição de Nikita Sobolev em gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
A não-documentada sintaxe de argumento nomeado para criar classes @ref{2b0,,NamedTuple} (por exemplo, @code{Point = NamedTuple("Point", x=int, y=int)}) foi descontinuada desde o Python 3.13. Em vez disso, use as sintaxes baseada em classe ou funcional.

@item 
Ao usar a sintaxe funcional de @ref{162,,TypedDict}s, não passar um valor para o parâmetro `fields' (@code{TD = TypedDict("TD")}) ou passar @code{None} (@code{TD = TypedDict("TD", None)}) foi está descontinuado desde o Python 3.13. Use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})} para criar uma classe TypedDict com nenhum campo.

@item 
A função decoradora @ref{2b1,,typing.no_type_check_decorator()} foi descontinuada desde o Python 3.13. Após oito anos no módulo @ref{104,,typing}, ela ainda não foi suportada por nenhum verificador de tipo importante.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
Os métodos @ref{2b4,,getmark()}, @code{setmark()} e @ref{2b5,,getmarkers()} das classes @ref{2b6,,Wave_read} e @ref{2b7,,Wave_write} foram descontinuados desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 16,Remoção pendente no Python 3 17,Remoção pendente no Python 3 15,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-python-3-16}@anchor{2e1}
@subsubsection Remoção pendente no Python 3.16



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2e2,,__loader__} em um módulo enquanto falha na definição de @ref{2e3,,__spec__.loader} está descontinuado. No Python 3.16, @code{__loader__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão.
@end itemize

@item 
@ref{7,,array}:


@itemize *

@item 
O código de formato @code{'u'} (@code{wchar_t}) foi descontinuado na documentação desde o Python 3.3 e do ambiente de execução desde o Python 3.13. Em vez disso, use o código de formato @code{'w'} (@ref{29b,,Py_UCS4}) para caracteres Unicode.
@end itemize

@item 
@ref{a,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} foi descontinuado e será removido no Python 3.16, use @ref{2e4,,inspect.iscoroutinefunction()} em vez disso. (Contribuição de Jiahao Li e Kumar Aditya em gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{12,,builtins}:


@itemize *

@item 
A inversão bit a bit em tipos booleanos, @code{~True} ou @code{~False} foi descontinuada desde o Python 3.12, pois produz resultados surpreendentes e não intuitivos (@code{-2} e @code{-1}). Em vez disso, use @code{not x} para a negação lógica de um booleano. No caso raro de você precisar da inversão bit a bit do inteiro subjacente, converta para @code{int} explicitamente (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
A exceção @code{ExecError} foi descontinuada desde o Python 3.14. Ela não foi usada por nenhuma função em @code{shutil} desde o Python 3.4, e agora é um alias de @ref{195,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
O método @ref{2e5,,Class.get_methods} foi descontinuado desde o Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
A função @ref{2ae,,_enablelegacywindowsfsencoding()} foi descontinuada desde o Python 3.13. Em vez disso, use a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING}.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
O atributo não documentado e não utilizado @code{TarFile.tarfile} foi descontinuado desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 17,Remoção pendente no Python 3 18,Remoção pendente no Python 3 16,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-python-3-17}@anchor{2e6}
@subsubsection Remoção pendente no Python 3.17



@itemize *

@item 
@ref{1e,,collections.abc}:


@itemize -

@item 
@ref{2e7,,collections.abc.ByteString} está agendado para remoção no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize -

@item 
Antes do Python 3.14, as uniões antigas eram implementadas usando a classe privada @code{typing._UnionGenericAlias}. Essa classe não é mais necessária para a implementação, mas foi mantida para compatibilidade com versões anteriores, com remoção prevista para o Python 3.17. Os usuários devem usar auxiliares de introspecção documentados, como @ref{2ec,,typing.get_origin()} e @ref{2ed,,typing.get_args()}, em vez de depender de detalhes de implementação privada.

@item 
@ref{2ee,,typing.ByteString}, obsoleto desde o Python 3.9, está programado para ser removido no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize
@end itemize

@node Remoção pendente no Python 3 18,Remoção pendente em versões futuras,Remoção pendente no Python 3 17,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-python-3-18}@anchor{2ef}
@subsubsection Remoção pendente no Python 3.18



@itemize *

@item 
@ref{36,,decimal}:


@itemize *

@item 
O especificador de formato de @ref{29d,,Decimal} não padrão e não documentado @code{'N'}, que só é suportado na implementação C do módulo @code{decimal}, foi descontinuada desde o Python 3.13. (Contribuição de Serhiy Storchaka em gh-89902@footnote{https://github.com/python/cpython/issues/89902}.)
@end itemize
@end itemize

@node Remoção pendente em versões futuras,,Remoção pendente no Python 3 18,Novas descontinuações
@anchor{whatsnew/3 13 pending-removal-in-future-versions}@anchor{2f0}
@subsubsection Remoção pendente em versões futuras


As APIs a seguir serão removidas no futuro, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{6,,argparse}: o aninhamento de grupos de argumentos e o aninhamento de grupos mutuamente exclusivos estão descontinuados.

@item 
@ref{12,,builtins}:


@itemize *

@item 
Geradores: a assinatura @code{throw(type, exc, tb)} e @code{athrow(type, exc, tb)} está descontinuada: use @code{throw(exc)} e @code{athrow(exc)}, a assinatura do argumento único.

@item 
Atualmente Python aceita literais numéricos imediatamente seguidos por palavras reservadas como, por exemplo, @code{0in x}, @code{1or x}, @code{0if 1else 2}. Ele permite expressões confusas e ambíguas como @code{[0x1for x in y]} (que pode ser interpretada como @code{[0x1 for x in y]} ou @code{[0x1f or x in y]}). Um aviso de sintaxe é levantado se o literal numérico for imediatamente seguido por uma das palavras reservadas @ref{2f1,,and}, @ref{18c,,else}, @ref{2f2,,for}, @ref{2f3,,if}, @ref{2f4,,in} , @ref{2f5,,is} e @ref{2f6,,or}. Em uma versão futura, será alterado para um erro de sintaxe. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Suporte para métodos @code{__index__()} e @code{__int__()} retornando tipo não-int: esses métodos serão necessários para retornar uma instância de uma subclasse estrita de @ref{257,,int}.

@item 
Suporte para o método @code{__float__()} retornando uma subclasse estrita de @ref{2f7,,float}: esses métodos serão necessários para retornar uma instância de @ref{2f7,,float}.

@item 
Suporte para o método @code{__complex__()} retornando uma subclasse estrita de @ref{2f8,,complex}: esses métodos serão necessários para retornar uma instância de @ref{2f8,,complex}.

@item 
Delegação do método @code{int()} para o @code{__trunc__()}.

@item 
Passar um número complexo como argumento `real' ou `imag' no construtor @ref{2f8,,complex()} agora está descontinuado; deve ser passado apenas como um único argumento posicional. (Contribuição de Serhiy Storchaka em gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{14,,calendar}: as constantes @code{calendar.January} e @code{calendar.February} foram descontinuadas e substituídas por @ref{2f9,,calendar.JANUARY} e @ref{2fa,,calendar.FEBRUARY}. (Contribuição de Prince Roshan em gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{2e0,,codeobject.co_lnotab}: use o método @ref{2fb,,codeobject.co_lines()}.

@item 
@ref{30,,datetime}:


@itemize *

@item 
@ref{2fc,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{2fd,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: o valor de plural deve ser um número inteiro.

@item 
@ref{77,,importlib}:


@itemize *

@item 
O parâmetro `debug_override' de @ref{2fe,,cache_from_source()} foi descontinuado: use o parâmetro `optimization'.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
Interface de tupla @code{EntryPoints}.

@item 
@code{None} implícito nos valores de retorno.
@end itemize

@item 
@ref{87,,logging}: o método @code{warn()} foi descontinuado desde o Python 3.3, use @ref{2ff,,warning()}.

@item 
@ref{8b,,mailbox}: o uso da entrada StringIO e do modo de texto foi descontinuado; em vez disso, use BytesIO e o modo binário.

@item 
@ref{a1,,os}: chame @ref{300,,os.register_at_fork()} em processo multithread.

@item 
@code{pydoc.ErrorDuringImport}: um valor de tupla para o parâmetro `exc_info' foi descontinuado, use uma instância de exceção.

@item 
@ref{b9,,re}: regras mais rigorosas agora são aplicadas para referências numéricas de grupos e nomes de grupos em expressões regulares. Apenas a sequência de dígitos ASCII agora é aceita como referência numérica. O nome do grupo em padrões de bytes e strings de substituição agora pode conter apenas letras e dígitos ASCII e sublinhado. (Contribuição de Serhiy Storchaka em gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
Módulos @code{sre_compile}, @code{sre_constants} e @code{sre_parse}.

@item 
@ref{c5,,shutil}: o parâmetro `onerror' de @ref{301,,rmtree()} foi descontinuado no Python 3.12; use o parâmetro `onexc'.

@item 
Protocolos e opções de @ref{d0,,ssl}


@itemize *

@item 
@ref{294,,ssl.SSLContext} sem argumento de protocolo foi descontinuado.

@item 
@ref{294,,ssl.SSLContext}: @ref{302,,set_npn_protocols()} e @code{selected_npn_protocol()} foram descontinuados, use ALPN.

@item 
Opções de @code{ssl.OP_NO_SSL*}

@item 
Opções de @code{ssl.OP_NO_TLS*}

@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 
Métodos de @ref{ed,,threading}:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{303,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{304,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{305,,threading.Thread.setDaemon()}: use o atributo @ref{306,,threading.Thread.daemon}.

@item 
@code{threading.Thread.getName()}, @ref{307,,threading.Thread.setName()}: use o atributo @ref{308,,threading.Thread.name}.

@item 
@code{threading.currentThread()}: use @ref{309,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{30a,,threading.active_count()}.
@end itemize

@item 
@ref{30b,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{30c,,unittest.IsolatedAsyncioTestCase}: foi descontinuado retornar um valor que não seja @code{None} de um caso de teste.

@item 
Funções descontinuadas de @ref{10a,,urllib.parse}: use @ref{30d,,urlparse()}


@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}: o estilo de @ref{30e,,URLopener} e @ref{30f,,FancyURLopener} de invocar solicitações foi descontinuado. Use as mais novas funções e métodos @ref{293,,urlopen()}.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} não deve fazer gravações parciais.

@item 
@ref{125,,xml.etree.ElementTree}: testar o valor verdade de um @ref{310,,Element} está descontinuado. Em um lançamento futuro isso sempre retornará @code{True}. Em vez disso, prefira os testes explícitos @code{len(elem)} ou @code{elem is not None}.

@item 
@ref{311,,zipimport.zipimporter.load_module()} foi descontinuado: use @ref{312,,exec_module()}.
@end itemize

@node Alterações de bytecode do CPython,Alterações na API C,Novas descontinuações,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 cpython-bytecode-changes}@anchor{313}
@subsection Alterações de bytecode do CPython



@itemize *

@item 
O oparg de @ref{314,,YIELD_VALUE} agora é @code{1} se o yield fizer parte de um yield-from ou um await, e @code{0} caso contrário. O oparg de @ref{315,,RESUME} foi alterado para adicionar um bit indicando se a profundidade de exceção é 1, o que é necessário para otimizar o fechamento dos geradores. (Contribuição de Irit Katriel em gh-111354@footnote{https://github.com/python/cpython/issues/111354}.)
@end itemize

@node Alterações na API C,Mudanças na construção,Alterações de bytecode do CPython,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 c-api-changes}@anchor{316}
@subsection Alterações na API C


@menu
* Novas funcionalidades: Novas funcionalidades<2>. 
* Alterações na API C: Alterações na API C<2>. 
* Mudanças na API C Limitada:: 
* APIs C removidas:: 
* APIs C descontinuadas:: 

@end menu

@node Novas funcionalidades<2>,Alterações na API C<2>,,Alterações na API C
@anchor{whatsnew/3 13 id7}@anchor{317}
@subsubsection Novas funcionalidades



@itemize *

@item 
Adiciona a @ref{15c,,API C PyMonitoring C} para gerar eventos de monitoramento da 
@geindex Propostas de Melhorias do Python; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/}:


@itemize *

@item 
@ref{318,,PyMonitoringState}

@item 
@ref{319,,PyMonitoring_FirePyStartEvent()}

@item 
@ref{31a,,PyMonitoring_FirePyResumeEvent()}

@item 
@ref{31b,,PyMonitoring_FirePyReturnEvent()}

@item 
@ref{31c,,PyMonitoring_FirePyYieldEvent()}

@item 
@ref{31d,,PyMonitoring_FireCallEvent()}

@item 
@ref{31e,,PyMonitoring_FireLineEvent()}

@item 
@ref{31f,,PyMonitoring_FireJumpEvent()}

@item 
@ref{320,,PyMonitoring_FireBranchEvent()}

@item 
@ref{321,,PyMonitoring_FireCReturnEvent()}

@item 
@ref{322,,PyMonitoring_FirePyThrowEvent()}

@item 
@ref{323,,PyMonitoring_FireRaiseEvent()}

@item 
@ref{324,,PyMonitoring_FireCRaiseEvent()}

@item 
@ref{325,,PyMonitoring_FireReraiseEvent()}

@item 
@ref{326,,PyMonitoring_FireExceptionHandledEvent()}

@item 
@ref{327,,PyMonitoring_FirePyUnwindEvent()}

@item 
@ref{328,,PyMonitoring_FireStopIterationEvent()}

@item 
@ref{329,,PyMonitoring_EnterScope()}

@item 
@ref{32a,,PyMonitoring_ExitScope()}
@end itemize

(Contribuição de Irit Katriel em gh-111997@footnote{https://github.com/python/cpython/issues/111997}).

@item 
Adiciona @ref{15b,,PyMutex}, um mutex leve que ocupa um único byte, e as novas funções @ref{32b,,PyMutex_Lock()} e @ref{32c,,PyMutex_Unlock()}. @code{PyMutex_Lock()} irá liberar a @ref{159,,GIL} (se atualmente mantida) se a operação precisar de bloqueio. (Contribuição de Sam Gross em gh-108724@footnote{https://github.com/python/cpython/issues/108724}.)

@item 
Adiciona a @ref{15a,,API C PyTime}, fornecendo acesso aos relógios do sistema.


@itemize *

@item 
@ref{32d,,PyTime_t}.

@item 
@ref{32e,,PyTime_MIN} e @ref{32f,,PyTime_MAX}.

@item 
@ref{330,,PyTime_AsSecondsDouble()}.

@item 
@ref{331,,PyTime_Monotonic()}.

@item 
@ref{332,,PyTime_MonotonicRaw()}.

@item 
@ref{333,,PyTime_PerfCounter()}.

@item 
@ref{334,,PyTime_PerfCounterRaw()}.

@item 
@ref{335,,PyTime_Time()}.

@item 
@ref{336,,PyTime_TimeRaw()}.
@end itemize

(Contribuição de Victor Stinner e Petr Viktorin em gh-110850@footnote{https://github.com/python/cpython/issues/110850}.)

@item 
Adiciona a função @ref{337,,PyDict_ContainsString()} com o mesmo comportamento de @ref{338,,PyDict_Contains()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*. (Contribuição de Victor Stinner em gh-108314@footnote{https://github.com/python/cpython/issues/108314}.)

@item 
Adiciona as funções @ref{33a,,PyDict_GetItemRef()} e @ref{33b,,PyDict_GetItemStringRef()} functions, que são semelhantes a @ref{33c,,PyDict_GetItemWithError()}, mas retornam uma  @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada}. Além disso, essas funções retornam @code{-1} em caso de erro, dispensando a necessidade de checar @code{PyErr_Occurred()}. (Contribuição de Victor Stinner em gh-106004@footnote{https://github.com/python/cpython/issues/106004}.)

@item 
Adiciona a função @ref{33f,,PyDict_SetDefaultRef()}, que é semelhante a @ref{340,,PyDict_SetDefault()}, mas retorna uma @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada}. Esta função retorna @code{-1} em caso de erro, @code{0} na inserção e @code{1} se a chave já estivesse presente no dicionário. (Contribuição de Sam Gross em gh-112066@footnote{https://github.com/python/cpython/issues/112066}.)

@item 
Adiciona as funções @ref{341,,PyDict_Pop()} e @ref{342,,PyDict_PopString()} para remover uma chave de um dicionário e, opcionalmente, retornam o valor removido. Isto é semelhante a @ref{343,,dict.pop()}, mas sem o valor padrão e sem levantar @ref{344,,KeyError} se a chave estiver ausente. (Contribuição de Stefan Behnel e Victor Stinner em gh-111262@footnote{https://github.com/python/cpython/issues/111262}.)

@item 
Adiciona as funções @ref{345,,PyMapping_GetOptionalItem()} e @ref{346,,PyMapping_GetOptionalItemString()} como alternativas a @ref{347,,PyObject_GetAttr()} e @ref{348,,PyObject_GetAttrString()}, respectivamente. As novas funções não levantam @ref{344,,KeyError} se o atributo não for encontrado no mapeamento. Essas variantes são mais convenientes e rápidas se o atributo ausente não for tratado como uma falha. (Contribuição de Serhiy Storchaka em gh-106307@footnote{https://github.com/python/cpython/issues/106307}.)

@item 
Adiciona as funções @ref{349,,PyObject_GetOptionalAttr()} e @ref{34a,,PyObject_GetOptionalAttrString()}, variantes de @ref{347,,PyObject_GetAttr()} e @ref{348,,PyObject_GetAttrString()}, respectivamente. Essas novas funções não levantam @ref{34b,,AttributeError} se o atributo não for encontrado. Essas variantes são mais convenientes e rápidas se o atributo ausente não for tratado como uma falha. (Contribuição de Serhiy Storchaka em gh-106521@footnote{https://github.com/python/cpython/issues/106521}.)

@item 
Adiciona a função @ref{34c,,PyErr_FormatUnraisable()} como uma extensão para @ref{34d,,PyErr_WriteUnraisable()}, que permite personalizar a mensagem de aviso. (Contribuição de Serhiy Storchaka em gh-108082@footnote{https://github.com/python/cpython/issues/108082}.)

@item 
Adiciona novas funções que retornam uma @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada} para quadros locais, globais, e embutidos, como parte de @ref{142,,PEP 667}:


@itemize *

@item 
@ref{34e,,PyEval_GetFrameBuiltins()} substitui @ref{34f,,PyEval_GetBuiltins()}

@item 
@ref{350,,PyEval_GetFrameGlobals()} substitui @ref{351,,PyEval_GetGlobals()}

@item 
@ref{352,,PyEval_GetFrameLocals()} substitui @ref{353,,PyEval_GetLocals()}
@end itemize

(Contribuição de Mark Shannon e Tian Gao em gh-74929@footnote{https://github.com/python/cpython/issues/74929}.)

@item 
Adiciona as funções @ref{354,,Py_GetConstant()} e @ref{355,,Py_GetConstantBorrowed()} para referências @ref{33d,,fortes} ou @ref{33e,,emprestadas} para constantes. Por exemplo, @code{Py_GetConstant(Py_CONSTANT_ZERO)} retorna uma referência forte para a constante zero. (Contribuição de Victor Stinner em gh-115754@footnote{https://github.com/python/cpython/issues/115754}.)

@item 
Adiciona a função @ref{356,,PyImport_AddModuleRef()} como uma substituta para @ref{357,,PyImport_AddModule()} mas retorna uma @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada}. (Contribuição de Victor Stinner em gh-105922@footnote{https://github.com/python/cpython/issues/105922}.)

@item 
Adiciona a função @ref{358,,Py_IsFinalizing()} para verificar se o interpretador Python principal está @ref{14e,,sendo desligado}. (Contribuição de Victor Stinner em gh-108014@footnote{https://github.com/python/cpython/issues/108014}.)

@item 
Adiciona a função @ref{359,,PyList_GetItemRef()} como uma substituta para @ref{35a,,PyList_GetItem()} mas que retorna uma @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada}. (Contribuição de Sam Gross em gh-114329@footnote{https://github.com/python/cpython/issues/114329}.)

@item 
Adiciona as funções @ref{35b,,PyList_Extend()} e @ref{35c,,PyList_Clear()}, espelhando os métodos @ref{35d,,list.extend()} e @ref{35e,,list.clear()} do Python. (Contribuição de Victor Stinner em gh-111138@footnote{https://github.com/python/cpython/issues/111138}.)

@item 
Adiciona a função @ref{35f,,PyLong_AsInt()}, semelhante à @ref{360,,PyLong_AsLong()}, mas armazena o resultado em um int em vez de um long em C. (Contribuição de Victor Stinner em gh-108014@footnote{https://github.com/python/cpython/issues/108014}.)

@item 
Adiciona as funções @ref{361,,PyLong_AsNativeBytes()}, @ref{362,,PyLong_FromNativeBytes()} e @ref{363,,PyLong_FromUnsignedNativeBytes()} para simplificar a conversão entre tipos inteiros nativos e objetos @ref{257,,int} do Python. (Contribuição de Steve Dower em gh-111140@footnote{https://github.com/python/cpython/issues/111140}.)

@item 
Adiciona a função @ref{364,,PyModule_Add()}, que é semelhante a @ref{365,,PyModule_AddObjectRef()} e @ref{366,,PyModule_AddObject()}, mas sempre rouba uma referência ao valor. (Contribuição de Serhiy Storchaka em gh-86493@footnote{https://github.com/python/cpython/issues/86493}.)

@item 
Adiciona a função @ref{367,,PyObject_GenericHash()} que implementa a função hashing padrão de um objeto Python. (Contribuição de Serhiy Storchaka em gh-113024@footnote{https://github.com/python/cpython/issues/113024}.)

@item 
Adiciona a função @ref{368,,Py_HashPointer()} para fazer hash de um ponteiro. (Contribuição de Victor Stinner em gh-111545@footnote{https://github.com/python/cpython/issues/111545}.)

@item 
Adiciona as funções @ref{369,,PyObject_VisitManagedDict()} e @ref{36a,,PyObject_ClearManagedDict()} que devem ser chamadas pelas funções traverse e clear de um tipo usando o sinalizador @ref{36b,,Py_TPFLAGS_MANAGED_DICT}. O projeto pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat/} pode ser usado para obter essas funções no Python 3.11 e 3.12. (Contribuição de Victor Stinner em gh-107073@footnote{https://github.com/python/cpython/issues/107073}.)

@item 
Adiciona as funções @ref{36c,,PyRefTracer_SetTracer()} e @ref{36d,,PyRefTracer_GetTracer()}, que permitem rastrear a criação e destruição de objetos da mesma forma que o módulo @ref{ff,,tracemalloc}. (Contribuição de Pablo Galindo em gh-93502@footnote{https://github.com/python/cpython/issues/93502}.)

@item 
Adiciona a função @ref{36e,,PySys_AuditTuple()} como uma alternativa à @ref{36f,,PySys_Audit()}, que recebe argumentos de evento como um objeto @ref{370,,tuple} do Python. (Contribuição de Victor Stinner em gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)

@item 
Adiciona a função @ref{371,,PyThreadState_GetUnchecked()} como uma alternativa a @ref{372,,PyThreadState_Get()} que não mata o processo com um erro fatal se for @code{NULL}. O chamador é responsável por verificar se o resultado é @code{NULL}. (Contribuição de Victor Stinner em gh-108867@footnote{https://github.com/python/cpython/issues/108867}.)

@item 
Adiciona a função @ref{373,,PyType_GetFullyQualifiedName()} para obter o nome totalmente qualificado do tipo. O nome do módulo é prefixado se @ref{374,,type.__module__} for uma string e não for igual a @code{'builtins'} ou @code{'__main__'}. (Contribuição de Victor Stinner em gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
Adiciona a função @ref{375,,PyType_GetModuleName()} para obter o nome do módulo do tipo. Isto é equivalente a obter o atributo @ref{374,,type.__module__}. (Contribuição de Eric Snow e Victor Stinner em gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
Adiciona as funções @ref{376,,PyUnicode_EqualToUTF8AndSize()} e @ref{377,,PyUnicode_EqualToUTF8()}: comparam o objeto Unicode com uma string const char* codificada em UTF-8 e retornam @code{1} se forem iguais ou @code{0} caso contrário. Essas funções não levantam exceções. (Contribuição de Serhiy Storchaka em gh-110289@footnote{https://github.com/python/cpython/issues/110289}.)

@item 
Adiciona a função @ref{378,,PyWeakref_GetRef()} como uma alternativa a @ref{379,,PyWeakref_GetObject()}, mas retorna uma @ref{33d,,referência forte}, ou @code{NULL} se o referente não mais existir. (Contribuição de Victor Stinner em gh-105927@footnote{https://github.com/python/cpython/issues/105927}.)

@item 
Adiciona variantes fixas de funções que ignoram erros silenciosamente:


@itemize *

@item 
@ref{37a,,PyObject_HasAttrWithError()} substitui @ref{37b,,PyObject_HasAttr()}.

@item 
@ref{37c,,PyObject_HasAttrStringWithError()} substitui @ref{37d,,PyObject_HasAttrString()}.

@item 
@ref{37e,,PyMapping_HasKeyWithError()} substitui @ref{37f,,PyMapping_HasKey()}.

@item 
@ref{380,,PyMapping_HasKeyStringWithError()} substitui @ref{381,,PyMapping_HasKeyString()}.
@end itemize

As novas funções retornam @code{-1} para erros e o padrão @code{1} para verdadeiro e @code{0} para falso.

(Contribuição de Serhiy Storchaka em gh-108511@footnote{https://github.com/python/cpython/issues/108511}.)
@end itemize

@node Alterações na API C<2>,Mudanças na API C Limitada,Novas funcionalidades<2>,Alterações na API C
@anchor{whatsnew/3 13 changed-c-apis}@anchor{382}
@subsubsection Alterações na API C



@itemize *

@item 
O parâmetro `keywords' das funções @ref{383,,PyArg_ParseTupleAndKeywords()} e @ref{384,,PyArg_VaParseTupleAndKeywords()} agora é do tipo char *const* em C e const char *const* em C++, em vez de char**. Em C++, isso torna essas funções compatíveis com argumentos dos tipos const char *const*, const char**, ou char *const* sem uma conversão de tipo explícita. Em C, as funções aceitam apenas argumentos do tipo char *const*. Isso pode ser sobrescrito com a macro @ref{385,,PY_CXX_CONST}. (Contribuição de Serhiy Storchaka em gh-65210@footnote{https://github.com/python/cpython/issues/65210}.)

@item 
@ref{383,,PyArg_ParseTupleAndKeywords()} agora oferece suporte a nomes de parâmetros nomeados não-ASCII. (Contribuição de Serhiy Storchaka em gh-110815@footnote{https://github.com/python/cpython/issues/110815}.)

@item 
A função @code{PyCode_GetFirstFree()} é agora uma API instável e foi renomeada para @ref{386,,PyUnstable_Code_GetFirstFree()}. (Contribuição de Bogdan Romanyuk em gh-115781@footnote{https://github.com/python/cpython/issues/115781}.)

@item 
As funções @ref{387,,PyDict_GetItem()}, @ref{388,,PyDict_GetItemString()}, @ref{37f,,PyMapping_HasKey()}, @ref{381,,PyMapping_HasKeyString()}, @ref{37b,,PyObject_HasAttr()}, @ref{37d,,PyObject_HasAttrString()}, e @ref{389,,PySys_GetObject()}, que apagam todos os erros que ocorrem ao chamá-las, agora reportam tais erros usando @ref{1f7,,sys.unraisablehook()}. Você pode substituí-las por outras funções conforme recomendado na documentação. (Contribuição de Serhiy Storchaka em gh-106672@footnote{https://github.com/python/cpython/issues/106672}.)

@item 
Adiciona suporte para os formatos @code{%T}, @code{%#T}, @code{%N} e @code{%#N} a @ref{38a,,PyUnicode_FromFormat()}:


@itemize *

@item 
@code{%T}: Obtém o nome totalmente qualificado de um tipo de objeto

@item 
@code{%#T}: Como acima, mas usa dois pontos como separador

@item 
@code{%N}: Obtém o nome totalmente qualificado de um tipo

@item 
@code{%#N}: Como acima, mas usa dois pontos como separador
@end itemize

Veja 
@geindex Propostas de Melhorias do Python; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} para uma descrição completa. (Contribuição de Victor Stinner em gh-111696@footnote{https://github.com/python/cpython/issues/111696}.)

@item 
Você não precisa mais definir a macro @code{PY_SSIZE_T_CLEAN} antes de incluir @code{Python.h} ao usar formatos @code{#} em @ref{38b,,códigos de formato}. APIs que aceitam os códigos de formato sempre usam @code{Py_ssize_t} para formatos @code{#}. (Contribuição de Inada Naoki em gh-104922@footnote{https://github.com/python/cpython/issues/104922}.)

@item 
Se Python for construído em @ref{1f9,,modo de depuração} ou @ref{38c,,com asserções}, @ref{38d,,PyTuple_SET_ITEM()} e @ref{38e,,PyList_SET_ITEM()} agora verificam o argumento do índice com uma asserção. (Contribuição de Victor Stinner em gh-106168@footnote{https://github.com/python/cpython/issues/106168}.)
@end itemize

@node Mudanças na API C Limitada,APIs C removidas,Alterações na API C<2>,Alterações na API C
@anchor{whatsnew/3 13 limited-c-api-changes}@anchor{38f}
@subsubsection Mudanças na API C Limitada



@itemize *

@item 
As seguintes funções agora estão incluídas na API C limitada:


@itemize *

@item 
@ref{390,,PyMem_RawMalloc()}

@item 
@ref{391,,PyMem_RawCalloc()}

@item 
@ref{392,,PyMem_RawRealloc()}

@item 
@ref{393,,PyMem_RawFree()}

@item 
@ref{36f,,PySys_Audit()}

@item 
@ref{36e,,PySys_AuditTuple()}

@item 
@ref{394,,PyType_GetModuleByDef()}
@end itemize

(Contributed by Victor Stinner in gh-85283@footnote{https://github.com/python/cpython/issues/85283} and gh-116936@footnote{https://github.com/python/cpython/issues/116936}.)

@item 
Python construído com @ref{395,,--with-trace-refs} (referências de rastreamento) agora oferece suporte à @ref{396,,API Limitada}. (Contribuição de Victor Stinner em gh-108634@footnote{https://github.com/python/cpython/issues/108634}.)
@end itemize

@node APIs C removidas,APIs C descontinuadas,Mudanças na API C Limitada,Alterações na API C
@anchor{whatsnew/3 13 removed-c-apis}@anchor{397}
@subsubsection APIs C removidas



@itemize *

@item 
Remove diversas funções, macros, variáveis, etc com nomes prefixados por @code{_Py} ou @code{_PY} (consideradas como API privada). Se o seu projeto for afetado por uma dessas remoções e você acreditar que a API removida deve permanecer disponível, por favor @ref{24e,,abra um novo relatório de problema} para solicitar uma API C pública e adicione @code{cc: @@vstinner} ao problema para notificar Victor Stinner. (Contribuição de Victor Stinner em gh-106320@footnote{https://github.com/python/cpython/issues/106320}.)

@item 
Remove protocolos de buffer antigos descontinuados no Python 3.0: use @ref{2e8,,Protocolo de buffer}.


@itemize *

@item 
@code{PyObject_CheckReadBuffer()}: use @ref{398,,PyObject_CheckBuffer()} para testar se o objeto oferece suporte ao protocolo de buffer. Observe que @ref{398,,PyObject_CheckBuffer()} não garante que @ref{399,,PyObject_GetBuffer()} terá sucesso. Para testar se o objeto é realmente legível, veja o próximo exemplo de @ref{399,,PyObject_GetBuffer()}.

@item 
@code{PyObject_AsCharBuffer()}, @code{PyObject_AsReadBuffer()}: use @ref{399,,PyObject_GetBuffer()} e @ref{39a,,PyBuffer_Release()}:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) < 0) @{
    return NULL;
@}
// Usa `view.buf` e `view.len` para ler do buffer.
// Você pode precisar converter buf como `(const char*)view.buf`.
PyBuffer_Release(&view);
@end example

@item 
@code{PyObject_AsWriteBuffer()}: use @ref{399,,PyObject_GetBuffer()} e @ref{39a,,PyBuffer_Release()}:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_WRITABLE) < 0) @{
    return NULL;
@}
// Usa `view.buf` e `view.len` para gravar no buffer.
PyBuffer_Release(&view);
@end example
@end itemize

(Contribuição de Inada Naoki in gh-85275@footnote{https://github.com/python/cpython/issues/85275}.)

@item 
Remove diversas funções descontinuadas no Python 3.9:


@itemize *

@item 
@code{PyEval_CallObject()}, @code{PyEval_CallObjectWithKeywords()}: use @ref{39b,,PyObject_CallNoArgs()} ou @ref{39c,,PyObject_Call()}.

@cartouche
@quotation Aviso 
Os argumentos posicionais de @ref{39c,,PyObject_Call()} devem ser uma @ref{370,,tuple} e não podem ser @code{NULL}, os argumentos nomeados devem ser @ref{256,,dict} ou @code{NULL}, enquanto funções removidas verificavam o tipo de argumentos e aceitavam argumentos posicionais e nomeados @code{NULL}. Para substituir @code{PyEval_CallObjectWithKeywords(func, NULL, kwargs)} por @ref{39c,,PyObject_Call()}, passe uma tupla vazia como argumentos posicionais usando @ref{39d,,PyTuple_New(0)}.
@end quotation
@end cartouche

@item 
@code{PyEval_CallFunction()}: use @ref{39e,,PyObject_CallFunction()}.

@item 
@code{PyEval_CallMethod()}: use @ref{39f,,PyObject_CallMethod()}.

@item 
@code{PyCFunction_Call()}: use @ref{39c,,PyObject_Call()}.
@end itemize

(Contribuição de Victor Stinner em gh-105107@footnote{https://github.com/python/cpython/issues/105107}.)

@item 
Remove as seguintes funções antigas da configuração de inicialização do Python, descontinuadas no Python 3.11:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}: use @ref{3a0,,PyConfig.warnoptions}.

@item 
@code{PySys_AddWarnOption()}: use @ref{3a0,,PyConfig.warnoptions}.

@item 
@code{PySys_AddXOption()}: use @ref{3a1,,PyConfig.xoptions}.

@item 
@code{PySys_HasWarnOptions()}: use @ref{3a1,,PyConfig.xoptions}.

@item 
@code{PySys_SetPath()}: defina @ref{3a2,,PyConfig.module_search_paths}.

@item 
@code{Py_SetPath()}: defina @ref{3a2,,PyConfig.module_search_paths}.

@item 
@code{Py_SetStandardStreamEncoding()}: defina @ref{3a3,,PyConfig.stdio_encoding}, e também talvez @ref{3a4,,PyConfig.legacy_windows_stdio} (no Windows).

@item 
@code{_Py_SetProgramFullPath()}: defina @ref{3a5,,PyConfig.executable}.
@end itemize

Em vez disso, use a nova API @ref{3a6,,PyConfig} da @ref{3a7,,Configuração de Inicialização do Python} (
@geindex Propostas de Melhorias do Python; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}), adicionada ao Python 3.8. (Contribuição de Victor Stinner em gh-105145@footnote{https://github.com/python/cpython/issues/105145}.)

@item 
Remove as funções @code{PyEval_AcquireLock()} e @code{PyEval_ReleaseLock()}, descontinuadas no Python 3.2. Eles não atualizavam o estado atual da thread. Elas podem ser substituídas por:


@itemize *

@item 
@ref{3a8,,PyEval_SaveThread()} e @ref{3a9,,PyEval_RestoreThread()};

@item 
@ref{3aa,,PyEval_AcquireThread()} e @ref{3a9,,PyEval_RestoreThread()} de baixo nível;

@item 
ou @ref{3ab,,PyGILState_Ensure()} e @ref{3ac,,PyGILState_Release()}.
@end itemize

(Contribuição de Victor Stinner em gh-105182@footnote{https://github.com/python/cpython/issues/105182}.)

@item 
Remove a função @code{PyEval_ThreadsInitialized()}, descontinuada no Python 3.9. Desde Python 3.7, @code{Py_Initialize()} sempre cria a GIL: chamar @code{PyEval_InitThreads()} não faz nada e @code{PyEval_ThreadsInitialized()} sempre retorna diferente de zero. (Contribuição de Victor Stinner em gh-105182@footnote{https://github.com/python/cpython/issues/105182}.)

@item 
Remove o apelido @code{_PyInterpreterState_Get()} de @ref{3ad,,PyInterpreterState_Get()} que era mantido para compatibilidade com versões anteriores do Python 3.8. O projeto pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat/}  pode ser usado para obter @ref{3ad,,PyInterpreterState_Get()} no Python 3.8 e versões anteriores. (Contribuição de Victor Stinner em gh-106320@footnote{https://github.com/python/cpython/issues/106320}.)

@item 
Remove a função privada @code{_PyObject_FastCall()}: use @code{PyObject_Vectorcall()}, a qual está disponível desde Python 3.8 (
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}). (Contribuição de Victor Stinner em gh-106023@footnote{https://github.com/python/cpython/issues/106023}.)

@item 
Remove o arquivo de cabeçalho @code{cpython/pytime.h}, que continha apenas funções privadas. (Contribuição de Victor Stinner em gh-106316@footnote{https://github.com/python/cpython/issues/106316}.)

@item 
Remove a constante não documentada @code{PY_TIMEOUT_MAX} da API C limitada. (Contribuição de Victor Stinner em gh-110014@footnote{https://github.com/python/cpython/issues/110014}.)

@item 
Remove as antigas macros de trashcan @code{Py_TRASHCAN_SAFE_BEGIN} e @code{Py_TRASHCAN_SAFE_END}. Substitua ambas pelas novas macros @code{Py_TRASHCAN_BEGIN} e @code{Py_TRASHCAN_END}. (Contribuição de Irit Katriel em gh-105111@footnote{https://github.com/python/cpython/issues/105111}.)
@end itemize

@node APIs C descontinuadas,,APIs C removidas,Alterações na API C
@anchor{whatsnew/3 13 deprecated-c-apis}@anchor{3ae}
@subsubsection APIs C descontinuadas



@itemize *

@item 
Descontinua antigas funções de inicialização do Python:


@itemize *

@item 
@ref{3af,,PySys_ResetWarnOptions()}: apague @ref{3b0,,sys.warnoptions} e @code{warnings.filters}.

@item 
@ref{3b1,,Py_GetExecPrefix()}: leia @ref{3b2,,sys.exec_prefix}.

@item 
@ref{3b3,,Py_GetPath()}: leia @ref{3b4,,sys.path}.

@item 
@ref{3b5,,Py_GetPrefix()}: leia @ref{3b6,,sys.prefix}.

@item 
@ref{3b7,,Py_GetProgramFullPath()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3b9,,Py_GetProgramName()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3ba,,Py_GetPythonHome()}: leia @ref{3bb,,PyConfig.home} ou a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}.
@end itemize

(Contribuição de Victor Stinner em gh-105145@footnote{https://github.com/python/cpython/issues/105145}.)

@item 
@ref{209,,Descontinua suavemente} as funções @ref{34f,,PyEval_GetBuiltins()}, @ref{351,,PyEval_GetGlobals()} e @ref{353,,PyEval_GetLocals()}, que retornam uma @ref{33e,,referência emprestada}. (Suavemente descontinuadas como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Descontinua a função @ref{3bd,,PyImport_ImportModuleNoBlock()} que é apenas um apelido para @ref{3be,,PyImport_ImportModule()} desde o Python 3.3. (Contribuição de Victor Stinner em gh-105396@footnote{https://github.com/python/cpython/issues/105396}.)

@item 
@ref{209,,Descontinua suavemente} a função @ref{366,,PyModule_AddObject()}. Ela deve ser substituída por @ref{364,,PyModule_Add()} ou @ref{365,,PyModule_AddObjectRef()}. (Contribuição de Serhiy Storchaka em gh-86493@footnote{https://github.com/python/cpython/issues/86493}.)

@item 
Descontinua os tipos antigos @code{Py_UNICODE} e @code{PY_UNICODE_TYPE} e define @code{Py_UNICODE_WIDE}. Em vez disso, use o tipo @code{wchar_t} diretamente. Desde Python 3.3, @code{Py_UNICODE} e @code{PY_UNICODE_TYPE} são apenas apelidos para @code{wchar_t}. (Contribuição de Victor Stinner em gh-105156@footnote{https://github.com/python/cpython/issues/105156}.)

@item 
Descontinua as funções @ref{379,,PyWeakref_GetObject()} e @ref{3bf,,PyWeakref_GET_OBJECT()}, que retornam uma @ref{33e,,referência emprestada}. Em vez disso, use a nova função @ref{378,,PyWeakref_GetRef()}, que retorna uma @ref{33d,,referência forte}. O projeto pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat/} pode ser usado para obter @ref{378,,PyWeakref_GetRef()} no Python 3.12 e versões anteriores. (Contribuição de Victor Stinner em gh-105927@footnote{https://github.com/python/cpython/issues/105927}.)
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<2>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<2>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<2>. 

@end menu

@node Remoção pendente no Python 3 14<2>,Remoção pendente no Python 3 15<2>,,APIs C descontinuadas
@anchor{whatsnew/3 13 id8}@anchor{3c0}
@subsubsection Remoção pendente no Python 3.14



@itemize *

@item 
O campo @code{ma_version_tag} em @ref{3c1,,PyDictObject} para módulos de extensão (
@geindex Propostas de Melhorias do Python; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}; gh-101193@footnote{https://github.com/python/cpython/issues/101193}).

@item 
A criação de @ref{3c2,,tipos imutáveis} com bases mutáveis (gh-95388@footnote{https://github.com/python/cpython/issues/95388}).

@item 
Funções para configurar a inicialização do Python, descontinuadas no Python 3.11:


@itemize *

@item 
@code{PySys_SetArgvEx()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{PySys_SetArgv()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{Py_SetProgramName()}: defina @ref{3c4,,PyConfig.program_name}.

@item 
@code{Py_SetPythonHome()}: defina @ref{3bb,,PyConfig.home}.
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.

@item 
Variáveis de configuração globais


@itemize *

@item 
@ref{3c6,,Py_DebugFlag}: use @ref{3c7,,PyConfig.parser_debug}.

@item 
@ref{3c8,,Py_VerboseFlag}: use @ref{3c9,,PyConfig.verbose}.

@item 
@ref{3ca,,Py_QuietFlag}: use @ref{3cb,,PyConfig.quiet}.

@item 
@ref{3cc,,Py_InteractiveFlag}: use @ref{3cd,,PyConfig.interactive}.

@item 
@ref{3ce,,Py_InspectFlag}: use @ref{3cf,,PyConfig.inspect}.

@item 
@ref{3d0,,Py_OptimizeFlag}: use @ref{3d1,,PyConfig.optimization_level}.

@item 
@ref{3d2,,Py_NoSiteFlag}: use @ref{3d3,,PyConfig.site_import}.

@item 
@ref{3d4,,Py_BytesWarningFlag}: use @ref{3d5,,PyConfig.bytes_warning}.

@item 
@ref{3d6,,Py_FrozenFlag}: use @ref{3d7,,PyConfig.pathconfig_warnings}.

@item 
@ref{3d8,,Py_IgnoreEnvironmentFlag}: use @ref{3d9,,PyConfig.use_environment}.

@item 
@ref{3da,,Py_DontWriteBytecodeFlag}: use @ref{3db,,PyConfig.write_bytecode}.

@item 
@ref{3dc,,Py_NoUserSiteDirectory}: use @ref{3dd,,PyConfig.user_site_directory}.

@item 
@ref{3de,,Py_UnbufferedStdioFlag}: use @ref{3df,,PyConfig.buffered_stdio}.

@item 
@ref{3e0,,Py_HashRandomizationFlag}: use @ref{3e1,,PyConfig.use_hash_seed} e @ref{3e2,,PyConfig.hash_seed}.

@item 
@ref{3e3,,Py_IsolatedFlag}: use @ref{3e4,,PyConfig.isolated}.

@item 
@ref{3e5,,Py_LegacyWindowsFSEncodingFlag}: use @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding}.

@item 
@ref{3e7,,Py_LegacyWindowsStdioFlag}: use @ref{3a4,,PyConfig.legacy_windows_stdio}.

@item 
@code{Py_FileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_HasFileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_FileSystemDefaultEncodeErrors}: use @ref{3e9,,PyConfig.filesystem_errors}.

@item 
@code{Py_UTF8Mode}: use @ref{3ea,,PyPreConfig.utf8_mode}. (veja @ref{3eb,,Py_PreInitialize()})
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.
@end itemize

@node Remoção pendente no Python 3 15<2>,Remoção pendente no Python 3 16<2>,Remoção pendente no Python 3 14<2>,APIs C descontinuadas
@anchor{whatsnew/3 13 id9}@anchor{3ec}
@subsubsection Remoção pendente no Python 3.15



@itemize *

@item 
The @ref{3bd,,PyImport_ImportModuleNoBlock()}: use @ref{3be,,PyImport_ImportModule()}.

@item 
@ref{379,,PyWeakref_GetObject()} e @ref{3bf,,PyWeakref_GET_OBJECT()}: use @ref{378,,PyWeakref_GetRef()}.

@item 
O tipo @ref{3ed,,Py_UNICODE} e a macro @code{Py_UNICODE_WIDE}: use @code{wchar_t}.

@item 
Funções de inicialização do Python


@itemize *

@item 
@ref{3af,,PySys_ResetWarnOptions()}: apague @ref{3b0,,sys.warnoptions} e @code{warnings.filters}.

@item 
@ref{3b1,,Py_GetExecPrefix()}: obtenha @ref{3ee,,sys.base_exec_prefix} e @ref{3b2,,sys.exec_prefix}.

@item 
@ref{3b3,,Py_GetPath()}: leia @ref{3b4,,sys.path}.

@item 
@ref{3b5,,Py_GetPrefix()}: obtenha @ref{3ef,,sys.base_prefix} e @ref{3b6,,sys.prefix}.

@item 
@ref{3b7,,Py_GetProgramFullPath()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3b9,,Py_GetProgramName()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3ba,,Py_GetPythonHome()}: leia @ref{3bb,,PyConfig.home} ou a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}.
@end itemize
@end itemize

@node Remoção pendente no Python 3 16<2>,Remoção pendente em versões futuras<2>,Remoção pendente no Python 3 15<2>,APIs C descontinuadas
@anchor{whatsnew/3 13 id10}@anchor{3f0}
@subsubsection Remoção pendente no Python 3.16



@itemize *

@item 
A cópia empacotada do @code{libmpdec}.
@end itemize

@node Remoção pendente em versões futuras<2>,,Remoção pendente no Python 3 16<2>,APIs C descontinuadas
@anchor{whatsnew/3 13 id11}@anchor{3f1}
@subsubsection Remoção pendente em versões futuras


As APIs a seguir foram descontinuadas e serão removidas, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{3f2,,Py_TPFLAGS_HAVE_FINALIZE}: desnecessária desde o Python 3.8.

@item 
@ref{3f3,,PyErr_Fetch()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f5,,PyErr_NormalizeException()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f6,,PyErr_Restore()}: use @ref{3f7,,PyErr_SetRaisedException()}.

@item 
@ref{3f8,,PyModule_GetFilename()}: use @ref{3f9,,PyModule_GetFilenameObject()}.

@item 
@ref{3fa,,PyOS_AfterFork()}: use @ref{3fb,,PyOS_AfterFork_Child()}.

@item 
@ref{3fc,,PySlice_GetIndicesEx()}: use @ref{3fd,,PySlice_Unpack()} e @ref{3fe,,PySlice_AdjustIndices()}.

@item 
@code{PyUnicode_AsDecodedObject()}: use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsDecodedUnicode()}: use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsEncodedObject()}: use @ref{400,,PyCodec_Encode()}.

@item 
@code{PyUnicode_AsEncodedUnicode()}: use @ref{400,,PyCodec_Encode()}.

@item 
@ref{401,,PyUnicode_READY()}: desnecessário desde o Python 3.12

@item 
@code{PyErr_Display()}: use @ref{402,,PyErr_DisplayException()}.

@item 
@code{_PyErr_ChainExceptions()}: use @code{_PyErr_ChainExceptions1()}.

@item 
O membro @code{PyBytesObject.ob_shash}: chame @ref{403,,PyObject_Hash()}.

@item 
O membro @code{PyDictObject.ma_version_tag}.

@item 
API do Thread Local Storage (TLS):


@itemize *

@item 
@ref{404,,PyThread_create_key()}: use @ref{405,,PyThread_tss_alloc()}.

@item 
@ref{406,,PyThread_delete_key()}: use @ref{407,,PyThread_tss_free()}.

@item 
@ref{408,,PyThread_set_key_value()}: use @ref{409,,PyThread_tss_set()}.

@item 
@ref{40a,,PyThread_get_key_value()}: use @ref{40b,,PyThread_tss_get()}.

@item 
@ref{40c,,PyThread_delete_key_value()}: use @ref{40d,,PyThread_tss_delete()}.

@item 
@ref{40e,,PyThread_ReInitTLS()}: desnecessário desde o Python 3.7.
@end itemize
@end itemize

@node Mudanças na construção,Portando para o Python 3 13,Alterações na API C,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 build-changes}@anchor{40f}@anchor{whatsnew/3 13 pythoncapi-compat-project}@anchor{410}
@subsection Mudanças na construção



@itemize *

@item 
@code{arm64-apple-ios} e @code{arm64-apple-ios-simulator} são agora plataformas de nível 3 da 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}. (Escrita e implementação da @ref{165,,PEP 730} foi uma contribuição de Russell Keith-Magee em gh-114099@footnote{https://github.com/python/cpython/issues/114099}.)

@item 
@code{aarch64-linux-android} e @code{x86_64-linux-android} são agora plataformas de nível 3 da 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}. (Escrita e implementação da @ref{165,,PEP 738} foi uma contribuição de Malcolm Smith em gh-116622@footnote{https://github.com/python/cpython/issues/116622}.)

@item 
@code{wasm32-wasi} agora é uma plataforma de nível 2 segundo a 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}. (Contribuição de Brett Cannon em gh-115192@footnote{https://github.com/python/cpython/issues/115192}.)

@item 
@code{wasm32-emscripten} não é mais uma plataforma suportada pela 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}. (Contribuição de Brett Cannon em gh-115192@footnote{https://github.com/python/cpython/issues/115192}.)

@item 
Construir CPython agora requer um compilador com suporte para a biblioteca atômica C11, funções atômicas embutidas do GCC ou intrínsecos interligados MSVC.

@item 
Autoconf 2.71 e aclocal 1.16.5 agora são necessários para regerar o script @code{configure}. (Contribuição de Christian Heimes em gh-89886@footnote{https://github.com/python/cpython/issues/89886} e de Victor Stinner em gh-112090@footnote{https://github.com/python/cpython/issues/112090}.)

@item 
SQLite 3.15.2 ou mais recente é necessário para construir o módulo de extensão @ref{cf,,sqlite3}. (Contribuição de Erlend Aasland em gh-105875@footnote{https://github.com/python/cpython/issues/105875}.)

@item 
CPython agora inclui a biblioteca mimalloc@footnote{https://github.com/microsoft/mimalloc/} por padrão. Está licenciada sob a licença do MIT; veja @ref{411,,licença do mimalloc}. O mimalloc incluído tem alterações personalizadas, veja gh-113141@footnote{https://github.com/python/cpython/issues/113141} para detalhes. (Contribuição de Dino Viehland em gh-109914@footnote{https://github.com/python/cpython/issues/109914}.)

@item 
A opção @ref{412,,--with-system-libmpdec} do @code{configure} agora tem como padrão @code{yes}. A cópia empacotada de @code{libmpdec} será removida no Python 3.16.

@item 
Python construído com @ref{395,,--with-trace-refs} (referências de rastreamento) do @code{configure} tem compatibilidade de ABI com a construção de lançamento do Python e a @ref{1f9,,construção de depuração}. (Contribuição de Victor Stinner em gh-108634@footnote{https://github.com/python/cpython/issues/108634}.)

@item 
Em sistemas POSIX, os nomes de arquivos pkg-config (@code{.pc}) agora incluem os sinalizadores de ABI. Por exemplo, a construção com threads livres gera @code{python-3.13t.pc} e a construção de depuração gera @code{python-3.13d.pc}.

@item 
As extensões C @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} e @code{_uuid} são agora construídas com a @ref{396,,API C limitada}. (Contribuição de Victor Stinner em gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)
@end itemize

@node Portando para o Python 3 13,Mudanças em teste de regressão,Mudanças na construção,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 porting-to-python-3-13}@anchor{146}
@subsection Portando para o Python 3.13


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações na API Python:: 
* Alterações na API C: Alterações na API C<3>. 

@end menu

@node Alterações na API Python,Alterações na API C<3>,,Portando para o Python 3 13
@anchor{whatsnew/3 13 changes-in-the-python-api}@anchor{413}
@subsubsection Alterações na API Python

@anchor{whatsnew/3 13 pep667-porting-notes-py}@anchor{183}

@itemize *

@item 
@ref{142,,PEP 667} introduz várias mudanças na semântica de @ref{141,,locals()} e @ref{182,,f_locals}:


@itemize *

@item 
Chamar @ref{141,,locals()} em um @ref{17e,,escopo otimizado} agora produz uma captura independente em cada chamada e, portanto, não atualiza mais implicitamente as referências retornadas anteriormente. Obter o comportamento legado do CPython agora requer chamadas explícitas para atualizar o dicionário inicialmente retornado com os resultados de chamadas subsequentes para @code{locals()}. Funções de execução de código que visam implicitamente @code{locals()} (como @code{exec} e @code{eval}) devem receber um espaço de nomes explícito para acessar seus resultados em um escopo otimizado. (Alterado como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Chamar @ref{141,,locals()} de uma compreensão no módulo ou escopo de classe (inclusive via @code{exec} ou @code{eval}) mais uma vez se comporta como se a compreensão estivesse sendo executada como uma função aninhada independente (isto é, as variáveis locais de o escopo que contém não está incluído). No Python 3.12, isso mudou para incluir as variáveis locais do escopo que o contém ao implementar a 
@geindex Propostas de Melhorias do Python; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}. (Alterado como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)

@item 
Acessar @ref{182,,FrameType.f_locals} em um @ref{17e,,escopo otimizado} agora retorna um proxy de “write-through” em vez de uma captura que é atualizado em horários mal especificados. Se uma captura for desejada, ela deve ser criada explicitamente com @code{dict} ou com o método @code{.copy()} do proxy. (Alterado como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}.)
@end itemize

@item 
@ref{414,,functools.partial} agora emite uma @ref{415,,FutureWarning} quando é usado como método. Seu comportamento será alterado em versões futuras do Python. Envolva-a em @ref{416,,staticmethod()} se quiser preservar o comportamento antigo. (Contribuição de Serhiy Storchaka em gh-121027@footnote{https://github.com/python/cpython/issues/121027}.)

@item 
Uma exceção @ref{417,,OSError} agora é levantada por @ref{418,,getpass.getuser()} para qualquer falha na recuperação de um nome de usuário, em vez de @ref{419,,ImportError} em plataformas não-Unix ou @ref{344,,KeyError} em plataformas Unix onde o banco de dados de senhas está vazio.

@item 
O valor do atributo @code{mode} de @ref{41a,,gzip.GzipFile} agora é uma string (@code{'rb'} ou @code{'wb'}) e não mais um inteiro (@code{1} ou @code{2}). O valor do atributo @code{mode} do objeto arquivo ou similar legível retornado por @ref{41b,,zipfile.ZipFile.open()} é agora @code{'rb'} e não mais @code{'r'}. (Contribuição de Serhiy Storchaka em gh-115961@footnote{https://github.com/python/cpython/issues/115961}.)

@item 
@ref{41c,,mailbox.Maildir} agora ignora arquivos com um ponto inicial (@code{.}). (Contribuição de Zackery Spytz em gh-65559@footnote{https://github.com/python/cpython/issues/65559}.)

@item 
@ref{22d,,pathlib.Path.glob()} e @ref{22e,,rglob()} agora retornam arquivos e diretórios se um padrão que termina com “@code{**}” for fornecido, em vez de apenas diretórios. Os usuários podem adicionar uma barra final para manter o comportamento anterior e corresponder apenas aos diretórios.

@item 
O módulo @ref{ed,,threading} agora espera que o módulo @code{_thread} tenha uma função @code{_is_main_interpreter}. É uma função sem argumentos que retorna @code{True} se o interpretador atual for o interpretador principal.

Qualquer biblioteca ou aplicação que forneça um módulo @code{_thread} personalizado deve obrigatoriamente fornecer @code{_is_main_interpreter()}, da mesma forma que outros atributos “privados” do módulo. (Veja gh-112826@footnote{https://github.com/python/cpython/issues/112826}.)
@end itemize

@node Alterações na API C<3>,,Alterações na API Python,Portando para o Python 3 13
@anchor{whatsnew/3 13 changes-in-the-c-api}@anchor{41d}
@subsubsection Alterações na API C



@itemize *

@item 
@code{Python.h} não inclui mais o cabeçalho padrão @code{<ieeefp.h>}. Ele foi incluído para a função @code{finite()} que agora é fornecida pelo cabeçalho @code{<math.h>}. Agora deve ser incluído explicitamente, se necessário. Remove também a macro @code{HAVE_IEEEFP_H}. (Contribuição de Victor Stinner em gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
@code{Python.h} não inclui mais estes arquivos de cabeçalho padrão: @code{<time.h>}, @code{<sys/select.h>} e @code{<sys/time.h>}. Se necessário, deverão agora ser incluídos explicitamente. Por exemplo, @code{<time.h>} fornece as funções @code{clock()} e @code{gmtime()}, @code{<sys/select.h>} fornece o @code{select()}, e @code{<sys/time.h>} fornece as funções @code{futimes()}, @code{gettimeofday()} e @code{setitimer()}. (Contribuição de Victor Stinner em gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
No Windows, @code{Python.h} não inclui mais o arquivo de cabeçalho padrão @code{<stddef.h>}. Se necessário, deverá agora ser incluído explicitamente. Por exemplo, ele fornece a função @code{offsetof()} e os tipos @code{size_t} e @code{ptrdiff_t}. Incluindo @code{<stddef.h>} explicitamente já era necessário para todas as outras plataformas, a macro @code{HAVE_STDDEF_H} só é definida no Windows. (Contribuição de Victor Stinner em gh-108765@footnote{https://github.com/python/cpython/issues/108765}.)

@item 
Se a macro @ref{41e,,Py_LIMITED_API} estiver definida, as macros @code{Py_BUILD_CORE}, @code{Py_BUILD_CORE_BUILTIN} e @code{Py_BUILD_CORE_MODULE} agora são indefinidas por @code{<Python.h>}. (Contribuição de Victor Stinner em gh-85283@footnote{https://github.com/python/cpython/issues/85283}.)

@item 
As macros antigas da lixeira @code{Py_TRASHCAN_SAFE_BEGIN} e @code{Py_TRASHCAN_SAFE_END} foram removidas. Elas devem ser substituídas pelas novas macros @code{Py_TRASHCAN_BEGIN} e @code{Py_TRASHCAN_END}.

Uma função @code{tp_dealloc} que contém as macros antigas, como:

@example
static void
dealocador_de_meutipo(meutipo *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

deve migrar para as novas macros da seguinte forma:

@example
static void
dealocador_de_meutipo(meutipo *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, dealocador_de_meutipo);
    ...
    Py_TRASHCAN_END
@}
@end example

Observe que @code{Py_TRASHCAN_BEGIN} tem um segundo argumento que deve ser a função de desalocação em que está. As novas macros foram adicionadas no Python 3.8 e as macros antigas foram descontinuadas no Python 3.11. (Contribuição de Irit Katriel em gh-105111@footnote{https://github.com/python/cpython/issues/105111}.)
@end itemize
@anchor{whatsnew/3 13 pep667-porting-notes-c}@anchor{184}

@itemize *

@item 
@ref{142,,PEP 667} introduz várias mudanças em funções relacionadas a quadro:


@itemize *

@item 
Os efeitos da mutação do dicionário retornado de @ref{353,,PyEval_GetLocals()} em um @ref{17e,,escopo otimizado} foram alterados. Novas entradas de dict adicionadas desta forma agora `apenas' ficarão visíveis para chamadas @ref{353,,PyEval_GetLocals()} subsequentes nesse quadro, como @ref{41f,,PyFrame_GetLocals()}, @ref{141,,locals()} e @ref{182,,FrameType.f_locals} não acessa mais o mesmo dicionário armazenado em cache subjacente. As alterações feitas nas entradas para nomes de variáveis reais e nomes adicionados através das interfaces proxy de “write-through” serão substituídas em chamadas subsequentes para @ref{353,,PyEval_GetLocals()} nesse quadro. A atualização de código recomendada depende de como a função estava sendo usada, portanto, consulte o aviso de descontinuação na função para obter detalhes.

@item 
Chamar @ref{41f,,PyFrame_GetLocals()} em um @ref{17e,,escopo otimizado} agora retorna um proxy de “write-through” em vez de uma captura que é atualizada em horários mal especificados. Se uma captura for desejada, ela deve ser criada explicitamente (por exemplo, com @ref{420,,PyDict_Copy()}) ou chamando a nova API @ref{352,,PyEval_GetFrameLocals()}.

@item 
@code{PyFrame_FastToLocals()} e @code{PyFrame_FastToLocalsWithError()} não têm mais nenhum efeito. Chamar essas funções tem sido redundante desde o Python 3.11, quando @ref{41f,,PyFrame_GetLocals()} foi introduzido pela primeira vez.

@item 
@code{PyFrame_LocalsToFast()} não tem mais efeito. Chamar esta função é redundante agora que @ref{41f,,PyFrame_GetLocals()} retorna um proxy de “write-through” para @ref{17e,,escopos otimizados}.
@end itemize

@item 
O Python 3.13 removeu muitas funções privadas. Algumas delas podem ser substituídas usando estas alternativas:


@itemize *

@item 
@code{_PyDict_Pop()}: @ref{341,,PyDict_Pop()} ou @ref{342,,PyDict_PopString()};

@item 
@code{_PyDict_GetItemWithError()}: @ref{33a,,PyDict_GetItemRef()};

@item 
@code{_PyErr_WriteUnraisableMsg()}: @ref{34c,,PyErr_FormatUnraisable()};

@item 
@code{_PyEval_SetTrace()}: @ref{421,,PyEval_SetTrace()} ou @ref{422,,PyEval_SetTraceAllThreads()};

@item 
@code{_PyList_Extend()}: @ref{35b,,PyList_Extend()};

@item 
@code{_PyLong_AsInt()}: @ref{35f,,PyLong_AsInt()};

@item 
@code{_PyMem_RawStrdup()}: @code{strdup()};

@item 
@code{_PyMem_Strdup()}: @code{strdup()};

@item 
@code{_PyObject_ClearManagedDict()}: @ref{36a,,PyObject_ClearManagedDict()};

@item 
@code{_PyObject_VisitManagedDict()}: @ref{369,,PyObject_VisitManagedDict()};

@item 
@code{_PyThreadState_UncheckedGet()}: @ref{371,,PyThreadState_GetUnchecked()};

@item 
@code{_PyTime_AsSecondsDouble()}: @ref{330,,PyTime_AsSecondsDouble()};

@item 
@code{_PyTime_GetMonotonicClock()}: @ref{331,,PyTime_Monotonic()} ou @ref{332,,PyTime_MonotonicRaw()};

@item 
@code{_PyTime_GetPerfCounter()}: @ref{333,,PyTime_PerfCounter()} ou @ref{334,,PyTime_PerfCounterRaw()};

@item 
@code{_PyTime_GetSystemClock()}: @ref{335,,PyTime_Time()} ou @ref{336,,PyTime_TimeRaw()};

@item 
@code{_PyTime_MAX}: @ref{32f,,PyTime_MAX};

@item 
@code{_PyTime_MIN}: @ref{32e,,PyTime_MIN};

@item 
@code{_PyTime_t}: @ref{32d,,PyTime_t};

@item 
@code{_Py_HashPointer()}: @ref{368,,Py_HashPointer()};

@item 
@code{_Py_IsFinalizing()}: @ref{358,,Py_IsFinalizing()}.
@end itemize

O projeto pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat/} pode ser usado para obter a maioria dessas novas funções no Python 3.12 e versões anteriores.
@end itemize

@node Mudanças em teste de regressão,Alterações notáveis no 3 13 1,Portando para o Python 3 13,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 regression-test-changes}@anchor{423}
@subsection Mudanças em teste de regressão



@itemize *

@item 
Python construído com @ref{424,,--with-pydebug} do @code{configure} agora oferece suporte a uma opção de linha de comando @ref{176,,-X presite=pacote.módulo}. Se usado, especifica um módulo que deve ser importado no início do ciclo de vida do interpretador, antes que @code{site.py} seja executado. (Contribuição de Łukasz Langa em gh-110769@footnote{https://github.com/python/cpython/issues/110769}.)
@end itemize

@node Alterações notáveis no 3 13 1,Alterações notáveis no 3 13 4,Mudanças em teste de regressão,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 notable-changes-in-3-13-1}@anchor{425}
@subsection Alterações notáveis no 3.13.1


@menu
* sys: sys<2>. 

@end menu

@node sys<2>,,,Alterações notáveis no 3 13 1
@anchor{whatsnew/3 13 id12}@anchor{426}
@subsubsection sys



@itemize *

@item 
A função especial @ref{427,,sys.getobjects()}, anteriormente não documentada, que só existe em construções especializadas do Python, agora pode retornar objetos de outros interpretadores além daquele em que foi chamada.
@end itemize

@node Alterações notáveis no 3 13 4,,Alterações notáveis no 3 13 1,O que há de novo no Python 3 13
@anchor{whatsnew/3 13 notable-changes-in-3-13-4}@anchor{428}
@subsection Alterações notáveis no 3.13.4


@menu
* os.path: os path<2>. 
* tarfile:: 

@end menu

@node os path<2>,tarfile,,Alterações notáveis no 3 13 4
@anchor{whatsnew/3 13 id13}@anchor{429}
@subsubsection os.path



@itemize *

@item 
O parâmetro `strict' para @ref{225,,os.path.realpath()} aceita um novo valor, @ref{42a,,os.path.ALLOW_MISSING}. Se usado, erros diferentes de @ref{42b,,FileNotFoundError} serão levantados novamente; o caminho resultante pode estar ausente, mas estará livre de links simbólicos. (Contribuição de Petr Viktorin para 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4517
CVE 2025-4517@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4517}.)
@end itemize

@node tarfile,,os path<2>,Alterações notáveis no 3 13 4
@anchor{whatsnew/3 13 tarfile}@anchor{42c}
@subsubsection tarfile



@itemize *

@item 
@ref{42d,,data_filter()} agora normaliza alvos de links simbólicos para evitar ataques de travessia de caminho. (Contribuição de Petr Viktorin em gh-127987@footnote{https://github.com/python/cpython/issues/127987} e 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4138
CVE 2025-4138@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4138}.)

@item 
@ref{42e,,extractall()} agora ignora a correção de atributos de diretório quando um diretório é removido ou substituído por outro tipo de arquivo. (Contribuição de Petr Viktorin em gh-127987@footnote{https://github.com/python/cpython/issues/127987} e 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718}.)

@item 
@ref{42f,,extract()} e @ref{42e,,extractall()} agora (re)aplicam o filtro de extração ao substituir um link (físico ou simbólico) por uma cópia de outro membro do arquivo e ao corrigir atributos de diretório. O primeiro levanta uma nova exceção, @ref{430,,LinkFallbackError}. (Contribuição de Petr Viktorin para 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4330
CVE 2025-4330@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4330} e 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718}.)

@item 
@ref{42f,,extract()} e @ref{42e,,extractall()} não extraem mais membros rejeitados quando @ref{431,,errorlevel()} é zero. (Contribuição de Matt Prodani e Petr Viktorin em gh-112887@footnote{https://github.com/python/cpython/issues/112887} e 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4435
CVE 2025-4435@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4435}.)
@end itemize

@node O que há de novo no Python 3 12,O que há de novo no Python 3 11,O que há de novo no Python 3 13,O que há de novo no Python
@anchor{whatsnew/3 12 doc}@anchor{432}@anchor{whatsnew/3 12 translation-repo}@anchor{433}@anchor{whatsnew/3 12 what-s-new-in-python-3-12}@anchor{434}
@section O que há de novo no 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 artigo explica os novos recursos no Python 3.12, em comparação com 3.11. Python 3.12 foi lançado em 2 de outubro de 2023. Veja @ref{13c,,changelog} para uma lista completa de mudanças.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 693
PEP 693@footnote{https://peps.python.org/pep-0693/} – Agendamento de lançamento do Python 3.12


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<2>. 
* Novas funcionalidades: Novas funcionalidades<3>. 
* Novos recursos relacionados a dicas de tipo:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<2>. 
* Novos módulos: Novos módulos<2>. 
* Módulos melhorados: Módulos melhorados<2>. 
* Otimizações: Otimizações<2>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<2>. 
* Ferramentas e daemons:: 
* Descontinuados:: 
* Removidos:: 
* Portando para Python 3.12: Portando para Python 3 12. 
* Mudanças na construção: Mudanças na construção<2>. 
* Alterações na API C: Alterações na API C<4>. 

@end menu

@node Resumo – Destaques da versão<2>,Novas funcionalidades<3>,,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 summary-release-highlights}@anchor{435}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.12.
@c Brevity is key.

Python 3.12 é uma versão estável da linguagem de programação Python, com uma combinação de alterações na linguagem e na biblioteca padrão. As alterações da biblioteca se concentram na limpeza de APIs descontinuadas, usabilidade e correção. É importante notar que o pacote @code{distutils} foi removido da biblioteca padrão. O suporte ao sistema de arquivos em @ref{a1,,os} e @ref{a4,,pathlib} teve uma série de melhorias e vários módulos têm melhor desempenho.

As mudanças de linguagem se concentram na usabilidade, já que @ref{436,,f-strings} tiveram muitas limitações removidas e as sugestões ‘Did you mean …’ continuam a melhorar. A nova @ref{437,,sintaxe de parâmetro type} e a instrução @ref{438,,type} melhoram a ergonomia para usar @ref{439,,tipos genéricos} e @ref{43a,,apelidos de tipos} com verificadores de tipo estáticos.

Este artigo não tenta fornecer uma especificação completa de todos os novos recursos, mas fornece uma visão geral conveniente. Para detalhes completos, você deve consultar a documentação, como @ref{144,,Referência da Biblioteca} e @ref{145,,Referência da Linguagem}. Se você quiser entender a implementação completa e a justificativa do design para uma mudança, consulte a PEP para um novo recurso específico; mas observe que as PEPs geralmente não são mantidas atualizadas depois que um recurso é totalmente implementado.


__________________________________________________________________


@c PEP-sized items next.

Novos recursos de sintaxe:


@itemize *

@item 
@ref{437,,PEP 695}, sintaxe de parâmetro de tipo e a instrução @ref{438,,type}
@end itemize

Novos recursos de gramática:


@itemize *

@item 
@ref{43b,,PEP 701}, @ref{436,,f-strings} na gramática
@end itemize

Melhorias no interpretador:


@itemize *

@item 
@ref{43c,,PEP 684}, uma única @ref{148,,GIL} por interpretador

@item 
@ref{43d,,PEP 669}, monitoramento de baixo impacto

@item 
@ref{43e,,Aprimoradas as sugestões 'Did you mean ...'} para as exceções @ref{43f,,NameError}, @ref{419,,ImportError} e @ref{18d,,SyntaxError}
@end itemize

Melhorias no modelo de dados Python:


@itemize *

@item 
@ref{440,,PEP 688}, usando o @ref{2e8,,protocolo de buffer} do Python
@end itemize

Melhorias significativas na biblioteca padrão:


@itemize *

@item 
A classe @ref{229,,pathlib.Path} agora oferece suporte a fazer subclasses

@item 
O módulo @ref{a1,,os} recebeu vários aprimoramentos para suporte ao Windows

@item 
Uma @ref{441,,interface de linha de comando} foi adicionada ao módulo @ref{cf,,sqlite3}

@item 
As verificações de @ref{442,,isinstance()} para @ref{443,,protocolos verificáveis em tempo de execução} desfruta de um aumento de velocidade entre duas e 20 vezes

@item 
O pacote @ref{a,,asyncio} teve vários aprimoramentos desempenho, com alguns benchmarks mostrando um aumento de 75% na velocidade.

@item 
Uma @ref{444,,interface de linha de comando} foi adicionada ao módulo @ref{110,,uuid}

@item 
Devido às alterações na @ref{43b,,PEP 701}, a produção de tokens por meio do módulo @ref{fb,,tokenize} é até 64% mais rápida.
@end itemize

Melhorias de Segurança:


@itemize *

@item 
Substitui as implementações embutidas do @ref{68,,hashlib} de SHA1, SHA3, SHA2-384, SHA2-512 e MD5 pelo código formalmente verificado do projeto HACL*@footnote{https://github.com/hacl-star/hacl-star/}. Essas implementações embutidas permanecem como fallbacks que são usados somente quando o OpenSSL não as fornece.
@end itemize

Melhorias na API C:


@itemize *

@item 
@ref{445,,PEP 697}, tier instável de API C

@item 
@ref{446,,PEP 683}, objetos imortal
@end itemize

Melhorias na implementação do CPython:


@itemize *

@item 
@ref{447,,PEP 709}, inlining de compreensão

@item 
@ref{18f,,Suporte do CPython} para o perfilador Linux @code{perf}

@item 
Implementa proteção contra estouro de pilha em plataformas suportadas
@end itemize

Novos recursos de tipagem:


@itemize *

@item 
@ref{448,,PEP 692}, usando @ref{162,,TypedDict} para anotar @ref{449,,**kwargs}

@item 
@ref{44a,,PEP 698}, decorador @ref{44b,,typing.override()}
@end itemize

Descontinuações, remoções ou restrições importantes:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}: Remove @code{wstr} os objetos Unicode na API C do Python, reduzindo o tamanho de cada objeto @ref{44c,,str} em pelo menos 8 bytes.

@item 
@geindex Propostas de Melhorias do Python; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}: Remove o pacote @code{distutils}. Consulte 
@geindex Propostas de Melhorias do Python; PEP 0632#migration-advice
o guia de migração@footnote{https://peps.python.org/pep-0632/#migration-advice} para obter conselhos sobre a substituição das APIs fornecidas por ele. O pacote de terceiros Setuptools@footnote{https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html} continua fornecendo @code{distutils}, se você ainda precisar dele no Python 3.12 e posterior.

@item 
gh-95299@footnote{https://github.com/python/cpython/issues/95299}: Não pré-instala @code{setuptools} em ambientes virtuais criados com @ref{111,,venv}. Isso significa que @code{distutils}, @code{setuptools}, @code{pkg_resources} e @code{easy_install} não estarão mais disponíveis por padrão; para acessá-los, execute @code{pip install setuptools} no ambiente virtual @ref{44d,,ativado}.

@item 
Os módulos @code{asynchat}, @code{asyncore} e @code{imp} foram removidos, juntamente com vários @ref{44e,,apelidos de métodos} de @ref{44f,,unittest.TestCase}.
@end itemize

@node Novas funcionalidades<3>,Novos recursos relacionados a dicas de tipo,Resumo – Destaques da versão<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 new-features}@anchor{450}
@subsection Novas funcionalidades


@menu
* PEP 695; Sintaxe do parâmetro de tipo: PEP 695 Sintaxe do parâmetro de tipo. 
* PEP 701; Formalização sintática de f-strings: PEP 701 Formalização sintática de f-strings. 
* PEP 684; Uma GIL por interpretador: PEP 684 Uma GIL por interpretador. 
* PEP 669; Monitoramento de baixo impacto para CPython: PEP 669 Monitoramento de baixo impacto para CPython. 
* PEP 688; Tornando o protocolo de buffer acessível no Python: PEP 688 Tornando o protocolo de buffer acessível no Python. 
* PEP 709; Fazendo inline de compreensão: PEP 709 Fazendo inline de compreensão. 
* Mensagens de erro melhoradas: Mensagens de erro melhoradas<2>. 

@end menu

@node PEP 695 Sintaxe do parâmetro de tipo,PEP 701 Formalização sintática de f-strings,,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-695-type-parameter-syntax}@anchor{451}@anchor{whatsnew/3 12 whatsnew312-pep695}@anchor{437}
@subsubsection PEP 695: Sintaxe do parâmetro de tipo


As classes e funções genéricas sob a 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} foram declaradas usando uma sintaxe detalhada que deixou o escopo dos parâmetros de tipo pouco claro e exigiu declarações explícitas de variação.

@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} apresenta uma maneira nova, mais compacta e explícita de criar @ref{452,,classes genéricas} e @ref{453,,funções}:

@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

Além disso, a PEP introduz uma nova maneira de declarar @ref{454,,apelidos de tipos} usando a instrução @ref{438,,type}, que cria uma instância de @ref{455,,TypeAliasType}:

@example
type Point = tuple[float, float]
@end example

Os apelidos de tipo também podem ser @ref{456,,genéricos}:

@example
type Point[T] = tuple[T, T]
@end example

A nova sintaxe permite declarar os parâmetros @ref{15f,,TypeVarTuple} e @ref{15e,,ParamSpec}, bem como os parâmetros @ref{15d,,TypeVar} com limites ou restrições:

@example
type IntFunc[**P] = Callable[P, int]  # ParamSpec
type LabeledTuple[*Ts] = tuple[str, *Ts]  # TypeVarTuple
type HashableSequence[T: Hashable] = Sequence[T]  # TypeVar com vínculo
type IntOrStrSequence[T: (int, str)] = Sequence[T]  # TypeVar com restrições
@end example

O valor dos apelidos de tipo e os limites e restrições das variáveis de tipo criadas por meio dessa sintaxe são avaliados somente sob demanda (consulte @ref{457,,avaliação preguiçosa}). Isso significa que os apelidos de tipo podem se referir a outros tipos definidos posteriormente no arquivo.

Os parâmetros de tipo declarados por meio de uma lista de parâmetros de tipo são visíveis no escopo da declaração e em quaisquer escopos aninhados, mas não no escopo externo. Por exemplo, eles podem ser usados nas anotações de tipo para os métodos de uma classe genérica ou no corpo da classe. Entretanto, não podem ser usadas no escopo do módulo depois que a classe é definida. Consulte @ref{2b3,,Listas de parâmetros de tipo} para obter uma descrição detalhada da semântica de tempo de execução dos parâmetros de tipo.

Para dar suporte a essa semântica de escopo, um novo tipo de escopo é introduzido, o @ref{188,,escopo de anotação}. Os escopos de anotação se comportam, em sua maior parte, como escopos de função, mas interagem de forma diferente com os escopos de classe. No Python 3.13, @ref{458,,anotações} também serão avaliadas em escopos de anotação.

Consulte 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} para obter mais detalhes.

(PEP escrita por Eric Traut. Implementação por Jelle Zijlstra, Eric Traut e outros em gh-103764@footnote{https://github.com/python/cpython/issues/103764}).

@node PEP 701 Formalização sintática de f-strings,PEP 684 Uma GIL por interpretador,PEP 695 Sintaxe do parâmetro de tipo,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-701-syntactic-formalization-of-f-strings}@anchor{459}@anchor{whatsnew/3 12 whatsnew312-pep701}@anchor{43b}
@subsubsection PEP 701: Formalização sintática de f-strings


@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} resolve algumas restrições no uso de @ref{436,,f-strings}. Componentes de expressão dentro de f-strings agora podem ser qualquer expressão válida do Python, incluindo strings reutilizando a mesma aspa que a f-string contida,  expressões multi-linhas, comentários, barras invertidas e sequências de escape unicode. Vamos cobri-los em detalhes:


@itemize *

@item 
Reuso de aspas: no Python 3.11, reusar as mesmas aspas que a f-string que contém levanta um @ref{18d,,SyntaxError}, forçando o usuário a usar outras aspas disponíveis (como usar aspas duplas ou triplas se a f-string usa aspas simples). No Python 3.12, agora você pode fazer coisas 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

Observe que, antes dessa alteração, não havia limite explícito de como f-strings podem ser aninhadas, mas o fato de as aspas de string não poderem ser reusadas dentro do componente de expressão de f-strings tornava impossível aninhar f-strings arbitrariamente. Na verdade, esta é a f-string mais aninhada que poderia ser escrita:

@example
>>> f"""@{f'@w{'}'@{f'@{f"@{1+1@}"@}'@}'@w{'}'@}"""
'2'
@end example

Como agora f-strings podem conter qualquer expressão Python válida dentro de componentes de expressão, agora é possível aninhar f-strings arbitrariamente:

@example
>>> f"@{f"@{f"@{f"@{f"@{f"@{1+1@}"@}"@}"@}"@}"@}"
'2'
@end example

@item 
Expressões e comentários multilinhas: no Python 3.11, as expressões f-string devem ser definidas em uma única linha, ainda que a expressão dentro de f-string externas possa normalmente abranger várias linhas (como listas literais sendo definidas em várias linhas), tornando-as mais difíceis de ler. No Python 3.12, agora você pode definir f-strings abrangendo várias linhas e adicionar comentários inline:

@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 
Contrabarra e caracteres unicode: antes do Python 3.12, as expressões f-string não podiam conter nenhum caractere @code{\}. Isso também afetou as @ref{45a,,sequências de escape} unicode (como @code{\N@{snowman@}}), pois elas contêm a parte @code{\N} que anteriormente não podia fazer parte dos componentes de expressão de f-strings. Agora, você pode definir expressões 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

Veja 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} para mais detalhes.

Como um efeito colateral positivo de como esse recurso foi implementado (analisando f-strings com o 
@geindex Propostas de Melhorias do Python; PEP 617
analisador GASE ou PEG@footnote{https://peps.python.org/pep-0617/}), agora as mensagens de erro para f-strings são mais precisas e incluem o local exato do erro. Por exemplo, no Python 3.11, a seguinte f-string levanta um @ref{18d,,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

mas a mensagem de erro não inclui o local exato do erro dentro da linha e também tem a expressão artificialmente cercada por parênteses. No Python 3.12, como as f-strings são analisadas com o analisador GASE, as mensagens de erro podem ser mais precisas e mostrar a linha inteira:

@example
>>> minha_string = f"@{x z y@}" + f"@{1 + 1@}"
  File "<stdin>", line 1
    minha_string = f"@{x z y@}" + f"@{1 + 1@}"
                   ^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

(Contribuição de Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou, Cristián Maureira-Fredes e Marta Gómez em gh-102856@footnote{https://github.com/python/cpython/issues/102856}. PEP escrito por Pablo Galindo, Batuhan Taskaya, Lysandros Nikolaou e Marta Gómez).

@node PEP 684 Uma GIL por interpretador,PEP 669 Monitoramento de baixo impacto para CPython,PEP 701 Formalização sintática de f-strings,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-684-a-per-interpreter-gil}@anchor{45b}@anchor{whatsnew/3 12 whatsnew312-pep684}@anchor{43c}
@subsubsection PEP 684: Uma GIL por interpretador


A 
@geindex Propostas de Melhorias do Python; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/} introduz uma @ref{148,,GIL} por interpretador, para que subinterpretadores possam agora ser criados com uma GIL único por interpretador. Isso permite que programas Python aproveitem ao máximo vários núcleos de CPU. Isso está atualmente disponível apenas por meio da API C, embora uma API Python seja 
@geindex Propostas de Melhorias do Python; PEP 554
esperada para 3.13@footnote{https://peps.python.org/pep-0554/}.

Use a nova função @ref{45c,,Py_NewInterpreterFromConfig()} para criar um interpretador com sua própria 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;
@}
/* O novo interpretador agora está ativo na atual thread. */
@end example

Para obter mais exemplos de como usar a API C para subinterpretadores com uma GIL por interpretador, consulte @code{Modules/_xxsubinterpretersmodule.c}.

(Contribuição de Eric Snow em gh-104210@footnote{https://github.com/python/cpython/issues/104210}, etc.)

@node PEP 669 Monitoramento de baixo impacto para CPython,PEP 688 Tornando o protocolo de buffer acessível no Python,PEP 684 Uma GIL por interpretador,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-669-low-impact-monitoring-for-cpython}@anchor{45d}@anchor{whatsnew/3 12 whatsnew312-pep669}@anchor{43d}
@subsubsection PEP 669: Monitoramento de baixo impacto para CPython


A 
@geindex Propostas de Melhorias do Python; PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} define uma nova @ref{da,,API} para perfis, depuradores e outras ferramentas monitorarem eventos no CPython. Ela abrange uma ampla gama de eventos, incluindo chamadas, retornos, linhas, exceções, saltos e mais. Isso significa que você só paga pelo que usa, fornecendo suporte para depuradores e ferramentas de cobertura com sobrecarga quase zero. Veja @ref{da,,sys.monitoring} para mais detalhes.

(Contribuição de Mark Shannon em gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@node PEP 688 Tornando o protocolo de buffer acessível no Python,PEP 709 Fazendo inline de compreensão,PEP 669 Monitoramento de baixo impacto para CPython,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-688-making-the-buffer-protocol-accessible-in-python}@anchor{45e}@anchor{whatsnew/3 12 whatsnew312-pep688}@anchor{440}
@subsubsection PEP 688: Tornando o protocolo de buffer acessível no Python


A 
@geindex Propostas de Melhorias do Python; PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/} apresenta uma maneira de usar o @ref{2e8,,protocolo de buffer} do código Python. As classes que implementam o método @ref{45f,,__buffer__()} agora podem ser usadas como tipos de buffer.

O novo @ref{2e9,,collections.abc.Buffer} ABC fornece uma maneira padrão de representar objetos de buffer, por exemplo, em anotações de tipo. A nova enumeração @ref{460,,inspect.BufferFlags} representa os sinalizadores que podem ser usados para personalizar a criação do buffer. (Contribuição de Jelle Zijlstra em gh-102500@footnote{https://github.com/python/cpython/issues/102500}.)

@node PEP 709 Fazendo inline de compreensão,Mensagens de erro melhoradas<2>,PEP 688 Tornando o protocolo de buffer acessível no Python,Novas funcionalidades<3>
@anchor{whatsnew/3 12 pep-709-comprehension-inlining}@anchor{461}@anchor{whatsnew/3 12 whatsnew312-pep709}@anchor{447}
@subsubsection PEP 709: Fazendo inline de compreensão


As compreensões de dicionário, lista e conjunto agora estão embutidas, em vez de criar um novo objeto função de uso único para cada execução da compreensão. Isso acelera a execução de uma compreensão em até duas vezes. Veja 
@geindex Propostas de Melhorias do Python; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} para mais detalhes.

As variáveis de iteração de compreensão permanecem isoladas e não sobrescrevem uma variável de mesmo nome no escopo externo, nem são visíveis após a compreensão. O uso de inlining resulta em algumas mudanças visíveis de comportamento:


@itemize *

@item 
Não há mais um quadro separado para a compreensão em tracebacks (situação da pilha de execução), e o rastreamento/criação de perfil não mostra mais a compreensão como uma chamada de função.

@item 
O módulo @ref{d8,,symtable} não produzirá mais tabelas de símbolos filhos para cada compreensão; em vez disso, os locais da compreensão serão incluídos na tabela de símbolos da função pai.

@item 
Chamar @ref{141,,locals()} dentro de uma compreensão agora inclui variáveis de fora da compreensão e não inclui mais a variável sintética @code{.0} para o “argumento” de compreensão.

@item 
Uma compreensão que itera diretamente sobre @code{locals()} (por exemplo, @code{[k for k in locals()]}) pode ver “RuntimeError: dictionary changed size during iteration” quando executada sob rastreamento (por exemplo, medição de cobertura de código). Esse é o mesmo comportamento já observado, por exemplo, em @code{for k in locals():}. Para evitar o erro, primeiro crie uma lista de chaves para iterar: @code{keys = list(locals()); [k for k in keys]}.
@end itemize

(Contribuição de Carl Meyer and Vladimir Matveev em 
@geindex Propostas de Melhorias do Python; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}.)

@node Mensagens de erro melhoradas<2>,,PEP 709 Fazendo inline de compreensão,Novas funcionalidades<3>
@anchor{whatsnew/3 12 improved-error-messages}@anchor{43e}
@subsubsection Mensagens de erro melhoradas



@itemize *

@item 
Os módulos da biblioteca padrão agora são potencialmente sugeridos como parte das mensagens de erro exibidas pelo interpretador quando uma exceção @ref{43f,,NameError} é levantada ao nível superior. (Contribuição de Pablo Galindo em 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 
Melhora a sugestão de erro para exceções @ref{43f,,NameError} para instâncias. Agora, se uma exceção @ref{43f,,NameError} for levantada em um método e a instância tiver um atributo que é exatamente igual ao nome na exceção, a sugestão incluirá @code{self.<NOME>} em vez da correspondência mais próxima no escopo do método. (Contribuição de Pablo Galindo em 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 
Melhora a mensagem de erro de @ref{18d,,SyntaxError} quando o usuário digita @code{import x from y} ao invés de @code{from y import x}. (Contribuição de Pablo Galindo em 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 
Exceções @ref{419,,ImportError} levantadas a partir de instruções @code{from <módulo> import <nome>} com falha agora incluem sugestões para o valor de @code{<nome>} com base nos nomes disponíveis em @code{<módulo>}. (Contribuição de Pablo Galindo em 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 Novos recursos relacionados a dicas de tipo,Outras mudanças na linguagem<2>,Novas funcionalidades<3>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 new-features-related-to-type-hints}@anchor{462}
@subsection Novos recursos relacionados a dicas de tipo


Esta seção cobre as principais mudanças que afetam as dicas de tipo da 
@geindex Propostas de Melhorias do Python; PEP 484
dicas de tipo@footnote{https://peps.python.org/pep-0484/} e o módulo @ref{104,,typing}.

@menu
* PEP 692; Usando TypedDict para tipagem mais precisa de **kwargs: PEP 692 Usando TypedDict para tipagem mais precisa de **kwargs. 
* PEP 698; Substitui decorador para tipagem estática: PEP 698 Substitui decorador para tipagem estática. 

@end menu

@node PEP 692 Usando TypedDict para tipagem mais precisa de **kwargs,PEP 698 Substitui decorador para tipagem estática,,Novos recursos relacionados a dicas de tipo
@anchor{whatsnew/3 12 pep-692-using-typeddict-for-more-precise-kwargs-typing}@anchor{463}@anchor{whatsnew/3 12 whatsnew312-pep692}@anchor{448}
@subsubsection PEP 692: Usando @code{TypedDict} para tipagem mais precisa de @code{**kwargs}


A tipagem de @code{**kwargs} em uma assinatura de função conforme introduzido por 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} permitia anotações válidas apenas nos casos em que todos os @code{**kwargs} eram do mesmo tipo.

A 
@geindex Propostas de Melhorias do Python; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} especifica uma maneira mais precisa de definir tipos de @code{**kwargs}, contando com dicionários tipados:

@example
from typing import TypedDict, Unpack

class Filme(TypedDict):
  nome: str
  ano: int

def foo(**kwargs: Unpack[Filme]): ...
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} para mais detalhes.

(Contribuição de Franek Magiera em gh-103629@footnote{https://github.com/python/cpython/issues/103629}.)

@node PEP 698 Substitui decorador para tipagem estática,,PEP 692 Usando TypedDict para tipagem mais precisa de **kwargs,Novos recursos relacionados a dicas de tipo
@anchor{whatsnew/3 12 pep-698-override-decorator-for-static-typing}@anchor{464}@anchor{whatsnew/3 12 whatsnew312-pep698}@anchor{44a}
@subsubsection PEP 698: Substitui decorador para tipagem estática


Um novo decorador @ref{44b,,typing.override()} foi adicionado ao módulo @ref{104,,typing}. Ele indica aos verificadores de tipo que o método se destina a substituir um método em uma superclasse. Isso permite que os verificadores de tipo detectem erros onde um método destinado a substituir algo em uma classe base não o faz de fato.

Exemplo:

@example
from typing import override

class Base:
  def obtém_cor(self) -> str:
    return "azul"

class FilhaBoa(Base):
  @@override  # ok: substitui Base.obtém_cor
  def obtém_cor(self) -> str:
    return "amarelo"

class FilhaRuim(Base):
  @@override  # erro de verificador de tipo: não substitui Base.obtém_cor
  def obtém_cores(self) -> str:
    return "vermelho"
@end example

Consulte 
@geindex Propostas de Melhorias do Python; PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/} para obter mais detalhes.

(Contribuição de Steven Troxler em gh-101561@footnote{https://github.com/python/cpython/issues/101561}.)

@node Outras mudanças na linguagem<2>,Novos módulos<2>,Novos recursos relacionados a dicas de tipo,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 other-language-changes}@anchor{465}
@subsection Outras mudanças na linguagem



@itemize *

@item 
O analisador sintático agora exibe @ref{18d,,SyntaxError} ao analisar o código-fonte que contém bytes nulos. (Contribuição de Pablo Galindo em gh-96670@footnote{https://github.com/python/cpython/issues/96670}.)

@item 
Um par de caracteres de barra invertida que não seja uma sequência de escape válida agora levanta uma exceção @ref{466,,SyntaxWarning}, em vez de @ref{1a5,,DeprecationWarning}. Por exemplo, @code{re.compile("\d+\.\d+")} agora emite um @ref{466,,SyntaxWarning} (@code{"\d"} é uma sequência de escape inválida, use strings brutas para expressão regular: @code{re.compile(r"\d+\.\d+")}). Em uma versão futura do Python, @ref{18d,,SyntaxError} acabará sendo levantada, em vez de @ref{466,,SyntaxWarning}. (Contribuição de Victor Stinner em gh-98401@footnote{https://github.com/python/cpython/issues/98401}.)

@item 
Escapes octais com valor maior do que @code{0o377} (ex: @code{"\477"}), descontinuados no Python 3.11, agora produzem um @ref{466,,SyntaxWarning}, em vez de @ref{1a5,,DeprecationWarning}. Em uma versão futura do Python, eles serão eventualmente um @ref{18d,,SyntaxError}. (Contribuição de Victor Stinner em gh-98401@footnote{https://github.com/python/cpython/issues/98401}.)

@item 
As variáveis usadas na parte de destino das compreensões que não são armazenadas agora podem ser usadas em expressões de atribuição (@code{:=}). Por exemplo, em @code{[(b := 1) for a, b.prop in some_iter]}, a atribuição a @code{b} agora é permitida. Observe que a atribuição a variáveis armazenadas em na parte de destino das compreensões (como @code{a}) ainda não é permitida, conforme 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}. (Contribuição de Nikita Sobolev em gh-100581@footnote{https://github.com/python/cpython/issues/100581}.)

@item 
As exceções levantadas em um método @code{__set_name__} de uma classe ou um tipo não são mais envolvidas por um @ref{195,,RuntimeError}. As informações de contexto são adicionadas à exceção como uma nota 
@geindex Propostas de Melhorias do Python; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}. (Contribuição de Irit Katriel em gh-77757@footnote{https://github.com/python/cpython/issues/77757}.)

@item 
Quando uma construção @code{try-except*} lida com toda a @ref{1b6,,ExceptionGroup} e levanta uma outra exceção, essa exceção não é mais envolvida em uma @ref{1b6,,ExceptionGroup}. Também alterada na versão 3.11.4. (Contribuição de Irit Katriel em gh-103590@footnote{https://github.com/python/cpython/issues/103590}.)

@item 
O coletor de lixo agora é executado somente no mecanismo de quebra de avaliação do laço de avaliação de bytecode do Python em vez de alocações de objetos. O coletor de lixo também pode ser executado quando @ref{467,,PyErr_CheckSignals()} é chamado, de modo que as extensões C que precisam ser executadas por um longo período sem executar nenhum código Python também têm a chance de executar o coletor de lixo periodicamente. (Contribuição de Pablo Galindo em gh-97922@footnote{https://github.com/python/cpython/issues/97922}.)

@item 
Todos os chamáveis internos e de extensão que esperam parâmetros booleanos agora aceitam argumentos de qualquer tipo, em vez de apenas @ref{468,,bool} e @ref{257,,int}. (Contribuição de Serhiy Storchaka em gh-60203@footnote{https://github.com/python/cpython/issues/60203}.)

@item 
@ref{2eb,,memoryview} agora oferece suporte ao tipo meio ponto flutuante (o código de formato “e”). (Contribuição de Donghee Na e Antoine Pitrou em gh-90751@footnote{https://github.com/python/cpython/issues/90751}.)

@item 
Objetos @ref{469,,slice} agora são hasheáveis, permitindo que sejam usados como chaves de dicionário e itens de conjunto. (Contribuição de Will Bradshaw, Furkan Onder e Raymond Hettinger em gh-101264@footnote{https://github.com/python/cpython/issues/101264}.)

@item 
@ref{46a,,sum()} agora usa a soma de Neumaier para melhorar a precisão e comutatividade ao somar valores flutuantes ou misturas de ints e floats. (Contribuição de Raymond Hettinger em gh-100425@footnote{https://github.com/python/cpython/issues/100425}.)

@item 
@ref{1a8,,ast.parse()} agora exibe @ref{18d,,SyntaxError} em vez de @ref{202,,ValueError} ao analisar o código-fonte que contém bytes nulos. (Contribuição de Pablo Galindo em gh-96670@footnote{https://github.com/python/cpython/issues/96670}.)

@item 
Os métodos de extração em @ref{de,,tarfile} e @ref{46b,,shutil.unpack_archive()} têm um novo argumento `filter' que permite limitar os recursos do tar que podem ser surpreendentes ou perigosos, como a criação de arquivos fora do diretório de destino. Consulte @ref{46c,,arquivos de extração de de arquivos tar} para obter detalhes. No Python 3.14, o padrão mudará para @code{'data'}. (Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)

@item 
Instâncias de @ref{46d,,types.MappingProxyType} agora são hasheáveis se o mapeamento subjacente for hasheável (Contribuição de Serhiy Storchaka em gh-87995@footnote{https://github.com/python/cpython/issues/87995}.)

@item 
Adiciona @ref{18f,,suporte ao perfilador perf} por meio da nova variável de ambiente 
@geindex PYTHONPERFSUPPORT
@geindex variável de ambiente; PYTHONPERFSUPPORT
@ref{46e,,PYTHONPERFSUPPORT} e da opção de linha de comando @ref{176,,-X perf}, bem como das novas funções @ref{46f,,sys.activate_stack_trampoline()}, @ref{470,,sys.deactivate_stack_trampoline()} e @ref{471,,sys.is_stack_trampoline_active()}. (Design de Pablo Galindo. Contribuição de Pablo Galindo e Christian Heimes com contribuições de Gregory P. Smith [Google] e Mark Shannon em gh-96123@footnote{https://github.com/python/cpython/issues/96123}).
@end itemize

@node Novos módulos<2>,Módulos melhorados<2>,Outras mudanças na linguagem<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 new-modules}@anchor{472}
@subsection Novos módulos



@itemize *

@item 
Nenhum.
@end itemize

@node Módulos melhorados<2>,Otimizações<2>,Novos módulos<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 improved-modules}@anchor{473}
@subsection Módulos melhorados


@menu
* array: array<2>. 
* asyncio: asyncio<2>. 
* calendar:: 
* csv:: 
* dis: dis<2>. 
* fractions: fractions<2>. 
* importlib.resources: importlib resources. 
* inspect:: 
* itertools: itertools<2>. 
* math: math<2>. 
* os: os<2>. 
* os.path: os path<3>. 
* pathlib: pathlib<3>. 
* platform:: 
* pdb: pdb<2>. 
* random: random<2>. 
* shutil: shutil<2>. 
* sqlite3: sqlite3<2>. 
* statistics: statistics<2>. 
* sys: sys<3>. 
* tempfile: tempfile<2>. 
* threading:: 
* tkinter: tkinter<2>. 
* tokenize:: 
* types: types<2>. 
* typing: typing<3>. 
* unicodedata: unicodedata<2>. 
* unittest: unittest<2>. 
* uuid:: 

@end menu

@node array<2>,asyncio<2>,,Módulos melhorados<2>
@anchor{whatsnew/3 12 array}@anchor{474}
@subsubsection array



@itemize *

@item 
A classe @ref{1a0,,array.array} agora suporta subscrição, tornando-a um @ref{439,,tipo genérico}. (Contribuição de Jelle Zijlstra em gh-98658@footnote{https://github.com/python/cpython/issues/98658}.)
@end itemize

@node asyncio<2>,calendar,array<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 asyncio}@anchor{475}
@subsubsection asyncio



@itemize *

@item 
O desempenho da gravação em soquetes no @ref{a,,asyncio} foi significativamente aprimorado. O @code{asyncio} agora evita cópias desnecessárias ao gravar em soquetes e usa o @ref{476,,sendmsg()} se a plataforma o suportar. (Contribuição de Kumar Aditya em gh-91166@footnote{https://github.com/python/cpython/issues/91166}.)

@item 
Adiciona as funções @ref{477,,asyncio.eager_task_factory()} e @ref{478,,asyncio.create_eager_task_factory()} para permitir a opção de um laço de eventos na execução de tarefas ansiosas, tornando alguns casos de uso de 2x a 5x mais rápidos. (Contribuição de Jacob Bower e Itamar Oren em gh-102853@footnote{https://github.com/python/cpython/issues/102853}, gh-104140@footnote{https://github.com/python/cpython/issues/104140} e gh-104138@footnote{https://github.com/python/cpython/issues/104138})

@item 
No Linux, @ref{a,,asyncio} usa @ref{479,,asyncio.PidfdChildWatcher} por padrão se @ref{47a,,os.pidfd_open()} estiver disponível e funcional em vez de @ref{47b,,asyncio.ThreadedChildWatcher}. (Contribuição de Kumar Aditya em gh-98024@footnote{https://github.com/python/cpython/issues/98024}.)

@item 
O laço de eventos agora usa o melhor observador filho disponível para cada plataforma (@ref{479,,asyncio.PidfdChildWatcher} se suportado e @ref{47b,,asyncio.ThreadedChildWatcher} caso contrário), portanto, configurar manualmente um observador filho não é recomendado. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
Adiciona o parâmetro `loop_factory' a @ref{47c,,asyncio.run()} para permitir a especificação de uma fábrica de laço de eventos personalizada. (Contribuição de Kumar Aditya em gh-99388@footnote{https://github.com/python/cpython/issues/99388}.)

@item 
Adiciona implementação C de @ref{47d,,asyncio.current_task()} para aceleração de 4x-6x. (Contribuição de Itamar Oren e Pranav Thulasiram Bhat em gh-100344@footnote{https://github.com/python/cpython/issues/100344}.)

@item 
@ref{47e,,asyncio.iscoroutine()} agora retorna @code{False} para geradores, pois @ref{a,,asyncio} não tem suporte a corrotinas legadas baseadas em geradores. (Contribuição de Kumar Aditya em gh-102748@footnote{https://github.com/python/cpython/issues/102748}.)

@item 
@ref{47f,,asyncio.wait()} e @ref{1aa,,asyncio.as_completed()} agora aceita geradores que produzem tarefas. (Contribuição de Kumar Aditya em gh-78530@footnote{https://github.com/python/cpython/issues/78530}.)
@end itemize

@node calendar,csv,asyncio<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 calendar}@anchor{480}
@subsubsection calendar



@itemize *

@item 
Adiciona enums @ref{481,,calendar.Month} e @ref{482,,calendar.Day} definindo meses do ano e dias da semana. (Contribuição de Prince Roshan em gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)
@end itemize

@node csv,dis<2>,calendar,Módulos melhorados<2>
@anchor{whatsnew/3 12 csv}@anchor{483}
@subsubsection csv



@itemize *

@item 
Adiciona os sinalizadores @ref{484,,csv.QUOTE_NOTNULL} e @ref{485,,csv.QUOTE_STRINGS} para fornecer um controle mais refinado de @code{None} e strings vazias por objetos @ref{486,,reader} e @ref{487,,writer}.
@end itemize

@node dis<2>,fractions<2>,csv,Módulos melhorados<2>
@anchor{whatsnew/3 12 dis}@anchor{488}
@subsubsection dis



@itemize *

@item 
Opcodes de pseudo-instruções (que são usados pelo compilador, mas não aparecem no bytecode executável) agora são expostos no módulo @ref{38,,dis}. @ref{489,,HAVE_ARGUMENT} ainda é relevante para opcodes reais, mas não é útil para pseudo-instruções. Use a nova coleção @ref{29e,,dis.hasarg}. (Contribuição de Irit Katriel em gh-94216@footnote{https://github.com/python/cpython/issues/94216}.)

@item 
Adiciona a coleção @ref{48a,,dis.hasexc} para indicar instruções que definem um manipulador de exceções. (Contribuição de Irit Katriel em gh-94216@footnote{https://github.com/python/cpython/issues/94216}.)
@end itemize

@node fractions<2>,importlib resources,dis<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 fractions}@anchor{48b}
@subsubsection fractions



@itemize *

@item 
Objetos do tipo @ref{1e7,,fractions.Fraction} agora têm suporte a formatação estilo float. (Contribuição de Mark Dickinson em gh-100161@footnote{https://github.com/python/cpython/issues/100161}.)
@end itemize

@node importlib resources,inspect,fractions<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 importlib-resources}@anchor{48c}
@subsubsection importlib.resources



@itemize *

@item 
@ref{48d,,importlib.resources.as_file()} agora tem suporta a diretórios de recursos. (Contribuição de Jason R. Coombs em gh-97930@footnote{https://github.com/python/cpython/issues/97930}.)

@item 
Renomeia o primeiro parâmetro de @ref{48e,,importlib.resources.files()} para `anchor'. (Contribuição de Jason R. Coombs em gh-100598@footnote{https://github.com/python/cpython/issues/100598}.)
@end itemize

@node inspect,itertools<2>,importlib resources,Módulos melhorados<2>
@anchor{whatsnew/3 12 inspect}@anchor{48f}
@subsubsection inspect



@itemize *

@item 
Adiciona @ref{490,,inspect.markcoroutinefunction()} para marcar funções de sincronização que retornam uma @ref{491,,corrotina} para uso com @ref{2e4,,inspect.iscoroutinefunction()}. (Contribuição de Carlton Gibson em gh-99247@footnote{https://github.com/python/cpython/issues/99247}.)

@item 
Adiciona @ref{492,,inspect.getasyncgenstate()} e @ref{493,,inspect.getasyncgenlocals()} para determinar o estado atual dos geradores assíncronos. (Contribuição de Thomas Krennwallner em gh-79940@footnote{https://github.com/python/cpython/issues/79940}.)

@item 
O desempenho de @ref{494,,inspect.getattr_static()} foi consideravelmente melhorado. A maioria das chamadas para a função deve ser pelo menos 2x mais rápida do que no Python 3.11. (Contribuição de Alex Waygood em gh-103193@footnote{https://github.com/python/cpython/issues/103193}.)
@end itemize

@node itertools<2>,math<2>,inspect,Módulos melhorados<2>
@anchor{whatsnew/3 12 itertools}@anchor{495}
@subsubsection itertools



@itemize *

@item 
Adiciona @ref{201,,itertools.batched()} para coletar tuplas de tamanhos iguais, onde o último lote pode ser menor que o resto. (Contribuição de Raymond Hettinger em gh-98363@footnote{https://github.com/python/cpython/issues/98363}.)
@end itemize

@node math<2>,os<2>,itertools<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 math}@anchor{496}
@subsubsection math



@itemize *

@item 
Adiciona @ref{497,,math.sumprod()} para calcular uma soma de produtos. (Contribuição de Raymond Hettinger em gh-100485@footnote{https://github.com/python/cpython/issues/100485}.)

@item 
Estende @ref{498,,math.nextafter()} para incluir um argumento `steps' para subir ou descer várias etapas ao mesmo tempo. (Contribuição de Matthias Goergens, Mark Dickinson e Raymond Hettinger em gh-94906@footnote{https://github.com/python/cpython/issues/94906}.)
@end itemize

@node os<2>,os path<3>,math<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 os}@anchor{499}
@subsubsection os



@itemize *

@item 
Adiciona @ref{49a,,os.PIDFD_NONBLOCK} para abrir um descritor de arquivo para um processo com @ref{47a,,os.pidfd_open()} em modo sem bloqueio. (Contribuição de Kumar Aditya em gh-93312@footnote{https://github.com/python/cpython/issues/93312}.)

@item 
@ref{49b,,os.DirEntry} agora inclui um método @ref{49c,,os.DirEntry.is_junction()} para verificar se a entrada é uma junção. (Contribuição de Charles Machalow em gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Adiciona funções @ref{49d,,os.listdrives()}, @ref{49e,,os.listvolumes()} e @ref{49f,,os.listmounts()} no Windows para enumerar unidades, volumes e pontos de montagem. (Contribuição de Steve Dower em gh-102519@footnote{https://github.com/python/cpython/issues/102519}.)

@item 
@ref{4a0,,os.stat()} e @ref{4a1,,os.lstat()} agora são mais precisos no Windows. O campo @code{st_birthtime} agora será preenchido com a hora de criação do arquivo, e @code{st_ctime} foi descontinuado, mas ainda contém a hora de criação (mas no futuro vai retornar a última alteração de metadados, para consistência com outras plataformas ). @code{st_dev} pode ter até 64 bits e @code{st_ino} até 128 bits dependendo do seu sistema de arquivos, e @code{st_rdev} é sempre definido como zero em vez de valores incorretos. Ambas as funções podem ser significativamente mais rápidas nas lançamentos mais recentes do Windows. (Contribuição de Steve Dower em gh-99726@footnote{https://github.com/python/cpython/issues/99726}.)
@end itemize

@node os path<3>,pathlib<3>,os<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 os-path}@anchor{4a2}
@subsubsection os.path



@itemize *

@item 
Adiciona @ref{4a3,,os.path.isjunction()} para verificar se um determinado caminho é uma junção. (Contribuição de Charles Machalow em gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Adiciona @ref{4a4,,os.path.splitroot()} para dividir um caminho em uma tríade @code{(drive, root, tail)}. (Contribuição de Barney Gale em gh-101000@footnote{https://github.com/python/cpython/issues/101000}.)
@end itemize

@node pathlib<3>,platform,os path<3>,Módulos melhorados<2>
@anchor{whatsnew/3 12 pathlib}@anchor{4a5}
@subsubsection pathlib



@itemize *

@item 
Adiciona suporte para fazer subclasse de @ref{4a6,,pathlib.PurePath} e @ref{229,,pathlib.Path}, além de suas variantes específicas do Posix e do Windows. As subclasses podem substituir o método @ref{4a7,,pathlib.PurePath.with_segments()} para passar informações entre instâncias de caminho.

@item 
Adiciona @ref{4a8,,pathlib.Path.walk()} para percorrer as árvores de diretórios e gerar todos os nomes de arquivos ou diretórios dentro delas, semelhante a @ref{4a9,,os.walk()}. (Contribuição de Stanislav Zmiev em gh-90385@footnote{https://github.com/python/cpython/issues/90385}.)

@item 
Adiciona o parâmetro opcional `walk_up' a @ref{2ca,,pathlib.PurePath.relative_to()} para permitir a inserção de entradas @code{..} no resultado; este comportamento é mais consistente com @ref{4aa,,os.path.relpath()}. (Contribuição de Domenico Ragusa em gh-84538@footnote{https://github.com/python/cpython/issues/84538}.)

@item 
Adiciona @ref{4ab,,pathlib.Path.is_junction()} como proxy para @ref{4a3,,os.path.isjunction()}. (Contribuição de Charles Machalow em gh-99547@footnote{https://github.com/python/cpython/issues/99547}.)

@item 
Adiciona o parâmetro opcional `case_sensitive' a @ref{22d,,pathlib.Path.glob()}, @ref{22e,,pathlib.Path.rglob()} e @ref{4ac,,pathlib.PurePath.match()} para fazer correspondência com distinção entre maiúsculas e minúsculas do caminho, permitindo uma precisão mais precisa controle sobre o processo de correspondência.
@end itemize

@node platform,pdb<2>,pathlib<3>,Módulos melhorados<2>
@anchor{whatsnew/3 12 platform}@anchor{4ad}
@subsubsection platform



@itemize *

@item 
Adiciona suporte para detectar versões do Windows 11 e do Windows Server posteriores a 2012. Anteriormente, pesquisas em plataformas Windows Server mais recentes que o Windows Server 2012 e no Windows 11 retornariam @code{Windows-10}. (Contribuição de Steve Dower em gh-89545@footnote{https://github.com/python/cpython/issues/89545}.)
@end itemize

@node pdb<2>,random<2>,platform,Módulos melhorados<2>
@anchor{whatsnew/3 12 pdb}@anchor{4ae}
@subsubsection pdb



@itemize *

@item 
Adiciona variáveis de conveniência para armazenar valores temporariamente para a sessão de depuração e fornece acesso rápido a valores como o quadro atual ou o valor de retorno. (Contribuição de Tian Gao em gh-103693@footnote{https://github.com/python/cpython/issues/103693}.)
@end itemize

@node random<2>,shutil<2>,pdb<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 random}@anchor{4af}
@subsubsection random



@itemize *

@item 
Adiciona @ref{4b0,,random.binomialvariate()}. (Contribuição de Raymond Hettinger em gh-81620@footnote{https://github.com/python/cpython/issues/81620}.)

@item 
Adiciona um padrão de @code{lambd=1.0} a @ref{4b1,,random.expovariate()}. (Contribuição de Raymond Hettinger em gh-100234@footnote{https://github.com/python/cpython/issues/100234}.)
@end itemize

@node shutil<2>,sqlite3<2>,random<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 shutil}@anchor{4b2}
@subsubsection shutil



@itemize *

@item 
@ref{4b3,,shutil.make_archive()} agora passa o argumento `root_dir' para arquivadores personalizados que o suportam. Neste caso, ele não altera mais temporariamente o diretório de trabalho atual do processo para `root_dir' para realizar o arquivamento. (Contribuição de Serhiy Storchaka em gh-74696@footnote{https://github.com/python/cpython/issues/74696}.)

@item 
@ref{301,,shutil.rmtree()} agora aceita um novo argumento `onexc' que é um tratador de erros como `onerror' mas que espera uma instância de exceção em vez de um trio `(typ, val, tb)'. `onerror' foi descontinuado. (Contribuição de Irit Katriel em gh-102828@footnote{https://github.com/python/cpython/issues/102828}.)

@item 
@code{shutil. which()} agora consulta a variável de ambiente `PATHEXT' para encontrar correspondências dentro de `PATH' no Windows mesmo quando o `cmd' fornecido inclui um componente de diretório. (Contribuição de Charles Machalow em gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)

@code{shutil. which()} chamará @code{NeedCurrentDirectoryForExePathW} ao consultar executáveis no Windows para determinar se o diretório de trabalho atual deve ser anexado ao caminho de pesquisa. (Contribuição de Charles Machalow em gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)

@ref{4b4,,shutil.which()} vai retornar um caminho que corresponde ao `cmd' com um componente de @code{PATHEXT} antes de uma correspondência direta em outro lugar no caminho de pesquisa no Windows. (Contribuição de Charles Machalow em gh-103179@footnote{https://github.com/python/cpython/issues/103179}.)
@end itemize

@node sqlite3<2>,statistics<2>,shutil<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 sqlite3}@anchor{4b5}
@subsubsection sqlite3



@itemize *

@item 
Adiciona uma @ref{441,,interface de linha de comando}. (Contribuição de Erlend E. Aasland em gh-77617@footnote{https://github.com/python/cpython/issues/77617}.)

@item 
Adiciona o atributo @ref{4b6,,sqlite3.Connection.autocommit} a @ref{245,,sqlite3.Connection} e o parâmetro `autocommit' a @ref{2a8,,sqlite3.connect()} para controlar a 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} compatível com @ref{4b7,,tratamento de transação}. (Contribuição de Erlend E. Aasland em gh-83638@footnote{https://github.com/python/cpython/issues/83638}.)

@item 
Adiciona o parâmetro somente-nomeado `entrypoint' a @ref{4b8,,sqlite3.Connection.load_extension()}, para substituir o ponto de entrada da extensão SQLite. (Contribuição de Erlend E. Aasland em gh-103015@footnote{https://github.com/python/cpython/issues/103015}.)

@item 
Adiciona @ref{4b9,,sqlite3.Connection.getconfig()} e @ref{4ba,,sqlite3.Connection.setconfig()} a @ref{245,,sqlite3.Connection} para fazer alterações na configuração de uma conexão de banco de dados. (Contribuição de Erlend E. Aasland em gh-103489@footnote{https://github.com/python/cpython/issues/103489}.)
@end itemize

@node statistics<2>,sys<3>,sqlite3<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 statistics}@anchor{4bb}
@subsubsection statistics



@itemize *

@item 
Estende @ref{4bc,,statistics.correlation()} para incluir como um método @code{ranked} para calcular a correlação de Spearman de dados classificados. (Contribuição de Raymond Hettinger em gh-95861@footnote{https://github.com/python/cpython/issues/95861}.)
@end itemize

@node sys<3>,tempfile<2>,statistics<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 sys}@anchor{4bd}
@subsubsection sys



@itemize *

@item 
Adiciona o espaço de nomes @ref{da,,sys.monitoring} para expor a nova API de monitoramento @ref{43d,,PEP 669}. (Contribuição de Mark Shannon em gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@item 
Adiciona @ref{46f,,sys.activate_stack_trampoline()} e @ref{470,,sys.deactivate_stack_trampoline()} para ativar e desativar trampolins do perfilador de pilha e @ref{471,,sys.is_stack_trampoline_active()} para consultar se os trampolins do perfilador de pilha estão ativos. (Contribuição de Pablo Galindo e Christian Heimes com contribuições de Gregory P. Smith [Google] e Mark Shannon em gh-96123@footnote{https://github.com/python/cpython/issues/96123}.)

@item 
Adiciona @ref{4be,,sys.last_exc} que contém a última exceção não tratada que foi levantada (para casos de uso de depuração post-mortem). Descontinuar os três campos que possuem as mesmas informações em seu formato legado: @ref{4bf,,sys.last_type}, @ref{4c0,,sys.last_value} e @ref{4c1,,sys.last_traceback}. (Contribuição de Irit Katriel em gh-102778@footnote{https://github.com/python/cpython/issues/102778}.)

@item 
@ref{4c2,,sys._current_exceptions()} agora retorna um mapeamento de thread-id para uma instância de exceção, ao invés de uma tupla @code{(typ, exc, tb)}. (Contribuição de Irit Katriel em gh-103176@footnote{https://github.com/python/cpython/issues/103176}.)

@item 
@ref{4c3,,sys.setrecursionlimit()} e @ref{4c4,,sys.getrecursionlimit()}. O limite de recursão agora se aplica apenas ao código Python. As funções integradas não usam o limite de recursão, mas são protegidas por um mecanismo diferente que evita que a recursão cause uma falha na máquina virtual.
@end itemize

@node tempfile<2>,threading,sys<3>,Módulos melhorados<2>
@anchor{whatsnew/3 12 tempfile}@anchor{4c5}
@subsubsection tempfile



@itemize *

@item 
A função @ref{4c6,,tempfile.NamedTemporaryFile} tem um novo parâmetro opcional `delete_on_close' (Contribuição de Evgeny Zorin em gh-58451@footnote{https://github.com/python/cpython/issues/58451}.)

@item 
@ref{21f,,tempfile.mkdtemp()} agora sempre retorna um caminho absoluto, mesmo se o argumento fornecido para o parâmetro `dir' for um caminho relativo.
@end itemize

@node threading,tkinter<2>,tempfile<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 threading}@anchor{4c7}
@subsubsection threading



@itemize *

@item 
Adiciona @ref{4c8,,threading.settrace_all_threads()} e @ref{4c9,,threading.setprofile_all_threads()} que permitem definir funções de rastreamento e criação de perfil em todos os threads em execução além do que está chamando. (Contribuição de Pablo Galindo em gh-93503@footnote{https://github.com/python/cpython/issues/93503}.)
@end itemize

@node tkinter<2>,tokenize,threading,Módulos melhorados<2>
@anchor{whatsnew/3 12 tkinter}@anchor{4ca}
@subsubsection tkinter



@itemize *

@item 
@code{tkinter.Canvas.coords()} agora nivela seus argumentos. Agora ele aceita não apenas coordenadas como argumentos separados (@code{x1, y1, x2, y2, ...}) e uma sequência de coordenadas (@code{[x1, y1, x2, y2, ...]}) , mas também coordenadas agrupadas em pares (@code{(x1, y1), (x2, y2), ...} e @code{[(x1, y1), (x2, y2), ...]}) , como métodos @code{create_*()}. (Contribuição de Serhiy Storchaka em gh-94473@footnote{https://github.com/python/cpython/issues/94473}.)
@end itemize

@node tokenize,types<2>,tkinter<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 tokenize}@anchor{4cb}
@subsubsection tokenize



@itemize *

@item 
O módulo @ref{fb,,tokenize} inclui as mudanças introduzidas em 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. (Contribuição de Marta Gómez Macías e Pablo Galindo em gh-102856@footnote{https://github.com/python/cpython/issues/102856}.) Veja @ref{4cc,,Portando para Python 3.12} para mais informações sobre as mudanças no módulo @ref{fb,,tokenize}.
@end itemize

@node types<2>,typing<3>,tokenize,Módulos melhorados<2>
@anchor{whatsnew/3 12 types}@anchor{4cd}
@subsubsection types



@itemize *

@item 
Adiciona @ref{4ce,,types.get_original_bases()} para permitir uma introspecção adicional de @ref{4cf,,Tipos genéricos definidos pelo usuário} quando subclassificado. (Contribuição de James Hilton-Balfe e Alex Waygood em gh-101827@footnote{https://github.com/python/cpython/issues/101827}.)
@end itemize

@node typing<3>,unicodedata<2>,types<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 typing}@anchor{4d0}@anchor{whatsnew/3 12 whatsnew-typing-py312}@anchor{4d1}
@subsubsection typing



@itemize *

@item 
As verificações de @ref{442,,isinstance()} com @ref{443,,protocolos verificáveis em tempo de execução} agora use @ref{494,,inspect.getattr_static()} em vez de @ref{4d2,,hasattr()} para verificar se existem atributos. Isso significa que descritores e métodos @ref{4d3,,__getattr__()} não são mais avaliados inesperadamente durante verificações @code{isinstance()} em protocolos verificáveis em tempo de execução. No entanto, também pode significar que alguns objetos que costumavam ser considerados instâncias de um protocolo verificável em tempo de execução podem não ser mais considerados instâncias desse protocolo no Python 3.12+ e vice-versa. É improvável que a maioria dos usuários seja afetada por esta mudança. (Contribuição de Alex Waygood em gh-102433@footnote{https://github.com/python/cpython/issues/102433}.)

@item 
Os membros de um protocolo verificável em tempo de execução agora são considerados “congelados” em tempo de execução assim que a classe é criada. Fazer alterações dinâmicas em atributos em tempo de execução em um protocolo verificável em tempo de execução ainda vai funcionário, mas não terá impacto nas verificações de @ref{442,,isinstance()} comparando objetos com o protocolo. Por exemplo:

@example
>>> from typing import Protocol, runtime_checkable
>>> @@runtime_checkable
... class TemX(Protocol):
...     x = 1
...
>>> class Foo: ...
...
>>> f = Foo()
>>> isinstance(f, TemX)
False
>>> f.x = 1
>>> isinstance(f, TemX)
True
>>> HasX.y = 2
>>> isinstance(f, TemX)  # inalterado, ainda que TemX agora tenha um atributo "y"
True
@end example

Esta mudança foi feita para acelerar as verificações de @code{isinstance()} em protocolos verificáveis em tempo de execução.

@item 
O perfil de desempenho de verificações de @ref{442,,isinstance()} com @ref{443,,protocolos verificáveis em tempo de execução} mudou significativamente. A maioria das verificações @code{isinstance()} a esses protocolos com apenas alguns membros devem ser pelo menos 2x mais rápidas que na versão 3.11, e algumas podem ser 20x mais rápidas ou mais. No entanto, as verificações de @code{isinstance()} em protocolos com muito mais membros podem ser mais lentas do que no Python 3.11. (Contribuição de Alex Waygood em gh-74690@footnote{https://github.com/python/cpython/issues/74690} e gh-103193@footnote{https://github.com/python/cpython/issues/103193}.)

@item 
Todas as classes @ref{162,,typing.TypedDict} e @ref{2b0,,typing.NamedTuple} agora possuem o atributo @code{__orig_bases__}. (Contribuição de Adrian Garcia Badaracco em gh-103699@footnote{https://github.com/python/cpython/issues/103699}.)

@item 
Adiciona o parâmetro @code{frozen_default} a @ref{4d4,,typing.dataclass_transform()}. (Contribuição de Erik De Bonte em gh-99957@footnote{https://github.com/python/cpython/issues/99957}.)
@end itemize

@node unicodedata<2>,unittest<2>,typing<3>,Módulos melhorados<2>
@anchor{whatsnew/3 12 unicodedata}@anchor{4d5}
@subsubsection unicodedata



@itemize *

@item 
O banco de dados Unicode foi atualizado para a versão 15.0.0. (Contribuição de Benjamin Peterson em gh-96734@footnote{https://github.com/python/cpython/issues/96734}).
@end itemize

@node unittest<2>,uuid,unicodedata<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 unittest}@anchor{4d6}
@subsubsection unittest


Adiciona uma opção de linha de comando @code{--durations}, mostrando os N casos de teste mais 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

(Contribuição de Giampaolo Rodola em gh-48330@footnote{https://github.com/python/cpython/issues/48330})

@node uuid,,unittest<2>,Módulos melhorados<2>
@anchor{whatsnew/3 12 uuid}@anchor{4d7}
@subsubsection uuid



@itemize *

@item 
Adiciona uma @ref{441,,interface de linha de comando}. (Contribuição de Adam Chhina em gh-88597@footnote{https://github.com/python/cpython/issues/88597}.)
@end itemize

@node Otimizações<2>,Alterações de bytecode do CPython<2>,Módulos melhorados<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 optimizations}@anchor{4d8}
@subsection Otimizações



@itemize *

@item 
Remove os membros @code{wstr} e @code{wstr_length} dos objetos Unicode. Reduz o tamanho do objeto em 8 ou 16 bytes na plataforma de 64 bits. (
@geindex Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}) (Contribuição de Inada Naoki em gh-92536@footnote{https://github.com/python/cpython/issues/92536}.)

@item 
Adiciona suporte experimental para usar o otimizador binário BOLT no processo de construção, o que melhora o desempenho de 1 a 5%. (Contribuição de Kevin Modzelewski em gh-90536@footnote{https://github.com/python/cpython/issues/90536} e ajuste de Donghee Na em gh-101525@footnote{https://github.com/python/cpython/issues/101525})

@item 
Acelera a substituição de expressões regulares (funções @ref{2a3,,re.sub()} e @ref{2a4,,re.subn()} e métodos @code{re.Pattern} correspondentes) para strings de substituição contendo referências de grupo em 2 ou 3 vezes . (Contribuição de Serhiy Storchaka em gh-91524@footnote{https://github.com/python/cpython/issues/91524}.)

@item 
Acelera a criação de @ref{1be,,asyncio.Task} adiando a dispendiosa formatação de strings. (Contribuição de Itamar Oren em gh-103793@footnote{https://github.com/python/cpython/issues/103793}.)

@item 
As funções @ref{4d9,,tokenize.tokenize()} e @ref{4da,,tokenize.generate_tokens()} são até 64% mais rápidas como efeito colateral das mudanças necessárias para cobrir 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} no módulo @ref{fb,,tokenize} . (Contribuição de Marta Gómez Macías e Pablo Galindo em gh-102856@footnote{https://github.com/python/cpython/issues/102856}.)

@item 
Acelera chamadas de métodos @ref{4db,,super()} e carregamentos de atributos através da nova instrução @ref{4dc,,LOAD_SUPER_ATTR}. (Contribuição de Carl Meyer e Vladimir Matveev em gh-103497@footnote{https://github.com/python/cpython/issues/103497}.)
@end itemize

@node Alterações de bytecode do CPython<2>,Ferramentas e daemons,Otimizações<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 cpython-bytecode-changes}@anchor{4dd}
@subsection Alterações de bytecode do CPython



@itemize *

@item 
Remove a instrução @code{LOAD_METHOD}. Ela foi mesclada em @ref{4de,,LOAD_ATTR}. @ref{4de,,LOAD_ATTR} agora se comportará como a antiga instrução @code{LOAD_METHOD} se o bit inferior de seu oparg estiver definido. (Contribuição de Ken Jin em gh-93429@footnote{https://github.com/python/cpython/issues/93429}.)

@item 
Remova as instruções @code{JUMP_IF_FALSE_OR_POP} e @code{JUMP_IF_TRUE_OR_POP}. (Contribuição de Irit Katriel em gh-102859@footnote{https://github.com/python/cpython/issues/102859}.)

@item 
Remove a instrução @code{PRECALL}. (Contribuição de Mark Shannon em gh-92925@footnote{https://github.com/python/cpython/issues/92925}.)

@item 
Adiciona as instruções @ref{4df,,BINARY_SLICE} e @ref{4e0,,STORE_SLICE}. (Contribuição de Mark Shannon em gh-94163@footnote{https://github.com/python/cpython/issues/94163}.)

@item 
Adiciona as instruções @ref{4e1,,CALL_INTRINSIC_1}. (Contribuição de Mark Shannon em gh-99005@footnote{https://github.com/python/cpython/issues/99005}.)

@item 
Adiciona a instrução @ref{4e2,,CALL_INTRINSIC_2}. (Contribuição de Irit Katriel em gh-101799@footnote{https://github.com/python/cpython/issues/101799}.)

@item 
Adiciona a instrução @ref{4e3,,CLEANUP_THROW}. (Contribuição de Brandt Bucher em gh-90997@footnote{https://github.com/python/cpython/issues/90997}.)

@item 
Adiciona a instrução @code{END_SEND}. (Contribuição de Mark Shannon em gh-103082@footnote{https://github.com/python/cpython/issues/103082}.)

@item 
Adiciona a instrução @ref{4e4,,LOAD_FAST_AND_CLEAR} como parte da implementação de 
@geindex Propostas de Melhorias do Python; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}. (Contribuição de Carl Meyer em gh-101441@footnote{https://github.com/python/cpython/issues/101441}.)

@item 
Adiciona a instrução @ref{4e5,,LOAD_FAST_CHECK}. (Contribuição de Dennis Sweeney em gh-93143@footnote{https://github.com/python/cpython/issues/93143}.)

@item 
Adiciona os opcodes @ref{4e6,,LOAD_FROM_DICT_OR_DEREF}, @ref{4e7,,LOAD_FROM_DICT_OR_GLOBALS} e @ref{4e8,,LOAD_LOCALS} como parte da implementação da 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}. Remove o opcode @code{LOAD_CLASSDEREF}, que pode ser substituído por @ref{4e8,,LOAD_LOCALS} mais @ref{4e6,,LOAD_FROM_DICT_OR_DEREF}. (Contribuição de Jelle Zijlstra em gh-103764@footnote{https://github.com/python/cpython/issues/103764}.)

@item 
Adiciona a instrução @ref{4dc,,LOAD_SUPER_ATTR}. (Contribuição de Carl Meyer e Vladimir Matveev em gh-103497@footnote{https://github.com/python/cpython/issues/103497}.)

@item 
Adiciona a instrução @ref{4e9,,RETURN_CONST}. (Contribuição de Wenyang Wang em gh-101632@footnote{https://github.com/python/cpython/issues/101632}.)
@end itemize

@node Ferramentas e daemons,Descontinuados,Alterações de bytecode do CPython<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 demos-and-tools}@anchor{4ea}
@subsection Ferramentas e daemons



@itemize *

@item 
Remove o diretório @code{Tools/demo/} que continha scripts antigos de demonstração. Uma cópia pode ser encontrada no projeto old-demos@footnote{https://github.com/gvanrossum/old-demos}. (Contribuição de Victor Stinner em gh-97681@footnote{https://github.com/python/cpython/issues/97681}.)

@item 
Remove scripts de exemplo desatualizados do diretório @code{Tools/scripts/}. Uma cópia pode ser encontrada no projeto old-demos@footnote{https://github.com/gvanrossum/old-demos}. (Contribuição de Victor Stinner em gh-97669@footnote{https://github.com/python/cpython/issues/97669}.)
@end itemize

@node Descontinuados,Removidos,Ferramentas e daemons,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 deprecated}@anchor{4eb}
@subsection Descontinuados



@itemize *

@item 
@ref{6,,argparse}: Os parâmetros `type', `choices' e `metavar' de @code{argparse.BooleanOptionalAction} foram descontinuados e serão removidos na versão 3.14. (Contribuição de Nikita Sobolev em gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{8,,ast}: Os seguintes recursos @ref{8,,ast} foram descontinuados na documentação desde Python 3.8, agora fazem com que um @ref{1a5,,DeprecationWarning} seja emitido em tempo de execução quando eles são acessados ou usados, e serão removidos no 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

Em vez disso, use @ref{2b9,,ast.Constant}. (Contribuição de Serhiy Storchaka em gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{a,,asyncio}:


@itemize *

@item 
As classes filhas do observador @ref{2ba,,asyncio.MultiLoopChildWatcher}, @ref{2bb,,asyncio.FastChildWatcher}, @ref{2bc,,asyncio.AbstractChildWatcher} e @ref{2bd,,asyncio.SafeChildWatcher} foram descontinuadas e serão removidas no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@ref{2be,,asyncio.set_child_watcher()}, @ref{2bf,,asyncio.get_child_watcher()}, @ref{2c0,,asyncio.AbstractEventLoopPolicy.set_child_watcher()} e @ref{2c1,,asyncio.AbstractEventLoopPolicy.get_child_watcher()} foram descontinuados e serão removidos no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
O método @ref{2c2,,get_event_loop()} da política de laço de eventos padrão agora emite um @ref{1a5,,DeprecationWarning} se não houver nenhum laço de eventos atual definido e decidir criar um. (Contribuição de Serhiy Storchaka e Guido van Rossum em gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{14,,calendar}: as constantes @code{calendar.January} e @code{calendar.February} foram descontinuadas e substituídas por @ref{2f9,,calendar.JANUARY} e @ref{2fa,,calendar.FEBRUARY}. (Contribuição de Prince Roshan em gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{1e,,collections.abc}: Descontinuou @ref{2e7,,collections.abc.ByteString}.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)

@item 
@ref{30,,datetime}: @ref{2fc,,utcnow()} e @ref{2fd,,utcfromtimestamp()} da classe @ref{1cc,,datetime.datetime} foram descontinuados e serão removidos em uma versão futura. Em vez disso, use objetos conscientes do fuso horário para representar datas e horas em UTC: respectivamente, chame @ref{4ec,,now()} e @ref{4ed,,fromtimestamp()} com o parâmetro `tz' definido como @ref{4ee,,datetime.UTC}. (Contribuição de Paul Ganssle em gh-103857@footnote{https://github.com/python/cpython/issues/103857}.)

@item 
@ref{3b,,email}: Descontinua o parâmetro `isdst' em @ref{2c4,,email.utils.localtime()}. (Contribuição de Alan Williams em gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc}: Foram descontinuadas as seguintes classes, programadas para remoção no Python 3.14:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Em vez disso, use classes de @ref{7c,,importlib.resources.abc}:


@itemize *

@item 
@ref{1f3,,importlib.resources.abc.Traversable}

@item 
@ref{2c5,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribuição de Jason R. Coombs e Hugo van Kemenade em gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools}: Descontinua o suporte para operações de cópia, deepcopy e pickle, que é não documentado, ineficiente, historicamente cheio de bugs e inconsistente. Isso será removido na versão 3.14 para uma redução significativa no volume de código e na carga de manutenção. (Contribuição de Raymond Hettinger em gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: No Python 3.14, o método de início padrão de @ref{94,,multiprocessing} será alterado para um mais seguro no Linux, BSDs e outras plataformas POSIX não-macOS onde @code{'fork'} é atualmente o padrão (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adicionar um aviso em tempo de execução sobre isso foi considerado muito perturbador, pois não se espera que a maior parte do código se importe. Use as APIs @ref{2c6,,get_context()} ou @ref{2c7,,set_start_method()} para especificar explicitamente quando seu código `requer' @code{'fork'}. Veja @ref{2c8,,contextos e métodos de início}.

@item 
@ref{a9,,pkgutil}: @ref{2cb,,pkgutil.find_loader()} e @ref{2cc,,pkgutil.get_loader()} foram descontinuados e serão removidos no Python 3.14; use @ref{2cd,,importlib.util.find_spec()} em vez disso. (Contribuição de Nikita Sobolev em gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}: O módulo tem duas funções @code{master_open()} e @code{slave_open()} não documentadas que foram descontinuados desde Python 2, mas só ganharam um @ref{1a5,,DeprecationWarning} adequado em 3.12. Remova-os em 3.14. (Contribuição de Soumendra Ganguly e Gregory P. Smith em gh-85984@footnote{https://github.com/python/cpython/issues/85984}.)

@item 
@ref{a1,,os}:


@itemize *

@item 
Os campos @code{st_ctime} retornados por @ref{4a0,,os.stat()} e @ref{4a1,,os.lstat()} no Windows foram descontinuados. Em um lançamento futuro, eles conterão o horário da última alteração de metadados, consistente com outras plataformas. Por enquanto, eles ainda contêm o horário de criação, que também está disponível no novo campo @code{st_birthtime}. (Contribuição de Steve Dower em gh-99726@footnote{https://github.com/python/cpython/issues/99726}.)

@item 
Nas plataformas POSIX, @ref{197,,os.fork()} agora pode levantar uma exceção @ref{1a5,,DeprecationWarning} quando puder detectar a chamada de um processo multithread. Sempre houve uma incompatibilidade fundamental com a plataforma POSIX ao fazer isso. Mesmo que esse código `pareça' funcionar. Adicionamos o aviso para aumentar a conscientização, pois os problemas encontrados pelo código ao fazer isso estão se tornando mais frequentes. Veja a documentação @ref{197,,os.fork()} para mais detalhes junto com esta discussão sobre fork ser incompatível com threads@footnote{https://discuss.python.org/t/concerns-regarding-deprecation-of-fork-with-alive-threads/33555} para `por que' estamos agora trazendo à tona esse antigo problema de compatibilidade de plataforma para os desenvolvedores.
@end itemize

Quando este aviso aparece devido ao uso de @ref{94,,multiprocessing} ou @ref{21,,concurrent.futures}, a correção é usar um método de início de @ref{94,,multiprocessing} diferente, como @code{"spawn"} ou @code{"forkserver"}.

@item 
@ref{c5,,shutil}: O argumento `onerror' de @ref{301,,shutil.rmtree()} foi descontinuado; use `onexc' em vez disso. (Contribuição de Irit Katriel em gh-102828@footnote{https://github.com/python/cpython/issues/102828}.)

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@ref{4ef,,adaptadores e conversores padrão} agora foram descontinuados. Em vez disso, use @ref{4f0,,Adapter and converter recipes} e adapte-os às suas necessidades. (Contribuição de Erlend E. Aasland em gh-90016@footnote{https://github.com/python/cpython/issues/90016}.)

@item 
Em @ref{2d1,,execute()}, @ref{1a5,,DeprecationWarning} agora é emitida quando @ref{2d3,,espaços reservados nomeados} são usados junto com parâmetros fornecidos como @ref{4f1,,sequência} em vez de como @ref{256,,dict}. A partir do Python 3.14, usar espaços reservados nomeados com parâmetros fornecidos como uma sequência vai levantar uma @ref{4f2,,ProgrammingError}. (Contribuição de Erlend E. Aasland em gh-101698@footnote{https://github.com/python/cpython/issues/101698}.)
@end itemize

@item 
@ref{d9,,sys}: Os campos @ref{4bf,,sys.last_type}, @ref{4c0,,sys.last_value} e @ref{4c1,,sys.last_traceback} foram descontinuados. Use @ref{4be,,sys.last_exc} em vez disso. (Contribuição de Irit Katriel em gh-102778@footnote{https://github.com/python/cpython/issues/102778}.)

@item 
@ref{de,,tarfile}: Extrair arquivos tar sem especificar `filter' foi descontinuado até Python 3.14, quando o filtro @code{'data'} se tornará o padrão. Veja @ref{46c,,Filtros de extração} para detalhes.

@item 
@ref{104,,typing}:


@itemize *

@item 
@ref{4f3,,typing.Hashable} e @ref{4f4,,typing.Sized}, apelidos forem @ref{4f5,,collections.abc.Hashable} e @ref{4f6,,collections.abc.Sized} respectivamente, foram descontinuados. (gh-94309@footnote{https://github.com/python/cpython/issues/94309}.)

@item 
@ref{2ee,,typing.ByteString}, descontinuado desde Python 3.9, agora faz com que um @ref{1a5,,DeprecationWarning} seja emitida quando é usado. (Contribuição de Alex Waygood em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize

@item 
@ref{125,,xml.etree.ElementTree}: O módulo agora emite @ref{1a5,,DeprecationWarning} ao testar o valor verdade de um @ref{310,,xml.etree.ElementTree.Element}. Antes, a implementação Python emitia @ref{415,,FutureWarning}, e a implementação C não emitia nada. (Contribuição de Jacob Walls em gh-83122@footnote{https://github.com/python/cpython/issues/83122}.)

@item 
As assinaturas de 3 argumentos (tipo, valor, traceback) de @ref{4f7,,coroutine throw()}, @ref{4f8,,generator throw()} e @ref{4f9,,async generator throw()} foram descontinuados e podem ser removidos em uma versão futura do Python. Use as versões de argumento único dessas funções. (Contribuição de Ofey Chan em gh-89874@footnote{https://github.com/python/cpython/issues/89874}.)

@item 
@ref{1a5,,DeprecationWarning} agora é levantada quando @ref{2d7,,__package__} em um módulo difere de @ref{2d8,,__spec__.parent} (anteriormente era @ref{4fa,,ImportWarning}). (Contribuição de Brett Cannon em gh-65961@footnote{https://github.com/python/cpython/issues/65961}.)

@item 
Definir @ref{2d7,,__package__} ou @ref{2d5,,__cached__} em um módulo foi descontinuado e deixará de ser definido ou levado em consideração pelo sistema de importação no Python 3.14. (Contribuição de Brett Cannon em gh-65961@footnote{https://github.com/python/cpython/issues/65961}.)

@item 
O operador de inversão bit a bit (@code{~}) em bool foi descontinuado. Isso levantará um erro no Python 3.16. Use @code{not} para negação lógica de bools. No raro caso em que você realmente precisa da inversão bit a bit do @code{int} subjacente, converta para int explicitamente: @code{~int(x)}. (Contribuição de Tim Hoffmann em gh-103487@footnote{https://github.com/python/cpython/issues/103487}.)

@item 
Acessar @ref{2e0,,co_lnotab} em objetos de código foi descontinuado no Python 3.10 via 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}, mas só obteve um @ref{1a5,,DeprecationWarning} adequado em 3.12. Pode ser removido em 3.15. (Contribuição de Nikita Sobolev em gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@menu
* Remoção pendente no Python 3.13: Remoção pendente no Python 3 13. 
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<3>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<3>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<3>. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<3>. 

@end menu

@node Remoção pendente no Python 3 13,Remoção pendente no Python 3 14<3>,,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-python-3-13}@anchor{4fb}
@subsubsection Remoção pendente no Python 3.13


Módulos (veja 
@geindex Propostas de Melhorias do Python; 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

Outros módulos:


@itemize *

@item 
@code{lib2to3} e o 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 
Encadeamento do descritor de @ref{166,,classmethod} (gh-89519@footnote{https://github.com/python/cpython/issues/89519})
@end itemize

@node Remoção pendente no Python 3 14<3>,Remoção pendente no Python 3 15<3>,Remoção pendente no Python 3 13,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-python-3-14}@anchor{4fc}
@subsubsection Remoção pendente no Python 3.14



@itemize *

@item 
@ref{6,,argparse}: Os parâmetros `type', `choices' e `metavar' de @code{argparse.BooleanOptionalAction} foram descontinuados e serão removidos na versão 3.14. (Contribuição de Nikita Sobolev em gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{8,,ast}: os seguintes recursos foram descontinuados na documentação desde Python 3.8, agora fazem com que um @ref{1a5,,DeprecationWarning} seja emitido em tempo de execução quando eles são acessados ou usados, e serão removidos no 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

Em vez disso, use @ref{2b9,,ast.Constant}. (Contribuição de Serhiy Storchaka em gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{a,,asyncio}:


@itemize *

@item 
As classes filhas do observador @ref{2ba,,MultiLoopChildWatcher}, @ref{2bb,,FastChildWatcher}, @ref{2bc,,AbstractChildWatcher} e @ref{2bd,,SafeChildWatcher} foram descontinuadas e serão removidas no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@ref{2be,,asyncio.set_child_watcher()}, @ref{2bf,,asyncio.get_child_watcher()}, @ref{2c0,,asyncio.AbstractEventLoopPolicy.set_child_watcher()} e @ref{2c1,,asyncio.AbstractEventLoopPolicy.get_child_watcher()} foram descontinuados e serão removidos no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
O método @ref{2c2,,get_event_loop()} da política de laço de eventos padrão agora emite um @ref{1a5,,DeprecationWarning} se não houver nenhum laço de eventos atual definido e decidir criar um. (Contribuição de Serhiy Storchaka e Guido van Rossum em gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{12,,builtins}: @code{bool(NotImplemented)} now emits a @ref{1a5,,DeprecationWarning}
and will raise a @ref{2c3,,TypeError} in Python 3.14.
(Contributed by Jelle Zijlstra in gh-118767@footnote{https://github.com/python/cpython/issues/118767}.)

@item 
@ref{3b,,email}: Descontinua o parâmetro `isdst' em @ref{2c4,,email.utils.localtime()}. (Contribuição de Alan Williams em gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc} descontinuou as classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Em vez disso, use classes de @ref{7c,,importlib.resources.abc}:


@itemize *

@item 
@ref{1f3,,importlib.resources.abc.Traversable}

@item 
@ref{2c5,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribuição de Jason R. Coombs e Hugo van Kemenade em gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools} tinha suporte não documentado, ineficiente, historicamente cheio de bugs e inconsistente para operações de cópia, cópia profunda e serialização com pickle. Isso será removido na versão 3.14 para uma redução significativa no volume de código e na carga de manutenção. (Contribuição de Raymond Hettinger em gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: o método de inicialização padrão será alterado para um mais seguro no Linux, BSDs e outras plataformas POSIX não-macOS onde @code{'fork'} é atualmente o padrão (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adicionar um aviso de tempo de execução sobre isso foi considerado muito perturbador, pois não se espera que a maior parte do código se importe. Use as APIs @ref{2c6,,get_context()} ou @ref{2c7,,set_start_method()} para especificar explicitamente quando seu código `requer' @code{'fork'}. Veja @ref{2c8,,Contextos e métodos de inicialização}.

@item 
@ref{a4,,pathlib}: @ref{2c9,,is_relative_to()} e @ref{2ca,,relative_to()}: passar argumentos adicionais foi descontinuado.

@item 
@ref{a9,,pkgutil}: @ref{2cb,,find_loader()} e @ref{2cc,,get_loader()} agora levantam @ref{1a5,,DeprecationWarning}; use @ref{2cd,,importlib.util.find_spec()} em vez disto. (Contribuição de Nikita Sobolev em gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}:


@itemize *

@item 
@code{master_open()}: use @ref{2ce,,pty.openpty()}.

@item 
@code{slave_open()}: use @ref{2ce,,pty.openpty()}.
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@ref{2cf,,version} e @ref{2d0,,version_info}.

@item 
@ref{2d1,,execute()} e @ref{2d2,,executemany()} se @ref{2d3,,espaços reservados nomeados} forem usados e `parameters' for uma sequência em vez de um @ref{256,,dict} .
@end itemize

@item 
@ref{108,,urllib}: @code{urllib.parse.Quoter} está obsoleto: não foi planejado para ser uma API pública. (Contribuição de Gregory P. Smith em gh-88168@footnote{https://github.com/python/cpython/issues/88168}.)
@end itemize

@node Remoção pendente no Python 3 15<3>,Remoção pendente no Python 3 16<3>,Remoção pendente no Python 3 14<3>,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-python-3-15}@anchor{4fd}
@subsubsection Remoção pendente no Python 3.15



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2d5,,__cached__} em um módulo enquanto falha na definição de @ref{2d6,,__spec__.cached} está descontinuado. No Python 3.15, @code{__cached__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
A definição de @ref{2d7,,__package__} em um módulo enquanto falha na definição de @ref{2d8,,__spec__.parent} está descontinuado. No Python 3.15, @code{__package__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2a,,ctypes}:


@itemize *

@item 
A função não documentada @code{ctypes.SetPointerType()} foi descontinuada desde o Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
A classe obsoleta e raramente usada @ref{2a1,,CGIHTTPRequestHandler} foi descontinuada desde o Python 3.13. Não existe substituição direta. `Qualquer coisa' é melhor que CGI para fazer a interface de um servidor web com um manipulador de requisição.

@item 
O sinalizador @code{--cgi} para a interface de linha de comando @code{python -m http.server} foi descontinuado desde o Python 3.13.
@end itemize

@item 
@ref{77,,importlib}:


@itemize *

@item 
Método @code{load_module()}: use @code{exec_module()}.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
A função @ref{2d9,,getdefaultlocale()} foi descontinuada desde o Python 3.11. Sua remoção foi planejada originalmente para o Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}), mas foi adiada para o Python 3.15. Em vez disso, use @ref{2da,,getlocale()}, @ref{2db,,setlocale()} e @ref{2dc,,getencoding()}. (Contribuição de Hugo van Kemenade em gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{2a6,,PurePath.is_reserved()} foi descontinuado desde o Python 3.13. Use @ref{223,,os.path.isreserved()} para detectar caminhos reservados no Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{2a7,,java_ver()} foi descontinuada desde o Python 3.13. Esta função é útil apenas para suporte Jython, tem uma API confusa e é amplamente não testada.
@end itemize

@item 
@ref{db,,sysconfig}:


@itemize *

@item 
O argumento `check_home' de @ref{2dd,,sysconfig.is_python_build()} foi descontinuado desde o Python 3.12.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{2de,,RLock()} não aceitará argumentos no Python 3.15. A passagem quaisquer argumentos foi descontinuada desde o Python 3.14, pois a versão Python não permite nenhum argumento, mas a versão C permite qualquer número de argumentos posicionais ou nomeados, ignorando todos os argumentos.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{2df,,types.CodeType}: o acesso a @ref{2e0,,co_lnotab} foi descontinuado na 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} desde 3.10 e foi planejado para ser removido em 3.12, mas só recebeu uma @ref{1a5,,DeprecationWarning} adequada em 3.12. Pode ser removido em 3.15. (Contribuição de Nikita Sobolev em gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
A sintaxe de argumento nomeado não documentada para criar classes @ref{2b0,,NamedTuple} (por exemplo, @code{Point = NamedTuple("Point", x=int, y=int)}) foi descontinuada desde o Python 3.13. Use a sintaxe baseada em classe ou a sintaxe funcional em vez disso.

@item 
Ao usar a sintaxe funcional de @ref{162,,TypedDict}s, não passar um valor para o parâmetro `fields' (@code{TD = TypedDict("TD")}) ou passar @code{None} (@code{TD = TypedDict("TD", None)}) foi está descontinuado desde o Python 3.13. Use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})} para criar uma classe TypedDict com nenhum campo.

@item 
A função decoradora @ref{2b1,,typing.no_type_check_decorator()} foi descontinuada desde o Python 3.13. Após oito anos no módulo @ref{104,,typing}, ela ainda não foi suportada por nenhum verificador de tipo importante.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
Os métodos @ref{2b4,,getmark()}, @code{setmark()} e @ref{2b5,,getmarkers()} das classes @ref{2b6,,Wave_read} e @ref{2b7,,Wave_write} foram descontinuados desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 16<3>,Remoção pendente no Python 3 17<2>,Remoção pendente no Python 3 15<3>,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-python-3-16}@anchor{4fe}
@subsubsection Remoção pendente no Python 3.16



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2e2,,__loader__} em um módulo enquanto falha na definição de @ref{2e3,,__spec__.loader} está descontinuado. No Python 3.16, @code{__loader__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão.
@end itemize

@item 
@ref{7,,array}:


@itemize *

@item 
O código de formato @code{'u'} (@code{wchar_t}) foi descontinuado na documentação desde o Python 3.3 e do ambiente de execução desde o Python 3.13. Em vez disso, use o código de formato @code{'w'} (@ref{29b,,Py_UCS4}) para caracteres Unicode.
@end itemize

@item 
@ref{a,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} foi descontinuado e será removido no Python 3.16, use @ref{2e4,,inspect.iscoroutinefunction()} em vez disso. (Contribuição de Jiahao Li e Kumar Aditya em gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{12,,builtins}:


@itemize *

@item 
A inversão bit a bit em tipos booleanos, @code{~True} ou @code{~False} foi descontinuada desde o Python 3.12, pois produz resultados surpreendentes e não intuitivos (@code{-2} e @code{-1}). Em vez disso, use @code{not x} para a negação lógica de um booleano. No caso raro de você precisar da inversão bit a bit do inteiro subjacente, converta para @code{int} explicitamente (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
A exceção @code{ExecError} foi descontinuada desde o Python 3.14. Ela não foi usada por nenhuma função em @code{shutil} desde o Python 3.4, e agora é um alias de @ref{195,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
O método @ref{2e5,,Class.get_methods} foi descontinuado desde o Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
A função @ref{2ae,,_enablelegacywindowsfsencoding()} foi descontinuada desde o Python 3.13. Em vez disso, use a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING}.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
O atributo não documentado e não utilizado @code{TarFile.tarfile} foi descontinuado desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 17<2>,Remoção pendente em versões futuras<3>,Remoção pendente no Python 3 16<3>,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-python-3-17}@anchor{4ff}
@subsubsection Remoção pendente no Python 3.17



@itemize *

@item 
@ref{1e,,collections.abc}:


@itemize -

@item 
@ref{2e7,,collections.abc.ByteString} está agendado para remoção no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize -

@item 
Antes do Python 3.14, as uniões antigas eram implementadas usando a classe privada @code{typing._UnionGenericAlias}. Essa classe não é mais necessária para a implementação, mas foi mantida para compatibilidade com versões anteriores, com remoção prevista para o Python 3.17. Os usuários devem usar auxiliares de introspecção documentados, como @ref{2ec,,typing.get_origin()} e @ref{2ed,,typing.get_args()}, em vez de depender de detalhes de implementação privada.

@item 
@ref{2ee,,typing.ByteString}, obsoleto desde o Python 3.9, está programado para ser removido no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize
@end itemize

@node Remoção pendente em versões futuras<3>,,Remoção pendente no Python 3 17<2>,Descontinuados
@anchor{whatsnew/3 12 pending-removal-in-future-versions}@anchor{500}
@subsubsection Remoção pendente em versões futuras


As APIs a seguir serão removidas no futuro, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{6,,argparse}: O aninhamento de grupos de argumentos e o aninhamento de grupos mutuamente exclusivos estão descontinuados.

@item 
@ref{12,,builtins}:


@itemize *

@item 
Geradores: a assinatura @code{throw(type, exc, tb)} e @code{athrow(type, exc, tb)} está descontinuada: use @code{throw(exc)} e @code{athrow(exc)}, a assinatura do argumento único.

@item 
Atualmente Python aceita literais numéricos imediatamente seguidos por palavras reservadas como, por exemplo, @code{0in x}, @code{1or x}, @code{0if 1else 2}. Ele permite expressões confusas e ambíguas como @code{[0x1for x in y]} (que pode ser interpretada como @code{[0x1 for x in y]} ou @code{[0x1f or x in y]}). Um aviso de sintaxe é levantado se o literal numérico for imediatamente seguido por uma das palavras reservadas @ref{2f1,,and}, @ref{18c,,else}, @ref{2f2,,for}, @ref{2f3,,if}, @ref{2f4,,in} , @ref{2f5,,is} e @ref{2f6,,or}. Em uma versão futura, será alterado para um erro de sintaxe. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Suporte para métodos @code{__index__()} e @code{__int__()} retornando tipo não-int: esses métodos serão necessários para retornar uma instância de uma subclasse estrita de @ref{257,,int}.

@item 
Suporte para o método @code{__float__()} retornando uma subclasse estrita de @ref{2f7,,float}: esses métodos serão necessários para retornar uma instância de @ref{2f7,,float}.

@item 
Suporte para o método @code{__complex__()} retornando uma subclasse estrita de @ref{2f8,,complex}: esses métodos serão necessários para retornar uma instância de @ref{2f8,,complex}.

@item 
Delegação do método @code{int()} para o @code{__trunc__()}.

@item 
Passar um número complexo como argumento `real' ou `imag' no construtor @ref{2f8,,complex()} agora está descontinuado; deve ser passado apenas como um único argumento posicional. (Contribuição de Serhiy Storchaka em gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{14,,calendar}: as constantes @code{calendar.January} e @code{calendar.February} foram descontinuadas e substituídas por @ref{2f9,,calendar.JANUARY} e @ref{2fa,,calendar.FEBRUARY}. (Contribuição de Prince Roshan em gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{2e0,,codeobject.co_lnotab}: use o método @ref{2fb,,codeobject.co_lines()}.

@item 
@ref{30,,datetime}:


@itemize *

@item 
@ref{2fc,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{2fd,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: o valor de plural deve ser um número inteiro.

@item 
@ref{77,,importlib}:


@itemize *

@item 
O parâmetro `debug_override' de @ref{2fe,,cache_from_source()} foi descontinuado: use o parâmetro `optimization'.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
Interface de tupla @code{EntryPoints}.

@item 
@code{None} implícito nos valores de retorno.
@end itemize

@item 
@ref{87,,logging}: o método @code{warn()} foi descontinuado desde o Python 3.3, use @ref{2ff,,warning()}.

@item 
@ref{8b,,mailbox}: o uso da entrada StringIO e do modo de texto foi descontinuado; em vez disso, use BytesIO e o modo binário.

@item 
@ref{a1,,os}: chame @ref{300,,os.register_at_fork()} em processo multithread.

@item 
@code{pydoc.ErrorDuringImport}: um valor de tupla para o parâmetro `exc_info' foi descontinuado, use uma instância de exceção.

@item 
@ref{b9,,re}: regras mais rigorosas agora são aplicadas para referências numéricas de grupos e nomes de grupos em expressões regulares. Apenas a sequência de dígitos ASCII agora é aceita como referência numérica. O nome do grupo em padrões de bytes e strings de substituição agora pode conter apenas letras e dígitos ASCII e sublinhado. (Contribuição de Serhiy Storchaka em gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
Módulos @code{sre_compile}, @code{sre_constants} e @code{sre_parse}.

@item 
@ref{c5,,shutil}: o parâmetro `onerror' de @ref{301,,rmtree()} foi descontinuado no Python 3.12; use o parâmetro `onexc'.

@item 
Protocolos e opções de @ref{d0,,ssl}


@itemize *

@item 
@ref{294,,ssl.SSLContext} sem argumento de protocolo foi descontinuado.

@item 
@ref{294,,ssl.SSLContext}: @ref{302,,set_npn_protocols()} e @code{selected_npn_protocol()} foram descontinuados, use ALPN.

@item 
Opções de @code{ssl.OP_NO_SSL*}

@item 
Opções de @code{ssl.OP_NO_TLS*}

@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 
Métodos de @ref{ed,,threading}:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{303,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{304,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{305,,threading.Thread.setDaemon()}: use o atributo @ref{306,,threading.Thread.daemon}.

@item 
@code{threading.Thread.getName()}, @ref{307,,threading.Thread.setName()}: use o atributo @ref{308,,threading.Thread.name}.

@item 
@code{threading.currentThread()}: use @ref{309,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{30a,,threading.active_count()}.
@end itemize

@item 
@ref{30b,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{30c,,unittest.IsolatedAsyncioTestCase}: foi descontinuado retornar um valor que não seja @code{None} de um caso de teste.

@item 
Funções descontinuadas de @ref{10a,,urllib.parse}: use @ref{30d,,urlparse()}


@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}: O estilo de @ref{30e,,URLopener} e @ref{30f,,FancyURLopener} de invocar solicitações foi descontinuado. Use as mais novas funções e métodos @ref{293,,urlopen()}.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} não deve fazer gravações parciais.

@item 
@ref{125,,xml.etree.ElementTree}: testar o valor verdade de um @ref{310,,Element} está descontinuado. Em um lançamento futuro isso sempre retornará @code{True}. Em vez disso, prefira os testes explícitos @code{len(elem)} ou @code{elem is not None}.

@item 
@ref{311,,zipimport.zipimporter.load_module()} foi descontinuado: use @ref{312,,exec_module()}.
@end itemize

@node Removidos,Portando para Python 3 12,Descontinuados,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 removed}@anchor{501}@anchor{whatsnew/3 12 whatsnew312-removed}@anchor{502}
@subsection Removidos


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

@end menu

@node asynchat e asyncore,configparser<3>,,Removidos
@anchor{whatsnew/3 12 asynchat-and-asyncore}@anchor{503}
@subsubsection asynchat e asyncore



@itemize *

@item 
Esses dois módulos foram removidos de acordo com o cronograma em 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}, tendo sido descontinuados no Python 3.6. Use @ref{a,,asyncio} em vez disso. (Contribuição de Nikita Sobolev em gh-96580@footnote{https://github.com/python/cpython/issues/96580}.)
@end itemize

@node configparser<3>,distutils,asynchat e asyncore,Removidos
@anchor{whatsnew/3 12 configparser}@anchor{504}
@subsubsection configparser



@itemize *

@item 
Vários nomes descontinuados no @ref{22,,configparser} na versão 3.2 foram removidos por gh-89336@footnote{https://github.com/python/cpython/issues/89336}:


@itemize *

@item 
@ref{505,,configparser.ParsingError} não possui mais um argumento ou atributo @code{filename}. Use o atributo e o argumento @code{source}.

@item 
@ref{22,,configparser} não possui mais uma classe @code{SafeConfigParser}. Use o nome @ref{1c8,,ConfigParser} mais curto.

@item 
@ref{1c8,,configparser.ConfigParser} não possui mais um método @code{readfp}. Use @ref{506,,read_file()} em vez disso.
@end itemize
@end itemize

@node distutils,ensurepip,configparser<3>,Removidos
@anchor{whatsnew/3 12 distutils}@anchor{507}@anchor{whatsnew/3 12 whatsnew312-removed-distutils}@anchor{508}
@subsubsection distutils



@itemize *

@item 
Remove o pacote @code{distutils}. Foi descontinuado no Python 3.10 por 
@geindex Propostas de Melhorias do Python; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} “Descontinuar o módulo distutils”. Para projetos que ainda usam @code{distutils} e não podem ser atualizados para outra coisa, o projeto @code{setuptools} pode ser instalado: ele ainda fornece @code{distutils}. (Contribuição de Victor Stinner em gh-92584@footnote{https://github.com/python/cpython/issues/92584}.)
@end itemize

@node ensurepip,enum<2>,distutils,Removidos
@anchor{whatsnew/3 12 ensurepip}@anchor{509}
@subsubsection ensurepip



@itemize *

@item 
Remove o wheel de setuptools incluído em @ref{55,,ensurepip} e para de instalar setuptools em ambientes criados por @ref{111,,venv}.

@code{pip (>= 22.1)} não requer que setuptools sejam instalados no ambiente. Pacotes baseados em @code{setuptools} (e baseados em @code{distutils}) ainda podem ser usados com @code{pip install}, já que o pip fornecerá @code{setuptools} no ambiente de construção que ele usa para construir um pacote.

@code{easy_install}, @code{pkg_resources}, @code{setuptools} e @code{distutils} não são mais fornecidos por padrão em ambientes criados com @code{venv} ou inicializados com @code{ensurepip}, já que eles são parte do pacote @code{setuptools}. Para projetos que dependem destes em tempo de execução, o projeto @code{setuptools} deve ser declarado como uma dependência e instalado separadamente (normalmente, usando pip).

(Contribuição de Pradyun Gedam em gh-95299@footnote{https://github.com/python/cpython/issues/95299}.)
@end itemize

@node enum<2>,ftplib,ensurepip,Removidos
@anchor{whatsnew/3 12 enum}@anchor{50a}
@subsubsection enum



@itemize *

@item 
Remove @code{EnumMeta.__getattr__} de @ref{56,,enum}, que não é mais necessário para acesso ao atributos do enum. (Contribuição de Ethan Furman em gh-95083@footnote{https://github.com/python/cpython/issues/95083}.)
@end itemize

@node ftplib,gzip,enum<2>,Removidos
@anchor{whatsnew/3 12 ftplib}@anchor{50b}
@subsubsection ftplib



@itemize *

@item 
Remove o atributo de classe @code{FTP_TLS.ssl_version} do @ref{5e,,ftplib}: use o parâmetro `context' em seu lugar. (Contribuição de Victor Stinner em gh-94172@footnote{https://github.com/python/cpython/issues/94172}.)
@end itemize

@node gzip,hashlib,ftplib,Removidos
@anchor{whatsnew/3 12 gzip}@anchor{50c}
@subsubsection gzip



@itemize *

@item 
Remove o atributo @code{filename} do @ref{41a,,gzip.GzipFile} de @ref{67,,gzip}, descontinuado desde Python 2.6, use o atributo @ref{50d,,name} em seu lugar. No modo de gravação, o atributo @code{filename} adicionou a extensão de arquivo @code{'.gz'} se ela não estivesse presente. (Contribuição de Victor Stinner em gh-94196@footnote{https://github.com/python/cpython/issues/94196}.)
@end itemize

@node hashlib,importlib<2>,gzip,Removidos
@anchor{whatsnew/3 12 hashlib}@anchor{50e}
@subsubsection hashlib



@itemize *

@item 
Remove a implementação Python pura de @ref{50f,,hashlib.pbkdf2_hmac()} de @ref{68,,hashlib}, descontinuado em Python 3.10. Python 3.10 e mais recente requer OpenSSL 1.1.1 (
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}): esta versão do OpenSSL fornece uma implementação C de @ref{50f,,pbkdf2_hmac()} que é mais rápida. (Contribuição de Victor Stinner em gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)
@end itemize

@node importlib<2>,imp,hashlib,Removidos
@anchor{whatsnew/3 12 importlib}@anchor{510}
@subsubsection importlib



@itemize *

@item 
Foi concluída a remoção de muitos alvos de @ref{77,,importlib} que haviam sido descontinuados anteriormente:


@itemize *

@item 
Referências e suporte a @code{module_repr()} foram removidos. (Contribuição de Barry Warsaw em gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@code{importlib.util.set_package}, @code{importlib.util.set_loader} e @code{importlib.util.module_for_loader} foram todos removidos. (Contribuição de Brett Cannon e Nikita Sobolev em gh-65961@footnote{https://github.com/python/cpython/issues/65961} e gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
O suporte para APIs @code{find_loader()} e @code{find_module()} foi removido. (Contribuição de Barry Warsaw em gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)

@item 
@code{importlib.abc.Finder}, @code{pkgutil.ImpImporter} e @code{pkgutil.ImpLoader} foram removidos. (Contribuição de Barry Warsaw em gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)
@end itemize
@end itemize

@node imp,io<2>,importlib<2>,Removidos
@anchor{whatsnew/3 12 imp}@anchor{511}@anchor{whatsnew/3 12 whatsnew312-removed-imp}@anchor{512}
@subsubsection imp



@itemize *

@item 
O módulo @code{imp} foi removido. (Contribuição de Barry Warsaw em gh-98040@footnote{https://github.com/python/cpython/issues/98040}.)

Para migrar consulte a seguinte tabela de correspondência:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

imp

@tab

importlib

@item

@code{imp.NullImporter}

@tab

Insere @code{None} em @code{sys.path_importer_cache}

@item

@code{imp.cache_from_source()}

@tab

@ref{2fe,,importlib.util.cache_from_source()}

@item

@code{imp.find_module()}

@tab

@ref{2cd,,importlib.util.find_spec()}

@item

@code{imp.get_magic()}

@tab

@ref{513,,importlib.util.MAGIC_NUMBER}

@item

@code{imp.get_suffixes()}

@tab

@ref{514,,importlib.machinery.SOURCE_SUFFIXES}, @ref{515,,importlib.machinery.EXTENSION_SUFFIXES} e @ref{516,,importlib.machinery.BYTECODE_SUFFIXES}

@item

@code{imp.get_tag()}

@tab

@ref{517,,sys.implementation.cache_tag}

@item

@code{imp.load_module()}

@tab

@ref{518,,importlib.import_module()}

@item

@code{imp.new_module(name)}

@tab

@code{types.ModuleType(name)}

@item

@code{imp.reload()}

@tab

@ref{519,,importlib.reload()}

@item

@code{imp.source_from_cache()}

@tab

@ref{51a,,importlib.util.source_from_cache()}

@item

@code{imp.load_source()}

@tab

`Veja abaixo'

@end multitable

@end quotation

Substitua @code{imp.load_source()} com:

@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)
    # O módulo é sempre executado e não colocado em cache em sys.modules.
    # Descomente a linha a seguir para colocar o módulo em cache.
    # sys.modules[module.__name__] = module
    loader.exec_module(module)
    return module
@end example

@item 
Remove funções e atributos do @code{imp} sem substituições:


@itemize *

@item 
Funções não 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()}: o esquema de trava foi alterado no Python 3.3 para travas por módulo.

@item 
Constantes de @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<2>,locale<2>,imp,Removidos
@anchor{whatsnew/3 12 io}@anchor{51b}
@subsubsection io



@itemize *

@item 
Remove @code{io.OpenWrapper} e @code{_pyio.OpenWrapper} de @ref{7f,,io}, descontinuados em Python 3.10: basta usar @ref{51c,,open()} em seu lugar. A função @ref{51c,,open()} (@ref{51d,,io.open()}) é uma função embutida. Desde o Python 3.10, @code{_pyio.open()} também é um método estático. (Contribuição de Victor Stinner em gh-94169@footnote{https://github.com/python/cpython/issues/94169}.)
@end itemize

@node locale<2>,smtpd,io<2>,Removidos
@anchor{whatsnew/3 12 locale}@anchor{51e}
@subsubsection locale



@itemize *

@item 
Remove a função @code{locale.format()} de @ref{86,,locale}, descontinuada no Python 3.7: use @ref{51f,,locale.format_string()} em seu lugar. (Contribuição de Victor Stinner em gh-94226@footnote{https://github.com/python/cpython/issues/94226}.)
@end itemize

@node smtpd,sqlite3<3>,locale<2>,Removidos
@anchor{whatsnew/3 12 smtpd}@anchor{520}
@subsubsection smtpd



@itemize *

@item 
O módulo @code{smtpd} foi removido de acordo com o cronograma em 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}, tendo sido descontinuado em Python 3.4.7 e 3.5.4. Use o módulo PyPI aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} ou qualquer outro servidor baseado em @ref{a,,asyncio}. (Contribuição de Oleg Iarygin em gh-93243@footnote{https://github.com/python/cpython/issues/93243}.)
@end itemize

@node sqlite3<3>,ssl<2>,smtpd,Removidos
@anchor{whatsnew/3 12 id2}@anchor{521}
@subsubsection sqlite3



@itemize *

@item 
Os seguintes recursos não documentados do @ref{cf,,sqlite3}, descontinuados no Python 3.10, foram agora removidos:


@itemize *

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode}
@end itemize

Se um cache compartilhado deve ser usado, abra o banco de dados no modo URI usando o parâmetro de consulta @code{cache=shared}.

A fábrica de texto @code{sqlite3.OptimizedUnicode} tem sido um apelido para @ref{44c,,str} desde Python 3.3. O código que anteriormente definiu a fábrica de texto como @code{OptimizedUnicode} pode usar @code{str} explicitamente ou confiar no valor padrão que também é @code{str}.

(Contribuição de Erlend E. Aasland em gh-92548@footnote{https://github.com/python/cpython/issues/92548}.)
@end itemize

@node ssl<2>,unittest<3>,sqlite3<3>,Removidos
@anchor{whatsnew/3 12 ssl}@anchor{522}
@subsubsection ssl



@itemize *

@item 
Remove a função @code{ssl.RAND_pseudo_bytes()} do @ref{d0,,ssl}, descontinuada no Python 3.6: use @ref{523,,os.urandom()} ou @ref{524,,ssl.RAND_bytes()} em seu lugar. (Contribuição de Victor Stinner em gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)

@item 
Remove a função @code{ssl.match_hostname()}. Foi descontinuada no Python 3.7. OpenSSL realiza correspondência de nome de host desde Python 3.7, Python não usa mais a função @code{ssl.match_hostname()}. (Contribuição de Victor Stinner em gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)

@item 
Remove a função @code{ssl.wrap_socket()}, descontinuada no Python 3.7: em vez desta, crie um objeto @ref{294,,ssl.SSLContext} e chame seu método @ref{525,,ssl.SSLContext.wrap_socket}. Qualquer pacote que ainda use @code{ssl.wrap_socket()} está quebrado e é inseguro. A função não envia uma extensão SNI TLS nem valida o nome do host do servidor. O código está sujeito a 
@geindex Common Weakness Enumeration; CWE 295
CWE 295@footnote{https://cwe.mitre.org/data/definitions/295.html} (validação inadequada de certificado). (Contribuição de Victor Stinner em gh-94199@footnote{https://github.com/python/cpython/issues/94199}.)
@end itemize

@node unittest<3>,webbrowser<2>,ssl<2>,Removidos
@anchor{whatsnew/3 12 id3}@anchor{526}
@subsubsection unittest



@itemize *

@item 
Remove recursos do @ref{106,,unittest} há muito tempo descontinuados:
@anchor{whatsnew/3 12 unittest-testcase-removed-aliases}@anchor{44e}

@itemize *

@item 
Vários apelidos de método de @ref{44f,,TestCase}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Apelido descontinuado

@tab

Método

@tab

Descontinuado em

@item

@code{failUnless}

@tab

@ref{527,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{528,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{529,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{52a,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{52b,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{52c,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{52d,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{527,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{529,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{52a,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{52b,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{52c,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{52e,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{52f,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{530,,assertNotRegex()}

@tab

3.5

@end multitable


Você pode usar @indicateurl{https://github.com/isidentical/teyit} para modernizar automaticamente seus testes de unidade.

@item 
Método não documentado e quebrado @code{assertDictContainsSubset} de @ref{44f,,TestCase} (descontinuado no Python 3.2).

@item 
Parâmetro não documentado `use_load_tests' de @ref{28f,,TestLoader.loadTestsFromModule} (descontinuado e ignorado desde Python 3.5).

@item 
Um apelido da classe @ref{531,,TextTestResult}: @code{_TextTestResult} (descontinuado no Python 3.2).
@end itemize

(Contribuição de Serhiy Storchaka em gh-89325@footnote{https://github.com/python/cpython/issues/89325}.)
@end itemize

@node webbrowser<2>,xml etree ElementTree,unittest<3>,Removidos
@anchor{whatsnew/3 12 webbrowser}@anchor{532}
@subsubsection webbrowser



@itemize *

@item 
Remove o suporte para navegadores descontinuados de @ref{115,,webbrowser}. Os navegadores removidos incluem: Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape, Firebird e Firefox versões 35 e inferiores (gh-102871@footnote{https://github.com/python/cpython/issues/102871}).
@end itemize

@node xml etree ElementTree,zipimport<2>,webbrowser<2>,Removidos
@anchor{whatsnew/3 12 xml-etree-elementtree}@anchor{533}
@subsubsection xml.etree.ElementTree



@itemize *

@item 
Remove o método @code{ElementTree.Element.copy()} da implementação Python pura, descontinuado no Python 3.10; use a função @ref{534,,copy.copy()} em seu lugar. A implementação C de @ref{125,,xml.etree.ElementTree} não possui nenhum método @code{copy()}, apenas um método @code{__copy__()}. (Contribuição de Victor Stinner em gh-94383@footnote{https://github.com/python/cpython/issues/94383}.)
@end itemize

@node zipimport<2>,Outros,xml etree ElementTree,Removidos
@anchor{whatsnew/3 12 zipimport}@anchor{535}
@subsubsection zipimport



@itemize *

@item 
Remove os métodos @code{find_loader()} e @code{find_module()} do @ref{132,,zipimport}, descontinuados no Python 3.10: use o método @code{find_spec()} em seu lugar. Veja 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} para o raciocínio. (Contribuição de Victor Stinner em gh-94379@footnote{https://github.com/python/cpython/issues/94379}.)
@end itemize

@node Outros,,zipimport<2>,Removidos
@anchor{whatsnew/3 12 others}@anchor{536}
@subsubsection Outros



@itemize *

@item 
Remove a regra @code{suspicious} do @code{Makefile} da documentação e do @code{Doc/tools/rstlint.py}, ambas em favor do sphinx-lint@footnote{https://github.com/sphinx-contrib/sphinx-lint}. (Contribuição de Julien Palard em gh-98179@footnote{https://github.com/python/cpython/issues/98179}.)

@item 
Remove os parâmetros `keyfile' e `certfile' dos módulos @ref{5e,,ftplib}, @ref{74,,imaplib}, @ref{ac,,poplib} e @ref{ca,,smtplib}, e dos módulos `key_file', `cert_file' e `check_hostname' do módulo @ref{6f,,http.client}, todos descontinuados desde Python 3.6. Use o parâmetro `context' (`ssl_context' em @ref{74,,imaplib}). (Contribuição de Victor Stinner em gh-94172@footnote{https://github.com/python/cpython/issues/94172}.)

@item 
Remove hacks de compatibilidade @code{Jython} de vários módulos e testes da stdlib. (Contribuição de Nikita Sobolev em gh-99482@footnote{https://github.com/python/cpython/issues/99482}.)

@item 
Remove o sinalizador @code{_use_broken_old_ctypes_structure_semantics_} do módulo @ref{2a,,ctypes}. (Contribuição de Nikita Sobolev em gh-99285@footnote{https://github.com/python/cpython/issues/99285}.)
@end itemize

@node Portando para Python 3 12,Mudanças na construção<2>,Removidos,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 porting-to-python-3-12}@anchor{537}@anchor{whatsnew/3 12 whatsnew312-porting-to-python312}@anchor{4cc}
@subsection Portando para Python 3.12


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações na API Python: Alterações na API Python<2>. 

@end menu

@node Alterações na API Python<2>,,,Portando para Python 3 12
@anchor{whatsnew/3 12 changes-in-the-python-api}@anchor{538}
@subsubsection Alterações na API Python



@itemize *

@item 
Regras mais rigorosas agora são aplicadas para referências numéricas de grupos e nomes de grupos em expressões regulares. Apenas a sequência de dígitos ASCII agora é aceita como referência numérica. O nome do grupo em padrões de bytes e strings de substituição agora pode conter apenas letras e dígitos ASCII e sublinhado. (Contribuição de Serhiy Storchaka em gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
Remove a funcionalidade @code{randrange()} descontinuada desde o Python 3.10. Anteriormente, @code{randrange(10.0)} era convertido sem perdas para @code{randrange(10)}. Agora, ele levanta um @ref{2c3,,TypeError}. Além disso, a exceção levantada para valores não inteiros como @code{randrange(10.5)} ou @code{randrange('10')} foi alterada de @ref{202,,ValueError} para @ref{2c3,,TypeError}. Isso também evita bugs onde @code{randrange(1e25)} selecionaria silenciosamente um intervalo maior que @code{randrange(10**25)}. (Originalmente sugerido por Serhiy Storchaka gh-86388@footnote{https://github.com/python/cpython/issues/86388}.)

@item 
@ref{539,,argparse.ArgumentParser} alterou a codificação e o tratador de erros para ler argumentos do arquivo (por exemplo, opção @code{fromfile_prefix_chars}) da codificação de texto padrão (por exemplo, @ref{53a,,locale.getpreferredencoding(False)}) para @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Os arquivos de argumento devem ser codificados em UTF-8 em vez de ANSI Codepage no Windows.

@item 
Remove o módulo @code{smtpd} baseado em @code{asyncore} descontinuado no Python 3.4.7 e 3.5.4. Um substituto recomendado é o módulo PyPI baseado em @ref{a,,asyncio} aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/}.

@item 
@ref{53c,,shlex.split()}: Passar @code{None} para o argumento `s' agora levanta uma exceção, ao invés de ler @ref{53d,,sys.stdin}. O recurso foi descontinuado no Python 3.9. (Contribuição de Victor Stinner em gh-94352@footnote{https://github.com/python/cpython/issues/94352}.)

@item 
O módulo @ref{a1,,os} não aceita mais caminhos bytes ou similar, como os tipos @ref{2ea,,bytearray} e @ref{2eb,,memoryview}: apenas o tipo exato @ref{1c2,,bytes} é aceito para strings de bytes. (Contribuição de Victor Stinner em gh-98393@footnote{https://github.com/python/cpython/issues/98393}.)

@item 
@ref{53e,,syslog.openlog()} e @ref{53f,,syslog.closelog()} agora falham se usadas em subinterpretadores. @ref{540,,syslog.syslog()} ainda pode ser usada em subinterpretadores, mas agora somente se @ref{53e,,syslog.openlog()} já tiver sido chamada no interpretador principal. Estas novas restrições não se aplicam ao interpretador principal, então apenas um pequeno grupo de usuários poderá ser afetado. Essa mudança ajuda no isolamento do interpretador. Além disso, @ref{dc,,syslog} é um wrapper em torno de recursos globais de processo, que são melhor gerenciados a partir do interpretador principal. (Contribuição de Donghee Na em gh-99127@footnote{https://github.com/python/cpython/issues/99127}.)

@item 
O comportamento não documentado de trava de @ref{541,,cached_property()} foi removido, porque travava todas as instâncias da classe, levando a uma alta contenção de trava. Isso significa que uma função getter de propriedade em cache agora pode ser executada mais de uma vez para uma única instância, se duas threads competirem. Para a maioria das propriedades simples em cache (por exemplo, aquelas que são idempotentes e simplesmente calculam um valor com base em outros atributos da instância), isso será suficiente. Se a sincronização for necessária, implemente a trava na função getter de propriedade em cache ou em torno de pontos de acesso multithread.

@item 
@ref{4c2,,sys._current_exceptions()} agora retorna um mapeamento de thread-id para uma instância de exceção, ao invés de uma tupla @code{(typ, exc, tb)}. (Contribuição de Irit Katriel em gh-103176@footnote{https://github.com/python/cpython/issues/103176}.)

@item 
Ao extrair arquivos tar usando @ref{de,,tarfile} ou @ref{46b,,shutil.unpack_archive()}, passe o argumento `filter' para limitar recursos que podem surpreender ou ser perigosos. Veja @ref{46c,,Filtros de extração} para detalhes.

@item 
A saída das funções @ref{4d9,,tokenize.tokenize()} e @ref{4da,,tokenize.generate_tokens()} agora foi alterada devido às mudanças introduzidas na 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. Isso significa que os tokens @code{STRING} não são mais emitidos para f-strings e os tokens descritos em 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} agora são produzidos: @code{FSTRING_START}, @code{FSTRING_MIDDLE} e @code{FSTRING_END} agora são emitidos para partes “string” de f-strings, além dos tokens apropriados para a tokenização nos componentes da expressão. Por exemplo, para a f-string @code{f"start @{1+1@} end"} a versão antiga do tokenizer emitida:

@example
1,0-1,18:           STRING         'f"start @{1+1@} end"'
@end example

enquanto a nova versão 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

Além disso, pode haver algumas pequenas alterações comportamentais como consequência das alterações necessárias para oferecer suporte à 
@geindex Propostas de Melhorias do Python; PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}. Algumas dessas mudanças incluem:


@itemize *

@item 
O atributo @code{type} dos tokens emitidos ao tokenizar alguns caracteres Python inválidos, como @code{!}, mudou de @code{ERRORTOKEN} para @code{OP}.

@item 
Strings incompletas de linha única agora também levantam @ref{542,,tokenize.TokenError} como fazem strings multilinhas incompletas.

@item 
Algum código Python incompleto ou inválido agora levanta @ref{542,,tokenize.TokenError} em vez de retornar tokens @code{ERRORTOKEN} arbitrários ao tokenizá-lo.

@item 
Misturar tabulações e espaços como indentação no mesmo arquivo não é mais suportado e vai levantar uma @ref{543,,TabError}.
@end itemize

@item 
O módulo @ref{ed,,threading} agora espera que o módulo @code{_thread} tenha um atributo @code{_is_main_interpreter}. É uma função sem argumentos que retorna @code{True} se o interpretador atual for o interpretador principal.

Qualquer biblioteca ou aplicação que forneça um módulo @code{_thread} personalizado deve fornecer @code{_is_main_interpreter()}. (Veja gh-112826@footnote{https://github.com/python/cpython/issues/112826}.)
@end itemize

@node Mudanças na construção<2>,Alterações na API C<4>,Portando para Python 3 12,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 build-changes}@anchor{544}
@subsection Mudanças na construção



@itemize *

@item 
Python não usa mais @code{setup.py} para construir módulos de extensão C compartilhados. Parâmetros de construção como cabeçalhos e bibliotecas são detectados no script @code{configure}. As extensões são construídas por @code{Makefile}. A maioria das extensões usa @code{pkg-config} e recorre à detecção manual. (Contribuição de Christian Heimes em gh-93939@footnote{https://github.com/python/cpython/issues/93939}.)

@item 
@code{va_start()} com dois parâmetros, como @code{va_start(args, format)}, agora é necessário para construir Python. @code{va_start()} não é mais chamado com um único parâmetro. (Contribuição de Kumar Aditya em gh-93207@footnote{https://github.com/python/cpython/issues/93207}.)

@item 
CPython agora usa a opção ThinLTO como política de otimização de tempo de vincualção padrão se o compilador Clang aceitar o sinalizador. (Contribuição de Donghee Na em gh-89536@footnote{https://github.com/python/cpython/issues/89536}.)

@item 
Adiciona a variável @code{COMPILEALL_OPTS} em @code{Makefile} para substituir as opções @ref{20,,compileall} (padrão: @code{-j0}) em @code{make install}. Também fundiu os 3 comandos @code{compileall} em um único comando para construir arquivos .pyc para todos os níveis de otimização (0, 1, 2) de uma só vez. (Contribuição de Victor Stinner em gh-99289@footnote{https://github.com/python/cpython/issues/99289}.)

@item 
Adiciona trios de plataforma para LoongArch de 64 bits:


@itemize *

@item 
loongarch64-linux-gnusf

@item 
loongarch64-linux-gnuf32

@item 
loongarch64-linux-gnu
@end itemize

(Contribuição de Zhang Na em gh-90656@footnote{https://github.com/python/cpython/issues/90656}.)

@item 
@code{PYTHON_FOR_REGEN} agora requer Python 3.10 ou mais novo.

@item 
Autoconf 2.71 e aclocal 1.16.4 agora são necessários para regerar @code{!configure}. (Contribuição de Christian Heimes em gh-89886@footnote{https://github.com/python/cpython/issues/89886}.)

@item 
Construções do Windows e instaladores do macOS em python.org agora usam OpenSSL 3.0.
@end itemize

@node Alterações na API C<4>,,Mudanças na construção<2>,O que há de novo no Python 3 12
@anchor{whatsnew/3 12 c-api-changes}@anchor{545}
@subsection Alterações na API C


@menu
* Novas funcionalidades: Novas funcionalidades<4>. 
* Portando para Python 3.12: Portando para Python 3 12<2>. 
* Descontinuados: Descontinuados<2>. 
* Removidos: Removidos<2>. 

@end menu

@node Novas funcionalidades<4>,Portando para Python 3 12<2>,,Alterações na API C<4>
@anchor{whatsnew/3 12 id4}@anchor{546}
@subsubsection Novas funcionalidades

@anchor{whatsnew/3 12 whatsnew312-pep697}@anchor{445}

@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: Introduz o @ref{547,,tier de API C Instável}, destinada a ferramentas de baixo nível como depuradores e compiladores JIT. Esta API pode mudar em cada versão secundária do CPython sem avisos de descontinuação. Seu conteúdo é marcado pelo prefixo @code{PyUnstable_} nos nomes.

Construtores de objeto código:


@itemize -

@item 
@code{PyUnstable_Code_New()} (renomeado de @code{PyCode_New})

@item 
@code{PyUnstable_Code_NewWithPosOnlyArgs()} (renomeado de @code{PyCode_NewWithPosOnlyArgs})
@end itemize

Armazenamento extra para objetos código (
@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}):


@itemize -

@item 
@code{PyUnstable_Eval_RequestCodeExtraIndex()} (renomeado de @code{_PyEval_RequestCodeExtraIndex})

@item 
@code{PyUnstable_Code_GetExtra()} (renomeado de @code{_PyCode_GetExtra})

@item 
@code{PyUnstable_Code_SetExtra()} (renomeado de @code{_PyCode_SetExtra})
@end itemize

Os nomes originais continuarão disponíveis até que a respectiva API seja alterada.

(Contribuição de Petr Viktorin em gh-101101@footnote{https://github.com/python/cpython/issues/101101}.)

@item 
@geindex Propostas de Melhorias do Python; PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: Adiciona uma API para estender tipos cujo layout de memória de instância é opaco:


@itemize -

@item 
@ref{548,,PyType_Spec.basicsize} pode ser zero ou negativo para especificar a herança ou extensão do tamanho da classe base.

@item 
@ref{549,,PyObject_GetTypeData()} e @ref{54a,,PyType_GetTypeDataSize()} adicionadas para permitir acesso a dados de instância específicos da subclasse.

@item 
@ref{54b,,Py_TPFLAGS_ITEMS_AT_END} e @ref{54c,,PyObject_GetItemData()} adicionadas para permitir a extensão segura de certos tipos de tamanho variável, incluindo @ref{54d,,PyType_Type}.

@item 
@ref{54e,,Py_RELATIVE_OFFSET} adicionada para permitir a definição de @ref{54f,,membros} em termos de uma estrutura específica da subclasse.
@end itemize

(Contribuição de Petr Viktorin em gh-103509@footnote{https://github.com/python/cpython/issues/103509}.)

@item 
Adiciona à @ref{396,,API C limitada} a nova função @ref{550,,PyType_FromMetaclass()}, que generaliza a @ref{551,,PyType_FromModuleAndSpec()} existente usando um argumento de metaclasse adicional. (Contribuição de Wenzel Jakob em gh-93012@footnote{https://github.com/python/cpython/issues/93012}.)

@item 
API para criação de objetos que podem ser chamados usando @ref{552,,o protocolo vectorcall} foi adicionada à @ref{553,,API Limitada}:


@itemize *

@item 
@ref{554,,Py_TPFLAGS_HAVE_VECTORCALL}

@item 
@ref{555,,PyVectorcall_NARGS()}

@item 
@ref{556,,PyVectorcall_Call()}

@item 
@ref{557,,vectorcallfunc}
@end itemize

O sinalizador @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} agora é removido de uma classe quando o método @ref{558,,__call__()} da classe é reatribuído. Isso torna vectorcall seguro para uso com tipos mutáveis (ou seja, tipos de heap sem o sinalizador imutável, @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE}). Tipos mutáveis que não substituem @ref{559,,tp_call} agora herdam o sinalizador @code{Py_TPFLAGS_HAVE_VECTORCALL}. (Contribuição de Petr Viktorin em gh-93274@footnote{https://github.com/python/cpython/issues/93274}.)

Os sinalizadores @ref{36b,,Py_TPFLAGS_MANAGED_DICT} e @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} foram adicionados. Isso permite que as classes de extensões ofereçam suporte a objetos @ref{55b,,__dict__} e weakrefs com menos trabalho, usando menos memória e com acesso mais rápido.

@item 
API para realizar chamadas usando @ref{552,,o protocolo vectorcall} foi adicionada à @ref{553,,API Limitada}:


@itemize *

@item 
@ref{55c,,PyObject_Vectorcall()}

@item 
@ref{55d,,PyObject_VectorcallMethod()}

@item 
@ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET}
@end itemize

Isto significa que ambas as extremidades de entrada e saída do protocolo de chamada vetorial estão agora disponíveis na @ref{553,,API Limitada}. (Contribuição de Wenzel Jakob em gh-98586@footnote{https://github.com/python/cpython/issues/98586}.)

@item 
Adiciona duas novas funções públicas, @ref{55f,,PyEval_SetProfileAllThreads()} e @ref{422,,PyEval_SetTraceAllThreads()}, que permitem definir funções de rastreamento e perfilação em todos os threads em execução, além do de chamada. (Contribuição de Pablo Galindo em gh-93503@footnote{https://github.com/python/cpython/issues/93503}.)

@item 
Adiciona a nova função @ref{560,,PyFunction_SetVectorcall()} à API C que define o campo vectorcall de um determinado @ref{561,,PyFunctionObject}. (Contribuição de Andrew Frost em gh-92257@footnote{https://github.com/python/cpython/issues/92257}.)

@item 
A API C agora permite registrar funções de retorno de chamada via @ref{562,,PyDict_AddWatcher()}, @ref{563,,PyDict_Watch()} e APIs relacionadas a serem chamadas sempre que um dicionário é modificado. Destina-se a ser usado para otimizar interpretadores, compiladores JIT ou depuradores. (Contribuição de Carl Meyer em gh-91052@footnote{https://github.com/python/cpython/issues/91052}.)

@item 
Adiciona a API @ref{564,,PyType_AddWatcher()} e @ref{565,,PyType_Watch()} para registrar retornos de chamada para receber notificações sobre alterações em um tipo. (Contribuição de Carl Meyer em gh-91051@footnote{https://github.com/python/cpython/issues/91051}.)

@item 
Adiciona APIs @ref{566,,PyCode_AddWatcher()} e @ref{567,,PyCode_ClearWatcher()} para registrar retornos de chamada para receber notificação sobre criação e destruição de objetos de código. (Contribuição de Itamar Oren em gh-91054@footnote{https://github.com/python/cpython/issues/91054}.)

@item 
Adiciona as funções @ref{568,,PyFrame_GetVar()} e @ref{569,,PyFrame_GetVarString()} para obter uma variável de quadro por seu nome. (Contribuição de Victor Stinner em gh-91248@footnote{https://github.com/python/cpython/issues/91248}.)

@item 
Adiciona @ref{3f4,,PyErr_GetRaisedException()} e @ref{3f7,,PyErr_SetRaisedException()} para salvar e restaurar a exceção atual. Essas funções retornam e aceitam um único objeto de exceção, em vez dos argumentos triplos dos agora obsoletos @ref{3f3,,PyErr_Fetch()} e @ref{3f6,,PyErr_Restore()}. Isso é menos sujeito a erros e um pouco mais eficiente. (Contribuição de Mark Shannon em gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Adiciona @code{_PyErr_ChainExceptions1}, que usa uma instância de exceção, para substituir a API legada @code{_PyErr_ChainExceptions}, que agora foi descontinuada. (Contribuição de Mark Shannon em gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Adiciona @ref{56a,,PyException_GetArgs()} e @ref{56b,,PyException_SetArgs()} como funções de conveniência para recuperar e modificar o @ref{56c,,args} passado para o construtor da exceção. (Contribuição de Mark Shannon em gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
Adiciona @ref{402,,PyErr_DisplayException()}, que usa uma instância de exceção, para substituir a API legada @code{PyErr_Display()}. (Contribuição de Irit Katriel em gh-102755@footnote{https://github.com/python/cpython/issues/102755}).
@end itemize
@anchor{whatsnew/3 12 whatsnew312-pep683}@anchor{446}

@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}: Introduz `Objetos Imortais', que permite que objetos ignorem contagens de referências e alterações relacionadas à API C:


@itemize -

@item 

@table @asis

@item @code{_Py_IMMORTAL_REFCNT}: A contagem de referências que define um objeto

como imortal.
@end table

@item 
@code{_Py_IsImmortal} Verifica se um objeto possui a contagem de referências imortal.

@item 

@table @asis

@item @code{PyObject_HEAD_INIT} Isso agora inicializará a contagem de referências para

@code{_Py_IMMORTAL_REFCNT} quando usado com @code{Py_BUILD_CORE}.
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL} Um identificador para objetos unicode internalizados

que são imortais.
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL_STATIC} Um identificador para unicode internalizado

objetos que são imortais e estáticos
@end table

@item 

@table @asis

@item @code{sys.getunicodeinternedsize} Isso retorna o número total de unicode

objetos que foram internalizados. Isso agora é necessário para @code{refleak.py} rastrear corretamente contagens de referências e blocos alocados
@end table
@end itemize

(Contribuição de Eddie Elizondo em gh-84436@footnote{https://github.com/python/cpython/issues/84436}.)

@item 
@geindex Propostas de Melhorias do Python; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}: Adiciona a nova função @ref{45c,,Py_NewInterpreterFromConfig()} e @ref{56d,,PyInterpreterConfig}, que podem ser usadas para criar subinterpretadores com suas próprias GILs. (Veja @ref{43c,,PEP 684; Uma GIL por interpretador} para mais informações.) (Contribuição de Eric Snow em gh-104110@footnote{https://github.com/python/cpython/issues/104110}.)

@item 
Na API C limitada versão 3.12, as funções @ref{56e,,Py_INCREF()} e @ref{56f,,Py_DECREF()} agora são implementadas como chamadas de função opacas para ocultar detalhes de implementação. (Contribuição de Victor Stinner em gh-105387@footnote{https://github.com/python/cpython/issues/105387}.)
@end itemize

@node Portando para Python 3 12<2>,Descontinuados<2>,Novas funcionalidades<4>,Alterações na API C<4>
@anchor{whatsnew/3 12 id5}@anchor{570}
@subsubsection Portando para Python 3.12



@itemize *

@item 
APIs Unicode legadas baseadas na representação de @code{Py_UNICODE*} foram removidas. Migre para APIs baseadas em UTF-8 ou @code{wchar_t*}.

@item 
Funções de análise de argumentos como @ref{571,,PyArg_ParseTuple()} não mais oferecem suporte a formato baseado em @code{Py_UNICODE*} (por exemplo, @code{u}, @code{Z}). Migre para outros formatos para Unicode como @code{s}, @code{z}, @code{es} e @code{U}.

@item 
@code{tp_weaklist} para todos os tipos embutidos estáticos é sempre @code{NULL}. Este é um campo somente interno em @code{PyTypeObject}, mas estamos apontando a mudança caso alguém acesse o campo diretamente de qualquer maneira. Para evitar quebras, considere usar a API C pública existente ou, se necessário, a macro @code{_PyObject_GET_WEAKREFS_LISTPTR()} (somente interna).

@item 
Este @ref{572,,PyTypeObject.tp_subclasses} somente interno pode agora não ser um ponteiro de objeto válido. Seu tipo foi alterado para void* para refletir isso. Mencionamos isso caso alguém esteja acessando diretamente o campo somente interno.

Para obter uma lista de subclasses, chame o método Python @ref{573,,__subclasses__()} (usando @ref{39f,,PyObject_CallMethod()}, por exemplo).

@item 
Adicionado suporte para mais opções de formatação (alinhamento à esquerda, octais, hexadecimais maiúsculos, @code{intmax_t}, @code{ptrdiff_t}, @code{wchar_t} strings C, largura variável e precisão) em @ref{38a,,PyUnicode_FromFormat()} e @ref{574,,PyUnicode_FromFormatV()}. (Contribuição de Serhiy Storchaka em gh-98836@footnote{https://github.com/python/cpython/issues/98836}.)

@item 
Um caractere de formato não reconhecido em @ref{38a,,PyUnicode_FromFormat()} e @ref{574,,PyUnicode_FromFormatV()} agora define um @ref{575,,SystemError}. Nas versões anteriores, fazia com que todo o restante da string de formato fosse copiado como estava para a string de resultado e quaisquer argumentos extras descartados. (Contribuição de Serhiy Storchaka em gh-95781@footnote{https://github.com/python/cpython/issues/95781}.)

@item 
Corrige o posicionamento incorreto do sinal em @ref{38a,,PyUnicode_FromFormat()} e @ref{574,,PyUnicode_FromFormatV()}. (Contribuição de Philip Georgi em gh-95504@footnote{https://github.com/python/cpython/issues/95504}.)

@item 
Classes de extensão que desejam adicionar um @ref{55b,,__dict__} ou slot de referência fraca devem usar @ref{36b,,Py_TPFLAGS_MANAGED_DICT} e @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} em vez de @code{tp_dictoffset} e @code{tp_weaklistoffset}, respectivamente. O uso de @code{tp_dictoffset} e @code{tp_weaklistoffset} ainda é aceitado, mas não oferece suporte totalmente  a herança múltipla (gh-95589@footnote{https://github.com/python/cpython/issues/95589}), e o desempenho pode ser pior. Classes que declaram @ref{36b,,Py_TPFLAGS_MANAGED_DICT} devem chamar @code{_PyObject_VisitManagedDict()} e @code{_PyObject_ClearManagedDict()} para percorrer e limpar os dicionários de sua instância. Para limpar weakrefs (referências fracas), chame @ref{576,,PyObject_ClearWeakRefs()}, como antes.

@item 
A função @ref{577,,PyUnicode_FSDecoder()} não aceita mais caminhos bytes ou similar, como os tipos @ref{2ea,,bytearray} e @ref{2eb,,memoryview}: apenas o tipo exato @ref{1c2,,bytes} é aceito para strings de bytes. (Contribuição de Victor Stinner em gh-98393@footnote{https://github.com/python/cpython/issues/98393}.)

@item 
As macros @ref{578,,Py_CLEAR}, @ref{579,,Py_SETREF} e @ref{57a,,Py_XSETREF} agora avaliam seus argumentos apenas uma vez. Se um argumento tiver efeitos colaterais, esses efeitos colaterais não serão mais duplicados. (Contribuição de Victor Stinner em gh-98724@footnote{https://github.com/python/cpython/issues/98724}.)

@item 
O indicador de erro do interpretador agora está sempre normalizado. Isso significa que @ref{57b,,PyErr_SetObject()}, @ref{57c,,PyErr_SetString()} e as outras funções que definem o indicador de erro agora normalizam a exceção antes de armazená-la. (Contribuição de Mark Shannon em gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
@code{_Py_RefTotal} não é mais oficial e é mantido apenas para compatibilidade com ABI. Observe que é um global interno e está disponível apenas em compilações de depuração. Se acontecer de você usá-lo, você precisará começar a usar @code{_Py_GetGlobalRefTotal()}.

@item 
As seguintes funções agora selecionam uma metaclasse apropriada para o tipo recém-criado:


@itemize *

@item 
@ref{57d,,PyType_FromSpec()}

@item 
@ref{57e,,PyType_FromSpecWithBases()}

@item 
@ref{551,,PyType_FromModuleAndSpec()}
@end itemize

A criação de classes cujas substituições de metaclasse @ref{57f,,tp_new} foi descontinuada e no Python 3.14+ não será permitida. Observe que essas funções ignoram @code{tp_new} da metaclasse, possivelmente permitindo uma inicialização incompleta.

Observe que @ref{550,,PyType_FromMetaclass()} (adicionada em Python 3.12) já não permite a criação de classes cuja metaclasse substitui @code{tp_new} (@ref{580,,__new__()} em Python).

Como @code{tp_new} substitui quase tudo que as funções @code{PyType_From*} fazem, os dois são incompatíveis entre si. O comportamento existente – ignorar a metaclasse em vários passos de criação do tipo – é inseguro em geral, uma vez que as (meta)classes presumem que @code{tp_new} foi chamado. Não existe uma solução geral simples. Um dos seguintes pode funcionar para você:


@itemize -

@item 
Se você controla a metaclasse, evite usar @code{tp_new} nela:


@itemize -

@item 
Se a inicialização puder ser ignorada, isso pode ser feito em @ref{581,,tp_init}.

@item 
Se a metaclasse não precisa ser instanciada do Python, defina seu @code{tp_new} como @code{NULL} usando o sinalizador @ref{582,,Py_TPFLAGS_DISALLOW_INSTANTIATION}. Isso o torna aceitável para funções @code{PyType_From*}.
@end itemize

@item 
Evite funções @code{PyType_From*}: se você não precisa de recursos específicos do C (slots ou configuração do tamanho da instância), crie tipos @ref{583,,chamando} a metaclasse.

@item 
Se você `sabe' que @code{tp_new} pode ser ignorado com segurança, filtre o aviso de descontinuação usando @ref{584,,warnings.catch_warnings()} do Python.
@end itemize

@item 
@ref{585,,PyOS_InputHook} e @ref{586,,PyOS_ReadlineFunctionPointer} não são mais chamados em @ref{587,,subinterpretadores}. Isso ocorre porque os clientes geralmente dependem do estado global de todo o processo (uma vez que esses retornos de chamada não têm como recuperar o estado do módulo de extensão).

Isso também evita situações em que as extensões podem ser executadas em um subinterpretador que não oferecem suporte (ou no qual ainda não foram carregadas). Veja gh-104668@footnote{https://github.com/python/cpython/issues/104668} para mais informações.

@item 
@ref{588,,PyLongObject} teve seus componentes internos alterados para melhor desempenho. Embora os internos de @ref{588,,PyLongObject} sejam privados, eles são usados por alguns módulos de extensão. Os campos internos não devem mais ser acessados diretamente, em vez disso, as funções da API que começam com @code{PyLong_...} devem ser usadas. Duas novas funções de API `instáveis' são fornecidas para acesso eficiente ao valor de @ref{588,,PyLongObject}s que cabe em uma única palavra de máquina:


@itemize *

@item 
@ref{589,,PyUnstable_Long_IsCompact()}

@item 
@ref{58a,,PyUnstable_Long_CompactValue()}
@end itemize

@item 
Alocadores personalizados, definidos via @ref{58b,,PyMem_SetAllocator()}, agora precisam ser seguros para thread, independentemente do domínio de memória. Os alocadores que não possuem estado próprio, incluindo “ganchos”, não são afetados. Se o seu alocador personalizado ainda não for seguro para thread e você precisar de orientação, crie um novo relatório de problema no GitHub e CC @code{@@ericsnowcurrently}.
@end itemize

@node Descontinuados<2>,Removidos<2>,Portando para Python 3 12<2>,Alterações na API C<4>
@anchor{whatsnew/3 12 id6}@anchor{58c}
@subsubsection Descontinuados



@itemize *

@item 
Em conformidade com a 
@geindex Propostas de Melhorias do Python; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}, o campo @code{ma_version_tag} em @ref{3c1,,PyDictObject} foi descontinuado para módulos de extensão. Acessar este campo gerará um aviso do compilador em tempo de compilação. Este campo será removido no Python 3.14. (Contribuição de Ramvikrams e Kumar Aditya em gh-101193@footnote{https://github.com/python/cpython/issues/101193}. PEP de Ken Jin.)

@item 
Variáveis de configuração global descontinuadas:


@itemize *

@item 
@ref{3c6,,Py_DebugFlag}: use @ref{3c7,,PyConfig.parser_debug}

@item 
@ref{3c8,,Py_VerboseFlag}: use @ref{3c9,,PyConfig.verbose}

@item 
@ref{3ca,,Py_QuietFlag}: use @ref{3cb,,PyConfig.quiet}

@item 
@ref{3cc,,Py_InteractiveFlag}: use @ref{3cd,,PyConfig.interactive}

@item 
@ref{3ce,,Py_InspectFlag}: use @ref{3cf,,PyConfig.inspect}

@item 
@ref{3d0,,Py_OptimizeFlag}: use @ref{3d1,,PyConfig.optimization_level}

@item 
@ref{3d2,,Py_NoSiteFlag}: use @ref{3d3,,PyConfig.site_import}

@item 
@ref{3d4,,Py_BytesWarningFlag}: use @ref{3d5,,PyConfig.bytes_warning}

@item 
@ref{3d6,,Py_FrozenFlag}: use @ref{3d7,,PyConfig.pathconfig_warnings}

@item 
@ref{3d8,,Py_IgnoreEnvironmentFlag}: use @ref{3d9,,PyConfig.use_environment}

@item 
@ref{3da,,Py_DontWriteBytecodeFlag}: use @ref{3db,,PyConfig.write_bytecode}

@item 
@ref{3dc,,Py_NoUserSiteDirectory}: use @ref{3dd,,PyConfig.user_site_directory}

@item 
@ref{3de,,Py_UnbufferedStdioFlag}: use @ref{3df,,PyConfig.buffered_stdio}

@item 
@ref{3e0,,Py_HashRandomizationFlag}: use @ref{3e1,,PyConfig.use_hash_seed}
and @ref{3e2,,PyConfig.hash_seed}

@item 
@ref{3e3,,Py_IsolatedFlag}: use @ref{3e4,,PyConfig.isolated}

@item 
@ref{3e5,,Py_LegacyWindowsFSEncodingFlag}: use @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding}

@item 
@ref{3e7,,Py_LegacyWindowsStdioFlag}: use @ref{3a4,,PyConfig.legacy_windows_stdio}

@item 
@code{Py_FileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}

@item 
@code{Py_HasFileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}

@item 
@code{Py_FileSystemDefaultEncodeErrors}: use @ref{3e9,,PyConfig.filesystem_errors}

@item 
@code{Py_UTF8Mode}: use @ref{3ea,,PyPreConfig.utf8_mode} (see @ref{3eb,,Py_PreInitialize()})
@end itemize

A API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}. (Contribuição de Victor Stinner em gh-77782@footnote{https://github.com/python/cpython/issues/77782}.)

@item 
A criação de @ref{3c2,,tipos imutáveis} com bases mutáveis foi descontinuada e será desativada no Python 3.14. (gh-95388@footnote{https://github.com/python/cpython/issues/95388})

@item 
O cabeçalho @code{structmember.h} foi descontinuado, embora continue disponível e não haja planos para removê-lo.

Seu conteúdo agora está disponível apenas incluindo @code{Python.h}, com um prefixo @code{Py} adicionado se estiver faltando:


@itemize -

@item 
@ref{54f,,PyMemberDef}, @ref{58d,,PyMember_GetOne()} e @ref{58e,,PyMember_SetOne()}

@item 
Macros de tipo como @ref{58f,,Py_T_INT}, @ref{590,,Py_T_DOUBLE}, etc. (anteriormente @code{T_INT}, @code{T_DOUBLE}, etc.)

@item 
Os sinalizadores @ref{591,,Py_READONLY} (anteriormente @code{READONLY}) e @ref{592,,Py_AUDIT_READ} (anteriormente todas em maiúsculas)
@end itemize

Vários itens não são expostos em @code{Python.h}:


@itemize -

@item 
@ref{593,,T_OBJECT} (use @ref{594,,Py_T_OBJECT_EX})

@item 
@ref{595,,T_NONE} (anteriormente não documentada e bastante estranha)

@item 
A macro @code{WRITE_RESTRICTED} que não faz nada.

@item 
As macros @code{RESTRICTED} e @code{READ_RESTRICTED}, equivalentes a @ref{592,,Py_AUDIT_READ}.

@item 
Em algumas configurações, @code{<stddef.h>} não está incluído em @code{Python.h}. Deve ser incluído manualmente ao usar @code{offsetof()}.
@end itemize

O cabeçalho descontinuado continua a fornecer seu conteúdo original com os nomes originais. Seu código antigo pode permanecer inalterado, a menos que as macros extras e sem namespace o incomodem muito.

(Contribuição em gh-47146@footnote{https://github.com/python/cpython/issues/47146} de Petr Viktorin, baseado em trabalhos anteriores de Alexander Belopolsky e Matthias Braun.)

@item 
@ref{3f3,,PyErr_Fetch()} e @ref{3f6,,PyErr_Restore()} foram descontinuado. Use @ref{3f4,,PyErr_GetRaisedException()} e @ref{3f7,,PyErr_SetRaisedException()} em vez disso. (Contribuição de Mark Shannon em gh-101578@footnote{https://github.com/python/cpython/issues/101578}.)

@item 
@code{PyErr_Display()} foi descontinuada. Use @ref{402,,PyErr_DisplayException()} em vez disso. (Contribuição de Irit Katriel em gh-102755@footnote{https://github.com/python/cpython/issues/102755}).

@item 
@code{_PyErr_ChainExceptions} foi descontinuada. Use @code{_PyErr_ChainExceptions1} em vez disso. (Contribuição de Irit Katriel em gh-102192@footnote{https://github.com/python/cpython/issues/102192}.)

@item 
Usar @ref{57d,,PyType_FromSpec()}, @ref{57e,,PyType_FromSpecWithBases()} ou @ref{551,,PyType_FromModuleAndSpec()} para criar uma classe cujas substituições de metaclasse @ref{57f,,tp_new} foi descontinuado. Chame a metaclasse.
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<4>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<4>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<4>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<4>. 

@end menu

@node Remoção pendente no Python 3 14<4>,Remoção pendente no Python 3 15<4>,,Descontinuados<2>
@anchor{whatsnew/3 12 id7}@anchor{596}
@subsubsection Remoção pendente no Python 3.14



@itemize *

@item 
O campo @code{ma_version_tag} em @ref{3c1,,PyDictObject} para módulos de extensão (
@geindex Propostas de Melhorias do Python; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}; gh-101193@footnote{https://github.com/python/cpython/issues/101193}).

@item 
A criação de @ref{3c2,,tipos imutáveis} com bases mutáveis (gh-95388@footnote{https://github.com/python/cpython/issues/95388}).

@item 
Funções para configurar a inicialização do Python, descontinuadas no Python 3.11:


@itemize *

@item 
@code{PySys_SetArgvEx()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{PySys_SetArgv()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{Py_SetProgramName()}: defina @ref{3c4,,PyConfig.program_name}.

@item 
@code{Py_SetPythonHome()}: defina @ref{3bb,,PyConfig.home}.
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.

@item 
Variáveis de configuração globais


@itemize *

@item 
@ref{3c6,,Py_DebugFlag}: Use @ref{3c7,,PyConfig.parser_debug}.

@item 
@ref{3c8,,Py_VerboseFlag}: Use @ref{3c9,,PyConfig.verbose}.

@item 
@ref{3ca,,Py_QuietFlag}: Use @ref{3cb,,PyConfig.quiet}.

@item 
@ref{3cc,,Py_InteractiveFlag}: Use @ref{3cd,,PyConfig.interactive}.

@item 
@ref{3ce,,Py_InspectFlag}: Use @ref{3cf,,PyConfig.inspect}.

@item 
@ref{3d0,,Py_OptimizeFlag}: Use @ref{3d1,,PyConfig.optimization_level}.

@item 
@ref{3d2,,Py_NoSiteFlag}: Use @ref{3d3,,PyConfig.site_import}.

@item 
@ref{3d4,,Py_BytesWarningFlag}: Use @ref{3d5,,PyConfig.bytes_warning}.

@item 
@ref{3d6,,Py_FrozenFlag}: Use @ref{3d7,,PyConfig.pathconfig_warnings}.

@item 
@ref{3d8,,Py_IgnoreEnvironmentFlag}: Use @ref{3d9,,PyConfig.use_environment}.

@item 
@ref{3da,,Py_DontWriteBytecodeFlag}: Use @ref{3db,,PyConfig.write_bytecode}.

@item 
@ref{3dc,,Py_NoUserSiteDirectory}: Use @ref{3dd,,PyConfig.user_site_directory}.

@item 
@ref{3de,,Py_UnbufferedStdioFlag}: Use @ref{3df,,PyConfig.buffered_stdio}.

@item 
@ref{3e0,,Py_HashRandomizationFlag}: Use @ref{3e1,,PyConfig.use_hash_seed} e @ref{3e2,,PyConfig.hash_seed}.

@item 
@ref{3e3,,Py_IsolatedFlag}: Use @ref{3e4,,PyConfig.isolated}.

@item 
@ref{3e5,,Py_LegacyWindowsFSEncodingFlag}: Use @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding}.

@item 
@ref{3e7,,Py_LegacyWindowsStdioFlag}: Use @ref{3a4,,PyConfig.legacy_windows_stdio}.

@item 
@code{Py_FileSystemDefaultEncoding}: Use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_HasFileSystemDefaultEncoding}: Use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_FileSystemDefaultEncodeErrors}: Use @ref{3e9,,PyConfig.filesystem_errors}.

@item 
@code{Py_UTF8Mode}: Use @ref{3ea,,PyPreConfig.utf8_mode}. (veja @ref{3eb,,Py_PreInitialize()})
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.
@end itemize

@node Remoção pendente no Python 3 15<4>,Remoção pendente no Python 3 16<4>,Remoção pendente no Python 3 14<4>,Descontinuados<2>
@anchor{whatsnew/3 12 id8}@anchor{597}
@subsubsection Remoção pendente no Python 3.15



@itemize *

@item 
The @ref{3bd,,PyImport_ImportModuleNoBlock()}: use @ref{3be,,PyImport_ImportModule()}.

@item 
@ref{379,,PyWeakref_GetObject()} e @ref{3bf,,PyWeakref_GET_OBJECT()}: Use @ref{378,,PyWeakref_GetRef()}.

@item 
O tipo @ref{3ed,,Py_UNICODE} e a macro @code{Py_UNICODE_WIDE}: use @code{wchar_t}.

@item 
Funções de inicialização do Python


@itemize *

@item 
@ref{3af,,PySys_ResetWarnOptions()}: apague @ref{3b0,,sys.warnoptions} e @code{warnings.filters}.

@item 
@ref{3b1,,Py_GetExecPrefix()}: obtenha @ref{3ee,,sys.base_exec_prefix} e @ref{3b2,,sys.exec_prefix}.

@item 
@ref{3b3,,Py_GetPath()}: leia @ref{3b4,,sys.path}.

@item 
@ref{3b5,,Py_GetPrefix()}: obtenha @ref{3ef,,sys.base_prefix} e @ref{3b6,,sys.prefix}.

@item 
@ref{3b7,,Py_GetProgramFullPath()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3b9,,Py_GetProgramName()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3ba,,Py_GetPythonHome()}: leia @ref{3bb,,PyConfig.home} ou a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}.
@end itemize
@end itemize

@node Remoção pendente no Python 3 16<4>,Remoção pendente em versões futuras<4>,Remoção pendente no Python 3 15<4>,Descontinuados<2>
@anchor{whatsnew/3 12 id9}@anchor{598}
@subsubsection Remoção pendente no Python 3.16



@itemize *

@item 
A cópia empacotada do @code{libmpdec}.
@end itemize

@node Remoção pendente em versões futuras<4>,,Remoção pendente no Python 3 16<4>,Descontinuados<2>
@anchor{whatsnew/3 12 id10}@anchor{599}
@subsubsection Remoção pendente em versões futuras


As APIs a seguir foram descontinuadas e serão removidas, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{3f2,,Py_TPFLAGS_HAVE_FINALIZE}: desnecessária desde o Python 3.8.

@item 
@ref{3f3,,PyErr_Fetch()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f5,,PyErr_NormalizeException()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f6,,PyErr_Restore()}: use @ref{3f7,,PyErr_SetRaisedException()}.

@item 
@ref{3f8,,PyModule_GetFilename()}: use @ref{3f9,,PyModule_GetFilenameObject()}.

@item 
@ref{3fa,,PyOS_AfterFork()}: use @ref{3fb,,PyOS_AfterFork_Child()}.

@item 
@ref{3fc,,PySlice_GetIndicesEx()}: use @ref{3fd,,PySlice_Unpack()} e @ref{3fe,,PySlice_AdjustIndices()}.

@item 
@code{PyUnicode_AsDecodedObject()}: use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsDecodedUnicode()}: Use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsEncodedObject()}: use @ref{400,,PyCodec_Encode()}.

@item 
@code{PyUnicode_AsEncodedUnicode()}: Use @ref{400,,PyCodec_Encode()}.

@item 
@ref{401,,PyUnicode_READY()}: desnecessário desde o Python 3.12

@item 
@code{PyErr_Display()}: use @ref{402,,PyErr_DisplayException()}.

@item 
@code{_PyErr_ChainExceptions()}: use @code{_PyErr_ChainExceptions1()}.

@item 
O membro @code{PyBytesObject.ob_shash}: chame @ref{403,,PyObject_Hash()}.

@item 
O membro @code{PyDictObject.ma_version_tag}.

@item 
API do Thread Local Storage (TLS):


@itemize *

@item 
@ref{404,,PyThread_create_key()}: use @ref{405,,PyThread_tss_alloc()}.

@item 
@ref{406,,PyThread_delete_key()}: use @ref{407,,PyThread_tss_free()}.

@item 
@ref{408,,PyThread_set_key_value()}: use @ref{409,,PyThread_tss_set()}.

@item 
@ref{40a,,PyThread_get_key_value()}: use @ref{40b,,PyThread_tss_get()}.

@item 
@ref{40c,,PyThread_delete_key_value()}: use @ref{40d,,PyThread_tss_delete()}.

@item 
@ref{40e,,PyThread_ReInitTLS()}: desnecessário desde o Python 3.7.
@end itemize
@end itemize

@node Removidos<2>,,Descontinuados<2>,Alterações na API C<4>
@anchor{whatsnew/3 12 id11}@anchor{59a}
@subsubsection Removidos



@itemize *

@item 
Remove o arquivo de cabeçalho @code{token.h}. Nunca houve nenhuma API C de tokenizador público. O arquivo de cabeçalho @code{token.h} foi projetado apenas para ser usado por internos do Python. (Contribuição de Victor Stinner em gh-92651@footnote{https://github.com/python/cpython/issues/92651}.)

@item 
As APIs Unicode legadas foram removidas. Veja a 
@geindex Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} para detalhes.


@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 
Remove a macro de função @code{PyUnicode_InternImmortal()}. (Contribuição de Victor Stinner em gh-85858@footnote{https://github.com/python/cpython/issues/85858}.)
@end itemize

@node O que há de novo no Python 3 11,O que há de novo no Python 3 10,O que há de novo no Python 3 12,O que há de novo no Python
@anchor{whatsnew/3 11 doc}@anchor{59b}@anchor{whatsnew/3 11 translation-repo}@anchor{59c}@anchor{whatsnew/3 11 what-s-new-in-python-3-11}@anchor{59d}
@section O que há de novo no 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 artigo explica os novos recursos no Python 3.11, em comparação com 3.10. Python 3.11 foi lançado em 24 de outubro de 2022. Veja @ref{13c,,changelog} para uma lista completa de mudanças.

@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<3>. 
* Novas funcionalidades: Novas funcionalidades<5>. 
* Novos recursos relacionados a dicas de tipo: Novos recursos relacionados a dicas de tipo<2>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<3>. 
* Outras mudanças na implementação do CPython:: 
* Novos módulos: Novos módulos<3>. 
* Módulos melhorados: Módulos melhorados<3>. 
* Otimizações: Otimizações<3>. 
* CPython mais rápido:: 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<3>. 
* Descontinuados: Descontinuados<3>. 
* Pendente remoção no Python 3.12: Pendente remoção no Python 3 12. 
* Removidos: Removidos<3>. 
* Portando para Python 3.11: Portando para Python 3 11. 
* Mudanças na construção: Mudanças na construção<3>. 
* Alterações na API C: Alterações na API C<5>. 
* Alterações notáveis no 3.11.4: Alterações notáveis no 3 11 4. 
* Alterações notáveis no 3.11.5: Alterações notáveis no 3 11 5. 

@end menu

@node Resumo – Destaques da versão<3>,Novas funcionalidades<5>,,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 summary-release-highlights}@anchor{59e}@anchor{whatsnew/3 11 whatsnew311-summary}@anchor{59f}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.11.
@c Brevity is key.


@itemize *

@item 
O Python 3.11 é entre 10-60% mais rápido que o Python 3.10. Em média, medimos uma aceleração de 1,25x no conjunto de benchmarks padrão. Veja @ref{5a0,,CPython mais rápido} para detalhes.
@end itemize

@c PEP-sized items next.

Novos recursos de sintaxe:


@itemize *

@item 
@ref{5a1,,PEP 654; Grupos de exceção e except*}
@end itemize

Novos recursos embutidos:


@itemize *

@item 
@ref{5a2,,PEP 678; Exceções podem ser enriquecidas com notas}
@end itemize

Novos módulos da biblioteca padrão:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/}: @ref{fc,,tomllib} — Suporte para analisar TOML@footnote{https://toml.io/} na Biblioteca Padrão
@end itemize

Melhorias no interpretador:


@itemize *

@item 
@ref{5a3,,PEP 657; Localizações de erros refinadas em tracebacks}

@item 
Nova opção de linha de comando @ref{5a4,,-P} e variável de ambiente 
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH} para @ref{5a6,,desabilitar automaticamente a anteposição automática de caminhos potencialmente inseguros} para @ref{3b4,,sys.path}
@end itemize

Novos recursos de tipagem:


@itemize *

@item 
@ref{5a7,,PEP 646; Genéricos variádicos}

@item 
@ref{5a8,,PEP 655; Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios}

@item 
@ref{5a9,,PEP 673; Tipo Self}

@item 
@ref{5aa,,PEP 675; Tipo de string literal arbitrário}

@item 
@ref{5ab,,PEP 681; Transformações de classe de dados}
@end itemize

Descontinuações, remoções e restrições importantes:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: @ref{5ac,,Muitos módulos legados de biblioteca padrão foram descontinuados} e serão removidos no Python 3.13

@item 
@geindex Propostas de Melhorias do Python; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}: @ref{5ad,,APIs do codificador Py_UNICODE foram removidas}

@item 
@geindex Propostas de Melhorias do Python; PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/}: @ref{5ae,,Macros convertidos em funções estáticas em linha}
@end itemize

@node Novas funcionalidades<5>,Novos recursos relacionados a dicas de tipo<2>,Resumo – Destaques da versão<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 new-features}@anchor{5af}@anchor{whatsnew/3 11 whatsnew311-features}@anchor{5b0}
@subsection Novas funcionalidades


@menu
* PEP 657; Localizações de erros refinadas em tracebacks: PEP 657 Localizações de erros refinadas em tracebacks. 
* PEP 654; Grupos de exceção e except*: PEP 654 Grupos de exceção e except*. 
* PEP 678; Exceções podem ser enriquecidas com notas: PEP 678 Exceções podem ser enriquecidas com notas. 
* Melhorias no inicializador py.exe do Windows: Melhorias no inicializador py exe do Windows. 

@end menu

@node PEP 657 Localizações de erros refinadas em tracebacks,PEP 654 Grupos de exceção e except*,,Novas funcionalidades<5>
@anchor{whatsnew/3 11 pep-657-fine-grained-error-locations-in-tracebacks}@anchor{5b1}@anchor{whatsnew/3 11 whatsnew311-pep657}@anchor{5a3}
@subsubsection PEP 657: Localizações de erros refinadas em tracebacks


Ao imprimir tracebacks (situação da pilha de execução), o interpretador agora apontará para a expressão exata que causou o erro, em vez de apenas a linha. Por exemplo:

@example
Traceback (most recent call last):
  File "distância.py", line 11, in <module>
    print(distância_de_manhattan(p1, p2))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "distância.py", line 6, in distância_de_manhattan
    return abs(ponto_1.x - ponto_2.x) + abs(ponto_1.y - ponto_2.y)
                           ^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'x'
@end example

Versões anteriores do interpretador apontavam apenas para a linha, tornando ambíguo qual objeto era @code{None}. Esses erros aprimorados também podem ser úteis ao lidar com objetos @ref{256,,dict} profundamente aninhados e várias chamadas de função:

@example
Traceback (most recent call last):
  File "consultar.py", line 37, in <module>
    mágica_aritmética('foo')
  File "consultar.py", line 18, in mágica_aritmética
    return adicionar_contagens(x) / 25
           ^^^^^^^^^^^^^
  File "consultar.py", line 24, in adicionar_contagens
    return 25 + consultar_usuário(usuário1) + consultar_usuário(usuário2)
                ^^^^^^^^^^^^^^^^^
  File "consultar.consultar", line 32, in consultar_usuário
    return 1 + consultar_contagem(db, resposta['a']['b']['c']['user'], tentar_novamente=True)
                                      ~~~~~~~~~~~~~~~~~~^^^^^
TypeError: 'NoneType' object is not subscriptable
@end example

Bem como expressões aritméticas complexas:

@example
Traceback (most recent call last):
  File "cálculo.py", line 54, in <module>
    resultado = (x / y / z) * (a / b / c)
                 ~~~~~~^~~
ZeroDivisionError: division by zero
@end example

Além disso, as informações usadas pela funcionalidade de traceback aprimorado são disponibilizadas por meio de uma API geral, que pode ser usada para correlacionar @ref{5b2,,instruções} @ref{187,,bytecode} com a localização do código-fonte. Essas informações podem ser recuperadas usando:


@itemize -

@item 
O método @ref{5b3,,codeobject.co_positions()} no Python.

@item 
A função @ref{5b4,,PyCode_Addr2Location()} na API C.
@end itemize

Veja 
@geindex Propostas de Melhorias do Python; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} para mais detalhes. (Contribuição de Pablo Galindo, Batuhan Taskaya e Ammar Askar em bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}.)

@cartouche
@quotation Nota 
Esse recurso requer o armazenamento de posições de coluna em @ref{5b5,,Objetos código}, o que pode resultar em um pequeno aumento no uso de memória do interpretador e no uso de disco para arquivos Python compilados. Para evitar armazenar as informações extras e desativar a exibição das informações extras de rastreamento, use a opção de linha de comando @ref{176,,-X no_debug_ranges} ou a variável de ambiente 
@geindex PYTHONNODEBUGRANGES
@geindex variável de ambiente; PYTHONNODEBUGRANGES
@ref{5b6,,PYTHONNODEBUGRANGES}.
@end quotation
@end cartouche

@node PEP 654 Grupos de exceção e except*,PEP 678 Exceções podem ser enriquecidas com notas,PEP 657 Localizações de erros refinadas em tracebacks,Novas funcionalidades<5>
@anchor{whatsnew/3 11 pep-654-exception-groups-and-except}@anchor{5b7}@anchor{whatsnew/3 11 whatsnew311-pep654}@anchor{5a1}
@subsubsection PEP 654: Grupos de exceção e @code{except*}


@geindex Propostas de Melhorias do Python; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} introduz recursos de linguagem que permitem que um programa levante e manipule várias exceções não relacionadas simultaneamente. Os tipos internos @ref{1b6,,ExceptionGroup} e @ref{25f,,BaseExceptionGroup} tornam possível agrupar exceções e criá-las juntas, e a nova sintaxe @ref{5b8,,except*} generaliza @ref{18b,,except} para corresponder a subgrupos de grupos de exceção.

Veja 
@geindex Propostas de Melhorias do Python; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} para mais detalhes.

(Contribuição de Irit Katriel em bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}. PEP escrita por Irit Katriel, Yury Selivanov e Guido van Rossum.)

@node PEP 678 Exceções podem ser enriquecidas com notas,Melhorias no inicializador py exe do Windows,PEP 654 Grupos de exceção e except*,Novas funcionalidades<5>
@anchor{whatsnew/3 11 pep-678-exceptions-can-be-enriched-with-notes}@anchor{5b9}@anchor{whatsnew/3 11 whatsnew311-pep678}@anchor{5a2}
@subsubsection PEP 678: Exceções podem ser enriquecidas com notas


O método @ref{5ba,,add_note()} é adicionado a @ref{5bb,,BaseException}. Ele pode ser usado para enriquecer exceções com informações de contexto que não estão disponíveis no momento em que a exceção é gerada. As notas adicionadas aparecem no traceback padrão.

Veja 
@geindex Propostas de Melhorias do Python; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} para mais detalhes.

(Contribuição de Irit Katriel em bpo-45607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45607}. PEP escrita por Zac Hatfield-Dodds.)

@node Melhorias no inicializador py exe do Windows,,PEP 678 Exceções podem ser enriquecidas com notas,Novas funcionalidades<5>
@anchor{whatsnew/3 11 whatsnew311-windows-launcher}@anchor{5bc}@anchor{whatsnew/3 11 windows-py-exe-launcher-improvements}@anchor{5bd}
@subsubsection Melhorias no inicializador @code{py.exe} do Windows


A cópia do @ref{5be,,Inicializador Python para Windows} incluída no Python 3.11 foi significativamente atualizada. Ele agora oferece suporte à sintaxe de company/tag conforme definido em 
@geindex Propostas de Melhorias do Python; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} usando o argumento @code{-V:@var{<company>}/@var{<tag>}} em vez do limitado @code{-@var{<major>}.@var{<minor>}}. Isso permite iniciar outras distribuições além de @code{PythonCore}, aquela hospedada em python.org@footnote{https://www.python.org}.

Ao usar seletores @code{-V:}, tanto company quanto tag podem ser omitidos, mas todas as instalações serão pesquisadas. Por exemplo, @code{-V:OtherPython/} selecionará a “melhor” tag registrada para @code{OtherPython}, enquanto @code{-V:3.11} ou @code{-V:/3.11} selecionará o “best” com a tag @code{3.11}.

Ao usar os argumentos legados @code{-@var{<major>}}, @code{-@var{<major>}.@var{<minor>}}, @code{-@var{<major>}-@var{<bitness>}} ou @code{-@var{<major>}.@var{<minor>}-@var{<bitness>}}, todo o comportamento existente deve ser preservado de versões anteriores e somente lançamentos de @code{PythonCore} será selecionado. No entanto, o sufixo @code{-64} agora implica “não 32 bits” (não necessariamente x86-64), pois existem várias plataformas de 64 bits suportadas. Tempos de execução de 32 bits são detectados verificando a tag do tempo de execução para um sufixo @code{-32}. Todas as versões do Python desde 3.5 incluíram isso em suas compilações de 32 bits.
@anchor{whatsnew/3 11 new-feat-related-type-hints-311}@anchor{5bf}
@node Novos recursos relacionados a dicas de tipo<2>,Outras mudanças na linguagem<3>,Novas funcionalidades<5>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 new-features-related-to-type-hints}@anchor{5c0}@anchor{whatsnew/3 11 whatsnew311-typing-features}@anchor{5c1}
@subsection Novos recursos relacionados a dicas de tipo


Esta seção cobre as principais mudanças que afetam as dicas de tipo da  
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e o módulo @ref{104,,typing}.

@menu
* PEP 646; Genéricos variádicos: PEP 646 Genéricos variádicos. 
* PEP 655; Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios: PEP 655 Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios. 
* PEP 673; Tipo Self: PEP 673 Tipo Self. 
* PEP 675; Tipo de string literal arbitrário: PEP 675 Tipo de string literal arbitrário. 
* PEP 681; Transformações de classe de dados: PEP 681 Transformações de classe de dados. 
* PEP 563 pode não ser o futuro:: 

@end menu

@node PEP 646 Genéricos variádicos,PEP 655 Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios,,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-646-variadic-generics}@anchor{5c2}@anchor{whatsnew/3 11 whatsnew311-pep646}@anchor{5a7}
@subsubsection PEP 646: Genéricos variádicos


@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introduzido anteriormente @ref{15d,,TypeVar}, permitindo a criação de genéricos parametrizados com um único tipo. 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} adiciona @ref{15f,,TypeVarTuple}, permitindo a parametrização com um número `arbitrário' de tipos. Em outras palavras, uma @ref{15f,,TypeVarTuple} é uma variável do tipo `variádico', habilitando genéricos `variádicos'.

Isso permite uma ampla variedade de casos de uso. Em particular, ele permite que o tipo de estruturas do tipo array em bibliotecas de computação numérica, como NumPy e TensorFlow, sejam parametrizadas com o array `shape'. Os verificadores de tipo estáticos agora poderão capturar bugs relacionados a formas no código que usa essas bibliotecas.

Veja 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} para mais detalhes.

(Contribuição de Matthew Rahtz em bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}, com contribuições de Serhiy Storchaka e Jelle Zijlstra. PEP escrita por Mark Mendoza, Matthew Rahtz, Pradeep Kumar Srinivasan e Vincent Siles.)

@node PEP 655 Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios,PEP 673 Tipo Self,PEP 646 Genéricos variádicos,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-655-marking-individual-typeddict-items-as-required-or-not-required}@anchor{5c3}@anchor{whatsnew/3 11 whatsnew311-pep655}@anchor{5a8}
@subsubsection PEP 655: Marcando itens @code{TypedDict} individuais como obrigatórios ou não obrigatórios


@ref{5c4,,Required} e @ref{5c5,,NotRequired} fornecem uma maneira direta de marcar se itens individuais em um @ref{162,,TypedDict} devem estar presentes. Anteriormente, isso só era possível usando herança.

Todos os campos ainda são obrigatórios por padrão, a menos que o parâmetro `total' seja definido como @code{False}, caso em que todos os campos ainda não são obrigatórios por padrão. Por exemplo, o seguinte especifica um @code{TypedDict} com uma chave obrigatória e uma chave não obrigatória:

@example
class Filme(TypedDict):
   título: str
   ano: NotRequired[int]

m1: Filme = @{"título": "Pantera Negra", "ano": 2018@}  # OK
m2: Filme = @{"título": "Star Wars"@}  # OK (ano não é obrigatório)
m3: Filme = @{"ano": 2022@}  # ERRO (falta título, um campo obrigatório)
@end example

A seguinte definição é equivalente:

@example
class File(TypedDict, total=False):
   título: Required[str]
   ano: int
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} para mais detalhes.

(Contribuição de David Foster e Jelle Zijlstra em bpo-47087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47087}. PEP escrita por David Foster.)

@node PEP 673 Tipo Self,PEP 675 Tipo de string literal arbitrário,PEP 655 Marcando itens TypedDict individuais como obrigatórios ou não obrigatórios,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-673-self-type}@anchor{5c6}@anchor{whatsnew/3 11 whatsnew311-pep673}@anchor{5a9}
@subsubsection PEP 673: Tipo @code{Self}


A nova anotação @ref{5c7,,Self} fornece uma maneira simples e intuitiva de anotar métodos que retornam uma instância de sua classe. Isso se comporta da mesma forma que a abordagem baseada em @ref{15d,,TypeVar} 
@geindex Propostas de Melhorias do Python; PEP 484#annotating-instance-and-class-methods
especificada na PEP 484@footnote{https://peps.python.org/pep-0484/#annotating-instance-and-class-methods}, mas é mais concisa e fácil de seguir.

Casos de uso comuns incluem construtores alternativos fornecidos como @ref{166,,classmethod}s e métodos @ref{5c8,,__enter__()} que retornam @code{self}:

@example
class MinhaTrava:
    def __enter__(self) -> Self:
        self.trava()
        return self

    ...

class MeuInt:
    @@classmethod
    def de_hex(cls, s: str) -> Self:
        return cls(int(s, 16))

    ...
@end example

@ref{5c7,,Self} também pode ser usado para anotar parâmetros de métodos ou atributos do mesmo tipo que sua classe de inclusão.

Veja 
@geindex Propostas de Melhorias do Python; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} para mais detalhes.

(Contribuição de James Hilton-Balfe em bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534}. PEP escrita por Pradeep Kumar Srinivasan e James Hilton-Balfe.)

@node PEP 675 Tipo de string literal arbitrário,PEP 681 Transformações de classe de dados,PEP 673 Tipo Self,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-675-arbitrary-literal-string-type}@anchor{5c9}@anchor{whatsnew/3 11 whatsnew311-pep675}@anchor{5aa}
@subsubsection PEP 675: Tipo de string literal arbitrário


A nova anotação @ref{5ca,,LiteralString} pode ser usada para indicar que um parâmetro de função pode ser de qualquer tipo de string literal. Isso permite que uma função aceite tipos de string literais arbitrários, bem como strings criadas a partir de outras strings literais. Os verificadores de tipo podem então impor que funções confidenciais, como aquelas que executam instruções SQL ou comandos de console, sejam chamadas apenas com argumentos estáticos, fornecendo proteção contra ataques de injeção.

Por exemplo, uma função de consulta SQL pode ser anotada da seguinte forma:

@example
def faz_consulta(sql: LiteralString) -> ...
    ...

def chamador(
    string_arbitrária: str,
    string_consulta: LiteralString,
    nome_tabela: LiteralString,
) -> None:
    faz_consulta("SELECT * FROM students")       # ok
    faz_consulta(string_consulta)                # ok
    faz_consulta("SELECT * FROM " + nome_tabela) # ok
    faz_consulta(string_arbitrária)              # erro no verificador de tipo
    faz_consulta(                                # erro no verificador de tipo
        f"SELECT * FROM students WHERE name = @{string_arbitrária@}"
    )
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} para mais detalhes.

(Contribuição de Jelle Zijlstra em bpo-47088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47088}. PEP escrita por Pradeep Kumar Srinivasan e Graham Bleaney.)

@node PEP 681 Transformações de classe de dados,PEP 563 pode não ser o futuro,PEP 675 Tipo de string literal arbitrário,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-681-data-class-transforms}@anchor{5cb}@anchor{whatsnew/3 11 whatsnew311-pep681}@anchor{5ab}
@subsubsection PEP 681: Transformações de classe de dados


@ref{4d4,,dataclass_transform} pode ser usado para decorar uma classe, metaclasse ou uma função que é um decorador. A presença de @code{@@dataclass_transform()} informa a um verificador de tipo estático que o objeto decorado executa uma “mágica” de tempo de execução que transforma uma classe, dando a ela comportamentos semelhantes a @ref{1cb,,dataclass}.

Por exemplo:

@example
# O decorador cria_modelo está definido por uma biblioteca.
@@typing.dataclass_transform()
def cria_modelo(cls: Type[T]) -> Type[T]:
    cls.__init__ = ...
    cls.__eq__ = ...
    cls.__ne__ = ...
    return cls

# O decorador cria_modelo agora pode ser usado para criar novas classes de modelo:
@@cria_modelo
class ModeloCliente:
    id: int
    nome: str

c = ModeloCliente(id=327, nome="Eric Idle")
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/} para mais detalhes.

(Contribuição de Jelle Zijlstra em gh-91860@footnote{https://github.com/python/cpython/issues/91860}. PEP escrita por Erik De Bonte e Eric Traut.)

@node PEP 563 pode não ser o futuro,,PEP 681 Transformações de classe de dados,Novos recursos relacionados a dicas de tipo<2>
@anchor{whatsnew/3 11 pep-563-may-not-be-the-future}@anchor{5cc}@anchor{whatsnew/3 11 whatsnew311-pep563-deferred}@anchor{5cd}
@subsubsection PEP 563 pode não ser o futuro


@geindex Propostas de Melhorias do Python; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} Avaliação adiada de anotações (a @code{from __future__ import annotations} @ref{189,,instrução future}) que foi originalmente planejada para lançamento no Python 3.10 foi colocada em espera indefinidamente. Veja esta mensagem do Conselho Diretor@footnote{https://mail.python.org/archives/list/python-dev@@python.org/message/VIZEBX5EYMSYIJNDBF6DMUMZOCWHARSO/} para mais informações.

@node Outras mudanças na linguagem<3>,Outras mudanças na implementação do CPython,Novos recursos relacionados a dicas de tipo<2>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 other-language-changes}@anchor{5ce}@anchor{whatsnew/3 11 whatsnew311-other-lang-changes}@anchor{5cf}
@subsection Outras mudanças na linguagem



@itemize *

@item 
Expressões de desempacotamento com asterisco agora podem ser usadas em instruções @ref{2f2,,for}. (Veja bpo-46725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46725} para mais detalhes.)

@item 
@ref{5d0,,Compreensões} assíncronas agora são permitidas dentro de compreensões em @ref{5d1,,funções assíncronas}. As compreensões externas tornam-se implicitamente assíncronas neste caso. (Contribuição de Serhiy Storchaka em bpo-33346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33346}.)

@item 
Uma exceção @ref{2c3,,TypeError} agora é levantada em vez de uma @ref{34b,,AttributeError} em instruções @ref{5d2,,with} e @ref{5d3,,contextlib.ExitStack.enter_context()} para objetos que não oferecem suporte ao protocolo de @ref{5d4,,gerenciador de contexto}, e em instruções @ref{5d5,,async with} e @ref{5d6,,contextlib.AsyncExitStack.enter_async_context()} para objetos que não oferecem suporte ao protocolo de @ref{5d7,,gerenciador de contexto assíncrono}. (Contribuição de Serhiy Storchaka em bpo-12022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12022} e bpo-44471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44471}.)

@item 
Adicionado @ref{5d8,,object.__getstate__()}, que fornece a implementação padrão do método @code{__getstate__()}. Fazer @ref{25,,copy} e @ref{a6,,pickle} de instâncias de subclasses de tipos embutidos @ref{2ea,,bytearray}, @ref{5d9,,set}, @ref{5da,,frozenset}, @ref{5db,,collections.OrderedDict}, @ref{5dc,,collections.deque}, @ref{5dd,,weakref.WeakSet} e @ref{5de,,datetime.tzinfo} agora copia e serializa com pickle atributos de instância implementados como @ref{5df,,slots}. Essa mudança tem um efeito colateral não intencional: ela atrapalha uma pequena minoria de projetos Python existentes que não esperavam que @ref{5d8,,object.__getstate__()} existisse. Consulte os comentários posteriores  em gh-70766@footnote{https://github.com/python/cpython/issues/70766} para discussões sobre quais soluções alternativas esse código pode precisar. (Contribuição de Serhiy Storchaka em bpo-26579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26579}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pythonsafepath}@anchor{5a6}

@itemize *

@item 
Adicionada uma opção de linha de comando @ref{5a4,,-P} e uma variável de ambiente 
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH}, que desativa o prefixo automático para @ref{3b4,,sys.path} do diretório do script ao executar um script ou o diretório atual ao usar @ref{5e0,,-c} e @ref{5e1,,-m}. Isso garante que apenas os módulos stdlib e instalados sejam escolhidos por @ref{5e2,,import}, e evita sombreamento involuntário ou mal-intencionado de módulos com aqueles em um diretório local (e normalmente gravável pelo usuário). (Contribuição de Victor Stinner em gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)

@item 
Uma opção @code{"z"} foi adicionada ao @ref{1e8,,Minilinguagem de especificação de formato} que força zero negativo para positivo após o arredondamento para a precisão do formato. Veja 
@geindex Propostas de Melhorias do Python; PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/} para mais detalhes. (Contribuição de John Belmonte em gh-90153@footnote{https://github.com/python/cpython/issues/90153}.)

@item 
Bytes não são mais aceitos em @ref{3b4,,sys.path}. O suporte quebrou em algum momento entre o Python 3.2 e o 3.6, sem que ninguém percebesse até o lançamento do Python 3.10.0. Além disso, trazer de volta o suporte seria problemático devido às interações entre @ref{5e3,,-b} e @ref{5e4,,sys.path_importer_cache} quando há uma mistura de chaves @ref{44c,,str} e @ref{1c2,,bytes}. (Contribuição de Thomas Grainger em gh-91181@footnote{https://github.com/python/cpython/issues/91181}.)
@end itemize

@node Outras mudanças na implementação do CPython,Novos módulos<3>,Outras mudanças na linguagem<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 other-cpython-implementation-changes}@anchor{5e5}@anchor{whatsnew/3 11 whatsnew311-other-implementation-changes}@anchor{5e6}
@subsection Outras mudanças na implementação do CPython



@itemize *

@item 
Os métodos especiais @ref{5e7,,__complex__()} para @ref{2f8,,complex} e @ref{5e8,,__bytes__()} para @ref{1c2,,bytes} são implementados para oferecer suporte aos protocolos @ref{5e9,,typing.SupportsComplex} e @ref{5ea,,typing.SupportsBytes}. (Contribuição de Mark Dickinson e Donghee Na em bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}.)

@item 
@code{siphash13} foi adicionado como um novo algoritmo de hash interno. Ele tem propriedades de segurança semelhantes ao @code{siphash24}, mas é um pouco mais rápido para entradas longas. @ref{44c,,str}, @ref{1c2,,bytes} e alguns outros tipos agora o usam como o algoritmo padrão para @ref{5eb,,hash()}. @ref{5ec,,Arquivos .pyc baseados em hash} da 
@geindex Propostas de Melhorias do Python; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} agora usam @code{siphash13} também. (Contribuição de Inada Naoki em bpo-29410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29410}.)

@item 
Quando uma exceção ativa é reativada por uma instrução @ref{5ed,,raise} sem parâmetros, o traceback anexado a essa exceção agora é sempre @code{sys.exc_info()[1].__traceback__}. Isso significa que as alterações feitas no traceback na cláusula @ref{18b,,except} atual são refletidas na exceção levantada novamente. (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
A representação do estado do interpretador de exceções tratadas (também conhecidas como @code{exc_info} ou @code{_PyErr_StackItem}) agora tem apenas o campo @code{exc_value}; @code{exc_type} e @code{exc_traceback} foram removidos, pois podem ser derivados de @code{exc_value}. (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
Uma nova @ref{5ee,,opção de linha de comando}, @code{AppendPath}, foi adicionada para o instalador do Windows. Ela se comporta de maneira semelhante ao @code{PrependPath}, mas anexa os diretórios de instalação e scripts em vez de antecedê-los. (Contribuição de Bastian Neuburger em bpo-44934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44934}.)

@item 
O campo @ref{5ef,,PyConfig.module_search_paths_set} agora deve ser definido como @code{1} para a inicialização usar @ref{3a2,,PyConfig.module_search_paths} para inicializar @ref{3b4,,sys.path}. Caso contrário, a inicialização irá recalcular o caminho e substituir quaisquer valores adicionados a @code{module_search_paths}.

@item 
A saída da opção @ref{5f0,,--help} agora cabe em 50 linhas/80 colunas. Informações sobre as @ref{5f1,,variáveis de ambiente do Python} e a opção @ref{176,,-X} agora estão disponíveis usando os respectivos sinalizadores @ref{5f2,,--help-env} e @ref{5f3,,--help-xoptions}, e com o novo @ref{5f4,,--help-all}. (Contribuição de Éric Araujo em bpo-46142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46142}.)

@item 
Converter entre @ref{257,,int} e @ref{44c,,str} em bases diferentes de 2 (binário), 4, 8 (octal), 16 (hexadecimal) ou 32 como base 10 (decimal) agora levanta uma exceção @ref{202,,ValueError} se o número de dígitos em forma de string estiver acima de um limite para evitar possíveis ataques de negação de serviço devido à complexidade algorítmica. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}. Este limite pode ser configurado ou desabilitado por variável de ambiente, sinalizador de linha de comando ou APIs de @ref{d9,,sys}. Veja a documentação de @ref{5f5,,limitação de comprimento de conversão de string inteira}. O limite padrão é de 4300 dígitos em forma de string.
@end itemize

@node Novos módulos<3>,Módulos melhorados<3>,Outras mudanças na implementação do CPython,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 new-modules}@anchor{5f6}@anchor{whatsnew/3 11 whatsnew311-new-modules}@anchor{5f7}
@subsection Novos módulos



@itemize *

@item 
@ref{fc,,tomllib}: Para analisar TOML@footnote{https://toml.io/}. Veja 
@geindex Propostas de Melhorias do Python; PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/} para mais detalhes. (Contribuição de Taneli Hukkinen em bpo-40059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40059}.)

@item 
@ref{11c,,wsgiref.types}: Tipos específicos de 
@geindex Propostas de Melhorias do Python; PEP 3333
WSGI@footnote{https://peps.python.org/pep-3333/} para verificação de tipo estático. (Contribuição de Sebastian Rittau em bpo-42012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42012}.)
@end itemize

@node Módulos melhorados<3>,Otimizações<3>,Novos módulos<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 improved-modules}@anchor{5f8}@anchor{whatsnew/3 11 whatsnew311-improved-modules}@anchor{5f9}
@subsection Módulos melhorados


@menu
* asyncio: asyncio<3>. 
* contextlib:: 
* dataclasses:: 
* datetime:: 
* enum: enum<3>. 
* fcntl:: 
* fractions: fractions<3>. 
* functools:: 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE e idlelib:: 
* inspect: inspect<2>. 
* locale: locale<3>. 
* logging:: 
* math: math<3>. 
* operador:: 
* os: os<3>. 
* pathlib: pathlib<4>. 
* re: re<3>. 
* shutil: shutil<3>. 
* socket:: 
* sqlite3: sqlite3<4>. 
* string:: 
* sys: sys<4>. 
* sysconfig:: 
* tempfile: tempfile<3>. 
* threading: threading<2>. 
* time: time<2>. 
* tkinter: tkinter<3>. 
* traceback: traceback<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<4>. 
* venv: venv<2>. 
* avisos: avisos<2>. 
* zipfile:: 

@end menu

@node asyncio<3>,contextlib,,Módulos melhorados<3>
@anchor{whatsnew/3 11 asyncio}@anchor{5fa}@anchor{whatsnew/3 11 whatsnew311-asyncio}@anchor{5fb}
@subsubsection asyncio



@itemize *

@item 
Adicionada a classe @ref{1b5,,TaskGroup}, um @ref{5fc,,assíncrono gerenciador de contexto} contendo um grupo de tarefas que irá esperar por todas elas ao sair. Para código novo, é recomendado usar @ref{1bf,,create_task()} e @ref{5fd,,gather()} diretamente. (Contribuição de Yury Selivanov e outros em gh-90908@footnote{https://github.com/python/cpython/issues/90908}.)

@item 
Adicionado @ref{5fe,,timeout()}, um gerenciador de contexto assíncrono para definir um tempo limite em operações assíncronas. Para código novo, é recomendado usar @ref{5ff,,wait_for()} diretamente. (Contribuição de Andrew Svetlov em gh-90927@footnote{https://github.com/python/cpython/issues/90927}.)

@item 
Adicionada a classe @ref{600,,Runner}, que expõe o maquinário usado por @ref{47c,,run()}. (Contribuição de Andrew Svetlov em gh-91218@footnote{https://github.com/python/cpython/issues/91218}.)

@item 
Adicionada a classe @ref{601,,Barrier} às primitivas de sincronização na biblioteca asyncio, e a exceção @ref{602,,BrokenBarrierError} relacionada. (Contribuição de Yves Duprat e Andrew Svetlov em gh-87518@footnote{https://github.com/python/cpython/issues/87518}.)

@item 
Adicionado o argumento nomeado `all_errors' para @ref{603,,asyncio.loop.create_connection()} para que vários erros de conexão possam ser levantados como @ref{1b6,,ExceptionGroup}.

@item 
Adicionado o método @ref{604,,asyncio.StreamWriter.start_tls()} para atualizar conexões baseadas em fluxo existentes para TLS. (Contribuição de Ian Good em bpo-34975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34975}.)

@item 
Adicionadas funções de soquete de datagrama `raw' ao laço de eventos: @ref{605,,sock_sendto()}, @ref{606,,sock_recvfrom()} e @ref{607,,sock_recvfrom_into()}. Eles têm implementações em @ref{608,,SelectorEventLoop} e @ref{609,,ProactorEventLoop}. (Contribuição de Alex Grönholm em bpo-46805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46805}.)

@item 
Adicionados os métodos @ref{1ba,,cancelling()} e @ref{1bb,,uncancel()} a @ref{1be,,Task}. Estes são destinados principalmente para uso interno, notadamente por @ref{1b5,,TaskGroup}.
@end itemize

@node contextlib,dataclasses,asyncio<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 contextlib}@anchor{60a}@anchor{whatsnew/3 11 whatsnew311-contextlib}@anchor{60b}
@subsubsection contextlib



@itemize *

@item 
Adicionado gerenciador de contexto não paralelo seguro @ref{60c,,chdir()} para alterar o diretório de trabalho atual e depois restaurá-lo na saída. Wrapper simples em torno de @ref{60d,,chdir()}. (Contribuição de Filipe Laíns em bpo-25625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25625})
@end itemize

@node dataclasses,datetime,contextlib,Módulos melhorados<3>
@anchor{whatsnew/3 11 dataclasses}@anchor{60e}@anchor{whatsnew/3 11 whatsnew311-dataclasses}@anchor{60f}
@subsubsection dataclasses



@itemize *

@item 
Alterar a verificação de mutabilidade padrão do campo, permitindo apenas padrões que são @ref{610,,hasheáveis} em vez de qualquer objeto que não seja uma instância de @ref{256,,dict}, @ref{611,,list} ou @ref{5d9,,set}. (Contribuição de Eric V. Smith em bpo-44674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44674}.)
@end itemize

@node datetime,enum<3>,dataclasses,Módulos melhorados<3>
@anchor{whatsnew/3 11 datetime}@anchor{612}@anchor{whatsnew/3 11 whatsnew311-datetime}@anchor{613}
@subsubsection datetime



@itemize *

@item 
Adicione @ref{4ee,,datetime.UTC}, um apelido de conveniência para @ref{614,,datetime.timezone.utc}. (Contribuição de Kabir Kwatra em gh-91973@footnote{https://github.com/python/cpython/issues/91973}.)

@item 
@ref{615,,datetime.date.fromisoformat()}, @ref{616,,datetime.time.fromisoformat()} e @ref{617,,datetime.datetime.fromisoformat()} agora podem ser usados para analisar a maioria dos formatos ISO 8601 (exceto aqueles que têm suporte a horas fracionárias e minutos). (Contribuição de Paul Ganssle em gh-80010@footnote{https://github.com/python/cpython/issues/80010}.)
@end itemize

@node enum<3>,fcntl,datetime,Módulos melhorados<3>
@anchor{whatsnew/3 11 enum}@anchor{618}@anchor{whatsnew/3 11 whatsnew311-enum}@anchor{619}
@subsubsection enum



@itemize *

@item 
Renomeado @code{EnumMeta} para @ref{1e5,,EnumType} (@code{EnumMeta} mantido como um apelido).

@item 
Adicionada @ref{61a,,StrEnum}, com membros que podem ser usados como (e devem ser) strings.

@item 
Adicionada @ref{61b,,ReprEnum}, que apenas modifica o @ref{61c,,__repr__()} dos membros enquanto retorna seus valores literais (ao invés de nomes) para @ref{61d,,__str__()} e @ref{61e,,__format__()} (usado por @ref{44c,,str()}, @ref{61f,,format()} e @ref{436,,f-string}s).

@item 
Alterado @ref{620,,Enum.__format__()} (o padrão para @ref{61f,,format()}, @ref{621,,str.format()} e @ref{436,,f-string}s) para sempre produz o mesmo resultado que @ref{622,,Enum.__str__()}: para enums herdados de @ref{61b,,ReprEnum} será o valor do membro; para todos os outros enums, será o enum e o nome do membro (por exemplo, @code{Color.RED}).

@item 
Adicionado um novo parâmetro de classe `boundary' para enums @ref{623,,Flag} e @ref{624,,FlagBoundary} com suas opções, para controlar como lidar com valores de sinalizadores fora do intervalo.

@item 
Adicionado o decorador de enum @ref{625,,verify()} e o enum @ref{626,,EnumCheck} com suas opções, para verificar classes de enum em relação a várias restrições específicas.

@item 
Adicionados os decoradores @ref{627,,member()} e @ref{628,,nonmember()}, para garantir que o objeto decorado seja/não seja convertido em um membro enum.

@item 
Adicionado o decorador @ref{629,,property()}, que funciona como @ref{194,,property()} exceto para enums. Use isso em vez de @ref{62a,,types.DynamicClassAttribute()}.

@item 
Adicionado o decorador enum @ref{62b,,global_enum()}, que ajusta @ref{61c,,__repr__()} e @ref{61d,,__str__()} para mostrar valores como membros de seu módulo em vez da classe enum. Por exemplo, @code{'re.ASCII'} para o membro @ref{62c,,ASCII} de @ref{62d,,re.RegexFlag} em vez de @code{'RegexFlag.ASCII'}.

@item 
Aprimorada @ref{623,,Flag} para ter suporte a @ref{62e,,len()}, iteração e @ref{2f4,,in}/@ref{62f,,not in} em seus membros. Por exemplo, o seguinte agora funciona: @code{len(AFlag(3)) == 2 and list(AFlag(3)) == (AFlag.ONE, AFlag.TWO)}

@item 
Alterada @ref{630,,Enum} e @ref{623,,Flag} para que os membros sejam agora definidos antes de @ref{631,,__init_subclass__()} ser chamado; @ref{632,,dir()} agora inclui métodos, etc., de tipos de dados mistos.

@item 
Alterada @ref{623,,Flag} para considerar apenas valores primários (potência de dois) canônicos enquanto valores compostos (@code{3}, @code{6}, @code{10}, etc.) são considerados apelidos; bandeiras invertidas são coagidas ao seu equivalente positivo.
@end itemize

@node fcntl,fractions<3>,enum<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 fcntl}@anchor{633}@anchor{whatsnew/3 11 whatsnew311-fcntl}@anchor{634}
@subsubsection fcntl



@itemize *

@item 
No FreeBSD, os sinalizadores @code{F_DUP2FD} e @code{F_DUP2FD_CLOEXEC} respectivamente são suportados, o primeiro é igual ao uso de @code{dup2} enquanto o último define o sinalizador @code{FD_CLOEXEC} adicionalmente.
@end itemize

@node fractions<3>,functools,fcntl,Módulos melhorados<3>
@anchor{whatsnew/3 11 fractions}@anchor{635}@anchor{whatsnew/3 11 whatsnew311-fractions}@anchor{636}
@subsubsection fractions



@itemize *

@item 
Suporte à inicialização no estilo 
@geindex Propostas de Melhorias do Python; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} de @ref{1e7,,Fraction} da string. (Contribuição de Sergey B Kirpichev em bpo-44258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44258}.)

@item 
@ref{1e7,,Fraction} agora implementa um método @code{__int__}, para que uma verificação de @code{isinstance(some_fraction, typing.SupportsInt)} seja aprovada. (Contribuição de Mark Dickinson em bpo-44547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44547}.)
@end itemize

@node functools,gzip<2>,fractions<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 functools}@anchor{637}@anchor{whatsnew/3 11 whatsnew311-functools}@anchor{638}
@subsubsection functools



@itemize *

@item 
@ref{639,,functools.singledispatch()} agora suporta @ref{63a,,types.UnionType} e @ref{63b,,typing.Union} como anotações para o argumento de dispatch.:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verboso=False):
...     if verboso:
...         print("Deixe-me apenas dizer,", end=" ")
...     print(arg)
...
>>> @@fun.register
... def _(arg: int | float, verboso=False):
...     if verboso:
...         print("Força nos números, não é?", end=" ")
...     print(arg)
...
>>> from typing import Union
>>> @@fun.register
... def _(arg: Union[list, set], verbose=False):
...     if verboso:
...         print("Enumere isso:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
...
@end example

(Contribuição de Yurii Karabas na bpo-46014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46014}.)
@end itemize

@node gzip<2>,hashlib<2>,functools,Módulos melhorados<3>
@anchor{whatsnew/3 11 gzip}@anchor{63c}@anchor{whatsnew/3 11 whatsnew311-gzip}@anchor{63d}
@subsubsection gzip



@itemize *

@item 
A função @ref{63e,,gzip.compress()} agora é mais rápida quando usada com o argumento `mtime=0', pois delega a compactação inteiramente para uma única operação @ref{63f,,zlib.compress()}. Há um efeito colateral dessa mudança: o cabeçalho do arquivo gzip contém um byte de “OS” em seu cabeçalho. Tradicionalmente, isso sempre foi definido com um valor de 255 representando “desconhecido” pelo módulo @ref{67,,gzip}. Agora, ao usar @ref{63e,,compress()} com `mtime=0', ele pode ser definido com um valor diferente pela biblioteca zlib C subjacente à qual o Python estava vinculado. (Veja gh-112346@footnote{https://github.com/python/cpython/issues/112346} para detalhes sobre o efeito colateral.)
@end itemize

@node hashlib<2>,IDLE e idlelib,gzip<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 hashlib}@anchor{640}@anchor{whatsnew/3 11 whatsnew311-hashlib}@anchor{641}
@subsubsection hashlib



@itemize *

@item 
@ref{642,,hashlib.blake2b()} e @ref{643,,hashlib.blake2s()} agora preferem libb2@footnote{https://www.blake2.net/} em vez da cópia do Python. (Contribuição de Christian Heimes em bpo-47095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47095}.)

@item 
O módulo interno @code{_sha3} com algoritmos SHA3 e SHAKE agora usa `tiny_sha3' em vez do `Keccak Code Package' para reduzir o código e o tamanho binário. O módulo @ref{68,,hashlib} prefere implementações otimizadas de SHA3 e SHAKE do OpenSSL. A alteração afeta apenas instalações sem suporte a OpenSSL. (Contribuição de Christian Heimes em bpo-47098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47098}.)

@item 
Adiciona @ref{644,,hashlib.file_digest()}, uma função auxiliar para hash eficiente de objetos arquivo ou similar. (Contribuição de Christian Heimes em gh-89313@footnote{https://github.com/python/cpython/issues/89313}.)
@end itemize

@node IDLE e idlelib,inspect<2>,hashlib<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 idle-and-idlelib}@anchor{645}@anchor{whatsnew/3 11 whatsnew311-idle}@anchor{646}
@subsubsection IDLE e idlelib



@itemize *

@item 
Aplica realce de sintaxe em arquivos @code{.pyi}. (Contribuição de Alex Waygood e Terry Jan Reedy em bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}.)

@item 
Inclui prompts ao salvar o console com entradas e saídas. (Contribuição de Terry Jan Reedy em gh-95191@footnote{https://github.com/python/cpython/issues/95191}.)
@end itemize

@node inspect<2>,locale<3>,IDLE e idlelib,Módulos melhorados<3>
@anchor{whatsnew/3 11 inspect}@anchor{647}@anchor{whatsnew/3 11 whatsnew311-inspect}@anchor{648}
@subsubsection inspect



@itemize *

@item 
Adiciona @ref{649,,getmembers_static()} para retornar todos os membros sem acionar a pesquisa dinâmica por meio do protocolo descritor. (Contribuição de Weipeng Hong em bpo-30533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30533}.)

@item 
Adiciona @ref{64a,,ismethodwrapper()} para verificar se o tipo de um objeto é um @ref{64b,,MethodWrapperType}. (Contribuição de Hakan Çelik em bpo-29418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29418}.)

@item 
Altera as funções relacionadas a quadros no módulo @ref{7e,,inspect} para retornar novas instâncias de classe @ref{64c,,FrameInfo} e @ref{64d,,Traceback} (compatíveis com as anteriores interfaces do tipo @ref{64e,,tupla nomeada}) que inclui as informações de posição estendidas 
@geindex Propostas de Melhorias do Python; PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} (número da linha final, coluna e coluna final). As funções afetadas são:


@itemize *

@item 
@ref{64f,,inspect.getframeinfo()}

@item 
@ref{650,,inspect.getouterframes()}

@item 
@ref{651,,inspect.getinnerframes()},

@item 
@ref{652,,inspect.stack()}

@item 
@ref{653,,inspect.trace()}
@end itemize

(Contribuição por Pablo Galindo em gh-88116@footnote{https://github.com/python/cpython/issues/88116}.)
@end itemize

@node locale<3>,logging,inspect<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 locale}@anchor{654}@anchor{whatsnew/3 11 whatsnew311-locale}@anchor{655}
@subsubsection locale



@itemize *

@item 
Adiciona @ref{2dc,,locale.getencoding()} para obter a codificação local atual. É semelhante a @code{locale.getpreferredencoding(False)}, mas ignora o @ref{656,,Modo UTF-8 do Python}.
@end itemize

@node logging,math<3>,locale<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 logging}@anchor{657}@anchor{whatsnew/3 11 whatsnew311-logging}@anchor{658}
@subsubsection logging



@itemize *

@item 
Adicionada @ref{659,,getLevelNamesMapping()} para retornar um mapeamento de nomes de nível de registro (por exemplo, @code{'CRITICAL'}) para os valores de seus @ref{65a,,Níveis de Logging} correspondentes (por exemplo, @code{50}, por padrão ). (Contribuição de Andrei Kulakovin em gh-88024@footnote{https://github.com/python/cpython/issues/88024}.)

@item 
Adicionado um método @ref{65b,,createSocket()} a @ref{65c,,SysLogHandler}, para corresponder a @ref{65d,,SocketHandler.createSocket()} . Ele é chamado automaticamente durante a inicialização do manipulador e ao emitir um evento, se não houver nenhum soquete ativo. (Contribuição de Kirill Pinchuk em gh-88457@footnote{https://github.com/python/cpython/issues/88457}.)
@end itemize

@node math<3>,operador,logging,Módulos melhorados<3>
@anchor{whatsnew/3 11 math}@anchor{65e}@anchor{whatsnew/3 11 whatsnew311-math}@anchor{65f}
@subsubsection math



@itemize *

@item 
Adiciona @ref{660,,math.exp2()}: retorna 2 elevado à potência de x. (Contribuição de Gideon Mitchell em bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917}.)

@item 
Adiciona @ref{661,,math.cbrt()}: retorna a raiz cúbica de x. (Contribuição de Ajith Ramachandran em bpo-44357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44357}.)

@item 
O comportamento de dois casos excepcionais @ref{662,,math.pow()} foi alterado, para consistência com a especificação IEEE 754. As operações @code{math.pow(0.0, -math.inf)} e @code{math.pow(-0.0, -math.inf)} agora retornam @code{inf}. Anteriormente eles levantavam @ref{202,,ValueError}. (Contribuição de Mark Dickinson em bpo-44339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44339}.)

@item 
O valor @ref{663,,math.nan} agora está sempre disponível. (Contribuição de Victor Stinner em bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}.)
@end itemize

@node operador,os<3>,math<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 operator}@anchor{664}@anchor{whatsnew/3 11 whatsnew311-operator}@anchor{665}
@subsubsection operador



@itemize *

@item 
Uma nova função @code{operator.call} foi adicionada, tal que @code{operator.call(obj, *args, **kwargs) == obj(*args, **kwargs)} (Contribuição de Antony Lee em bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}.)
@end itemize

@node os<3>,pathlib<4>,operador,Módulos melhorados<3>
@anchor{whatsnew/3 11 os}@anchor{666}@anchor{whatsnew/3 11 whatsnew311-os}@anchor{667}
@subsubsection os



@itemize *

@item 
No Windows, @ref{523,,os.urandom()} agora usa @code{BCryptGenRandom()}, em vez de @code{CryptGenRandom()} que foi descontinuado. (Contribuição de Dong-hee Na em bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611}.)
@end itemize

@node pathlib<4>,re<3>,os<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 pathlib}@anchor{668}@anchor{whatsnew/3 11 whatsnew311-pathlib}@anchor{669}
@subsubsection pathlib



@itemize *

@item 
@ref{22d,,glob()} e @ref{22e,,rglob()} retornam apenas diretórios se `pattern' terminar com um separador de componentes de nome de caminho: @ref{66a,,sep} ou @ref{66b,,altsep}. (Contribuição de Eisuke Kawasima em bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276} e bpo-33392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33392}.)
@end itemize

@node re<3>,shutil<3>,pathlib<4>,Módulos melhorados<3>
@anchor{whatsnew/3 11 re}@anchor{66c}@anchor{whatsnew/3 11 whatsnew311-re}@anchor{66d}
@subsubsection re



@itemize *

@item 
Agrupamento atômico (@code{(?>...)}) e quantificadores possessivos (@code{*+}, @code{++}, @code{?+}, @code{@{m,n@}+} ) agora são suportados em expressões regulares. (Contribuição de Jeffrey C. Jacobs e Serhiy Storchaka em bpo-433030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433030}.)
@end itemize

@node shutil<3>,socket,re<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 shutil}@anchor{66e}@anchor{whatsnew/3 11 whatsnew311-shutil}@anchor{66f}
@subsubsection shutil



@itemize *

@item 
Adicione o parâmetro opcional `dir_fd' em @ref{301,,shutil.rmtree()}. (Contribuição de Serhiy Storchaka em bpo-46245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46245}.)
@end itemize

@node socket,sqlite3<4>,shutil<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 socket}@anchor{670}@anchor{whatsnew/3 11 whatsnew311-socket}@anchor{671}
@subsubsection socket



@itemize *

@item 
Adiciona suporte ao soquete CAN para NetBSD. (Contribuição de Thomas Klausner em bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512}.)

@item 
@ref{672,,create_connection()} tem a opção de levantar, em caso de falha na conexão, um @ref{1b6,,ExceptionGroup} contendo todos os erros ao invés de somente levantar o último erro. (Contribuição de Irit Katriel em bpo-29980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29980}.)
@end itemize

@node sqlite3<4>,string,socket,Módulos melhorados<3>
@anchor{whatsnew/3 11 sqlite3}@anchor{673}@anchor{whatsnew/3 11 whatsnew311-sqlite3}@anchor{674}
@subsubsection sqlite3



@itemize *

@item 
Agora você pode desabilitar o autorizador passando @ref{675,,None} para @ref{2ab,,set_authorizer()}. (Contribuição de Erlend E. Aasland em bpo-44491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44491}.)

@item 
O nome do agrupamento @ref{676,,create_collation()} agora pode conter qualquer caractere Unicode. Nomes de agrupamento com caracteres inválidos agora levantar @ref{677,,UnicodeEncodeError} em vez de @ref{4f2,,sqlite3.ProgrammingError}. (Contribuição de Erlend E. Aasland em bpo-44688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44688}.)

@item 
As exceções @ref{cf,,sqlite3} agora incluem o código de erro estendido SQLite como @ref{678,,sqlite_errorcode} e o nome do erro SQLite como @ref{679,,sqlite_errorname}. (Contribuição de Aviv Palivoda, Daniel Shahaf e Erlend E. Aasland em bpo-16379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16379} e bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139}.)

@item 
Adiciona @ref{67a,,setlimit()} e @ref{67b,,getlimit()} a @ref{245,,sqlite3.Connection} para definir e obter limites SQLite por base de conexão. (Contribuição de Erlend E. Aasland em bpo-45243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45243}.)

@item 
@ref{cf,,sqlite3} agora define @ref{67c,,sqlite3.threadsafety} com base no modo de threading padrão com o qual a biblioteca SQLite subjacente foi compilada. (Contribuição de Erlend E. Aasland em bpo-45613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45613}.)

@item 
O retorno de chamadas C @ref{cf,,sqlite3} agora usam exceções que não podem ser levantadas se os rastreamentos de retorno de chamada estiverem habilitados. Os usuários agora podem registrar um @ref{1f7,,unraisable hook handler} para melhorar sua experiência de depuração. (Contribuição de Erlend E. Aasland em bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}.)

@item 
A busca por rollback não levanta mais @ref{67d,,InterfaceError}. Em vez disso, deixamos para a biblioteca SQLite lidar com esses casos. (Contribuição de Erlend E. Aasland em bpo-44092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44092}.)

@item 
Adiciona @ref{67e,,serialize()} e @ref{67f,,deserialize()} a @ref{245,,sqlite3.Connection} para serializar e desserializar bancos de dados. (Contribuição de Erlend E. Aasland em bpo-41930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41930}.)

@item 
Adiciona @ref{680,,create_window_function()} a @ref{245,,sqlite3.Connection} para criar funções de janela agregadas. (Contribuição de Erlend E. Aasland em bpo-34916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34916}.)

@item 
Adiciona @ref{681,,blobopen()} a @ref{245,,sqlite3.Connection}. @ref{682,,sqlite3.Blob} permite operações de E/S incrementais em blobs. (Contribuição de Aviv Palivoda e Erlend E. Aasland em bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905}.)
@end itemize

@node string,sys<4>,sqlite3<4>,Módulos melhorados<3>
@anchor{whatsnew/3 11 string}@anchor{683}@anchor{whatsnew/3 11 whatsnew311-string}@anchor{684}
@subsubsection string



@itemize *

@item 
Adiciona @ref{685,,get_identifiers()} e @ref{686,,is_valid()} a @ref{687,,string.Template}, que respectivamente retornam todos os marcadores de posição válidos e se quaisquer marcadores de posição inválidos estão presentes. (Contribuição de Ben Kehoe em gh-90465@footnote{https://github.com/python/cpython/issues/90465}.)
@end itemize

@node sys<4>,sysconfig,string,Módulos melhorados<3>
@anchor{whatsnew/3 11 sys}@anchor{688}@anchor{whatsnew/3 11 whatsnew311-sys}@anchor{689}
@subsubsection sys



@itemize *

@item 
@ref{68a,,sys.exc_info()} agora deriva os campos @code{type} e @code{traceback} do @code{value} (a instância de exceção) de forma que quanto uma exceção é modificada enquanto está sendo tratada, são refletidos nos resultados de chamadas subsequentes para @code{exc_info()}. (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
Adiciona @ref{68b,,sys.exception()} que retorna a instância de exceção ativa (equivalente a @code{sys.exc_info()[1]}). (Contribuição de Irit Katriel em bpo-46328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46328}.)

@item 
Adiciona o sinalizador @ref{68c,,sys.flags.safe_path}. (Contribuição de Victor Stinner em gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)
@end itemize

@node sysconfig,tempfile<3>,sys<4>,Módulos melhorados<3>
@anchor{whatsnew/3 11 sysconfig}@anchor{68d}@anchor{whatsnew/3 11 whatsnew311-sysconfig}@anchor{68e}
@subsubsection sysconfig



@itemize *

@item 
Três novos @ref{68f,,esquemas de instalação} (`posix_venv', `nt_venv' e `venv') foram adicionados e são usados quando o Python cria novos ambientes virtuais ou quando está sendo executado a partir de um ambiente virtual. Os dois primeiros esquemas (`posix_venv' e `nt_venv') são específicos do SO para não Windows e Windows, o `venv' é essencialmente um apelido para um deles de acordo com o SO em que o Python é executado. Isso é útil para distribuidores downstream que modificam @ref{690,,sysconfig.get_preferred_scheme()}. O código de terceiros que cria novos ambientes virtuais deve usar o novo esquema de instalação `venv' para determinar os caminhos, assim como @ref{111,,venv}. (Contribuição de Miro Hrončok em bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}.)
@end itemize

@node tempfile<3>,threading<2>,sysconfig,Módulos melhorados<3>
@anchor{whatsnew/3 11 tempfile}@anchor{691}@anchor{whatsnew/3 11 whatsnew311-tempfile}@anchor{692}
@subsubsection tempfile



@itemize *

@item 
Objetos @ref{693,,SpooledTemporaryFile} agora implementam totalmente os métodos de @ref{694,,io.BufferedIOBase} ou @ref{695,,io.TextIOBase} (dependendo do modo de arquivo). Isso permite que eles funcionem corretamente com APIs que esperam objetos arquivo ou similares, como módulos de compactação. (Contribuição de Carey Metcalfe em gh-70363@footnote{https://github.com/python/cpython/issues/70363}.)
@end itemize

@node threading<2>,time<2>,tempfile<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 threading}@anchor{696}@anchor{whatsnew/3 11 whatsnew311-threading}@anchor{697}
@subsubsection threading



@itemize *

@item 
No Unix, se a função @code{sem_clockwait()} estiver disponível na biblioteca C (glibc 2.30 e mais recente), o método @ref{698,,threading.Lock.acquire()} agora usa o relógio monotônico (@ref{699,,time.CLOCK_MONOTONIC}) para o tempo limite, em vez de usar o relógio do sistema (@ref{69a,,time.CLOCK_REALTIME}), para não ser afetado pelas alterações do relógio do sistema. (Contribuição de Victor Stinner em bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}.)
@end itemize

@node time<2>,tkinter<3>,threading<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 time}@anchor{69b}@anchor{whatsnew/3 11 whatsnew311-time}@anchor{69c}
@subsubsection time



@itemize *

@item 
No Unix, @ref{69d,,time.sleep()} agora usa a função @code{clock_nanosleep()} ou @code{nanosleep()}, se disponível, que tem uma resolução de 1 nanossegundo (10@w{^-9} segundos), em vez de usar @code{select()} que tem uma resolução de 1 microssegundo (10@w{^-6} segundos). (Contribuição de Benjamin Szőke e Victor Stinner em bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}.)

@item 
No Windows 8.1 e mais recente, @ref{69d,,time.sleep()} agora usa um temporizador aguardável baseado em temporizadores de alta resolução@footnote{https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/high-resolution-timers} que tem uma resolução de 100 nanossegundos (10@w{^-7} segundos). Anteriormente, tinha uma resolução de 1 milissegundo (10@w{^-3} segundos). (Contribuição de Benjamin Szőke, Donghee Na, Eryk Sun e Victor Stinner em bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302} e bpo-45429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45429}.)
@end itemize

@node tkinter<3>,traceback<2>,time<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 tkinter}@anchor{69e}@anchor{whatsnew/3 11 whatsnew311-tkinter}@anchor{69f}
@subsubsection tkinter



@itemize *

@item 
Adicionado o método @code{info_patchlevel()} que retorna a versão exata da biblioteca Tcl como uma tupla nomeada semelhante a @ref{6a0,,sys.version_info}. (Contribuição de Serhiy Storchaka em gh-91827@footnote{https://github.com/python/cpython/issues/91827}.)
@end itemize

@node traceback<2>,typing<4>,tkinter<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 traceback}@anchor{6a1}@anchor{whatsnew/3 11 whatsnew311-traceback}@anchor{6a2}
@subsubsection traceback



@itemize *

@item 
Adiciona @ref{6a3,,traceback.StackSummary.format_frame_summary()} para permitir que os usuários substituam quais quadros aparecem no traceback e como eles são formatados. (Contribuição de Ammar Askar em bpo-44569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44569}.)

@item 
Adiciona @ref{6a4,,traceback.TracebackException.print()}, que imprime a instância formatada @ref{25c,,TracebackException} em um arquivo. (Contribuição de Irit Katriel em bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809}.)
@end itemize

@node typing<4>,unicodedata<3>,traceback<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 typing}@anchor{6a5}@anchor{whatsnew/3 11 whatsnew311-typing}@anchor{6a6}
@subsubsection typing


Para alterações principais, veja @ref{5bf,,Novos recursos relacionados a dicas de tipo}.


@itemize *

@item 
Adiciona @ref{6a7,,typing.assert_never()} e @ref{6a8,,typing.Never}. @ref{6a7,,typing.assert_never()} é útil para pedir a um verificador de tipo para confirmar que uma linha de código não está acessível. Em tempo de execução, ele levanta uma exceção @ref{6a9,,AssertionError}. (Contribuição de Jelle Zijlstra em gh-90633@footnote{https://github.com/python/cpython/issues/90633}.)

@item 
Adiciona @ref{6aa,,typing.reveal_type()}. Isso é útil para perguntar a um verificador de tipo qual tipo ele inferiu para uma determinada expressão. Em tempo de execução imprime o tipo do valor recebido. (Contribuição de Jelle Zijlstra em gh-90572@footnote{https://github.com/python/cpython/issues/90572}.)

@item 
Adicione @ref{6ab,,typing.assert_type()}. Isso é útil para solicitar a um verificador de tipos que confirme se o tipo que ele inferiu para uma determinada expressão corresponde ao tipo fornecido. Em tempo de execução ele simplesmente retorna o valor recebido. (Contribuição de Jelle Zijlstra em gh-90638@footnote{https://github.com/python/cpython/issues/90638}.)

@item 
Os tipos @ref{162,,typing.TypedDict} agora podem ser genéricos. (Contribuição de Samodya Abeysiriwardane em gh-89026@footnote{https://github.com/python/cpython/issues/89026}.)

@item 
Os tipos @ref{2b0,,NamedTuple} agora podem ser genéricos. (Contribuição de Serhiy Storchaka em bpo-43923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43923}.)

@item 
Permite criar subclasse de @ref{6ac,,typing.Any}. Isso é útil para evitar erros de verificador de tipo relacionados a classes altamente dinâmicas, como mocks. (Contribuição de Shantanu Jain em gh-91154@footnote{https://github.com/python/cpython/issues/91154}.)

@item 
O decorador @ref{6ad,,typing.final()} agora define o @code{__final__} atribuído no objeto decorado. (Contribuição de Jelle Zijlstra em gh-90500@footnote{https://github.com/python/cpython/issues/90500}.)

@item 
A função @ref{6ae,,typing.get_overloads()} pode ser usada para introspecção das sobrecargas de uma função. @ref{6af,,typing.clear_overloads()} pode ser usado para limpar todas as sobrecargas registradas de uma função. (Contribuição de Jelle Zijlstra em gh-89263@footnote{https://github.com/python/cpython/issues/89263}.)

@item 
O método @ref{6b0,,__init__()} das subclasses @ref{264,,Protocol} agora é preservado. (Contribuição de Adrian Garcia Badarasco em gh-88970@footnote{https://github.com/python/cpython/issues/88970}.)

@item 
A representação de tipos de tupla vazias (@code{Tuple[()]}) está simplificada. Isso afeta a introspecção, por exemplo. @code{get_args(Tuple[()])} agora é avaliado como @code{()} em vez de @code{((),)}. (Contribuição de Serhiy Storchaka em gh-91137@footnote{https://github.com/python/cpython/issues/91137}.)

@item 
Afrouxa os requisitos de tempo de execução para anotações de tipo removendo a verificação chamável na função privada @code{typing._type_check}. (Contribuição de Gregory Beauregard em gh-90802@footnote{https://github.com/python/cpython/issues/90802}.)

@item 
@ref{6b1,,typing.get_type_hints()} agora tem suporte à avaliação de strings como referências diretas em @ref{6b2,,apelidos genéricos da PEP 585}. (Contribuição de Niklas Rosenstein em gh-85542@footnote{https://github.com/python/cpython/issues/85542}.)

@item 
@ref{6b1,,typing.get_type_hints()} não adiciona mais @ref{6b3,,Optional} aos parâmetros com @code{None} como padrão. (Contribuição de Nikita Sobolev em gh-90353@footnote{https://github.com/python/cpython/issues/90353}.)

@item 
@ref{6b1,,typing.get_type_hints()} agora tem suporte à avaliação de anotações @ref{266,,ClassVar} de strings simples. (Contribuição de Gregory Beauregard em gh-90711@footnote{https://github.com/python/cpython/issues/90711}.)

@item 
@ref{6b4,,typing.no_type_check()} não modifica mais classes e funções externas. Agora também marca corretamente os métodos de classe para não serem verificados quanto ao tipo. (Contribuição de Nikita Sobolev em gh-90729@footnote{https://github.com/python/cpython/issues/90729}.)
@end itemize

@node unicodedata<3>,unittest<4>,typing<4>,Módulos melhorados<3>
@anchor{whatsnew/3 11 unicodedata}@anchor{6b5}@anchor{whatsnew/3 11 whatsnew311-unicodedata}@anchor{6b6}
@subsubsection unicodedata



@itemize *

@item 
O banco de dados Unicode foi atualizado para a versão 14.0.0. (Contribuição de Benjamin Peterson em bpo-45190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45190}).
@end itemize

@node unittest<4>,venv<2>,unicodedata<3>,Módulos melhorados<3>
@anchor{whatsnew/3 11 unittest}@anchor{6b7}@anchor{whatsnew/3 11 whatsnew311-unittest}@anchor{6b8}
@subsubsection unittest



@itemize *

@item 
Adicionados os métodos @ref{6b9,,enterContext()} e @ref{6ba,,enterClassContext()} da classe @ref{44f,,TestCase}, método @ref{6bb,,enterAsyncContext()} da classe @ref{30c,,IsolatedAsyncioTestCase} e a função @ref{6bc,,unittest.enterModuleContext()}. (Contribuição de Serhiy Storchaka em bpo-45046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45046}.)
@end itemize

@node venv<2>,avisos<2>,unittest<4>,Módulos melhorados<3>
@anchor{whatsnew/3 11 venv}@anchor{6bd}@anchor{whatsnew/3 11 whatsnew311-venv}@anchor{6be}
@subsubsection venv



@itemize *

@item 
Quando novos ambientes virtuais Python são criados, o @ref{68f,,esquema de instalação do sysconfig} do `venv' é usado para determinar os caminhos dentro do ambiente. Quando o Python é executado em um ambiente virtual, o mesmo esquema de instalação é o padrão. Isso significa que os distribuidores downstream podem alterar o esquema de instalação padrão do sysconfig sem alterar o comportamento dos ambientes virtuais. O código de terceiros que também cria novos ambientes virtuais deve fazer o mesmo. (Contribuição de Miro Hrončok em bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}.)
@end itemize

@node avisos<2>,zipfile,venv<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 warnings}@anchor{6bf}@anchor{whatsnew/3 11 whatsnew311-warnings}@anchor{6c0}
@subsubsection avisos



@itemize *

@item 
@ref{584,,warnings.catch_warnings()} agora aceita argumentos para @ref{6c1,,warnings.simplefilter()}, fornecendo uma maneira mais concisa de ignorar localmente avisos ou convertê-los em erros. (Contribuição de Zac Hatfield-Dodds em bpo-47074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47074}.)
@end itemize

@node zipfile,,avisos<2>,Módulos melhorados<3>
@anchor{whatsnew/3 11 whatsnew311-zipfile}@anchor{6c2}@anchor{whatsnew/3 11 zipfile}@anchor{6c3}
@subsubsection zipfile



@itemize *

@item 
Adicionado suporte para especificar a codificação de nome de membro para leitura de metadados em um diretório @ref{6c4,,ZipFile} e cabeçalhos de arquivo. (Contribuição de Stephen J. Turnbull e Serhiy Storchaka em bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080}.)

@item 
Adicionado @ref{6c5,,ZipFile.mkdir()} para criar novos diretórios dentro de arquivos ZIP. (Contribuição de Sam Ezeh em gh-49083@footnote{https://github.com/python/cpython/issues/49083}.)

@item 
Adicionado @ref{6c6,,stem}, @ref{6c7,,suffix} e @ref{6c8,,suffixes} a @ref{6c9,,zipfile.Path}. (Contribuição de Miguel Brito em gh-88261@footnote{https://github.com/python/cpython/issues/88261}.)
@end itemize

@node Otimizações<3>,CPython mais rápido,Módulos melhorados<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 optimizations}@anchor{6ca}@anchor{whatsnew/3 11 whatsnew311-optimizations}@anchor{6cb}
@subsection Otimizações


Esta seção cobre otimizações específicas independentes do projeto @ref{5a0,,CPython mais rápido}, que é abordado em sua própria seção.


@itemize *

@item 
O compilador agora otimiza a @ref{6cc,,formatação simples de % no estilo printf} em literais de string contendo apenas os códigos de formato @code{%s}, @code{%r} e @code{%a} e a torna tão rápida quanto uma expressão @ref{436,,f-string} correspondente. (Contribuição de Serhiy Storchaka em bpo-28307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28307}.)

@item 
A divisão inteira (@code{//}) é melhor ajustada para otimização por compiladores. Agora é cerca de 20% mais rápido em x86-64 ao dividir um @ref{257,,int} por um valor menor que @code{2**30}. (Contribuição de Gregory P. Smith e Tim Peters em gh-90564@footnote{https://github.com/python/cpython/issues/90564}.)

@item 
@ref{46a,,sum()} agora é quase 30% mais rápida para inteiros menores que @code{2**30}. (Contribuição de Stefan Behnel em gh-68264@footnote{https://github.com/python/cpython/issues/68264}.)

@item 
O redimensionamento de listas é simplificado para o caso comum, acelerando @ref{6cd,,list.append()} em ≈15% e @ref{6ce,,compreensões de lista} em até 20-30% (Contribuição de Dennis Sweeney em gh-91165@footnote{https://github.com/python/cpython/issues/91165}.)

@item 
Dicionários não armazenam valores de hash quando todas as chaves são objetos Unicode, diminuindo o tamanho de @ref{256,,dict}. Por exemplo, @code{sys.getsizeof(dict.fromkeys("abcdefg"))} foi reduzido de 352 bytes para 272 bytes (23% menor) em plataformas de 64 bits. (Contribuição de Inada Naoki em bpo-46845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46845}.)

@item 
Usar @ref{6cf,,asyncio.DatagramProtocol} agora é muito mais rápido ao transferir arquivos grandes por UDP, com velocidades mais de 100 vezes maiores para um arquivo de ≈60 MiB. (Contribuição de msoxzw em gh-91487@footnote{https://github.com/python/cpython/issues/91487}.)

@item 
As funções @ref{6d0,,comb()} e @ref{6d1,,perm()} de @ref{8e,,math} são agora ≈10 vezes mais rápidas para argumentos grandes (com uma aceleração maior para `k' maiores). (Contribuição de Serhiy Storchaka em bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}.)

@item 
As funções @ref{6d2,,mean()}, @ref{6d3,,variance()} e @ref{6d4,,stdev()} do @ref{d2,,statistics} agora consomem iteradores em uma passagem em vez de convertê-los em uma @ref{611,,list} primeiro. Isso é duas vezes mais rápido e pode economizar memória de forma substancial. (Contribuição de Raymond Hettinger em gh-90415@footnote{https://github.com/python/cpython/issues/90415}.)

@item 
@ref{6d5,,unicodedata.normalize()} agora normaliza strings de puro ASCII em tempo constante. (Contribuição de Dong-hee Na em bpo-44987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44987}.)
@end itemize

@node CPython mais rápido,Alterações de bytecode do CPython<3>,Otimizações<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 faster-cpython}@anchor{6d6}@anchor{whatsnew/3 11 whatsnew311-faster-cpython}@anchor{5a0}
@subsection CPython mais rápido


O CPython 3.11 é em média 25% mais rápido@footnote{https://github.com/faster-cpython/ideas#published-results} que o CPython 3.10 medido com o conjunto de ferramentas de benchmarks pyperformance@footnote{https://github.com/python/pyperformance}, quando compilado com GCC no Ubuntu Linux. Dependendo da sua carga de trabalho, a aceleração geral pode ser de 10 a 60%.

Este projeto se concentra em duas áreas principais em Python: @ref{6d7,,Inicialização mais rápida} e @ref{6d8,,Tempo de execução mais rápido}. Otimizações que não são abordadas neste projeto estão listadas em @ref{6cb,,Otimizações}.

@menu
* Inicialização mais rápida:: 
* Tempo de execução mais rápido:: 
* Diversos:: 
* FAQ:: 
* Sobre:: 

@end menu

@node Inicialização mais rápida,Tempo de execução mais rápido,,CPython mais rápido
@anchor{whatsnew/3 11 faster-startup}@anchor{6d9}@anchor{whatsnew/3 11 whatsnew311-faster-startup}@anchor{6d7}
@subsubsection Inicialização mais rápida


@menu
* Importações congeladas/objetos de código estático:: 

@end menu

@node Importações congeladas/objetos de código estático,,,Inicialização mais rápida
@anchor{whatsnew/3 11 frozen-imports-static-code-objects}@anchor{6da}@anchor{whatsnew/3 11 whatsnew311-faster-imports}@anchor{6db}
@subsubsection Importações congeladas/objetos de código estático


O Python armazena o @ref{187,,bytecode} no diretório @ref{6dc,,__pycache__} para acelerar o carregamento do módulo.

Anteriormente na versão 3.10, a execução do módulo Python era assim:

@example
Read __pycache__ -> Unmarshal -> Heap allocated code object -> Evaluate
@end example

No Python 3.11, os principais módulos essenciais para a inicialização do Python são “congelados”. Isso significa que seus @ref{5b5,,Objetos código} (e bytecode) são alocados estaticamente pelo interpretador. Isso reduz as etapas no processo de execução do módulo para isso:

@example
Statically allocated code object -> Evaluate
@end example

A inicialização do interpretador agora é 10-15% mais rápida no Python 3.11. Isso tem um grande impacto para programas de execução curta usando Python.

(Contribuição de Eric Snow, Guido van Rossum e Kumar Aditya em vários issues.)

@node Tempo de execução mais rápido,Diversos,Inicialização mais rápida,CPython mais rápido
@anchor{whatsnew/3 11 faster-runtime}@anchor{6dd}@anchor{whatsnew/3 11 whatsnew311-faster-runtime}@anchor{6d8}
@subsubsection Tempo de execução mais rápido


@menu
* Quadros Python menos custosos e mais preguiçosos:: 
* Chamadas de função Python em linha:: 
* PEP 659; Interpretador adaptativo especializado: PEP 659 Interpretador adaptativo especializado. 

@end menu

@node Quadros Python menos custosos e mais preguiçosos,Chamadas de função Python em linha,,Tempo de execução mais rápido
@anchor{whatsnew/3 11 cheaper-lazy-python-frames}@anchor{6de}@anchor{whatsnew/3 11 whatsnew311-lazy-python-frames}@anchor{6df}
@subsubsection Quadros Python menos custosos e mais preguiçosos


Os quadros do Python, contendo informações de execução, são criados sempre que o Python chama uma função do Python. A seguir estão as novas otimizações de quadro:


@itemize -

@item 
Simplificado o processo de criação do quadro.

@item 
Alocação de memória evitada reutilizando generosamente o espaço do quadro na pilha C.

@item 
Simplificada a estrutura interna do quadro para conter apenas as informações essenciais. Os quadros anteriormente continham informações extras de depuração e gerenciamento de memória.
@end itemize

Os antigos @ref{6e0,,objetos quadros} agora são criados apenas quando solicitados por depuradores ou por funções de introspecção do Python, como @ref{6e1,,sys._getframe()} e @ref{6e2,,inspect.currentframe()}. Para a maioria dos códigos de usuário, nenhum objeto quadro é criado. Como resultado, quase todas as chamadas de funções do Python aceleraram significativamente. Medimos uma aceleração de 3 a 7% no desempenho do py.

(Contribuição de Mark Shannon em bpo-44590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44590}.)
@anchor{whatsnew/3 11 inline-calls}@anchor{6e3}
@node Chamadas de função Python em linha,PEP 659 Interpretador adaptativo especializado,Quadros Python menos custosos e mais preguiçosos,Tempo de execução mais rápido
@anchor{whatsnew/3 11 inlined-python-function-calls}@anchor{6e4}@anchor{whatsnew/3 11 whatsnew311-inline-calls}@anchor{6e5}
@subsubsection Chamadas de função Python em linha


Durante a chamada de uma função Python, o Python chamará uma função C de avaliação para interpretar o código dessa função. Isso efetivamente limita a recursão Python pura ao que é seguro para a pilha C.

No 3.11, quando o CPython detecta o código Python chamando outra função Python, ele configura um novo quadro e “pula” para o novo código dentro do novo quadro. Isso evita chamar a função de interpretação C completamente.

A maioria das chamadas de função do Python agora não consome espaço de pilha C, acelerando-as. Em funções recursivas simples como fibonacci ou fatorial, observamos um aumento de velocidade de 1,7x. Isso também significa que as funções recursivas podem recursar significativamente mais profundamente (se o usuário aumentar o limite de recursão com @ref{4c3,,sys.setrecursionlimit()}). Medimos uma melhoria de 1 a 3% no desempenho do py.

(Contribuição de Pablo Galindo e Mark Shannon em bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256}.)

@node PEP 659 Interpretador adaptativo especializado,,Chamadas de função Python em linha,Tempo de execução mais rápido
@anchor{whatsnew/3 11 pep-659-specializing-adaptive-interpreter}@anchor{6e6}@anchor{whatsnew/3 11 whatsnew311-pep659}@anchor{17c}
@subsubsection PEP 659: Interpretador adaptativo especializado


@geindex Propostas de Melhorias do Python; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} é uma das partes principais do projeto Faster CPython. A ideia geral é que, embora o Python seja uma linguagem dinâmica, a maior parte do código possui regiões onde objetos e tipos raramente mudam. Este conceito é conhecido como `estabilidade de tipo'.

Em tempo de execução, o Python tentará procurar padrões comuns e estabilidade de tipo no código em execução. O Python substituirá a operação atual por uma mais especializada. Essa operação especializada usa caminhos rápidos disponíveis apenas para esses casos/tipos de uso, que geralmente superam suas contrapartes genéricas. Isso também traz outro conceito chamado `cache inline', onde o Python armazena em cache os resultados de operações caras diretamente no @ref{187,,bytecode}.

O especializador também combinará certos pares de instruções comuns em uma superinstrução, reduzindo a sobrecarga durante a execução.

O Python só se especializará quando vir um código “quente” (executado várias vezes). Isso evita que o Python perca tempo com código de execução única. O Python também pode se especializar quando o código é muito dinâmico ou quando o uso muda. A especialização é tentada periodicamente e as tentativas de especialização não são muito caras, permitindo que a especialização se adapte às novas circunstâncias.

(PEP escrita por Mark Shannon, com ideias inspiradas por Stefan Brunthaler. Veja 
@geindex Propostas de Melhorias do Python; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} para mais informações. Implementação por Mark Shannon e Brandt Bucher, com ajuda adicional de Irit Katriel e Dennis Sweeney.)

@c If I missed out anyone, please add them.


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Forma

@tab

Especialização

@tab

Aceleração da operação

@tab

Contribuidor(es)

@item

Operações binárias

@tab

@code{x + x}

@code{x - x}

@code{x * x}

@tab

Adicionar, multiplicar e subtrair binários para tipos comuns como @ref{257,,int}, @ref{2f7,,float} e @ref{44c,,str} usam caminhos rápidos personalizados para seus tipos subjacentes.

@tab

10%

@tab

Mark Shannon,
Donghee Na,
Brandt Bucher,
Dennis Sweeney

@item

Subscrição

@tab

@code{a[i]}

@tab

Subscrever tipos contêineres como @ref{611,,list}, @ref{370,,tuple} e @ref{256,,dict} indexam diretamente as estruturas de dados subjacentes.

Subscrever @ref{283,,__getitem__()} personalizado também é inserido em linha de forma similar a @ref{6e3,,Chamadas de função Python em linha}.

@tab

10-25%

@tab

Irit Katriel,
Mark Shannon

@item

Armazenar com subscrição

@tab

@code{a[i] = z}

@tab

Similar à especialização de subscrição acima.

@tab

10-25%

@tab

Dennis Sweeney

@item

Chamadas

@tab

@code{f(arg)}

@code{C(arg)}

@tab

Chamadas para funções e tipos (C) embutidos comuns como @ref{62e,,len()} e @ref{44c,,str} chamam diretamente sua versão C subjacente. Isso evita passar pela convenção de chamada interna.

@tab

20%

@tab

Mark Shannon,
Ken Jin

@item

Carregar variável global

@tab

@code{print}

@code{len}

@tab

O índice do objeto no espaço de nomes globais/embutidas é armazenado em cache. Carregar globais e embutidas requer zero pesquisas de espaço de nomes.

@tab

@footnote{
Uma otimização semelhante já existia desde o Python 3.8. O 3.11 é especializado em mais formas e reduz algumas despesas gerais.
}

@tab

Mark Shannon

@item

Carregar atributo

@tab

@code{o.attr}

@tab

Semelhante ao carregamento de variáveis globais. O índice do atributo dentro do espaço de nomes da classe/objeto é armazenado em cache. Na maioria dos casos, o carregamento de atributos exigirá zero pesquisas de espaço de nomes.

@tab

@footnote{
Uma otimização semelhante já existia desde o Python 3.10. 3.11 é especializado em mais formas. Além disso, todos os carregamentos de atributos devem ser acelerados por @uref{https://bugs.python.org/issue?@@action=redirect&bpo=45947,bpo-45947}.
}

@tab

Mark Shannon

@item

Carregar métodos para chamada

@tab

@code{o.meth()}

@tab

O endereço real do método é armazenado em cache. O carregamento de método agora não tem pesquisas de espaço de nomes – mesmo para classes com longas cadeias de herança.

@tab

10-20%

@tab

Ken Jin,
Mark Shannon

@item

Armazenar atributo

@tab

@code{o.attr = z}

@tab

Semelhante à otimização de carregamento de atributos.

@tab

2% no pyperformance

@tab

Mark Shannon

@item

Desempacotar sequência

@tab

@code{*seq}

@tab

Especializado para contêineres comuns como @ref{611,,list} e @ref{370,,tuple}. Evita convenção de chamada interna.

@tab

8%

@tab

Brandt Bucher

@end multitable


@node Diversos,FAQ,Tempo de execução mais rápido,CPython mais rápido
@anchor{whatsnew/3 11 misc}@anchor{6e7}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-misc}@anchor{6e8}
@subsubsection Diversos



@itemize *

@item 
Os objetos agora requerem menos memória devido aos espaços de nomes de objetos criados lentamente. Seus dicionários de espaços de nomes agora também compartilham chaves mais livremente. (Contribuição de Mark Shannon em bpo-45340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45340} e bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}.)

@item 
Exceções de “custo zero” estão implementadas, eliminando o custo das instruções @ref{6e9,,try} quando nenhuma exceção é gerada. (Contribuição de Mark Shannon em bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}.)

@item 
Uma representação mais concisa de exceções no interpretador reduziu o tempo necessário para capturar uma exceção em cerca de 10%. (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
O mecanismo de correspondência de expressão regular do @ref{b9,,re} foi parcialmente refatorado e agora usa `gotos' computados (ou “código encadeado”) em plataformas suportadas. Como resultado, o Python 3.11 executa os benchmarks de expressão regular do pyperformance@footnote{https://pyperformance.readthedocs.io/benchmarks.html#regex-dna} até 10% mais rápido que o Python 3.10. (Contribuição de Brandt Bucher em gh-91404@footnote{https://github.com/python/cpython/issues/91404}.)
@end itemize

@node FAQ,Sobre,Diversos,CPython mais rápido
@anchor{whatsnew/3 11 faq}@anchor{6ea}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-faq}@anchor{6eb}
@subsubsection FAQ


@menu
* Como devo escrever meu código para utilizar esses aceleradores?:: 
* O CPython 3.11 usará mais memória?: O CPython 3 11 usará mais memória?. 
* Não vejo nenhuma aceleração em minha carga de trabalho. Por que?: Não vejo nenhuma aceleração em minha carga de trabalho Por que?. 
* Existe um compilador JIT?:: 

@end menu

@node Como devo escrever meu código para utilizar esses aceleradores?,O CPython 3 11 usará mais memória?,,FAQ
@anchor{whatsnew/3 11 faster-cpython-faq-my-code}@anchor{6ec}@anchor{whatsnew/3 11 how-should-i-write-my-code-to-utilize-these-speedups}@anchor{6ed}
@subsubsection Como devo escrever meu código para utilizar esses aceleradores?


Escrever código pythônico que segue as melhores práticas comuns; você não precisa alterar seu código. O projeto Faster CPython otimiza para padrões de código comuns que observamos.

@node O CPython 3 11 usará mais memória?,Não vejo nenhuma aceleração em minha carga de trabalho Por que?,Como devo escrever meu código para utilizar esses aceleradores?,FAQ
@anchor{whatsnew/3 11 faster-cpython-faq-memory}@anchor{6ee}@anchor{whatsnew/3 11 will-cpython-3-11-use-more-memory}@anchor{6ef}
@subsubsection O CPython 3.11 usará mais memória?


Talvez não; não esperamos que o uso de memória exceda 20% a mais que 3.10. Isso é compensado por otimizações de memória para objetos quadro e dicionários de objetos, conforme mencionado acima.

@node Não vejo nenhuma aceleração em minha carga de trabalho Por que?,Existe um compilador JIT?,O CPython 3 11 usará mais memória?,FAQ
@anchor{whatsnew/3 11 faster-cpython-ymmv}@anchor{6f0}@anchor{whatsnew/3 11 i-don-t-see-any-speedups-in-my-workload-why}@anchor{6f1}
@subsubsection Não vejo nenhuma aceleração em minha carga de trabalho. Por que?


Certos códigos não terão benefícios perceptíveis. Se seu código passa a maior parte do tempo em operações de E/S ou já faz a maior parte de sua computação em uma biblioteca de extensão C como NumPy, não haverá acelerações significativas. Atualmente, esse projeto é o que mais beneficia as cargas de trabalho Python puro.

Além disso, os valores de desempenho py são uma média geométrica. Mesmo dentro dos benchmarks de pyperformance, alguns benchmarks desaceleraram um pouco, enquanto outros aceleraram quase 2x!

@node Existe um compilador JIT?,,Não vejo nenhuma aceleração em minha carga de trabalho Por que?,FAQ
@anchor{whatsnew/3 11 faster-cpython-jit}@anchor{6f2}@anchor{whatsnew/3 11 is-there-a-jit-compiler}@anchor{6f3}
@subsubsection Existe um compilador JIT?


Não. Ainda estamos explorando outras otimizações.

@node Sobre,,FAQ,CPython mais rápido
@anchor{whatsnew/3 11 about}@anchor{6f4}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-about}@anchor{6f5}
@subsubsection Sobre


O Faster CPython explora otimizações para o @ref{6f6,,CPython}. A equipe principal é financiada pela Microsoft para trabalhar nisso em tempo integral. Pablo Galindo Salgado também é financiado pela Bloomberg LP para trabalhar no projeto em tempo parcial. Finalmente, muitos colaboradores são voluntários da comunidade.

@node Alterações de bytecode do CPython<3>,Descontinuados<3>,CPython mais rápido,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 cpython-bytecode-changes}@anchor{6f7}@anchor{whatsnew/3 11 whatsnew311-bytecode-changes}@anchor{6f8}
@subsection Alterações de bytecode do CPython


O bytecode agora contém entradas de cache inline, que assumem a forma das instruções recém-adicionadas @ref{6f9,,CACHE}. Muitos códigos de operações, ou `opcodes',  esperam ser seguidos por um número exato de caches e instruem o interpretador a ignorá-los em tempo de execução. Os caches preenchidos podem parecer instruções arbitrárias, portanto, muito cuidado deve ser tomado ao ler ou modificar o bytecode adaptativo bruto que contém dados acelerados.

@menu
* Novos opcodes:: 
* Opcodes substituídos:: 
* Opcodes alterados/removidos:: 

@end menu

@node Novos opcodes,Opcodes substituídos,,Alterações de bytecode do CPython<3>
@anchor{whatsnew/3 11 new-opcodes}@anchor{6fa}@anchor{whatsnew/3 11 whatsnew311-added-opcodes}@anchor{6fb}
@subsubsection Novos opcodes



@itemize *

@item 
@code{ASYNC_GEN_WRAP}, @ref{6fc,,RETURN_GENERATOR} e @ref{6fd,,SEND}, usados em geradores e corrotinas.

@item 
@ref{6fe,,COPY_FREE_VARS}, que evita precisar de código especial no lado do chamado para fechamentos.

@item 
@ref{6ff,,JUMP_BACKWARD_NO_INTERRUPT}, para usasr em certos loops nos quais o tratamento de interrupções é indesejável.

@item 
@ref{700,,MAKE_CELL}, para criar @ref{701,,Objeto célula}.

@item 
@ref{702,,CHECK_EG_MATCH} e @code{PREP_RERAISE_STAR}, para manipular @ref{5a1,,novos grupos de exceção e except*}, adicionados na 
@geindex Propostas de Melhorias do Python; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}.

@item 
@ref{703,,PUSH_EXC_INFO}, para uso em manipuladores de exceção.

@item 
@ref{315,,RESUME}, um `no-op', para rastreamento interno, depuração e verificações de otimização.
@end itemize

@node Opcodes substituídos,Opcodes alterados/removidos,Novos opcodes,Alterações de bytecode do CPython<3>
@anchor{whatsnew/3 11 replaced-opcodes}@anchor{704}@anchor{whatsnew/3 11 whatsnew311-replaced-opcodes}@anchor{705}
@subsubsection Opcodes substituídos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opcode(s) substituído(s)

@tab

Novo(s) opcode(s)

@tab

Notas

@item


@display
@code{BINARY_*}@w{ }
@code{INPLACE_*}@w{ }
@end display



@tab

@ref{706,,BINARY_OP}

@tab

Substituiu todos os opcodes numéricos binários/no local por um único opcode

@item


@display
@code{CALL_FUNCTION}@w{ }
@code{CALL_FUNCTION_KW}@w{ }
@code{CALL_METHOD}@w{ }
@end display



@tab


@display
@ref{707,,CALL}@w{ }
@code{KW_NAMES}@w{ }
@code{PRECALL}@w{ }
@ref{708,,PUSH_NULL}@w{ }
@end display



@tab

Separa a mudança de argumento para métodos da manipulação de argumentos nomeados; permite uma melhor especialização dos atendimentos

@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{709,,COPY}@w{ }
@ref{70a,,SWAP}@w{ }
@end display



@tab

Instruções de manipulação de pilha

@item


@display
@code{JUMP_IF_NOT_EXC_MATCH}@w{ }
@end display



@tab


@display
@ref{70b,,CHECK_EXC_MATCH}@w{ }
@end display



@tab

Agora efetua verificações, mas não pula

@item


@display
@code{JUMP_ABSOLUTE}@w{ }
@code{POP_JUMP_IF_FALSE}@w{ }
@code{POP_JUMP_IF_TRUE}@w{ }
@end display



@tab


@display
@ref{70c,,JUMP_BACKWARD}@w{ }
@code{POP_JUMP_BACKWARD_IF_*}@w{ }
@code{POP_JUMP_FORWARD_IF_*}@w{ }
@end display



@tab

Veja @footnote{
Todos os opcodes de salto agora são relativos, incluindo os existentes @code{JUMP_IF_TRUE_OR_POP} e @code{JUMP_IF_FALSE_OR_POP}. O argumento agora é um deslocamento da instrução atual em vez de um local absoluto.
}. Variantes @code{TRUE}, @code{FALSE}, @code{NONE} e @code{NOT_NONE} para cada direção

@item


@display
@code{SETUP_WITH}@w{ }
@code{SETUP_ASYNC_WITH}@w{ }
@end display



@tab

@ref{70d,,BEFORE_WITH}

@tab

Configuração de bloco @ref{5d2,,with}

@end multitable

@anchor{whatsnew/3 11 whatsnew311-changed-opcodes}@anchor{70e}@anchor{whatsnew/3 11 whatsnew311-removed-opcodes}@anchor{70f}
@node Opcodes alterados/removidos,,Opcodes substituídos,Alterações de bytecode do CPython<3>
@anchor{whatsnew/3 11 changed-removed-opcodes}@anchor{710}@anchor{whatsnew/3 11 whatsnew311-changed-removed-opcodes}@anchor{711}
@subsubsection Opcodes alterados/removidos



@itemize *

@item 
Alterados @ref{712,,MATCH_CLASS} e @ref{713,,MATCH_KEYS} para não enviar mais um valor booleano adicional para indicar sucesso/falha. Em vez disso, @code{None} é enviado em caso de falha no lugar da tupla de valores extraídos.

@item 
Alterados opcodes que funcionam com exceções para refleti-los agora sendo representados como um item na pilha em vez de três (consulte gh-89874@footnote{https://github.com/python/cpython/issues/89874}).

@item 
Removidos @code{COPY_DICT_WITHOUT_KEYS}, @code{GEN_START}, @code{POP_BLOCK}, @code{SETUP_FINALLY} e @code{YIELD_FROM}.
@end itemize
@anchor{whatsnew/3 11 whatsnew311-deprecated}@anchor{714}
@node Descontinuados<3>,Pendente remoção no Python 3 12,Alterações de bytecode do CPython<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 deprecated}@anchor{715}@anchor{whatsnew/3 11 whatsnew311-python-api-deprecated}@anchor{716}
@subsection Descontinuados


Esta seção lista as APIs do Python que foram descontinuadas no Python 3.11.

As APIs C descontinuadas são @ref{717,,listadas separadamente}.
@anchor{whatsnew/3 11 whatsnew311-deprecated-language}@anchor{718}
@menu
* Linguagem/Embutidos:: 
* Módulos:: 
* Biblioteca Padrão:: 

@end menu

@node Linguagem/Embutidos,Módulos,,Descontinuados<3>
@anchor{whatsnew/3 11 language-builtins}@anchor{719}@anchor{whatsnew/3 11 whatsnew311-deprecated-builtins}@anchor{71a}
@subsubsection Linguagem/Embutidos



@itemize *

@item 
O encadeamento de descritores @ref{166,,classmethod} (introduzido em bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}) agora foi descontinuado. Ele não pode mais ser usado para agrupar outros descritores como @ref{194,,property}. O design principal desse recurso era falho e causava vários problemas posteriores. Para “passar” um @ref{166,,classmethod}, considere usar o atributo @code{__wrapped__} que foi adicionado no Python 3.10. (Contribuição de Raymond Hettinger em gh-89519@footnote{https://github.com/python/cpython/issues/89519}.)

@item 
Escapes octais em strings e bytes literais com valores maiores que @code{0o377} (255 em decimal) agora produzem um @ref{1a5,,DeprecationWarning}. Em uma versão futura do Python, eles levantarão um @ref{466,,SyntaxWarning} e eventualmente um @ref{18d,,SyntaxError}. (Contribuição de Serhiy Storchaka em gh-81548@footnote{https://github.com/python/cpython/issues/81548}.)

@item 
A delegação de @ref{257,,int()} para @ref{71b,,__trunc__()} agora foi descontinuada. Chamar @code{int(a)} quando @code{type(a)} implementa @code{__trunc__()}, mas não @ref{71c,,__int__()} ou @ref{71d,,__index__()}, agora levanta uma exceção @ref{1a5,,DeprecationWarning}. (Contribuição de Zackery Spytz em bpo-44977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44977}.)
@end itemize

@node Módulos,Biblioteca Padrão,Linguagem/Embutidos,Descontinuados<3>
@anchor{whatsnew/3 11 modules}@anchor{71e}@anchor{whatsnew/3 11 whatsnew311-deprecated-modules}@anchor{71f}
@subsubsection Módulos

@anchor{whatsnew/3 11 whatsnew311-pep594}@anchor{5ac}

@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} levou à descontinuação dos seguintes módulos programados para remoção no 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


(Contribuição de Brett Cannon em bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061} e Victor Stinner em gh-68966@footnote{https://github.com/python/cpython/issues/68966}.)

@item 
Os módulos @code{asynchat}, @code{asyncore} e @code{smtpd} foram descontinuados desde pelo menos o Python 3.6. A documentação e os avisos de descontinuação foram atualizados para observar que serão removidos no Python 3.12. (Contribuição de Hugo van Kemenade em bpo-47022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47022}.)

@item 
O pacote @code{lib2to3} e a ferramenta @code{2to3} agora foram descontinuados e podem não ser capazes de analisar o Python 3.10 ou mais recente. Veja 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}, apresentando o novo analisador GASE, para detalhes. (Contribuição de Victor Stinner em bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}.)

@item 
Módulos não documentados @code{sre_compile}, @code{sre_constants} e @code{sre_parse} agora fora descontinuados. (Contribuição de Serhiy Storchaka em bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}.)
@end itemize

@node Biblioteca Padrão,,Módulos,Descontinuados<3>
@anchor{whatsnew/3 11 standard-library}@anchor{720}@anchor{whatsnew/3 11 whatsnew311-deprecated-stdlib}@anchor{721}
@subsubsection Biblioteca Padrão



@itemize *

@item 
Os itens a seguir foram descontinuados em @ref{22,,configparser} desde o Python 3.2. Seus avisos de descontinuação agora foram atualizados para observar que serão removidos no Python 3.12:


@itemize *

@item 
a classe @code{configparser.SafeConfigParser}

@item 
a propriedade @code{configparser.ParsingError.filename}

@item 
o método @code{configparser.RawConfigParser.readfp()}
@end itemize

(Contribuição de Hugo van Kemenade em bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}.)

@item 
@code{configparser.LegacyInterpolation} foi descontinuada na docstring desde o Python 3.2, e não está listada na documentação do @ref{22,,configparser}. Agora ela emite um @ref{1a5,,DeprecationWarning} e será removida no Python 3.13. Use @ref{722,,configparser.BasicInterpolation} ou @ref{723,,configparser.ExtendedInterpolation}. (Contribuição de Hugo van Kemenade em bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607}.)

@item 
O antigo conjunto de funções @ref{7b,,importlib.resources} foi descontinuado em favor das substituições adicionadas no Python 3.9 e será removido em uma versão futura do Python, devido ao não suporte de recursos localizados nos subdiretórios do pacote:


@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 
A função @ref{2d9,,locale.getdefaultlocale()} foi descontinuada e será removida no Python 3.15. Use as funções @ref{2db,,locale.setlocale()}, @ref{53a,,locale.getpreferredencoding(False)} e @ref{2da,,locale.getlocale()}. (Contribuição de Victor Stinner em gh-90817@footnote{https://github.com/python/cpython/issues/90817}.)

@item 
A função @code{locale.resetlocale()} foi descontinuada e será removida no Python 3.13. Use @code{locale.setlocale(locale.LC_ALL, "")}. (Contribuição de Victor Stinner em gh-90817@footnote{https://github.com/python/cpython/issues/90817}.)

@item 
Regras mais rígidas agora serão aplicadas para referências numéricas de grupos e nomes de grupos em @ref{724,,expressões regulares}. Apenas sequências de dígitos ASCII serão aceitas como referência numérica, e o nome do grupo em padrões @ref{1c2,,bytes} e strings de substituição podem conter apenas letras ASCII, dígitos e sublinhados. Por enquanto, um aviso de descontinuação é levantado para a sintaxe que viola essas regras. (Contribuição de Serhiy Storchaka em gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
No módulo @ref{b9,,re}, a função @code{re.template()} e os sinalizadores @code{re.TEMPLATE} e @code{re.T} correspondentes foram descontinuados, pois não foram documentados e careciam da um propósito óbvio. Eles serão removidos no Python 3.13. (Contribuição de Serhiy Storchaka e Miro Hrončok em gh-92728@footnote{https://github.com/python/cpython/issues/92728}.)

@item 
@code{turtle.settiltangle()} foi descontinuada desde o Python 3.1; ela agora emite um aviso de descontinuação e será removida no Python 3.13. Em vez dela, use @ref{725,,turtle.tiltangle()} (foi marcada anteriormente incorretamente como descontinuada e sua docstring agora está corrigida). (Contribuição de Hugo van Kemenade em bpo-45837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45837}.)

@item 
@ref{30b,,typing.Text}, que existe apenas para fornecer suporte de compatibilidade entre o código Python 2 e Python 3, foi descontinuada nesta versão. Sua remoção não está planejada, mas os usuários são encorajados a usar @ref{44c,,str} sempre que possível. (Contribuição de Alex Waygood em gh-92332@footnote{https://github.com/python/cpython/issues/92332}.)

@item 
A sintaxe do argumento nomeado para a construção de tipos @ref{162,,typing.TypedDict} foi descontinuado neste versão. O suporte será removido no Python 3.13. (Contribuição de Jingchen Ye em gh-90224@footnote{https://github.com/python/cpython/issues/90224}.)

@item 
@code{webbrowser.MacOSX} foi descontinuada e será removida no Python 3.13. Ela não foi testada, não foi documentada e não é usada pelo próprio @ref{115,,webbrowser}. (Contribuição de Dong-hee Na em bpo-42255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42255}.)

@item 
O comportamento de retornar um valor de um dos métodos de teste de @ref{44f,,TestCase} e @ref{30c,,IsolatedAsyncioTestCase} (diferente do valor padrão @code{None}) foi descontinuado nesta versão.

@item 
Foram descontinuadas as seguintes funções @ref{106,,unittest} não formalmente documentadas, agendadas para remoção no Python 3.13:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Em vez delas, use os métodos de @ref{28e,,TestLoader}:


@itemize *

@item 
@ref{28f,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{290,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{291,,unittest.TestLoader.getTestCaseNames()}
@end itemize

(Contribuição de Erlend E. Aasland em bpo-5846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5846}.)

@item 
@code{unittest.TestProgram.usageExit()} foi marcado como descontinuado, para ser removido em 3.13. (Contribuição de Carlos Damázio em gh-67048@footnote{https://github.com/python/cpython/issues/67048}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pending-removal}@anchor{726}
@node Pendente remoção no Python 3 12,Removidos<3>,Descontinuados<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 pending-removal-in-python-3-12}@anchor{727}@anchor{whatsnew/3 11 whatsnew311-python-api-pending-removal}@anchor{728}
@subsection Pendente remoção no Python 3.12


As seguintes APIs do Python foram descontinuadas em versões anteriores do Python e serão removidas no Python 3.12.

As APIs C com remoção pendente são @ref{729,,listadas separadamente}.


@itemize *

@item 
O módulo @code{asynchat}

@item 
O módulo @code{asyncore}

@item 
@ref{72a,,Todo o pacote distutils}

@item 
O módulo @code{imp}

@item 
O espaço de nomes @ref{72b,,typing.io}

@item 
O espaço de nomes @ref{72c,,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 
Variável de ambiente @code{PYTHONTHREADDEBUG}

@item 
Os seguintes aliases foram descontinuados no @ref{106,,unittest}:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Apelido descontinuado

@tab

Método

@tab

Descontinuado em

@item

@code{failUnless}

@tab

@ref{527,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{528,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{529,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{52a,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{52b,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{52c,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{52d,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{527,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{529,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{52a,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{52b,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{52c,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{52e,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{52f,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{530,,assertNotRegex()}

@tab

3.5

@end multitable

@end quotation
@end itemize
@anchor{whatsnew/3 11 whatsnew311-removed}@anchor{72d}
@node Removidos<3>,Portando para Python 3 11,Pendente remoção no Python 3 12,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 removed}@anchor{72e}@anchor{whatsnew/3 11 whatsnew311-python-api-removed}@anchor{72f}
@subsection Removidos


Esta seção lista as APIs do Python que foram removidas no Python 3.11.

As  APIs C removidas são @ref{730,,listadas separadamente}.


@itemize *

@item 
Removido o @ref{731,,decorador} @code{@@asyncio.coroutine()} permitindo que corrotinas baseadas em gerador legado sejam compatíveis com o código @ref{732,,async} / @ref{1b9,,await}. A função foi descontinuada desde o Python 3.8 e a remoção foi inicialmente agendada para o Python 3.10. Use @ref{5d1,,async def} em vez disso. (Contribuição de Illia Volochii em bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}.)

@item 
Removida @code{asyncio.coroutines.CoroWrapper}, que era usada para encapsular objetos de corrotina baseados em gerador legado no modo de depuração. (Contribuição de Illia Volochii em bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}.)

@item 
Devido a preocupações significativas de segurança, o parâmetro `reuse_address' de @ref{733,,asyncio.loop.create_datagram_endpoint()}, desabilitado no Python 3.9, agora foi totalmente removido. Isto é devido ao comportamento da opção de socket @code{SO_REUSEDDR} no UDP. (Contribuição de Hugo van Kemenade em bpo-45129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45129}.)

@item 
Removido o módulo @code{binhex}, descontinuado no Python 3.9. Também foram removidas as funções @ref{10,,binascii} relacionadas e igualmente descontinuadas:


@itemize *

@item 
@code{binascii.a2b_hqx()}

@item 
@code{binascii.b2a_hqx()}

@item 
@code{binascii.rlecode_hqx()}

@item 
@code{binascii.rldecode_hqx()}
@end itemize

A função @ref{734,,binascii.crc_hqx()} continua disponível.

(Contribuição de Victor Stinner em bpo-45085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45085}.)

@item 
Removido o comando @code{bdist_msi} do @code{distutils} que foi descontinuado no Python 3.9. Em vez disso, use @code{bdist_wheel} (pacotes wheel). (Contribuição de Hugo van Kemenade em bpo-45124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45124}.)

@item 
Removidos os métodos @ref{283,,__getitem__()} das classes @ref{735,,xml.dom.pulldom.DOMEventStream}, @ref{736,,wsgiref.util.FileWrapper} e @ref{737,,fileinput.FileInput}, descontinuados desde o Python 3.9 . (Contribuição de Hugo van Kemenade em bpo-45132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45132}.)

@item 
Removidas as funções descontinuadas @code{lgettext()}, @code{ldgettext()}, @code{lngettext()} e @code{ldngettext()} de @ref{63,,gettext}. Também removidas a função @code{bind_textdomain_codeset()}, os métodos @code{NullTranslations.output_charset()} e @code{NullTranslations.set_output_charset()}, e o parâmetro `codeset' de @code{translation()} e @code{install()}, já que eles são usados apenas para as funções @code{l*gettext()}. (Contribuição de Dong-hee Na e Serhiy Storchaka em bpo-44235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44235}.)

@item 
Removido do módulo @ref{7e,,inspect}:


@itemize *

@item 
A função @code{getargspec()}, descontinuada desde o Python 3.0; use @ref{738,,inspect.signature()} ou @ref{739,,inspect.getfullargspec()}.

@item 
A função @code{formatargspec()}, descontinuada desde o Python 3.5; use a função @ref{738,,inspect.signature()} ou o objeto @ref{1cf,,inspect.Signature} diretamente.

@item 
Os métodos não documentados @code{Signature.from_builtin()} e @code{Signature.from_function()}, descontinuados desde o Python 3.5; use o método @ref{73a,,Signature.from_callable()}.
@end itemize

(Contribuição de Hugo van Kemenade em bpo-45320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45320}.)

@item 
Removido o método @ref{73b,,__class_getitem__()} de @ref{4a6,,pathlib.PurePath}, pois não era usado e foi adicionado por engano em versões anteriores. (Contribuição de Nikita Sobolev em bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483}.)

@item 
Removida a classe @code{MailmanProxy} do módulo @code{smtpd}, pois ela não pode ser usada sem o pacote @code{mailman} externo. (Contribuição de Dong-hee Na em bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}.)

@item 
Removido o método descontinuado @code{split()} de @code{_tkinter.TkappType}. (Contribuição de Erlend E. Aasland em bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}.)

@item 
Removido o suporte a pacote de espaço de nomes da descoberta de @ref{106,,unittest}. Foi introduzido no Python 3.4, mas está quebrado desde o Python 3.7. (Contribuição de Inada Naoki em bpo-23882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23882}.)

@item 
Removido o método privado não documentado @code{float.__set_format__()}, anteriormente conhecido como @code{float.__setformat__()} no Python 3.7. Sua docstring dizia: “Você provavelmente não quer usar esta função. Ela existe principalmente para ser usada na conjunto de testes do Python.” (Contribuição de Victor Stinner em bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}.)

@item 
O sinalizador de configuração @code{--experimental-isolated-subinterpreters} e a macro @code{EXPERIMENTAL_ISOLATED_SUBINTERPRETERS} correspondente foram removidos.

@item 
Pynche@footnote{https://pypi.org/project/Pynche/} – O Pythonically Natural Color and Hue Editor – foi removido de @code{Tools/scripts} e está sendo desenvolvido independentemente@footnote{https://gitlab.com/warsaw/pynche/-/tree/main} da árvore fonte do Python.
@end itemize
@anchor{whatsnew/3 11 whatsnew311-porting}@anchor{73c}
@node Portando para Python 3 11,Mudanças na construção<3>,Removidos<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 porting-to-python-3-11}@anchor{73d}@anchor{whatsnew/3 11 whatsnew311-python-api-porting}@anchor{73e}
@subsection Portando para Python 3.11


Esta seção lista as alterações descritas anteriormente e outras correções de bugs na API do Python que podem exigir alterações em seu código Python.

As notas de portabilidade para a API C são @ref{73f,,listadas separadamente}.


@itemize *

@item 
@ref{51c,,open()}, @ref{51d,,io.open()}, @ref{740,,codecs.open()} e @ref{737,,fileinput.FileInput} não aceitam mais @code{'U'} (“nova linha universal”) em o modo de arquivo. No Python 3, o modo “nova linha universal” é usado por padrão sempre que um arquivo é aberto no modo de texto, e o sinalizador @code{'U'} foi descontinuado desde o Python 3.3. O @ref{741,,parâmetro de nova linha} para essas funções controla como as novas linhas universais funcionam. (Contribuição de Victor Stinner em bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}.)

@item 
As posições do nó da @ref{1a6,,ast.AST} agora são validadas quando fornecidas para @ref{192,,compile()} e outras funções relacionadas. Se posições inválidas forem detectadas, uma exceção @ref{202,,ValueError} será levantado. (Contribuição de Pablo Galindo em gh-93351@footnote{https://github.com/python/cpython/issues/93351})

@item 
Proibido passar executores que não sejam @ref{742,,concurrent.futures.ThreadPoolExecutor} para @ref{743,,asyncio.loop.set_default_executor()} após uma descontinuação no Python 3.8. (Contribuição de Illia Volochii em bpo-43234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43234}.)

@item 
@ref{14,,calendar}: As classes @ref{744,,calendar.LocaleTextCalendar} e @ref{745,,calendar.LocaleHTMLCalendar} agora usam @ref{2da,,locale.getlocale()}, em vez de usar @ref{2d9,,locale.getdefaultlocale()}, se nenhuma localidade é especificada. (Contribuição de Victor Stinner em bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}.)

@item 
O módulo @ref{a5,,pdb} agora lê o arquivo de configuração @code{.pdbrc} com a codificação @code{'UTF-8'}. (Contribuição de Srinivas Reddy Thatiparty (శ్రీనివాస్ రెడ్డి తాటిపర్తి) em bpo-41137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41137}.)

@item 
O parâmetro `population' de @ref{746,,random.sample()} deve ser uma sequência, e a conversão automática de @ref{5d9,,set}s para @ref{611,,list}s não é mais suportada. Além disso, se o tamanho da amostra for maior que o tamanho da população, uma exceção @ref{202,,ValueError} é levantada. (Contribuição de Raymond Hettinger em bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}.)

@item 
O parâmetro opcional `random' de @ref{747,,random.shuffle()} foi removido. Anteriormente, era uma função aleatória arbitrária a ser usada para o shuffle; agora, @ref{748,,random.random()} (seu padrão anterior) sempre será usado.

@item 
Em @ref{724,,Sintaxe de expressão regular} do @ref{b9,,re}, sinalizadores globais inline (por exemplo, @code{(?i)}) agora só podem ser usados no início de expressões regulares. Se uso em outro lugar foi descontinuado no Python 3.6. (Contribuição de Serhiy Storchaka em bpo-47066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47066}.)

@item 
No módulo @ref{b9,,re}, vários bugs de longa data foram corrigidos que, em casos raros, poderiam fazer com que os grupos de captura obtivessem o resultado errado. Portanto, isso pode alterar a saída capturada nesses casos. (Contribuição de Ma Lin em bpo-35859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35859}.)
@end itemize

@node Mudanças na construção<3>,Alterações na API C<5>,Portando para Python 3 11,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 build-changes}@anchor{749}@anchor{whatsnew/3 11 whatsnew311-build-changes}@anchor{74a}
@subsection Mudanças na construção



@itemize *

@item 
CPython agora tem 
@geindex Propostas de Melhorias do Python; PEP 11#tier-3
suporte a Tier 3@footnote{https://peps.python.org/pep-0011/#tier-3} da 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} para compilação cruzada para as plataformas WebAssembly@footnote{https://webassembly.org/} Emscripten@footnote{https://emscripten.org/} (@code{wasm32-unknown-emscripten}, ou seja, Python no navegador) e WebAssembly System Interface (WASI)@footnote{https://wasi.dev/} (@code{wasm32-unknown-wasi}). O esforço é inspirado em trabalhos anteriores como Pyodide@footnote{https://pyodide.org/}. Essas plataformas fornecem um subconjunto limitado de APIs POSIX; Os recursos e módulos das bibliotecas padrão do Python relacionados a redes, processos, encadeamento, sinais, mmap e usuários/grupos não estão disponíveis ou não funcionam. (Emscripten contribuído por Christian Heimes e Ethan Smith em gh-84461@footnote{https://github.com/python/cpython/issues/84461} e WASI contribuído por Christian Heimes em gh-90473@footnote{https://github.com/python/cpython/issues/90473}; plataformas promovidas em gh-95085@footnote{https://github.com/python/cpython/issues/95085})

@item 
A construção do CPython agora requer:


@itemize *

@item 
Um compilador C11@footnote{https://en.cppreference.com/w/c/11}. Recursos C11 opcionais@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features} não são necessários. (Contribuição de Victor Stinner em bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}, bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440} e bpo-46640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46640}.)

@item 
Suporte para números de ponto flutuante IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754}. (Contribuição de Victor Stinner em bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}.)
@end itemize

@item 
A macro @code{Py_NO_NAN} foi removida. Como o CPython agora requer pontos flutuantes de IEEE 754, os valores NaN estão sempre disponíveis. (Contribuição de Victor Stinner em bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}.)

@item 
O pacote @ref{f0,,tkinter} agora requer Tcl/Tk@footnote{https://www.tcl.tk} versão 8.5.12 ou mais recente. (Contribuição de Serhiy Storchaka em bpo-46996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46996}.)

@item 
Dependências de construção, sinalizadores de compilador e sinalizadores de vinculador para a maioria dos módulos de extensão stdlib agora são detectados pelo @code{configure}. Os sinalizadores, ou `flags', de libffi, libnsl, libsqlite3, zlib, bzip2, liblzma, libcrypt, Tcl/Tk e uuid são detectados por pkg-config@footnote{https://www.freedesktop.org/wiki/Software/pkg-config/} (Quando disponível). @ref{f0,,tkinter} agora requer um comando pkg-config para detectar configurações de desenvolvimento para cabeçalhos e bibliotecas Tcl/Tk@footnote{https://www.tcl.tk}. (Contribuição de Christian Heimes e Erlend Egeberg Aasland em bpo-45847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45847}, bpo-45747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45747} e bpo-45763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45763}.)

@item 
libpython não está mais vinculado a libcrypt. (Contribuição de Mike Gilbert em bpo-45433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45433}.)

@item 
O CPython agora pode ser construído com a opção ThinLTO@footnote{https://clang.llvm.org/docs/ThinLTO.html} passando @code{thin} para @ref{74b,,--with-lto}, ou seja, @code{--with-lto=thin}. (Contribuição de Donghee Na e Brett Holman em bpo-44340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44340}.)

@item 
Freelists para structs de objeto agora podem ser desabilitadas. Uma nova opção @ref{74c,,--without-freelists} do @code{configure} pode ser usada para desabilitar todas as freelists, exceto a tupla singleton vazia. (Contribuição de Christian Heimes em bpo-45522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45522}.)

@item 
@code{Modules/Setup} e @code{Modules/makesetup} foram melhorados e amarrados. Módulos de extensão agora podem ser construídos através do @code{makesetup}. Todos, exceto alguns módulos de teste, podem ser vinculados estaticamente em um binário principal ou biblioteca. (Contribuição de Brett Cannon e Christian Heimes em 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} e bpo-43974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43974}.)

@cartouche
@quotation Nota 
Use as variáveis de ambiente @code{TCLTK_CFLAGS} e @code{TCLTK_LIBS} para especificar manualmente a localização dos cabeçalhos e bibliotecas Tcl/Tk. As opções @code{configure} @code{--with-tcltk-includes} e @code{--with-tcltk-libs} foram removidas.

No RHEL 7 e CentOS 7 os pacotes de desenvolvimento não fornecem @code{tcl.pc} e @code{tk.pc}; use @code{TCLTK_LIBS="-ltk8.5 -ltkstub8.5 -ltcl8.5"}. O diretório @code{Misc/rhel7} contém arquivos @code{.pc} e instruções sobre como construir Python com RHEL 7’s e CentOS 7’s Tcl/Tk e OpenSSL.
@end quotation
@end cartouche

@item 
O CPython agora usará dígitos de 30 bits por padrão para a implementação de @ref{257,,int} do Python. Anteriormente, o padrão era usar dígitos de 30 bits em plataformas com @code{SIZEOF_VOID_P >= 8} e, caso contrário, dígitos de 15 bits. Ainda é possível solicitar explicitamente o uso de dígitos de 15 bits através da opção @ref{74d,,--enable-big-digits} para o script de configuração ou (para Windows) a variável @code{PYLONG_BITS_IN_DIGIT} em @code{PC/pyconfig.h}, mas esta opção pode ser removida em algum momento no futuro. (Contribuição de Mark Dickinson em bpo-45569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45569}.)
@end itemize

@node Alterações na API C<5>,Alterações notáveis no 3 11 4,Mudanças na construção<3>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 c-api-changes}@anchor{74e}@anchor{whatsnew/3 11 whatsnew311-c-api}@anchor{74f}
@subsection Alterações na API C


@menu
* Novas funcionalidades: Novas funcionalidades<6>. 
* Portando para Python 3.11: Portando para Python 3 11<2>. 
* Descontinuados: Descontinuados<4>. 
* Pendente remoção no Python 3.12: Pendente remoção no Python 3 12<2>. 
* Removidos: Removidos<4>. 

@end menu

@node Novas funcionalidades<6>,Portando para Python 3 11<2>,,Alterações na API C<5>
@anchor{whatsnew/3 11 id5}@anchor{750}@anchor{whatsnew/3 11 whatsnew311-c-api-new-features}@anchor{751}
@subsubsection Novas funcionalidades



@itemize *

@item 
Adiciona uma nova função @ref{752,,PyType_GetName()} para obter o nome curto do tipo. (Contribuição de Hai Shi em bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}.)

@item 
Adiciona uma nova função @ref{753,,PyType_GetQualName()} para obter o nome qualificado do tipo. (Contribuição de Hai Shi em bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}.)

@item 
Adiciona novas funções @ref{754,,PyThreadState_EnterTracing()} e @ref{755,,PyThreadState_LeaveTracing()} à API C limitada para suspender e retomar rastreamento e criação de perfil. (Contribuição de Victor Stinner em bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}.)

@item 
Adicionada a constante @ref{756,,Py_Version} que possui o mesmo valor que @ref{757,,PY_VERSION_HEX}. (Contribuição de Gabriele N. Tornetta em bpo-43931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43931}.)

@item 
@ref{758,,Py_buffer} e APIs agora fazem parte da API limitada e da ABI estável:


@itemize *

@item 
@ref{398,,PyObject_CheckBuffer()}

@item 
@ref{399,,PyObject_GetBuffer()}

@item 
@ref{759,,PyBuffer_GetPointer()}

@item 
@ref{75a,,PyBuffer_SizeFromFormat()}

@item 
@ref{75b,,PyBuffer_ToContiguous()}

@item 
@ref{75c,,PyBuffer_FromContiguous()}

@item 
@ref{75d,,PyObject_CopyData()}

@item 
@ref{75e,,PyBuffer_IsContiguous()}

@item 
@ref{75f,,PyBuffer_FillContiguousStrides()}

@item 
@ref{760,,PyBuffer_FillInfo()}

@item 
@ref{39a,,PyBuffer_Release()}

@item 
@ref{761,,PyMemoryView_FromBuffer()}

@item 
Slotes de tipo @ref{762,,bf_getbuffer} e @ref{763,,bf_releasebuffer}
@end itemize

(Contribuição de Christian Heimes em bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}.)

@item 
Adicionada a função @ref{394,,PyType_GetModuleByDef()}, utilizada para obter o módulo no qual um método foi definido, nos casos em que esta informação não está disponível diretamente (via @ref{764,,PyCMethod}). (Contribuição de Petr Viktorin em bpo-46613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46613}.)

@item 
Adiciona novas funções para compactar e desempacotar double C (serializar e desserializar): @ref{765,,PyFloat_Pack2()}, @ref{766,,PyFloat_Pack4()}, @ref{767,,PyFloat_Pack8()}, @ref{768,,PyFloat_Unpack2()} , @ref{769,,PyFloat_Unpack4()} e @ref{76a,,PyFloat_Unpack8()}. (Contribuição de Victor Stinner em bpo-46906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46906}.)

@item 
Adiciona novas funções para obter atributos do objeto quadro: @ref{76b,,PyFrame_GetBuiltins()}, @ref{76c,,PyFrame_GetGenerator()}, @ref{76d,,PyFrame_GetGlobals()}, @ref{76e,,PyFrame_GetLasti()}.

@item 
Adicionadas duas novas funções para obter e definir a instância de exceção ativa: @ref{76f,,PyErr_GetHandledException()} e @ref{770,,PyErr_SetHandledException()}. Estas são alternativas para @ref{771,,PyErr_SetExcInfo()} e @ref{772,,PyErr_GetExcInfo()} que funcionam com a representação de tuplas de 3 elementos legadas de exceções. (Contribuição de Irit Katriel em bpo-46343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46343}.)

@item 
Adicionada o membro @ref{773,,PyConfig.safe_path}. (Contribuição de Victor Stinner em gh-57684@footnote{https://github.com/python/cpython/issues/57684}.)
@end itemize

@node Portando para Python 3 11<2>,Descontinuados<4>,Novas funcionalidades<6>,Alterações na API C<5>
@anchor{whatsnew/3 11 id6}@anchor{774}@anchor{whatsnew/3 11 whatsnew311-c-api-porting}@anchor{73f}
@subsubsection Portando para Python 3.11

@anchor{whatsnew/3 11 whatsnew311-pep670}@anchor{5ae}

@itemize *

@item 
Algumas macros foram convertidas em funções inline estáticas para evitar armadilhas de macro@footnote{https://gcc.gnu.org/onlinedocs/cpp/Macro-Pitfalls.html}. A alteração deve ser transparente para os usuários, pois as funções de substituição converterão seus argumentos para os tipos esperados para evitar avisos do compilador devido a verificações de tipo estático. No entanto, quando a API C limitada é definida como >=3.11, essas conversões não são feitas e os chamadores precisarão converter argumentos para seus tipos esperados. Veja 
@geindex Propostas de Melhorias do Python; PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/} para mais detalhes. (Contribuição de Victor Stinner e Erlend E. Aasland em gh-89653@footnote{https://github.com/python/cpython/issues/89653}.)

@item 
@ref{771,,PyErr_SetExcInfo()} não usa mais os argumentos @code{type} e @code{traceback}, o interpretador agora deriva esses valores da instância de exceção (o argumento @code{value}). A função ainda rouba referências de todos os três argumentos. (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
@ref{772,,PyErr_GetExcInfo()} agora deriva os campos @code{type} e @code{traceback} do resultado da instância de exceção (o campo @code{value}). (Contribuição de Irit Katriel em bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}.)

@item 
@ref{775,,_frozen} tem um novo campo @code{is_package} para indicar se o módulo frozen é ou não um pacote. Anteriormente, um valor negativo no campo @code{size} era o indicador. Agora apenas valores não negativos serão usados para @code{size}. (Contribuição de Kumar Aditya em bpo-46608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46608}.)

@item 
@ref{776,,_PyFrameEvalFunction()} agora usa @code{_PyInterpreterFrame*} como seu segundo parâmetro, em vez de @code{PyFrameObject*}. Veja 
@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} para mais detalhes de como usar este tipo de ponteiro de função.

@item 
@code{PyCode_New()} e @code{PyCode_NewWithPosOnlyArgs()} agora recebem um argumento adicional @code{exception_table}. O uso dessas funções deve ser evitado, se possível. Para obter um objeto código personalizado: crie um objeto código usando o compilador e obtenha uma versão modificada com o método @code{replace}.

@item 
@ref{777,,PyCodeObject} não possui mais os campos @code{co_code}, @code{co_varnames}, @code{co_cellvars} e @code{co_freevars}. Em vez disso, use @ref{778,,PyCode_GetCode()}, @ref{779,,PyCode_GetVarnames()}, @ref{77a,,PyCode_GetCellvars()} e @ref{77b,,PyCode_GetFreevars()} respectivamente para acessá-los por meio da API C. (Contribuição de Brandt Bucher em bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841} e Ken Jin em gh-92154@footnote{https://github.com/python/cpython/issues/92154} e gh-94936@footnote{https://github.com/python/cpython/issues/94936}.)

@item 
As antigas macros trashcan (@code{Py_TRASHCAN_SAFE_BEGIN}/@code{Py_TRASHCAN_SAFE_END}) foram descontinuadas. Elas devem ser substituídas pelas novas macros @code{Py_TRASHCAN_BEGIN} e @code{Py_TRASHCAN_END}.

Uma função tp_dealloc que possui as macros antigas, como:

@example
static void
dealocador_de_meutipo(meutipo *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

deve migrar para as novas macros da seguinte forma:

@example
static void
dealocador_de_meutipo(meutipo *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, dealocador_de_meutipo);
    ...
    Py_TRASHCAN_END
@}
@end example

Observe que @code{Py_TRASHCAN_BEGIN} tem um segundo argumento que deve ser a função de desalocação em que está.

Para oferecer suporte a versões mais antigas do Python na mesma base de código, você pode definir as seguintes macros e usá-las em todo o código (crédito: elas foram copiadas da base de código do @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 
A função @ref{77c,,PyType_Ready()} agora levanta um erro se um tipo é definido com o sinalizador @ref{77d,,Py_TPFLAGS_HAVE_GC} definido, mas não tem função transversal (@ref{77e,,PyTypeObject.tp_traverse}). (Contribuição de Victor Stinner em bpo-44263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44263}.)

@item 
Tipos de heap com o sinalizador @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} agora podem herdar o protocolo vectorcall da 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}. Anteriormente, isso só era possível para @ref{77f,,tipos estáticos}. (Contribuição de Erlend E. Aasland em bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908})

@item 
Uma vez que @ref{780,,Py_TYPE()} é alterada para uma função estática inline, @code{Py_TYPE(obj) = new_type} deve ser substituído por @code{Py_SET_TYPE(obj, new_type)}: consulte a função @ref{781,,Py_SET_TYPE()} (disponível desde Python 3.9). Para compatibilidade com versões anteriores, esta macro pode ser usada:

@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

(Contribuição de Victor Stinner em bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
Uma vez que @ref{782,,Py_SIZE()} é alterada para uma função estática inline, @code{Py_SIZE(obj) = new_size} deve ser substituído por @code{Py_SET_SIZE(obj, new_size)}: veja a função @ref{783,,Py_SET_SIZE()} (disponível desde Python 3.9). Para compatibilidade com versões anteriores, esta macro pode ser usada:

@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

(Contribuição de Victor Stinner em bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
@code{<Python.h>} não inclui mais os arquivos de cabeçalho @code{<stdlib.h>}, @code{<stdio.h>}, @code{<errno.h>} e @code{<string.h>} quando a macro @code{Py_LIMITED_API} é definida como @code{0x030b0000} (Python 3.11) ou superior. As extensões C devem incluir explicitamente os arquivos de cabeçalho após @code{#include <Python.h>}. (Contribuição de Victor Stinner em bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}.)

@item 
Os arquivos API não limitados @code{cellobject.h}, @code{classobject.h}, @code{code.h}, @code{context.h}, @code{funcobject.h}, @code{genobject.h} e @code{longintrepr.h} foram movidos para o diretório @code{Include/cpython}. Além disso, o arquivo de cabeçalho @code{eval.h} foi removido. Esses arquivos não devem ser incluídos diretamente, pois já estão incluídos aos @ref{784,,arquivos de inclusão} do @code{Python.h}. Se eles foram incluídos diretamente, considere incluir @code{Python.h} em seu lugar. (Contribuição de Victor Stinner em bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
A macro @code{PyUnicode_CHECK_INTERNED()} foi excluída da API C limitada. Nunca foi utilizável lá, porque usava estruturas internas que não estão disponíveis na API C limitada. (Contribuição de Victor Stinner em bpo-46007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46007}.)

@item 
As seguintes funções e tipo de quadro agora estão disponíveis diretamente com @code{#include <Python.h>}, não é mais necessário adicionar @code{#include <frameobject.h>}:


@itemize *

@item 
@ref{785,,PyFrame_Check()}

@item 
@ref{786,,PyFrame_GetBack()}

@item 
@ref{76b,,PyFrame_GetBuiltins()}

@item 
@ref{76c,,PyFrame_GetGenerator()}

@item 
@ref{76d,,PyFrame_GetGlobals()}

@item 
@ref{76e,,PyFrame_GetLasti()}

@item 
@ref{41f,,PyFrame_GetLocals()}

@item 
@ref{787,,PyFrame_Type}
@end itemize

(Contribuição de Victor Stinner em gh-93937@footnote{https://github.com/python/cpython/issues/93937}.)
@end itemize
@anchor{whatsnew/3 11 pyframeobject-3-11-hiding}@anchor{788}

@itemize *

@item 
Os membros da estrutura @ref{789,,PyFrameObject} foram removidos da API C pública.

Embora a documentação observe que os campos @ref{789,,PyFrameObject} estão sujeitos a alterações a qualquer momento, eles permaneceram estáveis por um longo tempo e foram usados em várias extensões populares.

No Python 3.11, a estrutura do quadro foi reorganizada para permitir otimizações de desempenho. Alguns campos foram totalmente removidos, pois eram detalhes da antiga implementação.

Campos do @ref{789,,PyFrameObject}:


@itemize *

@item 
@code{f_back}: use @ref{786,,PyFrame_GetBack()}.

@item 
@code{f_blockstack}: removido.

@item 
@code{f_builtins}: use @ref{76b,,PyFrame_GetBuiltins()}.

@item 
@code{f_code}: use @ref{78a,,PyFrame_GetCode()}.

@item 
@code{f_gen}: use @ref{76c,,PyFrame_GetGenerator()}.

@item 
@code{f_globals}: use @ref{76d,,PyFrame_GetGlobals()}.

@item 
@code{f_iblock}: removido.

@item 
@code{f_lasti}: use @ref{76e,,PyFrame_GetLasti()}. Código usando @code{f_lasti} com @code{PyCode_Addr2Line()} deve usar @ref{78b,,PyFrame_GetLineNumber()}, pois deve ser mais rápido.

@item 
@code{f_lineno}: use @ref{78b,,PyFrame_GetLineNumber()}

@item 
@code{f_locals}: use @ref{41f,,PyFrame_GetLocals()}.

@item 
@code{f_stackdepth}: removido.

@item 
@code{f_state}: nenhuma API pública (renomeado para @code{f_frame.f_state}).

@item 
@code{f_trace}: nenhuma API pública.

@item 
@code{f_trace_lines}: use @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_lines")}.

@item 
@code{f_trace_opcodes}: use @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_opcodes")}.

@item 
@code{f_localsplus}: nenhuma API pública (renomeado para @code{f_frame.localsplus}).

@item 
@code{f_valuestack}: removido.
@end itemize

O objeto quadro do Python agora é criado de forma “preguiçosa” (`lazy'). Um efeito colateral é que o membro @ref{78c,,f_back} não deve ser acessado diretamente, já que seu valor agora também é calculado de forma “preguiçosa”. A função @ref{786,,PyFrame_GetBack()} deve ser chamada em seu lugar.

Depuradores que acessam @ref{182,,f_locals} diretamente `devem' chamar @ref{41f,,PyFrame_GetLocals()}. Eles não precisam mais chamar @code{PyFrame_FastToLocalsWithError()} ou @code{PyFrame_LocalsToFast()}. Na verdade, eles não devem chamar essas funções. A atualização necessária do quadro agora é gerenciada pela máquina virtual.

Código definindo @code{PyFrame_GetCode()} no Python 3.8 e 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 definindo @code{PyFrame_GetBack()} no Python 3.8 e 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

Ou use o projeto pythoncapi_compat@footnote{https://github.com/python/pythoncapi-compat} para obter essas duas funções em versões mais antigas do Python.

@item 
Mudanças nos membros da estrutura @ref{78d,,PyThreadState}:


@itemize *

@item 
@code{frame}: removido, use @ref{78e,,PyThreadState_GetFrame()} (função adicionada ao Python 3.9 por bpo-40429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40429}). Aviso: a função retorna um @ref{33d,,referência forte}, precisa chamar @ref{78f,,Py_XDECREF()}.

@item 
@code{tracing}: alterado, use @ref{754,,PyThreadState_EnterTracing()} e @ref{755,,PyThreadState_LeaveTracing()} (funções adicionadas ao Python 3.11 por bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}).

@item 
@code{recursion_depth}: removido, use @code{(tstate->recursion_limit - tstate->recursion_remaining)}.

@item 
@code{stackcheck_counter}: removido.
@end itemize

Código definindo @code{PyThreadState_GetFrame()} no Python 3.8 e 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 definindo @code{PyThreadState_EnterTracing()} e @code{PyThreadState_LeaveTracing()} no Python 3.10 e 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

Ou use o projeto pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat} para obter essas funções em funções antigas do Python.

@item 
Os distribuidores são encorajados a compilar o Python com a biblioteca Blake2 otimizada libb2@footnote{https://www.blake2.net/}.

@item 
O campo @ref{5ef,,PyConfig.module_search_paths_set} agora deve ser definido como 1 para inicialização para usar @ref{3a2,,PyConfig.module_search_paths} para inicializar @ref{3b4,,sys.path}. Caso contrário, a inicialização recalculará o caminho e substituirá quaisquer valores adicionados a @code{module_search_paths}.

@item 
@ref{790,,PyConfig_Read()} não calcula mais o caminho de pesquisa inicial e não preencherá nenhum valor em @ref{3a2,,PyConfig.module_search_paths}. Para calcular caminhos padrão e modificá-los, termine a inicialização e use @ref{389,,PySys_GetObject()} para recuperar @ref{3b4,,sys.path} como um objeto lista do Python e modifique-o diretamente.
@end itemize

@node Descontinuados<4>,Pendente remoção no Python 3 12<2>,Portando para Python 3 11<2>,Alterações na API C<5>
@anchor{whatsnew/3 11 id7}@anchor{791}@anchor{whatsnew/3 11 whatsnew311-c-api-deprecated}@anchor{717}
@subsubsection Descontinuados



@itemize *

@item 
Descontinua as seguintes funções para configurar a inicialização do 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

Em vez disso, use a nova API @ref{3a6,,PyConfig} da @ref{3a7,,Configuração de Inicialização do Python} (
@geindex Propostas de Melhorias do Python; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}). (Contribuição de Victor Stinner em gh-88279@footnote{https://github.com/python/cpython/issues/88279}.)

@item 
Descontinua o membro @code{ob_shash} do @ref{792,,PyBytesObject}. Use @ref{403,,PyObject_Hash()} em vez disso. (Contribuição de Inada Naoki em bpo-46864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46864}.)
@end itemize

@node Pendente remoção no Python 3 12<2>,Removidos<4>,Descontinuados<4>,Alterações na API C<5>
@anchor{whatsnew/3 11 id8}@anchor{793}@anchor{whatsnew/3 11 whatsnew311-c-api-pending-removal}@anchor{729}
@subsubsection Pendente remoção no Python 3.12


As seguintes APIs C foram descontinuadas em versões anteriores do Python e serão removidas no 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{401,,PyUnicode_READY()}

@item 
@code{PyUnicode_WSTR_LENGTH()}

@item 
@code{_PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_WCHAR_KIND}

@item 
@ref{794,,PyUnicodeObject}

@item 
@code{PyUnicode_InternImmortal()}
@end itemize

@node Removidos<4>,,Pendente remoção no Python 3 12<2>,Alterações na API C<5>
@anchor{whatsnew/3 11 id9}@anchor{795}@anchor{whatsnew/3 11 whatsnew311-c-api-removed}@anchor{730}
@subsubsection Removidos



@itemize *

@item 
@code{PyFrame_BlockSetup()} e @code{PyFrame_BlockPop()} foram removidas. (Contribuição de Mark Shannon em bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}.)

@item 
Remove as seguintes macros matemáticas usando a variável @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

(Contribuição de Victor Stinner em bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}.)

@item 
Remove as macros @code{Py_UNICODE_COPY()} e @code{Py_UNICODE_FILL()}, descontinuadas desde o Python 3.3. Use @code{PyUnicode_CopyCharacters()} ou @code{memcpy()} (string @code{wchar_t*}) e as funções @code{PyUnicode_Fill()}. (Contribuição de Victor Stinner em bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}.)

@item 
Remove o arquivo de cabeçalho @code{pystrhex.h}. Ele contém apenas funções privadas. As extensões C devem incluir apenas o arquivo principal @code{<Python.h>}. (Contribuição de Victor Stinner em bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}.)

@item 
Remove a macro @code{Py_FORCE_DOUBLE()}. Era usada pela macro @code{Py_IS_INFINITY()}. (Contribuição de Victor Stinner em bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}.)

@item 
Os seguintes itens não estão mais disponíveis quando @ref{41e,,Py_LIMITED_API} é definida:


@itemize *

@item 
@ref{796,,PyMarshal_WriteLongToFile()}

@item 
@ref{797,,PyMarshal_WriteObjectToFile()}

@item 
@ref{798,,PyMarshal_ReadObjectFromString()}

@item 
@ref{799,,PyMarshal_WriteObjectToString()}

@item 
a macro @code{Py_MARSHAL_VERSION}
@end itemize

Eles não fazem parte da @ref{79a,,API limitada}.

(Contribuição de Victor Stinner em bpo-45474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45474}.)

@item 
Exclui @ref{3bf,,PyWeakref_GET_OBJECT()} da API C limitada. Nunca funcionou porque a estrutura @code{PyWeakReference} é opaca na API C limitada. (Contribuição de Victor Stinner em bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
Remove a macro @code{PyHeapType_GET_MEMBERS()}. Estava exposta na API C pública por engano, deve ser usada apenas pelo Python internamente. Em vez disso, use o membro @code{PyTypeObject.tp_members}. (Contribuição de Victor Stinner em bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}.)

@item 
Remove a macro @code{HAVE_PY_SET_53BIT_PRECISION} (movida para a API C interna). (Contribuição de Victor Stinner em bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}.)
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pep624}@anchor{5ad}

@itemize *

@item 
Remove as APIs de codificação @ref{3ed,,Py_UNICODE}, pois foram descontinuadas desde o Python 3.3, são pouco usadas e ineficientes em relação às alternativas recomendadas.

As funções removidas são:


@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

Veja a 
@geindex Propostas de Melhorias do Python; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/} para detalhes e 
@geindex Propostas de Melhorias do Python; PEP 624#alternative-apis
orientação sobre migração@footnote{https://peps.python.org/pep-0624/#alternative-apis}. (Contribuição de Inada Naoki em bpo-44029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44029}.)
@end itemize

@node Alterações notáveis no 3 11 4,Alterações notáveis no 3 11 5,Alterações na API C<5>,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 notable-changes-in-3-11-4}@anchor{79b}
@subsection Alterações notáveis no 3.11.4


@menu
* tarfile: tarfile<2>. 

@end menu

@node tarfile<2>,,,Alterações notáveis no 3 11 4
@anchor{whatsnew/3 11 tarfile}@anchor{79c}
@subsubsection tarfile



@itemize *

@item 
Os métodos de extração em @ref{de,,tarfile} e @ref{46b,,shutil.unpack_archive()}, têm um novo argumento `filter' que permite limitar recursos do tar que podem ser surpreendentes ou perigosos, como criar arquivos fora do diretório de destino. Veja @ref{46c,,Filtros de extração} para detalhes. No Python 3.12, usar sem o argumento `filter' mostrará um @ref{1a5,,DeprecationWarning}. No Python 3.14, o padrão mudará para @code{'data'}. (Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node Alterações notáveis no 3 11 5,,Alterações notáveis no 3 11 4,O que há de novo no Python 3 11
@anchor{whatsnew/3 11 notable-changes-in-3-11-5}@anchor{79d}
@subsection Alterações notáveis no 3.11.5


@menu
* OpenSSL:: 

@end menu

@node OpenSSL,,,Alterações notáveis no 3 11 5
@anchor{whatsnew/3 11 openssl}@anchor{79e}
@subsubsection OpenSSL



@itemize *

@item 
Construções do Windows e instaladores do macOS em python.org agora usam OpenSSL 3.0.
@end itemize

@node O que há de novo no Python 3 10,O que há de novo no Python 3 9,O que há de novo no Python 3 11,O que há de novo no Python
@anchor{whatsnew/3 10 doc}@anchor{79f}@anchor{whatsnew/3 10 translation-repo}@anchor{7a0}@anchor{whatsnew/3 10 what-s-new-in-python-3-10}@anchor{7a1}
@section O que há de novo no 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 artigo explica os novos recursos no Python 3.10, em comparação com 3.9. Python 3.10 foi lançado em 4 de outubro de 2021. Veja @ref{13c,,changelog} para uma lista completa de mudanças.

@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<4>. 
* Novas funcionalidades: Novas funcionalidades<7>. 
* Novos recursos relacionados a dicas de tipo: Novos recursos relacionados a dicas de tipo<3>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<4>. 
* Novos módulos: Novos módulos<4>. 
* Módulos melhorados: Módulos melhorados<4>. 
* Otimizações: Otimizações<4>. 
* Descontinuados: Descontinuados<5>. 
* Removidos: Removidos<5>. 
* Portando para Python 3.10: Portando para Python 3 10. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<4>. 
* Mudanças na construção: Mudanças na construção<4>. 
* Alterações na API C: Alterações na API C<7>. 
* Recursos de segurança notáveis no 3.10.7: Recursos de segurança notáveis no 3 10 7. 
* Recursos de segurança notáveis no 3.10.8: Recursos de segurança notáveis no 3 10 8. 
* Alterações notáveis no 3.10.12: Alterações notáveis no 3 10 12. 

@end menu

@node Resumo – Destaques da versão<4>,Novas funcionalidades<7>,,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 summary-release-highlights}@anchor{7a2}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.10.
@c Brevity is key.

@c PEP-sized items next.

Novos recursos de sintaxe:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}, Correspondência de padrão estrutural: especificação

@item 
@geindex Propostas de Melhorias do Python; PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}, Correspondência de padrão estrutural: motivação e justificativa

@item 
@geindex Propostas de Melhorias do Python; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}, Correspondência de padrão estrutural: Tutorial

@item 
bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782}, Gerenciadores de contexto entre parênteses agora são permitidos oficialmente.
@end itemize

Novos recursos na biblioteca padrão:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}, Adiciona verificação de comprimento opcional ao zip.
@end itemize

Melhorias no interpretador:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}, Números de linha precisos para depuração e outras ferramentas.
@end itemize

Novos recursos de tipagem:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/}, Permite escrever tipos de união como X | Y

@item 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}, Variáveis de especificação de parâmetro

@item 
@geindex Propostas de Melhorias do Python; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}, Apelidos de tipo explícitos

@item 
@geindex Propostas de Melhorias do Python; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}, Guardas de Tipo Definidas Pelo Usuário
@end itemize

Descontinuações, remoções ou restrições importantes:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}, Exige OpenSSL 1.1.1 ou mais novo

@item 
@geindex Propostas de Melhorias do Python; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}, Descontinua o módulo distutils.

@item 
@geindex Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}, Descontinua e prepara para a remoção do membro wstr em PyUnicodeObject.

@item 
@geindex Propostas de Melhorias do Python; PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}, Remove APIs codificadoras de Py_UNICODE

@item 
@geindex Propostas de Melhorias do Python; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}, Adiciona EncodingWarning opcional
@end itemize

@node Novas funcionalidades<7>,Novos recursos relacionados a dicas de tipo<3>,Resumo – Destaques da versão<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 new-features}@anchor{7a3}
@subsection Novas funcionalidades


@menu
* Gerenciadores de contexto entre parênteses:: 
* Melhores mensagens de erro:: 
* PEP 626; Números de linha precisos para depuração e outras ferramentas: PEP 626 Números de linha precisos para depuração e outras ferramentas. 
* PEP 634; Correspondência de padrão estrutural: PEP 634 Correspondência de padrão estrutural. 
* EncodingWarning opcional e opção encoding="locale":: 

@end menu

@node Gerenciadores de contexto entre parênteses,Melhores mensagens de erro,,Novas funcionalidades<7>
@anchor{whatsnew/3 10 parenthesized-context-managers}@anchor{7a4}@anchor{whatsnew/3 10 whatsnew310-pep563}@anchor{7a5}
@subsubsection Gerenciadores de contexto entre parênteses


O uso de parênteses para continuação em várias linhas em gerenciadores de contexto agora é suportado. Isso permite a formatação de uma longa coleção de gerenciadores de contexto em várias linhas de maneira semelhante à que era possível anteriormente com instruções de importação. Por exemplo, todos esses exemplos agora são válidos:

@example
with (CtxManager() as exemplo):
    ...

with (
    CtxManager1(),
    CtxManager2()
):
    ...

with (CtxManager1() as exemplo,
      CtxManager2()):
    ...

with (CtxManager1(),
      CtxManager2() as exemplo):
    ...

with (
    CtxManager1() as exemplo1,
    CtxManager2() as exemplo2
):
    ...
@end example

também é possível usar uma vírgula no final do grupo fechado:

@example
with (
    CtxManager1() as exemplo1,
    CtxManager2() as exemplo2,
    CtxManager3() as exemplo3,
):
    ...
@end example

Esta nova sintaxe usa as capacidades não LL(1) do novo analisador sintático. Confira 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} para mais detalhes.

(Contribuição de Guido van Rossum, Pablo Galindo e Lysandros Nikolaou em bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782} e bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}.)

@node Melhores mensagens de erro,PEP 626 Números de linha precisos para depuração e outras ferramentas,Gerenciadores de contexto entre parênteses,Novas funcionalidades<7>
@anchor{whatsnew/3 10 better-error-messages}@anchor{7a6}
@subsubsection Melhores mensagens de erro


@menu
* SyntaxErrors:: 
* IndentationErrors:: 
* AttributeErrors:: 
* NameErrors:: 

@end menu

@node SyntaxErrors,IndentationErrors,,Melhores mensagens de erro
@anchor{whatsnew/3 10 syntaxerrors}@anchor{7a7}
@subsubsection SyntaxErrors


Ao analisar o código que contém parênteses ou chaves não fechados, o interpretador agora inclui o local da chave não fechado de parênteses em vez de exibir `SyntaxError: unexpected EOF while parsing' ou apontando para algum local incorreto. Por exemplo, considere o seguinte código (observe o “@{” não fechado):

@example
esperado = @{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,
algum_outro_codigo = foo()
@end example

Versões anteriores do interpretador relatavam lugares confusos como local do erro de sintaxe:

@example
File "exemplo.py", line 3
    algum_outro_codigo = foo()
                       ^
SyntaxError: invalid syntax
@end example

mas no Python 3.10, um erro mais informativo é emitido:

@example
File "exemplo.py", line 1
    esperado = @{9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
               ^
SyntaxError: '@{' was never closed
@end example

De maneira semelhante, erros envolvendo literais de string não fechadas (entre aspas simples e triplas) agora apontam para o início da string em vez de relatar EOF/EOL.

Essas melhorias são inspiradas em trabalhos anteriores no interpretador PyPy.

(Contribuição de Pablo Galindo em bpo-42864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42864} e Batuhan Taskaya em bpo-40176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40176}.)

As exceções @ref{18d,,SyntaxError} levantadas pelo interpretador agora destacam o intervalo total de erros da expressão que constitui o próprio erro de sintaxe, em vez de apenas onde o problema foi detectado. Desta forma, em vez de exibir (antes do 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

agora o Python 3.10 vai exibir a exceção 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 melhoria foi contribuída por Pablo Galindo em bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}.

Uma quantidade considerável de novas mensagens especializadas para exceções @ref{18d,,SyntaxError} foram incorporadas. Alguns dos mais notáveis são os seguintes:


@itemize *

@item 
Faltando @code{:} antes de blocos:

@example
>>> if foguete.posicao > horizonte_evento
  File "<stdin>", line 1
    if foguete.posicao > horizonte_evento
                                        ^
SyntaxError: expected ':'
@end example

(Contribuição de Pablo Galindo em bpo-42997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42997}.)

@item 
Tuplas sem parênteses em alvos de compreensão:

@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

(Contribuição de Pablo Galindo em bpo-43017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43017}.)

@item 
Faltando vírgulas em literais de coleção e entre expressões:

@example
>>> items = @{
... x: 1,
... y: 2
... z: 3,
  File "<stdin>", line 3
    y: 2
       ^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

(Contribuição de Pablo Galindo em bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}.)

@item 
Vários tipos de exceção sem parênteses:

@example
>>> try:
...     construir_esfera_de_dyson()
... except NotEnoughScienceError, NotEnoughResourcesError:
  File "<stdin>", line 3
    except NotEnoughScienceError, NotEnoughResourcesError:
           ^
SyntaxError: multiple exception types must be parenthesized
@end example

(Contribuição de Pablo Galindo em bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}.)

@item 
Faltando @code{:} em valores em literais de dicionário:

@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

(Contribuição de Pablo Galindo em bpo-43823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43823}.)

@item 
Blocos @code{try} sem blocos @code{except} ou @code{finally}:

@example
>>> try:
...     x = 2
... algumacoisa = 3
  File "<stdin>", line 3
    algumacoisa = 3
    ^^^^^^^^^^^
SyntaxError: expected 'except' or 'finally' block
@end example

(Contribuição de Pablo Galindo em bpo-44305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44305}.)

@item 
Uso de @code{=} em vez de @code{==} nas comparações:

@example
>>> if foguete.posicao = horizonte_evento:
  File "<stdin>", line 1
    if foguete.posicao = horizonte_evento:
                       ^
SyntaxError: cannot assign to attribute here. Maybe you meant '==' instead of '='?
@end example

(Contribuição de Pablo Galindo em bpo-43797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43797}.)

@item 
Uso de @code{*} em f-strings:

@example
>>> f"Buracos negros @{*all_black_holes@} e revelações"
  File "<stdin>", line 1
    (*all_black_holes)
     ^
SyntaxError: f-string: cannot use starred expression here
@end example

(Contribuição de Pablo Galindo em bpo-41064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41064}.)
@end itemize

@node IndentationErrors,AttributeErrors,SyntaxErrors,Melhores mensagens de erro
@anchor{whatsnew/3 10 indentationerrors}@anchor{7a8}
@subsubsection IndentationErrors


Muitas exceções @ref{7a9,,IndentationError} agora têm mais contexto sobre que tipo de bloco estava esperando um indentação, incluindo a localização da instrução:

@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,IndentationErrors,Melhores mensagens de erro
@anchor{whatsnew/3 10 attributeerrors}@anchor{7aa}
@subsubsection AttributeErrors


Ao exibir @ref{34b,,AttributeError}, @code{PyErr_Display()} oferecerá sugestões de nomes de atributos semelhantes no objeto a partir do qual a exceção foi levantada:

@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

(Contribuição de Pablo Galindo em bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}.)

@cartouche
@quotation Aviso 
Observe que isso não funcionará se @code{PyErr_Display()} não for chamado para exibir o erro que pode ocorrer se alguma outra função personalizada de exibição de erro for usada. Este é um cenário comum em alguns REPLs, laços de leitura-avaliação-impressão, como o IPython.
@end quotation
@end cartouche

@node NameErrors,,AttributeErrors,Melhores mensagens de erro
@anchor{whatsnew/3 10 nameerrors}@anchor{7ab}
@subsubsection NameErrors


Ao exibir @ref{43f,,NameError} levantada pelo interpretador, @code{PyErr_Display()} irá oferecer sugestões de nomes de variáveis semelhantes na função de onde a exceção foi levantada:

@example
>>> buraco_negro_de_schwarzschild = None
>>> buraco_negro_de_schwarschild
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'buraco_negro_de_schwarschild' is not defined. Did you mean: buraco_negro_de_schwarzschild?
@end example

(Contribuição de Pablo Galindo em bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}.)

@cartouche
@quotation Aviso 
Observe que isso não funcionará se @code{PyErr_Display()} não for chamado para exibir o erro que pode ocorrer se alguma outra função personalizada de exibição de erro for usada. Este é um cenário comum em alguns REPLs, laços de leitura-avaliação-impressão, como o IPython.
@end quotation
@end cartouche

@node PEP 626 Números de linha precisos para depuração e outras ferramentas,PEP 634 Correspondência de padrão estrutural,Melhores mensagens de erro,Novas funcionalidades<7>
@anchor{whatsnew/3 10 pep-626-precise-line-numbers-for-debugging-and-other-tools}@anchor{7ac}
@subsubsection PEP 626: Números de linha precisos para depuração e outras ferramentas


O PEP 626 traz números de linha mais precisos e confiáveis para ferramentas de depuração, criação de perfil e cobertura. Eventos de rastreamento, com o número de linha correto, são gerados para todas as linhas de código executadas e apenas para linhas de código que são executadas.

O atributo @ref{7ad,,f_lineno} de objetos de quadro sempre conterá o número de linha esperado.

O atributo @ref{2e0,,co_lnotab} @ref{1d2,,code objects} foi descontinuado e será removido no 3.12. O código que precisa ser convertido do deslocamento para o número da linha deve usar o novo método @ref{2fb,,co_lines()}.

@node PEP 634 Correspondência de padrão estrutural,EncodingWarning opcional e opção encoding="locale",PEP 626 Números de linha precisos para depuração e outras ferramentas,Novas funcionalidades<7>
@anchor{whatsnew/3 10 pep-634-structural-pattern-matching}@anchor{7ae}
@subsubsection PEP 634: Correspondência de padrão estrutural


A correspondência de padrão estrutural foi adicionada na forma de uma `instrução de correspondência' e `instruções de caso' de padrões com ações associadas. Os padrões consistem em sequências, mapeamentos, tipos de dados primitivos, bem como instâncias de classe. A correspondência de padrão permite que os programas extraiam informações de tipos de dados complexos, ramifiquem na estrutura de dados e apliquem ações específicas com base em diferentes formas de dados.

@menu
* Sintaxe e operações:: 
* Abordagem declarativa:: 
* Padrão simples; corresponder a um literal: Padrão simples corresponder a um literal. 
* Padrões com uma literal e variável:: 
* Padrões e classes:: 
* Padrões aninhados:: 
* Padrões complexos e o curinga:: 
* Guarda:: 
* Outros recursos-chave:: 

@end menu

@node Sintaxe e operações,Abordagem declarativa,,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 syntax-and-operations}@anchor{7af}
@subsubsection Sintaxe e operações


A sintaxe genérica da correspondência de padrão é:

@example
match sujeito:
    case <padrão_1>:
        <ação_1>
    case <padrão_2>:
        <ação_2>
    case <padrão_3>:
        <ação_3>
    case _:
        <ação_curinga>
@end example

Uma instrução de correspondência pega uma expressão e compara seu valor com padrões sucessivos fornecidos como um ou mais blocos de caso. Especificamente, a correspondência de padrões opera:


@enumerate 

@item 
usando dados com tipo e forma (o @code{sujeito})

@item 
avaliando o @code{sujeito} na instrução @code{match}

@item 
comparando o assunto com cada padrão em uma instrução @code{case} de cima para baixo até que uma correspondência seja confirmada.

@item 
executando a ação associada ao padrão da correspondência confirmada

@item 
Se uma correspondência exata não for confirmada, no último caso, um curinga @code{_}, se fornecido, será usado como o caso de correspondência. Se uma correspondência exata não for confirmada e não houver um caractere curinga, todo o bloco de correspondência será autônomo.
@end enumerate

@node Abordagem declarativa,Padrão simples corresponder a um literal,Sintaxe e operações,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 declarative-approach}@anchor{7b0}
@subsubsection Abordagem declarativa


Os leitores podem estar cientes da correspondência de padrão por meio do exemplo simples de correspondência de um assunto (objeto de dados) a um literal (padrão) com a instrução switch encontrada em C, Java ou JavaScript (e muitas outras linguagens). Frequentemente, a instrução switch é usada para comparação de um objeto/expressão com instruções case contendo literais.

Exemplos mais poderosos de correspondência de padrão podem ser encontrados em linguagens como Scala e Elixir. Com a correspondência de padrão estrutural, a abordagem é “declarativa” e declara explicitamente as condições (os padrões) para que os dados correspondam.

Embora uma série “imperativa” de instruções usando instruções “if” aninhadas possa ser usada para realizar algo semelhante à correspondência de padrão estrutural, é menos clara do que a abordagem “declarativa”. Em vez disso, a abordagem “declarativa” estabelece as condições a serem atendidas para uma correspondência e é mais legível por meio de seus padrões explícitos. Embora a correspondência de padrão estrutural possa ser usada em sua forma mais simples comparando uma variável a um literal em uma instrução case, seu verdadeiro valor para Python reside em seu tratamento do tipo e forma do sujeito.

@node Padrão simples corresponder a um literal,Padrões com uma literal e variável,Abordagem declarativa,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 simple-pattern-match-to-a-literal}@anchor{7b1}
@subsubsection Padrão simples: corresponder a um literal


Vejamos este exemplo como correspondência de padrão em sua forma mais simples: um valor, o assunto, sendo correspondido a vários literais, os padrões. No exemplo abaixo, @code{status} é o assunto da instrução de correspondência. Os padrões são cada uma das instruções de caso, onde literais representam códigos de status de solicitação. A ação associada ao caso é executada após uma partida:

@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

Se a função acima receber um @code{status} de 418, “I’m a teapot” será retornado. Se a função acima receber um @code{status} de 500, a instrução case com @code{_} irá corresponder a um curinga, e “Something’s wrong with the Internet” é retornado. Observe o último bloco: o nome da variável, @code{_}, atua como um `curinga' e garante que o assunto sempre corresponderá. O uso de @code{_} é opcional.

Você pode combinar vários literais em um único padrão usando @code{|} (“ou”):

@example
case 401 | 403 | 404:
    return "Não permitido"
@end example

@menu
* Comportamento sem o curinga:: 

@end menu

@node Comportamento sem o curinga,,,Padrão simples corresponder a um literal
@anchor{whatsnew/3 10 behavior-without-the-wildcard}@anchor{7b2}
@subsubsection Comportamento sem o curinga


Se modificarmos o exemplo acima removendo o último bloco case, o exemplo se tornará:

@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

Sem o uso de @code{_} em uma instrução case, uma correspondência pode não existir. Se não houver correspondência, o comportamento é autônomo. Por exemplo, se o @code{status} de 500 for passado, ocorre um no-op.

@node Padrões com uma literal e variável,Padrões e classes,Padrão simples corresponder a um literal,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 patterns-with-a-literal-and-variable}@anchor{7b3}
@subsubsection Padrões com uma literal e variável


Os padrões podem parecer atribuições de desempacotamento e um padrão pode ser usado para vincular variáveis. Neste exemplo, um ponto de dados pode ser desempacotado em sua coordenada x e coordenada y:

@example
# ponto é uma tupla (x, y)
match ponto:
    case (0, 0):
        print("Origem")
    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("Não é um ponto")
@end example

O primeiro padrão tem dois literais, @code{(0, 0)}, e pode ser considerado uma extensão do padrão literal mostrado acima. Os próximos dois padrões combinam um literal e uma variável, e a variável `vincula' um valor do assunto (@code{ponto}). O quarto padrão captura dois valores, o que o torna conceitualmente semelhante à atribuição de desempacotamento @code{(x, y) = ponto}.

@node Padrões e classes,Padrões aninhados,Padrões com uma literal e variável,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 patterns-and-classes}@anchor{7b4}
@subsubsection Padrões e classes


Se estiver usando classes para estruturar seus dados, você pode usar como padrão o nome da classe seguido por uma lista de argumentos semelhante a um construtor. Este padrão tem a capacidade de capturar atributos da instância em variáveis:

@example
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

def location(point):
    match point:
        case Point(x=0, y=0):
           print("O ponto está na origem.")
        case Point(x=0, y=y):
           print(f "Y=@{y@} e o ponto está no eixo y.")
        case Point(x=x, y=0):
           print(f "X=@{x@} e o ponto está no eixo x.")
        case Point():
           print("O ponto está localizado em outro lugar no plano.")
        case _:
           print("Não é um ponto")
@end example

@menu
* Padrões com parâmetros posicionais:: 

@end menu

@node Padrões com parâmetros posicionais,,,Padrões e classes
@anchor{whatsnew/3 10 patterns-with-positional-parameters}@anchor{7b5}
@subsubsection Padrões com parâmetros posicionais


Você pode usar parâmetros posicionais com algumas classes embutidas que fornecem uma ordem para seus atributos (por exemplo, classes de dados). Você também pode definir uma posição específica para atributos em padrões configurando o atributo especial @code{__match_args__} em suas classes. Se for definido como (“x”, “y”), os seguintes padrões são todos equivalentes (e todos ligam o atributo @code{y} à variável @code{var}):

@example
Ponto(1, var)
Ponto(1, y=var)
Ponto(x=1, y=var)
Ponto(y=var, x=1)
@end example

@node Padrões aninhados,Padrões complexos e o curinga,Padrões e classes,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 nested-patterns}@anchor{7b6}
@subsubsection Padrões aninhados


Os padrões podem ser aninhados arbitrariamente. Por exemplo, se nossos dados forem uma pequena lista de pontos, eles podem ser correspondidos assim:

@example
match points:
    case []:
        print("Nenhum ponto na lista.")
    case [Point(0, 0)]:
        print("A origem é o único ponto na lista.")
    case [Point(x, y)]:
        print(f"Um único ponto @{x@}, @{y@} está na lista.")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Dois pontos no eixo Y em @{y1@}, @{y2@} estão na lista.")
    case _:
        print("Algo diferente foi encontrado na lista.")
@end example

@node Padrões complexos e o curinga,Guarda,Padrões aninhados,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 complex-patterns-and-the-wildcard}@anchor{7b7}
@subsubsection Padrões complexos e o curinga


Até este ponto, os exemplos usaram @code{_} sozinho na última instrução case. Um curinga pode ser usado em padrões mais complexos, como @code{('error', code, _)}. Por exemplo:

@example
match test_variable:
    case ('warning', code, 40):
        print("Foi recebido um alerta.")
    case ('error', code, _):
        print(f"Ocorreu um erro @{code@}.")
@end example

No caso acima, @code{test_variable} irá corresponder a (‘erro’, código, 100) e (‘erro’, código, 800).

@node Guarda,Outros recursos-chave,Padrões complexos e o curinga,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 guard}@anchor{7b8}
@subsubsection Guarda


Podemos adicionar uma cláusula @code{if} a um padrão, conhecido como “guarda”. Se a guarda for falsa, @code{match} tenta o próximo bloco de caso. Observe que a captura de valor ocorre antes que a guarda seja avaliada:

@example
match point:
    case Point(x, y) if x == y:
        print(f"O ponto está localizado em uma diagonal Y=X at @{x@}.")
    case Point(x, y):
        print(f"Ponto não está na diagonal.")
@end example

@node Outros recursos-chave,,Guarda,PEP 634 Correspondência de padrão estrutural
@anchor{whatsnew/3 10 other-key-features}@anchor{7b9}
@subsubsection Outros recursos-chave


Vários outros recursos-chave:


@itemize -

@item 
Assim como desempacotar atribuições, os padrões de tupla e lista têm exatamente o mesmo significado e realmente correspondem a sequências arbitrárias. Tecnicamente, o sujeito deve ser uma sequência. Portanto, uma exceção importante é que padrões não correspondem a iteradores. Também evita um erro comum, sequência de padrões não correspondem a strings.

@item 
Os padrões de sequência têm suporte a curingas: @code{[x, y, *rest]} e @code{(x, y, *rest)} funcionam de forma semelhante a curingas em desempacotamentos de atribuições. O nome depois de @code{*} também pode ser @code{_}, então @code{(x, y, *_)} corresponde a uma sequência de pelo menos dois itens sem ligar os itens restantes.

@item 
Padrões de mapeamento: @code{@{"bandwidth": b, "latency": l@}} captura os valores @code{"bandwidth"} e @code{"latency"} de um dicionário. Diferente dos padrões de sequência, chaves extra são ignoradas.  Um curinga @code{**rest} também é permitido.  (Mas @code{**_} seria redundante, então não é permitido.)

@item 
Subpadrões podem ser capturados usando a palavra reservada @code{as}

@example
case (Ponto(x1, y1), Ponto(x2, y2) as p2): ...
@end example

Isso liga x1, y1, x2, y2 como você esperaria sem a cláusula @code{as} e p2 a todo o segundo item do sujeito.

@item 
A maioria dos literais são comparados por igualdade. No entanto, os singletons @code{True}, @code{False} e @code{None} são comparados por identidade.

@item 
Constantes nomeadas podem ser usadas em padrões. Essas constantes nomeadas devem ser nomes pontilhados para evitar que a constante seja interpretada como uma variável 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("Eu vejo vermelho!")
    case Color.GREEN:
        print("A grama é verde")
    case Color.BLUE:
        print("Eu azul de fome :(")
@end example
@end itemize

Para obter as especificações completas, consulte a 
@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}. A motivação e o raciocínio estão na 
@geindex Propostas de Melhorias do Python; PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}, e um tutorial mais longo está na 
@geindex Propostas de Melhorias do Python; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}.

@node EncodingWarning opcional e opção encoding="locale",,PEP 634 Correspondência de padrão estrutural,Novas funcionalidades<7>
@anchor{whatsnew/3 10 optional-encodingwarning-and-encoding-locale-option}@anchor{7ba}@anchor{whatsnew/3 10 whatsnew310-pep597}@anchor{7bb}
@subsubsection @code{EncodingWarning} opcional e opção @code{encoding="locale"}


A codificação padrão de @ref{7bc,,TextIOWrapper} e @ref{51c,,open()} depende da plataforma e da localidade. Como o UTF-8 é usado na maioria das plataformas Unix, omitir a opção @code{encoding} ao abrir arquivos UTF-8 (por exemplo, JSON, YAML, TOML, Markdown) é um bug muito comum. Por exemplo:

@example
# BUG: mode "rb" ou encoding="utf-8" deve ser usado.
with open("data.json") as f:
    data = json.load(f)
@end example

Para encontrar este tipo de bug, uma @code{EncodingWarning} opcional é adicionada. É emitido quando @ref{68c,,sys.flags.warn_default_encoding} é verdadeiro e a codificação padrão específica da localidade é usada.

A opção @code{-X warn_default_encoding} e 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variável de ambiente; PYTHONWARNDEFAULTENCODING
@ref{7bd,,PYTHONWARNDEFAULTENCODING} são adicionadas para ativar o aviso.

Veja @ref{7be,,Codificação do texto} para mais informações.

@node Novos recursos relacionados a dicas de tipo<3>,Outras mudanças na linguagem<4>,Novas funcionalidades<7>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 new-feat-related-type-hints}@anchor{7bf}@anchor{whatsnew/3 10 new-features-related-to-type-hints}@anchor{7c0}
@subsection Novos recursos relacionados a dicas de tipo


Esta seção cobre as principais mudanças que afetam as dicas de tipo da  
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e o módulo @ref{104,,typing}.

@menu
* PEP 604; novo operador de união de tipo: PEP 604 novo operador de união de tipo. 
* PEP 612; variáveis de especificação de parâmetros: PEP 612 variáveis de especificação de parâmetros. 
* PEP 613; TypeAlias: PEP 613 TypeAlias. 
* PEP 647; guardas de tipo definidas pelo usuário: PEP 647 guardas de tipo definidas pelo usuário. 

@end menu

@node PEP 604 novo operador de união de tipo,PEP 612 variáveis de especificação de parâmetros,,Novos recursos relacionados a dicas de tipo<3>
@anchor{whatsnew/3 10 pep-604-new-type-union-operator}@anchor{7c1}
@subsubsection PEP 604: novo operador de união de tipo


Um novo operador de união de tipo foi introduzido, o que permite a sintaxe @code{X | Y}. Isso fornece uma maneira mais limpa de expressar “tanto o tipo X quanto o tipo Y” ao invés de usar @ref{63b,,typing.Union}, especialmente em dicas de tipo.

Nas versões anteriores do Python, para aplicar uma dica de tipo para funções que aceitam argumentos de vários tipos, era usado @ref{63b,,typing.Union}:

@example
def square(number: Union[int, float]) -> Union[int, float]:
    return number ** 2
@end example

As dicas de tipo agora podem ser escritas de uma maneira mais sucinta:

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

Esta nova sintaxe também é aceita como o segundo argumento para @ref{442,,isinstance()} e @ref{7c2,,issubclass()}:

@example
>>> isinstance(1, int | str)
True
@end example

Veja @ref{7c3,,Tipo União} e 
@geindex Propostas de Melhorias do Python; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} para mais detalhes.

(Contribuição de Maggie Moss e Philippe Prados em bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}, com acréscimos por Yurii Karabas e Serhiy Storchaka em bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}.)

@node PEP 612 variáveis de especificação de parâmetros,PEP 613 TypeAlias,PEP 604 novo operador de união de tipo,Novos recursos relacionados a dicas de tipo<3>
@anchor{whatsnew/3 10 pep-612-parameter-specification-variables}@anchor{7c4}
@subsubsection PEP 612: variáveis de especificação de parâmetros


Duas novas opções para melhorar as informações fornecidas para verificadores de tipo estático para @code{Callable} da 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} foram adicionadas ao módulo @ref{104,,typing}.

A primeira é a variável de especificação de parâmetro. Eles são usados para encaminhar os tipos de parâmetro de um chamável para outro chamável – um padrão comumente encontrado em funções de ordem superior e decoradores. Exemplos de uso podem ser encontrados em @ref{15e,,typing.ParamSpec}. Anteriormente, não havia uma maneira fácil de digitar a dependência de anotação de tipos de parâmetro de maneira tão precisa.

A segunda opção é o novo operador @code{Concatenate}. É usado em conjunto com variáveis de especificação de parâmetro para digitar anotar um chamável de ordem superior que adiciona ou remove parâmetros de outro chamável. Exemplos de uso podem ser encontrados em @ref{7c5,,typing.Concatenate}.

Veja @ref{7c6,,typing.Callable}, @ref{15e,,typing.ParamSpec}, @ref{7c5,,typing.Concatenate}, @ref{7c7,,typing.ParamSpecArgs}, @ref{7c8,,typing.ParamSpecKwargs} e 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para mais detalhes.

(Contribuição de Ken Jin em bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}, com pequenas melhorias por Jelle Zijlstra em bpo-43783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43783}. PEP escrita por Mark Mendoza.)

@node PEP 613 TypeAlias,PEP 647 guardas de tipo definidas pelo usuário,PEP 612 variáveis de especificação de parâmetros,Novos recursos relacionados a dicas de tipo<3>
@anchor{whatsnew/3 10 pep-613-typealias}@anchor{7c9}
@subsubsection PEP 613: TypeAlias


@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introduziu o conceito de apelidos de tipo, exigindo apenas que fossem atribuições não anotadas de nível superior. Essa simplicidade às vezes tornava difícil para os verificadores de tipo distinguirem entre apelidos de tipo e atribuições comuns, especialmente quando referências diretas ou tipos inválidos estavam envolvidos. Compare:

@example
StrCache = 'Cache[str]'  # um apelido de tipo
LOG_PREFIX = 'LOG[DEBUG]'  # uma constante do módulo
@end example

Agora o módulo @ref{104,,typing} tem um valor especial @ref{7ca,,TypeAlias} que permite declarar apelidos de tipo, mais explicitamente:

@example
StrCache: TypeAlias = 'Cache[str]'  # um apelido de tipo
LOG_PREFIX = 'LOG[DEBUG]'  # uma constante do módulo
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} para mais detalhes.

(Contribuição de Mikhail Golubev em bpo-41923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41923}.)

@node PEP 647 guardas de tipo definidas pelo usuário,,PEP 613 TypeAlias,Novos recursos relacionados a dicas de tipo<3>
@anchor{whatsnew/3 10 pep-647-user-defined-type-guards}@anchor{7cb}
@subsubsection PEP 647: guardas de tipo definidas pelo usuário


@ref{164,,TypeGuard} foi adicionado ao módulo @ref{104,,typing} para anotar funções de guarda de tipo e melhorar informações fornecidas a verificadores de tipo estático durante um estreitamento de tipo. Para mais informações, veja a documentação do @ref{164,,TypeGuard} e a 
@geindex Propostas de Melhorias do Python; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}.

(Contribuição de Ken Jin e Guido van Rossum em bpo-43766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43766}. PEP escrita por Eric Traut.)

@node Outras mudanças na linguagem<4>,Novos módulos<4>,Novos recursos relacionados a dicas de tipo<3>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 other-language-changes}@anchor{7cc}
@subsection Outras mudanças na linguagem



@itemize *

@item 
O tipo @ref{257,,int} tem um novo método @ref{7cd,,int.bit_count()}, retornando o número de unidades na expansão binária de um dado inteiro, também conhecido como contagem da população. (Contribuição de Niklas Fiekas em bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882}.)

@item 
As visualizações retornadas por @ref{7ce,,dict.keys()}, @ref{7cf,,dict.values()} e @ref{7d0,,dict.items()} agora têm um atributo @code{mapping} que fornece um objeto @ref{46d,,types.MappingProxyType} que envolve o dicionário original. (Contribuição de Dennis Sweeney em bpo-40890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40890}.)

@item 
@geindex Propostas de Melhorias do Python; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}: A função @ref{7d1,,zip()} agora tem um sinalizador opcional @code{strict}, usado para exigir que todos os iteráveis tenham um comprimento igual.

@item 
Funções embutidas e de extensão que recebem argumentos inteiros não aceitam mais @ref{29d,,Decimal}, @ref{1e7,,Fraction} e outros objetos que podem ser convertidos em inteiros apenas com uma perda (por exemplo, tem o método @ref{71c,,__int__()}, mas não tem o método @ref{71d,,__index__()}). (Contribuição de Serhiy Storchaka em bpo-37999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37999}.)

@item 
Se @ref{7d2,,object.__ipow__()} retorna @ref{7d3,,NotImplemented}, o operador vai corretamente recorrer ao @ref{7d4,,object.__pow__()} e @ref{7d5,,object.__rpow__()} como esperado. (Contribuição de Alex Shkop em bpo-38302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38302}.)

@item 
Expressões de atribuição agora podem ser usadas sem parênteses dentro de literais de conjuntos e compreensões de conjuntos, bem como em índices de sequência (mas não em fatias).

@item 
As funções têm um novo atributo @code{__builtins__} que é usado para procurar por símbolos embutidos quando uma função é executada, em vez de procurar em @code{__globals__['__builtins__']}. O atributo é inicializado a partir de @code{__globals__["__builtins__"]} se existir; do contrário, a partir dos embutidos atuais. (Contribuição de Mark Shannon em bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}.)

@item 
Duas novas funções embutidas – @ref{7d6,,aiter()} e @ref{7d7,,anext()} foram adicionadas para fornecer contrapartes assíncronas para @ref{7d8,,iter()} e @ref{7d9,,next()}, respectivamente. (Contribuição de Joshua Bronson, Daniel Pope e Justin Wang em bpo-31861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31861}.)

@item 
Métodos estáticos (@ref{416,,@@staticmethod}) e métodos de classe (@ref{166,,@@classmethod}) agora herdam os atributos de método (@code{__module__}, @code{__name__}, @code{__qualname__}, @code{__doc__}, @code{__annotations__}) e têm um novo atributo @code{__wrapped__} . Além disso, métodos estáticos são agora chamáveis como funções regulares. (Contribuição de Victor Stinner em bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}.)

@item 
Anotações para alvos complexos (tudo além de alvos de nome simples, ou @code{simple name}, definidos pela 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}) não causam mais nenhum efeito de tempo de execução com @code{from __future__ import annotations}. (Contribuição de Batuhan Taskaya em bpo-42737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42737}.)

@item 
Objetos classe e módulo agora criam preguiçosamente dados vazios de anotações sob demanda. Os dicionários de anotações são armazenados em @code{__dict__} do objeto para compatibilidade com versões anteriores. Isso melhora as melhores práticas para trabalhar com @code{__annotations__}; para mais informações, veja @ref{7da,,Boas práticas para anotações}. (Contribuição de Larry Hastings em bpo-43901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43901}.)

@item 
Anotações consistindo em @code{yield}, @code{yield from}, @code{await} ou expressões nomeadas agora são proibidas em @code{from __future__ import annotations} por causa de seus efeitos colaterais. (Contribuição de Batuhan Taskaya em bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}.)

@item 
O uso de variáveis não ligadas, @code{super()} e outras expressões que podem alterar o processamento da tabela de símbolos como anotações são agora processadas sem efeito sob @code{from __future__ import annotations}. (Contribuição de Batuhan Taskaya em bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}.)

@item 
Hashes de valores NaN de ambos os tipos @ref{2f7,,float} e @ref{29d,,decimal.Decimal} agora dependem da identidade do objeto. Anteriormente, eles sempre hash para @code{0} mesmo que os valores NaN não sejam iguais uns aos outros. Isso causou um comportamento de tempo de execução potencialmente quadrático devido a colisões de hash excessivas ao criar dicionários e conjuntos contendo vários NaNs. (Contribuição de Raymond Hettinger em bpo-43475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43475}.)

@item 
Uma @ref{18d,,SyntaxError} (ao invés de uma @ref{43f,,NameError}) será levantada ao excluir a constante @ref{7db,,__debug__}. (Contribuição de Donghee Na em bpo-45000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45000}.)

@item 
Exceções @ref{18d,,SyntaxError} agora possuem atributos @code{end_lineno} e @code{end_offset}. Eles serão @code{None} se não forem determinados. (Contribuição de Pablo Galindo em bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}.)
@end itemize

@node Novos módulos<4>,Módulos melhorados<4>,Outras mudanças na linguagem<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 new-modules}@anchor{7dc}
@subsection Novos módulos



@itemize *

@item 
Nenhum.
@end itemize

@node Módulos melhorados<4>,Otimizações<4>,Novos módulos<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 improved-modules}@anchor{7dd}
@subsection Módulos melhorados


@menu
* asyncio: asyncio<4>. 
* argparse: argparse<2>. 
* array: array<3>. 
* asynchat@comma{} asyncore@comma{} smtpd: asynchat asyncore smtpd. 
* base64: base64<2>. 
* bdb:: 
* bisect:: 
* codecs:: 
* collections.abc: collections abc. 
* contextlib: contextlib<2>. 
* curses:: 
* dataclasses: dataclasses<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* encodings:: 
* enum: enum<4>. 
* fileinput:: 
* faulthandler:: 
* gc:: 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac:: 
* IDLE e idlelib: IDLE e idlelib<2>. 
* importlib.metadata: importlib metadata<2>. 
* inspect: inspect<3>. 
* itertools: itertools<3>. 
* linecache:: 
* os: os<4>. 
* os.path: os path<4>. 
* pathlib: pathlib<5>. 
* platform: platform<2>. 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* shelve:: 
* statistics: statistics<3>. 
* site: site<2>. 
* socket: socket<2>. 
* ssl: ssl<3>. 
* sqlite3: sqlite3<5>. 
* sys: sys<5>. 
* _thread:: 
* threading: threading<3>. 
* traceback: traceback<3>. 
* types: types<3>. 
* typing: typing<5>. 
* unittest: unittest<5>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

@end menu

@node asyncio<4>,argparse<2>,,Módulos melhorados<4>
@anchor{whatsnew/3 10 asyncio}@anchor{7de}
@subsubsection asyncio


Adiciona o método @ref{7df,,connect_accepted_socket()} até então em falta. (Contribuição de Alex Grönholm em bpo-41332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41332}.)

@node argparse<2>,array<3>,asyncio<4>,Módulos melhorados<4>
@anchor{whatsnew/3 10 argparse}@anchor{7e0}
@subsubsection argparse


A frase enganosa “argumentos opcionais” foi substituída por “opções” na ajuda do argparse. Alguns testes podem exigir adaptação se eles dependerem da correspondência de saída exata. (Contribuição de Raymond Hettinger em bpo-9694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9694}.)

@node array<3>,asynchat asyncore smtpd,argparse<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 array}@anchor{7e1}
@subsubsection array


O método @ref{7e2,,index()} de @ref{1a0,,array.array} agora possui os parâmetros `start' e `stop'. (Contribuição de Anders Lorentsen e Zackery Spytz em bpo-31956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31956}.)

@node asynchat asyncore smtpd,base64<2>,array<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 asynchat-asyncore-smtpd}@anchor{7e3}
@subsubsection asynchat, asyncore, smtpd


Esses módulos foram marcados como descontinuados em sua documentação de módulo desde o Python 3.6. Uma exceção @ref{1a5,,DeprecationWarning} em tempo de importação agora foi adicionada a todos esses três módulos.

@node base64<2>,bdb,asynchat asyncore smtpd,Módulos melhorados<4>
@anchor{whatsnew/3 10 base64}@anchor{7e4}
@subsubsection base64


Adiciona @ref{7e5,,base64.b32hexencode()} e @ref{7e6,,base64.b32hexdecode()} para dar suporte a Codificação Base32 com alfabeto hexa estendido.

@node bdb,bisect,base64<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 bdb}@anchor{7e7}
@subsubsection bdb


Adiciona @code{clearBreakpoints()} para redefinir todos os pontos de interrupção  definidos. (Contribuição de Irit Katriel em bpo-24160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24160}.)

@node bisect,codecs,bdb,Módulos melhorados<4>
@anchor{whatsnew/3 10 bisect}@anchor{7e8}
@subsubsection bisect


Adicionada a possibilidade de fornecer uma função `key' para as APIs no módulo @ref{11,,bisect}. (Contribuição de Raymond Hettinger em bpo-4356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4356}.)

@node codecs,collections abc,bisect,Módulos melhorados<4>
@anchor{whatsnew/3 10 codecs}@anchor{7e9}
@subsubsection codecs


Adiciona uma função @ref{7ea,,codecs.unregister()} para cancelar um registro de uma função de pesquisa de codecs. (Contribuição de Hai Shi em bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}.)

@node collections abc,contextlib<2>,codecs,Módulos melhorados<4>
@anchor{whatsnew/3 10 collections-abc}@anchor{7eb}
@subsubsection collections.abc


Os @code{__args__} do @ref{6b2,,genérico parametrizado} para @ref{7ec,,collections.abc.Callable} agora são consistentes com @ref{7c6,,typing.Callable}. A classe genérica @ref{7ec,,collections.abc.Callable} agora achata parâmetros de tipo, de forma semelhante ao que @ref{7c6,,typing.Callable} atualmente faz. Isso significa que @code{collections.abc.Callable[[int, str], str]} terá @code{__args__} de @code{(int, str, str)}; anteriormente, isso era @code{([int, str], str)}. Para permitir esta alteração, agora é possível criar subclasse de @ref{7ed,,types.GenericAlias} e uma subclasse será retornada ao fazer um subscript do tipo @ref{7ec,,collections.abc.Callable}. Observe que uma @ref{2c3,,TypeError} pode ser levantada para formas inválidas de parametrizar @ref{7ec,,collections.abc.Callable} que podem ter passado silenciosamente no Python 3.9. (Contribuição de Ken Jin em bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@node contextlib<2>,curses,collections abc,Módulos melhorados<4>
@anchor{whatsnew/3 10 contextlib}@anchor{7ee}
@subsubsection contextlib


Adiciona um gerenciador de contexto @ref{7ef,,contextlib.aclosing()} para fechar com segurança geradores assíncronos e objetos que representam recursos liberados de forma assíncrona. (Contribuição de Joongi Kim e John Belmonte em bpo-41229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41229}.)

Adiciona suporte a gerenciador de contexto assíncrono a @ref{7f0,,contextlib.nullcontext()}. (Contribuição de Tom Gringauz em bpo-41543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41543}.)

Adiciona @ref{7f1,,AsyncContextDecorator}, para dar suporte ao uso de gerenciadores de contexto assíncronos como decoradores.

@node curses,dataclasses<2>,contextlib<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 curses}@anchor{7f2}
@subsubsection curses


As funções de cores estendidas adicionadas no ncurses 6.1 serão usadas transparentemente por @ref{7f3,,curses.color_content()}, @ref{7f4,,curses.init_color()}, @ref{7f5,,curses.init_pair()} e @ref{7f6,,curses.pair_content()}. Uma nova função, @ref{7f7,,curses.has_extended_color_support()}, indica se o suporte a cores estendidas é fornecido pela biblioteca ncurses subjacente. (Contribuição de Jeffrey Kintscher e Hans Petter Jansson em bpo-36982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36982}.)

As constantes @code{BUTTON5_*} agora são expostas no módulo @ref{2b,,curses} se forem fornecidas pela biblioteca curses subjacente. (Contribuição de Zackery Spytz em bpo-39273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39273}.)

@node dataclasses<2>,distutils<2>,curses,Módulos melhorados<4>
@anchor{whatsnew/3 10 dataclasses}@anchor{7f8}
@subsubsection dataclasses


@menu
* __slots__:: 
* Campos somente-nomeados:: 

@end menu

@node __slots__,Campos somente-nomeados,,dataclasses<2>
@anchor{whatsnew/3 10 slots}@anchor{7f9}
@subsubsection __slots__


Adicionado o parâmetro @code{slots} no decorador @ref{1cb,,dataclasses.dataclass()}. (Contribuição de Yurii Karabas em bpo-42269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42269})

@node Campos somente-nomeados,,__slots__,dataclasses<2>
@anchor{whatsnew/3 10 keyword-only-fields}@anchor{7fa}
@subsubsection Campos somente-nomeados


dataclasses agora oferece suporte a campos que são somente-nomeados no método __init__ gerado. Há várias maneiras de especificar campos somente-nomeados.

Você pode dizer que todos os campos são somente-nomeados:

@example
from dataclasses import dataclass

@@dataclass(kw_only=True)
class Birthday:
    name: str
    birthday: datetime.date
@end example

Ambos @code{name} e @code{birthday} são parâmetros somente-nomeados para o método __init__ gerado.

Você pode especificar somente-nomeado por campo:

@example
from dataclasses import dataclass, field

@@dataclass
class Birthday:
    name: str
    birthday: datetime.date = field(kw_only=True)
@end example

Aqui apenas @code{birthday} é somente-nomeado. Se você definir @code{kw_only} em campos individuais, esteja ciente de que existem regras sobre a reordenação de campos devido a campos somente-nomeados que precisam seguir campos não somente-nomeados. Consulte a documentação completa de dataclasses para obter detalhes.

Você também pode especificar que todos os campos a partir de um marcador KW_ONLY sejam somente-nomeados. Este provavelmente será o uso mais comum:

@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

Aqui, @code{z} e @code{t} são parâmetros somente-nomeados, enquanto @code{x} e @code{y} não são. (Contribuição de Eric V. Smith em bpo-43532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43532}.)

@node distutils<2>,doctest<2>,dataclasses<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 distutils}@anchor{7fb}@anchor{whatsnew/3 10 distutils-deprecated}@anchor{72a}
@subsubsection distutils


Todo o pacote @code{distutils} foi descontinuado, para ser removido no Python 3.12. Sua funcionalidade para especificar compilações de pacote já foi completamente substituída por pacotes de terceiros @code{setuptools} e @code{packaging}, e a maioria das outras APIs comumente usadas estão disponíveis em outro lugar na biblioteca padrão (como @ref{aa,,platform}, @ref{c5,,shutil}, @ref{d6,,subprocess} ou @ref{db,,sysconfig}). Não há planos para migrar qualquer outra funcionalidade de @code{distutils}, e aplicativos que estão usando outras funções devem planejar fazer cópias privadas do código. Consulte 
@geindex Propostas de Melhorias do Python; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} para discussão.

O comando descontinuado @code{bdist_wininst} no Python 3.8 foi removido. O comando @code{bdist_wheel} agora é recomendado para distribuir pacotes binários no Windows. (Contribuição de Victor Stinner em bpo-42802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42802}.)

@node doctest<2>,encodings,distutils<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 doctest}@anchor{7fc}
@subsubsection doctest


Quando um módulo não define @code{__loader__}, recorre a @code{__spec__.loader}. (Contribuição de Brett Cannon em bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node encodings,enum<4>,doctest<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 encodings}@anchor{7fd}
@subsubsection encodings


@ref{7fe,,encodings.normalize_encoding()} agora ignora caracteres não-ASCII. (Contribuição de Hai Shi em bpo-39337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39337}.)

@node enum<4>,fileinput,encodings,Módulos melhorados<4>
@anchor{whatsnew/3 10 enum}@anchor{7ff}
@subsubsection enum


@ref{61c,,__repr__()} do @ref{630,,Enum} agora retorna @code{enum_name.member_name} e @ref{61d,,__str__()} agora retorna @code{member_name}. Os enums da stdlib disponíveis como constantes de módulo têm @ref{800,,repr()} de @code{module_name.member_name}. (Contribuição de Ethan Furman em bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}.)

Adiciona @ref{61a,,enum.StrEnum} para enums onde todos os membros são strings. (Contribuição de Ethan Furman em bpo-41816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41816}.)

@node fileinput,faulthandler,enum<4>,Módulos melhorados<4>
@anchor{whatsnew/3 10 fileinput}@anchor{801}
@subsubsection fileinput


Adiciona os parâmetros `encoding' e `errors' a @ref{802,,fileinput.input()} e @ref{737,,fileinput.FileInput}. (Contribuição de Inada Naoki em bpo-43712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43712}.)

@ref{803,,fileinput.hook_compressed()} agora retorna um objeto @ref{7bc,,TextIOWrapper} quando `mode' é “r” e o arquivo está compactado, como arquivos descompactados. (Contribuição de Inada Naoki em bpo-5758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5758}.)

@node faulthandler,gc,fileinput,Módulos melhorados<4>
@anchor{whatsnew/3 10 faulthandler}@anchor{804}
@subsubsection faulthandler


O módulo @ref{58,,faulthandler} agora detecta se um erro fatal ocorre durante a coleta do coletor de lixo. (Contribuição de Victor Stinner em bpo-44466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44466}.)

@node gc,glob<2>,faulthandler,Módulos melhorados<4>
@anchor{whatsnew/3 10 gc}@anchor{805}
@subsubsection gc


Adiciona ganchos de auditoria para @ref{806,,gc.get_objects()}, @ref{807,,gc.get_referrers()} e @ref{808,,gc.get_referents()}. (Contribuição de Pablo Galindo em bpo-43439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43439}.)

@node glob<2>,hashlib<3>,gc,Módulos melhorados<4>
@anchor{whatsnew/3 10 glob}@anchor{809}
@subsubsection glob


Adiciona os parâmetros `root_dir' e `dir_fd'  em @ref{29f,,glob()} e @ref{80a,,iglob()}, o que permite especificar o diretório raiz para a pesquisa. (Contribuição de Serhiy Storchaka em bpo-38144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38144}.)

@node hashlib<3>,hmac,glob<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 hashlib}@anchor{80b}
@subsubsection hashlib


O módulo hashlib requer OpenSSL 1.1.1 ou mais recente. (Contribuição de Christian Heimes em 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} e bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

O módulo hashlib tem suporte preliminar a OpenSSL 3.0.0. (Contribuição de Christian Heimes em bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820} e outras issues.)

A alternativa puramente Python de @ref{50f,,pbkdf2_hmac()} foi descontinuada. No futuro, o PBKDF2-HMAC só estará disponível quando o Python for desenvolvido com suporte a OpenSSL. (Contribuição de Christian Heimes em bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}.)

@node hmac,IDLE e idlelib<2>,hashlib<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 hmac}@anchor{80c}
@subsubsection hmac


O módulo hmac agora usa a implementação HMAC do OpenSSL internamente. (Contribuição de Christian Heimes em bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}.)

@node IDLE e idlelib<2>,importlib metadata<2>,hmac,Módulos melhorados<4>
@anchor{whatsnew/3 10 idle-and-idlelib}@anchor{80d}
@subsubsection IDLE e idlelib


Faz o IDLE invocar @ref{80e,,sys.excepthook()} (quando iniciado sem ‘-n’). Ganchos de usuário eram ignorados anteriormente. (Contribuição de Ken Hilton em bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}.)

Reorganiza a caixa de diálogo de configurações. Divide a aba General nas abas Windows e Shell/Ed. Move as fontes de ajuda, que estendem o menu Help, para a aba Extensions. Abre espaço para novas opções e encurta a caixa de diálogo. O último faz com que o diálogo se ajuste melhor a telas pequenas. (Contribuição de Terry Jan Reedy em bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}.) Move a configuração do espaço de recuo da aba Font para a nova aba Windows. (Contribuição de Mark Roseman e Terry Jan Reedy em bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}.)

As alterações acima foram portadas para uma versão de manutenção 3.9.

Adiciona uma barra lateral ao console. Move o prompt principal (‘>>>’) para a barra lateral. Adiciona prompts secundários (’…’) à barra lateral. Clicar com o botão esquerdo e opcionalmente arrastar seleciona uma ou mais linhas de texto, como na barra lateral do número da linha do editor. Clicar com o botão direito após selecionar as linhas de texto exibe um menu de contexto com “copy with prompts”. Isso compacta os prompts da barra lateral com linhas do texto selecionado. Esta opção também aparece no menu de contexto para o texto. (Contribuição de Tal Einat em bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}.)

Use espaços em vez de tabulações para indentar o código interativo. Isso faz com que as entradas de código interativo “pareçam corretas”. Tornar isso viável foi a principal motivação para adicionar a barra lateral do console. Contribuição de Terry Jan Reedy em bpo-37892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37892}.)

Realça as novas @ref{80f,,palavra reservada suave} @ref{810,,match}, @ref{810,,case} e @ref{811,,_} em instruções de correspondência de padrões. No entanto, este realce não é perfeito e estará incorreto em alguns casos raros, incluindo alguns @code{_} em padrões de @code{case}. (Contribuição de Tal Einat em bpo-44010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44010}.)

Novo nas versões de manutenção 3.10.

Aplica realce de sintaxe em arquivos @code{.pyi}. (Contribuição de Alex Waygood e Terry Jan Reedy em bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}.)

Inclui prompts ao salvar o console com entradas e saídas. (Contribuição de Terry Jan Reedy em gh-95191@footnote{https://github.com/python/cpython/issues/95191}.)

@node importlib metadata<2>,inspect<3>,IDLE e idlelib<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 importlib-metadata}@anchor{812}
@subsubsection importlib.metadata


Paridade de recursos com @code{importlib_metadata} 4.6 (histórico@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html}).

@ref{284,,Pontos de entrada importlib.metadata} agora oferecem uma experiência melhor para selecionar pontos de entrada por grupo e nome através do novo @ref{284,,importlib.metadata.EntryPoints}. Consulte a Nota de Compatibilidade nos documentos para obter mais informações sobre a descontinuação e uso.

Adicionada @ref{813,,importlib.metadata.packages_distributions()} para resolver módulos e pacotes Python de alto nível com suas @ref{814,,importlib.metadata.Distribution}.

@node inspect<3>,itertools<3>,importlib metadata<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 inspect}@anchor{815}
@subsubsection inspect


Quando um módulo não define @code{__loader__}, recorre a @code{__spec__.loader}. (Contribuição de Brett Cannon em bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

Adiciona @ref{816,,inspect.get_annotations()}, que calcula com segurança as anotações definidas em um objeto. Ele contorna as peculiaridades de acessar as anotações em vários tipos de objetos e faz poucas suposições sobre o objeto que examina. @ref{816,,inspect.get_annotations()} também pode desfazer a string corretamente de anotações em string. @ref{816,,inspect.get_annotations()} agora é considerada a melhor prática para acessar o dict de anotações definido em qualquer objeto Python; para mais informações sobre as melhores práticas para trabalhar com anotações, consulte @ref{7da,,Boas práticas para anotações}. Da mesma forma, @ref{738,,inspect.signature()}, @ref{73a,,inspect.Signature.from_callable()} e @code{inspect.Signature.from_function()} agora chamam @ref{816,,inspect.get_annotations()} para recuperar anotações. Isso significa que @ref{738,,inspect.signature()} e @ref{73a,,inspect.Signature.from_callable()} agora também podem remover a string de anotações em string. (Contribuição de Larry Hastings em bpo-43817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43817}.)

@node itertools<3>,linecache,inspect<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 itertools}@anchor{817}
@subsubsection itertools


Adiciona @ref{818,,itertools.pairwise()}. (Contribuição de Raymond Hettinger em bpo-38200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38200}.)

@node linecache,os<4>,itertools<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 linecache}@anchor{819}
@subsubsection linecache


Quando um módulo não define @code{__loader__}, recorre a @code{__spec__.loader}. (Contribuição de Brett Cannon em bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node os<4>,os path<4>,linecache,Módulos melhorados<4>
@anchor{whatsnew/3 10 os}@anchor{81a}
@subsubsection os


Adiciona suporte a @ref{1c5,,os.cpu_count()} para RTOS de VxWorks. (Contribuição de Peixing Xin em bpo-41440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41440}.)

Adiciona uma nova função @ref{81b,,os.eventfd()} e auxiliares relacionados para envolver a chamada de sistema @code{eventfd2} no Linux. (Contribuição de Christian Heimes em bpo-41001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41001}.)

Adiciona @ref{81c,,os.splice()} que permite mover dados entre dois descritores de arquivo sem copiar entre o espaço de endereço do kernel e o espaço de endereço do usuário, onde um dos descritores de arquivo deve se referir a um encadeamento (pipe). (Contribuição de Pablo Galindo em bpo-41625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41625}.)

Adiciona @ref{81d,,O_EVTONLY}, @ref{81e,,O_FSYNC}, @ref{81f,,O_SYMLINK} e @ref{820,,O_NOFOLLOW_ANY} para macOS. (Contribuição de Donghee Na em bpo-43106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43106}.)

@node os path<4>,pathlib<5>,os<4>,Módulos melhorados<4>
@anchor{whatsnew/3 10 os-path}@anchor{821}
@subsubsection os.path


@ref{225,,os.path.realpath()} agora aceita um argumento somente-nomeado `strict'. Quando definido como @code{True}, a exceção @ref{417,,OSError} é levantada se um caminho não existe ou um loop de link simbólico é encontrado. (Contribuição de Barney Gale em bpo-43757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43757}.)

@node pathlib<5>,platform<2>,os path<4>,Módulos melhorados<4>
@anchor{whatsnew/3 10 pathlib}@anchor{822}
@subsubsection pathlib


Adiciona suporte a fatiamento a @ref{823,,PurePath.parents}. (Contribuição de Joshua Cannon em bpo-35498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35498}.)

Adiciona suporte a indexação negativa a @ref{823,,PurePath.parents}. (Contribuição de Yaroslav Pankovych em bpo-21041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21041}.)

Adiciona o método @ref{824,,Path.hardlink_to} que substitui @code{link_to()}. O novo método tem a mesma ordem de argumentos que @ref{825,,symlink_to()}. (Contribuição de Barney Gale em bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}.)

@ref{826,,pathlib.Path.stat()} e @ref{827,,chmod()} agora aceita um argumento somente-nomeado `follow_symlinks' para consistência com as funções correspondentes no módulo @ref{a1,,os}. (Contribuição de Barney Gale em bpo-39906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39906}.)

@node platform<2>,pprint,pathlib<5>,Módulos melhorados<4>
@anchor{whatsnew/3 10 platform}@anchor{828}
@subsubsection platform


Adiciona @ref{829,,platform.freedesktop_os_release()} para obter a identificação do sistema operacional a partir do arquivo padrão os-release do freedesktop.org@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html}. (Contribuição de Christian Heimes em bpo-28468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28468}.)

@node pprint,py_compile,platform<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 pprint}@anchor{82a}
@subsubsection pprint


@ref{82b,,pprint.pprint()} agora aceita um novo argumento nomeado @code{underscore_numbers}. (Contribuição de sblondon em bpo-42914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42914}.)

@ref{ae,,pprint} agora pode fazer impressão bonita de instâncias de @ref{1cb,,dataclasses.dataclass}. (Contribuição de Lewis Gaul em bpo-43080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43080}.)

@node py_compile,pyclbr,pprint,Módulos melhorados<4>
@anchor{whatsnew/3 10 py-compile}@anchor{82c}
@subsubsection py_compile


Adiciona a opção @code{--quiet} à interface de linha de comando de @ref{b3,,py_compile}. (Contribuição de Gregory Schevchenko em bpo-38731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38731}.)

@node pyclbr,shelve,py_compile,Módulos melhorados<4>
@anchor{whatsnew/3 10 pyclbr}@anchor{82d}
@subsubsection pyclbr


Adiciona um atributo @code{end_lineno} aos objetos @code{Function} e @code{Class} na árvore retornada por @ref{82e,,pyclbr.readmodule()} e @ref{82f,,pyclbr.readmodule_ex()}. Isso corresponde ao @code{lineno} (início) existente. (Contribuição de Aviral Srivastava em bpo-38307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38307}.)

@node shelve,statistics<3>,pyclbr,Módulos melhorados<4>
@anchor{whatsnew/3 10 shelve}@anchor{830}
@subsubsection shelve


O módulo @ref{c3,,shelve} agora usa @ref{831,,pickle.DEFAULT_PROTOCOL} por padrão em vez do protocolo @code{3} do @ref{a6,,pickle} ao criar “shelves”. (Contribuição de Zackery Spytz em bpo-34204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34204}.)

@node statistics<3>,site<2>,shelve,Módulos melhorados<4>
@anchor{whatsnew/3 10 statistics}@anchor{832}
@subsubsection statistics


Adiciona @ref{833,,covariance()}, @ref{4bc,,correlation()} do Pearson, e funções simples @ref{834,,linear_regression()}. (Contribuição de Tymoteusz Wołodźko em bpo-38490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38490}.)

@node site<2>,socket<2>,statistics<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 site}@anchor{835}
@subsubsection site


Quando um módulo não define @code{__loader__}, recorre a @code{__spec__.loader}. (Contribuição de Brett Cannon em bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}.)

@node socket<2>,ssl<3>,site<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 socket}@anchor{836}
@subsubsection socket


A exceção @ref{837,,socket.timeout} é agora um apelido de @ref{838,,TimeoutError}. (Contribuição de Christian Heimes em bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}.)

Adiciona a opção de criar soquetes MPTCP com @code{IPPROTO_MPTCP} (Contribuição de Rui Cunha em bpo-43571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43571}.)

Adiciona a opção @code{IP_RECVTOS} para receber o tipo do serviço (ToS) ou campos DSCP/ECN (Contribuição de Georg Sauthoff em bpo-44077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44077}.)

@node ssl<3>,sqlite3<5>,socket<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 ssl}@anchor{839}
@subsubsection ssl


O módulo ssl requer OpenSSL 1.1.1 ou mais recente. (Contribuição de Christian Heimes em 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} e bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

O módulo ssl tem um suporte preliminar para OpenSSL 3.0.0 e a nova opção @ref{83a,,OP_IGNORE_UNEXPECTED_EOF}. (Contribuição de Christian Heimes em 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} e bpo-43811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43811}.)

Função descontinuada e o uso de constantes descontinuadas agora resultam em uma @ref{1a5,,DeprecationWarning}. @ref{83b,,ssl.SSLContext.options} tem @ref{83c,,OP_NO_SSLv2} e @ref{83d,,OP_NO_SSLv3} definidos por padrão e, portanto, não consegue avisar sobre a definição do sinalizador novamente. A @ref{83e,,seção de descontinuidade} tem uma lista de recursos descontinuados. (Contribuição de Christian Heimes em bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}.)

O módulo ssl agora tem configurações padrão mais seguras. Cifras sem `forward secrecy' ou SHA-1 MAC são desabilitadas por padrão. O nível de segurança 2 proíbe chaves fracas RSA, DH e ECC com menos de 112 bits de segurança. @ref{294,,SSLContext} assume como padrão a versão mínima do protocolo TLS 1.2. As configurações são baseadas na pesquisa de Hynek Schlawack. (Contribuição de Christian Heimes em bpo-43998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43998}.)

Os protocolos descontinuados SSL 3.0, TLS 1.0 e TLS 1.1 não são mais oficialmente suportados. Python não os bloqueia ativamente. No entanto, as opções de compilação do OpenSSL, configurações de distro, patches de fornecedores e suítes de criptografia podem impedir um handshake bem-sucedido.

Adiciona um parâmetro `timeout' à função @ref{83f,,ssl.get_server_certificate()}. (Contribuição de Zackery Spytz em bpo-31870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31870}.)

O módulo ssl usa tipos de heap e inicialização multifásica. (Contribuição de Christian Heimes em bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}.)

Uma nova sinalização de verificação @ref{156,,VERIFY_X509_PARTIAL_CHAIN} foi adicionada. (Contribuição de l0x em bpo-40849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40849}.)

@node sqlite3<5>,sys<5>,ssl<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 sqlite3}@anchor{840}
@subsubsection sqlite3


Adiciona eventos de auditoria para @ref{2a8,,connect()}, @ref{841,,enable_load_extension()} e @ref{4b8,,load_extension()}. (Contribuição de Erlend E. Aasland em bpo-43762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43762}.)

@node sys<5>,_thread,sqlite3<5>,Módulos melhorados<4>
@anchor{whatsnew/3 10 sys}@anchor{842}
@subsubsection sys


Adiciona o atributo @ref{843,,sys.orig_argv}: a lista de argumentos de linha de comando originais passada para o executável Python. (Contribuição de Victor Stinner em bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}.)

Adiciona @ref{844,,sys.stdlib_module_names}, contendo a lista de nomes de módulos da biblioteca padrão. (Contribuição de Victor Stinner em bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955}.)

@node _thread,threading<3>,sys<5>,Módulos melhorados<4>
@anchor{whatsnew/3 10 thread}@anchor{845}
@subsubsection _thread


@ref{846,,_thread.interrupt_main()} agora aceita um número de sinal opcional para simular (o padrão ainda é @ref{847,,signal.SIGINT}). (Contribuição de Antoine Pitrou em bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}.)

@node threading<3>,traceback<3>,_thread,Módulos melhorados<4>
@anchor{whatsnew/3 10 threading}@anchor{848}
@subsubsection threading


Adiciona @ref{849,,threading.gettrace()} e @ref{84a,,threading.getprofile()} para obter as funções definidas por @ref{84b,,threading.settrace()} e @ref{84c,,threading.setprofile()}, respectivamente. (Contribuição de Mario Corchero em bpo-42251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42251}.)

Adiciona @ref{84d,,threading.__excepthook__} para permitir obtenção do valor original de @ref{84e,,threading.excepthook()} no caso dele estar definido com um valor quebrado ou diferente. (Contribuição de Mario Corchero em bpo-42308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42308}.)

@node traceback<3>,types<3>,threading<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 traceback}@anchor{84f}
@subsubsection traceback


As funções @ref{850,,format_exception()}, @ref{851,,format_exception_only()} e @ref{852,,print_exception()} podem agora receber um objeto exceção como um argumento somente-posicional. (Contribuição de Zackery Spytz e Matthias Bussonnier em bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}.)

@node types<3>,typing<5>,traceback<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 types}@anchor{853}
@subsubsection types


Reintroduz as classes @ref{854,,types.EllipsisType}, @ref{855,,types.NoneType} e @ref{856,,types.NotImplementedType}, fornecendo um novo conjunto de tipos prontamente interpretáveis pelos verificadores de tipo. (Contribuição de Bas van Beek em bpo-41810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41810}.)

@node typing<5>,unittest<5>,types<3>,Módulos melhorados<4>
@anchor{whatsnew/3 10 typing}@anchor{857}
@subsubsection typing


Para alterações principais, veja @ref{7bf,,Novos recursos relacionados a dicas de tipo}.

O comportamento de @ref{858,,typing.Literal} foi alterado para ficar em conformidade com a 
@geindex Propostas de Melhorias do Python; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} e para corresponder ao comportamento de verificadores de tipo estático especificados na PEP.


@enumerate 

@item 
@code{Literal} agora elimina a duplicação de parâmetros.

@item 
Comparações de igualdade entre objetos @code{Literal} agora são independentes da ordem.

@item 
Comparações de @code{Literal} agora respeitam os tipos. Por exemplo, @code{Literal[0] == Literal[False]} avaliava anteriormente como @code{True}. Agora é @code{False}. Para oferecer suporte a essa mudança, o cache de tipo usado internamente agora oferece suporte a tipos de diferenciação.

@item 
Objetos @code{Literal} agora irão levantar uma exceção @ref{2c3,,TypeError} durante as comparações de igualdade se algum de seus parâmetros não for @ref{610,,hasheáveis}. Observe que declarar @code{Literal} com parâmetros inalteráveis não acusará um erro:

@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

(Contribuição de Yurii Karabas em bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}.)

Adiciona uma nova função @ref{859,,typing.is_typeddict()}  para fazer introspecção se uma anotação for uma @ref{162,,typing.TypedDict}. (Contribuição de Patrick Reader em bpo-41792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41792}.)

Subclasses de @code{typing.Protocol} que apenas têm variáveis de dados declaradas agora irão levantar um @code{TypeError} quando verificadas com @code{isinstance} a menos que sejam decoradas com @ref{443,,runtime_checkable()}. Anteriormente, essas verificações eram aprovadas silenciosamente. Os usuários devem decorar suas subclasses com o decorador @code{runtime_checkable()} se quiserem protocolos de tempo de execução. (Contribuição de Yurii Karabas em bpo-38908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38908}.)

A importação dos submódulos @code{typing.io} e @code{typing.re} agora emitirá @ref{1a5,,DeprecationWarning}. Esses submódulos fora descontinuados desde o Python 3.8 e serão removidos em uma versão futura do Python. Qualquer coisa pertencente a esses submódulos deve ser importada diretamente de @ref{104,,typing}. (Contribuição de Sebastian Rittau em bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}.)

@node unittest<5>,urllib parse,typing<5>,Módulos melhorados<4>
@anchor{whatsnew/3 10 unittest}@anchor{85a}
@subsubsection unittest


Adiciona novo método new @ref{85b,,assertNoLogs()} para complementar o existente @ref{85c,,assertLogs()}. (Contribuição de Kit Yan Choi em bpo-39385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39385}.)

@node urllib parse,xml<2>,unittest<5>,Módulos melhorados<4>
@anchor{whatsnew/3 10 urllib-parse}@anchor{85d}
@subsubsection urllib.parse


Versões do Python anteriores ao Python 3.10 permitiam o uso de @code{;} e @code{&} como separadores de parâmetros de consulta em @ref{27a,,urllib.parse.parse_qs()} e @ref{279,,urllib.parse.parse_qsl()}. Devido a questões de segurança e em conformidade com as recomendações mais recentes do W3C, isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como padrão. Esta mudança também afeta @code{cgi.parse()} e @code{cgi.parse_multipart()} já que elas usam as funções afetadas internamente. Para obter mais detalhes, consulte a respectiva documentação. (Contribuição de Adam Goldschmidt, Senthil Kumaran e Ken Jin em bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

A presença de caracteres de nova linha ou tab em partes de um URL permite algumas formas de ataques. Seguindo a especificação WHATWG que atualiza 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, nova linha ASCII @code{\n}, @code{\r} e os caracteres de tabulação @code{\t} são retirados da URL pelo analisador sintático em @ref{10a,,urllib.parse} impedindo tais ataques. Os caracteres de remoção são controlados por uma nova variável de nível de módulo @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (Veja gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node xml<2>,zipimport<3>,urllib parse,Módulos melhorados<4>
@anchor{whatsnew/3 10 xml}@anchor{85e}
@subsubsection xml


Adiciona uma classe @ref{85f,,LexicalHandler} ao módulo @ref{12a,,xml.sax.handler}. (Contribuição de Jonathan Gossage e Zackery Spytz em bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018}.)

@node zipimport<3>,,xml<2>,Módulos melhorados<4>
@anchor{whatsnew/3 10 zipimport}@anchor{860}
@subsubsection zipimport


Adiciona métodos relacionados à 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}: @ref{861,,find_spec()}, @ref{862,,zipimport.zipimporter.create_module()} e @ref{312,,zipimport.zipimporter.exec_module()}. (Contribuição de Brett Cannon em bpo-42131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42131}.)

Adiciona o método @ref{863,,invalidate_caches()}. (Contribuição de Desmond Cheong em bpo-14678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14678}.)

@node Otimizações<4>,Descontinuados<5>,Módulos melhorados<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 optimizations}@anchor{864}
@subsection Otimizações



@itemize *

@item 
Os construtores @ref{44c,,str()}, @ref{1c2,,bytes()} e @ref{2ea,,bytearray()} estão agora mais rápido (cerca de 30–40% para objetos pequenos). (Contribuição de Serhiy Storchaka em bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334}.)

@item 
O módulo @ref{be,,runpy} agora importa menos módulos. O tempo de inicialização do comando @code{python3 -m module-name} é 1,4 vezes mais rápido em média. No Linux, @code{python3 -I -m module-name} importa 69 módulos no Python 3.9, sendo que importa apenas 51 módulos (-18) no Python 3.10. (Contribuição de Victor Stinner em bpo-41006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41006} e bpo-41718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41718}.)

@item 
A instrução @code{LOAD_ATTR} agora usa o novo mecanismo “cache por opcode”. É cerca de 36% mais rápido agora para atributos regulares e 44% mais rápido para slots. (Contribuição de Pablo Galindo e Yury Selivanov em bpo-42093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42093} e Guido van Rossum em bpo-42927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42927}, com base em ideias implementadas originalmente em PyPy e MicroPython.)

@item 
Ao construir o Python com @ref{865,,--enable-optimizations} agora, @code{-fno-semantic-interposition} é adicionado à linha de compilação e vinculação. Isso acelera as compilações do interpretador Python criado com @ref{866,,--enable-shared} com @code{gcc} em até 30%. Consulte este artigo@footnote{https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/} para mais detalhes. (Contribuição de Victor Stinner e Pablo Galindo em bpo-38980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38980}.)

@item 
Usa um novo código de gerenciamento de buffer de saída para os módulos @ref{13,,bz2} / @ref{8a,,lzma} / @ref{133,,zlib} e adiciona a função @code{.readall()} à classe @code{_compression.DecompressReader}. A descompressão bz2 agora é 1,09x ~ 1.17x mais rápida, a descompressão lzma 1.20x ~ 1.32x mais rápida, @code{GzipFile.read(-1)} 1,11x ~ 1.18x mais rápida. (Contribuição de Ma Lin, revisada por Gregory P. Smith, em bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486})

@item 
Ao usar anotações em strings, dicts de anotações para funções não são mais criados quando a função é criada. Em vez disso, eles são armazenados como uma tupla de strings, e o objeto função converte lentamente isso no dict de anotações sob demanda. Essa otimização reduz pela metade o tempo de CPU necessário para definir uma função anotada. (Contribuição de Yurii Karabas e Inada Naoki em bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}.)

@item 
Funções de pesquisa de substring como @code{str1 in str2} e @code{str2.find(str1)} agora às vezes usam o algoritmo de pesquisa de string “Two-Way” de Crochemore & Perrin para evitar comportamento quadrático em strings longas. (Contribuição de Dennis Sweeney em bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972})

@item 
Adiciona micro-otimizações a @code{_PyType_Lookup()} para melhorar o desempenho de pesquisa de cache de atributo de tipo no caso comum de acessos de cache. Isso torna o interpretador 1,04 vezes mais rápido, em média. (Contribuição de Dino Viehland em bpo-43452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43452}.)

@item 
As seguintes funções embutidas agora oferecem suporte a uma convenção de chamada de vectorcalls mais rápidos da 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}: @ref{867,,map()}, @ref{868,,filter()}, @ref{869,,reversed()}, @ref{468,,bool()} e @ref{2f7,,float()}. (Contribuição de Donghee Na e Jeroen Demeyer em 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} e bpo-41870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41870}.)

@item 
O desempenho de @ref{86a,,BZ2File} foi melhorado removendo o @code{RLock} interno. Isso torna @code{BZ2File} inseguro para threads em face a vários leitores ou gravadores simultâneos, da mesma forma que suas classes equivalentes em @ref{67,,gzip} e @ref{8a,,lzma} têm sido. (Contribuição de Inada Naoki em bpo-43785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43785}.)
@end itemize

@node Descontinuados<5>,Removidos<5>,Otimizações<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 deprecated}@anchor{86b}@anchor{whatsnew/3 10 whatsnew310-deprecated}@anchor{83e}
@subsection Descontinuados



@itemize *

@item 
Atualmente Python aceita literais numéricos imediatamente seguidos por palavras-chave, por exemplo @code{0in x}, @code{1or x}, @code{0if 1else 2}. Permite expressões confusas e ambíguas como @code{[0x1for x in y]} (que pode ser interpretada como @code{[0x1 for x in y]} ou @code{[0x1f or x in y]}). A partir desta versão, um aviso de descontinuidade é levantado se o literal numérico for seguido imediatamente por uma das palavras-chave @ref{2f1,,and}, @ref{18c,,else}, @ref{2f2,,for}, @ref{2f3,,if}, @ref{2f4,,in}, @ref{2f5,,is} e @ref{2f6,,or}. Em versões futuras, ele será alterado para aviso de sintaxe e, finalmente, para erro de sintaxe. (Contribuição de Serhiy Storchaka em bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}.)

@item 
A partir desta versão, haverá um esforço concentrado para começar a limpar a semântica de importação antiga que foi mantida para compatibilidade com Python 2.7. Especificamente, @code{find_loader()}/@code{find_module()} (substituídos por @ref{86c,,find_spec()}), @ref{86d,,load_module()} (substituído por @ref{86e,,exec_module()}), @code{module_repr()} (que o sistema de importação cuida para você), o atributo @code{__package__} (substituído por @code{__spec__.parent}), o atributo @code{__loader__} (substituído por @code{__spec__.loader}), e o atributo @code{__cached__} ( substituído por @code{__spec__.cached}) será removido lentamente (assim como outras classes e métodos em @ref{77,,importlib}). @ref{4fa,,ImportWarning} e/ou @ref{1a5,,DeprecationWarning} será levantada conforme apropriado para ajudar a identificar o código que precisa ser atualizado durante esta transição.

@item 
Todo o espaço de nomes de @code{distutils} foi descontinuado, para ser removido no Python 3.12. Consulte a seção de @ref{72a,,alterações do módulo} para mais informações.

@item 
Argumentos não inteiros para @ref{86f,,random.randrange()} foram descontinuados. A exceção @ref{202,,ValueError} foi descontinuada em favor de uma exceção @ref{2c3,,TypeError}. (Contribuição de Serhiy Storchaka e Raymond Hettinger em bpo-37319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37319}.)

@item 
Os vários métodos de @code{load_module()} de @ref{77,,importlib} foram documentados como descontinuados desde Python 3.6, mas agora também irão disparar um @ref{1a5,,DeprecationWarning}. Use @ref{86e,,exec_module()} em vez disso. (Contribuição de Brett Cannon em bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
@code{zimport.zipimporter.load_module()} foi descontinuado em preferência a @ref{312,,exec_module()}. (Contribuição de Brett Cannon em bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
O uso de @ref{86d,,load_module()} pelo sistema de importação agora dispara uma exceção @ref{4fa,,ImportWarning}, pois @ref{86e,,exec_module()} é preferível. (Contribuição de Brett Cannon em bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}.)

@item 
O uso de @code{importlib.abc.MetaPathFinder.find_module()} e @code{importlib.abc.PathEntryFinder.find_module()} pelo sistema de importação agora dispara uma exceção @ref{4fa,,ImportWarning}, pois @ref{86c,,importlib.abc.MetaPathFinder.find_spec()} e @ref{870,,importlib.abc.PathEntryFinder.find_spec()} são preferidos, respectivamente. Você pode usar @ref{871,,importlib.util.spec_from_loader()} para ajudar no port. (Contribuição de Brett Cannon em bpo-42134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42134}.)

@item 
O uso de @code{importlib.abc.PathEntryFinder.find_loader()} pelo sistema de importação agora dispara uma exceção @ref{4fa,,ImportWarning}, pois @ref{870,,importlib.abc.PathEntryFinder.find_spec()} é preferido. Você pode usar @ref{871,,importlib.util.spec_from_loader()} para ajudar no port. (Contribuição de Brett Cannon em bpo-43672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43672}.)

@item 
As várias implementações de @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()} ) e @code{importlib.abc.PathEntryFinder.find_loader()} ( @code{importlib.machinery.FileFinder.find_loader()} ) agora levantam @ref{1a5,,DeprecationWarning} e estão programadas para remoção no Python 3.12 (anteriormente, eles foram documentados como descontinuados no Python 3.4). (Contribuição de Brett Cannon em bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}.)

@item 
@code{importlib.abc.Finder} foi descontinuada (incluindo seu único método, @code{find_module()}). @ref{872,,importlib.abc.MetaPathFinder} e @ref{873,,importlib.abc.PathEntryFinder} não mais herdam da classe. Usuários devem herdar de uma dessas duas classes conforme apropriado. (Contribuição de Brett Cannon em bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}.)

@item 
As descontinuações de @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} e @code{pkgutil.ImpLoader} foram todas atualizadas para listar Python 3.12 como a versão programada para remoção (elas começaram a levantar @ref{1a5,,DeprecationWarning} em versões anteriores do Python). (Contribuição de Brett Cannon em bpo-43720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43720}.)

@item 
O sistema de importação agora usa o atributo @code{__spec__} em módulos antes de recorrer a @code{module_repr()} para um método @code{__repr__()} do módulo. A remoção do uso de @code{module_repr()} está programado para Python 3.12. (Contribuição de Brett Cannon em 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()} e @code{importlib.machinery.BuiltinLoader.module_repr()} foram descontinuadas e programadas para remoção no Python 3.12. (Contribuição de Brett Cannon em bpo-42136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42136}.)

@item 
@code{sqlite3.OptimizedUnicode} teve a documentação removida e foi descontinuado desde o Python 3.3, quando foi tornado um apelido para @ref{44c,,str}. Foi agora descontinuado, programado para remoção no Python 3.12. (Contribuição de Erlend E. Aasland em bpo-42264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42264}.)

@item 
A função embutida não documentada @code{sqlite3.enable_shared_cache} foi agora descontinuada, agendada para remoção no Python 3.12. Seu uso é fortemente desencorajado pela documentação do SQLite3. Veja a documentação do SQLite3@footnote{https://sqlite.org/c3ref/enable_shared_cache.html} para mais detalhes. Se um cache compartilhado deve ser usado, abra o banco de dados no modo URI usando o parâmetro de consulta @code{cache=shared}. (Contribuição de Erlend E. Aasland em bpo-24464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24464}.)

@item 
Os seguintes métodos de @code{threading} foram agora descontinuados:


@itemize *

@item 
@code{threading.currentThread} => @ref{309,,threading.current_thread()}

@item 
@code{threading.activeCount} => @ref{30a,,threading.active_count()}

@item 
@code{threading.Condition.notifyAll} =>
@ref{303,,threading.Condition.notify_all()}

@item 
@code{threading.Event.isSet} => @ref{304,,threading.Event.is_set()}

@item 
@code{threading.Thread.setName} => @ref{308,,threading.Thread.name}

@item 
@code{threading.thread.getName} => @ref{308,,threading.Thread.name}

@item 
@code{threading.Thread.isDaemon} => @ref{306,,threading.Thread.daemon}

@item 
@code{threading.Thread.setDaemon} => @ref{306,,threading.Thread.daemon}
@end itemize

(Contribuição de Jelle Zijlstra em gh-87889@footnote{https://github.com/python/cpython/issues/87889}.)

@item 
@code{pathlib.Path.link_to()} foi descontinuado e programado para remoção no Python 3.12. Use @ref{824,,pathlib.Path.hardlink_to()} em vez disso. (Contribuição de Barney Gale em bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}.)

@item 
@code{cgi.log()} foi descontinuado e programado para remoção no Python 3.12. (Contribuição de Inada Naoki em bpo-41139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41139}.)

@item 
Os recurso a seguir do @ref{d0,,ssl} foram descontinuados desde o Python 3.6, Python 3.7 ou OpenSSL 1.1.0, e serão removidos no 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} e @code{OP_NO_TLSv1_3} foram substituídos por @ref{874,,minimum_version} e @ref{875,,maximum_version}.

@item 
@code{PROTOCOL_SSLv2}, @code{PROTOCOL_SSLv3}, @code{PROTOCOL_SSLv23}, @code{PROTOCOL_TLSv1}, @code{PROTOCOL_TLSv1_1}, @code{PROTOCOL_TLSv1_2} e @code{PROTOCOL_TLS} foram descontinuados em favor de @ref{876,,PROTOCOL_TLS_CLIENT} e @ref{877,,PROTOCOL_TLS_SERVER}

@item 
@code{wrap_socket()} foi substituída por @ref{525,,ssl.SSLContext.wrap_socket()}

@item 
@code{match_hostname()}

@item 
@code{RAND_pseudo_bytes()}, @code{RAND_egd()}

@item 
Recurso de NPN como @ref{878,,ssl.SSLSocket.selected_npn_protocol()} e @ref{302,,ssl.SSLContext.set_npn_protocols()} foram substituídos por ALPN.
@end itemize

@item 
A depuração de threads (variável de ambiente @code{PYTHONTHREADDEBUG}) foi descontinuada no Python 3.10 e será removida no Python 3.12. Este recurso exige uma @ref{1f9,,construção de depuração de Python}. (Contribuição de Victor Stinner em bpo-44584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44584}.)

@item 
A importação dos submódulos @code{typing.io} e @code{typing.re} agora emitirá @ref{1a5,,DeprecationWarning}. Esses submódulos serão removidos em uma versão futura do Python. Qualquer coisa pertencente a esses submódulos deve ser importada diretamente de @ref{104,,typing}. (Contribuição de Sebastian Rittau em bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}.)
@end itemize

@node Removidos<5>,Portando para Python 3 10,Descontinuados<5>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 removed}@anchor{879}@anchor{whatsnew/3 10 whatsnew310-removed}@anchor{87a}
@subsection Removidos



@itemize *

@item 
Removidos os métodos especiais @code{__int__}, @code{__float__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__rfloordiv__}, @code{__rmod__} e @code{__rdivmod__} da classe @ref{2f8,,complex}. Eles sempre levantavam uma exceção @ref{2c3,,TypeError}. (Contribuição de Serhiy Storchaka em bpo-41974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41974}.)

@item 
O método @code{ParserBase.error()} do módulo privado e não documentado @code{_markupbase} foi removido. @ref{87b,,html.parser.HTMLParser} é a única subclasse de @code{ParserBase} e sua implementação de @code{error()} já tinha sido removida no Python 3.5. (Contribuição de Berker Peksag em bpo-31844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31844}.)

@item 
Removido o atributo @code{unicodedata.ucnhash_CAPI} que foi um objeto interno PyCapsule. A estrutura privada relacionada @code{_PyUnicode_Name_CAPI} foi movida para uma API C interna. (Contribuição de Victor Stinner em bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}.)

@item 
Removido o módulo @code{parser}, que foi descontinuado em 3.9 em razão da mudança para o novo analisador sintático GASE, bem como todo os arquivos código-fonte e cabeçalhos C que estavam sendo usados pelo analisador sintático antigo, incluindo @code{node.h}, @code{parser.h}, @code{graminit.h} e @code{grammar.h}.

@item 
Removidas as funções de API C pública @code{PyParser_SimpleParseStringFlags}, @code{PyParser_SimpleParseStringFlagsFilename}, @code{PyParser_SimpleParseFileFlags} e @code{PyNode_Compile} que foram descontinuadas no 3.9 em razão da mudança para o novo analisador sintático GASE.

@item 
Removido o módulo @code{formatter}, que foi descontinuado no Python 3.4. É um tanto obsoleto, pouco usado e não testado. Ele foi originalmente programado para ser removido no Python 3.6, mas tais remoções foram adiadas até depois do fim de vida do Python 2.7. Os usuários existentes devem copiar quaisquer classes que usam em seu código. (Contribuição de Dong-hee Na e Terry J. Reedy em bpo-42299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42299}.)

@item 
Removida a função @code{PyModule_GetWarningsModule()} que era inútil agora porque o módulo @code{_warnings} foi convertido em um módulo embutido no 2.6. (Contribuição de Hai Shi em bpo-42599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42599}.)

@item 
Remove apelidos descontinuados para @ref{87c,,Classes Base Abstratas de Coleções} do módulo @ref{1d,,collections}. (Contribuição de Victor Stinner em bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324}.)

@item 
O parâmetro @code{loop} foi removido da maioria da @ref{87d,,API de alto nível} do @ref{a,,asyncio} seguindo a descontinuidade no Python 3.8. A motivação por trás desta alteração é multifacetada:


@enumerate 

@item 
Isso simplifica a API de alto nível.

@item 
As funções na API de alto nível obtêm implicitamente o laço de eventos em execução do thread atual desde o Python 3.7. Não há necessidade de passar o laço de eventos para a API na maioria dos casos de uso normais.

@item 
A passagem de laço de eventos está sujeita a erros, especialmente ao lidar com laços em execução em diferentes threads.
@end enumerate

Observe que a API de baixo nível ainda aceitará @code{loop}. Veja @ref{87e,,Alterações na API Python} para exemplos de como substituir o código existente.

(Contribuição de Yurii Karabas, Andrew Svetlov, Yury Selivanov e Kyle Stanley em bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}.)
@end itemize

@node Portando para Python 3 10,Alterações de bytecode do CPython<4>,Removidos<5>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 porting-to-python-3-10}@anchor{87f}
@subsection Portando para Python 3.10


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações na sintaxe Python:: 
* Alterações na API Python: Alterações na API Python<3>. 
* Alterações na API C: Alterações na API C<6>. 

@end menu

@node Alterações na sintaxe Python,Alterações na API Python<3>,,Portando para Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-syntax}@anchor{880}
@subsubsection Alterações na sintaxe Python



@itemize *

@item 
O aviso de descontinuação agora é emitido ao compilar a sintaxe anteriormente válida se o literal numérico for seguido imediatamente por uma palavra reservada (como em @code{0in x}). Em versões futuras, ele será alterado para aviso de sintaxe e, finalmente, para um erro de sintaxe. Para se livrar do aviso e tornar o código compatível com versões futuras, basta adicionar um espaço entre o literal numérico e a palavra reservada seguinte. (Contribuição de Serhiy Storchaka em bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}.)
@end itemize

@node Alterações na API Python<3>,Alterações na API C<6>,Alterações na sintaxe Python,Portando para Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-api}@anchor{881}@anchor{whatsnew/3 10 changes-python-api}@anchor{87e}
@subsubsection Alterações na API Python



@itemize *

@item 
Os parâmetros `etype' das funções @ref{850,,format_exception()}, @ref{851,,format_exception_only()} e @ref{852,,print_exception()} no módulo @ref{fe,,traceback} foram renomeadas para `exc'. (Contribuição de Zackery Spytz e Matthias Bussonnier em bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}.)

@item 
@ref{c,,atexit}: ao sair do Python, se uma função de retorno registrada com @ref{882,,atexit.register()} falhar, sua exceção agora é registrada nos logs. Anteriormente, apenas algumas exceções eram registradas nos logs e a última exceção era sempre ignorada silenciosamente. (Contribuição de Victor Stinner em bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}.)

@item 
A classe genérica @code{Collections.abc.Callable} agora nivela os parâmetros de tipo, similar ao que @ref{7c6,,typing.Callable} faz atualmente. Isso significa que @code{collections.abc.Callable[[int, str], str]} terá @code{__args__} de @code{(int, str, str)}; anteriormente era @code{([int, str], str)}. O código que acessa os argumentos via @ref{2ed,,typing.get_args()} ou @code{__args__} precisa levar em conta esta mudança. Além disso, @ref{2c3,,TypeError} pode ser levantada para formas inválidas de parametrização @code{Collections.abc.Callable} que pode ter passada silenciosamente no Python 3.9. (Contribuição de Ken Jin em bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@item 
@ref{883,,socket.htons()} e @ref{884,,socket.ntohs()} agora levantam @ref{885,,OverflowError} em vez de @ref{1a5,,DeprecationWarning} se o parâmetro dado não couber em um inteiro sem sinal de 16 bits. (Contribuição de Erlend E. Aasland em bpo-42393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42393}.)

@item 
O parâmetro @code{loop} foi removido da maioria da @ref{87d,,API de alto nível} do @ref{a,,asyncio} seguindo a descontinuidade no Python 3.8.

A corrotina que atualmente se parece com isso:

@example
async def foo(loop):
    await asyncio.sleep(1, loop=loop)
@end example

Deve ser substituída por isso:

@example
async def foo():
    await asyncio.sleep(1)
@end example

Se @code{foo()} for especificamente projetado para `não' executar no laço de eventos em execução da thread atual (por exemplo, executar no laço de eventos de outra thread), considere usar @ref{886,,asyncio.run_coroutine_threadsafe()}.

(Contribuição de Yurii Karabas, Andrew Svetlov, Yury Selivanov e Kyle Stanley em bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}.)

@item 
O construtor @ref{887,,types.FunctionType} agora herda os embutidos atuais se o dicionário `globals' tiver nenhuma chave @code{"__builtins__"}, em vez de usar @code{@{"None": None@}} como embutidos: o mesmo comportamento que as funções @ref{180,,eval()} e @ref{17f,,exec()}. Definir uma função com @code{def function(...): ...} no Python não é afetado, globais não podem ser substituídos com esta sintaxe: também herda os embutidos atuais. (Contribuição de Victor Stinner em bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}.)
@end itemize

@node Alterações na API C<6>,,Alterações na API Python<3>,Portando para Python 3 10
@anchor{whatsnew/3 10 changes-in-the-c-api}@anchor{888}
@subsubsection Alterações na API C



@itemize *

@item 
As funções de API C @code{PyParser_SimpleParseStringFlags}, @code{PyParser_SimpleParseStringFlagsFilename}, @code{PyParser_SimpleParseFileFlags}, @code{PyNode_Compile} e o tipo usado por essas funções, @code{struct _node}, foram removidos em razão da mudança para o novo analisador sintático GASE.

O código-fonte deve ser agora compilado diretamente para um objeto código usando, por exemplo, @ref{889,,Py_CompileString()}. O objeto código resultante pode ser então avaliado usando, por exemplo, @ref{88a,,PyEval_EvalCode()}.

Especificamente:


@itemize *

@item 
Uma chamada para @code{PyParser_SimpleParseStringFlags} seguida por @code{PyNode_Compile} pode ser substituída por @ref{889,,Py_CompileString()}.

@item 
Não há substituição direta para @code{PyParser_SimpleParseFileFlags}. Para compilar código de um argumento @code{FILE *}, você vai precisar ler o arquivo em C e passar o buffer resultante para @ref{889,,Py_CompileString()}.

@item 
Para compilar um arquivo de um nome de arquivo @code{char *} dado, abra explicitamente o arquivo, leia-o e compile o resultado. Uma forma de fazer isso é usando o módulo @ref{7f,,io} com @ref{3be,,PyImport_ImportModule()}, @ref{39f,,PyObject_CallMethod()}, @ref{88b,,PyBytes_AsString()} e @ref{889,,Py_CompileString()}, como esboçado abaixo. (Declarações e tratamento de erro foram omitidos.)

@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 
Para objetos @code{FrameObject}, o membro @ref{88c,,f_lasti} agora representa um deslocamento de código de palavra em vez de um deslocamento simples na string de bytecode. Isso significa que esse número precisa ser multiplicado por 2 para ser usado com APIs que esperam um deslocamento de byte (como @ref{88d,,PyCode_Addr2Line()}, por exemplo). Observe também que o membro @code{f_lasti} de objetos @code{FrameObject} não é considerado estável: por favor, use @ref{78b,,PyFrame_GetLineNumber()} em vez disso.
@end itemize
@end itemize

@node Alterações de bytecode do CPython<4>,Mudanças na construção<4>,Portando para Python 3 10,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 cpython-bytecode-changes}@anchor{88e}
@subsection Alterações de bytecode do CPython



@itemize *

@item 
A instrução @code{MAKE_FUNCTION} agora aceita um dicionário ou uma tupla de strings como as anotações da função. (Contribuição de Yurii Karabas e Inada Naoki em bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}.)
@end itemize

@node Mudanças na construção<4>,Alterações na API C<7>,Alterações de bytecode do CPython<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 build-changes}@anchor{88f}
@subsection Mudanças na construção



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}: Python agora exige OpenSSL 1.1.1 ou mais novo. OpenSSL 1.0.2 não é mais suportado. (Contribuição de Christian Heimes em bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}.)

@item 
As funções C99 @code{snprintf()} e @code{vsnprintf()} agora são exigidas para compilar o Python. (Contribuição de Victor Stinner em bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}.)

@item 
@ref{cf,,sqlite3} exige SQLite 3.7.15 ou superior. (Contribuição de Sergey Fedoseev e Erlend E. Aasland em bpo-40744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40744} e bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}.)

@item 
O módulo @ref{c,,atexit} deve agora sempre ser construído como um módulo embutido. (Contribuição de Victor Stinner em bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}.)

@item 
Adiciona a opção @ref{890,,--disable-test-modules} ao script @code{configure}: não constrói nem instala módulos de teste. (Contribuição de Xavier de Gaye, Thomas Petazzoni e Peixing Xin em bpo-27640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27640}.)

@item 
Adiciona a @ref{891,,option --with-wheel-pkg-dir=CAMINHO} ao script @code{./configure}. Se especificado, o módulo @ref{55,,ensurepip} procura por pacotes wheel de @code{setuptools} e @code{pip} neste diretório: se ambos estiverem presentes, esses pacotes wheel são usados em vez de pacotes wheel empacotados por ensurepip.

Algumas distribuições Linux possuem políticas de empacotamento recomendando evitar o empacotamento de dependências. Por exemplo, Fedora instala pacotes wheel no diretório @code{/usr/share/python-wheels/} e não instala o pacote @code{ensurepip._bundled}.

(Contribuição de Victor Stinner em bpo-42856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42856}.)

@item 
Adiciona uma nova @ref{892,,opção --without-static-libpython de configure} para não construir biblioteca estática @code{libpythonMAJOR.MINOR.a} e não instala o arquivo objeto @code{python.o}.

(Contribuição de Victor Stinner em bpo-43103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43103}.)

@item 
O script @code{configure} agora usa o utilitário @code{pkg-config}, se disponível, para detectar a localização dos cabeçalhos Tcl/Tk e bibliotecas. Como antes, esses locais podem ser explicitamente especificados com as opções de configuração @code{--with-tcltk-includes} e @code{--with-tcltk-libs} . (Contribuição de Manolis Stamatogiannakis em bpo-42603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42603}.)

@item 
Adiciona a opção @ref{893,,--with-openssl-rpath} ao script @code{configure}. A opção simplifica a construção do Python com uma instalação OpenSSL personalizada, por exemplo, @code{./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto}. (Contribuição de Christian Heimes em bpo-43466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43466}.)
@end itemize

@node Alterações na API C<7>,Recursos de segurança notáveis no 3 10 7,Mudanças na construção<4>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 c-api-changes}@anchor{894}
@subsection Alterações na API C


@menu
* PEP 652; Mantendo a ABI estável: PEP 652 Mantendo a ABI estável. 
* Novas funcionalidades: Novas funcionalidades<8>. 
* Portando para Python 3.10: Portando para Python 3 10<2>. 
* Descontinuados: Descontinuados<6>. 
* Removidos: Removidos<6>. 

@end menu

@node PEP 652 Mantendo a ABI estável,Novas funcionalidades<8>,,Alterações na API C<7>
@anchor{whatsnew/3 10 pep-652-maintaining-the-stable-abi}@anchor{895}
@subsubsection PEP 652: Mantendo a ABI estável


A ABI (interface binária de aplicação) Estável para módulos de extensão ou Python embutido agora está explicitamente definido. @ref{553,,Estabilidade da API C} descreve as garantias de estabilidade da API C e ABI junto com as melhores práticas para usar a ABI estável.

(Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 652
PEP 652@footnote{https://peps.python.org/pep-0652/} e bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}.)

@node Novas funcionalidades<8>,Portando para Python 3 10<2>,PEP 652 Mantendo a ABI estável,Alterações na API C<7>
@anchor{whatsnew/3 10 id1}@anchor{896}
@subsubsection Novas funcionalidades



@itemize *

@item 
O resultado de @ref{897,,PyNumber_Index()} agora sempre tem o tipo exato @ref{257,,int}. Anteriormente, o resultado poderia ser uma instância de uma subclasse de @code{int}. (Contribuição de Serhiy Storchaka em bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}.)

@item 
Adiciona um novo membro @ref{898,,orig_argv} à estrutura @ref{3a6,,PyConfig}: a lista dos argumentos originais da linha de comando passados para o executável Python. (Contribuição de Victor Stinner em bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}.)

@item 
As macros @ref{899,,PyDateTime_DATE_GET_TZINFO()} e @ref{89a,,PyDateTime_TIME_GET_TZINFO()} foram adicionadas para acessar os atributos @code{tzinfo} dos objetos @ref{1cc,,datetime.datetime} e @ref{1ce,,datetime.time}. (Contribuição de Zackery Spytz em bpo-30155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30155}.)

@item 
Adiciona uma função @ref{89b,,PyCodec_Unregister()} para cancelar um registro de uma função de pesquisa de codecs. (Contribuição de Hai Shi em bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}.)

@item 
A função @ref{89c,,PyIter_Send()} foi adicionada para permitir o envio de valor para o iterador sem levantar a exceção @code{StopIteration}. (Contribuição de Vladimir Matveev em bpo-41756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41756}.)

@item 
Adiciona @ref{89d,,PyUnicode_AsUTF8AndSize()} à API C limitada. (Contribuição de Alex Gaynor em bpo-41784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41784}.)

@item 
Adiciona a função @ref{365,,PyModule_AddObjectRef()}: semelhante a @ref{366,,PyModule_AddObject()}, mas não roube uma referência ao valor em caso de sucesso. (Contribuição de Victor Stinner em bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}.)

@item 
Adiciona as funções @ref{89e,,Py_NewRef()} e @ref{89f,,Py_XNewRef()} para incrementar a contagem de referências de um objeto e retornar o objeto. (Contribuição de Victor Stinner em bpo-42262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42262}.)

@item 
As funções @ref{57e,,PyType_FromSpecWithBases()} e @ref{551,,PyType_FromModuleAndSpec()} agora aceitam uma única classe como o argumento `bases'. (Contribuição de Serhiy Storchaka em bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423}.)

@item 
A função @ref{551,,PyType_FromModuleAndSpec()} agora aceita o slot NULL @code{tp_doc}. (Contribuição de Hai Shi em bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832}.)

@item 
A função @ref{8a0,,PyType_GetSlot()} pode aceitar @ref{77f,,tipos estáticos}. (Contribuição de Hai Shi e Petr Viktorin em bpo-41073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41073}.)

@item 
Adiciona uma nova função @ref{8a1,,PySet_CheckExact()} à C-API para verificar se um objeto é uma instância de @ref{5d9,,set}, mas não uma instância de um subtipo. (Contribuição de Pablo Galindo em bpo-43277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43277}.)

@item 
Adiciona @ref{8a2,,PyErr_SetInterruptEx()} que permite passar um número de sinal para simular. (Contribuição de Antoine Pitrou em bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}.)

@item 
A API C limitada agora é suportada se o @ref{1f9,,Python for compilado no modo de depuração} (se a macro @code{Py_DEBUG} estiver definida). Na API C limitada, as funções @ref{56e,,Py_INCREF()} e @ref{56f,,Py_DECREF()} agora são implementadas como chamadas de função opacas, em vez de acessar diretamente o membro @ref{8a3,,PyObject.ob_refcnt}, se o Python for compilado no modo de depuração e a macro @code{Py_LIMITED_API} tiver como alvo o Python 3.10 ou mais recente. Tornou-se possível suportar a API C limitada no modo de depuração porque a estrutura @ref{339,,PyObject} é a mesma no modo de lançamento e depuração desde o Python 3.8 (consulte bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}).

A API C limitada ainda não é suportada na compilação especial @ref{395,,--with-trace-refs} (macro @code{Py_TRACE_REFS}). (Contribuição de Victor Stinner em bpo-43688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43688}.)

@item 
Adiciona a função @ref{8a4,,Py_Is(x@comma{} y)} para testar se o objeto `x' é o objeto `y', o mesmo que @code{x is y} em Python. Adiciona também as funções @ref{8a5,,Py_IsNone()}, @ref{8a6,,Py_IsTrue()}, @ref{8a7,,Py_IsFalse()} para testar se um objeto é, respectivamente, o singleton @code{None}, o singleton @code{True} ou o singleton @code{False}. (Contribuição de Victor Stinner em bpo-43753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43753}.)

@item 
Adiciona novas funções para controlar o coletor de lixo do código C: @ref{8a8,,PyGC_Enable()}, @ref{8a9,,PyGC_Disable()}, @ref{8aa,,PyGC_IsEnabled()}. Estas funções permitem ativar, desativar e consultar o estado do coletor de lixo do código C sem precisar importar o módulo @ref{60,,gc}.

@item 
Adiciona um novo sinalizador de tipo @ref{582,,Py_TPFLAGS_DISALLOW_INSTANTIATION} para impedir a criação de instâncias de tipo. (Contribuição de Victor Stinner em bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916}.)

@item 
Adiciona um novo sinalizador de tipo @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} para criar objetos de tipo imutável: atributos de tipo não podem ser definidos nem excluídos. (Contribuição de Victor Stinner e Erlend E. Aasland em bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}.)
@end itemize

@node Portando para Python 3 10<2>,Descontinuados<6>,Novas funcionalidades<8>,Alterações na API C<7>
@anchor{whatsnew/3 10 id2}@anchor{8ab}
@subsubsection Portando para Python 3.10



@itemize *

@item 
A macro @code{PY_SSIZE_T_CLEAN} deve agora ser definida para usar os formatos @ref{571,,PyArg_ParseTuple()} e @ref{8ac,,Py_BuildValue()} que usam @code{#}: @code{es#}, @code{et#}, @code{s#}, @code{u#}, @code{y#}, @code{z#}, @code{U#} e @code{Z#}. Veja @ref{8ad,,Análise de argumentos e construção de valores} e 
@geindex Propostas de Melhorias do Python; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}. (Contribuição de Victor Stinner em bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}.)

@item 
Como @ref{8ae,,Py_REFCNT()} é alterado para a função estática em linha, @code{Py_REFCNT(obj) = new_refcnt} deve ser substituído por @code{Py_SET_REFCNT(obj, new_refcnt)}: veja @ref{8af,,Py_SET_REFCNT()} (disponível desde o Python 3.9). Para compatibilidade com versões anteriores, esta macro pode ser usada:

@example
#if PY_VERSION_HEX < 0x030900A4
#  define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
#endif
@end example

(Contribuição de Victor Stinner em bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}.)

@item 
A chamada de @ref{387,,PyDict_GetItem()} sem a @ref{159,,GIL} retida era permitido por razões históricas. Isso não é mais permitido. (Contribuição de Victor Stinner em bpo-40839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40839}.)

@item 
@code{PyUnicode_FromUnicode(NULL, size)} e @code{PyUnicode_FromStringAndSize(NULL, size)} levantam @code{DeprecationWarning} agora. Use @ref{8b0,,PyUnicode_New()} para alocar objeto Unicode sem dados iniciais. (Contribuição de Inada Naoki em bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
A estrutura privada @code{_PyUnicode_Name_CAPI} da API PyCapsule @code{unicodedata.ucnhash_CAPI} foi movida para a API C interna. (Contribuição de Victor Stinner em bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}.)

@item 
As funções @ref{3b3,,Py_GetPath()}, @ref{3b5,,Py_GetPrefix()}, @ref{3b1,,Py_GetExecPrefix()}, @ref{3b7,,Py_GetProgramFullPath()}, @ref{3ba,,Py_GetPythonHome()} e @ref{3b9,,Py_GetProgramName()} agora retornam @code{NULL} se chamadas antes de @ref{8b1,,Py_Initialize()} (antes do Python ser inicializado). Use a nova API de @ref{3a7,,Configuração de inicialização do Python} para obter a @ref{8b2,,Python Path Configuration}. (Contribuição de Victor Stinner em bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}.)

@item 
As macros @ref{38e,,PyList_SET_ITEM()}, @ref{38d,,PyTuple_SET_ITEM()} e @ref{8b3,,PyCell_SET()} não podem mais ser usadas como valor-l ou valor-r. Por exemplo, @code{x = PyList_SET_ITEM(a, b, c)} e @code{PyList_SET_ITEM(a, b, c) = x} agora falham com um erro do compilador. Isso previne bugs como o teste @code{if (PyList_SET_ITEM (a, b, c) < 0) ...}. (Contribuição de Zackery Spytz e Victor Stinner em bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459}.)

@item 
Os arquivos de API não limitada @code{odictobject.h}, @code{parser_interface.h}, @code{piclebufobject.h}, @code{pyarena.h}, @code{pyctype.h}, @code{pydebug. h}, @code{pyfpe.h} e @code{pytime.h} foram movidos para o diretório @code{Include/cpython}. Esses arquivos não devem ser incluídos diretamente, pois já estão incluídos em @code{Python.h}; veja @ref{784,,Arquivos de inclusão}. Se eles foram incluídos diretamente, considere incluir @code{Python.h} em vez disso. (Contribuição de Nicholas Sim em bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}.)

@item 
Use o sinalizador de tipo @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} para criar objetos de tipo imutável. Não confie em @ref{8b4,,Py_TPFLAGS_HEAPTYPE} para decidir se um objeto de tipo é mutável ou não; verifique se @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} está definido. (Contribuição de Victor Stinner e Erlend E. Aasland em bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}.)

@item 
A função não documentada @code{Py_FrozenMain} foi removida da API limitada. A função é útil principalmente para compilações personalizadas do Python. (Contribuição de Petr Viktorin em bpo-26241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26241}.)
@end itemize

@node Descontinuados<6>,Removidos<6>,Portando para Python 3 10<2>,Alterações na API C<7>
@anchor{whatsnew/3 10 id3}@anchor{8b5}
@subsubsection Descontinuados



@itemize *

@item 
A função @code{PyUnicode_InternImmortal()} agora foi descontinuada e será removida no Python 3.12: use @ref{8b6,,PyUnicode_InternInPlace()} em vez disso. (Contribuição de Victor Stinner em bpo-41692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41692}.)
@end itemize

@node Removidos<6>,,Descontinuados<6>,Alterações na API C<7>
@anchor{whatsnew/3 10 id4}@anchor{8b7}
@subsubsection Removidos



@itemize *

@item 
Removidas as funções @code{Py_UNICODE_str*} que manipulam strings @code{Py_UNICODE*}. (Contribuição de Inada Naoki em bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}.)


@itemize *

@item 
@code{Py_UNICODE_strlen}: use @ref{8b8,,PyUnicode_GetLength()} ou @ref{8b9,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat}: use @ref{8ba,,PyUnicode_CopyCharacters()} ou @ref{38a,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy}, @code{Py_UNICODE_strncpy}: use @ref{8ba,,PyUnicode_CopyCharacters()} ou @ref{8bb,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp}: use @ref{8bc,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp}: use @ref{8bd,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr}, @code{Py_UNICODE_strrchr}: use
@ref{8be,,PyUnicode_FindChar()}
@end itemize

@item 
Removida @code{PyUnicode_GetMax()}. Migre para as novas APIs (
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}). (Contribuição de Inada Naoki em bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}.)

@item 
Removida @code{PyLong_FromUnicode()}. Migre para @ref{8bf,,PyLong_FromUnicodeObject()}. (Contribuição de Inada Naoki em bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}.)

@item 
Removida @code{PyUnicode_AsUnicodeCopy()}. Use @ref{8c0,,PyUnicode_AsUCS4Copy()} ou @ref{8c1,,PyUnicode_AsWideCharString()} (Contribuição de Inada Naoki em bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}.)

@item 
Removida a variável @code{_Py_CheckRecursionLimit}: foi substituída por @code{ceval.recursion_limit} da estrutura @ref{8c2,,PyInterpreterState}. (Contribuição de Victor Stinner em bpo-41834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41834}.)

@item 
Removidas as macros não documentadas @code{Py_ALLOW_RECURSION} e @code{Py_END_ALLOW_RECURSION} e o campo @code{recursion_critical} da estrutura @ref{8c2,,PyInterpreterState}. (Contribuição de Serhiy Storchaka em bpo-41936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41936}.)

@item 
Removida a função @code{PyOS_InitInterrupts()} não documentada. Inicializar o Python já instala implicitamente manipuladores de sinal: veja @ref{8c3,,PyConfig.install_signal_handlers}. (Contribuição de Victor Stinner em bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}.)

@item 
Remova a função @code{PyAST_Validate()}. Não é mais possível construir um objeto AST (tipo @code{mod_ty}) com a API C pública. A função já foi excluída da API C limitada (
@geindex Propostas de Melhorias do Python; PEP 384
PEP 384@footnote{https://peps.python.org/pep-0384/}). (Contribuição de Victor Stinner em bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Remove o arquivo de cabeçalho @code{symtable.h} e as funções não 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

A função @code{Py_SymtableString()} fazia parte da ABI estável por engano, mas não pôde ser usada, porque o arquivo de cabeçalho @code{symtable.h} foi excluído da API C limitada.

Use o módulo Python @ref{d8,,symtable} em vez disso. (Contribuição de Victor Stinner em bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Remove @ref{586,,PyOS_ReadlineFunctionPointer()} dos cabeçalhos limitados da API C e de @code{python3.dll}, a biblioteca que fornece a ABI estável no Windows. Como a função recebe um argumento @code{FILE*}, sua estabilidade ABI não pode ser garantida. (Contribuição de Petr Viktorin em bpo-43868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43868}.)

@item 
Remove os arquivos de cabeçalho @code{ast.h}, @code{asdl.h} e @code{Python-ast.h}. Essas funções não estavam documentadas e excluídas da API C limitada. A maioria dos nomes definidos por esses arquivos de cabeçalho não foram prefixados por @code{Py} e, portanto, podem criar conflitos de nomes. Por exemplo, @code{Python-ast.h} definiu uma macro @code{Yield} que estava em conflito com o nome @code{Yield} usado pelo cabeçalho @code{<winbase.h>} do Windows. Use o módulo Python @ref{8,,ast} em vez disso. (Contribuição de Victor Stinner em bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Remove as funções do compilador e do analisador usando o tipo @code{struct _mod}, porque a API AST C pública foi removida:


@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

Essas funções não estavam documentadas e excluídas da API C limitada. (Contribuição de Victor Stinner em bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
Remove o arquivo de cabeçalho @code{pyarena.h} com funções:


@itemize *

@item 
@code{PyArena_New()}

@item 
@code{PyArena_Free()}

@item 
@code{PyArena_Malloc()}

@item 
@code{PyArena_AddPyObject()}
@end itemize

Essas funções não estavam documentadas, excluídas da API C limitada e eram usadas apenas internamente pelo compilador. (Contribuição de Victor Stinner em bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}.)

@item 
O membro @code{PyThreadState.use_tracing} foi removido para otimizar o Python. (Contribuição de Mark Shannon em bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}.)
@end itemize

@node Recursos de segurança notáveis no 3 10 7,Recursos de segurança notáveis no 3 10 8,Alterações na API C<7>,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-7}@anchor{8c4}
@subsection Recursos de segurança notáveis no 3.10.7


Converter entre @ref{257,,int} e @ref{44c,,str} em bases diferentes de 2 (binário), 4, 8 (octal), 16 (hexadecimal) ou 32 como base 10 (decimal) agora levanta uma exceção @ref{202,,ValueError} se o número de dígitos em forma de string estiver acima de um limite para evitar possíveis ataques de negação de serviço devido à complexidade algorítmica. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}. Este limite pode ser configurado ou desabilitado por variável de ambiente, sinalizador de linha de comando ou APIs de @ref{d9,,sys}. Veja a documentação de @ref{5f5,,limitação de comprimento de conversão de string inteira}. O limite padrão é de 4300 dígitos em forma de string.

@node Recursos de segurança notáveis no 3 10 8,Alterações notáveis no 3 10 12,Recursos de segurança notáveis no 3 10 7,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-8}@anchor{8c5}
@subsection Recursos de segurança notáveis no 3.10.8


O módulo descontinuado @code{mailcap} agora se recusa a injetar texto não seguro (nomes de arquivos, tipos MIME, parâmetros) em comandos shell. Em vez de usar esse texto, ele avisará e agirá como se uma correspondência não fosse encontrada (ou para comandos de teste, como se o teste tivesse falhado). (Contribuição de Petr Viktorin em gh-98966@footnote{https://github.com/python/cpython/issues/98966}.)

@node Alterações notáveis no 3 10 12,,Recursos de segurança notáveis no 3 10 8,O que há de novo no Python 3 10
@anchor{whatsnew/3 10 notable-changes-in-3-10-12}@anchor{8c6}
@subsection Alterações notáveis no 3.10.12


@menu
* tarfile: tarfile<3>. 

@end menu

@node tarfile<3>,,,Alterações notáveis no 3 10 12
@anchor{whatsnew/3 10 tarfile}@anchor{8c7}
@subsubsection tarfile



@itemize *

@item 
Os métodos de extração em @ref{de,,tarfile} e @ref{46b,,shutil.unpack_archive()}, têm um novo argumento `filter' que permite limitar recursos do tar que podem ser surpreendentes ou perigosos, como criar arquivos fora do diretório de destino. Veja @ref{46c,,Filtros de extração} para detalhes. No Python 3.12, usar sem o argumento `filter' mostrará um @ref{1a5,,DeprecationWarning}. No Python 3.14, o padrão mudará para @code{'data'}. (Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node O que há de novo no Python 3 9,O que há de novo no Python 3 8,O que há de novo no Python 3 10,O que há de novo no Python
@anchor{whatsnew/3 9 doc}@anchor{8c8}@anchor{whatsnew/3 9 translation-repo}@anchor{8c9}@anchor{whatsnew/3 9 what-s-new-in-python-3-9}@anchor{8ca}
@section O que há de novo no 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.

Este artigo explica os novos recursos no Python 3.9, em comparação com 3.8. Python 3.9 foi lançado em 15 de outubro de 2020. Veja o @ref{13c,,changelog}. para uma lista completa de mudanças.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 596
PEP 596@footnote{https://peps.python.org/pep-0596/} - Python 3.9 Release Schedule


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<5>. 
* Você deve verificar DeprecationWarning no seu código:: 
* Novas funcionalidades: Novas funcionalidades<9>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<5>. 
* Novos módulos: Novos módulos<5>. 
* Módulos melhorados: Módulos melhorados<5>. 
* Otimizações: Otimizações<5>. 
* Descontinuados: Descontinuados<7>. 
* Removidos: Removidos<7>. 
* Portando para Python 3.9: Portando para Python 3 9. 
* Mudanças na construção: Mudanças na construção<5>. 
* Alterações na API C: Alterações na API C<9>. 
* Alterações notáveis no Python 3.9.1: Alterações notáveis no Python 3 9 1. 
* Alterações notáveis no Python 3.9.2: Alterações notáveis no Python 3 9 2. 
* Alterações notáveis no Python 3.9.3: Alterações notáveis no Python 3 9 3. 
* Alterações notáveis no Python 3.9.5: Alterações notáveis no Python 3 9 5. 
* Recursos de segurança notáveis no 3.9.14: Recursos de segurança notáveis no 3 9 14. 
* Alterações notáveis no 3.9.17: Alterações notáveis no 3 9 17. 

@end menu

@node Resumo – Destaques da versão<5>,Você deve verificar DeprecationWarning no seu código,,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 summary-release-highlights}@anchor{8cb}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.9.
@c Brevity is key.

Novos recursos de sintaxe:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}, operadores de união adicionados ao @code{dict};

@item 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}, type hinting genéricos em coleções comuns;

@item 
@geindex Propostas de Melhorias do Python; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}, restrições de gramática relaxadas em decoradores.
@end itemize

Novos recursos embutidos:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/}, métodos de strings para remover prefixos e sufixos.
@end itemize

Novos recursos na biblioteca padrão:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}, anotações flexíveis de função e variável;

@item 
@ref{47a,,os.pidfd_open()} adicionada para permitidos gerenciamento de processo sem corridas e sinais.
@end itemize

Melhorias no interpretador:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}, acesso rápido ao estado do módulo a partir de métodos de tipos de extensão C;

@item 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}, CPython agora usa um novo analisador sintático com base em GASE;

@item 
vários tipos embutidos do Python (range, tuple, set, frozenset, list, dict) estão agora mais rápidos usando vectorcall da 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/};

@item 
coleta de lixo não causa bloqueio em objetos ressuscitados;

@item 
vários módulos do Python (@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}) agora usam inicialização multifásica conforme definido pela PEP 489;

@item 
vários módulos da biblioteca padrão (@code{audioop}, @ref{8,,ast}, @ref{66,,grp}, @code{_hashlib}, @ref{b2,,pwd}, @code{_posixsubprocess}, @ref{b8,,random}, @ref{c1,,select}, @ref{d5,,struct}, @ref{e1,,termios}, @ref{133,,zlib}) estão agora usando a ABI estável definida pela PEP 384.
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}, o banco de dados de fusos horários da IANA é agora apresentado na biblioteca padrão no módulo @ref{134,,zoneinfo};

@item 
uma implementação de um tipo topológico de um grafo agora é fornecida no novo módulo @ref{65,,graphlib}.
@end itemize

Alterações no processo de lançamento:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/}, CPython adota um ciclo de lançamento anual.
@end itemize

@node Você deve verificar DeprecationWarning no seu código,Novas funcionalidades<9>,Resumo – Destaques da versão<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 you-should-check-for-deprecationwarning-in-your-code}@anchor{8cc}
@subsection Você deve verificar DeprecationWarning no seu código


Quando o Python 2.7 ainda tinha suporte, muitas funcionalidades do Python 3 foram mantidas para compatibilidade com versões anteriores do Python 2.7. Com o fim do suporte ao Python 2, essas camadas de compatibilidade com versões anteriores foram removidas ou serão removidas em breve. A maioria deles emitia um aviso de @ref{1a5,,DeprecationWarning} por vários anos. Por exemplo, usar @code{collections.Mapping} em vez de @code{collections.abc.Mapping} emite uma @ref{1a5,,DeprecationWarning} desde Python 3.3, lançado em 2012.

Teste sua aplicação com a opção de linha de comando @ref{8cd,,-W} @code{default} para ver @ref{1a5,,DeprecationWarning} e @ref{8ce,,PendingDeprecationWarning}, ou mesmo com @ref{8cd,,-W} @code{error} para tratá-los como erros. @ref{8cf,,Filtro de avisos} pode ser usado para ignorar avisos de código de terceiros.

Python 3.9 é a última versão que fornece essas camadas de compatibilidade com versões anteriores do Python 2, para dar mais tempo aos mantenedores de projetos Python para organizar a remoção do suporte Python 2 e adicionar suporte para Python 3.9.

Aliases para @ref{87c,,classes bases abstratas} no módulo @ref{1d,,collections}, como o alias @code{collections.Mapping} para @ref{8d0,,collections.abc.Mapping}, são mantidos para uma última versão para compatibilidade reversa. Eles serão removidos do Python 3.10.

De maneira mais geral, experimente executar seus testes no @ref{1f8,,Modo de Desenvolvimento do Python}, que ajuda a preparar seu código para torná-lo compatível com a próxima versão do Python.

Observação: vários itens descontinuados pré-existentes também foram removidos nesta versão do Python. Consulte a seção @ref{8d1,,Removidos}.

@node Novas funcionalidades<9>,Outras mudanças na linguagem<5>,Você deve verificar DeprecationWarning no seu código,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 new-features}@anchor{8d2}
@subsection Novas funcionalidades


@menu
* Operadores de mesclagem & atualização de dicionário:: 
* Novos métodos de strings para remover prefixos e sufixos:: 
* Type hinting genéricos nas coleções padrão:: 
* Novo analisador sintático:: 

@end menu

@node Operadores de mesclagem & atualização de dicionário,Novos métodos de strings para remover prefixos e sufixos,,Novas funcionalidades<9>
@anchor{whatsnew/3 9 dictionary-merge-update-operators}@anchor{8d3}
@subsubsection Operadores de mesclagem & atualização de dicionário


Operadores de mesclagem (@code{|}) e atualização (@code{|=}) foram adicionados à classe embutida @ref{256,,dict}. Eles complementam o métodos @code{dict.update} e @code{@{**d1, **d2@}} existentes de mesclagem de dicionários.

Exemplo:

@example
>>> x = @{"chave1": "valor1 from x", "chave2": "valor2 from x"@}
>>> y = @{"chave2": "valor2 from y", "chave3": "valor3 from y"@}
>>> x | y
@{'chave1': 'valor1 from x', 'chave2': 'valor2 from y', 'chave3': 'valor3 from y'@}
>>> y | x
@{'chave2': 'valor2 from x', 'chave3': 'valor3 from y', 'chave1': 'valor1 from x'@}
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} para uma descrição completa. (Contribuição de Brandt Bucher em bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}.)

@node Novos métodos de strings para remover prefixos e sufixos,Type hinting genéricos nas coleções padrão,Operadores de mesclagem & atualização de dicionário,Novas funcionalidades<9>
@anchor{whatsnew/3 9 new-string-methods-to-remove-prefixes-and-suffixes}@anchor{8d4}
@subsubsection Novos métodos de strings para remover prefixos e sufixos


@ref{8d5,,str.removeprefix(prefix)} e @ref{8d6,,str.removesuffix(suffix)} foram adicionados para remover facilmente um prefixo ou sufixo desnecessário de uma string. Os métodos correspondentes @code{bytes}, @code{bytearray} e @code{collections.UserString} também foram adicionados. Veja 
@geindex Propostas de Melhorias do Python; PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/} para uma descrição completa. (Contribuição de Dennis Sweeney em bpo-39939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39939}.)

@node Type hinting genéricos nas coleções padrão,Novo analisador sintático,Novos métodos de strings para remover prefixos e sufixos,Novas funcionalidades<9>
@anchor{whatsnew/3 9 type-hinting-generics-in-standard-collections}@anchor{8d7}
@subsubsection Type hinting genéricos nas coleções padrão


Agora, nas anotações de tipo, você pode usar tipos de coleção embutidos como @code{list} e @code{dict} como tipos genéricos, em vez de importar os tipos de letras maiúsculas correspondentes (por exemplo, @code{List} ou @code{Dict}) de @code{typing}. Agora, outros tipos na biblioteca padrão também são genéricos, por exemplo, @code{queue.Queue}.

Exemplo:

@example
def cumprimentar_todos(nomes: list[str]) -> None:
    for nome in nomes:
        print("Olá", nome)
@end example

Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} para mais detalhes. (Contribuição de Guido van Rossum, Ethan Smith e Batuhan Taşkaya em bpo-39481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39481}.)

@node Novo analisador sintático,,Type hinting genéricos nas coleções padrão,Novas funcionalidades<9>
@anchor{whatsnew/3 9 new-parser}@anchor{8d8}
@subsubsection Novo analisador sintático


O Python 3.9 usa um novo analisador sintático, baseado em GASE@footnote{https://pt.wikipedia.org/wiki/Gramática_de_análise_sintática_de_expressão} em vez de LL(1)@footnote{https://pt.wikipedia.org/wiki/Analisador_sintático_LL}. O desempenho do novo analisador sintático é aproximadamente comparável ao do analisador sintático antigo, mas o formalismo do GASE é mais flexível que do LL(1) quando se trata de projetar novos recursos de linguagem. Começaremos a usar essa flexibilidade no Python 3.10 e posterior.

O módulo @ref{8,,ast} usa o novo analisador e produz o mesmo AST que o analisador antigo.

No Python 3.10, o analisador antigo será excluído e todas as funcionalidades que dependem dele (principalmente o módulo @code{parser}, que foi descontinuado a muito tempo). No Python 3.9 `apenas', você pode voltar ao analisador LL(1) usando uma opção de linha de comando (@code{-X oldparser}) ou uma variável de ambiente (@code{PYTHONOLDPARSER=1}).

Consulte 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} para mais detalhes. (Contribuição de Guido van Rossum, Pablo Galindo e Lysandros Nikolaou em bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}.)

@node Outras mudanças na linguagem<5>,Novos módulos<5>,Novas funcionalidades<9>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 other-language-changes}@anchor{8d9}
@subsection Outras mudanças na linguagem



@itemize *

@item 
@ref{8da,,__import__()} agora levanta @ref{419,,ImportError} em vez de @ref{202,,ValueError}, o que é usado para ocorrer quando uma importação relativa passou de seu um pacote de nível superior. (Contribuição de Ngalim Siregar em bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}.)

@item 
Agora, o Python obtém o caminho absoluto do nome do arquivo do script especificado na linha de comando (p.ex., @code{python3 script.py}): o atributo @code{__file__} do módulo @ref{1,,__main__} tornou-se um caminho absoluto, não um caminho relativo. Esses caminhos agora permanecem válidos depois que o diretório atual é alterado por @ref{60d,,os.chdir()}. Como efeito colateral, o traceback também exibe o caminho absoluto para quadros de módulos de @ref{1,,__main__} neste caso. (Contribuição de Victor Stinner em bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}.)

@item 
No @ref{1f8,,Modo de Desenvolvimento do Python} e na @ref{1f9,,compilação de depuração} , os argumentos `encoding' e `errors' agora são verificados quanto às operações de codificação e decodificação de strings. Exemplos: @ref{51c,,open()}, @ref{8db,,str.encode()} e @ref{8dc,,bytes.decode()}.

Por padrão, para obter o melhor desempenho, o argumento `errors' é verificado apenas no primeiro erro de codificação/decodificação, e o argumento `encoding' às vezes é ignorado para strings vazias. (Contribuição de Victor Stinner em bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}.)

@item 
@code{"".replace("", s, n)} agora retorna @code{s} em vez de uma string vazia para todos @code{n} não zero. Isso é agora consistente com @code{"".replace("", s)}. Há alterações similares para objetos @ref{1c2,,bytes} e @ref{2ea,,bytearray}. (Contribuição de Serhiy Storchaka em bpo-28029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28029}.)

@item 
Qualquer expressão válida agora pode ser usada como @ref{731,,decorador}. Anteriormente, a gramática era muito mais restritiva. Veja 
@geindex Propostas de Melhorias do Python; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para detalhes. (Contribuição de Brandt Bucher em bpo-39702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39702}.)

@item 
Aprimorada a ajuda para o módulo @code{digitando}. Agora, as linhas de documento são mostradas para todos os formulários especiais e aliases genéricos especiais (como @code{Union} e @code{List}). Usando @ref{8dd,,help()} com alias genérico como @code{List[int]} mostrará a ajuda para o tipo concreto correspondente (neste caso, @code{list}). (Contribuição de Serhiy Storchaka em bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}.)

@item 
A execução paralela de @ref{8de,,aclose()} / @ref{8df,,asend()} / @ref{4f9,,athrow()} é agora proibida e @code{ag_running} agora reflete o status atual de execução do gerador async. (Contribuição de Yury Selivanov em bpo-30773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30773}.)

@item 
Erros inesperados ao chamar o método @code{__iter__} não são mais mascarados por @code{TypeError} no operador @ref{2f4,,in} e nas funções @ref{8e0,,contains()}, @ref{8e1,,indexOf()} e @ref{8e2,,countOf()} do módulo @ref{9f,,operator}. (Contribuição de Serhiy Storchaka em bpo-40824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40824}.)

@item 
Expressões lambda sem parênteses não podem mais ser a parte da expressão em uma cláusula @code{if} em compreensões e expressões geradoras. Veja bpo-41848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41848} e bpo-43755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43755} para detalhes.
@end itemize

@node Novos módulos<5>,Módulos melhorados<5>,Outras mudanças na linguagem<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 new-modules}@anchor{8e3}
@subsection Novos módulos


@menu
* zoneinfo:: 
* graphlib:: 

@end menu

@node zoneinfo,graphlib,,Novos módulos<5>
@anchor{whatsnew/3 9 zoneinfo}@anchor{8e4}
@subsubsection zoneinfo


O módulo @ref{134,,zoneinfo} oferece suporte ao banco de dados de fuso horário da IANA para a biblioteca padrão. Ele adiciona @ref{8e5,,zoneinfo.ZoneInfo}, uma implementação concreta @ref{5de,,datetime.tzinfo}, apoiada pelos dados do fuso horário do sistema.

Exemplo:

@example
>>> from zoneinfo import ZoneInfo
>>> from datetime import datetime, timedelta

>>> # Tempo em fuso horário com horário de verão
>>> dt = datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(dt)
2020-10-31 12:00:00-07:00
>>> dt.tzname()
'PDT'

>>> # Tempo padrão
>>> dt += timedelta(days=7)
>>> print(dt)
2020-11-07 12:00:00-08:00
>>> print(dt.tzname())
PST
@end example

Como fonte alternativa de dados para plataformas que não entregam o banco de dados da IANA, o módulo tzdata@footnote{https://pypi.org/project/tzdata/} foi lançado como um pacote inicial – distribuído via PyPI e mantido pela equipe principal do CPython.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 615

@item PEP 615@footnote{https://peps.python.org/pep-0615/} – Suporte ao banco de dados de fuso horário da IANA na biblioteca padrão

PEP escrita e implementada por Paul Ganssle
@end table


@node graphlib,,zoneinfo,Novos módulos<5>
@anchor{whatsnew/3 9 graphlib}@anchor{8e6}
@subsubsection graphlib


Um novo módulo, @ref{65,,graphlib}, foi adicionado contendo a classe @ref{8e7,,graphlib.TopologicalSorter} para oferecer funcionalidade de realizar classificação topológica de grafos. (Contribuição de Pablo Galindo, Tim Peters e Larry Hastings em bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}.)

@node Módulos melhorados<5>,Otimizações<5>,Novos módulos<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 improved-modules}@anchor{8e8}
@subsection Módulos melhorados


@menu
* ast: ast<2>. 
* asyncio: asyncio<5>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<2>. 
* curses: curses<2>. 
* datetime: datetime<2>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* gc: gc<2>. 
* hashlib: hashlib<4>. 
* http:: 
* IDLE e idlelib: IDLE e idlelib<3>. 
* imaplib:: 
* importlib: importlib<3>. 
* inspect: inspect<4>. 
* ipaddress: ipaddress<2>. 
* math: math<4>. 
* multiprocessing: multiprocessing<2>. 
* nntplib:: 
* os: os<5>. 
* pathlib: pathlib<6>. 
* pdb: pdb<3>. 
* poplib:: 
* pprint: pprint<2>. 
* pydoc:: 
* random: random<3>. 
* signal:: 
* smtplib:: 
* socket: socket<3>. 
* time: time<3>. 
* sys: sys<6>. 
* tracemalloc:: 
* typing: typing<6>. 
* unicodedata: unicodedata<4>. 
* venv: venv<3>. 
* xml: xml<3>. 

@end menu

@node ast<2>,asyncio<5>,,Módulos melhorados<5>
@anchor{whatsnew/3 9 ast}@anchor{8e9}
@subsubsection ast


Adicionada a opção `indent' a @ref{8ea,,dump()}, que permite produzir uma saída indentada com várias linhas. (Contribuição de Serhiy Storchaka em bpo-37995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37995}.)

Adicionada @ref{8eb,,ast.unparse()} como uma função no módulo @ref{8,,ast} que pode ser usado para remover um objeto @ref{1a6,,ast.AST} e produzir uma string com código que produziria um objeto @ref{1a6,,ast.AST} equivalente quando analisado. (Contribuição de Pablo Galindo e Batuhan Taskaya em bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870}.)

Adicionadas docstrings aos nós AST que contêm a assinatura ASDL usada para construir esse nó. (Contribuição de Batuhan Taskaya em bpo-39638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39638}.)

@node asyncio<5>,compileall<2>,ast<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 asyncio}@anchor{8ec}
@subsubsection asyncio


Devido a significativas preocupações de segurança, o parâmetro `reuse_address' de @ref{733,,asyncio.loop.create_datagram_endpoint()} não é mais suportado. Isso ocorre devido ao comportamento da opção de soquete @code{SO_REUSEADDR} no UDP. Para mais detalhes, consulte a documentação de @code{loop.create_datagram_endpoint()}. (Contribuição de Kyle Stanley, Antoine Pitrou e Yury Selivanov em bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

Adicionada uma nova @ref{491,,corrotina} @ref{8ed,,shutdown_default_executor()} que agenda um desligamento para o executor padrão que espera na @ref{742,,ThreadPoolExecutor} para concluir o fechamento. Além disso, @ref{47c,,asyncio.run()} foi atualizada para usar o novo @ref{491,,corrotina}. (Contribuição de Kyle Stanley em bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}.)

Adicionada @ref{479,,asyncio.PidfdChildWatcher}, uma implementação de monitorador de filhos específica do Linux que controla descritores de arquivo de processo. (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692})

Adicionada uma nova @ref{491,,corrotina} @ref{8ee,,asyncio.to_thread()}. É usada principalmente para executar funções vinculadas à E/S em uma thread separada para evitar o bloqueio do loop de eventos e funciona essencialmente como uma versão de alto nível de @ref{8ef,,run_in_executor()} que pode receber argumentos nomeados diretamente. (Contribuição de Kyle Stanley e Yury Selivanov em bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309}.)

Ao cancelar a tarefa devido a um tempo limite, @ref{5ff,,asyncio.wait_for()} irá agora esperar até que o cancelamento seja concluído também no caso quando `timeout' é <= 0, como acontece com tempos limite positivos. (Contribuição de Elvis Pranskevichus em bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}.)

@ref{a,,asyncio} agora levanta @ref{2c3,,TypeError} ao chamar métodos incompatíveis com um soquete @ref{8f0,,ssl.SSLSocket}. (Contribuição de Ido Michael em bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404}.)

@node compileall<2>,concurrent futures<2>,asyncio<5>,Módulos melhorados<5>
@anchor{whatsnew/3 9 compileall}@anchor{8f1}
@subsubsection compileall


Adicionada nova possibilidade de usar hardlinks para arquivos @code{.pyc} duplicados: parâmetro `hardlink_dupes' e opção de linha de comando –hardlink-dupes. (Contribuição de Lumír ‘Frenzy’ Balhar em bpo-40495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40495}.)

Adicionadas novas opções para manipulação de caminho nos arquivos @code{.pyc} resultantes: parâmetros `stripdir', `prependdir', `limit_sl_dest' e opções de linha de comando -s, -p, -e. Foi adicionada a possibilidade de especificar a opção para um nível de otimização várias vezes. (Contribuição de Lumír ‘Frenzy’ Balhar em bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112}.)

@node concurrent futures<2>,curses<2>,compileall<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 concurrent-futures}@anchor{8f2}
@subsubsection concurrent.futures


Adicionado um novo parâmetro `cancel_futures' em @ref{8f3,,concurrent.futures.Executor.shutdown()} que cancela todos os futuros pendentes que ainda não começaram a ser executados, em vez de esperar que eles sejam concluídos antes de desligar o executor. (Contribuição de Kyle Stanley em bpo-39349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39349}.)

Removidos as threads do daemon de @ref{742,,ThreadPoolExecutor} e @ref{8f4,,ProcessPoolExecutor}. Isso melhora a compatibilidade com subinterpretadores e a previsibilidade em seus processos de desligamento. (Contribuição de Kyle Stanley em bpo-39812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39812}.)

Workers em @ref{8f4,,ProcessPoolExecutor} agora são gerados sob demanda, apenas quando não há workers ociosos disponíveis para reutilização. Isso otimiza a sobrecarga da inicialização e reduz a quantidade de tempo perdido da CPU para os workers ociosos. (Contribuição de Kyle Stanley em bpo-39207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39207}.)

@node curses<2>,datetime<2>,concurrent futures<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 curses}@anchor{8f5}
@subsubsection curses


Adicionadas as funções @ref{8f6,,curses.get_escdelay()}, @ref{8f7,,curses.set_escdelay()}, @ref{8f8,,curses.get_tabsize()} e @ref{8f9,,curses.set_tabsize()}. (Contribuição de Anthony Sottile em bpo-38312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38312}.)

@node datetime<2>,distutils<3>,curses<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 datetime}@anchor{8fa}
@subsubsection datetime


Os métodos @ref{8fb,,isocalendar()} de @ref{1cd,,datetime.date} e @ref{8fc,,isocalendar()} de @ref{1cc,,datetime.datetime} agora retornam uma @ref{1ca,,namedtuple()} em vez de uma @ref{370,,tuple}. (Contribuição de Donghee Na em bpo-24416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24416}.)

@node distutils<3>,fcntl<2>,datetime<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 distutils}@anchor{8fd}
@subsubsection distutils


O comando @code{upload} agora cria digests de hash SHA2-256 e Blake2b-256. Ele pula o MD5 em plataformas que bloqueiam digest do MD5. (Contribuição de Christian Heimes em bpo-40698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40698}.)

@node fcntl<2>,ftplib<2>,distutils<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 fcntl}@anchor{8fe}
@subsubsection fcntl


Adicionadas as constantes @code{fcntl.F_OFD_GETLK}, @code{fcntl.F_OFD_SETLK} e @code{fcntl.F_OFD_SETLKW}. (Contribuição de Donghee Na em bpo-38602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38602}.)

@node ftplib<2>,gc<2>,fcntl<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 ftplib}@anchor{8ff}
@subsubsection ftplib


@ref{900,,FTP} e @ref{901,,FTP_TLS} agora levantam a @ref{202,,ValueError} se o tempo limite especificado para o construtor for zero para impedir a criação de um soquete não-bloqueante. (Contribuição de Donghee Na em bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node gc<2>,hashlib<4>,ftplib<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 gc}@anchor{902}
@subsubsection gc


Quando o coletor de lixo faz uma coleção na qual alguns objetos ressuscitam (são alcançáveis fora dos ciclos isolados após a execução dos finalizadores), não bloqueia a coleção de todos os objetos que ainda estão inacessíveis. (Contribuição de Pablo Galindo e Tim Peters em bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}.)

Adicionada uma nova função @ref{903,,gc.is_finalized()} para verificar se um objeto foi finalizado pelo coletor de lixo. (Contribuição de Pablo Galindo em bpo-39322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39322}.)

@node hashlib<4>,http,gc<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 hashlib}@anchor{904}
@subsubsection hashlib


O módulo @ref{68,,hashlib} pode agora usar hashes SHA3 e SHAKE XOF de OpenSSL quando disponível. (Contribuição de Christian Heimes em bpo-37630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37630}.)

Os módulos hash integrados agora podem ser desativados com @code{./configure --without-builtin-hashlib-hashes} ou ativados seletivamente com por exemplo @code{./configure --with-builtin-hashlib-hashes=sha3,blake2} para forçar o uso da implementação baseada em OpenSSL. (Contribuição de Christian Heimes em bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479})

@node http,IDLE e idlelib<3>,hashlib<4>,Módulos melhorados<5>
@anchor{whatsnew/3 9 http}@anchor{905}
@subsubsection http


Códigos de status HTTP @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} e @code{425 TOO_EARLY} foram adicionados a @ref{906,,http.HTTPStatus}. (Contribuição de Donghee Na em bpo-39509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39509} e Ross Rhodes em bpo-39507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39507}.)

@node IDLE e idlelib<3>,imaplib,http,Módulos melhorados<5>
@anchor{whatsnew/3 9 idle-and-idlelib}@anchor{907}
@subsubsection IDLE e idlelib


Adicionada a opção para ativar e desativar o piscar do cursor. (Contribuição de Zackery Spytz na bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603}.)

A tecla Escape agora fecha as janelas de conclusão IDLE. (Contribuição de Johnny Najera em bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}.)

Adicionada argumentos nomeados à lista de completamento de nome de módulo. (Contribuição de Terry J. Reedy em bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}.)

Novo nas versões de manutenção 3.9.

Faz o IDLE invocar @ref{80e,,sys.excepthook()} (quando iniciado sem ‘-n’). Ganchos de usuário eram ignorados anteriormente. (Contribuição de Ken Hilton em bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}.)

As alterações acima foram portadas para versões de manutenção do 3.8.

Reorganiza a caixa de diálogo de configurações. Divide a aba General nas abas Windows e Shell/Ed. Move as fontes de ajuda, que estendem o menu Help, para a aba Extensions. Abre espaço para novas opções e encurta a caixa de diálogo. O último faz com que o diálogo se ajuste melhor a telas pequenas. (Contribuição de Terry Jan Reedy em bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}.) Move a configuração do espaço de recuo da aba Font para a nova aba Windows. (Contribuição de Mark Roseman e Terry Jan Reedy em bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}.)

Aplica realce de sintaxe em arquivos @code{.pyi}. (Contribuição de Alex Waygood e Terry Jan Reedy em bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}.)

@node imaplib,importlib<3>,IDLE e idlelib<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 imaplib}@anchor{908}
@subsubsection imaplib


@ref{909,,IMAP4} e @ref{90a,,IMAP4_SSL} agora possuem o parâmetro opcional `timeout' para seus construtores. Também, o método @ref{90b,,open()} agora possui um parâmetro opcional `timeout' com esta alteração. Os métodos substituídos de @ref{90a,,IMAP4_SSL} e @ref{90c,,IMAP4_stream} foram aplicados nesta alteração. (Contribuição de Dong-hee Na em bpo-38615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38615}.)

@ref{90d,,imaplib.IMAP4.unselect()} foi adicionado. @ref{90d,,imaplib.IMAP4.unselect()} libera os recursos do servidor associados à caixa de correio selecionada e retorna o servidor ao estado autenticado. Este comando executa as mesmas ações que @ref{90e,,imaplib.IMAP4.close()}, exceto que nenhuma mensagem é removida permanentemente da caixa de correio selecionada no momento. (Contribuição de Dong-hee Na em bpo-40375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40375}.)

@node importlib<3>,inspect<4>,imaplib,Módulos melhorados<5>
@anchor{whatsnew/3 9 importlib}@anchor{90f}
@subsubsection importlib


Para melhorar a consistência com as instruções de importação,  @ref{910,,importlib.util.resolve_name()} agora levanta @ref{419,,ImportError} em vez de @ref{202,,ValueError} para tentativas de importação relativas inválidas. (Contribuição de Ngalim Siregar em bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}.)

Carregadores de importação que publicam objetos de módulo imutáveis agora podem publicar pacotes imutáveis além de módulos individuais. (Contribuição de Dino Viehland em bpo-39336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39336}.)

Adicionada a função @ref{48e,,importlib.resources.files()} com suporte a subdiretórios nos dados do pacote, correspondendo ao backport na versão 1.5 do @code{importlib_resources}. (Contribuição de Jason R. Coombs em bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}.)

Renovado @code{importlib.metadata} de @code{importlib_metadata} versão 1.6.1.

@node inspect<4>,ipaddress<2>,importlib<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 inspect}@anchor{911}
@subsubsection inspect


@ref{912,,inspect.BoundArguments.arguments} foi alterado de @code{OrderedDict} para dict regular. (Contribuição de Inada Naoki em bpo-36350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36350} e bpo-39775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39775}.)

@node ipaddress<2>,math<4>,inspect<4>,Módulos melhorados<5>
@anchor{whatsnew/3 9 ipaddress}@anchor{913}
@subsubsection ipaddress


@ref{80,,ipaddress} agora suporta endereços IPv6 com escopo definido (endereço IPv6 com sufixo @code{%<scope_id>}).

Os endereços IPv6 com escopo definido podem ser analisados usando @ref{1fd,,ipaddress.IPv6Address}. Se presente, o ID da zona de escopo está disponível através do atributo @ref{914,,scope_id}. (Contribuição de Oleksandr Pavliuk em bpo-34788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34788}.)

A partir do Python 3.9.5, o módulo @ref{80,,ipaddress} não aceita mais zeros à esquerda em strings de endereço IPv4. (Contribuição de Christian Heimes em bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}).

@node math<4>,multiprocessing<2>,ipaddress<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 math}@anchor{915}
@subsubsection math


Expandida a função @ref{916,,math.gcd()} para manipular vários argumentos. Anteriormente, tinha suporte apenas a dois argumentos. (Contribuição de Serhiy Storchaka em bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648}.)

Adicionada @ref{917,,math.lcm()}: retorna o menor múltiplo comum dos argumentos especificados. (Contribuição de Mark Dickinson, Ananthakrishnan e Serhiy Storchaka em bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479} e :issue:` 39648`.)

Adicionada @ref{498,,math.nextafter()}: retorna o próximo valor de ponto flutuante após `x' em direção a `y'. (Contribuição de Victor Stinner em bpo-39288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39288}.)

Adicionada @ref{918,,math.ulp()}: retorna o valor do bit menos significativo de um ponto flutuante. (Contribuição de Victor Stinner em bpo-39310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39310}.)

@node multiprocessing<2>,nntplib,math<4>,Módulos melhorados<5>
@anchor{whatsnew/3 9 multiprocessing}@anchor{919}
@subsubsection multiprocessing


A classe @ref{91a,,multiprocessing.SimpleQueue} tem um novo método @ref{91b,,close()} para fechar explicitamente a fila. (Contribuição de Victor Stinner em bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}.)

@node nntplib,os<5>,multiprocessing<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 nntplib}@anchor{91c}
@subsubsection nntplib


@code{NNTP} e @code{NNTP_SSL} agora levantam uma exceção @ref{202,,ValueError} se o tempo limite fornecido ao construtor é zero, para prevenir a criação de um socket não-bloqueante. (Contribuição de Donghee Na em bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node os<5>,pathlib<6>,nntplib,Módulos melhorados<5>
@anchor{whatsnew/3 9 os}@anchor{91d}
@subsubsection os


Adicionadas as constantes @ref{91e,,CLD_KILLED} e @ref{91f,,CLD_STOPPED} para @code{si_code}. (Contribuição de Donghee Na em bpo-38493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38493}.)

Exposta @ref{47a,,os.pidfd_open()} específica do Linux (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}) e @ref{920,,os.P_PIDFD} (bpo-38713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38713}) para gerenciamento de processos com descritores de arquivo.

A função @ref{921,,os.unsetenv()} agora também está disponível no Windows. (Contribuição de Victor Stinner em bpo-39413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39413}.)

As funções @ref{922,,os.putenv()} e @ref{921,,os.unsetenv()} estão agora sempre disponíveis. (Contribuição de Victor Stinner em bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}.)

Adicionada a função @ref{923,,os.waitstatus_to_exitcode()}: converte um status de espera em um código de saída. (Contribuição de Victor Stinner em bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}.)

@node pathlib<6>,pdb<3>,os<5>,Módulos melhorados<5>
@anchor{whatsnew/3 9 pathlib}@anchor{924}
@subsubsection pathlib


Adicionado @ref{925,,pathlib.Path.readlink()}, que age de maneira semelhante a @ref{926,,os.readlink()}. (Contribuição de Girts Folkmanis em bpo-30618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30618})

@node pdb<3>,poplib,pathlib<6>,Módulos melhorados<5>
@anchor{whatsnew/3 9 pdb}@anchor{927}
@subsubsection pdb


No Windows, agora @ref{928,,Pdb} tem suporte a @code{~/.pdbrc}. (Contribuição de Tim Hopper e Dan Lidral-Porter em bpo-20523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20523}.)

@node poplib,pprint<2>,pdb<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 poplib}@anchor{929}
@subsubsection poplib


@ref{92a,,POP3} e @ref{92b,,POP3_SSL} agora levantam a @ref{202,,ValueError} se o tempo limite especificado para o construtor for zero para impedir a criação de um soquete sem bloqueio. (Contribuição de Donghee Na em bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

@node pprint<2>,pydoc,poplib,Módulos melhorados<5>
@anchor{whatsnew/3 9 pprint}@anchor{92c}
@subsubsection pprint


@ref{ae,,pprint} agora pode imprimir @ref{1d1,,types.SimpleNamespace}. (Contribuição de Carl Bordum Hansen em bpo-37376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37376}.)

@node pydoc,random<3>,pprint<2>,Módulos melhorados<5>
@anchor{whatsnew/3 9 pydoc}@anchor{92d}
@subsubsection pydoc


A string de documentação agora é mostrada não apenas para classe, função, método etc, mas para qualquer objeto que tenha seu próprio atributo @ref{92e,,__doc__}. (Contribuição de Serhiy Storchaka em bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}.)

@node random<3>,signal,pydoc,Módulos melhorados<5>
@anchor{whatsnew/3 9 random}@anchor{92f}
@subsubsection random


Adicionado um novo método @ref{930,,random.Random.randbytes()}: gera bytes aleatórios. (Contribuição de Victor Stinner em bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}.)

@node signal,smtplib,random<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 signal}@anchor{931}
@subsubsection signal


Exposta a @ref{932,,signal.pidfd_send_signal()} específica do Linux para enviar sinais a um processo usando um descritor de arquivo em vez de um pid. (bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712})

@node smtplib,socket<3>,signal,Módulos melhorados<5>
@anchor{whatsnew/3 9 smtplib}@anchor{933}
@subsubsection smtplib


@ref{934,,SMTP} e @ref{935,,SMTP_SSL} agora levantam uma @ref{202,,ValueError} se o tempo limite especificado para seu construtor for zero para impedir a criação de um soquete sem bloqueio. (Contribuição de Dong-hee Na em bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}.)

O construtor de @ref{936,,LMTP} agora tem um parâmetro opcional `timeout'. (Contribuição de Dong-hee Na em bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329}.)

@node socket<3>,time<3>,smtplib,Módulos melhorados<5>
@anchor{whatsnew/3 9 socket}@anchor{937}
@subsubsection socket


O módulo @ref{cc,,socket} agora exporta a constante @ref{938,,CAN_RAW_JOIN_FILTERS} no Linux 4.1 e superior. (Contribuição de Stefan Tatschner e Zackery Spytz em bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780}.)

O módulo socket agora suporta o protocolo @ref{939,,CAN_J1939} nas plataformas que o suportam. (Contribuição de Karl Ding em bpo-40291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40291}.)

O módulo socket agora tem as funções @ref{93a,,socket.send_fds()} e @ref{93b,,socket.recv_fds()}. (Contribuição de Joannah Nanjekye, Shinya Okano e Victor Stinner em bpo-28724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28724}.)

@node time<3>,sys<6>,socket<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 time}@anchor{93c}
@subsubsection time


No AIX, @ref{93d,,thread_time()} agora é implementado com @code{thread_cputime()} que possui resolução de nanossegundos, em vez de @code{clock_gettime(CLOCK_THREAD_CPUTIME_ID)}, que tem uma resolução de 10 milissegundos. (Contribuição de Batuhan Taskaya em bpo-40192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40192})

@node sys<6>,tracemalloc,time<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 sys}@anchor{93e}
@subsubsection sys


Adicionado um novo atributo @ref{93f,,sys.platlibdir}: nome do diretório da biblioteca específica da plataforma. É usado para construir o caminho da biblioteca padrão e os caminhos dos módulos de extensão instalados. É igual a @code{"lib"} na maioria das plataformas. No Fedora e SuSE, é igual a @code{"lib64"} nas plataformas de 64 bits. (Contribuição de Jan Matějek, Matěj Cepl, Charalampos Stratakis e Victor Stinner em bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}.)

Anteriormente, @ref{940,,sys.stderr} era armazenado em buffer quando não interativo. Agora, @code{stderr} assume como padrão sempre o buffer de linha. (Contribuição de Jendrik Seipp em bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601}.)

@node tracemalloc,typing<6>,sys<6>,Módulos melhorados<5>
@anchor{whatsnew/3 9 tracemalloc}@anchor{941}
@subsubsection tracemalloc


Adicionada @ref{942,,tracemalloc.reset_peak()} para definir o tamanho do pico dos blocos de memória rastreados para o tamanho atual, para medir o pico de partes específicas do código. (Contribuição de Huon Wilson em bpo-40630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40630}.)

@node typing<6>,unicodedata<4>,tracemalloc,Módulos melhorados<5>
@anchor{whatsnew/3 9 typing}@anchor{943}
@subsubsection typing


@geindex Propostas de Melhorias do Python; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/} introduziu um tipo @ref{944,,typing.Annotated} para decorar tipos existentes com metadados específicos de contexto e o novo parâmetro @code{include_extras} para @ref{6b1,,typing.get_type_hints()} para acessar os metadados em tempo de execução. (Contribuição de Till Varoquaux e Konstantin Kashin.)

@node unicodedata<4>,venv<3>,typing<6>,Módulos melhorados<5>
@anchor{whatsnew/3 9 unicodedata}@anchor{945}
@subsubsection unicodedata


O banco de dados Unicode foi atualizado para a versão 13.0.0. (bpo-39926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39926}).

@node venv<3>,xml<3>,unicodedata<4>,Módulos melhorados<5>
@anchor{whatsnew/3 9 venv}@anchor{946}
@subsubsection venv


Os scripts de ativação fornecidos por @ref{111,,venv} agora especificam sua personalização de prompt de forma consistente, sempre usando o valor especificado por @code{__VENV_PROMPT__}. Anteriormente, alguns scripts usavam incondicionalmente @code{__VENV_PROMPT__}, outros apenas se fosse definido (que era o caso padrão) e um usava @code{__VENV_NAME__}. (Contribuição de Brett Cannon em bpo-37663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37663}.)

@node xml<3>,,venv<3>,Módulos melhorados<5>
@anchor{whatsnew/3 9 xml}@anchor{947}
@subsubsection xml


Os caracteres de espaço em branco nos atributos agora são preservados ao serializar @ref{125,,xml.etree.ElementTree} para o arquivo XML. EOLNs não são mais normalizados para “n”. Este é o resultado da discussão sobre como interpretar a seção 2.11 da especificação XML. (Contribuição de Mefistotelis em bpo-39011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39011}.)

@node Otimizações<5>,Descontinuados<7>,Módulos melhorados<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 optimizations}@anchor{948}
@subsection Otimizações



@itemize *

@item 
Otimizado o idioma para atribuição de uma variável temporária nas compreensões. Agora @code{for y in [expr]} nas compreensões é tão rápido quanto uma atribuição simples @code{y = expr}. Por exemplo:

@quotation

sums = [s for s in [0] for x in data for s in [s + x]]
@end quotation

Ao contrário do operador @code{:=}, este idioma não vaza uma variável para o escopo externo.

(Contribuição de Serhiy Storchaka em bpo-32856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32856}.)

@item 
Otimizada a manipulação de sinais em aplicações multithread. Se uma thread diferente da thread principal obtiver um sinal, o loop de avaliação do bytecode não será mais interrompido a cada instrução de bytecode para verificar se há sinais pendentes que não podem ser manipulados. Somente o segmento principal do interpretador principal pode manipular sinais.

Anteriormente, o loop de avaliação do bytecode era interrompido em cada instrução até que a thread principal lidasse com os sinais. (Contribuição de Victor Stinner em bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}.)

@item 
Otimizado o módulo @ref{d6,,subprocess} no FreeBSD usando @code{closefrom()}. (Contribuição de Ed Maste, Conrad Meyer, Kyle Evans, Kubilay Kocak e Victor Stinner em bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}.)

@item 
@ref{949,,PyLong_FromDouble()} está agora até 1.87x mais rápido para valores que cabem em um long. (Contribuição de Sergey Fedoseev em bpo-37986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37986}.)

@item 
Vários componentes embutidos do Python (@ref{94a,,range}, @ref{370,,tuple}, @ref{5d9,,set}, @ref{5da,,frozenset}, @ref{611,,list}, @ref{256,,dict}) agora são acelerados usando o protocolo vectorcall da 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}. (Contribuição de Donghee Na, Mark Shannon, Jeroen Demeyer e Petr Viktorin em bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}.)

@item 
Otimizada a @code{set.difference_update()} para o caso em que o outro conjunto é muito maior do que o conjunto base. (Sugestão de Evgeny Kapun com contribuição de código de Michele Orrù em bpo-8425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8425}.)

@item 
O alocador de pequenos objetos do Python (@code{obmalloc.c}) agora permite (não mais que) uma arena vazia para permanecer disponível para reutilização imediata, sem retorná-la ao sistema operacional. Isso evita o desperdiçar loops simples, onde uma arena pode ser criada e destruída novamente em cada iteração. (Contribuição de Tim Peters em bpo-37257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37257}.)

@item 
@ref{94b,,divisão pelo piso} de operação flutuante agora tem um melhor desempenho. Além disso, a mensagem de @ref{94c,,ZeroDivisionError} para esta operação foi atualizada. (Contribuição de Donghee Na em bpo-39434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39434}.)

@item 
A decodificação de strings curtas ASCII com codecs UTF-8 e ascii é agora cerca de 15% mais rápida. (Contribuição de Inada Naoki em bpo-37348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37348}.)
@end itemize

Aqui está um resumo das melhorias de desempenho do Python 3.4 ao Python 3.9:

@example
Versão do Python                     3.4     3.5     3.6     3.7     3.8    3.9
--------------                       ---     ---     ---     ---     ---    ---

Acesso de leitura a variável e atributo:
    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

Acesso de escrita a variável e atributo:
    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

Acesso de leitura a estrutura de dados:
    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

Acesso de escrita a estrutura de dados:
    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

Operações em pilha (ou fila):
    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

Tempo de laços:
    loop_overhead                    0.5     0.6     0.4     0.3     0.3    0.3
@end example

Estes resultados foram gerados a partir do script de benchmark de acesso variável em: @code{Tools/scripts/var_access_benchmark.py}. O script de benchmark exibe tempos em nanossegundos. Os benchmarks foram medidos em um processador 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} executando as compilações do macOS de 64 bits encontradas em python.org@footnote{https://www.python.org/downloads/macos/}.

@node Descontinuados<7>,Removidos<7>,Otimizações<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 deprecated}@anchor{94d}
@subsection Descontinuados



@itemize *

@item 
O comando @code{bdist_msi} do distutils está agora descontinuado, use @code{bdist_wheel} (pacotes wheel). (Contribuição de Hugo van Kemenade em bpo-39586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39586}.)

@item 
Atualmente @ref{94e,,math.factorial()} aceita instâncias da @ref{2f7,,float} com valores inteiros não negativos (como @code{5.0}). Ela levanta uma @ref{202,,ValueError} para flutuadores não integrais e negativos. Agora está descontinuado. Nas versões futuras do Python, será levantada uma @ref{2c3,,TypeError} para todos os flutuadores. (Contribuição de Serhiy Storchaka em bpo-37315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37315}.)

@item 
Os módulos @code{parser} e @code{symbol} foram descontinuados e serão removidos em versões futuras do Python. Para a maioria dos casos de uso, os usuários podem aproveitar o estágio de geração e compilação da Árvore de Sintaxe Abstrata (AST), usando o módulo @ref{8,,ast}.

@item 
As funções públicas de API C @code{PyParser_SimpleParseStringFlags()}, @code{PyParser_SimpleParseStringFlagsFilename()}, @code{PyParser_SimpleParseFileFlags()} e @code{PyNode_Compile()} foram descontinuados e serão removidos no Python 3.10 junto com o analisador sintático antigo.

@item 
O uso de @ref{7d3,,NotImplemented} em um contexto booleano foi descontinuado, pois é quase exclusivamente o resultado de implementações incorretas de comparadores avançados. Isso será tornado em uma @ref{2c3,,TypeError} em uma versão futura do Python. (Contribuição de Josh Rosenberg em bpo-35712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35712}.)

@item 
O módulo @ref{b8,,random} atualmente aceita qualquer tipo hasheável como um possível valor inicial. Infelizmente, alguns desses tipos não têm garantia de ter um valor de hash determinístico. Após o Python 3.9, o módulo restringirá suas sementes a @ref{675,,None}, @ref{257,,int}, @ref{2f7,,float}, @ref{44c,,str}, @ref{1c2,,bytes} e @ref{2ea,,bytearray}.

@item 
A abertura do arquivo @ref{41a,,GzipFile} para escrita sem especificar o argumento `mode' foi descontinuado. Nas versões futuras do Python, ele sempre será aberto para leitura por padrão. Especifique o argumento `mode' para abri-lo para escrever e silenciar um aviso. (Contribuição de Serhiy Storchaka em bpo-28286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28286}.)

@item 
Descontinuado o método @code{split()} de @code{_tkinter.TkappType} a favor do método @code{splitlist()} que possui um comportamento mais consistente e previsível. (Contribuição de Serhiy Storchaka em bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}.)

@item 
A passagem explícita dos objetos da corrotina para @ref{47f,,asyncio.wait()} foi descontinuada e será removida na versão 3.11. (Contribuição de Yury Selivanov e Kyle Stanley em bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}.)

@item 
Os padrões binhex4 e hexbin4 agora foram descontinuados. O módulo @code{binhex} e as seguintes funções @ref{10,,binascii} foram descontinuadas:


@itemize *

@item 
@code{b2a_hqx()}, @code{a2b_hqx()}

@item 
@code{rlecode_hqx()}, @code{rledecode_hqx()}
@end itemize

(Contribuição de Victor Stinner em bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}.)

@item 
As classes @code{slice}, @code{Index} e @code{ExtSlice} de @ref{8,,ast} são consideradas descontinuadas e serão removidas nas versões futuras do Python. O próprio @code{value} deve ser usado em vez de @code{Index(value)}. @code{Tuple(slices, Load())} deve ser usada em vez de @code{ExtSlice(slices)}. (Contribuição de Serhiy Storchaka em  bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}.)

@item 
As classes @code{Suite}, @code{Param}, @code{AugLoad} e @code{AugStore} de @ref{8,,ast} são consideradas descontinuadas e serão removidas nas versões futuras do Python. Elas não foram geradas pelo analisador sintático e não foram aceitos pelo gerador de código no Python 3. (Contribuição de Batuhan Taskaya em bpo-39639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39639} e bpo-39969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39969} e Serhiy Storchaka em bpo-39988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39988}.)

@item 
As funções @code{PyEval_InitThreads()} e @code{PyEval_ThreadsInitialized()} agora estão descontinuadas e serão removidas no Python 3.11. Chamar @code{PyEval_InitThreads()} agora não faz nada. A @ref{159,,GIL} é inicializada por @ref{8b1,,Py_Initialize()} desde o Python 3.7. (Contribuição de Victor Stinner em bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}.)

@item 
Passar @code{None} como o primeiro argumento para a função @ref{53c,,shlex.split()} foi descontinuada.  (Contribuição de Zackery Spytz em bpo-33262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33262}.)

@item 
@code{smtpd.MailmanProxy()} está agora descontinuado, pois está inutilizável sem um módulo externo, @code{mailman}.  (Contribuição de Samuel Colvin em bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}.)

@item 
O módulo @code{lib2to3} agora emite um @ref{8ce,,PendingDeprecationWarning}. Python 3.9 mudou para um analisador sintático GASE (veja 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}) e Python 3.10 pode incluir uma nova sintaxe de linguagem que não é analisável pelo analisador sintático LL(1) de lib2to3. O módulo @code{lib2to3} pode ser removido da biblioteca padrão em uma versão futura do Python. Considere alternativas de terceiros, como LibCST@footnote{https://libcst.readthedocs.io/} ou parso@footnote{https://parso.readthedocs.io/}. (Contribuição de Carl Meyer em bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}.)

@item 
Adicionado o parâmetro `random' da @ref{747,,random.shuffle()} foi descontinuado. (Contribuição de Raymond Hettinger em bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465})
@end itemize

@node Removidos<7>,Portando para Python 3 9,Descontinuados<7>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 removed}@anchor{94f}@anchor{whatsnew/3 9 removed-in-python-39}@anchor{8d1}
@subsection Removidos



@itemize *

@item 
A versão errônea em @code{unittest.mock.__version__} foi removida.

@item 
@code{nntplib.NNTP}: os métodos @code{xpath()} e @code{xgtitle()} foram removidos. Esses métodos foram descontinuados desde Python 3.3. Geralmente, essas extensões não são suportadas ou não são habilitadas pelos administradores do servidor NNTP. Para @code{xgtitle()}, use @code{nntplib.NNTP.descriptions()} ou @code{nntplib.NNTP.description()}. (Contribuição de Donghee Na em bpo-39366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39366}.)

@item 
@ref{1a0,,array.array}: os métodos @code{tostring()} e @code{fromstring()} foram removidos. Eles eram aliases para @code{tobytes()} e @code{frombytes()}, descontinuado desde Python 3.2. (Contribuição de Victor Stinner em bpo-38916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38916}.)

@item 
A função @code{sys.callstats()} não documentada foi removida. Desde o Python 3.7, ela foi descontinuada e sempre retornou @ref{675,,None}. É necessária uma opção de compilação especial @code{CALL_PROFILE} que já foi removida no Python 3.7. (Contribuição de Victor Stinner em bpo-37414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37414}.)

@item 
As funções @code{sys.getcheckinterval()} e @code{sys.setcheckinterval()} foram removidas. Elas foram descontinuadas desde o Python 3.2. Use @ref{950,,sys.getswitchinterval()} e @ref{951,,sys.setswitchinterval()} em seu lugar. (Contribuição de Victor Stinner em bpo-37392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37392}.)

@item 
A função C @code{PyImport_Cleanup()} foi removida. Foi documentada como: “Esvazia a tabela do módulo. Apenas para uso interno.” (Contribuição de Victor Stinner em bpo-36710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36710}.)

@item 
Os módulos @code{_dummy_thread} e @code{dummy_threading} foram removidos. Esses módulos foram descontinuados desde o Python 3.7, que requer suporte a threading. (Contribuição de Victor Stinner em bpo-37312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37312}.)

@item 
O apelido @code{aifc.openfp()} para @code{aifc.open()}, o apelido @code{sunau.openfp()} para @code{sunau.open()} e o apelido @code{wave.openfp()} para @ref{952,,wave.open()} foram removidos. Eles estavam descontinuados desde o Python 3.7. (Contribuição de Victor Stinner em bpo-37320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37320}.)

@item 
O método @code{isAlive()} de @ref{953,,threading.Thread} foi removido. Ele foi descontinuado desde o Python 3.8. Use @ref{954,,is_alive()} ao invés. (Contribuição de Donghee Na em bpo-37804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37804}.)

@item 
Os métodos @code{getchildren()} e @code{getiterator()} das classes @ref{955,,ElementTree} e @ref{310,,Element} no módulo @ref{125,,ElementTree} foram removidos.  Eles foram descontinuados no Python 3.2. Use @code{iter(x)} ou @code{list(x)} em vez de @code{x.getchildren()} e @code{x.iter()} ou @code{list(x.iter())} em vez de @code{x.getiterator()}. (Contribuição Serhiy Storchaka no bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543}.)

@item 
A API antiga @ref{ab,,plistlib} foi removida. Ela tinha sido descontinuada desde o Python 3.4. Use as funções @ref{956,,load()}, @ref{957,,loads()}, @ref{958,,dump()} e @ref{959,,dumps()}. Além disso, o parâmetro `use_builtin_types' foi removido, os objetos padrão @ref{1c2,,bytes} são sempre usados em seu lugar. (Contribuição de Jon Janzen em bpo-36409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36409}.)

@item 
A função C @code{PyGen_NeedsFinalizing} foi removida. Ela não foi documentada, testada ou usada em qualquer lugar dentro do CPython após a implementação de 
@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}. Patch de Joannah Nanjekye. (Contribuição de Joannah Nanjekye em bpo-15088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15088})

@item 
@code{base64.encodestring()} e @code{base64.decodestring()}, aliases descontinuados desde Python 3.1, foram removidos: use @ref{95a,,base64.encodebytes()} e @ref{95b,,base64.decodebytes()}. (Contribuição de Victor Stinner em bpo-39351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39351}.)

@item 
A função @code{fractions.gcd()} foi removida, foi descontinuado desde Python 3.5 (bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}): use @ref{916,,math.gcd()} em seu lugar. (Contribuição de Victor Stinner em bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}.)

@item 
O parâmetro `buffering' de @ref{86a,,bz2.BZ2File} foi removido. Desde Python 3.0, ele era ignorado e ao usá-lo emitia uma @ref{1a5,,DeprecationWarning}. Passe um objeto arquivo aberto para controlar como o arquivo é aberto. (Contribuição de Victor Stinner em bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}.)

@item 
O parâmetro `encoding' de @ref{95c,,json.loads()} foi removido. A partir do Python 3.1, ele foi descontinuado e ignorado; usá-lo emitia uma @ref{1a5,,DeprecationWarning} desde Python 3.8. (Contribuição de Inada Naoki em bpo-39377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39377})

@item 
As instruções @code{with (await asyncio.lock):} e @code{with (yield from asyncio.lock):} não são mais suportadas, use @code{async with lock}. O mesmo é se aplica para @code{asyncio.Condition} e @code{asyncio.Semaphore}. (Contribuição de Andrew Svetlov em bpo-34793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34793}.)

@item 
A função @code{sys.getcounts()}, a opção de linha de comando @code{-X showalloccount} e o campo @code{show_alloc_count} da estrutura C @ref{3a6,,PyConfig} foram removidos. Eles exigiam uma construção especial do Python definindo a macro @code{COUNT_ALLOCS}. (Contribuição de Victor Stinner em bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}.)

@item 
O atributo @code{_field_types} da classe @ref{2b0,,typing.NamedTuple} foi removido. Ele foi descontinuado desde o Python 3.8. Use o atributo @code{__annotations__}. (Contribuição de Serhiy Storchaka em bpo-40182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40182}.)

@item 
O método @code{symtable.SymbolTable.has_exec()} foi removido. Ele foi descontinuado desde 2006, e retornando apenas @code{False} quando é chamado. (Contribuição de Batuhan Taskaya em bpo-40208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40208})

@item 
Os métodos @code{asyncio.Task.current_task()} e @code{asyncio.Task.all_tasks()} foram removidos. Eles foram descontinuados desde o Python 3.7 e você pode usar @ref{47d,,asyncio.current_task()} e @ref{95d,,asyncio.all_tasks()} em seu lugar. (Contribuição de Rémi Lapeyre em bpo-40967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40967})

@item 
O método @code{unescape()} na classe @ref{87b,,html.parser.HTMLParser} foi removido (foi descontinuado desde o Python 3.4). @ref{95e,,html.unescape()} deve ser usada para converter referências de caracteres para os caracteres Unicode correspondentes.
@end itemize

@node Portando para Python 3 9,Mudanças na construção<5>,Removidos<7>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 porting-to-python-3-9}@anchor{95f}
@subsection Portando para Python 3.9


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações na API Python: Alterações na API Python<4>. 
* Alterações na API C: Alterações na API C<8>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<5>. 

@end menu

@node Alterações na API Python<4>,Alterações na API C<8>,,Portando para Python 3 9
@anchor{whatsnew/3 9 changes-in-the-python-api}@anchor{960}
@subsubsection Alterações na API Python



@itemize *

@item 
@ref{8da,,__import__()} e @ref{910,,importlib.util.resolve_name()} agora levanta @ref{419,,ImportError} onde anteriormente levantava @ref{202,,ValueError}. Os chamadores capturando o tipo de exceção específico e suportando Python 3.9 e versões anteriores precisarão capturar ambas usando @code{except (ImportError, ValueError):}.

@item 
Os scripts de ativação @ref{111,,venv} não são mais casos especiais quando @code{__VENV_PROMPT__} está definido como @code{""}.

@item 
O método @ref{961,,select.epoll.unregister()} não ignora mais o erro @ref{962,,EBADF}. (Contribuição de Victor Stinner em bpo-39239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39239}.)

@item 
O parâmetro `compresslevel' de @ref{86a,,bz2.BZ2File} tornou-se uma parâmetro somente-nomeado, uma vez que o parâmetro `buffering' foi removido. (Contribuição de Victor Stinner em bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}.)

@item 
AST simplificada para assinatura. Índices simples serão representados por seus valores, fatias estendidas serão representadas como tuplas. @code{Index(value)} retornará um @code{value} em si, @code{ExtSlice(slices)} retornará @code{Tuple(slices, Load())}. (Contribuição de Serhiy Storchaka em bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}.)

@item 
O módulo @ref{77,,importlib} agora ignora a variável de ambiente 
@geindex PYTHONCASEOK
@geindex variável de ambiente; PYTHONCASEOK
@ref{963,,PYTHONCASEOK} quando as opções de linha de comando @ref{964,,-E} ou @ref{965,,-I} estão sendo usadas.

@item 
O parâmetro `encoding' foi adicionado às classes @ref{900,,ftplib.FTP} e @ref{901,,ftplib.FTP_TLS} como um parâmetro somente-nomeado, e a codificação padrão foi alterada de Latin-1 para UTF-8 para siga 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.

@item 
@ref{8ed,,asyncio.loop.shutdown_default_executor()} foi adicionado a @ref{966,,AbstractEventLoop}, significando que laços de eventos alternativos que herdam dele devem ter este método definido. (Contribuição de Kyle Stanley em bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}.)

@item 
Os valores constantes de futuras sinalizações no módulo @ref{0,,__future__} são atualizados para evitar colisão com sinalizações do compilador. Anteriormente, @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} estava em conflito com @code{CO_FUTURE_DIVISION}. (Contribuição de Batuhan Taskaya em bpo-39562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39562})

@item 
@code{array('u')} agora usa @code{wchar_t} como tipo C em vez de @code{Py_UNICODE}. Esta mudança não afeta seu comportamento porque @code{Py_UNICODE} é um apelido de @code{wchar_t} desde Python 3.3. (Contribuição de Inada Naoki em bpo-34538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34538}.)

@item 
A API de @ref{967,,logging.getLogger()} agora retorna o logger raiz quando passado o nome @code{'root'}, enquanto anteriormente retornava um logger não-raiz chamado @code{'root'}. Isso pode afetar casos onde o código do usuário deseja explicitamente um logger não-root chamado @code{'root'}, ou instancia um logger usando @code{logging.getLogger(__name__)} em algum módulo de nível superior chamado @code{'root.py'}. (Contribuição de Vinay Sajip em bpo-37742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37742}.)

@item 
O tratamento de divisão de @ref{4a6,,PurePath} agora retorna @ref{7d3,,NotImplemented} ao invés de levantar um @ref{2c3,,TypeError} quando passado algo diferente de uma instância de @code{str} ou @ref{4a6,,PurePath}. Isso permite a criação de classes compatíveis que não herdam desses tipos mencionados. (Contribuição de Roger Aiudi em bpo-34775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34775}).

@item 
A partir do Python 3.9.5, o módulo @ref{80,,ipaddress} não aceita mais zeros à esquerda em strings de endereço IPv4. Os zeros à esquerda são ambíguos e interpretados como notação octal por algumas bibliotecas. Por exemplo, a função legada @ref{968,,socket.inet_aton()} trata os zeros à esquerda como notação octal. A implementação glibc de @ref{969,,inet_pton()} moderna não aceita nenhum zeros à esquerda. (Contribuição de Christian Heimes em bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}).

@item 
@ref{96a,,codecs.lookup()} agora normaliza o nome da codificação da mesma forma que @ref{7fe,,encodings.normalize_encoding()}, exceto que @ref{96a,,codecs.lookup()} também converte o nome para minúsculas. Por exemplo, @code{"latex+latin1"} nome de codificação agora está normalizado para @code{"latex_latin1"}. (Contribuição de Jordon Xu em bpo-37751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37751}.)
@end itemize

@node Alterações na API C<8>,Alterações de bytecode do CPython<5>,Alterações na API Python<4>,Portando para Python 3 9
@anchor{whatsnew/3 9 changes-in-the-c-api}@anchor{96b}
@subsubsection Alterações na API C



@itemize *

@item 
Instâncias de @ref{96c,,tipos alocados por heap} (como aquelas criadas com @ref{57d,,PyType_FromSpec()} e APIs semelhantes) mantêm uma referência para seu objeto de tipo desde o Python 3.8. Conforme indicado nas “Mudanças na API C” do Python 3.8, para a grande maioria dos casos, não deve haver nenhum efeito colateral, mas para os tipos que têm uma função personalizada @ref{77e,,tp_traverse}, certifique-se de que todas as funções @code{tp_traverse} personalizadas de tipos alocados por heap visitam o tipo do objeto.

@quotation

Exemplo:

@example
int
travessia_foo(foo_struct *self, visitproc visit, void *arg) @{
// Resto da função de travessia
#if PY_VERSION_HEX >= 0x03090000
    // Isso não era necessário antes do Python 3.9 (problemas 35810 e 40217 do Python)
    Py_VISIT(Py_TYPE(self));
#endif
@}
@end example
@end quotation

Se sua função transversal delega para @code{tp_traverse} de sua classe base (ou outro tipo), certifique-se de que @code{Py_TYPE(self)} seja visitado apenas uma vez. Observe que apenas os @ref{96c,,tipos de heap} devem visitar o tipo em @code{tp_traverse}.

@quotation

Por exemplo, se sua função @code{tp_traverse} inclui:

@example
base->tp_traverse(self, visit, arg)
@end example

adicione:

@example
#if PY_VERSION_HEX >= 0x03090000
    // Isso não era necessário antes do Python 3.9 (bpo-35810 e bpo-40217)
    if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
        // tp_traverse de um tipo de heap já visitou Py_TYPE(self)
    @} else @{
        Py_VISIT(Py_TYPE(self));
    @}
#else
@end example
@end quotation

(Veja bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810} e bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217} para mais informações.)

@item 
As funções @code{PyEval_CallObject}, @code{PyEval_CallFunction}, @code{PyEval_CallMethod} e @code{PyEval_CallObjectWithKeywords} foram descontinuadas. Use @ref{39c,,PyObject_Call()} e suas variantes. (Veja mais detalhes em bpo-29548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29548}.)
@end itemize

@node Alterações de bytecode do CPython<5>,,Alterações na API C<8>,Portando para Python 3 9
@anchor{whatsnew/3 9 cpython-bytecode-changes}@anchor{96d}
@subsubsection Alterações de bytecode do CPython



@itemize *

@item 
O opcode @ref{96e,,LOAD_ASSERTION_ERROR} foi adicionado para tratar a instrução @ref{96f,,assert}. Anteriormente, a instrução assert não funcionava corretamente se a exceção @ref{6a9,,AssertionError} estivesse sendo ocultada. (Contribuição de Zackery Spytz em bpo-34880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34880}.)

@item 
O código de operação @ref{970,,COMPARE_OP} foi dividido em quatro instruções distintas:


@itemize *

@item 
@code{COMPARE_OP} para comparações ricas

@item 
@code{IS_OP} para testes “is” e “is not”

@item 
@code{CONTAINS_OP} para testes “in” e “not in”

@item 
@code{JUMP_IF_NOT_EXC_MATCH} para verificar exceções em instruções “try-except”.
@end itemize

(Contribuição de Mark Shannon em bpo-39156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39156}.)
@end itemize

@node Mudanças na construção<5>,Alterações na API C<9>,Portando para Python 3 9,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 build-changes}@anchor{971}
@subsection Mudanças na construção



@itemize *

@item 
Adicionada a opção @code{--with-platlibdir} ao script @code{configure}: nome do diretório de biblioteca específico da plataforma, armazenado no novo atributo @ref{93f,,sys.platlibdir}. Veja o atributo @ref{93f,,sys.platlibdir} para mais informações. (Contribuição de Jan Matějek, Matěj Cepl, Charalampos Stratakis e Victor Stinner em bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}.)

@item 
A macro especial de construção @code{COUNT_ALLOCS} foi removida. (Contribuição de Victor Stinner em bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}.)

@item 
Em plataformas não Windows, as funções @code{setenv()} e @code{unsetenv()} agora são necessárias para construir o Python. (Contribuição de Victor Stinner em bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}.)

@item 
Em plataformas não-Windows, a criação de instaladores @code{bdist_wininst} não possui mais suporte oficial. (Veja bpo-10945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10945} para mais detalhes.)

@item 
Ao compilar Python no macOS a partir do código-fonte, @code{_tkinter} agora se vincula a frameworks Tcl e Tk não pertencentes ao sistema se eles estiverem instalados em @code{/Library/Frameworks}, como era o caso em versões mais antigas do macOS. Se um macOS SDK for explicitamente configurado, usando @ref{972,,--enable-universalsdk} ou @code{-isysroot}, somente o SDK em si será procurado. Esse comportamento padrão pode ser sobreposto com @code{--with-tcltk-include} e @code{--with-tcltk-libs}. (Contribuição de Ned Deily em bpo-34956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34956}.)

@item 
Python pode agora ser construído para Windows 10 ARM64. (Contribuição de Steve Dower em bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}.)

@item 
Alguns testes individuais agora são ignorados quando @code{--pgo} é usada. Os testes em questão aumentaram significativamente o tempo da tarefa de PGO e provavelmente não ajudaram a melhorar a otimização do executável final. Isso acelera a tarefa por um fator de cerca de 15x. A execução de todo o conjunto de testes de unidade é lenta. Esta mudança pode resultar em uma construção um pouco menos otimizada, uma vez que nem tantos ramos de código serão executados. Se você estiver disposto a esperar por uma construção muito mais lenta, o comportamento antigo pode ser restaurado usando @code{./configure [..] PROFILE_TASK="-m test --pgo-extended"}. Não oferecemos garantia de qual conjunto de tarefas de PGO produz uma construção mais rápida. Os usuários que se importam devem executar seus próprios benchmarks relevantes, pois os resultados podem depender do ambiente, da carga de trabalho e da cadeia de ferramentas do compilador. (Veja bpo-36044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36044} e bpo-37707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37707} para mais detalhes.)
@end itemize

@node Alterações na API C<9>,Alterações notáveis no Python 3 9 1,Mudanças na construção<5>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 c-api-changes}@anchor{973}
@subsection Alterações na API C


@menu
* Novas funcionalidades: Novas funcionalidades<10>. 
* Portando para Python 3.9: Portando para Python 3 9<2>. 
* Removidos: Removidos<8>. 

@end menu

@node Novas funcionalidades<10>,Portando para Python 3 9<2>,,Alterações na API C<9>
@anchor{whatsnew/3 9 id1}@anchor{974}
@subsubsection Novas funcionalidades



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}: Adicionada @ref{551,,PyType_FromModuleAndSpec()} para associar um módulo a uma classe; @ref{975,,PyType_GetModule()} e @ref{976,,PyType_GetModuleState()} para obter o módulo e seu estado; e @ref{764,,PyCMethod} e @ref{977,,METH_METHOD} para permitir que um método acesse a classe na qual ela foi definida. (Contribuição de Marcel Plch e Petr Viktorin em bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}.)

@item 
Adicionada a função @ref{78a,,PyFrame_GetCode()}: obtém um código de quadro. Adiciona a função @ref{786,,PyFrame_GetBack()}: obtém o próximo quadro externo. (Contribuição de Victor Stinner em bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}.)

@item 
Adicionada @ref{78b,,PyFrame_GetLineNumber()} à API C limitada. (Contribuição de Victor Stinner em bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}.)

@item 
Adicionada as funções @ref{978,,PyThreadState_GetInterpreter()} e @ref{3ad,,PyInterpreterState_Get()} para obter o interpretador. Adiciona a função @ref{78e,,PyThreadState_GetFrame()} para obter o quadro atual de um estado de thread do Python. Adiciona a função @ref{979,,PyThreadState_GetID()}: obtém o identificador único de um estado de thread do Python. (Contribuição de Victor Stinner em bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}.)

@item 
Adicionada uma nova função pública @ref{39b,,PyObject_CallNoArgs()} à API C, que chama um objeto chamável Python sem nenhum argumento. É a maneira mais eficiente de chamar um objeto chamável Python sem nenhum argumento. (Contribuição de Victor Stinner em bpo-37194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37194}.)

@item 
Alterações na API C limitada (se a macro @code{Py_LIMITED_API} estiver definida):


@itemize *

@item 
Fornece @ref{97a,,Py_EnterRecursiveCall()} e @ref{97b,,Py_LeaveRecursiveCall()} como funções regulares para a API limitada. Anteriormente, eram definidas como macros, mas essas macros não compilavam com a API C limitada, que não pode acessar o campo @code{PyThreadState.recursion_depth} (a estrutura não é visível na API C limitada).

@item 
@code{PyObject_INIT()} e @code{PyObject_INIT_VAR()} se uma função regular não visível para ocultar os detalhes da implementação.
@end itemize

(Contribuição de Victor Stinner em bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} e bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}.)

@item 
A função @ref{97c,,PyModule_AddType()} é adicionado para ajudar a adicionar um tipo a um módulo. (Contribuição de Donghee Na em bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024}.)

@item 
Adicionadas as funções @ref{97d,,PyObject_GC_IsTracked()} e @ref{97e,,PyObject_GC_IsFinalized()} para a API pública para permitir a consulta se os objetos Python estão sendo rastreados ou já foram finalizados pelo coletor de lixo, respectivamente. (Contribuição de Pablo Galindo em bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}.)

@item 
Adicionada a @code{_PyObject_FunctionStr()} para obter uma representação amigável para o usuário de strings de um objeto função ou similar. (Patch por Jeroen Demeyer em bpo-37645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37645}.)

@item 
Adicionada @ref{97f,,PyObject_CallOneArg()} para chamar um objeto com um argumento posicional (Patch de Jeroen Demeyer em bpo-37483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37483}.)
@end itemize

@node Portando para Python 3 9<2>,Removidos<8>,Novas funcionalidades<10>,Alterações na API C<9>
@anchor{whatsnew/3 9 id2}@anchor{980}
@subsubsection Portando para Python 3.9



@itemize *

@item 
@code{PyInterpreterState.eval_frame} (
@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}) agora exige um novo parâmetro `tstate' obrigatório (@code{PyThreadState*}). (Contribuição de Victor Stinner em bpo-38500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38500}.)

@item 
Módulos de extensão: As funções @ref{981,,m_traverse}, @ref{982,,m_clear} e @ref{983,,m_free} de @ref{984,,PyModuleDef} não são mais chamados se o estado do módulo foi solicitado, mas ainda não está alocado. Este é o caso imediatamente após o módulo ser criado e antes de o módulo ser executado (função @ref{985,,Py_mod_exec}). Mais precisamente, estas funções são são chamados se @ref{986,,m_size} for maior que 0 e o estado do módulo (como retornado por @ref{987,,PyModule_GetState()}) for @code{NULL}.

Módulos de extensão sem um estado de módulo (@code{m_size <= 0}) não são afetados.

@item 
Se @ref{988,,Py_AddPendingCall()} for chamada em um subinterpretador, a função agora está programada para ser chamada a partir do subinterpretador, em vez de ser chamada a partir do interpretador principal. Cada subinterpretador agora tem sua própria lista de chamadas programadas. (Contribuição de Victor Stinner em bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}.)

@item 
O registro do Windows não é mais usado para inicializar @ref{3b4,,sys.path} quando a opção @code{-E} é usada (se @ref{3d9,,PyConfig.use_environment} estiver definido como @code{0}). Isso é significativo ao incorporar Python no Windows. (Contribuição de Zackery Spytz na bpo-8901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8901}.)

@item 
A variável global @ref{989,,PyStructSequence_UnnamedField} agora é uma constante e se refere a uma string constante. (Contribuição de Serhiy Storchaka em bpo-38650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38650}.)

@item 
A estrutura @code{PyGC_Head} agora é opaca. Ela só é definida na API C interna (@code{pycore_gc.h}). (Contribuição de Victor Stinner em bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}.)

@item 
@code{Py_UNICODE_COPY}, @code{Py_UNICODE_FILL}, , @code{PyUnicode_WSTR_LENGTH}, @code{PyUnicode_FromUnicode()}, @code{PyUnicode_AsUnicode()}, @code{_PyUnicode_AsUnicode} e @code{PyUnicode_AsUnicodeAndSize()} estão marcadas como descontinuadas no C. Elas foram descontinuadas pela 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} desde Python 3.3. (Contribuição de Inada Naoki em bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
A função @ref{98a,,Py_FatalError()} é substituída por uma macro que registra automaticamente o nome da função atual, a menos que a macro @code{Py_LIMITED_API} seja definida. (Contribuição de Victor Stinner em bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882}.)

@item 
O protocolo vectorcall agora exige que o chamador passe apenas strings como nomes de argumentos. (Veja bpo-37540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37540} para mais informações.)

@item 
Os detalhes de implementação de uma série de macros e funções agora estão ocultos:


@itemize *

@item 
A macro @ref{98b,,PyObject_IS_GC()} foi convertida para uma função.

@item 
A macro @code{PyObject_NEW()} se torna um apelido para a macro @ref{98c,,PyObject_New} e a macro @code{PyObject_NEW_VAR()} se torna um apelido para a macro @ref{98d,,PyObject_NewVar}. Elas não acessam mais diretamente o membro @ref{98e,,PyTypeObject.tp_basicsize}.

@item 
A macro @code{PyObject_GET_WEAKREFS_LISTPTR()} foi convertida para uma função: a macro acessava diretamente o membro @ref{98f,,PyTypeObject.tp_weaklistoffset}.

@item 
A macro @ref{398,,PyObject_CheckBuffer()} foi convertida para uma função: a macro acessava diretamente o membro @ref{990,,PyTypeObject.tp_as_buffer}.

@item 
@ref{991,,PyIndex_Check()} está agora declarada como uma função “opaca” para ocultar detalhes da implementação: removida a macro @code{PyIndex_Check()}. A macro acessava diretamente o membro @ref{992,,PyTypeObject.tp_as_number}.
@end itemize

(Veja bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170} para mais detalhes.)
@end itemize

@node Removidos<8>,,Portando para Python 3 9<2>,Alterações na API C<9>
@anchor{whatsnew/3 9 id3}@anchor{993}
@subsubsection Removidos



@itemize *

@item 
Excluídas as macros @code{PyFPE_START_PROTECT()} e @code{PyFPE_END_PROTECT()} de @code{pyfpe.h} da API C limitada. (Contribuição por Victor Stinner em bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}.)

@item 
O slot @code{tp_print} de @ref{994,,PyTypeObject} foi removido. Ele era usado para imprimir objetos em arquivos no Python 2.7 e anteriores. Desde Python 3.0, ele era ignorado e não utilizado. (Contribuição de Jeroen Demeyer em bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}.)

@item 
Alterações na API C limitada (se a macro @code{Py_LIMITED_API} estiver definida):


@itemize *

@item 
Excluídas as seguintes funções da API C limitada:


@itemize *

@item 
@code{PyThreadState_DeleteCurrent()} (Contribuição de Joannah Nanjekye em 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 
O mecanismo trashcan que nunca funcionou na 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 
Movidas as seguintes funções e definições para a API 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 construção de @code{Py_TRACE_REFS})
@end itemize
@end itemize

(Contribuição de Victor Stinner em bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} e bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}.)

@item 
Removido o gancho @code{_PyRuntime.getframe} e removida a macro @code{_PyThreadState_GetFrame} que era um alias para @code{_PyRuntime.getframe}. Eles eram os únicos expostos pela API C interna. Removido também o tipo @code{PyThreadFrameGetter}. (Contribuição de Victor Stinner em bpo-39946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39946}.)

@item 
Removidas as funções a seguir da API C. Chame @ref{995,,PyGC_Collect()} explicitamente para limpar todas as listas livres. (Contribuição de Inada Naoki e Victor Stinner em bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}, bpo-38896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38896} e 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()} e @code{PyCFunction_ClearFreeList()}: as listas livres de objetos de método vinculado foram removidas.

@item 
@code{PySet_ClearFreeList()}: a definição de lista livres foi removida no Python 3.4.

@item 
@code{PyTuple_ClearFreeList()}

@item 
@code{PyUnicode_ClearFreeList()}: a lista livre de Unicode foi removida no Python 3.3.
@end itemize

@item 
Removida a função @code{_PyUnicode_ClearStaticStrings()}. (Contribuição de Victor Stinner em bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}.)

@item 
Removido @code{Py_UNICODE_MATCH}. Ele foi descontinuado por 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} e quebrado desde o Python 3.3. A função @ref{8bd,,PyUnicode_Tailmatch()} pode ser usada em seu lugar. (Contribuição de Inada Naoki em bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}.)

@item 
Limpados os arquivos de cabeçalho de interfaces definidas, mas sem implementação. Os símbolos públicos da API sendo removidos são: @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}. (Contribuição de Pablo Galindo Salgado em bpo-39372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39372}.)
@end itemize

@node Alterações notáveis no Python 3 9 1,Alterações notáveis no Python 3 9 2,Alterações na API C<9>,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-1}@anchor{996}
@subsection Alterações notáveis no Python 3.9.1


@menu
* typing: typing<7>. 
* Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac: Suporte a macOS 11 0 Big Sur e Apple Silicon Mac. 

@end menu

@node typing<7>,Suporte a macOS 11 0 Big Sur e Apple Silicon Mac,,Alterações notáveis no Python 3 9 1
@anchor{whatsnew/3 9 id4}@anchor{997}
@subsubsection typing


O comportamento de @ref{858,,typing.Literal} foi alterado para ficar em conformidade com a 
@geindex Propostas de Melhorias do Python; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} e para corresponder ao comportamento de verificadores de tipo estático especificados na PEP.


@enumerate 

@item 
@code{Literal} agora elimina a duplicação de parâmetros.

@item 
Comparações de igualdade entre objetos @code{Literal} agora são independentes da ordem.

@item 
Comparações de @code{Literal} agora respeitam os tipos. Por exemplo, @code{Literal[0] == Literal[False]} avaliava anteriormente como @code{True}. Agora é @code{False}. Para oferecer suporte a essa mudança, o cache de tipo usado internamente agora oferece suporte a tipos de diferenciação.

@item 
Objetos @code{Literal} agora irão levantar uma exceção @ref{2c3,,TypeError} durante as comparações de igualdade se algum de seus parâmetros não for @ref{610,,hasheável}. Observe que declarar @code{Literal} com parâmetros mutáveis não gerará um erro:

@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

(Contribuição de Yurii Karabas em bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}.)

@node Suporte a macOS 11 0 Big Sur e Apple Silicon Mac,,typing<7>,Alterações notáveis no Python 3 9 1
@anchor{whatsnew/3 9 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{998}
@subsubsection Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac


A partir do 3.9.1, o Python agora oferece suporte total à construção e execução no macOS 11.0 (Big Sur) e no Apple Silicon Macs (baseado na arquitetura @code{ARM64}). Uma nova variante de compilação universal, @code{universal2}, está agora disponível para suportar nativamente ambos @code{ARM64} e @code{Intel 64} em um conjunto de executáveis. Os binários também podem ser construídos em versões atuais do macOS para serem implantados em uma variedade de versões mais antigas do macOS (testado para 10.9), enquanto algumas funções e opções do sistema operacional mais recentes estão disponíveis condicionalmente com base na versão do sistema operacional em uso no tempo de execução (“ligação fraca”)

(Contribuição de Ronald Oussoren e Lawrence D’Anna em bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}.)

@node Alterações notáveis no Python 3 9 2,Alterações notáveis no Python 3 9 3,Alterações notáveis no Python 3 9 1,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-2}@anchor{999}
@subsection Alterações notáveis no Python 3.9.2


@menu
* collections.abc: collections abc<2>. 
* urllib.parse: urllib parse<2>. 

@end menu

@node collections abc<2>,urllib parse<2>,,Alterações notáveis no Python 3 9 2
@anchor{whatsnew/3 9 collections-abc}@anchor{99a}
@subsubsection collections.abc


@ref{7ec,,collections.abc.Callable} genérica agora nivela os parâmetros de tipo, semelhante ao que @ref{7c6,,typing.Callable} faz atualmente. Isso significa que @code{collections.abc.Callable[[int, str], str]} terá @code{__args__} de @code{(int, str, str)}; anteriormente era @code{([int, str], str)}. Para permitir esta mudança, @ref{7ed,,types.GenericAlias} agora pode ter uma subclasse, e uma subclasse será retornada ao subscrever o tipo @code{Collections.abc.Callable}. O código que acessa os argumentos via @ref{2ed,,typing.get_args()} ou @code{__args__} precisa levar em conta esta mudança. Um @ref{1a5,,DeprecationWarning} pode ser emitido para formas inválidas de parametrização @code{Collections.abc.Callable} que pode ter passado silenciosamente no Python 3.9.1. Esta @ref{1a5,,DeprecationWarning} se tornará uma @ref{2c3,,TypeError} no Python 3.10. (Contribuição de Ken Jin em bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}.)

@node urllib parse<2>,,collections abc<2>,Alterações notáveis no Python 3 9 2
@anchor{whatsnew/3 9 urllib-parse}@anchor{99b}
@subsubsection urllib.parse


Versões anteriores do Python permitiam o uso de @code{;} e @code{&} como separadores de parâmetros de consulta nas funções @ref{27a,,urllib.parse.parse_qs()} e @ref{279,,urllib.parse.parse_qsl()}. Devido a questões de segurança, e em conformidade com as recomendações mais recentes do W3C, isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como padrão. Esta mudança também afeta as funções @code{cgi.parse()} e @code{cgi.parse_multipart()} já que elas usam as funções afetadas internamente. Para obter mais detalhes, consulte sua respectiva documentação. (Contribuição de Adam Goldschmidt, Senthil Kumaran e Ken Jin em bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Alterações notáveis no Python 3 9 3,Alterações notáveis no Python 3 9 5,Alterações notáveis no Python 3 9 2,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-3}@anchor{99c}
@subsection Alterações notáveis no Python 3.9.3


Uma correção de segurança altera o comportamento @ref{900,,ftplib.FTP} para não confiar no endereço IPv4 enviado do servidor remoto ao configurar um canal de dados passivo. Em vez disso, reutilizamos o endereço IP do servidor ftp. Para códigos incomuns que requerem o comportamento antigo, defina um atributo @code{trust_server_pasv_ipv4_address} em sua instância de FTP para @code{True}. (Veja gh-87451@footnote{https://github.com/python/cpython/issues/87451})

@node Alterações notáveis no Python 3 9 5,Recursos de segurança notáveis no 3 9 14,Alterações notáveis no Python 3 9 3,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-5}@anchor{99d}
@subsection Alterações notáveis no Python 3.9.5


@menu
* urllib.parse: urllib parse<3>. 

@end menu

@node urllib parse<3>,,,Alterações notáveis no Python 3 9 5
@anchor{whatsnew/3 9 id5}@anchor{99e}
@subsubsection urllib.parse


A presença de caracteres de nova linha ou tab em partes de um URL permite algumas formas de ataques. Seguindo a especificação WHATWG que atualiza 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, nova linha ASCII @code{\n}, @code{\r} e os caracteres de tabulação @code{\t} são retirados da URL pelo analisador sintático em @ref{10a,,urllib.parse} impedindo tais ataques. Os caracteres de remoção são controlados por uma nova variável de nível de módulo @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (Veja gh-88048@footnote{https://github.com/python/cpython/issues/88048})

@node Recursos de segurança notáveis no 3 9 14,Alterações notáveis no 3 9 17,Alterações notáveis no Python 3 9 5,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-security-feature-in-3-9-14}@anchor{99f}
@subsection Recursos de segurança notáveis no 3.9.14


Converter entre @ref{257,,int} e @ref{44c,,str} em bases diferentes de 2 (binário), 4, 8 (octal), 16 (hexadecimal) ou 32 como base 10 (decimal) agora levanta uma exceção @ref{202,,ValueError} se o número de dígitos em forma de string estiver acima de um limite para evitar possíveis ataques de negação de serviço devido à complexidade algorítmica. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}. Este limite pode ser configurado ou desabilitado por variável de ambiente, sinalizador de linha de comando ou APIs de @ref{d9,,sys}. Veja a documentação de @ref{5f5,,limitação de comprimento de conversão de string inteira}. O limite padrão é de 4300 dígitos em forma de string.

@node Alterações notáveis no 3 9 17,,Recursos de segurança notáveis no 3 9 14,O que há de novo no Python 3 9
@anchor{whatsnew/3 9 notable-changes-in-3-9-17}@anchor{9a0}
@subsection Alterações notáveis no 3.9.17


@menu
* tarfile: tarfile<4>. 

@end menu

@node tarfile<4>,,,Alterações notáveis no 3 9 17
@anchor{whatsnew/3 9 tarfile}@anchor{9a1}
@subsubsection tarfile



@itemize *

@item 
Os métodos de extração em @ref{de,,tarfile} e @ref{46b,,shutil.unpack_archive()}, têm um novo argumento `filter' que permite limitar recursos do tar que podem ser surpreendentes ou perigosos, como criar arquivos fora do diretório de destino. Veja @ref{46c,,Filtros de extração} para detalhes. No Python 3.12, usar sem o argumento `filter' mostrará um @ref{1a5,,DeprecationWarning}. No Python 3.14, o padrão mudará para @code{'data'}. (Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node O que há de novo no Python 3 8,O que há de novo no Python 3 7,O que há de novo no Python 3 9,O que há de novo no Python
@anchor{whatsnew/3 8 doc}@anchor{9a2}@anchor{whatsnew/3 8 translation-repo}@anchor{9a3}@anchor{whatsnew/3 8 what-s-new-in-python-3-8}@anchor{9a4}
@section O que há de novo no 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 artigo explica os novos recursos no Python 3.8, em comparação com 3.7. Python 3.8 foi lançado em 14 de outubro de 2019. Veja @ref{13c,,changelog} para uma lista completa de mudanças.

@c from datetime import date
@c from math import cos, radians
@c from unicodedata import normalize
@c import re
@c import math

@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<6>. 
* Novas funcionalidades: Novas funcionalidades<11>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<6>. 
* Novos módulos: Novos módulos<6>. 
* Módulos melhorados: Módulos melhorados<6>. 
* Otimizações: Otimizações<6>. 
* Mudanças a construções e API C:: 
* Descontinuados: Descontinuados<8>. 
* Remoção de APIs e recursos:: 
* Portando para o Python 3.8: Portando para o Python 3 8. 
* Alterações notáveis no Python 3.8.1: Alterações notáveis no Python 3 8 1. 
* Alterações notáveis no Python 3.8.2: Alterações notáveis no Python 3 8 2. 
* Alterações notáveis no Python 3.8.3: Alterações notáveis no Python 3 8 3. 
* Alterações notáveis no Python 3.8.8: Alterações notáveis no Python 3 8 8. 
* Alterações notáveis no Python 3.8.9: Alterações notáveis no Python 3 8 9. 
* Alterações notáveis no Python 3.8.10: Alterações notáveis no Python 3 8 10. 
* Alterações notáveis no Python 3.8.10: Alterações notáveis no Python 3 8 10<2>. 
* Alterações notáveis no Python 3.8.12: Alterações notáveis no Python 3 8 12. 
* Recursos de segurança notáveis no 3.8.14: Recursos de segurança notáveis no 3 8 14. 
* Alterações notáveis no 3.8.17: Alterações notáveis no 3 8 17. 

@end menu

@node Resumo – Destaques da versão<6>,Novas funcionalidades<11>,,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 summary-release-highlights}@anchor{9a5}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.8.
@c Brevity is key.

@c PEP-sized items next.

@node Novas funcionalidades<11>,Outras mudanças na linguagem<6>,Resumo – Destaques da versão<6>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 new-features}@anchor{9a6}
@subsection Novas funcionalidades


@menu
* Expressões de atribuição:: 
* Parâmetros somente-posicionais:: 
* Cache do sistema de arquivos paralelo para arquivos de bytecode compilados:: 
* A compilação de depuração usa a mesma ABI da compilação de lançamento:: 
* O suporte a f-strings = para expressões de auto-documentação e depuração:: 
* PEP 578; Ganchos de auditoria em tempo de execução Python: PEP 578 Ganchos de auditoria em tempo de execução Python. 
* PEP 587; Configuração de Inicialização do Python: PEP 587 Configuração de Inicialização do Python. 
* PEP 590; Vectorcall; um protocolo de chamada rápida para CPython: PEP 590 Vectorcall um protocolo de chamada rápida para CPython. 
* Protocolo de Pickle 5 com buffers de dados fora da banda:: 

@end menu

@node Expressões de atribuição,Parâmetros somente-posicionais,,Novas funcionalidades<11>
@anchor{whatsnew/3 8 assignment-expressions}@anchor{9a7}
@subsubsection Expressões de atribuição


Existe uma nova sintaxe @code{:=} que atribui valores a variáveis como parte de uma expressão maior. É carinhosamente conhecido como “o operador morsa” (“the walrus operator”, em inglês) devido à sua semelhança com os olhos e presas de uma morsa@footnote{https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg}

Neste exemplo, a expressão de atribuição ajuda a evitar a chamada de @ref{62e,,len()} duas vezes:

@example
if (n := len(a)) > 10:
    print(f"List is too long (@{n@} elements, expected <= 10)")
@end example

Um benefício semelhante surge durante a correspondência de expressões regulares, onde os objetos de correspondência são necessários duas vezes, uma vez para testar se ocorreu uma correspondência e outra para extrair um subgrupo:

@example
discount = 0.0
if (mo := re.search(r'(\d+)% discount', advertisement)):
    discount = float(mo.group(1)) / 100.0
@end example

O operador também é útil com loops while que calculam um valor para testar a finalização do loop e, em seguida, precisam desse mesmo valor novamente no corpo do loop:

@example
# Loop over fixed length blocks
while (block := f.read(256)) != '@w{'}:
    process(block)
@end example

Outro caso de uso motivador surge em compreensões de lista em que um valor calculado em uma condição de filtragem também é necessário no corpo da expressão:

@example
[clean_name.title() for name in names
 if (clean_name := normalize('NFC', name)) in allowed_names]
@end example

Tente limitar o uso do operador morsa para limpar os casos que reduzem a complexidade e melhoram a legibilidade.

Consulte 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para uma descrição completa.

(Contribuição de Emily Morehouse em bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)

@node Parâmetros somente-posicionais,Cache do sistema de arquivos paralelo para arquivos de bytecode compilados,Expressões de atribuição,Novas funcionalidades<11>
@anchor{whatsnew/3 8 positional-only-parameters}@anchor{9a8}
@subsubsection Parâmetros somente-posicionais


Existe uma nova sintaxe de parâmetro de função @code{/} para indicar que alguns parâmetros de função devem ser especificados posicionalmente e não podem ser usados como argumentos nomeados. Esta é a mesma notação mostrada por @code{help()} para funções C anotadas com a ferramenta Argument Clinic@footnote{https://devguide.python.org/development-tools/clinic/} de Larry Hastings.

No exemplo a seguir, os parâmetros `a' e `b' são apenas posicionais, enquanto `c' ou `d' podem ser posicionais ou nomeados e `e' ou `f' são obrigatoriamente nomeados:

@example
def f(a, b, /, c, d, *, e, f):
    print(a, b, c, d, e, f)
@end example

A seguir, uma chamada válida:

@example
f(10, 20, 30, d=40, e=50, f=60)
@end example

Porém, essas chamadas são inválidas:

@example
f(10, b=20, c=30, d=40, e=50, f=60)   # b não pode ser um argumento nomeado
f(10, 20, 30, 40, 50, f=60)           # e deve ser um argumento nomeado
@end example

Um caso de uso para essa notação é que ele permite que funções puras do Python emulem completamente os comportamentos das funções codificadas em C existentes. Por exemplo, a função embutida @ref{9a9,,divmod()} não aceita argumentos nomeados:

@example
def divmod(a, b, /):
    "Emula a função embutida divmod()"
    return (a // b, a % b)
@end example

Outro caso de uso é impedir argumentos nomeados quando o nome do parâmetro não for útil. Por exemplo, a função embutida @ref{62e,,len()} possui a assinatura @code{len(obj, /)}. Isso exclui chamadas estranhas, como:

@example
len(obj='hello')  # O argumento nomeado "obj" prejudica a legibilidade
@end example

Um benefício adicional de marcar um parâmetro como somente posicional é que ele permite que o nome do parâmetro seja alterado no futuro sem risco de quebrar o código do cliente. Por exemplo, no módulo @ref{d2,,statistics}, o nome do parâmetro `dist' pode ser alterado no futuro. Isso foi possível com a seguinte especificação de função:

@example
def quantiles(dist, /, *, n=4, method='exclusive')
    ...
@end example

Como os parâmetros à esquerda de @code{/} não são expostos como possíveis palavras-chave, os nomes dos parâmetros permanecem disponíveis para uso em @code{**kwargs}:

@example
>>> def f(a, b, /, **kwargs):
...     print(a, b, kwargs)
...
>>> f(10, 20, a=1, b=2, c=3)         # a e b são usados de duas formas
10 20 @{'a': 1, 'b': 2, 'c': 3@}
@end example

Isso simplifica bastante a implementação de funções e métodos que precisam aceitar argumentos nomeados arbitrários. Por exemplo, aqui está um trecho do código no módulo @ref{1d,,collections}:

@example
class Counter(dict):

    def __init__(self, iterable=None, /, **kwds):
        # Observe que "iterable" é um possível argumento nomeado
@end example

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} para uma descrição completa.

(Contribuição de Pablo Galindo em bpo-36540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36540}.)

@c TODO: Pablo will sprint on docs at PyCon US 2019.

@node Cache do sistema de arquivos paralelo para arquivos de bytecode compilados,A compilação de depuração usa a mesma ABI da compilação de lançamento,Parâmetros somente-posicionais,Novas funcionalidades<11>
@anchor{whatsnew/3 8 parallel-filesystem-cache-for-compiled-bytecode-files}@anchor{9aa}
@subsubsection Cache do sistema de arquivos paralelo para arquivos de bytecode compilados


A nova configuração 
@geindex PYTHONPYCACHEPREFIX
@geindex variável de ambiente; PYTHONPYCACHEPREFIX
@ref{9ab,,PYTHONPYCACHEPREFIX} (também disponível como @ref{176,,-X} @code{pycache_prefix}) configura o cache implícito de bytecode para usar uma árvore paralela separada do sistema de arquivos, em vez dos subdiretórios padrão @code{__pycache__} dentro cada diretório fonte.

O local do cache é relatado em @ref{9ac,,sys.pycache_prefix} (@ref{675,,None} indica o local padrão nos subdiretórios @code{__pycache__}).

(Contribuição de Carl Meyer em bpo-33499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33499}.)

@node A compilação de depuração usa a mesma ABI da compilação de lançamento,O suporte a f-strings = para expressões de auto-documentação e depuração,Cache do sistema de arquivos paralelo para arquivos de bytecode compilados,Novas funcionalidades<11>
@anchor{whatsnew/3 8 debug-build-uses-the-same-abi-as-release-build}@anchor{9ad}
@subsubsection A compilação de depuração usa a mesma ABI da compilação de lançamento


Agora, o Python usa a mesma ABI, seja ele compilado no modo de lançamento ou depuração. No Unix, quando o Python é compilado no modo de depuração, agora é possível carregar extensões C compiladas no modo de lançamento e extensões C compiladas usando a ABI estável.

Compilações de lançamento e @ref{1f9,,compilações de depuração} agora são compatíveis com ABI: definir a macro @code{Py_DEBUG} não implica mais a macro @code{Py_TRACE_REFS}, que introduz a única incompatibilidade ABI. A macro @code{Py_TRACE_REFS}, que adiciona a função @ref{427,,sys.getobjects()} e a variável de ambiente 
@geindex PYTHONDUMPREFS
@geindex variável de ambiente; PYTHONDUMPREFS
@ref{9ae,,PYTHONDUMPREFS}, pode ser configurada usando a nova opção de compilação @ref{395,,./configure --with-trace-refs}. (Contribuição de Victor Stinner em bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}.)

No Unix, as extensões C não estão mais vinculadas ao libpython, exceto no Android e Cygwin. Agora é possível que um Python vinculado estaticamente carregue uma extensão C criada usando uma biblioteca compartilhada Python. (Contribuição de Victor Stinner em bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}.)

No Unix, quando o Python é compilado no modo de depuração, a importação agora também procura extensões C compiladas no modo de lançamento e extensões C compiladas com a ABI estável. (Contribuição de Victor Stinner em bpo-36722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36722}.)

Para incorporar o Python em uma aplicação, uma nova opção @code{--embed} deve ser passada para @code{python3-config --libs --embed} para obter o @code{-lpython3.8} (vincula a aplicação ao libpython). Para dar suporte a 3.8 e versões mais antigas, tente @code{python3-config --libs --embed} primeiro e use como fallback para @code{python3-config --libs} (sem @code{--embed}) se o comando anterior falhar.

Adicione um módulo pkg-config @code{python-3.8-embed} para incorporar o Python em uma aplicação: @code{pkg-config python-3.8-embed --libs} inclui @code{-lpython3.8}. Para suportar tanto o 3.8 quanto o anterior, tente @code{pkg-config python-X.Y-embed --libs} primeiro e use como fallback @code{pkg-config python-X.Y --libs} (sem @code{--embed}) se o comando anterior falhar (substitua @code{X.Y} pela versão do Python).

Por outro lado, @code{pkg-config python3.8 --libs} não contém mais @code{-lpython3.8}. As extensões C não devem estar vinculadas ao libpython (exceto no Android e Cygwin, cujos casos são tratados pelo script); essa alteração é retroativamente incompatível de propósito. (Contribuição de Victor Stinner em bpo-36721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36721}.)

@node O suporte a f-strings = para expressões de auto-documentação e depuração,PEP 578 Ganchos de auditoria em tempo de execução Python,A compilação de depuração usa a mesma ABI da compilação de lançamento,Novas funcionalidades<11>
@anchor{whatsnew/3 8 bpo-36817-whatsnew}@anchor{9af}@anchor{whatsnew/3 8 f-strings-support-for-self-documenting-expressions-and-debugging}@anchor{9b0}
@subsubsection O suporte a f-strings @code{=} para expressões de auto-documentação e depuração


Adicionado um especificador @code{=} para @ref{436,,f-string}s. Uma f-string como @code{f'@{expr=@}'} será expandida para o texto da expressão, um sinal de igual e, em seguida, a representação da expressão avaliada. Por exemplo:

@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

O habitual @ref{9b1,,f-string especificadores de formato} permite mais controle sobre como o resultado da expressão é exibido:

@example
>>> delta = date.today() - member_since
>>> f'@{user=!s@}  @{delta.days=:,d@}'
'user=eric_idle  delta.days=16,075'
@end example

O especificador @code{=} exibirá toda a expressão para que os cálculos possam ser mostrados:

@example
>>> print(f'@{theta=@}  @{cos(radians(theta))=:.3f@}')
theta=30  cos(radians(theta))=0.866
@end example

(Contribuição de Eric V. Smith e Larry Hastings em bpo-36817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36817}.)

@node PEP 578 Ganchos de auditoria em tempo de execução Python,PEP 587 Configuração de Inicialização do Python,O suporte a f-strings = para expressões de auto-documentação e depuração,Novas funcionalidades<11>
@anchor{whatsnew/3 8 pep-578-python-runtime-audit-hooks}@anchor{9b2}
@subsubsection PEP 578: Ganchos de auditoria em tempo de execução Python


O PEP adiciona um Gancho de Auditoria e um Gancho Aberto Verificado. Ambos estão disponíveis no Python e no código nativo, permitindo que aplicações e estruturas escritas em código Python puro aproveitem as notificações extras, além de permitir que incorporadores ou administradores de sistema implementem versões do Python onde a auditoria está sempre ativada.

Veja 
@geindex Propostas de Melhorias do Python; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para mais detalhes.

@node PEP 587 Configuração de Inicialização do Python,PEP 590 Vectorcall um protocolo de chamada rápida para CPython,PEP 578 Ganchos de auditoria em tempo de execução Python,Novas funcionalidades<11>
@anchor{whatsnew/3 8 pep-587-python-initialization-configuration}@anchor{9b3}
@subsubsection PEP 587: Configuração de Inicialização do Python


O 
@geindex Propostas de Melhorias do Python; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} adiciona uma nova API C para configurar a Inicialização do Python, fornecendo um controle mais preciso de toda a configuração e melhores relatórios de erros.

Novas estruturas:


@itemize *

@item 
@ref{3a6,,PyConfig}

@item 
@ref{9b4,,PyPreConfig}

@item 
@ref{9b5,,PyStatus}

@item 
@ref{9b6,,PyWideStringList}
@end itemize

Novas Funções:


@itemize *

@item 
@ref{9b7,,PyConfig_Clear()}

@item 
@ref{9b8,,PyConfig_InitIsolatedConfig()}

@item 
@ref{9b9,,PyConfig_InitPythonConfig()}

@item 
@ref{790,,PyConfig_Read()}

@item 
@ref{9ba,,PyConfig_SetArgv()}

@item 
@ref{9bb,,PyConfig_SetBytesArgv()}

@item 
@ref{9bc,,PyConfig_SetBytesString()}

@item 
@ref{9bd,,PyConfig_SetString()}

@item 
@ref{9be,,PyPreConfig_InitIsolatedConfig()}

@item 
@ref{9bf,,PyPreConfig_InitPythonConfig()}

@item 
@ref{9c0,,PyStatus_Error()}

@item 
@ref{9c1,,PyStatus_Exception()}

@item 
@ref{9c2,,PyStatus_Exit()}

@item 
@ref{9c3,,PyStatus_IsError()}

@item 
@ref{9c4,,PyStatus_IsExit()}

@item 
@ref{9c5,,PyStatus_NoMemory()}

@item 
@ref{9c6,,PyStatus_Ok()}

@item 
@ref{9c7,,PyWideStringList_Append()}

@item 
@ref{9c8,,PyWideStringList_Insert()}

@item 
@ref{9c9,,Py_BytesMain()}

@item 
@ref{9ca,,Py_ExitStatusException()}

@item 
@ref{3c5,,Py_InitializeFromConfig()}

@item 
@ref{3eb,,Py_PreInitialize()}

@item 
@ref{9cb,,Py_PreInitializeFromArgs()}

@item 
@ref{9cc,,Py_PreInitializeFromBytesArgs()}

@item 
@ref{9cd,,Py_RunMain()}
@end itemize

Esse PEP também adiciona os campos @code{_PyRuntimeState.preconfig} (tipo @ref{9b4,,PyPreConfig}) e @code{PyInterpreterState.config} (tipo @ref{3a6,,PyConfig}) campos a essas estruturas internas. @code{PyInterpreterState.config} se torna a nova configuração de referência, substituindo variáveis de configuração global e outras variáveis privadas.

Veja @ref{3a7,,Configuração de Inicialização do Python} para a documentação.

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} para uma descrição completa.

(Contribuição de Victor Stinner em bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}.)

@node PEP 590 Vectorcall um protocolo de chamada rápida para CPython,Protocolo de Pickle 5 com buffers de dados fora da banda,PEP 587 Configuração de Inicialização do Python,Novas funcionalidades<11>
@anchor{whatsnew/3 8 pep-590-vectorcall-a-fast-calling-protocol-for-cpython}@anchor{9ce}
@subsubsection PEP 590: Vectorcall: um protocolo de chamada rápida para CPython


@ref{552,,O protocolo vectorcall} é adicionado à API Python/C. Ele visa formalizar as otimizações existentes que já foram feitas para várias classes. Qualquer @ref{77f,,tipo estático} que implemente um chamável pode usar esse protocolo.

Atualmente, isso é provisório. O objetivo é torná-lo totalmente público no Python 3.9.

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} para uma descrição completa.

(Contribuição de Jeroen Demeyer, Mark Shannon e Petr Viktorin em bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}.)

@node Protocolo de Pickle 5 com buffers de dados fora da banda,,PEP 590 Vectorcall um protocolo de chamada rápida para CPython,Novas funcionalidades<11>
@anchor{whatsnew/3 8 pickle-protocol-5-with-out-of-band-data-buffers}@anchor{9cf}
@subsubsection Protocolo de Pickle 5 com buffers de dados fora da banda


Quando @ref{a6,,pickle} é usado para transferir grande quantidade de dados entre processos Python, a fim de tirar proveito do processamento com vários núcleos ou com várias máquinas, é importante otimizar a transferência reduzindo cópias de memória e, possivelmente, aplicando técnicas personalizadas, como como compactação dependente de dados.

O protocolo @ref{a6,,pickle} 5 introduz suporte para buffers fora de banda, onde dados compatíveis com a 
@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} podem ser transmitidos separadamente do fluxo de pickle principal, a critério da camada de comunicação.

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} para uma descrição completa.

(Contribuição de Antoine Pitrou em bpo-36785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36785}.)

@node Outras mudanças na linguagem<6>,Novos módulos<6>,Novas funcionalidades<11>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 other-language-changes}@anchor{9d0}
@subsection Outras mudanças na linguagem



@itemize *

@item 
A instrução @ref{9d1,,continue} era ilegal na cláusula @ref{9d2,,finally} devido a um problema com a implementação. No Python 3.8, essa restrição foi levantada. (Contribuição de Serhiy Storchaka em bpo-32489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32489}.)

@item 
Os tipos @ref{468,,bool}, @ref{257,,int} e @ref{1e7,,fractions.Fraction} agora têm o método @ref{9d3,,as_integer_ratio()} como o encontrado em @ref{2f7,,float} e @ref{29d,,decimal.Decimal}. Esta pequena extensão da API torna possível escrever @code{numerator, denominator = x.as_integer_ratio()} e fazer com que funcione em vários tipos numéricos. (Contribuição de Lisa Roach em bpo-33073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33073} e Raymond Hettinger em bpo-37819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37819}.)

@item 
Os construtores de @ref{257,,int}, @ref{2f7,,float} e @ref{2f8,,complex} agora usarão o método especial @ref{71d,,__index__()}, se disponível, e o método correspondente @ref{71c,,__int__()}, @ref{9d4,,__float__()} ou @ref{5e7,,__complex__()} não está disponível. (Contribuição de Serhiy Storchaka em bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}.)

@item 
Adicionado suporte a escapes @code{\N@{@var{name}@}} em @ref{b9,,expressões 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

(Contribuição de Jonathan Eunice e Serhiy Storchaka em bpo-30688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30688}.)

@item 
Dict e dictviews agora são iteráveis em ordem de inserção reversa usando @ref{869,,reversed()}. (Contribuição de Rémi Lapeyre em bpo-33462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33462}.)

@item 
A sintaxe permitida para nomes de palavras-chave em chamadas de função foi ainda mais restrita. Em particular, @code{f((keyword)=arg)} não é mais permitido. Ele nunca teve a intenção de permitir mais do que um nome simples no lado esquerdo de um termo de atribuição de argumento nomeado. (Contribuição de Benjamin Peterson em bpo-34641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34641}.)

@item 
O desempacotamento de iterável generalizado das instruções @ref{9d5,,yield} e @ref{9d6,,return} não requer mais parênteses. Isso traz a sintaxe `yield' e `return' uma melhor concordância com a sintaxe de atribuição normal:

@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

(Contribuição de David Cuthbert e Jordan Chapman em bpo-32117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32117}.)

@item 
Quando uma vírgula está faltando em código como @code{[(10, 20) (30, 40)]}, o compilador exibe um @ref{466,,SyntaxWarning} com uma sugestão útil. Isso melhora apenas tendo um @ref{2c3,,TypeError} indicando que a primeira tupla não era chamável. (Contribuição de Serhiy Storchaka em bpo-15248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15248}.)

@item 
As operações aritméticas entre as subclasses de @ref{1cd,,datetime.date} ou @ref{1cc,,datetime.datetime} e @ref{9d7,,datetime.timedelta} agora retornam uma instância da subclasse, em vez da classe base. Isso também afeta o tipo de retorno de operações cuja implementação (direta ou indiretamente) utiliza aritmética de @ref{9d7,,datetime.timedelta}, como @ref{9d8,,astimezone()}. (Contribuição de Paul Ganssle em bpo-32417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32417}.)

@item 
Quando o interpretador Python é interrompido por Ctrl-C (SIGINT) e a exceção resultante @ref{9d9,,KeyboardInterrupt} não é capturada, o processo Python agora sai por meio de um sinal SIGINT ou com o código de saída correto, para que o processo de chamada possa detectar que foi encerrado devido a um Ctrl-C. Os shells no POSIX e Windows usam isso para finalizar corretamente os scripts em sessões interativas. (Contribuição do Google via Gregory P. Smith em bpo-1054041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1054041}.)

@item 
Alguns estilos avançados de programação requerem a atualização do objeto @ref{2df,,types.CodeType} para uma função existente. Como os objetos código são imutáveis, um novo objeto código precisa ser criado, modelado no objeto código existente. Com 19 parâmetros, isso foi um pouco tedioso. Agora, o novo método @code{replace()} torna possível criar um clone com alguns parâmetros alterados.

Aqui está um exemplo que altera a função @code{Statistics.mean()} para impedir que o parâmetro `data' seja usado como argumento nomeado:

@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

(Contribuição de Victor Stinner em bpo-37032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37032}.)

@item 
Para números inteiros, a forma de três argumentos da função @ref{9da,,pow()} agora permite que o expoente seja negativo no caso em que a base é relativamente primária ao módulo. Em seguida, calcula um inverso modular para a base quando o expoente é @code{-1} e uma potência adequada desse inverso para outros expoentes negativos. Por exemplo, para calcular o inverso multiplicativo modular@footnote{https://en.wikipedia.org/wiki/Modular_multiplicative_inverse} de 38 módulo 137, escreva:

@example
>>> pow(38, -1, 137)
119
>>> 119 * 38 % 137
1
@end example

Inversos modulares surgem na solução de equações diofantinas lineares@footnote{https://en.wikipedia.org/wiki/Diophantine_equation}. Por exemplo, para encontrar soluções inteiras para @code{4258𝑥 + 147𝑦 = 369}, primeiro reescreva como @code{4258𝑥 ≡ 369 (mod 147)} e depois resolva:

@example
>>> x = 369 * pow(4258, -1, 147) % 147
>>> y = (4258 * x - 369) // -147
>>> 4258 * x + 147 * y
369
@end example

(Contribuição de Mark Dickinson em bpo-36027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36027}.)

@item 
As compreensões de dict foram sincronizadas com literais de dict, para que a chave seja computada primeiro e o valor em segundo:

@example
>>> # Compreensão de dicionário
>>> cast = @{input('role? '): input('actor? ') for i in range(2)@}
role? King Arthur
actor? Chapman
role? Black Knight
actor? Cleese

>>> # Literal de dicionário
>>> cast = @{input('role? '): input('actor? ')@}
role? Sir Robin
actor? Eric Idle
@end example

A ordem de execução garantida é útil nas expressões de atribuição, porque as variáveis atribuídas na expressão de chave estarão disponíveis na expressão de 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

(Contribuição de Jörn Heissler em bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)

@item 
O método @ref{9db,,object.__reduce__()} agora pode retornar uma tupla de dois a seis elementos. Anteriormente, o limite era cinco. O novo sexto elemento opcional é um chamável com uma assinatura @code{(obj, state)}. Isso permite o controle direto sobre o comportamento de atualização de estado de um objeto específico. Se não for `None', este chamável terá prioridade sobre o método @ref{9dc,,__setstate__()} do objeto. (Contribuição de Pierre Glaser e Olivier Grisel em bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}.)
@end itemize

@node Novos módulos<6>,Módulos melhorados<6>,Outras mudanças na linguagem<6>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 new-modules}@anchor{9dd}
@subsection Novos módulos



@itemize *

@item 
O novo módulo @ref{7a,,importlib.metadata} fornece suporte (provisório) para a leitura de metadados de pacotes de terceiros. Por exemplo, ele pode extrair o número da versão de um pacote instalado, a lista de pontos de entrada e muito mais:

@example
>>> # Note o exemplo a seguir requer que o pacote popular
>>> # "requests" tenha sido instalado.
>>>
>>> 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

(Contribuição de Barry Warsaw e Jason R. Coombs em bpo-34632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34632}.)
@end itemize

@node Módulos melhorados<6>,Otimizações<6>,Novos módulos<6>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 improved-modules}@anchor{9de}
@subsection Módulos melhorados


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

@end menu

@node ast<3>,asyncio<6>,,Módulos melhorados<6>
@anchor{whatsnew/3 8 ast}@anchor{9df}
@subsubsection ast


Os nós de AST agora têm os atributos @code{end_lineno} e @code{end_col_offset}, que fornecem a localização precisa do final do nó. (Isso se aplica apenas aos nós que possuem os atributos @code{lineno} e @code{col_offset}.)

Nova função @ref{9e0,,ast.get_source_segment()} retorna o código-fonte para um nó AST específico.

(Contribuição de Ivan Levkivskyi em bpo-33416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33416}.)

A função @ref{1a8,,ast.parse()} possui alguns novos sinalizadores:


@itemize *

@item 
@code{type_comments=True} faz com que retorne o texto dos comentários de tipos de 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} associados a determinados nós AST;

@item 
@code{mode='func_type'} pode ser usado para analisar “comentários do tipo de assinatura” do 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} (retornados para nós AST de definição de função);

@item 
@code{feature_version=(3, N)} permite especificar uma versão anterior do Python 3. Por exemplo, @code{feature_version=(3, 4)} tratará @ref{732,,async} e @ref{1b9,,await} como palavras não reservadas.
@end itemize

(Contribuição de Guido van Rossum em bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}.)

@node asyncio<6>,builtins<2>,ast<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 asyncio}@anchor{9e1}
@subsubsection asyncio


@ref{47c,,asyncio.run()} passou da API provisória para a estável. Esta função pode ser usada para executar uma @ref{491,,corrotina} e retornar o resultado enquanto gerencia automaticamente o loop de eventos. Por exemplo:

@example
import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

asyncio.run(main())
@end example

Isso é `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

A implementação real é significativamente mais complexa. Assim, @ref{47c,,asyncio.run()} deve ser a maneira preferida de executar programas assíncronos.

(Contribuição de Yury Selivanov em bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}.)

A execução de @code{python -m asyncio} lança um REPL nativo assíncrono. Isso permite a experimentação rápida de código que possui um nível superior @ref{1b9,,await}. Não é mais necessário chamar diretamente @code{asyncio.run()}, o que geraria um novo loop de evento a cada chamada:

@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

(Contribuição de Yury Selivanov em bpo-37028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37028}.)

A exceção @ref{1b8,,asyncio.CancelledError} agora herda de @ref{5bb,,BaseException} em vez de @ref{9e2,,Exception} e não mais herda de @ref{9e3,,concurrent.futures.CancelledError}. (Contribuição de Yury Selivanov em bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}.)

No Windows, o loop de eventos padrão é agora @ref{609,,ProactorEventLoop}. (Contribuição de Victor Stinner em bpo-34687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34687}.)

@ref{609,,ProactorEventLoop} agora também tem suporte a UDP. (Contribuição de Adam Meily e Andrew Svetlov em bpo-29883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29883}.)

@ref{609,,ProactorEventLoop} pode agora ser interrompido por @ref{9d9,,KeyboardInterrupt} (“CTRL+C”). (Contribuição de Vladimir Matveev em bpo-23057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23057}.)

Adicionado @ref{9e4,,asyncio.Task.get_coro()} para obter a corrotina de dentro de um @ref{1be,,asyncio.Task}. (Contribuição de Alex Grönholm em bpo-36999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36999}.)

As tarefas de asyncio agora podem ser nomeadas, passando o argumento nomeado @code{name} para @ref{1bf,,asyncio.create_task()} ou o método de loop de evento @ref{1c0,,create_task()} ou chamando o método @ref{9e5,,set_name()} no objeto de tarefa. O nome da tarefa é visível na saída de @code{repr()} de @ref{1be,,asyncio.Task} e também pode ser recuperado usando o método @ref{9e6,,get_name()}. (Contribuição de Alex Grönholm em bpo-34270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34270}.)

Adicionado suporte a Happy Eyeballs@footnote{https://en.wikipedia.org/wiki/Happy_Eyeballs} para @ref{603,,asyncio.loop.create_connection()}. Para especificar o comportamento, dois novos parâmetros foram adicionados: `happy_eyeballs_delay' e `interleave'. O algoritmo Happy Eyeballs melhora a capacidade de resposta em aplicativos compatíveis com IPv4 e IPv6, tentando conectar-se simultaneamente usando os dois. (Contribuição de twisteroid ambassador em bpo-33530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33530}.)

@node builtins<2>,collections,asyncio<6>,Módulos melhorados<6>
@anchor{whatsnew/3 8 builtins}@anchor{9e7}
@subsubsection builtins


A função embutida @ref{192,,compile()} foi aprimorada para aceitar o sinalizador @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT}. Com esse novo sinalizador passado, @ref{192,,compile()} permitirá construções de nível superior @code{await}, @code{async for} e @code{async with} que geralmente são consideradas sintaxe inválida. O objeto de código assíncrono marcado com o sinalizador @code{CO_COROUTINE} pode ser retornado. (Contribuição de Matthias Bussonnier em bpo-34616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34616})

@node collections,cProfile,builtins<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 collections}@anchor{9e8}
@subsubsection collections


O método @ref{9e9,,_asdict()} para @ref{1ca,,collections.namedtuple()} agora retorna a @ref{256,,dict} em vez de um @ref{5db,,collections.OrderedDict}. Isso funciona porque os dict regulares garantem pedidos desde o Python 3.7. Se os recursos extras de @code{OrderedDict} forem necessários, a solução sugerida é converter o resultado no tipo desejado: @code{OrderedDict(nt._asdict())}. (Contribuição de Raymond Hettinger em bpo-35864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35864}.)

@node cProfile,csv<2>,collections,Módulos melhorados<6>
@anchor{whatsnew/3 8 cprofile}@anchor{9ea}
@subsubsection cProfile


A classe @ref{9eb,,cProfile.Profile} agora pode ser usada como um gerenciador de contexto. Perfile um bloco de código executando:

@example
import cProfile

with cProfile.Profile() as profiler:
      # código as ser analisada o desempenho
      ...
@end example

(Contribuição de Scott Sanderson em bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}.)

@node csv<2>,curses<3>,cProfile,Módulos melhorados<6>
@anchor{whatsnew/3 8 csv}@anchor{9ec}
@subsubsection csv


O @ref{9ed,,csv.DictReader} agora retorna instâncias de @ref{256,,dict} em vez de um @ref{5db,,collections.OrderedDict}. Agora, a ferramenta é mais rápida e utiliza menos memória enquanto preserva a ordem dos campos. (Contribuição de Michael Selik em bpo-34003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34003}.)

@node curses<3>,ctypes<2>,csv<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 curses}@anchor{9ee}
@subsubsection curses


Adicionada uma nova variável contendo informações de versão estruturada para a biblioteca ncurses subjacente: @ref{9ef,,ncurses_version}. (Contribuição de Serhiy Storchaka em bpo-31680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31680}.)

@node ctypes<2>,datetime<3>,curses<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 ctypes}@anchor{9f0}
@subsubsection ctypes


No Windows, @ref{9f1,,CDLL} e subclasses agora aceitam um parâmetro `winmode' para especificar sinalizadores para a chamada subjacente @code{LoadLibraryEx}. Os sinalizadores padrão são definidos para carregar apenas dependências da DLL em locais confiáveis, incluindo o caminho em que a DLL está armazenada (se um caminho completo ou parcial for usado para carregar a DLL inicial) e os caminhos adicionados por @ref{9f2,,add_dll_directory()} . (Contribuição de Steve Dower em bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

@node datetime<3>,functools<2>,ctypes<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 datetime}@anchor{9f3}
@subsubsection datetime


Adicionados novos construtores alternativos @ref{9f4,,datetime.date.fromisocalendar()} e @ref{9f5,,datetime.datetime.fromisocalendar()}, que constroem objetos de @ref{1cd,,date} e @ref{1cc,,datetime} respectivamente do ano ISO, número da semana e dia da semana; estes são o inverso do método @code{isocalendar} de cada classe. (Contribuição de Paul Ganssle em bpo-36004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36004}.)

@node functools<2>,gc<3>,datetime<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 functools}@anchor{9f6}
@subsubsection functools


@ref{9f7,,functools.lru_cache()} agora pode ser usado como um decorador direto, e não como uma função retornando um decorador. Portanto, agora ambos são suportados:

@example
@@lru_cache
def f(x):
    ...

@@lru_cache(maxsize=256)
def f(x):
    ...
@end example

(Contribuição de Raymond Hettinger em bpo-36772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36772}.)

Adicionado um novo decorador @ref{541,,functools.cached_property()}, para propriedades computadas armazenadas em cache durante toda a vida útil da instância.

@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

(Contribuição de Carl Meyer em bpo-21145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21145})

Adicionado um novo decorador @ref{9f8,,functools.singledispatchmethod()} que converte métodos em @ref{9f9,,funções genéricas} usando @ref{9fa,,despacho único}:

@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

(Contribuição de Ethan Smith em bpo-32380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32380})

@node gc<3>,gettext,functools<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 gc}@anchor{9fb}
@subsubsection gc


@ref{806,,get_objects()} agora pode receber um parâmetro opcional `generation' indicando uma geração da qual obter objetos. (Contribuição de Pablo Galindo em bpo-36016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36016}.)

@node gettext,gzip<3>,gc<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 gettext}@anchor{9fc}
@subsubsection gettext


Adicionado @ref{9fd,,pgettext()} e suas variantes. (Contribuição de Franz Glasner, Éric Araujo e Cheryl Sabella em bpo-2504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2504}.)

@node gzip<3>,IDLE e idlelib<4>,gettext,Módulos melhorados<6>
@anchor{whatsnew/3 8 gzip}@anchor{9fe}
@subsubsection gzip


Adicionado o parâmetro `mtime' em @ref{63e,,gzip.compress()} para saída reproduzível. (Contribuição de Guo Ci Teo em bpo-34898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34898}.)

A exceção @ref{9ff,,BadGzipFile} agora é levantada em vez de @ref{417,,OSError} para certos tipos de arquivos gzip inválidos ou corrompidos. (Contribuição de Filip Gruszczyński, Michele Orrù e Zackery Spytz em bpo-6584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6584}.)

@node IDLE e idlelib<4>,inspect<5>,gzip<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 idle-and-idlelib}@anchor{a00}
@subsubsection IDLE e idlelib


A saída em N linhas (50 por padrão) é compactada até um limite inferior. N pode ser alterado na seção PyShell da página General da caixa de diálogo Settings. Menos linhas, mas possivelmente extra longas, podem ser espremidas clicando com o botão direito do mouse na saída. A saída compactada pode ser expandida no local clicando duas vezes no botão ou na área de transferência ou em uma janela separada clicando com o botão direito do mouse. (Contribuição de Tal Einat em bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

Adiciona “Run Customized” ao menu Executar para executar um módulo com configurações personalizadas. Quaisquer argumentos de linha de comando inseridos são adicionados ao sys.argv. Eles também reaparecem na caixa para a próxima execução personalizada. Pode-se também suprimir a reinicialização normal do módulo principal do console. (Contribuição de Cheryl Sabella, Terry Jan Reedy e outros em bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} e bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}.)

Adicionados números de linha opcionais para janelas do editor IDLE. O Windows é aberto sem números de linha, a menos que definido de outra forma na guia General da caixa de diálogo de configuração. Os números de linha de uma janela existente são mostrados e ocultos no menu Opções. (Contribuição de Tal Einat e Saimadhav Heblikar em bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}.)

A codificação nativa do sistema operacional agora é usada para converter entre strings Python e objetos Tcl. Isso permite que o IDLE trabalhe com emoji e outros caracteres não BMP. Esses caracteres podem ser exibidos ou copiados e colados na ou da área de transferência. A conversão de strings de Tcl para Python e de volta agora nunca falha. (Muitas pessoas trabalharam nisso por oito anos, mas o problema foi finalmente resolvido por Serhiy Storchaka em bpo-13153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13153}.)

Novo em 3.8.1:

Adiciona a opção para ativar e desativar o piscar do cursor. (Contribuição de Zackery Spytz na bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603}.)

A tecla Escape agora fecha as janelas de conclusão IDLE. (Contribuição de Johnny Najera em bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}.)

As alterações acima foram suportadas para versões de manutenção 3.7.

Adiciona argumentos nomeados à lista de completamento de nome de módulo. (Contribuição de Terry J. Reedy em bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}.)

@node inspect<5>,io<3>,IDLE e idlelib<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 inspect}@anchor{a01}
@subsubsection inspect


A função @ref{a02,,inspect.getdoc()} agora pode encontrar docstrings para @code{__slots__} se esse atributo for @ref{256,,dict} onde os valores são docstrings. Isso fornece opções de documentação semelhantes às que já temos para @ref{194,,property()}, @ref{166,,classmethod()} e @ref{416,,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

(Contribuição de Raymond Hettinger em bpo-36326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36326}.)

@node io<3>,itertools<4>,inspect<5>,Módulos melhorados<6>
@anchor{whatsnew/3 8 io}@anchor{a03}
@subsubsection io


No modo de desenvolvimento (@ref{176,,-X} @code{env}) e na @ref{1f9,,compilação de depuração}, o finalizador @ref{1f5,,io.IOBase} agora registra a exceção se o método @code{close()} falhar. A exceção é ignorada silenciosamente por padrão na compilação de lançamento. (Contribuição de Victor Stinner em bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}.)

@node itertools<4>,json tool,io<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 itertools}@anchor{a04}
@subsubsection itertools


A função @ref{a05,,itertools.accumulate()} adicionou uma opção de argumento nomeado `initial' para especificar um valor inicial:

@example
>>> from itertools import accumulate
>>> list(accumulate([10, 5, 30, 15], initial=1000))
[1000, 1010, 1015, 1045, 1060]
@end example

(Contribuído por Lisa Roach em bpo-34659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34659}.)

@node json tool,logging<2>,itertools<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 json-tool}@anchor{a06}
@subsubsection json.tool


Adiciona a opção @code{--json-lines} para analisar cada linha de entrada como um objeto JSON separado. (Contribuição de Weipeng Hong em bpo-31553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31553}.)

@node logging<2>,math<5>,json tool,Módulos melhorados<6>
@anchor{whatsnew/3 8 logging}@anchor{a07}
@subsubsection logging


Adicionado um argumento nomeado `force' a @ref{a08,,logging.basicConfig()}. Quando definido como true, qualquer manipulador existente anexado ao logger raiz é removido e fechado antes de executar a configuração especificada pelos outros argumentos.

Isso resolve um problema de longa data. Depois que um logger ou `basicConfig()' foi chamado, as chamadas subsequentes para `basicConfig()' foram ignoradas silenciosamente. Isso dificultava a atualização, a experimentação ou o ensino das várias opções de configuração de log usando o prompt interativo ou um bloco de notas de Jupyter.

(Sugestão de Raymond Hettinger, implementação de Dong-hee Na e revisão de Vinay Sajip em bpo-33897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33897}.)

@node math<5>,mmap<2>,logging<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 math}@anchor{a09}
@subsubsection math


Adicionada nova função @ref{a0a,,math.dist()} para calcular a distância euclidiana entre dois pontos. (Contribuição de Raymond Hettinger em bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}.)

Expandida a função @ref{a0b,,math.hypot()} para manipular várias dimensões. Anteriormente, suportava apenas o caso 2-D. (Contribuição de Raymond Hettinger em bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}.)

Adicionada nova função, @ref{a0c,,math.prod()}, como função análoga a @ref{46a,,sum()} que retorna o produto de um valor ‘start’ (padrão: 1) vezes uma iterável de números:

@example
>>> prior = 0.8
>>> likelihoods = [0.625, 0.84, 0.30]
>>> math.prod(likelihoods, start=prior)
0.126
@end example

(Contribuição de Pablo Galindo em bpo-35606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35606}.)

Adicionadas duas novas funções combinatórias @ref{6d1,,math.perm()} e @ref{6d0,,math.comb()}:

@example
>>> math.perm(10, 3)    # Permutações de 10 coisas, 3 por vez
720
>>> math.comb(10, 3)    # Combinações de 10 coisas, 3 por vez
120
@end example

(Contribuição de Yash Aggarwal, Keller Fuchs, Serhiy Storchaka e Raymond Hettinger em bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}, bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178} e bpo-35431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35431}.)

Adicionada uma nova função @ref{a0d,,math.isqrt()} para calcular raízes quadradas inteiras precisas sem conversão para ponto flutuante. A nova função suporta números inteiros arbitrariamente grandes. É mais rápido que @code{floor(sqrt(n))}, mas mais lento que @ref{a0e,,math.sqrt()}:

@example
>>> r = 650320427
>>> s = r ** 2
>>> isqrt(s - 1)         # correto
650320426
>>> floor(sqrt(s - 1))   # incorreto
650320427
@end example

(Contribuição de Mark Dickinson em bpo-36887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36887}.)

A função @ref{94e,,math.factorial()} não aceita mais argumentos que não são parecidos com int. (Contribuição de Pablo Galindo em bpo-33083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33083}.)

@node mmap<2>,multiprocessing<3>,math<5>,Módulos melhorados<6>
@anchor{whatsnew/3 8 mmap}@anchor{a0f}
@subsubsection mmap


A classe @ref{20b,,mmap.mmap} agora possui o método @ref{a10,,madvise()} para acessar a chamada do sistema @code{madvise()}. (Contribuição de Zackery Spytz em bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941}.)

@node multiprocessing<3>,os<6>,mmap<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 multiprocessing}@anchor{a11}
@subsubsection multiprocessing


Adicionado novo módulo @ref{99,,multiprocessing.shared_memory}. (Contribuição de Davin Potts em bpo-35813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35813}.)

No macOS, o método inicial `spawn' agora é usado por padrão. (Contribuição de Victor Stinner em bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.)

@node os<6>,os path<5>,multiprocessing<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 os}@anchor{a12}
@subsubsection os


Adicionada nova função @ref{9f2,,add_dll_directory()} no Windows para fornecer caminhos de pesquisa adicionais para dependências nativas ao importar módulos de extensão ou carregar DLLs usando @ref{2a,,ctypes}. (Contribuição de Steve Dower em bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

Uma nova função @ref{a13,,os.memfd_create()} foi adicionada para envolver a chamada de sistema @code{memfd_create()}. (Contribuição de Zackery Spytz e Christian Heimes em bpo-26836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26836}.)

No Windows, grande parte da lógica manual para lidar com pontos de nova análise (incluindo links simbólicos e junções de diretórios) foi delegada ao sistema operacional. Especificamente, @ref{4a0,,os.stat()} agora percorrerá qualquer objeto suportado pelo sistema operacional, enquanto @ref{4a1,,os.lstat()} abrirá apenas pontos de nova análise que se identifiquem como “substitutos de nome”, enquanto outros serão abertos como para @ref{4a0,,os.stat()}. Em todos os casos, @ref{a14,,os.stat_result.st_mode} terá @code{S_IFLNK} definido apenas para links simbólicos e não para outros tipos de pontos de nova análise. Para identificar outros tipos de pontos de nova análise, verifique o novo atributo @ref{a15,,os.stat_result.st_reparse_tag}.

No Windows, @ref{926,,os.readlink()} agora pode ler junções de diretório. Observe que @ref{a16,,islink()} retornará @code{False} para junções de diretório e, portanto, o código que verifica primeiro @code{islink} continuará tratando junções como diretórios, enquanto o código que lida com erros de @ref{926,,os.readlink()} agora pode tratar junções como links.

(Contribuição de Steve Dower em bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node os path<5>,pathlib<7>,os<6>,Módulos melhorados<6>
@anchor{whatsnew/3 8 os-path}@anchor{a17}
@subsubsection os.path


Funções de @ref{a2,,os.path} que retornam um resultado booleano como @ref{a18,,exists()}, @ref{a19,,lexists()}, @ref{a1a,,isdir()}, @ref{a1b,,isfile()}, @ref{a16,,islink()} e @ref{a1c,,ismount()} agora retornam @code{False} em vez de levantar @ref{202,,ValueError} ou suas subclasses @ref{677,,UnicodeEncodeError} e @ref{a1d,,UnicodeDecodeError} para caminhos que contêm caracteres ou bytes não representáveis no nível do SO. (Contribuição de Serhiy Storchaka em bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}.)

@ref{a1e,,expanduser()} no Windows agora prefere a variável de ambiente 
@geindex USERPROFILE
@geindex variável de ambiente; USERPROFILE
@code{USERPROFILE} e não usa 
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME}, que normalmente não é definido para contas de usuário comuns. (Contribuição de Anthony Sottile em bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}.)

@ref{a1a,,isdir()} no Windows não retorna mais @code{True} para um link para um diretório inexistente.

@ref{225,,realpath()} no Windows agora resolve pontos de nova análise, incluindo links simbólicos e junções de diretório.

(Contribuição de Steve Dower em bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node pathlib<7>,pickle,os path<5>,Módulos melhorados<6>
@anchor{whatsnew/3 8 pathlib}@anchor{a1f}
@subsubsection pathlib


Os métodos @ref{229,,pathlib.Path} que retornam um resultado booleano como @ref{a20,,exists()}, @ref{230,,is_dir()}, @ref{22f,,is_file()}, @ref{a21,,is_mount()}, @ref{a22,,is_symlink()}, @ref{a23,,is_block_device()}, @ref{a24,,is_char_device()}, @ref{a25,,is_fifo()}, @ref{a26,,is_socket()} agora retornam @code{False} em vez de levantar @ref{202,,ValueError} ou sua subclasse @ref{677,,UnicodeEncodeError} para caminhos que contêm caracteres não representáveis no nível do sistema operacional. (Contribuição de Serhiy Storchaka em bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}.)

Adicionado @code{pathlib.Path.link_to()} que cria um link físico apontando para um caminho. (Contribuição de Joannah Nanjekye em bpo-26978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26978}) Observe que @code{link_to} foi descontinuado na versão 3.10 e removido na versão 3.12 em favor de um método @code{hardlink_to} adicionado na versão 3.10 que corresponde à semântica do método @code{symlink_to} existente.

@node pickle,plistlib,pathlib<7>,Módulos melhorados<6>
@anchor{whatsnew/3 8 pickle}@anchor{a27}
@subsubsection pickle


Extensões de @ref{a6,,pickle}, que atuem como subclasse da classe otimizada para C @ref{a28,,Pickler}, agora podem substituir a lógica de “pickling” de funções e classes definindo o método especial @ref{a29,,reducer_override()}. (Contribuição de Pierre Glaser e Olivier Grisel em bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}.)

@node plistlib,pprint<3>,pickle,Módulos melhorados<6>
@anchor{whatsnew/3 8 plistlib}@anchor{a2a}
@subsubsection plistlib


Adicionado novo @ref{a2b,,plistlib.UID} e habilitado suporte para leitura e escrita de plists binárias codificadas em NSKeyedArchiver. (Contribuição de Jon Janzen em bpo-26707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26707}.)

@node pprint<3>,py_compile<2>,plistlib,Módulos melhorados<6>
@anchor{whatsnew/3 8 pprint}@anchor{a2c}
@subsubsection pprint


O módulo @ref{ae,,pprint} adicionou um parâmetro `sort_dicts' a várias funções. Por padrão, essas funções continuam a classificar dicionários antes da renderização ou impressão. No entanto, se `sort_dicts' estiver definido como false, os dicionários manterão a ordem em que as chaves foram inseridas. Isso pode ser útil para comparação com entradas JSON durante a depuração.

Além disso, existe uma nova função de conveniência, @ref{a2d,,pprint.pp()}, que é como @ref{82b,,pprint.pprint()}, mas com `sort_dicts' padronizando como @code{False}:

@example
>>> from pprint import pprint, pp
>>> d = dict(source='input.txt', operation='filter', destination='output.txt')
>>> pp(d, width=40)                  # Ordem original
@{'source': 'input.txt',
 'operation': 'filter',
 'destination': 'output.txt'@}
>>> pprint(d, width=40)              # Chaves ordenadas alfabeticamente
@{'destination': 'output.txt',
 'operation': 'filter',
 'source': 'input.txt'@}
@end example

(Contribuição de Rémi Lapeyre em bpo-30670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30670}.)

@node py_compile<2>,shlex,pprint<3>,Módulos melhorados<6>
@anchor{whatsnew/3 8 py-compile}@anchor{a2e}
@subsubsection py_compile


@ref{a2f,,py_compile.compile()} agora possui suporte a um modo silencioso. (Contribuição de Joannah Nanjekye em bpo-22640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22640}.)

@node shlex,shutil<4>,py_compile<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 shlex}@anchor{a30}
@subsubsection shlex


A nova função @ref{a31,,shlex.join()} atua como o inverso da @ref{53c,,shlex.split()}. (Contribuição de Bo Bayles em bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}.)

@node shutil<4>,socket<4>,shlex,Módulos melhorados<6>
@anchor{whatsnew/3 8 shutil}@anchor{a32}
@subsubsection shutil


@ref{a33,,shutil.copytree()} agora aceita um novo argumento nomeado @code{dirs_exist_ok}. (Contribuição de Josh Bronson em bpo-20849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20849}.)

@ref{4b3,,shutil.make_archive()} agora tem como padrão o formato pax moderno (POSIX.1-2001) de novos arquivos para melhorar a portabilidade e a conformidade com os padrões, herdados da alteração correspondente no módulo @ref{de,,tarfile}. (Contribuição de C.A.M. Gerlach em bpo-30661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30661}.)

@ref{301,,shutil.rmtree()} no Windows agora remove junções de diretórios sem remover recursivamente o conteúdo primeiro. (Contribuição de Steve Dower em bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}.)

@node socket<4>,ssl<4>,shutil<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 socket}@anchor{a34}
@subsubsection socket


Adicionadas as funções de conveniência @ref{a35,,create_server()} e @ref{a36,,has_dualstack_ipv6()} para automatizar as tarefas necessárias geralmente envolvidas na criação de um soquete de servidor, incluindo a aceitação de conexões IPv4 e IPv6 no mesmo soquete. (Contribuição de Giampaolo Rodolà em bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561}.)

As funções @ref{a37,,socket.if_nameindex()}, @ref{a38,,socket.if_nametoindex()} e @ref{a39,,socket.if_indextoname()} foram agora implementadas no Windows. (Contribuição de Zackery Spytz em bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007}.)

@node ssl<4>,statistics<4>,socket<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 ssl}@anchor{a3a}
@subsubsection ssl


Adicionado @ref{a3b,,post_handshake_auth} para ativar e @ref{a3c,,verify_client_post_handshake()} para iniciar a autenticação pós-handshake do TLS 1.3. (Contribuição de Christian Heimes em bpo-34670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34670}.)

@node statistics<4>,sys<7>,ssl<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 statistics}@anchor{a3d}
@subsubsection statistics


Adicionada @ref{a3e,,statistics.fmean()} como uma variante de ponto flutuante mais rápida de @ref{6d2,,statistics.mean()}. (Contribuição de Raymond Hettinger e Steven D’Aprano em bpo-35904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35904}.)

Adicionada @ref{a3f,,statistics.geometric_mean()} (Contribuição de Raymond Hettinger em bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}.

Adicionada @code{Statistics.multimode()} que retorna uma lista dos valores mais comuns. (Contribuição de Raymond Hettinger em bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892}.)

Adicionada @ref{a40,,statistics.quantiles()} que divide dados ou uma distribuição em intervalos equivalentes (por exemplo, quartis, decis ou percentis). (Contribuição de Raymond Hettinger em bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}.)

Adicionada @ref{a41,,statistics.NormalDist}, uma ferramenta para criar e manipular distribuições normais de uma variável aleatória. (Contribuição de Raymond Hettinger em 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 de ser manos de 3 graus
0.3184678262814532
>>> # Chance relativa de ser 7 graus contra 10 graus
>>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1.2039930378537762

>>> el_niño = NormalDist(4, 2.5)
>>> temperature_feb += el_niño        # Adiciona em um efeito do clima
>>> temperature_feb
NormalDist(mu=10.0, sigma=6.830080526611674)

>>> temperature_feb * (9/5) + 32      # Converte para Fahrenheit
NormalDist(mu=50.0, sigma=12.294144947901014)
>>> temperature_feb.samples(3)        # Gera amostras aleatórias
[7.672102882379219, 12.000027119750287, 4.647488369766392]
@end example

@node sys<7>,tarfile<5>,statistics<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 sys}@anchor{a42}
@subsubsection sys


Adiciona uma nova função @ref{1f7,,sys.unraisablehook()}, que pode ser substituída para controlar como as “exceções não passíveis de levantamento” são tratadas. É chamada quando uma exceção ocorre, mas não há como o Python manipulá-la. Por exemplo, quando um destruidor gera uma exceção ou durante a coleta de lixo (@ref{a43,,gc.collect()}). (Contribuição de Victor Stinner em bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}.)

@node tarfile<5>,threading<4>,sys<7>,Módulos melhorados<6>
@anchor{whatsnew/3 8 tarfile}@anchor{a44}
@subsubsection tarfile


O módulo @ref{de,,tarfile} agora tem como padrão o formato pax moderno (POSIX.1-2001) para novos arquivos, em vez do anterior específico do GNU. Isso melhora a portabilidade de plataforma cruzada com uma codificação consistente (UTF-8) em um formato padronizado e extensível e oferece vários outros benefícios. (Contribuição de C.A.M. Gerlach em bpo-36268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36268}.)

@node threading<4>,tokenize<2>,tarfile<5>,Módulos melhorados<6>
@anchor{whatsnew/3 8 threading}@anchor{a45}
@subsubsection threading


Adiciona uma nova função @ref{84e,,threading.excepthook()} que manipula a exceção não capturada @ref{a46,,threading.Thread.run()}. Pode ser substituída para controlar como exceções não capturadas @ref{a46,,threading.Thread.run()} são manipuladas. (Contribuição de Victor Stinner em bpo-1230540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1230540}.)

Adiciona uma nova função @ref{a47,,threading.get_native_id()} e um atributo @ref{a48,,native_id} à classe @ref{953,,threading.Thread}. Eles retornam o Thread ID integral nativo do thread atual atribuído pelo kernel. Este recurso está disponível apenas em determinadas plataformas, consulte @ref{a47,,get_native_id} para mais informações. (Contribuição de Jake Tesler em bpo-36084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36084}.)

@node tokenize<2>,tkinter<4>,threading<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 tokenize}@anchor{a49}
@subsubsection tokenize


O módulo @ref{fb,,tokenize} agora emite implicitamente um token @code{NEWLINE} quando fornecido com entrada que não possui uma nova linha à direita. Esse comportamento agora corresponde ao que o tokenizador do C faz internamente. (Contribuição de Ammar Askar em bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node tkinter<4>,time<4>,tokenize<2>,Módulos melhorados<6>
@anchor{whatsnew/3 8 tkinter}@anchor{a4a}
@subsubsection tkinter


Adicionados os métodos @code{selection_from()}, @code{selection_present()}, @code{selection_range()} e @code{selection_to()} na classe @code{tkinter.Spinbox}. (Contribuição de Juliette Monsel em bpo-34829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34829}.)

Adicionado o método @code{moveto()} na classe @code{tkinter.Canvas}. (Contribuição de Juliette Monsel em bpo-23831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23831}.)

A classe @code{tkinter.PhotoImage} agora possui os métodos @code{transparency_get()} e @code{transparency_set()}. (Contribuição de Zackery Spytz em bpo-25451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25451}.)

@node time<4>,typing<8>,tkinter<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 time}@anchor{a4b}
@subsubsection time


Adiciona o novo relógio @ref{a4c,,CLOCK_UPTIME_RAW} ao macOS 10.12. (Contribuição de Joannah Nanjekye em bpo-35702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35702}.)

@node typing<8>,unicodedata<5>,time<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 typing}@anchor{a4d}
@subsubsection typing


O módulo @ref{104,,typing} incorpora vários novos recursos:


@itemize *

@item 
Um tipo de dicionário com tipos por chave. Veja 
@geindex Propostas de Melhorias do Python; PEP 589
PEP 589@footnote{https://peps.python.org/pep-0589/} e @ref{162,,typing.TypedDict}. TypedDict usa apenas chaves de strings. Por padrão, é necessário que todas as chaves estejam presentes. Especifique “total=False” para permitir que as chaves sejam opcionais:

@example
class Location(TypedDict, total=False):
    lat_long: tuple
    grid_square: str
    xy_coordinate: tuple
@end example

@item 
Tipos literais. Veja 
@geindex Propostas de Melhorias do Python; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} e @ref{858,,typing.Literal}. Tipos literais indicam que um parâmetro ou valor de retorno está restrito a um ou mais valores literais específicos:

@example
def get_status(port: int) -> Literal['connected', 'disconnected']:
    ...
@end example

@item 
Variáveis, funções, métodos e classes “finais”. Veja 
@geindex Propostas de Melhorias do Python; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/}, @ref{267,,typing.Final} e @ref{6ad,,typing.final()}. O qualificador final instrui um verificador de tipo estático a restringir criação de subclasse, substituição ou reatribuição:

@example
pi: Final[float] = 3.1415926536
@end example

@item 
Definições de protocolo. Veja 
@geindex Propostas de Melhorias do Python; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/}, @ref{264,,typing.Protocol} e @ref{443,,typing.runtime_checkable()}. ABCs simples como @ref{a4e,,typing.SupportsInt} agora são subclasses de @code{Protocol}.

@item 
Nova classe de protocolo @ref{a4f,,typing.SupportsIndex}.

@item 
Novas funções @ref{2ec,,typing.get_origin()} e @ref{2ed,,typing.get_args()}.
@end itemize

@node unicodedata<5>,unittest<6>,typing<8>,Módulos melhorados<6>
@anchor{whatsnew/3 8 unicodedata}@anchor{a50}
@subsubsection unicodedata


O módulo @ref{105,,unicodedata} agora foi atualizado para usar o Unicode 12.1.0@footnote{https://blog.unicode.org/2019/05/unicode-12-1-en.html}.

A nova função @ref{a51,,is_normalized()} pode ser usada para verificar se uma string está em uma forma normal específica, geralmente muito mais rápida do que normalizar a string. (Contribuição de Max Belanger, David Euresti e Greg Price em bpo-32285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32285} e bpo-37966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37966}).

@node unittest<6>,venv<4>,unicodedata<5>,Módulos melhorados<6>
@anchor{whatsnew/3 8 unittest}@anchor{a52}
@subsubsection unittest


Adicionada @ref{a53,,AsyncMock} para dar suporte a uma versão assíncrona de @ref{a54,,Mock}. Também foram adicionadas novas funções apropriadas para teste. (Contribuição de Lisa Roach em bpo-26467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26467}).

Adicionados @ref{a55,,addModuleCleanup()} e @ref{a56,,addClassCleanup()} a unittest para dar suporte a limpezas para @ref{a57,,setUpModule()} e @ref{a58,,setUpClass()}. (Contribuição de Lisa Roach em bpo-24412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24412}.)

Várias funções de declaração de mock agora também exibem uma lista de chamadas reais em caso de falha. (Contribuição de Petter Strandmark em bpo-35047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35047}.)

O módulo @ref{106,,unittest} ganhou suporte a corrotinas a serem usadas como casos de teste com @ref{30c,,unittest.IsolatedAsyncioTestCase}. (Contribuição de Andrew Svetlov em bpo-32972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32972}.)

Exemplo:

@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<6>,Módulos melhorados<6>
@anchor{whatsnew/3 8 venv}@anchor{a59}
@subsubsection venv


@ref{111,,venv} agora inclui um script @code{Activate.ps1} em todas as plataformas para ativar ambientes virtuais no PowerShell Core 6.1. (Contribuição de Brett Cannon em bpo-32718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32718}.)

@node weakref,xml<4>,venv<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 weakref}@anchor{a5a}
@subsubsection weakref


Os objetos proxy retornados por @ref{a5b,,weakref.proxy()} agora possuem suporte aos operadores de multiplicação de matrizes @code{@@} e @code{@@=} além dos outros operadores numéricos. (Contribuição de Mark Dickinson em bpo-36669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36669}.)

@node xml<4>,xmlrpc,weakref,Módulos melhorados<6>
@anchor{whatsnew/3 8 xml}@anchor{a5c}
@subsubsection xml


Como atenuação a DTD e recuperação de entidade externa, os módulos @ref{122,,xml.dom.minidom} e @ref{129,,xml.sax} não processam mais entidades externas por padrão. (Contribuição de Christian Heimes em bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}.)

Os métodos @code{.find*()} no módulo @ref{125,,xml.etree.ElementTree} possuem suporte a pesquisas curinga como @code{@{*@}tag}, que ignora o espaço para nome e @code{@{namespace@}*}, que retorna todas as tags no espaço para nome especificado. (Contribuição de Stefan Behnel em bpo-28238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28238}.)

O módulo @ref{125,,xml.etree.ElementTree} fornece uma nova função @ref{a5d,,canonicalize()} que implementa C14N 2.0. (Contribuição de Stefan Behnel em bpo-13611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13611}.)

O objeto de destino de @ref{a5e,,xml.etree.ElementTree.XMLParser} pode receber eventos de declaração de espaço de nomes através dos novos métodos de retorno de chamada @code{start_ns()} e @code{end_ns ()}. Além disso, o destino @ref{a5f,,xml.etree.ElementTree.TreeBuilder} pode ser configurado para processar eventos sobre comentários e instruções de processamento para incluí-los na árvore gerada. (Contribuição de Stefan Behnel em bpo-36676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36676} e bpo-36673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36673}.)

@node xmlrpc,,xml<4>,Módulos melhorados<6>
@anchor{whatsnew/3 8 xmlrpc}@anchor{a60}
@subsubsection xmlrpc


@ref{a61,,xmlrpc.client.ServerProxy} agora possui suporte a um argumento nomeado `headers' opcional para que uma sequência de cabeçalhos HTTP seja enviada a cada solicitação. Entre outras coisas, isso possibilita a atualização da autenticação básica padrão para uma autenticação de sessão mais rápida. (Contribuição de Cédric Krier em bpo-35153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35153}.)

@node Otimizações<6>,Mudanças a construções e API C,Módulos melhorados<6>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 optimizations}@anchor{a62}
@subsection Otimizações



@itemize *

@item 
O módulo @ref{d6,,subprocess} agora pode usar a função @ref{220,,os.posix_spawn()} em alguns casos para obter melhor desempenho. Atualmente, ele é usado apenas no macOS e Linux (usando glibc 2.24 ou mais recente) se todas essas condições forem atendidas:


@itemize *

@item 
`close_fds' ser false;

@item 
os parâmetros `preexec_fn', `pass_fds', `cwd' and `start_new_session' não estarem definidos;

@item 
o caminho `executable' conter um diretório.
@end itemize

(Contribuição de Joannah Nanjekye e Victor Stinner em bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}.)

@item 
@ref{a63,,shutil.copyfile()}, @ref{a64,,shutil.copy()}, @ref{a65,,shutil.copy2()}, @ref{a33,,shutil.copytree()} e @ref{a33,,shutil.copytree()} usam chamadas de sistema “fast-copy” específicas da plataforma no Linux e no macOS para copiar o arquivo com mais eficiência. “fast-copy” significa que a operação de cópia ocorre dentro do kernel, evitando o uso de buffers de espaço do usuário no Python como em “@code{outfd.write(infd.read())}”. No Windows, @ref{a63,,shutil.copyfile()} usa um buffer padrão com tamanho maior (1 MiB em vez de 16 KiB) e é usada uma variante de @ref{a66,,shutil.copyfileobj()} baseada em @ref{2eb,,memoryview()}. A velocidade de cópia de um arquivo 512 MiB na mesma partição é de aproximadamente +26% no Linux, +50% no macOS e +40% no Windows. Além disso, muito menos ciclos de CPU são consumidos. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}. (Contribuição de Giampaolo Rodolà em bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}.)

@item 
@ref{a33,,shutil.copytree()} usa a função @ref{a68,,os.scandir()} e todas as funções de cópia que dependem dela usam valores em cache de @ref{4a0,,os.stat()}. A velocidade para copiar um diretório com 8000 arquivos é de cerca de +9% no Linux, +20% no Windows e +30% em um compartilhamento SMB do Windows. Além disso, o número de chamadas de sistema @ref{4a0,,os.stat()} é reduzido em 38%, tornando @ref{a33,,shutil.copytree()} especialmente mais rápida em sistemas de arquivos em rede. (Contribuição de Giampaolo Rodolà em bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695}.)

@item 
O protocolo padrão no módulo @ref{a6,,pickle} agora é o Protocolo 4, introduzido pela primeira vez no Python 3.4. Ele oferece melhor desempenho e tamanho menor em comparação com o Protocolo 3 disponível desde o Python 3.0.

@item 
Removido um membro @ref{a69,,Py_ssize_t} de @code{PyGC_Head}. O tamanho de todos os objetos rastreados pelo coletor de lixo (por exemplo, tupla, lista, ditado) é reduzido em 4 ou 8 bytes. (Contribuição de Inada Naoki em bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}.)

@item 
@ref{a6a,,uuid.UUID} agora usa @code{__slots__} para reduzir seu uso de espaço de memória. (Contribuição de Wouter Bolsterlee e Tal Einat em bpo-30977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30977})

@item 
Melhor desempenho de @ref{a6b,,operator.itemgetter()} em 33%. Manipulação de argumento otimizada e incluído um caminho rápido para o caso comum de um único índice inteiro não negativo em uma tupla (que é o caso de uso típico na biblioteca padrão). (Contribuição de Raymond Hettinger em bpo-35664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35664}.)

@item 
Pesquisas de campo aceleradas em @ref{1ca,,collections.namedtuple()}. Agora elas são duas vezes mais rápidas, tornando-as a forma mais rápida de pesquisa de variáveis de instância no Python. (Contribuição de Raymond Hettinger, Pablo Galindo e Joe Jevnik, Serhiy Storchaka em bpo-32492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32492}.)

@item 
O construtor @ref{611,,list} não atribui globalmente o buffer interno do item se a entrada iterável tiver um comprimento conhecido (a entrada implementa @code{__len__}). Isso torna a lista criada 12% menor em média. (Contribuição de Raymond Hettinger e Pablo Galindo em bpo-33234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33234}.)

@item 
Duplicada a velocidade de gravação de variável de classe. Quando um atributo não-dunder era atualizado, havia uma chamada desnecessária para atualizar os slots. (Contribuição de Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger, Neil Schemenauer e Serhiy Storchaka em bpo-36012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36012}.)

@item 
Reduzida a sobrecarga dos argumentos de conversão passados para muitas funções e métodos internos. Isso acelerou chamando algumas funções e métodos internos simples de 20–50%. (Contribuição de Serhiy Storchaka em bpo-23867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23867}, bpo-35582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35582} e bpo-36127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36127}.)

@item 
A instrução @code{LOAD_GLOBAL} agora usa o novo mecanismo “por cache de código de operação”. É cerca de 40% mais rápido agora. (Contribuição de Yury Selivanov e Inada Naoki em :issue: @cite{26219}.)
@end itemize

@node Mudanças a construções e API C,Descontinuados<8>,Otimizações<6>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 build-and-c-api-changes}@anchor{a6c}
@subsection Mudanças a construções e API C



@itemize *

@item 
O @ref{a6d,,sys.abiflags} padrão se tornou uma string vazia: o sinalizador @code{m} para pymalloc se tornou inútil (compilações com e sem pymalloc são compatíveis com ABI) e, portanto, foi removido. (Contribuição de Victor Stinner em bpo-36707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36707}.)

Exemplos de alterações:


@itemize *

@item 
Somente o programa @code{python3.8} é instalado, o programa @code{python3.8m} se foi.

@item 
Somente o script @code{python3.8-config} é instalado, o programa @code{python3.8m-config} se foi.

@item 
O sinalizador @code{m} foi removido do sufixo dos nomes de arquivos da biblioteca dinâmica: módulos de extensão na biblioteca padrão, bem como daqueles produzidos e instalados por pacotes de terceiros, como os baixados do PyPI. No Linux, por exemplo, o sufixo de @code{.cpython-37m-x86_64-linux-gnu.so} do Python 3.7 se tornou @code{.cpython-38-x86_64-linux-gnu.so} no Python 3.8.
@end itemize

@item 
Os arquivos de cabeçalho foram reorganizados para separar melhor os diferentes tipos de APIs:


@itemize *

@item 
@code{Include/*.h} deve ser a API C pública estável e portátil.

@item 
@code{Include/cpython/*.h} deve ser a API C instável específica do CPython; API pública, com alguma API privada prefixada por @code{_Py} ou @code{_PY}.

@item 
@code{Include/internal/*.h} é a API C interna privada muito específica do CPython. Essa API é fornecida sem garantia de compatibilidade com versões anteriores e não deve ser usada fora do CPython. Ele é exposto apenas a necessidades muito específicas, como depuradores e perfis, que precisam acessar os componentes internos do CPython sem chamar funções. Esta API agora está instalada por @code{make install}.
@end itemize

(Contribuição de Victor Stinner em bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} e bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}, trabalho iniciado por Eric Snow em Python 3.7.)

@item 
Algumas macros foram convertidas em funções in-line estáticas: os tipos de parâmetros e o tipo de retorno são bem definidos, eles não têm problemas específicos para as macros, as variáveis têm escopos locais. Exemplos:


@itemize *

@item 
@ref{56e,,Py_INCREF()}, @ref{56f,,Py_DECREF()}

@item 
@ref{a6e,,Py_XINCREF()}, @ref{78f,,Py_XDECREF()}

@item 
@code{PyObject_INIT}, @code{PyObject_INIT_VAR}

@item 
Funções privadas: @code{_PyObject_GC_TRACK()}, @code{_PyObject_GC_UNTRACK()}, @code{_Py_Dealloc()}
@end itemize

(Contribuição de Victor Stinner em bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}.)

@item 
As funções @code{PyByteArray_Init()} e @code{PyByteArray_Fini()} foram removidas. Elas não faziam nada desde o Python 2.7.4 e o Python 3.2.0, foram excluídas da API limitada (ABI estável) e não foram documentados. (Contribuição de Victor Stinner em bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}.)

@item 
O resultado de @ref{a6f,,PyExceptionClass_Name()} agora é do tipo @code{const char *} em vez de @code{char *}. (Contribuição de Serhiy Storchaka em bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818}.)

@item 
A dualidade de @code{Modules/Setup.dist} e @code{Modules/Setup} foi removida. Anteriormente, ao atualizar a árvore de fontes do CPython, era necessário copiar manualmente @code{Modules/Setup.dist} (dentro da árvore de fontes) para @code{Modules/Setup} (dentro da árvore de compilação), a fim de refletir todas as alterações upstream. Isso foi um pequeno benefício para os empacotadores, à custa de um aborrecimento frequente para os desenvolvedores após o desenvolvimento do CPython, pois esquecer de copiar o arquivo pode causar falhas na compilação.

Agora, o sistema de compilação sempre lê @code{Modules/Setup} dentro da árvore de fontes. As pessoas que desejam personalizar esse arquivo são incentivadas a manter suas alterações em um fork do git do CPython ou como arquivos de patch, como faria em qualquer outra alteração na árvore de fontes.

(Contribuição de Antoine Pitrou em bpo-32430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32430}.)

@item 
Funções que convertem um número Python em número inteiro C, como @ref{360,,PyLong_AsLong()}, e funções de análise de argumentos, como @ref{571,,PyArg_ParseTuple()}, com unidades de formato de conversão de números inteiros, como @code{'i'}, agora usarão o método especial @ref{71d,,__index__()} em vez de @ref{71c,,__int__()}, se disponível. O aviso de descontinuação será emitido para objetos com o método @code{__int__()}, mas sem o método @code{__index__()} (como @ref{29d,,Decimal} e @ref{1e7,,Fraction} ). @ref{a70,,PyNumber_Check()} agora retornará @code{1} para objetos implementando @code{__index__()}. @ref{a71,,PyNumber_Long()}, @ref{a72,,PyNumber_Float()} e @ref{a73,,PyFloat_AsDouble()} agora também usam o método @code{__index__()}, se disponível. (Contribuição de Serhiy Storchaka em bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048} e bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}.)

@item 
Objetos de tipo alocado a heap agora aumentarão sua contagem de referências em @ref{a74,,PyObject_Init()} (e sua macro paralela @code{PyObject_INIT}) em vez de em @ref{a75,,PyType_GenericAlloc()}. Os tipos que modificam a alocação ou desalocação de instância podem precisar ser ajustados. (Contribuição de Eddie Elizondo em bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}.)

@item 
A nova função @code{PyCode_NewWithPosOnlyArgs()} permite criar objetos de código como @code{PyCode_New()}, mas com um parâmetro extra `posonlyargcount' para indicar o número de argumentos somente posicionais. (Contribuição de Pablo Galindo em bpo-37221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37221}.)

@item 
@code{Py_SetPath()} agora define @ref{3b8,,sys.executable} para o caminho completo do programa (@ref{3b7,,Py_GetProgramFullPath()}) em vez do nome do programa (@ref{3b9,,Py_GetProgramName()}). (Contribuição de Victor Stinner em bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}.)
@end itemize

@node Descontinuados<8>,Remoção de APIs e recursos,Mudanças a construções e API C,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 deprecated}@anchor{a76}
@subsection Descontinuados



@itemize *

@item 
O comando distutils @code{bdist_wininst} agora está descontinuado; use @code{bdist_wheel} (pacotes wheel). (Contribuição de Victor Stinner em bpo-37481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37481}.)

@item 
Os métodos descontinuados @code{getchildren()} e @code{getiterator()} no módulo @ref{125,,ElementTree} agora emitem um @ref{1a5,,DeprecationWarning} em vez de @ref{8ce,,PendingDeprecationWarning}. Eles serão removidos no Python 3.9. (Contribuição de Serhiy Storchaka em bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Passar um objeto que não é uma instância de @ref{742,,concurrent.futures.ThreadPoolExecutor} para @ref{743,,loop.set_default_executor()} foi descontinuado e será proibido no Python 3.9. (Contribuição de Elvis Pranskevichus em bpo-34075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34075}.)

@item 
Os métodos @ref{283,,__getitem__()} de @ref{735,,xml.dom.pulldom.DOMEventStream}, @ref{736,,wsgiref.util.FileWrapper} e @ref{737,,fileinput.FileInput} foram descontinuados.

As implementações desses métodos têm ignorado seu parâmetro `index' e retornado o próximo item. (Contribuição de Berker Peksag em bpo-9372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9372}.)

@item 
A classe @ref{2b0,,typing.NamedTuple} descontinuou o atributo @code{_field_types} em favor do atributo @code{__annotations__} que possui as mesmas informações. (Contribuição de Raymond Hettinger em bpo-36320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36320}.)

@item 
As classes @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} e @code{Ellipsis} do módulo @ref{8,,ast} são consideradas descontinuadas e serão removidos em versões futuras do Python. A @ref{2b9,,Constant} deve ser usado. (Contribuição de Serhiy Storchaka em bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}.)

@item 
Os métodos @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()}, @code{visit_NameConstant()} e @code{visit_Ellipsis()} da classe @ref{a77,,ast.NodeVisitor} estão agora descontinuados e não serão chamados nas versões futuras do Python. Adicione o método @ref{a78,,visit_Constant()} para manipular todos os nós constantes. (Contribuição de Serhiy Storchaka em bpo-36917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36917}.)

@item 
O @ref{731,,decorador} @code{@@asyncio.coroutine} está descontinuado e será removido na versão 3.10. Em vez de @code{@@asyncio.coroutine}, use @ref{5d1,,async def}. (Contribuição de Andrew Svetlov em bpo-36921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36921}.)

@item 
Em @ref{a,,asyncio}, a passagem explícita de um argumento `loop' foi descontinuado e será removido na versão 3.10 para os seguintes: @ref{a79,,asyncio.sleep()}, @ref{5fd,,asyncio.gather()}, @ref{a7a,,asyncio.shield()}, @ref{5ff,,asyncio.wait_for()}, @ref{47f,,asyncio.wait()}, @ref{1aa,,asyncio.as_completed()}, @ref{1be,,asyncio.Task}, @ref{a7b,,asyncio.Lock}, @ref{a7c,,asyncio.Event}, @ref{a7d,,asyncio.Condition}, @ref{a7e,,asyncio.Semaphore}, @ref{a7f,,asyncio.BoundedSemaphore}, @ref{a80,,asyncio.Queue}, @ref{a81,,asyncio.create_subprocess_exec()} e @ref{a82,,asyncio.create_subprocess_shell()}.

@item 
A passagem explícita dos objetos da corrotina para @ref{47f,,asyncio.wait()} foi descontinuada e será removida na versão 3.11. (Contribuição de Yury Selivanov em bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}.)

@item 
As seguintes funções e métodos estão descontinuados no módulo @ref{63,,gettext}: @code{lgettext()}, @code{ldgettext()}, @code{lngettext()} e @code{ldngettext()}. Eles retornam bytes codificados, e é possível que você receba exceções inesperadas relacionadas ao Unicode se houver problemas de codificação com as strings traduzidas. É muito melhor usar alternativas que retornam strings Unicode no Python 3. Essas funções estão desativadas há muito tempo.

A função @code{bind_textdomain_codeset()}, os métodos @code{NullTranslations.output_charset()} e @code{NullTranslations.set_output_charset()} e o parâmetro `codeset' das funções @ref{a83,,translation()} e @ref{a84,,install()} também estão descontinuados, pois são usados apenas para as funções @code{l*gettext()}. (Contribuição de Serhiy Storchaka em bpo-33710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33710}.)

@item 
O método @code{isAlive()} de @ref{953,,threading.Thread} foi descontinuado. (Contribuição de Donghee Na em bpo-35283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35283}.)

@item 
Muitas funções internas e de extensão que recebem argumentos inteiros agora emitem um aviso de descontinuidade para objetos de @ref{29d,,Decimal}, de @ref{1e7,,Fraction} e quaisquer outros objetos que possam ser convertidos apenas em números inteiros com perda (por exemplo, que possuem o método @ref{71c,,__int__()}, mas não têm o método @ref{71d,,__index__()}). Em uma versão futura, haverá erros. (Contribuição de Serhiy Storchaka em bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048}.)

@item 
Descontinuada a passagem dos seguintes argumentos como argumentos nomeados:


@itemize -

@item 
`func' em @ref{a85,,functools.partialmethod()}, @ref{a86,,weakref.finalize()}, @ref{a87,,profile.Profile.runcall()}, @code{cProfile.Profile.runcall()}, @ref{a88,,bdb.Bdb.runcall()}, @ref{a89,,trace.Trace.runfunc()} e @ref{a8a,,curses.wrapper()}.

@item 
`function' em @ref{a8b,,unittest.TestCase.addCleanup()}.

@item 
`fn' no método @ref{a8c,,submit()} de @ref{742,,concurrent.futures.ThreadPoolExecutor} e @ref{8f4,,concurrent.futures.ProcessPoolExecutor}.

@item 
`callback' em @ref{a8d,,contextlib.ExitStack.callback()}, @code{contextlib.AsyncExitStack.callback()} e @ref{a8e,,contextlib.AsyncExitStack.push_async_callback()}.

@item 
`c' e `typeid' no metódo @code{create()} de @code{multiprocessing.managers.Server} e @code{multiprocessing.managers.SharedMemoryServer}.

@item 
`obj' em @ref{a86,,weakref.finalize()}.
@end itemize

Em versões futuras do Python, elas serão @ref{a8f,,somente-posicionais}. (Contribuição de Serhiy Storchaka em bpo-36492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36492}.)
@end itemize

@node Remoção de APIs e recursos,Portando para o Python 3 8,Descontinuados<8>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 api-and-feature-removals}@anchor{a90}
@subsection Remoção de APIs e recursos


Os seguintes recursos e APIs foram removidos do Python 3.8:


@itemize *

@item 
A partir do Python 3.3, a importação de ABCs de @ref{1d,,collections} foi descontinuada e a importação deve ser feita de @ref{1e,,collections.abc}. A possibilidade de importar de coleções foi marcada para remoção em 3.8, mas foi adiada para 3.9. (Veja gh-81134@footnote{https://github.com/python/cpython/issues/81134}.)

@item 
O módulo @code{macpath}, descontinuado no Python 3.7, foi removido. (Contribuição de Victor Stinner em bpo-35471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35471}.)

@item 
A função @code{platform.popen()} foi removida, após ter sido descontinuada desde o Python 3.3: em vez disso, use @ref{a91,,os.popen()}. (Contribuição de Victor Stinner em bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}.)

@item 
A função @code{time.clock()} foi removida, após ter sido descontinuada desde o Python 3.3: use @ref{a92,,time.perf_counter()} ou @ref{a93,,time.process_time()}, dependendo de suas necessidades, para ter um comportamento bem definido. (Contribuição de Matthias Bussonnier em bpo-36895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36895}.)

@item 
O script @code{pyvenv} foi removido em favor do @code{python3.8 -m venv} para ajudar a eliminar a confusão sobre a qual interpretador Python o script @code{pyvenv} está associado. (Contribuição de Brett Cannon em bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427}.)

@item 
@code{parse_qs}, @code{parse_qsl} e @code{escape} foram removidos do módulo @code{cgi}. Eles foram descontinuados no Python 3.2 ou mais antigo. Eles devem ser importados dos módulos @code{urllib.parse} e @code{html}.

@item 
A função @code{filemode} foi removida do módulo @ref{de,,tarfile}. Não é documentada e foi descontinuada desde o Python 3.3.

@item 
O construtor @ref{a5e,,XMLParser} não aceita mais o argumento `html'. Isso nunca teve efeito e foi descontinuado no Python 3.4. Todos os outros parâmetros agora são @ref{2a5,,somente-nomeados}. (Contribuição de Serhiy Storchaka em bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Removido o método @code{doctype()} de @ref{a5e,,XMLParser}. (Contribuição de Serhiy Storchaka em bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
O codec “unicode_internal” foi removido. (Contribuição de Inada Naoki em bpo-36297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36297}.)

@item 
Os objetos @code{Cache} e @code{Statement} do módulo @ref{cf,,sqlite3} não expostos para o usuário. (Contribuição de Aviv Palivoda em bpo-30262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30262}.)

@item 
O argumento nomeado @code{bufsize} de @ref{802,,fileinput.input()} e @ref{737,,fileinput.FileInput()}, que era ignorado e estava descontinuado desde o Python 3.6, foi removido. bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952} (Contribuição de Matthias Bussonnier.)

@item 
As funções @code{sys.set_coroutine_wrapper()} e @code{sys.get_coroutine_wrapper()} descontinuadas no Python 3.7 foram removidas; bpo-36933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36933} (Contribuição de Matthias Bussonnier.)
@end itemize

@node Portando para o Python 3 8,Alterações notáveis no Python 3 8 1,Remoção de APIs e recursos,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 porting-to-python-3-8}@anchor{a94}
@subsection Portando para o Python 3.8


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações no comportamento do Python:: 
* Alterações na API Python: Alterações na API Python<5>. 
* Alterações na API C: Alterações na API C<10>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<6>. 
* Ferramentas e daemons: Ferramentas e daemons<2>. 

@end menu

@node Alterações no comportamento do Python,Alterações na API Python<5>,,Portando para o Python 3 8
@anchor{whatsnew/3 8 changes-in-python-behavior}@anchor{a95}
@subsubsection Alterações no comportamento do Python



@itemize *

@item 
Expressões `yield' (ambas as cláusulas @code{yield} e @code{yield from}) agora não são permitidas nas compreensões e expressões geradoras (além da expressão iterável na cláusula mais à esquerda @code{for}). (Contribuição de Serhiy Storchaka em bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}.)

@item 
Agora, o compilador produz um @ref{466,,SyntaxWarning} quando verificações de identidade (@code{is} e @code{is not}) são usadas com certos tipos de literais (por exemplo, strings, números). Geralmente, eles podem funcionar acidentalmente no CPython, mas não são garantidos pelas especificações da linguagem. O aviso aconselha os usuários a usar testes de igualdade (@code{==} e @code{!=}). (Contribuição de Serhiy Storchaka em bpo-34850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34850}.)

@item 
O interpretador do CPython pode engolir exceções em algumas circunstâncias. No Python 3.8, isso acontece em menos casos. Em particular, as exceções levantadas ao obter o atributo do dicionário de tipos não são mais ignoradas. (Contribuição de Serhiy Storchaka em bpo-35459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35459}.)

@item 
Removidas as implementações @code{__str__} dos tipos embutidos @ref{468,,bool}, @ref{257,,int}, @ref{2f7,,float}, @ref{2f8,,complex} e poucas classes da biblioteca padrão. Agora eles herdam @code{__str__()} de @ref{a96,,object}. Como resultado, definir o método @code{__repr__()} na subclasse dessas classes afetará sua representação de string. (Contribuição de Serhiy Storchaka em bpo-36793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36793}.)

@item 
No AIX, @ref{a97,,sys.platform} não contém mais a versão principal. É sempre @code{'aix'}, em vez de @code{'aix3'} .. @code{'aix7'}. Como as versões mais antigas do Python incluem o número da versão, é recomendável usar sempre @code{sys.platform.startswith('aix')}. (Contribuição de M. Felt em bpo-36588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36588}.)

@item 
@code{PyEval_AcquireLock()} e @code{PyEval_AcquireThread()} agora encerram a thread atual se chamado enquanto o interpretador está finalizando, tornando-os consistentes com @ref{3a9,,PyEval_RestoreThread()}, @ref{a98,,Py_END_ALLOW_THREADS()} e @ref{3ab,,PyGILState_Ensure()}. Se esse comportamento não for desejado, proteja a chamada verificando @code{_Py_IsFinalizing()} ou @ref{a99,,sys.is_finalizing()}. (Contribuição de Joannah Nanjekye em bpo-36475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36475}.)
@end itemize

@node Alterações na API Python<5>,Alterações na API C<10>,Alterações no comportamento do Python,Portando para o Python 3 8
@anchor{whatsnew/3 8 changes-in-the-python-api}@anchor{a9a}
@subsubsection Alterações na API Python



@itemize *

@item 
A função @ref{a9b,,os.getcwdb()} agora usa a codificação UTF-8 no Windows, em vez da página de códigos ANSI: veja 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para a justificativa. A função não é mais descontinuada no Windows. (Contribuição de Victor Stinner em bpo-37412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37412}.)

@item 
@ref{199,,subprocess.Popen} agora pode usar @ref{220,,os.posix_spawn()} em alguns casos para melhor desempenho. No Subsistema Windows para Linux e na Emulação de Usuário QEMU, o construtor @ref{199,,Popen} usando @ref{220,,os.posix_spawn()} não levanta mais uma exceção em erros como “missing program” (programa ausente). Em vez disso, o processo filho falha com um @ref{a9c,,returncode} diferente de zero. (Contribuição de Joannah Nanjekye e Victor Stinner em bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}.)

@item 
O argumento `preexec_fn' de * @ref{199,,subprocess.Popen} não é mais compatível com subinterpretadores. O uso do parâmetro em um subinterpretador agora levanta @ref{195,,RuntimeError}. (Contribuição de Eric Snow em bpo-34651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34651}, modificado por Christian Heimes em bpo-37951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37951}.)

@item 
O método @ref{a9d,,imaplib.IMAP4.logout()} não ignora mais silenciosamente exceções arbitrárias. (Contribuição de Victor Stinner em bpo-36348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36348}.)

@item 
A função @code{platform.popen()} foi removida, após ter sido descontinuada desde o Python 3.3: em vez disso, use @ref{a91,,os.popen()}. (Contribuição de Victor Stinner em bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}.)

@item 
A função @code{Statistics.mode()} não levanta mais uma exceção quando dados multimodais são fornecidos. Em vez disso, ela retorna o primeiro modo encontrado nos dados de entrada. (Contribuição de Raymond Hettinger em bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892}.)

@item 
O método @ref{a9e,,selection()} da classe @ref{a9f,,tkinter.ttk.Treeview} não recebe mais argumentos. Seu uso com argumentos para alterar a seleção foi descontinuado no Python 3.6. Use métodos especializados como @ref{aa0,,selection_set()} para alterar a seleção. (Contribuição de Serhiy Storchaka em bpo-31508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31508}.)

@item 
Os métodos @ref{aa1,,writexml()}, @ref{aa2,,toxml()} e @ref{aa3,,toprettyxml()} de @ref{122,,xml.dom.minidom} e o método @ref{aa4,,write()} de @ref{125,,xml.etree.ElementTree} agora preservam a ordem dos atributos especificada pelo usuário. (Contribuição de Diego Rojas e Raymond Hettinger em bpo-34160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34160}.)

@item 
Um banco de dados @ref{32,,dbm.dumb} aberto com sinalizadores @code{'r'} agora é somente leitura. @ref{aa5,,dbm.dumb.open()} com os sinalizadores @code{'r'} e @code{'w'} não cria mais um banco de dados se ele não existir. (Contribuição de Serhiy Storchaka em bpo-32749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32749}.)

@item 
O método @code{doctype()} definido em uma subclasse de @ref{a5e,,XMLParser} não será mais chamado e emitirá um @ref{1bd,,RuntimeWarning} em vez de um @ref{1a5,,DeprecationWarning}. Defina o método @ref{aa6,,doctype()} em um alvo para manipular uma declaração doctype XML. (Contribuição de Serhiy Storchaka em bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}.)

@item 
Uma @ref{195,,RuntimeError} agora é levantada quando a metaclasse personalizada não fornece a entrada @code{__classcell__} no espaço de nomes passado para @code{type.__new__}. Uma @ref{1a5,,DeprecationWarning} era emitida no Python 3.6-3.7. (Contribuição de Serhiy Storchaka em bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}.)

@item 
A classe @ref{9eb,,cProfile.Profile} agora pode ser usada como um gerenciador de contexto. (Contribuição de Scott Sanderson em bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}.)

@item 
@ref{a63,,shutil.copyfile()}, @ref{a64,,shutil.copy()}, @ref{a65,,shutil.copy2()}, @ref{a33,,shutil.copytree()} e @ref{a33,,shutil.copytree()} usam chamadas de sistema de “cópia rápido” específica da plataforma (veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}).

@item 
O tamanho padrão do buffer de @ref{a63,,shutil.copyfile()} no Windows foi alterado de 16 KiB para 1 MiB.

@item 
A estrutura de @code{PyGC_Head} mudou completamente. Todo o código que tocava no membro struct deve ser reescrito. (Veja bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}.)

@item 
A estrutura de @ref{8c2,,PyInterpreterState} foi movida para os arquivos de cabeçalho “internal” (especificamente Include/internal/pycore_pystate.h). Um @code{PyInterpreterState} opaco ainda está disponível como parte da API pública (e ABI estável). Os documentos indicam que nenhum dos campos da estrutura é público, por isso esperamos que ninguém os tenha usado. No entanto, se você confia em um ou mais desses campos em particular e não tiver alternativa, abra um relatório de erro no BPO. Vamos trabalhar para ajudá-lo a ajustar (possivelmente incluindo a adição de funções de acessador à API pública). (Veja bpo-35886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35886}.)

@item 
O método @ref{aa7,,mmap.flush()} agora retorna @code{None} com êxito e levanta uma exceção no erro em todas as plataformas. Anteriormente, seu comportamento dependia da plataforma: um valor diferente de zero era retornado com êxito; zero era retornado com erro no Windows. Um valor zero era retornado com sucesso; uma exceção era levanta no caso de erro no Unix. (Contribuição de Berker Peksag em bpo-2122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2122}.)

@item 
Os módulos @ref{122,,xml.dom.minidom} e @ref{129,,xml.sax} não mais processam entidades externas por padrão. (Contribuição de Christian Heimes em bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}.)

@item 
Excluir uma chave de um banco de dados @ref{31,,dbm} somente leitura (@ref{32,,dbm.dumb}, @ref{33,,dbm.gnu} ou @ref{34,,dbm.ndbm}) levanta @code{error} (@ref{aa8,,dbm.dumb.error}, @ref{aa9,,dbm.gnu.error} ou @ref{aaa,,dbm.ndbm.error}) em vez de @ref{344,,KeyError}. (Contribuição de Xiang Zhang em bpo-33106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33106}.)

@item 
AST foi simplificado para literais. Todas as constantes serão representadas como instâncias de @ref{2b9,,ast.Constant}. Instanciar classes antigas @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} e @code{Ellipsis} retornará uma instância de @code{Constant}. (Contribuição de Serhiy Storchaka em bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}.)

@item 
@ref{a1e,,expanduser()} no Windows agora prefere a variável de ambiente 
@geindex USERPROFILE
@geindex variável de ambiente; USERPROFILE
@code{USERPROFILE} e não usa 
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME}, que normalmente não é definido para contas de usuário comuns. (Contribuição de Anthony Sottile em bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}.)

@item 
A exceção @ref{1b8,,asyncio.CancelledError} agora herda de @ref{5bb,,BaseException} em vez de @ref{9e2,,Exception} e não mais herda de @ref{9e3,,concurrent.futures.CancelledError}. (Contribuição de Yury Selivanov em bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}.)

@item 
A função @ref{5ff,,asyncio.wait_for()} agora aguarda corretamente o cancelamento ao usar uma instância de @ref{1be,,asyncio.Task}. Anteriormente, ao atingir tempo limite, ele era cancelado e devolvido imediatamente. (Contribuição de Elvis Pranskevichus em bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}.)

@item 
A função @ref{aab,,asyncio.BaseTransport.get_extra_info()} agora retorna um objeto soquete seguro de usar quando ‘socket’ é passado para o parâmetro `name'. (Contribuição de Yury Selivanov em bpo-37027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37027}.)

@item 
@ref{aac,,asyncio.BufferedProtocol} foi promovida a API estável.
@end itemize
@anchor{whatsnew/3 8 bpo-36085-whatsnew}@anchor{aad}

@itemize *

@item 
As dependências de DLL para módulos de extensão e DLLs carregadas com @ref{2a,,ctypes} no Windows agora são resolvidas com mais segurança. Somente os caminhos do sistema, o diretório que contém o arquivo DLL ou PYD e os diretórios adicionados com @ref{9f2,,add_dll_directory()} são pesquisados por dependências de tempo de carregamento. Especificamente, 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} e o diretório de trabalho atual não são mais usados, e as modificações nelas não terão mais efeito na resolução normal da DLL. Se seu aplicativo conta com esses mecanismos, você deve verificar @ref{9f2,,add_dll_directory()} e, se existir, use-o para adicionar seu diretório DLLs ao carregar sua biblioteca. Observe que os usuários do Windows 7 precisarão garantir que o Windows Update KB2533623 esteja instalado (isso também é verificado pelo instalador). (Contribuição de Steve Dower em bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}.)

@item 
Os arquivos de cabeçalho e as funções relacionadas ao pgen foram removidos após sua substituição por uma implementação pura do Python. (Contribuição de Pablo Galindo em bpo-36623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36623}.)

@item 
@ref{2df,,types.CodeType} possui um novo parâmetro na segunda posição do construtor (`posonlyargcount *) para suportar argumentos apenas de posição definidos em :pep:`570`. O primeiro argumento (*argcount') agora representa o número total de argumentos posicionais (incluindo argumentos somente posicionais). O novo método @code{replace()} de @ref{2df,,types.CodeType} pode ser usado para tornar o código à prova de futuro.

@item 
O parâmetro @code{digestmod} para @ref{aae,,hmac.new()} não usa mais o resumo MD5 por padrão.
@end itemize

@node Alterações na API C<10>,Alterações de bytecode do CPython<6>,Alterações na API Python<5>,Portando para o Python 3 8
@anchor{whatsnew/3 8 changes-in-the-c-api}@anchor{aaf}
@subsubsection Alterações na API C



@itemize *

@item 
A estrutura @ref{ab0,,PyCompilerFlags} recebeu um novo campo `cf_feature_version'. Ele deve ser inicializado para @code{PY_MINOR_VERSION}. O campo é ignorado por padrão e é usado se e somente se o sinalizador @code{PyCF_ONLY_AST} estiver definido em `cf_flags'. (Contribuição de Guido van Rossum em bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}.)

@item 
A função @code{PyEval_ReInitThreads()} foi removida da API C. Não deve ser chamada explicitamente: use @ref{3fb,,PyOS_AfterFork_Child()}. (Contribuição de Victor Stinner em bpo-36728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36728}.)

@item 
No Unix, as extensões C não estão mais vinculadas ao libpython, exceto no Android e Cygwin. Quando o Python é incorporado, @code{libpython} não deve ser carregado com @code{RTLD_LOCAL}, mas @code{RTLD_GLOBAL}. Anteriormente, usando @code{RTLD_LOCAL}, já não era possível carregar extensões C que não estavam vinculadas a @code{libpython}, como extensões C da biblioteca padrão criada pela seção @code{*shared*} de @code{Modules/Setup}. (Contribuição de Victor Stinner em bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}.)

@item 
O uso de variantes @code{#} de formatos na análise ou construção de valor (por exemplo, @ref{571,,PyArg_ParseTuple()}, @ref{8ac,,Py_BuildValue()}, @ref{39e,,PyObject_CallFunction()}, etc.) sem @code{PY_SSIZE_T_CLEAN} definido agora levanta @code{DeprecationWarning}. Será removido em 3.10 ou 4.0. Leia @ref{8ad,,Análise de argumentos e construção de valores} para detalhes. (Contribuição de Inada Naoki em bpo-36381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36381}.)

@item 
Instâncias de tipos alocados em heap (como aquelas criadas com @ref{57d,,PyType_FromSpec()}) mantêm uma referência ao seu objeto de tipo. O aumento da contagem de referências desses objetos de tipo foi movido de @ref{a75,,PyType_GenericAlloc()} para as funções de nível mais baixo, @ref{a74,,PyObject_Init()} e @code{PyObject_INIT}. Isso faz com que os tipos criados por meio de @ref{57d,,PyType_FromSpec()} se comportem como outras classes em código gerenciado.

@ref{77f,,Tipos alocados estaticamente} não são afetados.

Para a grande maioria dos casos, não deve haver efeito colateral. No entanto, tipos que aumentam manualmente a contagem de referência após alocar uma instância (talvez para solucionar o bug) agora podem se tornar imortais. Para evitar isso, essas classes precisam chamar Py_DECREF no objeto de tipo durante a desalocação da instância.

Para portar corretamente esses tipos para o 3.8, aplique as seguintes alterações:


@itemize *

@item 
Remove @ref{56e,,Py_INCREF} do objeto de tipo após alocar uma instância, se houver. Isso pode ocorrer após chamar @ref{98c,,PyObject_New}, @ref{98d,,PyObject_NewVar}, @ref{ab1,,PyObject_GC_New()}, @ref{ab2,,PyObject_GC_NewVar()} ou qualquer outro alocador personalizado que use @ref{a74,,PyObject_Init()} ou @code{PyObject_INIT}.

Exemplo:

@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
    // Solução de contorno para o issue 35810 do Python; não mais necessário no Python 3.8
    PY_INCREF(type)
#endif
    return foo;
@}
@end example

@item 
Certifica-se de que todas as funções @code{tp_dealloc} personalizadas de tipos alocados em heap diminuam a contagem de referências do tipo.

Exemplo:

@example
static void
foo_dealloc(foo_struct *instance) @{
    PyObject *type = Py_TYPE(instance);
    PyObject_GC_Del(instance);
#if PY_VERSION_HEX >= 0x03080000
    // Isso não era necessário antes do Python 3.8 (issue 35810 do Python)
    Py_DECREF(type);
#endif
@}
@end example
@end itemize

(Contribuição de Eddie Elizondo em bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}.)

@item 
A macro @ref{ab3,,Py_DEPRECATED()} foi implementada para MSVC. A macro agora deve ser colocada antes do nome do símbolo.

Exemplo:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example

(Contribuição de Zackery Spytz em bpo-33407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33407}.)

@item 
O interpretador não pretende mais dar suporte à compatibilidade binária de tipos de extensão nas liberações de recursos. O @ref{ab4,,PyTypeObject} exportado por um módulo de extensão de terceiros deve ter todos os slots esperados na versão atual do Python, incluindo @ref{ab5,,tp_finalize} (@ref{3f2,,Py_TPFLAGS_HAVE_FINALIZE} não é mais verificado antes de ler @ref{ab5,,tp_finalize}).

(Contribuição de Antoine Pitrou em bpo-32388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32388}.)

@item 
As funções @code{PyNode_AddChild()} e @code{PyParser_AddToken()} agora aceitam dois argumentos adicionais @code{int} `end_lineno' e `end_col_offset'.

@item 
O arquivo @code{libpython38.a} para permitir que as ferramentas do MinGW se vinculem diretamente a @code{python38.dll} não está mais incluído na distribuição regular do Windows. Se você precisar deste arquivo, ele poderá ser gerado com as ferramentas @code{gendef} e @code{dlltool}, que fazem parte do pacote binutils do MinGW:

@example
gendef - python38.dll > tmp.def
dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
@end example

A localização de um arquivo @code{pythonXY.dll} dependerá das opções de instalação e da versão e idioma do Windows. Consulte @ref{ab6,,Utilizando Python no Windows} para mais informações. A biblioteca resultante deve ser colocada no mesmo diretório que @code{pythonXY.lib}, que geralmente é o diretório @code{libs} na sua instalação do Python.

(Contribuição de Steve Dower em bpo-37351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37351}.)
@end itemize

@node Alterações de bytecode do CPython<6>,Ferramentas e daemons<2>,Alterações na API C<10>,Portando para o Python 3 8
@anchor{whatsnew/3 8 cpython-bytecode-changes}@anchor{ab7}
@subsubsection Alterações de bytecode do CPython



@itemize *

@item 
O loop do interpretador foi simplificado movendo a lógica de desenrolar a pilha de blocos no compilador. O compilador agora emite instruções explícitas para ajustar a pilha de valores e chamar o código de limpeza para @ref{ab8,,break}, @ref{9d1,,continue} e @ref{9d6,,return}.

Removidos os códigos de operação @code{BREAK_LOOP}, @code{CONTINUE_LOOP}, @code{SETUP_LOOP} e @code{SETUP_EXCEPT}. Adicionados novos códigos de opção @code{ROT_FOUR}, @code{BEGIN_FINALLY}, @code{CALL_FINALLY} e @code{POP_FINALLY}. Alterado o comportamento de @code{END_FINALLY} e @code{WITH_CLEANUP_START}.

(Contribuição de Mark Shannon, Antoine Pitrou e Serhiy Storchaka em bpo-17611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17611}.)

@item 
Adicionado novo código de operação @ref{ab9,,END_ASYNC_FOR} para lidar com exceções geradas ao aguardar um próximo item em um loop @ref{aba,,async for}. (Contribuição de Serhiy Storchaka em bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}.)

@item 
O @ref{abb,,MAP_ADD} agora espera o valor como o primeiro elemento na pilha e a chave como o segundo elemento. Essa alteração foi feita para que a chave seja sempre avaliada antes do valor na compreensão do dicionário, conforme proposto em 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}. (Contribuição de Jörn Heissler em bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}.)
@end itemize

@node Ferramentas e daemons<2>,,Alterações de bytecode do CPython<6>,Portando para o Python 3 8
@anchor{whatsnew/3 8 demos-and-tools}
@subsubsection Ferramentas e daemons


Adicionado um script de benchmark para cronometrar várias maneiras de acessar variáveis: @code{Tools/scripts/var_access_benchmark.py}. (Contribuição de Raymond Hettinger em bpo-35884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35884}.)

Aqui está um resumo das melhorias de desempenho 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

Os benchmarks foram medidos em um processador 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} nos sistemas macOS 64-bit encontrados em python.org@footnote{https://www.python.org/downloads/macos/}. O script de benchmark exibe tempos em nanossegundos.

@node Alterações notáveis no Python 3 8 1,Alterações notáveis no Python 3 8 2,Portando para o Python 3 8,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-1}@anchor{abd}
@subsection Alterações notáveis no Python 3.8.1


Devido a significativas preocupações de segurança, o parâmetro `reuse_address' de @ref{733,,asyncio.loop.create_datagram_endpoint()} não é mais suportado. Isso ocorre devido ao comportamento da opção de soquete @code{SO_REUSEADDR} no UDP. Para mais detalhes, consulte a documentação de @code{loop.create_datagram_endpoint()}. (Contribuição de Kyle Stanley, Antoine Pitrou e Yury Selivanov em bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Alterações notáveis no Python 3 8 2,Alterações notáveis no Python 3 8 3,Alterações notáveis no Python 3 8 1,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-2}@anchor{abe}
@subsection Alterações notáveis no Python 3.8.2


Corrigida uma regressão com o retorno de chamada @code{ignore} de @ref{a33,,shutil.copytree()}. Os tipos de argumento agora são str e List[str] novamente. (Contribuição de Manuel Barkhau e Giampaolo Rodola em gh-83571@footnote{https://github.com/python/cpython/issues/83571}.)

@node Alterações notáveis no Python 3 8 3,Alterações notáveis no Python 3 8 8,Alterações notáveis no Python 3 8 2,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-3}@anchor{abf}
@subsection Alterações notáveis no Python 3.8.3


Os valores constantes dos futuros sinalizadores no módulo @ref{0,,__future__} fpram atualizados para evitar colisão com os sinalizadores do compilador. Anteriormente, @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} estava colidindo com @code{CO_FUTURE_DIVISION}. (Contribuição de Batuhan Taskaya em gh-83743@footnote{https://github.com/python/cpython/issues/83743})

@node Alterações notáveis no Python 3 8 8,Alterações notáveis no Python 3 8 9,Alterações notáveis no Python 3 8 3,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-8}@anchor{ac0}
@subsection Alterações notáveis no Python 3.8.8


Versões anteriores do Python permitiam o uso de @code{;} e @code{&} como separadores de parâmetros de consulta nas funções @ref{27a,,urllib.parse.parse_qs()} e @ref{279,,urllib.parse.parse_qsl()}. Devido a questões de segurança, e em conformidade com as recomendações mais recentes do W3C, isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como padrão. Esta mudança também afeta as funções @code{cgi.parse()} e @code{cgi.parse_multipart()} já que elas usam as funções afetadas internamente. Para obter mais detalhes, consulte sua respectiva documentação. (Contribuição de Adam Goldschmidt, Senthil Kumaran e Ken Jin em bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Alterações notáveis no Python 3 8 9,Alterações notáveis no Python 3 8 10,Alterações notáveis no Python 3 8 8,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-9}@anchor{ac1}
@subsection Alterações notáveis no Python 3.8.9


Uma correção de segurança altera o comportamento @ref{900,,ftplib.FTP} para não confiar no endereço IPv4 enviado do servidor remoto ao configurar um canal de dados passivo. Em vez disso, reutilizamos o endereço IP do servidor ftp. Para códigos incomuns que requerem o comportamento antigo, defina um atributo @code{trust_server_pasv_ipv4_address} em sua instância de FTP para @code{True}. (Veja gh-87451@footnote{https://github.com/python/cpython/issues/87451})

@node Alterações notáveis no Python 3 8 10,Alterações notáveis no Python 3 8 10<2>,Alterações notáveis no Python 3 8 9,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-10}@anchor{ac2}
@subsection Alterações notáveis no Python 3.8.10


@menu
* Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac: Suporte a macOS 11 0 Big Sur e Apple Silicon Mac<2>. 

@end menu

@node Suporte a macOS 11 0 Big Sur e Apple Silicon Mac<2>,,,Alterações notáveis no Python 3 8 10
@anchor{whatsnew/3 8 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{ac3}
@subsubsection Suporte a macOS 11.0 (Big Sur) e Apple Silicon Mac


A partir do 3.8.10, Python oferece suporte total à construção e execução no macOS 11 (Big Sur) e no Apple Silicon Macs (baseado na arquitetura @code{ARM64}). Uma nova variante de compilação universal, @code{universal2}, está agora disponível com suporte nativo para @code{ARM64} e @code{Intel 64} em um conjunto de executáveis. Observe que suporte para “ligação fraca”, criar binários direcionados para versões mais recentes do macOS que também serão executados corretamente em versões mais antigas através da verificação em tempo de execução por recursos ausentes, não está mais incluída de forma retroativa do Python 3.9; para oferece suporte a uma gama de versões do macOS, continue a visar e a desenvolver para a versão mais antiga do intervalo.

(Contribuição original de Ronald Oussoren e Lawrence D’Anna em gh-85272@footnote{https://github.com/python/cpython/issues/85272}, com correções de FX Coudert e Eli Rykoff, e portado para a versão 3.8 por Maxime Bélanger e Ned Deily)

@node Alterações notáveis no Python 3 8 10<2>,Alterações notáveis no Python 3 8 12,Alterações notáveis no Python 3 8 10,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 id1}@anchor{ac4}
@subsection Alterações notáveis no Python 3.8.10


@menu
* urllib.parse: urllib parse<4>. 

@end menu

@node urllib parse<4>,,,Alterações notáveis no Python 3 8 10<2>
@anchor{whatsnew/3 8 urllib-parse}@anchor{ac5}
@subsubsection urllib.parse


A presença de caracteres de nova linha ou tab em partes de um URL permite algumas formas de ataques. Seguindo a especificação WHATWG que atualiza 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, nova linha ASCII @code{\n}, @code{\r} e os caracteres de tabulação @code{\t} são retirados da URL pelo analisador sintático em @ref{10a,,urllib.parse} impedindo tais ataques. Os caracteres de remoção são controlados por uma nova variável de nível de módulo @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE}. (Veja bpo-43882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43882})

@node Alterações notáveis no Python 3 8 12,Recursos de segurança notáveis no 3 8 14,Alterações notáveis no Python 3 8 10<2>,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-12}@anchor{ac6}
@subsection Alterações notáveis no Python 3.8.12


@menu
* Alterações na API Python: Alterações na API Python<6>. 

@end menu

@node Alterações na API Python<6>,,,Alterações notáveis no Python 3 8 12
@anchor{whatsnew/3 8 id2}@anchor{ac7}
@subsubsection Alterações na API Python


A partir do Python 3.8.12, o módulo @ref{80,,ipaddress} não aceita mais zeros à esquerda em strings de endereço IPv4. Os zeros à esquerda são ambíguos e interpretados como notação octal por algumas bibliotecas. Por exemplo, a função legada @ref{968,,socket.inet_aton()} trata os zeros à esquerda como notação octal. A implementação glibc de @ref{969,,inet_pton()} moderna não aceita nenhum zeros à esquerda.

(Originalmente contribuição de Christian Heimes em bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384} e backport para 3.8 por Achraf Merzouki.)

@node Recursos de segurança notáveis no 3 8 14,Alterações notáveis no 3 8 17,Alterações notáveis no Python 3 8 12,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-security-feature-in-3-8-14}@anchor{ac8}
@subsection Recursos de segurança notáveis no 3.8.14


Converter entre @ref{257,,int} e @ref{44c,,str} em bases diferentes de 2 (binário), 4, 8 (octal), 16 (hexadecimal) ou 32 como base 10 (decimal) agora levanta uma exceção @ref{202,,ValueError} se o número de dígitos em forma de string estiver acima de um limite para evitar possíveis ataques de negação de serviço devido à complexidade algorítmica. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}. Este limite pode ser configurado ou desabilitado por variável de ambiente, sinalizador de linha de comando ou APIs de @ref{d9,,sys}. Veja a documentação de @ref{5f5,,limitação de comprimento de conversão de string inteira}. O limite padrão é de 4300 dígitos em forma de string.

@node Alterações notáveis no 3 8 17,,Recursos de segurança notáveis no 3 8 14,O que há de novo no Python 3 8
@anchor{whatsnew/3 8 notable-changes-in-3-8-17}@anchor{ac9}
@subsection Alterações notáveis no 3.8.17


@menu
* tarfile: tarfile<6>. 

@end menu

@node tarfile<6>,,,Alterações notáveis no 3 8 17
@anchor{whatsnew/3 8 id3}@anchor{aca}
@subsubsection tarfile



@itemize *

@item 
Os métodos de extração em @ref{de,,tarfile} e @ref{46b,,shutil.unpack_archive()}, têm um novo argumento `filter' que permite limitar recursos do tar que podem ser surpreendentes ou perigosos, como criar arquivos fora do diretório de destino. Veja @ref{46c,,Filtros de extração} para detalhes. No Python 3.12, usar sem o argumento `filter' mostrará um @ref{1a5,,DeprecationWarning}. No Python 3.14, o padrão mudará para @code{'data'}. (Contribuição de Petr Viktorin em 
@geindex Propostas de Melhorias do Python; PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/}.)
@end itemize

@node O que há de novo no Python 3 7,What’s New In Python 3 6,O que há de novo no Python 3 8,O que há de novo no Python
@anchor{whatsnew/3 7 doc}@anchor{acb}@anchor{whatsnew/3 7 translation-repo}@anchor{acc}@anchor{whatsnew/3 7 what-s-new-in-python-3-7}@anchor{acd}
@section O que há de novo no 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.

Este artigo explica os novos recursos no Python 3.7, em comparação com 3.6. Python 3.7 foi lançado em 27 de Junho de 2018. Veja @ref{13c,,changelog} para uma lista completa de mudanças.

@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<7>. 
* Novas funcionalidades: Novas funcionalidades<12>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<7>. 
* Novos módulos: Novos módulos<7>. 
* Módulos melhorados: Módulos melhorados<7>. 
* Alterações na API C: Alterações na API C<11>. 
* Mudanças na construção: Mudanças na construção<6>. 
* Otimizações: Otimizações<7>. 
* Outras mudanças na implementação do CPython: Outras mudanças na implementação do CPython<2>. 
* Comportamento do Python descontinuado:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods. 
* Deprecated functions and types of the C API:: 
* Platform Support Removals:: 
* Remoção de APIs e recursos: Remoção de APIs e recursos<2>. 
* Module Removals:: 
* Windows-only Changes:: 
* Porting to Python 3.7: Porting to Python 3 7. 
* Notable changes in Python 3.7.1: Notable changes in Python 3 7 1. 
* Notable changes in Python 3.7.2: Notable changes in Python 3 7 2. 
* Notable changes in Python 3.7.6: Notable changes in Python 3 7 6. 
* Notable changes in Python 3.7.10: Notable changes in 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 Resumo – Destaques da versão<7>,Novas funcionalidades<12>,,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 summary-release-highlights}@anchor{ace}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.7.
@c Brevity is key.

Novos recursos de sintaxe:


@itemize *

@item 
@ref{acf,,PEP 563}, avaliação postergada de anotações de tipos.
@end itemize

Alterações de sintaxe incompatíveis com versões anteriores:


@itemize *

@item 
@ref{732,,async} e @ref{1b9,,await} são agora palavras chave reservadas.
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@ref{24,,contextvars}: @ref{ad0,,PEP 567 – Variáveis de Contexto}

@item 
@ref{2f,,dataclasses}: @ref{ad1,,PEP 557 – Classes de Dados}

@item 
@ref{ad2,,importlib.resources}
@end itemize

Novos recursos embutidos:


@itemize *

@item 
@ref{ad3,,PEP 553}, a nova função @ref{234,,breakpoint()}.;
@end itemize

Melhorias no modelo de dados Python:


@itemize *

@item 
@ref{ad4,,PEP 562}, personalização de acesso aos atributos do módulo.

@item 
@ref{ad5,,PEP 560}, suporte principal para o módulo typing e tipos genéricos.

@item 
a natureza de preservação da ordem de inserção de objetos @ref{ad6,,dict} foi declarada@footnote{https://mail.python.org/pipermail/python-dev/2017-December/151283.html} como uma parte oficial da especificação da linguagem Python.
@end itemize

Melhorias significativas na biblioteca padrão:


@itemize *

@item 
O módulo @ref{a,,asyncio} recebeu novos recursos, significativo à @ref{ad7,,melhorias de usabilidade e desempenho}.

@item 
O módulo @ref{ee,,time} ganhou suporte para @ref{ad8,,funções com resolução de nanossegundos}.
@end itemize

Melhorias na implementação do CPython:


@itemize *

@item 
Evitando o uso de ASCII como a codificação de texto padrão:


@itemize *

@item 
@ref{ad9,,PEP 538}, coerção de localidade C legada

@item 
@ref{ada,,PEP 540}, modo de tempo de execução UTF-8 forçado.
@end itemize

@item 
@ref{adb,,PEP 552}, .pycs determinísticos

@item 
@ref{adc,,Novo Modo de Desenvolvimento do Python}

@item 
@ref{add,,PEP 565}, aprimorada o tratamento de @ref{1a5,,DeprecationWarning}
@end itemize

Melhorias na API C:


@itemize *

@item 
@ref{ade,,PEP 539}, nova API C para armazenamento local de thread
@end itemize

Melhorias na documentação:


@itemize *

@item 
@ref{adf,,PEP 545}, Traduções da documentação do Python

@item 
Novas traduções da documentação: japonês@footnote{https://docs.python.org/ja/}, francês@footnote{https://docs.python.org/fr/} e coreano@footnote{https://docs.python.org/ko/}.
@end itemize

Esta versão apresenta melhorias de desempenho notáveis em muitas áreas. A seção @ref{ae0,,Otimizações} os lista em detalhes.

Para uma lista de mudanças que podem afetar a compatibilidade com versões anteriores do Python, consulte a seção @ref{ae1,,Porting to Python 3.7}.

@node Novas funcionalidades<12>,Outras mudanças na linguagem<7>,Resumo – Destaques da versão<7>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 new-features}@anchor{ae2}
@subsection Novas funcionalidades


@menu
* PEP 563; Avaliação Postergada de Anotações: PEP 563 Avaliação Postergada de Anotações. 
* PEP 538; Coerção de localidade C legada: PEP 538 Coerção de localidade C legada. 
* PEP 540; Modo de tempo de execução UTF-8 forçado: PEP 540 Modo de tempo de execução UTF-8 forçado. 
* PEP 553; breakpoint() embutida: PEP 553 breakpoint embutida. 
* PEP 539; Nova API C para armazenamento local de thread: PEP 539 Nova API C para armazenamento local de thread. 
* PEP 562; Personalização de acesso aos atributos do módulo: PEP 562 Personalização de acesso aos atributos do módulo. 
* PEP 564; Novas funções de tempo com resolução de nanossegundos: PEP 564 Novas funções de tempo com resolução de nanossegundos. 
* PEP 565; Mostra DeprecationWarning em __main__: PEP 565 Mostra DeprecationWarning em __main__. 
* PEP 560; Suporte básico para módulo typing e tipos genéricos: PEP 560 Suporte básico para módulo typing e tipos genéricos. 
* PEP 552; Arquivos .pyc baseados em hash: PEP 552 Arquivos pyc baseados em hash. 
* PEP 545; Traduções da documentação do Python: PEP 545 Traduções da documentação do Python. 
* Modo de Desenvolvimento do Python (-X dev): Modo de Desenvolvimento do Python -X dev. 

@end menu

@node PEP 563 Avaliação Postergada de Anotações,PEP 538 Coerção de localidade C legada,,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-563-postponed-evaluation-of-annotations}@anchor{ae3}@anchor{whatsnew/3 7 whatsnew37-pep563}@anchor{acf}
@subsubsection PEP 563: Avaliação Postergada de Anotações


O advento das dicas de tipo no Python revelou dois problemas de usabilidade gritantes com a funcionalidade das anotações adicionadas em 
@geindex Propostas de Melhorias do Python; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} e refinadas ainda mais em 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}:


@itemize *

@item 
as anotações só podiam usar nomes que já estavam disponíveis no escopo atual, ou seja, não suportavam referências de encaminhamento de nenhum tipo; e

@item 
anotar o código-fonte teve efeitos adversos no tempo de inicialização dos programas Python.
@end itemize

Ambos os problemas são corrigidos com o adiamento da avaliação das anotações. Em vez de compilar o código que executa expressões em anotações em seu tempo de definição, o compilador armazena a anotação em um formato de string equivalente ao AST da expressão em questão. Se necessário, as anotações podem ser resolvidas em tempo de execução usando @code{digitando.get_type_hints()}. No caso comum em que isso não é necessário, as anotações são mais baratas de armazenar (uma vez que strings curtas são internadas pelo interpretador) e tornam o tempo de inicialização mais rápido.

Em termos de usabilidade, as anotações agora suportam referências futuras, tornando a seguinte sintaxe válida:

@example
class C:
    @@classmethod
    def from_string(cls, source: str) -> C:
        ...

    def validate_b(self, obj: B) -> bool:
        ...

class B:
    ...
@end example

Como essa mudança quebra a compatibilidade, o novo comportamento precisa ser habilitado por módulo no Python 3.7 usando uma importação de @ref{0,,__future__}

@example
from __future__ import annotations
@end example

Ele se tornará o padrão no Python 3.10.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} – avaliação postergada de anotações de tipos

PEP escrita e implementada por Łukasz Langa.
@end table


@node PEP 538 Coerção de localidade C legada,PEP 540 Modo de tempo de execução UTF-8 forçado,PEP 563 Avaliação Postergada de Anotações,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-538-legacy-c-locale-coercion}@anchor{ae4}@anchor{whatsnew/3 7 whatsnew37-pep538}@anchor{ad9}
@subsubsection PEP 538: Coerção de localidade C legada


Um desafio contínuo dentro da série Python 3 tem sido determinar uma estratégia padrão sensata para lidar com a suposição de codificação de texto “ASCII de 7 bits” atualmente implícita pelo uso da localidade C ou POSIX padrão em plataformas não Windows.

A 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} atualiza a interface de linha de comando do interpretador padrão para forçar automaticamente essa localidade para uma localidade baseada em UTF-8 disponível conforme descrito na documentação da nova variável de ambiente 
@geindex PYTHONCOERCECLOCALE
@geindex variável de ambiente; PYTHONCOERCECLOCALE
@ref{ae5,,PYTHONCOERCECLOCALE}. Configurar automaticamente @code{LC_CTYPE} desta forma significa que tanto o interpretador central quanto as extensões C com reconhecimento da localidade (como @ref{ba,,readline}) irão presumir o uso de UTF-8 como a codificação de texto padrão, ao invés de ASCII.

A definição de suporte de plataforma na 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} também foi atualizada para limitar o suporte de manipulação de texto completo para localidades não baseadas em ASCII adequadamente configuradas.

Como parte dessa mudança, o tratador de erros padrão para @ref{53d,,stdin} e @ref{ae6,,stdout} agora é @code{surrogateescape} (em vez de @code{strict}) ao usar qualquer uma das localidades de destino de coerção definidas (atualmente @code{C.UTF-8}, @code{C.utf8} e @code{UTF-8}). O tratador de erros padrão para @ref{940,,stderr} continua a ser @code{backslashreplace}, independente da localidade.

A coerção de localidade é silenciosa por padrão, mas para ajudar na depuração de problemas de integração potencialmente relacionados à localidade, avisos explícitos (emitidos diretamente em @ref{940,,stderr}) podem ser solicitados configurando @code{PYTHONCOERCECLOCALE=warn}. Essa configuração também fará com que o tempo de execução do Python emita um aviso se a localidade C legada permanecer ativa quando o interpretador principal for inicializado.

Embora a coerção de localidade 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} tenha o benefício de também afetar os módulos de extensão (como GNU @code{readline}), bem como processos filhos (incluindo aqueles que executam aplicativos não Python e versões mais antigas do Python), tem a desvantagem de exigir que uma localidade de destino adequado esteja presente no sistema em execução. Para tratador melhor o caso em que nenhuma localidade de destino adequado está disponível (como ocorre no RHEL/CentOS 7, por exemplo), o Python 3.7 também implementa @ref{ada,,PEP 540; Modo de tempo de execução UTF-8 forçado}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 538

@item PEP 538@footnote{https://peps.python.org/pep-0538/} – Forçando a localidade C legada para uma localidade baseada em UTF-8

PEP escrita e implementada por Nick Coghlan.
@end table


@node PEP 540 Modo de tempo de execução UTF-8 forçado,PEP 553 breakpoint embutida,PEP 538 Coerção de localidade C legada,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-540-forced-utf-8-runtime-mode}@anchor{ae7}@anchor{whatsnew/3 7 whatsnew37-pep540}@anchor{ada}
@subsubsection PEP 540: Modo de tempo de execução  UTF-8 forçado


A nova opção de linha de comando @ref{176,,-X} @code{utf8} e a variável de ambiente 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8} podem ser usadas para habilitar o @ref{656,,modo UTF-8 do Python}.

Quando no modo UTF-8, o CPython ignora as configurações de localidade e usa a codificação UTF-8 por padrão. Os tratador de erros para fluxos @ref{53d,,sys.stdin} e @ref{ae6,,sys.stdout} são configurados para @code{surrogateescape}.

O modo UTF-8 forçado pode ser usado para alterar o comportamento de manipulação de texto em um interpretador Python embutido sem alterar as configurações de localidade de uma aplicação embutida.

Embora o modo UTF-8 da 
@geindex Propostas de Melhorias do Python; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} tenha a vantagem de funcionar independentemente de quais localidades estão disponíveis no sistema em execução, ele tem a desvantagem de não ter efeito sobre os módulos de extensão (como GNU @code{readline}) , processos filho executando aplicativos não-Python e processos filho executando versões anteriores do Python. Para reduzir o risco de corromper dados de texto ao se comunicar com tais componentes, o Python 3.7 também implementa @ref{ada,,PEP 540; Modo de tempo de execução UTF-8 forçado}).

O modo UTF-8 é habilitado por padrão quando a localidade é @code{C} ou @code{POSIX}, e o recurso de coerção de localidade 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} falha em mudá-la para uma alternativa baseada em UTF-8 (seja falha é devido a @code{PYTHONCOERCECLOCALE=0} sendo definido, @code{LC_ALL} sendo definido, ou a falta de uma localidade de destino adequada).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 540

@item PEP 540@footnote{https://peps.python.org/pep-0540/} – Adiciona um novo modo UTF-8

PEP escrito e implementado por Victor Stinner
@end table


@node PEP 553 breakpoint embutida,PEP 539 Nova API C para armazenamento local de thread,PEP 540 Modo de tempo de execução UTF-8 forçado,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-553-built-in-breakpoint}@anchor{ae9}@anchor{whatsnew/3 7 whatsnew37-pep553}@anchor{ad3}
@subsubsection PEP 553: @code{breakpoint()} embutida


Python 3.7 inclui a nova função embutida @ref{234,,breakpoint()} como uma maneira fácil e consistente de entrar no depurador Python.

@code{breakpoint()} embutida chama @ref{aea,,sys.breakpointhook()}. Por padrão, o último importa @ref{a5,,pdb} e então chama @code{pdb.set_trace()}, mas ao ligar @code{sys.breakpointhook()} à função de sua escolha, @code{breakpoint()} pode entrar em qualquer depurador. Além disso, a variável de ambiente 
@geindex PYTHONBREAKPOINT
@geindex variável de ambiente; PYTHONBREAKPOINT
@ref{aeb,,PYTHONBREAKPOINT} pode ser configurada para o chamável de seu depurador de escolha. Defina @code{PYTHONBREAKPOINT=0} para desabilitar completamente o @code{breakpoint()} embutida.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 553

@item PEP 553@footnote{https://peps.python.org/pep-0553/} – breakpoint() embutida

PEP escrita e implementada por Barry Warsaw
@end table


@node PEP 539 Nova API C para armazenamento local de thread,PEP 562 Personalização de acesso aos atributos do módulo,PEP 553 breakpoint embutida,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-539-new-c-api-for-thread-local-storage}@anchor{aec}@anchor{whatsnew/3 7 whatsnew37-pep539}@anchor{ade}
@subsubsection PEP 539: Nova API C para armazenamento local de thread


Enquanto Python fornece uma API C para suporte de armazenamento local de thread; a existente @ref{aed,,API da armazenamento local de thread (TLS)} usou int para representar as chaves TLS em todas as plataformas. Isso geralmente não tem sido um problema para plataformas oficialmente suportadas, mas isso não é compatível com POSIX, nem portátil em qualquer sentido prático.

A 
@geindex Propostas de Melhorias do Python; PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/} muda isso fornecendo uma nova @ref{aee,,API de armazenamento específico de thread (TSS)} para CPython que substitui o uso da API de TLS existente dentro do interpretador CPython, enquanto descontinua a API existente. A API de TSS usa um novo tipo @ref{aef,,Py_tss_t} em vez de int para representar as chaves de TSS – um tipo não visível cuja definição pode depender da implementação TLS subjacente. Portanto, isso permitirá construir CPython em plataformas onde a chave nativa de TLS é definida de uma forma que não pode ser convertida com segurança para int.

Observe que em plataformas onde a chave TLS nativa é definida de uma forma que não pode ser convertida com segurança para int, todas as funções da API TLS existente serão no-op e retornarão falha imediatamente. Isso indica claramente que a API antiga não é suportada em plataformas onde não pode ser usada de forma confiável e que nenhum esforço será feito para adicionar tal suporte.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 539

@item PEP 539@footnote{https://peps.python.org/pep-0539/} – Uma nova API C para armazenamento local de thread no CPython

PEP escrita por Erik M. Bray; implementação por Masayuki Yamamoto.
@end table


@node PEP 562 Personalização de acesso aos atributos do módulo,PEP 564 Novas funções de tempo com resolução de nanossegundos,PEP 539 Nova API C para armazenamento local de thread,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-562-customization-of-access-to-module-attributes}@anchor{af0}@anchor{whatsnew/3 7 whatsnew37-pep562}@anchor{ad4}
@subsubsection PEP 562: Personalização de acesso aos atributos do módulo


Python 3.7 allows defining @ref{af1,,__getattr__()} on modules and will call
it whenever a module attribute is otherwise not found.  Defining
@ref{af2,,__dir__()} on modules is now also allowed.

Um exemplo típico de onde isso pode ser útil é a descontinuação do atributo do módulo e o carregamento preguiçoso ou `lazy'.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} – Módulo @code{__getattr__} e @code{__dir__}

PEP escrita e implementada por Ivan Levkivskyi
@end table


@node PEP 564 Novas funções de tempo com resolução de nanossegundos,PEP 565 Mostra DeprecationWarning em __main__,PEP 562 Personalização de acesso aos atributos do módulo,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-564-new-time-functions-with-nanosecond-resolution}@anchor{af3}@anchor{whatsnew/3 7 whatsnew37-pep564}@anchor{ad8}
@subsubsection PEP 564: Novas funções de tempo com resolução de nanossegundos


A resolução dos relógios em sistemas modernos pode exceder a precisão limitada de um número de ponto flutuante retornado pela função @ref{254,,time.time()} e suas variantes. Para evitar perda de precisão, 
@geindex Propostas de Melhorias do Python; PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/} adiciona seis novas variantes em “nanossegundos” das funções de temporizador existentes ao módulo @ref{ee,,time}:


@itemize *

@item 
@ref{af4,,time.clock_gettime_ns()}

@item 
@ref{af5,,time.clock_settime_ns()}

@item 
@ref{af6,,time.monotonic_ns()}

@item 
@ref{af7,,time.perf_counter_ns()}

@item 
@ref{af8,,time.process_time_ns()}

@item 
@ref{af9,,time.time_ns()}
@end itemize

As novas funções retornam o número de nanossegundos como um valor inteiro.

@geindex Propostas de Melhorias do Python; PEP 0564#annex-clocks-resolution-in-python
Medições@footnote{https://peps.python.org/pep-0564/#annex-clocks-resolution-in-python} mostram que no Linux e no Windows a resolução de @ref{af9,,time.time_ns()} é aproximadamente 3 vezes melhor do que @ref{254,,time.time()}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 564

@item PEP 564@footnote{https://peps.python.org/pep-0564/} – Adiciona novas funções de tempo com resolução de nanossegundos

PEP escrito e implementado por Victor Stinner
@end table


@node PEP 565 Mostra DeprecationWarning em __main__,PEP 560 Suporte básico para módulo typing e tipos genéricos,PEP 564 Novas funções de tempo com resolução de nanossegundos,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-565-show-deprecationwarning-in-main}@anchor{afa}@anchor{whatsnew/3 7 whatsnew37-pep565}@anchor{add}
@subsubsection PEP 565: Mostra DeprecationWarning em @code{__main__}


O tratamento padrão de @ref{1a5,,DeprecationWarning} foi alterado de forma que esses avisos sejam mais uma vez mostrados por padrão, mas apenas quando o código que os aciona está sendo executado diretamente no módulo @ref{1,,__main__}. Como resultado, os desenvolvedores de scripts de arquivo único e aqueles que usam Python interativamente devem mais uma vez começar a ver avisos de descontinuação para as APIs que usam, mas os avisos de descontinuação acionados por aplicações importadas, biblioteca e módulos de estrutura continuarão ocultos por padrão.

Como resultado dessa mudança, a biblioteca padrão agora permite que os desenvolvedores escolham entre três comportamentos diferentes de aviso de descontinuação:


@itemize *

@item 
@ref{415,,FutureWarning}: sempre exibida por padrão, recomendado para avisos que devem ser vistos pelos usuários finais da aplicação (por exemplo, para definições de configuração de aplicações descontinuadas).

@item 
@ref{1a5,,DeprecationWarning}: exibida por padrão apenas em @ref{1,,__main__} e ao executar testes, recomendado para avisos que devem ser vistos por outros desenvolvedores Python onde uma atualização de versão pode resultar em mudança de comportamento ou um erro.

@item 
@ref{8ce,,PendingDeprecationWarning}: exibida por padrão apenas ao executar testes, destinados a casos em que uma atualização de versão futura mudará a categoria de aviso para @ref{1a5,,DeprecationWarning} ou @ref{415,,FutureWarning}.
@end itemize

Anteriormente, ambas @ref{1a5,,DeprecationWarning} e @ref{8ce,,PendingDeprecationWarning} eram visíveis apenas durante a execução de testes, o que significava que os desenvolvedores principalmente escrevendo scripts de arquivo único ou usando Python interativamente poderiam ser surpreendidos por alterações nas APIs que usavam.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 565

@item PEP 565@footnote{https://peps.python.org/pep-0565/} – Show DeprecationWarning in @code{__main__}

PEP escrita e implementada por Nick Coghlan
@end table


@node PEP 560 Suporte básico para módulo typing e tipos genéricos,PEP 552 Arquivos pyc baseados em hash,PEP 565 Mostra DeprecationWarning em __main__,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-560-core-support-for-typing-module-and-generic-types}@anchor{afb}@anchor{whatsnew/3 7 whatsnew37-pep560}@anchor{ad5}
@subsubsection PEP 560: Suporte básico para módulo @code{typing} e tipos genéricos


Initially 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} was designed in such way that it would not introduce `any'
changes to the core CPython interpreter. Now type hints and the @ref{104,,typing}
module are extensively used by the community, so this restriction is removed.
The PEP introduces two special methods @ref{73b,,__class_getitem__()} and
@ref{afc,,__mro_entries__()}, these methods are now used by most classes and special
constructs in @ref{104,,typing}. As a result, the speed of various operations
with types increased up to 7 times, the generic types can be used without
metaclass conflicts, and several long standing bugs in @ref{104,,typing} module are
fixed.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/} – Suporte básico para módulo typing e tipos genéricos

PEP escrita e implementada por Ivan Levkivskyi
@end table


@node PEP 552 Arquivos pyc baseados em hash,PEP 545 Traduções da documentação do Python,PEP 560 Suporte básico para módulo typing e tipos genéricos,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-552-hash-based-pyc-files}@anchor{afd}@anchor{whatsnew/3 7 whatsnew37-pep552}@anchor{adb}
@subsubsection PEP 552: Arquivos .pyc baseados em hash


O Python tradicionalmente verifica a atualização dos arquivos de cache em bytecode (ou seja, arquivos @code{.pyc}) comparando os metadados da fonte (registro de data e hora e tamanho da última modificação) com os metadados da fonte salvos no cabeçalho do arquivo de cache quando foi gerado. Embora eficaz, esse método de invalidação tem suas desvantagens. Quando os registros de data e hora do sistema de arquivos são muito grosseiros, o Python pode perder as atualizações de origem, levando à confusão do usuário. Além disso, ter um registro de data e hora no arquivo de cache é problemático para reprodutibilidade de compilação@footnote{https://reproducible-builds.org/} e sistemas de compilação baseados em conteúdo.

@geindex Propostas de Melhorias do Python; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} estende o formato pyc para permitir que o hash do arquivo de origem seja usado para invalidação em vez do registro de data e hora  da fonte. Esses arquivos @code{.pyc} são chamados de “baseados em hash”. Por padrão, Python ainda usa invalidação baseada em registro de data e hora e não gera arquivos @code{.pyc} baseados em hash em tempo de execução. Arquivos @code{.pyc} baseados em hash podem ser gerados com @ref{b3,,py_compile} ou @ref{20,,compileall}.

Arquivos @code{.pyc} baseados em hash vêm em duas variantes: verificados e não verificados. Python valida arquivos @code{.pyc} baseados em hash verificados em relação aos arquivos fonte correspondentes em tempo de execução, mas não o faz para pycs baseados em hash não verificados. Arquivos @code{.pyc} baseados em hash não verificados são uma otimização de desempenho útil para ambientes onde um sistema externo ao Python (por exemplo, o sistema de construção) é responsável por manter os arquivos @code{.pyc} atualizados.

Veja a função @ref{5ec,,Invalidação de bytecode em cache} para mais informações.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/} – pycs determinísticos

PEP escrita e implementada por Benjamin Peterson
@end table


@node PEP 545 Traduções da documentação do Python,Modo de Desenvolvimento do Python -X dev,PEP 552 Arquivos pyc baseados em hash,Novas funcionalidades<12>
@anchor{whatsnew/3 7 pep-545-python-documentation-translations}@anchor{afe}@anchor{whatsnew/3 7 whatsnew37-pep545}@anchor{adf}
@subsubsection PEP 545: Traduções da documentação do Python


@geindex Propostas de Melhorias do Python; PEP 545
PEP 545@footnote{https://peps.python.org/pep-0545/} descreve o processo de criação a manutenção das traduções da documentação do Python.

Três novas traduções foram adicionadas:


@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 545

@item PEP 545@footnote{https://peps.python.org/pep-0545/} – Traduções da documentação do Python

PEP escrita e implementada por Julien Palard, Inada Naoki e Victor Stinner.
@end table


@node Modo de Desenvolvimento do Python -X dev,,PEP 545 Traduções da documentação do Python,Novas funcionalidades<12>
@anchor{whatsnew/3 7 python-development-mode-x-dev}@anchor{aff}@anchor{whatsnew/3 7 whatsnew37-devmode}@anchor{adc}
@subsubsection Modo de Desenvolvimento do Python (-X dev)


A nova opção de linha de comando @ref{176,,-X} @code{dev} ou a nova variável de ambiente 
@geindex PYTHONDEVMODE
@geindex variável de ambiente; PYTHONDEVMODE
@ref{b00,,PYTHONDEVMODE} pode ser usada para habilitar @ref{1f8,,Modo de Desenvolvimento do Python}. Quando está no modo de desenvolvimento, o Python executa verificações adicionais em tempo de execução que são muito caras para serem habilitadas por padrão. Veja a documentação @ref{1f8,,Modo de Desenvolvimento do Python} para a descrição completa.

@node Outras mudanças na linguagem<7>,Novos módulos<7>,Novas funcionalidades<12>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 other-language-changes}@anchor{b01}
@subsection Outras mudanças na linguagem



@itemize *

@item 
Uma expressão @ref{1b9,,await} e compreensões contendo uma cláusula @ref{aba,,async for} eram ilegais nas expressões em @ref{9b1,,literais de strings formatadas} devido a um problema com a implementação. No Python 3.7, esta restrição foi retirada.

@item 
Mais de 255 argumentos agora podem ser passados para uma função, e uma função agora pode ter mais de 255 parâmetros. (Contribuição de Serhiy Storchaka em bpo-12844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12844} e bpo-18896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18896}.)

@item 
@ref{b02,,bytes.fromhex()} e @ref{b03,,bytearray.fromhex()} agora ignoram todos os espaços em branco ASCII, não apenas espaços. (Contribuição de Robert Xiao em bpo-28927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28927}.)

@item 
@ref{44c,,str}, @ref{1c2,,bytes} e @ref{2ea,,bytearray} ganharam suporte para o novo método @ref{b04,,isascii()}, que pode ser usado para testar se uma string ou bytes contêm apenas os caracteres ASCII. (Contribuição de INADA Naoki em bpo-32677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32677}.)

@item 
@ref{419,,ImportError} agora exibe o nome do módulo e o caminho do módulo @code{__file__} quando @code{from ... import ...} falha. (Contribuição de Matthias Bussonnier em bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}.)

@item 
Importações circulares envolvendo importações absolutas com ligação de um submódulo a um nome agora são suportadas. (Contribuição de Serhiy Storchaka em bpo-30024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30024}.)

@item 
@code{object.__format__(x, '@w{'})} agora é equivalente a @code{str(x)} em vez de @code{format(str(self), '@w{'})}. (Contribuição de Serhiy Storchaka em bpo-28974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28974}.)

@item 
Para melhor prover suporte à criação dinâmica de rastreamentos de pilha, @ref{b05,,types.TracebackType} agora pode ser instanciado a partir do código Python, e o atributo @ref{b06,,tb_next} em @ref{b07,,tracebacks} agora é gravável. (Contribuição de Nathaniel J. Smith em bpo-30579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30579}.)

@item 
Ao usar a opção @ref{5e1,,-m}, @code{sys.path[0]} agora é expandido para o caminho completo do diretório inicial, em vez de ser deixado como o diretório vazio (o que permite importações do `atual' diretório de trabalho no momento em que ocorre uma importação) (Contribuição de Nick Coghlan em bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}.)

@item 
A nova opção @ref{176,,-X} @code{importtime} ou a variável de ambiente 
@geindex PYTHONPROFILEIMPORTTIME
@geindex variável de ambiente; PYTHONPROFILEIMPORTTIME
@ref{b08,,PYTHONPROFILEIMPORTTIME} pode ser usada para mostrar o tempo de cada importação de módulo. (Contribuição de Inada Naoki em bpo-31415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31415}.)
@end itemize

@node Novos módulos<7>,Módulos melhorados<7>,Outras mudanças na linguagem<7>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 new-modules}@anchor{b09}
@subsection Novos módulos


@menu
* contextvars:: 
* dataclasses: dataclasses<3>. 
* importlib.resources: importlib resources<2>. 

@end menu

@node contextvars,dataclasses<3>,,Novos módulos<7>
@anchor{whatsnew/3 7 contextvars}@anchor{b0a}@anchor{whatsnew/3 7 whatsnew37-pep567}@anchor{ad0}
@subsubsection contextvars


O novo módulo @ref{24,,contextvars} e um conjunto de @ref{b0b,,novas APIs C} introduzem suporte para `variáveis de contexto'. Variáveis de contexto são conceitualmente semelhantes às variáveis locais de thread. Ao contrário do TLS, as variáveis de contexto oferecem suporte a código assíncrono corretamente.

Os módulos @ref{a,,asyncio} e @ref{36,,decimal} foram atualizados para usar e prover suporte a variáveis de contexto prontas para uso. Particularmente o contexto decimal ativo agora é armazenado em uma variável de contexto, o que permite que operações decimais funcionem com o contexto correto em código assíncrono.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 567

@item PEP 567@footnote{https://peps.python.org/pep-0567/} – Variáveis de contexto

PEP escrita e implementada por Yury Selivanov
@end table


@node dataclasses<3>,importlib resources<2>,contextvars,Novos módulos<7>
@anchor{whatsnew/3 7 dataclasses}@anchor{b0c}@anchor{whatsnew/3 7 whatsnew37-pep557}@anchor{ad1}
@subsubsection dataclasses


O novo decorador @ref{1cb,,dataclass()} fornece uma maneira de declarar `classes de dados'. Uma classe de dados descreve seus atributos usando anotações de variáveis de classe. Seu construtor e outros métodos mágicos, como @ref{61c,,__repr__()}, @ref{b0d,,__eq__()} e @ref{b0e,,__hash__()} são gerados automaticamente.

Exemplo:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 557

@item PEP 557@footnote{https://peps.python.org/pep-0557/} – Classes de dados

PEP escrita e implementada por Eric V. Smith
@end table


@node importlib resources<2>,,dataclasses<3>,Novos módulos<7>
@anchor{whatsnew/3 7 importlib-resources}@anchor{b0f}@anchor{whatsnew/3 7 whatsnew37-importlib-resources}@anchor{ad2}
@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{b10,,importlib.abc.ResourceReader} instance to support this
new API.  Built-in file path loaders and zip file loaders both support this.

(Contribuição de Barry Warsaw e Brett Cannon em bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}.)


@subsubheading Ver também


importlib_resources@footnote{https://importlib-resources.readthedocs.io/en/latest/} – um backport do PyPI para versões anteriores do Python.


@node Módulos melhorados<7>,Alterações na API C<11>,Novos módulos<7>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 improved-modules}@anchor{b11}
@subsection Módulos melhorados


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

@end menu

@node argparse<3>,asyncio<7>,,Módulos melhorados<7>
@anchor{whatsnew/3 7 argparse}@anchor{b12}
@subsubsection argparse


O novo método @ref{b13,,ArgumentParser.parse_intermixed_args()} permite misturar opções e argumentos posicionais. (Contribuição de paul.j3 em bpo-14191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14191}.)

@node asyncio<7>,binascii,argparse<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 asyncio}@anchor{b14}@anchor{whatsnew/3 7 whatsnew37-asyncio}@anchor{ad7}
@subsubsection asyncio


O módulo @ref{a,,asyncio} recebeu muitos novos recursos, usabilidade e @ref{b15,,melhorias de desempenho}. Mudanças notáveis incluem:


@itemize *

@item 
A nova função @ref{b16,,provisória} @ref{47c,,asyncio.run()} pode ser usada para executar uma corrotina a partir de código síncrono criando e destruindo automaticamente o laço de eventos. (Contribuição de Yury Selivanov em bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}.)

@item 
asyncio ganhou suporte para @ref{24,,contextvars}. @ref{b17,,loop.call_soon()}, @ref{b18,,loop.call_soon_threadsafe()}, @code{loop.call_later()}, @ref{b19,,loop.call_at()} e @ref{b1a,,Future.add_done_callback()} têm um novo parâmetro somente-nomeado opcional `context'. @ref{1be,,Tasks} agora rastreia seu contexto automaticamente. Veja 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mais detalhes. (Contribuição de Yury Selivanov em bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}.)

@item 
A nova função @ref{1bf,,asyncio.create_task()} foi adicionada como um atalho para @code{asyncio.get_event_loop().create_task()}. (Contribuição de Andrew Svetlov em bpo-32311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32311}.)

@item 
O novo método @ref{b1b,,loop.start_tls()} pode ser usado para atualizar uma conexão existente para TLS. (Contribuição de Yury Selivanov em bpo-23749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23749}.)

@item 
O novo método @ref{b1c,,loop.sock_recv_into()} permite a leitura de dados de um soquete diretamente em um buffer fornecido, tornando possível reduzir as cópias de dados. (Contribuição de Antoine Pitrou em bpo-31819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31819}.)

@item 
A nova função @ref{47d,,asyncio.current_task()} retorna a instância @ref{1be,,Task} atualmente em execução, e a nova função @ref{95d,,asyncio.all_tasks()} retorna um conjunto de todas as instâncias @code{Task} existentes em um determinado laço. Os métodos @code{Task.current_task()} e @code{Task.all_tasks()} foram descontinuados. (Contribuição de Andrew Svetlov em bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250}.)

@item 
A nova classe `provisória' @ref{aac,,BufferedProtocol} permite implementar protocolos de streaming com controle manual sobre o buffer de recebimento. (Contribuição de Yury Selivanov em bpo-32251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32251}.)

@item 
A nova função @ref{b1d,,asyncio.get_running_loop()} retorna o laço atualmente em execução e levanta uma exceção @ref{195,,RuntimeError} se nenhum laço estiver em execução. Isto contrasta com @ref{2c2,,asyncio.get_event_loop()}, que irá `criar' um novo laço de eventos se nenhum estiver em execução. (Contribuição de Yury Selivanov em bpo-32269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32269}.)

@item 
O novo método de corrotina @ref{b1e,,StreamWriter.wait_closed()} permite esperar até que o gravador de fluxo seja fechado. O novo método @ref{b1f,,StreamWriter.is_closing()} pode ser usado para determinar se o gravador está fechando. (Contribuição de Andrew Svetlov em bpo-32391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32391}.)

@item 
O novo método de corrotina @ref{b20,,loop.sock_sendfile()} permite enviar arquivos usando @ref{b21,,os.sendfile} quando possível. (Contribuição de Andrew Svetlov em bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}.)

@item 
Os novos métodos @ref{b22,,Future.get_loop()} e @code{Task.get_loop()} retornam a instância do laço no qual uma tarefa ou um future foi criado. @ref{b23,,Server.get_loop()} permite fazer o mesmo para objetos @ref{b24,,asyncio.Server}. (Contribuição de Yury Selivanov em bpo-32415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32415} e Srinivas Reddy Thatiparthy em bpo-32418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32418}.)

@item 
Agora é possível controlar como as instâncias de @ref{b24,,asyncio.Server} começam a servir. Anteriormente, o servidor começaria a servir imediatamente após ser criado. O novo argumento nomeado `start_serving' para @ref{b25,,loop.create_server()} e @ref{1ae,,loop.create_unix_server()}, bem como @ref{b26,,Server.start_serving()} e @ref{b27,,Server.serve_forever()} podem ser usados para dissociar a instanciação e o serviço do servidor. O novo método @ref{b28,,Server.is_serving()} retorna @code{True} se o servidor estiver servindo. Os objetos @ref{b24,,Server} agora são gerenciadores de contexto assíncronos:

@example
srv = await loop.create_server(...)

async with srv:
    # algum código

# Neste ponto, srv é fechado e não mais aceita novas conexões.
@end example

(Contribuição de Yury Selivanov em bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}.)

@item 
Objetos de retorno de chamada retornados por @ref{b29,,loop.call_later()} ganharam o novo método @ref{b2a,,when()} que retorna um registro de data e hora de retorno de chamada agendado absoluto. (Contribuição de Andrew Svetlov em bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}.)

@item 
O método @ref{733,,loop.create_datagram_endpoint()} ganhou suporte para soquetes Unix. (Contribuição de Quentin Dawans em bpo-31245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31245}.)

@item 
As funções @ref{b2b,,asyncio.open_connection()}, @ref{b2c,,asyncio.start_server()}, os métodos @ref{603,,loop.create_connection()}, @ref{b25,,loop.create_server()}, @ref{7df,,loop.create_accepted_socket()} e suas variantes de soquete UNIX correspondentes agora aceitam o argumento nomeado `ssl_handshake_timeout'. (Contribuição de Neil Aspinall em bpo-29970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29970}.)

@item 
O novo método @ref{b2d,,Handle.cancelled()} retorna @code{True} se o retorno de chamada foi cancelado. (Contribuição de Marat Sharafutdinov em bpo-31943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31943}.)

@item 
A fonte de asyncio foi convertida para usar a sintaxe @ref{732,,async}/@ref{1b9,,await}. (Contribuição de Andrew Svetlov em bpo-32193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32193}.)

@item 
O novo método @ref{b2e,,ReadTransport.is_reading()} pode ser usado para determinar o estado de leitura do transporte. Além disso, chamadas para @ref{b2f,,ReadTransport.resume_reading()} e @ref{b30,,ReadTransport.pause_reading()} agora são idempotentes. (Contribuição de Yury Selivanov em bpo-32356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32356}.)

@item 
Loop methods which accept socket paths now support passing
@ref{2a0,,path-like objects}.
(Contributed by Yury Selivanov in bpo-32066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32066}.)

@item 
In @ref{a,,asyncio} TCP sockets on Linux are now created with @code{TCP_NODELAY}
flag set by default.
(Contributed by Yury Selivanov and Victor Stinner in bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}.)

@item 
Exceptions occurring in cancelled tasks are no longer logged.
(Contributed by Yury Selivanov in bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}.)

@item 
New @code{WindowsSelectorEventLoopPolicy} and
@code{WindowsProactorEventLoopPolicy} classes.
(Contributed by Yury Selivanov in bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}.)
@end itemize

Several @code{asyncio} APIs have been
@ref{b31,,deprecated}.

@node binascii,calendar<2>,asyncio<7>,Módulos melhorados<7>
@anchor{whatsnew/3 7 binascii}@anchor{b32}
@subsubsection binascii


The @ref{b33,,b2a_uu()} 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 calendar<2>,collections<2>,binascii,Módulos melhorados<7>
@anchor{whatsnew/3 7 calendar}@anchor{b34}
@subsubsection calendar


The @ref{b35,,HTMLCalendar} class has new class attributes which ease
the customization of CSS classes in the produced HTML calendar.
(Contributed by Oz Tiram in bpo-30095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30095}.)

@node collections<2>,compileall<3>,calendar<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 collections}@anchor{b36}
@subsubsection collections


@code{collections.namedtuple()} now supports default values.
(Contributed by Raymond Hettinger in bpo-32320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32320}.)

@node compileall<3>,concurrent futures<3>,collections<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 compileall}@anchor{b37}
@subsubsection compileall


@ref{b38,,compileall.compile_dir()} learned the new `invalidation_mode' parameter,
which can be used to enable
@ref{adb,,hash-based .pyc invalidation}.  The invalidation
mode can also be specified on the command line using the new
@code{--invalidation-mode} argument.
(Contributed by Benjamin Peterson in bpo-31650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31650}.)

@node concurrent futures<3>,contextlib<3>,compileall<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 concurrent-futures}@anchor{b39}
@subsubsection concurrent.futures


@ref{8f4,,ProcessPoolExecutor} and
@ref{742,,ThreadPoolExecutor} now
support the new `initializer' and `initargs' constructor arguments.
(Contributed by Antoine Pitrou in bpo-21423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21423}.)

The @ref{8f4,,ProcessPoolExecutor}
can now take the multiprocessing context via the new `mp_context' argument.
(Contributed by Thomas Moreau in bpo-31540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31540}.)

@node contextlib<3>,cProfile<2>,concurrent futures<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 contextlib}@anchor{b3a}
@subsubsection contextlib


The new @ref{7f0,,nullcontext()} is a simpler and faster no-op
context manager than @ref{b3b,,ExitStack}.
(Contributed by Jesse-Bakker in bpo-10049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10049}.)

The new @ref{b3c,,asynccontextmanager()},
@ref{b3d,,AbstractAsyncContextManager}, and
@ref{b3e,,AsyncExitStack} have been added to
complement their synchronous counterparts.  (Contributed
by Jelle Zijlstra in bpo-29679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29679} and bpo-30241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30241},
and by Alexander Mohr and Ilya Kulakov in bpo-29302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29302}.)

@node cProfile<2>,crypt,contextlib<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 cprofile}@anchor{b3f}
@subsubsection cProfile


The @ref{27,,cProfile} command line now accepts @code{-m module_name} as an
alternative to script path.  (Contributed by Sanyam Khurana in bpo-21862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21862}.)

@node crypt,datetime<4>,cProfile<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 crypt}@anchor{b40}
@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<4>,dbm<2>,crypt,Módulos melhorados<7>
@anchor{whatsnew/3 7 datetime}@anchor{b41}
@subsubsection datetime


The new @ref{617,,datetime.fromisoformat()}
method constructs a @ref{1cc,,datetime} object from a string
in one of the formats output by
@ref{b42,,datetime.isoformat()}.
(Contributed by Paul Ganssle in bpo-15873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15873}.)

The @ref{5de,,tzinfo} class now supports sub-minute offsets.
(Contributed by Alexander Belopolsky in bpo-5288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5288}.)

@node dbm<2>,decimal,datetime<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 dbm}@anchor{b43}
@subsubsection dbm


@ref{32,,dbm.dumb} now supports reading read-only files and no longer writes the
index file when it is not changed.

@node decimal,dis<3>,dbm<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 decimal}@anchor{b44}
@subsubsection decimal


The @ref{36,,decimal} module now uses @ref{ad0,,context variables}
to store the decimal context.
(Contributed by Yury Selivanov in bpo-32630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32630}.)

@node dis<3>,distutils<4>,decimal,Módulos melhorados<7>
@anchor{whatsnew/3 7 dis}@anchor{b45}
@subsubsection dis


The @ref{b46,,dis()} function is now able to
disassemble nested code objects (the code of comprehensions, generator
expressions and nested functions, and the code used for building nested
classes).  The maximum depth of disassembly recursion is controlled by
the new `depth' parameter.
(Contributed by Serhiy Storchaka in bpo-11822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11822}.)

@node distutils<4>,enum<5>,dis<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 distutils}@anchor{b47}
@subsubsection distutils


@code{README.rst} is now included in the list of distutils standard READMEs and
therefore included in source distributions.
(Contributed by Ryan Gonzalez in bpo-11913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11913}.)

@node enum<5>,functools<3>,distutils<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 enum}@anchor{b48}
@subsubsection enum


The @ref{630,,Enum} learned the new @code{_ignore_} class property,
which allows listing the names of properties which should not become
enum members.
(Contributed by Ethan Furman in bpo-31801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31801}.)

In Python 3.8, attempting to check for non-Enum objects in @ref{630,,Enum}
classes will raise a @ref{2c3,,TypeError} (e.g. @code{1 in Color}); similarly,
attempting to check for non-Flag objects in a @ref{623,,Flag} member will
raise @ref{2c3,,TypeError} (e.g. @code{1 in Perm.RW}); currently, both operations
return @ref{b49,,False} instead and are deprecated.
(Contributed by Ethan Furman in bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}.)

@node functools<3>,gc<4>,enum<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 functools}@anchor{b4a}
@subsubsection functools


@ref{639,,functools.singledispatch()} now supports registering implementations
using type annotations.
(Contributed by Łukasz Langa in bpo-32227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32227}.)

@node gc<4>,hmac<2>,functools<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 gc}@anchor{b4b}
@subsubsection gc


The new @ref{b4c,,gc.freeze()} function allows freezing all objects tracked
by the garbage collector and excluding them from future collections.
This can be used before a POSIX @code{fork()} call to make the GC copy-on-write
friendly or to speed up collection.  The new @ref{b4d,,gc.unfreeze()} functions
reverses this operation.  Additionally, @ref{b4e,,gc.get_freeze_count()} can
be used to obtain the number of frozen objects.
(Contributed by Li Zekun in bpo-31558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31558}.)

@node hmac<2>,http client,gc<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 hmac}@anchor{b4f}
@subsubsection hmac


The @ref{6a,,hmac} module now has an optimized one-shot @ref{b50,,digest()}
function, which is up to three times faster than @ref{b51,,HMAC()}.
(Contributed by Christian Heimes in bpo-32433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32433}.)

@node http client,http server,hmac<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 http-client}@anchor{b52}
@subsubsection http.client


@ref{b53,,HTTPConnection} and @ref{b54,,HTTPSConnection}
now support the new `blocksize' argument for improved upload throughput.
(Contributed by Nir Soffer in bpo-31945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31945}.)

@node http server,idlelib e IDLE,http client,Módulos melhorados<7>
@anchor{whatsnew/3 7 http-server}@anchor{b55}
@subsubsection http.server


@ref{b56,,SimpleHTTPRequestHandler} now supports the HTTP
@code{If-Modified-Since} header.  The server returns the 304 response status if
the target file was not modified after the time specified in the header.
(Contributed by Pierre Quentel in bpo-29654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29654}.)

@ref{b56,,SimpleHTTPRequestHandler} accepts the new `directory'
argument, in addition to the new @code{--directory} command line argument.
With this parameter, the server serves the specified directory, by default it
uses the current working directory.
(Contributed by Stéphane Wirtel and Julien Palard in bpo-28707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28707}.)

The new @ref{b57,,ThreadingHTTPServer} class
uses threads to handle requests using @ref{b58,,ThreadingMixIn}.
It is used when @code{http.server} is run with @code{-m}.
(Contributed by Julien Palard in bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}.)

@node idlelib e IDLE,importlib<4>,http server,Módulos melhorados<7>
@anchor{whatsnew/3 7 idlelib-and-idle}@anchor{b59}
@subsubsection idlelib e IDLE


Multiple fixes for autocompletion. (Contributed by Louie Lu in bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}.)

Module Browser (on the File menu, formerly called Class Browser),
now displays nested functions and classes in addition to top-level
functions and classes.
(Contributed by Guilherme Polo, Cheryl Sabella, and Terry Jan Reedy
in bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}.)

The Settings dialog (Options, Configure IDLE) has been partly rewritten
to improve both appearance and function.
(Contributed by Cheryl Sabella and Terry Jan Reedy in multiple issues.)

The font sample now includes a selection of non-Latin characters so that
users can better see the effect of selecting a particular font.
(Contributed by Terry Jan Reedy in bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}.)
The sample can be edited to include other characters.
(Contributed by Serhiy Storchaka in bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}.)

The IDLE features formerly implemented as extensions have been reimplemented
as normal features.  Their settings have been moved from the Extensions tab
to other dialog tabs.
(Contributed by Charles Wohlganger and Terry Jan Reedy in bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}.)

Editor code context option revised.  Box displays all context lines up to
maxlines.  Clicking on a context line jumps the editor to that line.  Context
colors for custom themes is added to Highlights tab of Settings dialog.
(Contributed by Cheryl Sabella and Terry Jan Reedy in bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642},
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}, and bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}.)

On Windows, a new API call tells Windows 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.
(Contributed by Terry Jan Reedy in bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}.)

New in 3.7.1:

A saída em N linhas (50 por padrão) é compactada até um limite inferior. N pode ser alterado na seção PyShell da página General da caixa de diálogo Settings. Menos linhas, mas possivelmente extra longas, podem ser espremidas clicando com o botão direito do mouse na saída. A saída compactada pode ser expandida no local clicando duas vezes no botão ou na área de transferência ou em uma janela separada clicando com o botão direito do mouse. (Contribuição de Tal Einat em bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

The changes above have been backported to 3.6 maintenance releases.

NEW in 3.7.4:

Add “Run Customized” to the Run menu to run a module with customized
settings. Any command line arguments entered are added to sys.argv.
They re-appear in the box for the next customized run.  One can also
suppress the normal Shell main module restart.  (Contributed by Cheryl
Sabella, Terry Jan Reedy, and others in bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} and bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}.)

New in 3.7.5:

Add optional line numbers for IDLE editor windows. Windows
open without line numbers unless set otherwise in the General
tab of the configuration dialog.  Line numbers for an existing
window are shown and hidden in the Options menu.
(Contributed by Tal Einat and Saimadhav Heblikar in bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}.)

@node importlib<4>,io<4>,idlelib e IDLE,Módulos melhorados<7>
@anchor{whatsnew/3 7 importlib}@anchor{b5a}
@subsubsection importlib


The @ref{b10,,importlib.abc.ResourceReader} ABC was introduced to
support the loading of resources from packages.  See also
@ref{ad2,,importlib.resources}.
(Contributed by Barry Warsaw, Brett Cannon in bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}.)

@ref{519,,importlib.reload()} now raises @ref{b5b,,ModuleNotFoundError} if the module
lacks a spec.
(Contributed by Garvit Khatri in bpo-29851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29851}.)

@ref{2cd,,importlib.util.find_spec()} now raises @ref{b5b,,ModuleNotFoundError} instead of
@ref{34b,,AttributeError} if the specified parent module is not a package (i.e.
lacks a @code{__path__} attribute).
(Contributed by Milan Oberkirch in bpo-30436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30436}.)

The new @ref{b5c,,importlib.util.source_hash()} can be used to compute the hash of
the passed source.  A @ref{adb,,hash-based .pyc file}
embeds the value returned by this function.

@node io<4>,ipaddress<3>,importlib<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 io}@anchor{b5d}
@subsubsection io


The new @ref{b5e,,TextIOWrapper.reconfigure()}
method can be used to reconfigure the text stream with the new settings.
(Contributed by Antoine Pitrou in bpo-30526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30526} and
INADA Naoki in bpo-15216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15216}.)

@node ipaddress<3>,itertools<5>,io<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 ipaddress}@anchor{b5f}
@subsubsection ipaddress


The new @code{subnet_of()} and @code{supernet_of()} methods of
@ref{1ff,,ipaddress.IPv6Network} and @ref{1fe,,ipaddress.IPv4Network} can
be used for network containment tests.
(Contributed by Michel Albert and Cheryl Sabella in bpo-20825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20825}.)

@node itertools<5>,locale<4>,ipaddress<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 itertools}@anchor{b60}
@subsubsection itertools


@ref{b61,,itertools.islice()} now accepts
@ref{71d,,integer-like objects} as start, stop,
and slice arguments.
(Contributed by Will Roberts in bpo-30537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30537}.)

@node locale<4>,logging<3>,itertools<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 locale}@anchor{b62}
@subsubsection locale


The new `monetary' argument to @ref{51f,,locale.format_string()} can be used
to make the conversion use monetary thousands separators and
grouping strings.  (Contributed by Garvit in bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}.)

The @ref{53a,,locale.getpreferredencoding()} function now always returns @code{'UTF-8'}
on Android or when in the @ref{ada,,forced UTF-8 mode}.

@node logging<3>,math<6>,locale<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 logging}@anchor{b63}
@subsubsection logging


@ref{b64,,Logger} instances can now be pickled.
(Contributed by Vinay Sajip in bpo-30520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30520}.)

The new @ref{b65,,StreamHandler.setStream()}
method can be used to replace the logger stream after handler creation.
(Contributed by Vinay Sajip in bpo-30522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30522}.)

It is now possible to specify keyword arguments to handler constructors in
configuration passed to @ref{b66,,logging.config.fileConfig()}.
(Contributed by Preston Landers in bpo-31080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31080}.)

@node math<6>,mimetypes<2>,logging<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 math}@anchor{b67}
@subsubsection math


The new @ref{b68,,math.remainder()} function implements the IEEE 754-style remainder
operation.  (Contributed by Mark Dickinson in bpo-29962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29962}.)

@node mimetypes<2>,msilib,math<6>,Módulos melhorados<7>
@anchor{whatsnew/3 7 mimetypes}@anchor{b69}
@subsubsection mimetypes


The MIME type of .bmp has been changed from @code{'image/x-ms-bmp'} to
@code{'image/bmp'}.
(Contributed by Nitish Chandra in bpo-22589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22589}.)

@node msilib,multiprocessing<4>,mimetypes<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 msilib}@anchor{b6a}
@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 melhorados<7>
@anchor{whatsnew/3 7 multiprocessing}@anchor{b6b}
@subsubsection multiprocessing


The new @ref{b6c,,Process.close()} method
explicitly closes the process object and releases all resources associated
with it.  @ref{202,,ValueError} is raised if the underlying process is still
running.
(Contributed by Antoine Pitrou in bpo-30596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30596}.)

The new @ref{b6d,,Process.kill()} method can
be used to terminate the process using the @ref{b6e,,SIGKILL} signal on Unix.
(Contributed by Vitor Pereira in bpo-30794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30794}.)

Non-daemonic threads created by @ref{b6f,,Process} are now
joined on process exit.
(Contributed by Antoine Pitrou in bpo-18966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18966}.)

@node os<7>,pathlib<8>,multiprocessing<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 os}@anchor{b70}
@subsubsection os


@ref{b71,,os.fwalk()} now accepts the `path' argument as @ref{1c2,,bytes}.
(Contributed by Serhiy Storchaka in bpo-28682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28682}.)

@ref{a68,,os.scandir()} gained support for @ref{b72,,file descriptors}.
(Contributed by Serhiy Storchaka in bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}.)

The new @ref{300,,register_at_fork()} function allows registering Python
callbacks to be executed at process fork.
(Contributed by Antoine Pitrou in bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

Added @ref{b73,,os.preadv()} (combine the functionality of @ref{b74,,os.readv()} and
@ref{b75,,os.pread()}) and @ref{b76,,os.pwritev()} functions (combine the functionality
of @ref{b77,,os.writev()} and @ref{b78,,os.pwrite()}). (Contributed by Pablo Galindo in
bpo-31368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31368}.)

The mode argument of @ref{21e,,os.makedirs()} no longer affects the file
permission bits of newly created intermediate-level directories.
(Contributed by Serhiy Storchaka in bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}.)

@ref{b79,,os.dup2()} now returns the new file descriptor.  Previously, @code{None}
was always returned.
(Contributed by Benjamin Peterson in bpo-32441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32441}.)

The structure returned by @ref{4a0,,os.stat()} now contains the
@ref{b7a,,st_fstype} attribute on Solaris and its derivatives.
(Contributed by Jesús Cea Avión in bpo-32659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32659}.)

@node pathlib<8>,pdb<4>,os<7>,Módulos melhorados<7>
@anchor{whatsnew/3 7 pathlib}@anchor{b7b}
@subsubsection pathlib


The new @ref{a21,,Path.is_mount()} method is now available
on POSIX systems and can be used to determine whether a path is a mount point.
(Contributed by Cooper Ry Lees in bpo-30897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30897}.)

@node pdb<4>,py_compile<3>,pathlib<8>,Módulos melhorados<7>
@anchor{whatsnew/3 7 pdb}@anchor{b7c}
@subsubsection pdb


@ref{235,,pdb.set_trace()} now takes an optional `header' keyword-only
argument.  If given, it is printed to the console just before debugging
begins.  (Contributed by Barry Warsaw in bpo-31389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31389}.)

@ref{a5,,pdb} command line now accepts @code{-m module_name} as an alternative to
script file.  (Contributed by Mario Corchero in bpo-32206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32206}.)

@node py_compile<3>,pydoc<2>,pdb<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 py-compile}@anchor{b7d}
@subsubsection py_compile


@ref{a2f,,py_compile.compile()} – and by extension, @ref{20,,compileall} – now
respects the 
@geindex SOURCE_DATE_EPOCH
@geindex variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} environment variable by
unconditionally creating @code{.pyc} files for hash-based validation.
This allows for guaranteeing
reproducible builds@footnote{https://reproducible-builds.org/} of @code{.pyc}
files when they are created eagerly. (Contributed by Bernhard M. Wiedemann
in bpo-29708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29708}.)

@node pydoc<2>,queue<2>,py_compile<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 pydoc}@anchor{b7e}
@subsubsection pydoc


The pydoc server can now bind to an arbitrary hostname specified by the
new @code{-n} command-line argument.
(Contributed by Feanil Patel in bpo-31128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31128}.)

@node queue<2>,re<4>,pydoc<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 queue}@anchor{b7f}
@subsubsection queue


The new @ref{b80,,SimpleQueue} class is an unbounded @abbr{FIFO} queue.
(Contributed by Antoine Pitrou in bpo-14976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14976}.)

@node re<4>,signal<2>,queue<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 re}@anchor{b81}
@subsubsection re


The flags @ref{62c,,re.ASCII}, @ref{b82,,re.LOCALE} and @ref{b83,,re.UNICODE}
can be set within the scope of a group.
(Contributed by Serhiy Storchaka in bpo-31690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31690}.)

@ref{2a2,,re.split()} now supports splitting on a pattern like @code{r'\b'},
@code{'^$'} or @code{(?=-)} that matches an empty string.
(Contributed by Serhiy Storchaka in bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054}.)

Regular expressions compiled with the @ref{b82,,re.LOCALE} flag no longer
depend on the locale at compile time.  Locale settings are applied only
when the compiled regular expression is used.
(Contributed by Serhiy Storchaka in bpo-30215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30215}.)

@ref{415,,FutureWarning} is now emitted if a regular expression contains
character set constructs that will change semantically in the future,
such as nested sets and set operations.
(Contributed by Serhiy Storchaka in bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}.)

Compiled regular expression and match objects can now be copied
using @ref{534,,copy.copy()} and @ref{b84,,copy.deepcopy()}.
(Contributed by Serhiy Storchaka in bpo-10076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10076}.)

@node signal<2>,socket<5>,re<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 signal}@anchor{b85}
@subsubsection signal


The new `warn_on_full_buffer' argument to the @ref{b86,,signal.set_wakeup_fd()}
function makes it possible to specify whether Python prints a warning on
stderr when the wakeup buffer overflows.
(Contributed by Nathaniel J. Smith in bpo-30050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30050}.)

@node socket<5>,socketserver,signal<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 socket}@anchor{b87}
@subsubsection socket


The new @ref{b88,,socket.getblocking()} method
returns @code{True} if the socket is in blocking mode and @code{False} otherwise.
(Contributed by Yury Selivanov in bpo-32373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32373}.)

The new @ref{b89,,socket.close()} function closes the passed socket file descriptor.
This function should be used instead of @ref{b8a,,os.close()} for better
compatibility across platforms.
(Contributed by Christian Heimes in bpo-32454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32454}.)

The @ref{cc,,socket} module now exposes the @ref{b8b,,socket.TCP_CONGESTION} (Linux 2.6.13), @ref{b8b,,socket.TCP_USER_TIMEOUT} (Linux 2.6.37), and @ref{b8b,,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{b8c,,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}.)

Sockets now auto-detect family, type and protocol from file descriptor
by default.
(Contributed by Christian Heimes in bpo-28134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28134}.)

@node socketserver,sqlite3<6>,socket<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 socketserver}@anchor{b8d}
@subsubsection socketserver


@ref{b8e,,socketserver.ThreadingMixIn.server_close} now waits until all non-daemon
threads complete. @ref{b8e,,socketserver.ForkingMixIn.server_close} now waits
until all child processes complete.

Add a new @ref{b8f,,socketserver.ForkingMixIn.block_on_close} class attribute to
@ref{b90,,socketserver.ForkingMixIn} and @ref{b58,,socketserver.ThreadingMixIn}
classes. Set the class attribute to @code{False} to get the pre-3.7 behaviour.

@node sqlite3<6>,ssl<5>,socketserver,Módulos melhorados<7>
@anchor{whatsnew/3 7 sqlite3}@anchor{b91}
@subsubsection sqlite3


@ref{245,,sqlite3.Connection} now exposes the @ref{b92,,backup()}
method when the underlying SQLite library is at version 3.6.11 or higher.
(Contributed by Lele Gaifax in bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}.)

The `database' argument of @ref{2a8,,sqlite3.connect()} now accepts any
@ref{2a0,,path-like object}, instead of just a string.
(Contributed by Anders Lorentsen in bpo-31843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31843}.)

@node ssl<5>,string<2>,sqlite3<6>,Módulos melhorados<7>
@anchor{whatsnew/3 7 ssl}@anchor{b93}
@subsubsection ssl


The @ref{d0,,ssl} module now uses OpenSSL’s builtin API instead of
@code{match_hostname()} to check a host name or an IP address.  Values
are validated during TLS handshake.  Any certificate validation error
including failing the host name check now raises
@ref{b94,,SSLCertVerificationError} and aborts the handshake with a proper
TLS Alert message.  The new exception contains additional information.
Host name validation can be customized with
@ref{b95,,SSLContext.hostname_checks_common_name}.
(Contributed by Christian Heimes in bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}.)

@cartouche
@quotation Nota 
The improved host name check requires a `libssl' implementation compatible
with OpenSSL 1.0.2 or 1.1.  Consequently, OpenSSL 0.9.8 and 1.0.1 are no
longer supported (see @ref{b96,,Platform Support Removals} for more details).
The ssl module is mostly compatible with LibreSSL 2.7.2 and newer.
@end quotation
@end cartouche

The @code{ssl} module no longer sends IP addresses in SNI TLS extension.
(Contributed by Christian Heimes in bpo-32185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32185}.)

@code{match_hostname()} no longer supports partial wildcards like
@code{www*.example.org}.
(Contributed by Mandeep Singh in bpo-23033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23033} and Christian Heimes in
bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}.)

The default cipher suite selection of the @code{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 updates.  Default cipher
suite selection can be configured at compile time.
(Contributed by Christian Heimes in bpo-31429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31429}.)

Validation of server certificates containing internationalized domain names
(IDNs) is now supported.  As part of this change, the
@ref{b97,,SSLSocket.server_hostname} attribute
now stores the expected hostname in A-label form (@code{"xn--pythn-mua.org"}),
rather than the U-label form (@code{"pythön.org"}).  (Contributed by
Nathaniel J. Smith and Christian Heimes in bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}.)

The @code{ssl} module has preliminary and experimental support for TLS 1.3 and
OpenSSL 1.1.1.  At the time of Python 3.7.0 release, OpenSSL 1.1.1 is still
under development and TLS 1.3 hasn’t been finalized yet.  The TLS 1.3
handshake and protocol behaves slightly differently than TLS 1.2 and earlier,
see @ref{b98,,TLS 1.3}.
(Contributed by Christian Heimes in 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} and bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618})

@ref{8f0,,SSLSocket} and @ref{b99,,SSLObject} no longer have a public
constructor.  Direct instantiation was never a documented and supported
feature.  Instances must be created with @ref{294,,SSLContext} methods
@ref{525,,wrap_socket()} and @ref{b9a,,wrap_bio()}.
(Contributed by Christian Heimes in bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951})

OpenSSL 1.1 APIs for setting the minimum and maximum TLS protocol version are
available as @ref{874,,SSLContext.minimum_version}
and @ref{875,,SSLContext.maximum_version}.
Supported protocols are indicated by several new flags, such as
@ref{b9b,,HAS_TLSv1_1}.
(Contributed by Christian Heimes in bpo-32609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32609}.)

Added @ref{a3b,,ssl.SSLContext.post_handshake_auth} to enable and
@ref{a3c,,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<2>,subprocess<2>,ssl<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 string}@anchor{b9c}
@subsubsection string


@ref{687,,string.Template} now lets you to optionally modify the regular
expression pattern for braced placeholders and non-braced placeholders
separately.  (Contributed by Barry Warsaw in bpo-1198569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1198569}.)

@node subprocess<2>,sys<8>,string<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 subprocess}@anchor{b9d}
@subsubsection subprocess


The @ref{b9e,,subprocess.run()} function accepts the new `capture_output'
keyword argument.  When true, stdout and stderr will be captured.
This is equivalent to passing @ref{b9f,,subprocess.PIPE} as `stdout' and
`stderr' arguments.
(Contributed by Bo Bayles in bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}.)

The @code{subprocess.run} function and the @ref{199,,subprocess.Popen} constructor
now accept the `text' keyword argument as an alias
to `universal_newlines'.
(Contributed by Andrew Clegg in bpo-31756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31756}.)

On Windows the default for `close_fds' was changed from @code{False} to
@code{True} when redirecting the standard handles.  It’s now possible to set
`close_fds' to true when redirecting the standard handles.  See
@ref{199,,subprocess.Popen}.  This means that `close_fds' now defaults to
@code{True} on all supported platforms.
(Contributed by Segev Finer in bpo-19764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19764}.)

The subprocess module is now more graceful when handling
@ref{9d9,,KeyboardInterrupt} during @ref{ba0,,subprocess.call()},
@ref{b9e,,subprocess.run()}, or in a @ref{199,,Popen}
context manager.  It now waits a short amount of time for the child
to exit, before continuing the handling of the @code{KeyboardInterrupt}
exception.
(Contributed by Gregory P. Smith in bpo-25942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25942}.)

@node sys<8>,time<5>,subprocess<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 sys}@anchor{ba1}
@subsubsection sys


The new @ref{aea,,sys.breakpointhook()} hook function is called by the
built-in @ref{234,,breakpoint()}.
(Contributed by Barry Warsaw in bpo-31353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31353}.)

On Android, the new @ref{ba2,,sys.getandroidapilevel()} returns the build-time
Android API version.
(Contributed by Victor Stinner in bpo-28740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28740}.)

The new @ref{ba3,,sys.get_coroutine_origin_tracking_depth()} function returns
the current coroutine origin tracking depth, as set by
the new @ref{ba4,,sys.set_coroutine_origin_tracking_depth()}.  @ref{a,,asyncio}
has been converted to use this new API instead of
the deprecated @code{sys.set_coroutine_wrapper()}.
(Contributed by Nathaniel J. Smith in bpo-32591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32591}.)

@node time<5>,tkinter<5>,sys<8>,Módulos melhorados<7>
@anchor{whatsnew/3 7 time}@anchor{ba5}
@subsubsection time


@geindex Propostas de Melhorias do Python; PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/} adds six new functions with nanosecond resolution to the
@ref{ee,,time} module:


@itemize *

@item 
@ref{af4,,time.clock_gettime_ns()}

@item 
@ref{af5,,time.clock_settime_ns()}

@item 
@ref{af6,,time.monotonic_ns()}

@item 
@ref{af7,,time.perf_counter_ns()}

@item 
@ref{af8,,time.process_time_ns()}

@item 
@ref{af9,,time.time_ns()}
@end itemize

New clock identifiers have been added:


@itemize *

@item 
@ref{ba6,,time.CLOCK_BOOTTIME} (Linux): Identical to
@ref{699,,time.CLOCK_MONOTONIC}, except it also includes any time that the
system is suspended.

@item 
@ref{ba7,,time.CLOCK_PROF} (FreeBSD, NetBSD and OpenBSD): High-resolution
per-process CPU timer.

@item 
@ref{ba8,,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

The new @ref{93d,,time.thread_time()} and @ref{ba9,,time.thread_time_ns()} functions
can be used to get per-thread CPU time measurements.
(Contributed by Antoine Pitrou in bpo-32025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32025}.)

The new @ref{baa,,time.pthread_getcpuclockid()} function returns the clock ID
of the thread-specific CPU-time clock.

@node tkinter<5>,tracemalloc<2>,time<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 tkinter}@anchor{bab}
@subsubsection tkinter


The new @ref{bac,,tkinter.ttk.Spinbox} class is now available.
(Contributed by Alan Moore in bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}.)

@node tracemalloc<2>,types<4>,tkinter<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 tracemalloc}@anchor{bad}
@subsubsection tracemalloc


@ref{bae,,tracemalloc.Traceback} behaves more like regular tracebacks,
sorting the frames from oldest to most recent.
@ref{baf,,Traceback.format()}
now accepts negative `limit', truncating the result to the
@code{abs(limit)} oldest frames.  To get the old behaviour, use
the new `most_recent_first' argument to @code{Traceback.format()}.
(Contributed by Jesse Bakker in bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}.)

@node types<4>,unicodedata<6>,tracemalloc<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 types}@anchor{bb0}
@subsubsection types


The new @ref{bb1,,WrapperDescriptorType},
@ref{64b,,MethodWrapperType}, @ref{bb2,,MethodDescriptorType},
and @ref{bb3,,ClassMethodDescriptorType} classes are now available.
(Contributed by Manuel Krebber and Guido van Rossum in bpo-29377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29377},
and Serhiy Storchaka in bpo-32265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32265}.)

The new @ref{bb4,,types.resolve_bases()} function resolves MRO entries
dynamically as specified by 
@geindex Propostas de Melhorias do Python; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}.
(Contributed by Ivan Levkivskyi in bpo-32717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32717}.)

@node unicodedata<6>,unittest<7>,types<4>,Módulos melhorados<7>
@anchor{whatsnew/3 7 unicodedata}@anchor{bb5}
@subsubsection unicodedata


The internal @ref{105,,unicodedata} database has been upgraded to use Unicode 11@footnote{https://www.unicode.org/versions/Unicode11.0.0/}. (Contributed by Benjamin
Peterson.)

@node unittest<7>,unittest mock,unicodedata<6>,Módulos melhorados<7>
@anchor{whatsnew/3 7 unittest}@anchor{bb6}
@subsubsection unittest


The new @code{-k} command-line option allows filtering tests by a name
substring or a Unix shell-like pattern.
For example, @code{python -m unittest -k foo} runs
@code{foo_tests.SomeTest.test_something}, @code{bar_tests.SomeTest.test_foo},
but not @code{bar_tests.FooTest.test_something}.
(Contributed by Jonas Haag in bpo-32071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32071}.)

@node unittest mock,urllib parse<5>,unittest<7>,Módulos melhorados<7>
@anchor{whatsnew/3 7 unittest-mock}@anchor{bb7}
@subsubsection unittest.mock


The @ref{bb8,,sentinel} attributes now preserve their identity
when they are @ref{25,,copied} or @ref{a6,,pickled}. (Contributed by
Serhiy Storchaka in bpo-20804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20804}.)

The new @ref{bb9,,seal()} function allows sealing
@ref{a54,,Mock} instances, which will disallow further creation
of attribute mocks.  The seal is applied recursively to all attributes that
are themselves mocks.
(Contributed by Mario Corchero in bpo-30541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30541}.)

@node urllib parse<5>,uu,unittest mock,Módulos melhorados<7>
@anchor{whatsnew/3 7 urllib-parse}@anchor{bba}
@subsubsection urllib.parse


@ref{bbb,,urllib.parse.quote()} has been updated from 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} to 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html},
adding @code{~} to the set of characters that are never quoted by default.
(Contributed by Christian Theune and Ratnadeep Debnath in bpo-16285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16285}.)

@node uu,uuid<2>,urllib parse<5>,Módulos melhorados<7>
@anchor{whatsnew/3 7 uu}@anchor{bbc}
@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<2>,avisos<3>,uu,Módulos melhorados<7>
@anchor{whatsnew/3 7 uuid}@anchor{bbd}
@subsubsection uuid


The new @ref{bbe,,UUID.is_safe} attribute relays information
from the platform about whether generated UUIDs are generated with a
multiprocessing-safe method.
(Contributed by Barry Warsaw in bpo-22807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22807}.)

@ref{bbf,,uuid.getnode()} now prefers universally administered
MAC addresses over locally administered MAC addresses.
This makes a better guarantee for global uniqueness of UUIDs returned
from @ref{bc0,,uuid.uuid1()}.  If only locally administered MAC addresses are
available, the first such one found is returned.
(Contributed by Barry Warsaw in bpo-32107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32107}.)

@node avisos<3>,xml<5>,uuid<2>,Módulos melhorados<7>
@anchor{whatsnew/3 7 warnings}@anchor{bc1}
@subsubsection avisos


The initialization of the default warnings filters has changed as follows:


@itemize *

@item 
warnings enabled via command line options (including those for @ref{5e3,,-b}
and the new CPython-specific @ref{176,,-X} @code{dev} option) are always passed
to the warnings machinery via the @ref{3b0,,sys.warnoptions} attribute.

@item 
warnings filters enabled via the command line or the environment now have the
following order of precedence:


@itemize *

@item 
the @code{BytesWarning} filter for @ref{5e3,,-b} (or @code{-bb})

@item 
any filters specified with the @ref{8cd,,-W} option

@item 
any filters specified with the 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} environment
variable

@item 
any other CPython specific filters (e.g. the @code{default} filter added
for the new @code{-X dev} mode)

@item 
any implicit filters defined directly by the warnings machinery
@end itemize

@item 
in @ref{1f9,,CPython debug builds}, all warnings are now displayed
by default (the implicit filter list is empty)
@end itemize

(Contributed by Nick Coghlan and Victor Stinner in 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}.)

Deprecation warnings are once again shown by default in single-file scripts and
at the interactive prompt.  See @ref{add,,PEP 565; Mostra DeprecationWarning em __main__} for details.
(Contributed by Nick Coghlan in bpo-31975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31975}.)

@node xml<5>,xml etree,avisos<3>,Módulos melhorados<7>
@anchor{whatsnew/3 7 xml}@anchor{bc3}
@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 melhorados<7>
@anchor{whatsnew/3 7 xml-etree}@anchor{bc4}
@subsubsection xml.etree


@ref{bc5,,ElementPath} predicates in the @code{find()}
methods can now compare text of the current node with @code{[. = "text"]},
not only text in children.  Predicates also allow adding spaces for
better readability.  (Contributed by Stefan Behnel in bpo-31648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31648}.)

@node xmlrpc server,zipapp,xml etree,Módulos melhorados<7>
@anchor{whatsnew/3 7 xmlrpc-server}@anchor{bc6}
@subsubsection xmlrpc.server


@code{SimpleXMLRPCDispatcher.register_function()}
can now be used as a decorator.  (Contributed by Xiang Zhang in
bpo-7769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7769}.)

@node zipapp,zipfile<2>,xmlrpc server,Módulos melhorados<7>
@anchor{whatsnew/3 7 zipapp}@anchor{bc7}
@subsubsection zipapp


Function @ref{bc8,,create_archive()} now accepts an optional `filter'
argument to allow the user to select which files should be included in the
archive.  (Contributed by Irmen de Jong in bpo-31072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31072}.)

Function @ref{bc8,,create_archive()} now accepts an optional `compressed'
argument to generate a compressed archive.  A command line option
@code{--compress} has also been added to support compression.
(Contributed by Zhiming Wang in bpo-31638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31638}.)

@node zipfile<2>,,zipapp,Módulos melhorados<7>
@anchor{whatsnew/3 7 zipfile}@anchor{bc9}
@subsubsection zipfile


@ref{6c4,,ZipFile} now accepts the new `compresslevel' parameter to
control the compression level.
(Contributed by Bo Bayles in bpo-21417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21417}.)

Subdirectories in archives created by @code{ZipFile} are now stored in
alphabetical order.
(Contributed by Bernhard M. Wiedemann in bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}.)

@node Alterações na API C<11>,Mudanças na construção<6>,Módulos melhorados<7>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 c-api-changes}@anchor{bca}
@subsection Alterações na API C


A new API for thread-local storage has been implemented.  See
@ref{ade,,PEP 539; Nova API C para armazenamento local de thread} for an overview and
@ref{aee,,Thread Specific Storage (TSS) API} for a complete reference.
(Contributed by Masayuki Yamamoto in bpo-25658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25658}.)

The new @ref{ad0,,context variables} functionality
exposes a number of @ref{b0b,,new C APIs}.

The new @ref{bcb,,PyImport_GetModule()} function returns the previously
imported module with the given name.
(Contributed by Eric Snow in bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}.)

The new @ref{bcc,,Py_RETURN_RICHCOMPARE} macro eases writing rich
comparison functions.
(Contributed by Petr Victorin in bpo-23699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23699}.)

The new @ref{bcd,,Py_UNREACHABLE} macro can be used to mark unreachable
code paths.
(Contributed by Barry Warsaw in bpo-31338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31338}.)

The @ref{ff,,tracemalloc} now exposes a C API through the new
@ref{bce,,PyTraceMalloc_Track()} and @ref{bcf,,PyTraceMalloc_Untrack()}
functions.
(Contributed by Victor Stinner in bpo-30054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30054}.)

The new @ref{bd0,,import__find__load__start} and
@ref{bd0,,import__find__load__done} static markers can be used
to trace module imports.
(Contributed by Christian Heimes in bpo-31574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31574}.)

The fields @code{name} and @code{doc} of structures
@ref{54f,,PyMemberDef}, @ref{bd1,,PyGetSetDef},
@ref{bd2,,PyStructSequence_Field}, @ref{bd3,,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}.)

The result of @ref{89d,,PyUnicode_AsUTF8AndSize()} and @ref{bd4,,PyUnicode_AsUTF8()}
is now of type @code{const char *} rather of @code{char *}. (Contributed by Serhiy
Storchaka in bpo-28769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28769}.)

The result of @ref{bd5,,PyMapping_Keys()}, @ref{bd6,,PyMapping_Values()} and
@ref{bd7,,PyMapping_Items()} is now always a list, rather than a list or a
tuple. (Contributed by Oren Milman in bpo-28280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28280}.)

Added functions @ref{3fd,,PySlice_Unpack()} and @ref{3fe,,PySlice_AdjustIndices()}.
(Contributed by Serhiy Storchaka in bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@ref{3fa,,PyOS_AfterFork()} is deprecated in favour of the new functions
@ref{bd8,,PyOS_BeforeFork()}, @ref{bd9,,PyOS_AfterFork_Parent()} and
@ref{3fb,,PyOS_AfterFork_Child()}.  (Contributed by Antoine Pitrou in
bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

The @code{PyExc_RecursionErrorInst} singleton that was part of the public API
has been removed as its members being never cleared may cause a segfault
during finalization of the interpreter. Contributed by Xavier de Gaye in
bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} and bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}.

Added C API support for timezones with timezone constructors
@ref{bda,,PyTimeZone_FromOffset()} and @ref{bdb,,PyTimeZone_FromOffsetAndName()},
and access to the UTC singleton with @ref{bdc,,PyDateTime_TimeZone_UTC}.
Contributed by Paul Ganssle in bpo-10381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10381}.

The type of results of @code{PyThread_start_new_thread()} and
@code{PyThread_get_thread_ident()}, and the `id' parameter of
@ref{bdd,,PyThreadState_SetAsyncExc()} changed from long to
unsigned long.
(Contributed by Serhiy Storchaka in bpo-6532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6532}.)

@ref{8c1,,PyUnicode_AsWideCharString()} now raises a @ref{202,,ValueError} if the
second argument is @code{NULL} and the wchar_t* string contains null
characters.  (Contributed by Serhiy Storchaka in bpo-30708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30708}.)

Changes to the startup sequence and the management of dynamic memory
allocators mean that the long documented requirement to call
@ref{8b1,,Py_Initialize()} before calling most C API functions is now
relied on more heavily, and failing to abide by it may lead to segfaults in
embedding applications. See the @ref{ae1,,Porting to Python 3.7} section in this
document and the @ref{bde,,Antes da inicialização do Python} section in the C API documentation
for more details.

The new @ref{bdf,,PyInterpreterState_GetID()} returns the unique ID for a
given interpreter.
(Contributed by Eric Snow in bpo-29102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29102}.)

@ref{be0,,Py_DecodeLocale()}, @ref{be1,,Py_EncodeLocale()} now use the UTF-8
encoding when the @ref{ada,,UTF-8 mode} is enabled.
(Contributed by Victor Stinner in bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}.)

@ref{be2,,PyUnicode_DecodeLocaleAndSize()} and @ref{be3,,PyUnicode_EncodeLocale()}
now use the current locale encoding for @code{surrogateescape} error handler.
(Contributed by Victor Stinner in bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}.)

The `start' and `end' parameters of @ref{8be,,PyUnicode_FindChar()} are
now adjusted to behave like string slices.
(Contributed by Xiang Zhang in bpo-28822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28822}.)

@node Mudanças na construção<6>,Otimizações<7>,Alterações na API C<11>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 build-changes}@anchor{be4}
@subsection Mudanças na construção


Support for building @code{--without-threads} has been removed.  The
@ref{ed,,threading} module is now always available.
(Contributed by Antoine Pitrou in bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370}.).

A full copy of libffi is no longer bundled for use when building the
@ref{2a,,_ctypes} module on non-OSX UNIX platforms.  An installed copy
of libffi is now required when building @code{_ctypes} on such platforms.
(Contributed by Zachary Ware in bpo-27979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27979}.)

The Windows build process no longer depends on Subversion to pull in external
sources, a Python script is used to download zipfiles from GitHub instead.
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 for this purpose.  (Contributed by Zachary
Ware in bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}.)

The @ref{d0,,ssl} module requires OpenSSL 1.0.2 or 1.1 compatible libssl.
OpenSSL 1.0.1 has reached end of lifetime on 2016-12-31 and is no longer
supported. LibreSSL is temporarily not supported as well. LibreSSL releases
up to version 2.6.4 are missing required OpenSSL 1.0.2 APIs.

@node Otimizações<7>,Outras mudanças na implementação do CPython<2>,Mudanças na construção<6>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 optimizations}@anchor{be5}@anchor{whatsnew/3 7 whatsnew37-perf}@anchor{ae0}
@subsection Otimizações


The overhead of calling many methods of various standard library classes
implemented in C has been significantly reduced by porting more code
to use the @code{METH_FASTCALL} convention.
(Contributed by Victor Stinner in 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}, and bpo-29286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29286}.)

Various optimizations have reduced Python startup time by 10% on Linux and
up to 30% on macOS.
(Contributed by Victor Stinner, INADA Naoki in bpo-29585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29585}, and
Ivan Levkivskyi in bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}.)

Method calls are now up to 20% faster due to the bytecode changes which
avoid creating bound method instances.
(Contributed by Yury Selivanov and INADA Naoki in bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}.)
@anchor{whatsnew/3 7 whatsnew37-asyncio-perf}@anchor{b15}
The @ref{a,,asyncio} module received a number of notable optimizations for
commonly used functions:


@itemize *

@item 
The @ref{2c2,,asyncio.get_event_loop()} function has been reimplemented in C to
make it up to 15 times faster.
(Contributed by Yury Selivanov in bpo-32296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32296}.)

@item 
@ref{be6,,asyncio.Future} callback management has been optimized.
(Contributed by Yury Selivanov in bpo-32348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32348}.)

@item 
@ref{5fd,,asyncio.gather()} is now up to 15% faster.
(Contributed by Yury Selivanov in bpo-32355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32355}.)

@item 
@ref{a79,,asyncio.sleep()} is now up to 2 times faster when the `delay'
argument is zero or negative.
(Contributed by Andrew Svetlov in bpo-32351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32351}.)

@item 
The performance overhead of asyncio debug mode has been reduced.
(Contributed by Antoine Pitrou in bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}.)
@end itemize

As a result of @ref{ad5,,PEP 560 work}, the import time
of @ref{104,,typing} has been reduced by a factor of 7, and many typing operations
are now faster.
(Contributed by Ivan Levkivskyi in bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}.)

@ref{be7,,sorted()} and @ref{be8,,list.sort()} have been optimized for common cases
to be up to 40-75% faster.
(Contributed by Elliot Gorokhovsky in bpo-28685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28685}.)

@ref{be9,,dict.copy()} is now up to 5.5 times faster.
(Contributed by Yury Selivanov in bpo-31179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31179}.)

@ref{4d2,,hasattr()} and @ref{bea,,getattr()} are now about 4 times faster when
`name' is not found and `obj' does not override @ref{4d3,,object.__getattr__()}
or @ref{beb,,object.__getattribute__()}.
(Contributed by INADA Naoki in bpo-32544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32544}.)

Searching for certain Unicode characters (like Ukrainian capital “Є”)
in a string was up to 25 times slower than searching for other characters.
It is now only 3 times slower in the worst case.
(Contributed by Serhiy Storchaka in bpo-24821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24821}.)

The @ref{1ca,,collections.namedtuple()} factory has been reimplemented to
make the creation of named tuples 4 to 6 times faster.
(Contributed by Jelle Zijlstra with further improvements by INADA Naoki,
Serhiy Storchaka, and Raymond Hettinger in bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}.)

@ref{bec,,datetime.date.fromordinal()} and @ref{bed,,datetime.date.fromtimestamp()}
are now up to 30% faster in the common case.
(Contributed by Paul Ganssle in bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403}.)

The @ref{b71,,os.fwalk()} function is now up to 2 times faster thanks to
the use of @ref{a68,,os.scandir()}.
(Contributed by Serhiy Storchaka in bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}.)

The speed of the @ref{301,,shutil.rmtree()} function has been improved by
20–40% thanks to the use of the @ref{a68,,os.scandir()} function.
(Contributed by Serhiy Storchaka in bpo-28564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28564}.)

Optimized case-insensitive matching and searching of @ref{b9,,regular expressions}.  Searching some patterns can now be up to 20 times faster.
(Contributed by Serhiy Storchaka in bpo-30285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30285}.)

@ref{bee,,re.compile()} now converts @code{flags} parameter to int object if
it is @code{RegexFlag}.  It is now as fast as Python 3.5, and faster than
Python 3.6 by about 10% depending on the pattern.
(Contributed by INADA Naoki in bpo-31671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31671}.)

The @ref{bef,,modify()} methods of classes
@ref{bf0,,selectors.EpollSelector}, @ref{bf1,,selectors.PollSelector}
and @ref{bf2,,selectors.DevpollSelector} may be around 10% faster under
heavy loads.  (Contributed by Giampaolo Rodola’ in bpo-30014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30014})

Constant folding has been moved from the peephole optimizer to the new AST
optimizer, which is able perform optimizations more consistently.
(Contributed by Eugene Toder and INADA Naoki in bpo-29469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29469} and
bpo-11549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11549}.)

Most functions and methods in @ref{4,,abc} have been rewritten in C.
This makes creation of abstract base classes, and calling @ref{442,,isinstance()}
and @ref{7c2,,issubclass()} on them 1.5x faster.  This also reduces Python
start-up time by up to 10%. (Contributed by Ivan Levkivskyi and INADA Naoki
in bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333})

Significant speed improvements to alternate constructors for
@ref{1cd,,datetime.date} and @ref{1cc,,datetime.datetime} by using fast-path
constructors when not constructing subclasses. (Contributed by Paul Ganssle
in bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403})

The speed of comparison of @ref{1a0,,array.array} instances has been
improved considerably in certain cases.  It is now from 10x to 70x faster
when comparing arrays holding values of the same integer type.
(Contributed by Adrian Wielgosik in bpo-24700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24700}.)

The @ref{bf3,,math.erf()} and @ref{bf4,,math.erfc()} functions now use the (faster)
C library implementation on most platforms.
(Contributed by Serhiy Storchaka in bpo-26121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26121}.)

@node Outras mudanças na implementação do CPython<2>,Comportamento do Python descontinuado,Otimizações<7>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 other-cpython-implementation-changes}@anchor{bf5}
@subsection Outras mudanças na implementação do 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{bf6,,f_trace_lines} and @ref{bf7,,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 
Fixed some consistency problems with namespace package module attributes.
Namespace module objects now have an @code{__file__} that is set to @code{None}
(previously unset), and their @code{__spec__.origin} is also set to @code{None}
(previously the string @code{"namespace"}).  See bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}.  Also, the
namespace module object’s @code{__spec__.loader} is set to the same value as
@code{__loader__} (previously, the former was set to @code{None}).  See
bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}.

@item 
The @ref{141,,locals()} dictionary now displays in the lexical order that
variables were defined.  Previously, the order was undefined.
(Contributed by Raymond Hettinger in 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 Comportamento do Python descontinuado,Deprecated Python modules functions and methods,Outras mudanças na implementação do CPython<2>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 deprecated-python-behavior}@anchor{bf8}
@subsection Comportamento do Python descontinuado


Yield expressions (both @code{yield} and @code{yield from} clauses) are now deprecated
in comprehensions and generator expressions (aside from the iterable expression
in the leftmost @code{for} clause). This ensures that comprehensions
always immediately return a container of the appropriate type (rather than
potentially returning a @ref{bf9,,generator iterator} object), while generator
expressions won’t attempt to interleave their implicit output with the output
from any explicit yield expressions.  In Python 3.7, such expressions emit
@ref{1a5,,DeprecationWarning} when compiled, in Python 3.8 this will be a
@ref{18d,,SyntaxError}.
(Contributed by Serhiy Storchaka in bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}.)

Returning a subclass of @ref{2f8,,complex} from @ref{5e7,,object.__complex__()} is
deprecated and will be an error in future Python versions.  This makes
@code{__complex__()} consistent with @ref{71c,,object.__int__()} and
@ref{9d4,,object.__float__()}.
(Contributed by Serhiy Storchaka in bpo-28894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28894}.)

@node Deprecated Python modules functions and methods,Deprecated functions and types of the C API,Comportamento do Python descontinuado,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 deprecated-python-modules-functions-and-methods}@anchor{bfa}
@subsection Deprecated Python modules, functions and methods


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

@end menu

@node aifc,asyncio<8>,,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 aifc}@anchor{bfb}
@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,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id2}@anchor{bfc}@anchor{whatsnew/3 7 whatsnew37-asyncio-deprecated}@anchor{b31}
@subsubsection asyncio


Support for directly @code{await}-ing instances of @ref{a7b,,asyncio.Lock} and
other asyncio synchronization primitives has been deprecated.  An
asynchronous context manager must be used in order to acquire and release
the synchronization resource.
(Contributed by Andrew Svetlov in 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>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id3}@anchor{bfd}
@subsubsection collections


In Python 3.8, the abstract base classes in @ref{1e,,collections.abc} will no
longer be exposed in the regular @ref{1d,,collections} module.  This will help
create a clearer distinction between the concrete classes and the abstract
base classes.
(Contributed by Serhiy Storchaka in bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}.)

@node dbm<3>,enum<6>,collections<3>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id4}@anchor{bfe}
@subsubsection dbm


@ref{32,,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 missing and recreated in the @code{'r'} and @code{'w'}
modes (this will be an error in future Python releases).
(Contributed by Serhiy Storchaka in bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}.)

@node enum<6>,gettext<2>,dbm<3>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id5}@anchor{bff}
@subsubsection enum


In Python 3.8, attempting to check for non-Enum objects in @ref{630,,Enum}
classes will raise a @ref{2c3,,TypeError} (e.g. @code{1 in Color}); similarly,
attempting to check for non-Flag objects in a @ref{623,,Flag} member will
raise @ref{2c3,,TypeError} (e.g. @code{1 in Perm.RW}); currently, both operations
return @ref{b49,,False} instead.
(Contributed by Ethan Furman in bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}.)

@node gettext<2>,importlib<5>,enum<6>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 gettext}@anchor{c00}
@subsubsection gettext


Using non-integer value for selecting a plural form in @ref{63,,gettext} is
now deprecated.  It never correctly worked. (Contributed by Serhiy Storchaka
in bpo-28692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28692}.)

@node importlib<5>,locale<5>,gettext<2>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id6}@anchor{c01}
@subsubsection importlib


Methods
@code{MetaPathFinder.find_module()}
(replaced by
@ref{86c,,MetaPathFinder.find_spec()})
and
@code{PathEntryFinder.find_loader()}
(replaced by
@ref{870,,PathEntryFinder.find_spec()})
both deprecated in Python 3.4 now emit @ref{1a5,,DeprecationWarning}.
(Contributed by Matthias Bussonnier in bpo-29576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29576}.)

The @ref{c02,,importlib.abc.ResourceLoader} ABC has been deprecated in
favour of @ref{b10,,importlib.abc.ResourceReader}.

@node locale<5>,macpath,importlib<5>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id7}@anchor{c03}
@subsubsection locale


@code{locale.format()} has been deprecated, use @ref{51f,,locale.format_string()}
instead.  (Contributed by Garvit in bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}.)

@node macpath,threading<5>,locale<5>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 macpath}@anchor{c04}
@subsubsection macpath


The @code{macpath} is now deprecated and will be removed in Python 3.8.
(Contributed by Chi Hsuan Yen in bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}.)

@node threading<5>,socket<6>,macpath,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 threading}@anchor{c05}
@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<6>,ssl<6>,threading<5>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id8}@anchor{c06}
@subsubsection socket


The silent argument value truncation in @ref{883,,socket.htons()} and
@ref{884,,socket.ntohs()} has been deprecated.  In future versions of Python,
if the passed argument is larger than 16 bits, an exception will be raised.
(Contributed by Oren Milman in bpo-28332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28332}.)

@node ssl<6>,sunau,socket<6>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id9}@anchor{c07}
@subsubsection ssl


@code{ssl.wrap_socket()} is deprecated.  Use
@ref{525,,ssl.SSLContext.wrap_socket()} instead.
(Contributed by Christian Heimes in bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}.)

@node sunau,sys<9>,ssl<6>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 sunau}@anchor{c08}
@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<9>,wave,sunau,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 id10}@anchor{c09}
@subsubsection sys


Deprecated @code{sys.set_coroutine_wrapper()} and
@code{sys.get_coroutine_wrapper()}.

The undocumented @code{sys.callstats()} function has been deprecated and
will be removed in a future Python version.
(Contributed by Victor Stinner in bpo-28799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28799}.)

@node wave,,sys<9>,Deprecated Python modules functions and methods
@anchor{whatsnew/3 7 wave}@anchor{c0a}
@subsubsection wave


@code{wave.openfp()} has been deprecated and will be removed in Python 3.9.
Use @ref{952,,wave.open()} instead.
(Contributed by Brian Curtin in bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}.)

@node Deprecated functions and types of the C API,Platform Support Removals,Deprecated Python modules functions and methods,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 deprecated-functions-and-types-of-the-c-api}@anchor{c0b}
@subsection Deprecated functions and types of the C API


Function @ref{3fc,,PySlice_GetIndicesEx()} is deprecated and replaced with
a macro if @code{Py_LIMITED_API} is not set or set to a value in the range
between @code{0x03050400} and @code{0x03060000} (not inclusive), or is @code{0x03060100}
or higher.  (Contributed by Serhiy Storchaka in bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@ref{3fa,,PyOS_AfterFork()} has been deprecated.  Use @ref{bd8,,PyOS_BeforeFork()},
@ref{bd9,,PyOS_AfterFork_Parent()} or @ref{3fb,,PyOS_AfterFork_Child()} instead.
(Contributed by Antoine Pitrou in bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}.)

@node Platform Support Removals,Remoção de APIs e recursos<2>,Deprecated functions and types of the C API,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 id11}@anchor{c0c}@anchor{whatsnew/3 7 platform-support-removals}@anchor{b96}
@subsection Platform Support Removals



@itemize *

@item 
FreeBSD 9 and older are no longer officially supported.

@item 
For full Unicode support, including within extension modules, *nix platforms
are now expected to provide at least one of @code{C.UTF-8} (full locale),
@code{C.utf8} (full locale) or @code{UTF-8} (@code{LC_CTYPE}-only locale) as an
alternative to the legacy @code{ASCII}-based @code{C} locale.

@item 
OpenSSL 0.9.8 and 1.0.1 are no longer supported, which means building CPython
3.7 with SSL/TLS support on older platforms still using these versions
requires custom build options that link to a more recent version of OpenSSL.

Notably, this issue affects the Debian 8 (aka “jessie”) and Ubuntu 14.04
(aka “Trusty”) LTS Linux distributions, as they still use OpenSSL 1.0.1 by
default.

Debian 9 (“stretch”) and Ubuntu 16.04 (“xenial”), as well as recent releases
of other LTS Linux releases (e.g. RHEL/CentOS 7.5, SLES 12-SP3), use OpenSSL
1.0.2 or later, and remain supported in the default build configuration.

CPython’s own CI configuration file@footnote{https://github.com/python/cpython/blob/v3.7.13/.travis.yml} provides an
example of using the SSL
compatibility testing infrastructure@footnote{https://github.com/python/cpython/tree/3.13/Tools/ssl/multissltests.py} in
CPython’s test suite to build and link against OpenSSL 1.1.0 rather than an
outdated system provided OpenSSL.
@end itemize

@node Remoção de APIs e recursos<2>,Module Removals,Platform Support Removals,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 api-and-feature-removals}@anchor{c0d}
@subsection Remoção de APIs e recursos


The following features and APIs have been removed from Python 3.7:


@itemize *

@item 
The @code{os.stat_float_times()} function has been removed. It was introduced in
Python 2.3 for backward compatibility with Python 2.2, and was deprecated
since Python 3.1.

@item 
Unknown escapes consisting of @code{'\'} and an ASCII letter in replacement
templates for @ref{2a3,,re.sub()} were deprecated in Python 3.5, and will now
cause an error.

@item 
Removed support of the `exclude' argument in @ref{c0e,,tarfile.TarFile.add()}.
It was deprecated in Python 2.7 and 3.2.  Use the `filter' argument instead.

@item 
The @code{ntpath.splitunc()} function was deprecated in
Python 3.1, and has now been removed.  Use @ref{c0f,,splitdrive()}
instead.

@item 
@ref{1ca,,collections.namedtuple()} no longer supports the `verbose' parameter
or @code{_source} attribute which showed the generated source code for the
named tuple class.  This was part of an optimization designed to speed-up
class creation.  (Contributed by Jelle Zijlstra with further improvements
by INADA Naoki, Serhiy Storchaka, and Raymond Hettinger in bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}.)

@item 
Functions @ref{468,,bool()}, @ref{2f7,,float()}, @ref{611,,list()} and @ref{370,,tuple()} no
longer take keyword arguments.  The first argument of @ref{257,,int()} can now
be passed only as positional argument.

@item 
Removed previously deprecated in Python 2.4 classes @code{Plist}, @code{Dict} and
@code{_InternalDict} in the @ref{ab,,plistlib} module.  Dict values in the result
of functions @code{readPlist()} and
@code{readPlistFromBytes()} are now normal dicts.  You no longer
can use attribute access to access items of these dictionaries.

@item 
The @code{asyncio.windows_utils.socketpair()} function has been
removed.  Use the @ref{c10,,socket.socketpair()} function instead,
it is available on all platforms since Python 3.5.
@code{asyncio.windows_utils.socketpair} was just an alias to
@code{socket.socketpair} on Python 3.5 and newer.

@item 
@ref{a,,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 
Direct instantiation of @ref{8f0,,ssl.SSLSocket} and @ref{b99,,ssl.SSLObject}
objects is now prohibited. The constructors were never documented, tested,
or designed as public constructors.  Users were supposed to use
@code{ssl.wrap_socket()} or @ref{294,,ssl.SSLContext}.
(Contributed by Christian Heimes in 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 Module Removals,Windows-only Changes,Remoção de APIs e recursos<2>,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 module-removals}@anchor{c11}
@subsection Module Removals


The @code{fpectl} module 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.
(Contributed by Nathaniel J. Smith in bpo-29137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29137}.)

@node Windows-only Changes,Porting to Python 3 7,Module Removals,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 windows-only-changes}@anchor{c12}
@subsection Windows-only Changes


The python launcher, (py.exe), can accept 32 & 64 bit specifiers `without'
having to specify a minor version as well. So @code{py -3-32} and @code{py -3-64}
become valid as well as @code{py -3.7-32}, also the -`m'-64 and -`m.n'-64 forms
are now accepted to force 64 bit python even if 32 bit would have otherwise
been used. If the specified version is not available py.exe will error exit.
(Contributed by Steve Barnes in bpo-30291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30291}.)

The launcher can be run as @code{py -0} to produce a list of the installed pythons,
`with default marked with an asterisk'. Running @code{py -0p} will include the paths.
If py is run with a version specifier that cannot be matched it will also print
the `short form' list of available specifiers.
(Contributed by Steve Barnes in bpo-30362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30362}.)

@node Porting to Python 3 7,Notable changes in Python 3 7 1,Windows-only Changes,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 porting-to-python-3-7}@anchor{c13}@anchor{whatsnew/3 7 porting-to-python-37}@anchor{ae1}
@subsection Porting to Python 3.7


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Changes in Python Behavior:: 
* Alterações na API Python: Alterações na API Python<7>. 
* Alterações na API C: Alterações na API C<12>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<7>. 
* Windows-only Changes: Windows-only Changes<2>. 
* Other CPython implementation changes:: 

@end menu

@node Changes in Python Behavior,Alterações na API Python<7>,,Porting to Python 3 7
@anchor{whatsnew/3 7 changes-in-python-behavior}@anchor{c14}
@subsubsection Changes in Python Behavior



@itemize *

@item 
@ref{732,,async} and @ref{1b9,,await} names are now reserved keywords.
Code using these names as identifiers will now raise a @ref{18d,,SyntaxError}.
(Contributed by Jelle Zijlstra in bpo-30406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30406}.)

@item 
@geindex Propostas de Melhorias do Python; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} is enabled for all code in Python 3.7, meaning that
@ref{c15,,StopIteration} exceptions raised directly or indirectly in
coroutines and generators are transformed into @ref{195,,RuntimeError}
exceptions.
(Contributed by Yury Selivanov in bpo-32670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32670}.)

@item 
@ref{c16,,object.__aiter__()} methods can no longer be declared as
asynchronous.  (Contributed by Yury Selivanov in bpo-31709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31709}.)

@item 
Due to an oversight, earlier Python versions erroneously accepted the
following syntax:

@example
f(1 for x in [1],)

class C(1 for x in [1]):
    pass
@end example

Python 3.7 now correctly raises a @ref{18d,,SyntaxError}, as a generator
expression always needs to be directly inside a set of parentheses
and cannot have a comma on either side, and the duplication of the
parentheses can be omitted only on calls.
(Contributed by Serhiy Storchaka in bpo-32012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32012} and bpo-32023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32023}.)

@item 
When using the @ref{5e1,,-m} switch, the initial working directory is now added
to @ref{3b4,,sys.path}, rather than an empty string (which dynamically denoted
the current working directory at the time of each import). Any programs that
are checking for the empty string, or otherwise relying on the previous
behaviour, will need to be updated accordingly (e.g. by also checking for
@code{os.getcwd()} or @code{os.path.dirname(__main__.__file__)}, depending on why
the code was checking for the empty string in the first place).
@end itemize

@node Alterações na API Python<7>,Alterações na API C<12>,Changes in Python Behavior,Porting to Python 3 7
@anchor{whatsnew/3 7 changes-in-the-python-api}@anchor{c17}
@subsubsection Alterações na API Python



@itemize *

@item 
@ref{b8e,,socketserver.ThreadingMixIn.server_close} now waits until all
non-daemon threads complete.  Set the new
@ref{b8f,,socketserver.ThreadingMixIn.block_on_close} class attribute to
@code{False} to get the pre-3.7 behaviour.
(Contributed by Victor Stinner in bpo-31233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31233} and bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}.)

@item 
@ref{b8e,,socketserver.ForkingMixIn.server_close} now waits until all
child processes complete. Set the new
@ref{b8f,,socketserver.ForkingMixIn.block_on_close} class attribute to @code{False}
to get the pre-3.7 behaviour.
(Contributed by Victor Stinner in bpo-31151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31151} and bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}.)

@item 
The @ref{c18,,locale.localeconv()} function now temporarily sets the @code{LC_CTYPE}
locale to the value of @code{LC_NUMERIC} in some cases.
(Contributed by Victor Stinner in bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}.)

@item 
@ref{c19,,pkgutil.walk_packages()} now raises a @ref{202,,ValueError} if `path' is
a string.  Previously an empty list was returned.
(Contributed by Sanyam Khurana in bpo-24744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24744}.)

@item 
A format string argument for @ref{c1a,,string.Formatter.format()}
is now @ref{a8f,,positional-only}.
Passing it as a keyword argument was deprecated in Python 3.5. (Contributed
by Serhiy Storchaka in bpo-29193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29193}.)

@item 
Attributes @ref{c1b,,key},
@ref{c1c,,value} and
@ref{c1d,,coded_value} of class
@ref{c1e,,http.cookies.Morsel} are now read-only.
Assigning to them was deprecated in Python 3.5.
Use the @ref{c1f,,set()} method for setting them.
(Contributed by Serhiy Storchaka in bpo-29192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29192}.)

@item 
The `mode' argument of @ref{21e,,os.makedirs()} no longer affects the file
permission bits of newly created intermediate-level directories.
To set their file permission bits you can set the umask before invoking
@code{makedirs()}.
(Contributed by Serhiy Storchaka in bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}.)

@item 
The @ref{c20,,struct.Struct.format} type is now @ref{44c,,str} instead of
@ref{1c2,,bytes}. (Contributed by Victor Stinner in 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 
Due to internal changes in @ref{cc,,socket}, calling @ref{c21,,socket.fromshare()}
on a socket created by @ref{c22,,socket.share} in older
Python versions is not supported.

@item 
@code{repr} for @ref{5bb,,BaseException} has changed to not include the trailing
comma.  Most exceptions are affected by this change.
(Contributed by Serhiy Storchaka in bpo-30399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30399}.)

@item 
@code{repr} for @ref{9d7,,datetime.timedelta} has changed to include the keyword
arguments in the output. (Contributed by Utkarsh Upadhyay in bpo-30302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30302}.)

@item 
Because @ref{301,,shutil.rmtree()} is now implemented using the @ref{a68,,os.scandir()}
function, the user specified handler `onerror' is now called with the first
argument @code{os.scandir} instead of @code{os.listdir} when listing the directory
is failed.

@item 
Support for nested sets and set operations in regular expressions as in
Unicode Technical Standard #18@footnote{https://unicode.org/reports/tr18/} might be added in the future.  This would
change the syntax.  To facilitate this future change a @ref{415,,FutureWarning}
will be raised in ambiguous cases for the time being.
That include sets starting with a literal @code{'['} or containing literal
character sequences @code{'--'}, @code{'&&'}, @code{'~~'}, and @code{'||'}.  To
avoid a warning, escape them with a backslash.
(Contributed by Serhiy Storchaka in bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}.)

@item 
The result of splitting a string on a @ref{b9,,regular expression}
that could match an empty string has been changed.  For example
splitting on @code{r'\s*'} will now split not only on whitespaces as it
did previously, but also on empty strings before all non-whitespace
characters and just before the end of the string.
The previous behavior can be restored by changing the pattern
to @code{r'\s+'}.  A @ref{415,,FutureWarning} was emitted for such patterns since
Python 3.5.

For patterns that match both empty and non-empty strings, the result of
searching for all matches may also be changed in other cases.  For example
in the string @code{'a\n\n'}, the pattern @code{r'(?m)^\s*?$'} will not only
match empty strings at positions 2 and 3, but also the string @code{'\n'} at
positions 2–3.  To match only blank lines, the pattern should be rewritten
as @code{r'(?m)^[^\S\n]*$'}.

@ref{2a3,,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’).

(Contributed by Serhiy Storchaka in bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054} and bpo-32308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32308}.)

@item 
Change @ref{c23,,re.escape()} to only escape regex special characters instead
of escaping all characters other than ASCII letters, numbers, and @code{'_'}.
(Contributed by Serhiy Storchaka in bpo-29995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29995}.)

@item 
@ref{bae,,tracemalloc.Traceback} frames are now sorted from oldest to most
recent to be more consistent with @ref{fe,,traceback}.
(Contributed by Jesse Bakker in bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}.)

@item 
On OSes that support @ref{c24,,socket.SOCK_NONBLOCK} or
@ref{c25,,socket.SOCK_CLOEXEC} bit flags, the
@ref{c26,,socket.type} no longer has them applied.
Therefore, checks like @code{if sock.type == socket.SOCK_STREAM}
work as expected on all platforms.
(Contributed by Yury Selivanov in bpo-32331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32331}.)

@item 
On Windows the default for the `close_fds' argument of
@ref{199,,subprocess.Popen} was changed from @ref{b49,,False} to @ref{c27,,True}
when redirecting the standard handles. If you previously depended on handles
being inherited when using @ref{199,,subprocess.Popen} with standard io
redirection, you will have to pass @code{close_fds=False} to preserve the
previous behaviour, or use
@ref{c28,,STARTUPINFO.lpAttributeList}.

@item 
@ref{c29,,importlib.machinery.PathFinder.invalidate_caches()} – which implicitly
affects @ref{c2a,,importlib.invalidate_caches()} – now deletes entries
in @ref{5e4,,sys.path_importer_cache} which are set to @code{None}.
(Contributed by Brett Cannon in bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}.)

@item 
In @ref{a,,asyncio},
@ref{c2b,,loop.sock_recv()},
@ref{c2c,,loop.sock_sendall()},
@ref{c2d,,loop.sock_accept()},
@ref{c2e,,loop.getaddrinfo()},
@ref{c2f,,loop.getnameinfo()}
have been changed to be proper coroutine methods to match their
documentation.  Previously, these methods returned @ref{be6,,asyncio.Future}
instances.
(Contributed by Yury Selivanov in bpo-32327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32327}.)

@item 
@ref{c30,,asyncio.Server.sockets} now returns a copy of the internal list
of server sockets, instead of returning it directly.
(Contributed by Yury Selivanov in bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}.)

@item 
@ref{c20,,Struct.format} is now a @ref{44c,,str} instance
instead of a @ref{1c2,,bytes} instance.
(Contributed by Victor Stinner in bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071}.)

@item 
@ref{6,,argparse} subparsers can now be made mandatory by passing @code{required=True}
to @ref{c31,,ArgumentParser.add_subparsers()}.
(Contributed by Anthony Sottile in bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510}.)

@item 
@ref{c32,,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{c33,,Calendar.itermonthdates}
will now consistently raise an exception when a date falls outside of the
@code{0001-01-01} through @code{9999-12-31} range.  To support applications that
cannot tolerate such exceptions, the new
@ref{c34,,Calendar.itermonthdays3} and
@ref{c35,,Calendar.itermonthdays4} can be used.
The new methods return tuples and are not restricted by the range supported by
@ref{1cd,,datetime.date}.
(Contributed by Alexander Belopolsky in bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}.)

@item 
@ref{c36,,collections.ChainMap} now preserves the order of the underlying
mappings.  (Contributed by Raymond Hettinger in bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}.)

@item 
The @code{submit()} method of @ref{742,,concurrent.futures.ThreadPoolExecutor}
and @ref{8f4,,concurrent.futures.ProcessPoolExecutor} now raises
a @ref{195,,RuntimeError} if called during interpreter shutdown.
(Contributed by Mark Nemec in bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}.)

@item 
The @ref{1c8,,configparser.ConfigParser} constructor now uses @code{read_dict()}
to process the default values, 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.
(Contributed by James Tocknell in bpo-23835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23835}.)

@item 
Several undocumented internal imports were removed.
One example is that @code{os.errno} is no longer available; use @code{import errno}
directly instead.
Note that such undocumented internal imports may be removed any time without
notice, even in micro version releases.
@end itemize

@node Alterações na API C<12>,Alterações de bytecode do CPython<7>,Alterações na API Python<7>,Porting to Python 3 7
@anchor{whatsnew/3 7 changes-in-the-c-api}@anchor{c37}
@subsubsection Alterações na API C


The function @ref{3fc,,PySlice_GetIndicesEx()} is considered unsafe for
resizable sequences.  If the slice indices are not instances of @ref{257,,int},
but objects that implement the @code{__index__()} method, the sequence can be
resized after passing its length to @code{PySlice_GetIndicesEx()}.  This
can lead to returning indices out of the length of the sequence.  For
avoiding possible problems use new functions @ref{3fd,,PySlice_Unpack()} and
@ref{3fe,,PySlice_AdjustIndices()}.
(Contributed by Serhiy Storchaka in bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}.)

@node Alterações de bytecode do CPython<7>,Windows-only Changes<2>,Alterações na API C<12>,Porting to Python 3 7
@anchor{whatsnew/3 7 cpython-bytecode-changes}@anchor{c38}
@subsubsection Alterações de bytecode do CPython


There are two new opcodes: @ref{c39,,LOAD_METHOD} and @code{CALL_METHOD}.
(Contributed by Yury Selivanov and INADA Naoki in bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}.)

The @code{STORE_ANNOTATION} opcode has been removed.
(Contributed by Mark Shannon in bpo-32550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32550}.)

@node Windows-only Changes<2>,Other CPython implementation changes,Alterações de bytecode do CPython<7>,Porting to Python 3 7
@anchor{whatsnew/3 7 id12}@anchor{c3a}
@subsubsection Windows-only Changes


The file used to override @ref{3b4,,sys.path} is now called
@code{<python-executable>._pth} instead of @code{'sys.path'}.
See @ref{c3b,,Encontrando módulos} for more information.
(Contributed by Steve Dower in bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}.)

@node Other CPython implementation changes,,Windows-only Changes<2>,Porting to Python 3 7
@anchor{whatsnew/3 7 id13}@anchor{c3c}
@subsubsection Other CPython implementation changes


In preparation for potential future changes to the public CPython runtime
initialization API (see 
@geindex Propostas de Melhorias do Python; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/} for an initial, but somewhat outdated,
draft), CPython’s internal startup
and configuration management logic has been significantly refactored. While
these updates are intended to be entirely transparent to both embedding
applications and users of the regular CPython CLI, they’re being mentioned
here as the refactoring changes the internal order of various operations
during interpreter startup, and hence may uncover previously latent defects,
either in embedding applications, or in CPython itself.
(Initially contributed by Nick Coghlan and Eric Snow as part of
bpo-22257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22257}, and further updated by Nick, Eric, and Victor Stinner in a
number of other issues). Some known details affected:


@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

Due to changes in the way the default warnings filters are configured,
setting @ref{3d4,,Py_BytesWarningFlag} to a value greater than one is no longer
sufficient to both emit @ref{c3d,,BytesWarning} messages and have them converted
to exceptions.  Instead, the flag must be set (to cause the warnings to be
emitted in the first place), and an explicit @code{error::BytesWarning}
warnings filter added to convert them to exceptions.

Due to a change in the way docstrings are handled by the compiler, the
implicit @code{return None} in a function body consisting solely of a docstring
is now marked as occurring on the same line as the docstring, not on the
function’s header line.

The current exception state has been moved from the frame object to the co-routine.
This simplified the interpreter and fixed a couple of obscure bugs caused by
having swap exception state when entering or exiting a generator.
(Contributed by Mark Shannon in bpo-25612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25612}.)

@node Notable changes in Python 3 7 1,Notable changes in Python 3 7 2,Porting to Python 3 7,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-1}@anchor{c3e}
@subsection Notable changes in Python 3.7.1


Starting in 3.7.1, @ref{8b1,,Py_Initialize()} now consistently reads and respects
all of the same environment settings as @ref{c3f,,Py_Main()} (in earlier Python
versions, it respected an ill-defined subset of those environment variables,
while in Python 3.7.0 it didn’t read any of them due to bpo-34247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34247}). If
this behavior is unwanted, set @ref{3d8,,Py_IgnoreEnvironmentFlag} to 1 before
calling @ref{8b1,,Py_Initialize()}.

In 3.7.1 the C API for Context Variables
@ref{c40,,was updated} to use
@ref{339,,PyObject} pointers.  See also bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762}.

In 3.7.1 the @ref{fb,,tokenize} module now implicitly emits a @code{NEWLINE} token
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 in bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node Notable changes in Python 3 7 2,Notable changes in Python 3 7 6,Notable changes in Python 3 7 1,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-2}@anchor{c41}
@subsection Notable changes in Python 3.7.2


In 3.7.2, @ref{111,,venv} on Windows no longer copies the original binaries, but
creates redirector scripts named @code{python.exe} and @code{pythonw.exe} instead.
This resolves a long standing issue where all virtual environments would have
to be upgraded or recreated with each Python update. However, note that this
release will still require recreation of virtual environments in order to get
the new scripts.

@node Notable changes in Python 3 7 6,Notable changes in Python 3 7 10,Notable changes in Python 3 7 2,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-6}@anchor{c42}
@subsection Notable changes in Python 3.7.6


Devido a significativas preocupações de segurança, o parâmetro `reuse_address' de @ref{733,,asyncio.loop.create_datagram_endpoint()} não é mais suportado. Isso ocorre devido ao comportamento da opção de soquete @code{SO_REUSEADDR} no UDP. Para mais detalhes, consulte a documentação de @code{loop.create_datagram_endpoint()}. (Contribuição de Kyle Stanley, Antoine Pitrou e Yury Selivanov em bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Notable changes in Python 3 7 10,Notable changes in Python 3 7 11,Notable changes in Python 3 7 6,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-10}@anchor{c43}
@subsection Notable changes in Python 3.7.10


Versões anteriores do Python permitiam o uso de @code{;} e @code{&} como separadores de parâmetros de consulta nas funções @ref{27a,,urllib.parse.parse_qs()} e @ref{279,,urllib.parse.parse_qsl()}. Devido a questões de segurança, e em conformidade com as recomendações mais recentes do W3C, isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como padrão. Esta mudança também afeta as funções @code{cgi.parse()} e @code{cgi.parse_multipart()} já que elas usam as funções afetadas internamente. Para obter mais detalhes, consulte sua respectiva documentação. (Contribuição de Adam Goldschmidt, Senthil Kumaran e Ken Jin em 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,Notable changes in Python 3 7 10,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-11}@anchor{c44}
@subsection Notable changes in Python 3.7.11


Uma correção de segurança altera o comportamento @ref{900,,ftplib.FTP} para não confiar no endereço IPv4 enviado do servidor remoto ao configurar um canal de dados passivo. Em vez disso, reutilizamos o endereço IP do servidor ftp. Para códigos incomuns que requerem o comportamento antigo, defina um atributo @code{trust_server_pasv_ipv4_address} em sua instância de FTP para @code{True}. (Veja 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,O que há de novo no Python 3 7
@anchor{whatsnew/3 7 notable-security-feature-in-3-7-14}@anchor{c45}
@subsection Notable security feature in 3.7.14


Converter entre @ref{257,,int} e @ref{44c,,str} em bases diferentes de 2 (binário), 4, 8 (octal), 16 (hexadecimal) ou 32 como base 10 (decimal) agora levanta uma exceção @ref{202,,ValueError} se o número de dígitos em forma de string estiver acima de um limite para evitar possíveis ataques de negação de serviço devido à complexidade algorítmica. Esta é uma mitigação para 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}. Este limite pode ser configurado ou desabilitado por variável de ambiente, sinalizador de linha de comando ou APIs de @ref{d9,,sys}. Veja a documentação de @ref{5f5,,limitação de comprimento de conversão de string inteira}. O limite padrão é de 4300 dígitos em forma de string.

@node What’s New In Python 3 6,O que há de novo no Python 3 5,O que há de novo no Python 3 7,O que há de novo no Python
@anchor{whatsnew/3 6 doc}@anchor{c46}@anchor{whatsnew/3 6 translation-repo}@anchor{c47}@anchor{whatsnew/3 6 what-s-new-in-python-3-6}@anchor{c48}
@section What’s New In Python 3.6


@*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.

This article explains the new features in Python 3.6, compared to 3.5.
Python 3.6 was released on December 23, 2016.  See the
changelog@footnote{https://docs.python.org/3.6/whatsnew/changelog.html} for a full
list of changes.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 494
PEP 494@footnote{https://peps.python.org/pep-0494/} - Python 3.6 Release Schedule


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<8>. 
* Novas funcionalidades: Novas funcionalidades<13>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<8>. 
* Novos módulos: Novos módulos<8>. 
* Módulos melhorados: Módulos melhorados<8>. 
* Otimizações: Otimizações<8>. 
* Mudanças a construções e API C: Mudanças a construções e API C<2>. 
* Other Improvements:: 
* Descontinuados: Descontinuados<9>. 
* Removidos: Removidos<9>. 
* Porting to Python 3.6: Porting to Python 3 6. 
* Notable changes in Python 3.6.2: Notable changes in Python 3 6 2. 
* Notable changes in Python 3.6.4: Notable changes in Python 3 6 4. 
* Notable changes in Python 3.6.5: Notable changes in Python 3 6 5. 
* Notable changes in Python 3.6.7: Notable changes in Python 3 6 7. 
* Notable changes in Python 3.6.10: Notable changes in Python 3 6 10. 
* Notable changes in Python 3.6.13: Notable changes in Python 3 6 13. 
* Notable changes in Python 3.6.14: Notable changes in Python 3 6 14. 

@end menu

@node Resumo – Destaques da versão<8>,Novas funcionalidades<13>,,What’s New In Python 3 6
@anchor{whatsnew/3 6 summary-release-highlights}@anchor{c49}
@subsection Resumo – Destaques da versão


Novos recursos de sintaxe:


@itemize *

@item 
@ref{c4a,,PEP 498}, formatted string literals.

@item 
@ref{c4b,,PEP 515}, underscores in numeric literals.

@item 
@ref{c4c,,PEP 526}, syntax for variable annotations.

@item 
@ref{c4d,,PEP 525}, asynchronous generators.

@item 
@ref{c4e,,PEP 530}: asynchronous comprehensions.
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@ref{c0,,secrets}: @ref{c4f,,PEP 506 – Adding A Secrets Module To The Standard Library}.
@end itemize

Melhorias na implementação do CPython:


@itemize *

@item 
The @ref{ad6,,dict} type has been reimplemented to use a @ref{c50,,more compact representation} based on a proposal by Raymond Hettinger@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html} and similar to the PyPy dict implementation@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}. This resulted in dictionaries using 20% to 25% less memory when compared to Python 3.5.

@item 
Customization of class creation has been simplified with the
@ref{c51,,new protocol}.

@item 
The class attribute definition order is @ref{c52,,now preserved}.

@item 
The order of elements in @code{**kwargs} now
@ref{c53,,corresponds to the order} in which keyword
arguments were passed to the function.

@item 
DTrace and SystemTap @ref{c54,,probing support} has
been added.

@item 
The new @ref{c55,,PYTHONMALLOC} environment variable
can now be used to debug the interpreter memory allocation and access
errors.
@end itemize

Melhorias significativas na biblioteca padrão:


@itemize *

@item 
The @ref{a,,asyncio} module has received new features, significant
usability and performance improvements, and a fair amount of bug fixes.
Starting with Python 3.6 the @code{asyncio} module is no longer provisional
and its API is considered stable.

@item 
A new @ref{c56,,file system path protocol} has been
implemented to support @ref{2a0,,path-like objects}.
All standard library functions operating on paths have been updated to
work with the new protocol.

@item 
The @ref{30,,datetime} module has gained support for
@ref{c57,,Local Time Disambiguation}.

@item 
The @ref{104,,typing} module received a number of
@ref{c58,,improvements}.

@item 
The @ref{ff,,tracemalloc} module has been significantly reworked
and is now used to provide better output for @ref{244,,ResourceWarning}
as well as provide better diagnostics for memory allocation errors.
See the @ref{c55,,PYTHONMALLOC section} for more
information.
@end itemize

Melhorias de Segurança:


@itemize *

@item 
The new @ref{c0,,secrets} module has been added to simplify the generation of
cryptographically strong pseudo-random numbers suitable for
managing secrets such as account authentication, tokens, and similar.

@item 
On Linux, @ref{523,,os.urandom()} now blocks until the system urandom entropy
pool is initialized to increase the security. See the 
@geindex Propostas de Melhorias do Python; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} for the
rationale.

@item 
The @ref{68,,hashlib} and @ref{d0,,ssl} modules now support OpenSSL 1.1.0.

@item 
The default settings and feature set of the @ref{d0,,ssl} module have been
improved.

@item 
The @ref{68,,hashlib} module received support for the BLAKE2, SHA-3 and SHAKE
hash algorithms and the @ref{c59,,scrypt()} key derivation function.
@end itemize

Melhorias do Windows:


@itemize *

@item 
@ref{c5a,,PEP 528} and @ref{c5b,,PEP 529},
Windows filesystem and console encoding changed to UTF-8.

@item 
The @code{py.exe} launcher, when used interactively, no longer prefers Python 2 over Python 3 when the user doesn’t specify a version (via command line arguments or a config file). Handling of shebang lines remains unchanged - “python” refers to Python 2 in that case.

@item 
@code{python.exe} and @code{pythonw.exe} have been marked as long-path aware,
which means that the 260 character path limit may no longer apply.
See @ref{c5c,,removing the MAX_PATH limitation} for details.

@item 
A @code{._pth} file can be added to force isolated mode and fully specify
all search paths to avoid registry and environment lookup. See
@ref{c3b,,the documentation} for more information.

@item 
A @code{python36.zip} file now works as a landmark to infer
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}. See @ref{c3b,,the documentation} for
more information.
@end itemize

@node Novas funcionalidades<13>,Outras mudanças na linguagem<8>,Resumo – Destaques da versão<8>,What’s New In Python 3 6
@anchor{whatsnew/3 6 new-features}@anchor{c5d}@anchor{whatsnew/3 6 pypy-dict-implementation}@anchor{c5e}
@subsection Novas funcionalidades


@menu
* PEP 498; Formatted string literals: PEP 498 Formatted string literals. 
* PEP 526; Syntax for variable annotations: PEP 526 Syntax for variable annotations. 
* PEP 515; Underscores in Numeric Literals: PEP 515 Underscores in Numeric Literals. 
* PEP 525; Asynchronous Generators: PEP 525 Asynchronous Generators. 
* PEP 530; Asynchronous Comprehensions: PEP 530 Asynchronous Comprehensions. 
* PEP 487; Simpler customization of class creation: PEP 487 Simpler customization of class creation. 
* PEP 487; Descriptor Protocol Enhancements: PEP 487 Descriptor Protocol Enhancements. 
* PEP 519; Adding a file system path protocol: PEP 519 Adding a file system path protocol. 
* PEP 495; Local Time Disambiguation: PEP 495 Local Time Disambiguation. 
* PEP 529; Change Windows filesystem encoding to UTF-8: PEP 529 Change Windows filesystem encoding to UTF-8. 
* PEP 528; Change Windows console encoding to UTF-8: PEP 528 Change Windows console encoding to UTF-8. 
* PEP 520; Preserving Class Attribute Definition Order: PEP 520 Preserving Class Attribute Definition Order. 
* PEP 468; Preserving Keyword Argument Order: PEP 468 Preserving Keyword Argument Order. 
* New dict implementation:: 
* PEP 523; Adding a frame evaluation API to CPython: PEP 523 Adding a frame evaluation API to CPython. 
* PYTHONMALLOC environment variable:: 
* DTrace and SystemTap probing support:: 

@end menu

@node PEP 498 Formatted string literals,PEP 526 Syntax for variable annotations,,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-498-formatted-string-literals}@anchor{c5f}@anchor{whatsnew/3 6 whatsnew36-pep498}@anchor{c4a}
@subsubsection PEP 498: Formatted string literals


@geindex Propostas de Melhorias do Python; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} introduces a new kind of string literals: `f-strings', or
@ref{9b1,,formatted string literals}.

Formatted string literals are prefixed with @code{'f'} and are similar to the format strings accepted by @ref{621,,str.format()}. They contain replacement fields surrounded by curly braces. The replacement fields are expressions, which are evaluated at run time, and then formatted using the @ref{61f,,format()} protocol:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 498

@item PEP 498@footnote{https://peps.python.org/pep-0498/} – Literal String Interpolation.

PEP written and implemented by Eric V. Smith.
@end table

@ref{9b1,,Feature documentation}.


@node PEP 526 Syntax for variable annotations,PEP 515 Underscores in Numeric Literals,PEP 498 Formatted string literals,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-526-syntax-for-variable-annotations}@anchor{c60}@anchor{whatsnew/3 6 whatsnew36-pep526}@anchor{c4c}
@subsubsection PEP 526: Syntax for variable annotations


@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introduced the standard for type annotations of function
parameters, a.k.a. type hints. This PEP adds syntax to Python for annotating
the types of variables including class variables and instance variables:

@example
primes: List[int] = []

captain: str  # Note: no initial value!

class Starship:
    stats: Dict[str, int] = @{@}
@end example

Just as for function annotations, the Python interpreter does not attach any
particular meaning to variable annotations and only stores them in the
@code{__annotations__} attribute of a class or module.

In contrast to variable declarations in statically typed languages,
the goal of annotation syntax is to provide an easy way to specify structured
type metadata for third party tools and libraries via the abstract syntax tree
and the @code{__annotations__} attribute.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} – Syntax for variable annotations.

PEP written by Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa Roach,
and Guido van Rossum. Implemented by 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 Underscores in Numeric Literals,PEP 525 Asynchronous Generators,PEP 526 Syntax for variable annotations,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-515-underscores-in-numeric-literals}@anchor{c61}@anchor{whatsnew/3 6 whatsnew36-pep515}@anchor{c4b}
@subsubsection PEP 515: Underscores in Numeric Literals


@geindex Propostas de Melhorias do Python; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} adds the ability to use underscores in numeric literals for improved readability. For example:

@example
>>> 1_000_000_000_000_000
1000000000000000
>>> 0x_FF_FF_FF_FF
4294967295
@end example

Single underscores are allowed between digits and after any base specifier. Leading, trailing, or multiple underscores in a row are not allowed.

The @ref{1e8,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 515

@item PEP 515@footnote{https://peps.python.org/pep-0515/} – Underscores in Numeric Literals

PEP written by Georg Brandl and Serhiy Storchaka.
@end table


@node PEP 525 Asynchronous Generators,PEP 530 Asynchronous Comprehensions,PEP 515 Underscores in Numeric Literals,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-525-asynchronous-generators}@anchor{c62}@anchor{whatsnew/3 6 whatsnew36-pep525}@anchor{c4d}
@subsubsection PEP 525: Asynchronous Generators


@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} introduced support for native coroutines and @code{async} / @code{await} syntax to Python 3.5. A notable limitation of the Python 3.5 implementation is that it was not possible to use @code{await} and @code{yield} in the same function body. In Python 3.6 this restriction has been lifted, making it possible to define `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

The new syntax allows for faster and more concise code.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/} – Asynchronous Generators

PEP written and implemented by Yury Selivanov.
@end table


@node PEP 530 Asynchronous Comprehensions,PEP 487 Simpler customization of class creation,PEP 525 Asynchronous Generators,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-530-asynchronous-comprehensions}@anchor{c63}@anchor{whatsnew/3 6 whatsnew36-pep530}@anchor{c4e}
@subsubsection PEP 530: Asynchronous Comprehensions


@geindex Propostas de Melhorias do Python; PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/} adds support for using @code{async for} in list, set, dict
comprehensions and generator expressions:

@example
result = [i async for i in aiter() if i % 2]
@end example

Additionally, @code{await} expressions are supported in all kinds
of comprehensions:

@example
result = [await fun() for fun in funcs if await condition()]
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 530

@item PEP 530@footnote{https://peps.python.org/pep-0530/} – Asynchronous Comprehensions

PEP written and implemented by Yury Selivanov.
@end table


@node PEP 487 Simpler customization of class creation,PEP 487 Descriptor Protocol Enhancements,PEP 530 Asynchronous Comprehensions,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-487-simpler-customization-of-class-creation}@anchor{c64}@anchor{whatsnew/3 6 whatsnew36-pep487}@anchor{c51}
@subsubsection PEP 487: Simpler customization of class creation


It is now possible to customize subclass creation without using a metaclass.
The new @code{__init_subclass__} classmethod will be called on the base class
whenever a new subclass is created:

@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

In order to allow zero-argument @ref{4db,,super()} calls to work correctly from
@ref{631,,__init_subclass__()} implementations, custom metaclasses must
ensure that the new @code{__classcell__} namespace entry is propagated to
@code{type.__new__} (as described in @ref{c65,,Criando o objeto classe}).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/} – Simpler customization of class creation

PEP written and implemented by Martin Teichmann.
@end table

@ref{c66,,Feature documentation}


@node PEP 487 Descriptor Protocol Enhancements,PEP 519 Adding a file system path protocol,PEP 487 Simpler customization of class creation,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-487-descriptor-protocol-enhancements}@anchor{c67}@anchor{whatsnew/3 6 whatsnew36-pep487-descriptors}@anchor{c68}
@subsubsection PEP 487: Descriptor Protocol Enhancements


@geindex Propostas de Melhorias do Python; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} extends the descriptor protocol to include the new optional
@ref{c69,,__set_name__()} method.  Whenever a new class is defined, the new
method will be called on all descriptors included in the definition, providing
them with a reference to the class being defined and the name given to the
descriptor within the class namespace.  In other words, instances of
descriptors can now know the attribute name of the descriptor in the
owner class:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/} – Simpler customization of class creation

PEP written and implemented by Martin Teichmann.
@end table

@ref{c6a,,Feature documentation}


@node PEP 519 Adding a file system path protocol,PEP 495 Local Time Disambiguation,PEP 487 Descriptor Protocol Enhancements,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-519-adding-a-file-system-path-protocol}@anchor{c6b}@anchor{whatsnew/3 6 whatsnew36-pep519}@anchor{c56}
@subsubsection PEP 519: Adding a file system path protocol


File system paths have historically been represented as @ref{44c,,str}
or @ref{1c2,,bytes} objects. This has led to people who write code which
operate on file system paths to assume that such objects are only one
of those two types (an @ref{257,,int} representing a file descriptor
does not count as that is not a file path). Unfortunately that
assumption prevents alternative object representations of file system
paths like @ref{a4,,pathlib} from working with pre-existing code,
including Python’s standard library.

To fix this situation, a new interface represented by
@ref{c6c,,os.PathLike} has been defined. By implementing the
@ref{c6d,,__fspath__()} method, an object signals that it
represents a path. An object can then provide a low-level
representation of a file system path as a @ref{44c,,str} or
@ref{1c2,,bytes} object. This means an object is considered
@ref{2a0,,path-like} if it implements
@ref{c6c,,os.PathLike} or is a @ref{44c,,str} or @ref{1c2,,bytes} object
which represents a file system path. Code can use @ref{c6e,,os.fspath()},
@ref{c6f,,os.fsdecode()}, or @ref{c70,,os.fsencode()} to explicitly get a
@ref{44c,,str} and/or @ref{1c2,,bytes} representation of a path-like
object.

The built-in @ref{51c,,open()} function has been updated to accept
@ref{c6c,,os.PathLike} objects, as have all relevant functions in the
@ref{a1,,os} and @ref{a2,,os.path} modules, and most other functions and
classes in the standard library.  The @ref{49b,,os.DirEntry} class
and relevant classes in @ref{a4,,pathlib} have also been updated to
implement @ref{c6c,,os.PathLike}.

The hope is that updating the fundamental functions for operating
on file system paths will lead to third-party code to implicitly
support all @ref{2a0,,path-like objects} without any
code changes, or at least very minimal ones (e.g. calling
@ref{c6e,,os.fspath()} at the beginning of code before operating on a
path-like object).

Here are some examples of how the new interface allows for
@ref{229,,pathlib.Path} to be used more easily and transparently with
pre-existing code:

@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

(Implemented by Brett Cannon, Ethan Furman, Dusty Phillips, and Jelle Zijlstra.)


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 519

@item PEP 519@footnote{https://peps.python.org/pep-0519/} – Adding a file system path protocol

PEP written by Brett Cannon and Koos Zevenhoven.
@end table


@node PEP 495 Local Time Disambiguation,PEP 529 Change Windows filesystem encoding to UTF-8,PEP 519 Adding a file system path protocol,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-495-local-time-disambiguation}@anchor{c71}@anchor{whatsnew/3 6 whatsnew36-pep495}@anchor{c57}
@subsubsection PEP 495: Local Time Disambiguation


In most world locations, there have been and will be times when local clocks are moved back. In those times, intervals are introduced in which local clocks show the same time twice in the same day. In these situations, the information displayed on a local clock (or stored in a Python datetime instance) is insufficient to identify a particular moment in time.

@geindex Propostas de Melhorias do Python; PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} adds the new `fold' attribute to instances of
@ref{1cc,,datetime.datetime} and @ref{1ce,,datetime.time} classes to differentiate
between two moments in time for which local times are the same:

@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

The values of the @ref{c72,,fold} attribute have the
value @code{0} for all instances except those that represent the second
(chronologically) moment in time in an ambiguous case.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 495

@item PEP 495@footnote{https://peps.python.org/pep-0495/} – Local Time Disambiguation

PEP written by Alexander Belopolsky and Tim Peters, implementation
by Alexander Belopolsky.
@end table


@node PEP 529 Change Windows filesystem encoding to UTF-8,PEP 528 Change Windows console encoding to UTF-8,PEP 495 Local Time Disambiguation,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-529-change-windows-filesystem-encoding-to-utf-8}@anchor{c73}@anchor{whatsnew/3 6 whatsnew36-pep529}@anchor{c5b}
@subsubsection PEP 529: Change Windows filesystem encoding to UTF-8


Representing filesystem paths is best performed with str (Unicode) rather than
bytes. However, there are some situations where using bytes is sufficient and
correct.

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{c74,,sys.getfilesystemencoding()}, which now defaults to @code{'utf-8'}.

Applications that do not use str to represent paths should use
@ref{c70,,os.fsencode()} and @ref{c6f,,os.fsdecode()} to ensure their bytes are
correctly encoded. To revert to the previous behaviour, set
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} or call
@ref{2ae,,sys._enablelegacywindowsfsencoding()}.

See 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} for more information and discussion of code modifications that
may be required.

@node PEP 528 Change Windows console encoding to UTF-8,PEP 520 Preserving Class Attribute Definition Order,PEP 529 Change Windows filesystem encoding to UTF-8,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-528-change-windows-console-encoding-to-utf-8}@anchor{c75}@anchor{whatsnew/3 6 whatsnew36-pep528}@anchor{c5a}
@subsubsection PEP 528: Change Windows console encoding to UTF-8


The default console on Windows will now accept all Unicode characters and
provide correctly read str objects to Python code. @code{sys.stdin},
@code{sys.stdout} and @code{sys.stderr} now default to utf-8 encoding.

This change only applies when using an interactive console, and not when
redirecting files or pipes. To revert to the previous behaviour for interactive
console use, set 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@ref{c76,,PYTHONLEGACYWINDOWSSTDIO}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 528

@item PEP 528@footnote{https://peps.python.org/pep-0528/} – Change Windows console encoding to UTF-8

PEP written and implemented by Steve Dower.
@end table


@node PEP 520 Preserving Class Attribute Definition Order,PEP 468 Preserving Keyword Argument Order,PEP 528 Change Windows console encoding to UTF-8,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-520-preserving-class-attribute-definition-order}@anchor{c77}@anchor{whatsnew/3 6 whatsnew36-pep520}@anchor{c52}
@subsubsection PEP 520: Preserving Class Attribute Definition Order


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{c78,,__dict__} attribute.

Also, the effective default class `execution' namespace (returned from
@ref{c79,,type.__prepare__()}) is now an insertion-order-preserving
mapping.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 520

@item PEP 520@footnote{https://peps.python.org/pep-0520/} – Preserving Class Attribute Definition Order

PEP written and implemented by Eric Snow.
@end table


@node PEP 468 Preserving Keyword Argument Order,New dict implementation,PEP 520 Preserving Class Attribute Definition Order,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-468-preserving-keyword-argument-order}@anchor{c7a}@anchor{whatsnew/3 6 whatsnew36-pep468}@anchor{c53}
@subsubsection PEP 468: Preserving Keyword Argument Order


@code{**kwargs} in a function signature is now guaranteed to be an
insertion-order-preserving mapping.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 468

@item PEP 468@footnote{https://peps.python.org/pep-0468/} – Preserving Keyword Argument Order

PEP written and implemented by Eric Snow.
@end table


@node New dict implementation,PEP 523 Adding a frame evaluation API to CPython,PEP 468 Preserving Keyword Argument Order,Novas funcionalidades<13>
@anchor{whatsnew/3 6 new-dict-implementation}@anchor{c7b}@anchor{whatsnew/3 6 whatsnew36-compactdict}@anchor{c50}
@subsubsection New dict implementation


The @ref{ad6,,dict} type now uses a “compact” representation
based on a proposal by Raymond Hettinger@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html}
which was first implemented by PyPy@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}.
The memory usage of the new @ref{256,,dict()} is between 20% and 25% smaller
compared to Python 3.5.

The order-preserving aspect of this new implementation is considered an
implementation detail and should not be relied upon (this may change in
the future, but it is desired to have this new dict implementation in
the language for a few releases before changing the language spec to mandate
order-preserving semantics for all current and future Python
implementations; this also helps preserve backwards-compatibility
with older versions of the language where random iteration order is
still in effect, e.g. Python 3.5).

(Contributed by INADA Naoki in 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 Adding a frame evaluation API to CPython,PYTHONMALLOC environment variable,New dict implementation,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pep-523-adding-a-frame-evaluation-api-to-cpython}@anchor{c7c}@anchor{whatsnew/3 6 whatsnew36-pep523}@anchor{c7d}
@subsubsection PEP 523: Adding a frame evaluation API to CPython


While Python provides extensive support to customize how code executes, one place it has not done so is in the evaluation of frame objects. If you wanted some way to intercept frame evaluation in Python there really wasn’t any way without directly manipulating function pointers for defined functions.

@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} changes this by providing an API to make frame
evaluation pluggable at the C level. This will allow for tools such
as debuggers and JITs to intercept frame evaluation before the
execution of Python code begins. This enables the use of alternative
evaluation implementations for Python code, tracking frame
evaluation, etc.

This API is not part of the limited C API and is marked as private to
signal that usage of this API is expected to be limited and only
applicable to very select, low-level use-cases. Semantics of the
API will change with Python as necessary.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 523

@item PEP 523@footnote{https://peps.python.org/pep-0523/} – Adding a frame evaluation API to CPython

PEP written by Brett Cannon and Dino Viehland.
@end table


@node PYTHONMALLOC environment variable,DTrace and SystemTap probing support,PEP 523 Adding a frame evaluation API to CPython,Novas funcionalidades<13>
@anchor{whatsnew/3 6 pythonmalloc-environment-variable}@anchor{c7e}@anchor{whatsnew/3 6 whatsnew36-pythonmalloc}@anchor{c55}
@subsubsection PYTHONMALLOC environment variable


The new 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable allows setting the Python
memory allocators and installing debug hooks.

It is now possible to install debug hooks on Python memory allocators on Python
compiled in release mode using @code{PYTHONMALLOC=debug}. Effects of debug hooks:


@itemize *

@item 
Newly allocated memory is filled with the byte @code{0xCB}

@item 
Freed memory is filled with the byte @code{0xDB}

@item 
Detect violations of the Python memory allocator API. For example,
@ref{c80,,PyObject_Free()} called on a memory block allocated by
@ref{c81,,PyMem_Malloc()}.

@item 
Detect writes before the start of a buffer (buffer underflows)

@item 
Detect writes after the end of a buffer (buffer overflows)

@item 
Check that the @ref{148,,GIL} is held when allocator
functions of @ref{c82,,PYMEM_DOMAIN_OBJ} (ex: @ref{c83,,PyObject_Malloc()}) and
@ref{c84,,PYMEM_DOMAIN_MEM} (ex: @ref{c81,,PyMem_Malloc()}) domains are called.
@end itemize

Checking if the GIL is held is also a new feature of Python 3.6.

See the @ref{c85,,PyMem_SetupDebugHooks()} function for debug hooks on Python
memory allocators.

It is now also possible to force the usage of the @code{malloc()} allocator of
the C library for all Python memory allocations using @code{PYTHONMALLOC=malloc}.
This is helpful when using external memory debuggers like Valgrind on
a Python compiled in release mode.

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.

Example of fatal error on buffer overflow using
@code{python3.6 -X tracemalloc=5} (store 5 frames in traces):

@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

(Contributed by Victor Stinner in bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516} and bpo-26564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26564}.)

@node DTrace and SystemTap probing support,,PYTHONMALLOC environment variable,Novas funcionalidades<13>
@anchor{whatsnew/3 6 dtrace-and-systemtap-probing-support}@anchor{c86}@anchor{whatsnew/3 6 whatsnew36-tracing}@anchor{c54}
@subsubsection DTrace and SystemTap probing support


Python can now be built @code{--with-dtrace} which enables static markers
for the following events in the interpreter:


@itemize *

@item 
function call/return

@item 
garbage collection started/finished

@item 
line of code executed.
@end itemize

This can be used to instrument running interpreters in production,
without the need to recompile specific @ref{1f9,,debug builds} or
providing application-specific profiling/debugging code.

More details in @ref{c87,,Instrumentando o CPython com DTrace e SystemTap}.

The current implementation is tested on Linux and macOS. Additional markers may be added in the future.

(Contributed by Łukasz Langa in bpo-21590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21590}, based on patches by
Jesús Cea Avión, David Malcolm, and Nikhil Benesch.)

@node Outras mudanças na linguagem<8>,Novos módulos<8>,Novas funcionalidades<13>,What’s New In Python 3 6
@anchor{whatsnew/3 6 other-language-changes}@anchor{c88}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
A @code{global} or @code{nonlocal} statement must now textually appear
before the first use of the affected name in the same scope.
Previously this was a @ref{466,,SyntaxWarning}.

@item 
It is now possible to set a @ref{c89,,special method} to
@code{None} to indicate that the corresponding operation is not available.
For example, if a class sets @ref{c8a,,__iter__()} to @code{None}, the class
is not iterable.
(Contributed by Andrew Barnert and Ivan Levkivskyi in bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}.)

@item 
Long sequences of repeated traceback lines are now abbreviated as
@code{"[Previous line repeated @{count@} more times]"} (see
@ref{c8b,,traceback} for an example).
(Contributed by Emanuel Barry in bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@item 
Import now raises the new exception @ref{b5b,,ModuleNotFoundError} (subclass of @ref{419,,ImportError}) when it cannot find a module. Code that currently checks for ImportError (in try-except) will still work. (Contributed by Eric Snow in bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@item 
Class methods relying on zero-argument @code{super()} will now work correctly
when called from metaclass methods during class creation.
(Contributed by Martin Teichmann in bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}.)
@end itemize

@node Novos módulos<8>,Módulos melhorados<8>,Outras mudanças na linguagem<8>,What’s New In Python 3 6
@anchor{whatsnew/3 6 new-modules}@anchor{c8c}
@subsection Novos módulos


@menu
* segredos:: 

@end menu

@node segredos,,,Novos módulos<8>
@anchor{whatsnew/3 6 secrets}@anchor{c8d}@anchor{whatsnew/3 6 whatsnew36-pep506}@anchor{c4f}
@subsubsection segredos


The main purpose of the new @ref{c0,,secrets} module is to provide an obvious way
to reliably generate cryptographically strong pseudo-random values suitable
for managing secrets, such as account authentication, tokens, and similar.

@cartouche
@quotation Aviso 
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{523,,os.urandom()} on Python 3.5 and earlier.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 506

@item PEP 506@footnote{https://peps.python.org/pep-0506/} – Adding A Secrets Module To The Standard Library

PEP written and implemented by Steven D’Aprano.
@end table


@node Módulos melhorados<8>,Otimizações<8>,Novos módulos<8>,What’s New In Python 3 6
@anchor{whatsnew/3 6 improved-modules}@anchor{c8e}
@subsection Módulos melhorados


@menu
* array: array<4>. 
* ast: ast<4>. 
* asyncio: asyncio<9>. 
* binascii: binascii<2>. 
* cmath:: 
* collections: collections<4>. 
* concurrent.futures: concurrent futures<4>. 
* contextlib: contextlib<4>. 
* datetime: datetime<5>. 
* decimal: decimal<2>. 
* distutils: distutils<5>. 
* email: email<2>. 
* encodings: encodings<2>. 
* enum: enum<7>. 
* faulthandler: faulthandler<2>. 
* fileinput: fileinput<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib e IDLE: idlelib e IDLE<2>. 
* importlib: importlib<6>. 
* inspect: inspect<6>. 
* json:: 
* logging: logging<4>. 
* math: math<7>. 
* multiprocessing: multiprocessing<5>. 
* os: os<8>. 
* pathlib: pathlib<9>. 
* pdb: pdb<5>. 
* pickle: pickle<2>. 
* pickletools:: 
* pydoc: pydoc<3>. 
* random: random<4>. 
* re: re<5>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* site: site<3>. 
* sqlite3: sqlite3<7>. 
* socket: socket<7>. 
* socketserver: socketserver<2>. 
* ssl: ssl<7>. 
* statistics: statistics<5>. 
* struct:: 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* telnetlib:: 
* time: time<6>. 
* timeit:: 
* tkinter: tkinter<6>. 
* traceback: traceback<4>. 
* tracemalloc: tracemalloc<3>. 
* typing: typing<9>. 
* unicodedata: unicodedata<7>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* avisos: avisos<4>. 
* winreg:: 
* winsound:: 
* xmlrpc.client: xmlrpc client. 
* zipfile: zipfile<3>. 
* zlib:: 

@end menu

@node array<4>,ast<4>,,Módulos melhorados<8>
@anchor{whatsnew/3 6 array}@anchor{c8f}
@subsubsection array


Exhausted iterators of @ref{1a0,,array.array} will now stay exhausted even if the iterated array is extended. This is consistent with the behavior of other mutable sequences.

Contributed by Serhiy Storchaka in bpo-26492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26492}.

@node ast<4>,asyncio<9>,array<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 ast}@anchor{c90}
@subsubsection ast


The new @ref{2b9,,ast.Constant} AST node has been added. It can be used by external AST optimizers for the purposes of constant folding.

Contributed by Victor Stinner in bpo-26146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26146}.

@node asyncio<9>,binascii<2>,ast<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 asyncio}@anchor{c91}
@subsubsection asyncio


Starting with Python 3.6 the @code{asyncio} module is no longer provisional and its
API is considered stable.

Notable changes in the @ref{a,,asyncio} module since Python 3.5.0
(all backported to 3.5.x due to the provisional status):


@itemize *

@item 
The @ref{2c2,,get_event_loop()} function has been changed to
always return the currently running loop when called from coroutines
and callbacks.
(Contributed by Yury Selivanov in bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}.)

@item 
The @ref{c92,,ensure_future()} function and all functions that
use it, such as @ref{c93,,loop.run_until_complete()},
now accept all kinds of @ref{1ad,,awaitable objects}.
(Contributed by Yury Selivanov.)

@item 
New @ref{886,,run_coroutine_threadsafe()} function to submit
coroutines to event loops from other threads.
(Contributed by Vincent Michel.)

@item 
New @ref{c94,,Transport.is_closing()}
method to check if the transport is closing or closed.
(Contributed by Yury Selivanov.)

@item 
The @ref{b25,,loop.create_server()}
method can now accept a list of hosts.
(Contributed by Yann Sionneau.)

@item 
New @ref{c95,,loop.create_future()}
method to create Future objects.  This allows alternative event
loop implementations, such as
uvloop@footnote{https://github.com/MagicStack/uvloop}, to provide a faster
@ref{be6,,asyncio.Future} implementation.
(Contributed by Yury Selivanov in bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}.)

@item 
New @ref{c96,,loop.get_exception_handler()}
method to get the current exception handler.
(Contributed by Yury Selivanov in bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}.)

@item 
New @ref{1b4,,StreamReader.readuntil()}
method to read data from the stream until a separator bytes
sequence appears.
(Contributed by Mark Korenberg.)

@item 
The performance of @ref{c97,,StreamReader.readexactly()}
has been improved.
(Contributed by Mark Korenberg in bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}.)

@item 
The @ref{c2e,,loop.getaddrinfo()}
method is optimized to avoid calling the system @code{getaddrinfo}
function if the address is already resolved.
(Contributed by A. Jesse Jiryu Davis.)

@item 
The @ref{c98,,loop.stop()}
method has been changed to stop the loop immediately after
the current iteration.  Any new callbacks scheduled as a result
of the last iteration will be discarded.
(Contributed by Guido van Rossum in bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}.)

@item 
@ref{c99,,Future.set_exception}
will now raise @ref{2c3,,TypeError} when passed an instance of
the @ref{c15,,StopIteration} exception.
(Contributed by Chris Angelico in bpo-26221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26221}.)

@item 
New @ref{7df,,loop.connect_accepted_socket()}
method to be used by servers that accept connections outside of asyncio,
but that use asyncio to handle them.
(Contributed by Jim Fulton in bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}.)

@item 
@code{TCP_NODELAY} flag is now set for all TCP transports by default.
(Contributed by Yury Selivanov in bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}.)

@item 
New @ref{c9a,,loop.shutdown_asyncgens()}
to properly close pending asynchronous generators before closing the
loop.
(Contributed by Yury Selivanov in bpo-28003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28003}.)

@item 
@ref{be6,,Future} and @ref{1be,,Task}
classes now have an optimized C implementation which makes asyncio
code up to 30% faster.
(Contributed by Yury Selivanov and INADA Naoki in bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}
and bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}.)
@end itemize

@node binascii<2>,cmath,asyncio<9>,Módulos melhorados<8>
@anchor{whatsnew/3 6 binascii}@anchor{c9b}
@subsubsection binascii


The @ref{c9c,,b2a_base64()} function now accepts an optional `newline'
keyword argument to control whether the newline character is appended to the
return value.
(Contributed by Victor Stinner in bpo-25357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25357}.)

@node cmath,collections<4>,binascii<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 cmath}@anchor{c9d}
@subsubsection cmath


The new @ref{c9e,,cmath.tau} (`τ') constant has been added.
(Contributed by Lisa Roach in bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}, see 
@geindex Propostas de Melhorias do Python; PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/} for details.)

New constants: @ref{c9f,,cmath.inf} and @ref{ca0,,cmath.nan} to
match @ref{ca1,,math.inf} and @ref{663,,math.nan}, and also @ref{ca2,,cmath.infj}
and @ref{ca3,,cmath.nanj} to match the format used by complex repr.
(Contributed by Mark Dickinson in bpo-23229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23229}.)

@node collections<4>,concurrent futures<4>,cmath,Módulos melhorados<8>
@anchor{whatsnew/3 6 collections}@anchor{ca4}
@subsubsection collections


The new @ref{ca5,,Collection} abstract base class has been
added to represent sized iterable container classes.
(Contributed by Ivan Levkivskyi, docs by Neil Girdhar in bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}.)

The new @ref{ca6,,Reversible} abstract base class represents
iterable classes that also provide the @ref{ca7,,__reversed__()} method.
(Contributed by Ivan Levkivskyi in bpo-25987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25987}.)

The new @ref{ca8,,AsyncGenerator} abstract base class represents
asynchronous generators.
(Contributed by Yury Selivanov in bpo-28720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28720}.)

The @ref{1ca,,namedtuple()} function now accepts an optional
keyword argument `module', which, when specified, is used for
the @ref{374,,__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}.)

The `verbose' and `rename' arguments for
@ref{1ca,,namedtuple()} are now keyword-only.
(Contributed by Raymond Hettinger in bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}.)

Recursive @ref{5dc,,collections.deque} instances can now be pickled.
(Contributed by Serhiy Storchaka in bpo-26482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26482}.)

@node concurrent futures<4>,contextlib<4>,collections<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 concurrent-futures}@anchor{ca9}
@subsubsection concurrent.futures


The @ref{742,,ThreadPoolExecutor}
class constructor now accepts an optional `thread_name_prefix' argument
to make it possible to customize the names of the threads created by the
pool.
(Contributed by Gregory P. Smith in bpo-27664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27664}.)

@node contextlib<4>,datetime<5>,concurrent futures<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 contextlib}@anchor{caa}
@subsubsection contextlib


The @ref{cab,,contextlib.AbstractContextManager} class has been added to
provide an abstract base class for context managers.  It provides a
sensible default implementation for @code{__enter__()} which returns
@code{self} and leaves @code{__exit__()} an abstract method.  A matching
class has been added to the @ref{104,,typing} module as
@ref{cac,,typing.ContextManager}.
(Contributed by Brett Cannon in bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}.)

@node datetime<5>,decimal<2>,contextlib<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 datetime}@anchor{cad}
@subsubsection datetime


The @ref{1cc,,datetime} and @ref{1ce,,time} classes have
the new @ref{cae,,fold} attribute used to disambiguate local time
when necessary.  Many functions in the @ref{30,,datetime} have been
updated to support local time disambiguation.
See @ref{c57,,Local Time Disambiguation} section for more
information.
(Contributed by Alexander Belopolsky in bpo-24773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24773}.)

The @ref{caf,,datetime.strftime()} and
@ref{cb0,,date.strftime()} methods now support
ISO 8601 date directives @code{%G}, @code{%u} and @code{%V}.
(Contributed by Ashley Anderson in bpo-12006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12006}.)

The @ref{b42,,datetime.isoformat()} function
now accepts an optional `timespec' argument that specifies the number
of additional components of the time value to include.
(Contributed by Alessandro Cucci and Alexander Belopolsky in bpo-19475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19475}.)

The @ref{cb1,,datetime.combine()} now
accepts an optional `tzinfo' argument.
(Contributed by Alexander Belopolsky in bpo-27661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27661}.)

@node decimal<2>,distutils<5>,datetime<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 decimal}@anchor{cb2}
@subsubsection decimal


New @ref{cb3,,Decimal.as_integer_ratio()}
method that returns a pair @code{(n, d)} of integers that represent the given
@ref{29d,,Decimal} instance as a fraction, in lowest terms and
with a positive denominator:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

(Contributed by Stefan Krah amd Mark Dickinson in bpo-25928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25928}.)

@node distutils<5>,email<2>,decimal<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 distutils}@anchor{cb4}
@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<2>,encodings<2>,distutils<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 email}@anchor{cb5}
@subsubsection email


The new email API, enabled via the `policy' keyword to various constructors, is
no longer provisional.  The @ref{3b,,email} documentation has been reorganized and
rewritten to focus on the new API, while retaining the old documentation for
the legacy API.  (Contributed by R. David Murray in bpo-24277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24277}.)

The @ref{45,,email.mime} classes now all accept an optional `policy' keyword.
(Contributed by Berker Peksag in bpo-27331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27331}.)

The @ref{cb6,,DecodedGenerator} now supports the `policy'
keyword.

There is a new @ref{4f,,policy} attribute,
@ref{cb7,,message_factory}, that controls what class is used
by default when the parser creates new message objects.  For the
@ref{cb8,,email.policy.compat32} policy this is @ref{27c,,Message},
for the new policies it is @ref{27b,,EmailMessage}.
(Contributed by R. David Murray in bpo-20476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20476}.)

@node encodings<2>,enum<7>,email<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 encodings}@anchor{cb9}
@subsubsection encodings


On Windows, added the @code{'oem'} encoding to use @code{CP_OEMCP}, and the @code{'ansi'}
alias for the existing @code{'mbcs'} encoding, which uses the @code{CP_ACP} code page.
(Contributed by Steve Dower in bpo-27959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27959}.)

@node enum<7>,faulthandler<2>,encodings<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 enum}@anchor{cba}
@subsubsection enum


Two new enumeration base classes have been added to the @ref{56,,enum} module:
@ref{623,,Flag} and @ref{cbb,,IntFlag}.  Both are used to define
constants that can be combined using the bitwise operators.
(Contributed by Ethan Furman in bpo-23591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23591}.)

Many standard library modules have been updated to use the
@ref{cbb,,IntFlag} class for their constants.

The new @ref{cbc,,enum.auto} value can be used to assign values to enum
members automatically:

@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 faulthandler<2>,fileinput<2>,enum<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 faulthandler}@anchor{cbd}
@subsubsection faulthandler


On Windows, the @ref{58,,faulthandler} module now installs a handler for Windows
exceptions: see @ref{cbe,,faulthandler.enable()}. (Contributed by Victor Stinner in
bpo-23848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23848}.)

@node fileinput<2>,hashlib<5>,faulthandler<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 fileinput}@anchor{cbf}
@subsubsection fileinput


@ref{cc0,,hook_encoded()} now supports the `errors' argument.
(Contributed by Joseph Hackman in bpo-25788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25788}.)

@node hashlib<5>,http client<2>,fileinput<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 hashlib}@anchor{cc1}
@subsubsection hashlib


@ref{68,,hashlib} supports OpenSSL 1.1.0.  The minimum recommend version is 1.0.2.
(Contributed by Christian Heimes in bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

BLAKE2 hash functions were added to the module. @ref{642,,blake2b()}
and @ref{643,,blake2s()} are always available and support the full
feature set of BLAKE2.
(Contributed by Christian Heimes in bpo-26798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26798} based on code by
Dmitry Chestnykh and Samuel Neves. Documentation written by Dmitry Chestnykh.)

The SHA-3 hash functions @ref{cc2,,sha3_224()}, @ref{cc3,,sha3_256()},
@ref{cc4,,sha3_384()}, @ref{cc5,,sha3_512()}, and SHAKE hash functions
@ref{cc6,,shake_128()} and @ref{cc7,,shake_256()} were added.
(Contributed by Christian Heimes in bpo-16113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16113}. Keccak Code Package
by Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche, and
Ronny Van Keer.)

The password-based key derivation function @ref{c59,,scrypt()} is now
available with OpenSSL 1.1.0 and newer.
(Contributed by Christian Heimes in bpo-27928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27928}.)

@node http client<2>,idlelib e IDLE<2>,hashlib<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 http-client}@anchor{cc8}
@subsubsection http.client


@ref{cc9,,HTTPConnection.request()} and
@ref{cca,,endheaders()} both now support
chunked encoding request bodies.
(Contributed by Demian Brecht and Rolf Krahl in bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@node idlelib e IDLE<2>,importlib<6>,http client<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 idlelib-and-idle}@anchor{ccb}
@subsubsection idlelib e IDLE


The idlelib package is being modernized and refactored to make IDLE look and
work better and to make the code easier to understand, test, and improve. Part
of making IDLE look better, especially on Linux and Mac, is using ttk widgets,
mostly in the dialogs.  As a result, IDLE no longer runs with tcl/tk 8.4.  It
now requires tcl/tk 8.5 or 8.6.  We recommend running the latest release of
either.

‘Modernizing’ includes renaming and consolidation of idlelib modules. The
renaming of files with partial uppercase names is similar to the renaming of,
for instance, Tkinter and TkFont to tkinter and tkinter.font in 3.0.  As a
result, imports of idlelib files that worked in 3.5 will usually not work in
3.6.  At least a module name change will be needed (see idlelib/README.txt),
sometimes more.  (Name changes contributed by Al Swiegart and Terry Reedy in
bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}.  Most idlelib patches since have been and will be part of the
process.)

In compensation, the eventual result with be that some idlelib classes will be
easier to use, with better APIs and docstrings explaining them.  Additional
useful information will be added to idlelib when available.

New in 3.6.2:

Multiple fixes for autocompletion. (Contributed by Louie Lu in bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}.)

New in 3.6.3:

Module Browser (on the File menu, formerly called Class Browser),
now displays nested functions and classes in addition to top-level
functions and classes.
(Contributed by Guilherme Polo, Cheryl Sabella, and Terry Jan Reedy
in bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}.)

The IDLE features formerly implemented as extensions have been reimplemented
as normal features.  Their settings have been moved from the Extensions tab
to other dialog tabs.
(Contributed by Charles Wohlganger and Terry Jan Reedy in bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}.)

The Settings dialog (Options, Configure IDLE) has been partly rewritten
to improve both appearance and function.
(Contributed by Cheryl Sabella and Terry Jan Reedy in multiple issues.)

New in 3.6.4:

The font sample now includes a selection of non-Latin characters so that
users can better see the effect of selecting a particular font.
(Contributed by Terry Jan Reedy in bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}.)
The sample can be edited to include other characters.
(Contributed by Serhiy Storchaka in bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}.)

New in 3.6.6:

Editor code context option revised.  Box displays all context lines up to
maxlines.  Clicking on a context line jumps the editor to that line.  Context
colors for custom themes is added to Highlights tab of Settings dialog.
(Contributed by Cheryl Sabella and Terry Jan Reedy in bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642},
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}, and bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}.)

On Windows, a new API call tells Windows 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.
(Contributed by Terry Jan Reedy in bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}.)

New in 3.6.7:

A saída em N linhas (50 por padrão) é compactada até um limite inferior. N pode ser alterado na seção PyShell da página General da caixa de diálogo Settings. Menos linhas, mas possivelmente extra longas, podem ser espremidas clicando com o botão direito do mouse na saída. A saída compactada pode ser expandida no local clicando duas vezes no botão ou na área de transferência ou em uma janela separada clicando com o botão direito do mouse. (Contribuição de Tal Einat em bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}.)

@node importlib<6>,inspect<6>,idlelib e IDLE<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 importlib}@anchor{ccc}
@subsubsection importlib


Import now raises the new exception @ref{b5b,,ModuleNotFoundError}
(subclass of @ref{419,,ImportError}) when it cannot find a module.  Code
that current checks for @code{ImportError} (in try-except) will still work.
(Contributed by Eric Snow in bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@ref{ccd,,importlib.util.LazyLoader} now calls
@ref{cce,,create_module()} on the wrapped loader, removing the
restriction that @ref{ccf,,importlib.machinery.BuiltinImporter} and
@ref{cd0,,importlib.machinery.ExtensionFileLoader} couldn’t be used with
@ref{ccd,,importlib.util.LazyLoader}.

@ref{2fe,,importlib.util.cache_from_source()},
@ref{51a,,importlib.util.source_from_cache()}, and
@ref{cd1,,importlib.util.spec_from_file_location()} now accept a
@ref{2a0,,path-like object}.

@node inspect<6>,json,importlib<6>,Módulos melhorados<8>
@anchor{whatsnew/3 6 inspect}@anchor{cd2}
@subsubsection inspect


The @ref{738,,inspect.signature()} function 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}. (Contributed by Jelle Zijlstra in bpo-19611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19611}.)

To reduce code churn when upgrading from Python 2.7 and the legacy
@code{inspect.getargspec()} API, the previously documented deprecation of
@ref{739,,inspect.getfullargspec()} has been reversed. While this function is
convenient for single/source Python 2/3 code bases, the richer
@ref{738,,inspect.signature()} interface remains the recommended approach for new
code. (Contributed by Nick Coghlan in bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172})

@node json,logging<4>,inspect<6>,Módulos melhorados<8>
@anchor{whatsnew/3 6 json}@anchor{cd3}
@subsubsection json


@ref{cd4,,json.load()} and @ref{95c,,json.loads()} now support binary input.  Encoded
JSON should be represented using either UTF-8, UTF-16, or UTF-32.
(Contributed by Serhiy Storchaka in bpo-17909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17909}.)

@node logging<4>,math<7>,json,Módulos melhorados<8>
@anchor{whatsnew/3 6 logging}@anchor{cd5}
@subsubsection logging


The new @ref{cd6,,WatchedFileHandler.reopenIfNeeded()}
method has been added to add the ability to check if the log file needs to
be reopened.
(Contributed by Marian Horban in bpo-24884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24884}.)

@node math<7>,multiprocessing<5>,logging<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 math}@anchor{cd7}
@subsubsection math


The tau (`τ') constant has been added to the @ref{8e,,math} and @ref{18,,cmath}
modules.
(Contributed by Lisa Roach in bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}, see 
@geindex Propostas de Melhorias do Python; PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/} for details.)

@node multiprocessing<5>,os<8>,math<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 multiprocessing}@anchor{cd8}
@subsubsection multiprocessing


@ref{cd9,,Proxy Objects} returned by
@ref{cda,,multiprocessing.Manager()} can now be nested.
(Contributed by Davin Potts in bpo-6766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6766}.)

@node os<8>,pathlib<9>,multiprocessing<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 os}@anchor{cdb}
@subsubsection os


See the summary of @ref{c56,,PEP 519} for details on how the
@ref{a1,,os} and @ref{a2,,os.path} modules now support
@ref{2a0,,path-like objects}.

@ref{a68,,scandir()} now supports @ref{1c2,,bytes} paths on Windows.

A new @ref{cdc,,close()} method allows explicitly closing a
@ref{a68,,scandir()} iterator.  The @ref{a68,,scandir()} iterator now
supports the @ref{5d4,,context manager} protocol.  If a @code{scandir()}
iterator is neither exhausted nor explicitly closed a @ref{244,,ResourceWarning}
will be emitted in its destructor.
(Contributed by Serhiy Storchaka in bpo-25994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25994}.)

On Linux, @ref{523,,os.urandom()} now blocks until the system urandom entropy pool
is initialized to increase the security. See the 
@geindex Propostas de Melhorias do Python; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} for the rationale.

The Linux @code{getrandom()} syscall (get random bytes) is now exposed as the new
@ref{cdd,,os.getrandom()} function.
(Contributed by Victor Stinner, part of the 
@geindex Propostas de Melhorias do Python; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/})

@node pathlib<9>,pdb<5>,os<8>,Módulos melhorados<8>
@anchor{whatsnew/3 6 pathlib}@anchor{cde}
@subsubsection pathlib


@ref{a4,,pathlib} now supports @ref{2a0,,path-like objects}.
(Contributed by Brett Cannon in bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}.)

See the summary of @ref{c56,,PEP 519} for details.

@node pdb<5>,pickle<2>,pathlib<9>,Módulos melhorados<8>
@anchor{whatsnew/3 6 pdb}@anchor{cdf}
@subsubsection pdb


The @ref{928,,Pdb} class constructor has a new optional `readrc' argument
to control whether @code{.pdbrc} files should be read.

@node pickle<2>,pickletools,pdb<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 pickle}@anchor{ce0}
@subsubsection pickle


Objects that need @code{__new__} called with keyword arguments can now be pickled
using @ref{ce1,,pickle protocols} older than protocol version 4.
Protocol version 4 already supports this case.  (Contributed by Serhiy
Storchaka in bpo-24164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24164}.)

@node pickletools,pydoc<3>,pickle<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 pickletools}@anchor{ce2}
@subsubsection pickletools


@ref{ce3,,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<3>,random<4>,pickletools,Módulos melhorados<8>
@anchor{whatsnew/3 6 pydoc}@anchor{ce4}
@subsubsection pydoc


The @ref{b5,,pydoc} module has learned to respect the @code{MANPAGER}
environment variable.
(Contributed by Matthias Klose in bpo-8637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8637}.)

@ref{8dd,,help()} and @ref{b5,,pydoc} can now list named tuple fields in the
order they were defined rather than alphabetically.
(Contributed by Raymond Hettinger in bpo-24879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24879}.)

@node random<4>,re<5>,pydoc<3>,Módulos melhorados<8>
@anchor{whatsnew/3 6 random}@anchor{ce5}
@subsubsection random


The new @ref{ce6,,choices()} function returns a list of elements of
specified size from the given population with optional weights.
(Contributed by Raymond Hettinger in bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}.)

@node re<5>,readline,random<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 re}@anchor{ce7}
@subsubsection re


Added support of modifier spans in regular expressions.  Examples:
@code{'(?i:p)ython'} matches @code{'python'} and @code{'Python'}, but not @code{'PYTHON'};
@code{'(?i)g(?-i:v)r'} matches @code{'GvR'} and @code{'gvr'}, but not @code{'GVR'}.
(Contributed by Serhiy Storchaka in bpo-433028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433028}.)

Match object groups can be accessed by @code{__getitem__}, which is
equivalent to @code{group()}.  So @code{mo['name']} is now equivalent to
@code{mo.group('name')}.  (Contributed by Eric Smith in bpo-24454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24454}.)

@ref{ce8,,Match} objects now support
@ref{71d,,index-like objects} as group
indices.
(Contributed by Jeroen Demeyer and Xiang Zhang in bpo-27177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27177}.)

@node readline,rlcompleter,re<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 readline}@anchor{ce9}
@subsubsection readline


Added @ref{cea,,set_auto_history()} to enable or disable
automatic addition of input to the history list.  (Contributed by
Tyler Crompton in bpo-26870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26870}.)

@node rlcompleter,shlex<2>,readline,Módulos melhorados<8>
@anchor{whatsnew/3 6 rlcompleter}@anchor{ceb}
@subsubsection rlcompleter


Private and special attribute names now are omitted unless the prefix starts
with underscores.  A space or a colon is added after some completed keywords.
(Contributed by Serhiy Storchaka in bpo-25011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25011} and bpo-25209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25209}.)

@node shlex<2>,site<3>,rlcompleter,Módulos melhorados<8>
@anchor{whatsnew/3 6 shlex}@anchor{cec}
@subsubsection shlex


The @ref{ced,,shlex} has much
@ref{cee,,improved shell compatibility}
through the new `punctuation_chars' argument to control which characters
are treated as punctuation.
(Contributed by Vinay Sajip in bpo-1521950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1521950}.)

@node site<3>,sqlite3<7>,shlex<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 site}@anchor{cef}
@subsubsection site


When specifying paths to add to @ref{3b4,,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<7>,socket<7>,site<3>,Módulos melhorados<8>
@anchor{whatsnew/3 6 sqlite3}@anchor{cf0}
@subsubsection sqlite3


@ref{cf1,,sqlite3.Cursor.lastrowid} now supports the @code{REPLACE} statement.
(Contributed by Alex LordThorsen in bpo-16864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16864}.)

@node socket<7>,socketserver<2>,sqlite3<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 socket}@anchor{cf2}
@subsubsection socket


The @ref{cf3,,ioctl()} function now supports the
@ref{cf4,,SIO_LOOPBACK_FAST_PATH} control code.
(Contributed by Daniel Stokes in bpo-26536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26536}.)

The @ref{cf5,,getsockopt()} constants @code{SO_DOMAIN},
@code{SO_PROTOCOL}, @code{SO_PEERSEC}, and @code{SO_PASSSEC} are now supported.
(Contributed by Christian Heimes in bpo-26907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26907}.)

The @ref{cf6,,setsockopt()} now supports the
@code{setsockopt(level, optname, None, optlen: int)} form.
(Contributed by Christian Heimes in bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744}.)

The socket module now supports the address family
@ref{cf7,,AF_ALG} to interface with Linux Kernel crypto API. @code{ALG_*},
@code{SOL_ALG} and @ref{cf8,,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.)

New Linux constants @code{TCP_USER_TIMEOUT} and @code{TCP_CONGESTION} were added.
(Contributed by Omar Sandoval, bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}).

@node socketserver<2>,ssl<7>,socket<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 socketserver}@anchor{cf9}
@subsubsection socketserver


Servers based on the @ref{cd,,socketserver} module, including those
defined in @ref{72,,http.server}, @ref{12f,,xmlrpc.server} and
@ref{11b,,wsgiref.simple_server}, now support the @ref{5d4,,context manager}
protocol.
(Contributed by Aviv Palivoda in bpo-26404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26404}.)

The @ref{cfa,,wfile} attribute of
@ref{cfb,,StreamRequestHandler} classes now implements
the @ref{694,,io.BufferedIOBase} writable interface.  In particular,
calling @ref{cfc,,write()} is now guaranteed to send the
data in full.  (Contributed by Martin Panter in bpo-26721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26721}.)

@node ssl<7>,statistics<5>,socketserver<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 ssl}@anchor{cfd}
@subsubsection ssl


@ref{d0,,ssl} supports OpenSSL 1.1.0.  The minimum recommend version is 1.0.2.
(Contributed by Christian Heimes in bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

3DES has been removed from the default cipher suites and ChaCha20 Poly1305
cipher suites have been added.
(Contributed by Christian Heimes in bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850} and bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}.)

@ref{294,,SSLContext} has better default configuration for options
and ciphers.
(Contributed by Christian Heimes in bpo-28043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28043}.)

SSL session can be copied from one client-side connection to another
with the new @ref{cfe,,SSLSession} class.  TLS session resumption can
speed up the initial handshake, reduce latency and improve performance
(Contributed by Christian Heimes in bpo-19500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19500} based on a draft by
Alex Warhawk.)

The new @ref{cff,,get_ciphers()} method can be used to
get a list of enabled ciphers in order of cipher priority.

All constants and flags have been converted to @ref{d00,,IntEnum} and
@ref{cbb,,IntFlag}.
(Contributed by Christian Heimes in bpo-28025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28025}.)

Server and client-side specific TLS protocols for @ref{294,,SSLContext}
were added.
(Contributed by Christian Heimes in bpo-28085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28085}.)

Added @ref{a3b,,ssl.SSLContext.post_handshake_auth} to enable and
@ref{a3c,,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 statistics<5>,struct,ssl<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 statistics}@anchor{d01}
@subsubsection statistics


A new @ref{d02,,harmonic_mean()} function has been added.
(Contributed by Steven D’Aprano in bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}.)

@node struct,subprocess<3>,statistics<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 struct}@anchor{d03}
@subsubsection struct


@ref{d5,,struct} now supports IEEE 754 half-precision floats via the @code{'e'}
format specifier.
(Contributed by Eli Stevens, Mark Dickinson in bpo-11734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11734}.)

@node subprocess<3>,sys<10>,struct,Módulos melhorados<8>
@anchor{whatsnew/3 6 subprocess}@anchor{d04}
@subsubsection subprocess


@ref{199,,subprocess.Popen} destructor now emits a @ref{244,,ResourceWarning} warning
if the child process is still running. Use the context manager protocol (@code{with
proc: ...}) or explicitly call the @ref{d05,,wait()} method to
read the exit status of the child process. (Contributed by Victor Stinner in
bpo-26741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26741}.)

The @ref{199,,subprocess.Popen} constructor and all functions that pass arguments
through to it now accept `encoding' and `errors' arguments. Specifying either
of these will enable text mode for the `stdin', `stdout' and `stderr' streams.
(Contributed by Steve Dower in bpo-6135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6135}.)

@node sys<10>,telnetlib,subprocess<3>,Módulos melhorados<8>
@anchor{whatsnew/3 6 sys}@anchor{d06}
@subsubsection sys


The new @ref{d07,,getfilesystemencodeerrors()} function returns the name of
the error mode used to convert between Unicode filenames and bytes filenames.
(Contributed by Steve Dower in bpo-27781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27781}.)

On Windows the return value of the @ref{d08,,getwindowsversion()} function
now includes the `platform_version' field which contains the accurate major
version, minor version and build number of the current operating system,
rather than the version that is being emulated for the process
(Contributed by Steve Dower in bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}.)

@node telnetlib,time<6>,sys<10>,Módulos melhorados<8>
@anchor{whatsnew/3 6 telnetlib}@anchor{d09}
@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 time<6>,timeit,telnetlib,Módulos melhorados<8>
@anchor{whatsnew/3 6 time}@anchor{d0a}
@subsubsection time


The @ref{d0b,,struct_time} attributes @code{tm_gmtoff} and
@code{tm_zone} are now available on all platforms.

@node timeit,tkinter<6>,time<6>,Módulos melhorados<8>
@anchor{whatsnew/3 6 timeit}@anchor{d0c}
@subsubsection timeit


The new @ref{d0d,,Timer.autorange()} convenience
method has been added to call @ref{d0e,,Timer.timeit()}
repeatedly so that the total run time is greater or equal to 200 milliseconds.
(Contributed by Steven D’Aprano in bpo-6422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6422}.)

@ref{ef,,timeit} now warns when there is substantial (4x) variance
between best and worst times.
(Contributed by Serhiy Storchaka in bpo-23552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23552}.)

@node tkinter<6>,traceback<4>,timeit,Módulos melhorados<8>
@anchor{whatsnew/3 6 tkinter}@anchor{d0f}
@subsubsection tkinter


Added methods @code{Variable.trace_add()},
@code{Variable.trace_remove()} and @code{trace_info()}
in the @code{tkinter.Variable} class.  They replace old methods
@code{trace_variable()}, @code{trace()},
@code{trace_vdelete()} and
@code{trace_vinfo()} that use obsolete Tcl commands and might
not work in future versions of Tcl.
(Contributed by Serhiy Storchaka in bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}).

@node traceback<4>,tracemalloc<3>,tkinter<6>,Módulos melhorados<8>
@anchor{whatsnew/3 6 traceback}@anchor{d10}@anchor{whatsnew/3 6 whatsnew36-traceback}@anchor{c8b}
@subsubsection traceback


Both the traceback module and the interpreter’s builtin exception display now
abbreviate long sequences of repeated lines in tracebacks as shown in the
following example:

@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

(Contributed by Emanuel Barry in bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@node tracemalloc<3>,typing<9>,traceback<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 tracemalloc}@anchor{d11}
@subsubsection tracemalloc


The @ref{ff,,tracemalloc} module now supports tracing memory allocations in
multiple different address spaces.

The new @ref{d12,,DomainFilter} filter class has been added
to filter block traces by their address space (domain).

(Contributed by Victor Stinner in bpo-26588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26588}.)

@node typing<9>,unicodedata<7>,tracemalloc<3>,Módulos melhorados<8>
@anchor{whatsnew/3 6 typing}@anchor{d13}@anchor{whatsnew/3 6 whatsnew36-typing}@anchor{c58}
@subsubsection typing


Since the @ref{104,,typing} module is @ref{b16,,provisional},
all changes introduced in Python 3.6 have also been
backported to Python 3.5.x.

The @ref{104,,typing} module has a much improved support for generic type
aliases.  For example @code{Dict[str, Tuple[S, T]]} is now a valid
type annotation.
(Contributed by Guido van Rossum in Github #195@footnote{https://github.com/python/typing/pull/195}.)

The @ref{cac,,typing.ContextManager} class has been added for
representing @ref{cab,,contextlib.AbstractContextManager}.
(Contributed by Brett Cannon in bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}.)

The @ref{d14,,typing.Collection} class has been added for
representing @ref{ca5,,collections.abc.Collection}.
(Contributed by Ivan Levkivskyi in bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}.)

The @ref{266,,typing.ClassVar} type construct has been added to
mark class variables.  As introduced in 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, a variable annotation
wrapped in ClassVar indicates that a given attribute is intended to be used as
a class variable and should not be set on instances of that class.
(Contributed by Ivan Levkivskyi in Github #280@footnote{https://github.com/python/typing/pull/280}.)

A new @ref{d15,,TYPE_CHECKING} constant that is assumed to be
@code{True} by the static type checkers, but is @code{False} at runtime.
(Contributed by Guido van Rossum in Github #230@footnote{https://github.com/python/typing/issues/230}.)

A new @ref{d16,,NewType()} helper function has been added to create
lightweight distinct types for annotations:

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

The static type checker will treat the new type as if it were a subclass
of the original type.  (Contributed by Ivan Levkivskyi in Github #189@footnote{https://github.com/python/typing/issues/189}.)

@node unicodedata<7>,unittest mock<2>,typing<9>,Módulos melhorados<8>
@anchor{whatsnew/3 6 unicodedata}@anchor{d17}
@subsubsection unicodedata


The @ref{105,,unicodedata} module now uses data from Unicode 9.0.0@footnote{https://unicode.org/versions/Unicode9.0.0/}.
(Contributed by Benjamin Peterson.)

@node unittest mock<2>,urllib request,unicodedata<7>,Módulos melhorados<8>
@anchor{whatsnew/3 6 unittest-mock}@anchor{d18}
@subsubsection unittest.mock


The @ref{a54,,Mock} class has the following improvements:


@itemize *

@item 
Two new methods, @ref{d19,,Mock.assert_called()} and @ref{d1a,,Mock.assert_called_once()} to check if the mock object
was called.
(Contributed by Amit Saha in bpo-26323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26323}.)

@item 
The @ref{d1b,,Mock.reset_mock()} method
now has two optional keyword only arguments: `return_value' and
`side_effect'.
(Contributed by Kushal Das in bpo-21271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21271}.)
@end itemize

@node urllib request,urllib robotparser,unittest mock<2>,Módulos melhorados<8>
@anchor{whatsnew/3 6 urllib-request}@anchor{d1c}
@subsubsection urllib.request


If a HTTP request has a file or iterable body (other than a
bytes object) but no @code{Content-Length} header, rather than
throwing an error, @ref{d1d,,AbstractHTTPHandler}
now falls back to use chunked transfer encoding.
(Contributed by Demian Brecht and Rolf Krahl in bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@node urllib robotparser,venv<5>,urllib request,Módulos melhorados<8>
@anchor{whatsnew/3 6 urllib-robotparser}@anchor{d1e}
@subsubsection urllib.robotparser


@ref{d1f,,RobotFileParser} now supports the @code{Crawl-delay} and
@code{Request-rate} extensions.
(Contributed by Nikolay Bogoychev in bpo-16099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16099}.)

@node venv<5>,avisos<4>,urllib robotparser,Módulos melhorados<8>
@anchor{whatsnew/3 6 venv}@anchor{d20}
@subsubsection venv


@ref{111,,venv} accepts a new parameter @code{--prompt}. This parameter provides an
alternative prefix for the virtual environment. (Proposed by Łukasz Balcerzak
and ported to 3.6 by Stéphane Wirtel in bpo-22829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22829}.)

@node avisos<4>,winreg,venv<5>,Módulos melhorados<8>
@anchor{whatsnew/3 6 warnings}@anchor{d21}
@subsubsection avisos


A new optional `source' parameter has been added to the
@ref{d22,,warnings.warn_explicit()} function: the destroyed object which emitted a
@ref{244,,ResourceWarning}. A `source' attribute has also been added to
@code{warnings.WarningMessage} (contributed by Victor Stinner in
bpo-26568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26568} and bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}).

When a @ref{244,,ResourceWarning} warning is logged, the @ref{ff,,tracemalloc} module is now
used to try to retrieve the traceback where the destroyed object was allocated.

Example with the script @code{example.py}:

@example
import warnings

def func():
    return open(__file__)

f = func()
f = None
@end example

Output of the command @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

The “Object allocated at” traceback is new and is only displayed if
@ref{ff,,tracemalloc} is tracing Python memory allocations and if the
@ref{112,,warnings} module was already imported.

@node winreg,winsound,avisos<4>,Módulos melhorados<8>
@anchor{whatsnew/3 6 winreg}@anchor{d23}
@subsubsection winreg


Added the 64-bit integer type @ref{d24,,REG_QWORD}.
(Contributed by Clement Rouault in bpo-23026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23026}.)

@node winsound,xmlrpc client,winreg,Módulos melhorados<8>
@anchor{whatsnew/3 6 winsound}@anchor{d25}
@subsubsection winsound


Allowed keyword arguments to be passed to @ref{d26,,Beep},
@ref{d27,,MessageBeep}, and @ref{d28,,PlaySound} (bpo-27982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27982}).

@node xmlrpc client,zipfile<3>,winsound,Módulos melhorados<8>
@anchor{whatsnew/3 6 xmlrpc-client}@anchor{d29}
@subsubsection xmlrpc.client


The @ref{12e,,xmlrpc.client} module now supports unmarshalling
additional data types used by the Apache XML-RPC implementation
for numerics and @code{None}.
(Contributed by Serhiy Storchaka in bpo-26885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26885}.)

@node zipfile<3>,zlib,xmlrpc client,Módulos melhorados<8>
@anchor{whatsnew/3 6 zipfile}@anchor{d2a}
@subsubsection zipfile


A new @ref{d2b,,ZipInfo.from_file()} class method
allows making a @ref{d2c,,ZipInfo} instance from a filesystem file.
A new @ref{d2d,,ZipInfo.is_dir()} method can be used
to check if the @ref{d2c,,ZipInfo} instance represents a directory.
(Contributed by Thomas Kluyver in bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}.)

The @ref{41b,,ZipFile.open()} method can now be used to
write data into a ZIP file, as well as for extracting data.
(Contributed by Thomas Kluyver in bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}.)

@node zlib,,zipfile<3>,Módulos melhorados<8>
@anchor{whatsnew/3 6 zlib}@anchor{d2e}
@subsubsection zlib


The @ref{63f,,compress()} and @ref{d2f,,decompress()} functions now accept
keyword arguments.
(Contributed by Aviv Palivoda in bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243} and
Xiang Zhang in bpo-16764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16764} respectively.)

@node Otimizações<8>,Mudanças a construções e API C<2>,Módulos melhorados<8>,What’s New In Python 3 6
@anchor{whatsnew/3 6 optimizations}@anchor{d30}
@subsection Otimizações



@itemize *

@item 
The Python interpreter now uses a 16-bit wordcode instead of bytecode which
made a number of opcode optimizations possible.
(Contributed by Demur Rumed with input and reviews from
Serhiy Storchaka and Victor Stinner in bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} and bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050}.)

@item 
The @ref{be6,,asyncio.Future} class now has an optimized C implementation.
(Contributed by Yury Selivanov and INADA Naoki in bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}.)

@item 
The @ref{1be,,asyncio.Task} class now has an optimized
C implementation. (Contributed by Yury Selivanov in bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}.)

@item 
Various implementation improvements in the @ref{104,,typing} module
(such as caching of generic types) allow up to 30 times performance
improvements and reduced memory footprint.

@item 
The ASCII decoder is now up to 60 times as fast for error handlers
@code{surrogateescape}, @code{ignore} and @code{replace} (Contributed
by Victor Stinner in bpo-24870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24870}).

@item 
The ASCII and the Latin1 encoders are now up to 3 times as fast for the
error handler @code{surrogateescape}
(Contributed by Victor Stinner in bpo-25227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25227}).

@item 
The UTF-8 encoder is now up to 75 times as fast for error handlers
@code{ignore}, @code{replace}, @code{surrogateescape}, @code{surrogatepass} (Contributed
by Victor Stinner in bpo-25267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25267}).

@item 
The UTF-8 decoder is now up to 15 times as fast for error handlers
@code{ignore}, @code{replace} and @code{surrogateescape} (Contributed
by Victor Stinner in bpo-25301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25301}).

@item 
@code{bytes % args} is now up to 2 times faster. (Contributed by Victor Stinner
in bpo-25349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25349}).

@item 
@code{bytearray % args} is now between 2.5 and 5 times faster. (Contributed by
Victor Stinner in bpo-25399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25399}).

@item 
Optimize @ref{b02,,bytes.fromhex()} and @ref{b03,,bytearray.fromhex()}: they are now
between 2x and 3.5x faster. (Contributed by Victor Stinner in bpo-25401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25401}).

@item 
Optimize @code{bytes.replace(b'@w{'}, b'.')} and @code{bytearray.replace(b'@w{'}, b'.')}:
up to 80% faster. (Contributed by Josh Snider in bpo-26574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26574}).

@item 
Allocator functions of the @ref{c81,,PyMem_Malloc()} domain
(@ref{c84,,PYMEM_DOMAIN_MEM}) now use the @ref{d31,,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{d32,,pickle.load()} and @ref{d33,,pickle.loads()} are now up to 10% faster when
deserializing many small objects (Contributed by Victor Stinner in
bpo-27056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27056}).

@item 
Passing @ref{d34,,keyword arguments} to a function has an
overhead in comparison with passing @ref{d35,,positional arguments}.  Now in extension functions implemented with using
Argument Clinic this overhead is significantly decreased.
(Contributed by Serhiy Storchaka in bpo-27574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27574}).

@item 
Optimized @ref{29f,,glob()} and @ref{80a,,iglob()} functions in the
@ref{64,,glob} module; they are now about 3–6 times faster.
(Contributed by Serhiy Storchaka in bpo-25596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25596}).

@item 
Optimized globbing in @ref{a4,,pathlib} by using @ref{a68,,os.scandir()};
it is now about 1.5–4 times faster.
(Contributed by Serhiy Storchaka in bpo-26032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26032}).

@item 
@ref{125,,xml.etree.ElementTree} parsing, iteration and deepcopy performance
has been significantly improved.
(Contributed by Serhiy Storchaka in bpo-25638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25638}, bpo-25873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25873},
and bpo-25869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25869}.)

@item 
Creation of @ref{1e7,,fractions.Fraction} instances from floats and
decimals is now 2 to 3 times faster.
(Contributed by Serhiy Storchaka in bpo-25971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25971}.)
@end itemize

@node Mudanças a construções e API C<2>,Other Improvements,Otimizações<8>,What’s New In Python 3 6
@anchor{whatsnew/3 6 build-and-c-api-changes}@anchor{d36}
@subsection Mudanças a construções e API C



@itemize *

@item 
Python now requires some C99 support in the toolchain to build.
Most notably, Python now uses standard integer types and macros in
place of custom macros like @code{PY_LONG_LONG}.
For more information, see 
@geindex Propostas de Melhorias do Python; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} and bpo-17884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17884}.

@item 
Cross-compiling CPython with the Android NDK and the Android API level set to
21 (Android 5.0 Lollipop) or greater runs successfully. While Android is not
yet a supported platform, the Python test suite runs on the Android emulator
with only about 16 tests failures. See the Android meta-issue bpo-26865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26865}.

@item 
The @code{--enable-optimizations} configure flag has been added. Turning it on
will activate expensive optimizations like PGO.
(Original patch by Alecsandru Patrascu of Intel in bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}.)

@item 
The @ref{148,,GIL} must now be held when allocator
functions of @ref{c82,,PYMEM_DOMAIN_OBJ} (ex: @ref{c83,,PyObject_Malloc()}) and
@ref{c84,,PYMEM_DOMAIN_MEM} (ex: @ref{c81,,PyMem_Malloc()}) domains are called.

@item 
New @ref{d37,,Py_FinalizeEx()} API which indicates if flushing buffered data
failed.
(Contributed by Martin Panter in bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}.)

@item 
@ref{383,,PyArg_ParseTupleAndKeywords()} now supports @ref{a8f,,positional-only parameters}.  Positional-only parameters are
defined by empty names.
(Contributed by Serhiy Storchaka in bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}).

@item 
@code{PyTraceback_Print} method now abbreviates long sequences of repeated lines
as @code{"[Previous line repeated @{count@} more times]"}.
(Contributed by Emanuel Barry in bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}.)

@item 
The new @ref{d38,,PyErr_SetImportErrorSubclass()} function allows for
specifying a subclass of @ref{419,,ImportError} to raise.
(Contributed by Eric Snow in bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767}.)

@item 
The new @ref{d39,,PyErr_ResourceWarning()} function can be used to generate
a @ref{244,,ResourceWarning} providing the source of the resource allocation.
(Contributed by Victor Stinner in bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}.)

@item 
The new @ref{d3a,,PyOS_FSPath()} function returns the file system
representation of a @ref{2a0,,path-like object}.
(Contributed by Brett Cannon in bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}.)

@item 
The @ref{d3b,,PyUnicode_FSConverter()} and @ref{577,,PyUnicode_FSDecoder()}
functions will now accept @ref{2a0,,path-like objects}.
@end itemize

@node Other Improvements,Descontinuados<9>,Mudanças a construções e API C<2>,What’s New In Python 3 6
@anchor{whatsnew/3 6 other-improvements}@anchor{d3c}
@subsection Other Improvements



@itemize *

@item 
When @ref{d3d,,--version} (short form: @ref{177,,-V}) is supplied twice,
Python prints @ref{178,,sys.version} for detailed information.

@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 Descontinuados<9>,Removidos<9>,Other Improvements,What’s New In Python 3 6
@anchor{whatsnew/3 6 deprecated}@anchor{d3e}
@subsection Descontinuados


@menu
* New Keywords:: 
* Deprecated Python behavior:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<2>. 
* xml: xml<6>. 
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<2>. 
* Deprecated Build Options:: 

@end menu

@node New Keywords,Deprecated Python behavior,,Descontinuados<9>
@anchor{whatsnew/3 6 new-keywords}@anchor{d3f}
@subsubsection New Keywords


@code{async} and @code{await} are not recommended to be used as variable, class,
function or module names.  Introduced by 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} in Python 3.5, they will
become proper keywords in Python 3.7.  Starting in Python 3.6, the use of
@code{async} or @code{await} as names will generate a @ref{1a5,,DeprecationWarning}.

@node Deprecated Python behavior,Deprecated Python modules functions and methods<2>,New Keywords,Descontinuados<9>
@anchor{whatsnew/3 6 deprecated-python-behavior}@anchor{d40}
@subsubsection Deprecated Python behavior


Raising the @ref{c15,,StopIteration} exception inside a generator will now
generate a @ref{1a5,,DeprecationWarning}, and will trigger a @ref{195,,RuntimeError}
in Python 3.7.  See @ref{d41,,PEP 479; Change StopIteration handling inside generators} for details.

The @ref{c16,,__aiter__()} method is now expected to return an asynchronous
iterator directly instead of returning an awaitable as previously.
Doing the former will trigger a @ref{1a5,,DeprecationWarning}.  Backward
compatibility will be removed in Python 3.7.
(Contributed by Yury Selivanov in bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}.)

A backslash-character pair that is not a valid escape sequence now generates
a @ref{1a5,,DeprecationWarning}.  Although this will eventually become a
@ref{18d,,SyntaxError}, that will not be for several Python releases.
(Contributed by Emanuel Barry in bpo-27364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27364}.)

When performing a relative import, falling back on @code{__name__} and
@code{__path__} from the calling module when @code{__spec__} or
@code{__package__} are not defined now raises an @ref{4fa,,ImportWarning}.
(Contributed by Rose Ames in bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}.)

@node Deprecated Python modules functions and methods<2>,xml<6>,Deprecated Python behavior,Descontinuados<9>
@anchor{whatsnew/3 6 deprecated-python-modules-functions-and-methods}@anchor{d42}
@subsubsection Deprecated Python modules, functions and methods


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

@end menu

@node asynchat,asyncore,,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 asynchat}@anchor{d43}
@subsubsection asynchat


The @code{asynchat} has been deprecated in favor of @ref{a,,asyncio}.
(Contributed by Mariatta in bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002}.)

@node asyncore,dbm<4>,asynchat,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 asyncore}@anchor{d44}
@subsubsection asyncore


The @code{asyncore} has been deprecated in favor of @ref{a,,asyncio}.
(Contributed by Mariatta in bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002}.)

@node dbm<4>,distutils<6>,asyncore,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 dbm}@anchor{d45}
@subsubsection dbm


Unlike other @ref{31,,dbm} implementations, the @ref{32,,dbm.dumb} module
creates databases with the @code{'rw'} mode and allows modifying the database
opened with the @code{'r'} mode.  This behavior is now deprecated and will
be removed in 3.8.
(Contributed by Serhiy Storchaka in bpo-21708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21708}.)

@node distutils<6>,grp,dbm<4>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id2}@anchor{d46}
@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<7>,distutils<6>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 grp}@anchor{d47}
@subsubsection grp


The support of non-integer arguments in @ref{d48,,getgrgid()} has been
deprecated.
(Contributed by Serhiy Storchaka in bpo-26129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26129}.)

@node importlib<7>,os<9>,grp,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id3}@anchor{d49}
@subsubsection importlib


The @ref{d4a,,importlib.machinery.SourceFileLoader.load_module()} and
@ref{d4b,,importlib.machinery.SourcelessFileLoader.load_module()} methods
are now deprecated. They were the only remaining implementations of
@ref{86d,,importlib.abc.Loader.load_module()} in @ref{77,,importlib} that had not
been deprecated in previous versions of Python in favour of
@ref{86e,,importlib.abc.Loader.exec_module()}.

The @ref{d4c,,importlib.machinery.WindowsRegistryFinder} class is now
deprecated. As of 3.6.0, it is still added to @ref{d4d,,sys.meta_path} by
default (on Windows), but this may change in future releases.

@node os<9>,re<6>,importlib<7>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id4}@anchor{d4e}
@subsubsection os


Undocumented support of general @ref{d4f,,bytes-like objects}
as paths in @ref{a1,,os} functions, @ref{192,,compile()} and similar functions is
now deprecated.
(Contributed by Serhiy Storchaka in bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791} and bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}.)

@node re<6>,ssl<8>,os<9>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id5}@anchor{d50}
@subsubsection re


Support for inline flags @code{(?letters)} in the middle of the regular
expression has been deprecated and will be removed in a future Python
version.  Flags at the start of a regular expression are still allowed.
(Contributed by Serhiy Storchaka in bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}.)

@node ssl<8>,tkinter<7>,re<6>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id6}@anchor{d51}
@subsubsection ssl


OpenSSL 0.9.8, 1.0.0 and 1.0.1 are deprecated and no longer supported.
In the future the @ref{d0,,ssl} module will require at least OpenSSL 1.0.2 or
1.1.0.

SSL-related arguments like @code{certfile}, @code{keyfile} and @code{check_hostname}
in @ref{5e,,ftplib}, @ref{6f,,http.client}, @ref{74,,imaplib}, @ref{ac,,poplib},
and @ref{ca,,smtplib} have been deprecated in favor of @code{context}.
(Contributed by Christian Heimes in bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022}.)

A couple of protocols and functions of the @ref{d0,,ssl} module are now
deprecated. Some features will no longer be available in future versions
of OpenSSL. Other features are deprecated in favor of a different API.
(Contributed by Christian Heimes in bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022} and bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}.)

@node tkinter<7>,venv<6>,ssl<8>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id7}@anchor{d52}
@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>,Deprecated Python modules functions and methods<2>
@anchor{whatsnew/3 6 id8}@anchor{d53}@anchor{whatsnew/3 6 whatsnew36-venv}@anchor{d54}
@subsubsection venv


The @code{pyvenv} script has been deprecated in favour of @code{python3 -m venv}.
This prevents confusion as to what Python interpreter @code{pyvenv} is
connected to and thus what Python interpreter will be used by the virtual
environment.  (Contributed by Brett Cannon in bpo-25154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25154}.)

@node xml<6>,Deprecated functions and types of the C API<2>,Deprecated Python modules functions and methods<2>,Descontinuados<9>
@anchor{whatsnew/3 6 xml}@anchor{d55}
@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 Deprecated functions and types of the C API<2>,Deprecated Build Options,xml<6>,Descontinuados<9>
@anchor{whatsnew/3 6 deprecated-functions-and-types-of-the-c-api}@anchor{d56}
@subsubsection Deprecated functions and types of the C API


Undocumented functions @code{PyUnicode_AsEncodedObject()},
@code{PyUnicode_AsDecodedObject()}, @code{PyUnicode_AsEncodedUnicode()}
and @code{PyUnicode_AsDecodedUnicode()} are deprecated now.
Use the @ref{d57,,generic codec based API} instead.

@node Deprecated Build Options,,Deprecated functions and types of the C API<2>,Descontinuados<9>
@anchor{whatsnew/3 6 deprecated-build-options}@anchor{d58}
@subsubsection Deprecated Build Options


The @code{--with-system-ffi} configure flag is now on by default on non-macOS
UNIX platforms.  It may be disabled by using @code{--without-system-ffi}, but
using the flag is deprecated and will not be accepted in Python 3.7.
macOS is unaffected by this change.  Note that many OS distributors already
use the @code{--with-system-ffi} flag when building their system Python.

@node Removidos<9>,Porting to Python 3 6,Descontinuados<9>,What’s New In Python 3 6
@anchor{whatsnew/3 6 removed}@anchor{d59}
@subsection Removidos


@menu
* Remoção de APIs e recursos: Remoção de APIs e recursos<3>. 

@end menu

@node Remoção de APIs e recursos<3>,,,Removidos<9>
@anchor{whatsnew/3 6 api-and-feature-removals}@anchor{d5a}
@subsubsection Remoção de APIs e recursos



@itemize *

@item 
Unknown escapes consisting of @code{'\'} and an ASCII letter in
regular expressions will now cause an error.  In replacement templates for
@ref{2a3,,re.sub()} they are still allowed, but deprecated.
The @ref{b82,,re.LOCALE} flag can now only be used with binary patterns.

@item 
@code{inspect.getmoduleinfo()} was removed (was deprecated since CPython 3.3).
@ref{d5b,,inspect.getmodulename()} should be used for obtaining the module
name for a given path.
(Contributed by Yury Selivanov in bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}.)

@item 
@code{traceback.Ignore} class and @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} methods were removed from the
@ref{fe,,traceback} module. They were undocumented methods deprecated since
Python 3.2 and equivalent functionality is available from private methods.

@item 
The @code{tk_menuBar()} and @code{tk_bindForTraversal()} dummy methods in
@ref{f0,,tkinter} widget classes were removed (corresponding Tk commands
were obsolete since Tk 4.0).

@item 
The @ref{41b,,open()} method of the @ref{6c4,,zipfile.ZipFile}
class no longer supports the @code{'U'} mode (was deprecated since Python 3.4).
Use @ref{7bc,,io.TextIOWrapper} for reading compressed text files in
@ref{d5c,,universal newlines} mode.

@item 
The undocumented @code{IN}, @code{CDROM}, @code{DLFCN}, @code{TYPES}, @code{CDIO}, and
@code{STROPTS} modules have been removed.  They had been available in the
platform specific @code{Lib/plat-*/} directories, but were chronically out of
date, inconsistently available across platforms, and unmaintained.  The
script that created these modules is still available in the source
distribution at Tools/scripts/h2py.py@footnote{https://github.com/python/cpython/blob/v3.6.15/Tools/scripts/h2py.py}.

@item 
The deprecated @code{asynchat.fifo} class has been removed.
@end itemize

@node Porting to Python 3 6,Notable changes in Python 3 6 2,Removidos<9>,What’s New In Python 3 6
@anchor{whatsnew/3 6 porting-to-python-3-6}@anchor{d5d}
@subsection Porting to Python 3.6


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Changes in ‘python’ Command Behavior:: 
* Alterações na API Python: Alterações na API Python<8>. 
* Alterações na API C: Alterações na API C<13>. 
* Alterações de bytecode do CPython: Alterações de bytecode do CPython<8>. 

@end menu

@node Changes in ‘python’ Command Behavior,Alterações na API Python<8>,,Porting to Python 3 6
@anchor{whatsnew/3 6 changes-in-python-command-behavior}@anchor{d5e}
@subsubsection Changes in ‘python’ Command Behavior



@itemize *

@item 
The output of a special Python build with defined @code{COUNT_ALLOCS},
@code{SHOW_ALLOC_COUNT} or @code{SHOW_TRACK_COUNT} macros is now off by
default.  It can be re-enabled using the @code{-X showalloccount} option.
It now outputs to @code{stderr} instead of @code{stdout}.
(Contributed by Serhiy Storchaka in bpo-23034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23034}.)
@end itemize

@node Alterações na API Python<8>,Alterações na API C<13>,Changes in ‘python’ Command Behavior,Porting to Python 3 6
@anchor{whatsnew/3 6 changes-in-the-python-api}@anchor{d5f}
@subsubsection Alterações na API Python



@itemize *

@item 
@ref{51c,,open()} will no longer allow combining the @code{'U'} mode flag
with @code{'+'}.
(Contributed by Jeff Balogh and John O’Connor in bpo-2091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2091}.)

@item 
@ref{cf,,sqlite3} no longer implicitly commits an open transaction before DDL
statements.

@item 
On Linux, @ref{523,,os.urandom()} now blocks until the system urandom entropy pool
is initialized to increase the security.

@item 
When @ref{86e,,importlib.abc.Loader.exec_module()} is defined,
@ref{cce,,importlib.abc.Loader.create_module()} must also be defined.

@item 
@ref{d60,,PyErr_SetImportError()} now sets @ref{2c3,,TypeError} when its `msg'
argument is not set. Previously only @code{NULL} was returned.

@item 
The format of the @ref{2e0,,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{7ad,,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 Propostas de Melhorias do Python; PEP 511
PEP 511@footnote{https://peps.python.org/pep-0511/} for the rationale.

@item 
The functions in the @ref{20,,compileall} module now return booleans instead
of @code{1} or @code{0} to represent success or failure, respectively. Thanks to
booleans being a subclass of integers, this should only be an issue if you
were doing identity checks for @code{1} or @code{0}. See bpo-25768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25768}.

@item 
Reading the @code{port} attribute of
@ref{d61,,urllib.parse.urlsplit()} and @ref{30d,,urlparse()} results
now raises @ref{202,,ValueError} for out-of-range values, rather than
returning @ref{675,,None}.  See bpo-20059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20059}.

@item 
The @code{imp} module now raises a @ref{1a5,,DeprecationWarning} instead of
@ref{8ce,,PendingDeprecationWarning}.

@item 
The following modules have had missing APIs added to their
@ref{d62,,__all__} attributes to match the documented APIs:
@ref{14,,calendar}, @code{cgi}, @ref{29,,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 
When performing a relative import, if @code{__package__} does not compare equal
to @code{__spec__.parent} then @ref{4fa,,ImportWarning} is raised.
(Contributed by Brett Cannon in bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}.)

@item 
When a relative import is performed and no parent package is known, then
@ref{419,,ImportError} will be raised. Previously, @ref{575,,SystemError} could be
raised. (Contributed by Brett Cannon in bpo-18018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18018}.)

@item 
Servers based on the @ref{cd,,socketserver} module, including those
defined in @ref{72,,http.server}, @ref{12f,,xmlrpc.server} and
@ref{11b,,wsgiref.simple_server}, now only catch exceptions derived
from @ref{9e2,,Exception}. Therefore if a request handler raises
an exception like @ref{d63,,SystemExit} or @ref{9d9,,KeyboardInterrupt},
@ref{d64,,handle_error()} is no longer called, and
the exception will stop a single-threaded server. (Contributed by
Martin Panter in bpo-23430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23430}.)

@item 
@code{spwd.getspnam()} now raises a @ref{d65,,PermissionError} instead of
@ref{344,,KeyError} if the user doesn’t have privileges.

@item 
The @ref{d66,,socket.socket.close()} method now raises an exception if
an error (e.g. @code{EBADF}) was reported by the underlying system call.
(Contributed by Martin Panter in 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 
All optional arguments of the @ref{d67,,dump()}, @ref{d68,,dumps()},
@ref{cd4,,load()} and @ref{95c,,loads()} functions and
@ref{d69,,JSONEncoder} and @ref{d6a,,JSONDecoder} class
constructors in the @ref{82,,json} module are now @ref{2a5,,keyword-only}.
(Contributed by Serhiy Storchaka in bpo-18726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18726}.)

@item 
Subclasses de @ref{d6b,,type} que não substituem @code{type.__new__} não podem mais usar a forma com apenas um argumento para obter o tipo de um objeto.

@item 
As part of 
@geindex Propostas de Melhorias do Python; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/}, the handling of keyword arguments passed to
@ref{d6b,,type} (other than the metaclass hint, @code{metaclass}) is now
consistently delegated to @ref{631,,object.__init_subclass__()}. This means that
@ref{580,,type.__new__} and @ref{6b0,,type.__init__} both now accept arbitrary keyword arguments,
but @ref{631,,object.__init_subclass__()} (which is called from
@ref{580,,type.__new__}) will reject them by default.
Custom metaclasses accepting additional keyword arguments will need to adjust
their calls to @ref{580,,type.__new__}
(whether direct or via @ref{4db,,super}) accordingly.

@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

This behavior has also been backported to earlier Python versions
by Setuptools 26.0.0.

@item 
In the @ref{10b,,urllib.request} module and the
@ref{cc9,,http.client.HTTPConnection.request()} method, if no Content-Length
header field has been specified and the request body is a file object,
it is now sent with HTTP 1.1 chunked encoding. If a file object has to
be sent to a HTTP 1.0 server, the Content-Length value now has to be
specified by the caller.
(Contributed by Demian Brecht and Rolf Krahl with tweaks from
Martin Panter in bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}.)

@item 
The @ref{9ed,,DictReader} now returns rows of type
@ref{5db,,OrderedDict}.
(Contributed by Steve Holden in 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 
The `verbose' and `rename' arguments for
@ref{1ca,,namedtuple()} are now keyword-only.
(Contributed by Raymond Hettinger in bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}.)

@item 
On Linux, @ref{d6c,,ctypes.util.find_library()} now looks in
@code{LD_LIBRARY_PATH} for shared libraries.
(Contributed by Vinay Sajip in bpo-9998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9998}.)

@item 
The @ref{909,,imaplib.IMAP4} class now handles flags containing the
@code{']'} character in messages sent from the server to improve
real-world compatibility.
(Contributed by Lita Cho in bpo-21815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21815}.)

@item 
The @ref{d6d,,mmap.mmap.write()} function now returns the number
of bytes written like other write methods.
(Contributed by Jakub Stasiak in bpo-26335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26335}.)

@item 
The @ref{d6e,,pkgutil.iter_modules()} and @ref{c19,,pkgutil.walk_packages()}
functions now return @ref{d6f,,ModuleInfo} named tuples.
(Contributed by Ramchandra Apte in bpo-17211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17211}.)

@item 
@ref{2a3,,re.sub()} now raises an error for invalid numerical group
references in replacement templates even if the pattern is not
found in the string.  The error message for invalid group references
now includes the group index and the position of the reference.
(Contributed by SilentGhost, Serhiy Storchaka in bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}.)

@item 
@ref{6c4,,zipfile.ZipFile} will now raise @ref{228,,NotImplementedError} for
unrecognized compression values.  Previously a plain @ref{195,,RuntimeError}
was raised.  Additionally, calling @ref{6c4,,ZipFile} methods
on a closed ZipFile or calling the @ref{d70,,write()} method
on a ZipFile created with mode @code{'r'} will raise a @ref{202,,ValueError}.
Previously, a @ref{195,,RuntimeError} was raised in those scenarios.

@item 
when custom metaclasses are combined with zero-argument @ref{4db,,super()} or
direct references from methods to the implicit @code{__class__} closure
variable, the implicit @code{__classcell__} namespace entry must now be passed
up to @code{type.__new__} for initialisation. Failing to do so will result in
a @ref{1a5,,DeprecationWarning} in Python 3.6 and a @ref{195,,RuntimeError} in
Python 3.8.

@item 
With the introduction of @ref{b5b,,ModuleNotFoundError}, import system consumers
may start expecting import system replacements to raise that more specific
exception when appropriate, rather than the less-specific @ref{419,,ImportError}.
To provide future compatibility with such consumers, implementers of
alternative import systems that completely replace @ref{8da,,__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 Alterações na API C<13>,Alterações de bytecode do CPython<8>,Alterações na API Python<8>,Porting to Python 3 6
@anchor{whatsnew/3 6 changes-in-the-c-api}@anchor{d71}
@subsubsection Alterações na API C



@itemize *

@item 
The @ref{c81,,PyMem_Malloc()} allocator family now uses the @ref{d31,,pymalloc allocator} rather than the system @code{malloc()}. Applications calling
@ref{c81,,PyMem_Malloc()} without holding the GIL can now crash. Set the
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable to @code{debug} to validate the
usage of memory allocators in your application. See bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}.

@item 
@ref{d72,,Py_Exit()} (and the main interpreter) now override the exit status
with 120 if flushing buffered data failed.  See bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}.
@end itemize

@node Alterações de bytecode do CPython<8>,,Alterações na API C<13>,Porting to Python 3 6
@anchor{whatsnew/3 6 cpython-bytecode-changes}@anchor{d73}
@subsubsection Alterações de bytecode do CPython


There have been several major changes to the @ref{187,,bytecode} in Python 3.6.


@itemize *

@item 
The Python interpreter now uses a 16-bit wordcode instead of bytecode.
(Contributed by Demur Rumed with input and reviews from
Serhiy Storchaka and Victor Stinner in bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} and bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050}.)

@item 
The new @code{FORMAT_VALUE} and @ref{d74,,BUILD_STRING} opcodes as part
of the  @ref{c4a,,formatted string literal} implementation.
(Contributed by Eric Smith in bpo-25483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25483} and
Serhiy Storchaka in bpo-27078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27078}.)

@item 
The new @ref{d75,,BUILD_CONST_KEY_MAP} opcode to optimize the creation
of dictionaries with constant keys.
(Contributed by Serhiy Storchaka in bpo-27140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27140}.)

@item 
The function call opcodes have been heavily reworked for better performance
and simpler implementation.
The @ref{d76,,MAKE_FUNCTION}, @code{CALL_FUNCTION},
@code{CALL_FUNCTION_KW} and @code{BUILD_MAP_UNPACK_WITH_CALL} opcodes
have been modified, the new @ref{d77,,CALL_FUNCTION_EX} and
@code{BUILD_TUPLE_UNPACK_WITH_CALL} have been added, and
@code{CALL_FUNCTION_VAR}, @code{CALL_FUNCTION_VAR_KW} and @code{MAKE_CLOSURE} opcodes
have been removed.
(Contributed by Demur Rumed in bpo-27095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27095}, and Serhiy Storchaka in
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 
The new @ref{d78,,SETUP_ANNOTATIONS} and @code{STORE_ANNOTATION} opcodes
have been added to support the new @ref{d79,,variable annotation} syntax.
(Contributed by Ivan Levkivskyi in bpo-27985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27985}.)
@end itemize

@node Notable changes in Python 3 6 2,Notable changes in Python 3 6 4,Porting to Python 3 6,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-2}@anchor{d7a}
@subsection Notable changes in Python 3.6.2


@menu
* Novo alvo de construção make regen-all:: 
* Remoção do alvo de construção make touch:: 

@end menu

@node Novo alvo de construção make regen-all,Remoção do alvo de construção make touch,,Notable changes in Python 3 6 2
@anchor{whatsnew/3 6 new-make-regen-all-build-target}@anchor{d7b}
@subsubsection Novo alvo de construção @code{make regen-all}


Para simplificar a compilação cruzada e garantir que o CPython possa ser compilado de forma confiável sem exigir que uma versão existente do Python já esteja disponível, o sistema de construção baseado em autotools não tenta mais recompilar implicitamente os arquivos gerados com base nos tempos de modificação dos arquivos.

Em vez disso, um novo comando @code{make regen-all} foi adicionado para forçar a regeneração desses arquivos quando desejado (por exemplo, após uma versão inicial do Python já ter sido construída com base nas versões pré-geradas).

Alvos de regeneração mais seletivos também são definidos – veja Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.13/Makefile.pre.in} para detalhes.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Adicionado na versão 3.6.2.


@node Remoção do alvo de construção make touch,,Novo alvo de construção make regen-all,Notable changes in Python 3 6 2
@anchor{whatsnew/3 6 removal-of-make-touch-build-target}@anchor{d7c}
@subsubsection Remoção do alvo de construção @code{make touch}


O alvo de construção @code{make touch} usado anteriormente para solicitar regeneração implícita de arquivos gerados atualizando seus tempos de modificação foi removido.

Ele foi substituído pelo novo alvo @code{make regen-all}.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Alterado na versão 3.6.2.


@node Notable changes in Python 3 6 4,Notable changes in Python 3 6 5,Notable changes in Python 3 6 2,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-4}@anchor{d7d}
@subsection Notable changes in Python 3.6.4


The @code{PyExc_RecursionErrorInst} singleton that was part of the public API
has been removed as its members being never cleared may cause a segfault
during finalization of the interpreter.
(Contributed by Xavier de Gaye in bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} and bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}.)

@node Notable changes in Python 3 6 5,Notable changes in Python 3 6 7,Notable changes in Python 3 6 4,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-5}@anchor{d7e}
@subsection Notable changes in Python 3.6.5


The @ref{c18,,locale.localeconv()} function now sets temporarily the @code{LC_CTYPE}
locale to the @code{LC_NUMERIC} locale in some cases.
(Contributed by Victor Stinner in bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}.)

@node Notable changes in Python 3 6 7,Notable changes in Python 3 6 10,Notable changes in Python 3 6 5,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-7}@anchor{d7f}
@subsection Notable changes in 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}.

In 3.6.7 the @ref{fb,,tokenize} module now implicitly emits a @code{NEWLINE} token
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 in bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}.)

@node Notable changes in Python 3 6 10,Notable changes in Python 3 6 13,Notable changes in Python 3 6 7,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-10}@anchor{d80}
@subsection Notable changes in Python 3.6.10


Devido a significativas preocupações de segurança, o parâmetro `reuse_address' de @ref{733,,asyncio.loop.create_datagram_endpoint()} não é mais suportado. Isso ocorre devido ao comportamento da opção de soquete @code{SO_REUSEADDR} no UDP. Para mais detalhes, consulte a documentação de @code{loop.create_datagram_endpoint()}. (Contribuição de Kyle Stanley, Antoine Pitrou e Yury Selivanov em bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}.)

@node Notable changes in Python 3 6 13,Notable changes in Python 3 6 14,Notable changes in Python 3 6 10,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-13}@anchor{d81}
@subsection Notable changes in Python 3.6.13


Versões anteriores do Python permitiam o uso de @code{;} e @code{&} como separadores de parâmetros de consulta nas funções @ref{27a,,urllib.parse.parse_qs()} e @ref{279,,urllib.parse.parse_qsl()}. Devido a questões de segurança, e em conformidade com as recomendações mais recentes do W3C, isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como padrão. Esta mudança também afeta as funções @code{cgi.parse()} e @code{cgi.parse_multipart()} já que elas usam as funções afetadas internamente. Para obter mais detalhes, consulte sua respectiva documentação. (Contribuição de Adam Goldschmidt, Senthil Kumaran e Ken Jin em bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}.)

@node Notable changes in Python 3 6 14,,Notable changes in Python 3 6 13,What’s New In Python 3 6
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-14}@anchor{d82}
@subsection Notable changes in Python 3.6.14


Uma correção de segurança altera o comportamento @ref{900,,ftplib.FTP} para não confiar no endereço IPv4 enviado do servidor remoto ao configurar um canal de dados passivo. Em vez disso, reutilizamos o endereço IP do servidor ftp. Para códigos incomuns que requerem o comportamento antigo, defina um atributo @code{trust_server_pasv_ipv4_address} em sua instância de FTP para @code{True}. (Veja 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 O que há de novo no Python 3 5,O que há de novo no Python 3 4,What’s New In Python 3 6,O que há de novo no Python
@anchor{whatsnew/3 5 doc}@anchor{d83}@anchor{whatsnew/3 5 translation-repo}@anchor{d84}@anchor{whatsnew/3 5 what-s-new-in-python-3-5}@anchor{d85}
@section O que há de novo no 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.

This article explains the new features in Python 3.5, compared to 3.4.
Python 3.5 was released on September 13, 2015.  See the
changelog@footnote{https://docs.python.org/3.5/whatsnew/changelog.html} for a full
list of changes.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 478
PEP 478@footnote{https://peps.python.org/pep-0478/} - Python 3.5 Release Schedule


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<9>. 
* Novas funcionalidades: Novas funcionalidades<14>. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<9>. 
* Novos módulos: Novos módulos<9>. 
* Módulos melhorados: Módulos melhorados<9>. 
* Other module-level changes:: 
* Otimizações: Otimizações<9>. 
* Mudanças a construções e API C: Mudanças a construções e API C<3>. 
* Descontinuados: Descontinuados<10>. 
* Removidos: Removidos<10>. 
* Porting to Python 3.5: Porting to Python 3 5. 
* Notable changes in Python 3.5.4: Notable changes in Python 3 5 4. 

@end menu

@node Resumo – Destaques da versão<9>,Novas funcionalidades<14>,,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 summary-release-highlights}@anchor{d86}
@subsection Resumo – Destaques da versão


Novos recursos de sintaxe:


@itemize *

@item 
@ref{d87,,PEP 492}, coroutines with async and await syntax.

@item 
@ref{d88,,PEP 465}, a new matrix multiplication operator: @code{a @@ b}.

@item 
@ref{d89,,PEP 448}, additional unpacking generalizations.
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@ref{104,,typing}: @ref{d8a,,PEP 484 – Type Hints}.

@item 
@ref{130,,zipapp}: @ref{d8b,,PEP 441 Improving Python ZIP Application Support}.
@end itemize

Novos recursos embutidos:


@itemize *

@item 
@code{bytes % args}, @code{bytearray % args}: @ref{d8c,,PEP 461} –
Adding @code{%} formatting to bytes and bytearray.

@item 
New @ref{d8d,,bytes.hex()}, @ref{d8e,,bytearray.hex()} and @ref{d8f,,memoryview.hex()}
methods. (Contributed by Arnon Yaari in bpo-9951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9951}.)

@item 
@ref{2eb,,memoryview} now supports tuple indexing (including multi-dimensional).
(Contributed by Antoine Pitrou in bpo-23632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23632}.)

@item 
Generators have a new @code{gi_yieldfrom} attribute, which returns the
object being iterated by @code{yield from} expressions. (Contributed
by Benno Leslie and Yury Selivanov in bpo-24450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24450}.)

@item 
A new @ref{d90,,RecursionError} exception is now raised when maximum
recursion depth is reached.  (Contributed by Georg Brandl
in bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}.)
@end itemize

Melhorias na implementação do CPython:


@itemize *

@item 
When the @code{LC_TYPE} locale is the POSIX locale (@code{C} locale),
@ref{53d,,sys.stdin} and @ref{ae6,,sys.stdout} now use the
@code{surrogateescape} error handler, instead of the @code{strict} error handler.
(Contributed by Victor Stinner in bpo-19977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19977}.)

@item 
@code{.pyo} files are no longer used and have been replaced by a more flexible
scheme that includes the optimization level explicitly in @code{.pyc} name.
(See @ref{d91,,PEP 488 overview}.)

@item 
Builtin and extension modules are now initialized in a multi-phase process,
which is similar to how Python modules are loaded.
(See @ref{d92,,PEP 489 overview}.)
@end itemize

Melhorias significativas na biblioteca padrão:


@itemize *

@item 
@ref{5db,,collections.OrderedDict} is now
@ref{d93,,implemented in C}, which makes it
4 to 100 times faster.

@item 
The @ref{d0,,ssl} module gained
@ref{d94,,support for Memory BIO}, which decouples SSL
protocol handling from network IO.

@item 
The new @ref{a68,,os.scandir()} function provides a
@ref{d95,,better and significantly faster way}
of directory traversal.

@item 
@ref{9f7,,functools.lru_cache()} has been mostly
@ref{d96,,reimplemented in C}, yielding much better
performance.

@item 
The new @ref{b9e,,subprocess.run()} function provides a
@ref{d97,,streamlined way to run subprocesses}.

@item 
The @ref{fe,,traceback} module has been significantly
@ref{d98,,enhanced} for improved
performance and developer convenience.
@end itemize

Melhorias de Segurança:


@itemize *

@item 
SSLv3 is now disabled throughout the standard library.
It can still be enabled by instantiating a @ref{294,,ssl.SSLContext}
manually.  (See bpo-22638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22638} for more details; this change was
backported to CPython 3.4 and 2.7.)

@item 
HTTP cookie parsing is now stricter, in order to protect
against potential injection attacks. (Contributed by Antoine Pitrou
in bpo-22796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22796}.)
@end itemize

Melhorias do Windows:


@itemize *

@item 
A new installer for Windows has replaced the old MSI.
See @ref{ab6,,Utilizando Python no Windows} for more information.

@item 
Windows builds now use Microsoft Visual C++ 14.0, and extension modules
should use the same.
@end itemize

Please read on for a comprehensive list of user-facing changes, including many
other smaller improvements, CPython optimizations, deprecations, and potential
porting issues.

@node Novas funcionalidades<14>,Outras mudanças na linguagem<9>,Resumo – Destaques da versão<9>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 new-features}@anchor{d99}
@subsection Novas funcionalidades


@menu
* PEP 492 - Coroutines with async and await syntax:: 
* PEP 465 - A dedicated infix operator for matrix multiplication:: 
* PEP 448 - Additional Unpacking Generalizations:: 
* PEP 461 - percent formatting support for bytes and bytearray:: 
* PEP 484 - Type Hints:: 
* PEP 471 - os.scandir() function – a better and faster directory iterator: PEP 471 - os scandir function – a better and faster directory iterator. 
* PEP 475; Retry system calls failing with EINTR: PEP 475 Retry system calls failing with EINTR. 
* PEP 479; Change StopIteration handling inside generators: PEP 479 Change StopIteration handling inside generators. 
* PEP 485; A function for testing approximate equality: PEP 485 A function for testing approximate equality. 
* PEP 486; Make the Python Launcher aware of virtual environments: PEP 486 Make the Python Launcher aware of virtual environments. 
* PEP 488; Elimination of PYO files: PEP 488 Elimination of PYO files. 
* PEP 489; Multi-phase extension module initialization: PEP 489 Multi-phase extension module initialization. 

@end menu

@node PEP 492 - Coroutines with async and await syntax,PEP 465 - A dedicated infix operator for matrix multiplication,,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-492-coroutines-with-async-and-await-syntax}@anchor{d9a}@anchor{whatsnew/3 5 whatsnew-pep-492}@anchor{d87}
@subsubsection PEP 492 - Coroutines with async and await syntax


@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} greatly improves support for asynchronous programming in Python
by adding @ref{1ad,,awaitable objects},
@ref{d9b,,coroutine functions},
@ref{d9c,,asynchronous iteration},
and @ref{5d7,,asynchronous context managers}.

Coroutine functions are declared using the new @ref{5d1,,async def} syntax:

@example
>>> async def coro():
...     return 'spam'
@end example

Inside a coroutine function, the new @ref{1b9,,await} expression can be used
to suspend coroutine execution until the result is available.  Any object
can be `awaited', as long as it implements the @ref{1ad,,awaitable} protocol by
defining the @ref{d9d,,__await__()} method.

PEP 492 also adds @ref{aba,,async for} statement for convenient iteration
over asynchronous iterables.

An example of a rudimentary HTTP client written using the new syntax:

@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

Similarly to asynchronous iteration, there is a new syntax for asynchronous
context managers.  The following 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

will output:

@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

Note that both @ref{aba,,async for} and @ref{5d5,,async with} can only
be used inside a coroutine function declared with @ref{5d1,,async def}.

Coroutine functions are intended to be run inside a compatible event loop,
such as the @ref{d9e,,asyncio loop}.

@cartouche
@quotation Nota 

Alterado na versão 3.5.2: Starting with CPython 3.5.2, @code{__aiter__} can directly return
@ref{1ab,,asynchronous iterators}.  Returning
an @ref{1ad,,awaitable} object will result in a
@ref{8ce,,PendingDeprecationWarning}.

See more details in the @ref{d9f,,Iteradores assíncronos} documentation
section.

@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} – Coroutines with async and await syntax

PEP written and implemented by Yury Selivanov.
@end table


@node PEP 465 - A dedicated infix operator for matrix multiplication,PEP 448 - Additional Unpacking Generalizations,PEP 492 - Coroutines with async and await syntax,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-465-a-dedicated-infix-operator-for-matrix-multiplication}@anchor{da0}@anchor{whatsnew/3 5 whatsnew-pep-465}@anchor{d88}
@subsubsection PEP 465 - A dedicated infix operator for matrix multiplication


@geindex Propostas de Melhorias do Python; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} adds the @code{@@} infix operator for matrix multiplication.
Currently, no builtin Python types implement the new operator, however, it
can be implemented by defining @ref{da1,,__matmul__()},
@ref{da2,,__rmatmul__()}, and @ref{da3,,__imatmul__()} for regular,
reflected, and in-place matrix multiplication.
The semantics of these methods is similar to that of
methods defining other infix arithmetic operators.

Matrix multiplication is a notably common operation in many fields of
mathematics, science, engineering, and the addition of @code{@@} allows writing
cleaner code:

@example
S = (H @@ beta - r).T @@ inv(H @@ V @@ H.T) @@ (H @@ beta - r)
@end example

instead of:

@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 has support for the new operator:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 465

@item PEP 465@footnote{https://peps.python.org/pep-0465/} – A dedicated infix operator for matrix multiplication

PEP written by Nathaniel J. Smith; implemented by Benjamin Peterson.
@end table


@node PEP 448 - Additional Unpacking Generalizations,PEP 461 - percent formatting support for bytes and bytearray,PEP 465 - A dedicated infix operator for matrix multiplication,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-448-additional-unpacking-generalizations}@anchor{da4}@anchor{whatsnew/3 5 whatsnew-pep-448}@anchor{d89}
@subsubsection PEP 448 - Additional Unpacking Generalizations


@geindex Propostas de Melhorias do Python; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} extends the allowed uses of the @code{*} iterable unpacking
operator and @code{**} dictionary unpacking operator.  It is now possible
to use an arbitrary number of unpackings in @ref{da5,,function calls}:

@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

Similarly, tuple, list, set, and dictionary displays allow multiple
unpackings (see @ref{da6,,Listas de expressões} and @ref{da7,,Sintaxes de criação de dicionário}):

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 448

@item PEP 448@footnote{https://peps.python.org/pep-0448/} – Additional Unpacking Generalizations

PEP written by Joshua Landau; implemented by Neil Girdhar,
Thomas Wouters, and Joshua Landau.
@end table


@node PEP 461 - percent formatting support for bytes and bytearray,PEP 484 - Type Hints,PEP 448 - Additional Unpacking Generalizations,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-461-percent-formatting-support-for-bytes-and-bytearray}@anchor{da8}@anchor{whatsnew/3 5 whatsnew-pep-461}@anchor{d8c}
@subsubsection PEP 461 - percent formatting support for bytes and bytearray


@geindex Propostas de Melhorias do Python; PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} adds support for the @code{%}
@ref{da9,,interpolation operator} to @ref{1c2,,bytes}
and @ref{2ea,,bytearray}.

While interpolation is usually thought of as a string operation, there are
cases where interpolation on @code{bytes} or @code{bytearrays} makes sense, and the
work needed to make up for this missing functionality detracts from the
overall readability of the code.  This issue is particularly important when
dealing with wire format protocols, which are often a mixture of binary
and ASCII compatible text.

Exemplos:

@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 is not allowed for @code{%b}, but it is accepted by @code{%a} (equivalent of
@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

Note that @code{%s} and @code{%r} conversion types, although supported, should
only be used in codebases that need compatibility with Python 2.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 461

@item PEP 461@footnote{https://peps.python.org/pep-0461/} – Adding % formatting to bytes and bytearray

PEP written by Ethan Furman; implemented by Neil Schemenauer and
Ethan Furman.
@end table


@node PEP 484 - Type Hints,PEP 471 - os scandir function – a better and faster directory iterator,PEP 461 - percent formatting support for bytes and bytearray,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-484-type-hints}@anchor{daa}@anchor{whatsnew/3 5 whatsnew-pep-484}@anchor{d8a}
@subsubsection PEP 484 - Type Hints


Function annotation syntax has been a Python feature since version 3.0
(
@geindex Propostas de Melhorias do Python; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}), however the semantics of annotations has been left undefined.

Experience has shown that the majority of function annotation
uses were to provide type hints to function parameters and return values.  It
became evident that it would be beneficial for Python users, if the
standard library included the base definitions and tools for type annotations.

@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} introduces a @ref{b16,,provisional module} to
provide these standard definitions and tools, along with some conventions
for situations where annotations are not available.

For example, here is a simple function whose argument and return type
are declared in the annotations:

@example
def greeting(name: str) -> str:
    return 'Hello ' + name
@end example

While these annotations are available at runtime through the usual
@code{__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.

The type system supports unions, generic types, and a special type
named @ref{6ac,,Any} which is consistent with (i.e. assignable to
and from) all types.


@subsubheading Ver também



@itemize *

@item 
@ref{104,,typing} documentação do módulo

@item 

@table @asis

@geindex Propostas de Melhorias do Python; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} – Type Hints

PEP written by Guido van Rossum, Jukka Lehtosalo, and Łukasz Langa;
implemented by Guido van Rossum.
@end table

@item 

@table @asis

@geindex Propostas de Melhorias do Python; PEP 483

@item PEP 483@footnote{https://peps.python.org/pep-0483/} – The Theory of Type Hints

PEP escrito por Guido van Rossum
@end table
@end itemize


@node PEP 471 - os scandir function – a better and faster directory iterator,PEP 475 Retry system calls failing with EINTR,PEP 484 - Type Hints,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-471-os-scandir-function-a-better-and-faster-directory-iterator}@anchor{dab}@anchor{whatsnew/3 5 whatsnew-pep-471}@anchor{d95}
@subsubsection PEP 471 - os.scandir() function – a better and faster directory iterator


@geindex Propostas de Melhorias do Python; PEP 471
PEP 471@footnote{https://peps.python.org/pep-0471/} adds a new directory iteration function, @ref{a68,,os.scandir()},
to the standard library.  Additionally, @ref{4a9,,os.walk()} is now
implemented using @code{scandir}, which makes it 3 to 5 times faster
on POSIX systems and 7 to 20 times faster on Windows systems.  This is
largely achieved by greatly reducing the number of calls to @ref{4a0,,os.stat()}
required to walk a directory tree.

Additionally, @code{scandir} returns an iterator, as opposed to returning
a list of file names, which improves memory efficiency when iterating
over very large directories.

The following example shows a simple use of @ref{a68,,os.scandir()} to display all
the files (excluding directories) in the given `path' that don’t start with
@code{'.'}. The @ref{dac,,entry.is_file()} call will generally
not make an additional system call:

@example
for entry in os.scandir(path):
    if not entry.name.startswith('.') and entry.is_file():
        print(entry.name)
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 471

@item PEP 471@footnote{https://peps.python.org/pep-0471/} – os.scandir() function – a better and faster directory iterator

PEP written and implemented by Ben Hoyt with the help of Victor Stinner.
@end table


@node PEP 475 Retry system calls failing with EINTR,PEP 479 Change StopIteration handling inside generators,PEP 471 - os scandir function – a better and faster directory iterator,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-475-retry-system-calls-failing-with-eintr}@anchor{dad}@anchor{whatsnew/3 5 whatsnew-pep-475}@anchor{dae}
@subsubsection PEP 475: Retry system calls failing with EINTR


An @ref{daf,,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{db0,,InterruptedError} in such cases.  This meant that, when writing a
Python application, the developer had two choices:


@enumerate 

@item 
Ignore the @code{InterruptedError}.

@item 
Handle the @code{InterruptedError} and attempt to restart the interrupted
system call at every call site.
@end enumerate

The first option makes an application fail intermittently.
The second option adds a large amount of boilerplate that makes the
code nearly unreadable.  Compare:

@example
print("Hello World")
@end example

e:

@example
while True:
    try:
        print("Hello World")
        break
    except InterruptedError:
        continue
@end example

@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} implements automatic retry of system calls on
@code{EINTR}.  This removes the burden of dealing with @code{EINTR}
or @ref{db0,,InterruptedError} in user code in most situations and makes
Python programs, including the standard library, more robust.  Note that
the system call is only retried if the signal handler does not raise an
exception.

Below is a list of functions which are now retried when interrupted
by a signal:


@itemize *

@item 
@ref{51c,,open()} and @ref{51d,,io.open()};

@item 
functions of the @ref{58,,faulthandler} module;

@item 
@ref{a1,,os} functions: @ref{db1,,fchdir()}, @ref{21c,,fchmod()},
@ref{db2,,fchown()}, @ref{db3,,fdatasync()}, @ref{db4,,fstat()},
@ref{db5,,fstatvfs()}, @ref{db6,,fsync()}, @ref{db7,,ftruncate()},
@ref{db8,,mkfifo()}, @ref{db9,,mknod()}, @ref{dba,,open()},
@ref{dbb,,posix_fadvise()}, @ref{dbc,,posix_fallocate()}, @ref{b75,,pread()},
@ref{b78,,pwrite()}, @ref{dbd,,read()}, @ref{b74,,readv()}, @ref{b21,,sendfile()},
@ref{dbe,,wait3()}, @ref{dbf,,wait4()}, @ref{dc0,,wait()},
@ref{dc1,,waitid()}, @ref{dc2,,waitpid()}, @ref{dc3,,write()},
@ref{b77,,writev()};

@item 
special cases: @ref{b8a,,os.close()} and @ref{b79,,os.dup2()} now ignore
@ref{daf,,EINTR} errors; the syscall is not retried (see the PEP
for the rationale);

@item 
@ref{c1,,select} functions: @ref{dc4,,devpoll.poll()},
@ref{dc5,,epoll.poll()},
@ref{dc6,,kqueue.control()},
@ref{dc7,,poll.poll()}, @ref{dc8,,select()};

@item 
methods of the @ref{dc9,,socket} class: @ref{dca,,accept()},
@ref{dcb,,connect()} (except for non-blocking sockets),
@ref{dcc,,recv()}, @ref{dcd,,recvfrom()},
@ref{dce,,recvmsg()}, @ref{dcf,,send()},
@ref{dd0,,sendall()}, @ref{476,,sendmsg()},
@ref{dd1,,sendto()};

@item 
@ref{dd2,,signal.sigtimedwait()} and @ref{dd3,,signal.sigwaitinfo()};

@item 
@ref{69d,,time.sleep()}.
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 475

@item PEP 475@footnote{https://peps.python.org/pep-0475/} – Retry system calls failing with EINTR

PEP and implementation written by Charles-François Natali and
Victor Stinner, with the help of Antoine Pitrou (the French connection).
@end table


@node PEP 479 Change StopIteration handling inside generators,PEP 485 A function for testing approximate equality,PEP 475 Retry system calls failing with EINTR,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-479-change-stopiteration-handling-inside-generators}@anchor{dd4}@anchor{whatsnew/3 5 whatsnew-pep-479}@anchor{d41}
@subsubsection PEP 479: Change StopIteration handling inside generators


The interaction of generators and @ref{c15,,StopIteration} in Python 3.4 and
earlier was sometimes surprising, and could conceal obscure bugs.  Previously,
@code{StopIteration} raised accidentally inside a generator function was
interpreted as the end of the iteration by the loop construct driving the
generator.

@geindex Propostas de Melhorias do Python; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} changes the behavior of generators: when a @code{StopIteration}
exception is raised inside a generator, it is replaced with a
@ref{195,,RuntimeError} before it exits the generator frame.  The main goal of
this change is to ease debugging in the situation where an unguarded
@ref{7d9,,next()} call raises @code{StopIteration} and causes the iteration controlled
by the generator to terminate silently. This is particularly pernicious in
combination with the @code{yield from} construct.

This is a backwards incompatible change, so to enable the new behavior,
a @ref{dd5,,__future__} import is necessary:

@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

Without a @code{__future__} import, a @ref{8ce,,PendingDeprecationWarning} will be
raised whenever a @ref{c15,,StopIteration} exception is raised inside a generator.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 479

@item PEP 479@footnote{https://peps.python.org/pep-0479/} – Change StopIteration handling inside generators

PEP written by Chris Angelico and Guido van Rossum. Implemented by
Chris Angelico, Yury Selivanov and Nick Coghlan.
@end table


@node PEP 485 A function for testing approximate equality,PEP 486 Make the Python Launcher aware of virtual environments,PEP 479 Change StopIteration handling inside generators,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-485-a-function-for-testing-approximate-equality}@anchor{dd6}@anchor{whatsnew/3 5 whatsnew-pep-485}@anchor{dd7}
@subsubsection PEP 485: A function for testing approximate equality


@geindex Propostas de Melhorias do Python; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} adds the @ref{dd8,,math.isclose()} and @ref{dd9,,cmath.isclose()}
functions which tell whether two values are approximately equal or
“close” to each other.  Whether or not two values are considered
close is determined according to given absolute and relative tolerances.
Relative tolerance is the maximum allowed difference between @code{isclose}
arguments, relative to the larger absolute value:

@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

It is also possible to compare two values using absolute tolerance, which
must be a non-negative value:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 485

@item PEP 485@footnote{https://peps.python.org/pep-0485/} – Uma função para testar igualdade aproximada

PEP written by Christopher Barker; implemented by Chris Barker and
Tal Einat.
@end table


@node PEP 486 Make the Python Launcher aware of virtual environments,PEP 488 Elimination of PYO files,PEP 485 A function for testing approximate equality,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-486-make-the-python-launcher-aware-of-virtual-environments}@anchor{dda}@anchor{whatsnew/3 5 whatsnew-pep-486}@anchor{ddb}
@subsubsection PEP 486: Make the Python Launcher aware of virtual environments


@geindex Propostas de Melhorias do Python; PEP 486
PEP 486@footnote{https://peps.python.org/pep-0486/} makes the Windows launcher (see 
@geindex Propostas de Melhorias do Python; PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/}) aware of an active
virtual environment. When the default interpreter would be used and the
@code{VIRTUAL_ENV} environment variable is set, the interpreter in the virtual
environment will be used.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 486

@item PEP 486@footnote{https://peps.python.org/pep-0486/} – Make the Python Launcher aware of virtual environments

PEP written and implemented by Paul Moore.
@end table


@node PEP 488 Elimination of PYO files,PEP 489 Multi-phase extension module initialization,PEP 486 Make the Python Launcher aware of virtual environments,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-488-elimination-of-pyo-files}@anchor{ddc}@anchor{whatsnew/3 5 whatsnew-pep-488}@anchor{d91}
@subsubsection PEP 488: Elimination of PYO files


@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} does away with the concept of @code{.pyo} files. This means that
@code{.pyc} files represent both unoptimized and optimized bytecode. To prevent the
need to constantly regenerate bytecode files, @code{.pyc} files now have an
optional @code{opt-} tag in their name when the bytecode is optimized. This has the
side-effect of no more bytecode file name clashes when running under either
@ref{ddd,,-O} or @ref{dde,,-OO}. Consequently, bytecode files generated from
@ref{ddd,,-O}, and @ref{dde,,-OO} may now exist simultaneously.
@ref{2fe,,importlib.util.cache_from_source()} has an updated API to help with
this change.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/} – Elimination of PYO files

PEP written and implemented by Brett Cannon.
@end table


@node PEP 489 Multi-phase extension module initialization,,PEP 488 Elimination of PYO files,Novas funcionalidades<14>
@anchor{whatsnew/3 5 pep-489-multi-phase-extension-module-initialization}@anchor{ddf}@anchor{whatsnew/3 5 whatsnew-pep-489}@anchor{d92}
@subsubsection PEP 489: Multi-phase extension module initialization


@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} updates extension module initialization to take advantage of the
two step module loading mechanism introduced by 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} in Python 3.4.

This change brings the import semantics of extension modules that opt-in to
using the new mechanism much closer to those of Python source and bytecode
modules, including the ability to use any valid identifier as a module name,
rather than being restricted to ASCII.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/} – Inicialização de módulo extensão multifase

PEP written by Petr Viktorin, Stefan Behnel, and Nick Coghlan;
implemented by Petr Viktorin.
@end table


@node Outras mudanças na linguagem<9>,Novos módulos<9>,Novas funcionalidades<14>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 other-language-changes}@anchor{de0}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
Added the @code{"namereplace"} error handlers.  The @code{"backslashreplace"}
error handlers now work with decoding and translating.
(Contributed by Serhiy Storchaka in bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676} and bpo-22286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22286}.)

@item 
The @ref{5e3,,-b} option now affects comparisons of @ref{1c2,,bytes} with
@ref{257,,int}.  (Contributed by Serhiy Storchaka in bpo-23681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23681}.)

@item 
New Kazakh @code{kz1048} and Tajik @code{koi8_t} @ref{de1,,codecs}.
(Contributed by Serhiy Storchaka in bpo-22682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22682} and bpo-22681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22681}.)

@item 
Property docstrings are now writable. This is especially useful for
@ref{1ca,,collections.namedtuple()} docstrings.
(Contributed by Berker Peksag in bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}.)

@item 
Circular imports involving relative imports are now supported.
(Contributed by Brett Cannon and Antoine Pitrou in bpo-17636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17636}.)
@end itemize

@node Novos módulos<9>,Módulos melhorados<9>,Outras mudanças na linguagem<9>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 new-modules}@anchor{de2}
@subsection Novos módulos


@menu
* typing: typing<10>. 
* zipapp: zipapp<2>. 

@end menu

@node typing<10>,zipapp<2>,,Novos módulos<9>
@anchor{whatsnew/3 5 typing}@anchor{de3}
@subsubsection typing


The new @ref{104,,typing} @ref{b16,,provisional} module
provides standard definitions and tools for function type annotations.
See @ref{d8a,,Type Hints} for more information.

@node zipapp<2>,,typing<10>,Novos módulos<9>
@anchor{whatsnew/3 5 whatsnew-zipapp}@anchor{d8b}@anchor{whatsnew/3 5 zipapp}@anchor{de4}
@subsubsection zipapp


The new @ref{130,,zipapp} module (specified in 
@geindex Propostas de Melhorias do Python; PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/}) provides an API and
command line tool for creating executable Python Zip Applications, which
were introduced in Python 2.6 in bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}, but which were not well
publicized, either at the time or since.

With the new module, bundling your application is as simple as putting all
the files, including a @code{__main__.py} file, into a directory @code{myapp}
and running:

@example
$ python -m zipapp myapp
$ python myapp.pyz
@end example

The module implementation has been contributed by Paul Moore in
bpo-23491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23491}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/} – Improving Python ZIP Application Support


@node Módulos melhorados<9>,Other module-level changes,Novos módulos<9>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 improved-modules}@anchor{de5}
@subsection Módulos melhorados


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

@end menu

@node argparse<4>,asyncio<10>,,Módulos melhorados<9>
@anchor{whatsnew/3 5 argparse}@anchor{de6}
@subsubsection argparse


The @ref{539,,ArgumentParser} class now allows disabling
@ref{de7,,abbreviated usage} of long options by setting
@ref{de8,,allow_abbrev} to @code{False}.  (Contributed by Jonathan Paugh,
Steven Bethard, paul j3 and Daniel Eriksson in bpo-14910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14910}.)

@node asyncio<10>,bz2,argparse<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 asyncio}@anchor{de9}
@subsubsection asyncio


Since the @ref{a,,asyncio} module is @ref{b16,,provisional},
all changes introduced in Python 3.5 have also been backported to Python 3.4.x.

Notable changes in the @ref{a,,asyncio} module since Python 3.4.0:


@itemize *

@item 
New debugging APIs: @ref{dea,,loop.set_debug()}
and @ref{deb,,loop.get_debug()} methods.
(Contributed by Victor Stinner.)

@item 
The proactor event loop now supports SSL.
(Contributed by Antoine Pitrou and Victor Stinner in bpo-22560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22560}.)

@item 
A new @ref{dec,,loop.is_closed()} method to
check if the event loop is closed.
(Contributed by Victor Stinner in bpo-21326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21326}.)

@item 
A new @ref{1c0,,loop.create_task()}
to conveniently create and schedule a new @ref{1be,,Task}
for a coroutine.  The @code{create_task} method is also used by all
asyncio functions that wrap coroutines into tasks, such as
@ref{47f,,asyncio.wait()}, @ref{5fd,,asyncio.gather()}, etc.
(Contributed by Victor Stinner.)

@item 
A new @ref{ded,,transport.get_write_buffer_limits()}
method to inquire for `high-' and `low-' water limits of the flow
control.
(Contributed by Victor Stinner.)

@item 
The @code{async()} function is deprecated in favor of
@ref{c92,,ensure_future()}.
(Contributed by Yury Selivanov.)

@item 
New @ref{dee,,loop.set_task_factory()} and
@ref{def,,loop.get_task_factory()}
methods to customize the task factory that @ref{1c0,,loop.create_task()} method uses.  (Contributed by Yury
Selivanov.)

@item 
New @ref{df0,,Queue.join()} and
@ref{df1,,Queue.task_done()} queue methods.
(Contributed by Victor Stinner.)

@item 
The @code{JoinableQueue} class was removed, in favor of the
@ref{a80,,asyncio.Queue} class.
(Contributed by Victor Stinner.)
@end itemize

Updates in 3.5.1:


@itemize *

@item 
The @ref{c92,,ensure_future()} function and all functions that
use it, such as @ref{c93,,loop.run_until_complete()},
now accept all kinds of @ref{1ad,,awaitable objects}.
(Contributed by Yury Selivanov.)

@item 
New @ref{886,,run_coroutine_threadsafe()} function to submit
coroutines to event loops from other threads.
(Contributed by Vincent Michel.)

@item 
New @ref{c94,,Transport.is_closing()}
method to check if the transport is closing or closed.
(Contributed by Yury Selivanov.)

@item 
The @ref{b25,,loop.create_server()}
method can now accept a list of hosts.
(Contributed by Yann Sionneau.)
@end itemize

Updates in 3.5.2:


@itemize *

@item 
New @ref{c95,,loop.create_future()}
method to create Future objects.  This allows alternative event
loop implementations, such as
uvloop@footnote{https://github.com/MagicStack/uvloop}, to provide a faster
@ref{be6,,asyncio.Future} implementation.
(Contributed by Yury Selivanov.)

@item 
New @ref{c96,,loop.get_exception_handler()}
method to get the current exception handler.
(Contributed by Yury Selivanov.)

@item 
New @ref{1b4,,StreamReader.readuntil()}
method to read data from the stream until a separator bytes
sequence appears.
(Contributed by Mark Korenberg.)

@item 
The @ref{603,,loop.create_connection()}
and @ref{b25,,loop.create_server()}
methods are optimized to avoid calling the system @code{getaddrinfo}
function if the address is already resolved.
(Contributed by A. Jesse Jiryu Davis.)

@item 
The @ref{df2,,loop.sock_connect(sock@comma{} address)}
no longer requires the `address' to be resolved prior to the call.
(Contributed by A. Jesse Jiryu Davis.)
@end itemize

@node bz2,cgi,asyncio<10>,Módulos melhorados<9>
@anchor{whatsnew/3 5 bz2}@anchor{df3}
@subsubsection bz2


The @ref{df4,,BZ2Decompressor.decompress}
method now accepts an optional `max_length' argument to limit the maximum
size of decompressed data. (Contributed by Nikolaus Rath in bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}.)

@node cgi,cmath<2>,bz2,Módulos melhorados<9>
@anchor{whatsnew/3 5 cgi}@anchor{df5}
@subsubsection cgi


The @code{FieldStorage} class now supports the @ref{5d4,,context manager}
protocol.  (Contributed by Berker Peksag in bpo-20289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20289}.)

@node cmath<2>,código,cgi,Módulos melhorados<9>
@anchor{whatsnew/3 5 cmath}@anchor{df6}
@subsubsection cmath


A new function @ref{dd9,,isclose()} provides a way to test for approximate
equality.  (Contributed by Chris Barker and Tal Einat in bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}.)

@node código,collections<5>,cmath<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 code}@anchor{df7}
@subsubsection código


The @ref{df8,,InteractiveInterpreter.showtraceback()}
method now prints the full chained traceback, just like the interactive
interpreter.  (Contributed by Claudiu Popa in bpo-17442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17442}.)

@node collections<5>,collections abc<3>,código,Módulos melhorados<9>
@anchor{whatsnew/3 5 collections}@anchor{df9}
@subsubsection collections

@anchor{whatsnew/3 5 whatsnew-ordereddict}@anchor{d93}
The @ref{5db,,OrderedDict} class is now implemented in C, which
makes it 4 to 100 times faster.  (Contributed by Eric Snow in bpo-16991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16991}.)

@code{OrderedDict.items()}, @code{OrderedDict.keys()},
and @code{OrderedDict.values()} views now support @ref{869,,reversed()} iteration.
(Contributed by Serhiy Storchaka in bpo-19505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19505}.)

The @ref{5dc,,deque} class now defines
@ref{dfa,,index()}, @ref{dfb,,insert()}, and
@ref{dfc,,copy()}, and supports the @code{+} and @code{*} operators.
This allows deques to be recognized as a @ref{1a1,,MutableSequence}
and improves their substitutability for lists.
(Contributed by Raymond Hettinger in bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}.)

Docstrings produced by @ref{1ca,,namedtuple()} can now be updated:

@example
Point = namedtuple('Point', ['x', 'y'])
Point.__doc__ += ': Cartesian coordinate'
Point.x.__doc__ = 'abscissa'
Point.y.__doc__ = 'ordinate'
@end example

(Contributed by Berker Peksag in bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}.)

The @ref{dfd,,UserString} class now implements the
@ref{dfe,,__getnewargs__()}, @ref{dff,,__rmod__()}, @ref{e00,,casefold()},
@ref{e01,,format_map()}, @ref{e02,,isprintable()}, and @ref{e03,,maketrans()}
methods to match the corresponding methods of @ref{44c,,str}.
(Contributed by Joe Jevnik in bpo-22189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22189}.)

@node collections abc<3>,compileall<4>,collections<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 collections-abc}@anchor{e04}
@subsubsection collections.abc


The @code{Sequence.index()} method now
accepts `start' and `stop' arguments to match the corresponding methods
of @ref{370,,tuple}, @ref{611,,list}, etc.
(Contributed by Devin Jeanpierre in bpo-23086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23086}.)

A new @ref{e05,,Generator} abstract base class. (Contributed
by Stefan Behnel in bpo-24018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24018}.)

New @ref{e06,,Awaitable}, @ref{e07,,Coroutine},
@ref{e08,,AsyncIterator}, and
@ref{e09,,AsyncIterable} abstract base classes.
(Contributed by Yury Selivanov in 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<4>,concurrent futures<5>,collections abc<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 compileall}@anchor{e0a}
@subsubsection compileall


A new @ref{20,,compileall} option, @code{-j @var{N}}, allows running `N' workers
simultaneously to perform parallel bytecode compilation.
The @ref{b38,,compile_dir()} function has a corresponding @code{workers}
parameter.  (Contributed by Claudiu Popa in bpo-16104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16104}.)

Another new option, @code{-r}, allows controlling the maximum recursion
level for subdirectories.  (Contributed by Claudiu Popa in bpo-19628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19628}.)

The @code{-q} command line option can now be specified more than once, in
which case all output, including errors, will be suppressed.  The corresponding
@code{quiet} parameter in @ref{b38,,compile_dir()},
@ref{e0b,,compile_file()}, and @ref{e0c,,compile_path()} can now
accept an integer value indicating the level of output suppression.
(Contributed by Thomas Kluyver in bpo-21338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21338}.)

@node concurrent futures<5>,configparser<4>,compileall<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 concurrent-futures}@anchor{e0d}
@subsubsection concurrent.futures


The @ref{e0e,,Executor.map()} method now accepts a
`chunksize' argument to allow batching of tasks to improve performance when
@ref{8f4,,ProcessPoolExecutor()} is used.
(Contributed by Dan O’Reilly in bpo-11271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11271}.)

The number of workers in the @ref{742,,ThreadPoolExecutor}
constructor is optional now.  The default value is 5 times the number of CPUs.
(Contributed by Claudiu Popa in bpo-21527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21527}.)

@node configparser<4>,contextlib<5>,concurrent futures<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 configparser}@anchor{e0f}
@subsubsection configparser


@ref{22,,configparser} now provides a way to customize the conversion
of values by specifying a dictionary of converters in the
@ref{1c8,,ConfigParser} constructor, or by defining them
as methods in @code{ConfigParser} subclasses.  Converters defined in
a parser instance are inherited by its section proxies.

Exemplo:

@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

(Contributed by Łukasz Langa in bpo-18159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18159}.)

@node contextlib<5>,csv<3>,configparser<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 contextlib}@anchor{e10}
@subsubsection contextlib


The new @ref{e11,,redirect_stderr()} @ref{5d4,,context manager} (similar to
@ref{e12,,redirect_stdout()}) makes it easier for utility scripts to
handle inflexible APIs that write their output to @ref{940,,sys.stderr} and
don’t provide any options to redirect it:

@example
>>> import contextlib, io, logging
>>> f = io.StringIO()
>>> with contextlib.redirect_stderr(f):
...     logging.warning('warning')
...
>>> f.getvalue()
'WARNING:root:warning\n'
@end example

(Contributed by Berker Peksag in bpo-22389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22389}.)

@node csv<3>,curses<4>,contextlib<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 csv}@anchor{e13}
@subsubsection csv


The @ref{e14,,writerow()} method now supports arbitrary iterables,
not just sequences.  (Contributed by Serhiy Storchaka in bpo-23171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23171}.)

@node curses<4>,dbm<5>,csv<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 curses}@anchor{e15}
@subsubsection curses


The new @ref{e16,,update_lines_cols()} function updates the @ref{e17,,LINES}
and @ref{e18,,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<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 dbm}@anchor{e19}
@subsubsection dbm


@ref{aa5,,dumb.open} always creates a new database when the flag
has the value @code{"n"}.  (Contributed by Claudiu Popa in bpo-18039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18039}.)

@node difflib,distutils<7>,dbm<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 difflib}@anchor{e1a}
@subsubsection difflib


The charset of HTML documents generated by
@ref{e1b,,HtmlDiff.make_file()}
can now be customized by using a new `charset' keyword-only argument.
The default charset of HTML document changed from @code{"ISO-8859-1"}
to @code{"utf-8"}.
(Contributed by Berker Peksag in bpo-2052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2052}.)

The @ref{e1c,,diff_bytes()} function can now compare lists of byte
strings.  This fixes a regression from Python 2.
(Contributed by Terry J. Reedy and Greg Ward in bpo-17445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17445}.)

@node distutils<7>,doctest<3>,difflib,Módulos melhorados<9>
@anchor{whatsnew/3 5 distutils}@anchor{e1d}
@subsubsection distutils


Both the @code{build} and @code{build_ext} commands now accept a @code{-j} option to
enable parallel building of extension modules.
(Contributed by Antoine Pitrou in 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 melhorados<9>
@anchor{whatsnew/3 5 doctest}@anchor{e1e}
@subsubsection doctest


The @ref{e1f,,DocTestSuite()} function returns an empty
@ref{e20,,unittest.TestSuite} if `module' contains no docstrings, instead of
raising @ref{202,,ValueError}.  (Contributed by Glenn Jones in bpo-15916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15916}.)

@node email<3>,enum<8>,doctest<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 email}@anchor{e21}
@subsubsection email


A new policy option @ref{e22,,Policy.mangle_from_}
controls whether or not lines that start with @code{"From "} in email bodies are
prefixed with a @code{">"} character by generators.  The default is @code{True} for
@ref{cb8,,compat32} and @code{False} for all other policies.
(Contributed by Milan Oberkirch in bpo-20098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20098}.)

A new
@ref{e23,,Message.get_content_disposition()}
method provides easy access to a canonical value for the
@code{Content-Disposition} header.
(Contributed by Abhilash Raj in bpo-21083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21083}.)

A new policy option @ref{e24,,EmailPolicy.utf8}
can be set to @code{True} to encode email headers using the UTF-8 charset instead
of using encoded words.  This allows @code{Messages} to be formatted according to
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} and used with an SMTP server that supports the 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}
@code{SMTPUTF8} extension.  (Contributed by R. David Murray in
bpo-24211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24211}.)

The @ref{e25,,mime.text.MIMEText} constructor now
accepts a @ref{e26,,charset.Charset} instance.
(Contributed by Claude Paroz and Berker Peksag in bpo-16324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16324}.)

@node enum<8>,faulthandler<3>,email<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 enum}@anchor{e27}
@subsubsection enum


The @ref{630,,Enum} callable has a new parameter `start' to
specify the initial number of enum values if only `names' are provided:

@example
>>> Animal = enum.Enum('Animal', 'cat dog', start=10)
>>> Animal.cat
<Animal.cat: 10>
>>> Animal.dog
<Animal.dog: 11>
@end example

(Contributed by Ethan Furman in bpo-21706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21706}.)

@node faulthandler<3>,functools<4>,enum<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 faulthandler}@anchor{e28}
@subsubsection faulthandler


The @ref{cbe,,enable()}, @ref{e29,,register()},
@ref{e2a,,dump_traceback()} and
@ref{e2b,,dump_traceback_later()} functions now accept file
descriptors in addition to file-like objects.
(Contributed by Wei Wu in bpo-23566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23566}.)

@node functools<4>,glob<3>,faulthandler<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 functools}@anchor{e2c}
@subsubsection functools

@anchor{whatsnew/3 5 whatsnew-lrucache}@anchor{d96}
Most of the @ref{9f7,,lru_cache()} machinery is now implemented in C, making
it significantly faster.  (Contributed by Matt Joiner, Alexey Kachayev, and
Serhiy Storchaka in bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}.)

@node glob<3>,gzip<4>,functools<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 glob}@anchor{e2d}
@subsubsection glob


The @ref{80a,,iglob()} and @ref{29f,,glob()} functions now support recursive
search in subdirectories, using the @code{"**"} pattern.
(Contributed by Serhiy Storchaka in bpo-13968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13968}.)

@node gzip<4>,heapq,glob<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 gzip}@anchor{e2e}
@subsubsection gzip


The `mode' argument of the @ref{41a,,GzipFile} constructor now
accepts @code{"x"} to request exclusive creation.
(Contributed by Tim Heaney in bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222}.)

@node heapq,http<2>,gzip<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 heapq}@anchor{e2f}
@subsubsection heapq


Element comparison in @ref{e30,,merge()} can now be customized by
passing a @ref{e31,,key function} in a new optional `key' keyword argument,
and a new optional `reverse' keyword argument can be used to reverse element
comparison:

@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

(Contributed by Raymond Hettinger in bpo-13742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13742}.)

@node http<2>,http client<3>,heapq,Módulos melhorados<9>
@anchor{whatsnew/3 5 http}@anchor{e32}
@subsubsection http


A new @ref{906,,HTTPStatus} enum that defines a set of
HTTP status codes, reason phrases and long descriptions written in English.
(Contributed by Demian Brecht in bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}.)

@node http client<3>,idlelib e IDLE<3>,http<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 http-client}@anchor{e33}
@subsubsection http.client


@ref{e34,,HTTPConnection.getresponse()}
now raises a @ref{e35,,RemoteDisconnected} exception when a
remote server connection is closed unexpectedly.  Additionally, if a
@ref{e36,,ConnectionError} (of which @code{RemoteDisconnected}
is a subclass) is raised, the client socket is now closed automatically,
and will reconnect on the next request:

@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

(Contributed by Martin Panter in bpo-3566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3566}.)

@node idlelib e IDLE<3>,imaplib<2>,http client<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 idlelib-and-idle}@anchor{e37}
@subsubsection idlelib e IDLE


Since idlelib implements the IDLE shell and editor and is not intended for import by other programs, it gets improvements with every release. See @code{Lib/idlelib/NEWS.txt} for a cumulative list of changes since 3.4.0, as well as changes made in future 3.5.x releases. This file is also available from the IDLE Help ‣ About IDLE dialog.

@node imaplib<2>,imghdr,idlelib e IDLE<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 imaplib}@anchor{e38}
@subsubsection imaplib


The @ref{909,,IMAP4} class now supports the @ref{5d4,,context manager} protocol.
When used in a @ref{5d2,,with} statement, the IMAP4 @code{LOGOUT}
command will be called automatically at the end of the block.
(Contributed by Tarek Ziadé and Serhiy Storchaka in bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972}.)

The @ref{74,,imaplib} module now supports 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html} (ENABLE Extension)
and 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} (UTF-8 Support) via the @ref{e39,,IMAP4.enable()}
method.  A new @ref{e3a,,IMAP4.utf8_enabled}
attribute tracks whether or not 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} support is enabled.
(Contributed by Milan Oberkirch, R. David Murray, and Maciej Szulik in
bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}.)

The @ref{74,,imaplib} module now automatically encodes non-ASCII string usernames
and passwords using UTF-8, as recommended by the RFCs.  (Contributed by Milan
Oberkirch in bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}.)

@node imghdr,importlib<8>,imaplib<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 imghdr}@anchor{e3b}
@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<8>,inspect<7>,imghdr,Módulos melhorados<9>
@anchor{whatsnew/3 5 importlib}@anchor{e3c}
@subsubsection importlib


The @ref{ccd,,util.LazyLoader} class allows for
lazy loading of modules in applications where startup time is important.
(Contributed by Brett Cannon in bpo-17621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17621}.)

The @ref{e3d,,abc.InspectLoader.source_to_code()}
method is now a static method.  This makes it easier to initialize a module
object with code compiled from a string by running
@code{exec(code, module.__dict__)}.
(Contributed by Brett Cannon in bpo-21156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21156}.)

The new @ref{e3e,,util.module_from_spec()}
function is now the preferred way to create a new module.  As opposed to
creating a @ref{e3f,,types.ModuleType} instance directly, this new function
will set the various import-controlled attributes based on the passed-in
spec object.  (Contributed by Brett Cannon in bpo-20383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20383}.)

@node inspect<7>,io<5>,importlib<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 inspect}@anchor{e40}
@subsubsection inspect


Both the @ref{1cf,,Signature} and @ref{1d0,,Parameter} classes are
now picklable and hashable.  (Contributed by Yury Selivanov in bpo-20726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20726}
and bpo-20334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20334}.)

A new
@ref{e41,,BoundArguments.apply_defaults()}
method provides a way to set default values for missing arguments:

@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

(Contributed by Yury Selivanov in bpo-24190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24190}.)

A new class method
@ref{73a,,Signature.from_callable()} makes
subclassing of @ref{1cf,,Signature} easier.  (Contributed
by Yury Selivanov and Eric Snow in bpo-17373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17373}.)

The @ref{738,,signature()} function now accepts a `follow_wrapped'
optional keyword argument, which, when set to @code{False}, disables automatic
following of @code{__wrapped__} links.
(Contributed by Yury Selivanov in bpo-20691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20691}.)

A set of new functions to inspect
@ref{d9b,,coroutine functions} and
@ref{491,,coroutine objects} has been added:
@ref{e42,,iscoroutine()}, @ref{2e4,,iscoroutinefunction()},
@ref{e43,,isawaitable()}, @ref{e44,,getcoroutinelocals()},
and @ref{e45,,getcoroutinestate()}.
(Contributed by Yury Selivanov in bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017} and bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}.)

The @ref{652,,stack()}, @ref{653,,trace()},
@ref{650,,getouterframes()}, and @ref{651,,getinnerframes()}
functions now return a list of named tuples.
(Contributed by Daniel Shahaf in bpo-16808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16808}.)

@node io<5>,ipaddress<4>,inspect<7>,Módulos melhorados<9>
@anchor{whatsnew/3 5 io}@anchor{e46}
@subsubsection io


A new @ref{e47,,BufferedIOBase.readinto1()}
method, that uses at most one call to the underlying raw stream’s
@ref{e48,,RawIOBase.read()} or
@ref{e49,,RawIOBase.readinto()} methods.
(Contributed by Nikolaus Rath in bpo-20578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20578}.)

@node ipaddress<4>,json<2>,io<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 ipaddress}@anchor{e4a}
@subsubsection ipaddress


Both the @ref{1fe,,IPv4Network} and @ref{1ff,,IPv6Network} classes
now accept an @code{(address, netmask)} tuple argument, so as to easily construct
network objects from existing addresses:

@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

(Contributed by Peter Moody and Antoine Pitrou in bpo-16531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16531}.)

A new @ref{e4b,,reverse_pointer} attribute for the
@ref{1fc,,IPv4Address} and @ref{1fd,,IPv6Address} classes
returns the name of the reverse DNS PTR record:

@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

(Contributed by Leon Weber in bpo-20480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20480}.)

@node json<2>,linecache<2>,ipaddress<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 json}@anchor{e4c}
@subsubsection json


The @ref{83,,json.tool} command line interface now preserves the order of keys in
JSON objects passed in input.  The new @code{--sort-keys} option can be used
to sort the keys alphabetically. (Contributed by Berker Peksag
in bpo-21650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21650}.)

JSON decoder now raises @ref{e4d,,JSONDecodeError} instead of
@ref{202,,ValueError} to provide better context information about the error.
(Contributed by Serhiy Storchaka in bpo-19361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19361}.)

@node linecache<2>,locale<6>,json<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 linecache}@anchor{e4e}
@subsubsection linecache


A new @ref{e4f,,lazycache()} function can be used to capture information
about a non-file-based module to permit getting its lines later via
@ref{e50,,getline()}. This avoids doing I/O until a line is actually
needed, without having to carry the module globals around indefinitely.
(Contributed by Robert Collins in bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

@node locale<6>,logging<5>,linecache<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 locale}@anchor{e51}
@subsubsection locale


A new @ref{e52,,delocalize()} function can be used to convert a string into
a normalized number string, taking the @code{LC_NUMERIC} settings into account:

@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

(Contributed by Cédric Krier in bpo-13918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13918}.)

@node logging<5>,lzma,locale<6>,Módulos melhorados<9>
@anchor{whatsnew/3 5 logging}@anchor{e53}
@subsubsection logging


All logging methods (@ref{b64,,Logger} @ref{e54,,log()},
@ref{e55,,exception()}, @ref{e56,,critical()},
@ref{e57,,debug()}, etc.), now accept exception instances
as an `exc_info' argument, in addition to boolean values and exception
tuples:

@example
>>> import logging
>>> try:
...     1/0
... except ZeroDivisionError as ex:
...     logging.error('exception', exc_info=ex)
ERROR:root:exception
@end example

(Contributed by Yury Selivanov in bpo-20537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20537}.)

The @ref{e58,,handlers.HTTPHandler} class now
accepts an optional @ref{294,,ssl.SSLContext} instance to configure SSL
settings used in an HTTP connection.
(Contributed by Alex Gaynor in bpo-22788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22788}.)

The @ref{e59,,handlers.QueueListener} class now
takes a `respect_handler_level' keyword argument which, if set to @code{True},
will pass messages to handlers taking handler levels into account.
(Contributed by Vinay Sajip.)

@node lzma,math<8>,logging<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 lzma}@anchor{e5a}
@subsubsection lzma


The @ref{e5b,,LZMADecompressor.decompress()}
method now accepts an optional `max_length' argument to limit the maximum
size of decompressed data.
(Contributed by Martin Panter in bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}.)

@node math<8>,multiprocessing<6>,lzma,Módulos melhorados<9>
@anchor{whatsnew/3 5 math}@anchor{e5c}
@subsubsection math


Two new constants have been added to the @ref{8e,,math} module: @ref{ca1,,inf}
and @ref{663,,nan}.  (Contributed by Mark Dickinson in bpo-23185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23185}.)

A new function @ref{dd8,,isclose()} provides a way to test for approximate
equality. (Contributed by Chris Barker and Tal Einat in bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}.)

A new @ref{916,,gcd()} function has been added.  The @code{fractions.gcd()}
function is now deprecated. (Contributed by Mark Dickinson and Serhiy
Storchaka in bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}.)

@node multiprocessing<6>,operador<2>,math<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 multiprocessing}@anchor{e5d}
@subsubsection multiprocessing


@ref{e5e,,sharedctypes.synchronized()}
objects now support the @ref{5d4,,context manager} protocol.
(Contributed by Charles-François Natali in bpo-21565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21565}.)

@node operador<2>,os<10>,multiprocessing<6>,Módulos melhorados<9>
@anchor{whatsnew/3 5 operator}@anchor{e5f}
@subsubsection operador


@ref{e60,,attrgetter()}, @ref{a6b,,itemgetter()},
and @ref{e61,,methodcaller()} objects now support pickling.
(Contributed by Josh Rosenberg and Serhiy Storchaka in bpo-22955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22955}.)

New @ref{e62,,matmul()} and @ref{e63,,imatmul()} functions
to perform matrix multiplication.
(Contributed by Benjamin Peterson in bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}.)

@node os<10>,pathlib<10>,operador<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 os}@anchor{e64}
@subsubsection os


The new @ref{a68,,scandir()} function returning an iterator of
@ref{49b,,DirEntry} objects has been added.  If possible, @ref{a68,,scandir()}
extracts file attributes while scanning a directory, removing the need to
perform subsequent system calls to determine file type or attributes, which may
significantly improve performance.  (Contributed by Ben Hoyt with the help
of Victor Stinner in bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524}.)

On Windows, a new
@ref{e65,,stat_result.st_file_attributes}
attribute is now available.  It corresponds to the @code{dwFileAttributes} member
of the @code{BY_HANDLE_FILE_INFORMATION} structure returned by
@code{GetFileInformationByHandle()}.  (Contributed by Ben Hoyt in bpo-21719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21719}.)

The @ref{523,,urandom()} function now uses the @code{getrandom()} syscall on Linux 3.17
or newer, and @code{getentropy()} on OpenBSD 5.6 and newer, removing the need to
use @code{/dev/urandom} and avoiding failures due to potential file descriptor
exhaustion.  (Contributed by Victor Stinner in bpo-22181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22181}.)

New @ref{e66,,get_blocking()} and @ref{e67,,set_blocking()} functions allow
getting and setting a file descriptor’s blocking mode (@ref{e68,,O_NONBLOCK}.)
(Contributed by Victor Stinner in bpo-22054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22054}.)

The @ref{e69,,truncate()} and @ref{db7,,ftruncate()} functions are now supported
on Windows.  (Contributed by Steve Dower in bpo-23668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23668}.)

There is a new @ref{e6a,,os.path.commonpath()} function returning the longest
common sub-path of each passed pathname.  Unlike the
@ref{e6b,,os.path.commonprefix()} function, it always returns a valid
path:

@example
>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'
@end example

(Contributed by Rafik Draoui and Serhiy Storchaka in bpo-10395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10395}.)

@node pathlib<10>,pickle<3>,os<10>,Módulos melhorados<9>
@anchor{whatsnew/3 5 pathlib}@anchor{e6c}
@subsubsection pathlib


The new @ref{e6d,,Path.samefile()} method can be used
to check whether the path points to the same file as another path, which can
be either another @ref{229,,Path} object, or a string:

@example
>>> import pathlib
>>> p1 = pathlib.Path('/etc/hosts')
>>> p2 = pathlib.Path('/etc/../etc/hosts')
>>> p1.samefile(p2)
True
@end example

(Contributed by Vajrasky Kok and Antoine Pitrou in bpo-19775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19775}.)

The @ref{e6e,,Path.mkdir()} method now accepts a new optional
`exist_ok' argument to match @code{mkdir -p} and @ref{21e,,os.makedirs()}
functionality.  (Contributed by Berker Peksag in bpo-21539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21539}.)

There is a new @ref{e6f,,Path.expanduser()} method to
expand @code{~} and @code{~user} prefixes.  (Contributed by Serhiy Storchaka and
Claudiu Popa in bpo-19776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19776}.)

A new @ref{e70,,Path.home()} class method can be used to get
a @ref{229,,Path} instance representing the user’s home
directory.
(Contributed by Victor Salgado and Mayank Tripathi in bpo-19777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19777}.)

New @ref{e71,,Path.write_text()},
@ref{e72,,Path.read_text()},
@ref{e73,,Path.write_bytes()},
@ref{e74,,Path.read_bytes()} methods to simplify
read/write operations on files.

The following code snippet will create or rewrite existing file
@code{~/spam42}:

@example
>>> import pathlib
>>> p = pathlib.Path('~/spam42')
>>> p.expanduser().write_text('ham')
3
@end example

(Contributed by Christopher Welborn in bpo-20218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20218}.)

@node pickle<3>,poplib<2>,pathlib<10>,Módulos melhorados<9>
@anchor{whatsnew/3 5 pickle}@anchor{e75}
@subsubsection pickle


Nested objects, such as unbound methods or nested classes, can now be pickled
using @ref{ce1,,pickle protocols} older than protocol version 4.
Protocol version 4 already supports these cases.  (Contributed by Serhiy
Storchaka in bpo-23611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23611}.)

@node poplib<2>,re<7>,pickle<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 poplib}@anchor{e76}
@subsubsection poplib


A new @ref{e77,,POP3.utf8()} command enables 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html}
(Internationalized Email) support, if a POP server supports it.
(Contributed by Milan OberKirch in bpo-21804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21804}.)

@node re<7>,readline<2>,poplib<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 re}@anchor{e78}
@subsubsection re


References and conditional references to groups with fixed length are now
allowed in lookbehind assertions:

@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

(Contributed by Serhiy Storchaka in bpo-9179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9179}.)

The number of capturing groups in regular expressions is no longer limited to
100.  (Contributed by Serhiy Storchaka in bpo-22437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22437}.)

The @ref{2a3,,sub()} and @ref{2a4,,subn()} functions now replace unmatched
groups with empty strings instead of raising an exception.
(Contributed by Serhiy Storchaka in bpo-1519638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1519638}.)

The @ref{23e,,re.error} exceptions have new attributes,
@ref{e79,,msg}, @ref{e7a,,pattern},
@ref{e7b,,pos}, @ref{e7c,,lineno},
and @ref{e7d,,colno}, that provide better context
information about the error:

@example
>>> re.compile("""
...     (?x)
...     .++
... """)
Traceback (most recent call last):
   ...
sre_constants.error: multiple repeat at position 16 (line 3, column 7)
@end example

(Contributed by Serhiy Storchaka in bpo-22578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22578}.)

@node readline<2>,selectors,re<7>,Módulos melhorados<9>
@anchor{whatsnew/3 5 readline}@anchor{e7e}
@subsubsection readline


A new @ref{e7f,,append_history_file()} function can be used to append
the specified number of trailing elements in history to the given file.
(Contributed by Bruno Cauet in bpo-22940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22940}.)

@node selectors,shutil<5>,readline<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 selectors}@anchor{e80}
@subsubsection selectors


The new @ref{bf2,,DevpollSelector} supports efficient
@code{/dev/poll} polling on Solaris.
(Contributed by Giampaolo Rodola’ in bpo-18931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18931}.)

@node shutil<5>,signal<3>,selectors,Módulos melhorados<9>
@anchor{whatsnew/3 5 shutil}@anchor{e81}
@subsubsection shutil


The @ref{e82,,move()} function now accepts a `copy_function' argument,
allowing, for example, the @ref{a64,,copy()} function to be used instead of
the default @ref{a65,,copy2()} if there is a need to ignore file metadata
when moving.
(Contributed by Claudiu Popa in bpo-19840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19840}.)

The @ref{4b3,,make_archive()} function now supports the `xztar' format.
(Contributed by Serhiy Storchaka in bpo-5411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5411}.)

@node signal<3>,smtpd<2>,shutil<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 signal}@anchor{e83}
@subsubsection signal


On Windows, the @ref{b86,,set_wakeup_fd()} function now also supports
socket handles.  (Contributed by Victor Stinner in bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}.)

Various @code{SIG*} constants in the @ref{c6,,signal} module have been converted into
@ref{56,,Enums}.  This allows meaningful names to be printed
during debugging, instead of integer “magic numbers”.
(Contributed by Giampaolo Rodola’ in bpo-21076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21076}.)

@node smtpd<2>,smtplib<2>,signal<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 smtpd}@anchor{e84}
@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 melhorados<9>
@anchor{whatsnew/3 5 smtplib}@anchor{e85}
@subsubsection smtplib


A new @ref{e86,,SMTP.auth()} method provides a convenient way to
implement custom authentication mechanisms. (Contributed by Milan
Oberkirch in bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}.)

The @ref{e87,,SMTP.set_debuglevel()} method now
accepts an additional debuglevel (2), which enables timestamps in debug
messages. (Contributed by Gavin Chappell and Maciej Szulik in bpo-16914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16914}.)

Both the @ref{e88,,SMTP.sendmail()} and
@ref{e89,,SMTP.send_message()} methods now
support 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} (SMTPUTF8).
(Contributed by Milan Oberkirch and R. David Murray in bpo-22027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22027}.)

@node sndhdr,socket<8>,smtplib<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 sndhdr}@anchor{e8a}
@subsubsection sndhdr


The @code{what()} and @code{whathdr()} functions  now return
a @ref{1ca,,namedtuple()}.  (Contributed by Claudiu Popa in
bpo-18615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18615}.)

@node socket<8>,ssl<9>,sndhdr,Módulos melhorados<9>
@anchor{whatsnew/3 5 socket}@anchor{e8b}
@subsubsection socket


Functions with timeouts now use a monotonic clock, instead of a system clock.
(Contributed by Victor Stinner in bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

A new @ref{e8c,,socket.sendfile()} method allows
sending a file over a socket by using the high-performance @ref{b21,,os.sendfile()}
function on UNIX, resulting in uploads being from 2 to 3 times faster than when
using plain @ref{dcf,,socket.send()}.
(Contributed by Giampaolo Rodola’ in bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}.)

The @ref{dd0,,socket.sendall()} method no longer resets the
socket timeout every time bytes are received or sent.  The socket timeout is
now the maximum total duration to send all data.
(Contributed by Victor Stinner in bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}.)

The `backlog' argument of the @ref{e8d,,socket.listen()}
method is now optional.  By default it is set to
@ref{e8e,,SOMAXCONN} or to @code{128}, whichever is less.
(Contributed by Charles-François Natali in bpo-21455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21455}.)

@node ssl<9>,sqlite3<8>,socket<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 ssl}@anchor{e8f}
@subsubsection ssl


@menu
* Підтримка BIO пам’яті:: 
* Application-Layer Protocol Negotiation Support:: 
* Other Changes:: 

@end menu

@node Підтримка BIO пам’яті,Application-Layer Protocol Negotiation Support,,ssl<9>
@anchor{whatsnew/3 5 memory-bio-support}@anchor{e90}@anchor{whatsnew/3 5 whatsnew-sslmemorybio}@anchor{d94}
@subsubsection Підтримка BIO пам’яті


(Contributed by Geert Jansen in bpo-21965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21965}.)

The new @ref{b99,,SSLObject} class has been added to provide SSL protocol
support for cases when the network I/O capabilities of @ref{8f0,,SSLSocket}
are not necessary or are suboptimal.  @code{SSLObject} represents
an SSL protocol instance, but does not implement any network I/O methods, and
instead provides a memory buffer interface.  The new @ref{e91,,MemoryBIO}
class can be used to pass data between Python and an SSL protocol instance.

The memory BIO SSL support is primarily intended to be used in frameworks
implementing asynchronous I/O for which @ref{8f0,,SSLSocket}’s readiness
model (“select/poll”) is inefficient.

A new @ref{b9a,,SSLContext.wrap_bio()} method can be used
to create a new @code{SSLObject} instance.

@node Application-Layer Protocol Negotiation Support,Other Changes,Підтримка BIO пам’яті,ssl<9>
@anchor{whatsnew/3 5 application-layer-protocol-negotiation-support}@anchor{e92}
@subsubsection Application-Layer Protocol Negotiation Support


(Contributed by Benjamin Peterson in bpo-20188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20188}.)

Where OpenSSL support is present, the @ref{d0,,ssl} module now implements
the `Application-Layer Protocol Negotiation' TLS extension as described
in 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}.

The new @ref{e93,,SSLContext.set_alpn_protocols()}
can be used to specify which protocols a socket should advertise during
the TLS handshake.

The new
@ref{e94,,SSLSocket.selected_alpn_protocol()}
returns the protocol that was selected during the TLS handshake.
The @ref{e95,,HAS_ALPN} flag indicates whether ALPN support is present.

@node Other Changes,,Application-Layer Protocol Negotiation Support,ssl<9>
@anchor{whatsnew/3 5 other-changes}@anchor{e96}
@subsubsection Other Changes


There is a new @ref{e97,,SSLSocket.version()} method to
query the actual protocol version in use.
(Contributed by Antoine Pitrou in bpo-20421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20421}.)

The @ref{8f0,,SSLSocket} class now implements
a @code{SSLSocket.sendfile()} method.
(Contributed by Giampaolo Rodola’ in bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}.)

The @code{SSLSocket.send()} method now raises either
the @ref{e98,,ssl.SSLWantReadError} or @ref{e99,,ssl.SSLWantWriteError} exception 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}.)

The @ref{e9a,,cert_time_to_seconds()} function now interprets the input time
as UTC and not as local time, per 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}.  Additionally, the return
value is always an @ref{257,,int}. (Contributed by Akira Li in bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}.)

New @code{SSLObject.shared_ciphers()} and
@ref{e9b,,SSLSocket.shared_ciphers()} methods return
the list of ciphers sent by the client during the handshake.
(Contributed by Benjamin Peterson in bpo-23186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23186}.)

The @ref{e9c,,SSLSocket.do_handshake()},
@ref{e9d,,SSLSocket.read()},
@code{SSLSocket.shutdown()}, and
@ref{e9e,,SSLSocket.write()} methods of the @ref{8f0,,SSLSocket}
class no longer reset the socket timeout every time bytes are received or sent.
The socket timeout is now the maximum total duration of the method.
(Contributed by Victor Stinner in bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}.)

The @code{match_hostname()} function now supports matching of IP addresses.
(Contributed by Antoine Pitrou in bpo-23239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23239}.)

@node sqlite3<8>,subprocess<4>,ssl<9>,Módulos melhorados<9>
@anchor{whatsnew/3 5 sqlite3}@anchor{e9f}
@subsubsection sqlite3


The @ref{ea0,,Row} class now fully supports the sequence protocol,
in particular @ref{869,,reversed()} iteration and slice indexing.
(Contributed by Claudiu Popa in bpo-10203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10203}; by Lucas Sinclair,
Jessica McKellar, and  Serhiy Storchaka in bpo-13583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13583}.)

@node subprocess<4>,sys<11>,sqlite3<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 subprocess}@anchor{ea1}@anchor{whatsnew/3 5 whatsnew-subprocess}@anchor{d97}
@subsubsection subprocess


The new @ref{b9e,,run()} function has been added.
It runs the specified command and returns a
@ref{ea2,,CompletedProcess} object, which describes a finished
process.  The new API is more consistent and is the recommended approach
to invoking subprocesses in Python code that does not need to maintain
compatibility with earlier Python versions.
(Contributed by Thomas Kluyver in bpo-23342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23342}.)

Exemplos:

@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<11>,sysconfig<2>,subprocess<4>,Módulos melhorados<9>
@anchor{whatsnew/3 5 sys}@anchor{ea3}
@subsubsection sys


A new @code{set_coroutine_wrapper()} function allows setting a global
hook that will be called whenever a @ref{491,,coroutine object}
is created by an @ref{5d1,,async def} function.  A corresponding
@code{get_coroutine_wrapper()} can be used to obtain a currently set
wrapper.  Both functions are @ref{b16,,provisional},
and are intended for debugging purposes only.  (Contributed by Yury Selivanov
in bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}.)

A new @ref{a99,,is_finalizing()} function can be used to check if the Python
interpreter is @ref{14e,,shutting down}.
(Contributed by Antoine Pitrou in bpo-22696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22696}.)

@node sysconfig<2>,tarfile<7>,sys<11>,Módulos melhorados<9>
@anchor{whatsnew/3 5 sysconfig}@anchor{ea4}
@subsubsection sysconfig


The name of the user scripts directory on Windows now includes the first
two components of the Python version. (Contributed by Paul Moore
in bpo-23437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23437}.)

@node tarfile<7>,threading<6>,sysconfig<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 tarfile}@anchor{ea5}
@subsubsection tarfile


The `mode' argument of the @ref{ea6,,open()} function now accepts @code{"x"}
to request exclusive creation.  (Contributed by Berker Peksag in bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}.)

The @ref{42e,,TarFile.extractall()} and
@ref{42f,,TarFile.extract()} methods now take a keyword
argument `numeric_owner'.  If set to @code{True}, the extracted files and
directories will be owned by the numeric @code{uid} and @code{gid} from the tarfile.
If set to @code{False} (the default, and the behavior in versions prior to 3.5),
they will be owned by the named user and group in the tarfile.
(Contributed by Michael Vogt and Eric Smith in bpo-23193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23193}.)

The @ref{ea7,,TarFile.list()} now accepts an optional
`members' keyword argument that can be set to a subset of the list returned
by @ref{ea8,,TarFile.getmembers()}.
(Contributed by Serhiy Storchaka in bpo-21549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21549}.)

@node threading<6>,time<7>,tarfile<7>,Módulos melhorados<9>
@anchor{whatsnew/3 5 threading}@anchor{ea9}
@subsubsection threading


Both the @ref{698,,Lock.acquire()} and
@ref{eaa,,RLock.acquire()} methods
now use a monotonic clock for timeout management.
(Contributed by Victor Stinner in bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

@node time<7>,timeit<2>,threading<6>,Módulos melhorados<9>
@anchor{whatsnew/3 5 time}@anchor{eab}
@subsubsection time


The @ref{253,,monotonic()} function is now always available.
(Contributed by Victor Stinner in bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}.)

@node timeit<2>,tkinter<8>,time<7>,Módulos melhorados<9>
@anchor{whatsnew/3 5 timeit}@anchor{eac}
@subsubsection timeit


A new command line option @code{-u} or @code{--unit=@var{U}} can be used to specify the time
unit for the timer output.  Supported options are @code{usec}, @code{msec},
or @code{sec}.  (Contributed by Julian Gindi in bpo-18983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18983}.)

The @ref{ead,,timeit()} function has a new `globals' parameter for
specifying the namespace in which the code will be running.
(Contributed by Ben Roberts in bpo-2527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2527}.)

@node tkinter<8>,traceback<5>,timeit<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 tkinter}@anchor{eae}
@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<5>,types<5>,tkinter<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 traceback}@anchor{eaf}@anchor{whatsnew/3 5 whatsnew-traceback}@anchor{d98}
@subsubsection traceback


New @ref{eb0,,walk_stack()} and @ref{eb1,,walk_tb()}
functions to conveniently traverse frame and
@ref{b07,,traceback objects}.
(Contributed by Robert Collins in bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

New lightweight classes: @ref{25c,,TracebackException},
@ref{eb2,,StackSummary}, and @ref{eb3,,FrameSummary}.
(Contributed by Robert Collins in bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}.)

Both the @ref{eb4,,print_tb()} and @ref{eb5,,print_stack()} functions
now support negative values for the `limit' argument.
(Contributed by Dmitry Kazakov in bpo-22619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22619}.)

@node types<5>,unicodedata<8>,traceback<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 types}@anchor{eb6}
@subsubsection types


A new @ref{eb7,,coroutine()} function to transform
@ref{bf9,,generator} and
@ref{e05,,generator-like} objects into
@ref{1ad,,awaitables}.
(Contributed by Yury Selivanov in bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}.)

A new type called @ref{eb8,,CoroutineType}, which is used for
@ref{491,,coroutine} objects created by @ref{5d1,,async def} functions.
(Contributed by Yury Selivanov in bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}.)

@node unicodedata<8>,unittest<8>,types<5>,Módulos melhorados<9>
@anchor{whatsnew/3 5 unicodedata}@anchor{eb9}
@subsubsection unicodedata


The @ref{105,,unicodedata} module now uses data from Unicode 8.0.0@footnote{https://unicode.org/versions/Unicode8.0.0/}.

@node unittest<8>,unittest mock<3>,unicodedata<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 unittest}@anchor{eba}
@subsubsection unittest


The @ref{28f,,TestLoader.loadTestsFromModule()}
method now accepts a keyword-only argument `pattern' which is passed to
@code{load_tests} as the third argument.  Found packages are now checked for
@code{load_tests} regardless of whether their path matches `pattern', because it
is impossible for a package name to match the default pattern.
(Contributed by Robert Collins and Barry A. Warsaw in bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}.)

Unittest discovery errors now are exposed in the
@ref{ebb,,TestLoader.errors} attribute of the
@ref{28e,,TestLoader} instance.
(Contributed by Robert Collins in bpo-19746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19746}.)

A new command line option @code{--locals} to show local variables in
tracebacks.  (Contributed by Robert Collins in bpo-22936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22936}.)

@node unittest mock<3>,urllib<2>,unittest<8>,Módulos melhorados<9>
@anchor{whatsnew/3 5 unittest-mock}@anchor{ebc}
@subsubsection unittest.mock


The @ref{a54,,Mock} class has the following improvements:


@itemize *

@item 
The class constructor has a new `unsafe' parameter, which causes mock
objects to raise @ref{34b,,AttributeError} on attribute names starting
with @code{"assert"}.
(Contributed by Kushal Das in bpo-21238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21238}.)

@item 
A new @ref{ebd,,Mock.assert_not_called()}
method to check if the mock object was called.
(Contributed by Kushal Das in bpo-21262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21262}.)
@end itemize

The @ref{ebe,,MagicMock} class now supports
@ref{ebf,,__truediv__()}, @ref{ec0,,__divmod__()}
and @ref{da1,,__matmul__()} operators.
(Contributed by Johannes Baiter in bpo-20968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20968}, and Håkan Lövdahl
in bpo-23581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23581} and bpo-23568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23568}.)

It is no longer necessary to explicitly pass @code{create=True} to the
@ref{ec1,,patch()} function when patching builtin names.
(Contributed by Kushal Das in bpo-17660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17660}.)

@node urllib<2>,wsgiref,unittest mock<3>,Módulos melhorados<9>
@anchor{whatsnew/3 5 urllib}@anchor{ec2}
@subsubsection urllib


A new
@ref{ec3,,request.HTTPPasswordMgrWithPriorAuth}
class allows HTTP Basic Authentication credentials to be managed so as to
eliminate unnecessary @code{401} response handling, or to unconditionally send
credentials on the first request in order to communicate with servers that
return a @code{404} response instead of a @code{401} if the @code{Authorization} header
is not sent. (Contributed by Matej Cepl in bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494} and Akshit Khurana in
bpo-7159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7159}.)

A new `quote_via' argument for the
@ref{ec4,,parse.urlencode()}
function provides a way to control the encoding of query parts if needed.
(Contributed by Samwyse and Arnon Yaari in bpo-13866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13866}.)

The @ref{293,,request.urlopen()} function accepts an
@ref{294,,ssl.SSLContext} object as a `context' argument, which will be used for
the HTTPS connection.  (Contributed by Alex Gaynor in bpo-22366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22366}.)

The @ref{ec5,,parse.urljoin()} was updated to use the
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} semantics for the resolution of relative URLs, rather than
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} and 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html}.
(Contributed by Demian Brecht and Senthil Kumaran in bpo-22118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22118}.)

@node wsgiref,xmlrpc<2>,urllib<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 wsgiref}@anchor{ec6}
@subsubsection wsgiref


The `headers' argument of the @ref{ec7,,headers.Headers}
class constructor is now optional.
(Contributed by Pablo Torres Navarrete and SilentGhost in bpo-5800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5800}.)

@node xmlrpc<2>,xml sax,wsgiref,Módulos melhorados<9>
@anchor{whatsnew/3 5 xmlrpc}@anchor{ec8}
@subsubsection xmlrpc


The @ref{a61,,client.ServerProxy} class now supports
the @ref{5d4,,context manager} protocol.
(Contributed by Claudiu Popa in bpo-20627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20627}.)

The @ref{a61,,client.ServerProxy} constructor now accepts
an optional @ref{294,,ssl.SSLContext} instance.
(Contributed by Alex Gaynor in bpo-22960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22960}.)

@node xml sax,zipfile<4>,xmlrpc<2>,Módulos melhorados<9>
@anchor{whatsnew/3 5 xml-sax}@anchor{ec9}
@subsubsection xml.sax


SAX parsers now support a character stream of the
@ref{eca,,xmlreader.InputSource} object.
(Contributed by Serhiy Storchaka in bpo-2175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2175}.)

@ref{ecb,,parseString()} now accepts a @ref{44c,,str} instance.
(Contributed by Serhiy Storchaka in bpo-10590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10590}.)

@node zipfile<4>,,xml sax,Módulos melhorados<9>
@anchor{whatsnew/3 5 zipfile}@anchor{ecc}
@subsubsection zipfile


ZIP output can now be written to unseekable streams.
(Contributed by Serhiy Storchaka in bpo-23252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23252}.)

The `mode' argument of @ref{41b,,ZipFile.open()} method now
accepts @code{"x"} to request exclusive creation.
(Contributed by Serhiy Storchaka in bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}.)

@node Other module-level changes,Otimizações<9>,Módulos melhorados<9>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 other-module-level-changes}@anchor{ecd}
@subsection Other module-level changes


Many functions in the @ref{90,,mmap}, @code{ossaudiodev}, @ref{cc,,socket},
@ref{d0,,ssl}, and @ref{1b,,codecs} modules now accept writable
@ref{d4f,,bytes-like objects}.
(Contributed by Serhiy Storchaka in bpo-23001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23001}.)

@node Otimizações<9>,Mudanças a construções e API C<3>,Other module-level changes,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 optimizations}@anchor{ece}
@subsection Otimizações


The @ref{4a9,,os.walk()} function has been sped up by 3 to 5 times on POSIX systems,
and by 7 to 20 times on Windows.  This was done using the new @ref{a68,,os.scandir()}
function, which exposes file information from the underlying @code{readdir} or
@code{FindFirstFile}/@code{FindNextFile} system calls.  (Contributed by
Ben Hoyt with help from Victor Stinner in bpo-23605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23605}.)

Construction of @code{bytes(int)} (filled by zero bytes) is faster and uses less
memory for large objects. @code{calloc()} is used instead of @code{malloc()} to
allocate memory for these objects.
(Contributed by Victor Stinner in bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}.)

Some operations on @ref{80,,ipaddress} @ref{1fe,,IPv4Network} and
@ref{1ff,,IPv6Network} have been massively sped up, such as
@ref{ecf,,subnets()}, @ref{ed0,,supernet()},
@ref{ed1,,summarize_address_range()}, @ref{ed2,,collapse_addresses()}.
The speed up can range from 3 to 15 times.
(Contributed by Antoine Pitrou, Michel Albert, and Markus in
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}.)

Pickling of @ref{80,,ipaddress} objects was optimized to produce significantly
smaller output.  (Contributed by Serhiy Storchaka in bpo-23133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23133}.)

Many operations on @ref{ed3,,io.BytesIO} are now 50% to 100% faster.
(Contributed by Serhiy Storchaka in bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381} and David Wilson in
bpo-22003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22003}.)

The @ref{ed4,,marshal.dumps()} function is now faster: 65–85% with versions 3
and 4, 20–25% with versions 0 to 2 on typical data, and up to 5 times in
best cases.
(Contributed by Serhiy Storchaka in bpo-20416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20416} and bpo-23344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23344}.)

The UTF-32 encoder is now 3 to 7 times faster.
(Contributed by Serhiy Storchaka in bpo-15027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15027}.)

Regular expressions are now parsed up to 10% faster.
(Contributed by Serhiy Storchaka in bpo-19380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19380}.)

The @ref{d68,,json.dumps()} function was optimized to run with
@code{ensure_ascii=False} as fast as with @code{ensure_ascii=True}.
(Contributed by Naoki Inada in bpo-23206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23206}.)

The @ref{ed5,,PyObject_IsInstance()} and @ref{ed6,,PyObject_IsSubclass()}
functions have been sped up in the common case that the second argument
has @ref{d6b,,type} as its metaclass.
(Contributed Georg Brandl by in bpo-22540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22540}.)

Method caching was slightly improved, yielding up to 5% performance
improvement in some benchmarks.
(Contributed by Antoine Pitrou in bpo-22847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22847}.)

Objects from the @ref{b8,,random} module now use 50% less memory on 64-bit
builds.  (Contributed by Serhiy Storchaka in bpo-23488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23488}.)

The @ref{194,,property()} getter calls are up to 25% faster.
(Contributed by Joe Jevnik in bpo-23910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23910}.)

Instantiation of @ref{1e7,,fractions.Fraction} is now up to 30% faster.
(Contributed by Stefan Behnel in bpo-22464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22464}.)

String methods @ref{ed7,,find()}, @ref{ed8,,rfind()}, @ref{ed9,,split()},
@ref{eda,,partition()} and the @ref{2f4,,in} string operator are now significantly
faster for searching 1-character substrings.
(Contributed by Serhiy Storchaka in bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}.)

@node Mudanças a construções e API C<3>,Descontinuados<10>,Otimizações<9>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 build-and-c-api-changes}@anchor{edb}
@subsection Mudanças a construções e API C


New @code{calloc} functions were added:


@itemize *

@item 
@ref{391,,PyMem_RawCalloc()},

@item 
@ref{edc,,PyMem_Calloc()},

@item 
@ref{edd,,PyObject_Calloc()}.
@end itemize

(Contribuição de Victor Stinner em bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}.)

New encoding/decoding helper functions:


@itemize *

@item 
@ref{be0,,Py_DecodeLocale()} (replaced @code{_Py_char2wchar()}),

@item 
@ref{be1,,Py_EncodeLocale()} (replaced @code{_Py_wchar2char()}).
@end itemize

(Contribuição de Victor Stinner em bpo-18395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18395}.)

A new @ref{ede,,PyCodec_NameReplaceErrors()} function to replace the unicode
encode error with @code{\N@{...@}} escapes.
(Contributed by Serhiy Storchaka in bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676}.)

A new @ref{edf,,PyErr_FormatV()} function similar to @ref{ee0,,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}.)

A new @ref{ee1,,PyExc_RecursionError} exception.
(Contributed by Georg Brandl in bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}.)

New @ref{ee2,,PyModule_FromDefAndSpec()}, @ref{ee3,,PyModule_FromDefAndSpec2()},
and @ref{ee4,,PyModule_ExecDef()} functions introduced by 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} –
multi-phase extension module initialization.
(Contributed by Petr Viktorin in bpo-24268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24268}.)

New @ref{ee5,,PyNumber_MatrixMultiply()} and
@ref{ee6,,PyNumber_InPlaceMatrixMultiply()} functions to perform matrix
multiplication.
(Contributed by Benjamin Peterson in bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}.  See also 
@geindex Propostas de Melhorias do Python; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/}
for details.)

The @ref{ab5,,PyTypeObject.tp_finalize} slot is now part of the stable ABI.

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

Extension modules now include a platform information tag in their filename on
some platforms (the tag is optional, and CPython will import extensions without
it, although if the tag is present and mismatched, the extension won’t be
loaded):


@itemize *

@item 
On Linux, extension module filenames end with
@code{.cpython-<major><minor>m-<architecture>-<os>.pyd}:


@itemize *

@item 
@code{<major>} is the major number of the Python version;
for Python 3.5 this is @code{3}.

@item 
@code{<minor>} is the minor number of the Python version;
for Python 3.5 this is @code{5}.

@item 
@code{<architecture>} is the hardware architecture the extension module
was built to run on. It’s most commonly either @code{i386} for 32-bit Intel
platforms or @code{x86_64} for 64-bit Intel (and AMD) platforms.

@item 
@code{<os>} is always @code{linux-gnu}, except for extensions built to
talk to the 32-bit ABI on 64-bit platforms, in which case it is
@code{linux-gnu32} (and @code{<architecture>} will be @code{x86_64}).
@end itemize

@item 
On Windows, extension module filenames end with
@code{<debug>.cp<major><minor>-<platform>.pyd}:


@itemize *

@item 
@code{<major>} is the major number of the Python version;
for Python 3.5 this is @code{3}.

@item 
@code{<minor>} is the minor number of the Python version;
for Python 3.5 this is @code{5}.

@item 
@code{<platform>} is the platform the extension module was built for,
either @code{win32} for Win32, @code{win_amd64} for Win64, @code{win_ia64} for
Windows Itanium 64, and @code{win_arm} for Windows on ARM.

@item 
If built in debug mode, @code{<debug>} will be @code{_d},
otherwise it will be blank.
@end itemize

@item 
On OS X platforms, extension module filenames now end with @code{-darwin.so}.

@item 
On all other platforms, extension module filenames are the same as they were
with Python 3.4.
@end itemize

@node Descontinuados<10>,Removidos<10>,Mudanças a construções e API C<3>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 deprecated}@anchor{ee7}
@subsection Descontinuados


@menu
* New Keywords: New Keywords<2>. 
* Comportamento do Python descontinuado: Comportamento do Python descontinuado<2>. 
* Unsupported Operating Systems:: 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<3>. 

@end menu

@node New Keywords<2>,Comportamento do Python descontinuado<2>,,Descontinuados<10>
@anchor{whatsnew/3 5 new-keywords}@anchor{ee8}
@subsubsection New Keywords


@code{async} and @code{await} are not recommended to be used as variable, class,
function or module names.  Introduced by 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} in Python 3.5, they will
become proper keywords in Python 3.7.

@node Comportamento do Python descontinuado<2>,Unsupported Operating Systems,New Keywords<2>,Descontinuados<10>
@anchor{whatsnew/3 5 deprecated-python-behavior}@anchor{ee9}
@subsubsection Comportamento do Python descontinuado


Raising the @ref{c15,,StopIteration} exception inside a generator will now generate a silent
@ref{8ce,,PendingDeprecationWarning}, which will become a non-silent deprecation
warning in Python 3.6 and will trigger a @ref{195,,RuntimeError} in Python 3.7.
See @ref{d41,,PEP 479; Change StopIteration handling inside generators}
for details.

@node Unsupported Operating Systems,Deprecated Python modules functions and methods<3>,Comportamento do Python descontinuado<2>,Descontinuados<10>
@anchor{whatsnew/3 5 unsupported-operating-systems}@anchor{eea}
@subsubsection Unsupported Operating Systems


Windows XP is no longer supported by Microsoft, thus, per 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, CPython
3.5 is no longer officially supported on this OS.

@node Deprecated Python modules functions and methods<3>,,Unsupported Operating Systems,Descontinuados<10>
@anchor{whatsnew/3 5 deprecated-python-modules-functions-and-methods}@anchor{eeb}
@subsubsection Deprecated Python modules, functions and methods


The @code{formatter} module has now graduated to full deprecation and is still
slated for removal in Python 3.6.

The @code{asyncio.async()} function is deprecated in favor of
@ref{c92,,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.

Directly assigning values to the @ref{c1b,,key},
@ref{c1c,,value} and
@ref{c1d,,coded_value} of @ref{c1e,,http.cookies.Morsel}
objects is deprecated.  Use the @ref{c1f,,set()} method
instead.  In addition, the undocumented `LegalChars' parameter of
@ref{c1f,,set()} is deprecated, and is now ignored.

Passing a format string as keyword argument `format_string' to the
@ref{c1a,,format()} method of the @ref{eec,,string.Formatter}
class has been deprecated.
(Contributed by Serhiy Storchaka in bpo-23671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23671}.)

The @code{platform.dist()} and @code{platform.linux_distribution()} functions
are now deprecated.  Linux distributions use too many different ways of
describing themselves, so the functionality is left to a package.
(Contributed by Vajrasky Kok and Berker Peksag in bpo-1322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1322}.)

The previously undocumented @code{from_function} and @code{from_builtin} methods of
@ref{1cf,,inspect.Signature} are deprecated.  Use the new
@ref{73a,,Signature.from_callable()}
method instead. (Contributed by Yury Selivanov in bpo-24248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24248}.)

The @code{inspect.getargspec()} function is deprecated and scheduled to be
removed in Python 3.6.  (See bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438} for details.)

The @ref{7e,,inspect} @ref{739,,getfullargspec()},
@ref{eed,,getcallargs()}, and @code{formatargspec()} functions are
deprecated in favor of the @ref{738,,inspect.signature()} API. (Contributed by Yury
Selivanov in bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438}.)

@ref{eee,,getargvalues()} and @ref{eef,,formatargvalues()} functions
were inadvertently marked as deprecated with the release of Python 3.5.0.

Use of @ref{b82,,re.LOCALE} flag with str patterns or @ref{62c,,re.ASCII} is now
deprecated.  (Contributed by Serhiy Storchaka in bpo-22407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22407}.)

Use of unrecognized special sequences consisting of @code{'\'} and an ASCII letter
in regular expression patterns and replacement patterns now raises a
deprecation warning and will be forbidden in Python 3.6.
(Contributed by Serhiy Storchaka in bpo-23622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23622}.)

The undocumented and unofficial `use_load_tests' default argument of the
@ref{28f,,unittest.TestLoader.loadTestsFromModule()} method now is
deprecated and ignored.
(Contributed by Robert Collins and Barry A. Warsaw in bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}.)

@node Removidos<10>,Porting to Python 3 5,Descontinuados<10>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 removed}@anchor{ef0}
@subsection Removidos


@menu
* Remoção de APIs e recursos: Remoção de APIs e recursos<4>. 

@end menu

@node Remoção de APIs e recursos<4>,,,Removidos<10>
@anchor{whatsnew/3 5 api-and-feature-removals}@anchor{ef1}
@subsubsection Remoção de APIs e recursos


The following obsolete and previously deprecated APIs and features have been
removed:


@itemize *

@item 
The @code{__version__} attribute has been dropped from the email package.  The
email code hasn’t been shipped separately from the stdlib for a long time,
and the @code{__version__} string was not updated in the last few releases.

@item 
The internal @code{Netrc} class in the @ref{5e,,ftplib} module was deprecated in
3.4, and has now been removed.
(Contributed by Matt Chaput in bpo-6623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6623}.)

@item 
The concept of @code{.pyo} files has been removed.

@item 
The JoinableQueue class in the provisional @ref{a,,asyncio} module was
deprecated in 3.4.4 and is now removed.
(Contributed by A. Jesse Jiryu Davis in bpo-23464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23464}.)
@end itemize

@node Porting to Python 3 5,Notable changes in Python 3 5 4,Removidos<10>,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 porting-to-python-3-5}@anchor{ef2}
@subsection Porting to Python 3.5


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Alterações no comportamento do Python: Alterações no comportamento do Python<2>. 
* Alterações na API Python: Alterações na API Python<9>. 
* Alterações na API C: Alterações na API C<14>. 

@end menu

@node Alterações no comportamento do Python<2>,Alterações na API Python<9>,,Porting to Python 3 5
@anchor{whatsnew/3 5 changes-in-python-behavior}@anchor{ef3}
@subsubsection Alterações no comportamento do Python



@itemize *

@item 
Due to an oversight, earlier Python versions erroneously accepted the
following syntax:

@example
f(1 for x in [1], *args)
f(1 for x in [1], **kwargs)
@end example

Python 3.5 now correctly raises a @ref{18d,,SyntaxError}, as generator
expressions must be put in parentheses if not a sole argument to a function.
@end itemize

@node Alterações na API Python<9>,Alterações na API C<14>,Alterações no comportamento do Python<2>,Porting to Python 3 5
@anchor{whatsnew/3 5 changes-in-the-python-api}@anchor{ef4}
@subsubsection Alterações na API Python



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}: System calls are now retried when interrupted by a signal instead
of raising @ref{db0,,InterruptedError} if the Python signal handler does not
raise an exception.

@item 
Before Python 3.5, a @ref{1ce,,datetime.time} object was considered to be false
if it represented midnight in UTC.  This behavior was considered obscure and
error-prone and has been removed in Python 3.5.  See bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936} for full
details.

@item 
The @code{ssl.SSLSocket.send()} method now raises either
@ref{e98,,ssl.SSLWantReadError} or @ref{e99,,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 
The @code{__name__} attribute of generators is now set from the function name,
instead of being set from the code name. Use @code{gen.gi_code.co_name} to
retrieve the code name. Generators also have a new @code{__qualname__}
attribute, the qualified name, which is now used for the representation
of a generator (@code{repr(gen)}).
(Contributed by Victor Stinner in bpo-21205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21205}.)

@item 
The deprecated “strict” mode and argument of @ref{87b,,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{87b,,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 
Although it is not formally part of the API, it is worth noting for porting
purposes (ie: fixing tests) that error messages that were previously of the
form “‘sometype’ does not support the buffer protocol” are now of the form “a
@ref{d4f,,bytes-like object} is required, not ‘sometype’”.
(Contributed by Ezio Melotti in bpo-16518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16518}.)

@item 
If the current directory is set to a directory that no longer exists then
@ref{42b,,FileNotFoundError} will no longer be raised and instead
@ref{ef5,,find_spec()} will return @code{None}
`without' caching @code{None} in @ref{5e4,,sys.path_importer_cache}, which is
different than the typical case (bpo-22834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22834}).

@item 
HTTP status code and messages from @ref{6f,,http.client} and @ref{72,,http.server}
were refactored into a common @ref{906,,HTTPStatus} enum.  The values in
@ref{6f,,http.client} and @ref{72,,http.server} remain available for backwards
compatibility.  (Contributed by Demian Brecht in bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}.)

@item 
When an import loader defines @ref{86e,,exec_module()}
it is now expected to also define
@ref{cce,,create_module()} (raises a
@ref{1a5,,DeprecationWarning} now, will be an error in Python 3.6). If the loader
inherits from @ref{ef6,,importlib.abc.Loader} then there is nothing to do, else
simply define @ref{cce,,create_module()} to return
@code{None}.  (Contributed by Brett Cannon in bpo-23014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23014}.)

@item 
The @ref{2a2,,re.split()} function always ignored empty pattern matches, so the
@code{"x*"} pattern worked the same as @code{"x+"}, and the @code{"\b"} pattern never
worked.  Now @ref{2a2,,re.split()} raises a warning if the pattern could match
an empty string.  For compatibility, use patterns that never match an empty
string (e.g. @code{"x+"} instead of @code{"x*"}).  Patterns that could only match
an empty string (such as @code{"\b"}) now raise an error.
(Contributed by Serhiy Storchaka in bpo-22818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22818}.)

@item 
The @ref{c1e,,http.cookies.Morsel} dict-like interface has been made self
consistent:  morsel comparison now takes the @ref{c1b,,key}
and @ref{c1c,,value} into account,
@ref{ef7,,copy()} now results in a
@ref{c1e,,Morsel} instance rather than a @ref{256,,dict}, and
@ref{ef8,,update()} will now raise an exception if any of the
keys in the update dictionary are invalid.  In addition, the undocumented
`LegalChars' parameter of @ref{c1f,,set()} is deprecated and
is now ignored.  (Contributed by Demian Brecht in bpo-2211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2211}.)

@item 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} has removed @code{.pyo} files from Python and introduced the optional
@code{opt-} tag in @code{.pyc} file names. The
@ref{2fe,,importlib.util.cache_from_source()} has gained an `optimization'
parameter to help control the @code{opt-} tag. Because of this, the
`debug_override' parameter of the function is now deprecated. @code{.pyo} files
are also no longer supported as a file argument to the Python interpreter and
thus serve no purpose when distributed on their own (i.e. sourceless code
distribution). Due to the fact that the magic number for bytecode has changed
in Python 3.5, all old @code{.pyo} files from previous versions of Python are
invalid regardless of this PEP.

@item 
The @ref{cc,,socket} module now exports the @ref{ef9,,CAN_RAW_FD_FRAMES}
constant on linux 3.6 and greater.

@item 
The @ref{e9a,,ssl.cert_time_to_seconds()} function now interprets the input time
as UTC and not as local time, per 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}.  Additionally, the return
value is always an @ref{257,,int}. (Contributed by Akira Li in bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}.)

@item 
The @code{pygettext.py} Tool now uses the standard +NNNN format for timezones in
the POT-Creation-Date header.

@item 
The @ref{ca,,smtplib} module now uses @ref{940,,sys.stderr} instead of the previous
module-level @code{stderr} variable for debug output.  If your (test)
program depends on patching the module-level variable to capture the debug
output, you will need to update it to capture sys.stderr instead.

@item 
The @ref{efa,,str.startswith()} and @ref{efb,,str.endswith()} methods no longer return
@code{True} when finding the empty string and the indexes are completely out of
range.  (Contributed by Serhiy Storchaka in bpo-24284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24284}.)

@item 
The @ref{a02,,inspect.getdoc()} function now returns documentation strings
inherited from base classes.  Documentation strings no longer need to be
duplicated if the inherited documentation is appropriate.  To suppress an
inherited string, an empty string must be specified (or the documentation
may be filled in).  This change affects the output of the @ref{b5,,pydoc}
module and the @ref{8dd,,help()} function.
(Contributed by Serhiy Storchaka in bpo-15582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15582}.)

@item 
Nested @ref{414,,functools.partial()} calls are now flattened.  If you were
relying on the previous behavior, you can now either add an attribute to a
@ref{414,,functools.partial()} object or you can create a subclass of
@ref{414,,functools.partial()}.
(Contributed by Alexander Belopolsky in bpo-7830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7830}.)
@end itemize

@node Alterações na API C<14>,,Alterações na API Python<9>,Porting to Python 3 5
@anchor{whatsnew/3 5 changes-in-the-c-api}@anchor{efc}
@subsubsection Alterações na API 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 
The @code{PyMemAllocator} structure was renamed to
@ref{efd,,PyMemAllocatorEx} and a new @code{calloc} field was added.

@item 
Removed non-documented macro @code{PyObject_REPR()} which leaked references.
Use format character @code{%R} in @ref{38a,,PyUnicode_FromFormat()}-like functions
to format the @ref{800,,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{374,,__module__} attribute breaks pickling and
introspection, a deprecation warning is now raised for builtin types without
the @ref{374,,__module__} attribute.  This will be an @ref{34b,,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 Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} implementation, the @code{tp_reserved} slot of
@ref{ab4,,PyTypeObject} was replaced with a
@ref{efe,,tp_as_async} slot.  Refer to @ref{eff,,Objetos corrotina} for
new types, structures and functions.
@end itemize

@node Notable changes in Python 3 5 4,,Porting to Python 3 5,O que há de novo no Python 3 5
@anchor{whatsnew/3 5 notable-changes-in-python-3-5-4}@anchor{f00}
@subsection Notable changes in Python 3.5.4


@menu
* Novo alvo de construção make regen-all: Novo alvo de construção make regen-all<2>. 
* Remoção do alvo de construção make touch: Remoção do alvo de construção make touch<2>. 

@end menu

@node Novo alvo de construção make regen-all<2>,Remoção do alvo de construção make touch<2>,,Notable changes in Python 3 5 4
@anchor{whatsnew/3 5 new-make-regen-all-build-target}@anchor{f01}
@subsubsection Novo alvo de construção @code{make regen-all}


Para simplificar a compilação cruzada e garantir que o CPython possa ser compilado de forma confiável sem exigir que uma versão existente do Python já esteja disponível, o sistema de construção baseado em autotools não tenta mais recompilar implicitamente os arquivos gerados com base nos tempos de modificação dos arquivos.

Em vez disso, um novo comando @code{make regen-all} foi adicionado para forçar a regeneração desses arquivos quando desejado (por exemplo, após uma versão inicial do Python já ter sido construída com base nas versões pré-geradas).

Alvos de regeneração mais seletivos também são definidos – veja Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.13/Makefile.pre.in} para detalhes.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Adicionado na versão 3.5.4.


@node Remoção do alvo de construção make touch<2>,,Novo alvo de construção make regen-all<2>,Notable changes in Python 3 5 4
@anchor{whatsnew/3 5 removal-of-make-touch-build-target}@anchor{f02}
@subsubsection Remoção do alvo de construção @code{make touch}


O alvo de construção @code{make touch} usado anteriormente para solicitar regeneração implícita de arquivos gerados atualizando seus tempos de modificação foi removido.

Ele foi substituído pelo novo alvo @code{make regen-all}.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Alterado na versão 3.5.4.


@node O que há de novo no Python 3 4,O que há de novo no Python 3 3,O que há de novo no Python 3 5,O que há de novo no Python
@anchor{whatsnew/3 4 doc}@anchor{f03}@anchor{whatsnew/3 4 translation-repo}@anchor{f04}@anchor{whatsnew/3 4 what-s-new-in-python-3-4}@anchor{f05}
@section O que há de novo no 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``.

This article explains the new features in Python 3.4, compared to 3.3. Python 3.4 was released on March 16, 2014. For full details, see the changelog@footnote{https://docs.python.org/3.4/whatsnew/changelog.html}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 429
PEP 429@footnote{https://peps.python.org/pep-0429/} – Python 3.4 Release Schedule


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<10>. 
* Novas funcionalidades: Novas funcionalidades<15>. 
* Novos módulos: Novos módulos<10>. 
* Módulos melhorados: Módulos melhorados<10>. 
* CPython Implementation Changes:: 
* Descontinuados: Descontinuados<11>. 
* Removidos: Removidos<11>. 
* Porting to Python 3.4: Porting to Python 3 4. 
* Alterado em 3.4.3: Alterado em 3 4 3. 

@end menu

@node Resumo – Destaques da versão<10>,Novas funcionalidades<15>,,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 summary-release-highlights}@anchor{f06}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.4.
@c Brevity is key.

Novos recursos de sintaxe:


@itemize *

@item 
Não foram adicionados novos recursos de sintaxe no Python 3.4.
@end itemize

Outras novas funcionalidades:


@itemize *

@item 
@ref{f07,,pip should always be available} (
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}).

@item 
@ref{f08,,Newly created file descriptors are non-inheritable}
(
@geindex Propostas de Melhorias do Python; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}).

@item 
command line option for @ref{f09,,isolated mode}
(bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499}).

@item 
@ref{f0a,,improvements in the handling of codecs}
that are not text encodings (multiple issues).

@item 
@ref{f0b,,A ModuleSpec Type} for the Import System (
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}). (Affects importer authors.)

@item 
The @ref{8d,,marshal} format has been made @ref{f0c,,more compact and efficient} (bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475}).
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@ref{a,,asyncio}: @ref{f0d,,New provisional API for asynchronous IO} (
@geindex Propostas de Melhorias do Python; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}).

@item 
@ref{55,,ensurepip}: @ref{f0e,,Bootstrapping the pip installer}
(
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}).

@item 
@ref{56,,enum}: @ref{f0f,,Support for enumeration types}
(
@geindex Propostas de Melhorias do Python; PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/}).

@item 
@ref{a4,,pathlib}: @ref{f10,,Object-oriented filesystem paths}
(
@geindex Propostas de Melhorias do Python; PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/}).

@item 
@ref{c2,,selectors}: @ref{f11,,High-level and efficient I/O multiplexing}, built upon the @ref{c1,,select} module primitives (part
of 
@geindex Propostas de Melhorias do Python; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}).

@item 
@ref{d2,,statistics}: A basic @ref{f12,,numerically stable statistics library} (
@geindex Propostas de Melhorias do Python; PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/}).

@item 
@ref{ff,,tracemalloc}: @ref{f13,,Trace Python memory allocations} (
@geindex Propostas de Melhorias do Python; PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/}).
@end itemize

Módulos de biblioteca significativamente melhorados:


@itemize *

@item 
@ref{f14,,Single-dispatch generic functions} in
@ref{5f,,functools} (
@geindex Propostas de Melhorias do Python; PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/}).

@item 
New @ref{a6,,pickle} @ref{f15,,protocol 4} (
@geindex Propostas de Melhorias do Python; PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/}).

@item 
@ref{94,,multiprocessing} now has @ref{f16,,an option to avoid using os.fork on Unix} (bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}).

@item 
@ref{3b,,email} has a new submodule, @ref{3d,,contentmanager}, and
a new @ref{27c,,Message} subclass
(@ref{27b,,EmailMessage}) that @ref{f17,,simplify MIME handling} (bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}).

@item 
The @ref{7e,,inspect} and @ref{b5,,pydoc} modules are now capable of
correct introspection of a much wider variety of callable objects,
which improves the output of the Python @ref{8dd,,help()} system.

@item 
The @ref{80,,ipaddress} module API has been declared stable
@end itemize

Melhorias de Segurança:


@itemize *

@item 
@ref{f18,,Secure and interchangeable hash algorithm}
(
@geindex Propostas de Melhorias do Python; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/}).

@item 
@ref{f08,,Make newly created file descriptors non-inheritable}
(
@geindex Propostas de Melhorias do Python; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}) to avoid leaking file descriptors to child processes.

@item 
New command line option for @ref{f09,,isolated mode},
(bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499}).

@item 
@ref{94,,multiprocessing} now has @ref{f16,,an option to avoid using os.fork on Unix}. `spawn' and `forkserver' are more secure because they avoid sharing data with child processes.

@item 
@ref{94,,multiprocessing} child processes on Windows no longer inherit
all of the parent’s inheritable handles, only the necessary ones.

@item 
A new @ref{50f,,hashlib.pbkdf2_hmac()} function provides
the PKCS#5 password-based key derivation function 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}.

@item 
@ref{f19,,TLSv1.1 and TLSv1.2 support} for @ref{d0,,ssl}.

@item 
@ref{f1a,,Retrieving certificates from the Windows system cert store support} for @ref{d0,,ssl}.

@item 
@ref{f1b,,Server-side SNI (Server Name Indication) support} for @ref{d0,,ssl}.

@item 
The @ref{294,,ssl.SSLContext} class has a @ref{f1c,,lot of improvements}.

@item 
All modules in the standard library that support SSL now support server
certificate verification, including hostname matching
(@code{ssl.match_hostname()}) and CRLs (Certificate Revocation lists, see
@ref{f1d,,ssl.SSLContext.load_verify_locations()}).
@end itemize

Melhorias na implementação do CPython:


@itemize *

@item 
@ref{f1e,,Safe object finalization} (
@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}).

@item 
Leveraging 
@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}, in most cases @ref{f1e,,module globals are no longer set to None during finalization} (bpo-18214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18214}).

@item 
@ref{f1f,,Configurable memory allocators} (
@geindex Propostas de Melhorias do Python; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/}).

@item 
@ref{f20,,Argument Clinic} (
@geindex Propostas de Melhorias do Python; PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/}).
@end itemize

Please read on for a comprehensive list of user-facing changes, including many
other smaller improvements, CPython optimizations, deprecations, and potential
porting issues.

@node Novas funcionalidades<15>,Novos módulos<10>,Resumo – Destaques da versão<10>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 new-features}@anchor{f21}
@subsection Novas funcionalidades


@menu
* PEP 453; Explicit Bootstrapping of PIP in Python Installations: PEP 453 Explicit Bootstrapping of PIP in Python Installations. 
* PEP 446; Newly Created File Descriptors Are Non-Inheritable: PEP 446 Newly Created File Descriptors Are Non-Inheritable. 
* Melhorias no manuseio de Codecs:: 
* PEP 451; A ModuleSpec Type for the Import System: PEP 451 A ModuleSpec Type for the Import System. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<10>. 

@end menu

@node PEP 453 Explicit Bootstrapping of PIP in Python Installations,PEP 446 Newly Created File Descriptors Are Non-Inheritable,,Novas funcionalidades<15>
@anchor{whatsnew/3 4 pep-453-explicit-bootstrapping-of-pip-in-python-installations}@anchor{f22}@anchor{whatsnew/3 4 whatsnew-pep-453}@anchor{f07}
@subsubsection PEP 453: Explicit Bootstrapping of PIP in Python Installations


@menu
* Bootstrapping pip By Default:: 
* Mudanças na documentação:: 

@end menu

@node Bootstrapping pip By Default,Mudanças na documentação,,PEP 453 Explicit Bootstrapping of PIP in Python Installations
@anchor{whatsnew/3 4 bootstrapping-pip-by-default}@anchor{f23}
@subsubsection Bootstrapping pip By Default


The new @ref{55,,ensurepip} module (defined in 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}) provides a standard
cross-platform mechanism to bootstrap the pip installer into Python
installations and virtual environments. The version of @code{pip} included
with Python 3.4.0 is @code{pip} 1.5.4, and future 3.4.x maintenance releases
will update the bundled version to the latest version of @code{pip} that is
available at the time of creating the release candidate.

By default, the commands @code{pipX} and @code{pipX.Y} will be installed on all
platforms (where X.Y stands for the version of the Python installation),
along with the @code{pip} Python package and its dependencies. On Windows and
in virtual environments on all platforms, the unversioned @code{pip} command
will also be installed. On other platforms, the system wide unversioned
@code{pip} command typically refers to the separately installed Python 2
version.

The @code{pyvenv} command line utility and the @ref{111,,venv}
module make use of the @ref{55,,ensurepip} module to make @code{pip} readily
available in virtual environments. When using the command line utility,
@code{pip} is installed by default, while when using the @ref{111,,venv} module
@ref{f24,,API} installation of @code{pip} must be requested explicitly.

For CPython @ref{f25,,source builds on POSIX systems}, the @code{make install} and @code{make altinstall} commands bootstrap @code{pip} by default. This behaviour can be controlled through configure options, and overridden through Makefile options.

On Windows and Mac OS X, the CPython installers now default to installing
@code{pip} along with CPython itself (users may opt out of installing it
during the installation process). Window users will need to opt in to the
automatic @code{PATH} modifications to have @code{pip} available from the command
line by default, otherwise it can still be accessed through the Python
launcher for Windows as @code{py -m pip}.

As 
@geindex Propostas de Melhorias do Python; 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 
To avoid conflicts between parallel Python 2 and Python 3 installations,
only the versioned @code{pip3} and @code{pip3.4} commands are bootstrapped by
default when @code{ensurepip} is invoked directly - the @code{--default-pip}
option is needed to also request the unversioned @code{pip} command.
@code{pyvenv} and the Windows installer ensure that the unqualified @code{pip}
command is made available in those environments, and @code{pip} can always be
invoked via the @code{-m} switch rather than directly to avoid ambiguity on
systems with multiple Python installations.
@end quotation
@end cartouche

@node Mudanças na documentação,,Bootstrapping pip By Default,PEP 453 Explicit Bootstrapping of PIP in Python Installations
@anchor{whatsnew/3 4 documentation-changes}@anchor{f26}
@subsubsection Mudanças na documentação


As part of this change, the @ref{f27,,Instalando módulos Python} and
distributing-index sections of the documentation have been
completely redesigned as short getting started and FAQ documents. Most
packaging documentation has now been moved out to the Python Packaging
Authority maintained Python Packaging User Guide@footnote{https://packaging.python.org} and the documentation of the individual
projects.

No entanto, como esta migração ainda está incompleta, as versões legadas desses guias permanecem disponíveis como @ref{f28,,Construindo extensões C e C ++ com setuptools} e @ref{f29,,Construindo extensões C e C ++ com setuptools}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} – Explicit bootstrapping of pip in Python installations

PEP written by Donald Stufft and Nick Coghlan, implemented by
Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.
@end table


@node PEP 446 Newly Created File Descriptors Are Non-Inheritable,Melhorias no manuseio de Codecs,PEP 453 Explicit Bootstrapping of PIP in Python Installations,Novas funcionalidades<15>
@anchor{whatsnew/3 4 pep-446-newly-created-file-descriptors-are-non-inheritable}@anchor{f2a}@anchor{whatsnew/3 4 whatsnew-pep-446}@anchor{f08}
@subsubsection PEP 446: Newly Created File Descriptors Are Non-Inheritable


@geindex Propostas de Melhorias do Python; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/} makes newly created file descriptors @ref{f2b,,non-inheritable}. In general, this is the behavior an application will want: when launching a new process, having currently open files also open in the new process can lead to all sorts of hard to find bugs, and potentially to security issues.

However, there are occasions when inheritance is desired. To support these cases, the following new functions and methods are available:


@itemize *

@item 
@ref{f2c,,os.get_inheritable()}, @ref{f2d,,os.set_inheritable()}

@item 
@ref{f2e,,os.get_handle_inheritable()}, @ref{f2f,,os.set_handle_inheritable()}

@item 
@ref{f30,,socket.socket.get_inheritable()}, @ref{f31,,socket.socket.set_inheritable()}
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 446

@item PEP 446@footnote{https://peps.python.org/pep-0446/} – Make newly created file descriptors non-inheritable

PEP escrito e implementado por Victor Stinner.
@end table


@node Melhorias no manuseio de Codecs,PEP 451 A ModuleSpec Type for the Import System,PEP 446 Newly Created File Descriptors Are Non-Inheritable,Novas funcionalidades<15>
@anchor{whatsnew/3 4 codec-handling-improvements}@anchor{f0a}@anchor{whatsnew/3 4 improvements-to-codec-handling}@anchor{f32}
@subsubsection Melhorias no manuseio de Codecs


Since it was first introduced, the @ref{1b,,codecs} module has always been
intended to operate as a type-neutral dynamic encoding and decoding
system. However, its close coupling with the Python text model, especially
the type restricted convenience methods on the builtin @ref{44c,,str},
@ref{1c2,,bytes} and @ref{2ea,,bytearray} types, has historically obscured that
fact.

As a key step in clarifying the situation, the @ref{f33,,codecs.encode()} and
@ref{f34,,codecs.decode()} convenience functions are now properly documented in
Python 2.7, 3.3 and 3.4. These functions have existed in the @ref{1b,,codecs}
module (and have been covered by the regression test suite) since Python 2.4,
but were previously only discoverable through runtime introspection.

Unlike the convenience methods on @ref{44c,,str}, @ref{1c2,,bytes} and
@ref{2ea,,bytearray}, the @ref{1b,,codecs} convenience functions support arbitrary
codecs in both Python 2 and Python 3, rather than being limited to Unicode text
encodings (in Python 3) or @code{basestring} <-> @code{basestring} conversions (in
Python 2).

In Python 3.4, the interpreter is able to identify the known non-text
encodings provided in the standard library and direct users towards these
general purpose convenience functions when appropriate:

@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

In a related change, whenever it is feasible without breaking backwards
compatibility, exceptions raised during encoding and decoding operations
are wrapped in a chained exception of the same type that mentions the
name of the codec responsible for producing the 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

Finally, as the examples above show, these improvements have permitted
the restoration of the convenience aliases for the non-Unicode codecs that
were themselves restored in Python 3.2. This means that encoding binary data
to and from its hexadecimal representation (for example) can now be written
as:

@example
>>> from codecs import encode, decode
>>> encode(b"hello", "hex")
b'68656c6c6f'
>>> decode(b"68656c6c6f", "hex")
b'hello'
@end example

The binary and text transforms provided in the standard library are detailed
in @ref{f35,,Binary Transforms} and @ref{f36,,Text Transforms}.

(Contributed by Nick Coghlan in 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} and bpo-19619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19619}.)

@node PEP 451 A ModuleSpec Type for the Import System,Outras mudanças na linguagem<10>,Melhorias no manuseio de Codecs,Novas funcionalidades<15>
@anchor{whatsnew/3 4 pep-451-a-modulespec-type-for-the-import-system}@anchor{f37}@anchor{whatsnew/3 4 whatsnew-pep-451}@anchor{f0b}
@subsubsection PEP 451: A ModuleSpec Type for the Import System


@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} provides an encapsulation of the information about a module that the import machinery will use to load it (that is, a module specification). This helps simplify both the import implementation and several import-related APIs. The change is also a stepping stone for several future import-related improvements@footnote{https://mail.python.org/pipermail/python-dev/2013-November/130111.html}.

The public-facing changes from the PEP are entirely backward-compatible. Furthermore, they should be transparent to everyone but importer authors. Key finder and loader methods have been deprecated, but they will continue working. New importers should use the new methods described in the PEP. Existing importers should be updated to implement the new methods. See the @ref{f38,,Descontinuados} section for a list of methods that should be replaced and their replacements.

@node Outras mudanças na linguagem<10>,,PEP 451 A ModuleSpec Type for the Import System,Novas funcionalidades<15>
@anchor{whatsnew/3 4 other-language-changes}@anchor{f39}
@subsubsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
Unicode database updated to UCD version 6.3.

@item 
@ref{f3a,,min()} and @ref{f3b,,max()} now accept a `default' keyword-only argument that can be used to specify the value they return if the iterable they are evaluating has no elements. (Contributed by Julian Berman in bpo-18111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18111}.)

@item 
Objetos módulo são agora @ref{f3c,,fracamente referenciáveis}.

@item 
Module @code{__file__} attributes (and related values) should now always contain absolute paths by default, with the sole exception of @code{__main__.__file__} when a script has been executed directly using a relative path. (Contributed by Brett Cannon in bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}.)

@item 
All the UTF-* codecs (except UTF-7) now reject surrogates during both
encoding and decoding unless the @code{surrogatepass} error handler is used,
with the exception of the UTF-16 decoder (which accepts valid surrogate pairs)
and the UTF-16 encoder (which produces them while encoding non-BMP characters).
(Contributed by Victor Stinner, Kang-Hao (Kenny) Lu and Serhiy Storchaka in
bpo-12892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12892}.)

@item 
New German EBCDIC @ref{de1,,codec} @code{cp273}. (Contributed by Michael Bierenfeld and Andrew Kuchling in bpo-1097797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1097797}.)

@item 
New Ukrainian @ref{de1,,codec} @code{cp1125}. (Contributed by Serhiy Storchaka in bpo-19668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19668}.)

@item 
@ref{1c2,,bytes}.join() and @ref{2ea,,bytearray}.join() now accept arbitrary buffer objects as arguments. (Contributed by Antoine Pitrou in bpo-15958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15958}.)

@item 
The @ref{257,,int} constructor now accepts any object that has an @code{__index__} method for its `base' argument. (Contributed by Mark Dickinson in bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772}.)

@item 
Frame objects now have a @ref{280,,clear()} method that clears all references to local variables from the frame. (Contributed by Antoine Pitrou in bpo-17934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17934}.)

@item 
@ref{2eb,,memoryview} is now registered as a @ref{1e,,Sequence}, and supports the @ref{869,,reversed()} builtin. (Contributed by Nick Coghlan and Claudiu Popa in bpo-18690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18690} and bpo-19078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19078}.)

@item 
Signatures reported by @ref{8dd,,help()} have been modified and improved in
several cases as a result of the introduction of Argument Clinic and other
changes to the @ref{7e,,inspect} and @ref{b5,,pydoc} modules.

@item 
@ref{f3d,,__length_hint__()} is now part of the formal language specification (see 
@geindex Propostas de Melhorias do Python; PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/}). (Contributed by Armin Ronacher in bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)
@end itemize

@node Novos módulos<10>,Módulos melhorados<10>,Novas funcionalidades<15>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 new-modules}@anchor{f3e}
@subsection Novos módulos


@menu
* asyncio: asyncio<11>. 
* ensurepip: ensurepip<2>. 
* enum: enum<9>. 
* pathlib: pathlib<11>. 
* selectors: selectors<2>. 
* statistics: statistics<6>. 
* tracemalloc: tracemalloc<4>. 

@end menu

@node asyncio<11>,ensurepip<2>,,Novos módulos<10>
@anchor{whatsnew/3 4 asyncio}@anchor{f3f}@anchor{whatsnew/3 4 whatsnew-asyncio}@anchor{f0d}
@subsubsection asyncio


The new @ref{a,,asyncio} module (defined in 
@geindex Propostas de Melhorias do Python; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/}) provides a standard
pluggable event loop model for Python, providing solid asynchronous IO
support in the standard library, and making it easier for other event loop
implementations to interoperate with the standard library and each other.

For Python 3.4, this module is considered a @ref{b16,,provisional API}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3156

@item PEP 3156@footnote{https://peps.python.org/pep-3156/} – Asynchronous IO Support Rebooted: the “asyncio” Module

PEP written and implementation led by Guido van Rossum.
@end table


@node ensurepip<2>,enum<9>,asyncio<11>,Novos módulos<10>
@anchor{whatsnew/3 4 ensurepip}@anchor{f40}@anchor{whatsnew/3 4 whatsnew-ensurepip}@anchor{f0e}
@subsubsection ensurepip


The new @ref{55,,ensurepip} module is the primary infrastructure for the 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} implementation. In the normal course of events end users will not need to interact with this module, but it can be used to manually bootstrap @code{pip} if the automated bootstrapping into an installation or virtual environment was declined.

@ref{55,,ensurepip} includes a bundled copy of @code{pip}, up-to-date as of the first release candidate of the release of CPython with which it ships (this applies to both maintenance releases and feature releases). @code{ensurepip} does not access the internet. If the installation has Internet access, after @code{ensurepip} is run the bundled @code{pip} can be used to upgrade @code{pip} to a more recent release than the bundled one. (Note that such an upgraded version of @code{pip} is considered to be a separately installed package and will not be removed if Python is uninstalled.)

The module is named `ensure'pip because if called when @code{pip} is already installed, it does nothing. It also has an @code{--upgrade} option that will cause it to install the bundled copy of @code{pip} if the existing installed version of @code{pip} is older than the bundled copy.

@node enum<9>,pathlib<11>,ensurepip<2>,Novos módulos<10>
@anchor{whatsnew/3 4 enum}@anchor{f41}@anchor{whatsnew/3 4 whatsnew-enum}@anchor{f0f}
@subsubsection enum


The new @ref{56,,enum} module (defined in 
@geindex Propostas de Melhorias do Python; PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/}) provides a standard
implementation of enumeration types, allowing other modules (such as
@ref{cc,,socket}) to provide more informative error messages and better
debugging support by replacing opaque integer constants with backwards
compatible enumeration values.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 435

@item PEP 435@footnote{https://peps.python.org/pep-0435/} – Adding an Enum type to the Python standard library

PEP written by Barry Warsaw, Eli Bendersky and Ethan Furman,
implemented by Ethan Furman.
@end table


@node pathlib<11>,selectors<2>,enum<9>,Novos módulos<10>
@anchor{whatsnew/3 4 pathlib}@anchor{f42}@anchor{whatsnew/3 4 whatsnew-pathlib}@anchor{f10}
@subsubsection pathlib


The new @ref{a4,,pathlib} module offers classes representing filesystem paths with semantics appropriate for different operating systems. Path classes are divided between `pure paths', which provide purely computational operations without I/O, and `concrete paths', which inherit from pure paths but also provide I/O operations.

For Python 3.4, this module is considered a @ref{b16,,provisional API}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 428

@item PEP 428@footnote{https://peps.python.org/pep-0428/} – The pathlib module – object-oriented filesystem paths

PEP escrita e implementada por Antoine Pitrou.
@end table


@node selectors<2>,statistics<6>,pathlib<11>,Novos módulos<10>
@anchor{whatsnew/3 4 selectors}@anchor{f43}@anchor{whatsnew/3 4 whatsnew-selectors}@anchor{f11}
@subsubsection selectors


The new @ref{c2,,selectors} module (created as part of implementing 
@geindex Propostas de Melhorias do Python; PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/})
allows high-level and efficient I/O multiplexing, built upon the
@ref{c1,,select} module primitives.

@node statistics<6>,tracemalloc<4>,selectors<2>,Novos módulos<10>
@anchor{whatsnew/3 4 statistics}@anchor{f44}@anchor{whatsnew/3 4 whatsnew-statistics}@anchor{f12}
@subsubsection statistics


The new @ref{d2,,statistics} module (defined in 
@geindex Propostas de Melhorias do Python; PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/}) offers some core
statistics functionality directly in the standard library. This module
supports calculation of the mean, median, mode, variance and standard
deviation of a data series.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 450

@item PEP 450@footnote{https://peps.python.org/pep-0450/} – Adding A Statistics Module To The Standard Library

PEP written and implemented by Steven D’Aprano
@end table


@node tracemalloc<4>,,statistics<6>,Novos módulos<10>
@anchor{whatsnew/3 4 tracemalloc}@anchor{f45}@anchor{whatsnew/3 4 whatsnew-tracemalloc}@anchor{f13}
@subsubsection tracemalloc


The new @ref{ff,,tracemalloc} module (defined in 
@geindex Propostas de Melhorias do Python; PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/}) is a debug tool to
trace memory blocks allocated by Python. It provides the following information:


@itemize *

@item 
Trace where an object was allocated

@item 
Statistics on allocated memory blocks per filename and per line number:
total size, number and average size of allocated memory blocks

@item 
Compute the differences between two snapshots to detect memory leaks
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 454

@item PEP 454@footnote{https://peps.python.org/pep-0454/} – Add a new tracemalloc module to trace Python memory allocations

PEP escrito e implementado por Victor Stinner
@end table


@node Módulos melhorados<10>,CPython Implementation Changes,Novos módulos<10>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 improved-modules}@anchor{f46}
@subsection Módulos melhorados


@menu
* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<5>. 
* audioop:: 
* base64: base64<3>. 
* collections: collections<6>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<4>. 
* doctest: doctest<4>. 
* email: email<4>. 
* filecmp:: 
* functools: functools<5>. 
* gc: gc<5>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<3>. 
* html:: 
* http: http<3>. 
* idlelib e IDLE: idlelib e IDLE<4>. 
* importlib: importlib<9>. 
* inspect: inspect<8>. 
* ipaddress: ipaddress<5>. 
* logging: logging<6>. 
* marshal: marshal<2>. 
* mmap: mmap<3>. 
* multiprocessing: multiprocessing<7>. 
* operador: operador<3>. 
* os: os<11>. 
* pdb: pdb<6>. 
* pickle: pickle<4>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty:: 
* pydoc: pydoc<4>. 
* re: re<8>. 
* resource:: 
* select:: 
* shelve: shelve<2>. 
* shutil: shutil<6>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* socket: socket<9>. 
* sqlite3: sqlite3<9>. 
* ssl: ssl<10>. 
* stat:: 
* struct: struct<2>. 
* subprocess: subprocess<5>. 
* sunau: sunau<2>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* textwrap:: 
* threading: threading<7>. 
* traceback: traceback<6>. 
* types: types<6>. 
* urllib: urllib<3>. 
* unittest: unittest<9>. 
* venv: venv<7>. 
* wave: wave<2>. 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* zipfile: zipfile<5>. 

@end menu

@node abc,aifc<2>,,Módulos melhorados<10>
@anchor{whatsnew/3 4 abc}@anchor{f47}
@subsubsection abc


New function @ref{f48,,abc.get_cache_token()} can be used to know when to invalidate caches that are affected by changes in the object graph. (Contributed by Łukasz Langa in bpo-16832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16832}.)

New class @ref{f49,,ABC} has @ref{f4a,,ABCMeta} as its meta class.
Using @code{ABC} as a base class has essentially the same effect as specifying
@code{metaclass=abc.ABCMeta}, but is simpler to type and easier to read.
(Contributed by Bruno Dupuis in bpo-16049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16049}.)

@node aifc<2>,argparse<5>,abc,Módulos melhorados<10>
@anchor{whatsnew/3 4 aifc}@anchor{f4b}
@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{5d2,,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{d4f,,bytes-like object}.  (Contributed by Serhiy
Storchaka in bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node argparse<5>,audioop,aifc<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 argparse}@anchor{f4c}
@subsubsection argparse


The @ref{f4d,,FileType} class now accepts `encoding' and `errors' arguments, which are passed through to @ref{51c,,open()}. (Contributed by Lucas Maystre in bpo-11175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11175}.)

@node audioop,base64<3>,argparse<5>,Módulos melhorados<10>
@anchor{whatsnew/3 4 audioop}@anchor{f4e}
@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{d4f,,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>,collections<6>,audioop,Módulos melhorados<10>
@anchor{whatsnew/3 4 base64}@anchor{f4f}
@subsubsection base64


The encoding and decoding functions in @ref{e,,base64} now accept any @ref{d4f,,bytes-like object} in cases where it previously required a @ref{1c2,,bytes} or @ref{2ea,,bytearray} instance. (Contributed by Nick Coghlan in bpo-17839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17839}.)

New functions @ref{f50,,a85encode()}, @ref{f51,,a85decode()}, @ref{f52,,b85encode()}, and @ref{f53,,b85decode()} provide the ability to encode and decode binary data from and to @code{Ascii85} and the git/mercurial @code{Base85} formats, respectively. The @code{a85} functions have options that can be used to make them compatible with the variants of the @code{Ascii85} encoding, including the Adobe variant. (Contributed by Martin Morrison, the Mercurial project, Serhiy Storchaka, and Antoine Pitrou in bpo-17618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17618}.)

@node collections<6>,colorsys,base64<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 collections}@anchor{f54}
@subsubsection collections


The @ref{f55,,ChainMap.new_child()} method now accepts an `m' argument specifying the child map to add to the chain. This allows an existing mapping and/or a custom mapping type to be used for the child. (Contributed by Vinay Sajip in bpo-16613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16613}.)

@node colorsys,contextlib<6>,collections<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 colorsys}@anchor{f56}
@subsubsection colorsys


The number of digits in the coefficients for the RGB — YIQ conversions have been expanded so that they match the FCC NTSC versions. The change in results should be less than 1% and may better match results found elsewhere. (Contributed by Brian Landers and Serhiy Storchaka in bpo-14323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14323}.)

@node contextlib<6>,dbm<6>,colorsys,Módulos melhorados<10>
@anchor{whatsnew/3 4 contextlib}@anchor{f57}
@subsubsection contextlib


The new @ref{f58,,contextlib.suppress} context manager helps to clarify the intent of code that deliberately suppresses exceptions from a single statement. (Contributed by Raymond Hettinger in bpo-15806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15806} and Zero Piraeus in bpo-19266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19266}.)

The new @ref{e12,,contextlib.redirect_stdout()} context manager makes it easier for utility scripts to handle inflexible APIs that write their output to @ref{ae6,,sys.stdout} and don’t provide any options to redirect it. Using the context manager, the @ref{ae6,,sys.stdout} output can be redirected to any other stream or, in conjunction with @ref{f59,,io.StringIO}, to a string. The latter can be especially useful, for example, to capture output from a function that was written to implement a command line interface. It is recommended only for utility scripts because it affects the global state of @ref{ae6,,sys.stdout}. (Contributed by Raymond Hettinger in bpo-15805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15805}.)

The @ref{23,,contextlib} documentation has also been updated to include a
@ref{f5a,,discussion} of the
differences between single use, reusable and reentrant context managers.

@node dbm<6>,dis<4>,contextlib<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 dbm}@anchor{f5b}
@subsubsection dbm


@ref{f5c,,dbm.open()} objects now support the context management protocol. When used in a @ref{5d2,,with} statement, the @code{close} method of the database object will be called automatically at the end of the block. (Contributed by Claudiu Popa and Nick Coghlan in bpo-19282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19282}.)

@node dis<4>,doctest<4>,dbm<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 dis}@anchor{f5d}
@subsubsection dis


Functions @ref{f5e,,show_code()}, @ref{b46,,dis()}, @ref{f5f,,distb()}, and
@ref{f60,,disassemble()} now accept a keyword-only `file' argument that
controls where they write their output.

The @ref{38,,dis} module is now built around an @ref{1da,,Instruction} class
that provides object oriented access to the details of each individual bytecode
operation.

A new method, @ref{1d9,,get_instructions()}, provides an iterator that emits the Instruction stream for a given piece of Python code. Thus it is now possible to write a program that inspects and manipulates a bytecode object in ways different from those provided by the @ref{38,,dis} module itself. For example:

@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

The various display tools in the @ref{38,,dis} module have been rewritten to use
these new components.

In addition, a new application-friendly class @ref{f61,,Bytecode} provides
an object-oriented API for inspecting bytecode in both in human-readable form
and for iterating over instructions.  The @ref{f61,,Bytecode} constructor
takes the same arguments that @ref{1d9,,get_instructions()} does (plus an
optional `current_offset'), and the resulting object can be iterated to produce
@ref{1da,,Instruction} objects.  But it also has a @ref{f62,,dis}
method, equivalent to calling @ref{b46,,dis} on the constructor argument, but
returned as a multi-line string:

@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{f61,,Bytecode} also has a class method,
@ref{f63,,from_traceback()}, that provides the ability to manipulate a
traceback (that is, @code{print(Bytecode.from_traceback(tb).dis())} is equivalent
to @code{distb(tb)}).

(Contributed by Nick Coghlan, Ryan Kelly and Thomas Kluyver in bpo-11816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11816}
and Claudiu Popa in bpo-17916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17916}.)

New function @ref{f64,,stack_effect()} computes the effect on the Python stack
of a given opcode and argument, information that is not otherwise available.
(Contributed by Larry Hastings in bpo-19722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19722}.)

@node doctest<4>,email<4>,dis<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 doctest}@anchor{f65}
@subsubsection doctest


A new @ref{f66,,option flag}, @ref{f67,,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}.)

The @ref{3a,,doctest} command line interface now uses @ref{6,,argparse}, and has two new options, @code{-o} and @code{-f}. @code{-o} allows @ref{f66,,doctest options} to be specified on the command line, and @code{-f} is a shorthand for @code{-o FAIL_FAST} (to parallel the similar option supported by the @ref{106,,unittest} CLI). (Contributed by R. David Murray in bpo-11390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11390}.)

@ref{3a,,doctest} will now find doctests in extension module @code{__doc__} strings.
(Contributed by Zachary Ware in bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158}.)

@node email<4>,filecmp,doctest<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 email}@anchor{f68}
@subsubsection email


@ref{f69,,as_string()} now accepts a `policy' argument to override the default policy of the message when generating a string representation of it. This means that @code{as_string} can now be used in more circumstances, instead of having to create and use a @ref{40,,generator} in order to pass formatting parameters to its @code{flatten} method. (Contributed by R. David Murray in bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600}.)

New method @ref{f6a,,as_bytes()} added to produce a bytes representation of the message in a fashion similar to how @code{as_string} produces a string representation. It does not accept the `maxheaderlen' argument, but does accept the `unixfrom' and `policy' arguments. The @ref{27c,,Message} @ref{f6b,,__bytes__()} method calls it, meaning that @code{bytes(mymsg)} will now produce the intuitive result: a bytes object containing the fully formatted message. (Contributed by R. David Murray in bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600}.)

The @ref{f6c,,Message.set_param()} message now accepts a `replace' keyword argument. When specified, the associated header will be updated without changing its location in the list of headers. For backward compatibility, the default is @code{False}. (Contributed by R. David Murray in bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}.)
@anchor{whatsnew/3 4 whatsnew-email-contentmanager}@anchor{f17}
A pair of new subclasses of @ref{27c,,Message} have been added (@ref{27b,,EmailMessage} and @ref{f6d,,MIMEPart}), along with a new sub-module, @ref{3d,,contentmanager} and a new @ref{4f,,policy} attribute @ref{f6e,,content_manager}. All documentation is currently in the new module, which is being added as part of email’s new @ref{b16,,provisional API}. These classes provide a number of new methods that make extracting content from and inserting content into email messages much easier. For details, see the @ref{3d,,contentmanager} documentation and the @ref{f6f,,email; Exemplos}. These API additions complete the bulk of the work that was planned as part of the email6 project. The currently provisional API is scheduled to become final in Python 3.5 (possibly with a few minor additions in the area of error handling). (Contributed by R. David Murray in bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891}.)

@node filecmp,functools<5>,email<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 filecmp}@anchor{f70}
@subsubsection filecmp


A new @ref{f71,,clear_cache()} function provides the ability to clear the @ref{5a,,filecmp} comparison cache, which uses @ref{4a0,,os.stat()} information to determine if the file has changed since the last compare. This can be used, for example, if the file might have been changed and re-checked in less time than the resolution of a particular filesystem’s file modification time field. (Contributed by Mark Levitt in bpo-18149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18149}.)

New module attribute @ref{f72,,DEFAULT_IGNORES} provides the list of
directories that are used as the default value for the `ignore' parameter of
the @ref{f73,,dircmp()} function.  (Contributed by Eli Bendersky in
bpo-15442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15442}.)

@node functools<5>,gc<5>,filecmp,Módulos melhorados<10>
@anchor{whatsnew/3 4 functools}@anchor{f74}
@subsubsection functools


The new @ref{a85,,partialmethod()} descriptor brings partial argument
application to descriptors, just as @ref{414,,partial()} provides
for normal callables. The new descriptor also makes it easier to get
arbitrary callables (including @ref{414,,partial()} instances)
to behave like normal instance methods when included in a class definition.
(Contributed by Alon Horev and Nick Coghlan in bpo-4331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4331}.)
@anchor{whatsnew/3 4 whatsnew-singledispatch}@anchor{f14}
The new @ref{639,,singledispatch()} decorator brings support for
single-dispatch generic functions to the Python standard library. Where
object oriented programming focuses on grouping multiple operations on a
common set of data into a class, a generic function focuses on grouping
multiple implementations of an operation that allows it to work with
`different' kinds of data.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 443

@item PEP 443@footnote{https://peps.python.org/pep-0443/} – Single-dispatch generic functions

PEP escrita e implementada por Łukasz Langa.
@end table


@ref{f75,,total_ordering()} now supports a return value of
@ref{7d3,,NotImplemented} from the underlying comparison function.  (Contributed
by Katie Miller in bpo-10042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10042}.)

A pure-python version of the @ref{414,,partial()} function is now in the stdlib; in CPython it is overridden by the C accelerated version, but it is available for other implementations to use. (Contributed by Brian Thorne in bpo-12428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12428}.)

@node gc<5>,glob<4>,functools<5>,Módulos melhorados<10>
@anchor{whatsnew/3 4 gc}@anchor{f76}
@subsubsection gc


New function @ref{f77,,get_stats()} returns a list of three per-generation
dictionaries containing the collections statistics since interpreter startup.
(Contributed by Antoine Pitrou in bpo-16351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16351}.)

@node glob<4>,hashlib<6>,gc<5>,Módulos melhorados<10>
@anchor{whatsnew/3 4 glob}@anchor{f78}
@subsubsection glob


A new function @ref{f79,,escape()} provides a way to escape special characters in a filename so that they do not become part of the globbing expansion but are instead matched literally. (Contributed by Serhiy Storchaka in bpo-8402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8402}.)

@node hashlib<6>,hmac<3>,glob<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 hashlib}@anchor{f7a}
@subsubsection hashlib


A new @ref{50f,,hashlib.pbkdf2_hmac()} function provides the PKCS#5 password-based key derivation function 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}. (Contributed by Christian Heimes in bpo-18582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18582}.)

The @ref{f7b,,name} attribute of @ref{68,,hashlib} hash objects is now a formally supported interface. It has always existed in CPython’s @ref{68,,hashlib} (although it did not return lower case names for all supported hashes), but it was not a public interface and so some other Python implementations have not previously supported it. (Contributed by Jason R. Coombs in bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532}.)

@node hmac<3>,html,hashlib<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 hmac}@anchor{f7c}
@subsubsection hmac


@ref{6a,,hmac} now accepts @code{bytearray} as well as @code{bytes} for the `key' argument to the @ref{aae,,new()} function, and the `msg' parameter to both the @ref{aae,,new()} function and the @ref{f7d,,update()} method now accepts any type supported by the @ref{68,,hashlib} module. (Contributed by Jonas Borgström in bpo-18240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18240}.)

The `digestmod' argument to the @ref{aae,,hmac.new()} function may now be any hash digest name recognized by @ref{68,,hashlib}. In addition, the current behavior in which the value of `digestmod' defaults to @code{MD5} is deprecated: in a future version of Python there will be no default value. (Contributed by Christian Heimes in bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276}.)

With the addition of @ref{f7e,,block_size} and @ref{f7f,,name}
attributes (and the formal documentation of the @ref{f80,,digest_size}
attribute), the @ref{6a,,hmac} module now conforms fully to the 
@geindex Propostas de Melhorias do Python; PEP 247
PEP 247@footnote{https://peps.python.org/pep-0247/} API.
(Contributed by Christian Heimes in bpo-18775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18775}.)

@node html,http<3>,hmac<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 html}@anchor{f81}
@subsubsection html


New function @ref{95e,,unescape()} function converts HTML5 character references to the corresponding Unicode characters. (Contributed by Ezio Melotti in bpo-2927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2927}.)

@ref{87b,,HTMLParser} accepts a new keyword argument `convert_charrefs' that, when @code{True}, automatically converts all character references. For backward-compatibility, its value defaults to @code{False}, but it will change to @code{True} in a future version of Python, so you are invited to set it explicitly and update your code to use this new feature. (Contributed by Ezio Melotti in bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633}.)

The `strict' argument of @ref{87b,,HTMLParser} is now deprecated.
(Contributed by Ezio Melotti in bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}.)

@node http<3>,idlelib e IDLE<4>,html,Módulos melhorados<10>
@anchor{whatsnew/3 4 http}@anchor{f82}
@subsubsection http


@ref{f83,,send_error()} now accepts an
optional additional `explain' parameter which can be used to provide an
extended error description, overriding the hardcoded default if there is one.
This extended error description will be formatted using the
@ref{f84,,error_message_format} attribute
and sent as the body of the error response.
(Contributed by Karl Cow in bpo-12921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12921}.)

The @ref{72,,http.server} @ref{f85,,command line interface} now has
a @code{-b/--bind} option that causes the server to listen on a specific address.
(Contributed by Malte Swart in bpo-17764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17764}.)

@node idlelib e IDLE<4>,importlib<9>,http<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 idlelib-and-idle}@anchor{f86}
@subsubsection idlelib e IDLE


Since idlelib implements the IDLE shell and editor and is not intended for
import by other programs, it gets improvements with every release. See
@code{Lib/idlelib/NEWS.txt} for a cumulative list of changes since 3.3.0,
as well as changes made in future 3.4.x releases. This file is also available
from the IDLE Help ‣ About IDLE dialog.

@node importlib<9>,inspect<8>,idlelib e IDLE<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 importlib}@anchor{f87}
@subsubsection importlib


The @ref{f88,,InspectLoader} ABC defines a new method, @ref{e3d,,source_to_code()} that accepts source data and a path and returns a code object. The default implementation is equivalent to @code{compile(data, path, 'exec', dont_inherit=True)}. (Contributed by Eric Snow and Brett Cannon in bpo-15627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15627}.)

@ref{f88,,InspectLoader} also now has a default implementation for the @ref{f89,,get_code()} method. However, it will normally be desirable to override the default implementation for performance reasons. (Contributed by Brett Cannon in bpo-18072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18072}.)

The @ref{519,,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{513,,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{2fe,,cache_from_source()}
and @ref{51a,,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}.)

The @ref{77,,importlib} bootstrap @ref{f8a,,NamespaceLoader} now conforms to the @ref{f88,,InspectLoader} ABC, which means that @code{runpy} and @code{python -m} can now be used with namespace packages. (Contributed by Brett Cannon in bpo-18058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18058}.)

@ref{7d,,importlib.util} has a new function @ref{f8b,,decode_source()} that decodes source from bytes using universal newline processing. This is useful for implementing @ref{f8c,,InspectLoader.get_source()} methods.

@ref{cd0,,importlib.machinery.ExtensionFileLoader} now has a @ref{f8d,,get_filename()} method. This was inadvertently omitted in the original implementation. (Contributed by Eric Snow in bpo-19152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19152}.)

@node inspect<8>,ipaddress<5>,importlib<9>,Módulos melhorados<10>
@anchor{whatsnew/3 4 inspect}@anchor{f8e}
@subsubsection inspect


The @ref{7e,,inspect} module now offers a basic @ref{f8f,,command line interface} to quickly display source code and other information for modules, classes and functions. (Contributed by Claudiu Popa and Nick Coghlan in bpo-18626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18626}.)

@ref{f90,,unwrap()} makes it easy to unravel wrapper function chains created by @ref{f91,,functools.wraps()} (and any other API that sets the @code{__wrapped__} attribute on a wrapper function). (Contributed by Daniel Urban, Aaron Iles and Nick Coghlan in bpo-13266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13266}.)

As part of the implementation of the new @ref{56,,enum} module, the @ref{7e,,inspect} module now has substantially better support for custom @code{__dir__} methods and dynamic class attributes provided through metaclasses. (Contributed by Ethan Furman in bpo-18929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18929} and bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030}.)

@ref{739,,getfullargspec()} and @code{getargspec()}
now use the @ref{738,,signature()} API. This allows them to
support a much broader range of callables, including those with
@code{__signature__} attributes, those with metadata provided by argument
clinic, @ref{414,,functools.partial()} objects and more. Note that, unlike
@ref{738,,signature()}, these functions still ignore @code{__wrapped__}
attributes, and report the already bound first argument for bound methods,
so it is still necessary to update your code to use
@ref{738,,signature()} directly if those features are desired.
(Contributed by Yury Selivanov in bpo-17481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17481}.)

@ref{738,,signature()} now supports duck types of CPython functions, which adds support for functions compiled with Cython. (Contributed by Stefan Behnel and Yury Selivanov in bpo-17159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17159}.)

@node ipaddress<5>,logging<6>,inspect<8>,Módulos melhorados<10>
@anchor{whatsnew/3 4 ipaddress}@anchor{f92}
@subsubsection ipaddress


@ref{80,,ipaddress} was added to the standard library in Python 3.3 as a
@ref{b16,,provisional API}. With the release of Python 3.4, this qualification
has been removed: @ref{80,,ipaddress} is now considered a stable API, covered
by the normal standard library requirements to maintain backwards
compatibility.

A new @ref{f93,,is_global} property is @code{True} if an address is globally routeable. (Contributed by Peter Moody in bpo-17400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17400}.)

@node logging<6>,marshal<2>,ipaddress<5>,Módulos melhorados<10>
@anchor{whatsnew/3 4 logging}@anchor{f94}
@subsubsection logging


The @ref{f95,,TimedRotatingFileHandler} has a new `atTime' parameter that can be used to specify the time of day when rollover should happen. (Contributed by Ronald Oussoren in bpo-9556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9556}.)

@ref{f96,,SocketHandler} and @ref{f97,,DatagramHandler} now support Unix domain sockets (by setting `port' to @code{None}). (Contributed by Vinay Sajip in commit ce46195b56a9.)

@ref{b66,,fileConfig()} now accepts a @ref{f98,,configparser.RawConfigParser} subclass instance for the `fname' parameter. This facilitates using a configuration file when logging configuration is just a part of the overall application configuration, or where the application modifies the configuration before passing it to @ref{b66,,fileConfig()}. (Contributed by Vinay Sajip in bpo-16110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16110}.)

Logging configuration data received from a socket via the @ref{f99,,logging.config.listen()} function can now be validated before being processed by supplying a verification function as the argument to the new `verify' keyword argument. (Contributed by Vinay Sajip in bpo-15452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15452}.)

@node marshal<2>,mmap<3>,logging<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 marshal}@anchor{f9a}@anchor{whatsnew/3 4 whatsnew-marshal-3}@anchor{f0c}
@subsubsection marshal


The default @ref{8d,,marshal} version has been bumped to 3. The code implementing the new version restores the Python2 behavior of recording only one copy of interned strings and preserving the interning on deserialization, and extends this “one copy” ability to any object type (including handling recursive references). This reduces both the size of @code{.pyc} files and the amount of memory a module occupies in memory when it is loaded from a @code{.pyc} (or @code{.pyo}) file. (Contributed by Kristján Valur Jónsson in bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475}, with additional speedups by Antoine Pitrou in bpo-19219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19219}.)

@node mmap<3>,multiprocessing<7>,marshal<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 mmap}@anchor{f9b}
@subsubsection mmap


mmap objects are now @ref{f3c,,weakly referenceable}.
(Contributed by Valerie Lambert in bpo-4885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4885}.)

@node multiprocessing<7>,operador<3>,mmap<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 multiprocessing}@anchor{f9c}
@subsubsection multiprocessing

@anchor{whatsnew/3 4 whatsnew-multiprocessing-no-fork}@anchor{f16}
On Unix two new @ref{2c8,,start methods}, @code{spawn} and @code{forkserver}, have been added for starting processes using @ref{94,,multiprocessing}. These make the mixing of processes with threads more robust, and the @code{spawn} method matches the semantics that multiprocessing has always used on Windows. New function @ref{f9d,,get_all_start_methods()} reports all start methods available on the platform, @ref{f9e,,get_start_method()} reports the current start method, and @ref{2c7,,set_start_method()} sets the start method. (Contributed by Richard Oudkerk in bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}.)

@ref{94,,multiprocessing} also now has the concept of a @code{context}, which determines how child processes are created. New function @ref{2c6,,get_context()} returns a context that uses a specified start method. It has the same API as the @ref{94,,multiprocessing} module itself, so you can use it to create @ref{f9f,,Pool}s and other objects that will operate within that context. This allows a framework and an application or different parts of the same application to use multiprocessing without interfering with each other. (Contributed by Richard Oudkerk in bpo-18999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18999}.)

Except when using the old `fork' start method, child processes no longer
inherit unneeded handles/file descriptors from their parents (part of
bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713}).

@ref{94,,multiprocessing} now relies on @ref{be,,runpy} (which implements the @code{-m} switch) to initialise @code{__main__} appropriately in child processes when using the @code{spawn} or @code{forkserver} start methods. This resolves some edge cases where combining multiprocessing, the @code{-m} command line switch, and explicit relative imports could cause obscure failures in child processes. (Contributed by Nick Coghlan in bpo-19946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19946}.)

@node operador<3>,os<11>,multiprocessing<7>,Módulos melhorados<10>
@anchor{whatsnew/3 4 operator}@anchor{fa0}
@subsubsection operador


New function @ref{fa1,,length_hint()} provides an implementation of the specification for how the @ref{f3d,,__length_hint__()} special method should be used, as part of the 
@geindex Propostas de Melhorias do Python; PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/} formal specification of this language feature. (Contributed by Armin Ronacher in bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)

There is now a pure-python version of the @ref{9f,,operator} module available for reference and for use by alternate implementations of Python. (Contributed by Zachary Ware in bpo-16694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16694}.)

@node os<11>,pdb<6>,operador<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 os}@anchor{fa2}
@subsubsection os


There are new functions to get and set the @ref{f2b,,inheritable flag} of a file descriptor (@ref{f2c,,os.get_inheritable()},
@ref{f2d,,os.set_inheritable()}) or a Windows handle
(@ref{f2e,,os.get_handle_inheritable()}, @ref{f2f,,os.set_handle_inheritable()}).

New function @ref{1c5,,cpu_count()} reports the number of CPUs available on the platform on which Python is running (or @code{None} if the count can’t be determined). The @ref{fa3,,multiprocessing.cpu_count()} function is now implemented in terms of this function). (Contributed by Trent Nelson, Yogesh Chaudhari, Victor Stinner, and Charles-François Natali in bpo-17914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17914}.)

@ref{fa4,,os.path.samestat()} is now available on the Windows platform (and the @ref{fa5,,os.path.samefile()} implementation is now shared between Unix and Windows). (Contributed by Brian Curtin in bpo-11939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11939}.)

@ref{a1c,,os.path.ismount()} now recognizes volumes mounted below a drive root on Windows. (Contributed by Tim Golden in bpo-9035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9035}.)

@ref{dba,,os.open()} supports two new flags on platforms that provide them,
@ref{fa6,,O_PATH} (un-opened file descriptor), and @ref{fa7,,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>,pickle<4>,os<11>,Módulos melhorados<10>
@anchor{whatsnew/3 4 pdb}@anchor{fa8}
@subsubsection pdb


@ref{a5,,pdb} has been enhanced to handle generators, @ref{9d5,,yield}, and @code{yield from} in a more useful fashion. This is especially helpful when debugging @ref{a,,asyncio} based programs. (Contributed by Andrew Svetlov and Xavier de Gaye in bpo-16596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16596}.)

The @code{print} command has been removed from @ref{a5,,pdb}, restoring access to the Python @ref{fa9,,print()} function from the pdb command line. Python2’s @code{pdb} did not have a @code{print} command; instead, entering @code{print} executed the @code{print} statement. In Python3 @code{print} was mistakenly made an alias for the pdb @ref{faa,,p} command. @code{p}, however, prints the @code{repr} of its argument, not the @code{str} like the Python2 @code{print} command did. Worse, the Python3 @code{pdb print} command shadowed the Python3 @code{print} function, making it inaccessible at the @code{pdb} prompt. (Contributed by Connor Osborn in bpo-18764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18764}.)

@node pickle<4>,plistlib<2>,pdb<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 pickle}@anchor{fab}@anchor{whatsnew/3 4 whatsnew-protocol-4}@anchor{f15}
@subsubsection pickle


@ref{a6,,pickle} now supports (but does not use by default) a new pickle protocol,
protocol 4.  This new protocol addresses a number of issues that were present
in previous protocols, such as the serialization of nested classes, very large
strings and containers, and classes whose @ref{580,,__new__()} method takes
keyword-only arguments.  It also provides some efficiency improvements.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3154

@item PEP 3154@footnote{https://peps.python.org/pep-3154/} – Pickle protocol 4

PEP written by Antoine Pitrou and implemented by Alexandre Vassalotti.
@end table


@node plistlib<2>,poplib<3>,pickle<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 plistlib}@anchor{fac}
@subsubsection plistlib


@ref{ab,,plistlib} now has an API that is similar to the standard pattern for
stdlib serialization protocols, with new @ref{956,,load()},
@ref{958,,dump()}, @ref{957,,loads()}, and @ref{959,,dumps()}
functions.  (The older API is now deprecated.)  In addition to the already
supported XML plist format (@ref{fad,,FMT_XML}), it also now supports
the binary plist format (@ref{fae,,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 melhorados<10>
@anchor{whatsnew/3 4 poplib}@anchor{faf}
@subsubsection poplib


Two new methods have been added to @ref{ac,,poplib}: @ref{fb0,,capa()}, which returns the list of capabilities advertised by the POP server, and @ref{fb1,,stls()}, which switches a clear-text POP3 session into an encrypted POP3 session if the POP server supports it. (Contributed by Lorenzo Catucci in bpo-4473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4473}.)

@node pprint<4>,pty,poplib<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 pprint}@anchor{fb2}
@subsubsection pprint


The @ref{ae,,pprint} module’s @ref{fb3,,PrettyPrinter} class and its @ref{fb4,,pformat()}, and @ref{82b,,pprint()} functions have a new option, `compact', that controls how the output is formatted. Currently setting `compact' to @code{True} means that sequences will be printed with as many sequence elements as will fit within `width' on each (indented) line. (Contributed by Serhiy Storchaka in bpo-19132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19132}.)

Long strings are now wrapped using Python’s normal line continuation syntax. (Contributed by Antoine Pitrou in bpo-17150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17150}.)

@node pty,pydoc<4>,pprint<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 pty}@anchor{fb5}
@subsubsection pty


@ref{fb6,,pty.spawn()} now returns the status value from @ref{dc2,,os.waitpid()} on the child process, instead of @code{None}. (Contributed by Gregory P. Smith.)

@node pydoc<4>,re<8>,pty,Módulos melhorados<10>
@anchor{whatsnew/3 4 pydoc}@anchor{fb7}
@subsubsection pydoc


The @ref{b5,,pydoc} module is now based directly on the @ref{738,,inspect.signature()}
introspection API, allowing it to provide signature information for a wider
variety of callable objects. This change also means that @code{__wrapped__}
attributes are now taken into account when displaying help information.
(Contributed by Larry Hastings in bpo-19674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19674}.)

The @ref{b5,,pydoc} module no longer displays the @code{self} parameter for already bound methods. Instead, it aims to always display the exact current signature of the supplied callable. (Contributed by Larry Hastings in bpo-20710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20710}.)

In addition to the changes that have been made to @ref{b5,,pydoc} directly,
its handling of custom @code{__dir__} methods and various descriptor
behaviours has also been improved substantially by the underlying changes in
the @ref{7e,,inspect} module.

As the @ref{8dd,,help()} builtin is based on @ref{b5,,pydoc}, the above changes also
affect the behaviour of @ref{8dd,,help()}.

@node re<8>,resource,pydoc<4>,Módulos melhorados<10>
@anchor{whatsnew/3 4 re}@anchor{fb8}
@subsubsection re


New @ref{fb9,,fullmatch()} function and @ref{fba,,Pattern.fullmatch()} method anchor
the pattern at both ends of the string to match.  This provides a way to be
explicit about the goal of the match, which avoids a class of subtle bugs where
@code{$} characters get lost during code changes or the addition of alternatives
to an existing regular expression.  (Contributed by Matthew Barnett in
bpo-16203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16203}.)

The repr of @ref{fbb,,regex objects} now includes the pattern and the flags; the repr of @ref{fbc,,match objects} now includes the start, end, and the part of the string that matched. (Contributed by Hugo Lopes Tavares and Serhiy Storchaka in bpo-13592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13592} and bpo-17087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17087}.)

@node resource,select,re<8>,Módulos melhorados<10>
@anchor{whatsnew/3 4 resource}@anchor{fbd}
@subsubsection resource


New @ref{fbe,,prlimit()} function, available on Linux platforms with a kernel version of 2.6.36 or later and glibc of 2.13 or later, provides the ability to query or set the resource limits for processes other than the one making the call. (Contributed by Christian Heimes in 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{fbf,,RLIMIT_MSGQUEUE},
@ref{fc0,,RLIMIT_NICE}, @ref{fc1,,RLIMIT_RTPRIO},
@ref{fc2,,RLIMIT_RTTIME}, and @ref{fc3,,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{fc4,,RLIMIT_SBSIZE}, @ref{fc5,,RLIMIT_SWAP}, and
@ref{fc6,,RLIMIT_NPTS}.  (Contributed by Claudiu Popa in
bpo-19343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19343}.)

@node select,shelve<2>,resource,Módulos melhorados<10>
@anchor{whatsnew/3 4 select}@anchor{fc7}
@subsubsection select


@ref{fc8,,epoll} objects now support the context management protocol. When used in a @ref{5d2,,with} statement, the @ref{fc9,,close()} method will be called automatically at the end of the block. (Contributed by Serhiy Storchaka in bpo-16488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16488}.)

@ref{fca,,devpoll} objects now have @ref{fcb,,fileno()} and @ref{fcc,,close()} methods, as well as a new attribute @ref{fcd,,closed}. (Contributed by Victor Stinner in bpo-18794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18794}.)

@node shelve<2>,shutil<6>,select,Módulos melhorados<10>
@anchor{whatsnew/3 4 shelve}@anchor{fce}
@subsubsection shelve


@ref{fcf,,Shelf} instances may now be used in @ref{5d2,,with} statements,
and will be automatically closed at the end of the @code{with} block.
(Contributed by Filip Gruszczyński in bpo-13896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13896}.)

@node shutil<6>,smtpd<3>,shelve<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 shutil}@anchor{fd0}
@subsubsection shutil


@ref{a63,,copyfile()} now raises a specific @ref{fd1,,Error} subclass, @ref{fd2,,SameFileError}, when the source and destination are the same file, which allows an application to take appropriate action on this specific error. (Contributed by Atsuo Ishimoto and Hynek Schlawack in bpo-1492704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1492704}.)

@node smtpd<3>,smtplib<3>,shutil<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 smtpd}@anchor{fd3}
@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>,socket<9>,smtpd<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 smtplib}@anchor{fd4}
@subsubsection smtplib


@ref{fd5,,SMTPException} is now a subclass of @ref{417,,OSError}, which allows
both socket level errors and SMTP protocol level errors to be caught in one
try/except statement by code that only cares whether or not an error occurred.
(Contributed by Ned Jackson Lovely in bpo-2118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2118}.)

@node socket<9>,sqlite3<9>,smtplib<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 socket}@anchor{fd6}
@subsubsection socket


The socket module now supports the @ref{fd7,,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}.)

Socket objects have new methods to get or set their @ref{f2b,,inheritable flag}, @ref{f30,,get_inheritable()} and
@ref{f31,,set_inheritable()}.

The @code{socket.AF_*} and @code{socket.SOCK_*} constants are now enumeration values using the new @ref{56,,enum} module. This allows meaningful names to be printed during debugging, instead of integer “magic numbers”.

The @ref{fd8,,AF_LINK} constant is now available on BSD and OSX.

@ref{969,,inet_pton()} and @ref{fd9,,inet_ntop()} are now supported on Windows. (Contributed by Atsuo Ishimoto in bpo-7171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7171}.)

@node sqlite3<9>,ssl<10>,socket<9>,Módulos melhorados<10>
@anchor{whatsnew/3 4 sqlite3}@anchor{fda}
@subsubsection sqlite3


A new boolean parameter to the @ref{2a8,,connect()} function, `uri', can be used to indicate that the `database' parameter is a @code{uri} (see the SQLite URI documentation@footnote{https://www.sqlite.org/uri.html}). (Contributed by poq in bpo-13773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13773}.)

@node ssl<10>,stat,sqlite3<9>,Módulos melhorados<10>
@anchor{whatsnew/3 4 ssl}@anchor{fdb}
@subsubsection ssl

@anchor{whatsnew/3 4 whatsnew-tls-11-12}@anchor{f19}
@ref{fdc,,PROTOCOL_TLSv1_1} and @ref{fdd,,PROTOCOL_TLSv1_2} (TLSv1.1 and TLSv1.2 support) have been added; support for these protocols is only available if Python is linked with OpenSSL 1.0.1 or later. (Contributed by Michele Orrù and Antoine Pitrou in bpo-16692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16692}.)
@anchor{whatsnew/3 4 whatsnew34-sslcontext}@anchor{f1c}
New function @ref{155,,create_default_context()} provides a standard way to obtain an @ref{294,,SSLContext} whose settings are intended to be a reasonable balance between compatibility and security. These settings are more stringent than the defaults provided by the @ref{294,,SSLContext} constructor, and may be adjusted in the future, without prior deprecation, if best-practice security requirements change. The new recommended best practice for using stdlib libraries that support SSL is to use @ref{155,,create_default_context()} to obtain an @ref{294,,SSLContext} object, modify it if needed, and then pass it as the `context' argument of the appropriate stdlib API. (Contributed by Christian Heimes in bpo-19689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19689}.)

@ref{294,,SSLContext} method @ref{f1d,,load_verify_locations()}
accepts a new optional argument `cadata', which can be used to provide PEM or
DER encoded certificates directly via strings or bytes, respectively.
(Contributed by Christian Heimes in bpo-18138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18138}.)

New function @ref{fde,,get_default_verify_paths()} returns a named tuple of the paths and environment variables that the @ref{fdf,,set_default_verify_paths()} method uses to set OpenSSL’s default @code{cafile} and @code{capath}. This can be an aid in debugging default verification issues. (Contributed by Christian Heimes in bpo-18143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18143}.)

@ref{294,,SSLContext} has a new method, @ref{fe0,,cert_store_stats()}, that reports the number of loaded @code{X.509} certs, @code{X.509 CA} certs, and certificate revocation lists (@code{crl}s), as well as a @ref{fe1,,get_ca_certs()} method that returns a list of the loaded @code{CA} certificates. (Contributed by Christian Heimes in bpo-18147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18147}.)

If OpenSSL 0.9.8 or later is available, @ref{294,,SSLContext} has a new
attribute @ref{fe2,,verify_flags} that can be used to control the
certificate verification process by setting it to some combination of the new
constants @ref{fe3,,VERIFY_DEFAULT}, @ref{fe4,,VERIFY_CRL_CHECK_LEAF},
@ref{fe5,,VERIFY_CRL_CHECK_CHAIN}, or @ref{157,,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}.)

New @ref{294,,SSLContext} method @ref{fe6,,load_default_certs()} loads a set of default “certificate authority” (CA) certificates from default locations, which vary according to the platform. It can be used to load both TLS web server authentication certificates (@code{purpose=}@ref{fe7,,SERVER_AUTH}) for a client to use to verify a server, and certificates for a server to use in verifying client certificates (@code{purpose=}@ref{fe8,,CLIENT_AUTH}). (Contributed by Christian Heimes in bpo-19292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19292}.)
@anchor{whatsnew/3 4 whatsnew34-win-cert-store}@anchor{f1a}
Two new windows-only functions, @ref{fe9,,enum_certificates()} and @ref{fea,,enum_crls()} provide the ability to retrieve certificates, certificate information, and CRLs from the Windows cert store. (Contributed by Christian Heimes in bpo-17134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17134}.)
@anchor{whatsnew/3 4 whatsnew34-sni}@anchor{f1b}
Support for server-side SNI (Server Name Indication) using the new
@ref{feb,,ssl.SSLContext.set_servername_callback()} method.
(Contributed by Daniel Black in bpo-8109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8109}.)

The dictionary returned by @ref{fec,,SSLSocket.getpeercert()} contains additional @code{X509v3} extension items: @code{crlDistributionPoints}, @code{calIssuers}, and @code{OCSP} URIs. (Contributed by Christian Heimes in bpo-18379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18379}.)

@node stat,struct<2>,ssl<10>,Módulos melhorados<10>
@anchor{whatsnew/3 4 stat}@anchor{fed}
@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{fee,,ST_MODE} flags, @ref{fef,,S_IFDOOR},
@ref{ff0,,S_IFPORT}, and @ref{ff1,,S_IFWHT}.  (Contributed by
Christian Hiemes in bpo-11016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11016}.)

@node struct<2>,subprocess<5>,stat,Módulos melhorados<10>
@anchor{whatsnew/3 4 struct}@anchor{ff2}
@subsubsection struct


New function @ref{ff3,,iter_unpack} and a new
@ref{ff4,,struct.Struct.iter_unpack()} method on compiled formats provide streamed
unpacking of a buffer containing repeated instances of a given format of data.
(Contributed by Antoine Pitrou in bpo-17804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17804}.)

@node subprocess<5>,sunau<2>,struct<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 subprocess}@anchor{ff5}
@subsubsection subprocess


@ref{ff6,,check_output()} now accepts an `input' argument that can
be used to provide the contents of @code{stdin} for the command that is run.
(Contributed by Zack Weinberg in bpo-16624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16624}.)

@ref{ff7,,getoutput()} and @ref{ff8,,getstatusoutput()} now
work on Windows.  This change was actually inadvertently made in 3.3.4.
(Contributed by Tim Golden in bpo-10197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10197}.)

@node sunau<2>,sys<12>,subprocess<5>,Módulos melhorados<10>
@anchor{whatsnew/3 4 sunau}@anchor{ff9}
@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{5d2,,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()} now supports 24 bit samples, thus adding
support for writing 24 sample using the module.  (Contributed by
Serhiy Storchaka in bpo-19261@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19261}.)

The @code{writeframesraw()} and
@code{writeframes()} methods now accept any @ref{d4f,,bytes-like object}.  (Contributed by Serhiy Storchaka in bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node sys<12>,tarfile<8>,sunau<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 sys}@anchor{ffa}
@subsubsection sys


New function @ref{ffb,,sys.getallocatedblocks()} returns the current number of blocks allocated by the interpreter. (In CPython with the default @code{--with-pymalloc} setting, this is allocations made through the @ref{c83,,PyObject_Malloc()} API.) This can be useful for tracking memory leaks, especially if automated via a test suite. (Contributed by Antoine Pitrou in bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390}.)

When the Python interpreter starts in @ref{ffc,,interactive mode}, it checks for an @ref{ffd,,__interactivehook__} attribute on the @ref{d9,,sys} module. If the attribute exists, its value is called with no arguments just before interactive mode is started. The check is made after the 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} file is read, so it can be set there. The @ref{c7,,site} module @ref{fff,,sets it} to a function that enables tab completion and history saving (in @code{~/.python-history}) if the platform supports @ref{ba,,readline}. If you do not want this (new) behavior, you can override it in 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP}, @ref{c8,,sitecustomize}, or @ref{10e,,usercustomize} by deleting this attribute from @ref{d9,,sys} (or setting it to some other callable). (Contributed by Éric Araujo and Antoine Pitrou in bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845}.)

@node tarfile<8>,textwrap,sys<12>,Módulos melhorados<10>
@anchor{whatsnew/3 4 tarfile}@anchor{1000}
@subsubsection tarfile


The @ref{de,,tarfile} module now supports a simple @ref{1001,,Interface de linha de comando} when called as a script directly or via @code{-m}. This can be used to create and extract tarfile archives. (Contributed by Berker Peksag in bpo-13477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13477}.)

@node textwrap,threading<7>,tarfile<8>,Módulos melhorados<10>
@anchor{whatsnew/3 4 textwrap}@anchor{1002}
@subsubsection textwrap


The @ref{1003,,TextWrapper} class has two new attributes/constructor arguments: @ref{1004,,max_lines}, which limits the number of lines in the output, and @ref{1005,,placeholder}, which is a string that will appear at the end of the output if it has been truncated because of `max_lines'. Building on these capabilities, a new convenience function @ref{1006,,shorten()} collapses all of the whitespace in the input to single spaces and produces a single line of a given `width' that ends with the `placeholder' (by default, @code{[...]}). (Contributed by Antoine Pitrou and Serhiy Storchaka in bpo-18585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18585} and bpo-18725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18725}.)

@node threading<7>,traceback<6>,textwrap,Módulos melhorados<10>
@anchor{whatsnew/3 4 threading}@anchor{1007}
@subsubsection threading


The @ref{953,,Thread} object representing the main thread can be obtained from the new @ref{1008,,main_thread()} function. In normal conditions this will be the thread from which the Python interpreter was started. (Contributed by Andrew Svetlov in bpo-18882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18882}.)

@node traceback<6>,types<6>,threading<7>,Módulos melhorados<10>
@anchor{whatsnew/3 4 traceback}@anchor{1009}
@subsubsection traceback


A new @ref{100a,,traceback.clear_frames()} function takes a traceback object and clears the local variables in all of the frames it references, reducing the amount of memory consumed. (Contributed by Andrew Kuchling in bpo-1565525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1565525}.)

@node types<6>,urllib<3>,traceback<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 types}@anchor{100b}
@subsubsection types


A new @ref{62a,,DynamicClassAttribute()} descriptor provides a way to define
an attribute that acts normally when looked up through an instance object, but
which is routed to the `class' @code{__getattr__} when looked up through the
class.  This allows one to have properties active on a class, and have virtual
attributes on the class with the same name (see @ref{56,,enum} for an example).
(Contributed by Ethan Furman in bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030}.)

@node urllib<3>,unittest<9>,types<6>,Módulos melhorados<10>
@anchor{whatsnew/3 4 urllib}@anchor{100c}
@subsubsection urllib


@ref{10b,,urllib.request} now supports @code{data:} URLs via the @ref{100d,,DataHandler} class. (Contributed by Mathias Panzenböck in bpo-16423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16423}.)

The http method that will be used by a @ref{100e,,Request} class can now be specified by setting a @ref{100f,,method} class attribute on the subclass. (Contributed by Jason R Coombs in bpo-18978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18978}.)

@ref{100e,,Request} objects are now reusable: if the @ref{1010,,full_url} or @ref{1011,,data} attributes are modified, all relevant internal properties are updated. This means, for example, that it is now possible to use the same @ref{100e,,Request} object in more than one @ref{1012,,OpenerDirector.open()} call with different `data' arguments, or to modify a @ref{100e,,Request}‘s @code{url} rather than recomputing it from scratch. There is also a new @ref{1013,,remove_header()} method that can be used to remove headers from a @ref{100e,,Request}. (Contributed by Alexey Kachayev in bpo-16464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16464}, Daniel Wozniak in bpo-17485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17485}, and Damien Brecht and Senthil Kumaran in bpo-17272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17272}.)

@ref{1014,,HTTPError} objects now have a @ref{1015,,headers} attribute that provides access to the HTTP response headers associated with the error. (Contributed by Berker Peksag in bpo-15701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15701}.)

@node unittest<9>,venv<7>,urllib<3>,Módulos melhorados<10>
@anchor{whatsnew/3 4 unittest}@anchor{1016}
@subsubsection unittest


The @ref{44f,,TestCase} class has a new method,
@ref{1017,,subTest()}, that produces a context manager whose
@ref{5d2,,with} block becomes a “sub-test”.  This context manager allows a test
method to dynamically generate subtests  by, say, calling the @code{subTest}
context manager inside a loop.  A single test method can thereby produce an
indefinite number of separately identified and separately counted tests, all of
which will run even if one or more of them fail.  For example:

@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

will result in six subtests, each identified in the unittest verbose output with a label consisting of the variable name @code{i} and a particular value for that variable (@code{i=0}, @code{i=1}, etc). See @ref{1018,,Distinguindo iterações de teste utilizando subtestes} for the full version of this example. (Contributed by Antoine Pitrou in bpo-16997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16997}.)

@ref{1019,,unittest.main()} now accepts an iterable of test names for `defaultTest', where previously it only accepted a single test name as a string. (Contributed by Jyrki Pulliainen in bpo-15132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15132}.)

If @ref{101a,,SkipTest} is raised during test discovery (that is, at the module level in the test file), it is now reported as a skip instead of an error. (Contributed by Zach Ware in bpo-16935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16935}.)

@ref{101b,,discover()} now sorts the discovered files to provide consistent test ordering. (Contributed by Martin Melin and Jeff Ramnani in bpo-16709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16709}.)

@ref{e20,,TestSuite} now drops references to tests as soon as the test has been run, if the test is successful. On Python interpreters that do garbage collection, this allows the tests to be garbage collected if nothing else is holding a reference to the test. It is possible to override this behavior by creating a @ref{e20,,TestSuite} subclass that defines a custom @code{_removeTestAtIndex} method. (Contributed by Tom Wardill, Matt McClure, and Andrew Svetlov in bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798}.)

A new test assertion context-manager, @ref{85c,,assertLogs()}, will ensure that a given block of code emits a log message using the @ref{87,,logging} module. By default the message can come from any logger and have a priority of @code{INFO} or higher, but both the logger name and an alternative minimum logging level may be specified. The object returned by the context manager can be queried for the @ref{101c,,LogRecord}s and/or formatted messages that were logged. (Contributed by Antoine Pitrou in bpo-18937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18937}.)

Test discovery now works with namespace packages (Contributed by Claudiu Popa
in bpo-17457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17457}.)

@ref{107,,unittest.mock} objects now inspect their specification signatures when matching calls, which means an argument can now be matched by either position or name, instead of only by position. (Contributed by Antoine Pitrou in bpo-17015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17015}.)

@ref{101d,,mock_open()} objects now have @code{readline} and @code{readlines}
methods.  (Contributed by Toshio Kuratomi in bpo-17467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17467}.)

@node venv<7>,wave<2>,unittest<9>,Módulos melhorados<10>
@anchor{whatsnew/3 4 venv}@anchor{101e}
@subsubsection venv


@ref{111,,venv} now includes activation scripts for the @code{csh} and @code{fish} shells. (Contributed by Andrew Svetlov in bpo-15417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15417}.)

@ref{26a,,EnvBuilder} and the @ref{26b,,create()} convenience function take a new keyword argument `with_pip', which defaults to @code{False}, that controls whether or not @ref{26a,,EnvBuilder} ensures that @code{pip} is installed in the virtual environment. (Contributed by Nick Coghlan in bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} as part of the 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} implementation.)

@node wave<2>,weakref<2>,venv<7>,Módulos melhorados<10>
@anchor{whatsnew/3 4 wave}@anchor{101f}
@subsubsection wave


The @ref{1020,,getparams()} method now returns a namedtuple rather
than a plain tuple.  (Contributed by Claudiu Popa in bpo-17487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17487}.)

@ref{952,,wave.open()} now supports the context management protocol. (Contributed by Claudiu Popa in bpo-17616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17616}.)

@ref{113,,wave} can now @ref{1021,,write output to unseekable files}. (Contributed by David Jones, Guilherme Polo, and Serhiy Storchaka in bpo-5202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5202}.)

The @ref{1022,,writeframesraw()} and @ref{1023,,writeframes()} methods now accept any @ref{d4f,,bytes-like object}. (Contributed by Serhiy Storchaka in bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311}.)

@node weakref<2>,xml etree<2>,wave<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 weakref}@anchor{1024}
@subsubsection weakref


New @ref{1025,,WeakMethod} class simulates weak references to bound methods. (Contributed by Antoine Pitrou in bpo-14631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14631}.)

New @ref{a86,,finalize} class makes it possible to register a callback to be invoked when an object is garbage collected, without needing to carefully manage the lifecycle of the weak reference itself. (Contributed by Richard Oudkerk in bpo-15528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15528}.)

The callback, if any, associated with a @ref{1026,,ref} is now exposed via the @ref{1027,,__callback__} attribute. (Contributed by Mark Dickinson in bpo-17643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17643}.)

@node xml etree<2>,zipfile<5>,weakref<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 xml-etree}@anchor{1028}
@subsubsection xml.etree


A new parser, @ref{1029,,XMLPullParser}, allows a non-blocking applications to parse XML documents. An example can be seen at @ref{102a,,A API de pull para análise sem bloqueio}. (Contributed by Antoine Pitrou in bpo-17741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17741}.)

The @ref{125,,xml.etree.ElementTree} @ref{102b,,tostring()} and @ref{102c,,tostringlist()} functions, and the @ref{955,,ElementTree} @ref{aa4,,write()} method, now have a `short_empty_elements' @ref{2a5,,keyword-only parameter} providing control over whether elements with no content are written in abbreviated (@code{<tag />}) or expanded (@code{<tag></tag>}) form. (Contributed by Ariel Poliak and Serhiy Storchaka in bpo-14377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14377}.)

@node zipfile<5>,,xml etree<2>,Módulos melhorados<10>
@anchor{whatsnew/3 4 zipfile}@anchor{102d}
@subsubsection zipfile


The @ref{102e,,writepy()} method of the @ref{102f,,PyZipFile} class has a new `filterfunc' option that can be used to control which directories and files are added to the archive. For example, this could be used to exclude test files from the archive. (Contributed by Christian Tismer in bpo-19274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19274}.)

The `allowZip64' parameter to @ref{6c4,,ZipFile} and
@ref{102f,,PyZipFile} is now @code{True} by default.  (Contributed by
William Mallard in bpo-17201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17201}.)

@node CPython Implementation Changes,Descontinuados<11>,Módulos melhorados<10>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 cpython-implementation-changes}@anchor{1030}
@subsection CPython Implementation Changes


@menu
* PEP 445; Customization of CPython Memory Allocators: PEP 445 Customization of CPython Memory Allocators. 
* PEP 442; Safe Object Finalization: PEP 442 Safe Object Finalization. 
* PEP 456; Secure and Interchangeable Hash Algorithm: PEP 456 Secure and Interchangeable Hash Algorithm. 
* PEP 436; Argument Clinic: PEP 436 Argument Clinic. 
* Other Alterações a compilações e API C:: 
* Other Improvements: Other Improvements<2>. 
* Otimizações Relevantes:: 

@end menu

@node PEP 445 Customization of CPython Memory Allocators,PEP 442 Safe Object Finalization,,CPython Implementation Changes
@anchor{whatsnew/3 4 pep-445-customization-of-cpython-memory-allocators}@anchor{1031}@anchor{whatsnew/3 4 whatsnew-pep-445}@anchor{f1f}
@subsubsection PEP 445: Customization of CPython Memory Allocators


@geindex Propostas de Melhorias do Python; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/} adds new C level interfaces to customize memory allocation in
the CPython interpreter.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 445

@item PEP 445@footnote{https://peps.python.org/pep-0445/} – Add new APIs to customize Python memory allocators

PEP escrito e implementado por Victor Stinner.
@end table


@node PEP 442 Safe Object Finalization,PEP 456 Secure and Interchangeable Hash Algorithm,PEP 445 Customization of CPython Memory Allocators,CPython Implementation Changes
@anchor{whatsnew/3 4 pep-442-safe-object-finalization}@anchor{1032}@anchor{whatsnew/3 4 whatsnew-pep-442}@anchor{f1e}
@subsubsection PEP 442: Safe Object Finalization


@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} removes the current limitations and quirks of object finalization
in CPython. With it, objects with @ref{1033,,__del__()} methods, as well as
generators with @ref{9d2,,finally} clauses, can be finalized when they are
part of a reference cycle.

As part of this change, module globals are no longer forcibly set to @ref{675,,None} during interpreter shutdown in most cases, instead relying on the normal operation of the cyclic garbage collector. This avoids a whole class of interpreter-shutdown-time errors, usually involving @code{__del__} methods, that have plagued Python since the cyclic GC was first introduced.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 442

@item PEP 442@footnote{https://peps.python.org/pep-0442/} – Safe object finalization

PEP escrita e implementada por Antoine Pitrou.
@end table


@node PEP 456 Secure and Interchangeable Hash Algorithm,PEP 436 Argument Clinic,PEP 442 Safe Object Finalization,CPython Implementation Changes
@anchor{whatsnew/3 4 pep-456-secure-and-interchangeable-hash-algorithm}@anchor{1034}@anchor{whatsnew/3 4 whatsnew-pep-456}@anchor{f18}
@subsubsection PEP 456: Secure and Interchangeable Hash Algorithm


@geindex Propostas de Melhorias do Python; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} follows up on earlier security fix work done on Python’s hash algorithm to address certain DOS attacks to which public facing APIs backed by dictionary lookups may be subject. (See bpo-14621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14621} for the start of the current round of improvements.) The PEP unifies CPython’s hash code to make it easier for a packager to substitute a different hash algorithm, and switches Python’s default implementation to a SipHash implementation on platforms that have a 64 bit data type. Any performance differences in comparison with the older FNV algorithm are trivial.

The PEP adds additional fields to the @ref{1035,,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 Argument Clinic,Other Alterações a compilações e API C,PEP 456 Secure and Interchangeable Hash Algorithm,CPython Implementation Changes
@anchor{whatsnew/3 4 pep-436-argument-clinic}@anchor{1036}@anchor{whatsnew/3 4 whatsnew-pep-436}@anchor{f20}
@subsubsection PEP 436: Argument Clinic


“Argument Clinic” (
@geindex Propostas de Melhorias do Python; PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/}) is now part of the CPython build process
and can be used to simplify the process of defining and maintaining
accurate signatures for builtins and standard library extension modules
implemented in C.

Some standard library extension modules have been converted to use Argument
Clinic in Python 3.4, and @ref{b5,,pydoc} and @ref{7e,,inspect} have been updated
accordingly.

It is expected that signature metadata for programmatic introspection will
be added to additional callables implemented in C as part of Python 3.4
maintenance releases.

@cartouche
@quotation Nota 
The Argument Clinic PEP is not fully up to date with the state of the
implementation. This has been deemed acceptable by the release manager
and core development team in this case, as Argument Clinic will not
be made available as a public API for third party use in Python 3.4.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 436

@item PEP 436@footnote{https://peps.python.org/pep-0436/} – The Argument Clinic DSL

PEP written and implemented by Larry Hastings.
@end table


@node Other Alterações a compilações e API C,Other Improvements<2>,PEP 436 Argument Clinic,CPython Implementation Changes
@anchor{whatsnew/3 4 other-build-and-c-api-changes}@anchor{1037}
@subsubsection Other Alterações a compilações e API C



@itemize *

@item 
The new @ref{8a0,,PyType_GetSlot()} function has been added to the stable ABI, allowing retrieval of function pointers from named type slots when using the limited API. (Contributed by Martin von Löwis in 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 
Most Python C APIs that don’t mutate string arguments are now correctly marked as accepting @code{const char *} rather than @code{char *}. (Contributed by Serhiy Storchaka in bpo-1772673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772673}.)

@item 
A new shell version of @code{python-config} can be used even when a python
interpreter is not available (for example, in cross compilation scenarios).

@item 
@ref{38a,,PyUnicode_FromFormat()} now supports width and precision
specifications for @code{%s}, @code{%A}, @code{%U}, @code{%V}, @code{%S}, and @code{%R}.
(Contributed by Ysj Ray and Victor Stinner in bpo-7330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7330}.)

@item 
New function @ref{1038,,PyStructSequence_InitType2()} supplements the existing @ref{1039,,PyStructSequence_InitType()} function. The difference is that it returns @code{0} on success and @code{-1} on failure.

@item 
The CPython source can now be compiled using the address sanity checking features of recent versions of GCC and clang: the false alarms in the small object allocator have been silenced. (Contributed by Dhiru Kholia in bpo-18596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18596}.)

@item 
The Windows build now uses Address Space Layout Randomization@footnote{https://en.wikipedia.org/wiki/Address_space_layout_randomization} and Data Execution Prevention@footnote{https://en.wikipedia.org/wiki/Data_Execution_Prevention}. (Contributed by Christian Heimes in bpo-16632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16632}.)

@item 
New function @ref{103a,,PyObject_LengthHint()} is the C API equivalent of @ref{fa1,,operator.length_hint()}. (Contributed by Armin Ronacher in bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148}.)
@end itemize

@node Other Improvements<2>,Otimizações Relevantes,Other Alterações a compilações e API C,CPython Implementation Changes
@anchor{whatsnew/3 4 other-improvements}@anchor{103b}@anchor{whatsnew/3 4 other-improvements-3-4}@anchor{103c}
@subsubsection Other Improvements

@anchor{whatsnew/3 4 whatsnew-isolated-mode}@anchor{f09}

@itemize *

@item 
The @ref{103d,,python} command has a new @ref{103e,,option}, @code{-I}, which causes it to run in “isolated mode”,
which means that @ref{3b4,,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 
Tab-completion is now enabled by default in the interactive interpreter on systems that support @ref{ba,,readline}. History is also enabled by default, and is written to (and read from) the file @code{~/.python-history}. (Contributed by Antoine Pitrou and Éric Araujo in bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845}.)

@item 
Invoking the Python interpreter with @code{--version} now outputs the version to
standard output instead of standard error (bpo-18338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18338}). Similar changes
were made to @ref{6,,argparse} (bpo-18920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18920}) and other modules that have
script-like invocation capabilities (bpo-18922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18922}).

@item 
The CPython Windows installer now adds @code{.py} to the 
@geindex PATHEXT
@geindex variável de ambiente; PATHEXT
@code{PATHEXT} variable when extensions are registered, allowing users to run a python script at the windows command prompt by just typing its name without the @code{.py} extension. (Contributed by Paul Moore in 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{103f,,python regression test suite} now
also checks for memory allocation leaks, using
@ref{ffb,,sys.getallocatedblocks()}.  (Contributed by Antoine Pitrou in
bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390}.)

@item 
@code{python -m} now works with namespace packages.

@item 
The @ref{d1,,stat} module is now implemented in C, which means it gets the
values for its constants from the C header files, instead of having the
values hard-coded in the python module as was previously the case.

@item 
Loading multiple python modules from a single OS module (@code{.so}, @code{.dll}) now works correctly (previously it silently returned the first python module in the file). (Contributed by Václav Šmilauer in bpo-16421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16421}.)

@item 
A new opcode, @code{LOAD_CLASSDEREF}, has been added to fix a bug in the loading of free variables in class bodies that could be triggered by certain uses of @ref{c79,,__prepare__}. (Contributed by Benjamin Peterson in bpo-17853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17853}.)

@item 
A number of MemoryError-related crashes were identified and fixed by Victor
Stinner using his 
@geindex Propostas de Melhorias do Python; PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/}-based @code{pyfailmalloc} tool (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 
The @code{pyvenv} command now accepts a @code{--copies} option to use copies rather than symlinks even on systems where symlinks are the default. (Contributed by Vinay Sajip in bpo-18807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18807}.)

@item 
The @code{pyvenv} command also accepts a @code{--without-pip} option to suppress the otherwise-automatic bootstrapping of pip into the virtual environment. (Contributed by Nick Coghlan in bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} as part of the 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} implementation.)

@item 
The encoding name is now optional in the value set for the 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} environment variable. This makes it possible to set just the error handler, without changing the default encoding. (Contributed by Serhiy Storchaka in bpo-18818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18818}.)

@item 
The @ref{13,,bz2}, @ref{8a,,lzma}, and @ref{67,,gzip} module @code{open} functions now support @code{x} (exclusive creation) mode. (Contributed by Tim Heaney and Vajrasky Kok in bpo-19201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19201}, bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222}, and bpo-19223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19223}.)
@end itemize

@node Otimizações Relevantes,,Other Improvements<2>,CPython Implementation Changes
@anchor{whatsnew/3 4 significant-optimizations}@anchor{1041}
@subsubsection Otimizações Relevantes



@itemize *

@item 
The UTF-32 decoder is now 3x to 4x faster. (Contributed by Serhiy Storchaka in bpo-14625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14625}.)

@item 
The cost of hash collisions for sets is now reduced. Each hash table probe now checks a series of consecutive, adjacent key/hash pairs before continuing to make random probes through the hash table. This exploits cache locality to make collision resolution less expensive. The collision resolution scheme can be described as a hybrid of linear probing and open addressing. The number of additional linear probes defaults to nine. This can be changed at compile-time by defining LINEAR_PROBES to be any value. Set LINEAR_PROBES=0 to turn-off linear probing entirely. (Contributed by Raymond Hettinger in bpo-18771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18771}.)

@item 
The interpreter starts about 30% faster. A couple of measures lead to the speedup. The interpreter loads fewer modules on startup, e.g. the @ref{b9,,re}, @ref{1d,,collections} and @ref{86,,locale} modules and their dependencies are no longer imported by default. The marshal module has been improved to load compiled Python code faster. (Contributed by Antoine Pitrou, Christian Heimes and Victor Stinner in 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} and bpo-9548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9548}.)

@item 
@ref{86a,,bz2.BZ2File} is now as fast or faster than the Python2 version for most cases. @ref{1042,,lzma.LZMAFile} has also been optimized. (Contributed by Serhiy Storchaka and Nadeem Vawda in bpo-16034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16034}.)

@item 
@ref{1043,,random.getrandbits()} is 20%-40% faster for small integers (the most common use case). (Contributed by Serhiy Storchaka in bpo-16674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16674}.)

@item 
By taking advantage of the new storage format for strings, pickling of strings is now significantly faster. (Contributed by Victor Stinner and Antoine Pitrou in bpo-15596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15596}.)

@item 
A performance issue in @code{io.FileIO.readall()} has been solved.  This
particularly affects Windows, and significantly speeds up the case of piping
significant amounts of data through @ref{d6,,subprocess}.  (Contributed
by Richard Oudkerk in bpo-15758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15758}.)

@item 
@ref{1044,,html.escape()} is now 10x faster. (Contributed by Matt Bryant in bpo-18020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18020}.)

@item 
On Windows, the native @code{VirtualAlloc} is now used instead of the CRT @code{malloc} in @code{obmalloc}. Artificial benchmarks show about a 3% memory savings.

@item 
@ref{523,,os.urandom()} now uses a lazily opened persistent file descriptor
so as to avoid using many file descriptors when run in parallel from
multiple threads.  (Contributed by Antoine Pitrou in bpo-18756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18756}.)
@end itemize

@node Descontinuados<11>,Removidos<11>,CPython Implementation Changes,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 deprecated}@anchor{1045}@anchor{whatsnew/3 4 deprecated-3-4}@anchor{f38}
@subsection Descontinuados


This section covers various APIs and other features that have been deprecated in Python 3.4, and will be removed in Python 3.5 or later. In most (but not all) cases, using the deprecated APIs will produce a @ref{1a5,,DeprecationWarning} when the interpreter is run with deprecation warnings enabled (for example, by using @code{-Wd}).

@menu
* Deprecations in the Python API:: 
* Deprecated Features:: 

@end menu

@node Deprecations in the Python API,Deprecated Features,,Descontinuados<11>
@anchor{whatsnew/3 4 deprecations-in-the-python-api}@anchor{1046}
@subsubsection Deprecations in the Python API



@itemize *

@item 
As mentioned in @ref{f0b,,PEP 451; A ModuleSpec Type for the Import System}, a number of @ref{77,,importlib}
methods and functions are deprecated: @code{importlib.find_loader()} is
replaced by @ref{2cd,,importlib.util.find_spec()};
@code{importlib.machinery.PathFinder.find_module()} is replaced by
@ref{1047,,importlib.machinery.PathFinder.find_spec()};
@code{importlib.abc.MetaPathFinder.find_module()} is replaced by
@ref{86c,,importlib.abc.MetaPathFinder.find_spec()};
@code{importlib.abc.PathEntryFinder.find_loader()} and
@code{find_module()} are replaced by
@ref{870,,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{86e,,importlib.abc.Loader.exec_module()},
@ref{1048,,importlib.abc.InspectLoader.exec_module()}
@ref{1049,,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 
The @code{formatter} module is pending deprecation and is slated for removal
in Python 3.6.

@item 
@code{MD5} as the default `digestmod' for the @ref{aae,,hmac.new()} function is deprecated. Python 3.6 will require an explicit digest name or constructor as `digestmod' argument.

@item 
The internal @code{Netrc} class in the @ref{5e,,ftplib} module has been documented as deprecated in its docstring for quite some time. It now emits a @ref{1a5,,DeprecationWarning} and will be removed completely in Python 3.5.

@item 
The undocumented `endtime' argument to @ref{d05,,subprocess.Popen.wait()} should
not have been exposed and is hopefully not in use; it is deprecated and
will mostly likely be removed in Python 3.5.

@item 
The `strict' argument of @ref{87b,,HTMLParser} is deprecated.

@item 
The @ref{ab,,plistlib} @code{readPlist()},
@code{writePlist()}, @code{readPlistFromBytes()}, and
@code{writePlistToBytes()} functions are deprecated in favor of the
corresponding new functions @ref{956,,load()}, @ref{958,,dump()},
@ref{957,,loads()}, and @ref{959,,dumps()}.  @code{Data()}
is deprecated in favor of just using the @ref{1c2,,bytes} constructor.

@item 
The @ref{db,,sysconfig} key @code{SO} is deprecated, it has been replaced by
@code{EXT_SUFFIX}.

@item 
The @code{U} mode accepted by various @code{open} functions is deprecated.
In Python3 it does not do anything useful, and should be replaced by
appropriate uses of @ref{7bc,,io.TextIOWrapper} (if needed) and its `newline'
argument.

@item 
The `parser' argument of @ref{273,,xml.etree.ElementTree.iterparse()} has been deprecated, as has the `html' argument of @ref{a5e,,XMLParser()}. To prepare for the removal of the latter, all arguments to @code{XMLParser} should be passed by keyword.
@end itemize

@node Deprecated Features,,Deprecations in the Python API,Descontinuados<11>
@anchor{whatsnew/3 4 deprecated-features}@anchor{104a}
@subsubsection Deprecated Features



@itemize *

@item 
Running @ref{104b,,IDLE — editor e console Python} with the @code{-n} flag (no subprocess) is deprecated.
However, the feature will not be removed until bpo-18823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18823} is resolved.

@item 
The site module adding a “site-python” directory to sys.path, if it
exists, is deprecated (bpo-19375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19375}).
@end itemize

@node Removidos<11>,Porting to Python 3 4,Descontinuados<11>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 removed}@anchor{104c}
@subsection Removidos


@menu
* Operating Systems No Longer Supported:: 
* Remoção de APIs e recursos: Remoção de APIs e recursos<5>. 
* Code Cleanups:: 

@end menu

@node Operating Systems No Longer Supported,Remoção de APIs e recursos<5>,,Removidos<11>
@anchor{whatsnew/3 4 operating-systems-no-longer-supported}@anchor{104d}
@subsubsection Operating Systems No Longer Supported


Support for the following operating systems has been removed from the source
and build tools:


@itemize *

@item 
OS/2 (bpo-16135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16135}).

@item 
Windows 2000 (changeset e52df05b496a).

@item 
Windows systems where @code{COMSPEC} points to @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 Remoção de APIs e recursos<5>,Code Cleanups,Operating Systems No Longer Supported,Removidos<11>
@anchor{whatsnew/3 4 api-and-feature-removals}@anchor{104e}
@subsubsection Remoção de APIs e recursos


The following obsolete and previously deprecated APIs and features have been
removed:


@itemize *

@item 
The unmaintained @code{Misc/TextMate} and @code{Misc/vim} directories have been
removed (see the devguide@footnote{https://devguide.python.org}
for suggestions on what to use instead).

@item 
The @code{SO} makefile macro is removed (it was replaced by the
@code{SHLIB_SUFFIX} and @code{EXT_SUFFIX} macros) (bpo-16754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16754}).

@item 
The @code{PyThreadState.tick_counter} field has been removed; its value has
been meaningless since Python 3.2, when the “new GIL” was introduced
(bpo-19199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19199}).

@item 
@code{PyLoader} and @code{PyPycLoader} have been removed from @ref{77,,importlib}.
(Contributed by Taras Lyapun in bpo-15641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15641}.)

@item 
The `strict' argument to @ref{b53,,HTTPConnection} and @ref{b54,,HTTPSConnection} has been removed. HTTP 0.9-style “Simple Responses” are no longer supported.

@item 
The deprecated @ref{100e,,urllib.request.Request} getter and setter methods
@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}, and
@code{is_unverifiable} have been removed (use direct attribute access instead).

@item 
Support for loading the deprecated @code{TYPE_INT64} has been removed from @ref{8d,,marshal}. (Contributed by Dan Riti in bpo-15480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15480}.)

@item 
@ref{1cf,,inspect.Signature}: positional-only parameters are now required
to have a valid name.

@item 
@ref{61e,,object.__format__()} no longer accepts non-empty format strings, it now raises a @ref{2c3,,TypeError} instead. Using a non-empty string has been deprecated since Python 3.2. This change has been made to prevent a situation where previously working (but incorrect) code would start failing if an object gained a __format__ method, which means that your code may now raise a @ref{2c3,,TypeError} if you are using an @code{'s'} format code with objects that do not have a __format__ method that handles it. See bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994} for background.

@item 
@code{difflib.SequenceMatcher.isbjunk()} and
@code{difflib.SequenceMatcher.isbpopular()} were deprecated in 3.2, and have
now been removed: use @code{x in sm.bjunk} and
@code{x in sm.bpopular}, where `sm' is a @ref{104f,,SequenceMatcher} object
(bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}).
@end itemize

@node Code Cleanups,,Remoção de APIs e recursos<5>,Removidos<11>
@anchor{whatsnew/3 4 code-cleanups}@anchor{1050}
@subsubsection Code Cleanups



@itemize *

@item 
The unused and undocumented internal @code{Scanner} class has been removed from
the @ref{b5,,pydoc} module.

@item 
The private and effectively unused @code{_gestalt} module has been removed,
along with the private @ref{aa,,platform} functions @code{_mac_ver_lookup},
@code{_mac_ver_gstalt}, and @code{_bcd2str}, which would only have ever been called
on badly broken OSX systems (see bpo-18393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18393}).

@item 
The hardcoded copies of certain @ref{d1,,stat} constants that were included in
the @ref{de,,tarfile} module namespace have been removed.
@end itemize

@node Porting to Python 3 4,Alterado em 3 4 3,Removidos<11>,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 porting-to-python-3-4}@anchor{1051}
@subsection Porting to Python 3.4


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Changes in ‘python’ Command Behavior: Changes in ‘python’ Command Behavior<2>. 
* Alterações na API Python: Alterações na API Python<10>. 
* Alterações na API C: Alterações na API C<15>. 

@end menu

@node Changes in ‘python’ Command Behavior<2>,Alterações na API Python<10>,,Porting to Python 3 4
@anchor{whatsnew/3 4 changes-in-python-command-behavior}@anchor{1052}
@subsubsection Changes in ‘python’ Command Behavior



@itemize *

@item 
In a posix shell, setting the 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} environment variable to an empty value is equivalent to not setting it at all. However, setting 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} to an empty value was `not' equivalent to not setting it at all: setting 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} to an empty value was equivalent to setting it to @code{.}, which leads to confusion when reasoning by analogy to how 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} works. The behavior now conforms to the posix convention for 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.

@item 
The [X refs, Y blocks] output of a debug (@code{--with-pydebug}) build of the CPython interpreter is now off by default. It can be re-enabled using the @code{-X showrefcount} option. (Contributed by Ezio Melotti in bpo-17323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17323}.)

@item 
The python command and most stdlib scripts (as well as @ref{6,,argparse}) now
output @code{--version} information to @code{stdout} instead of @code{stderr} (for
issue list see @ref{103c,,Other Improvements} above).
@end itemize

@node Alterações na API Python<10>,Alterações na API C<15>,Changes in ‘python’ Command Behavior<2>,Porting to Python 3 4
@anchor{whatsnew/3 4 changes-in-the-python-api}@anchor{1054}
@subsubsection Alterações na API Python



@itemize *

@item 
The ABCs defined in @ref{78,,importlib.abc} now either raise the appropriate
exception or return a default value instead of raising
@ref{228,,NotImplementedError} blindly. This will only affect code calling
@ref{4db,,super()} and falling through all the way to the ABCs. For compatibility,
catch both @ref{228,,NotImplementedError} or the appropriate exception as needed.

@item 
The module type now initializes the @ref{2d7,,__package__} and
@ref{2e2,,__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 
Import now resets relevant attributes (e.g. @code{__name__}, @code{__loader__},
@code{__package__}, @code{__file__}, @code{__cached__}) unconditionally when reloading.
Note that this restores a pre-3.3 behavior in that it means a module is
re-found when re-loaded (bpo-19413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19413}).

@item 
Frozen packages no longer set @code{__path__} to a list containing the package name, they now set it to an empty list. The previous behavior could cause the import system to do the wrong thing on submodule imports if there was also a directory with the same name as the frozen package. The correct way to determine if a module is a package or not is to use @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{1055,,importlib.machinery.FrozenImporter},
or if Python 2 compatibility is necessary you can use @code{imp.is_frozen()}.

@item 
@ref{a2f,,py_compile.compile()} now raises @ref{1056,,FileExistsError} if the file path
it would write to is a symlink or a non-regular file. This is to act as a
warning that import will overwrite those files with a regular file regardless
of what type of file path they were originally.

@item 
@ref{1057,,importlib.abc.SourceLoader.get_source()} no longer raises
@ref{419,,ImportError} when the source code being loaded triggers a
@ref{18d,,SyntaxError} or @ref{a1d,,UnicodeDecodeError}. As @ref{419,,ImportError} is
meant to be raised only when source code cannot be found but it should, it was
felt to be over-reaching/overloading of that meaning when the source code is
found but improperly structured. If you were catching ImportError before and
wish to continue to ignore syntax or decoding issues, catch all three
exceptions now.

@item 
@ref{1058,,functools.update_wrapper()} e @ref{f91,,functools.wraps()} agora definem corretamente o atributo @code{__wrapped__} para a função que está sendo empacotada, mesmo que essa função também tenha seu atributo @code{__wrapped__} definido.  Isso significa que os atributos @code{__wrapped__} agora vinculam corretamente uma pilha de funções decoradas em vez de cada atributo @code{__wrapped__} na cadeia referente à função mais interna. Bibliotecas de introspecção que presumiam que o comportamento anterior foi intencional podem usar @ref{f90,,inspect.unwrap()} para acessar a primeira função na cadeia que não possui nenhum atributo @code{__wrapped__}.

@item 
@ref{739,,inspect.getfullargspec()} foi reimplementada em cima de @ref{738,,inspect.signature()} e, portanto, lida com uma variedade muito maior de objetos que podem ser chamados do que no passado. Espera-se que chamáveis adicionais de módulos embutidos e de extensão ganhem metadados de assinatura ao longo da série Python 3.4.  O código que presume que @ref{739,,inspect.getfullargspec()} falhará em chamáveis não-Python pode precisar ser ajustado de acordo.

@item 
@ref{1059,,importlib.machinery.PathFinder} now passes on the current working directory to objects in @ref{105a,,sys.path_hooks} for the empty string. This results in @ref{5e4,,sys.path_importer_cache} never containing @code{'@w{'}}, thus iterating through @ref{5e4,,sys.path_importer_cache} based on @ref{3b4,,sys.path} will not find all keys. A module’s @code{__file__} when imported in the current working directory will also now have an absolute path, including when using @code{-m} with the interpreter (except for @code{__main__.__file__} when a script has been executed directly using a relative path) (Contributed by Brett Cannon in bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}). is specified on the command-line) (bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416}).

@item 
The removal of the `strict' argument to @ref{b53,,HTTPConnection} and @ref{b54,,HTTPSConnection} changes the meaning of the remaining arguments if you are specifying them positionally rather than by keyword. If you’ve been paying attention to deprecation warnings your code should already be specifying any additional arguments via keywords.

@item 
Strings between @code{from __future__ import ...} statements now `always' raise a @ref{18d,,SyntaxError}. Previously if there was no leading docstring, an interstitial string would sometimes be ignored. This brings CPython into compliance with the language spec; Jython and PyPy already were. (bpo-17434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17434}).

@item 
@ref{fec,,ssl.SSLSocket.getpeercert()} and @ref{e9c,,ssl.SSLSocket.do_handshake()} now raise an @ref{417,,OSError} with @code{ENOTCONN} when the @code{SSLSocket} is not connected, instead of the previous behavior of raising an @ref{34b,,AttributeError}. In addition, @ref{fec,,getpeercert()} will raise a @ref{202,,ValueError} if the handshake has not yet been done.

@item 
@ref{105b,,base64.b32decode()} now raises a @ref{105c,,binascii.Error} when the input string contains non-b32-alphabet characters, instead of a @ref{2c3,,TypeError}. This particular @ref{2c3,,TypeError} was missed when the other @ref{2c3,,TypeError}s were converted. (Contributed by Serhiy Storchaka in bpo-18011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18011}.) Note: this change was also inadvertently applied in 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 
Calling @code{read} or @code{write} on a closed SSL socket now raises an
informative @ref{202,,ValueError} rather than the previous more mysterious
@ref{34b,,AttributeError} (bpo-9177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9177}).

@item 
@ref{105d,,slice.indices()} no longer produces an @ref{885,,OverflowError} for huge values. As a consequence of this fix, @ref{105d,,slice.indices()} now raises a @ref{202,,ValueError} if given a negative length; previously it returned nonsense values (bpo-14794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14794}).

@item 
The @ref{2f8,,complex} constructor, unlike the @ref{18,,cmath} functions, was incorrectly accepting @ref{2f7,,float} values if an object’s @code{__complex__} special method returned one. This now raises a @ref{2c3,,TypeError}. (bpo-16290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16290}.)

@item 
The @ref{257,,int} constructor in 3.2 and 3.3 erroneously accepts @ref{2f7,,float} values for the `base' parameter. It is unlikely anyone was doing this, but if so, it will now raise a @ref{2c3,,TypeError} (bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772}).

@item 
Defaults for keyword-only arguments are now evaluated `after' defaults for regular keyword arguments, instead of before. Hopefully no one wrote any code that depends on the previous buggy behavior (bpo-16967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16967}).

@item 
Stale thread states are now cleared after @ref{197,,fork()}. This may cause some system resources to be released that previously were incorrectly kept perpetually alive (for example, database connections kept in thread-local storage). (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{105e,,__kwdefaults__}.
(Contributed by Yury Selivanov in bpo-20625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20625}.)

@item 
@ref{f7b,,hashlib.hash.name} now always returns the identifier in lower case.
Previously some builtin hashes had uppercase names, but now that it is a
formal public interface the naming has been made consistent (bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532}).

@item 
Because @ref{e20,,unittest.TestSuite} now drops references to tests after they
are run, test harnesses that reuse a @ref{e20,,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{e20,,TestSuite} subclass that defines a
@code{_removeTestAtIndex} method that does nothing (see
@ref{105f,,TestSuite.__iter__()}) (bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798}).

@item 
@ref{106,,unittest} now uses @ref{6,,argparse} for command line parsing. There are certain invalid command forms that used to work that are no longer allowed; in theory this should not cause backward compatibility issues since the disallowed command forms didn’t make any sense and are unlikely to be in use.

@item 
The @ref{2a2,,re.split()}, @ref{1060,,re.findall()}, and @ref{2a3,,re.sub()} functions, and
the @ref{1061,,group()} and @ref{1062,,groups()} methods of
@code{match} objects now always return a `bytes' object when the string
to be matched is a @ref{d4f,,bytes-like object}.  Previously the return type
matched the input type, so if your code was depending on the return value
being, say, a @code{bytearray}, you will need to change your code.

@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 
The new `convert_charrefs' argument to @ref{87b,,HTMLParser} currently defaults to @code{False} for backward compatibility, but will eventually be changed to default to @code{True}. It is recommended that you add this keyword, with the appropriate value, to any @ref{87b,,HTMLParser} calls in your code (bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633}).

@item 
Since the `digestmod' argument to the @ref{aae,,hmac.new()} function will in the
future have no default, all calls to @ref{aae,,hmac.new()} should be changed to
explicitly specify a `digestmod' (bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276}).

@item 
Calling @ref{1063,,sysconfig.get_config_var()} with the @code{SO} key, or looking @code{SO} up in the results of a call to @ref{1064,,sysconfig.get_config_vars()} is deprecated. This key should be replaced by @code{EXT_SUFFIX} or @code{SHLIB_SUFFIX}, depending on the context (bpo-19555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19555}).

@item 
Any calls to @code{open} functions that specify @code{U} should be modified.
@code{U} is ineffective in Python3 and will eventually raise an error if used.
Depending on the function, the equivalent of its old Python2 behavior can be
achieved using either a `newline' argument, or if necessary by wrapping the
stream in @ref{7bc,,TextIOWrapper} to use its `newline' argument
(bpo-15204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15204}).

@item 
If you use @code{pyvenv} in a script and desire that pip
`not' be installed, you must add @code{--without-pip} to your command
invocation.

@item 
The default behavior of @ref{d67,,json.dump()} and @ref{d68,,json.dumps()} when an indent is specified has changed: it no longer produces trailing spaces after the item separating commas at the ends of lines. This will matter only if you have tests that are doing white-space-sensitive comparisons of such output (bpo-16333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16333}).

@item 
@ref{3a,,doctest} now looks for doctests in extension module @code{__doc__}
strings, so if your doctest test discovery includes extension modules that
have things that look like doctests in them you may see test failures you’ve
never seen before when running your tests (bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158}).

@item 
The @ref{1e,,collections.abc} module has been slightly refactored as part of the Python startup improvements. As a consequence of this, it is no longer the case that importing @ref{1d,,collections} automatically imports @ref{1e,,collections.abc}. If your program depended on the (undocumented) implicit import, you will need to add an explicit @code{import collections.abc} (bpo-20784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20784}).
@end itemize

@node Alterações na API C<15>,,Alterações na API Python<10>,Porting to Python 3 4
@anchor{whatsnew/3 4 changes-in-the-c-api}@anchor{1065}
@subsubsection Alterações na API C



@itemize *

@item 
@ref{1066,,PyEval_EvalFrameEx()}, @ref{1067,,PyObject_Repr()}, and
@ref{1068,,PyObject_Str()}, along with some other internal C APIs, now include
a debugging assertion that ensures they are not used in situations where
they may silently discard a currently active exception. In cases where
discarding the active exception is expected and desired (for example,
because it has already been saved locally with @ref{3f3,,PyErr_Fetch()} or
is being deliberately replaced with a different exception), an explicit
@ref{1069,,PyErr_Clear()} call will be needed to avoid triggering the
assertion when invoking these operations (directly or indirectly) and
running against a version of Python that is compiled with assertions
enabled.

@item 
@ref{d60,,PyErr_SetImportError()} now sets @ref{2c3,,TypeError} when its `msg'
argument is not set. Previously only @code{NULL} was returned with no exception
set.

@item 
The result of the @ref{586,,PyOS_ReadlineFunctionPointer} callback must
now be a string allocated by @ref{390,,PyMem_RawMalloc()} or
@ref{392,,PyMem_RawRealloc()}, or @code{NULL} if an error occurred, instead of a
string allocated by @ref{c81,,PyMem_Malloc()} or @ref{106a,,PyMem_Realloc()}
(bpo-16742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16742})

@item 
@ref{408,,PyThread_set_key_value()} now always set the value. In Python
3.3, the function did nothing if the key already exists (if the current
value is a non-@code{NULL} pointer).

@item 
The @code{f_tstate} (thread state) field of the @ref{789,,PyFrameObject}
structure has been removed to fix a bug: see bpo-14432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14432} for the
rationale.
@end itemize

@node Alterado em 3 4 3,,Porting to Python 3 4,O que há de novo no Python 3 4
@anchor{whatsnew/3 4 changed-in-3-4-3}@anchor{106b}
@subsection Alterado em 3.4.3


@menu
* PEP 476; Habilitando verificação de certificado por padrão para clientes http stdlib: PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib. 

@end menu

@node PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib,,,Alterado em 3 4 3
@anchor{whatsnew/3 4 pep-476}@anchor{106c}@anchor{whatsnew/3 4 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{106d}
@subsubsection PEP 476: Habilitando verificação de certificado por padrão para clientes http stdlib


@ref{6f,,http.client} and modules which use it, such as @ref{10b,,urllib.request} and
@ref{12e,,xmlrpc.client}, will now verify that the server presents a certificate
which is signed by a CA in the platform trust store and whose hostname matches
the hostname being requested by default, significantly improving security for
many applications.

Para aplicações que exigem o antigo comportamento anterior, elas podem passar um 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 O que há de novo no Python 3 3,O que há de novo no Python 3 2,O que há de novo no Python 3 4,O que há de novo no Python
@anchor{whatsnew/3 3 doc}@anchor{106e}@anchor{whatsnew/3 3 translation-repo}@anchor{106f}@anchor{whatsnew/3 3 what-s-new-in-python-3-3}@anchor{1070}
@section O que há de novo no 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.

This article explains the new features in Python 3.3, compared to 3.2.
Python 3.3 was released on September 29, 2012.  For full details,
see the changelog@footnote{https://docs.python.org/3.3/whatsnew/changelog.html}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 398
PEP 398@footnote{https://peps.python.org/pep-0398/} - Python 3.3 Release Schedule


@menu
* Resumo – Destaques da versão: Resumo – Destaques da versão<11>. 
* PEP 405; Ambientes Virtuais: PEP 405 Ambientes Virtuais. 
* PEP 420; Implicit Namespace Packages: PEP 420 Implicit Namespace Packages. 
* PEP 3118; New memoryview implementation and buffer protocol documentation: PEP 3118 New memoryview implementation and buffer protocol documentation. 
* PEP 393; Flexible String Representation: PEP 393 Flexible String Representation. 
* PEP 397; Python Launcher for Windows: PEP 397 Python Launcher for Windows. 
* PEP 3151; Reworking the OS and IO exception hierarchy: PEP 3151 Reworking the OS and IO exception hierarchy. 
* PEP 380; Syntax for Delegating to a Subgenerator: PEP 380 Syntax for Delegating to a Subgenerator. 
* PEP 409; Suppressing exception context: PEP 409 Suppressing exception context. 
* PEP 414; Explicit Unicode literals: PEP 414 Explicit Unicode literals. 
* PEP 3155; Qualified name for classes and functions: PEP 3155 Qualified name for classes and functions. 
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary. 
* PEP 362; Function Signature Object: PEP 362 Function Signature Object. 
* PEP 421; Adding sys.implementation: PEP 421 Adding sys implementation. 
* Using importlib as the Implementation of Import:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<11>. 
* A Finer-Grained Import Lock:: 
* Builtin functions and types:: 
* Novos módulos: Novos módulos<11>. 
* Módulos melhorados: Módulos melhorados<11>. 
* Otimizações: Otimizações<10>. 
* Mudanças a construções e API C: Mudanças a construções e API C<4>. 
* Descontinuados: Descontinuados<12>. 
* Porting to Python 3.3: Porting to Python 3 3. 

@end menu

@node Resumo – Destaques da versão<11>,PEP 405 Ambientes Virtuais,,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 summary-release-highlights}@anchor{1071}
@subsection Resumo – Destaques da versão


@c This section singles out the most important changes in Python 3.3.
@c Brevity is key.

Novos recursos de sintaxe:


@itemize *

@item 
New @code{yield from} expression for @ref{1072,,generator delegation}.

@item 
A sintaxe @code{u'unicode'} é aceita novamente para objetos tipo @ref{44c,,str}.
@end itemize

Novos módulos de biblioteca:


@itemize *

@item 
@ref{58,,faulthandler} (helps debugging low-level crashes)

@item 
@ref{80,,ipaddress} (high-level objects representing IP addresses and masks)

@item 
@ref{8a,,lzma} (compressão de dados usando o algoritmo XZ / LZMA)

@item 
@ref{107,,unittest.mock} (replace parts of your system under test with mock objects)

@item 
@ref{111,,venv} (Python @ref{1073,,virtual environments}, as in the
popular @code{virtualenv} package)
@end itemize

Novos recursos embutidos:


@itemize *

@item 
Reworked @ref{1074,,I/O exception hierarchy}.
@end itemize

Melhorias na implementação:


@itemize *

@item 
Rewritten @ref{1075,,import machinery} based on @ref{77,,importlib}.

@item 
More compact @ref{1076,,unicode strings}.

@item 
More compact @ref{1077,,attribute dictionaries}.
@end itemize

Significantly Improved Library Modules:


@itemize *

@item 
C Accelerator for the @ref{1078,,decimal} module.

@item 
Better unicode handling in the @ref{1079,,email} module
(@ref{107a,,provisional}).
@end itemize

Melhorias de Segurança:


@itemize *

@item 
Hash randomization is switched on by default.
@end itemize

Please read on for a comprehensive list of user-facing changes.

@node PEP 405 Ambientes Virtuais,PEP 420 Implicit Namespace Packages,Resumo – Destaques da versão<11>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-405}@anchor{1073}@anchor{whatsnew/3 3 pep-405-virtual-environments}@anchor{107b}
@subsection PEP 405: Ambientes Virtuais


Virtual environments help create separate Python setups while sharing a
system-wide base install, for ease of maintenance.  Virtual environments
have their own set of private site packages (i.e. locally installed
libraries), and are optionally segregated from the system-wide site
packages.  Their concept and implementation are inspired by the popular
@code{virtualenv} third-party package, but benefit from tighter integration
with the interpreter core.

This PEP adds the @ref{111,,venv} module for programmatic access, and the
@code{pyvenv} script for command-line access and
administration.  The Python interpreter checks for a @code{pyvenv.cfg},
file whose existence signals the base of a virtual environment’s directory
tree.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 405

@item PEP 405@footnote{https://peps.python.org/pep-0405/} - Ambientes Virtuais Python

PEP written by Carl Meyer; implementation by Carl Meyer and Vinay Sajip
@end table


@node PEP 420 Implicit Namespace Packages,PEP 3118 New memoryview implementation and buffer protocol documentation,PEP 405 Ambientes Virtuais,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-420-implicit-namespace-packages}@anchor{107c}
@subsection PEP 420: Implicit Namespace Packages


Native support for package directories that don’t require @code{__init__.py}
marker files and can automatically span multiple path segments (inspired by
various third party approaches to namespace packages, as described in
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/})


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/} - Implicit Namespace Packages

PEP written by Eric V. Smith; implementation by Eric V. Smith
and Barry Warsaw
@end table


@node PEP 3118 New memoryview implementation and buffer protocol documentation,PEP 393 Flexible String Representation,PEP 420 Implicit Namespace Packages,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-3118-new-memoryview-implementation-and-buffer-protocol-documentation}@anchor{107d}@anchor{whatsnew/3 3 pep-3118-update}@anchor{107e}
@subsection PEP 3118: New memoryview implementation and buffer protocol documentation


A implementação de 
@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} foi significativamente melhorada.

The new memoryview implementation comprehensively fixes all ownership and
lifetime issues of dynamically allocated fields in the Py_buffer struct
that led to multiple crash reports. Additionally, several functions that
crashed or returned incorrect results for non-contiguous or multi-dimensional
input have been fixed.

The memoryview object now has a PEP-3118 compliant getbufferproc()
that checks the consumer’s request type. Many new features have been
added, most of them work in full generality for non-contiguous arrays
and arrays with suboffsets.

The documentation has been updated, clearly spelling out responsibilities
for both exporters and consumers. Buffer request flags are grouped into
basic and compound flags. The memory layout of non-contiguous and
multi-dimensional NumPy-style arrays is explained.

@menu
* Recursos:: 
* Mudanças na API:: 

@end menu

@node Recursos,Mudanças na API,,PEP 3118 New memoryview implementation and buffer protocol documentation
@anchor{whatsnew/3 3 features}@anchor{107f}
@subsubsection Recursos



@itemize *

@item 
All native single character format specifiers in struct module syntax
(optionally prefixed with ‘@@’) are now supported.

@item 
With some restrictions, the cast() method allows changing of format and
shape of C-contiguous arrays.

@item 
Multi-dimensional list representations are supported for any array type.

@item 
Multi-dimensional comparisons are supported for any array type.

@item 
One-dimensional memoryviews of hashable (read-only) types with formats B,
b or c are now hashable.  (Contributed by Antoine Pitrou in bpo-13411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=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 Mudanças na API,,Recursos,PEP 3118 New memoryview implementation and buffer protocol documentation
@anchor{whatsnew/3 3 api-changes}@anchor{1080}
@subsubsection Mudanças na API



@itemize *

@item 
The maximum number of dimensions is officially limited to 64.

@item 
The representation of empty shape, strides and suboffsets is now
an empty tuple instead of @code{None}.

@item 
Accessing a memoryview element with format ‘B’ (unsigned bytes)
now returns an integer (in accordance with the struct module syntax).
For returning a bytes object the view must be cast to ‘c’ first.

@item 
memoryview comparisons now use the logical structure of the operands
and compare all array elements by value. All format strings in struct
module syntax are supported. Views with unrecognised format strings
are still permitted, but will always compare as unequal, regardless
of view contents.

@item 
For further changes see @ref{1081,,Build and C API Changes} and @ref{1082,,Porting C code}.
@end itemize

(Contributed by Stefan Krah in bpo-10181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10181}.)


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} - Revising the Buffer Protocol


@node PEP 393 Flexible String Representation,PEP 397 Python Launcher for Windows,PEP 3118 New memoryview implementation and buffer protocol documentation,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-393}@anchor{1076}@anchor{whatsnew/3 3 pep-393-flexible-string-representation}@anchor{1083}
@subsection PEP 393: Flexible String Representation


The Unicode string type is changed to support multiple internal
representations, depending on the character with the largest Unicode ordinal
(1, 2, or 4 bytes) in the represented string.  This allows a space-efficient
representation in common cases, but gives access to full UCS-4 on all
systems.  For compatibility with existing APIs, several representations may
exist in parallel; over time, this compatibility should be phased out.

On the Python side, there should be no downside to this change.

On the C API side, 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} is fully backward compatible.  The legacy API
should remain available at least five years.  Applications using the legacy
API will not fully benefit of the memory reduction, or - worse - may use
a bit more memory, because Python may have to maintain two versions of each
string (in the legacy format and in the new efficient storage).

@menu
* Funcionalidade:: 
* Desempenho e utilização de recursos:: 

@end menu

@node Funcionalidade,Desempenho e utilização de recursos,,PEP 393 Flexible String Representation
@anchor{whatsnew/3 3 functionality}@anchor{1084}
@subsubsection Funcionalidade


Changes introduced by 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} are the following:


@itemize *

@item 
Python now always supports the full range of Unicode code points, including
non-BMP ones (i.e. from @code{U+0000} to @code{U+10FFFF}).  The distinction between
narrow and wide builds no longer exists and Python now behaves like a wide
build, even under Windows.

@item 
With the death of narrow builds, the problems specific to narrow builds have
also been fixed, for example:


@itemize *

@item 
@ref{62e,,len()} now always returns 1 for non-BMP characters,
so @code{len('\U0010FFFF') == 1};

@item 
surrogate pairs are not recombined in string literals,
so @code{'\uDBFF\uDFFF' != '\U0010FFFF'};

@item 
indexing or slicing non-BMP characters returns the expected value,
so @code{'\U0010FFFF'[0]} now returns @code{'\U0010FFFF'} and not @code{'\uDBFF'};

@item 
all other functions in the standard library now correctly handle
non-BMP code points.
@end itemize

@item 
The value of @ref{1085,,sys.maxunicode} is now always @code{1114111} (@code{0x10FFFF}
in hexadecimal).  The @code{PyUnicode_GetMax()} function still returns
either @code{0xFFFF} or @code{0x10FFFF} for backward compatibility, and it should
not be used with the new Unicode API (see bpo-13054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13054}).

@item 
The @code{./configure} flag @code{--with-wide-unicode} has been removed.
@end itemize

@node Desempenho e utilização de recursos,,Funcionalidade,PEP 393 Flexible String Representation
@anchor{whatsnew/3 3 performance-and-resource-usage}@anchor{1086}
@subsubsection Desempenho e utilização de recursos


The storage of Unicode strings now depends on the highest code point in the string:


@itemize *

@item 
pure ASCII and Latin1 strings (@code{U+0000-U+00FF}) use 1 byte per code point;

@item 
BMP strings (@code{U+0000-U+FFFF}) use 2 bytes per code point;

@item 
non-BMP strings (@code{U+10000-U+10FFFF}) use 4 bytes per code point.
@end itemize

The net effect is that for most applications, memory usage of string
storage should decrease significantly - especially compared to former
wide unicode builds - as, in many cases, strings will be pure ASCII
even in international contexts (because many strings store non-human
language data, such as XML fragments, HTTP headers, JSON-encoded data,
etc.).  We also hope that it will, for the same reasons, increase CPU
cache efficiency on non-trivial applications. The memory usage of
Python 3.3 is two to three times smaller than Python 3.2, and a little
bit better than Python 2.7, on a Django benchmark (see the PEP for
details).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 393

@item PEP 393@footnote{https://peps.python.org/pep-0393/} - Flexible String Representation

PEP written by Martin von Löwis; implementation by Torsten Becker
and Martin von Löwis.
@end table


@node PEP 397 Python Launcher for Windows,PEP 3151 Reworking the OS and IO exception hierarchy,PEP 393 Flexible String Representation,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-397}@anchor{1087}@anchor{whatsnew/3 3 pep-397-python-launcher-for-windows}@anchor{1088}
@subsection PEP 397: Python Launcher for Windows


The Python 3.3 Windows installer now includes a @code{py} launcher application
that can be used to launch Python applications in a version independent
fashion.

This launcher is invoked implicitly when double-clicking @code{*.py} files.
If only a single Python version is installed on the system, that version
will be used to run the file. If multiple versions are installed, the most
recent version is used by default, but this can be overridden by including
a Unix-style “shebang line” in the Python script.

The launcher can also be used explicitly from the command line as the @code{py}
application. Running @code{py} follows the same version selection rules as
implicitly launching scripts, but a more specific version can be selected
by passing appropriate arguments (such as @code{-3} to request Python 3 when
Python 2 is also installed, or @code{-2.6} to specifically request an earlier
Python version when a more recent version is installed).

In addition to the launcher, the Windows installer now includes an
option to add the newly installed Python to the system PATH.  (Contributed
by Brian Curtin in bpo-3561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3561}.)


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 397

@item PEP 397@footnote{https://peps.python.org/pep-0397/} - Python Launcher for Windows

PEP written by Mark Hammond and Martin v. Löwis; implementation by
Vinay Sajip.
@end table

Launcher documentation: @ref{5be,,Inicializador Python para Windows}

Installer PATH modification: @ref{1089,,Encontrando o executável do Python}


@node PEP 3151 Reworking the OS and IO exception hierarchy,PEP 380 Syntax for Delegating to a Subgenerator,PEP 397 Python Launcher for Windows,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-3151}@anchor{1074}@anchor{whatsnew/3 3 pep-3151-reworking-the-os-and-io-exception-hierarchy}@anchor{108a}
@subsection PEP 3151: Reworking the OS and IO exception hierarchy


The hierarchy of exceptions raised by operating system errors is now both
simplified and finer-grained.

You don’t have to worry anymore about choosing the appropriate exception
type between @ref{417,,OSError}, @ref{108b,,IOError}, @ref{108c,,EnvironmentError},
@ref{108d,,WindowsError}, @code{mmap.error}, @ref{108e,,socket.error} or
@ref{108f,,select.error}.  All these exception types are now only one:
@ref{417,,OSError}.  The other names are kept as aliases for compatibility
reasons.

Also, it is now easier to catch a specific error condition.  Instead of
inspecting the @code{errno} attribute (or @code{args[0]}) for a particular
constant from the @ref{57,,errno} module, you can catch the adequate
@ref{417,,OSError} subclass.  The available subclasses are the following:


@itemize *

@item 
@ref{1090,,BlockingIOError}

@item 
@ref{1091,,ChildProcessError}

@item 
@ref{e36,,ConnectionError}

@item 
@ref{1056,,FileExistsError}

@item 
@ref{42b,,FileNotFoundError}

@item 
@ref{db0,,InterruptedError}

@item 
@ref{1092,,IsADirectoryError}

@item 
@ref{1093,,NotADirectoryError}

@item 
@ref{d65,,PermissionError}

@item 
@ref{1094,,ProcessLookupError}

@item 
@ref{838,,TimeoutError}
@end itemize

And the @ref{e36,,ConnectionError} itself has finer-grained subclasses:


@itemize *

@item 
@ref{1095,,BrokenPipeError}

@item 
@ref{1096,,ConnectionAbortedError}

@item 
@ref{1097,,ConnectionRefusedError}

@item 
@ref{1098,,ConnectionResetError}
@end itemize

Thanks to the new exceptions, common usages of the @ref{57,,errno} can now be
avoided.  For example, the following code written for 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

can now be written without the @ref{57,,errno} import and without manual
inspection of exception attributes:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3151

@item PEP 3151@footnote{https://peps.python.org/pep-3151/} - Reworking the OS and IO Exception Hierarchy

PEP escrita e implmentada por Antoine Pitrou
@end table


@geindex yield;yield from (in What's New)

@node PEP 380 Syntax for Delegating to a Subgenerator,PEP 409 Suppressing exception context,PEP 3151 Reworking the OS and IO exception hierarchy,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-380}@anchor{1072}@anchor{whatsnew/3 3 pep-380-syntax-for-delegating-to-a-subgenerator}@anchor{1099}
@subsection PEP 380: Syntax for Delegating to a Subgenerator


PEP 380 adds the @code{yield from} expression, allowing a @ref{109a,,generator} to
delegate
part of its operations to another generator. This allows a section of code
containing @ref{9d5,,yield} to be factored out and placed in another generator.
Additionally, the subgenerator is allowed to return with a value, and the
value is made available to the delegating generator.

While designed primarily for use in delegating to a subgenerator, the @code{yield
from} expression actually allows delegation to arbitrary subiterators.

For simple iterators, @code{yield from iterable} is essentially just a shortened
form of @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

However, unlike an ordinary loop, @code{yield from} allows subgenerators to
receive sent and thrown values directly from the calling scope, and
return a final value to the outer generator:

@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

The main principle driving this change is to allow even generators that are
designed to be used with the @code{send} and @code{throw} methods to be split into
multiple subgenerators as easily as a single large function can be split into
multiple subfunctions.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - Sintaxe para Delegar a um Subgerador

PEP written by Greg Ewing; implementation by Greg Ewing, integrated into
3.3 by Renaud Blanch, Ryan Kelly and Nick Coghlan; documentation by
Zbigniew Jędrzejewski-Szmek and Nick Coghlan
@end table


@node PEP 409 Suppressing exception context,PEP 414 Explicit Unicode literals,PEP 380 Syntax for Delegating to a Subgenerator,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-409-suppressing-exception-context}@anchor{109b}
@subsection PEP 409: Suppressing exception context


PEP 409 introduces new syntax that allows the display of the chained
exception context to be disabled. This allows cleaner error messages in
applications that convert between exception types:

@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

Without the @code{from None} suffix to suppress the cause, the original
exception would be displayed by default:

@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 debugging capability is lost, as the original exception context remains
available if needed (for example, if an intervening library has incorrectly
suppressed valuable underlying details):

@example
>>> try:
...     D(@{@}).x
... except AttributeError as exc:
...     print(repr(exc.__context__))
...
KeyError('x',)
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 409

@item PEP 409@footnote{https://peps.python.org/pep-0409/} - Suppressing exception context

PEP written by Ethan Furman; implemented by Ethan Furman and Nick
Coghlan.
@end table


@node PEP 414 Explicit Unicode literals,PEP 3155 Qualified name for classes and functions,PEP 409 Suppressing exception context,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-414-explicit-unicode-literals}@anchor{109c}
@subsection PEP 414: Explicit Unicode literals


To ease the transition from Python 2 for Unicode aware Python applications
that make heavy use of Unicode literals, Python 3.3 once again supports the
“@code{u}” prefix for string literals. This prefix has no semantic significance
in Python 3, it is provided solely to reduce the number of purely mechanical
changes in migrating to Python 3, making it easier for developers to focus on
the more significant semantic changes (such as the stricter default
separation of binary and text data).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 414

@item PEP 414@footnote{https://peps.python.org/pep-0414/} - Explicit Unicode literals

PEP written by Armin Ronacher.
@end table


@node PEP 3155 Qualified name for classes and functions,PEP 412 Key-Sharing Dictionary,PEP 414 Explicit Unicode literals,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-3155-qualified-name-for-classes-and-functions}@anchor{109d}
@subsection PEP 3155: Qualified name for classes and functions


Functions and class objects have a new @ref{109e,,__qualname__}
attribute representing
the “path” from the module top-level to their definition.  For global functions
and classes, this is the same as @ref{109f,,__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.

Example with (non-bound) methods:

@example
>>> class C:
...     def meth(self):
...         pass
...
>>> C.meth.__name__
'meth'
>>> C.meth.__qualname__
'C.meth'
@end example

Example with nested classes:

@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

Example with nested functions:

@example
>>> def outer():
...     def inner():
...         pass
...     return inner
...
>>> outer().__name__
'inner'
>>> outer().__qualname__
'outer.<locals>.inner'
@end example

The string representation of those objects is also changed to include the
new, more precise information:

@example
>>> str(C.D)
"<class '__main__.C.D'>"
>>> str(C.D.meth)
'<function C.D.meth at 0x7f46b9fe31e0>'
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3155

@item PEP 3155@footnote{https://peps.python.org/pep-3155/} - Qualified name for classes and functions

PEP escrita e implementada por Antoine Pitrou.
@end table


@node PEP 412 Key-Sharing Dictionary,PEP 362 Function Signature Object,PEP 3155 Qualified name for classes and functions,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-412}@anchor{1077}@anchor{whatsnew/3 3 pep-412-key-sharing-dictionary}@anchor{10a0}
@subsection PEP 412: Key-Sharing Dictionary


Dictionaries used for the storage of objects’ attributes are now able to
share part of their internal storage between each other (namely, the part
which stores the keys and their respective hashes).  This reduces the memory
consumption of programs creating many instances of non-builtin types.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 412

@item PEP 412@footnote{https://peps.python.org/pep-0412/} - Key-Sharing Dictionary

PEP written and implemented by Mark Shannon.
@end table


@node PEP 362 Function Signature Object,PEP 421 Adding sys implementation,PEP 412 Key-Sharing Dictionary,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-362-function-signature-object}@anchor{10a1}
@subsection PEP 362: Function Signature Object


A new function @ref{738,,inspect.signature()} makes introspection of python
callables easy and straightforward.  A broad range of callables is supported:
python functions, decorated or not, classes, and @ref{414,,functools.partial()}
objects.  New classes @ref{1cf,,inspect.Signature}, @ref{1d0,,inspect.Parameter}
and @ref{10a2,,inspect.BoundArguments} hold information about the call signatures,
such as, annotations, default values, parameters kinds, and bound arguments,
which considerably simplifies writing decorators and any code that validates
or amends calling signatures or arguments.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/}: -  Function Signature Object

PEP written by Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon Seo;
implemented by Yury Selivanov.
@end table


@node PEP 421 Adding sys implementation,Using importlib as the Implementation of Import,PEP 362 Function Signature Object,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 pep-421-adding-sys-implementation}@anchor{10a3}
@subsection PEP 421: Adding sys.implementation


A new attribute on the @ref{d9,,sys} module exposes details specific to the
implementation of the currently running interpreter.  The initial set of
attributes on @ref{517,,sys.implementation} are @code{name}, @code{version},
@code{hexversion}, and @code{cache_tag}.

The intention of @code{sys.implementation} is to consolidate into one namespace
the implementation-specific data used by the standard library.  This allows
different Python implementations to share a single standard library code base
much more easily.  In its initial state, @code{sys.implementation} holds only a
small portion of the implementation-specific data.  Over time that ratio will
shift in order to make the standard library more portable.

One example of improved standard library portability is @code{cache_tag}.  As of
Python 3.3, @code{sys.implementation.cache_tag} is used by @ref{77,,importlib} to
support 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} compliance.  Any Python implementation that uses
@code{importlib} for its built-in import system may use @code{cache_tag} to control
the caching behavior for modules.

@menu
* SimpleNamespace:: 

@end menu

@node SimpleNamespace,,,PEP 421 Adding sys implementation
@anchor{whatsnew/3 3 simplenamespace}@anchor{10a4}
@subsubsection SimpleNamespace


The implementation of @code{sys.implementation} also introduces a new type to
Python: @ref{1d1,,types.SimpleNamespace}.  In contrast to a mapping-based
namespace, like @ref{256,,dict}, @code{SimpleNamespace} is attribute-based, like
@ref{a96,,object}.  However, unlike @code{object}, @code{SimpleNamespace} instances
are writable.  This means that you can add, remove, and modify the namespace
through normal attribute access.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 421

@item PEP 421@footnote{https://peps.python.org/pep-0421/} - Adding sys.implementation

PEP written and implemented by Eric Snow.
@end table


@node Using importlib as the Implementation of Import,Outras mudanças na linguagem<11>,PEP 421 Adding sys implementation,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 importlib}@anchor{1075}@anchor{whatsnew/3 3 using-importlib-as-the-implementation-of-import}@anchor{10a5}
@subsection Using importlib as the Implementation of 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-implement parts of @code{imp} in pure Python
bpo-14605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14605} - Make import machinery explicit
bpo-14646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14646} - Require loaders set __loader__ and __package__

The @ref{8da,,__import__()} function is now powered by @ref{10a6,,importlib.__import__()}.
This work leads to the completion of “phase 2” of 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. There are
multiple benefits to this change. First, it has allowed for more of the
machinery powering import to be exposed instead of being implicit and hidden
within the C code. It also provides a single implementation for all Python VMs
supporting Python 3.3 to use, helping to end any VM-specific deviations in
import semantics. And finally it eases the maintenance of import, allowing for
future growth to occur.

For the common user, there should be no visible change in semantics.  For
those whose code currently manipulates import or calls import
programmatically, the code changes that might possibly be required are covered
in the @ref{10a7,,Porting Python code} section of this document.

@menu
* New APIs:: 
* Visible Changes:: 

@end menu

@node New APIs,Visible Changes,,Using importlib as the Implementation of Import
@anchor{whatsnew/3 3 new-apis}@anchor{10a8}
@subsubsection New APIs


One of the large benefits of this work is the exposure of what goes into
making the import statement work. That means the various importers that were
once implicit are now fully exposed as part of the @ref{77,,importlib} package.

The abstract base classes defined in @ref{78,,importlib.abc} have been expanded
to properly delineate between @ref{10a9,,meta path finders}
and @ref{10aa,,path entry finders} by introducing
@ref{872,,importlib.abc.MetaPathFinder} and
@ref{873,,importlib.abc.PathEntryFinder}, respectively. The old ABC of
@code{importlib.abc.Finder} is now only provided for backwards-compatibility
and does not enforce any method requirements.

In terms of finders, @ref{10ab,,importlib.machinery.FileFinder} exposes the
mechanism used to search for source and bytecode files of a module. Previously
this class was an implicit member of @ref{105a,,sys.path_hooks}.

For loaders, the new abstract base class @ref{10ac,,importlib.abc.FileLoader} helps
write a loader that uses the file system as the storage mechanism for a module’s
code. The loader for source files
(@ref{10ad,,importlib.machinery.SourceFileLoader}), sourceless bytecode files
(@ref{10ae,,importlib.machinery.SourcelessFileLoader}), and extension modules
(@ref{cd0,,importlib.machinery.ExtensionFileLoader}) are now available for
direct use.

@ref{419,,ImportError} now has @code{name} and @code{path} attributes which are set when
there is relevant data to provide. The message for failed imports will also
provide the full name of the module now instead of just the tail end of the
module’s name.

The @ref{c2a,,importlib.invalidate_caches()} function will now call the method with
the same name on all finders cached in @ref{5e4,,sys.path_importer_cache} to help
clean up any stored state as necessary.

@node Visible Changes,,New APIs,Using importlib as the Implementation of Import
@anchor{whatsnew/3 3 visible-changes}@anchor{10af}
@subsubsection Visible Changes


For potential required changes to code, see the @ref{10a7,,Porting Python code}
section.

Beyond the expanse of what @ref{77,,importlib} now exposes, there are other
visible changes to import. The biggest is that @ref{d4d,,sys.meta_path} and
@ref{105a,,sys.path_hooks} now store all of the meta path finders and path entry
hooks used by import.  Previously the finders were implicit and hidden within
the C code of import instead of being directly exposed. This means that one can
now easily remove or change the order of the various finders to fit one’s needs.

Another change is that all modules have a @code{__loader__} attribute, storing the
loader used to create the module. 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} has been updated to make this
attribute mandatory for loaders to implement, so in the future once 3rd-party
loaders have been updated people will be able to rely on the existence of the
attribute. Until such time, though, import is setting the module post-load.

Loaders are also now expected to set the @code{__package__} attribute from
@geindex Propostas de Melhorias do Python; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/}. Once again, import itself is already setting this on all loaders
from @ref{77,,importlib} and import itself is setting the attribute post-load.

@code{None} is now inserted into @ref{5e4,,sys.path_importer_cache} when no finder
can be found on @ref{105a,,sys.path_hooks}. Since @code{imp.NullImporter} is not
directly exposed on @ref{105a,,sys.path_hooks} it could no longer be relied upon to
always be available to use as a value representing no finder found.

All other changes relate to semantic changes which should be taken into
consideration when updating code for Python 3.3, and thus should be read about
in the @ref{10a7,,Porting Python code} section of this document.

(Implementation by Brett Cannon)

@node Outras mudanças na linguagem<11>,A Finer-Grained Import Lock,Using importlib as the Implementation of Import,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 other-language-changes}@anchor{10b0}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
Added support for Unicode name aliases and named sequences.
Both @ref{10b1,,unicodedata.lookup()} and @code{'\N@{...@}'} now resolve name aliases,
and @ref{10b1,,unicodedata.lookup()} resolves named sequences too.

(Contributed by Ezio Melotti in bpo-12753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12753}.)

@item 
Unicode database updated to UCD version 6.1.0

@item 
Equality comparisons on @ref{94a,,range()} objects now return a result reflecting
the equality of the underlying sequences generated by those range objects.
(bpo-13201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13201})

@item 
The @code{count()}, @code{find()}, @code{rfind()}, @code{index()} and @code{rindex()}
methods of @ref{1c2,,bytes} and @ref{2ea,,bytearray} objects now accept an
integer between 0 and 255 as their first argument.

(Contributed by Petri Lehtinen in bpo-12170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12170}.)

@item 
The @code{rjust()}, @code{ljust()}, and @code{center()} methods of @ref{1c2,,bytes}
and @ref{2ea,,bytearray} now accept a @ref{2ea,,bytearray} for the @code{fill}
argument.  (Contributed by Petri Lehtinen in bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380}.)

@item 
New methods have been added to @ref{611,,list} and @ref{2ea,,bytearray}:
@code{copy()} and @code{clear()} (bpo-10516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10516}).  Consequently,
@ref{1a1,,MutableSequence} now also defines a
@code{clear()} method (bpo-11388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11388}).

@item 
Raw bytes literals can now be written @code{rb"..."} as well as @code{br"..."}.

(Contributed by Antoine Pitrou in bpo-13748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13748}.)

@item 
@ref{10b2,,dict.setdefault()} now does only one lookup for the given key, making
it atomic when used with built-in types.

(Contributed by Filip Gruszczyński in bpo-13521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13521}.)

@item 
The error messages produced when a function call does not match the function
signature have been significantly improved.

(Contributed by Benjamin Peterson.)
@end itemize

@node A Finer-Grained Import Lock,Builtin functions and types,Outras mudanças na linguagem<11>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 a-finer-grained-import-lock}@anchor{10b3}
@subsection A Finer-Grained Import Lock


Previous versions of CPython have always relied on a global import lock.
This led to unexpected annoyances, such as deadlocks when importing a module
would trigger code execution in a different thread as a side-effect.
Clumsy workarounds were sometimes employed, such as the
@ref{3bd,,PyImport_ImportModuleNoBlock()} C API function.

In Python 3.3, importing a module takes a per-module lock.  This correctly
serializes importation of a given module from multiple threads (preventing
the exposure of incompletely initialized modules), while eliminating the
aforementioned annoyances.

(Contributed by Antoine Pitrou in bpo-9260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9260}.)

@node Builtin functions and types,Novos módulos<11>,A Finer-Grained Import Lock,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 builtin-functions-and-types}@anchor{10b4}
@subsection Builtin functions and types



@itemize *

@item 
@ref{51c,,open()} gets a new `opener' parameter: the underlying file descriptor
for the file object is then obtained by calling `opener' with (`file',
`flags'). It can be used to use custom flags like @ref{10b5,,os.O_CLOEXEC} for
example. The @code{'x'} mode was added: open for exclusive creation, failing if
the file already exists.

@item 
@ref{fa9,,print()}: added the `flush' keyword argument. If the `flush' keyword
argument is true, the stream is forcibly flushed.

@item 
@ref{5eb,,hash()}: hash randomization is enabled by default, see
@ref{b0e,,object.__hash__()} and 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED}.

@item 
The @ref{44c,,str} type gets a new @ref{e00,,casefold()} method: return a
casefolded copy of the string, casefolded strings may be used for caseless
matching. For example, @code{'ß'.casefold()} returns @code{'ss'}.

@item 
The sequence documentation has been substantially rewritten to better
explain the binary/text sequence distinction and to provide specific
documentation sections for the individual builtin sequence types
(bpo-4966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4966}).
@end itemize

@node Novos módulos<11>,Módulos melhorados<11>,Builtin functions and types,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 new-modules}@anchor{10b7}
@subsection Novos módulos


@menu
* faulthandler: faulthandler<4>. 
* ipaddress: ipaddress<6>. 
* lzma: lzma<2>. 

@end menu

@node faulthandler<4>,ipaddress<6>,,Novos módulos<11>
@anchor{whatsnew/3 3 faulthandler}@anchor{10b8}
@subsubsection faulthandler


This new debug module @ref{58,,faulthandler} contains functions to dump Python tracebacks explicitly,
on a fault (a crash like a segmentation fault), after a timeout, or on a user
signal. Call @ref{cbe,,faulthandler.enable()} to install fault handlers for the
@ref{10b9,,SIGSEGV}, @ref{10ba,,SIGFPE}, @ref{10bb,,SIGABRT},
@ref{10bc,,SIGBUS}, and @ref{10bd,,SIGILL} signals.
You can also enable them at startup by setting the 
@geindex PYTHONFAULTHANDLER
@geindex variável de ambiente; PYTHONFAULTHANDLER
@ref{10be,,PYTHONFAULTHANDLER}
environment variable or by using @ref{176,,-X} @code{faulthandler} command line option.

Example of a segmentation fault on 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<6>,lzma<2>,faulthandler<4>,Novos módulos<11>
@anchor{whatsnew/3 3 ipaddress}@anchor{10bf}
@subsubsection ipaddress


The new @ref{80,,ipaddress} module provides tools for creating and manipulating
objects representing IPv4 and IPv6 addresses, networks and interfaces (i.e.
an IP address associated with a specific IP subnet).

(Contributed by Google and Peter Moody in 
@geindex Propostas de Melhorias do Python; PEP 3144
PEP 3144@footnote{https://peps.python.org/pep-3144/}.)

@node lzma<2>,,ipaddress<6>,Novos módulos<11>
@anchor{whatsnew/3 3 lzma}@anchor{10c0}
@subsubsection lzma


The newly added @ref{8a,,lzma} module provides data compression and decompression
using the LZMA algorithm, including support for the @code{.xz} and @code{.lzma}
file formats.

(Contributed by Nadeem Vawda and Per Øyvind Karlsen in bpo-6715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6715}.)

@node Módulos melhorados<11>,Otimizações<10>,Novos módulos<11>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 improved-modules}@anchor{10c1}
@subsection Módulos melhorados


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

@end menu

@node abc<2>,array<5>,,Módulos melhorados<11>
@anchor{whatsnew/3 3 abc}@anchor{10c2}
@subsubsection abc


Improved support for abstract base classes containing descriptors composed with
abstract methods. The recommended approach to declaring abstract descriptors is
now to provide @code{__isabstractmethod__} as a dynamically updated
property. The built-in descriptors have been updated accordingly.


@itemize *

@item 
@ref{10c3,,abc.abstractproperty} has been deprecated, use @ref{194,,property}
with @ref{10c4,,abc.abstractmethod()} instead.

@item 
@ref{10c5,,abc.abstractclassmethod} has been deprecated, use
@ref{166,,classmethod} with @ref{10c4,,abc.abstractmethod()} instead.

@item 
@ref{10c6,,abc.abstractstaticmethod} has been deprecated, use
@ref{416,,staticmethod} with @ref{10c4,,abc.abstractmethod()} instead.
@end itemize

(Contributed by Darren Dale in bpo-11610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11610}.)

@ref{10c7,,abc.ABCMeta.register()} now returns the registered subclass, which means
it can now be used as a class decorator (bpo-10868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10868}).

@node array<5>,base64<4>,abc<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 array}@anchor{10c8}
@subsubsection array


The @ref{7,,array} module supports the long long type using @code{q} and
@code{Q} type codes.

(Contributed by Oren Tirosh and Hirokazu Yamamoto in bpo-1172711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1172711}.)

@node base64<4>,binascii<3>,array<5>,Módulos melhorados<11>
@anchor{whatsnew/3 3 base64}@anchor{10c9}
@subsubsection base64


ASCII-only Unicode strings are now accepted by the decoding functions of the
@ref{e,,base64} modern interface. For example, @code{base64.b64decode('YWJj')}
returns @code{b'abc'}.  (Contributed by Catalin Iacob in bpo-13641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13641}.)

@node binascii<3>,bz2<2>,base64<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 binascii}@anchor{10ca}
@subsubsection binascii


In addition to the binary objects they normally accept, the @code{a2b_} functions
now all also accept ASCII-only strings as input.  (Contributed by Antoine
Pitrou in bpo-13637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13637}.)

@node bz2<2>,codecs<2>,binascii<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 bz2}@anchor{10cb}
@subsubsection bz2


The @ref{13,,bz2} module has been rewritten from scratch. In the process, several
new features have been added:


@itemize *

@item 
New @ref{10cc,,bz2.open()} function: open a bzip2-compressed file in binary or
text mode.

@item 
@ref{86a,,bz2.BZ2File} can now read from and write to arbitrary file-like
objects, by means of its constructor’s `fileobj' argument.

(Contributed by Nadeem Vawda in bpo-5863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5863}.)

@item 
@ref{86a,,bz2.BZ2File} and @ref{10cd,,bz2.decompress()} can now decompress
multi-stream inputs (such as those produced by the @code{pbzip2} tool).
@ref{86a,,bz2.BZ2File} can now also be used to create this type of file, using
the @code{'a'} (append) mode.

(Contributed by Nir Aides in bpo-1625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1625}.)

@item 
@ref{86a,,bz2.BZ2File} now implements all of the @ref{694,,io.BufferedIOBase} API,
except for the @code{detach()} and @code{truncate()} methods.
@end itemize

@node codecs<2>,collections<7>,bz2<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 codecs}@anchor{10ce}
@subsubsection codecs


The @ref{53,,mbcs} codec has been rewritten to handle correctly
@code{replace} and @code{ignore} error handlers on all Windows versions.  The
@ref{53,,mbcs} codec now supports all error handlers, instead of only
@code{replace} to encode and @code{ignore} to decode.

A new Windows-only codec has been added: @code{cp65001} (bpo-13216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13216}). It is the
Windows code page 65001 (Windows UTF-8, @code{CP_UTF8}).  For example, it is used
by @code{sys.stdout} if the console output code page is set to cp65001 (e.g., using
@code{chcp 65001} command).

Multibyte CJK decoders now resynchronize faster.  They only ignore the first
byte of an invalid byte sequence. For example, @code{b'\xff\n'.decode('gb2312',
'replace')} now returns a @code{\n} after the replacement character.

(bpo-12016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12016})

Incremental CJK codec encoders are no longer reset at each call to their
encode() methods. For example:

@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

This example gives @code{b'~@{Np~@}~@{J)~@}~@{l6~@}~@{HK~@}~@{!#~@} Bye.'} with older Python
versions.

(bpo-12100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12100})

The @code{unicode_internal} codec has been deprecated.

@node collections<7>,contextlib<7>,codecs<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 collections}@anchor{10cf}
@subsubsection collections


Addition of a new @ref{c36,,ChainMap} class to allow treating a
number of mappings as a single unit.  (Written by Raymond Hettinger for
bpo-11089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11089}, made public in bpo-11297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11297}.)

The abstract base classes have been moved in a new @ref{1e,,collections.abc}
module, to better differentiate between the abstract and the concrete
collections classes.  Aliases for ABCs are still present in the
@ref{1d,,collections} module to preserve existing imports.  (bpo-11085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11085})

@c XXX addition of __slots__ to ABCs not recorded here: internal detail

The @ref{10d0,,Counter} class now supports the unary @code{+} and @code{-}
operators, as well as the in-place operators @code{+=}, @code{-=}, @code{|=}, and
@code{&=}.  (Contributed by Raymond Hettinger in bpo-13121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13121}.)

@node contextlib<7>,crypt<2>,collections<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 contextlib}@anchor{10d1}
@subsubsection contextlib


@ref{b3b,,ExitStack} now provides a solid foundation for
programmatic manipulation of context managers and similar cleanup
functionality. Unlike the previous @code{contextlib.nested} API (which was
deprecated and removed), the new API is designed to work correctly
regardless of whether context managers acquire their resources in
their @code{__init__} method (for example, file objects) or in their
@code{__enter__} method (for example, synchronisation objects from the
@ref{ed,,threading} module).

(bpo-13585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13585})

@node crypt<2>,curses<5>,contextlib<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 crypt}@anchor{10d2}
@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<5>,datetime<6>,crypt<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 curses}@anchor{10d3}
@subsubsection curses



@itemize *

@item 
If the @ref{2b,,curses} module is linked to the ncursesw library, use Unicode
functions when Unicode strings or characters are passed (e.g.
@code{waddwstr()}), and bytes functions otherwise (e.g. @code{waddstr()}).

@item 
Use the locale encoding instead of @code{utf-8} to encode Unicode strings.

@item 
@ref{10d4,,curses.window} has a new @ref{10d5,,curses.window.encoding} attribute.

@item 
The @ref{10d4,,curses.window} class has a new @ref{10d6,,get_wch()}
method to get a wide character

@item 
The @ref{2b,,curses} module has a new @ref{10d7,,unget_wch()} function to
push a wide character so the next @ref{10d6,,get_wch()} will return
it
@end itemize

(Contributed by Iñigo Serna in bpo-6755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6755}.)

@node datetime<6>,decimal<3>,curses<5>,Módulos melhorados<11>
@anchor{whatsnew/3 3 datetime}@anchor{10d8}
@subsubsection datetime



@itemize *

@item 
Equality comparisons between naive and aware @ref{1cc,,datetime}
instances now return @ref{b49,,False} instead of raising @ref{2c3,,TypeError}
(bpo-15006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15006}).

@item 
New @ref{10d9,,datetime.datetime.timestamp()} method: Return POSIX timestamp
corresponding to the @ref{1cc,,datetime} instance.

@item 
The @ref{caf,,datetime.datetime.strftime()} method supports formatting years
older than 1000.

@item 
The @ref{9d8,,datetime.datetime.astimezone()} method can now be
called without arguments to convert datetime instance to the system
timezone.
@end itemize

@node decimal<3>,email<5>,datetime<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 decimal}@anchor{10da}@anchor{whatsnew/3 3 new-decimal}@anchor{1078}
@subsubsection decimal



@table @asis

@item bpo-7652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7652} - integrate fast native decimal arithmetic.

C-module and libmpdec written by 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.

The following table is meant as an illustration. Benchmarks are available
at @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
* Recursos: Recursos<2>. 
* Mudanças na API: Mudanças na API<2>. 

@end menu

@node Recursos<2>,Mudanças na API<2>,,decimal<3>
@anchor{whatsnew/3 3 id1}@anchor{10db}
@subsubsection Recursos



@itemize *

@item 
The @ref{10dc,,FloatOperation} signal optionally enables stricter
semantics for mixing floats and Decimals.

@item 
If Python is compiled without threads, the C version automatically
disables the expensive thread local context machinery. In this case,
the variable @ref{10dd,,HAVE_THREADS} is set to @code{False}.
@end itemize

@node Mudanças na API<2>,,Recursos<2>,decimal<3>
@anchor{whatsnew/3 3 id2}@anchor{10de}
@subsubsection Mudanças na API



@itemize *

@item 
The C module has the following context limits, depending on the machine
architecture:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32 bits

@tab

64 bits

@item

@ref{10df,,MAX_PREC}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@ref{10e0,,MAX_EMAX}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@ref{10e1,,MIN_EMIN}

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@end multitable

@end quotation

@item 
In the context templates (@ref{10e2,,DefaultContext},
@ref{10e3,,BasicContext} and @ref{10e4,,ExtendedContext})
the magnitude of @ref{10e5,,Emax} and
@ref{10e6,,Emin} has changed to @code{999999}.

@item 
The @ref{29d,,Decimal} constructor in decimal.py does not observe
the context limits and converts values with arbitrary exponents or precision
exactly. Since the C version has internal limits, the following scheme is
used: If possible, values are converted exactly, otherwise
@ref{10e7,,InvalidOperation} is raised and the result is NaN. In the
latter case it is always possible to use @ref{10e8,,create_decimal()}
in order to obtain a rounded or inexact value.

@item 
The power function in decimal.py is always correctly rounded. In the
C version, it is defined in terms of the correctly rounded
@ref{10e9,,exp()} and @ref{10ea,,ln()} functions,
but the final result is only “almost always correctly rounded”.

@item 
In the C version, the context dictionary containing the signals is a
@ref{10eb,,MutableMapping}.  For speed reasons,
@ref{10ec,,flags} and @ref{10ed,,traps} always
refer to the same @ref{10eb,,MutableMapping} that the context
was initialized with. If a new signal dictionary is assigned,
@ref{10ec,,flags} and @ref{10ed,,traps}
are updated with the new values, but they do not reference the RHS
dictionary.

@item 
Pickling a @ref{10ee,,Context} produces a different output in order
to have a common interchange format for the Python and C versions.

@item 
The order of arguments in the @ref{10ee,,Context} constructor has been
changed to match the order displayed by @ref{800,,repr()}.

@item 
The @code{watchexp} parameter in the @ref{10ef,,quantize()} method
is deprecated.
@end itemize

@node email<5>,ftplib<3>,decimal<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 email}@anchor{10f0}@anchor{whatsnew/3 3 new-email}@anchor{1079}
@subsubsection email


@menu
* Policy Framework:: 
* Provisional Policy with New Header API:: 
* Other API Changes:: 

@end menu

@node Policy Framework,Provisional Policy with New Header API,,email<5>
@anchor{whatsnew/3 3 policy-framework}@anchor{10f1}
@subsubsection Policy Framework


The email package now has a @ref{4f,,policy} framework.  A
@ref{10f2,,Policy} is an object with several methods and properties
that control how the email package behaves.  The primary policy for Python 3.3
is the @ref{10f3,,Compat32} policy, which provides backward
compatibility with the email package in Python 3.2.  A @code{policy} can be
specified when an email message is parsed by a @ref{4e,,parser}, or when a
@ref{27c,,Message} object is created, or when an email is
serialized using a @ref{40,,generator}.  Unless overridden, a policy passed
to a @code{parser} is inherited by all the @code{Message} object and sub-objects
created by the @code{parser}.  By default a @code{generator} will use the policy of
the @code{Message} object it is serializing.  The default policy is
@ref{cb8,,compat32}.

The minimum set of controls implemented by all @code{policy} objects are:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

max_line_length

@tab

The maximum length, excluding the linesep character(s),
individual lines may have when a @code{Message} is
serialized.  Defaults to 78.

@item

linesep

@tab

The character used to separate individual lines when a
@code{Message} is serialized.  Defaults to @code{\n}.

@item

cte_type

@tab

@code{7bit} or @code{8bit}.  @code{8bit} applies only to a
@code{Bytes} @code{generator}, and means that non-ASCII may
be used where allowed by the protocol (or where it
exists in the original input).

@item

raise_on_defect

@tab

Causes a @code{parser} to raise error when defects are
encountered instead of adding them to the @code{Message}
object’s @code{defects} list.

@end multitable


A new policy instance, with new settings, is created using the
@ref{10f4,,clone()} method of policy objects.  @code{clone} takes
any of the above controls as keyword arguments.  Any control not specified in
the call retains its default value.  Thus you can create a policy that uses
@code{\r\n} linesep characters like this:

@example
mypolicy = compat32.clone(linesep='\r\n')
@end example

Policies can be used to make the generation of messages in the format needed by
your application simpler.  Instead of having to remember to specify
@code{linesep='\r\n'} in all the places you call a @code{generator}, you can specify
it once, when you set the policy used by the @code{parser} or the @code{Message},
whichever your program uses to create @code{Message} objects.  On the other hand,
if you need to generate messages in multiple forms, you can still specify the
parameters in the appropriate @code{generator} call.  Or you can have custom
policy instances for your different cases, and pass those in when you create
the @code{generator}.

@node Provisional Policy with New Header API,Other API Changes,Policy Framework,email<5>
@anchor{whatsnew/3 3 provisional-policy-with-new-header-api}@anchor{10f5}
@subsubsection Provisional Policy with New Header API


While the policy framework is worthwhile all by itself, the main motivation for
introducing it is to allow the creation of new policies that implement new
features for the email package in a way that maintains backward compatibility
for those who do not use the new policies.  Because the new policies introduce a
new API, we are releasing them in Python 3.3 as a @ref{107a,,provisional policy}.  Backwards incompatible changes (up to and including
removal of the code) may occur if deemed necessary by the core developers.

The new policies are instances of @ref{10f6,,EmailPolicy},
and add the following additional controls:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

refold_source

@tab

Controls whether or not headers parsed by a
@ref{4e,,parser} are refolded by the
@ref{40,,generator}.  It can be @code{none}, @code{long},
or @code{all}.  The default is @code{long}, which means that
source headers with a line longer than
@code{max_line_length} get refolded.  @code{none} means no
line get refolded, and @code{all} means that all lines
get refolded.

@item

header_factory

@tab

A callable that take a @code{name} and @code{value} and
produces a custom header object.

@end multitable


The @code{header_factory} is the key to the new features provided by the new
policies.  When one of the new policies is used, any header retrieved from
a @code{Message} object is an object produced by the @code{header_factory}, and any
time you set a header on a @code{Message} it becomes an object produced by
@code{header_factory}.  All such header objects have a @code{name} attribute equal
to the header name.  Address and Date headers have additional attributes
that give you access to the parsed data of the header.  This means you can now
do things like this:

@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

You will note that the unicode display name is automatically encoded as
@code{utf-8} when the message is serialized, but that when the header is accessed
directly, you get the unicode version.  This eliminates any need to deal with
the @ref{41,,email.header} @ref{10f7,,decode_header()} or
@ref{10f8,,make_header()} functions.

You can also create addresses from parts:

@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

Decoding to unicode is done automatically:

@example
>>> m2 = message_from_string(str(m))
>>> m2['to']
'Éric <foo@@example.com>'
@end example

When you parse a message, you can use the @code{addresses} and @code{groups}
attributes of the header objects to access the groups and individual
addresses:

@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

In summary, if you use one of the new policies, header manipulation works the
way it ought to:  your application works with unicode strings, and the email
package transparently encodes and decodes the unicode to and from the RFC
standard Content Transfer Encodings.

@node Other API Changes,,Provisional Policy with New Header API,email<5>
@anchor{whatsnew/3 3 other-api-changes}@anchor{10f9}
@subsubsection Other API Changes


New @ref{10fa,,BytesHeaderParser}, added to the @ref{4e,,parser}
module to complement @ref{10fb,,HeaderParser} and complete the Bytes
API.

New utility functions:


@itemize *

@item 
@ref{10fc,,format_datetime()}: given a @ref{1cc,,datetime},
produce a string formatted for use in an email header.

@item 
@ref{10fd,,parsedate_to_datetime()}: given a date string from
an email header, convert it into an aware @ref{1cc,,datetime},
or a naive @ref{1cc,,datetime} if the offset is @code{-0000}.

@item 
@ref{2c4,,localtime()}: With no argument, returns the
current local time as an aware @ref{1cc,,datetime} using the local
@ref{10fe,,timezone}.  Given an aware @ref{1cc,,datetime},
converts it into an aware @ref{1cc,,datetime} using the
local @ref{10fe,,timezone}.
@end itemize

@node ftplib<3>,functools<6>,email<5>,Módulos melhorados<11>
@anchor{whatsnew/3 3 ftplib}@anchor{10ff}
@subsubsection ftplib



@itemize *

@item 
@ref{900,,ftplib.FTP} now accepts a @code{source_address} keyword argument to
specify the @code{(host, port)} to use as the source address in the bind call
when creating the outgoing socket.  (Contributed by Giampaolo Rodolà
in bpo-8594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8594}.)

@item 
The @ref{901,,FTP_TLS} class now provides a new
@ref{1100,,ccc()} function to revert control channel back to
plaintext.  This can be useful to take advantage of firewalls that know how
to handle NAT with non-secure FTP without opening fixed ports.  (Contributed
by Giampaolo Rodolà in bpo-12139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12139}.)

@item 
Added @ref{1101,,ftplib.FTP.mlsd()} method which provides a parsable directory
listing format and deprecates @ref{1102,,ftplib.FTP.nlst()} and
@ref{1103,,ftplib.FTP.dir()}.  (Contributed by Giampaolo Rodolà in bpo-11072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11072}.)
@end itemize

@node functools<6>,gc<6>,ftplib<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 functools}@anchor{1104}
@subsubsection functools


The @ref{9f7,,functools.lru_cache()} decorator now accepts a @code{typed} keyword
argument (that defaults to @code{False} to ensure that it caches values of
different types that compare equal in separate cache slots.  (Contributed
by Raymond Hettinger in bpo-13227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13227}.)

@node gc<6>,hmac<4>,functools<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 gc}@anchor{1105}
@subsubsection gc


It is now possible to register callbacks invoked by the garbage collector
before and after collection using the new @ref{1106,,callbacks} list.

@node hmac<4>,http<4>,gc<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 hmac}@anchor{1107}
@subsubsection hmac


A new @ref{1108,,compare_digest()} function has been added to prevent side
channel attacks on digests through timing analysis.  (Contributed by Nick
Coghlan and Christian Heimes in bpo-15061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15061}.)

@node http<4>,html<2>,hmac<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 http}@anchor{1109}
@subsubsection http


@ref{110a,,http.server.BaseHTTPRequestHandler} now buffers the headers and writes
them all at once when @ref{110b,,end_headers()} is
called.  A new method @ref{110c,,flush_headers()}
can be used to directly manage when the accumulated headers are sent.
(Contributed by Andrew Schaaf in bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709}.)

@ref{72,,http.server} now produces valid @code{HTML 4.01 strict} output.
(Contributed by Ezio Melotti in bpo-13295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13295}.)

@ref{110d,,http.client.HTTPResponse} now has a
@ref{110e,,readinto()} method, which means it can be used
as an @ref{110f,,io.RawIOBase} class.  (Contributed by John Kuhn in
bpo-13464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13464}.)

@node html<2>,imaplib<3>,http<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 html}@anchor{1110}
@subsubsection html


@ref{87b,,html.parser.HTMLParser} is now able to parse broken markup without
raising errors, therefore the `strict' argument of the constructor and the
@code{HTMLParseError} exception are now deprecated.
The ability to parse broken markup is the result of a number of bug fixes that
are also available on the latest bug fix releases of Python 2.7/3.2.
(Contributed by Ezio Melotti in bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}, and 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}.)

A new @ref{1111,,html5} dictionary that maps HTML5 named character
references to the equivalent Unicode character(s) (e.g. @code{html5['gt;'] ==
'>'}) has been added to the @ref{6c,,html.entities} module.  The dictionary is
now also used by @ref{87b,,HTMLParser}.  (Contributed by Ezio
Melotti in bpo-11113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11113} and bpo-15156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15156}.)

@node imaplib<3>,inspect<9>,html<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 imaplib}@anchor{1112}
@subsubsection imaplib


The @ref{90a,,IMAP4_SSL} constructor now accepts an SSLContext
parameter to control parameters of the secure channel.

(Contributed by Sijin Joseph in bpo-8808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8808}.)

@node inspect<9>,io<6>,imaplib<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 inspect}@anchor{1113}
@subsubsection inspect


A new @ref{1114,,getclosurevars()} function has been added. This function
reports the current binding of all names referenced from the function body and
where those names were resolved, making it easier to verify correct internal
state when testing code that relies on stateful closures.

(Contributed by Meador Inge and Nick Coghlan in bpo-13062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13062}.)

A new @ref{1115,,getgeneratorlocals()} function has been added. This
function reports the current binding of local variables in the generator’s
stack frame, making it easier to verify correct internal state when testing
generators.

(Contributed by Meador Inge in bpo-15153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15153}.)

@node io<6>,itertools<6>,inspect<9>,Módulos melhorados<11>
@anchor{whatsnew/3 3 io}@anchor{1116}
@subsubsection io


The @ref{51d,,open()} function has a new @code{'x'} mode that can be used to
exclusively create a new file, and raise a @ref{1056,,FileExistsError} if the file
already exists. It is based on the C11 ‘x’ mode to fopen().

(Contributed by David Townshend in bpo-12760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12760}.)

The constructor of the @ref{7bc,,TextIOWrapper} class has a new
`write_through' optional argument. If `write_through' is @code{True}, calls to
@code{write()} are guaranteed not to be buffered: any data
written on the @ref{7bc,,TextIOWrapper} object is immediately handled to its
underlying binary buffer.

@node itertools<6>,logging<7>,io<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 itertools}@anchor{1117}
@subsubsection itertools


@ref{a05,,accumulate()} now takes an optional @code{func} argument for
providing a user-supplied binary function.

@node logging<7>,math<9>,itertools<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 logging}@anchor{1118}
@subsubsection logging


The @ref{a08,,basicConfig()} function now supports an optional @code{handlers}
argument taking an iterable of handlers to be added to the root logger.

A class level attribute @code{append_nul} has
been added to @ref{65c,,SysLogHandler} to allow control of the
appending of the @code{NUL} (@code{\000}) byte to syslog records, since for some
daemons it is required while for others it is passed through to the log.

@node math<9>,mmap<4>,logging<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 math}@anchor{1119}
@subsubsection math


The @ref{8e,,math} module has a new function, @ref{111a,,log2()},  which returns
the base-2 logarithm of `x'.

(Written by Mark Dickinson in bpo-11888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11888}.)

@node mmap<4>,multiprocessing<8>,math<9>,Módulos melhorados<11>
@anchor{whatsnew/3 3 mmap}@anchor{111b}
@subsubsection mmap


The @ref{111c,,read()} method is now more compatible with other file-like
objects: if the argument is omitted or specified as @code{None}, it returns the
bytes from the current file position to the end of the mapping.  (Contributed
by Petri Lehtinen in bpo-12021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12021}.)

@node multiprocessing<8>,nntplib<2>,mmap<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 multiprocessing}@anchor{111d}
@subsubsection multiprocessing


The new @ref{111e,,multiprocessing.connection.wait()} function allows polling
multiple objects (such as connections, sockets and pipes) with a timeout.
(Contributed by Richard Oudkerk in bpo-12328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12328}.)

@ref{111f,,multiprocessing.connection.Connection} objects can now be transferred
over multiprocessing connections.
(Contributed by Richard Oudkerk in bpo-4892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4892}.)

@ref{b6f,,multiprocessing.Process} now accepts a @code{daemon} keyword argument
to override the default behavior of inheriting the @code{daemon} flag from
the parent process (bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064}).

New attribute @ref{1120,,multiprocessing.Process.sentinel} allows a
program to wait on multiple @ref{b6f,,Process} objects at one
time using the appropriate OS primitives (for example, @ref{c1,,select} on
posix systems).

New methods @ref{1121,,multiprocessing.pool.Pool.starmap()} and
@ref{1122,,starmap_async()} provide
@ref{1123,,itertools.starmap()} equivalents to the existing
@ref{1124,,multiprocessing.pool.Pool.map()} and
@ref{1125,,map_async()} functions.  (Contributed by Hynek
Schlawack in bpo-12708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12708}.)

@node nntplib<2>,os<12>,multiprocessing<8>,Módulos melhorados<11>
@anchor{whatsnew/3 3 nntplib}@anchor{1126}
@subsubsection nntplib


The @code{nntplib.NNTP} class now supports the context management protocol to
unconditionally consume @ref{108e,,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

(Contributed by Giampaolo Rodolà in bpo-9795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9795}.)

@node os<12>,pdb<7>,nntplib<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 os}@anchor{1127}
@subsubsection os



@itemize *

@item 
The @ref{a1,,os} module has a new @ref{1128,,pipe2()} function that makes it
possible to create a pipe with @ref{10b5,,O_CLOEXEC} or
@ref{e68,,O_NONBLOCK} flags set atomically. This is especially useful to
avoid race conditions in multi-threaded programs.

@item 
The @ref{a1,,os} module has a new @ref{b21,,sendfile()} function which provides
an efficient “zero-copy” way for copying data from one file (or socket)
descriptor to another. The phrase “zero-copy” refers to the fact that all of
the copying of data between the two descriptors is done entirely by the
kernel, with no copying of data into userspace buffers. @ref{b21,,sendfile()}
can be used to efficiently copy data from a file on disk to a network socket,
e.g. for downloading a file.

(Patch submitted by Ross Lagerwall and Giampaolo Rodolà in bpo-10882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10882}.)

@item 
To avoid race conditions like symlink attacks and issues with temporary
files and directories, it is more reliable (and also faster) to manipulate
file descriptors instead of file names. Python 3.3 enhances existing functions
and introduces new functions to work on file descriptors (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 
The @ref{a1,,os} module has a new @ref{b71,,fwalk()} function similar to
@ref{4a9,,walk()} except that it also yields file descriptors referring to the
directories visited. This is especially useful to avoid symlink races.

@item 
The following functions get new optional `dir_fd' (@ref{1129,,paths relative to directory descriptors}) and/or `follow_symlinks' (@ref{112a,,not following symlinks}):
@ref{112b,,access()}, @ref{112c,,chflags()}, @ref{21b,,chmod()}, @ref{112d,,chown()},
@ref{112e,,link()}, @ref{4a1,,lstat()}, @ref{21d,,mkdir()}, @ref{db8,,mkfifo()},
@ref{db9,,mknod()}, @ref{dba,,open()}, @ref{926,,readlink()}, @ref{112f,,remove()},
@ref{1130,,rename()}, @ref{1131,,replace()}, @ref{1132,,rmdir()}, @ref{4a0,,stat()},
@ref{1133,,symlink()}, @ref{1134,,unlink()}, @ref{1135,,utime()}.  Platform
support for using these parameters can be checked via the sets
@ref{1136,,os.supports_dir_fd} and @ref{1137,,os.supports_follow_symlinks}.

@item 
The following functions now support a file descriptor for their path argument:
@ref{60d,,chdir()}, @ref{21b,,chmod()}, @ref{112d,,chown()},
@ref{1138,,execve()}, @ref{1139,,listdir()}, @ref{113a,,pathconf()}, @ref{a18,,exists()},
@ref{4a0,,stat()}, @ref{113b,,statvfs()}, @ref{1135,,utime()}.  Platform support
for this can be checked via the @ref{113c,,os.supports_fd} set.
@end itemize

@item 
@ref{112b,,access()} accepts an @code{effective_ids} keyword argument to turn on
using the effective uid/gid rather than the real uid/gid in the access check.
Platform support for this can be checked via the
@ref{113d,,supports_effective_ids} set.

@item 
The @ref{a1,,os} module has two new functions: @ref{113e,,getpriority()} and
@ref{113f,,setpriority()}. They can be used to get or set process
niceness/priority in a fashion similar to @ref{1140,,os.nice()} but extended to all
processes instead of just the current one.

(Patch submitted by Giampaolo Rodolà in bpo-10784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10784}.)

@item 
The new @ref{1131,,os.replace()} function allows cross-platform renaming of a
file with overwriting the destination.  With @ref{1130,,os.rename()}, an existing
destination file is overwritten under POSIX, but raises an error under
Windows.
(Contributed by Antoine Pitrou in bpo-8828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8828}.)

@item 
The stat family of functions (@ref{4a0,,stat()}, @ref{db4,,fstat()},
and @ref{4a1,,lstat()}) now support reading a file’s timestamps
with nanosecond precision.  Symmetrically, @ref{1135,,utime()}
can now write file timestamps with nanosecond precision.  (Contributed by
Larry Hastings in bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127}.)

@item 
The new @ref{1141,,os.get_terminal_size()} function queries the size of the
terminal attached to a file descriptor. See also
@ref{1142,,shutil.get_terminal_size()}.
(Contributed by Zbigniew Jędrzejewski-Szmek in bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609}.)
@end itemize

@c XXX sort out this mess after beta1


@itemize *

@item 
New functions to support Linux extended attributes (bpo-12720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12720}):
@ref{1143,,getxattr()}, @ref{1144,,listxattr()}, @ref{1145,,removexattr()},
@ref{1146,,setxattr()}.

@item 
New interface to the scheduler. These functions
control how a process is allocated CPU time by the operating system. New
functions:
@ref{1147,,sched_get_priority_max()}, @ref{1148,,sched_get_priority_min()},
@ref{1149,,sched_getaffinity()}, @ref{114a,,sched_getparam()},
@ref{114b,,sched_getscheduler()}, @ref{114c,,sched_rr_get_interval()},
@ref{114d,,sched_setaffinity()}, @ref{114e,,sched_setparam()},
@ref{114f,,sched_setscheduler()}, @ref{1150,,sched_yield()},

@item 
New functions to control the file system:


@itemize *

@item 
@ref{dbb,,posix_fadvise()}: Announces an intention to access data in a
specific pattern thus allowing the kernel to make optimizations.

@item 
@ref{dbc,,posix_fallocate()}: Ensures that enough disk space is allocated
for a file.

@item 
@ref{1151,,sync()}: Force write of everything to disk.
@end itemize

@item 
Additional new  posix functions:


@itemize *

@item 
@ref{1152,,lockf()}: Apply, test or remove a POSIX lock on an open file descriptor.

@item 
@ref{b75,,pread()}: Read from a file descriptor at an offset, the file
offset remains unchanged.

@item 
@ref{b78,,pwrite()}: Write to a file descriptor from an offset, leaving
the file offset unchanged.

@item 
@ref{b74,,readv()}: Read from a file descriptor into a number of writable buffers.

@item 
@ref{e69,,truncate()}: Truncate the file corresponding to `path', so that
it is at most `length' bytes in size.

@item 
@ref{dc1,,waitid()}: Wait for the completion of one or more child processes.

@item 
@ref{b77,,writev()}: Write the contents of `buffers' to a file descriptor,
where `buffers' is an arbitrary sequence of buffers.

@item 
@ref{1153,,getgrouplist()} (bpo-9344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9344}): Return list of group ids that
specified user belongs to.
@end itemize

@item 
@ref{1154,,times()} and @ref{1155,,uname()}: Return type changed from a tuple to
a tuple-like object with named attributes.

@item 
Some platforms now support additional constants for the @ref{1156,,lseek()}
function, such as @code{os.SEEK_HOLE} and @code{os.SEEK_DATA}.

@item 
New constants @ref{1157,,RTLD_LAZY}, @ref{1158,,RTLD_NOW},
@ref{1159,,RTLD_GLOBAL}, @ref{115a,,RTLD_LOCAL}, @ref{115b,,RTLD_NODELETE},
@ref{115c,,RTLD_NOLOAD}, and @ref{115d,,RTLD_DEEPBIND} are available on
platforms that support them.   These are for use with the
@ref{115e,,sys.setdlopenflags()} function, and supersede the similar constants
defined in @ref{2a,,ctypes} and @code{DLFCN}.  (Contributed by Victor Stinner
in bpo-13226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13226}.)

@item 
@ref{1133,,os.symlink()} now accepts (and ignores) the @code{target_is_directory}
keyword argument on non-Windows platforms, to ease cross-platform support.
@end itemize

@node pdb<7>,pickle<5>,os<12>,Módulos melhorados<11>
@anchor{whatsnew/3 3 pdb}@anchor{115f}
@subsubsection pdb


Tab-completion is now available not only for command names, but also their
arguments.  For example, for the @code{break} command, function and file names
are completed.

(Contributed by Georg Brandl in bpo-14210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14210})

@node pickle<5>,pydoc<5>,pdb<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 pickle}@anchor{1160}
@subsubsection pickle


@ref{a28,,pickle.Pickler} objects now have an optional
@ref{1161,,dispatch_table} attribute allowing per-pickler
reduction functions to be set.

(Contributed by Richard Oudkerk in bpo-14166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14166}.)

@node pydoc<5>,re<9>,pickle<5>,Módulos melhorados<11>
@anchor{whatsnew/3 3 pydoc}@anchor{1162}
@subsubsection pydoc


The Tk GUI and the @code{serve()} function have been removed from the
@ref{b5,,pydoc} module: @code{pydoc -g} and @code{serve()} have been deprecated
in Python 3.2.

@node re<9>,sched,pydoc<5>,Módulos melhorados<11>
@anchor{whatsnew/3 3 re}@anchor{1163}
@subsubsection re


@ref{44c,,str} regular expressions now support @code{\u} and @code{\U} escapes.

(Contributed by Serhiy Storchaka in bpo-3665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3665}.)

@node sched,select<2>,re<9>,Módulos melhorados<11>
@anchor{whatsnew/3 3 sched}@anchor{1164}
@subsubsection sched



@itemize *

@item 
@ref{1165,,run()} now accepts a `blocking' parameter which when
set to false makes the method execute the scheduled events due to expire
soonest (if any) and then return immediately.
This is useful in case you want to use the @ref{1166,,scheduler} in
non-blocking applications.  (Contributed by Giampaolo Rodolà in bpo-13449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13449}.)

@item 
@ref{1166,,scheduler} class can now be safely used in multi-threaded
environments.  (Contributed by Josiah Carlson and Giampaolo Rodolà in
bpo-8684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8684}.)

@item 
`timefunc' and `delayfunct' parameters of @ref{1166,,scheduler} class
constructor are now optional and defaults to @ref{254,,time.time()} and
@ref{69d,,time.sleep()} respectively.  (Contributed by Chris Clark in
bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)

@item 
@ref{1167,,enter()} and @ref{1168,,enterabs()}
`argument' parameter is now optional.  (Contributed by Chris Clark in
bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)

@item 
@ref{1167,,enter()} and @ref{1168,,enterabs()}
now accept a `kwargs' parameter.  (Contributed by Chris Clark in
bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245}.)
@end itemize

@node select<2>,shlex<3>,sched,Módulos melhorados<11>
@anchor{whatsnew/3 3 select}@anchor{1169}
@subsubsection select


Solaris and derivative platforms have a new class @ref{fca,,select.devpoll}
for high performance asynchronous sockets via @code{/dev/poll}.
(Contributed by Jesús Cea Avión in bpo-6397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6397}.)

@node shlex<3>,shutil<7>,select<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 shlex}@anchor{116a}
@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{27d,,quote()} properly escapes all characters in a string
that might be otherwise given special meaning by the shell.

@node shutil<7>,signal<4>,shlex<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 shutil}@anchor{116b}
@subsubsection shutil



@itemize *

@item 
Novas Funções:


@itemize *

@item 
@ref{116c,,disk_usage()}: provides total, used and free disk space
statistics.  (Contributed by Giampaolo Rodolà in bpo-12442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12442}.)

@item 
@ref{240,,chown()}: allows one to change user and/or group of the given
path also specifying the user/group names and not only their numeric
ids.  (Contributed by Sandro Tosi in bpo-12191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12191}.)

@item 
@ref{1142,,shutil.get_terminal_size()}: returns the size of the terminal window
to which the interpreter is attached.  (Contributed by Zbigniew
Jędrzejewski-Szmek in bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609}.)
@end itemize

@item 
@ref{a65,,copy2()} and @ref{116d,,copystat()} now preserve file
timestamps with nanosecond precision on platforms that support it.
They also preserve file “extended attributes” on Linux.  (Contributed
by Larry Hastings in bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127} and  bpo-15238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15238}.)

@item 
Several functions now take an optional @code{symlinks} argument: when that
parameter is true, symlinks aren’t dereferenced and the operation instead
acts on the symlink itself (or creates one, if relevant).
(Contributed by Hynek Schlawack in bpo-12715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12715}.)

@item 
When copying files to a different file system, @ref{e82,,move()} now
handles symlinks the way the posix @code{mv} command does, recreating the
symlink rather than copying the target file contents.  (Contributed by
Jonathan Niehof in bpo-9993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9993}.)  @ref{e82,,move()} now also returns
the @code{dst} argument as its result.

@item 
@ref{301,,rmtree()} is now resistant to symlink attacks on platforms
which support the new @code{dir_fd} parameter in @ref{dba,,os.open()} and
@ref{1134,,os.unlink()}.  (Contributed by Martin von Löwis and Hynek Schlawack
in bpo-4489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4489}.)
@end itemize

@node signal<4>,smtpd<4>,shutil<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 signal}@anchor{116e}
@subsubsection signal



@itemize *

@item 
The @ref{c6,,signal} module has new functions:


@itemize *

@item 
@ref{116f,,pthread_sigmask()}: fetch and/or change the signal mask of the
calling thread (Contributed by Jean-Paul Calderone in bpo-8407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8407});

@item 
@ref{1170,,pthread_kill()}: send a signal to a thread;

@item 
@ref{1171,,sigpending()}: examine pending functions;

@item 
@ref{1172,,sigwait()}: wait a signal;

@item 
@ref{dd3,,sigwaitinfo()}: wait for a signal, returning detailed
information about it;

@item 
@ref{dd2,,sigtimedwait()}: like @ref{dd3,,sigwaitinfo()} but with a
timeout.
@end itemize

@item 
The signal handler writes the signal number as a single byte instead of
a nul byte into the wakeup file descriptor. So it is possible to wait more
than one signal and know which signals were raised.

@item 
@ref{1173,,signal.signal()} and @ref{1174,,signal.siginterrupt()} raise an OSError,
instead of a RuntimeError: OSError has an errno attribute.
@end itemize

@node smtpd<4>,smtplib<4>,signal<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 smtpd}@anchor{1175}
@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.

(Initial @code{ELHO} support by Alberto Trevino.  Size extension by Juhana
Jauhiainen.  Substantial additional work on the patch contributed by Michele
Orrù and Dan Boswell.  bpo-8739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8739})

@node smtplib<4>,socket<10>,smtpd<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 smtplib}@anchor{1176}
@subsubsection smtplib


The @ref{934,,SMTP}, @ref{935,,SMTP_SSL}, and
@ref{936,,LMTP} classes now accept a @code{source_address} keyword argument
to specify the @code{(host, port)} to use as the source address in the bind call
when creating the outgoing socket.  (Contributed by Paulo Scardine in
bpo-11281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11281}.)

@ref{934,,SMTP} now supports the context management protocol, allowing an
@code{SMTP} instance to be used in a @code{with} statement.  (Contributed
by Giampaolo Rodolà in bpo-11289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11289}.)

The @ref{935,,SMTP_SSL} constructor and the @ref{1177,,starttls()}
method now accept an SSLContext parameter to control parameters of the secure
channel.  (Contributed by Kasun Herath in bpo-8809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8809}.)

@node socket<10>,socketserver<3>,smtplib<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 socket}@anchor{1178}
@subsubsection socket



@itemize *

@item 
The @ref{dc9,,socket} class now exposes additional methods to process
ancillary data when supported by the underlying platform:


@itemize *

@item 
@ref{476,,sendmsg()}

@item 
@ref{dce,,recvmsg()}

@item 
@ref{1179,,recvmsg_into()}
@end itemize

(Contributed by David Watson in bpo-6560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6560}, based on an earlier patch by
Heiko Wundram)

@item 
The @ref{dc9,,socket} class now supports the PF_CAN protocol family
(@indicateurl{https://en.wikipedia.org/wiki/Socketcan}), on Linux
(@indicateurl{https://lwn.net/Articles/253425}).

(Contributed by Matthias Fuchs, updated by Tiago Gonçalves in bpo-10141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10141}.)

@item 
The @ref{dc9,,socket} class now supports the PF_RDS protocol family
(@indicateurl{https://en.wikipedia.org/wiki/Reliable_Datagram_Sockets} and
https://oss.oracle.com/projects/rds@footnote{https://web.archive.org/web/20130115155505/https://oss.oracle.com/projects/rds/}).

@item 
The @ref{dc9,,socket} class now supports the @code{PF_SYSTEM} protocol
family on OS X.  (Contributed by Michael Goderbauer in bpo-13777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13777}.)

@item 
New function @ref{117a,,sethostname()} allows the hostname to be set
on Unix systems if the calling process has sufficient privileges.
(Contributed by Ross Lagerwall in bpo-10866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10866}.)
@end itemize

@node socketserver<3>,sqlite3<10>,socket<10>,Módulos melhorados<11>
@anchor{whatsnew/3 3 socketserver}@anchor{117b}
@subsubsection socketserver


@ref{117c,,BaseServer} now has an overridable method
@ref{117d,,service_actions()} that is called by the
@ref{117e,,serve_forever()} method in the service loop.
@ref{b90,,ForkingMixIn} now uses this to clean up zombie
child processes.  (Contributed by Justin Warkentin in bpo-11109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11109}.)

@node sqlite3<10>,ssl<11>,socketserver<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 sqlite3}@anchor{117f}
@subsubsection sqlite3


New @ref{245,,sqlite3.Connection} method
@ref{2ad,,set_trace_callback()} can be used to capture a trace of
all sql commands processed by sqlite.  (Contributed by Torsten Landschoff
in bpo-11688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11688}.)

@node ssl<11>,stat<2>,sqlite3<10>,Módulos melhorados<11>
@anchor{whatsnew/3 3 ssl}@anchor{1180}
@subsubsection ssl



@itemize *

@item 
The @ref{d0,,ssl} module has two new random generation functions:


@itemize *

@item 
@ref{524,,RAND_bytes()}: generate cryptographically strong
pseudo-random bytes.

@item 
@code{RAND_pseudo_bytes()}: generate pseudo-random bytes.
@end itemize

(Contributed by Victor Stinner in bpo-12049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12049}.)

@item 
The @ref{d0,,ssl} module now exposes a finer-grained exception hierarchy
in order to make it easier to inspect the various kinds of errors.
(Contributed by Antoine Pitrou in bpo-11183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11183}.)

@item 
@ref{295,,load_cert_chain()} now accepts a `password' argument
to be used if the private key is encrypted.
(Contributed by Adam Simpkins in bpo-12803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12803}.)

@item 
Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is
now supported through the @ref{1181,,load_dh_params()} and
@ref{1182,,set_ecdh_curve()} methods.
(Contributed by Antoine Pitrou in bpo-13626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13626} and bpo-13627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13627}.)

@item 
SSL sockets have a new @ref{1183,,get_channel_binding()} method
allowing the implementation of certain authentication mechanisms such as
SCRAM-SHA-1-PLUS.  (Contributed by Jacek Konieczny in bpo-12551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12551}.)

@item 
You can query the SSL compression algorithm used by an SSL socket, thanks
to its new @ref{1184,,compression()} method.  The new attribute
@ref{1185,,OP_NO_COMPRESSION} can be used to disable compression.
(Contributed by Antoine Pitrou in bpo-13634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13634}.)

@item 
Support has been added for the Next Protocol Negotiation extension using
the @ref{302,,ssl.SSLContext.set_npn_protocols()} method.
(Contributed by Colin Marc in bpo-14204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14204}.)

@item 
SSL errors can now be introspected more easily thanks to
@ref{1186,,library} and @ref{1187,,reason} attributes.
(Contributed by Antoine Pitrou in bpo-14837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14837}.)

@item 
The @ref{83f,,get_server_certificate()} function now supports IPv6.
(Contributed by Charles-François Natali in bpo-11811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11811}.)

@item 
New attribute @ref{1188,,OP_CIPHER_SERVER_PREFERENCE} allows setting
SSLv3 server sockets to use the server’s cipher ordering preference rather
than the client’s (bpo-13635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13635}).
@end itemize

@node stat<2>,struct<3>,ssl<11>,Módulos melhorados<11>
@anchor{whatsnew/3 3 stat}@anchor{1189}
@subsubsection stat


The undocumented tarfile.filemode function has been moved to
@ref{118a,,stat.filemode()}. It can be used to convert a file’s mode to a string of
the form ‘-rwxrwxrwx’.

(Contributed by Giampaolo Rodolà in bpo-14807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14807}.)

@node struct<3>,subprocess<6>,stat<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 struct}@anchor{118b}
@subsubsection struct


The @ref{d5,,struct} module now supports @code{ssize_t} and @code{size_t} via the
new codes @code{n} and @code{N}, respectively.  (Contributed by Antoine Pitrou
in bpo-3163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3163}.)

@node subprocess<6>,sys<13>,struct<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 subprocess}@anchor{118c}
@subsubsection subprocess


Command strings can now be bytes objects on posix platforms.  (Contributed by
Victor Stinner in bpo-8513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8513}.)

A new constant @ref{118d,,DEVNULL} allows suppressing output in a
platform-independent fashion.  (Contributed by Ross Lagerwall in
bpo-5870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5870}.)

@node sys<13>,tarfile<9>,subprocess<6>,Módulos melhorados<11>
@anchor{whatsnew/3 3 sys}@anchor{118e}
@subsubsection sys


The @ref{d9,,sys} module has a new @ref{118f,,thread_info} @ref{64e,,named tuple} holding information about the thread implementation
(bpo-11223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11223}).

@node tarfile<9>,tempfile<4>,sys<13>,Módulos melhorados<11>
@anchor{whatsnew/3 3 tarfile}@anchor{1190}
@subsubsection tarfile


@ref{de,,tarfile} now supports @code{lzma} encoding via the @ref{8a,,lzma} module.
(Contributed by Lars Gustäbel in bpo-5689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5689}.)

@node tempfile<4>,textwrap<2>,tarfile<9>,Módulos melhorados<11>
@anchor{whatsnew/3 3 tempfile}@anchor{1191}
@subsubsection tempfile


@ref{693,,tempfile.SpooledTemporaryFile}'s @code{truncate()} method now accepts
a @code{size} parameter.  (Contributed by Ryan Kelly in bpo-9957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9957}.)

@node textwrap<2>,threading<8>,tempfile<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 textwrap}@anchor{1192}
@subsubsection textwrap


The @ref{ec,,textwrap} module has a new @ref{276,,indent()} that makes
it straightforward to add a common prefix to selected lines in a block
of text  (bpo-13857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13857}).

@node threading<8>,time<8>,textwrap<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 threading}@anchor{1193}
@subsubsection threading


@ref{1194,,threading.Condition}, @ref{1195,,threading.Semaphore},
@ref{1196,,threading.BoundedSemaphore}, @ref{1197,,threading.Event}, and
@ref{1198,,threading.Timer}, all of which used to be factory functions returning a
class instance, are now classes and may be subclassed.  (Contributed by Éric
Araujo in bpo-10968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10968}.)

The @ref{953,,threading.Thread} constructor now accepts a @code{daemon} keyword
argument to override the default behavior of inheriting the @code{daemon} flag
value from the parent thread (bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064}).

The formerly private function @code{_thread.get_ident} is now available as the
public function @ref{1199,,threading.get_ident()}.  This eliminates several cases of
direct access to the @code{_thread} module in the stdlib.  Third party code that
used @code{_thread.get_ident} should likewise be changed to use the new public
interface.

@node time<8>,types<7>,threading<8>,Módulos melhorados<11>
@anchor{whatsnew/3 3 time}@anchor{119a}
@subsubsection time


The 
@geindex Propostas de Melhorias do Python; PEP 418
PEP 418@footnote{https://peps.python.org/pep-0418/} added new functions to the @ref{ee,,time} module:


@itemize *

@item 
@ref{119b,,get_clock_info()}: Get information on a clock.

@item 
@ref{253,,monotonic()}: Monotonic clock (cannot go backward), not affected
by system clock updates.

@item 
@ref{a92,,perf_counter()}: Performance counter with the highest available
resolution to measure a short duration.

@item 
@ref{a93,,process_time()}: Sum of the system and user CPU time of the
current process.
@end itemize

Other new functions:


@itemize *

@item 
@ref{119c,,clock_getres()}, @ref{119d,,clock_gettime()} and
@ref{119e,,clock_settime()} functions with @code{CLOCK_@var{xxx}} constants.
(Contributed by Victor Stinner in bpo-10278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10278}.)
@end itemize

To improve cross platform consistency, @ref{69d,,sleep()} now raises a
@ref{202,,ValueError} when passed a negative sleep value.  Previously this was an
error on posix, but produced an infinite sleep on Windows.

@node types<7>,unittest<10>,time<8>,Módulos melhorados<11>
@anchor{whatsnew/3 3 types}@anchor{119f}
@subsubsection types


Add a new @ref{46d,,types.MappingProxyType} class: Read-only proxy of a mapping.
(bpo-14386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14386})

The new functions @ref{11a0,,types.new_class()} and @ref{11a1,,types.prepare_class()} provide support
for 
@geindex Propostas de Melhorias do Python; PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/} compliant dynamic type creation. (bpo-14588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14588})

@node unittest<10>,urllib<4>,types<7>,Módulos melhorados<11>
@anchor{whatsnew/3 3 unittest}@anchor{11a2}
@subsubsection unittest


@ref{52d,,assertRaises()}, @ref{52f,,assertRaisesRegex()}, @ref{11a3,,assertWarns()}, and
@ref{11a4,,assertWarnsRegex()} now accept a keyword argument `msg' when used as
context managers.  (Contributed by Ezio Melotti and Winston Ewert in
bpo-10775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10775}.)

@ref{11a5,,unittest.TestCase.run()} now returns the @ref{11a6,,TestResult}
object.

@node urllib<4>,webbrowser<3>,unittest<10>,Módulos melhorados<11>
@anchor{whatsnew/3 3 urllib}@anchor{11a7}
@subsubsection urllib


The @ref{100e,,Request} class, now accepts a `method' argument
used by @ref{11a8,,get_method()} to determine what HTTP method
should be used.  For example, this will send a @code{'HEAD'} request:

@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<4>,Módulos melhorados<11>
@anchor{whatsnew/3 3 webbrowser}@anchor{11a9}
@subsubsection webbrowser


The @ref{115,,webbrowser} module supports more “browsers”: Google Chrome (named
@code{chrome}, @code{chromium}, @code{chrome-browser} or
@code{chromium-browser} depending on the version and operating system),
and the generic launchers @code{xdg-open}, from the FreeDesktop.org
project, and @code{gvfs-open}, which is the default URI handler for GNOME
3.  (The former contributed by Arnaud Calmettes in bpo-13620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13620}, the latter
by Matthias Klose in bpo-14493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14493}.)

@node xml etree ElementTree<2>,zlib<2>,webbrowser<3>,Módulos melhorados<11>
@anchor{whatsnew/3 3 xml-etree-elementtree}@anchor{11aa}
@subsubsection xml.etree.ElementTree


The @ref{125,,xml.etree.ElementTree} module now imports its C accelerator by
default; there is no longer a need to explicitly import
@code{xml.etree.cElementTree} (this module stays for backwards compatibility,
but is now deprecated).  In addition,  the @code{iter} family of methods of
@ref{310,,Element} has been optimized (rewritten in C).
The module’s documentation has also been greatly improved with added examples
and a more detailed reference.

@node zlib<2>,,xml etree ElementTree<2>,Módulos melhorados<11>
@anchor{whatsnew/3 3 zlib}@anchor{11ab}
@subsubsection zlib


New attribute @ref{11ac,,zlib.Decompress.eof} makes it possible to distinguish
between a properly formed compressed stream and an incomplete or truncated one.
(Contributed by Nadeem Vawda in bpo-12646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12646}.)

New attribute @ref{11ad,,zlib.ZLIB_RUNTIME_VERSION} reports the version string of
the underlying @code{zlib} library that is loaded at runtime.  (Contributed by
Torsten Landschoff in bpo-12306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12306}.)

@node Otimizações<10>,Mudanças a construções e API C<4>,Módulos melhorados<11>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 optimizations}@anchor{11ae}
@subsection Otimizações


Major performance enhancements have been added:


@itemize *

@item 
Thanks to 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, some operations on Unicode strings have been optimized:


@itemize *

@item 
the memory footprint is divided by 2 to 4 depending on the text

@item 
encode an ASCII string to UTF-8 doesn’t need to encode characters anymore,
the UTF-8 representation is shared with the ASCII representation

@item 
the UTF-8 encoder has been optimized

@item 
repeating a single ASCII letter and getting a substring of an ASCII string
is 4 times faster
@end itemize

@item 
UTF-8 is now 2x to 4x faster.  UTF-16 encoding is now up to 10x faster.

(Contributed by 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} and
bpo-15026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15026}.)
@end itemize

@node Mudanças a construções e API C<4>,Descontinuados<12>,Otimizações<10>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 build-and-c-api-changes}@anchor{1081}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
New 
@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} related function:


@itemize *

@item 
@ref{11af,,PyMemoryView_FromMemory()}
@end itemize

@item 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} added new Unicode types, macros and functions:


@itemize *

@item 
High-level API:


@itemize *

@item 
@ref{8ba,,PyUnicode_CopyCharacters()}

@item 
@ref{8be,,PyUnicode_FindChar()}

@item 
@ref{8b8,,PyUnicode_GetLength()}, @ref{8b9,,PyUnicode_GET_LENGTH}

@item 
@ref{8b0,,PyUnicode_New()}

@item 
@ref{8bb,,PyUnicode_Substring()}

@item 
@ref{11b0,,PyUnicode_ReadChar()}, @ref{11b1,,PyUnicode_WriteChar()}
@end itemize

@item 
Low-level API:


@itemize *

@item 
@ref{11b2,,Py_UCS1}, @ref{11b3,,Py_UCS2}, @ref{29b,,Py_UCS4} types

@item 
@ref{11b4,,PyASCIIObject} and @ref{11b5,,PyCompactUnicodeObject} structures

@item 
@ref{401,,PyUnicode_READY}

@item 
@ref{11b6,,PyUnicode_FromKindAndData()}

@item 
@ref{11b7,,PyUnicode_AsUCS4()}, @ref{8c0,,PyUnicode_AsUCS4Copy()}

@item 
@ref{11b8,,PyUnicode_DATA}, @ref{11b9,,PyUnicode_1BYTE_DATA},
@ref{11ba,,PyUnicode_2BYTE_DATA}, @ref{11bb,,PyUnicode_4BYTE_DATA}

@item 
@ref{11bc,,PyUnicode_KIND} with @code{PyUnicode_Kind} enum:
@code{PyUnicode_WCHAR_KIND}, @ref{11bd,,PyUnicode_1BYTE_KIND},
@ref{11be,,PyUnicode_2BYTE_KIND}, @ref{11bf,,PyUnicode_4BYTE_KIND}

@item 
@ref{11c0,,PyUnicode_READ}, @ref{11c1,,PyUnicode_READ_CHAR}, @ref{11c2,,PyUnicode_WRITE}

@item 
@ref{11c3,,PyUnicode_MAX_CHAR_VALUE}
@end itemize
@end itemize

@item 
@ref{571,,PyArg_ParseTuple} now accepts a @ref{2ea,,bytearray} for the @code{c}
format (bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380}).
@end itemize

@node Descontinuados<12>,Porting to Python 3 3,Mudanças a construções e API C<4>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 deprecated}@anchor{11c4}
@subsection Descontinuados


@menu
* Unsupported Operating Systems: Unsupported Operating Systems<2>. 
* Deprecated Python modules@comma{} functions and methods: Deprecated Python modules functions and methods<4>. 
* Deprecated functions and types of the C API: Deprecated functions and types of the C API<3>. 
* Deprecated features:: 

@end menu

@node Unsupported Operating Systems<2>,Deprecated Python modules functions and methods<4>,,Descontinuados<12>
@anchor{whatsnew/3 3 unsupported-operating-systems}@anchor{11c5}
@subsubsection Unsupported Operating Systems


OS/2 and VMS are no longer supported due to the lack of a maintainer.

Windows 2000 and Windows platforms which set @code{COMSPEC} to @code{command.com}
are no longer supported due to maintenance burden.

OSF support, which was deprecated in 3.2, has been completely removed.

@node Deprecated Python modules functions and methods<4>,Deprecated functions and types of the C API<3>,Unsupported Operating Systems<2>,Descontinuados<12>
@anchor{whatsnew/3 3 deprecated-python-modules-functions-and-methods}@anchor{11c6}
@subsubsection Deprecated Python modules, functions and methods



@itemize *

@item 
Passing a non-empty string to @code{object.__format__()} is deprecated, and
will produce a @ref{2c3,,TypeError} in Python 3.4 (bpo-9856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9856}).

@item 
The @code{unicode_internal} codec has been deprecated because of the
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, use UTF-8, UTF-16 (@code{utf-16-le} or @code{utf-16-be}), or UTF-32
(@code{utf-32-le} or @code{utf-32-be})

@item 
@ref{1102,,ftplib.FTP.nlst()} and @ref{1103,,ftplib.FTP.dir()}: use
@ref{1101,,ftplib.FTP.mlsd()}

@item 
@code{platform.popen()}: use the @ref{d6,,subprocess} module. Check especially
the @ref{11c7,,Replacing Older Functions with the subprocess Module} section (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}: The Windows bytes API has been deprecated in the @ref{a1,,os}
module. Use Unicode filenames, instead of bytes filenames, to not depend on
the ANSI code page anymore and to support any filename.

@item 
bpo-13988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13988}: The @code{xml.etree.cElementTree} module is deprecated.  The
accelerator is used automatically whenever available.

@item 
The behaviour of @code{time.clock()} depends on the platform: use the new
@ref{a92,,time.perf_counter()} or @ref{a93,,time.process_time()} function instead,
depending on your requirements, to have a well defined behaviour.

@item 
The @code{os.stat_float_times()} function is deprecated.

@item 
@ref{4,,abc} module:


@itemize *

@item 
@ref{10c3,,abc.abstractproperty} has been deprecated, use @ref{194,,property}
with @ref{10c4,,abc.abstractmethod()} instead.

@item 
@ref{10c5,,abc.abstractclassmethod} has been deprecated, use
@ref{166,,classmethod} with @ref{10c4,,abc.abstractmethod()} instead.

@item 
@ref{10c6,,abc.abstractstaticmethod} has been deprecated, use
@ref{416,,staticmethod} with @ref{10c4,,abc.abstractmethod()} instead.
@end itemize

@item 
@ref{77,,importlib} package:


@itemize *

@item 
@ref{11c8,,importlib.abc.SourceLoader.path_mtime()} is now deprecated in favour of
@ref{11c9,,importlib.abc.SourceLoader.path_stats()} as bytecode files now store
both the modification time and size of the source file the bytecode file was
compiled from.
@end itemize
@end itemize

@node Deprecated functions and types of the C API<3>,Deprecated features,Deprecated Python modules functions and methods<4>,Descontinuados<12>
@anchor{whatsnew/3 3 deprecated-functions-and-types-of-the-c-api}@anchor{11ca}
@subsubsection Deprecated functions and types of the C API


The @ref{3ed,,Py_UNICODE} has been deprecated by 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} and will be
removed in Python 4. All functions using this type are deprecated:

Unicode functions and methods using @ref{3ed,,Py_UNICODE} and
@ref{3ed,,Py_UNICODE}* types:


@itemize *

@item 
@code{PyUnicode_FromUnicode}: use @ref{11cb,,PyUnicode_FromWideChar()} or
@ref{11b6,,PyUnicode_FromKindAndData()}

@item 
@code{PyUnicode_AS_UNICODE}, @code{PyUnicode_AsUnicode()},
@code{PyUnicode_AsUnicodeAndSize()}: use @ref{8c1,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_AS_DATA}: use @ref{11b8,,PyUnicode_DATA} with
@ref{11c0,,PyUnicode_READ} and @ref{11c2,,PyUnicode_WRITE}

@item 
@code{PyUnicode_GET_SIZE}, @code{PyUnicode_GetSize()}: use
@ref{8b9,,PyUnicode_GET_LENGTH} or @ref{8b8,,PyUnicode_GetLength()}

@item 
@code{PyUnicode_GET_DATA_SIZE}: use
@code{PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)} (only work on ready
strings)

@item 
@code{PyUnicode_AsUnicodeCopy()}: use @ref{8c0,,PyUnicode_AsUCS4Copy()} or
@ref{8c1,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_GetMax()}
@end itemize

Functions and macros manipulating Py_UNICODE* strings:


@itemize *

@item 
@code{Py_UNICODE_strlen()}: use @ref{8b8,,PyUnicode_GetLength()} or
@ref{8b9,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat()}: use @ref{8ba,,PyUnicode_CopyCharacters()} or
@ref{38a,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy()}, @code{Py_UNICODE_strncpy()},
@code{Py_UNICODE_COPY()}: use @ref{8ba,,PyUnicode_CopyCharacters()} or
@ref{8bb,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp()}: use @ref{8bc,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp()}: use @ref{8bd,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr()}, @code{Py_UNICODE_strrchr()}: use
@ref{8be,,PyUnicode_FindChar()}

@item 
@code{Py_UNICODE_FILL()}: use @ref{11cc,,PyUnicode_Fill()}

@item 
@code{Py_UNICODE_MATCH}
@end itemize

Encoders:


@itemize *

@item 
@code{PyUnicode_Encode()}: use @code{PyUnicode_AsEncodedObject()}

@item 
@code{PyUnicode_EncodeUTF7()}

@item 
@code{PyUnicode_EncodeUTF8()}: use @ref{bd4,,PyUnicode_AsUTF8()} or
@ref{11cd,,PyUnicode_AsUTF8String()}

@item 
@code{PyUnicode_EncodeUTF32()}

@item 
@code{PyUnicode_EncodeUTF16()}

@item 
@code{PyUnicode_EncodeUnicodeEscape()} use
@ref{11ce,,PyUnicode_AsUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeRawUnicodeEscape()} use
@ref{11cf,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeLatin1()}: use @ref{11d0,,PyUnicode_AsLatin1String()}

@item 
@code{PyUnicode_EncodeASCII()}: use @ref{11d1,,PyUnicode_AsASCIIString()}

@item 
@code{PyUnicode_EncodeCharmap()}

@item 
@code{PyUnicode_TranslateCharmap()}

@item 
@code{PyUnicode_EncodeMBCS()}: use @ref{11d2,,PyUnicode_AsMBCSString()} or
@ref{11d3,,PyUnicode_EncodeCodePage()} (with @code{CP_ACP} code_page)

@item 
@code{PyUnicode_EncodeDecimal()},
@code{PyUnicode_TransformDecimalToASCII()}
@end itemize

@node Deprecated features,,Deprecated functions and types of the C API<3>,Descontinuados<12>
@anchor{whatsnew/3 3 deprecated-features}@anchor{11d4}
@subsubsection Deprecated features


The @ref{7,,array} module’s @code{'u'} format code is now deprecated and will be
removed in Python 4 together with the rest of the (@ref{3ed,,Py_UNICODE}) API.

@node Porting to Python 3 3,,Descontinuados<12>,O que há de novo no Python 3 3
@anchor{whatsnew/3 3 porting-to-python-3-3}@anchor{11d5}
@subsection Porting to Python 3.3


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.

@menu
* Porting Python code:: 
* Porting C code:: 
* Building C extensions:: 
* Command Line Switch Changes:: 

@end menu

@node Porting Python code,Porting C code,,Porting to Python 3 3
@anchor{whatsnew/3 3 porting-python-code}@anchor{10a7}@anchor{whatsnew/3 3 portingpythoncode}@anchor{11d6}
@subsubsection Porting Python code



@itemize *

@item 
Hash randomization is enabled by default. Set the 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED}
environment variable to @code{0} to disable hash randomization. See also the
@ref{b0e,,object.__hash__()} method.

@item 
bpo-12326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12326}: On Linux, sys.platform doesn’t contain the major version
anymore. It is now always ‘linux’, instead of ‘linux2’ or ‘linux3’ depending
on the Linux version used to build Python. Replace sys.platform == ‘linux2’
with sys.platform.startswith(‘linux’), or directly sys.platform == ‘linux’ if
you don’t need to support older Python versions.

@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} and @ref{30,,datetime}:
@ref{885,,OverflowError} is now raised instead of @ref{202,,ValueError} if a
timestamp is out of range. @ref{417,,OSError} is now raised if C functions
@code{gmtime()} or @code{localtime()} failed.

@item 
The default finders used by import now utilize a cache of what is contained
within a specific directory. If you create a Python source file or sourceless
bytecode file, make sure to call @ref{c2a,,importlib.invalidate_caches()} to clear
out the cache for the finders to notice the new file.

@item 
@ref{419,,ImportError} now uses the full name of the module that was attempted to
be imported. Doctests that check ImportErrors’ message will need to be
updated to use the full name of the module instead of just the tail of the
name.

@item 
The `index' argument to @ref{8da,,__import__()} now defaults to 0 instead of -1
and no longer support negative values. It was an oversight when 
@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} was
implemented that the default value remained -1. If you need to continue to
perform a relative import followed by an absolute import, then perform the
relative import using an index of 1, followed by another import using an
index of 0. It is preferred, though, that you use
@ref{518,,importlib.import_module()} rather than call @ref{8da,,__import__()} directly.

@item 
@ref{8da,,__import__()} no longer allows one to use an index value other than 0
for top-level modules. E.g. @code{__import__('sys', level=1)} is now an error.

@item 
Because @ref{d4d,,sys.meta_path} and @ref{105a,,sys.path_hooks} now have finders on
them by default, you will most likely want to use @ref{11d7,,list.insert()} instead
of @ref{6cd,,list.append()} to add to those lists.

@item 
Because @code{None} is now inserted into @ref{5e4,,sys.path_importer_cache}, if you
are clearing out entries in the dictionary of paths that do not have a
finder, you will need to remove keys paired with values of @code{None} `and'
@code{imp.NullImporter} to be backwards-compatible. This will lead to extra
overhead on older versions of Python that re-insert @code{None} into
@ref{5e4,,sys.path_importer_cache} where it represents the use of implicit
finders, but semantically it should not change anything.

@item 
@code{importlib.abc.Finder} no longer specifies a @code{find_module()} abstract
method that must be implemented. If you were relying on subclasses to
implement that method, make sure to check for the method’s existence first.
You will probably want to check for @code{find_loader()} first, though, in the
case of working with @ref{10aa,,path entry finders}.

@item 
@ref{a9,,pkgutil} has been converted to use @ref{77,,importlib} internally. This
eliminates many edge cases where the old behaviour of the 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} import
emulation failed to match the behaviour of the real import system. The
import emulation itself is still present, but is now deprecated. The
@ref{11d8,,pkgutil.iter_importers()} and @ref{c19,,pkgutil.walk_packages()} functions
special case the standard import hooks so they are still supported even
though they do not provide the non-standard @code{iter_modules()} method.

@item 
A longstanding RFC-compliance bug (bpo-1079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1079}) in the parsing done by
@ref{10f7,,email.header.decode_header()} has been fixed.  Code that uses the
standard idiom to convert encoded headers into unicode
(@code{str(make_header(decode_header(h))}) will see no change, but code that
looks at the individual tuples returned by decode_header will see that
whitespace that precedes or follows @code{ASCII} sections is now included in the
@code{ASCII} section.  Code that builds headers using @code{make_header} should
also continue to work without change, since @code{make_header} continues to add
whitespace between @code{ASCII} and non-@code{ASCII} sections if it is not already
present in the input strings.

@item 
@ref{11d9,,email.utils.formataddr()} now does the correct content transfer
encoding when passed non-@code{ASCII} display names.  Any code that depended on
the previous buggy behavior that preserved the non-@code{ASCII} unicode in the
formatted output string will need to be changed (bpo-1690608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1690608}).

@item 
@ref{11da,,poplib.POP3.quit()} may now raise protocol errors like all other
@code{poplib} methods.  Code that assumes @code{quit} does not raise
@ref{11db,,poplib.error_proto} errors may need to be changed if errors on @code{quit}
are encountered by a particular application (bpo-11291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11291}).

@item 
The @code{strict} argument to @ref{11dc,,email.parser.Parser}, deprecated since
Python 2.4, has finally been removed.

@item 
The deprecated method @code{unittest.TestCase.assertSameElements} has been
removed.

@item 
The deprecated variable @code{time.accept2dyear} has been removed.

@item 
The deprecated @code{Context._clamp} attribute has been removed from the
@ref{36,,decimal} module.  It was previously replaced by the public attribute
@ref{11dd,,clamp}.  (See bpo-8540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8540}.)

@item 
The undocumented internal helper class @code{SSLFakeFile} has been removed
from @ref{ca,,smtplib}, since its functionality has long been provided directly
by @ref{11de,,socket.socket.makefile()}.

@item 
Passing a negative value to @ref{69d,,time.sleep()} on Windows now raises an
error instead of sleeping forever.  It has always raised an error on posix.

@item 
The @code{ast.__version__} constant has been removed.  If you need to
make decisions affected by the AST version, use @ref{6a0,,sys.version_info}
to make the decision.

@item 
Code that used to work around the fact that the @ref{ed,,threading} module used
factory functions by subclassing the private classes will need to change to
subclass the now-public classes.

@item 
The undocumented debugging machinery in the threading module has been
removed, simplifying the code.  This should have no effect on production
code, but is mentioned here in case any application debug frameworks were
interacting with it (bpo-13550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13550}).
@end itemize

@node Porting C code,Building C extensions,Porting Python code,Porting to Python 3 3
@anchor{whatsnew/3 3 porting-c-code}@anchor{1082}
@subsubsection Porting C code



@itemize *

@item 
In the course of changes to the buffer API the undocumented
@code{smalltable} member of the
@ref{758,,Py_buffer} structure has been removed and the
layout of the @code{PyMemoryViewObject} has changed.

All extensions relying on the relevant parts in @code{memoryobject.h}
or @code{object.h} must be rebuilt.

@item 
Due to @ref{1076,,PEP 393}, the @ref{3ed,,Py_UNICODE} type and all
functions using this type are deprecated (but will stay available for
at least five years).  If you were using low-level Unicode APIs to
construct and access unicode objects and you want to benefit of the
memory footprint reduction provided by 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, you have to convert
your code to the new @ref{11df,,Unicode API}.

However, if you only have been using high-level functions such as
@ref{11e0,,PyUnicode_Concat()}, @ref{11e1,,PyUnicode_Join()} or
@ref{38a,,PyUnicode_FromFormat()}, your code will automatically take
advantage of the new unicode representations.

@item 
@ref{11e2,,PyImport_GetMagicNumber()} now returns @code{-1} upon failure.

@item 
As a negative value for the `level' argument to @ref{8da,,__import__()} is no
longer valid, the same now holds for @ref{11e3,,PyImport_ImportModuleLevel()}.
This also means that the value of `level' used by
@ref{11e4,,PyImport_ImportModuleEx()} is now @code{0} instead of @code{-1}.
@end itemize

@node Building C extensions,Command Line Switch Changes,Porting C code,Porting to Python 3 3
@anchor{whatsnew/3 3 building-c-extensions}@anchor{11e5}
@subsubsection Building C extensions



@itemize *

@item 
The range of possible file names for C extensions has been narrowed.
Very rarely used spellings have been suppressed: under POSIX, files
named @code{xxxmodule.so}, @code{xxxmodule.abi3.so} and
@code{xxxmodule.cpython-*.so} are no longer recognized as implementing
the @code{xxx} module.  If you had been generating such files, you have
to switch to the other spellings (i.e., remove the @code{module} string
from the file names).

(implemented in bpo-14040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14040}.)
@end itemize

@node Command Line Switch Changes,,Building C extensions,Porting to Python 3 3
@anchor{whatsnew/3 3 command-line-switch-changes}@anchor{11e6}
@subsubsection Command Line Switch Changes



@itemize *

@item 
The -Q command-line flag and related artifacts have been removed.  Code
checking sys.flags.division_warning will need updating.

(bpo-10998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10998}, contributed by Éric Araujo.)

@item 
When @code{python} is started with @ref{11e7,,-S}, @code{import site}
will no longer add site-specific paths to the module search paths.  In
previous versions, it did.

(bpo-11591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11591}, contributed by Carl Meyer with editions by Éric Araujo.)
@end itemize

@node O que há de novo no Python 3 2,O que há de novo no Python 3 1,O que há de novo no Python 3 3,O que há de novo no Python
@anchor{whatsnew/3 2 doc}@anchor{11e8}@anchor{whatsnew/3 2 translation-repo}@anchor{11e9}@anchor{whatsnew/3 2 what-s-new-in-python-3-2}@anchor{11ea}
@section O que há de novo no 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.

This article explains the new features in Python 3.2 as compared to 3.1.
Python 3.2 was released on February 20, 2011. It
focuses on a few highlights and gives a few examples.  For full details, see the
Misc/NEWS@footnote{https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS}
file.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 392
PEP 392@footnote{https://peps.python.org/pep-0392/} - Python 3.2 Release Schedule


@menu
* PEP 384; Defining a Stable ABI: PEP 384 Defining a Stable ABI. 
* PEP 389; Argparse Command Line Parsing Module: PEP 389 Argparse Command Line Parsing Module. 
* PEP 391; Dictionary Based Configuration for Logging: PEP 391 Dictionary Based Configuration for Logging. 
* PEP 3148; The concurrent.futures module: PEP 3148 The concurrent futures module. 
* PEP 3147; PYC Repository Directories: PEP 3147 PYC Repository Directories. 
* PEP 3149; ABI Version Tagged .so Files: PEP 3149 ABI Version Tagged so Files. 
* PEP 3333; Python Web Server Gateway Interface v1.0.1: PEP 3333 Python Web Server Gateway Interface v1 0 1. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<12>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules. 
* Multi-threading:: 
* Otimizações: Otimizações<11>. 
* Unicode:: 
* Codecs:: 
* Documentação:: 
* IDLE:: 
* Code Repository:: 
* Mudanças a construções e API C: Mudanças a construções e API C<5>. 
* Porting to Python 3.2: Porting to Python 3 2. 

@end menu

@node PEP 384 Defining a Stable ABI,PEP 389 Argparse Command Line Parsing Module,,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-384-defining-a-stable-abi}@anchor{11eb}
@subsection PEP 384: Defining a Stable ABI


In the past, extension modules built for one Python version were often
not usable with other Python versions. Particularly on Windows, every
feature release of Python required rebuilding all extension modules that
one wanted to use. This requirement was the result of the free access to
Python interpreter internals that extension modules could use.

With Python 3.2, an alternative approach becomes available: extension
modules which restrict themselves to a limited API (by defining
Py_LIMITED_API) cannot use many of the internals, but are constrained
to a set of API functions that are promised to be stable for several
releases. As a consequence, extension modules built for 3.2 in that
mode will also work with 3.3, 3.4, and so on. Extension modules that
make use of details of memory structures can still be built, but will
need to be recompiled for every feature release.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 384

@item PEP 384@footnote{https://peps.python.org/pep-0384/} - Defining a Stable ABI

PEP written by Martin von Löwis.
@end table


@node PEP 389 Argparse Command Line Parsing Module,PEP 391 Dictionary Based Configuration for Logging,PEP 384 Defining a Stable ABI,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-389-argparse-command-line-parsing-module}@anchor{11ec}
@subsection PEP 389: Argparse Command Line Parsing Module


A new module for command line parsing, @ref{6,,argparse}, was introduced to
overcome the limitations of @ref{a0,,optparse} which did not provide support for
positional arguments (not just options), subcommands, required options and other
common patterns of specifying and validating options.

This module has already had widespread success in the community as a
third-party module.  Being more fully featured than its predecessor, the
@ref{6,,argparse} module is now the preferred module for command-line processing.
The older module is still being kept available because of the substantial amount
of legacy code that depends on it.

Here’s an annotated example parser showing features like limiting results to a
set of choices, specifying a `metavar' in the help screen, validating that one
or more positional arguments is present, and making a required option:

@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

Example of calling the parser on a command string:

@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

Example of the parser’s automatically generated help:

@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

An especially nice @ref{6,,argparse} feature is the ability to define subparsers,
each with their own argument patterns and help displays:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - New Command Line Parsing Module

PEP written by Steven Bethard.
@end table

@ref{11ed,,Migrando código optparse para argparse} for details on the differences from @ref{a0,,optparse}.


@node PEP 391 Dictionary Based Configuration for Logging,PEP 3148 The concurrent futures module,PEP 389 Argparse Command Line Parsing Module,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-391-dictionary-based-configuration-for-logging}@anchor{11ee}
@subsection PEP 391:  Dictionary Based Configuration for 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{22,,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.

To support a more flexible style, the module now offers
@ref{11ef,,logging.config.dictConfig()} for specifying logging configuration with
plain Python dictionaries.  The configuration options include formatters,
handlers, filters, and loggers.  Here’s a working example of a configuration
dictionary:

@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

If that dictionary is stored in a file called @code{conf.json}, it can be
loaded and called with code like this:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - Dictionary Based Configuration for Logging

PEP written by Vinay Sajip.
@end table


@node PEP 3148 The concurrent futures module,PEP 3147 PYC Repository Directories,PEP 391 Dictionary Based Configuration for Logging,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-3148-the-concurrent-futures-module}@anchor{11f0}
@subsection PEP 3148:  The @code{concurrent.futures} module


Code for creating and managing concurrency is being collected in a new top-level
namespace, `concurrent'.  Its first member is a `futures' package which provides
a uniform high-level interface for managing threads and processes.

The design for @ref{21,,concurrent.futures} was inspired by the
`java.util.concurrent' package.  In that model, a running call and its result
are represented by a @ref{11f1,,Future} object that abstracts
features common to threads, processes, and remote procedure calls.  That object
supports status checks (running or done), timeouts, cancellations, adding
callbacks, and access to results or exceptions.

The primary offering of the new module is a pair of executor classes for
launching and managing calls.  The goal of the executors is to make it easier to
use existing tools for making parallel calls. They save the effort needed to
setup a pool of resources, launch the calls, create a results queue, add
time-out handling, and limit the total number of threads, processes, or remote
procedure calls.

Ideally, each application should share a single executor across multiple
components so that process and thread limits can be centrally managed.  This
solves the design challenge that arises when each component has its own
competing strategy for resource management.

Both classes share a common interface with three methods:
@ref{a8c,,submit()} for scheduling a callable and
returning a @ref{11f1,,Future} object;
@ref{e0e,,map()} for scheduling many asynchronous calls
at a time, and @ref{8f3,,shutdown()} for freeing
resources.  The class is a @ref{5d4,,context manager} and can be used in a
@ref{5d2,,with} statement to assure that resources are automatically released
when currently pending futures are done executing.

A simple of example of @ref{742,,ThreadPoolExecutor} is a
launch of four parallel threads for copying files:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} - Futures – Execute Computations Asynchronously

PEP written by Brian Quinlan.
@end table

@ref{11f2,,Code for Threaded Parallel URL reads}, an
example using threads to fetch multiple web pages in parallel.

@ref{11f3,,Code for computing prime numbers in parallel}, an example demonstrating
@ref{8f4,,ProcessPoolExecutor}.


@node PEP 3147 PYC Repository Directories,PEP 3149 ABI Version Tagged so Files,PEP 3148 The concurrent futures module,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-3147-pyc-repository-directories}@anchor{11f4}
@subsection PEP 3147:  PYC Repository Directories


Python’s scheme for caching bytecode in `.pyc' files did not work well in
environments with multiple Python interpreters.  If one interpreter encountered
a cached file created by another interpreter, it would recompile the source and
overwrite the cached file, thus losing the benefits of caching.

The issue of “pyc fights” has become more pronounced as it has become
commonplace for Linux distributions to ship with multiple versions of Python.
These conflicts also arise with CPython alternatives such as Unladen Swallow.

To solve this problem, Python’s import machinery has been extended to use
distinct filenames for each interpreter.  Instead of Python 3.2 and Python 3.3 and
Unladen Swallow each competing for a file called “mymodule.pyc”, they will now
look for “mymodule.cpython-32.pyc”, “mymodule.cpython-33.pyc”, and
“mymodule.unladen10.pyc”.  And to prevent all of these new files from
cluttering source directories, the `pyc' files are now collected in a
“__pycache__” directory stored under the package directory.

Aside from the filenames and target directories, the new scheme has a few
aspects that are visible to the programmer:


@itemize *

@item 
Imported modules now have a @ref{2d5,,__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 
The @ref{b3,,py_compile} and @ref{20,,compileall} modules have been updated to
reflect the new naming convention and target directory.  The command-line
invocation of `compileall' has new options: @code{-i} for
specifying a list of files and directories to compile and @code{-b} which causes
bytecode files to be written to their legacy location rather than
`__pycache__'.

@item 
The @ref{78,,importlib.abc} module has been updated with new @ref{11f5,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/} - PYC Repository Directories

PEP written by Barry Warsaw.
@end table


@node PEP 3149 ABI Version Tagged so Files,PEP 3333 Python Web Server Gateway Interface v1 0 1,PEP 3147 PYC Repository Directories,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-3149-abi-version-tagged-so-files}@anchor{11f6}
@subsection PEP 3149: ABI Version Tagged .so Files


The PYC repository directory allows multiple bytecode cache files to be
co-located.  This PEP implements a similar mechanism for shared object files by
giving them a common directory and distinct names for each version.

The common directory is “pyshared” and the file names are made distinct by
identifying the Python implementation (such as CPython, PyPy, Jython, etc.), the
major and minor version numbers, and optional build flags (such as “d” for
debug, “m” for pymalloc, “u” for wide-unicode).  For an arbitrary package “foo”,
you may see these files when the distribution package is installed:

@example
/usr/share/pyshared/foo.cpython-32m.so
/usr/share/pyshared/foo.cpython-33md.so
@end example

In Python itself, the tags are accessible from functions in the @ref{db,,sysconfig}
module:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3149

@item PEP 3149@footnote{https://peps.python.org/pep-3149/} - ABI Version Tagged .so Files

PEP written by Barry Warsaw.
@end table


@node PEP 3333 Python Web Server Gateway Interface v1 0 1,Outras mudanças na linguagem<12>,PEP 3149 ABI Version Tagged so Files,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 pep-3333-python-web-server-gateway-interface-v1-0-1}@anchor{11f7}
@subsection PEP 3333: Python Web Server Gateway Interface v1.0.1


This informational PEP clarifies how bytes/text issues are to be handled by the
WSGI protocol.  The challenge is that string handling in Python 3 is most
conveniently handled with the @ref{44c,,str} type even though the HTTP protocol
is itself bytes oriented.

The PEP differentiates so-called `native strings' that are used for
request/response headers and metadata versus `byte strings' which are used for
the bodies of requests and responses.

The `native strings' are always of type @ref{44c,,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.

For developers porting WSGI applications from Python 2, here are the salient
points:


@itemize *

@item 
If the app already used strings for headers in Python 2, no change is needed.

@item 
If instead, the app encoded output headers or decoded input headers, then the
headers will need to be re-encoded to Latin-1.  For example, an output header
encoded in utf-8 was using @code{h.encode('utf-8')} now needs to convert from
bytes to native strings using @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{11f8,,wsgiref.handlers.read_environ()} for transcoding CGI variables from
@ref{11f9,,os.environ} into native strings and returning a new dictionary.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3333

@item PEP 3333@footnote{https://peps.python.org/pep-3333/} - Python Web Server Gateway Interface v1.0.1

PEP written by Phillip Eby.
@end table


@node Outras mudanças na linguagem<12>,New Improved and Deprecated Modules,PEP 3333 Python Web Server Gateway Interface v1 0 1,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 other-language-changes}@anchor{11fa}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
String formatting for @ref{61f,,format()} and @ref{621,,str.format()} gained new
capabilities for the format character `#'.  Previously, for integers in
binary, octal, or hexadecimal, it caused the output to be prefixed with ‘0b’,
‘0o’, or ‘0x’ respectively.  Now it can also handle floats, complex, and
Decimal, causing the output to always have a decimal point even when no digits
follow it.

@example
>>> format(20, '#o')
'0o24'
>>> format(12.34, '#5.0f')
'  12.'
@end example

(Suggested by Mark Dickinson and implemented by Eric Smith in bpo-7094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7094}.)

@item 
There is also a new @ref{e01,,str.format_map()} method that extends the
capabilities of the existing @ref{621,,str.format()} method by accepting arbitrary
@ref{11fb,,mapping} objects.  This new method makes it possible to use string
formatting with any of Python’s many dictionary-like objects such as
@ref{11fc,,defaultdict}, @ref{fcf,,Shelf},
@ref{1c8,,ConfigParser}, or @ref{31,,dbm}.  It is also useful with
custom @ref{256,,dict} subclasses that normalize keys before look-up or that
supply a @ref{11fd,,__missing__()} method for unknown keys:

@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

(Suggested by Raymond Hettinger and implemented by Eric Smith in
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{68c,,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

(Contributed by Marcin Wojdyr in bpo-1772833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772833}).

@item 
The @ref{4d2,,hasattr()} function works by calling @ref{bea,,getattr()} and detecting
whether an exception is raised.  This technique allows it to detect methods
created dynamically by @ref{4d3,,__getattr__()} or @ref{beb,,__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{34b,,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

(Discovered by Yury Selivanov and fixed by Benjamin Peterson; bpo-9666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9666}.)

@item 
The @ref{44c,,str()} of a float or complex number is now the same as its
@ref{800,,repr()}. Previously, the @ref{44c,,str()} form was shorter but that just
caused confusion and is no longer needed now that the shortest possible
@ref{800,,repr()} is displayed by default:

@example
>>> import math
>>> repr(math.pi)
'3.141592653589793'
>>> str(math.pi)
'3.141592653589793'
@end example

(Proposed and implemented by Mark Dickinson; bpo-9337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9337}.)

@item 
@ref{2eb,,memoryview} objects now have a @ref{11fe,,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

(Added by Antoine Pitrou; bpo-9757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9757}.)

@item 
Previously it was illegal to delete a name from the local namespace if it
occurs as a free variable in a nested block:

@example
def outer(x):
    def inner():
        return x
    inner()
    del x
@end example

This is now allowed.  Remember that the target of an @ref{18b,,except} clause
is cleared, so this code which used to work with Python 2.6, raised a
@ref{18d,,SyntaxError} with Python 3.1 and now works again:

@example
def f():
    def print_error():
        print(e)
    try:
        something
    except Exception as e:
        print_error()
        # implicit "del e" here
@end example

(See bpo-4617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4617}.)

@item 
@ref{11ff,,Struct sequence types} are now subclasses of tuple.
This means that C structures like those returned by @ref{4a0,,os.stat()},
@ref{1200,,time.gmtime()}, and @ref{6a0,,sys.version_info} now work like a
@ref{64e,,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

(Suggested by Arfrever Frehtes Taifersar Arahesis and implemented
by Benjamin Peterson in bpo-8413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8413}.)

@item 
Warnings are now easier to control using the 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}
environment variable as an alternative to using @code{-W} at the command line:

@example
$ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'
@end example

(Suggested by Barry Warsaw and implemented by Philip Jenvey in bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301}.)

@item 
A new warning category, @ref{244,,ResourceWarning}, has been added.  It is
emitted when potential issues with resource consumption or cleanup
are detected.  It is silenced by default in normal release builds but
can be enabled through the means provided by the @ref{112,,warnings}
module, or on the command line.

A @ref{244,,ResourceWarning} is issued at interpreter shutdown if the
@ref{1201,,gc.garbage} list isn’t empty, and if @ref{1202,,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.

A @ref{244,,ResourceWarning} is also issued when a @ref{1203,,file object} is destroyed
without having been explicitly closed.  While the deallocator for such
object ensures it closes the underlying operating system resource
(usually, a file descriptor), the delay in deallocating the object could
produce various issues, especially under Windows.  Here is an example
of enabling the warning from the command line:

@example
$ python -q -Wdefault
>>> f = open("foo", "wb")
>>> del f
__main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
@end example

(Added by Antoine Pitrou and Georg Brandl in bpo-10093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10093} and bpo-477863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=477863}.)

@item 
@ref{94a,,range} objects now support `index' and `count' methods. This is part
of an effort to make more objects fully implement the
@ref{1204,,collections.Sequence} @ref{11f5,,abstract base class}.  As a result, the
language will have a more uniform API.  In addition, @ref{94a,,range} objects
now support slicing and negative indices, even with values larger than
@ref{1205,,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

(Contributed by Daniel Stutzbach in bpo-9213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9213}, by Alexander Belopolsky
in bpo-2690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2690}, and by Nick Coghlan in bpo-10889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10889}.)

@item 
The @ref{1206,,callable()} builtin function from Py2.x was resurrected.  It provides
a concise, readable alternative to using an @ref{11f5,,abstract base class} in an
expression like @code{isinstance(x, collections.Callable)}:

@example
>>> callable(max)
True
>>> callable(20)
False
@end example

(See bpo-10518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10518}.)

@item 
Python’s import mechanism can now load modules installed in directories with
non-ASCII characters in the path name.  This solved an aggravating problem
with home directories for users with non-ASCII characters in their usernames.
@end itemize

@quotation

(Required extensive work by Victor Stinner in bpo-9425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9425}.)
@end quotation

@node New Improved and Deprecated Modules,Multi-threading,Outras mudanças na linguagem<12>,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 new-improved-and-deprecated-modules}@anchor{1207}
@subsection New, Improved, and Deprecated Modules


Python’s standard library has undergone significant maintenance efforts and
quality improvements.

The biggest news for Python 3.2 is that the @ref{3b,,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.

Throughout the standard library, there has been more careful attention to
encodings and text versus bytes issues.  In particular, interactions with the
operating system are now better able to exchange non-ASCII data using the
Windows MBCS encoding, locale-aware encodings, or UTF-8.

Another significant win is the addition of substantially better support for
`SSL' connections and security certificates.

In addition, more classes now implement a @ref{5d4,,context manager} to support
convenient and reliable resource clean-up using a @ref{5d2,,with} statement.

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

@end menu

@node email<6>,elementtree,,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 email}@anchor{1208}
@subsubsection email


The usability of the @ref{3b,,email} package in Python 3 has been mostly fixed by
the extensive efforts of R. David Murray.  The problem was that emails are
typically read and stored in the form of @ref{1c2,,bytes} rather than @ref{44c,,str}
text, and they may contain multiple encodings within a single email.  So, the
email package had to be extended to parse and generate email messages in bytes
format.


@itemize *

@item 
New functions @ref{1209,,message_from_bytes()} and
@ref{120a,,message_from_binary_file()}, and new classes
@ref{120b,,BytesFeedParser} and @ref{120c,,BytesParser}
allow binary message data to be parsed into model objects.

@item 
Given bytes input to the model, @ref{120d,,get_payload()}
will by default decode a message body that has a
@code{Content-Transfer-Encoding} of `8bit' using the charset
specified in the MIME headers and return the resulting string.

@item 
Given bytes input to the model, @ref{120e,,Generator} will
convert message bodies that have a @code{Content-Transfer-Encoding} of
`8bit' to instead have a `7bit' @code{Content-Transfer-Encoding}.

Headers with unencoded non-ASCII bytes are deemed to be 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}-encoded
using the `unknown-8bit' character set.

@item 
A new class @ref{120f,,BytesGenerator} produces bytes as output,
preserving any unchanged non-ASCII data that was present in the input used to
build the model, including message bodies with a
@code{Content-Transfer-Encoding} of `8bit'.

@item 
The @ref{ca,,smtplib} @ref{934,,SMTP} class now accepts a byte string
for the `msg' argument to the @ref{e88,,sendmail()} method,
and a new method, @ref{e89,,send_message()} accepts a
@ref{27c,,Message} object and can optionally obtain the
`from_addr' and `to_addrs' addresses directly from the object.
@end itemize

(Proposed and implemented by R. David Murray, bpo-4661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4661} and bpo-10321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10321}.)

@node elementtree,functools<7>,email<6>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 elementtree}@anchor{1210}
@subsubsection elementtree


The @ref{125,,xml.etree.ElementTree} package and its @code{xml.etree.cElementTree}
counterpart have been updated to version 1.3.

Several new and useful functions and methods have been added:


@itemize *

@item 
@ref{1211,,xml.etree.ElementTree.fromstringlist()} which builds an XML document
from a sequence of fragments

@item 
@ref{1212,,xml.etree.ElementTree.register_namespace()} for registering a global
namespace prefix

@item 
@ref{102c,,xml.etree.ElementTree.tostringlist()} for string representation
including all sublists

@item 
@ref{1213,,xml.etree.ElementTree.Element.extend()} for appending a sequence of zero
or more elements

@item 
@ref{1214,,xml.etree.ElementTree.Element.iterfind()} searches an element and
subelements

@item 
@ref{1215,,xml.etree.ElementTree.Element.itertext()} creates a text iterator over
an element and its subelements

@item 
@ref{1216,,xml.etree.ElementTree.TreeBuilder.end()} closes the current element

@item 
@ref{aa6,,xml.etree.ElementTree.TreeBuilder.doctype()} handles a doctype
declaration
@end itemize

Two methods have been deprecated:


@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

For details of the update, see Introducing ElementTree@footnote{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm}
on Fredrik Lundh’s website.

(Contributed by Florent Xicluna and Fredrik Lundh, bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472}.)

@node functools<7>,itertools<7>,elementtree,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 functools}@anchor{1217}
@subsubsection functools



@itemize *

@item 
The @ref{5f,,functools} module includes a new decorator for caching function
calls.  @ref{9f7,,functools.lru_cache()} can save repeated queries to an external
resource whenever the results are expected to be the same.

For example, adding a caching decorator to a database query function can save
database accesses for popular searches:

@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

To help with choosing an effective cache size, the wrapped function is
instrumented for tracking cache statistics:

@example
>>> get_phone_number.cache_info()
CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
@end example

If the phonelist table gets updated, the outdated contents of the cache can be
cleared with:

@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{f91,,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{1218,,__annotations__} if
defined.  And now it also gracefully skips over missing attributes such as
@ref{1219,,__doc__} which
might not be defined for the wrapped callable.

In the above example, the cache can be removed by recovering the original
function:

@example
>>> get_phone_number = get_phone_number.__wrapped__    # uncached function
@end example

(By Nick Coghlan and 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}, and
bpo-8814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8814}.)

@item 
To help write classes with rich comparison methods, a new decorator
@ref{f75,,functools.total_ordering()} will use existing equality and inequality
methods to fill in the remaining methods.

For example, supplying `__eq__' and `__lt__' will enable
@ref{f75,,total_ordering()} to fill-in `__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

With the `total_ordering' decorator, the remaining comparison methods
are filled in automatically.

(Contributed by Raymond Hettinger.)

@item 
To aid in porting programs from Python 2, the @ref{121a,,functools.cmp_to_key()}
function converts an old-style comparison function to
modern @ref{e31,,key function}:

@example
>>> # locale-aware sort order
>>> sorted(iterable, key=cmp_to_key(locale.strcoll))
@end example

For sorting examples and a brief sorting tutorial, see the Sorting HowTo@footnote{https://wiki.python.org/moin/HowTo/Sorting/} tutorial.

(Contributed by Raymond Hettinger.)
@end itemize

@node itertools<7>,collections<8>,functools<7>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 itertools}@anchor{121b}
@subsubsection itertools



@itemize *

@item 
The @ref{81,,itertools} module has a new @ref{a05,,accumulate()} function
modeled on APL’s `scan' operator and Numpy’s `accumulate' function:

@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

For an example using @ref{a05,,accumulate()}, see the @ref{121c,,examples for the random module}.

(Contributed by Raymond Hettinger and incorporating design suggestions
from Mark Dickinson.)
@end itemize

@node collections<8>,threading<9>,itertools<7>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 collections}@anchor{121d}
@subsubsection collections



@itemize *

@item 
The @ref{10d0,,collections.Counter} class now has two forms of in-place
subtraction, the existing `-=' operator for saturating subtraction@footnote{https://en.wikipedia.org/wiki/Saturation_arithmetic} and the new
@ref{121e,,subtract()} method for regular subtraction.  The
former is suitable for multisets@footnote{https://en.wikipedia.org/wiki/Multiset}
which only have positive counts, and the latter is more suitable for use cases
that allow negative counts:

@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

(Contributed by Raymond Hettinger.)

@item 
The @ref{5db,,collections.OrderedDict} class has a new method
@ref{121f,,move_to_end()} which takes an existing key and
moves it to either the first or last position in the ordered sequence.

The default is to move an item to the last position.  This is equivalent of
renewing an entry with @code{od[k] = od.pop(k)}.

A fast move-to-end operation is useful for resequencing entries.  For example,
an ordered dictionary can be used to track order of access by aging entries
from the oldest to the most recently accessed.

@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

(Contributed by Raymond Hettinger.)

@item 
The @ref{5dc,,collections.deque} class grew two new methods
@ref{1220,,count()} and @ref{1221,,reverse()} that
make them more substitutable for @ref{611,,list} objects:

@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

(Contributed by Raymond Hettinger.)
@end itemize

@node threading<9>,datetime and time,collections<8>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 threading}@anchor{1222}
@subsubsection threading


The @ref{ed,,threading} module has a new @ref{1223,,Barrier}
synchronization class for making multiple threads wait until all of them have
reached a common barrier point.  Barriers are useful for making sure that a task
with multiple preconditions does not run until all of the predecessor tasks are
complete.

Barriers can work with an arbitrary number of threads.  This is a generalization
of a Rendezvous@footnote{https://en.wikipedia.org/wiki/Synchronous_rendezvous} which
is defined for only two threads.

Implemented as a two-phase cyclic barrier, @ref{1223,,Barrier} objects
are suitable for use in loops.  The separate `filling' and `draining' phases
assure that all threads get released (drained) before any one of them can loop
back and re-enter the barrier.  The barrier fully resets after each cycle.

Example of using barriers:

@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

In this example, the barrier enforces a rule that votes cannot be counted at any
polling site until all polls are closed.  Notice how a solution with a barrier
is similar to one with @ref{1224,,threading.Thread.join()}, but the threads stay alive
and continue to do work (summarizing ballots) after the barrier point is
crossed.

If any of the predecessor tasks can hang or be delayed, a barrier can be created
with an optional `timeout' parameter.  Then if the timeout period elapses before
all the predecessor tasks reach the barrier point, all waiting threads are
released and a @ref{1225,,BrokenBarrierError} exception is raised:

@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

In this example, the barrier enforces a more robust rule.  If some election
sites do not finish before midnight, the barrier times-out and the ballots are
sealed and deposited in a queue for later handling.

See Barrier Synchronization Patterns@footnote{https://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf}
for more examples of how barriers can be used in parallel computing.  Also, there is
a simple but thorough explanation of barriers in The Little Book of Semaphores@footnote{https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf}, `section 3.6'.

(Contributed by Kristján Valur Jónsson with an API review by Jeffrey Yasskin in
bpo-8777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8777}.)

@node datetime and time,math<10>,threading<9>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 datetime-and-time}@anchor{1226}
@subsubsection datetime and time



@itemize *

@item 
The @ref{30,,datetime} module has a new type @ref{10fe,,timezone} that
implements the @ref{5de,,tzinfo} interface by returning a fixed UTC
offset and timezone name. This makes it easier to create timezone-aware
datetime objects:

@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 
Also, @ref{9d7,,timedelta} objects can now be multiplied by
@ref{2f7,,float} and divided by @ref{2f7,,float} and @ref{257,,int} objects.
And @ref{9d7,,timedelta} objects can now divide one another.

@item 
The @ref{cb0,,datetime.date.strftime()} method is no longer restricted to years
after 1900.  The new supported year range is from 1000 to 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{1a5,,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{1227,,time.asctime()} function will
accept any year that fits in a C int, while the @ref{1228,,time.mktime()} and
@ref{1229,,time.strftime()} functions will accept the full range supported by the
corresponding operating system functions.
@end itemize

(Contributed by Alexander Belopolsky and Victor Stinner in 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},
and 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<10>,abc<3>,datetime and time,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 math}@anchor{122a}
@subsubsection math


The @ref{8e,,math} module has been updated with six new functions inspired by the
C99 standard.

The @ref{122b,,isfinite()} function provides a reliable and fast way to detect
special values.  It returns @code{True} for regular numbers and @code{False} for `Nan' or
`Infinity':

@example
>>> from math import isfinite
>>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
[True, True, False, False]
@end example

The @ref{122c,,expm1()} function computes @code{e**x-1} for small values of `x'
without incurring the loss of precision that usually accompanies the subtraction
of nearly equal quantities:

@example
>>> from math import expm1
>>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
0.013765762467652909
@end example

The @ref{bf3,,erf()} function computes a probability integral or Gaussian error function@footnote{https://en.wikipedia.org/wiki/Error_function}.  The
complementary error function, @ref{bf4,,erfc()}, is @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

The @ref{122d,,gamma()} function is a continuous extension of the factorial
function.  See @indicateurl{https://en.wikipedia.org/wiki/Gamma_function} for details.  Because
the function is related to factorials, it grows large even for small values of
`x', so there is also a @ref{122e,,lgamma()} function for computing the natural
logarithm of the gamma function:

@example
>>> from math import gamma, lgamma
>>> gamma(7.0)           # six factorial
720.0
>>> lgamma(801.0)        # log(800 factorial)
4551.950730698041
@end example

(Contributed by Mark Dickinson.)

@node abc<3>,io<7>,math<10>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 abc}@anchor{122f}
@subsubsection abc


The @ref{4,,abc} module now supports @ref{10c5,,abstractclassmethod()} and
@ref{10c6,,abstractstaticmethod()}.

These tools make it possible to define an @ref{11f5,,abstract base class} that
requires a particular @ref{166,,classmethod()} or @ref{416,,staticmethod()} to be
implemented:

@example
class Temperature(metaclass=abc.ABCMeta):
    @@abc.abstractclassmethod
    def from_fahrenheit(cls, t):
        ...
    @@abc.abstractclassmethod
    def from_celsius(cls, t):
        ...
@end example

(Patch submitted by Daniel Urban; bpo-5867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5867}.)

@node io<7>,reprlib,abc<3>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 io}@anchor{1230}
@subsubsection io


The @ref{ed3,,io.BytesIO} has a new method, @ref{1231,,getbuffer()}, which
provides functionality similar to @ref{2eb,,memoryview()}.  It creates an editable
view of the data without making a copy.  The buffer’s random access and support
for slice notation are well-suited to in-place editing:

@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

(Contributed by Antoine Pitrou in bpo-5506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5506}.)

@node reprlib,logging<8>,io<7>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 reprlib}@anchor{1232}
@subsubsection reprlib


When writing a @ref{61c,,__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{611,,list} and @ref{5d9,,set} handle
self-reference by displaying “…” in the recursive part of the representation
string.

To help write such @ref{61c,,__repr__()} methods, the @ref{bb,,reprlib} module has a new
decorator, @ref{1233,,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

(Contributed by Raymond Hettinger in bpo-9826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9826} and bpo-9840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9840}.)

@node logging<8>,csv<4>,reprlib,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 logging}@anchor{1234}
@subsubsection logging


In addition to dictionary-based configuration described above, the
@ref{87,,logging} package has many other improvements.

The logging documentation has been augmented by a @ref{1235,,basic tutorial}, an @ref{1236,,advanced tutorial}, and a @ref{1237,,cookbook} of
logging recipes.  These documents are the fastest way to learn about logging.

The @ref{a08,,logging.basicConfig()} set-up function gained a `style' argument to
support three different types of string formatting.  It defaults to “%” for
traditional %-formatting, can be set to “@{” for the new @ref{621,,str.format()} style, or
can be set to “$” for the shell-style formatting provided by
@ref{687,,string.Template}.  The following three configurations are equivalent:

@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{1238,,StreamHandler} directed to
@ref{940,,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{1239,,logging.raiseExceptions}.  The new default handler is stored in
@ref{123a,,logging.lastResort}.

The use of filters has been simplified.  Instead of creating a
@ref{123b,,Filter} object, the predicate can be any Python callable that
returns @code{True} or @code{False}.

There were a number of other improvements that add flexibility and simplify
configuration.  See the module documentation for a full listing of changes in
Python 3.2.

@node csv<4>,contextlib<8>,logging<8>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 csv}@anchor{123c}
@subsubsection csv


The @ref{29,,csv} module now supports a new dialect, @ref{123d,,unix_dialect},
which applies quoting for all fields and a traditional Unix style with @code{'\n'} as
the line terminator.  The registered dialect name is @code{unix}.

The @ref{123e,,csv.DictWriter} has a new method,
@ref{123f,,writeheader()} for writing-out an initial row to document
the field names:

@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

(New dialect suggested by Jay Talbot in bpo-5975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5975}, and the new method
suggested by Ed Abraham in bpo-1537721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537721}.)

@node contextlib<8>,decimal and fractions,csv<4>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 contextlib}@anchor{1240}
@subsubsection contextlib


There is a new and slightly mind-blowing tool
@ref{1241,,ContextDecorator} that is helpful for creating a
@ref{5d4,,context manager} that does double duty as a function decorator.

As a convenience, this new functionality is used by
@ref{1242,,contextmanager()} so that no extra effort is needed to support
both roles.

The basic idea is that both context managers and function decorators can be used
for pre-action and post-action wrappers.  Context managers wrap a group of
statements using a @ref{5d2,,with} statement, and function decorators wrap a
group of statements enclosed in a function.  So, occasionally there is a need to
write a pre-action or post-action wrapper that can be used in either role.

For example, it is sometimes useful to wrap functions or groups of statements
with a logger that can track the time of entry and time of exit.  Rather than
writing both a function decorator and a context manager for the task, the
@ref{1242,,contextmanager()} provides both capabilities in a single
definition:

@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

Formerly, this would have only been usable as a context manager:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

Now, it can be used as a decorator as well:

@example
@@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()
@end example

Trying to fulfill two roles at once places some limitations on the technique.
Context managers normally have the flexibility to return an argument usable by
a @ref{5d2,,with} statement, but there is no parallel for function decorators.

In the above example, there is not a clean way for the `track_entry_and_exit'
context manager to return a logging instance for use in the body of enclosed
statements.

(Contributed by Michael Foord in bpo-9110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9110}.)

@node decimal and fractions,ftp,contextlib<8>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 decimal-and-fractions}@anchor{1243}
@subsubsection decimal and fractions


Mark Dickinson crafted an elegant and efficient scheme for assuring that
different numeric datatypes will have the same hash value whenever their actual
values are equal (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{1035,,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 
The @ref{29d,,decimal.Decimal} constructor now accepts @ref{2f7,,float} objects
directly so there in no longer a need to use the @ref{1244,,from_float()}
method (bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}).

@item 
Mixed type comparisons are now fully supported so that
@ref{29d,,Decimal} objects can be directly compared with @ref{2f7,,float}
and @ref{1e7,,fractions.Fraction} (bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531} and bpo-8188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8188}).
@end itemize

Similar changes were made to @ref{1e7,,fractions.Fraction} so that the
@ref{1245,,from_float()} and @ref{1246,,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{36,,decimal} module is that the
@ref{11dd,,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}).

(Contributed by Mark Dickinson and Raymond Hettinger.)

@node ftp,popen,decimal and fractions,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 ftp}@anchor{1247}
@subsubsection ftp


The @ref{900,,ftplib.FTP} class now supports the context management protocol to
unconditionally consume @ref{108e,,socket.error} exceptions and to close the FTP
connection when done:

@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

Other file-like objects such as @ref{20b,,mmap.mmap} and @ref{802,,fileinput.input()}
also grew auto-closing context managers:

@example
with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
    for line in f:
        process(line)
@end example

(Contributed by Tarek Ziadé and Giampaolo Rodolà in bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972}, and
by Georg Brandl in bpo-8046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8046} and bpo-1286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1286}.)

The @ref{901,,FTP_TLS} class now accepts a `context' parameter, which is a
@ref{294,,ssl.SSLContext} object allowing bundling SSL configuration options,
certificates and private keys into a single (potentially long-lived) structure.

(Contributed by Giampaolo Rodolà; bpo-8806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8806}.)

@node popen,select<3>,ftp,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 popen}@anchor{1248}
@subsubsection popen


The @ref{a91,,os.popen()} and @ref{199,,subprocess.Popen()} functions now support
@ref{5d2,,with} statements for auto-closing of the file descriptors.

(Contributed by Antoine Pitrou and Brian Curtin in bpo-7461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7461} and
bpo-10554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10554}.)

@node select<3>,gzip and zipfile,popen,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 select}@anchor{1249}
@subsubsection select


The @ref{c1,,select} module now exposes a new, constant attribute,
@ref{124a,,PIPE_BUF}, which gives the minimum number of bytes which are
guaranteed not to block when @ref{dc8,,select.select()} says a pipe is ready
for writing.

@example
>>> import select
>>> select.PIPE_BUF
512
@end example

(Available on Unix systems. Patch by Sébastien Sablé in bpo-9862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9862})

@node gzip and zipfile,tarfile<10>,select<3>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 gzip-and-zipfile}@anchor{124b}
@subsubsection gzip and zipfile


@ref{41a,,gzip.GzipFile} now implements the @ref{694,,io.BufferedIOBase}
@ref{11f5,,abstract base class} (except for @code{truncate()}).  It also has a
@ref{124c,,peek()} method and supports unseekable as well as
zero-padded file objects.

The @ref{67,,gzip} module also gains the @ref{63e,,compress()} and
@ref{124d,,decompress()} functions for easier in-memory compression and
decompression.  Keep in mind that text needs to be encoded as @ref{1c2,,bytes}
before compressing and decompressing:

@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

(Contributed by Anand B. Pillai in bpo-3488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3488}; and by Antoine Pitrou, Nir
Aides and Brian Curtin in 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} and
bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846}.)

Also, the @ref{41b,,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{124e,,io.BufferedReader} object for more speedups.  It
also solves an issue where interleaved calls to `read' and `readline' gave the
wrong results.

(Patch submitted by Nir Aides in bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610}.)

@node tarfile<10>,hashlib<7>,gzip and zipfile,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 tarfile}@anchor{124f}
@subsubsection tarfile


The @ref{1250,,TarFile} class can now be used as a context manager.  In
addition, its @ref{c0e,,add()} method has a new option, `filter',
that controls which files are added to the archive and allows the file metadata
to be edited.

The new `filter' option replaces the older, less flexible `exclude' parameter
which is now deprecated.  If specified, the optional `filter' parameter needs to
be a @ref{d34,,keyword argument}.  The user-supplied filter function accepts a
@ref{1251,,TarInfo} object and returns an updated
@ref{1251,,TarInfo} object, or if it wants the file to be excluded, the
function can return @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

(Proposed by Tarek Ziadé and implemented by Lars Gustäbel in bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856}.)

@node hashlib<7>,ast<5>,tarfile<10>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 hashlib}@anchor{1252}
@subsubsection hashlib


The @ref{68,,hashlib} module has two new constant attributes listing the hashing
algorithms guaranteed to be present in all implementations and those available
on the current implementation:

@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

(Suggested by Carl Chenet in bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418}.)

@node ast<5>,os<13>,hashlib<7>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 ast}@anchor{1253}
@subsubsection ast


The @ref{8,,ast} module has a wonderful a general-purpose tool for safely
evaluating expression strings using the Python literal
syntax.  The @ref{c32,,ast.literal_eval()} function serves as a secure alternative to
the builtin @ref{180,,eval()} function which is easily abused.  Python 3.2 adds
@ref{1c2,,bytes} and @ref{5d9,,set} literals to the list of supported types:
strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and @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

(Implemented by Benjamin Peterson and Georg Brandl.)

@node os<13>,shutil<8>,ast<5>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 os}@anchor{1254}
@subsubsection os


Different operating systems use various encodings for filenames and environment
variables.  The @ref{a1,,os} module provides two new functions,
@ref{c70,,fsencode()} and @ref{c6f,,fsdecode()}, for encoding and decoding
filenames:

@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{1255,,os.supports_bytes_environ} constant will be
true.

For direct access to encoded environment variables (if available),
use the new @ref{1256,,os.getenvb()} function or use @ref{1257,,os.environb}
which is a bytes version of @ref{11f9,,os.environ}.

(Contributed by Victor Stinner.)

@node shutil<8>,sqlite3<11>,os<13>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 shutil}@anchor{1258}
@subsubsection shutil


The @ref{a33,,shutil.copytree()} function has two new options:


@itemize *

@item 
`ignore_dangling_symlinks': when @code{symlinks=False} so that the function
copies a file pointed to by a symlink, not the symlink itself. This option
will silence the error raised if the file doesn’t exist.

@item 
`copy_function': is a callable that will be used to copy files.
@ref{a65,,shutil.copy2()} is used by default.
@end itemize

(Contributed by Tarek Ziadé.)

In addition, the @ref{c5,,shutil} module now supports @ref{1259,,archiving operations} for zipfiles, uncompressed tarfiles, gzipped tarfiles,
and bzipped tarfiles.  And there are functions for registering additional
archiving file formats (such as xz compressed tarfiles or custom formats).

The principal functions are @ref{4b3,,make_archive()} and
@ref{46b,,unpack_archive()}.  By default, both operate on the current
directory (which can be set by @ref{60d,,os.chdir()}) and on any sub-directories.
The archive filename needs to be specified with a full pathname.  The archiving
step is non-destructive (the original files are left unchanged).

@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

(Contributed by Tarek Ziadé.)

@node sqlite3<11>,html<3>,shutil<8>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 sqlite3}@anchor{125a}
@subsubsection sqlite3


The @ref{cf,,sqlite3} module was updated to pysqlite version 2.6.0.  It has two new capabilities.


@itemize *

@item 
The @code{sqlite3.Connection.in_transit} attribute is true if there is an
active transaction for uncommitted changes.

@item 
The @ref{841,,sqlite3.Connection.enable_load_extension()} and
@ref{4b8,,sqlite3.Connection.load_extension()} methods allows you to load SQLite
extensions from “.so” files.  One well-known extension is the fulltext-search
extension distributed with SQLite.
@end itemize

(Contributed by R. David Murray and Shashwat Anand; bpo-8845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8845}.)

@node html<3>,socket<11>,sqlite3<11>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 html}@anchor{125b}
@subsubsection html


A new @ref{6b,,html} module was introduced with only a single function,
@ref{1044,,escape()}, which is used for escaping reserved characters from HTML
markup:

@example
>>> import html
>>> html.escape('x > 2 && x < 7')
'x &gt; 2 &amp;&amp; x &lt; 7'
@end example

@node socket<11>,ssl<12>,html<3>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 socket}@anchor{125c}
@subsubsection socket


The @ref{cc,,socket} module has two new improvements.


@itemize *

@item 
Socket objects now have a @ref{125d,,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{672,,socket.create_connection()} now supports the context management protocol
to unconditionally consume @ref{108e,,socket.error} exceptions and to close the
socket when done.
(Contributed by Giampaolo Rodolà; bpo-9794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9794}.)
@end itemize

@node ssl<12>,nntp,socket<11>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 ssl}@anchor{125e}
@subsubsection ssl


The @ref{d0,,ssl} module added a number of features to satisfy common requirements
for secure (encrypted, authenticated) internet connections:


@itemize *

@item 
A new class, @ref{294,,SSLContext}, serves as a container for persistent
SSL data, such as protocol settings, certificates, private keys, and various
other options. It includes a @ref{525,,wrap_socket()} for creating
an SSL socket from an SSL context.

@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{525,,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 
When linked against recent versions of OpenSSL, the @ref{d0,,ssl} module now
supports the Server Name Indication extension to the TLS protocol, allowing
multiple “virtual hosts” using different certificates on a single IP port.
This extension is only supported in client mode, and is activated by passing
the `server_hostname' argument to @ref{525,,ssl.SSLContext.wrap_socket()}.

@item 
Various options have been added to the @ref{d0,,ssl} module, such as
@ref{83c,,OP_NO_SSLv2} which disables the insecure and obsolete SSLv2
protocol.

@item 
The extension now loads all the OpenSSL ciphers and digest algorithms.  If
some SSL certificates cannot be verified, they are reported as an “unknown
algorithm” error.

@item 
The version of OpenSSL being used is now accessible using the module
attributes @ref{125f,,ssl.OPENSSL_VERSION} (a string),
@ref{1260,,ssl.OPENSSL_VERSION_INFO} (a 5-tuple), and
@ref{1261,,ssl.OPENSSL_VERSION_NUMBER} (an integer).
@end itemize

(Contributed by Antoine Pitrou in 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}, and bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321}.)

@node nntp,сертифікати,ssl<12>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 nntp}@anchor{1262}
@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.

(Contributed by Antoine Pitrou in bpo-9360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9360} and Andrew Vant in bpo-1926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1926}.)

@node сертифікати,imaplib<4>,nntp,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 certificates}@anchor{1263}
@subsubsection сертифікати


@ref{b54,,http.client.HTTPSConnection}, @ref{1264,,urllib.request.HTTPSHandler}
and @ref{293,,urllib.request.urlopen()} now take optional arguments to allow for
server certificate checking against a set of Certificate Authorities,
as recommended in public uses of HTTPS.

(Added by Antoine Pitrou, bpo-9003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9003}.)

@node imaplib<4>,http client<4>,сертифікати,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 imaplib}@anchor{1265}
@subsubsection imaplib


Support for explicit TLS on standard IMAP4 connections has been added through
the new @ref{1266,,imaplib.IMAP4.starttls} method.

(Contributed by Lorenzo M. Catucci and Antoine Pitrou, bpo-4471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4471}.)

@node http client<4>,unittest<11>,imaplib<4>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 http-client}@anchor{1267}
@subsubsection http.client


There were a number of small API improvements in the @ref{6f,,http.client} module.
The old-style HTTP 0.9 simple responses are no longer supported and the `strict'
parameter is deprecated in all classes.

The @ref{b53,,HTTPConnection} and
@ref{b54,,HTTPSConnection} classes now have a `source_address'
parameter for a (host, port) tuple indicating where the HTTP connection is made
from.

Support for certificate checking and HTTPS virtual hosts were added to
@ref{b54,,HTTPSConnection}.

The @ref{cc9,,request()} method on connection objects
allowed an optional `body' argument so that a @ref{1203,,file object} could be used
to supply the content of the request.  Conveniently, the `body' argument now
also accepts an @ref{1268,,iterable} object so long as it includes an explicit
@code{Content-Length} header.  This extended interface is much more flexible than
before.

To establish an HTTPS connection through a proxy server, there is a new
@ref{1269,,set_tunnel()} method that sets the host and
port for HTTP Connect tunneling.

To match the behavior of @ref{72,,http.server}, the HTTP client library now also
encodes headers with ISO-8859-1 (Latin-1) encoding.  It was already doing that
for incoming headers, so now the behavior is consistent for both incoming and
outgoing traffic. (See work by Armin Ronacher in bpo-10980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10980}.)

@node unittest<11>,random<5>,http client<4>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 unittest}@anchor{126a}
@subsubsection unittest


The unittest module has a number of improvements supporting test discovery for
packages, easier experimentation at the interactive prompt, new testcase
methods, improved diagnostic messages for test failures, and better method
names.


@itemize *

@item 
The command-line call @code{python -m unittest} can now accept file paths
instead of module names for running specific tests (bpo-10620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10620}).  The new
test discovery can find tests within packages, locating any test importable
from the top-level directory.  The top-level directory can be specified with
the @code{-t} option, a pattern for matching files with @code{-p}, and a directory to
start discovery with @code{-s}:

@example
$ python -m unittest discover -s my_proj_dir -p _test.py
@end example

(Contributed by Michael Foord.)

@item 
Experimentation at the interactive prompt is now easier because the
@ref{44f,,unittest.TestCase} class can now be instantiated without
arguments:

@example
>>> from unittest import TestCase
>>> TestCase().assertEqual(pow(2, 3), 8)
@end example

(Contributed by Michael Foord.)

@item 
The @ref{106,,unittest} module has two new methods,
@ref{11a3,,assertWarns()} and
@ref{11a4,,assertWarnsRegex()} to verify that a given warning type
is triggered by the code under test:

@example
with self.assertWarns(DeprecationWarning):
    legacy_function('XYZ')
@end example

(Contributed by Antoine Pitrou, bpo-9754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9754}.)

Another new method, @ref{126b,,assertCountEqual()} is used to
compare two iterables to determine if their element counts are equal (whether
the same elements are present with the same number of occurrences regardless
of order):

@example
def test_anagram(self):
    self.assertCountEqual('algorithm', 'logarithm')
@end example

(Contributed by Raymond Hettinger.)

@item 
A principal feature of the unittest module is an effort to produce meaningful
diagnostics when a test fails.  When possible, the failure is recorded along
with a diff of the output.  This is especially helpful for analyzing log files
of failed test runs. However, since diffs can sometime be voluminous, there is
a new @ref{126c,,maxDiff} attribute that sets maximum length of
diffs displayed.

@item 
In addition, the method names in the module have undergone a number of clean-ups.

For example, @ref{52e,,assertRegex()} is the new name for
@code{assertRegexpMatches()} which was misnamed because the
test uses @ref{126d,,re.search()}, not @ref{126e,,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.

(Contributed by Raymond Hettinger and implemented by Ezio Melotti.)

@item 
To improve consistency, some long-standing method aliases are being
deprecated in favor of the preferred names:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Old Name

@tab

Preferred Name

@item

@code{assert_()}

@tab

@ref{527,,assertTrue()}

@item

@code{assertEquals()}

@tab

@ref{529,,assertEqual()}

@item

@code{assertNotEquals()}

@tab

@ref{52a,,assertNotEqual()}

@item

@code{assertAlmostEquals()}

@tab

@ref{52b,,assertAlmostEqual()}

@item

@code{assertNotAlmostEquals()}

@tab

@ref{52c,,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.

(Contributed by 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.

(Contributed by Raymond Hettinger.)
@end itemize

@node random<5>,poplib<4>,unittest<11>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 random}@anchor{126f}
@subsubsection random


The integer methods in the @ref{b8,,random} module now do a better job of producing
uniform distributions.  Previously, they computed selections with
@code{int(n*random())} which had a slight bias whenever `n' was not a power of two.
Now, multiple selections are made from a range up to the next power of two and a
selection is kept only when it falls within the range @code{0 <= x < n}.  The
functions and methods affected are @ref{86f,,randrange()},
@ref{1270,,randint()}, @ref{1271,,choice()}, @ref{747,,shuffle()} and
@ref{746,,sample()}.

(Contributed by Raymond Hettinger; bpo-9025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9025}.)

@node poplib<4>,asyncore<2>,random<5>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 poplib}@anchor{1272}
@subsubsection poplib


@ref{92b,,POP3_SSL} class now accepts a `context' parameter, which is a
@ref{294,,ssl.SSLContext} object allowing bundling SSL configuration options,
certificates and private keys into a single (potentially long-lived)
structure.

(Contributed by Giampaolo Rodolà; bpo-8807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8807}.)

@node asyncore<2>,tempfile<5>,poplib<4>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 asyncore}@anchor{1273}
@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.

(Contributed by Giampaolo Rodolà; bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706}.)

@node tempfile<5>,inspect<10>,asyncore<2>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 tempfile}@anchor{1274}
@subsubsection tempfile


The @ref{e0,,tempfile} module has a new context manager,
@ref{1275,,TemporaryDirectory} which provides easy deterministic
cleanup of temporary directories:

@example
with tempfile.TemporaryDirectory() as tmpdirname:
    print('created temporary dir:', tmpdirname)
@end example

(Contributed by Neil Schemenauer and Nick Coghlan; bpo-5178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5178}.)

@node inspect<10>,pydoc<6>,tempfile<5>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 inspect}@anchor{1276}
@subsubsection inspect



@itemize *

@item 
The @ref{7e,,inspect} module has a new function
@ref{1277,,getgeneratorstate()} to easily identify the current state of a
generator-iterator:

@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

(Contributed by Rodolpho Eckhardt and Nick Coghlan, bpo-10220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10220}.)

@item 
To support lookups without the possibility of activating a dynamic attribute,
the @ref{7e,,inspect} module has a new function, @ref{494,,getattr_static()}.
Unlike @ref{4d2,,hasattr()}, this is a true read-only search, guaranteed not to
change state while it is searching:

@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

(Contributed by Michael Foord.)
@end quotation

@node pydoc<6>,dis<5>,inspect<10>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 pydoc}@anchor{1278}
@subsubsection pydoc


The @ref{b5,,pydoc} module now provides a much-improved web server interface, as
well as a new command-line option @code{-b} to automatically open a browser window
to display that server:

@example
$ pydoc3.2 -b
@end example

(Contributed by Ron Adam; bpo-2001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2001}.)

@node dis<5>,dbm<7>,pydoc<6>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 dis}@anchor{1279}
@subsubsection dis


The @ref{38,,dis} module gained two new functions for inspecting code,
@ref{127a,,code_info()} and @ref{f5e,,show_code()}.  Both provide detailed code
object information for the supplied function, method, source code string or code
object.  The former returns a string and the latter prints it:

@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

In addition, the @ref{b46,,dis()} function now accepts string arguments
so that the common idiom @code{dis(compile(s, '@w{'}, 'eval'))} can be shortened
to @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

Taken together, these improvements make it easier to explore how CPython is
implemented and to see for yourself what the language syntax does
under-the-hood.

(Contributed by Nick Coghlan in bpo-9147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9147}.)

@node dbm<7>,ctypes<3>,dis<5>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 dbm}@anchor{127b}
@subsubsection dbm


All database modules now support the @code{get()} and @code{setdefault()} methods.

(Suggested by Ray Allen in bpo-9523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9523}.)

@node ctypes<3>,site<4>,dbm<7>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 ctypes}@anchor{127c}
@subsubsection ctypes


A new type, @ref{127d,,ctypes.c_ssize_t} represents the C @code{ssize_t} datatype.

@node site<4>,sysconfig<3>,ctypes<3>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 site}@anchor{127e}
@subsubsection site


The @ref{c7,,site} module has three new functions useful for reporting on the
details of a given Python installation.


@itemize *

@item 
@ref{127f,,getsitepackages()} lists all global site-packages directories.

@item 
@ref{1280,,getuserbase()} reports on the user’s base directory where data can
be stored.

@item 
@ref{1281,,getusersitepackages()} reveals the user-specific site-packages
directory path.
@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

Conveniently, some of site’s functionality is accessible directly from the
command-line:

@example
$ python -m site --user-base
/Users/raymondhettinger/.local
$ python -m site --user-site
/Users/raymondhettinger/.local/lib/python3.2/site-packages
@end example

(Contributed by Tarek Ziadé in bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693}.)

@node sysconfig<3>,pdb<8>,site<4>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 sysconfig}@anchor{1282}
@subsubsection sysconfig


The new @ref{db,,sysconfig} module makes it straightforward to discover
installation paths and configuration variables that vary across platforms and
installations.

The module offers access simple access functions for platform and version
information:


@itemize *

@item 
@ref{1283,,get_platform()} returning values like `linux-i586' or
`macosx-10.6-ppc'.

@item 
@ref{1284,,get_python_version()} returns a Python version string
such as “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{1285,,get_paths()} makes a dictionary containing installation paths
for the current installation scheme.

@item 
@ref{1064,,get_config_vars()} returns a dictionary of platform specific
variables.
@end itemize

There is also a convenient command-line interface:

@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

(Moved out of Distutils by Tarek Ziadé.)

@node pdb<8>,configparser<5>,sysconfig<3>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 pdb}@anchor{1286}
@subsubsection pdb


The @ref{a5,,pdb} debugger module gained a number of usability improvements:


@itemize *

@item 
@code{pdb.py} now has a @code{-c} option that executes commands as given in a
@code{.pdbrc} script file.

@item 
A @code{.pdbrc} script file can contain @code{continue} and @code{next} commands
that continue debugging.

@item 
The @ref{928,,Pdb} class constructor now accepts a `nosigint' argument.

@item 
New commands: @code{l(list)}, @code{ll(long list)} and @code{source} for
listing source code.

@item 
New commands: @code{display} and @code{undisplay} for showing or hiding
the value of an expression if it has changed.

@item 
New command: @code{interact} for starting an interactive interpreter containing
the global and local  names found in the current scope.

@item 
Breakpoints can be cleared by breakpoint number.
@end itemize

(Contributed by Georg Brandl, Antonio Cuni and Ilya Sandler.)

@node configparser<5>,urllib parse<6>,pdb<8>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 configparser}@anchor{1287}
@subsubsection configparser


The @ref{22,,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{1c8,,ConfigParser}. Support
for inline comments is now turned off by default and section or option
duplicates are not allowed in a single configuration source.

Config parsers gained a new API based on the mapping protocol:

@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

The new API is implemented on top of the classical API, so custom parser
subclasses should be able to use it without modifications.

The INI file structure accepted by config parsers can now be customized. Users
can specify alternative option/value delimiters and comment prefixes, change the
name of the `DEFAULT' section or switch the interpolation syntax.

There is support for pluggable interpolation including an additional interpolation
handler @ref{723,,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

A number of smaller features were also introduced, like support for specifying
encoding in read operations, specifying fallback values for get-functions, or
reading directly from dictionaries and strings.

(All changes contributed by Łukasz Langa.)

@c XXX consider showing a difflib example

@node urllib parse<6>,mailbox,configparser<5>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 urllib-parse}@anchor{1288}
@subsubsection urllib.parse


A number of usability improvements were made for the @ref{10a,,urllib.parse} module.

The @ref{30d,,urlparse()} function now supports IPv6@footnote{https://en.wikipedia.org/wiki/IPv6} addresses as described in 
@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

The @ref{1289,,urldefrag()} function now returns a @ref{64e,,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

And, the @ref{ec4,,urlencode()} function is now much more flexible,
accepting either a string or bytes type for the `query' argument.  If it is a
string, then the `safe', `encoding', and `error' parameters are sent to
@ref{128a,,quote_plus()} for encoding:

@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

As detailed in @ref{128b,,Analisando bytes codificados em ASCII}, all the @ref{10a,,urllib.parse}
functions now accept ASCII-encoded byte strings as input, so long as they are
not mixed with regular strings.  If ASCII-encoded byte strings are given as
parameters, the return types will also be an ASCII-encoded byte strings:

@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

(Work by Nick Coghlan, Dan Mahn, and Senthil Kumaran in bpo-2987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2987},
bpo-5468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5468}, and bpo-9873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9873}.)

@node mailbox,turtledemo,urllib parse<6>,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 mailbox}@anchor{128c}
@subsubsection mailbox


Thanks to a concerted effort by R. David Murray, the @ref{8b,,mailbox} module has
been fixed for Python 3.2.  The challenge was that mailbox had been originally
designed with a text interface, but email messages are best represented with
@ref{1c2,,bytes} because various parts of a message may have different encodings.

The solution harnessed the @ref{3b,,email} package’s binary support for parsing
arbitrary email messages.  In addition, the solution required a number of API
changes.

As expected, the @ref{128d,,add()} method for
@ref{128e,,mailbox.Mailbox} objects now accepts binary input.

@ref{f59,,StringIO} and text file input are deprecated.  Also, string input
will fail early if non-ASCII characters are used.  Previously it would fail when
the email was processed in a later step.

There is also support for binary output.  The @ref{128f,,get_file()}
method now returns a file in the binary mode (where it used to incorrectly set
the file to text-mode).  There is also a new @ref{1290,,get_bytes()}
method that returns a @ref{1c2,,bytes} representation of a message corresponding
to a given `key'.

It is still possible to get non-binary output using the old API’s
@ref{1291,,get_string()} method, but that approach
is not very useful.  Instead, it is best to extract messages from
a @ref{1292,,Message} object or to load them from binary input.

(Contributed by R. David Murray, with efforts from Steffen Daode Nurpmeso and an
initial patch by Victor Stinner in bpo-9124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9124}.)

@node turtledemo,,mailbox,New Improved and Deprecated Modules
@anchor{whatsnew/3 2 turtledemo}@anchor{1293}
@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{3b4,,sys.path}, it can now be run directly
from the command-line:

@example
$ python -m turtledemo
@end example

(Moved from the Demo directory by Alexander Belopolsky in bpo-10199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10199}.)

@node Multi-threading,Otimizações<11>,New Improved and Deprecated Modules,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 multi-threading}@anchor{1294}
@subsection Multi-threading



@itemize *

@item 
The mechanism for serializing execution of concurrently running Python threads
(generally known as the @ref{159,,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{951,,sys.setswitchinterval()}.
It currently defaults to 5 milliseconds.

Additional details about the implementation can be read from a python-dev mailing-list message@footnote{https://mail.python.org/pipermail/python-dev/2009-October/093321.html}
(however, “priority requests” as exposed in this message have not been kept
for inclusion).

(Contribuição de Antoine Pitrou.)

@item 
Regular and recursive locks now accept an optional `timeout' argument to their
@ref{698,,acquire()} method.  (Contributed by Antoine Pitrou;
bpo-7316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7316}.)

@item 
Similarly, @ref{1295,,threading.Semaphore.acquire()} also gained a `timeout'
argument.  (Contributed by Torsten Landschoff; bpo-850728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=850728}.)

@item 
Regular and recursive lock acquisitions can now be interrupted by signals on
platforms using Pthreads.  This means that Python programs that deadlock while
acquiring locks can be successfully killed by repeatedly sending SIGINT to the
process (by pressing @code{Ctrl}+@code{C} in most shells).
(Contributed by Reid Kleckner; bpo-8844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8844}.)
@end itemize

@node Otimizações<11>,Unicode,Multi-threading,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 optimizations}@anchor{1296}
@subsection Otimizações


A number of small performance enhancements have been added:


@itemize *

@item 
Python’s peephole optimizer now recognizes patterns such @code{x in @{1, 2, 3@}} as
being a test for membership in a set of constants.  The optimizer recasts the
@ref{5d9,,set} as a @ref{5da,,frozenset} and stores the pre-built constant.

Now that the speed penalty is gone, it is practical to start writing
membership tests using set-notation.  This style is both semantically clear
and operationally fast:

@example
extension = name.rpartition('.')[2]
if extension in @{'xml', 'html', 'xhtml', 'css'@}:
    handle(name)
@end example

(Patch and additional tests contributed by Dave Malcolm; bpo-6690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6690}).

@item 
Serializing and unserializing data using the @ref{a6,,pickle} module is now
several times faster.

(Contributed by Alexandre Vassalotti, Antoine Pitrou
and the Unladen Swallow team in bpo-9410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9410} and bpo-3873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3873}.)

@item 
The Timsort algorithm@footnote{https://en.wikipedia.org/wiki/Timsort} used in
@ref{be8,,list.sort()} and @ref{be7,,sorted()} now runs faster and uses less memory
when called with a @ref{e31,,key function}.  Previously, every element of
a list was wrapped with a temporary object that remembered the key value
associated with each element.  Now, two arrays of keys and values are
sorted in parallel.  This saves the memory consumed by the sort wrappers,
and it saves time lost to delegating comparisons.

(Patch by Daniel Stutzbach in bpo-9915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9915}.)

@item 
JSON decoding performance is improved and memory consumption is reduced
whenever the same string is repeated for multiple keys.  Also, JSON encoding
now uses the C speedups when the @code{sort_keys} argument is true.

(Contributed by Antoine Pitrou in bpo-7451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7451} and by Raymond Hettinger and
Antoine Pitrou in bpo-10314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10314}.)

@item 
Recursive locks (created with the @ref{2de,,threading.RLock()} API) now benefit
from a C implementation which makes them as fast as regular locks, and between
10x and 15x faster than their previous pure Python implementation.

(Contributed by 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{ed9,,split()},
@ref{1297,,rsplit()}, @ref{1298,,splitlines()} and @ref{19a,,replace()} methods on
@ref{1c2,,bytes}, @ref{2ea,,bytearray} and @ref{44c,,str} objects. Likewise, the
algorithm is also used by @ref{ed8,,rfind()}, @ref{1299,,rindex()}, @ref{1297,,rsplit()} and
@ref{129a,,rpartition()}.

(Patch by Florent Xicluna in bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622} and bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462}.)

@item 
Integer to string conversions now work two “digits” at a time, reducing the
number of division and modulo operations.

(bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713} by Gawain Bolton, Mark Dickinson, and 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{110a,,BaseHTTPRequestHandler}
has more efficient buffering (bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709} by Andrew Schaaf).  The
@ref{e60,,operator.attrgetter()} function has been sped-up (bpo-10160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10160} by
Christos Georgiou).  And @ref{1c8,,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,Otimizações<11>,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 unicode}@anchor{129b}
@subsection Unicode


Python has been updated to Unicode 6.0.0@footnote{https://unicode.org/versions/Unicode6.0.0/}.  The update to the standard adds
over 2,000 new characters including emoji@footnote{https://en.wikipedia.org/wiki/Emoji}
symbols which are important for mobile phones.

In addition, the updated standard has altered the character properties for two
Kannada characters (U+0CF1, U+0CF2) and one New Tai Lue numeric character
(U+19DA), making the former eligible for use in identifiers while disqualifying
the latter.  For more information, see Unicode Character Database Changes@footnote{https://www.unicode.org/versions/Unicode6.0.0/#Database_Changes}.

@node Codecs,Documentação,Unicode,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 codecs}@anchor{129c}
@subsection Codecs


Support was added for `cp720' Arabic DOS encoding (bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979}).

MBCS encoding no longer ignores the error handler argument. In the default
strict mode, it raises an @ref{a1d,,UnicodeDecodeError} when it encounters an
undecodable byte sequence and an @ref{677,,UnicodeEncodeError} for an unencodable
character.

The MBCS codec supports @code{'strict'} and @code{'ignore'} error handlers for
decoding, and @code{'strict'} and @code{'replace'} for encoding.

To emulate Python3.1 MBCS encoding, select the @code{'ignore'} handler for decoding
and the @code{'replace'} handler for encoding.

On Mac OS X, Python decodes command line arguments with @code{'utf-8'} rather than
the locale encoding.

By default, @ref{de,,tarfile} uses @code{'utf-8'} encoding on Windows (instead of
@code{'mbcs'}) and the @code{'surrogateescape'} error handler on all operating
systems.

@node Documentação,IDLE,Codecs,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 documentation}@anchor{129d}
@subsection Documentação


The documentation continues to be improved.


@itemize *

@item 
A table of quick links has been added to the top of lengthy sections such as
@ref{129e,,Funções embutidas}.  In the case of @ref{81,,itertools}, the links are
accompanied by tables of cheatsheet-style summaries to provide an overview and
memory jog without having to read all of the docs.

@item 
In some cases, the pure Python source code can be a helpful adjunct to the
documentation, so now many modules now feature quick links to the latest
version of the source code.  For example, the @ref{5f,,functools} module
documentation has a quick link at the top labeled:

@quotation

`Source code' Lib/functools.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/functools.py}.
@end quotation

(Contributed by Raymond Hettinger; see
rationale@footnote{https://rhettinger.wordpress.com/2011/01/28/open-your-source-more/}.)

@item 
The docs now contain more examples and recipes.  In particular, @ref{b9,,re}
module has an extensive section, @ref{129f,,Exemplos de expressão regular}.  Likewise, the
@ref{81,,itertools} module continues to be updated with new
@ref{12a0,,Receitas com itertools}.

@item 
The @ref{30,,datetime} module now has an auxiliary implementation in pure Python.
No functionality was changed.  This just provides an easier-to-read alternate
implementation.

(Contributed by Alexander Belopolsky in bpo-9528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9528}.)

@item 
The unmaintained @code{Demo} directory has been removed.  Some demos were
integrated into the documentation, some were moved to the @code{Tools/demo}
directory, and others were removed altogether.

(Contributed by Georg Brandl in bpo-7962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7962}.)
@end itemize

@node IDLE,Code Repository,Documentação,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 idle}@anchor{12a1}
@subsection IDLE



@itemize *

@item 
The format menu now has an option to clean source files by stripping
trailing whitespace.

(Contributed by Raymond Hettinger; bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150}.)

@item 
IDLE on Mac OS X now works with both Carbon AquaTk and Cocoa AquaTk.

(Contributed by Kevin Walzer, Ned Deily, and Ronald Oussoren; bpo-6075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6075}.)
@end itemize

@node Code Repository,Mudanças a construções e API C<5>,IDLE,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 code-repository}@anchor{12a2}
@subsection Code Repository


In addition to the existing Subversion code repository at @indicateurl{https://svn.python.org}
there is now a Mercurial@footnote{https://www.mercurial-scm.org/} repository at
@indicateurl{https://hg.python.org/}.

After the 3.2 release, there are plans to switch to Mercurial as the primary
repository.  This distributed version control system should make it easier for
members of the community to create and share external changesets.  See
@geindex Propostas de Melhorias do Python; PEP 385
PEP 385@footnote{https://peps.python.org/pep-0385/} for details.

To learn to use the new version control system, see the Quick Start@footnote{https://www.mercurial-scm.org/wiki/QuickStart} or the Guide to Mercurial Workflows@footnote{https://www.mercurial-scm.org/guide}.

@node Mudanças a construções e API C<5>,Porting to Python 3 2,Code Repository,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 build-and-c-api-changes}@anchor{12a3}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
The `idle', `pydoc' and `2to3' scripts are now installed with a
version-specific suffix on @code{make altinstall} (bpo-10679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10679}).

@item 
The C functions that access the Unicode Database now accept and return
characters from the full Unicode range, even on narrow unicode builds
(Py_UNICODE_TOLOWER, Py_UNICODE_ISDECIMAL, and others).  A visible difference
in Python is that @ref{12a4,,unicodedata.numeric()} now returns the correct value
for large code points, and @ref{800,,repr()} may consider more characters as
printable.

(Reported by Bupjoe Lee and fixed by Amaury Forgeot D’Arc; bpo-5127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5127}.)

@item 
Computed gotos are now enabled by default on supported compilers (which are
detected by the configure script).  They can still be disabled selectively by
specifying @code{--without-computed-gotos}.

(Contributed by Antoine Pitrou; bpo-9203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9203}.)

@item 
The option @code{--with-wctype-functions} was removed.  The built-in unicode
database is now used for all functions.

(Contributed by Amaury Forgeot D’Arc; bpo-9210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9210}.)

@item 
Hash values are now values of a new type, @ref{12a5,,Py_hash_t}, which is
defined to be the same size as a pointer.  Previously they were of type long,
which on some 64-bit operating systems is still only 32 bits long.  As a
result of this fix, @ref{5d9,,set} and @ref{256,,dict} can now hold more than
@code{2**32} entries on builds with 64-bit pointers (previously, they could grow
to that size but their performance degraded catastrophically).

(Suggested by Raymond Hettinger and implemented by 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{12a6,,sys.argv} without also modifying @ref{3b4,,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 
There is a new function @ref{12a7,,PyLong_AsLongLongAndOverflow()} which
is analogous to @ref{12a8,,PyLong_AsLongAndOverflow()}.  They both serve to
convert Python @ref{257,,int} into a native fixed-width type while providing
detection of cases where the conversion won’t fit (bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767}).

@item 
The @ref{12a9,,PyUnicode_CompareWithASCIIString()} function now returns `not
equal' if the Python string is `NUL' terminated.

@item 
There is a new function @ref{12aa,,PyErr_NewExceptionWithDoc()} that is
like @ref{12ab,,PyErr_NewException()} but allows a docstring to be specified.
This lets C exceptions have the same self-documenting capabilities as
their pure Python counterparts (bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033}).

@item 
When compiled with the @code{--with-valgrind} option, the pymalloc
allocator will be automatically disabled when running under Valgrind.  This
gives improved memory leak detection when running under Valgrind, while taking
advantage of pymalloc at other times (bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422}).

@item 
Removed the @code{O?} format from the `PyArg_Parse' functions.  The format is no
longer used and it had never been documented (bpo-8837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8837}).
@end itemize

There were a number of other small changes to the C-API.  See the
Misc/NEWS@footnote{https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS}
file for a complete list.

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 Porting to Python 3 2,,Mudanças a construções e API C<5>,O que há de novo no Python 3 2
@anchor{whatsnew/3 2 porting-to-python-3-2}@anchor{12ac}
@subsection Porting to Python 3.2


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.


@itemize *

@item 
The @ref{22,,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 
The interpolation syntax is now validated on
@ref{12ad,,get()} and
@ref{12ae,,set()} operations. In the default
interpolation scheme, only two tokens with percent signs are valid: @code{%(name)s}
and @code{%%}, the latter being an escaped percent sign.

@item 
The @ref{12ae,,set()} and
@ref{12af,,add_section()} methods now verify that
values are actual strings.  Formerly, unsupported types could be introduced
unintentionally.

@item 
Duplicate sections or options from a single source now raise either
@ref{12b0,,DuplicateSectionError} or
@ref{12b1,,DuplicateOptionError}.  Formerly, duplicates would
silently overwrite a previous entry.

@item 
Inline comments are now disabled by default so now the `;' character
can be safely used in values.

@item 
Comments now can be indented.  Consequently, for `;' or `#' to appear at
the start of a line in multiline values, it has to be interpolated.  This
keeps comment prefix characters in values from being mistaken as comments.

@item 
@code{""} is now a valid value and is no longer automatically converted to an
empty string. For empty strings, use @code{"option ="} in a line.
@end itemize

@item 
The @code{nntplib} module was reworked extensively, meaning that its APIs
are often incompatible with the 3.1 APIs.

@item 
@ref{2ea,,bytearray} objects can no longer be used as filenames; instead,
they should be converted to @ref{1c2,,bytes}.

@item 
The @code{array.tostring()} and @code{array.fromstring()} have been renamed to
@ref{12b2,,array.tobytes()} and
@ref{12b3,,array.frombytes()} for clarity.  The old names
have been deprecated. (See bpo-8990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8990}.)

@item 
@code{PyArg_Parse*()} functions:


@itemize *

@item 
“t#” format has been removed: use “s#” or “s*” instead

@item 
“w” and “w#” formats has been removed: use “w*” instead
@end itemize

@item 
The @code{PyCObject} type, deprecated in 3.1, has been removed.  To wrap
opaque C pointers in Python objects, the @ref{12b4,,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 
The @ref{12b5,,random.seed()} function and method now salt string seeds with an
sha512 hash function.  To access the previous version of `seed' in order to
reproduce Python 3.1 sequences, set the `version' argument to `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{12b6,,bytes.maketrans()} and
@ref{12b7,,bytearray.maketrans()}.  This change solves the confusion around which
types were supported by the @ref{d3,,string} module.  Now, @ref{44c,,str},
@ref{1c2,,bytes}, and @ref{2ea,,bytearray} each have their own `maketrans' and
`translate' methods with intermediate translation tables of the appropriate
type.

(Contributed by 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{5d2,,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

(Contributed by Georg Brandl and Mattias Brändström;
appspot issue 53094@footnote{https://codereview.appspot.com/53094}.)

@item 
@ref{12b8,,struct.pack()} now only allows bytes for the @code{s} string pack code.
Formerly, it would accept text arguments and implicitly encode them to bytes
using UTF-8.  This was problematic because it made assumptions about the
correct encoding and because a variable-length encoding can fail when writing
to fixed length segment of a structure.

Code such as @code{struct.pack('<6sHHBBB', 'GIF87a', x, y)} should be rewritten
with to use bytes instead of text, @code{struct.pack('<6sHHBBB', b'GIF87a', x, y)}.

(Discovered by David Beazley and fixed by Victor Stinner; bpo-10783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10783}.)

@item 
The @ref{125,,xml.etree.ElementTree} class now raises an
@ref{12b9,,xml.etree.ElementTree.ParseError} when a parse fails. Previously it
raised an @ref{12ba,,xml.parsers.expat.ExpatError}.

@item 
The new, longer @ref{44c,,str()} value on floats may break doctests which rely on
the old output format.

@item 
In @ref{199,,subprocess.Popen}, the default value for `close_fds' is now
@code{True} under Unix; under Windows, it is @code{True} if the three standard
streams are set to @code{None}, @code{False} otherwise.  Previously, `close_fds'
was always @code{False} by default, which produced difficult to solve bugs
or race conditions when open file descriptors would leak into the child
process.

@item 
Support for legacy HTTP 0.9 has been removed from @ref{10b,,urllib.request}
and @ref{6f,,http.client}.  Such support is still present on the server side
(in @ref{72,,http.server}).

(Contributed by Antoine Pitrou, bpo-10711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10711}.)

@item 
SSL sockets in timeout mode now raise @ref{837,,socket.timeout} when a timeout
occurs, rather than a generic @ref{12bb,,SSLError}.

(Contributed by 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{3a8,,PyEval_SaveThread()}
and @ref{3a9,,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.

(Contributed by Giampaolo Rodola in bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706}.)

@item 
Due to the new @ref{159,,GIL} implementation, @code{PyEval_InitThreads()}
cannot be called before @ref{8b1,,Py_Initialize()} anymore.
@end itemize

@node O que há de novo no Python 3 1,O que há de novo no Python 3 0,O que há de novo no Python 3 2,O que há de novo no Python
@anchor{whatsnew/3 1 doc}@anchor{12bc}@anchor{whatsnew/3 1 translation-repo}@anchor{12bd}@anchor{whatsnew/3 1 what-s-new-in-python-3-1}@anchor{12be}
@section O que há de novo no 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.

Esse artigo explica os novos recursos em Python 3.1, comparado ao 3.0. Python 3.1 foi lançado em 27 de junho de 2009.

@menu
* PEP 372; Dicionários ordenados: PEP 372 Dicionários ordenados. 
* PEP 378; Especificador de formato para separador de milhares: PEP 378 Especificador de formato para separador de milhares. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<13>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<2>. 
* Otimizações: Otimizações<12>. 
* IDLE: IDLE<2>. 
* Mudanças a construções e API C: Mudanças a construções e API C<6>. 
* Porting to Python 3.1: Porting to Python 3 1. 

@end menu

@node PEP 372 Dicionários ordenados,PEP 378 Especificador de formato para separador de milhares,,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 pep-372-ordered-dictionaries}@anchor{12bf}
@subsection PEP 372: Dicionários ordenados


Regular Python dictionaries iterate over key/value pairs in arbitrary order. Over the years, a number of authors have written alternative implementations that remember the order that the keys were originally inserted. Based on the experiences from those implementations, a new @ref{5db,,collections.OrderedDict} class has been introduced.

The OrderedDict API is substantially the same as regular dictionaries but will iterate over keys and values in a guaranteed order depending on when a key was first inserted. If a new entry overwrites an existing entry, the original insertion position is left unchanged. Deleting an entry and reinserting it will move it to the end.

A biblioteca padrão agora possui suporte para dicionários ordenados em vários módulos. O módulo @ref{22,,configparser} usa-os por padrão. Isso permite que os arquivos de configuração sejam lidos, modificados e depois gravados de volta na ordem original. O método `_asdict()' para @ref{1ca,,collections.namedtuple()} agora retorna um dicionário ordenado com os valores aparecendo na mesma ordem que os índices de tupla subjacentes. O módulo @ref{82,,json} está sendo construído com um `object_pairs_hook' para permitir que OrderedDicts sejam construídos pelo decodificador. Também foi adicionado suporte para ferramentas de terceiros como PyYAML@footnote{https://pyyaml.org/}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - Dicionários ordenados

PEP written by Armin Ronacher and Raymond Hettinger. Implementation written by Raymond Hettinger.
@end table


Uma vez que dicionários ordenados lembram sua ordem de inserção, isso pode ser usada em conjunto com classificação para criar um dicionário classificado:

@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

Os novos dicionários classificados mantem suas ordem de classificação quando entradas são removidas. Mas quando novas chaves são adicionadas, as chaves são adicionados ao fim e a classificação não é mantida.

@node PEP 378 Especificador de formato para separador de milhares,Outras mudanças na linguagem<13>,PEP 372 Dicionários ordenados,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 pep-378-format-specifier-for-thousands-separator}@anchor{12c0}
@subsection PEP 378: Especificador de formato para separador de milhares


The built-in @ref{61f,,format()} function and the @ref{621,,str.format()} method use a mini-language that now includes a simple, non-locale aware way to format a number with a thousands separator. That provides a way to humanize a program’s output, improving its professional appearance and readability:

@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

The supported types are @ref{257,,int}, @ref{2f7,,float}, @ref{2f8,,complex}
and @ref{29d,,decimal.Decimal}.

Discussions are underway about how to specify alternative separators like dots, spaces, apostrophes, or underscores. Locale-aware applications should use the existing `n' format specifier which already has some support for thousands separators.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - Especificador de formato para separador de milhares

PEP escrita por Raymond Hettinger e implementada por Eric Smith e Mark Dickinson.
@end table


@node Outras mudanças na linguagem<13>,New Improved and Deprecated Modules<2>,PEP 378 Especificador de formato para separador de milhares,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 other-language-changes}@anchor{12c1}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
Directories and zip archives containing a @code{__main__.py} file can now be executed directly by passing their name to the interpreter. The directory/zipfile is automatically inserted as the first entry in sys.path. (Suggestion and initial patch by Andy Chu; revised patch by Phillip J. Eby and Nick Coghlan; bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}.)

@item 
The @ref{257,,int()} type gained a @code{bit_length} method that returns the
number of bits necessary to represent its argument in binary:

@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

(Contributed by Fredrik Johansson, Victor Stinner, Raymond Hettinger,
and Mark Dickinson; bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439}.)

@item 
The fields in @ref{61f,,format()} strings can now be automatically
numbered:

@example
>>> 'Sir @{@} of @{@}'.format('Gallahad', 'Camelot')
'Sir Gallahad of Camelot'
@end example

Formerly, the string would have required numbered fields such as:
@code{'Sir @{0@} of @{1@}'}.

(Contributed by 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{12b6,,bytes.maketrans()} and @ref{12b7,,bytearray.maketrans()}.
This change solves the confusion around which types were supported by the
@ref{d3,,string} module. Now, @ref{44c,,str}, @ref{1c2,,bytes}, and
@ref{2ea,,bytearray} each have their own `maketrans' and `translate'
methods with intermediate translation tables of the appropriate type.

(Contributed by Georg Brandl; bpo-5675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5675}.)

@item 
The syntax of the @ref{5d2,,with} statement now allows multiple context
managers in a single statement:

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

(Contributed by Georg Brandl and Mattias Brändström;
appspot issue 53094@footnote{https://codereview.appspot.com/53094}.)

@item 
@code{round(x, n)} now returns an integer if `x' is an integer.
Previously it returned a float:

@example
>>> round(1123, -2)
1100
@end example

(Contributed by 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).

The new algorithm for @code{repr(1.1)} is smarter and returns @code{'1.1'}.
Effectively, it searches all equivalent string representations (ones that
get stored with the same underlying float value) and returns the shortest
representation.

The new algorithm tends to emit cleaner representations when possible, but it does not change the underlying values. So, it is still the case that @code{1.1 + 2.2 != 3.3} even though the representations may suggest otherwise.

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.

(Contributed by Eric Smith and Mark Dickinson; bpo-1580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1580})
@end itemize

@node New Improved and Deprecated Modules<2>,Otimizações<12>,Outras mudanças na linguagem<13>,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 new-improved-and-deprecated-modules}@anchor{12c2}
@subsection New, Improved, and Deprecated Modules



@itemize *

@item 
Added a @ref{10d0,,collections.Counter} class to support convenient
counting of unique items in a sequence or iterable:

@example
>>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
Counter(@{'blue': 3, 'red': 2, 'green': 1@})
@end example

(Contributed by Raymond Hettinger; bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199}.)

@item 
Added a new module, @ref{f9,,tkinter.ttk} for access to the Tk themed widget set.
The basic idea of ttk is to separate, to the extent possible, the code
implementing a widget’s behavior from the code implementing its appearance.

(Contributed by Guilherme Polo; bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983}.)

@item 
The @ref{41a,,gzip.GzipFile} and @ref{86a,,bz2.BZ2File} classes now support
the context management protocol:

@example
>>> # Automatically close file after writing
>>> with gzip.GzipFile(filename, "wb") as f:
...     f.write(b"xxx")
@end example

(Contribuição de Antoine Pitrou.)

@item 
The @ref{36,,decimal} module now supports methods for creating a decimal object from a binary @ref{2f7,,float}. The conversion is exact but can sometimes be surprising:

@example
>>> Decimal.from_float(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
@end example

The long decimal result shows the actual binary fraction being stored for `1.1'. The fraction has many digits because `1.1' cannot be exactly represented in binary.

(Contributed by Raymond Hettinger and Mark Dickinson.)

@item 
The @ref{81,,itertools} module grew two new functions. The @ref{12c3,,itertools.combinations_with_replacement()} function is one of four for generating combinatorics including permutations and Cartesian products. The @ref{12c4,,itertools.compress()} function mimics its namesake from APL. Also, the existing @ref{12c5,,itertools.count()} function now has an optional `step' argument and can accept any type of counting sequence including @ref{1e7,,fractions.Fraction} and @ref{29d,,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

(Contributed by Raymond Hettinger.)

@item 
@ref{1ca,,collections.namedtuple()} now supports a keyword argument `rename' which lets invalid fieldnames be automatically converted to positional names in the form _0, _1, etc. This is useful when the field names are being created by an external source such as a CSV header, SQL field list, or user input:

@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

(Contributed by Raymond Hettinger; bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818}.)

@item 
The @ref{2a3,,re.sub()}, @ref{2a4,,re.subn()} and @ref{2a2,,re.split()} functions now
accept a flags parameter.

(Contributed by Gregory Smith.)

@item 
The @ref{87,,logging} module now implements a simple @ref{12c6,,logging.NullHandler} class for applications that are not using logging but are calling library code that does. Setting-up a null handler will suppress spurious warnings such as “No handlers could be found for logger foo”:

@example
>>> h = logging.NullHandler()
>>> logging.getLogger("foo").addHandler(h)
@end example

(Contributed by Vinay Sajip; bpo-4384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4384}).

@item 
The @ref{be,,runpy} module which supports the @code{-m} command line switch
now supports the execution of packages by looking for and executing
a @code{__main__} submodule when a package name is supplied.

(Contributed by Andi Vajda; bpo-4195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4195}.)

@item 
The @ref{a5,,pdb} module can now access and display source code loaded via
@ref{132,,zipimport} (or any other conformant 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} loader).

(Contributed by Alexander Belopolsky; bpo-4201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4201}.)

@item 
@ref{414,,functools.partial} objects can now be pickled.
@end itemize

@quotation

(Suggested by Antoine Pitrou and Jesse Noller. Implemented by Jack Diederich; bpo-5228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5228}.)
@end quotation


@itemize *

@item 
Add @ref{b5,,pydoc} help topics for symbols so that @code{help('@@')}
works as expected in the interactive environment.

(Contributed by David Laban; bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739}.)

@item 
The @ref{106,,unittest} module now supports skipping individual tests or classes
of tests. And it supports marking a test as an expected failure, a test that
is known to be broken, but shouldn’t be counted as a failure on a
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

Also, tests for exceptions have been builtout to work with context managers
using the @ref{5d2,,with} statement:

@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{12c7,,assertSetEqual()},
@ref{12c8,,assertDictEqual()},
@code{assertDictContainsSubset()},
@ref{12c9,,assertListEqual()},
@ref{12ca,,assertTupleEqual()},
@ref{12cb,,assertSequenceEqual()},
@ref{52f,,assertRaisesRegexp()},
@ref{12cc,,assertIsNone()},
and @ref{12cd,,assertIsNotNone()}.

(Contributed by Benjamin Peterson and Antoine Pitrou.)

@item 
The @ref{7f,,io} module has three new constants for the @ref{12ce,,seek()}
method: @ref{12cf,,SEEK_SET}, @ref{12d0,,SEEK_CUR}, and @ref{12d1,,SEEK_END}.

@item 
The @ref{6a0,,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

(Contributed by 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.

(Contributed by Derek Morr; bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655} and bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664}.)

@item 
The @ref{a6,,pickle} module has been adapted for better interoperability with Python 2.x when used with protocol 2 or lower. The reorganization of the standard library changed the formal reference for many objects. For example, @code{__builtin__.set} in Python 2 is called @code{builtins.set} in Python 3. This change confounded efforts to share data between different versions of Python. But now when protocol 2 or lower is selected, the pickler will automatically use the old Python 2 names for both loading and dumping. This remapping is turned-on by default but can be disabled with the `fix_imports' option:

@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

An unfortunate but unavoidable side-effect of this change is that protocol 2
pickles produced by Python 3.1 won’t be readable with Python 3.0. The latest
pickle protocol, protocol 3, should be used when migrating data between
Python 3.x implementations, as it doesn’t attempt to remain compatible with
Python 2.x.

(Contributed by Alexandre Vassalotti and Antoine Pitrou, bpo-6137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6137}.)

@item 
A new module, @ref{77,,importlib} was added. It provides a complete, portable, pure Python reference implementation of the @ref{5e2,,import} statement and its counterpart, the @ref{8da,,__import__()} function. It represents a substantial step forward in documenting and defining the actions that take place during imports.

(Contributed by Brett Cannon.)
@end itemize

@node Otimizações<12>,IDLE<2>,New Improved and Deprecated Modules<2>,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 optimizations}@anchor{12d2}
@subsection Otimizações


Major performance enhancements have been added:


@itemize *

@item 
The new I/O library (as defined in 
@geindex Propostas de Melhorias do Python; PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/}) was mostly written in
Python and quickly proved to be a problematic bottleneck in Python 3.0.
In Python 3.1, the I/O library has been entirely rewritten in C and is
2 to 20 times faster depending on the task at hand. The pure Python
version is still available for experimentation purposes through
the @code{_pyio} module.

(Contributed by Amaury Forgeot d’Arc and Antoine Pitrou.)

@item 
Added a heuristic so that tuples and dicts containing only untrackable objects
are not tracked by the garbage collector. This can reduce the size of
collections and therefore the garbage collection overhead on long-running
programs, depending on their particular use of datatypes.

(Contributed by Antoine Pitrou, bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}.)

@item 
Enabling a configure option named @code{--with-computed-gotos}
on compilers that support it (notably: gcc, SunPro, icc), the bytecode
evaluation loop is compiled with a new dispatch mechanism which gives
speedups of up to 20%, depending on the system, the compiler, and
the benchmark.

(Contributed by Antoine Pitrou along with a number of other participants,
bpo-4753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4753}).

@item 
The decoding of UTF-8, UTF-16 and LATIN-1 is now two to four times
faster.

(Contributed by Antoine Pitrou and Amaury Forgeot d’Arc, bpo-4868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4868}.)

@item 
The @ref{82,,json} module now has a C extension to substantially improve
its performance.  In addition, the API was modified so that json works
only with @ref{44c,,str}, not with @ref{1c2,,bytes}.  That change makes the
module closely match the JSON specification@footnote{https://json.org/}
which is defined in terms of Unicode.

(Contributed by Bob Ippolito and converted to Py3.1 by Antoine Pitrou
and Benjamin Peterson; bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136}.)

@item 
Unpickling now interns the attribute names of pickled objects. This saves memory and allows pickles to be smaller.

(Contributed by Jake McGuire and Antoine Pitrou; bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084}.)
@end itemize

@node IDLE<2>,Mudanças a construções e API C<6>,Otimizações<12>,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 idle}@anchor{12d3}
@subsection IDLE



@itemize *

@item 
IDLE’s format menu now provides an option to strip trailing whitespace
from a source file.

(Contributed by Roger D. Serwy; bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150}.)
@end itemize

@node Mudanças a construções e API C<6>,Porting to Python 3 1,IDLE<2>,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 build-and-c-api-changes}@anchor{12d4}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
Os inteiros agora são armazenados internamente na base @code{2**15} ou na base @code{2**30}, the base being determined at build time.  Previously, they were sempre armazenado na base @code{2**15}. Usando a base @code{2**30} dá significativa performance de desempenho em máquinas de 64 bits, mas resultados de referência em 32 bits máquinas foram misturadas. Portanto, o padrão é usar a base @code{2**30} em máquinas de 64 bits e base @code{2**15} em máquinas de 32 bits; no Unix, há uma nova opção de configuração @code{--enable-big-digits} que pode ser usada para substituir este padrão.

Além das melhorias de desempenho, essa alteração deve ser invisível para os usuários finais, com uma exceção: para fins de teste e depuração, há um novo structseq @ref{12d5,,sys.int_info} que fornece informações sobre o formato interno, fornecendo o número de bits por dígito e o tamanho em bytes do tipo C usado para armazenar cada dígito:

@example
>>> import sys
>>> sys.int_info
sys.int_info(bits_per_digit=30, sizeof_digit=4)
@end example

(Contributed by Mark Dickinson; bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258}.)

@item 
The @ref{12d6,,PyLong_AsUnsignedLongLong()} function now handles a negative
`pylong' by raising @ref{885,,OverflowError} instead of @ref{2c3,,TypeError}.

(Contributed by Mark Dickinson and Lisandro Dalcrin; bpo-5175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5175}.)

@item 
Deprecated @code{PyNumber_Int()}.  Use @ref{a71,,PyNumber_Long()} instead.

(Contributed by Mark Dickinson; bpo-4910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4910}.)

@item 
Added a new @ref{12d7,,PyOS_string_to_double()} function to replace the
deprecated functions @code{PyOS_ascii_strtod()} and @code{PyOS_ascii_atof()}.

(Contributed by Mark Dickinson; bpo-5914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5914}.)

@item 
Added @ref{12b4,,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.

(Contributed by Larry Hastings; bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630}.)
@end itemize

@node Porting to Python 3 1,,Mudanças a construções e API C<6>,O que há de novo no Python 3 1
@anchor{whatsnew/3 1 porting-to-python-3-1}@anchor{12d8}
@subsection Porting to Python 3.1


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu 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 
The automatic name remapping in the pickle module for protocol 2 or lower can make Python 3.1 pickles unreadable in Python 3.0. One solution is to use protocol 3. Another solution is to set the `fix_imports' option to @code{False}. See the discussion above for more details.
@end itemize

@node O que há de novo no Python 3 0,O que há de novo no Python 2 7,O que há de novo no Python 3 1,O que há de novo no Python
@anchor{whatsnew/3 0 doc}@anchor{12d9}@anchor{whatsnew/3 0 translation-repo}@anchor{12da}@anchor{whatsnew/3 0 what-s-new-in-python-3-0}@anchor{12db}
@section O que há de novo no 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 artigo explica os novos recursos do Python 3.0, em comparação com o 2.6. O Python 3.0, também conhecido como “Python 3000” ou “Py3K”, é o primeiro lançamento do Python `intencionalmente incompatível com versões anteriores'. O Python 3.0 foi lançado em 3 de dezembro de 2008. Há mais mudanças do que em um lançamento típico, e mais que são importantes para todos os usuários do Python. No entanto, depois de digerir as mudanças, você verá que o Python realmente não mudou tanto assim – em geral, estamos principalmente corrigindo aborrecimentos bem conhecidos, e removendo muita sujeira antiga.

Este artigo não tenta fornecer uma especificação completa de todos os novos recursos, mas tenta dar uma visão geral conveniente. Para detalhes completos, você deve consultar a documentação do Python 3.0 e/ou as muitas PEPs referenciadas no texto. Se você quiser entender a implementação completa e a lógica de design para um recurso específico, as PEPs geralmente têm mais detalhes do que a documentação regular; mas observe que as PEPs geralmente não são mantidas atualizadas depois que um recurso foi totalmente implementado.

Devido a restrições de tempo, este documento não está tão completo quanto deveria ser. Como sempre para um novo lançamento, o arquivo @code{Misc/NEWS} na distribuição fonte contém uma riqueza de informações detalhadas sobre cada pequena coisa que foi alterada.

@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
* Obstáculos comuns:: 
* Visão geral das alterações da sintaxe:: 
* Mudanças já presentes no Python 2.6: Mudanças já presentes no Python 2 6. 
* Mudanças na biblioteca:: 
* PEP 3101; Uma nova abordagem para formatação de strings: PEP 3101 Uma nova abordagem para formatação de strings. 
* Mudanças para exceções:: 
* Outras mudanças diversas:: 
* Mudanças a construções e API C: Mudanças a construções e API C<7>. 
* Desempenho:: 
* Portando para o Python 3.0: Portando para o Python 3 0. 

@end menu

@node Obstáculos comuns,Visão geral das alterações da sintaxe,,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 common-stumbling-blocks}@anchor{12dc}
@subsection Obstáculos comuns


Esta seção lista as poucas mudanças que provavelmente irão lhe atrapalhar se você estiver acostumado com o Python 2.5.

@menu
* print é uma função:: 
* Visualizações e iteradores em vez de listas:: 
* Comparações de ordenação:: 
* Inteiros:: 
* Texto vs. Dados em vez de Unicode vs. 8 bits: Texto vs Dados em vez de Unicode vs 8 bits. 

@end menu

@node print é uma função,Visualizações e iteradores em vez de listas,,Obstáculos comuns
@anchor{whatsnew/3 0 print-is-a-function}@anchor{12dd}
@subsubsection print é uma função


A instrução @code{print} foi substituída por uma função @ref{fa9,,print()}, com argumentos nomeados para substituir a maior parte da sintaxe especial da antiga instrução @code{print} (
@geindex Propostas de Melhorias do Python; PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}). Exemplos:

@example
Antigo: print "The answer is", 2*2
Novo: print("The answer is", 2*2)

Antigo: print x,           # Vírgula no final suprime nova linha
Novo: print(x, end=" ")  # Anexa um espaço em vez de uma nova linha

Antigo: print              # Exibe uma nova linha
Novo: print()            # Você precisa chamar a função!

Antigo: print >>sys.stderr, "fatal error"
Novo: print("fatal error", file=sys.stderr)

Antigo: print (x, y)       # Exibe repr((x, y))
Novo: print((x, y))      # Não é o mesmo que print(x, y)!
@end example

Você também pode personalizar o separador entre itens, por exemplo:

@example
print("Há <", 2**32, "> possibilidades!", sep="")
@end example

que produz:

@example
Há <4294967296> possibilidades!
@end example

Nota:


@itemize *

@item 
A função @ref{fa9,,print()} não tem suporte ao recurso “softspace” da antiga instrução @code{print}. Por exemplo, no Python 2.x, @code{print "A\n", "B"} escreveria @code{"A\nB\n"}; mas no Python 3.0, @code{print("A\n", "B")} escreve @code{"A\n B\n"}.

@item 
Inicialmente, você vai se pegar digitando o antigo @code{print x} bastante no modo interativo. É hora de treinar seus dedos para digitar @code{print(x)} em vez disso!

@item 
Ao usar a ferramenta de conversão de fonte para fonte @code{2to3}, todas as instruções @code{print} são automaticamente convertidas em chamadas de função @ref{fa9,,print()}, então isso geralmente não é um problema para projetos maiores.
@end itemize

@node Visualizações e iteradores em vez de listas,Comparações de ordenação,print é uma função,Obstáculos comuns
@anchor{whatsnew/3 0 views-and-iterators-instead-of-lists}@anchor{12de}
@subsubsection Visualizações e iteradores em vez de listas


Algumas APIs conhecidas não retornam mais listas:


@itemize *

@item 
Os métodos @ref{7ce,,dict.keys()}, @ref{7d0,,dict.items()} e @ref{7cf,,dict.values()} de @ref{256,,dict} retornam visualizações, ou “views”, em vez de listas. Por exemplo, isso não funciona mais: @code{k = d.keys(); k.sort()}. Use @code{k = sorted(d)} em vez disso (isso funciona no Python 2.5 também e é igualmente eficiente).

@item 
Além disso, os métodos @code{dict.iterkeys()}, @code{dict.iteritems()} e @code{dict.itervalues()} não são mais suportados.

@item 
@ref{867,,map()} e @ref{868,,filter()} retornam iteradores. Se você realmente precisa de uma lista e as sequências de entrada são todas de comprimento igual, uma solução rápida é envolver @ref{867,,map()} em @ref{611,,list()}, por exemplo, @code{list(map(...))}, mas uma solução melhor é frequentemente usar uma compreensão de lista (especialmente quando o código original usa @ref{12df,,lambda}), ou reescrever o código para que ele não precise de uma lista. Particularmente complicado é @ref{867,,map()} invocado para os efeitos colaterais da função; a transformação correta é usar um laço @ref{2f2,,for} regular (já que criar uma lista seria apenas desperdício).

Se as sequências de entrada não tiverem o mesmo comprimento, @ref{867,,map()} irá parar no término da mais curta das sequências. Para compatibilidade total com @ref{867,,map()} do Python 2.x, também envolva as sequências em @ref{12e0,,itertools.zip_longest()}, por exemplo, @code{map(func, *sequences)} se torna @code{list(map(func, itertools.zip_longest(*sequences)))}.

@item 
@ref{94a,,range()} agora se comporta como @code{xrange()} costumava se comportar, exceto que funciona com valores de tamanho arbitrário. Este último não existe mais.

@item 
@ref{7d1,,zip()} agora retorna um iterador.
@end itemize

@node Comparações de ordenação,Inteiros,Visualizações e iteradores em vez de listas,Obstáculos comuns
@anchor{whatsnew/3 0 ordering-comparisons}@anchor{12e1}
@subsubsection Comparações de ordenação


O Python 3.0 simplificou as regras para ordenar comparações:


@itemize *

@item 
Os operadores de comparação de ordenação (@code{<}, @code{<=}, @code{>=}, @code{>}) levantam uma exceção TypeError quando os operandos não têm uma ordenação natural significativa. Assim, expressões como @code{1 < '@w{'}}, @code{0 > None} ou @code{len <= len} não são mais válidas e, por exemplo, @code{None < None} levanta @ref{2c3,,TypeError} em vez de retornar @code{False}. Um corolário é que classificar uma lista heterogênea não faz mais sentido – todos os elementos devem ser comparáveis entre si. Observe que isso não se aplica aos operadores @code{==} e @code{!=}: objetos de diferentes tipos incomparáveis sempre são comparados de forma diferente entre si.

@item 
@ref{be7,,sorted()} e @ref{be8,,list.sort()} não aceitam mais o argumento `cmp' fornecendo uma função de comparação. Use o argumento `key' em vez disso. N.B. os argumentos `key' e `reverse' agora são “somente-nomeados”.

@item 
A função @code{cmp()} deve ser tratada como extinta, e o método especial @code{__cmp__()} não é mais suportado. Use @ref{12e2,,__lt__()} para classificação, @ref{b0d,,__eq__()} com @ref{b0e,,__hash__()} e outras comparações avançadas conforme necessário. (Se você realmente precisa da funcionalidade @code{cmp()}, pode usar a expressão @code{(a > b) - (a < b)} como o equivalente para @code{cmp(a, b)}.)
@end itemize

@node Inteiros,Texto vs Dados em vez de Unicode vs 8 bits,Comparações de ordenação,Obstáculos comuns
@anchor{whatsnew/3 0 integers}@anchor{12e3}
@subsubsection Inteiros



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}: Essencialmente, @code{long} foi renomeado para @ref{257,,int}. Ou seja, há apenas um tipo integral embutido, chamado @ref{257,,int}; mas ele se comporta principalmente como o antigo tipo @code{long}.

@item 
@geindex Propostas de Melhorias do Python; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: Uma expressão como @code{1/2} retorna um float. Use @code{1//2} para obter o comportamento de truncamento. (A última sintaxe existe há anos, pelo menos desde o Python 2.2.)

@item 
A constante @code{sys.maxint} foi removida, pois não há mais um limite para o valor de inteiros. No entanto, @ref{1205,,sys.maxsize} pode ser usado como um inteiro maior do que qualquer lista prática ou índice de string. Ele está em conformidade com o tamanho inteiro “natural” da implementação e é tipicamente o mesmo que @code{sys.maxint} em versões anteriores na mesma plataforma (assumindo as mesmas opções de construção).

@item 
O @ref{800,,repr()} de um inteiro longo não inclui mais o @code{L} final, então o código que remove esse caractere incondicionalmente cortará o último dígito. (Use @ref{44c,,str()} em vez disso.)

@item 
Literais octais não estão mais no formato @code{0720}; em vez disso, use @code{0o720}.
@end itemize

@node Texto vs Dados em vez de Unicode vs 8 bits,,Inteiros,Obstáculos comuns
@anchor{whatsnew/3 0 text-vs-data-instead-of-unicode-vs-8-bit}@anchor{12e4}
@subsubsection Texto vs. Dados em vez de Unicode vs. 8 bits


Tudo o que você achava que sabia sobre dados binários e Unicode mudou.


@itemize *

@item 
O Python 3.0 usa os conceitos de `texto' e `dados' (binários) em vez de strings Unicode e strings de 8 bits. Todo texto é Unicode; no entanto, o Unicode `codificado' é representado como dados binários. O tipo usado para armazenar texto é @ref{44c,,str}, o tipo usado para armazenar dados é @ref{1c2,,bytes}. A maior diferença com a situação 2.x é que qualquer tentativa de misturar texto e dados no Python 3.0 levanta @ref{2c3,,TypeError}, enquanto que se você misturasse strings Unicode e de 8 bits no Python 2.x, funcionaria se a string de 8 bits contivesse apenas bytes de 7 bits (ASCII), mas você obteria @ref{a1d,,UnicodeDecodeError} se contivesse valores não ASCII. Esse comportamento específico de valor causou inúmeras caras tristes ao longo dos anos.

@item 
Como consequência dessa mudança na filosofia, praticamente todo código que usa Unicode, codificações ou dados binários provavelmente terá que mudar. A mudança é para melhor, pois no mundo 2.x havia vários bugs relacionados à mistura de texto codificado e não codificado. Para estar preparado no Python 2.x, comece a usar @code{unicode} para todo texto não codificado e @ref{44c,,str} apenas para dados binários ou codificados. Então a ferramenta @code{2to3} fará a maior parte do trabalho para você.

@item 
Você não pode mais usar literais @code{u"..."} para texto Unicode. No entanto, você deve usar literais @code{b"..."} para dados binários.

@item 
Como os tipos @ref{44c,,str} e @ref{1c2,,bytes} não podem ser misturados, você deve sempre converter explicitamente entre eles. Use @ref{8db,,str.encode()} para ir de @ref{44c,,str} para @ref{1c2,,bytes}, e @ref{8dc,,bytes.decode()} para ir de @ref{1c2,,bytes} para @ref{44c,,str}. Você também pode usar @code{bytes(s, encoding=...)} e @code{str(b, encoding=...)}, respectivamente.

@item 
Assim como @ref{44c,,str}, o tipo @ref{1c2,,bytes} é imutável. Há um tipo `mutável' separado para armazenar dados binários em buffer, @ref{2ea,,bytearray}. Quase todas as APIs que aceitam @ref{1c2,,bytes} também aceitam @ref{2ea,,bytearray}. A API mutável é baseada em @ref{1a1,,collections.MutableSequence}.

@item 
Todas as contrabarras em literais de strings brutas são interpretadas literalmente. Isso significa que os escapes @code{'\U'} e @code{'\u'} em strings brutas não são tratados de forma especial. Por exemplo, @code{r'\u20ac'} é uma string de 6 caracteres no Python 3.0, enquanto no 2.6, @code{ur'\u20ac'} era o único caractere “euro”. (É claro que essa mudança afeta apenas literais de strings brutas; o caractere euro é @code{'\u20ac'} no Python 3.0.)

@item 
O tipo abstrato embutido @code{basestring} foi removido. Use @ref{44c,,str} em vez disso. Os tipos @ref{44c,,str} e @ref{1c2,,bytes} não têm funcionalidade suficiente em comum para garantir uma classe base compartilhada. A ferramenta @code{2to3} (veja abaixo) substitui cada ocorrência de @code{basestring} por @ref{44c,,str}.

@item 
Arquivos abertos como arquivos texto (ainda o modo padrão para @ref{51c,,open()}) sempre usam uma codificação para mapear entre strings (na memória) e bytes (no disco). Arquivos binários (abertos com um @code{b} no argumento mode) sempre usam bytes na memória. Isso significa que se um arquivo for aberto usando um modo ou codificação incorretos, a E/S provavelmente falhará ruidosamente, em vez de produzir dados incorretos silenciosamente. Isso também significa que até mesmo usuários Unix terão que especificar o modo correto (texto ou binário) ao abrir um arquivo. Há uma codificação padrão dependente da plataforma, que em plataformas Unixy pode ser definida com a variável de ambiente @code{LANG} (e às vezes também com algumas outras variáveis de ambiente relacionadas à localidade específicas da plataforma). Em muitos casos, mas não em todos, o padrão do sistema é UTF-8; você nunca deve contar com esse padrão. Qualquer aplicação que leia ou escreva mais do que texto ASCII puro provavelmente deve ter uma maneira de substituir a codificação. Não há mais necessidade de usar os fluxos com reconhecimento de codificação no módulo @ref{1b,,codecs}.

@item 
Os valores iniciais de @ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout} e @ref{940,,sys.stderr} agora são arquivos texto somente unicode (ou seja, são instâncias de @ref{695,,io.TextIOBase}). Para ler e gravar dados de bytes com esses fluxos, você precisa usar o atributo @ref{12e5,,io.TextIOBase.buffer} deles.

@item 
Nomes de arquivo são passados e retornados de APIs como strings (Unicode). Isso pode apresentar problemas específicos de plataforma porque em algumas plataformas nomes de arquivo são strings de bytes arbitrárias. (Por outro lado, no Windows nomes de arquivo são armazenados nativamente como Unicode.) Como solução alternativa, a maioria das APIs (por exemplo, @ref{51c,,open()} e muitas funções no módulo @ref{a1,,os}) que aceitam nomes de arquivo aceitam objetos @ref{1c2,,bytes} assim como strings, e algumas APIs têm uma maneira de pedir um valor de retorno @ref{1c2,,bytes}. Assim, @ref{1139,,os.listdir()} retorna uma lista de instâncias @ref{1c2,,bytes} se o argumento for uma instância @ref{1c2,,bytes}, e @ref{a9b,,os.getcwdb()} retorna o diretório de trabalho atual como uma instância @ref{1c2,,bytes}. Observe que quando @ref{1139,,os.listdir()} retorna uma lista de strings, os nomes de arquivos que não podem ser decodificados corretamente são omitidos em vez de levantar @ref{12e6,,UnicodeError}.

@item 
Algumas APIs de sistema como @ref{11f9,,os.environ} e @ref{12a6,,sys.argv} também podem apresentar problemas quando os bytes disponibilizados pelo sistema não são interpretáveis usando a codificação padrão. Definir a variável @code{LANG} e executar o programa novamente é provavelmente a melhor abordagem.

@item 
@geindex Propostas de Melhorias do Python; PEP 3138
PEP 3138@footnote{https://peps.python.org/pep-3138/}: A @ref{800,,repr()} de uma string não escapa mais caracteres não-ASCII. No entanto, ele ainda escapa caracteres de controle e pontos de código com status não imprimível no padrão Unicode.

@item 
@geindex Propostas de Melhorias do Python; PEP 3120
PEP 3120@footnote{https://peps.python.org/pep-3120/}: A codificação de fontes padrão agora é UTF-8.

@item 
@geindex Propostas de Melhorias do Python; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}: Letras não ASCII agora são permitidas em identificadores. (No entanto, a biblioteca padrão permanece somente ASCII, com exceção dos nomes dos colaboradores nos comentários.)

@item 
Os módulos @code{StringIO} e @code{cStringIO} se foram. Em vez disso, importe o módulo @ref{7f,,io} e use @ref{f59,,io.StringIO} ou @ref{ed3,,io.BytesIO} para texto e dados, respectivamente.

@item 
Veja também o guia @ref{12e7,,Unicode}, que foi atualizado para o Python 3.0.
@end itemize

@node Visão geral das alterações da sintaxe,Mudanças já presentes no Python 2 6,Obstáculos comuns,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 overview-of-syntax-changes}@anchor{12e8}
@subsection Visão geral das alterações da sintaxe


Esta seção fornece uma breve visão geral de cada mudança `sintática' no Python 3.0.

@menu
* Nova sintaxe:: 
* Sintaxe alterada:: 
* Sintaxe removida:: 

@end menu

@node Nova sintaxe,Sintaxe alterada,,Visão geral das alterações da sintaxe
@anchor{whatsnew/3 0 new-syntax}@anchor{12e9}
@subsubsection Nova sintaxe



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}: Anotações de argumento de função e valor de retorno. Isso fornece uma maneira padronizada de anotar os parâmetros e o valor de retorno de uma função. Não há semântica anexada a essas anotações, exceto que elas podem ser introspectadas em tempo de execução usando o atributo @code{__annotations__}. A intenção é encorajar a experimentação por meio de metaclasses, decoradores ou frameworks.

@item 
@geindex Propostas de Melhorias do Python; PEP 3102
PEP 3102@footnote{https://peps.python.org/pep-3102/}: Argumentos somente-nomeados. Parâmetros nomeados que ocorrem após @code{*args} na lista de parâmetros `devem' ser especificados usando a sintaxe dos nomes na chamada. Você também pode usar um @code{*} simples na lista de parâmetros para indicar que não aceita uma lista de argumentos de comprimento variável, mas tem argumentos somente-nomeados.

@item 
Argumentos nomeados são permitidos após a lista de classes base em uma definição de classe. Isso é usado pela nova convenção para especificar uma metaclasse (veja a próxima seção), mas pode ser usado para outros propósitos também, desde que a metaclasse dê suporte.

@item 
@geindex Propostas de Melhorias do Python; PEP 3104
PEP 3104@footnote{https://peps.python.org/pep-3104/}: instrução @ref{12ea,,nonlocal}. Usando @code{nonlocal x}, agora você pode atribuir diretamente a uma variável em um escopo externo (mas não global). @code{nonlocal} é uma nova palavra reservada.

@item 
@geindex Propostas de Melhorias do Python; PEP 3132
PEP 3132@footnote{https://peps.python.org/pep-3132/}: Desempacotamento iterável estendido. Agora você pode escrever coisas como @code{a, b, *rest = some_sequence}. E até mesmo @code{*rest, a = stuff}. O objeto @code{rest} é sempre uma lista (possivelmente vazia); o lado direito pode ser qualquer iterável. Exemplo:

@example
(a, *rest, b) = range(5)
@end example

Isso define `a' como @code{0}, `b' como @code{4} e `rest' como @code{[1, 2, 3]}.

@item 
Compreensões de dicionário: @code{@{k: v for k, v in stuff@}} significa a mesma coisa que @code{dict(stuff)}, mas é mais flexível. (Isto é 
@geindex Propostas de Melhorias do Python; PEP 274
PEP 274@footnote{https://peps.python.org/pep-0274/} justificada. :-)

@item 
Definir literais, por exemplo, @code{@{1, 2@}}. Note que @code{@{@}} é um dicionário vazio; use @code{set()} para um conjunto vazio. Compreensões de conjuntos também são suportadas; por exemplo, @code{@{x for x in stuff@}} significa a mesma coisa que @code{set(stuff)}, mas é mais flexível.

@item 
Novos literais octais, por exemplo, @code{0o720} (já em 2.6). Os antigos literais octais (@code{0720}) se foram.

@item 
Novos literais binários, por exemplo, @code{0b1010} (já em 2.6), e há uma nova função embutida correspondente, @ref{12eb,,bin()}.

@item 
Literais de bytes são introduzidos com um @code{b} ou @code{B} no início, e há uma nova função embutida correspondente, @ref{1c2,,bytes()}.
@end itemize

@node Sintaxe alterada,Sintaxe removida,Nova sintaxe,Visão geral das alterações da sintaxe
@anchor{whatsnew/3 0 changed-syntax}@anchor{12ec}
@subsubsection Sintaxe alterada



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/} e 
@geindex Propostas de Melhorias do Python; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: nova sintaxe da instrução @ref{5ed,,raise}: @code{raise [@var{expr} [from @var{expr}]]}. Veja abaixo.

@item 
@code{as} e @ref{5d2,,with} agora são palavras reservadas. (Desde a versão 2.6, na verdade.)

@item 
@code{True}, @code{False} e @code{None} são palavras reservadas. (A versão 2.6 já aplicava parcialmente as restrições em @code{None}.)

@item 
Alteração de @ref{18b,,except} `exc', `var' para @code{except} `exc' @code{as} `var'. Veja a 
@geindex Propostas de Melhorias do Python; PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}.

@item 
@geindex Propostas de Melhorias do Python; PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}: Nova sintaxe de metaclasse. Em vez de:

@example
class C:
    __metaclass__ = M
    ...
@end example

agora você deve usar:

@example
class C(metaclass=M):
    ...
@end example

A variável global do módulo @code{__metaclass__} não é mais suportada. (Era uma ajuda para facilitar a mudança do padrão para classes de novo estilo sem derivar cada classe de @ref{a96,,object}.)

@item 
As compreensões de lista não têm mais suporte a mais a forma sintática @code{[... for @var{var} in @var{item1}, @var{item2}, ...]}. Use @code{[... for @var{var} in (@var{item1}, @var{item2}, ...)]} em vez disso. Observe também que as compreensões de lista têm semântica diferente: elas estão mais próximas do açúcar sintático para uma expressão geradora dentro de um construtor @ref{611,,list()} e, em particular, as variáveis de controle de laço não são mais vazadas para o escopo circundante.

@item 
As `reticências' (@code{...}) podem ser usadas como uma expressão atômica em qualquer lugar. (Anteriormente, eram permitidas apenas em fatias.) Além disso, agora `devem' ser escritas como @code{...}. (Anteriormente, também poderiam ser escritas como @code{. . .}, por um mero acidente da gramática.)
@end itemize

@node Sintaxe removida,,Sintaxe alterada,Visão geral das alterações da sintaxe
@anchor{whatsnew/3 0 removed-syntax}@anchor{12ed}
@subsubsection Sintaxe removida



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 3113
PEP 3113@footnote{https://peps.python.org/pep-3113/}: Desempacotamento de parâmetro de tupla removido. Você não pode mais escrever @code{def foo(a, (b, c)): ...}. Em vez disso, use @code{def foo(a, b_c): b, c = b_c}.

@item 
Removidos backticks (use @ref{800,,repr()}).

@item 
Removido @code{<>} (use @code{!=}).

@item 
Removida palavra reservada: @ref{17f,,exec()} não é mais uma palavra reservada; ela permanece como uma função. (Felizmente a sintaxe da função também era aceita nas versões 2.x.) Observe também que @ref{17f,,exec()} não aceita mais um argumento de fluxo; em vez de @code{exec(f)} você pode usar @code{exec(f.read())}.

@item 
Literais de inteiro não mais têm suporte a um @code{l} ou @code{L} final.

@item 
Literais de string não mais têm suporte a um @code{u} ou @code{U} no início.

@item 
A sintaxe @ref{12ee,,from} `módulo' @ref{5e2,,import} @code{*} é permitida somente no nível do módulo, não mais dentro de funções.

@item 
A única sintaxe aceitável para importações relativas é @code{from .[@var{module}] import @var{name}}. Todos as formas de @ref{5e2,,import} que não começam com @code{.} são interpretadas como importações absolutas. (
@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/})

@item 
As classes clássicas se foram.
@end itemize

@node Mudanças já presentes no Python 2 6,Mudanças na biblioteca,Visão geral das alterações da sintaxe,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 changes-already-present-in-python-2-6}@anchor{12ef}
@subsection Mudanças já presentes no Python 2.6


Como muitos usuários provavelmente fazem o salto direto do Python 2.5 para o Python 3.0, esta seção lembra o leitor dos novos recursos que foram originalmente projetados para o Python 3.0, mas que foram portados de volta para o Python 2.6. As seções correspondentes em @ref{12f0,,O que há de novo no Python 2.6} devem ser consultadas para descrições mais longas.


@itemize *

@item 
@ref{12f1,,PEP 343; The ‘with’ statement}. A instrução @ref{5d2,,with} agora é um recurso padrão e não precisa mais ser importada de @ref{0,,__future__}. Confira também @ref{12f2,,Writing Context Managers} e @ref{12f3,,The contextlib module}.

@item 
@ref{12f4,,PEP 366; Explicit Relative Imports From a Main Module}. Isso aumenta a utilidade da opção @ref{5e1,,-m} quando o módulo referenciado reside em um pacote.

@item 
@ref{12f5,,PEP 370; Per-user site-packages Directory}.

@item 
@ref{12f6,,PEP 371; The multiprocessing Package}.

@item 
@ref{12f7,,PEP 3101; Advanced String Formatting}. Nota: a descrição da versão 2.6 menciona o método @ref{61f,,format()} para strings de 8 bits e Unicode. No 3.0, apenas o tipo @ref{44c,,str} (strings de texto com suporte a Unicode) tem suporte a esse método; o tipo @ref{1c2,,bytes} não. O plano é eventualmente tornar esta a única API para formatação de strings e começar a descontinuar o operador @code{%} no Python 3.1.

@item 
@ref{12f8,,PEP 3105; print As a Function}. Este é agora um recurso padrão e não precisa mais ser importado de @ref{0,,__future__}. Mais detalhes foram fornecidos acima.

@item 
@ref{12f9,,PEP 3110; Exception-Handling Changes}. A sintaxe @ref{18b,,except} `exc' @code{as} `var' agora é padrão e @code{except} `exc', `var' não é mais suportado. (Claro, a parte @code{as} `var' ainda é opcional.)

@item 
@ref{12fa,,PEP 3112; Byte Literals}. A notação de literal de string @code{b"..."} (e suas variantes como @code{b'...'}, @code{b"""..."""} e @code{br"..."}) agora produz um literal do tipo @ref{1c2,,bytes}.

@item 
@ref{12fb,,PEP 3116; New I/O Library}. O módulo @ref{7f,,io} agora é a maneira padrão de fazer E/S de arquivo. A função embutida @ref{51c,,open()} agora é um apelido para @ref{51d,,io.open()} e tem argumentos nomeados adicionais `encoding', `errors', `newline' e `closefd'. Observe também que um argumento `mode' inválido agora levanta @ref{202,,ValueError}, não @ref{108b,,IOError}. O objeto arquivo binário subjacente a um objeto arquivo texto pode ser acessado como @code{f.buffer} (mas tome cuidado, pois o objeto texto mantém um buffer de si mesmo para acelerar as operações de codificação e decodificação).

@item 
@ref{12fc,,PEP 3118; Revised Buffer Protocol}. A antiga função embutida @code{buffer()} agora realmente se foi; a nova função embutida @ref{2eb,,memoryview()} fornece funcionalidade (principalmente) semelhante.

@item 
@ref{12fd,,PEP 3119; Abstract Base Classes}. O módulo @ref{4,,abc} e as ABCs definidas no módulo @ref{1d,,collections} desempenham um papel um pouco mais proeminente na linguagem agora, e tipos embutidos de coleção como @ref{256,,dict} e @ref{611,,list} estão em conformidade com as ABCs @ref{10eb,,collections.MutableMapping} e @ref{1a1,,collections.MutableSequence}, respectivamente.

@item 
@ref{12fe,,PEP 3127; Integer Literal Support and Syntax}. Conforme mencionado acima, a nova notação de literal octal é a única suportada, e literais binários foram adicionados.

@item 
@ref{12ff,,PEP 3129; Class Decorators}.

@item 
@ref{1300,,PEP 3141; A Type Hierarchy for Numbers}. O módulo @ref{9e,,numbers} é outro novo uso de ABCs, definindo a “torre numérica” do Python. Observe também o novo módulo @ref{5d,,fractions} que implementa @ref{1301,,numbers.Rational}.
@end itemize

@node Mudanças na biblioteca,PEP 3101 Uma nova abordagem para formatação de strings,Mudanças já presentes no Python 2 6,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 library-changes}@anchor{1302}
@subsection Mudanças na biblioteca


Devido a restrições de tempo, este documento não cobre exaustivamente as mudanças muito extensas na biblioteca padrão. 
@geindex Propostas de Melhorias do Python; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} é a referência para as principais mudanças na biblioteca. Aqui está uma revisão resumida:


@itemize *

@item 
Muitos módulos antigos foram removidos. Alguns, como @code{gopherlib} (não mais usado) e @code{md5} (substituído por @ref{68,,hashlib}), já tinham sido descontinuados pela 
@geindex Propostas de Melhorias do Python; PEP 4
PEP 4@footnote{https://peps.python.org/pep-0004/}. Outros foram removidos como resultado da remoção do suporte para várias plataformas, como Irix, BeOS e Mac OS 9 (veja 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}). Alguns módulos também foram selecionados para remoção no Python 3.0 devido à falta de uso ou porque existe uma substituição melhor. Veja 
@geindex Propostas de Melhorias do Python; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} para uma lista exaustiva.

@item 
O pacote @code{bsddb3} foi removido porque sua presença na biblioteca padrão principal provou ao longo do tempo ser um fardo particular para os desenvolvedores principais devido à instabilidade dos testes e ao cronograma de lançamento do Berkeley DB. No entanto, o pacote está vivo e bem, mantido externamente em @indicateurl{https://www.jcea.es/programacion/pybsddb.htm}.

@item 
Alguns módulos foram renomeados porque seu nome antigo desobedecia a 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, ou por vários outros motivos. Aqui está a lista:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Old Name

@tab

Novo nome

@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 
Um padrão comum no Python 2.x é ter uma versão de um módulo implementada em Python puro, com uma versão acelerada opcional implementada como uma extensão C; por exemplo, @ref{a6,,pickle} e @code{cPickle}. Isso coloca o fardo de importar a versão acelerada e recorrer à versão Python pura em cada usuário desses módulos. No Python 3.0, as versões aceleradas são consideradas detalhes de implementação das versões Python puras. Os usuários devem sempre importar a versão padrão, que tenta importar a versão acelerada e recorrer à versão Python pura. O par @ref{a6,,pickle} / @code{cPickle} recebeu esse tratamento. O módulo @ref{af,,profile} está na lista para 3.1. O módulo @code{StringIO} foi transformado em uma classe no módulo @ref{7f,,io}.

@item 
Alguns módulos relacionados foram agrupados em pacotes e, geralmente, os nomes dos submódulos foram simplificados. Os novos pacotes resultantes são:


@itemize *

@item 
@ref{31,,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 os módulos relacionados a @code{Tkinter}, exceto @ref{101,,turtle}). O público-alvo de @ref{101,,turtle} não se importa muito com @ref{f0,,tkinter}. Observe também que, a partir do Python 2.6, a funcionalidade de @ref{101,,turtle} foi bastante aprimorada.

@item 
@ref{108,,urllib} (@code{urllib}, @code{urllib2}, @code{urlparse},
@code{robotparse}).

@item 
@ref{12d,,xmlrpc} (@code{xmlrpclib}, @code{DocXMLRPCServer},
@code{SimpleXMLRPCServer}).
@end itemize
@end itemize

Algumas outras mudanças nos módulos da biblioteca padrão, não cobertas pela 
@geindex Propostas de Melhorias do Python; PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/}:


@itemize *

@item 
@code{sets} eliminado. Use a classe embutida @ref{5d9,,set()}.

@item 
Limpeza do módulo @ref{d9,,sys}: removidos @code{sys.exitfunc()}, @code{sys.exc_clear()}, @code{sys.exc_type}, @code{sys.exc_value}, @code{sys.exc_traceback}. (Observe que @ref{4bf,,sys.last_type} etc. permanecem.)

@item 
Limpeza do tipo @ref{1a0,,array.array}: os métodos @code{read()} e @code{write()} foram removidos; use @ref{1303,,fromfile()} e @ref{1304,,tofile()} em vez disso. Além disso, o typecode @code{'c'} para vetor foi removido – use @code{'b'} para bytes ou @code{'u'} para caracteres Unicode.

@item 
Cleanup of the @ref{9f,,operator} module: removed
@code{sequenceIncludes()} and @code{isCallable()}.

@item 
Limpeza do módulo @code{thread}: @code{acquire_lock()} e @code{release_lock()} foram removidos; use @ref{698,,acquire()} e @ref{1305,,release()} em vez disso.

@item 
Cleanup of the @ref{b8,,random} module: removed the @code{jumpahead()} API.

@item 
O módulo @code{new} foi removido.

@item 
The functions @code{os.tmpnam()}, @code{os.tempnam()} and
@code{os.tmpfile()} have been removed in favor of the @ref{e0,,tempfile}
module.

@item 
O módulo @ref{fb,,tokenize} foi alterado para funcionar com bytes. O ponto de entrada principal agora é @ref{4d9,,tokenize.tokenize()}, em vez de generate_tokens.

@item 
@code{string.letters} and its friends (@code{string.lowercase} and
@code{string.uppercase}) are gone.  Use
@ref{1306,,string.ascii_letters} etc. instead.  (The reason for the
removal is that @code{string.letters} and friends had
locale-specific behavior, which is a bad idea for such
attractively named global “constants”.)

@item 
Renamed module @code{__builtin__} to @ref{12,,builtins} (removing the
underscores, adding an ‘s’).  The @code{__builtins__} variable
found in most global namespaces is unchanged.  To modify a builtin,
you should use @ref{12,,builtins}, not @code{__builtins__}!
@end itemize

@node PEP 3101 Uma nova abordagem para formatação de strings,Mudanças para exceções,Mudanças na biblioteca,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 pep-3101-a-new-approach-to-string-formatting}@anchor{1307}
@subsection 
@geindex Propostas de Melhorias do Python; PEP 3101
`PEP 3101': Uma nova abordagem para formatação de strings



@itemize *

@item 
Um novo sistema para operações de formatação de strings embutidas substitui o operador de formatação de strings @code{%}. (No entanto, o operador @code{%} ainda é suportado; ele será descontinuado no Python 3.1 e removido da linguagem em algum momento posterior.) Leia a 
@geindex Propostas de Melhorias do Python; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/} para obter informações completas.
@end itemize

@node Mudanças para exceções,Outras mudanças diversas,PEP 3101 Uma nova abordagem para formatação de strings,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 changes-to-exceptions}@anchor{1308}
@subsection Mudanças para exceções


As APIs para levantar e capturar exceções foram limpas e novos recursos poderosos foram adicionados:


@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 352
PEP 352@footnote{https://peps.python.org/pep-0352/}: Todas as exceções devem ser derivadas (direta ou indiretamente) de @ref{5bb,,BaseException}. Esta é a raiz da hierarquia de exceções. Isso não é novo como recomendação, mas o `requisito' para herdar de @ref{5bb,,BaseException} é novo. (O Python 2.6 ainda permitia que classes clássicas fossem levantadas e não colocava nenhuma restrição sobre o que você pode capturar.) Como consequência, exceções de string estão finalmente verdadeira e completamente mortas.

@item 
Quase todas as exceções devem derivar de @ref{9e2,,Exception}; @ref{5bb,,BaseException} deve ser usado apenas como uma classe base para exceções que devem ser manipuladas apenas no nível superior, como @ref{d63,,SystemExit} ou @ref{9d9,,KeyboardInterrupt}. O idioma recomendado para manipular todas as exceções, exceto para esta última categoria, é usar @ref{18b,,except} @ref{9e2,,Exception}.

@item 
@code{StandardError} was removed.

@item 
Exceptions no longer behave as sequences.  Use the @ref{56c,,args}
attribute instead.

@item 
@geindex Propostas de Melhorias do Python; PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/}: levantando exceções. Agora você deve usar @code{raise @var{Exception}(@var{args})} em vez de @code{raise @var{Exception}, @var{args}}. Além disso, você não pode mais especificar explicitamente um traceback (situação da pilha de execução); em vez disso, se você `precisar' fazer isso, você pode atribuir diretamente ao atributo @ref{1309,,__traceback__} (veja abaixo).

@item 
@geindex Propostas de Melhorias do Python; PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}: Capturando exceções. Agora você deve usar @code{except @var{SomeException} as @var{variable}} em vez de @code{except @var{SomeException}, @var{variable}}. Além disso, a variável `variable' é explicitamente excluída quando o bloco @ref{18b,,except} é deixado.

@item 
@geindex Propostas de Melhorias do Python; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: Encadeamento de exceções. Existem dois casos: encadeamento implícito e encadeamento explícito. O encadeamento implícito acontece quando uma exceção é levantada em um bloco manipulador @ref{18b,,except} ou @ref{9d2,,finally}. Isso geralmente acontece devido a um bug no bloco do manipulador; chamamos isso de exceção `secundária'. Nesse caso, a exceção original (que estava sendo manipulada) é salva como o atributo @ref{130a,,__context__} da exceção secundária. O encadeamento explícito é invocado com esta sintaxe:

@example
raise SecondaryException() from primary_exception
@end example

(onde `primary_exception' é qualquer expressão que produz um objeto de exceção, provavelmente uma exceção que foi capturada anteriormente). Neste caso, a exceção primária é armazenada no atributo @ref{130b,,__cause__} da exceção secundária. O traceback impresso quando uma exceção não tratada ocorre percorre a cadeia de atributos @code{__cause__} e @ref{130a,,__context__} e imprime um traceback separado para cada componente da cadeia, com a exceção primária no topo. (Usuários Java podem reconhecer este comportamento.)

@item 
@geindex Propostas de Melhorias do Python; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: Objetos exceção agora armazenam seu traceback como o atributo @ref{1309,,__traceback__}. Isso significa que um objeto de exceção agora contém todas as informações pertencentes a uma exceção, e há menos motivos para usar @ref{68a,,sys.exc_info()} (embora o último não seja removido).

@item 
Algumas mensagens de exceção estão melhores quando o Windows falha ao carregar um módulo de extensão. Por exemplo, @code{error code 193} agora é @code{%1 is not a valid Win32 application}. As strings agora lidam com localidades que não sejam em inglês.
@end itemize

@node Outras mudanças diversas,Mudanças a construções e API C<7>,Mudanças para exceções,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 miscellaneous-other-changes}@anchor{130c}
@subsection Outras mudanças diversas


@menu
* Operadores e métodos especiais:: 
* Funções embutidas:: 

@end menu

@node Operadores e métodos especiais,Funções embutidas,,Outras mudanças diversas
@anchor{whatsnew/3 0 operators-and-special-methods}@anchor{130d}
@subsubsection Operadores e métodos especiais



@itemize *

@item 
@code{!=} agora retorna o oposto de @code{==}, a menos que @code{==} retorne @ref{7d3,,NotImplemented}.

@item 
O conceito de “métodos não vinculados” foi removido da linguagem. Ao referenciar um método como um atributo de classe, agora você obtém um objeto função simples.

@item 
@code{__getslice__()}, @code{__setslice__()} and @code{__delslice__()}
were killed.  The syntax @code{a[i:j]} now translates to
@code{a.__getitem__(slice(i, j))} (or @ref{130e,,__setitem__()} or
@ref{130f,,__delitem__()}, when used as an assignment or deletion target,
respectively).

@item 
@geindex Propostas de Melhorias do Python; PEP 3114
PEP 3114@footnote{https://peps.python.org/pep-3114/}: o método padrão @ref{7d9,,next()} foi renomeado para @ref{1310,,__next__()}.

@item 
The @code{__oct__()} and @code{__hex__()} special methods are removed
– @ref{1311,,oct()} and @ref{1312,,hex()} use @ref{71d,,__index__()} now to convert
the argument to an integer.

@item 
Removed support for @code{__members__} and @code{__methods__}.

@item 
Os atributos de função chamados @code{func_X} foram renomeados para usar o formato @code{__X__}, liberando esses nomes no espaço de nomes de atributos de função para atributos definidos pelo usuário. A saber, @code{func_closure}, @code{func_code}, @code{func_defaults}, @code{func_dict}, @code{func_doc}, @code{func_globals}, @code{func_name} foram renomeados para @ref{1313,,__closure__}, @ref{29a,,__code__}, @ref{1314,,__defaults__}, @ref{1315,,__dict__}, @ref{1219,,__doc__}, @ref{1316,,__globals__}, @ref{1317,,__name__}, respectivamente.

@item 
@code{__nonzero__()} agora é @ref{1318,,__bool__()}.
@end itemize

@node Funções embutidas,,Operadores e métodos especiais,Outras mudanças diversas
@anchor{whatsnew/3 0 builtins}@anchor{1319}
@subsubsection Funções embutidas



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 3135
PEP 3135@footnote{https://peps.python.org/pep-3135/}: Nova função @ref{4db,,super()}. Agora você pode invocar @ref{4db,,super()} sem argumentos e (presumindo que isso esteja em um método de instância regular definido dentro de uma instrução @ref{131a,,class}) a classe e instância corretas serão automaticamente escolhidas. Com argumentos, o comportamento de @ref{4db,,super()} não é alterado.

@item 
@geindex Propostas de Melhorias do Python; PEP 3111
PEP 3111@footnote{https://peps.python.org/pep-3111/}: @code{raw_input()} was renamed to @ref{131b,,input()}.  That
is, the new @ref{131b,,input()} function reads a line from
@ref{53d,,sys.stdin} and returns it with the trailing newline stripped.
It raises @ref{131c,,EOFError} if the input is terminated prematurely.
To get the old behavior of @ref{131b,,input()}, use @code{eval(input())}.

@item 
Uma nova função embutido @ref{7d9,,next()} foi adicionada para chamar o método @ref{1310,,__next__()} em um objeto.

@item 
A estratégia de arredondamento da função @ref{131d,,round()} e o tipo de retorno foram alterados. Casos exatos de meio caminho agora são arredondados para o resultado par mais próximo em vez de para longe de zero. (Por exemplo, @code{round(2.5)} agora retorna @code{2} em vez de @code{3}.) @code{round(x[, n])} agora delega para @code{x.__round__([n])} em vez de sempre retornar um float. Geralmente retorna um inteiro quando chamado com um único argumento e um valor do mesmo tipo que @code{x} quando chamado com dois argumentos.

@item 
Moved @code{intern()} to @ref{131e,,sys.intern()}.

@item 
Removed: @code{apply()}.  Instead of @code{apply(f, args)} use
@code{f(*args)}.

@item 
Removed @ref{1206,,callable()}.  Instead of @code{callable(f)} you can use
@code{isinstance(f, collections.Callable)}.  The @code{operator.isCallable()}
function is also gone.

@item 
Removed @code{coerce()}.  This function no longer serves a purpose
now that classic classes are gone.

@item 
Removed @code{execfile()}.  Instead of @code{execfile(fn)} use
@code{exec(open(fn).read())}.

@item 
Removed the @code{file} type.  Use @ref{51c,,open()}.  There are now several
different kinds of streams that open can return in the @ref{7f,,io} module.

@item 
Removed @code{reduce()}.  Use @ref{131f,,functools.reduce()} if you really
need it; however, 99 percent of the time an explicit @ref{2f2,,for}
loop is more readable.

@item 
Removed @code{reload()}.  Use @code{imp.reload()}.

@item 
Removed. @code{dict.has_key()} – use the @ref{2f4,,in} operator
instead.
@end itemize

@c ======================================================================

@node Mudanças a construções e API C<7>,Desempenho,Outras mudanças diversas,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 build-and-c-api-changes}@anchor{1320}
@subsection Mudanças a construções e API C


Devido a restrições de tempo, aqui está uma lista `muito' incompleta de alterações na API C.


@itemize *

@item 
O suporte para várias plataformas foi descartado, incluindo, mas não se limitando a Mac OS 9, BeOS, RISCOS, Irix e Tru64.

@item 
@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/}: Nova API de Buffer.

@item 
@geindex Propostas de Melhorias do Python; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}: Inicialização e finalização do módulo de extensão.

@item 
@geindex Propostas de Melhorias do Python; PEP 3123
PEP 3123@footnote{https://peps.python.org/pep-3123/}: Tornando @ref{1321,,PyObject_HEAD} conforme o padrão C.

@item 
Não há mais suporte à API C para execução restrita.

@item 
As APIs C @code{PyNumber_Coerce()}, @code{PyNumber_CoerceEx()}, @code{PyMember_Get()} e @code{PyMember_Set()} foram removidas.

@item 
Nova API C @ref{3bd,,PyImport_ImportModuleNoBlock()}, funciona como @ref{3be,,PyImport_ImportModule()}, mas não bloqueia na trava de importação (retornando um erro).

@item 
Renomeado o slot e o método de nível C de conversão booleana: @code{nb_nonzero} agora é @code{nb_bool}.

@item 
Removidas @code{METH_OLDARGS} e @code{WITH_CYCLE_GC} da API C.
@end itemize

@c ======================================================================

@node Desempenho,Portando para o Python 3 0,Mudanças a construções e API C<7>,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 performance}@anchor{1322}
@subsection Desempenho


O resultado líquido das generalizações do 3.0 é que o Python 3.0 executa o benchmark pystone cerca de 10% mais lento que o Python 2.5. Provavelmente a maior causa é a remoção do uso de maiúsculas e minúsculas especiais para números inteiros pequenos. Há espaço para melhorias, mas isso acontecerá após o lançamento do 3.0!

@c ======================================================================

@node Portando para o Python 3 0,,Desempenho,O que há de novo no Python 3 0
@anchor{whatsnew/3 0 porting-to-python-3-0}@anchor{1323}
@subsection Portando para o Python 3.0


Para portar o código-fonte existente do Python 2.5 ou 2.6 para o Python 3.0, a melhor estratégia é a seguinte:


@enumerate 0

@item 
(Pré-requisito:) Comece com uma excelente cobertura de teste.

@item 
Portar para o Python 2.6. Isso não deve dar mais trabalho do que o port médio do Python 2.x para o Python 2.(x+1). Certifique-se de que todos os seus testes passem.

@item 
(Ainda usando 2.6:) Ative a opção de linha de comando @code{-3}. Isso habilita avisos sobre recursos que serão removidos (ou alterados) no 3.0. Execute seu conjunto de testes novamente e corrija o código sobre o qual você recebe avisos até que não haja mais avisos e todos os seus testes ainda passem.

@item 
Execute o tradutor de fonte para fonte @code{2to3} em sua árvore de código-fonte. Execute o resultado da tradução no Python 3.0. Corrija manualmente quaisquer problemas restantes, corrigindo problemas até que todos os testes passem novamente.
@end enumerate

Não é recomendado tentar escrever código-fonte que seja executado inalterado no Python 2.6 e 3.0; você teria que usar um estilo de codificação muito distorcido, por exemplo, evitando instruções @code{print}, metaclasses e muito mais. Se você estiver mantendo uma biblioteca que precisa ter suporte ao Python 2.6 e Python 3.0, a melhor abordagem é modificar a etapa 3 acima editando a versão 2.6 do código-fonte e executando o tradutor @code{2to3} novamente, em vez de editar a versão 3.0 do código-fonte.

Para portar extensões C para Python 3.0, consulte @ref{1324,,Portando módulos de extensão para o Python 3}.

@c ======================================================================

@node O que há de novo no Python 2 7,O que há de novo no Python 2 6,O que há de novo no Python 3 0,O que há de novo no Python
@anchor{whatsnew/2 7 doc}@anchor{1325}@anchor{whatsnew/2 7 translation-repo}@anchor{1326}@anchor{whatsnew/2 7 what-s-new-in-python-2-7}@anchor{1327}
@section O que há de novo no Python 2.7


@*Autor: 
A.M. Kuchling (amk at 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 artigo explica os novos recursos do Python 2.7. O Python 2.7 foi lançado em 3 de julho de 2010.

A manipulação numérica foi aprimorada de várias maneiras, tanto para números de ponto flutuante quanto para a classe @ref{29d,,Decimal}. Existem algumas adições úteis à biblioteca padrão, como um módulo @ref{106,,unittest} bastante aprimorado, o módulo @ref{6,,argparse} para analisar as opções da linha de comando, classes convenientes @ref{5db,,OrderedDict} e @ref{10d0,,Counter} no módulo @ref{1d,,collections} e muitas outras melhorias.

O Python 2.7 está planejado para ser o último dos lançamentos 2.x, por isso trabalhamos para torná-lo um bom lançamento a longo prazo. Para ajudar na migração para o Python 3, vários novos recursos da série Python 3.x foram incluídos no 2.7.

Este artigo não tenta fornecer uma especificação completa dos novos recursos, mas fornece uma visão geral conveniente. Para detalhes completos, você deve consultar a documentação do Python 2.7 em @indicateurl{https://docs.python.org}. Se você deseja entender a lógica do design e implementação, consulte a PEP para obter um novo recurso específico ou o problema em @indicateurl{https://bugs.python.org} no qual uma alteração foi discutida. Sempre que possível, o “O que há de novo no Python” é vinculado ao item de bug/patch de cada alteração.

@menu
* O futuro para o Python 2.x: O futuro para o Python 2 x. 
* Mudanças no tratamento de avisos de descontinuação:: 
* Recursos do Python 3.1: Recursos do Python 3 1. 
* PEP 372; Adicionando um dicionário ordenado a coleções: PEP 372 Adicionando um dicionário ordenado a coleções. 
* PEP 378; Especificador de formato para separador de milhares: PEP 378 Especificador de formato para separador de milhares<2>. 
* PEP 389; O módulo argparse para analisar linhas de comando: PEP 389 O módulo argparse para analisar linhas de comando. 
* PEP 391; Configuração baseada em dicionário para logging: PEP 391 Configuração baseada em dicionário para logging. 
* PEP 3106; Views de dicionário: PEP 3106 Views de dicionário. 
* PEP 3137; O objeto memoryview: PEP 3137 O objeto memoryview. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<14>. 
* Módulos Novos ou Aprimorados:: 
* Mudanças a construções e API C: Mudanças a construções e API C<8>. 
* Outras alterações e correções:: 
* Portando para Python 2.7: Portando para Python 2 7. 
* Novos recursos adicionados às versões de manutenção do Python 2.7: Novos recursos adicionados às versões de manutenção do Python 2 7. 
* Reconhecimentos:: 

@end menu

@node O futuro para o Python 2 x,Mudanças no tratamento de avisos de descontinuação,,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 the-future-for-python-2-x}@anchor{1328}@anchor{whatsnew/2 7 whatsnew27-python31}@anchor{1329}
@subsection O futuro para o Python 2.x


Python 2.7 é o último grande lançamento da série 2.x, já que os mantenedores do Python mudaram o foco de seus esforços de desenvolvimento de novos recursos para a série Python 3.x. Isso significa que, embora o Python 2 continue recebendo correções de bugs e seja atualizado para construir corretamente em novo hardware e versões de sistemas operados com suporte, não haverá novos lançamentos de recursos completos para a linguagem ou biblioteca padrão.

No entanto, embora haja um grande subconjunto comum entre Python 2.7 e Python 3, e muitas das mudanças envolvidas na migração para esse subconjunto comum, ou diretamente para Python 3, podem ser automatizadas com segurança, algumas outras mudanças (principalmente aquelas associadas ao tratamento Unicode) pode exigir uma consideração cuidadosa e, de preferência, conjuntos de testes de regressão automatizados robustos, para migrar com eficácia.

Isso significa que o Python 2.7 permanecerá em vigor por um longo tempo, fornecendo uma plataforma base estável e com suporte para sistemas de produção que ainda não foram portados para Python 3. O ciclo de vida completo esperado da série Python 2.7 é detalhado na 
@geindex Propostas de Melhorias do Python; PEP 373
PEP 373@footnote{https://peps.python.org/pep-0373/}.

Algumas consequências principais da significância de longo prazo de 2.7 são:


@itemize *

@item 
Conforme observado acima, a versão 2.7 tem um período de manutenção muito mais longo em comparação com as versões 2.x anteriores. Atualmente, espera-se que o Python 2.7 continue com o suporte da equipe de desenvolvimento central (recebendo atualizações de segurança e outras correções de bugs) até pelo menos 2020 (10 anos após seu lançamento inicial, em comparação com o período de suporte mais típico de 18-24 meses).

@item 
Conforme a biblioteca padrão do Python 2.7 envelhece, fazer uso efetivo do Python Package Index (diretamente ou por meio de um redistribuidor) torna-se mais importante para os usuários do Python 2. Além de uma grande variedade de pacotes de terceiros para várias tarefas, os pacotes disponíveis incluem backports de novos módulos e recursos da biblioteca padrão do Python 3 que são compatíveis com o Python 2, bem como várias ferramentas e bibliotecas que podem tornar mais fácil migre para Python 3. O Guia de Usuário para Empacotamento de Python@footnote{https://packaging.python.org} fornece orientação sobre como baixar e instalar software do Python Package Index.

@item 
Embora a abordagem preferida para aprimorar o Python 2 agora seja a publicação de novos pacotes no Python Package Index, essa abordagem não funciona necessariamente em todos os casos, especialmente aqueles relacionados à segurança de rede. Em casos excepcionais que não podem ser tratados adequadamente com a publicação de pacotes novos ou atualizados no PyPI, o processo de Proposta de Melhoria do Python, ou PEP, pode ser usado para justificar a adição de novos recursos diretamente à biblioteca padrão do Python 2. Quaisquer adições, e as versões de manutenção onde foram adicionadas, serão observadas na seção @ref{132a,,Novos recursos adicionados às versões de manutenção do Python 2.7} abaixo.
@end itemize

Para projetos que desejam migrar de Python 2 para Python 3, ou para desenvolvedores de bibliotecas e frameworks que desejam oferecer suporte a usuários em Python 2 e Python 3, há uma variedade de ferramentas e guias disponíveis para ajudar a decidir sobre uma abordagem adequada e gerenciar alguns dos os detalhes técnicos envolvidos. O ponto de partida recomendado é o guia pyporting-howto.

@node Mudanças no tratamento de avisos de descontinuação,Recursos do Python 3 1,O futuro para o Python 2 x,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 changes-to-the-handling-of-deprecation-warnings}@anchor{132b}
@subsection Mudanças no tratamento de avisos de descontinuação


Para Python 2.7, uma decisão política foi feita para silenciar avisos apenas de interesse para desenvolvedores por padrão. @ref{1a5,,DeprecationWarning} e seus descendentes agora são ignorados a menos que solicitado de outra forma, evitando que os usuários vejam avisos acionados por uma aplicação. Essa mudança também foi feita no branch que se tornou o Python 3.2. (Discutido em stdlib-sig e realizado em bpo-7319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7319}.)

Em versões anteriores, as mensagens @ref{1a5,,DeprecationWarning} eram habilitadas por padrão, fornecendo aos desenvolvedores de Python uma indicação clara de onde seu código pode quebrar em uma versão principal futura do Python.

No entanto, há cada vez mais usuários de aplicações baseadas em Python que não estão diretamente envolvidos no desenvolvimento dessas aplicações. Mensagens de @ref{1a5,,DeprecationWarning} são irrelevantes para tais usuários, fazendo-os se preocupar com uma aplicação que está realmente funcionando corretamente e sobrecarregando os desenvolvedores de aplicações com a resposta a essas preocupações.

Você pode reativar a exibição de mensagens @ref{1a5,,DeprecationWarning} executando Python com a opção @ref{8cd,,-Wdefault} (forma curta: @ref{8cd,,-Wd}) ou definindo a variável de ambiente 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} para @code{"default"} (ou @code{"d"}) antes de executar o Python. O código Python também pode reativá-los chamando @code{warnings.simplefilter('default')}.

O módulo @code{unittest} também reativa automaticamente os avisos de depreciação ao executar testes.

@node Recursos do Python 3 1,PEP 372 Adicionando um dicionário ordenado a coleções,Mudanças no tratamento de avisos de descontinuação,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 python-3-1-features}@anchor{132c}
@subsection Recursos do Python 3.1


Assim como o Python 2.6 incorporou recursos do Python 3.0, a versão 2.7 incorpora alguns dos novos recursos do Python 3.1. A série 2.x continua a fornecer ferramentas para migração para a série 3.x.

Uma lista parcial de recursos do 3.1 que foram transferidos para o 2.7:


@itemize *

@item 
A sintaxe para conjuntos de literais (@code{@{1,2,3@}} é um conjunto mutável).

@item 
Compreensões de dicionário e conjunto (@code{@{i: i*2 for i in range(3)@}}).

@item 
Vários gerenciadores de contexto em uma única instrução @ref{5d2,,with}.

@item 
Uma nova versão da biblioteca @ref{7f,,io}, reescrita em C para melhor desempenho.

@item 
O tipo de dicionário ordenado descrito na @ref{132d,,PEP 372; Adicionando um dicionário ordenado a coleções}.

@item 
O novo especificador de formato @code{","} descrito na @ref{132e,,PEP 378; Especificador de formato para separador de milhares}.

@item 
O objeto @ref{2eb,,memoryview}.

@item 
Um pequeno subconjunto do módulo @ref{77,,importlib}, @ref{132f,,descrito sob}.

@item 
O @ref{800,,repr()} de um ponto flutuante @code{x} é mais curto em muitos casos: agora é baseado na string decimal mais curta que é garantida para arredondar de volta para @code{x}. Como nas versões anteriores do Python, é garantido que @code{float(repr(x))} recupera @code{x}.

@item 
As conversões de ponto flutuante para string e string para ponto flutuante são arredondadas corretamente. A função @ref{131d,,round()} também está agora corretamente arredondada.

@item 
O tipo @ref{12b4,,PyCapsule}, usado para fornecer uma API C para módulos de extensão.

@item 
A função de API C @ref{12a8,,PyLong_AsLongAndOverflow()}.
@end itemize

Outros novos avisos do modo Python3 incluem:


@itemize *

@item 
@code{operator.isCallable()} e @code{operator.sequenceIncludes()}, que não são suportados no 3.x, agora disparam avisos.

@item 
A opção @code{-3} agora habilita automaticamente a opção @code{-Qwarn} que causa avisos sobre o uso de divisão clássica com inteiros e inteiros longos.
@end itemize

@c ========================================================================

@c Large, PEP-level features and changes should be described here.

@c ========================================================================

@node PEP 372 Adicionando um dicionário ordenado a coleções,PEP 378 Especificador de formato para separador de milhares<2>,Recursos do Python 3 1,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-0372}@anchor{132d}@anchor{whatsnew/2 7 pep-372-adding-an-ordered-dictionary-to-collections}@anchor{1330}
@subsection PEP 372: Adicionando um dicionário ordenado a coleções


Dicionários regulares no Python iteram sobre pares de chave/valor em ordem arbitrária. Ao longo dos anos, vários autores escreveram implementações alternativas que lembram a ordem em que as chaves foram inseridas originalmente. Com base nas experiências dessas implementações, 2.7 introduz uma nova classe @ref{5db,,OrderedDict} no módulo @ref{1d,,collections}.

A API @ref{5db,,OrderedDict} fornece a mesma interface que os dicionários regulares, mas itera sobre chaves e valores em uma ordem garantida dependendo de quando uma chave foi inserida pela primeira vez:

@example
>>> from collections import OrderedDict
>>> d = OrderedDict([('first', 1),
...                  ('second', 2),
...                  ('third', 3)])
>>> d.items()
[('first', 1), ('second', 2), ('third', 3)]
@end example

Se uma nova entrada substituir uma entrada existente, a posição de inserção original permanece inalterada:

@example
>>> d['second'] = 4
>>> d.items()
[('first', 1), ('second', 4), ('third', 3)]
@end example

Excluir uma entrada e reinseri-la irá movê-la para o final:

@example
>>> del d['second']
>>> d['second'] = 5
>>> d.items()
[('first', 1), ('third', 3), ('second', 5)]
@end example

O método @ref{1331,,popitem()} tem um argumento opcional `last' cujo valor padrão é @code{True}. Se `last' for true, a chave adicionada mais recentemente é retornada e removida; se for falso, a chave mais antiga é selecionada:

@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

A comparação de dois dicionários ordenados verifica as chaves e os valores e exige que o pedido de inserção seja o mesmo:

@example
>>> od1 = OrderedDict([('first', 1),
...                    ('second', 2),
...                    ('third', 3)])
>>> od2 = OrderedDict([('third', 3),
...                    ('first', 1),
...                    ('second', 2)])
>>> od1 == od2
False
>>> # Move a chave 'third' para o fim
>>> del od2['third']; od2['third'] = 3
>>> od1 == od2
True
@end example

Comparar um @ref{5db,,OrderedDict} com um dicionário regular ignora a ordem de inserção e apenas compara as chaves e valores.

Como funciona a @ref{5db,,OrderedDict}? Ela mantém uma lista duplamente vinculada de chaves, acrescentando novas chaves à lista à medida que são inseridas. Um dicionário secundário mapeia as chaves para seu nó de lista correspondente, portanto, a exclusão não precisa percorrer toda a lista vinculada e, portanto, permanece `O'(1).

A biblioteca padrão agora oferece suporte ao uso de dicionários ordenados em vários módulos.


@itemize *

@item 
O módulo @ref{22,,ConfigParser} os usa por padrão, o que significa que os arquivos de configuração agora podem ser lidos, modificados e então escritos de volta em sua ordem original.

@item 
O método @ref{9e9,,_asdict()} para @ref{1ca,,collections.namedtuple()} agora retorna um dicionário ordenado com os valores aparecendo na mesma ordem que os índices de tupla subjacentes.

@item 
O construtor de classe @ref{d6a,,JSONDecoder} do módulo @ref{82,,json} foi estendido com um parâmetro `object_pairs_hook' para permitir que instâncias @code{OrderedDict} sejam construídas pelo decodificador. O suporte também foi adicionado para ferramentas de terceiros como PyYAML@footnote{https://pyyaml.org/}.
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - Adicionando um dicionário ordenado às coleções

PEP escrita por Armin Ronacher e Raymond Hettinger; implementada por Raymond Hettinger.
@end table


@node PEP 378 Especificador de formato para separador de milhares<2>,PEP 389 O módulo argparse para analisar linhas de comando,PEP 372 Adicionando um dicionário ordenado a coleções,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-0378}@anchor{132e}@anchor{whatsnew/2 7 pep-378-format-specifier-for-thousands-separator}@anchor{1332}
@subsection PEP 378: Especificador de formato para separador de milhares


Para tornar a saída do programa mais legível, pode ser útil adicionar separadores a números grandes, renderizando-os como 18,446,744.073,709,551,616 em vez de 18446744073709551616.

A solução totalmente geral para fazer isso é o módulo @ref{86,,locale}, que pode usar diferentes separadores (“,” na América do Norte, “.” na Europa) e diferentes tamanhos de agrupamento, mas @ref{86,,locale} é complicado para usar e inadequado para aplicativos multithread onde diferentes threads estão produzindo saída para diferentes localidades.

Portanto, um mecanismo simples de agrupamento de vírgulas foi adicionado à minilinguagem usada pelo método @ref{621,,str.format()}. Ao formatar um número de ponto flutuante, basta incluir uma vírgula entre a largura e a precisão:

@example
>>> '@{:20,.2f@}'.format(18446744073709551616.0)
'18,446,744,073,709,551,616.00'
@end example

Ao formatar um número inteiro, inclua a vírgula após a largura:

@example
>>> '@{:20,d@}'.format(18446744073709551616)
'18,446,744,073,709,551,616'
@end example

Este mecanismo não é adaptável de forma alguma; vírgulas são sempre usadas como separadores e o agrupamento é sempre em grupos de três dígitos. O mecanismo de formatação de vírgula não é tão geral quanto o módulo @ref{86,,locale}, mas é mais fácil de usar.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - Especificador de formato para separador de milhares

PEP escrita por Raymond Hettinger; implementada por Eric Smith.
@end table


@node PEP 389 O módulo argparse para analisar linhas de comando,PEP 391 Configuração baseada em dicionário para logging,PEP 378 Especificador de formato para separador de milhares<2>,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-389-the-argparse-module-for-parsing-command-lines}@anchor{1333}
@subsection PEP 389: O módulo argparse para analisar linhas de comando


O módulo @ref{6,,argparse} para analisar argumentos de linha de comando foi adicionado como um substituto mais poderoso para o módulo @ref{a0,,optparse}.

Isso significa que Python agora oferece suporte a três módulos diferentes para analisar argumentos de linha de comando: @ref{61,,getopt}, @ref{a0,,optparse} e @ref{6,,argparse}. O módulo @ref{61,,getopt} se assemelha muito à função @code{getopt()} da biblioteca C, portanto continua útil se você estiver escrevendo um protótipo Python que eventualmente será reescrito em C. @ref{a0,,optparse} torna-se redundante, mas não há planos para removê-lo porque muitos scripts ainda o utilizam e não há uma maneira automatizada de atualizar esses scripts. (Tornar a API @ref{6,,argparse} consistente com a interface de @ref{a0,,optparse} foi discutido, mas rejeitado por ser muito confuso e difícil.)

Resumindo, se você está escrevendo um novo script e não precisa se preocupar com a compatibilidade com versões anteriores do Python, use @ref{6,,argparse} ao invés de @ref{a0,,optparse}.

Aqui está um exemplo:

@example
import argparse

parser = argparse.ArgumentParser(description='Command-line example.')

# Adiciona alterações opcionais
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')

# Permite qualquer número de argumentos adicionais.
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 você o substitua, as opções @code{-h} e @code{--help} são adicionadas automaticamente e produzem uma saída formatada de maneira organizada:

@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

Como em @ref{a0,,optparse}, as opções e argumentos da linha de comando são retornados como um objeto com atributos nomeados pelos 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{6,,argparse} tem uma validação muito mais sofisticada que @ref{a0,,optparse}; você pode especificar um número exato de argumentos como um inteiro, 0 ou mais argumentos passando @code{'*'}, 1 ou mais passando @code{'+'}, ou um argumento opcional com @code{'?'}. Um analisador de nível superior pode conter sub-analisadores para definir subcomandos que possuem diferentes conjuntos de opções, como em @code{svn commit}, @code{svn checkout}, etc. Você pode especificar o tipo de um argumento como @ref{f4d,,FileType}, que abrirá arquivos automaticamente para você e entende que @code{'-'} significa entrada ou saída padrão.


@subsubheading Ver também



@table @asis

@item Documentação do @ref{6,,argparse}

A página de documentação do módulo argparse.

@item @ref{11ed,,Migrando código optparse para argparse}

Parte da documentação do Python, descrevendo como converter o código que usa @ref{a0,,optparse}.

@geindex Propostas de Melhorias do Python; PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - argparse - Novo módulo de análise sintática de linha de comando

PEP escrita e implementada por Steven Bethard.
@end table


@node PEP 391 Configuração baseada em dicionário para logging,PEP 3106 Views de dicionário,PEP 389 O módulo argparse para analisar linhas de comando,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-391-dictionary-based-configuration-for-logging}@anchor{1334}
@subsection PEP 391: Configuração baseada em dicionário para logging


O módulo @ref{87,,logging} é muito flexível; os aplicativos podem definir uma árvore de subsistemas de log e cada logger nessa árvore pode filtrar determinadas mensagens, formatá-las de maneira diferente e direcionar mensagens para um número variável de manipuladores.

Toda essa flexibilidade pode exigir muita configuração. Você pode escrever instruções Python para criar objetos e definir suas propriedades, mas uma configuração complexa requer um código detalhado, mas enfadonho. @ref{87,,logging} também suporta uma função @ref{b66,,fileConfig()} que analisa um arquivo, mas o formato do arquivo não oferece suporte  à configuração de filtros, e é mais confuso gerar programaticamente.

O Python 2.7 adiciona uma função @ref{11ef,,dictConfig()} que usa um dicionário para configurar o log. Existem muitas maneiras de produzir um dicionário a partir de diferentes fontes: construir um com código; analisar um arquivo contendo JSON; ou use uma biblioteca de análise de YAML se houver uma instalada. Para mais informações veja @ref{1335,,Funções de configuração}.

O exemplo a seguir configura dois loggers, o logger raiz e um logger denominado “network”. As mensagens enviadas para o registrador raiz serão enviadas para o log do sistema usando o protocolo syslog, e as mensagens para o logger “network” serão gravadas em um arquivo @code{network.log} que será rotacionado assim que o log atingir 1 MB.

@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'@}@},

 # Especifica todos os loggers subordinados
 'loggers': @{
             'network': @{
                         'handlers': ['netlog']
             @}
 @},
 # Especifica propriedades do logger raiz
 'root': @{
          'handlers': ['syslog']
 @},
@}

# Prepara as configurações
logging.config.dictConfig(configdict)

# Como um exemplo, registra duas mensagens de erro
logger = logging.getLogger('/')
logger.error('Database not found')

netlogger = logging.getLogger('network')
netlogger.error('Connection failed')
@end example

Três melhorias menores no módulo @ref{87,,logging}, todas implementadas por Vinay Sajip, são:

@c rev79293


@itemize *

@item 
A classe @ref{65c,,SysLogHandler} agora tem suporte a syslogging sobre TCP. O construtor tem um parâmetro `socktype' que fornece o tipo de soquete a ser usado, @ref{1336,,socket.SOCK_DGRAM} para UDP ou @ref{1337,,socket.SOCK_STREAM} para TCP. O protocolo padrão permanece UDP.

@item 
As instâncias @ref{b64,,Logger} ganharam um método @ref{1338,,getChild()} que recupera um logger descendente usando um caminho relativo. Por exemplo, depois de recuperar um logger fazendo @code{log = getLogger('app')}, chamar @code{log.getChild('network.listen')} é equivalente a @code{getLogger('app.network.listen')}.

@item 
A classe @ref{1339,,LoggerAdapter} ganhou um método @ref{133a,,isEnabledFor()} que pega um `level' e retorna se o logger subjacente processaria uma mensagem desse nível de importância.
@end itemize

@c XXX: Logger objects don't have a class declaration so the link don't work


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - Configuração baseada em dicionário para logging

PEP escrita e implementada por Vinay Sajip.
@end table


@node PEP 3106 Views de dicionário,PEP 3137 O objeto memoryview,PEP 391 Configuração baseada em dicionário para logging,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-3106-dictionary-views}@anchor{133b}
@subsection PEP 3106: Views de dicionário


Os métodos de dicionário @ref{7ce,,keys()}, @ref{7cf,,values()} e @ref{7d0,,items()} são diferentes no Python 3.x. Eles retornam um objeto chamado `view' em vez de uma lista totalmente materializada.

Não é possível alterar os valores de retorno de @ref{7ce,,keys()}, @ref{7cf,,values()} e @ref{7d0,,items()} no Python 2.7 porque muito código seria interrompido. Em vez disso, as versões 3.x foram adicionadas com os novos nomes @code{viewkeys()}, @code{viewvalues()} e @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

As views podem ser iteradas, mas as exibições de chave e item também se comportam como conjuntos. O operador @code{&} realiza a interseção, e o @code{|} realiza uma união:

@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

A view acompanha o dicionário e seu conteúdo muda à medida que o dicionário é modificado:

@example
>>> vk = d.viewkeys()
>>> vk
dict_keys([0, 130, 10, ..., 250])
>>> d[260] = '&'
>>> vk
dict_keys([0, 130, 260, 10, ..., 250])
@end example

No entanto, observe que você não pode adicionar ou remover chaves enquanto estiver iterando na view:

@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

Você pode usar os métodos de exibição no código Python 2.x, e o conversor 2to3 irá alterá-los para os métodos padrão @ref{7ce,,keys()}, @ref{7cf,,values()} e @ref{7d0,,items()}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3106

@item PEP 3106@footnote{https://peps.python.org/pep-3106/} - Repaginação de dict.keys(), .values() e .items()

PEP escrita por Guido van Rossum. Backported para 2.7 por Alexandre Vassalotti; bpo-1967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1967}.
@end table


@node PEP 3137 O objeto memoryview,Outras mudanças na linguagem<14>,PEP 3106 Views de dicionário,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 pep-3137-the-memoryview-object}@anchor{133c}
@subsection PEP 3137: O objeto memoryview


O objeto @ref{2eb,,memoryview} fornece uma visão do conteúdo da memória de outro objeto que corresponde à interface do tipo @ref{1c2,,bytes}.

@example
>>> import string
>>> m = memoryview(string.letters)
>>> m
<memory at 0x37f850>
>>> len(m)           # Retorna o comprimento de objeto subjacente
52
>>> m[0], m[25], m[26]   # Indexação retorna um byte
('a', 'z', 'A')
>>> m2 = m[0:26]         # Fatiamento retorna outra memoryview
>>> m2
<memory at 0x37f080>
@end example

O conteúdo da viewq pode ser convertido em uma string de bytes ou uma lista de inteiros:

@example
>>> m2.tobytes()
'abcdefghijklmnopqrstuvwxyz'
>>> m2.tolist()
[97, 98, 99, 100, 101, 102, 103, ... 121, 122]
>>>
@end example

Objetos @ref{2eb,,memoryview} permitem modificar o objeto subjacente se for um objeto mutável.

@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)  # Criando um objeto mutável
>>> b
bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
>>> mb = memoryview(b)
>>> mb[0] = '*'         # Atribui para visão, alterando o bytearray.
>>> b[0:5]              # O bytearray foi alterado.
bytearray(b'*bcde')
>>>
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3137

@item PEP 3137@footnote{https://peps.python.org/pep-3137/} - Bytes imutáveis e buffer mutável

PEP escrita por Guido van Rossum. Implementada por Travis Oliphant, Antoine Pitrou e outros. Portado para 2.7 por Antoine Pitrou; bpo-2396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2396}.
@end table


@node Outras mudanças na linguagem<14>,Módulos Novos ou Aprimorados,PEP 3137 O objeto memoryview,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 other-language-changes}@anchor{133d}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
A sintaxe para set literais foi portada do Python 3.x. Os colchetes são usados para cercar o conteúdo do conjunto mutável resultante; os literais definidos são diferenciados dos dicionários por não conterem caracteres de dois pontos e valores. @code{@{@}} continua a representar um dicionário vazio; use @code{set()} para um conjunto vazio.

@example
>>> @{1, 2, 3, 4, 5@}
set([1, 2, 3, 4, 5])
>>> set() # conjunto vazio
set([])
>>> @{@}    # dicionário vazio
@{@}
@end example

Portado por Alexandre Vassalotti; bpo-2335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2335}.

@item 
As compreensões de dicionário e conjunto são outro recurso importado do 3.x, generalizando as compreensões de lista/gerador para usar a sintaxe literal para conjuntos e dicionários.

@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 
A instrução @ref{5d2,,with} agora pode usar vários gerenciadores de contexto em uma instrução. Os gerenciadores de contexto são processados da esquerda para a direita e cada um é tratado como o início de uma nova instrução @code{with}. Isso significa que:

@example
with A() as a, B() as b:
    ... conjunto de instruções ...
@end example

é equivalente a:

@example
with A() as a:
    with B() as b:
        ... conjunto de instruções ...
@end example

A função @code{contextlib.nested()} fornece uma função muito similar, então não é mais necessária e foi descontinuada.

(Proposta em @indicateurl{https://codereview.appspot.com/53094}; implementada por Georg Brandl.)

@item 
As conversões entre números de ponto flutuante, ou float. e strings agora são arredondadas corretamente na maioria das plataformas. Estas conversões ocorrem em muitos lugares diferentes: @ref{44c,,str()} em floats e números complexos; os construtores @ref{2f7,,float} e @ref{2f8,,complex}; formatação numérica; serializar e desserializar floats e números complexos usando os módulos @ref{8d,,marshal}, @ref{a6,,pickle} e @ref{82,,json}; análise de float e literais imaginários no código Python; e a conversão @ref{29d,,Decimal}-para-float.

Relacionado a isso, o @ref{800,,repr()} de um número de ponto flutuante `x' agora retorna um resultado baseado na string decimal mais curta que é garantida para arredondar de volta para `x' sob o arredondamento correto (com o modo de arredondamento round-half-to-even). Anteriormente, fornecia uma string baseada no arredondamento x para 17 dígitos decimais.

@c maybe add an example?

A biblioteca de arredondamento responsável por essa melhoria funciona no Windows e em plataformas Unix usando os compiladores gcc, icc ou suncc. Pode haver um pequeno número de plataformas onde a operação correta deste código não pode ser garantida, então o código não é usado em tais sistemas. Você pode descobrir qual código está sendo usado verificando @ref{133e,,sys.float_repr_style}, que será @code{short} se o novo código estiver em uso e @code{legacy} se não estiver.

Implementada por Eric Smith and Mark Dickinson, usando a biblioteca @code{dtoa.c} de David Gay; bpo-7117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7117}.

@item 
As conversões de inteiros longos e inteiros regulares para ponto flutuante agora arredondam de maneira diferente, retornando o número de ponto flutuante mais próximo ao número. Isso não importa para pequenos inteiros que podem ser convertidos exatamente, mas para grandes números que inevitavelmente perderão a precisão, o Python 2.7 agora se aproxima mais. Por exemplo, o Python 2.6 computou o seguinte:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935283e+20
>>> n - long(float(n))
65535L
@end example

O resultado de ponto flutuante do Python 2.7 é maior, mas muito mais próximo do valor verdadeiro:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935289e+20
>>> n - long(float(n))
-1L
@end example

(Implementada por Mark Dickinson; bpo-3166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3166}.)

A divisão inteira também é mais precisa em seus comportamentos de arredondamento. (Também implementada por Mark Dickinson; bpo-1811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1811}.)

@item 
A coerção implícita para números complexos foi removida; o interpretador nunca mais tentará chamar um método @code{__coerce__()} em objetos complexos. (Removido por Meador Inge e Mark Dickinson; bpo-5211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5211}.)

@item 
O método @ref{621,,str.format()} agora tem suporte à numeração automática dos campos de substituição. Isso torna o uso de @ref{621,,str.format()} mais parecido com o uso da formatação @code{%s}:

@example
>>> '@{@}:@{@}:@{@}'.format(2009, 04, 'Sunday')
'2009:4:Sunday'
>>> '@{@}:@{@}:@{day@}'.format(2009, 4, day='Sunday')
'2009:4:Sunday'
@end example

A numeração automática leva os campos da esquerda para a direita, então o primeiro especificador @code{@{...@}} usará o primeiro argumento para @ref{621,,str.format()}, o próximo especificador usará o próximo argumento e breve. Você não pode misturar a numeração automática e a numeração explícita – numerar todos os seus campos especificadores ou nenhum deles – mas você pode misturar a numeração automática e os campos nomeados, como no segundo exemplo acima. (Contribuição de Eric Smith; bpo-5237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5237}.)

Números complexos agora suportam corretamente o uso com @ref{61f,,format()}, e o padrão é alinhamento à direita. A especificação de uma precisão ou separação por vírgula aplica-se às partes reais e imaginárias do número, mas uma largura de campo e alinhamento especificados são aplicados a toda a saída @code{1.5+3j} resultante. (Contribuição de Eric Smith; bpo-1588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1588} e bpo-7988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7988}.)

O código de formato ‘F’ agora sempre formata sua saída usando caracteres maiúsculos, então agora produzirá ‘INF’ e ‘NAN’. (Contribuição de Eric Smith; bpo-3382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3382}.)

Uma alteração de baixo nível: o método @ref{61e,,object.__format__()} agora aciona um @ref{8ce,,PendingDeprecationWarning} se for passado uma string de formato, porque o método @code{__format__()} para @ref{a96,,object} converte o objeto para uma representação de string e formata isso. Anteriormente, o método aplicava silenciosamente a string de formato à representação da string, mas isso poderia ocultar erros no código Python. Se você estiver fornecendo informações de formatação, como alinhamento ou precisão, presumivelmente espera que a formatação seja aplicada de alguma maneira específica do objeto. (Correção de Eric Smith; bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994}.)

@item 
Os tipos @ref{257,,int()} e @code{long()} ganharam um método @code{bit_length} que retorna o número de bits necessários para representar seu argumento em binário:

@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

(Contribuição de Fredrik Johansson e Victor Stinner; bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439}.)

@item 
A instrução @ref{5e2,,import} não tentará mais uma importação absoluta se uma importação relativa (por exemplo, @code{from .os import sep}) falhar. Isso corrige um bug, mas pode possivelmente quebrar certas instruções @code{import} que estavam funcionando apenas por acidente. (Correção de Meador Inge; bpo-7902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7902}.)

@item 
Agora é possível para uma subclasse do tipo embutido @code{unicode} substituir o método @code{__unicode__()}. (Implementado por Victor Stinner; bpo-1583863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583863}.)

@item 
O método @ref{133f,,translate()} do tipo @ref{2ea,,bytearray} agora aceita @code{None} como seu primeiro argumento. (Correção de Georg Brandl; bpo-4759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4759}.)

@c XXX bytearray doesn't seem to be documented

@item 
Ao usar @ref{166,,@@classmethod} e @ref{416,,@@staticmethod} para agrupar métodos como classe ou métodos estáticos, o objeto envólucro agora expõe a função agrupada como seu atributo @ref{1340,,__func__}. (Contribuição de Amaury Forgeot d’Arc, após sugestão de George Sakkis; bpo-5982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5982}.)

@item 
Quando um conjunto restrito de atributos foi definido usando @code{__slots__}, excluir um atributo não definido não levantaria @ref{34b,,AttributeError} como seria de esperar. Correção de Benjamin Peterson; bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604}.)

@item 
Duas novas codificações agora são suportadas: “cp720”, usado principalmente para texto em árabe; e “cp858”, uma variante do CP 850 que adiciona o símbolo do euro. (CP720 foi contribuição de Alexander Belchenko e Amaury Forgeot d’Arc em bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979}; CP858 foi contribuição de Tim Hatch em bpo-8016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8016}.)

@item 
O objeto @code{file} agora definirá o atributo @code{filename} na exceção @ref{108b,,IOError} ao tentar abrir um diretório em plataformas POSIX (observado por Jan Kaliszewski; bpo-4764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4764}) , e agora verifica explicitamente e proíbe a gravação em objetos arquivo somente leitura em vez de confiar na biblioteca C para detectar e relatar o erro (correção de Stefan Krah; bpo-5677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5677}).

@item 
O tokenizador do Python agora traduz as próprias terminações de linha, então a função embutida @ref{192,,compile()} agora aceita código usando qualquer convenção de terminação de linha. Além disso, não requer mais que o código termine em uma nova linha.

@item 
Parênteses extras em definições de função são ilegais no Python 3.x, o que significa que você obtém um erro de sintaxe de @code{def f((x)): pass}. No modo de aviso do Python3, o Python 2.7 agora avisará sobre esse uso estranho. (Notado por James Lingard; bpo-7362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7362}.)

@item 
Agora é possível criar referências fracas para objetos de classe de estilo antigo. As classes de novo estilo sempre tiveram referências fracas. (Correção de Antoine Pitrou; bpo-8268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8268}.)

@item 
Quando um objeto de módulo é coletado como lixo, o dicionário do módulo agora só é limpo se ninguém mais estiver mantendo uma referência ao dicionário (bpo-7140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7140}).
@end itemize

@c ======================================================================

@menu
* Alterações no interpretador:: 
* Otimizações: Otimizações<13>. 

@end menu

@node Alterações no interpretador,Otimizações<13>,,Outras mudanças na linguagem<14>
@anchor{whatsnew/2 7 interpreter-changes}@anchor{1341}@anchor{whatsnew/2 7 new-27-interpreter}@anchor{1342}
@subsubsection Alterações no interpretador


Uma nova variável de ambiente, 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}, permite controlar os avisos. Deve ser definido como uma string contendo configurações de aviso, equivalentes àquelas usadas com a opção @ref{8cd,,-W}, separadas por vírgulas. (Contribuição de Brian Curtin; bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301}.)

Por exemplo, a configuração a seguir imprimirá avisos toda vez que ocorrerem, mas transformará os avisos do módulo @ref{71,,Cookie} em um erro. (A sintaxe exata para definir uma variável de ambiente varia entre sistemas operacionais e shells.)

@example
export PYTHONWARNINGS=all,error:::Cookie:0
@end example

@c ======================================================================

@node Otimizações<13>,,Alterações no interpretador,Outras mudanças na linguagem<14>
@anchor{whatsnew/2 7 optimizations}@anchor{1343}
@subsubsection Otimizações


Vários aprimoramentos de desempenho foram adicionados:


@itemize *

@item 
Um novo opcode foi adicionado para executar a configuração inicial das instruções @ref{5d2,,with}, procurando os métodos @ref{5c8,,__enter__()} e @ref{1344,,__exit__()}. (Contribuição de Benjamin Peterson.)

@item 
O coletor de lixo agora funciona melhor para um padrão de uso comum: quando muitos objetos estão sendo alocados sem desalocar nenhum deles. Anteriormente, isso levaria um tempo quadrático para coleta de lixo, mas agora o número de coletas de lixo completas é reduzido à medida que o número de objetos no heap aumenta. A nova lógica só executa uma passagem completa de coleta de lixo quando a geração intermediária tiver sido coletada 10 vezes e quando o número de objetos sobreviventes da geração intermediária exceder 10% do número de objetos da geração mais antiga. (Sugerido por Martin von Löwis e implementado por Antoine Pitrou; bpo-4074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4074}.)

@item 
O coletor de lixo tenta evitar o rastreamento de contêineres simples que não podem fazer parte de um ciclo. No Python 2.7, isso agora é verdade para tuplas e dicts contendo tipos atômicos (como ints, strings, etc.). Transitivamente, um dict contendo tuplas de tipos atômicos também não será rastreado. Isso ajuda a reduzir o custo de cada coleta de lixo diminuindo o número de objetos a serem considerados e percorridos pelo coletor. (Contribuição de Antoine Pitrou; bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}.)

@item 
Inteiros longos agora são armazenados internamente na base @code{2**15} ou na base @code{2**30}, sendo a base determinada no momento da compilação. Anteriormente, eles eram sempre armazenados na base @code{2**15}. O uso de base @code{2**30} oferece melhorias significativas de desempenho em máquinas de 64 bits, mas os resultados de benchmark em máquinas de 32 bits foram mistos. Portanto, o padrão é usar base @code{2**30} em máquinas de 64 bits e base @code{2**15} em máquinas de 32 bits; no Unix, há uma nova opção de configuração @code{--enable-big-digits} que pode ser usada para substituir esse padrão.

Além das melhorias de desempenho, essa alteração deve ser invisível para os usuários finais, com uma exceção: para fins de teste e depuração, há um novo structseq @code{sys.long_info} que fornece informações sobre o formato interno, fornecendo o número de bits por dígito e o tamanho em bytes do tipo C usado para armazenar cada dígito:

@example
>>> import sys
>>> sys.long_info
sys.long_info(bits_per_digit=30, sizeof_digit=4)
@end example

(Contributed by Mark Dickinson; bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258}.)

Outro conjunto de alterações tornou os objetos longos alguns bytes menores: 2 bytes menores em sistemas de 32 bits e 6 bytes em sistemas de 64 bits. (Contribuição de Mark Dickinson; bpo-5260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5260}.)

@item 
O algoritmo de divisão para números inteiros longos ficou mais rápido apertando o laço interno, fazendo deslocamentos em vez de multiplicações e corrigindo uma iteração extra desnecessária. Vários benchmarks mostram acelerações entre 50% e 150% para divisões inteiras longas e operações de módulo. (Contribuição de Mark Dickinson; bpo-5512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5512}.) Operações bit a bit também são significativamente mais rápidas (patch inicial de Gregory Smith; bpo-1087418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1087418}).

@item 
A implementação de @code{%} verifica se o operando do lado esquerdo é uma string Python e usa casos especiais; isso resulta em um aumento de desempenho de 1 a 3% para aplicativos que usam frequentemente @code{%} com strings, como templates em bibliotecas. (Implementação de Collin Winter; bpo-5176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5176}.)

@item 
Compreensões de lista com uma condição @code{if} são compiladas em bytecode mais rápido. (Patch de Antoine Pitrou, retroportado para 2.7 por Jeffrey Yasskin; bpo-4715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4715}.)

@item 
A conversão de um inteiro ou inteiro longo em uma string decimal ficou mais rápida com o uso de maiúsculas e minúsculas especiais na base 10, em vez de usar uma função de conversão generalizada que oferece suporte a bases arbitrárias. (Patch por Gawain Bolton; bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713}.)

@item 
Os métodos @code{split()}, @code{replace()}, @code{rindex()}, @code{rpartition()} e @code{rsplit()} de tipos semelhantes a strings (strings, Strings Unicode e objetos @ref{2ea,,bytearray}) agora usam um algoritmo de pesquisa reversa rápida em vez de uma varredura caractere por caractere. Às vezes, isso é mais rápido por um fator de 10. (Adicionado por Florent Xicluna; bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462} e bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622}.)

@item 
Os módulos @ref{a6,,pickle} e @code{cPickle} agora internalizam automaticamente as strings usadas para nomes de atributos, reduzindo o uso de memória dos objetos resultantes da desserialização com pickle. (Contribuição de Jake McGuire; bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084}.)

@item 
O módulo @code{cPickle} agora usa dicionários de casos especiais, reduzindo quase pela metade o tempo necessário para serializá-los com pickle. (Contribuição de Collin Winter; bpo-5670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5670}.)
@end itemize

@c ======================================================================

@node Módulos Novos ou Aprimorados,Mudanças a construções e API C<8>,Outras mudanças na linguagem<14>,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 new-and-improved-modules}@anchor{1345}
@subsection Módulos Novos ou Aprimorados


Como em todas os lançamentos, a biblioteca padrão do Python recebeu diversas melhorias e correções de bugs. Aqui está uma lista parcial das mudanças mais notáveis, classificadas em ordem alfabética por nome do módulo. Consulte o arquivo @code{Misc/NEWS} na árvore de código-fonte para uma lista mais completa de alterações, ou procure nos logs do Subversion para todos os detalhes.


@itemize *

@item 
A classe de depuração base do módulo @ref{f,,bdb} @ref{1346,,Bdb} ganhou um recurso para pular módulos. O construtor agora usa um iterável contendo padrões estilo glob como @code{django.*}; o depurador não entrará nos quadros de pilha de um módulo que corresponda a um desses padrões. (Contribuição de Maru Newby após sugestão de Senthil Kumaran; bpo-5142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5142}.)

@item 
O módulo @ref{10,,binascii} agora oferece suporte à API de buffer, então ele pode ser usado com instâncias @ref{2eb,,memoryview} e outros objetos buffer similares. (Backport de 3.x por Florent Xicluna; bpo-7703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7703}.)

@item 
Módulo atualizado: o módulo @code{bsddb} foi atualizado de 4.7.2devel9 para a versão 4.8.4 do pacote pybsddb@footnote{https://www.jcea.es/programacion/pybsddb.htm}. A nova versão apresenta melhor compatibilidade com Python 3.x, várias correções de bugs e adiciona vários novos sinalizadores e métodos BerkeleyDB. (Atualizado por Jesús Cea Avión; bpo-8156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8156}. O changelog do pybsddb pode ser lido em @indicateurl{https://hg.jcea.es/pybsddb/file/tip/ChangeLog}.)

@item 
O @ref{86a,,BZ2File} do módulo @ref{13,,bz2} agora oferece suporte ao protocolo de gerenciamento de contexto, então você pode escrever @code{with bz2.BZ2File(...) as f:}. (Contribuição de Hagen Fürstenau; bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}.)

@item 
Nova classe: a classe @ref{10d0,,Counter} no módulo @ref{1d,,collections} é útil para contabilizar dados. As instâncias @ref{10d0,,Counter} se comportam principalmente como dicionários, mas retornam zero para chaves ausentes em vez de levantar uma exceção @ref{344,,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

Existem três métodos @ref{10d0,,Counter} adicionais. @ref{1347,,most_common()} retorna os N elementos mais comuns e suas contagens. @ref{1348,,elements()} retorna um iterador sobre os elementos contidos, repetindo cada elemento tantas vezes quanto sua contagem. @ref{121e,,subtract()} pega um iterável e subtrai um para cada elemento em vez de adicionar; se o argumento for um dicionário ou outro @code{Counter}, as contagens são subtraídas.

@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

Contribuição de Raymond Hettinger; bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199}.

@c revision 79660

Nova classe: @ref{5db,,OrderedDict} é descrita na seção anterior @ref{132d,,PEP 372; Adicionando um dicionário ordenado a coleções}.

Novo método: O tipo de dados @ref{5dc,,deque} agora tem um método @ref{1220,,count()} que retorna o número de elementos contidos igual ao argumento fornecido `x', e um @ref{1221,,reverse()} método que inverte os elementos do deque no local. @ref{5dc,,deque} também expõe seu comprimento máximo como o atributo somente leitura @ref{1349,,maxlen}. (Ambos os recursos adicionados por Raymond Hettinger.)

A classe @ref{1ca,,namedtuple} agora possui um parâmetro opcional `rename'. Se `rename' for verdadeiro, os nomes de campos inválidos porque foram repetidos ou não são identificadores Python legais serão renomeados para nomes legais derivados da posição do campo na 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

(Adição de Raymond Hettinger; bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818}.)

Finalmente, a classe base abstrata @ref{8d0,,Mapping} agora retorna @ref{7d3,,NotImplemented} se um mapeamento for comparado a outro tipo que não seja um @code{Mapping}. (Correção de Daniel Stutzbach; bpo-8729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8729}.)

@item 
Construtores para as classes de análise no módulo @ref{22,,ConfigParser} agora recebem um parâmetro `allow_no_value', cujo padrão é false; se verdadeiro, opções sem valores serão permitidas. Por exemplo:

@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

(Contribuição de Mats Kindahl; bpo-7005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7005}.)

@item 
Função descontinuada: @code{contextlib.nested()}, que permite lidar com mais de um gerenciador de contexto com uma única instrução @ref{5d2,,with}, foi descontinuada porque a instrução @code{with} agora oferece suporte a múltiplos contextos gerentes.

@item 
O módulo @ref{70,,cookielib} agora ignora cookies que possuem um campo de versão inválido, que não contém um valor inteiro. (Correção de John J. Lee; bpo-3924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3924}.)

@item 
A função @ref{b84,,deepcopy()} do módulo @ref{25,,copy} agora copiará corretamente os métodos de instância vinculados. (Implementado por Robert Collins; bpo-1515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1515}.)

@item 
O módulo @ref{2a,,ctypes} agora sempre converte @code{None} em um ponteiro C @code{NULL} para argumentos declarados como ponteiros. (Alterado por Thomas Heller; bpo-4606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4606}.) A biblioteca libffi@footnote{https://sourceware.org/libffi/} subjacente foi atualizada para a versão 3.0.9, contendo várias correções para diferentes plataformas. (Atualizado por Matthias Klose; bpo-8142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8142}.)

@item 
Novo método: a classe @ref{9d7,,timedelta} do módulo @ref{30,,datetime} ganhou um método @ref{134a,,total_seconds()} que retorna o número de segundos na duração. (Contribuição de Brian Quinlan; bpo-5788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5788}.)

@item 
Novo método: a classe @ref{29d,,Decimal} ganhou um método de classe @ref{1244,,from_float()} que realiza uma conversão exata de um número de ponto flutuante para um @code{Decimal}. Essa conversão exata busca a maior aproximação decimal do valor da representação de ponto flutuante; o valor decimal resultante ainda incluirá a imprecisão, se houver. Por exemplo, @code{Decimal.from_float(0.1)} retorna @code{Decimal('0.1000000000000000055511151231257827021181583404541015625')}. (Implementado por Raymond Hettinger; bpo-4796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4796}.)

Comparar instâncias de @ref{29d,,Decimal} com números de ponto flutuante agora produz resultados sensatos com base nos valores numéricos dos operandos. Anteriormente, essas comparações recorreriam às regras padrão do Python para comparar objetos, que produziam resultados arbitrários com base em seu tipo. Observe que você ainda não pode combinar @code{Decimal} e ponto flutuante em outras operações, como adição, já que você deve escolher explicitamente como converter entre float e @code{Decimal}. (Corrigido por Mark Dickinson; bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531}.)

O construtor para @ref{29d,,Decimal} agora aceita números de ponto flutuante (adicionados por Raymond Hettinger; bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}) e caracteres Unicode não europeus, como dígitos árabe-índicos (contribuição de Mark Dickinson; bpo-6595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6595}).

A maioria dos métodos da classe @ref{10ee,,Context} agora aceitam números inteiros, bem como instâncias @ref{29d,,Decimal}; as únicas exceções são os métodos @ref{134b,,canonical()} e @ref{134c,,is_canonical()}. (Patch de Juan José Conti; bpo-7633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7633}.)

Ao usar instâncias @ref{29d,,Decimal} com o método @ref{621,,format()} de uma string, o alinhamento padrão era anteriormente o alinhamento à esquerda. Isso foi alterado para alinhamento à direita, que é mais sensato para tipos numéricos. (Alteração de Mark Dickinson; bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857}.)

Comparações envolvendo um valor NaN de sinalização (ou @code{sNAN}) agora sinalizam @ref{10e7,,InvalidOperation} em vez de retornar silenciosamente um valor verdadeiro ou falso dependendo do operador de comparação. Valores silenciosos de NaN (ou @code{NaN}) agora são hasheáveis. (Corrigido por Mark Dickinson; bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279}.)

@item 
O módulo @ref{37,,difflib} agora produz uma saída que é mais compatível com as ferramentas @code{diff}/@code{patch} modernas através de uma pequena mudança, usando um caractere de tabulação em vez de espaços como separador no cabeçalho, fornecendo o nome do arquivo. (Correção de Anatoly Techtonik; bpo-7585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7585}.)

@item 
O comando Distutils @code{sdist} agora sempre regenera o arquivo @code{MANIFEST}, pois mesmo que os arquivos @code{MANIFEST.in} ou @code{setup.py} não tenham sido modificados, o usuário pode ter criado alguns novos arquivos que deveriam ser incluídos. (Correção de Tarek Ziadé; bpo-8688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8688}.)

@item 
O sinalizador @ref{134d,,IGNORE_EXCEPTION_DETAIL} do módulo @ref{3a,,doctest} irá agora ignorar o nome do módulo que contém a exceção que está sendo testada. (Patch de Lennart Regebro; bpo-7490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7490}.)

@item 
A classe @ref{27c,,Message} do módulo @ref{3b,,email} agora aceitará uma carga útil com valor Unicode, convertendo automaticamente a carga útil para a codificação especificada por @code{output_charset}. (Adição de R. David Murray; bpo-1368247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1368247}.)

@item 
A classe @ref{1e7,,Fraction} agora aceita uma única instância float ou @ref{29d,,Decimal}, ou dois números racionais, como argumentos para seu construtor. (Implementação de Mark Dickinson; racionais adicionados em bpo-5812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5812} e float/decimal em bpo-8294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8294}.)

Ordenar comparações (@code{<}, @code{<=}, @code{>}, @code{>=}) entre frações e números complexos agora levanta um @ref{2c3,,TypeError}. Isso corrige um descuido, fazendo com que @ref{1e7,,Fraction} corresponda aos outros tipos numéricos.

@c revision 79455

@item 
Nova classe: @ref{901,,FTP_TLS} no módulo @ref{5e,,ftplib} fornece conexões FTP seguras usando encapsulamento TLS de autenticação, bem como controle subsequente e transferências de dados. (Contribuição de Giampaolo Rodola; bpo-2054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2054}.)

O método @ref{134e,,storbinary()} para envios de binários agora pode reiniciar envios graças a um parâmetro `rest' adicionado (patch de Pablo Mouzo; bpo-6845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6845}.)

@item 
Novo decorador de classe: @ref{f75,,total_ordering()} no módulo @ref{5f,,functools} pega uma classe que define um método @ref{b0d,,__eq__()} e um de @ref{12e2,,__lt__()} , @ref{134f,,__le__()}, @ref{1350,,__gt__()} ou @ref{1351,,__ge__()} e gera os métodos de comparação ausentes. Como o método @code{__cmp__()} está sendo descontinuado no Python 3.x, esse decorador facilita a definição de classes ordenadas. (Adicionado por Raymond Hettinger; bpo-5479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5479}.)

Nova função: @ref{121a,,cmp_to_key()} usará uma função de comparação de estilo antigo que espera dois argumentos e retornará um novo chamável que pode ser usado como parâmetro `key' para funções como @ref{be7,,sorted()}, @ref{f3a,,min()} e @ref{f3b,,max()}, etc. O principal uso pretendido é ajudar a tornar o código compatível com Python 3.x. (Adição de Raymond Hettinger.)

@item 
Nova função: o @ref{1352,,is_tracked()} do módulo @ref{60,,gc} retorna verdadeiro se uma determinada instância for rastreada pelo coletor de lixo, falso caso contrário. (Contribuição de Antoine Pitrou; bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688})

@item 
O @ref{41a,,GzipFile} do módulo @ref{67,,gzip} agora oferece suporte ao protocolo de gerenciamento de contexto, então você pode escrever @code{with gzip.GzipFile(...) as f:} (contribuição de Hagen Fürstenau; bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}), e agora implementa o @ref{694,,io.BufferedIOBase} ABC, então você pode envolvê-lo com @ref{124e,,io.BufferedReader} para processamento mais rápido (contribuição de Nir Aides; bpo-7471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7471}). Agora também é possível substituir o horário de modificação registrado em um arquivo compactado, fornecendo um registro de data e hora opcional ao construtor. (Contribuição de Jacques Frechet; bpo-4272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4272}.)

Arquivos no formato gzip podem ser preenchidos com zero bytes à direita; o módulo @ref{67,,gzip} agora consumirá esses bytes finais. (Correção de Tadek Pietraszek e Brian Curtin; bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846}.)

@item 
Novo atributo: o módulo @ref{68,,hashlib} agora possui um atributo @code{algorithms} contendo uma tupla nomeando os algoritmos suportados. No Python 2.7, @code{hashlib.algorithms} contém @code{('md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512')}. (Contribuição de Carl Chenet; bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418}.)

@item 
A classe padrão @ref{110d,,HTTPResponse} usada pelo módulo @ref{6e,,httplib} agora oferece suporte a buffering, resultando em uma leitura muito mais rápida de respostas HTTP. (Contribuição de Kristján Valur Jónsson; bpo-4879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4879}.)

As classes @ref{b53,,HTTPConnection} e @ref{b54,,HTTPSConnection} agora oferecem suporte a um parâmetro `source_address', uma tupla de 2 elementos @code{(host, port)} fornecendo o endereço de origem que será usado para a conexão. (Contribuição de Eldon Ziegler; bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}.)

@item 
O módulo @code{ihooks} agora oferece suporte a importações relativas. Observe que @code{ihooks} é um módulo mais antigo para personalizar importações, substituído pelo módulo @code{imputil} adicionado no Python 2.0. (Suporte relativo à importação adicionado por Neil Schemenauer.)

@c revision 75423

@item 
O módulo @ref{74,,imaplib} agora oferece suporte a endereços IPv6. (Contribuição de Derek Morr; bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655}.)

@item 
Nova função: @ref{eed,,getcallargs()} do módulo @ref{7e,,inspect} pega um chamável e seus argumentos nomeados e posicionais, e descobre quais dos parâmetros do chamável receberão cada argumento, retornando um dicionário mapeando nomes de argumentos para seus valores. Por exemplo:

@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

Contribuição de George Sakkis; bpo-3135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3135}.

@item 
Módulo atualizado: A biblioteca @ref{7f,,io} foi atualizada para a versão fornecida com Python 3.1. Para 3.1, a biblioteca de E/S foi totalmente reescrita em C e é de 2 a 20 vezes mais rápida dependendo da tarefa que está sendo executada. A versão original do Python foi renomeada para o módulo @code{_pyio}.

Uma pequena mudança resultante: a classe @ref{695,,io.TextIOBase} agora tem um atributo @ref{1353,,errors} fornecendo a configuração de erro usada para erros de codificação e decodificação (um dos @code{'strict'} , @code{'replace'}, @code{'ignore'}).

A classe @ref{1354,,io.FileIO} agora levanta uma exceção @ref{417,,OSError} quando passa um descritor de arquivo inválido. (Implementado por Benjamin Peterson; bpo-4991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4991}.) O método @ref{1355,,truncate()} agora preserva a posição do arquivo; anteriormente, mudaria a posição do arquivo para o final do novo arquivo. (Correção de Pascal Chambon; bpo-6939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6939}.)

@item 
Nova função: @code{itertools.compress(data, selectors)} aceita dois iteradores. Elementos de `data' serão retornados se o valor correspondente em `selectors' for verdadeiro:

@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

Nova função: @code{itertools.combinations_with_replacement(iter, r)} retorna todas as combinações possíveis de elementos de comprimento `r' do `iter' iterável. Ao contrário de @ref{1356,,combinations()}, elementos individuais podem ser repetidos nas combinações geradas:

@example
itertools.combinations_with_replacement('abc', 2) =>
  ('a', 'a'), ('a', 'b'), ('a', 'c'),
  ('b', 'b'), ('b', 'c'), ('c', 'c')
@end example

Observe que os elementos são tratados como únicos dependendo de sua posição na entrada, não de seus valores reais.

A função @ref{12c5,,itertools.count()} agora tem um argumento `step' que permite incrementar por valores diferentes de 1. @ref{12c5,,count()} agora também permite argumentos nomeados e o uso de valores não inteiros, como floats ou @ref{29d,,Decimal} instâncias. (Implementação de Raymond Hettinger; bpo-5032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5032}.)

@ref{1356,,itertools.combinations()} e @ref{1357,,itertools.product()} anteriormente levantavam @ref{202,,ValueError} para valores de `r' maiores que o iterável de entrada. Isto foi considerado um erro de especificação, então agora elas retornam um iterador vazio. (Corrigido por Raymond Hettinger; bpo-4816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4816}.)

@item 
Módulo atualizado: O módulo @ref{82,,json} foi atualizado para a versão 2.0.9 do pacote simplejson, que inclui uma extensão C que torna a codificação e decodificação mais rápidas. (Contribuição de Bob Ippolito; bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136}.)

Para oferecer suporte ao novo tipo @ref{5db,,collections.OrderedDict}, @ref{cd4,,json.load()} agora tem um parâmetro opcional `object_pairs_hook' que será chamado com qualquer literal de objeto que decodifica para uma lista de pares. (Contribuição de Raymond Hettinger; bpo-5381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5381}.)

@item 
A classe @ref{41c,,Maildir} do módulo @ref{8b,,mailbox} agora registra o registro de data e hora nos diretórios que lê, e apenas os relê se o horário de modificação for alterado posteriormente. Isso melhora o desempenho, evitando varreduras de diretório desnecessárias. (Corrigido por AM Kuchling e 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 
Novas funções: o módulo @ref{8e,,math} ganhou @ref{bf3,,erf()} e @ref{bf4,,erfc()} para a função de erro e a função de erro complementar, @ref{122c,,expm1()} que calcula @code{e**x - 1} com mais precisão do que usar @ref{1358,,exp()} e subtrair 1, @ref{122d,,gamma()} para a função Gamma, e @ref{122e,,lgamma()} para o log natural da função Gamma. (Contribuição de Mark Dickinson e nirinA raseliarison; bpo-3366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3366}.)

@item 
As classes @code{Manager*} do módulo @ref{94,,multiprocessing} agora podem receber um chamável que será chamado sempre que um subprocesso for iniciado, junto com um conjunto de argumentos que serão passados para o chamável. (Contribuição de lekma; bpo-5585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5585}.)

A classe @ref{f9f,,Pool}, que controla um conjunto de processos de trabalho, agora possui um parâmetro opcional `maxtasksperchild'. Os processos de trabalho executarão o número especificado de tarefas e então sairão, fazendo com que @code{Pool} inicie um novo trabalhador. Isso é útil se as tarefas puderem vazar memória ou outros recursos, ou se algumas tarefas fizerem com que o trabalho fique muito grande. (Contribuição de Charles Cazabon; bpo-6963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6963}.)

@item 
O módulo @code{nntplib} agora oferece suporte para endereços IPv6. (Contribuição de Derek Morr; bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664}.)

@item 
Novas funções: o módulo @ref{a1,,os} envolve as seguintes chamadas de sistema POSIX: @ref{1359,,getresgid()} e @ref{135a,,getresuid()}, que retornam os GIDs e UIDs reais, efetivos e salvos ; @ref{135b,,setresgid()} e @ref{135c,,setresuid()}, que definem GIDs e UIDs reais, efetivos e salvos para novos valores; @ref{135d,,initgroups()}, que inicializa a lista de acesso do grupo para o processo atual. (Funções GID/UID foram contribuição de Travis H.; bpo-6508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6508}. Suporte para initgroups adicionado por Jean-Paul Calderone; bpo-7333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7333}.)

A função @ref{197,,os.fork()} agora reinicializa a trava de importação no processo filho; isso corrige problemas no Solaris quando @ref{197,,fork()} é chamado de um thread. (Correção de Zsolt Cserna; bpo-7242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7242}.)

@item 
No módulo @ref{a2,,os.path}, as funções @ref{135e,,normpath()} e @ref{135f,,abspath()} agora preservam o Unicode; se o caminho de entrada for uma string Unicode, o valor de retorno também será uma string Unicode. (@ref{135e,,normpath()} corrigido por Matt Giuca em bpo-5827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5827}; @ref{135f,,abspath()} corrigido por Ezio Melotti em bpo-3426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3426}.)

@item 
O módulo @ref{b5,,pydoc} agora tem ajuda para os vários símbolos que o Python usa. Agora você pode fazer @code{help('<<')} ou @code{help('@@')}, por exemplo. (Contribuição de David Laban; bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739}.)

@item 
Os módulos @ref{b9,,re} @ref{2a2,,split()}, @ref{2a3,,sub()} e @ref{2a4,,subn()} agora aceitam um argumento opcional `flags', para consistência com as outras funções do módulo. (Adição de Gregory P. Smith.)

@item 
Nova função: @ref{181,,run_path()} no módulo @ref{be,,runpy} executará o código em um argumento `path' fornecido. `path' pode ser o caminho de um arquivo fonte Python (@code{example.py}), um arquivo de bytecode compilado (@code{example.pyc}), um diretório (@code{./package/}) ou um arquivo zip (@code{example.zip}). Se um diretório ou zip path for fornecido, ele será adicionado na frente de @code{sys.path} e o módulo @ref{1,,__main__} será importado. É esperado que o diretório ou zip contenha um @code{__main__.py}; caso contrário, algum outro @code{__main__.py} poderá ser importado de um local posteriormente em @code{sys.path}. Isso torna mais o maquinário de @ref{be,,runpy} disponível para scripts que desejam imitar a maneira como a linha de comando do Python processa um nome de caminho explícito. (Adição de Nick Coghlan; bpo-6816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6816}.)

@item 
Nova função: no módulo @ref{c5,,shutil}, @ref{4b3,,make_archive()} pega um nome de arquivo, tipo de arquivo (formato zip ou tar) e um caminho de diretório, e cria um arquivo contendo o conteúdo do diretório. (Adição de Tarek Ziadé.)

As funções @ref{a63,,copyfile()} e @ref{a33,,copytree()} de @ref{c5,,shutil} agora levantam uma exceção @ref{1360,,SpecialFileError} quando solicitado a copiar um encadeamento nomeado. Anteriormente, o código trataria pipes nomeados como um arquivo normal, abrindo-os para leitura, e isso seria bloqueado indefinidamente. (Correção de Antoine Pitrou; bpo-3002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3002}.)

@item 
O módulo @ref{c6,,signal} não reinstala mais o manipulador de sinal a menos que isso seja realmente necessário, o que corrige um bug que poderia tornar impossível capturar o sinal EINTR de forma robusta. (Correção de Charles-François Natali; bpo-8354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8354}.)

@item 
Novas funções: no módulo @ref{c7,,site}, três novas funções retornam vários caminhos específicos do site e do usuário. @ref{127f,,getsitepackages()} retorna uma lista contendo todos os diretórios globais de pacotes de sites, @ref{1281,,getusersitepackages()} retorna o caminho do diretório de pacotes de sites do usuário e @ref{1280,,getuserbase()} retorna o valor da variável de ambiente @ref{1361,,USER_BASE}, fornecendo o caminho para um diretório que pode ser usado para armazenar dados. (Contribuição de Tarek Ziadé; bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693}.)

O módulo @ref{c7,,site} agora reporta exceções que ocorrem quando o módulo @ref{c8,,sitecustomize} é importado, e não irá mais capturar e engolir a exceção @ref{9d9,,KeyboardInterrupt}. (Correção de Victor Stinner; bpo-3137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3137}.)

@item 
A função @ref{672,,create_connection()} ganhou um parâmetro `source_address', uma tupla de 2 elementos @code{(host, port)} fornecendo o endereço de origem que será usado para a conexão. (Contribuição de Eldon Ziegler; bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}.)

Os métodos @ref{1362,,recv_into()} e @ref{1363,,recvfrom_into()} agora escreverão em objetos que oferecem suporte à API de buffer, mais utilmente objetos @ref{2ea,,bytearray} e @ref{2eb,,memoryview}. (Implementação de Antoine Pitrou; bpo-8104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8104}.)

@item 
A classe @ref{1364,,TCPServer} do módulo @ref{cd,,SocketServer} agora oferece suporte a limite de tempo de soquete e desativação do algoritmo Nagle. O atributo de classe @code{disable_nagle_algorithm} é padronizado como @code{False}; se substituído como verdadeiro, novas conexões de solicitação terão a opção TCP_NODELAY definida para evitar o armazenamento em buffer de muitos envios pequenos em um único pacote TCP. O atributo de classe @ref{1365,,timeout} pode conter um tempo limite em segundos que será aplicado ao soquete de solicitação; se nenhuma solicitação for recebida dentro desse tempo, @ref{1366,,handle_timeout()} será chamado e @ref{1367,,handle_request()} retornará. (Contribuição de Kristján Valur Jónsson; bpo-6192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6192} e bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}.)

@item 
Módulo atualizado: o módulo @ref{cf,,sqlite3} foi atualizado para a versão 2.6.0 do pacote pysqlite@footnote{https://github.com/ghaering/pysqlite}. A versão 2.6.0 inclui uma série de correções de bugs e adiciona a capacidade de carregar extensões SQLite de bibliotecas compartilhadas. Chame o método @code{enable_load_extension(True)} para habilitar extensões, e então chame @ref{4b8,,load_extension()} para carregar uma biblioteca compartilhada específica. (Atualização de Gerhard Häring.)

@item 
Os objetos @ref{8f0,,SSLSocket} do módulo @ref{d0,,ssl} agora oferecem suporte à API de buffer, que corrigiu uma falha no conjunto de testes (correção por Antoine Pitrou; bpo-7133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7133}) e definiu automaticamente o @code{SSL_MODE_AUTO_RETRY} do OpenSSL, o que impedirá que um código de erro seja retornado de operações @code{recv()} que acionam uma renegociação SSL (correção por Antoine Pitrou; bpo-8222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8222}).

A função construtora @ref{525,,wrap_socket()} agora recebe um argumento `ciphers' que é uma string listando os algoritmos de criptografia a serem permitidos; o formato da string é descrito na documentação do OpenSSL@footnote{https://docs.openssl.org/1.0.2/man1/ciphers/}. (Adição de Antoine Pitrou; bpo-8322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8322}.)

Outra mudança faz com que a extensão carregue todas as cifras e algoritmos de resumo do OpenSSL para que estejam todos disponíveis. Não foi possível verificar alguns certificados SSL, reportando um erro de “algoritmo desconhecido”. (Relato de Beda Kosata e correção de Antoine Pitrou; bpo-8484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8484}.)

A versão do OpenSSL usada agora está disponível como os atributos do módulo @ref{125f,,ssl.OPENSSL_VERSION} (uma string), @ref{1260,,ssl.OPENSSL_VERSION_INFO} (uma tupla de 5) e @ref{1261,,ssl.OPENSSL_VERSION_NUMBER} (um número inteiro). (Adição de Antoine Pitrou; bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321}.)

@item 
O módulo @ref{d5,,struct} não irá mais ignorar silenciosamente erros de overflow quando um valor for muito grande para um código de formato inteiro específico (um de @code{bBhHiIlLqQ}); agora sempre levanta uma exceção @ref{1368,,struct.error}. (Alteração de Mark Dickinson; bpo-1523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1523}.) A função @ref{12b8,,pack()} também tentará usar @ref{71d,,__index__()} para converter e empacotar números não inteiros antes de tentar o método @ref{71c,,__int__()} ou relatar um erro. (Alteração de Mark Dickinson; bpo-8300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8300}.)

@item 
Nova função: o @ref{ff6,,check_output()} do módulo @ref{d6,,subprocess} executa um comando com um conjunto especificado de argumentos e retorna a saída do comando como uma string quando o comando é executado sem erros, ou levanta uma exceção @ref{1369,,CalledProcessError} caso contrário.

@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

(Contribuição de Gregory P. Smith.)

O módulo @ref{d6,,subprocess} agora tentará novamente suas chamadas internas do sistema ao receber um sinal @ref{daf,,EINTR}. (Relato por várias pessoas; patch final por Gregory P. Smith em bpo-1068268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1068268}.)

@item 
Nova função: @ref{136a,,is_declared_global()} no módulo @ref{d8,,symtable} retorna verdadeiro para variáveis que são explicitamente declaradas como globais, falso para aquelas que são implicitamente globais. (Contribuição de Jeremy Hylton.)

@item 
O módulo @ref{dc,,syslog} agora usará o valor de @code{sys.argv[0]} como identificador em vez do valor padrão anterior de @code{'python'}. (Alteração de Sean Reifschneider; bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}.)

@item 
O valor @ref{6a0,,sys.version_info} agora é uma tupla nomeada, com atributos chamados @code{major}, @code{minor}, @code{micro}, @code{releaselevel} e @code{serial}. (Contribuição de Ross Light; bpo-4285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4285}.)

@ref{d08,,sys.getwindowsversion()} também retorna uma tupla nomeada, com atributos chamados @code{major}, @code{minor}, @code{build}, @code{platform}, @code{service_pack}, @code{service_pack_major}, @code{service_pack_minor}, @code{suite_mask} e @code{product_type}. (Contribuição de Brian Curtin; bpo-7766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7766}.)

@item 
O tratamento de erros padrão do módulo @ref{de,,tarfile} foi alterado, para não mais suprimir erros fatais. O nível de erro padrão era anteriormente 0, o que significava que os erros resultariam apenas na gravação de uma mensagem no log de depuração, mas como o log de depuração não está ativado por padrão, esses erros passam despercebidos. O nível de erro padrão agora é 1, o que levanta uma exceção se houver um erro. (Alteração de Lars Gustäbel; bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}.)

@ref{de,,tarfile} agora oferece suporte à filtragem de objetos @ref{1251,,TarInfo} sendo adicionados a um arquivo tar. Quando você chama @ref{c0e,,add()}, você pode fornecer um argumento `filter' opcional que é chamável. O chamável `filter' receberá o @ref{1251,,TarInfo} para cada arquivo sendo adicionado, e pode modificá-lo e retorná-lo. Se o chamável retornar @code{None}, o arquivo será excluído do arquivo resultante. Isto é mais poderoso do que o argumento `exclude' existente, que foi, portanto, descontinuado. (Adição de Lars Gustäbel; bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856}.) A classe @ref{1250,,TarFile} agora também oferece suporte ao protocolo de gerenciamento de contexto. (Adição de Lars Gustäbel; bpo-7232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7232}.)

@item 
O método @ref{136b,,wait()} da classe @ref{1197,,threading.Event} agora retorna o sinalizador interno na saída. Isso significa que o método geralmente retornará verdadeiro porque @ref{136b,,wait()} deve ser bloqueado até que o sinalizador interno se torne verdadeiro. O valor de retorno só será falso se um tempo limite tiver sido fornecido e a operação tiver expirado. (Contribuição de Tim Lesher; bpo-1674032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1674032}.)

@item 
O banco de dados Unicode fornecido pelo módulo @ref{105,,unicodedata} agora é usado internamente para determinar quais caracteres são numéricos, espaços em branco ou representam quebras de linha. O banco de dados também inclui informações do arquivo de dados @code{Unihan.txt} (patch de Anders Chrigström e Amaury Forgeot d’Arc; bpo-1571184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1571184}) e foi atualizado para a versão 5.2.0 (atualização de Florent Xicluna; bpo-8024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8024}).

@item 
A função @ref{d61,,urlsplit()} do módulo @ref{10a,,urlparse} agora lida com esquemas de URL desconhecidos de uma forma compatível com 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}: se a URL estiver no formato @code{"<alguma_coisa>://..."}, o texto antes de @code{://} é tratado como o esquema, mesmo que seja um esquema inventado que o módulo não conhece. Essa alteração pode quebrar o código que contornava o comportamento antigo. Por exemplo, Python 2.6.4 ou 2.5 retornará o seguinte:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7 (e Python 2.6.5) vai retornar:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

(Na verdade, o Python 2.7 produz uma saída ligeiramente diferente, pois retorna uma tupla nomeada em vez de uma tupla padrão.)

O módulo @ref{10a,,urlparse} também oferece suporte a endereços IPv6 literais conforme definido pelo 
@geindex RFC; RFC 2732
RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} (contribuição de 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 
Nova classe: a classe @ref{5dd,,WeakSet} no módulo @ref{114,,weakref} é um conjunto que contém apenas referências fracas aos seus elementos; os elementos serão removidos quando não houver referências apontando para eles. (Originalmente implementado em Python 3.x por Raymond Hettinger e portado para 2.7 por Michael Foord.)

@item 
A biblioteca @ref{125,,xml.etree.ElementTree} não escapa mais caracteres de E comercial e de sinal de maior e de menor ao gerar uma instrução de processamento XML (que se parece com @code{<?xml-stylesheet href="#style1"?>}) ou comentário (que se parece com @code{<!-- comentário -->}). (Patch de Neil Muller; bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}.)

@item 
O cliente e servidor de XML-RPC, fornecidos pelos módulos @ref{12e,,xmlrpclib} e @ref{12f,,SimpleXMLRPCServer}, melhoraram o desempenho ao prover suporte a kep-alive do HTTP/1.1 e, opcionalmente, usando a codificação gzip para compactar o XML que está sendo trocado. A compactação gzip é controlada pelo atributo @code{encode_threshold} de @ref{136c,,SimpleXMLRPCRequestHandler}, que contém um tamanho em bytes; respostas maiores que isso serão compactadas. (Contribuição de Kristján Valur Jónsson; bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}.)

@item 
A classe @ref{6c4,,ZipFile} do módulo @ref{131,,zipfile} agora oferece suporte ao protocolo de gerenciamento de contexto, então você pode escrever @code{with zipfile.ZipFile(...) as f:}. (Contribuição de Brian Curtin; bpo-5511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5511}.)

@ref{131,,zipfile} agora também oferece suporte ao arquivamento de diretórios vazios e os extrai corretamente. (Correção de Kuba Wieczorek; bpo-4710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4710}.) Ler arquivos de um arquivo é mais rápido e intercalar @ref{136d,,read()} e @code{readline()} agora funciona corretamente. (Contribuição de Nir Aides; bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610}.)

A função @ref{136e,,is_zipfile()} agora aceita um objeto arquivo, além dos nomes de caminho aceitos em versões anteriores. (Contribuição de Gabriel Genellina; bpo-4756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4756}.)

O método @ref{136f,,writestr()} agora tem um parâmetro `compress_type' opcional que permite substituir o método de compactação padrão especificado no construtor de @ref{6c4,,ZipFile}. (Contribuição 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
* Novo módulo; importlib: Novo módulo importlib. 
* Novo módulo; sysconfig: Novo módulo sysconfig. 
* ttk; Widgets temáticos para Tk: ttk Widgets temáticos para Tk. 
* Módulo atualizado; unittest: Módulo atualizado unittest. 
* Módulo atualizado; ElementTree 1.3: Módulo atualizado ElementTree 1 3. 

@end menu

@node Novo módulo importlib,Novo módulo sysconfig,,Módulos Novos ou Aprimorados
@anchor{whatsnew/2 7 importlib-section}@anchor{132f}@anchor{whatsnew/2 7 new-module-importlib}@anchor{1370}
@subsubsection Novo módulo: importlib


Python 3.1 inclui o pacote @ref{77,,importlib}, uma reimplementação da lógica subjacente à instrução @ref{5e2,,import} do Python. @ref{77,,importlib} é útil para implementadores de interpretadores Python e para usuários que desejam escrever novos importadores que possam participar do processo de importação. Python 2.7 não contém o pacote @ref{77,,importlib} completo, mas em vez disso possui um pequeno subconjunto que contém uma única função, @ref{518,,import_module()}.

@code{import_module(name, package=None)} importa um módulo. `name' é uma string contendo o nome do módulo ou pacote. É possível fazer importações relativas fornecendo uma string que começa com um caractere @code{.}, como @code{..utils.errors}. Para importações relativas, o argumento `package' deve ser fornecido e é o nome do pacote que será usado como âncora para a importação relativa. @ref{518,,import_module()} insere o módulo importado em @code{sys.modules} e retorna o objeto do módulo.

Veja alguns exemplos:

@example
>>> from importlib import import_module
>>> anydbm = import_module('anydbm')  # Importação absoluta padrão
>>> anydbm
<module 'anydbm' from '/p/python/Lib/anydbm.py'>
>>> # Importação relativa
>>> 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} foi implementado por Brett Cannon e introduzido no Python 3.1.

@node Novo módulo sysconfig,ttk Widgets temáticos para Tk,Novo módulo importlib,Módulos Novos ou Aprimorados
@anchor{whatsnew/2 7 new-module-sysconfig}@anchor{1371}
@subsubsection Novo módulo: sysconfig


O módulo @ref{db,,sysconfig} foi retirado do pacote Distutils, tornando-se um novo módulo de nível independente. @ref{db,,sysconfig} fornece funções para obter informações sobre o processo de construção do Python: opções do compilador, caminhos de instalação, o nome da plataforma e se o Python está sendo executado a partir de seu diretório de código-fonte.

Algumas das funções do módulo são:


@itemize *

@item 
@ref{1063,,get_config_var()} retorna variáveis do Makefile do Python e do arquivo @code{pyconfig.h}.

@item 
@ref{1064,,get_config_vars()} retorna um dicionário contendo todas as variáveis de configuração.

@item 
@ref{1372,,get_path()} retorna o caminho configurado para um tipo específico de módulo: a biblioteca padrão, módulos específicos do site, módulos específicos da plataforma, etc.

@item 
@ref{2dd,,is_python_build()} retorna verdadeiro se você estiver executando um binário de uma árvore de código-fonte em Python, e falso caso contrário.
@end itemize

Consulte a documentação do @ref{db,,sysconfig} para mais detalhes e para uma lista completa de funções.

O pacote Distutils e @ref{db,,sysconfig} agora são mantidos por Tarek Ziadé, que também iniciou um pacote Distutils2 (repositório fonte em @indicateurl{https://hg.python.org/distutils2/}) para desenvolver uma versão de próxima geração do Distutils.

@node ttk Widgets temáticos para Tk,Módulo atualizado unittest,Novo módulo sysconfig,Módulos Novos ou Aprimorados
@anchor{whatsnew/2 7 ttk-themed-widgets-for-tk}@anchor{1373}
@subsubsection ttk: Widgets temáticos para Tk


O Tcl/Tk 8.5 inclui um conjunto de widgets temáticos que reimplementam widgets Tk básicos, mas têm uma aparência mais personalizável e podem, portanto, se assemelhar mais aos widgets da plataforma nativa. Este conjunto de widgets foi originalmente chamado de Tile, mas foi renomeado para Ttk (para “Tk temático”) ao ser adicionado ao Tcl/Tck versão 8.5.

Para saber mais, leia a documentação do módulo @ref{f9,,ttk}. Você também pode ler a página de manual do Tcl/Tk que descreve o mecanismo do tema Ttk, disponível em @indicateurl{https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.html}. Algumas capturas de tela do código Python/Ttk em uso estão em @indicateurl{https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki}.

O módulo @ref{f9,,tkinter.ttk} foi escrito por Guilherme Polo e adicionado em bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983}. Uma versão alternativa chamada @code{Tile.py}, escrita por Martin Franklin e mantida por Kevin Walzer, foi proposta para inclusão em bpo-2618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2618}, mas os autores argumentaram que o trabalho de Guilherme Polo era mais abrangente.

@node Módulo atualizado unittest,Módulo atualizado ElementTree 1 3,ttk Widgets temáticos para Tk,Módulos Novos ou Aprimorados
@anchor{whatsnew/2 7 unittest-section}@anchor{1374}@anchor{whatsnew/2 7 updated-module-unittest}@anchor{1375}
@subsubsection Módulo atualizado: unittest


O módulo @ref{106,,unittest} foi bastante aprimorado; muitos novos recursos foram adicionados. A maioria desses recursos foi implementada por Michael Foord, salvo indicação em contrário. A versão aprimorada do módulo pode ser baixada separadamente para uso com as versões 2.4 a 2.6 do Python, empacotadas como o pacote @code{unittest2}, de unittest2@footnote{https://pypi.org/project/unittest2/}.

Quando usado na linha de comando, o módulo pode descobrir testes automaticamente. Não é tão sofisticado quanto py.test@footnote{https://pytest.org} ou nose@footnote{https://nose.readthedocs.io/}, mas fornece uma maneira simples de executar testes mantidos dentro de um conjunto de diretórios de pacotes. Por exemplo, o comando a seguir irá pesquisar no subdiretório @code{test/} por quaisquer arquivos de teste importáveis chamados @code{test*.py}:

@example
python -m unittest discover -s test
@end example

Consulte a documentação do módulo @ref{106,,unittest} para mais detalhes. (Desenvolvido em bpo-6001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6001}.)

A função @ref{1019,,main()} oferece suporte a algumas outras novas opções:


@itemize *

@item 
@ref{1376,,-b} ou @code{--buffer} armazenará em buffer a saída padrão e os fluxos de erro padrão durante cada teste. Se o teste for aprovado, qualquer saída resultante será descartada; em caso de falha, a saída em buffer será exibida.

@item 
@ref{1377,,-c} ou @code{--catch} fará com que a interrupção control-C seja tratada com mais elegância. Em vez de interromper imediatamente o processo de teste, o teste em execução será concluído e então os resultados parciais até a interrupção serão relatados. Se você estiver impaciente, um segundo toque no controle C causará uma interrupção imediata.

Este manipulador de control-C tenta evitar causar problemas quando o código que está sendo testado ou os testes em execução definiram um manipulador de sinal próprio, percebendo que um manipulador de sinal já estava definido e chamando-o. Se isso não funcionar para você, existe um decorador @ref{1378,,removeHandler()} que pode ser usado para marcar testes que devem ter o manuseio de control-C desabilitado.

@item 
@ref{1379,,-f} ou @code{--failfast} faz com que a execução do teste pare imediatamente quando um teste falha, em vez de continuar a executar testes adicionais. (Sugerido por Cliff Dyer e implementado por Michael Foord; bpo-8074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8074}.)
@end itemize

As mensagens de progresso agora mostram ‘x’ para falhas esperadas e ‘u’ para sucessos inesperados quando executadas em modo detalhado. (Contribuição de Benjamin Peterson.)

Os casos de teste podem levantar a exceção @ref{101a,,SkipTest} para pular um teste (bpo-1034053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1034053}).

As mensagens de erro para falhas @ref{529,,assertEqual()}, @ref{527,,assertTrue()} e @ref{528,,assertFalse()} agora fornecem mais informações. Se você definir o atributo @ref{137a,,longMessage} de suas classes @ref{44f,,TestCase} como true, tanto a mensagem de erro padrão quanto qualquer mensagem adicional que você fornecer serão impressas para falhas. (Adição de Michael Foord; bpo-5663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5663}.)

O método @ref{52d,,assertRaises()} agora retorna um manipulador de contexto quando chamado sem fornecer um objeto chamável para ser executado. Por exemplo, você pode escrever isto:

@example
with self.assertRaises(KeyError):
    @{@}['foo']
@end example

(implementação de Antoine Pitrou; bpo-4444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4444}.)

@c rev 78774

Correções de desmontagem e configuração em nível de módulo e classe agora são suportados. Os módulos podem conter funções @ref{a57,,setUpModule()} e @ref{137b,,tearDownModule()}. As classes podem ter métodos @ref{a58,,setUpClass()} e @ref{137c,,tearDownClass()} que devem ser definidos como métodos de classe (usando @code{@@classmethod} ou equivalente). Essas funções e métodos são invocados quando o executor de teste alterna para um caso de teste em um módulo ou classe diferente.

Os métodos @ref{a8b,,addCleanup()} e @ref{137d,,doCleanups()} foram adicionados. @ref{a8b,,addCleanup()} permite adicionar funções de limpeza que serão chamadas incondicionalmente (após @ref{137e,,setUp()} se @ref{137e,,setUp()} falhar, caso contrário, após @ref{137f,,tearDown()}). Isso permite uma alocação e desalocação de recursos muito mais simples durante os testes (bpo-5679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5679}).

Foram adicionados vários novos métodos que fornecem testes mais especializados. Muitos desses métodos foram escritos por engenheiros do Google para uso em seus conjuntos de testes; Gregory P. Smith, Michael Foord e GvR trabalharam na fusão deles na versão Python de @ref{106,,unittest}.


@itemize *

@item 
@ref{12cc,,assertIsNone()} e @ref{12cd,,assertIsNotNone()} pegam uma expressão e verificam se o resultado é ou não @code{None}.

@item 
@ref{1380,,assertIs()} e @ref{1381,,assertIsNot()} pegam dois valores e verificam se os dois valores são avaliados como o mesmo objeto ou não. (Adicionado por Michael Foord; bpo-2578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2578}.)

@item 
@ref{1382,,assertIsInstance()} e @ref{1383,,assertNotIsInstance()} verificam se o objeto resultante é uma instância de uma classe específica ou de uma tupla de classes. (Adicionado por Georg Brandl; bpo-7031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7031}.)

@item 
@ref{1384,,assertGreater()}, @ref{1385,,assertGreaterEqual()}, @ref{1386,,assertLess()}, e @ref{1387,,assertLessEqual()} comparam duas quantidades.

@item 
@ref{1388,,assertMultiLineEqual()} compara duas strings e, se não forem iguais, exibe uma comparação útil que destaca as diferenças nas duas strings. Esta comparação agora é usada por padrão quando strings Unicode são comparadas com @ref{529,,assertEqual()}.

@item 
@ref{52e,,assertRegexpMatches()} e @ref{530,,assertNotRegexpMatches()} verificam se o primeiro argumento é uma string que corresponde ou não à expressão regular fornecida como o segundo argumento (bpo-8038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8038}).

@item 
@ref{52f,,assertRaisesRegexp()} verifica se uma exceção específica foi levantada e também verifica se a representação da string da exceção corresponde à expressão regular fornecida.

@item 
@ref{1389,,assertIn()} e @ref{138a,,assertNotIn()} testa se `primeiro' está ou não em `segundo'.

@item 
@ref{126b,,assertItemsEqual()} testa se duas sequências fornecidas contêm os mesmos elementos.

@item 
@ref{12c7,,assertSetEqual()} compara se dois conjuntos são iguais e apenas relata as diferenças entre os conjuntos em caso de erro.

@item 
Da mesma forma, @ref{12c9,,assertListEqual()} e @ref{12ca,,assertTupleEqual()} comparam os tipos especificados e explicam quaisquer diferenças sem necessariamente imprimir seus valores completos; esses métodos agora são usados por padrão ao comparar listas e tuplas usando @ref{529,,assertEqual()}. De forma mais geral, @ref{12cb,,assertSequenceEqual()} compara duas sequências e pode opcionalmente verificar se ambas as sequências são de um tipo específico.

@item 
@ref{12c8,,assertDictEqual()} compara dois dicionários e relata as diferenças; agora é usado por padrão quando você compara dois dicionários usando @ref{529,,assertEqual()}. @code{assertDictContainsSubset()} verifica se todos os pares chave/valor em `first' são encontrados em `second'.

@item 
@ref{52b,,assertAlmostEqual()} e @ref{52c,,assertNotAlmostEqual()} testam se `first' e `second' são aproximadamente iguais. Este método pode arredondar a diferença para um número opcionalmente especificado de `places' (o padrão é 7) e compará-lo com zero, ou exigir que a diferença seja menor que um valor `delta' fornecido.

@item 
@ref{138b,,loadTestsFromName()} respeita corretamente o atributo @ref{138c,,suiteClass} do @ref{28e,,TestLoader}. (Correção de Mark Roddy; bpo-6866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6866}.)

@item 
Um novo gancho permite estender o método @ref{529,,assertEqual()} para lidar com novos tipos de dados. O método @ref{138d,,addTypeEqualityFunc()} leva um objeto de tipo e uma função. A função será usada quando ambos os objetos comparados forem do tipo especificado. Esta função deve comparar os dois objetos e gerar uma exceção se eles não corresponderem; é uma boa ideia que a função forneça informações adicionais sobre por que os dois objetos não correspondem, assim como fazem os novos métodos de comparação de sequências.
@end itemize

@ref{1019,,unittest.main()} agora recebe um argumento @code{exit} opcional.  Se for falso, @ref{1019,,main()} não chama @ref{138e,,sys.exit()}, permitindo que @ref{1019,,main()} seja usado a partir do interpretador interativo.  (Contribuição de J. Pablo Fernández; bpo-3379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3379}.)

@ref{11a6,,TestResult} tem novos métodos @ref{138f,,startTestRun()} e @ref{1390,,stopTestRun()} que são chamados imediatamente antes e depois de uma execução de teste. (Contribuição de Robert Collins; bpo-5728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5728}.)

Com todas essas mudanças, o @code{unittest.py} estava ficando estranhamente grande, então o módulo foi transformado em um pacote e o código dividido em vários arquivos (por Benjamin Peterson). Isso não afeta como o módulo é importado ou usado.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://web.archive.org/web/20210619163128/http://www.voidspace.org.uk/python/articles/unittest2.shtml}

Descreve os novos recursos, como usá-los e a justificativa para diversas decisões de design. (Por Michael Foord.)
@end table


@node Módulo atualizado ElementTree 1 3,,Módulo atualizado unittest,Módulos Novos ou Aprimorados
@anchor{whatsnew/2 7 elementtree-section}@anchor{1391}@anchor{whatsnew/2 7 updated-module-elementtree-1-3}@anchor{1392}
@subsubsection Módulo atualizado: ElementTree 1.3


A versão da biblioteca ElementTree incluída no Python foi atualizada para a versão 1.3. Alguns dos novos recursos são:


@itemize *

@item 
As várias funções de análise agora recebem um argumento nomeado `parser' fornecendo uma instância @ref{a5e,,XMLParser} que será usada. Isso torna possível substituir a codificação interna do arquivo:

@example
p = ET.XMLParser(encoding='utf-8')
t = ET.XML("""<root/>""", parser=p)
@end example

Erros na análise de XML agora levantam uma exceção @ref{12b9,,ParseError}, cujas instâncias possuem um atributo @code{position} contendo uma tupla (`linha', `coluna') fornecendo a localização do problema.

@item 
O código do ElementTree para converter árvores em strings foi significativamente reformulado, tornando-o quase duas vezes mais rápido em muitos casos. Os métodos @ref{aa4,,ElementTree.write()} e @code{Element.write()} agora têm um parâmetro `method' que pode ser “xml” (o padrão), “html” ou “text”. O modo HTML exibirá elementos vazios como @code{<empty></empty>} em vez de @code{<empty/>}, e o modo texto ignorará os elementos e exibirá apenas os blocos de texto. Se você definir o atributo @ref{1393,,tag} de um elemento como @code{None}, mas deixar seus filhos no lugar, o elemento será omitido quando a árvore for gravada, portanto, não será necessário fazer uma reorganização mais extensa para remover um único elemento.

O tratamento de espaços de nomes também foi aprimorado. Todas as declarações @code{xmlns:<alguma-coisa>} agora são geradas no elemento raiz, e não espalhadas pelo XML resultante. Você pode definir o espaço de nomes padrão para uma árvore definindo o atributo @code{default_namespace} e registrar novos prefixos com @ref{1212,,register_namespace()}. No modo XML, você pode usar o parâmetro true/false `xml_declaration' para suprimir a declaração XML.

@item 
Novo método @ref{310,,Element}: @ref{1213,,extend()} anexa os itens de uma sequência aos filhos do elemento. Os próprios elementos se comportam como sequências, por isso é fácil mover os filhos de um elemento para outro:

@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 
Novo método @ref{310,,Element}: @ref{1394,,iter()} produz os filhos do elemento como um gerador. Também é possível escrever @code{for child in elem:} para percorrer os filhos de um elemento. O método existente @code{getiterator()} agora está descontinuado, assim como @code{getchildren()} que constrói e retorna uma lista de filhos.

@item 
Novo método @ref{310,,Element}: @ref{1215,,itertext()} produz todos os pedaços de texto que são descendentes do elemento. Por exemplo:

@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 
Descontinuado: usar um elemento como booleano (ou seja, @code{if elem:}) retornaria verdadeiro se o elemento tivesse algum filho, ou falso se não houvesse nenhum filho. Este comportamento é confuso – @code{None} é falso, mas um elemento sem filhos também o é? – então agora irá acionar um @ref{415,,FutureWarning}. Em seu código, você deve ser explícito: escreva @code{len(elem) != 0} se estiver interessado no número de filhos, ou @code{elem is not None}.
@end itemize

Fredrik Lundh desenvolve ElementTree e produziu a versão 1.3; você pode ler o artigo dele descrevendo 1.3 em @indicateurl{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm}. Florent Xicluna atualizou a versão incluída no Python, após discussões em python-dev e em bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472}.)

@c ======================================================================

@node Mudanças a construções e API C<8>,Outras alterações e correções,Módulos Novos ou Aprimorados,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 build-and-c-api-changes}@anchor{1395}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
O uso da versão mais recente do GNU Debugger, GDB 7, pode ser programado usando Python@footnote{https://web.archive.org/web/20110715084810/http://sourceware.org/gdb/current/onlinedocs/gdb/Python.html}. Quando você começa a depurar um programa executável P, o GDB irá procurar por um arquivo chamado @code{P-gdb.py} e lê-lo automaticamente. Dave Malcolm contribuiu com um @code{python-gdb.py} que adiciona vários comandos úteis ao depurar o próprio Python. Por exemplo, @code{py-up} e @code{py-down} sobem ou descem um quadro de pilha Python, que geralmente corresponde a vários quadros de pilha C. @code{py-print} imprime o valor de uma variável Python e @code{py-bt} imprime o stack trace do Python. (Adicionado como resultado de bpo-8032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8032}.)

@item 
Se você usar o arquivo @code{.gdbinit} fornecido com Python, a macro “pyo” na versão 2.7 agora funciona corretamente quando o thread que está sendo depurado não contém a GIL; a macro agora a adquire antes de imprimir. (Contribuição de Victor Stinner; bpo-3632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3632}.)

@item 
@ref{988,,Py_AddPendingCall()} agora é segura para thread, permitindo que qualquer thread de trabalho envie notificações para o thread principal do Python. Isto é particularmente útil para operações de E/S assíncronas. (Contribuição de Kristján Valur Jónsson; bpo-4293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4293}.)

@item 
Nova função: @ref{1396,,PyCode_NewEmpty()} cria um objeto código vazio; apenas o nome do arquivo, o nome da função e o número da primeira linha são necessários. Isto é útil para módulos de extensão que estão tentando construir uma pilha de traceback mais útil. Anteriormente, essas extensões precisavam chamar @code{PyCode_New()}, que tinha muito mais argumentos. (Adição de Jeffrey Yasskin.)

@item 
Nova função: @ref{12aa,,PyErr_NewExceptionWithDoc()} cria uma nova classe de exceção, assim como a @ref{12ab,,PyErr_NewException()} existente faz, mas recebe um argumento @code{char *} extra contendo a docstring para a nova classe de exceção . (Adição de ‘lekma’ no rastreador de bugs do Python; bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033}.)

@item 
Nova função: @ref{78b,,PyFrame_GetLineNumber()} pega um objeto quadro e retorna o número da linha que o frame está executando atualmente. Anteriormente, o código precisaria obter o índice da instrução de bytecode atualmente em execução e, em seguida, procurar o número da linha correspondente a esse endereço. (Adição de Jeffrey Yasskin.)

@item 
Novas funções: @ref{12a8,,PyLong_AsLongAndOverflow()} e @ref{12a7,,PyLong_AsLongLongAndOverflow()} aproxima um inteiro longo do Python como um long ou long long do C. Se o número for muito grande para caber no tipo de saída, um sinalizador `overflow' será definido e retornado ao chamador. (Contribuição de Case Van Horsen; bpo-7528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7528} e bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767}.)

@item 
Nova função: decorrente da reescrita da conversão string-para-float, uma nova função @ref{12d7,,PyOS_string_to_double()} foi adicionada. As antigas funções @code{PyOS_ascii_strtod()} e @code{PyOS_ascii_atof()} agora foram descontinuadas.

@item 
Nova função: @code{PySys_SetArgvEx()} define o valor de @code{sys.argv} e pode opcionalmente atualizar @code{sys.path} para incluir o diretório que contém o script nomeado por @code{sys.argv[0]} dependendo do valor de um parâmetro `updatepath'.

Esta função foi adicionada para fechar uma falha de segurança em aplicativos que incorporam Python. A função antiga, @code{PySys_SetArgv()}, sempre atualizava @code{sys.path}, e às vezes adicionava o diretório atual. Isso significava que, se você executasse uma aplicação incorporando Python em um diretório controlado por outra pessoa, os invasores poderiam colocar um módulo cavalo de Troia no diretório (digamos, um arquivo chamado @code{os.py}) que sua aplicação então usaria. importar e executar.

Se você mantém uma aplicação C/C++ que incorpora Python, verifique se está chamando @code{PySys_SetArgv()} e considere cuidadosamente se a aplicação deve usar @code{PySys_SetArgvEx()} com `updatepath' definido como false.

Problema de segurança relatado como 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}; discutido em bpo-5753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5753}, e corrigido por Antoine Pitrou.

@item 
Novas macros: os arquivos de cabeçalho do Python agora definem as seguintes macros: @ref{1397,,Py_ISALNUM}, @ref{1398,,Py_ISALPHA}, @ref{1399,,Py_ISDIGIT}, @ref{139a,,Py_ISLOWER}, @ref{139b,,Py_ISSPACE}, @ref{139c,,Py_ISUPPER}, @ref{139d,,Py_ISXDIGIT}, @ref{139e,,Py_TOLOWER} e @ref{139f,,Py_TOUPPER}. Todas essas funções são análogas às macros padrão C para classificação de caracteres, mas ignoram a configuração de localidade atual, porque em vários lugares o Python precisa analisar caracteres de maneira independente de localidade. (Adição de Eric Smith; bpo-5793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5793}.)

@item 
Função removida: @code{PyEval_CallObject()} agora está disponível apenas como uma macro. Uma versão de função estava sendo mantida para preservar a compatibilidade de links ABI, mas isso foi em 1997; certamente pode ser excluído agora. (Remoção de Antoine Pitrou; bpo-8276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8276}.)

@item 
Novos códigos de formato: as funções @code{PyString_FromFormat()}, @code{PyString_FromFormatV()} e @ref{ee0,,PyErr_Format()} agora aceitam @code{%lld} e @code{%llu} códigos de formato para exibir os tipos long long de C. (Contribuição de Mark Dickinson; bpo-7228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7228}.)

@item 
A complicada interação entre threads e forks de processos foi alterada. Anteriormente, o processo filho criado por @ref{197,,os.fork()} pode falhar porque o filho é criado com apenas um único thread em execução, a thread executando @ref{197,,os.fork()}. Se outros threads estivessem mantendo uma trava, como a trava de importação do Python, quando o fork fosse executado, a trava ainda seria marcada como “retida” no novo processo. Mas no processo filho nada liberaria a trava, pois os outros threads não foram replicados e o processo filho não seria mais capaz de realizar importações.

Python 2.7 adquire a trava de importação antes de executar um @ref{197,,os.fork()}, e também limpará quaisquer travas criadas usando o módulo @ref{ed,,threading}. Módulos de extensão C que possuem travas internas, ou que chamam @code{fork()} eles próprios, não se beneficiarão desta limpeza.

(Correção de Thomas Wouters; bpo-1590864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1590864}.)

@item 
A função @ref{13a0,,Py_Finalize()} agora chama a função interna @code{threading._shutdown()}; isso evita que algumas exceções sejam levantadas quando um interpretador é encerrado. (Patch de Adam Olsen; bpo-1722344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1722344}.)

@item 
Ao usar a estrutura @ref{54f,,PyMemberDef} para definir atributos de um tipo, o Python não permitirá mais que você tente excluir ou definir um atributo @code{T_STRING_INPLACE}.

@c rev 79644

@item 
Símbolos globais definidos pelo módulo @ref{2a,,ctypes} agora são prefixados com @code{Py}, ou com @code{_ctypes}. (Implementado por Thomas Heller; bpo-3102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3102}.)

@item 
Nova opção de configuração: a opção @code{--with-system-expat} permite construir o módulo @ref{126,,pyexpat} para usar a biblioteca Expat do sistema. (Contribuição de Arfrever Frehtes Taifersar Arahesis; bpo-7609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7609}.)

@item 
Nova opção de configuração: a opção @code{--with-valgrind} agora desativará o alocador pymalloc, o que é difícil para o detector de erros de memória Valgrind analisar corretamente. Valgrind será, portanto, melhor na detecção de vazamentos e sobrecargas de memória. (Contribuição de James Henstridge; bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422}.)

@item 
Nova opção de configuração: agora você pode fornecer uma string vazia para @code{--with-dbmliborder=} para desabilitar todos os vários módulos DBM. (Adição de Arfrever Frehtes Taifersar Arahesis; bpo-6491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6491}.)

@item 
O script @code{configure} agora verifica bugs de arredondamento de ponto flutuante em determinados chips Intel de 32 bits e define uma definição de pré-processador @code{X87_DOUBLE_ROUNDING}. Nenhum código usa essa definição no momento, mas ela está disponível para quem quiser. (Adicionado por Mark Dickinson; bpo-2937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2937}.)

@code{configure} agora também define uma variável Makefile @code{LDCXXSHARED} para oferecer suporte à ligação C++. (Contribuição de Arfrever Frehtes Taifersar Arahesis; bpo-1222585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1222585}.)

@item 
O processo de construção agora cria os arquivos necessários para suporte ao pkg-config. (Contribuição de Clinton Roy; bpo-3585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3585}.)

@item 
O processo de construção agora prover suporte ao Subversion 1.7. (Contribuição de Arfrever Frehtes Taifersar Arahesis; bpo-6094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6094}.)
@end itemize

@menu
* Capsules:: 
* Alterações específicas da porta; Windows: Alterações específicas da porta Windows. 
* Alterações específicas da porta; Mac OS X: Alterações específicas da porta Mac OS X. 
* Alterações específicas da porta; FreeBSD: Alterações específicas da porta FreeBSD. 

@end menu

@node Capsules,Alterações específicas da porta Windows,,Mudanças a construções e API C<8>
@anchor{whatsnew/2 7 capsules}@anchor{13a1}@anchor{whatsnew/2 7 whatsnew27-capsules}@anchor{13a2}
@subsubsection Capsules


Python 3.1 adiciona um novo tipo de dados C, @ref{12b4,,PyCapsule}, para fornecer uma API C para um módulo de extensão. Uma cápsula é essencialmente o detentor de um ponteiro C @code{void *} e é disponibilizada como um atributo de módulo; por exemplo, a API do módulo @ref{cc,,socket} é exposta como @code{socket.CAPI}, e @ref{105,,unicodedata} expõe @code{ucnhash_CAPI}. Outras extensões podem importar o módulo, acessar seu dicionário para obter o objeto cápsula e então obter o ponteiro @code{void *}, que normalmente apontará para uma matriz de ponteiros para as diversas funções da API do módulo.

Já existe um tipo de dados usado para isso, @code{PyCObject}, mas ele não fornece segurança de tipo. Código maligno escrito em Python puro pode causar uma falha de segmentação pegando um @code{PyCObject} do módulo A e de alguma forma substituindo-o por @code{PyCObject} no módulo B. As cápsulas sabem seu próprio nome , e para obter o ponteiro é necessário fornecer o nome:

@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

Você tem certeza de que @code{vtable} aponta para o que você espera. Se uma cápsula diferente fosse passada, @ref{13a3,,PyCapsule_IsValid()} detectaria o nome incompatível e retornaria falso. Consulte @ref{13a4,,Fornecendo uma API C para um módulo de extensão} para mais informações sobre como usar esses objetos.

Python 2.7 agora usa cápsulas internamente para fornecer várias APIs de módulo de extensão, mas o @code{PyCObject_AsVoidPtr()} foi modificado para lidar com cápsulas, preservando a compatibilidade em tempo de compilação com a interface @code{PyCObject}. O uso de @code{PyCObject_AsVoidPtr()} sinalizará uma exceção @ref{8ce,,PendingDeprecationWarning}, que é silencioso por padrão.

Implementado em Python 3.1 e portado para 2.7 por Larry Hastings; discutido em bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630}.

@c ======================================================================

@node Alterações específicas da porta Windows,Alterações específicas da porta Mac OS X,Capsules,Mudanças a construções e API C<8>
@anchor{whatsnew/2 7 port-specific-changes-windows}@anchor{13a5}
@subsubsection Alterações específicas da porta: Windows



@itemize *

@item 
O módulo @ref{93,,msvcrt} agora contém algumas constantes do arquivo de cabeçalho @code{crtassem.h}: @ref{13a6,,CRT_ASSEMBLY_VERSION}, @ref{13a7,,VC_ASSEMBLY_PUBLICKEYTOKEN} e @ref{13a8,,LIBRARIES_ASSEMBLY_NAME_PREFIX}. (Contribuição de David Cournapeau; bpo-4365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4365}.)

@item 
O módulo @ref{116,,_winreg} para acessar o registro agora implementa as funções @ref{13a9,,CreateKeyEx()} e @ref{13aa,,DeleteKeyEx()}, versões estendidas de funções suportadas anteriormente que recebem vários argumentos extras. Os @ref{13ab,,DisableReflectionKey()}, @ref{13ac,,EnableReflectionKey()} e @ref{13ad,,QueryReflectionKey()} também foram testados e documentados. (Implementação de Brian Curtin: bpo-7347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7347}.)

@item 
A nova API @code{_beginthreadex()} é usada para iniciar threads, e as funções nativas de armazenamento local de thread agora são usadas. (Contribuição de Kristján Valur Jónsson; bpo-3582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3582}.)

@item 
A função @ref{13ae,,os.kill()} agora funciona no Windows. O valor do sinal pode ser as constantes @ref{13af,,CTRL_C_EVENT}, @ref{13b0,,CTRL_BREAK_EVENT} ou qualquer número inteiro. As duas primeiras constantes enviarão eventos de pressionamento de tecla @code{Control}-@code{C} e @code{Control}-@code{Break} para subprocessos; qualquer outro valor usará a API @code{TerminateProcess()}. (Contribuição de Miki Tebeka; bpo-1220212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1220212}.)

@item 
A função @ref{1139,,os.listdir()} agora falha corretamente para um caminho vazio. (Correção de Hirokazu Yamamoto; bpo-5913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5913}.)

@item 
O módulo @ref{8f,,mimetypes} agora irá ler o banco de dados MIME do registro do Windows ao inicializar. (Patch de Gabriel Genellina; bpo-4969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4969}.)
@end itemize

@c ======================================================================

@node Alterações específicas da porta Mac OS X,Alterações específicas da porta FreeBSD,Alterações específicas da porta Windows,Mudanças a construções e API C<8>
@anchor{whatsnew/2 7 port-specific-changes-mac-os-x}@anchor{13b1}
@subsubsection Alterações específicas da porta: Mac OS X



@itemize *

@item 
O caminho @code{/Library/Python/2.7/site-packages} agora é anexado a @code{sys.path}, para compartilhar pacotes adicionados entre a instalação do sistema e uma cópia da mesma versão instalada pelo usuário. (Alteração de Ronald Oussoren; bpo-4865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4865}.)


Alterado na versão 2.7.13: A partir da versão 2.7.13, esta alteração foi removida. @code{/Library/Python/2.7/site-packages}, o diretório site-packages usado pelo sistema Python 2.7 fornecido pela Apple não é mais anexado a @code{sys.path} para Pythons instalados pelo usuário, como do Instaladores do python.org. A partir do macOS 10.12, a Apple mudou a forma como o diretório site-packages do sistema é configurado, o que pode causar falha na instalação de componentes pip, como setuptools. Os pacotes instalados para o sistema Python não serão mais compartilhados com Pythons instalados pelo usuário. ( bpo-28440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28440})

@end itemize

@node Alterações específicas da porta FreeBSD,,Alterações específicas da porta Mac OS X,Mudanças a construções e API C<8>
@anchor{whatsnew/2 7 port-specific-changes-freebsd}@anchor{13b2}
@subsubsection Alterações específicas da porta: FreeBSD



@itemize *

@item 
Constante @code{SO_SETFIB} do FreeBSD 7.1, usada com os métodos @ref{cf5,,getsockopt()} e @ref{cf6,,setsockopt()} do @ref{dc9,,socket()} para selecionar uma tabela de roteamento alternativa, agora está disponível no módulo @ref{cc,,socket}. (Adição de Kyle VanderBeek; bpo-8235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8235}.)
@end itemize

@node Outras alterações e correções,Portando para Python 2 7,Mudanças a construções e API C<8>,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 other-changes-and-fixes}@anchor{13b3}
@subsection Outras alterações e correções



@itemize *

@item 
Dois scripts de benchmark, @code{iobench} e @code{ccbench}, foram adicionados ao diretório @code{Tools}. @code{iobench} mede a velocidade dos objetos embutidos de E/S de arquivo retornados por @ref{51c,,open()} durante a execução de várias operações, e @code{ccbench} é um benchmark de simultaneidade que tenta medir o rendimento da computação, latência de comutação de threads e largura de banda de processamento de E/S ao executar diversas tarefas usando um número variável de threads.

@item 
O script @code{Tools/i18n/msgfmt.py} agora entende formas plurais em arquivos @code{.po}. (Correção de Martin von Löwis; bpo-5464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5464}.)

@item 
Ao importar um módulo de um arquivo @code{.pyc} ou @code{.pyo} com uma contraparte @code{.py} existente, os atributos @ref{13b4,,co_filename} dos objetos código resultantes são substituídos quando o nome do arquivo original fica obsoleto. Isso pode acontecer se o arquivo tiver sido renomeado, movido ou acessado por caminhos diferentes. (Patch de Ziga Seilnacht e Jean-Paul Calderone; bpo-1180193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1180193}.)

@item 
O script @code{regrtest.py} agora usa uma opção @code{--randseed=} que recebe um número inteiro que será usado como semente aleatória para a opção @code{-r} que executa testes em ordem aleatória. A opção @code{-r} também informa a semente que foi usada (Adição de Collin Winter.)

@item 
Outra opção @code{regrtest.py} é @code{-j}, que recebe um número inteiro especificando quantos testes são executados em paralelo. Isto permite reduzir o tempo total de execução em máquinas com vários núcleos. Esta opção é compatível com várias outras opções, incluindo a opção @code{-R} que é conhecida por produzir longos tempos de execução. (Adicionado por Antoine Pitrou, bpo-6152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6152}.) Isso também pode ser usado com uma nova opção @code{-F} que executa testes selecionados em um loop até que eles falhem. (Adição de Antoine Pitrou; bpo-7312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7312}.)

@item 
Quando executado como um script, o módulo @code{py_compile.py} agora aceita @code{'-'} como argumento, que lerá a entrada padrão para a lista de nomes de arquivos a serem compilados. (Contribuição de Piotr Ożarowski; bpo-8233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8233}.)
@end itemize

@c ======================================================================

@node Portando para Python 2 7,Novos recursos adicionados às versões de manutenção do Python 2 7,Outras alterações e correções,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 porting-to-python-2-7}@anchor{13b5}
@subsection Portando para Python 2.7


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.


@itemize *

@item 
A função @ref{94a,,range()} processa seus argumentos de forma mais consistente; agora ele chamará @ref{71c,,__int__()} em argumentos que não são ponto flutuantes nem inteiros que são fornecidos a ele. (Correção de Alexander Belopolsky; bpo-1533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533}.)

@item 
O método string @ref{61f,,format()} alterou a precisão padrão usada para números de ponto flutuante e complexos de 6 casas decimais para 12, o que corresponde à precisão usada por @ref{44c,,str()}. (Alteração de Eric Smith; bpo-5920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5920}.)

@item 
Por causa de uma otimização para a instrução @ref{5d2,,with}, os métodos especiais @ref{5c8,,__enter__()} e @ref{1344,,__exit__()} devem pertencer ao tipo do objeto e não podem ser diretamente anexados ao instância do objeto. Isto afeta classes de novo estilo (derivadas de @ref{a96,,object}) e tipos de extensão C. (bpo-6101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6101}.)

@item 
Devido a um bug no Python 2.6, o parâmetro `exc_value' para os métodos @ref{1344,,__exit__()} era frequentemente a representação de string da exceção, não uma instância. Isso foi corrigido na versão 2.7, então `exc_value' será uma instância conforme esperado. (Correção de Florent Xicluna; bpo-7853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7853}.)

@item 
Quando um conjunto restrito de atributos foi definido usando @code{__slots__}, excluir um atributo não definido não levantaria @ref{34b,,AttributeError} como seria de esperar. Correção de Benjamin Peterson; bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604}.)
@end itemize

Na biblioteca padrão:


@itemize *

@item 
Operações com instâncias @ref{1cc,,datetime} que resultaram em um ano fora do intervalo suportado nem sempre levantam @ref{885,,OverflowError}. Esses erros agora são verificados com mais cuidado e irão levantar a exceção. (Relato de Mark Leander, patch de Anand B. Pillai e Alexander Belopolsky; bpo-7150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7150}.)

@item 
Ao usar instâncias @ref{29d,,Decimal} com o método @ref{61f,,format()} de uma string, o alinhamento padrão era anteriormente o alinhamento à esquerda. Isso foi alterado para alinhamento à direita, o que pode alterar a saída dos seus programas. (Alteração de Mark Dickinson; bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857}.)

Comparações envolvendo um valor NaN de sinalização (ou @code{sNAN}) agora sinalizam @ref{10e7,,InvalidOperation} em vez de retornar silenciosamente um valor verdadeiro ou falso dependendo do operador de comparação. Valores silenciosos de NaN (ou @code{NaN}) agora são hasheáveis. (Corrigido por Mark Dickinson; bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279}.)

@item 
A biblioteca @ref{125,,xml.etree.ElementTree} não escapa mais os caracteres de e-comercial e colchetes angulares ao gerar uma instrução de processamento XML (que se parece com @code{<?xml-stylesheet href="#style1"?>}) ou comentário ( que se parece com @code{<!-- comment -->}). (Patch de Neil Muller; bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}.)

@item 
O método @code{readline()} dos objetos @ref{f59,,StringIO} agora não faz nada quando um comprimento negativo é solicitado, como fazem outros objetos arquivo ou similares. (bpo-7348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7348}).

@item 
O módulo @ref{dc,,syslog} agora usará o valor de @code{sys.argv[0]} como identificador em vez do valor padrão anterior de @code{'python'}. (Alteração de Sean Reifschneider; bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}.)

@item 
O tratamento de erros padrão do módulo @ref{de,,tarfile} foi alterado, para não mais suprimir erros fatais. O nível de erro padrão era anteriormente 0, o que significava que os erros resultariam apenas na gravação de uma mensagem no log de depuração, mas como o log de depuração não está ativado por padrão, esses erros passam despercebidos. O nível de erro padrão agora é 1, o que levanta uma exceção se houver um erro. (Alteração de Lars Gustäbel; bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}.)

@item 
A função @ref{d61,,urlsplit()} do módulo @ref{10a,,urlparse} agora lida com esquemas de URL desconhecidos de uma forma compatível com 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}: se a URL estiver no formato @code{"<alguma_coisa>://..."}, o texto antes de @code{://} é tratado como o esquema, mesmo que seja um esquema inventado que o módulo não conhece. Essa alteração pode quebrar o código que contornava o comportamento antigo. Por exemplo, Python 2.6.4 ou 2.5 retornará o seguinte:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7 (e Python 2.6.5) vai retornar:

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

(Na verdade, o Python 2.7 produz uma saída ligeiramente diferente, pois retorna uma tupla nomeada em vez de uma tupla padrão.)
@end itemize

Para extensões C:


@itemize *

@item 
Extensões C que usam códigos de formato inteiro com a família de funções @code{PyArg_Parse*} agora levantarão uma exceção @ref{2c3,,TypeError} em vez de disparar uma @ref{1a5,,DeprecationWarning} (bpo-5080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5080}).

@item 
Use a nova função @ref{12d7,,PyOS_string_to_double()} em vez das antigas funções @code{PyOS_ascii_strtod()} e @code{PyOS_ascii_atof()}, que agora estão descontinuadas.
@end itemize

Para aplicações que incorporam Python:


@itemize *

@item 
A função @code{PySys_SetArgvEx()} foi adicionada, permitindo que aplicativos fechem uma falha de segurança quando a função @code{PySys_SetArgv()} existente for usada. Verifique se você está chamando @code{PySys_SetArgv()} e considere cuidadosamente se a aplicação deve usar @code{PySys_SetArgvEx()} com `updatepath' definido como falso.
@end itemize

@c ======================================================================

@node Novos recursos adicionados às versões de manutenção do Python 2 7,Reconhecimentos,Portando para Python 2 7,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 new-features-added-to-python-2-7-maintenance-releases}@anchor{13b6}@anchor{whatsnew/2 7 py27-maintenance-enhancements}@anchor{132a}
@subsection Novos recursos adicionados às versões de manutenção do Python 2.7


Novos recursos podem ser adicionados às versões de manutenção do Python 2.7 quando a situação realmente exigir. Quaisquer adições devem passar pelo processo de proposta de melhoria do Python, ou em inglês Python Enhancement Proposal – PEP, e apresentar um argumento convincente sobre por que não podem ser abordadas adequadamente adicionando o novo recurso apenas ao Python 3 ou publicando-o no Python Package Index.

Além das propostas específicas listadas abaixo, há uma isenção geral que permite que novos avisos @code{-3} sejam adicionados em qualquer versão de manutenção do Python 2.7.

@menu
* Duas novas variáveis de ambiente para modo de depuração:: 
* PEP 434; Exceção de aprimoramento do IDLE para todos os branches: PEP 434 Exceção de aprimoramento do IDLE para todos os branches. 
* PEP 466; Aprimoramentos de segurança de rede do Python 2.7: PEP 466 Aprimoramentos de segurança de rede do Python 2 7. 
* PEP 477; Backport do ensurepip (PEP 453) para o Python 2.7: PEP 477 Backport do ensurepip PEP 453 para o Python 2 7. 
* PEP 476; Habilitando verificação de certificado por padrão para clientes http stdlib: PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib<2>. 
* PEP 493; Ferramentas de migração de verificação HTTPS para Python 2.7: PEP 493 Ferramentas de migração de verificação HTTPS para Python 2 7. 
* Novo alvo de construção make regen-all: Novo alvo de construção make regen-all<3>. 
* Remoção do alvo de construção make touch: Remoção do alvo de construção make touch<3>. 

@end menu

@node Duas novas variáveis de ambiente para modo de depuração,PEP 434 Exceção de aprimoramento do IDLE para todos os branches,,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 two-new-environment-variables-for-debug-mode}@anchor{13b7}
@subsubsection Duas novas variáveis de ambiente para modo de depuração


No modo de depuração, a estatística @code{[xxx refs]} não é escrita por padrão, a variável de ambiente @code{PYTHONSHOWREFCOUNT} agora também deve ser definida. (Contribuição de Victor Stinner; bpo-31733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31733}.)

Quando Python é compilado com @code{COUNT_ALLOC} definido, as contagens de alocação não são mais despejadas por padrão: a variável de ambiente @code{PYTHONSHOWALLOCCOUNT} agora também deve ser definida. Além disso, as contagens de alocação agora são despejadas no stderr, em vez do stdout. (Contribuição de Victor Stinner; bpo-31692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31692}.)


Adicionado na versão 2.7.15.


@node PEP 434 Exceção de aprimoramento do IDLE para todos os branches,PEP 466 Aprimoramentos de segurança de rede do Python 2 7,Duas novas variáveis de ambiente para modo de depuração,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 pep-434-idle-enhancement-exception-for-all-branches}@anchor{13b8}
@subsubsection PEP 434: Exceção de aprimoramento do IDLE para todos os branches


@geindex Propostas de Melhorias do Python; PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/} descreve uma isenção geral para alterações feitas no ambiente de desenvolvimento IDLE enviado junto com o Python. Esta isenção permite que os desenvolvedores de IDLE forneçam uma experiência de usuário mais consistente em todas as versões suportadas do Python 2 e 3.

Para obter detalhes sobre quaisquer alterações do IDLE, consulte o arquivo NEWS da versão específica.

@node PEP 466 Aprimoramentos de segurança de rede do Python 2 7,PEP 477 Backport do ensurepip PEP 453 para o Python 2 7,PEP 434 Exceção de aprimoramento do IDLE para todos os branches,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 pep-466-network-security-enhancements-for-python-2-7}@anchor{13b9}
@subsubsection PEP 466: Aprimoramentos de segurança de rede do Python 2.7


@geindex Propostas de Melhorias do Python; PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} descreve uma série de propostas de melhoria de segurança de rede que foram aprovadas para inclusão nas versões de manutenção do Python 2.7, com a primeira dessas mudanças aparecendo na versão Python 2.7.7.

Recursos relacionados a 
@geindex Propostas de Melhorias do Python; PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} adicionados no Python 2.7.7:


@itemize *

@item 
@ref{1108,,hmac.compare_digest()} foi portado do Python 3 para disponibilizar uma operação de comparação resistente a ataques de tempo para aplicações em Python 2. (Contribuição de Alex Gaynor; bpo-21306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21306}.)

@item 
OpenSSL 1.0.1g foi atualizado nos instaladores oficiais do Windows publicados em python.org. (Contribuição de Zachary Ware; bpo-21462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21462}.)
@end itemize

Recursos relacionados a 
@geindex Propostas de Melhorias do Python; PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} adicionados no Python 2.7.8:


@itemize *

@item 
@ref{50f,,hashlib.pbkdf2_hmac()} foi portado do Python 3 para tornar um algoritmo de hash adequado para armazenamento seguro de senhas amplamente disponível para aplicações Python 2. (Contribuição de Alex Gaynor; bpo-21304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21304}.)

@item 
OpenSSL 1.0.1h foi atualizado para os instaladores oficiais do Windows publicados em python.org. (Contribuição de Zachary Ware em bpo-21671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21671} para 
@geindex Common Vulnerabilities and Exposures; CVE 2014-0224
CVE 2014-0224@footnote{https://www.cve.org/CVERecord?id=CVE-2014-0224}.)
@end itemize

Recursos relacionados a 
@geindex Propostas de Melhorias do Python; PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} adicionados no Python 2.7.9:


@itemize *

@item 
A maior parte do módulo @ref{d0,,ssl} do Python 3.4 foi portada. Isso significa que @ref{d0,,ssl} agora provê suporte a indicar de nome de servidor, configurações TLS1.x, acesso ao armazenamento de certificados da plataforma, a classe @ref{294,,SSLContext} e outros recursos. (Contribuição de Alex Gaynor e David Reid; bpo-21308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21308}.)

Consulte as notas “Versão adicionada: 2.7.9” na documentação do módulo para obter detalhes específicos.

@item 
@ref{523,,os.urandom()} foi alterado para armazenar em cache um descritor de arquivo para @code{/dev/urandom} em vez de reabrir @code{/dev/urandom} em cada chamada. (Contribuição de Alex Gaynor; bpo-21305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21305}.)

@item 
@ref{13ba,,hashlib.algorithms_guaranteed} e @ref{13bb,,hashlib.algorithms_available} foram portados do Python 3 para tornar mais fácil para os aplicações Python 2 selecionarem o algoritmo de hash mais forte disponível. (Contribuição de Alex Gaynor em bpo-21307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21307})
@end itemize

@node PEP 477 Backport do ensurepip PEP 453 para o Python 2 7,PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib<2>,PEP 466 Aprimoramentos de segurança de rede do Python 2 7,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 pep-477-backport-ensurepip-pep-453-to-python-2-7}@anchor{13bc}
@subsubsection PEP 477: Backport do ensurepip (PEP 453) para o Python 2.7


A 
@geindex Propostas de Melhorias do Python; PEP 477
PEP 477@footnote{https://peps.python.org/pep-0477/} aprova a inclusão do módulo ensurepip do 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} e da documentação aprimorada que foi habilitada por ele nas versões de manutenção do Python 2.7, aparecendo primeiro na versão Python 2.7.9.

@menu
* Bootstrapping pip By Default: Bootstrapping pip By Default<2>. 
* Mudanças na documentação: Mudanças na documentação<2>. 

@end menu

@node Bootstrapping pip By Default<2>,Mudanças na documentação<2>,,PEP 477 Backport do ensurepip PEP 453 para o Python 2 7
@anchor{whatsnew/2 7 bootstrapping-pip-by-default}@anchor{13bd}
@subsubsection Bootstrapping pip By Default


O novo módulo @ref{55,,ensurepip} (definido em 
@geindex Propostas de Melhorias do Python; PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}) fornece um mecanismo padrão de plataforma cruzada para inicializar o instalador pip em instalações Python. A versão do @code{pip} incluída no Python 2.7.9 é @code{pip} 1.5.6, e futuras versões de manutenção 2.7.x atualizarão a versão empacotada para a versão mais recente do @code{pip} que está disponível em o momento da criação do candidato a lançamento.

Por padrão, os comandos @code{pip}, @code{pipX} e @code{pipX.Y} serão instalados em todas as plataformas (onde X.Y representa a versão da instalação do Python), junto com o pacote Python via @code{pip} e suas dependências.

Para @ref{f25,,construções de fontes do CPython em sistemas POSIX}, os comandos @code{make install} e @code{make altinstall} não inicializam @code{pip} por padrão. Este comportamento pode ser controlado através de opções de configuração e substituído através de opções do Makefile.

On Windows and Mac OS X, the CPython installers now default to installing
@code{pip} along with CPython itself (users may opt out of installing it
during the installation process). Window users will need to opt in to the
automatic @code{PATH} modifications to have @code{pip} available from the command
line by default, otherwise it can still be accessed through the Python
launcher for Windows as @code{py -m pip}.

Como 
@geindex Propostas de Melhorias do Python; PEP 0477#disabling-ensurepip-by-downstream-distributors
discutido na PEP@footnote{https://peps.python.org/pep-0477/#disabling-ensurepip-by-downstream-distributors}, os empacotadores de plataforma podem optar por não instalar estes comandos por padrão, desde que, quando invocados, forneçam instruções claras e simples sobre como instalá-los naquela plataforma (geralmente usando o gerenciador de pacotes do sistema). .

@node Mudanças na documentação<2>,,Bootstrapping pip By Default<2>,PEP 477 Backport do ensurepip PEP 453 para o Python 2 7
@anchor{whatsnew/2 7 documentation-changes}@anchor{13be}
@subsubsection Mudanças na documentação


As part of this change, the @ref{f27,,Instalando módulos Python} and
distributing-index sections of the documentation have been
completely redesigned as short getting started and FAQ documents. Most
packaging documentation has now been moved out to the Python Packaging
Authority maintained Python Packaging User Guide@footnote{https://packaging.python.org} and the documentation of the individual
projects.

No entanto, como esta migração ainda está incompleta, as versões legadas desses guias permanecem disponíveis como @ref{f28,,Construindo extensões C e C ++ com setuptools} e @ref{f29,,Construindo extensões C e C ++ com setuptools}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} – Explicit bootstrapping of pip in Python installations

PEP written by Donald Stufft and Nick Coghlan, implemented by
Donald Stufft, Nick Coghlan, Martin von Löwis and Ned Deily.
@end table


@node PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib<2>,PEP 493 Ferramentas de migração de verificação HTTPS para Python 2 7,PEP 477 Backport do ensurepip PEP 453 para o Python 2 7,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{13bf}
@subsubsection PEP 476: Habilitando verificação de certificado por padrão para clientes http stdlib


@geindex Propostas de Melhorias do Python; PEP 476
PEP 476@footnote{https://peps.python.org/pep-0476/} atualizou @ref{6e,,httplib} e módulos que o utilizam, como @ref{10b,,urllib2} e @ref{12e,,xmlrpclib}, para agora verificar se o servidor apresenta um certificado que é assinado por uma Autoridade Certificadora no armazenamento confiável da plataforma e cujo nome de host corresponde ao nome de host solicitado por padrão, melhorando significativamente a segurança para muitas aplicações. Essa alteração foi feita na versão 2.7.9 do Python.

Para aplicações que exigem o antigo comportamento anterior, elas podem passar um contexto alternativo:

@example
import urllib2
import ssl

# Isso desabilita toda verificação
context = ssl._create_unverified_context()

# Isso permite usar um certificado específico para o host,
# o que não precisa ser no armazenamento de confiança
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib2.urlopen("https://invalid-cert", context=context)
@end example

@node PEP 493 Ferramentas de migração de verificação HTTPS para Python 2 7,Novo alvo de construção make regen-all<3>,PEP 476 Habilitando verificação de certificado por padrão para clientes http stdlib<2>,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 pep-493-https-verification-migration-tools-for-python-2-7}@anchor{13c0}
@subsubsection PEP 493: Ferramentas de migração de verificação HTTPS para Python 2.7


@geindex Propostas de Melhorias do Python; PEP 493
PEP 493@footnote{https://peps.python.org/pep-0493/} fornece ferramentas de migração adicionais para provê um processo de atualização de infraestrutura mais incremental para ambientes contendo aplicações e serviços que dependem do processamento historicamente permissivo de certificados de servidor ao estabelecer conexões HTTPS de clientes. Essas adições foram feitas na versão 2.7.12 do Python.

Estas ferramentas destinam-se a ser utilizadas em casos em que as aplicações e serviços afetados não podem ser modificados para passar explicitamente um contexto SSL mais permissivo ao estabelecer a ligação.

Para aplicações e serviços que não podem ser modificados, a nova variável de ambiente @code{PYTHONHTTPSVERIFY} pode ser definida como @code{0} para reverter todo um processo Python de volta ao comportamento permissivo padrão do Python 2.7.8 e anteriores.

Para casos em que o código de estabelecimento da conexão não pode ser modificado, mas a aplicação geral pode, a nova função @code{ssl._https_verify_certificates()} pode ser usada para ajustar o comportamento padrão em tempo de execução.

@node Novo alvo de construção make regen-all<3>,Remoção do alvo de construção make touch<3>,PEP 493 Ferramentas de migração de verificação HTTPS para Python 2 7,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 new-make-regen-all-build-target}@anchor{13c1}
@subsubsection Novo alvo de construção @code{make regen-all}


Para simplificar a compilação cruzada e garantir que o CPython possa ser compilado de forma confiável sem exigir que uma versão existente do Python já esteja disponível, o sistema de construção baseado em autotools não tenta mais recompilar implicitamente os arquivos gerados com base nos tempos de modificação dos arquivos.

Em vez disso, um novo comando @code{make regen-all} foi adicionado para forçar a regeneração desses arquivos quando desejado (por exemplo, após uma versão inicial do Python já ter sido construída com base nas versões pré-geradas).

Alvos de regeneração mais seletivos também são definidos – veja Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.13/Makefile.pre.in} para detalhes.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Adicionado na versão 2.7.14.


@node Remoção do alvo de construção make touch<3>,,Novo alvo de construção make regen-all<3>,Novos recursos adicionados às versões de manutenção do Python 2 7
@anchor{whatsnew/2 7 removal-of-make-touch-build-target}@anchor{13c2}
@subsubsection Remoção do alvo de construção @code{make touch}


O alvo de construção @code{make touch} usado anteriormente para solicitar regeneração implícita de arquivos gerados atualizando seus tempos de modificação foi removido.

Ele foi substituído pelo novo alvo @code{make regen-all}.

(Contribuição de Victor Stinner em bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}.)


Alterado na versão 2.7.14.


@c ======================================================================

@node Reconhecimentos,,Novos recursos adicionados às versões de manutenção do Python 2 7,O que há de novo no Python 2 7
@anchor{whatsnew/2 7 acknowledgements}@anchor{13c3}@anchor{whatsnew/2 7 acks27}@anchor{13c4}
@subsection Reconhecimentos


O autor gostaria de agradecer às seguintes pessoas por oferecerem sugestões, correções e assistência com vários rascunhos deste artigo: Nick Coghlan, Philip Jenvey, Ryan Lovett, R. David Murray, Hugh Secker-Walker.

@node O que há de novo no Python 2 6,What’s New in Python 2 5,O que há de novo no Python 2 7,O que há de novo no Python
@anchor{whatsnew/2 6 doc}@anchor{13c5}@anchor{whatsnew/2 6 translation-repo}@anchor{13c6}@anchor{whatsnew/2 6 what-s-new-in-python-2-6}@anchor{13c7}@anchor{whatsnew/2 6 whats-new-in-2-6}@anchor{12f0}
@section O que há de novo no Python 2.6


@*Autor: 
A.M. Kuchling (amk at 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.

This article explains the new features in Python 2.6, released on October 1,
2008.  The release schedule is described in 
@geindex Propostas de Melhorias do Python; PEP 361
PEP 361@footnote{https://peps.python.org/pep-0361/}.

The major theme of Python 2.6 is preparing the migration path to
Python 3.0, a major redesign of the language.  Whenever possible,
Python 2.6 incorporates new features and syntax from 3.0 while
remaining compatible with existing code by not removing older features
or syntax.  When it’s not possible to do that, Python 2.6 tries to do
what it can, adding compatibility functions in a
@code{future_builtins} module and a @code{-3} switch to warn about
usages that will become unsupported in 3.0.

Some significant new packages have been added to the standard library,
such as the @ref{94,,multiprocessing} and @ref{82,,json} modules, but
there aren’t many new features that aren’t related to Python 3.0 in
some way.

Python 2.6 also sees a number of improvements and bugfixes throughout the source. A search through the change logs finds there were 259 patches applied and 612 bugs fixed between Python 2.5 and 2.6. Both figures are likely to be underestimates.

This article doesn’t attempt to provide a complete specification of the new features, but instead provides a convenient overview. For full details, you should refer to the documentation for Python 2.6. If you want to understand the rationale for the design and implementation, refer to the PEP for a particular new feature. Whenever possible, “What’s New in Python” links to the bug/patch item for each change.

@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. 
* Changes to the Development Process:: 
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement. 
* PEP 366; Explicit Relative Imports From a Main Module: PEP 366 Explicit Relative Imports From a Main Module. 
* PEP 370; Per-user site-packages Directory: PEP 370 Per-user site-packages Directory. 
* PEP 371; The multiprocessing Package: PEP 371 The multiprocessing Package. 
* PEP 3101; Advanced String Formatting: PEP 3101 Advanced String Formatting. 
* PEP 3105; print As a Function: PEP 3105 print As a Function. 
* PEP 3110; Exception-Handling Changes: PEP 3110 Exception-Handling Changes. 
* PEP 3112; Byte Literals: PEP 3112 Byte Literals. 
* PEP 3116; New I/O Library: PEP 3116 New I/O Library. 
* PEP 3118; Revised Buffer Protocol: PEP 3118 Revised Buffer Protocol. 
* PEP 3119; Abstract Base Classes: PEP 3119 Abstract Base Classes. 
* PEP 3127; Integer Literal Support and Syntax: PEP 3127 Integer Literal Support and Syntax. 
* PEP 3129; Class Decorators: PEP 3129 Class Decorators. 
* PEP 3141; A Type Hierarchy for Numbers: PEP 3141 A Type Hierarchy for Numbers. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<15>. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<2>. 
* Deprecations and Removals:: 
* Mudanças a construções e API C: Mudanças a construções e API C<9>. 
* Porting to Python 2.6: Porting to Python 2 6. 
* Reconhecimentos: Reconhecimentos<2>. 

@end menu

@node Python 3 0,Changes to the Development Process,,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 python-3-0}@anchor{13c8}
@subsection Python 3.0


The development cycle for Python versions 2.6 and 3.0 was synchronized, with the alpha and beta releases for both versions being made on the same days. The development of 3.0 has influenced many features in 2.6.

Python 3.0 is a far-ranging redesign of Python that breaks compatibility with the 2.x series. This means that existing Python code will need some conversion in order to run on Python 3.0. However, not all the changes in 3.0 necessarily break compatibility. In cases where new features won’t cause existing code to break, they’ve been backported to 2.6 and are described in this document in the appropriate place. Some of the 3.0-derived features are:


@itemize *

@item 
A @code{__complex__()} method for converting objects to a complex number.

@item 
Alternate syntax for catching exceptions: @code{except TypeError as exc}.

@item 
The addition of @ref{131f,,functools.reduce()} as a synonym for the built-in
@code{reduce()} function.
@end itemize

Python 3.0 adds several new built-in functions and changes the
semantics of some existing builtins.  Functions that are new in 3.0
such as @ref{12eb,,bin()} have simply been added to Python 2.6, but existing
builtins haven’t been changed; instead, the @code{future_builtins}
module has versions with the new 3.0 semantics.  Code written to be
compatible with 3.0 can do @code{from future_builtins import hex, map} as
necessary.

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 também


The 3`xxx' series of PEPs, which contains proposals for Python 3.0.
@geindex Propostas de Melhorias do Python; PEP 3000
PEP 3000@footnote{https://peps.python.org/pep-3000/} describes the development process for Python 3.0.
Start with 
@geindex Propostas de Melhorias do Python; 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 Changes to the Development Process,PEP 343 The ‘with’ statement,Python 3 0,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 changes-to-the-development-process}@anchor{13c9}
@subsection Changes to the Development Process


While 2.6 was being developed, the Python development process
underwent two significant changes: we switched from SourceForge’s
issue tracker to a customized Roundup installation, and the
documentation was converted from LaTeX to reStructuredText.

@menu
* New Issue Tracker; Roundup: New Issue Tracker Roundup. 
* New Documentation Format; reStructuredText Using Sphinx: New Documentation Format reStructuredText Using Sphinx. 

@end menu

@node New Issue Tracker Roundup,New Documentation Format reStructuredText Using Sphinx,,Changes to the Development Process
@anchor{whatsnew/2 6 new-issue-tracker-roundup}@anchor{13ca}
@subsubsection New Issue Tracker: Roundup


For a long time, the Python developers had been growing increasingly annoyed by SourceForge’s bug tracker. SourceForge’s hosted solution doesn’t permit much customization; for example, it wasn’t possible to customize the life cycle of issues.

The infrastructure committee of the Python Software Foundation
therefore posted a call for issue trackers, asking volunteers to set
up different products and import some of the bugs and patches from
SourceForge.  Four different trackers were examined: Jira@footnote{https://www.atlassian.com/software/jira/},
Launchpad@footnote{https://launchpad.net/},
Roundup@footnote{https://roundup.sourceforge.io/}, and
Trac@footnote{https://trac.edgewall.org/}.
The committee eventually settled on Jira
and Roundup as the two candidates.  Jira is a commercial product that
offers no-cost hosted instances to free-software projects; Roundup
is an open-source project that requires volunteers
to administer it and a server to host it.

After posting a call for volunteers, a new Roundup installation was set up at @indicateurl{https://bugs.python.org}. One installation of Roundup can host multiple trackers, and this server now also hosts issue trackers for Jython and for the Python web site. It will surely find other uses in the future. Where possible, this edition of “What’s New in Python” links to the bug/patch item for each change.

Hosting of the Python bug tracker is kindly provided by
Upfront Systems@footnote{https://upfrontsoftware.co.za}
of Stellenbosch, South Africa.  Martin von Löwis put a
lot of effort into importing existing bugs and patches from
SourceForge; his scripts for this import operation are at
@code{https://svn.python.org/view/tracker/importer/} and may be useful to
other projects wishing to move from SourceForge to Roundup.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://bugs.python.org}

The Python bug tracker.

@item @indicateurl{https://bugs.jython.org}:

The Jython bug tracker.

@item @indicateurl{https://roundup.sourceforge.io/}

Roundup downloads and documentation.

@item @indicateurl{https://svn.python.org/view/tracker/importer/}

Martin von Löwis’s conversion scripts.
@end table


@node New Documentation Format reStructuredText Using Sphinx,,New Issue Tracker Roundup,Changes to the Development Process
@anchor{whatsnew/2 6 new-documentation-format-restructuredtext-using-sphinx}@anchor{13cb}
@subsubsection New Documentation Format: reStructuredText Using Sphinx


The Python documentation was written using LaTeX since the project started around 1989. In the 1980s and early 1990s, most documentation was printed out for later study, not viewed online. LaTeX was widely used because it provided attractive printed output while remaining straightforward to write once the basic rules of the markup were learned.

Today LaTeX is still used for writing publications destined for printing, but the landscape for programming tools has shifted. We no longer print out reams of documentation; instead, we browse through it online and HTML has become the most important format to support. Unfortunately, converting LaTeX to HTML is fairly complicated and Fred L. Drake Jr., the long-time Python documentation editor, spent a lot of time maintaining the conversion process. Occasionally people would suggest converting the documentation into SGML and later XML, but performing a good conversion is a major task and no one ever committed the time required to finish the job.

During the 2.6 development cycle, Georg Brandl put a lot of effort
into building a new toolchain for processing the documentation.  The
resulting package is called Sphinx, and is available from
@indicateurl{https://www.sphinx-doc.org/}.

Sphinx concentrates on HTML output, producing attractively styled and modern HTML; printed output is still supported through conversion to LaTeX. The input format is reStructuredText, a markup syntax supporting custom extensions and directives that is commonly used in the Python community.

Sphinx is a standalone package that can be used for writing, and
almost two dozen other projects
(listed on the Sphinx web site@footnote{https://www.sphinx-doc.org/en/master/examples.html})
have adopted Sphinx as their documentation tool.


@subsubheading Ver também



@table @asis

@item Documenting Python@footnote{https://devguide.python.org/documenting/}

Describes how to write for Python’s documentation.

@item Sphinx@footnote{https://www.sphinx-doc.org/}

Documentation and code for the Sphinx toolchain.

@item Docutils@footnote{https://docutils.sourceforge.io}

The underlying reStructuredText parser and toolset.
@end table


@node PEP 343 The ‘with’ statement,PEP 366 Explicit Relative Imports From a Main Module,Changes to the Development Process,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-0343}@anchor{12f1}@anchor{whatsnew/2 6 pep-343-the-with-statement}@anchor{13cc}
@subsection PEP 343: The ‘with’ statement


The previous version, Python 2.5, added the ‘@ref{5d2,,with}’
statement as an optional feature, to be enabled by a @code{from __future__
import with_statement} directive.  In 2.6 the statement no longer needs to
be specially enabled; this means that @code{with} is now always a
keyword.  The rest of this section is a copy of the corresponding
section from the “What’s New in Python 2.5” document; if you’re
familiar with the ‘@code{with}’ statement
from Python 2.5, you can skip this section.

The ‘@ref{5d2,,with}’ statement clarifies code that previously would use @code{try...finally} blocks to ensure that clean-up code is executed. In this section, I’ll discuss the statement as it will commonly be used. In the next section, I’ll examine the implementation details and show how to write objects for use with this statement.

The ‘@ref{5d2,,with}’ statement is a control-flow structure whose basic
structure is:

@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{5c8,,__enter__()} and @ref{1344,,__exit__()}
methods).

The object’s @ref{5c8,,__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{1344,,__exit__()}
method is called, even if the block raised an exception, and can therefore run
clean-up code.

Some standard Python objects now support the context management protocol and can
be used with the ‘@ref{5d2,,with}’ statement. File objects are one example:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...
@end example

After this statement has executed, the file object in `f' will have been
automatically closed, even if the @ref{2f2,,for} loop raised an exception
part-way through the block.

@cartouche
@quotation Nota 
In this case, `f' is the same object created by @ref{51c,,open()}, because
@ref{5c8,,__enter__()} returns `self'.
@end quotation
@end cartouche

The @ref{ed,,threading} module’s locks and condition variables also support the ‘@ref{5d2,,with}’ statement:

@example
lock = threading.Lock()
with lock:
    # Critical section of code
    ...
@end example

The lock is acquired before the block is executed and always released once the block is complete.

The @ref{13cd,,localcontext()} function in the @ref{36,,decimal} module makes
it easy to save and restore the current decimal context, which encapsulates
the desired precision and rounding characteristics for computations:

@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
* Writing Context Managers:: 
* The contextlib module:: 

@end menu

@node Writing Context Managers,The contextlib module,,PEP 343 The ‘with’ statement
@anchor{whatsnew/2 6 new-26-context-managers}@anchor{12f2}@anchor{whatsnew/2 6 writing-context-managers}@anchor{13ce}
@subsubsection Writing Context Managers


Under the hood, the ‘@ref{5d2,,with}’ statement is fairly complicated. Most
people will only use ‘@code{with}’ in company with existing objects and
don’t need to know these details, so you can skip the rest of this section if
you like.  Authors of new objects will need to understand the details of the
underlying implementation and should keep reading.

A high-level explanation of the context management protocol is:


@itemize *

@item 
The expression is evaluated and should result in an object called a “context
manager”.  The context manager must have @ref{5c8,,__enter__()} and
@ref{1344,,__exit__()} methods.

@item 
The context manager’s @ref{5c8,,__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 
The code in `BLOCK' is executed.

@item 
If `BLOCK' raises an exception, the context manager’s @ref{1344,,__exit__()} method
is called with three arguments, the exception details (@code{type, value, traceback},
the same values returned by @ref{68a,,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{5d2,,with}’ statement will
never realize anything went wrong.

@item 
If `BLOCK' didn’t raise an exception,  the @ref{1344,,__exit__()} method is still
called, but `type', `value', and `traceback' are all @code{None}.
@end itemize

Let’s think through an example. I won’t present detailed code but will only sketch the methods necessary for a database that supports transactions.

(For people unfamiliar with database terminology: a set of changes to the database are grouped into a transaction. Transactions can be either committed, meaning that all the changes are written into the database, or rolled back, meaning that the changes are all discarded and the database is unchanged. See any database textbook for more information.)

Vamos supor que exista um objeto representando uma conexão com o banco de dados. Nosso objetivo será permitir que o usuário escreva 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

The transaction should be committed if the code in the block runs flawlessly or
rolled back if there’s an exception. Here’s the basic interface for
@code{DatabaseConnection} that I’ll assume:

@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{5c8,,__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{5d2,,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{1344,,__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.

In the code below, execution will just fall off the end of the function, returning the default value of @code{None}. @code{None} is false, so the exception will be re-raised automatically. If you wished, you could be more explicit and add a @ref{9d6,,return} statement at the marked location.

@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 The contextlib module,,Writing Context Managers,PEP 343 The ‘with’ statement
@anchor{whatsnew/2 6 new-module-contextlib}@anchor{12f3}@anchor{whatsnew/2 6 the-contextlib-module}@anchor{13cf}
@subsubsection The contextlib module


The @ref{23,,contextlib} module provides some functions and a decorator that
are useful when writing objects for use with the ‘@ref{5d2,,with}’ statement.

The decorator is called @ref{1242,,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{9d5,,yield} will be
executed as the @ref{5c8,,__enter__()} method, and the value yielded will
be the method’s return value that will get bound to the variable in the
‘@ref{5d2,,with}’ statement’s @code{as} clause, if any.  The code after
the @code{yield} will be executed in the @ref{1344,,__exit__()} method.
Any exception raised in the block will be raised by the @code{yield}
statement.

Using this decorator, our database example from the previous section
could be written as:

@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

The @ref{23,,contextlib} module also has a @code{nested(mgr1, mgr2, ...)} function
that combines a number of context managers so you don’t need to write nested
‘@ref{5d2,,with}’ statements.  In this example, the single ‘@code{with}’
statement both starts a database transaction and acquires a thread lock:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

Finally, the @ref{13d0,,closing()} function returns its argument so that it can be
bound to a variable, and calls the argument’s @code{.close()} method at the end
of the block.

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - A instrução “with”

PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland, Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a ‘@ref{5d2,,with}’ statement, which can be helpful in learning how the statement works.
@end table

The documentation for the @ref{23,,contextlib} module.


@c ======================================================================

@node PEP 366 Explicit Relative Imports From a Main Module,PEP 370 Per-user site-packages Directory,PEP 343 The ‘with’ statement,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-0366}@anchor{12f4}@anchor{whatsnew/2 6 pep-366-explicit-relative-imports-from-a-main-module}@anchor{13d1}
@subsection PEP 366: Explicit Relative Imports From a Main Module


Python’s @ref{5e1,,-m} switch allows running a module as a script.
When you ran a module that was located inside a package, relative
imports didn’t work correctly.

The fix for Python 2.6 adds a @ref{2d7,,module.__package__} attribute.
When this attribute is present, relative imports will be
relative to the value of this attribute instead of the
@ref{13d2,,__name__} attribute.

PEP 302-style importers can then set @ref{2d7,,__package__} as necessary.
The @ref{be,,runpy} module that implements the @ref{5e1,,-m} switch now
does this, so relative imports will now work correctly in scripts
running from inside a package.

@c ======================================================================

@node PEP 370 Per-user site-packages Directory,PEP 371 The multiprocessing Package,PEP 366 Explicit Relative Imports From a Main Module,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-0370}@anchor{12f5}@anchor{whatsnew/2 6 pep-370-per-user-site-packages-directory}@anchor{13d3}
@subsection PEP 370: Per-user @code{site-packages} Directory


When you run Python, the module search path @code{sys.path} usually
includes a directory whose path ends in @code{"site-packages"}.  This
directory is intended to hold locally installed packages available to
all users using a machine or a particular site installation.

Python 2.6 introduces a convention for user-specific site directories.
The directory varies depending on the platform:


@itemize *

@item 
Unix and Mac OS X: @code{~/.local/}

@item 
Windows: @code{%APPDATA%/Python}
@end itemize

Within this directory, there will be version-specific subdirectories,
such as @code{lib/python2.6/site-packages} on Unix/Mac OS and
@code{Python26/site-packages} on Windows.

If you don’t like the default directory, it can be overridden by an
environment variable.  
@geindex PYTHONUSERBASE
@geindex variável de ambiente; PYTHONUSERBASE
@ref{13d4,,PYTHONUSERBASE} sets the root
directory used for all Python versions supporting this feature.  On
Windows, the directory for application-specific data can be changed by
setting the @code{APPDATA} environment variable.  You can also
modify the @code{site.py} file for your Python installation.

The feature can be disabled entirely by running Python with the
@ref{13d5,,-s} option or setting the 
@geindex PYTHONNOUSERSITE
@geindex variável de ambiente; PYTHONNOUSERSITE
@ref{13d6,,PYTHONNOUSERSITE}
environment variable.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 370

@item PEP 370@footnote{https://peps.python.org/pep-0370/} - Per-user @code{site-packages} Directory

PEP written and implemented by Christian Heimes.
@end table


@c ======================================================================

@node PEP 371 The multiprocessing Package,PEP 3101 Advanced String Formatting,PEP 370 Per-user site-packages Directory,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-0371}@anchor{12f6}@anchor{whatsnew/2 6 pep-371-the-multiprocessing-package}@anchor{13d7}
@subsection PEP 371: The @code{multiprocessing} Package


The new @ref{94,,multiprocessing} package lets Python programs create new processes that will perform a computation and return a result to the parent. The parent and child processes can communicate using queues and pipes, synchronize their operations using locks and semaphores, and can share simple arrays of data.

The @ref{94,,multiprocessing} module started out as an exact emulation of
the @ref{ed,,threading} module using processes instead of threads.  That
goal was discarded along the path to Python 2.6, but the general
approach of the module is still similar.  The fundamental class
is the @ref{b6f,,Process}, which is passed a callable object and
a collection of arguments.  The @ref{13d8,,start()} method
sets the callable running in a subprocess, after which you can call
the @ref{13d9,,is_alive()} method to check whether the
subprocess is still running and the @ref{13da,,join()}
method to wait for the process to exit.

Here’s a simple example where the subprocess will calculate a factorial. The function doing the calculation is written strangely so that it takes significantly longer when the input argument is a multiple of 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

A @ref{13db,,Queue} is used to communicate the result of the factorial. The @ref{13db,,Queue} object is stored in a global variable. The child process will use the value of the variable when the child was created; because it’s a @ref{13db,,Queue}, parent and child can use the object to communicate. (If the parent were to change the value of the global variable, the child’s value would be unaffected, and vice versa.)

Two other classes, @ref{f9f,,Pool} and
@ref{cda,,Manager}, provide higher-level interfaces.
@ref{f9f,,Pool} will create a fixed number of worker
processes, and requests can then be distributed to the workers by calling
@ref{13dc,,apply()} or
@ref{13dd,,apply_async()} to add a single request, and
@ref{1124,,map()} or
@ref{1125,,map_async()} to add a number of
requests.  The following code uses a @ref{f9f,,Pool} to
spread requests across 5 worker processes and retrieve a list of results:

@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

This produces the following output:

@example
1
39916800
51090942171709440000
8222838654177922817725562880000000
33452526613163807108170062053440751665152000000000
...
@end example

The other high-level interface, the @ref{cda,,Manager} class,
creates a separate server process that can hold master copies of Python data
structures.  Other processes can then access and modify these data
structures using proxy objects.  The following example creates a
shared dictionary by calling the @ref{256,,dict()} method; the worker
processes then insert values into the dictionary.  (Locking is not
done for you automatically, which doesn’t matter in this example.
@ref{cda,,Manager}’s methods also include
@ref{13de,,Lock()},
@ref{13df,,RLock()},
and @ref{13e0,,Semaphore()} to create
shared locks.)

@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

This will produce the output:

@example
1 1
11 39916800
21 51090942171709440000
31 8222838654177922817725562880000000
41 33452526613163807108170062053440751665152000000000
51 15511187532873822802242430164693032110632597200169861120000...
@end example


@subsubheading Ver também


The documentation for the @ref{94,,multiprocessing} module.


@table @asis

@geindex Propostas de Melhorias do Python; PEP 371

@item PEP 371@footnote{https://peps.python.org/pep-0371/} - Addition of the multiprocessing package

PEP written by Jesse Noller and Richard Oudkerk;
implemented by Richard Oudkerk and Jesse Noller.
@end table


@c ======================================================================

@node PEP 3101 Advanced String Formatting,PEP 3105 print As a Function,PEP 371 The multiprocessing Package,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3101}@anchor{12f7}@anchor{whatsnew/2 6 pep-3101-advanced-string-formatting}@anchor{13e1}
@subsection PEP 3101: Advanced String Formatting


In Python 3.0, the @code{%} operator is supplemented by a more powerful string
formatting method, @ref{61f,,format()}.  Support for the @ref{621,,str.format()} method
has been backported to Python 2.6.

In 2.6, both 8-bit and Unicode strings have a @code{.format()} method that
treats the string as a template and takes the arguments to be formatted.
The formatting template uses curly brackets (@code{@{}, @code{@}}) as special characters:

@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

Curly brackets can be escaped by doubling them:

@example
>>> "Empty dict: @{@{@}@}".format()
"Empty dict: @{@}"
@end example

Field names can be integers indicating positional arguments, such as @code{@{0@}}, @code{@{1@}}, etc. or names of keyword arguments. You can also supply compound field names that read attributes or access dictionary keys:

@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

Note that when using dictionary-style notation such as @code{[.mp4]}, you don’t need to put any quotation marks around the string; it will look up the value using @code{.mp4} as the key. Strings beginning with a number will be converted to an integer. You can’t write more complicated expressions inside a format string.

So far we’ve shown how to specify which field to substitute into the resulting string. The precise formatting used is also controllable by adding a colon followed by a format specifier. For example:

@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

Format specifiers can reference other fields through nesting:

@example
>>> fmt = '@{0:@{1@}@}'
>>> width = 15
>>> fmt.format('Invoice #1234', width)
'Invoice #1234  '
>>> width = 35
>>> fmt.format('Invoice #1234', width)
'Invoice #1234                      '
@end example

The alignment of a field within the desired width can be specified:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caractere

@tab

Effect

@item

< (default)

@tab

Left-align

@item

>

@tab

Right-align

@item

^

@tab

Center

@item

=

@tab

(For numeric types only) Pad after the sign.

@end multitable


Format specifiers can also include a presentation type, which controls how the value is formatted. For example, floating-point numbers can be formatted as a general number or in exponential notation:

@example
>>> '@{0:g@}'.format(3.75)
'3.75'
>>> '@{0:e@}'.format(3.75)
'3.750000e+00'
@end example

A variety of presentation types are available. Consult the 2.6 documentation for a @ref{13e2,,complete list}; here’s a sample:


@multitable {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{b}

@tab

Binary. Outputs the number in base 2.

@item

@code{c}

@tab

Character. Converts the integer to the corresponding Unicode character
before printing.

@item

@code{d}

@tab

Inteiro decimal. Exibe o número na base 10.

@item

@code{o}

@tab

Formato octal. Exibe o número na base 8.

@item

@code{x}

@tab

Formato hexadecimal. Produz o número na base 16, usando letras minúsculas para os dígitos acima de 9.

@item

@code{e}

@tab

Exponent notation. Prints the number in scientific notation using the
letter ‘e’ to indicate the exponent.

@item

@code{g}

@tab

General format. This prints the number as a fixed-point number, unless
the number is too large, in which case it switches to ‘e’ exponent
notation.

@item

@code{n}

@tab

Number. This is the same as ‘g’ (for floats) or ‘d’ (for integers),
except that it uses the current locale setting to insert the appropriate
number separator characters.

@item

@code{%}

@tab

Percentage. Multiplies the number by 100 and displays in fixed (‘f’)
format, followed by a percent sign.

@end multitable


Classes and types can define a @ref{61e,,__format__()} method to control how they’re
formatted.  It receives a single argument, the format specifier:

@example
def __format__(self, format_spec):
    if isinstance(format_spec, unicode):
        return unicode(str(self))
    else:
        return str(self)
@end example

There’s also a @ref{61f,,format()} builtin that will format a single
value.  It calls the type’s @ref{61e,,__format__()} method with the
provided specifier:

@example
>>> format(75.6564, '.2f')
'75.66'
@end example


@subsubheading Ver também



@table @asis

@item @ref{13e2,,Sintaxe das strings de formato}

The reference documentation for format fields.

@geindex Propostas de Melhorias do Python; PEP 3101

@item PEP 3101@footnote{https://peps.python.org/pep-3101/} - Advanced String Formatting

PEP written by Talin. Implemented by Eric Smith.
@end table


@c ======================================================================

@node PEP 3105 print As a Function,PEP 3110 Exception-Handling Changes,PEP 3101 Advanced String Formatting,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3105}@anchor{12f8}@anchor{whatsnew/2 6 pep-3105-print-as-a-function}@anchor{13e3}
@subsection PEP 3105: @code{print} As a Function


The @code{print} statement becomes the @ref{fa9,,print()} function in Python 3.0.
Making @ref{fa9,,print()} a function makes it possible to replace the function
by doing @code{def print(...)} or importing a new function from somewhere else.

Python 2.6 has a @code{__future__} import that removes @code{print} as language syntax, letting you use the functional form instead. For example:

@example
>>> from __future__ import print_function
>>> print('# of entries', len(dictionary), file=sys.stderr)
@end example

The signature of the new function is:

@example
def print(*args, sep=' ', end='\n', file=None)
@end example

The parameters are:


@itemize *

@item 
`args': positional arguments whose values will be printed out.

@item 
`sep': the separator, which will be printed between arguments.

@item 
`end': the ending text, which will be printed after all of the
arguments have been output.

@item 
`file': the file object to which the output will be sent.
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3105

@item PEP 3105@footnote{https://peps.python.org/pep-3105/} - Make print a function

PEP written by Georg Brandl.
@end table


@c ======================================================================

@node PEP 3110 Exception-Handling Changes,PEP 3112 Byte Literals,PEP 3105 print As a Function,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3110}@anchor{12f9}@anchor{whatsnew/2 6 pep-3110-exception-handling-changes}@anchor{13e4}
@subsection PEP 3110: Exception-Handling Changes


One error that Python programmers occasionally make
is writing the following code:

@example
try:
    ...
except TypeError, ValueError:  # Wrong!
    ...
@end example

The author is probably trying to catch both @ref{2c3,,TypeError} and @ref{202,,ValueError} exceptions, but this code actually does something different: it will catch @ref{2c3,,TypeError} and bind the resulting exception object to the local name @code{"ValueError"}. The @ref{202,,ValueError} exception will not be caught at all. The correct code specifies a tuple of exceptions:

@example
try:
    ...
except (TypeError, ValueError):
    ...
@end example

This error happens because the use of the comma here is ambiguous:
does it indicate two different nodes in the parse tree, or a single
node that’s a tuple?

Python 3.0 makes this unambiguous by replacing the comma with the word “as”. To catch an exception and store the exception object in the variable @code{exc}, you must write:

@example
try:
    ...
except TypeError as exc:
    ...
@end example

Python 3.0 will only support the use of “as”, and therefore interprets the first example as catching two different exceptions. Python 2.6 supports both the comma and “as”, so existing code will continue to work. We therefore suggest using “as” when writing new Python code that will only be executed with 2.6.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3110

@item PEP 3110@footnote{https://peps.python.org/pep-3110/} - Catching Exceptions in Python 3000

PEP written and implemented by Collin Winter.
@end table


@c ======================================================================

@node PEP 3112 Byte Literals,PEP 3116 New I/O Library,PEP 3110 Exception-Handling Changes,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3112}@anchor{12fa}@anchor{whatsnew/2 6 pep-3112-byte-literals}@anchor{13e5}
@subsection PEP 3112: Byte Literals


Python 3.0 adopts Unicode as the language’s fundamental string type and denotes 8-bit literals differently, either as @code{b'string'} or using a @ref{1c2,,bytes} constructor. For future compatibility, Python 2.6 adds @ref{1c2,,bytes} as a synonym for the @ref{44c,,str} type, and it also supports the @code{b'@w{'}} notation.

The 2.6 @ref{44c,,str} differs from 3.0’s @ref{1c2,,bytes} type in various ways; most notably, the constructor is completely different. In 3.0, @code{bytes([65, 66, 67])} is 3 elements long, containing the bytes representing @code{ABC}; in 2.6, @code{bytes([65, 66, 67])} returns the 12-byte string representing the @ref{44c,,str()} of the list.

The primary use of @ref{1c2,,bytes} in 2.6 will be to write tests of object type such as @code{isinstance(x, bytes)}. This will help the 2to3 converter, which can’t tell whether 2.x code intends strings to contain either characters or 8-bit bytes; you can now use either @ref{1c2,,bytes} or @ref{44c,,str} to represent your intention exactly, and the resulting code will also be correct in Python 3.0.

There’s also a @code{__future__} import that causes all string literals to become Unicode strings. This means that @code{\u} escape sequences can be used to include Unicode characters:

@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

At the C level, Python 3.0 will rename the existing 8-bit
string type, called @code{PyStringObject} in Python 2.x,
to @ref{792,,PyBytesObject}.  Python 2.6 uses @code{#define}
to support using the names @ref{792,,PyBytesObject()},
@ref{13e6,,PyBytes_Check()}, @ref{13e7,,PyBytes_FromStringAndSize()},
and all the other functions and macros used with strings.

Instances of the @ref{1c2,,bytes} type are immutable just as strings are. A new @ref{2ea,,bytearray} type stores a mutable sequence of 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

Byte arrays support most of the methods of string types, such as
@ref{13e8,,startswith()}/@ref{13e9,,endswith()},
@ref{13ea,,find()}/@ref{13eb,,rfind()},
and some of the methods of lists, such as @ref{13ec,,append()},
@ref{13ed,,pop()},  and @ref{13ee,,reverse()}.

@example
>>> b = bytearray('ABC')
>>> b.append('d')
>>> b.append(ord('e'))
>>> b
bytearray(b'ABCde')
@end example

There’s also a corresponding C API, with
@ref{13ef,,PyByteArray_FromObject()},
@ref{13f0,,PyByteArray_FromStringAndSize()},
and various other functions.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3112

@item PEP 3112@footnote{https://peps.python.org/pep-3112/} - Bytes literals in Python 3000

PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
@end table


@c ======================================================================

@node PEP 3116 New I/O Library,PEP 3118 Revised Buffer Protocol,PEP 3112 Byte Literals,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3116}@anchor{12fb}@anchor{whatsnew/2 6 pep-3116-new-i-o-library}@anchor{13f1}
@subsection PEP 3116: New I/O Library


Python’s built-in file objects support a number of methods, but
file-like objects don’t necessarily support all of them.  Objects that
imitate files usually support @code{read()} and
@code{write()}, but they may not support @code{readline()},
for example.  Python 3.0 introduces a layered I/O library in the @ref{7f,,io}
module that separates buffering and text-handling features from the
fundamental read and write operations.

There are three levels of abstract base classes provided by
the @ref{7f,,io} module:


@itemize *

@item 
@ref{110f,,RawIOBase} defines raw I/O operations: @ref{e48,,read()},
@ref{e49,,readinto()}, @ref{13f2,,write()},
@ref{12ce,,seek()}, @ref{13f3,,tell()}, @ref{1355,,truncate()},
and @ref{1f6,,close()}.
Most of the methods of this class will often map to a single system call.
There are also @ref{13f4,,readable()}, @ref{13f5,,writable()},
and @ref{13f6,,seekable()} methods for determining what operations a
given object will allow.

Python 3.0 has concrete implementations of this class for files and
sockets, but Python 2.6 hasn’t restructured its file and socket objects
in this way.

@item 
@ref{694,,BufferedIOBase} is an abstract base class that
buffers data in memory to reduce the number of
system calls used, making I/O processing more efficient.
It supports all of the methods of @ref{110f,,RawIOBase},
and adds a @ref{13f7,,raw} attribute holding the underlying
raw object.

There are five concrete classes implementing this ABC.
@ref{13f8,,BufferedWriter} and @ref{124e,,BufferedReader} are for objects
that support write-only or read-only usage that have a @ref{12ce,,seek()}
method for random access.  @ref{13f9,,BufferedRandom} objects support
read and write access upon the same underlying stream, and
@ref{13fa,,BufferedRWPair} is for objects such as TTYs that have both
read and write operations acting upon unconnected streams of data.
The @ref{ed3,,BytesIO} class supports reading, writing, and seeking
over an in-memory buffer.

@geindex novas linhas universais;What's new

@item 
@ref{695,,TextIOBase}: Provides functions for reading and writing
strings (remember, strings will be Unicode in Python 3.0),
and supporting @ref{d5c,,universal newlines}.  @ref{695,,TextIOBase} defines
the @ref{ba,,readline()} method and supports iteration upon
objects.

There are two concrete implementations.  @ref{7bc,,TextIOWrapper}
wraps a buffered I/O object, supporting all of the methods for
text I/O and adding a @ref{12e5,,buffer} attribute for access
to the underlying object.  @ref{f59,,StringIO} simply buffers
everything in memory without ever writing anything to disk.

(In Python 2.6, @ref{f59,,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

In Python 2.6, the underlying implementations haven’t been restructured to build on top of the @ref{7f,,io} module’s classes. The module is being provided to make it easier to write code that’s forward-compatible with 3.0, and to save developers the effort of writing their own implementations of buffering and text I/O.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3116

@item PEP 3116@footnote{https://peps.python.org/pep-3116/} - New I/O

PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
Jeremy Hylton, Martin von Löwis, Tony Lownds, and others.
@end table


@c ======================================================================

@node PEP 3118 Revised Buffer Protocol,PEP 3119 Abstract Base Classes,PEP 3116 New I/O Library,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3118}@anchor{12fc}@anchor{whatsnew/2 6 pep-3118-revised-buffer-protocol}@anchor{13fb}
@subsection PEP 3118: Revised Buffer Protocol


The buffer protocol is a C-level API that lets Python types exchange pointers into their internal representations. A memory-mapped file can be viewed as a buffer of characters, for example, and this lets another module such as @ref{b9,,re} treat memory-mapped files as a string of characters to be searched.

The primary users of the buffer protocol are numeric-processing packages such as NumPy, which expose the internal representation of arrays so that callers can write data directly into an array instead of going through a slower API. This PEP updates the buffer protocol in light of experience from NumPy development, adding a number of new features such as indicating the shape of an array or locking a memory region.

The most important new C API function is @code{PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)}, which takes an object and a set of flags, and fills in the @code{Py_buffer} structure with information about the object’s memory representation. Objects can use this operation to lock memory in place while an external caller could be modifying the contents, so there’s a corresponding @code{PyBuffer_Release(Py_buffer *view)} to indicate that the external caller is done.

The `flags' argument to @ref{399,,PyObject_GetBuffer()} specifies constraints upon the memory returned. Some examples are:


@itemize *

@item 
@ref{13fc,,PyBUF_WRITABLE} indicates that the memory must be writable.

@item 
@code{PyBUF_LOCK} requests a read-only or exclusive lock on the memory.

@item 
@ref{13fd,,PyBUF_C_CONTIGUOUS} and @ref{13fe,,PyBUF_F_CONTIGUOUS}
requests a C-contiguous (last dimension varies the fastest) or
Fortran-contiguous (first dimension varies the fastest) array layout.
@end itemize

Two new argument codes for @ref{571,,PyArg_ParseTuple()},
@code{s*} and @code{z*}, return locked buffer objects for a parameter.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3118

@item PEP 3118@footnote{https://peps.python.org/pep-3118/} - Revising the buffer protocol

PEP written by Travis Oliphant and Carl Banks; implemented by
Travis Oliphant.
@end table


@c ======================================================================

@node PEP 3119 Abstract Base Classes,PEP 3127 Integer Literal Support and Syntax,PEP 3118 Revised Buffer Protocol,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3119}@anchor{12fd}@anchor{whatsnew/2 6 pep-3119-abstract-base-classes}@anchor{13ff}
@subsection PEP 3119: Abstract Base Classes


Some object-oriented languages such as Java support interfaces,
declaring that a class has a given set of methods or supports a given
access protocol.  Abstract Base Classes (or ABCs) are an equivalent
feature for Python. The ABC support consists of an @ref{4,,abc} module
containing a metaclass called @ref{f4a,,ABCMeta}, special handling of
this metaclass by the @ref{442,,isinstance()} and @ref{7c2,,issubclass()}
builtins, and a collection of basic ABCs that the Python developers
think will be widely useful.  Future versions of Python will probably
add more ABCs.

Let’s say you have a particular class and wish to know whether it supports
dictionary-style access.  The phrase “dictionary-style” is vague, however.
It probably means that accessing items with @code{obj[1]} works.
Does it imply that setting items with @code{obj[2] = value} works?
Or that the object will have @code{keys()}, @code{values()}, and @code{items()}
methods?  What about the iterative variants  such as @code{iterkeys()}?
@code{copy`and :meth:()}!update`?  Iterating over the object with @code{iter()}?

The Python 2.6 @ref{1d,,collections} module includes a number of
different ABCs that represent these distinctions.  @code{Iterable}
indicates that a class defines @ref{c8a,,__iter__()}, and
@code{Container} means the class defines a @ref{1400,,__contains__()}
method and therefore supports @code{x in y} expressions.  The basic
dictionary interface of getting items, setting items, and
@code{keys()}, @code{values()}, and @code{items()}, is defined by the
@code{MutableMapping} ABC.

You can derive your own classes from a particular ABC
to indicate they support that ABC’s interface:

@example
import collections

class Storage(collections.MutableMapping):
    ...
@end example

Alternatively, you could write the class without deriving from
the desired ABC and instead register the class by
calling the ABC’s @ref{10c7,,register()} method:

@example
import collections

class Storage:
    ...

collections.MutableMapping.register(Storage)
@end example

For classes that you write, deriving from the ABC is probably clearer.
The @ref{10c7,,register()}  method is useful when you’ve written a new
ABC that can describe an existing type or class, or if you want
to declare that some third-party class implements an ABC.
For example, if you defined a @code{PrintableType} ABC,
it’s legal to do:

@example
# Register Python's types
PrintableType.register(int)
PrintableType.register(float)
PrintableType.register(str)
@end example

Classes should obey the semantics specified by an ABC, but
Python can’t check this; it’s up to the class author to
understand the ABC’s requirements and to implement the code accordingly.

To check whether an object supports a particular interface, you can
now write:

@example
def func(d):
    if not isinstance(d, collections.MutableMapping):
        raise ValueError("Mapping object expected, not %r" % d)
@end example

Don’t feel that you must now begin writing lots of checks as in the above example. Python has a strong tradition of duck-typing, where explicit type-checking is never done and code simply calls methods on an object, trusting that those methods will be there and raising an exception if they aren’t. Be judicious in checking for ABCs and only do it where it’s absolutely necessary.

You can write your own ABCs by using @code{abc.ABCMeta} as the
metaclass in a class definition:

@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

In the @code{Drawable} ABC above, the @code{draw_doubled()} method
renders the object at twice its size and can be implemented in terms
of other methods described in @code{Drawable}.  Classes implementing
this ABC therefore don’t need to provide their own implementation
of @code{draw_doubled()}, though they can do so.  An implementation
of @code{draw()} is necessary, though; the ABC can’t provide
a useful generic implementation.

You can apply the @ref{10c4,,@@~abc.abstractmethod} decorator to methods such as
@code{draw()} that must be implemented; Python will then raise an
exception for classes that don’t define the method.
Note that the exception is only raised when you actually
try to create an instance of a subclass lacking the method:

@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

Abstract data attributes can be declared using the
@code{@@abstractproperty} decorator:

@example
from abc import abstractproperty
...

@@abstractproperty
def readonly(self):
   return self._x
@end example

Subclasses must then define a @code{readonly} property.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - Introduzindo classes base abstratas

PEP written by Guido van Rossum and Talin.
Implemented by Guido van Rossum.
Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
@end table


@c ======================================================================

@node PEP 3127 Integer Literal Support and Syntax,PEP 3129 Class Decorators,PEP 3119 Abstract Base Classes,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3127}@anchor{12fe}@anchor{whatsnew/2 6 pep-3127-integer-literal-support-and-syntax}@anchor{1401}
@subsection PEP 3127: Integer Literal Support and Syntax


Python 3.0 changes the syntax for octal (base-8) integer literals,
prefixing them with “0o” or “0O” instead of a leading zero, and adds
support for binary (base-2) integer literals, signalled by a “0b” or
“0B” prefix.

Python 2.6 doesn’t drop support for a leading 0 signalling
an octal number, but it does add support for “0o” and “0b”:

@example
>>> 0o21, 2*8 + 1
(17, 17)
>>> 0b101111
47
@end example

The @ref{1311,,oct()} builtin still returns numbers
prefixed with a leading zero, and a new @ref{12eb,,bin()}
builtin returns the binary representation for a number:

@example
>>> oct(42)
'052'
>>> future_builtins.oct(42)
'0o52'
>>> bin(173)
'0b10101101'
@end example

The @ref{257,,int()} and @code{long()} builtins will now accept the “0o”
and “0b” prefixes when base-8 or base-2 are requested, or when the
`base' argument is zero (signalling that the base used should be
determined from the string):

@example
>>> int ('0o52', 0)
42
>>> int('1101', 2)
13
>>> int('0b1101', 2)
13
>>> int('0b1101', 0)
13
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3127

@item PEP 3127@footnote{https://peps.python.org/pep-3127/} - Integer Literal Support and Syntax

PEP written by Patrick Maupin; backported to 2.6 by
Eric Smith.
@end table


@c ======================================================================

@node PEP 3129 Class Decorators,PEP 3141 A Type Hierarchy for Numbers,PEP 3127 Integer Literal Support and Syntax,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3129}@anchor{12ff}@anchor{whatsnew/2 6 pep-3129-class-decorators}@anchor{1402}
@subsection PEP 3129: Class Decorators


Decorators have been extended from functions to classes. It’s now legal to write:

@example
@@foo
@@bar
class A:
  pass
@end example

Isso equivale a:

@example
class A:
  pass

A = foo(bar(A))
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - Class Decorators

PEP written by Collin Winter.
@end table


@c ======================================================================

@node PEP 3141 A Type Hierarchy for Numbers,Outras mudanças na linguagem<15>,PEP 3129 Class Decorators,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 pep-3141}@anchor{1300}@anchor{whatsnew/2 6 pep-3141-a-type-hierarchy-for-numbers}@anchor{1403}
@subsection PEP 3141: A Type Hierarchy for Numbers


Python 3.0 adds several abstract base classes for numeric types inspired by Scheme’s numeric tower. These classes were backported to 2.6 as the @ref{9e,,numbers} module.

The most general ABC is @code{Number}. It defines no operations at all, and only exists to allow checking if an object is a number by doing @code{isinstance(obj, Number)}.

@code{Complex} is a subclass of @code{Number}. Complex numbers can undergo the basic operations of addition, subtraction, multiplication, division, and exponentiation, and you can retrieve the real and imaginary parts and obtain a number’s conjugate. Python’s built-in complex type is an implementation of @code{Complex}.

@code{Real} further derives from @code{Complex}, and adds
operations that only work on real numbers: @code{floor()}, @code{trunc()},
rounding, taking the remainder mod N, floor division,
and comparisons.

@code{Rational} numbers derive from @code{Real}, have @code{numerator} and @code{denominator} properties, and can be converted to floats. Python 2.6 adds a simple rational-number class, @code{Fraction}, in the @ref{5d,,fractions} module. (It’s called @code{Fraction} instead of @code{Rational} to avoid a name clash with @ref{1301,,numbers.Rational}.)

@code{Integral} numbers derive from @code{Rational}, and
can be shifted left and right with @code{<<} and @code{>>},
combined using bitwise operations such as @code{&} and @code{|},
and can be used as array indexes and slice boundaries.

In Python 3.0, the PEP slightly redefines the existing builtins
@ref{131d,,round()}, @ref{1404,,math.floor()}, @ref{1405,,math.ceil()}, and adds a new
one, @ref{1406,,math.trunc()}, that’s been backported to Python 2.6.
@ref{1406,,math.trunc()} rounds toward zero, returning the closest
@code{Integral} that’s between the function’s argument and zero.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3141

@item PEP 3141@footnote{https://peps.python.org/pep-3141/} - A Type Hierarchy for Numbers

PEP written by Jeffrey Yasskin.
@end table

Scheme's numerical tower@footnote{https://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower}, from the Guile manual.

Scheme's number datatypes@footnote{https://conservatory.scheme.org/schemers/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2} from the R5RS Scheme specification.


@menu
* The fractions Module:: 

@end menu

@node The fractions Module,,,PEP 3141 A Type Hierarchy for Numbers
@anchor{whatsnew/2 6 the-fractions-module}@anchor{1407}
@subsubsection The @code{fractions} Module


To fill out the hierarchy of numeric types, the @ref{5d,,fractions} module provides a rational-number class. Rational numbers store their values as a numerator and denominator forming a fraction, and can exactly represent numbers such as @code{2/3} that floating-point numbers can only approximate.

The @code{Fraction} constructor takes two @code{Integral} values
that will be the numerator and denominator of the resulting fraction.

@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

Note that values that can only be approximated by floating-point
numbers, such as 1./3, are not simplified to the number being
approximated; the fraction attempts to match the floating-point value
`exactly'.

The @ref{5d,,fractions} module is based upon an implementation by Sjoerd Mullender that was in Python’s @code{Demo/classes/} directory for a long time. This implementation was significantly updated by Jeffrey Yasskin.

@node Outras mudanças na linguagem<15>,Módulos Novos ou Aprimorados<2>,PEP 3141 A Type Hierarchy for Numbers,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 other-language-changes}@anchor{1408}
@subsection Outras mudanças na linguagem


Algumas das mudanças menores feitas no núcleo da linguagem Python são:


@itemize *

@item 
Directories and zip archives containing a @code{__main__.py} file can now be executed directly by passing their name to the interpreter. The directory or zip archive is automatically inserted as the first entry in sys.path. (Suggestion and initial patch by Andy Chu, subsequently revised by Phillip J. Eby and Nick Coghlan; bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}.)

@item 
A função @ref{4d2,,hasattr()} estava capturando e ignorando todos os erros, sob a suposição de que eles significavam que um método @code{__getattr__()} estava falhando de alguma forma e o valor de retorno de @ref{4d2,,hasattr()} seria, portanto, @code{False}. Esta lógica não deve ser aplicada a @ref{9d9,,KeyboardInterrupt} e @ref{d63,,SystemExit}, entretanto; O Python 2.6 não descartará mais tais exceções quando @ref{4d2,,hasattr()} as encontrar. (Correção de Benjamin Peterson; bpo-2196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2196}.)

@item 
When calling a function using the @code{**} syntax to provide keyword
arguments, you are no longer required to use a Python dictionary;
any mapping will now work:

@example
>>> def f(**kw):
...    print sorted(kw)
...
>>> ud=UserDict.UserDict()
>>> ud['a'] = 1
>>> ud['b'] = 'string'
>>> f(**ud)
['a', 'b']
@end example

(Contributed by Alexander Belopolsky; bpo-1686487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1686487}.)

It’s also become legal to provide keyword arguments after a @code{*args} argument
to a function call.

@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

Previously this would have been a syntax error.
(Contributed by Amaury Forgeot d’Arc; bpo-3473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3473}.)

@item 
A new builtin, @code{next(iterator, [default])} returns the next item from the specified iterator. If the `default' argument is supplied, it will be returned if `iterator' has been exhausted; otherwise, the @ref{c15,,StopIteration} exception will be raised. (Backported in bpo-2719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2719}.)

@item 
Tuples now have @ref{1409,,index()} and @ref{140a,,count()} methods
matching the list type’s @ref{140b,,index()} and @ref{140c,,count()} methods:

@example
>>> t = (0,1,2,3,4,0,1,2)
>>> t.index(3)
3
>>> t.count(0)
2
@end example

(Contributed by Raymond Hettinger)

@item 
The built-in types now have improved support for extended slicing syntax,
accepting various combinations of @code{(start, stop, step)}.
Previously, the support was partial and certain corner cases wouldn’t work.
(Implemented by Thomas Wouters.)

@c Revision 57619

@item 
Properties now have three attributes, @code{getter}, @code{setter}
and @code{deleter}, that are decorators providing useful shortcuts
for adding a getter, setter or deleter function to an existing
property. You would use them like this:

@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 
Several methods of the built-in set types now accept multiple iterables:
@code{intersection()},
@code{intersection_update()},
@code{union()}, @code{update()},
@code{difference()} and @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

(Contributed by Raymond Hettinger.)

@item 
Many floating-point features were added. The @ref{2f7,,float()} function will now turn the string @code{nan} into an IEEE 754 Not A Number value, and @code{+inf} and @code{-inf} into positive or negative infinity. This works on any platform with IEEE 754 semantics. (Contributed by Christian Heimes; bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}.)

Other functions in the @ref{8e,,math} module, @code{isinf()} and @code{isnan()}, return true if their floating-point argument is infinite or Not A Number. (bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640})

Conversion functions were added to convert floating-point numbers into hexadecimal strings (bpo-3008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3008}). These functions convert floats to and from a string representation without introducing rounding errors from the conversion between decimal and binary. Floats have a @ref{1312,,hex()} method that returns a string representation, and the @code{float.fromhex()} method converts a string back into a number:

@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 
A numerical nicety: when creating a complex number from two floats on systems that support signed zeros (-0 and +0), the @ref{2f8,,complex()} constructor will now preserve the sign of the zero. (Fixed by Mark T. Dickinson; bpo-1507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1507}.)

@item 
Classes that inherit a @code{__hash__()} method from a parent class can set @code{__hash__ = None} to indicate that the class isn’t hashable. This will make @code{hash(obj)} raise a @ref{2c3,,TypeError} and the class will not be indicated as implementing the @code{Hashable} ABC.

You should do this when you’ve defined a @code{__cmp__()} or @code{__eq__()} method that compares objects by their value rather than by identity. All objects have a default hash method that uses @code{id(obj)} as the hash value. There’s no tidy way to remove the @code{__hash__()} method inherited from a parent class, so assigning @code{None} was implemented as an override. At the C level, extensions can set @code{tp_hash} to @ref{140d,,PyObject_HashNotImplemented()}. (Fixed by Nick Coghlan and Amaury Forgeot d’Arc; bpo-2235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2235}.)

@item 
The @ref{140e,,GeneratorExit} exception now subclasses @ref{5bb,,BaseException} instead of @ref{9e2,,Exception}. This means that an exception handler that does @code{except Exception:} will not inadvertently catch @ref{140e,,GeneratorExit}. (Contributed by Chad Austin; bpo-1537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537}.)

@item 
Generator objects now have a @code{gi_code} attribute that refers to
the original code object backing the generator.
(Contributed by Collin Winter; bpo-1473257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1473257}.)

@item 
The @ref{192,,compile()} built-in function now accepts keyword arguments as well as positional parameters. (Contributed by Thomas Wouters; bpo-1444529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1444529}.)

@item 
The @ref{2f8,,complex()} constructor now accepts strings containing parenthesized complex numbers, meaning that @code{complex(repr(cplx))} will now round-trip values. For example, @code{complex('(3+4j)')} now returns the value (3+4j). (bpo-1491866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1491866})

@item 
The string @code{translate()} method now accepts @code{None} as the translation table parameter, which is treated as the identity transformation. This makes it easier to carry out operations that only delete characters. (Contributed by Bengt Richter and implemented by Raymond Hettinger; bpo-1193128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1193128}.)

@item 
The built-in @ref{632,,dir()} function now checks for a @code{__dir__()} method on the objects it receives. This method must return a list of strings containing the names of valid attributes for the object, and lets the object control the value that @ref{632,,dir()} produces. Objects that have @code{__getattr__()} or @code{__getattribute__()} methods can use this to advertise pseudo-attributes they will honor. (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{140f,,__self__}, and @code{im_func} is also available as
@ref{1340,,__func__}.
The old names are still supported in Python 2.6, but are gone in 3.0.

@item 
An obscure change: when you use the @ref{141,,locals()} function inside a
@ref{131a,,class} statement, the resulting dictionary no longer returns free
variables.  (Free variables, in this case, are variables referenced in the
@code{class} statement  that aren’t attributes of the class.)
@end itemize

@c ======================================================================

@menu
* Otimizações: Otimizações<14>. 
* Alterações no interpretador: Alterações no interpretador<2>. 

@end menu

@node Otimizações<14>,Alterações no interpretador<2>,,Outras mudanças na linguagem<15>
@anchor{whatsnew/2 6 optimizations}@anchor{1410}
@subsubsection Otimizações



@itemize *

@item 
The @ref{112,,warnings} module has been rewritten in C. This makes it possible to invoke warnings from the parser, and may also make the interpreter’s startup faster. (Contributed by Neal Norwitz and Brett Cannon; bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171}.)

@item 
Type objects now have a cache of methods that can reduce
the work required to find the correct method implementation
for a particular class; once cached, the interpreter doesn’t need to
traverse base classes to figure out the right method to call.
The cache is cleared if a base class or the class itself is modified,
so the cache should remain correct even in the face of Python’s dynamic
nature.
(Original optimization implemented by Armin Rigo, updated for
Python 2.6 by Kevin Jacobs; bpo-1700288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1700288}.)

By default, this change is only applied to types that are included with the Python core. Extension modules may not necessarily be compatible with this cache, so they must explicitly add @code{Py_TPFLAGS_HAVE_VERSION_TAG} to the module’s @code{tp_flags} field to enable the method cache. (To be compatible with the method cache, the extension module’s code must not directly access and modify the @code{tp_dict} member of any of the types it implements. Most modules don’t do this, but it’s impossible for the Python interpreter to determine that. See bpo-1878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1878} for some discussion.)

@item 
Function calls that use keyword arguments are significantly faster by doing a quick pointer comparison, usually saving the time of a full string comparison. (Contributed by Raymond Hettinger, after an initial implementation by Antoine Pitrou; bpo-1819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1819}.)

@item 
All of the functions in the @ref{d5,,struct} module have been rewritten in
C, thanks to work at the Need For Speed sprint.
(Contributed by Raymond Hettinger.)

@item 
Some of the standard built-in types now set a bit in their type objects. This speeds up checking whether an object is a subclass of one of these types. (Contributed by Neal Norwitz.)

@item 
Unicode strings now use faster code for detecting whitespace and line breaks; this speeds up the @code{split()} method by about 25% and @code{splitlines()} by 35%. (Contributed by Antoine Pitrou.) Memory usage is reduced by using pymalloc for the Unicode string’s data.

@item 
The @code{with} statement now stores the @ref{1344,,__exit__()} method on the stack,
producing a small speedup.  (Implemented by Jeffrey Yasskin.)

@item 
To reduce memory usage, the garbage collector will now clear internal
free lists when garbage-collecting the highest generation of objects.
This may return memory to the operating system sooner.
@end itemize

@c ======================================================================

@node Alterações no interpretador<2>,,Otimizações<14>,Outras mudanças na linguagem<15>
@anchor{whatsnew/2 6 interpreter-changes}@anchor{1411}@anchor{whatsnew/2 6 new-26-interpreter}@anchor{1412}
@subsubsection Alterações no interpretador


Two command-line options have been reserved for use by other Python implementations. The @ref{1413,,-J} switch has been reserved for use by Jython for Jython-specific options, such as switches that are passed to the underlying JVM. @ref{176,,-X} has been reserved for options specific to a particular implementation of Python such as CPython, Jython, or IronPython. If either option is used with Python 2.6, the interpreter will report that the option isn’t currently used.

Python can now be prevented from writing @code{.pyc} or @code{.pyo} files by supplying the @ref{1414,,-B} switch to the Python interpreter, or by setting the 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE} environment variable before running the interpreter. This setting is available to Python programs as the @code{sys.dont_write_bytecode} variable, and Python code can change the value to modify the interpreter’s behaviour. (Contributed by Neal Norwitz and Georg Brandl.)

The encoding used for standard input, output, and standard error can be specified by setting the 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} environment variable before running the interpreter. The value should be a string in the form @code{<encoding>} or @code{<encoding>:<errorhandler>}. The `encoding' part specifies the encoding’s name, e.g. @code{utf-8} or @code{latin-1}; the optional `errorhandler' part specifies what to do with characters that can’t be handled by the encoding, and should be one of “error”, “ignore”, or “replace”. (Contributed by Martin von Löwis.)

@c ======================================================================

@node Módulos Novos ou Aprimorados<2>,Deprecations and Removals,Outras mudanças na linguagem<15>,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 new-and-improved-modules}@anchor{1416}
@subsection Módulos Novos ou Aprimorados


Como em todas os lançamentos, a biblioteca padrão do Python recebeu diversas melhorias e correções de bugs. Aqui está uma lista parcial das mudanças mais notáveis, classificadas em ordem alfabética por nome do módulo. Consulte o arquivo @code{Misc/NEWS} na árvore de código-fonte para uma lista mais completa de alterações, ou procure nos logs do Subversion para todos os detalhes.


@itemize *

@item 
Os módulos @code{asyncore} e @code{asynchat} estão sendo mantidos ativamente novamente e várias correções e correções foram aplicadas. (Mantido por Josiah Carlson; veja bpo-1736190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1736190} para um patch.)

@item 
The @code{bsddb} module also has a new maintainer, Jesús Cea Avión, and the package is now available as a standalone package. The web page for the package is www.jcea.es/programacion/pybsddb.htm@footnote{https://www.jcea.es/programacion/pybsddb.htm}. The plan is to remove the package from the standard library in Python 3.0, because its pace of releases is much more frequent than Python’s.

The @code{bsddb.dbshelve} module now uses the highest pickling protocol
available, instead of restricting itself to protocol 1.
(Contributed by 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{8ce,,PendingDeprecationWarning} messages in 2.6
(bpo-600362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=600362}).

@item 
The @ref{18,,cmath} module underwent extensive revision,
contributed by Mark Dickinson and Christian Heimes.
Five new functions were added:


@itemize *

@item 
@code{polar()} converts a complex number to polar form, returning
the modulus and argument of the complex number.

@item 
@code{rect()} does the opposite, turning a modulus, argument pair
back into the corresponding complex number.

@item 
@code{phase()} returns the argument (also called the angle) of a complex
number.

@item 
@code{isnan()} returns True if either
the real or imaginary part of its argument is a NaN.

@item 
@code{isinf()} returns True if either the real or imaginary part of
its argument is infinite.
@end itemize

The revisions also improved the numerical soundness of the @ref{18,,cmath} module. For all functions, the real and imaginary parts of the results are accurate to within a few units of least precision (ulps) whenever possible. See bpo-1381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1381} for the details. The branch cuts for @code{asinh()}, @code{atanh()}: and @code{atan()} have also been corrected.

The tests for the module have been greatly expanded; nearly 2000 new
test cases exercise the algebraic functions.

On IEEE 754 platforms, the @ref{18,,cmath} module now handles IEEE 754
special values and floating-point exceptions in a manner consistent
with Annex ‘G’ of the C99 standard.

@item 
A new data type in the @ref{1d,,collections} module: @code{namedtuple(typename, fieldnames)}
is a factory function that creates subclasses of the standard tuple
whose fields are accessible by name as well as index.  For example:

@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

Several places in the standard library that returned tuples have
been modified to return @code{namedtuple()} instances.  For example,
the @code{Decimal.as_tuple()} method now returns a named tuple with
@code{sign}, @code{digits}, and @code{exponent} fields.

(Contributed by Raymond Hettinger.)

@item 
Another change to the @ref{1d,,collections} module is that the @code{deque} type now supports an optional `maxlen' parameter; if supplied, the deque’s size will be restricted to no more than `maxlen' items. Adding more items to a full deque causes old items to be discarded.

@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

(Contributed by Raymond Hettinger.)

@item 
The @ref{71,,Cookie} module’s @ref{c1e,,Morsel} objects now support an
@ref{1417,,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 
A new window method in the @ref{2b,,curses} module, @code{chgat()}, changes the display attributes for a certain number of characters on a single line. (Contributed by 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

The @code{Textbox} class in the @ref{2e,,curses.textpad} module
now supports editing in insert mode as well as overwrite mode.
Insert mode is enabled by supplying a true value for the `insert_mode'
parameter when creating the @code{Textbox} instance.

@item 
The @ref{30,,datetime} module’s @code{strftime()} methods now support a @code{%f} format code that expands to the number of microseconds in the object, zero-padded on the left to six places. (Contributed by Skip Montanaro; bpo-1158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1158}.)

@item 
The @ref{36,,decimal} module was updated to version 1.66 of
the General Decimal Specification@footnote{https://speleotrove.com/decimal/decarith.html}.  New features
include some methods for some basic mathematical functions such as
@code{exp()} and @code{log10()}:

@example
>>> Decimal(1).exp()
Decimal("2.718281828459045235360287471")
>>> Decimal("2.7182818").ln()
Decimal("0.9999999895305022877376682436")
>>> Decimal(1000).log10()
Decimal("3")
@end example

The @code{as_tuple()} method of @code{Decimal} objects now returns a
named tuple with @code{sign}, @code{digits}, and @code{exponent} fields.

(Implemented by Facundo Batista and Mark Dickinson. Named tuple support added by Raymond Hettinger.)

@item 
The @ref{37,,difflib} module’s @code{SequenceMatcher} class
now returns named tuples representing matches,
with @code{a}, @code{b}, and @code{size} attributes.
(Contributed by Raymond Hettinger.)

@item 
An optional @code{timeout} parameter, specifying a timeout measured in seconds, was added to the @ref{900,,ftplib.FTP} class constructor as well as the @code{connect()} method. (Added by Facundo Batista.) Also, the @code{FTP} class’s @code{storbinary()} and @code{storlines()} now take an optional `callback' parameter that will be called with each block of data after the data has been sent. (Contributed by Phil Schwartz; bpo-1221598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1221598}.)

@item 
The @code{reduce()} built-in function is also available in the @ref{5f,,functools} module. In Python 3.0, the builtin has been dropped and @code{reduce()} is only available from @ref{5f,,functools}; currently there are no plans to drop the builtin in the 2.x series. (Patched by Christian Heimes; bpo-1739906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739906}.)

@item 
When possible, the @ref{62,,getpass} module will now use @code{/dev/tty} to print a prompt message and read the password, falling back to standard error and standard input. If the password may be echoed to the terminal, a warning is printed before the prompt is displayed. (Contributed by Gregory P. Smith.)

@item 
The @ref{29f,,glob.glob()} function can now return Unicode filenames if a Unicode path was used and Unicode filenames are matched within the directory. (bpo-1001604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1001604})

@item 
A new function in the @ref{69,,heapq} module, @code{merge(iter1, iter2, ...)}, takes any number of iterables returning data in sorted order, and returns a new generator that returns the contents of all the iterators, also in sorted order. For example:

@example
>>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
[1, 2, 3, 5, 8, 9, 16]
@end example

Another new function, @code{heappushpop(heap, item)},
pushes `item' onto `heap', then pops off and returns the smallest item.
This is more efficient than making a call to @code{heappush()} and then
@code{heappop()}.

@ref{69,,heapq} is now implemented to only use less-than comparison,
instead of the less-than-or-equal comparison it previously used.
This makes @ref{69,,heapq}’s usage of a type match the
@ref{be8,,list.sort()} method.
(Contributed by Raymond Hettinger.)

@item 
An optional @code{timeout} parameter, specifying a timeout measured in
seconds, was added to the @ref{b53,,httplib.HTTPConnection} and
@ref{b54,,HTTPSConnection} class constructors.  (Added by Facundo
Batista.)

@item 
Most of the @ref{7e,,inspect} module’s functions, such as @code{getmoduleinfo()} and @code{getargs()}, now return named tuples. In addition to behaving like tuples, the elements of the return value can also be accessed as attributes. (Contributed by Raymond Hettinger.)

Some new functions in the module include
@code{isgenerator()}, @code{isgeneratorfunction()},
and @code{isabstract()}.

@item 
The @ref{81,,itertools} module gained several new functions.

@code{izip_longest(iter1, iter2, ...[, fillvalue])} makes tuples from each of the elements; if some of the iterables are shorter than others, the missing values are set to `fillvalue'. For example:

@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])} returns the Cartesian product
of the supplied iterables, a set of tuples containing
every possible combination of the elements returned from each 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

The optional `repeat' keyword argument is used for taking the product of an iterable or a set of iterables with themselves, repeated `N' times. With a single iterable argument, `N'-tuples are returned:

@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

With two iterables, `2N'-tuples are returned.

@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{combinations(iterable, r)} returns sub-sequences of length `r' from
the elements of `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{permutations(iter[, r])} returns all the permutations of length `r' of the iterable’s elements. If `r' is not specified, it will default to the number of elements produced by the 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)} is an existing function in @ref{81,,itertools} that gained a new constructor in Python 2.6. @code{itertools.chain.from_iterable(iterable)} takes a single iterable that should return other iterables. @code{chain()} will then return all the elements of the first iterable, then all the elements of the second, and so on.

@example
>>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
[1, 2, 3, 4, 5, 6]
@end example

(All contributed by Raymond Hettinger.)

@item 
The @ref{87,,logging} module’s @code{FileHandler} class and its subclasses @code{WatchedFileHandler}, @code{RotatingFileHandler}, and @code{TimedRotatingFileHandler} now have an optional `delay' parameter to their constructors. If `delay' is true, opening of the log file is deferred until the first @code{emit()} call is made. (Contributed by Vinay Sajip.)

@code{TimedRotatingFileHandler} also has a `utc' constructor parameter. If the argument is true, UTC time will be used in determining when midnight occurs and in generating filenames; otherwise local time will be used.

@item 
Several new functions were added to the @ref{8e,,math} module:


@itemize *

@item 
@ref{1418,,isinf()} and @ref{1419,,isnan()} determine whether a given float
is a (positive or negative) infinity or a NaN (Not a Number), respectively.

@item 
@ref{141a,,copysign()} copies the sign bit of an IEEE 754 number, returning the absolute value of `x' combined with the sign bit of `y'. For example, @code{math.copysign(1, -0.0)} returns -1.0. (Contributed by Christian Heimes.)

@item 
@ref{94e,,factorial()} computes the factorial of a number.
(Contributed by Raymond Hettinger; bpo-2138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2138}.)

@item 
@ref{141b,,fsum()} adds up the stream of numbers from an iterable,
and is careful to avoid loss of precision through using partial sums.
(Contributed by Jean Brouwers, Raymond Hettinger, and Mark Dickinson;
bpo-2819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2819}.)

@item 
@ref{141c,,acosh()}, @ref{141d,,asinh()}
and @ref{141e,,atanh()} compute the inverse hyperbolic functions.

@item 
@ref{141f,,log1p()} returns the natural logarithm of `1+x'
(base `e').

@item 
@code{trunc()} rounds a number toward zero, returning the closest
@code{Integral} that’s between the function’s argument and zero.
Added as part of the backport of
@ref{1300,,PEP 3141's type hierarchy for numbers}.
@end itemize

@item 
The @ref{8e,,math} module has been improved to give more consistent
behaviour across platforms, especially with respect to handling of
floating-point exceptions and IEEE 754 special values.

Whenever possible, the module follows the recommendations of the C99 standard about 754’s special values. For example, @code{sqrt(-1.)} should now give a @ref{202,,ValueError} across almost all platforms, while @code{sqrt(float('NaN'))} should return a NaN on all IEEE 754 platforms. Where Annex ‘F’ of the C99 standard recommends signaling ‘divide-by-zero’ or ‘invalid’, Python will raise @ref{202,,ValueError}. Where Annex ‘F’ of the C99 standard recommends signaling ‘overflow’, Python will raise @ref{885,,OverflowError}. (See bpo-711019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=711019} and bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640}.)

(Contributed by Christian Heimes and Mark Dickinson.)

@item 
@ref{20b,,mmap} objects now have a @code{rfind()} method that searches for a substring beginning at the end of the string and searching backwards. The @code{find()} method also gained an `end' parameter giving an index at which to stop searching. (Contributed by John Lenton.)

@item 
The @ref{9f,,operator} module gained a @code{methodcaller()} function that takes a name and an optional set of arguments, returning a callable that will call the named function on any arguments passed to it. For example:

@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

(Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)

The @code{attrgetter()} function now accepts dotted names and performs
the corresponding attribute lookups:

@example
>>> inst_name = operator.attrgetter(
...        '__class__.__name__')
>>> inst_name('@w{'})
'str'
>>> inst_name(help)
'_Helper'
@end example

(Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)

@item 
The @ref{a1,,os} module now wraps several new system calls. @code{fchmod(fd, mode)} and @code{fchown(fd, uid, gid)} change the mode and ownership of an opened file, and @code{lchmod(path, mode)} changes the mode of a symlink. (Contributed by Georg Brandl and Christian Heimes.)

@code{chflags()} and @code{lchflags()} are wrappers for the corresponding system calls (where they’re available), changing the flags set on a file. Constants for the flag values are defined in the @ref{d1,,stat} module; some possible values include @code{UF_IMMUTABLE} to signal the file may not be changed and @code{UF_APPEND} to indicate that data can only be appended to the file. (Contributed by M. Levinson.)

@code{os.closerange(low, high)} efficiently closes all file descriptors from `low' to `high', ignoring any errors and not including `high' itself. This function is now used by the @ref{d6,,subprocess} module to make starting processes faster. (Contributed by Georg Brandl; bpo-1663329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1663329}.)

@item 
The @code{os.environ} object’s @code{clear()} method will now unset the environment variables using @ref{921,,os.unsetenv()} in addition to clearing the object’s keys. (Contributed by Martin Horcicka; bpo-1181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1181}.)

@item 
The @ref{4a9,,os.walk()} function now has a @code{followlinks} parameter. If set to True, it will follow symlinks pointing to directories and visit the directory’s contents. For backward compatibility, the parameter’s default value is false. Note that the function can fall into an infinite recursion if there’s a symlink that points to a parent directory. (bpo-1273829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1273829})

@item 
In the @ref{a2,,os.path} module, the @code{splitext()} function
has been changed to not split on leading period characters.
This produces better results when operating on Unix’s dot-files.
For example, @code{os.path.splitext('.ipython')}
now returns @code{('.ipython', '@w{'})} instead of @code{('@w{'}, '.ipython')}.
(bpo-1115886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1115886})

A new function, @code{os.path.relpath(path, start='.')}, returns a relative path from the @code{start} path, if it’s supplied, or from the current working directory to the destination @code{path}. (Contributed by Richard Barran; bpo-1339796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1339796}.)

On Windows, @ref{1420,,os.path.expandvars()} will now expand environment variables given in the form “%var%”, and “~user” will be expanded into the user’s home directory path. (Contributed by Josiah Carlson; bpo-957650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957650}.)

@item 
The Python debugger provided by the @ref{a5,,pdb} module
gained a new command: “run” restarts the Python program being debugged
and can optionally take new command-line arguments for the program.
(Contributed by Rocky Bernstein; bpo-1393667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1393667}.)

@item 
The @ref{1421,,pdb.post_mortem()} function, used to begin debugging a traceback, will now use the traceback returned by @ref{68a,,sys.exc_info()} if no traceback is supplied. (Contributed by Facundo Batista; bpo-1106316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1106316}.)

@item 
The @ref{a7,,pickletools} module now has an @code{optimize()} function
that takes a string containing a pickle and removes some unused
opcodes, returning a shorter pickle that contains the same data structure.
(Contributed by Raymond Hettinger.)

@item 
A @code{get_data()} function was added to the @ref{a9,,pkgutil} module that returns the contents of resource files included with an installed Python package. For example:

@example
>>> import pkgutil
>>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StandardError
 ...
@end example

(Contributed by Paul Moore; bpo-2439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2439}.)

@item 
The @code{pyexpat} module’s @code{Parser} objects now allow setting
their @code{buffer_size} attribute to change the size of the buffer
used to hold character data.
(Contributed by Achim Gaedke; bpo-1137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1137}.)

@item 
The @code{Queue} module now provides queue variants that retrieve entries in different orders. The @code{PriorityQueue} class stores queued items in a heap and retrieves them in priority order, and @code{LifoQueue} retrieves the most recently added entries first, meaning that it behaves like a stack. (Contributed by Raymond Hettinger.)

@item 
The @ref{b8,,random} module’s @code{Random} objects can now be pickled on a 32-bit system and unpickled on a 64-bit system, and vice versa. Unfortunately, this change also means that Python 2.6’s @code{Random} objects can’t be unpickled correctly on earlier versions of Python. (Contributed by Shawn Ligocki; bpo-1727780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1727780}.)

The new @code{triangular(low, high, mode)} function returns random numbers following a triangular distribution. The returned values are between `low' and `high', not including `high' itself, and with `mode' as the most frequently occurring value in the distribution. (Contributed by Wladmir van der Laan and Raymond Hettinger; bpo-1681432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1681432}.)

@item 
Long regular expression searches carried out by the @ref{b9,,re} module will check for signals being delivered, so time-consuming searches can now be interrupted. (Contributed by Josh Hoyt and Ralf Schmitt; bpo-846388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=846388}.)

The regular expression module is implemented by compiling bytecodes for a tiny regex-specific virtual machine. Untrusted code could create malicious strings of bytecode directly and cause crashes, so Python 2.6 includes a verifier for the regex bytecode. (Contributed by Guido van Rossum from work for 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 
The @ref{bf,,sched} module’s @code{scheduler} instances now
have a read-only @ref{b6,,queue} attribute that returns the
contents of the scheduler’s queue, represented as a list of
named tuples with the fields @code{(time, priority, action, argument)}.
(Contributed by Raymond Hettinger; bpo-1861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1861}.)

@item 
The @ref{c1,,select} module now has wrapper functions
for the Linux @code{epoll()} and BSD @code{kqueue()} system calls.
@code{modify()} method was added to the existing @code{poll}
objects; @code{pollobj.modify(fd, eventmask)} takes a file descriptor
or file object and an event mask, modifying the recorded event mask
for that file.
(Contributed by Christian Heimes; bpo-1657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1657}.)

@item 
The @ref{a33,,shutil.copytree()} function now has an optional `ignore' argument that takes a callable object. This callable will receive each directory path and a list of the directory’s contents, and returns a list of names that will be ignored, not copied.

The @ref{c5,,shutil} module also provides an @code{ignore_patterns()} function for use with this new parameter. @code{ignore_patterns()} takes an arbitrary number of glob-style patterns and returns a callable that will ignore any files and directories that match any of these patterns. The following example copies a directory tree, but skips both @code{.svn} directories and Emacs backup files, which have names ending with ‘~’:

@example
shutil.copytree('Doc/library', '/tmp/library',
                ignore=shutil.ignore_patterns('*~', '.svn'))
@end example

(Contributed by Tarek Ziadé; bpo-2663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2663}.)

@item 
Integrating signal handling with GUI handling event loops like those used by Tkinter or GTk+ has long been a problem; most software ends up polling, waking up every fraction of a second to check if any GUI events have occurred. The @ref{c6,,signal} module can now make this more efficient. Calling @code{signal.set_wakeup_fd(fd)} sets a file descriptor to be used; when a signal is received, a byte is written to that file descriptor. There’s also a C-level function, @ref{1422,,PySignal_SetWakeupFd()}, for setting the descriptor.

Event loops will use this by opening a pipe to create two descriptors,
one for reading and one for writing.  The writable descriptor
will be passed to @code{set_wakeup_fd()}, and the readable descriptor
will be added to the list of descriptors monitored by the event loop via
@code{select()} or @code{poll()}.
On receiving a signal, a byte will be written and the main event loop
will be woken up, avoiding the need to poll.

(Contributed by Adam Olsen; bpo-1583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583}.)

The @code{siginterrupt()} function is now available from Python code,
and allows changing whether signals can interrupt system calls or not.
(Contributed by Ralf Schmitt.)

The @code{setitimer()} and @code{getitimer()} functions have also been added (where they’re available). @code{setitimer()} allows setting interval timers that will cause a signal to be delivered to the process after a specified time, measured in wall-clock time, consumed process time, or combined process+system time. (Contributed by Guilherme Polo; bpo-2240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2240}.)

@item 
The @ref{ca,,smtplib} module now supports SMTP over SSL thanks to the addition of the @code{SMTP_SSL} class. This class supports an interface identical to the existing @code{SMTP} class. (Contributed by Monty Taylor.) Both class constructors also have an optional @code{timeout} parameter that specifies a timeout for the initial connection attempt, measured in seconds. (Contributed by Facundo Batista.)

An implementation of the LMTP protocol (
@geindex RFC; RFC 2033
RFC 2033@footnote{https://datatracker.ietf.org/doc/html/rfc2033.html}) was also added to the module. LMTP is used in place of SMTP when transferring e-mail between agents that don’t manage a mail queue. (LMTP implemented by Leif Hedstrom; bpo-957003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957003}.)

@code{SMTP.starttls()} now complies with 
@geindex RFC; RFC 3207
RFC 3207@footnote{https://datatracker.ietf.org/doc/html/rfc3207.html} and forgets any knowledge obtained from the server not obtained from the TLS negotiation itself. (Patch contributed by Bill Fenner; bpo-829951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=829951}.)

@item 
The @ref{cc,,socket} module now supports TIPC (@indicateurl{https://tipc.sourceforge.net/}),
a high-performance non-IP-based protocol designed for use in clustered
environments.  TIPC addresses are 4- or 5-tuples.
(Contributed by Alberto Bertogli; bpo-1646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1646}.)

A new function, @code{create_connection()}, takes an address and connects to it using an optional timeout value, returning the connected socket object. This function also looks up the address’s type and connects to it using IPv4 or IPv6 as appropriate. Changing your code to use @code{create_connection()} instead of @code{socket(socket.AF_INET, ...)} may be all that’s required to make your code work with IPv6.

@item 
The base classes in the @ref{cd,,SocketServer} module now support
calling a @ref{1366,,handle_timeout()} method after a span of inactivity
specified by the server’s @ref{1365,,timeout} attribute.  (Contributed
by Michael Pomraning.)  The @ref{117e,,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 
The @ref{cf,,sqlite3} module, maintained by Gerhard Häring,
has been updated from version 2.3.2 in Python 2.5 to
version 2.4.1.

@item 
The @ref{d5,,struct} module now supports the C99 _Bool type,
using the format character @code{'?'}.
(Contributed by David Remahl.)

@item 
The @ref{199,,Popen} objects provided by the @ref{d6,,subprocess} module
now have @ref{1423,,terminate()}, @ref{1424,,kill()}, and @ref{1425,,send_signal()} methods.
On Windows, @code{send_signal()} only supports the @ref{1426,,SIGTERM}
signal, and all these methods are aliases for the Win32 API function
@code{TerminateProcess()}.
(Contributed by Christian Heimes.)

@item 
A new variable in the @ref{d9,,sys} module, @code{float_info}, is an object containing information derived from the @code{float.h} file about the platform’s floating-point support. Attributes of this object include @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}.)

Another new variable, @code{dont_write_bytecode}, controls whether Python writes any @code{.pyc} or @code{.pyo} files on importing a module. If this variable is true, the compiled files are not written. The variable is initially set on start-up by supplying the @ref{1414,,-B} switch to the Python interpreter, or by setting the 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE} environment variable before running the interpreter. Python code can subsequently change the value of this variable to control whether bytecode files are written or not. (Contributed by Neal Norwitz and Georg Brandl.)

Information about the command-line arguments supplied to the Python interpreter is available by reading attributes of a named tuple available as @code{sys.flags}. For example, the @code{verbose} attribute is true if Python was executed in verbose mode, @code{debug} is true in debugging mode, etc. These attributes are all read-only. (Contributed by Christian Heimes.)

A new function, @code{getsizeof()}, takes a Python object and returns the amount of memory used by the object, measured in bytes. Built-in objects return correct results; third-party extensions may not, but can define a @code{__sizeof__()} method to return the object’s size. (Contributed by Robert Schuppenies; bpo-2898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2898}.)

It’s now possible to determine the current profiler and tracer functions
by calling @ref{1427,,sys.getprofile()} and @ref{1428,,sys.gettrace()}.
(Contributed by Georg Brandl; bpo-1648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1648}.)

@item 
The @ref{de,,tarfile} module now supports POSIX.1-2001 (pax) tarfiles in addition to the POSIX.1-1988 (ustar) and GNU tar formats that were already supported. The default format is GNU tar; specify the @code{format} parameter to open a file using a different format:

@example
tar = tarfile.open("output.tar", "w",
                   format=tarfile.PAX_FORMAT)
@end example

The new @code{encoding} and @code{errors} parameters specify an encoding and an error handling scheme for character conversions. @code{'strict'}, @code{'ignore'}, and @code{'replace'} are the three standard ways Python can handle errors,; @code{'utf-8'} is a special value that replaces bad characters with their UTF-8 representation. (Character conversions occur because the PAX format supports Unicode filenames, defaulting to UTF-8 encoding.)

The @code{TarFile.add()} method now accepts an @code{exclude} argument that’s
a function that can be used to exclude certain filenames from
an archive.
The function must take a filename and return true if the file
should be excluded or false if it should be archived.
The function is applied to both the name initially passed to @code{add()}
and to the names of files in recursively added directories.

(All changes contributed by 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 
The @ref{4c6,,tempfile.NamedTemporaryFile} class usually deletes the temporary file it created when the file is closed. This behaviour can now be changed by passing @code{delete=False} to the constructor. (Contributed by Damien Miller; bpo-1537850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537850}.)

A new class, @code{SpooledTemporaryFile}, behaves like a temporary file but stores its data in memory until a maximum size is exceeded. On reaching that limit, the contents will be written to an on-disk temporary file. (Contributed by Dustin J. Mitchell.)

The @code{NamedTemporaryFile} and @code{SpooledTemporaryFile} classes
both work as context managers, so you can write
@code{with tempfile.NamedTemporaryFile() as tmp: ...}.
(Contributed by 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{1429,,EnvironmentVarGuard()} is a
context manager that temporarily changes environment variables and
automatically restores them to their old values.

Another context manager, @code{TransientResource}, can surround calls to resources that may or may not be available; it will catch and ignore a specified list of exceptions. For example, a network test may ignore certain failures when connecting to an external web site:

@example
with test_support.TransientResource(IOError,
                                errno=errno.ETIMEDOUT):
    f = urllib.urlopen('https://sf.net')
    ...
@end example

Finally, @code{check_warnings()} resets the @code{warning} module’s
warning filters and returns an object that will record all warning
messages triggered (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

(Contributed by Brett Cannon.)

@item 
The @ref{ec,,textwrap} module can now preserve existing whitespace
at the beginnings and ends of the newly created lines
by specifying @code{drop_whitespace=False}
as an argument:

@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

(Contributed by Dwayne Bailey; bpo-1581073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1581073}.)

@item 
The @ref{ed,,threading} module API is being changed to use properties such as @code{daemon} instead of @code{setDaemon()} and @code{isDaemon()} methods, and some methods have been renamed to use underscores instead of camel-case; for example, the @code{activeCount()} method is renamed to @code{active_count()}. Both the 2.6 and 3.0 versions of the module support the same properties and renamed methods, but don’t remove the old methods. No date has been set for the deprecation of the old APIs in Python 3.x; the old APIs won’t be removed in any 2.x version. (Carried out by several people, most notably Benjamin Peterson.)

The @ref{ed,,threading} module’s @code{Thread} objects gained an @code{ident} property that returns the thread’s identifier, a nonzero integer. (Contributed by Gregory P. Smith; bpo-2871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2871}.)

@item 
The @ref{ef,,timeit} module now accepts callables as well as strings
for the statement being timed and for the setup code.
Two convenience functions were added for creating
@code{Timer} instances:
@code{repeat(stmt, setup, time, repeat, number)} and
@code{timeit(stmt, setup, time, number)} create an instance and call
the corresponding method. (Contributed by Erik Demaine;
bpo-1533909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533909}.)

@item 
The @code{Tkinter} module now accepts lists and tuples for options,
separating the elements by spaces before passing the resulting value to
Tcl/Tk.
(Contributed by Guilherme Polo; bpo-2906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2906}.)

@item 
The @ref{101,,turtle} module for turtle graphics was greatly enhanced by Gregor Lingl. New features in the module include:


@itemize *

@item 
Better animation of turtle movement and rotation.

@item 
Control over turtle movement using the new @code{delay()},
@code{tracer()}, and @code{speed()} methods.

@item 
The ability to set new shapes for the turtle, and to
define a new coordinate system.

@item 
Turtles now have an @code{undo()} method that can roll back actions.

@item 
Simple support for reacting to input events such as mouse and keyboard
activity, making it possible to write simple games.

@item 
A @code{turtle.cfg} file can be used to customize the starting appearance
of the turtle’s screen.

@item 
The module’s docstrings can be replaced by new docstrings that have been
translated into another language.
@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{293,,urllib.urlopen} function and the
@code{urllib.ftpwrapper} class constructor, as well as the
@ref{293,,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

(Added by Facundo Batista.)

@item 
The Unicode database provided by the @ref{105,,unicodedata} module has been updated to version 5.1.0. (Updated by Martin von Löwis; bpo-3811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3811}.)

@item 
The @ref{112,,warnings} module’s @code{formatwarning()} and @code{showwarning()} gained an optional `line' argument that can be used to supply the line of source code. (Added as part of bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171}, which re-implemented part of the @ref{112,,warnings} module in C code.)

A new function, @code{catch_warnings()}, is a context manager
intended for testing purposes that lets you temporarily modify the
warning filters and then restore their original values (bpo-3781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3781}).

@item 
The XML-RPC @ref{12f,,SimpleXMLRPCServer} and @ref{12f,,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} also has a @code{_send_traceback_header} attribute; if true, the exception and formatted traceback are returned as HTTP headers “X-Exception” and “X-Traceback”. This feature is for debugging purposes only and should not be used on production servers because the tracebacks might reveal passwords or other sensitive information. (Contributed by Alan McIntyre as part of his project for Google’s Summer of Code 2007.)

@item 
The @ref{12e,,xmlrpclib} module no longer automatically converts
@ref{1cd,,datetime.date} and @ref{1ce,,datetime.time} to the
@ref{142a,,xmlrpclib.DateTime} type; the conversion semantics were
not necessarily correct for all applications.  Code using
@code{xmlrpclib} should convert @code{date} and @ref{1ce,,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 
The @ref{131,,zipfile} module’s @code{ZipFile} class now has
@code{extract()} and @code{extractall()} methods that will unpack
a single file or all the files in the archive to the current directory, or
to a specified directory:

@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

(Contributed by Alan McIntyre; bpo-467924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=467924}.)

The @ref{51c,,open()}, @code{read()} and @code{extract()} methods can now take either a filename or a @code{ZipInfo} object. This is useful when an archive accidentally contains a duplicated filename. (Contributed by Graham Horler; bpo-1775025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1775025}.)

Finally, @ref{131,,zipfile} now supports using Unicode filenames for archived files. (Contributed by 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
* The ast module:: 
* The future_builtins module:: 
* The json module; JavaScript Object Notation: The json module JavaScript Object Notation. 
* The plistlib module; A Property-List Parser: The plistlib module A Property-List Parser. 
* ctypes Enhancements:: 
* Improved SSL Support:: 

@end menu

@node The ast module,The future_builtins module,,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 the-ast-module}@anchor{142b}
@subsubsection The @code{ast} module


The @ref{8,,ast} module provides an Abstract Syntax Tree representation of Python code, and Armin Ronacher contributed a set of helper functions that perform a variety of common tasks. These will be useful for HTML templating packages, code analyzers, and similar tools that process Python code.

The @code{parse()} function takes an expression and returns an AST.
The @code{dump()} function outputs a representation of a tree, suitable
for debugging:

@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

This outputs a deeply nested tree:

@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

The @code{literal_eval()} method takes a string or an AST representing a literal expression, parses and evaluates it, and returns the resulting value. A literal expression is a Python expression containing only strings, numbers, dictionaries, etc. but no statements or function calls. If you need to evaluate an expression but cannot accept the security risk of using an @ref{180,,eval()} call, @code{literal_eval()} will handle it safely:

@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

The module also includes @code{NodeVisitor} and
@code{NodeTransformer} classes for traversing and modifying an AST,
and functions for common transformations such as changing line
numbers.

@c ======================================================================

@node The future_builtins module,The json module JavaScript Object Notation,The ast module,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 the-future-builtins-module}@anchor{142c}
@subsubsection The @code{future_builtins} module


Python 3.0 makes many changes to the repertoire of built-in
functions, and most of the changes can’t be introduced in the Python
2.x series because they would break compatibility.
The @code{future_builtins} module provides versions
of these built-in functions that can be imported when writing
3.0-compatible code.

The functions in this module currently include:


@itemize *

@item 
@code{ascii(obj)}: equivalent to @ref{800,,repr()}. In Python 3.0, @ref{800,,repr()} will return a Unicode string, while @ref{142d,,ascii()} will return a pure ASCII bytestring.

@item 
@code{filter(predicate, iterable)},
@code{map(func, iterable1, ...)}: the 3.0 versions
return iterators, unlike the 2.x builtins which return lists.

@item 
@code{hex(value)}, @code{oct(value)}: instead of calling the @code{__hex__()} or @code{__oct__()} methods, these versions will call the @code{__index__()} method and convert the result to hexadecimal or octal. @ref{1311,,oct()} will use the new @code{0o} notation for its result.
@end itemize

@c ======================================================================

@node The json module JavaScript Object Notation,The plistlib module A Property-List Parser,The future_builtins module,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 the-json-module-javascript-object-notation}@anchor{142e}
@subsubsection The @code{json} module: JavaScript Object Notation


The new @ref{82,,json} module supports the encoding and decoding of Python types in
JSON (Javascript Object Notation). JSON is a lightweight interchange format
often used in web applications. For more information about JSON, see
@indicateurl{http://www.json.org}.

@ref{82,,json} comes with support for decoding and encoding most built-in Python
types. The following example encodes and decodes a dictionary:

@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

It’s also possible to write your own decoders and encoders to support
more types. Pretty-printing of the JSON strings is also supported.

@ref{82,,json} (originally called simplejson) was written by Bob
Ippolito.

@c ======================================================================

@node The plistlib module A Property-List Parser,ctypes Enhancements,The json module JavaScript Object Notation,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 the-plistlib-module-a-property-list-parser}@anchor{142f}
@subsubsection The @code{plistlib} module: A Property-List Parser


The @code{.plist} format is commonly used on Mac OS X to
store basic data types (numbers, strings, lists,
and dictionaries) by serializing them into an XML-based format.
It resembles the XML-RPC serialization of data types.

Despite being primarily used on Mac OS X, the format
has nothing Mac-specific about it and the Python implementation works
on any platform that Python supports, so the @ref{ab,,plistlib} module
has been promoted to the standard library.

Using the module is simple:

@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 ctypes Enhancements,Improved SSL Support,The plistlib module A Property-List Parser,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 ctypes-enhancements}@anchor{1430}
@subsubsection ctypes Enhancements


Thomas Heller continued to maintain and enhance the
@ref{2a,,ctypes} module.

@ref{2a,,ctypes} now supports a @code{c_bool} datatype that represents the C99 @code{bool} type. (Contributed by David Remahl; bpo-1649190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1649190}.)

The @ref{2a,,ctypes} string, buffer and array types have improved
support for extended slicing syntax,
where various combinations of @code{(start, stop, step)} are supplied.
(Implemented by Thomas Wouters.)

@c Revision 57769

All @ref{2a,,ctypes} data types now support @code{from_buffer()} and @code{from_buffer_copy()} methods that create a ctypes instance based on a provided buffer object. @code{from_buffer_copy()} copies the contents of the object, while @code{from_buffer()} will share the same memory area.

A new calling convention tells @ref{2a,,ctypes} to clear the @code{errno} or
Win32 LastError variables at the outset of each wrapped call.
(Implemented by Thomas Heller; bpo-1798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1798}.)

You can now retrieve the Unix @code{errno} variable after a function call. When creating a wrapped function, you can supply @code{use_errno=True} as a keyword parameter to the @code{DLL()} function and then call the module-level methods @code{set_errno()} and @code{get_errno()} to set and retrieve the error value.

The Win32 LastError variable is similarly supported by
the @code{DLL()}, @code{OleDLL()}, and @code{WinDLL()} functions.
You supply @code{use_last_error=True} as a keyword parameter
and then call the module-level methods @code{set_last_error()}
and @code{get_last_error()}.

The @code{byref()} function, used to retrieve a pointer to a ctypes
instance, now has an optional `offset' parameter that is a byte
count that will be added to the returned pointer.

@c ======================================================================

@node Improved SSL Support,,ctypes Enhancements,Módulos Novos ou Aprimorados<2>
@anchor{whatsnew/2 6 improved-ssl-support}@anchor{1431}
@subsubsection Improved SSL Support


Bill Janssen made extensive improvements to Python 2.6’s support for the Secure Sockets Layer by adding a new module, @ref{d0,,ssl}, that’s built atop the OpenSSL@footnote{https://www.openssl.org/} library. This new module provides more control over the protocol negotiated, the X.509 certificates used, and has better support for writing SSL servers (as opposed to clients) in Python. The existing SSL support in the @ref{cc,,socket} module hasn’t been removed and continues to work, though it will be removed in Python 3.0.

To use the new module, you must first create a TCP connection in the
usual way and then pass it to the @code{ssl.wrap_socket()} function.
It’s possible to specify whether a certificate is required, and to
obtain certificate info by calling the @code{getpeercert()} method.


@subsubheading Ver também


The documentation for the @ref{d0,,ssl} module.


@c ======================================================================

@node Deprecations and Removals,Mudanças a construções e API C<9>,Módulos Novos ou Aprimorados<2>,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 deprecations-and-removals}@anchor{1432}
@subsection Deprecations and Removals



@itemize *

@item 
String exceptions have been removed. Attempting to use them raises a @ref{2c3,,TypeError}.

@item 
Changes to the @ref{9e2,,Exception} interface
as dictated by 
@geindex Propostas de Melhorias do Python; 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{56c,,args} attribute.

@item 
(3.0-warning mode) Python 3.0 will feature a reorganized standard
library that will drop many outdated modules and rename others.
Python 2.6 running in 3.0-warning mode will warn about these modules
when they are imported.

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{3b,,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{1433,,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{5d9,,set} and @ref{5da,,frozenset} types.

@item 
The @code{sha} module has been deprecated; use the @ref{68,,hashlib} module
instead.
@end itemize

@c ======================================================================

@node Mudanças a construções e API C<9>,Porting to Python 2 6,Deprecations and Removals,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 build-and-c-api-changes}@anchor{1434}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
Python now must be compiled with C89 compilers (after 19
years!).  This means that the Python source tree has dropped its
own implementations of @code{memmove()} and @code{strerror()}, which
are in the C89 standard library.

@item 
Python 2.6 can be built with Microsoft Visual Studio 2008 (version 9.0), and this is the new default compiler. See the @code{PCbuild} directory for the build files. (Implemented by Christian Heimes.)

@item 
On Mac OS X, Python 2.6 can be compiled as a 4-way universal build.
The @code{configure} script
can take a @code{--with-universal-archs=[32-bit|64-bit|all]}
switch, controlling whether the binaries are built for 32-bit
architectures (x86, PowerPC), 64-bit (x86-64 and PPC-64), or both.
(Contributed by 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.

Esta função foi adicionada para fechar uma falha de segurança em aplicativos que incorporam Python. A função antiga, @code{PySys_SetArgv()}, sempre atualizava @code{sys.path}, e às vezes adicionava o diretório atual. Isso significava que, se você executasse uma aplicação incorporando Python em um diretório controlado por outra pessoa, os invasores poderiam colocar um módulo cavalo de Troia no diretório (digamos, um arquivo chamado @code{os.py}) que sua aplicação então usaria. importar e executar.

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 
The BerkeleyDB module now has a C API object, available as @code{bsddb.db.api}. This object can be used by other C extensions that wish to use the @code{bsddb} module for their own purposes. (Contributed by Duncan Grisby.)

@item 
The new buffer interface, previously described in
@ref{13fb,,the PEP 3118 section},
adds @ref{399,,PyObject_GetBuffer()} and @ref{39a,,PyBuffer_Release()},
as well as a few other functions.

@item 
Python’s use of the C stdio library is now thread-safe, or at least
as thread-safe as the underlying library is.  A long-standing potential
bug occurred if one thread closed a file object while another thread
was reading from or writing to the object.  In 2.6 file objects
have a reference count, manipulated by the
@code{PyFile_IncUseCount()} and @code{PyFile_DecUseCount()}
functions.  File objects can’t be closed unless the reference count
is zero.  @code{PyFile_IncUseCount()} should be called while the GIL
is still held, before carrying out an I/O operation using the
@code{FILE *} pointer, and @code{PyFile_DecUseCount()} should be called
immediately after the GIL is re-acquired.
(Contributed by Antoine Pitrou and Gregory P. Smith.)

@item 
Importing modules simultaneously in two different threads no longer deadlocks; it will now raise an @ref{419,,ImportError}. A new API function, @ref{3bd,,PyImport_ImportModuleNoBlock()}, will look for a module in @code{sys.modules} first, then try to import it after acquiring an import lock. If the import lock is held by another thread, an @ref{419,,ImportError} is raised. (Contributed by Christian Heimes.)

@item 
Several functions return information about the platform’s
floating-point support.  @ref{1435,,PyFloat_GetMax()} returns
the maximum representable floating-point value,
and @ref{1436,,PyFloat_GetMin()} returns the minimum
positive value.  @ref{1437,,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 
C functions and methods that use @ref{1438,,PyComplex_AsCComplex()} will now accept arguments that have a @code{__complex__()} method. In particular, the functions in the @ref{18,,cmath} module will now accept objects with this method. This is a backport of a Python 3.0 change. (Contributed by Mark Dickinson; bpo-1675423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1675423}.)

@item 
Python’s C API now includes two functions for case-insensitive string
comparisons, @code{PyOS_stricmp(char*, char*)}
and @code{PyOS_strnicmp(char*, char*, Py_ssize_t)}.
(Contributed by Christian Heimes; bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}.)

@item 
Many C extensions define their own little macro for adding integers and strings to the module’s dictionary in the @code{init*} function. Python 2.6 finally defines standard macros for adding values to a module, @ref{1439,,PyModule_AddStringMacro} and @ref{143a,,PyModule_AddIntMacro()}. (Contributed by Christian Heimes.)

@item 
Some macros were renamed in both 3.0 and 2.6 to make it clearer that
they are macros,
not functions.  @code{Py_Size()} became @ref{782,,Py_SIZE()},
@code{Py_Type()} became @ref{780,,Py_TYPE()}, and
@code{Py_Refcnt()} became @ref{8ae,,Py_REFCNT()}.
The mixed-case macros are still available
in Python 2.6 for backward compatibility.
(bpo-1629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1629})

@item 
Distutils now places C extensions it builds in a
different directory when running on a debug version of Python.
(Contributed by Collin Winter; bpo-1530959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1530959}.)

@item 
Several basic data types, such as integers and strings, maintain internal free lists of objects that can be re-used. The data structures for these free lists now follow a naming convention: the variable is always named @code{free_list}, the counter is always named @code{numfree}, and a macro @code{Py<typename>_MAXFREELIST} is always defined.

@item 
A new Makefile target, “make patchcheck”, prepares the Python source tree
for making a patch: it fixes trailing whitespace in all modified
@code{.py} files, checks whether the documentation has been changed,
and reports whether the @code{Misc/ACKS} and @code{Misc/NEWS} files
have been updated.
(Contributed by Brett Cannon.)

Another new target, “make profile-opt”, compiles a Python binary using GCC’s profile-guided optimization. It compiles Python with profiling enabled, runs the test suite to obtain a set of profiling results, and then compiles using these results for optimization. (Contributed by Gregory P. Smith.)
@end itemize

@c ======================================================================

@menu
* Alterações específicas da porta; Windows: Alterações específicas da porta Windows<2>. 
* Alterações específicas da porta; Mac OS X: Alterações específicas da porta Mac OS X<2>. 
* Port-Specific Changes; IRIX: Port-Specific Changes IRIX. 

@end menu

@node Alterações específicas da porta Windows<2>,Alterações específicas da porta Mac OS X<2>,,Mudanças a construções e API C<9>
@anchor{whatsnew/2 6 port-specific-changes-windows}@anchor{143b}
@subsubsection Alterações específicas da porta: Windows



@itemize *

@item 
The support for Windows 95, 98, ME and NT4 has been dropped.
Python 2.6 requires at least Windows 2000 SP4.

@item 
The new default compiler on Windows is Visual Studio 2008 (version 9.0). The build directories for Visual Studio 2003 (version 7.1) and 2005 (version 8.0) were moved into the PC/ directory. The new @code{PCbuild} directory supports cross compilation for X64, debug builds and Profile Guided Optimization (PGO). PGO builds are roughly 10% faster than normal builds. (Contributed by Christian Heimes with help from Amaury Forgeot d’Arc and 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{143c,,getwch()} function reads a keypress and returns a Unicode
value, as does the @ref{143d,,getwche()} function.  The @ref{143e,,putwch()} function
takes a Unicode character and writes it to the console.
(Contributed by Christian Heimes.)

@item 
@ref{1420,,os.path.expandvars()} will now expand environment variables in the form “%var%”, and “~user” will be expanded into the user’s home directory path. (Contributed by 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{cf3,,ioctl()} method that provides a limited interface to the
@code{WSAIoctl()} system interface.

@item 
The @ref{116,,_winreg} module now has a function,
@ref{143f,,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{5d2,,with} statements. (Contributed by Christian Heimes.)

@ref{116,,_winreg} also has better support for x64 systems,
exposing the @ref{13ab,,DisableReflectionKey()}, @ref{13ac,,EnableReflectionKey()},
and @ref{13ad,,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 Alterações específicas da porta Mac OS X<2>,Port-Specific Changes IRIX,Alterações específicas da porta Windows<2>,Mudanças a construções e API C<9>
@anchor{whatsnew/2 6 port-specific-changes-mac-os-x}@anchor{1440}
@subsubsection Alterações específicas da porta: Mac OS X



@itemize *

@item 
When compiling a framework build of Python, you can now specify the
framework name to be used by providing the
@code{--with-framework-name=} option to the
@code{configure} script.

@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 Port-Specific Changes IRIX,,Alterações específicas da porta Mac OS X<2>,Mudanças a construções e API C<9>
@anchor{whatsnew/2 6 port-specific-changes-irix}@anchor{1441}
@subsubsection Port-Specific Changes: 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 Porting to Python 2 6,Reconhecimentos<2>,Mudanças a construções e API C<9>,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 porting-to-python-2-6}@anchor{1442}
@subsection Porting to Python 2.6


Esta seção lista as alterações descritas anteriormente e outras correções que podem exigir alterações no seu código.


@itemize *

@item 
Classes that aren’t supposed to be hashable should
set @code{__hash__ = None} in their definitions to indicate
the fact.

@item 
String exceptions have been removed. Attempting to use them raises a @ref{2c3,,TypeError}.

@item 
The @code{__init__()} method of @ref{5dc,,collections.deque} now clears any existing contents of the deque before adding elements from the iterable. This change makes the behavior match @code{list.__init__()}.

@item 
@ref{6b0,,object.__init__()} previously accepted arbitrary arguments and keyword arguments, ignoring them. In Python 2.6, this is no longer allowed and will result in a @ref{2c3,,TypeError}. This will affect @code{__init__()} methods that end up calling the corresponding method on @ref{a96,,object} (perhaps through using @ref{4db,,super()}). See bpo-1683368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1683368} for discussion.

@item 
The @code{Decimal} constructor now accepts leading and trailing whitespace when passed a string. Previously it would raise an @code{InvalidOperation} exception. On the other hand, the @code{create_decimal()} method of @code{Context} objects now explicitly disallows extra whitespace, raising a @code{ConversionSyntax} exception.

@item 
Due to an implementation accident, if you passed a file path to the built-in @ref{8da,,__import__()} function, it would actually import the specified file. This was never intended to work, however, and the implementation now explicitly checks for this case and raises an @ref{419,,ImportError}.

@item 
C API: the @ref{1443,,PyImport_Import()} and @ref{3be,,PyImport_ImportModule()}
functions now default to absolute imports, not relative imports.
This will affect C extensions that import other modules.

@item 
C API: extension data types that shouldn’t be hashable
should define their @code{tp_hash} slot to
@ref{140d,,PyObject_HashNotImplemented()}.

@item 
The @ref{cc,,socket} module exception @ref{108e,,socket.error} now inherits from @ref{108b,,IOError}. Previously it wasn’t a subclass of @code{StandardError} but now it is, through @ref{108b,,IOError}. (Implemented by Gregory P. Smith; bpo-1706815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1706815}.)

@item 
The @ref{12e,,xmlrpclib} module no longer automatically converts
@ref{1cd,,datetime.date} and @ref{1ce,,datetime.time} to the
@ref{142a,,xmlrpclib.DateTime} type; the conversion semantics were
not necessarily correct for all applications.  Code using
@code{xmlrpclib} should convert @code{date} and @ref{1ce,,time}
instances. (bpo-1330538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1330538})

@item 
(3.0-warning mode) The @ref{9e2,,Exception} class now warns
when accessed using slicing or index access; having
@ref{9e2,,Exception} behave like a tuple is being phased out.

@item 
(3.0-warning mode) inequality comparisons between two dictionaries or two objects that don’t implement comparison methods are reported as warnings. @code{dict1 == dict2} still works, but @code{dict1 < dict2} is being phased out.

Comparisons between cells, which are an implementation detail of Python’s
scoping rules, also cause warnings because such comparisons are forbidden
entirely in 3.0.
@end itemize

Para aplicações que incorporam 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 Reconhecimentos<2>,,Porting to Python 2 6,O que há de novo no Python 2 6
@anchor{whatsnew/2 6 acknowledgements}@anchor{1444}@anchor{whatsnew/2 6 acks}@anchor{1445}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions, corrections and assistance with various drafts of this article: Georg Brandl, Steve Brown, Nick Coghlan, Ralph Corderoy, Jim Jewett, Kent Johnson, Chris Lambacher, Martin Michlmayr, Antoine Pitrou, Brian Warner.

@node What’s New in Python 2 5,What’s New in Python 2 4,O que há de novo no Python 2 6,O que há de novo no Python
@anchor{whatsnew/2 5 doc}@anchor{1446}@anchor{whatsnew/2 5 translation-repo}@anchor{1447}@anchor{whatsnew/2 5 what-s-new-in-python-2-5}@anchor{1448}
@section What’s New in Python 2.5


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew25.tex 56611 2007-07-29 08:26:10Z georg.brandl $

@c Fix XXX comments

This article explains the new features in Python 2.5.  The final release of
Python 2.5 is scheduled for August 2006; 
@geindex Propostas de Melhorias do Python; PEP 356
PEP 356@footnote{https://peps.python.org/pep-0356/} describes the planned
release schedule.  Python 2.5 was released on September 19, 2006.

The changes in Python 2.5 are an interesting mix of language and library
improvements. The library enhancements will be more important to Python’s user
community, I think, because several widely useful packages were added.  New
modules include ElementTree for XML processing (@code{xml.etree}),
the SQLite database module (@code{sqlite}), and the @ref{2a,,ctypes}
module for calling C functions.

The language changes are of middling significance.  Some pleasant new features
were added, but most of them aren’t features that you’ll use every day.
Conditional expressions were finally added to the language using a novel syntax;
see section @ref{1449,,PEP 308; Conditional Expressions}.  The new ‘@ref{5d2,,with}’ statement will make
writing cleanup code easier (section @ref{144a,,PEP 343; The ‘with’ statement}).  Values can now be passed
into generators (section @ref{144b,,PEP 342; New Generator Features}).  Imports are now visible as either
absolute or relative (section @ref{144c,,PEP 328; Absolute and Relative Imports}).  Some corner cases of exception
handling are handled better (section @ref{144d,,PEP 341; Unified try/except/finally}).  All these improvements
are worthwhile, but they’re improvements to one specific language feature or
another; none of them are broad modifications to Python’s semantics.

As well as the language and library additions, other improvements and bugfixes
were made throughout the source tree.  A search through the SVN change logs
finds there were 353 patches applied and 458 bugs fixed between Python 2.4 and
2.5.  (Both figures are likely to be underestimates.)

This article doesn’t try to be a complete specification of the new features;
instead changes are briefly introduced using helpful examples.  For full
details, you should always refer to the documentation for Python 2.5 at
@indicateurl{https://docs.python.org}. If you want to understand the complete implementation
and design rationale, refer to the PEP for a particular new feature.

Comments, suggestions, and error reports for this document are welcome; please
e-mail them to the author or open a bug in the Python bug tracker.

@c ======================================================================

@menu
* PEP 308; Conditional Expressions: PEP 308 Conditional Expressions. 
* PEP 309; Partial Function Application: PEP 309 Partial Function Application. 
* PEP 314; Metadata for Python Software Packages v1.1: PEP 314 Metadata for Python Software Packages v1 1. 
* PEP 328; Absolute and Relative Imports: PEP 328 Absolute and Relative Imports. 
* PEP 338; Executing Modules as Scripts: PEP 338 Executing Modules as Scripts. 
* PEP 341; Unified try/except/finally: PEP 341 Unified try/except/finally. 
* PEP 342; New Generator Features: PEP 342 New Generator Features. 
* PEP 343; The ‘with’ statement: PEP 343 The ‘with’ statement<2>. 
* PEP 352; Exceptions as New-Style Classes: PEP 352 Exceptions as New-Style Classes. 
* PEP 353; Using ssize_t as the index type: PEP 353 Using ssize_t as the index type. 
* PEP 357; The ‘__index__’ method: PEP 357 The ‘__index__’ method. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<16>. 
* New@comma{} Improved@comma{} and Removed Modules: New Improved and Removed Modules. 
* Mudanças a construções e API C: Mudanças a construções e API C<10>. 
* Porting to Python 2.5: Porting to Python 2 5. 
* Reconhecimentos: Reconhecimentos<3>. 

@end menu

@node PEP 308 Conditional Expressions,PEP 309 Partial Function Application,,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-308}@anchor{1449}@anchor{whatsnew/2 5 pep-308-conditional-expressions}@anchor{144e}
@subsection PEP 308: Conditional Expressions


For a long time, people have been requesting a way to write conditional
expressions, which are expressions that return value A or value B depending on
whether a Boolean value is true or false.  A conditional expression lets you
write a single assignment statement that has the same effect as the following:

@example
if condition:
    x = true_value
else:
    x = false_value
@end example

There have been endless tedious discussions of syntax on both python-dev and
comp.lang.python.  A vote was even held that found the majority of voters wanted
conditional expressions in some form, but there was no syntax that was preferred
by a clear majority. Candidates included C’s @code{cond ? true_v : false_v}, @code{if
cond then true_v else false_v}, and 16 other variations.

Guido van Rossum eventually chose a surprising syntax:

@example
x = true_value if condition else false_value
@end example

Evaluation is still lazy as in existing Boolean expressions, so the order of
evaluation jumps around a bit.  The `condition' expression in the middle is
evaluated first, and the `true_value' expression is evaluated only if the
condition was true.  Similarly, the `false_value' expression is only evaluated
when the condition is false.

This syntax may seem strange and backwards; why does the condition go in the
`middle' of the expression, and not in the front as in C’s @code{c ? x : y}?  The
decision was checked by applying the new syntax to the modules in the standard
library and seeing how the resulting code read.  In many cases where a
conditional expression is used, one value seems to be the ‘common case’ and one
value is an ‘exceptional case’, used only on rarer occasions when the condition
isn’t met.  The conditional syntax makes this pattern a bit more obvious:

@example
contents = ((doc + '\n') if doc else '@w{'})
@end example

I read the above statement as meaning “here `contents' is  usually assigned a
value of @code{doc+'\n'}; sometimes  `doc' is empty, in which special case an empty
string is returned.”   I doubt I will use conditional expressions very often
where there  isn’t a clear common and uncommon case.

There was some discussion of whether the language should require surrounding
conditional expressions with parentheses.  The decision was made to `not'
require parentheses in the Python language’s grammar, but as a matter of style I
think you should always use them. Consider these two statements:

@example
# First version -- no parens
level = 1 if logging else 0

# Second version -- with parens
level = (1 if logging else 0)
@end example

In the first version, I think a reader’s eye might group the statement into
‘level = 1’, ‘if logging’, ‘else 0’, and think that the condition decides
whether the assignment to `level' is performed.  The second version reads
better, in my opinion, because it makes it clear that the assignment is always
performed and the choice is being made between two values.

Another reason for including the brackets: a few odd combinations of list
comprehensions and lambdas could look like incorrect conditional expressions.
See 
@geindex Propostas de Melhorias do Python; PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} for some examples.  If you put parentheses around your
conditional expressions, you won’t run into this case.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 308

@item PEP 308@footnote{https://peps.python.org/pep-0308/} - Conditional Expressions

PEP written by Guido van Rossum and Raymond D. Hettinger; implemented by Thomas
Wouters.
@end table


@c ======================================================================

@node PEP 309 Partial Function Application,PEP 314 Metadata for Python Software Packages v1 1,PEP 308 Conditional Expressions,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-309}@anchor{144f}@anchor{whatsnew/2 5 pep-309-partial-function-application}@anchor{1450}
@subsection PEP 309: Partial Function Application


The @ref{5f,,functools} module is intended to contain tools for functional-style
programming.

One useful tool in this module is the @code{partial()} function. For programs
written in a functional style, you’ll sometimes want to construct variants of
existing functions that have some of the parameters filled in.  Consider a
Python function @code{f(a, b, c)}; you could create a new function @code{g(b, c)} that
was equivalent to @code{f(1, b, c)}.  This is called “partial function
application”.

@code{partial()} takes the arguments @code{(function, arg1, arg2, ... kwarg1=value1,
kwarg2=value2)}.  The resulting object is callable, so you can just call it to
invoke `function' with the filled-in arguments.

Aqui está um pequeno mas bem realístico exemplo:

@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

Here’s another example, from a program that uses PyGTK.  Here a context-sensitive
pop-up menu is being constructed dynamically.  The callback provided
for the menu option is a partially applied version of the @code{open_item()}
method, where the first argument has been provided.

@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

Another function in the @ref{5f,,functools} module is the
@code{update_wrapper(wrapper, wrapped)} function that helps you write
well-behaved decorators.  @code{update_wrapper()} copies the name, module, and
docstring attribute to a wrapper function so that tracebacks inside the wrapped
function are easier to understand.  For example, you might write:

@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()} is a decorator that can be used inside your own decorators to copy
the wrapped function’s information.  An alternate  version of the previous
example would be:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 309

@item PEP 309@footnote{https://peps.python.org/pep-0309/} - Partial Function Application

PEP proposed and written by Peter Harris; implemented by Hye-Shik Chang and Nick
Coghlan, with adaptations by Raymond Hettinger.
@end table


@c ======================================================================

@node PEP 314 Metadata for Python Software Packages v1 1,PEP 328 Absolute and Relative Imports,PEP 309 Partial Function Application,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-314}@anchor{1451}@anchor{whatsnew/2 5 pep-314-metadata-for-python-software-packages-v1-1}@anchor{1452}
@subsection PEP 314: Metadata for Python Software Packages v1.1


Some simple dependency support was added to Distutils.  The @code{setup()}
function now has @code{requires}, @code{provides}, and @code{obsoletes} keyword
parameters.  When you build a source distribution using the @code{sdist} command,
the dependency information will be recorded in the @code{PKG-INFO} file.

Another new keyword parameter is @code{download_url}, which should be set to a URL
for the package’s source code.  This means it’s now possible to look up an entry
in the package index, determine the dependencies for a package, and download the
required packages.

@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

Another new enhancement to the Python package index at
@indicateurl{https://pypi.org} is storing source and binary archives for a
package.  The new @code{upload} Distutils command will upload a package to
the repository.

Before a package can be uploaded, you must be able to build a distribution using
the @code{sdist} Distutils command.  Once that works, you can run @code{python
setup.py upload} to add your package to the PyPI archive.  Optionally you can
GPG-sign the package by supplying the @code{--sign} and @code{--identity}
options.

Package uploading was implemented by Martin von Löwis and Richard Jones.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 314

@item PEP 314@footnote{https://peps.python.org/pep-0314/} - Metadata for Python Software Packages v1.1

PEP proposed and written by A.M. Kuchling, Richard Jones, and Fred Drake;
implemented by Richard Jones and Fred Drake.
@end table


@c ======================================================================

@node PEP 328 Absolute and Relative Imports,PEP 338 Executing Modules as Scripts,PEP 314 Metadata for Python Software Packages v1 1,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-328}@anchor{144c}@anchor{whatsnew/2 5 pep-328-absolute-and-relative-imports}@anchor{1453}
@subsection PEP 328: Absolute and Relative Imports


The simpler part of 
@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} was implemented in Python 2.4: parentheses could now
be used to enclose the names imported from a module using the @code{from ... import
...} statement, making it easier to import many different names.

The more complicated part has been implemented in Python 2.5: importing a module
can be specified to use absolute or package-relative imports.  The plan is to
move toward making absolute imports the default in future versions of Python.

Let’s say you have a package directory like this:

@example
pkg/
pkg/__init__.py
pkg/main.py
pkg/string.py
@end example

This defines a package named @code{pkg} containing the @code{pkg.main} and
@code{pkg.string} submodules.

Consider the code in the @code{main.py} module.  What happens if it executes
the statement @code{import string}?  In Python 2.4 and earlier, it will first look
in the package’s directory to perform a relative import, finds
@code{pkg/string.py}, imports the contents of that file as the
@code{pkg.string} module, and that module is bound to the name @code{string} in the
@code{pkg.main} module’s namespace.

That’s fine if @code{pkg.string} was what you wanted.  But what if you wanted
Python’s standard @ref{d3,,string} module?  There’s no clean way to ignore
@code{pkg.string} and look for the standard module; generally you had to look at
the contents of @code{sys.modules}, which is slightly unclean.    Holger Krekel’s
@code{py.std} package provides a tidier way to perform imports from the standard
library, @code{import py; py.std.string.join()}, but that package isn’t available
on all Python installations.

Reading code which relies on relative imports is also less clear, because a
reader may be confused about which module, @ref{d3,,string} or @code{pkg.string},
is intended to be used.  Python users soon learned not to duplicate the names of
standard library modules in the names of their packages’ submodules, but you
can’t protect against having your submodule’s name being used for a new module
added in a future version of Python.

In Python 2.5, you can switch @ref{5e2,,import}’s behaviour to  absolute imports
using a @code{from __future__ import absolute_import} directive.  This absolute-import
behaviour will become the default in a future version (probably Python
2.7).  Once absolute imports  are the default, @code{import string} will always
find the standard library’s version. It’s suggested that users should begin
using absolute imports as much as possible, so it’s preferable to begin writing
@code{from pkg import string} in your code.

Relative imports are still possible by adding a leading period  to the module
name when using the @code{from ... import} form:

@example
# Import names from pkg.string
from .string import name1, name2
# Import pkg.string
from . import string
@end example

This imports the @ref{d3,,string} module relative to the current package, so in
@code{pkg.main} this will import `name1' and `name2' from @code{pkg.string}.
Additional leading periods perform the relative import starting from the parent
of the current package.  For example, code in the @code{A.B.C} module can do:

@example
from . import D                 # Imports A.B.D
from .. import E                # Imports A.E
from ..F import G               # Imports A.F.G
@end example

Leading periods cannot be used with the @code{import modname}  form of the import
statement, only the @code{from ... import} form.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - Importações: Multilinha e absoluta/relativa

PEP written by Aahz; implemented by Thomas Wouters.

@item @indicateurl{https://pylib.readthedocs.io/}

The py library by Holger Krekel, which contains the @code{py.std} package.
@end table


@c ======================================================================

@node PEP 338 Executing Modules as Scripts,PEP 341 Unified try/except/finally,PEP 328 Absolute and Relative Imports,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-338}@anchor{1454}@anchor{whatsnew/2 5 pep-338-executing-modules-as-scripts}@anchor{1455}
@subsection PEP 338: Executing Modules as Scripts


The @ref{5e1,,-m} switch added in Python 2.4 to execute a module as a script
gained a few more abilities.  Instead of being implemented in C code inside the
Python interpreter, the switch now uses an implementation in a new module,
@ref{be,,runpy}.

The @ref{be,,runpy} module implements a more sophisticated import mechanism so that
it’s now possible to run modules in a package such as @code{pychecker.checker}.
The module also supports alternative import mechanisms such as the
@ref{132,,zipimport} module.  This means you can add a .zip archive’s path to
@code{sys.path} and then use the @ref{5e1,,-m} switch to execute code from the
archive.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} - Executing modules as scripts

PEP written and  implemented by Nick Coghlan.
@end table


@c ======================================================================

@node PEP 341 Unified try/except/finally,PEP 342 New Generator Features,PEP 338 Executing Modules as Scripts,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-341}@anchor{144d}@anchor{whatsnew/2 5 pep-341-unified-try-except-finally}@anchor{1456}
@subsection PEP 341: Unified try/except/finally


Until Python 2.5, the @ref{6e9,,try} statement came in two flavours. You could
use a @ref{9d2,,finally} block to ensure that code is always executed, or one or
more @ref{18b,,except} blocks to catch  specific exceptions.  You couldn’t
combine both @code{except} blocks and a @code{finally} block, because
generating the right bytecode for the combined version was complicated and it
wasn’t clear what the semantics of the combined statement should be.

Guido van Rossum spent some time working with Java, which does support the
equivalent of combining @ref{18b,,except} blocks and a @ref{9d2,,finally} block,
and this clarified what the statement should mean.  In Python 2.5, you can now
write:

@example
try:
    block-1 ...
except Exception1:
    handler-1 ...
except Exception2:
    handler-2 ...
else:
    else-block
finally:
    final-block
@end example

The code in `block-1' is executed.  If the code raises an exception, the various
@ref{18b,,except} blocks are tested: if the exception is of class
@code{Exception1}, `handler-1' is executed; otherwise if it’s of class
@code{Exception2}, `handler-2' is executed, and so forth.  If no exception is
raised, the `else-block' is executed.

No matter what happened previously, the `final-block' is executed once the code
block is complete and any raised exceptions handled. Even if there’s an error in
an exception handler or the `else-block' and a new exception is raised, the code
in the `final-block' is still run.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 341

@item PEP 341@footnote{https://peps.python.org/pep-0341/} - Unifying try-except and try-finally

PEP written by Georg Brandl;  implementation by Thomas Lee.
@end table


@c ======================================================================

@node PEP 342 New Generator Features,PEP 343 The ‘with’ statement<2>,PEP 341 Unified try/except/finally,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-342}@anchor{144b}@anchor{whatsnew/2 5 pep-342-new-generator-features}@anchor{1457}
@subsection PEP 342: New Generator Features


Python 2.5 adds a simple way to pass values `into' a generator. As introduced in
Python 2.3, generators only produce output; once a generator’s code was invoked
to create an iterator, there was no way to pass any new information into the
function when its execution is resumed.  Sometimes the ability to pass in some
information would be useful.  Hackish solutions to this include making the
generator’s code look at a global variable and then changing the global
variable’s value, or passing in some mutable object that callers then modify.

To refresh your memory of basic generators, here’s a simple example:

@example
def counter (maximum):
    i = 0
    while i < maximum:
        yield i
        i += 1
@end example

When you call @code{counter(10)}, the result is an iterator that returns the values
from 0 up to 9.  On encountering the @ref{9d5,,yield} statement, the iterator
returns the provided value and suspends the function’s execution, preserving the
local variables. Execution resumes on the following call to the iterator’s
@ref{7d9,,next()} method, picking up after the @code{yield} statement.

In Python 2.3, @ref{9d5,,yield} was a statement; it didn’t return any value.  In
2.5, @code{yield} is now an expression, returning a value that can be
assigned to a variable or otherwise operated on:

@example
val = (yield i)
@end example

I recommend that you always put parentheses around a @ref{9d5,,yield} expression
when you’re doing something with the returned value, as in the above example.
The parentheses aren’t always necessary, but it’s easier to always add them
instead of having to remember when they’re needed.

(
@geindex Propostas de Melhorias do Python; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} explains the exact rules, which are that a
@ref{9d5,,yield}-expression must always be parenthesized except when it
occurs at the top-level
expression on the right-hand side of an assignment.  This means you can write
@code{val = yield i} but have to use parentheses when there’s an operation, as in
@code{val = (yield i) + 12}.)

Values are sent into a generator by calling its @code{send(value)} method.  The
generator’s code is then resumed and the @ref{9d5,,yield} expression returns the
specified `value'.  If the regular @ref{7d9,,next()} method is called, the
@code{yield} returns @ref{675,,None}.

Here’s the previous example, modified to allow changing the value of the
internal counter.

@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

And here’s an example of changing the counter:

@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{9d5,,yield} will usually return @ref{675,,None}, so you should always check
for this case.  Don’t just use its value in expressions unless you’re sure that
the @code{send()} method will be the only method used to resume your generator
function.

In addition to @code{send()}, there are two other new methods on generators:


@itemize *

@item 
@code{throw(type, value=None, traceback=None)} is used to raise an exception
inside the generator; the exception is raised by the @ref{9d5,,yield} expression
where the generator’s execution is paused.

@item 
@code{close()} raises a new @ref{140e,,GeneratorExit} exception inside the generator
to terminate the iteration.  On receiving this exception, the generator’s code
must either raise @ref{140e,,GeneratorExit} or @ref{c15,,StopIteration}.  Catching the
@ref{140e,,GeneratorExit} exception and returning a value is illegal and will trigger
a @ref{195,,RuntimeError}; if the function raises some other exception, that
exception is propagated to the caller.  @code{close()} will also be called by
Python’s garbage collector when the generator is garbage-collected.

If you need to run cleanup code when a @ref{140e,,GeneratorExit} occurs, I suggest
using a @code{try: ... finally:} suite instead of  catching @ref{140e,,GeneratorExit}.
@end itemize

The cumulative effect of these changes is to turn generators from one-way
producers of information into both producers and consumers.

Generators also become `coroutines', a more generalized form of subroutines.
Subroutines are entered at one point and exited at another point (the top of the
function, and a @ref{9d6,,return} statement), but coroutines can be entered,
exited, and resumed at many different points (the @ref{9d5,,yield} statements).
We’ll have to figure out patterns for using coroutines effectively in Python.

The addition of the @code{close()} method has one side effect that isn’t obvious.
@code{close()} is called when a generator is garbage-collected, so this means the
generator’s code gets one last chance to run before the generator is destroyed.
This last chance means that @code{try...finally} statements in generators can now
be guaranteed to work; the @ref{9d2,,finally} clause will now always get a
chance to run.  The syntactic restriction that you couldn’t mix @ref{9d5,,yield}
statements with a @code{try...finally} suite has therefore been removed.  This
seems like a minor bit of language trivia, but using generators and
@code{try...finally} is actually necessary in order to implement the
@ref{5d2,,with} statement described by 
@geindex Propostas de Melhorias do Python; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.  I’ll look at this new statement
in the following  section.

Another even more esoteric effect of this change: previously, the
@code{gi_frame} attribute of a generator was always a frame object. It’s now
possible for @code{gi_frame} to be @code{None} once the generator has been
exhausted.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - Corrotinas via Geradores Aprimorados

PEP written by  Guido van Rossum and Phillip J. Eby; implemented by Phillip J.
Eby.  Includes examples of  some fancier uses of generators as coroutines.

Earlier versions of these features were proposed in  
@geindex Propostas de Melhorias do Python; PEP 288
PEP 288@footnote{https://peps.python.org/pep-0288/} by Raymond
Hettinger and 
@geindex Propostas de Melhorias do Python; PEP 325
PEP 325@footnote{https://peps.python.org/pep-0325/} by Samuele Pedroni.

@item @indicateurl{https://en.wikipedia.org/wiki/Coroutine}

The Wikipedia entry for  coroutines.

@item @indicateurl{https://web.archive.org/web/20160321211320/http://www.sidhe.org/~dan/blog/archives/000178.html}

An explanation of coroutines from a Perl point of view, written by Dan Sugalski.
@end table


@c ======================================================================

@node PEP 343 The ‘with’ statement<2>,PEP 352 Exceptions as New-Style Classes,PEP 342 New Generator Features,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-343}@anchor{144a}@anchor{whatsnew/2 5 pep-343-the-with-statement}@anchor{1458}
@subsection PEP 343: The ‘with’ statement


The ‘@ref{5d2,,with}’ statement clarifies code that previously would use @code{try...finally} blocks to ensure that clean-up code is executed. In this section, I’ll discuss the statement as it will commonly be used. In the next section, I’ll examine the implementation details and show how to write objects for use with this statement.

The ‘@ref{5d2,,with}’ statement is a new control-flow structure whose basic
structure is:

@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{5c8,,__enter__()} and @ref{1344,,__exit__()}
methods.

The object’s @ref{5c8,,__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{1344,,__exit__()}
method is called, even if the block raised an exception, and can therefore run
clean-up code.

To enable the statement in Python 2.5, you need to add the following directive
to your module:

@example
from __future__ import with_statement
@end example

The statement will always be enabled in Python 2.6.

Some standard Python objects now support the context management protocol and can
be used with the ‘@ref{5d2,,with}’ statement. File objects are one example:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... more processing code ...
@end example

After this statement has executed, the file object in `f' will have been
automatically closed, even if the @ref{2f2,,for} loop raised an exception
part-way through the block.

@cartouche
@quotation Nota 
In this case, `f' is the same object created by @ref{51c,,open()}, because
@ref{5c8,,__enter__()} returns `self'.
@end quotation
@end cartouche

The @ref{ed,,threading} module’s locks and condition variables also support the ‘@ref{5d2,,with}’ statement:

@example
lock = threading.Lock()
with lock:
    # Critical section of code
    ...
@end example

The lock is acquired before the block is executed and always released once the block is complete.

The new @code{localcontext()} function in the @ref{36,,decimal} module makes it easy
to save and restore the current decimal context, which encapsulates the desired
precision and rounding characteristics for computations:

@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
* Writing Context Managers: Writing Context Managers<2>. 
* The contextlib module: The contextlib module<2>. 

@end menu

@node Writing Context Managers<2>,The contextlib module<2>,,PEP 343 The ‘with’ statement<2>
@anchor{whatsnew/2 5 new-25-context-managers}@anchor{1459}@anchor{whatsnew/2 5 writing-context-managers}@anchor{145a}
@subsubsection Writing Context Managers


Under the hood, the ‘@ref{5d2,,with}’ statement is fairly complicated. Most
people will only use ‘@code{with}’ in company with existing objects and
don’t need to know these details, so you can skip the rest of this section if
you like.  Authors of new objects will need to understand the details of the
underlying implementation and should keep reading.

A high-level explanation of the context management protocol is:


@itemize *

@item 
The expression is evaluated and should result in an object called a “context
manager”.  The context manager must have @ref{5c8,,__enter__()} and @ref{1344,,__exit__()}
methods.

@item 
The context manager’s @ref{5c8,,__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 
The code in `BLOCK' is executed.

@item 
If `BLOCK' raises an exception, the @code{__exit__(type, value, traceback)}
is called with the exception details, the same values returned by
@ref{68a,,sys.exc_info()}.  The method’s return value controls whether the 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{5d2,,with}’ statement will
never realize anything went wrong.

@item 
If `BLOCK' didn’t raise an exception,  the @ref{1344,,__exit__()} method is still
called, but `type', `value', and `traceback' are all @code{None}.
@end itemize

Let’s think through an example. I won’t present detailed code but will only sketch the methods necessary for a database that supports transactions.

(For people unfamiliar with database terminology: a set of changes to the database are grouped into a transaction. Transactions can be either committed, meaning that all the changes are written into the database, or rolled back, meaning that the changes are all discarded and the database is unchanged. See any database textbook for more information.)

Vamos supor que exista um objeto representando uma conexão com o banco de dados. Nosso objetivo será permitir que o usuário escreva 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

A transação deverá ser confirmada se o código no bloco funcionar perfeitamente ou revertida se houver uma exceção. Aqui está a interface básica para @code{DatabaseConnection} que presumirei:

@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{5c8,,__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{5d2,,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{1344,,__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.

In the code below, execution will just fall off the end of the function, returning the default value of @code{None}. @code{None} is false, so the exception will be re-raised automatically. If you wished, you could be more explicit and add a @ref{9d6,,return} statement at the marked location.

@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 The contextlib module<2>,,Writing Context Managers<2>,PEP 343 The ‘with’ statement<2>
@anchor{whatsnew/2 5 contextlibmod}@anchor{145b}@anchor{whatsnew/2 5 the-contextlib-module}@anchor{145c}
@subsubsection The contextlib module


The new @ref{23,,contextlib} module provides some functions and a decorator that
are useful for writing objects for use with the ‘@ref{5d2,,with}’ statement.

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{9d5,,yield} will be executed as the
@ref{5c8,,__enter__()} method, and the value yielded will be the method’s return
value that will get bound to the variable in the ‘@ref{5d2,,with}’ statement’s
@code{as} clause, if any.  The code after the @ref{9d5,,yield} will be
executed in the @ref{1344,,__exit__()} method.  Any exception raised in the block will
be raised by the @code{yield} statement.

Our database example from the previous section could be written  using this
decorator as:

@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

The @ref{23,,contextlib} module also has a @code{nested(mgr1, mgr2, ...)} function
that combines a number of context managers so you don’t need to write nested
‘@ref{5d2,,with}’ statements.  In this example, the single ‘@code{with}’
statement both starts a database transaction and acquires a thread lock:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

Finally, the @code{closing(object)} function returns `object' so that it can be
bound to a variable, and calls @code{object.close} at the end of the block.

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - A instrução “with”

PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland, Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a ‘@ref{5d2,,with}’ statement, which can be helpful in learning how the statement works.
@end table

The documentation for the @ref{23,,contextlib} module.


@c ======================================================================

@node PEP 352 Exceptions as New-Style Classes,PEP 353 Using ssize_t as the index type,PEP 343 The ‘with’ statement<2>,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-352}@anchor{145d}@anchor{whatsnew/2 5 pep-352-exceptions-as-new-style-classes}@anchor{145e}
@subsection PEP 352: Exceptions as New-Style Classes


Exception classes can now be new-style classes, not just classic classes, and
the built-in @ref{9e2,,Exception} class and all the standard built-in exceptions
(@ref{43f,,NameError}, @ref{202,,ValueError}, etc.) are now new-style classes.

The inheritance hierarchy for exceptions has been rearranged a bit. In 2.5, the
inheritance relationships are:

@example
BaseException       # New in Python 2.5
|- KeyboardInterrupt
|- SystemExit
|- Exception
   |- (all other current built-in exceptions)
@end example

This rearrangement was done because people often want to catch all exceptions
that indicate program errors.  @ref{9d9,,KeyboardInterrupt} and @ref{d63,,SystemExit}
aren’t errors, though, and usually represent an explicit action such as the user
hitting @code{Control}-@code{C} or code calling @ref{138e,,sys.exit()}.  A bare @code{except:} will
catch all exceptions, so you commonly need to list @ref{9d9,,KeyboardInterrupt} and
@ref{d63,,SystemExit} in order to re-raise them.  The usual pattern is:

@example
try:
    ...
except (KeyboardInterrupt, SystemExit):
    raise
except:
    # Log error...
    # Continue running program...
@end example

In Python 2.5, you can now write @code{except Exception} to achieve the same
result, catching all the exceptions that usually indicate errors  but leaving
@ref{9d9,,KeyboardInterrupt} and @ref{d63,,SystemExit} alone.  As in previous versions,
a bare @code{except:} still catches all exceptions.

The goal for Python 3.0 is to require any class raised as an exception to derive
from @ref{5bb,,BaseException} or some descendant of @ref{5bb,,BaseException}, and future
releases in the Python 2.x series may begin to enforce this constraint.
Therefore, I suggest you begin making all your exception classes derive from
@ref{9e2,,Exception} now.  It’s been suggested that the bare @code{except:} form should
be removed in Python 3.0, but Guido van Rossum hasn’t decided whether to do this
or not.

Raising of strings as exceptions, as in the statement @code{raise "Error
occurred"}, is deprecated in Python 2.5 and will trigger a warning.  The aim is
to be able to remove the string-exception feature in a few releases.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 352

@item PEP 352@footnote{https://peps.python.org/pep-0352/} - Required Superclass for Exceptions

PEP written by  Brett Cannon and Guido van Rossum; implemented by Brett Cannon.
@end table


@c ======================================================================

@node PEP 353 Using ssize_t as the index type,PEP 357 The ‘__index__’ method,PEP 352 Exceptions as New-Style Classes,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-353}@anchor{145f}@anchor{whatsnew/2 5 pep-353-using-ssize-t-as-the-index-type}@anchor{1460}
@subsection PEP 353: Using ssize_t as the index type


A wide-ranging change to Python’s C API, using a new  @ref{a69,,Py_ssize_t} type
definition instead of int,  will permit the interpreter to handle more
data on 64-bit platforms. This change doesn’t affect Python’s capacity on 32-bit
platforms.

Various pieces of the Python interpreter used C’s int type to store
sizes or counts; for example, the number of items in a list or tuple were stored
in an int.  The C compilers for most 64-bit platforms still define
int as a 32-bit type, so that meant that lists could only hold up to
@code{2**31 - 1} = 2147483647 items. (There are actually a few different
programming models that 64-bit C compilers can use – see
@indicateurl{https://unix.org/version2/whatsnew/lp64_wp.html} for a discussion – but the
most commonly available model leaves int as 32 bits.)

A limit of 2147483647 items doesn’t really matter on a 32-bit platform because
you’ll run out of memory before hitting the length limit. Each list item
requires space for a pointer, which is 4 bytes, plus space for a
@ref{339,,PyObject} representing the item.  2147483647*4 is already more bytes
than a 32-bit address space can contain.

It’s possible to address that much memory on a 64-bit platform, however.  The
pointers for a list that size would only require 16 GiB of space, so it’s not
unreasonable that Python programmers might construct lists that large.
Therefore, the Python interpreter had to be changed to use some type other than
int, and this will be a 64-bit type on 64-bit platforms.  The change
will cause incompatibilities on 64-bit machines, so it was deemed worth making
the transition now, while the number of 64-bit users is still relatively small.
(In 5 or 10 years, we may `all' be on 64-bit machines, and the transition would
be more painful then.)

This change most strongly affects authors of C extension modules.   Python
strings and container types such as lists and tuples  now use
@ref{a69,,Py_ssize_t} to store their size.   Functions such as
@ref{1461,,PyList_Size()}  now return @ref{a69,,Py_ssize_t}.  Code in extension modules
may therefore need to have some variables changed to @ref{a69,,Py_ssize_t}.

The @ref{571,,PyArg_ParseTuple()} and @ref{8ac,,Py_BuildValue()} functions have a new
conversion code, @code{n}, for @ref{a69,,Py_ssize_t}.   @ref{571,,PyArg_ParseTuple()}’s
@code{s#} and @code{t#} still output int by default, but you can define the
macro  @code{PY_SSIZE_T_CLEAN} before including @code{Python.h}  to make
them return @ref{a69,,Py_ssize_t}.

@geindex Propostas de Melhorias do Python; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} has a section on conversion guidelines that  extension authors should
read to learn about supporting 64-bit platforms.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 353

@item PEP 353@footnote{https://peps.python.org/pep-0353/} - Using ssize_t as the index type

PEP written and implemented by Martin von Löwis.
@end table


@c ======================================================================

@node PEP 357 The ‘__index__’ method,Outras mudanças na linguagem<16>,PEP 353 Using ssize_t as the index type,What’s New in Python 2 5
@anchor{whatsnew/2 5 pep-357}@anchor{1462}@anchor{whatsnew/2 5 pep-357-the-index-method}@anchor{1463}
@subsection PEP 357: The ‘__index__’ method


The NumPy developers had a problem that could only be solved by adding a new
special method, @code{__index__()}.  When using slice notation, as in
@code{[start:stop:step]}, the values of the `start', `stop', and `step' indexes
must all be either integers or long integers.  NumPy defines a variety of
specialized integer types corresponding to unsigned and signed integers of 8,
16, 32, and 64 bits, but there was no way to signal that these types could be
used as slice indexes.

Slicing can’t just use the existing @code{__int__()} method because that method
is also used to implement coercion to integers.  If slicing used
@code{__int__()}, floating-point numbers would also become legal slice indexes
and that’s clearly an undesirable behaviour.

Instead, a new special method called @code{__index__()} was added.  It takes no
arguments and returns an integer giving the slice index to use.  For example:

@example
class C:
    def __index__ (self):
        return self.value
@end example

The return value must be either a Python integer or long integer. The
interpreter will check that the type returned is correct, and raises a
@ref{2c3,,TypeError} if this requirement isn’t met.

A corresponding @ref{1464,,nb_index} slot was added to the C-level
@ref{1465,,PyNumberMethods} structure to let C extensions implement this protocol.
@code{PyNumber_Index(obj)} can be used in extension code to call the
@code{__index__()} function and retrieve its result.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 357

@item PEP 357@footnote{https://peps.python.org/pep-0357/} - Allowing Any Object to be Used for Slicing

PEP written  and implemented by Travis Oliphant.
@end table


@c ======================================================================

@node Outras mudanças na linguagem<16>,New Improved and Removed Modules,PEP 357 The ‘__index__’ method,What’s New in Python 2 5
@anchor{whatsnew/2 5 other-lang}@anchor{1466}@anchor{whatsnew/2 5 other-language-changes}@anchor{1467}
@subsection Outras mudanças na linguagem


Here are all of the changes that Python 2.5 makes to the core Python language.


@itemize *

@item 
The @ref{256,,dict} type has a new hook for letting subclasses provide a default
value when a key isn’t contained in the dictionary. When a key isn’t found, the
dictionary’s @code{__missing__(key)} method will be called.  This hook is used
to implement the new @code{defaultdict} class in the @ref{1d,,collections}
module.  The following example defines a dictionary  that returns zero for any
missing key:

@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 
Both 8-bit and Unicode strings have new @code{partition(sep)}  and
@code{rpartition(sep)} methods that simplify a common use case.

The @code{find(S)} method is often used to get an index which is then used to
slice the string and obtain the pieces that are before and after the separator.
@code{partition(sep)} condenses this pattern into a single method call that
returns a 3-tuple containing the substring before the separator, the separator
itself, and the substring after the separator.  If the separator isn’t found,
the first element of the tuple is the entire string and the other two elements
are empty.  @code{rpartition(sep)} also returns a 3-tuple but starts searching
from the end of the string; the @code{r} stands for ‘reverse’.

Alguns exemplos:

@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

(Implemented by Fredrik Lundh following a suggestion by Raymond Hettinger.)

@item 
The @code{startswith()} and @code{endswith()} methods of string types now accept
tuples of strings to check for.

@example
def is_image_file (filename):
    return filename.endswith(('.gif', '.jpg', '.tiff'))
@end example

(Implemented by Georg Brandl following a suggestion by Tom Lynn.)

@c RFE #1491485

@item 
The @ref{f3a,,min()} and @ref{f3b,,max()} built-in functions gained a @code{key} keyword
parameter analogous to the @code{key} argument for @code{sort()}.  This parameter
supplies a function that takes a single argument and is called for every value
in the list; @ref{f3a,,min()}/@ref{f3b,,max()} will return the element with the
smallest/largest return value from this function. For example, to find the
longest string in a list, you can do:

@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

(Contributed by Steven Bethard and Raymond Hettinger.)

@item 
Two new built-in functions, @ref{1468,,any()} and @ref{1469,,all()}, evaluate whether an
iterator contains any true or false values.  @ref{1468,,any()} returns @ref{c27,,True}
if any value returned by the iterator is true; otherwise it will return
@ref{b49,,False}.  @ref{1469,,all()} returns @ref{c27,,True} only if all of the values
returned by the iterator evaluate as true. (Suggested by Guido van Rossum, and
implemented by Raymond Hettinger.)

@item 
The result of a class’s @code{__hash__()} method can now be either a long
integer or a regular integer.  If a long integer is returned, the hash of that
value is taken.  In earlier versions the hash value was required to be a
regular integer, but in 2.5 the @ref{146a,,id()} built-in was changed to always
return non-negative numbers, and users often seem to use @code{id(self)} in
@code{__hash__()} methods (though this is discouraged).

@c Bug #1536021

@item 
ASCII is now the default encoding for modules.  It’s now  a syntax error if a
module contains string literals with 8-bit characters but doesn’t have an
encoding declaration.  In Python 2.4 this triggered a warning, not a syntax
error.  See 
@geindex Propostas de Melhorias do Python; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}  for how to declare a module’s encoding; for example, you
might add  a line like this near the top of the source file:

@example
# -*- coding: latin1 -*-
@end example

@item 
A new warning, @ref{146b,,UnicodeWarning}, is triggered when  you attempt to
compare a Unicode string and an 8-bit string  that can’t be converted to Unicode
using the default ASCII encoding.   The result of the comparison is false:

@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

Previously this would raise a @ref{a1d,,UnicodeDecodeError} exception, but in 2.5
this could result in puzzling problems when accessing a dictionary.  If you
looked up @code{unichr(128)} and @code{chr(128)} was being used as a key, you’d get a
@ref{a1d,,UnicodeDecodeError} exception.  Other changes in 2.5 resulted in this
exception being raised instead of suppressed by the code in @code{dictobject.c}
that implements dictionaries.

Raising an exception for such a comparison is strictly correct, but the change
might have broken code, so instead  @ref{146b,,UnicodeWarning} was introduced.

(Implemented by Marc-André Lemburg.)

@item 
One error that Python programmers sometimes make is forgetting to include an
@code{__init__.py} module in a package directory. Debugging this mistake can be
confusing, and usually requires running Python with the @ref{146c,,-v} switch to
log all the paths searched. In Python 2.5, a new @ref{4fa,,ImportWarning} warning is
triggered when an import would have picked up a directory as a package but no
@code{__init__.py} was found.  This warning is silently ignored by default;
provide the @ref{8cd,,-Wd} option when running the Python executable to display
the warning message. (Implemented by Thomas Wouters.)

@item 
The list of base classes in a class definition can now be empty.   As an
example, this is now legal:

@example
class C():
    pass
@end example

(Implemented by Brett Cannon.)
@end itemize

@c ======================================================================

@menu
* Interactive Interpreter Changes:: 
* Otimizações: Otimizações<15>. 

@end menu

@node Interactive Interpreter Changes,Otimizações<15>,,Outras mudanças na linguagem<16>
@anchor{whatsnew/2 5 interactive}@anchor{146d}@anchor{whatsnew/2 5 interactive-interpreter-changes}@anchor{146e}
@subsubsection Interactive Interpreter Changes


In the interactive interpreter, @code{quit} and @code{exit}  have long been strings so
that new users get a somewhat helpful message when they try to quit:

@example
>>> quit
'Use Ctrl-D (i.e. EOF) to exit.'
@end example

In Python 2.5, @code{quit} and @code{exit} are now objects that still produce string
representations of themselves, but are also callable. Newbies who try @code{quit()}
or @code{exit()} will now exit the interpreter as they expect.  (Implemented by
Georg Brandl.)

The Python executable now accepts the standard long options  @ref{5f0,,--help}
and @ref{d3d,,--version}; on Windows,  it also accepts the @ref{146f,,/?} option
for displaying a help message. (Implemented by Georg Brandl.)

@c ======================================================================

@node Otimizações<15>,,Interactive Interpreter Changes,Outras mudanças na linguagem<16>
@anchor{whatsnew/2 5 optimizations}@anchor{1470}@anchor{whatsnew/2 5 opts}@anchor{1471}
@subsubsection Otimizações


Several of the optimizations were developed at the NeedForSpeed sprint, an event
held in Reykjavik, Iceland, from May 21–28 2006. The sprint focused on speed
enhancements to the CPython implementation and was funded by EWT LLC with local
support from CCP Games.  Those optimizations added at this sprint are specially
marked in the following list.


@itemize *

@item 
When they were introduced  in Python 2.4, the built-in @ref{5d9,,set} and
@ref{5da,,frozenset} types were built on top of Python’s dictionary type.   In 2.5
the internal data structure has been customized for implementing sets, and as a
result sets will use a third less memory and are somewhat faster. (Implemented
by Raymond Hettinger.)

@item 
The speed of some Unicode operations, such as finding substrings, string
splitting, and character map encoding and decoding, has been improved.
(Substring search and splitting improvements were added by Fredrik Lundh and
Andrew Dalke at the NeedForSpeed sprint. Character maps were improved by Walter
Dörwald and Martin von Löwis.)

@c Patch 1313939, 1359618

@item 
The @code{long(str, base)} function is now faster on long digit strings
because fewer intermediate results are calculated.  The peak is for strings of
around 800–1000 digits where  the function is 6 times faster. (Contributed by
Alan McIntyre and committed at the NeedForSpeed sprint.)

@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{202,,ValueError} from the @code{read*()} method.
(Implemented by Thomas Wouters.)

@c Patch 1397960

@item 
The @ref{d5,,struct} module now compiles structure format  strings into an
internal representation and caches this representation, yielding a 20% speedup.
(Contributed by Bob Ippolito at the NeedForSpeed sprint.)

@item 
The @ref{b9,,re} module got a 1 or 2% speedup by switching to  Python’s allocator
functions instead of the system’s  @code{malloc()} and @code{free()}.
(Contributed by Jack Diederich at the NeedForSpeed sprint.)

@item 
The code generator’s peephole optimizer now performs simple constant folding
in expressions.  If you write something like @code{a = 2+3}, the code generator
will do the arithmetic and produce code corresponding to @code{a = 5}.  (Proposed
and implemented  by Raymond Hettinger.)

@item 
Function calls are now faster because code objects now keep  the most recently
finished frame (a “zombie frame”) in an internal field of the code object,
reusing it the next time the code object is invoked.  (Original patch by Michael
Hudson, modified by Armin Rigo and Richard Jones; committed at the NeedForSpeed
sprint.)  Frame objects are also slightly smaller, which may improve cache
locality and reduce memory usage a bit.  (Contributed by Neal Norwitz.)

@c Patch 876206

@c Patch 1337051

@item 
Python’s built-in exceptions are now new-style classes, a change that speeds
up instantiation considerably.  Exception handling in Python 2.5 is therefore
about 30% faster than in 2.4. (Contributed by Richard Jones, Georg Brandl and
Sean Reifschneider at the NeedForSpeed sprint.)

@item 
Importing now caches the paths tried, recording whether  they exist or not so
that the interpreter makes fewer  @code{open()} and @code{stat()} calls on
startup. (Contributed by Martin von Löwis and Georg Brandl.)

@c Patch 921466
@end itemize

@c ======================================================================

@node New Improved and Removed Modules,Mudanças a construções e API C<10>,Outras mudanças na linguagem<16>,What’s New in Python 2 5
@anchor{whatsnew/2 5 modules}@anchor{1472}@anchor{whatsnew/2 5 new-improved-and-removed-modules}@anchor{1473}
@subsection New, Improved, and Removed Modules


The standard library received many enhancements and bug fixes in Python 2.5.
Here’s a partial list of the most notable changes, sorted alphabetically by
module name. Consult the @code{Misc/NEWS} file in the source tree for a more
complete list of changes, or look through the SVN logs for all the details.


@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 
The @ref{1b,,codecs} module gained support for incremental codecs.  The
@code{codec.lookup()} function now returns a @code{CodecInfo} instance instead
of a tuple. @code{CodecInfo} instances behave like a 4-tuple to preserve
backward compatibility but also have the attributes @code{encode},
@code{decode}, @code{incrementalencoder}, @code{incrementaldecoder},
@code{streamwriter}, and @code{streamreader}.  Incremental codecs  can receive
input and produce output in multiple chunks; the output is the same as if the
entire input was fed to the non-incremental codec. See the @ref{1b,,codecs} module
documentation for details. (Designed and implemented by Walter Dörwald.)

@c Patch  1436130

@item 
The @ref{1d,,collections} module gained a new type, @code{defaultdict}, that
subclasses the standard @ref{256,,dict} type.  The new type mostly behaves like a
dictionary but constructs a default value when a key isn’t present,
automatically adding it to the dictionary for the requested key value.

The first argument to @code{defaultdict}’s constructor is a factory function
that gets called whenever a key is requested but not found. This factory
function receives no arguments, so you can use built-in type constructors such
as @ref{611,,list()} or @ref{257,,int()}.  For example,  you can make an index of words
based on their initial letter like this:

@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

Printing @code{index} results in the following output:

@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

(Contributed by Guido van Rossum.)

@item 
The @code{deque} double-ended queue type supplied by the @ref{1d,,collections}
module now has a @code{remove(value)} method that removes the first occurrence
of `value' in the queue, raising @ref{202,,ValueError} if the value isn’t found.
(Contributed by Raymond Hettinger.)

@item 
New module: The @ref{23,,contextlib} module contains helper functions for use
with the new ‘@ref{5d2,,with}’ statement.  See section @ref{145b,,The contextlib module}
for more about this module.

@item 
New module: The @ref{27,,cProfile} module is a C implementation of  the existing
@ref{af,,profile} module that has much lower overhead. The module’s interface is
the same as @ref{af,,profile}: you run @code{cProfile.run('main()')} to profile a
function, can save profile data to a file, etc.  It’s not yet known if the
Hotshot profiler, which is also written in C but doesn’t match the
@ref{af,,profile} module’s interface, will continue to be maintained in future
versions of Python.  (Contributed by Armin Rigo.)

Also, the @ref{b0,,pstats} module for analyzing the data measured by the profiler
now supports directing the output to any file object by supplying a `stream'
argument to the @code{Stats} constructor. (Contributed by Skip Montanaro.)

@item 
The @ref{29,,csv} module, which parses files in comma-separated value format,
received several enhancements and a number of bugfixes.  You can now set the
maximum size in bytes of a field by calling the
@code{csv.field_size_limit(new_limit)} function; omitting the `new_limit'
argument will return the currently set limit.  The @code{reader} class now has
a @code{line_num} attribute that counts the number of physical lines read from
the source; records can span multiple physical lines, so @code{line_num} is not
the same as the number of records read.

The CSV parser is now stricter about multi-line quoted fields. Previously, if a
line ended within a quoted field without a terminating newline character, a
newline would be inserted into the returned field. This behavior caused problems
when reading files that contained carriage return characters within fields, so
the code was changed to return the field without inserting newlines. As a
consequence, if newlines embedded within fields are important, the input should
be split into lines in a manner that preserves the newline characters.

(Contributed by Skip Montanaro and Andrew McNamara.)

@item 
The @ref{1cc,,datetime} class in the @ref{30,,datetime}  module now has a
@code{strptime(string, format)}  method for parsing date strings, contributed
by Josh Spoerri. It uses the same format characters as @ref{1474,,time.strptime()} and
@ref{1229,,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 
The @code{SequenceMatcher.get_matching_blocks()} method in the @ref{37,,difflib}
module now guarantees to return a minimal list of blocks describing matching
subsequences.  Previously, the algorithm would occasionally break a block of
matching elements into two list entries. (Enhancement by Tim Peters.)

@item 
The @ref{3a,,doctest} module gained a @code{SKIP} option that keeps an example from
being executed at all.  This is intended for code snippets that are usage
examples intended for the reader and aren’t actually test cases.

An `encoding' parameter was added to the @code{testfile()} function and the
@code{DocFileSuite} class to specify the file’s encoding.  This makes it
easier to use non-ASCII characters in  tests contained within a docstring.
(Contributed by Bjorn Tillenius.)

@c Patch 1080727

@item 
The @ref{3b,,email} package has been updated to version 4.0. (Contributed by
Barry Warsaw.)

@c XXX need to provide some more detail here

@geindex novas linhas universais;What's new

@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{131b,,input()} function to allow opening files in binary or @ref{d5c,,universal newlines} mode.  Another new parameter, `openhook', lets you use a function
other than @ref{51c,,open()}  to open the input files.  Once you’re iterating over
the set of files, the @code{FileInput} object’s new @ref{1475,,fileno()} returns
the file descriptor for the currently opened file. (Contributed by Georg
Brandl.)

@item 
In the @ref{60,,gc} module, the new @code{get_count()} function returns a 3-tuple
containing the current collection counts for the three GC generations.  This is
accounting information for the garbage collector; when these counts reach a
specified threshold, a garbage collection sweep will be made.  The existing
@ref{a43,,gc.collect()} function now takes an optional `generation' argument of 0, 1,
or 2 to specify which generation to collect. (Contributed by Barry Warsaw.)

@item 
The @code{nsmallest()} and  @code{nlargest()} functions in the @ref{69,,heapq}
module  now support a @code{key} keyword parameter similar to the one provided by
the @ref{f3a,,min()}/@ref{f3b,,max()} functions and the @code{sort()} methods.  For
example:

@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

(Contributed by Raymond Hettinger.)

@item 
The @ref{b61,,itertools.islice()} function now accepts @code{None} for the start and
step arguments.  This makes it more compatible with the attributes of slice
objects, so that you can now write the following:

@example
s = slice(5)     # Create slice object
itertools.islice(iterable, s.start, s.stop, s.step)
@end example

(Contributed by Raymond Hettinger.)

@item 
The @ref{61f,,format()} function in the @ref{86,,locale} module has been modified and
two new functions were added, @code{format_string()} and @code{currency()}.

The @ref{61f,,format()} function’s `val' parameter could previously be a string as
long as no more than one %char specifier appeared; now the parameter must be
exactly one %char specifier with no surrounding text.  An optional `monetary'
parameter was also added which, if @code{True}, will use the locale’s rules for
formatting currency in placing a separator between groups of three digits.

To format strings with multiple %char specifiers, use the new
@code{format_string()} function that works like @ref{61f,,format()} but also supports
mixing %char specifiers with arbitrary text.

A new @code{currency()} function was also added that formats a number according
to the current locale’s settings.

(Contributed by Georg Brandl.)

@c Patch 1180296

@item 
The @ref{8b,,mailbox} module underwent a massive rewrite to add the capability to
modify mailboxes in addition to reading them.  A new set of classes that include
@code{mbox}, @code{MH}, and @code{Maildir} are used to read mailboxes, and
have an @code{add(message)} method to add messages, @code{remove(key)} to
remove messages, and @code{lock()}/@code{unlock()} to lock/unlock the mailbox.
The following example converts a maildir-format mailbox into an mbox-format
one:

@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

(Contributed by Gregory K. Johnson.  Funding was provided by Google’s 2005
Summer of Code.)

@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 
The @ref{9f,,operator} module’s @code{itemgetter()}  and @code{attrgetter()}
functions now support multiple fields.   A call such as
@code{operator.attrgetter('a', 'b')} will return a function  that retrieves the
@code{a} and @code{b} attributes.  Combining  this new feature with the
@code{sort()} method’s @code{key} parameter  lets you easily sort lists using
multiple fields. (Contributed by Raymond Hettinger.)

@item 
The @ref{a0,,optparse} module was updated to version 1.5.1 of the Optik library.
The @code{OptionParser} class gained an @code{epilog} attribute, a string
that will be printed after the help message, and a @code{destroy()} method to
break reference cycles created by the object. (Contributed by Greg Ward.)

@item 
The @ref{a1,,os} module underwent several changes.  The @code{stat_float_times}
variable now defaults to true, meaning that @ref{4a0,,os.stat()} will now return time
values as floats.  (This doesn’t necessarily mean that @ref{4a0,,os.stat()} will
return times that are precise to fractions of a second; not all systems support
such precision.)

Constants named @ref{12cf,,os.SEEK_SET}, @ref{12d0,,os.SEEK_CUR}, and
@ref{12d1,,os.SEEK_END} have been added; these are the parameters to the
@ref{1156,,os.lseek()} function.  Two new constants for locking are
@ref{1476,,os.O_SHLOCK} and @ref{1477,,os.O_EXLOCK}.

Two new functions, @code{wait3()} and @code{wait4()}, were added.  They’re similar
the @code{waitpid()} function which waits for a child process to exit and returns
a tuple of the process ID and its exit status, but @code{wait3()} and
@code{wait4()} return additional information.  @code{wait3()} doesn’t take a
process ID as input, so it waits for any child process to exit and returns a
3-tuple of `process-id', `exit-status', `resource-usage' as returned from the
@ref{1478,,resource.getrusage()} function. @code{wait4(pid)} does take a process ID.
(Contributed by Chad J. Schroeder.)

On FreeBSD, the @ref{4a0,,os.stat()} function now returns  times with nanosecond
resolution, and the returned object now has @code{st_gen} and
@code{st_birthtime}. The @code{st_flags} attribute is also available, if the
platform supports it. (Contributed by Antti Louko and  Diego Pettenò.)

@c (Patch 1180695, 1212117)

@item 
The Python debugger provided by the @ref{a5,,pdb} module can now store lists of
commands to execute when a breakpoint is reached and execution stops.  Once
breakpoint #1 has been created, enter @code{commands 1} and enter a series of
commands to be executed, finishing the list with @code{end}.  The command list can
include commands that resume execution, such as @code{continue} or @code{next}.
(Contributed by 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{9db,,__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 
The @ref{a9,,pkgutil} module, containing various utility functions for finding
packages, was enhanced to support 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}’s import hooks and now also works for
packages stored in ZIP-format archives. (Contributed by Phillip J. Eby.)

@item 
The pybench benchmark suite by Marc-André Lemburg is now included in the
@code{Tools/pybench} directory.  The pybench suite is an improvement on the
commonly used @code{pystone.py} program because pybench provides a more
detailed measurement of the interpreter’s speed.  It times particular operations
such as function calls, tuple slicing, method lookups, and numeric operations,
instead of performing many different operations and reducing the result to a
single number as @code{pystone.py} does.

@item 
The @code{pyexpat} module now uses version 2.0 of the Expat parser.
(Contributed by Trent Mick.)

@item 
The @ref{13db,,Queue} class provided by the @code{Queue} module gained two new
methods.  @code{join()} blocks until all items in the queue have been retrieved
and all processing work on the items  have been completed.  Worker threads call
the other new method,  @code{task_done()}, to signal that processing for an item
has been completed.  (Contributed by Raymond Hettinger.)

@item 
The old @code{regex} and @code{regsub} modules, which have been  deprecated
ever since Python 2.0, have finally been deleted.   Other deleted modules:
@code{statcache}, @code{tzparse}, @code{whrandom}.

@item 
Also deleted: the @code{lib-old} directory, which includes ancient modules
such as @code{dircmp} and @code{ni}, was removed.  @code{lib-old} wasn’t on the
default @code{sys.path}, so unless your programs explicitly added the directory to
@code{sys.path}, this removal shouldn’t affect your code.

@item 
The @ref{bd,,rlcompleter} module is no longer  dependent on importing the
@ref{ba,,readline} module and therefore now works on non-Unix platforms. (Patch
from Robert Kiendl.)

@c Patch #1472854

@item 
The @ref{12f,,SimpleXMLRPCServer} and @ref{12f,,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 
The @ref{cc,,socket} module now supports @code{AF_NETLINK} sockets on Linux,
thanks to a patch from Philippe Biondi.   Netlink sockets are a Linux-specific
mechanism for communications between a user-space process and kernel code; an
introductory  article about them is at @indicateurl{https://www.linuxjournal.com/article/7356}.
In Python code, netlink addresses are represented as a tuple of 2 integers,
@code{(pid, group_mask)}.

Two new methods on socket objects, @code{recv_into(buffer)} and
@code{recvfrom_into(buffer)}, store the received data in an object  that
supports the buffer protocol instead of returning the data as a string.  This
means you can put the data directly into an array or a memory-mapped file.

Socket objects also gained @code{getfamily()}, @code{gettype()}, and
@code{getproto()} accessor methods to retrieve the family, type, and protocol
values for the socket.

@item 
New module: the @code{spwd} module provides functions for accessing the shadow
password database on systems that support  shadow passwords.

@item 
The @ref{d5,,struct} is now faster because it  compiles format strings into
@code{Struct} objects with @code{pack()} and @code{unpack()} methods.  This is
similar to how the @ref{b9,,re} module lets you create compiled regular expression
objects.  You can still use the module-level  @code{pack()} and @code{unpack()}
functions; they’ll create  @code{Struct} objects and cache them.  Or you can
use  @code{Struct} instances directly:

@example
s = struct.Struct('ih3s')

data = s.pack(1972, 187, 'abc')
year, number, name = s.unpack(data)
@end example

You can also pack and unpack data to and from buffer objects directly using the
@code{pack_into(buffer, offset, v1, v2, ...)} and @code{unpack_from(buffer,
offset)} methods.  This lets you store data directly into an array or a
memory-mapped file.

(@code{Struct} objects were implemented by Bob Ippolito at the NeedForSpeed
sprint.  Support for buffer objects was added by Martin Blais, also at the
NeedForSpeed sprint.)

@item 
The Python developers switched from CVS to Subversion during the 2.5
development process.  Information about the exact build version is available as
the @code{sys.subversion} variable, a 3-tuple of @code{(interpreter-name, branch-name,
revision-range)}.  For example, at the time of writing my copy of 2.5 was
reporting @code{('CPython', 'trunk', '45313:45315')}.

This information is also available to C extensions via the
@ref{1479,,Py_GetBuildInfo()} function that returns a  string of build information
like this: @code{"trunk:45355:45356M, Apr 13 2006, 07:42:19"}.   (Contributed by
Barry Warsaw.)

@item 
Another new function, @ref{147a,,sys._current_frames()}, returns the current stack
frames for all running threads as a dictionary mapping thread identifiers to the
topmost stack frame currently active in that thread at the time the function is
called.  (Contributed by Tim Peters.)

@item 
The @code{TarFile} class in the @ref{de,,tarfile} module now has an
@code{extractall()} method that extracts all members from the archive into the
current working directory.  It’s also possible to set a different directory as
the extraction target, and to unpack only a subset of the archive’s members.

The compression used for a tarfile opened in stream mode can now be autodetected
using the mode @code{'r|*'}. (Contributed by Lars Gustäbel.)

@c patch 918101

@item 
The @ref{ed,,threading} module now lets you set the stack size used when new
threads are created. The @code{stack_size([*size*])} function returns the
currently configured stack size, and supplying the optional `size' parameter
sets a new value.  Not all platforms support changing the stack size, but
Windows, POSIX threading, and OS/2 all do. (Contributed by Andrew MacIntyre.)

@c Patch 1454481

@item 
The @ref{105,,unicodedata} module has been updated to use version 4.1.0 of the
Unicode character database.  Version 3.2.0 is required  by some specifications,
so it’s still available as  @ref{147b,,unicodedata.ucd_3_2_0}.

@item 
New module: the  @ref{110,,uuid} module generates  universally unique identifiers
(UUIDs) according to 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.  The RFC defines several different UUID
versions that are generated from a starting string, from system properties, or
purely randomly.  This module contains a @code{UUID} class and  functions
named @code{uuid1()}, @code{uuid3()}, @code{uuid4()},  and  @code{uuid5()} to
generate different versions of UUID.  (Version 2 UUIDs  are not specified in
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} and are not supported by this module.)

@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

(Contributed by Ka-Ping Yee.)

@item 
The @ref{114,,weakref} module’s @code{WeakKeyDictionary} and
@code{WeakValueDictionary} types gained new methods for iterating over the
weak references contained in the dictionary.  @code{iterkeyrefs()} and
@code{keyrefs()} methods were added to @code{WeakKeyDictionary}, and
@code{itervaluerefs()} and @code{valuerefs()} were added to
@code{WeakValueDictionary}.  (Contributed by Fred L. Drake, Jr.)

@item 
The @ref{115,,webbrowser} module received a number of enhancements. It’s now
usable as a script with @code{python -m webbrowser}, taking a URL as the argument;
there are a number of switches  to control the behaviour (@code{-n} for a new
browser window,  @code{-t} for a new tab).  New module-level functions,
@code{open_new()} and @code{open_new_tab()}, were added  to support this.  The
module’s @ref{51c,,open()} function supports an additional feature, an `autoraise'
parameter that signals whether to raise the open window when possible. A number
of additional browsers were added to the supported list such as Firefox, Opera,
Konqueror, and elinks.  (Contributed by Oleg Broytmann and Georg Brandl.)

@c Patch #754022

@item 
The @ref{12e,,xmlrpclib} module now supports returning  @ref{1cc,,datetime} objects
for the XML-RPC date type.  Supply  @code{use_datetime=True} to the @ref{147c,,loads()}
function or the @code{Unmarshaller} class to enable this feature. (Contributed
by Skip Montanaro.)

@c Patch 1120353

@item 
The @ref{131,,zipfile} module now supports the ZIP64 version of the  format,
meaning that a .zip archive can now be larger than 4 GiB and can contain
individual files larger than 4 GiB.  (Contributed by Ronald Oussoren.)

@c Patch 1446489

@item 
The @ref{133,,zlib} module’s @code{Compress} and @code{Decompress} objects now
support a @ref{25,,copy()} method that makes a copy of the  object’s internal state
and returns a new  @code{Compress} or @code{Decompress} object.
(Contributed by Chris AtLee.)

@c Patch 1435422
@end itemize

@c ======================================================================

@menu
* The ctypes package:: 
* The ElementTree package:: 
* The hashlib package:: 
* The sqlite3 package:: 
* The wsgiref package:: 

@end menu

@node The ctypes package,The ElementTree package,,New Improved and Removed Modules
@anchor{whatsnew/2 5 module-ctypes}@anchor{147d}@anchor{whatsnew/2 5 the-ctypes-package}@anchor{147e}
@subsubsection The ctypes package


The @ref{2a,,ctypes} package, written by Thomas Heller, has been added  to the
standard library.  @ref{2a,,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{2a,,ctypes} package is much fancier.

To load a shared library or DLL, you must create an instance of the
@code{CDLL} class and provide the name or path of the shared library or DLL.
Once that’s done, you can call arbitrary functions by accessing them as
attributes of the @code{CDLL} object.

@example
import ctypes

libc = ctypes.CDLL('libc.so.6')
result = libc.printf("Line of output\n")
@end example

Type constructors for the various C types are provided: @code{c_int()},
@code{c_float()}, @code{c_double()}, @code{c_char_p()} (equivalent to char*), and so forth.  Unlike Python’s types, the C versions are all mutable; you
can assign to their @code{value} attribute to change the wrapped value.  Python
integers and strings will be automatically converted to the corresponding C
types, but for other types you  must call the correct type constructor.  (And I
mean `must';  getting it wrong will often result in the interpreter crashing
with a segmentation fault.)

You shouldn’t use @code{c_char_p()} with a Python string when the C function will
be modifying the memory area, because Python strings are  supposed to be
immutable; breaking this rule will cause puzzling bugs.  When you need a
modifiable memory area, use @code{create_string_buffer()}:

@example
s = "this is a string"
buf = ctypes.create_string_buffer(s)
libc.strfry(buf)
@end example

C functions are assumed to return integers, but you can set the @code{restype}
attribute of the function object to  change this:

@example
>>> libc.atof('2.71828')
-1783957616
>>> libc.atof.restype = ctypes.c_double
>>> libc.atof('2.71828')
2.71828
@end example

@ref{2a,,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{147f,,py_object} type
constructor that will create a  @ref{339,,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{147f,,py_object()}; if it’s omitted you end  up with a
segmentation fault.

@ref{2a,,ctypes} has been around for a while, but people still write  and
distribution hand-coded extension modules because you can’t rely on
@ref{2a,,ctypes} being present. Perhaps developers will begin to write  Python
wrappers atop a library accessed through @ref{2a,,ctypes} instead of extension
modules, now that @ref{2a,,ctypes} is included with core Python.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://web.archive.org/web/20180410025338/http://starship.python.net/crew/theller/ctypes/}

The pre-stdlib ctypes web page, with a tutorial, reference, and FAQ.
@end table

The documentation  for the @ref{2a,,ctypes} module.


@c ======================================================================

@node The ElementTree package,The hashlib package,The ctypes package,New Improved and Removed Modules
@anchor{whatsnew/2 5 module-etree}@anchor{1480}@anchor{whatsnew/2 5 the-elementtree-package}@anchor{1481}
@subsubsection The ElementTree package


A subset of Fredrik Lundh’s ElementTree library for processing XML has been
added to the standard library as @code{xml.etree}.  The available modules are
@code{ElementTree}, @code{ElementPath}, and @code{ElementInclude} from
ElementTree 1.2.6.    The @code{cElementTree} accelerator module is also
included.

The rest of this section will provide a brief overview of using ElementTree.
Full documentation for ElementTree is available at
@indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}.

ElementTree represents an XML document as a tree of element nodes. The text
content of the document is stored as the @code{text} and @code{tail}
attributes of  (This is one of the major differences between ElementTree and
the Document Object Model; in the DOM there are many different types of node,
including @code{TextNode}.)

The most commonly used parsing function is @code{parse()}, that takes either a
string (assumed to contain a filename) or a file-like object and returns an
@code{ElementTree} instance:

@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

Once you have an @code{ElementTree} instance, you can call its @code{getroot()}
method to get the root @code{Element} node.

There’s also an @code{XML()} function that takes a string literal and returns an
@code{Element} node (not an @code{ElementTree}).   This function provides a
tidy way to incorporate XML fragments, approaching the convenience of an XML
literal:

@example
svg = ET.XML("""<svg width="10px" version="1.0">
             </svg>""")
svg.set('height', '320px')
svg.append(elem1)
@end example

Each XML element supports some dictionary-like and some list-like access
methods.  Dictionary-like operations are used to access attribute values, and
list-like operations are used to access child nodes.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@item

@code{elem[n]}

@tab

Returns n’th child element.

@item

@code{elem[m:n]}

@tab

Returns list of m’th through n’th child
elements.

@item

@code{len(elem)}

@tab

Returns number of child elements.

@item

@code{list(elem)}

@tab

Returns list of child elements.

@item

@code{elem.append(elem2)}

@tab

Adds `elem2' as a child.

@item

@code{elem.insert(index, elem2)}

@tab

Inserts `elem2' at the specified location.

@item

@code{del elem[n]}

@tab

Deletes n’th child element.

@item

@code{elem.keys()}

@tab

Returns list of attribute names.

@item

@code{elem.get(name)}

@tab

Returns value of attribute `name'.

@item

@code{elem.set(name, value)}

@tab

Sets new value for attribute `name'.

@item

@code{elem.attrib}

@tab

Retrieves the dictionary containing
attributes.

@item

@code{del elem.attrib[name]}

@tab

Deletes attribute `name'.

@end multitable


Comments and processing instructions are also represented as @code{Element}
nodes.  To check if a node is a comment or processing instructions:

@example
if elem.tag is ET.Comment:
    ...
elif elem.tag is ET.ProcessingInstruction:
    ...
@end example

To generate XML output, you should call the @code{ElementTree.write()} method.
Like @code{parse()}, it can take either a string or a file-like object:

@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

(Caution: the default encoding used for output is ASCII.  For general XML work,
where an element’s name may contain arbitrary Unicode characters, ASCII isn’t a
very useful encoding because it will raise an exception if an element’s name
contains any characters with values greater than 127.  Therefore, it’s best to
specify a different encoding such as UTF-8 that can handle any Unicode
character.)

This section is only a partial description of the ElementTree interfaces. Please
read the package’s official documentation for more details.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}

Official documentation for ElementTree.
@end table


@c ======================================================================

@node The hashlib package,The sqlite3 package,The ElementTree package,New Improved and Removed Modules
@anchor{whatsnew/2 5 module-hashlib}@anchor{1482}@anchor{whatsnew/2 5 the-hashlib-package}@anchor{1483}
@subsubsection The hashlib package


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

Once a hash object has been created, its methods are the same as before:
@code{update(string)} hashes the specified string into the  current digest
state, @code{digest()} and @code{hexdigest()} return the digest value as a binary
string or a string of hex digits, and @ref{25,,copy()} returns a new hashing object
with the same digest state.


@subsubheading Ver também


The documentation  for the @ref{68,,hashlib} module.


@c ======================================================================

@node The sqlite3 package,The wsgiref package,The hashlib package,New Improved and Removed Modules
@anchor{whatsnew/2 5 module-sqlite}@anchor{1484}@anchor{whatsnew/2 5 the-sqlite3-package}@anchor{1485}
@subsubsection The sqlite3 package


The pysqlite module (@indicateurl{https://www.pysqlite.org}), a wrapper for the SQLite embedded
database, has been added to the standard library under the package name
@ref{cf,,sqlite3}.

SQLite é uma biblioteca C que fornece um banco de dados leve baseado em disco que não requer um processo de servidor separado e permite acessar o banco de dados usando uma variante não padrão da linguagem de consulta SQL. Algumas aplicações podem usar SQLite para armazenamento interno de dados. Também é possível prototipar um aplicativo usando SQLite e, em seguida, portar o código para um banco de dados maior, como PostgreSQL ou Oracle.

pysqlite was written by Gerhard Häring and provides a SQL interface compliant
with the DB-API 2.0 specification described by 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}.

If you’re compiling the Python source yourself, note that the source tree
doesn’t include the SQLite code, only the wrapper module. You’ll need to have
the SQLite libraries and headers installed before compiling Python, and the
build process will compile the module when the necessary headers are available.

To use the module, you must first create a @code{Connection} object that
represents the database.  Here the data will be stored in the
@code{/tmp/example} file:

@example
conn = sqlite3.connect('/tmp/example')
@end example

You can also supply the special name @code{:memory:} to create a database in RAM.

Once you have a @code{Connection}, you can create a @code{Cursor}  object
and call its @code{execute()} method to perform SQL commands:

@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

Usually your SQL operations will need to use values from Python variables.  You
shouldn’t assemble your query using Python’s string operations because doing so
is insecure; it makes your program vulnerable to an SQL injection attack.

Instead, use the DB-API’s parameter substitution.  Put @code{?} as a placeholder
wherever you want to use a value, and then provide a tuple of values as the
second argument to the cursor’s @code{execute()} method.  (Other database modules
may use a different placeholder, such as @code{%s} or @code{:1}.) For example:

@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

To retrieve data after executing a SELECT statement, you can either  treat the
cursor as an iterator, call the cursor’s @code{fetchone()} method to retrieve a
single matching row,  or call @code{fetchall()} to get a list of the matching
rows.

This example uses the iterator form:

@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

For more information about the SQL dialect supported by SQLite, see
@indicateurl{https://www.sqlite.org}.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://www.pysqlite.org}

The pysqlite web page.

@item @indicateurl{https://www.sqlite.org}

A página web do SQLite; a documentação descreve a sintaxe e os tipos de dados disponíveis para o dialeto SQL suportado.
@end table

The documentation  for the @ref{cf,,sqlite3} module.


@table @asis

@geindex Propostas de Melhorias do Python; PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - Especificação 2.0 da API de banco de dados

PEP escrita por Marc-André Lemburg.
@end table


@c ======================================================================

@node The wsgiref package,,The sqlite3 package,New Improved and Removed Modules
@anchor{whatsnew/2 5 module-wsgiref}@anchor{1486}@anchor{whatsnew/2 5 the-wsgiref-package}@anchor{1487}
@subsubsection The wsgiref package


The Web Server Gateway Interface (WSGI) v1.0 defines a standard interface
between web servers and Python web applications and is described in 
@geindex Propostas de Melhorias do Python; PEP 333
PEP 333@footnote{https://peps.python.org/pep-0333/}.
The @ref{118,,wsgiref} package is a reference implementation of the WSGI
specification.

@c XXX should this be in a :pep:`333` section instead?

The package includes a basic HTTP server that will run a WSGI application; this
server is useful for debugging but isn’t intended for  production use.  Setting
up a server takes only a few lines of code:

@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 também



@table @asis

@item @indicateurl{https://web.archive.org/web/20160331090247/http://wsgi.readthedocs.org/en/latest/}

A central web site for WSGI-related resources.

@geindex Propostas de Melhorias do Python; PEP 333

@item PEP 333@footnote{https://peps.python.org/pep-0333/} - Python Web Server Gateway Interface v1.0

PEP written by Phillip J. Eby.
@end table


@c ======================================================================

@node Mudanças a construções e API C<10>,Porting to Python 2 5,New Improved and Removed Modules,What’s New in Python 2 5
@anchor{whatsnew/2 5 build-and-c-api-changes}@anchor{1488}@anchor{whatsnew/2 5 build-api}@anchor{1489}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
The Python source tree was converted from CVS to Subversion,  in a complex
migration procedure that was supervised and flawlessly carried out by Martin von
Löwis.  The procedure was developed as 
@geindex Propostas de Melhorias do Python; PEP 347
PEP 347@footnote{https://peps.python.org/pep-0347/}.

@item 
Coverity, a company that markets a source code analysis tool called Prevent,
provided the results of their examination of the Python source code.  The
analysis found about 60 bugs that  were quickly fixed.  Many of the bugs were
refcounting problems, often occurring in error-handling code.  See
@indicateurl{https://scan.coverity.com} for the statistics.

@item 
The largest change to the C API came from 
@geindex Propostas de Melhorias do Python; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}, which modifies the
interpreter to use a @ref{a69,,Py_ssize_t} type definition instead of
int.  See the earlier section @ref{145f,,PEP 353; Using ssize_t as the index type} for a discussion of this
change.

@item 
The design of the bytecode compiler has changed a great deal,  no longer
generating bytecode by traversing the parse tree.  Instead the parse tree is
converted to an abstract syntax tree (or AST), and it is  the abstract syntax
tree that’s traversed to produce the bytecode.

It’s possible for Python code to obtain AST objects by using the
@ref{192,,compile()} built-in and specifying @code{_ast.PyCF_ONLY_AST} as the value of
the  `flags' parameter:

@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

No official documentation has been written for the AST code yet, but 
@geindex Propostas de Melhorias do Python; PEP 339
PEP 339@footnote{https://peps.python.org/pep-0339/}
discusses the design.  To start learning about the code, read the definition of
the various AST nodes in @code{Parser/Python.asdl}.  A Python script reads this
file and generates a set of C structure definitions in
@code{Include/Python-ast.h}.  The @code{PyParser_ASTFromString()} and
@code{PyParser_ASTFromFile()}, defined in @code{Include/pythonrun.h}, take
Python source as input and return the root of an AST representing the contents.
This AST can then be turned into a code object by @code{PyAST_Compile()}.  For
more information, read the source code, and then ask questions on python-dev.

The AST code was developed under Jeremy Hylton’s management, and implemented by
(in alphabetical order) Brett Cannon, Nick Coghlan, Grant Edwards, John
Ehresman, Kurt Kaiser, Neal Norwitz, Tim Peters, Armin Rigo, and Neil
Schemenauer, plus the participants in a number of AST sprints at conferences
such as 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 
Evan Jones’s patch to obmalloc, first described in a talk at PyCon DC 2005,
was applied.  Python 2.4 allocated small objects in 256K-sized arenas, but never
freed arenas.  With this patch, Python will free arenas when they’re empty.  The
net effect is that on some platforms, when you allocate many objects, Python’s
memory usage may actually drop when you delete them and the memory may be
returned to the operating system.  (Implemented by Evan Jones, and reworked by
Tim Peters.)

Note that this change means extension modules must be more careful when
allocating memory.  Python’s API has many different functions for allocating
memory that are grouped into families.  For example, @ref{c81,,PyMem_Malloc()},
@ref{106a,,PyMem_Realloc()}, and @ref{148a,,PyMem_Free()} are one family that allocates
raw memory, while @ref{c83,,PyObject_Malloc()}, @ref{148b,,PyObject_Realloc()}, and
@ref{c80,,PyObject_Free()} are another family that’s supposed to be used for
creating Python objects.

Previously these different families all reduced to the platform’s
@code{malloc()} and @code{free()} functions.  This meant  it didn’t matter if
you got things wrong and allocated memory with the @code{PyMem} function but
freed it with the @code{PyObject} function.  With 2.5’s changes to obmalloc,
these families now do different things and mismatches will probably result in a
segfault.  You should carefully test your C extension modules with Python 2.5.

@item 
The built-in set types now have an official C API.  Call @ref{148c,,PySet_New()}
and @ref{148d,,PyFrozenSet_New()} to create a new set, @ref{148e,,PySet_Add()} and
@ref{148f,,PySet_Discard()} to add and remove elements, and @ref{1490,,PySet_Contains()}
and @ref{1491,,PySet_Size()} to examine the set’s state. (Contributed by Raymond
Hettinger.)

@item 
C code can now obtain information about the exact revision of the Python
interpreter by calling the  @ref{1479,,Py_GetBuildInfo()} function that returns a
string of build information like this: @code{"trunk:45355:45356M, Apr 13 2006,
07:42:19"}.   (Contributed by Barry Warsaw.)

@item 
Two new macros can be used to indicate C functions that are local to the
current file so that a faster calling convention can be used.
@ref{1492,,Py_LOCAL} declares the function as returning a value of the
specified `type' and uses a fast-calling qualifier.
@ref{1493,,Py_LOCAL_INLINE} does the same thing and also requests the
function be inlined.  If macro @code{PY_LOCAL_AGGRESSIVE} is defined before
@code{python.h} is included, a set of more aggressive optimizations are enabled
for the module; you should benchmark the results to find out if these
optimizations actually make the code faster.  (Contributed by Fredrik Lundh at
the NeedForSpeed sprint.)

@item 
@code{PyErr_NewException(name, base, dict)} can now accept a tuple of base
classes as its `base' argument.  (Contributed by Georg Brandl.)

@item 
The @code{PyErr_Warn()} function for issuing warnings is now deprecated in
favour of @code{PyErr_WarnEx(category, message, stacklevel)} which lets you
specify the number of stack frames separating this function and the caller.  A
`stacklevel' of 1 is the function calling @ref{1494,,PyErr_WarnEx()}, 2 is the
function above that, and so forth.  (Added by Neal Norwitz.)

@item 
The CPython interpreter is still written in C, but  the code can now be
compiled with a C++ compiler without errors.   (Implemented by Anthony Baxter,
Martin von Löwis, Skip Montanaro.)

@item 
The @code{PyRange_New()} function was removed.  It was never documented, never
used in the core code, and had dangerously lax error checking.  In the unlikely
case that your extensions were using it, you can replace it by something like
the following:

@example
range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
                              start, stop, step);
@end example
@end itemize

@c ======================================================================

@menu
* Port-Specific Changes:: 

@end menu

@node Port-Specific Changes,,,Mudanças a construções e API C<10>
@anchor{whatsnew/2 5 port-specific-changes}@anchor{1495}@anchor{whatsnew/2 5 ports}@anchor{1496}
@subsubsection Port-Specific Changes



@itemize *

@item 
MacOS X (10.3 and higher): dynamic loading of modules now uses the
@code{dlopen()} function instead of MacOS-specific functions.

@item 
MacOS X: an @code{--enable-universalsdk} switch was added to the
@code{configure} script that compiles the interpreter as a universal binary
able to run on both PowerPC and Intel processors. (Contributed by Ronald
Oussoren; bpo-2573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2573}.)

@item 
Windows: @code{.dll} is no longer supported as a filename extension for
extension modules.  @code{.pyd} is now the only filename extension that will be
searched for.
@end itemize

@c ======================================================================

@node Porting to Python 2 5,Reconhecimentos<3>,Mudanças a construções e API C<10>,What’s New in Python 2 5
@anchor{whatsnew/2 5 porting}@anchor{1497}@anchor{whatsnew/2 5 porting-to-python-2-5}@anchor{1498}
@subsection Porting to Python 2.5


This section lists previously described changes that may require changes to your
code:


@itemize *

@item 
ASCII is now the default encoding for modules.  It’s now  a syntax error if a
module contains string literals with 8-bit characters but doesn’t have an
encoding declaration.  In Python 2.4 this triggered a warning, not a syntax
error.

@item 
Previously, the @code{gi_frame} attribute of a generator was always a frame
object.  Because of the 
@geindex Propostas de Melhorias do Python; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} changes described in section @ref{144b,,PEP 342; New Generator Features},
it’s now possible for @code{gi_frame} to be @code{None}.

@item 
A new warning, @ref{146b,,UnicodeWarning}, is triggered when  you attempt to
compare a Unicode string and an 8-bit string that can’t be converted to Unicode
using the default ASCII encoding.  Previously such comparisons would raise a
@ref{a1d,,UnicodeDecodeError} exception.

@item 
Library: the @ref{29,,csv} module is now stricter about multi-line quoted fields.
If your files contain newlines embedded within fields, the input should be split
into lines in a manner which preserves the newline characters.

@item 
Library: the @ref{86,,locale} module’s  @ref{61f,,format()} function’s would
previously  accept any string as long as no more than one %char specifier
appeared.  In Python 2.5, the argument must be exactly one %char specifier with
no surrounding text.

@item 
Library: The @ref{a6,,pickle} and @code{cPickle} modules no longer accept a
return value of @code{None} from the @ref{9db,,__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{12f,,SimpleXMLRPCServer} and @ref{12f,,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 
C API: Many functions now use @ref{a69,,Py_ssize_t}  instead of int to
allow processing more data on 64-bit machines.  Extension code may need to make
the same change to avoid warnings and to support 64-bit machines.  See the
earlier section @ref{145f,,PEP 353; Using ssize_t as the index type} for a discussion of this change.

@item 
C API:  The obmalloc changes mean that  you must be careful to not mix usage
of the @code{PyMem_*} and @code{PyObject_*} families of functions. Memory
allocated with  one family’s @code{*_Malloc} must be  freed with the
corresponding family’s @code{*_Free} function.
@end itemize

@c ======================================================================

@node Reconhecimentos<3>,,Porting to Python 2 5,What’s New in Python 2 5
@anchor{whatsnew/2 5 acknowledgements}@anchor{1499}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions,
corrections and assistance with various drafts of this article: 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 What’s New in Python 2 4,What’s New in Python 2 3,What’s New in Python 2 5,O que há de novo no Python
@anchor{whatsnew/2 4 doc}@anchor{149a}@anchor{whatsnew/2 4 translation-repo}@anchor{149b}@anchor{whatsnew/2 4 what-s-new-in-python-2-4}@anchor{149c}
@section What’s New in 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

This article explains the new features in Python 2.4.1, released on March 30,
2005.

Python 2.4 is a medium-sized release.  It doesn’t introduce as many changes as
the radical Python 2.2, but introduces more features than the conservative 2.3
release.  The most significant new language features are function decorators and
generator expressions; most other changes are to the standard library.

According to the CVS change logs, there were 481 patches applied and 502 bugs
fixed between Python 2.3 and 2.4.  Both figures are likely to be underestimates.

This article doesn’t attempt to provide a complete specification of every single
new feature, but instead provides a brief introduction to each feature.  For
full details, you should refer to the documentation for Python 2.4, such as the
Python Library Reference and the Python Reference Manual.  Often you will be
referred to the PEP for a particular new feature for explanations of the
implementation and design rationale.

@c ======================================================================

@menu
* PEP 218; Built-In Set Objects: PEP 218 Built-In Set Objects. 
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers. 
* PEP 289; Generator Expressions: PEP 289 Generator Expressions. 
* PEP 292; Simpler String Substitutions: PEP 292 Simpler String Substitutions. 
* PEP 318; Decorators for Functions and Methods: PEP 318 Decorators for Functions and Methods. 
* PEP 322; Reverse Iteration: PEP 322 Reverse Iteration. 
* PEP 324; New subprocess Module: PEP 324 New subprocess Module. 
* PEP 327; Decimal Data Type: PEP 327 Decimal Data Type. 
* PEP 328; Multi-line Imports: PEP 328 Multi-line Imports. 
* PEP 331; Locale-Independent Float/String Conversions: PEP 331 Locale-Independent Float/String Conversions. 
* Outras mudanças na linguagem: Outras mudanças na linguagem<17>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<3>. 
* Mudanças a construções e API C: Mudanças a construções e API C<11>. 
* Porting to Python 2.4: Porting to Python 2 4. 
* Reconhecimentos: Reconhecimentos<4>. 

@end menu

@node PEP 218 Built-In Set Objects,PEP 237 Unifying Long Integers and Integers,,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-218-built-in-set-objects}@anchor{149d}
@subsection PEP 218: Built-In Set Objects


Python 2.3 introduced the @code{sets} module.  C implementations of set data
types have now been added to the Python core as two new built-in types,
@code{set(iterable)} and @code{frozenset(iterable)}.  They provide high speed
operations for membership testing, for eliminating duplicates from sequences,
and for mathematical operations like unions, intersections, differences, and
symmetric differences.

@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

The @ref{5da,,frozenset()} type is an immutable version of @ref{5d9,,set()}. Since it is
immutable and hashable, it may be used as a dictionary key or as a member of
another set.

The @code{sets} module remains in the standard library, and may be useful if you
wish to subclass the @code{Set} or @code{ImmutableSet} classes.  There are
currently no plans to deprecate the module.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - Adding a Built-In Set Object Type

Originally proposed by Greg Wilson and ultimately implemented by Raymond
Hettinger.
@end table


@c ======================================================================

@node PEP 237 Unifying Long Integers and Integers,PEP 289 Generator Expressions,PEP 218 Built-In Set Objects,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-237-unifying-long-integers-and-integers}@anchor{149e}
@subsection PEP 237: Unifying Long Integers and Integers


The lengthy transition process for this PEP, begun in Python 2.2, takes another
step forward in Python 2.4.  In 2.3, certain integer operations that would
behave differently after int/long unification triggered @ref{415,,FutureWarning}
warnings and returned values limited to 32 or 64 bits (depending on your
platform).  In 2.4, these expressions no longer produce a warning and instead
produce a different result that’s usually a long integer.

The problematic expressions are primarily left shifts and lengthy hexadecimal
and octal constants.  For example, @code{2 << 32} results in a warning in 2.3,
evaluating to 0 on 32-bit platforms.  In Python 2.4, this expression now returns
the correct answer, 8589934592.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - Unifying Long Integers and Integers

Original PEP written by Moshe Zadka and GvR.  The changes for 2.4 were
implemented by  Kalle Svensson.
@end table


@c ======================================================================

@node PEP 289 Generator Expressions,PEP 292 Simpler String Substitutions,PEP 237 Unifying Long Integers and Integers,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-289-generator-expressions}@anchor{149f}
@subsection PEP 289: Generator Expressions


The iterator feature introduced in Python 2.2 and the @ref{81,,itertools} module
make it easier to write programs that loop through large data sets without
having the entire data set in memory at one time.  List comprehensions don’t fit
into this picture very well because they produce a Python list object containing
all of the items.  This unavoidably pulls all of the objects into memory, which
can be a problem if your data set is very large.  When trying to write a
functionally styled program, it would be natural to write something like:

@example
links = [link for link in get_all_links() if not link.followed]
for link in links:
    ...
@end example

instead of

@example
for link in get_all_links():
    if link.followed:
        continue
    ...
@end example

The first form is more concise and perhaps more readable, but if you’re dealing
with a large number of link objects you’d have to write the second form to avoid
having all link objects in memory at the same time.

Generator expressions work similarly to list comprehensions but don’t
materialize the entire list; instead they create a generator that will return
elements one by one.  The above example could be written as:

@example
links = (link for link in get_all_links() if not link.followed)
for link in links:
    ...
@end example

Generator expressions always have to be written inside parentheses, as in the
above example.  The parentheses signalling a function call also count, so if you
want to create an iterator that will be immediately passed to a function you
could write:

@example
print sum(obj.count for obj in list_all_objects())
@end example

Generator expressions differ from list comprehensions in various small ways.
Most notably, the loop variable (`obj' in the above example) is not accessible
outside of the generator expression.  List comprehensions leave the variable
assigned to its last value; future versions of Python will change this, making
list comprehensions match generator expressions in this respect.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 289

@item PEP 289@footnote{https://peps.python.org/pep-0289/} - Generator Expressions

Proposed by Raymond Hettinger and implemented by Jiwon Seo with early efforts
steered by Hye-Shik Chang.
@end table


@c ======================================================================

@node PEP 292 Simpler String Substitutions,PEP 318 Decorators for Functions and Methods,PEP 289 Generator Expressions,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-292-simpler-string-substitutions}@anchor{14a0}
@subsection PEP 292: Simpler String Substitutions


Some new classes in the standard library provide an alternative mechanism for
substituting variables into strings; this style of substitution may be better
for applications where untrained users need to edit templates.

The usual way of substituting variables by name is the @code{%} operator:

@example
>>> '%(page)i: %(title)s' % @{'page':2, 'title': 'The Best of Times'@}
'2: The Best of Times'
@end example

When writing the template string, it can be easy to forget the @code{i} or @code{s}
after the closing parenthesis.  This isn’t a big problem if the template is in a
Python module, because you run the code, get an “Unsupported format character”
@ref{202,,ValueError}, and fix the problem.  However, consider an application such
as Mailman where template strings or translations are being edited by users who
aren’t aware of the Python language.  The format string’s syntax is complicated
to explain to such users, and if they make a mistake, it’s difficult to provide
helpful feedback to them.

PEP 292 adds a @code{Template} class to the @ref{d3,,string} module that uses
@code{$} to indicate a substitution:

@example
>>> import string
>>> t = string.Template('$page: $title')
>>> t.substitute(@{'page':2, 'title': 'The Best of Times'@})
'2: The Best of Times'
@end example

If a key is missing from the dictionary, the @code{substitute()} method will
raise a @ref{344,,KeyError}.  There’s also a @code{safe_substitute()} method that
ignores missing keys:

@example
>>> t = string.Template('$page: $title')
>>> t.safe_substitute(@{'page':3@})
'3: $title'
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 292

@item PEP 292@footnote{https://peps.python.org/pep-0292/} - Simpler String Substitutions

Written and implemented  by Barry Warsaw.
@end table


@c ======================================================================

@node PEP 318 Decorators for Functions and Methods,PEP 322 Reverse Iteration,PEP 292 Simpler String Substitutions,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-318-decorators-for-functions-and-methods}@anchor{14a1}
@subsection PEP 318: Decorators for Functions and Methods


Python 2.2 extended Python’s object model by adding static methods and class
methods, but it didn’t extend Python’s syntax to provide any new way of defining
static or class methods.  Instead, you had to write a @ref{14a2,,def} statement
in the usual way, and pass the resulting method to a @ref{416,,staticmethod()} or
@ref{166,,classmethod()} function that would wrap up the function as a method of the
new type. Your code would look like this:

@example
class C:
   def meth (cls):
       ...

   meth = classmethod(meth)   # Rebind name to wrapped-up class method
@end example

If the method was very long, it would be easy to miss or forget the
@ref{166,,classmethod()} invocation after the function body.

The intention was always to add some syntax to make such definitions more
readable, but at the time of 2.2’s release a good syntax was not obvious.  Today
a good syntax `still' isn’t obvious but users are asking for easier access to
the feature; a new syntactic feature has been added to meet this need.

The new feature is called “function decorators”.  The name comes from the idea
that @ref{166,,classmethod()}, @ref{416,,staticmethod()}, and friends are storing
additional information on a function object; they’re `decorating' functions with
more details.

The notation borrows from Java and uses the @code{'@@'} character as an indicator.
Using the new syntax, the example above would be written:

@example
class C:

   @@classmethod
   def meth (cls):
       ...
@end example

The @code{@@classmethod} is shorthand for the @code{meth=classmethod(meth)} assignment.
More generally, if you have the following:

@example
@@A
@@B
@@C
def f ():
    ...
@end example

It’s equivalent to the following pre-decorator code:

@example
def f(): ...
f = A(B(C(f)))
@end example

Decorators must come on the line before a function definition, one decorator per
line, and can’t be on the same line as the def statement, meaning that @code{@@A def
f(): ...} is illegal.  You can only decorate function definitions, either at
the module level or inside a class; you can’t decorate class definitions.

A decorator is just a function that takes the function to be decorated as an
argument and returns either the same function or some new object.  The return
value of the decorator need not be callable (though it typically is), unless
further decorators will be applied to the result.  It’s easy to write your own
decorators.  The following simple example just sets an attribute on the function
object:

@example
>>> def deco(func):
...    func.attr = 'decorated'
...    return func
...
>>> @@deco
... def f(): pass
...
>>> f
<function f at 0x402ef0d4>
>>> f.attr
'decorated'
>>>
@end example

As a slightly more realistic example, the following decorator checks that the
supplied argument is an integer:

@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

An example in 
@geindex Propostas de Melhorias do Python; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/} contains a fancier version of this idea that lets you
both specify the required type and check the returned type.

Decorator functions can take arguments.  If arguments are supplied, your
decorator function is called with only those arguments and must return a new
decorator function; this function must take a single function and return a
function, as previously described.  In other words, @code{@@A @@B @@C(args)} becomes:

@example
def f(): ...
_deco = C(args)
f = A(B(_deco(f)))
@end example

Getting this right can be slightly brain-bending, but it’s not too difficult.

A small related change makes the @ref{1317,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} - Decorators for Functions, Methods and Classes

Written  by Kevin D. Smith, Jim Jewett, and Skip Montanaro.  Several people
wrote patches implementing function decorators, but the one that was actually
checked in was patch #979728, written by Mark Russell.

@item @indicateurl{https://wiki.python.org/moin/PythonDecoratorLibrary}

This Wiki page contains several examples of decorators.
@end table


@c ======================================================================

@node PEP 322 Reverse Iteration,PEP 324 New subprocess Module,PEP 318 Decorators for Functions and Methods,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-322-reverse-iteration}@anchor{14a3}
@subsection PEP 322: Reverse Iteration


A new built-in function, @code{reversed(seq)}, takes a sequence and returns an
iterator that loops over the elements of the sequence  in reverse order.

@example
>>> for i in reversed(xrange(1,4)):
...    print i
...
3
2
1
@end example

Compared to extended slicing, such as @code{range(1,4)[::-1]}, @ref{869,,reversed()} is
easier to read, runs faster, and uses substantially less memory.

Note that @ref{869,,reversed()} only accepts sequences, not arbitrary iterators.  If
you want to reverse an iterator, first convert it to  a list with @ref{611,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 322

@item PEP 322@footnote{https://peps.python.org/pep-0322/} - Reverse Iteration

Written and implemented by Raymond Hettinger.
@end table


@c ======================================================================

@node PEP 324 New subprocess Module,PEP 327 Decimal Data Type,PEP 322 Reverse Iteration,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-324-new-subprocess-module}@anchor{14a4}
@subsection PEP 324: New subprocess Module


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{199,,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' is commonly a sequence of strings that will be the arguments to the
program executed as the subprocess.  (If the `shell' argument is true, `args'
can be a string which will then be passed on to the shell for interpretation,
just as @ref{14a5,,os.system()} does.)

`stdin', `stdout', and `stderr' specify what the subprocess’s input, output, and
error streams will be.  You can provide a file object or a file descriptor, or
you can use the constant @code{subprocess.PIPE} to create a pipe between the
subprocess and the parent.

@geindex novas linhas universais;What's new

The constructor has a number of handy options:


@itemize *

@item 
`close_fds' requests that all file descriptors be closed before running the
subprocess.

@item 
`cwd' specifies the working directory in which the subprocess will be executed
(defaulting to whatever the parent’s working directory is).

@item 
`env' is a dictionary specifying environment variables.

@item 
`preexec_fn' is a function that gets called before the child is started.

@item 
`universal_newlines' opens the child’s input and output using Python’s
@ref{d5c,,universal newlines} feature.
@end itemize

Once you’ve created the @code{Popen} instance,  you can call its @code{wait()}
method to pause until the subprocess has exited, @code{poll()} to check if it’s
exited without pausing,  or @code{communicate(data)} to send the string `data'
to the subprocess’s standard input.   @code{communicate(data)}  then reads any
data that the subprocess has sent to its standard output  or standard error,
returning a tuple @code{(stdout_data, stderr_data)}.

@code{call()} is a shortcut that passes its arguments along to the @code{Popen}
constructor, waits for the command to complete, and returns the status code of
the subprocess.  It can serve as a safer analog to @ref{14a5,,os.system()}:

@example
sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
if sts == 0:
    # Success
    ...
else:
    # dpkg returned an error
    ...
@end example

The command is invoked without use of the shell.  If you really do want to  use
the shell, you can add @code{shell=True} as a keyword argument and provide a string
instead of a sequence:

@example
sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
@end example

The PEP takes various examples of shell and Python code and shows how they’d be
translated into Python code that uses @ref{d6,,subprocess}.  Reading this section
of the PEP is highly recommended.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 324

@item PEP 324@footnote{https://peps.python.org/pep-0324/} - subprocess - New process module

Written and implemented by Peter Åstrand, with assistance from Fredrik Lundh and
others.
@end table


@c ======================================================================

@node PEP 327 Decimal Data Type,PEP 328 Multi-line Imports,PEP 324 New subprocess Module,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-327-decimal-data-type}@anchor{14a6}
@subsection PEP 327: Decimal Data Type


Python has always supported floating-point (FP) numbers, based on the underlying
C double type, as a data type.  However, while most programming
languages provide a floating-point type, many people (even programmers) are
unaware that floating-point numbers don’t represent certain decimal fractions
accurately.  The new @code{Decimal} type can represent these fractions
accurately, up to a user-specified precision limit.

@menu
* Why is Decimal needed?:: 
* The Decimal type:: 
* The Context type:: 

@end menu

@node Why is Decimal needed?,The Decimal type,,PEP 327 Decimal Data Type
@anchor{whatsnew/2 4 why-is-decimal-needed}@anchor{14a7}
@subsubsection Why is Decimal needed?


The limitations arise from the representation used for floating-point numbers.
FP numbers are made up of three components:


@itemize *

@item 
The sign, which is positive or negative.

@item 
The mantissa, which is a single-digit binary number   followed by a fractional
part.  For example, @code{1.01} in base-2 notation is @code{1 + 0/2 + 1/4}, or 1.25 in
decimal notation.

@item 
The exponent, which tells where the decimal point is located in the number
represented.
@end itemize

For example, the number 1.25 has positive sign, a mantissa value of 1.01 (in
binary), and an exponent of 0 (the decimal point doesn’t need to be shifted).
The number 5 has the same sign and mantissa, but the exponent is 2 because the
mantissa is multiplied by 4 (2 to the power of the exponent 2); 1.25 * 4 equals
5.

Modern systems usually provide floating-point support that conforms to a
standard called IEEE 754.  C’s double type is usually implemented as a
64-bit IEEE 754 number, which uses 52 bits of space for the mantissa.  This
means that numbers can only be specified to 52 bits of precision.  If you’re
trying to represent numbers whose expansion repeats endlessly, the expansion is
cut off after 52 bits. Unfortunately, most software needs to produce output in
base 10, and common fractions in base 10 are often repeating decimals in binary.
For example, 1.1 decimal is binary @code{1.0001100110011 ...}; .1 = 1/16 + 1/32 +
1/256 plus an infinite number of additional terms.  IEEE 754 has to chop off
that infinitely repeated decimal after 52 digits, so the representation is
slightly inaccurate.

Sometimes you can see this inaccuracy when the number is printed:

@example
>>> 1.1
1.1000000000000001
@end example

The inaccuracy isn’t always visible when you print the number because the
FP-to-decimal-string conversion is provided by the C library, and most C libraries try
to produce sensible output.  Even if it’s not displayed, however, the inaccuracy
is still there and subsequent operations can magnify the error.

For many applications this doesn’t matter.  If I’m plotting points and
displaying them on my monitor, the difference between 1.1 and 1.1000000000000001
is too small to be visible.  Reports often limit output to a certain number of
decimal places, and if you round the number to two or three or even eight
decimal places, the error is never apparent.  However, for applications where it
does matter,  it’s a lot of work to implement your own custom arithmetic
routines.

Hence, the @code{Decimal} type was created.

@node The Decimal type,The Context type,Why is Decimal needed?,PEP 327 Decimal Data Type
@anchor{whatsnew/2 4 the-decimal-type}@anchor{14a8}
@subsubsection The @code{Decimal} type


A new module, @ref{36,,decimal}, was added to Python’s standard library.  It
contains two classes, @code{Decimal} and @code{Context}.  @code{Decimal}
instances represent numbers, and @code{Context} instances are used to wrap up
various settings such as the precision and default rounding mode.

@code{Decimal} instances are immutable, like regular Python integers and FP
numbers; once it’s been created, you can’t change the value an instance
represents.  @code{Decimal} instances can be created from integers or
strings:

@example
>>> import decimal
>>> decimal.Decimal(1972)
Decimal("1972")
>>> decimal.Decimal("1.1")
Decimal("1.1")
@end example

You can also provide tuples containing the sign, the mantissa represented  as a
tuple of decimal digits, and the exponent:

@example
>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
Decimal("-14.75")
@end example

Cautionary note: the sign bit is a Boolean value, so 0 is positive and 1 is
negative.

Converting from floating-point numbers poses a bit of a problem: should the FP
number representing 1.1 turn into the decimal number for exactly 1.1, or for 1.1
plus whatever inaccuracies are introduced? The decision was to dodge the issue
and leave such a conversion out of the API.  Instead, you should convert the
floating-point number into a string using the desired precision and pass the
string to the @code{Decimal} constructor:

@example
>>> f = 1.1
>>> decimal.Decimal(str(f))
Decimal("1.1")
>>> decimal.Decimal('%.12f' % f)
Decimal("1.100000000000")
@end example

Once you have @code{Decimal} instances, you can perform the usual mathematical
operations on them.  One limitation: exponentiation requires an integer
exponent:

@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

You can combine @code{Decimal} instances with integers, but not with
floating-point numbers:

@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

@code{Decimal} numbers can be used with the @ref{8e,,math} and @ref{18,,cmath}
modules, but note that they’ll be immediately converted to  floating-point
numbers before the operation is performed, resulting in a possible loss of
precision and accuracy.  You’ll also get back a regular floating-point number
and not a @code{Decimal}.

@example
>>> import math, cmath
>>> d = decimal.Decimal('123456789012.345')
>>> math.sqrt(d)
351364.18288201344
>>> cmath.sqrt(-d)
351364.18288201344j
@end example

@code{Decimal} instances have a @code{sqrt()} method that returns a
@code{Decimal}, but if you need other things such as trigonometric functions
you’ll have to implement them.

@example
>>> d.sqrt()
Decimal("351364.1828820134592177245001")
@end example

@node The Context type,,The Decimal type,PEP 327 Decimal Data Type
@anchor{whatsnew/2 4 the-context-type}@anchor{14a9}
@subsubsection The @code{Context} type


Instances of the @code{Context} class encapsulate several settings for
decimal operations:


@itemize *

@item 
@code{prec} is the precision, the number of decimal places.

@item 
@code{rounding} specifies the rounding mode.  The @ref{36,,decimal} module has
constants for the various possibilities: @code{ROUND_DOWN},
@code{ROUND_CEILING},  @code{ROUND_HALF_EVEN}, and various others.

@item 
@code{traps} is a dictionary specifying what happens on encountering certain
error conditions: either  an exception is raised or  a value is returned.  Some
examples of error conditions are division by zero, loss of precision, and
overflow.
@end itemize

There’s a thread-local default context available by calling @code{getcontext()};
you can change the properties of this context to alter the default precision,
rounding, or trap handling.  The following example shows the effect of changing
the precision of the default context:

@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

The default action for error conditions is selectable; the module can either
return a special value such as infinity or not-a-number, or exceptions can be
raised:

@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

The @code{Context} instance also has various methods for formatting  numbers
such as @code{to_eng_string()} and @code{to_sci_string()}.

For more information, see the documentation for the @ref{36,,decimal} module, which
includes a quick-start tutorial and a reference.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 327

@item PEP 327@footnote{https://peps.python.org/pep-0327/} - Decimal Data Type

Written by Facundo Batista and implemented by Facundo Batista, Eric Price,
Raymond Hettinger, Aahz, and Tim Peters.

@item http://www.lahey.com/float.htm@footnote{https://web.archive.org/web/20230604072523/http://www.lahey.com/float.htm}

The article uses Fortran code to illustrate many of the problems that
floating-point inaccuracy can cause.

@item @indicateurl{https://speleotrove.com/decimal/}

A description of a decimal-based representation.  This representation is being
proposed as a standard, and underlies the new Python decimal type.  Much of this
material was written by Mike Cowlishaw, designer of the Rexx language.
@end table


@c ======================================================================

@node PEP 328 Multi-line Imports,PEP 331 Locale-Independent Float/String Conversions,PEP 327 Decimal Data Type,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-328-multi-line-imports}@anchor{14aa}
@subsection PEP 328: Multi-line Imports


One language change is a small syntactic tweak aimed at making it easier to
import many names from a module.  In a @code{from module import names} statement,
`names' is a sequence of names separated by commas.  If the sequence is  very
long, you can either write multiple imports from the same module, or you can use
backslashes to escape the line endings like this:

@example
from SimpleXMLRPCServer import SimpleXMLRPCServer,\
            SimpleXMLRPCRequestHandler,\
            CGIXMLRPCRequestHandler,\
            resolve_dotted_attribute
@end example

The syntactic change in Python 2.4 simply allows putting the names within
parentheses.  Python ignores newlines within a parenthesized expression, so the
backslashes are no longer needed:

@example
from SimpleXMLRPCServer import (SimpleXMLRPCServer,
                                SimpleXMLRPCRequestHandler,
                                CGIXMLRPCRequestHandler,
                                resolve_dotted_attribute)
@end example

The PEP also proposes that all @ref{5e2,,import} statements be absolute imports,
with a leading @code{.} character to indicate a relative import.  This part of the
PEP was not implemented for Python 2.4, but was completed for Python 2.5.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - Importações: Multilinha e absoluta/relativa

Written by Aahz.  Multi-line imports were implemented by Dima Dorfman.
@end table


@c ======================================================================

@node PEP 331 Locale-Independent Float/String Conversions,Outras mudanças na linguagem<17>,PEP 328 Multi-line Imports,What’s New in Python 2 4
@anchor{whatsnew/2 4 pep-331-locale-independent-float-string-conversions}@anchor{14ab}
@subsection PEP 331: Locale-Independent Float/String Conversions


The @ref{86,,locale} modules lets Python software select various conversions and
display conventions that are localized to a particular country or language.
However, the module was careful to not change the numeric locale because various
functions in Python’s implementation required that the numeric locale remain set
to the @code{'C'} locale.  Often this was because the code was using the C
library’s @code{atof()} function.

Not setting the numeric locale caused trouble for extensions that used third-party
C libraries, however, because they wouldn’t have the correct locale set.
The motivating example was GTK+, whose user interface widgets weren’t displaying
numbers in the current locale.

The solution described in the PEP is to add three new functions to the Python
API that perform ASCII-only conversions, ignoring the locale setting:


@itemize *

@item 
@code{PyOS_ascii_strtod(str, ptr)}  and @code{PyOS_ascii_atof(str, ptr)}
both convert a string to a C double.

@item 
@code{PyOS_ascii_formatd(buffer, buf_len, format, d)} converts a
double to an ASCII string.
@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 331

@item PEP 331@footnote{https://peps.python.org/pep-0331/} - Locale-Independent Float/String Conversions

Written by Christian R. Reis, and implemented by Gustavo Carneiro.
@end table


@c ======================================================================

@node Outras mudanças na linguagem<17>,New Improved and Deprecated Modules<3>,PEP 331 Locale-Independent Float/String Conversions,What’s New in Python 2 4
@anchor{whatsnew/2 4 other-language-changes}@anchor{14ac}
@subsection Outras mudanças na linguagem


Here are all of the changes that Python 2.4 makes to the core Python language.


@itemize *

@item 
Decorators for functions and methods were added (
@geindex Propostas de Melhorias do Python; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/}).

@item 
Built-in @ref{5d9,,set()} and @ref{5da,,frozenset()} types were  added (
@geindex Propostas de Melhorias do Python; PEP 218
PEP 218@footnote{https://peps.python.org/pep-0218/}).
Other new built-ins include the @code{reversed(seq)} function (
@geindex Propostas de Melhorias do Python; PEP 322
PEP 322@footnote{https://peps.python.org/pep-0322/}).

@item 
Generator expressions were added (
@geindex Propostas de Melhorias do Python; PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/}).

@item 
Certain numeric expressions no longer return values restricted to 32 or 64
bits (
@geindex Propostas de Melhorias do Python; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}).

@item 
You can now put parentheses around the list of names in a @code{from module import
names} statement (
@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/}).

@item 
The @ref{14ad,,dict.update()} method now accepts the same argument forms as the
@ref{256,,dict} constructor.  This includes any mapping, any iterable of key/value
pairs, and keyword arguments. (Contributed by Raymond Hettinger.)

@item 
The string methods @code{ljust()}, @code{rjust()}, and @code{center()} now take
an optional argument for specifying a fill character other than a space.
(Contributed by Raymond Hettinger.)

@item 
Strings also gained an @code{rsplit()} method that works like the @code{split()}
method but splits from the end of the string.   (Contributed by Sean
Reifschneider.)

@example
>>> 'www.python.org'.split('.', 1)
['www', 'python.org']
'www.python.org'.rsplit('.', 1)
['www.python', 'org']
@end example

@item 
Three keyword parameters, `cmp', `key', and `reverse', were added to the
@code{sort()} method of lists. These parameters make some common usages of
@code{sort()} simpler. All of these parameters are optional.

For the `cmp' parameter, the value should be a comparison function that takes
two parameters and returns -1, 0, or +1 depending on how the parameters compare.
This function will then be used to sort the list.  Previously this was the only
parameter that could be provided to @code{sort()}.

`key' should be a single-parameter function that takes a list element and
returns a comparison key for the element.  The list is then sorted using the
comparison keys.  The following example sorts a list case-insensitively:

@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

The last example, which uses the `cmp' parameter, is the old way to perform a
case-insensitive sort.  It works but is slower than using a `key' parameter.
Using `key' calls @code{lower()} method once for each element in the list while
using `cmp' will call it twice for each comparison, so using `key' saves on
invocations of the @code{lower()} method.

For simple key functions and comparison functions, it is often possible to avoid
a @ref{12df,,lambda} expression by using an unbound method instead.  For example,
the above case-insensitive sort is best written as:

@example
>>> L.sort(key=str.lower)
>>> L
['A', 'b', 'c', 'D']
@end example

Finally, the `reverse' parameter takes a Boolean value.  If the value is true,
the list will be sorted into reverse order. Instead of @code{L.sort();
L.reverse()}, you can now write @code{L.sort(reverse=True)}.

The results of sorting are now guaranteed to be stable.  This means that two
entries with equal keys will be returned in the same order as they were input.
For example, you can sort a list of people by name, and then sort the list by
age, resulting in a list sorted by age where people with the same age are in
name-sorted order.

(All changes to @code{sort()} contributed by Raymond Hettinger.)

@item 
There is a new built-in function @code{sorted(iterable)} that works like the
in-place @ref{be8,,list.sort()} method but can be used in expressions.  The
differences are:

@item 
the input may be any iterable;

@item 
a newly formed copy is sorted, leaving the original intact; and

@item 
the expression returns the new sorted copy

@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

(Contributed by Raymond Hettinger.)

@item 
Integer operations will no longer trigger an @code{OverflowWarning}. The
@code{OverflowWarning} warning will disappear in Python 2.5.

@item 
The interpreter gained a new switch, @ref{5e1,,-m}, that takes a name, searches
for the corresponding  module on @code{sys.path}, and runs the module as a script.
For example,  you can now run the Python profiler with @code{python -m profile}.
(Contributed by Nick Coghlan.)

@item 
The @code{eval(expr, globals, locals)} and @code{execfile(filename, globals,
locals)} functions and the @code{exec} statement now accept any mapping type
for the `locals' parameter.  Previously this had to be a regular Python
dictionary.  (Contributed by Raymond Hettinger.)

@item 
The @ref{7d1,,zip()} built-in function and @code{itertools.izip()} now return an
empty list if called with no arguments. Previously they raised a
@ref{2c3,,TypeError} exception.  This makes them more suitable for use with variable
length argument lists:

@example
>>> def transpose(array):
...    return zip(*array)
...
>>> transpose([(1,2,3), (4,5,6)])
[(1, 4), (2, 5), (3, 6)]
>>> transpose([])
[]
@end example

(Contributed by Raymond Hettinger.)

@item 
Encountering a failure while importing a module no longer leaves a partially initialized
module object in @code{sys.modules}.  The incomplete module object left
behind would fool further imports of the same module into succeeding, leading to
confusing errors.   (Fixed by Tim Peters.)

@item 
@ref{675,,None} is now a constant; code that binds a new value to  the name
@code{None} is now a syntax error. (Contributed by Raymond Hettinger.)
@end itemize

@c ======================================================================

@menu
* Otimizações: Otimizações<16>. 

@end menu

@node Otimizações<16>,,,Outras mudanças na linguagem<17>
@anchor{whatsnew/2 4 optimizations}@anchor{14ae}
@subsubsection Otimizações



@itemize *

@item 
The inner loops for list and tuple slicing were optimized and now run about
one-third faster.  The inner loops for dictionaries were also optimized,
resulting in performance boosts for @code{keys()}, @code{values()}, @code{items()},
@code{iterkeys()}, @code{itervalues()}, and @code{iteritems()}. (Contributed by
Raymond Hettinger.)

@item 
The machinery for growing and shrinking lists was optimized for speed and for
space efficiency.  Appending and popping from lists now runs faster due to more
efficient code paths and less frequent use of the underlying system
@code{realloc()}.  List comprehensions also benefit.   @ref{35d,,list.extend()} was
also optimized and no longer converts its argument into a temporary list before
extending the base list.  (Contributed by Raymond Hettinger.)

@item 
@ref{611,,list()}, @ref{370,,tuple()}, @ref{867,,map()}, @ref{868,,filter()}, and @ref{7d1,,zip()} now
run several times faster with non-sequence arguments that supply a
@code{__len__()} method.  (Contributed by Raymond Hettinger.)

@item 
The methods @code{list.__getitem__()}, @code{dict.__getitem__()}, and
@code{dict.__contains__()} are now implemented as @code{method_descriptor}
objects rather than @code{wrapper_descriptor} objects.  This form of  access
doubles their performance and makes them more suitable for use as arguments to
functionals: @code{map(mydict.__getitem__, keylist)}. (Contributed by Raymond
Hettinger.)

@item 
Added a new opcode, @code{LIST_APPEND}, that simplifies the generated bytecode
for list comprehensions and speeds them up by about a third.  (Contributed by
Raymond Hettinger.)

@item 
The peephole bytecode optimizer has been improved to  produce shorter, faster
bytecode; remarkably, the resulting bytecode is  more readable.  (Enhanced by
Raymond Hettinger.)

@item 
String concatenations in statements of the form @code{s = s + "abc"} and @code{s +=
"abc"} are now performed more efficiently in certain circumstances.  This
optimization won’t be present in other Python implementations such as Jython, so
you shouldn’t rely on it; using the @code{join()} method of strings is still
recommended when you want to efficiently glue a large number of strings
together. (Contributed by Armin Rigo.)
@end itemize

The net result of the 2.4 optimizations is that Python 2.4 runs the pystone
benchmark around 5% faster than Python 2.3 and 35% faster than Python 2.2.
(pystone is not a particularly good benchmark, but it’s the most commonly used
measurement of Python’s performance.  Your own applications may show greater or
smaller benefits from 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 New Improved and Deprecated Modules<3>,Mudanças a construções e API C<11>,Outras mudanças na linguagem<17>,What’s New in Python 2 4
@anchor{whatsnew/2 4 new-improved-and-deprecated-modules}@anchor{14af}
@subsection New, Improved, and Deprecated Modules


As usual, Python’s standard library received a number of enhancements and bug
fixes.  Here’s a partial list of the most notable changes, sorted alphabetically
by module name. Consult the @code{Misc/NEWS} file in the source tree for a more
complete list of changes, or look through the CVS logs for all the details.


@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 
The @ref{e,,base64} module now has more complete 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html} support for Base64,
Base32, and Base16 encoding and decoding, including optional case folding and
optional alternative alphabets. (Contributed by Barry Warsaw.)

@item 
The @ref{11,,bisect} module now has an underlying C implementation for improved
performance. (Contributed by Dmitry Vasiliev.)

@item 
The CJKCodecs collections of East Asian codecs, maintained by Hye-Shik Chang,
was integrated into 2.4.   The new encodings are:

@item 
Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz

@item 
Chinese (ROC): big5, cp950

@item 

@table @asis

@item Japanese: 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 
Korean: cp949, euc-kr, johab, iso-2022-kr

@item 
Some other new encodings were added: HP Roman8,  ISO_8859-11, ISO_8859-16,
PCTP-154, and TIS-620.

@item 
The UTF-8 and UTF-16 codecs now cope better with receiving partial input.
Previously the @code{StreamReader} class would try to read more data, making
it impossible to resume decoding from the stream.  The @code{read()} method will
now return as much data as it can and future calls will resume decoding where
previous ones left off.  (Implemented by Walter Dörwald.)

@item 
There is a new @ref{1d,,collections} module for  various specialized collection
datatypes.  Currently it contains just one type, @code{deque}, a double-ended
queue that supports efficiently adding and removing elements from either
end:

@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

Several modules, such as the @code{Queue} and @ref{ed,,threading} modules, now take
advantage of @ref{5dc,,collections.deque} for improved performance.  (Contributed
by Raymond Hettinger.)

@item 
The @ref{22,,ConfigParser} classes have been enhanced slightly. The @ref{14b0,,read()}
method now returns a list of the files that were successfully parsed, and the
@ref{12ae,,set()} method raises @ref{2c3,,TypeError} if passed a `value' argument that
isn’t a string.   (Contributed by John Belmonte and David Goodger.)

@item 
The @ref{2b,,curses} module now supports the ncurses extension
@code{use_default_colors()}.  On platforms where the terminal supports
transparency, this makes it possible to use a transparent background.
(Contributed by Jörg Lehmann.)

@item 
The @ref{37,,difflib} module now includes an @code{HtmlDiff} class that creates
an HTML table showing a side by side comparison of two versions of a text.
(Contributed by Dan Gass.)

@item 
The @ref{3b,,email} package was updated to version 3.0,  which dropped various
deprecated APIs and removes support for Python versions earlier than 2.3.  The
3.0 version of the package uses a new incremental parser for MIME messages,
available in the @code{email.FeedParser} module.  The new parser doesn’t require
reading the entire message into memory, and doesn’t raise exceptions if a
message is malformed; instead it records any problems in the  @code{defect}
attribute of the message.  (Developed by Anthony Baxter, Barry Warsaw, Thomas
Wouters, and others.)

@item 
The @ref{69,,heapq} module has been converted to C.  The resulting tenfold
improvement in speed makes the module suitable for handling high volumes of
data.  In addition, the module has two new functions @code{nlargest()} and
@code{nsmallest()} that use heaps to find the N largest or smallest values in a
dataset without the expense of a full sort.  (Contributed by 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 
The @ref{74,,imaplib} module now supports IMAP’s THREAD command (contributed by
Yves Dionne) and new @code{deleteacl()} and @code{myrights()} methods (contributed
by Arnaud Mazin).

@item 
The @ref{81,,itertools} module gained a @code{groupby(iterable[, *func*])}
function. `iterable' is something that can be iterated over to return a stream
of elements, and the optional `func' parameter is a function that takes an
element and returns a key value; if omitted, the key is simply the element
itself.  @code{groupby()} then groups the elements into subsequences which have
matching values of the key, and returns a series of 2-tuples containing the key
value and an iterator over the subsequence.

Here’s an example to make this clearer.  The `key' function simply returns
whether a number is even or odd, so the result of @code{groupby()} is to return
consecutive runs of odd or even numbers.

@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()} is typically used with sorted input.  The logic for
@code{groupby()} is similar to the Unix @code{uniq} filter which makes it handy for
eliminating, counting, or identifying duplicate elements:

@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

(Contributed by Hye-Shik Chang.)

@item 
@ref{81,,itertools} also gained a function named @code{tee(iterator, N)} that
returns `N' independent iterators that replicate `iterator'.  If `N' is omitted,
the default is 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

Note that @code{tee()} has to keep copies of the values returned  by the
iterator; in the worst case, it may need to keep all of them.   This should
therefore be used carefully if the leading iterator can run far ahead of the
trailing iterator in a long stream of inputs. If the separation is large, then
you might as well use  @ref{611,,list()} instead.  When the iterators track closely
with one another, @code{tee()} is ideal.  Possible applications include
bookmarking, windowing, or lookahead iterators. (Contributed by 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 
Some keyword arguments were added to the @ref{87,,logging} package’s
@code{basicConfig()} function to simplify log configuration.  The default
behavior is to log messages to standard error, but various keyword arguments can
be specified to log to a particular file, change the logging format, or set the
logging level. For example:

@example
import logging
logging.basicConfig(filename='/var/log/application.log',
    level=0,  # Log all messages
    format='%(levelname):%(process):%(thread):%(message)')
@end example

Other additions to the @ref{87,,logging} package include a @code{log(level, msg)}
convenience method, as well as a @code{TimedRotatingFileHandler} class that
rotates its log files at a timed interval.  The module already had
@code{RotatingFileHandler}, which rotated logs once the file exceeded a
certain size.  Both classes derive from a new @code{BaseRotatingHandler} class
that can be used to implement other rotating handlers.

(Changes implemented by Vinay Sajip.)

@item 
The @ref{8d,,marshal} module now shares interned strings on unpacking a  data
structure.  This may shrink the size of certain pickle strings, but the primary
effect is to make @code{.pyc} files significantly smaller. (Contributed by
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 
Two new functions were added to the @ref{9f,,operator} module,
@code{attrgetter(attr)} and @code{itemgetter(index)}. Both functions return
callables that take a single argument and return the corresponding attribute or
item; these callables make excellent data extractors when used with @ref{867,,map()}
or @ref{be7,,sorted()}.  For example:

@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

(Contributed by Raymond Hettinger.)

@item 
The @ref{a0,,optparse} module was updated in various ways.  The module now passes
its messages through @ref{14b1,,gettext.gettext()}, making it possible to
internationalize Optik’s help and error messages.  Help messages for options can
now include the string @code{'%default'}, which will be replaced by the option’s
default value.  (Contributed by Greg Ward.)

@item 
The long-term plan is to deprecate the @code{rfc822} module in some future
Python release in favor of the @ref{3b,,email} package. To this end, the
@ref{14b2,,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 
A new @code{urandom(n)} function was added to the @ref{a1,,os} module, returning
a string containing `n' bytes of random data.  This function provides access to
platform-specific sources of randomness such as @code{/dev/urandom} on Linux or
the Windows CryptoAPI.  (Contributed by Trevor Perrin.)

@item 
Another new function: @code{os.path.lexists(path)}  returns true if the file
specified by `path' exists, whether or not it’s a symbolic link.  This differs
from the existing @code{os.path.exists(path)} function, which returns false if
`path' is a symlink that points to a destination that doesn’t exist.
(Contributed by Beni Cherniavsky.)

@item 
A new @code{getsid()} function was added to the @ref{ad,,posix} module that
underlies the @ref{a1,,os} module. (Contributed by J. Raynor.)

@item 
The @ref{ac,,poplib} module now supports POP over SSL.  (Contributed by Hector
Urtubia.)

@item 
The @ref{af,,profile} module can now profile C extension functions. (Contributed
by Nick Bastin.)

@item 
The @ref{b8,,random} module has a new method called @code{getrandbits(N)} that
returns a long integer `N' bits in length.  The existing @code{randrange()}
method now uses @code{getrandbits()} where appropriate, making generation of
arbitrarily large random numbers more efficient.  (Contributed by Raymond
Hettinger.)

@item 
The regular expression language accepted by the @ref{b9,,re} module was extended
with simple conditional expressions, written as @code{(?(group)A|B)}.  `group' is
either a numeric group ID or a group name defined with @code{(?P<group>...)}
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' will be used instead. (Contributed by Gustavo Niemeyer.)

@item 
The @ref{b9,,re} module is also no longer recursive, thanks to a massive amount
of work by Gustavo Niemeyer.  In a recursive regular expression engine, certain
patterns result in a large amount of C stack space being consumed, and it was
possible to overflow the stack. For example, if you matched a 30000-byte string
of @code{a} characters against the expression @code{(a|b)+}, one stack frame was
consumed per character.  Python 2.3 tried to check for stack overflow and raise
a @ref{195,,RuntimeError} exception, but certain patterns could sidestep the
checking and if you were unlucky Python could segfault. Python 2.4’s regular
expression engine can match this pattern without problems.

@item 
The @ref{c6,,signal} module now performs tighter error-checking on the parameters
to the @ref{1173,,signal.signal()} function.  For example, you can’t set a handler on
the @code{SIGKILL} signal; previous versions of Python would quietly accept
this, but 2.4 will raise a @ref{195,,RuntimeError} exception.

@item 
Two new functions were added to the @ref{cc,,socket} module. @code{socketpair()}
returns a pair of connected sockets and @code{getservbyport(port)} looks up the
service name for a given port number. (Contributed by Dave Cole and Barry
Warsaw.)

@item 
The @code{sys.exitfunc()} function has been deprecated.  Code should be using
the existing @ref{c,,atexit} module, which correctly handles calling multiple exit
functions.  Eventually @code{sys.exitfunc()} will become a purely internal
interface, accessed only by @ref{c,,atexit}.

@item 
The @ref{de,,tarfile} module now generates GNU-format tar files by default.
(Contributed by Lars Gustäbel.)

@item 
The @ref{ed,,threading} module now has an elegantly simple way to support
thread-local data.  The module contains a @code{local} class whose attribute
values are local to different threads.

@example
import threading

data = threading.local()
data.number = 42
data.url = ('www.python.org', 80)
@end example

Other threads can assign and retrieve their own values for the @code{number}
and @code{url} attributes.  You can subclass @code{local} to initialize
attributes or to add methods. (Contributed by Jim Fulton.)

@item 
The @ref{ef,,timeit} module now automatically disables periodic garbage
collection during the timing loop.  This change makes consecutive timings more
comparable.  (Contributed by Raymond Hettinger.)

@item 
The @ref{114,,weakref} module now supports a wider variety of objects including
Python functions, class instances, sets, frozensets, deques, arrays, files,
sockets, and regular expression pattern objects. (Contributed by Raymond
Hettinger.)

@item 
The @ref{12e,,xmlrpclib} module now supports a multi-call extension for
transmitting multiple XML-RPC calls in a single HTTP operation. (Contributed by
Brian Quinlan.)

@item 
The @code{mpz}, @code{rotor}, and @code{xreadlines} modules have  been
removed.
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@c =====================

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

@end menu

@node cookielib,doctest<5>,,New Improved and Deprecated Modules<3>
@anchor{whatsnew/2 4 cookielib}@anchor{14b3}
@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.

In order to store cookies across sessions, two implementations of cookie jars
are provided: one that stores cookies in the Netscape format so applications can
use the Mozilla or Lynx cookie files, and one that stores cookies in the same
format as the Perl libwww library.

@ref{10b,,urllib2} has been changed to interact with @ref{70,,cookielib}:
@code{HTTPCookieProcessor} manages a cookie jar that is used when accessing
URLs.

This module was contributed by John J. Lee.

@c ==================

@node doctest<5>,,cookielib,New Improved and Deprecated Modules<3>
@anchor{whatsnew/2 4 doctest}@anchor{14b4}
@subsubsection doctest


The @ref{3a,,doctest} module underwent considerable refactoring thanks to Edward
Loper and Tim Peters.  Testing can still be as simple as running
@ref{14b5,,doctest.testmod()}, but the refactorings allow customizing the module’s
operation in various ways

The new @code{DocTestFinder} class extracts the tests from a given  object’s
docstrings:

@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

The new @code{DocTestRunner} class then runs individual tests and can produce
a summary of the results:

@example
runner = doctest.DocTestRunner()
for t in tests:
    tried, failed = runner.run(t)

runner.summarize(verbose=1)
@end example

The above example produces the following output:

@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} uses an instance of the @code{OutputChecker} class to
compare the expected output with the actual output.  This class takes a number
of different flags that customize its behaviour; ambitious users can also write
a completely new subclass of @code{OutputChecker}.

The default output checker provides a number of handy features. For example,
with the @ref{14b6,,doctest.ELLIPSIS} option flag, an ellipsis (@code{...}) in the
expected output matches any substring,  making it easier to accommodate outputs
that vary in minor ways:

@example
def o (n):
    """>>> o(1)
<__main__.C instance at 0x...>
>>>
"""
@end example

Another special string, @code{<BLANKLINE>}, matches a blank line:

@example
def p (n):
    """>>> p(1)
<BLANKLINE>
>>>
"""
@end example

Another new capability is producing a diff-style display of the output by
specifying the @ref{14b7,,doctest.REPORT_UDIFF} (unified diffs),
@ref{14b8,,doctest.REPORT_CDIFF} (context diffs), or @ref{14b9,,doctest.REPORT_NDIFF}
(delta-style) option flags.  For example:

@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

Running the above function’s tests with @ref{14b7,,doctest.REPORT_UDIFF} specified,
you get the following output:

@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 Mudanças a construções e API C<11>,Porting to Python 2 4,New Improved and Deprecated Modules<3>,What’s New in Python 2 4
@anchor{whatsnew/2 4 build-and-c-api-changes}@anchor{14ba}
@subsection Mudanças a construções e API C


Some of the changes to Python’s build process and to the C API are:


@itemize *

@item 
Three new convenience macros were added for common return values from
extension functions: @ref{14bb,,Py_RETURN_NONE}, @ref{14bc,,Py_RETURN_TRUE}, and
@ref{14bd,,Py_RETURN_FALSE}. (Contributed by Brett Cannon.)

@item 
Another new macro, @ref{578,,Py_CLEAR},  decreases the reference count of
`obj' and sets `obj' to the null pointer.  (Contributed by Jim Fulton.)

@item 
A new function, @code{PyTuple_Pack(N, obj1, obj2, ..., objN)}, constructs
tuples from a variable length argument list of Python objects.  (Contributed by
Raymond Hettinger.)

@item 
A new function, @code{PyDict_Contains(d, k)}, implements fast dictionary
lookups without masking exceptions raised during the look-up process.
(Contributed by Raymond Hettinger.)

@item 
The @ref{14be,,Py_IS_NAN}(X) macro returns 1 if  its float or double argument
`X' is a NaN.   (Contributed by Tim Peters.)

@item 
C code can avoid unnecessary locking by using the new
@code{PyEval_ThreadsInitialized()} function to tell  if any thread operations
have been performed.  If this function  returns false, no lock operations are
needed. (Contributed by Nick Coghlan.)

@item 
A new function, @ref{384,,PyArg_VaParseTupleAndKeywords()}, is the same as
@ref{383,,PyArg_ParseTupleAndKeywords()} but takes a  @code{va_list} instead of a
number of arguments. (Contributed by Greg Chapman.)

@item 
A new method flag, @ref{14bf,,METH_COEXIST}, allows a function defined in slots
to co-exist with a @ref{14c0,,PyCFunction} having the same name.  This can halve
the access time for a method such as @code{set.__contains__()}.  (Contributed by
Raymond Hettinger.)

@item 
Python can now be built with additional profiling for the interpreter itself,
intended as an aid to people developing the Python core.  Providing
@code{--enable-profiling} to the @code{configure} script will let you
profile the interpreter with @code{gprof}, and providing the
@code{--with-tsc} switch enables profiling using the Pentium’s
Time-Stamp-Counter register.  Note that the @code{--with-tsc} switch is slightly
misnamed, because the profiling feature also works on the PowerPC platform,
though that processor architecture doesn’t call that register “the TSC
register”.  (Contributed by Jeremy Hylton.)

@item 
The @code{tracebackobject} type has been renamed to
@code{PyTracebackObject}.
@end itemize

@c ======================================================================

@menu
* Port-Specific Changes: Port-Specific Changes<2>. 

@end menu

@node Port-Specific Changes<2>,,,Mudanças a construções e API C<11>
@anchor{whatsnew/2 4 port-specific-changes}@anchor{14c1}
@subsubsection Port-Specific Changes



@itemize *

@item 
The Windows port now builds under MSVC++ 7.1 as well as version 6.
(Contributed by Martin von Löwis.)
@end itemize

@c ======================================================================

@node Porting to Python 2 4,Reconhecimentos<4>,Mudanças a construções e API C<11>,What’s New in Python 2 4
@anchor{whatsnew/2 4 porting-to-python-2-4}@anchor{14c2}
@subsection Porting to Python 2.4


This section lists previously described changes that may require changes to your
code:


@itemize *

@item 
Left shifts and hexadecimal/octal constants that are too  large no longer
trigger a @ref{415,,FutureWarning} and return  a value limited to 32 or 64 bits;
instead they return a long integer.

@item 
Integer operations will no longer trigger an @code{OverflowWarning}. The
@code{OverflowWarning} warning will disappear in Python 2.5.

@item 
The @ref{7d1,,zip()} built-in function and @code{itertools.izip()} now return  an
empty list instead of raising a @ref{2c3,,TypeError} exception if called with no
arguments.

@item 
You can no longer compare the @code{date} and @ref{1cc,,datetime} instances
provided by the @ref{30,,datetime} module.  Two  instances of different classes
will now always be unequal, and  relative comparisons (@code{<}, @code{>}) will raise
a @ref{2c3,,TypeError}.

@item 
@code{dircache.listdir()} now passes exceptions to the caller instead of
returning empty lists.

@item 
@code{LexicalHandler.startDTD()} used to receive the public and system IDs in
the wrong order.  This has been corrected; applications relying on the wrong
order need to be fixed.

@item 
@ref{14c3,,fcntl.ioctl()} now warns if the `mutate'  argument is omitted and
relevant.

@item 
The @ref{de,,tarfile} module now generates GNU-format tar files by default.

@item 
Encountering a failure while importing a module no longer leaves a
partially initialized module object in @code{sys.modules}.

@item 
@ref{675,,None} is now a constant; code that binds a new value to  the name
@code{None} is now a syntax error.

@item 
The @code{signals.signal()} function now raises a @ref{195,,RuntimeError} exception
for certain illegal values; previously these errors would pass silently.  For
example, you can no longer set a handler on the @code{SIGKILL} signal.
@end itemize

@c ======================================================================

@node Reconhecimentos<4>,,Porting to Python 2 4,What’s New in Python 2 4
@anchor{whatsnew/2 4 acknowledgements}@anchor{14c4}@anchor{whatsnew/2 4 acks}@anchor{14c5}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions,
corrections and assistance with various drafts of this article: Koray Can,
Hye-Shik Chang, Michael Dyck, Raymond Hettinger, Brian Hurt, Hamish Lawson,
Fredrik Lundh, Sean Reifschneider, Sadruddin Rejeb.

@node What’s New in Python 2 3,What’s New in Python 2 2,What’s New in Python 2 4,O que há de novo no Python
@anchor{whatsnew/2 3 doc}@anchor{14c6}@anchor{whatsnew/2 3 translation-repo}@anchor{14c7}@anchor{whatsnew/2 3 what-s-new-in-python-2-3}@anchor{14c8}
@section What’s New in Python 2.3


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew23.tex 54631 2007-03-31 11:58:36Z georg.brandl $

This article explains the new features in Python 2.3.  Python 2.3 was released
on July 29, 2003.

The main themes for Python 2.3 are polishing some of the features added in 2.2,
adding various small but useful enhancements to the core language, and expanding
the standard library.  The new object model introduced in the previous version
has benefited from 18 months of bugfixes and from optimization efforts that have
improved the performance of new-style classes.  A few new built-in functions
have been added such as @ref{46a,,sum()} and @ref{14c9,,enumerate()}.  The @ref{2f4,,in}
operator can now be used for substring searches (e.g. @code{"ab" in "abc"} returns
@ref{c27,,True}).

Some of the many new library features include Boolean, set, heap, and date/time
data types, the ability to import modules from ZIP-format archives, metadata
support for the long-awaited Python catalog, an updated version of IDLE, and
modules for logging messages, wrapping text, parsing CSV files, processing
command-line options, using BerkeleyDB databases…  the list of new and
enhanced modules is lengthy.

This article doesn’t attempt to provide a complete specification of the new
features, but instead provides a convenient overview.  For full details, you
should refer to the documentation for Python 2.3, such as the Python Library
Reference and the Python Reference Manual.  If you want to understand the
complete implementation and design rationale, refer to the PEP for a particular
new feature.

@c ======================================================================

@menu
* PEP 218; A Standard Set Datatype: PEP 218 A Standard Set Datatype. 
* PEP 255; Simple Generators: PEP 255 Simple Generators. 
* PEP 263; Source Code Encodings: PEP 263 Source Code Encodings. 
* PEP 273; Importing Modules from ZIP Archives: PEP 273 Importing Modules from ZIP Archives. 
* PEP 277; Unicode file name support for Windows NT: PEP 277 Unicode file name support for Windows NT. 
* PEP 278; Universal Newline Support: PEP 278 Universal Newline Support. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; The logging Package: PEP 282 The logging Package. 
* PEP 285; A Boolean Type: PEP 285 A Boolean Type. 
* PEP 293; Codec Error Handling Callbacks: PEP 293 Codec Error Handling Callbacks. 
* PEP 301; Package Index and Metadata for Distutils: PEP 301 Package Index and Metadata for Distutils. 
* PEP 302; New Import Hooks: PEP 302 New Import Hooks. 
* PEP 305; Comma-separated Files: PEP 305 Comma-separated Files. 
* PEP 307; Pickle Enhancements: PEP 307 Pickle Enhancements. 
* Extended Slices:: 
* Outras mudanças na linguagem: Outras mudanças na linguagem<18>. 
* New@comma{} Improved@comma{} and Deprecated Modules: New Improved and Deprecated Modules<4>. 
* Pymalloc; A Specialized Object Allocator: Pymalloc A Specialized Object Allocator. 
* Mudanças a construções e API C: Mudanças a construções e API C<12>. 
* Outras alterações e correções: Outras alterações e correções<2>. 
* Porting to Python 2.3: Porting to Python 2 3. 
* Reconhecimentos: Reconhecimentos<5>. 

@end menu

@node PEP 218 A Standard Set Datatype,PEP 255 Simple Generators,,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-218-a-standard-set-datatype}@anchor{14ca}
@subsection PEP 218: A Standard Set Datatype


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.

Here’s a simple example:

@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{14cb,,union()} and
@ref{14cc,,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{14cd,,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{14ce,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - Adding a Built-In Set Object Type

PEP written by Greg V. Wilson. Implemented by Greg V. Wilson, Alex Martelli, and
GvR.
@end table


@c ======================================================================

@node PEP 255 Simple Generators,PEP 263 Source Code Encodings,PEP 218 A Standard Set Datatype,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-255-simple-generators}@anchor{14cf}@anchor{whatsnew/2 3 section-generators}@anchor{14d0}
@subsection PEP 255: Simple Generators


In Python 2.2, generators were added as an optional feature, to be enabled by a
@code{from __future__ import generators} directive.  In 2.3 generators no longer
need to be specially enabled, and are now always present; this means that
@ref{9d5,,yield} is now always a keyword.  The rest of this section is a copy of
the description of generators from the “What’s New in Python 2.2” document; if
you read it back when Python 2.2 came out, you can skip the rest of this
section.

You’re doubtless familiar with how function calls work in Python or C. When you
call a function, it gets a private namespace where its local variables are
created.  When the function reaches a @ref{9d6,,return} statement, the local
variables are destroyed and the resulting value is returned to the caller.  A
later call to the same function will get a fresh new set of local variables.
But, what if the local variables weren’t thrown away on exiting a function?
What if you could later resume the function where it left off?  This is what
generators provide; they can be thought of as resumable functions.

Here’s the simplest example of a generator function:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

A new keyword, @ref{9d5,,yield}, was introduced for generators.  Any function
containing a @code{yield} statement is a generator function; this is
detected by Python’s bytecode compiler which compiles the function specially as
a result.

When you call a generator function, it doesn’t return a single value; instead it
returns a generator object that supports the iterator protocol.  On executing
the @ref{9d5,,yield} statement, the generator outputs the value of @code{i},
similar to a @ref{9d6,,return} statement.  The big difference between
@code{yield} and a @code{return} statement is that on reaching a
@code{yield} the generator’s state of execution is suspended and local
variables are preserved.  On the next call to the generator’s @code{.next()}
method, the function will resume executing immediately after the
@code{yield} statement.  (For complicated reasons, the @code{yield}
statement isn’t allowed inside the @ref{6e9,,try} block of a
@code{try}…@code{finally} statement; read 
@geindex Propostas de Melhorias do Python; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/} for a full
explanation of the interaction between @code{yield} and exceptions.)

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

You could equally write @code{for i in generate_ints(5)}, or @code{a,b,c =
generate_ints(3)}.

Inside a generator function, the @ref{9d6,,return} statement can only be used
without a value, and signals the end of the procession of values; afterwards the
generator cannot return any further values. @code{return} with a value, such
as @code{return 5}, is a syntax error inside a generator function.  The end of the
generator’s results can also be indicated by raising @ref{c15,,StopIteration}
manually, or by just letting the flow of execution fall off the bottom of the
function.

You could achieve the effect of generators manually by writing your own class
and storing all the local variables of the generator as instance variables.  For
example, returning a list of integers could be done by setting @code{self.count} to
0, and having the @ref{7d9,,next()} method increment @code{self.count} and return it.
However, for a moderately complicated generator, writing a corresponding class
would be much messier. @code{Lib/test/test_generators.py} contains a number of
more interesting examples.  The simplest one implements an in-order traversal of
a tree using generators recursively.

@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

Two other examples in @code{Lib/test/test_generators.py} produce solutions for
the N-Queens problem (placing $N$ queens on an $NxN$ chess board so that no
queen threatens another) and the Knight’s Tour (a route that takes a knight to
every square of an $NxN$ chessboard without visiting any square twice).

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{2f3,,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 doesn’t go nearly as far as Icon in adopting generators as a central
concept.  Generators are considered part of the core Python language, but
learning or using them isn’t compulsory; if they don’t solve any problems that
you have, feel free to ignore them. One novel feature of Python’s interface as
compared to Icon’s is that a generator’s state is represented as a concrete
object (the iterator) that can be passed around to other functions or stored in
a data structure.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Simple Generators

Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland.  Implemented mostly
by Neil Schemenauer and Tim Peters, with other fixes from the Python Labs crew.
@end table


@c ======================================================================

@node PEP 263 Source Code Encodings,PEP 273 Importing Modules from ZIP Archives,PEP 255 Simple Generators,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-263-source-code-encodings}@anchor{14d1}@anchor{whatsnew/2 3 section-encodings}@anchor{14d2}
@subsection PEP 263: Source Code Encodings


Python source files can now be declared as being in different character set
encodings.  Encodings are declared by including a specially formatted comment in
the first or second line of the source file.  For example, a UTF-8 file can be
declared with:

@example
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
@end example

Without such an encoding declaration, the default encoding used is 7-bit ASCII.
Executing or importing modules that contain string literals with 8-bit
characters and have no encoding declaration will result in a
@ref{1a5,,DeprecationWarning} being signalled by Python 2.3; in 2.4 this will be a
syntax error.

The encoding declaration only affects Unicode string literals, which will be
converted to Unicode using the specified encoding.  Note that Python identifiers
are still restricted to ASCII characters, so you can’t have variable names that
use characters outside of the usual alphanumerics.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/} - Defining Python Source Code Encodings

Written by Marc-André Lemburg and Martin von Löwis; implemented by Suzuki Hisao
and Martin von Löwis.
@end table


@c ======================================================================

@node PEP 273 Importing Modules from ZIP Archives,PEP 277 Unicode file name support for Windows NT,PEP 263 Source Code Encodings,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-273-importing-modules-from-zip-archives}@anchor{14d3}
@subsection PEP 273: Importing Modules from ZIP Archives


The new @ref{132,,zipimport} module adds support for importing modules from a
ZIP-format archive.  You don’t need to import the module explicitly; it will be
automatically imported if a ZIP archive’s filename is added to @code{sys.path}.
For example:

@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

An entry in @code{sys.path} can now be the filename of a ZIP archive. The ZIP
archive can contain any kind of files, but only files named @code{*.py},
@code{*.pyc}, or @code{*.pyo} can be imported.  If an archive only contains
@code{*.py} files, Python will not attempt to modify the archive by adding the
corresponding @code{*.pyc} file, meaning that if a ZIP archive doesn’t contain
@code{*.pyc} files, importing may be rather slow.

A path within the archive can also be specified to only import from a
subdirectory; for example, the path @code{/tmp/example.zip/lib/} would only
import from the @code{lib/} subdirectory within the archive.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - Import Modules from Zip Archives

Written by James C. Ahlstrom,  who also provided an implementation. Python 2.3
follows the specification in 
@geindex Propostas de Melhorias do Python; PEP 273
PEP 273@footnote{https://peps.python.org/pep-0273/},  but uses an implementation written by
Just van Rossum  that uses the import hooks described in 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. See section
@ref{14d4,,PEP 302; New Import Hooks} for a description of the new import hooks.
@end table


@c ======================================================================

@node PEP 277 Unicode file name support for Windows NT,PEP 278 Universal Newline Support,PEP 273 Importing Modules from ZIP Archives,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-277-unicode-file-name-support-for-windows-nt}@anchor{14d5}
@subsection PEP 277: Unicode file name support for Windows NT


On Windows NT, 2000, and XP, the system stores file names as Unicode strings.
Traditionally, Python has represented file names as byte strings, which is
inadequate because it renders some file names inaccessible.

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{51c,,open()} built-in function. If a Unicode string is passed to
@ref{1139,,os.listdir()}, Python now returns a list of Unicode strings.  A new
function, @code{os.getcwdu()}, returns the current directory as a Unicode string.

Byte strings still work as file names, and on Windows Python will transparently
convert them to Unicode using the @code{mbcs} encoding.

Other systems also allow Unicode strings as file names but convert them to byte
strings before passing them to the system, which can cause a @ref{12e6,,UnicodeError}
to be raised. Applications can test whether arbitrary Unicode strings are
supported as file names by checking @ref{14d6,,os.path.supports_unicode_filenames},
a Boolean value.

Under MacOS, @ref{1139,,os.listdir()} may now return Unicode filenames.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 277

@item PEP 277@footnote{https://peps.python.org/pep-0277/} - Unicode file name support for Windows NT

Written by Neil Hodgson; implemented by Neil Hodgson, Martin von Löwis, and Mark
Hammond.
@end table


@c ======================================================================

@geindex novas linhas universais;What's new

@node PEP 278 Universal Newline Support,PEP 279 enumerate,PEP 277 Unicode file name support for Windows NT,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-278-universal-newline-support}@anchor{14d7}
@subsection PEP 278: Universal Newline Support


The three major operating systems used today are Microsoft Windows, Apple’s
Macintosh OS, and the various Unix derivatives.  A minor irritation of
cross-platform work  is that these three platforms all use different characters to
mark the ends of lines in text files.  Unix uses the linefeed (ASCII character
10), MacOS uses the carriage return (ASCII character 13), and Windows uses a
two-character sequence of a carriage return plus a newline.

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{d5c,,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.

This feature can be disabled when compiling Python by specifying the
@code{--without-universal-newlines} switch when running Python’s
@code{configure} script.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 278

@item PEP 278@footnote{https://peps.python.org/pep-0278/} - Universal Newline Support

Written and implemented by Jack Jansen.
@end table


@c ======================================================================

@node PEP 279 enumerate,PEP 282 The logging Package,PEP 278 Universal Newline Support,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-279-enumerate}@anchor{14d8}@anchor{whatsnew/2 3 section-enumerate}@anchor{14d9}
@subsection PEP 279: enumerate()


A new built-in function, @ref{14c9,,enumerate()}, will make certain loops a bit
clearer.  @code{enumerate(thing)}, where `thing' is either an iterator or a
sequence, returns an iterator that will return @code{(0, thing[0])}, @code{(1,
thing[1])}, @code{(2, thing[2])}, and so forth.

A common idiom to change every element of a list looks like this:

@example
for i in range(len(L)):
    item = L[i]
    # ... compute some result based on item ...
    L[i] = result
@end example

This can be rewritten using @ref{14c9,,enumerate()} as:

@example
for i, item in enumerate(L):
    # ... compute some result based on item ...
    L[i] = result
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 279

@item PEP 279@footnote{https://peps.python.org/pep-0279/} - The enumerate() built-in function

Written and implemented by Raymond D. Hettinger.
@end table


@c ======================================================================

@node PEP 282 The logging Package,PEP 285 A Boolean Type,PEP 279 enumerate,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-282-the-logging-package}@anchor{14da}
@subsection PEP 282: The logging Package


A standard package for writing logs, @ref{87,,logging}, has been added to Python
2.3.  It provides a powerful and flexible mechanism for generating logging
output which can then be filtered and processed in various ways.  A
configuration file written in a standard format can be used to control the
logging behavior of a program.  Python includes handlers that will write log
records to standard error or to a file or socket, send them to the system log,
or even e-mail them to a particular address; of course, it’s also possible to
write your own handler classes.

The @ref{b64,,Logger} class is the primary class. Most application code will deal
with one or more @ref{b64,,Logger} objects, each one used by a particular
subsystem of the application. Each @ref{b64,,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{b64,,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{b64,,Logger} that’s the parent of all other loggers.

For simple uses, the @ref{87,,logging} package contains some convenience functions
that always use the root 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

This produces the following output:

@example
WARNING:root:Alerta:arquivo de configuração server.conf não encontrado
ERROR:root:Ocorreu um erro
CRITICAL:root:Erro crítico -- 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{14db,,setLevel()} method
on the root logger.

Notice the @ref{2ff,,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{14dc,,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

This produces the following output:

@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

Slightly more advanced programs will use a logger other than the root logger.
The @code{getLogger(name)} function is used to get a particular log, creating
it if it doesn’t exist yet. @code{getLogger(None)} returns the root logger.

@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{b64,,Logger}
can prevent this by setting its @ref{14dd,,propagate} attribute to @ref{b49,,False}.

There are more classes provided by the @ref{87,,logging} package that can be
customized.  When a @ref{b64,,Logger} instance is told to log a message, it
creates a @ref{101c,,LogRecord} instance that is sent to any number of different
@ref{14de,,Handler} instances.  Loggers and handlers can also have an attached list
of filters, and each filter can cause the @ref{101c,,LogRecord} to be ignored or
can modify the record before passing it along.  When they’re finally output,
@ref{101c,,LogRecord} instances are converted to text by a @ref{14df,,Formatter}
class.  All of these classes can be replaced by your own specially written
classes.

With all of these features the @ref{87,,logging} package should provide enough
flexibility for even the most complicated applications.  This is only an
incomplete overview of its features, so please see the package’s reference
documentation for all of the details.  Reading 
@geindex Propostas de Melhorias do Python; PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/} will also be helpful.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - A Logging System

Written by Vinay Sajip and Trent Mick; implemented by Vinay Sajip.
@end table


@c ======================================================================

@node PEP 285 A Boolean Type,PEP 293 Codec Error Handling Callbacks,PEP 282 The logging Package,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-285-a-boolean-type}@anchor{14e0}@anchor{whatsnew/2 3 section-bool}@anchor{14e1}
@subsection PEP 285: A Boolean Type


A Boolean type was added to Python 2.3.  Two new constants were added to the
@code{__builtin__} module, @ref{c27,,True} and @ref{b49,,False}.  (@ref{c27,,True} and
@ref{b49,,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.)

The type object for this new type is named @ref{468,,bool}; the constructor for it
takes any Python value and converts it to @ref{c27,,True} or @ref{b49,,False}.

@example
>>> bool(1)
True
>>> bool(0)
False
>>> bool([])
False
>>> bool( (1,) )
True
@end example

Most of the standard library modules and built-in functions have been changed to
return Booleans.

@example
>>> obj = []
>>> hasattr(obj, 'append')
True
>>> isinstance(obj, list)
True
>>> isinstance(obj, tuple)
False
@end example

Python’s Booleans were added with the primary goal of making code clearer.  For
example, if you’re reading a function and encounter the statement @code{return 1},
you might wonder whether the @code{1} represents a Boolean truth value, an index,
or a coefficient that multiplies some other quantity.  If the statement is
@code{return True}, however, the meaning of the return value is quite clear.

Python’s Booleans were `not' added for the sake of strict type-checking.  A very
strict language such as Pascal would also prevent you performing arithmetic with
Booleans, and would require that the expression in an @ref{2f3,,if} statement
always evaluate to a Boolean result.  Python is not this strict and never will
be, as 
@geindex Propostas de Melhorias do Python; PEP 285
PEP 285@footnote{https://peps.python.org/pep-0285/} explicitly says.  This means you can still use any expression
in an @code{if} statement, even ones that evaluate to a list or tuple or
some random object.  The Boolean type is a subclass of the @ref{257,,int} class so
that arithmetic using a Boolean still works.

@example
>>> True + 1
2
>>> False + 1
1
>>> False * 75
0
>>> True * 75
75
@end example

To sum up @ref{c27,,True} and @ref{b49,,False} in a sentence: they’re alternative
ways to spell the integer values 1 and 0, with the single difference that
@ref{44c,,str()} and @ref{800,,repr()} return the strings @code{'True'} and @code{'False'}
instead of @code{'1'} and @code{'0'}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 285

@item PEP 285@footnote{https://peps.python.org/pep-0285/} - Adding a bool type

Written and implemented by GvR.
@end table


@c ======================================================================

@node PEP 293 Codec Error Handling Callbacks,PEP 301 Package Index and Metadata for Distutils,PEP 285 A Boolean Type,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-293-codec-error-handling-callbacks}@anchor{14e2}
@subsection PEP 293: Codec Error Handling Callbacks


When encoding a Unicode string into a byte string, unencodable characters may be
encountered.  So far, Python has allowed specifying the error processing as
either “strict” (raising @ref{12e6,,UnicodeError}), “ignore” (skipping the
character), or “replace” (using a question mark in the output string), with
“strict” being the default behavior. It may be desirable to specify alternative
processing of such errors, such as inserting an XML character reference or HTML
entity reference into the converted string.

Python now has a flexible framework to add different processing strategies.  New
error handlers can be added with @ref{14e3,,codecs.register_error()}, and codecs then
can access the error handler with @ref{14e4,,codecs.lookup_error()}. An equivalent C
API has been added for codecs written in C. The error handler gets the necessary
state information such as the string being converted, the position in the string
where the error was detected, and the target encoding.  The handler can then
either raise an exception or return a replacement string.

Two additional error handlers have been implemented using this framework:
“backslashreplace” uses Python backslash quoting to represent unencodable
characters and “xmlcharrefreplace” emits XML character references.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 293

@item PEP 293@footnote{https://peps.python.org/pep-0293/} - Codec Error Handling Callbacks

Written and implemented by Walter Dörwald.
@end table


@c ======================================================================

@node PEP 301 Package Index and Metadata for Distutils,PEP 302 New Import Hooks,PEP 293 Codec Error Handling Callbacks,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-301-package-index-and-metadata-for-distutils}@anchor{14e5}@anchor{whatsnew/2 3 section-pep301}@anchor{14e6}
@subsection PEP 301: Package Index and Metadata for Distutils


Support for the long-requested Python catalog makes its first appearance in 2.3.

The heart of the catalog is the new Distutils @code{register} command.
Running @code{python setup.py register} will collect the metadata describing a
package, such as its name, version, maintainer, description, &c., and send it to
a central catalog server.  The resulting catalog is available from
@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.

Here’s an example @code{setup.py} with classifiers, written to be compatible
with older versions of the 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

The full list of classifiers can be obtained by running  @code{python setup.py
register --list-classifiers}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 301

@item PEP 301@footnote{https://peps.python.org/pep-0301/} - Package Index and Metadata for Distutils

Written and implemented by Richard Jones.
@end table


@c ======================================================================

@node PEP 302 New Import Hooks,PEP 305 Comma-separated Files,PEP 301 Package Index and Metadata for Distutils,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-302-new-import-hooks}@anchor{14e7}@anchor{whatsnew/2 3 section-pep302}@anchor{14d4}
@subsection PEP 302: New Import Hooks


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 Propostas de Melhorias do Python; 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} is a list of callable objects; most  often they’ll be
classes.  Each callable takes a string containing a path and either returns an
importer object that will handle imports from this path or raises an
@ref{419,,ImportError} exception if it can’t handle this path.

@item 
@code{sys.path_importer_cache} caches importer objects for each path, so
@code{sys.path_hooks} will only need to be traversed once for each path.

@item 
@code{sys.meta_path} is a list of importer objects that will be traversed before
@code{sys.path} is checked.  This list is initially empty, but user code can add
objects to it.  Additional built-in and frozen modules can be imported by an
object added to this list.
@end itemize

Importer objects must have a single method, @code{find_module(fullname,
path=None)}.  `fullname' will be a module or package name, e.g. @code{string} or
@code{distutils.core}.  @code{find_module()} must return a loader object that has a
single method, @code{load_module(fullname)}, that creates and returns the
corresponding module object.

Pseudo-code for Python’s new import logic, therefore, looks something like this
(simplified a bit; see 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} for the full details):

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/} - New Import Hooks

Written by Just van Rossum and Paul Moore. Implemented by Just van Rossum.
@end table


@c ======================================================================

@node PEP 305 Comma-separated Files,PEP 307 Pickle Enhancements,PEP 302 New Import Hooks,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-305-comma-separated-files}@anchor{14e8}@anchor{whatsnew/2 3 section-pep305}@anchor{14e9}
@subsection PEP 305: Comma-separated Files


Comma-separated files are a format frequently used for exporting data from
databases and spreadsheets.  Python 2.3 adds a parser for comma-separated files.

Comma-separated format is deceptively simple at first glance:

@example
Costs,150,200,3.95
@end example

Read a line and call @code{line.split(',')}: what could be simpler? But toss in
string data that can contain commas, and things get more complicated:

@example
"Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
@end example

A big ugly regular expression can parse this, but using the new  @ref{29,,csv}
package is much simpler:

@example
import csv

input = open('datafile', 'rb')
reader = csv.reader(input)
for line in reader:
    print line
@end example

The @ref{486,,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.

Different dialects of comma-separated files can be defined and registered;
currently there are two dialects, both used by Microsoft Excel. A separate
@ref{487,,csv.writer} class will generate comma-separated files from a succession
of tuples or lists, quoting strings that contain the delimiter.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - CSV File API

Written and implemented  by Kevin Altis, Dave Cole, Andrew McNamara, Skip
Montanaro, Cliff Wells.
@end table


@c ======================================================================

@node PEP 307 Pickle Enhancements,Extended Slices,PEP 305 Comma-separated Files,What’s New in Python 2 3
@anchor{whatsnew/2 3 pep-307-pickle-enhancements}@anchor{14ea}@anchor{whatsnew/2 3 section-pep307}@anchor{14eb}
@subsection PEP 307: Pickle Enhancements


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 Propostas de Melhorias do Python; 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.

The solution was to invent a new pickle protocol.  The @ref{14ec,,pickle.dumps()}
function has supported a text-or-binary flag  for a long time.  In 2.3, this
flag is redefined from a Boolean to an integer: 0 is the old text-mode pickle
format, 1 is the old binary format, and now 2 is a new 2.3-specific format.  A
new constant, @ref{14ed,,pickle.HIGHEST_PROTOCOL}, can be used to select the
fanciest protocol available.

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{5d8,,__getstate__()}, @ref{9dc,,__setstate__()}, and @ref{dfe,,__getnewargs__()}.  Consult
@geindex Propostas de Melhorias do Python; PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} for the full semantics  of these methods.

As a way to compress pickles yet further, it’s now possible to use integer codes
instead of long strings to identify pickled classes. The Python Software
Foundation will maintain a list of standardized codes; there’s also a range of
codes for private use.  Currently no codes have been specified.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 307

@item PEP 307@footnote{https://peps.python.org/pep-0307/} - Extensions to the pickle protocol

Written and implemented  by Guido van Rossum and Tim Peters.
@end table


@c ======================================================================

@node Extended Slices,Outras mudanças na linguagem<18>,PEP 307 Pickle Enhancements,What’s New in Python 2 3
@anchor{whatsnew/2 3 extended-slices}@anchor{14ee}@anchor{whatsnew/2 3 section-slices}@anchor{14ef}
@subsection Extended Slices


Ever since Python 1.4, the slicing syntax has supported an optional third “step”
or “stride” argument.  For example, these are all legal Python syntax:
@code{L[1:10:2]}, @code{L[:-1:1]}, @code{L[::-1]}.  This was added to Python at the
request of the developers of Numerical Python, which uses the third argument
extensively.  However, Python’s built-in list, tuple, and string sequence types
have never supported this feature, raising a @ref{2c3,,TypeError} if you tried it.
Michael Hudson contributed a patch to fix this shortcoming.

For example, you can now easily extract the elements of a list that have even
indexes:

@example
>>> L = range(10)
>>> L[::2]
[0, 2, 4, 6, 8]
@end example

Negative values also work to make a copy of the same list in reverse order:

@example
>>> L[::-1]
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@end example

This also works for tuples, arrays, and strings:

@example
>>> s='abcd'
>>> s[::2]
'ac'
>>> s[::-1]
'dcba'
@end example

If you have a mutable sequence such as a list or an array you can assign to or
delete an extended slice, but there are some differences between assignment to
extended and regular slices.  Assignment to a regular slice can be used to
change the length of the sequence:

@example
>>> a = range(3)
>>> a
[0, 1, 2]
>>> a[1:3] = [4, 5, 6]
>>> a
[0, 4, 5, 6]
@end example

Extended slices aren’t this flexible.  When assigning to an extended slice, the
list on the right hand side of the statement must contain the same number of
items as the slice it is replacing:

@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

Deletion is more straightforward:

@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{283,,__getitem__()} methods of the
built-in sequences:

@example
>>> range(10).__getitem__(slice(0, 5, 2))
[0, 2, 4]
@end example

Or use slice objects directly in subscripts:

@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{94a,,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

From this example you can also see that the built-in @ref{469,,slice} object is
now the type object for the slice type, and is no longer a function.  This is
consistent with Python 2.2, where @ref{257,,int}, @ref{44c,,str}, etc., underwent
the same change.

@c ======================================================================

@node Outras mudanças na linguagem<18>,New Improved and Deprecated Modules<4>,Extended Slices,What’s New in Python 2 3
@anchor{whatsnew/2 3 other-language-changes}@anchor{14f0}
@subsection Outras mudanças na linguagem


Here are all of the changes that Python 2.3 makes to the core Python language.


@itemize *

@item 
The @ref{9d5,,yield} statement is now always a keyword, as described in
section @ref{14d0,,PEP 255; Simple Generators} of this document.

@item 
A new built-in function @ref{14c9,,enumerate()} was added, as described in section
@ref{14d9,,PEP 279; enumerate()} of this document.

@item 
Two new constants, @ref{c27,,True} and @ref{b49,,False} were added along with the
built-in @ref{468,,bool} type, as described in section @ref{14e1,,PEP 285; A Boolean Type} of this
document.

@item 
The @ref{257,,int()} type constructor will now return a long integer instead of
raising an @ref{885,,OverflowError} when a string or floating-point number is too
large to fit into an integer.  This can lead to the paradoxical result that
@code{isinstance(int(expression), int)} is false, but that seems unlikely to cause
problems in practice.

@item 
Built-in types now support the extended slicing syntax, as described in
section @ref{14ef,,Extended Slices} of this document.

@item 
A new built-in function, @code{sum(iterable, start=0)},  adds up the numeric
items in the iterable object and returns their sum.  @ref{46a,,sum()} only accepts
numbers, meaning that you can’t use it to concatenate a bunch of strings.
(Contributed by Alex Martelli.)

@item 
@code{list.insert(pos, value)} used to  insert `value' at the front of the list
when `pos' was negative.  The behaviour has now been changed to be consistent
with slice indexing, so when `pos' is -1 the value will be inserted before the
last element, and so forth.

@item 
@code{list.index(value)}, which searches for `value'  within the list and returns
its index, now takes optional  `start' and `stop' arguments to limit the search
to  only part of the list.

@item 
Dictionaries have a new method, @code{pop(key[, *default*])}, that returns
the value corresponding to `key' and removes that key/value pair from the
dictionary.  If the requested key isn’t present in the dictionary, `default' is
returned if it’s specified and @ref{344,,KeyError} raised if it isn’t.

@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

There’s also a new class method,  @code{dict.fromkeys(iterable, value)}, that
creates a dictionary with keys taken from the supplied iterator `iterable' and
all values set to `value', defaulting to @code{None}.

(Patches contributed by Raymond Hettinger.)

Also, the @ref{256,,dict()} constructor now accepts keyword arguments to simplify
creating small dictionaries:

@example
>>> dict(red=1, blue=2, green=3, black=4)
@{'blue': 2, 'black': 4, 'green': 3, 'red': 1@}
@end example

(Contributed by Just van Rossum.)

@item 
The @ref{96f,,assert} statement no longer checks the @code{__debug__} flag, so
you can no longer disable assertions by assigning to @code{__debug__}. Running
Python with the @ref{ddd,,-O} switch will still generate code that doesn’t
execute any assertions.

@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 
A new warning, @ref{8ce,,PendingDeprecationWarning} was added to indicate features
which are in the process of being deprecated.  The warning will `not' be printed
by default.  To check for use of features that will be deprecated in the future,
supply @ref{8cd,,-Walways;;PendingDeprecationWarning;;} on the command line or
use @ref{14f1,,warnings.filterwarnings()}.

@item 
The process of deprecating string-based exceptions, as in @code{raise "Error
occurred"}, has begun.  Raising a string will now trigger
@ref{8ce,,PendingDeprecationWarning}.

@item 
Using @code{None} as a variable name will now result in a @ref{466,,SyntaxWarning}
warning.  In a future version of Python, @code{None} may finally become a keyword.

@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{14f2,,A Ordem de Resolução de Métodos do Python 2.3}, 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

In 2.3, you get this:

@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{14f3,,__name__} and @ref{14f4,,__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{14f5,,__class__} attribute.
@end itemize

@c ======================================================================

@menu
* String Changes:: 
* Otimizações: Otimizações<17>. 

@end menu

@node String Changes,Otimizações<17>,,Outras mudanças na linguagem<18>
@anchor{whatsnew/2 3 string-changes}@anchor{14f6}
@subsubsection String Changes



@itemize *

@item 
The @ref{2f4,,in} operator now works differently for strings. Previously, when
evaluating @code{X in Y} where `X' and `Y' are strings, `X' could only be a single
character. That’s now changed; `X' can be a string of any length, and @code{X in Y}
will return @ref{c27,,True} if `X' is a substring of `Y'.  If `X' is the empty
string, the result is always @ref{c27,,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{ed7,,find()} string method.

@item 
The @ref{14f7,,strip()}, @ref{14f8,,lstrip()}, and @ref{14f9,,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

(Suggested by Simon Brunning and implemented by Walter Dörwald.)

@item 
The @ref{efa,,startswith()} and @ref{efb,,endswith()} string methods now accept negative
numbers for the `start' and `end' parameters.

@item 
Another new string method is @ref{14fa,,zfill()}, originally a function in the
@ref{d3,,string} module.  @ref{14fa,,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{14fa,,zfill()}.

@example
>>> '45'.zfill(4)
'0045'
>>> '12345'.zfill(4)
'12345'
>>> 'goofy'.zfill(6)
'0goofy'
@end example

(Contributed by 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{c27,,True} for either kind of string.  It’s a completely abstract
type, so you can’t create @code{basestring} instances.

@item 
Interned strings are no longer immortal and will now be garbage-collected in
the usual way when the only reference to them is from the internal dictionary of
interned strings.  (Implemented by Oren Tirosh.)
@end itemize

@c ======================================================================

@node Otimizações<17>,,String Changes,Outras mudanças na linguagem<18>
@anchor{whatsnew/2 3 optimizations}@anchor{14fb}
@subsubsection Otimizações



@itemize *

@item 
The creation of new-style class instances has been made much faster; they’re
now faster than classic classes!

@item 
The @ref{be8,,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 
The @code{SET_LINENO} opcode is now gone.  This may provide a small speed
increase, depending on your compiler’s idiosyncrasies. See section
@ref{14fc,,Outras alterações e correções} for a longer explanation. (Removed by 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 
A number of small rearrangements have been made in various hotspots to improve
performance, such as inlining a function or removing some code.  (Implemented
mostly by GvR, but lots of people have contributed single changes.)
@end itemize

The net result of the 2.3 optimizations is that Python 2.3 runs the  pystone
benchmark around 25% faster than Python 2.2.

@c ======================================================================

@node New Improved and Deprecated Modules<4>,Pymalloc A Specialized Object Allocator,Outras mudanças na linguagem<18>,What’s New in Python 2 3
@anchor{whatsnew/2 3 new-improved-and-deprecated-modules}@anchor{14fd}
@subsection New, Improved, and Deprecated Modules


As usual, Python’s standard library received a number of enhancements and bug
fixes.  Here’s a partial list of the most notable changes, sorted alphabetically
by module name. Consult the @code{Misc/NEWS} file in the source tree for a more
complete list of changes, or look through the CVS logs for all the details.


@itemize *

@item 
The @ref{7,,array} module now supports arrays of Unicode characters using the
@code{'u'} format character.  Arrays also now support using the @code{+=} assignment
operator to add another array’s contents, and the @code{*=} assignment operator to
repeat an array. (Contributed by 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 
The new @ref{13,,bz2} module is an interface to the bz2 data compression library.
bz2-compressed data is usually smaller than  corresponding
@ref{133,,zlib}-compressed data. (Contributed by Gustavo Niemeyer.)

@item 
A set of standard date/time types has been added in the new @ref{30,,datetime}
module.  See the following section for more details.

@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

Modifying @code{sample.h} would then cause the module to be recompiled.
(Contributed by Jeremy Hylton.)

@item 
Other minor changes to Distutils: it now checks for the 
@geindex CC
@geindex variável de ambiente; CC
@ref{14fe,,CC},
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS}, @code{CPP}, 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS}, and 
@geindex CPPFLAGS
@geindex variável de ambiente; CPPFLAGS
@ref{1501,,CPPFLAGS}
environment variables, using them to override the settings in Python’s
configuration (contributed by Robert Weber).

@item 
Previously the @ref{3a,,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{e1f,,DocTestSuite()} function creates a
@ref{e20,,unittest.TestSuite} object from a set of @ref{3a,,doctest} tests.

@item 
The new @code{gc.get_referents(object)} function returns a list of all the
objects referenced by `object'.

@item 
The @ref{61,,getopt} module gained a new function, @ref{1502,,gnu_getopt()}, that
supports the same arguments as the existing @ref{1503,,getopt()} function but uses
GNU-style scanning mode. The existing @ref{1503,,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

(Contributed by Peter Åstrand.)

@item 
The @ref{66,,grp}, @ref{b2,,pwd}, and @ref{bc,,resource} modules now return enhanced
tuples:

@example
>>> import grp
>>> g = grp.getgrnam('amk')
>>> g.gr_name, g.gr_gid
('amk', 500)
@end example

@item 
The @ref{67,,gzip} module can now handle files exceeding 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{1504,,heappush()} and @ref{1505,,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

(Contributed by Kevin O’Connor.)

@item 
The IDLE integrated development environment has been updated using the code
from the IDLEfork project (@indicateurl{https://idlefork.sourceforge.net}).  The most notable feature is
that the code being developed is now executed in a subprocess, meaning that
there’s no longer any need for manual @code{reload()} operations. IDLE’s core code
has been incorporated into the standard library as the @ref{73,,idlelib} package.

@item 
The @ref{74,,imaplib} module now supports IMAP over SSL. (Contributed by Piers
Lauder and 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{c27,,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 
Two new functions in the @ref{8e,,math} module, @code{degrees(rads)} and
@code{radians(degs)}, convert between radians and degrees.  Other functions in
the @ref{8e,,math} module such as @ref{1506,,math.sin()} and @ref{1507,,math.cos()} have always
required input values measured in radians.  Also, an optional `base' argument
was added to @ref{1508,,math.log()} to make it easier to compute logarithms for bases
other than @code{e} and @code{10}.  (Contributed by 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{254,,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{1509,,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

In Python 2.4, the default will change to always returning floats.

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 
The @ref{a0,,optparse} module contains a new parser for command-line arguments
that can convert option values to a particular Python type  and will
automatically generate a usage message.  See the following section for  more
details.

@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 
The new @ref{aa,,platform} module contains a number of functions that try to
determine various properties of the platform you’re running on.  There are
functions for getting the architecture, CPU type, the Windows OS version, and
even the Linux distribution version. (Contributed by 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{150a,,buffer_text} attribute to @ref{c27,,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{746,,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

The @ref{b8,,random} module now uses a new algorithm, the Mersenne Twister,
implemented in C.  It’s faster and more extensively studied than the previous
algorithm.

(All changes contributed by Raymond Hettinger.)

@item 
The @ref{ba,,readline} module also gained a number of new functions:
@ref{150b,,get_history_item()}, @ref{150c,,get_current_history_length()}, and
@ref{150d,,redisplay()}.

@item 
The @code{rexec} and @code{Bastion} modules have been declared dead, and
attempts to import them will fail with a @ref{195,,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 
The @ref{c5,,shutil} module gained a @code{move(src, dest)} function that
recursively moves a file or directory to a new location.

@item 
Support for more advanced POSIX signal handling was added to the @ref{c6,,signal}
but then removed again as it proved impossible to make it work reliably across
platforms.

@item 
The @ref{cc,,socket} module now supports timeouts.  You can call the
@code{settimeout(t)} method on a socket object to set a timeout of `t' seconds.
Subsequent socket operations that take longer than `t' seconds to complete will
abort and raise a @ref{837,,socket.timeout} exception.

The original timeout implementation was by Tim O’Malley.  Michael Gilfix
integrated it into the Python @ref{cc,,socket} module and shepherded it through a
lengthy review.  After the code was checked in, Guido van Rossum rewrote parts
of it.  (This is a good example of a collaborative development process in
action.)

@item 
On Windows, the @ref{cc,,socket} module now ships with Secure  Sockets Layer
(SSL) support.

@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 
The new @ref{de,,tarfile} module  allows reading from and writing to
@code{tar}-format archive files. (Contributed by 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{150e,,fill()} is built on top of @ref{150f,,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{1003,,TextWrapper} class that actually implements
the text wrapping strategy.   Both the @ref{1003,,TextWrapper} class and the
@ref{150f,,wrap()} and @ref{150e,,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{2f3,,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{1474,,strptime()} function has long been an annoyance
because it uses the platform C library’s @ref{1474,,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{1510,,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

Any breakage caused by this change should be reported as a bug.

@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{283,,__getitem__()}, @ref{130e,,__setitem__()},
@ref{130f,,__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

(Contributed by 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{aa2,,toxml()} and @ref{aa3,,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 
Support for internationalized domain names (RFCs 3454, 3490, 3491, and 3492)
has been added. The “idna” encoding can be used to convert between a Unicode
domain name and the ASCII-compatible encoding (ACE) of that name.

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

To implement this change, the @ref{d4,,stringprep} module, the  @code{mkstringprep}
tool and the @code{punycode} encoding have been added.
@end itemize

@c ======================================================================

@menu
* Date/Time Type:: 
* The optparse Module:: 

@end menu

@node Date/Time Type,The optparse Module,,New Improved and Deprecated Modules<4>
@anchor{whatsnew/2 3 date-time-type}@anchor{1511}
@subsubsection Date/Time Type


Date and time types suitable for expressing timestamps were added as the
@ref{30,,datetime} module.  The types don’t support different calendars or many
fancy features, and just stick to the basics of representing time.

The three primary types are: @ref{1cd,,date}, representing a day, month, and year;
@ref{1ce,,time}, consisting of hour, minute, and second; and @ref{1cc,,datetime},
which contains all the attributes of both @ref{1cd,,date} and @ref{1ce,,time}.
There’s also a @ref{9d7,,timedelta} class representing differences between two
points in time, and time zone logic is implemented by classes inheriting from
the abstract @ref{5de,,tzinfo} class.

You can create instances of @ref{1cd,,date} and @ref{1ce,,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{1512,,today()} class method returns the
current local date.

Once created, instances of the date/time classes are all immutable. There are a
number of methods for producing formatted strings from objects:

@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{1513,,replace()} method allows modifying one or more fields  of a
@ref{1cd,,date} or @ref{1cc,,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{b42,,isoformat()}).  @ref{1cd,,date} and @ref{1cc,,datetime}
instances can be subtracted from each other, and added to @ref{9d7,,timedelta}
instances.  The largest missing feature is that there’s no standard library
support for parsing strings and getting back a @ref{1cd,,date} or
@ref{1cc,,datetime}.

For more information, refer to the module’s reference documentation.
(Contributed by Tim Peters.)

@c ======================================================================

@node The optparse Module,,Date/Time Type,New Improved and Deprecated Modules<4>
@anchor{whatsnew/2 3 the-optparse-module}@anchor{1514}
@subsubsection The optparse Module


The @ref{61,,getopt} module provides simple parsing of command-line arguments.  The
new @ref{a0,,optparse} module (originally named Optik) provides more elaborate
command-line parsing that follows the Unix conventions, automatically creates
the output for @code{--help}, and can perform different actions for different
options.

You start by creating an instance of @ref{1515,,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{1516,,parse_args()} method.

@example
options, args = op.parse_args(sys.argv[1:])
print options
print args
@end example

This returns an object containing all of the option values, and a list of
strings containing the remaining arguments.

Invoking the script with the various arguments now works as you’d expect it to.
Note that the length argument is automatically converted to an integer.

@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

The help message is automatically generated for you:

@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

See the module’s documentation for more details.

Optik was written by Greg Ward, with suggestions from the readers of the Getopt
SIG.

@c ======================================================================

@node Pymalloc A Specialized Object Allocator,Mudanças a construções e API C<12>,New Improved and Deprecated Modules<4>,What’s New in Python 2 3
@anchor{whatsnew/2 3 pymalloc-a-specialized-object-allocator}@anchor{1517}@anchor{whatsnew/2 3 section-pymalloc}@anchor{1518}
@subsection Pymalloc: A Specialized Object Allocator


Pymalloc, a specialized object allocator written by Vladimir Marangozov, was a
feature added to Python 2.1.  Pymalloc is intended to be faster than the system
@code{malloc()} and to have less memory overhead for allocation patterns typical
of Python programs. The allocator uses C’s @code{malloc()} function to get large
pools of memory and then fulfills smaller memory requests from these pools.

In 2.1 and 2.2, pymalloc was an experimental feature and wasn’t enabled by
default; you had to explicitly enable it when compiling Python by providing the
@code{--with-pymalloc} option to the @code{configure} script.  In 2.3,
pymalloc has had further enhancements and is now enabled by default; you’ll have
to supply @code{--without-pymalloc} to disable it.

This change is transparent to code written in Python; however, pymalloc may
expose bugs in C extensions.  Authors of C extension modules should test their
code with pymalloc enabled, because some incorrect code may cause core dumps at
runtime.

There’s one particularly common error that causes problems.  There are a number
of memory allocation functions in Python’s C API that have previously just been
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 may get you a core dump.  For example, if memory was allocated using
@ref{c83,,PyObject_Malloc()}, it has to be freed using @ref{c80,,PyObject_Free()}, 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.

As part of this change, the confusing multiple interfaces for allocating memory
have been consolidated down into two API families. Memory allocated with one
family must not be manipulated with functions from the other family.  There is
one family for allocating chunks of memory and another family of functions
specifically for allocating Python objects.


@itemize *

@item 
To allocate and free an undistinguished chunk of memory use the “raw memory”
family: @ref{c81,,PyMem_Malloc()}, @ref{106a,,PyMem_Realloc()}, and @ref{148a,,PyMem_Free()}.

@item 
The “object memory” family is the interface to the pymalloc facility described
above and is biased towards a large number of “small” allocations:
@ref{c83,,PyObject_Malloc()}, @ref{148b,,PyObject_Realloc()}, and @ref{c80,,PyObject_Free()}.

@item 
To allocate and free Python objects, use the “object” family
@ref{98c,,PyObject_New}, @ref{98d,,PyObject_NewVar}, and @ref{1519,,PyObject_Del()}.
@end itemize

Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides debugging
features to catch memory overwrites and doubled frees in both extension modules
and in the interpreter itself.  To enable this support, compile a debugging
version of the Python interpreter by running @code{configure} with
@code{--with-pydebug}.

To aid extension writers, a header file @code{Misc/pymemcompat.h} is
distributed with the source to Python 2.3 that allows Python extensions to use
the 2.3 interfaces to memory allocation while compiling against any version of
Python since 1.5.2.  You would copy the file from Python’s source distribution
and bundle it with the source of your extension.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://hg.python.org/cpython/file/default/Objects/obmalloc.c}

For the full details of the pymalloc implementation, see the comments at
the top of the file @code{Objects/obmalloc.c} in the Python source code.
The above link points to the file within the python.org SVN browser.
@end table


@c ======================================================================

@node Mudanças a construções e API C<12>,Outras alterações e correções<2>,Pymalloc A Specialized Object Allocator,What’s New in Python 2 3
@anchor{whatsnew/2 3 build-and-c-api-changes}@anchor{151a}
@subsection Mudanças a construções e API C


As alterações no processo de construção do Python e na API C incluem:


@itemize *

@item 
The cycle detection implementation used by the garbage collection has proven
to be stable, so it’s now been made mandatory.  You can no longer compile Python
without it, and the @code{--with-cycle-gc} switch to @code{configure} has
been removed.

@item 
Python can now optionally be built as a shared library
(@code{libpython2.3.so}) by supplying @code{--enable-shared} when running
Python’s @code{configure} script.  (Contributed by Ondrej Palkovsky.)

@item 
The @code{DL_EXPORT} and @code{DL_IMPORT} macros are now deprecated.
Initialization functions for Python extension modules should now be declared
using the new macro @ref{151b,,PyMODINIT_FUNC}, while the Python core will
generally use the @code{PyAPI_FUNC} and @code{PyAPI_DATA} macros.

@item 
The interpreter can be compiled without any docstrings for the built-in
functions and modules by supplying @code{--without-doc-strings} to the
@code{configure} script. This makes the Python executable about 10% smaller,
but will also mean that you can’t get help for Python’s built-ins.  (Contributed
by Gustavo Niemeyer.)

@item 
The @code{PyArg_NoArgs()} macro is now deprecated, and code that uses it
should be changed.  For Python 2.2 and later, the method definition table can
specify the @ref{151c,,METH_NOARGS} flag, signalling that there are no arguments,
and the argument checking can then be removed.  If compatibility with pre-2.2
versions of Python is important, the code could use @code{PyArg_ParseTuple(args,
"")} instead, but this will be slower than using @ref{151c,,METH_NOARGS}.

@item 
@ref{571,,PyArg_ParseTuple()} accepts new format characters for various sizes of
unsigned integers: @code{B} for unsigned char, @code{H} for unsigned short int,  @code{I} for unsigned int,  and @code{K} for unsigned long long.

@item 
A new function, @code{PyObject_DelItemString(mapping, char *key)} was added
as shorthand for @code{PyObject_DelItem(mapping, PyString_New(key))}.

@item 
File objects now manage their internal string buffer differently, increasing
it exponentially when needed.  This results in the benchmark tests in
@code{Lib/test/test_bufio.py} speeding up considerably (from 57 seconds to 1.7
seconds, according to one measurement).

@item 
It’s now possible to define class and static methods for a C extension type by
setting either the @ref{151d,,METH_CLASS} or @ref{151e,,METH_STATIC} flags in a
method’s @ref{151f,,PyMethodDef} structure.

@item 
Python now includes a copy of the Expat XML parser’s source code, removing any
dependence on a system version or local installation of 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{374,,__module__} and
@ref{14f3,,__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
* Port-Specific Changes: Port-Specific Changes<3>. 

@end menu

@node Port-Specific Changes<3>,,,Mudanças a construções e API C<12>
@anchor{whatsnew/2 3 port-specific-changes}@anchor{1520}
@subsubsection Port-Specific Changes


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

On MacOS, most toolbox modules have been weaklinked to improve backward
compatibility.  This means that modules will no longer fail to load if a single
routine is missing on the current OS version. Instead calling the missing
routine will raise an exception. (Contributed by Jack Jansen.)

The RPM spec files, found in the @code{Misc/RPM/} directory in the Python
source distribution, were updated for 2.3.  (Contributed by Sean Reifschneider.)

Other new platforms now supported by Python include AtheOS
(@indicateurl{http://www.atheos.cx/}), GNU/Hurd, and OpenVMS.

@c ======================================================================

@node Outras alterações e correções<2>,Porting to Python 2 3,Mudanças a construções e API C<12>,What’s New in Python 2 3
@anchor{whatsnew/2 3 other-changes-and-fixes}@anchor{1521}@anchor{whatsnew/2 3 section-other}@anchor{14fc}
@subsection Outras alterações e correções


As usual, there were a bunch of other improvements and bugfixes scattered
throughout the source tree.  A search through the CVS change logs finds there
were 523 patches applied and 514 bugs fixed between Python 2.2 and 2.3.  Both
figures are likely to be underestimates.

Some of the more notable changes are:


@itemize *

@item 
If the 
@geindex PYTHONINSPECT
@geindex variável de ambiente; PYTHONINSPECT
@ref{1522,,PYTHONINSPECT} environment variable is set, the Python
interpreter will enter the interactive prompt after running a Python program, as
if Python had been invoked with the @ref{1523,,-i} option. The environment
variable can be set before running the Python interpreter, or it can be set by
the Python program as part of its execution.

@item 
The @code{regrtest.py} script now provides a way to allow “all resources
except `foo'.”  A resource name passed to the @code{-u} option can now be
prefixed with a hyphen (@code{'-'}) to mean “remove this resource.”  For example,
the option ‘@code{-uall,-bsddb}’ could be used to enable the use of all resources
except @code{bsddb}.

@item 
The tools used to build the documentation now work under Cygwin as well as
Unix.

@item 
The @code{SET_LINENO} opcode has been removed.  Back in the mists of time, this
opcode was needed to produce line numbers in tracebacks and support trace
functions (for, e.g., @ref{a5,,pdb}). Since Python 1.5, the line numbers in
tracebacks have been computed using a different mechanism that works with
“python -O”.  For Python 2.3 Michael Hudson implemented a similar scheme to
determine when to call the trace function, removing the need for @code{SET_LINENO}
entirely.

It would be difficult to detect any resulting difference from Python code, apart
from a slight speed up when Python is run without @ref{ddd,,-O}.

C extensions that access the @ref{7ad,,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{7ad,,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 Porting to Python 2 3,Reconhecimentos<5>,Outras alterações e correções<2>,What’s New in Python 2 3
@anchor{whatsnew/2 3 porting-to-python-2-3}@anchor{1524}
@subsection Porting to Python 2.3


This section lists previously described changes that may require changes to your
code:


@itemize *

@item 
@ref{9d5,,yield} is now always a keyword; if it’s used as a variable name in
your code, a different name must be chosen.

@item 
For strings `X' and `Y', @code{X in Y} now works if `X' is more than one
character long.

@item 
The @ref{257,,int()} type constructor will now return a long integer instead of
raising an @ref{885,,OverflowError} when a string or floating-point number is too
large to fit into an integer.

@item 
If you have Unicode strings that contain 8-bit characters, you must declare
the file’s encoding (UTF-8, Latin-1, or whatever) by adding a comment to the top
of the file.  See section @ref{14d2,,PEP 263; Source Code Encodings} for more information.

@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 
Large octal and hex literals such as @code{0xffffffff} now trigger a
@ref{415,,FutureWarning}. Currently they’re stored as 32-bit numbers and result in a
negative value, but in Python 2.4 they’ll become positive long integers.

There are a few ways to fix this warning.  If you really need a positive number,
just add an @code{L} to the end of the literal.  If you’re trying to get a 32-bit
integer with low bits set and have previously used an expression such as @code{~(1
<< 31)}, it’s probably clearest to start with all bits set and clear the
desired upper bits. For example, to clear just the top bit (bit 31), you could
write @code{0xffffffffL &~(1L<<31)}.

@item 
You can no longer disable assertions by assigning to @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 
Using @code{None} as a variable name will now result in a @ref{466,,SyntaxWarning}
warning.

@item 
Names of extension types defined by the modules included with Python now
contain the module and a @code{'.'} in front of the type name.
@end itemize

@c ======================================================================

@node Reconhecimentos<5>,,Porting to Python 2 3,What’s New in Python 2 3
@anchor{whatsnew/2 3 acknowledgements}@anchor{1525}@anchor{whatsnew/2 3 acks}@anchor{1526}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions,
corrections and assistance with various drafts of this article: 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 What’s New in Python 2 2,What’s New in Python 2 1,What’s New in Python 2 3,O que há de novo no Python
@anchor{whatsnew/2 2 doc}@anchor{1527}@anchor{whatsnew/2 2 translation-repo}@anchor{1528}@anchor{whatsnew/2 2 what-s-new-in-python-2-2}@anchor{1529}
@section What’s New in Python 2.2


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew22.tex 37315 2004-09-10 19:33:00Z akuchling $

@menu
* Introdução:: 
* PEPs 252 and 253; Type and Class Changes: PEPs 252 and 253 Type and Class Changes. 
* PEP 234; Iterators: PEP 234 Iterators. 
* PEP 255; Simple Generators: PEP 255 Simple Generators<2>. 
* PEP 237; Unifying Long Integers and Integers: PEP 237 Unifying Long Integers and Integers<2>. 
* PEP 238; Changing the Division Operator: PEP 238 Changing the Division Operator. 
* Unicode Changes:: 
* PEP 227; Nested Scopes: PEP 227 Nested Scopes. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<3>. 
* Interpreter Changes and Fixes:: 
* Outras alterações e correções: Outras alterações e correções<3>. 
* Reconhecimentos: Reconhecimentos<6>. 

@end menu

@node Introdução,PEPs 252 and 253 Type and Class Changes,,What’s New in Python 2 2
@anchor{whatsnew/2 2 introduction}@anchor{152a}
@subsection Introdução


This article explains the new features in Python 2.2.2, released on October 14,
2002.  Python 2.2.2 is a bugfix release of Python 2.2, originally released on
December 21, 2001.

Python 2.2 can be thought of as the “cleanup release”.  There are some features
such as generators and iterators that are completely new, but most of the
changes, significant and far-reaching though they may be, are aimed at cleaning
up irregularities and dark corners of the language design.

This article doesn’t attempt to provide a complete specification of the new
features, but instead provides a convenient overview.  For full details, you
should refer to the documentation for Python 2.2, such as the Python Library Reference@footnote{https://docs.python.org/2.2/lib/lib.html} and the Python Reference Manual@footnote{https://docs.python.org/2.2/ref/ref.html}.  If you want to
understand the complete implementation and design rationale for a change, refer
to the PEP for a particular new feature.

@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 and 253 Type and Class Changes,PEP 234 Iterators,Introdução,What’s New in Python 2 2
@anchor{whatsnew/2 2 peps-252-and-253-type-and-class-changes}@anchor{152b}
@subsection PEPs 252 and 253: Type and Class Changes


The largest and most far-reaching changes in Python 2.2 are to Python’s model of
objects and classes.  The changes should be backward compatible, so it’s likely
that your code will continue to run unchanged, but the changes provide some
amazing new capabilities. Before beginning this, the longest and most
complicated section of this article, I’ll provide an overview of the changes and
offer some comments.

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{152c,,UserList}
instance.

Python 2.2 fixes this, and in the process adds some exciting new capabilities.
A brief summary:


@itemize *

@item 
You can subclass built-in types such as lists and even integers, and your
subclasses should work in every place that requires the original type.

@item 
It’s now possible to define static and class methods, in addition to the
instance methods available in previous versions of 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{4d3,,__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 
The list of legal attributes for an instance can be limited to a particular
set using `slots', making it possible to safeguard against typos and
perhaps make more optimizations possible in future versions of Python.
@end itemize

Some users have voiced concern about all these changes.  Sure, they say, the new
features are neat and lend themselves to all sorts of tricks that weren’t
possible in previous versions of Python, but they also make the language more
complicated.  Some people have said that they’ve always recommended Python for
its simplicity, and feel that its simplicity is being lost.

Personally, I think there’s no need to worry.  Many of the new features are
quite esoteric, and you can write a lot of Python code without ever needed to be
aware of them.  Writing a simple class is no more difficult than it ever was, so
you don’t need to bother learning or teaching them unless they’re actually
needed.  Some very complicated tasks that were previously only possible from C
will now be possible in pure Python, and to my mind that’s all for the better.

I’m not going to attempt to cover every single corner case and small change that
were required to make the new features work.  Instead this section will paint
only the broad strokes.  See section @ref{152d,,Related Links}, “Related Links”, for
further sources of information about Python 2.2’s new object model.

@menu
* Old and New Classes:: 
* Descriptors:: 
* Multiple Inheritance; The Diamond Rule: Multiple Inheritance The Diamond Rule. 
* Attribute Access:: 
* Related Links:: 

@end menu

@node Old and New Classes,Descriptors,,PEPs 252 and 253 Type and Class Changes
@anchor{whatsnew/2 2 old-and-new-classes}@anchor{152e}
@subsubsection Old and New Classes


First, you should know that Python 2.2 really has two kinds of classes: classic
or old-style classes, and new-style classes.  The old-style class model is
exactly the same as the class model in earlier versions of Python.  All the new
features described in this section apply only to new-style classes. This
divergence isn’t intended to last forever; eventually old-style classes will be
dropped, possibly in Python 3.0.

So how do you define a new-style class?  You do it by subclassing an existing
new-style class.  Most of Python’s built-in types, such as integers, lists,
dictionaries, and even files, are new-style classes now.  A new-style class
named @ref{a96,,object}, the base class for all built-in types, has also been
added so if no built-in type is suitable, you can just subclass
@ref{a96,,object}:

@example
class C(object):
    def __init__ (self):
        ...
    ...
@end example

This means that @ref{131a,,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 Propostas de Melhorias do Python; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/}
for the details — but it’s easier to just subclass @ref{a96,,object}.)

The type objects for the built-in types are available as built-ins, named using
a clever trick.  Python has always had built-in functions named @ref{257,,int()},
@ref{2f7,,float()}, and @ref{44c,,str()}.  In 2.2, they aren’t functions any more, but
type objects that behave as factories when called.

@example
>>> int
<type 'int'>
>>> int('123')
123
@end example

To make the set of types complete, new type objects such as @ref{256,,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 Descriptors,Multiple Inheritance The Diamond Rule,Old and New Classes,PEPs 252 and 253 Type and Class Changes
@anchor{whatsnew/2 2 descriptors}@anchor{152f}
@subsubsection Descriptors


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{55b,,__dict__} of an object, but when class inheritance or an arbitrary
@code{__getattr__()} hook were in use this could still be inaccurate.

The one big idea underlying the new class model is that an API for describing
the attributes of an object using `descriptors' has been formalized.
Descriptors specify the value of an attribute, stating whether it’s a method or
a field.  With the descriptor API, static methods and class methods become
possible, as well as more exotic constructs.

Attribute descriptors are objects that live inside class objects, and have a few
attributes of their own:


@itemize *

@item 
@ref{109f,,__name__} is the attribute’s name.

@item 
@ref{92e,,__doc__} is the attribute’s docstring.

@item 
@code{__get__(object)} is a method that retrieves the attribute value from
`object'.

@item 
@code{__set__(object, value)} sets the attribute on `object' to `value'.

@item 
@code{__delete__(object, value)} deletes the `value'  attribute of `object'.
@end itemize

For example, when you write @code{obj.x}, the steps that Python actually performs
are:

@example
descriptor = obj.__class__.x
descriptor.__get__(obj)
@end example

For methods, @ref{1530,,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{416,,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.

More new features, such as slots and properties, are also implemented as new
kinds of descriptors, and it’s not difficult to write a descriptor class that
does something novel.  For example, it would be possible to write a descriptor
class that made it possible to write Eiffel-style preconditions and
postconditions for a method.  A class that used this feature might be defined
like this:

@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 Multiple Inheritance The Diamond Rule,Attribute Access,Descriptors,PEPs 252 and 253 Type and Class Changes
@anchor{whatsnew/2 2 multiple-inheritance-the-diamond-rule}@anchor{1531}
@subsubsection Multiple Inheritance: The Diamond Rule


Multiple inheritance has also been made more useful through changing the rules
under which names are resolved.  Consider this set of classes (diagram taken
from 
@geindex Propostas de Melhorias do Python; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} by 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.

New-style classes follow a different algorithm that’s a bit more complicated to
explain, but does the right thing in this situation. (Note that Python 2.3
changes this algorithm to one that produces the same results in most cases, but
produces more useful results for really complicated inheritance graphs.)


@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{4db,,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

@ref{4db,,super()} can also return unbound superclass objects when called as
@code{super(class)} or @code{super(class1, class2)}, but this probably won’t
often be useful.

@node Attribute Access,Related Links,Multiple Inheritance The Diamond Rule,PEPs 252 and 253 Type and Class Changes
@anchor{whatsnew/2 2 attribute-access}@anchor{1532}
@subsubsection Attribute Access


A fair number of sophisticated Python classes define hooks for attribute access
using @ref{4d3,,__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.

First, @code{__getattr__(attr_name)} is still supported by new-style classes,
and nothing about it has changed.  As before, it will be called when an attempt
is made to access @code{obj.foo} and no attribute named @code{foo} is found in the
instance’s dictionary.

New-style classes also support a new method,
@code{__getattribute__(attr_name)}.  The difference between the two methods is
that @ref{beb,,__getattribute__()} is `always' called whenever any attribute is
accessed, while the old @ref{4d3,,__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{55b,,__dict__}. @ref{4d3,,__getattr__()} methods also end up being called by Python
when it checks for other methods such as @ref{61c,,__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{194,,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{55b,,__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.

Finally, it’s possible to constrain the list of attributes that can be
referenced on an object using the new @ref{1533,,__slots__} class attribute. Python
objects are usually very dynamic; at any time it’s possible to define a new
attribute on an instance by just doing @code{obj.new_attr=1}.   A new-style class
can define a class attribute named @ref{1533,,__slots__} to limit the legal
attributes  to a particular set of names.  An example will make this clear:

@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

Note how you get an @ref{34b,,AttributeError} on the attempt to assign to an
attribute not listed in @ref{1533,,__slots__}.

@node Related Links,,Attribute Access,PEPs 252 and 253 Type and Class Changes
@anchor{whatsnew/2 2 related-links}@anchor{1534}@anchor{whatsnew/2 2 sect-rellinks}@anchor{152d}
@subsubsection Related Links


This section has just been a quick overview of the new features, giving enough
of an explanation to start you programming, but many details have been
simplified or ignored.  Where should you go to get a more complete picture?

The @ref{1535,,Guia de descritores} 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.

Next, there are two relevant PEPs, 
@geindex Propostas de Melhorias do Python; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} and 
@geindex Propostas de Melhorias do Python; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/}.  
@geindex Propostas de Melhorias do Python; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} is
titled “Making Types Look More Like Classes”, and covers the descriptor API.
@geindex Propostas de Melhorias do Python; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} is titled “Subtyping Built-in Types”, and describes the changes to
type objects that make it possible to subtype built-in objects.  
@geindex Propostas de Melhorias do Python; PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} is
the more complicated PEP of the two, and at a few points the necessary
explanations of types and meta-types may cause your head to explode.  Both PEPs
were written and implemented by Guido van Rossum, with substantial assistance
from the rest of the Zope Corp. team.

Finally, there’s the ultimate authority: the source code.  Most of the machinery
for the type handling is in @code{Objects/typeobject.c}, but you should only
resort to it after all other avenues have been exhausted, including posting a
question to python-list or python-dev.

@c ======================================================================

@node PEP 234 Iterators,PEP 255 Simple Generators<2>,PEPs 252 and 253 Type and Class Changes,What’s New in Python 2 2
@anchor{whatsnew/2 2 pep-234-iterators}@anchor{1536}
@subsection PEP 234: Iterators


Another significant addition to 2.2 is an iteration interface at both the C and
Python levels.  Objects can define how they can be looped over by callers.

In Python versions up to 2.1, the usual way to make @code{for item in obj} work is
to define a @ref{283,,__getitem__()} method that looks something like this:

@example
def __getitem__(self, index):
    return <next item>
@end example

@ref{283,,__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{2f2,,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{283,,__getitem__()} calls will be made with `index' incrementing by
one each time.  In other words, the presence of the @ref{283,,__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{283,,__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{1537,,tp_iter}
function in order to return an iterator, and extension types that want to behave
as iterators can define a @ref{1538,,tp_iternext} function.

So, after all this, what do iterators actually do?  They have one required
method, @ref{7d9,,next()}, which takes no arguments and returns the next value.  When
there are no more values to be returned, calling @ref{7d9,,next()} should raise the
@ref{c15,,StopIteration} exception.

@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{2f2,,for} statement no longer expects a sequence; it
expects something for which @ref{7d8,,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{1537,,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

Iterator support has been added to some of Python’s basic types.   Calling
@ref{7d8,,iter()} on a dictionary will return an iterator which loops over its keys:

@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{2f4,,in} operator now works on dictionaries,
so @code{key in dict} is now equivalent to @code{dict.has_key(key)}.

Files also provide an iterator, which calls the @ref{ba,,readline()} method until
there are no more lines in the file.  This means you can now read each line of a
file using code like this:

@example
for line in file:
    # do something for each line
    ...
@end example

Note that you can only go forward in an iterator; there’s no way to get the
previous element, reset the iterator, or make a copy of it. An iterator object
could provide such additional capabilities, but the iterator protocol only
requires a @ref{7d9,,next()} method.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 234

@item PEP 234@footnote{https://peps.python.org/pep-0234/} - Iterators

Written by Ka-Ping Yee and GvR; implemented  by the Python Labs crew, mostly by
GvR and Tim Peters.
@end table


@c ======================================================================

@node PEP 255 Simple Generators<2>,PEP 237 Unifying Long Integers and Integers<2>,PEP 234 Iterators,What’s New in Python 2 2
@anchor{whatsnew/2 2 pep-255-simple-generators}@anchor{1539}
@subsection PEP 255: Simple Generators


Generators are another new feature, one that interacts with the introduction of
iterators.

You’re doubtless familiar with how function calls work in Python or C.  When you
call a function, it gets a private namespace where its local variables are
created.  When the function reaches a @ref{9d6,,return} statement, the local
variables are destroyed and the resulting value is returned to the caller.  A
later call to the same function will get a fresh new set of local variables.
But, what if the local variables weren’t thrown away on exiting a function?
What if you could later resume the function where it left off?  This is what
generators provide; they can be thought of as resumable functions.

Here’s the simplest example of a generator function:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

A new keyword, @ref{9d5,,yield}, was introduced for generators.  Any function
containing a @code{yield} statement is a generator function; this is
detected by Python’s bytecode compiler which compiles the function specially as
a result.  Because a new keyword was introduced, generators must be explicitly
enabled in a module by including a @code{from __future__ import generators}
statement near the top of the module’s source code.  In Python 2.3 this
statement will become unnecessary.

When you call a generator function, it doesn’t return a single value; instead it
returns a generator object that supports the iterator protocol.  On executing
the @ref{9d5,,yield} statement, the generator outputs the value of @code{i},
similar to a @ref{9d6,,return} statement.  The big difference between
@code{yield} and a @code{return} statement is that on reaching a
@code{yield} the generator’s state of execution is suspended and local
variables are preserved.  On the next call to the generator’s @code{next()} method,
the function will resume executing immediately after the @code{yield}
statement.  (For complicated reasons, the @code{yield} statement isn’t
allowed inside the @code{try} block of a
@ref{6e9,,try}…@ref{9d2,,finally} statement; read 
@geindex Propostas de Melhorias do Python; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/} for a full
explanation of the interaction between @code{yield} and exceptions.)

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

You could equally write @code{for i in generate_ints(5)}, or @code{a,b,c =
generate_ints(3)}.

Inside a generator function, the @ref{9d6,,return} statement can only be used
without a value, and signals the end of the procession of values; afterwards the
generator cannot return any further values. @code{return} with a value, such
as @code{return 5}, is a syntax error inside a generator function.  The end of the
generator’s results can also be indicated by raising @ref{c15,,StopIteration}
manually, or by just letting the flow of execution fall off the bottom of the
function.

You could achieve the effect of generators manually by writing your own class
and storing all the local variables of the generator as instance variables.  For
example, returning a list of integers could be done by setting @code{self.count} to
0, and having the @ref{7d9,,next()} method increment @code{self.count} and return it.
However, for a moderately complicated generator, writing a corresponding class
would be much messier. @code{Lib/test/test_generators.py} contains a number of
more interesting examples.  The simplest one implements an in-order traversal of
a tree using generators recursively.

@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

Two other examples in @code{Lib/test/test_generators.py} produce solutions for
the N-Queens problem (placing $N$ queens on an $NxN$ chess board so that no
queen threatens another) and the Knight’s Tour (a route that takes a knight to
every square of an $NxN$ chessboard without visiting any square twice).

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{2f3,,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 doesn’t go nearly as far as Icon in adopting generators as a central
concept.  Generators are considered a new part of the core Python language, but
learning or using them isn’t compulsory; if they don’t solve any problems that
you have, feel free to ignore them. One novel feature of Python’s interface as
compared to Icon’s is that a generator’s state is represented as a concrete
object (the iterator) that can be passed around to other functions or stored in
a data structure.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Simple Generators

Written by Neil Schemenauer, Tim Peters, Magnus Lie Hetland.  Implemented mostly
by Neil Schemenauer and Tim Peters, with other fixes from the Python Labs crew.
@end table


@c ======================================================================

@node PEP 237 Unifying Long Integers and Integers<2>,PEP 238 Changing the Division Operator,PEP 255 Simple Generators<2>,What’s New in Python 2 2
@anchor{whatsnew/2 2 pep-237-unifying-long-integers-and-integers}@anchor{153a}
@subsection PEP 237: Unifying Long Integers and Integers


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{2c3,,TypeError} exception with the message ‘slice
index must be int’.

Python 2.2 will shift values from short to long integers as required. The ‘L’
suffix is no longer needed to indicate a long integer literal, as now the
compiler will choose the appropriate type.  (Using the ‘L’ suffix will be
discouraged in future 2.x versions of Python, triggering a warning in Python
2.4, and probably dropped in Python 3.0.)  Many operations that used to raise an
@ref{885,,OverflowError} will now return a long integer as their result.  For
example:

@example
>>> 1234567890123
1234567890123L
>>> 2 ** 64
18446744073709551616L
@end example

In most cases, integers and long integers will now be treated identically.  You
can still distinguish them with the @ref{d6b,,type()} built-in function, but that’s
rarely needed.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - Unifying Long Integers and Integers

Written by Moshe Zadka and Guido van Rossum.  Implemented mostly by Guido van
Rossum.
@end table


@c ======================================================================

@node PEP 238 Changing the Division Operator,Unicode Changes,PEP 237 Unifying Long Integers and Integers<2>,What’s New in Python 2 2
@anchor{whatsnew/2 2 pep-238-changing-the-division-operator}@anchor{153b}
@subsection PEP 238: Changing the Division Operator


The most controversial change in Python 2.2 heralds the start of an effort to
fix an old design flaw that’s been in Python from the beginning. Currently
Python’s division operator, @code{/}, behaves like C’s division operator when
presented with two integer arguments: it returns an integer result that’s
truncated down when there would be a fractional part.  For example, @code{3/2} is
1, not 1.5, and @code{(-1)/2} is -1, not -0.5.  This means that the results of
division can vary unexpectedly depending on the type of the two operands and
because Python is dynamically typed, it can be difficult to determine the
possible types of the operands.

(The controversy is over whether this is `really' a design flaw, and whether
it’s worth breaking existing code to fix this.  It’s caused endless discussions
on python-dev, and in July 2001 erupted into a storm of acidly sarcastic
postings on @code{comp.lang.python}. I won’t argue for either side here
and will stick to describing what’s  implemented in 2.2.  Read 
@geindex Propostas de Melhorias do Python; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/} for a
summary of arguments and counter-arguments.)

Because this change might break code, it’s being introduced very gradually.
Python 2.2 begins the transition, but the switch won’t be complete until Python
3.0.

First, I’ll borrow some terminology from 
@geindex Propostas de Melhorias do Python; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}.  “True division” is the
division that most non-programmers are familiar with: 3/2 is 1.5, 1/4 is 0.25,
and so forth.  “Floor division” is what Python’s @code{/} operator currently does
when given integer operands; the result is the floor of the value returned by
true division.  “Classic division” is the current mixed behaviour of @code{/}; it
returns the result of floor division when the operands are integers, and returns
the result of true division when one of the operands is a floating-point number.

Here are the changes 2.2 introduces:


@itemize *

@item 
A new operator, @code{//}, is the floor division operator. (Yes, we know it looks
like C++’s comment symbol.)  @code{//} `always' performs floor division no matter
what the types of its operands are, so @code{1 // 2} is 0 and @code{1.0 // 2.0} is
also 0.0.

@code{//} is always available in Python 2.2; you don’t need to enable it using a
@code{__future__} statement.

@item 
By including a @code{from __future__ import division} in a module, the @code{/}
operator will be changed to return the result of true division, so @code{1/2} is
0.5.  Without the @code{__future__} statement, @code{/} still means classic division.
The default meaning of @code{/} will not change until Python 3.0.

@item 
Classes can define methods called @ref{ebf,,__truediv__()} and @ref{153c,,__floordiv__()}
to overload the two division operators.  At the C level, there are also slots in
the @ref{1465,,PyNumberMethods} structure so extension types can define the two
operators.

@item 
Python 2.2 supports some command-line arguments for testing whether code will
work with the changed division semantics.  Running python with @code{-Q
warn} will cause a warning to be issued whenever division is applied to two
integers.  You can use this to find code that’s affected by the change and fix
it.  By default, Python 2.2 will simply perform classic division without a
warning; the warning will be turned on by default in Python 2.3.
@end itemize


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 238

@item PEP 238@footnote{https://peps.python.org/pep-0238/} - Changing the Division Operator

Written by Moshe Zadka and  Guido van Rossum.  Implemented by Guido van Rossum..
@end table


@c ======================================================================

@node Unicode Changes,PEP 227 Nested Scopes,PEP 238 Changing the Division Operator,What’s New in Python 2 2
@anchor{whatsnew/2 2 unicode-changes}@anchor{153d}
@subsection Unicode Changes


Python’s Unicode support has been enhanced a bit in 2.2.  Unicode strings are
usually stored as UCS-2, as 16-bit unsigned integers. Python 2.2 can also be
compiled to use UCS-4, 32-bit unsigned integers, as its internal encoding by
supplying @code{--enable-unicode=ucs4} to the configure script.   (It’s also
possible to specify @code{--disable-unicode} to completely disable Unicode
support.)

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{202,,ValueError} exception. This is all
described in 
@geindex Propostas de Melhorias do Python; 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.

Using this new feature, codecs have been added for tasks not directly related to
Unicode.  For example, codecs have been added for uu-encoding, MIME’s base64
encoding, and compression with the @ref{133,,zlib} module:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 261

@item PEP 261@footnote{https://peps.python.org/pep-0261/} - Support for ‘wide’ Unicode characters

Written by Paul Prescod.
@end table


@c ======================================================================

@node PEP 227 Nested Scopes,Módulos Novos ou Aprimorados<3>,Unicode Changes,What’s New in Python 2 2
@anchor{whatsnew/2 2 pep-227-nested-scopes}@anchor{153e}
@subsection PEP 227: Nested Scopes


In Python 2.1, statically nested scopes were added as an optional feature, to be
enabled by a @code{from __future__ import nested_scopes} directive.  In 2.2 nested
scopes no longer need to be specially enabled, and are now always present.  The
rest of this section is a copy of the description of nested scopes from my
“What’s New in Python 2.1” document; if you read it when 2.1 came out, you can
skip the rest of this section.

The largest change introduced in Python 2.1, and made complete in 2.2, is to
Python’s scoping rules.  In Python 2.0, at any given time there are at most
three namespaces used to look up variable names: local, module-level, and the
built-in namespace.  This often surprised people because it didn’t match their
intuitive expectations.  For example, a nested recursive function definition
doesn’t work:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

The function @code{g()} will always raise a @ref{43f,,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{12df,,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

The readability of Python code written in a strongly functional style suffers
greatly as a result.

The most significant change to Python 2.2 is that static scoping has been added
to the language to fix this problem.  As a first effect, the @code{name=name}
default argument is now unnecessary in the above example.  Put simply, when a
given variable name is not assigned a value within a function (by an assignment,
or the @ref{14a2,,def}, @ref{131a,,class}, or @ref{5e2,,import} statements),
references to the variable will be looked up in the local namespace of the
enclosing scope.  A more detailed explanation of the rules, and a dissection of
the implementation, can be found in the PEP.

This change may cause some compatibility problems for code where the same
variable name is used both at the module level and as a local variable within a
function that contains further function definitions. This seems rather unlikely
though, since such code would have been pretty confusing to read in the first
place.

One side effect of the change is that the @code{from module import *} and @code{exec} statements have been made illegal inside a function scope under certain conditions. The Python reference manual has said all along that @code{from module import *} is only legal at the top level of a module, but the CPython interpreter has never enforced this before. As part of the implementation of nested scopes, the compiler which turns Python source into bytecodes has to generate different code to access variables in a containing scope. @code{from module import *} and @code{exec} make it impossible for the compiler to figure this out, because they add names to the local namespace that are unknowable at compile time. Therefore, if a function contains function definitions or @ref{12df,,lambda} expressions with free variables, the compiler will flag this by raising a @ref{18d,,SyntaxError} exception.

To make the preceding explanation a bit clearer, here’s an example:

@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()}.

This shouldn’t be much of a limitation, since @code{exec} is rarely used in
most Python code (and when it is used, it’s often a sign of a poor design
anyway).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - Statically Nested Scopes

Written and implemented by Jeremy Hylton.
@end table


@c ======================================================================

@node Módulos Novos ou Aprimorados<3>,Interpreter Changes and Fixes,PEP 227 Nested Scopes,What’s New in Python 2 2
@anchor{whatsnew/2 2 new-and-improved-modules}@anchor{153f}
@subsection Módulos Novos ou Aprimorados



@itemize *

@item 
The @ref{12e,,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{12f,,SimpleXMLRPCServer} module makes it easy to create straightforward
XML-RPC servers.  See @indicateurl{http://xmlrpc.scripting.com/} for more information about XML-RPC.

@item 
The new @ref{6a,,hmac} module implements the HMAC algorithm described by
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html}. (Contributed by 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{1540,,tm_year}. The enhanced functions include
@ref{4a0,,stat()}, @ref{db4,,fstat()}, @ref{113b,,statvfs()}, and @ref{db5,,fstatvfs()} in the
@ref{a1,,os} module, and @ref{1541,,localtime()}, @ref{1200,,gmtime()}, and @ref{1474,,strptime()} in
the @ref{ee,,time} module.

For example, to obtain a file’s size using the old tuples, you’d end up writing
something like @code{file_size = os.stat(filename)[stat.ST_SIZE]}, but now this can
be written more clearly as @code{file_size = os.stat(filename).st_size}.

The original patch for this feature was contributed by Nick Mathewson.

@item 
The Python profiler has been extensively reworked and various errors in its
output have been corrected.  (Contributed by Fred L. Drake, Jr. and Tim Peters.)

@item 
The @ref{cc,,socket} module can be compiled to support IPv6; specify the
@code{--enable-ipv6} option to Python’s configure script.  (Contributed by
Jun-ichiro “itojun” Hagino.)

@item 
Two new format characters were added to the @ref{d5,,struct} module for 64-bit
integers on platforms that support the C long long type.  @code{q} is for
a signed 64-bit integer, and @code{Q} is for an unsigned one.  The value is
returned in Python’s long integer type.  (Contributed by Tim Peters.)

@item 
In the interpreter’s interactive mode, there’s a new built-in function
@ref{8dd,,help()} that uses the @ref{b5,,pydoc} module introduced in Python 2.1 to
provide interactive help. @code{help(object)} displays any available help text
about `object'.  @ref{8dd,,help()} with no argument puts you in an online help
utility, where you can enter the names of functions, classes, or modules to read
their help text. (Contributed by Guido van Rossum, using Ka-Ping Yee’s
@ref{b5,,pydoc} module.)

@item 
Various bugfixes and performance improvements have been made to the SRE engine
underlying the @ref{b9,,re} module.  For example, the @ref{2a3,,re.sub()} and
@ref{2a2,,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{1542,,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 
The @ref{ca,,smtplib} module now supports 
@geindex RFC; RFC 2487
RFC 2487@footnote{https://datatracker.ietf.org/doc/html/rfc2487.html}, “Secure SMTP over TLS”, so
it’s now possible to encrypt the SMTP traffic between a Python program and the
mail transport agent being handed a message.  @ref{ca,,smtplib} also supports SMTP
authentication.  (Contributed by Gerhard Häring.)

@item 
The @ref{74,,imaplib} module, maintained by Piers Lauder, has support for several
new extensions: the NAMESPACE extension defined in 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html}, SORT, GETACL and
SETACL.  (Contributed by Anthony Baxter and 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{3b,,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{37,,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{1543,,MimeTypes} class, which takes a list of
filenames to be parsed.  (Contributed by Fred L. Drake, Jr.)

@item 
A @ref{1198,,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 Interpreter Changes and Fixes,Outras alterações e correções<3>,Módulos Novos ou Aprimorados<3>,What’s New in Python 2 2
@anchor{whatsnew/2 2 interpreter-changes-and-fixes}@anchor{1544}
@subsection Interpreter Changes and Fixes


Some of the changes only affect people who deal with the Python interpreter at
the C level because they’re writing Python extension modules, embedding the
interpreter, or just hacking on the interpreter itself. If you only write Python
code, none of the changes described here will affect you very much.


@itemize *

@item 
Profiling and tracing functions can now be implemented in C, which can operate
at much higher speeds than Python-based functions and should reduce the overhead
of profiling and tracing.  This  will be of interest to authors of development
environments for Python.  Two new C functions were added to Python’s API,
@ref{1545,,PyEval_SetProfile()} and @ref{421,,PyEval_SetTrace()}. The existing
@ref{1546,,sys.setprofile()} and @ref{1547,,sys.settrace()} functions still exist, and have
simply been changed to use the new C-level interface.  (Contributed by Fred L.
Drake, Jr.)

@item 
Another low-level API, primarily of interest to implementers of Python
debuggers and development tools, was added. @ref{1548,,PyInterpreterState_Head()} and
@ref{1549,,PyInterpreterState_Next()} let a caller walk through all the existing
interpreter objects; @ref{154a,,PyInterpreterState_ThreadHead()} and
@ref{154b,,PyThreadState_Next()} allow looping over all the thread states for a given
interpreter.  (Contributed by David Beazley.)

@item 
The C-level interface to the garbage collector has been changed to make it
easier to write extension types that support garbage collection and to debug
misuses of the functions. Various functions have slightly different semantics,
so a bunch of functions had to be renamed.  Extensions that use the old API will
still compile but will `not' participate in garbage collection, so updating them
for 2.2 should be considered fairly high priority.

To upgrade an extension module to the new API, perform the following steps:

@item 
Rename @code{Py_TPFLAGS_GC} to @ref{77d,,Py_TPFLAGS_HAVE_GC}.

@item 

@table @asis

@item Use @ref{ab1,,PyObject_GC_New()} or @ref{ab2,,PyObject_GC_NewVar()} to allocate

objects, and @ref{154c,,PyObject_GC_Del()} to deallocate them.
@end table

@item 
Rename @code{PyObject_GC_Init()} to @ref{154d,,PyObject_GC_Track()} and
@code{PyObject_GC_Fini()} to @ref{154e,,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 
A new @code{et} format sequence was added to @ref{571,,PyArg_ParseTuple()}; @code{et}
takes both a parameter and an encoding name, and converts the parameter to the
given encoding if the parameter turns out to be a Unicode string, or leaves it
alone if it’s an 8-bit string, assuming it to already be in the desired
encoding.  This differs from the @code{es} format character, which assumes that
8-bit strings are in Python’s default ASCII encoding and converts them to the
specified new encoding. (Contributed by M.-A. Lemburg, and used for the MBCS
support on Windows described in the following section.)

@item 
A different argument parsing function, @ref{154f,,PyArg_UnpackTuple()}, has been
added that’s simpler and presumably faster.  Instead of specifying a format
string, the caller simply gives the minimum and maximum number of arguments
expected, and a set of pointers to @ref{339,,PyObject}* variables that will be
filled in with argument values.

@item 
Two new flags @ref{151c,,METH_NOARGS} and @ref{1550,,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{1551,,METH_VARARGS}.  Also, the old
@code{METH_OLDARGS} style of writing C methods is  now officially deprecated.

@item 
Two new wrapper functions, @ref{1552,,PyOS_snprintf()} and @ref{1553,,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 
The @ref{1554,,_PyTuple_Resize()} function has lost an unused parameter, so now it
takes 2 parameters instead of 3.  The third argument was never used, and can
simply be discarded when porting code from earlier versions to Python 2.2.
@end itemize

@c ======================================================================

@node Outras alterações e correções<3>,Reconhecimentos<6>,Interpreter Changes and Fixes,What’s New in Python 2 2
@anchor{whatsnew/2 2 other-changes-and-fixes}@anchor{1555}
@subsection Outras alterações e correções


As usual there were a bunch of other improvements and bugfixes scattered
throughout the source tree.  A search through the CVS change logs finds there
were 527 patches applied and 683 bugs fixed between Python 2.1 and 2.2; 2.2.1
applied 139 patches and fixed 143 bugs; 2.2.2 applied 106 patches and fixed 82
bugs.  These figures are likely to be underestimates.

Some of the more notable changes are:


@itemize *

@item 
The code for the MacOS port for Python, maintained by Jack Jansen, is now kept
in the main Python CVS tree, and many changes have been made to support MacOS X.

The most significant change is the ability to build Python as a framework,
enabled by supplying the @code{--enable-framework} option to the configure
script when compiling Python.  According to Jack Jansen, “This installs a
self-contained Python installation plus the OS X framework “glue” into
@code{/Library/Frameworks/Python.framework} (or another location of choice).
For now there is little immediate added benefit to this (actually, there is the
disadvantage that you have to change your PATH to be able to find Python), but
it is the basis for creating a full-blown Python application, porting the
MacPython IDE, possibly using Python as a standard OSA scripting language and
much more.”

Most of the MacPython toolbox modules, which interface to MacOS APIs such as
windowing, QuickTime, scripting, etc. have been ported to OS X, but they’ve been
left commented out in @code{setup.py}.  People who want to experiment with
these modules can uncomment them manually.

@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 
Keyword arguments passed to built-in functions that don’t take them now cause a
@ref{2c3,,TypeError} exception to be raised, with the message “`function' takes no
keyword arguments”.

@item 
Weak references, added in Python 2.1 as an extension module, are now part of
the core because they’re used in the implementation of new-style classes.  The
@ref{1556,,ReferenceError} exception has therefore moved from the @ref{114,,weakref}
module to become a built-in exception.

@item 
A new script, @code{Tools/scripts/cleanfuture.py} by Tim Peters,
automatically removes obsolete @code{__future__} statements from Python source
code.

@item 
An additional `flags' argument has been added to the built-in function
@ref{192,,compile()}, so the behaviour of @code{__future__} statements can now be
correctly observed in simulated shells, such as those presented by IDLE and
other development environments.  This is described in 
@geindex Propostas de Melhorias do Python; PEP 264
PEP 264@footnote{https://peps.python.org/pep-0264/}. (Contributed
by Michael Hudson.)

@item 
The new license introduced with Python 1.6 wasn’t GPL-compatible.  This is
fixed by some minor textual changes to the 2.2 license, so it’s now legal to
embed Python inside a GPLed program again.  Note that Python itself is not
GPLed, but instead is under a license that’s essentially equivalent to the BSD
license, same as it always was.  The license changes were also applied to the
Python 2.0.1 and 2.1.1 releases.

@item 
When presented with a Unicode filename on Windows, Python will now convert it
to an MBCS encoded string, as used by the Microsoft file APIs.  As MBCS is
explicitly used by the file APIs, Python’s choice of ASCII as the default
encoding turns out to be an annoyance.  On Unix, the locale’s character set is
used if @code{locale.nl_langinfo(CODESET)} is available.  (Windows support was
contributed by Mark Hammond with assistance from Marc-André Lemburg. Unix
support was added by Martin von Löwis.)

@item 
Large file support is now enabled on Windows.  (Contributed by Tim Peters.)

@item 
The @code{Tools/scripts/ftpmirror.py} script now parses a @code{.netrc}
file, if you have one. (Contributed by 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{2f4,,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 
There were a bunch of patches to the dictionary implementation, mostly to fix
potential core dumps if a dictionary contains objects that sneakily changed
their hash value, or mutated the dictionary they were contained in. For a while
python-dev fell into a gentle rhythm of Michael Hudson finding a case that
dumped core, Tim Peters fixing the bug, Michael finding another case, and round
and round it went.

@item 
On Windows, Python can now be compiled with Borland C thanks to a number of
patches contributed by Stephen Hansen, though the result isn’t fully functional
yet.  (But this `is' progress…)

@item 
Another Windows enhancement: Wise Solutions generously offered PythonLabs use
of their InstallerMaster 8.1 system.  Earlier PythonLabs Windows installers used
Wise 5.0a, which was beginning to show its age.  (Packaged up by Tim Peters.)

@item 
Files ending in @code{.pyw} can now be imported on Windows. @code{.pyw} is a
Windows-only thing, used to indicate that a script needs to be run using
PYTHONW.EXE instead of PYTHON.EXE in order to prevent a DOS console from popping
up to display the output.  This patch makes it possible to import such scripts,
in case they’re also usable as modules.  (Implemented by David Bolen.)

@item 
On platforms where Python uses the C @code{dlopen()} function  to load
extension modules, it’s now possible to set the flags used  by @code{dlopen()}
using the @ref{1557,,sys.getdlopenflags()} and @ref{115e,,sys.setdlopenflags()} functions.
(Contributed by Bram Stolk.)

@item 
The @ref{9da,,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{2c3,,TypeError} exception.
@end itemize

@c ======================================================================

@node Reconhecimentos<6>,,Outras alterações e correções<3>,What’s New in Python 2 2
@anchor{whatsnew/2 2 acknowledgements}@anchor{1558}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions,
corrections and assistance with various drafts of this article: 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 What’s New in Python 2 1,What’s New in Python 2 0,What’s New in Python 2 2,O que há de novo no Python
@anchor{whatsnew/2 1 doc}@anchor{1559}@anchor{whatsnew/2 1 translation-repo}@anchor{155a}@anchor{whatsnew/2 1 what-s-new-in-python-2-1}@anchor{155b}
@section What’s New in Python 2.1


@*Autor: 
A.M. Kuchling


@c $Id: whatsnew21.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* Introdução: Introdução<2>. 
* PEP 227; Nested Scopes: PEP 227 Nested Scopes<2>. 
* PEP 236; __future__ Directives: PEP 236 __future__ Directives. 
* PEP 207; Rich Comparisons: PEP 207 Rich Comparisons. 
* PEP 230; Warning Framework: PEP 230 Warning Framework. 
* PEP 229; New Build System: PEP 229 New Build System. 
* PEP 205; Weak References: PEP 205 Weak References. 
* PEP 232; Function Attributes: PEP 232 Function Attributes. 
* PEP 235; Importing Modules on Case-Insensitive Platforms: PEP 235 Importing Modules on Case-Insensitive Platforms. 
* PEP 217; Interactive Display Hook: PEP 217 Interactive Display Hook. 
* PEP 208; New Coercion Model: PEP 208 New Coercion Model. 
* PEP 241; Metadata in Python Packages: PEP 241 Metadata in Python Packages. 
* Módulos Novos ou Aprimorados: Módulos Novos ou Aprimorados<4>. 
* Outras alterações e correções: Outras alterações e correções<4>. 
* Reconhecimentos: Reconhecimentos<7>. 

@end menu

@node Introdução<2>,PEP 227 Nested Scopes<2>,,What’s New in Python 2 1
@anchor{whatsnew/2 1 introduction}@anchor{155c}
@subsection Introdução


This article explains the new features in Python 2.1. While there aren’t as many changes in 2.1 as there were in Python 2.0, there are still some pleasant surprises in store. 2.1 is the first release to be steered through the use of Python Enhancement Proposals, or PEPs, so most of the sizable changes have accompanying PEPs that provide more complete documentation and a design rationale for the change. This article doesn’t attempt to document the new features completely, but simply provides an overview of the new features for Python programmers. Refer to the Python 2.1 documentation, or to the specific PEP, for more details about any new feature that particularly interests you.

One recent goal of the Python development team has been to accelerate the pace
of new releases, with a new release coming every 6 to 9 months. 2.1 is the first
release to come out at this faster pace, with the first alpha appearing in
January, 3 months after the final version of 2.0 was released.

The final release of Python 2.1 was made on April 17, 2001.

@c ======================================================================

@node PEP 227 Nested Scopes<2>,PEP 236 __future__ Directives,Introdução<2>,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-227-nested-scopes}@anchor{155d}
@subsection PEP 227: Nested Scopes


The largest change in Python 2.1 is to Python’s scoping rules. In Python 2.0, at any given time there are at most three namespaces used to look up variable names: local, module-level, and the built-in namespace. This often surprised people because it didn’t match their intuitive expectations. For example, a nested recursive function definition doesn’t work:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

The function @code{g()} will always raise a @ref{43f,,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{12df,,lambda} expression clumsier, and this was a problem in practice.
In code which uses @ref{12df,,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

The readability of Python code written in a strongly functional style suffers
greatly as a result.

The most significant change to Python 2.1 is that static scoping has been added to the language to fix this problem. As a first effect, the @code{name=name} default argument is now unnecessary in the above example. Put simply, when a given variable name is not assigned a value within a function (by an assignment, or the @ref{14a2,,def}, @ref{131a,,class}, or @ref{5e2,,import} statements), references to the variable will be looked up in the local namespace of the enclosing scope. A more detailed explanation of the rules, and a dissection of the implementation, can be found in the PEP.

This change may cause some compatibility problems for code where the same
variable name is used both at the module level and as a local variable within a
function that contains further function definitions. This seems rather unlikely
though, since such code would have been pretty confusing to read in the first
place.

One side effect of the change is that the @code{from module import *} and @code{exec} statements have been made illegal inside a function scope under certain conditions. The Python reference manual has said all along that @code{from module import *} is only legal at the top level of a module, but the CPython interpreter has never enforced this before. As part of the implementation of nested scopes, the compiler which turns Python source into bytecodes has to generate different code to access variables in a containing scope. @code{from module import *} and @code{exec} make it impossible for the compiler to figure this out, because they add names to the local namespace that are unknowable at compile time. Therefore, if a function contains function definitions or @ref{12df,,lambda} expressions with free variables, the compiler will flag this by raising a @ref{18d,,SyntaxError} exception.

To make the preceding explanation a bit clearer, here’s an example:

@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()}.

This shouldn’t be much of a limitation, since @code{exec} is rarely used in
most Python code (and when it is used, it’s often a sign of a poor design
anyway).

Compatibility concerns have led to nested scopes being introduced gradually; in
Python 2.1, they aren’t enabled by default, but can be turned on within a module
by using a future statement as described in 
@geindex Propostas de Melhorias do Python; PEP 236
PEP 236@footnote{https://peps.python.org/pep-0236/}.  (See the following section
for further discussion of 
@geindex Propostas de Melhorias do Python; PEP 236
PEP 236@footnote{https://peps.python.org/pep-0236/}.)  In Python 2.2, nested scopes will become
the default and there will be no way to turn them off, but users will have had
all of 2.1’s lifetime to fix any breakage resulting from their introduction.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - Statically Nested Scopes

Written and implemented by Jeremy Hylton.
@end table


@c ======================================================================

@node PEP 236 __future__ Directives,PEP 207 Rich Comparisons,PEP 227 Nested Scopes<2>,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-236-future-directives}@anchor{155e}
@subsection PEP 236: __future__ Directives


The reaction to nested scopes was widespread concern about the dangers of breaking code with the 2.1 release, and it was strong enough to make the Pythoneers take a more conservative approach. This approach consists of introducing a convention for enabling optional functionality in release N that will become compulsory in release N+1.

The syntax uses a @code{from...import} statement using the reserved module name @ref{0,,__future__}. Nested scopes can be enabled by the following statement:

@example
from __future__ import nested_scopes
@end example

While it looks like a normal @ref{5e2,,import} statement, it’s not; there are
strict rules on where such a future statement can be put. They can only be at
the top of a module, and must precede any Python code or regular
@code{import} statements.  This is because such statements can affect how
the Python bytecode compiler parses code and generates bytecode, so they must
precede any statement that will result in bytecodes being produced.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - Back to the @ref{0,,__future__}

Written by Tim Peters, and primarily implemented by Jeremy Hylton.
@end table


@c ======================================================================

@node PEP 207 Rich Comparisons,PEP 230 Warning Framework,PEP 236 __future__ Directives,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-207-rich-comparisons}@anchor{155f}
@subsection PEP 207: Rich Comparisons


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.

In Python 2.1, rich comparisons were added in order to support this need. Python classes can now individually overload each of the @code{<}, @code{<=}, @code{>}, @code{>=}, @code{==}, and @code{!=} operations. The new magic method names are:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Nome do método

@item

@code{<}

@tab

@ref{12e2,,__lt__()}

@item

@code{<=}

@tab

@ref{134f,,__le__()}

@item

@code{>}

@tab

@ref{1350,,__gt__()}

@item

@code{>=}

@tab

@ref{1351,,__ge__()}

@item

@code{==}

@tab

@ref{b0d,,__eq__()}

@item

@code{!=}

@tab

@ref{1560,,__ne__()}

@end multitable


(The magic methods are named after the corresponding Fortran operators @code{.LT.}. @code{.LE.}, &c. Numeric programmers are almost certainly quite familiar with these names and will find them easy to remember.)

Each of these magic methods is of the form @code{method(self, other)}, where @code{self} will be the object on the left-hand side of the operator, while @code{other} will be the object on the right-hand side. For example, the expression @code{A < B} will cause @code{A.__lt__(B)} to be called.

Each of these magic methods can return anything at all: a Boolean, a matrix, a list, or any other Python object. Alternatively they can raise an exception if the comparison is impossible, inconsistent, or otherwise meaningless.

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.

There are also corresponding changes of interest to C programmers; there’s a new
slot @code{tp_richcmp} in type objects and an API for performing a given rich
comparison.  I won’t cover the C API here, but will refer you to 
@geindex Propostas de Melhorias do Python; PEP 207
PEP 207@footnote{https://peps.python.org/pep-0207/}, or to
2.1’s C API documentation, for the full list of related functions.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 207

@item PEP 207@footnote{https://peps.python.org/pep-0207/} - Rich Comparisons

Written by Guido van Rossum, heavily based on earlier work by David Ascher, and
implemented by Guido van Rossum.
@end table


@c ======================================================================

@node PEP 230 Warning Framework,PEP 229 New Build System,PEP 207 Rich Comparisons,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-230-warning-framework}@anchor{1561}
@subsection PEP 230: Warning Framework


Over its 10 years of existence, Python has accumulated a certain number of obsolete modules and features along the way. It’s difficult to know when a feature is safe to remove, since there’s no way of knowing how much code uses it — perhaps no programs depend on the feature, or perhaps many do. To enable removing old features in a more structured way, a warning framework was added. When the Python developers want to get rid of a feature, it will first trigger a warning in the next version of Python. The following Python version can then drop the feature, and users will have had a full release cycle to remove uses of the old feature.

Python 2.1 adds the warning framework to be used in this scheme. It adds a @ref{112,,warnings} module that provide functions to issue warnings, and to filter out warnings that you don’t want to be displayed. Third-party modules can also use this framework to deprecate old features that they no longer wish to support.

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

Warnings can be issued by calling the @ref{1562,,warnings.warn()} function:

@example
warnings.warn("feature X no longer supported")
@end example

The first parameter is the warning message; an additional optional parameters
can be used to specify a particular warning category.

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{1a5,,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).

Functions were also added to Python’s C API for issuing warnings; refer to PEP
230 or to Python’s API documentation for the details.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 5

@item PEP 5@footnote{https://peps.python.org/pep-0005/} - Guidelines for Language Evolution

Written by Paul Prescod, to specify procedures to be followed when removing old features from Python. The policy described in this PEP hasn’t been officially adopted, but the eventual policy probably won’t be too different from Prescod’s proposal.

@geindex Propostas de Melhorias do Python; PEP 230

@item PEP 230@footnote{https://peps.python.org/pep-0230/} - Warning Framework

Written and implemented by Guido van Rossum.
@end table


@c ======================================================================

@node PEP 229 New Build System,PEP 205 Weak References,PEP 230 Warning Framework,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-229-new-build-system}@anchor{1563}
@subsection PEP 229: New Build System


When compiling Python, the user had to go in and edit the @code{Modules/Setup}
file in order to enable various additional modules; the default set is
relatively small and limited to modules that compile on most Unix platforms.
This means that on Unix platforms with many more features, most notably Linux,
Python installations often don’t contain all useful modules they could.

Python 2.0 added the Distutils, a set of modules for distributing and installing extensions. In Python 2.1, the Distutils are used to compile much of the standard library of extension modules, autodetecting which ones are supported on the current machine. It’s hoped that this will make Python installations easier and more featureful.

Instead of having to edit the @code{Modules/Setup} file in order to enable modules, a @code{setup.py} script in the top directory of the Python source distribution is run at build time, and attempts to discover which modules can be enabled by examining the modules and header files on the system. If a module is configured in @code{Modules/Setup}, the @code{setup.py} script won’t attempt to compile that module and will defer to the @code{Modules/Setup} file’s contents. This provides a way to specific any strange command-line flags or libraries that are required for a specific platform.

In another far-reaching change to the build mechanism, Neil Schemenauer restructured things so Python now uses a single makefile that isn’t recursive, instead of makefiles in the top directory and in each of the @code{Python/}, @code{Parser/}, @code{Objects/}, and @code{Modules/} subdirectories. This makes building Python faster and also makes hacking the Makefiles clearer and simpler.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 229

@item PEP 229@footnote{https://peps.python.org/pep-0229/} - Using Distutils to Build Python

Written and implemented by A.M. Kuchling.
@end table


@c ======================================================================

@node PEP 205 Weak References,PEP 232 Function Attributes,PEP 229 New Build System,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-205-weak-references}@anchor{1564}
@subsection PEP 205: Weak References


Weak references, available through the @ref{114,,weakref} module, are a minor but
useful new data type in the Python programmer’s toolbox.

Storing a reference to an object (say, in a dictionary or a list) has the side effect of keeping that object alive forever. There are a few specific cases where this behaviour is undesirable, object caches being the most common one, and another being circular references in data structures such as trees.

For example, consider a memoizing function that caches the results of another
function @code{f(x)} by storing the function’s argument and its result in a
dictionary:

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

Weak references provide a way to implement a cache that won’t keep objects alive beyond their time. If an object is only accessible through weak references, the object will be deallocated and the weak references will now indicate that the object it referred to no longer exists. A weak reference to an object `obj' is created by calling @code{wr = weakref.ref(obj)}. The object being referred to is returned by calling the weak reference as if it were a function: @code{wr()}. It will return the referenced object, or @code{None} if the object no longer exists.

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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - Weak References

Written and implemented by Fred L. Drake, Jr.
@end table


@c ======================================================================

@node PEP 232 Function Attributes,PEP 235 Importing Modules on Case-Insensitive Platforms,PEP 205 Weak References,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-232-function-attributes}@anchor{1565}
@subsection PEP 232: Function Attributes


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{1219,,__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.

Arbitrary attributes can now be set and retrieved on functions using the regular
Python syntax:

@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{1315,,__dict__}. Unlike the @ref{c78,,__dict__} attribute of class instances, in
functions you can actually assign a new dictionary to @ref{1315,,__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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 232

@item PEP 232@footnote{https://peps.python.org/pep-0232/} - Function Attributes

Written and implemented by Barry Warsaw.
@end table


@c ======================================================================

@node PEP 235 Importing Modules on Case-Insensitive Platforms,PEP 217 Interactive Display Hook,PEP 232 Function Attributes,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-235-importing-modules-on-case-insensitive-platforms}@anchor{1566}
@subsection PEP 235: Importing Modules on Case-Insensitive Platforms


Some operating systems have filesystems that are case-insensitive, MacOS and Windows being the primary examples; on these systems, it’s impossible to distinguish the filenames @code{FILE.PY} and @code{file.py}, even though they do store the file’s name in its original case (they’re case-preserving, too).

In Python 2.1, the @ref{5e2,,import} statement will work to simulate case-sensitivity on case-insensitive platforms. Python will now search for the first case-sensitive match by default, raising an @ref{419,,ImportError} if no such file is found, so @code{import file} will not import a module named @code{FILE.PY}. Case-insensitive matching can be requested by setting the 
@geindex PYTHONCASEOK
@geindex variável de ambiente; PYTHONCASEOK
@ref{963,,PYTHONCASEOK} environment variable before starting the Python interpreter.

@c ======================================================================

@node PEP 217 Interactive Display Hook,PEP 208 New Coercion Model,PEP 235 Importing Modules on Case-Insensitive Platforms,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-217-interactive-display-hook}@anchor{1567}
@subsection PEP 217: Interactive Display Hook


When using the Python interpreter interactively, the output of commands is
displayed using the built-in @ref{800,,repr()} function. In Python 2.1, the variable
@ref{1568,,sys.displayhook()} can be set to a callable object which will be called
instead of @ref{800,,repr()}. For example, you can set it to a special
pretty-printing function:

@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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 217

@item PEP 217@footnote{https://peps.python.org/pep-0217/} - Display Hook for Interactive Use

Written and implemented by Moshe Zadka.
@end table


@c ======================================================================

@node PEP 208 New Coercion Model,PEP 241 Metadata in Python Packages,PEP 217 Interactive Display Hook,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-208-new-coercion-model}@anchor{1569}
@subsection PEP 208: New Coercion Model


How numeric coercion is done at the C level was significantly modified. This will only affect the authors of C extensions to Python, allowing them more flexibility in writing extension types that support numeric operations.

Extension types can now set the type flag @code{Py_TPFLAGS_CHECKTYPES} in their
@code{PyTypeObject} structure to indicate that they support the new coercion model.
In such extension types, the numeric slot functions can no longer assume that
they’ll be passed two arguments of the same type; instead they may be passed two
arguments of differing types, and can then perform their own internal coercion.
If the slot function is passed a type it can’t handle, it can indicate the
failure by returning a reference to the @code{Py_NotImplemented} singleton value.
The numeric functions of the other type will then be tried, and perhaps they can
handle the operation; if the other type also returns @code{Py_NotImplemented}, then
a @ref{2c3,,TypeError} will be raised.  Numeric methods written in Python can also
return @code{Py_NotImplemented}, causing the interpreter to act as if the method
did not exist (perhaps raising a @ref{2c3,,TypeError}, perhaps trying another
object’s numeric methods).


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 208

@item PEP 208@footnote{https://peps.python.org/pep-0208/} - Reworking the Coercion Model

Written and implemented by Neil Schemenauer, heavily based upon earlier work by Marc-André Lemburg. Read this to understand the fine points of how numeric operations will now be processed at the C level.
@end table


@c ======================================================================

@node PEP 241 Metadata in Python Packages,Módulos Novos ou Aprimorados<4>,PEP 208 New Coercion Model,What’s New in Python 2 1
@anchor{whatsnew/2 1 pep-241-metadata-in-python-packages}@anchor{156a}
@subsection PEP 241: Metadata in Python Packages


A common complaint from Python users is that there’s no single catalog of all
the Python modules in existence.  T. Middleton’s Vaults of Parnassus at
@code{www.vex.net/parnassus/} (retired in February 2009, available in the Internet Archive Wayback Machine@footnote{https://web.archive.org/web/20090130140102/http://www.vex.net/parnassus/})
was the largest catalog of Python modules, but
registering software at the Vaults is optional, and many people did not bother.

As a first small step toward fixing the problem, Python software packaged using
the Distutils @code{sdist} command will include a file named
@code{PKG-INFO} containing information about the package such as its name,
version, and author (metadata, in cataloguing terminology).  
@geindex Propostas de Melhorias do Python; PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/} contains
the full list of fields that can be present in the @code{PKG-INFO} file.  As
people began to package their software using Python 2.1, more and more packages
will include metadata, making it possible to build automated cataloguing systems
and experiment with them.  With the result experience, perhaps it’ll be possible
to design a really good catalog and then build support for it into Python 2.2.
For example, the Distutils @code{sdist} and @code{bdist_*} commands
could support an @code{upload} option that would automatically upload your
package to a catalog server.

You can start creating packages containing @code{PKG-INFO} even if you’re not
using Python 2.1, since a new release of the Distutils will be made for users of
earlier Python versions.  Version 1.0.2 of the Distutils includes the changes
described in 
@geindex Propostas de Melhorias do Python; PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/}, as well as various bugfixes and enhancements.  It will be
available from the Distutils SIG at @indicateurl{https://www.python.org/community/sigs/current/distutils-sig/}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 241

@item PEP 241@footnote{https://peps.python.org/pep-0241/} - Metadata for Python Software Packages

Written and implemented by A.M. Kuchling.

@geindex Propostas de Melhorias do Python; PEP 243

@item PEP 243@footnote{https://peps.python.org/pep-0243/} - Module Repository Upload Mechanism

Written by Sean Reifschneider, this draft PEP describes a proposed mechanism for uploading Python packages to a central server.
@end table


@c ======================================================================

@node Módulos Novos ou Aprimorados<4>,Outras alterações e correções<4>,PEP 241 Metadata in Python Packages,What’s New in Python 2 1
@anchor{whatsnew/2 1 new-and-improved-modules}@anchor{156b}
@subsection Módulos Novos ou Aprimorados



@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} also includes a Tk-based interactive help browser. @code{pydoc} quickly becomes addictive; try it out!

@item 
Two different modules for unit testing were added to the standard library.
The @ref{3a,,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{37,,difflib} module contains a class, @ref{104f,,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{2d,,curses.panel}, a wrapper for the panel library, part of ncurses and of SYSV curses, was contributed by Thomas Gellekum. The panel library provides windows with the additional feature of depth. Windows can be moved higher or lower in the depth ordering, and the panel library figures out where panels overlap and which sections are visible.

@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 also contributed another hook for handling uncaught exceptions. @ref{80e,,sys.excepthook()} can be set to a callable object. When an exception isn’t caught by any @ref{6e9,,try}…@ref{18b,,except} blocks, the exception will be passed to @ref{80e,,sys.excepthook()}, which can then do whatever it likes. At the Ninth Python Conference, Ping demonstrated an application for this hook: printing an extended traceback that not only lists the stack frames, but also lists the function arguments and the local variables for each frame.

@item 
Various functions in the @ref{ee,,time} module, such as @ref{1227,,asctime()} and
@ref{1541,,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.

This change was proposed and implemented by Thomas Wouters.

@item 
The @ref{5e,,ftplib} module now defaults to retrieving files in passive mode, because passive mode is more likely to work from behind a firewall. This request came from the Debian bug tracking system, since other Debian packages use @ref{5e,,ftplib} to retrieve files and then don’t work from behind a firewall. It’s deemed unlikely that this will cause problems for anyone, because Netscape defaults to passive mode and few people complain, but if passive mode is unsuitable for your application or network setup, call @code{set_pasv(0)} on FTP objects to disable passive mode.

@item 
Support for raw socket access has been added to the @ref{cc,,socket} module,
contributed by Grant Edwards.

@item 
The @ref{b0,,pstats} module now contains a simple interactive statistics browser for displaying timing profiles for Python programs, invoked when the module is run as a script. Contributed by Eric S. Raymond.

@item 
A new implementation-dependent function, @code{sys._getframe([depth])}, has been added to return a given frame object from the current call stack. @ref{6e1,,sys._getframe()} returns the frame at the top of the call stack; if the optional integer argument `depth' is supplied, the function returns the frame that is `depth' calls below the top of the stack. For example, @code{sys._getframe(1)} returns the caller’s frame object.

This function is only present in CPython, not in Jython or the .NET implementation. Use it for debugging, and resist the temptation to put it into production code.
@end itemize

@c ======================================================================

@node Outras alterações e correções<4>,Reconhecimentos<7>,Módulos Novos ou Aprimorados<4>,What’s New in Python 2 1
@anchor{whatsnew/2 1 other-changes-and-fixes}@anchor{156c}
@subsection Outras alterações e correções


There were relatively few smaller changes made in Python 2.1 due to the shorter release cycle. A search through the CVS change logs turns up 117 patches applied, and 136 bugs fixed; both figures are likely to be underestimates. Some of the more notable changes are:


@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{156d,,PyMem_New}, it has to be freed
using @ref{156e,,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.

The object allocator was contributed by 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

For a fuller discussion of the line I/O changes, see the python-dev summary for
January 1–15, 2001 at @indicateurl{https://mail.python.org/pipermail/python-dev/2001-January/}.

@item 
A new method, @ref{156f,,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 
Modules can now control which names are imported when @code{from module import *} is used, by defining an @code{__all__} attribute containing a list of names that will be imported. One common complaint is that if the module imports other modules such as @ref{d9,,sys} or @ref{d3,,string}, @code{from module import *} will add them to the importing module’s namespace. To fix this, simply list the public names in @code{__all__}:

@example
# List public names
__all__ = ['Database', 'open']
@end example

A stricter version of this patch was first suggested and implemented by Ben
Wolfson, but after some python-dev discussion, a weaker final version was
checked in.

@item 
Applying @ref{800,,repr()} to strings previously used octal escapes for non-printable characters; for example, a newline was @code{'\012'}. This was a vestigial trace of Python’s C ancestry, but today octal is of very little practical use. Ka-Ping Yee suggested using hex escapes instead of octal ones, and using the @code{\n}, @code{\t}, @code{\r} escapes for the appropriate characters, and implemented this new formatting.

@item 
Syntax errors detected at compile-time can now raise exceptions containing the
filename and line number of the error, a pleasant side effect of the compiler
reorganization done by Jeremy Hylton.

@item 
C extensions which import other modules have been changed to use
@ref{3be,,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 
The size of the Unicode character database was shrunk by another 340K thanks
to Fredrik Lundh.

@item 
Some new ports were contributed: MacOS X (by Steven Majewski), Cygwin (by Jason Tishler); RISCOS (by Dietmar Schwertberger); Unixware 7 (by Billy G. Allie).
@end itemize

And there’s the usual list of minor bugfixes, minor memory leaks, docstring
edits, and other tweaks, too lengthy to be worth itemizing; see the CVS logs for
the full details if you want them.

@c ======================================================================

@node Reconhecimentos<7>,,Outras alterações e correções<4>,What’s New in Python 2 1
@anchor{whatsnew/2 1 acknowledgements}@anchor{1570}
@subsection Reconhecimentos


The author would like to thank the following people for offering suggestions on
various drafts of this article: Graeme Cross, David Goodger, Jay Graves, Michael
Hudson, Marc-André Lemburg, Fredrik Lundh, Neil Schemenauer, Thomas Wouters.

@node What’s New in Python 2 0,Changelog,What’s New in Python 2 1,O que há de novo no Python
@anchor{whatsnew/2 0 doc}@anchor{1571}@anchor{whatsnew/2 0 translation-repo}@anchor{1572}@anchor{whatsnew/2 0 what-s-new-in-python-2-0}@anchor{1573}
@section What’s New in Python 2.0


@*Autor: 
A.M. Kuchling and Moshe Zadka


@c $Id: whatsnew20.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* Introdução: Introdução<3>. 
* What About Python 1.6?: What About Python 1 6?. 
* New Development Process:: 
* Unicode: Unicode<2>. 
* Compreensões de lista:: 
* Augmented Assignment:: 
* String Methods:: 
* Garbage Collection of Cycles:: 
* Other Core Changes:: 
* Porting to 2.0: Porting to 2 0. 
* Extending/Embedding Changes:: 
* Distutils; Making Modules Easy to Install: Distutils Making Modules Easy to Install. 
* XML Modules:: 
* Module changes:: 
* Novos módulos: Novos módulos<12>. 
* IDLE Improvements:: 
* Deleted and Deprecated Modules:: 
* Reconhecimentos: Reconhecimentos<8>. 

@end menu

@node Introdução<3>,What About Python 1 6?,,What’s New in Python 2 0
@anchor{whatsnew/2 0 introduction}@anchor{1574}
@subsection Introdução


A new release of Python, version 2.0, was released on October 16, 2000. This
article covers the exciting new features in 2.0, highlights some other useful
changes, and points out a few incompatible changes that may require rewriting
code.

Python’s development never completely stops between releases, and a steady flow
of bug fixes and improvements are always being submitted. A host of minor fixes,
a few optimizations, additional docstrings, and better error messages went into
2.0; to list them all would be impossible, but they’re certainly significant.
Consult the publicly available CVS logs if you want to see the full list.  This
progress is due to the five developers working for  PythonLabs are now getting
paid to spend their days fixing bugs, and also due to the improved communication
resulting  from moving to SourceForge.

@c ======================================================================

@node What About Python 1 6?,New Development Process,Introdução<3>,What’s New in Python 2 0
@anchor{whatsnew/2 0 what-about-python-1-6}@anchor{1575}
@subsection What About Python 1.6?


Python 1.6 can be thought of as the Contractual Obligations Python release.
After the core development team left CNRI in May 2000, CNRI requested that a 1.6
release be created, containing all the work on Python that had been performed at
CNRI.  Python 1.6 therefore represents the state of the CVS tree as of May 2000,
with the most significant new feature being Unicode support.  Development
continued after May, of course, so the 1.6 tree received a few fixes to ensure
that it’s forward-compatible with Python 2.0.  1.6 is therefore part of Python’s
evolution, and not a side branch.

So, should you take much interest in Python 1.6?  Probably not.  The 1.6final
and 2.0beta1 releases were made on the same day (September 5, 2000), the plan
being to finalize Python 2.0 within a month or so.  If you have applications to
maintain, there seems little point in breaking things by moving to 1.6, fixing
them, and then having another round of breakage within a month by moving to 2.0;
you’re better off just going straight to 2.0.  Most of the really interesting
features described in this document are only in 2.0, because a lot of work was
done between May and September.

@c ======================================================================

@node New Development Process,Unicode<2>,What About Python 1 6?,What’s New in Python 2 0
@anchor{whatsnew/2 0 new-development-process}@anchor{1576}
@subsection New Development Process


The most important change in Python 2.0 may not be to the code at all, but to
how Python is developed: in May 2000 the Python developers began using the tools
made available by SourceForge for storing  source code, tracking bug reports,
and managing the queue of patch submissions.  To report bugs or submit patches
for Python 2.0, use the bug tracking and patch manager tools available from
Python’s project page, located at @indicateurl{https://sourceforge.net/projects/python/}.

The most important of the services now hosted at SourceForge is the Python CVS
tree, the version-controlled repository containing the source code for Python.
Previously, there were roughly 7 or so people who had write access to the CVS
tree, and all patches had to be inspected and checked in by one of the people on
this short list. Obviously, this wasn’t very scalable.  By moving the CVS tree
to SourceForge, it became possible to grant write access to more people; as of
September 2000 there were 27 people able to check in changes, a fourfold
increase.  This makes possible large-scale changes that wouldn’t be attempted if
they’d have to be filtered through the small group of core developers.  For
example, one day Peter Schneider-Kamp took it into his head to drop K&R C
compatibility and convert the C source for Python to ANSI C. After getting
approval on the python-dev mailing list, he launched into a flurry of checkins
that lasted about a week, other developers joined in to help, and the job was
done.  If there were only 5 people with write access, probably that task would
have been viewed as “nice, but not worth the time and effort needed” and it
would never have gotten done.

The shift to using SourceForge’s services has resulted in a remarkable increase
in the speed of development.  Patches now get submitted, commented on, revised
by people other than the original submitter, and bounced back and forth between
people until the patch is deemed worth checking in.  Bugs are tracked in one
central location and can be assigned to a specific person for fixing, and we can
count the number of open bugs to measure progress.  This didn’t come without a
cost: developers now have more e-mail to deal with, more mailing lists to
follow, and special tools had to be written for the new environment. For
example, SourceForge sends default patch and bug notification e-mail messages
that are completely unhelpful, so Ka-Ping Yee wrote an HTML screen-scraper that
sends more useful messages.

The ease of adding code caused a few initial growing pains, such as code was
checked in before it was ready or without getting clear agreement from the
developer group.  The approval process that has emerged is somewhat similar to
that used by the Apache group. Developers can vote +1, +0, -0, or -1 on a patch;
+1 and -1 denote acceptance or rejection, while +0 and -0 mean the developer is
mostly indifferent to the change, though with a slight positive or negative
slant.  The most significant change from the Apache model is that the voting is
essentially advisory, letting Guido van Rossum, who has Benevolent Dictator For
Life status, know what the general opinion is. He can still ignore the result of
a vote, and approve or reject a change even if the community disagrees with him.

Producing an actual patch is the last step in adding a new feature, and is
usually easy compared to the earlier task of coming up with a good design.
Discussions of new features can often explode into lengthy mailing list threads,
making the discussion hard to follow, and no one can read every posting to
python-dev.  Therefore, a relatively formal process has been set up to write
Python Enhancement Proposals (PEPs), modelled on the internet RFC process.  PEPs
are draft documents that describe a proposed new feature, and are continually
revised until the community reaches a consensus, either accepting or rejecting
the proposal.  Quoting from the introduction to 
@geindex Propostas de Melhorias do Python; PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/}, “PEP Purpose and
Guidelines”:

@quotation

PEP stands for Python Enhancement Proposal.  A PEP is a design document
providing information to the Python community, or describing a new feature for
Python.  The PEP should provide a concise technical specification of the feature
and a rationale for the feature.

We intend PEPs to be the primary mechanisms for proposing new features, for
collecting community input on an issue, and for documenting the design decisions
that have gone into Python.  The PEP author is responsible for building
consensus within the community and documenting dissenting opinions.
@end quotation

Read the rest of 
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; PEP 201
PEP 201@footnote{https://peps.python.org/pep-0201/}, “Lockstep Iteration”, to PEP 225, “Elementwise/Objectwise
Operators”.

@c ======================================================================

@node Unicode<2>,Compreensões de lista,New Development Process,What’s New in Python 2 0
@anchor{whatsnew/2 0 unicode}@anchor{1577}
@subsection Unicode


The largest new feature in Python 2.0 is a new fundamental data type: Unicode
strings.  Unicode uses 16-bit numbers to represent characters instead of the
8-bit number used by ASCII, meaning that 65,536 distinct characters can be
supported.

The final interface for Unicode support was arrived at through countless
often-stormy discussions on the python-dev mailing list, and mostly implemented by
Marc-André Lemburg, based on a Unicode string type implementation by Fredrik
Lundh.  A detailed explanation of the interface was written up as 
@geindex Propostas de Melhorias do Python; PEP 100
PEP 100@footnote{https://peps.python.org/pep-0100/},
“Python Unicode Integration”. This article will simply cover the most
significant points about the Unicode interfaces.

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

Unicode strings, just like regular strings, are an immutable sequence type.
They can be indexed and sliced, but not modified in place. Unicode strings have
an @code{encode( [encoding] )} method that returns an 8-bit string in the desired
encoding.  Encodings are named by strings, such as @code{'ascii'}, @code{'utf-8'},
@code{'iso-8859-1'}, or whatever.  A codec API is defined for implementing and
registering new encodings that are then available throughout a Python program.
If an encoding isn’t specified, the default encoding is usually 7-bit ASCII,
though it can be changed for your Python installation by calling the
@code{sys.setdefaultencoding(encoding)} function in a customized version of
@code{site.py}.

Combining 8-bit and Unicode strings always coerces to Unicode, using the default
ASCII encoding; the result of @code{'a' + u'bc'} is @code{u'abc'}.

New built-in functions have been added, and existing built-ins modified to
support Unicode:


@itemize *

@item 
@code{unichr(ch)} returns a Unicode string 1 character long, containing the
character `ch'.

@item 
@code{ord(u)}, where `u' is a 1-character regular or Unicode string, returns the
number of the character as an integer.

@item 
@code{unicode(string [, encoding]  [, errors] )} creates a Unicode string
from an 8-bit string.  @code{encoding} is a string naming the encoding to use. The
@code{errors} parameter specifies the treatment of characters that are invalid for
the current encoding; passing @code{'strict'} as the value causes an exception to
be raised on any encoding error, while @code{'ignore'} causes errors to be silently
ignored and @code{'replace'} uses U+FFFD, the official replacement character, in
case of any problems.

@item 
The @code{exec} statement, and various built-ins such as @code{eval()},
@code{getattr()}, and @code{setattr()} will also accept Unicode strings as well as
regular strings.  (It’s possible that the process of fixing this missed some
built-ins; if you find a built-in function that accepts strings but doesn’t
accept Unicode strings at all, please report it as a bug.)
@end itemize

A new module, @ref{105,,unicodedata}, provides an interface to Unicode character
properties.  For example, @code{unicodedata.category(u'A')} returns the 2-character
string ‘Lu’, the ‘L’ denoting it’s a letter, and ‘u’ meaning that it’s
uppercase. @code{unicodedata.bidirectional(u'\u0660')} returns ‘AN’, meaning that
U+0660 is an Arabic number.

The @ref{1b,,codecs} module contains functions to look up existing encodings and
register new ones.  Unless you want to implement a new encoding, you’ll most
often use the @code{codecs.lookup(encoding)} function, which returns a
4-element tuple: @code{(encode_func, decode_func, stream_reader, stream_writer)}.


@itemize *

@item 
`encode_func' is a function that takes a Unicode string, and returns a 2-tuple
@code{(string, length)}.  `string' is an 8-bit string containing a portion (perhaps
all) of the Unicode string converted into the given encoding, and `length' tells
you how much of the Unicode string was converted.

@item 
`decode_func' is the opposite of `encode_func', taking an 8-bit string and
returning a 2-tuple @code{(ustring, length)}, consisting of the resulting Unicode
string `ustring' and the integer `length' telling how much of the 8-bit string
was consumed.

@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

For example, the following code writes a Unicode string into a file,  encoding
it as 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

The following code would then read UTF-8 input from the file:

@example
input = UTF8_streamreader( open( '/tmp/output', 'rb') )
print repr(input.read())
input.close()
@end example

Unicode-aware regular expressions are available through the @ref{b9,,re} module,
which has a new underlying implementation called SRE written by Fredrik Lundh of
Secret Labs AB.

A @code{-U} command line option was added which causes the Python compiler to
interpret all string literals as Unicode string literals. This is intended to be
used in testing and future-proofing your Python code, since some future version
of Python may drop support for 8-bit strings and provide only Unicode strings.

@c ======================================================================

@node Compreensões de lista,Augmented Assignment,Unicode<2>,What’s New in Python 2 0
@anchor{whatsnew/2 0 list-comprehensions}@anchor{1578}
@subsection Compreensões de lista


Lists are a workhorse data type in Python, and many programs manipulate a list
at some point.  Two common operations on lists are to loop over them, and either
pick out the elements that meet a certain criterion, or apply some function to
each element.  For example, given a list of strings, you might want to pull out
all the strings containing a given substring, or strip off trailing whitespace
from each line.

The existing @ref{867,,map()} and @ref{868,,filter()} functions can be used for this
purpose, but they require a function as one of their arguments.  This is fine if
there’s an existing built-in function that can be passed directly, but if there
isn’t, you have to create a little function to do the required work, and
Python’s scoping rules make the result ugly if the little function needs
additional information.  Take the first example in the previous paragraph,
finding all the strings in the list containing a given substring.  You could
write the following to do it:

@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

Because of Python’s scoping rules, a default argument is used so that the
anonymous function created by the @ref{12df,,lambda} expression knows what
substring is being searched for.  List comprehensions make this cleaner:

@example
sublist = [ s for s in L if string.find(s, S) != -1 ]
@end example

List comprehensions have the form:

@example
[ expression for expr in sequence1
             for expr2 in sequence2 ...
             for exprN in sequenceN
             if condition ]
@end example

The @code{for}…@code{in} clauses contain the sequences to be
iterated over.  The sequences do not have to be the same length, because they
are `not' iterated over in parallel, but from left to right; this is explained
more clearly in the following paragraphs.  The elements of the generated list
will be the successive values of `expression'.  The final @code{if} clause
is optional; if present, `expression' is only evaluated and added to the result
if `condition' is true.

To make the semantics very clear, a list comprehension is equivalent to the
following Python code:

@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

This means that when there are multiple @code{for}…@code{in}
clauses, the resulting list will be equal to the product of the lengths of all
the sequences.  If you have two lists of length 3, the output list is 9 elements
long:

@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

To avoid introducing an ambiguity into Python’s grammar, if `expression' is
creating a tuple, it must be surrounded with parentheses.  The first list
comprehension below is a syntax error, while the second one is correct:

@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

The idea of list comprehensions originally comes from the functional programming
language Haskell (@indicateurl{https://www.haskell.org}).  Greg Ewing argued most effectively
for adding them to Python and wrote the initial list comprehension patch, which
was then discussed for a seemingly endless time on the python-dev mailing list
and kept up-to-date by Skip Montanaro.

@c ======================================================================

@node Augmented Assignment,String Methods,Compreensões de lista,What’s New in Python 2 0
@anchor{whatsnew/2 0 augmented-assignment}@anchor{1579}
@subsection Augmented Assignment


Augmented assignment operators, another long-requested feature, have been added
to Python 2.0.  Augmented assignment operators include @code{+=}, @code{-=}, @code{*=},
and so forth.  For example, the statement @code{a += 2} increments the value of the
variable  @code{a} by 2, equivalent to the slightly lengthier @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.

Augmented assignment operators were first introduced in the C programming
language, and most C-derived languages, such as @code{awk}, C++, Java, Perl,
and PHP also support them.  The augmented assignment patch was implemented by
Thomas Wouters.

@c ======================================================================

@node String Methods,Garbage Collection of Cycles,Augmented Assignment,What’s New in Python 2 0
@anchor{whatsnew/2 0 string-methods}@anchor{157a}
@subsection String Methods


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.

Instead, Python 2.0 pushes the problem onto the string type, making string
manipulation functionality available through methods on both 8-bit strings and
Unicode strings.

@example
>>> 'andrew'.capitalize()
'Andrew'
>>> 'hostname'.replace('os', 'linux')
'hlinuxtname'
>>> 'moshe'.find('sh')
2
@end example

One thing that hasn’t changed, a noteworthy April Fools’ joke notwithstanding,
is that Python strings are immutable. Thus, the string methods return new
strings, and do not modify the string on which they operate.

The old @ref{d3,,string} module is still around for backwards compatibility, but it
mostly acts as a front-end to the new string methods.

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 Garbage Collection of Cycles,Other Core Changes,String Methods,What’s New in Python 2 0
@anchor{whatsnew/2 0 garbage-collection-of-cycles}@anchor{157b}
@subsection Garbage Collection of Cycles


The C implementation of Python uses reference counting to implement garbage
collection.  Every Python object maintains a count of the number of references
pointing to itself, and adjusts the count as references are created or
destroyed.  Once the reference count reaches zero, the object is no longer
accessible, since you need to have a reference to an object to access it, and if
the count is zero, no references exist any longer.

Reference counting has some pleasant properties: it’s easy to understand and
implement, and the resulting implementation is portable, fairly fast, and reacts
well with other libraries that implement their own memory handling schemes.  The
major problem with reference counting is that it sometimes doesn’t realise that
objects are no longer accessible, resulting in a memory leak.  This happens when
there are cycles of references.

Consider the simplest possible cycle,  a class instance which has a reference to
itself:

@example
instance = SomeClass()
instance.myself = instance
@end example

After the above two lines of code have been executed, the reference count of
@code{instance} is 2; one reference is from the variable named @code{'instance'}, and
the other is from the @code{myself} attribute of the instance.

If the next line of code is @code{del instance}, what happens?  The reference count
of @code{instance} is decreased by 1, so it has a reference count of 1; the
reference in the @code{myself} attribute still exists.  Yet the instance is no
longer accessible through Python code, and it could be deleted.  Several objects
can participate in a cycle if they have references to each other, causing all of
the objects to be leaked.

Python 2.0 fixes this problem by periodically executing a cycle detection
algorithm which looks for inaccessible cycles and deletes the objects involved.
A new @ref{60,,gc} module provides functions to perform a garbage collection,
obtain debugging statistics, and tuning the collector’s parameters.

Running the cycle detection algorithm takes some time, and therefore will result
in some additional overhead.  It is hoped that after we’ve gotten experience
with the cycle collection from using 2.0, Python 2.1 will be able to minimize
the overhead with careful tuning.  It’s not yet obvious how much performance is
lost, because benchmarking this is tricky and depends crucially on how often the
program creates and destroys objects.  The detection of cycles can be disabled
when Python is compiled, if you can’t afford even a tiny speed penalty or
suspect that the cycle collection is buggy, by specifying the
@code{--without-cycle-gc} switch when running the @code{configure}
script.

Several people tackled this problem and contributed to a solution.  An early
implementation of the cycle detection approach was written by Toby Kelsey.  The
current algorithm was suggested by Eric Tiedemann during a visit to CNRI, and
Guido van Rossum and Neil Schemenauer wrote two different implementations, which
were later integrated by Neil.  Lots of other people offered suggestions along
the way; the March 2000 archives of the python-dev mailing list contain most of
the relevant discussion, especially in the threads titled “Reference cycle
collection for Python” and “Finalization again”.

@c ======================================================================

@node Other Core Changes,Porting to 2 0,Garbage Collection of Cycles,What’s New in Python 2 0
@anchor{whatsnew/2 0 other-core-changes}@anchor{157c}
@subsection Other Core Changes


Various minor changes have been made to Python’s syntax and built-in functions.
None of the changes are very far-reaching, but they’re handy conveniences.

@menu
* Minor Language Changes:: 
* Changes to Built-in Functions:: 

@end menu

@node Minor Language Changes,Changes to Built-in Functions,,Other Core Changes
@anchor{whatsnew/2 0 minor-language-changes}@anchor{157d}
@subsubsection Minor Language Changes


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

Modules can now be renamed on importing them, using the syntax @code{import module
as name} or @code{from module import name as othername}.  The patch was submitted
by Thomas Wouters.

A new format style is available when using the @code{%} operator; ‘%r’ will insert
the @ref{800,,repr()} of its argument.  This was also added from symmetry
considerations, this time for symmetry with the existing ‘%s’ format style,
which inserts the @ref{44c,,str()} of its argument.  For example, @code{'%r %s' % ('abc',
'abc')} returns a string containing @code{'abc' abc}.

Previously there was no way to implement a class that overrode Python’s built-in
@ref{2f4,,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{157e,,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.

Earlier versions of Python used a recursive algorithm for deleting objects.
Deeply nested data structures could cause the interpreter to fill up the C stack
and crash; Christian Tismer rewrote the deletion logic to fix this problem.  On
a related note, comparing recursive objects recursed infinitely and crashed;
Jeremy Hylton rewrote the code to no longer crash, producing a useful result
instead.  For example, after this code:

@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

Work has been done on porting Python to 64-bit Windows on the Itanium processor,
mostly by Trent Mick of ActiveState.  (Confusingly, @code{sys.platform} is still
@code{'win32'} on Win64 because it seems that for ease of porting, MS Visual C++
treats code as 32 bit on Itanium.) PythonWin also supports Windows CE; see the
Python CE page at @indicateurl{https://pythonce.sourceforge.net/} for more information.

Another new platform is Darwin/MacOS X; initial support for it is in Python 2.0.
Dynamic loading works, if you specify “configure –with-dyld –with-suffix=.x”.
Consult the README in the Python source distribution for more instructions.

An attempt has been made to alleviate one of Python’s warts, the often-confusing
@ref{43f,,NameError} exception when code refers to a local variable before the
variable has been assigned a value.  For example, the following code raises an
exception on the @code{print} statement in both 1.5.2 and 2.0; in 1.5.2 a
@ref{43f,,NameError} exception is raised, while 2.0 raises a new
@ref{157f,,UnboundLocalError} exception. @ref{157f,,UnboundLocalError} is a subclass of
@ref{43f,,NameError}, so any existing code that expects @ref{43f,,NameError} to be
raised should still work.

@example
def f():
    print "i=",i
    i = i + 1
f()
@end example

Two new exceptions, @ref{543,,TabError} and @ref{7a9,,IndentationError}, have been
introduced.  They’re both subclasses of @ref{18d,,SyntaxError}, and are raised when
Python code is found to be improperly indented.

@node Changes to Built-in Functions,,Minor Language Changes,Other Core Changes
@anchor{whatsnew/2 0 changes-to-built-in-functions}@anchor{1580}
@subsubsection Changes to Built-in Functions


A new built-in, @code{zip(seq1, seq2, ...)}, has been added.  @ref{7d1,,zip()}
returns a list of tuples where each tuple contains the i-th element from each of
the argument sequences.  The difference between @ref{7d1,,zip()} and @code{map(None,
seq1, seq2)} is that @ref{867,,map()} pads the sequences with @code{None} if the
sequences aren’t all of the same length, while @ref{7d1,,zip()} truncates the
returned list to the length of the shortest argument sequence.

The @ref{257,,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{2c3,,TypeError} exception with the message “can’t convert non-string with
explicit base”.

A new variable holding more detailed version information has been added to the
@ref{d9,,sys} module.  @code{sys.version_info} is a tuple @code{(major, minor, micro,
level, serial)} For example, in a hypothetical 2.0.1beta1, @code{sys.version_info}
would be @code{(2, 0, 1, 'beta', 1)}. `level' is a string such as @code{"alpha"},
@code{"beta"}, or @code{"final"} for a final release.

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

can be reduced to a single @code{return dict.setdefault(key, [])} statement.

The interpreter sets a maximum recursion depth in order to catch runaway
recursion before filling the C stack and causing a core dump or GPF..
Previously this limit was fixed when you compiled Python, but in 2.0 the maximum
recursion depth can be read and modified using @ref{4c4,,sys.getrecursionlimit()} and
@ref{4c3,,sys.setrecursionlimit()}. The default value is 1000, and a rough maximum
value for a given platform can be found by running a new script,
@code{Misc/find_recursionlimit.py}.

@c ======================================================================

@node Porting to 2 0,Extending/Embedding Changes,Other Core Changes,What’s New in Python 2 0
@anchor{whatsnew/2 0 porting-to-2-0}@anchor{1581}
@subsection Porting to 2.0


New Python releases try hard to be compatible with previous releases, and the
record has been pretty good.  However, some changes are considered useful
enough, usually because they fix initial design decisions that turned out to be
actively mistaken, that breaking backward compatibility can’t always be avoided.
This section lists the changes in Python 2.0 that may cause old Python code to
break.

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
@ref{6cd,,append()} and @ref{11d7,,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{2c3,,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{571,,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{1582,,socket.connect_ex} and @ref{1583,,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.

The @code{\x} escape in string literals now takes exactly 2 hex digits.  Previously
it would consume all the hex digits following the ‘x’ and take the lowest 8 bits
of the result, so @code{\x123456} was equivalent to @code{\x56}.

The @ref{34b,,AttributeError} and @ref{43f,,NameError} exceptions have a more friendly
error message, whose text will be something like @code{'Spam' instance has no
attribute 'eggs'} or @code{name 'eggs' is not defined}.  Previously the error
message was just the missing attribute name @code{eggs}, and code written to take
advantage of this fact will break in 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{2c3,,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}.

The subtlest long integer change of all is that the @ref{44c,,str()} of a long
integer no longer has a trailing ‘L’ character, though @ref{800,,repr()} still
includes it.  The ‘L’ annoyed many people who wanted to print long integers that
looked just like regular integers, since they had to go out of their way to chop
off the character.  This is no longer a problem in 2.0, but code which does
@code{str(longval)[:-1]} and assumes the ‘L’ is there, will now lose the final
digit.

Taking the @ref{800,,repr()} of a float now uses a different formatting precision
than @ref{44c,,str()}.  @ref{800,,repr()} uses @code{%.17g} format string for C’s
@code{sprintf()}, while @ref{44c,,str()} uses @code{%.12g} as before.  The effect is that
@ref{800,,repr()} may occasionally show more decimal places than  @ref{44c,,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 Extending/Embedding Changes,Distutils Making Modules Easy to Install,Porting to 2 0,What’s New in Python 2 0
@anchor{whatsnew/2 0 extending-embedding-changes}@anchor{1584}
@subsection Extending/Embedding Changes


Some of the changes are under the covers, and will only be apparent to people
writing C extension modules or embedding a Python interpreter in a larger
application.  If you aren’t dealing with Python’s C API, you can safely skip
this section.

The version number of the Python C API was incremented, so C extensions compiled
for 1.5.2 must be recompiled in order to work with 2.0.  On Windows, it’s not
possible for Python 2.0 to import a third party extension built for Python 1.5.x
due to how Windows DLLs work, so Python will raise an exception and the import
will fail.

Users of Jim Fulton’s ExtensionClass module will be pleased to find out that
hooks have been added so that ExtensionClasses are now supported by
@ref{442,,isinstance()} and @ref{7c2,,issubclass()}. This means you no longer have to
remember to write code such as @code{if type(obj) == myExtensionClass}, but can use
the more natural @code{if isinstance(obj, myExtensionClass)}.

The @code{Python/importdl.c} file, which was a mass of #ifdefs to support
dynamic loading on many different platforms, was cleaned up and reorganised by
Greg Stein.  @code{importdl.c} is now quite small, and platform-specific code
has been moved into a bunch of @code{Python/dynload_*.c} files.  Another
cleanup: there were also a number of @code{my*.h} files in the Include/
directory that held various portability hacks; they’ve been merged into a single
file, @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.

Recent versions of the GUSI development environment for MacOS support POSIX
threads.  Therefore, Python’s POSIX threading support now works on the
Macintosh.  Threading support using the user-space GNU @code{pth} library was also
contributed.

Threading support on Windows was enhanced, too.  Windows supports thread locks
that use kernel objects only in case of contention; in the common case when
there’s no contention, they use simpler functions which are an order of
magnitude faster.  A threaded version of Python 1.5.2 on NT is twice as slow as
an unthreaded version; with the 2.0 changes, the difference is only 10%.  These
improvements were contributed by Yakov Markovitch.

Python 2.0’s source now uses only ANSI C prototypes, so compiling Python now
requires an ANSI C compiler, and can no longer be done using a compiler that
only supports K&R C.

Previously the Python virtual machine used 16-bit numbers in its bytecode,
limiting the size of source files.  In particular, this affected the maximum
size of literal lists and dictionaries in Python source; occasionally people who
are generating Python code would run into this limit.  A patch by Charles G.
Waldman raises the limit from @code{2**16} to @code{2**32}.

Three new convenience functions intended for adding constants to a module’s
dictionary at module initialization time were added: @ref{366,,PyModule_AddObject()},
@ref{1585,,PyModule_AddIntConstant()}, and @ref{1586,,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{1587,,PyOS_getsig()} gets
a signal handler and @ref{1588,,PyOS_setsig()} will set a new handler.

@c ======================================================================

@node Distutils Making Modules Easy to Install,XML Modules,Extending/Embedding Changes,What’s New in Python 2 0
@anchor{whatsnew/2 0 distutils-making-modules-easy-to-install}@anchor{1589}
@subsection Distutils: Making Modules Easy to Install


Before Python 2.0, installing modules was a tedious affair – there was no way
to figure out automatically where Python is installed, or what compiler options
to use for extension modules.  Software authors had to go through an arduous
ritual of editing Makefiles and configuration files, which only really work on
Unix and leave Windows and MacOS unsupported.  Python users faced wildly
differing installation instructions which varied between different extension
packages, which made administering a Python installation something of  a chore.

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.

In order to use the Distutils, you need to write a @code{setup.py} script.  For
the simple case, when the software contains only .py files, a minimal
@code{setup.py} can be just a few lines long:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       py_modules = ["module1", "module2"])
@end example

The @code{setup.py} file isn’t much more complicated if the software consists
of a few packages:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       packages = ["package", "package.subpackage"])
@end example

A C extension can be the most complicated case; here’s an example taken from
the PyXML package:

@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

The Distutils can also take care of creating source and binary distributions.
The “sdist” command, run by “@code{python setup.py sdist}’, builds a source
distribution such as @code{foo-1.0.tar.gz}. Adding new commands isn’t
difficult, “bdist_rpm” and “bdist_wininst” commands have already been
contributed to create an RPM distribution and a Windows installer for the
software, respectively.  Commands to create other distribution formats such as
Debian packages and Solaris @code{.pkg} files are in various stages of
development.

All this is documented in a new manual, `Distributing Python Modules', that
joins the basic set of Python documentation.

@c ======================================================================

@node XML Modules,Module changes,Distutils Making Modules Easy to Install,What’s New in Python 2 0
@anchor{whatsnew/2 0 xml-modules}@anchor{158a}
@subsection XML Modules


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
* SAX2 Support:: 
* DOM Support:: 
* Relationship to PyXML:: 

@end menu

@node SAX2 Support,DOM Support,,XML Modules
@anchor{whatsnew/2 0 sax2-support}@anchor{158b}
@subsubsection SAX2 Support


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{158c,,startElement()} and @ref{158d,,endElement()}
methods are called for every starting and end tag encountered by the parser, the
@ref{158e,,characters()} method is called for every chunk of character data, and so
forth.

The advantage of the event-driven approach is that the whole document doesn’t
have to be resident in memory at any one time, which matters if you are
processing really huge documents.  However, writing the SAX handler class can
get very complicated if you’re trying to modify the document structure in some
elaborate way.

For example, this little example program defines a handler that prints a message
for every starting and ending tag, and then parses the file @code{hamlet.xml}
using it:

@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 DOM Support,Relationship to PyXML,SAX2 Support,XML Modules
@anchor{whatsnew/2 0 dom-support}@anchor{158f}
@subsubsection DOM Support


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.

The DOM is useful for modifying XML documents, because you can create a DOM
tree, modify it by adding new nodes or rearranging subtrees, and then produce a
new XML document as output.  You can also construct a DOM tree manually and
convert it to XML, which can be a more flexible way of producing XML output than
simply writing @code{<tag1>}…@code{</tag1>} to a file.

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

For the `Hamlet' XML file, the above few lines output:

@example
<PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
<PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>
@end example

The root element of the document is available as @code{doc.documentElement}, and
its children can be easily modified by deleting, adding, or removing nodes:

@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 Relationship to PyXML,,DOM Support,XML Modules
@anchor{whatsnew/2 0 relationship-to-pyxml}@anchor{1590}
@subsubsection Relationship to PyXML


The XML Special Interest Group has been working on XML-related Python code for a
while.  Its code distribution, called PyXML, is available from the SIG’s web
pages at @indicateurl{https://www.python.org/community/sigs/current/xml-sig}. The PyXML distribution also used
the package name @code{xml}.  If you’ve written programs that used PyXML, you’re
probably wondering about its compatibility with the 2.0 @ref{120,,xml} package.

The answer is that Python 2.0’s @ref{120,,xml} package isn’t compatible with PyXML,
but can be made compatible by installing a recent version PyXML.  Many
applications can get by with the XML support that is included with Python 2.0,
but more complicated applications will require that the full PyXML package will
be installed.  When installed, PyXML versions 0.6.0 or greater will replace the
@ref{120,,xml} package shipped with Python, and will be a strict superset of the
standard package, adding a bunch of additional features.  Some of the additional
features in PyXML include:


@itemize *

@item 
4DOM, a full DOM implementation from FourThought, Inc.

@item 
The xmlproc validating parser, written by Lars Marius Garshol.

@item 
The @code{sgmlop} parser accelerator module, written by Fredrik Lundh.
@end itemize

@c ======================================================================

@node Module changes,Novos módulos<12>,XML Modules,What’s New in Python 2 0
@anchor{whatsnew/2 0 module-changes}@anchor{1591}
@subsection Module changes


Lots of improvements and bugfixes were made to Python’s extensive standard
library; some of the affected modules include @ref{ba,,readline},
@ref{22,,ConfigParser}, @code{cgi}, @ref{14,,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.

The @ref{2b,,curses} module has been greatly extended, starting from Oliver
Andrich’s enhanced version, to provide many additional functions from ncurses
and SYSV curses, such as colour, alternative character set support, pads, and
mouse support.  This means the module is no longer compatible with operating
systems that only have BSD curses, but there don’t seem to be any currently
maintained OSes that fall into this category.

As mentioned in the earlier discussion of 2.0’s Unicode support, the underlying
implementation of the regular expressions provided by the @ref{b9,,re} module has
been changed.  SRE, a new regular expression engine written by Fredrik Lundh and
partially funded by Hewlett Packard, supports matching against both 8-bit
strings and Unicode strings.

@c ======================================================================

@node Novos módulos<12>,IDLE Improvements,Module changes,What’s New in Python 2 0
@anchor{whatsnew/2 0 new-modules}@anchor{1592}
@subsection Novos módulos


A number of new modules were added.  We’ll simply list them with brief
descriptions; consult the 2.0 documentation for the details of a particular
module.


@itemize *

@item 
@ref{c,,atexit}:  For registering functions to be called before the Python
interpreter exits. Code that currently sets @code{sys.exitfunc} directly should be
changed to  use the @ref{c,,atexit} module instead, importing @ref{c,,atexit} and
calling @ref{882,,atexit.register()} with  the function to be called on exit.
(Contributed by Skip Montanaro.)

@item 
@ref{1b,,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}: This module provides internationalization (I18N) and
localization (L10N) support for Python programs by providing an interface to the
GNU gettext message catalog library. (Integrated by Barry Warsaw, from separate
contributions by Martin  von Löwis, Peter Funk, and 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}: An interface to memory-mapped files on both Windows and Unix.  A
file’s contents can be mapped directly into memory, at which point it behaves
like a mutable string, so its contents can be read and modified.  They can even
be passed to functions that expect ordinary strings, such as the @ref{b9,,re}
module. (Contributed by Sam Rushing, with some extensions by 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}: A module/script to  check Python source code for ambiguous
indentation. (Contributed by Tim Peters.)

@item 
@code{UserString}: A base class useful for deriving objects that behave like
strings.

@item 
@ref{115,,webbrowser}: A module that provides a platform independent way to launch
a web browser on a specific URL. For each platform, various browsers are tried
in a specific order. The user can alter which browser is launched by setting the
`BROWSER' environment variable.  (Originally inspired by Eric S. Raymond’s patch
to @ref{108,,urllib} which added similar functionality, but the final module comes
from code originally  implemented by Fred Drake as
@code{Tools/idle/BrowserControl.py}, and adapted for the standard library by
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{131,,zipfile}: A module for reading and writing ZIP-format archives.  These
are archives produced by @code{PKZIP} on DOS/Windows or @code{zip} on
Unix, not to be confused with @code{gzip}-format files (which are
supported by the @ref{67,,gzip} module) (Contributed by 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 IDLE Improvements,Deleted and Deprecated Modules,Novos módulos<12>,What’s New in Python 2 0
@anchor{whatsnew/2 0 idle-improvements}@anchor{1593}
@subsection IDLE Improvements


IDLE is the official Python cross-platform IDE, written using Tkinter. Python
2.0 includes IDLE 0.6, which adds a number of new features and improvements.  A
partial list:


@itemize *

@item 
UI improvements and optimizations, especially in the area of syntax
highlighting and auto-indentation.

@item 
The class browser now shows more information, such as the top level functions
in a module.

@item 
Tab width is now a user settable option. When opening an existing Python file,
IDLE automatically detects the indentation conventions, and adapts.

@item 
There is now support for calling browsers on various platforms, used to open
the Python documentation in a browser.

@item 
IDLE now has a command line, which is largely similar to  the vanilla Python
interpreter.

@item 
Call tips were added in many places.

@item 
IDLE can now be installed as a package.

@item 
In the editor window, there is now a line/column bar at the bottom.

@item 
Three new keystroke commands: Check module (@code{Alt}-@code{F5}), Import module (@code{F5}) and
Run script (@code{Ctrl}-@code{F5}).
@end itemize

@c ======================================================================

@node Deleted and Deprecated Modules,Reconhecimentos<8>,IDLE Improvements,What’s New in Python 2 0
@anchor{whatsnew/2 0 deleted-and-deprecated-modules}@anchor{1594}
@subsection Deleted and Deprecated Modules


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 Reconhecimentos<8>,,Deleted and Deprecated Modules,What’s New in Python 2 0
@anchor{whatsnew/2 0 acknowledgements}@anchor{1595}
@subsection Reconhecimentos


The authors would like to thank the following people for offering suggestions on
various drafts of this article: 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, and Russ Schmidt.

O “Changelog” é uma versão HTML do arquivo construído@footnote{https://pypi.org/project/blurb/} do conteúdo da árvore de diretórios Misc/NEWS.d@footnote{https://github.com/python/cpython/tree/3.13/Misc/NEWS.d}, que contém `todas' as mudanças não triviais do Python para a versão atual.

@node Changelog,,What’s New in Python 2 0,O que há de novo no Python
@anchor{whatsnew/changelog doc}@anchor{1596}@anchor{whatsnew/changelog changelog}@anchor{13c}@anchor{whatsnew/changelog id1}@anchor{1597}@anchor{whatsnew/changelog translation-repo}@anchor{1598}
@section Changelog


@menu
* Python seguinte:: 
* Python 3.13.11 final: Python 3 13 11 final. 
* Python 3.13.10 final: Python 3 13 10 final. 
* Python 3.13.9 final: Python 3 13 9 final. 
* Python 3.13.8 final: Python 3 13 8 final. 
* Python 3.13.7 final: Python 3 13 7 final. 
* Python 3.13.6 final: Python 3 13 6 final. 
* Python 3.13.5 final: Python 3 13 5 final. 
* Python 3.13.4 final: Python 3 13 4 final. 
* Python 3.13.3 final: Python 3 13 3 final. 
* Python 3.13.2 final: Python 3 13 2 final. 
* Python 3.13.1 final: Python 3 13 1 final. 
* Python 3.13.0 final: Python 3 13 0 final. 
* Python 3.13.0 release candidate 3: Python 3 13 0 release candidate 3. 
* Python 3.13.0 release candidate 2: Python 3 13 0 release candidate 2. 
* Python 3.13.0 release candidate 1: Python 3 13 0 release candidate 1. 
* Python 3.13.0 beta 4: Python 3 13 0 beta 4. 
* Python 3.13.0 beta 3: Python 3 13 0 beta 3. 
* Python 3.13.0 beta 2: Python 3 13 0 beta 2. 
* 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 seguinte,Python 3 13 11 final,,Changelog
@anchor{whatsnew/changelog python-next}@anchor{1599}
@subsection Python seguinte


`Data de lançamento: XXXX-XX-XX'

@menu
* Windows:: 
* Ferramentas/Demos:: 
* Testes:: 
* Segurança:: 
* Biblioteca:: 
* IDLE: IDLE<3>. 
* Núcleo e embutidos:: 
* API C:: 
* Construção:: 

@end menu

@node Windows,Ferramentas/Demos,,Python seguinte
@anchor{whatsnew/changelog windows}@anchor{159a}
@subsubsection Windows



@itemize -

@item 
gh-128067@footnote{https://github.com/python/cpython/issues/128067}: Fix a bug in PyREPL on Windows where output without a trailing
newline was overwritten by the next prompt.
@end itemize

@node Ferramentas/Demos,Testes,Windows,Python seguinte
@anchor{whatsnew/changelog tools-demos}@anchor{159b}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-142095@footnote{https://github.com/python/cpython/issues/142095}: Make gdb ‘py-bt’ command use frame from thread local state when
available. Patch by Sam Gross and Victor Stinner.
@end itemize

@node Testes,Segurança,Ferramentas/Demos,Python seguinte
@anchor{whatsnew/changelog tests}@anchor{159c}
@subsubsection Testes



@itemize -

@item 
gh-65784@footnote{https://github.com/python/cpython/issues/65784}: Add support for parametrized resource @code{wantobjects} in
regrtests, which allows to run Tkinter tests with the specified value of
@code{tkinter.wantobjects}, for example @code{-u wantobjects=0}.

@item 
gh-143553@footnote{https://github.com/python/cpython/issues/143553}: Add support for parametrized resources, such as @code{-u
xpickle=2.7}.

@item 
gh-142836@footnote{https://github.com/python/cpython/issues/142836}: Accommodated Solaris in
@code{test_pdb.test_script_target_anonymous_pipe}.

@item 
bpo-31391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31391}: Forward-port test_xpickle from Python 2 to Python 3 and add the
resource back to test’s command line.
@end itemize

@node Segurança,Biblioteca,Testes,Python seguinte
@anchor{whatsnew/changelog security}@anchor{159d}
@subsubsection Segurança



@itemize -

@item 
gh-144125@footnote{https://github.com/python/cpython/issues/144125}: @ref{120f,,BytesGenerator} will now refuse to
serialize (write) headers that are unsafely folded or delimited; see
@ref{1e0,,verify_generated_headers}. (Contributed by Bas
Bloemsaat and Petr Viktorin in gh-121650@footnote{https://github.com/python/cpython/issues/121650}).

@item 
gh-143935@footnote{https://github.com/python/cpython/issues/143935}: Fixed a bug in the folding of comments when flattening an email
message using a modern email policy. Comments consisting of a very long
sequence of non-foldable characters could trigger a forced line wrap that
omitted the required leading space on the continuation line, causing the
remainder of the comment to be interpreted as a new header field. This
enabled header injection with carefully crafted inputs.

@item 
gh-143925@footnote{https://github.com/python/cpython/issues/143925}: Reject control characters in @code{data:} URL media types.

@item 
gh-143919@footnote{https://github.com/python/cpython/issues/143919}: Reject control characters in @ref{c1e,,http.cookies.Morsel}
fields and values.

@item 
gh-143916@footnote{https://github.com/python/cpython/issues/143916}: Reject C0 control characters within wsgiref.headers.Headers
fields, values, and parameters.
@end itemize

@node Biblioteca,IDLE<3>,Segurança,Python seguinte
@anchor{whatsnew/changelog library}@anchor{159e}
@subsubsection Biblioteca



@itemize -

@item 
gh-144169@footnote{https://github.com/python/cpython/issues/144169}: Fix three crashes when non-string keyword arguments are
supplied to objects in the @ref{8,,ast} module.

@item 
gh-144100@footnote{https://github.com/python/cpython/issues/144100}: Fixed a crash in ctypes when using a deprecated
@code{POINTER(str)} type in @code{argtypes}. Instead of aborting, ctypes now
raises a proper Python exception when the pointer target type is
unresolved.

@item 
gh-144050@footnote{https://github.com/python/cpython/issues/144050}: Fix @ref{118a,,stat.filemode()} in the pure-Python implementation to
avoid misclassifying invalid mode values as block devices.

@item 
gh-144023@footnote{https://github.com/python/cpython/issues/144023}: Fixed validation of file descriptor 0 in posix functions when
used with follow_symlinks parameter.

@item 
gh-143999@footnote{https://github.com/python/cpython/issues/143999}: Fix an issue where @ref{1277,,inspect.getgeneratorstate()} and
@ref{e45,,inspect.getcoroutinestate()} could fail for generators wrapped by
@ref{eb7,,types.coroutine()} in the suspended state.

@item 
gh-143706@footnote{https://github.com/python/cpython/issues/143706}: Fix @ref{94,,multiprocessing} forkserver so that @ref{12a6,,sys.argv}
is correctly set before @code{__main__} is preloaded. Previously,
@ref{12a6,,sys.argv} was empty during main module import in forkserver child
processes. This fixes a regression introduced in 3.13.8 and 3.14.1. Root
caused by Aaron Wieczorek, test provided by Thomas Watson, thanks!

@item 
gh-143638@footnote{https://github.com/python/cpython/issues/143638}: Forbid reentrant calls of the @ref{a28,,pickle.Pickler} and
@ref{159f,,pickle.Unpickler} methods for the C implementation. Previously,
this could cause crash or data corruption, now concurrent calls of methods
of the same object raise @ref{195,,RuntimeError}.

@item 
gh-78724@footnote{https://github.com/python/cpython/issues/78724}: Raise @ref{195,,RuntimeError}’s when user attempts to call methods
on half-initialized @ref{15a0,,Struct} objects, For example, created
by @code{Struct.__new__(Struct)}.  Patch by Sergey B Kirpichev.

@item 
gh-143602@footnote{https://github.com/python/cpython/issues/143602}: Fix a inconsistency issue in @ref{13f2,,write()} that
leads to unexpected buffer overwrite by deduplicating the buffer exports.

@item 
gh-143547@footnote{https://github.com/python/cpython/issues/143547}: Fix @ref{1f7,,sys.unraisablehook()} when the hook raises an
exception and changes @ref{1f7,,sys.unraisablehook()}: hold a strong reference
to the old hook. Patch by Victor Stinner.

@item 
gh-143378@footnote{https://github.com/python/cpython/issues/143378}: Fix use-after-free crashes when a @ref{ed3,,BytesIO} object
is concurrently mutated during @ref{13f2,,write()} or
@ref{15a1,,writelines()}.

@item 
gh-143346@footnote{https://github.com/python/cpython/issues/143346}: Fix incorrect wrapping of the Base64 data in
@code{plistlib._PlistWriter} when the indent contains a mix of tabs and
spaces.

@item 
gh-143310@footnote{https://github.com/python/cpython/issues/143310}: @ref{f0,,tkinter}: fix a crash when a Python @ref{611,,list} is
mutated during the conversion to a Tcl object (e.g., when setting a Tcl
variable). Patch by Bénédikt Tran.

@item 
gh-143309@footnote{https://github.com/python/cpython/issues/143309}: Fix a crash in @ref{1138,,os.execve()} on non-Windows platforms when
given a custom environment mapping which is then mutated during parsing.
Patch by Bénédikt Tran.

@item 
gh-143308@footnote{https://github.com/python/cpython/issues/143308}: @ref{a6,,pickle}: fix use-after-free crashes when a
@ref{15a2,,PickleBuffer} is concurrently mutated by a custom buffer
callback during pickling. Patch by Bénédikt Tran and Aaron Wieczorek.

@item 
gh-143237@footnote{https://github.com/python/cpython/issues/143237}: Fix support of named pipes in the rotating @ref{87,,logging}
handlers.

@item 
gh-143249@footnote{https://github.com/python/cpython/issues/143249}: Fix possible buffer leaks in Windows overlapped I/O on error
handling.

@item 
gh-143241@footnote{https://github.com/python/cpython/issues/143241}: @ref{134,,zoneinfo}: fix infinite loop in @ref{15a3,,ZoneInfo.from_file} when parsing a malformed TZif file. Patch
by Fatih Celik.

@item 
gh-142830@footnote{https://github.com/python/cpython/issues/142830}: @ref{cf,,sqlite3}: fix use-after-free crashes when the
connection’s callbacks are mutated during a callback execution. Patch by
Bénédikt Tran.

@item 
gh-143200@footnote{https://github.com/python/cpython/issues/143200}: @ref{125,,xml.etree.ElementTree}: fix use-after-free crashes in
@ref{283,,__getitem__()} and @ref{130e,,__setitem__()} methods of
@ref{310,,Element} when the element is concurrently
mutated. Patch by Bénédikt Tran.

@item 
gh-142195@footnote{https://github.com/python/cpython/issues/142195}: Updated timeout evaluation logic in @ref{d6,,subprocess} to be
compatible with deterministic environments like Shadow where time moves
exactly as requested.

@item 
gh-143145@footnote{https://github.com/python/cpython/issues/143145}: Fixed a possible reference leak in ctypes when constructing
results with multiple output parameters on error.

@item 
gh-122431@footnote{https://github.com/python/cpython/issues/122431}: Corrected the error message in
@ref{e7f,,readline.append_history_file()} to state that @code{nelements} must be
non-negative instead of positive.

@item 
gh-143004@footnote{https://github.com/python/cpython/issues/143004}: Fix a potential use-after-free in
@ref{15a4,,collections.Counter.update()} when user code mutates the Counter
during an update.

@item 
gh-143046@footnote{https://github.com/python/cpython/issues/143046}: The @ref{a,,asyncio} REPL no longer prints copyright and version
messages in the quiet mode (@ref{15a5,,-q}). Patch by Bartosz Sławecki.

@item 
gh-140648@footnote{https://github.com/python/cpython/issues/140648}: The @ref{a,,asyncio} REPL now respects the @ref{965,,-I} flag
(isolated mode). Previously, it would load and execute
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} even if the flag was set. Contributed by Bartosz
Sławecki.

@item 
gh-142991@footnote{https://github.com/python/cpython/issues/142991}: Fixed socket operations such as recvfrom() and sendto() for
FreeBSD divert(4) socket.

@item 
gh-143010@footnote{https://github.com/python/cpython/issues/143010}: Fixed a bug in @ref{8b,,mailbox} where the precise timing of an
external event could result in the library opening an existing file
instead of a file it expected to create.

@item 
gh-142881@footnote{https://github.com/python/cpython/issues/142881}: Fix concurrent and reentrant call of @ref{15a6,,atexit.unregister()}.

@item 
gh-112127@footnote{https://github.com/python/cpython/issues/112127}: Fix possible use-after-free in @ref{15a6,,atexit.unregister()} when
the callback is unregistered during comparison.

@item 
gh-142783@footnote{https://github.com/python/cpython/issues/142783}: Fix zoneinfo use-after-free with descriptor _weak_cache. a
descriptor as _weak_cache could cause crashes during object creation. The
fix ensures proper reference counting for descriptor-provided objects.

@item 
gh-142754@footnote{https://github.com/python/cpython/issues/142754}: Add the `ownerDocument' attribute to @ref{122,,xml.dom.minidom}
elements and attributes created by directly instantiating the @code{Element}
or @code{Attr} class. Note that this way of creating nodes is not supported;
creator functions like @ref{15a7,,xml.dom.Document.documentElement()} should
be used instead.

@item 
gh-142784@footnote{https://github.com/python/cpython/issues/142784}: The @ref{a,,asyncio} REPL now properly closes the loop upon the
end of interactive session. Previously, it could cause surprising
warnings. Contributed by Bartosz Sławecki.

@item 
gh-142594@footnote{https://github.com/python/cpython/issues/142594}: Fix crash in @code{TextIOWrapper.close()} when the underlying
buffer’s @code{closed} property calls @ref{15a8,,detach()}.

@item 
gh-142451@footnote{https://github.com/python/cpython/issues/142451}: @ref{6a,,hmac}: Ensure that the @ref{f7e,,HMAC.block_size} attribute is correctly copied by @ref{15a9,,HMAC.copy}. Patch by Bénédikt Tran.

@item 
gh-142495@footnote{https://github.com/python/cpython/issues/142495}: @ref{11fc,,collections.defaultdict} now prioritizes
@ref{130e,,__setitem__()} when inserting default values from
@code{default_factory}. This prevents race conditions where a default value
would overwrite a value set before @code{default_factory} returns.

@item 
gh-142651@footnote{https://github.com/python/cpython/issues/142651}: @ref{107,,unittest.mock}: fix a thread safety issue where
@ref{15aa,,Mock.call_count} may return
inaccurate values when the mock is called concurrently from multiple
threads.

@item 
gh-142595@footnote{https://github.com/python/cpython/issues/142595}: Added type check during initialization of the @ref{36,,decimal}
module to prevent a crash in case of broken stdlib.  Patch by Sergey B
Kirpichev.

@item 
gh-142517@footnote{https://github.com/python/cpython/issues/142517}: The non-@code{compat32} @ref{3b,,email} policies now correctly handle
refolding encoded words that contain bytes that can not be decoded in
their specified character set.  Previously this resulted in an encoding
exception during folding.

@item 
gh-112527@footnote{https://github.com/python/cpython/issues/112527}: The help text for required options in @ref{6,,argparse} no longer
extended with “ (default: None)”.

@item 
gh-142315@footnote{https://github.com/python/cpython/issues/142315}: Pdb can now run scripts from anonymous pipes used in process
substitution. Patch by Bartosz Sławecki.

@item 
gh-142282@footnote{https://github.com/python/cpython/issues/142282}: Fix @ref{15ab,,winreg.QueryValueEx()} to not accidentally read
garbage buffer under race condition.

@item 
gh-75949@footnote{https://github.com/python/cpython/issues/75949}: Corrige o @ref{6,,argparse} para preservar os separadores @code{|} em grupos mutuamente exclusivos quando a linha de uso quebra devido ao comprimento.

@item 
gh-68552@footnote{https://github.com/python/cpython/issues/68552}: Os defeitos @code{MisplacedEnvelopeHeaderDefect} e @code{Missing header name} agora são passados corretamente para o método @code{handle_defect} de @code{policy} em @ref{15ac,,FeedParser}.

@item 
gh-142006@footnote{https://github.com/python/cpython/issues/142006}: Corrige um bug no algoritmo de recolhimento do mod @ref{15ad,,email.policy.default} que resultava incorretamente em uma quebra de linha duplicada quando uma linha que terminava exatamente em max_line_length era seguida por um token que podia ser desdobrado.

@item 
gh-105836@footnote{https://github.com/python/cpython/issues/105836}: Fix @ref{886,,asyncio.run_coroutine_threadsafe()} leaving underlying
cancelled asyncio task running.

@item 
gh-139971@footnote{https://github.com/python/cpython/issues/139971}: @ref{b5,,pydoc}: Ensure that the link to the online documentation
of a @ref{15ae,,stdlib} module is correct.

@item 
gh-139262@footnote{https://github.com/python/cpython/issues/139262}: Some keystrokes can be swallowed in the new @code{PyREPL} on
Windows, especially when used together with the ALT key. Fix by Chris
Eibl.

@item 
gh-138897@footnote{https://github.com/python/cpython/issues/138897}: Improved @ref{15af,,license}/@ref{15b0,,copyright}/@ref{15b1,,credits}
display in the @ref{16a,,REPL}: now uses a pager.

@item 
gh-79986@footnote{https://github.com/python/cpython/issues/79986}: Add parsing for @code{References} and @code{In-Reply-To} headers to
the @ref{3b,,email} library that parses the header content as lists of
message id tokens.  This prevents them from being folded incorrectly.

@item 
gh-109263@footnote{https://github.com/python/cpython/issues/109263}: Starting a process from spawn context in @ref{94,,multiprocessing}
no longer sets the start method globally.

@item 
gh-90871@footnote{https://github.com/python/cpython/issues/90871}: Corrigido um erro de um erro referente ao parâmetro backlog em @ref{1ae,,create_unix_server()}. Contribuição de Christian Harries.

@item 
gh-133253@footnote{https://github.com/python/cpython/issues/133253}: Fix thread-safety issues in @ref{85,,linecache}.

@item 
gh-132715@footnote{https://github.com/python/cpython/issues/132715}: Skip writing objects during marshalling once a failure has
occurred.

@item 
gh-127529@footnote{https://github.com/python/cpython/issues/127529}: Corrige o comportamento de @code{asyncio.selector_events.BaseSelectorEventLoop._accept_connection()} ao lidar com @ref{1096,,ConnectionAbortedError} em um laço. Isso melhora o desempenho no OpenBSD.
@end itemize

@node IDLE<3>,Núcleo e embutidos,Biblioteca,Python seguinte
@anchor{whatsnew/changelog idle}@anchor{15b2}
@subsubsection IDLE



@itemize -

@item 
gh-143774@footnote{https://github.com/python/cpython/issues/143774}: Better explain the operation of Format / Format Paragraph.
@end itemize

@node Núcleo e embutidos,API C,IDLE<3>,Python seguinte
@anchor{whatsnew/changelog core-and-builtins}@anchor{15b3}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-144307@footnote{https://github.com/python/cpython/issues/144307}: Prevent a reference leak in module teardown at interpreter
finalization.

@item 
gh-144194@footnote{https://github.com/python/cpython/issues/144194}: Fix error handling in perf jitdump initialization on memory
allocation failure.

@item 
gh-141805@footnote{https://github.com/python/cpython/issues/141805}: Fix crash in @ref{5d9,,set} when objects with the same hash are
concurrently added to the set after removing an element with the same hash
while the set still contains elements with the same hash.

@item 
gh-143670@footnote{https://github.com/python/cpython/issues/143670}: Fixes a crash in @code{ga_repr_items_list} function.

@item 
gh-143377@footnote{https://github.com/python/cpython/issues/143377}: Fix a crash in @code{_interpreters.capture_exception()} when
the exception is incorrectly formatted. Patch by Bénédikt Tran.

@item 
gh-143189@footnote{https://github.com/python/cpython/issues/143189}: Fix crash when inserting a non-@ref{44c,,str} key into a split
table dictionary when the key matches an existing key in the split table
but has no corresponding value in the dict.

@item 
gh-143228@footnote{https://github.com/python/cpython/issues/143228}: Fix use-after-free in perf trampoline when toggling profiling
while threads are running or during interpreter finalization with daemon
threads active. The fix uses reference counting to ensure trampolines are
not freed while any code object could still reference them. Pach by Pablo
Galindo

@item 
gh-142664@footnote{https://github.com/python/cpython/issues/142664}: Fix a use-after-free crash in @ref{b0e,,memoryview.__hash__} when the @code{__hash__} method of the referenced object
mutates that object or the view. Patch by Bénédikt Tran.

@item 
gh-142557@footnote{https://github.com/python/cpython/issues/142557}: Fix a use-after-free crash in @ref{da9,,bytearray.__mod__} when the @code{bytearray} is mutated while
formatting the @code{%}-style arguments. Patch by Bénédikt Tran.

@item 
gh-143195@footnote{https://github.com/python/cpython/issues/143195}: Fix use-after-free crashes in @ref{d8e,,bytearray.hex()} and
@ref{d8f,,memoryview.hex()} when the separator’s @ref{15b4,,__len__()}
mutates the original object. Patch by Bénédikt Tran.

@item 
gh-143135@footnote{https://github.com/python/cpython/issues/143135}: Set @ref{15b5,,sys.flags.inspect} to @code{1} when
@geindex PYTHONINSPECT
@geindex variável de ambiente; PYTHONINSPECT
@ref{1522,,PYTHONINSPECT} is @code{0}. Previously, it was set to @code{0} in this
case.

@item 
gh-143003@footnote{https://github.com/python/cpython/issues/143003}: Fix an overflow of the shared empty buffer in
@ref{15b6,,bytearray.extend()} when @code{__length_hint__()} returns 0 for
non-empty iterator.

@item 
gh-143006@footnote{https://github.com/python/cpython/issues/143006}: Fix a possible assertion error when comparing negative
non-integer @code{float} and @code{int} with the same number of bits in the
integer part.

@item 
gh-142776@footnote{https://github.com/python/cpython/issues/142776}: Fix a file descriptor leak in import.c

@item 
gh-142829@footnote{https://github.com/python/cpython/issues/142829}: Fix a use-after-free crash in @ref{15b7,,contextvars.Context}
comparison when a custom @code{__eq__} method modifies the context via
@ref{15b8,,set()}.

@item 
gh-142766@footnote{https://github.com/python/cpython/issues/142766}: Clear the frame of a generator when @ref{15b9,,generator.close()} is
called.

@item 
gh-142737@footnote{https://github.com/python/cpython/issues/142737}: Tracebacks will be displayed in fallback mode even if
@ref{51d,,io.open()} is lost. Previously, this would crash the interpreter.
Patch by Bartosz Sławecki.

@item 
gh-142554@footnote{https://github.com/python/cpython/issues/142554}: Fix a crash in @ref{9a9,,divmod()} when @code{_pylong.int_divmod()}
does not return a tuple of length two exactly. Patch by Bénédikt Tran.

@item 
gh-142560@footnote{https://github.com/python/cpython/issues/142560}: Fix use-after-free in @ref{2ea,,bytearray} search-like methods
(@ref{13ea,,find()}, @ref{15ba,,count()},
@ref{15bb,,index()}, @ref{15bc,,rindex()}, and
@ref{13eb,,rfind()}) by marking the storage as exported which causes
reallocation attempts to raise @ref{15bd,,BufferError}. For
@ref{8e0,,contains()}, @ref{15be,,split()}, and
@ref{15bf,,rsplit()} the @ref{2e8,,buffer protocol} is
used for this.

@item 
gh-142343@footnote{https://github.com/python/cpython/issues/142343}: Fix SIGILL crash on m68k due to incorrect assembly constraint.

@item 
gh-141732@footnote{https://github.com/python/cpython/issues/141732}: Ensure the @ref{61c,,__repr__()} for @ref{1b6,,ExceptionGroup}
and @ref{25f,,BaseExceptionGroup} does not change when the exception sequence
that was original passed in to its constructor is subsequently mutated.

@item 
gh-100964@footnote{https://github.com/python/cpython/issues/100964}: Fix reference cycle in exhausted generator frames. Patch by
Savannah Ostrowski.

@item 
gh-140373@footnote{https://github.com/python/cpython/issues/140373}: Correctly emit @code{PY_UNWIND} event when generator object is
closed. Patch by Mikhail Efimov.

@item 
gh-138568@footnote{https://github.com/python/cpython/issues/138568}: Adjusted the built-in @ref{8dd,,help()} function so that empty
inputs are ignored in interactive mode.

@item 
gh-127773@footnote{https://github.com/python/cpython/issues/127773}: Não usa o cache de atributos de tipo para tipos com uma @ref{15c0,,MRO} incompatível.
@end itemize

@node API C,Construção,Núcleo e embutidos,Python seguinte
@anchor{whatsnew/changelog c-api}@anchor{15c1}
@subsubsection API C



@itemize -

@item 
gh-142571@footnote{https://github.com/python/cpython/issues/142571}: @code{PyUnstable_CopyPerfMapFile()} now checks that opening
the file succeeded before flushing.
@end itemize

@node Construção,,API C,Python seguinte
@anchor{whatsnew/changelog build}@anchor{15c2}
@subsubsection Construção



@itemize -

@item 
gh-142454@footnote{https://github.com/python/cpython/issues/142454}: When calculating the digest of the JIT stencils input, sort the
hashed files by filenames before adding their content to the hasher. This
ensures deterministic hash input and hence deterministic hash, independent
on filesystem order.

@item 
gh-141808@footnote{https://github.com/python/cpython/issues/141808}: When running @code{make clean-retain-profile}, keep the generated
JIT stencils. That way, the stencils are not generated twice when
Profile-guided optimization (PGO) is used. It also allows distributors to
supply their own pre-built JIT stencils.

@item 
gh-138061@footnote{https://github.com/python/cpython/issues/138061}: Ensure reproducible builds by making JIT stencil header
generation deterministic.
@end itemize

@node Python 3 13 11 final,Python 3 13 10 final,Python seguinte,Changelog
@anchor{whatsnew/changelog python-3-13-11-final}@anchor{15c3}
@subsection Python 3.13.11 final


`Release date: 2025-12-05'

@menu
* Segurança: Segurança<2>. 
* Biblioteca: Biblioteca<2>. 
* Núcleo e embutidos: Núcleo e embutidos<2>. 

@end menu

@node Segurança<2>,Biblioteca<2>,,Python 3 13 11 final
@anchor{whatsnew/changelog id2}@anchor{15c4}
@subsubsection Segurança



@itemize -

@item 
gh-142145@footnote{https://github.com/python/cpython/issues/142145}: Remove quadratic behavior in @code{xml.minidom} node ID cache
clearing.

@item 
gh-119451@footnote{https://github.com/python/cpython/issues/119451}: Fix a potential memory denial of service in the
@ref{6f,,http.client} module. When connecting to a malicious server, it could
cause an arbitrary amount of memory to be allocated. This could have led
to symptoms including a @ref{15c5,,MemoryError}, swapping, out of memory (OOM)
killed processes or containers, or even system crashes.

@item 
gh-119452@footnote{https://github.com/python/cpython/issues/119452}: Fix a potential memory denial of service in the
@ref{72,,http.server} module. When a malicious user is connected to the CGI
server on Windows, it could cause an arbitrary amount of memory to be
allocated. This could have led to symptoms including a @ref{15c5,,MemoryError},
swapping, out of memory (OOM) killed processes or containers, or even
system crashes.
@end itemize

@node Biblioteca<2>,Núcleo e embutidos<2>,Segurança<2>,Python 3 13 11 final
@anchor{whatsnew/changelog id3}@anchor{15c6}
@subsubsection Biblioteca



@itemize -

@item 
gh-140797@footnote{https://github.com/python/cpython/issues/140797}: Revert changes to the undocumented @code{re.Scanner} class.
Capturing groups are still allowed for backward compatibility, although
using them can lead to incorrect result. They will be forbidden in future
Python versions.

@item 
gh-142206@footnote{https://github.com/python/cpython/issues/142206}: The resource tracker in the @ref{94,,multiprocessing} module now
uses the original communication protocol, as in Python 3.14.0 and below,
by default. This avoids issues with upgrading Python while it is running.
(Note that such ‘in-place’ upgrades are not tested.) The tracker remains
compatible with subprocesses that use new protocol (that is, subprocesses
using Python 3.13.10, 3.14.1 and 3.15).
@end itemize

@node Núcleo e embutidos<2>,,Biblioteca<2>,Python 3 13 11 final
@anchor{whatsnew/changelog id4}@anchor{15c7}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-142218@footnote{https://github.com/python/cpython/issues/142218}: Fix crash when inserting into a split table dictionary with a
non @ref{44c,,str} key that matches an existing key.
@end itemize

@node Python 3 13 10 final,Python 3 13 9 final,Python 3 13 11 final,Changelog
@anchor{whatsnew/changelog python-3-13-10-final}@anchor{15c8}
@subsection Python 3.13.10 final


`Release date: 2025-12-02'

@menu
* Ferramentas/Demos: Ferramentas/Demos<2>. 
* Testes: Testes<2>. 
* Segurança: Segurança<3>. 
* Biblioteca: Biblioteca<3>. 
* IDLE: IDLE<4>. 
* Documentação: Documentação<2>. 
* Núcleo e embutidos: Núcleo e embutidos<3>. 
* API C: API C<2>. 

@end menu

@node Ferramentas/Demos<2>,Testes<2>,,Python 3 13 10 final
@anchor{whatsnew/changelog id5}@anchor{15c9}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-141442@footnote{https://github.com/python/cpython/issues/141442}: O ambiente de testes do iOS agora lida corretamente com argumentos de teste que contêm espaços.
@end itemize

@node Testes<2>,Segurança<3>,Ferramentas/Demos<2>,Python 3 13 10 final
@anchor{whatsnew/changelog id6}@anchor{15ca}
@subsubsection Testes



@itemize -

@item 
gh-140482@footnote{https://github.com/python/cpython/issues/140482}: Preserva e restaura o estado de @code{stty echo} como parte do ambiente de teste.

@item 
gh-140082@footnote{https://github.com/python/cpython/issues/140082}: Atualiza o comando @code{python -m test} para definir @code{FORCE_COLOR=1} quando executado com cores ativadas, para que o @ref{106,,unittest}, executado por ele com saída redirecionada, seja exibido em cores.

@item 
gh-136442@footnote{https://github.com/python/cpython/issues/136442}: Usa o código de saída @code{1} em vez de @code{5} se a @ref{a58,,unittest.TestCase.setUpClass()} levantar uma exceção.
@end itemize

@node Segurança<3>,Biblioteca<3>,Testes<2>,Python 3 13 10 final
@anchor{whatsnew/changelog id7}@anchor{15cb}
@subsubsection Segurança



@itemize -

@item 
gh-139700@footnote{https://github.com/python/cpython/issues/139700}: Verifica a consistência do registro zip64 no final do diretório central. Suporte a registros com “dados extensíveis zip64” se não houver bytes anexados ao arquivo ZIP.

@item 
gh-137836@footnote{https://github.com/python/cpython/issues/137836}: Adiciona suporte ao elemento “plaintext”, elementos RAWTEXT “xmp”, “iframe”, “noembed e “noframes”, e elementos RAWTEXT “noscript” opicionais em @ref{87b,,html.parser.HTMLParser}.

@item 
gh-136063@footnote{https://github.com/python/cpython/issues/136063}: @ref{44,,email.message}: ensure linear complexity for legacy HTTP
parameters parsing. Patch by Bénédikt Tran.

@item 
gh-136065@footnote{https://github.com/python/cpython/issues/136065}: Corrige complexidade quadrática em @ref{1420,,os.path.expandvars()}.

@item 
gh-119342@footnote{https://github.com/python/cpython/issues/119342}: Fix a potential memory denial of service in the @ref{ab,,plistlib}
module. When reading a Plist file received from untrusted source, it could
cause an arbitrary amount of memory to be allocated. This could have led
to symptoms including a @ref{15c5,,MemoryError}, swapping, out of memory (OOM)
killed processes or containers, or even system crashes.
@end itemize

@node Biblioteca<3>,IDLE<4>,Segurança<3>,Python 3 13 10 final
@anchor{whatsnew/changelog id8}@anchor{15cc}
@subsubsection Biblioteca



@itemize -

@item 
gh-74389@footnote{https://github.com/python/cpython/issues/74389}: Quando a entrada padrão (stdin) usada por uma instância de @ref{199,,subprocess.Popen} é fechada, isso agora é ignorado em @ref{15cd,,subprocess.Popen.communicate()}, em vez de deixar a classe em um estado inconsistente.

@item 
gh-87512@footnote{https://github.com/python/cpython/issues/87512}: Corrige o tratamento do limite de tempo de @ref{15cd,,subprocess.Popen.communicate()} no Windows ao escrever entradas grandes. Anteriormente, o timeout era ignorado durante a escrita na entrada padrão (stdin), fazendo com que o método bloqueasse indefinidamente se o processo filho não consumisse a entrada rapidamente. Agora, a escrita na entrada padrão é realizada em uma thread em segundo plano, permitindo que o tempo limite seja aplicado corretamente.

@item 
gh-141473@footnote{https://github.com/python/cpython/issues/141473}: Quando o método @ref{15cd,,subprocess.Popen.communicate()} é chamado com um valor de entrada e um tempo limite definido, e é chamado uma segunda vez após uma exceção @ref{15ce,,TimeoutExpired} antes que o processo seja encerrado, ele não deve mais travar.

@item 
gh-59000@footnote{https://github.com/python/cpython/issues/59000}: Fix @ref{a5,,pdb} breakpoint resolution for class methods when the
module defining the class is not imported.

@item 
gh-141570@footnote{https://github.com/python/cpython/issues/141570}: Suporte para @ref{15cf,,objeto arquivo ou similar} que levanta @ref{417,,OSError} de @ref{15d0,,fileno()} na detecção de cores (@code{_colorize.can_colorize()}). Isso pode ocorrer quando @code{sys.stdout} é redirecionado.

@item 
gh-141659@footnote{https://github.com/python/cpython/issues/141659}: Corrige erros de descritor de arquivo inválido provenientes do processo @code{_posixsubprocess} no AIX.

@item 
gh-141497@footnote{https://github.com/python/cpython/issues/141497}: @ref{80,,ipaddress}: garante que os métodos @ref{15d1,,IPv4Network.hosts()} e @ref{15d2,,IPv6Network.hosts()} sempre retornem um iterador.

@item 
gh-140938@footnote{https://github.com/python/cpython/issues/140938}: As funções @ref{6d4,,statistics.stdev()} e @ref{15d3,,statistics.pstdev()} agora levantam @ref{202,,ValueError} quando a entrada contém um infinito ou um NaN.

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: Atualizada a configuração de threads do Tcl em @ref{3,,_tkinter} para presumir que threads estão sempre disponíveis no Tcl 9 e versões posteriores.

@item 
gh-137109@footnote{https://github.com/python/cpython/issues/137109}: O @ref{197,,os.fork} e as APIs de fork relacionadas não emitirão mais avisos no caso comum em que as APIs da plataforma Linux ou macOS retornam o número de threads em um processo e encontram a resposta como 1, mesmo quando um função de retorno @ref{300,,os.register_at_fork()} @code{after_in_parent=} (re)inicia uma thread.

@item 
gh-141314@footnote{https://github.com/python/cpython/issues/141314}: Corrigido o erro de asserção em @ref{15d4,,io.TextIOWrapper.tell()} ao ler arquivos com quebras de linha de retorno de carro isoladas (@code{\r}).

@item 
gh-141311@footnote{https://github.com/python/cpython/issues/141311}: Corrigido o erro de asserção em @code{io.BytesIO.readinto()} e o comportamento indefinido que ocorria quando a posição de leitura estava acima da capacidade em @ref{ed3,,io.BytesIO}.

@item 
gh-141141@footnote{https://github.com/python/cpython/issues/141141}: Corrige um problema de segurança de threads com @ref{f53,,base64.b85decode()}. Contribuição de Benel Tayar.

@item 
gh-140911@footnote{https://github.com/python/cpython/issues/140911}: @ref{1d,,collections}: Garante que os métodos @code{UserString.rindex()} e @code{UserString.index()} aceitem instâncias de @ref{dfd,,collections.UserString} como sub-argumento.

@item 
gh-140797@footnote{https://github.com/python/cpython/issues/140797}: A classe não documentada @code{re.Scanner} agora proíbe expressões regulares que contenham grupos de captura em seus padrões de léxico. Padrões que utilizavam grupos de captura podiam anteriormente causar falhas de segmentação. Em vez disso, utilize grupos sem captura (?:…).

@item 
gh-140815@footnote{https://github.com/python/cpython/issues/140815}: @ref{58,,faulthandler} agora detecta se um quadro ou um objeto código é inválido ou foi liberado. Patch por Victor Stinner.

@item 
gh-100218@footnote{https://github.com/python/cpython/issues/100218}: Define corretamente @ref{15d5,,errno} quando as @ref{a38,,socket.if_nametoindex()} ou @ref{a39,,socket.if_indextoname()} levantam @ref{417,,OSError}. Patch por Bénédikt Tran.

@item 
gh-140875@footnote{https://github.com/python/cpython/issues/140875}: Corrigido o tratamento de referências de caracteres não fechadas (nomeadas e numéricas) seguidas pelo fim do arquivo em @ref{87b,,html.parser.HTMLParser} com @code{convert_charrefs=False}.

@item 
gh-140734@footnote{https://github.com/python/cpython/issues/140734}: @ref{94,,multiprocessing}: Corrige erro de diferença de um bit ao verificar o comprimento do caminho de um arquivo de socket temporário. Patch por Bénédikt Tran.

@item 
gh-140874@footnote{https://github.com/python/cpython/issues/140874}: Bump the version of pip bundled in @ref{55,,ensurepip} to version
25.3

@item 
gh-140691@footnote{https://github.com/python/cpython/issues/140691}: Em @ref{10b,,urllib.request}, quando a abertura de um URL FTP falha porque não é possível estabelecer uma conexão de dados, o socket da conexão de controle é agora fechado para evitar um @ref{244,,ResourceWarning}.

@item 
gh-103847@footnote{https://github.com/python/cpython/issues/103847}: Corrigido o travamento que ocorria ao cancelar um processo criado por @ref{a81,,asyncio.create_subprocess_exec()} ou @ref{a82,,asyncio.create_subprocess_shell()}. Patch por Kumar Aditya.

@item 
gh-140590@footnote{https://github.com/python/cpython/issues/140590}: Correção na verificação de argumentos para o método @code{functools.partial.__setstate__()}, que pode levar à corrupção do estado interno e ao travamento do sistema. Patch por Sergey Miryanov.

@item 
gh-140634@footnote{https://github.com/python/cpython/issues/140634}: Corrige um bug de contagem de referências em @code{os.sched_param.__reduce__()}.

@item 
gh-140633@footnote{https://github.com/python/cpython/issues/140633}: Ignora @ref{34b,,AttributeError} ao definir o atributo @code{__file__} de um módulo ao carregar um módulo de extensão empacotado como Apple Framework.

@item 
gh-140593@footnote{https://github.com/python/cpython/issues/140593}: @ref{126,,xml.parsers.expat}: Corrige um vazamento de memória que poderia afetar usuários com @ref{15d6,,ElementDeclHandler()} definido como um manipulador de declaração de elemento personalizado. Patch por Sebastian Pipping.

@item 
gh-140607@footnote{https://github.com/python/cpython/issues/140607}: Dentro de @ref{e48,,io.RawIOBase.read()}, verifica se a contagem de bytes retornada por @ref{e49,,io.RawIOBase.readinto()} é válida (dentro do buffer fornecido).

@item 
gh-138162@footnote{https://github.com/python/cpython/issues/138162}: Corrige @ref{1339,,logging.LoggerAdapter} com @code{merge_extra=True} e sem o argumento `extra'.

@item 
gh-140474@footnote{https://github.com/python/cpython/issues/140474}: Corrige vazamento de memória em @ref{1a0,,array.array} ao criar vetores a partir de um objeto @ref{44c,,str} vazio e do código do tipo @code{u}.

@item 
gh-140272@footnote{https://github.com/python/cpython/issues/140272}: Corrige vazamento de memória no método @code{clear()} do banco de dados @ref{33,,dbm.gnu}.

@item 
gh-140041@footnote{https://github.com/python/cpython/issues/140041}: Corrige importação de @ref{2a,,ctypes} no Android e Cygwin quando sinalizadores ABI estiverem presentes.

@item 
gh-139905@footnote{https://github.com/python/cpython/issues/139905}: Adiciona sugestão à mensagem de erro para subclasses @ref{15d7,,typing.Generic} quando @code{cls.__parameters__} estiver ausente devido a uma classe pai falhar ao chamar @ref{631,,super().__init_subclass__()} em sua @code{__init_subclass__}.

@item 
gh-139845@footnote{https://github.com/python/cpython/issues/139845}: Correção para não exibir KeyboardInterrupt duas vezes no REPL padrão de asyncio.

@item 
gh-139783@footnote{https://github.com/python/cpython/issues/139783}: Corrige @ref{15d8,,inspect.getsourcelines()} para o caso em que um decorador é seguido por um comentário ou uma linha vazia.

@item 
gh-70765@footnote{https://github.com/python/cpython/issues/70765}: @ref{72,,http.server}: corrige o tratamento padrão de requisições HTTP/0.9 em @ref{110a,,BaseHTTPRequestHandler}. Anteriormente, @code{BaseHTTPRequestHandler.parse_request()} aguardava incorretamente por cabeçalhos na requisição, embora estes não sejam suportados em HTTP/0.9. Patch por Bénédikt Tran.

@item 
gh-139391@footnote{https://github.com/python/cpython/issues/139391}: Corrige um problema em que, em plataformas não Windows, não era possível sair normalmente de um processo @code{python -m asyncio} suspenso por Ctrl+Z e posteriormente retomado por @code{fg@footnote{https://manpages.debian.org/fg}}, exceto com @code{kill@footnote{https://manpages.debian.org/kill}}.

@item 
gh-101828@footnote{https://github.com/python/cpython/issues/101828}: Corrige os codecs @code{'shift_jisx0213'}, @code{'shift_jis_2004'}, @code{'euc_jisx0213'} e @code{'euc_jis_2004'} que truncavam caracteres nulos, pois eram tratados como parte de sequências de múltiplos caracteres.

@item 
gh-139246@footnote{https://github.com/python/cpython/issues/139246}: correção: colar texto com largura zero na largura padrão do REPL está incorreto.

@item 
gh-90949@footnote{https://github.com/python/cpython/issues/90949}: Adiciona os métodos @ref{15d9,,SetAllocTrackerActivationThreshold()} e @ref{15da,,SetAllocTrackerMaximumAmplification()} aos objetos @ref{15db,,xmlparser} para evitar o uso de quantidades desproporcionais de memória dinâmica dentro de um analisador sintático Expat. Patch por Bénédikt Tran.

@item 
gh-139065@footnote{https://github.com/python/cpython/issues/139065}: Corrige espaço final antes de uma palavra longa encapsulada se o comprimento da linha for exatamente `width' em @ref{ec,,textwrap}.

@item 
gh-138993@footnote{https://github.com/python/cpython/issues/138993}: Reduz indentação do texto de @ref{15b1,,credits}.

@item 
gh-138859@footnote{https://github.com/python/cpython/issues/138859}: Corrige a parametrização de tipo genérico levantando @ref{2c3,,TypeError} ao omitir uma @code{ParamSpec} que tem um padrão que não é uma lista de tipos.

@item 
gh-138775@footnote{https://github.com/python/cpython/issues/138775}: O uso de @code{python -m} com @ref{e,,base64} foi corrigido para detectar a entrada de um terminal, de forma que reconheça corretamente o EOF (fim de arquivo).

@item 
gh-98896@footnote{https://github.com/python/cpython/issues/98896}: Corrige um erro em resource_tracker do módulo multiprocessing quando os nomes de SharedMemory contêm dois pontos. Patch por Rani Pinchuk.

@item 
gh-75989@footnote{https://github.com/python/cpython/issues/75989}: @ref{42e,,tarfile.TarFile.extractall()} e @ref{42f,,tarfile.TarFile.extract()} agora substituem links simbólicos ao extrair links físicos. (Contribuição de Alexander Enrique Urieles Nieto em gh-75989@footnote{https://github.com/python/cpython/issues/75989}.)

@item 
gh-83424@footnote{https://github.com/python/cpython/issues/83424}: Permite criar um @ref{9f1,,ctypes.CDLL} sem nome ao passar um identificador como argumento.

@item 
gh-136234@footnote{https://github.com/python/cpython/issues/136234}: Corrige @ref{15dc,,asyncio.WriteTransport.writelines()} para ser robusto a falhas de conexão, usando o mesmo comportamento de @ref{15dd,,write()}.

@item 
gh-136057@footnote{https://github.com/python/cpython/issues/136057}: Corrigido o bug em @ref{a5,,pdb} e @ref{f,,bdb} onde @code{next} e @code{step} não conseguiam ultrapassar a linha se existisse um laço na linha.

@item 
gh-135307@footnote{https://github.com/python/cpython/issues/135307}: @ref{3b,,email}: Corrige a exceção em @code{set_content()} ao codificar texto quando max_line_length está definido como @code{0} ou @code{None} (ilimitado).

@item 
gh-134453@footnote{https://github.com/python/cpython/issues/134453}: Corrigido o tratamento de @code{input=} da função @ref{15cd,,subprocess.Popen.communicate()} por instâncias de @ref{2eb,,memoryview} que não tinham formato de bytes em plataformas POSIX. Agora, essas instâncias são convertidas corretamente para uma visualização em formato de byte, em vez de truncar a entrada. Plataformas Windows não apresentavam esse bug.

@item 
gh-102431@footnote{https://github.com/python/cpython/issues/102431}: Esclarece restrições para argumentos “lógicos” em métodos de @ref{10ee,,decimal.Context}.
@end itemize

@node IDLE<4>,Documentação<2>,Biblioteca<3>,Python 3 13 10 final
@anchor{whatsnew/changelog id9}@anchor{15de}
@subsubsection IDLE



@itemize -

@item 
gh-96491@footnote{https://github.com/python/cpython/issues/96491}: Desduplica o número da versão na barra de título do shell do IDLE após salvar em um arquivo.
@end itemize

@node Documentação<2>,Núcleo e embutidos<3>,IDLE<4>,Python 3 13 10 final
@anchor{whatsnew/changelog documentation}@anchor{15df}
@subsubsection Documentação



@itemize -

@item 
gh-141994@footnote{https://github.com/python/cpython/issues/141994}: @ref{12a,,xml.sax.handler}: Faz a documentação de @ref{15e0,,xml.sax.handler.feature_external_ges} alertar sobre a vulnerabilidade a ataques de entidades externas@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack}. Patch por Sebastian Pipping.

@item 
gh-140578@footnote{https://github.com/python/cpython/issues/140578}: Remove a frase desatualizada na documentação de @ref{94,,multiprocessing}, que dava a entender que @ref{742,,concurrent.futures.ThreadPoolExecutor} não existia.
@end itemize

@node Núcleo e embutidos<3>,API C<2>,Documentação<2>,Python 3 13 10 final
@anchor{whatsnew/changelog id10}@anchor{15e1}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-142048@footnote{https://github.com/python/cpython/issues/142048}: Fix quadratically increasing garbage collection delays in
free-threaded build.

@item 
gh-141930@footnote{https://github.com/python/cpython/issues/141930}: When importing a module, use Python’s regular file object to
ensure that writes to @code{.pyc} files are complete or an appropriate error
is raised.

@item 
gh-120158@footnote{https://github.com/python/cpython/issues/120158}: Corrige estado inconsistente ao habilitar e desabilitar eventos de monitoramento muitas vezes.

@item 
gh-141579@footnote{https://github.com/python/cpython/issues/141579}: Corrigido o problema na função @ref{46f,,sys.activate_stack_trampoline()} para que ela ofereça suporte correto ao backend @code{perf_jit}. Patch por Pablo Galindo.

@item 
gh-141312@footnote{https://github.com/python/cpython/issues/141312}: Corrige a falha de asserção no método @code{__setstate__} do iterador de intervalo quando um argumento não inteiro é passado. Patch por Sergey Miryanov.

@item 
gh-140939@footnote{https://github.com/python/cpython/issues/140939}: Corrige vazamento de memória quando @ref{2ea,,bytearray} ou @ref{1c2,,bytes} é formatado com o formato @code{%*b} com uma largura grande que resulta em uma @ref{15c5,,MemoryError}.

@item 
gh-140530@footnote{https://github.com/python/cpython/issues/140530}: Corrige um vazamento de referência que ocorria quando @code{raise exc from cause} falhava. Patch por Bénédikt Tran.

@item 
gh-140576@footnote{https://github.com/python/cpython/issues/140576}: Corrigido o erro que causava o fechamento inesperado do código em @ref{4da,,tokenize.generate_tokens()} em caso de entrada incorreta específica. Patch por Mikhail Efimov.

@item 
gh-140551@footnote{https://github.com/python/cpython/issues/140551}: Corrigido o problema que causava o fechamento inesperado do arquivo @ref{256,,dict} se o método @ref{15e2,,dict.clear()} fosse chamado na fase de busca. Patch por Mikhail Efimov e Inada Naoki.

@item 
gh-140471@footnote{https://github.com/python/cpython/issues/140471}: Corrige possível estouro de buffer na inicialização do nó @ref{1a6,,ast.AST} ao encontrar @ref{15e3,,_fields} malformados contendo não-@ref{44c,,str}.

@item 
gh-140406@footnote{https://github.com/python/cpython/issues/140406}: Corrige vazamento de memória quando o método @ref{b0e,,__hash__()} de um objeto retorna um objeto que não é um @ref{257,,int}.

@item 
gh-140306@footnote{https://github.com/python/cpython/issues/140306}: Corrige vazamentos de memória em operações de canal entre interpretadores e manipulação de espaço de nomes compartilhado.

@item 
gh-140301@footnote{https://github.com/python/cpython/issues/140301}: Corrige vazamento de memória de @code{PyConfig} em subinterpretadores.

@item 
gh-140000@footnote{https://github.com/python/cpython/issues/140000}: Corrige possível vazamento de memória quando há um ciclo de referência entre uma instância de @ref{455,,typing.TypeAliasType}, @ref{15d,,typing.TypeVar}, @ref{15e,,typing.ParamSpec} ou @ref{15f,,typing.TypeVarTuple} e seu atributo @code{__name__}. Patch por Mikhail Efimov.

@item 
gh-139748@footnote{https://github.com/python/cpython/issues/139748}: Corrige vazamentos de referência em ramificações de erro de funções que aceitam strings de caminho ou bytes, como @ref{192,,compile()} e @ref{14a5,,os.system()}. Patch por Bénédikt Tran.

@item 
gh-139516@footnote{https://github.com/python/cpython/issues/139516}: Corrigir erro no formato de início de especificação de dois pontos lambda na f-string no tokenizador.

@item 
gh-139640@footnote{https://github.com/python/cpython/issues/139640}: Corrige a ingestão de alguns avisos de sintaxe em módulos diferentes caso eles acidentalmente tenham a mesma mensagem e sejam emitidos na mesma linha. Corrige avisos duplicados no bloco @code{finally}.

@item 
gh-137400@footnote{https://github.com/python/cpython/issues/137400}: Corrige uma falha na construção com @ref{15e4,,threads livres} ao desabilitar a criação de perfil ou o rastreamento em todos os threads com @ref{55f,,PyEval_SetProfileAllThreads()} ou @ref{422,,PyEval_SetTraceAllThreads()} ou seus equivalentes em Python @ref{4c8,,threading.settrace_all_threads()} e @ref{4c9,,threading.setprofile_all_threads()}.

@item 
gh-133400@footnote{https://github.com/python/cpython/issues/133400}: Comportamento corrigido do Ctrl+D (^D) no módulo _pyrepl para corresponder ao comportamento antigo do REPL pré-3.13.
@end itemize

@node API C<2>,,Núcleo e embutidos<3>,Python 3 13 10 final
@anchor{whatsnew/changelog id11}@anchor{15e5}
@subsubsection API C



@itemize -

@item 
gh-140042@footnote{https://github.com/python/cpython/issues/140042}: Removed the sqlite3_shutdown call that could cause closing
connections for sqlite when used with multiple sub interpreters.

@item 
gh-140487@footnote{https://github.com/python/cpython/issues/140487}: Corrige @ref{15e6,,Py_RETURN_NOTIMPLEMENTED} na API C limitada 3.11 e anteriores: não trata @code{Py_NotImplemented} como imortal. Patch por Victor Stinner.
@end itemize

@node Python 3 13 9 final,Python 3 13 8 final,Python 3 13 10 final,Changelog
@anchor{whatsnew/changelog python-3-13-9-final}@anchor{15e7}
@subsection Python 3.13.9 final


`Release date: 2025-10-14'

@menu
* Biblioteca: Biblioteca<4>. 

@end menu

@node Biblioteca<4>,,,Python 3 13 9 final
@anchor{whatsnew/changelog id12}@anchor{15e8}
@subsubsection Biblioteca



@itemize -

@item 
gh-139783@footnote{https://github.com/python/cpython/issues/139783}: Corrige @ref{15d8,,inspect.getsourcelines()} para o caso em que um decorador é seguido por um comentário ou uma linha vazia.
@end itemize

@node Python 3 13 8 final,Python 3 13 7 final,Python 3 13 9 final,Changelog
@anchor{whatsnew/changelog python-3-13-8-final}@anchor{15e9}
@subsection Python 3.13.8 final


`Data de lançamento: 2025-10-07'

@menu
* macOS:: 
* Windows: Windows<2>. 
* Ferramentas/Demos: Ferramentas/Demos<3>. 
* Testes: Testes<3>. 
* Segurança: Segurança<4>. 
* Biblioteca: Biblioteca<5>. 
* Núcleo e embutidos: Núcleo e embutidos<4>. 
* API C: API C<3>. 
* Construção: Construção<2>. 

@end menu

@node macOS,Windows<2>,,Python 3 13 8 final
@anchor{whatsnew/changelog macos}@anchor{15ea}
@subsubsection macOS



@itemize -

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: Atualiza o instalador do macOS para usar o Tcl/Tk 8.6.17.

@item 
gh-139573@footnote{https://github.com/python/cpython/issues/139573}: Atualizada a versão empacotada do OpenSSL para 3.0.18.
@end itemize

@node Windows<2>,Ferramentas/Demos<3>,macOS,Python 3 13 8 final
@anchor{whatsnew/changelog id13}@anchor{15eb}
@subsubsection Windows



@itemize -

@item 
gh-139573@footnote{https://github.com/python/cpython/issues/139573}: Atualizada a versão empacotada do OpenSSL para 3.0.18.

@item 
gh-138896@footnote{https://github.com/python/cpython/issues/138896}: Corrige erro ao instalar o runtime do C em máquinas Windows não atualizadas
@end itemize

@node Ferramentas/Demos<3>,Testes<3>,Windows<2>,Python 3 13 8 final
@anchor{whatsnew/changelog id14}@anchor{15ec}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-139330@footnote{https://github.com/python/cpython/issues/139330}: A ferramenta de geração de SBOM não verificava os valores de versão e checksum em relação ao script @code{Modules/expat/refresh.sh}, o que levava a que os valores ficassem desatualizados durante atualizações de rotina.

@item 
gh-137873@footnote{https://github.com/python/cpython/issues/137873}: O executor de testes iOS foi simplificado, resolvendo alguns problemas que foram observados ao usar o executor nos ambientes de teste do GitHub Actions e do Azure Pipelines.
@end itemize

@node Testes<3>,Segurança<4>,Ferramentas/Demos<3>,Python 3 13 8 final
@anchor{whatsnew/changelog id15}@anchor{15ed}
@subsubsection Testes



@itemize -

@item 
gh-139208@footnote{https://github.com/python/cpython/issues/139208}: Corrige o regrtest @code{--fast-ci --verbose}: não ignora mais a opção @code{--verbose}. Patch por Victor Stinner.
@end itemize

@node Segurança<4>,Biblioteca<5>,Testes<3>,Python 3 13 8 final
@anchor{whatsnew/changelog id16}@anchor{15ee}
@subsubsection Segurança



@itemize -

@item 
gh-139400@footnote{https://github.com/python/cpython/issues/139400}: @ref{126,,xml.parsers.expat}: Garante que os analisadores Expat pais sejam coletados como lixo somente quando não forem mais referenciados por subanalisadores criados por @ref{15ef,,ExternalEntityParserCreate()}. Patch por Sebastian Pipping.

@item 
gh-139283@footnote{https://github.com/python/cpython/issues/139283}: @ref{cf,,sqlite3}: manipula corretamente o número máximo de linhas a serem buscadas em @ref{15f0,,Cursor.fetchmany} e rejeita valores negativos para @ref{15f1,,Cursor.arraysize}. Patch por Bénédikt Tran.

@item 
gh-135661@footnote{https://github.com/python/cpython/issues/135661}: Corrige a análise da seção CDATA em @ref{87b,,html.parser.HTMLParser} de acordo com o padrão HTML5: @code{] ]>} e @code{]] >} não encerram mais a seção CDATA. Adiciona o método privado @code{_set_support_cdata()}, que pode ser usado para especificar como analisar @code{<[CDATA[} — como uma seção CDATA em conteúdo externo (SVG ou MathML) ou como um comentário falso no espaço de nomes HTML.
@end itemize

@node Biblioteca<5>,Núcleo e embutidos<4>,Segurança<4>,Python 3 13 8 final
@anchor{whatsnew/changelog id17}@anchor{15f2}
@subsubsection Biblioteca



@itemize -

@item 
gh-139312@footnote{https://github.com/python/cpython/issues/139312}: Atualiza libexpat empacotado para 2.7.3

@item 
gh-139289@footnote{https://github.com/python/cpython/issues/139289}: Faz uma importação preguiçosa real em @ref{bd,,rlcompleter} em @ref{a5,,pdb} e restaura o completer existente após importar @ref{bd,,rlcompleter}.

@item 
gh-139210@footnote{https://github.com/python/cpython/issues/139210}: Corrige o problema de uso após liberação ao relatar um evento desconhecido em @ref{273,,xml.etree.ElementTree.iterparse()}. Patch por Ken Jin.

@item 
gh-138860@footnote{https://github.com/python/cpython/issues/138860}: Importação preguiçosa de @ref{bd,,rlcompleter} em @ref{a5,,pdb} para evitar impasse no subprocesso.

@item 
gh-112729@footnote{https://github.com/python/cpython/issues/112729}: Corrige falha ao chamar @code{_interpreters.create} quando o processo está sem memória.

@item 
gh-139076@footnote{https://github.com/python/cpython/issues/139076}: Corrige um bug no módulo @ref{b5,,pydoc} que estava escondendo funções em um módulo Python se elas fossem implementadas em um módulo de extensão e o módulo não tivesse @code{__all__}.

@item 
gh-138998@footnote{https://github.com/python/cpython/issues/138998}: Atualiza libexpat empacotado para 2.7.2

@item 
gh-130567@footnote{https://github.com/python/cpython/issues/130567}: Corrige possível falha em @ref{15f3,,locale.strxfrm()} devido a um bug de plataforma no macOS.

@item 
gh-138779@footnote{https://github.com/python/cpython/issues/138779}: Suporte a números de dispositivos maiores que @code{2**63-1} para o campo @ref{15f4,,st_rdev} da estrutura @ref{1509,,os.stat_result}.

@item 
gh-128636@footnote{https://github.com/python/cpython/issues/128636}: Corrige falha no PyREPL quando os.environ é substituído por um valor inválido para Mac

@item 
gh-88375@footnote{https://github.com/python/cpython/issues/88375}: Corrige a normalização das regras e URLs @code{robots.txt} no módulo @ref{10d,,urllib.robotparser}. Não ignora mais o @code{?} final. Distingue os caracteres especiais brutos @code{?}, @code{=} e @code{&} dos codificados em porcentagem.

@item 
gh-138515@footnote{https://github.com/python/cpython/issues/138515}: @ref{3b,,email} é adicionado à construção Emscripten.

@item 
gh-111788@footnote{https://github.com/python/cpython/issues/111788}: Corrige erros de análise no módulo @ref{10d,,urllib.robotparser}. Não falhe ao tentar analisar caminhos estranhos. Não falha ao tentar decodificar arquivos @code{robots.txt} não UTF-8.

@item 
gh-138432@footnote{https://github.com/python/cpython/issues/138432}: @ref{15f5,,zoneinfo.reset_tzpath()} agora converterá quaisquer objetos @ref{c6c,,os.PathLike} recebidos em strings antes de adicioná-los a @code{TZPATH}. Ele levantará @code{TypeError} se algo diferente de uma string for encontrado após essa conversão. Se for fornecido um objeto @ref{c6c,,os.PathLike} que represente um caminho relativo, ele levantará @code{ValueError} em vez de @code{TypeError} e apresentará uma mensagem de erro mais informativa.

@item 
gh-138008@footnote{https://github.com/python/cpython/issues/138008}: Corrige falhas de segmentação no módulo @ref{2a,,ctypes} devido a @ref{15f6,,argtypes} inválido. Patch por Dung Nguyen.

@item 
gh-60462@footnote{https://github.com/python/cpython/issues/60462}: Corrige @ref{15f3,,locale.strxfrm()} no Solaris (e possivelmente em outras plataformas).

@item 
gh-138204@footnote{https://github.com/python/cpython/issues/138204}: Proibe expansão de @ref{90,,mapas de memória} anônimos compartilhados no Linux, o que causou um erro de barramento.

@item 
gh-138010@footnote{https://github.com/python/cpython/issues/138010}: Fix an issue where defining a class with a
@ref{160,,@@warnings.deprecated}-decorated base class may not invoke the
correct @ref{631,,__init_subclass__()} method in cases involving
multiple inheritance. Patch by Brian Schubert.

@item 
gh-138133@footnote{https://github.com/python/cpython/issues/138133}: Evita laço infinito de traceback ao enviar CTRL^C para Python através de @code{strace}.

@item 
gh-134869@footnote{https://github.com/python/cpython/issues/134869}: Correção de um problema em que pressionar Ctrl+C durante o preenchimento de guias no site REPL deixava o menu de preenchimento automático em um estado corrompido.

@item 
gh-137317@footnote{https://github.com/python/cpython/issues/137317}: @ref{738,,inspect.signature()} agora trata corretamente classes que usam um descritor em um método encapsulado @code{__init__()} ou @code{__new__()}. Contribuição de Yongyu Yan.

@item 
gh-137754@footnote{https://github.com/python/cpython/issues/137754}: Corrige a importação do módulo @ref{134,,zoneinfo} se a implementação C do módulo @ref{30,,datetime} não estiver disponível.

@item 
gh-137490@footnote{https://github.com/python/cpython/issues/137490}: Manipula @ref{15f7,,ECANCELED} da mesma forma que @ref{daf,,EINTR} em @ref{dd3,,signal.sigwaitinfo()} no NetBSD.

@item 
gh-137477@footnote{https://github.com/python/cpython/issues/137477}: Corrige @code{inspect.getblock()}, @ref{15d8,,inspect.getsourcelines()} e @ref{15f8,,inspect.getsource()} para expressões geradoras.

@item 
gh-137017@footnote{https://github.com/python/cpython/issues/137017}: Corrige @ref{954,,threading.Thread.is_alive} para permanecer @code{True} até que a thread do SO subjacente seja completamente limpa. Isso evita falsos negativos em casos extremos envolvendo monitoramento de threads ou chamadas prematuras de @ref{954,,threading.Thread.is_alive}.

@item 
gh-136134@footnote{https://github.com/python/cpython/issues/136134}: @code{SMTP.auth_cram_md5()} agora levanta uma @ref{fd5,,SMTPException} em vez de uma @ref{202,,ValueError} se o Python tiver sido construído sem suporte a MD5. Em particular, clientes @ref{934,,SMTP} não tentarão usar este método, mesmo que se presuma que o servidor remoto o suporte. Patch por Bénédikt Tran.

@item 
gh-136134@footnote{https://github.com/python/cpython/issues/136134}: @ref{15f9,,IMAP4.login_cram_md5} agora levanta @ref{15fa,,IMAP4.error} se a autenticação CRAM-MD5 não for suportada. Patch por Bénédikt Tran.

@item 
gh-135386@footnote{https://github.com/python/cpython/issues/135386}: Corrige a abertura de um banco de dados @ref{35,,dbm.sqlite3} para leitura de um arquivo ou diretório somente leitura.

@item 
gh-126631@footnote{https://github.com/python/cpython/issues/126631}: Corrige bug no @code{forkserver} do @ref{94,,multiprocessing} que impedia @code{__main__} de ser pré-carregado.

@item 
gh-123085@footnote{https://github.com/python/cpython/issues/123085}: In a bare call to @ref{48e,,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-118981@footnote{https://github.com/python/cpython/issues/118981}: Corrige possível travamento em @code{multiprocessing.popen_spawn_posix} que pode ocorrer quando o processo filho morre prematuramente, fechando os descritores de arquivo filhos imediatamente.

@item 
gh-78319@footnote{https://github.com/python/cpython/issues/78319}: O suporte UTF8 para o comando IMAP APPEND foi tornado compatível com RFC.

@item 
bpo-38735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38735}: Corrige falha ao importar um módulo do diretório raiz em plataformas do tipo Unix com sys.pycache_prefix definido.

@item 
bpo-41839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41839}: Permite valores de prioridade negativos das funções @ref{1148,,os.sched_get_priority_min()} e @ref{1147,,os.sched_get_priority_max()}.
@end itemize

@node Núcleo e embutidos<4>,API C<3>,Biblioteca<5>,Python 3 13 8 final
@anchor{whatsnew/changelog id18}@anchor{15fb}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-134466@footnote{https://github.com/python/cpython/issues/134466}: Não executa o PyREPL em um ambiente degradado onde a definição de atributos termios não é permitida.

@item 
gh-71810@footnote{https://github.com/python/cpython/issues/71810}: Levanta @ref{885,,OverflowError} para @code{(-1).to_bytes()} para conversões com sinal quando a contagem de bytes for zero. Patch por Sergey B Kirpichev.

@item 
gh-105487@footnote{https://github.com/python/cpython/issues/105487}: Remove @ref{15fc,,__copy__()}, @ref{15fd,,__deepcopy__()} e @ref{14f4,,__bases__} inexistentes das entradas @ref{15fe,,__dir__()} de @ref{7ed,,types.GenericAlias}.

@item 
gh-134163@footnote{https://github.com/python/cpython/issues/134163}: Fix a hang when the process is out of memory inside an
exception handler.

@item 
gh-138479@footnote{https://github.com/python/cpython/issues/138479}: Corrige uma falha quando @code{__typing_subst__} de um objeto genérico retorna um objeto que não é uma @ref{370,,tuple}.

@item 
gh-137576@footnote{https://github.com/python/cpython/issues/137576}: Correção para código-fonte incorreto exibido em tracebacks do REPL básico quando 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} é fornecido. Patch por Adam Hartz.

@item 
gh-132744@footnote{https://github.com/python/cpython/issues/132744}: Certas chamadas agora verificam a recursão descontrolada e respeitam o limite de recursão do sistema.
@end itemize

@node API C<3>,Construção<2>,Núcleo e embutidos<4>,Python 3 13 8 final
@anchor{whatsnew/changelog id19}@anchor{15ff}
@subsubsection API C



@itemize -

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

While not officially marked deprecated until 3.14,
@code{PyThread_exit_thread} is no longer called internally and remains solely
for interface compatibility. 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.
@end itemize

@node Construção<2>,,API C<3>,Python 3 13 8 final
@anchor{whatsnew/changelog id20}@anchor{1600}
@subsubsection Construção



@itemize -

@item 
gh-135734@footnote{https://github.com/python/cpython/issues/135734}: Python can correctly be configured and built with @code{./configure
--enable-optimizations --disable-test-modules}. Previously, the profile
data generation step failed due to PGO tests where immortalization
couldn’t be properly suppressed. Patch by Bénédikt Tran.
@end itemize

@node Python 3 13 7 final,Python 3 13 6 final,Python 3 13 8 final,Changelog
@anchor{whatsnew/changelog python-3-13-7-final}@anchor{1601}
@subsection Python 3.13.7 final


`Data de lançamento: 14-08-2025'

@menu
* Biblioteca: Biblioteca<6>. 
* Documentação: Documentação<3>. 
* Núcleo e embutidos: Núcleo e embutidos<5>. 

@end menu

@node Biblioteca<6>,Documentação<3>,,Python 3 13 7 final
@anchor{whatsnew/changelog id21}@anchor{1602}
@subsubsection Biblioteca



@itemize -

@item 
gh-137583@footnote{https://github.com/python/cpython/issues/137583}: Fix a deadlock introduced in 3.13.6 when a call to
@ref{dcc,,ssl.SSLSocket.recv} was blocked in one thread,
and then another method on the object (such as @ref{dcf,,ssl.SSLSocket.send}) was subsequently called in another thread.

@item 
gh-137044@footnote{https://github.com/python/cpython/issues/137044}: Retorna valores de limite grandes como inteiros positivos em vez de inteiros negativos em @ref{1603,,resource.getrlimit()}. Aceita valores grandes e rejeita valores negativos (exceto @ref{1604,,RLIM_INFINITY}) para limites em @ref{1605,,resource.setrlimit()}.

@item 
gh-136914@footnote{https://github.com/python/cpython/issues/136914}: Corrige recuperação de @ref{1606,,doctest.DocTest.lineno} para objetos decorados com @ref{1607,,functools.cache()} ou @ref{541,,functools.cached_property}.

@item 
gh-131788@footnote{https://github.com/python/cpython/issues/131788}: Torna @code{ResourceTracker.send} de @ref{94,,multiprocessing} reentrante seguro
@end itemize

@node Documentação<3>,Núcleo e embutidos<5>,Biblioteca<6>,Python 3 13 7 final
@anchor{whatsnew/changelog id22}@anchor{1608}
@subsubsection Documentação



@itemize -

@item 
gh-136155@footnote{https://github.com/python/cpython/issues/136155}: Agora estamos verificando erros fatais em construções de EPUB no CI.
@end itemize

@node Núcleo e embutidos<5>,,Documentação<3>,Python 3 13 7 final
@anchor{whatsnew/changelog id23}@anchor{1609}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-137400@footnote{https://github.com/python/cpython/issues/137400}: Corrige uma falha na construção com @ref{15e4,,threads livres} ao desabilitar a criação de perfil ou o rastreamento em todos os threads com @ref{55f,,PyEval_SetProfileAllThreads()} ou @ref{422,,PyEval_SetTraceAllThreads()} ou seus equivalentes em Python @ref{4c8,,threading.settrace_all_threads()} e @ref{4c9,,threading.setprofile_all_threads()}.
@end itemize

@node Python 3 13 6 final,Python 3 13 5 final,Python 3 13 7 final,Changelog
@anchor{whatsnew/changelog python-3-13-6-final}@anchor{160a}
@subsection Python 3.13.6 final


`Data de lançamento: 06-08-2025'

@menu
* macOS: macOS<2>. 
* Windows: Windows<3>. 
* Ferramentas/Demos: Ferramentas/Demos<4>. 
* Testes: Testes<4>. 
* Segurança: Segurança<5>. 
* Biblioteca: Biblioteca<7>. 
* Documentação: Documentação<4>. 
* Núcleo e embutidos: Núcleo e embutidos<6>. 
* Construção: Construção<3>. 

@end menu

@node macOS<2>,Windows<3>,,Python 3 13 6 final
@anchor{whatsnew/changelog id24}@anchor{160b}
@subsubsection macOS



@itemize -

@item 
gh-137450@footnote{https://github.com/python/cpython/issues/137450}: macOS instalador console melhorias no gerenciamento de caminhos: separe o script pós-instalação do instalador @code{console profile updater} do @code{Update console Profile.comando} para permitir um manuseio mais robusto do erro.

@item 
gh-137134@footnote{https://github.com/python/cpython/issues/137134}: Atualização do instalador do macOS para ser fornecido com o SQLite versão 3.50.4.
@end itemize

@node Windows<3>,Ferramentas/Demos<4>,macOS<2>,Python 3 13 6 final
@anchor{whatsnew/changelog id25}@anchor{160c}
@subsubsection Windows



@itemize -

@item 
gh-137134@footnote{https://github.com/python/cpython/issues/137134}: Atualizar o instalador do Windows para que seja fornecido com o SQLite 3.50.4.
@end itemize

@node Ferramentas/Demos<4>,Testes<4>,Windows<3>,Python 3 13 6 final
@anchor{whatsnew/changelog id26}@anchor{160d}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-135968@footnote{https://github.com/python/cpython/issues/135968}: Os stubs para @code{strip} agora são fornecidos como parte de uma instalação do iOS.
@end itemize

@node Testes<4>,Segurança<5>,Ferramentas/Demos<4>,Python 3 13 6 final
@anchor{whatsnew/changelog id27}@anchor{160e}
@subsubsection Testes



@itemize -

@item 
gh-135966@footnote{https://github.com/python/cpython/issues/135966}: O ambiente de teste do iOS agora manipula a pasta @code{app_packages} como um diretório de site.

@item 
gh-135494@footnote{https://github.com/python/cpython/issues/135494}: Corrige o regrtest para suportar a exclusão de testes de @code{--pgo}. Patch por Victor Stinner.

@item 
gh-135489@footnote{https://github.com/python/cpython/issues/135489}: Exibe saída detalhada para testes com falha durante a etapa de criação de perfil do PGO com –enable-optimizations.
@end itemize

@node Segurança<5>,Biblioteca<7>,Testes<4>,Python 3 13 6 final
@anchor{whatsnew/changelog id28}@anchor{160f}
@subsubsection Segurança



@itemize -

@item 
gh-135661@footnote{https://github.com/python/cpython/issues/135661}: Corrige a análise das tags de início e fim em @ref{87b,,html.parser.HTMLParser} de acordo com o padrão HTML5.


@itemize *

@item 
Espaços em branco não são mais aceitos entre @code{</} e o nome da tag. Por exemplo, @code{</ script>} não encerra a seção de script.

@item 
Tabulação vertical (@code{\v}) e espaços em branco não ASCII não são mais reconhecidos como espaços em branco. Os únicos espaços em branco são @code{\t\n\r\f} e espaço.

@item 
O caractere nulo (U+0000) não termina mais o nome da tag.

@item 
Atributos e barras após o nome da tag em tags finais agora são ignorados, em vez de terminar após o primeiro @code{>} no valor do atributo entre aspas. Por exemplo, @code{</script/foo=">"/>}.

@item 
Barras múltiplas e espaços em branco entre o último atributo e o @code{>} de fechamento agora são ignorados nas tags de início e fim. Por exemplo, @code{<a foo=bar/ //>}.

@item 
Múltiplos @code{=} entre o nome do atributo e o valor não são mais recolhidos. Por exemplo, @code{<a foo==bar>} produz o atributo “foo” com o valor “=bar”.
@end itemize

@item 
gh-102555@footnote{https://github.com/python/cpython/issues/102555}: Corrige a análise de comentários em @ref{87b,,html.parser.HTMLParser} de acordo com o padrão HTML5. @code{--!>} agora encerra o comentário. @code{-- >} não encerra mais o comentário. Suporte a comentários vazios @code{<-->} e @code{<--->} que encerravam anormalmente.

@item 
gh-135462@footnote{https://github.com/python/cpython/issues/135462}: Corrigida a complexidade quadrática no processamento de entradas especialmente criadas em @ref{87b,,html.parser.HTMLParser}. Erros de fim de arquivo agora são tratados de acordo com as especificações do HTML5 – comentários e declarações são fechados automaticamente, tags são ignoradas.

@item 
gh-118350@footnote{https://github.com/python/cpython/issues/118350}: Corrige suporte ao modo de texto bruto escapável (elementos “textarea” e “title”) em @ref{87b,,html.parser.HTMLParser}.
@end itemize

@node Biblioteca<7>,Documentação<4>,Segurança<5>,Python 3 13 6 final
@anchor{whatsnew/changelog id29}@anchor{1610}
@subsubsection Biblioteca



@itemize -

@item 
gh-132710@footnote{https://github.com/python/cpython/issues/132710}: Se possível, garante que @ref{bbf,,uuid.getnode()} retorne o mesmo resultado mesmo em processos diferentes. Anteriormente, o resultado era constante apenas dentro do mesmo processo. Patch por Bénédikt Tran.

@item 
gh-137273@footnote{https://github.com/python/cpython/issues/137273}: Corrige falha de asserção de depuração em @ref{2db,,locale.setlocale()} no Windows.

@item 
gh-137257@footnote{https://github.com/python/cpython/issues/137257}: Sobe a versão do pip empacotado em ensurepip para a versão 25.2.

@item 
gh-81325@footnote{https://github.com/python/cpython/issues/81325}: @ref{1250,,tarfile.TarFile} agora aceita um @ref{2a0,,caminho ou similar} ao trabalhar em um arquivo tar. (Contribuição de Alexander Enrique Urieles Nieto em gh-81325@footnote{https://github.com/python/cpython/issues/81325}.)

@item 
gh-130522@footnote{https://github.com/python/cpython/issues/130522}: Corrige @ref{2c3,,TypeError} não levantável levantada durante @ref{14e,,desligamento do interpretador} no módulo @ref{ed,,threading}.

@item 
gh-130577@footnote{https://github.com/python/cpython/issues/130577}: @ref{de,,tarfile} agora valida arquivos para garantir que os deslocamentos dos membros não sejam negativos. (Contribuição de Alexander Enrique Urieles Nieto em gh-130577@footnote{https://github.com/python/cpython/issues/130577}.)

@item 
gh-136549@footnote{https://github.com/python/cpython/issues/136549}: Corrige assinatura de @ref{84e,,threading.excepthook()}.

@item 
gh-136523@footnote{https://github.com/python/cpython/issues/136523}: Corrige @ref{2b7,,wave.Wave_write} emitindo uma exceção não levantável quando open a levanta.

@item 
gh-52876@footnote{https://github.com/python/cpython/issues/52876}: Adiciona o parâmetro @code{keepends} ausente (padrão @code{True}) para @code{codecs.StreamReaderWriter.readline()} e @code{codecs.StreamReaderWriter.readlines()}.

@item 
gh-85702@footnote{https://github.com/python/cpython/issues/85702}: Se @code{zoneinfo._common.load_tzdata} receber um pacote sem um recurso, um @ref{1611,,zoneinfo.ZoneInfoNotFoundError} será levantada em vez de uma @ref{d65,,PermissionError}. Patch por Victor Stinner.

@item 
gh-134759@footnote{https://github.com/python/cpython/issues/134759}: Corrige @ref{157f,,UnboundLocalError} em @ref{120d,,email.message.Message.get_payload()} quando o payload a ser decodificado for um objeto @ref{1c2,,bytes}. Patch por Kliment Lamonov.

@item 
gh-136028@footnote{https://github.com/python/cpython/issues/136028}: Corrige a análise de nomes de meses contendo “İ” (U+0130, LETRA I MAIÚSCULA COM PONTO EM CIMA) em @ref{1474,,time.strptime()}. Isso afeta as localidades az_AZ, ber_DZ, ber_MA e crh_UA.

@item 
gh-135995@footnote{https://github.com/python/cpython/issues/135995}: Na codificação palmos, faz o byte @code{0x9b} ser decodificado para @code{›} (U+203A - ASPAS ÚNICAS DE ÂNGULO À DIREITA).

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: Corrige @ref{1474,,time.strptime()} para os formatos @code{%c} e @code{%x} nos locais byn_ER, wal_ET e lzh_TW, e para o formato @code{%X} nos locais ar_SA, bg_BG e lzh_TW.

@item 
gh-91555@footnote{https://github.com/python/cpython/issues/91555}: An earlier change, which was introduced in 3.13.4, has been
reverted. It disabled logging for a logger during handling of log messages
for that logger. Since the reversion, the behaviour should be as it was
before 3.13.4.

@item 
gh-135878@footnote{https://github.com/python/cpython/issues/135878}: Corrige uma falha de @ref{1d1,,types.SimpleNamespace} em construções com @ref{15e4,,threads livres}, quando várias threads estavam chamando seu método @ref{61c,,__repr__()} ao mesmo tempo.

@item 
gh-135836@footnote{https://github.com/python/cpython/issues/135836}: Corrige @ref{157e,,IndexError} em @ref{603,,asyncio.loop.create_connection()} que poderia ocorrer quando uma exceção não-@ref{417,,OSError} fosse levantada durante a conexão e o @code{close()} do soquete levantasse @code{OSError}.

@item 
gh-135836@footnote{https://github.com/python/cpython/issues/135836}: Corrige @ref{157e,,IndexError} em @ref{603,,asyncio.loop.create_connection()} que poderia ocorrer quando o algoritmo Happy Eyeballs resultava em uma lista de exceções vazia durante tentativas de conexão.

@item 
gh-135855@footnote{https://github.com/python/cpython/issues/135855}: Levanta @ref{2c3,,TypeError} em vez de @ref{575,,SystemError} quando @code{_interpreters.set___main___attrs()} recebe um objeto não dict. Patch por Brian Schubert.

@item 
gh-135815@footnote{https://github.com/python/cpython/issues/135815}: @ref{9b,,netrc}: Ignora as verificações de segurança se @ref{1612,,os.getuid()} estiver ausente. Patch por Bénédikt Tran.

@item 
gh-135640@footnote{https://github.com/python/cpython/issues/135640}: Corrigido um bug que permitia chamar @ref{aa4,,xml.etree.ElementTree.ElementTree.write()} em um objeto ElementTree com um elemento raiz inválido. Esse comportamento apagava o arquivo passado para @code{write} caso ele já existisse.

@item 
gh-135444@footnote{https://github.com/python/cpython/issues/135444}: Corrige @ref{1af,,asyncio.DatagramTransport.sendto()} para levar em conta o tamanho do cabeçalho do datagrama quando os dados não podem ser enviados.

@item 
gh-135497@footnote{https://github.com/python/cpython/issues/135497}: Corrige falha em @ref{1613,,os.getlogin()} para nomes de usuários mais longos em plataformas baseadas em BSD.

@item 
gh-135487@footnote{https://github.com/python/cpython/issues/135487}: Corrige @code{reprlib.Repr.repr_int()} quando são fornecidos inteiros com mais de @ref{1614,,sys.get_int_max_str_digits()} dígitos. Patch por Bénédikt Tran.

@item 
gh-135335@footnote{https://github.com/python/cpython/issues/135335}: @ref{94,,multiprocessing}: Limpa @code{stdout} e @code{stderr} após pré-carregar módulos no @code{forkserver}.

@item 
gh-135244@footnote{https://github.com/python/cpython/issues/135244}: @ref{110,,uuid}: when the MAC address cannot be determined, the
48-bit node ID is now generated with a cryptographically-secure
pseudo-random number generator (CSPRNG) as per 
@geindex RFC; RFC 9562 Section 6.10-3
RFC 9562@comma{} §6.10.3@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-6.10-3}. This affects @ref{bc0,,uuid1()}.

@item 
gh-135069@footnote{https://github.com/python/cpython/issues/135069}: Corrige a exceção “Invalid error handling” em @code{encodings.idna.IncrementalDecoder} para substituir corretamente o parâmetro ‘errors’.

@item 
gh-134698@footnote{https://github.com/python/cpython/issues/134698}: Corrige uma falha ao chamar métodos de @ref{294,,ssl.SSLContext} ou @ref{8f0,,ssl.SSLSocket} em várias threads.

@item 
gh-132124@footnote{https://github.com/python/cpython/issues/132124}: On POSIX-compliant systems,
@code{multiprocessing.util.get_temp_dir()} now ignores 
@geindex TMPDIR
@geindex variável de ambiente; TMPDIR
@code{TMPDIR}
(and similar environment variables) if the path length of @code{AF_UNIX}
socket files exceeds the platform-specific maximum length when using the
`forkserver' start method. Patch by Bénédikt Tran.

@item 
gh-133439@footnote{https://github.com/python/cpython/issues/133439}: Corrige comandos ponto com espaços à direita são confundidos com instruções SQL multilinha na interface de linha de comando sqlite3.

@item 
gh-132969@footnote{https://github.com/python/cpython/issues/132969}: Impede que a thread executora @ref{8f4,,ProcessPoolExecutor}, que permanece em execução quando @ref{8f3,,shutdown(wait=False)}, tente ajustar os processos de trabalho do pool após o estado do objeto já ter sido redefinido durante o desligamento. Uma combinação de condições, incluindo um processo de trabalho encerrado de forma anormal, resultou em uma exceção e um possível travamento quando a thread executora ainda em execução tentou substituir os processos de trabalho inativos no pool.

@item 
gh-130664@footnote{https://github.com/python/cpython/issues/130664}: Suporte ao separador de dígitos @code{'_'} na formatação da parte integral de @ref{29d,,Decimal}’s. Patch por Sergey B Kirpichev.

@item 
gh-85702@footnote{https://github.com/python/cpython/issues/85702}: Se @code{zoneinfo._common.load_tzdata} receber um pacote sem um recurso, uma @code{ZoneInfoNotFoundError} será levantada em vez de uma @ref{1092,,IsADirectoryError}.

@item 
gh-130664@footnote{https://github.com/python/cpython/issues/130664}: Lida com maiúsculas e minúsculas para a formatação de @ref{1e7,,Fraction}: tratar o preenchimento com zeros (precedendo o campo de largura por um caractere zero (@code{'0'})) como um equivalente a um caractere de preenchimento de @code{'0'} com um tipo de alinhamento de @code{'='}, assim como no caso de @ref{2f7,,float}.
@end itemize

@node Documentação<4>,Núcleo e embutidos<6>,Biblioteca<7>,Python 3 13 6 final
@anchor{whatsnew/changelog id30}@anchor{1615}
@subsubsection Documentação



@itemize -

@item 
gh-135171@footnote{https://github.com/python/cpython/issues/135171}: Documenta que o @ref{1ac,,iterador} para a cláusula @code{for} mais à esquerda na expressão geradora é criado imediatamente.
@end itemize

@node Núcleo e embutidos<6>,Construção<3>,Documentação<4>,Python 3 13 6 final
@anchor{whatsnew/changelog id31}@anchor{1616}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-58124@footnote{https://github.com/python/cpython/issues/58124}: Corrige erros de codificação Python em Unicode do codec da página de código: usar “cp65000” e “cp65001” em vez de “CP_UTF7” e “CP_UTF8”, que não são nomes de código Python válidos. Patch por Victor Stinner.

@item 
gh-137314@footnote{https://github.com/python/cpython/issues/137314}: Corrigida uma regressão em que f-strings brutas interpretavam incorretamente sequências de escape em especificações de formato. As f-strings brutas agora preservam corretamente as contrabarras literais nas especificações de formato, correspondendo ao comportamento do Python 3.11. Por exemplo, @code{rf"@{obj:\xFF@}"} agora produz corretamente @code{'\\xFF'} em vez de @code{'ÿ'}. Patch por Pablo Galindo.

@item 
gh-136541@footnote{https://github.com/python/cpython/issues/136541}: Corrigimos alguns problemas com os trampolins do Perf em x86-64 e aarch64. Os trampolins não estavam sendo gerados corretamente em alguns casos, o que poderia fazer com que a integração do Perf não funcionasse corretamente. Patch por Pablo Galindo.

@item 
gh-109700@footnote{https://github.com/python/cpython/issues/109700}: Corrige tratamento de erro de memória em @ref{340,,PyDict_SetDefault()}.

@item 
gh-78465@footnote{https://github.com/python/cpython/issues/78465}: Corrige mensagem de erro para @code{cls.__new__(cls, ...)} onde @code{cls} não é um tipo de extensão ou embutido instanciável (com @code{tp_new} definido como @code{NULL}).

@item 
gh-135871@footnote{https://github.com/python/cpython/issues/135871}: Tentativas de trava de mutex não bloqueantes agora retornam imediatamente quando a trava está ocupado, em vez de girar brevemente na construção com @ref{15e4,,threads livres}.

@item 
gh-135607@footnote{https://github.com/python/cpython/issues/135607}: Corrige possíveis corridas @ref{114,,weakref} no destrutor de um objeto na construção com @ref{15e4,,threads livres}.

@item 
gh-135496@footnote{https://github.com/python/cpython/issues/135496}: Corrige erro de digitação no tipo de conversão de f-strings (“exclamanation” -> “exclamation”).

@item 
gh-130077@footnote{https://github.com/python/cpython/issues/130077}: Gera corretamente erros de sintaxe personalizados quando for encontrada uma sintaxe incorreta contendo nomes que são prefixos de palavras reservadas contextuais. Patch por Pablo Galindo.

@item 
gh-135148@footnote{https://github.com/python/cpython/issues/135148}: Corrigido um bug em que expressões de depuração de strings f (usando =) removiam incorretamente partes de strings contendo aspas de escape e caracteres #. Patch por Pablo Galindo.

@item 
gh-133136@footnote{https://github.com/python/cpython/issues/133136}: Limita o uso excessivo de memória na construção com @ref{15e4,,threads livres} quando um dicionário ou lista grande é redimensionado e acessado por várias threads.

@item 
gh-132617@footnote{https://github.com/python/cpython/issues/132617}: Corrige verificação de modificação @ref{14ad,,dict.update()} que poderia levantar incorretamente um erro “dict mutated during update” quando um dicionário diferente era modificado e compartilhava o mesmo objeto de chaves subjacente.

@item 
gh-91153@footnote{https://github.com/python/cpython/issues/91153}: Corrige uma falha quando um @ref{2ea,,bytearray} é mutado simultaneamente durante a atribuição de item.

@item 
gh-127971@footnote{https://github.com/python/cpython/issues/127971}: Corrige leituras fora de um ponto além do final de uma string na pesquisa de string.

@item 
gh-125723@footnote{https://github.com/python/cpython/issues/125723}: Corrige falha com @code{gi_frame.f_locals} quando os frames do gerador duram mais que o gerador. Patch por Mikhail Efimov.
@end itemize

@node Construção<3>,,Núcleo e embutidos<6>,Python 3 13 6 final
@anchor{whatsnew/changelog id32}@anchor{1617}
@subsubsection Construção



@itemize -

@item 
gh-135497@footnote{https://github.com/python/cpython/issues/135497}: Corrige a detecção de @code{MAXLOGNAME} no script @code{configure.ac}.
@end itemize

@node Python 3 13 5 final,Python 3 13 4 final,Python 3 13 6 final,Changelog
@anchor{whatsnew/changelog python-3-13-5-final}@anchor{1618}
@subsection Python 3.13.5 final


`Release date: 2025-06-11'

@menu
* Windows: Windows<4>. 
* Testes: Testes<5>. 
* Biblioteca: Biblioteca<8>. 
* Núcleo e embutidos: Núcleo e embutidos<7>. 
* API C: API C<4>. 

@end menu

@node Windows<4>,Testes<5>,,Python 3 13 5 final
@anchor{whatsnew/changelog id33}@anchor{1619}
@subsubsection Windows



@itemize -

@item 
gh-135151@footnote{https://github.com/python/cpython/issues/135151}: Avoid distributing modified @code{pyconfig.h} in the
traditional installer. Extension module builds must always specify
@code{Py_GIL_DISABLED} when targeting the free-threaded runtime.
@end itemize

@node Testes<5>,Biblioteca<8>,Windows<4>,Python 3 13 5 final
@anchor{whatsnew/changelog id34}@anchor{161a}
@subsubsection Testes



@itemize -

@item 
gh-135120@footnote{https://github.com/python/cpython/issues/135120}: Adiciona @code{test.support.subTests()}.
@end itemize

@node Biblioteca<8>,Núcleo e embutidos<7>,Testes<5>,Python 3 13 5 final
@anchor{whatsnew/changelog id35}@anchor{161b}
@subsubsection Biblioteca



@itemize -

@item 
gh-133967@footnote{https://github.com/python/cpython/issues/133967}: Não normaliza o nome @ref{86,,locale} ‘C.UTF-8’ para ‘en_US.UTF-8’.

@item 
gh-135326@footnote{https://github.com/python/cpython/issues/135326}: Restore support of integer-like objects with @code{__index__()}
in @ref{1043,,random.getrandbits()}.

@item 
gh-135321@footnote{https://github.com/python/cpython/issues/135321}: Levanta uma exceção correta para valores maiores que 0x7fffffff para o opcode @code{BINSTRING} na implementação C de @ref{a6,,pickle}.

@item 
gh-135276@footnote{https://github.com/python/cpython/issues/135276}: Correções de bugs retroportadas em zipfile.Path do zipp 3.23. Corrigidas @code{.name}, @code{.stem} e outras propriedades baseadas em basename no Windows ao trabalhar com um arquivo zip em disco.

@item 
gh-134151@footnote{https://github.com/python/cpython/issues/134151}: @ref{3b,,email}: Corrige @ref{2c3,,TypeError} em @ref{161c,,email.utils.decode_params()} ao classificar continuações 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} que contêm uma seção não numerada.

@item 
gh-134152@footnote{https://github.com/python/cpython/issues/134152}: @ref{3b,,email}: Corrige análise de ID de mensagem de e-mail com domínio inválido.

@item 
gh-127081@footnote{https://github.com/python/cpython/issues/127081}: Corrige problemas de segurança do thread libc com @ref{a1,,os} substituindo @code{getlogin} pela versão reentrante @code{getlogin_r}.

@item 
gh-131884@footnote{https://github.com/python/cpython/issues/131884}: Corrige problemas de formatação em @ref{d67,,json.dump()} quando `indent' e `skipkeys' são usados.
@end itemize

@node Núcleo e embutidos<7>,API C<4>,Biblioteca<8>,Python 3 13 5 final
@anchor{whatsnew/changelog id36}@anchor{161d}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-135171@footnote{https://github.com/python/cpython/issues/135171}: Roll back changes to generator and list comprehensions that
went into 3.13.4 to fix gh-127682@footnote{https://github.com/python/cpython/issues/127682}, but which involved semantic and
bytecode changes not appropriate for a bugfix release.
@end itemize

@node API C<4>,,Núcleo e embutidos<7>,Python 3 13 5 final
@anchor{whatsnew/changelog id37}@anchor{161e}
@subsubsection API C



@itemize -

@item 
gh-134989@footnote{https://github.com/python/cpython/issues/134989}: Corrige as macros @code{Py_RETURN_NONE}, @code{Py_RETURN_TRUE} e @code{Py_RETURN_FALSE} na API C limitada 3.11 e anteriores: não trata @code{Py_None}, @code{Py_True} e @code{Py_False} como imortais. Patch por Victor Stinner.

@item 
gh-134989@footnote{https://github.com/python/cpython/issues/134989}: Implementa @ref{161f,,PyObject_DelAttr()} e @ref{1620,,PyObject_DelAttrString()} como macros na API C limitada 3.12 e anteriores. Patch por Victor Stinner.
@end itemize

@node Python 3 13 4 final,Python 3 13 3 final,Python 3 13 5 final,Changelog
@anchor{whatsnew/changelog python-3-13-4-final}@anchor{1621}
@subsection Python 3.13.4 final


`Release date: 2025-06-03'

@menu
* Windows: Windows<5>. 
* Testes: Testes<6>. 
* Segurança: Segurança<6>. 
* Biblioteca: Biblioteca<9>. 
* IDLE: IDLE<5>. 
* Documentação: Documentação<5>. 
* Biblioteca: Biblioteca<10>. 
* Núcleo e embutidos: Núcleo e embutidos<8>. 
* Biblioteca: Biblioteca<11>. 
* Núcleo e embutidos: Núcleo e embutidos<9>. 
* API C: API C<5>. 
* Construção: Construção<4>. 

@end menu

@node Windows<5>,Testes<6>,,Python 3 13 4 final
@anchor{whatsnew/changelog id38}@anchor{1622}
@subsubsection Windows



@itemize -

@item 
gh-130727@footnote{https://github.com/python/cpython/issues/130727}: Corrige uma corrida em chamadas internas para o WMI que pode resultar em uma exceção de “identificador inválido” sob carga alta. Patch por Chris Eibl.

@item 
gh-76023@footnote{https://github.com/python/cpython/issues/76023}: Faz com que @ref{225,,os.path.realpath()} ignore o erro 1005 do Windows quando estiver no modo não estrito.

@item 
gh-133626@footnote{https://github.com/python/cpython/issues/133626}: Garante que os pacotes não sejam acidentalmente agrupados no instalador tradicional.

@item 
gh-133512@footnote{https://github.com/python/cpython/issues/133512}: Add warnings to @ref{5be,,Inicializador Python para Windows} about use of subcommands
belonging to the Python install manager.
@end itemize

@node Testes<6>,Segurança<6>,Windows<5>,Python 3 13 4 final
@anchor{whatsnew/changelog id39}@anchor{1623}
@subsubsection Testes



@itemize -

@item 
gh-133744@footnote{https://github.com/python/cpython/issues/133744}: Corrigido o teste de interrupção de multiprocessamento. Adicionado um evento para sincronizar o processo pai com o processo filho: aguardar até que o processo filho comece a hibernar. Patch por Victor Stinner.

@item 
gh-133639@footnote{https://github.com/python/cpython/issues/133639}: Corrige @code{TestPyReplAutoindent.test_auto_indent_default()} não executar @code{input_code}.

@item 
gh-133131@footnote{https://github.com/python/cpython/issues/133131}: O ambiente de testes do iOS agora selecionará o dispositivo “classe SE” lançado mais recentemente para testes, caso um dispositivo não seja especificado explicitamente.

@item 
gh-109981@footnote{https://github.com/python/cpython/issues/109981}: O auxiliar de teste que conta a lista de descritores de arquivo abertos agora usa a abordagem otimizada @code{/dev/fd} em todas as plataformas Apple, não apenas no macOS. Isso evita travamentos causados por descritores de arquivo protegidos.
@end itemize

@node Segurança<6>,Biblioteca<9>,Testes<6>,Python 3 13 4 final
@anchor{whatsnew/changelog id40}@anchor{1624}
@subsubsection Segurança



@itemize -

@item 
gh-135034@footnote{https://github.com/python/cpython/issues/135034}: Corrige vários problemas que permitiam que os filtros de extração @code{tarfile} (@code{filter="data"} e @code{filter="tar"}) fossem ignorados usando links simbólicos e links físicos criados.

Endereços 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718}, 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4138
CVE 2025-4138@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4138}, 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4330
CVE 2025-4330@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4330} e 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4517
CVE 2025-4517@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4517}.

@item 
gh-133767@footnote{https://github.com/python/cpython/issues/133767}: Corrige uso após liberação no decodificador “unicode-escape” com um tratador de erros não “estrito”.

@item 
gh-128840@footnote{https://github.com/python/cpython/issues/128840}: Faz um curto-circuito no processamento de endereços IPv6 longos no início de @ref{80,,ipaddress} para evitar consumo excessivo de memória e uma pequena negação de serviço.
@end itemize

@node Biblioteca<9>,IDLE<5>,Segurança<6>,Python 3 13 4 final
@anchor{whatsnew/changelog id41}@anchor{1625}
@subsubsection Biblioteca



@itemize -

@item 
gh-134718@footnote{https://github.com/python/cpython/issues/134718}: @ref{8ea,,ast.dump()} agora só omite os valores @code{None} e @code{[]} se forem valores padrão.

@item 
gh-128840@footnote{https://github.com/python/cpython/issues/128840}: Corrige a análise de endereços IPv6 longos com endereço IPv4 incorporado.

@item 
gh-134696@footnote{https://github.com/python/cpython/issues/134696}: Implementações HACL* e OpenSSL embutidas de construtores de funções hash agora aceitam corretamente os mesmos argumentos nomeados `documentados'. Por exemplo, @ref{1626,,md5()} podia ser invocado anteriormente como @code{md5(data=data)} ou @code{md5(string=string)} dependendo da implementação subjacente, mas essas chamadas não eram compatíveis. Patch por Bénédikt Tran.

@item 
gh-134210@footnote{https://github.com/python/cpython/issues/134210}: @ref{1627,,curses.window.getch()} agora manipula sinais corretamente. Patch por Bénédikt Tran.

@item 
gh-80334@footnote{https://github.com/python/cpython/issues/80334}: @ref{1628,,multiprocessing.freeze_support()} agora verifica o trabalho em qualquer plataforma de método de inicialização “spawn”, em vez de apenas no Windows.

@item 
gh-114177@footnote{https://github.com/python/cpython/issues/114177}: Corrige @ref{a,,asyncio} para não fechar encadeamentos de subprocesso, o que de outra forma geraria erro quando o laço de eventos já estivesse fechado.

@item 
gh-134152@footnote{https://github.com/python/cpython/issues/134152}: Corrigida @ref{157f,,UnboundLocalError} que poderia ocorrer durante a análise do cabeçalho @ref{3b,,email} se um delimitador final esperado estivesse faltando em alguns contextos.

@item 
gh-62184@footnote{https://github.com/python/cpython/issues/62184}: Remove a importação da implementação C de @ref{1354,,io.FileIO} da implementação Python que tem sua própria implementação

@item 
gh-133982@footnote{https://github.com/python/cpython/issues/133982}: Emite @ref{1bd,,RuntimeWarning} na implementação Python de @ref{7f,,io} quando o @ref{1203,,objeto arquivo ou similar} não for fechado explicitamente na presença de múltiplas camadas de E/S.

@item 
gh-133890@footnote{https://github.com/python/cpython/issues/133890}: O módulo @ref{de,,tarfile} agora manipula @ref{677,,UnicodeEncodeError} da mesma forma que @ref{417,,OSError} quando não é possível extrair um membro.

@item 
gh-134097@footnote{https://github.com/python/cpython/issues/134097}: Corrige interação da @ref{16a,,REPL} e a nova opção de linha de comando @ref{176,,-X showrefcount}.

@item 
gh-133889@footnote{https://github.com/python/cpython/issues/133889}: A página de listagem de diretório gerada em @ref{b56,,http.server.SimpleHTTPRequestHandler} agora mostra apenas o componente do caminho decodificado da URL solicitada, e não a consulta e o fragmento.

@item 
gh-134098@footnote{https://github.com/python/cpython/issues/134098}: Corrige caminhos de manipulação que terminam com uma barra codificada em porcentagem (@code{%2f} ou @code{%2F}) em @ref{b56,,http.server.SimpleHTTPRequestHandler}.

@item 
gh-134062@footnote{https://github.com/python/cpython/issues/134062}: @ref{80,,ipaddress}: corrige colisões em @ref{b0e,,__hash__()} para objetos @ref{1fe,,IPv4Network} e @ref{1ff,,IPv6Network}.

@item 
gh-133745@footnote{https://github.com/python/cpython/issues/133745}: In 3.13.3 we accidentally changed the signature of the asyncio
@code{create_task()} family of methods and how it calls a custom task factory
in a backwards incompatible way. Since some 3rd party libraries have
already made changes to work around the issue that might break if we
simply reverted the changes, we’re instead changing things to be backwards
compatible with 3.13.2 while still supporting those workarounds for
3.13.3. In particular, the special-casing of @code{name} and @code{context} is
back (until 3.14) and consequently eager tasks may still find that their
name hasn’t been set before they execute their first yielding await.

@item 
gh-71253@footnote{https://github.com/python/cpython/issues/71253}: Levanta @ref{202,,ValueError} em @ref{51c,,open()} se `opener' retornar um descritor de arquivo negativo na implementação Python de @ref{7f,,io} para corresponder à implementação C.

@item 
gh-77057@footnote{https://github.com/python/cpython/issues/77057}: Corrige o tratamento de declarações de marcação inválidas em @ref{87b,,html.parser.HTMLParser}.

@item 
gh-133489@footnote{https://github.com/python/cpython/issues/133489}: @ref{1043,,random.getrandbits()} agora pode gerar mais de 2@w{^31} bits. @ref{1629,,random.randbytes()} agora pode gerar mais de 256 MiB.

@item 
gh-133290@footnote{https://github.com/python/cpython/issues/133290}: Corrige problema de armazenamento em cache de atributo ao definir @ref{162a,,ctypes._Pointer._type_} na função não documentada e descontinuada @code{ctypes.SetPointerType()} e no método não documentado @code{set_type()}.

@item 
gh-132876@footnote{https://github.com/python/cpython/issues/132876}: @code{ldexp()} no Windows não arredonda resultados abaixo do normal antes do Windows 11, mas deveria. O invólucro de @ref{162b,,math.ldexp()} do Python agora os arredonda, então os resultados podem mudar um pouco, em casos raros de resultados muito pequenos, em versões do Windows anteriores à 11.

@item 
gh-133089@footnote{https://github.com/python/cpython/issues/133089}: Usa o valor de tempo limite original para @ref{15ce,,subprocess.TimeoutExpired} quando a função @ref{b9e,,subprocess.run()} for chamada com um tempo limite em vez de, às vezes, um valor de tempo limite parcial restante confuso usado internamente no @code{wait()} final.

@item 
gh-133009@footnote{https://github.com/python/cpython/issues/133009}: @ref{125,,xml.etree.ElementTree}: Corrige uma falha em @ref{15fd,,Element.__deepcopy__} quando o elemento sofre mutação simultânea. Patch por Bénédikt Tran.

@item 
gh-132995@footnote{https://github.com/python/cpython/issues/132995}: Aumenta a versão do pip incluído no EnsurePip para a versão 25.1.1

@item 
gh-132017@footnote{https://github.com/python/cpython/issues/132017}: Corrige erro quando @code{pyrepl} é suspenso e depois retomado e encerrado.

@item 
gh-132673@footnote{https://github.com/python/cpython/issues/132673}: Corrige uma falha ao usar @code{_align_ = 0} e @code{_fields_ = []} em uma @ref{1d4,,ctypes.Structure}.

@item 
gh-132527@footnote{https://github.com/python/cpython/issues/132527}: Inclui o typecode válido ‘w’ na mensagem de erro quando um typecode inválido for passado para @ref{1a0,,array.array}.

@item 
gh-132439@footnote{https://github.com/python/cpython/issues/132439}: Corrigido @code{PyREPL} no Windows: caracteres inseridos via AltGr são engolidos. Patch por Chris Eibl.

@item 
gh-132429@footnote{https://github.com/python/cpython/issues/132429}: Corrige o suporte de soquetes Bluetooth no NetBSD e no DragonFly BSD.

@item 
gh-132106@footnote{https://github.com/python/cpython/issues/132106}: @ref{162c,,QueueListener.start} agora levanta uma @ref{195,,RuntimeError} se o listener já estiver iniciado.

@item 
gh-132417@footnote{https://github.com/python/cpython/issues/132417}: Corrige uma desreferência de ponteiro @code{NULL} quando uma função C chamada usando @ref{2a,,ctypes} com @code{restype} @ref{147f,,py_object} retorna @code{NULL}.

@item 
gh-132385@footnote{https://github.com/python/cpython/issues/132385}: Corrige sugestões de erro de instância que acionam possíveis exceções em @ref{4d3,,object.__getattr__()} em @ref{fe,,traceback}.

@item 
gh-132308@footnote{https://github.com/python/cpython/issues/132308}: Uma exceção @ref{25c,,traceback.TracebackException} agora renderiza corretamente os atributos @code{__context__} e @code{__cause__} da @ref{9e2,,Exception} @ref{162d,,falsa}, e o atributo @code{exceptions} de falsey @ref{1b6,,ExceptionGroup}.

@item 
gh-132250@footnote{https://github.com/python/cpython/issues/132250}: Corrigida a @ref{575,,SystemError} em @ref{27,,cProfile} quando localizar a função C real de um método levanta uma exceção.

@item 
gh-132063@footnote{https://github.com/python/cpython/issues/132063}: Evita que exceções avaliadas como falsas (ou seja, quando o método @code{__bool__} retorna @code{False} ou o método @code{__len__} retorna 0) sejam ignoradas por @ref{8f4,,concurrent.futures.ProcessPoolExecutor} e @ref{742,,concurrent.futures.ThreadPoolExecutor}.

@item 
gh-119605@footnote{https://github.com/python/cpython/issues/119605}: Respeita @code{follow_wrapped} para os métodos @code{__init__()} e @code{__new__()} ao obter a assinatura de classe para uma classe com @ref{738,,inspect.signature()}. Preserva a assinatura de classe após o encapsulamento com @ref{160,,warnings.deprecated()}. Patch por Xuehai Pan.

@item 
gh-91555@footnote{https://github.com/python/cpython/issues/91555}: Ignora mensagens de log geradas durante o tratamento de mensagens de log para evitar impasse ou recursão infinita. [NOTA: Eta alteração foi revertida posteriormente.]

@item 
gh-131434@footnote{https://github.com/python/cpython/issues/131434}: Melhora o relatório de erros para formato incorreto em @ref{1474,,time.strptime()}.

@item 
gh-131127@footnote{https://github.com/python/cpython/issues/131127}: Sistemas que usam LibreSSL agora são construídos com sucesso.

@item 
gh-130999@footnote{https://github.com/python/cpython/issues/130999}: Evita sair do novo REPL e oferece sugestões mesmo se houver candidatos que não sejam strings quando ocorrerem erros.

@item 
gh-130941@footnote{https://github.com/python/cpython/issues/130941}: Corrige @ref{1c8,,configparser.ConfigParser} analisando interpolação vazia com @code{allow_no_value} definido como @code{True}.

@item 
gh-129098@footnote{https://github.com/python/cpython/issues/129098}: Corrige o relatório de traceback do REPL ao usar @ref{192,,compile()} com um arquivo inexistente. Patch por Bénédikt Tran.

@item 
gh-130631@footnote{https://github.com/python/cpython/issues/130631}: @code{http.cookiejar.join_header_words()} agora é mais semelhante à versão original do Perl. Agora, ele coloca aspas o mesmo conjunto de caracteres e sempre coloca aspas em valores que terminam com @code{"\n"}.

@item 
gh-129719@footnote{https://github.com/python/cpython/issues/129719}: Corrige a constante @code{socket.CAN_RAW_ERR_FILTER} ausente no módulo socket em sistemas Linux. Ela estava ausente desde o Python 3.11.

@item 
gh-124096@footnote{https://github.com/python/cpython/issues/124096}: Ativa o modo de terminal virtual e habilita a colagem entre colchetes no REPL no console do Windows. (Se o terminal não oferecer suporte à colagem entre colchetes, habilitá-la não fará nada.)

@item 
gh-122559@footnote{https://github.com/python/cpython/issues/122559}: Remove os métodos @code{__reduce__()} e @code{__reduce_ex__()} que sempre levantam @ref{2c3,,TypeError} na implementação em C de @ref{1354,,io.FileIO}, @ref{124e,,io.BufferedReader}, @ref{13f8,,io.BufferedWriter} e @ref{13f9,,io.BufferedRandom} e substitua-os pelos métodos padrão @code{__getstate__()} que levantam @code{TypeError}. Isso restaura detalhes precisos do comportamento do Python 3.11 e versões anteriores.

@item 
gh-122179@footnote{https://github.com/python/cpython/issues/122179}: @ref{644,,hashlib.file_digest()} agora levanta @ref{1090,,BlockingIOError} quando não há dados disponíveis durante E/S não bloqueantes. Antes, ele adicionava bytes nulos espúrios ao resumo.

@item 
gh-86155@footnote{https://github.com/python/cpython/issues/86155}: @ref{162e,,html.parser.HTMLParser.close()} não perde mais dados quando a tag @code{<script>} não está fechada. Patch por Waylan Limberg.

@item 
gh-69426@footnote{https://github.com/python/cpython/issues/69426}: Corrige @ref{87b,,html.parser.HTMLParser} para não desfazer o escape de entidades de caracteres em valores de atributos se eles forem seguidos por um alfanumérico ASCII ou um sinal de igual.

@item 
bpo-44172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44172}: Mantém uma referência às janelas originais @ref{2b,,curses} nas subjanelas para que a janela original não seja excluída antes das subjanelas.
@end itemize

@node IDLE<5>,Documentação<5>,Biblioteca<9>,Python 3 13 4 final
@anchor{whatsnew/changelog id42}@anchor{162f}
@subsubsection IDLE



@itemize -

@item 
gh-112936@footnote{https://github.com/python/cpython/issues/112936}: corrige IDLE: nenhum item de menu Shell no modo de processo único.
@end itemize

@node Documentação<5>,Biblioteca<10>,IDLE<5>,Python 3 13 4 final
@anchor{whatsnew/changelog id43}@anchor{1630}
@subsubsection Documentação



@itemize -

@item 
gh-107006@footnote{https://github.com/python/cpython/issues/107006}: Move a documentação e o código de exemplo para @ref{1631,,threading.local} da docstring para a documentação oficial.
@end itemize

@node Biblioteca<10>,Núcleo e embutidos<8>,Documentação<5>,Python 3 13 4 final
@anchor{whatsnew/changelog id44}@anchor{1632}
@subsubsection Biblioteca



@itemize -

@item 
gh-134908@footnote{https://github.com/python/cpython/issues/134908}: Corrige falha ao iterar sobre linhas em um arquivo texto na construção com @ref{15e4,,threads livres}.
@end itemize

@node Núcleo e embutidos<8>,Biblioteca<11>,Biblioteca<10>,Python 3 13 4 final
@anchor{whatsnew/changelog id45}@anchor{1633}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-127682@footnote{https://github.com/python/cpython/issues/127682}: Não chama mais @code{__iter__} duas vezes em compreensões de lista. Isso alinha o comportamento das compreensões de lista com outras formas de iteração.
@end itemize

@node Biblioteca<11>,Núcleo e embutidos<9>,Núcleo e embutidos<8>,Python 3 13 4 final
@anchor{whatsnew/changelog id46}@anchor{1634}
@subsubsection Biblioteca



@itemize -

@item 
gh-134381@footnote{https://github.com/python/cpython/issues/134381}: Corrige @ref{195,,RuntimeError} ao usar um @ref{953,,threading.Thread} não iniciado após chamar @ref{197,,os.fork()}
@end itemize

@node Núcleo e embutidos<9>,API C<5>,Biblioteca<11>,Python 3 13 4 final
@anchor{whatsnew/changelog id47}@anchor{1635}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-128066@footnote{https://github.com/python/cpython/issues/128066}: Corrige um caso extremo em que o PyREPL levantava um erro incorretamente quando o Python era invocado em um sistema de arquivos somente leitura ao tentar gravar entradas no arquivo de histórico.

@item 
gh-134100@footnote{https://github.com/python/cpython/issues/134100}: Corrige um bug de uso após liberação que ocorre quando um módulo importado não está em @ref{1636,,sys.modules} após sua importação inicial. Patch por Nico-Posada.

@item 
gh-133703@footnote{https://github.com/python/cpython/issues/133703}: Corrige que a tabela de hash no dicionário pode ser maior do que o pretendido em algumas situações.

@item 
gh-132869@footnote{https://github.com/python/cpython/issues/132869}: Fix crash in the @ref{15e4,,free threading} build when accessing an
object attribute that may be concurrently inserted or deleted.

@item 
gh-132762@footnote{https://github.com/python/cpython/issues/132762}: @ref{1637,,fromkeys()} não entra mais em laço infinito ao adicionar um pequeno conjunto de chaves a um dicionário base grande. Patch por Angela Liss.

@item 
gh-133543@footnote{https://github.com/python/cpython/issues/133543}: Fix a possible memory leak that could occur when directly
accessing instance dictionaries (@code{__dict__}) that later become part of a
reference cycle.

@item 
gh-133516@footnote{https://github.com/python/cpython/issues/133516}: Levanta @ref{202,,ValueError} quando as constantes @code{True}, @code{False} ou @code{None} forem usadas como um identificador após a normalização NFKC.

@item 
gh-133441@footnote{https://github.com/python/cpython/issues/133441}: Fix crash upon setting an attribute with a @ref{256,,dict}
subclass. Patch by Victor Stinner.

@item 
gh-132942@footnote{https://github.com/python/cpython/issues/132942}: Corrige duas corridas no cache de pesquisa de tipos. Isso afetava a construção com threads livres e podia causar travamentos (aparentemente bastante difíceis de acionar).

@item 
gh-132713@footnote{https://github.com/python/cpython/issues/132713}: Corrige a condição de corrida @code{repr(list)}: mantém uma referência forte ao item ao chamar @code{repr(item)}. Patch por Victor Stinner.

@item 
gh-132747@footnote{https://github.com/python/cpython/issues/132747}: Corrige uma falha ao chamar @ref{1530,,__get__()} de um @ref{1638,,method} com um segundo argumento @ref{675,,None}.

@item 
gh-132542@footnote{https://github.com/python/cpython/issues/132542}: Atualiza @ref{a48,,Thread.native_id} após @code{fork(2)@footnote{https://manpages.debian.org/fork(2)}} para garantir a precisão. Patch por Noam Cohen.

@item 
gh-124476@footnote{https://github.com/python/cpython/issues/124476}: Corrige decodificação da codificação local no local C.UTF-8.

@item 
gh-131927@footnote{https://github.com/python/cpython/issues/131927}: Avisos do compilador originados do mesmo módulo e número de linha agora são emitidos apenas uma vez, correspondendo ao comportamento dos avisos emitidos pelo código do usuário. Isso também pode ser configurado com filtros @ref{112,,warnings}.

@item 
gh-127682@footnote{https://github.com/python/cpython/issues/127682}: Não é mais necessário chamar @code{__iter__} duas vezes ao criar e executar uma expressão geradora. A criação de uma expressão geradora a partir de uma expressão não iterável só será levantada quando a expressão geradora for executada. Isso alinha o comportamento das expressões geradoras com outros geradores.

@item 
gh-131878@footnote{https://github.com/python/cpython/issues/131878}: Trata exceções não capturadas no laço de entrada principal para o novo REPL.

@item 
gh-131878@footnote{https://github.com/python/cpython/issues/131878}: Corrige suporte a caracteres Unicode com dois ou mais pontos de código no Windows no novo REPL.

@item 
gh-130804@footnote{https://github.com/python/cpython/issues/130804}: Corrige suporte a caracteres Unicode no Windows no novo REPL.

@item 
gh-130070@footnote{https://github.com/python/cpython/issues/130070}: Corrigido um erro de asserção para @ref{17f,,exec()} passando uma string @code{source} e uma @code{closure} não @code{None}. Patch por Bartosz Sławecki.

@item 
gh-129958@footnote{https://github.com/python/cpython/issues/129958}: Corrige um bug que permitia quebras de linha inconsistentes em especificadores de formato para f-strings entre aspas simples. Patch por Pablo Galindo.
@end itemize

@node API C<5>,Construção<4>,Núcleo e embutidos<9>,Python 3 13 4 final
@anchor{whatsnew/changelog id48}@anchor{1639}
@subsubsection API C



@itemize -

@item 
gh-132909@footnote{https://github.com/python/cpython/issues/132909}: Corrige um estouro ao manipular o formato @ref{163a,,K} em @ref{8ac,,Py_BuildValue()}. Patch por Bénédikt Tran.
@end itemize

@node Construção<4>,,API C<5>,Python 3 13 4 final
@anchor{whatsnew/changelog id49}@anchor{163b}
@subsubsection Construção



@itemize -

@item 
gh-134923@footnote{https://github.com/python/cpython/issues/134923}: As construções do Windows com otimização guiada por perfil habilitada agora usam @code{/GENPROFILE} e @code{/USEPROFILE} em vez das opções descontinuadas @code{/LTCG:}.

@item 
gh-133183@footnote{https://github.com/python/cpython/issues/133183}: Os shims do compilador iOS agora incluem @code{IPHONEOS_DEPLOYMENT_TARGET} em triplos de destino, garantindo que os mínimos da versão do SDK sejam respeitados.

@item 
gh-133167@footnote{https://github.com/python/cpython/issues/133167}: Corrige o processo de compilação com @code{--enable-optimizations} e @code{--without-docstrings}.

@item 
gh-132649@footnote{https://github.com/python/cpython/issues/132649}: O script @code{PClayout} agora permite passar @code{--include-tcltk} no Windows ARM64.

@item 
gh-117088@footnote{https://github.com/python/cpython/issues/117088}: O ligador AIX não oferece suporte à opção -h, portanto, evita-a por meio da verificação da plataforma

@item 
gh-132026@footnote{https://github.com/python/cpython/issues/132026}: Corrige o uso de identificadores indefinidos na detecção de tripletos de plataforma em plataformas MIPS Linux.
@end itemize

@node Python 3 13 3 final,Python 3 13 2 final,Python 3 13 4 final,Changelog
@anchor{whatsnew/changelog python-3-13-3-final}@anchor{163c}
@subsection Python 3.13.3 final


`Data de lançamento: 2025-04-08'

@menu
* macOS: macOS<3>. 
* Windows: Windows<6>. 
* Ferramentas/Demos: Ferramentas/Demos<5>. 
* Testes: Testes<7>. 
* Segurança: Segurança<7>. 
* Biblioteca: Biblioteca<12>. 
* IDLE: IDLE<6>. 
* Documentação: Documentação<6>. 
* Núcleo e embutidos: Núcleo e embutidos<10>. 
* Biblioteca: Biblioteca<13>. 
* Núcleo e embutidos: Núcleo e embutidos<11>. 
* API C: API C<6>. 
* Construção: Construção<5>. 

@end menu

@node macOS<3>,Windows<6>,,Python 3 13 3 final
@anchor{whatsnew/changelog id50}@anchor{163d}
@subsubsection macOS



@itemize -

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: Atualiza o instalador do macOS para usar o Tcl/Tk 8.6.16.

@item 
gh-131423@footnote{https://github.com/python/cpython/issues/131423}: Atualiza o instalador do macOS para usar o OpenSSL 3.0.16. Patch por Bénédikt Tran.

@item 
gh-131025@footnote{https://github.com/python/cpython/issues/131025}: Atualiza o instalador do macOS para ser fornecido com o SQLite 3.49.1.

@item 
gh-91132@footnote{https://github.com/python/cpython/issues/91132}: Atualiza o instalador do macOS para usar o ncurses 6.5.
@end itemize

@node Windows<6>,Ferramentas/Demos<5>,macOS<3>,Python 3 13 3 final
@anchor{whatsnew/changelog id51}@anchor{163e}
@subsubsection Windows



@itemize -

@item 
gh-131423@footnote{https://github.com/python/cpython/issues/131423}: Atualiza a versão empacotada do OpenSSL para 3.0.16. A nova construção também desabilita o suporte a uplink, o que pode ser relevante para incorporadores, mas não tem impacto no uso normal.

@item 
gh-131025@footnote{https://github.com/python/cpython/issues/131025}: Atualiza o instalador do Windows para ser fornecido com o SQLite 3.49.1.

@item 
gh-131020@footnote{https://github.com/python/cpython/issues/131020}: pylauncher@footnote{https://github.com/python/cpython/tree/3.13/PC/launcher2.c} detecta corretamente um BOM ao procurar pelo shebang. Correção por Chris Eibl.
@end itemize

@node Ferramentas/Demos<5>,Testes<7>,Windows<6>,Python 3 13 3 final
@anchor{whatsnew/changelog id52}@anchor{163f}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-131852@footnote{https://github.com/python/cpython/issues/131852}: @code{msgfmt} não adiciona mais @code{POT-Creation-Date} aos arquivos @code{.mo} gerados para consistência com GNU @code{msgfmt}.

@item 
gh-85012@footnote{https://github.com/python/cpython/issues/85012}: Redefine corretamente @code{msgctxt} ao compilar mensagens em @code{msgfmt}.

@item 
gh-130025@footnote{https://github.com/python/cpython/issues/130025}: O ambiente de teste do iOS agora manipula corretamente links simbólicos usados como referências de framework Python.
@end itemize

@node Testes<7>,Segurança<7>,Ferramentas/Demos<5>,Python 3 13 3 final
@anchor{whatsnew/changelog id53}@anchor{1640}
@subsubsection Testes



@itemize -

@item 
gh-131050@footnote{https://github.com/python/cpython/issues/131050}: @code{test_ssl.test_dh_params} é ignorado se a biblioteca TLS subjacente não oferecer suporte a Diffie-Hellman efêmero de campo finito.

@item 
gh-129200@footnote{https://github.com/python/cpython/issues/129200}: Agora, vários executores do ambiente de testes do iOS podem ser iniciados ao mesmo tempo sem gerar ambiguidade sobre a propriedade do simulador.

@item 
gh-130292@footnote{https://github.com/python/cpython/issues/130292}: O banco de testes do iOS agora será executado com sucesso em uma máquina que não executou testes do Xcode anteriormente (como configurações de CI).

@item 
gh-130293@footnote{https://github.com/python/cpython/issues/130293}: Os testes de colorização terminal não são mais sensíveis ao valor da variável @code{TERM} no ambiente de teste.

@item 
gh-126332@footnote{https://github.com/python/cpython/issues/126332}: Adiciona testes de unidade para pyrepl.
@end itemize

@node Segurança<7>,Biblioteca<12>,Testes<7>,Python 3 13 3 final
@anchor{whatsnew/changelog id54}@anchor{1641}
@subsubsection Segurança



@itemize -

@item 
gh-131809@footnote{https://github.com/python/cpython/issues/131809}: Atualiza libexpat empacotado para 2.7.1

@item 
gh-131261@footnote{https://github.com/python/cpython/issues/131261}: Atualiza para libexpat 2.7.0

@item 
gh-127371@footnote{https://github.com/python/cpython/issues/127371}: Evita buffering ilimitado para @code{tempfile.SpooledTemporaryFile.writelines()}. Anteriormente, o spillover de disco era verificado somente após o iterador de linhas ter sido esgotado. Agora, isso é feito após cada linha ser escrita.

@item 
gh-121284@footnote{https://github.com/python/cpython/issues/121284}: Corrige bug na dobragem (`folding') de palavras codificadas do rfc2047 ao achatar uma mensagem de e-mail usando uma política de e-mail moderna. Anteriormente, quando uma palavra codificada era muito longa para uma linha, ela era decodificada, dividida em linhas e recodificada. Mas vírgulas e outros caracteres especiais no texto original podiam ser deixados sem codificação e sem aspas. Isso poderia teoricamente ser usado para falsificar linhas de cabeçalho usando uma palavra codificada cuidadosamente construída se o e-mail renderizado resultante fosse transmitido ou reanalisado.
@end itemize

@node Biblioteca<12>,IDLE<6>,Segurança<7>,Python 3 13 3 final
@anchor{whatsnew/changelog id55}@anchor{1642}
@subsubsection Biblioteca



@itemize -

@item 
gh-132174@footnote{https://github.com/python/cpython/issues/132174}: Corrige o nome da função na mensagem de erro @code{_interpreters.run_string}.

@item 
gh-132171@footnote{https://github.com/python/cpython/issues/132171}: Corrige falha de @code{_interpreters.run_string} em subclasses de string.

@item 
gh-129204@footnote{https://github.com/python/cpython/issues/129204}: Introduz o novo botão de variável de ambiente @code{_PYTHON_SUBPROCESS_USE_POSIX_SPAWN} em @ref{d6,,subprocess} para controlar o uso de @ref{220,,os.posix_spawn()}.

@item 
gh-132159@footnote{https://github.com/python/cpython/issues/132159}: Não oculta argumentos de usuário em @code{__new__()} gerado pelo decorador @ref{160,,warnings.deprecated}. Patch por Xuehai Pan.

@item 
gh-132075@footnote{https://github.com/python/cpython/issues/132075}: Corrige possível uso de estruturas de endereço @ref{cc,,socket} com membros não inicializados. Agora, todos os membros da estrutura são inicializados com zeros por padrão.

@item 
gh-132002@footnote{https://github.com/python/cpython/issues/132002}: Corrige falha ao desalocar @ref{1643,,contextvars.ContextVar} com nomes de strings estranhos e não hasheáveis.

@item 
gh-131668@footnote{https://github.com/python/cpython/issues/131668}: @ref{cc,,socket}: Corrige código que analisa endereços de soquete AF_BLUETOOTH.

@item 
gh-131492@footnote{https://github.com/python/cpython/issues/131492}: Corrige um vazamento de recursos quando a construção de um @ref{41a,,gzip.GzipFile} com um nome de arquivo falha, por exemplo, ao passar um @code{compresslevel} inválido.

@item 
gh-131325@footnote{https://github.com/python/cpython/issues/131325}: Corrige implementação de fallback do sendfile para drenar dados após gravar no transporte em @ref{a,,asyncio}.

@item 
gh-129843@footnote{https://github.com/python/cpython/issues/129843}: Corrige passagem de argumento incorreta em @ref{d22,,warnings.warn_explicit()}.

@item 
gh-131204@footnote{https://github.com/python/cpython/issues/131204}: Usa a fonte monoespaçada do System Font Stack para suporte multiplataforma em @ref{1644,,difflib.HtmlDiff}.

@item 
gh-130940@footnote{https://github.com/python/cpython/issues/130940}: O atributo @code{PyConfig.use_system_logger}, introduzido no Python 3.13.2, foi removido. A introdução desse atributo introduziu inadvertidamente uma quebra de ABI no macOS e iOS. O uso do registrador do sistema agora é habilitado por padrão no iOS e desabilitado por padrão no macOS.

@item 
gh-131045@footnote{https://github.com/python/cpython/issues/131045}: Corrige problema com @code{__contains__}, valores e pseudomembros para @ref{623,,enum.Flag}.

@item 
gh-130959@footnote{https://github.com/python/cpython/issues/130959}: Corrige implementação puro Python de @ref{616,,datetime.time.fromisoformat()} para rejeitar horários com espaços na parte fracionária (por exemplo, @code{12:34:56.400 +02:00}), correspondendo à implementação C. Patch por Michał Gorny.

@item 
gh-130637@footnote{https://github.com/python/cpython/issues/130637}: Adiciona validação para dados de resposta numérica no método poplib.POP3.stat()

@item 
gh-130461@footnote{https://github.com/python/cpython/issues/130461}: Remova as diretivas @code{.. index::} da documentação do módulo @ref{110,,uuid}. Essas diretivas criaram entradas anteriormente no índice geral para @ref{bbf,,getnode()}, bem como as funções construtoras @ref{bc0,,uuid1()}, @ref{1645,,uuid3()}, @ref{1646,,uuid4()} e @ref{1647,,uuid5()}.

@item 
gh-130379@footnote{https://github.com/python/cpython/issues/130379}: O módulo zipapp agora calcula a lista de arquivos a serem adicionados ao arquivo antes de criá-lo. Isso evita incluir acidentalmente o alvo quando ele está sendo criado no diretório de origem.

@item 
gh-130285@footnote{https://github.com/python/cpython/issues/130285}: Corrige casos extremos para @ref{746,,random.sample()} permitindo que o parâmetro `counts' especifique uma população vazia. Então agora, @code{sample([], 0, counts=[])} e @code{sample('abc', k=0, counts=[0, 0, 0])} ambos dão o mesmo resultado que @code{sample([], 0)}.

@item 
gh-130250@footnote{https://github.com/python/cpython/issues/130250}: Corrige uma regressão em @code{traceback.print_last()}.

@item 
gh-130230@footnote{https://github.com/python/cpython/issues/130230}: Corrige falha em @ref{9da,,pow()} com apenas @ref{29d,,Decimal} terceiro argumento.

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: Reverte uma alteração na versão anterior, tentando tornar preguiçosas algumas importações stdlib usadas no módulo @ref{d6,,subprocess}, pois isso estava causando erros durante os finalizadores @code{__del__} que chamavam métodos como @code{terminate}, @code{kill} ou @code{send_signal}.

@item 
gh-130164@footnote{https://github.com/python/cpython/issues/130164}: Corrigia uma falha ao levantar @ref{2c3,,TypeError} em @ref{1648,,inspect.Signature.bind()} para argumentos somente posicionais fornecidos como nomeados quando um argumento nomeado variável (por exemplo, @code{**kwargs}) está presente.

@item 
gh-130151@footnote{https://github.com/python/cpython/issues/130151}: Corrigir vazamentos de referência em @code{_hashlib.hmac_new()} e @code{_hashlib.hmac_digest()}. Patch por Bénédikt Tran.

@item 
gh-130145@footnote{https://github.com/python/cpython/issues/130145}: Corrige @code{asyncio.AbstractEventloop.run_forever()} quando outro laço já estiver em execução.

@item 
gh-129726@footnote{https://github.com/python/cpython/issues/129726}: Corrige @ref{41a,,gzip.GzipFile} levantando uma exceção não levantável durante a coleta de lixo ao fazer referência a um objeto temporário, interrompendo o laço de referências com @ref{114,,weakref}.

@item 
gh-127750@footnote{https://github.com/python/cpython/issues/127750}: Remove armazenamento em cache quebrado de @ref{9f8,,functools.singledispatchmethod()} introduzido em gh-85160@footnote{https://github.com/python/cpython/issues/85160}.

@item 
gh-129583@footnote{https://github.com/python/cpython/issues/129583}: Atualiza pip empacotado para 25.0.1

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: Atualiza o aviso de descontinuação de @ref{86d,,importlib.abc.Loader.load_module()}.

@item 
gh-129646@footnote{https://github.com/python/cpython/issues/129646}: Atualiza o mapeamento de apelido de localidade no módulo @ref{86,,locale} para corresponder ao mapeamento de apelido de localidade mais recente do X Org e oferecer suporte a novas localidades no Glibc 2.41.

@item 
gh-129603@footnote{https://github.com/python/cpython/issues/129603}: Corrige bugs onde objetos @ref{ea0,,sqlite3.Row} poderiam sofrer segfault se seu @ref{1649,,description} herdado fosse definido como @code{None}. Patch por Erlend Aasland.

@item 
gh-128231@footnote{https://github.com/python/cpython/issues/128231}: A execução de múltiplas instruções no novo REPL agora para imediatamente após a primeira exceção encontrada. Patch por Bartosz Sławecki.

@item 
gh-117779@footnote{https://github.com/python/cpython/issues/117779}: Corrigida a leitura de entradas duplicadas em @ref{131,,zipfile} por nome. A leitura de entradas duplicadas (exceto a última) por @code{ZipInfo} agora emite um aviso em vez de levantar uma exceção.

@item 
gh-128772@footnote{https://github.com/python/cpython/issues/128772}: Corrige @ref{b5,,pydoc} para métodos com o atributo @code{__module__} igual a @code{None}.

@item 
gh-92897@footnote{https://github.com/python/cpython/issues/92897}: Foi agendada a descontinuação do argumento @code{check_home} de @ref{2dd,,sysconfig.is_python_build()} para o Python 3.15.

@item 
gh-128657@footnote{https://github.com/python/cpython/issues/128657}: Corrige possível referência extra ao usar objetos retornados por @ref{164a,,hashlib.sha256()} em @ref{15e4,,threads livres}.

@item 
gh-128703@footnote{https://github.com/python/cpython/issues/128703}: Corrige @ref{208,,mimetypes.guess_type()} para usar o mapeamento padrão para @code{Content-Type} vazio no registro.

@item 
gh-128308@footnote{https://github.com/python/cpython/issues/128308}: Adiciona suporte ao argumento nomeado `name' para tarefas ansiosas em @ref{1c0,,asyncio.loop.create_task()}, @ref{1bf,,asyncio.create_task()} e @ref{1bc,,asyncio.TaskGroup.create_task()}, passando todos os `kwargs' para a fábrica de tarefas definida por @ref{dee,,asyncio.loop.set_task_factory()}.

@item 
gh-128388@footnote{https://github.com/python/cpython/issues/128388}: Corrige @code{PyREPL} no Windows para oferecer suporte a mais atalhos de teclado, como os atalhos de teclado para pular palavras @code{Control}-@code{←} e @code{Control}-@code{→} e aqueles com meta (isto é, @code{Alt}), por exemplo, @code{Alt}-@code{d} para @code{kill-word} ou @code{Alt}-@code{Backspace} para @code{backward-kill-word}.

@item 
gh-126037@footnote{https://github.com/python/cpython/issues/126037}: @ref{125,,xml.etree.ElementTree}: Corrige uma falha em @ref{164b,,Element.find}, @ref{164c,,Element.findtext} e @ref{164d,,Element.findall} quando a tag a ser encontrada implementa um método @ref{b0d,,__eq__()} que altera o elemento que está sendo consultado. Patch por Bénédikt Tran.

@item 
gh-127712@footnote{https://github.com/python/cpython/issues/127712}: Corrige o tratamento do argumento @code{secure} de @ref{164e,,logging.handlers.SMTPHandler}.

@item 
gh-126033@footnote{https://github.com/python/cpython/issues/126033}: @ref{125,,xml.etree.ElementTree}: Corrige uma falha em @ref{164f,,Element.remove} quando o elemento é mutado simultaneamente. Patch por Bénédikt Tran.

@item 
gh-118201@footnote{https://github.com/python/cpython/issues/118201}: Falhas intermitentes corrigidas de @ref{1650,,os.confstr}, @ref{113a,,os.pathconf} e @ref{1651,,os.sysconf} no iOS e no Android.

@item 
gh-124927@footnote{https://github.com/python/cpython/issues/124927}: Caracteres não imprimíveis agora são manipulados corretamente no novo REPL.
@end itemize

@node IDLE<6>,Documentação<6>,Biblioteca<12>,Python 3 13 3 final
@anchor{whatsnew/changelog id56}@anchor{1652}
@subsubsection IDLE



@itemize -

@item 
gh-129873@footnote{https://github.com/python/cpython/issues/129873}: Simplifica a exibição da documentação do IDLE copiando apenas a seção de texto de idle.html para idlelib/help.html. Patch por Stan Ulbrych.
@end itemize

@node Documentação<6>,Núcleo e embutidos<10>,IDLE<6>,Python 3 13 3 final
@anchor{whatsnew/changelog id57}@anchor{1653}
@subsubsection Documentação



@itemize -

@item 
gh-131417@footnote{https://github.com/python/cpython/issues/131417}: Menciona @ref{be6,,asyncio.Future} e @ref{1be,,asyncio.Task} na lista de classes genéricas.

@item 
gh-125722@footnote{https://github.com/python/cpython/issues/125722}: Requer Sphinx 8.2.0 ou posterior para construir a documentação do Python. Patch por Adam Turner.

@item 
gh-129712@footnote{https://github.com/python/cpython/issues/129712}: As tags de wheels suportadas por cada opção do macOS Universal SDK agora estão documentadas.

@item 
gh-46236@footnote{https://github.com/python/cpython/issues/46236}: API C: Documenta @ref{1654,,PyUnicode_RSplit()}, @ref{1655,,PyUnicode_Partition()} e @ref{1656,,PyUnicode_RPartition()}.
@end itemize

@node Núcleo e embutidos<10>,Biblioteca<13>,Documentação<6>,Python 3 13 3 final
@anchor{whatsnew/changelog id58}@anchor{1657}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-132011@footnote{https://github.com/python/cpython/issues/132011}: Corrige falha ao chamar @code{list.append()} como um método não vinculado.

@item 
gh-131998@footnote{https://github.com/python/cpython/issues/131998}: Corrige uma falha ao usar um objeto de método não vinculado @ref{1658,,descritor} em uma função onde um descritor de método vinculado foi usado.

@item 
gh-131988@footnote{https://github.com/python/cpython/issues/131988}: Corrige uma regressão de desempenho que causava gargalos de dimensionamento na construção de threads livres nas versões 3.13.1 e 3.13.2.

@item 
gh-131719@footnote{https://github.com/python/cpython/issues/131719}: Corrige a falta de verificação de NULL em @code{_PyMem_FreeDelayed} na construção com @ref{15e4,,threads livres}.

@item 
gh-131670@footnote{https://github.com/python/cpython/issues/131670}: Corrige falha em @ref{7d7,,anext()} na sincronização @ref{1659,,__anext__()} levantando uma exceção.

@item 
gh-131141@footnote{https://github.com/python/cpython/issues/131141}: Corrige disputa de dados na instrumentação @ref{da,,sys.monitoring} ao registrar retorno de chamada.

@item 
gh-130932@footnote{https://github.com/python/cpython/issues/130932}: Corrige tratamento de exceção incorreto em @code{_PyModule_IsPossiblyShadowing}

@item 
gh-130851@footnote{https://github.com/python/cpython/issues/130851}: Corrige uma falha na construção com @ref{15e4,,threads livres} ao construir um objeto @ref{1a,,code} com @ref{165a,,co_consts} que contém instâncias de tipos que não são gerados pelo compilador de bytecode.

@item 
gh-130794@footnote{https://github.com/python/cpython/issues/130794}: Corrige vazamento de memória na construção com @ref{15e4,,threads livres} ao redimensionar uma lista ou dicionário compartilhado de vários threads de curta duração.

@item 
gh-130775@footnote{https://github.com/python/cpython/issues/130775}: Não falha em @code{column} negativo e @code{end_column} em locais @ref{8,,ast}.

@item 
gh-130382@footnote{https://github.com/python/cpython/issues/130382}: Corrige @code{PyRefTracer_DESTROY} não sendo enviado de @code{Py_DECREF()} de @code{Python/ceval.c}

@item 
gh-130618@footnote{https://github.com/python/cpython/issues/130618}: Corrige um bug que estava causando o levantamento de @code{UnicodeDecodeError} ou @code{SystemError} ao usar f-strings com expressões @code{lambda} com caracteres não-ASCII. Patch por Pablo Galindo

@item 
gh-130163@footnote{https://github.com/python/cpython/issues/130163}: Corrige possíveis travamentos relacionados à alteração simultânea e ao uso dos atributos do módulo @ref{d9,,sys}.

@item 
gh-88887@footnote{https://github.com/python/cpython/issues/88887}: Corrigindo vazamento do processo de multiprocessamento Resource Tracker, geralmente observado ao executar Python como PID 1.

@item 
gh-130115@footnote{https://github.com/python/cpython/issues/130115}: Corrige um problema com identificadores de thread sendo estendidos por sinal em algumas plataformas.

@item 
gh-128396@footnote{https://github.com/python/cpython/issues/128396}: Corrige uma falha que ocorre ao chamar @ref{141,,locals()} dentro de uma compreensão em linha que usa a mesma variável local que o escopo do quadro externo, onde a variável é uma variável livre ou de célula.

@item 
gh-116042@footnote{https://github.com/python/cpython/issues/116042}: Corrige local para SyntaxErrors de escapes inválidos no tokenizador. Patch por Pablo Galindo
@end itemize

@node Biblioteca<13>,Núcleo e embutidos<11>,Núcleo e embutidos<10>,Python 3 13 3 final
@anchor{whatsnew/changelog id59}@anchor{165b}
@subsubsection Biblioteca



@itemize -

@item 
gh-129983@footnote{https://github.com/python/cpython/issues/129983}: Corrige corrida de dados em compile_template em @code{sre.c}.
@end itemize

@node Núcleo e embutidos<11>,API C<6>,Biblioteca<13>,Python 3 13 3 final
@anchor{whatsnew/changelog id60}@anchor{165c}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-129967@footnote{https://github.com/python/cpython/issues/129967}: Corrige uma condição de corrida na construção com @ref{15e4,,threads livres} quando @code{repr(set)} é chamado simultaneamente com @code{set.clear()}.

@item 
gh-129900@footnote{https://github.com/python/cpython/issues/129900}: Corrige códigos de retorno dentro de @ref{d63,,SystemExit} que não estão sendo retornados pelo REPL.

@item 
gh-129732@footnote{https://github.com/python/cpython/issues/129732}: Corrigida uma corrida em @code{_Py_qsbr_reserve} na construção com threads livres.

@item 
gh-129643@footnote{https://github.com/python/cpython/issues/129643}: Corrige a segurança de thread de @ref{165d,,PyList_Insert()} em construções com threads livres.

@item 
gh-129668@footnote{https://github.com/python/cpython/issues/129668}: Corrige condição de corrida ao levantar @ref{15c5,,MemoryError} na construção com threads livres.

@item 
gh-129643@footnote{https://github.com/python/cpython/issues/129643}: Corrige a segurança de thread de @ref{165e,,PyList_SetItem()} em construções com threads livres. Patch por Kumar Aditya.

@item 
gh-128714@footnote{https://github.com/python/cpython/issues/128714}: Corrige as possíveis corridas nos métodos especiais get/set @code{__annotations__}, @code{__annotate__} e @code{__type_params__} para o objeto função e adiciona testes relacionados.

@item 
gh-128632@footnote{https://github.com/python/cpython/issues/128632}: Não mais permite @code{__classdict__} como nome de um parâmetro de tipo. Usar esse nome anteriormente travava o interpretador em algumas circunstâncias.

@item 
gh-127953@footnote{https://github.com/python/cpython/issues/127953}: O tempo para manipular um evento @code{LINE} em sys.monitoring (e sys.settrace) agora é independente do número de linhas no objeto de código.

@item 
gh-125331@footnote{https://github.com/python/cpython/issues/125331}: @code{from __future__ import barry_as_FLUFL} agora funciona em mais contextos, incluindo quando é usado em arquivos, com o sinalizador @code{-c} e no REPL quando há várias instruções na mesma linha. Anteriormente, funcionava apenas em linhas subsequentes no REPL e quando os sinalizadores apropriados eram passados diretamente para @ref{192,,compile()}. Patch por Pablo Galindo.
@end itemize

@node API C<6>,Construção<5>,Núcleo e embutidos<11>,Python 3 13 3 final
@anchor{whatsnew/changelog id61}@anchor{165f}
@subsubsection API C



@itemize -

@item 
gh-131740@footnote{https://github.com/python/cpython/issues/131740}: Atualiza PyUnstable_GC_VisitObjects para percorrer a geração permanente.

@item 
gh-129533@footnote{https://github.com/python/cpython/issues/129533}: Atualiza @ref{8a8,,PyGC_Enable()}, @ref{8a9,,PyGC_Disable()}, @ref{8aa,,PyGC_IsEnabled()} para usar operação atômica para segurança de thread em construção com threads livres. Patch por Donghee Na.
@end itemize

@node Construção<5>,,API C<6>,Python 3 13 3 final
@anchor{whatsnew/changelog id62}@anchor{1660}
@subsubsection Construção



@itemize -

@item 
gh-131865@footnote{https://github.com/python/cpython/issues/131865}: A construção do DTrace agora passa corretamente as variáveis @code{CC} e @code{CFLAGS} para o comando @code{dtrace} ao utilizar o SystemTap no Linux.

@item 
gh-131675@footnote{https://github.com/python/cpython/issues/131675}: Corrige construções da biblioteca mimalloc para alvos ARM de 32 bits.

@item 
gh-130673@footnote{https://github.com/python/cpython/issues/130673}: Corrige possível erro @code{KeyError} ao manipular seções de objetos durante o processo de construção JIT.

@item 
gh-130740@footnote{https://github.com/python/cpython/issues/130740}: Certifica-se de que @code{Python.h} esteja incluído antes de @code{stdbool.h}, a menos que @code{pyconfig.h} esteja incluído antes ou em alguns contextos específicos da plataforma.

@item 
gh-129838@footnote{https://github.com/python/cpython/issues/129838}: Não redefine @code{_Py_NO_SANITIZE_UNDEFINED} ao compilar com uma versão recente do GCC e um sanitizador indefinido habilitado.

@item 
gh-129660@footnote{https://github.com/python/cpython/issues/129660}: Remove @code{test_embed} do treinamento de PGO, cuja contribuição em versões recentes é considerada ignorável.
@end itemize

@node Python 3 13 2 final,Python 3 13 1 final,Python 3 13 3 final,Changelog
@anchor{whatsnew/changelog python-3-13-2-final}@anchor{1661}
@subsection Python 3.13.2 final


`Data de lançamento: 2025-02-04'

@menu
* macOS: macOS<4>. 
* Windows: Windows<7>. 
* Ferramentas/Demos: Ferramentas/Demos<6>. 
* Testes: Testes<8>. 
* Segurança: Segurança<8>. 
* Biblioteca: Biblioteca<14>. 
* Documentação: Documentação<7>. 
* Biblioteca: Biblioteca<15>. 
* Núcleo e embutidos: Núcleo e embutidos<12>. 
* API C: API C<7>. 
* Construção: Construção<6>. 

@end menu

@node macOS<4>,Windows<7>,,Python 3 13 2 final
@anchor{whatsnew/changelog id63}@anchor{1662}
@subsubsection macOS



@itemize -

@item 
gh-127592@footnote{https://github.com/python/cpython/issues/127592}: O uso das APIs unificadas do Apple System Log foi desabilitado quando a versão mínima do macOS era anterior à 10.12.
@end itemize

@node Windows<7>,Ferramentas/Demos<6>,macOS<4>,Python 3 13 2 final
@anchor{whatsnew/changelog id64}@anchor{1663}
@subsubsection Windows



@itemize -

@item 
gh-127353@footnote{https://github.com/python/cpython/issues/127353}: Permite forçar a saída de cores no Windows usando variáveis de ambiente. Patch por Andrey Efremov.
@end itemize

@node Ferramentas/Demos<6>,Testes<8>,Windows<7>,Python 3 13 2 final
@anchor{whatsnew/changelog id65}@anchor{1664}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-129248@footnote{https://github.com/python/cpython/issues/129248}: O executor de testes do iOS agora remove o prefixo de log de cada linha de saída do conjunto de testes.

@item 
gh-128152@footnote{https://github.com/python/cpython/issues/128152}: Corrige um bug em que o analisador de pré-processador C da Argument Clinic tentava analisar diretivas de pré-processador dentro de comentários C. Patch por Erlend Aasland.
@end itemize

@node Testes<8>,Segurança<8>,Ferramentas/Demos<6>,Python 3 13 2 final
@anchor{whatsnew/changelog id66}@anchor{1665}
@subsubsection Testes



@itemize -

@item 
gh-127906@footnote{https://github.com/python/cpython/issues/127906}: Testa a API C limitada em test_cppext. Patch por Victor Stinner.

@item 
gh-127637@footnote{https://github.com/python/cpython/issues/127637}: Adiciona testes para a interface de linha de comando @ref{38,,dis}. Patch por Bénédikt Tran.

@item 
gh-126925@footnote{https://github.com/python/cpython/issues/126925}: Os resultados dos testes do iOS agora são transmitidos durante a execução do teste, e o xcresulttool descontinuado não é mais usado.
@end itemize

@node Segurança<8>,Biblioteca<14>,Testes<8>,Python 3 13 2 final
@anchor{whatsnew/changelog id67}@anchor{1666}
@subsubsection Segurança



@itemize -

@item 
gh-105704@footnote{https://github.com/python/cpython/issues/105704}: Ao usar @ref{d61,,urllib.parse.urlsplit()} e @ref{30d,,urllib.parse.urlparse()}, a análise de host não rejeitaria nomes de domínio contendo colchetes (@code{[} e @code{]}). Os colchetes são válidos somente para hosts IPv6 e IPvFuture de acordo com RFC 3986 Seção 3.2.2@footnote{https://www.rfc-editor.org/rfc/rfc3986#section-3.2.2}.

@item 
gh-127655@footnote{https://github.com/python/cpython/issues/127655}: Corrigido o transporte de @code{asyncio.selector_events._SelectorSocketTransport} não pausando escritas para o protocolo quando o buffer atinge a marca d’água alta ao usar @ref{15dc,,asyncio.WriteTransport.writelines()}.

@item 
gh-126108@footnote{https://github.com/python/cpython/issues/126108}: Corrige uma possível desreferência de ponteiro @code{NULL} em @code{PySys_AddWarnOptionUnicode()}.

@item 
gh-80222@footnote{https://github.com/python/cpython/issues/80222}: Corrige bug na dobragem `(folding)' de strings entre aspas ao achatar uma mensagem de e-mail usando uma política de e-mail moderna. Anteriormente, quando uma string entre aspas era dobrada para abranger mais de uma linha, as aspas circundantes e escapes internos eram omitidos. Isso poderia, teoricamente, ser usado para fazer `spoof' das linhas de cabeçalho usando uma string entre aspas cuidadosamente construída se o e-mail renderizado resultante fosse transmitido ou reanalisado.

@item 
gh-119511@footnote{https://github.com/python/cpython/issues/119511}: Corrige uma potencial negação de serviço no módulo @ref{74,,imaplib}. Ao conectar-se a um servidor malicioso, isso poderia fazer com que uma quantidade arbitrária de memória fosse alocada. Em muitos sistemas, isso é inofensivo, pois a memória virtual não utilizada é apenas um mapeamento, mas se isso atingir um limite de tamanho de endereço virtual, pode levar a um @ref{15c5,,MemoryError} ou outra falha de processo. Em sistemas ou construções incomuns, onde toda a memória alocada é tocada e apoiada por RAM ou armazenamento real, isso pode ter consumido recursos ao fazer isso até travar de forma semelhante.
@end itemize

@node Biblioteca<14>,Documentação<7>,Segurança<8>,Python 3 13 2 final
@anchor{whatsnew/changelog id68}@anchor{1667}
@subsubsection Biblioteca



@itemize -

@item 
gh-129502@footnote{https://github.com/python/cpython/issues/129502}: Erros improváveis na preparação de argumentos para o retorno de chamada @ref{2a,,ctypes} agora são tratados da mesma forma que erros levantados no retorno de chamada ou na conversão do resultado do retorno de chamada — usando @ref{1f7,,sys.unraisablehook()} em vez de @ref{80e,,sys.excepthook()} e não definindo @ref{4be,,sys.last_exc} e outras variáveis.

@item 
gh-129403@footnote{https://github.com/python/cpython/issues/129403}: Corrigida a mensagem de @ref{202,,ValueError} para @ref{601,,asyncio.Barrier} e @ref{1223,,threading.Barrier}.

@item 
gh-129409@footnote{https://github.com/python/cpython/issues/129409}: Corrige um estouro de inteiro no módulo @ref{29,,csv} ao gravar um campo de dados maior que 2 GB.

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: Melhora o tempo de importação de @ref{d6,,subprocess} importando @code{locale} e @code{signal} de forma preguiçosa. Patch por Taneli Hukkinen.

@item 
gh-129346@footnote{https://github.com/python/cpython/issues/129346}: Em @ref{cf,,sqlite3}, manipula a falta de memória ao criar funções SQL definidas pelo usuário.

@item 
gh-129061@footnote{https://github.com/python/cpython/issues/129061}: Corrige FORCE_COLOR e NO_COLOR quando strings vazias. Patch por Hugo van Kemenade.

@item 
gh-128550@footnote{https://github.com/python/cpython/issues/128550}: Foi removida uma otimização incorreta relacionada a tarefas ansiosas em @ref{1b5,,asyncio.TaskGroup} que resultava em cancelamentos perdidos.

@item 
gh-128991@footnote{https://github.com/python/cpython/issues/128991}: Libera a referência do quadro de entrada dentro do retorno de chamada @ref{f,,bdb}

@item 
gh-128978@footnote{https://github.com/python/cpython/issues/128978}: Corrige uma exceção @ref{43f,,NameError} em @code{sysconfig.expand_makefile_vars()}. Patch por Bénédikt Tran.

@item 
gh-128961@footnote{https://github.com/python/cpython/issues/128961}: Corrige uma falha ao definir o estado em um iterador @ref{1a0,,array.array} esgotado.

@item 
gh-128894@footnote{https://github.com/python/cpython/issues/128894}: Corrige @code{traceback.TracebackException._format_syntax_error} para não falhar em exceções com metadados personalizados.

@item 
gh-128916@footnote{https://github.com/python/cpython/issues/128916}: Não tenta definir @code{SO_REUSEPORT} em soquetes de famílias de endereços diferentes de @code{AF_INET} e @code{AF_INET6}, pois isso não faz sentido com essas famílias de endereços, e a chamada falhará com o kernel Linux 6.12.9 e mais recentes.

@item 
gh-128679@footnote{https://github.com/python/cpython/issues/128679}: Corrige condição de corrida de @ref{1668,,tracemalloc.stop()}. Corrige @ref{ff,,tracemalloc} para oferece suporte à chamada de @ref{1668,,tracemalloc.stop()} em uma thread, enquanto outra thread está rastreando alocações de memória. Patch por Victor Stinner.

@item 
gh-128636@footnote{https://github.com/python/cpython/issues/128636}: Corrige falha do PyREPL quando @ref{11f9,,os.environ} é substituído por um valor inválido.

@item 
gh-128562@footnote{https://github.com/python/cpython/issues/128562}: Corrige possíveis conflitos nos nomes dos widgets @ref{f0,,tkinter} gerados se o nome da classe do widget terminar com um dígito.

@item 
gh-128498@footnote{https://github.com/python/cpython/issues/128498}: Padrão para stdout isatty para detecção de cor em vez de stderr. Patch por Hugo van Kemenade.

@item 
gh-128552@footnote{https://github.com/python/cpython/issues/128552}: Corrige lixo cíclico introduzido por @ref{1c0,,asyncio.loop.create_task()} e @ref{1bc,,asyncio.TaskGroup.create_task()} mantendo uma referência à tarefa criada se ela estiver ansiosa.

@item 
gh-128479@footnote{https://github.com/python/cpython/issues/128479}: Corrige @code{asyncio.staggered.staggered_race()} vazando tarefas e emitindo uma exceção não tratada.

@item 
gh-128400@footnote{https://github.com/python/cpython/issues/128400}: Corrige falha ao usar @ref{e2a,,faulthandler.dump_traceback()} enquanto outras threads estiverem ativas na construção com @ref{15e4,,threads livres}.

@item 
gh-88834@footnote{https://github.com/python/cpython/issues/88834}: Unifica a verificação de instância para @ref{63b,,typing.Union} e @ref{63a,,types.UnionType}: @code{Union} agora usa as verificações de instância em relação aos seus parâmetros em vez das verificações de subclasse.

@item 
gh-128302@footnote{https://github.com/python/cpython/issues/128302}: Corrige @code{xml.dom.xmlbuilder.DOMEntityResolver.resolveEntity()}, que foi quebrado pela transição do Python 3.0.

@item 
gh-128302@footnote{https://github.com/python/cpython/issues/128302}: Permite que @code{xml.dom.xmlbuilder.DOMParser.parse()} manipule corretamente instâncias @code{xml.dom.xmlbuilder.DOMInputSource} que tenham apenas um atributo @code{systemId} definido.

@item 
gh-112064@footnote{https://github.com/python/cpython/issues/112064}: Corrige tratamento incorreto de tamanhos de leitura negativos em @ref{1669,,HTTPResponse.read}. Patch por Yury Manushkin.

@item 
gh-58956@footnote{https://github.com/python/cpython/issues/58956}: Corrigido um vazamento de referência de quadro em @ref{f,,bdb}.

@item 
gh-128131@footnote{https://github.com/python/cpython/issues/128131}: Suporte completo ao acesso aleatório de arquivos zip somente leitura, não criptografados e descompactados obtidos por @ref{41b,,ZipFile.open}.

@item 
gh-112328@footnote{https://github.com/python/cpython/issues/112328}: @ref{1e4,,enum.EnumDict} agora pode ser usada sem recorrer à API privada.

@item 
gh-127975@footnote{https://github.com/python/cpython/issues/127975}: Evita reutilizar tipos de aspas em @ref{8eb,,ast.unparse()} se não for necessário.

@item 
gh-128062@footnote{https://github.com/python/cpython/issues/128062}: Reverte a fonte da barra de menu do @ref{102,,turtledemo} para seu valor padrão e exibe as teclas de atalho na posição correta.

@item 
gh-128014@footnote{https://github.com/python/cpython/issues/128014}: Corrige a redefinição do ícone da janela padrão passando @code{default='@w{'}} para o método @code{wm_iconbitmap()} do @ref{f0,,tkinter}.

@item 
gh-115514@footnote{https://github.com/python/cpython/issues/115514}: Corrige exceções e escritas incompletas após @code{asyncio._SelectorTransport} ser fechado antes das gravações serem concluídas.

@item 
gh-41872@footnote{https://github.com/python/cpython/issues/41872}: Corrige extração rápida de docstrings de módulo de um arquivo em @ref{b5,,pydoc}. Agora ele oferece suporte a docstrings com aspas simples, sequências de escape, literais de strings brutas e outras sintaxes Python.

@item 
gh-127060@footnote{https://github.com/python/cpython/issues/127060}: Define a variável de ambiente TERM como “dumb” para desabilitar cores de traceback no IDLE, já que o IDLE não entende sequências de escape ANSI. Patch por Victor Stinner.

@item 
gh-126742@footnote{https://github.com/python/cpython/issues/126742}: Corrige o suporte de mensagens de erro localizadas relatadas por @code{dlerror(3)@footnote{https://manpages.debian.org/dlerror(3)}} e @code{gdbm_strerror@footnote{https://manpages.debian.org/gdbm(3)}} nas funções @ref{2a,,ctypes} e @ref{33,,dbm.gnu} respectivamente. Patch por Bénédikt Tran.

@item 
gh-127873@footnote{https://github.com/python/cpython/issues/127873}: Quando @code{-E} estiver definido, ignora apenas @code{PYTHON_COLORS} e não @code{FORCE_COLOR}/@code{NO_COLOR}/@code{TERM} ao colorir a saída. Patch por Hugo van Kemenade.

@item 
gh-127870@footnote{https://github.com/python/cpython/issues/127870}: Detecta chamadas recursivas no tratamento de ctypes @code{_as_parameter_}. Patch por Victor Stinner.

@item 
gh-127847@footnote{https://github.com/python/cpython/issues/127847}: Corrige a posição ao fazer buscas e leituras intercaladas em arquivos zip não compactados e não criptografados retornados por @ref{41b,,zipfile.ZipFile.open()}.

@item 
gh-127732@footnote{https://github.com/python/cpython/issues/127732}: O módulo @ref{aa,,platform} agora detecta corretamente o Windows Server 2025.

@item 
gh-126821@footnote{https://github.com/python/cpython/issues/126821}: As aplicações de macOS e iOS agora podem escolher redirecionar stdout e stderr para o log do sistema durante a configuração do interpretador.

@item 
gh-93312@footnote{https://github.com/python/cpython/issues/93312}: Inclui @code{<sys/pidfd.h>} para obter a constante @code{os.PIDFD_NONBLOCK}. Patch por Victor Stinner.

@item 
gh-83662@footnote{https://github.com/python/cpython/issues/83662}: Adiciona o método @code{__class_getitem__} ausente à implementação Python de @ref{414,,functools.partial()}, para torná-lo compatível com a versão C. Isso é relevante principalmente para implementações Python alternativas como PyPy e GraalPy, porque o CPython geralmente usará a implementação C dessa função.

@item 
gh-127586@footnote{https://github.com/python/cpython/issues/127586}: @ref{f9f,,multiprocessing.pool.Pool} agora restaura corretamente os manipuladores de sinais bloqueados da thread mãe ao criar processos via `spawn' ou `forkserver'.

@item 
gh-98188@footnote{https://github.com/python/cpython/issues/98188}: Corrige um problema em @ref{120d,,email.message.Message.get_payload()} onde os dados não podem ser decodificados se o mecanismo de Codificação de Transferência de Conteúdo contiver espaços em branco à direita ou texto lixo adicional. Patch por Hui Liu.

@item 
gh-127257@footnote{https://github.com/python/cpython/issues/127257}: Em @ref{d0,,ssl}, falhas de chamada de sistema que o OpenSSL relata usando @code{ERR_LIB_SYS} agora são levantadas como @ref{417,,OSError}.

@item 
gh-127096@footnote{https://github.com/python/cpython/issues/127096}: Não recria a seção sem nome em cada leitura em @ref{1c8,,configparser.ConfigParser}. Patch por Andrey Efremov.

@item 
gh-127196@footnote{https://github.com/python/cpython/issues/127196}: Corrige falha quando um dicionário com chaves em codificação inválida era passado para diversas funções no módulo @code{_interpreters}.

@item 
gh-126775@footnote{https://github.com/python/cpython/issues/126775}: Torna @ref{166a,,linecache.checkcache()} seguro para thread e seguro para reentrada do GC.

@item 
gh-126332@footnote{https://github.com/python/cpython/issues/126332}: Corrige falha do _pyrepl ao dar dois CTRL-Z em uma linha que transborda.

@item 
gh-126225@footnote{https://github.com/python/cpython/issues/126225}: @ref{61,,getopt} e @ref{a0,,optparse} não estão mais marcados como descontinuados. Há razões legítimas para usar um desses módulos em preferência a @ref{6,,argparse}, e nenhum desses módulos corre o risco de ser removido da biblioteca padrão. Dos três, @code{argparse} continua sendo a escolha padrão recomendada, `a menos que' uma das preocupações observadas no topo da documentação do módulo @code{optparse} se aplique.

@item 
gh-125553@footnote{https://github.com/python/cpython/issues/125553}: Corrige invariância de ida e volta para continuações de contrabarra em @ref{166b,,tokenize.untokenize()}.

@item 
gh-123987@footnote{https://github.com/python/cpython/issues/123987}: Corrigido problema no NamespaceReader em que um item não-caminho em um caminho de espaço de nomes, como um sinalizador adicionado por um instalador editável, interrompia o carregamento de recursos.

@item 
gh-123401@footnote{https://github.com/python/cpython/issues/123401}: O módulo @ref{71,,http.cookies} agora suporta análise de formatos de data obsoletos de 
@geindex RFC; RFC 850
RFC 850@footnote{https://datatracker.ietf.org/doc/html/rfc850.html}, de acordo com os requisitos do 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}. Patch por Nano Zheng.

@item 
gh-122431@footnote{https://github.com/python/cpython/issues/122431}: @ref{e7f,,readline.append_history_file()} agora levanta @ref{202,,ValueError} quando recebe um valor negativo.

@item 
gh-119257@footnote{https://github.com/python/cpython/issues/119257}: Exibe o menu de autopreenchimento com tecla tab abaixo da linha atual, o que resulta em um comportamento menos instável e corrige um bug de movimento do cursor. Patch por Daniel Hollas
@end itemize

@node Documentação<7>,Biblioteca<15>,Biblioteca<14>,Python 3 13 2 final
@anchor{whatsnew/changelog id69}@anchor{166c}
@subsubsection Documentação



@itemize -

@item 
gh-125722@footnote{https://github.com/python/cpython/issues/125722}: Requer Sphinx 8.1.3 ou posterior para construir a documentação do Python. Patch por Adam Turner.

@item 
gh-67206@footnote{https://github.com/python/cpython/issues/67206}: Documenta que @ref{166d,,string.printable} não é imprimível no sentido POSIX. Em particular, @ref{e02,,string.printable.isprintable()} retorna @ref{b49,,False}. Patch por Bénédikt Tran.
@end itemize

@node Biblioteca<15>,Núcleo e embutidos<12>,Documentação<7>,Python 3 13 2 final
@anchor{whatsnew/changelog id70}@anchor{166e}
@subsubsection Biblioteca



@itemize -

@item 
gh-129345@footnote{https://github.com/python/cpython/issues/129345}: Corrige desreferência de ponteiro nulo em @ref{53e,,syslog.openlog()} quando um gancho de auditoria levanta uma exceção.
@end itemize

@node Núcleo e embutidos<12>,API C<7>,Biblioteca<15>,Python 3 13 2 final
@anchor{whatsnew/changelog id71}@anchor{166f}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-129093@footnote{https://github.com/python/cpython/issues/129093}: Corrige f-strings como @code{f'@{expr=@}'} que às vezes não exibem a expressão completa quando a expressão contém @code{!=}.

@item 
gh-124363@footnote{https://github.com/python/cpython/issues/124363}: Trata expressões de depuração em f-string como strings brutas. Patch por Pablo Galindo

@item 
gh-128799@footnote{https://github.com/python/cpython/issues/128799}: Adiciona o quadro @code{except*} ao traceback quando ele encapsula uma exceção simples.

@item 
gh-128078@footnote{https://github.com/python/cpython/issues/128078}: Corrige um @ref{575,,SystemError} ao usar @ref{7d7,,anext()} com um valor de tupla padrão. Patch por Bénédikt Tran.

@item 
gh-128717@footnote{https://github.com/python/cpython/issues/128717}: Corrige uma falha ao definir o limite de recursão enquanto outros threads estão ativos na construção com @ref{15e4,,threads livres}.

@item 
gh-128330@footnote{https://github.com/python/cpython/issues/128330}: Restaura caracteres de controle do terminal na saída do REPL.

@item 
gh-128079@footnote{https://github.com/python/cpython/issues/128079}: Corrige um bug em que @ref{5b8,,except*} não verifica corretamente o valor de retorno de uma função @ref{1670,,split()} de @ref{1b6,,ExceptionGroup}, levando a uma falha em alguns casos. Agora, quando @ref{1670,,split()} retorna um objeto inválido, @ref{5b8,,except*} levanta @ref{2c3,,TypeError} com o objeto @ref{1b6,,ExceptionGroup} levantado originalmente encadeado a ele.

@item 
gh-128030@footnote{https://github.com/python/cpython/issues/128030}: Evita erro ao chamar @code{PyModule_GetFilenameObject} em um objeto que não é módulo ao importar um símbolo inexistente de um objeto que não é módulo.

@item 
gh-127903@footnote{https://github.com/python/cpython/issues/127903}: @code{Objects/unicodeobject.c}: corrige uma falha em compilações de depuração em @code{_copy_characters} quando não há nada para copiar.

@item 
gh-127599@footnote{https://github.com/python/cpython/issues/127599}: Corrige estatísticas para incrementos de contagens de referências de objetos (em particular, quando uma contagem de referências foi aumentada em mais de 1 em uma única operação).

@item 
gh-127651@footnote{https://github.com/python/cpython/issues/127651}: Ao levantar @ref{419,,ImportError} para símbolos ausentes em importações @code{from}, use @code{__file__} na mensagem de erro se @code{__spec__.origin} não for um local

@item 
gh-127582@footnote{https://github.com/python/cpython/issues/127582}: Corrige ressurreição de objeto não seguro para thread ao chamar finalizadores e retornos de chamada do observador na construção com threads livres.

@item 
gh-127434@footnote{https://github.com/python/cpython/issues/127434}: Os shims do compilador iOS agora podem aceitar argumentos com espaços.

@item 
gh-127536@footnote{https://github.com/python/cpython/issues/127536}: Adiciona travas faltando em torno de algumas operações de atribuição de lista na construção com threads livres.

@item 
gh-126862@footnote{https://github.com/python/cpython/issues/126862}: Corrige um possível estouro quando uma classe herda de um número absurdo de superclasses. Reportado por Valery Fedorenko. Patch por Bénédikt Tran.

@item 
gh-127349@footnote{https://github.com/python/cpython/issues/127349}: Corrigido o erro ao redimensionar o terminal no Python REPL. Patch por Semyon Moroz.

@item 
gh-126076@footnote{https://github.com/python/cpython/issues/126076}: Objetos realocados, como objetos @code{tuple}, @code{bytes} e @code{str} são rastreados corretamente por @ref{ff,,tracemalloc} e seus ganchos associados. Patch por Pablo Galindo.
@end itemize

@node API C<7>,Construção<6>,Núcleo e embutidos<12>,Python 3 13 2 final
@anchor{whatsnew/changelog id72}@anchor{1671}
@subsubsection API C



@itemize -

@item 
gh-127791@footnote{https://github.com/python/cpython/issues/127791}: Corrige perda de retornos de chamada após mais de uma chamada para @ref{1672,,PyUnstable_AtExit()}.
@end itemize

@node Construção<6>,,API C<7>,Python 3 13 2 final
@anchor{whatsnew/changelog id73}@anchor{1673}
@subsubsection Construção



@itemize -

@item 
gh-129539@footnote{https://github.com/python/cpython/issues/129539}: Não redefine @code{EX_OK} quando o sistema tiver o cabeçalho @code{sysexits.h}.

@item 
gh-128472@footnote{https://github.com/python/cpython/issues/128472}: Ignora a otimização BOLT de funções usando gotos computados, corrigindo erros na compilação com LLVM 19.

@item 
gh-123925@footnote{https://github.com/python/cpython/issues/123925}: Corrige a construção do módulo @ref{2b,,curses} em plataformas com libncurses, mas sem libncursesw.

@item 
gh-128321@footnote{https://github.com/python/cpython/issues/128321}: Define @code{LIBS} em vez de @code{LDFLAGS} ao verificar se as funções de biblioteca @ref{cf,,sqlite3} estão disponíveis. Isso corrige a ordenação de bibliotecas vinculadas durante as verificações, que era incorreta ao usar uma @code{libsqlite3} vinculada estaticamente.

@item 
gh-127865@footnote{https://github.com/python/cpython/issues/127865}: Corrige falha de construção em sistemas sem suporte a thread-locals.
@end itemize

@node Python 3 13 1 final,Python 3 13 0 final,Python 3 13 2 final,Changelog
@anchor{whatsnew/changelog python-3-13-1-final}@anchor{1674}
@subsection Python 3.13.1 final


`Data de lançamento: 2024-12-03'

@menu
* macOS: macOS<5>. 
* Windows: Windows<8>. 
* Ferramentas/Demos: Ferramentas/Demos<7>. 
* Testes: Testes<9>. 
* Segurança: Segurança<9>. 
* Biblioteca: Biblioteca<16>. 
* IDLE: IDLE<7>. 
* Documentação: Documentação<8>. 
* Núcleo e embutidos: Núcleo e embutidos<13>. 
* Biblioteca: Biblioteca<17>. 
* Núcleo e embutidos: Núcleo e embutidos<14>. 
* Biblioteca: Biblioteca<18>. 
* Núcleo e embutidos: Núcleo e embutidos<15>. 
* API C: API C<8>. 
* Construção: Construção<7>. 

@end menu

@node macOS<5>,Windows<8>,,Python 3 13 1 final
@anchor{whatsnew/changelog id74}@anchor{1675}
@subsubsection macOS



@itemize -

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: Atualiza o Tcl/Tk empacotado no instalador do macOS para 8.6.15.
@end itemize

@node Windows<8>,Ferramentas/Demos<7>,macOS<5>,Python 3 13 1 final
@anchor{whatsnew/changelog id75}@anchor{1676}
@subsubsection Windows



@itemize -

@item 
gh-126911@footnote{https://github.com/python/cpython/issues/126911}: Atualiza a saída do comando credits.

@item 
gh-118973@footnote{https://github.com/python/cpython/issues/118973}: Garante que a instalação experimental de threads livres inclua o módulo @code{_tkinter}. O componente Tcl/Tk opcional também deve ser instalado para que o módulo funcione.

@item 
gh-126497@footnote{https://github.com/python/cpython/issues/126497}: Corrige a falha do venv devido à ausência de executáveis do redirecionador em instalações experimentais de threads livres.

@item 
gh-126074@footnote{https://github.com/python/cpython/issues/126074}: Remoção de DLLs desnecessárias do pacote incorporável do Windows

@item 
gh-125315@footnote{https://github.com/python/cpython/issues/125315}: Evita travamentos em @ref{aa,,platform} devido a chamadas WMI lentas em algumas máquinas Windows.

@item 
gh-126084@footnote{https://github.com/python/cpython/issues/126084}: Corrige o venvwlauncher para iniciar o pythonw em vez do python para que nenhuma janela de console extra seja criada.

@item 
gh-125842@footnote{https://github.com/python/cpython/issues/125842}: Corrige uma @ref{575,,SystemError} quando @ref{138e,,sys.exit()} é chamado com @code{0xffffffff} no Windows.

@item 
gh-125550@footnote{https://github.com/python/cpython/issues/125550}: Habilita o @ref{5be,,Inicializador Python para Windows} para detectar instalações do Python 3.14 da Windows Store.

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: Tcl/Tk empacotado atualizado para 8.6.15.
@end itemize

@node Ferramentas/Demos<7>,Testes<9>,Windows<8>,Python 3 13 1 final
@anchor{whatsnew/changelog id76}@anchor{1677}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-126807@footnote{https://github.com/python/cpython/issues/126807}: Corrige avisos de extração em @code{pygettext.py} causados por definições de função equivocadas para chamadas de função.

@item 
gh-126167@footnote{https://github.com/python/cpython/issues/126167}: O conjunto de textos do iOS foi modificado para que possa ser usado por projetos de terceiros para fins de teste.
@end itemize

@node Testes<9>,Segurança<9>,Ferramentas/Demos<7>,Python 3 13 1 final
@anchor{whatsnew/changelog id77}@anchor{1678}
@subsubsection Testes



@itemize -

@item 
gh-126909@footnote{https://github.com/python/cpython/issues/126909}: Corrige testes de atributo estendido test_os para funcionar em sistemas de arquivos com limite de tamanho xattr de 1 KiB.

@item 
gh-125041@footnote{https://github.com/python/cpython/issues/125041}: Reativa testes ignorados para @ref{133,,zlib} na arquitetura s390x: ignora apenas verificações dos bytes compactados, que podem ser diferentes entre a implementação de software do zlib e a implementação acelerada por hardware.

@item 
gh-124295@footnote{https://github.com/python/cpython/issues/124295}: Adiciona testes de tradução ao módulo @ref{6,,argparse}.
@end itemize

@node Segurança<9>,Biblioteca<16>,Testes<9>,Python 3 13 1 final
@anchor{whatsnew/changelog id78}@anchor{1679}
@subsubsection Segurança



@itemize -

@item 
gh-126623@footnote{https://github.com/python/cpython/issues/126623}: Atualiza libexpat para 2.6.4

@item 
gh-125140@footnote{https://github.com/python/cpython/issues/125140}: Remove o diretório atual de @code{sys.path} ao usar PyREPL.

@item 
gh-122792@footnote{https://github.com/python/cpython/issues/122792}: Alterado @code{ipaddress.IPv6Address} mapeado para IPv4 para usar consistentemente o valor do endereço IPv4 mapeado para decidir propriedades. Propriedades que têm seu comportamento corrigido são @code{is_multicast}, @code{is_reserved}, @code{is_link_local}, @code{is_global} e @code{is_unspecified}.
@end itemize

@node Biblioteca<16>,IDLE<7>,Segurança<9>,Python 3 13 1 final
@anchor{whatsnew/changelog id79}@anchor{167a}
@subsubsection Biblioteca



@itemize -

@item 
gh-127321@footnote{https://github.com/python/cpython/issues/127321}: @ref{235,,pdb.set_trace()} não parará em um opcode que não tenha mais um número de linha associado.

@item 
gh-127303@footnote{https://github.com/python/cpython/issues/127303}: Expõe publicamente @ref{167b,,EXACT_TOKEN_TYPES} em @code{token.__all__}.

@item 
gh-123967@footnote{https://github.com/python/cpython/issues/123967}: Corrige o manipulador de falhas para quadros de trampolim. Se o quadro mais alto for um quadro de trampolim, pule-o. Patch por Victor Stinner.

@item 
gh-127182@footnote{https://github.com/python/cpython/issues/127182}: Corrige o travamento de @code{io.StringIO.__setstate__()}, quando @ref{675,,None} foi passado como o primeiro valor.

@item 
gh-127217@footnote{https://github.com/python/cpython/issues/127217}: Corrige @ref{167c,,urllib.request.pathname2url()} para caminhos começando com várias barras no Posix.

@item 
gh-127035@footnote{https://github.com/python/cpython/issues/127035}: Corrige @ref{4b4,,shutil.which} no Windows. Agora ele analisa a correspondência direta se e somente se o comando termina com uma extensão PATHEXT ou X_OK não está no modo. Suporta arquivos sem extensão se “.” estiver em PATHEXT. Suporta extensões PATHEXT que terminam com um ponto.

@item 
gh-122273@footnote{https://github.com/python/cpython/issues/122273}: Suporte ao histórico de PyREPL no Windows. Patch por devdanzin e Victor Stinner.

@item 
gh-127078@footnote{https://github.com/python/cpython/issues/127078}: Corrige o problema em que @ref{167d,,urllib.request.url2pathname()} falhava ao descartar uma barra extra antes de uma unidade UNC no caminho da URL no Windows.

@item 
gh-126766@footnote{https://github.com/python/cpython/issues/126766}: Corrige o problema em que @ref{167d,,urllib.request.url2pathname()} falhava ao descartar qualquer autoridade ‘localhost’ presente na URL.

@item 
gh-127065@footnote{https://github.com/python/cpython/issues/127065}: Corrige o travamento ao chamar uma instância @ref{e61,,operator.methodcaller()} de vários threads na construção com threads livres.

@item 
gh-126997@footnote{https://github.com/python/cpython/issues/126997}: Corrige o suporte de opcodes STRING e GLOBAL com argumentos não ASCII em @ref{a7,,pickletools}. @ref{ce3,,pickletools.dis()} agora emite bytes não ASCII em argumentos STRING, BINSTRING e SHORT_BINSTRING como escape (@code{\\xXX}).

@item 
gh-126316@footnote{https://github.com/python/cpython/issues/126316}: @ref{66,,grp}: Torna @ref{167e,,grp.getgrall()} seguro para thread adicionando um mutex. Patch por Victor Stinner.

@item 
gh-126618@footnote{https://github.com/python/cpython/issues/126618}: Corrige a representação de objetos @ref{12c5,,itertools.count} quando o valor da contagem é @ref{1205,,sys.maxsize}.

@item 
gh-85168@footnote{https://github.com/python/cpython/issues/85168}: Corrige problema em que @ref{167d,,urllib.request.url2pathname()} e @ref{167c,,pathname2url()} sempre usavam UTF-8 ao citar e descitar URIs de arquivo. Agora eles usam @ref{53b,,tratador de erros e codificação do sistema de arquivos}.

@item 
gh-67877@footnote{https://github.com/python/cpython/issues/67877}: Corrige vazamentos de memória quando a correspondência de @ref{b9,,expressão regular} termina abruptamente, seja por causa de um sinal ou porque a alocação de memória falha.

@item 
gh-126789@footnote{https://github.com/python/cpython/issues/126789}: Corrigidos os valores de @ref{1064,,sysconfig.get_config_vars()}, @ref{1285,,sysconfig.get_paths()} e seus irmãos quando a inicialização de @ref{c7,,site} acontece após @ref{db,,sysconfig} ter construído um cache para @ref{1064,,sysconfig.get_config_vars()}.

@item 
gh-126188@footnote{https://github.com/python/cpython/issues/126188}: Atualiza pip empacotado para 24.3.1

@item 
gh-126780@footnote{https://github.com/python/cpython/issues/126780}: Corrige @ref{135e,,os.path.normpath()} para caminhos relativos à unidade no Windows.

@item 
gh-126766@footnote{https://github.com/python/cpython/issues/126766}: Corrige problema em que @ref{167d,,urllib.request.url2pathname()} falhava ao descartar duas barras iniciais introduzindo uma seção de autoridade vazia.

@item 
gh-126727@footnote{https://github.com/python/cpython/issues/126727}: @code{locale.nl_langinfo(locale.ERA)} agora retorna vários segmentos de descrição de era separados por ponto e vírgula. Anteriormente, ele retornava apenas o primeiro segmento em plataformas com Glibc.

@item 
gh-126699@footnote{https://github.com/python/cpython/issues/126699}: Permite que @ref{e08,,collections.abc.AsyncIterator} seja uma base para Protocols.

@item 
gh-126654@footnote{https://github.com/python/cpython/issues/126654}: Corrige falha quando um objeto não dicionário era passado para várias funções no módulo @code{_interpreters}.

@item 
gh-104745@footnote{https://github.com/python/cpython/issues/104745}: Limita o início de um patcher (de @ref{ec1,,unittest.mock.patch()} ou @ref{167f,,unittest.mock.patch.object()}) mais de uma vez sem pará-lo

@item 
gh-126595@footnote{https://github.com/python/cpython/issues/126595}: Corrige falha ao instanciar @ref{12c5,,itertools.count} com uma contagem inicial de @ref{1205,,sys.maxsize} em construções de depuração. Patch por Bénédikt Tran.

@item 
gh-120423@footnote{https://github.com/python/cpython/issues/120423}: Corrige problema em que @ref{167c,,urllib.request.pathname2url()} manipulava incorretamente caminhos do Windows com barras inseridas.

@item 
gh-126565@footnote{https://github.com/python/cpython/issues/126565}: Melhora o desempenho de @ref{1680,,zipfile.Path.open()} para modos que não sejam de leitura.

@item 
gh-126505@footnote{https://github.com/python/cpython/issues/126505}: Corrige bugs na compilação de @ref{b9,,expressões regulares} sem distinção entre maiúsculas e minúsculas com classes de caracteres que contenham caracteres não BMP: o caractere maiúsculo não BMP foi ignorado e o sinalizador ASCII foi ignorado ao corresponder a um intervalo de caracteres cujo limite superior está além da região BMP.

@item 
gh-117378@footnote{https://github.com/python/cpython/issues/117378}: Corrigido o processo de forkserver do método de início @ref{94,,multiprocessing} @code{"forkserver"} para herdar corretamente o @ref{3b4,,sys.path} do pai durante a importação de módulos @ref{1681,,multiprocessing.set_forkserver_preload()} da mesma maneira que @ref{3b4,,sys.path} é configurado em workers antes de executar itens de trabalho.

Este bug fez com que alguns módulos do forkserver pré-carregados falhassem silenciosamente no pré-carregamento. Isso se manifestou como uma degradação de desempenho em processos filhos quando o @code{sys.path} era necessário devido ao trabalho repetido adicional em cada worker.

Também poderia ter um efeito colateral de @code{""} permanecer em @ref{3b4,,sys.path} durante importações de pré-carregamento do forkserver em vez do caminho absoluto de @ref{1682,,os.getcwd()} no momento da importação de multiprocessamento usado no worker @code{sys.path}.

As diferenças de @code{sys.path} entre as fases no processo filho poderiam ter causado o pré-carregamento para importar coisas incorretas do local errado. Não temos conhecimento de que isso realmente tenha acontecido na prática.

@item 
gh-125679@footnote{https://github.com/python/cpython/issues/125679}: Os valores de @ref{1683,,multiprocessing.Lock} e @ref{1684,,multiprocessing.RLock} @code{repr} não dizem mais “unknown” no macOS.

@item 
gh-126476@footnote{https://github.com/python/cpython/issues/126476}: Levanta @ref{1685,,calendar.IllegalMonthError} (agora uma subclasse de @ref{157e,,IndexError}) para @ref{1686,,calendar.month()} quando o mês de entrada não está correto.

@item 
gh-126489@footnote{https://github.com/python/cpython/issues/126489}: A implementação Python de @ref{a6,,pickle} não chama mais @ref{1687,,pickle.Pickler.persistent_id()} para o resultado de @code{persistent_id()}.

@item 
gh-126313@footnote{https://github.com/python/cpython/issues/126313}: Corrige um problema em @ref{1688,,curses.napms()} quando @ref{1689,,curses.initscr()} ainda não foi chamado. Patch por Bénédikt Tran.

@item 
gh-126303@footnote{https://github.com/python/cpython/issues/126303}: Corrige serializar com pickle e cópia de objetos @ref{168a,,os.sched_param}.

@item 
gh-126138@footnote{https://github.com/python/cpython/issues/126138}: Corrige uma falha de uso após liberação em objetos @ref{1be,,asyncio.Task} cuja corrotina subjacente produz um objeto que implementa um @ref{beb,,__getattribute__()} maligno. Patch por Nico Posada.

@item 
gh-126220@footnote{https://github.com/python/cpython/issues/126220}: Corrige falha em @code{cProfile.Profile} e @code{_lsprof.Profiler} quando seus retornos de chamada eram chamados diretamente com 0 argumentos.

@item 
gh-126212@footnote{https://github.com/python/cpython/issues/126212}: Corrige problema em que @ref{167c,,urllib.request.pathname2url()} e @ref{167d,,url2pathname()} removiam barras de caminhos de unidade DOS do Windows e URLs.

@item 
gh-126223@footnote{https://github.com/python/cpython/issues/126223}: Levanta @ref{677,,UnicodeEncodeError} em vez de um @ref{575,,SystemError} ao chamar @code{_interpreters.create()} com um caractere Unicode inválido.

@item 
gh-126205@footnote{https://github.com/python/cpython/issues/126205}: Corrige o problema em que @ref{167c,,urllib.request.pathname2url()} gerava URLs começando com quatro barras (em vez de duas) quando recebia um caminho UNC do Windows.

@item 
gh-126105@footnote{https://github.com/python/cpython/issues/126105}: Corrige uma falha em @ref{8,,ast} quando o atributo @ref{15e3,,ast.AST._fields} é excluído.

@item 
gh-126106@footnote{https://github.com/python/cpython/issues/126106}: Corrige uma possível desreferência de ponteiro @code{NULL} em @ref{d0,,ssl}.

@item 
gh-126080@footnote{https://github.com/python/cpython/issues/126080}: Corrige uma falha de uso após liberação em objetos @ref{1be,,asyncio.Task} para os quais o loop de eventos subjacente implementa um @ref{beb,,__getattribute__()} maligno. Relatado por Nico-Posada. Patch por Bénédikt Tran.

@item 
gh-126083@footnote{https://github.com/python/cpython/issues/126083}: Corrige um vazamento de referência em objetos @ref{1be,,asyncio.Task} ao reinicializar o mesmo objeto com um contexto não @code{None}. Patch por Nico Posada.

@item 
gh-125984@footnote{https://github.com/python/cpython/issues/125984}: Corrige falhas de uso após liberação em objetos @ref{be6,,asyncio.Future} para os quais o laço de eventos subjacente implementa um @ref{beb,,__getattribute__()} maligno. Relatado por Nico-Posada. Patch por Bénédikt Tran.

@item 
gh-125969@footnote{https://github.com/python/cpython/issues/125969}: Corrige uma falha fora dos limites quando um @ref{b17,,asyncio.loop.call_soon()} maligno altera o comprimento da lista de retornos de chamada internos. Patch por Bénédikt Tran.

@item 
gh-125966@footnote{https://github.com/python/cpython/issues/125966}: Corrige uma falha de uso após liberação em @ref{168b,,asyncio.Future.remove_done_callback()}. Patch por Bénédikt Tran.

@item 
gh-125789@footnote{https://github.com/python/cpython/issues/125789}: Corrige possível falha ao alterar a lista de retornos de chamada retornados por @code{asyncio.Future._callbacks}. Agora ele sempre retorna uma nova cópia na implementação C @code{_asyncio}. Patch por Kumar Aditya.

@item 
gh-124452@footnote{https://github.com/python/cpython/issues/124452}: Corrige um problema em @ref{168c,,email.policy.EmailPolicy.header_source_parse()} e @ref{168d,,email.policy.Compat32.header_source_parse()} que introduziam espaços em branco iniciais espúrios em valores de cabeçalho quando o cabeçalho incluía um caractere de nova linha após o delimitador de nome do cabeçalho (@code{:}) e antes do valor.

@item 
gh-125884@footnote{https://github.com/python/cpython/issues/125884}: Corrige o bug para @ref{a5,,pdb} onde ele não pode definir pontos de interrupção em funções com certas anotações.

@item 
gh-125355@footnote{https://github.com/python/cpython/issues/125355}: Corrige vários bugs em @ref{b13,,argparse.ArgumentParser.parse_intermixed_args()}.


@itemize *

@item 
O analisador não muda mais temporariamente durante a análise.

@item 
Os valores padrão não são processados duas vezes.

@item 
Os grupos mutuamente exclusivos obrigatórios contendo argumentos posicionais agora são suportados.

@item 
O relatório de argumentos ausentes agora inclui os nomes de todos os argumentos posicionais e opcionais necessários.

@item 
Opções desconhecidas podem ser misturadas com argumentos posicionais em parse_known_intermixed_args().
@end itemize

@item 
gh-125666@footnote{https://github.com/python/cpython/issues/125666}: Evita a saída do interpretador se um byte nulo for fornecido como entrada no novo REPL.

@item 
gh-125710@footnote{https://github.com/python/cpython/issues/125710}: [Enum] corrige comparações hasheável<->não-hasheável para valores de membros

@item 
gh-125631@footnote{https://github.com/python/cpython/issues/125631}: Restaura a capacidade de definir atributos @ref{1687,,persistent_id} e @ref{168e,,persistent_load} de instâncias das classes @code{Pickler} e @code{Unpickler} no módulo @ref{a6,,pickle}.

@item 
gh-125378@footnote{https://github.com/python/cpython/issues/125378}: Corrige o bug em @ref{a5,,pdb} onde após um comando multilinha, uma linha vazia repete a primeira linha do comando multilinha, em vez do comando completo.

@item 
gh-125682@footnote{https://github.com/python/cpython/issues/125682}: Rejeita dígitos não ASCII na implementação Python de @ref{95c,,json.loads()} em conformidade com a especificação JSON.

@item 
gh-125660@footnote{https://github.com/python/cpython/issues/125660}: Rejeita escapes unicode inválidos para implementação Python de @ref{95c,,json.loads()}.

@item 
gh-125259@footnote{https://github.com/python/cpython/issues/125259}: Corrige a lógica de remoção de notas para erros lançados na inicialização de enumeração.

@item 
gh-125590@footnote{https://github.com/python/cpython/issues/125590}: Permite que @code{FrameLocalsProxy} exclua e remova se a chave não for uma variável rápida.

@item 
gh-125519@footnote{https://github.com/python/cpython/issues/125519}: Melhora o traceback se @ref{519,,importlib.reload()} for chamado com um objeto que não seja um módulo. Patch por Alex Waygood.

@item 
gh-125451@footnote{https://github.com/python/cpython/issues/125451}: Corrige um impasse quando @ref{8f4,,concurrent.futures.ProcessPoolExecutor} desliga simultaneamente com um erro ao alimentar um trabalho para um processo de trabalho.

@item 
gh-125422@footnote{https://github.com/python/cpython/issues/125422}: Corrige o bug onde @ref{a5,,pdb} e @ref{f,,bdb} podem entrar no quadro do chamador inferior.

@item 
gh-100141@footnote{https://github.com/python/cpython/issues/100141}: Corrige o bug onde @ref{a5,,pdb} ficará preso em um laço infinito ao depurar um arquivo vazio.

@item 
gh-125115@footnote{https://github.com/python/cpython/issues/125115}: Corrige um bug em @ref{a5,,pdb} onde argumentos começando com @code{-} não podem ser passados para o script depurado.

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: Corrige @ref{1474,,time.strptime()} para os formatos @code{%c}, @code{%x} e @code{%X} em muitos locais que usam dígitos não ASCII, como persa, birmanês, odia e shan.

@item 
gh-125398@footnote{https://github.com/python/cpython/issues/125398}: Corrige a conversão do caminho @code{VIRTUAL_ENV} no script activate em @ref{111,,venv} ao executar no Git Bash para Windows.

@item 
gh-125316@footnote{https://github.com/python/cpython/issues/125316}: Corrige o uso de @ref{414,,functools.partial()} como membro @ref{630,,enum.Enum}. Um FutureWarning com sugestão para usar @ref{627,,enum.member()} agora é emitido quando a instância @code{partial} é usada como um membro enum.

@item 
gh-125245@footnote{https://github.com/python/cpython/issues/125245}: Corrige condição de corrida ao importar @ref{1e,,collections.abc}, que poderia retornar incorretamente um módulo vazio.

@item 
gh-125243@footnote{https://github.com/python/cpython/issues/125243}: Corrige corrida de dados ao criar objetos @ref{8e5,,zoneinfo.ZoneInfo} na construção com threads livres.

@item 
gh-125254@footnote{https://github.com/python/cpython/issues/125254}: Corrige um bug em que ArgumentError inclui a opção ambígua incorreta em @ref{6,,argparse}.

@item 
gh-125235@footnote{https://github.com/python/cpython/issues/125235}: Mantém os caminhos TCL @ref{f0,,tkinter} em venv apontando para a instalação base no Windows.

@item 
gh-61011@footnote{https://github.com/python/cpython/issues/61011}: Corrige herança de grupos mutuamente exclusivos aninhados do analisador pai em @ref{539,,argparse.ArgumentParser}. Anteriormente, todos os grupos mutuamente exclusivos aninhados perdiam sua conexão com o grupo que os continha e eram exibidos como pertencentes diretamente ao analisador.

@item 
gh-52551@footnote{https://github.com/python/cpython/issues/52551}: Corrige problemas de codificação em @ref{1229,,time.strftime()}, o método @ref{caf,,strftime()} das classes @ref{30,,datetime} @ref{1cc,,datetime}, @ref{1cd,,date} e @ref{1ce,,time} e a formatação dessas classes. Caracteres não codificáveis no localidade atual agora são aceitáveis na string de formato. Pares substitutos e sequência de bytes codificados por surrogatescape não são mais recombinados. O caractere nulo incorporado não termina mais a string de formato.

@item 
gh-125118@footnote{https://github.com/python/cpython/issues/125118}: Não copia valores arbitrários para _Bool no módulo @ref{d5,,struct}.

@item 
gh-125069@footnote{https://github.com/python/cpython/issues/125069}: Corrige um problema em que fornecer um objeto @ref{4a6,,pathlib.PurePath} como um argumento inicializador para um segundo objeto @ref{4a6,,PurePath} com um @ref{22c,,parser} diferente resultava em argumentos para o inicializador do objeto anterior sendo unidos pelo analisador do objeto posterior.

@item 
gh-125096@footnote{https://github.com/python/cpython/issues/125096}: Se a variável de ambiente 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL} estiver definida, o módulo @ref{c7,,site} não importa mais o módulo @code{_pyrepl}. Além disso, o módulo @ref{c7,,site} agora respeita as opções de linha de comando @ref{964,,-E} e @ref{965,,-I}: ignore 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL} neste caso. Patch por Victor Stinner.

@item 
gh-124969@footnote{https://github.com/python/cpython/issues/124969}: Corrige @code{locale.nl_langinfo(locale.ALT_DIGITS)} em plataformas com glibc. Agora ele retorna uma string consistindo de até 100 símbolos separados por ponto e vírgula (uma string vazia na maioria dos locais) em todas as plataformas Posix. Anteriormente, ele retornava apenas o primeiro símbolo ou uma string vazia.

@item 
gh-124960@footnote{https://github.com/python/cpython/issues/124960}: Corrige suporte para o sinalizador future @code{barry_as_FLUFL} no novo REPL.

@item 
gh-124984@footnote{https://github.com/python/cpython/issues/124984}: Corrige segurança de thread em @ref{d0,,ssl} na construção com threads livres. As operações OpenSSL agora são protegidas por uma trava por objeto.

@item 
gh-124958@footnote{https://github.com/python/cpython/issues/124958}: Corrige refcycles em exceções levantadas de @ref{1b5,,asyncio.TaskGroup} e a implementação python de @ref{be6,,asyncio.Future}

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: Corrige @ref{1474,,time.strptime()} para os formatos @code{%c} e @code{%x} em muitos idiomas: árabe, bislama, bretão, bodo, cassubiano, chuvache, estoniano, francês, irlandês, ge’ez, gurajati, gaélico manx, hebraico, hindi, chhattisgarhi, crioulo haitiano, japonês, canarês, coreano, marata, malaio, norueguês, nynorsk, punjabi, rajasthani, tok pisin, iorubá, chinês yue, yau nungon e chinês.

@item 
gh-124917@footnote{https://github.com/python/cpython/issues/124917}: Permite chamar @ref{a18,,os.path.exists()} e @ref{a19,,os.path.lexists()} com argumentos de palavra-chave no Windows. Corrige uma regressão em 3.13.0.

@item 
gh-124653@footnote{https://github.com/python/cpython/issues/124653}: Corrige a detecção da API de fila mínima necessária pelo módulo @ref{87,,logging}. Patch por Bénédikt Tran.

@item 
gh-124858@footnote{https://github.com/python/cpython/issues/124858}: Corrige ciclos de referência deixados em tracebacks em @ref{b2b,,asyncio.open_connection()} quando usado com @code{happy_eyeballs_delay}

@item 
gh-124390@footnote{https://github.com/python/cpython/issues/124390}: Corrigidas @ref{6a9,,AssertionError} ao usar @code{asyncio.staggered.staggered_race()} com @ref{477,,asyncio.eager_task_factory}.

@item 
gh-124651@footnote{https://github.com/python/cpython/issues/124651}: Coloca corretamente entre aspas as strings template em scripts de ativação @ref{111,,venv}.

@item 
gh-116850@footnote{https://github.com/python/cpython/issues/116850}: Corrige @ref{6,,argparse} para espaços de nomes com dict não diretamente gravável (por exemplo, classes).

@item 
gh-58573@footnote{https://github.com/python/cpython/issues/58573}: Corrige conflitos entre opções longas abreviadas no analisador pai e subanalisadores em @ref{6,,argparse}.

@item 
gh-124594@footnote{https://github.com/python/cpython/issues/124594}: Todos os prompts REPL @ref{a,,asyncio} são executados no mesmo @ref{15b7,,context}. Contribuição de Bartosz Sławecki.

@item 
gh-61181@footnote{https://github.com/python/cpython/issues/61181}: Corrige suporte de @ref{168f,,choices} com valor de string em @ref{6,,argparse}. Substrings da string especificada não são mais considerados valores válidos.

@item 
gh-80259@footnote{https://github.com/python/cpython/issues/80259}: Corrige suporte de @ref{6,,argparse} de argumentos posicionais com @code{nargs='?'}, @code{default=argparse.SUPPRESS} e @code{type} especificado.

@item 
gh-120378@footnote{https://github.com/python/cpython/issues/120378}: Corrige uma falha relacionada a um estouro de inteiro em @ref{1690,,curses.resizeterm()} e @ref{1691,,curses.resize_term()}.

@item 
gh-123884@footnote{https://github.com/python/cpython/issues/123884}: Corrige bug no tratamento de itertools.tee() de outras entradas tee (um tee em um tee). A saída agora tem os prometidos `n' novos iteradores independentes. Anteriormente, o primeiro iterador era idêntico (não independente) ao iterador de entrada. Isso às vezes dava resultados surpreendentes.

@item 
gh-58956@footnote{https://github.com/python/cpython/issues/58956}: Corrigido um bug em @ref{a5,,pdb} onde às vezes o ponto de interrupção não disparava se ele fosse definido em uma função que já está na pilha de chamadas.

@item 
gh-124345@footnote{https://github.com/python/cpython/issues/124345}: vim @ref{6,,argparse} suporta opções longas de traço simples abreviadas separadas por @code{=} de seu valor.

@item 
gh-104860@footnote{https://github.com/python/cpython/issues/104860}: Corrigido a falta de permissão de abreviação de opções longas de traço simples em @ref{6,,argparse} com @code{allow_abbrev=False}.

@item 
gh-63143@footnote{https://github.com/python/cpython/issues/63143}: Corrigida a análise de argumentos mutuamente exclusivos em @ref{6,,argparse}. Argumentos com o valor idêntico ao valor padrão (por exemplo, booleanos, inteiros pequenos, strings vazias ou de 1 caractere) não são mais considerados “não presentes”.

@item 
gh-72795@footnote{https://github.com/python/cpython/issues/72795}: Argumentos posicionais com @ref{1692,,nargs} igual a @code{'*'} ou @code{argparse.REMAINDER} não são mais necessários. Isso permite usar argumento posicional com @code{nargs='*'} e sem @code{default} em grupo mutuamente exclusivo e melhora a mensagem de erro sobre argumentos necessários.

@item 
gh-59317@footnote{https://github.com/python/cpython/issues/59317}: Corrige análise de argumento posicional com @ref{1692,,nargs} igual a @code{'?'} ou @code{'*'} se for precedido por uma opção e outro argumento posicional.

@item 
gh-53780@footnote{https://github.com/python/cpython/issues/53780}: @ref{6,,argparse} agora ignora o primeiro @code{"--"} (traço duplo) entre uma opção e um comando.

@item 
gh-124217@footnote{https://github.com/python/cpython/issues/124217}: Adicionar bloco IPv6 reservado do RFC 9637 @code{3fff::/20} no módulo @ref{80,,ipaddress}.

@item 
gh-81691@footnote{https://github.com/python/cpython/issues/81691}: Corrige manipulação de múltiplos @code{"--"} (traços duplos) em @ref{6,,argparse}. Apenas o primeiro foi removido, todos os subsequentes agora são tomados literalmente.

@item 
gh-123978@footnote{https://github.com/python/cpython/issues/123978}: Remove @ref{93d,,time.thread_time()} e @ref{ba9,,time.thread_time_ns()} quebrados no NetBSD.

@item 
gh-124008@footnote{https://github.com/python/cpython/issues/124008}: Corrige possível travamento (na construção de depuração), saída incorreta ou retorno de valor incorreto do binário bruto @code{write()} ao gravar no console no Windows.

@item 
gh-123935@footnote{https://github.com/python/cpython/issues/123935}: Corrige detecção de slots pai para dataclasses que herdam de classes com @code{__dictoffset__}.

@item 
gh-122765@footnote{https://github.com/python/cpython/issues/122765}: Corrige erros de aspas desbalanceadas que ocorrem quando activate.csh em @ref{111,,venv} era carregado com um prompt personalizado contendo aspas desemparelhadas ou novas linhas.

@item 
gh-123370@footnote{https://github.com/python/cpython/issues/123370}: Corrige a tela que não limpa após executar o relógio turtledemo.

@item 
gh-116810@footnote{https://github.com/python/cpython/issues/116810}: Resolve um vazamento de memória introduzido no @ref{d0,,ssl} do CPython 3.10 quando a propriedade @ref{1693,,ssl.SSLSocket.session} era acessada. Acelera o acesso de leitura e gravação à referida propriedade ao não clonar mais objetos de sessão desnecessariamente por meio de serialização.

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: Atualiza chamadas @code{read} ilimitadas em @ref{131,,zipfile} para especificar um @code{size} explícito, colocando um limite na quantidade de dados que eles podem ler. Isso também atualiza o tratamento em torno do tamanho máximo de comentário do ZIP para corresponder ao padrão em vez de ler comentários que são um byte muito longos.

@item 
gh-70764@footnote{https://github.com/python/cpython/issues/70764}: Corrigido um problema em que @ref{1114,,inspect.getclosurevars()} classificaria incorretamente um nome de atributo como uma variável global quando o nome existe tanto como um nome de atributo quanto como uma variável global.

@item 
gh-118289@footnote{https://github.com/python/cpython/issues/118289}: @code{posixpath.realpath()} agora levanta @ref{1093,,NotADirectoryError} quando o modo `strict' está habilitado e um caminho sem diretório com uma barra final é fornecido.

@item 
gh-119826@footnote{https://github.com/python/cpython/issues/119826}: Sempre retorna um caminho absoluto para @ref{135f,,os.path.abspath()} no Windows.

@item 
gh-117766@footnote{https://github.com/python/cpython/issues/117766}: Sempre usa @ref{44c,,str()} para exibir @code{choices} em @ref{6,,argparse}.

@item 
gh-101955@footnote{https://github.com/python/cpython/issues/101955}: Corrige SystemError ao corresponder ao padrão de expressão regular contendo alguma combinação de quantificador possessivo, alternativo e grupo de captura.

@item 
gh-88110@footnote{https://github.com/python/cpython/issues/88110}: Corrigido @ref{b6f,,multiprocessing.Process} relatando um @code{.exitcode} de 1 mesmo em caso de sucesso ao usar o método de início @code{"fork"} ao usar um @ref{742,,concurrent.futures.ThreadPoolExecutor}.

@item 
gh-71936@footnote{https://github.com/python/cpython/issues/71936}: Corrigir uma condição de corrida em @ref{f9f,,multiprocessing.pool.Pool}.

@item 
bpo-46128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46128}: Remove quadros de pilha @ref{30c,,unittest.IsolatedAsyncioTestCase} de stacktraces relatados.

@item 
bpo-14074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14074}: Corrige o processamento de metavariável de @ref{6,,argparse} para permitir que argumentos posicionais tenham uma metavar de tupla.
@end itemize

@node IDLE<7>,Documentação<8>,Biblioteca<16>,Python 3 13 1 final
@anchor{whatsnew/changelog id80}@anchor{1694}
@subsubsection IDLE



@itemize -

@item 
gh-122392@footnote{https://github.com/python/cpython/issues/122392}: Aumenta o espaçamento vertical atualmente inadequado para os navegadores IDLE (caminho, módulo e pilha) em monitores de alta resolução.
@end itemize

@node Documentação<8>,Núcleo e embutidos<13>,IDLE<7>,Python 3 13 1 final
@anchor{whatsnew/changelog id81}@anchor{1695}
@subsubsection Documentação



@itemize -

@item 
gh-126622@footnote{https://github.com/python/cpython/issues/126622}: Adicionadas páginas de rascunho para módulos removidos explicando sua remoção, onde encontrar substituições e links para a última versão do Python que os suportava. Contribuição de Ned Batchelder.

@item 
gh-125277@footnote{https://github.com/python/cpython/issues/125277}: Exige Sphinx 7.2.6 ou posterior para construir a documentação do Python. Patch por Adam Turner.

@item 
gh-124872@footnote{https://github.com/python/cpython/issues/124872}: Adicionadas as definições para @ref{1696,,contexto}, @ref{1697,,contexto atual} e @ref{1698,,protocolo de gerenciamento de contexto}, atualizadas definições relacionadas para serem consistentes e expandida a documentação para @ref{15b7,,contextvars.Context}.

@item 
gh-125018@footnote{https://github.com/python/cpython/issues/125018}: A documentação @ref{7a,,importlib.metadata} agora inclui alvos de referência cruzada semântica para as APIs documentadas significativas. Isso significa que referências intersphinx como @ref{1699,,importlib.metadata.version()} agora funcionarão conforme o esperado.

@item 
gh-70870@footnote{https://github.com/python/cpython/issues/70870}: Esclarecido o uso duplo do termo “variável livre” (tanto o significado formal de qualquer referência a nomes definidos fora do escopo local, quanto o significado pragmático mais restrito de variáveis não locais nomeadas em @code{co_freevars}).

@item 
gh-121277@footnote{https://github.com/python/cpython/issues/121277}: Os escritores da documentação do CPython agora podem usar @code{next} como a versão para as diretivas @code{versionchanged}, @code{versionadded}, @code{deprecated}.

@item 
gh-60712@footnote{https://github.com/python/cpython/issues/60712}: Inclui o tipo @ref{a96,,object} nas listas de tipos documentados. Alteração por Furkan Onder e Martin Panter.

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: A documentação @ref{c3f,,Py_Main()} foi movida da seção “API de nível muito alto” para a seção “Inicialização e finalização”.

Também explicita que esperamos que @code{Py_Main} seja chamado tipicamente em vez de @code{Py_Initialize} em vez de depois dele (já que @code{Py_Main} faz sua própria chamada para @code{Py_Initialize}). Documente que chamar ambos é suportado, mas depende da versão de quais configurações serão aplicadas corretamente.
@end itemize

@node Núcleo e embutidos<13>,Biblioteca<17>,Documentação<8>,Python 3 13 1 final
@anchor{whatsnew/changelog id82}@anchor{169a}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-113841@footnote{https://github.com/python/cpython/issues/113841}: Corrige possível comportamento indefinido de divisão por zero em @ref{2f8,,complex}’s @ref{169b,,_Py_c_pow()}.

@item 
gh-127020@footnote{https://github.com/python/cpython/issues/127020}: Corrige uma falha na construção com threads livres quando @ref{778,,PyCode_GetCode()}, @ref{779,,PyCode_GetVarnames()}, @ref{77a,,PyCode_GetCellvars()} ou @ref{77b,,PyCode_GetFreevars()} eram chamados de várias threads ao mesmo tempo.

@item 
gh-126980@footnote{https://github.com/python/cpython/issues/126980}: Corrige @ref{45f,,__buffer__()} de @ref{2ea,,bytearray} travando quando @ref{169c,,READ} ou @ref{169d,,WRITE} são passados como sinalizadores.

@item 
gh-126881@footnote{https://github.com/python/cpython/issues/126881}: Corrige falha na finalização do estado dtoa. Patch por Kumar Aditya.

@item 
gh-126341@footnote{https://github.com/python/cpython/issues/126341}: Agora @ref{202,,ValueError} é levantada em vez de @ref{575,,SystemError} ao tentar iterar sobre um objeto @ref{2eb,,memoryview} liberado.

@item 
gh-126688@footnote{https://github.com/python/cpython/issues/126688}: Corrige uma falha ao chamar @ref{197,,os.fork()} em alguns sistemas operacionais, incluindo SerenityOS.
@end itemize

@node Biblioteca<17>,Núcleo e embutidos<14>,Núcleo e embutidos<13>,Python 3 13 1 final
@anchor{whatsnew/changelog id83}@anchor{169e}
@subsubsection Biblioteca



@itemize -

@item 
gh-126066@footnote{https://github.com/python/cpython/issues/126066}: Corrige @ref{77,,importlib} para não gravar arquivos .pyc incompletos quando um ulimit ou algum outro mecanismo do sistema operacional estiver impedindo que a gravação seja feita completamente.
@end itemize

@node Núcleo e embutidos<14>,Biblioteca<18>,Biblioteca<17>,Python 3 13 1 final
@anchor{whatsnew/changelog id84}@anchor{169f}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-126312@footnote{https://github.com/python/cpython/issues/126312}: Corrige travamento durante a coleta de lixo em um objeto congelado por @ref{b4c,,gc.freeze()} na construção com threads livres.

@item 
gh-126139@footnote{https://github.com/python/cpython/issues/126139}: Fornece melhor localização de erro ao tentar usar uma @ref{dd5,,instrução future} com um recurso futuro desconhecido.

@item 
gh-126018@footnote{https://github.com/python/cpython/issues/126018}: Corrige travamento em @ref{16a0,,sys.audit()} ao passar uma não string como primeiro argumento e o Python foi compilado no modo de depuração.

@item 
gh-125942@footnote{https://github.com/python/cpython/issues/125942}: No Android, a configuração @code{errors} de @ref{ae6,,sys.stdout} foi alterada de @code{surrogateescape} para @code{backslashreplace}.

@item 
gh-125859@footnote{https://github.com/python/cpython/issues/125859}: Corrige uma falha na construção com threads livres quando @ref{806,,gc.get_objects()} ou @ref{807,,gc.get_referrers()} é chamado durante uma coleta de lixo em andamento.

@item 
gh-125703@footnote{https://github.com/python/cpython/issues/125703}: Honra corretamente os ganchos @ref{ff,,tracemalloc} em caminhos @code{Py_DECREF} especializados. Patch por Pablo Galindo

@item 
gh-125593@footnote{https://github.com/python/cpython/issues/125593}: Usa cores para destacar locais de erro no traceback do grupo de exceções

@item 
gh-125444@footnote{https://github.com/python/cpython/issues/125444}: Corrige instruções ilegais para arquiteturas Arm mais antigas. Patch por Diego Russo, testes de Ross Burton.

@item 
gh-124375@footnote{https://github.com/python/cpython/issues/124375}: Corrige uma falha na construção com threads livres quando o GC é executado simultaneamente com uma nova thread iniciando.

@item 
gh-125221@footnote{https://github.com/python/cpython/issues/125221}: Corrige possível condição de corrida ao chamar @ref{16a1,,__reduce_ex__()} pela primeira vez na construção com threads livres.

@item 
gh-125038@footnote{https://github.com/python/cpython/issues/125038}: Corrige falha ao iterar sobre uma expressão geradora após alterações diretas em @code{gi_frame.f_locals}. Patch por Mikhail Efimov.

@item 
gh-123378@footnote{https://github.com/python/cpython/issues/123378}: Corrige uma falha no método @ref{61d,,__str__()} de objetos @ref{12e6,,UnicodeError} quando os valores @ref{16a2,,UnicodeError.start} e @ref{16a3,,UnicodeError.end} são inválidos ou estão fora do intervalo. Patch por Bénédikt Tran.

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: Corrige uma falha causada por strings internas imortais sendo compartilhadas entre subinterpretadores que usam inicialização básica de fase única. Nesse caso, a string pode ser usada por um interpretador que sobrevive ao interpretador que a criou e a internou. Para interpretadores que compartilham o estado obmalloc, compartilhe também o dict interno com o interpretador principal.

@item 
gh-122878@footnote{https://github.com/python/cpython/issues/122878}: Usa o binário @code{pager}, se disponível (por exemplo, no Debian e derivados), para exibir REPL @code{help()}.

@item 
gh-124188@footnote{https://github.com/python/cpython/issues/124188}: Corrige a leitura e decodificação de uma linha do arquivo de origem com codificação não UTF-8 para erros de sintaxe levantados no compilador.

@item 
gh-123930@footnote{https://github.com/python/cpython/issues/123930}: Melhora a mensagem de erro quando um script que faz “shadowing” de um módulo da biblioteca padrão faz com que @ref{419,,ImportError} seja levantada durante uma importação “from”. Da mesma forma, melhore a mensagem de erro quando um script que faz shadowing de um módulo de terceiros tenta importar um atributo desse módulo de terceiros enquanto ainda está inicializando.

@item 
gh-122907@footnote{https://github.com/python/cpython/issues/122907}: A construção com @code{HAVE_DYNAMIC_LOADING} agora funciona tão bem quanto no 3.12. As deficiências existentes serão abordadas separadamente. (Consulte @indicateurl{https://github.com/python/cpython/issues/122950}.)
@end itemize

@node Biblioteca<18>,Núcleo e embutidos<15>,Núcleo e embutidos<14>,Python 3 13 1 final
@anchor{whatsnew/changelog id85}@anchor{16a4}
@subsubsection Biblioteca



@itemize -

@item 
gh-118950@footnote{https://github.com/python/cpython/issues/118950}: Corrige o bug em que SSLProtocol.connection_lost não estava sendo chamado quando OSError era lançada na gravação no soquete.

@item 
gh-113570@footnote{https://github.com/python/cpython/issues/113570}: Corrige um bug em @code{reprlib.repr} em que ele chamava incorretamente o método repr em tipos embutidos Python com shadowing.
@end itemize

@node Núcleo e embutidos<15>,API C<8>,Biblioteca<18>,Python 3 13 1 final
@anchor{whatsnew/changelog id86}@anchor{16a5}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-109746@footnote{https://github.com/python/cpython/issues/109746}: Se @code{_thread.start_new_thread()} falhar ao iniciar uma nova thread, ele exclui seu estado do interpretador e, portanto, evita sua limpeza repetida na finalização.
@end itemize

@node API C<8>,Construção<7>,Núcleo e embutidos<15>,Python 3 13 1 final
@anchor{whatsnew/changelog id87}@anchor{16a6}
@subsubsection API C



@itemize -

@item 
gh-126554@footnote{https://github.com/python/cpython/issues/126554}: Corrige o tratamento de erros em objetos @ref{9f1,,ctypes.CDLL} que podem resultar em uma falha em situações raras.

@item 
gh-125608@footnote{https://github.com/python/cpython/issues/125608}: Corrige um bug em que os observadores de dicionário (por exemplo, @ref{563,,PyDict_Watch()}) no dicionário de atributos de um objeto (@ref{55b,,__dict__}) não eram acionados quando os atributos do objeto eram modificados.

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: Adiciona @code{Py_IsInitialized} à lista de APIs que são seguras para chamar antes que o interpretador seja inicializado e atualiza os testes de incorporação para cobri-lo.
@end itemize

@node Construção<7>,,API C<8>,Python 3 13 1 final
@anchor{whatsnew/changelog id88}@anchor{16a7}
@subsubsection Construção



@itemize -

@item 
gh-123877@footnote{https://github.com/python/cpython/issues/123877}: Define @code{wasm32-wasip1} como o alvo WASI. O antigo alvo @code{wasm32-wasi} está descontinuado para que possa ser usado para um eventual WASI 1.0.

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: Codifica a ordem de palavras float como little endian no WASM.

@item 
gh-125940@footnote{https://github.com/python/cpython/issues/125940}: A construção no Android agora oferece suporte a tamanhos de página de 16 KB@footnote{https://developer.android.com/guide/practices/page-sizes}.

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: Melhora a detecção da ordem de palavras flutuantes no Linux quando as otimizações de tempo de link estiverem habilitadas.

@item 
gh-125269@footnote{https://github.com/python/cpython/issues/125269}: Corrige a detecção de se @code{-latomic} é necessário ao fazer compilação cruzada do CPython usando o script configure.

@item 
gh-121634@footnote{https://github.com/python/cpython/issues/121634}: Permite especificar o triplo de compilação de destino para WASI.

@item 
gh-122578@footnote{https://github.com/python/cpython/issues/122578}: Usa WASI SDK 24 para testes.

@item 
gh-115382@footnote{https://github.com/python/cpython/issues/115382}: Corrige falhas de compilação cruzada quando o host e o SOABIs de destino correspondem.
@end itemize

@node Python 3 13 0 final,Python 3 13 0 release candidate 3,Python 3 13 1 final,Changelog
@anchor{whatsnew/changelog python-3-13-0-final}@anchor{16a8}
@subsection Python 3.13.0 final


`Data de lançamento: 2024-10-07'

@menu
* Biblioteca: Biblioteca<19>. 
* Núcleo e embutidos: Núcleo e embutidos<16>. 

@end menu

@node Biblioteca<19>,Núcleo e embutidos<16>,,Python 3 13 0 final
@anchor{whatsnew/changelog id89}@anchor{16a9}
@subsubsection Biblioteca



@itemize -

@item 
gh-125008@footnote{https://github.com/python/cpython/issues/125008}: Corrige @ref{166b,,tokenize.untokenize()} produzindo sintaxe inválida para chaves duplas precedidas por certos caracteres de escape.
@end itemize

@node Núcleo e embutidos<16>,,Biblioteca<19>,Python 3 13 0 final
@anchor{whatsnew/changelog id90}@anchor{16aa}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-124871@footnote{https://github.com/python/cpython/issues/124871}: Corrige bug do compilador (em algumas versões do 3.13) onde uma asserção falha durante a análise de acessibilidade.
@end itemize

@node Python 3 13 0 release candidate 3,Python 3 13 0 release candidate 2,Python 3 13 0 final,Changelog
@anchor{whatsnew/changelog python-3-13-0-release-candidate-3}@anchor{16ab}
@subsection Python 3.13.0 release candidate 3


`Data de lançamento: 2024-10-01'

@menu
* macOS: macOS<6>. 
* Windows: Windows<9>. 
* Testes: Testes<10>. 
* Biblioteca: Biblioteca<20>. 
* IDLE: IDLE<8>. 
* Documentação: Documentação<9>. 
* Núcleo e embutidos: Núcleo e embutidos<17>. 
* API C: API C<9>. 
* Construção: Construção<8>. 

@end menu

@node macOS<6>,Windows<9>,,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id91}@anchor{16ac}
@subsubsection macOS



@itemize -

@item 
gh-123797@footnote{https://github.com/python/cpython/issues/123797}: Verifica a disponibilidade do tempo de execução da função @code{ptsname_r} no macOS.
@end itemize

@node Windows<9>,Testes<10>,macOS<6>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id92}@anchor{16ad}
@subsubsection Windows



@itemize -

@item 
gh-124609@footnote{https://github.com/python/cpython/issues/124609}: Corrige @code{_Py_ThreadId} para construções do Windows usando MinGW. Patch por Tony Roberts.

@item 
gh-124254@footnote{https://github.com/python/cpython/issues/124254}: Garante que binários experimentais de threads livres permaneçam instalados durante a atualização.

@item 
gh-123915@footnote{https://github.com/python/cpython/issues/123915}: Garante que @code{Tools\\msi\\buildrelease.bat} use diretórios diferentes para compilações AMD64 e ARM64.
@end itemize

@node Testes<10>,Biblioteca<20>,Windows<9>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id93}@anchor{16ae}
@subsubsection Testes



@itemize -

@item 
gh-124378@footnote{https://github.com/python/cpython/issues/124378}: Atualizado @code{test_ttk} para passar com Tcl/Tk 8.6.15.
@end itemize

@node Biblioteca<20>,IDLE<8>,Testes<10>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id94}@anchor{16af}
@subsubsection Biblioteca



@itemize -

@item 
gh-124538@footnote{https://github.com/python/cpython/issues/124538}: Corrige falha ao usar @ref{808,,gc.get_referents()} em um objeto cápsula.

@item 
gh-124498@footnote{https://github.com/python/cpython/issues/124498}: Corrige @ref{455,,typing.TypeAliasType} para não ser genérico, quando @code{type_params} é uma tupla vazia.

@item 
gh-123017@footnote{https://github.com/python/cpython/issues/123017}: Devido a resultados não confiáveis em alguns dispositivos, @ref{1229,,time.strftime()} não aceita mais anos negativos no Android.

@item 
gh-123014@footnote{https://github.com/python/cpython/issues/123014}: @ref{47a,,os.pidfd_open()} e @ref{932,,signal.pidfd_send_signal()} agora estão indisponíveis ao construir em níveis de API do Android mais antigos que 31, pois as chamadas de sistema subjacentes podem causar uma falha.

@item 
gh-124248@footnote{https://github.com/python/cpython/issues/124248}: Corrige possível falha ao usar @ref{d5,,struct} para processar campos ‘Pascal string’ de largura zero (@code{0p}).

@item 
gh-87041@footnote{https://github.com/python/cpython/issues/87041}: Corrige um bug em @ref{6,,argparse} onde a ajuda de argumento de sub-analisador longa é indentada incorretamente.

@item 
gh-124212@footnote{https://github.com/python/cpython/issues/124212}: Corrige variável inválida em @ref{111,,venv} manipulação de link simbólico com falha no Windows

@item 
gh-124171@footnote{https://github.com/python/cpython/issues/124171}: Adiciona solução alternativa para implementações quebradas de @code{fmod()} no Windows, que perdem o sinal de zero (por exemplo, @code{fmod(-10, 1)} retorna @code{0.0}). Patch por Sergey B Kirpichev.

@item 
gh-123934@footnote{https://github.com/python/cpython/issues/123934}: Corrige @ref{ebe,,unittest.mock.MagicMock} redefinindo valores de retorno de métodos mágicos após @code{.reset_mock(return_value=True)} ser chamado.

@item 
gh-123968@footnote{https://github.com/python/cpython/issues/123968}: Corrige a interface de linha de comando para o módulo @ref{b8,,random} para selecionar floats entre 0 e N, não 1 e N.

@item 
gh-123892@footnote{https://github.com/python/cpython/issues/123892}: Adicionar @code{"_wmi"} a @ref{844,,sys.stdlib_module_names}. Patch por Victor Stinner.

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: Corrige @ref{15f8,,inspect.getsource()} para classes nos módulos @ref{1e,,collections.abc} e @ref{36,,decimal} (para implementação Python pura). @ref{16b0,,inspect.getcomments()} agora levanta OSError em vez de IndexError se o valor @code{__firstlineno__} para uma classe estiver fora dos limites.

@item 
gh-121735@footnote{https://github.com/python/cpython/issues/121735}: Ao trabalhar com arquivos zip, importlib.resources agora honra corretamente referências adjacentes ao módulo (por exemplo, @code{files(pkg.mod)} e não apenas @code{files(pkg)}).

@item 
gh-122145@footnote{https://github.com/python/cpython/issues/122145}: Corrige um problema ao relatar tracebacks correspondentes ao código Python emitindo um corpo AST vazio. Patch de Nikita Sobolev e Bénédikt Tran.

@item 
gh-119004@footnote{https://github.com/python/cpython/issues/119004}: Corrige uma falha em @ref{16b1,,OrderedDict.__eq__} quando operandos são mutados durante a verificação. Patch por Bénédikt Tran.

@item 
bpo-44864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44864}: Não traduz strings fornecidas pelo usuário em @ref{539,,argparse.ArgumentParser}.
@end itemize

@node IDLE<8>,Documentação<9>,Biblioteca<20>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id95}@anchor{16b2}
@subsubsection IDLE



@itemize -

@item 
gh-112938@footnote{https://github.com/python/cpython/issues/112938}: Corrige travamento ininterrupto quando o console obtém saída rápida e contínua.

@item 
gh-120104@footnote{https://github.com/python/cpython/issues/120104}: Corrige preenchimento em janelas de diálogo de configuração e pesquisa no IDLE.
@end itemize

@node Documentação<9>,Núcleo e embutidos<17>,IDLE<8>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id96}@anchor{16b3}
@subsubsection Documentação



@itemize -

@item 
gh-124720@footnote{https://github.com/python/cpython/issues/124720}: Atualiza a seção “Usando Python em um Mac” do documento “Configuração e uso do Python” e incluir informações sobre a instalação do suporte a threads livres.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Adiciona um guia de plataforma Android e sinaliza módulos não disponíveis no Android.
@end itemize

@node Núcleo e embutidos<17>,API C<9>,Documentação<9>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id97}@anchor{16b4}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-124567@footnote{https://github.com/python/cpython/issues/124567}: Reverte o GC incremental (em 3.13), pois não está claro se os benefícios superam os custos neste momento.

@item 
gh-124642@footnote{https://github.com/python/cpython/issues/124642}: Corrigido problema de escalabilidade em construções com threads livres para leituras sem travas de dicionários em cenários de multithread

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: Corrige um bug que pode causar uma falha quando subinterpretadores usam módulos “básicos” de extensão de fase única. Objetos compartilhados podem se referir a nós PyGC_Head que foram liberados como parte da limpeza do interpretador.

@item 
gh-124547@footnote{https://github.com/python/cpython/issues/124547}: Ao desalocar um objeto com valores inline cujo @code{__dict__} ainda está ativo: se a alocação de memória para os valores inline falhar, limpe o dicionário. Evita uma falha do interpretador.

@item 
gh-124513@footnote{https://github.com/python/cpython/issues/124513}: Corrige uma falha no construtor FrameLocalsProxy: verifica o número de argumentos. Patch por Victor Stinner.

@item 
gh-124442@footnote{https://github.com/python/cpython/issues/124442}: Corrige não determinismo na compilação classificando o valor de @ref{14b,,__static_attributes__}. Patch por kp2pml30.

@item 
gh-123856@footnote{https://github.com/python/cpython/issues/123856}: Corrige falha do PyREPL quando uma interrupção de teclado é acionada após usar uma pesquisa de histórico

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: Documenta a descontinuação da configuração e uso de @code{__package__} e @code{__cached__}.

@item 
gh-124027@footnote{https://github.com/python/cpython/issues/124027}: Suporte às chaves @code{<page up>}, @code{<page down>} e @code{<delete>} no Python REPL quando @code{$TERM} estiver definido como @code{vt100}.

@item 
gh-77894@footnote{https://github.com/python/cpython/issues/77894}: Corrige possível travamento no coletor de lixo quando ele tenta quebrar um laço de referência contendo um objeto @ref{2eb,,memoryview}. Agora, um objeto @code{memoryview} só pode ser limpo se não houver buffers que o referenciem.

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: Define o atributo @code{__module__} para uma classe agora remove o item @code{__firstlineno__} do dict do tipo, então eles não serão mais inconsistentes.
@end itemize

@node API C<9>,Construção<8>,Núcleo e embutidos<17>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id98}@anchor{16b5}
@subsubsection API C



@itemize -

@item 
gh-124160@footnote{https://github.com/python/cpython/issues/124160}: Corrige travamento ao importar módulos contendo inicialização de estado e fase única em um subinterpretador.

@item 
gh-123880@footnote{https://github.com/python/cpython/issues/123880}: Corrige um bug que impedia importações circulares de módulos de extensão que usam inicialização de fase única.
@end itemize

@node Construção<8>,,API C<9>,Python 3 13 0 release candidate 3
@anchor{whatsnew/changelog id99}@anchor{16b6}
@subsubsection Construção



@itemize -

@item 
gh-124487@footnote{https://github.com/python/cpython/issues/124487}: As construções do Windows agora usam o Windows 8.1 como sua linha de base de API (a instalação já exigia o Windows 8.1).

@item 
gh-124043@footnote{https://github.com/python/cpython/issues/124043}: Construir usando @ref{395,,--with-trace-refs} é (temporariamente) proibido quando a GIL está desabilitado.
@end itemize

@node Python 3 13 0 release candidate 2,Python 3 13 0 release candidate 1,Python 3 13 0 release candidate 3,Changelog
@anchor{whatsnew/changelog python-3-13-0-release-candidate-2}@anchor{16b7}
@subsection Python 3.13.0 release candidate 2


`Data de lançamento: 2024-09-06'

@menu
* macOS: macOS<7>. 
* Windows: Windows<10>. 
* Ferramentas/Demos: Ferramentas/Demos<8>. 
* Testes: Testes<11>. 
* Segurança: Segurança<10>. 
* Biblioteca: Biblioteca<21>. 
* IDLE: IDLE<9>. 
* Biblioteca: Biblioteca<22>. 
* Núcleo e embutidos: Núcleo e embutidos<18>. 
* API C: API C<10>. 
* Construção: Construção<9>. 

@end menu

@node macOS<7>,Windows<10>,,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id100}@anchor{16b8}
@subsubsection macOS



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Construção do instalador do macOS atualizada para usar o OpenSSL 3.0.15.
@end itemize

@node Windows<10>,Ferramentas/Demos<8>,macOS<7>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id101}@anchor{16b9}
@subsubsection Windows



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Construção do Windows atualizada para usar o OpenSSL 3.0.15.

@item 
gh-122573@footnote{https://github.com/python/cpython/issues/122573}: A construção do Windows do CPython agora requer 3.10 ou mais recente.

@item 
gh-100256@footnote{https://github.com/python/cpython/issues/100256}: @ref{8f,,mimetypes} não falha mais quando encontra uma chave de registro inacessível.

@item 
gh-79846@footnote{https://github.com/python/cpython/issues/79846}: Faz com que @code{ssl.create_default_context()} ignore certificados inválidos no armazenamento de certificados do Windows
@end itemize

@node Ferramentas/Demos<8>,Testes<11>,Windows<10>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id102}@anchor{16ba}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Atualiza os fluxos de trabalho do GitHub CI para usar o OpenSSL 3.0.15 e multissltests para usar 3.0.15, 3.1.7 e 3.2.3.
@end itemize

@node Testes<11>,Segurança<10>,Ferramentas/Demos<8>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id103}@anchor{16bb}
@subsubsection Testes



@itemize -

@item 
gh-119727@footnote{https://github.com/python/cpython/issues/119727}: Adiciona a opção de linha de comando @code{--single-process} ao executor de testes Python (regrtest). Patch por Victor Stinner.

@item 
gh-101525@footnote{https://github.com/python/cpython/issues/101525}: Ignora @code{test_gdb} se o binário for realocado pelo BOLT. Patch por Donghee Na.
@end itemize

@node Segurança<10>,Biblioteca<21>,Testes<11>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id104}@anchor{16bc}
@subsubsection Segurança



@itemize -

@item 
gh-123678@footnote{https://github.com/python/cpython/issues/123678}: Atualiza o libexpat para 2.6.3

@item 
gh-121285@footnote{https://github.com/python/cpython/issues/121285}: Remove o backtracking da análise de cabeçalho do arquivo tar para @code{hdrcharset}, PAX e cabeçalhos esparsos GNU.
@end itemize

@node Biblioteca<21>,IDLE<9>,Segurança<10>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id105}@anchor{16bd}
@subsubsection Biblioteca



@itemize -

@item 
gh-123657@footnote{https://github.com/python/cpython/issues/123657}: Corrige o travamento e o vazamento de memória em @ref{16be,,decimal.getcontext()}. Ele travava ao usar um contexto local de thread por @code{--with-decimal-contextvar=no}.

@item 
gh-123448@footnote{https://github.com/python/cpython/issues/123448}: Corrigido vazamento de memória de @ref{262,,typing.NoDefault} movendo-o para o vetor de tipos estáticos.

@item 
gh-123409@footnote{https://github.com/python/cpython/issues/123409}: Corrige a saída de @ref{16bf,,ipaddress.IPv6Address.reverse_pointer} de acordo com 
@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 por Bénédikt Tran.

@item 
gh-123270@footnote{https://github.com/python/cpython/issues/123270}: Aplicada uma correção mais cirúrgica para payloads malformados em @ref{6c9,,zipfile.Path} causando loops infinitos (gh-122905@footnote{https://github.com/python/cpython/issues/122905}) sem quebrar o conteúdo usando caracteres legítimos.

@item 
gh-123228@footnote{https://github.com/python/cpython/issues/123228}: Corrige tipo de retorno para @code{_pyrepl.readline._ReadlineWrapper.get_line_buffer()} para ser @ref{44c,,str()}. Patch por Sergey B Kirpichev.

@item 
gh-123240@footnote{https://github.com/python/cpython/issues/123240}: Levanta eventos de auditoria para @ref{131b,,input()} no novo REPL.

@item 
gh-123243@footnote{https://github.com/python/cpython/issues/123243}: Corrige vazamento de memória em @code{_decimal}.

@item 
gh-122546@footnote{https://github.com/python/cpython/issues/122546}: Usar consistentemente o mesmo nome de arquivo para diferentes exceções no novo repl. Patch por Sergey B Kirpichev.

@item 
gh-123213@footnote{https://github.com/python/cpython/issues/123213}: A atribuição @ref{1213,,xml.etree.ElementTree.Element.extend()} e @ref{310,,Element} não oculta mais a exceção interna se um gerador errôneo for passado. Patch por Bar Harel.

@item 
gh-85110@footnote{https://github.com/python/cpython/issues/85110}: Preserva caminho relativo em URL sem netloc em @ref{16c0,,urllib.parse.urlunsplit()} e @ref{16c1,,urllib.parse.urlunparse()}.

@item 
gh-123067@footnote{https://github.com/python/cpython/issues/123067}: Corrige complexidade quadrática na análise de valores de cookies entre aspas @code{"} com contrabarras por @ref{71,,http.cookies}.

@item 
gh-122981@footnote{https://github.com/python/cpython/issues/122981}: Corrige @ref{15f8,,inspect.getsource()} para classes geradas com classes base Python (por exemplo, enums).

@item 
gh-122903@footnote{https://github.com/python/cpython/issues/122903}: @code{zipfile.Path.glob} agora corresponde corretamente aos diretórios em vez de omiti-los silenciosamente.

@item 
gh-122905@footnote{https://github.com/python/cpython/issues/122905}: Objetos @ref{6c9,,zipfile.Path} agora sanitizam nomes do arquivo zip.

@item 
gh-122695@footnote{https://github.com/python/cpython/issues/122695}: Corrige liberação dupla ao usar @ref{808,,gc.get_referents()} com um iterador @ref{be6,,asyncio.Future} liberado.

@item 
gh-116263@footnote{https://github.com/python/cpython/issues/116263}: @ref{16c2,,logging.handlers.RotatingFileHandler} não substitui mais  arquivos de log vazios.

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: Restaura o método descontinuado @code{warn()} do @ref{87,,logging}. Ele foi removido no Python 3.13 alpha 1. Mantém o método descontinuado @code{warn()} no Python 3.13. Patch por Victor Stinner.

@item 
gh-122744@footnote{https://github.com/python/cpython/issues/122744}: Sobe a versão do pip empacotado em ensurepip para a versão 24.2.

@item 
gh-118814@footnote{https://github.com/python/cpython/issues/118814}: Corrige o construtor @ref{15d,,typing.TypeVar} quando o nome for passado como argumento nomeado.

@item 
gh-122478@footnote{https://github.com/python/cpython/issues/122478}: Remove quadros internos de tracebacks mostrados em @ref{16c3,,code.InteractiveInterpreter} com @ref{80e,,sys.excepthook()} não padrão. Salve os tracebacks corretos em @ref{4c1,,sys.last_traceback} e atualize o atributo @code{__traceback__} de @ref{4c0,,sys.last_value} e @ref{4be,,sys.last_exc}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: No Android, as constantes @code{FICLONE} e @code{FICLONERANGE} não são mais expostas por @ref{59,,fcntl}, pois esses ioctls são bloqueados pelo SELinux.

@item 
gh-82378@footnote{https://github.com/python/cpython/issues/82378}: Garante que o novo @ref{16a,,REPL} interprete @ref{16c4,,sys.tracebacklimit} da mesma forma que o REPL clássico.

@item 
gh-122334@footnote{https://github.com/python/cpython/issues/122334}: Corrige o travamento ao importar @ref{d0,,ssl} após a reinicialização do interpretador principal.

@item 
gh-87320@footnote{https://github.com/python/cpython/issues/87320}: Em @ref{16c3,,code.InteractiveInterpreter}, trata exceções causadas pela chamada de um @ref{80e,,sys.excepthook()} não padrão. Antes, a exceção era apresentada para o chamador, encerrando o @ref{16a,,REPL}.

@item 
gh-121650@footnote{https://github.com/python/cpython/issues/121650}: Cabeçalhos @ref{3b,,email} com quebras de linha incorporadas agora são citados na saída. O @ref{40,,generator} agora se recusará a serializar (escrever) cabeçalhos que são dobrados ou delimitados de forma insegura; consulte @ref{1e0,,verify_generated_headers}. (Contribuição de Bas Bloemsaat e Petr Viktorin em gh-121650@footnote{https://github.com/python/cpython/issues/121650}.)

@item 
gh-121723@footnote{https://github.com/python/cpython/issues/121723}: Faz @ref{11ef,,logging.config.dictConfig()} aceitar qualquer objeto que implemente a API pública Queue. Veja a seção @ref{16c5,,configuração de fila} para detalhes. Patch por Bénédikt Tran.

@item 
gh-122081@footnote{https://github.com/python/cpython/issues/122081}: Corrige uma falha na função opcional @code{decimal.IEEEContext()} disponível por meio do sinalizador de configuração @code{EXTRA_FUNCTIONALITY}.

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: Mostra corretamente os locais de erro quando @ref{18d,,SyntaxError} é levantada em um novo repl. Patch por Sergey B Kirpichev.

@item 
gh-121151@footnote{https://github.com/python/cpython/issues/121151}: Corrige o encapsulamento de texto de uso longo de argumentos dentro de um grupo mutuamente exclusivo em @ref{6,,argparse}.

@item 
gh-108172@footnote{https://github.com/python/cpython/issues/108172}: @code{webbrowser} honra o navegador preferido do sistema no Linux quando a entrada desktop de nome contém o texto de um nome de navegador conhecido.

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: Agora você pode obter as cadeias de certificados TLS brutas de conexões TLS por meio dos métodos @ref{16c6,,ssl.SSLSocket.get_verified_chain()} e @ref{16c7,,ssl.SSLSocket.get_unverified_chain()}.

Contribuição de Mateusz Nowak.
@end itemize

@node IDLE<9>,Biblioteca<22>,Biblioteca<21>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id106}@anchor{16c8}
@subsubsection IDLE



@itemize -

@item 
gh-120083@footnote{https://github.com/python/cpython/issues/120083}: Adiciona a cor preta explícita como primeiro plano de dicas flutuantes (hovertips) do IDLE, necessário para macOS recentes. Corrige o Sonoma mostrando branco ilegível em amarelo claro. Patch por John Riggles.
@end itemize

@node Biblioteca<22>,Núcleo e embutidos<18>,IDLE<9>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id107}@anchor{16c9}
@subsubsection Biblioteca



@itemize -

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: o REPL do asyncio agora está reconhecendo corretamente KeyboardInterrupts. A exibição de exceções levantadas em threads secundárias foi corrigida.
@end itemize

@node Núcleo e embutidos<18>,API C<10>,Biblioteca<22>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id108}@anchor{16ca}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-119310@footnote{https://github.com/python/cpython/issues/119310}: Permite que o novo console interativo leia arquivos de histórico escritos com a biblioteca editline que usam entradas com escape unicode. Patch por aorcajo e Łukasz Langa.

@item 
gh-123572@footnote{https://github.com/python/cpython/issues/123572}: Corrige mapeamentos de teclas para várias teclas F no Windows para o novo REPL. Patch por devdanzin

@item 
gh-119034@footnote{https://github.com/python/cpython/issues/119034}: Altera as teclas @code{<page up>} e @code{<page down>} do REPL do Python para pesquisa de histórico para frente/para trás. Patch por Victor Stinner.

@item 
gh-123545@footnote{https://github.com/python/cpython/issues/123545}: Corrige um decref duplo em casos raros em construções JIT experimentais.

@item 
gh-123484@footnote{https://github.com/python/cpython/issues/123484}: Corrige @code{_Py_DebugOffsets} para objetos longos para serem relativos ao início do objeto em vez do início de um subobjeto.

@item 
gh-123344@footnote{https://github.com/python/cpython/issues/123344}: Adiciona otimizações AST para padrões de parâmetros de tipo.

@item 
gh-123321@footnote{https://github.com/python/cpython/issues/123321}: Impede que a condição de corrida Parser/myreadline apresente falhas de segmentação no uso multithread. Patch por Bar Harel e Amit Wienner.

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: Corrige um bug que causava o aparecimento de prompts perdidos no meio de linhas quebradas no novo REPL.

@item 
gh-122982@footnote{https://github.com/python/cpython/issues/122982}: Estende o período de descontinuação para inversão de bool (@code{~}) em dois anos.

@item 
gh-123275@footnote{https://github.com/python/cpython/issues/123275}: Suporte a @ref{176,,-X gil=1} e a 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL=1} em construções sem threads livres.

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: Desativa quebra de linha no Apple Terminal por meio de um código de escape ANSI. Patch por Pablo Galindo

@item 
gh-123229@footnote{https://github.com/python/cpython/issues/123229}: Corrige o aviso valgrind inicializando os buffers f-string para 0 no tokenizador. Patch por Pablo Galindo

@item 
gh-122298@footnote{https://github.com/python/cpython/issues/122298}: Restaura a impressão das estatísticas do GC quando @code{gc.set_debug(gc.DEBUG_STATS)} é chamado. Este recurso foi removido acidentalmente ao implementar o GC incremental.

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: Mostra corretamente os locais de erro quando uma @ref{18d,,SyntaxError} é levanta no REPL básico. Patch por Sergey B Kirpichev.

@item 
gh-123142@footnote{https://github.com/python/cpython/issues/123142}: Corrige o local de origem muito amplo em tracebacks de exceção provenientes de iteráveis quebrados em compreensões.

@item 
gh-123048@footnote{https://github.com/python/cpython/issues/123048}: Corrige um bug em que o código de correspondência de padrões poderia emitir um @ref{16cb,,JUMP_FORWARD} sem local de origem.

@item 
gh-123123@footnote{https://github.com/python/cpython/issues/123123}: Corrige a exibição de exceções @ref{18d,,SyntaxError} cobrindo várias linhas. Patch por Pablo Galindo

@item 
gh-123083@footnote{https://github.com/python/cpython/issues/123083}: Corrige um possível uso após liberação em @code{STORE_ATTR_WITH_HINT}.

@item 
gh-123022@footnote{https://github.com/python/cpython/issues/123022}: Corrige falha em construção com threads livres ao chamar @ref{8b1,,Py_Initialize()} de uma thread não principal.

@item 
gh-122888@footnote{https://github.com/python/cpython/issues/122888}: Corrige falha em certas chamadas para @code{str()} com argumentos posicionais do tipo errado. Patch por Jelle Zijlstra.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Corrige mensagens stdout e stderr do Android sendo truncadas ou perdidas.

@item 
gh-122527@footnote{https://github.com/python/cpython/issues/122527}: Corrige uma falha que ocorria quando um @code{PyStructSequence} era desalocado após o dicionário do seu tipo ser limpo pelo GC. O @ref{98e,,tp_basicsize} do tipo agora considera campos não sequenciais que não estão incluídos no @ref{782,,Py_SIZE} da sequência.

@item 
gh-122445@footnote{https://github.com/python/cpython/issues/122445}: Adiciona somente campos que são modificados via self.* para @ref{14b,,__static_attributes__}.

@item 
gh-98442@footnote{https://github.com/python/cpython/issues/98442}: Corrige localizações de origem muito amplas das instruções de limpeza de uma declaração with.

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: Corrige localizações de origem de instruções geradas para declarações with.

@item 
gh-120097@footnote{https://github.com/python/cpython/issues/120097}: @code{FrameLocalsProxy} agora é uma subclasse de @code{collections.abc.Mapping} e pode ser correspondido como um mapeamento em instruções @code{match}
@end itemize

@node API C<10>,Construção<9>,Núcleo e embutidos<18>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id109}@anchor{16cc}
@subsubsection API C



@itemize -

@item 
gh-122728@footnote{https://github.com/python/cpython/issues/122728}: Corrige @ref{353,,PyEval_GetLocals()} para evitar @ref{575,,SystemError} (“argumento ruim para função interna”). Patch por Victor Stinner.
@end itemize

@node Construção<9>,,API C<10>,Python 3 13 0 release candidate 2
@anchor{whatsnew/changelog id110}@anchor{16cd}
@subsubsection Construção



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: Atualizada construção do Android para usar OpenSSL 3.0.15.

@item 
gh-123297@footnote{https://github.com/python/cpython/issues/123297}: Propaga o valor de @code{LDFLAGS} para @code{LDCXXSHARED} em @ref{db,,sysconfig}. Patch por Pablo Galindo

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Renomeia variável de construção @code{MODULE_LDFLAGS} de volta para @code{LIBPYTHON}, como é usada por sistemas de construção de pacotes (por exemplo, Meson).

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Corrige um problema em que o JIT experimental poderia ser construído várias vezes pelo alvo @code{make regen-all}, levando a possíveis condições de corrida em construções fortemente paralelizadas.

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Corrige uma possível condição de corrida afetando construções paralelas configuradas com @code{--enable-experimental-jit}, em que @ref{42b,,FileNotFoundError} poderia ser causado por outro processo que já estava movendo @code{jit_stencils.h.new} para @code{jit_stencils.h}.
@end itemize

@node Python 3 13 0 release candidate 1,Python 3 13 0 beta 4,Python 3 13 0 release candidate 2,Changelog
@anchor{whatsnew/changelog python-3-13-0-release-candidate-1}@anchor{16ce}
@subsection Python 3.13.0 release candidate 1


`Data de lançamento: 2024-07-31'

@menu
* Testes: Testes<12>. 
* Segurança: Segurança<11>. 
* Biblioteca: Biblioteca<23>. 
* IDLE: IDLE<10>. 
* Núcleo e embutidos: Núcleo e embutidos<19>. 
* API C: API C<11>. 
* Construção: Construção<10>. 

@end menu

@node Testes<12>,Segurança<11>,,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id111}@anchor{16cf}
@subsubsection Testes



@itemize -

@item 
gh-59022@footnote{https://github.com/python/cpython/issues/59022}: Adiciona testes para @ref{16d0,,pkgutil.extend_path()}. Patch por Andreas Stocker.

@item 
gh-99242@footnote{https://github.com/python/cpython/issues/99242}: @ref{16d1,,os.getloadavg()} pode levantar @ref{417,,OSError} ao executar testes de regressão sob certas condições (por exemplo, chroot). Este erro agora é capturado e ignorado, pois o relatório da média de carga é opcional.
@end itemize

@node Segurança<11>,Biblioteca<23>,Testes<12>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id112}@anchor{16d2}
@subsubsection Segurança



@itemize -

@item 
gh-122133@footnote{https://github.com/python/cpython/issues/122133}: Autentica a conexão de soquete para o fallback @code{socket.socketpair()} em plataformas onde @code{AF_UNIX} não está disponível, como o Windows.

Patch por Gregory P. Smith <@email{greg@@krypto.org}> e Seth Larson <@email{seth@@python.org}>. Reportado por Ellie <@email{el@@horse64.org}>

@item 
gh-121957@footnote{https://github.com/python/cpython/issues/121957}: Corrigidos eventos de auditoria ausentes no uso interativo do Python, agora também sendo acionados corretamente para @code{python -i}, bem como para @code{python -m asyncio}. Os eventos em questão são @code{cpython.run_stdin} e @code{cpython.run_startup}.
@end itemize

@node Biblioteca<23>,IDLE<10>,Segurança<11>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id113}@anchor{16d3}
@subsubsection Biblioteca



@itemize -

@item 
gh-122400@footnote{https://github.com/python/cpython/issues/122400}: Lida com @ref{202,,ValueError}s levantados por @ref{4a0,,os.stat()} em @ref{f73,,filecmp.dircmp} e @ref{16d4,,filecmp.cmpfiles()}. Patch por Bénédikt Tran.

@item 
gh-122311@footnote{https://github.com/python/cpython/issues/122311}: Corrige algumas mensagens de erro em @ref{a6,,pickle}.

@item 
gh-122332@footnote{https://github.com/python/cpython/issues/122332}: Corrigido segfault com @ref{9e4,,asyncio.Task.get_coro()} ao usar uma fábrica de tarefas ansiosa.

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: a função @ref{29c,,ctypes.ARRAY()} agora está @ref{209,,suavemente descontinuada}: ela não emite mais avisos de descontinuação e não está programada para remoção.

@item 
gh-122087@footnote{https://github.com/python/cpython/issues/122087}: Restaura @ref{16d5,,inspect.ismethoddescriptor()} e @ref{16d6,,inspect.isroutine()} retornando @code{False} para objetos @ref{414,,functools.partial}.

@item 
gh-122170@footnote{https://github.com/python/cpython/issues/122170}: Lida com @ref{202,,ValueError}s levantadas por @ref{4a0,,os.stat()} em @ref{85,,linecache}. Patch por Bénédikt Tran.

@item 
gh-82951@footnote{https://github.com/python/cpython/issues/82951}: Serializa objetos com @code{__qualname__} complexo (como métodos não vinculados e classes aninhadas) por nome não envolve mais serializar objetos pais por valor em protocolos pickle < 4.

@item 
gh-113785@footnote{https://github.com/python/cpython/issues/113785}: @ref{29,,csv} agora analisa corretamente campos numéricos (quando usados com @ref{16d7,,csv.QUOTE_NONNUMERIC} ou @ref{485,,csv.QUOTE_STRINGS}) que começam com um caractere de escape.

@item 
gh-122088@footnote{https://github.com/python/cpython/issues/122088}: @ref{160,,@@warnings.deprecated} agora copia o status da corrotina de funções e métodos para que @ref{2e4,,inspect.iscoroutinefunction()} retorne o resultado correto.

@item 
gh-120930@footnote{https://github.com/python/cpython/issues/120930}: Corrigido um bug introduzido por gh-92081@footnote{https://github.com/python/cpython/issues/92081} que adicionava um espaço extra incorreto para palavras codificadas ocorrendo em cabeçalhos encapsulados.

@item 
gh-121474@footnote{https://github.com/python/cpython/issues/121474}: Corrigida a verificação de sanidade ausente para o argumento @code{parties} no construtor @ref{1223,,threading.Barrier}. Patch por Clinton Christian (pygeek).

@item 
gh-120289@footnote{https://github.com/python/cpython/issues/120289}: Corrigido o problema de uso após liberação em @ref{27,,cProfile} ao desabilitar @code{disable()} e @code{clear()} em temporizadores externos.
@end itemize

@node IDLE<10>,Núcleo e embutidos<19>,Biblioteca<23>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id114}@anchor{16d8}
@subsubsection IDLE



@itemize -

@item 
gh-122482@footnote{https://github.com/python/cpython/issues/122482}: Alterado o Sobre do IDLE para direcionar os usuários para discuss.python.org em vez do e-mail e lista de discussão idle-dev, agora não utilizados.
@end itemize

@node Núcleo e embutidos<19>,API C<11>,IDLE<10>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id115}@anchor{16d9}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-116090@footnote{https://github.com/python/cpython/issues/116090}: Corrige um problema em construções JIT que impediam alguns loops @ref{2f2,,for} de disparar corretamente eventos de monitoramento @ref{16da,,RAISE}.

@item 
gh-122208@footnote{https://github.com/python/cpython/issues/122208}: Os monitoradores de dicionário agora só entregam o evento PyDict_EVENT_ADDED quando a inserção está em um estado conhecido como bom para ser bem-sucedida.

@item 
gh-122300@footnote{https://github.com/python/cpython/issues/122300}: Preserva nós AST para f-string com especificadores de formato de elemento único. Patch por Pablo Galindo

@item 
gh-120906@footnote{https://github.com/python/cpython/issues/120906}: @ref{182,,frame.f_locals} agora oferece suporte a objetos hash arbitrários como chaves.

@item 
gh-122029@footnote{https://github.com/python/cpython/issues/122029}: Emite eventos @code{c_call} em @ref{1546,,sys.setprofile()} quando um @code{PyMethodObject} apontando para um @code{PyCFunction} é chamado.

@item 
gh-122026@footnote{https://github.com/python/cpython/issues/122026}: Corrige um bug que fazia com que o tokenizador não identificasse corretamente parênteses incompatíveis dentro de f-strings em algumas situações. Patch por Pablo Galindo

@item 
gh-118934@footnote{https://github.com/python/cpython/issues/118934}: Faz @code{PyEval_GetLocals} retornar referência emprestada
@end itemize

@node API C<11>,Construção<10>,Núcleo e embutidos<19>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id116}@anchor{16db}
@subsubsection API C



@itemize -

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Faz @ref{16dc,,PyObject_Print} contornar um bug no Android e OpenBSD que o impedia de levantar uma exceção ao tentar gravar em um fluxo somente leitura.

@item 
gh-121489@footnote{https://github.com/python/cpython/issues/121489}: Exporta @code{_PyBytes_Join()} privada novamente.
@end itemize

@node Construção<10>,,API C<11>,Python 3 13 0 release candidate 1
@anchor{whatsnew/changelog id117}@anchor{16dd}
@subsubsection Construção



@itemize -

@item 
gh-120522@footnote{https://github.com/python/cpython/issues/120522}: Adicionada uma opção @ref{16de,,--with-app-store-compliance} para corrigir problemas conhecidos com processos de revisão da App Store do macOS/iOS.
@end itemize

@node Python 3 13 0 beta 4,Python 3 13 0 beta 3,Python 3 13 0 release candidate 1,Changelog
@anchor{whatsnew/changelog python-3-13-0-beta-4}@anchor{16df}
@subsection Python 3.13.0 beta 4


`Data de lançamento: 2024-07-18'

@menu
* Testes: Testes<13>. 
* Biblioteca: Biblioteca<24>. 
* IDLE: IDLE<11>. 
* Documentação: Documentação<10>. 
* Núcleo e embutidos: Núcleo e embutidos<20>. 
* API C: API C<12>. 
* Construção: Construção<11>. 

@end menu

@node Testes<13>,Biblioteca<24>,,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id118}@anchor{16e0}
@subsubsection Testes



@itemize -

@item 
gh-121084@footnote{https://github.com/python/cpython/issues/121084}: Corrige vazamentos aleatórios de test_typing. Limpa caches ABC de tipagem ao executar testes para refleaks (opção @code{-R}): chama @code{_abc_caches_clear()} em classes abstratas de tipagem e suas subclasses. Patch por Victor Stinner.

@item 
gh-121160@footnote{https://github.com/python/cpython/issues/121160}: Adiciona um teste para @ref{16e1,,readline.set_history_length()}. Observe que este teste pode falhar em bibliotecas readline.

@item 
gh-121200@footnote{https://github.com/python/cpython/issues/121200}: Corrige @code{test_expanduser_pwd2()} de @code{test_posixpath}. Chama @code{getpwnam()} para obter @code{pw_dir}, pois pode ser diferente de @code{getpwall()} @code{pw_dir}. Patch por Victor Stinner.

@item 
gh-121188@footnote{https://github.com/python/cpython/issues/121188}: Ao criar o arquivo XML JUnit, o regrtest agora escapa caracteres inválidos em XML, como o caractere de controle chr(27) usado em sequências de escape ANSI. Patch por Victor Stinner.
@end itemize

@node Biblioteca<24>,IDLE<11>,Testes<13>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id119}@anchor{16e2}
@subsubsection Biblioteca



@itemize -

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: O argumento `shallow' para @ref{f73,,filecmp.dircmp} (novo no Python 3.13) agora é somente-nomeado.

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: Simplifica o tratamento do arquivo de histórico no auxiliar @code{site.register_readline()}. A variável @code{CAN_USE_PYREPL} agora será inicializada quando importada. Patch por Sergey B Kirpichev.

@item 
gh-121332@footnote{https://github.com/python/cpython/issues/121332}: Corrige o construtor de nós @ref{8,,ast} com @code{_attributes} personalizados. Anteriormente, passar atributos personalizados levantaria @ref{1a5,,DeprecationWarning}. Passar argumentos para o construtor que não estão em @code{_fields} ou @code{_attributes} continua descontinuado. Patch por Jelle Zijlstra.

@item 
gh-121279@footnote{https://github.com/python/cpython/issues/121279}: Evita @ref{43f,,NameError} para o módulo @ref{112,,warnings} ao acessar os atributos descontinuados do módulo @ref{78,,importlib.abc}.

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: Corrige um bug no tratamento do histórico de comandos do novo @ref{16a,,REPL} que fazia com que o arquivo de histórico fosse apagado na saída do REPL.

@item 
gh-87744@footnote{https://github.com/python/cpython/issues/87744}: Corrige a corrida waitpid ao chamar @ref{16e3,,send_signal()} em asyncio. Patch por Kumar Aditya.

@item 
gh-121018@footnote{https://github.com/python/cpython/issues/121018}: Corrigidos outros problemas em que @ref{539,,argparse.ArgumentParser} não honrava @code{exit_on_error=False}.

@item 
gh-120678@footnote{https://github.com/python/cpython/issues/120678}: Corrigida a regressão no novo REPL que significava que globais de arquivos passados usando o argumento @code{-i} não seriam incluídos no namespace global do REPL. Patch por Alex Waygood.

@item 
gh-120782@footnote{https://github.com/python/cpython/issues/120782}: Corrigidas referências erradas dos tipos @ref{30,,datetime} após recarregar o módulo.

@item 
gh-120713@footnote{https://github.com/python/cpython/issues/120713}: @ref{caf,,datetime.datetime.strftime()} agora preenche com 0 anos com menos de quatro dígitos para os especificadores de formato @code{%Y} e @code{%G} no Linux. Patch por Ben Hsing

@item 
gh-117983@footnote{https://github.com/python/cpython/issues/117983}: Adia a importação de @code{threading} em @code{importlib.util} até que o carregamento preguiçoso seja usado.

@item 
gh-119189@footnote{https://github.com/python/cpython/issues/119189}: Ao usar o operador @code{**} ou @ref{9da,,pow()} com @ref{1e7,,Fraction} como base e um expoente que não seja racional, um float ou um complexo, a fração não é mais convertida em um float.

@item 
gh-118714@footnote{https://github.com/python/cpython/issues/118714}: Permite @code{restart} na depuração post-mortem de @ref{a5,,pdb}. Removida a mensagem de reinicialização quando o usuário sai do pdb do modo post-mortem.

@item 
gh-105623@footnote{https://github.com/python/cpython/issues/105623}: Corrige degradação de desempenho em @ref{16c2,,logging.handlers.RotatingFileHandler}. Patch por Craig Robson.
@end itemize

@node IDLE<11>,Documentação<10>,Biblioteca<24>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id120}@anchor{16e4}
@subsubsection IDLE



@itemize -

@item 
gh-78889@footnote{https://github.com/python/cpython/issues/78889}: Para o congelamentos do Shell bloqueando o acesso do usuário a atributos sys.stdout.shell que não são métodos, que são todos privados.
@end itemize

@node Documentação<10>,Núcleo e embutidos<20>,IDLE<11>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id121}@anchor{16e5}
@subsubsection Documentação



@itemize -

@item 
gh-121749@footnote{https://github.com/python/cpython/issues/121749}: Corrige documentação para @ref{365,,PyModule_AddObjectRef()}.

@item 
gh-120012@footnote{https://github.com/python/cpython/issues/120012}: Esclarece os comportamentos de @ref{16e6,,multiprocessing.Queue.empty()} e @ref{16e7,,multiprocessing.SimpleQueue.empty()} em filas fechadas. Patch por Bénédikt Tran.
@end itemize

@node Núcleo e embutidos<20>,API C<12>,Documentação<10>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id122}@anchor{16e8}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-121860@footnote{https://github.com/python/cpython/issues/121860}: Corrige travamento ao rematerializar um dicionário gerenciado após ele ter sido excluído.

@item 
gh-121814@footnote{https://github.com/python/cpython/issues/121814}: Corrigido o SegFault quando @ref{421,,PyEval_SetTrace()} é usado sem nenhum quadro Python na pilha.

@item 
gh-121295@footnote{https://github.com/python/cpython/issues/121295}: Corrigido o console PyREPL entrando em um estado bloqueado após interromper uma colagem longa

@item 
gh-121794@footnote{https://github.com/python/cpython/issues/121794}: Corrigido o bug no Python de threads livres onde um objeto ressuscitado poderia levar a uma falha de asserção de contagem de referência negativa.

@item 
gh-121657@footnote{https://github.com/python/cpython/issues/121657}: Melhorada a mensagem de @ref{18d,,SyntaxError} se o usuário tentar usar @ref{9d5,,yield from} fora de uma função.

@item 
gh-121609@footnote{https://github.com/python/cpython/issues/121609}: Corrigido o ato de colar caracteres contendo unicode character joiners no novo REPL. Patch por Marta Gomez Macias

@item 
gh-117482@footnote{https://github.com/python/cpython/issues/117482}: Invólucros de slot inesperados não são mais criados para tipos estáticos embutidos em subinterpretadores.

@item 
gh-121499@footnote{https://github.com/python/cpython/issues/121499}: Corrige um bug que afetava como o histórico multilinha estava sendo renderizado no novo REPL após interagir com o novo cache de tela. Patch por Pablo Galindo

@item 
gh-121497@footnote{https://github.com/python/cpython/issues/121497}: Corrige um bug que impedia o REPL de respeitar corretamente o histórico quando um gancho de entrada era definido. Patch por Pablo Galindo

@item 
gh-121012@footnote{https://github.com/python/cpython/issues/121012}: A execução do nível 2 agora garante que os iteradores de lista permaneçam esgotados, uma vez que se esgotem.

@item 
gh-121439@footnote{https://github.com/python/cpython/issues/121439}: Permite que tuplas de comprimento 20 na lista de liberação sejam reutilizadas.

@item 
gh-121368@footnote{https://github.com/python/cpython/issues/121368}: Corrige a condição de corrida em @code{_PyType_Lookup} na construção com threads livres devido a uma cerca de memória ausente. Isso pode levar @code{_PyType_Lookup} a retornar resultados incorretos no arm64.

@item 
gh-121130@footnote{https://github.com/python/cpython/issues/121130}: Corrige f-strings com expressões de depuração em especificadores de formato. Patch por Pablo Galindo

@item 
gh-121115@footnote{https://github.com/python/cpython/issues/121115}: @ref{361,,PyLong_AsNativeBytes()} não usa mais métodos @ref{71d,,__index__()} por padrão. O sinalizador @code{Py_ASNATIVEBYTES_ALLOW_INDEX} foi adicionado para permitir isso.
@end itemize

@node API C<12>,Construção<11>,Núcleo e embutidos<20>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id123}@anchor{16e9}
@subsubsection API C



@itemize -

@item 
gh-89364@footnote{https://github.com/python/cpython/issues/89364}: Exporta a função @ref{1422,,PySignal_SetWakeupFd()}. Anteriormente, a função era documentada, mas não podia ser usada em código de terceiros. Patch por Victor Stinner.

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: @ref{8b6,,PyUnicode_InternInPlace()} não impede mais que seu argumento seja coletado como lixo.

Várias funções que usam @code{char *} agora são documentadas como possivelmente impedindo que objetos de string sejam coletados como lixo; consulte a documentação para obter detalhes: @ref{16ea,,PyUnicode_InternFromString()}, @ref{16eb,,PyDict_SetItemString()}, @ref{16ec,,PyObject_SetAttrString()}, @ref{1620,,PyObject_DelAttrString()}, @ref{16ea,,PyUnicode_InternFromString()} e funções de conveniência @code{PyModule_Add*}.

@item 
gh-113601@footnote{https://github.com/python/cpython/issues/113601}: Removidas asserções de construção de depuração relacionadas a strings internas, que eram falsamente acionadas por extensões ABI estáveis.

@item 
gh-112136@footnote{https://github.com/python/cpython/issues/112136}: Restaura a estrutura privada @code{_PyArg_Parser} e a função privada @code{_PyArg_ParseTupleAndKeywordsFast()}, removidas anteriormente no Python 3.13 alpha 1. Patch por Victor Stinner.
@end itemize

@node Construção<11>,,API C<12>,Python 3 13 0 beta 4
@anchor{whatsnew/changelog id124}@anchor{16ed}
@subsubsection Construção



@itemize -

@item 
gh-120371@footnote{https://github.com/python/cpython/issues/120371}: Suporta WASI SDK 22 ignorando explicitamente funções que são apenas stubs em wasi-libc.

@item 
gh-121731@footnote{https://github.com/python/cpython/issues/121731}: Corrige erro de construção mimalloc no GNU/Hurd

@item 
gh-121487@footnote{https://github.com/python/cpython/issues/121487}: Corrige aviso de descontinuação para ATOMIC_VAR_INIT em mimalloc.

@item 
gh-121467@footnote{https://github.com/python/cpython/issues/121467}: Corrige um bug do Makefile que impedia a instalação de arquivos de cabeçalho mimalloc.

@item 
gh-121103@footnote{https://github.com/python/cpython/issues/121103}: Em sistemas POSIX, excluindo instalações do framework macOS, o diretório lib para a construção com threads livres agora inclui um sufixo “t” para evitar conflitos com uma instalação de construção padrão co-localizada.

@item 
gh-120831@footnote{https://github.com/python/cpython/issues/120831}: A versão mínima padrão do iOS foi aumentada para 13.0.

@item 
gh-113565@footnote{https://github.com/python/cpython/issues/113565}: Melhora as verificações de dependência @ref{2b,,curses} e @ref{2d,,curses.panel} em @code{configure}.
@end itemize

@node Python 3 13 0 beta 3,Python 3 13 0 beta 2,Python 3 13 0 beta 4,Changelog
@anchor{whatsnew/changelog python-3-13-0-beta-3}@anchor{16ee}
@subsection Python 3.13.0 beta 3


`Data de lançamento: 2024-06-27'

@menu
* Núcleo e embutidos: Núcleo e embutidos<21>. 
* Biblioteca: Biblioteca<25>. 
* Núcleo e embutidos: Núcleo e embutidos<22>. 
* Biblioteca: Biblioteca<26>. 
* Construção: Construção<12>. 
* API C: API C<13>. 

@end menu

@node Núcleo e embutidos<21>,Biblioteca<25>,,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id125}@anchor{16ef}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-120838@footnote{https://github.com/python/cpython/issues/120838}: @ref{13a0,,Py_Finalize()} e @ref{d37,,Py_FinalizeEx()} agora sempre são executados com o interpretador principal ativo.

@item 
gh-113433@footnote{https://github.com/python/cpython/issues/113433}: Subinterpretadores agora são limpos automaticamente durante a finalização do tempo de execução.

@item 
gh-119462@footnote{https://github.com/python/cpython/issues/119462}: Garante que invariantes de versionamento de tipo sejam mantidos: * Superclasses sempre têm seu número de versão atribuído antes das subclasses * A tag version é sempre zero se a tag não for válida. * A tag version é sempre diferente de zero se a tag for válida.

@item 
gh-120437@footnote{https://github.com/python/cpython/issues/120437}: Corrige problemas de otimização @code{_CHECK_STACK_SPACE} introduzidos em gh-118322@footnote{https://github.com/python/cpython/issues/118322}.

@item 
gh-120722@footnote{https://github.com/python/cpython/issues/120722}: Define corretamente a posição do bytecode em instruções de retorno dentro de lambdas. Patch por Jelle Zijlstra.

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: Corrige bug onde o compilador cria um salto redundante durante a substituição de pseudo-op. Só pode acontecer com um AST sintético que tenha uma tentativa na mesma linha que a instrução após o manipulador de exceção.

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: Strings internalizadas com @ref{131e,,sys.intern()} são novamente coletadas como lixo quando não são mais usadas, conforme a documentação. Strings internadas com a função C @ref{8b6,,PyUnicode_InternInPlace()} ainda são imortais. Os internos do mecanismo de internação de strings foram alterados. Isso pode afetar o desempenho e as identidades dos objetos @ref{44c,,str}.

@item 
gh-120384@footnote{https://github.com/python/cpython/issues/120384}: Corrige uma falha de vetor fora dos limites em @code{list_ass_subscript}, que poderia ser invocada por meio de alguma entrada especificamente adaptada: incluindo modificação simultânea de um objeto de lista, onde um thread atribui uma fatia e outro a limpa.

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: Corrige falha no compilador em código com NOPs e JUMPs redundantes que aparecem depois que os manipuladores de exceção são movidos para o final do código.
@end itemize

@node Biblioteca<25>,Núcleo e embutidos<22>,Núcleo e embutidos<21>,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id126}@anchor{16f0}
@subsubsection Biblioteca



@itemize -

@item 
gh-120380@footnote{https://github.com/python/cpython/issues/120380}: Corrige implementação Python de @ref{a28,,pickle.Pickler} para objetos @ref{1c2,,bytes} e @ref{2ea,,bytearray} ao usar o protocolo versão 5. Patch por Bénédikt Tran.
@end itemize

@node Núcleo e embutidos<22>,Biblioteca<26>,Biblioteca<25>,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id127}@anchor{16f1}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-120400@footnote{https://github.com/python/cpython/issues/120400}: Suporte ao perfilador de desempenho Linux para ver chamadas Python na arquitetura RISC-V.

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: Entrega sinais reais em Ctrl-C e Ctrl-Z no novo REPL. Patch por Pablo Galindo

@item 
gh-120346@footnote{https://github.com/python/cpython/issues/120346}: Respeita 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL} ao executar no modo de inspeção interativa (@code{python -i}). Patch de Pablo Galindo

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: Corrige os locais de origem das instruções geradas para o iterador de uma instrução for.

@item 
gh-120198@footnote{https://github.com/python/cpython/issues/120198}: Corrige uma falha quando vários threads leem e escrevem na mesma @code{__class__} de um objeto simultaneamente.

@item 
gh-120298@footnote{https://github.com/python/cpython/issues/120298}: Corrige o uso após a liberação em @code{list_richcompare_impl} que pode ser invocado por meio de alguma entrada maligna especificamente adaptada.

@item 
gh-119666@footnote{https://github.com/python/cpython/issues/119666}: Corrige uma falha do compilador no caso em que duas compreensões no escopo da classe referenciam @code{__class__}.

@item 
gh-120225@footnote{https://github.com/python/cpython/issues/120225}: Corrige a falha no compilador em bloco vazio no final do manipulador de exceção.

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: Melhora as mensagens @ref{18d,,SyntaxError} para expressões inválidas em um limite de parâmetros de tipo, uma tupla de restrição de parâmetro de tipo ou um parâmetro de tipo padrão. Patch por Bénédikt Tran.

@item 
bpo-24766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24766}: Corrige manipulação do argumento @code{doc} para subclasses de @code{property}.
@end itemize

@node Biblioteca<26>,Construção<12>,Núcleo e embutidos<22>,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id128}@anchor{16f2}
@subsubsection Biblioteca



@itemize -

@item 
gh-121027@footnote{https://github.com/python/cpython/issues/121027}: Adiciona um aviso futuro em @code{functools.partial.__get__()}. Em versões futuras do Python, @ref{414,,functools.partial} será um descritor de método.

@item 
gh-121025@footnote{https://github.com/python/cpython/issues/121025}: Melhora o @ref{61c,,__repr__()} de @ref{a85,,functools.partialmethod}. Patch por Bénédikt Tran.

@item 
gh-121018@footnote{https://github.com/python/cpython/issues/121018}: Corrige um problema em que @code{argparse.ArgumentParser.parses_args()} não honrava @code{exit_on_error=False} quando recebia argumentos não reconhecidos. Patch por Ben Hsing.

@item 
gh-119614@footnote{https://github.com/python/cpython/issues/119614}: Corrige truncamento de strings com caracteres nulos incorporados em algumas operações internas em @ref{f0,,tkinter}.

@item 
gh-120910@footnote{https://github.com/python/cpython/issues/120910}: Ao ler arquivos instalados de um egg, usa @code{relative_to(walk_up=True)} para honrar arquivos instalados fora da raiz da instalação.

@item 
gh-120888@footnote{https://github.com/python/cpython/issues/120888}: Atualiza pip wheel empacotado com ensurepip (pip 24.1.1)

@item 
gh-101830@footnote{https://github.com/python/cpython/issues/101830}: Acessar a representação de string do objeto @ref{f0,,tkinter} não converte mais o objeto Tcl subjacente em uma string no Windows.

@item 
gh-120811@footnote{https://github.com/python/cpython/issues/120811}: Corrige possível vazamento de memória em @ref{16f3,,contextvars.Context.run()}.

@item 
gh-120769@footnote{https://github.com/python/cpython/issues/120769}: Faz com que uma linha vazia em @ref{a5,,pdb} repita o último comando mesmo quando o comando é de @code{cmdqueue}.

@item 
gh-120732@footnote{https://github.com/python/cpython/issues/120732}: Corrige @code{name} passando para o objeto @ref{a54,,unittest.mock.Mock} ao usar @ref{16f4,,unittest.mock.create_autospec()}.

@item 
gh-120683@footnote{https://github.com/python/cpython/issues/120683}: Corrige um erro em @ref{101c,,logging.LogRecord}, quando a parte inteira do registro de data e hora é arredondada para cima, enquanto o cálculo de milissegundos trunca, fazendo com que o registro de data e hora do log esteja errado em até 999 ms (afetou aproximadamente 1 em 8 milhões de registros de data e hora).

@item 
gh-120633@footnote{https://github.com/python/cpython/issues/120633}: Move a barra de rolagem e remova os menus destacáveis no turtledemo.

@item 
gh-120541@footnote{https://github.com/python/cpython/issues/120541}: Melhora o prompt no pager “less” quando @ref{8dd,,help()} é chamado com argumento não-string.

@item 
gh-120495@footnote{https://github.com/python/cpython/issues/120495}: Corrige o tratamento de exceção incorreto no Tab Nanny. Patch por Wulian233.

@item 
gh-120381@footnote{https://github.com/python/cpython/issues/120381}: Corrige @ref{16d5,,inspect.ismethoddescriptor()} para verificar também a falta de @ref{16f5,,__delete__()}. Patch por Jan Kaliszewski.

@item 
gh-90425@footnote{https://github.com/python/cpython/issues/90425}: O byte do SO em cabeçalhos gzip agora é sempre definido como 255 ao usar @ref{63e,,gzip.compress()}.

@item 
gh-120343@footnote{https://github.com/python/cpython/issues/120343}: Corrige o relatório de deslocamento de coluna para tokens que vêm depois de f-strings multilinhas no módulo @ref{fb,,tokenize}.

@item 
gh-119600@footnote{https://github.com/python/cpython/issues/119600}: Corrige @ref{ec1,,unittest.mock.patch()} para não ler atributos do alvo quando @code{new_callable} estiver definido. Patch por Robert Collins.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Corrige bug de caso extremo em que @ref{6b1,,typing.get_type_hints()} produziria resultados incorretos se parâmetros de tipo em um escopo de classe fossem substituídos por atribuições em um escopo de classe e a semântica @code{from __future__ import annotations} estivesse habilitada. Patch por Alex Waygood.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Corrige @ref{43f,,NameError} errôneo ao chamar @ref{816,,inspect.get_annotations()} com @code{eval_str=True`} em uma classe que fazia uso de parâmetros do tipo 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} em um módulo que tinha @code{from __future__ import annotations} no topo do arquivo. Patch por Alex Waygood.

@item 
gh-120268@footnote{https://github.com/python/cpython/issues/120268}: Proíbe passar @code{None} para @ref{bed,,datetime.date.fromtimestamp()} Python puro para obter consistência com a implementação da extensão C.

@item 
gh-120244@footnote{https://github.com/python/cpython/issues/120244}: Corrige vazamento de memória em @ref{2a3,,re.sub()} quando a string de substituição contém referências anteriores.

@item 
gh-120211@footnote{https://github.com/python/cpython/issues/120211}: Corrige @ref{f9,,tkinter.ttk} com Tcl/Tk 9.0.

@item 
gh-71587@footnote{https://github.com/python/cpython/issues/71587}: Corrige travamento na versão C de @ref{16f6,,datetime.datetime.strptime()} quando chamado novamente no interpretador reiniciado.

@item 
gh-120161@footnote{https://github.com/python/cpython/issues/120161}: @ref{30,,datetime} não trava mais em certas situações complexas de ciclo de referência.

@item 
gh-119698@footnote{https://github.com/python/cpython/issues/119698}: Corrige @ref{2e5,,symtable.Class.get_methods()} e documenta seu comportamento. Patch por Bénédikt Tran.

@item 
gh-120121@footnote{https://github.com/python/cpython/issues/120121}: Adiciona @ref{16f7,,concurrent.futures.InvalidStateError} ao módulo @code{__all__}.

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: Adiciona a enumeração @ref{16f8,,symtable.SymbolTableType} para representar as possíveis saídas do método @ref{16f9,,symtable.SymbolTable.get_type}. Patch por Bénédikt Tran.

@item 
gh-120108@footnote{https://github.com/python/cpython/issues/120108}: Corrige chamada de @ref{b84,,copy.deepcopy()} em árvores @ref{8,,ast} que foram modificadas para ter referências a nós pais. Patch por Jelle Zijlstra.

@item 
gh-112672@footnote{https://github.com/python/cpython/issues/112672}: Suporte para construção de @ref{f0,,tkinter} com Tcl 9.0.

@item 
gh-65454@footnote{https://github.com/python/cpython/issues/65454}: @ref{16fa,,unittest.mock.Mock.attach_mock()} não dispara mais uma chamada para um @code{PropertyMock} sendo anexado.

@item 
gh-81936@footnote{https://github.com/python/cpython/issues/81936}: Os métodos @code{help()} e @code{showtopic()} agora respeitam um argumento `output' configurado para @code{pydoc.Helper} e não usam o pager em tais casos. Patch por Enrico Tröger.

@item 
gh-119577@footnote{https://github.com/python/cpython/issues/119577}: O @ref{1a5,,DeprecationWarning} emitido ao testar o valor verdade de um @ref{310,,xml.etree.ElementTree.Element} agora descreve o retorno incondicional de @code{True} em uma versão futura em vez de gerar uma exceção no Python 3.14.

@item 
gh-118908@footnote{https://github.com/python/cpython/issues/118908}: Limita os globais expostos de importações e definições internas na inicialização do novo REPL. Patch por Eugene Triguba e Pablo Galindo.

@item 
gh-119506@footnote{https://github.com/python/cpython/issues/119506}: Corrige o método @code{io.TextIOWrapper.write()} que quebra o buffer interno quando o método é chamado novamente durante a descarga do buffer interno.
@end itemize

@node Construção<12>,API C<13>,Biblioteca<26>,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id129}@anchor{16fb}
@subsubsection Construção



@itemize -

@item 
gh-120671@footnote{https://github.com/python/cpython/issues/120671}: Corrige testes de configuração com falha devido a um espaço ausente ao anexar a CFLAGS.

@item 
gh-120602@footnote{https://github.com/python/cpython/issues/120602}: Manipula corretamente instalações LLVM com @code{LLVM_VERSION_SUFFIX} ao construir com @code{--enable-experimental-jit}.

@item 
gh-120326@footnote{https://github.com/python/cpython/issues/120326}: No Windows, corrige o erro de construção quando as opções @code{--disable-gil} e @code{--experimental-jit} são combinadas.

@item 
gh-120291@footnote{https://github.com/python/cpython/issues/120291}: Torna o script de shell @code{python-config} compatível com shells além do bash.
@end itemize

@node API C<13>,,Construção<12>,Python 3 13 0 beta 3
@anchor{whatsnew/changelog id130}@anchor{16fc}
@subsubsection API C



@itemize -

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: Remova o tipo privado @code{_Py_CODEUNIT} da API C pública. O cabeçalho interno @code{pycore_code.h} agora deve ser usado para obter esse tipo interno. Patch por Victor Stinner.

@item 
gh-120858@footnote{https://github.com/python/cpython/issues/120858}: @ref{16fd,,PyDict_Next()} não trava mais o dicionário na construção com threads livres. O bloqueio precisa ser feito pelo chamador em todo o laço de iteração.

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: Remove as seguintes funções instáveis:


@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 por Victor Stinner.

@item 
gh-119344@footnote{https://github.com/python/cpython/issues/119344}: A API da seção crítica agora é pública como parte da API C não limitada.

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: Adiciona @ref{16fe,,PyUnstable_Object_ClearWeakRefsNoCallbacks()}, que limpa weakrefs sem chamar seus callbacks.

@item 
gh-117511@footnote{https://github.com/python/cpython/issues/117511}: Torna o @ref{15b,,PyMutex} público na API C não limitada.
@end itemize

@node Python 3 13 0 beta 2,Python 3 13 0 beta 1,Python 3 13 0 beta 3,Changelog
@anchor{whatsnew/changelog python-3-13-0-beta-2}@anchor{16ff}
@subsection Python 3.13.0 beta 2


`Data de lançamento: 2024-06-05'

@menu
* Segurança: Segurança<12>. 
* Núcleo e embutidos: Núcleo e embutidos<23>. 
* Biblioteca: Biblioteca<27>. 
* Testes: Testes<14>. 
* Construção: Construção<13>. 
* Windows: Windows<11>. 
* API C: API C<14>. 

@end menu

@node Segurança<12>,Núcleo e embutidos<23>,,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id131}@anchor{1700}
@subsubsection Segurança



@itemize -

@item 
gh-118773@footnote{https://github.com/python/cpython/issues/118773}: Corrige a criação de ACLs em @ref{21d,,os.mkdir()} no Windows para funcionar corretamente em máquinas que não falam inglês.

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: @ref{21d,,os.mkdir()} no Windows agora aceita o `modo' de @code{0o700} para restringir o novo diretório ao usuário atual. Isso corrige 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030} afetando @ref{21f,,tempfile.mkdtemp()} em cenários onde o diretório temporário base é mais permissivo do que o padrão.
@end itemize

@node Núcleo e embutidos<23>,Biblioteca<27>,Segurança<12>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id132}@anchor{1701}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-119724@footnote{https://github.com/python/cpython/issues/119724}: Revertidas as melhorias para mensagens de erro para instruções @code{elif}/@code{else} que não correspondem a nenhuma instrução válida, o que torna difícil localizar os erros de sintaxe dentro desses blocos @code{elif}/@code{else}.

@item 
gh-119842@footnote{https://github.com/python/cpython/issues/119842}: Honra @ref{585,,PyOS_InputHook()} no novo REPL. Patch por Pablo Galindo

@item 
gh-119821@footnote{https://github.com/python/cpython/issues/119821}: Corrige a execução de @ref{188,,escopos de anotação} dentro de classes quando @code{globals} estiver definido como um não-dict. Patch por Jelle Zijlstra.

@item 
gh-119548@footnote{https://github.com/python/cpython/issues/119548}: Adiciona um comando @code{clear} ao REPL. Patch por Pablo Galindo

@item 
gh-111999@footnote{https://github.com/python/cpython/issues/111999}: Corrige a assinatura de @ref{e01,,str.format_map()}.

@item 
gh-119560@footnote{https://github.com/python/cpython/issues/119560}: Uma asserção inválida no beta 1 foi removida. A asserção falharia se @code{PyState_FindModule()} fosse usada na função init de um módulo de extensão antes que o módulo def tivesse sido inicializado.

@item 
gh-119369@footnote{https://github.com/python/cpython/issues/119369}: Corrige um impasse (deadlock) durante a exclusão de thread em construção com threads livres, que poderia ocorrer quando a GIL foi habilitada em tempo de execução.

@item 
gh-119525@footnote{https://github.com/python/cpython/issues/119525}: Corrige o impasse envolvendo o cache @code{_PyType_Lookup()} na construção com threads livres quando a GIL é habilitada dinamicamente em tempo de execução.

@item 
gh-119311@footnote{https://github.com/python/cpython/issues/119311}: Corrige bug onde nomes são inesperadamente cortados nas bases de classes genéricas.

@item 
gh-119395@footnote{https://github.com/python/cpython/issues/119395}: Corrige bug onde nomes aparecendo após uma classe genérica são cortados como se estivessem na classe genérica.

@item 
gh-119213@footnote{https://github.com/python/cpython/issues/119213}: Módulos não embutidos construídos com a clínica de argumentos estavam travando se usados em um subinterpretador antes do interpretador principal. Os objetos que estavam causando o problema por vazamento entre os interpretadores descuidadamente foram corrigidos.

@item 
gh-119011@footnote{https://github.com/python/cpython/issues/119011}: Corrige @code{type.__type_params__} para retornar uma tupla vazia em vez de um descritor.

@item 
gh-118692@footnote{https://github.com/python/cpython/issues/118692}: Evita criar instâncias @ref{c15,,StopIteration} desnecessárias para monitoramento.

@item 
gh-119049@footnote{https://github.com/python/cpython/issues/119049}: Corrige a exibição da linha de origem para avisos criados pela API C se o módulo @ref{112,,warnings} ainda não tiver sido importado.

@item 
gh-118844@footnote{https://github.com/python/cpython/issues/118844}: Corrige falhas de construção ao configurar com @code{--disable-gil} e @code{--enable-experimental-jit}.

@item 
gh-118921@footnote{https://github.com/python/cpython/issues/118921}: Adiciona o método @code{copy()} para @code{FrameLocalsProxy} que retorna um @code{dict} para variáveis locais.

@item 
gh-117657@footnote{https://github.com/python/cpython/issues/117657}: Corrige corridas de dados no campo que armazena um ponteiro para a thread principal do interpretador que ocorrem em construções com threads livres.

@item 
gh-118561@footnote{https://github.com/python/cpython/issues/118561}: Corrige condição de corrida em construções com threads livres onde @code{list.extend()} poderia expor memória não inicializada para leitores simultâneos.

@item 
gh-117195@footnote{https://github.com/python/cpython/issues/117195}: Evita falha de asserção para construções de depuração ao chamar @code{object.__sizeof__(1)}
@end itemize

@node Biblioteca<27>,Testes<14>,Núcleo e embutidos<23>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id133}@anchor{1702}
@subsubsection Biblioteca



@itemize -

@item 
gh-119819@footnote{https://github.com/python/cpython/issues/119819}: Corrige regressão para permitir configuração de registro com tipos de fila de multiprocessamento.

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: O módulo @ref{2a,,ctypes} agora pode ser importado em todos os subinterpretadores, incluindo aqueles que têm sua própria GIL.

@item 
gh-118835@footnote{https://github.com/python/cpython/issues/118835}: Corrige falha do _pyrepl ao usar prompt personalizado com códigos de escape ANSI.

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: O módulo @code{_datetime} (implementação C para @ref{30,,datetime}) agora oferece suporte a importação em múltiplos interpretadores.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Corrige problema com @ref{301,,shutil.rmtree()} onde uma @ref{d90,,RecursionError} é levantada em árvores de diretório profundas.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Corrige parcialmente o problema com @ref{301,,shutil.rmtree()} onde uma @ref{d90,,RecursionError} é levantada em árvores de diretório profundas. Um erro de recursão não é mais levantado quando @code{rmtree.avoids_symlink_attacks} é falso.

@item 
gh-119118@footnote{https://github.com/python/cpython/issues/119118}: Corrige regressão de desempenho no módulo @ref{fb,,tokenize} armazenando em cache o atributo de token @code{line} e calculando o deslocamento da coluna de forma mais eficiente.

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: Corrige problema com @ref{b71,,os.fwalk()} onde uma @ref{d90,,RecursionError} era levantada em árvores de diretório profundas ajustando a implementação para ser iterativa em vez de recursiva.

@item 
gh-119588@footnote{https://github.com/python/cpython/issues/119588}: @code{zipfile.Path.is_symlink} agora avalia se o caminho fornecido é um link simbólico.

@item 
gh-119555@footnote{https://github.com/python/cpython/issues/119555}: Captura @ref{18d,,SyntaxError} de @ref{192,,compile()} no método runsource() do InteractiveColoredConsole. Patch por Sergey B Kirpichev.

@item 
gh-113892@footnote{https://github.com/python/cpython/issues/113892}: Agora, o método @code{sock_connect} de @ref{609,,asyncio.ProactorEventLoop} levanta um @ref{202,,ValueError} se o soquete fornecido não estiver no modo não bloqueante, bem como em outras implementações de laço.

@item 
gh-119443@footnote{https://github.com/python/cpython/issues/119443}: O REPL interativo não é mais executado com @code{from __future__ import annotations} habilitado. Patch por Jelle Zijlstra.

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: Os objetos na C-API datetime agora são alocados estaticamente, o que significa melhor segurança de memória, especialmente quando o módulo é recarregado. Isso deve ser transparente para os usuários.

@item 
gh-118894@footnote{https://github.com/python/cpython/issues/118894}: @ref{a,,asyncio} O REPL agora tem os mesmos recursos do PyREPL.

@item 
gh-118911@footnote{https://github.com/python/cpython/issues/118911}: No PyREPL, a lógica do @code{maybe-accept} foi atualizada para que, se o usuário pressionar @code{Enter} duas vezes, ele possa encerrar o bloco mesmo se houver um espaço em branco à direita. Além disso, agora, quando o usuário pressiona a seta para cima, o cursor fica na última linha da função. Isso corresponde ao comportamento do IPython. Patch por Aya Elsayed.

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: Remove dependência para @ref{ba,,readline} do novo REPL do Python.

@item 
gh-119174@footnote{https://github.com/python/cpython/issues/119174}: Corrige DPI alto que causa janelas borradas no turtledemo (exemplos do turtle-graphics) Patch por Wulian233 e Terry Jan Reedy

@item 
gh-119121@footnote{https://github.com/python/cpython/issues/119121}: Corrige um NameError acontecendo em @code{asyncio.staggered.staggered_race}. Esta função agora está testada.

@item 
gh-119113@footnote{https://github.com/python/cpython/issues/119113}: Corrige problema em que @ref{1703,,pathlib.PurePath.with_suffix()} não levantava @ref{2c3,,TypeError} quando dado @code{None} como sufixo.

@item 
gh-118643@footnote{https://github.com/python/cpython/issues/118643}: Corrige um AttributeError no módulo @ref{3b,,email} ao redobrar uma longa lista de endereços. Também corrige mais casos de codificação incorreta do separador de endereços na lista de endereços.

@item 
gh-58933@footnote{https://github.com/python/cpython/issues/58933}: Faz @ref{a5,,pdb} retornar ao quadro do chamador corretamente quando @code{f_trace} do quadro do chamador não estiver definido

@item 
gh-118895@footnote{https://github.com/python/cpython/issues/118895}: Define atributos em @ref{262,,typing.NoDefault} agora levanta @ref{34b,,AttributeError} em vez de @ref{2c3,,TypeError}.

@item 
gh-118868@footnote{https://github.com/python/cpython/issues/118868}: Corrigido o problema em que kwargs não eram mais passados para o manipulador de registro QueueHandler

@item 
gh-118851@footnote{https://github.com/python/cpython/issues/118851}: Argumentos @code{ctx} para os construtores de classes de nó @ref{8,,ast} agora são padronizados para @ref{1a4,,ast.Load()}. Patch por Jelle Zijlstra.

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: Restaura o valor padrão de @code{tkiter.wantobjects} para @code{1}.

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: Corrige erros ao chamar ligações Tkinter no Windows.

@item 
gh-118507@footnote{https://github.com/python/cpython/issues/118507}: Corrige @ref{a1b,,os.path.isfile()} no Windows para pipes. Acelera @ref{4a3,,os.path.isjunction()} e @ref{a19,,os.path.lexists()} no Windows com uma implementação nativa.

@item 
gh-118772@footnote{https://github.com/python/cpython/issues/118772}: Permite que instâncias @ref{15d,,typing.TypeVar} sem um padrão sigam instâncias sem um padrão em alguns casos. Patch por Jelle Zijlstra.

@item 
gh-110863@footnote{https://github.com/python/cpython/issues/110863}: @ref{225,,os.path.realpath()} agora suprime qualquer @ref{417,,OSError} de @ref{926,,os.readlink()} quando o modo `strict' está desabilitado (o padrão).

@item 
gh-118263@footnote{https://github.com/python/cpython/issues/118263}: Acelera @ref{4a4,,os.path.splitroot()} e @ref{135e,,os.path.normpath()} com uma chamada C direta.

@item 
gh-118033@footnote{https://github.com/python/cpython/issues/118033}: Corrige @ref{1cb,,dataclasses.dataclass()} não criando um slot @code{__weakref__} ao subclassificar @ref{15d7,,typing.Generic}.

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: Em @ref{7b,,importlib.resources}, sincronizar com importlib_resources 6.3.2@footnote{https://importlib-resources.readthedocs.io/en/latest/history.html#v6-3-2}, incluindo: @code{MultiplexedPath} agora espera caminhos @code{Traversable}, descontinuando argumentos de string para @code{MultiplexedPath}; Suporte habilitado para recursos em pacotes de espaço de nomes em arquivos zip; Corrigido @code{NotADirectoryError} ao chamar arquivos em um subdiretório de um pacote de espaço de nomes.

@item 
gh-113978@footnote{https://github.com/python/cpython/issues/113978}: Ignora avisos sobre conclusão de texto dentro do REPL.

@item 
gh-103956@footnote{https://github.com/python/cpython/issues/103956}: Corrige a falta de caracteres de nova linha na saída do módulo @ref{fd,,trace} quando o rastreamento de linha está habilitado, mas a linha de código-fonte para o quadro atual não está disponível.

@item 
gh-92081@footnote{https://github.com/python/cpython/issues/92081}: Corrige espaços ausentes em cabeçalhos de e-mail quando os espaços são misturados com caracteres codificados de 8 bits.

@item 
gh-103194@footnote{https://github.com/python/cpython/issues/103194}: Prepara o Tkinter para alterações na API C no Tcl 8.7/9.0 para evitar que @code{_tkinter.Tcl_Obj} seja retornado inesperadamente em vez de @ref{468,,bool}, @ref{44c,,str}, @ref{2ea,,bytearray} ou @ref{257,,int}.

@item 
gh-87106@footnote{https://github.com/python/cpython/issues/87106}: Corrigida a manipulação em @ref{1648,,inspect.Signature.bind()} de argumentos nomeados com o mesmo nome que argumentos somente-posicionais quando um argumento nomeado variádico (por exemplo, @code{**kwargs}) estiver presente.

@item 
bpo-45767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45767}: Corrige conversão de inteiros em @ref{1704,,os.major()}, @ref{1705,,os.minor()} e @ref{1706,,os.makedev()}. Suporte a números de dispositivos maiores que @code{2**63-1}. Suporte a número de dispositivos inexistente (@code{NODEV}).

@item 
gh-67693@footnote{https://github.com/python/cpython/issues/67693}: Corrige @ref{16c1,,urllib.parse.urlunparse()} e @ref{16c0,,urllib.parse.urlunsplit()} para URIs com caminho começando com várias barras e sem autoridade. Baseado no patch de Ashwin Ramaswami.
@end itemize

@node Testes<14>,Construção<13>,Biblioteca<27>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id134}@anchor{1707}
@subsubsection Testes



@itemize -

@item 
gh-119050@footnote{https://github.com/python/cpython/issues/119050}: Executor de teste regrtest: Adiciona suporte XML ao verificador de reflexos (opção -R). Patch de Victor Stinner.
@end itemize

@node Construção<13>,Windows<11>,Testes<14>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id135}@anchor{1708}
@subsubsection Construção



@itemize -

@item 
gh-119729@footnote{https://github.com/python/cpython/issues/119729}: Em sistemas POSIX, os nomes de arquivo pkg-config (@code{.pc}) agora incluem os sinalizadores ABI, que podem incluir debug ("d") e free-threaded ("t"). Por exemplo: * @code{python-3.14.pc} (padrão, construção não-debug) * @code{python-3.14d.pc} (padrão, construção debug) * @code{python-3.14t.pc} (construção com threads livres)

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Retorna ao libmpdec empacotado se uma versão do sistema não puder ser encontrada.

@item 
gh-119132@footnote{https://github.com/python/cpython/issues/119132}: Atualiza @ref{178,,sys.version} para identificar se a construção é a construção padrão ou a construção com threads livres. Patch por Donghee Na.

@item 
gh-118836@footnote{https://github.com/python/cpython/issues/118836}: Corrige um @code{AssertionError} ao construir com @code{--enable-experimental-jit} e o compilador emite uma seção @code{SHT_NOTE}.

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: Corrige uma possível condição de corrida que afeta construções paralelas configuradas com @code{--enable-experimental-jit}, nas quais erros de construção podem ser causados por um arquivo de cabeçalho gerado de forma incompleta.
@end itemize

@node Windows<11>,API C<14>,Construção<13>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id136}@anchor{1709}
@subsubsection Windows



@itemize -

@item 
gh-119679@footnote{https://github.com/python/cpython/issues/119679}: Garante que bibliotecas de importação corretas sejam incluídas nas instalações do Windows.

@item 
gh-119690@footnote{https://github.com/python/cpython/issues/119690}: Adiciona suporte a Unicode e corrige eventos de auditoria para @code{_winapi.CreateNamedPipe}.

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: Adiciona suporte para o novo pyrepl no Windows

@item 
gh-119070@footnote{https://github.com/python/cpython/issues/119070}: Corrige o tratamento de @code{py.exe} de shebangs como @code{/usr/bin/env python3.12}, que eram interpretados anteriormente como @code{python3.exe} em vez de @code{python3.12.exe}.

@item 
gh-117505@footnote{https://github.com/python/cpython/issues/117505}: Corrige um problema com o instalador do Windows não executando ensurepip em um ambiente totalmente isolado. Isso pode causar interações inesperadas com os pacotes do site do usuário.

@item 
gh-118209@footnote{https://github.com/python/cpython/issues/118209}: Evita travamentos em @ref{90,,mmap} no Windows quando a memória mapeada estiver inacessível devido a erros do sistema de arquivos ou violações de acesso.

@item 
gh-116145@footnote{https://github.com/python/cpython/issues/116145}: Tcl/Tk empacotado atualizado para 8.6.14.
@end itemize

@node API C<14>,,Windows<11>,Python 3 13 0 beta 2
@anchor{whatsnew/changelog id137}@anchor{170a}
@subsubsection API C



@itemize -

@item 
gh-119585@footnote{https://github.com/python/cpython/issues/119585}: Corrige travamento quando um estado de thread que foi criado por @ref{3ab,,PyGILState_Ensure()} chama um destruidor que durante @ref{170b,,PyThreadState_Clear()} chama de volta para @ref{3ab,,PyGILState_Ensure()} e @ref{3ac,,PyGILState_Release()}. Isso pode ocorrer quando na construção com threads livres ou ao usar variáveis de thread local cujos destruidores chamam @ref{3ab,,PyGILState_Ensure()}.

@item 
gh-119336@footnote{https://github.com/python/cpython/issues/119336}: Restaura a função @code{_PyLong_NumBits()} removida. Ela é usada pelo projeto pywin32. Patch por Ethan Smith

@item 
gh-119247@footnote{https://github.com/python/cpython/issues/119247}: Adicionadas as macros @code{Py_BEGIN_CRITICAL_SECTION_SEQUENCE_FAST} e @code{Py_END_CRITICAL_SECTION_SEQUENCE_FAST} para tornar possível usar as APIs PySequence_Fast com segurança quando de threads livres, e atualizar str.join para funcionar sem que a GIL as use.

@item 
gh-111389@footnote{https://github.com/python/cpython/issues/111389}: Adicionar constante @ref{170c,,PyHASH_MULTIPLIER}: multiplicador primo usado em string e vários outros hashes. Patch por Victor Stinner.

@item 
gh-116984@footnote{https://github.com/python/cpython/issues/116984}: Faz mimalloc incluir relativo ao arquivo atual para evitar que incorporadores ou extensões precisem incluir @code{Internal/mimalloc} se eles já estiverem incluindo cabeçalhos CPython internos.

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: Restaura @code{_PyWeakref_ClearRef} que foi removido anteriormente no Python 3.13 alpha 1.
@end itemize

@node Python 3 13 0 beta 1,Python 3 13 0 alpha 6,Python 3 13 0 beta 2,Changelog
@anchor{whatsnew/changelog python-3-13-0-beta-1}@anchor{170d}
@subsection Python 3.13.0 beta 1


`Data de lançamento: 2024-05-08'

@menu
* Segurança: Segurança<13>. 
* Núcleo e embutidos: Núcleo e embutidos<24>. 
* Biblioteca: Biblioteca<28>. 
* Núcleo e embutidos: Núcleo e embutidos<25>. 
* Biblioteca: Biblioteca<29>. 
* Documentação: Documentação<11>. 
* Construção: Construção<14>. 
* Windows: Windows<12>. 
* macOS: macOS<8>. 
* IDLE: IDLE<12>. 
* API C: API C<15>. 

@end menu

@node Segurança<13>,Núcleo e embutidos<24>,,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id138}@anchor{170e}
@subsubsection Segurança



@itemize -

@item 
gh-116741@footnote{https://github.com/python/cpython/issues/116741}: Atualiza libexpat empacotado para 2.6.2

@item 
gh-117233@footnote{https://github.com/python/cpython/issues/117233}: Detecta suporte a BLAKE2, SHA3, Shake e SHA512 truncado na biblioteca libcrypto do OpenSSL no momento da construção. Isso permite que @ref{68,,hashlib} seja usado com bibliotecas que não suportam todos os algoritmos que o OpenSSL upstream suporta.
@end itemize

@node Núcleo e embutidos<24>,Biblioteca<28>,Segurança<13>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id139}@anchor{170f}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-118414@footnote{https://github.com/python/cpython/issues/118414}: Adiciona opcodes instrumentados à asserção YIELD_VALUE para rastrear casos.

@item 
gh-117953@footnote{https://github.com/python/cpython/issues/117953}: Quando um módulo embutido ou de extensão é importado pela primeira vez, enquanto um subinterpretador está ativo, a função init do módulo agora é executada pelo interpretador principal antes que a importação continue no subinterpretador. Consequentemente, os módulos init de fase única agora falham em um subinterpretador isolado sem a função init em execução sob esse interpretador, enquanto antes ele seria executado sob o subinterpretador `antes' de falhar, potencialmente deixando para trás o estado global e os retornos de chamada e, de outra forma, deixando o módulo em um estado inconsistente.

@item 
gh-117549@footnote{https://github.com/python/cpython/issues/117549}: Não usa a sintaxe do inicializador designado em funções inline em cabeçalhos internos. Eles causam problemas para usuários de C++ ou MSVC que ainda não estão usando o padrão C++ mais recente (C++20). Enquanto interno, pycore_backoff.h, é incluído (indiretamente, via pycore_code.h) por algum software de terceiros importante que faz isso para velocidade.
@end itemize

@node Biblioteca<28>,Núcleo e embutidos<25>,Núcleo e embutidos<24>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id140}@anchor{1710}
@subsubsection Biblioteca



@itemize -

@item 
gh-95382@footnote{https://github.com/python/cpython/issues/95382}: Melhora o desempenho de @ref{d68,,json.dumps()} e @ref{d67,,json.dump()} ao usar o argumento `indent'. Dependendo dos dados, a codificação usando @ref{d68,,json.dumps()} com `indent' pode ser de 2 a 3 vezes mais rápida.
@end itemize

@node Núcleo e embutidos<25>,Biblioteca<29>,Biblioteca<28>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id141}@anchor{1711}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: Em construções com @code{--disable-gil}, a GIL será habilitada durante o carregamento de módulos de extensão C. Se o módulo indicar que suporta execução sem a GIL, a GIL será desabilitada quando o carregamento for concluído. Caso contrário, a GIL permanecerá habilitada pelo restante da vida útil do interpretador. Esse comportamento não se aplica se a GIL tiver sido explicitamente habilitada ou desabilitada com @code{PYTHON_GIL} ou @code{-Xgil}.

@item 
gh-118513@footnote{https://github.com/python/cpython/issues/118513}: Corrige @ref{157f,,UnboundLocalError} incorreta quando duas compreensões na mesma função referenciam o mesmo nome e, em uma compreensão, o nome é vinculado, enquanto na outra é um global implícito.

@item 
gh-118518@footnote{https://github.com/python/cpython/issues/118518}: Permite que o suporte Linux perf funcione sem ponteiros de quadro usando o suporte JIT avançado do perf. O recurso é ativado ao usar a variável de ambiente @code{PYTHON_PERF_JIT_SUPPORT} ou ao executar Python com @code{-Xperf_jit}. Patch por Pablo Galindo.

@item 
gh-117514@footnote{https://github.com/python/cpython/issues/117514}: Adiciona a função @code{sys._is_gil_enabled()} que retorna se a GIL está habilitada no momento. Na construção padrão, ela sempre retorna @code{True} porque a GIL está sempre habilitada. Na construção com threads livres, ela pode retornar @code{True} ou @code{False}.

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: Interrompe um laço entre a implementação Python do módulo @ref{36,,decimal} e o código Python para conversão de inteiro para string. Também otimize a conversão de inteiro para string para valores no intervalo de 9_000 a 135_000 dígitos decimais.

@item 
gh-118473@footnote{https://github.com/python/cpython/issues/118473}: Corrige @ref{1712,,sys.set_asyncgen_hooks()} para não ser parcialmente definido ao levantar @ref{2c3,,TypeError}.

@item 
gh-118465@footnote{https://github.com/python/cpython/issues/118465}: O compilador preenche o novo campo @code{__firstlineno__} em uma classe com o número da linha da primeira linha da definição da classe.

@item 
gh-118492@footnote{https://github.com/python/cpython/issues/118492}: Corrige um problema em que o cache de tipos pode expor um atributo acessado anteriormente quando um finalizador é executado.

@item 
gh-117714@footnote{https://github.com/python/cpython/issues/117714}: atualiza @code{async_generator.athrow().close()} e @code{async_generator.asend().close()} para fechar sua seção do gerador assíncrono subjacente

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: O interpretador @ref{169,,interativo} agora é implementado em Python, o que permite uma série de novos recursos como cores, entrada multilinha, visualização de histórico e modo de colagem. Contribuído por Pablo Galindo, Łukasz Langa e Lysandros Nikolaou com base no código do projeto PyPy.

@item 
gh-74929@footnote{https://github.com/python/cpython/issues/74929}: Implementa PEP 667: convertido @ref{182,,FrameType.f_locals} e @ref{41f,,PyFrame_GetLocals()} para retornar um objeto proxy de gravação quando o quadro se refere a uma função ou compreensão.

@item 
gh-116767@footnote{https://github.com/python/cpython/issues/116767}: Corrige travamento no compilador em ‘async with’ que tem muitos gerenciadores de contexto.

@item 
gh-118335@footnote{https://github.com/python/cpython/issues/118335}: Altera como usar o interpretador de nível 2. Em vez de executar Python com @code{-X uops} ou definir a variável de ambiente @code{PYTHON_UOPS=1}, essa escolha agora é feita em tempo de construção configurando com @code{--enable-experimental-jit=interpreter}.

`Cuidado!' Isso altera a variável de ambiente para habilitar ou desabilitar micro-ops para @code{PYTHON_JIT}. O antigo @code{PYTHON_UOPS} não é mais usado.

@item 
gh-118306@footnote{https://github.com/python/cpython/issues/118306}: Atualiza a compilação JIT para usar LLVM 18

@item 
gh-118160@footnote{https://github.com/python/cpython/issues/118160}: @ref{188,,Escopos de anotação} dentro de classes agora podem conter compreensões. No entanto, tais compreensões não são incorporadas em seu escopo pai em tempo de execução. Patch por Jelle Zijlstra.

@item 
gh-118272@footnote{https://github.com/python/cpython/issues/118272}: Corrige bug onde @code{generator.close} não libera os locais do quadro do gerador.

@item 
gh-118216@footnote{https://github.com/python/cpython/issues/118216}: Não considera importações @ref{0,,__future__} com pontos antes do nome do módulo.

@item 
gh-118074@footnote{https://github.com/python/cpython/issues/118074}: Garante que os objetos Executor no array COLD_EXITS não sejam considerados GC-able (o que acessaria bytes fora do objeto).

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: Usa carregamento preguiçoso do número da linha do quadro para melhorar o desempenho do rastreamento

@item 
gh-118082@footnote{https://github.com/python/cpython/issues/118082}: Melhora a mensagem @ref{18d,,SyntaxError} para importações sem nomes, como nos casos @code{from x import} e @code{import}. Agora, ele indica aos usuários que @ref{5e2,,import} espera pelo menos um nome depois dele.

@item 
gh-118090@footnote{https://github.com/python/cpython/issues/118090}: Melhora a mensagem @ref{18d,,SyntaxError} para colchetes de parâmetros de tipo vazios.

@item 
gh-117958@footnote{https://github.com/python/cpython/issues/117958}: Adicionado um método @code{get_jit_code()} para acessar o código de máquina compilado JIT do UOp Executor quando o JIT experimental estiver habilitado. Patch por Anthony Shaw.

@item 
gh-117901@footnote{https://github.com/python/cpython/issues/117901}: Adiciona uma opção para o codegen do compilador para salvar sequências de instruções aninhadas para introspecção.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Redireciona stdout e stderr para o log do sistema quando incorporado em um aplicativo Android.

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: @ref{188,,o escopo de anotação} dentro de escopos de classe agora pode conter lambdas.

@item 
gh-117894@footnote{https://github.com/python/cpython/issues/117894}: Impede que objetos @code{agen.aclose()} sejam reutilizados após @code{.throw()}.

@item 
gh-117881@footnote{https://github.com/python/cpython/issues/117881}: impede acesso simultâneo a um gerador assíncrono via athrow().throw() ou asend().throw()

@item 
gh-117536@footnote{https://github.com/python/cpython/issues/117536}: Corrige um @ref{1bd,,RuntimeWarning} ao chamar @code{agen.aclose().throw(Exception)}.

@item 
gh-117755@footnote{https://github.com/python/cpython/issues/117755}: Corrige alocador mimalloc para alocação de memória enorme (em torno de 8.589.934.592 GiB) no s390x. Patch por Victor Stinner.

@item 
gh-117750@footnote{https://github.com/python/cpython/issues/117750}: Corrige problema em que o dict de um objeto ficava fora de sincronia com os valores internos do objeto ao ser limpo. @code{obj.__dict__.clear()} agora limpa os valores internos, mas deixa o dict anexado ao objeto.

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Melhora o desempenho dos seguintes métodos @ref{1c2,,bytes} e @ref{2ea,,bytearray} adaptando-os à convenção de chamada @ref{1713,,METH_FASTCALL}:


@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}: Acelera as chamadas para @ref{44c,,str()} com argumento somente posicional, usando a convenção de chamada 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall}. Patch por Erlend Aasland.

@item 
gh-117680@footnote{https://github.com/python/cpython/issues/117680}: Dá a @code{_PyInstructionSequence} uma interface Python e use-a em testes.

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: Objetos alocados estaticamente são, por definição, imortais, portanto, devem ser marcados como tal, independentemente de estarem em módulos de extensão ou não.

@item 
gh-117385@footnote{https://github.com/python/cpython/issues/117385}: Remove eventos @code{PY_MONITORING_EVENT_BRANCH} e @code{PY_MONITORING_EVENT_EXCEPTION_HANDLED} não manipulados de @ref{1547,,sys.settrace()}.

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: Módulos de extensão podem indicar ao tempo de execução que podem ser executados sem a GIL. Módulos init multifásicos fazem isso chamando o fornecimento de @code{Py_MOD_GIL_NOT_USED} para o slot @code{Py_mod_gil}, enquanto módulos init monofásicos chamam @code{PyUnstable_Module_SetGIL(mod, Py_MOD_GIL_NOT_USED)} de sua função init.

@item 
gh-116129@footnote{https://github.com/python/cpython/issues/116129}: Implementa 
@geindex Propostas de Melhorias do Python; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}, adicionando suporte para padrões em parâmetros de tipo. Patch por Jelle Zijlstra.

@item 
gh-93502@footnote{https://github.com/python/cpython/issues/93502}: Adiciona duas novas funções à API C, @ref{36c,,PyRefTracer_SetTracer()} e @ref{36d,,PyRefTracer_GetTracer()}, que permite rastrear a criação e destruição de objetos da mesma forma que o módulo @ref{ff,,tracemalloc} faz. Patch por Pablo Galindo

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: Melhora significativamente o desempenho de @ref{1547,,sys.settrace()}

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: Melhora a mensagem de erro quando um script que faz shadowing de um módulo da biblioteca padrão faz com que @ref{34b,,AttributeError} seja levantada. Da mesma forma, melhorar a mensagem de erro quando um script que faz shadowing de um módulo de terceiros tenta acessar um atributo desse módulo de terceiros enquanto ainda está inicializando.

@item 
gh-99180@footnote{https://github.com/python/cpython/issues/99180}: Elimina indicadores de traceback não informativos em instruções @code{return} e @code{assignment} simples. Patch por Pablo Galindo.

@item 
gh-105879@footnote{https://github.com/python/cpython/issues/105879}: Permite que os argumentos `globals' e `locals' para @ref{17f,,exec()} e @ref{180,,eval()} sejam passados como nomeados.
@end itemize

@node Biblioteca<29>,Documentação<11>,Núcleo e embutidos<25>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id142}@anchor{1714}
@subsubsection Biblioteca



@itemize -

@item 
gh-118418@footnote{https://github.com/python/cpython/issues/118418}: Uma @ref{1a5,,DeprecationWarning} agora é emitida se você não passar um valor para o novo parâmetro `type_params' de @code{typing._eval_type()} ou @code{typing.ForwardRef._evaluate()}. (Usar qualquer uma dessas funções privadas e não documentadas é desencorajado para começar, mas deixar de passar um valor para o parâmetro @code{type_params} pode levar a um comportamento incorreto no Python 3.12 ou mais recente.)

@item 
gh-118660@footnote{https://github.com/python/cpython/issues/118660}: Adiciona um segundo parâmetro de tipo opcional para @ref{cac,,typing.ContextManager} e @ref{1715,,typing.AsyncContextManager}, representando os tipos de retorno de @ref{1344,,__exit__()} e @ref{1716,,__aexit__()} respectivamente. Este parâmetro tem como padrão @code{bool | None}.

@item 
gh-118650@footnote{https://github.com/python/cpython/issues/118650}: O módulo @code{enum} permite que o método chamado @code{_repr_*} seja definido em tipos @code{Enum}.

@item 
gh-118648@footnote{https://github.com/python/cpython/issues/118648}: Adiciona padrões de parâmetros de tipo para @ref{1717,,typing.Generator} e @ref{1718,,typing.AsyncGenerator}.

@item 
gh-101137@footnote{https://github.com/python/cpython/issues/101137}: O tipo MIME @code{text/x-rst} agora é suportado por @ref{8f,,mimetypes}.

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: A implementação Python do módulo @code{decimal} poderia parecer travar em casos de potência relativamente pequena (como @code{2**117}) se a precisão do contexto fosse definida como um valor muito alto. Um método diferente para verificar resultados exatamente representáveis é usado agora que não depende da computação de @code{10**precision} (que poderia ser efetivamente muito grande para ser computada).

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: @code{breakpoint()} e @code{pdb.set_trace()} agora entram no depurador imediatamente após a chamada, em vez de antes da próxima linha ser executada.

@item 
gh-118500@footnote{https://github.com/python/cpython/issues/118500}: Adiciona suporte @ref{a5,,pdb} para zipapps

@item 
gh-118406@footnote{https://github.com/python/cpython/issues/118406}: Adiciona assinatura para objetos @ref{245,,sqlite3.Connection}.

@item 
gh-101732@footnote{https://github.com/python/cpython/issues/101732}: Usa uma função de tempo openssl compatível com Y2038 quando disponível.

@item 
gh-118404@footnote{https://github.com/python/cpython/issues/118404}: Corrige @ref{738,,inspect.signature()} para chamáveis não comparáveis.

@item 
gh-118402@footnote{https://github.com/python/cpython/issues/118402}: Corrige @ref{738,,inspect.signature()} para o resultado da chamada @ref{121a,,functools.cmp_to_key()}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: No Android, @ref{1283,,sysconfig.get_platform} agora retorna o formato especificado por 
@geindex Propostas de Melhorias do Python; PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}.

@item 
gh-118285@footnote{https://github.com/python/cpython/issues/118285}: Permite especificar a assinatura de instâncias personalizadas do tipo de extensão pelo atributo @code{__text_signature__}. Especifica assinaturas de instâncias @ref{e60,,operator.attrgetter}, @ref{a6b,,operator.itemgetter} e @ref{e61,,operator.methodcaller}.

@item 
gh-118314@footnote{https://github.com/python/cpython/issues/118314}: Corrige um caso extremo no modo estrito @ref{1719,,binascii.a2b_base64()}, onde o preenchimento excessivo não é detectado quando nenhum preenchimento é necessário.

@item 
gh-118271@footnote{https://github.com/python/cpython/issues/118271}: Adiciona os métodos @code{PhotoImage} @code{read()} para ler uma imagem de um arquivo e @code{data()} para obter os dados da imagem. Adiciona os parâmetros `background' e `grayscale' ao método @code{write()} de @code{PhotoImage}.

@item 
gh-118225@footnote{https://github.com/python/cpython/issues/118225}: Adiciona o método @code{PhotoImage} @code{copy_replace()} para copiar uma região de uma imagem para outra, possivelmente com zoom de pixel e/ou subamostragem. Adicione o parâmetro `from_coords' aos métodos @code{copy()}, @code{zoom()} e @code{subsample()} da @code{PhotoImage}. Adiciona os parâmetros `zoom' e `subsample' ao método  @code{copy()} de @code{PhotoImage}.

@item 
gh-118221@footnote{https://github.com/python/cpython/issues/118221}: Corrige um bug em que @ref{247,,sqlite3.Connection.iterdump()} poderia falhar se um @ref{171a,,row factory} personalizado fosse usado. Patch por Erlend Aasland.

@item 
gh-118013@footnote{https://github.com/python/cpython/issues/118013}: Corrige regressão introduzida em gh-103193@footnote{https://github.com/python/cpython/issues/103193} que significava que chamar @ref{494,,inspect.getattr_static()} em uma instância faria com que uma referência forte à classe dessa instância persistisse em um cache interno no módulo @ref{7e,,inspect}. Isso causava consumo inesperado de memória se a classe fosse criada dinamicamente, a classe mantivesse referências fortes a outros objetos que ocupassem uma quantidade significativa de memória e o cache contivesse a única referência forte à classe. A correção para a regressão leva a uma lentidão em @code{getattr_static()}, mas a função ainda deve ser significativamente mais rápida do que era no Python 3.11. Patch por Alex Waygood.

@item 
gh-118218@footnote{https://github.com/python/cpython/issues/118218}: Acelera @ref{818,,itertools.pairwise()} no caso comum em até 1,8x.

@item 
gh-117486@footnote{https://github.com/python/cpython/issues/117486}: Melhora o comportamento das subclasses definidas pelo usuário de @ref{1a6,,ast.AST}. Essas classes agora não exigirão alterações no caso usual para estar em conformidade com as alterações de comportamento do módulo @ref{8,,ast} no Python 3.13. Patch por Jelle Zijlstra.

@item 
gh-90848@footnote{https://github.com/python/cpython/issues/90848}: Corrigida @ref{16f4,,unittest.mock.create_autospec()} para configurar o mock pai com argumentos nomeados.

@item 
gh-118168@footnote{https://github.com/python/cpython/issues/118168}: Corrige a substituição incorreta de argumentos quando @ref{171b,,typing.Unpack} é usado com a @ref{370,,tuple} embutido. @code{typing.Unpack} agora levanta @ref{2c3,,TypeError} quando usado com certos tipos inválidos. Patch por Jelle Zijlstra.

@item 
gh-118131@footnote{https://github.com/python/cpython/issues/118131}: Adiciona a interface de linha de comando para o módulo @ref{b8,,random}. Patch por Hugo van Kemenade.

@item 
gh-118107@footnote{https://github.com/python/cpython/issues/118107}: Corrige @ref{132,,zipimport} leitura de arquivos ZIP64 com entradas de arquivo muito grandes ou muito deslocadas.

@item 
gh-102511@footnote{https://github.com/python/cpython/issues/102511}: Corrige @ref{135e,,os.path.normpath()} para caminhos UNC no Windows. Acelera @ref{4a4,,os.path.splitroot()} com uma implementação nativa.

@item 
gh-117535@footnote{https://github.com/python/cpython/issues/117535}: Altera o nome de arquivo desconhecido de @ref{112,,warnings} de @code{sys} para @code{<sys>} para esclarecer que não é um nome de arquivo real.

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: Corrige @ref{43f,,NameError} errôneo ao chamar @ref{6b1,,typing.get_type_hints()} em uma classe que fazia uso de parâmetros de tipo 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} em um módulo que tinha @code{from __future__ import annotations} no topo do arquivo. Patch por Alex Waygood.

@item 
gh-116931@footnote{https://github.com/python/cpython/issues/116931}: Adiciona verificação do parâmetro `fileobj' para @ref{171c,,tarfile.TarFile.addfile()}

@item 
gh-117995@footnote{https://github.com/python/cpython/issues/117995}: Não levanta @ref{1a5,,DeprecationWarning} quando uma @ref{4f1,,sequência} de parâmetros for usada para vincular marcadores de posição indexados e sem nome. Veja também gh-100668@footnote{https://github.com/python/cpython/issues/100668}.

@item 
gh-80361@footnote{https://github.com/python/cpython/issues/80361}: Corrige TypeError em @ref{120d,,email.message.Message.get_payload()} quando o charset é codificado em 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.

@item 
gh-86650@footnote{https://github.com/python/cpython/issues/86650}: Corrige IndexError ao analisar alguns e-mails com Message-ID inválido (incluindo endereços únicos gerados pelo Microsoft Outlook).

@item 
gh-117691@footnote{https://github.com/python/cpython/issues/117691}: Melhora as mensagens de erro emitidas pelos avisos de descontinuação de @ref{de,,tarfile} relacionados ao PEP 706. Se um argumento @code{filter} não for fornecido para @code{extract()} ou @code{extractall}, o aviso de descontinuação agora aponta para a linha no código do usuário onde a função relevante foi chamada. Patch por Alex Waygood.

@item 
gh-115874@footnote{https://github.com/python/cpython/issues/115874}: Corrige um possível segfault durante a coleta de lixo de objetos @code{_asyncio.FutureIter}. Patch por Savannah Ostrowski.

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: Acelera @ref{22d,,pathlib.Path.glob()} omitindo uma chamada inicial @ref{230,,is_dir()}. Como resultado dessa alteração, @ref{22d,,glob()} não pode mais levantar @ref{417,,OSError}.

@item 
gh-77102@footnote{https://github.com/python/cpython/issues/77102}: O módulo @ref{c7,,site} agora analisa o arquivo @code{.pth} com UTF-8 primeiro, e @ref{242,,codificação da localidade} se @code{UnicodeDecodeError} acontecer. Ele suportava apenas codificação da localidade antes.

@item 
gh-76785@footnote{https://github.com/python/cpython/issues/76785}: Nós expusemos o módulo de baixo nível @code{_interpreters} para o bem da implementação PyPI de 
@geindex Propostas de Melhorias do Python; PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}. Às vezes, ele estava disponível como o módulo @code{_xxsubinterpreters} e era usado anteriormente apenas para testes. Na maior parte, ele deve ser considerado um módulo interno, como @code{_thread} e @code{_imp}. Veja @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}: Acelera @ref{22d,,pathlib.Path.glob()} não escaneando diretórios para segmentos de padrões não curinga.

@item 
gh-117727@footnote{https://github.com/python/cpython/issues/117727}: Acelera @ref{171d,,pathlib.Path.iterdir()} usando @ref{a68,,os.scandir()} internamente.

@item 
gh-117586@footnote{https://github.com/python/cpython/issues/117586}: Acelera @ref{4a8,,pathlib.Path.walk()} trabalhando com strings internamente.

@item 
gh-117722@footnote{https://github.com/python/cpython/issues/117722}: Altera o novo suporte a múltiplos separadores em @ref{1b4,,asyncio.StreamReader.readuntil()} para aceitar apenas tuplas de separadores em vez de iteráveis arbitrários.

@item 
gh-117692@footnote{https://github.com/python/cpython/issues/117692}: Corrige um bug quando @ref{171e,,doctest.DocTestFinder} estava falhando em @code{builtin_function_or_method} encapsulado.

@item 
gh-117348@footnote{https://github.com/python/cpython/issues/117348}: Desempenho de tempo de importação amplamente restaurado do configparser evitando dataclasses.

@item 
gh-117641@footnote{https://github.com/python/cpython/issues/117641}: Aceleração de @ref{e6a,,os.path.commonpath()} no Unix.

@item 
gh-117663@footnote{https://github.com/python/cpython/issues/117663}: Corrige @code{_simple_enum} para detectar apelidos quando vários argumentos estão presentes, mas apenas um é o valor do membro.

@item 
gh-117636@footnote{https://github.com/python/cpython/issues/117636}: Aceleração de @ref{171f,,os.path.join()}.

@item 
gh-117618@footnote{https://github.com/python/cpython/issues/117618}: Suporte a @code{package.module} como @code{filename} para o comando @code{break} de @ref{a5,,pdb}

@item 
gh-102247@footnote{https://github.com/python/cpython/issues/102247}: os códigos de status enum com constantes em http.HTTPStatus são atualizados para incluir os nomes do RFC9110. Este RFC inclui alguns status HTTP usados anteriormente apenas para WEBDAV e atribui nomes mais genéricos a eles.

As constantes antigas são preservadas para retrocompatibilidade.

@item 
gh-117607@footnote{https://github.com/python/cpython/issues/117607}: Aceleração de @ref{4aa,,os.path.relpath()}.

@item 
gh-117586@footnote{https://github.com/python/cpython/issues/117586}: Aceleração de @ref{22d,,pathlib.Path.glob()} trabalhando com strings internamente.

@item 
gh-117225@footnote{https://github.com/python/cpython/issues/117225}: Adiciona cor à saída do doctest. Patch por Hugo van Kemenade.

@item 
gh-117566@footnote{https://github.com/python/cpython/issues/117566}: @ref{1720,,ipaddress.IPv6Address.is_loopback()} agora retornará @code{True} para endereços de loopback mapeados em IPv4, ou seja, endereços no espaço de endereço @code{::ffff:127.0.0.0/104}.

@item 
gh-117546@footnote{https://github.com/python/cpython/issues/117546}: Corrige o problema em que @ref{225,,os.path.realpath()} parou de resolver links simbólicos após encontrar um loop de links simbólicos no POSIX.

@item 
gh-116720@footnote{https://github.com/python/cpython/issues/116720}: Comportamento aprimorado de @ref{1b5,,asyncio.TaskGroup} quando um cancelamento externo colide com um cancelamento interno. Por exemplo, quando dois grupos de tarefas são aninhados e ambos experimentam uma exceção em uma tarefa filha simultaneamente, era possível que o grupo de tarefas externo se comportasse mal, porque seu cancelamento interno foi engolido pelo grupo de tarefas interno.

No caso em que um grupo de tarefas é cancelado externamente e também deve levantar uma @ref{1b6,,ExceptionGroup}, ele agora chamará o método @ref{1b7,,cancel()} da tarefa pai. Isso garante que uma @ref{1b8,,asyncio.CancelledError} será levantada no próximo @ref{1b9,,await}, para que o cancelamento não seja perdido.

Um benefício adicional dessas mudanças é que os grupos de tarefas agora preservam a contagem de cancelamentos (@ref{1ba,,asyncio.Task.cancelling()}).

Para lidar com alguns casos extremos, @ref{1bb,,asyncio.Task.uncancel()} agora pode redefinir o sinalizador não documentado @code{_must_cancel} quando a contagem de cancelamentos chegar a zero.

@item 
gh-117516@footnote{https://github.com/python/cpython/issues/117516}: Adiciona @ref{163,,typing.TypeIs}, implementando 
@geindex Propostas de Melhorias do Python; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}. Patch por Jelle Zijlstra.

@item 
gh-117503@footnote{https://github.com/python/cpython/issues/117503}: Corrige suporte de nomes de usuários não-ASCII em caminhos de bytes em @ref{a1e,,os.path.expanduser()} no Posix.

@item 
gh-117394@footnote{https://github.com/python/cpython/issues/117394}: @ref{a1c,,os.path.ismount()} agora é 2-3 vezes mais rápido se o usuário tiver permissões.

@item 
gh-117313@footnote{https://github.com/python/cpython/issues/117313}: Trata apenas @code{'\\n'}, @code{'\\r'} e @code{'\\r\\n'} como separadores de linha ao redobrar as mensagens @ref{3b,,email}. Preserva os caracteres de controle @code{'\\v'}, @code{'\\f'}, @code{'\\x1c'}, @code{'\\x1d'} e @code{'\\x1e'} e os separadores de linha Unicode @code{'\\x85'}, @code{'\\u2028'} e @code{'\\u2029'} como estão.

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: Converte @code{_ctypes} para inicialização multifásica (
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: Adiciona a função @ref{207,,mimetypes.guess_file_type()} que funciona com o caminho do arquivo. Passar o caminho do arquivo em vez da URL em @ref{208,,guess_type()} está @ref{209,,suavemente descontinuado}.

@item 
gh-68583@footnote{https://github.com/python/cpython/issues/68583}: CLI de webbrowser: substitui getopt por argparse, adiciona opções longas. Patch de Hugo van Kemenade.

@item 
gh-116871@footnote{https://github.com/python/cpython/issues/116871}: Sugestões de nome para @ref{34b,,AttributeError} e @ref{419,,ImportError} agora incluem apenas nomes sublinhados se o nome original estiver sublinhado.

@item 
gh-116023@footnote{https://github.com/python/cpython/issues/116023}: Não mostra campos vazios (valor @code{None} ou @code{[]}) em @ref{8ea,,ast.dump()} por padrão. Adiciona o parâmetro @code{show_empty=False} para mostrá-los opcionalmente.

@item 
gh-115961@footnote{https://github.com/python/cpython/issues/115961}: Adicionados atributos @code{name} e @code{mode} para objetos arquivo ou similares compactados e arquivados nos módulos @ref{13,,bz2}, @ref{8a,,lzma}, @ref{de,,tarfile} e @ref{131,,zipfile}. O valor do atributo @code{mode} de @ref{41a,,gzip.GzipFile} foi alterado de inteiro (@code{1} ou @code{2}) para string (@code{'rb'} ou @code{'wb'}). O valor do atributo @code{mode} do objeto arquivo ou similar legível retornado por @ref{41b,,zipfile.ZipFile.open()} foi alterado de @code{'r'} para @code{'rb'}.

@item 
gh-82062@footnote{https://github.com/python/cpython/issues/82062}: Corrige @ref{738,,inspect.signature()} para manipular corretamente os padrões de parâmetros em métodos em módulos de extensão que usam nomes definidos no espaço de nomes do módulo.

@item 
gh-83856@footnote{https://github.com/python/cpython/issues/83856}: Honra @ref{c,,atexit} para todos os métodos de inicialização @ref{94,,multiprocessing}

@item 
gh-113081@footnote{https://github.com/python/cpython/issues/113081}: Imprime exceção colorida assim como o traceback embutido em @ref{a5,,pdb}

@item 
gh-112855@footnote{https://github.com/python/cpython/issues/112855}: Acelera a serialização com pickle de objetos @ref{4a6,,pathlib.PurePath}. Patch por Barney Gale.

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: Suporte a eventos de opcode em @ref{f,,bdb}

@item 
gh-109617@footnote{https://github.com/python/cpython/issues/109617}: @code{ncurses}: corrigiu uma falha que poderia ocorrer no macOS 13 ou anterior quando o Python era criado com o SDK do Apple Xcode 15.

@item 
gh-83151@footnote{https://github.com/python/cpython/issues/83151}: Ativadas declarações e avaliações arbitrárias no shell @ref{a5,,pdb} para acessar as variáveis locais do quadro atual, o que tornou possível que códigos multiescopo, como geradores ou funções aninhadas, funcionassem.

@item 
gh-110209@footnote{https://github.com/python/cpython/issues/110209}: Adicionado @ref{73b,,__class_getitem__()} a @ref{1721,,types.GeneratorType} e @ref{eb8,,types.CoroutineType} para fins de dicas de tipo. Patch por James Hilton-Balfe.

@item 
gh-108191@footnote{https://github.com/python/cpython/issues/108191}: O @ref{1d1,,types.SimpleNamespace} agora aceita um argumento posicional opcional que especifica valores iniciais de atributos como um dict ou um iterável de pares de chave-valor.

@item 
gh-62090@footnote{https://github.com/python/cpython/issues/62090}: Corrige erros de asserção causados por espaços em branco em metavars ou grupos suprimidos com @code{SUPPRESS} em @ref{6,,argparse} simplificando a formatação de uso. Patch por Ali Hamdan.

@item 
gh-102402@footnote{https://github.com/python/cpython/issues/102402}: Ajusta @code{logging.LogRecord} para usar @code{time.time_ns()} e corrige um pequeno bug relacionado à matemática de ponto flutuante.

@item 
gh-100242@footnote{https://github.com/python/cpython/issues/100242}: Traz a implementação Python pura @code{functools.partial.__new__} mais alinhada com a implementação C ao não apenas verificar sempre a presença do atributo @code{'func'} no primeiro argumento de @code{partial}. Em vez disso, tanto a versão Python quanto a versão C realizam uma verificação @code{isinstance(func, partial)} no primeiro argumento de @code{partial}.

@item 
gh-99730@footnote{https://github.com/python/cpython/issues/99730}: Solicitações HEAD não são mais atualizadas para solicitações GET durante redirecionamentos em urllib.

@item 
gh-66410@footnote{https://github.com/python/cpython/issues/66410}: Define o módulo global @code{wantobjects} @code{tkinter} como @code{2} antes de criar o objeto @ref{1722,,Tk} ou chamar o método @code{wantobjects()} do objeto @code{Tk} com o argumento @code{2} agora faz com que argumentos para retornos de chamada registrados no módulo @ref{f0,,tkinter} sejam passados como vários objetos Python (@code{int}, @code{float}, @code{bytes}, @code{tuple}), dependendo de sua representação interna em Tcl, em vez de sempre @code{str}. @code{tkinter.wantobjects} agora está definido como @code{2} por padrão.

@item 
bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}: Corrige vários IndexError ao analisar e-mails com Message-ID, endereço, rotas, etc. truncados, por exemplo, @code{example@@}.

@item 
bpo-39324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39324}: Adiciona mapeamento de tipo mime para .md <-> text/markdown

@item 
bpo-18108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18108}: @ref{240,,shutil.chown()} agora suporta argumentos nomeados `dir_fd' e `follow_symlinks'.

@item 
bpo-30988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30988}: Corrige análise de e-mails com cabeçalhos de endereço inválidos com um ponto inicial ou final. Patch por tsufeki.

@item 
bpo-32839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32839}: Adiciona o método @code{after_info()} para widgets Tkinter.
@end itemize

@node Documentação<11>,Construção<14>,Biblioteca<29>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id143}@anchor{1723}
@subsubsection Documentação



@itemize -

@item 
gh-117928@footnote{https://github.com/python/cpython/issues/117928}: A versão mínima do Sphinx necessária para a documentação agora é 6.2.1.
@end itemize

@node Construção<14>,Windows<12>,Documentação<11>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id144}@anchor{1724}
@subsubsection Construção



@itemize -

@item 
gh-118734@footnote{https://github.com/python/cpython/issues/118734}: Corrige a construção do Windows quando invocada diretamente (não por meio do script @code{build.bat}) sem especificar um valor para @code{UseTIER2}.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: A opção @code{configure} @ref{412,,--with-system-libmpdec} agora tem como padrão @code{yes}. A cópia empacotada de @code{libmpdecimal} será removida no Python 3.15.

@item 
gh-117845@footnote{https://github.com/python/cpython/issues/117845}: Corrige a construção em versões recentes do libedit detectando assinaturas de hook readline em @code{configure}.

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: Um projeto de testbed foi adicionado para executar o conjunto de testes no Android.

@item 
gh-117645@footnote{https://github.com/python/cpython/issues/117645}: Aumenta o tamanho da pilha WASI de 512 KiB para 8 MiB e a memória inicial de 10 MiB para 20 MiB. Patch por Victor Stinner.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: @code{configure} agora usa @code{pkg-config} para detectar dependências @ref{36,,decimal} se a opção @ref{412,,--with-system-libmpdec} for fornecida.
@end itemize

@node Windows<12>,macOS<8>,Construção<14>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id145}@anchor{1725}
@subsubsection Windows



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Atualiza o instalador do Windows para usar libmpdecimal 4.0.0.

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: @ref{21d,,os.mkdir()} agora aceita `modo' de @code{0o700} para restringir o novo diretório ao usuário atual.

@item 
gh-118347@footnote{https://github.com/python/cpython/issues/118347}: Corrige atualizações do iniciador que não sendo instaladas.

@item 
gh-118293@footnote{https://github.com/python/cpython/issues/118293}: O módulo @code{multiprocessing} agora passa o sinalizador @code{STARTF_FORCEOFFFEEDBACK} ao gerar processos para informar ao Windows para não alterar o cursor do mouse.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Atualiza o instalador do Windows para usar o SQLite 3.45.3.

@item 
gh-90329@footnote{https://github.com/python/cpython/issues/90329}: Suprime o aviso exibido na criação do ambiente virtual quando os caminhos solicitados e criados diferem apenas por um nome curto (estilo 8.3). Os avisos continuarão a ser exibidos se uma junção ou link simbólico no caminho fez com que o venv fosse criado em um local diferente do solicitado originalmente.

@item 
gh-117786@footnote{https://github.com/python/cpython/issues/117786}: Corrige ambientes virtuais que não iniciam corretamente quando criados a partir de uma instalação da Store.
@end itemize

@node macOS<8>,IDLE<12>,Windows<12>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id146}@anchor{1726}
@subsubsection macOS



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Atualiza o instalador do macOS para usar libmpdecimal 4.0.0.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: O uso do símbolo do pré-processador iOS foi tornado compatível com SDKs macOS mais antigos.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Atualiza o instalador macOS para usar o SQLite 3.45.3.

@item 
gh-91629@footnote{https://github.com/python/cpython/issues/91629}: Use as configurações @code{~/.config/fish/conf.d} e @code{fish_add_path} para definir 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} ao instalar para o shell Fish.
@end itemize

@node IDLE<12>,API C<15>,macOS<8>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id147}@anchor{1727}
@subsubsection IDLE



@itemize -

@item 
bpo-34774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34774}: Use o tema de cores selecionado pelo usuário para Help => IDLE Doc.
@end itemize

@node API C<15>,,IDLE<12>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id148}@anchor{1728}
@subsubsection API C



@itemize -

@item 
gh-118124@footnote{https://github.com/python/cpython/issues/118124}: Corrige @ref{1729,,Py_BUILD_ASSERT} e @ref{172a,,Py_BUILD_ASSERT_EXPR} para expressões não constantes: use @code{static_assert()} no C11 e mais recentes. Patch por Victor Stinner.

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: Adiciona variante “Raw” das funções PyTime


@itemize *

@item 
@ref{332,,PyTime_MonotonicRaw()}

@item 
@ref{334,,PyTime_PerfCounterRaw()}

@item 
@ref{336,,PyTime_TimeRaw()}
@end itemize

Patch por Victor Stinner.

@item 
gh-117987@footnote{https://github.com/python/cpython/issues/117987}: Restaura funções removidas no Python 3.13 alpha 1:


@itemize *

@item 
@ref{172b,,Py_SetPythonHome()}

@item 
@ref{172c,,Py_SetProgramName()}

@item 
@ref{172d,,PySys_SetArgvEx()}

@item 
@ref{172e,,PySys_SetArgv()}
@end itemize

Patch por Victor Stinner.

@item 
gh-117929@footnote{https://github.com/python/cpython/issues/117929}: Restaura função removida @ref{172f,,PyEval_InitThreads()}. Patch por Victor Stinner.

@item 
gh-117534@footnote{https://github.com/python/cpython/issues/117534}: Melhora a lógica de validação na implementação C de @ref{617,,datetime.datetime.fromisoformat()} para lidar melhor com anos inválidos. Patch por Vlad Efanov.

@item 
gh-68114@footnote{https://github.com/python/cpython/issues/68114}: Corrigido o tratamento de skipitem() dos antigos formatadores ‘w’ e ‘w#’. Eles não são mais suportados e agora levantam uma exceção se usados.

@item 
gh-111997@footnote{https://github.com/python/cpython/issues/111997}: Adiciona uma API C para disparar eventos de monitoramento.
@end itemize

@node Python 3 13 0 alpha 6,Python 3 13 0 alpha 5,Python 3 13 0 beta 1,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-6}@anchor{1730}
@subsection Python 3.13.0 alpha 6


`Data de lançamento: 2024-04-09'

@menu
* Núcleo e embutidos: Núcleo e embutidos<26>. 
* Biblioteca: Biblioteca<30>. 
* Núcleo e embutidos: Núcleo e embutidos<27>. 
* Biblioteca: Biblioteca<31>. 
* Documentação: Documentação<12>. 
* Testes: Testes<15>. 
* Construção: Construção<15>. 
* Windows: Windows<13>. 
* API C: API C<16>. 

@end menu

@node Núcleo e embutidos<26>,Biblioteca<30>,,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id149}@anchor{1731}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-117494@footnote{https://github.com/python/cpython/issues/117494}: Refatorada a estrutura de dados da sequência de instruções de compile.c para instruction_sequence.c.

@item 
gh-116968@footnote{https://github.com/python/cpython/issues/116968}: Introduzido um tipo de contador de backoff unificado de 16 bits (@code{_Py_BackoffCounter}), compartilhado entre o especializador adaptativo de Nível 1 e o otimizador de Nível 2. A API usada para contadores de especialização adaptável é alterada, mas o comportamento é (supostamente) idêntico.

O comportamento dos contadores de Nível 2 é alterado:


@itemize *

@item 
Não há mais limites dinâmicos (nunca os variamos).

@item 
Todos os contadores agora usam o mesmo backoff exponencial.

@item 
O contador para @code{JUMP_BACKWARD} começa a contagem regressiva a partir de 16.

@item 
A @code{temperature} nas saídas laterais começa a contagem regressiva a partir de 64.
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Melhora o desempenho dos seguintes métodos @ref{1c2,,bytes} e @ref{2ea,,bytearray} adaptando-os à convenção de chamada @ref{1713,,METH_FASTCALL}:


@itemize *

@item 
@code{endswith()}

@item 
@code{startswith()}
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: Melhora o desempenho dos seguintes métodos @ref{44c,,str} adaptando-os à convenção de chamada @ref{1713,,METH_FASTCALL}:


@itemize *

@item 
@ref{1732,,count()}

@item 
@ref{efb,,endswith()}

@item 
@ref{ed7,,find()}

@item 
@ref{1733,,index()}

@item 
@ref{ed8,,rfind()}

@item 
@ref{1299,,rindex()}

@item 
@ref{efa,,startswith()}
@end itemize

@item 
gh-117411@footnote{https://github.com/python/cpython/issues/117411}: Move @code{PyFutureFeatures} para um cabeçalho interno e torna-o privado.

@item 
gh-109120@footnote{https://github.com/python/cpython/issues/109120}: Adicionado identificador de expressões de estrela incorretas, por exemplo @code{f(3, *)}. Patch por Grigoryev Semyon

@item 
gh-117266@footnote{https://github.com/python/cpython/issues/117266}: Corrige travamentos para certas subclasses criadas pelo usuário de @ref{1a6,,ast.AST}. Essas classes agora devem definir o atributo @code{_field_types}.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Atualizado o código C do projeto HACL*@footnote{https://github.com/hacl-star/hacl-star} do @ref{68,,hashlib} embutido a partir do upstream que usamos para muitas implementações quando elas não estão presentes via OpenSSL em uma determinada construção. Isso também evita o raro potencial de um problema de vinculação de regra de definição de nome de símbolo C.

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: Altera o antigo bit de espaço de objetos na geração jovem de 0 para gcstate->visited, para que quaisquer objetos criados durante o GC tenham o antigo bit definido corretamente se forem movidos para a geração antiga.

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: O GC do ciclo agora escolhe o tamanho dos incrementos com base no tamanho total do heap, em vez da taxa de criação de objetos. Isso garante que ele possa acompanhar o crescimento dos heaps.

@item 
gh-116735@footnote{https://github.com/python/cpython/issues/116735}: Para @code{INSTRUMENTED_CALL_FUNCTION_EX}, define @code{arg0} como @code{sys.monitoring.MISSING} em vez de @code{None} para o evento @ref{1734,,CALL}.

@item 
gh-113964@footnote{https://github.com/python/cpython/issues/113964}: Iniciar novas threads e a criação de processos por meio de @ref{197,,os.fork()} agora são impedidos somente quando todas as threads não daemon são encerradas.

@item 
gh-116626@footnote{https://github.com/python/cpython/issues/116626}: Garante que @code{INSTRUMENTED_CALL_FUNCTION_EX} sempre emita @ref{1734,,CALL}

@item 
gh-116554@footnote{https://github.com/python/cpython/issues/116554}: @code{list.sort()} agora explora mais casos de ordenação parcial, particularmente aqueles com longas execuções descendentes com subexecuções de valores iguais. Elas são reconhecidas como execuções únicas agora (anteriormente, cada bloco de valores repetidos fazia com que uma nova execução fosse criada).

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Adicionado um carregador que pode descobrir módulos de extensão em uma pasta Frameworks no estilo iOS.

@item 
gh-115775@footnote{https://github.com/python/cpython/issues/115775}: O compilador preenche o novo campo @code{__static_attributes__} em uma classe com os nomes dos atributos desta classe que são acessados por meio de self.X de qualquer função em seu corpo.

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: A array de valores, a estrutura @code{PyDictValues} agora é incorporada ao objeto durante a alocação. Isso fornece melhor desempenho no caso comum e não degrada tanto quando o @code{__dict__} do objeto é materializado.

@item 
gh-108362@footnote{https://github.com/python/cpython/issues/108362}: Implementa um coletor de lixo cíclico incremental. Ao coletar a geração antiga em incrementos, não há necessidade de uma varredura completa do heap. Isso pode reduzir enormemente o tempo máximo de pausa para programas com grandes heaps.

Reduz o número de gerações de três para duas. A geração antiga é dividida em dois espaços, “visitado” e “pendente”.

A coleta acontece em duas etapas:: * Um incremento é formado a partir da geração jovem e uma pequena parte do espaço pendente. * Este incremento é escaneado e os sobreviventes são movidos para o final do espaço visitado.

Quando o espaço de coleta fica vazio, os dois espaços são trocados.
@end itemize

@node Biblioteca<30>,Núcleo e embutidos<27>,Núcleo e embutidos<26>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id150}@anchor{1735}
@subsubsection Biblioteca



@itemize -

@item 
gh-109870@footnote{https://github.com/python/cpython/issues/109870}: Dataclasses agora chamam @ref{17f,,exec()} uma vez por dataclass, em vez de uma vez por método adicionado. Isso pode acelerar a criação de dataclass em até 20%.

@item 
gh-97901@footnote{https://github.com/python/cpython/issues/97901}: O tipo MIME @code{text/rtf} agora é suportado por @ref{8f,,mimetypes}.
@end itemize

@node Núcleo e embutidos<27>,Biblioteca<31>,Biblioteca<30>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id151}@anchor{1736}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-24612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24612}: Melhora o @ref{18d,,SyntaxError} que acontece quando ‘not’ aparece após um operador. Patch por Pablo Galindo
@end itemize

@node Biblioteca<31>,Documentação<12>,Núcleo e embutidos<27>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id152}@anchor{1737}
@subsubsection Biblioteca



@itemize -

@item 
gh-117648@footnote{https://github.com/python/cpython/issues/117648}: Melhora o desempenho de @ref{171f,,os.path.join()} e @ref{a1e,,os.path.expanduser()}.

@item 
gh-117584@footnote{https://github.com/python/cpython/issues/117584}: Raise @ref{2c3,,TypeError} for non-paths in
@ref{4aa,,posixpath.relpath}.

@item 
gh-117467@footnote{https://github.com/python/cpython/issues/117467}: Preserve mailbox ownership when rewriting in
@ref{1738,,mailbox.mbox.flush}. Patch by Tony
Mountifield.

@item 
gh-114848@footnote{https://github.com/python/cpython/issues/114848}: Levanta @ref{42b,,FileNotFoundError} quando @code{getcwd()} retornar ‘(unreachable)’, o que pode acontecer no Linux >= 2.6.36 com glibc < 2.27.

@item 
gh-117459@footnote{https://github.com/python/cpython/issues/117459}: @code{asyncio.asyncio.run_coroutine_threadsafe()} agora mantém o traceback de @code{CancelledError}, @ref{838,,TimeoutError} e @code{InvalidStateError} que são levantados na corrotina.

@item 
gh-117381@footnote{https://github.com/python/cpython/issues/117381}: Corrige mensagem de erro para @code{ntpath.commonpath()}.

@item 
gh-117337@footnote{https://github.com/python/cpython/issues/117337}: Descontinua funções não documentadas @code{glob.glob0()} e @code{glob.glob1()}. Use @ref{29f,,glob.glob()} e passe um diretório para seu argumento `root_dir'.

@item 
gh-117349@footnote{https://github.com/python/cpython/issues/117349}: Otimiza várias funções em @ref{a2,,os.path}.

@item 
gh-117348@footnote{https://github.com/python/cpython/issues/117348}: Refatorado @code{configparser.RawConfigParser._read()} para reduzir a complexidade ciclométrica e melhorar a compreensão.

@item 
gh-117335@footnote{https://github.com/python/cpython/issues/117335}: Levanta TypeError para não sequências para @code{ntpath.commonpath()}.

@item 
gh-66449@footnote{https://github.com/python/cpython/issues/66449}: @ref{1c8,,configparser.ConfigParser} agora aceita seções sem nome antes das nomeadas, se configurado para isso.

@item 
gh-88014@footnote{https://github.com/python/cpython/issues/88014}: Na documentação de @ref{41a,,gzip.GzipFile} no módulo gzip, explique o tipo de dados do argumento construtor opcional `mtime' e recomende @code{mtime = 0} para gerar fluxos determinísticos.

@item 
gh-117310@footnote{https://github.com/python/cpython/issues/117310}: Corrigida uma falha improvável inicial e extra @code{Py_DECREF} em @ref{d0,,ssl} ao criar um novo @code{_ssl._SSLContext} se o CPython foi construído de forma implausível, de modo que a lista de cifras padrão está vazia `ou' a biblioteca SSL à qual foi vinculado relata uma falha de sua API C @code{SSL_CTX_set_cipher_list()}.

@item 
gh-117294@footnote{https://github.com/python/cpython/issues/117294}: Um @code{DocTestCase} agora relata como ignorado se todos os exemplos no doctest forem ignorados.

@item 
gh-98966@footnote{https://github.com/python/cpython/issues/98966}: Em @ref{d6,,subprocess}, levanta uma mensagem mais informativa quando @code{stdout=STDOUT}.

@item 
gh-117225@footnote{https://github.com/python/cpython/issues/117225}: doctest: imprime apenas “e X failed” quando não for zero, não pluraliza “1 items”. Patch de Hugo van Kemenade.

@item 
gh-117205@footnote{https://github.com/python/cpython/issues/117205}: Acelera @ref{b38,,compileall.compile_dir()} em 20% ao usar multiprocessamento aumentando @code{chunksize}.

@item 
gh-117178@footnote{https://github.com/python/cpython/issues/117178}: Corrige a regressão no carregamento lento de módulos autorreferenciais, introduzida em gh-114781@footnote{https://github.com/python/cpython/issues/114781}.

@item 
gh-112383@footnote{https://github.com/python/cpython/issues/112383}: Corrige o tratamento do módulo @ref{38,,dis} de instruções @code{ENTER_EXECUTOR}.

@item 
gh-117182@footnote{https://github.com/python/cpython/issues/117182}: O carregamento preguiçoso de módulos que modificam seu próprio @code{__class__} não reverte mais o @code{__class__} para @ref{e3f,,types.ModuleType}.

@item 
gh-117084@footnote{https://github.com/python/cpython/issues/117084}: Corrige a extração de @ref{131,,zipfile} para entradas de diretório com o nome contendo barras invertidas no Windows.

@item 
gh-117114@footnote{https://github.com/python/cpython/issues/117114}: Torna @ref{1739,,os.path.isdevdrive()} disponível em todas as plataformas. Para aqueles que não oferecem Dev Drives, ele sempre retornará @code{False}.

@item 
gh-117110@footnote{https://github.com/python/cpython/issues/117110}: Corrige um bug que impede que subclasses de @ref{6ac,,typing.Any} sejam instanciadas com argumentos. Patch por Chris Fu.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Adiadas as importações de seleção em importlib.metadata e importlib.resources para uma aceleração de 14%.

@item 
gh-70647@footnote{https://github.com/python/cpython/issues/70647}: Inicia o período de descontinuação para o comportamento atual de @ref{16f6,,datetime.datetime.strptime()} e @ref{1474,,time.strptime()} que sempre falha ao analisar uma sequência de datas com um @ref{202,,ValueError} envolvendo um dia do mês, como @code{strptime("02-29", "%m-%d")} quando um ano `não' é especificado e a data acontece de ser 29 de fevereiro. Isso deve ajudar a evitar que os usuários encontrem novos bugs a cada quatro anos devido a uma suposição natural equivocada sobre a API ao analisar valores de data parciais.

@item 
gh-116987@footnote{https://github.com/python/cpython/issues/116987}: Corrigida @code{inspect.findsource()} para objetos de código de classe.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Modifica a biblioteca padrão para permitir diferenças de plataforma iOS.

@item 
gh-90872@footnote{https://github.com/python/cpython/issues/90872}: No Windows, @ref{d05,,subprocess.Popen.wait()} não chama mais @code{WaitForSingleObject()} com um tempo limite negativo: passe @code{0} ms se o tempo limite for negativo. Patch por Victor Stinner.

@item 
gh-116957@footnote{https://github.com/python/cpython/issues/116957}: configparser: Não deixa os valores ConfigParser em um estado inválido (armazenados como uma lista em vez de uma str) após uma leitura anterior gerar DuplicateSectionError ou DuplicateOptionError.

@item 
gh-115538@footnote{https://github.com/python/cpython/issues/115538}: @code{_io.WindowsConsoleIO} agora emite um aviso se um valor booleano for passado como um argumento filedescriptor.

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: Ignora linhas vazias e comentários em @code{.pdbrc}

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: Atualizado zipfile._path de zipp 3.18@footnote{https://zipp.readthedocs.io/en/latest/history.html#v3-18-0}, fornecendo melhor compatibilidade para PyPy, melhor desempenho glob para arquivos zip profundamente aninhados e fornecendo acesso interno a @code{CompleteDirs.inject} para uso em outros testes (como importlib.resources).

@item 
gh-63207@footnote{https://github.com/python/cpython/issues/63207}: No Windows, @ref{254,,time.time()} agora usa o relógio @code{GetSystemTimePreciseAsFileTime()} para ter uma resolução melhor que 1 us, em vez do relógio @code{GetSystemTimeAsFileTime()} que tem uma resolução de 15,6 ms. Patch por Victor Stinner.

@item 
gh-116764@footnote{https://github.com/python/cpython/issues/116764}: Restaura o suporte de @code{None} e outros valores falsos nas funções @ref{10a,,urllib.parse} @ref{27a,,parse_qs()} e @ref{279,,parse_qsl()}. Além disso, agora eles levantam um TypeError para inteiros diferentes de zero e sequências não vazias.

@item 
gh-116811@footnote{https://github.com/python/cpython/issues/116811}: Em @code{PathFinder.invalidate_caches}, delega para @code{MetadataPathFinder.invalidate_caches}.

@item 
gh-116647@footnote{https://github.com/python/cpython/issues/116647}: Corrige filho recursivo em dataclasses

@item 
gh-113171@footnote{https://github.com/python/cpython/issues/113171}: Corrige vários falsos positivos e falsos negativos em


@itemize *

@item 
@ref{173a,,ipaddress.IPv4Address.is_private} (veja estas documentações para detalhes)

@item 
@ref{f93,,ipaddress.IPv4Address.is_global}

@item 
@ref{173b,,ipaddress.IPv6Address.is_private}

@item 
@ref{173c,,ipaddress.IPv6Address.is_global}
@end itemize

Também nos atributos correspondentes @ref{1fe,,ipaddress.IPv4Network} e @ref{1ff,,ipaddress.IPv6Network}.

@item 
gh-63283@footnote{https://github.com/python/cpython/issues/63283}: Em @ref{52,,encodings.idna}, qualquer capitalização do prefixo ACE (@code{xn--}) agora é aceitável. Patch por Pepijn de Vos e Zackery Spytz.

@item 
gh-71042@footnote{https://github.com/python/cpython/issues/71042}: Adiciona @ref{173d,,platform.android_ver()}, que fornece informações sobre o dispositivo e o sistema operacional no Android.

@item 
gh-73468@footnote{https://github.com/python/cpython/issues/73468}: Adicionada a nova função @ref{205,,math.fma()}, envolvendo a operação @code{fma()} do C99: função de multiplicação-adição fundida. Patch por Mark Dickinson e Victor Stinner.

@item 
gh-116608@footnote{https://github.com/python/cpython/issues/116608}: As funções @ref{7b,,importlib.resources} @ref{1ec,,is_resource()}, @ref{1ed,,open_binary()}, @ref{1ee,,open_text()}, @ref{1ef,,path()}, @ref{1f0,,read_binary()} e @ref{1f1,,read_text()} não estão mais descontinuadas e oferecem suporte a subdiretórios por meio de vários argumentos posicionais. A função @ref{1f2,,contents()} também permite subdiretórios, mas continua descontinuada.

@item 
gh-116484@footnote{https://github.com/python/cpython/issues/116484}: Altera os nomes de widgets @code{tkinter.Checkbutton} gerados automaticamente para evitar colisões com nomes de widgets @code{tkinter.ttk.Checkbutton} gerados automaticamente dentro do mesmo widget pai.

@item 
gh-114314@footnote{https://github.com/python/cpython/issues/114314}: Em @ref{2a,,ctypes}, os dados de ctype agora são armazenados em objetos type diretamente em vez de em uma subclasse dict. Esta é uma alteração interna que não deve afetar o uso.

@item 
gh-116401@footnote{https://github.com/python/cpython/issues/116401}: Corrige o bloqueio de @ref{b71,,os.fwalk()} e @ref{301,,shutil.rmtree()} ao abrir o encadeamento nomeado.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Implementa @ref{d6c,,ctypes.util.find_library()} no Android.

@item 
gh-90535@footnote{https://github.com/python/cpython/issues/90535}: Corrige suporte de valores de `interval' > 1 em @code{logging.TimedRotatingFileHandler} para @code{when='MIDNIGHT'} e @code{when='Wx'}.

@item 
gh-113308@footnote{https://github.com/python/cpython/issues/113308}: Remove algumas partes internas protegidas de @ref{110,,uuid}: @code{_has_uuid_generate_time_safe}, @code{_netbios_getnode}, @code{_ipconfig_getnode} e @code{_load_system_functions}. Elas não eram usadas.

@item 
gh-115627@footnote{https://github.com/python/cpython/issues/115627}: Corrige o tratamento de erro do módulo @ref{d0,,ssl} de término de conexão por peer. Agora ele lança um OSError com o código de erro apropriado em vez de um EOFError.

@item 
gh-114847@footnote{https://github.com/python/cpython/issues/114847}: Acelera @ref{225,,os.path.realpath()} em plataformas não Windows.

@item 
gh-114271@footnote{https://github.com/python/cpython/issues/114271}: Corrige uma corrida em @code{threading.Thread.join()}.

@code{threading._MainThread} agora sempre representa o thread principal do interpretador principal.

@code{PyThreadState.on_delete} e @code{PyThreadState.on_delete_data} foram removidos.

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: Adiciona os métodos @ref{1b2,,asyncio.Server.close_clients()} e @ref{1b3,,asyncio.Server.abort_clients()} que permitem fechar um servidor asyncio de forma mais forçada.

@item 
gh-85287@footnote{https://github.com/python/cpython/issues/85287}: Altera os codecs Unicode para retornar UnicodeEncodeError ou UnicodeDecodeError, em vez de apenas UnicodeError.

@item 
gh-113548@footnote{https://github.com/python/cpython/issues/113548}: @ref{a5,,pdb} agora permite argumentos CLI para @code{pdb -m}.

@item 
gh-112948@footnote{https://github.com/python/cpython/issues/112948}: Torna a conclusão de @ref{a5,,pdb} semelhante ao Python REPL

@item 
gh-105866@footnote{https://github.com/python/cpython/issues/105866}: Corrigido o bug @code{_get_slots} que causava erro ao definir dataclasses com slots e um weakref_slot.

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: Adiciona a terminação @ref{a80,,asyncio.Queue} com o método @ref{1b0,,shutdown()}.

@item 
gh-89739@footnote{https://github.com/python/cpython/issues/89739}: O módulo @ref{132,,zipimport} agora pode ler arquivos ZIP64.

@item 
bpo-33533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33533}: @ref{1aa,,asyncio.as_completed()} agora retorna um objeto que é um iterador assíncrono e um iterador simples. O novo padrão de iteração assíncrona permite uma correlação mais fácil entre tarefas anteriores e seus resultados concluídos. Esta é uma correspondência mais próxima ao padrão de iteração de @ref{173e,,concurrent.futures.as_completed()}. Patch por Justin Arthur.

@item 
bpo-27578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27578}: @ref{15f8,,inspect.getsource()} (e funções relacionadas) funcionam com arquivos de módulo vazios, retornando @code{'\\n'} (ou equivalente razoável) em vez de gerar @code{OSError}. Patch por Kernc.

@item 
bpo-37141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37141}: Aceita um iterável de separadores em @ref{1b4,,asyncio.StreamReader.readuntil()}, parando quando um deles for encontrado.

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: Faz @ref{208,,mimetypes.guess_type()} analisar corretamente URLs com apenas um nome de host, URLs contendo fragmento ou consulta e nomes de arquivo com apenas um sharepoint UNC no Windows. Baseado no patch por Dong-hee Na.

@item 
bpo-15010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15010}: @ref{101b,,unittest.TestLoader.discover()} agora salva o valor original de @code{unittest.TestLoader._top_level_dir} e o restaura no final da chamada.
@end itemize

@node Documentação<12>,Testes<15>,Biblioteca<31>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id153}@anchor{173f}
@subsubsection Documentação



@itemize -

@item 
gh-115977@footnote{https://github.com/python/cpython/issues/115977}: Remove referências de compatibilidade para Emscripten.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Adiciona um guia de plataforma iOS e sinaliza módulos não disponíveis no iOS.

@item 
gh-91565@footnote{https://github.com/python/cpython/issues/91565}: Alterações nos arquivos de documentação e saídas de configuração para refletir o novo local para relatar bugs - ou seja, GitHub em vez de bugs.python.org.
@end itemize

@node Testes<15>,Construção<15>,Documentação<12>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id154}@anchor{1740}
@subsubsection Testes



@itemize -

@item 
gh-83434@footnote{https://github.com/python/cpython/issues/83434}: Desativa a saída XML do JUnit (opção de linha de comando @code{--junit-xml=FILE}) no regrtest ao procurar vazamentos de referência (opção @code{-R}). Patch por Victor Stinner.

@item 
gh-117187@footnote{https://github.com/python/cpython/issues/117187}: Corrige testes XML para vanilla Expat <2.6.0.

@item 
gh-116333@footnote{https://github.com/python/cpython/issues/116333}: Testes de coisas relacionadas a TLS (códigos de erro, etc.) foram atualizados para serem mais tolerantes sobre strings e comportamentos de mensagens de erro específicos, como visto nos forks BoringSSL e AWS-LC do OpenSSL.

@item 
gh-117089@footnote{https://github.com/python/cpython/issues/117089}: Testes consolidados para importlib.metadata em seu próprio pacote @code{metadata}.

@item 
gh-115979@footnote{https://github.com/python/cpython/issues/115979}: Atualiza test_importlib para que passe no WASI SDK 21.

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: Adiciona –tsan ao test.regrtest para executar testes TSAN em tempos de execução razoáveis. Patch por Donghee Na.

@item 
gh-116307@footnote{https://github.com/python/cpython/issues/116307}: Adicionado o auxiliar de importação @code{isolated_modules}, pois @code{CleanImport} não remove módulos importados durante o contexto. Use-o em testes importlib.resources para evitar deixar @code{mod} por aí para impedir testes importlib.metadata.
@end itemize

@node Construção<15>,Windows<13>,Testes<15>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id155}@anchor{1741}
@subsubsection Construção



@itemize -

@item 
gh-114736@footnote{https://github.com/python/cpython/issues/114736}: Faz construções WASI usar WASI SDK 21.

@item 
gh-115983@footnote{https://github.com/python/cpython/issues/115983}: Pula a construção de módulos de teste que devem ser construídos como compartilhados sob WASI.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Adiciona script de construção e instruções do Android.
@end itemize

@node Windows<13>,API C<16>,Construção<15>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id156}@anchor{1742}
@subsubsection Windows



@itemize -

@item 
gh-117267@footnote{https://github.com/python/cpython/issues/117267}: Garante que @code{DirEntry.stat().st_ctime} se comporte consistentemente com @ref{4a0,,os.stat()} durante o período de descontinuação de @code{st_ctime} contendo o mesmo valor que @code{st_birthtime}. Após o período de descontinuação, @code{st_ctime} será o tempo de alteração de metadados (ou indisponível por meio de @code{DirEntry}), e apenas @code{st_birthtime} conterá o tempo de criação.

@item 
gh-116195@footnote{https://github.com/python/cpython/issues/116195}: Melhora o desempenho de @ref{1743,,os.getppid()} usando uma API de sistema alternativa quando disponível. Contribuição de vxiiduu.

@item 
gh-88494@footnote{https://github.com/python/cpython/issues/88494}: No Windows, @ref{253,,time.monotonic()} agora usa o relógio @code{QueryPerformanceCounter()} para ter uma resolução melhor que 1 us, em vez do relógio @code{GetTickCount64()} que tem uma resolução de 15,6 ms. Patch por Victor Stinner.

@item 
gh-116773@footnote{https://github.com/python/cpython/issues/116773}: Corrige instâncias de @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}: Corrige a implementação asyncio ProactorEventLoop para que o envio de um datagrama para um endereço que não esteja escutando não impeça o recebimento de mais datagramas.

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: Trocado do código @code{libmpdecimal} fornecido para um pacote externo hospedado separadamente no repositório @code{cpython-source-deps} ao construir o módulo @code{_decimal}.
@end itemize

@node API C<16>,,Windows<13>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id157}@anchor{1744}
@subsubsection API C



@itemize -

@item 
gh-117642@footnote{https://github.com/python/cpython/issues/117642}: Corrige a implementação de 
@geindex Propostas de Melhorias do Python; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} para @code{%#T} e @code{%#N}.

@item 
gh-87193@footnote{https://github.com/python/cpython/issues/87193}: @ref{1745,,_PyBytes_Resize()} agora pode ser chamada para objetos bytes com contagem de referências > 1, incluindo objetos bytes de 1 byte. Ele cria um novo objeto bytes e destrói o antigo se ele tiver contagem de referências > 1.

@item 
gh-117021@footnote{https://github.com/python/cpython/issues/117021}: Corrige estouro de inteiro em @ref{1746,,PyLong_AsPid()} em plataformas de 64 bits que não sejam Windows.

@item 
gh-115756@footnote{https://github.com/python/cpython/issues/115756}: @code{PyCode_GetFirstFree()} é uma API utilizável agora e foi renomeada para @ref{386,,PyUnstable_Code_GetFirstFree()}. (Contribuição de Bogdan Romanyuk em gh-115781@footnote{https://github.com/python/cpython/issues/115781})

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: Adiciona o teste @code{test_cext}: cria uma extensão C para verificar se a API Python C emite avisos do compilador C. Patch por Victor Stinner.

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: Torna a API C compatível com o sinalizador do compilador @code{-Werror=declaration-after-statement} novamente. Patch por Victor Stinner.

@item 
gh-116936@footnote{https://github.com/python/cpython/issues/116936}: Adiciona @ref{394,,PyType_GetModuleByDef()} à API C limitada. Patch por Victor Stinner.

@item 
gh-116809@footnote{https://github.com/python/cpython/issues/116809}: Restaura a função privada @code{_PyErr_ChainExceptions1()} removida. Patch por Victor Stinner.

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: Na versão limitada 3.13 da API C, obter Singletons @code{Py_None}, @code{Py_False}, @code{Py_True}, @code{Py_Ellipsis} e @code{Py_NotImplemented} agora é implementado como chamadas de função no nível ABI estável para ocultar detalhes de implementação. Obter essas constantes ainda retorna referências emprestadas. Patch por Victor Stinner.

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: Adiciona as funções @ref{354,,Py_GetConstant()} e @ref{355,,Py_GetConstantBorrowed()} para obter constantes. Por exemplo, @code{Py_GetConstant(Py_CONSTANT_ZERO)} retorna uma @ref{33d,,referência forte} para a constante zero. Patch por Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Adiciona suporte para os formatos @code{%T}, @code{%T#}, @code{%N} e @code{%N#} para @ref{38a,,PyUnicode_FromFormat()}: formata o nome totalmente qualificado de um tipo de objeto e de um tipo: chama @ref{375,,PyType_GetModuleName()}. Veja 
@geindex Propostas de Melhorias do Python; PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} para mais informações. Patch por Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Adiciona a função @ref{375,,PyType_GetModuleName()} para obter o nome do módulo do tipo. Equivalente a obter o atributo @code{type.__module__}. Patch por Eric Snow e Victor Stinner.

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: Adiciona a função @ref{373,,PyType_GetFullyQualifiedName()} para obter o nome totalmente qualificado do tipo. Equivalente a @code{f"@{type.__module__@}.@{type.__qualname__@}"}, ou @code{type.__qualname__} se @code{type.__module__} não for uma string ou for igual a @code{"builtins"}. Patch por Victor Stinner.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: As extensões C @code{fcntl}, @code{grp}, @code{pwd}, @code{termios}, @code{_statistics} e @code{_testconsole} agora são construídas com a @ref{396,,API C limitada}. Patch por Victor Stinner.

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: Adiciona sinalizadores adicionais a @ref{361,,PyLong_AsNativeBytes()} e @ref{362,,PyLong_FromNativeBytes()} para permitir que o chamador determine como lidar com casos extremos em torno de valores que preenchem o buffer inteiro.

@item 
gh-113024@footnote{https://github.com/python/cpython/issues/113024}: Adiciona a função @ref{367,,PyObject_GenericHash()}.
@end itemize

@node Python 3 13 0 alpha 5,Python 3 13 0 alpha 4,Python 3 13 0 alpha 6,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-5}@anchor{1747}
@subsection Python 3.13.0 alpha 5


`Data de lançamento: 2024-03-12'

@menu
* Segurança: Segurança<14>. 
* Núcleo e embutidos: Núcleo e embutidos<28>. 
* Biblioteca: Biblioteca<32>. 
* Núcleo e embutidos: Núcleo e embutidos<29>. 
* Biblioteca: Biblioteca<33>. 
* Núcleo e embutidos: Núcleo e embutidos<30>. 
* Biblioteca: Biblioteca<34>. 
* Documentação: Documentação<13>. 
* Testes: Testes<16>. 
* Construção: Construção<16>. 
* Windows: Windows<14>. 
* macOS: macOS<9>. 
* IDLE: IDLE<13>. 
* Ferramentas/Demos: Ferramentas/Demos<9>. 
* API C: API C<17>. 

@end menu

@node Segurança<14>,Núcleo e embutidos<28>,,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id158}@anchor{1748}
@subsubsection Segurança



@itemize -

@item 
gh-115398@footnote{https://github.com/python/cpython/issues/115398}: Permite controlar o adiamento da nova análise Expat >=2.6.0 (
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}) adicionando cinco novos métodos:


@itemize *

@item 
@ref{26f,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{270,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{271,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{272,,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{fe0,,ssl.SSLContext.cert_store_stats()} e @ref{fe1,,ssl.SSLContext.get_ca_certs()} agora travam corretamente o acesso ao armazenamento de certificados, quando o @ref{294,,ssl.SSLContext} é compartilhado entre várias threads.
@end itemize

@node Núcleo e embutidos<28>,Biblioteca<32>,Segurança<14>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id159}@anchor{1749}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-116604@footnote{https://github.com/python/cpython/issues/116604}: Respeita o status do coletor de lixo quando chamadas indiretas são feitas via @ref{467,,PyErr_CheckSignals()} e o disjuntor de avaliação. Patch por Pablo Galindo

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: @ref{611,,list} agora é compatível com a implementação da 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.

@item 
gh-116381@footnote{https://github.com/python/cpython/issues/116381}: Adiciona especialização para @code{CONTAINS_OP}.

@item 
gh-116296@footnote{https://github.com/python/cpython/issues/116296}: Corrige possível vazamento de referência no tratamento de erros internos de @code{object.__reduce__()}.

@item 
gh-115823@footnote{https://github.com/python/cpython/issues/115823}: Calcula corretamente intervalos de erro no analisador ao levantar exceções @ref{18d,,SyntaxError} causadas por sequências de bytes inválidas. Patch por Pablo Galindo

@item 
gh-115778@footnote{https://github.com/python/cpython/issues/115778}: Adiciona anotação @code{tierN} para definição de instrução no interpretador DSL.

@item 
gh-115733@footnote{https://github.com/python/cpython/issues/115733}: Corrige travamento ao chamar @code{next()} em iteradores de lista esgotados.

@item 
gh-115700@footnote{https://github.com/python/cpython/issues/115700}: O estágio de construção de regen-cases agora funciona no Windows.

@item 
gh-115347@footnote{https://github.com/python/cpython/issues/115347}: Corrige um bug em que docstring era substituído por um NOP redundante quando Python é executado com @code{-OO}.

@item 
gh-115323@footnote{https://github.com/python/cpython/issues/115323}: Torna a mensagem de erro mais significativa para quando @ref{15b6,,bytearray.extend()} é chamado com um objeto @ref{44c,,str}.

@item 
gh-112175@footnote{https://github.com/python/cpython/issues/112175}: Cada @code{PyThreadState} agora tem seu próprio @code{eval_breaker}, permitindo que threads específicos sejam interrompidos.
@end itemize

@node Biblioteca<32>,Núcleo e embutidos<29>,Núcleo e embutidos<28>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id160}@anchor{174a}
@subsubsection Biblioteca



@itemize -

@item 
gh-115154@footnote{https://github.com/python/cpython/issues/115154}: Corrige um bug que estava fazendo com que a função @ref{166b,,tokenize.untokenize()} manipulasse literais nomeados unicode incorretamente. Patch por Pablo Galindo
@end itemize

@node Núcleo e embutidos<29>,Biblioteca<33>,Biblioteca<32>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id161}@anchor{174b}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-115154@footnote{https://github.com/python/cpython/issues/115154}: Corrige um bug que estava fazendo com que a função @ref{166b,,tokenize.untokenize()} manipulasse literais nomeados unicode incorretamente. Patch por Pablo Galindo
@end itemize

@node Biblioteca<33>,Núcleo e embutidos<30>,Núcleo e embutidos<29>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id162}@anchor{174c}
@subsubsection Biblioteca



@itemize -

@item 
gh-104090@footnote{https://github.com/python/cpython/issues/104090}: O rastreador de recursos de multiprocessamento agora sai com código de status diferente de zero se um vazamento de recurso for detectado. Ele ainda sai com código de status 0 caso contrário.
@end itemize

@node Núcleo e embutidos<30>,Biblioteca<34>,Biblioteca<33>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id163}@anchor{174d}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-105858@footnote{https://github.com/python/cpython/issues/105858}: Melhora os construtores para nós @ref{8,,ast}. Os argumentos de tipos de lista agora assumem como padrão uma lista vazia se omitidos, e os campos opcionais assumem como padrão @code{None}. Os nós AST agora têm um atributo @code{__annotations__} com os tipos esperados de seus atributos. Passar argumentos extras não reconhecidos para nós AST está descontinuado e se tornará um erro no Python 3.15. Omitir um argumento obrigatório para um nó AST está descontinuado e se tornará um erro no Python 3.15. Patch por Jelle Zijlstra.

@item 
gh-101860@footnote{https://github.com/python/cpython/issues/101860}: Expor atributo @code{__name__} na propriedade.

@item 
gh-96497@footnote{https://github.com/python/cpython/issues/96497}: Corrige resolução incorreta de variáveis de classe mutiladas usadas em expressões de atribuição em compreensões.
@end itemize

@node Biblioteca<34>,Documentação<13>,Núcleo e embutidos<30>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id164}@anchor{174e}
@subsubsection Biblioteca



@itemize -

@item 
gh-116600@footnote{https://github.com/python/cpython/issues/116600}: Corrige @ref{800,,repr()} para membros globais @ref{623,,Flag}.

@item 
gh-116349@footnote{https://github.com/python/cpython/issues/116349}: @ref{2a7,,platform.java_ver()} está descontinuado e será removido na versão 3.15. Ele não foi testado em grande parte, tinha uma API confusa e era útil apenas para suporte a Jython.

@item 
gh-116143@footnote{https://github.com/python/cpython/issues/116143}: Corrige uma corrida no pydoc @code{_start_server}, eliminando uma janela na qual @code{_start_server} pode retornar um thread que está “servindo”, mas sem um conjunto @code{docserver}.

@item 
gh-116127@footnote{https://github.com/python/cpython/issues/116127}: @ref{104,,typing}: implementa 
@geindex Propostas de Melhorias do Python; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/} que adiciona suporte a @ref{161,,typing.ReadOnly} para @ref{162,,typing.TypedDict}.

@item 
gh-116325@footnote{https://github.com/python/cpython/issues/116325}: @ref{104,,typing}: levanta @ref{18d,,SyntaxError} em vez de @ref{34b,,AttributeError} em referências de encaminhamento como strings vazias.

@item 
gh-115957@footnote{https://github.com/python/cpython/issues/115957}: Quando @code{asyncio.TaskGroup.create_task} é chamado em um @code{asyncio.TaskGroup} inativo, a corrotina fornecida será fechada (o que impede um @code{RuntimeWarning}).

@item 
gh-115978@footnote{https://github.com/python/cpython/issues/115978}: Desabilita preadv(), readv(), pwritev() e writev() em WASI.

No wasmtime para WASI 0.2, essas funções não passam no test_posix (@indicateurl{https://github.com/bytecodealliance/wasmtime/issues/7830}).

@item 
gh-88352@footnote{https://github.com/python/cpython/issues/88352}: Corrige o cálculo do próximo tempo de rollover no manipulador @code{logging.TimedRotatingFileHandler}. @code{computeRollover()} agora sempre retorna um registro de data e hora maior que o tempo especificado e funciona corretamente durante a mudança de horário de verão. @code{doRollover()} não substitui mais o arquivo já rolado, evitando perda de dados quando executado à meia-noite ou durante tempo repetido na mudança de horário de verão.

@item 
gh-87115@footnote{https://github.com/python/cpython/issues/87115}: Define @code{__main__.__spec__} como @code{None} ao executar um script com @ref{a5,,pdb}

@item 
gh-76511@footnote{https://github.com/python/cpython/issues/76511}: Corrige UnicodeEncodeError em @code{email.Message.as_string()} que resulta quando uma mensagem que afirma estar no conjunto de caracteres ASCII na verdade tem caracteres não ASCII. Caracteres não ASCII agora são substituídos pelo caractere de substituição U+FFFD, como no manipulador de erros @code{replace}.

@item 
gh-89547@footnote{https://github.com/python/cpython/issues/89547}: Adiciona suporte para formulários especiais de digitação aninhada como Final[ClassVar[int]].

@item 
gh-65824@footnote{https://github.com/python/cpython/issues/65824}: Melhora o prompt @code{less} em @ref{b5,,pydoc}.

@item 
gh-116040@footnote{https://github.com/python/cpython/issues/116040}: [Enum] corrige chamadas por valor quando o segundo valor for falso; por exemplo. Cardinal(1, 0)

@item 
gh-115821@footnote{https://github.com/python/cpython/issues/115821}: [Enum] Melhora a mensagem de erro ao chamar super().__new__() em __new__ personalizado.

@item 
gh-85644@footnote{https://github.com/python/cpython/issues/85644}: Usa a variável de ambiente @code{XDG_CURRENT_DESKTOP} em @ref{115,,webbrowser} para verificar a área de trabalho. Prefira-a ao descontinuado @code{GNOME_DESKTOP_SESSION_ID} para detecção do GNOME.

@item 
gh-75988@footnote{https://github.com/python/cpython/issues/75988}: Corrigida @ref{16f4,,unittest.mock.create_autospec()} para passar a chamada para o objeto encapsulado para retornar o resultado real.

@item 
gh-115881@footnote{https://github.com/python/cpython/issues/115881}: Corrige problema em que @ref{1a8,,ast.parse()} sinalizaria incorretamente gerenciadores de contexto condicional (como @code{with (x() if y else z()): ...}) como sintaxe inválida se @code{feature_version=(3, 8)} fosse passado. Isso reverte as alterações na gramática feitas como parte de gh-94949@footnote{https://github.com/python/cpython/issues/94949}.

@item 
gh-115886@footnote{https://github.com/python/cpython/issues/115886}: Corrige truncamento silencioso do nome com um caractere nulo incorporado em @ref{174f,,multiprocessing.shared_memory.SharedMemory}.

@item 
gh-115532@footnote{https://github.com/python/cpython/issues/115532}: Adiciona estimativa de densidade do kernel ao módulo de estatísticas.

@item 
gh-115714@footnote{https://github.com/python/cpython/issues/115714}: No WASI, o módulo @ref{ee,,time} não obtém mais o tempo de processo usando @code{times()} ou @code{CLOCK_PROCESS_CPUTIME_ID}, a API do sistema não é confiável e provavelmente será removida do WASI. As funções de relógio afetadas retornam para chamar @code{clock()}.

@item 
gh-115809@footnote{https://github.com/python/cpython/issues/115809}: Melhora o algoritmo para calcular quais arquivos de log revertidos devem ser excluídos em @code{logging.TimedRotatingFileHandler}. Agora é confiável para manipuladores sem @code{namer} e com @code{namer} determinístico arbitrário que deixa a parte de data e hora no nome do arquivo inalterada.

@item 
gh-74668@footnote{https://github.com/python/cpython/issues/74668}: As funções @ref{10a,,urllib.parse} @ref{27a,,parse_qs()} e @ref{279,,parse_qsl()} agora suportam argumentos de bytes contendo dados não ASCII brutos e codificados em porcentagem.

@item 
gh-67044@footnote{https://github.com/python/cpython/issues/67044}: @ref{487,,csv.writer()} agora sempre coloca aspas ou escapa @code{'\r'} e @code{'\n'}, independentemente do valor `lineterminator'.

@item 
gh-115712@footnote{https://github.com/python/cpython/issues/115712}: Restaura o suporte do delimitador de espaço com @code{skipinitialspace=True} em @ref{29,,csv}. @ref{487,,csv.writer()} agora coloca aspas em campos vazios se o delimitador for um espaço e skipinitialspace for true e levanta uma exceção se aspas não forem possíveis.

@item 
gh-112364@footnote{https://github.com/python/cpython/issues/112364}: Corrigido @ref{8eb,,ast.unparse()} para manipular format_spec com @code{"}, @code{'} ou @code{\\}. Corrigido por Frank Hoffmann.

@item 
gh-112997@footnote{https://github.com/python/cpython/issues/112997}: Para de registrar argumentos de retorno de chamada potencialmente sensíveis em @ref{a,,asyncio} a menos que o modo de depuração esteja ativo.

@item 
gh-114914@footnote{https://github.com/python/cpython/issues/114914}: Corrige um problema em que um @code{StreamWriter} abandonado não seria coletado como lixo.

@item 
gh-111358@footnote{https://github.com/python/cpython/issues/111358}: Corrige um bug em @code{asyncio.BaseEventLoop.shutdown_default_executor()} para garantir que o tempo limite passado para a corrotina se comporte conforme o esperado.

@item 
gh-115618@footnote{https://github.com/python/cpython/issues/115618}: Corrige a diminuição inadequada da contagem de referência para o argumento @code{None} em métodos @ref{194,,property} @ref{1750,,getter()}, @ref{1751,,setter()} e @ref{1752,,deleter()}.

@item 
gh-112720@footnote{https://github.com/python/cpython/issues/112720}: Refatora @code{dis.ArgResolver} para tornar possível fazer subclasse e alterar a maneira como argumentos de salto são interpretados.

@item 
gh-112006@footnote{https://github.com/python/cpython/issues/112006}: Corrige @ref{f90,,inspect.unwrap()} para tipos com o descritor de dados @code{__wrapper__}. Corrige @ref{73a,,inspect.Signature.from_callable()} para embutido @ref{166,,classmethod()} e @ref{416,,staticmethod()}.

@item 
gh-101293@footnote{https://github.com/python/cpython/issues/101293}: Adiciona suporte a chamáveis com o método @code{__call__()} e tipos com métodos @code{__new__()} e @code{__init__()} definidos como métodos de classe, métodos estáticos, métodos vinculados, funções parciais e outros tipos de métodos e descritores em @ref{73a,,inspect.Signature.from_callable()}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Isola @code{_lsprof} (aplica a 
@geindex Propostas de Melhorias do Python; 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} não ignora mais funções globais implementadas como métodos embutidos, como @code{MethodDescriptorType} e @code{WrapperDescriptorType}.

@item 
gh-115256@footnote{https://github.com/python/cpython/issues/115256}: Adicionado DeprecationWarning ao acessar o atributo tarfile de objetos TarInfo. O atributo nunca é usado internamente e só é anexado ao TarInfos quando o tarfile é aberto no modo de gravação, não no modo de leitura. O atributo cria um ciclo de referência desnecessário que pode causar corrupção ao não fechar o identificador após gravar um tarfile.

@item 
gh-115197@footnote{https://github.com/python/cpython/issues/115197}: @code{urllib.request} não resolve mais o nome do host antes de verificá-lo em relação à lista de bypass de proxy do sistema no macOS e Windows.

@item 
gh-113812@footnote{https://github.com/python/cpython/issues/113812}: @code{DatagramTransport.sendto()} agora enviará datagramas de comprimento zero se for chamado com um objeto de bytes vazio. O controle de fluxo de transporte agora também considera o cabeçalho do datagrama ao calcular o tamanho do buffer.

@item 
gh-114763@footnote{https://github.com/python/cpython/issues/114763}: Protege os módulos carregados com @ref{ccd,,importlib.util.LazyLoader} de condições de corrida quando vários threads tentam acessar atributos antes que o carregamento seja concluído.

@item 
gh-114709@footnote{https://github.com/python/cpython/issues/114709}: @code{posixpath.commonpath()} agora levanta uma exceção @ref{202,,ValueError} quando passado um iterável vazio. Anteriormente, @ref{157e,,IndexError} era levantada.

@code{posixpath.commonpath()} agora levanta uma exceção @ref{2c3,,TypeError} quando passado @code{None}. Anteriormente, @ref{202,,ValueError} era levantada.

@item 
gh-114610@footnote{https://github.com/python/cpython/issues/114610}: Corrige bug onde @ref{1753,,pathlib.PurePath.with_stem()} convertia um sufixo de caminho não vazio em um radical quando recebia um argumento `stem' vazio. Agora levanta @ref{202,,ValueError}, assim como @ref{1703,,pathlib.PurePath.with_suffix()} faz quando chamado em um caminho com um radical vazio, dado um argumento `suffix' não vazio.

@item 
gh-107361@footnote{https://github.com/python/cpython/issues/107361}: Adiciona @ref{156,,ssl.VERIFY_X509_PARTIAL_CHAIN} e @code{VERIFY_X509_STRICT} ao contexto SSL padrão criado com @ref{155,,ssl.create_default_context()}.

@item 
gh-112281@footnote{https://github.com/python/cpython/issues/112281}: Permite a criação de @ref{7c3,,união de tipos} para @ref{944,,typing.Annotated} com metadados não-estruturáveis.

@item 
gh-111775@footnote{https://github.com/python/cpython/issues/111775}: Corrige @code{importlib.resources.simple.ResourceHandle.open()} para modo texto, adicionado argumento @code{stream} ausente.

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: Faz .pdbrc e -c funcionarem com quaisquer comandos pdb válidos.

@item 
gh-107625@footnote{https://github.com/python/cpython/issues/107625}: Levanta @ref{505,,configparser.ParsingError} dos métodos @ref{14b0,,read()} e @ref{506,,read_file()} de @ref{1c8,,configparser.ConfigParser} se uma chave sem um valor correspondente for continuada (isto é, seguida por uma linha indentada).

@item 
gh-107155@footnote{https://github.com/python/cpython/issues/107155}: Corrige saída incorreta de @code{help(x)} onde @code{x} é uma função @ref{12df,,lambda}, que tem um atributo de dicionário @code{__annotations__} com uma chave @code{"return"}.

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: Adiciona opção para comparações `não rasas' para @ref{f73,,filecmp.dircmp} como @ref{1754,,filecmp.cmp()}. Patch original por Steven Ward. Aprimorado por Tobias Rautenkranz

@item 
gh-69990@footnote{https://github.com/python/cpython/issues/69990}: @code{Profile.print_stats()} foi melhorado para aceitar vários argumentos de classificação. Correção por Chiu-Hsiang Hsu e Furkan Onder.

@item 
gh-104061@footnote{https://github.com/python/cpython/issues/104061}: Adiciona constante @code{socket.SO_BINDTOIFINDEX}.

@item 
gh-60346@footnote{https://github.com/python/cpython/issues/60346}: Corrige ArgumentParser inconsistente com parse_known_args.

@item 
gh-102389@footnote{https://github.com/python/cpython/issues/102389}: Adiciona @code{windows_31j} aos apelidos para o codec @code{cp932}

@item 
gh-72249@footnote{https://github.com/python/cpython/issues/72249}: Always include the @ref{1755,,module} name in the @ref{800,,repr()} of
@ref{414,,functools.partial()} objects.  Patch by Furkan Onder and Anilyka
Barry.

@item 
gh-100985@footnote{https://github.com/python/cpython/issues/100985}: Atualiza HTTPSConnection para encapsular consistentemente endereços IPv6 ao usar um proxy.

@item 
gh-100884@footnote{https://github.com/python/cpython/issues/100884}: email: corrige dobramento incorreto de vírgula em listas de endereços em várias linhas em combinação com codificação unicode.

@item 
gh-95782@footnote{https://github.com/python/cpython/issues/95782}: Corrige @code{io.BufferedReader.tell()}, @code{io.BufferedReader.seek()}, @code{_pyio.BufferedReader.tell()}, @code{io.BufferedRandom.tell()}, @code{io.BufferedRandom.seek()} e @code{_pyio.BufferedRandom.tell()} sendo capazes de retornar deslocamentos negativos.

@item 
gh-96310@footnote{https://github.com/python/cpython/issues/96310}: Corrige um traceback em @ref{6,,argparse} quando todas as opções em um grupo mutuamente exclusivo são suprimidas.

@item 
gh-93205@footnote{https://github.com/python/cpython/issues/93205}: Corrige um bug em @ref{f95,,logging.handlers.TimedRotatingFileHandler} onde várias instâncias de manipulador rotativo apontando para arquivos com o mesmo nome, mas extensões diferentes, entrariam em conflito e não excluiriam os arquivos corretos.

@item 
bpo-31116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31116}: Adiciona codificação Z85 a @code{base64}.

@item 
bpo-44865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44865}: Adiciona chamada ausente para função de localização em @ref{6,,argparse}.

@item 
bpo-43952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43952}: Corrige @ref{1756,,multiprocessing.connection.Listener.accept()} para aceitar bytes vazios como authkey. Não aceitar bytes vazios como chave faz com que ele trave indefinidamente.

@item 
bpo-42125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42125}: linecache: obtém nome do módulo de @code{__spec__} se disponível. Isso permite obter código-fonte para o módulo @code{__main__} quando um carregador personalizado é usado.

@item 
bpo-41122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41122}: Não passar argumentos corretamente para @ref{9f8,,functools.singledispatchmethod()} agora levanta um TypeError em vez de atingir um índice fora dos limites internamente.

@item 
bpo-40818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40818}: O asyncio REPL agora executa @ref{ffd,,sys.__interactivehook__} na inicialização. A implementação padrão de @ref{ffd,,sys.__interactivehook__} fornece preenchimento automático para o asyncio REPL. O patch é uma contribuição por Rémi Lapeyre.

@item 
bpo-33775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33775}: Adiciona o texto de ajuda ‘default’ e ‘version’ para localização no argparse.
@end itemize

@node Documentação<13>,Testes<16>,Biblioteca<34>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id165}@anchor{1757}
@subsubsection Documentação



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: Documenta 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425} do Expat <2.6.0 em “Vulnerabilidades em XML”.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Melhora o tempo de importação de @ref{110,,uuid} no Linux.
@end itemize

@node Testes<16>,Construção<16>,Documentação<13>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id166}@anchor{1758}
@subsubsection Testes



@itemize -

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Adiciona exclusões de teste para dar suporte à execução do conjunto de testes no Android.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Habilita @code{test_concurrent_futures} em plataformas que oferecem suporte a threads, mas não multiprocessamento.

@item 
gh-115796@footnote{https://github.com/python/cpython/issues/115796}: Faz com que ‘_testinternalcapi.assemble_code_object’ construa a tabela de exceções para o objeto de código.

@item 
gh-115720@footnote{https://github.com/python/cpython/issues/115720}: Testes de vazamento (@code{-R}, @code{--huntrleaks}) agora mostram um resumo do número de vazamentos encontrados em cada iteração.

@item 
gh-115122@footnote{https://github.com/python/cpython/issues/115122}: Adiciona a opção @code{--bisect} ao executor de teste regrtest: execute testes com falha com @code{test.bisect_cmd} para identificar testes com falha. Patch por Victor Stinner.

@item 
gh-115596@footnote{https://github.com/python/cpython/issues/115596}: Corrige @code{ProgramPriorityTests} em @code{test_os} alterando permanentemente a prioridade do processo.

@item 
gh-115556@footnote{https://github.com/python/cpython/issues/115556}: No Windows, vírgulas passadas em argumentos para @code{Tools\buildbot\test.bat} e @code{PCbuild\\rt.bat} agora são manipuladas corretamente.

@item 
gh-115420@footnote{https://github.com/python/cpython/issues/115420}: Corrige tradução de alvos de manipuladores de exceção por @code{_testinternalcapi.optimize_cfg}.

@item 
gh-115376@footnote{https://github.com/python/cpython/issues/115376}: Corrige falha de segmentação em @code{_testinternalcapi.compiler_codegen} em entrada incorreta.
@end itemize

@node Construção<16>,Windows<14>,Testes<16>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id167}@anchor{1759}
@subsubsection Construção



@itemize -

@item 
gh-116313@footnote{https://github.com/python/cpython/issues/116313}: Faz com que construções WASI funcionem no wasmtime 18 com primitivos WASI 0.2/preview2.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Altera @ref{a97,,sys.platform} do Android de @code{"linux"} para @code{"android"}.

@item 
gh-116117@footnote{https://github.com/python/cpython/issues/116117}: Faz backport da PR #42 da @code{libb2} para corrigir a compilação do CPython no Windows de 32 bits com @code{clang-cl}.

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: Corrige vários problemas de construção do Android

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Um projeto de testbed foi adicionado para executar o conjunto de testes no iOS.

@item 
gh-115350@footnote{https://github.com/python/cpython/issues/115350}: Corrige o módulo de construção ctypes com -DWIN32_LEAN_AND_MEAN definido

@item 
gh-111225@footnote{https://github.com/python/cpython/issues/111225}: Vincula módulos de extensão ao libpython no Android.

@item 
gh-115737@footnote{https://github.com/python/cpython/issues/115737}: O nome de instalação do libPython agora está definido corretamente para compilações macOS sem framework.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Os alvos do Makefile foram adicionados para oferecer suporte à compilação de uma construção de framework compatível com iOS.
@end itemize

@node Windows<14>,macOS<9>,Construção<16>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id168}@anchor{175a}
@subsubsection Windows



@itemize -

@item 
gh-116012@footnote{https://github.com/python/cpython/issues/116012}: Garante que o valor de @code{GetLastError()} seja preservado em todas as operações com a GIL.

@item 
gh-115582@footnote{https://github.com/python/cpython/issues/115582}: Construir extensões destinadas a construções com threads livres do CPython agora exigem a compilação manual com @code{/DPy_GIL_DISABLED} ao usar uma instalação regular. Espera-se que isso mude em versões futuras.

@item 
gh-115554@footnote{https://github.com/python/cpython/issues/115554}: O instalador agora tem regras mais rígidas sobre a atualização do @ref{5be,,Inicializador Python para Windows}. Em geral, a maioria dos usuários tem apenas um único iniciador instalado e não verá nenhuma diferença. Quando vários iniciadores foram instalados, a opção de instalar o iniciador é desabilitada até que todos, exceto um, tenham sido removidos. O downgrade do iniciador (que nunca foi permitido) agora é mais obviamente bloqueado.

@item 
gh-115543@footnote{https://github.com/python/cpython/issues/115543}: @ref{5be,,Inicializador Python para Windows} agora pode detectar o Python 3.13 quando instalado da Microsoft Store e instalará o Python 3.12 por padrão quando 
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex variável de ambiente; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} estiver definido.
@end itemize

@node macOS<9>,IDLE<13>,Windows<14>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id169}@anchor{175b}
@subsubsection macOS



@itemize -

@item 
gh-116145@footnote{https://github.com/python/cpython/issues/116145}: Atualiza instalador do macOS para Tcl/Tk 8.6.14.
@end itemize

@node IDLE<13>,Ferramentas/Demos<9>,macOS<9>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id170}@anchor{175c}
@subsubsection IDLE



@itemize -

@item 
gh-88516@footnote{https://github.com/python/cpython/issues/88516}: No macOS, mostra um ícone de proxy na barra de título das janelas do editor para corresponder ao comportamento da plataforma.
@end itemize

@node Ferramentas/Demos<9>,API C<17>,IDLE<13>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id171}@anchor{175d}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-100176@footnote{https://github.com/python/cpython/issues/100176}: Remove Tools/@{io,cc,string@}bench desatualizado

@item 
bpo-45101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45101}: Adiciona consistência na mensagem de uso de E/S entre 2 versões do python-config.
@end itemize

@node API C<17>,,Ferramentas/Demos<9>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id172}@anchor{175e}
@subsubsection API C



@itemize -

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: Adiciona novamente o nome @code{_PyCFunctionFastWithKeywords}, removido no Python 3.13 alpha 4 por engano. Manter o antigo nome privado @code{_PyCFunctionFastWithKeywords} (Python 3.7) como um apelido para o novo nome público @code{PyCFunctionFastWithKeywords} (Python 3.13a4). Patch por Victor Stinner.

@item 
gh-111418@footnote{https://github.com/python/cpython/issues/111418}: Adiciona as macros C @ref{175f,,PyHASH_MODULUS}, @ref{1760,,PyHASH_BITS}, @ref{1761,,PyHASH_INF} e @ref{1762,,PyHASH_IMAG}. Patch por Sergey B Kirpichev.
@end itemize

@node Python 3 13 0 alpha 4,Python 3 13 0 alpha 3,Python 3 13 0 alpha 5,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-4}@anchor{1763}
@subsection Python 3.13.0 alpha 4


`Data de lançamento: 2024-02-15'

@menu
* Segurança: Segurança<15>. 
* Núcleo e embutidos: Núcleo e embutidos<31>. 
* Biblioteca: Biblioteca<35>. 
* Documentação: Documentação<14>. 
* Testes: Testes<17>. 
* Construção: Construção<17>. 
* Windows: Windows<15>. 
* macOS: macOS<10>. 
* IDLE: IDLE<14>. 
* Ferramentas/Demos: Ferramentas/Demos<10>. 
* API C: API C<18>. 

@end menu

@node Segurança<15>,Núcleo e embutidos<31>,,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id173}@anchor{1764}
@subsubsection Segurança



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: Atualiza libexpat empacotado para 2.6.0

@item 
gh-115243@footnote{https://github.com/python/cpython/issues/115243}: Corrige possíveis travamentos em @ref{dfa,,collections.deque.index()} quando o deque é modificado simultaneamente.
@end itemize

@node Núcleo e embutidos<31>,Biblioteca<35>,Segurança<15>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id174}@anchor{1765}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: Para um iterador reverso vazio for, lista será reduzida para @ref{869,,reversed()}. Patch por Donghee Na

@item 
gh-114570@footnote{https://github.com/python/cpython/issues/114570}: Adiciona exceção @ref{14d,,PythonFinalizationError}. Esta exceção derivada de @ref{195,,RuntimeError} é levantada quando uma operação é bloqueada durante a @ref{14e,,finalização do Python}. Patch por Victor Stinner.

@item 
gh-114695@footnote{https://github.com/python/cpython/issues/114695}: Adiciona @ref{1766,,sys._clear_internal_caches()}, que limpa todos os caches internos relacionados ao desempenho (e descontinua a função menos geral @ref{1767,,sys._clear_type_cache()}).

@item 
gh-114828@footnote{https://github.com/python/cpython/issues/114828}: Corrige travamentos de compilação em exemplos de código incomuns usando @ref{4db,,super()} dentro de uma compreensão em um corpo de classe.

@item 
gh-112069@footnote{https://github.com/python/cpython/issues/112069}: Adapta os métodos @ref{5d9,,set} e @ref{5da,,frozenset} para Argument Clinic.

@item 
gh-115011@footnote{https://github.com/python/cpython/issues/115011}: Setters para membros com um tipo inteiro sem sinal agora oferecem suporte ao mesmo intervalo de valores válidos para objetos que têm um método @ref{71d,,__index__()} como para @ref{257,,int}.

@item 
gh-114887@footnote{https://github.com/python/cpython/issues/114887}: Alterada a validação do tipo de soquete em @ref{733,,create_datagram_endpoint()} para aceitar todos os soquetes não-stream. Isso corrige uma regressão na compatibilidade com soquetes brutos.

@item 
gh-114944@footnote{https://github.com/python/cpython/issues/114944}: Corrige uma corrida entre @code{PyParkingLot_Park} e @code{_PyParkingLot_UnparkAll}.

@item 
gh-113462@footnote{https://github.com/python/cpython/issues/113462}: Limita o número de versões que uma única classe pode usar. Impede que algumas classes rebeldes usem todos os números de versão.

@item 
gh-76763@footnote{https://github.com/python/cpython/issues/76763}: A função embutido @ref{1768,,chr()} agora sempre levanta @ref{202,,ValueError} para valores fora do intervalo válido. Anteriormente, levantava @ref{885,,OverflowError} para valores muito grandes ou pequenos.

@item 
gh-114806@footnote{https://github.com/python/cpython/issues/114806}: Não especializa mais chamadas para classes, se essas classes tiverem metaclasses. Corrige bug onde o método @code{__call__} da metaclasse não estava sendo chamado.

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: Melhora mensagem de erro para chamadas de função com argumentos nomeados inválidos via getargs

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: A construção com threads livres não aloca mais espaço para a estrutura @code{PyGC_Head} em objetos que oferecem suporte a coleta de lixo cíclica. Vários outros campos e estruturas de dados são usados como substituições, incluindo @code{ob_gc_bits}, @code{ob_tid} e estruturas de dados internas mimalloc.

@item 
gh-114456@footnote{https://github.com/python/cpython/issues/114456}: Reduz o limite de recursão em uma construção de depuração do WASI.

@item 
gh-114083@footnote{https://github.com/python/cpython/issues/114083}: O compilador aplica o dobramento de LOAD_CONST com a instrução a seguir em uma passagem separada antes de outras otimizações. Isso permite o jump threading em certas circunstâncias.

@item 
gh-114388@footnote{https://github.com/python/cpython/issues/114388}: Corrige um @ref{1bd,,RuntimeWarning} emitido ao atribuir um valor inteiro que não é uma instância de @ref{257,,int} a um atributo que corresponde a um membro struct C de @ref{1769,,type} T_UINT e T_ULONG. Corrige um @ref{1bd,,RuntimeWarning} duplo emitido ao atribuir um valor inteiro negativo a um atributo que corresponde a um membro struct C do tipo T_UINT.

@item 
gh-114265@footnote{https://github.com/python/cpython/issues/114265}: O compilador propaga números de linha antes da otimização, levando a mais oportunidades de otimização e removendo a necessidade do hack @code{guarantee_lineno_for_exits}.

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: A construção com threads livres agora tem sua própria implementação de GC segura para thread que usa mimalloc para encontrar objetos rastreados por GC. Não é geracional, diferente da implementação GC existente.

@item 
gh-114050@footnote{https://github.com/python/cpython/issues/114050}: Corrige falha de segmentação causada por uma string de formato incorreta na exceção @code{TypeError} quando mais de dois argumentos são passados para @code{int}.

@item 
gh-112354@footnote{https://github.com/python/cpython/issues/112354}: A instrução @code{END_FOR} agora exibe apenas um valor. Isso é para oferecer melhor suporte a saídas laterais em laços.

@item 
gh-113884@footnote{https://github.com/python/cpython/issues/113884}: Torna @ref{b80,,queue.SimpleQueue} segura para thread quando a GIL estiver desabilitada.

@item 
gh-114058@footnote{https://github.com/python/cpython/issues/114058}: Implementa as bases do eliminador de redundância de Nível 2.

@item 
gh-113939@footnote{https://github.com/python/cpython/issues/113939}: frame.clear(): Limpa frame.f_locals também, e não apenas os locals rápidos. Isso é relevante quando frame.f_locals foi acessado, o que também conteria referências a todos os locais.

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: Converte @ref{5dc,,collections.deque} para usar Argument Clinic.

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: Torna os métodos em @ref{5dc,,collections.deque} seguros para thread quando a GIL estiver desabilitada.

@item 
gh-113464@footnote{https://github.com/python/cpython/issues/113464}: Adiciona uma opção (@code{--enable-experimental-jit} para construções baseadas em @code{configure} ou @code{--experimental-jit} para construções baseadas em @code{PCbuild}) para construir um compilador `experimental' just-in-time, baseado em copy-and-patch@footnote{https://fredrikbk.com/publications/copy-and-patch.pdf}

@item 
gh-113055@footnote{https://github.com/python/cpython/issues/113055}: Torna interp->obmalloc um ponteiro. Para interpretadores que compartilham estado com o interpretador principal, isso aponta para a mesma estrutura de memória estática. Para interpretadores com seu próprio estado obmalloc, ele é alocado em heap. Adiciona free_obmalloc_arenas() que liberará as arenas obmalloc e as estruturas de árvore radix para interpretadores com seu próprio estado obmalloc.

@item 
gh-55664@footnote{https://github.com/python/cpython/issues/55664}: Adiciona um aviso ao criar @ref{d6b,,type} usando um dicionário de espaço de nomes com chaves não string. Patch por Daniel Urban e Furkan Onder.

@item 
gh-104530@footnote{https://github.com/python/cpython/issues/104530}: Usa variáveis de condição nativas do Win32.
@end itemize

@node Biblioteca<35>,Documentação<14>,Núcleo e embutidos<31>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id175}@anchor{176a}
@subsubsection Biblioteca



@itemize -

@item 
gh-115392@footnote{https://github.com/python/cpython/issues/115392}: Corrige um bug em @ref{3a,,doctest} onde números de linha incorretos seriam relatados para funções decoradas.

@item 
gh-114563@footnote{https://github.com/python/cpython/issues/114563}: Corrige vários bugs de @ref{61f,,format()} ao usar a implementação C de @ref{29d,,Decimal}: * vazamento de memória em alguns casos raros ao usar a opção de formato @code{z} (coagir negativo 0) * saída incorreta ao aplicar a opção de formato @code{z} ao tipo @code{F} (ponto fixo com @code{NAN} maiúsculo / @code{INF}) * saída incorreta ao aplicar a opção de formato @code{#} (formato alternativo)

@item 
gh-102840@footnote{https://github.com/python/cpython/issues/102840}: Corrige traceback confuso quando as operações floordiv, mod ou divmod acontecem entre instâncias de @ref{1e7,,fractions.Fraction} e @ref{2f8,,complex}.

@item 
gh-115165@footnote{https://github.com/python/cpython/issues/115165}: A maioria das exceções agora são ignoradas ao tentar definir o atributo @code{__orig_class__} em objetos retornados ao chamar apelidos genéricos @ref{104,,typing} (incluindo aliases genéricos criados usando @ref{944,,typing.Annotated}). Anteriormente, apenas @ref{34b,,AttributeError} era ignorada. Patch por Dave Shawley.

@item 
gh-112903@footnote{https://github.com/python/cpython/issues/112903}: Corrige erros de “issubclass() arg 1 must be a class” em certos casos de herança múltipla com aliases genéricos (regressão nas primeiras versões alfa 3.13).

@item 
gh-115133@footnote{https://github.com/python/cpython/issues/115133}: Corrige testes para @ref{1029,,XMLPullParser} com Expat 2.6.0.

@item 
gh-115059@footnote{https://github.com/python/cpython/issues/115059}: @code{io.BufferedRandom.read1()} agora limpa o buffer de gravação subjacente.

@item 
gh-79382@footnote{https://github.com/python/cpython/issues/79382}: @code{**} no final não permite mais corresponder arquivos e caminhos não existentes em @ref{29f,,glob()} recursivo.

@item 
gh-67837@footnote{https://github.com/python/cpython/issues/67837}: Evita condições de corrida na criação de diretórios durante a extração simultânea em @ref{de,,tarfile} e @ref{131,,zipfile}.

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: Acelera @ref{22d,,pathlib.Path.glob()} removendo a correspondência de regex redundante.

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: Reverte parcialmente o comportamento de @code{tkinter.Text.count()}. Por padrão, ele preserva o comportamento de versões mais antigas do Python, exceto que definir @code{wantobjects} como 0 não tem mais efeito. Adiciona um novo parâmetro `return_ints': especificar @code{return_ints=True} faz com que @code{Text.count()} sempre retorna a contagem única como um inteiro em vez de uma tupla de 1 elemento ou @code{None}.

@item 
gh-114628@footnote{https://github.com/python/cpython/issues/114628}: Quando csv.Error é levantada ao manipular TypeError, não exibir o traceback de TypeError.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Adicionado @code{_POSIX_VDISABLE} de @code{<unistd.h>} de C para @ref{e1,,termios}.

@item 
gh-114965@footnote{https://github.com/python/cpython/issues/114965}: Atualiza pip empacotado para 24.0

@item 
gh-114959@footnote{https://github.com/python/cpython/issues/114959}: @ref{de,,tarfile} não ignora mais erros ao tentar extrair um diretório em cima de um arquivo.

@item 
gh-114894@footnote{https://github.com/python/cpython/issues/114894}: Adiciona @ref{1a2,,array.array.clear()}.

@item 
gh-114071@footnote{https://github.com/python/cpython/issues/114071}: Suporte a subclasses de tupla usando auto() para valor de membro enum.

@item 
gh-109475@footnote{https://github.com/python/cpython/issues/109475}: Corrige suporte ao valor de opção explícito “–” em @ref{6,,argparse} (por exemplo, @code{--option=--}).

@item 
gh-49766@footnote{https://github.com/python/cpython/issues/49766}: Corrige comparação @ref{1cd,,date}-@ref{1cc,,datetime}. Agora, os métodos de comparação especiais como @code{__eq__} e @code{__lt__} retornam @ref{7d3,,NotImplemented} se um dos comparandos for @code{date} e o outro for @code{datetime} em vez de ignorar a parte do tempo e o fuso horário ou retornar forçadamente “não igual” ou levantar @ref{2c3,,TypeError}. Ele torna a comparação das subclasses @code{date} e @code{datetime} mais simétrica e permite alterar o comportamento padrão substituindo os métodos de comparação especiais em subclasses.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Corrige estruturas ctypes com vetor na plataforma Windows ARM64 definindo @code{MAX_STRUCT_SIZE} como 32 em stgdict. Patch por Diego Russo

@item 
gh-114678@footnote{https://github.com/python/cpython/issues/114678}: Garante que o aviso de descontinuação para o especificador ‘N’ no formato @ref{29d,,Decimal} não seja levantada para casos em que ‘N’ aparece em outros lugares no especificador de formato. Baseado no patch por Stefan Krah.

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: Retorna arquivos e diretórios de @ref{22d,,pathlib.Path.glob()} se um padrão termina com “@code{**}”. Anteriormente, apenas diretórios eram retornados.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Melhora o tempo de importação de @ref{7a,,importlib.metadata} e @ref{50,,email.utils}.

@item 
gh-113280@footnote{https://github.com/python/cpython/issues/113280}: Corrige um vazamento de soquete aberto em casos raros quando ocorria um erro na criação de @ref{8f0,,ssl.SSLSocket}.

@item 
gh-77749@footnote{https://github.com/python/cpython/issues/77749}: @ref{176b,,email.policy.EmailPolicy.fold()} agora sempre codifica caracteres não ASCII em cabeçalhos se @ref{e24,,utf8} for falso.

@item 
gh-83383@footnote{https://github.com/python/cpython/issues/83383}: A sincronização do banco de dados @ref{32,,dbm.dumb} agora é no-op se não houver modificação desde a abertura ou última sincronização. O arquivo de diretório para um banco de dados @ref{32,,dbm.dumb} vazio recém-criado agora é criado imediatamente após a abertura, em vez de adiar isso até a sincronização ou o fechamento.

@item 
gh-91602@footnote{https://github.com/python/cpython/issues/91602}: Adiciona o parâmetro somente-nomeado `filter' a @ref{247,,sqlite3.Connection.iterdump()} para filtrar objetos de banco de dados para despejar. Patch por Mariusz Felisiak.

@item 
gh-112451@footnote{https://github.com/python/cpython/issues/112451}: Proíbe criar subclasse de Python puro @ref{10fe,,datetime.timezone}. Isso é consistente com a implementação da extensão C. Patch por Mariusz Felisiak.

@item 
gh-69893@footnote{https://github.com/python/cpython/issues/69893}: Adiciona o método @code{close()} para o iterador retornado por @ref{273,,xml.etree.ElementTree.iterparse()}.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduz o tempo de importação do módulo @ref{ed,,threading} em ~50%. Patch por Daniel Hollas.

@item 
gh-114492@footnote{https://github.com/python/cpython/issues/114492}: Torna o resultado de @ref{176c,,termios.tcgetattr()} reproduzível no Alpine Linux. Anteriormente, ele poderia deixar um lixo aleatório em alguns campos.

@item 
gh-114315@footnote{https://github.com/python/cpython/issues/114315}: Torna @ref{176d,,threading.Lock} uma classe real, não uma função de fábrica. Adiciona @code{__new__} ao tipo @code{_thread.lock}.

@item 
gh-100414@footnote{https://github.com/python/cpython/issues/100414}: Adiciona @ref{35,,dbm.sqlite3} como um backend para @ref{31,,dbm}, e torna-o o novo backend padrão @code{dbm}. Patch por Raymond Hettinger e Erlend E. Aasland.

@item 
gh-113267@footnote{https://github.com/python/cpython/issues/113267}: Reverte alterações em gh-106584@footnote{https://github.com/python/cpython/issues/106584} que tornavam as chamadas dos métodos @code{TestResult} @code{startTest()} e @code{stopTest()} desbalanceadas.

@item 
gh-75128@footnote{https://github.com/python/cpython/issues/75128}: Ignora uma @ref{417,,OSError} em @code{asyncio.BaseEventLoop.create_server()} quando o IPv6 estiver disponível, mas a interface não puder realmente suportá-lo.

@item 
gh-114423@footnote{https://github.com/python/cpython/issues/114423}: As entradas @code{_DummyThread} em @code{threading._active} agora são removidas automaticamente quando o thread relacionado morre.

@item 
gh-114257@footnote{https://github.com/python/cpython/issues/114257}: Descarta o erro @code{FileNotFound} em @ref{d6c,,ctypes.util.find_library()} e retorna apenas @code{None} no Linux.

@item 
gh-114321@footnote{https://github.com/python/cpython/issues/114321}: Expõe mais constantes específicas da plataforma no módulo @ref{59,,fcntl} no Linux, macOS, FreeBSD e NetBSD.

@item 
gh-114328@footnote{https://github.com/python/cpython/issues/114328}: A @ref{176e,,tty.setcbreak()} e a nova @ref{176f,,tty.cfmakecbreak()} não limpam mais o sinalizador ICRLF de entrada do terminal. Isso corrige uma regressão introduzida na 3.12 que não correspondia mais a como os sistemas operacionais definem o modo cbreak em suas páginas de manual @code{stty(1)}.

@item 
gh-114281@footnote{https://github.com/python/cpython/issues/114281}: Remove dicas de tipo de @code{Lib/asyncio/staggered.py}. As anotações no projeto typeshed@footnote{https://github.com/python/typeshed} devem ser usadas em vez disso.

@item 
gh-101438@footnote{https://github.com/python/cpython/issues/101438}: Evite o ciclo de referência em ElementTree.iterparse. O iterador retornado por @code{ElementTree.iterparse} pode manter um descritor de arquivo. O ciclo de referência impedia a limpeza rápida do descritor de arquivo se o iterador retornado não estivesse esgotado.

@item 
gh-114198@footnote{https://github.com/python/cpython/issues/114198}: A assinatura para o método @code{__replace__} em @ref{2f,,dataclasses} agora tem o primeiro argumento chamado @code{self}, em vez de @code{obj}.

@item 
gh-104522@footnote{https://github.com/python/cpython/issues/104522}: @ref{417,,OSError} levantada ao executar um subprocesso agora tem apenas o atributo `filename' definido como `cwd' se o erro foi causado por uma tentativa malsucedida de alterar o diretório atual.

@item 
gh-114149@footnote{https://github.com/python/cpython/issues/114149}: Enum: manipula corretamente subclasses de tuplas em @code{__new__} personalizado.

@item 
gh-83648@footnote{https://github.com/python/cpython/issues/83648}: Suporta descontinuação de opções, argumentos posicionais e subcomandos em @ref{6,,argparse}.

@item 
gh-114087@footnote{https://github.com/python/cpython/issues/114087}: Acelera @code{dataclasses.asdict} em até 1,35x.

@item 
gh-109534@footnote{https://github.com/python/cpython/issues/109534}: Corrige um vazamento de referência em @code{asyncio.selector_events.BaseSelectorEventLoop} quando negociações SSL falham. Patch foi contribuição de Jamie Phan.

@item 
gh-79634@footnote{https://github.com/python/cpython/issues/79634}: Aceita @ref{2a0,,objetos caminho ou similares} como padrões em @ref{22d,,pathlib.Path.glob()} e @ref{22e,,rglob()}.

@item 
gh-112202@footnote{https://github.com/python/cpython/issues/112202}: Garante que uma chamada @ref{1770,,asyncio.Condition.notify()} não seja perdida se a @code{Task} despertada for cancelada simultaneamente ou encontrar qualquer outro erro.

@item 
gh-113951@footnote{https://github.com/python/cpython/issues/113951}: Corrige o comportamento dos métodos @code{tag_unbind()} das classes @code{tkinter.Text} e @code{tkinter.Canvas} com três argumentos. Anteriormente, @code{widget.tag_unbind(tag, sequence, funcid)} destruía a vinculação atual para `sequence', deixando `sequence' desvinculado, e excluía o comando `funcid'. Agora, ele remove apenas `funcid' da vinculação para `sequence', mantendo outros comandos, e exclui o comando `funcid'. Ele deixa `sequence' desvinculado somente se `funcid' foi o último comando vinculado.

@item 
gh-97959@footnote{https://github.com/python/cpython/issues/97959}: Corrige métodos de classe de renderização, métodos vinculados, métodos e apelidos de função em @ref{b5,,pydoc}. Métodos de classe não têm mais a nota “método de instância builtins.type”. Notas correspondentes agora são adicionadas para métodos de classe e não vinculados. Apelidos de método e função agora têm referências ao módulo ou à classe onde a origem foi definida se for diferente da atual. Métodos vinculados agora são listados na seção de métodos estáticos. Métodos de classes internas agora são suportados, bem como métodos de classes Python.

@item 
gh-113796@footnote{https://github.com/python/cpython/issues/113796}: Adiciona mais verificações de validação no construtor @ref{1771,,csv.Dialect}. @ref{202,,ValueError} agora é levantada se o mesmo caractere for usado em funções diferentes.

@item 
gh-113732@footnote{https://github.com/python/cpython/issues/113732}: Corrige suporte de @ref{484,,QUOTE_NOTNULL} e @ref{485,,QUOTE_STRINGS} em @ref{486,,csv.reader()}.

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: Acelera @ref{4a8,,pathlib.Path.walk()} usando @ref{1772,,os.DirEntry.path} onde possível.

@item 
gh-89039@footnote{https://github.com/python/cpython/issues/89039}: Quando o método replace() é chamado em uma subclasse de datetime, date ou time, chamar corretamente o construtor derivado. Anteriormente, apenas o construtor da classe base era chamado.

Além disso, certifica-se de passar valores de fold diferentes de zero ao criar subclasses em vários métodos. Anteriormente, fold era ignorado silenciosamente.

@item 
gh-112919@footnote{https://github.com/python/cpython/issues/112919}: Aceleração de @ref{1513,,datetime.datetime.replace()}, @ref{1773,,datetime.date.replace()} e @ref{1774,,datetime.time.replace()}.

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: Define o ponto de interrupção na primeira linha executável da função, em vez da linha de definição da função quando o usuário faz @code{break func} usando @ref{a5,,pdb}

@item 
gh-112343@footnote{https://github.com/python/cpython/issues/112343}: Melhora o tratamento de variáveis de conveniência pdb para evitar a substituição de conteúdo de string.

@item 
gh-112240@footnote{https://github.com/python/cpython/issues/112240}: Adiciona opção à CLI do módulo de calendar para especificar o dia da semana para começar cada semana. Patch por Steven Ward.

@item 
gh-111741@footnote{https://github.com/python/cpython/issues/111741}: Reconhece @code{image/webp} como um formato padrão no módulo @ref{8f,,mimetypes}.

@item 
gh-43457@footnote{https://github.com/python/cpython/issues/43457}: Corrige o método do widget @ref{f0,,tkinter} @code{wm_attributes()}. Agora ele aceita o nome do atributo sem o prefixo menos para obter atributos de janela e permite especificar atributos e valores para ser definido como argumentos nomeados. Adiciona um novo argumento nomeado opcional `return_python_dict': chamar @code{w.wm_attributes(return_python_dict=True)} retorna os atributos como um dict em vez de uma tupla. Chamar @code{w.wm_attributes()} agora retorna uma tupla em vez de uma string se `wantobjects' foi definido como 0.

@item 
gh-82626@footnote{https://github.com/python/cpython/issues/82626}: Muitas funções agora emitem um aviso se um valor booleano for passado como um argumento de descritor de arquivo.

@item 
gh-111051@footnote{https://github.com/python/cpython/issues/111051}: Adicionada verificação para modificação de arquivo durante a depuração com @ref{a5,,pdb}

@item 
gh-110345@footnote{https://github.com/python/cpython/issues/110345}: Mostra o patchlevel Tcl/Tk (em vez da versão) em @code{tkinter._test()}.

@item 
gh-38807@footnote{https://github.com/python/cpython/issues/38807}: Corrige a condição de corrida em @ref{fd,,trace}. Em vez de verificar se um diretório existe e criá-lo, chame diretamente @ref{21e,,os.makedirs()} com o kwarg @code{exist_ok=True}.

@item 
gh-75705@footnote{https://github.com/python/cpython/issues/75705}: Define o envelope unixfrom em @ref{1775,,mailbox.mbox} e @ref{1776,,mailbox.MMDF}.

@item 
gh-106233@footnote{https://github.com/python/cpython/issues/106233}: Corrige o stacklevel em @code{InvalidTZPathWarning} durante a importação do módulo @ref{134,,zoneinfo}.

@item 
gh-105102@footnote{https://github.com/python/cpython/issues/105102}: Permita que @ref{1777,,ctypes.Union} seja aninhado em @ref{1d4,,ctypes.Structure} quando o endianness do sistema for o oposto das classes.

@item 
gh-104282@footnote{https://github.com/python/cpython/issues/104282}: Corrige a desreferência de ponteiro nulo em @code{lzma._decode_filter_properties()} devido ao tratamento impróprio de filtros BCJ com propriedades de comprimento zero. Patch por Radislav Chugunov.

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: Adiciona terminação @ref{13db,,queue.Queue} com @ref{23a,,shutdown()}.

@item 
gh-101599@footnote{https://github.com/python/cpython/issues/101599}: Altera a formatação de opções de sinalizador argparse para remover redundância.

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: Adiciona funções pseudoterminais POSIX @ref{1778,,os.posix_openpt()}, @ref{1779,,os.grantpt()}, @ref{177a,,os.unlockpt()} e @ref{177b,,os.ptsname()}.

@item 
gh-102512@footnote{https://github.com/python/cpython/issues/102512}: Quando @ref{197,,os.fork()} é chamado de um thread estrangeiro (também conhecido como @code{_DummyThread}), o tipo do thread em um processo filho é alterado para @code{_MainThread}. Também alterou seu nome e status como daemon, agora pode ser unido.

@item 
gh-88569@footnote{https://github.com/python/cpython/issues/88569}: Adiciona @ref{223,,os.path.isreserved()}, que identifica nomes de caminho reservados como “NUL”, “AUX” e “CON”. Esta função está disponível somente no Windows.

Descontinua @ref{2a6,,pathlib.PurePath.is_reserved()}.

@item 
bpo-38364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38364}: As funções @code{inspect} @code{isgeneratorfunction}, @code{iscoroutinefunction}, @code{isasyncgenfunction} agora oferecem suporte a funções encapsuladas @code{functools.partialmethod} da mesma forma que oferecem suporte a @code{functools.partial}.
@end itemize

@node Documentação<14>,Testes<17>,Biblioteca<35>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id176}@anchor{177c}
@subsubsection Documentação



@itemize -

@item 
gh-115233@footnote{https://github.com/python/cpython/issues/115233}: Corrige um exemplo para @ref{1339,,LoggerAdapter} no Logging Cookbook.

@item 
gh-114123@footnote{https://github.com/python/cpython/issues/114123}: Move a docstring do módulo @ref{29,,csv} para o módulo @code{csv} em vez de reexportá-la do módulo interno @code{_csv} e remove @code{__doc__} de @code{csv.__all__}.

Move @code{csv.__version__} para o módulo @code{csv} em vez de reexportá-lo do módulo interno @code{_csv} e remove @code{__version__} de @code{csv.__all__}.
@end itemize

@node Testes<17>,Construção<17>,Documentação<14>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id177}@anchor{177d}
@subsubsection Testes



@itemize -

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: Adicionadas exclusões de teste necessárias para executar o conjunto de testes no iOS.

@item 
gh-105089@footnote{https://github.com/python/cpython/issues/105089}: Corrige o teste @code{test.test_zipfile.test_core.TestWithDirectory.test_create_directory_with_write} no AIX fazendo um AND bit a bit de 0xFFFF no modo , para que ele fique sincronizado com @code{zinfo.external_attr}
@end itemize

@node Construção<17>,Windows<15>,Testes<17>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id178}@anchor{177e}
@subsubsection Construção



@itemize -

@item 
gh-115167@footnote{https://github.com/python/cpython/issues/115167}: Evita incluir @code{vcruntime140_threads.dll} ao Python ao construir com o Visual Studio 2022 versão 17.8.

@item 
gh-113632@footnote{https://github.com/python/cpython/issues/113632}: Promove o WASI para uma plataforma de nível 2 e remove o Emscripten do nível 3 em configure.ac.

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: configure e Makefile foram refatorados para acomodar construções de framework em plataformas Apple diferentes do macOS.

@item 
gh-114875@footnote{https://github.com/python/cpython/issues/114875}: Adiciona @code{getgrent()} como um pré-requisito para construir o módulo @ref{66,,grp}.
@end itemize

@node Windows<15>,macOS<10>,Construção<17>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id179}@anchor{177f}
@subsubsection Windows



@itemize -

@item 
gh-115049@footnote{https://github.com/python/cpython/issues/115049}: Corrige a falha do iniciador @code{py.exe} quando executado como usuários sem perfis de usuário.

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Atualize o instalador do Windows para usar o SQLite 3.45.1.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Atualize a construção do Windows para usar o OpenSSL 3.0.13.

@item 
gh-111239@footnote{https://github.com/python/cpython/issues/111239}: Atualiza as construções do Windows para usar o zlib v1.3.1.

@item 
gh-100107@footnote{https://github.com/python/cpython/issues/100107}: O iniciador @code{py.exe} não tentará mais executar o redirecionador da Microsoft Store ao iniciar um script contendo um shebang @code{/usr/bin/env}

@item 
gh-112984@footnote{https://github.com/python/cpython/issues/112984}: Adiciona binários de threads livres ao instalador do Windows como um componente opcional.

@item 
gh-89240@footnote{https://github.com/python/cpython/issues/89240}: Permite que @ref{94,,multiprocessing} crie pools com mais de 62 processos.
@end itemize

@node macOS<10>,IDLE<14>,Windows<15>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id180}@anchor{1780}
@subsubsection macOS



@itemize -

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: Atualiza o instalador do macOS para usar o SQLite 3.45.1.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Atualiza o instalador do macOS para usar o OpenSSL 3.0.13.

@item 
gh-114490@footnote{https://github.com/python/cpython/issues/114490}: Adiciona suporte de ligação Mach-O para @ref{1781,,platform.architecture()}.

@item 
gh-87804@footnote{https://github.com/python/cpython/issues/87804}: No macOS, o resultado de @code{os.statvfs} e @code{os.fstatvfs} agora relata corretamente o tamanho de discos muito grandes, em versões anteriores o número relatado de blocos estava errado para discos com pelo menos 2**32 blocos.
@end itemize

@node IDLE<14>,Ferramentas/Demos<10>,macOS<10>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id181}@anchor{1782}
@subsubsection IDLE



@itemize -

@item 
gh-96905@footnote{https://github.com/python/cpython/issues/96905}: No código de idlelib, para de redefinir os tipos embutidos ‘dict’ e ‘object’.

@item 
gh-103820@footnote{https://github.com/python/cpython/issues/103820}: Revisa as ligações do IDLE para que os eventos do botão do mouse 4/5 em sistemas de janelas não X11 (por exemplo, Win32 e Aqua) não sejam confundidos com rolagem.
@end itemize

@node Ferramentas/Demos<10>,API C<18>,IDLE<14>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id182}@anchor{1783}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-113516@footnote{https://github.com/python/cpython/issues/113516}: Não define @code{LDSHARED} ao construir para WASI.

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: Atualiza fluxos de trabalho do GitHub CI para usar OpenSSL 3.0.13 e multissltests para usar 1.1.1w, 3.0.13, 3.1.5 e 3.2.1.

@item 
gh-115015@footnote{https://github.com/python/cpython/issues/115015}: Corrige um bug no Argument Clinic que gerava código incorreto para métodos sem parâmetros que usam a convenção de chamada @ref{1784,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}. Apenas a contagem de parâmetros posicionais foi verificada; qualquer argumento nomeado passado seria aceito silenciosamente.
@end itemize

@node API C<18>,,Ferramentas/Demos<10>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id183}@anchor{1785}
@subsubsection API C



@itemize -

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: Adiciona as funções @ref{361,,PyLong_AsNativeBytes()}, @ref{362,,PyLong_FromNativeBytes()} e @ref{363,,PyLong_FromUnsignedNativeBytes()}.

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: @ref{760,,PyBuffer_FillInfo()} agora levanta uma @ref{575,,SystemError} se chamada com @ref{1786,,PyBUF_READ} ou @ref{1787,,PyBUF_WRITE} como sinalizadores. Esses sinalizadores devem ser usados apenas com a API C @code{PyMemoryView_*}.

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: @ref{399,,PyObject_GetBuffer()} agora levanta uma @ref{575,,SystemError} se chamado com @ref{1786,,PyBUF_READ} ou @ref{1787,,PyBUF_WRITE} como sinalizadores. Esses sinalizadores devem ser usados somente com a API C @code{PyMemoryView_*}.

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: Adiciona os typedefs @code{PyCFunctionFast} e @code{PyCFunctionFastWithKeywords} (idênticos aos typedefs @code{_PyCFunctionFast} e @code{_PyCFunctionFastWithKeywords} existentes, apenas sem um prefixo @code{_} inicial).

@item 
gh-114329@footnote{https://github.com/python/cpython/issues/114329}: Adiciona @ref{359,,PyList_GetItemRef()}, que é semelhante a @ref{35a,,PyList_GetItem()}, mas retorna uma @ref{33d,,referência forte} em vez de uma @ref{33e,,referência emprestada}.

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: Adiciona a API C de PyTime:


@itemize *

@item 
Tipo @ref{32d,,PyTime_t}.

@item 
Constantes @ref{32e,,PyTime_MIN} e @ref{32f,,PyTime_MAX}.

@item 
Funções @ref{330,,PyTime_AsSecondsDouble()}, @ref{331,,PyTime_Monotonic()}, @ref{333,,PyTime_PerfCounter()} e @ref{335,,PyTime_Time()}.
@end itemize

Patch por Victor Stinner.

@item 
gh-112066@footnote{https://github.com/python/cpython/issues/112066}: Adiciona @ref{33f,,PyDict_SetDefaultRef()}: insere uma chave e um valor em um dicionário se a chave ainda não estiver presente. Isto é similar a @ref{10b2,,dict.setdefault()}, mas retorna um valor inteiro indicando se a chave já estava presente. Também é similar a @ref{340,,PyDict_SetDefault()}, mas retorna uma referência forte em vez de uma referência emprestada.
@end itemize

@node Python 3 13 0 alpha 3,Python 3 13 0 alpha 2,Python 3 13 0 alpha 4,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-3}@anchor{1788}
@subsection Python 3.13.0 alpha 3


`Data de lançamento: 2024-01-17'

@menu
* Segurança: Segurança<16>. 
* Núcleo e embutidos: Núcleo e embutidos<32>. 
* Biblioteca: Biblioteca<36>. 
* Documentação: Documentação<15>. 
* Testes: Testes<18>. 
* Construção: Construção<18>. 
* Windows: Windows<16>. 
* macOS: macOS<11>. 
* IDLE: IDLE<15>. 
* API C: API C<19>. 

@end menu

@node Segurança<16>,Núcleo e embutidos<32>,,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id184}@anchor{1789}
@subsubsection Segurança



@itemize -

@item 
gh-113659@footnote{https://github.com/python/cpython/issues/113659}: Pula arquivos @code{.pth} com nomes começando com um ponto ou atributo de arquivo oculto.

@item 
gh-112302@footnote{https://github.com/python/cpython/issues/112302}: Criado um documento de lista de materiais de software e ferramentas para rastrear dependências.
@end itemize

@node Núcleo e embutidos<32>,Biblioteca<36>,Segurança<16>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id185}@anchor{178a}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: O compilador duplica blocos básicos que têm uma verificação de quebra de avaliação, nenhum número de linha e vários predecessores.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Um salto que deixa um manipulador de exceção de volta ao código normal não verifica mais o quebra de avaliação.

@item 
gh-113655@footnote{https://github.com/python/cpython/issues/113655}: Define o limite de recursão C para 4000 no Windows e 10000 no Linux/OSX. Isso parece estar perto do ponto ideal para manter a segurança, mas não comprometer a retrocompatibilidade.

@item 
gh-113710@footnote{https://github.com/python/cpython/issues/113710}: Adiciona efeitos de pilha digitados ao DSL do interpretador, junto com várias anotações de instruções.

@item 
gh-77046@footnote{https://github.com/python/cpython/issues/77046}: No Windows, os descritores de arquivo que envolvem identificadores do Windows agora são criados não herdáveis por padrão (
@geindex Propostas de Melhorias do Python; PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}). Patch por Zackery Spytz e Victor Stinner.

@item 
gh-113853@footnote{https://github.com/python/cpython/issues/113853}: Garante que todos os executores progridam. Isso garante que a execução de nível 2 sempre progrida.

@item 
gh-113753@footnote{https://github.com/python/cpython/issues/113753}: Corrige um problema em que o finalizador de objetos @code{PyAsyncGenASend} pode não ser chamado se eles forem alocados de uma lista livre.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Compilador alterado para que saltos sintéticos que não estejam no final do laço não verifiquem mais o disjuntor de avaliação.

@item 
gh-113703@footnote{https://github.com/python/cpython/issues/113703}: Corrige uma regressão no módulo @ref{1c,,codeop} que estava fazendo com que ele identificasse incorretamente f-strings incompletas. Patch por Pablo Galindo

@item 
gh-89811@footnote{https://github.com/python/cpython/issues/89811}: Verifica se há uma @code{tp_version_tag} válida antes de executar especializações de bytecode que dependem desse valor ser utilizável.

@item 
gh-111488@footnote{https://github.com/python/cpython/issues/111488}: Mensagem de erro alterada em caso de nenhuma palavra reservada ‘in’ após ‘for’ em compreensões de lista

@item 
gh-113657@footnote{https://github.com/python/cpython/issues/113657}: Corrige um problema que fazia com que atualizações importantes de ponteiros de instruções fossem otimizadas fora dos rastreamentos de nível dois.

@item 
gh-113603@footnote{https://github.com/python/cpython/issues/113603}: Corrige um bug em que um NOP redundante não é removido, causando falha em uma asserção no compilador no modo de depuração.

@item 
gh-113602@footnote{https://github.com/python/cpython/issues/113602}: Corrige um erro que fazia com que o analisador sintático tentasse sobrescrever erros existentes e travasse no processo. Patch por Pablo Galindo

@item 
gh-113486@footnote{https://github.com/python/cpython/issues/113486}: Não emite mais eventos @code{PY_UNWIND} espúrios para chamadas otimizadas para classes.

@item 
gh-113297@footnote{https://github.com/python/cpython/issues/113297}: Corrige falha de segmentação no compilador na instrução with com 19 gerenciadores de contexto.

@item 
gh-113212@footnote{https://github.com/python/cpython/issues/113212}: Melhora as mensagens de erro de @ref{4db,,super}.

@item 
gh-111375@footnote{https://github.com/python/cpython/issues/111375}: Usa somente @code{NULL} na pilha de exceções para indicar que uma exceção foi tratada. Patch por Carey Metcalfe.

@item 
gh-112215@footnote{https://github.com/python/cpython/issues/112215}: Aumenta o limite de recursão C por um fator de 3 para compilações não depuradas, exceto para plataformas webassembly e s390 que não foram alteradas. Isso atenua algumas regressões no 3.12 com recursão profunda misturando código interno (C) e Python.

@item 
gh-113054@footnote{https://github.com/python/cpython/issues/113054}: Corrigido bug onde um NOP redundante não é removido, causando falha em uma asserção no compilador no modo de depuração.

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: Usa o estado por analisador sintático AST em vez do estado global para rastrear a profundidade da recursão dentro do analisador sintático AST para evitar uma possível condição de corrida devido à análise simultânea.

O problema apareceu principalmente na versão 3.11 por usuários multithread de @ref{1a8,,ast.parse()}. Na versão 3.12, uma alteração em quando a coleta de lixo pode ser acionada impediu que a condição de corrida ocorresse.

@item 
gh-108866@footnote{https://github.com/python/cpython/issues/108866}: Altera a API e o contrato de @code{_PyExecutorObject} para retornar o ponteiro next_instr, em vez do quadro, e para sempre executar pelo menos uma instrução.

@item 
gh-90350@footnote{https://github.com/python/cpython/issues/90350}: Otimiza as funções embutidas @ref{f3a,,min()} e @ref{f3b,,max()}.

@item 
gh-112943@footnote{https://github.com/python/cpython/issues/112943}: Calcula corretamente os deslocamentos de coluna final para tokens multilinha no módulo @ref{fb,,tokenize}. Patch por Pablo Galindo

@item 
gh-112125@footnote{https://github.com/python/cpython/issues/112125}: Corrige @code{None.__ne__(None)} retornando @code{NotImplemented} em vez de @code{False}.

@item 
gh-74616@footnote{https://github.com/python/cpython/issues/74616}: @ref{131b,,input()} agora levanta uma ValueError quando emitido no terminal se o prompt contiver caracteres nulos incorporados em vez de truncá-lo silenciosamente.

@item 
gh-112716@footnote{https://github.com/python/cpython/issues/112716}: Corrige SystemError na instrução @code{import} e nos métodos @code{__reduce__()} de tipos embutidos quando @code{__builtins__} não é um dict.

@item 
gh-112730@footnote{https://github.com/python/cpython/issues/112730}: Usa cor para destacar locais de erro em tracebacks. Patch por Pablo Galindo

@item 
gh-112625@footnote{https://github.com/python/cpython/issues/112625}: Corrige um bug em que um objeto bytearray poderia ser limpo durante a iteração sobre um argumento no método @code{bytearray.join()} que poderia resultar na leitura de memória após ser liberado.

@item 
gh-112660@footnote{https://github.com/python/cpython/issues/112660}: Não limpa erros inesperados durante mensagens de erro de formatação para ImportError e AttributeError para módulos.

@item 
gh-105967@footnote{https://github.com/python/cpython/issues/105967}: Solução alternativa para um bug na biblioteca zlib da plataforma macOS da Apple, em que @ref{178b,,zlib.crc32()} e @ref{178c,,binascii.crc32()} poderiam produzir resultados incorretos em entradas de vários gigabytes. Incluindo ao usar @ref{131,,zipfile} em zips contendo dados grandes.

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: Fornece uma mensagem de erro melhor ao acessar atributos inválidos em módulos parcialmente inicializados. A origem do módulo que está sendo acessado agora está incluída na mensagem para ajudar com o problema comum de sombreamento de outros módulos.

@item 
gh-112217@footnote{https://github.com/python/cpython/issues/112217}: Adiciona verificação para o tipo de @code{__cause__} retornado da chamada do tipo @code{T} em @code{raise from T}.

@item 
gh-111058@footnote{https://github.com/python/cpython/issues/111058}: Altera coro.cr_frame/gen.gi_frame para retornar @code{None} após a corrotina/gerador ter sido fechado. Isso corrige um bug em que @ref{e45,,getcoroutinestate()} e @ref{1277,,getgeneratorstate()} retornam o estado errado para uma corrotina/gerador fechado.

@item 
gh-112388@footnote{https://github.com/python/cpython/issues/112388}: Corrige um erro que estava fazendo o analisador tentar sobrescrever erros do tokenizador. Patch por pablo Galindo

@item 
gh-112387@footnote{https://github.com/python/cpython/issues/112387}: Corrige posições de erro para strings decodificadas com erros de análise léxica reversa. Patch por Pablo Galindo

@item 
gh-99606@footnote{https://github.com/python/cpython/issues/99606}: Torna o código gerado para uma f-string vazia idêntico ao código de uma string normal vazia.

@item 
gh-112367@footnote{https://github.com/python/cpython/issues/112367}: Evita comportamento indefinido ao usar os trampolins do perf não liberando as arenas de código até o desligamento. Patch por Pablo Galindo

@item 
gh-112320@footnote{https://github.com/python/cpython/issues/112320}: O tradutor de nível 2 agora rastreia o nível de confiança para permanecer “no rastreamento” (ou seja, não sair de volta para o interpretador de nível 1) para instruções de ramificação com base no número de bits definidos no “contador” de ramificação. A tradução de rastreamento termina quando a confiança cai abaixo de 1/3.

@item 
gh-109598@footnote{https://github.com/python/cpython/issues/109598}: @ref{178d,,PyComplex_RealAsDouble()}/@ref{178e,,PyComplex_ImagAsDouble()} agora tenta converter um objeto para uma instância @ref{2f8,,complex} usando seu método @code{__complex__()} antes de retornar ao método @code{__float__()}. Patch por Sergey B Kirpichev.

@item 
gh-94606@footnote{https://github.com/python/cpython/issues/94606}: Corrige UnicodeEncodeError quando @code{email.message.get_payload()} lê uma mensagem com um caractere substituto Unicode e o conteúdo da mensagem não está bem formado para codificação de escape substituto. Patch por Sidney Markowitz.

@item 
bpo-21861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21861}: Usa o nome de classe real do objeto em @code{_io.FileIO.__repr__()}, @code{_io._WindowsConsoleIO()} e @code{_io.TextIOWrapper.__repr__()}, para tornar esses métodos amigáveis à subclasse.

@item 
bpo-45369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45369}: Remove soluções alternativas do LibreSSL conforme a 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}.

@item 
bpo-34392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34392}: Adicionada @ref{250,,sys._is_interned()}.
@end itemize

@node Biblioteca<36>,Documentação<15>,Núcleo e embutidos<32>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id186}@anchor{178f}
@subsubsection Biblioteca



@itemize -

@item 
gh-114077@footnote{https://github.com/python/cpython/issues/114077}: Corrige possível @ref{885,,OverflowError} em @ref{e8c,,socket.socket.sendfile()} ao passar `count' maior que 2 GiB em plataforma de 32 bits.

@item 
gh-111803@footnote{https://github.com/python/cpython/issues/111803}: @ref{ab,,plistlib} agora oferece suporte ao carregamento de listas aninhadas mais profundamente em formato binário.

@item 
gh-114014@footnote{https://github.com/python/cpython/issues/114014}: Corrige um bug em @ref{1e7,,fractions.Fraction} onde uma string inválida usando @code{d} na parte decimais cria um erro diferente comparado a outras letras/caracteres inválidos. Patch por Jeremiah Gabriel Pascual.

@item 
gh-108364@footnote{https://github.com/python/cpython/issues/108364}: @ref{247,,sqlite3.Connection.iterdump()} agora garante que o suporte a chave estrangeira seja desabilitado antes de despejar o esquema do banco de dados, se houver qualquer violação de chave estrangeira. Patch por Erlend E. Aasland e Mariusz Felisiak.

@item 
gh-113971@footnote{https://github.com/python/cpython/issues/113971}: O atributo @code{._compresslevel} protegido anteriormente por @ref{d2c,,zipfile.ZipInfo} foi tornado público como @code{.compress_level} com o antigo nome @code{_compresslevel} permanecendo disponível como uma propriedade para manter a compatibilidade.

@item 
gh-113877@footnote{https://github.com/python/cpython/issues/113877}: Corrige o método @code{winfo_pathname()} do @ref{f0,,tkinter} no Windows de 64 bits.

@item 
gh-113868@footnote{https://github.com/python/cpython/issues/113868}: Adicionados @ref{1790,,mmap.MAP_NORESERVE}, @ref{1791,,mmap.MAP_NOEXTEND}, @ref{1792,,mmap.MAP_HASSEMAPHORE}, @ref{1793,,mmap.MAP_NOCACHE}, @ref{1794,,mmap.MAP_JIT}, @ref{1795,,mmap.MAP_RESILIENT_CODESIGN}, @ref{1796,,mmap.MAP_RESILIENT_MEDIA}, @ref{1797,,mmap.MAP_32BIT}, @ref{1798,,mmap.MAP_TRANSLATED_ALLOW_EXECUTE}, @ref{1799,,mmap.MAP_UNIX03} e @ref{179a,,mmap.MAP_TPRO}. Todos eles são sinalizadores @code{mmap(2)} no macOS.

@item 
gh-113848@footnote{https://github.com/python/cpython/issues/113848}: Os gerenciadores de contexto @ref{1b5,,asyncio.TaskGroup()} e @ref{5fe,,asyncio.timeout()} agora manipulam as subclasses @ref{1b8,,CancelledError}, bem como @code{CancelledError} exato.

@item 
gh-113661@footnote{https://github.com/python/cpython/issues/113661}: unittest runner: Não sai com 5 se os testes foram ignorados. A intenção de sair com 5 era detectar problemas em que o conjunto de testes não foi descoberto. Se pulamos os testes, ele foi descoberto corretamente.

@item 
gh-96037@footnote{https://github.com/python/cpython/issues/96037}: Insere @ref{838,,TimeoutError} no contexto da exceção que foi levantada durante a saída de um bloco @ref{5fe,,asyncio.timeout()} expirado.

@item 
gh-113781@footnote{https://github.com/python/cpython/issues/113781}: Silencia AttributeError não levantável quando avisos são emitidos durante a finalização do Python.

@item 
gh-113238@footnote{https://github.com/python/cpython/issues/113238}: Adiciona @code{Anchor} a @code{importlib.resources} (para que o código esteja em conformidade com a documentação)

@item 
gh-111693@footnote{https://github.com/python/cpython/issues/111693}: @ref{179b,,asyncio.Condition.wait()} agora levanta novamente a mesma instância @code{CancelledError} que pode ter causado sua interrupção. Corrigida a condição de corrida em @ref{179c,,asyncio.Semaphore.acquire()} quando interrompido com uma @code{CancelledError}.

@item 
gh-113791@footnote{https://github.com/python/cpython/issues/113791}: Adiciona @code{CLOCK_MONOTONIC_RAW_APPROX} e @code{CLOCK_UPTIME_RAW_APPROX} a @ref{ee,,time} no macOS. Esses são relógios disponíveis no macOS 10.12 ou posterior.

@item 
gh-112932@footnote{https://github.com/python/cpython/issues/112932}: Restaura a capacidade de @ref{131,,zipfile} de @code{extractall} de arquivos zip com uma entrada de diretório “/” neles, como é comumente adicionado a zips por alguns exportadores de dados de wiki ou rastreadores de bugs.

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: Levanta avisos de descontinuação de @ref{4a6,,pathlib.PurePath} e não de sua classe base privada @code{PurePathBase}.

@item 
gh-113594@footnote{https://github.com/python/cpython/issues/113594}: Corrige @ref{677,,UnicodeEncodeError} em @ref{3b,,email} ao redobrar linhas que contêm parte codificada de 8 bits desconhecida seguida por parte codificada de 8 bits não desconhecida.

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: Em @code{asyncio.StreamReaderProtocol.connection_made()}, há um retorno de chamada que registra um erro se a tarefa que envolve o “retorno de chamada de conectado” falhar. Este retorno de chamada falharia se a tarefa fosse cancelada. Evite isso verificando se a tarefa foi cancelada primeiro. Se sim, feche o transporte, mas não registre um erro.

@item 
gh-113626@footnote{https://github.com/python/cpython/issues/113626}: Adiciona suporte para o argumento `allow_code' no módulo @ref{8d,,marshal}. Passar @code{allow_code=False} previne a serialização e desserialização de objetos de código, o que é incompatível entre versões do Python.

@item 
gh-85567@footnote{https://github.com/python/cpython/issues/85567}: Corrige avisos de recursos para arquivos não fechados nas interfaces de linha de comando @ref{a6,,pickle} e @ref{a7,,pickletools}.

@item 
gh-113537@footnote{https://github.com/python/cpython/issues/113537}: Suporte a cargas de @code{str} em @ref{957,,plistlib.loads()}.

@item 
gh-89850@footnote{https://github.com/python/cpython/issues/89850}: Adiciona implementações padrão dos métodos @ref{1687,,pickle.Pickler.persistent_id()} e @ref{168e,,pickle.Unpickler.persistent_load()} na implementação C. Chamar @code{super().persistent_id()} e @code{super().persistent_load()} em subclasses da implementação C das classes @ref{a28,,pickle.Pickler} e @ref{159f,,pickle.Unpickler} não causa mais recursão infinita.

@item 
gh-113569@footnote{https://github.com/python/cpython/issues/113569}: Indica se não houve chamadas reais na falha do unittest @ref{179d,,assert_has_calls()}.

@item 
gh-101225@footnote{https://github.com/python/cpython/issues/101225}: Aumenta o backlog para objetos @ref{179e,,multiprocessing.connection.Listener} criados por @code{multiprocessing.manager} e @code{multiprocessing.resource_sharer} para reduzir significativamente o risco de obter um erro de conexão recusada ao criar um @ref{111f,,multiprocessing.connection.Connection} para eles.

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: Levanta eventos de auditoria de @ref{229,,pathlib.Path} e não de sua classe base privada @code{PathBase}.

@item 
gh-113543@footnote{https://github.com/python/cpython/issues/113543}: Garante que @code{webbrowser.MacOSXOSAScript} envie o evento de auditoria @code{webbrowser.open}.

@item 
gh-113028@footnote{https://github.com/python/cpython/issues/113028}: Quando uma segunda referência a uma string aparece na entrada para @ref{a6,,pickle}, e a implementação Python está em uso, temos a garantia de que uma única cópia é decapada e um único objeto é compartilhado quando recarregado. Anteriormente, no protocolo 0, quando uma string continha certos caracteres (por exemplo, nova linha), isso resultava em objetos duplicados.

@item 
gh-113421@footnote{https://github.com/python/cpython/issues/113421}: Corrige o logger de multiprocessamento para @code{%(filename)s}.

@item 
gh-111784@footnote{https://github.com/python/cpython/issues/111784}: Corrige falhas de segmentação no módulo @code{_elementtree}. Corrige a primeira falha de segmentação durante a desalocação de instâncias @code{_elementtree.XMLParser} mantendo uma referência forte ao módulo @code{pyexpat} no estado do módulo para o tempo de vida da cápsula. Corrige a segunda falha de segmentação que acontece no mesmo processo de desalocação mantendo uma referência forte ao módulo @code{_elementtree} na estrutura @code{XMLParser} para o tempo de vida do módulo @code{_elementtree}.

@item 
gh-113407@footnote{https://github.com/python/cpython/issues/113407}: Corrige a importação de @ref{107,,unittest.mock} quando o CPython é construído sem docstrings.

@item 
gh-113320@footnote{https://github.com/python/cpython/issues/113320}: Corrige uma regressão no Python 3.12 onde classes @ref{264,,Protocol} que não foram marcadas como @ref{443,,runtime-checkable} seriam introspectadas desnecessariamente, potencialmente causando exceções se o protocolo tivesse membros problemáticos. Patch por Alex Waygood.

@item 
gh-53502@footnote{https://github.com/python/cpython/issues/53502}: Adiciona uma nova opção @code{aware_datetime} em @ref{ab,,plistlib} para carregar ou despejar datetime consciente.

@item 
gh-113358@footnote{https://github.com/python/cpython/issues/113358}: Corrige renderização de tracebacks com exceções com um __getattr__ quebrado

@item 
gh-113214@footnote{https://github.com/python/cpython/issues/113214}: Corrige um @code{AttributeError} durante término do protocolo SSL asyncio em cenários SSL sobre SSL.

@item 
gh-113246@footnote{https://github.com/python/cpython/issues/113246}: Atualiza o pip empacotado para 23.3.2.

@item 
gh-87264@footnote{https://github.com/python/cpython/issues/87264}: Corrigido o método list() do tarfile para mostrar o tipo de arquivo.

@item 
gh-112182@footnote{https://github.com/python/cpython/issues/112182}: @code{asyncio.futures.Future.set_exception()} agora transforma @ref{c15,,StopIteration} em @ref{195,,RuntimeError} em vez de travar ou apresentar outro comportamento incorreto. Contribuição de patch de Jamie Phan.

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: Acelera @ref{22d,,pathlib.Path.glob()} usando @ref{1772,,os.DirEntry.path} sempre que possível.

@item 
gh-113149@footnote{https://github.com/python/cpython/issues/113149}: Melhora a mensagem de erro quando um vetor JSON ou objeto contém uma vírgula final. Patch por Carson Radtke.

@item 
gh-113117@footnote{https://github.com/python/cpython/issues/113117}: O módulo @ref{d6,,subprocess} agora pode usar a função @ref{220,,os.posix_spawn()} com @code{close_fds=True} em plataformas onde @code{posix_spawn_file_actions_addclosefrom_np} está disponível. Patch por Jakub Kulik.

@item 
gh-113199@footnote{https://github.com/python/cpython/issues/113199}: Faz @code{http.client.HTTPResponse.read1} e @code{http.client.HTTPResponse.readline} fecharem E/S após ler todos os dados quando o comprimento do conteúdo for conhecido. Patch por Illia Volochii.

@item 
gh-113191@footnote{https://github.com/python/cpython/issues/113191}: Adiciona suporte a @ref{21c,,os.fchmod()} e um descritor de arquivo em @ref{21b,,os.chmod()} no Windows.

@item 
gh-113188@footnote{https://github.com/python/cpython/issues/113188}: Corrige @ref{179f,,shutil.copymode()} e @ref{116d,,shutil.copystat()} no Windows. Anteriormente, eles funcionavam de forma diferente se `dst' fosse um link simbólico: eles modificavam os bits de permissão do próprio `dst' em vez do arquivo para o qual ele aponta se `follow_symlinks' fosse true ou `src' não fosse um link simbólico, e não modificavam os bits de permissão se `follow_symlinks' fosse false e `src' fosse um link simbólico.

@item 
gh-113119@footnote{https://github.com/python/cpython/issues/113119}: @ref{220,,os.posix_spawn()} agora aceita @code{env=None}, o que faz com que o processo recém-gerado use o ambiente de processo atual. Patch por Jakub Kulik.

@item 
gh-113202@footnote{https://github.com/python/cpython/issues/113202}: Adiciona uma opção @code{strict} para @code{batched()} no módulo @code{itertools}.

@item 
gh-61648@footnote{https://github.com/python/cpython/issues/61648}: Detecta números de linha de propriedades em doctests.

@item 
gh-113175@footnote{https://github.com/python/cpython/issues/113175}: Sincroniza com importlib_metadata 7.0, incluindo anotações de tipo aprimoradas, problema corrigido com pacotes com links simbólicos em @code{package_distributions}, adicionado @code{EntryPoints.__repr__}, introduzido o script @code{diagnose}, adicionada a propriedade @code{Distribution.origin} e removido o acesso @code{EntryPoint} descontinuado por índice numérico (comportamento de tupla).

@item 
gh-59616@footnote{https://github.com/python/cpython/issues/59616}: Adiciona suporte para @ref{21a,,os.lchmod()} e o argumento `follow_symlinks' em @ref{21b,,os.chmod()} no Windows. Observe que o valor padrão de `follow_symlinks' em @code{os.lchmod()} é @code{False} no Windows.

@item 
gh-112559@footnote{https://github.com/python/cpython/issues/112559}: @ref{1173,,signal.signal()} e @ref{17a0,,signal.getsignal()} não chamam mais @code{repr} em manipuladores chamáveis. @ref{47c,,asyncio.run()} e @ref{17a1,,asyncio.Runner.run()} não chamam mais @code{repr} nos resultados da tarefa. Patch por Yilei Yang.

@item 
gh-112962@footnote{https://github.com/python/cpython/issues/112962}: As funções do módulo @ref{38,,dis} adicionam informações de cache à instância @ref{1da,,Instruction} em vez de criar instâncias falsas @ref{1da,,Instruction} para representar as entradas de cache.

@item 
gh-112989@footnote{https://github.com/python/cpython/issues/112989}: Reduz a sobrecarga para conectar soquetes com SelectorEventLoop do @ref{a,,asyncio}.

@item 
gh-112970@footnote{https://github.com/python/cpython/issues/112970}: Usa @code{closefrom()} no Linux onde disponível (por exemplo, glibc-2.34), em vez de apenas FreeBSD.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Corrige estruturas ctypes com array na plataforma PPC64LE definindo @code{MAX_STRUCT_SIZE} como 64 em stgdict. Patch por Diego Russo.

@item 
gh-112540@footnote{https://github.com/python/cpython/issues/112540}: A função statistics.geometric_mean() agora retorna zero para conjuntos de dados contendo um zero. Anteriormente, isso levantaria uma exceção.

@item 
gh-87286@footnote{https://github.com/python/cpython/issues/87286}: Adicionados @code{LOG_FTP}, @code{LOG_NETINFO}, @code{LOG_REMOTEAUTH}, @code{LOG_INSTALL}, @code{LOG_RAS} e @code{LOG_LAUNCHD} ao módulo @ref{dc,,syslog}, todos eles constantes usados no macOS.

@item 
gh-112800@footnote{https://github.com/python/cpython/issues/112800}: Corrige @ref{a,,asyncio} @code{SubprocessTransport.close()} para não lançar @code{PermissionError} quando usado com executáveis setuid.

@item 
gh-51944@footnote{https://github.com/python/cpython/issues/51944}: Adiciona as seguintes constantes ao módulo @ref{e1,,termios}. Esses valores estão presentes nos cabeçalhos do sistema macOS: @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}: Corrige um erro de recursão infinita na limpeza de @ref{1275,,tempfile.TemporaryDirectory()} no Windows.

@item 
gh-94692@footnote{https://github.com/python/cpython/issues/94692}: @ref{301,,shutil.rmtree()} agora captura apenas exceções OSError. Anteriormente, uma versão resistente a ataques de symlink de @code{shutil.rmtree()} podia ignorar ou passar para o manipulador de erros uma exceção arbitrária quando argumentos inválidos eram fornecidos.

@item 
gh-112736@footnote{https://github.com/python/cpython/issues/112736}: O uso de símbolos del-safe em @code{subprocess} foi refatorado para permitir o uso em ambientes de construção multiplataforma.

@item 
gh-112727@footnote{https://github.com/python/cpython/issues/112727}: Acelera @ref{17a2,,pathlib.Path.absolute()}. Patch por Barney Gale.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: Aceleração de verificações de @ref{7c2,,issubclass()} em relação a @ref{443,,protocolos runtime-checkable} simples em cerca de 6%. Patch por Alex Waygood.

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: Aceleração de verificações de @ref{442,,isinstance()} em cerca de 20% para @ref{443,,protocolos verificáveis em tempo de execução} que têm apenas um membro chamável. Aceleração de verificações de @ref{7c2,,issubclass()} para esses protocolos em cerca de 10%. Patch por Alex Waygood.

@item 
gh-112645@footnote{https://github.com/python/cpython/issues/112645}: Remoção de erro de descontinuação ao passar @code{onerror} para @ref{301,,shutil.rmtree()}.

@item 
gh-112640@footnote{https://github.com/python/cpython/issues/112640}: Adiciona o parâmetro @code{kwdefaults} a @ref{887,,types.FunctionType} para definir valores padrão de argumento nomeado.

@item 
gh-112622@footnote{https://github.com/python/cpython/issues/112622}: Garante que o parâmetro @code{name} seja passado para o laço de eventos em @ref{1bf,,asyncio.create_task()}.

@item 
gh-112618@footnote{https://github.com/python/cpython/issues/112618}: Corrige um bug de armazenamento em cache relacionado a @ref{944,,typing.Annotated}. @code{Annotated[str, True]} não é mais idêntico a @code{Annotated[str, 1]}.

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: Corrige uma regressão de desempenho no @ref{d6,,subprocess} do 3.12 no Linux, onde ele não usaria mais a chamada de sistema de caminho rápido @code{vfork()} quando poderia devido a um bug lógico, em vez disso, voltando para o seguro, mas mais lento @code{fork()}.

Também foi corrigido um segundo bug de segurança potencial do 3.12.0. Se um valor de @code{extra_groups=[]} fosse passado para @ref{199,,subprocess.Popen} ou APIs relacionadas, a chamada de sistema @code{setgroups(0, NULL)} subjacente para limpar a lista de grupos não seria feita no processo filho antes de @code{exec()}.

Isso foi identificado por meio de inspeção de código no processo de correção do primeiro bug.

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: Corrige estruturas ctypes com array na plataforma Arm definindo @code{MAX_STRUCT_SIZE} como 32 em stgdict. Patch por Diego Russo.

@item 
gh-81194@footnote{https://github.com/python/cpython/issues/81194}: Corrige uma falha em @ref{a39,,socket.if_indextoname()} com valor específico (UINT_MAX). Corrigir um estouro de inteiro em @ref{a39,,socket.if_indextoname()} em plataformas não Windows de 64 bits.

@item 
gh-112578@footnote{https://github.com/python/cpython/issues/112578}: Corrige uma @ref{1bd,,RuntimeWarning} espúrio ao executar o módulo @ref{131,,zipfile}.

@item 
gh-112516@footnote{https://github.com/python/cpython/issues/112516}: Atualiza a cópia empacotada do pip para a versão 23.3.1.

@item 
gh-112510@footnote{https://github.com/python/cpython/issues/112510}: Adiciona @ref{17a3,,readline.backend} para os usos do backend readline (@code{editline} ou @code{readline})

@item 
gh-112328@footnote{https://github.com/python/cpython/issues/112328}: [Enum] Torna @code{EnumDict}, @code{EnumDict.member_names}, @code{EnumType._add_alias_} e @code{EnumType._add_value_alias_} públicos.

@item 
gh-112509@footnote{https://github.com/python/cpython/issues/112509}: Corrige casos extremos que poderiam fazer com que uma chave estivesse presente nos atributos @code{__required_keys__} e @code{__optional_keys__} de um @ref{162,,typing.TypedDict}. Patch por Jelle Zijlstra.

@item 
gh-101336@footnote{https://github.com/python/cpython/issues/101336}: Adiciona o parâmetro nomeado @code{keep_alive} para @code{AbstractEventLoop.create_server()} e @code{BaseEventLoop.create_server()}.

@item 
gh-63284@footnote{https://github.com/python/cpython/issues/63284}: Adicionado suporte para modo TLS-PSK (chave pré-compartilhada) para :mod: módulo @ref{d0,,ssl}.

@item 
gh-112414@footnote{https://github.com/python/cpython/issues/112414}: Corrige regressão no Python 3.12 onde chamar @ref{800,,repr()} em um módulo que foi importado usando um @ref{17a4,,loader} personalizado poderia falhar com @ref{34b,,AttributeError}. Patch por Alex Waygood.

@item 
gh-112358@footnote{https://github.com/python/cpython/issues/112358}: Reverte alteração na inicialização @ref{15a0,,struct.Struct} que quebrou alguns casos de extensão de classes.

@item 
gh-112405@footnote{https://github.com/python/cpython/issues/112405}: Otimiza @ref{2ca,,pathlib.PurePath.relative_to()}. Patch por Alex Waygood.

@item 
gh-94722@footnote{https://github.com/python/cpython/issues/94722}: Corrige bug onde a comparação entre instâncias de @ref{17a5,,DocTest} falha se uma delas tiver @code{None} como seu lineno.

@item 
gh-112361@footnote{https://github.com/python/cpython/issues/112361}: Acelera um pequeno punhado de métodos @ref{a4,,pathlib} removendo alguns objetos temporários.

@item 
gh-112345@footnote{https://github.com/python/cpython/issues/112345}: Melhora a mensagem de erro ao tentar chamar @ref{7c2,,issubclass()} contra um @ref{264,,typing.Protocol} que tem membros não-método. Patch por Randolf Scholz.

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: Altera a saída @ref{38,,dis} para exibir no-lineno como “–” em vez de “None”.

@item 
gh-112332@footnote{https://github.com/python/cpython/issues/112332}: Descontinua o campo @code{exc_type} de @ref{25c,,traceback.TracebackException}. Adiciona @code{exc_type_str} para substituí-lo.

@item 
gh-81620@footnote{https://github.com/python/cpython/issues/81620}: Adiciona testes extras para @ref{4b0,,random.binomialvariate()}

@item 
gh-112292@footnote{https://github.com/python/cpython/issues/112292}: Corrige uma falha em @ref{ba,,readline} quando importado de um subinterpretador. Patch por Anthony Shaw

@item 
gh-77621@footnote{https://github.com/python/cpython/issues/77621}: Melhora ligeiramente o tempo de importação do módulo @ref{a4,,pathlib} adiando algumas importações. Patch por Barney Gale.

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: Altera a saída @ref{38,,dis} para exibir rótulos lógicos para alvos de salto em vez de deslocamentos.

@item 
gh-112139@footnote{https://github.com/python/cpython/issues/112139}: Adiciona @code{Signature.format()} para formatar assinaturas para string com opções extras. E usá-lo em @ref{b5,,pydoc} para renderizar assinaturas mais legíveis que tenham novas linhas entre parâmetros.

@item 
gh-112105@footnote{https://github.com/python/cpython/issues/112105}: Faz @ref{17a6,,readline.set_completer_delims()} funcionar com libedit

@item 
gh-106922@footnote{https://github.com/python/cpython/issues/106922}: Exibe várias linhas com @code{traceback} quando os erros abrangerem várias linhas.

@item 
gh-111874@footnote{https://github.com/python/cpython/issues/111874}: Ao criar uma classe @ref{2b0,,typing.NamedTuple}, garante que @ref{c69,,__set_name__()} seja chamado em todos os objetos que definem @code{__set_name__} e existam nos valores do dicionário de classes da classe @code{NamedTuple}. Patch por Alex Waygood.

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: Adiciona suporte ao tipo de elemento “vsapi” em @ref{258,,tkinter.ttk.Style.element_create()}.

@item 
gh-110275@footnote{https://github.com/python/cpython/issues/110275}: Os métodos @code{_replace()} e @code{__replace__()} da tupla nomeada agora levantam TypeError em vez de ValueError para argumentos nomeados inválidos.

@item 
gh-99367@footnote{https://github.com/python/cpython/issues/99367}: Não desorganiza @code{sys.path[0]} em @ref{a5,,pdb} se safe_path estiver definido

@item 
gh-111615@footnote{https://github.com/python/cpython/issues/111615}: Corrige uma regressão causada por uma correção em gh-93162@footnote{https://github.com/python/cpython/issues/93162}, na qual você não conseguia configurar uma @code{QueueHandler} sem especificar manipuladores.

@item 
gh-75666@footnote{https://github.com/python/cpython/issues/75666}: Corrige o comportamento do método @code{unbind()} do widget @ref{f0,,tkinter} com dois argumentos. Anteriormente, @code{widget.unbind(sequence, funcid)} destruía a vinculação atual para `sequence', deixando `sequence' desvinculado, e excluía o comando `funcid'. Agora ele remove apenas `funcid' da vinculação para `sequence', mantendo outros comandos, e exclui o comando `funcid'. Ele deixa `sequence' desvinculado somente se `funcid' foi o último comando vinculado.

@item 
gh-67790@footnote{https://github.com/python/cpython/issues/67790}: Implementa suporte básico de formatação (largura mínima, alinhamento, preenchimento) para @ref{1e7,,fractions.Fraction}.

@item 
gh-111049@footnote{https://github.com/python/cpython/issues/111049}: Corrige travamento durante coleta de lixo do objeto buffer @ref{ed3,,io.BytesIO}.

@item 
gh-102980@footnote{https://github.com/python/cpython/issues/102980}: Redireciona a saída do comando @code{interact} de @ref{a5,,pdb} para o mesmo canal do depurador. Adiciona testes e melhore a documentação.

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: @ref{1e1,,email.utils.getaddresses()} e @ref{1e2,,email.utils.parseaddr()} agora retornam tuplas de dois elementos @code{('@w{'}, '@w{'})} em mais situações onde endereços de e-mail inválidos são encontrados em vez de potencialmente imprecisos valores. Adiciona o parâmetro `strict' opcional a estas duas funções: use @code{strict=False} para obter o comportamento antigo, aceitar entradas malformadas. @code{getattr(email.utils, 'supports_strict_parsing', False)} pode usar para verificar se o parâmetro `strict' está disponível. Patch por Thomas Dwyer e Victor Stinner para melhorar a correção 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043}.

@item 
gh-52161@footnote{https://github.com/python/cpython/issues/52161}: @ref{17a7,,cmd.Cmd.do_help()} agora limpa docstrings com @ref{17a8,,inspect.cleandoc()} antes de escrevê-las. Patch por Filip Łapkiewicz.

@item 
gh-82300@footnote{https://github.com/python/cpython/issues/82300}: Adiciona o parâmetro @code{track} a @ref{174f,,multiprocessing.shared_memory.SharedMemory} que permite usar blocos de memória compartilhada sem precisar registrar com o rastreador de recursos POSIX que os libera automaticamente na saída do processo.

@item 
gh-110109@footnote{https://github.com/python/cpython/issues/110109}: Adiciona a classe privada @code{pathlib._PurePathBase}: uma classe base para @ref{4a6,,pathlib.PurePath} que omite certos métodos mágicos. Pode ser tornado público (junto com @code{_PathBase}) no futuro.

@item 
gh-109858@footnote{https://github.com/python/cpython/issues/109858}: Protege @ref{131,,zipfile} de zipbomb “quoted-overlap”. Agora ele levanta BadZipFile ao tentar ler uma entrada que se sobrepõe a outra entrada ou diretório central.

@item 
gh-109786@footnote{https://github.com/python/cpython/issues/109786}: Corrige possíveis vazamentos de referência e travamento ao reinserir o método @code{__next__()} de @ref{818,,itertools.pairwise}.

@item 
gh-91539@footnote{https://github.com/python/cpython/issues/91539}: Melhoria de desempenho pequena (10 - 20%) e trivial de @code{urllib.request.getproxies_environment()}, normalmente útil quando há muitas variáveis de ambiente para analisar.

@item 
gh-103363@footnote{https://github.com/python/cpython/issues/103363}: Adiciona o argumento somente-nomeado `follow_symlinks' a @ref{231,,pathlib.Path.owner()} e @ref{232,,group()}, com o padrão @code{True}.

@item 
gh-102130@footnote{https://github.com/python/cpython/issues/102130}: Suporte para conclusão de tabulação em @ref{19,,cmd} para @code{editline}.

@item 
gh-99437@footnote{https://github.com/python/cpython/issues/99437}: @ref{181,,runpy.run_path()} agora decodifica objetos caminho ou similares, garantindo que __file__ e sys.argv[0] do módulo que está sendo executado sejam sempre strings.

@item 
gh-104003@footnote{https://github.com/python/cpython/issues/104003}: Adiciona @ref{160,,warnings.deprecated()}, um decorador para marcar funções descontinuadas para verificadores de tipo estático e para avisar sobre o uso de classes e funções obsoletas. Veja 
@geindex Propostas de Melhorias do Python; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}. Patch por Jelle Zijlstra.

@item 
gh-103708@footnote{https://github.com/python/cpython/issues/103708}: Torna o nome python codificado, um parâmetro configurável para que diferentes implementações do python possam substituí-lo em vez de fazer grandes diferenças em sysconfig.py

@item 
gh-66515@footnote{https://github.com/python/cpython/issues/66515}: @ref{17a9,,mailbox.MH} agora oferece suporte a pastas que não contêm um arquivo @code{.mh_sequences} (por exemplo, pastas de cache IMAP do Claws Mail). Patch por Serhiy Storchaka.

@item 
gh-83162@footnote{https://github.com/python/cpython/issues/83162}: Renomeado @code{re.error} para @code{PatternError} para maior clareza, e mantido @code{re.error} para compatibilidade com versões anteriores. Patch por Matthias Bussonnier e Adam Chhina.

@item 
gh-91133@footnote{https://github.com/python/cpython/issues/91133}: Corrige um bug na limpeza de @ref{1275,,tempfile.TemporaryDirectory}, que agora não desreferencia mais links simbólicos ao contornar erros de permissão do sistema de arquivos.

@item 
bpo-43153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43153}: No Windows, @code{tempfile.TemporaryDirectory} mascarava anteriormente um @code{PermissionError} com @code{NotADirectoryError} durante a limpeza de diretório. Agora ele levanta corretamente @code{PermissionError} se os erros não forem ignorados. Patch por Andrei Kulakov e Ken Jin.

@item 
bpo-32731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32731}: @ref{418,,getpass.getuser()} agora levanta @ref{417,,OSError} para todas as falhas em vez de @ref{419,,ImportError} em sistemas sem o módulo @ref{b2,,pwd} ou @ref{344,,KeyError} se o banco de dados de senhas estiver vazio.

@item 
bpo-34321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34321}: @ref{20b,,mmap.mmap} agora tem um parâmetro `trackfd' no Unix; se for @code{False}, o descritor de arquivo especificado por `fileno' não será duplicado.

@item 
bpo-35332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35332}: A função @ref{301,,shutil.rmtree()} agora ignora erros ao chamar @ref{b8a,,os.close()} quando `ignore_errors' é @code{True}, e @ref{b8a,,os.close()} não é mais tentado novamente após erro.

@item 
bpo-35928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35928}: @ref{7bc,,io.TextIOWrapper} agora manipula corretamente o buffer de decodificação após @code{read()} e @code{write()}.

@item 
bpo-26791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26791}: @ref{e82,,shutil.move()} agora move um link simbólico para um diretório quando esse diretório é o alvo do link simbólico. Isso fornece o mesmo comportamento do comando mv shell. O comportamento anterior gerou uma exceção. Patch por Jeffrey Kintscher.

@item 
bpo-41422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41422}: Corrigidos vazamentos de memória de @ref{a28,,pickle.Pickler} e @ref{159f,,pickle.Unpickler} envolvendo referências cíclicas por meio do mapeamento de memorando interno.

@item 
bpo-19821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19821}: A função @code{pydoc.ispackage()} foi descontinuada.

@item 
bpo-40262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40262}: O método @code{ssl.SSLSocket.recv_into()} não requer mais o argumento `buffer' para implementar @code{__len__} e suporta buffers com tamanho de item arbitrário.

@item 
bpo-39912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39912}: @ref{14f1,,warnings.filterwarnings()} e @ref{6c1,,warnings.simplefilter()} agora levantam exceções apropriadas em vez de @code{AssertionError}. Patch foi contribuição de Rémi Lapeyre.

@item 
bpo-37260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37260}: Corrigida uma condição de corrida em @ref{301,,shutil.rmtree()} na qual entradas de diretório removidas por outro processo ou thread enquanto @code{shutil.rmtree()} está em execução podem fazer com que ele levante FileNotFoundError. Patch por Jeffrey Kintscher.

@item 
bpo-36959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36959}: Corrigidas algumas mensagens de erro para combinações de strings de formato ISO inválidas em @code{strptime()} que se referiam a diretivas não contidas na string de formato. Patch por Gordon P. Hemsley.

@item 
bpo-18060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18060}: Corrigido um problema de herança de classe que pode causar falhas de segmentação ao derivar dois ou mais níveis de subclasses de uma classe base de Structure ou Union.

@item 
bpo-29779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29779}: Adicionada uma nova variável de ambiente 
@geindex PYTHON_HISTORY
@geindex variável de ambiente; PYTHON_HISTORY
@ref{191,,PYTHON_HISTORY} para definir o local de um arquivo @code{.python_history}.

@item 
bpo-21360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21360}: @ref{41c,,mailbox.Maildir} agora ignora arquivos com um ponto inicial.
@end itemize

@node Documentação<15>,Testes<18>,Biblioteca<36>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id187}@anchor{17aa}
@subsubsection Documentação



@itemize -

@item 
gh-111699@footnote{https://github.com/python/cpython/issues/111699}: Realoca o aviso de descontinuação de @code{smtpd} para sua própria seção em vez de em @code{locale} no documento O que há de novo no Python 3.12

@item 
gh-110746@footnote{https://github.com/python/cpython/issues/110746}: Marcação aprimorada para opções/valores válidos para os métodos ttk.treeview.column e ttk.treeview.heading, e para Layouts.

@item 
gh-95649@footnote{https://github.com/python/cpython/issues/95649}: Document que o módulo @ref{a,,asyncio} contém código retirado de v0.16.0 do projeto uvloop@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0}, bem como as informações de licenciamento do MIT necessárias.
@end itemize

@node Testes<18>,Construção<18>,Documentação<15>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id188}@anchor{17ab}
@subsubsection Testes



@itemize -

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: Desabilita @code{test_super_deep()} de @code{test_call} em construções pydebug em WASI; a profundidade da pilha é muito pequena para tornar o teste útil.

@item 
gh-111801@footnote{https://github.com/python/cpython/issues/111801}: Reduz o limite de recursão em @code{test_isinstance} para @code{test_infinitely_many_bases()}. Isso evita um estouro de pilha em uma construção pydebug de WASI.

@item 
gh-111802@footnote{https://github.com/python/cpython/issues/111802}: Especifica uma profundidade de recursão baixa para @code{test_bad_getattr()} em @code{test.pickletester} para evitar esgotar a pilha em uma construção pydebug para WASI.

@item 
gh-44626@footnote{https://github.com/python/cpython/issues/44626}: Corrige @ref{224,,os.path.isabs()} retornando incorretamente @code{True} quando recebe um caminho que começa com exatamente uma barra (invertida) no Windows.

Corrige @code{pathlib.PureWindowsPath.is_absolute()} retornando incorretamente @code{False} para alguns caminhos que começam com duas barras (invertidas).

@item 
gh-113633@footnote{https://github.com/python/cpython/issues/113633}: Use estado do módulo para o módulo de extensão _testcapi.

@item 
gh-109980@footnote{https://github.com/python/cpython/issues/109980}: Corrige @code{test_tarfile_vs_tar} em @code{test_shutil} para macOS, onde o tar do sistema pode incluir mais informações no arquivo do que @ref{4b3,,shutil.make_archive}.

@item 
gh-112769@footnote{https://github.com/python/cpython/issues/112769}: Os testes agora comparam corretamente a versão zlib quando @ref{11ad,,zlib.ZLIB_RUNTIME_VERSION} contém sufixos não inteiros. Por exemplo, zlib-ng define a versão como @code{1.3.0.zlib-ng}.

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: Adiciona um teste de regressão para verificar se @code{vfork()} é usado quando esperado por @ref{d6,,subprocess} em sistemas POSIX habilitados para vfork (Linux).

@item 
gh-108927@footnote{https://github.com/python/cpython/issues/108927}: Corrigida a dependência de ordem na execução de testes no mesmo processo quando um teste que tem submódulos (por exemplo, test_importlib) segue um teste que importa seu submódulo (por exemplo, test_importlib.util) e precede um teste (por exemplo, test_unittest ou test_compileall) que usa esse submódulo.

@item 
bpo-40648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40648}: Modos de teste que o arquivo pode obter com chmod() no Windows.
@end itemize

@node Construção<18>,Windows<16>,Testes<18>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id189}@anchor{17ac}
@subsubsection Construção



@itemize -

@item 
gh-114013@footnote{https://github.com/python/cpython/issues/114013}: Corrige @code{Tools/wasm/wasi.py} para não incluir o caminho para @code{python.wasm} como parte de @code{HOSTRUNNER}. A variável de ambiente tem como objetivo especificar como executar apenas o host WASI, tendo @code{python.wasm} e sinalizadores relevantes anexados ao @code{HOSTRUNNER}. Isso corrige o funcionamento de @code{make test}.

@item 
gh-113258@footnote{https://github.com/python/cpython/issues/113258}: Alterada a construção do Windows para gravar módulos congelados gerados na árvore de construção em vez da árvore de fontes.

@item 
gh-112305@footnote{https://github.com/python/cpython/issues/112305}: Corrigida a etapa @code{check-clean-src} realizada em construções fora da árvore para detectar arquivos @code{$(srcdir)/Python/frozen_modules/*.h} errantes e recomendou etapas de limpeza apropriadas da árvore de fontes para obter uma construção funcional novamente.

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: Adiciona suporte para sanitizador de thread (TSAN)

@item 
gh-112867@footnote{https://github.com/python/cpython/issues/112867}: Corrige a construção para o caso em que WITH_PYMALLOC_RADIX_TREE=0 definido.

@item 
gh-103065@footnote{https://github.com/python/cpython/issues/103065}: Apresenta @code{Tools/wasm/wasi.py} para simplificar a execução de uma construção WASI.

@item 
bpo-11102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11102}: As funções @ref{1704,,os.major()}, @ref{1706,,os.makedev()} e @ref{1705,,os.minor()} agora estão disponíveis no HP-UX v3.

@item 
bpo-36351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36351}: Não defina ipv6type ao fazer compilação cruzada.
@end itemize

@node Windows<16>,macOS<11>,Construção<18>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id190}@anchor{17ad}
@subsubsection Windows



@itemize -

@item 
gh-114096@footnote{https://github.com/python/cpython/issues/114096}: Os privilégios de processo que são ativados para criar junções de diretório agora são restaurados posteriormente, evitando alterações de comportamento em outras partes do programa.

@item 
gh-111877@footnote{https://github.com/python/cpython/issues/111877}: As chamadas @ref{4a0,,os.stat()} estavam retornando valores de tempo incorretos para arquivos que não podiam ser acessados diretamente.

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: Atualiza o instalador do Windows para usar o SQLite 3.44.2.

@item 
gh-113009@footnote{https://github.com/python/cpython/issues/113009}: @ref{94,,multiprocessing}: No Windows, corrige uma condição de corrida em @code{Process.terminate()}: não define mais o atributo @code{returncode} para sempre chamar @code{WaitForSingleObject()} em @code{Process.wait()}. Anteriormente, às vezes o processo ainda estava em execução após @code{TerminateProcess()} mesmo se @code{GetExitCodeProcess()} não fosse @code{STILL_ACTIVE}. Patch por Victor Stinner.

@item 
gh-86179@footnote{https://github.com/python/cpython/issues/86179}: Corrige cálculos de caminho ao iniciar o Python no Windows por meio de um link simbólico.

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: Atualiza Tcl/Tk no instalador do Windows para 8.6.13 com um patch para suprimir avisos incorretos de ThemeChanged.

@item 
gh-111650@footnote{https://github.com/python/cpython/issues/111650}: Garante que a variável do pré-processador @code{Py_GIL_DISABLED} seja definida em @code{pyconfig.h} para que módulos de extensão escritos em C possam usá-la.

@item 
gh-112278@footnote{https://github.com/python/cpython/issues/112278}: Reduz o custo de tempo para algumas funções em @ref{aa,,platform} no Windows se o usuário atual não tiver permissão para o WMI.

@item 
gh-73427@footnote{https://github.com/python/cpython/issues/73427}: Descontinua @ref{2ae,,sys._enablelegacywindowsfsencoding()}. Use 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} em vez disso. Patch por Inada Naoki.

@item 
gh-87868@footnote{https://github.com/python/cpython/issues/87868}: Classifica e remove corretamente variáveis de ambiente duplicadas em @code{_winapi.CreateProcess()}.

@item 
bpo-37308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37308}: Corrige mojibake em @ref{20b,,mmap.mmap} ao usar um argumento `tagname' não ASCII no Windows.
@end itemize

@node macOS<11>,IDLE<15>,Windows<16>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id191}@anchor{17ae}
@subsubsection macOS



@itemize -

@item 
gh-113666@footnote{https://github.com/python/cpython/issues/113666}: Adiciona as seguintes constantes ao módulo @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} e @code{SF_DATALESS}. Os valores @code{UF_SETTABLE}, @code{SF_SUPPORTED}, @code{SF_SETTABLE} e @code{SF_SYNTHETIC} estão disponíveis apenas no macOS.

@item 
gh-113536@footnote{https://github.com/python/cpython/issues/113536}: @ref{dc1,,os.waitid()} agora está disponível no macOS

@item 
gh-110459@footnote{https://github.com/python/cpython/issues/110459}: Executar @code{configure ... --with-openssl-rpath=X/Y/Z} não falha mais em detectar OpenSSL no macOS.

@item 
gh-74573@footnote{https://github.com/python/cpython/issues/74573}: Documenta que @ref{34,,dbm.ndbm} pode corromper silenciosamente arquivos DBM em atualizações ao exceder limites de plataforma não documentados e pode travar (falha de segmentação) ao ler um arquivo corrompido. (FB8919203)

@item 
gh-65701@footnote{https://github.com/python/cpython/issues/65701}: A ferramenta @code{freeze} não funciona com construções de framework do Python. Documente isso e faça sair mais cedo ao executar a ferramenta com tal construção.

@item 
gh-87277@footnote{https://github.com/python/cpython/issues/87277}: webbrowser: Não procura navegadores X11 no macOS. Geralmente, eles não são usados e procurá-los pode resultar na inicialização do XQuartz, mesmo que ele não seja usado de outra forma.

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: Atualiza o instalador do macOS para usar o SQLite 3.44.2.

@item 
gh-108269@footnote{https://github.com/python/cpython/issues/108269}: Define @code{CFBundleAllowMixedLocalizations} como true no Info.plist para o framework, Python.app incorporado e IDLE.app com instalações do framework no macOS. Isso permite que as aplicações selecionem o local preferido do usuário quando for diferente do inglês.

@item 
gh-102362@footnote{https://github.com/python/cpython/issues/102362}: Garante que o resultado de @code{sysconfig.get_plaform()} inclua pelo menos uma versão principal e secundária, mesmo que @code{MACOSX_DEPLOYMENT_TARGET} esteja definido como apenas uma versão principal durante a construção para corresponder ao formato esperado pelo pip.

@item 
gh-110017@footnote{https://github.com/python/cpython/issues/110017}: Desabilita um teste de estresse de tratamento de sinal no macOS devido a um bug no macOS (FB13453490).

@item 
gh-110820@footnote{https://github.com/python/cpython/issues/110820}: Garante que as definições do pré-processador para @code{ALIGNOF_MAX_ALIGN_T}, @code{SIZEOF_LONG_DOUBLE} e @code{HAVE_GCC_ASM_FOR_X64} estejam corretas para construções Universal 2 no macOS.

@item 
gh-109981@footnote{https://github.com/python/cpython/issues/109981}: Usa @code{/dev/fd} no macOS para determinar o número de arquivos abertos em @code{test.support.os_helper.fd_count} para evitar uma falha com descritores de arquivo “guarded” ao sondar arquivos abertos.
@end itemize

@node IDLE<15>,API C<19>,macOS<11>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id192}@anchor{17af}
@subsubsection IDLE



@itemize -

@item 
gh-72284@footnote{https://github.com/python/cpython/issues/72284}: Melhora as listas de recursos, atalhos de teclado do editor e atalhos de teclado do shell no documento do IDLE.

@item 
gh-113903@footnote{https://github.com/python/cpython/issues/113903}: Corrige a falha rara de test.test_idle, em test_configdialog.

@item 
gh-113729@footnote{https://github.com/python/cpython/issues/113729}: Corrige o bug do menu “Help -> IDLE Doc” em 3.11.7 e 3.12.1.

@item 
gh-113269@footnote{https://github.com/python/cpython/issues/113269}: Corrige o travamento do test_editor no macOS Catalina.

@item 
gh-112898@footnote{https://github.com/python/cpython/issues/112898}: Corrige o processamento de arquivos não salvos ao sair do IDLE no macOS.

@item 
bpo-13586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13586}: Insere o texto selecionado ao abrir a caixa de diálogo “Replace”.
@end itemize

@node API C<19>,,IDLE<15>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id193}@anchor{17b0}
@subsubsection API C



@itemize -

@item 
gh-106560@footnote{https://github.com/python/cpython/issues/106560}: Corrige declarações redundantes na API C pública. Declare PyBool_Type, PyLong_Type e PySys_Audit() apenas uma vez. Patch por Victor Stinner.

@item 
gh-112438@footnote{https://github.com/python/cpython/issues/112438}: Corrige o suporte de unidades de formato “es”, “et”, “es#” e “et#” em tuplas aninhadas em funções do tipo @ref{571,,PyArg_ParseTuple()}.

@item 
gh-111545@footnote{https://github.com/python/cpython/issues/111545}: Adiciona a função @ref{368,,Py_HashPointer()} para fazer hash de um ponteiro. Patch por Victor Stinner.

@item 
gh-65210@footnote{https://github.com/python/cpython/issues/65210}: Altera a declaração do parâmetro `keywords' de @ref{383,,PyArg_ParseTupleAndKeywords()} e @ref{384,,PyArg_VaParseTupleAndKeywords()} para melhor compatibilidade com C++.
@end itemize

@node Python 3 13 0 alpha 2,Python 3 13 0 alpha 1,Python 3 13 0 alpha 3,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-2}@anchor{17b1}
@subsection Python 3.13.0 alpha 2


`Data de lançamento: 2023-11-22'

@menu
* Núcleo e embutidos: Núcleo e embutidos<33>. 
* Biblioteca: Biblioteca<37>. 
* Testes: Testes<19>. 
* Construção: Construção<19>. 
* Windows: Windows<17>. 
* macOS: macOS<12>. 
* IDLE: IDLE<16>. 
* Ferramentas/Demos: Ferramentas/Demos<11>. 
* API C: API C<20>. 

@end menu

@node Núcleo e embutidos<33>,Biblioteca<37>,,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id194}@anchor{17b2}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-112243@footnote{https://github.com/python/cpython/issues/112243}: Não inclua comentários nas expressões do depurador com f-string. Patch por Pablo Galindo

@item 
gh-112287@footnote{https://github.com/python/cpython/issues/112287}: Otimiza ligeiramente o interpretador nível 2 (uop) carregando apenas @code{oparg} e @code{operand} quando necessário. Também dobra o limite de tamanho de rastreamento novamente, para 512 desta vez.

@item 
gh-112266@footnote{https://github.com/python/cpython/issues/112266}: Altera as docstrings de @ref{55b,,__dict__} e @code{__weakref__}.

@item 
gh-111807@footnote{https://github.com/python/cpython/issues/111807}: Reduz a profundidade máxima da pilha do analisador para 1000 em construções de depuração WASI.

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: Quando o Python é construído no modo de depuração, define o limite de recursão C para 500 em vez de 1500. Uma construção de depuração provavelmente é construída com baixo nível de otimização, o que implica maior uso de memória de pilha do que uma construção de lançamento. Patch por Victor Stinner.

@item 
gh-106529@footnote{https://github.com/python/cpython/issues/106529}: Habilita a tradução de @code{FOR_ITER} não especializado para o Nível 2.

@item 
gh-111916@footnote{https://github.com/python/cpython/issues/111916}: Torna os módulos relacionados ao hashlib seguros para thread sem a GIL

@item 
gh-81137@footnote{https://github.com/python/cpython/issues/81137}: Descontinua a atribuição ao campo @code{__code__} de uma função quando o novo objeto de código for de um tipo incompatível (por exemplo, de um gerador para uma função simples).

@item 
gh-79932@footnote{https://github.com/python/cpython/issues/79932}: Levanta uma exceção se @ref{280,,frame.clear()} for chamado em um quadro suspenso.

@item 
gh-81925@footnote{https://github.com/python/cpython/issues/81925}: Implementa IDs de thread nativas para GNU KFreeBSD.

@item 
gh-111843@footnote{https://github.com/python/cpython/issues/111843}: Usa o backoff exponencial para reduzir o número de tentativas de otimização de nível 2 com falha em mais de 99%.

@item 
gh-110829@footnote{https://github.com/python/cpython/issues/110829}: Unir uma thread agora garante que a thread do sistema operacional subjacente tenha saído. Isso é necessário para fork() mais seguro em processos multithread.

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: Certifica-se de que os rastreamentos de nível 2 sejam desotimizados se o código for instrumentado

@item 
gh-111772@footnote{https://github.com/python/cpython/issues/111772}: Especializa cargas e armazenamentos de slot para _Py_T_OBJECT, bem como Py_T_OBJECT_EX

@item 
gh-111666@footnote{https://github.com/python/cpython/issues/111666}: Acelera @ref{17b3,,BaseExceptionGroup.derive()}, @ref{17b4,,BaseExceptionGroup.subgroup()} e @ref{1670,,BaseExceptionGroup.split()} alterando como eles analisam os argumentos passados.

@item 
gh-111654@footnote{https://github.com/python/cpython/issues/111654}: Corrige o travamento do tempo de execução quando algum erro acontece no opcode @code{LOAD_FROM_DICT_OR_DEREF}.

@item 
gh-111623@footnote{https://github.com/python/cpython/issues/111623}: Adiciona suporte para compartilhar tuplas entre interpretadores usando a API de interpretador cruzado. Patch por Anthony Shaw.

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: O oparg de @ref{314,,YIELD_VALUE} agora é @code{1} se a instrução for parte de um yield-from ou await, e @code{0} caso contrário.

O estado do quadro SUSPENDED agora é dividido em @code{SUSPENDED} e @code{SUSPENDED_YIELD_FROM}. Isso simplifica o código em @code{_PyGen_yf}.

@item 
gh-111520@footnote{https://github.com/python/cpython/issues/111520}: Mescla os interpretadores nível 1 (bytecode) e nível 2 (micro-ops), movendo o laço do interpretador nível 2 e alterne para @code{_PyEval_EvalFrameDefault()} em @code{Python/ceval.c}. O arquivo @code{Python/executor.c} desapareceu. Além disso, as macros @code{TIER_ONE} e @code{TIER_TWO} agora são manipuladas pelo gerador de código.

`Cuidado!' Isso altera as variáveis de ambiente para habilitar micro-ops e sua depuração para @code{PYTHON_UOPS} e @code{PYTHON_LLTRACE}.

@item 
gh-109181@footnote{https://github.com/python/cpython/issues/109181}: Acelera a criação do objeto @code{Traceback} calculando preguiçosamente o número da linha. Patch por Pablo Galindo

@item 
gh-111420@footnote{https://github.com/python/cpython/issues/111420}: Permite comentários de tipo em instruções @code{with} entre parênteses

@item 
gh-111438@footnote{https://github.com/python/cpython/issues/111438}: Adicione suporte para compartilhar floats entre interpretadores usando a API de interpretador cruzado. Patch por Anthony Shaw.

@item 
gh-111435@footnote{https://github.com/python/cpython/issues/111435}: Adiciona suporte para compartilhar @code{True} e @code{False} entre interpretadores usando a API de interpretador cruzado. Patch por Anthony Shaw.

@item 
gh-102388@footnote{https://github.com/python/cpython/issues/102388}: Corrige um bug em que os codecs @code{iso2022_jp_3} e @code{iso2022_jp_2004} liam fora dos limites

@item 
gh-111366@footnote{https://github.com/python/cpython/issues/111366}: Corrige um problema no @ref{1c,,codeop} que estava fazendo com que exceções @ref{18d,,SyntaxError} geradas na presença de sintaxe inválida não contivessem mensagens de erro precisas. Patch por Pablo Galindo

@item 
gh-111380@footnote{https://github.com/python/cpython/issues/111380}: Corrige um bug que estava fazendo com que @ref{466,,SyntaxWarning} aparecesse duas vezes ao analisar se uma sintaxe inválida fosse encontrada posteriormente. Patch por Pablo Galindo

@item 
gh-111374@footnote{https://github.com/python/cpython/issues/111374}: Adicionada uma nova variável de ambiente 
@geindex PYTHON_FROZEN_MODULES
@geindex variável de ambiente; PYTHON_FROZEN_MODULES
@ref{18e,,PYTHON_FROZEN_MODULES}. Determina se os módulos congelados são ou não ignorados pelo mecanismo de importação, equivalente à opção de linha de comando @ref{176,,-X frozen_modules}.

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: Remove @code{oparg} de @ref{314,,YIELD_VALUE}. Altera @code{oparg} de @ref{315,,RESUME} para incluir informações sobre o except-depth. Essas alterações possibilitam simplificar o código no fechamento do gerador.

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: Corrige uma regressão que impedia o salto entre @code{is None} e @code{is not None} durante a depuração. Patch por Savannah Ostrowski.

@item 
gh-67224@footnote{https://github.com/python/cpython/issues/67224}: Mostra linhas de origem em tracebacks ao usar a opção @code{-c} ao executar Python. Patch por Pablo Galindo

@item 
gh-111123@footnote{https://github.com/python/cpython/issues/111123}: Corrige um bug em que uma declaração @ref{18a,,global} em um bloco @ref{18b,,except} é rejeitada quando o global é usado no bloco @ref{18c,,else}.

@item 
gh-110938@footnote{https://github.com/python/cpython/issues/110938}: Corrige mensagens de erro para blocos indentados com funções e classes com parâmetros de tipo genérico. Patch por Pablo Galindo

@item 
gh-109214@footnote{https://github.com/python/cpython/issues/109214}: Remove atualizações desnecessárias de ponteiros de instruções antes de retornar de quadros.

@item 
gh-110912@footnote{https://github.com/python/cpython/issues/110912}: Exibe corretamente o traceback para exceções @ref{15c5,,MemoryError} usando o módulo @ref{fe,,traceback}. Patch por Pablo Galindo

@item 
gh-109894@footnote{https://github.com/python/cpython/issues/109894}: Corrige falha devido a @ref{15c5,,MemoryError} estático inicializado incorretamente no subinterpretador.

@item 
gh-110892@footnote{https://github.com/python/cpython/issues/110892}: Retorna @code{NULL} para eventos @code{PyTrace_RETURN} causados por uma exceção

@item 
gh-110864@footnote{https://github.com/python/cpython/issues/110864}: Corrige análise de argumento por @code{_PyArg_UnpackKeywordsWithVararg} para funções que definem parâmetros posicionais-ou-nomeados, argumentos variáveis e somente-nomeados.

@item 
gh-109094@footnote{https://github.com/python/cpython/issues/109094}: Substitui @code{prev_instr} no quadro do interpretador por @code{instr_ptr} que aponta para o início da instrução que está sendo executada no momento (ou será executada quando o quadro for retomado).

@item 
gh-110805@footnote{https://github.com/python/cpython/issues/110805}: Permite que o repl mostre o código-fonte e tracebacks completos. Patch por Pablo Galindo

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: Adiciona 
@geindex PYTHON_PRESITE=package.module
@geindex variável de ambiente; PYTHON_PRESITE=package.module
@code{PYTHON_PRESITE=package.module} para importar um módulo no início do ciclo de vida do interpretador antes de @code{site.py} ser executado. O Python precisa ser @ref{1f9,,construído no modo de depuração} para que esta opção exista.

@item 
gh-110481@footnote{https://github.com/python/cpython/issues/110481}: Implementa a contagem de referências tendenciosa em construções @code{--disable-gil}.

@item 
gh-110543@footnote{https://github.com/python/cpython/issues/110543}: Corrige regressão no Python 3.12 onde @code{types.CodeType.replace()} produziria um objeto de código quebrado se chamado em um objeto código de módulo ou classe que contém uma compreensão. Patch por Jelle Zijlstra.

@item 
gh-89519@footnote{https://github.com/python/cpython/issues/89519}: Removidos os descritores encadeados de @ref{166,,classmethod} (introduzidos em bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}). Isso não pode mais ser usado para encapsular outros descritores como @ref{194,,property}. O design principal desse recurso era falho e causava uma série de problemas posteriores. Para “passar” um @ref{166,,classmethod}, considere usar o atributo @code{__wrapped__} que foi adicionado no Python 3.10.

@item 
gh-103615@footnote{https://github.com/python/cpython/issues/103615}: Usa eventos locais para rastreamento de opcode

@item 
bpo-46657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46657}: Adiciona suporte ao alocador de memória mimalloc.

@item 
gh-106718@footnote{https://github.com/python/cpython/issues/106718}: Quando PyConfig.stdlib_dir é definido explicitamente, ele agora é respeitado e não será substituído por PyConfig.home.

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: Corrige o SystemError incorreto sobre a incompatibilidade de profundidade de recursão do construtor AST.

@item 
gh-100445@footnote{https://github.com/python/cpython/issues/100445}: Melhora a mensagem de erro para strings não terminadas com escapes.

@item 
bpo-45759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45759}: Melhoradas as mensagens de erro para instruções @code{elif}/@code{else} que não correspondem a nenhuma instrução válida. Patch por Jeremiah Vivian.
@end itemize

@node Biblioteca<37>,Testes<19>,Núcleo e embutidos<33>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id195}@anchor{17b5}
@subsubsection Biblioteca



@itemize -

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: Corrige o SystemError no construtor TextIOWrapper com o argumento “errors” não codificável no modo não de depuração.

@item 
gh-111995@footnote{https://github.com/python/cpython/issues/111995}: Adicionada a constante @code{NI_IDN} ao módulo @ref{cc,,socket} quando presente em C no momento da compilação para uso com @ref{17b6,,socket.getnameinfo()}.

@item 
gh-109538@footnote{https://github.com/python/cpython/issues/109538}: Emite mensagem de aviso em vez de exibir @ref{195,,RuntimeError} quando o laço de eventos já foi fechado em @code{StreamWriter.__del__()}.

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: Corrige travamentos em @ref{b5e,,io.TextIOWrapper.reconfigure()} ao passar argumentos inválidos, por exemplo, codificação não string.

@item 
gh-111460@footnote{https://github.com/python/cpython/issues/111460}: @ref{2b,,curses}: restaura o suporte a caracteres amplos (incluindo @ref{10d7,,curses.unget_wch()} e @ref{10d6,,get_wch()}) no macOS, que estava indisponível devido a uma regressão no Python 3.12.

@item 
gh-103791@footnote{https://github.com/python/cpython/issues/103791}: @ref{f58,,contextlib.suppress} agora oferece suporte à supressão de exceções levantadas como parte de um @ref{25f,,BaseExceptionGroup}, além do suporte recente para @ref{1b6,,ExceptionGroup}.

@item 
gh-111835@footnote{https://github.com/python/cpython/issues/111835}: A classe @ref{20b,,mmap.mmap} agora tem um método @ref{20c,,seekable()} que pode ser usado quando um objeto arquivo ou similar pesquisável é necessário. O método @ref{20d,,seek()} agora retorna a nova posição absoluta. Patch por Donghee Na.

@item 
gh-111804@footnote{https://github.com/python/cpython/issues/111804}: Remove posix.fallocate() em WASI, pois o posix_fallocate() subjacente não está disponível na visualização WASI2.

@item 
gh-111841@footnote{https://github.com/python/cpython/issues/111841}: Corrige argumentos truncados em um caractere nulo incorporado em @ref{922,,os.putenv()} e @ref{921,,os.unsetenv()} no Windows.

@item 
gh-111768@footnote{https://github.com/python/cpython/issues/111768}: @ref{17b7,,wsgiref.util.is_hop_by_hop()} agora é exposto corretamente em @code{__all__}.

@item 
gh-80731@footnote{https://github.com/python/cpython/issues/80731}: Evita executar a função padrão em @ref{17b8,,cmd.Cmd} em um bloco except

@item 
gh-111541@footnote{https://github.com/python/cpython/issues/111541}: Corrige @ref{3a,,doctest} para subclasses não embutidas de @ref{18d,,SyntaxError}.

@item 
gh-111719@footnote{https://github.com/python/cpython/issues/111719}: Adiciona validação de argumento extra para o comando @code{alias} em @ref{a5,,pdb}

@item 
gh-111482@footnote{https://github.com/python/cpython/issues/111482}: @ref{ee,,time}: Torna as funções @ref{119d,,time.clock_gettime()} e @ref{af4,,time.clock_gettime_ns()} até 2x mais rápidas por convenção de chamada mais rápida. Patch por Victor Stinner.

@item 
gh-110894@footnote{https://github.com/python/cpython/issues/110894}: Chama manipulador de exceção de laço para exceções em @code{client_connected_cb} de @ref{b2c,,asyncio.start_server()} para que as aplicações possam lidar com isso. Patch por Kumar Aditya.

@item 
gh-111531@footnote{https://github.com/python/cpython/issues/111531}: Corrige vazamentos de referência nos métodos @code{bind_class()} e @code{bind_all()} dos widgets @ref{f0,,tkinter}.

@item 
gh-111246@footnote{https://github.com/python/cpython/issues/111246}: @ref{1ae,,asyncio.loop.create_unix_server()} agora removerá automaticamente o soquete Unix quando o servidor for fechado.

@item 
gh-111356@footnote{https://github.com/python/cpython/issues/111356}: Adicionados @ref{17b9,,io.text_encoding()}, @ref{17ba,,io.DEFAULT_BUFFER_SIZE} e @ref{17bb,,io.IncrementalNewlineDecoder} para @code{io.__all__}.

@item 
gh-66425@footnote{https://github.com/python/cpython/issues/66425}: Remove o código para definir o cabeçalho REMOTE_HOST do módulo wsgiref, pois ele é inacessível. Este cabeçalho é usado por motivos de desempenho, o que não é necessário no módulo wsgiref.

@item 
gh-111429@footnote{https://github.com/python/cpython/issues/111429}: Acelera @ref{2ca,,pathlib.PurePath.relative_to()} e @ref{2c9,,is_relative_to()}.

@item 
gh-111342@footnote{https://github.com/python/cpython/issues/111342}: Corrigido erro de digitação em @ref{497,,math.sumprod()}.

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: Remove menção de tipo de elemento “vsapi” não suportado em @ref{258,,tkinter.ttk.Style.element_create()}. Adiciona testes para @code{element_create()} e outros métodos @code{ttk.Style}. Adiciona exemplos para @code{element_create()} na documentação.

@item 
gh-111388@footnote{https://github.com/python/cpython/issues/111388}: Adiciona parâmetro @code{show_group} para @ref{851,,traceback.format_exception_only()}, que permite formatar instâncias @ref{1b6,,ExceptionGroup}.

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: Outra tentativa de corrigir @ref{17bc,,asyncio.Server.wait_closed()}. Agora ela bloqueia até que ambas as condições sejam verdadeiras: o servidor é fechado, `e' não há mais conexões ativas. (Isso significa que em alguns casos onde na versão 3.12.0 essa função retornaria `incorretamente' imediatamente, agora ela bloqueará; em particular, quando não há conexões ativas, mas o servidor ainda não foi fechado.)

@item 
gh-111259@footnote{https://github.com/python/cpython/issues/111259}: Otimiza curingas recursivos em @ref{a4,,pathlib}.

@item 
gh-111295@footnote{https://github.com/python/cpython/issues/111295}: Corrige @ref{ee,,time} não verificando erros ao inicializar.

@item 
gh-111253@footnote{https://github.com/python/cpython/issues/111253}: Adiciona verificação de erros durante a inicialização do módulo @code{_socket}.

@item 
gh-111251@footnote{https://github.com/python/cpython/issues/111251}: Corrige @code{_blake2} não verificando erros ao inicializar.

@item 
gh-111233@footnote{https://github.com/python/cpython/issues/111233}: Corrige @ref{c1,,select} não verificando erros ao inicializar.

@item 
gh-111230@footnote{https://github.com/python/cpython/issues/111230}: Corrige @ref{d0,,ssl} não verificando erros ao inicializar.

@item 
gh-111174@footnote{https://github.com/python/cpython/issues/111174}: Corrige travamento em @ref{1231,,io.BytesIO.getbuffer()} chamado repetidamente para BytesIO vazio.

@item 
gh-111187@footnote{https://github.com/python/cpython/issues/111187}: Adia versão de remoção para locale.getdefaultlocale() para Python 3.15.

@item 
gh-111159@footnote{https://github.com/python/cpython/issues/111159}: Corrige comparação de saída @ref{3a,,doctest} para exceções com notas.

@item 
gh-110910@footnote{https://github.com/python/cpython/issues/110910}: Corrige manipulação de estado inválido em @ref{1b5,,asyncio.TaskGroup} e @ref{17bd,,asyncio.Timeout}. Eles agora geram RuntimeError adequado se forem usados incorretamente e são deixados em estado consistente depois disso.

@item 
gh-111092@footnote{https://github.com/python/cpython/issues/111092}: Faz turtledemo ser executado sem root padrão habilitado.

@item 
gh-110944@footnote{https://github.com/python/cpython/issues/110944}: Adiciona suporte a apelido e variáveis de conveniência para completamento automático de @ref{a5,,pdb}

@item 
gh-110745@footnote{https://github.com/python/cpython/issues/110745}: Adicionado o parâmetro `newline' para @ref{e72,,pathlib.Path.read_text()}. Patch por Junya Okabe.

@item 
gh-84583@footnote{https://github.com/python/cpython/issues/84583}: Faz @ref{a5,,pdb} entrar no modo post-mortem mesmo para @ref{18d,,SyntaxError}

@item 
gh-80675@footnote{https://github.com/python/cpython/issues/80675}: Define @code{f_trace_lines = True} em todos os quadros em @ref{235,,pdb.set_trace()}

@item 
gh-110771@footnote{https://github.com/python/cpython/issues/110771}: Expõe as partes de configuração e limpeza de @code{asyncio.run_forever()} como os métodos autônomos @code{asyncio.run_forever_setup()} e @code{asyncio.run_forever_cleanup()}. Isso permite uma integração mais estreita com laços de eventos da GUI.

@item 
gh-110774@footnote{https://github.com/python/cpython/issues/110774}: Suporte para definir o kwarg loop_factory @ref{600,,asyncio.Runner} em @ref{30c,,unittest.IsolatedAsyncioTestCase}

@item 
gh-110392@footnote{https://github.com/python/cpython/issues/110392}: Corrige @ref{17be,,tty.setraw()} e @ref{176e,,tty.setcbreak()}: anteriormente eles retornavam uma lista parcialmente modificada dos atributos tty originais. @ref{17bf,,tty.cfmakeraw()} e @ref{176f,,tty.cfmakecbreak()} agora fazem uma cópia da lista de caracteres especiais antes de modificá-la.

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: Torna o número de linhas do ponto de interrupção da função mais preciso em @ref{a5,,pdb}

@item 
gh-88434@footnote{https://github.com/python/cpython/issues/88434}: Emite aviso de descontinuação para números não inteiros em funções e métodos @ref{63,,gettext} que consideram formas plurais, mesmo que a tradução não tenha sido encontrada.

@item 
gh-110395@footnote{https://github.com/python/cpython/issues/110395}: Garante que os objetos @ref{17c0,,select.kqueue()} apareçam corretamente como fechados em filhos bifurcados, para evitar operações em um descritor de arquivo inválido.

@item 
gh-110196@footnote{https://github.com/python/cpython/issues/110196}: Adiciona o método @code{__reduce__} a @code{IPv6Address} para manter @code{scope_id}

@item 
gh-109747@footnote{https://github.com/python/cpython/issues/109747}: Melhora os erros para padrões `look-behind' não suportados. Agora re.error é levantada em vez de OverflowError ou RuntimeError para largura muito grande do padrão `look-behind.'

@item 
gh-109466@footnote{https://github.com/python/cpython/issues/109466}: Adiciona a propriedade @ref{1fb,,ipaddress.IPv4Address.ipv6_mapped}, que retorna o endereço IPv6 mapeado para IPv4.

@item 
gh-85098@footnote{https://github.com/python/cpython/issues/85098}: Implementa a CLI do módulo @ref{d8,,symtable} e melhorar o repr de @ref{17c1,,Symbol}.

@item 
gh-108791@footnote{https://github.com/python/cpython/issues/108791}: Tratamento de erros aprimorado na interface de linha de comando @ref{a5,,pdb}, fazendo com que ela produza mensagens de erro mais concisas.

@item 
gh-105931@footnote{https://github.com/python/cpython/issues/105931}: Altera @ref{20,,compileall} para remover apenas o prefixo stripdir do caminho completo registrado no arquivo @code{.pyc} compilado, quando o prefixo corresponder ao início do caminho completo em sua totalidade. Quando o prefixo não corresponder, nenhuma remoção será realizada e um aviso para esse efeito será exibido.

Anteriormente, todos os componentes de caminho do prefixo stripdir que correspondiam ao caminho completo eram removidos, enquanto aqueles que não correspondiam eram deixados sozinhos (incluindo aqueles intercalados entre componentes correspondentes).

@item 
gh-107431@footnote{https://github.com/python/cpython/issues/107431}: Cria os tipos @code{DictProxy} e @code{ListProxy} em @ref{6b2,,tipos Generic Alias} de @ref{97,,multiprocessing.managers} para uso @code{[]} em contextos de tipagem.

@item 
gh-72904@footnote{https://github.com/python/cpython/issues/72904}: Adiciona @ref{1ea,,glob.translate()}. Esta função converte um nome de caminho com curingas de estilo shell em uma expressão regular.

@item 
gh-90026@footnote{https://github.com/python/cpython/issues/90026}: Define @code{USE_XATTRS} no Cygwin para que as funções relacionadas a XATTR no módulo @ref{a1,,os} fiquem disponíveis.

@item 
gh-90890@footnote{https://github.com/python/cpython/issues/90890}: Novos métodos @ref{17c2,,mailbox.Maildir.get_info()}, @ref{17c3,,mailbox.Maildir.set_info()}, @ref{17c4,,mailbox.Maildir.get_flags()}, @ref{17c5,,mailbox.Maildir.set_flags()}, @ref{17c6,,mailbox.Maildir.add_flag()}, @ref{17c7,,mailbox.Maildir.remove_flag()}. Esses métodos aceleram o acesso às informações e/ou sinalizadores de uma mensagem e são úteis quando não é necessário acessar o conteúdo da mensagem, como ao iterar sobre um Maildir para encontrar mensagens com sinalizadores específicos.

@item 
gh-102956@footnote{https://github.com/python/cpython/issues/102956}: Corrige o retorno de strings de bytes vazias após uma busca no módulo zipfile

@item 
gh-102895@footnote{https://github.com/python/cpython/issues/102895}: Adicionado um parâmetro @code{local_exit} para @ref{17c8,,code.interact()} para evitar que @code{exit()} e @code{quit} fechem @code{sys.stdin} e levantem @code{SystemExit}.

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: Altera o comportamento de @code{tkinter.Text.count()}. Agora ele sempre retorna um inteiro se uma ou menos opções de contagem forem especificadas. Anteriormente, ele podia retornar uma única contagem como uma tupla de 1 elemento, um inteiro (somente se a opção @code{"update"} fosse especificada) ou @code{None} se nenhum item fosse encontrado. O resultado agora é o mesmo se @code{wantobjects} for definido como @code{0}.

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: Troca o armazenamento dos nomes de pontos de código unicode para usar uma estrutura de dados diferente, um grafo de palavras acíclicas direcionadas@footnote{https://pt.wikipedia.org/wiki/Aut%C3%B4mato_finito_determinístico_acíclico}. Isso torna a biblioteca compartilhada unicodedata cerca de 440 KiB menor. Contribuição de Carl Friedrich Bolz-Tereick usando código do projeto PyPy.

@item 
gh-73561@footnote{https://github.com/python/cpython/issues/73561}: Omite o escopo da interface de um endereço IPv6 quando usado como cabeçalho de host por @ref{6f,,http.client}.

@item 
gh-86826@footnote{https://github.com/python/cpython/issues/86826}: @code{zipinfo} agora oferece suporte ao intervalo completo de valores na string TZ determinado pelo RFC 8536 e detecta todos os formatos inválidos. Ambas as implementações Python e C agora levantam exceções do mesmo tipo em dados inválidos.
@end itemize

@node Testes<19>,Construção<19>,Biblioteca<37>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id196}@anchor{17c9}
@subsubsection Testes



@itemize -

@item 
gh-111808@footnote{https://github.com/python/cpython/issues/111808}: Faz o valor padrão de @code{test.support.infinite_recursion()} ser condicional com base em se otimizações foram usadas ao compilar o interpretador. Isso ajuda com plataformas como WASI cujo tamanho de pilha é muito restrito em construções de depuração.

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: A coleta de cobertura de linha de bibliotecas padrão dentro do conjunto de testes de regressão agora é precisa, bem como muito mais rápida. Patch por Łukasz Langa.

@item 
gh-110367@footnote{https://github.com/python/cpython/issues/110367}: Torna a opção regrtest @code{--verbose3} compatível com as opções @code{--huntrleaks -jN}. O comando @code{./python -m test -j1 -R 3:3 --verbose3} agora funciona como esperado. Patch por Victor Stinner.

@item 
gh-111165@footnote{https://github.com/python/cpython/issues/111165}: Remove as funções não mais utilizadas @code{run_unittest()} e @code{run_doctest()} do módulo @ref{e4,,test.support}.

@item 
gh-110932@footnote{https://github.com/python/cpython/issues/110932}: Corrige regrtest se a variável de ambiente @code{SOURCE_DATE_EPOCH} estiver definida: usar o valor da variável como a semente aleatória. Patch por Victor Stinner.

@item 
gh-110995@footnote{https://github.com/python/cpython/issues/110995}: test_gdb: Corrige a detecção de gdb construído sem suporte a scripts Python. Patch por Victor Stinner.

@item 
gh-110918@footnote{https://github.com/python/cpython/issues/110918}: Os padrões de correspondência de casos de teste especificados pelas opções @code{--match}, @code{--ignore}, @code{--matchfile} e @code{--ignorefile} agora são testados na ordem de especificação, e a última correspondência determina se o caso de teste deve ser executado ou ignorado.

@item 
gh-108747@footnote{https://github.com/python/cpython/issues/108747}: Adiciona o teste de unidade para os ganchos @code{usercustomize} e @code{sitecustomize} de @ref{c7,,site}.
@end itemize

@node Construção<19>,Windows<17>,Testes<19>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id197}@anchor{17ca}
@subsubsection Construção



@itemize -

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: Faz @code{make regen-unicodedata} funcionar para construções fora da árvore do CPython.

@item 
gh-112088@footnote{https://github.com/python/cpython/issues/112088}: Adiciona o script @code{Tools/build/regen-configure.sh} para regenerar o @code{configure} com uma imagem de contêiner do Ubuntu. A imagem do contêiner @code{quay.io/tiran/cpython_autoconf:271} (tiran/cpython_autoconf@footnote{https://github.com/tiran/cpython_autoconf}) não é mais usada. Patch por Victor Stinner.

@item 
gh-111046@footnote{https://github.com/python/cpython/issues/111046}: Para wasi-threads, a memória agora é exportada para corrigir problemas de compatibilidade com alguns tempos de execução wasm.

@item 
gh-110828@footnote{https://github.com/python/cpython/issues/110828}: AIX 32 bits precisa de @code{-latomic} para construir o módulo de extensão @code{_testcapi}.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: As extensões C @code{errno}, @code{md5}, @code{resource}, @code{winsound}, @code{_ctypes_test}, @code{_multiprocessing.posixshmem}, @code{_scproxy}, @code{_stat}, @code{_testimportmultiple} e @code{_uuid} agora são criadas com a @ref{396,,API C limitada}. Patch por Victor Stinner.
@end itemize

@node Windows<17>,macOS<12>,Construção<19>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id198}@anchor{17cb}
@subsubsection Windows



@itemize -

@item 
gh-111856@footnote{https://github.com/python/cpython/issues/111856}: Corrige @ref{db4,,fstat()} em sistemas de arquivos que não oferecem suporte a solicitações de ID de arquivo. Isso inclui FAT32 e exFAT.

@item 
gh-111293@footnote{https://github.com/python/cpython/issues/111293}: Corrige @ref{17cc,,os.DirEntry.inode} eliminando 64 bits mais altos de uma ID de arquivo em alguns sistemas de arquivos no Windows.

@item 
gh-110913@footnote{https://github.com/python/cpython/issues/110913}: O WindowsConsoleIO agora divide corretamente buffers grandes sem dividir sequências UTF-8.
@end itemize

@node macOS<12>,IDLE<16>,Windows<17>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id199}@anchor{17cd}
@subsubsection macOS



@itemize -

@item 
gh-59703@footnote{https://github.com/python/cpython/issues/59703}: Para construções de framework macOS, em @code{getpath.c} use a função @code{dladdr} do sistema para encontrar o caminho para a biblioteca compartilhada em vez de depender de APIs macOS descontinuadas.

@item 
gh-110950@footnote{https://github.com/python/cpython/issues/110950}: Atualiza o instalador macOS para incluir uma correção Tcl/Tk upstream para o aviso @code{Secure coding is not enabled for restorable state!} encontrado no Tkinter no macOS 14 Sonoma.

@item 
gh-111015@footnote{https://github.com/python/cpython/issues/111015}: Garante que IDLE.app e Python Launcher.app sejam instalados com as permissões apropriadas em construções macOS.

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: Atualiza o instalador do macOS para incluir uma correção Tcl/Tk upstream para o erro @code{ttk::ThemeChanged} encontrado no Tkinter.

@item 
gh-92603@footnote{https://github.com/python/cpython/issues/92603}: Atualiza o instalador do macOS para incluir uma correção aceita pelo Tcl/Tk upstream para uma falha encontrada após a destruição da primeira instância @ref{1722,,tkinter.Tk()}.
@end itemize

@node IDLE<16>,Ferramentas/Demos<11>,macOS<12>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id200}@anchor{17ce}
@subsubsection IDLE



@itemize -

@item 
bpo-35668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35668}: Adiciona docstrings ao módulo depurador IDLE. Corrigir dois bugs: inicializar @code{Idb.botframe} (deve estar em Bdb); em @code{Idb.in_rpc_code}, verificar se @code{prev_frame} é @code{None} antes de tentar usá-lo. Expandir bastante o test_debugger.
@end itemize

@node Ferramentas/Demos<11>,API C<20>,IDLE<16>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id201}@anchor{17cf}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-111903@footnote{https://github.com/python/cpython/issues/111903}: Clínica de Argumentos agora oferece suporte à diretiva @code{@@critical_section} que instrui a Clínica de Argumentos a gerar uma seção crítica em torno da chamada de função, que trava o objeto @code{self} em construções @code{--disable-gil}. Patch por Sam Gross.
@end itemize

@node API C<20>,,Ferramentas/Demos<11>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id202}@anchor{17d0}
@subsubsection API C



@itemize -

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Adiciona novamente a função privada @code{_PyThreadState_UncheckedGet()} como um apelido para a nova função pública @ref{371,,PyThreadState_GetUnchecked()}. Patch por Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Restaure a função @code{_PyDict_GetItemStringWithError()} removida. Ela é usada pelo numpy. Patch por Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Restaure as funções privadas, macros e estruturas da API C removidas que não têm substituição simples por enquanto:


@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 por Victor Stinner.

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: Adiciona novamente os includes @code{<ctype.h>} e @code{<unistd.h>} em @code{Python.h}, mas não os inclui na versão limitada da API C 3.13 e mais recentes. Patch por Victor Stinner.

@item 
gh-111956@footnote{https://github.com/python/cpython/issues/111956}: Adiciona API de inicialização única interna: @code{_PyOnceFlag} e @code{_PyOnceFlag_CallOnce}.

@item 
gh-111262@footnote{https://github.com/python/cpython/issues/111262}: Adiciona funções @ref{341,,PyDict_Pop()} e @ref{342,,PyDict_PopString()}: remover uma chave de um dicionário e, opcionalmente, retornar o valor removido. Isso é semelhante a @ref{343,,dict.pop()}, mas sem o valor padrão e não levantando @ref{344,,KeyError} se a chave estiver faltando. Patch por Stefan Behnel e Victor Stinner.

@item 
gh-111863@footnote{https://github.com/python/cpython/issues/111863}: Renomeia @code{Py_NOGIL} para @code{Py_GIL_DISABLED}. Patch por Hugo van Kemenade.

@item 
gh-111138@footnote{https://github.com/python/cpython/issues/111138}: Adiciona as funções @ref{35b,,PyList_Extend()} e @ref{35c,,PyList_Clear()}: semelhantes aos métodos Python @code{list.extend()} e @code{list.clear()}. Patch por Victor Stinner.

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: No Windows, @code{Python.h} não inclui mais o arquivo de cabeçalho padrão @code{<stddef.h>}. Se necessário, ele deve ser incluído explicitamente. Patch por Victor Stinner.

@item 
gh-111569@footnote{https://github.com/python/cpython/issues/111569}: Implementa “Python Critical Sections” de 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}. Essas são macros para ajudar a substituir a GIL por travas por objeto na construção com @code{--disable-gil} do CPython. As macros são no-ops na construção padrão.

@item 
gh-111506@footnote{https://github.com/python/cpython/issues/111506}: Na versão limitada 3.13 da API C, a função @ref{8af,,Py_SET_REFCNT()} agora é implementada como uma chamada de função opaca. Patch por Victor Stinner.

@item 
gh-108082@footnote{https://github.com/python/cpython/issues/108082}: Adiciona a função @ref{34c,,PyErr_FormatUnraisable()}.

@item 
gh-110964@footnote{https://github.com/python/cpython/issues/110964}: Move as funções privadas não documentadas _PyArg e a estrutura _PyArg_Parser para a API C interna (@code{pycore_modsupport.h}). Patch por Victor Stinner.

@item 
gh-110815@footnote{https://github.com/python/cpython/issues/110815}: Suporte a nomes de palavras reservadas não ASCII em @ref{383,,PyArg_ParseTupleAndKeywords()}.

@item 
gh-109587@footnote{https://github.com/python/cpython/issues/109587}: Introduzida @code{PyUnstable_PerfTrampoline_CompileCode()}, @code{PyUnstable_PerfTrampoline_SetPersistAfterFork()} e @code{PyUnstable_CopyPerfMapFile()}. Essas funções permitem que módulos de extensão inicializem trampolins avidamente, depois que o aplicativo é “aquecido”. Isso torna possível ter perf-trampolines em execução de forma sempre habilitada.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Adiciona a função @ref{36f,,PySys_Audit()} à API C limitada. Patch por Victor Stinner.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Adiciona @ref{390,,PyMem_RawMalloc()}, @ref{391,,PyMem_RawCalloc()}, @ref{392,,PyMem_RawRealloc()} e @ref{393,,PyMem_RawFree()} à API C limitada. Patch por Victor Stinner.

@item 
gh-106672@footnote{https://github.com/python/cpython/issues/106672}: Funções @ref{387,,PyDict_GetItem()}, @ref{388,,PyDict_GetItemString()}, @ref{37f,,PyMapping_HasKey()}, @ref{381,,PyMapping_HasKeyString()}, @ref{37b,,PyObject_HasAttr()}, @ref{37d,,PyObject_HasAttrString()} e @ref{389,,PySys_GetObject()}, que limpam todos os erros ocorridos durante a chamada da função, agora os relatam usando @ref{1f7,,sys.unraisablehook()}.

@item 
gh-67565@footnote{https://github.com/python/cpython/issues/67565}: Remove a verificação redundante de contiguidade C em @code{getargs.c}, @ref{10,,binascii}, @ref{d0,,ssl} e Clínica de Argumentos. Remendado por Stefan Krah e Furkan Onder
@end itemize

@node Python 3 13 0 alpha 1,Python 3 12 0 beta 1,Python 3 13 0 alpha 2,Changelog
@anchor{whatsnew/changelog python-3-13-0-alpha-1}@anchor{17d1}
@subsection Python 3.13.0 alpha 1


`Data de lançamento: 2023-10-13'

@menu
* Segurança: Segurança<17>. 
* Núcleo e embutidos: Núcleo e embutidos<34>. 
* Biblioteca: Biblioteca<38>. 
* Documentação: Documentação<16>. 
* Testes: Testes<20>. 
* Construção: Construção<20>. 
* Windows: Windows<18>. 
* macOS: macOS<13>. 
* IDLE: IDLE<17>. 
* Ferramentas/Demos: Ferramentas/Demos<12>. 
* API C: API C<21>. 

@end menu

@node Segurança<17>,Núcleo e embutidos<34>,,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id203}@anchor{17d2}
@subsubsection Segurança



@itemize -

@item 
gh-108310@footnote{https://github.com/python/cpython/issues/108310}: Corrigido um problema em que instâncias de @ref{8f0,,ssl.SSLSocket} eram vulneráveis a um desvio do handshake TLS e incluíam proteções (como verificação de certificado) e tratavam dados não criptografados enviados como se fossem dados criptografados TLS pós-handshake. Problema de segurança relatado como 
@geindex Common Vulnerabilities and Exposures; CVE 2023-40217
CVE 2023-40217@footnote{https://www.cve.org/CVERecord?id=CVE-2023-40217} por Aapo Oksman. Patch por Gregory P. Smith.

@item 
gh-107774@footnote{https://github.com/python/cpython/issues/107774}: PEP 669 especifica que @code{sys.monitoring.register_callback} gerará um evento de auditoria. Pré-lançamentos do Python 3.12 não geravam o evento de auditoria. Isso agora foi corrigido.

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: Revertida a alteração de melhoria de segurança @ref{50,,email.utils} lançada na 3.12beta4 que involuntariamente fez com que @ref{1e1,,email.utils.getaddresses} falhasse ao analisar endereços de e-mail com uma vírgula no campo de nome entre aspas. Veja gh-106669@footnote{https://github.com/python/cpython/issues/106669}.

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Atualiza nosso novo código HACL* embutido @ref{68,,hashlib} do upstream. O SHA2 embutido deve ser mais rápido e um problema com SHA3 em plataformas de 32 bits foi corrigido.

@item 
gh-102509@footnote{https://github.com/python/cpython/issues/102509}: Começa a inicializar @code{ob_digit} durante a criação de objetos @ref{588,,PyLongObject}. Patch por Illia Volochii.
@end itemize

@node Núcleo e embutidos<34>,Biblioteca<38>,Segurança<17>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id204}@anchor{17d3}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-110782@footnote{https://github.com/python/cpython/issues/110782}: Corrige o travamento quando @ref{15d,,typing.TypeVar} é construído com um argumento nomeado. Patch por Jelle Zijlstra.

@item 
gh-110752@footnote{https://github.com/python/cpython/issues/110752}: Redefine @code{ceval.eval_breaker} em @code{interpreter_clear()}

@item 
gh-110721@footnote{https://github.com/python/cpython/issues/110721}: Usa a implementação de @ref{fe,,traceback} para a funcionalidade padrão @code{PyErr_Display()}. Patch por Pablo Galindo

@item 
gh-110696@footnote{https://github.com/python/cpython/issues/110696}: Corrige mensagem de erro incorreta para descompactação de argumento inválido. Patch por Pablo Galindo

@item 
gh-104169@footnote{https://github.com/python/cpython/issues/104169}: Divide o tokenizador em dois diretórios separados: - Uma parte inclui a lógica de produção do lexema real e fica em @code{Parser/lexer}. - A segunda parte encapsula o lexer de acordo com os diferentes modos de tokenização que temos (string, utf-8, file, interactive, readline) e fica em @code{Parser/tokenizer}.

@item 
gh-110688@footnote{https://github.com/python/cpython/issues/110688}: Remove o método não documentado @code{test_c_api} de @ref{5d9,,set}, que foi definido apenas para fins de teste em @code{Py_DEBUG}. Agora temos testes CAPI adequados.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Corrige um vazamento de referência ao executar com 
@geindex PYTHONUOPS
@geindex variável de ambiente; PYTHONUOPS
@code{PYTHONUOPS} ou @ref{176,,-X uops 1} habilitado.

@item 
gh-110514@footnote{https://github.com/python/cpython/issues/110514}: Adiciona @code{PY_THROW} para eventos @ref{1546,,sys.setprofile()}

@item 
gh-110489@footnote{https://github.com/python/cpython/issues/110489}: Otimiza @ref{1405,,math.ceil()} quando a entrada for exatamente um float, resultando em uma melhoria de cerca de 10%.

@item 
gh-110455@footnote{https://github.com/python/cpython/issues/110455}: Guarda @code{assert(tstate->thread_id > 0)} com @code{#ifndef HAVE_PTHREAD_STUBS}. Isso permite que construções do pydebug funcionem sob WASI, o qual (atualmente) não tem suporte a threads.

@item 
gh-110309@footnote{https://github.com/python/cpython/issues/110309}: Remove nós constantes vazios desnecessários no final das especificações da f-strings.

@item 
gh-110259@footnote{https://github.com/python/cpython/issues/110259}: Identifica corretamente a especificação de formato em f-strings (com aspas simples ou triplas) que tenham várias linhas na parte da expressão e incluam uma especificação de formatação. Patch por Pablo Galindo

@item 
gh-110237@footnote{https://github.com/python/cpython/issues/110237}: Corrige verificações de erro ausentes para chamadas para @code{PyList_Append} em @code{_PyEval_MatchClass}.

@item 
gh-110164@footnote{https://github.com/python/cpython/issues/110164}: regrtest: Se a variável de ambiente @code{SOURCE_DATE_EPOCH} for definida, o regrtest agora desabilita a aleatorização de testes. Patch por Victor Stinner.

@item 
gh-109889@footnote{https://github.com/python/cpython/issues/109889}: Corrige o algoritmo de detecção de NOP redundante do compilador para ignorar NOPs sem número de linha ao procurar o número de linha da próxima instrução.

@item 
gh-109853@footnote{https://github.com/python/cpython/issues/109853}: @code{sys.path[0]} agora está definido corretamente para subinterpretadores.

@item 
gh-109923@footnote{https://github.com/python/cpython/issues/109923}: Define o número da linha no @code{POP_TOP} que segue um @code{RETURN_GENERATOR}.

@item 
gh-105716@footnote{https://github.com/python/cpython/issues/105716}: Subinterpretadores agora lidam corretamente com o caso em que eles têm threads em execução em segundo plano. Antes, tais threads interferiam na limpeza e destruição delas, assim como impediam a execução de outro script.

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: O eval_breaker interno e os sinalizadores de suporte, além da versão de monitoramento, foram mesclados em um único inteiro atômico para acelerar as verificações.

@item 
gh-109823@footnote{https://github.com/python/cpython/issues/109823}: Corrige bug em que o compilador não ajusta rótulos ao remover um bloco básico vazio que é um alvo de salto.

@item 
gh-109793@footnote{https://github.com/python/cpython/issues/109793}: O thread principal não sai mais prematuramente quando um subinterpretador é limpo durante a finalização do tempo de execução. O bug era um problema particularmente porque, quando acionado, o processo Python sempre retornava com um exitcode 0, mesmo se falhasse.

@item 
gh-109719@footnote{https://github.com/python/cpython/issues/109719}: Corrige rótulos de alvos de salto ausentes quando o compilador reordena blocos frios/quentes.

@item 
gh-109595@footnote{https://github.com/python/cpython/issues/109595}: Adiciona a opção de linha de comando @ref{176,,-X cpu_count} para substituir os resultados de retorno de @ref{1c5,,os.cpu_count()} e @ref{1c4,,os.process_cpu_count()}. Esta opção é útil para usuários que precisam limitar os recursos da CPU de um sistema de contêiner sem ter que modificar o contêiner (código da aplicação). Patch por Donghee Na.

@item 
gh-109627@footnote{https://github.com/python/cpython/issues/109627}: Corrige bug em que o compilador não atribui um novo rótulo de alvo de salto a um pequeno bloco de saída duplicado.

@item 
gh-109596@footnote{https://github.com/python/cpython/issues/109596}: Corrige alguns tokens na gramática que estavam marcados incorretamente como palavras-chave suaves. Corrigir também alguns nomes de regras repetidos e garantir que regras repetidas não sejam permitidas. Patch por Pablo Galindo.

@item 
gh-109496@footnote{https://github.com/python/cpython/issues/109496}: Em um Python construído em modo de depuração, @ref{56f,,Py_DECREF()} agora chama @code{_Py_NegativeRefcount()} se o objeto for um ponteiro pendente para memória desalocada: memória preenchida com @code{0xDD} “byte morto” pelo gancho de depuração nos alocadores de memória. A correção consiste em verificar a contagem de referências `antes' de verificar @code{_Py_IsImmortal()}. Patch por Victor Stinner.

@item 
gh-107265@footnote{https://github.com/python/cpython/issues/107265}: Faz deopt de opcodes ocultos pelo executor quando o opcode base é necessário

@item 
gh-109371@footnote{https://github.com/python/cpython/issues/109371}: Feito deopt corretamente nas instruções para inicialização de ferramenta e modificada a asserção incorreta na instrumentação, quando uma ferramenta anterior já define eventos INSTRUCTION

@item 
gh-105658@footnote{https://github.com/python/cpython/issues/105658}: Corrige bug em que o rastreamento de linha de um bloco except terminando com uma condicional inclui um evento em excesso com a linha da expressão condicional.

@item 
gh-109219@footnote{https://github.com/python/cpython/issues/109219}: Corrige escopos de parâmetros de tipo de compilação que usam um nome que também é livre em um escopo interno.

@item 
gh-109351@footnote{https://github.com/python/cpython/issues/109351}: Corrige falha ao compilar um AST inválido envolvendo uma expressão nomeada (morsa).

@item 
gh-109341@footnote{https://github.com/python/cpython/issues/109341}: Corrige falha ao compilar um AST inválido envolvendo um @ref{17d4,,ast.TypeAlias}.

@item 
gh-109195@footnote{https://github.com/python/cpython/issues/109195}: Corrige o local de origem para a instrução @code{LOAD_*} que precede um @code{LOAD_SUPER_ATTR} para carregar a variável global @code{super} (ou variável de sombreamento) para que ela abranja apenas o nome @code{super} e não os parênteses seguintes.

@item 
gh-109256@footnote{https://github.com/python/cpython/issues/109256}: Os IDs de opcode para opcodes especializados são alocados em seu próprio intervalo para melhorar a estabilidade dos IDs para os opcodes ‘reais’.

@item 
gh-109216@footnote{https://github.com/python/cpython/issues/109216}: Corrige possível vazamento de memória em @ref{17d5,,BUILD_MAP}.

@item 
gh-109207@footnote{https://github.com/python/cpython/issues/109207}: Corrige um SystemError em @code{__repr__} do objeto de entrada da tabela de símbolos.

@item 
gh-109179@footnote{https://github.com/python/cpython/issues/109179}: Corrige bug em que a exibição do traceback C descarta notas de @ref{18d,,SyntaxError}.

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: Não permitir escopos aninhados (lambdas, expressões geradoras e compreensões) dentro de escopos de anotação PEP 695 que estejam aninhados dentro de classes.

@item 
gh-109156@footnote{https://github.com/python/cpython/issues/109156}: Adiciona testes para instruções de desinstrumentação, mantendo a instrumentação para linhas

@item 
gh-109114@footnote{https://github.com/python/cpython/issues/109114}: Relaxa a detecção da mensagem de erro para lambdas inválidas dentro de f-strings para não procurar campos de substituição arbitrários e evitar falsos positivos. Patch por Pablo Galindo

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: Adiciona um novo opcode @ref{17d6,,CALL_KW}, usado para chamadas que contêm argumentos nomeados. Além disso, corrige uma possível falha ao pular chamadas de método em um depurador.

@item 
gh-109052@footnote{https://github.com/python/cpython/issues/109052}: Use o opcode base ao comparar objetos de código para evitar interferência da instrumentação

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: Corrige falha do interpretador quando uma exceção NameError é levantada dentro dos parâmetros de tipo de uma classe genérica.

@item 
gh-88943@footnote{https://github.com/python/cpython/issues/88943}: Melhora o erro de sintaxe para caracteres não ASCII que seguem um literal numérico. Agora, ele aponta para o caractere não ASCII inválido, não para o literal numérico válido.

@item 
gh-108976@footnote{https://github.com/python/cpython/issues/108976}: Corrige falha que ocorre após desinstrumentar um objeto código em uma função de retorno de monitoramento.

@item 
gh-108732@footnote{https://github.com/python/cpython/issues/108732}: Torna as variáveis de iteração de compreensões de escopo de módulo e classe visíveis para pdb e outras ferramentas que usam @code{frame.f_locals} novamente.

@item 
gh-108959@footnote{https://github.com/python/cpython/issues/108959}: Corrigir o posicionamento do cursor para locais de erro em operações binárias e de subscrito que envolvem parênteses e espaços não semânticos. Patch por Pablo Galindo.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Corrige uma falha ao executar com 
@geindex PYTHONUOPS
@geindex variável de ambiente; PYTHONUOPS
@code{PYTHONUOPS} ou @ref{176,,-X uops} habilitado e ocorre um erro durante a otimização.

@item 
gh-108727@footnote{https://github.com/python/cpython/issues/108727}: Define @code{tp_dealloc} para @code{CounterOptimizer_Type}. Isso corrige uma falha de segmentação na desalocação.

@item 
gh-108520@footnote{https://github.com/python/cpython/issues/108520}: Corrige @code{multiprocessing.synchronize.SemLock.__setstate__()} para inicializar corretamente @code{multiprocessing.synchronize.SemLock._is_fork_ctx}. Isso corrige uma regressão ao passar um SemLock entre processos aninhados.

Renomeia @code{multiprocessing.synchronize.SemLock.is_fork_ctx} para @code{multiprocessing.synchronize.SemLock._is_fork_ctx} para evitar expô-lo como API pública.

@item 
gh-108654@footnote{https://github.com/python/cpython/issues/108654}: Restaura os locais sombreados por uma compreensão embutida se a compreensão levantar uma exceção.

@item 
gh-108488@footnote{https://github.com/python/cpython/issues/108488}: Altera a inicialização das entradas de cache em linha para que a entrada de cache para @code{JUMP_BACKWARD} seja inicializada com zero, em vez do valor @code{adaptive_counter_warmup()} usado para todas as outras instruções. Este contador, único entre as instruções, conta a partir de zero.

@item 
gh-108716@footnote{https://github.com/python/cpython/issues/108716}: Desativa o congelamento profundo de objetos código. Os módulos permanecem congelados, de modo que não é necessária uma pesquisa no sistema de arquivos para módulos comuns.

@item 
gh-108614@footnote{https://github.com/python/cpython/issues/108614}: Adiciona a instrução RESUME_CHECK para evitar ter que manipular instrumentação, sinais e alternância de contextos no mecanismo de execução de nível 2.

@item 
gh-108487@footnote{https://github.com/python/cpython/issues/108487}: Move um assert que causaria uma falha espúria em um caso tortuoso que deveria apenas acionar a desotimização.

@item 
gh-106176@footnote{https://github.com/python/cpython/issues/106176}: Usa um @code{WeakValueDictionary} para rastrear as listas que contêm os módulos que cada thread está importando no momento. Isso ajuda a evitar um vazamento de referência, que mantém a lista ativa por mais tempo do que o necessário. Referências fracas são usadas, pois o GC não pode interromper a limpeza.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: O estágio de construção regen-opcode foi removido e seu trabalho agora é feito em regen-cases.

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: Corrige número de linha ausente em @ref{70c,,JUMP_BACKWARD} no final de um laço for.

@item 
gh-108113@footnote{https://github.com/python/cpython/issues/108113}: A função embutida @ref{192,,compile()} agora pode aceitar um novo sinalizador, @code{ast.PyCF_OPTIMIZED_AST}, que é semelhante a @code{ast.PyCF_ONLY_AST} exceto que o @code{AST} retornado é otimizado de acordo com o valor do argumento @code{optimize}.

@ref{1a8,,ast.parse()} agora aceita um argumento opcional @code{optimize} que é passado para o @ref{192,,compile()} embutido. Isto torna possível obter um @code{AST} otimizado.

@item 
gh-107971@footnote{https://github.com/python/cpython/issues/107971}: Os IDs de opcode são gerados a partir de bytecodes.c em vez de serem codificados em opcode.py.

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: Melhora a mensagem de erro para chamadas de função com argumentos nomeados inválidos. Patch por Pablo Galindo.

@item 
gh-108390@footnote{https://github.com/python/cpython/issues/108390}: Levanta uma exceção ao definir um evento não local (@code{RAISE}, @code{EXCEPTION_HANDLED}, etc.) em @code{sys.monitoring.set_local_events}.

Corrige travamento ao rastrear chamadas recursivas para classes Python.

@item 
gh-108035@footnote{https://github.com/python/cpython/issues/108035}: Remove a estrutura @code{_PyCFrame}, movendo o ponteiro para o quadro do interpretador atual de volta ao estado da thread, como era na versão 3.10 e anteriores. O @code{_PyCFrame} existia como uma otimização de desempenho para rastreamento. Desde que a PEP 669 foi implementada, essa otimização não se aplica mais.

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: Corrige abort/segfault ao usar todos os oito slots do observador de tipo, em plataformas onde @code{char} tem sinal por padrão.

@item 
gh-106581@footnote{https://github.com/python/cpython/issues/106581}: Corrige possíveis falhas de asserção e eventos de instrumentação ausentes quando 
@geindex PYTHONUOPS
@geindex variável de ambiente; PYTHONUOPS
@code{PYTHONUOPS} ou @ref{176,,-X uops} estiver habilitado.

@item 
gh-107526@footnote{https://github.com/python/cpython/issues/107526}: Reverte a conversão de @code{vars}, @code{dir}, @code{next}, @code{getattr} e @code{iter} para clínica de argumentos.

@item 
gh-84805@footnote{https://github.com/python/cpython/issues/84805}: Gera assinatura automaticamente para funções de extensão @ref{151c,,METH_NOARGS} e @ref{1550,,METH_O}.

@item 
gh-107758@footnote{https://github.com/python/cpython/issues/107758}: Torna a rotina @code{dump_stack()} usada pelo recurso @code{lltrace} (depuração de interpretador de baixo nível) robusta contra recursão, garantindo que ela nunca chame um método @code{__repr__} implementado em Python. Além disso, faça com que a saída semelhante para UOPs de Nível 2 apareça em @code{stdout} (em vez de @code{stderr}), para corresponder ao código @code{lltrace} em ceval.c.

@item 
gh-107659@footnote{https://github.com/python/cpython/issues/107659}: Adiciona docstrings para @ref{17d7,,ctypes.pointer()} e @ref{17d8,,ctypes.POINTER()}.

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: Modifica o bytecode para que o chamável real para um @ref{707,,CALL} esteja em uma posição consistente na pilha (independentemente de as otimizações de chamada de método vinculado estarem ativas ou não).

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}:  Regressão de desempenho corrigida em @code{sys.settrace}.

@item 
gh-107724@footnote{https://github.com/python/cpython/issues/107724}: Nas versões de pré-lançamento da 3.12, até a rc1, a função de retorno de chamada sys.monitoring para o evento @code{PY_THROW} não continha o terceiro argumento, exception. Isso já foi corrigido.

@item 
gh-84436@footnote{https://github.com/python/cpython/issues/84436}: Ignora modificações na contagem de referências para muitos objetos imortais conhecidos.

@item 
gh-107596@footnote{https://github.com/python/cpython/issues/107596}: Especializa a subscrição de objetos @ref{44c,,str} por índices @ref{257,,int}.

@item 
gh-107080@footnote{https://github.com/python/cpython/issues/107080}: As construções de referências de rastreamento (@code{--with-trace-refs}) estavam travando quando usadas com subinterpretadores isolados. O estado global problemático foi isolado para cada interpretador. Além de corrigir as falhas, essa alteração não afeta os usuários.

@item 
gh-107557@footnote{https://github.com/python/cpython/issues/107557}: Gera os casos necessários para o interpretador abstrato barebones de nível 2 para passagens de otimização em CPython.

@item 
gh-106608@footnote{https://github.com/python/cpython/issues/106608}: Torna @code{_PyUOpExecutorObject} de comprimento variável.

@item 
gh-100964@footnote{https://github.com/python/cpython/issues/100964}: Limpa o estado de exceção dos geradores após @code{return} para interromper os ciclos de referência.

@item 
gh-107455@footnote{https://github.com/python/cpython/issues/107455}: Melhora as mensagens de erro ao converter um tipo incompatível para @ref{17d9,,ctypes.c_char_p}, @ref{17da,,ctypes.c_wchar_p} e @ref{17db,,ctypes.c_void_p}.

@item 
gh-107263@footnote{https://github.com/python/cpython/issues/107263}: Aumenta o limite de recursão em C para funções que não sejam o interpretador principal de 800 para 1500. Isso deve permitir que funções como @code{list.__repr__} e @code{json.dumps} manipulem todas as entradas possíveis antes da versão 3.12.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Corrige um problema que causava a leitura incorreta de caches inline ao executar com 
@geindex PYTHONUOPS
@geindex variável de ambiente; PYTHONUOPS
@code{PYTHONUOPS} ou @ref{176,,-X uops} habilitados.

@item 
gh-104432@footnote{https://github.com/python/cpython/issues/104432}: Corrige possível acesso desalinhado à memória em APIs C envolvendo sequências retornadas de ponteiros @code{char *} dentro dos módulos @ref{66,,grp} e @ref{cc,,socket}. Isso foi revelado usando uma compilação @code{-fsaniziter=alignment} no macOS ARM. Patch por Christopher Chavez.

@item 
gh-106078@footnote{https://github.com/python/cpython/issues/106078}: Isola @code{_decimal} (aplicar 
@geindex Propostas de Melhorias do Python; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}). Patch por Charlie Zhao.

@item 
gh-106898@footnote{https://github.com/python/cpython/issues/106898}: Adiciona a exceção como terceiro argumento às funções de retorno @code{PY_UNIND} em @code{sys.monitoring}. Isso torna o callback @code{PY_UNWIND} consistente com as outras funções de retorno de tratamento de exceções.

@item 
gh-106895@footnote{https://github.com/python/cpython/issues/106895}: Levanta um @code{ValueError} quando uma função de callback de monitoramento retornar @code{DISABLE} para eventos que não podem ser desabilitados localmente.

@item 
gh-106897@footnote{https://github.com/python/cpython/issues/106897}: Adiciona um evento @code{RERAISE} a @code{sys.monitoring}, que ocorre quando uma exceção é reativada, seja explicitamente por uma instrução @code{raise} simples ou implicitamente em um bloco @code{except} ou @code{finally}.

@item 
gh-77377@footnote{https://github.com/python/cpython/issues/77377}: Garante que objetos de sincronização multiprocessamento criados em um contexto de fork não sejam enviados para um processo diferente criado em um contexto de geração. Isso transforma um erro de segmentação em um erro de tempo de execução acionável no processo pai.

@item 
gh-106931@footnote{https://github.com/python/cpython/issues/106931}: Objetos string alocados estaticamente agora são internados globalmente em vez de por interpretador. Isso corrige uma situação em que tal string só seria internada em um único interpretador. Objetos string normais não são afetados.

@item 
gh-104621@footnote{https://github.com/python/cpython/issues/104621}: Módulos não suportados agora sempre falham na importação.

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: Adicionado @code{dbm.ndbm.ndbm.clear()} a @ref{34,,dbm.ndbm}. Patch por Donghee Na.

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: Adiciona @code{dbm.gnu.gdbm.clear()} a @ref{33,,dbm.gnu}. Patch por Donghee Na.

@item 
gh-107015@footnote{https://github.com/python/cpython/issues/107015}: Os tokens ASYNC e AWAIT foram removidos da gramática, o que elimina a possibilidade de criar as palavras reservadas contextuais @code{async} e @code{await} ao usar @code{feature_version<7} em @ref{1a8,,ast.parse()}.

@item 
gh-106917@footnote{https://github.com/python/cpython/issues/106917}: Corrige chamadas ao método @ref{4db,,super()} no estilo classmethod (ou seja, onde o segundo argumento para @ref{4db,,super()}, ou o segundo argumento implícito extraído de @code{self/cls} no caso de super com argumento zero, é um tipo) quando o alvo da chamada não é um classmethod.

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: O Python não trava mais devido a uma corrida pouco frequente ao inicializar strings internas por interpretador. A falha se manifestava quando o interpretador era finalizado.

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: O Python não trava mais devido a uma corrida pouco frequente na configuração de @code{Py_FileSystemDefaultEncoding} e @code{Py_FileSystemDefaultEncodeErrors} (ambos descontinuados), ao inicializar simultaneamente dois subinterpretadores isolados. Agora, eles são definidos apenas durante a inicialização em tempo de execução.

@item 
gh-106908@footnote{https://github.com/python/cpython/issues/106908}: Corrige vários travamentos, vazamentos de referência, falhas de teste e bugs de rastreamento/introspecção ao executar com 
@geindex PYTHONUOPS
@geindex variável de ambiente; PYTHONUOPS
@code{PYTHONUOPS} ou @ref{176,,-X uops} habilitado.

@item 
gh-106092@footnote{https://github.com/python/cpython/issues/106092}: Corrige uma falha de segmentação causada por um bug de uso após liberação em @code{frame_dealloc} quando a lixeira atrasa a desalocação de um @code{PyFrameObject}.

@item 
gh-106485@footnote{https://github.com/python/cpython/issues/106485}: Reduz o número de dicionários de instâncias materializadas, desmaterializando-os quando possível.

@item 
gh-106719@footnote{https://github.com/python/cpython/issues/106719}: Não suprime mais erros arbitrários nos getters e setters @code{__annotations__} nos tipos type e module.

@item 
gh-106723@footnote{https://github.com/python/cpython/issues/106723}: Propaga @code{frozen_modules} para interpretadores de processos gerados por multiprocessamento.

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: Divide @code{LOAD_ATTR_INSTANCE_VALUE} em micro-ops.

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: Divide as especializações @ref{17dc,,LOAD_GLOBAL} em micro-ops.

@item 
gh-106597@footnote{https://github.com/python/cpython/issues/106597}: Uma nova estrutura de depuração de offsets foi adicionada ao @code{_PyRuntimeState} que ajudará depuradores e profilers fora do processo a obter as posições para estruturas relevantes do interpretador de uma forma independente de como o Python foi compilado e que não exija a cópia dos cabeçalhos. Patch por Pablo Galindo

@item 
gh-106487@footnote{https://github.com/python/cpython/issues/106487}: Permite que o argumento `count' de @ref{19a,,str.replace()} seja nomeado. Patch por Hugo van Kemenade.

@item 
gh-96844@footnote{https://github.com/python/cpython/issues/96844}: Melhora a mensagem de erro de @ref{17dd,,list.remove()}. Patch por Donghee Na.

@item 
gh-81283@footnote{https://github.com/python/cpython/issues/81283}: O compilador agora remove recuos de docstrings. Reduz o tamanho do arquivo @code{pyc} em 5% quando o módulo é amplamente documentado. Essa alteração afeta @code{__doc__}, portanto, ferramentas como doctest serão afetadas.

@item 
gh-106396@footnote{https://github.com/python/cpython/issues/106396}: Quando a especificação de formato de uma expressão de f-string está vazia, o analisador agora gera um nó @ref{17de,,ast.JoinedStr} vazio para ela, em vez de um nó @ref{17de,,ast.JoinedStr} de um elemento com uma string vazia @ref{2b9,,ast.Constant}.

@item 
gh-100288@footnote{https://github.com/python/cpython/issues/100288}: Especializa @ref{4de,,LOAD_ATTR} para não descritores na classe. Adiciona @code{LOAD_ATTR_NONDESCRIPTOR_WITH_VALUES} e @code{LOAD_ATTR_NONDESCRIPTOR_NO_DICT}.

@item 
gh-106008@footnote{https://github.com/python/cpython/issues/106008}: Corrige possíveis vazamentos de referência ao não otimizar comparações com @ref{675,,None} no compilador de bytecode.

@item 
gh-106145@footnote{https://github.com/python/cpython/issues/106145}: Torna @code{end_lineno} e @code{end_col_offset} obrigatórios em nós AST @code{type_param}.

@item 
gh-106213@footnote{https://github.com/python/cpython/issues/106213}: Alterada a forma como os trampolins de chamada do Emscripten funcionam para compatibilidade com a integração Wasm/JS Promise.

@item 
gh-106182@footnote{https://github.com/python/cpython/issues/106182}: @ref{c74,,sys.getfilesystemencoding()} e @ref{d07,,sys.getfilesystemencodeerrors} agora retornam objetos Unicode internalizados.

@item 
gh-106210@footnote{https://github.com/python/cpython/issues/106210}: Removido o trampolim de importação do Emscripten, pois não era mais necessário para o Pyodide.

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: Adicionado um novo otimizador e interpretador de rastreamento experimental (também conhecido como “nível 2”). Atualmente, isso é pessimista, então não use ainda — esta é uma infraestrutura para que possamos experimentar com passes de otimização. Para habilitá-lo, passe @code{-Xuops} ou defina @code{PYTHONUOPS=1}. Para obter a saída de depuração, defina @code{PYTHONUOPSDEBUG=N}, onde @code{N} é um nível de depuração (0-4, onde 0 indica ausência de saída de depuração e 4 indica excesso de verbosidade).

@item 
gh-105775@footnote{https://github.com/python/cpython/issues/105775}: @ref{17df,,LOAD_CLOSURE} agora é uma pseudo-op.

@item 
gh-105730@footnote{https://github.com/python/cpython/issues/105730}: Permite qualquer chamada que não seja de objetos de tipo como predicado de condição em @ref{1670,,BaseExceptionGroup.split()} e @ref{17b4,,BaseExceptionGroup.subgroup()}.

@item 
gh-105979@footnote{https://github.com/python/cpython/issues/105979}: Corrige falha em @code{_imp.get_frozen_object()} devido a tratamento incorreto de exceções.

@item 
gh-106003@footnote{https://github.com/python/cpython/issues/106003}: Adiciona uma nova instrução @ref{17e0,,TO_BOOL}, que realiza conversões booleanas para @ref{17e1,,POP_JUMP_IF_TRUE}, @ref{17e2,,POP_JUMP_IF_FALSE} e @ref{17e3,,UNARY_NOT} (que agora esperam valores @ref{468,,bool} exatos). Além disso, modifique o oparg de @ref{970,,COMPARE_OP} para incluir um sinalizador opcional de “conversão booleana”.

@item 
gh-98931@footnote{https://github.com/python/cpython/issues/98931}: Garante que mensagens de erro personalizadas @ref{18d,,SyntaxError} sejam levantadas para importações inválidas com múltiplos destinos. Patch por Pablo Galindo

@item 
gh-105724@footnote{https://github.com/python/cpython/issues/105724}: Melhora as mensagens de erro @code{assert} fornecendo o intervalo exato de erro.

@item 
gh-105908@footnote{https://github.com/python/cpython/issues/105908}: Corrige o bug em que gh-99111@footnote{https://github.com/python/cpython/issues/99111} quebrava a importação futura @code{barry_as_FLUFL} no REPL do Python.

@item 
gh-105840@footnote{https://github.com/python/cpython/issues/105840}: Corrige possíveis travamentos ao especializar chamadas de função com muitos @code{__defaults__}.

@item 
gh-105831@footnote{https://github.com/python/cpython/issues/105831}: Corrige um bug em uma f-string, onde o uso de uma expressão de depuração (o sinal @code{=}) que aparece na última linha de um arquivo resulta no buffer de depuração que contém o texto da expressão sendo um caractere a menos.

@item 
gh-105800@footnote{https://github.com/python/cpython/issues/105800}: Emite corretamente @ref{466,,SyntaxWarning} em f-strings se sequências inválidas forem usadas. Patch por Pablo Galindo

@item 
gh-105340@footnote{https://github.com/python/cpython/issues/105340}: Inclui a variável de iteração de compreensão em @code{locals()} dentro de uma compreensão de escopo de módulo ou classe.

@item 
gh-105331@footnote{https://github.com/python/cpython/issues/105331}: Levanta @ref{202,,ValueError} se o argumento @code{delay} para @ref{a79,,asyncio.sleep()} for um NaN (correspondente a @ref{69d,,time.sleep()}).

@item 
gh-105587@footnote{https://github.com/python/cpython/issues/105587}: O tempo de execução não pode garantir que objetos imortais não serão mutados por extensões. Portanto, isso modifica _PyStaticObject_CheckRefcnt para avisar em vez de declarar.

@item 
gh-105564@footnote{https://github.com/python/cpython/issues/105564}: Não inclui quebras de linha artificiais no atributo @code{line} de tokens nas APIs do módulo @ref{fb,,tokenize}. Patch por Pablo Galindo

@item 
gh-105549@footnote{https://github.com/python/cpython/issues/105549}: Tokeniza separadamente os tokens @code{NUMBER} e @code{NAME} que não sejam ambíguos. Patch por Pablo Galindo.

@item 
gh-105588@footnote{https://github.com/python/cpython/issues/105588}: Corrige um problema que poderia resultar em travamentos ao compilar nós @ref{8,,ast} malformados.

@item 
gh-100987@footnote{https://github.com/python/cpython/issues/100987}: Permite objetos que não são objetos código como o “executável” em quadros internos. A longo prazo, isso pode ajudar ferramentas como Cython e PySpy a interagirem de forma mais eficiente. A curto prazo, nos permite realizar algumas otimizações de forma mais simples.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs no módulo @ref{12,,builtins}, onde exceções poderiam ser sobrescritas.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bug no compilador, onde uma exceção poderia ser sobrescrita.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Melhora o tratamento de erros em @ref{17e4,,PyUnicode_BuildEncodingMap()}, onde uma exceção poderia ser sobrescrita.

@item 
gh-105486@footnote{https://github.com/python/cpython/issues/105486}: Altera a representação da lista de argumentos @code{ParamSpec} em @code{types.GenericAlias}.

@item 
gh-105678@footnote{https://github.com/python/cpython/issues/105678}: Divide a instrução @code{MAKE_FUNCTION} em duas partes: @code{MAKE_FUNCTION}, que cria a função, e @code{SET_FUNCTION_ATTRIBUTE}, que define os atributos da função. Isso torna o efeito de pilha de @code{MAKE_FUNCTION} regular para facilitar a otimização e a geração de código.

@item 
gh-105435@footnote{https://github.com/python/cpython/issues/105435}: Corrige o caractere de quebra de linha falso se o arquivo terminar em um comentário sem quebra de linha. Patch por Pablo Galindo

@item 
gh-105390@footnote{https://github.com/python/cpython/issues/105390}: Levanta corretamente as exceções @ref{542,,tokenize.TokenError} em vez de @ref{18d,,SyntaxError} para erros de tokenização, como entrada incompleta. Patch por Pablo Galindo

@item 
gh-105259@footnote{https://github.com/python/cpython/issues/105259}: Não inclui o caractere de quebra de linha para tokens @code{NEWLINE} finais emitidos no módulo @ref{fb,,tokenize}. Patch por Pablo Galindo

@item 
gh-104635@footnote{https://github.com/python/cpython/issues/104635}: Elimina instruções redundantes @ref{17e5,,STORE_FAST} no compilador. Patch por Donghee Na e Carl Meyer.

@item 
gh-105324@footnote{https://github.com/python/cpython/issues/105324}: Corrige a função principal do módulo @ref{fb,,tokenize} ao ler de @code{sys.stdin}. Patch por Pablo Galindo

@item 
gh-33092@footnote{https://github.com/python/cpython/issues/33092}: Simplifica e acelera o interpretador para f-strings. Remove o opcode @code{FORMAT_VALUE}. Adiciona opcodes @code{CONVERT_VALUE}, @code{FORMAT_SIMPLE} e @code{FORMAT_WITH_SPEC}. O compilador emite uma sequência mais eficiente para cada expressão de formato.

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: Remove as superinstruções restantes de duas unidades de código. Todas as superinstruções restantes usam apenas uma unidade de código, simplificando a instrumentação e agilizando o processamento.

@item 
gh-105235@footnote{https://github.com/python/cpython/issues/105235}: Impede o acesso à memória fora dos limites durante chamadas @code{mmap.find()}.

@item 
gh-98963@footnote{https://github.com/python/cpython/issues/98963}: Restaura a capacidade de uma subclasse de @ref{194,,property} definir @code{__slots__} ou, de outra forma, ser livre de dicionários, ignorando falhas na definição de uma docstring em tal classe. Esse comportamento havia regredido na versão 3.12beta1. Um @ref{34b,,AttributeError} onde não havia um anteriormente era prejudicial ao código existente.

@item 
gh-104812@footnote{https://github.com/python/cpython/issues/104812}: O mecanismo de “chamada pendente” agora funciona para todos os interpretadores, não apenas para o interpretador principal, e é executado em todas as threads, não apenas na thread principal. Algumas chamadas ainda são feitas apenas na thread principal, ou seja, no interpretador principal. Esta alteração não afeta o tratamento de sinais nem a C-API pública existente (@code{Py_AddPendingCall()}), que ainda têm como alvo apenas a thread principal. A nova funcionalidade destina-se estritamente ao uso interno por enquanto, uma vez que as consequências de seu uso ainda não são bem compreendidas, exceto em alguns casos muito restritos. Esta alteração alinha a capacidade com a intenção quando o estado foi definido por interpretador há vários anos.

@item 
gh-105194@footnote{https://github.com/python/cpython/issues/105194}: Não escapa com barras invertidas os especificadores de formato de f-string. Patch por Pablo Galindo

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: Substitui algumas superinstruções dinâmicas por equivalentes de instrução única.

@item 
gh-105162@footnote{https://github.com/python/cpython/issues/105162}: Corrigido bug em generator.close()/throw(), onde um iterador interno era ignorado quando o iterador externo era instrumentado.

@item 
gh-105164@footnote{https://github.com/python/cpython/issues/105164}: Garante que as anotações sejam configuradas corretamente se a única anotação em um bloco estiver dentro de um bloco @ref{810,,match}. Patch por Jelle Zijlstra.

@item 
gh-105148@footnote{https://github.com/python/cpython/issues/105148}: Torna @code{_PyASTOptimizeState} interno a ast_opt.c. Torna @code{_PyAST_Optimize} com dois inteiros em vez de um ponteiro para esta estrutura. Isso evita a necessidade de incluir pycore_compile.h em ast_opt.c.

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: Atributos de nós @ref{8,,ast} que são listas agora assumem como padrão a lista vazia se omitidos. Isso significa que alguns códigos que anteriormente geravam @ref{2c3,,TypeError} quando o nó AST era usado agora prosseguirão com a lista vazia. Patch por Jelle Zijlstra.

@item 
gh-105111@footnote{https://github.com/python/cpython/issues/105111}: Remove as antigas macros da lixeira @code{Py_TRASHCAN_SAFE_BEGIN} e @code{Py_TRASHCAN_SAFE_END}. Elas devem ser substituídas pelas novas macros @code{Py_TRASHCAN_BEGIN} e @code{Py_TRASHCAN_END}.

@item 
gh-105035@footnote{https://github.com/python/cpython/issues/105035}: Corrige chamadas de @ref{4db,,super()} em tipos com implementação personalizada de @ref{17e6,,tp_getattro} (por exemplo, metatipos).

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: Exibe linhas CRLF no atributo de string tokenize em tokens NL e NEWLINE. Patch por Marta Gómez.

@item 
gh-105013@footnote{https://github.com/python/cpython/issues/105013}: Corrige o tratamento de lambdas entre parênteses de várias linhas em @ref{15f8,,inspect.getsource()}. Patch por Pablo Galindo

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: Não inclui um token final @code{NL} adicional ao analisar arquivos com linhas CRLF. Patch por Marta Gómez.

@item 
gh-104976@footnote{https://github.com/python/cpython/issues/104976}: Garante que os objetos @code{tokenize.TokenInfo} @code{DEDENT} finais emitidos pelo módulo @ref{fb,,tokenize} sejam reportados como no Python 3.11. Patch por Pablo Galindo.

@item 
gh-104972@footnote{https://github.com/python/cpython/issues/104972}: Garante que o atributo @code{line} em objetos @code{tokenize.TokenInfo} no módulo @ref{fb,,tokenize} estejam sempre corretos. Patch por Pablo Galindo

@item 
gh-104955@footnote{https://github.com/python/cpython/issues/104955}: Corrige a assinatura para o novo slot de @ref{17e7,,__release_buffer__()}. Patch por Jelle Zijlstra.

@item 
gh-104690@footnote{https://github.com/python/cpython/issues/104690}: Iniciar novas threads e criar processos através de @ref{197,,os.fork()} durante o desligamento do interpretador (como a partir de manipuladores @ref{c,,atexit}) não é mais suportado. Isso pode levar a uma condição de corrida entre a thread principal do tempo de execução do Python, liberando estados de threads enquanto rotinas internas de @ref{ed,,threading} tentam alocar e usar o estado de threads recém-criadas. Ou filhos do fork tentando usar o tempo de execução e o estado da thread no meio do desligamento no processo filho.

@item 
gh-104879@footnote{https://github.com/python/cpython/issues/104879}: Corrige a falha ao acessar o atributo @code{__module__} de apelidos de tipo definidos fora de um módulo. Patch por Jelle Zijlstra.

@item 
gh-104825@footnote{https://github.com/python/cpython/issues/104825}: Tokens emitidos pelo módulo @ref{fb,,tokenize} não incluem mais um caractere @code{\\n} implícito no atributo @code{line}. Patch por Pablo Galindo

@item 
gh-104770@footnote{https://github.com/python/cpython/issues/104770}: Se um gerador retornar um valor ao ser fechado, o valor agora é retornado por @ref{15b9,,generator.close()}.

@item 
gh-89091@footnote{https://github.com/python/cpython/issues/89091}: Levanta @ref{1bd,,RuntimeWarning} para métodos de gerador assíncronos não aguardados, como @ref{8df,,asend()}, @ref{4f9,,athrow()} e @ref{8de,,aclose()}. Patch por Kumar Aditya.

@item 
gh-96663@footnote{https://github.com/python/cpython/issues/96663}: Adiciona uma mensagem de erro melhor e mais introspectiva ao definir atributos em classes sem um @code{__dict__} e sem membro de slot para o atributo.

@item 
gh-93627@footnote{https://github.com/python/cpython/issues/93627}: Atualiza a implementação do módulo pickle em Python para corresponder à implementação em C do módulo pickle. Para objetos que definem métodos de redução como @ref{16a1,,__reduce_ex__()} ou @ref{9db,,__reduce__()} como @code{None}, a operação de pickle resultará em um @ref{2c3,,TypeError}.

@item 
gh-101006@footnote{https://github.com/python/cpython/issues/101006}: Melhora o tratamento de erros ao ler dados @ref{8d,,marshal}.

@item 
gh-91095@footnote{https://github.com/python/cpython/issues/91095}: Especializa chamadas para a maioria das classes Python. Especificamente, qualquer classe que herde de @code{object} ou de outra classe Python e não sobrescreva @code{__new__}.

A instrução especializada faz o seguinte:


@enumerate 

@item 
Cria o objeto (chamando @code{object.__new__})

@item 
Envia um quadro de correção para a pilha de quadros (para limpeza após @code{__init__})

@item 
Envia o quadro de @code{__init__} para a pilha de quadros
@end enumerate

Acelera a instanciação da maioria das classes Python.
@end itemize

@node Biblioteca<38>,Documentação<16>,Núcleo e embutidos<34>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id205}@anchor{17e8}
@subsubsection Biblioteca



@itemize -

@item 
gh-110786@footnote{https://github.com/python/cpython/issues/110786}: A CLI de @ref{db,,sysconfig} agora ignora @ref{1095,,BrokenPipeError}, fazendo com que ele saia normalmente se sua saída estiver sendo canalizada e o canal for fechado.

@item 
gh-103480@footnote{https://github.com/python/cpython/issues/103480}: O módulo @ref{db,,sysconfig} agora é um pacote, em vez de um módulo de arquivo único.

@item 
gh-110733@footnote{https://github.com/python/cpython/issues/110733}: Microotimização: Evite chamar @code{min()}, @code{max()} em @code{BaseEventLoop._run_once()}.

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: Adicionado @ref{17e9,,asyncio.EventLoop} para uso com o kwarg @ref{47c,,asyncio.run()} `loop_factory' para evitar chamar o sistema de políticas asyncio.

@item 
gh-110682@footnote{https://github.com/python/cpython/issues/110682}: @ref{443,,protocolos runtime-checkable} usados para considerar @code{__match_args__} um membro do protocolo em @code{__instancecheck__} se estivesse presente no protocolo. Agora, este atributo é ignorado se estiver presente.

@item 
gh-110488@footnote{https://github.com/python/cpython/issues/110488}: Corrige alguns problemas em @ref{17ea,,pathlib.PurePath.with_name()}: um único ponto era considerado incorretamente um nome válido e, em @code{PureWindowsPath}, um nome com um fluxo de dados NTFS alternativo, como @code{a:b}, era considerado incorretamente inválido.

@item 
gh-110590@footnote{https://github.com/python/cpython/issues/110590}: Corrige um bug em @code{_sre.compile()}, onde @ref{2c3,,TypeError} era substituído por @ref{885,,OverflowError} quando o argumento `code' era uma lista de não-ints.

@item 
gh-65052@footnote{https://github.com/python/cpython/issues/65052}: Impede que @ref{a5,,pdb} trave ao tentar exibir objetos não exibíveis

@item 
gh-110519@footnote{https://github.com/python/cpython/issues/110519}: Aviso de descontinuação sobre números não inteiros em @ref{63,,gettext} agora sempre se refere à linha no código do usuário onde a função ou método gettext é usado. Anteriormente, ele podia se referir a uma linha no código @code{gettext}.

@item 
gh-89902@footnote{https://github.com/python/cpython/issues/89902}: Descontinua o especificador de formato não padrão “N” para @ref{29d,,decimal.Decimal}. Ele não foi documentado e suportado apenas na implementação em C.

@item 
gh-110378@footnote{https://github.com/python/cpython/issues/110378}: Os gerenciadores de contexto @ref{1242,,contextmanager()} e @ref{b3c,,asynccontextmanager()} agora fecham um objeto gerador subjacente inválido que produz mais de um valor.

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: Em @ref{a5,,pdb}, defina a variável de conveniência @code{$_exception} para depuração post mortem.

@item 
gh-110365@footnote{https://github.com/python/cpython/issues/110365}: Corrige o bug em @ref{17eb,,termios.tcsetattr()} que estava sobrescrevendo erros existentes durante a análise de inteiros da lista @code{term}.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Melhora ligeiramente o tempo de importação de vários módulos da biblioteca padrão, adiando as importações de @ref{112,,warnings} dentro desses módulos. Patch por Alex Waygood.

@item 
gh-110273@footnote{https://github.com/python/cpython/issues/110273}: @ref{17ec,,dataclasses.replace()} agora levanta TypeError em vez de ValueError se especificar o argumento de palavra-chave para um campo declarado com init=False ou se o argumento nomeado não for especificado para o campo InitVar obrigatório.

@item 
gh-110249@footnote{https://github.com/python/cpython/issues/110249}: Adiciona o sinalizador @code{--inline-caches} à linha de comando @code{dis}.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Corrige uma regressão do Python 3.12 no tempo de importação de @ref{b8,,random}. Patch por Alex Waygood.

@item 
gh-110222@footnote{https://github.com/python/cpython/issues/110222}: Adiciona suporte a objetos sequência struct em @ref{151,,copy.replace()}. Patch por Xuehai Pan.

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: @ref{94,,multiprocessing}, @ref{21,,concurrent.futures}, @ref{20,,compileall}: Substitui @ref{1c5,,os.cpu_count()} por @ref{1c4,,os.process_cpu_count()} para selecionar o número padrão de threads e processos de trabalho. Obter a afinidade da CPU, se compatível. Patch por Victor Stinner.

@item 
gh-110150@footnote{https://github.com/python/cpython/issues/110150}: Corrige o tratamento de caso base em statistics.quantiles. Agora permite um único ponto de dados.

@item 
gh-110036@footnote{https://github.com/python/cpython/issues/110036}: No Windows, o multiprocessamento @code{Popen.terminate()} agora captura @ref{d65,,PermissionError} e obtém o código de saída do processo. Se o processo ainda estiver em execução, lança novamente o @ref{d65,,PermissionError}. Caso contrário, o processo é encerrado conforme o esperado: armazena seu código de saída. Patch por Victor Stinner.

@item 
gh-110038@footnote{https://github.com/python/cpython/issues/110038}: Corrige um problema que fazia com que @code{KqueueSelector.select()} não retornasse todos os eventos de prontidão em alguns casos quando um descritor de arquivo é registrado para leitura e escrita.

@item 
gh-110045@footnote{https://github.com/python/cpython/issues/110045}: Atualiza o módulo @ref{d8,,symtable} para suportar os novos escopos introduzidos por 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.

@item 
gh-88402@footnote{https://github.com/python/cpython/issues/88402}: Adiciona novas variáveis a @ref{1064,,sysconfig.get_config_vars()} no Windows: @code{LIBRARY}, @code{LDLIBRARY}, @code{LIBDIR}, @code{SOABI} e @code{Py_NOGIL}.

@item 
gh-109631@footnote{https://github.com/python/cpython/issues/109631}: Funções do @ref{b9,,re} como @ref{1060,,re.findall()}, @ref{2a2,,re.split()}, @ref{126d,,re.search()} e @ref{2a3,,re.sub()}, que realizam correspondências curtas e repetidas, agora podem ser interrompidas pelo usuário.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduz o tempo de importação de @ref{50,,email.utils} em cerca de 43%. Isso resulta em uma redução de cerca de 18% no tempo de importação de @ref{44,,email.message}, o que, por sua vez, reduz o tempo de importação de @ref{7a,,importlib.metadata} em cerca de 6%. Patch por Alex Waygood.

@item 
gh-109818@footnote{https://github.com/python/cpython/issues/109818}: Corrige @ref{1233,,reprlib.recursive_repr()} que não copiava @code{__type_params__} da função decorada.

@item 
gh-109047@footnote{https://github.com/python/cpython/issues/109047}: @ref{21,,concurrent.futures}: A `thread do gerenciador de executores' agora captura exceções ao adicionar um item à `fila de chamadas'. Durante a finalização do Python, a criação de uma nova thread agora pode gerar @ref{195,,RuntimeError}. Captura a chamada à exceção @code{terminate_broken()} neste caso. Patch por Victor Stinner.

@item 
gh-109782@footnote{https://github.com/python/cpython/issues/109782}: Garante que a assinatura de @ref{a1a,,os.path.isdir()} seja idêntica em todas as plataformas. Patch por Amin Alaee.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Melhora o tempo de importação de @ref{5f,,functools} em cerca de 13%. Patch por Alex Waygood.

@item 
gh-109590@footnote{https://github.com/python/cpython/issues/109590}: @ref{4b4,,shutil.which()} dará preferência a arquivos com a extensão @code{PATHEXT} se o modo fornecido incluir @code{os.X_OK} no Win32. Se nenhuma correspondência com @code{PATHEXT} for encontrada, um arquivo sem a extensão @code{PATHEXT} poderá ser retornado. Esta alteração fará com que @ref{4b4,,shutil.which()} aja de forma mais semelhante ao comportamento anterior no Python 3.11.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduz o tempo de importação de @ref{56,,enum} em mais de 50%. Patch por Alex Waygood.

@item 
gh-109593@footnote{https://github.com/python/cpython/issues/109593}: Evita impasses em uma chamada reentrante para o rastreador de recursos de multiprocessamento. Tal chamada reentrante, embora improvável, pode ocorrer se uma passagem de GC invocar o finalizador para um objeto de multiprocessamento, como SemLock.

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: Reduz o tempo de importação de @ref{104,,typing} em cerca de um terço. Patch por Alex Waygood.

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: Adiciona a função @ref{1c4,,os.process_cpu_count()} para obter o número de CPUs lógicas utilizáveis pela thread de chamada do processo atual. Patch por Victor Stinner.

@item 
gh-74481@footnote{https://github.com/python/cpython/issues/74481}: Adiciona constantes relacionadas a @code{set_error_mode} no módulo @code{msvcrt} na construção de depuração do Python.

@item 
gh-109613@footnote{https://github.com/python/cpython/issues/109613}: Corrige @ref{4a0,,os.stat()} e @ref{17ed,,os.DirEntry.stat()}: verificar exceções. Anteriormente, no Python construído em modo de depuração, essas funções podiam disparar um erro fatal do Python (e abortar o processo) quando uma função era bem-sucedida com uma exceção definida. Patch por Victor Stinner.

@item 
gh-109599@footnote{https://github.com/python/cpython/issues/109599}: Expõe o tipo de objetos PyCapsule como @code{types.CapsuleType}.

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: Agora você pode obter as cadeias de certificados TLS brutas de conexões TLS por meio dos métodos @ref{16c6,,ssl.SSLSocket.get_verified_chain()} e @ref{16c7,,ssl.SSLSocket.get_unverified_chain()}.

Contribuição de Mateusz Nowak.

@item 
gh-109559@footnote{https://github.com/python/cpython/issues/109559}: Atualiza o banco de dados @ref{105,,unicodedata} para Unicode 15.1.0.

@item 
gh-109543@footnote{https://github.com/python/cpython/issues/109543}: Remove a verificação desnecessária de @ref{4d2,,hasattr()} durante a criação de @ref{162,,typing.TypedDict}.

@item 
gh-109495@footnote{https://github.com/python/cpython/issues/109495}: Remove @code{__slots__} extras desnecessários na implementação em Python puro de @ref{1cc,,datetime} para reduzir o tamanho da memória, pois são definidos na superclasse. Patch por James Hilton-Balfe

@item 
gh-109461@footnote{https://github.com/python/cpython/issues/109461}: @ref{87,,logging}: Usa um gerenciador de contexto para aquisição de travas.

@item 
gh-109096@footnote{https://github.com/python/cpython/issues/109096}: @ref{2a1,,http.server.CGIHTTPRequestHandler} foi descontinuado para remoção na versão 3.15. Seu design é antigo e o mundo da web já ultrapassou o CGI há muito tempo.

@item 
gh-109409@footnote{https://github.com/python/cpython/issues/109409}: Corrige o erro que permitia herdar uma classe de dados congelada de vários pais, alguns dos quais possivelmente não estavam congelados.

@item 
gh-109375@footnote{https://github.com/python/cpython/issues/109375}: O comando @ref{a5,,pdb} @code{alias} agora impede o registro de apelidos sem argumentos.

@item 
gh-109319@footnote{https://github.com/python/cpython/issues/109319}: Descontinua o campo @code{dis.HAVE_ARGUMENT} em favor de @code{dis.hasarg}.

@item 
gh-107219@footnote{https://github.com/python/cpython/issues/107219}: Uma condição de corrida foi corrigida em @code{concurrent.futures}. Quando um processo no pool de processos era encerrado abruptamente (enquanto o future estava em execução ou pendente), a conexão era encerrada. Se a fila de chamadas estiver bloqueada no envio de bytes para um processo de trabalho, o encerramento da conexão de escrita interrompe o envio, permitindo o fechamento da fila. Patch por Victor Stinner.

@item 
gh-66143@footnote{https://github.com/python/cpython/issues/66143}: O objeto @ref{17ee,,codecs.CodecInfo} agora é copiável e pode ser selecionado. Patch por Robert Lehmann e Furkan Onder.

@item 
gh-109187@footnote{https://github.com/python/cpython/issues/109187}: @ref{17ef,,pathlib.Path.resolve()} agora trata laços de links simbólicos como outros erros: no modo estrito, @ref{417,,OSError} é levantada, e no modo não estrito, nenhuma exceção é levantada.

@item 
gh-50644@footnote{https://github.com/python/cpython/issues/50644}: Tenta serializar com pickle ou criar uma cópia rasa ou profunda de fluxos @ref{1b,,codecs} agora levantam um TypeError. Anteriormente, a cópia falhava com um RecursionError, enquanto o pickle produzia resultados incorretos que eventualmente causavam a falha ao desserializar com pickle com um RecursionError.

@item 
gh-109174@footnote{https://github.com/python/cpython/issues/109174}: Adicionado suporte a @ref{1d1,,types.SimpleNamespace} em @ref{151,,copy.replace()}.

@item 
gh-109164@footnote{https://github.com/python/cpython/issues/109164}: @ref{a5,,pdb}: Substitui @ref{61,,getopt} por @ref{6,,argparse} para analisar argumentos de linha de comando.

@item 
gh-109151@footnote{https://github.com/python/cpython/issues/109151}: Habilita os recursos de edição @code{readline} na interface de linha de comando @ref{441,,sqlite3} (@code{python -m sqlite3}).

@item 
gh-108987@footnote{https://github.com/python/cpython/issues/108987}: Corrige a condição de corrida @ref{196,,_thread.start_new_thread()}. Se uma thread for criada durante a finalização do Python, a thread recém-gerada agora sai imediatamente em vez de tentar acessar a memória liberada e causar um travamento. Patch por Victor Stinner.

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: Enum: requer @code{names=()} ou @code{type=...} para criar uma enumeração vazia usando a sintaxe funcional.

@item 
gh-109033@footnote{https://github.com/python/cpython/issues/109033}: Exceções levantadas pela função embutida os.utime agora incluem o nome do arquivo relacionado.

@item 
gh-108843@footnote{https://github.com/python/cpython/issues/108843}: Corrige um problema em @ref{8eb,,ast.unparse()} ao desfazer a análise de f-strings contendo muitos tipos de aspas.

@item 
gh-108469@footnote{https://github.com/python/cpython/issues/108469}: @ref{8eb,,ast.unparse()} agora oferece suporte à nova sintaxe @ref{436,,f-string} introduzida no Python 3.12. Observe que as aspas @ref{436,,f-string} foram selecionadas novamente para simplificar a nova sintaxe. (Patch por Steven Sun)

@item 
gh-108751@footnote{https://github.com/python/cpython/issues/108751}: Adiciona a função @ref{151,,copy.replace()}, que permite criar uma cópia modificada de um objeto. Ela oferece suporte às tuplas nomeadas, classes de dados e muitos outros objetos.

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: Enum: Levanta @ref{2c3,,TypeError} se @code{super().__new__()} for chamado de um @code{__new__} personalizado.

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: Descontinua a passagem do retorno de chamada por argumento nomeado para as seguintes APIs @ref{245,,sqlite3.Connection}:


@itemize *

@item 
@ref{2ab,,set_authorizer()}

@item 
@ref{2ac,,set_progress_handler()}

@item 
@ref{2ad,,set_trace_callback()}
@end itemize

Os parâmetros afetados se tornarão somente-posicionais no Python 3.15.

Patch por Erlend E. Aasland.

@item 
gh-105829@footnote{https://github.com/python/cpython/issues/105829}: Corrige impasse (deadlock) em concurrent.futures.ProcessPoolExecutor

@item 
gh-108295@footnote{https://github.com/python/cpython/issues/108295}: Corrige travamentos relacionados ao uso de referências fracas em @ref{15d,,typing.TypeVar}.

@item 
gh-108463@footnote{https://github.com/python/cpython/issues/108463}: Faz com que expressões/instruções funcionem conforme o esperado no pdb

@item 
gh-108277@footnote{https://github.com/python/cpython/issues/108277}: Adiciona @ref{211,,os.timerfd_create()}, @ref{212,,os.timerfd_settime()}, @ref{214,,os.timerfd_gettime()}, @ref{213,,os.timerfd_settime_ns()} e @ref{215,,os.timerfd_gettime_ns()} para fornecer uma interface de baixo nível para o descritor de arquivo de notificação de timer do Linux.

@item 
gh-107811@footnote{https://github.com/python/cpython/issues/107811}: @ref{de,,tarfile}: a extração de membros com UID ou GID muito grande (por exemplo, em um sistema operacional com @code{id_t} de 32 bits) agora falha da mesma forma que a falha na definição do ID.

@item 
gh-64662@footnote{https://github.com/python/cpython/issues/64662}: Corrige o suporte para tabelas virtuais em @ref{247,,sqlite3.Connection.iterdump()}. Patch por Aviv Palivoda.

@item 
gh-108111@footnote{https://github.com/python/cpython/issues/108111}: Corrige uma regressão introduzida em gh-101251@footnote{https://github.com/python/cpython/issues/101251} para a versão 3.12, resultando em um cálculo de deslocamento incorreto em @code{gzip.GzipFile.seek()}.

@item 
gh-108294@footnote{https://github.com/python/cpython/issues/108294}: @ref{69d,,time.sleep()} agora levanta um evento de auditoria.

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: Descontinua a passagem de nome, número de argumentos e o chamável como argumentos nomeados para as seguintes APIs de @ref{245,,sqlite3.Connection}:


@itemize *

@item 
@ref{2a9,,create_function()}

@item 
@ref{2aa,,create_aggregate()}
@end itemize

Os parâmetros afetados se tornarão somente-posicionais no Python 3.15.

Patch por Erlend E. Aasland.

@item 
gh-108322@footnote{https://github.com/python/cpython/issues/108322}: Aceleração de NormalDist.samples() usando o método CDF inverso em vez de chamar random.gauss().

@item 
gh-83417@footnote{https://github.com/python/cpython/issues/83417}: Adiciona a capacidade do venv de criar um arquivo @code{.gitignore}, que faz com que o ambiente criado seja ignorado pelo Git. Essa configuração é ativada por padrão quando o venv é chamado por meio de sua CLI.

@item 
gh-105736@footnote{https://github.com/python/cpython/issues/105736}: Harmonização da versão Python pura de @ref{5db,,OrderedDict} com a versão C. Agora, ambas as versões configuram seu estado interno em @code{__new__}. Anteriormente, a versão Python pura fazia a configuração em @code{__init__}.

@item 
gh-108083@footnote{https://github.com/python/cpython/issues/108083}: Corrige bugs no construtor de @ref{245,,sqlite3.Connection} e @ref{246,,sqlite3.Connection.close()}, onde exceções poderiam vazar. Patch por Erlend E. Aasland.

@item 
gh-107932@footnote{https://github.com/python/cpython/issues/107932}: Corrige o módulo @code{dis} para relatar e exibir corretamente o bytecode que não possui linhas de código-fonte.

@item 
gh-105539@footnote{https://github.com/python/cpython/issues/105539}: @ref{cf,,sqlite3} agora emite uma @ref{244,,ResourceWarning} se um objeto @ref{245,,sqlite3.Connection} não for @code{fechado} explicitamente. Patch por Erlend E. Aasland.

@item 
gh-107995@footnote{https://github.com/python/cpython/issues/107995}: O atributo @code{__module__} em instâncias de @ref{541,,functools.cached_property} agora é definido como o nome do módulo no qual a cached_property está definida, em vez de “functools”. Isso significa que os doctests em docstrings @code{cached_property} agora são coletados corretamente pelo módulo @ref{3a,,doctest}. Patch por Tyler Smart.

@item 
gh-107963@footnote{https://github.com/python/cpython/issues/107963}: Corrige @ref{1681,,multiprocessing.set_forkserver_preload()} para verificar a lista de nomes de módulos fornecida. Patch por Donghee Na.

@item 
gh-106242@footnote{https://github.com/python/cpython/issues/106242}: Corrige @ref{135e,,os.path.normpath()} para manipular caracteres nulos incorporados sem truncar o caminho.

@item 
gh-81555@footnote{https://github.com/python/cpython/issues/81555}: @ref{122,,xml.dom.minidom} agora coloca apenas aspas @code{"} em atributos.

@item 
gh-50002@footnote{https://github.com/python/cpython/issues/50002}: @ref{122,,xml.dom.minidom} agora preserva espaços em branco em atributos.

@item 
gh-93057@footnote{https://github.com/python/cpython/issues/93057}: Passa mais de um argumento posicional para @ref{2a8,,sqlite3.connect()} e o construtor @ref{245,,sqlite3.Connection} está obsoleto. Os parâmetros restantes se tornarão somente-nomeados no Python 3.15. Patch por Erlend E. Aasland.

@item 
gh-76913@footnote{https://github.com/python/cpython/issues/76913}: Adiciona o parâmetro/recurso `merge_extra' a @ref{1339,,logging.LoggerAdapter}

@item 
gh-107913@footnote{https://github.com/python/cpython/issues/107913}: Corrige possíveis perdas dos valores @code{errno} e @code{winerror} em exceções @ref{417,,OSError} se eles fossem limpados ou modificados pelo código de limpeza antes de criar o objeto de exceção.

@item 
gh-107845@footnote{https://github.com/python/cpython/issues/107845}: @ref{42d,,tarfile.data_filter()} agora leva em consideração a localização dos links simbólicos ao determinar seu destino, portanto, não rejeitará mais alguns tarballs válidos com @code{LinkOutsideDestinationError}.

@item 
gh-107812@footnote{https://github.com/python/cpython/issues/107812}: Estende o suporte a netlink do socket para a plataforma FreeBSD.

@item 
gh-107805@footnote{https://github.com/python/cpython/issues/107805}: Corrige assinaturas de funções geradas em nível de módulo no @ref{101,,turtle}.

@item 
gh-107782@footnote{https://github.com/python/cpython/issues/107782}: @ref{b5,,pydoc} agora é capaz de exibir assinaturas que não são representáveis em Python, por exemplo, para @code{getattr} e @code{dict.pop}.

@item 
gh-56166@footnote{https://github.com/python/cpython/issues/56166}: Descontinua a passagem de argumentos opcionais `maxsplit', `count' e `flags' em funções de nível de módulo @ref{2a2,,re.split()}, @ref{2a3,,re.sub()} e @ref{2a4,,re.subn()} como posicionais. Eles devem ser passados apenas como nomeados.

@item 
gh-107710@footnote{https://github.com/python/cpython/issues/107710}: Acelera @ref{17f0,,logging.getHandlerNames()}.

@item 
gh-107715@footnote{https://github.com/python/cpython/issues/107715}: Corrige @ref{17f1,,doctest.DocTestFinder.find()} na presença de nomes de classe com caracteres especiais. Patch por Gertjan van Zwieten.

@item 
gh-100814@footnote{https://github.com/python/cpython/issues/100814}: Passa um objeto chamável como um valor de opção para uma imagem Tkinter agora levanta o TclError esperado em vez de um AttributeError.

@item 
gh-72684@footnote{https://github.com/python/cpython/issues/72684}: Adiciona métodos de widget @ref{f0,,tkinter}: @code{tk_busy_hold()}, @code{tk_busy_configure()}, @code{tk_busy_cget()}, @code{tk_busy_forget()}, @code{tk_busy_current()} e @code{tk_busy_status()}.

@item 
gh-106684@footnote{https://github.com/python/cpython/issues/106684}: Levanta @ref{244,,ResourceWarning} quando @ref{17f2,,asyncio.StreamWriter} não for fechado, causando vazamentos de memória. Patch por Kumar Aditya.

@item 
gh-107465@footnote{https://github.com/python/cpython/issues/107465}: Adiciona método de classe @ref{22a,,pathlib.Path.from_uri()}.

@item 
gh-107077@footnote{https://github.com/python/cpython/issues/107077}: Parece que em algumas condições, o OpenSSL retornará @code{SSL_ERROR_SYSCALL} em vez de @code{SSL_ERROR_SSL} quando uma verificação de certificação falhar, mas os parâmetros de erro ainda conterão @code{ERR_LIB_SSL} e @code{SSL_R_CERTIFICATE_VERIFY_FAILED}. Estamos detectando essa situação e levantando o erro @code{ssl.SSLCertVerificationError} apropriado. Patch por Pablo Galindo

@item 
gh-107576@footnote{https://github.com/python/cpython/issues/107576}: Corrige @ref{4ce,,types.get_original_bases()} para retornar @code{__orig_bases__} somente se estiver presente diretamente em @code{cls}. Patch por James Hilton-Balfe.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: Remove @code{opcode.is_pseudo}, @code{opcode.MIN_PSEUDO_OPCODE} e @code{opcode.MAX_PSEUDO_OPCODE}, que foram adicionados na versão 3.12, nunca foram documentados e não foram projetados para uso externo.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @code{opcode.ENABLE_SPECIALIZATION} (que foi adicionado na versão 3.12, mas nunca foi documentado ou destinado ao uso externo) foi movido para @code{_opcode.ENABLE_SPECIALIZATION}, onde os testes podem acessá-lo.

@item 
gh-107396@footnote{https://github.com/python/cpython/issues/107396}: tarfiles; Corrigido o uso antes da atribuição de self.exception para descompactação gzip.

@item 
gh-107409@footnote{https://github.com/python/cpython/issues/107409}: Definido o atributo @code{__wrapped__} em @ref{1233,,reprlib.recursive_repr()}.

@item 
gh-107406@footnote{https://github.com/python/cpython/issues/107406}: Implementa o novo método @code{__repr__()} para @ref{15a0,,struct.Struct}. Agora ele retorna @code{Struct(<format repr>)}.

@item 
gh-107369@footnote{https://github.com/python/cpython/issues/107369}: Otimiza @ref{276,,textwrap.indent()}. Ele está ~30% mais rápido para entradas grandes. Patch por Inada Naoki.

@item 
gh-78722@footnote{https://github.com/python/cpython/issues/78722}: Corrige o problema em que @ref{171d,,pathlib.Path.iterdir()} não levantava @ref{417,,OSError} até ser iterado.

@item 
gh-105578@footnote{https://github.com/python/cpython/issues/105578}: Descontinua @ref{2b2,,typing.AnyStr} em favor da nova sintaxe de parâmetro de tipo. Consulte PEP 695.

@item 
gh-62519@footnote{https://github.com/python/cpython/issues/62519}: Faz com que @ref{9fd,,gettext.pgettext()} busque definições no plural quando a tradução não for encontrada.

@item 
gh-107089@footnote{https://github.com/python/cpython/issues/107089}: Prateleiras abertas com @ref{17f3,,shelve.open()} têm um método @code{clear()} muito mais rápido. Patch por James Cave.

@item 
gh-82500@footnote{https://github.com/python/cpython/issues/82500}: Corrige estouro em sistemas de 32 bits com a implementação de @ref{a,,asyncio} @ref{b21,,os.sendfile()}.

@item 
gh-83006@footnote{https://github.com/python/cpython/issues/83006}: Documenta o comportamento de @ref{116c,,shutil.disk_usage()} para sistemas de arquivos não montados no Unix.

@item 
gh-65495@footnote{https://github.com/python/cpython/issues/65495}: Usa @code{mail from} e @code{rcpt to} em letras minúsculas em @code{smptlib.SMTP}.

@item 
gh-106186@footnote{https://github.com/python/cpython/issues/106186}: Não reporta o defeito @code{MultipartInvariantViolationDefect} quando a classe @ref{11dc,,email.parser.Parser} for usada para analisar e-mails com @code{headersonly=True}.

@item 
gh-105002@footnote{https://github.com/python/cpython/issues/105002}: Corrige resultado inválido do método @code{PurePath.relative_to()} ao tentar percorrer um segmento “@code{..}” em `other' com `walk_up' habilitado. Uma exceção @ref{202,,ValueError} agora é levantada neste caso.

@item 
gh-106739@footnote{https://github.com/python/cpython/issues/106739}: Adiciona @code{rtype_cache} à mensagem de aviso (como um complemento ao tipo de objetos vazados e ao número de objetos vazados já incluídos na mensagem) para facilitar a depuração de objetos vazados quando o processo rastreador de recursos de multiprocessamento os encontra no desligamento. Isso ajuda a identificar mais rapidamente o que vazou e/ou por que o objeto vazado não foi limpo corretamente.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Otimiza @code{SelectSelector.select()} para muitos casos de iteração. Patch por Donghee Na.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Otimiza @code{_PollLikeSelector.select()} para o caso de muitas iterações.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: Otimiza @code{KqueueSelector.select()} para o caso de muitas iterações. Patch por Donghee Na.

@item 
gh-106831@footnote{https://github.com/python/cpython/issues/106831}: Corrige a possível ausência da verificação @code{NULL} do resultado @code{d2i_SSL_SESSION} em @code{_ssl.c}.

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: As diversas listas de opcodes no módulo @ref{38,,dis} agora são geradas a partir de bytecodes.c em vez de construídas explicitamente em opcode.py.

@item 
gh-106727@footnote{https://github.com/python/cpython/issues/106727}: Torna @ref{15f8,,inspect.getsource()} mais inteligente para classes com definições de mesmo nome

@item 
gh-106789@footnote{https://github.com/python/cpython/issues/106789}: Remove importação de @ref{ae,,pprint} de @ref{db,,sysconfig}.

@item 
gh-105726@footnote{https://github.com/python/cpython/issues/105726}: Adiciona @code{__slots__} a @ref{cab,,contextlib.AbstractContextManager} e @ref{b3d,,contextlib.AbstractAsyncContextManager} para que classes filhas possam usar @code{__slots__}.

@item 
gh-106774@footnote{https://github.com/python/cpython/issues/106774}: Atualiza a cópia do pacote do pip para a versão 23.2.1.

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: @ref{c2,,selectors}: Otimiza o código @code{EpollSelector.select()} movendo parte do código para fora do laço.

@item 
gh-106752@footnote{https://github.com/python/cpython/issues/106752}: Corrigidos vários bugs em zipfile.Path, incluindo: em @code{zipfile.Path.match()}, os separadores do Windows não são mais respeitados (e nunca foram pensados para serem); Corrigidas as operações @code{name}/@code{suffix}/@code{suffixes}/@code{stem} quando nenhum nome de arquivo está presente e o Path não está na raiz do arquivo zip; Glob reformulado para melhor desempenho e comportamento de correspondência mais correto.

@item 
gh-105293@footnote{https://github.com/python/cpython/issues/105293}: Removida a chamada para @code{SSL_CTX_set_session_id_context} durante a criação de contexto do lado do cliente no módulo @ref{d0,,ssl}.

@item 
gh-106734@footnote{https://github.com/python/cpython/issues/106734}: Desabilita o preenchimento automático com tabulação no modo multilinha de @ref{a5,,pdb}

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: Exibido metadados do opcode por meio de @code{_opcode}.

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: Adiciona o novo comando @code{exceptions} ao depurador Pdb. Ele possibilita a navegação entre exceções encadeadas ao usar a depuração post mortem.

@item 
gh-106602@footnote{https://github.com/python/cpython/issues/106602}: Adiciona __copy__ e __deepcopy__ em @ref{56,,enum}

@item 
gh-106664@footnote{https://github.com/python/cpython/issues/106664}: @ref{c2,,selectors}: Adiciona o método @code{_SelectorMapping.get()} e otimiza @code{_SelectorMapping.__getitem__()}.

@item 
gh-106628@footnote{https://github.com/python/cpython/issues/106628}: Acelera a análise de e-mails em cerca de 20%, eliminando a necessidade de compilar uma nova expressão regular para cada e-mail.

@item 
gh-89427@footnote{https://github.com/python/cpython/issues/89427}: Define a variável de ambiente @code{VIRTUAL_ENV_PROMPT} na ativação de @ref{111,,venv}, mesmo quando @code{VIRTUAL_ENV_DISABLE_PROMPT} estiver definido.

@item 
gh-106530@footnote{https://github.com/python/cpython/issues/106530}: Reverte uma alteração em @ref{17f4,,colorsys.rgb_to_hls()} que causava divisão por zero para certas entradas quase brancas. Patch por Terry Jan Reedy.

@item 
gh-106584@footnote{https://github.com/python/cpython/issues/106584}: Corrige o código de saída para @code{unittest} caso todos os testes sejam ignorados. Patch por Egor Eliseev.

@item 
gh-106566@footnote{https://github.com/python/cpython/issues/106566}: Otimiza @code{(?!)} (padrão que sempre falha) em expressões regulares.

@item 
gh-106554@footnote{https://github.com/python/cpython/issues/106554}: @ref{c2,,selectors}: Reduz a sobrecarga do seletor usando @code{dict.get()} para procurar descritores de arquivo.

@item 
gh-106558@footnote{https://github.com/python/cpython/issues/106558}: Remove o ciclo de referência em chamadores de @code{convert_to_error()} excluindo @code{result} do escopo em um bloco @code{finally}.

@item 
gh-100502@footnote{https://github.com/python/cpython/issues/100502}: Adiciona o atributo de classe @code{pathlib.PurePath.pathmod} que armazena a implementação de @ref{a2,,os.path} usado para operações de caminho de baixo nível: @code{posixpath} ou @code{ntpath}.

@item 
gh-106527@footnote{https://github.com/python/cpython/issues/106527}: Reduz a sobrecarga para adicionar e remover leitores e escritores @ref{a,,asyncio}.

@item 
gh-106524@footnote{https://github.com/python/cpython/issues/106524}: Corrige a falha em @code{_sre.template()} com modelos contendo índices de grupo inválidos.

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: Removido @code{_legacy} e os nomes que ele fornecia de @code{importlib.resources}: @code{Resource}, @code{contents}, @code{is_resource}, @code{open_binary}, @code{open_text}, @code{path}, @code{read_binary} e @code{read_text}.

@item 
gh-106052@footnote{https://github.com/python/cpython/issues/106052}: Módulo @ref{b9,,re}: corrige a correspondência de quantificadores possessivos no caso de um subpadrão contendo retrocesso.

@item 
gh-106510@footnote{https://github.com/python/cpython/issues/106510}: Melhora a saída de depuração para grupos atômicos em expressões regulares.

@item 
gh-106503@footnote{https://github.com/python/cpython/issues/106503}: Corrige o ciclo de referência em @code{asyncio._SelectorSocketTransport} removendo @code{_write_ready} em @code{close}.

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: Corrige a inversão da máscara de sinalizador quando existem flags sem nome.

@item 
gh-90876@footnote{https://github.com/python/cpython/issues/90876}: Impede que @code{multiprocessing.spawn} falhe na `importação' em ambientes onde @code{sys.executable} é @code{None}. Isso regrediu na versão 3.11 com a adição do suporte a objetos caminho ou similares em multiprocessamento.

@item 
gh-106403@footnote{https://github.com/python/cpython/issues/106403}: Instâncias de @ref{15d,,typing.TypeVar}, @ref{15e,,typing.ParamSpec}, @ref{7c7,,typing.ParamSpecArgs}, @ref{7c8,,typing.ParamSpecKwargs} e @ref{15f,,typing.TypeVarTuple} novamente oferecem suporte a referências fracas, corrigindo uma regressão introduzida no Python 3.12.0 beta 1. Patch por Jelle Zijlstra.

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: Adiciona a classe privada @code{pathlib._PathBase}, que fornece suporte experimental para sistemas de arquivos virtuais e pode ser disponibilizada publicamente em uma versão futura do Python.

@item 
gh-106292@footnote{https://github.com/python/cpython/issues/106292}: Verifica se há um valor armazenado em cache do tipo dicionário instanciado no método @code{__get__()} de @ref{541,,functools.cached_property()}. Isso corresponde melhor ao comportamento anterior à versão 3.12 e melhora a compatibilidade para usuários que subclassificam @ref{541,,functools.cached_property()} e adicionam um método @code{__set__()}.

@item 
gh-106350@footnote{https://github.com/python/cpython/issues/106350}: Detecta possível falha de alocação de memória na função libtommath @code{mp_init()} usada pelo módulo @code{_tkinter}.

@item 
gh-106330@footnote{https://github.com/python/cpython/issues/106330}: Corrige a correspondência incorreta de caminhos vazios em @ref{4ac,,pathlib.PurePath.match()}. Este bug foi introduzido no Python 3.12.0 beta 1.

@item 
gh-106309@footnote{https://github.com/python/cpython/issues/106309}: Descontinua @ref{2b1,,typing.no_type_check_decorator()}. Nenhum verificador de tipos importante adicionou suporte a este decorador. Patch por Alex Waygood.

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: Faz com que @code{pydoc.doc()} capture o módulo inválido @ref{419,,ImportError} quando o fluxo de saída não for @code{None}.

@item 
gh-106263@footnote{https://github.com/python/cpython/issues/106263}: Corrige a falha ao chamar @code{repr} com um objeto SignalDict construído manualmente. Patch por Charlie Zhao.

@item 
gh-106236@footnote{https://github.com/python/cpython/issues/106236}: Substitui instruções @code{assert} por @code{raise RuntimeError} em @ref{ed,,threading}, para que @code{_DummyThread} não possa ser unido nem mesmo com @code{-OO}.

@item 
gh-106238@footnote{https://github.com/python/cpython/issues/106238}: Corrige bug raro de simultaneidade na aquisição de trava pelo pacote de registro.

@item 
gh-106152@footnote{https://github.com/python/cpython/issues/106152}: Adicionado gancho de evento PY_THROW para @ref{27,,cProfile} para geradores.

@item 
gh-106075@footnote{https://github.com/python/cpython/issues/106075}: Adicionado @code{asyncio.taskgroups.__all__} a @code{asyncio.__all__} para exportação em importações estrela.

@item 
gh-104527@footnote{https://github.com/python/cpython/issues/104527}: O Zipapp agora ignora a anexação de um arquivo a si mesmo.

@item 
gh-106046@footnote{https://github.com/python/cpython/issues/106046}: Melhoria na mensagem de erro de @ref{c6e,,os.fspath()} se chamada em um objeto onde @code{__fspath__} está definido como @code{None}. Patch por Alex Waygood.

@item 
gh-105987@footnote{https://github.com/python/cpython/issues/105987}: Corrige falha devido à contagem de referências incorreta nas rotinas internas ansiosas de fábrica de tarefas do do @ref{a,,asyncio}.

@item 
gh-105974@footnote{https://github.com/python/cpython/issues/105974}: Corrige bug em que uma classe @ref{264,,typing.Protocol} que tinha um ou mais membros não-chamáveis levantava @ref{2c3,,TypeError} quando @ref{7c2,,issubclass()} era chamada contra ela, mesmo se definisse um método @code{__subclasshook__} personalizado. O comportamento no Python 3.11 e versões anteriores — que agora foi restaurado — era não levantar @ref{2c3,,TypeError} nessas situações se um método @code{__subclasshook__} personalizado fosse definido. Patch por Alex Waygood.

@item 
gh-96145@footnote{https://github.com/python/cpython/issues/96145}: Revertida a adição de @code{json.AttrDict}.

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: Adiciona @ref{227,,pathlib.UnsupportedOperation}, que é levantada em vez de @ref{228,,NotImplementedError} quando uma operação de caminho não é suportada.

@item 
gh-105808@footnote{https://github.com/python/cpython/issues/105808}: Corrigida uma regressão introduzida em gh-101251@footnote{https://github.com/python/cpython/issues/101251} para a versão 3.12, que fazia com que @code{gzip.GzipFile.flush()} não descarregasse o compactador (nem passasse o argumento @code{zip_mode}).

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @ref{f64,,stack_effect()} não levanta mais uma exceção se um @code{oparg} for fornecido para um @code{opcode} que não usa seu argumento, ou quando não for fornecido para um @code{opcode} que o utiliza. Neste último caso, o efeito de pilha é retornado para @code{oparg=0}.

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: Habilita @ref{8eb,,ast.unparse()} para desfazer o analisador sintático de definições de função e classe criadas sem o novo campo @code{type_params} de 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}. Patch por Jelle Zijlstra.

@item 
gh-105793@footnote{https://github.com/python/cpython/issues/105793}: Adiciona o argumento somente-nomeado `follow_symlinks' para @ref{230,,pathlib.Path.is_dir()} e @ref{22f,,is_file()}, com o padrão @code{True}.

@item 
gh-105570@footnote{https://github.com/python/cpython/issues/105570}: Descontinua dois métodos de criação de classes @ref{162,,typing.TypedDict} com 0 campos usando a sintaxe funcional: @code{TD = TypedDict("TD")} e @code{TD = TypedDict("TD", None)}. Ambos serão descontinuados no Python 3.15. Para criar uma classe @code{TypedDict} com 0 campos, use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})}.

@item 
gh-105745@footnote{https://github.com/python/cpython/issues/105745}: Corrige o método @code{webbrowser.Konqueror.open}.

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: @ref{2a,,ctypes}: Descontinua as funções não documentadas @code{ctypes.SetPointerType()} e @code{ctypes.ARRAY()}. Patch por Victor Stinner.

@item 
gh-105687@footnote{https://github.com/python/cpython/issues/105687}: Remove as funções descontinuadas @code{re.template}, @code{re.T}, @code{re.TEMPLATE} e @code{sre_constans.SRE_FLAG_TEMPLATE}.

@item 
gh-105684@footnote{https://github.com/python/cpython/issues/105684}: O suporte a @ref{9e5,,asyncio.Task.set_name()} agora é obrigatório para implementações de tarefas de terceiros. A função não documentada @code{_set_task_name()} (descontinuada desde a versão 3.8) foi removida. Patch por Kumar Aditya.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige um bug em @code{_Unpickler_SetInputStream()}, onde uma exceção poderia ser sobrescrita em caso de falha.

@item 
gh-105626@footnote{https://github.com/python/cpython/issues/105626}: Altera o valor de retorno padrão de @ref{17f5,,http.client.HTTPConnection.get_proxy_response_headers()} para @code{None} e não @code{@{@}}.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @ref{d9,,sys}, onde exceções poderiam ser sobrescritas devido ao tratamento de erros adiado.

@item 
gh-105605@footnote{https://github.com/python/cpython/issues/105605}: Reforça o tratamento de erros em @code{pyexpat} durante a inicialização do módulo para evitar que exceções sejam sobrescritas e que objetos sejam desreferenciados duas vezes.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bug em @ref{36,,decimal}, onde uma exceção poderia acabar sendo sobrescrita.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @code{_datetime}, onde exceções poderiam ser sobrescritas em caso de falha na inicialização do módulo.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs na inicialização de @code{_ssl}, que poderiam levar a referências vazadas e exceções sobrescritas.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige um bug em @ref{1a0,,array.array}, onde uma exceção poderia acabar sendo sobrescrita.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @code{_ctypes}, onde exceções poderiam ser sobrescritas.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige um bug no módulo @ref{ad,,posix}, onde uma exceção poderia ser sobrescrita.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @code{_elementtree}, onde exceções poderiam ser sobrescritas.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @ref{134,,zoneinfo}, onde exceções poderiam ser sobrescritas.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @ref{57,,errno}, onde exceções poderiam ser sobrescritas.

@item 
gh-105566@footnote{https://github.com/python/cpython/issues/105566}: Descontinua a criação de uma classe @ref{2b0,,typing.NamedTuple} usando argumentos nomeados para denotar os campos (@code{NT = NamedTuple("NT", x=int, y=str)}). Isso não será permitido no Python 3.15. Use a sintaxe baseada em classe ou a sintaxe funcional.

Dois métodos para criar classes @code{NamedTuple} com 0 campos usando a sintaxe funcional também estão descontinuados e não serão permitidos no Python 3.15: @code{NT = NamedTuple("NT")} e @code{NT = NamedTuple("NT", None)}. Para criar uma classe @code{NamedTuple} com 0 campos, use @code{class NT(NamedTuple): pass} ou @code{NT = NamedTuple("NT", [])}.

@item 
gh-105545@footnote{https://github.com/python/cpython/issues/105545}: Remove o atributo @code{webbrowser.MacOSXOSAScript._name}, que estava descontinuado na versão 3.11.

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: Corrige a inversão de sinalizadores quando existem membros de apelido/máscara.

@item 
gh-105509@footnote{https://github.com/python/cpython/issues/105509}: @ref{944,,typing.Annotated} agora é implementado como uma instância de @code{typing._SpecialForm} em vez de uma classe. Isso não deve ter impacto direto para os usuários da API pública do módulo @ref{104,,typing}.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige bugs em @ref{a6,,pickle}, onde exceções podiam ser sobrescritas.

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: Emite @ref{415,,FutureWarning} de @ref{22d,,pathlib.Path.glob()} e @ref{22e,,rglob()} se o padrão fornecido terminar com “@code{**}”. Em uma versão futura do Python, padrões com essa terminação corresponderão tanto a arquivos quanto a diretórios. Adicione uma barra final para corresponder apenas a diretórios.

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: Corrige um bug em @ref{cf,,sqlite3} onde uma exceção poderia ser sobrescrita no retorno de chamada de @ref{676,,collation}.

@item 
gh-105382@footnote{https://github.com/python/cpython/issues/105382}: Remove os parâmetros `cafile', `capath' e `cadefault' da função @ref{293,,urllib.request.urlopen()}, descontinuados no Python 3.6. Patch por Victor Stinner.

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: @ref{87,,logging}: Remove os métodos @code{Logger.warn()} e @code{LoggerAdapter.warn()} não documentados e não testados, bem como a função @code{logging.warn()}. Descontinuados desde o Python 3.3, eles eram apelidos dos métodos @ref{17f6,,logging.Logger.warning()}, @code{logging.LoggerAdapter.warning()} e @ref{2ff,,logging.warning()}. Patch por Victor Stinner.

@item 
gh-105332@footnote{https://github.com/python/cpython/issues/105332}: Reverte o método de serialização com pickle de by-name para by-value.

@item 
gh-104554@footnote{https://github.com/python/cpython/issues/104554}: Adiciona suporte ao esquema RTSPS em urllib.parse

@item 
gh-105292@footnote{https://github.com/python/cpython/issues/105292}: Adiciona opção a @ref{851,,traceback.format_exception_only()} para recursivamente retornar à exceção aninhada de um @ref{25f,,BaseExceptionGroup}.

@item 
gh-105280@footnote{https://github.com/python/cpython/issues/105280}: Corrige bug em que @code{isinstance([], collections.abc.Mapping)} poderia ser avaliado como @code{True} se a coleta de lixo ocorresse no momento errado. O bug foi causado por alterações na implementação de @ref{264,,typing.Protocol} no Python 3.12.

@item 
gh-80480@footnote{https://github.com/python/cpython/issues/80480}: @ref{7,,array}: Adiciona o typecode @code{'w'} que representa @code{Py_UCS4}.

@item 
gh-105239@footnote{https://github.com/python/cpython/issues/105239}: Corrige bug antigo em que @code{issubclass(object, typing.Protocol)} era avaliado como @code{True} em alguns casos extremos. Patch por Alex Waygood.

@item 
gh-104310@footnote{https://github.com/python/cpython/issues/104310}: Na versão beta 1, adicionamos uma função utilitária para autores de módulos de extensão, para usar ao testar seus módulos quanto ao suporte em múltiplos interpretadores ou sob uma GIL por interpretador. O nome dessa função mudou de @code{allowing_all_extensions} para @code{_incompatible_extension_module_restrictions}. O padrão para o argumento “disable_check” foi alterado de “True” para “False”, para corresponder melhor ao novo nome da função.

@item 
gh-105080@footnote{https://github.com/python/cpython/issues/105080}: Assinatura inconsistente corrigida em classes derivadas para @ref{738,,inspect.signature()}

@item 
gh-105144@footnote{https://github.com/python/cpython/issues/105144}: Uma regressão recente foi corrigida no módulo @ref{104,,typing}. A regressão significava que executar @code{class Foo(X, typing.Protocol)}, onde @code{X} era uma classe que tinha @ref{f4a,,abc.ABCMeta} como metaclasse, faria com que chamadas subsequentes de @code{isinstance(1, X)} levantassem erroneamente @ref{2c3,,TypeError}. Patch por Alex Waygood.

@item 
gh-62948@footnote{https://github.com/python/cpython/issues/62948}: O finalizador @ref{1f5,,io.IOBase} agora registra os erros do método @code{close()} com @ref{1f7,,sys.unraisablehook}. Anteriormente, os erros eram ignorados silenciosamente por padrão e registrados apenas no @ref{1f8,,Modo de Desenvolvimento Python} ou no @ref{1f9,,Python construído em modo de depuração}. Patch por Victor Stinner.

@item 
gh-105096@footnote{https://github.com/python/cpython/issues/105096}: @ref{113,,wave}: Descontinua os métodos @code{getmark()}, @code{setmark()} e @code{getmarkers()} das classes @ref{2b6,,wave.Wave_read} e @ref{2b7,,wave.Wave_write}. Eles serão removidos no Python 3.15. Patch por Victor Stinner.

@item 
gh-104992@footnote{https://github.com/python/cpython/issues/104992}: Remove o método @code{unittest.TestProgram.usageExit()} não testado e não documentado, descontinuado no Python 3.11. Patch por Hugo van Kemenade.

@item 
gh-104996@footnote{https://github.com/python/cpython/issues/104996}: Melhore o desempenho da inicialização de @ref{4a6,,pathlib.PurePath} adiando a junção de caminhos quando múltiplos argumentos são fornecidos.

@item 
gh-101588@footnote{https://github.com/python/cpython/issues/101588}: Descontinua o suporte não documentado a copy/deepcopy/pickle para itertools.

@item 
gh-103631@footnote{https://github.com/python/cpython/issues/103631}: Corrige @code{pathlib.PurePosixPath(pathlib.PureWindowsPath(...))} que não convertia separadores de caminho para restaurar o comportamento compatível com a versão 3.11.

@item 
gh-104947@footnote{https://github.com/python/cpython/issues/104947}: Torna as comparações entre objetos @ref{17f7,,pathlib.PureWindowsPath} consistentes no Windows e no Posix para corresponder ao comportamento da versão 3.11.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{audioop}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{aifc}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{uu}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104935@footnote{https://github.com/python/cpython/issues/104935}: Corrige bugs na interação entre @ref{443,,typing.runtime_checkable()} e @ref{15d7,,typing.Generic} que foram introduzidos pela implementação 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}. Patch por Jelle Zijlstra.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{crypt} e sua extensão privada @code{_crypt}, descontinuados no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{nis}, obsoletos no Python 3.11. Patch por Victor Stinner.

@item 
gh-104898@footnote{https://github.com/python/cpython/issues/104898}: Adiciona @ref{1533,,__slots__} ausente a @ref{c6c,,os.PathLike}.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{xdrlib}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{nntplib}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104886@footnote{https://github.com/python/cpython/issues/104886}: Remove a classe não documentada @code{configparser.LegacyInterpolation}, descontinuada na documentação desde o Python 3.2 e com um aviso de descontinuação desde o Python 3.11. Patch por Hugo van Kemenade.

@item 
gh-104786@footnote{https://github.com/python/cpython/issues/104786}: Remove a criação de @ref{162,,typing.TypedDict} baseada em kwargs.

@item 
gh-104876@footnote{https://github.com/python/cpython/issues/104876}: Remove o método @code{turtle.RawTurtle.settiltangle()}, descontinuado na documentação desde o Python 3.1 e com um aviso de descontinuação desde o Python 3.11. Patch por Hugo van Kemenade.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Removido o pacote @code{msilib}, descontinuado no Python 3.11.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Removido o módulo @code{spwd}, descontinuado no Python 3.11: o projeto python-pam@footnote{https://pypi.org/project/python-pam/} pode ser usado em seu lugar. Patch por Victor Stinner.

@item 
gh-75552@footnote{https://github.com/python/cpython/issues/75552}: Removido o módulo @code{tkinter.tix}, descontinuado desde o Python 3.6.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{chunk}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{mailcap}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{sunau}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104780@footnote{https://github.com/python/cpython/issues/104780}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{ossaudiodev}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: Remove o módulo @code{pipes}, descontinuado no Python 3.11. Patch por Victor Stinner.

@item 
gh-104873@footnote{https://github.com/python/cpython/issues/104873}: Adiciona @ref{263,,typing.get_protocol_members()} para retornar o conjunto de membros que definem um @ref{264,,typing.Protocol}. Adiciona @ref{265,,typing.is_protocol()} para verificar se uma classe é um @ref{264,,typing.Protocol}. Patch por Jelle Zijlstra.

@item 
gh-104874@footnote{https://github.com/python/cpython/issues/104874}: Documenta os atributos @code{__name__} e @code{__supertype__} de @ref{d16,,typing.NewType}. Patch por Jelle Zijlstra.

@item 
gh-104835@footnote{https://github.com/python/cpython/issues/104835}: Removidas as seguintes funções @ref{106,,unittest}, descontinuadas no Python 3.11:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

Em vez delas, use os métodos de @ref{28e,,TestLoader}:


@itemize *

@item 
@ref{28f,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{290,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{291,,unittest.TestLoader.getTestCaseNames()}
@end itemize

Patch por 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{229,,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 Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}) @code{type_params}
field on @ref{17f8,,ast.ClassDef}, @ref{17f9,,ast.AsyncFunctionDef}, and
@ref{17fa,,ast.FunctionDef} to better preserve backward compatibility. Patch
by Jelle Zijlstra

@item 
gh-104797@footnote{https://github.com/python/cpython/issues/104797}: Allow @ref{264,,typing.Protocol} classes to inherit from
@ref{2e9,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{22d,,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{a68,,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{1da,,dis.Instruction}.

@item 
gh-103558@footnote{https://github.com/python/cpython/issues/103558}: Fixed @code{parent} argument validation mechanism of
@ref{6,,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{7ed,,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{22d,,pathlib.Path.glob()} and
@ref{22e,,rglob()}, defaulting to false.

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: Hide traceback in @ref{8dd,,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{2de,,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{4ac,,pathlib.PurePath.match()}.

@item 
gh-84867@footnote{https://github.com/python/cpython/issues/84867}: @ref{28e,,unittest.TestLoader} no longer loads test cases from
exact @ref{44f,,unittest.TestCase} and @ref{17fb,,unittest.FunctionTestCase}
classes.

@item 
gh-99203@footnote{https://github.com/python/cpython/issues/99203}: Restore following CPython <= 3.10.5 behavior of
@ref{4b3,,shutil.make_archive()}: do not create an empty archive if
@code{root_dir} is not a directory, and, in that case, raise
@ref{42b,,FileNotFoundError} or @ref{1093,,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{1a5,,DeprecationWarning} for @ref{7,,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{16f4,,unittest.mock.create_autospec()} now properly returns
coroutine functions compatible with @ref{2e4,,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{e61,,operator.methodcaller()} using the
@geindex Propostas de Melhorias do Python; 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{101d,,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{9f8,,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 Documentação<16>,Testes<20>,Biblioteca<38>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id206}@anchor{17fc}
@subsubsection Documentação



@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{38,,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{56d,,PyInterpreterConfig} and
@ref{45c,,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{2b,,curses} module variables
@ref{e17,,LINES} and @ref{e18,,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{9f7,,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{25c,,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{25c,,traceback.TracebackException}
class.

@item 
gh-104943@footnote{https://github.com/python/cpython/issues/104943}: Remove mentions of old Python versions in
@ref{2b0,,typing.NamedTuple}.

@item 
gh-54738@footnote{https://github.com/python/cpython/issues/54738}: Add documentation on how to localize the @ref{6,,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{2f7,,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 Testes<20>,Construção<20>,Documentação<16>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id207}@anchor{17fd}
@subsubsection Testes



@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{69d,,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{12b5,,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{1dc,,doctest.DocTestRunner.run()} method now counts the
number of skipped tests. Add @ref{1dd,,doctest.DocTestRunner.skips} and
@ref{1de,,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{17fe,,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{14,,calendar} to achieve full test
coverage.
@end itemize

@node Construção<20>,Windows<18>,Testes<20>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id208}@anchor{17ff}
@subsubsection Construção



@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 variável de ambiente; PROFILE_TASK
@ref{1800,,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{395,,--with-trace-refs}
(tracing references) is now ABI compatible with Python release build and
@ref{1f9,,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{396,,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<18>,macOS<13>,Construção<20>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id209}@anchor{1801}
@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{225,,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{225,,realpath()} to behave consistently when
passed a path containing an embedded null character on Windows. In strict
mode, it now raises @ref{417,,OSError} instead of the unexpected
@ref{202,,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{5be,,Inicializador 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{a65,,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{4a0,,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{1739,,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<13>,IDLE<17>,Windows<18>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id210}@anchor{1802}
@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<17>,Ferramentas/Demos<12>,macOS<13>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id211}@anchor{1803}
@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 Ferramentas/Demos<12>,API C<21>,IDLE<17>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id212}@anchor{1804}
@subsubsection Ferramentas/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{396,,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 API C<21>,,Ferramentas/Demos<12>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id213}@anchor{1805}
@subsubsection API C



@itemize -

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: If the @ref{41e,,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{376,,PyUnicode_EqualToUTF8AndSize()} and
@ref{377,,PyUnicode_EqualToUTF8()} functions.

@item 
gh-110235@footnote{https://github.com/python/cpython/issues/110235}: Raise @ref{2c3,,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{1806,,PyImport_GetImporter()} now sets RuntimeError if it
fails to get @ref{105a,,sys.path_hooks} or @ref{5e4,,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{15b,,PyMutex} internal-only lightweight locking API.

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: Add @ref{36e,,PySys_AuditTuple()} function: similar to
@ref{36f,,PySys_Audit()}, but pass event arguments as a Python @ref{370,,tuple}
object.  Patch by Victor Stinner.

@item 
gh-108867@footnote{https://github.com/python/cpython/issues/108867}: Add @ref{371,,PyThreadState_GetUnchecked()} function: similar to
@ref{372,,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{37a,,PyObject_HasAttrWithError()},
@ref{37c,,PyObject_HasAttrStringWithError()},
@ref{37e,,PyMapping_HasKeyWithError()} and
@ref{380,,PyMapping_HasKeyStringWithError()}.

@item 
gh-107073@footnote{https://github.com/python/cpython/issues/107073}: Add @ref{369,,PyObject_VisitManagedDict()} and
@ref{36a,,PyObject_ClearManagedDict()} functions which must be called by the
traverse and clear functions of a type using
@ref{36b,,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{395,,--with-trace-refs}
(tracing references) now supports the @ref{396,,Limited API}.
Patch by Victor Stinner.

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: Add @ref{35f,,PyLong_AsInt()} function: similar to
@ref{360,,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{337,,PyDict_ContainsString()} function: same as
@ref{338,,PyDict_Contains()}, but `key' is specified as a const char* UTF-8 encoded bytes string, rather than a @ref{339,,PyObject}*.
Patch by Victor Stinner.

@item 
gh-108337@footnote{https://github.com/python/cpython/issues/108337}: Adiciona operações atômicas em tipos de dados adicionais em pyatomic.h.

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: Add @ref{358,,Py_IsFinalizing()} function: check if the main
Python interpreter is @ref{14e,,shutting down}. Patch
by Victor Stinner.

@item 
gh-107916@footnote{https://github.com/python/cpython/issues/107916}: C API functions @ref{1807,,PyErr_SetFromErrnoWithFilename()},
@ref{1808,,PyErr_SetExcFromWindowsErrWithFilename()} and
@ref{1809,,PyErr_SetFromWindowsErrWithFilename()} save now the error code
before calling @ref{180a,,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{1a5,,DeprecationWarning} for uses of
@ref{180b,,PyType_Spec} with metaclasses that have custom @code{tp_new}.

@item 
gh-107249@footnote{https://github.com/python/cpython/issues/107249}: Implement the @ref{180c,,Py_UNUSED} macro for Windows MSVC
compiler. Patch by Victor Stinner.

@item 
gh-107226@footnote{https://github.com/python/cpython/issues/107226}: @ref{365,,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{bd4,,PyUnicode_AsUTF8()}. It was kept for backward compatibility with
Python 3.0 - 3.2. The @ref{bd4,,PyUnicode_AsUTF8()} is available since Python
3.3. The @ref{11cd,,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{161f,,PyObject_DelAttr()} and
@ref{1620,,PyObject_DelAttrString()} macros to functions. Patch by Victor
Stinner.

@item 
gh-106307@footnote{https://github.com/python/cpython/issues/106307}: Add @ref{345,,PyMapping_GetOptionalItem()} function.

@item 
gh-106521@footnote{https://github.com/python/cpython/issues/106521}: Add @ref{349,,PyObject_GetOptionalAttr()} and
@ref{34a,,PyObject_GetOptionalAttrString()} functions.

@item 
gh-106320@footnote{https://github.com/python/cpython/issues/106320}: Remove @code{_PyInterpreterState_Get()} alias to
@ref{3ad,,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 Propostas de Melhorias do Python; 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{1f9,,debug mode} or
@ref{38c,,with assertions}, @ref{38d,,PyTuple_SET_ITEM()}
and @ref{38e,,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{33a,,PyDict_GetItemRef()} and
@ref{33b,,PyDict_GetItemStringRef()} functions: similar to
@ref{33c,,PyDict_GetItemWithError()} but returning a @ref{33d,,strong reference}
instead of a @ref{33e,,borrowed reference}. Patch by Victor Stinner.

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: Deprecate the @ref{379,,PyWeakref_GetObject()} and
@ref{3bf,,PyWeakref_GET_OBJECT()} functions: use the new
@ref{378,,PyWeakref_GetRef()} function instead. Patch by Victor Stinner.

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: Add @ref{378,,PyWeakref_GetRef()} function: similar to
@ref{379,,PyWeakref_GetObject()} but returns a @ref{33d,,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{356,,PyImport_AddModuleRef()}: similar to
@ref{357,,PyImport_AddModule()}, but return a @ref{33d,,strong reference}
instead of a @ref{33e,,borrowed reference}. Patch by Victor Stinner.

@item 
gh-105227@footnote{https://github.com/python/cpython/issues/105227}: The new @ref{180d,,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{180e,,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{180f,,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{56e,,Py_INCREF()} and
@ref{56f,,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{3bd,,PyImport_ImportModuleNoBlock()} function
which is just an alias to @ref{3be,,PyImport_ImportModule()} since Python
3.3. Patch by Victor Stinner.

@item 
gh-103968@footnote{https://github.com/python/cpython/issues/103968}: @ref{550,,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{3af,,PySys_ResetWarnOptions()}

@item 
@ref{3b1,,Py_GetExecPrefix()}

@item 
@ref{3b3,,Py_GetPath()}

@item 
@ref{3b5,,Py_GetPrefix()}

@item 
@ref{3b7,,Py_GetProgramFullPath()}

@item 
@ref{3b9,,Py_GetProgramName()}

@item 
@ref{3ba,,Py_GetPythonHome()}
@end itemize

Patch por 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{399,,PyObject_GetBuffer()} and @ref{39a,,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 por 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{39b,,PyObject_CallNoArgs()} and @ref{39c,,PyObject_Call()} (positional
arguments must not be `NULL') instead.

@item 
@code{PyEval_CallFunction()}: use @ref{39e,,PyObject_CallFunction()}.

@item 
@code{PyEval_CallMethod()}: use @ref{39f,,PyObject_CallMethod()}.

@item 
@code{PyCFunction_Call()}: use @ref{39c,,PyObject_Call()}.
@end itemize

Patch por 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{5b8,,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{571,,PyArg_ParseTuple()} and
@ref{8ac,,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{585,,PyOS_InputHook} or
@ref{586,,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{364,,PyModule_Add()} function: similar to
@ref{365,,PyModule_AddObjectRef()} and @ref{366,,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{8ac,,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,Changelog
@anchor{whatsnew/changelog python-3-12-0-beta-1}@anchor{1810}
@subsection Python 3.12.0 beta 1


`Data de lançamento: 2023-05-22'

@menu
* Segurança: Segurança<18>. 
* Biblioteca: Biblioteca<39>. 
* Núcleo e embutidos: Núcleo e embutidos<35>. 
* Biblioteca: Biblioteca<40>. 
* Núcleo e embutidos: Núcleo e embutidos<36>. 
* Biblioteca: Biblioteca<41>. 
* Núcleo e embutidos: Núcleo e embutidos<37>. 
* Biblioteca: Biblioteca<42>. 
* Documentação: Documentação<17>. 
* Testes: Testes<21>. 
* Construção: Construção<21>. 
* Windows: Windows<19>. 
* macOS: macOS<14>. 
* IDLE: IDLE<18>. 
* Ferramentas/Demos: Ferramentas/Demos<13>. 
* API C: API C<22>. 

@end menu

@node Segurança<18>,Biblioteca<39>,,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id214}@anchor{1811}
@subsubsection Segurança



@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{d61,,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 Biblioteca<39>,Núcleo e embutidos<35>,Segurança<18>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id215}@anchor{1812}
@subsubsection Biblioteca



@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
@end itemize

@node Núcleo e embutidos<35>,Biblioteca<40>,Biblioteca<39>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id216}@anchor{1813}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{187,,bytecode} instructions could
ignore 
@geindex Propostas de Melhorias do Python; 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{611,,list} or @ref{370,,tuple} repetition
could fail to respect 
@geindex Propostas de Melhorias do Python; 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{37d,,PyObject_HasAttrString()}

@item 
gh-104066@footnote{https://github.com/python/cpython/issues/104066}: Improve the performance of @ref{4d2,,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{c27,,True}, @ref{b49,,False}, and @ref{675,,None}) in the main interpreter
loop.

@item 
gh-103899@footnote{https://github.com/python/cpython/issues/103899}: Provide a helpful hint in the @ref{2c3,,TypeError} message when
accidentally calling a @ref{1755,,module} object that has a callable attribute
of the same name (such as @ref{b46,,dis.dis()} or @ref{1cc,,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 Propostas de Melhorias do Python; 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.
@end itemize

@node Biblioteca<40>,Núcleo e embutidos<36>,Núcleo e embutidos<35>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id217}@anchor{1814}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<36>,Biblioteca<41>,Biblioteca<40>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id218}@anchor{1815}
@subsubsection Núcleo e embutidos



@itemize -

@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{1b6,,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{5b8,,except*}.

@item 
gh-103492@footnote{https://github.com/python/cpython/issues/103492}: Clarify @ref{466,,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{4dc,,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{195,,RuntimeError}. Context information is added
to the exception as a 
@geindex Propostas de Melhorias do Python; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} note.

@item 
gh-103333@footnote{https://github.com/python/cpython/issues/103333}: @ref{34b,,AttributeError} now retains the @code{name} attribute when
pickled and unpickled.
@end itemize

@node Biblioteca<41>,Núcleo e embutidos<37>,Núcleo e embutidos<36>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id219}@anchor{1816}
@subsubsection Biblioteca



@itemize -

@item 
gh-103242@footnote{https://github.com/python/cpython/issues/103242}: Migrate @ref{1182,,set_ecdh_curve()} method not to
use deprecated OpenSSL APIs. Patch by Donghee Na.
@end itemize

@node Núcleo e embutidos<37>,Biblioteca<42>,Biblioteca<41>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id220}@anchor{1817}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{6f9,,CACHE} entries for
@ref{707,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{1026,,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{2eb,,memoryview} objects (such
as @code{memoryview(ctypes.c_uint8(42))}) now raises a @ref{2c3,,TypeError}.
Previously this returned @code{1}, which was not consistent with
@code{mem_0d[0]} raising an @ref{157e,,IndexError}.
@end itemize

@node Biblioteca<42>,Documentação<17>,Núcleo e embutidos<37>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id221}@anchor{1818}
@subsubsection Biblioteca



@itemize -

@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{a,,asyncio}.

@item 
gh-104600@footnote{https://github.com/python/cpython/issues/104600}: @ref{1058,,functools.update_wrapper()} now sets the
@code{__type_params__} attribute (added by 
@geindex Propostas de Melhorias do Python; 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{7c2,,issubclass()} check comparing a class
@code{X} against a @ref{443,,runtime-checkable protocol} @code{Y} with non-callable members would not
cause @ref{2c3,,TypeError} to be raised if an @ref{442,,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{4ac,,pathlib.PurePath.match()}

@item 
gh-75367@footnote{https://github.com/python/cpython/issues/75367}: Fix data descriptor detection in
@ref{494,,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{22d,,pathlib.Path.glob()} raised
@ref{d90,,RecursionError} when walking deep directory trees.

@item 
gh-103000@footnote{https://github.com/python/cpython/issues/103000}: Improve performance of @ref{1819,,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{17b6,,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{22d,,pathlib.Path.glob()} raised @ref{417,,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{22d,,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{22d,,pathlib.Path.glob()} returned incomplete
results when it encountered a @ref{d65,,PermissionError}. This method now
suppresses all @ref{417,,OSError} exceptions, except those raised from calling
@ref{230,,is_dir()} on the top-level path.

@item 
gh-104144@footnote{https://github.com/python/cpython/issues/104144}: Optimize @ref{1b5,,asyncio.TaskGroup} when using
@ref{477,,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{5fd,,asyncio.gather()} when using
@ref{477,,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{22d,,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{22d,,pathlib.Path.glob()} by using
@ref{181a,,re.IGNORECASE} to implement case-insensitive matching.

@item 
gh-104102@footnote{https://github.com/python/cpython/issues/104102}: Improve performance of @ref{22d,,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{171b,,typing.Unpack} according to
@geindex Propostas de Melhorias do Python; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/}.

@item 
gh-103963@footnote{https://github.com/python/cpython/issues/103963}: Make @ref{38,,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{181b,,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{181c,,io.open_code()} for files to be executed instead of
raw @ref{51c,,open()}

@item 
gh-68968@footnote{https://github.com/python/cpython/issues/68968}: Fixed garbled output of @ref{529,,assertEqual()}
when an input lacks final newline.

@item 
gh-100370@footnote{https://github.com/python/cpython/issues/100370}: Fix potential @ref{885,,OverflowError} in
@ref{681,,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{14,,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{d61,,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{38,,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{2fc,,datetime.datetime.utcnow()} and
@ref{2fd,,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{f58,,contextlib.suppress} now supports suppressing
exceptions raised as part of an @ref{1b6,,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{9f5,,datetime.datetime.fromisocalendar()} in the
implementation of @ref{16f6,,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{181d,,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{51d,,io.open()} with
@ref{181c,,io.open_code()}. The new method would also call into the hook set by
@ref{181e,,PyFile_SetOpenCodeHook()}.

@item 
gh-103556@footnote{https://github.com/python/cpython/issues/103556}: Now creating @ref{1cf,,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{17a2,,pathlib.Path.absolute()} and
@ref{181f,,cwd()} by joining paths only when necessary. Also
improve performance of @ref{1820,,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{27,,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{4a6,,pathlib.PurePath} and
@ref{229,,Path}.

@item 
gh-103489@footnote{https://github.com/python/cpython/issues/103489}: Add @ref{4b9,,getconfig()} and
@ref{4ba,,setconfig()} to @ref{245,,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{244,,ResourceWarning} in
@ref{b53,,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{15dc,,writelines()} in @ref{a,,asyncio} to send very
large payloads that exceed the amount of data that can be written in one
call to @ref{dcf,,socket.socket.send()} or @ref{476,,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{1cb,,dataclasses.dataclass()}.

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: Isolate @code{_collections} (apply 
@geindex Propostas de Melhorias do Python; 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{14df,,logging.Formatter} @code{defaults}
parameter to @ref{11ef,,logging.config.dictConfig()} and
@ref{b66,,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 Propostas de Melhorias do Python; 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{442,,isinstance()} checks against
@ref{443,,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{4d1,,“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{9e0,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{ec1,,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 Propostas de Melhorias do Python; 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{4a7,,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{1821,,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{171f,,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{494,,inspect.getattr_static()}. Patch by
Alex Waygood.

@item 
gh-103176@footnote{https://github.com/python/cpython/issues/103176}: @ref{4c2,,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{4b8,,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{1822,,dataclasses.astuple()} and
@ref{1819,,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{46b,,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{46c,,Filtros de extração} 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{22d,,pathlib.Path.glob()} and @ref{22e,,rglob()}.

@item 
gh-101819@footnote{https://github.com/python/cpython/issues/101819}: Isolate the @ref{7f,,io} extension module by applying 
@geindex Propostas de Melhorias do Python; 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 @ref{2e7,,collections.abc.ByteString}

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{229,,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{38,,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{4a6,,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{17bf,,tty.cfmakeraw()} and @ref{176f,,tty.cfmakecbreak()} to
@ref{100,,tty} and modernize, the behavior of @ref{17be,,tty.setraw()} and
@ref{176e,,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{4ce,,types.get_original_bases()} to provide further
introspection for types.

@item 
gh-101640@footnote{https://github.com/python/cpython/issues/101640}: @ref{539,,argparse.ArgumentParser} now catches errors when
writing messages, such as when @ref{940,,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{b53,,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 @ref{2cb,,pkgutil.find_loader()} and
@ref{2cc,,pkgutil.get_loader()} in favor of @ref{2cd,,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{199,,subprocess.Popen}.

@item 
gh-94906@footnote{https://github.com/python/cpython/issues/94906}: Support multiple steps in @ref{498,,math.nextafter()}. Patch by
Shantanu Jain and Matthias Gorgens.

@item 
gh-51574@footnote{https://github.com/python/cpython/issues/51574}: Make @ref{21f,,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{131,,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{22d,,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{485,,QUOTE_STRINGS} and @ref{484,,QUOTE_NOTNULL}
to the suite of @ref{29,,csv} module quoting styles.

@item 
bpo-24964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24964}: Added
@ref{17f5,,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{1823,,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 Documentação<17>,Testes<21>,Biblioteca<42>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id222}@anchor{1824}
@subsubsection Documentação



@itemize -

@item 
gh-67056@footnote{https://github.com/python/cpython/issues/67056}: Document that the effect of registering or unregistering an
@ref{c,,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 Propostas de Melhorias do Python; 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 Testes<21>,Construção<21>,Documentação<17>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id223}@anchor{1825}
@subsubsection Testes



@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{134,,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{1826,,os.spawn*} tests failing on Windows
when the working directory or interpreter path contains spaces.
@end itemize

@node Construção<21>,Windows<19>,Testes<21>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id224}@anchor{1827}
@subsubsection Construção



@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<19>,macOS<14>,Construção<21>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id225}@anchor{1828}
@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{116d,,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{2c3,,TypeError} was raised when calling
@code{ntpath.realpath()} with a bytes parameter in some cases.
@end itemize

@node macOS<14>,IDLE<18>,Windows<19>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id226}@anchor{1829}
@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<18>,Ferramentas/Demos<13>,macOS<14>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id227}@anchor{182a}
@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 Ferramentas/Demos<13>,API C<22>,IDLE<18>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id228}@anchor{182b}
@subsubsection Ferramentas/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{180c,,Py_UNUSED}. Patch by Erlend E.
Aasland.
@end itemize

@node API C<22>,,Ferramentas/Demos<13>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id229}@anchor{182c}
@subsubsection API C



@itemize -

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: Added unstable C API for extracting the value of “compact”
integers: @ref{589,,PyUnstable_Long_IsCompact()} and
@ref{58a,,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{57d,,PyType_FromSpec()} and its variants now allow creating
classes whose metaclass overrides @ref{57f,,tp_new}. The
@code{tp_new} is ignored. This behavior is deprecated and will be disallowed
in 3.14+. The new @ref{550,,PyType_FromMetaclass()} already disallows it.

@item 
gh-103743@footnote{https://github.com/python/cpython/issues/103743}: Add @ref{182d,,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{182e,,PyUnstable_WritePerfMapEntry()},
@ref{182f,,PyUnstable_PerfMapState_Init()} and
@ref{1830,,PyUnstable_PerfMapState_Fini()}. These allow extension modules (JIT
compilers in particular) to write to perf-map files in a thread safe
manner. The @ref{1831,,Suporte do Python ao perfilador perf do 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{548,,PyType_Spec.basicsize} can now be zero or negative,
@ref{549,,PyObject_GetTypeData()} can be used to get subclass-specific data,
and @ref{54b,,Py_TPFLAGS_ITEMS_AT_END} can be used to safely extend
variable-size objects. See 
@geindex Propostas de Melhorias do Python; 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{1832,,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{38a,,PyUnicode_FromFormat()} and @ref{574,,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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-7}@anchor{1833}
@subsection Python 3.12.0 alpha 7


`Data de lançamento: 2023-04-04'

@menu
* Núcleo e embutidos: Núcleo e embutidos<38>. 
* Biblioteca: Biblioteca<43>. 
* Núcleo e embutidos: Núcleo e embutidos<39>. 
* Construção: Construção<22>. 
* Núcleo e embutidos: Núcleo e embutidos<40>. 
* Biblioteca: Biblioteca<44>. 
* Documentação: Documentação<18>. 
* Testes: Testes<22>. 
* Construção: Construção<23>. 
* Windows: Windows<20>. 
* Ferramentas/Demos: Ferramentas/Demos<14>. 
* API C: API C<23>. 

@end menu

@node Núcleo e embutidos<38>,Biblioteca<43>,,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id230}@anchor{1834}
@subsubsection Núcleo e embutidos



@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{6f9,,CACHE} entries for
@ref{1835,,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{4be,,sys.last_exc} and deprecate @ref{4bf,,sys.last_type},
@ref{4c0,,sys.last_value} and @ref{4c1,,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{970,,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{402,,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{6f9,,CACHE} entries used by
@ref{17dc,,LOAD_GLOBAL}.
@end itemize

@node Biblioteca<43>,Núcleo e embutidos<39>,Núcleo e embutidos<38>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id231}@anchor{1836}
@subsubsection Biblioteca



@itemize -

@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}).
@end itemize

@node Núcleo e embutidos<39>,Construção<22>,Biblioteca<43>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id232}@anchor{1837}
@subsubsection Núcleo e embutidos



@itemize -

@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{1b,,codecs} encoding/decoding errors now get the context
information (which operation and which codecs) attached as 
@geindex Propostas de Melhorias do Python; 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.
@end itemize

@node Construção<22>,Núcleo e embutidos<40>,Núcleo e embutidos<39>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id233}@anchor{1838}
@subsubsection Construção



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<40>,Biblioteca<44>,Construção<22>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id234}@anchor{1839}
@subsubsection Núcleo e embutidos



@itemize -

@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
@end itemize

@node Biblioteca<44>,Documentação<18>,Núcleo e embutidos<40>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id235}@anchor{183a}
@subsubsection Biblioteca



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Adapt @code{_pickle} to 
@geindex Propostas de Melhorias do Python; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}. Patch by Mohamed Koubaa
and Erlend Aasland.

@item 
gh-103085@footnote{https://github.com/python/cpython/issues/103085}: Pure python @ref{2dc,,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{928,,Pdb} that raise @ref{18d,,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{38,,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{442,,isinstance()} checks against @ref{443,,runtime-checkable protocols} now use
@ref{494,,inspect.getattr_static()} rather than @ref{4d2,,hasattr()} to lookup
whether attributes exist. This means that descriptors and
@ref{4d3,,__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{928,,Pdb} that raise @ref{18d,,SyntaxError}. Patch by Tian Gao.

@item 
gh-102947@footnote{https://github.com/python/cpython/issues/102947}: Improve traceback when @ref{183b,,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{17bd,,asyncio.Timeout} context manager now works reliably
even when performing cleanup due to task cancellation.  Previously it
could raise a @ref{1b8,,CancelledError} instead of an
@ref{183c,,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{1508,,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{301,,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{15e,,ParamSpec}. Previously, if the
@code{ParamSpec} was substituted with a parameters list that itself contained
a @ref{15d,,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{4a6,,pathlib.PurePath} and @ref{229,,Path} subclasses were not
called in some circumstances.

@item 
gh-78530@footnote{https://github.com/python/cpython/issues/78530}: @ref{47f,,asyncio.wait()} now accepts generators yielding tasks.
Patch by Kumar Aditya.

@item 
gh-102748@footnote{https://github.com/python/cpython/issues/102748}: @ref{47e,,asyncio.iscoroutine()} now returns @code{False} for
generators as @ref{a,,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{15e,,ParamSpec}. (Use square brackets to
represent a parameter list.)

@item 
gh-100112@footnote{https://github.com/python/cpython/issues/100112}: @ref{9e4,,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{49d,,os.listdrives()}, @ref{49e,,os.listvolumes()} and
@ref{49f,,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{492,,inspect.getasyncgenstate()} and
@ref{493,,inspect.getasyncgenlocals()}. Patch by Thomas Krennwallner.

@item 
gh-102103@footnote{https://github.com/python/cpython/issues/102103}: Add @code{module} argument to @ref{183d,,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{2f,,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{f1d,,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{1275,,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{183e,,unittest.TextTestRunner} and
@ref{531,,unittest.TextTestResult} constructors accept a new `durations'
keyword argument. Subclasses should take this into account or accept
@code{**kwargs}. Added @ref{183f,,unittest.TestResult.addDuration()} method and
@ref{17fe,,unittest.TestResult.collectedDurations} attribute.

(Contribuição de Giampaolo Rodola)

@item 
gh-98169@footnote{https://github.com/python/cpython/issues/98169}: Fix @ref{1822,,dataclasses.astuple()} crash when
@ref{11fc,,collections.defaultdict} is present in the attributes.

@item 
gh-96931@footnote{https://github.com/python/cpython/issues/96931}: Fix incorrect results from @ref{e9b,,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{1840,,SSLEOFError}, matching the
behavior in previous versions of OpenSSL. The
@ref{83b,,options} attribute on @ref{294,,SSLContext} also
no longer includes @ref{83a,,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{1645,,uuid.uuid3()} and @ref{1647,,uuid.uuid5()} functions support
@ref{1c2,,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{2c4,,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 Documentação<18>,Testes<22>,Biblioteca<44>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id236}@anchor{1841}
@subsubsection Documentação



@itemize -

@item 
gh-103112@footnote{https://github.com/python/cpython/issues/103112}: Add docstring to @ref{1669,,http.client.HTTPResponse.read()} to fix
@code{pydoc} output.
@end itemize

@node Testes<22>,Construção<23>,Documentação<18>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id237}@anchor{1842}
@subsubsection Testes



@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 Construção<23>,Windows<20>,Testes<22>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id238}@anchor{1843}
@subsubsection Construção



@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<20>,Ferramentas/Demos<14>,Construção<23>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id239}@anchor{1844}
@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 Ferramentas/Demos<14>,API C<23>,Windows<20>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id240}@anchor{1845}
@subsubsection Ferramentas/Demos



@itemize -

@item 
gh-102809@footnote{https://github.com/python/cpython/issues/102809}: @code{Misc/gdbinit} was removed.
@end itemize

@node API C<23>,,Ferramentas/Demos<14>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id241}@anchor{1846}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-6}@anchor{1847}
@subsection Python 3.12.0 alpha 6


`Data de lançamento: 2023-03-07'

@menu
* Segurança: Segurança<19>. 
* Núcleo e embutidos: Núcleo e embutidos<41>. 
* Biblioteca: Biblioteca<45>. 
* Documentação: Documentação<19>. 
* Testes: Testes<23>. 
* Construção: Construção<24>. 
* Windows: Windows<21>. 
* macOS: macOS<15>. 
* API C: API C<24>. 

@end menu

@node Segurança<19>,Núcleo e embutidos<41>,,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id242}@anchor{1848}
@subsubsection Segurança



@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{199,,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 Núcleo e embutidos<41>,Biblioteca<45>,Segurança<19>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id243}@anchor{1849}
@subsubsection Núcleo e embutidos



@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{184a,,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{184b,,socket.getaddrinfo} no longer raises
@ref{885,,OverflowError} for @ref{257,,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{184c,,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{4e2,,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 @ref{4e9,,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 Biblioteca<45>,Documentação<19>,Núcleo e embutidos<41>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id244}@anchor{184d}
@subsubsection Biblioteca



@itemize -

@item 
gh-102302@footnote{https://github.com/python/cpython/issues/102302}: Micro-optimise hashing of @ref{1d0,,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{19e,,argparse.ArgumentParser.add_argument()} were dropped. Patch by Yeojin
Kim.

@item 
gh-91038@footnote{https://github.com/python/cpython/issues/91038}: @ref{184e,,platform.platform()} now has boolean default arguments.

@item 
gh-81652@footnote{https://github.com/python/cpython/issues/81652}: Add @ref{184f,,mmap.MAP_ALIGNED_SUPER} FreeBSD and
@ref{1850,,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{b79,,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{ed3,,io.BytesIO} if
@ref{1014,,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{575,,SystemError} when
the callable object exhausts the iterator but forgets to either return a
sentinel value or raise @ref{c15,,StopIteration}.

@item 
gh-87634@footnote{https://github.com/python/cpython/issues/87634}: Remove locking behavior from @ref{541,,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{f,,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{1e7,,fractions.Fraction} for small components. The
private argument @code{_normalize} of the @ref{1e7,,fractions.Fraction}
constructor has been removed.

@item 
gh-101693@footnote{https://github.com/python/cpython/issues/101693}: In @ref{2d1,,sqlite3.Cursor.execute()}, @ref{1a5,,DeprecationWarning} is
now emitted when @ref{2d3,,named placeholders} are used
together with parameters supplied as a @ref{4f1,,sequence} instead of as a
@ref{256,,dict}. Starting from Python 3.14, using named placeholders with
parameters supplied as a sequence will raise a
@ref{4f2,,ProgrammingError}. Patch by Erlend E. Aasland.

@item 
gh-101446@footnote{https://github.com/python/cpython/issues/101446}: Change repr of @ref{5db,,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{4a6,,pathlib.PurePath} construction by handling
arguments more uniformly. When a @ref{229,,pathlib.Path} argument is
supplied, we use its string representation rather than joining its parts
with @ref{171f,,os.path.join()}.

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: Speed up @ref{4a6,,pathlib.PurePath} construction by calling
@ref{171f,,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{229,,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{1851,,pty.fork()} to use
@ref{1852,,os.login_tty()}.

A @ref{1a5,,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{2ce,,pty.openpty()}.

@item 
gh-101561@footnote{https://github.com/python/cpython/issues/101561}: Add a new decorator @ref{44b,,typing.override()}. See 
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{17a2,,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 Propostas de Melhorias do Python; PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/} to @ref{134,,zoneinfo}. Patch by Erlend E. Aasland.

@item 
gh-96764@footnote{https://github.com/python/cpython/issues/96764}: @ref{5ff,,asyncio.wait_for()} now uses @ref{5fe,,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{1853,,lzma.LZMADecompressor} and
@ref{1854,,bz2.BZ2Decompressor} objects without calling @code{__init__()}, and
fix leakage of locks and internal buffers when calling the @code{__init__()}
methods of @ref{1853,,lzma.LZMADecompressor}, @ref{1855,,lzma.LZMACompressor},
@ref{1856,,bz2.BZ2Compressor}, and @ref{1854,,bz2.BZ2Decompressor} objects
multiple times.
@end itemize

@node Documentação<19>,Testes<23>,Biblioteca<45>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id245}@anchor{1857}
@subsubsection Documentação



@itemize -

@item 
gh-85417@footnote{https://github.com/python/cpython/issues/85417}: Update @ref{18,,cmath} documentation to clarify behaviour on branch
cuts.

@item 
gh-97725@footnote{https://github.com/python/cpython/issues/97725}: Fix @ref{1858,,asyncio.Task.print_stack()} description for
@code{file=None}. Patch by Oleg Iarygin.
@end itemize

@node Testes<23>,Construção<24>,Documentação<19>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id246}@anchor{1859}
@subsubsection Testes



@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 Construção<24>,Windows<21>,Testes<23>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id247}@anchor{185a}
@subsubsection Construção



@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{185b,,--with-strict-overflow}. Patch by Matthias Görgens and Shantanu
Jain.
@end itemize

@node Windows<21>,macOS<15>,Construção<24>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id248}@anchor{185c}
@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<15>,API C<24>,Windows<21>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id249}@anchor{185d}
@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 API C<24>,,macOS<15>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id250}@anchor{185e}
@subsubsection API C



@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{3f4,,PyErr_GetRaisedException()} and
@ref{3f7,,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{3f3,,PyErr_Fetch()} and @ref{3f6,,PyErr_Restore()}. This is less error
prone and a bit more efficient.

Add @ref{56a,,PyException_GetArgs()} and @ref{56b,,PyException_SetArgs()} as
convenience functions for retrieving and modifying the
@ref{56c,,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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-5}@anchor{185f}
@subsection Python 3.12.0 alpha 5


`Data de lançamento: 2023-02-07'

@menu
* Segurança: Segurança<20>. 
* Núcleo e embutidos: Núcleo e embutidos<42>. 
* Biblioteca: Biblioteca<46>. 
* Documentação: Documentação<20>. 
* Testes: Testes<24>. 
* Construção: Construção<25>. 
* Windows: Windows<22>. 

@end menu

@node Segurança<20>,Núcleo e embutidos<42>,,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id251}@anchor{1860}
@subsubsection Segurança



@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 Núcleo e embutidos<42>,Biblioteca<46>,Segurança<20>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id253}@anchor{1861}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-92173@footnote{https://github.com/python/cpython/issues/92173}: Fix the @code{defs} and @code{kwdefs} arguments to
@ref{1862,,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{9d1,,continue} or
@ref{ab8,,break} which are not in a loop. Patch by Donghee Na.

@item 
gh-101372@footnote{https://github.com/python/cpython/issues/101372}: Fix @ref{a51,,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{1863,,sys.getsizeof()} reporting for @ref{257,,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{15c5,,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{257,,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{314,,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{970,,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{1631,,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{344,,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}.
@end itemize

@node Biblioteca<46>,Documentação<20>,Núcleo e embutidos<42>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id254}@anchor{1864}
@subsubsection Biblioteca



@itemize -

@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{1d4,,ctypes.Structure} objects, reflecting their
true representation in memory.

@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{604,,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 Propostas de Melhorias do Python; 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{1865,,TimerHandle} in
@code{asyncio.base_events.BaseEventLoop._add_callback}.

@item 
gh-101144@footnote{https://github.com/python/cpython/issues/101144}: Make @ref{1680,,zipfile.Path.open()} and
@ref{1866,,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{2c3,,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{6b1,,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{4a4,,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{a,,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{1562,,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{1d4,,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{1e7,,fractions.Fraction} instances.

@item 
gh-99266@footnote{https://github.com/python/cpython/issues/99266}: Preserve more detailed error messages in @ref{2a,,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{1867,,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{1868,,c_byte} to @ref{1869,,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{1a5,,DeprecationWarning} when testing the truth value of an
@ref{310,,xml.etree.ElementTree.Element}. Before, the Python implementation
emitted @ref{415,,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{229,,pathlib.Path} accepted and ignored
keyword arguments. Patch provided by Yurii Karabas.

@item 
gh-77772@footnote{https://github.com/python/cpython/issues/77772}: @ref{9f1,,ctypes.CDLL}, @ref{186a,,ctypes.OleDLL},
@ref{186b,,ctypes.WinDLL}, and @ref{186c,,ctypes.PyDLL} now accept
@ref{2a0,,path-like objects} as their @code{name} argument.
Patch by Robert Hoelzl.
@end itemize

@node Documentação<20>,Testes<24>,Biblioteca<46>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id255}@anchor{186d}
@subsubsection Documentação



@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 Testes<24>,Construção<25>,Documentação<20>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id256}@anchor{186e}
@subsubsection Testes



@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 Construção<25>,Windows<22>,Testes<24>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id257}@anchor{186f}
@subsubsection Construção



@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 Propostas de Melhorias do Python; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}, the @code{ma_version_tag} field in
@ref{3c1,,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<22>,,Construção<25>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id258}@anchor{1870}
@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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-4}@anchor{1871}
@subsection Python 3.12.0 alpha 4


`Data de lançamento: 2023-01-10'

@menu
* Núcleo e embutidos: Núcleo e embutidos<43>. 
* Biblioteca: Biblioteca<47>. 
* Núcleo e embutidos: Núcleo e embutidos<44>. 
* Biblioteca: Biblioteca<48>. 
* Núcleo e embutidos: Núcleo e embutidos<45>. 
* Biblioteca: Biblioteca<49>. 
* Documentação: Documentação<21>. 
* Testes: Testes<25>. 
* Construção: Construção<26>. 
* Windows: Windows<23>. 
* macOS: macOS<16>. 
* Ferramentas/Demos: Ferramentas/Demos<15>. 
* API C: API C<25>. 

@end menu

@node Núcleo e embutidos<43>,Biblioteca<47>,,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id259}@anchor{1872}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-100776@footnote{https://github.com/python/cpython/issues/100776}: Fix misleading default value in @ref{131b,,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{4e1,,CALL_INTRINSIC_1} instruction. Remove
@code{IMPORT_STAR}, @code{PRINT_EXPR} and
@code{STOPITERATION_ERROR}, replacing them with the
@ref{4e1,,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{18d,,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 Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}.

@item 
gh-100268@footnote{https://github.com/python/cpython/issues/100268}: Add @ref{1873,,int.is_integer()} to improve duck type compatibility
between @ref{257,,int} and @ref{2f7,,float}.

@item 
gh-100425@footnote{https://github.com/python/cpython/issues/100425}: Improve the accuracy of @code{sum()} with compensated summation.
@end itemize

@node Biblioteca<47>,Núcleo e embutidos<44>,Núcleo e embutidos<43>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id260}@anchor{1874}
@subsubsection Biblioteca



@itemize -

@item 
gh-100374@footnote{https://github.com/python/cpython/issues/100374}: Fix incorrect result and delay in @ref{1875,,socket.getfqdn()}. Patch
by Dominic Socular.
@end itemize

@node Núcleo e embutidos<44>,Biblioteca<48>,Biblioteca<47>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id261}@anchor{1876}
@subsubsection Núcleo e embutidos



@itemize -

@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{2fb,,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{970,,COMPARE_OP} for
@ref{2f7,,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 @ref{1877,,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{4d2,,hasattr()} for type objects with
a missing attribute.

@item 
gh-99582@footnote{https://github.com/python/cpython/issues/99582}: Freeze @ref{132,,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.
@end itemize

@node Biblioteca<48>,Núcleo e embutidos<45>,Núcleo e embutidos<44>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id262}@anchor{1878}
@subsubsection Biblioteca



@itemize -

@item 
gh-89051@footnote{https://github.com/python/cpython/issues/89051}: Add @ref{1879,,ssl.OP_LEGACY_SERVER_CONNECT}
@end itemize

@node Núcleo e embutidos<45>,Biblioteca<49>,Biblioteca<48>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id263}@anchor{187a}
@subsubsection Núcleo e embutidos



@itemize -

@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 Biblioteca<49>,Documentação<21>,Núcleo e embutidos<45>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id264}@anchor{187b}
@subsubsection Biblioteca



@itemize -

@item 
gh-100833@footnote{https://github.com/python/cpython/issues/100833}: Speed up @ref{141b,,math.fsum()} by removing defensive @code{volatile}
qualifiers.

@item 
gh-100805@footnote{https://github.com/python/cpython/issues/100805}: Modify @ref{1271,,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{187c,,email.message.Message.__contains__()} twice as fast.

@item 
gh-91851@footnote{https://github.com/python/cpython/issues/91851}: Microoptimizations for @ref{187d,,fractions.Fraction.__round__()},
@ref{187e,,fractions.Fraction.__ceil__()} and
@ref{187f,,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{4a9,,os.walk()} by using
@ref{442,,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{b2b,,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{17a2,,pathlib.Path.absolute()} by nearly
2x. This comes at the cost of a performance regression in
@ref{181f,,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{bb9,,unittest.mock.seal()} with
@ref{a53,,unittest.mock.AsyncMock}.

@item 
gh-100488@footnote{https://github.com/python/cpython/issues/100488}: Add @code{Fraction.is_integer()} to check whether a
@ref{1e7,,fractions.Fraction} is an integer. This improves duck type
compatibility with @ref{2f7,,float} and @ref{257,,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{b1d,,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{47d,,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{1a5,,DeprecationWarning} may be raised when @ref{197,,os.fork()}
or @ref{198,,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{a,,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{123e,,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{1880,,datetime.time.strftime()} to `format'. Rename the `t' parameter of
@ref{4ed,,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{1014,,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{4a9,,os.walk()} where a @ref{d90,,RecursionError}
would occur on deep directory structures by adjusting the implementation
of @ref{4a9,,os.walk()} to be iterative instead of recursive.

@item 
gh-94943@footnote{https://github.com/python/cpython/issues/94943}: Add @ref{1881,,Suporte a dataclass} to the @ref{630,,Enum}
@ref{1882,,__repr__()}. When inheriting from a
@ref{1cb,,dataclass}, only show the field names in the value
section of the member @ref{800,,repr()}, and not the dataclass’ class name.

@item 
gh-83035@footnote{https://github.com/python/cpython/issues/83035}: Fix @ref{15f8,,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{490,,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 Propostas de Melhorias do Python; 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{3a,,doctest} failure on @ref{64b,,types.MethodWrapperType}
in modules.

@item 
gh-85267@footnote{https://github.com/python/cpython/issues/85267}: Several improvements to @ref{738,,inspect.signature()}’s handling of
@code{__text_signature}. - Fixes a case where @ref{738,,inspect.signature()}
dropped parameters - Fixes a case where @ref{738,,inspect.signature()} raised
@ref{542,,tokenize.TokenError} - Allows @ref{738,,inspect.signature()} to
understand defaults involving binary operations of constants -
@ref{738,,inspect.signature()} is documented as only raising @ref{2c3,,TypeError}
or @ref{202,,ValueError}, but sometimes raised @ref{195,,RuntimeError}. These
cases now raise @ref{202,,ValueError} - Removed a dead code path

@item 
gh-91166@footnote{https://github.com/python/cpython/issues/91166}: @ref{a,,asyncio} is optimized to avoid excessive copying when
writing to socket and use @ref{476,,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{1883,,urllib.parse.unquote()} and
@ref{1884,,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{b3c,,asynccontextmanager()}, which caused it to propagate
exceptions with incorrect tracebacks and fix a 3.11 regression in
@ref{1242,,contextmanager()}, which caused it to propagate
exceptions with incorrect tracebacks for @ref{c15,,StopIteration}.

@item 
gh-78707@footnote{https://github.com/python/cpython/issues/78707}: Deprecate passing more than one positional argument to
@ref{2ca,,pathlib.PurePath.relative_to()} and
@ref{2c9,,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{1e7,,Fraction} arithmetics for small
components.

@item 
bpo-24132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24132}: Make @ref{4a6,,pathlib.PurePath} and @ref{229,,Path}
subclassable (private to start). Previously, attempting to instantiate a
subclass resulted in an @ref{34b,,AttributeError} being raised. Patch by
Barney Gale.

@item 
bpo-40447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40447}: Accept @ref{c6c,,os.PathLike} (such as @ref{229,,pathlib.Path}) in
the @code{stripdir} arguments of @ref{e0b,,compileall.compile_file()} and
@ref{b38,,compileall.compile_dir()}.

@item 
bpo-36880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36880}: Fix a reference counting issue when a @ref{2a,,ctypes} callback
with return type @ref{147f,,py_object} returns @code{None}, which could
cause crashes.
@end itemize

@node Documentação<21>,Testes<25>,Biblioteca<49>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id265}@anchor{1885}
@subsubsection Documentação



@itemize -

@item 
gh-100616@footnote{https://github.com/python/cpython/issues/100616}: Document existing @code{attr} parameter to
@ref{1886,,curses.window.vline()} function in @ref{2b,,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{b38,,compileall.compile_dir()} and @ref{e0b,,compileall.compile_file()} could
be @ref{1c2,,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 Testes<25>,Construção<26>,Documentação<21>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id266}@anchor{1887}
@subsubsection Testes



@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 Construção<26>,Windows<23>,Testes<25>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id267}@anchor{1888}
@subsubsection Construção



@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<23>,macOS<16>,Construção<26>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id268}@anchor{1889}
@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{188a,,asyncio.Protocol.data_received()} receives an
immutable @ref{1c2,,bytes} object (as documented), instead of
@ref{2ea,,bytearray}.

@item 
bpo-43984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43984}: @ref{188b,,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{417,,OSError}.
@end itemize

@node macOS<16>,Ferramentas/Demos<15>,Windows<23>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id269}@anchor{188c}
@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 Ferramentas/Demos<15>,API C<25>,macOS<16>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id270}@anchor{188d}
@subsubsection Ferramentas/Demos



@itemize -

@item 
bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256}: Fix a bug that caused an @ref{34b,,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 API C<25>,,Ferramentas/Demos<15>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id271}@anchor{188e}
@subsubsection API C



@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{578,,Py_CLEAR}, @ref{579,,Py_SETREF} and
@ref{57a,,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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-3}@anchor{188f}
@subsection Python 3.12.0 alpha 3


`Data de lançamento: 2022-12-06'

@menu
* Segurança: Segurança<21>. 
* Núcleo e embutidos: Núcleo e embutidos<46>. 
* Biblioteca: Biblioteca<50>. 
* Núcleo e embutidos: Núcleo e embutidos<47>. 
* Biblioteca: Biblioteca<51>. 
* Documentação: Documentação<22>. 
* Testes: Testes<26>. 
* Construção: Construção<27>. 
* Windows: Windows<24>. 
* macOS: macOS<17>. 
* Ferramentas/Demos: Ferramentas/Demos<16>. 
* API C: API C<26>. 

@end menu

@node Segurança<21>,Núcleo e embutidos<46>,,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id272}@anchor{1890}
@subsubsection Segurança



@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 Núcleo e embutidos<46>,Biblioteca<50>,Segurança<21>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id273}@anchor{1891}
@subsubsection Núcleo e embutidos



@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{566,,PyCode_AddWatcher()} and
@ref{567,,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{1b6,,ExceptionGroup} subclass can wrap a
@ref{5bb,,BaseException}.
@end itemize

@node Biblioteca<50>,Núcleo e embutidos<47>,Núcleo e embutidos<46>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id274}@anchor{1892}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<47>,Biblioteca<51>,Biblioteca<50>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id275}@anchor{1893}
@subsubsection Núcleo e embutidos



@itemize -

@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{77c,,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{94a,,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{202,,ValueError} instead of @ref{575,,SystemError} when
methods of uninitialized @ref{17bb,,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{1354,,io.FileIO} when the
opener returns an invalid file descriptor.
@end itemize

@node Biblioteca<51>,Documentação<22>,Núcleo e embutidos<47>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id276}@anchor{1894}
@subsubsection Biblioteca



@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{4d4,,typing.dataclass_transform()}.

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: Fix @ref{17bc,,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{44f,,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{a,,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{47c,,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{1895,,ast.increment_lineno()} to also cover
@ref{1896,,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{15f,,TypeVarTuple} and one or more
@ref{15d,,TypeVar}.

@item 
gh-99379@footnote{https://github.com/python/cpython/issues/99379}: Fix substitution of @ref{15e,,ParamSpec} followed by
@ref{15f,,TypeVarTuple} in generic aliases.

@item 
gh-99344@footnote{https://github.com/python/cpython/issues/99344}: Fix substitution of @ref{15f,,TypeVarTuple} and
@ref{15e,,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{2a,,ctypes}.

@item 
gh-99201@footnote{https://github.com/python/cpython/issues/99201}: Fix @ref{157e,,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{2ca,,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{2c2,,asyncio.get_event_loop()} and many other @ref{a,,asyncio}
functions like @ref{c92,,asyncio.ensure_future()}, @ref{a7a,,asyncio.shield()} or
@ref{5fd,,asyncio.gather()}, and also the
@code{get_event_loop()} method of
@code{asyncio.BaseDefaultEventLoopPolicy} now raise a
@ref{195,,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{1a5,,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{12b8,,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{173a,,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{1897,,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{b2b,,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{cb0,,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 Documentação<22>,Testes<26>,Biblioteca<51>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id277}@anchor{1898}
@subsubsection Documentação



@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{468,,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{dc0,,os.wait*} family of functions, and improved the docs for
@ref{dc1,,os.waitid()} with more explanation of the possible argument
constants.
@end itemize

@node Testes<26>,Construção<27>,Documentação<22>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id278}@anchor{1899}
@subsubsection Testes



@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 Construção<27>,Windows<24>,Testes<26>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id279}@anchor{189a}
@subsubsection Construção



@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{20,,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<24>,macOS<17>,Construção<27>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id280}@anchor{189b}
@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{178,,sys.version} and @code{sys._git} on
Windows

@item 
gh-99442@footnote{https://github.com/python/cpython/issues/99442}: Fix handling in @ref{5be,,Inicializador 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{174f,,multiprocessing.shared_memory.SharedMemory} on Windows.
@end itemize

@node macOS<17>,Ferramentas/Demos<16>,Windows<24>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id281}@anchor{189c}
@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 Ferramentas/Demos<16>,API C<26>,macOS<17>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id282}@anchor{189d}
@subsubsection Ferramentas/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 API C<26>,,Ferramentas/Demos<16>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id283}@anchor{189e}
@subsubsection API C



@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{41e,,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{189f,,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{593,,T_OBJECT}, @ref{595,,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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-2}@anchor{18a0}
@subsection Python 3.12.0 alpha 2


`Data de lançamento: 2022-11-14'

@menu
* Segurança: Segurança<22>. 
* Núcleo e embutidos: Núcleo e embutidos<48>. 
* Construção: Construção<28>. 
* Núcleo e embutidos: Núcleo e embutidos<49>. 
* Biblioteca: Biblioteca<52>. 
* Documentação: Documentação<23>. 
* Testes: Testes<27>. 
* Construção: Construção<29>. 
* Windows: Windows<25>. 
* macOS: macOS<18>. 
* API C: API C<27>. 

@end menu

@node Segurança<22>,Núcleo e embutidos<48>,,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id284}@anchor{18a1}
@subsubsection Segurança



@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{a,,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 Núcleo e embutidos<48>,Construção<28>,Segurança<22>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id285}@anchor{18a2}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-81057@footnote{https://github.com/python/cpython/issues/81057}: The docs clearly say that @ref{18a3,,PyImport_Inittab},
@ref{18a4,,PyImport_AppendInittab()}, and @ref{18a5,,PyImport_ExtendInittab()}
should not be used after @ref{8b1,,Py_Initialize()} has been called. We now
enforce this for the two functions.  Additionally, the runtime now uses an
internal copy of @ref{18a3,,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{78d,,PyThreadState} and
@ref{8c2,,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{5b8,,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{18d,,SyntaxError} for a @ref{6e9,,try} block
with both @ref{18b,,except} and @ref{5b8,,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{18a6,,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{43f,,NameError} exceptions for
instances. Now if a @ref{43f,,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{466,,SyntaxWarning}, instead of
@ref{1a5,,DeprecationWarning}. In a future Python version they will be
eventually a @ref{18d,,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{466,,SyntaxWarning}, instead of
@ref{1a5,,DeprecationWarning}.  For example, @code{re.compile("\d+\.\d+")} now
emits a @ref{466,,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{18d,,SyntaxError} will eventually be raised,
instead of @ref{466,,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{18d,,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{15d,,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{184a,,FOR_ITER} for generators. Saves
multiple layers of dispatch and checking to get from the
@ref{184a,,FOR_ITER} instruction in the caller to the @ref{315,,RESUME} in
the generator.

@item 
gh-98762@footnote{https://github.com/python/cpython/issues/98762}: Fix source locations of @ref{810,,match} sub-patterns.

@item 
gh-98586@footnote{https://github.com/python/cpython/issues/98586}: Added the methods @ref{55c,,PyObject_Vectorcall()} and
@ref{55d,,PyObject_VectorcallMethod()} to the @ref{553,,Limited API}
along with the auxiliary macro constant
@ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET}.

The availability of these functions enables more efficient 
@geindex Propostas de Melhorias do Python; 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{1533,,__slots__}) could behave incorrectly or crash instead of
raising a @ref{2c3,,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{1bd,,RuntimeWarning} and assign
@ref{675,,None} to any fast locals that are left unbound after jumps or
@ref{18a7,,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{1066,,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{18a8,,RETURN_VALUE}, @ref{314,,YIELD_VALUE}, and
@ref{6fc,,RETURN_GENERATOR}, which now clear the frame.
@end itemize

@node Construção<28>,Núcleo e embutidos<49>,Núcleo e embutidos<48>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id286}@anchor{18a9}
@subsubsection Construção



@itemize -

@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
@end itemize

@node Núcleo e embutidos<49>,Biblioteca<52>,Construção<28>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id287}@anchor{18aa}
@subsubsection Núcleo e embutidos



@itemize -

@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{2a,,ctypes} calls.

@item 
gh-91058@footnote{https://github.com/python/cpython/issues/91058}: @ref{419,,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{184a,,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{18ab,,ETH_P_ALL} and some of the
@ref{18ac,,ETHERTYPE_* constants} in @ref{cc,,socket}.
Patch by Noam Cohen.
@end itemize

@node Biblioteca<52>,Documentação<23>,Núcleo e embutidos<49>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id288}@anchor{18ad}
@subsubsection Biblioteca



@itemize -

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

@item 
gh-99418@footnote{https://github.com/python/cpython/issues/99418}: Fix bug in @ref{30d,,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 @ref{2bc,,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{18ae,,secrets.token_hex()}.

@item 
gh-74044@footnote{https://github.com/python/cpython/issues/74044}: Fixed bug where @ref{738,,inspect.signature()} reported incorrect
arguments for decorated methods.

@item 
gh-99275@footnote{https://github.com/python/cpython/issues/99275}: Fix @code{SystemError} in @ref{2a,,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{a41,,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 Propostas de Melhorias do Python; 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{a0a,,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{18af,,DatagramTransport} in @ref{a,,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{18b0,,conditional expression} without the
“else” branch.

@item 
gh-98703@footnote{https://github.com/python/cpython/issues/98703}: Fix @ref{18b1,,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{1a0,,array.array} class now supports subscripting, making
it a @ref{439,,generic type}.

@item 
gh-98284@footnote{https://github.com/python/cpython/issues/98284}: Improved @ref{2c3,,TypeError} message for undefined abstract
methods of a @ref{f49,,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 Propostas de Melhorias do Python; 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{2a0,,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{4b6,,autocommit} attribute to
@ref{245,,sqlite3.Connection} and the `autocommit' parameter to
@ref{2a8,,sqlite3.connect()} to control 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant @ref{4b7,,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{1063,,sysconfig.get_config_var()} to incorrectly return @ref{675,,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{16f4,,unittest.mock.create_autospec()} after it was sealed with
@ref{bb9,,unittest.mock.seal()} function.

@item 
bpo-38523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38523}: @ref{a33,,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{2ca,,pathlib.PurePath.relative_to()}.

@item 
bpo-36267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36267}: Fix IndexError in @ref{539,,argparse.ArgumentParser} when a
@code{store_true} action is given an explicit argument.
@end itemize

@node Documentação<23>,Testes<27>,Biblioteca<52>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id289}@anchor{18b2}
@subsubsection Documentação



@itemize -

@item 
gh-98832@footnote{https://github.com/python/cpython/issues/98832}: Changes wording of docstring for @ref{171d,,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 Testes<27>,Construção<29>,Documentação<23>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id290}@anchor{18b3}
@subsubsection Testes



@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 Construção<29>,Windows<25>,Testes<27>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id291}@anchor{18b4}
@subsubsection Construção



@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{412,,--with-system-libmpdec} is passed to @code{configure}. Don’t
use vendored @code{libexpat} headers if @ref{18b5,,--with-system-expat} is
passed to @code{configure}.
@end itemize

@node Windows<25>,macOS<18>,Construção<29>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id292}@anchor{18b6}
@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{5be,,Inicializador 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<18>,API C<27>,Windows<25>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id293}@anchor{18b7}
@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 API C<27>,,macOS<18>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id294}@anchor{18b8}
@subsubsection API C



@itemize -

@item 
gh-98724@footnote{https://github.com/python/cpython/issues/98724}: The @ref{578,,Py_CLEAR}, @ref{579,,Py_SETREF} and
@ref{57a,,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{18b9,,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{568,,PyFrame_GetVar()} and @ref{569,,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,Changelog
@anchor{whatsnew/changelog python-3-12-0-alpha-1}@anchor{18ba}
@subsection Python 3.12.0 alpha 1


`Data de lançamento: 2022-10-25'

@menu
* Segurança: Segurança<23>. 
* Núcleo e embutidos: Núcleo e embutidos<50>. 
* Biblioteca: Biblioteca<53>. 
* Núcleo e embutidos: Núcleo e embutidos<51>. 
* Biblioteca: Biblioteca<54>. 
* Núcleo e embutidos: Núcleo e embutidos<52>. 
* Biblioteca: Biblioteca<55>. 
* Núcleo e embutidos: Núcleo e embutidos<53>. 
* Biblioteca: Biblioteca<56>. 
* Núcleo e embutidos: Núcleo e embutidos<54>. 
* Biblioteca: Biblioteca<57>. 
* Núcleo e embutidos: Núcleo e embutidos<55>. 
* Biblioteca: Biblioteca<58>. 
* Núcleo e embutidos: Núcleo e embutidos<56>. 
* Biblioteca: Biblioteca<59>. 
* Núcleo e embutidos: Núcleo e embutidos<57>. 
* Biblioteca: Biblioteca<60>. 
* Núcleo e embutidos: Núcleo e embutidos<58>. 
* Biblioteca: Biblioteca<61>. 
* Núcleo e embutidos: Núcleo e embutidos<59>. 
* Biblioteca: Biblioteca<62>. 
* Documentação: Documentação<24>. 
* Testes: Testes<28>. 
* Construção: Construção<30>. 
* Windows: Windows<26>. 
* macOS: macOS<19>. 
* IDLE: IDLE<19>. 
* Ferramentas/Demos: Ferramentas/Demos<17>. 
* API C: API C<28>. 

@end menu

@node Segurança<23>,Núcleo e embutidos<50>,,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id295}@anchor{18bb}
@subsubsection Segurança



@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{2c8,,“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 Núcleo e embutidos<50>,Biblioteca<53>,Segurança<23>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id296}@anchor{18bc}
@subsubsection Núcleo e embutidos



@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{43f,,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.
@end itemize

@node Biblioteca<53>,Núcleo e embutidos<51>,Núcleo e embutidos<50>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id297}@anchor{18bd}
@subsubsection Biblioteca



@itemize -

@item 
gh-96078@footnote{https://github.com/python/cpython/issues/96078}: @ref{1150,,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{134,,zoneinfo} to Argument Clinic.
@end itemize

@node Núcleo e embutidos<51>,Biblioteca<54>,Biblioteca<53>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id298}@anchor{18be}
@subsubsection Núcleo e embutidos



@itemize -

@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{4e5,,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{18bf,,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{467,,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{18c0,,./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{3b4,,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{18d,,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{18c1,,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{176,,-X int_max_str_digits} option with no value (invalid) when the
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,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.
@end itemize

@node Biblioteca<54>,Núcleo e embutidos<52>,Núcleo e embutidos<51>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id299}@anchor{18c3}
@subsubsection Biblioteca



@itemize -

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: Fix undefined behaviour in @code{audioop.c}.
@end itemize

@node Núcleo e embutidos<52>,Biblioteca<55>,Biblioteca<54>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id300}@anchor{18c4}
@subsubsection Núcleo e embutidos



@itemize -

@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{202,,ValueError} is raised if an integer is larger than
the limit, mention the @ref{18c5,,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{575,,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{2eb,,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
@end itemize

@node Biblioteca<55>,Núcleo e embutidos<53>,Núcleo e embutidos<52>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id301}@anchor{18c6}
@subsubsection Biblioteca



@itemize -

@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}.
@end itemize

@node Núcleo e embutidos<53>,Biblioteca<56>,Biblioteca<55>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id302}@anchor{18c7}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{4de,,LOAD_ATTR} from
specializing properly when accessing properties.

@item 
gh-96348@footnote{https://github.com/python/cpython/issues/96348}: Emit a DeprecationWarning when @ref{4f8,,throw()},
@ref{4f7,,throw()} or @ref{4f9,,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{34b,,AttributeError} missing @code{name} and @code{obj}
attributes in @ref{beb,,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{46f,,sys.activate_stack_trampoline()} and
@ref{470,,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{471,,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{3ab,,PyGILState_Ensure()} when allocating
new thread state. Patch by Kumar Aditya.

@item 
gh-96046@footnote{https://github.com/python/cpython/issues/96046}: @ref{77c,,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{18c8,,ENOTCAPABLE} is now mapped to
@ref{d65,,PermissionError}. The @ref{57,,errno} modules exposes the new error
number. @code{getpath.py} now ignores @ref{d65,,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{6e9,,try}/@ref{18b,,except} blocks to
handle exceptions raised during @ref{15b9,,close()} or
@ref{4f8,,throw()} calls through a suspended frame.

@item 
gh-95977@footnote{https://github.com/python/cpython/issues/95977}: Optimized calling @ref{1530,,__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{78e,,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{2f7,,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{611,,list} from @ref{ed9,,str.split()}
and @ref{1297,,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{154e,,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{d90,,RecursionError} is
now raised instead. Patch by Pablo Galindo

@item 
gh-93351@footnote{https://github.com/python/cpython/issues/93351}: @ref{1a6,,ast.AST} node positions are now validated when provided
to @ref{192,,compile()} and other related functions. If invalid positions are
detected, a @ref{202,,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{18a6,,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.
@end itemize

@node Biblioteca<56>,Núcleo e embutidos<54>,Núcleo e embutidos<53>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id303}@anchor{18c9}
@subsubsection Biblioteca



@itemize -

@item 
gh-95023@footnote{https://github.com/python/cpython/issues/95023}: Implement @ref{18ca,,os.setns()} and  @ref{18cb,,os.unshare()} for Linux.
Patch by Noam Cohen.
@end itemize

@node Núcleo e embutidos<54>,Biblioteca<57>,Biblioteca<56>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id304}@anchor{18cc}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<57>,Núcleo e embutidos<55>,Núcleo e embutidos<54>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id305}@anchor{18cd}
@subsubsection Biblioteca



@itemize -

@item 
gh-94996@footnote{https://github.com/python/cpython/issues/94996}: @ref{1a8,,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.
@end itemize

@node Núcleo e embutidos<55>,Biblioteca<58>,Biblioteca<57>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id306}@anchor{18ce}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-94739@footnote{https://github.com/python/cpython/issues/94739}: Allow jumping within, out of, and across exception handlers in
the debugger.
@end itemize

@node Biblioteca<58>,Núcleo e embutidos<56>,Núcleo e embutidos<55>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id307}@anchor{18cf}
@subsubsection Biblioteca



@itemize -

@item 
gh-94949@footnote{https://github.com/python/cpython/issues/94949}: @ref{1a8,,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{1a8,,ast.parse()} will no longer parse assignment expressions
when passed @code{feature_version} less than @code{(3, 8)}. Patch by Shantanu
Jain.
@end itemize

@node Núcleo e embutidos<56>,Biblioteca<59>,Biblioteca<58>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id308}@anchor{18d0}
@subsubsection Núcleo e embutidos



@itemize -

@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{8,,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{2ea,,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 Propostas de Melhorias do Python; 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{46d,,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{4df,,BINARY_SLICE} and @ref{4e0,,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{7ed,,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.
@end itemize

@node Biblioteca<59>,Núcleo e embutidos<57>,Núcleo e embutidos<56>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id309}@anchor{18d1}
@subsubsection Biblioteca



@itemize -

@item 
gh-93461@footnote{https://github.com/python/cpython/issues/93461}: @ref{c2a,,importlib.invalidate_caches()} now drops entries from
@ref{5e4,,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}.
@end itemize

@node Núcleo e embutidos<57>,Biblioteca<60>,Biblioteca<59>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id310}@anchor{18d2}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-93621@footnote{https://github.com/python/cpython/issues/93621}: Change order of bytecode instructions emitted for
@ref{5d2,,with} and @ref{5d5,,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{778,,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{8,,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{550,,PyType_FromMetaclass()}, which
generalizes the existing @ref{551,,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{550,,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.
@end itemize

@node Biblioteca<60>,Núcleo e embutidos<58>,Núcleo e embutidos<57>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id311}@anchor{18d3}
@subsubsection Biblioteca



@itemize -

@item 
gh-91102@footnote{https://github.com/python/cpython/issues/91102}: @code{_warnings.warn_explicit()} is ported to Argument Clinic.
@end itemize

@node Núcleo e embutidos<58>,Biblioteca<61>,Biblioteca<60>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id312}@anchor{18d4}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<61>,Núcleo e embutidos<59>,Núcleo e embutidos<58>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id313}@anchor{18d5}
@subsubsection Biblioteca



@itemize -

@item 
gh-92261@footnote{https://github.com/python/cpython/issues/92261}: Fix hang when trying to iterate over a @code{typing.Union}.
@end itemize

@node Núcleo e embutidos<59>,Biblioteca<62>,Biblioteca<61>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id314}@anchor{18d6}
@subsubsection Núcleo e embutidos



@itemize -

@item 
gh-91432@footnote{https://github.com/python/cpython/issues/91432}: Specialized the @ref{184a,,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{611,,list} and
@ref{370,,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 Biblioteca<62>,Documentação<24>,Núcleo e embutidos<59>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id315}@anchor{18d7}
@subsubsection Biblioteca



@itemize -

@item 
gh-89237@footnote{https://github.com/python/cpython/issues/89237}: Fix hang on Windows in @code{subprocess.wait_closed()} in
@ref{a,,asyncio} with @ref{609,,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{2ea,,bytearray} and @ref{2eb,,memoryview} types: only the exact
@ref{1c2,,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{65b,,createSocket()} method
was added to @ref{65c,,SysLogHandler}.

@item 
gh-96035@footnote{https://github.com/python/cpython/issues/96035}: Fix bug in @ref{30d,,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{1546,,sys.setprofile()} and @ref{1547,,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
@ref{2c1,,asyncio.AbstractEventLoopPolicy.get_child_watcher()} and
@ref{2c0,,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{540,,syslog.syslog()} in multi-threaded
applications. On macOS, the libc @code{syslog()} function is not thread-safe,
so @ref{540,,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{20b,,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
@ref{2ba,,MultiLoopChildWatcher},
@ref{2bb,,FastChildWatcher} and @ref{2bd,,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
@ref{479,,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{34b,,AttributeError} when @ref{ff6,,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{43f,,NameError} and @ref{34b,,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{816,,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{a,,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{168b,,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{a,,asyncio} where
@ref{18d8,,process_exited()} called before the
@ref{18d9,,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{18da,,urllib.parse.quote_from_bytes()} memory use on large
values.

Contribuição de 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{18db,,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{1301,,numbers.Rational}’s to
@ref{2f7,,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{dc9,,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{18dc,,getChildren()} method to
@ref{b64,,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{18dd,,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{18de,,Comportamento de strftime() e strptime()}.

@item 
gh-95899@footnote{https://github.com/python/cpython/issues/95899}: Fix @ref{600,,asyncio.Runner} to call
@ref{18df,,asyncio.set_event_loop()} only once to avoid calling
@ref{18e0,,attach_loop()} multiple times on child
watchers. Patch by Kumar Aditya.

@item 
gh-95736@footnote{https://github.com/python/cpython/issues/95736}: Fix @ref{30c,,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{18da,,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{1b8,,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{906,,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{1b5,,asyncio.TaskGroup} to propagate exception when
@ref{1b8,,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{4a6,,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{1648,,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{18e1,,EPERM} or
@ref{18e2,,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{47c,,asyncio.run()} for @ref{1be,,asyncio.Task}
implementations without @ref{1bb,,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{3b,,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{18e3,,os.EFD_CLOEXEC},
@ref{18e4,,os.EFD_NONBLOCK} and @ref{18e5,,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{e0e,,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{2a8,,connect()} to the
@ref{245,,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{17bd,,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{1a8,,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{441,,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{18b1,,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{a,,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{4f3,,typing.Hashable} and
@ref{4f4,,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{47c,,asyncio.run()} and
@ref{30c,,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{15a0,,struct.Struct} when it was not completely
initialized by initializing it in @ref{580,,__new__()}.  Patch by Kumar
Aditya.

@item 
gh-94510@footnote{https://github.com/python/cpython/issues/94510}: Re-entrant calls to @ref{1546,,sys.setprofile()} and
@ref{1547,,sys.settrace()} now raise @ref{195,,RuntimeError}. Patch by Pablo
Galindo.

@item 
gh-92336@footnote{https://github.com/python/cpython/issues/92336}: Fix bug where @ref{e50,,linecache.getline()} fails on bad files with
@ref{a1d,,UnicodeDecodeError} or @ref{18d,,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{1b5,,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{534,,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{132,,zipimport}: Remove @code{find_loader()} and @code{find_module()}
methods, deprecated in Python 3.10: use the @code{find_spec()} method
instead. See 
@geindex Propostas de Melhorias do Python; 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{53c,,shlex.split()}: Passing @code{None} for `s' argument now
raises an exception, rather than reading @ref{53d,,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{a28,,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{4ef,,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{4b3,,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{38,,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{51f,,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{294,,ssl.SSLContext} object and call its
@ref{525,,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{523,,os.urandom()} or @ref{524,,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{50f,,hashlib.pbkdf2_hmac()}, deprecated in Python 3.10. Python 3.10 and
newer requires OpenSSL 1.1.1 (
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}): this OpenSSL version provides a
C implementation of @ref{50f,,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{41a,,gzip.GzipFile}, deprecated since Python 2.6, use the
@ref{50d,,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 @ref{479,,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{51c,,open()} instead. The @ref{51c,,open()}
(@ref{51d,,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{cfe,,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{2e4,,inspect.iscoroutinefunction()},
@ref{18e6,,inspect.isgeneratorfunction()}, and
@ref{18e7,,inspect.isasyncgenfunction()} now properly return @code{True} for
duck-typed function-like objects like instances of
@ref{a53,,unittest.mock.AsyncMock}.

This makes @ref{2e4,,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{623,,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{534,,copy.copy()}-ing @ref{623,,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{18e8,,ReferenceType}, @ref{18e9,,ProxyType},
@ref{18ea,,CallableProxyType}. It makes them pickleable.

@item 
gh-91389@footnote{https://github.com/python/cpython/issues/91389}: Fix an issue where @ref{38,,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 Propostas de Melhorias do Python; 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{534,,copy.copy()} and @ref{b84,,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{18eb,,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 @ref{2cf,,sqlite3.version} and
@ref{2d0,,sqlite3.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{48d,,importlib.resources.as_file()} context manager to
remove the temporary file if destroyed late during Python finalization:
keep a local reference to the @ref{112f,,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{49a,,os.PIDFD_NONBLOCK} flag to open a file descriptor
for a process with @ref{47a,,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{2c3,,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{539,,argparse.ArgumentParser} to use
@ref{53b,,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{823,,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{11ef,,logging.config.dictConfig()} to
usefully configure @ref{18ec,,QueueHandler} and
@ref{e59,,QueueListener} as a pair, and add
@ref{18ed,,logging.getHandlerByName()} and @ref{17f0,,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 Propostas de Melhorias do Python; 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{a7e,,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{a,,asyncio} tasks.

@item 
gh-74696@footnote{https://github.com/python/cpython/issues/74696}: @ref{4b3,,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{2a8,,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{8eb,,ast.unparse()} when @code{ImportFrom.level} is @code{None}

@item 
gh-92932@footnote{https://github.com/python/cpython/issues/92932}: Now @ref{b46,,dis()} and @ref{1d9,,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{229,,pathlib.Path} arguments in addition to @ref{44c,,str} paths. Patch
by David Foster.

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: Removed the @code{encoding} argument from @ref{a91,,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{18ee,,c_time_t} to @ref{2a,,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{18ef,,os.pipe()} on WASI.

@item 
gh-89325@footnote{https://github.com/python/cpython/issues/89325}: Removed many old deprecated @ref{106,,unittest} features:
@ref{44f,,TestCase} method aliases, undocumented and broken
@ref{44f,,TestCase} method @code{assertDictContainsSubset},
undocumented @ref{28f,,TestLoader.loadTestsFromModule} parameter `use_load_tests', and
an underscored alias of the @ref{531,,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{8eb,,ast.unparse()} for empty tuples in the assignment
target context.

@item 
gh-91581@footnote{https://github.com/python/cpython/issues/91581}: @ref{2fd,,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{18f0,,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{4a8,,pathlib.Path.walk()} as an alternative to
@ref{4a9,,os.walk()}.

@item 
gh-92550@footnote{https://github.com/python/cpython/issues/92550}: Fix @ref{22e,,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{101c,,logging.LogRecord} instance so that filters attached to
@ref{14de,,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{6,,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 por Erlend E. Aasland.

@item 
gh-92530@footnote{https://github.com/python/cpython/issues/92530}: Fix an issue that occurred after interrupting
@ref{18f1,,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{229,,pathlib.Path} deprecated method @code{link_to} has been
removed. Use 3.10’s @ref{824,,hardlink_to()} method instead as
its semantics are consistent with that of
@ref{825,,symlink_to()}.

@item 
gh-89336@footnote{https://github.com/python/cpython/issues/89336}: Removed @ref{22,,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{73b,,__class_getitem__()} to
@ref{9ed,,csv.DictReader} and @ref{123e,,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{955,,ElementTree} method
@ref{aa4,,write()} and function
@ref{102b,,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{c0f,,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{8f4,,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{4ed,,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{2a3,,re.sub()} and @ref{2a4,,re.subn()} and corresponding @ref{18f2,,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{6c4,,zipfile.ZipFile} now raises @ref{18f3,,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{194,,property()}.

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @ref{2a,,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{123e,,DictWriter} and
@ref{9ed,,DictReader} now coerce the @code{fieldnames} argument to a
@ref{611,,list} if it is an iterator.

@item 
bpo-35540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35540}: Fix @ref{1819,,dataclasses.asdict()} crash when
@ref{11fc,,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{1c2,,bytes} on @ref{3b4,,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{a21,,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{8dd,,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{15d,,typing.TypeVar}, @ref{15e,,typing.ParamSpec},
@ref{15f,,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{a,,asyncio} to AIX platform only.

@item 
bpo-28249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28249}: Set @ref{1606,,doctest.DocTest.lineno} to @code{None} when an object
does not have @ref{92e,,__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{a,,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{6b9,,enterContext()} and
@ref{6ba,,enterClassContext()} of class
@ref{44f,,TestCase}, method
@ref{6bb,,enterAsyncContext()} of class
@ref{30c,,IsolatedAsyncioTestCase} and function
@ref{6bc,,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{a47,,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{4c6,,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
@ref{11fd,,__missing__()} when a value is not found. This matches the
behavior of @ref{256,,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{8ed,,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{600,,asyncio.Runner} or @ref{47c,,asyncio.run()}, the
default timeout is 5 minutes.

@item 
bpo-34828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34828}: @ref{247,,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{ea6,,tarfile.open()}.
@end itemize

@node Documentação<24>,Testes<28>,Biblioteca<62>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id316}@anchor{18f4}
@subsubsection Documentação



@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{8,,ast}
documentation about @ref{c32,,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}: Atualiza a documentação da biblioteca com @ref{18f5,,informações de disponibilidade} para as plataformas WebAssembly @code{wasm32-emscripten} e @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 Propostas de Melhorias do Python; PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} style protocol type
@ref{18f6,,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{18f7,,How to use the connection context manager}.

@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{8cd,,-W} and 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,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{4a6,,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{a02,,inspect.getdoc()},
@ref{18f8,,inspect.getmodule()}, and @ref{18f9,,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{18fa,,Error Handlers} documentation in
@ref{1b,,codecs}.

@item 
bpo-13553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13553}: Document tkinter.Tk args.
@end itemize

@node Testes<28>,Construção<30>,Documentação<24>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id317}@anchor{18fb}
@subsubsection Testes



@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/3.13/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{18fc,,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{2f,,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{18fd,,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{18fe,,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 variável de ambiente; 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{1863,,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{21b,,os.chmod()} is
now a dummy function on WASI. Skip all tests that depend on working
@ref{21b,,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 Construção<30>,Windows<26>,Testes<28>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id318}@anchor{18ff}
@subsubsection Construção



@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{21,,concurrent.futures} for @ref{a,,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{135a,,getresuid()}, @ref{1359,,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 Propostas de Melhorias do Python; 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{c80,,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{2b,,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 Propostas de Melhorias do Python; 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<26>,macOS<19>,Construção<30>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id319}@anchor{1900}
@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{14a5,,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{5be,,Inicializador 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{841,,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{5be,,Inicializador Python para Windows} for @code{/usr/bin/env}
shebang lines, which will now search 
@geindex PATH
@geindex variável de ambiente; 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{5be,,Inicializador 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{5be,,Inicializador 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{131,,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{1141,,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{a,,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{1901,,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<19>,IDLE<19>,Windows<26>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id320}@anchor{1902}
@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{db8,,os.mkfifo()} or @ref{db9,,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<19>,Ferramentas/Demos<17>,macOS<19>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id321}@anchor{1903}
@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 Ferramentas/Demos<17>,API C<28>,IDLE<19>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id322}@anchor{1904}
@subsubsection Ferramentas/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}: A nova ferramenta @code{Tools/wasm/wasm_builder.py} automatiza as etapas de configuração, compilação e teste para a construção do CPython em plataformas WebAssembly.

@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 API C<28>,,Ferramentas/Demos<17>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id324}@anchor{1905}
@subsubsection API C



@itemize -

@item 
gh-98393@footnote{https://github.com/python/cpython/issues/98393}: The @ref{577,,PyUnicode_FSDecoder()} function no longer accepts
bytes-like paths, like @ref{2ea,,bytearray} and @ref{2eb,,memoryview} types:
only the exact @ref{1c2,,bytes} type is accepted for bytes strings. Patch by
Victor Stinner.

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: Add @ref{565,,PyType_Watch()} and related APIs to allow callbacks
on @ref{1906,,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{5f5,,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{36b,,Py_TPFLAGS_MANAGED_DICT}
and @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} instead.

@item 
gh-95781@footnote{https://github.com/python/cpython/issues/95781}: An unrecognized format character in
@ref{38a,,PyUnicode_FromFormat()} and @ref{574,,PyUnicode_FromFormatV()} now
sets a @ref{575,,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{554,,Py_TPFLAGS_HAVE_VECTORCALL}, @ref{555,,PyVectorcall_NARGS()} and
@ref{556,,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{38a,,PyUnicode_FromFormat()} and @ref{574,,PyUnicode_FromFormatV()}. Patch
by Philip Georgi.

@item 
gh-93012@footnote{https://github.com/python/cpython/issues/93012}: The @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} flag is now removed
from a class when the class’s @ref{558,,__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{559,,tp_call} now inherit the
@ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} flag.

@item 
gh-95388@footnote{https://github.com/python/cpython/issues/95388}: Creating @ref{3c2,,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{779,,PyCode_GetVarnames()}, @ref{77a,,PyCode_GetCellvars()}
and @ref{77b,,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{383,,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{785,,PyFrame_Check()}

@item 
@ref{786,,PyFrame_GetBack()}

@item 
@ref{76b,,PyFrame_GetBuiltins()}

@item 
@ref{76c,,PyFrame_GetGenerator()}

@item 
@ref{76d,,PyFrame_GetGlobals()}

@item 
@ref{76e,,PyFrame_GetLasti()}

@item 
@ref{41f,,PyFrame_GetLocals()}

@item 
@ref{787,,PyFrame_Type}
@end itemize

Patch por 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{550,,PyType_FromMetaclass()} (and other @code{PyType_From*}
functions) now check that offsets and the base class’s
@ref{98e,,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{55f,,PyEval_SetProfileAllThreads()} and
@ref{422,,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{4c9,,threading.setprofile_all_threads()} and
@ref{4c8,,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{3d8,,Py_IgnoreEnvironmentFlag}, in the documentation: the
@ref{3c5,,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{3d8,,Py_IgnoreEnvironmentFlag}: the @ref{3c5,,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{3a2,,PyConfig.module_search_paths} are
ignored unless @ref{5ef,,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{560,,PyFunction_SetVectorcall()} to the C API
which sets the vectorcall field of a given @ref{561,,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{57d,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-beta-1}@anchor{1907}
@subsection Python 3.11.0 beta 1


`Data de lançamento: 2022-05-06'

@menu
* Segurança: Segurança<24>. 
* Núcleo e embutidos: Núcleo e embutidos<60>. 
* Biblioteca: Biblioteca<63>. 
* Núcleo e embutidos: Núcleo e embutidos<61>. 
* Construção: Construção<31>. 
* Núcleo e embutidos: Núcleo e embutidos<62>. 
* Biblioteca: Biblioteca<64>. 
* Documentação: Documentação<25>. 
* Testes: Testes<29>. 
* Construção: Construção<32>. 
* Windows: Windows<27>. 
* macOS: macOS<20>. 
* Ferramentas/Demos: Ferramentas/Demos<18>. 
* API C: API C<29>. 

@end menu

@node Segurança<24>,Núcleo e embutidos<60>,,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id325}@anchor{1908}
@subsubsection Segurança



@itemize -

@item 
gh-57684@footnote{https://github.com/python/cpython/issues/57684}: Add the @ref{5a4,,-P} command line option and the
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH} environment variable to not prepend a potentially
unsafe path to @ref{3b4,,sys.path}. Patch by Victor Stinner.
@end itemize

@node Núcleo e embutidos<60>,Biblioteca<63>,Segurança<24>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id326}@anchor{1909}
@subsubsection Núcleo e embutidos



@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{34b,,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{17f,,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 Propostas de Melhorias do Python; 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{63a,,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{1a5,,DeprecationWarning}. In a future Python version they will be a
@ref{466,,SyntaxWarning} and eventually a @ref{18d,,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{442,,isinstance()} and @ref{7c2,,issubclass()} checks for
@ref{63a,,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{789,,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{5bb,,BaseException} (added
in an earlier version of 3.11) with the final design of 
@geindex Propostas de Melhorias do Python; PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}.
Namely, @ref{5bb,,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{17e1,,POP_JUMP_IF_TRUE}, @ref{17e2,,POP_JUMP_IF_FALSE},
@ref{190a,,POP_JUMP_IF_NONE} and @ref{190b,,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.
@end itemize

@node Biblioteca<63>,Núcleo e embutidos<61>,Núcleo e embutidos<60>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id327}@anchor{190c}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<61>,Construção<31>,Biblioteca<63>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id328}@anchor{190d}
@subsubsection Núcleo e embutidos



@itemize -

@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{9da,,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{15a2,,pickle.PickleBuffer}, @code{testcapi.RecursingInfinitelyError},
and @ref{7ed,,types.GenericAlias}.

The functions affected are 24 methods in @ref{2a,,ctypes}.

Patch by Oleg Iarygin.

@item 
bpo-46942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46942}: Use Argument Clinic for the @ref{190e,,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 @ref{190f,,set.intersection()} for non-set arguments.

@item 
bpo-46721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46721}: Optimize @ref{1910,,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.
@end itemize

@node Construção<31>,Núcleo e embutidos<62>,Núcleo e embutidos<61>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id329}@anchor{1911}
@subsubsection Construção



@itemize -

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: Do not use POSIX semaphores on NetBSD
@end itemize

@node Núcleo e embutidos<62>,Biblioteca<64>,Construção<31>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id330}@anchor{1912}
@subsubsection Núcleo e embutidos



@itemize -

@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 Biblioteca<64>,Documentação<25>,Núcleo e embutidos<62>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id331}@anchor{1913}
@subsubsection Biblioteca



@itemize -

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: Add the `encoding' parameter to @ref{a91,,os.popen()}.

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: Fix an issue where @ref{38,,dis} utilities may interpret populated
inline cache entries as valid instructions.

@item 
gh-92332@footnote{https://github.com/python/cpython/issues/92332}: Deprecate @ref{30b,,typing.Text} (removal of the class is
currently not planned). Patch by Alex Waygood.

@item 
gh-78157@footnote{https://github.com/python/cpython/issues/78157}: 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{38,,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{617,,datetime.datetime.fromisoformat()},
@ref{615,,datetime.date.fromisoformat()} and
@ref{616,,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{1242,,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{1cb,,@@~dataclasses.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{73b,,__class_getitem__()} to
@ref{1339,,logging.LoggerAdapter} and @ref{1238,,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{1d0,,inspect.Parameter} now raises @ref{202,,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{7ed,,types.GenericAlias}. Patch by Jelle Zijlstra.

@item 
gh-88089@footnote{https://github.com/python/cpython/issues/88089}: Add support for generic @ref{2b0,,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{ff7,,subprocess.getoutput()} and @ref{ff8,,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{1914,,multiprocessing.Queue} `after' the last write of buffered data to
the write end of the pipe to avoid @ref{1095,,BrokenPipeError} at garbage
collection and at @ref{1915,,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 Propostas de Melhorias do Python; 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{1916,,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{a,,asyncio} modules.

@item 
gh-91860@footnote{https://github.com/python/cpython/issues/91860}: Add @ref{4d4,,typing.dataclass_transform()}, implementing 
@geindex Propostas de Melhorias do Python; 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{1917,,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{6a0,,sys.version_info}.

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: Add @ref{1918,,--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{1919,,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{191a,,signal.raise_signal()} and @ref{13ae,,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{6a7,,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{6b1,,typing.get_type_hints()} for
@ref{7ec,,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{fba,,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{672,,create_connection()} in an @ref{1b6,,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{67d,,InterfaceError} instead of
@ref{4f2,,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 Propostas de Melhorias do Python; 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{64f,,inspect.getframeinfo()},
@ref{650,,inspect.getouterframes()}, @ref{651,,inspect.getinnerframes()},
@ref{652,,inspect.stack()} and @ref{653,,inspect.trace()}. Patch by Pablo Galindo.

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: Add indexing and slicing support to @ref{682,,sqlite3.Blob}. Patch
by Aviv Palivoda and Erlend E. Aasland.

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: Add @ref{5d4,,context manager} support to @ref{682,,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{38,,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{584,,warnings.catch_warnings()} now accepts arguments for
@ref{6c1,,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 
gh-91498@footnote{https://github.com/python/cpython/issues/91498}: 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 Propostas de Melhorias do Python; 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{2dc,,locale.getencoding()} to get the current locale
encoding. It is similar to @code{locale.getpreferredencoding(False)} but
ignores the @ref{656,,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{13cd,,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{3b,,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{6ae,,typing.get_overloads()} and
@ref{6af,,typing.clear_overloads()}. Patch by Jelle Zijlstra.

@item 
bpo-44807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44807}: @ref{264,,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{8f4,,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{191b,,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{7c5,,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{694,,io.BufferedIOBase} or
@ref{695,,io.TextIOBase} interface for
@ref{693,,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{162,,TypedDict} subclasses to also include
@ref{15d7,,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{199,,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{680,,create_window_function()} to
@ref{245,,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{29,,csv} to use Argument Clinic for
@ref{191c,,csv.field_size_limit()}, @ref{191d,,csv.get_dialect()},
@ref{191e,,csv.unregister_dialect()} and @ref{191f,,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{4f2,,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{294,,SSLContext}.

@item 
bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276}: @ref{229,,Path} methods @ref{22d,,glob()} and
@ref{22e,,rglob()} return only directories if `pattern' ends with
a pathname components separator (@code{/} or @ref{66a,,sep}). Patch by
Eisuke Kawashima.

@item 
bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905}: Add @ref{681,,blobopen()} to
@ref{245,,sqlite3.Connection}. @ref{682,,sqlite3.Blob} allows incremental I/O
operations on blobs. Patch by Aviv Palivoda and Erlend E. Aasland.
@end itemize

@node Documentação<25>,Testes<29>,Biblioteca<64>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id332}@anchor{1920}
@subsubsection Documentação



@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{46b,,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{a33,,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 Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} and 
@geindex Propostas de Melhorias do Python; 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{553,,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{1921,,PyDoc_STR} to follow the guideline of 
@geindex Propostas de Melhorias do Python; 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{1922,,runpy.run_module()} and
@ref{181,,runpy.run_path()}. Original patch by Andrew Brezovsky.
@end itemize

@node Testes<29>,Construção<32>,Documentação<25>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id333}@anchor{1923}
@subsubsection Testes



@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 variável de ambiente; 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{1924,,ipaddress.IPv4Interface} and
@ref{1925,,ipaddress.IPv6Interface} construction with tuple arguments.
Original patch and tests by louisom.
@end itemize

@node Construção<32>,Windows<27>,Testes<29>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id334}@anchor{1926}
@subsubsection Construção



@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}: As construções de @code{PGInstrument} do Windows agora copiam uma DLL necessária para o diretório de saída, facilitando a execução do estágio de perfil de uma construção do PGO.
@end itemize

@node Windows<27>,macOS<20>,Construção<32>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id335}@anchor{1927}
@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{5be,,Inicializador 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{4a0,,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<20>,Ferramentas/Demos<18>,Windows<27>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id336}@anchor{1928}
@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 Ferramentas/Demos<18>,API C<29>,macOS<20>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id337}@anchor{1929}
@subsubsection Ferramentas/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 API C<29>,,Ferramentas/Demos<18>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id338}@anchor{192a}
@subsubsection API C



@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{778,,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{1862,,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 Propostas de Melhorias do Python; 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{8ae,,Py_REFCNT()}, @ref{780,,Py_TYPE()}, @ref{782,,Py_SIZE()} and
@ref{192b,,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{192c,,PyOS_CheckStack()} is now exported in the Stable ABI on
Windows.

@item 
bpo-47169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47169}: @ref{192d,,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{76f,,PyErr_GetHandledException()} and
@ref{770,,PyErr_SetHandledException()} as simpler alternatives to
@ref{772,,PyErr_GetExcInfo()} and @ref{771,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-7}@anchor{192e}
@subsection Python 3.11.0 alpha 7


`Data de lançamento: 2022-04-05'

@menu
* Núcleo e embutidos: Núcleo e embutidos<63>. 
* Biblioteca: Biblioteca<65>. 
* Núcleo e embutidos: Núcleo e embutidos<64>. 
* Biblioteca: Biblioteca<66>. 
* Núcleo e embutidos: Núcleo e embutidos<65>. 
* Biblioteca: Biblioteca<67>. 
* Documentação: Documentação<26>. 
* Testes: Testes<30>. 
* Construção: Construção<33>. 
* Windows: Windows<28>. 
* macOS: macOS<21>. 
* Ferramentas/Demos: Ferramentas/Demos<19>. 
* API C: API C<30>. 

@end menu

@node Núcleo e embutidos<63>,Biblioteca<65>,,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id339}@anchor{192f}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-47212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47212}: Raise @ref{7a9,,IndentationError} instead of @ref{18d,,SyntaxError} for
a bare @code{except} with no following indent. Improve @ref{18d,,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{702,,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{70b,,CHECK_EXC_MATCH} + jump.

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: Replace the absolute jump opcode @ref{1930,,JUMP_NO_INTERRUPT} by
the relative @ref{6ff,,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}: O WebAssembly não consegue lidar com conversões de ponteiros para função ruins (contagem ou tipos diferentes de argumento). O Python agora pode usar trampolins de chamada para atenuar o problema. Defina @code{PY_CALL_TRAMPOLINE} para ativar os trampolins de chamada.

@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{417,,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{70c,,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{789,,PyFrameObject} by calling @ref{41f,,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.
@end itemize

@node Biblioteca<65>,Núcleo e embutidos<64>,Núcleo e embutidos<63>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id340}@anchor{1931}
@subsubsection Biblioteca



@itemize -

@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
@end itemize

@node Núcleo e embutidos<64>,Biblioteca<66>,Biblioteca<65>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id341}@anchor{1932}
@subsubsection Núcleo e embutidos



@itemize -

@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{1c2,,bytes} and @ref{2ea,,bytearray} by
30%. Patch by Kumar Aditya.

@item 
bpo-47009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47009}: Improved the performance of @ref{6cd,,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}.
@end itemize

@node Biblioteca<66>,Núcleo e embutidos<65>,Núcleo e embutidos<64>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id342}@anchor{1933}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46829}: Deprecate passing a message into @ref{1934,,asyncio.Future.cancel()}
and @ref{1b7,,asyncio.Task.cancel()}
@end itemize

@node Núcleo e embutidos<65>,Biblioteca<67>,Biblioteca<66>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id343}@anchor{1935}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-46993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46993}: Speed up @ref{2ea,,bytearray} creation from @ref{611,,list} and
@ref{370,,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{1713,,METH_FASTCALL} calling convention. Patch by Kumar Aditya.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Modify @ref{1936,,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{707,,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{1750,,getter},
@ref{1751,,setter}, and @ref{1752,,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 Biblioteca<67>,Documentação<26>,Núcleo e embutidos<65>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id344}@anchor{1937}
@subsubsection Biblioteca



@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{1be,,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{df2,,asyncio.loop.sock_connect()} to only resolve names for
@ref{1938,,socket.AF_INET} or @ref{1939,,socket.AF_INET6} families. Resolution
may not make sense for other families, like @code{socket.AF_BLUETOOTH}
and @ref{193a,,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{13bb,,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{30e,,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{68a,,sys.exc_info()} to 
@geindex Propostas de Melhorias do Python; 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{5ca,,typing.LiteralString}, part of 
@geindex Propostas de Melhorias do Python; 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{126d,,re.search()}, @ref{2a2,,re.split()},
@ref{1060,,re.findall()}, @ref{1542,,re.finditer()} and @ref{2a3,,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{1542,,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 Propostas de Melhorias do Python; 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{6c4,,zipfile.ZipFile} constructor and the @code{--metadata-encoding}
option in the @ref{131,,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{17b9,,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{178c,,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{178c,,binascii.crc32()} release the GIL when computing on
larger inputs as @ref{178b,,zlib.crc32()} and @ref{68,,hashlib} do.

This also boosts performance on Windows as it now uses the zlib crc32
implementation for @ref{178c,,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{600,,asyncio.Runner} context manager.

@item 
bpo-46382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46382}: @ref{1cb,,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 Propostas de Melhorias do Python; 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{47f,,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{644,,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{a7e,,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 Propostas de Melhorias do Python; 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{dc8,,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{6ac,,typing.Any}. Patch by Shantanu
Jain.

@item 
bpo-46995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46995}: Deprecate missing @ref{9e5,,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{1bf,,asyncio.create_task()} and @ref{1c0,,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{663,,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{b24,,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{193b,,SIG_IGN} and @ref{193c,,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{a1e,,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 Propostas de Melhorias do Python; 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{5fe,,asyncio.timeout()} and @ref{193d,,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{944,,typing.Annotated} to wrap @ref{7c7,,typing.ParamSpecArgs} and
@ref{193e,,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{68f,,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{193f,,sysconfig.get_default_scheme()} and
@ref{690,,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{6b1,,typing.get_type_hints()} now supports evaluating strings
as forward references in @ref{6b2,,PEP 585 generic aliases}.

@item 
bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607}: Add @ref{1a5,,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{6ab,,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{301,,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{d16,,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{1562,,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 Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} compatible exceptions in
@ref{cf,,sqlite3}.


@itemize *

@item 
Raise @ref{67d,,InterfaceError} instead of
@ref{4f2,,ProgrammingError} for @code{SQLITE_MISUSE} errors.

@item 
Don’t overwrite @ref{15bd,,BufferError} with @ref{202,,ValueError} when conversion to
BLOB fails.

@item 
Raise @ref{4f2,,ProgrammingError} instead of @ref{1940,,Warning} if
user tries to @ref{2d1,,execute()} more than one SQL statement.

@item 
Raise @ref{4f2,,ProgrammingError} instead of @ref{202,,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{67e,,serialize()} and
@ref{67f,,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{1941,,ctypes.BigEndianUnion} and
@ref{1942,,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 Documentação<26>,Testes<30>,Biblioteca<67>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id345}@anchor{1943}
@subsubsection Documentação



@itemize -

@item 
bpo-45099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45099}: Document internal @ref{a,,asyncio} API.

@item 
bpo-47126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47126}: Update PEP URLs to 
@geindex Propostas de Melhorias do Python; 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{178c,,binascii.crc32()} / @ref{1944,,zlib.adler32()} / @ref{178b,,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{1945,,Definindo Tipos de Extensão; 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{9d9,,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 Testes<30>,Construção<33>,Documentação<26>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id346}@anchor{1946}
@subsubsection Testes



@itemize -

@item 
bpo-47205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47205}: Skip test for @ref{1149,,sched_getaffinity()} and
@ref{114d,,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{8ee,,asyncio.to_thread()} tests to use
@ref{30c,,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{b21,,os.sendfile()} is converted from
deprecated @code{asyncore} (see 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}) to @ref{a,,asyncio}. Patch by
Oleg Iarygin.
@end itemize

@node Construção<33>,Windows<28>,Testes<30>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id347}@anchor{1947}
@subsubsection Construção



@itemize -

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Add configure option @ref{1948,,--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<28>,macOS<21>,Construção<33>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id348}@anchor{1949}
@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{5be,,Inicializador Python para Windows} to support a new @code{-V:company/tag}
argument for full 
@geindex Propostas de Melhorias do Python; 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 variável de ambiente; 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<21>,Ferramentas/Demos<19>,Windows<28>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id349}@anchor{194a}
@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 Ferramentas/Demos<19>,API C<30>,macOS<21>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id350}@anchor{194b}
@subsubsection Ferramentas/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 API C<30>,,Ferramentas/Demos<19>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id351}@anchor{194c}
@subsubsection API C



@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{194d,,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{ba3,,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{194e,,sys.get_asyncgen_hooks()} and
@ref{1712,,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{765,,PyFloat_Pack2()}, @ref{766,,PyFloat_Pack4()},
@ref{767,,PyFloat_Pack8()}, @ref{768,,PyFloat_Unpack2()},
@ref{769,,PyFloat_Unpack4()} and @ref{76a,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-6}@anchor{194f}
@subsection Python 3.11.0 alpha 6


`Data de lançamento: 2022-03-07'

@menu
* Núcleo e embutidos: Núcleo e embutidos<66>. 
* Biblioteca: Biblioteca<68>. 
* Núcleo e embutidos: Núcleo e embutidos<67>. 
* Biblioteca: Biblioteca<69>. 
* Núcleo e embutidos: Núcleo e embutidos<68>. 
* Biblioteca: Biblioteca<70>. 
* Núcleo e embutidos: Núcleo e embutidos<69>. 
* Biblioteca: Biblioteca<71>. 
* Documentação: Documentação<27>. 
* Testes: Testes<31>. 
* Construção: Construção<34>. 
* Windows: Windows<29>. 
* IDLE: IDLE<20>. 
* API C: API C<31>. 

@end menu

@node Núcleo e embutidos<66>,Biblioteca<68>,,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id352}@anchor{1950}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-46940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46940}: Avoid overriding @ref{34b,,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{706,,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{1951,,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{970,,COMPARE_OP} followed by @ref{18a6,,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{4de,,LOAD_ATTR},
@ref{c39,,LOAD_METHOD}, and @ref{1952,,STORE_ATTR}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline cache for @ref{1835,,BINARY_SUBSCR}.

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: Use inline caching for @ref{970,,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{1953,,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{17dc,,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{706,,BINARY_OP} caches inline using a new
@ref{6f9,,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{4de,,LOAD_ATTR} and
@ref{1952,,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{970,,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.
@end itemize

@node Biblioteca<68>,Núcleo e embutidos<67>,Núcleo e embutidos<66>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id353}@anchor{1954}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46794}: Bump up the libexpat version into 2.4.6
@end itemize

@node Núcleo e embutidos<67>,Biblioteca<69>,Biblioteca<68>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id354}@anchor{1955}
@subsubsection Núcleo e embutidos



@itemize -

@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{1318,,__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{706,,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.
@end itemize

@node Biblioteca<69>,Núcleo e embutidos<68>,Núcleo e embutidos<67>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id355}@anchor{1956}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: @ref{2a,,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.
@end itemize

@node Núcleo e embutidos<68>,Biblioteca<70>,Biblioteca<69>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id356}@anchor{1957}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-45923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45923}: Add a quickened form of @ref{315,,RESUME} that skips quickening
checks.

@item 
bpo-46702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46702}: Specialize @ref{1953,,UNPACK_SEQUENCE} for @ref{370,,tuple} and
@ref{611,,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.
@end itemize

@node Biblioteca<70>,Núcleo e embutidos<69>,Núcleo e embutidos<68>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id357}@anchor{1958}
@subsubsection Biblioteca



@itemize -

@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{55c,,PyObject_Vectorcall()} while calling ctypes callback
function. Patch by Donghee Na.
@end itemize

@node Núcleo e embutidos<69>,Biblioteca<71>,Biblioteca<70>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id358}@anchor{1959}
@subsubsection Núcleo e embutidos



@itemize -

@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{195a,,PyLong_FromLong()}, and added a fast path for single-digit integers
to @ref{195b,,PyLong_FromLongLong()}.
@end itemize

@node Biblioteca<71>,Documentação<27>,Núcleo e embutidos<69>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id359}@anchor{195c}
@subsubsection Biblioteca



@itemize -

@item 
bpo-25707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25707}: Fixed a file leak in @ref{273,,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{195d,,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{195e,,find()} and @ref{195f,,rfind()} for
@code{find()} and @code{rfind()}.

@item 
bpo-46736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46736}: @ref{b56,,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{18af,,asyncio.DatagramTransport}.

@item 
bpo-46827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46827}: Support UDP sockets in  @ref{df2,,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{2c3,,TypeError} if @ref{8f0,,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{301,,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{1b8,,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{1960,,urllib.request.HTTPPasswordMgr.find_user_password()} and
@ref{1961,,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{1962,,random.gauss()} and @ref{1963,,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{38,,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{1964,,typing.ForwardRef} now
includes the @code{module} parameter of @ref{1964,,typing.ForwardRef} when it is
set.

@item 
bpo-46643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46643}: In @ref{6b1,,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{162,,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{15e,,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{5fd,,asyncio.gather()} when initial type
check fails.

@item 
bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}: The @ref{744,,calendar.LocaleTextCalendar} and
@ref{745,,calendar.LocaleHTMLCalendar} classes now use
@ref{2da,,locale.getlocale()}, instead of using
@ref{2d9,,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{2d9,,locale.getdefaultlocale()} function is deprecated and
will be removed in Python 3.13. Use @ref{2db,,locale.setlocale()},
@ref{53a,,locale.getpreferredencoding(False)}
and @ref{2da,,locale.getlocale()} functions instead.  Patch by Victor Stinner.

@item 
bpo-46655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46655}: In @ref{6b1,,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{a5e,,xml.etree.ElementTree.XMLParser} with a @code{target=None} keyword
provides a default @ref{a5f,,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{1c,,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{6b4,,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{229,,pathlib.Path} object as a context manager.

@item 
bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534}: Implement 
@geindex Propostas de Melhorias do Python; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} @ref{5c7,,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{6a8,,typing.Never} and @ref{6a7,,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{1964,,typing.ForwardRef} now honor the @code{module} parameter of
@ref{1964,,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{6b1,,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{62d,,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{2a,,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{1965,,is_tarfile()} method when using
`fileobj' argument: position in the `fileobj' was advanced forward which
made it unreadable with @ref{1966,,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{1c8,,configparser.ConfigParser} constructor raise
@ref{2c3,,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{64a,,inspect.ismethodwrapper()} and fix
@ref{16d6,,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 Documentação<27>,Testes<31>,Biblioteca<71>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id360}@anchor{1967}
@subsubsection Documentação



@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 Testes<31>,Construção<34>,Documentação<27>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id361}@anchor{1968}
@subsubsection Testes



@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 Construção<34>,Windows<29>,Testes<31>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id362}@anchor{1969}
@subsubsection Construção



@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{775,,_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<29>,IDLE<20>,Construção<34>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id363}@anchor{196a}
@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<20>,API C<31>,Windows<29>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id364}@anchor{196b}
@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 API C<31>,,IDLE<20>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id365}@anchor{196c}
@subsubsection API C



@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{789,,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{394,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-5}@anchor{196d}
@subsection Python 3.11.0 alpha 5


`Data de lançamento: 2022-02-03'

@menu
* Núcleo e embutidos: Núcleo e embutidos<70>. 
* Biblioteca: Biblioteca<72>. 
* Núcleo e embutidos: Núcleo e embutidos<71>. 
* Biblioteca: Biblioteca<73>. 
* Construção: Construção<35>. 
* Núcleo e embutidos: Núcleo e embutidos<72>. 
* Biblioteca: Biblioteca<74>. 
* Documentação: Documentação<28>. 
* Testes: Testes<32>. 
* Construção: Construção<36>. 
* Windows: Windows<30>. 
* macOS: macOS<22>. 
* IDLE: IDLE<21>. 
* API C: API C<32>. 

@end menu

@node Núcleo e embutidos<70>,Biblioteca<72>,,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id366}@anchor{196e}
@subsubsection Núcleo e embutidos



@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{4db,,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{257,,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{1a5,,DeprecationWarning}.

@item 
bpo-46458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46458}: Reorder code emitted by the compiler for a
@ref{6e9,,try}-@ref{18b,,except} block so that the @ref{18c,,else} block’s
code immediately follows the @ref{6e9,,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{14c9,,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{709,,COPY} and @ref{70a,,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 Propostas de Melhorias do Python; 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{196f,,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}.
@end itemize

@node Biblioteca<72>,Núcleo e embutidos<71>,Núcleo e embutidos<70>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id367}@anchor{1970}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<71>,Biblioteca<73>,Biblioteca<72>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id368}@anchor{1971}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-46361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46361}: Ensure that “small” integers created by @ref{1972,,int.from_bytes()}
and @ref{29d,,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
@end itemize

@node Biblioteca<73>,Construção<35>,Núcleo e embutidos<71>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id369}@anchor{1973}
@subsubsection Biblioteca



@itemize -

@item 
bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512}: Add CAN Socket support for NetBSD.
@end itemize

@node Construção<35>,Núcleo e embutidos<72>,Biblioteca<73>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id370}@anchor{1974}
@subsubsection Construção



@itemize -

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: Do not use POSIX semaphores on NetBSD
@end itemize

@node Núcleo e embutidos<72>,Biblioteca<74>,Construção<35>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id371}@anchor{1975}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-44024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44024}: Improve the @ref{2c3,,TypeError} message for non-string second
arguments passed to the built-in functions @ref{bea,,getattr()} and
@ref{4d2,,hasattr()}. Patch by Géry Ogam.
@end itemize

@node Biblioteca<74>,Documentação<28>,Núcleo e embutidos<72>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id372}@anchor{1976}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46624}: Restore support for non-integer arguments of
@ref{86f,,random.randrange()} and @ref{1270,,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{6b1,,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{1003,,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{6b1,,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{b05,,types.TracebackType} and
@ref{1977,,types.FrameType}. Calculate them directly from the caught
exception without calling @ref{68a,,sys.exc_info()}.

@item 
bpo-46491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46491}: Allow @ref{944,,typing.Annotated} to wrap @ref{267,,typing.Final} and
@ref{266,,typing.ClassVar}. Patch by Gregory Beauregard.

@item 
bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483}: Remove @ref{73b,,__class_getitem__()} from
@ref{4a6,,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{2c3,,TypeError} with a
relevant error message on invalid arg. Previously it allowed a cryptic
@ref{34b,,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{a,,asyncio} generic classes now return
@ref{7ed,,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{11ef,,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{1978,,__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{6aa,,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{171d,,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{17a2,,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{a0d,,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{630,,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{738,,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{c92,,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{1979,,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{134,,zoneinfo} to rely on importlib.resources
traversable API.

@item 
bpo-46103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46103}: Now @ref{197a,,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{197b,,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{15e,,ParamSpec} in
@ref{7c5,,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 Documentação<28>,Testes<32>,Biblioteca<74>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id373}@anchor{197c}
@subsubsection Documentação



@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 Testes<32>,Construção<36>,Documentação<28>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id374}@anchor{197d}
@subsubsection Testes



@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{d90,,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{197,,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 Construção<36>,Windows<30>,Testes<32>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id375}@anchor{197e}
@subsubsection Construção



@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<30>,macOS<22>,Construção<36>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id376}@anchor{197f}
@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 variável de ambiente; PATH
@code{PATH} instead of at the
start.
@end itemize

@node macOS<22>,IDLE<21>,Windows<30>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id377}@anchor{1980}
@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<21>,API C<32>,macOS<22>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id378}@anchor{1981}
@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 API C<32>,,IDLE<21>,Python 3 11 0 alpha 5
@anchor{whatsnew/changelog id379}@anchor{1982}
@subsubsection API C



@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{758,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-4}@anchor{1983}
@subsection Python 3.11.0 alpha 4


`Data de lançamento: 2022-01-13'

@menu
* Núcleo e embutidos: Núcleo e embutidos<73>. 
* Biblioteca: Biblioteca<75>. 
* Núcleo e embutidos: Núcleo e embutidos<74>. 
* Biblioteca: Biblioteca<76>. 
* Núcleo e embutidos: Núcleo e embutidos<75>. 
* Biblioteca: Biblioteca<77>. 
* Núcleo e embutidos: Núcleo e embutidos<76>. 
* Biblioteca: Biblioteca<78>. 
* Documentação: Documentação<29>. 
* Testes: Testes<33>. 
* Construção: Construção<37>. 
* Windows: Windows<31>. 
* macOS: macOS<23>. 
* API C: API C<33>. 

@end menu

@node Núcleo e embutidos<73>,Biblioteca<75>,,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id380}@anchor{1984}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-46070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46070}: @ref{1985,,Py_EndInterpreter()} now explicitly untracks all objects
currently tracked by the GC. Previously, if an object was used later by
another interpreter, calling @ref{154e,,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.
@end itemize

@node Biblioteca<75>,Núcleo e embutidos<74>,Núcleo e embutidos<73>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id381}@anchor{1986}
@subsubsection Biblioteca



@itemize -

@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”.
@end itemize

@node Núcleo e embutidos<74>,Biblioteca<76>,Biblioteca<75>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id382}@anchor{1987}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<76>,Núcleo e embutidos<75>,Núcleo e embutidos<74>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id383}@anchor{1988}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46085}: Fix iterator cache mechanism of @code{OrderedDict}.
@end itemize

@node Núcleo e embutidos<75>,Biblioteca<77>,Biblioteca<76>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id384}@anchor{1989}
@subsubsection Núcleo e embutidos



@itemize -

@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{18d,,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{190b,,POP_JUMP_IF_NOT_NONE} and
@ref{190a,,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{c,,atexit} module involving functions
that unregister themselves before raising exceptions. Patch by Pablo
Galindo.
@end itemize

@node Biblioteca<77>,Núcleo e embutidos<76>,Núcleo e embutidos<75>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id385}@anchor{198a}
@subsubsection Biblioteca



@itemize -

@item 
bpo-46000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46000}: Improve compatibility of the @ref{2b,,curses} module with NetBSD
curses.
@end itemize

@node Núcleo e embutidos<76>,Biblioteca<78>,Biblioteca<77>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id386}@anchor{198b}
@subsubsection Núcleo e embutidos



@itemize -

@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{192,,compile()} function did not
always raise a @ref{18d,,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 Propostas de Melhorias do Python; 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{5d9,,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{756,,Py_Version} constant which bears the same
value as @ref{757,,PY_VERSION_HEX}. Patch by Gabriele N. Tornetta.
@end itemize

@node Biblioteca<78>,Documentação<29>,Núcleo e embutidos<76>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id387}@anchor{198c}
@subsubsection Biblioteca



@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{68b,,sys.exception()} method which returns the active
exception instance.

@item 
bpo-46307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46307}: Add @ref{686,,string.Template.is_valid()} and
@ref{685,,string.Template.get_identifiers()} methods.

@item 
bpo-46306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46306}: Assume that @ref{2df,,types.CodeType} always has
@code{types.CodeType.co_firstlineno} in @ref{3a,,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{a,,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{15e,,typing.ParamSpec} and
@ref{15d,,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{198d,,enum.Enum.__dir__()}.

@item 
bpo-46266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46266}: Improve day constants in @ref{14,,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{6d0,,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{29f,,glob()} and
@ref{80a,,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{198e,,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{531,,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{6,,argparse} raises @ref{202,,ValueError} with clear message
when trying to render usage for an empty mutually exclusive group.
Previously it raised a cryptic @ref{157e,,IndexError}.

@item 
bpo-45615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45615}: Functions in the @ref{fe,,traceback} module raise @ref{2c3,,TypeError}
rather than @ref{34b,,AttributeError} when an exception argument is not of
type @ref{5bb,,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{639,,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{122c,,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 @ref{59,,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{198f,,multiprocessing.Event} objects, patch by Kumar Aditya.

@item 
bpo-45643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45643}: Added @ref{1990,,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{67d,,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{838,,TimeoutError}, keep these
names as deprecated aliases.
@end itemize

@node Documentação<29>,Testes<33>,Biblioteca<78>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id388}@anchor{1991}
@subsubsection Documentação



@itemize -

@item 
bpo-46196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46196}: Document method @ref{1992,,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{1993,,globals()} function.
@end itemize

@node Testes<33>,Construção<37>,Documentação<29>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id389}@anchor{1994}
@subsubsection Testes



@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{30c,,unittest.IsolatedAsyncioTestCase} usage.

@item 
bpo-23819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23819}: Fixed @ref{a,,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 Construção<37>,Windows<31>,Testes<33>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id390}@anchor{1995}
@subsubsection Construção



@itemize -

@item 
bpo-44133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44133}: When Python is configured with
@ref{892,,--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{866,,--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{fc8,,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}: Um novo diretório @code{Tools/wasm} contém auxiliares relacionados a WebAssembly, como @code{config.site} próprio para wasm32-emscripten, arquivos do gerador wasm para empacotar a stdlib e um 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<31>,macOS<23>,Construção<37>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id391}@anchor{1996}
@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<23>,API C<33>,Windows<31>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id392}@anchor{1997}
@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 API C<33>,,macOS<23>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id393}@anchor{1998}
@subsubsection API C



@itemize -

@item 
bpo-46236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46236}: Fix a bug in @ref{18bf,,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{759,,PyBuffer_GetPointer()},
@ref{75c,,PyBuffer_FromContiguous()}, @ref{75b,,PyBuffer_ToContiguous()} and
@ref{761,,PyMemoryView_FromBuffer()} now take buffer info by @code{const
Py_buffer *} instead of @code{Py_buffer *}, as they do not need mutability.
@ref{75c,,PyBuffer_FromContiguous()} also now takes the source buffer as
@code{const void *}, and similarly @ref{759,,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{1999,,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{3bd,,PyImport_ImportModuleNoBlock()} with
@ref{3be,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-3}@anchor{199a}
@subsection Python 3.11.0 alpha 3


`Data de lançamento: 2021-12-08'

@menu
* Núcleo e embutidos: Núcleo e embutidos<77>. 
* Biblioteca: Biblioteca<79>. 
* Núcleo e embutidos: Núcleo e embutidos<78>. 
* Biblioteca: Biblioteca<80>. 
* Documentação: Documentação<30>. 
* Testes: Testes<34>. 
* Construção: Construção<38>. 
* Windows: Windows<32>. 
* macOS: macOS<24>. 
* API C: API C<34>. 

@end menu

@node Núcleo e embutidos<77>,Biblioteca<79>,,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id394}@anchor{199b}
@subsubsection Núcleo e embutidos



@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{18d,,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{5bb,,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{199c,,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{68a,,sys.exc_info()} and @ref{772,,PyErr_GetExcInfo()} if the exception
instance is modified while the exception is handled, as well as
@ref{771,,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.
@end itemize

@node Biblioteca<79>,Núcleo e embutidos<78>,Núcleo e embutidos<77>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id395}@anchor{199d}
@subsubsection Biblioteca



@itemize -

@item 
bpo-45614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45614}: Fix @ref{fe,,traceback} display for exceptions with invalid module
name.
@end itemize

@node Núcleo e embutidos<78>,Biblioteca<80>,Biblioteca<79>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id396}@anchor{199e}
@subsubsection Núcleo e embutidos



@itemize -

@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{6fe,,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{1835,,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 Propostas de Melhorias do Python; 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{706,,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{197,,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{706,,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 Biblioteca<80>,Documentação<30>,Núcleo e embutidos<78>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id397}@anchor{199f}
@subsubsection Biblioteca



@itemize -

@item 
bpo-27946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27946}: Fix possible crash when getting an attribute of
@ref{310,,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{a,,asyncio} normalize exceptions as soon as they are
captured with @ref{3f3,,PyErr_Fetch()}, and before they are stored as an
exc_info triplet. This brings @ref{a,,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{531,,unittest.TextTestResult} and
@ref{183e,,unittest.TextTestRunner} flush now the output stream more often.

@item 
bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917}: Added @ref{660,,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 por 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{834,,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{38,,dis} produced an incorrect oparg when
@ref{18a6,,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{3b4,,sys.path}
location while the program is running, calling the
@ref{c2a,,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{bb4,,types.resolve_bases()} and @ref{11a0,,types.new_class()} for
@ref{7ed,,types.GenericAlias} instance as a base.

@item 
bpo-45663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45663}: Fix @ref{19a0,,dataclasses.is_dataclass()} for dataclasses which are
subclasses of @ref{7ed,,types.GenericAlias}.

@item 
bpo-45662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45662}: Fix the repr of @ref{193e,,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{69d,,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{6d0,,math.comb()} and @ref{6d1,,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 Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} for @ref{8e7,,graphlib.TopologicalSorter}.

@item 
bpo-44733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44733}: Add @code{max_tasks_per_child} to
@ref{8f4,,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{649,,inspect.getmembers_static()} , it return all members
without triggering dynamic lookup via the descriptor protocol. Patch by
Weipeng Hong.
@end itemize

@node Documentação<30>,Testes<34>,Biblioteca<80>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id398}@anchor{19a1}
@subsubsection Documentação



@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{d6b,,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{1822,,astuple()} and
@ref{1819,,asdict()} docs, warning about deepcopy being applied and
providing a workaround.
@end itemize

@node Testes<34>,Construção<38>,Documentação<30>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id399}@anchor{19a2}
@subsubsection Testes



@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{9f7,,functools.lru_cache()}
to @code{test_functools}.
@end itemize

@node Construção<38>,Windows<32>,Testes<34>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id400}@anchor{19a3}
@subsubsection Construção



@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 por 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{36,,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{133,,zlib}, @ref{13,,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<32>,macOS<24>,Construção<38>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id401}@anchor{19a4}
@subsubsection Windows



@itemize -

@item 
bpo-46105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46105}: Fixed calculation of @ref{3b4,,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<24>,API C<34>,Windows<32>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id402}@anchor{19a5}
@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 API C<34>,,macOS<24>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id403}@anchor{19a6}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-2}@anchor{19a7}
@subsection Python 3.11.0 alpha 2


`Data de lançamento: 2021-11-05'

@menu
* Núcleo e embutidos: Núcleo e embutidos<79>. 
* Biblioteca: Biblioteca<81>. 
* Documentação: Documentação<31>. 
* Testes: Testes<35>. 
* Construção: Construção<39>. 
* Windows: Windows<33>. 
* macOS: macOS<25>. 
* IDLE: IDLE<22>. 
* API C: API C<35>. 

@end menu

@node Núcleo e embutidos<79>,Biblioteca<81>,,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id404}@anchor{19a8}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-45716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45716}: Improve the @ref{18d,,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{844,,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{419,,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{19a9,,Comparações 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{176,,-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 Propostas de Melhorias do Python; PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}. Add @ref{1b6,,ExceptionGroup} and
@ref{25f,,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 Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.
@end itemize

@node Biblioteca<81>,Documentação<31>,Núcleo e embutidos<79>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id405}@anchor{19aa}
@subsubsection Biblioteca



@itemize -

@item 
bpo-45679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45679}: Fix caching of multi-value @ref{858,,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{67c,,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{2a8,,sqlite3.connect()} now correctly raises @ref{15c5,,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{82b,,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{19ab,,operator.call()} to @code{operator.__all__}. Patch by
Kreusada.

@item 
bpo-42174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42174}: @ref{1142,,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{f8a,,importlib.machinery.NamespaceLoader} is
now public, and implements the @ref{f88,,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{134,,zoneinfo} in the @ref{30,,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{41a,,gzip.GzipFile},
@ref{86a,,bz2.BZ2File}, and @ref{1042,,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{1964,,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{19ac,,email.utils.parsedate_tz()} crashing with
@ref{157f,,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{19ad,,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{a7d,,asyncio.Condition} with explicit
@ref{a7b,,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{1771,,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{3a,,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{18f8,,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{29,,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{12e,,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{1771,,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{b53,,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{67a,,setlimit()} and
@ref{67b,,getlimit()} to @ref{245,,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{738,,inspect.signature()} or @ref{739,,inspect.getfullargspec()} instead.
@end table

@item 
the @code{formatargspec} function, deprecated since Python 3.5;
use the @ref{738,,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{73a,,Signature.from_callable()} method
instead.
@end itemize

Patch por 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{60c,,chdir()} context
manager to change the current working directory and then restore it on
exit. Simple wrapper around @ref{60d,,chdir()}.

@item 
bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139}: Add support for SQLite extended result codes in
@ref{19ae,,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{6,,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{1e7,,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 Documentação<31>,Testes<35>,Biblioteca<81>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id406}@anchor{19af}
@subsubsection Documentação



@itemize -

@item 
bpo-45726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45726}: Improve documentation for @ref{639,,functools.singledispatch()} and
@ref{9f8,,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{19b0,,importlib.abc.TraversableResources} documentation.

@item 
bpo-45464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45464}: Mention in the documentation of @ref{19b1,,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 Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} in @ref{1e,,collections.abc}.

@item 
bpo-45516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45516}: Add protocol description to the
@ref{19b2,,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 Testes<35>,Construção<39>,Documentação<31>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id407}@anchor{19b3}
@subsubsection Testes



@itemize -

@item 
bpo-45678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45678}: Add tests for scenarios in which
@ref{9f8,,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{f5f,,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 Construção<39>,Windows<33>,Testes<35>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id408}@anchor{19b4}
@subsubsection Construção



@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{18,,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{178,,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<33>,macOS<25>,Construção<39>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id409}@anchor{19b5}
@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<25>,IDLE<22>,Windows<33>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id410}@anchor{19b6}
@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<22>,API C<35>,macOS<25>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id411}@anchor{19b7}
@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 API C<35>,,IDLE<22>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id412}@anchor{19b8}
@subsubsection API C



@itemize -

@item 
bpo-29103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29103}: @ref{551,,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{3bf,,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{784,,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{796,,PyMarshal_WriteLongToFile()}

@item 
@ref{797,,PyMarshal_WriteObjectToFile()}

@item 
@ref{798,,PyMarshal_ReadObjectFromString()}

@item 
@ref{799,,PyMarshal_WriteObjectToString()}

@item 
a macro @code{Py_MARSHAL_VERSION}
@end itemize

Eles não fazem parte da @ref{79a,,API limitada}.

Patch por 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 por 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{754,,PyThreadState_EnterTracing()}, and
@ref{755,,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{989,,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,Changelog
@anchor{whatsnew/changelog python-3-11-0-alpha-1}@anchor{19b9}
@subsection Python 3.11.0 alpha 1


`Data de lançamento: 2021-10-05'

@menu
* Segurança: Segurança<25>. 
* Núcleo e embutidos: Núcleo e embutidos<80>. 
* Biblioteca: Biblioteca<82>. 
* Núcleo e embutidos: Núcleo e embutidos<81>. 
* Biblioteca: Biblioteca<83>. 
* Núcleo e embutidos: Núcleo e embutidos<82>. 
* Biblioteca: Biblioteca<84>. 
* Núcleo e embutidos: Núcleo e embutidos<83>. 
* Biblioteca: Biblioteca<85>. 
* Núcleo e embutidos: Núcleo e embutidos<84>. 
* Biblioteca: Biblioteca<86>. 
* Núcleo e embutidos: Núcleo e embutidos<85>. 
* Biblioteca: Biblioteca<87>. 
* Núcleo e embutidos: Núcleo e embutidos<86>. 
* Biblioteca: Biblioteca<88>. 
* Núcleo e embutidos: Núcleo e embutidos<87>. 
* Biblioteca: Biblioteca<89>. 
* Núcleo e embutidos: Núcleo e embutidos<88>. 
* Biblioteca: Biblioteca<90>. 
* Núcleo e embutidos: Núcleo e embutidos<89>. 
* Biblioteca: Biblioteca<91>. 
* Documentação: Documentação<32>. 
* Testes: Testes<36>. 
* Construção: Construção<40>. 
* Windows: Windows<34>. 
* macOS: macOS<26>. 
* IDLE: IDLE<23>. 
* Ferramentas/Demos: Ferramentas/Demos<20>. 
* API C: API C<36>. 

@end menu

@node Segurança<25>,Núcleo e embutidos<80>,,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id413}@anchor{19ba}
@subsubsection Segurança



@itemize -

@item 
bpo-42278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42278}: Replaced usage of @ref{19bb,,tempfile.mktemp()} with
@ref{1275,,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{810,,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 Núcleo e embutidos<80>,Biblioteca<82>,Segurança<25>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id414}@anchor{19bc}
@subsubsection Núcleo e embutidos



@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{7ed,,types.GenericAlias} objects.

@item 
bpo-45155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45155}: @ref{19bd,,int.to_bytes()} and @ref{1972,,int.from_bytes()} now take a
default value of @code{"big"} for the @code{byteorder} argument.
@ref{19bd,,int.to_bytes()} also takes a default value of @code{1} for the
@code{length} argument.
@end itemize

@node Biblioteca<82>,Núcleo e embutidos<81>,Núcleo e embutidos<80>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id415}@anchor{19be}
@subsubsection Biblioteca



@itemize -

@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{19bf,,os.isatty()},
@ref{19c0,,os.device_encoding()} and @ref{7bc,,io.TextIOWrapper}. By extension,
@ref{51d,,io.open()} in text mode is also affected. This change solves a
deadlock in @ref{19bf,,os.isatty()}. Patch by Vincent Michel in bpo-44219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44219}.
@end itemize

@node Núcleo e embutidos<81>,Biblioteca<83>,Biblioteca<82>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id416}@anchor{19c1}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-44959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44959}: Added fallback to extension modules with ‘.sl’ suffix on HP-UX
@end itemize

@node Biblioteca<83>,Núcleo e embutidos<82>,Núcleo e embutidos<81>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id417}@anchor{19c2}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<82>,Biblioteca<84>,Biblioteca<83>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id418}@anchor{19c3}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-44348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44348}: The deallocator function of the @ref{5bb,,BaseException} type now
uses the trashcan mechanism to prevent stack overflow. For example, when a
@ref{d90,,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{51c,,open()}, @ref{51d,,io.open()}, @ref{740,,codecs.open()} and
@ref{737,,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).
@end itemize

@node Biblioteca<84>,Núcleo e embutidos<83>,Núcleo e embutidos<82>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id419}@anchor{19c4}
@subsubsection Biblioteca



@itemize -

@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{17ed,,os.DirEntry.stat()}. Patch by
Stanisław Skonieczny.
@end itemize

@node Núcleo e embutidos<83>,Biblioteca<85>,Biblioteca<84>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id420}@anchor{19c5}
@subsubsection Núcleo e embutidos



@itemize -

@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{18d,,SyntaxError} is now raised when trying to delete
@ref{7db,,__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.
@end itemize

@node Biblioteca<85>,Núcleo e embutidos<84>,Núcleo e embutidos<83>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id421}@anchor{19c6}
@subsubsection Biblioteca



@itemize -

@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
@end itemize

@node Núcleo e embutidos<84>,Biblioteca<86>,Biblioteca<85>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id422}@anchor{19c7}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}: Implement the @code{__bytes__()} special method on the
@ref{1c2,,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{2f8,,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
@end itemize

@node Biblioteca<86>,Núcleo e embutidos<85>,Núcleo e embutidos<84>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id423}@anchor{19c8}
@subsubsection Biblioteca



@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.
@end itemize

@node Núcleo e embutidos<85>,Biblioteca<87>,Biblioteca<86>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id424}@anchor{19c9}
@subsubsection Núcleo e embutidos



@itemize -

@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{2f7,,float} or @ref{2f8,,complex}.

@item 
bpo-44895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44895}: A debug variable 
@geindex PYTHONDUMPREFSFILE
@geindex variável de ambiente; PYTHONDUMPREFSFILE
@ref{19ca,,PYTHONDUMPREFSFILE} is added for
creating a dump file which is generated by @ref{395,,--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{18d,,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{7d3,,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.
@end itemize

@node Biblioteca<87>,Núcleo e embutidos<86>,Núcleo e embutidos<85>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id425}@anchor{19cb}
@subsubsection Biblioteca



@itemize -

@item 
bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611}: On Windows, @ref{523,,os.urandom()}: uses BCryptGenRandom API
instead of CryptGenRandom API which is deprecated from Microsoft Windows
API. Patch by Donghee Na.
@end itemize

@node Núcleo e embutidos<86>,Biblioteca<88>,Biblioteca<87>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id426}@anchor{19cc}
@subsubsection Núcleo e embutidos



@itemize -

@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{18d,,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.
@end itemize

@node Biblioteca<88>,Núcleo e embutidos<87>,Núcleo e embutidos<86>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id427}@anchor{19cd}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<87>,Biblioteca<89>,Biblioteca<88>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id428}@anchor{19ce}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{154c,,PyObject_GC_Del()} in error path when
initializing @ref{7ed,,types.GenericAlias}.
@end itemize

@node Biblioteca<89>,Núcleo e embutidos<88>,Núcleo e embutidos<87>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id429}@anchor{19cf}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<88>,Biblioteca<90>,Biblioteca<89>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id430}@anchor{19d0}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: Heap types with the @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} flag
can now inherit the 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall protocol.  Previously, this was
only possible for @ref{77f,,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{5eb,,hash()} of
@ref{a5b,,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{2c3,,TypeError} is now raised instead of an
@ref{34b,,AttributeError} in @ref{5d2,,with} and @ref{5d5,,async with}
statements for objects which do not support the @ref{5d4,,context manager} or
@ref{5d7,,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.
@end itemize

@node Biblioteca<90>,Núcleo e embutidos<89>,Núcleo e embutidos<88>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id431}@anchor{19d1}
@subsubsection Biblioteca



@itemize -

@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
@end itemize

@node Núcleo e embutidos<89>,Biblioteca<91>,Biblioteca<90>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id432}@anchor{19d2}
@subsubsection Núcleo e embutidos



@itemize -

@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{370,,tuple}, @ref{611,,list}, @ref{5da,,frozenset}) no longer accept
arbitrary keyword arguments. [reverted in 3.11a4] Subclass of @ref{5d9,,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{d6b,,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}: Correção de assinaturas incorretas das funções dictkeys_reversed e dictitems_reversed no código C, que quebrou a construção do WebAssembly.

@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{621,,str.format()}.

@item 
bpo-11105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11105}: When compiling @ref{1a6,,ast.AST} objects with recursive
references through @ref{192,,compile()}, the interpreter doesn’t crash anymore
instead it raises a @ref{d90,,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 Biblioteca<91>,Documentação<32>,Núcleo e embutidos<89>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id433}@anchor{19d3}
@subsubsection Biblioteca



@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{698,,threading.Lock.acquire()}
method now uses the monotonic clock (@ref{699,,time.CLOCK_MONOTONIC}) for
the timeout, rather than using the system clock
(@ref{69a,,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{1224,,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{69d,,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{69d,,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{19d4,,unittest.TestCase.debug()} raises now a
@ref{101a,,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{a63,,copyfile()},
@ref{a64,,copy()}, @ref{a65,,copy2()} raising
@ref{42b,,FileNotFoundError} when source is a directory, which should raise
@ref{1092,,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 por 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{b46,,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{69d,,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{22,,configparser} module: the
@code{SafeConfigParser} class, the @code{filename} property of the
@ref{505,,ParsingError} class, the @code{readfp()} method of
the @ref{1c8,,ConfigParser} class, deprecated since Python
3.2.

Patch por 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{6d5,,unicodedata.normalize()}. Patch by Donghee Na.

@item 
bpo-35474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35474}: Calling @ref{19d5,,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{6b1,,typing.get_type_hints()} now works with
@ref{267,,Final} wrapped in @ref{1964,,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{44f,,TestCase} methods.

@item 
Broken from start @ref{44f,,TestCase} method @code{assertDictContainsSubset()}.

@item 
Ignored @code{<unittest.TestLoader.loadTestsFromModule> TestLoader.loadTestsFromModule()} parameter `use_load_tests'.

@item 
Old alias @code{_TextTestResult} of @ref{531,,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{283,,__getitem__()} methods of
@ref{735,,xml.dom.pulldom.DOMEventStream}, @ref{736,,wsgiref.util.FileWrapper}
and @ref{737,,fileinput.FileInput}, deprecated since Python 3.9.

Patch por 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{733,,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 por 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 por Hugo van Kemenade.

@item 
bpo-30856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30856}: @ref{11a6,,unittest.TestResult} methods
@ref{19d6,,addFailure()},
@ref{19d7,,addError()},
@ref{19d8,,addSkip()} and
@ref{19d9,,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{10,,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

A função @ref{734,,binascii.crc_hqx()} continua disponível.

Patch por 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 Propostas de Melhorias do Python; 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{6a3,,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{11a5,,run()} now always return a
@ref{11a6,,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{21,,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{a55,,addModuleCleanup()} were not called unless the user defines @code{tearDownModule()} in their test module.

@item 
Functions registered with @ref{a56,,addClassCleanup()} were not called if @code{tearDownClass} is set to @code{None}.

@item 
Buffering in @ref{11a6,,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{63e,,gzip.compress()} and
@ref{124d,,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{5d9,,set} and @ref{5da,,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{1390,,stopTestRun()} is now always
called in pair with method @ref{138f,,startTestRun()} for
@ref{11a6,,TestResult} objects implicitly created in
@ref{11a5,,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{19da,,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{220,,os.posix_spawn()} for better performance.

@item 
bpo-44911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44911}: @ref{30c,,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{197b,,argparse.BooleanOptionalAction}’s default value is no
longer printed twice when used with
@ref{19db,,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{93f,,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{15c5,,MemoryError} is now raised instead of @ref{1940,,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{1940,,sqlite3.Warning} when the statement contains surrogate characters in @code{Connection.__call__()} and @code{Cursor.execute()}.

@item 
@ref{2c3,,TypeError} is now raised instead of @ref{202,,ValueError} for non-string script argument in @code{Cursor.executescript()}.

@item 
@ref{202,,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{f2d,,os.set_inheritable()} function on FreeBSD 14 for
file descriptor opened with the @ref{fa6,,O_PATH} flag: ignore the
@ref{962,,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{15c5,,MemoryError} raised in user-defined functions will now
produce a @code{MemoryError} in @ref{cf,,sqlite3}. @ref{885,,OverflowError} will
now be converted to @ref{19dc,,DataError}. Previously
@ref{19dd,,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{44c,,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{15e,,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{264,,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{1331,,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{4d9,,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{bea,,getattr()} on
@ref{194,,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{19de,,logging.FileHandler} is used in @ref{c,,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{e0b,,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{676,,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{885,,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{738,,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{15f8,,inspect.getsource()}
when examining a class in the interactive session. Instead of
@ref{2c3,,TypeError}, it should be @ref{417,,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{9f7,,functools.lru_cache()}) was bumped up from 256 to 32768, affecting
functions: @ref{19df,,fnmatch.fnmatch()}, @ref{19e0,,fnmatch.fnmatchcase()},
@ref{19e1,,fnmatch.filter()}.

@item 
bpo-41928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41928}: Update @ref{a63,,shutil.copyfile()} to raise
@ref{42b,,FileNotFoundError} instead of confusing @ref{1092,,IsADirectoryError}
when a path ending with a @code{os.path.sep} does not exist;
@ref{a64,,shutil.copy()} and @ref{a65,,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{8e1,,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{fb3,,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{19e2,,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{27b,,email.message.EmailMessage}.

@item 
bpo-44468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44468}: @ref{6b1,,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{675,,None} to @ref{2ab,,set_authorizer()}. Patch
by Erlend E. Aasland.

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: Set the proper @ref{19e3,,Py_TPFLAGS_MAPPING} and
@ref{19e4,,Py_TPFLAGS_SEQUENCE} flags for subclasses created before a
parent has been registered as a @ref{8d0,,collections.abc.Mapping} or
@ref{1204,,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{2c3,,TypeError} is now raised instead of an
@ref{34b,,AttributeError} in @ref{5d3,,contextlib.ExitStack.enter_context()} and
@ref{5d6,,contextlib.AsyncExitStack.enter_async_context()} for objects which do
not support the @ref{5d4,,context manager} or @ref{5d7,,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{eb3,,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{77d,,Py_TPFLAGS_HAVE_GC} flag. Patch by
Victor Stinner.

@item 
bpo-44422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44422}: The @ref{19e5,,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{2c3,,TypeError}.

@item 
bpo-44389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44389}: Fix deprecation of @ref{19e6,,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{661,,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{659,,logging.getLevelNamesMapping()}

@item 
bpo-44260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44260}: The @ref{19e7,,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{731,,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{1e7,,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{173b,,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{8eb,,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{6c9,,zipfile.Path} now supports @ref{6c6,,zipfile.Path.stem},
@ref{6c8,,zipfile.Path.suffixes}, and @ref{6c7,,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 Propostas de Melhorias do Python; 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{8eb,,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{d6e,,pkgutil.iter_modules()} with a list of @ref{229,,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{b56,,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{34b,,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{15c5,,MemoryError}
@end itemize

Patch por 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{15c5,,MemoryError} in @ref{46b,,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{63f,,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{518,,importlib.import_module()} and @ref{10a6,,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{742,,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{852,,traceback.print_exception()}, @ref{850,,traceback.format_exception()} and
@ref{851,,traceback.format_exception_only()}.

@item 
bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809}: Add the @ref{6a4,,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{9f7,,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{ff6,,subprocess.check_output()} now raises @ref{202,,ValueError}
when the invalid keyword argument `check' is passed by user code.
Previously such use would fail later with a @ref{2c3,,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{19e8,,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{ea6,,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{1195,,Semaphore}, @ref{1196,,BoundedSemaphore},
@ref{1197,,Event} and @ref{1223,,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

Em vez delas, use os métodos de @ref{28e,,TestLoader}:


@itemize *

@item 
@ref{28f,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{290,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{291,,unittest.TestLoader.getTestCaseNames()}
@end itemize

Patch por 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{22,,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{b3c,,contextlib.asynccontextmanager()} to match
@ref{1242,,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{1e1,,email.utils.getaddresses()} now accepts
@ref{19e9,,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 Documentação<32>,Testes<36>,Biblioteca<91>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id434}@anchor{19ea}
@subsubsection Documentação



@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{1e,,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{19eb,,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{19bd,,int.to_bytes()} and
@ref{1972,,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{e,,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{4b3,,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{1754,,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{8e2,,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{150f,,textwrap.wrap()},
@ref{150e,,textwrap.fill()}, and @ref{1006,,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{131,,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{1372,,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{a,,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{2f,,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{11fc,,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 Testes<36>,Construção<40>,Documentação<32>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id435}@anchor{19ec}
@subsubsection Testes



@itemize -

@item 
bpo-40173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40173}: Fix @ref{19ed,,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{2b0,,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{bb9,,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{93f,,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{a43,,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{146a,,id()} is preserved when @code{obj
* 1} is used on @ref{44c,,str} and @ref{1c2,,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{19ee,,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{a0e,,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{1840,,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 Construção<40>,Windows<34>,Testes<36>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id436}@anchor{19ef}
@subsubsection Construção



@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 variável de ambiente; 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<34>,macOS<26>,Construção<40>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id437}@anchor{19f0}
@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{698,,threading.Lock.acquire()} or
@ref{19f1,,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<26>,IDLE<23>,Windows<34>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id438}@anchor{19f2}
@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{d6c,,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<23>,Ferramentas/Demos<20>,macOS<26>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id439}@anchor{19f3}
@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{810,,match} statement’s @ref{80f,,soft keywords}: @ref{810,,match}, @ref{810,,case}, and
@ref{811,,_}. 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 Ferramentas/Demos<20>,API C<36>,IDLE<23>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id440}@anchor{19f4}
@subsubsection Ferramentas/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 API C<36>,,Ferramentas/Demos<20>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id441}@anchor{19f5}
@subsubsection API C



@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{202,,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{19f6,,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{19f7,,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{468,,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{753,,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{9cd,,Py_RunMain()} now resets @ref{18a3,,PyImport_Inittab} to
its initial value at exit. It must be possible to call
@ref{18a4,,PyImport_AppendInittab()} or @ref{18a5,,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.

Funções removidas:


@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{78d,,PyThreadState} members like
@code{_tstate->trash_delete_nesting}, whereas the @ref{78d,,PyThreadState}
structure is opaque in the limited C API.

Exclude also the @code{PyTrash_UNWIND_LEVEL} constant from the C API.

Patch por 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{79a,,Conteúdo da API Limitada} now shows the public name
@ref{789,,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{192b,,Py_IS_TYPE()} no longer uses @ref{780,,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{780,,Py_TYPE()} and @ref{782,,Py_SIZE()} macros to
static inline functions. The @ref{781,,Py_SET_TYPE()} and
@ref{783,,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{77c,,PyType_Ready()} function now raises an error if a
type is defined with the @ref{77d,,Py_TPFLAGS_HAVE_GC} flag set but has no
traverse function (@ref{77e,,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{3a6,,PyConfig} API of the @ref{3a7,,Python Initialization Configuration} instead (
@geindex Propostas de Melhorias do Python; 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{89b,,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 Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} and 
@geindex Propostas de Melhorias do Python; 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{752,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-beta-1}@anchor{19f8}
@subsection Python 3.10.0 beta 1


`Data de lançamento: 2021-05-03'

@menu
* Segurança: Segurança<26>. 
* Núcleo e embutidos: Núcleo e embutidos<90>. 
* Biblioteca: Biblioteca<92>. 
* Núcleo e embutidos: Núcleo e embutidos<91>. 
* Biblioteca: Biblioteca<93>. 
* Núcleo e embutidos: Núcleo e embutidos<92>. 
* Biblioteca: Biblioteca<94>. 
* Documentação: Documentação<33>. 
* Testes: Testes<37>. 
* Construção: Construção<41>. 
* Windows: Windows<35>. 
* macOS: macOS<27>. 
* IDLE: IDLE<24>. 
* API C: API C<37>. 

@end menu

@node Segurança<26>,Núcleo e embutidos<90>,,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id442}@anchor{19f9}
@subsubsection Segurança



@itemize -

@item 
bpo-43434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43434}: Creating @ref{245,,sqlite3.Connection} objects now also produces
@code{sqlite3.connect} and @code{sqlite3.connect/handle} @ref{19fa,,auditing events}. Previously these events were only produced by
@ref{2a8,,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{294,,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{841,,sqlite3.Connection.enable_load_extension()}, and
@ref{4b8,,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{29f,,glob.glob()} and
@ref{80a,,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{968,,socket.inet_aton()} treats leading zeros as octal notation. glibc
implementation of modern @ref{969,,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{19fb,,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 Núcleo e embutidos<90>,Biblioteca<92>,Segurança<26>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id443}@anchor{19fc}
@subsubsection Núcleo e embutidos



@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{19fd,,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{1e,,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.
@end itemize

@node Biblioteca<92>,Núcleo e embutidos<91>,Núcleo e embutidos<90>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id444}@anchor{19fe}
@subsubsection Biblioteca



@itemize -

@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{1a0,,array.array} type immutable. Patch by Erlend
E. Aasland.
@end itemize

@node Núcleo e embutidos<91>,Biblioteca<93>,Biblioteca<92>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id445}@anchor{19ff}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{18d,,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{7a9,,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{43f,,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{1a00,,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{416,,@@staticmethod}) and class methods
(@ref{166,,@@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{1a01,,__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.
@end itemize

@node Biblioteca<93>,Núcleo e embutidos<92>,Núcleo e embutidos<91>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id446}@anchor{1a02}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<92>,Biblioteca<94>,Biblioteca<93>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id447}@anchor{1a03}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}: Static methods (@ref{416,,@@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{d90,,RecursionError} is now raised instead.

@item 
bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}: When printing @ref{34b,,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 Biblioteca<94>,Documentação<33>,Núcleo e embutidos<92>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id448}@anchor{1a04}
@subsubsection Biblioteca



@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{1a05,,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{279,,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{6b1,,typing.get_type_hints()} receives no namespace dictionary
arguments, @ref{6b1,,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{f1d,,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{816,,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{816,,inspect.get_annotations()}
can also correctly un-stringize stringized annotations.

@ref{738,,inspect.signature()}, @code{inspect.from_callable()}, and
@code{inspect.from_function()} now call @ref{816,,inspect.get_annotations()} to
retrieve annotations.  This means @ref{738,,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 Propostas de Melhorias do Python; 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{d63,,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{86a,,bz2.BZ2File},
@ref{41a,,gzip.GzipFile}, and @ref{1042,,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{51d,,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{344,,KeyError} raised in @ref{6b1,,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{199,,subprocess.Popen} args are provided as a string or
as @ref{229,,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{442,,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{83a,,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 Propostas de Melhorias do Python; 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{225,,os.path.realpath()} now accepts a `strict' keyword-only
argument. When set to @code{True}, @ref{417,,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 
gh-47383@footnote{https://github.com/python/cpython/issues/47383}: The @code{P.args} and @code{P.kwargs} attributes of
@ref{15e,,typing.ParamSpec} are now instances of the new classes
@ref{7c7,,typing.ParamSpecArgs} and @ref{7c8,,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{802,,fileinput.input()} and @ref{737,,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{1a01,,__match_args__} generation
could fail for some @ref{2f,,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{309,,threading.current_thread()}

@item 
@code{activeCount} => @ref{30a,,threading.active_count()}

@item 
@code{Condition.notifyAll} => @ref{303,,threading.Condition.notify_all()}

@item 
@code{Event.isSet} => @ref{304,,threading.Event.is_set()}

@item 
@code{Thread.setName} => @ref{308,,threading.Thread.name}

@item 
@code{thread.getName} => @ref{308,,threading.Thread.name}

@item 
@code{Thread.isDaemon} => @ref{306,,threading.Thread.daemon}

@item 
@code{Thread.setDaemon} => @ref{306,,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{1a06,,turtle.textinput()} and @ref{1a07,,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{b95,,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{ea6,,tarfile.open()} when @ref{8a,,lzma}
/ @ref{13,,bz2} are unavailable.  Patch by Anthony Sottile.

@item 
bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}: Allow @ref{1c2,,bytes} @code{separator} argument in
@code{urllib.parse.parse_qs} and @code{urllib.parse.parse_qsl} when parsing
@ref{44c,,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{15c5,,MemoryError}. Patch by
Erlend E. Aasland.

@item 
bpo-43312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43312}: New functions @ref{690,,sysconfig.get_preferred_scheme()} and
@ref{193f,,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{b92,,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{1cb,,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{6b1,,typing.get_type_hints()} now checks the local namespace of
a class when evaluating 
@geindex Propostas de Melhorias do Python; 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{2c2,,asyncio.get_event_loop()} without
running event loop. Emit deprecation warning for @ref{a,,asyncio} functions
which implicitly create a @ref{be6,,Future} or
@ref{1be,,Task} objects if there is no running event loop and no
explicit `loop' argument is passed: @ref{c92,,ensure_future()},
@ref{1a08,,wrap_future()}, @ref{5fd,,gather()},
@ref{a7a,,shield()}, @ref{1aa,,as_completed()} and constructors of
@ref{be6,,Future}, @ref{1be,,Task},
@ref{1a09,,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{13,,bz2} /
@ref{8a,,lzma} / @ref{133,,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{83f,,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{17ec,,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{1a0a,,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{826,,pathlib.Path.stat()} and @ref{827,,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{a1e,,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{e6f,,pathlib.Path.expanduser()} and @ref{e70,,home()} now
consistently raise @ref{195,,RuntimeError} exception when a home directory
cannot be resolved. Previously a @ref{344,,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{83f,,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{17da,,ctypes.c_wchar_p} type: embedded null characters would cause a
@ref{202,,ValueError} to be raised. Patch by Zackery Spytz.
@end itemize

@node Documentação<33>,Testes<37>,Biblioteca<94>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id449}@anchor{1a0b}
@subsubsection Documentação



@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{19e3,,Py_TPFLAGS_MAPPING} and
@ref{19e4,,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 Testes<37>,Construção<41>,Documentação<33>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id450}@anchor{1a0c}
@subsubsection Testes



@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{1131,,os.replace()} rather than @ref{1130,,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{84e,,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 Construção<41>,Windows<35>,Testes<37>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id451}@anchor{1a0d}
@subsubsection Construção



@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 Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}. Python now requires OpenSSL 1.1.1 or
newer.
@end itemize

@node Windows<35>,macOS<27>,Construção<41>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id452}@anchor{1a0e}
@subsubsection Windows



@itemize -

@item 
bpo-35306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35306}: Adds additional arguments to @ref{1a0f,,os.startfile()} function.

@item 
bpo-43538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43538}: Avoid raising errors from @ref{a20,,pathlib.Path.exists()} when
passed an invalid filename.

@item 
bpo-38822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38822}: Fixed @ref{4a0,,os.stat()} failing on inaccessible directories with
a trailing slash, rather than falling back to the parent directory’s
metadata. This implicitly affected @ref{a18,,os.path.exists()} and
@ref{a1a,,os.path.isdir()}.

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: Fixed decoding of host names in @ref{1a10,,socket.gethostbyaddr()}
and @ref{1a11,,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<27>,IDLE<24>,Windows<35>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id453}@anchor{1a12}
@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<24>,API C<37>,macOS<27>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id454}@anchor{1a13}
@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 API C<37>,,IDLE<24>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id455}@anchor{1a14}
@subsubsection API C



@itemize -

@item 
bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916}: Add a new @ref{582,,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{8a8,,PyGC_Enable()}, @ref{8a9,,PyGC_Disable()},
@ref{8aa,,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{3c2,,Py_TPFLAGS_IMMUTABLETYPE} flag for
immutable type objects, and modify @ref{77c,,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{edc,,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{586,,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 Propostas de Melhorias do Python; 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{8a4,,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{8a5,,Py_IsNone()}, @ref{8a6,,Py_IsTrue()}, @ref{8a7,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-7}@anchor{1a15}
@subsection Python 3.10.0 alpha 7


`Data de lançamento: 2021-04-05'

@menu
* Segurança: Segurança<27>. 
* Núcleo e embutidos: Núcleo e embutidos<93>. 
* Biblioteca: Biblioteca<95>. 
* Núcleo e embutidos: Núcleo e embutidos<94>. 
* Biblioteca: Biblioteca<96>. 
* Documentação: Documentação<34>. 
* Testes: Testes<38>. 
* Construção: Construção<42>. 
* Windows: Windows<36>. 
* IDLE: IDLE<25>. 
* API C: API C<38>. 

@end menu

@node Segurança<27>,Núcleo e embutidos<93>,,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id456}@anchor{1a16}
@subsubsection Segurança



@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{900,,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{806,,gc.get_objects()},
@ref{807,,gc.get_referrers()} and @ref{808,,gc.get_referents()}. Patch by Pablo
Galindo.
@end itemize

@node Núcleo e embutidos<93>,Biblioteca<95>,Segurança<27>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id457}@anchor{1a17}
@subsubsection Núcleo e embutidos



@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.
@end itemize

@node Biblioteca<95>,Núcleo e embutidos<94>,Núcleo e embutidos<93>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id458}@anchor{1a18}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<94>,Biblioteca<96>,Biblioteca<95>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id459}@anchor{1a19}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; 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{18d,,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{be0,,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{11ff,,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 Propostas de Melhorias do Python; 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}.

Coautoria de: 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{1344,,__exit__()} is always called in with statements, even
for interrupts.
@end itemize

@node Biblioteca<96>,Documentação<34>,Núcleo e embutidos<94>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id460}@anchor{1a1a}
@subsubsection Biblioteca



@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{a61,,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{7e2,,index()} method of @ref{1a0,,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{294,,ssl.SSLContext} debug callback
with @ref{1a1b,,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 Propostas de Melhorias do Python; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}: Add @code{EncodingWarning} warning, @code{-X
warn_default_encoding} option, 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variável de ambiente; PYTHONWARNDEFAULTENCODING
@ref{7bd,,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{82b,,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{1a1c,,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{844,,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{1275,,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{1e7,,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{15c5,,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{16f6,,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{1a1d,,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{e82,,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{1a1e,,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{1a1f,,tempfile.gettempdir()} and @ref{1a20,,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{1a21,,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 Documentação<34>,Testes<38>,Biblioteca<96>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id461}@anchor{1a22}
@subsubsection Documentação



@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{253,,time.monotonic()},
@ref{a92,,time.perf_counter()}, @ref{a93,,time.process_time()}, or
@ref{93d,,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 Testes<38>,Construção<42>,Documentação<34>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id462}@anchor{1a23}
@subsubsection Testes



@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 Construção<42>,Windows<36>,Testes<38>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id463}@anchor{1a24}
@subsubsection Construção



@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<36>,IDLE<25>,Construção<42>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id464}@anchor{1a25}
@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<25>,API C<38>,Windows<36>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id465}@anchor{1a26}
@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 API C<38>,,IDLE<25>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id466}@anchor{1a27}
@subsubsection API C



@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{56e,,Py_INCREF()} and @ref{56f,,Py_DECREF()} functions are now implemented
as opaque function calls, rather than accessing directly the
@ref{8a3,,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{339,,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 por 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{8,,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

A função @code{Py_SymtableString()} fazia parte da ABI estável por engano, mas não pôde ser usada, porque o arquivo de cabeçalho @code{symtable.h} foi excluído da API C limitada.

The Python @ref{d8,,symtable} module remains available and is unchanged.

Patch por 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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-6}@anchor{1a28}
@subsection Python 3.10.0 alpha 6


`Data de lançamento: 2021-03-01'

@menu
* Segurança: Segurança<28>. 
* Núcleo e embutidos: Núcleo e embutidos<95>. 
* Biblioteca: Biblioteca<97>. 
* Núcleo e embutidos: Núcleo e embutidos<96>. 
* Biblioteca: Biblioteca<98>. 
* Núcleo e embutidos: Núcleo e embutidos<97>. 
* Biblioteca: Biblioteca<99>. 
* Documentação: Documentação<35>. 
* Testes: Testes<39>. 
* Construção: Construção<43>. 
* Windows: Windows<37>. 
* macOS: macOS<28>. 
* IDLE: IDLE<26>. 
* API C: API C<39>. 

@end menu

@node Segurança<28>,Núcleo e embutidos<95>,,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id467}@anchor{1a29}
@subsubsection Segurança



@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 Núcleo e embutidos<95>,Biblioteca<97>,Segurança<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id468}@anchor{1a2a}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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{8a1,,PySet_CheckExact()} function to the C-API to
check if an object is an instance of @ref{5d9,,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{887,,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{180,,eval()} and @ref{17f,,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{18d,,SyntaxError} message for missing comma
in literals. Patch by Pablo Galindo.
@end itemize

@node Biblioteca<97>,Núcleo e embutidos<96>,Núcleo e embutidos<95>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id469}@anchor{1a2b}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<96>,Biblioteca<98>,Biblioteca<97>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id470}@anchor{1a2c}
@subsubsection Núcleo e embutidos



@itemize -

@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 Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} (structural pattern matching). Patch by
Brandt Bucher.
@end itemize

@node Biblioteca<98>,Núcleo e embutidos<97>,Núcleo e embutidos<96>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id471}@anchor{1a2d}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40692}: In the @ref{8f4,,concurrent.futures.ProcessPoolExecutor},
validate that @code{multiprocess.synchronize()} is available on a given
platform and rely on that check in the @ref{21,,concurrent.futures} test
suite so we can run tests that are unrelated to
@code{ProcessPoolExecutor} on those platforms.
@end itemize

@node Núcleo e embutidos<97>,Biblioteca<99>,Biblioteca<98>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id472}@anchor{1a2e}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-38302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38302}: If @ref{7d2,,object.__ipow__()} returns @ref{7d3,,NotImplemented}, the
operator will correctly fall back to @ref{7d4,,object.__pow__()} and
@ref{7d5,,object.__rpow__()} as expected.
@end itemize

@node Biblioteca<99>,Documentação<35>,Núcleo e embutidos<97>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id473}@anchor{1a2f}
@subsubsection Biblioteca



@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{852,,print_exception()} and
@ref{850,,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{15c5,,MemoryError}. Patch
by Erlend E. Aasland.

@item 
bpo-40956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40956}: Fix segfault in @ref{b92,,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{1a30,,readline.get_begidx()} and @ref{1a31,,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{1c,,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{81d,,O_EVTONLY}, @ref{81e,,O_FSYNC},
@ref{81f,,O_SYMLINK} and @ref{820,,O_NOFOLLOW_ANY} for macOS. Patch by
Donghee Na.

@item 
bpo-42960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42960}: Adds @ref{1a32,,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 Documentação<35>,Testes<39>,Biblioteca<99>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id474}@anchor{1a33}
@subsubsection Documentação



@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 Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} for detail.
@end itemize

@node Testes<39>,Construção<43>,Documentação<35>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id475}@anchor{1a34}
@subsubsection Testes



@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 Construção<43>,Windows<37>,Testes<39>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id476}@anchor{1a35}
@subsubsection Construção



@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<37>,macOS<28>,Construção<43>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id477}@anchor{1a36}
@subsubsection Windows



@itemize -

@item 
bpo-43155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43155}: @ref{1a37,,PyCMethod_New()} is now present in @code{python3.lib}.
@end itemize

@node macOS<28>,IDLE<26>,Windows<37>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id478}@anchor{1a38}
@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<26>,API C<39>,macOS<28>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id479}@anchor{1a39}
@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 API C<39>,,IDLE<26>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id480}@anchor{1a3a}
@subsubsection API C



@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{1a3b,,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{784,,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{784,,Include Files}.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{a6f,,PyExceptionClass_Name()} is now always declared as a
function, in order to hide implementation details. The macro accessed
@ref{1a3c,,PyTypeObject.tp_name} directly.  Patch by Erlend E. Aasland.

@item 
bpo-43239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43239}: The @ref{1a3d,,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{1a3e,,PyIter_Check()} is now always declared as a function, in
order to hide implementation details. The macro accessed
@ref{1538,,PyTypeObject.tp_iternext} directly. Patch by Erlend E. Aasland.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert @ref{1a3f,,PyDescr_IsData()} macro to a function to hide
implementation details: The macro accessed
@ref{1a40,,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{1a41,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-5}@anchor{1a42}
@subsection Python 3.10.0 alpha 5


`Data de lançamento: 2021-02-02'

@menu
* Segurança: Segurança<29>. 
* Núcleo e embutidos: Núcleo e embutidos<98>. 
* Biblioteca: Biblioteca<100>. 
* Núcleo e embutidos: Núcleo e embutidos<99>. 
* Biblioteca: Biblioteca<101>. 
* Documentação: Documentação<36>. 
* Testes: Testes<40>. 
* Construção: Construção<44>. 
* Windows: Windows<38>. 
* macOS: macOS<29>. 
* IDLE: IDLE<27>. 
* API C: API C<40>. 

@end menu

@node Segurança<29>,Núcleo e embutidos<98>,,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id481}@anchor{1a43}
@subsubsection Segurança



@itemize -

@item 
bpo-42938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42938}: Avoid static buffers when computing the repr of
@ref{1a44,,ctypes.c_double} and @ref{1a45,,ctypes.c_longdouble} values.
@end itemize

@node Núcleo e embutidos<98>,Biblioteca<100>,Segurança<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id482}@anchor{1a46}
@subsubsection Núcleo e embutidos



@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{98a,,Py_FatalError()} calls in the compiler with
regular @ref{575,,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{8b1,,Py_Initialize()} /
@ref{13a0,,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{18d,,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
@end itemize

@node Biblioteca<100>,Núcleo e embutidos<99>,Núcleo e embutidos<98>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id483}@anchor{1a47}
@subsubsection Biblioteca



@itemize -

@item 
bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324}: Remove deprecated aliases to
@ref{87c,,Classes Base Abstratas de Coleções} from the @ref{1d,,collections}
module.
@end itemize

@node Núcleo e embutidos<99>,Biblioteca<101>,Biblioteca<100>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id484}@anchor{1a48}
@subsubsection Núcleo e embutidos



@itemize -

@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 Biblioteca<101>,Documentação<36>,Núcleo e embutidos<99>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id485}@anchor{1a49}
@subsubsection Biblioteca



@itemize -

@item 
bpo-43108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43108}: Fixed a reference leak in the @ref{2b,,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{498,,math.nextafter()} for NaN on AIX.

@item 
bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955}: Add @ref{844,,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{25c,,TracebackException}’s new @code{compact}
param in @ref{11a6,,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{25c,,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{98a,,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{25c,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{27,,cProfile} and @ref{af,,profile} to catch
@ref{1095,,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{2b,,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 Documentação<36>,Testes<40>,Biblioteca<101>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id486}@anchor{1a4a}
@subsubsection Documentação



@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 Testes<40>,Construção<44>,Documentação<36>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id487}@anchor{1a4b}
@subsubsection Testes



@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 Construção<44>,Windows<38>,Testes<40>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id488}@anchor{1a4c}
@subsubsection Construção



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

Algumas distribuições Linux possuem políticas de empacotamento recomendando evitar o empacotamento de dependências. Por exemplo, Fedora instala pacotes wheel no diretório @code{/usr/share/python-wheels/} e não instala o pacote @code{ensurepip._bundled}.
@end itemize

@node Windows<38>,macOS<29>,Construção<44>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id489}@anchor{1a4d}
@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<29>,IDLE<27>,Windows<38>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id490}@anchor{1a4e}
@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<27>,API C<40>,macOS<29>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id491}@anchor{1a4f}
@subsubsection IDLE



@itemize -

@item 
bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}: Make IDLE invoke @ref{80e,,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 API C<40>,,IDLE<27>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id492}@anchor{1a50}
@subsubsection API C



@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{1a51,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-4}@anchor{1a52}
@subsection Python 3.10.0 alpha 4


`Data de lançamento: 2021-01-04'

@menu
* Núcleo e embutidos: Núcleo e embutidos<100>. 
* Biblioteca: Biblioteca<102>. 
* Núcleo e embutidos: Núcleo e embutidos<101>. 
* Biblioteca: Biblioteca<103>. 
* Núcleo e embutidos: Núcleo e embutidos<102>. 
* Biblioteca: Biblioteca<104>. 
* Documentação: Documentação<37>. 
* Testes: Testes<41>. 
* Construção: Construção<45>. 
* macOS: macOS<30>. 
* Ferramentas/Demos: Ferramentas/Demos<21>. 
* API C: API C<41>. 

@end menu

@node Núcleo e embutidos<100>,Biblioteca<102>,,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id493}@anchor{1a53}
@subsubsection Núcleo e embutidos



@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{8,,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{5e0,,-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
@end itemize

@node Biblioteca<102>,Núcleo e embutidos<101>,Núcleo e embutidos<100>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id494}@anchor{1a54}
@subsubsection Biblioteca



@itemize -

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: Make the @ref{c,,atexit} module state per-interpreter. It is now
safe have more than one @ref{c,,atexit} module instance. Patch by Donghee Na
and Victor Stinner.
@end itemize

@node Núcleo e embutidos<101>,Biblioteca<103>,Biblioteca<102>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id495}@anchor{1a55}
@subsubsection Núcleo e embutidos



@itemize -

@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{1a56,,PyRun_SimpleFileExFlags()} now uses the correct encoding to
decode the filename.
@end itemize

@node Biblioteca<103>,Núcleo e embutidos<102>,Núcleo e embutidos<101>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id496}@anchor{1a57}
@subsubsection Biblioteca



@itemize -

@item 
bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}: The @code{__args__} of the parameterized generics for
@ref{7c6,,typing.Callable} and @ref{7ec,,collections.abc.Callable} are now
consistent.  The @code{__args__} for @ref{7ec,,collections.abc.Callable} are
now flattened while @ref{7c6,,typing.Callable}’s have not changed.  To allow
this change, @ref{7ed,,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 Propostas de Melhorias do Python; 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{551,,PyType_FromModuleAndSpec()}.

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{7,,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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<102>,Biblioteca<104>,Biblioteca<103>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id497}@anchor{1a58}
@subsubsection Núcleo e embutidos



@itemize -

@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 Biblioteca<104>,Documentação<37>,Núcleo e embutidos<102>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id498}@anchor{1a59}
@subsubsection Biblioteca



@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{1a5a,,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{2ed,,typing.get_args()} and @ref{2ec,,typing.get_origin()} now
support 
@geindex Propostas de Melhorias do Python; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} union types and 
@geindex Propostas de Melhorias do Python; 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{1a5b,,collections.deque.remove()}.

@item 
bpo-35728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35728}: Added a root parameter to @ref{1a5c,,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{2b,,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{1a5d,,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 Propostas de Melhorias do Python; 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{195,,RuntimeError} with descriptive message instead
of obscure @ref{34b,,AttributeError} or @ref{43f,,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{1f7,,sys.unraisablehook}, rather than logging them directly into
@ref{940,,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{882,,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 Propostas de Melhorias do Python; 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{c32,,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{746,,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{885,,OverflowError} instead of silent truncation in
@ref{884,,socket.ntohs()} and @ref{883,,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{86f,,random.randrange()} argument handling to match
@ref{94a,,range()}.


@itemize *

@item 
The integer test and conversion in @code{randrange()} now uses
@ref{1a5e,,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 Propostas de Melhorias do Python; 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{162,,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{738,,inspect.signature()} and @ref{73a,,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{e67,,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{e,,base64}. Patch by Brandon Stansbury.
@end itemize

@node Documentação<37>,Testes<41>,Biblioteca<104>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id499}@anchor{1a5f}
@subsubsection Documentação



@itemize -

@item 
bpo-17140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17140}: Add documentation for the
@ref{1a60,,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 Testes<41>,Construção<45>,Documentação<37>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id500}@anchor{1a61}
@subsubsection Testes



@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 Construção<45>,macOS<30>,Testes<41>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id501}@anchor{1a62}
@subsubsection Construção



@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<30>,Ferramentas/Demos<21>,Construção<45>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id502}@anchor{1a63}
@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 Ferramentas/Demos<21>,API C<41>,macOS<30>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id503}@anchor{1a64}
@subsubsection Ferramentas/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 API C<41>,,Ferramentas/Demos<21>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id504}@anchor{1a65}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-3}@anchor{1a66}
@subsection Python 3.10.0 alpha 3


`Data de lançamento: 2020-12-07'

@menu
* Segurança: Segurança<30>. 
* Núcleo e embutidos: Núcleo e embutidos<103>. 
* Biblioteca: Biblioteca<105>. 
* Núcleo e embutidos: Núcleo e embutidos<104>. 
* Biblioteca: Biblioteca<106>. 
* Núcleo e embutidos: Núcleo e embutidos<105>. 
* Biblioteca: Biblioteca<107>. 
* Núcleo e embutidos: Núcleo e embutidos<106>. 
* Biblioteca: Biblioteca<108>. 
* Documentação: Documentação<38>. 
* Testes: Testes<42>. 
* Construção: Construção<46>. 
* Windows: Windows<39>. 
* macOS: macOS<31>. 
* IDLE: IDLE<28>. 
* Ferramentas/Demos: Ferramentas/Demos<22>. 
* API C: API C<42>. 

@end menu

@node Segurança<30>,Núcleo e embutidos<103>,,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id505}@anchor{1a67}
@subsubsection Segurança



@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 Núcleo e embutidos<103>,Biblioteca<105>,Segurança<30>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id506}@anchor{1a68}
@subsubsection Núcleo e embutidos



@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{1a69,,garbage collector}:


@itemize -

@item 
@ref{5db,,collections.OrderedDict.items()}

@item 
@ref{7d0,,dict.items()}

@item 
@ref{14c9,,enumerate()}

@item 
@ref{131f,,functools.reduce()}

@item 
@ref{1356,,itertools.combinations()}

@item 
@ref{12c3,,itertools.combinations_with_replacement()}

@item 
@ref{1a6a,,itertools.permutations()}

@item 
@ref{1357,,itertools.product()}

@item 
@ref{12e0,,itertools.zip_longest()}

@item 
@ref{7d1,,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{5e3,,-b} is specified. Speed up comparison of bytarray
objects with non-buffer object.
@end itemize

@node Biblioteca<105>,Núcleo e embutidos<104>,Núcleo e embutidos<103>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id507}@anchor{1a6b}
@subsubsection Biblioteca



@itemize -

@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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}). Patch by Victor Stinner.
@end itemize

@node Núcleo e embutidos<104>,Biblioteca<106>,Biblioteca<105>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id508}@anchor{1a6c}
@subsubsection Núcleo e embutidos



@itemize -

@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{8c3,,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{7ed,,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.
@end itemize

@node Biblioteca<106>,Núcleo e embutidos<105>,Núcleo e embutidos<104>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id509}@anchor{1a6d}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{b6,,queue} to use heap types.
@end itemize

@node Núcleo e embutidos<105>,Biblioteca<107>,Biblioteca<106>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id510}@anchor{1a6e}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<107>,Núcleo e embutidos<106>,Núcleo e embutidos<105>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id511}@anchor{1a6f}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @ref{90,,mmap} to use heap types.
@end itemize

@node Núcleo e embutidos<106>,Biblioteca<108>,Biblioteca<107>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id512}@anchor{1a70}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}: Allow @code{GenericAlias} objects to use @ref{7c3,,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 Biblioteca<108>,Documentação<38>,Núcleo e embutidos<106>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id513}@anchor{1a71}
@subsubsection Biblioteca



@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{417,,OSError} instead of
@ref{157e,,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{15f8,,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{25c,,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{829,,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{f73,,filecmp.dircmp} respect subclassing. Now the
@ref{1a72,,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{837,,socket.timeout} is now an alias of
@ref{838,,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{8da,,__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 Propostas de Melhorias do Python; 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{254,,time.time()}, @ref{a92,,time.perf_counter()} and
@ref{253,,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{1a73,,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{a92,,time.perf_counter()} on Windows and @ref{253,,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{af7,,time.perf_counter_ns()} and @ref{af6,,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{953,,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{84d,,threading.__excepthook__} to allow retrieving the
original value of @ref{84e,,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{44c,,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{849,,threading.gettrace()} and
@ref{84a,,threading.getprofile()} to retrieve the functions set by
@ref{84b,,threading.settrace()} and @ref{84c,,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{19c0,,os.device_encoding()} function now returns
@code{'UTF-8'} rather than the device encoding if the @ref{656,,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{850,,traceback.format_exception()},
@ref{851,,traceback.format_exception_only()}, and
@ref{852,,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{1a74,,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{81c,,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{1a75,,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{823,,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{81b,,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{823,,pathlib.PurePath.parents}.
@end itemize

@node Documentação<38>,Testes<42>,Biblioteca<108>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id514}@anchor{1a76}
@subsubsection Documentação



@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 Testes<42>,Construção<46>,Documentação<38>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id515}@anchor{1a77}
@subsubsection Testes



@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 Construção<46>,Windows<39>,Testes<42>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id516}@anchor{1a78}
@subsubsection Construção



@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<39>,macOS<31>,Construção<46>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id517}@anchor{1a79}
@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<31>,IDLE<28>,Windows<39>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id518}@anchor{1a7a}
@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<28>,Ferramentas/Demos<22>,macOS<31>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id519}@anchor{1a7b}
@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 Ferramentas/Demos<22>,API C<42>,IDLE<28>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id520}@anchor{1a7c}
@subsubsection Ferramentas/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 API C<42>,,Ferramentas/Demos<22>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id521}@anchor{1a7d}
@subsubsection API C



@itemize -

@item 
bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423}: The @ref{57e,,PyType_FromSpecWithBases()} and
@ref{551,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{780,,Py_TYPE()} and @ref{782,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{8c3,,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{3b3,,Py_GetPath()}, @ref{3b5,,Py_GetPrefix()},
@ref{3b1,,Py_GetExecPrefix()}, @ref{3b7,,Py_GetProgramFullPath()},
@ref{3ba,,Py_GetPythonHome()} and @ref{3b9,,Py_GetProgramName()} functions now
return @code{NULL} if called before @ref{8b1,,Py_Initialize()} (before Python is
initialized). Use the new @ref{3a7,,Python Initialization Configuration API} to get the @ref{8b2,,Python Path Configuration.}. Patch by Victor Stinner.

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: The @ref{790,,PyConfig_Read()} function now only parses
@ref{3c3,,PyConfig.argv} arguments once: @ref{1a7e,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
strippped from @ref{3c3,,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{89e,,Py_NewRef()} and @ref{89f,,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{8b1,,Py_Initialize()} is called twice, the second call
now updates more @ref{d9,,sys} attributes for the configuration, rather than
only @ref{12a6,,sys.argv}. Patch by Victor Stinner.

@item 
bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832}: The @ref{551,,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{365,,PyModule_AddObjectRef()} function: similar to
@ref{366,,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{1713,,METH_FASTCALL} calling convention is added to the
limited API. The functions  @ref{97c,,PyModule_AddType()},
@ref{551,,PyType_FromModuleAndSpec()}, @ref{975,,PyType_GetModule()} and
@ref{976,,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{8a0,,PyType_GetSlot()} can now accept static types.

@item 
bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459}: @ref{38e,,PyList_SET_ITEM()}, @ref{38d,,PyTuple_SET_ITEM()} and
@ref{8b3,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-2}@anchor{1a7f}
@subsection Python 3.10.0 alpha 2


`Data de lançamento: 2020-11-03'

@menu
* Segurança: Segurança<31>. 
* Núcleo e embutidos: Núcleo e embutidos<107>. 
* Biblioteca: Biblioteca<109>. 
* Núcleo e embutidos: Núcleo e embutidos<108>. 
* Biblioteca: Biblioteca<110>. 
* Documentação: Documentação<39>. 
* Testes: Testes<43>. 
* Construção: Construção<47>. 
* Windows: Windows<40>. 
* macOS: macOS<32>. 
* IDLE: IDLE<29>. 
* API C: API C<43>. 

@end menu

@node Segurança<31>,Núcleo e embutidos<107>,,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id522}@anchor{1a80}
@subsubsection Segurança



@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 Núcleo e embutidos<107>,Biblioteca<109>,Segurança<31>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id523}@anchor{1a81}
@subsubsection Núcleo e embutidos



@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{8,,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{18d,,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{2f8,,complex} class.  They
always raised a @ref{2c3,,TypeError}.

@item 
bpo-41902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41902}: Micro optimization when compute
@ref{1a82,,sq_item} and
@ref{1a83,,mp_subscript} of @ref{94a,,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.
@end itemize

@node Biblioteca<109>,Núcleo e embutidos<108>,Núcleo e embutidos<107>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id524}@anchor{1a84}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<108>,Biblioteca<110>,Biblioteca<109>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id525}@anchor{1a85}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-38605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38605}: Enable @code{from __future__ import annotations} (
@geindex Propostas de Melhorias do Python; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}) by
default. The values found in @code{__annotations__} dicts are now
strings, for example @code{@{"x": "int"@}} instead of @code{@{"x": int@}}.
@end itemize

@node Biblioteca<110>,Documentação<39>,Núcleo e embutidos<108>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id526}@anchor{1a86}
@subsubsection Biblioteca



@itemize -

@item 
bpo-35455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35455}: On Solaris, @ref{93d,,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{800,,repr()} of @ref{104,,typing} types containing
@ref{6b2,,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{19de,,logging.FileHandler} class now keeps a reference to
the builtin @ref{51c,,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 Propostas de Melhorias do Python; 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{199,,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}: @ref{1a87,,InvalidFileException} and @ref{d90,,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{1ce,,datetime.time} subclasses.
Patch by Dean Inwood.

@item 
bpo-19270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19270}: @ref{1a88,,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{150f,,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{199,,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{d6c,,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 Propostas de Melhorias do Python; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}, introducing @ref{7ca,,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}: @ref{7fe,,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{1cb,,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{4b4,,shutil.which()} now ignores empty entries in
@geindex PATHEXT
@geindex variável de ambiente; 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{27,,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{831,,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 Documentação<39>,Testes<43>,Biblioteca<110>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id527}@anchor{1a89}
@subsubsection Documentação



@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{1a8a,,classes} and @ref{1a8b,,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{6b2,,generic alias type} and
@ref{7ed,,types.GenericAlias}. Also added an entry in glossary for
@ref{439,,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 Testes<43>,Construção<47>,Documentação<39>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id528}@anchor{1a8c}
@subsubsection Testes



@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 Construção<47>,Windows<40>,Testes<43>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id529}@anchor{1a8d}
@subsubsection Construção



@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<40>,macOS<32>,Construção<47>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id530}@anchor{1a8e}
@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<32>,IDLE<29>,Windows<40>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id531}@anchor{1a8f}
@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<29>,API C<43>,macOS<32>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id532}@anchor{1a90}
@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 API C<43>,,IDLE<29>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id533}@anchor{1a91}
@subsubsection API C



@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{151f,,PyMethodDef}’s lifetime is managed through
the @code{self} argument of a @ref{14c0,,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{1a92,,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,Changelog
@anchor{whatsnew/changelog python-3-10-0-alpha-1}@anchor{1a93}
@subsection Python 3.10.0 alpha 1


`Data de lançamento: 2020-10-05'

@menu
* Segurança: Segurança<32>. 
* Núcleo e embutidos: Núcleo e embutidos<109>. 
* Biblioteca: Biblioteca<111>. 
* Núcleo e embutidos: Núcleo e embutidos<110>. 
* Biblioteca: Biblioteca<112>. 
* Núcleo e embutidos: Núcleo e embutidos<111>. 
* Biblioteca: Biblioteca<113>. 
* Núcleo e embutidos: Núcleo e embutidos<112>. 
* Biblioteca: Biblioteca<114>. 
* Núcleo e embutidos: Núcleo e embutidos<113>. 
* Biblioteca: Biblioteca<115>. 
* Núcleo e embutidos: Núcleo e embutidos<114>. 
* Biblioteca: Biblioteca<116>. 
* Núcleo e embutidos: Núcleo e embutidos<115>. 
* Biblioteca: Biblioteca<117>. 
* Núcleo e embutidos: Núcleo e embutidos<116>. 
* Biblioteca: Biblioteca<118>. 
* Núcleo e embutidos: Núcleo e embutidos<117>. 
* Biblioteca: Biblioteca<119>. 
* Núcleo e embutidos: Núcleo e embutidos<118>. 
* Biblioteca: Biblioteca<120>. 
* Núcleo e embutidos: Núcleo e embutidos<119>. 
* Biblioteca: Biblioteca<121>. 
* Núcleo e embutidos: Núcleo e embutidos<120>. 
* Biblioteca: Biblioteca<122>. 
* Núcleo e embutidos: Núcleo e embutidos<121>. 
* Biblioteca: Biblioteca<123>. 
* Núcleo e embutidos: Núcleo e embutidos<122>. 
* Biblioteca: Biblioteca<124>. 
* Núcleo e embutidos: Núcleo e embutidos<123>. 
* Biblioteca: Biblioteca<125>. 
* Documentação: Documentação<40>. 
* Testes: Testes<44>. 
* Construção: Construção<48>. 
* Windows: Windows<41>. 
* macOS: macOS<33>. 
* IDLE: IDLE<30>. 
* API C: API C<44>. 

@end menu

@node Segurança<32>,Núcleo e embutidos<109>,,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id534}@anchor{1a94}
@subsubsection Segurança



@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 Núcleo e embutidos<109>,Biblioteca<111>,Segurança<32>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id535}@anchor{1a95}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-41909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41909}: Fixed stack overflow in @ref{7c2,,issubclass()} and
@ref{442,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Donghee Na.
@end itemize

@node Biblioteca<111>,Núcleo e embutidos<110>,Núcleo e embutidos<109>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id536}@anchor{1a96}
@subsubsection Biblioteca



@itemize -

@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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<110>,Biblioteca<112>,Biblioteca<111>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id537}@anchor{1a97}
@subsubsection Núcleo e embutidos



@itemize -

@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{7ed,,types.GenericAlias}. Patch by
Batuhan Taskaya.
@end itemize

@node Biblioteca<112>,Núcleo e embutidos<111>,Núcleo e embutidos<110>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id538}@anchor{1a98}
@subsubsection Biblioteca



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_lsprof} extension module to multi-phase
initialization (
@geindex Propostas de Melhorias do Python; 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{18,,cmath} extension module to multi-phase
initialization (
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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.
@end itemize

@node Núcleo e embutidos<111>,Biblioteca<113>,Biblioteca<112>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id539}@anchor{1a99}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<113>,Núcleo e embutidos<112>,Núcleo e embutidos<111>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id540}@anchor{1a9a}
@subsubsection Biblioteca



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @code{_overlapped} extension module to multi-phase
initialization (
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<112>,Biblioteca<114>,Biblioteca<113>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id541}@anchor{1a9b}
@subsubsection Núcleo e embutidos



@itemize -

@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{621,,str.format()}.
@end itemize

@node Biblioteca<114>,Núcleo e embutidos<113>,Núcleo e embutidos<112>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id542}@anchor{1a9c}
@subsubsection Biblioteca



@itemize -

@item 
bpo-41675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41675}: The implementation of @ref{1174,,signal.siginterrupt()} now uses
@code{sigaction()} (if it is available in the system) instead of the
deprecated @code{siginterrupt()}. Patch by Pablo Galindo.
@end itemize

@node Núcleo e embutidos<113>,Biblioteca<115>,Biblioteca<114>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id543}@anchor{1a9d}
@subsubsection Núcleo e embutidos



@itemize -

@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{15c5,,MemoryError}. Patch by Pablo Galindo.
@end itemize

@node Biblioteca<115>,Núcleo e embutidos<114>,Núcleo e embutidos<113>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id544}@anchor{1a9e}
@subsubsection Biblioteca



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port the @ref{133,,zlib} extension module to multi-phase
initialization (
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<114>,Biblioteca<116>,Biblioteca<115>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id545}@anchor{1a9f}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<116>,Núcleo e embutidos<115>,Núcleo e embutidos<114>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id546}@anchor{1aa0}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @code{_operator} to use @ref{57d,,PyType_FromSpec()}.
@end itemize

@node Núcleo e embutidos<115>,Biblioteca<117>,Biblioteca<116>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id547}@anchor{1aa1}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<117>,Núcleo e embutidos<116>,Núcleo e embutidos<115>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id548}@anchor{1aa2}
@subsubsection Biblioteca



@itemize -

@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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<116>,Biblioteca<118>,Biblioteca<117>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id549}@anchor{1aa3}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<118>,Núcleo e embutidos<117>,Núcleo e embutidos<116>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id550}@anchor{1aa4}
@subsubsection Biblioteca



@itemize -

@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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}).
@end itemize

@node Núcleo e embutidos<117>,Biblioteca<119>,Biblioteca<118>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id551}@anchor{1aa5}
@subsubsection Núcleo e embutidos



@itemize -

@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{131d,,round()} with integer argument is now faster (9–60%).

@item 
bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334}: Constructors @ref{44c,,str()}, @ref{1c2,,bytes()} and @ref{2ea,,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
@end itemize

@node Biblioteca<119>,Núcleo e embutidos<118>,Núcleo e embutidos<117>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id552}@anchor{1aa6}
@subsubsection Biblioteca



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: Port @code{winapi} to multiphase initialization
@end itemize

@node Núcleo e embutidos<118>,Biblioteca<120>,Biblioteca<119>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id553}@anchor{1aa7}
@subsubsection Núcleo e embutidos



@itemize -

@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.
@end itemize

@node Biblioteca<120>,Núcleo e embutidos<119>,Núcleo e embutidos<118>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id554}@anchor{1aa8}
@subsubsection Biblioteca



@itemize -

@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
@end itemize

@node Núcleo e embutidos<119>,Biblioteca<121>,Biblioteca<120>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id555}@anchor{1aa9}
@subsubsection Núcleo e embutidos



@itemize -

@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{18d,,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.
@end itemize

@node Biblioteca<121>,Núcleo e embutidos<120>,Núcleo e embutidos<119>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id556}@anchor{1aaa}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: Convert @code{_bz2} to use @ref{57d,,PyType_FromSpec()}.
@end itemize

@node Núcleo e embutidos<120>,Biblioteca<122>,Biblioteca<121>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id557}@anchor{1aab}
@subsubsection Núcleo e embutidos



@itemize -

@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{7d1,,zip()} now supports 
@geindex Propostas de Melhorias do Python; PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}’s @code{strict} parameter,
which raises a @ref{202,,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{18d,,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
@end itemize

@node Biblioteca<122>,Núcleo e embutidos<121>,Núcleo e embutidos<120>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id558}@anchor{1aac}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40950}: Add a state to the @code{nis} module (
@geindex Propostas de Melhorias do Python; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}) and apply
the multiphase initialization. Patch by Donghee Na.
@end itemize

@node Núcleo e embutidos<121>,Biblioteca<123>,Biblioteca<122>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id559}@anchor{1aad}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-40947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40947}: The Python @ref{8b2,,Path Configuration} now
takes @ref{1aae,,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{18d,,SyntaxError} for valid
input due to this. For example, an empty line following a line
continuation character was interpreted as a @ref{18d,,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{46d,,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{202,,ValueError} when validating custom AST’s where the
constants @code{True}, @code{False} and @code{None} are used within a
@ref{1aaf,,ast.Name} node.

@item 
bpo-40854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40854}: Allow overriding @ref{93f,,sys.platlibdir} via a new
@geindex PYTHONPLATLIBDIR
@geindex variável de ambiente; PYTHONPLATLIBDIR
@ref{1ab0,,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{2f4,,in} operator and functions
@ref{8e0,,contains()}, @ref{8e1,,indexOf()} and
@ref{8e2,,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{94a,,range} object now always has exact type @ref{257,,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{18d,,SyntaxError} in the expression part of an
fstring, the filename attribute of the @ref{18d,,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{57e,,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{780,,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{4f8,,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{2c3,,TypeError} messages about missing or extra
arguments now include the function’s @ref{1ab1,,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{4f8,,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.
@end itemize

@node Biblioteca<123>,Núcleo e embutidos<122>,Núcleo e embutidos<121>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id560}@anchor{1ab2}
@subsubsection Biblioteca



@itemize -

@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.
@end itemize

@node Núcleo e embutidos<122>,Biblioteca<124>,Biblioteca<123>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id561}@anchor{1ab3}
@subsubsection Núcleo e embutidos



@itemize -

@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{29d,,Decimal}s, @ref{1e7,,Fraction}s and other objects that can be converted to integers only with a loss
(e.g. that have the @ref{71c,,__int__()} method but do not have the
@ref{71d,,__index__()} method).

@item 
bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882}: Add @ref{7cd,,int.bit_count()}, counting the number of ones in the
binary representation of an integer. Patch by Niklas Fiekas.
@end itemize

@node Biblioteca<124>,Núcleo e embutidos<123>,Núcleo e embutidos<122>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id562}@anchor{1ab4}
@subsubsection Biblioteca



@itemize -

@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{7f7,,curses.has_extended_color_support()} to indicate whether extended
color support is provided by the underlying ncurses library.
@end itemize

@node Núcleo e embutidos<123>,Biblioteca<125>,Biblioteca<124>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id563}@anchor{1ab5}
@subsubsection Núcleo e embutidos



@itemize -

@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 Biblioteca<125>,Documentação<40>,Núcleo e embutidos<123>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id564}@anchor{1ab6}
@subsubsection Biblioteca



@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{c32,,ast.literal_eval()}. Also
document stripping of spaces and tabs for @ref{180,,eval()}.

@item 
bpo-41773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41773}: Note in documentation that @ref{ce6,,random.choices()} doesn’t
support non-finite weights, raise @ref{202,,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{7ea,,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{1510,,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{953,,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{854,,types.EllipsisType}, @ref{856,,types.NotImplementedType}
and @ref{855,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{1ac,,iterator} to @ref{2eb,,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{47c,,asyncio.run()}. This allows
setting @code{PYTHONASYNCIODEBUG} or @code{-X dev} to enable asyncio debug mode
when using @ref{47c,,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{4f2,,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{4f2,,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{5ff,,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{5ff,,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{1c,,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{1095,,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{1c5,,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{1181,,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{1a0,,array.array} as a
@ref{1a1,,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{15d7,,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{417,,OSError} to ignore error if the filesystem
is read-only, instead of only ignoring @ref{42b,,FileNotFoundError} and
@ref{d65,,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{131f,,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{1ab7,,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{29f,,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{8e5,,zoneinfo.ZoneInfo} from being subclassed.

@item 
bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018}: Add the @ref{85f,,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{843,,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{14df,,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{29,,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{1ab8,,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{486,,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{1a5e,,operator.index()} now always has exact type
@ref{257,,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{2a,,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{1ab9,,PyErr_Print()}.

@item 
bpo-16995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16995}: Add @ref{7e5,,base64.b32hexencode()} and @ref{7e6,,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{1aba,,os.RWF_APPEND} flag for @ref{b76,,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{1895,,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{1abb,,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{1a8,,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{184b,,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{184b,,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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} and use
@ref{97c,,PyModule_AddType()}.

@item 
bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309}: Added a new @ref{491,,coroutine} @ref{8ee,,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{8ef,,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{1abc,,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{1368,,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{29f,,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{487,,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{2c3,,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{11a3,,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{87b,,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 Documentação<40>,Testes<44>,Biblioteca<125>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id565}@anchor{1abd}
@subsubsection Documentação



@itemize -

@item 
bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}: Add documentation for 
@geindex Propostas de Melhorias do Python; 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{1abe,,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 Testes<44>,Construção<48>,Documentação<40>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id566}@anchor{1abf}
@subsubsection Testes



@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{1ac0,,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{7e2,,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{1ac1,,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 Construção<48>,Windows<41>,Testes<44>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id567}@anchor{1ac2}
@subsubsection Construção



@itemize -

@item 
bpo-38249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38249}: Update @ref{bcd,,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{134,,zoneinfo} module and its tests
were not included when Python is installed with @code{make}.
@end itemize

@node Windows<41>,macOS<33>,Construção<48>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id568}@anchor{1ac3}
@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<33>,IDLE<30>,Windows<41>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id569}@anchor{1ac4}
@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<30>,API C<44>,macOS<33>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id570}@anchor{1ac5}
@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 API C<44>,,IDLE<30>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id571}@anchor{1ac6}
@subsubsection API C



@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{8c2,,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{8b6,,PyUnicode_InternInPlace()}
instead. Patch by Victor Stinner.

@item 
bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}: Add @ref{89b,,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{8c2,,PyInterpreterState}
structure. Patch by Victor Stinner.

@item 
bpo-41689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41689}: Types created with @ref{57d,,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 @ref{1ac7,,PyOS_mystrnicmp()} and
@ref{1ac8,,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{899,,PyDateTime_DATE_GET_TZINFO()} and
@ref{89a,,PyDateTime_TIME_GET_TZINFO()} macros for accessing the @code{tzinfo}
attributes of @ref{1cc,,datetime.datetime} and @ref{1ce,,datetime.time}
objects.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Revert @ref{1ac9,,PyType_HasFeature()} change: it reads again
directly the @ref{19fd,,PyTypeObject.tp_flags} member when the limited C
API is not used, rather than always calling @ref{1aca,,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{399,,PyObject_GetBuffer()} and @ref{39a,,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 @ref{1acb,,PyObject_INIT()} and @ref{1acc,,PyObject_INIT_VAR()}
macros become aliases to, respectively, @ref{a74,,PyObject_Init()} and
@ref{1acd,,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{571,,PyArg_ParseTuple()} and @ref{8ac,,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{8ad,,Parsing arguments and building values} and
the 
@geindex Propostas de Melhorias do Python; 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{1ace,,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{387,,PyDict_GetItem()} without @ref{159,,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}: @ref{1acf,,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{897,,PyNumber_Index()} now always has exact
type @ref{257,,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{8ae,,Py_REFCNT()} and @ref{782,,Py_SIZE()} macros to
static inline functions. They cannot be used as l-value anymore: use
@ref{8af,,Py_SET_REFCNT()} and @ref{783,,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{339,,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,Changelog
@anchor{whatsnew/changelog python-3-9-0-beta-1}@anchor{1ad0}
@subsection Python 3.9.0 beta 1


`Data de lançamento: 2020-05-19'

@menu
* Segurança: Segurança<33>. 
* Núcleo e embutidos: Núcleo e embutidos<124>. 
* Biblioteca: Biblioteca<126>. 
* Documentação: Documentação<41>. 
* Testes: Testes<45>. 
* Construção: Construção<49>. 
* Windows: Windows<42>. 
* macOS: macOS<34>. 
* Ferramentas/Demos: Ferramentas/Demos<23>. 
* API C: API C<45>. 

@end menu

@node Segurança<33>,Núcleo e embutidos<124>,,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id572}@anchor{1ad1}
@subsubsection Segurança



@itemize -

@item 
bpo-40501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40501}: @ref{110,,uuid} no longer uses @ref{2a,,ctypes} to load
@code{libuuid} or @code{rpcrt4.dll} at runtime.
@end itemize

@node Núcleo e embutidos<124>,Biblioteca<126>,Segurança<33>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id573}@anchor{1ad2}
@subsubsection Núcleo e embutidos



@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{1ad3,,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{18dd,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{5eb,,hash()} and @ref{869,,reversed()} to
@ref{a5b,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{4f8,,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{949,,PyLong_FromDouble()} for values
that fit into long.
@end itemize

@node Biblioteca<126>,Documentação<41>,Núcleo e embutidos<124>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id574}@anchor{1ad4}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40662}: Fixed @ref{9e0,,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{11,,bisect} to use Argument Clinic.

@item 
bpo-40536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40536}: Added the @ref{1ad5,,available_timezones()} function to the
@ref{134,,zoneinfo} module. Patch by Paul Ganssle.

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: The @ref{b51,,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{a02,,inspect.getdoc()}.

@item 
bpo-40607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40607}: When cancelling a task due to timeout, @ref{5ff,,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 Propostas de Melhorias do Python; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}, the @ref{134,,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{1be,,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{9f7,,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{1be,,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{20,,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{c32,,ast.literal_eval()} in the
presence of malformed @ref{1ad6,,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{1ad7,,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{d33,,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{33,,dbm.gnu} to use gdbm_count if possible when
calling @ref{62e,,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{1ad8,,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{21,,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{91b,,close()} method to
the @ref{91a,,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{ebe,,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{90d,,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{46d,,types.MappingProxyType} is now reversible.

@item 
bpo-39075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39075}: The repr for @ref{1d1,,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{93d,,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{1cd,,datetime.date} and
@ref{1cc,,datetime.datetime} now return a @ref{64e,,named tuple} instead of a
@ref{370,,tuple}.
@end itemize

@node Documentação<41>,Testes<45>,Biblioteca<126>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id575}@anchor{1ad9}
@subsubsection Documentação



@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{47f,,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{d33,,pickle.loads()} in the docs
@end itemize

@node Testes<45>,Construção<49>,Documentação<41>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id576}@anchor{1ada}
@subsubsection Testes



@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 Construção<49>,Windows<42>,Testes<45>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id577}@anchor{1adb}
@subsubsection Construção



@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<42>,macOS<34>,Construção<49>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id578}@anchor{1adc}
@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{a,,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<34>,Ferramentas/Demos<23>,Windows<42>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id579}@anchor{1add}
@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 Ferramentas/Demos<23>,API C<45>,macOS<34>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id580}@anchor{1ade}
@subsubsection Ferramentas/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 API C<45>,,Ferramentas/Demos<23>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id581}@anchor{1adf}
@subsubsection API C



@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{78e,,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{995,,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{786,,PyFrame_GetBack()} function: get the frame next
outer frame.

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: New @ref{78a,,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{57e,,PyType_FromSpecWithBases()} will visit its class object when
traversing references in the garbage collector (implemented as an
extension of the provided @ref{77e,,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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-6}@anchor{1ae0}
@subsection Python 3.9.0 alpha 6


`Data de lançamento: 2020-04-27'

@menu
* Segurança: Segurança<34>. 
* Núcleo e embutidos: Núcleo e embutidos<125>. 
* Biblioteca: Biblioteca<127>. 
* Documentação: Documentação<42>. 
* Testes: Testes<46>. 
* Construção: Construção<50>. 
* Windows: Windows<43>. 
* macOS: macOS<35>. 
* IDLE: IDLE<31>. 
* Ferramentas/Demos: Ferramentas/Demos<24>. 
* API C: API C<46>. 

@end menu

@node Segurança<34>,Núcleo e embutidos<125>,,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id582}@anchor{1ae1}
@subsubsection Segurança



@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{19fb,,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 Núcleo e embutidos<125>,Biblioteca<127>,Segurança<34>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id583}@anchor{1ae2}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{57d,,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{170b,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}
@code{vectorcall} calling convention. Patch by Mark Shannon.
@end itemize

@node Biblioteca<127>,Documentação<42>,Núcleo e embutidos<125>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id584}@anchor{1ae3}
@subsubsection Biblioteca



@itemize -

@item 
bpo-40398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40398}: @ref{2ed,,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{2ec,,typing.get_origin()}, @ref{2ed,,typing.get_args()}
and @ref{6b1,,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 Propostas de Melhorias do Python; 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{dc2,,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{15d,,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{85c,,assertLogs()}
assertion is used.

@item 
bpo-40275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40275}: The @ref{a,,asyncio} package is now imported lazily in
@ref{106,,unittest} only when the @ref{30c,,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{a02,,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{1629,,random.randbytes()} function and
@ref{930,,random.Random.randbytes()} method to generate random bytes.

@item 
bpo-40277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40277}: @ref{1ca,,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{181c,,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{8f4,,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{2b0,,typing.NamedTuple} class.

@item 
bpo-36517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36517}: Multiple inheritance with @ref{2b0,,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{923,,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{2de,,threading.RLock}
and @ref{1194,,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{1197,,threading.Event} to
@code{_at_fork_reinit()}.

@item 
bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780}: Expose @ref{938,,CAN_RAW_JOIN_FILTERS} in the
@ref{cc,,socket} module.

@item 
bpo-39503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39503}: @ref{19fb,,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{21,,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{1636,,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{1ae4,,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 Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators to
@ref{1ae5,,weakref.WeakValueDictionary}.

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: Added 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators to
@ref{1ae6,,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{1ae7,,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 Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} operators (@code{|} and @code{|=}) to
@ref{c36,,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{16a0,,sys.audit()} failures in
@ref{1712,,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{15f8,,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{53c,,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 Documentação<42>,Testes<46>,Biblioteca<127>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id585}@anchor{1ae8}
@subsubsection Documentação



@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{1ae9,,Modelo de dados} docs to include @ref{256,,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{1aea,,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 Testes<46>,Construção<50>,Documentação<42>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id586}@anchor{1aeb}
@subsubsection Testes



@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{1aec,,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{900,,ftplib.FTP} and
@ref{901,,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 Construção<50>,Windows<43>,Testes<46>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id587}@anchor{1aed}
@subsubsection Construção



@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<43>,macOS<35>,Construção<50>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id588}@anchor{1aee}
@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<35>,IDLE<31>,Windows<43>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id589}@anchor{1aef}
@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<31>,Ferramentas/Demos<24>,macOS<35>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id590}@anchor{1af0}
@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 Ferramentas/Demos<24>,API C<46>,IDLE<31>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id591}@anchor{1af1}
@subsubsection Ferramentas/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{923,,os.waitstatus_to_exitcode()} to convert @ref{14a5,,os.system()} exit status
into an exit code.
@end itemize

@node API C<46>,,Ferramentas/Demos<24>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id592}@anchor{1af2}
@subsubsection API C



@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{98b,,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{97d,,PyObject_GC_IsTracked()} and
@ref{97e,,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{98c,,PyObject_New()} macro, and the @code{PyObject_NEW_VAR()} macro
becomes an alias to the @ref{98d,,PyObject_NewVar()} macro, to hide
implementation details. They no longer access directly the
@ref{98e,,PyTypeObject.tp_basicsize} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{1ac9,,PyType_HasFeature()} now always calls
@ref{1aca,,PyType_GetFlags()} to hide implementation details. Previously, it
accessed directly the @ref{19fd,,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{98f,,PyTypeObject.tp_weaklistoffset} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Convert @ref{398,,PyObject_CheckBuffer()} macro to a function to
hide implementation details: the macro accessed directly the
@ref{990,,PyTypeObject.tp_as_buffer} member.

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: Always declare @ref{991,,PyIndex_Check()} as an opaque function to
hide implementation details: remove @code{PyIndex_Check()} macro. The macro
accessed directly the @ref{992,,PyTypeObject.tp_as_number} member.

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Add @ref{979,,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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-5}@anchor{1af3}
@subsection Python 3.9.0 alpha 5


`Data de lançamento: 2020-03-23'

@menu
* Segurança: Segurança<35>. 
* Núcleo e embutidos: Núcleo e embutidos<126>. 
* Biblioteca: Biblioteca<128>. 
* Documentação: Documentação<43>. 
* Testes: Testes<47>. 
* Construção: Construção<51>. 
* Windows: Windows<44>. 
* macOS: macOS<36>. 
* IDLE: IDLE<32>. 
* Ferramentas/Demos: Ferramentas/Demos<25>. 
* API C: API C<47>. 

@end menu

@node Segurança<35>,Núcleo e embutidos<126>,,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id593}@anchor{1af4}
@subsubsection Segurança



@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 Núcleo e embutidos<126>,Biblioteca<128>,Segurança<35>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id594}@anchor{1af5}
@subsubsection Núcleo e embutidos



@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{988,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{988,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{3a9,,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{13a0,,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{575,,SystemError} in
@code{math.@{atan2,copysign,remainder@}()} when the first argument cannot be
converted to a @ref{2f7,,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.

Isso afeta os usuários de tstate->id como o mecanismo de armazenamento em cache da contextvar, que pode retornar objetos em cache inválidos sob uso intenso de threads (observado em cenários de sistemas embarcados).

@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 Propostas de Melhorias do Python; 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{731,,decorator} grammar restrictions to allow any valid
expression (
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{bd4,,PyUnicode_AsUTF8()} and
@ref{89d,,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{7d3,,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 Biblioteca<128>,Documentação<43>,Núcleo e embutidos<126>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id595}@anchor{1af6}
@subsubsection Biblioteca



@itemize -

@item 
bpo-39830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39830}: Add @ref{6c9,,zipfile.Path} to @code{__all__} in the @ref{131,,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{bbf,,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{36f,,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{5db,,collections.OrderedDict} now implements @code{|} and
@code{|=} (
@geindex Propostas de Melhorias do Python; 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{1af7,,unittest.mock.AsyncMock.await_args_list} has call
objects in the order of awaited arguments instead of using
@ref{1af8,,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{11f9,,os.environ} and @ref{1257,,os.environb} to support
@geindex Propostas de Melhorias do Python; 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{1af9,,random.Random.seed()} method when a @ref{468,,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{179e,,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{8ea,,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{8eb,,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{1095,,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{18f8,,inspect.getmodule()} when it tried to loop through
@ref{1636,,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{11fc,,collections.defaultdict} now implements @code{|}
(
@geindex Propostas de Melhorias do Python; 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{8f4,,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{b38,,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{46d,,types.MappingProxyType} objects now support the merge
(@code{|}) operator from 
@geindex Propostas de Melhorias do Python; 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 variável de ambiente; PYTHONCASEOK
@ref{963,,PYTHONCASEOK} environment variable when the @ref{964,,-E} or
@ref{965,,-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{1afa,,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{906,,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{1afb,,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{8,,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 Documentação<43>,Testes<47>,Biblioteca<128>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id596}@anchor{1afc}
@subsubsection Documentação



@itemize -

@item 
bpo-39868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39868}: Updated the Language Reference for 
@geindex Propostas de Melhorias do Python; 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{38,,dis}
@end itemize

@node Testes<47>,Construção<51>,Documentação<43>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id597}@anchor{1afd}
@subsubsection Testes



@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{3b4,,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 Construção<51>,Windows<44>,Testes<47>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id598}@anchor{1afe}
@subsubsection Construção



@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{93f,,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<44>,macOS<36>,Construção<51>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id599}@anchor{1aff}
@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<36>,IDLE<32>,Windows<44>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id600}@anchor{1b00}
@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<32>,Ferramentas/Demos<25>,macOS<36>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id601}@anchor{1b01}
@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 Ferramentas/Demos<25>,API C<47>,IDLE<32>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id602}@anchor{1b02}
@subsubsection Ferramentas/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 API C<47>,,Ferramentas/Demos<25>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id603}@anchor{1b03}
@subsubsection API C



@itemize -

@item 
bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024}: Add @ref{97c,,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{78e,,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{978,,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{3ad,,PyInterpreterState_Get()} function to the limited C
API.

@item 
bpo-35370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35370}: If @ref{36f,,PySys_Audit()} fails in @ref{1545,,PyEval_SetProfile()}
or @ref{421,,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{1b04,,PyDescr_NewMethod()} and @ref{1b05,,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{bcd,,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{18fe,,PyNumber_ToBase()} now raises a @ref{575,,SystemError}
instead of crashing when called with invalid base.

@item 
bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882}: The @ref{98a,,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{981,,m_traverse},
@ref{982,,m_clear} and @ref{983,,m_free}
functions of @ref{984,,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{985,,Py_mod_exec} function). More precisely, these functions are not
called if @ref{986,,m_size} is greater than 0 and the module
state (as returned by @ref{987,,PyModule_GetState()}) is @code{NULL}.

Módulos de extensão sem um estado de módulo (@code{m_size <= 0}) não são afetados.

@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{1b06,,_PyInterpreterState_GetEvalFrameFunc()} and
@ref{1b07,,_PyInterpreterState_SetEvalFrameFunc()} C functions. The
@ref{776,,_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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-4}@anchor{1b08}
@subsection Python 3.9.0 alpha 4


`Data de lançamento: 2020-02-25'

@menu
* Segurança: Segurança<36>. 
* Núcleo e embutidos: Núcleo e embutidos<127>. 
* Biblioteca: Biblioteca<129>. 
* Documentação: Documentação<44>. 
* Testes: Testes<48>. 
* Construção: Construção<52>. 
* Windows: Windows<45>. 
* IDLE: IDLE<33>. 
* API C: API C<48>. 

@end menu

@node Segurança<36>,Núcleo e embutidos<127>,,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id604}@anchor{1b09}
@subsubsection Segurança



@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 Núcleo e embutidos<127>,Biblioteca<129>,Segurança<36>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id605}@anchor{1b0a}
@subsubsection Núcleo e embutidos



@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{192b,,Py_IS_TYPE()}. Patch by
Donghee Na.

@item 
bpo-39619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39619}: Enable use of @ref{1b0b,,os.chroot()} on HP-UX systems.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add @ref{192b,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{1541,,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{94b,,floor division} of float operation now has a better
performance. Also the message of @ref{94c,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{256,,dict} (and @ref{1b0c,,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 Biblioteca<129>,Documentação<44>,Núcleo e embutidos<127>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id606}@anchor{1b0d}
@subsubsection Biblioteca



@itemize -

@item 
bpo-30566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30566}: Fix @ref{157e,,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{916,,math.gcd()} and @ref{917,,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{1b0e,,io.UnsupportedOperation} in
@code{io.BufferedReader.truncate()} when it is called on a read-only
@ref{124e,,io.BufferedReader} instance.

@item 
bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479}: Add @ref{917,,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{1e7,,fractions.Fraction} if the numerator
and/or the denominator is an @ref{257,,int} subclass. The @ref{916,,math.gcd()}
function is now used to normalize the `numerator' and `denominator'.
@ref{916,,math.gcd()} always return a @ref{257,,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{4a9,,os.walk()}, @ref{b71,,os.fwalk()},
@ref{22d,,pathlib.Path.glob()} and @ref{22e,,pathlib.Path.rglob()}.

@item 
bpo-39559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39559}: Remove unused, undocumented argument @code{getters} from
@ref{bbf,,uuid.getnode()}

@item 
bpo-38149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38149}: @ref{16a0,,sys.audit()} is now called only once per call of
@ref{29f,,glob.glob()} and @ref{80a,,glob.iglob()}.

@item 
bpo-39546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39546}: Fix a regression in @ref{539,,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{734,,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{944,,typing.Annotated} and @code{include_extras} parameter
to @ref{6b1,,typing.get_type_hints()} as part of 
@geindex Propostas de Melhorias do Python; 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{16f4,,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{8f3,,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{ebe,,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 Documentação<44>,Testes<48>,Biblioteca<129>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id607}@anchor{1b0f}
@subsubsection Documentação



@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 Testes<48>,Construção<52>,Documentação<44>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id608}@anchor{1b10}
@subsubsection Testes



@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{1541,,time.localtime()} fails with @ref{885,,OverflowError}. It is the case on
AIX 6.1 for example.
@end itemize

@node Construção<52>,Windows<45>,Testes<48>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id609}@anchor{1b11}
@subsubsection Construção



@itemize -

@item 
bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}: Remove @code{COUNT_ALLOCS} special build.
@end itemize

@node Windows<45>,IDLE<33>,Construção<52>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id610}@anchor{1b12}
@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{e70,,home()} and @ref{e6f,,expanduser()}
on Windows now prefer 
@geindex USERPROFILE
@geindex variável de ambiente; USERPROFILE
@code{USERPROFILE} and no longer use
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME}, which is not normally set for regular user accounts. This
makes them again behave like @ref{a1e,,os.path.expanduser()}, which was changed
to ignore 
@geindex HOME
@geindex variável de ambiente; 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<33>,API C<48>,Windows<45>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id611}@anchor{1b13}
@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{9d9,,KeyboardInterrupt} or
shell restart occurs.  Patch by Zackery Spytz.
@end itemize

@node API C<48>,,IDLE<33>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id612}@anchor{1b14}
@subsubsection API C



@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{18,,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{783,,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{1b15,,PyUnicode_IsIdentifier()} does not call
@ref{98a,,Py_FatalError()} anymore if the string is not ready.

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: Add @ref{781,,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{8af,,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{1ac9,,PyType_HasFeature()}, @ref{1b16,,PyType_Check()} and
@ref{1b17,,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{a74,,PyObject_Init()} and @ref{1acd,,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{170b,,PyThreadState_Clear()} function now calls the
@code{PyThreadState.on_delete} callback. Previously, that happened in
@ref{1b18,,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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-3}@anchor{1b19}
@subsection Python 3.9.0 alpha 3


`Data de lançamento: 2020-01-24'

@menu
* Núcleo e embutidos: Núcleo e embutidos<128>. 
* Biblioteca: Biblioteca<130>. 
* Documentação: Documentação<45>. 
* Construção: Construção<53>. 
* IDLE: IDLE<34>. 
* API C: API C<49>. 

@end menu

@node Núcleo e embutidos<128>,Biblioteca<130>,,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id613}@anchor{1b1a}
@subsubsection Núcleo e embutidos



@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{903,,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 Propostas de Melhorias do Python; 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{f3a,,min()} or
@ref{f3b,,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{94a,,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{1b1b,,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{1b1c,,-u} command-line option or setting the
@geindex PYTHONUNBUFFERED
@geindex variável de ambiente; PYTHONUNBUFFERED
@ref{1b1d,,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{1b1b,,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 Biblioteca<130>,Documentação<45>,Núcleo e embutidos<128>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id614}@anchor{1b1e}
@subsubsection Biblioteca



@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{921,,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{a33,,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{922,,os.putenv()} and @ref{921,,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{922,,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{1965,,tarfile.is_tarfile()} to be used with file and
file-like objects, like @ref{136e,,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{95c,,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{86a,,bz2.BZ2File}. Since
Python 3.0, it was ignored and using it was emitting
@ref{1a5,,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{10,,binascii} functions:
@code{b2a_hqx()}, @code{a2b_hqx()},
@code{rlecode_hqx()}, @code{rledecode_hqx()},
@ref{734,,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{95a,,base64.encodebytes()} and
@ref{95b,,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{916,,math.gcd()} instead.

@item 
bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329}: @ref{936,,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{901,,FTP_TLS} and @ref{901,,FTP_TLS} now raise
a @ref{202,,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{934,,SMTP} and @ref{935,,SMTP_SSL} now raise
a @ref{202,,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{918,,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{202,,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{498,,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{92a,,POP3} and @ref{92b,,POP3_SSL} now raise a
@ref{202,,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{961,,select.epoll.unregister()} method no longer ignores
the @ref{962,,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{1b1f,,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{693,,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{c6c,,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{909,,IMAP4} and @ref{90a,,IMAP4_SSL} now
have an optional `timeout' parameter for their constructors. Also, the
@ref{90b,,open()} method now has an optional `timeout' parameter
with this change. The overridden methods of @ref{90a,,IMAP4_SSL}
and @ref{90c,,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{1425,,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{a9c,,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{53e,,syslog.openlog()} was called without arguments.

@item 
bpo-38293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38293}: Add @ref{534,,copy.copy()} and @ref{b84,,copy.deepcopy()} support to
@ref{194,,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 Documentação<45>,Construção<53>,Biblioteca<130>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id615}@anchor{1b20}
@subsubsection Documentação



@itemize -

@item 
bpo-39381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39381}: Mention in docs that @ref{2c2,,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{1b21,,Tipos e membros} table.

@item 
bpo-3530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3530}: In the @ref{8,,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 Construção<53>,IDLE<34>,Documentação<45>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id616}@anchor{1b22}
@subsubsection Construção



@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<34>,API C<49>,Construção<53>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id617}@anchor{1b23}
@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 API C<49>,,IDLE<34>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id618}@anchor{1b24}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-2}@anchor{1b25}
@subsection Python 3.9.0 alpha 2


`Data de lançamento: 2019-12-18'

@menu
* Segurança: Segurança<37>. 
* Núcleo e embutidos: Núcleo e embutidos<129>. 
* Biblioteca: Biblioteca<131>. 
* Documentação: Documentação<46>. 
* Testes: Testes<49>. 
* Construção: Construção<54>. 
* Windows: Windows<46>. 
* macOS: macOS<37>. 
* IDLE: IDLE<35>. 
* API C: API C<50>. 

@end menu

@node Segurança<37>,Núcleo e embutidos<129>,,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id619}@anchor{1b26}
@subsubsection Segurança



@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{733,,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 Núcleo e embutidos<129>,Biblioteca<131>,Segurança<37>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id620}@anchor{1b27}
@subsubsection Núcleo e embutidos



@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{36f,,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{80e,,sys.excepthook()} and
@ref{1f7,,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{611,,list} and
@ref{5d9,,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{b6f,,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 Biblioteca<131>,Documentação<46>,Núcleo e embutidos<129>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id621}@anchor{1b28}
@subsubsection Biblioteca



@itemize -

@item 
bpo-39033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39033}: Fix @ref{43f,,NameError} in @ref{132,,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{1a0,,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{1091,,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{6b1,,typing.get_type_hints()} properly handles functions
decorated with @ref{f91,,functools.wraps()}.

@item 
bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870}: Expose @ref{8eb,,ast.unparse()} as a function of the @ref{8,,ast}
module that can be used to unparse an @ref{1a6,,ast.AST} object and produce
a string with code that would produce an equivalent @ref{1a6,,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{162,,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{6,,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{fec,,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{112e,,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{1afa,,urllib.request.AbstractDigestAuthHandler}.

@item 
bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712}: Add the Linux-specific @ref{932,,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{3a,,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 Documentação<46>,Testes<49>,Biblioteca<131>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id622}@anchor{1b29}
@subsubsection Documentação



@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{16f6,,datetime.datetime.strptime()} accepts for @code{%Z}. Patch by Karl
Dubost.
@end itemize

@node Testes<49>,Construção<54>,Documentação<46>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id623}@anchor{1b2a}
@subsubsection Testes



@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{1b2b,,LOOPBACK_TIMEOUT},
@ref{1b2c,,INTERNET_TIMEOUT},
@ref{19ee,,SHORT_TIMEOUT} and
@ref{1b2d,,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{141b,,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{d65,,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{2c3,,TypeError} when passing target as a string with
@ref{167f,,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 Construção<54>,Windows<46>,Testes<49>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id624}@anchor{1b2e}
@subsubsection Construção



@itemize -

@item 
bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404}: @ref{a,,asyncio} now raises @ref{2c3,,TypeError} when calling
incompatible methods with an @ref{8f0,,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<46>,macOS<37>,Construção<54>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id625}@anchor{1b2f}
@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<37>,IDLE<35>,Windows<46>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id626}@anchor{1b30}
@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<35>,API C<50>,macOS<37>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id627}@anchor{1b31}
@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 API C<50>,,IDLE<35>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id628}@anchor{1b32}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-9-0-alpha-1}@anchor{1b33}
@subsection Python 3.9.0 alpha 1


`Data de lançamento: 2019-11-19'

@menu
* Segurança: Segurança<38>. 
* Núcleo e embutidos: Núcleo e embutidos<130>. 
* Biblioteca: Biblioteca<132>. 
* Documentação: Documentação<47>. 
* Testes: Testes<50>. 
* Construção: Construção<55>. 
* Windows: Windows<47>. 
* macOS: macOS<38>. 
* IDLE: IDLE<36>. 
* Ferramentas/Demos: Ferramentas/Demos<26>. 
* API C: API C<51>. 

@end menu

@node Segurança<38>,Núcleo e embutidos<130>,,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id629}@anchor{1b34}
@subsubsection Segurança



@itemize -

@item 
bpo-38722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38722}: @ref{be,,runpy} now uses @ref{181c,,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{2a,,ctypes} module.

@item 
bpo-38418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38418}: Fixes audit event for @ref{14a5,,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{1b35,,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{1b36,,Linha de comando e ambiente}).

@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{1139,,os.listdir()}, @ref{a68,,os.scandir()} and @ref{234,,breakpoint()}.

@item 
bpo-37364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37364}: @ref{181c,,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 Núcleo e embutidos<130>,Biblioteca<132>,Segurança<38>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id630}@anchor{1b37}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-38631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38631}: Replace @code{Py_FatalError()} call with a regular
@ref{195,,RuntimeError} exception in @code{float.__getformat__()}.

@item 
bpo-38639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38639}: Optimized @ref{1404,,math.floor()}, @ref{1405,,math.ceil()} and
@ref{1406,,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{1c2,,bytes} and @ref{2ea,,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{2ea,,bytearray}, @ref{1a0,,array} and
@ref{20b,,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{154d,,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 Propostas de Melhorias do Python; 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{256,,dict} constructor and the
@ref{14ad,,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{47c,,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{a51,,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{96a,,codecs.lookup()} to normalize the encoding name the
same way than @ref{7fe,,encodings.normalize_encoding()}, except that
@ref{96a,,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{ab8,,break} and @ref{9d1,,continue}
in the @ref{9d2,,finally} block when the corresponding @ref{6e9,,try}
block contains @ref{9d6,,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{1a82,,sq_item} of @ref{2ea,,bytearray}. Patch by
Sergey Fedoseev.

@item 
bpo-37802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37802}: Slightly improve performance of
@ref{1b38,,PyLong_FromUnsignedLong()}, @ref{1b39,,PyLong_FromUnsignedLongLong()}
and @ref{1b3a,,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{466,,SyntaxWarning} instead
of @ref{1a5,,DeprecationWarning} for invalid escape sequences in string and
bytes literals.

@item 
bpo-37757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37757}: 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}: As described in the PEP, assignment expressions now
raise @ref{18d,,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{dbe,,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{96f,,assert} statement now works properly if the
@ref{6a9,,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{10a6,,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{80e,,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}: @ref{15b6,,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{950,,sys.getswitchinterval()} and @ref{951,,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{51c,,open()}, @ref{8db,,str.encode()} and @ref{8dc,,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{51c,,open()}, @ref{51d,,io.open()}, @ref{740,,codecs.open()} and
@ref{737,,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{36f,,PySys_Audit()} call in @ref{20b,,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{75a,,PyBuffer_SizeFromFormat()} function
(previously documented but not implemented): call @ref{1b3b,,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{a47,,threading.get_native_id()} now also supports NetBSD.

@item 
bpo-37077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37077}: Add @ref{a47,,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{46a,,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{166,,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 Biblioteca<132>,Documentação<47>,Núcleo e embutidos<130>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id631}@anchor{1b3c}
@subsubsection Biblioteca



@itemize -

@item 
bpo-36589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36589}: The @ref{e16,,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{2c3,,TypeError} messages for @ref{171f,,os.path.join()} to
include @ref{c6c,,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{181c,,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{51c,,open()}.

@item 
bpo-38438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38438}: Simplify the @ref{6,,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{920,,os.P_PIDFD} constant, which may be passed to
@ref{dc1,,os.waitid()} to wait on a Linux process file descriptor.

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: Add @ref{479,,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{47a,,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{8f6,,curses.get_escdelay()}, @ref{8f7,,curses.set_escdelay()},
@ref{8f8,,curses.get_tabsize()}, and @ref{8f9,,curses.set_tabsize()} functions - by
Anthony Sottile.

@item 
bpo-38586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38586}: Now @ref{b66,,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{91e,,CLD_KILLED} and @ref{91f,,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{b21,,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{208,,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 @ref{193e,,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{fef,,stat.S_IFDOOR}, @ref{ff0,,stat.S_IFPORT},
@ref{ff1,,stat.S_IFWHT}, @ref{1b3d,,stat.S_ISDOOR()}, @ref{1b3e,,stat.S_ISPORT()}, and
@ref{1b3f,,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{2b0,,typing.NamedTuple} are now
pickleable.

@item 
bpo-38332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38332}: Prevent @ref{344,,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{1b40,,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{41a,,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{b75,,os.pread()} to accept
@ref{a69,,Py_ssize_t} instead of int.

@item 
bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112}: @ref{20,,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{2b0,,NamedTuple} and
@ref{162,,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{30,,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{ea0,,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{d19,,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{ea0,,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{a,,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{1e,,collections.abc} module

@item 
bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}: For @ref{a,,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{47c,,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{2a0,,path-like object} as @code{directory}
argument to the @ref{b56,,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{8,,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{494,,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{ccf,,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{8ea,,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{8ea,,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{a78,,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{1b41,,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{37,,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{6,,argparse}.

@item 
bpo-34488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34488}: @code{writelines()} method of @ref{ed3,,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{bcb,,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{3b,,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{9d7,,datetime.timedelta} and
@ref{10fe,,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{10d7,,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{1b42,,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{7d3,,NotImplemented} for unsupported type of
the other operand. This allows the other operand to play role (for example
the equality comparison with @ref{1b43,,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{10fe,,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{7d3,,NotImplemented} in Python implementation of
@code{__eq__} for @ref{9d7,,timedelta} and @ref{1ce,,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{1b44,,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{114d,,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{a9b,,os.getcwdb()} function now uses the UTF-8 encoding on
Windows, rather than the ANSI code page: see 
@geindex Propostas de Melhorias do Python; 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{1d1,,types.SimpleNamespace}. Patch by Carl Bordum Hansen.

@item 
bpo-26967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26967}: An @ref{539,,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{1b45,,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{2aa,,sqlite3.Connection.create_aggregate()},
@ref{2a9,,sqlite3.Connection.create_function()},
@ref{2ab,,sqlite3.Connection.set_authorizer()},
@ref{2ac,,sqlite3.Connection.set_progress_handler()}
@ref{2ad,,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{17ec,,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{94e,,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{1b46,,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{34b,,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{195,,RuntimeError} raised by
@ref{95d,,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{b9e,,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{5dc,,collections.deque} in
@ref{a7b,,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{93a,,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{1b47,,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{800,,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{1b48,,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{1e,,collections.abc} no longer
are exposed in the regular @ref{1d,,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{1719,,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{925,,readlink()}. Patch by Girts Folkmanis.

@item 
bpo-32498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32498}: Made @ref{1883,,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{e82,,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 Documentação<47>,Testes<50>,Biblioteca<132>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id632}@anchor{1b49}
@subsubsection Documentação



@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{3b,,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{195,,RuntimeError} is raised if
@ref{197,,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{366,,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{1547,,sys.settrace()} docs.

@item 
bpo-37878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37878}: Make @ref{1b4a,,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{41c,,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{16f6,,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{30,,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{2a0,,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 Testes<50>,Construção<55>,Documentação<47>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id633}@anchor{1b4b}
@subsubsection Testes



@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{1b2b,,LOOPBACK_TIMEOUT},
@ref{1b2c,,INTERNET_TIMEOUT},
@ref{19ee,,SHORT_TIMEOUT} and
@ref{1b2d,,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{1b4c,,os.setsid()} and @ref{1b4d,,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{30,,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{953,,threading.Thread} exception using
@ref{84e,,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{1b4e,,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{1b4f,,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{1f7,,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{1b50,,unittest.skip()} is
uncalled. Patch by Naitree Zhu.
@end itemize

@node Construção<55>,Windows<47>,Testes<50>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id634}@anchor{1b51}
@subsubsection Construção



@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{44c,,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{1b52,,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<47>,macOS<38>,Construção<55>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id635}@anchor{1b53}
@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{1c5,,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{225,,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{4a0,,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{926,,os.readlink()} (or
indirectly through @ref{225,,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{1b54,,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{a18,,exists()} and a valid result from @ref{4a0,,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{4a1,,os.lstat()} and other reparse points as regular files in
@ref{4a0,,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{419,,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 variável de ambiente; 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{3b8,,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{1b54,,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{1b55,,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<38>,IDLE<36>,Windows<47>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id636}@anchor{1b56}
@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<36>,Ferramentas/Demos<26>,macOS<38>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id637}@anchor{1b57}
@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 Ferramentas/Demos<26>,API C<51>,IDLE<36>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id638}@anchor{1b58}
@subsubsection Ferramentas/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{1b59,,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 API C<51>,,Ferramentas/Demos<26>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id639}@anchor{1b5a}
@subsubsection API C



@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{97a,,Py_EnterRecursiveCall()} and
@ref{97b,,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{989,,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{1b5b,,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{a5b,,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{3b8,,sys.executable} to the
program full path (@ref{3b7,,Py_GetProgramFullPath()}) rather than to the
program name (@ref{3b9,,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{bcd,,Py_UNREACHABLE()} macro now calls
@ref{98a,,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 Propostas de Melhorias do Python; 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{39c,,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{39c,,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{1b5c,,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{1713,,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{39b,,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{1b5d,,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,Changelog
@anchor{whatsnew/changelog python-3-8-0-beta-1}@anchor{1b5e}
@subsection Python 3.8.0 beta 1


`Data de lançamento: 2019-06-04'

@menu
* Segurança: Segurança<39>. 
* Núcleo e embutidos: Núcleo e embutidos<131>. 
* Biblioteca: Biblioteca<133>. 
* Documentação: Documentação<48>. 
* Testes: Testes<51>. 
* Construção: Construção<56>. 
* Windows: Windows<48>. 
* macOS: macOS<39>. 
* IDLE: IDLE<37>. 
* Ferramentas/Demos: Ferramentas/Demos<27>. 
* API C: API C<52>. 

@end menu

@node Segurança<39>,Núcleo e embutidos<131>,,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id640}@anchor{1b5f}
@subsubsection Segurança



@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 Núcleo e embutidos<131>,Biblioteca<133>,Segurança<39>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id641}@anchor{1b60}
@subsubsection Núcleo e embutidos



@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{257,,int}, @ref{2f7,,float} and
@ref{2f8,,complex} will now use the @ref{71d,,__index__()} special
method, if available and the corresponding method @ref{71c,,__int__()},
@ref{9d4,,__float__()} or @ref{5e7,,__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{a13,,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{2df,,types.CodeType}).

@item 
bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007}: Implement @ref{a37,,socket.if_nameindex()},
@ref{a38,,socket.if_nametoindex()}, and @ref{a39,,socket.if_indextoname()} on
Windows.

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: @ref{34d,,PyErr_WriteUnraisable()} now creates a traceback object
if there is no current traceback. Moreover, call
@ref{3f5,,PyErr_NormalizeException()} and @ref{1b61,,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{18d,,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{468,,bool}, @ref{257,,int}, @ref{2f7,,float}, @ref{2f8,,complex} and few
classes from the standard library. They now inherit @code{__str__()} from
@ref{a96,,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{68c,,sys.flags} and @ref{1b62,,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 Biblioteca<133>,Documentação<48>,Núcleo e embutidos<131>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id642}@anchor{1b63}
@subsubsection Biblioteca



@itemize -

@item 
bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}: Added @ref{6d1,,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{a81,,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{196,,_thread.start_new_thread()} now logs uncaught exception
raised by the function using @ref{1f7,,sys.unraisablehook()}, rather than
@ref{80e,,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{a53,,unittest.mock.AsyncMock} setup for autospeccing. Document newly
implemented async methods in @ref{ebe,,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{1b64,,symtable.symtable()} now accepts the same input types for
source code as the built-in @ref{192,,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{84e,,threading.excepthook()} function which handles
uncaught @ref{a46,,threading.Thread.run()} exception. It can be overridden to
control how uncaught @ref{a46,,threading.Thread.run()} exceptions are handled.

@item 
bpo-36996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36996}: Handle @ref{ec1,,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{7d9,,next()} with the mock resulting
from @ref{101d,,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{802,,fileinput.input()} and @ref{737,,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{1d,,collections} is deprecated, and import should be done from
@ref{1e,,collections.abc}. Still being able to import from @ref{1d,,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{43f,,NameError} in
@ref{1b65,,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{116d,,shutil.copystat()} now ignores @ref{1b66,,errno.EINVAL} on
@ref{1146,,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{1a09,,asyncio.StreamReader} and @ref{17f2,,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{a82,,asyncio.create_subprocess_shell()} and
@ref{a81,,asyncio.create_subprocess_exec()} to use @code{asyncio.Stream}
instead of deprecated @code{StreamReader} and @code{StreamWriter}.
Deprecate @ref{1a09,,asyncio.StreamReader} and @ref{17f2,,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{a0d,,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{1f7,,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{a43,,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{e59,,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{9ff,,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{a2f,,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{1b67,,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{123f,,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{101d,,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{6d0,,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{1275,,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{131f,,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{1b68,,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{a31,,shlex.join()}, the
inverse of @ref{53c,,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{199,,subprocess.Popen()} on Windows.  The `args' parameter now accepts a
@ref{2a0,,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{2a0,,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{1b69,,pathlib.Path.unlink} now accepts a `missing_ok'
parameter to avoid a @ref{42b,,FileNotFoundError} from being raised. Patch by
Robert Buchholz.

@item 
bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941}: Allow @ref{20b,,mmap.mmap} objects to access the madvise() system
call (through @ref{a10,,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{1b6a,,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 Documentação<48>,Testes<51>,Biblioteca<133>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id643}@anchor{1b6b}
@subsubsection Documentação



@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 Testes<51>,Construção<56>,Documentação<48>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id644}@anchor{1b6c}
@subsubsection Testes



@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{1b4f,,test.support.catch_unraisable_exception()} rather than
@ref{1b6d,,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{1b4f,,test.support.catch_unraisable_exception()}: context
manager catching unraisable exception using @ref{1f7,,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{30,,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 Construção<56>,Windows<48>,Testes<51>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id645}@anchor{1b6e}
@subsubsection Construção



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

Adicione um módulo pkg-config @code{python-3.8-embed} para incorporar o Python em uma aplicação: @code{pkg-config python-3.8-embed --libs} inclui @code{-lpython3.8}. Para suportar tanto o 3.8 quanto o anterior, tente @code{pkg-config python-X.Y-embed --libs} primeiro e use como fallback @code{pkg-config python-X.Y --libs} (sem @code{--embed}) se o comando anterior falhar (substitua @code{X.Y} pela versão do Python).

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<48>,macOS<39>,Construção<56>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id646}@anchor{1b6f}
@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{ab3,,Py_DEPRECATED()} macro has been implemented for
MSVC.
@end itemize

@node macOS<39>,IDLE<37>,Windows<48>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id647}@anchor{1b70}
@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<37>,Ferramentas/Demos<27>,macOS<39>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id648}@anchor{1b71}
@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 Ferramentas/Demos<27>,API C<52>,IDLE<37>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id649}@anchor{1b72}
@subsubsection Ferramentas/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 API C<52>,,Ferramentas/Demos<27>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id650}@anchor{1b73}
@subsubsection API C



@itemize -

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: Implement the 
@geindex Propostas de Melhorias do Python; 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{1b74,,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 Propostas de Melhorias do Python; 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{3fb,,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,Changelog
@anchor{whatsnew/changelog python-3-8-0-alpha-4}@anchor{1b75}
@subsection Python 3.8.0 alpha 4


`Data de lançamento: 2019-05-06'

@menu
* Segurança: Segurança<40>. 
* Núcleo e embutidos: Núcleo e embutidos<132>. 
* Biblioteca: Biblioteca<134>. 
* Documentação: Documentação<49>. 
* Testes: Testes<52>. 
* Construção: Construção<57>. 
* Windows: Windows<49>. 
* macOS: macOS<40>. 
* IDLE: IDLE<38>. 
* Ferramentas/Demos: Ferramentas/Demos<28>. 
* API C: API C<53>. 

@end menu

@node Segurança<40>,Núcleo e embutidos<132>,,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id651}@anchor{1b76}
@subsubsection Segurança



@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{4b4,,shutil.which()} now uses @code{os.confstr("CS_PATH")} if
available and if the 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} environment variable is not set.
Remove also the current directory from @code{posixpath.defpath}. On Unix,
@ref{4b4,,shutil.which()} and the @ref{d6,,subprocess} module no longer search the
executable in the current directory if the 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} environment
variable is not set.
@end itemize

@node Núcleo e embutidos<132>,Biblioteca<134>,Segurança<40>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id652}@anchor{1b77}
@subsubsection Núcleo e embutidos



@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{a97,,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 Propostas de Melhorias do Python; 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{3a9,,PyEval_RestoreThread()}, @ref{a98,,Py_END_ALLOW_THREADS()}, and
@ref{3ab,,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{12c5,,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{154d,,PyObject_GC_Track()} calls in the
@ref{a6,,pickle} module. Patch by Zackery Spytz.
@end itemize

@node Biblioteca<134>,Documentação<49>,Núcleo e embutidos<132>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id653}@anchor{1b78}
@subsubsection Biblioteca



@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{737,,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{3b8,,sys.executable} is
@code{None} or an empty string: use @ref{1682,,os.getcwd()} to initialize
@code{project_base}.  Fix also the distutils build command: don’t use
@ref{3b8,,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{4b4,,shutil.which()} and @code{distutils.spawn.find_executable}
now use @code{os.confstr("CS_PATH")} if available instead of
@ref{1b79,,os.defpath}, if the @code{PATH} environment variable is not set.
Moreover, don’t use @code{os.confstr("CS_PATH")} nor @ref{1b79,,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{a,,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{176,,-X} @code{dev}) and in debug build,
the @ref{1f5,,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{1228,,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{ec1,,unittest.mock.patch()} object will now return @code{None} instead of
raising @ref{195,,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{9f4,,datetime.date.fromisocalendar()} and
@ref{9f5,,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{1b7a,,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{a35,,create_server()} and
@ref{a36,,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{166,,classmethod()} and @ref{416,,staticmethod()} to
@ref{16f4,,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{a54,,unittest.mock.Mock}.

@item 
bpo-34547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34547}: @ref{1b67,,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{1b7b,,xml.sax.parse()} now supports @ref{2a0,,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 Documentação<49>,Testes<52>,Biblioteca<134>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id654}@anchor{1b7c}
@subsubsection Documentação



@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 Testes<52>,Construção<57>,Documentação<49>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id655}@anchor{1b7d}
@subsubsection Testes



@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{1b7e,,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 Construção<57>,Windows<49>,Testes<52>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id656}@anchor{1b7f}
@subsubsection Construção



@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{427,,sys.getobjects()} function
and the 
@geindex PYTHONDUMPREFS
@geindex variável de ambiente; PYTHONDUMPREFS
@ref{9ae,,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<49>,macOS<40>,Construção<57>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id657}@anchor{1b80}
@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{9f2,,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<40>,IDLE<38>,Windows<49>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id658}@anchor{1b81}
@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<38>,Ferramentas/Demos<28>,macOS<40>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id659}@anchor{1b82}
@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 Ferramentas/Demos<28>,API C<53>,IDLE<38>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id660}@anchor{1b83}
@subsubsection Ferramentas/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 API C<53>,,Ferramentas/Demos<28>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id661}@anchor{1b84}
@subsubsection API C



@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}: @ref{1b85,,PyDoc_VAR}(name) and @ref{1aea,,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{c85,,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{be0,,Py_DecodeLocale()} before
@ref{8b1,,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{1b86,,PyDate_FromTimestamp()} function were incorrectly
interpreted as a single timestamp rather than an arguments tuple, which
causes existing code to start raising @ref{2c3,,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,Changelog
@anchor{whatsnew/changelog python-3-8-0-alpha-3}@anchor{1b87}
@subsection Python 3.8.0 alpha 3


`Data de lançamento: 2019-03-25'

@menu
* Segurança: Segurança<41>. 
* Núcleo e embutidos: Núcleo e embutidos<133>. 
* Biblioteca: Biblioteca<135>. 
* Documentação: Documentação<50>. 
* Testes: Testes<53>. 
* Construção: Construção<58>. 
* Windows: Windows<50>. 
* IDLE: IDLE<39>. 
* Ferramentas/Demos: Ferramentas/Demos<29>. 
* API C: API C<54>. 

@end menu

@node Segurança<41>,Núcleo e embutidos<133>,,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id662}@anchor{1b88}
@subsubsection Segurança



@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{1b89,,http.cookiejar.DefaultCookiePolicy} policy. Patch
by Karthikeyan Singaravelan.
@end itemize

@node Núcleo e embutidos<133>,Biblioteca<135>,Segurança<41>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id663}@anchor{1b8a}
@subsubsection Núcleo e embutidos



@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{3b4,,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{192,,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{d32,,pickle.load()}, @ref{1b8b,,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{71d,,__index__()} special method will be used
instead of @ref{71c,,__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 Biblioteca<135>,Documentação<50>,Núcleo e embutidos<133>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id664}@anchor{1b8c}
@subsubsection Biblioteca



@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{a,,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{20b,,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{1b8d,,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{2a0,,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{111e,,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{16f4,,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 Documentação<50>,Testes<53>,Biblioteca<135>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id665}@anchor{1b8e}
@subsubsection Documentação



@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 Testes<53>,Construção<58>,Documentação<50>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id666}@anchor{1b8f}
@subsubsection Testes



@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 Construção<58>,Windows<50>,Testes<53>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id667}@anchor{1b90}
@subsubsection Construção



@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<50>,IDLE<39>,Construção<58>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id668}@anchor{1b91}
@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<39>,Ferramentas/Demos<29>,Windows<50>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id669}@anchor{1b92}
@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 Ferramentas/Demos<29>,API C<54>,IDLE<39>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id670}@anchor{1b93}
@subsubsection Ferramentas/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 API C<54>,,Ferramentas/Demos<29>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id671}@anchor{1b94}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-8-0-alpha-2}@anchor{1b95}
@subsection Python 3.8.0 alpha 2


`Data de lançamento: 2019-02-25'

@menu
* Núcleo e embutidos: Núcleo e embutidos<134>. 
* Biblioteca: Biblioteca<136>. 
* Documentação: Documentação<51>. 
* Testes: Testes<54>. 
* Windows: Windows<51>. 
* IDLE: IDLE<40>. 

@end menu

@node Núcleo e embutidos<134>,Biblioteca<136>,,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id672}@anchor{1b96}
@subsubsection Núcleo e embutidos



@itemize -

@item 
bpo-36052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36052}: Raise a @ref{18d,,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{c6c,,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{be8,,list.sort()} when sorting objects
with @code{ob_type->tp_richcompare == NULL}.  Patch by Zackery Spytz.
@end itemize

@node Biblioteca<136>,Documentação<51>,Núcleo e embutidos<134>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id673}@anchor{1b97}
@subsubsection Biblioteca



@itemize -

@item 
bpo-35512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35512}: @ref{1b6a,,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{4b4,,shutil.which()}.

@item 
bpo-35960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35960}: Fix @ref{1b98,,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{1b99,,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{126d,,re.search()}, @ref{1060,,re.findall()}, @ref{2a3,,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{a0c,,math.prod()} as analogous function to
@ref{46a,,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{1cc,,datetime.datetime}
subclasses and @ref{9d7,,datetime.timedelta} now returns an object of the
same type as the @ref{1cc,,datetime.datetime} subclass. As a result,
@ref{9d8,,datetime.datetime.astimezone()} and alternate constructors like
@ref{4ec,,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{a61,,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 Documentação<51>,Testes<54>,Biblioteca<136>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id674}@anchor{1b9a}
@subsubsection Documentação



@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 Testes<54>,Windows<51>,Documentação<51>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id675}@anchor{1b9b}
@subsubsection Testes



@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<51>,IDLE<40>,Testes<54>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id676}@anchor{1b9c}
@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<40>,,Windows<51>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id677}@anchor{1b9d}
@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,Changelog
@anchor{whatsnew/changelog python-3-8-0-alpha-1}@anchor{1b9e}
@subsection Python 3.8.0 alpha 1


`Data de lançamento: 2019-02-03'

@menu
* Segurança: Segurança<42>. 
* Núcleo e embutidos: Núcleo e embutidos<135>. 
* Biblioteca: Biblioteca<137>. 
* Documentação: Documentação<52>. 
* Testes: Testes<55>. 
* Construção: Construção<59>. 
* Windows: Windows<52>. 
* macOS: macOS<41>. 
* IDLE: IDLE<41>. 
* Ferramentas/Demos: Ferramentas/Demos<30>. 
* API C: API C<55>. 

@end menu

@node Segurança<42>,Núcleo e embutidos<135>,,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id678}@anchor{1b9f}
@subsubsection Segurança



@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{965,,-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{964,,-E} and
@ref{13d5,,-s} options (enabled by @ref{965,,-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{b21,,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 Núcleo e embutidos<135>,Biblioteca<137>,Segurança<42>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id679}@anchor{1ba0}
@subsubsection Núcleo e embutidos



@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{61f,,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{38a,,PyUnicode_FromFormat()} and @code{%s} in @ref{1ba1,,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{575,,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{621,,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 Propostas de Melhorias do Python; 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{132,,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{202,,ValueError} instead of @ref{885,,OverflowError} in case
of a negative @code{_length_} in a @ref{1ba2,,ctypes.Array} subclass.  Also
raise @ref{2c3,,TypeError} instead of @ref{34b,,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{466,,SyntaxWarning} raised as an exception at code generation
time will be now replaced with a @ref{18d,,SyntaxError} for better error
reporting.

@item 
bpo-34983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34983}: Expose @ref{1ba3,,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{1c2,,bytes} and @ref{2ea,,bytearray} constructors no longer
convert unexpected exceptions (e.g. @ref{15c5,,MemoryError} and
@ref{9d9,,KeyboardInterrupt}) to @ref{2c3,,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{1c2,,bytes()} when the @ref{611,,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{466,,SyntaxWarning} is now emitted instead of a
@ref{1a5,,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{466,,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{427,,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{51c,,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{34b,,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{1f6,,io.IOBase.close()}, ensure that the
@ref{1ba4,,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{1a56,,PyRun_SimpleFileExFlags()}
before calling @ref{1ab9,,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{1a3e,,PyIter_Check()}, @ref{991,,PyIndex_Check()} and
@ref{a6f,,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{1201,,gc.garbage} list. @ref{995,,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{195,,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{1a5,,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 variável de ambiente; PYTHONPYCACHEPREFIX
@ref{9ab,,PYTHONPYCACHEPREFIX} environment variable and
@ref{176,,-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{132,,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 shrinked only when
@code{used == 0}. Now dict has more chance to be shrinked.

@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{ab9,,END_ASYNC_FOR} and fixes the
following issues:


@itemize *

@item 
Setting global @ref{1ba5,,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{9d1,,continue} statement is now allowed in the
@ref{9d2,,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{ab8,,break}, @ref{9d1,,continue} and
@ref{9d6,,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 Biblioteca<137>,Documentação<52>,Núcleo e embutidos<135>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id680}@anchor{1ba6}
@subsubsection Biblioteca



@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{220,,os.posix_spawn()} and @ref{1ba7,,os.posix_spawnp()} now have a
`setsid' parameter.

@item 
bpo-23846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23846}: @ref{609,,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{a,,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{1ba7,,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{a4c,,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{8dd,,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{9a9,,divmod()}
function on @ref{1e7,,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{220,,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{2a,,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{bc0,,uuid.uuid1()} now calls @ref{af9,,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{a92,,time.perf_counter()} rather than
@ref{254,,time.time()} to measure the execution time of a test:
@ref{254,,time.time()} can go backwards, whereas @ref{a92,,time.perf_counter()} is
monotonic.

@item 
bpo-35502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35502}: Fixed reference leaks in
@ref{a5f,,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{1781,,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{a54,,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{244,,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{344,,KeyError} on calling @ref{1ba8,,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{1ba9,,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{dc8,,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{dc8,,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{1baa,,platform.uname()} now redirects @code{stderr} to
@ref{1bab,,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{a91,,os.popen()} instead.

@item 
bpo-35344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35344}: On macOS, @ref{184e,,platform.platform()} now uses
@ref{1bac,,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{c18,,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{1b45,,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{17bb,,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{117e,,socketserver.BaseServer.serve_forever()} now exits
immediately if it’s @ref{1bad,,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{ebe,,unittest.mock.MagicMock} now supports the
@code{__fspath__} method (from @ref{c6c,,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{310,,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{2e4,,inspect.iscoroutinefunction()},
@ref{18e6,,inspect.isgeneratorfunction()} and @ref{18e7,,inspect.isasyncgenfunction()}
work with @ref{414,,functools.partial()}. Patch by Pablo Galindo.

@item 
bpo-34521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34521}: Use @ref{1bae,,socket.CMSG_SPACE()} to calculate ancillary data size
instead of @ref{1baf,,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{1bb0,,mimetypes.MimeTypes.guess_type()} now accepts
@ref{2a0,,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{934,,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{1bb1,,digest()} and
@ref{1bb2,,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{19d4,,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 variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} environment variable no longer
overrides the value of the `invalidation_mode' argument to
@ref{a2f,,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{1bb3,,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{132,,zipimport}.

@item 
bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}: The parser now represents all constants as
@ref{2b9,,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{d1b,,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{1229,,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{21a,,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{a55,,addModuleCleanup()} and
@ref{a56,,addClassCleanup()} to unittest to support cleanups
for @ref{a57,,setUpModule()} and
@ref{a58,,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{1b79,,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{202,,ValueError} is now raised by
@ref{1bb4,,multiprocessing.Queue.put()} and @ref{1bb5,,multiprocessing.Queue.get()}
instead of @ref{6a9,,AssertionError} and @ref{417,,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 Propostas de Melhorias do Python; 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{131,,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{7c2,,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{1bb6,,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{926,,os.readlink()} now accepts @ref{2a0,,path-like} and @ref{1c2,,bytes} objects on Windows.

@item 
bpo-22602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22602}: The UTF-7 decoder now raises @ref{a1d,,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{aa7,,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{1703,,pathlib.PurePath.with_suffix()} when
formatting an error message.

@item 
bpo-18540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18540}: The @ref{909,,imaplib.IMAP4} and @ref{90a,,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{52d,,assertRaises()},
@ref{52f,,assertRaisesRegex()},
@ref{11a3,,assertWarns()} and
@ref{11a4,,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{283,,__getitem__()} methods of
@ref{735,,xml.dom.pulldom.DOMEventStream}, @ref{736,,wsgiref.util.FileWrapper}
and @ref{737,,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{1bb7,,dbm.gnu.open()} and @ref{1bb8,,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{e89,,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{9e6,,get_name()} and
@ref{9e5,,set_name()}) and is visible in the @ref{800,,repr()} output.
An initial name can also be set using the new @code{name} keyword argument to
@ref{1bf,,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{1142,,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{2aa,,sqlite3.Connection.create_aggregate()},
@ref{2a9,,sqlite3.Connection.create_function()},
@ref{2ab,,sqlite3.Connection.set_authorizer()},
@ref{2ac,,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{29,,csv} reader are now @ref{468,,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{2c3,,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{519,,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{105b,,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{2a9,,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 Propostas de Melhorias do Python; 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{253,,time.monotonic()} instead of the system clock @ref{254,,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{b74,,os.readv()}, @ref{b77,,os.writev()},
@ref{b73,,os.preadv()} and @ref{b76,,os.pwritev()} and in @ref{b21,,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{534,,copy.copy()} and @ref{b84,,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{a33,,shutil.copytree()} uses @ref{a68,,os.scandir()} function and
all copy functions depending from it use cached @ref{4a0,,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{4a0,,os.stat()} syscalls is reduced by 38% making
@ref{a33,,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{a18,,exists()}, @ref{a19,,lexists()}, @ref{a1a,,isdir()},
@ref{a1b,,isfile()}, @ref{a16,,islink()}, and
@ref{a1c,,ismount()}, and @ref{229,,pathlib.Path} methods that return a
boolean result like @ref{a20,,exists()},
@ref{230,,is_dir()}, @ref{22f,,is_file()},
@ref{a21,,is_mount()}, @ref{a22,,is_symlink()},
@ref{a23,,is_block_device()},
@ref{a24,,is_char_device()}, @ref{a25,,is_fifo()},
@ref{a26,,is_socket()} now return @code{False} instead of raising
@ref{202,,ValueError} or its subclasses @ref{677,,UnicodeEncodeError} and
@ref{a1d,,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{1ba9,,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{2c3,,TypeError} instead of @ref{575,,SystemError} when
performed on @ref{20b,,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{5ff,,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{a63,,shutil.copyfile()}, @ref{a64,,shutil.copy()},
@ref{a65,,shutil.copy2()}, @ref{a33,,shutil.copytree()} and @ref{e82,,shutil.move()} use
platform-specific fast-copy syscalls on Linux and macOS in order to copy
the file more efficiently. On Windows @ref{a63,,shutil.copyfile()} uses a
bigger default buffer size (1 MiB instead of 16 KiB) and a
@ref{2eb,,memoryview()}-based variant of @ref{a66,,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{bc0,,uuid.uuid1()} on FreeBSD.

@item 
bpo-33238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33238}: Add @code{InvalidStateError} to @ref{21,,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{4da,,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{ebe,,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{1bb9,,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{22,,configparser} from @ref{5db,,collections.OrderedDict} to the standard
@ref{256,,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{a5e,,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{1a5,,DeprecationWarning}
instead of @ref{8ce,,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{101d,,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{2c3,,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{34,,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{f64,,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{1bba,,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{f64,,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{1bbb,,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{1f2,,importlib.resources.contents()} and
@ref{1bbc,,importlib.abc.ResourceReader.contents()} return an @ref{1268,,iterable}
instead of an @ref{1ac,,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{5e1,,-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{3b4,,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{5e4,,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 Propostas de Melhorias do Python; 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{1bbd,,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 Propostas de Melhorias do Python; 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{220,,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{202,,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{1bbe,,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{32,,dbm.dumb} database opened with flags ‘r’ is now
read-only. @ref{aa5,,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{1bbf,,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{9ef,,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{1cc,,datetime}, @ref{1cd,,date} and
@ref{1ce,,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{245,,sqlite3.Connection} now exposes a
@ref{b92,,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{2a,,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 Documentação<52>,Testes<55>,Biblioteca<137>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id681}@anchor{1bc0}
@subsubsection Documentação



@itemize -

@item 
bpo-21257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21257}: Document @ref{1bc1,,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{50,,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 Propostas de Melhorias do Python; 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{b2b,,asyncio.open_connection()},
@ref{b2c,,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 Propostas de Melhorias do Python; 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{130,,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{34b,,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{1a5,,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 Testes<55>,Construção<59>,Documentação<52>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id682}@anchor{1bc2}
@subsubsection Testes



@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{11,,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{254,,time.time()} with @ref{253,,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 Construção<59>,Windows<52>,Testes<55>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id683}@anchor{1bc3}
@subsubsection Construção



@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
@ref{1bc4,,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<52>,macOS<41>,Construção<59>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id684}@anchor{1bc5}
@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{417,,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{926,,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<41>,IDLE<41>,Windows<52>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id685}@anchor{1bc6}
@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<41>,Ferramentas/Demos<30>,macOS<41>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id686}@anchor{1bc7}
@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 variável de ambiente; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,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 Ferramentas/Demos<30>,API C<55>,IDLE<41>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id687}@anchor{1bc8}
@subsubsection Ferramentas/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 API C<55>,,Ferramentas/Demos<30>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id688}@anchor{1bc9}
@subsubsection API C



@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{1745,,_PyBytes_Resize()} for empty bytes objects.

@item 
bpo-35322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35322}: Fix memory leak in @ref{be3,,PyUnicode_EncodeLocale()} and
@ref{1bca,,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{56e,,Py_INCREF()}, @ref{56f,,Py_DECREF()}, @ref{a6e,,Py_XINCREF()},
@ref{78f,,Py_XDECREF()}, @ref{1acb,,PyObject_INIT()},
@ref{1acc,,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{d37,,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{16dc,,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{575,,SystemError} in
@ref{383,,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 @ref{1bcb,,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{1bcc,,PySequence_Size()},
@ref{1bcd,,PySequence_GetItem()}, @ref{1bce,,PySequence_SetItem()} and
@ref{1bcf,,PySequence_DelItem()} called with a mapping and
@ref{1bd0,,PyMapping_Size()} called with a sequence.

@item 
bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818}: @ref{a6f,,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{1bd1,,PyUnicode_AsWideChar()} and
@ref{8c1,,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,Changelog
@anchor{whatsnew/changelog python-3-7-0-final}@anchor{1bd2}
@subsection Python 3.7.0 final


`Data de lançamento: 2018-06-27'

@menu
* Biblioteca: Biblioteca<138>. 
* API C: API C<56>. 

@end menu

@node Biblioteca<138>,API C<56>,,Python 3 7 0 final
@anchor{whatsnew/changelog id689}@anchor{1bd3}
@subsubsection Biblioteca



@itemize -

@item 
bpo-33851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33851}: Fix @ref{1bd4,,ast.get_docstring()} for a node that lacks a
docstring.
@end itemize

@node API C<56>,,Biblioteca<138>,Python 3 7 0 final
@anchor{whatsnew/changelog id690}@anchor{1bd5}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-release-candidate-1}@anchor{1bd6}
@subsection Python 3.7.0 release candidate 1


`Data de lançamento: 2018-06-12'

@menu
* Núcleo e embutidos: Núcleo e embutidos<136>. 
* Biblioteca: Biblioteca<139>. 
* Documentação: Documentação<53>. 
* Construção: Construção<60>. 
* Windows: Windows<53>. 
* IDLE: IDLE<42>. 

@end menu

@node Núcleo e embutidos<136>,Biblioteca<139>,,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id691}@anchor{1bd7}
@subsubsection Núcleo e embutidos



@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 Biblioteca<139>,Documentação<53>,Núcleo e embutidos<136>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id692}@anchor{1bd8}
@subsubsection Biblioteca



@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{2c3,,TypeError} instead of @ref{575,,SystemError} when
performed on @ref{20b,,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 Documentação<53>,Construção<60>,Biblioteca<139>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id693}@anchor{1bd9}
@subsubsection Documentação



@itemize -

@item 
bpo-33409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33409}: Clarified the relationship between 
@geindex Propostas de Melhorias do Python; 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{b2b,,asyncio.open_connection()},
@ref{b2c,,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 Construção<60>,Windows<53>,Documentação<53>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id694}@anchor{1bda}
@subsubsection Construção



@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<53>,IDLE<42>,Construção<60>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id695}@anchor{1bdb}
@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<42>,,Windows<53>,Python 3 7 0 release candidate 1
@anchor{whatsnew/changelog id696}@anchor{1bdc}
@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-beta-5}@anchor{1bdd}
@subsection Python 3.7.0 beta 5


`Data de lançamento: 2018-05-30'

@menu
* Núcleo e embutidos: Núcleo e embutidos<137>. 
* Biblioteca: Biblioteca<140>. 
* Documentação: Documentação<54>. 
* Testes: Testes<56>. 
* Construção: Construção<61>. 
* macOS: macOS<42>. 
* IDLE: IDLE<43>. 

@end menu

@node Núcleo e embutidos<137>,Biblioteca<140>,,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id697}@anchor{1bde}
@subsubsection Núcleo e embutidos



@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{1201,,gc.garbage} list. @ref{995,,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 Biblioteca<140>,Documentação<54>,Núcleo e embutidos<137>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id698}@anchor{1bdf}
@subsubsection Biblioteca



@itemize -

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: When cancelling the task due to a timeout,
@ref{5ff,,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{bc0,,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{2a,,ctypes}.  Patch by Segev Finer.
@end itemize

@node Documentação<54>,Testes<56>,Biblioteca<140>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id699}@anchor{1be0}
@subsubsection Documentação



@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 Propostas de Melhorias do Python; 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 Testes<56>,Construção<61>,Documentação<54>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id700}@anchor{1be1}
@subsubsection Testes



@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 Construção<61>,macOS<42>,Testes<56>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id701}@anchor{1be2}
@subsubsection Construção



@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<42>,IDLE<43>,Construção<61>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id702}@anchor{1be3}
@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<43>,,macOS<42>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id703}@anchor{1be4}
@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-beta-4}@anchor{1be5}
@subsection Python 3.7.0 beta 4


`Data de lançamento: 2018-05-02'

@menu
* Núcleo e embutidos: Núcleo e embutidos<138>. 
* Biblioteca: Biblioteca<141>. 
* Documentação: Documentação<55>. 
* Testes: Testes<57>. 
* Construção: Construção<62>. 
* Windows: Windows<54>. 
* macOS: macOS<43>. 
* IDLE: IDLE<44>. 
* Ferramentas/Demos: Ferramentas/Demos<31>. 

@end menu

@node Núcleo e embutidos<138>,Biblioteca<141>,,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id704}@anchor{1be6}
@subsubsection Núcleo e embutidos



@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 shrinked only when
@code{used == 0}. Now dict has more chance to be shrinked.

@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 Biblioteca<141>,Documentação<55>,Núcleo e embutidos<138>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id705}@anchor{1be7}
@subsubsection Biblioteca



@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{34,,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{1bbb,,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{1f2,,importlib.resources.contents()} and
@ref{1bbc,,importlib.abc.ResourceReader.contents()} return an @ref{1268,,iterable}
instead of an @ref{1ac,,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{5e1,,-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{3b4,,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{5e4,,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{2c3,,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 Propostas de Melhorias do Python; 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{1bbd,,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{220,,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 Documentação<55>,Testes<57>,Biblioteca<141>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id706}@anchor{1be8}
@subsubsection Documentação



@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 Testes<57>,Construção<62>,Documentação<55>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id707}@anchor{1be9}
@subsubsection Testes



@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 Construção<62>,Windows<54>,Testes<57>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id708}@anchor{1bea}
@subsubsection Construção



@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<54>,macOS<43>,Construção<62>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id709}@anchor{1beb}
@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<43>,IDLE<44>,Windows<54>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id710}@anchor{1bec}
@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<44>,Ferramentas/Demos<31>,macOS<43>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id711}@anchor{1bed}
@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 Ferramentas/Demos<31>,,IDLE<44>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id712}@anchor{1bee}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-7-0-beta-3}@anchor{1bef}
@subsection Python 3.7.0 beta 3


`Data de lançamento: 2018-03-29'

@menu
* Segurança: Segurança<43>. 
* Núcleo e embutidos: Núcleo e embutidos<139>. 
* Biblioteca: Biblioteca<142>. 
* Documentação: Documentação<56>. 
* Testes: Testes<58>. 
* Construção: Construção<63>. 
* Windows: Windows<55>. 
* macOS: macOS<44>. 
* IDLE: IDLE<45>. 
* Ferramentas/Demos: Ferramentas/Demos<32>. 
* API C: API C<57>. 

@end menu

@node Segurança<43>,Núcleo e embutidos<139>,,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id713}@anchor{1bf0}
@subsubsection Segurança



@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 Núcleo e embutidos<139>,Biblioteca<142>,Segurança<43>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id714}@anchor{1bf1}
@subsubsection Núcleo e embutidos



@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 Biblioteca<142>,Documentação<56>,Núcleo e embutidos<139>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id715}@anchor{1bf2}
@subsubsection Biblioteca



@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{202,,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{245,,sqlite3.Connection} now exposes a
@ref{b92,,backup} method, if the underlying SQLite
library is at version 3.6.11 or higher.  Patch by Lele Gaifax.
@end itemize

@node Documentação<56>,Testes<58>,Biblioteca<142>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id716}@anchor{1bf3}
@subsubsection Documentação



@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{130,,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 Testes<58>,Construção<63>,Documentação<56>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id717}@anchor{1bf4}
@subsubsection Testes



@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 Construção<63>,Windows<55>,Testes<58>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id718}@anchor{1bf5}
@subsubsection Construção



@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<55>,macOS<44>,Construção<63>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id719}@anchor{1bf6}
@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<44>,IDLE<45>,Windows<55>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id720}@anchor{1bf7}
@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<45>,Ferramentas/Demos<32>,macOS<44>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id721}@anchor{1bf8}
@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 variável de ambiente; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,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 Ferramentas/Demos<32>,API C<57>,IDLE<45>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id722}@anchor{1bf9}
@subsubsection Ferramentas/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 API C<57>,,Ferramentas/Demos<32>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id723}@anchor{1bfa}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-beta-2}@anchor{1bfb}
@subsection Python 3.7.0 beta 2


`Data de lançamento: 2018-02-27'

@menu
* Segurança: Segurança<44>. 
* Núcleo e embutidos: Núcleo e embutidos<140>. 
* Biblioteca: Biblioteca<143>. 
* Documentação: Documentação<57>. 
* Testes: Testes<59>. 
* Construção: Construção<64>. 
* Windows: Windows<56>. 
* macOS: macOS<45>. 
* IDLE: IDLE<46>. 
* Ferramentas/Demos: Ferramentas/Demos<33>. 

@end menu

@node Segurança<44>,Núcleo e embutidos<140>,,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id724}@anchor{1bfc}
@subsubsection Segurança



@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 Núcleo e embutidos<140>,Biblioteca<143>,Segurança<44>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id725}@anchor{1bfd}
@subsubsection Núcleo e embutidos



@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 Biblioteca<143>,Documentação<57>,Núcleo e embutidos<140>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id726}@anchor{1bfe}
@subsubsection Biblioteca



@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{1a5,,DeprecationWarning} when using or importing an ABC
directly from @ref{1d,,collections} rather than from @ref{1e,,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{1bbe,,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 Documentação<57>,Testes<59>,Biblioteca<143>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id727}@anchor{1bff}
@subsubsection Documentação



@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{34b,,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{1a5,,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 Testes<59>,Construção<64>,Documentação<57>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id728}@anchor{1c00}
@subsubsection Testes



@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 Construção<64>,Windows<56>,Testes<59>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id729}@anchor{1c01}
@subsubsection Construção



@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<56>,macOS<45>,Construção<64>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id730}@anchor{1c02}
@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{926,,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<45>,IDLE<46>,Windows<56>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id731}@anchor{1c03}
@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<46>,Ferramentas/Demos<33>,macOS<45>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id732}@anchor{1c04}
@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 Ferramentas/Demos<33>,,IDLE<46>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id733}@anchor{1c05}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-7-0-beta-1}@anchor{1c06}
@subsection Python 3.7.0 beta 1


`Data de lançamento: 2018-01-30'

@menu
* Núcleo e embutidos: Núcleo e embutidos<141>. 
* Biblioteca: Biblioteca<144>. 
* Documentação: Documentação<58>. 
* Testes: Testes<60>. 
* Construção: Construção<65>. 
* Windows: Windows<57>. 
* macOS: macOS<46>. 
* API C: API C<58>. 

@end menu

@node Núcleo e embutidos<141>,Biblioteca<144>,,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id734}@anchor{1c07}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Biblioteca<144>,Documentação<58>,Núcleo e embutidos<141>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id735}@anchor{1c08}
@subsubsection Biblioteca



@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{1509,,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{b1e,,asyncio.StreamWriter.wait_closed()} and
@ref{b1f,,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 Propostas de Melhorias do Python; 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 cancelation 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{4ed,,datetime.datetime.fromtimestamp()} did not
call __new__ in @ref{1cc,,datetime.datetime} subclasses.

@item 
bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403}: Improved speed of @ref{1cd,,datetime.date} and
@ref{1cc,,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{b10,,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{c02,,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{2a0,,path-like object}. If `args' is given
as a sequence, it’s first element can now be a @ref{2a0,,path-like object} as
well.

@item 
bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}: The @ref{c18,,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{621,,str.format()} method when formatting a number
(@ref{257,,int}, @ref{2f7,,float}, @ref{2f7,,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 Documentação<58>,Testes<60>,Biblioteca<144>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id736}@anchor{1c09}
@subsubsection Documentação



@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 Testes<60>,Construção<65>,Documentação<58>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id737}@anchor{1c0a}
@subsubsection Testes



@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 Construção<65>,Windows<57>,Testes<60>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id738}@anchor{1c0b}
@subsubsection Construção



@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 variável de ambiente; 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<57>,macOS<46>,Construção<65>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id739}@anchor{1c0c}
@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<46>,API C<58>,Windows<57>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id740}@anchor{1c0d}
@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 API C<58>,,macOS<46>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id741}@anchor{1c0e}
@subsubsection API C



@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.timzone.UTC} singleton.
@end itemize

@node Python 3 7 0 alpha 4,Python 3 7 0 alpha 3,Python 3 7 0 beta 1,Changelog
@anchor{whatsnew/changelog python-3-7-0-alpha-4}@anchor{1c0f}
@subsection Python 3.7.0 alpha 4


`Data de lançamento: 2018-01-08'

@menu
* Núcleo e embutidos: Núcleo e embutidos<142>. 
* Biblioteca: Biblioteca<145>. 
* Documentação: Documentação<59>. 
* Testes: Testes<61>. 
* Windows: Windows<58>. 
* Ferramentas/Demos: Ferramentas/Demos<34>. 
* API C: API C<59>. 

@end menu

@node Núcleo e embutidos<142>,Biblioteca<145>,,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id742}@anchor{1c10}
@subsubsection Núcleo e embutidos



@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{1c11,,-R} option now turns on hash randomization when
the 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Biblioteca<145>,Documentação<59>,Núcleo e embutidos<142>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id743}@anchor{1c12}
@subsubsection Biblioteca



@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{b10,,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{d61,,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{2a3,,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 ouput.
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{617,,datetime.datetime.fromisoformat()},
@ref{616,,datetime.time.fromisoformat()} and
@ref{615,,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{8f4,,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 Documentação<59>,Testes<61>,Biblioteca<145>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id744}@anchor{1c13}
@subsubsection Documentação



@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 Testes<61>,Windows<58>,Documentação<59>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id745}@anchor{1c14}
@subsubsection Testes



@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<58>,Ferramentas/Demos<34>,Testes<61>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id746}@anchor{1c15}
@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 Ferramentas/Demos<34>,API C<59>,Windows<58>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id747}@anchor{1c16}
@subsubsection Ferramentas/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 API C<59>,,Ferramentas/Demos<34>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id748}@anchor{1c17}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-alpha-3}@anchor{1c18}
@subsection Python 3.7.0 alpha 3


`Data de lançamento: 2017-12-05'

@menu
* Núcleo e embutidos: Núcleo e embutidos<143>. 
* Biblioteca: Biblioteca<146>. 
* Documentação: Documentação<60>. 
* Testes: Testes<62>. 
* Construção: Construção<66>. 
* Windows: Windows<59>. 
* macOS: macOS<47>. 
* IDLE: IDLE<47>. 
* Ferramentas/Demos: Ferramentas/Demos<35>. 
* API C: API C<60>. 

@end menu

@node Núcleo e embutidos<143>,Biblioteca<146>,,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id749}@anchor{1c19}
@subsubsection Núcleo e embutidos



@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 Biblioteca<146>,Documentação<60>,Núcleo e embutidos<143>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id750}@anchor{1c1a}
@subsubsection Biblioteca



@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{1c1b,,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{c10,,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{a1e,,os.path.expanduser()} to find the @code{~/.netrc} file in
@ref{1a05,,netrc.netrc}.  If it does not exist, @ref{42b,,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{1ca,,collections.namedtuple()} in the
@ref{1c1c,,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{1a5,,DeprecationWarning}, @ref{8ce,,PendingDeprecationWarning} and
@ref{4fa,,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 Propostas de Melhorias do Python; 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{2a0,,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{1c1d,,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{ba6,,time.CLOCK_BOOTTIME},
@ref{ba7,,time.CLOCK_PROF} and @ref{ba8,,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{1c1e,,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 Propostas de Melhorias do Python; 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{1ff,,ipaddress.IPv6Network} and @ref{1fe,,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 Propostas de Melhorias do Python; 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{af4,,clock_gettime_ns()}, @ref{af5,,clock_settime_ns()},
@ref{af6,,monotonic_ns()}, @ref{af7,,perf_counter_ns()},
@ref{af8,,process_time_ns()}, @ref{af9,,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{14b0,,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{906,,http.HTTPStatus}. Patch by Vitor Pereira.
@end itemize

@node Documentação<60>,Testes<62>,Biblioteca<146>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id751}@anchor{1c1f}
@subsubsection Documentação



@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 Testes<62>,Construção<66>,Documentação<60>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id752}@anchor{1c20}
@subsubsection Testes



@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 Construção<66>,Windows<59>,Testes<62>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id753}@anchor{1c21}
@subsubsection Construção



@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<59>,macOS<47>,Construção<66>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id754}@anchor{1c22}
@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<47>,IDLE<47>,Windows<59>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id755}@anchor{1c23}
@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<47>,Ferramentas/Demos<35>,macOS<47>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id756}@anchor{1c24}
@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 Ferramentas/Demos<35>,API C<60>,IDLE<47>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id757}@anchor{1c25}
@subsubsection Ferramentas/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 API C<60>,,Ferramentas/Demos<35>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id758}@anchor{1c26}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-7-0-alpha-2}@anchor{1c27}
@subsection Python 3.7.0 alpha 2


`Data de lançamento: 2017-10-16'

@menu
* Núcleo e embutidos: Núcleo e embutidos<144>. 
* Biblioteca: Biblioteca<147>. 
* Documentação: Documentação<61>. 
* Construção: Construção<67>. 
* IDLE: IDLE<48>. 
* API C: API C<61>. 

@end menu

@node Núcleo e embutidos<144>,Biblioteca<147>,,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id759}@anchor{1c28}
@subsubsection Núcleo e embutidos



@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 variável de ambiente; PYTHONPROFILEIMPORTTIME
@ref{b08,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@end itemize

@node Biblioteca<147>,Documentação<61>,Núcleo e embutidos<144>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id760}@anchor{1c29}
@subsubsection Biblioteca



@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{8f4,,concurrent.futures.ProcessPoolExecutor} constructor. Also, free
job resources in @ref{8f4,,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 Documentação<61>,Construção<67>,Biblioteca<147>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id761}@anchor{1c2a}
@subsubsection Documentação



@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 Construção<67>,IDLE<48>,Documentação<61>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id762}@anchor{1c2b}
@subsubsection Construção



@itemize -

@item 
bpo-31696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31696}: Improve compiler version information in @ref{178,,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<48>,API C<61>,Construção<67>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id763}@anchor{1c2c}
@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 API C<61>,,IDLE<48>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id764}@anchor{1c2d}
@subsubsection API C



@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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-7-0-alpha-1}@anchor{1c2e}
@subsection Python 3.7.0 alpha 1


`Data de lançamento: 2017-09-19'

@menu
* Segurança: Segurança<45>. 
* Núcleo e embutidos: Núcleo e embutidos<145>. 
* Biblioteca: Biblioteca<148>. 
* Documentação: Documentação<62>. 
* Testes: Testes<63>. 
* Construção: Construção<68>. 
* Windows: Windows<60>. 
* IDLE: IDLE<49>. 
* Ferramentas/Demos: Ferramentas/Demos<36>. 
* API C: API C<62>. 

@end menu

@node Segurança<45>,Núcleo e embutidos<145>,,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id765}@anchor{1c2f}
@subsubsection Segurança



@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 Núcleo e embutidos<145>,Biblioteca<148>,Segurança<45>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id766}@anchor{1c30}
@subsubsection Núcleo e embutidos



@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 libray 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 Propostas de Melhorias do Python; 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{885,,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 Propostas de Melhorias do Python; 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{1546,,sys.setprofile()} function,
@ref{27,,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 splitted 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 Biblioteca<148>,Documentação<62>,Núcleo e embutidos<145>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id767}@anchor{1c31}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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{44c,,str} instead of
@ref{1c2,,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}: Addded 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 Documentação<62>,Testes<63>,Biblioteca<148>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id768}@anchor{1c32}
@subsubsection Documentação



@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{1c2,,bytes()} and @ref{2ea,,bytearray()} are
now their respective type definitions, rather than the corresponding
builtin function entries. Use @ref{1c33,,bytes} and
@ref{1c34,,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 Propostas de Melhorias do Python; 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 Testes<63>,Construção<68>,Documentação<62>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id769}@anchor{1c35}
@subsubsection Testes



@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 Construção<68>,Windows<60>,Testes<63>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id770}@anchor{1c36}
@subsubsection Construção



@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 Propostas de Melhorias do Python; 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<60>,IDLE<49>,Construção<68>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id771}@anchor{1c37}
@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<49>,Ferramentas/Demos<36>,Windows<60>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id772}@anchor{1c38}
@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 Ferramentas/Demos<36>,API C<62>,IDLE<49>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id773}@anchor{1c39}
@subsubsection Ferramentas/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 Propostas de Melhorias do Python; 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 API C<62>,,Ferramentas/Demos<36>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id774}@anchor{1c3a}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-6-6-final}@anchor{1c3b}
@subsection Python 3.6.6 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-6-6-release-candidate-1}@anchor{1c3c}
@subsection Python 3.6.6 release candidate 1


`Data de lançamento: 2018-06-11'

@menu
* Núcleo e embutidos: Núcleo e embutidos<146>. 
* Biblioteca: Biblioteca<149>. 
* Documentação: Documentação<63>. 
* Testes: Testes<64>. 
* Construção: Construção<69>. 
* Windows: Windows<61>. 
* macOS: macOS<48>. 
* IDLE: IDLE<50>. 
* Ferramentas/Demos: Ferramentas/Demos<37>. 
* API C: API C<63>. 

@end menu

@node Núcleo e embutidos<146>,Biblioteca<149>,,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id775}@anchor{1c3d}
@subsubsection Núcleo e embutidos



@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{1201,,gc.garbage} list. @ref{995,,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 Biblioteca<149>,Documentação<63>,Núcleo e embutidos<146>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id776}@anchor{1c3e}
@subsubsection Biblioteca



@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{2c3,,TypeError} instead of @ref{575,,SystemError} when
performed on @ref{20b,,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{34,,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{1bbb,,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 Propostas de Melhorias do Python; 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{1bbd,,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{2a,,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 Documentação<63>,Testes<64>,Biblioteca<149>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id777}@anchor{1c3f}
@subsubsection Documentação



@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{130,,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 Testes<64>,Construção<69>,Documentação<63>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id778}@anchor{1c40}
@subsubsection Testes



@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 Construção<69>,Windows<61>,Testes<64>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id779}@anchor{1c41}
@subsubsection Construção



@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<61>,macOS<48>,Construção<69>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id780}@anchor{1c42}
@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<48>,IDLE<50>,Windows<61>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id781}@anchor{1c43}
@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<50>,Ferramentas/Demos<37>,macOS<48>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id782}@anchor{1c44}
@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 Ferramentas/Demos<37>,API C<63>,IDLE<50>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id783}@anchor{1c45}
@subsubsection Ferramentas/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 API C<63>,,Ferramentas/Demos<37>,Python 3 6 6 release candidate 1
@anchor{whatsnew/changelog id784}@anchor{1c46}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-6-5-final}@anchor{1c47}
@subsection Python 3.6.5 final


`Data de lançamento: 2018-03-28'

@menu
* Testes: Testes<65>. 
* Construção: Construção<70>. 

@end menu

@node Testes<65>,Construção<70>,,Python 3 6 5 final
@anchor{whatsnew/changelog id785}@anchor{1c48}
@subsubsection Testes



@itemize -

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: Avoid regrtest compatibility issue with namespace packages.
@end itemize

@node Construção<70>,,Testes<65>,Python 3 6 5 final
@anchor{whatsnew/changelog id786}@anchor{1c49}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-5-release-candidate-1}@anchor{1c4a}
@subsection Python 3.6.5 release candidate 1


`Data de lançamento: 2018-03-13'

@menu
* Segurança: Segurança<46>. 
* Núcleo e embutidos: Núcleo e embutidos<147>. 
* Biblioteca: Biblioteca<150>. 
* Documentação: Documentação<64>. 
* Testes: Testes<66>. 
* Construção: Construção<71>. 
* Windows: Windows<62>. 
* macOS: macOS<49>. 
* IDLE: IDLE<51>. 
* Ferramentas/Demos: Ferramentas/Demos<38>. 
* API C: API C<64>. 

@end menu

@node Segurança<46>,Núcleo e embutidos<147>,,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id787}@anchor{1c4b}
@subsubsection Segurança



@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 Núcleo e embutidos<147>,Biblioteca<150>,Segurança<46>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id788}@anchor{1c4c}
@subsubsection Núcleo e embutidos



@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 Biblioteca<150>,Documentação<64>,Núcleo e embutidos<147>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id789}@anchor{1c4d}
@subsubsection Biblioteca



@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{202,,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{d61,,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{c18,,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{621,,str.format()} method when formatting a number
(@ref{257,,int}, @ref{2f7,,float}, @ref{2f7,,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 Documentação<64>,Testes<66>,Biblioteca<150>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id790}@anchor{1c4e}
@subsubsection Documentação



@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{34b,,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{1a5,,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 Testes<66>,Construção<71>,Documentação<64>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id791}@anchor{1c4f}
@subsubsection Testes



@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 Construção<71>,Windows<62>,Testes<66>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id792}@anchor{1c50}
@subsubsection Construção



@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<62>,macOS<49>,Construção<71>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id793}@anchor{1c51}
@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{926,,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<49>,IDLE<51>,Windows<62>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id794}@anchor{1c52}
@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<51>,Ferramentas/Demos<38>,macOS<49>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id795}@anchor{1c53}
@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 variável de ambiente; IDLESTARTUP
@code{IDLESTARTUP} or
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,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 Ferramentas/Demos<38>,API C<64>,IDLE<51>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id796}@anchor{1c54}
@subsubsection Ferramentas/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 API C<64>,,Ferramentas/Demos<38>,Python 3 6 5 release candidate 1
@anchor{whatsnew/changelog id797}@anchor{1c55}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-6-4-final}@anchor{1c56}
@subsection Python 3.6.4 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-6-4-release-candidate-1}@anchor{1c57}
@subsection Python 3.6.4 release candidate 1


`Data de lançamento: 2017-12-05'

@menu
* Núcleo e embutidos: Núcleo e embutidos<148>. 
* Biblioteca: Biblioteca<151>. 
* Documentação: Documentação<65>. 
* Testes: Testes<67>. 
* Construção: Construção<72>. 
* Windows: Windows<63>. 
* macOS: macOS<50>. 
* IDLE: IDLE<52>. 
* Ferramentas/Demos: Ferramentas/Demos<39>. 
* API C: API C<65>. 

@end menu

@node Núcleo e embutidos<148>,Biblioteca<151>,,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id798}@anchor{1c58}
@subsubsection Núcleo e embutidos



@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 Biblioteca<151>,Documentação<65>,Núcleo e embutidos<148>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id799}@anchor{1c59}
@subsubsection Biblioteca



@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{1ca,,collections.namedtuple()} in the
@ref{1c1c,,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 Documentação<65>,Testes<67>,Biblioteca<151>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id800}@anchor{1c5a}
@subsubsection Documentação



@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 Testes<67>,Construção<72>,Documentação<65>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id801}@anchor{1c5b}
@subsubsection Testes



@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 Construção<72>,Windows<63>,Testes<67>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id802}@anchor{1c5c}
@subsubsection Construção



@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<63>,macOS<50>,Construção<72>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id803}@anchor{1c5d}
@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<50>,IDLE<52>,Windows<63>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id804}@anchor{1c5e}
@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<52>,Ferramentas/Demos<39>,macOS<50>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id805}@anchor{1c5f}
@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 Ferramentas/Demos<39>,API C<65>,IDLE<52>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id806}@anchor{1c60}
@subsubsection Ferramentas/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 API C<65>,,Ferramentas/Demos<39>,Python 3 6 4 release candidate 1
@anchor{whatsnew/changelog id807}@anchor{1c61}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-6-3-final}@anchor{1c62}
@subsection Python 3.6.3 final


`Data de lançamento: 2017-10-03'

@menu
* Biblioteca: Biblioteca<152>. 
* Construção: Construção<73>. 

@end menu

@node Biblioteca<152>,Construção<73>,,Python 3 6 3 final
@anchor{whatsnew/changelog id808}@anchor{1c63}
@subsubsection Biblioteca



@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 Construção<73>,,Biblioteca<152>,Python 3 6 3 final
@anchor{whatsnew/changelog id809}@anchor{1c64}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-3-release-candidate-1}@anchor{1c65}
@subsection Python 3.6.3 release candidate 1


`Data de lançamento: 2017-09-18'

@menu
* Segurança: Segurança<47>. 
* Núcleo e embutidos: Núcleo e embutidos<149>. 
* Biblioteca: Biblioteca<153>. 
* Documentação: Documentação<66>. 
* Testes: Testes<68>. 
* Construção: Construção<74>. 
* Windows: Windows<64>. 
* IDLE: IDLE<53>. 
* Ferramentas/Demos: Ferramentas/Demos<40>. 

@end menu

@node Segurança<47>,Núcleo e embutidos<149>,,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id810}@anchor{1c66}
@subsubsection Segurança



@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 Núcleo e embutidos<149>,Biblioteca<153>,Segurança<47>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id811}@anchor{1c67}
@subsubsection Núcleo e embutidos



@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 libray 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 Biblioteca<153>,Documentação<66>,Núcleo e embutidos<149>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id812}@anchor{1c68}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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 Documentação<66>,Testes<68>,Biblioteca<153>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id813}@anchor{1c69}
@subsubsection Documentação



@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 Testes<68>,Construção<74>,Documentação<66>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id814}@anchor{1c6a}
@subsubsection Testes



@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 Construção<74>,Windows<64>,Testes<68>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id815}@anchor{1c6b}
@subsubsection Construção



@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<64>,IDLE<53>,Construção<74>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id816}@anchor{1c6c}
@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<53>,Ferramentas/Demos<40>,Windows<64>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id817}@anchor{1c6d}
@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 Ferramentas/Demos<40>,,IDLE<53>,Python 3 6 3 release candidate 1
@anchor{whatsnew/changelog id818}@anchor{1c6e}
@subsubsection Ferramentas/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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-6-2-final}@anchor{1c6f}
@subsection Python 3.6.2 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-6-2-release-candidate-2}@anchor{1c70}
@subsection Python 3.6.2 release candidate 2


`Data de lançamento: 2017-07-07'

@menu
* Segurança: Segurança<48>. 

@end menu

@node Segurança<48>,,,Python 3 6 2 release candidate 2
@anchor{whatsnew/changelog id819}@anchor{1c71}
@subsubsection Segurança



@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,Changelog
@anchor{whatsnew/changelog python-3-6-2-release-candidate-1}@anchor{1c72}
@subsection Python 3.6.2 release candidate 1


`Data de lançamento: 2017-06-17'

@menu
* Segurança: Segurança<49>. 
* Núcleo e embutidos: Núcleo e embutidos<150>. 
* Biblioteca: Biblioteca<154>. 
* IDLE: IDLE<54>. 
* API C: API C<66>. 
* Construção: Construção<75>. 
* Documentação: Documentação<67>. 
* Ferramentas/Demos: Ferramentas/Demos<41>. 
* Testes: Testes<69>. 
* Windows: Windows<65>. 

@end menu

@node Segurança<49>,Núcleo e embutidos<150>,,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id820}@anchor{1c73}
@subsubsection Segurança



@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 Núcleo e embutidos<150>,Biblioteca<154>,Segurança<49>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id821}@anchor{1c74}
@subsubsection Núcleo e embutidos



@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{885,,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 Biblioteca<154>,IDLE<54>,Núcleo e embutidos<150>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id822}@anchor{1c75}
@subsubsection Biblioteca



@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<54>,API C<66>,Biblioteca<154>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id823}@anchor{1c76}
@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 API C<66>,Construção<75>,IDLE<54>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id824}@anchor{1c77}
@subsubsection API C



@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 Construção<75>,Documentação<67>,API C<66>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id825}@anchor{1c78}
@subsubsection Construção



@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 Documentação<67>,Ferramentas/Demos<41>,Construção<75>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id826}@anchor{1c79}
@subsubsection Documentação



@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{1c2,,bytes()} and @ref{2ea,,bytearray()} are
now their respective type definitions, rather than the corresponding
builtin function entries. Use @ref{1c33,,bytes} and
@ref{1c34,,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 Ferramentas/Demos<41>,Testes<69>,Documentação<67>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id827}@anchor{1c7a}
@subsubsection Ferramentas/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 Testes<69>,Windows<65>,Ferramentas/Demos<41>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id828}@anchor{1c7b}
@subsubsection Testes



@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<65>,,Testes<69>,Python 3 6 2 release candidate 1
@anchor{whatsnew/changelog id829}@anchor{1c7c}
@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,Changelog
@anchor{whatsnew/changelog python-3-6-1-final}@anchor{1c7d}
@subsection Python 3.6.1 final


`Data de lançamento: 2017-03-21'

@menu
* Núcleo e embutidos: Núcleo e embutidos<151>. 
* Construção: Construção<76>. 

@end menu

@node Núcleo e embutidos<151>,Construção<76>,,Python 3 6 1 final
@anchor{whatsnew/changelog id830}@anchor{1c7e}
@subsubsection Núcleo e embutidos



@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 Construção<76>,,Núcleo e embutidos<151>,Python 3 6 1 final
@anchor{whatsnew/changelog id831}@anchor{1c7f}
@subsubsection Construção



@itemize -

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: fix format of git information used in sys.version

@item 
Corrigir comentário incompatível em python.h
@end itemize

@node Python 3 6 1 release candidate 1,Python 3 6 0 final,Python 3 6 1 final,Changelog
@anchor{whatsnew/changelog python-3-6-1-release-candidate-1}@anchor{1c80}
@subsection Python 3.6.1 release candidate 1


`Data de lançamento: 2017-03-04'

@menu
* Núcleo e embutidos: Núcleo e embutidos<152>. 
* Biblioteca: Biblioteca<155>. 
* IDLE: IDLE<55>. 
* Windows: Windows<66>. 
* API C: API C<67>. 
* Documentação: Documentação<68>. 
* Testes: Testes<70>. 
* Construção: Construção<77>. 

@end menu

@node Núcleo e embutidos<152>,Biblioteca<155>,,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id832}@anchor{1c81}
@subsubsection Núcleo e embutidos



@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 Biblioteca<155>,IDLE<55>,Núcleo e embutidos<152>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id833}@anchor{1c82}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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<55>,Windows<66>,Biblioteca<155>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id834}@anchor{1c83}
@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<66>,API C<67>,IDLE<55>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id835}@anchor{1c84}
@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 Propostas de Melhorias do Python; 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 API C<67>,Documentação<68>,Windows<66>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id836}@anchor{1c85}
@subsubsection API C



@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 Documentação<68>,Testes<70>,API C<67>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id837}@anchor{1c86}
@subsubsection Documentação



@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 Testes<70>,Construção<77>,Documentação<68>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id838}@anchor{1c87}
@subsubsection Testes



@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 Construção<77>,,Testes<70>,Python 3 6 1 release candidate 1
@anchor{whatsnew/changelog id839}@anchor{1c88}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-final}@anchor{1c89}
@subsection Python 3.6.0 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-6-0-release-candidate-2}@anchor{1c8a}
@subsection Python 3.6.0 release candidate 2


`Data de lançamento: 2016-12-16'

@menu
* Núcleo e embutidos: Núcleo e embutidos<153>. 
* Ferramentas/Demos: Ferramentas/Demos<42>. 
* Windows: Windows<67>. 
* Construção: Construção<78>. 

@end menu

@node Núcleo e embutidos<153>,Ferramentas/Demos<42>,,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id840}@anchor{1c8b}
@subsubsection Núcleo e embutidos



@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 Ferramentas/Demos<42>,Windows<67>,Núcleo e embutidos<153>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id841}@anchor{1c8c}
@subsubsection Ferramentas/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<67>,Construção<78>,Ferramentas/Demos<42>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id842}@anchor{1c8d}
@subsubsection Windows



@itemize -

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: Deprecate WindowsRegistryFinder.
@end itemize

@node Construção<78>,,Windows<67>,Python 3 6 0 release candidate 2
@anchor{whatsnew/changelog id843}@anchor{1c8e}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-release-candidate-1}@anchor{1c8f}
@subsection Python 3.6.0 release candidate 1


`Data de lançamento: 2016-12-06'

@menu
* Núcleo e embutidos: Núcleo e embutidos<154>. 
* Biblioteca: Biblioteca<156>. 
* API C: API C<68>. 
* Documentação: Documentação<69>. 
* Ferramentas/Demos: Ferramentas/Demos<43>. 

@end menu

@node Núcleo e embutidos<154>,Biblioteca<156>,,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id844}@anchor{1c90}
@subsubsection Núcleo e embutidos



@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 Biblioteca<156>,API C<68>,Núcleo e embutidos<154>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id845}@anchor{1c91}
@subsubsection Biblioteca



@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 API C<68>,Documentação<69>,Biblioteca<156>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id846}@anchor{1c92}
@subsubsection API C



@itemize -

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() now never raises exceptions.
@end itemize

@node Documentação<69>,Ferramentas/Demos<43>,API C<68>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id847}@anchor{1c93}
@subsubsection Documentação



@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 Propostas de Melhorias do Python; PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} and zero-argument
@code{super()}.
@end itemize

@node Ferramentas/Demos<43>,,Documentação<69>,Python 3 6 0 release candidate 1
@anchor{whatsnew/changelog id848}@anchor{1c94}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-6-0-beta-4}@anchor{1c95}
@subsection Python 3.6.0 beta 4


`Data de lançamento: 2016-11-21'

@menu
* Núcleo e embutidos: Núcleo e embutidos<155>. 
* Biblioteca: Biblioteca<157>. 
* Documentação: Documentação<70>. 
* Testes: Testes<71>. 
* Construção: Construção<79>. 

@end menu

@node Núcleo e embutidos<155>,Biblioteca<157>,,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id849}@anchor{1c96}
@subsubsection Núcleo e embutidos



@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 Biblioteca<157>,Documentação<70>,Núcleo e embutidos<155>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id850}@anchor{1c97}
@subsubsection Biblioteca



@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 Documentação<70>,Testes<71>,Biblioteca<157>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id851}@anchor{1c98}
@subsubsection Documentação



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: Documented command-line interface of zipfile.
@end itemize

@node Testes<71>,Construção<79>,Documentação<70>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id852}@anchor{1c99}
@subsubsection Testes



@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 Construção<79>,,Testes<71>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id853}@anchor{1c9a}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-beta-3}@anchor{1c9b}
@subsection Python 3.6.0 beta 3


`Data de lançamento: 2016-10-31'

@menu
* Núcleo e embutidos: Núcleo e embutidos<156>. 
* Biblioteca: Biblioteca<158>. 
* Windows: Windows<68>. 
* Construção: Construção<80>. 
* Testes: Testes<72>. 

@end menu

@node Núcleo e embutidos<156>,Biblioteca<158>,,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id854}@anchor{1c9c}
@subsubsection Núcleo e embutidos



@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 Biblioteca<158>,Windows<68>,Núcleo e embutidos<156>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id855}@anchor{1c9d}
@subsubsection Biblioteca



@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<68>,Construção<80>,Biblioteca<158>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id856}@anchor{1c9e}
@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 Construção<80>,Testes<72>,Windows<68>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id857}@anchor{1c9f}
@subsubsection Construção



@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 Testes<72>,,Construção<80>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id858}@anchor{1ca0}
@subsubsection Testes



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-beta-2}@anchor{1ca1}
@subsection Python 3.6.0 beta 2


`Data de lançamento: 2016-10-10'

@menu
* Núcleo e embutidos: Núcleo e embutidos<157>. 
* Biblioteca: Biblioteca<159>. 
* Windows: Windows<69>. 
* API C: API C<69>. 
* Construção: Construção<81>. 
* Testes: Testes<73>. 

@end menu

@node Núcleo e embutidos<157>,Biblioteca<159>,,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id859}@anchor{1ca2}
@subsubsection Núcleo e embutidos



@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 splitted 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 Biblioteca<159>,Windows<69>,Núcleo e embutidos<157>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id860}@anchor{1ca3}
@subsubsection Biblioteca



@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<69>,API C<69>,Biblioteca<159>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id861}@anchor{1ca4}
@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 API C<69>,Construção<81>,Windows<69>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id862}@anchor{1ca5}
@subsubsection API C



@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 Construção<81>,Testes<73>,API C<69>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id863}@anchor{1ca6}
@subsubsection Construção



@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 Testes<73>,,Construção<81>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id864}@anchor{1ca7}
@subsubsection Testes



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-beta-1}@anchor{1ca8}
@subsection Python 3.6.0 beta 1


`Data de lançamento: 2016-09-12'

@menu
* Núcleo e embutidos: Núcleo e embutidos<158>. 
* Biblioteca: Biblioteca<160>. 
* IDLE: IDLE<56>. 
* API C: API C<70>. 
* Testes: Testes<74>. 
* Construção: Construção<82>. 
* Ferramentas/Demos: Ferramentas/Demos<44>. 
* Windows: Windows<70>. 

@end menu

@node Núcleo e embutidos<158>,Biblioteca<160>,,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id865}@anchor{1ca9}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Biblioteca<160>,IDLE<56>,Núcleo e embutidos<158>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id866}@anchor{1caa}
@subsubsection Biblioteca



@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{523,,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 Propostas de Melhorias do Python; 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{cdd,,os.getrandom()} function. This change is part of the 
@geindex Propostas de Melhorias do Python; 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<56>,API C<70>,Biblioteca<160>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id867}@anchor{1cab}
@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 API C<70>,Testes<74>,IDLE<56>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id868}@anchor{1cac}
@subsubsection API C



@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 Testes<74>,Construção<82>,API C<70>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id869}@anchor{1cad}
@subsubsection Testes



@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 Construção<82>,Ferramentas/Demos<44>,Testes<74>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id870}@anchor{1cae}
@subsubsection Construção



@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 Ferramentas/Demos<44>,Windows<70>,Construção<82>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id871}@anchor{1caf}
@subsubsection Ferramentas/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<70>,,Ferramentas/Demos<44>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id872}@anchor{1cb0}
@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-alpha-4}@anchor{1cb1}
@subsection Python 3.6.0 alpha 4


`Data de lançamento: 2016-08-15'

@menu
* Núcleo e embutidos: Núcleo e embutidos<159>. 
* Biblioteca: Biblioteca<161>. 
* IDLE: IDLE<57>. 
* Testes: Testes<75>. 
* Windows: Windows<71>. 
* Construção: Construção<83>. 

@end menu

@node Núcleo e embutidos<159>,Biblioteca<161>,,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id873}@anchor{1cb2}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Biblioteca<161>,IDLE<57>,Núcleo e embutidos<159>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id874}@anchor{1cb3}
@subsubsection Biblioteca



@itemize -

@item 
bpo-26027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26027}: Add 
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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<57>,Testes<75>,Biblioteca<161>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id875}@anchor{1cb4}
@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 Testes<75>,Windows<71>,IDLE<57>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id876}@anchor{1cb5}
@subsubsection Testes



@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<71>,Construção<83>,Testes<75>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id877}@anchor{1cb6}
@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 Propostas de Melhorias do Python; 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 Construção<83>,,Windows<71>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id878}@anchor{1cb7}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-alpha-3}@anchor{1cb8}
@subsection Python 3.6.0 alpha 3


`Data de lançamento: 2016-07-11'

@menu
* Segurança: Segurança<50>. 
* Núcleo e embutidos: Núcleo e embutidos<160>. 
* Biblioteca: Biblioteca<162>. 
* IDLE: IDLE<58>. 
* API C: API C<71>. 
* Construção: Construção<84>. 
* Ferramentas/Demos: Ferramentas/Demos<45>. 
* Documentação: Documentação<71>. 
* Testes: Testes<76>. 

@end menu

@node Segurança<50>,Núcleo e embutidos<160>,,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id879}@anchor{1cb9}
@subsubsection Segurança



@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 Núcleo e embutidos<160>,Biblioteca<162>,Segurança<50>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id880}@anchor{1cba}
@subsubsection Núcleo e embutidos



@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 Biblioteca<162>,IDLE<58>,Núcleo e embutidos<160>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id881}@anchor{1cbb}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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<58>,API C<71>,Biblioteca<162>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id882}@anchor{1cbc}
@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 API C<71>,Construção<84>,IDLE<58>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id883}@anchor{1cbd}
@subsubsection API C



@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 Construção<84>,Ferramentas/Demos<45>,API C<71>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id884}@anchor{1cbe}
@subsubsection Construção



@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 Ferramentas/Demos<45>,Documentação<71>,Construção<84>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id885}@anchor{1cbf}
@subsubsection Ferramentas/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 Documentação<71>,Testes<76>,Ferramentas/Demos<45>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id886}@anchor{1cc0}
@subsubsection Documentação



@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 Testes<76>,,Documentação<71>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id887}@anchor{1cc1}
@subsubsection Testes



@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,Changelog
@anchor{whatsnew/changelog python-3-6-0-alpha-2}@anchor{1cc2}
@subsection Python 3.6.0 alpha 2


`Data de lançamento: 2016-06-13'

@menu
* Segurança: Segurança<51>. 
* Núcleo e embutidos: Núcleo e embutidos<161>. 
* Biblioteca: Biblioteca<163>. 
* IDLE: IDLE<59>. 
* Documentação: Documentação<72>. 
* Testes: Testes<77>. 
* Windows: Windows<72>. 
* Construção: Construção<85>. 
* API C: API C<72>. 
* Ferramentas/Demos: Ferramentas/Demos<46>. 

@end menu

@node Segurança<51>,Núcleo e embutidos<161>,,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id888}@anchor{1cc3}
@subsubsection Segurança



@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{523,,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 Núcleo e embutidos<161>,Biblioteca<163>,Segurança<51>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id889}@anchor{1cc4}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Biblioteca<163>,IDLE<59>,Núcleo e embutidos<161>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id890}@anchor{1cc5}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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<59>,Documentação<72>,Biblioteca<163>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id891}@anchor{1cc6}
@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 Documentação<72>,Testes<77>,IDLE<59>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id892}@anchor{1cc7}
@subsubsection Documentação



@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 Propostas de Melhorias do Python; 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 Testes<77>,Windows<72>,Documentação<72>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id893}@anchor{1cc8}
@subsubsection Testes



@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<72>,Construção<85>,Testes<77>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id894}@anchor{1cc9}
@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 Construção<85>,API C<72>,Windows<72>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id895}@anchor{1cca}
@subsubsection Construção



@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 API C<72>,Ferramentas/Demos<46>,Construção<85>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id896}@anchor{1ccb}
@subsubsection API C



@itemize -

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: Add the PyOS_FSPath() function (part of 
@geindex Propostas de Melhorias do Python; 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 Ferramentas/Demos<46>,,API C<72>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id897}@anchor{1ccc}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-6-0-alpha-1}@anchor{1ccd}
@subsection Python 3.6.0 alpha 1


`Data de lançamento: 2016-05-16'

@menu
* Segurança: Segurança<52>. 
* Núcleo e embutidos: Núcleo e embutidos<162>. 
* Biblioteca: Biblioteca<164>. 
* IDLE: IDLE<60>. 
* Documentação: Documentação<73>. 
* Testes: Testes<78>. 
* Construção: Construção<86>. 
* Windows: Windows<73>. 
* Ferramentas/Demos: Ferramentas/Demos<47>. 
* API C: API C<73>. 

@end menu

@node Segurança<52>,Núcleo e embutidos<162>,,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id898}@anchor{1cce}
@subsubsection Segurança



@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 Núcleo e embutidos<162>,Biblioteca<164>,Segurança<52>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id899}@anchor{1ccf}
@subsubsection Núcleo e embutidos



@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{c81,,PyMem_Malloc()} domain
(@ref{c84,,PYMEM_DOMAIN_MEM}) now use the @ref{d31,,pymalloc allocator} rather than system @code{malloc()}. Applications calling
@ref{c81,,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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{c81,,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{c83,,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 variável de ambiente; PYTHONMALLOC
@ref{c7f,,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{c85,,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 variável de ambiente; PYTHONMALLOCSTATS
@ref{1cd0,,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 Propostas de Melhorias do Python; 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 Biblioteca<164>,IDLE<60>,Núcleo e embutidos<162>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id900}@anchor{1cd1}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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{1142,,shutil.get_terminal_size()}, catch
@ref{34b,,AttributeError} instead of @ref{43f,,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{523,,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 splitted 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{419,,ImportError}
rather than a @ref{2c3,,TypeError} if @ref{8da,,__import__()} is tried during the
Python shutdown process but @ref{3b4,,sys.path} is already cleared (set to
@code{None}).

@item 
bpo-21925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21925}: @ref{1b8d,,warnings.formatwarning()} now catches exceptions when
calling @ref{e50,,linecache.getline()} and
@ref{1cd2,,tracemalloc.get_object_traceback()} to be able to log
@ref{244,,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{d39,,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{82e,,pyclbr.readmodule()} and @ref{82f,,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}: Corrigido textwrap.dedent() para o caso em que o maior espaço em branco comum seja uma substring do menor espaço em branco inicial. Com base no `patch' de 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<60>,Documentação<73>,Biblioteca<164>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id901}@anchor{1cd3}
@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 Documentação<73>,Testes<78>,IDLE<60>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id902}@anchor{1cd4}
@subsubsection Documentação



@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 Testes<78>,Construção<86>,Documentação<73>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id903}@anchor{1cd5}
@subsubsection Testes



@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 Construção<86>,Windows<73>,Testes<78>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id904}@anchor{1cd6}
@subsubsection Construção



@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<73>,Ferramentas/Demos<47>,Construção<86>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id905}@anchor{1cd7}
@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 Ferramentas/Demos<47>,API C<73>,Windows<73>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id906}@anchor{1cd8}
@subsubsection Ferramentas/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 API C<73>,,Ferramentas/Demos<47>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id907}@anchor{1cd9}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-5-5-final}@anchor{1cda}
@subsection Python 3.5.5 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-5-5-release-candidate-1}@anchor{1cdb}
@subsection Python 3.5.5 release candidate 1


`Data de lançamento: 2018-01-23'

@menu
* Segurança: Segurança<53>. 
* Núcleo e embutidos: Núcleo e embutidos<163>. 
* Biblioteca: Biblioteca<165>. 

@end menu

@node Segurança<53>,Núcleo e embutidos<163>,,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id908}@anchor{1cdc}
@subsubsection Segurança



@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 Núcleo e embutidos<163>,Biblioteca<165>,Segurança<53>,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id909}@anchor{1cdd}
@subsubsection Núcleo e embutidos



@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 Biblioteca<165>,,Núcleo e embutidos<163>,Python 3 5 5 release candidate 1
@anchor{whatsnew/changelog id910}@anchor{1cde}
@subsubsection Biblioteca



@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,Changelog
@anchor{whatsnew/changelog python-3-5-4-final}@anchor{1cdf}
@subsection Python 3.5.4 final


`Data de lançamento: 2017-08-07'

@menu
* Biblioteca: Biblioteca<166>. 

@end menu

@node Biblioteca<166>,,,Python 3 5 4 final
@anchor{whatsnew/changelog id911}@anchor{1ce0}
@subsubsection Biblioteca



@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,Changelog
@anchor{whatsnew/changelog python-3-5-4-release-candidate-1}@anchor{1ce1}
@subsection Python 3.5.4 release candidate 1


`Data de lançamento: 2017-07-23'

@menu
* Segurança: Segurança<54>. 
* Núcleo e embutidos: Núcleo e embutidos<164>. 
* Biblioteca: Biblioteca<167>. 
* Documentação: Documentação<74>. 
* Testes: Testes<79>. 
* Construção: Construção<87>. 
* Windows: Windows<74>. 
* API C: API C<74>. 

@end menu

@node Segurança<54>,Núcleo e embutidos<164>,,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id912}@anchor{1ce2}
@subsubsection Segurança



@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 Núcleo e embutidos<164>,Biblioteca<167>,Segurança<54>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id913}@anchor{1ce3}
@subsubsection Núcleo e embutidos



@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{885,,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 Biblioteca<167>,Documentação<74>,Núcleo e embutidos<164>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id914}@anchor{1ce4}
@subsubsection Biblioteca



@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 Documentação<74>,Testes<79>,Biblioteca<167>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id915}@anchor{1ce5}
@subsubsection Documentação



@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 Testes<79>,Construção<87>,Documentação<74>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id916}@anchor{1ce6}
@subsubsection Testes



@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 Construção<87>,Windows<74>,Testes<79>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id917}@anchor{1ce7}
@subsubsection Construção



@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<74>,API C<74>,Construção<87>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id918}@anchor{1ce8}
@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 API C<74>,,Windows<74>,Python 3 5 4 release candidate 1
@anchor{whatsnew/changelog id919}@anchor{1ce9}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-5-3-final}@anchor{1cea}
@subsection Python 3.5.3 final


`Data de lançamento: 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,Changelog
@anchor{whatsnew/changelog python-3-5-3-release-candidate-1}@anchor{1ceb}
@subsection Python 3.5.3 release candidate 1


`Data de lançamento: 2017-01-02'

@menu
* Segurança: Segurança<55>. 
* Núcleo e embutidos: Núcleo e embutidos<165>. 
* Biblioteca: Biblioteca<168>. 
* IDLE: IDLE<61>. 
* API C: API C<75>. 
* Documentação: Documentação<75>. 
* Testes: Testes<80>. 
* Ferramentas/Demos: Ferramentas/Demos<48>. 
* Windows: Windows<75>. 
* Construção: Construção<88>. 

@end menu

@node Segurança<55>,Núcleo e embutidos<165>,,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id920}@anchor{1cec}
@subsubsection Segurança



@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 Núcleo e embutidos<165>,Biblioteca<168>,Segurança<55>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id921}@anchor{1ced}
@subsubsection Núcleo e embutidos



@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 Biblioteca<168>,IDLE<61>,Núcleo e embutidos<165>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id922}@anchor{1cee}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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<61>,API C<75>,Biblioteca<168>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id923}@anchor{1cef}
@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 API C<75>,Documentação<75>,IDLE<61>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id924}@anchor{1cf0}
@subsubsection API C



@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 Documentação<75>,Testes<80>,API C<75>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id925}@anchor{1cf1}
@subsubsection Documentação



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: Documented command-line interface of zipfile.
@end itemize

@node Testes<80>,Ferramentas/Demos<48>,Documentação<75>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id926}@anchor{1cf2}
@subsubsection Testes



@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 Ferramentas/Demos<48>,Windows<75>,Testes<80>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id927}@anchor{1cf3}
@subsubsection Ferramentas/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<75>,Construção<88>,Ferramentas/Demos<48>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id928}@anchor{1cf4}
@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 Construção<88>,,Windows<75>,Python 3 5 3 release candidate 1
@anchor{whatsnew/changelog id929}@anchor{1cf5}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-5-2-final}@anchor{1cf6}
@subsection Python 3.5.2 final


`Data de lançamento: 2016-06-26'

@menu
* Núcleo e embutidos: Núcleo e embutidos<166>. 
* Testes: Testes<81>. 
* IDLE: IDLE<62>. 

@end menu

@node Núcleo e embutidos<166>,Testes<81>,,Python 3 5 2 final
@anchor{whatsnew/changelog id930}@anchor{1cf7}
@subsubsection Núcleo e embutidos



@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 Testes<81>,IDLE<62>,Núcleo e embutidos<166>,Python 3 5 2 final
@anchor{whatsnew/changelog id931}@anchor{1cf8}
@subsubsection Testes



@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<62>,,Testes<81>,Python 3 5 2 final
@anchor{whatsnew/changelog id932}@anchor{1cf9}
@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,Changelog
@anchor{whatsnew/changelog python-3-5-2-release-candidate-1}@anchor{1cfa}
@subsection Python 3.5.2 release candidate 1


`Data de lançamento: 2016-06-12'

@menu
* Segurança: Segurança<56>. 
* Núcleo e embutidos: Núcleo e embutidos<167>. 
* Biblioteca: Biblioteca<169>. 
* IDLE: IDLE<63>. 
* Documentação: Documentação<76>. 
* Testes: Testes<82>. 
* Construção: Construção<89>. 
* Windows: Windows<76>. 
* Ferramentas/Demos: Ferramentas/Demos<49>. 

@end menu

@node Segurança<56>,Núcleo e embutidos<167>,,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id933}@anchor{1cfb}
@subsubsection Segurança



@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{523,,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 Núcleo e embutidos<167>,Biblioteca<169>,Segurança<56>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id934}@anchor{1cfc}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Biblioteca<169>,IDLE<63>,Núcleo e embutidos<167>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id935}@anchor{1cfd}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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{1142,,shutil.get_terminal_size()}, catch
@ref{34b,,AttributeError} instead of @ref{43f,,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{523,,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{1b8d,,warnings.formatwarning()} now catches exceptions on
@code{linecache.getline(...)} to be able to log @ref{244,,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{82e,,pyclbr.readmodule()} and @ref{82f,,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<63>,Documentação<76>,Biblioteca<169>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id936}@anchor{1cfe}
@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 Documentação<76>,Testes<82>,IDLE<63>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id937}@anchor{1cff}
@subsubsection Documentação



@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 Propostas de Melhorias do Python; 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 Testes<82>,Construção<89>,Documentação<76>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id938}@anchor{1d00}
@subsubsection Testes



@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 Construção<89>,Windows<76>,Testes<82>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id939}@anchor{1d01}
@subsubsection Construção



@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<76>,Ferramentas/Demos<49>,Construção<89>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id940}@anchor{1d02}
@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 Ferramentas/Demos<49>,,Windows<76>,Python 3 5 2 release candidate 1
@anchor{whatsnew/changelog id941}@anchor{1d03}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-5-1-final}@anchor{1d04}
@subsection Python 3.5.1 final


`Data de lançamento: 2015-12-06'

@menu
* Núcleo e embutidos: Núcleo e embutidos<168>. 
* Windows: Windows<77>. 

@end menu

@node Núcleo e embutidos<168>,Windows<77>,,Python 3 5 1 final
@anchor{whatsnew/changelog id942}@anchor{1d05}
@subsubsection Núcleo e embutidos



@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<77>,,Núcleo e embutidos<168>,Python 3 5 1 final
@anchor{whatsnew/changelog id943}@anchor{1d06}
@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,Changelog
@anchor{whatsnew/changelog python-3-5-1-release-candidate-1}@anchor{1d07}
@subsection Python 3.5.1 release candidate 1


`Data de lançamento: 2015-11-22'

@menu
* Núcleo e embutidos: Núcleo e embutidos<169>. 
* Biblioteca: Biblioteca<170>. 
* IDLE: IDLE<64>. 
* Documentação: Documentação<77>. 
* Testes: Testes<83>. 
* Construção: Construção<90>. 
* Windows: Windows<78>. 
* Ferramentas/Demos: Ferramentas/Demos<50>. 

@end menu

@node Núcleo e embutidos<169>,Biblioteca<170>,,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id944}@anchor{1d08}
@subsubsection Núcleo e embutidos



@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 Biblioteca<170>,IDLE<64>,Núcleo e embutidos<169>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id945}@anchor{1d09}
@subsubsection Biblioteca



@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}: Corrigido textwrap.dedent() para o caso em que o maior espaço em branco comum seja uma substring do menor espaço em branco inicial. Com base no `patch' de 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<64>,Documentação<77>,Biblioteca<170>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id946}@anchor{1d0a}
@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 Documentação<77>,Testes<83>,IDLE<64>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id947}@anchor{1d0b}
@subsubsection Documentação



@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 Testes<83>,Construção<90>,Documentação<77>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id948}@anchor{1d0c}
@subsubsection Testes



@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 Construção<90>,Windows<78>,Testes<83>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id949}@anchor{1d0d}
@subsubsection Construção



@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<78>,Ferramentas/Demos<50>,Construção<90>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id950}@anchor{1d0e}
@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 Ferramentas/Demos<50>,,Windows<78>,Python 3 5 1 release candidate 1
@anchor{whatsnew/changelog id951}@anchor{1d0f}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-5-0-final}@anchor{1d10}
@subsection Python 3.5.0 final


`Data de lançamento: 2015-09-13'

@menu
* Construção: Construção<91>. 

@end menu

@node Construção<91>,,,Python 3 5 0 final
@anchor{whatsnew/changelog id952}@anchor{1d11}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-release-candidate-4}@anchor{1d12}
@subsection Python 3.5.0 release candidate 4


`Data de lançamento: 2015-09-09'

@menu
* Biblioteca: Biblioteca<171>. 
* Construção: Construção<92>. 

@end menu

@node Biblioteca<171>,Construção<92>,,Python 3 5 0 release candidate 4
@anchor{whatsnew/changelog id953}@anchor{1d13}
@subsubsection Biblioteca



@itemize -

@item 
bpo-25029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25029}: Fixes MemoryError in test_strptime.
@end itemize

@node Construção<92>,,Biblioteca<171>,Python 3 5 0 release candidate 4
@anchor{whatsnew/changelog id954}@anchor{1d14}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-release-candidate-3}@anchor{1d15}
@subsection Python 3.5.0 release candidate 3


`Data de lançamento: 2015-09-07'

@menu
* Núcleo e embutidos: Núcleo e embutidos<170>. 
* Biblioteca: Biblioteca<172>. 

@end menu

@node Núcleo e embutidos<170>,Biblioteca<172>,,Python 3 5 0 release candidate 3
@anchor{whatsnew/changelog id955}@anchor{1d16}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} syntax.
@end itemize

@node Biblioteca<172>,,Núcleo e embutidos<170>,Python 3 5 0 release candidate 3
@anchor{whatsnew/changelog id956}@anchor{1d17}
@subsubsection Biblioteca



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-release-candidate-2}@anchor{1d18}
@subsection Python 3.5.0 release candidate 2


`Data de lançamento: 2015-08-25'

@menu
* Núcleo e embutidos: Núcleo e embutidos<171>. 
* Biblioteca: Biblioteca<173>. 

@end menu

@node Núcleo e embutidos<171>,Biblioteca<173>,,Python 3 5 0 release candidate 2
@anchor{whatsnew/changelog id957}@anchor{1d19}
@subsubsection Núcleo e embutidos



@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 Biblioteca<173>,,Núcleo e embutidos<171>,Python 3 5 0 release candidate 2
@anchor{whatsnew/changelog id958}@anchor{1d1a}
@subsubsection Biblioteca



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-release-candidate-1}@anchor{1d1b}
@subsection Python 3.5.0 release candidate 1


`Data de lançamento: 2015-08-09'

@menu
* Núcleo e embutidos: Núcleo e embutidos<172>. 
* Biblioteca: Biblioteca<174>. 
* IDLE: IDLE<65>. 
* Documentação: Documentação<78>. 
* Testes: Testes<84>. 

@end menu

@node Núcleo e embutidos<172>,Biblioteca<174>,,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id959}@anchor{1d1c}
@subsubsection Núcleo e embutidos



@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 Biblioteca<174>,IDLE<65>,Núcleo e embutidos<172>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id960}@anchor{1d1d}
@subsubsection Biblioteca



@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<65>,Documentação<78>,Biblioteca<174>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id961}@anchor{1d1e}
@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 Documentação<78>,Testes<84>,IDLE<65>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id962}@anchor{1d1f}
@subsubsection Documentação



@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 Testes<84>,,Documentação<78>,Python 3 5 0 release candidate 1
@anchor{whatsnew/changelog id963}@anchor{1d20}
@subsubsection Testes



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-beta-4}@anchor{1d21}
@subsection Python 3.5.0 beta 4


`Data de lançamento: 2015-07-26'

@menu
* Núcleo e embutidos: Núcleo e embutidos<173>. 
* Biblioteca: Biblioteca<175>. 
* Construção: Construção<93>. 

@end menu

@node Núcleo e embutidos<173>,Biblioteca<175>,,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id964}@anchor{1d22}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Biblioteca<175>,Construção<93>,Núcleo e embutidos<173>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id965}@anchor{1d23}
@subsubsection Biblioteca



@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 Construção<93>,,Biblioteca<175>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id966}@anchor{1d24}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-beta-3}@anchor{1d25}
@subsection Python 3.5.0 beta 3


`Data de lançamento: 2015-07-05'

@menu
* Núcleo e embutidos: Núcleo e embutidos<174>. 
* Biblioteca: Biblioteca<176>. 
* Testes: Testes<85>. 
* Documentação: Documentação<79>. 
* Construção: Construção<94>. 

@end menu

@node Núcleo e embutidos<174>,Biblioteca<176>,,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id967}@anchor{1d26}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Biblioteca<176>,Testes<85>,Núcleo e embutidos<174>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id968}@anchor{1d27}
@subsubsection Biblioteca



@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 Testes<85>,Documentação<79>,Biblioteca<176>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id969}@anchor{1d28}
@subsubsection Testes



@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 Documentação<79>,Construção<94>,Testes<85>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id970}@anchor{1d29}
@subsubsection Documentação



@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 Construção<94>,,Documentação<79>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id971}@anchor{1d2a}
@subsubsection Construção



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-beta-2}@anchor{1d2b}
@subsection Python 3.5.0 beta 2


`Data de lançamento: 2015-05-31'

@menu
* Núcleo e embutidos: Núcleo e embutidos<175>. 
* Biblioteca: Biblioteca<177>. 

@end menu

@node Núcleo e embutidos<175>,Biblioteca<177>,,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id972}@anchor{1d2c}
@subsubsection Núcleo e embutidos



@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 Biblioteca<177>,,Núcleo e embutidos<175>,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id973}@anchor{1d2d}
@subsubsection Biblioteca



@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 Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-5-0-beta-1}@anchor{1d2e}
@subsection Python 3.5.0 beta 1


`Data de lançamento: 2015-05-24'

@menu
* Núcleo e embutidos: Núcleo e embutidos<176>. 
* Biblioteca: Biblioteca<178>. 
* IDLE: IDLE<66>. 
* Testes: Testes<86>. 
* Documentação: Documentação<80>. 
* Ferramentas/Demos: Ferramentas/Demos<51>. 

@end menu

@node Núcleo e embutidos<176>,Biblioteca<178>,,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id974}@anchor{1d2f}
@subsubsection Núcleo e embutidos



@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 Biblioteca<178>,IDLE<66>,Núcleo e embutidos<176>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id975}@anchor{1d30}
@subsubsection Biblioteca



@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<66>,Testes<86>,Biblioteca<178>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id976}@anchor{1d31}
@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 Testes<86>,Documentação<80>,IDLE<66>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id977}@anchor{1d32}
@subsubsection Testes



@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 Documentação<80>,Ferramentas/Demos<51>,Testes<86>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id978}@anchor{1d33}
@subsubsection Documentação



@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 Ferramentas/Demos<51>,,Documentação<80>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id979}@anchor{1d34}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-5-0-alpha-4}@anchor{1d35}
@subsection Python 3.5.0 alpha 4


`Data de lançamento: 2015-04-19'

@menu
* Núcleo e embutidos: Núcleo e embutidos<177>. 
* Biblioteca: Biblioteca<179>. 
* Construção: Construção<95>. 
* Testes: Testes<87>. 
* Ferramentas/Demos: Ferramentas/Demos<52>. 
* API C: API C<76>. 

@end menu

@node Núcleo e embutidos<177>,Biblioteca<179>,,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id980}@anchor{1d36}
@subsubsection Núcleo e embutidos



@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 Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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 Biblioteca<179>,Construção<95>,Núcleo e embutidos<177>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id981}@anchor{1d37}
@subsubsection Biblioteca



@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{dd0,,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{dcb,,socket.socket.connect()} now waits until the connection
completes instead of raising @ref{db0,,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{dcb,,socket.socket.connect()} still
raise @ref{db0,,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 Propostas de Melhorias do Python; 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 Construção<95>,Testes<87>,Biblioteca<179>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id982}@anchor{1d38}
@subsubsection Construção



@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 Testes<87>,Ferramentas/Demos<52>,Construção<95>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id983}@anchor{1d39}
@subsubsection Testes



@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 Ferramentas/Demos<52>,API C<76>,Testes<87>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id984}@anchor{1d3a}
@subsubsection Ferramentas/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 API C<76>,,Ferramentas/Demos<52>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id985}@anchor{1d3b}
@subsubsection API C



@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,Changelog
@anchor{whatsnew/changelog python-3-5-0-alpha-3}@anchor{1d3c}
@subsection Python 3.5.0 alpha 3


`Data de lançamento: 2015-03-28'

@menu
* Núcleo e embutidos: Núcleo e embutidos<178>. 
* Biblioteca: Biblioteca<180>. 
* Construção: Construção<96>. 
* Testes: Testes<88>. 
* Ferramentas/Demos: Ferramentas/Demos<53>. 

@end menu

@node Núcleo e embutidos<178>,Biblioteca<180>,,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id986}@anchor{1d3d}
@subsubsection Núcleo e embutidos



@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 Biblioteca<180>,Construção<96>,Núcleo e embutidos<178>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id987}@anchor{1d3e}
@subsubsection Biblioteca



@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{dd3,,signal.sigwaitinfo()} and @ref{dd2,,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 Construção<96>,Testes<88>,Biblioteca<180>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id988}@anchor{1d3f}
@subsubsection Construção



@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 Testes<88>,Ferramentas/Demos<53>,Construção<96>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id989}@anchor{1d40}
@subsubsection Testes



@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 Ferramentas/Demos<53>,,Testes<88>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id990}@anchor{1d41}
@subsubsection Ferramentas/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,Changelog
@anchor{whatsnew/changelog python-3-5-0-alpha-2}@anchor{1d42}
@subsection Python 3.5.0 alpha 2


`Data de lançamento: 2015-03-09'

@menu
* Núcleo e embutidos: Núcleo e embutidos<179>. 
* Biblioteca: Biblioteca<181>. 
* Construção: Construção<97>. 
* API C: API C<77>. 
* Windows: Windows<79>. 

@end menu

@node Núcleo e embutidos<179>,Biblioteca<181>,,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id991}@anchor{1d43}
@subsubsection Núcleo e embutidos



@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 Biblioteca<181>,Construção<97>,Núcleo e embutidos<179>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id992}@anchor{1d44}
@subsubsection Biblioteca



@itemize -

@item 
bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524}: New os.scandir() function, part of the 
@geindex Propostas de Melhorias do Python; 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 Construção<97>,API C<77>,Biblioteca<181>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id993}@anchor{1d45}
@subsubsection Construção



@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 API C<77>,Windows<79>,Construção<97>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id994}@anchor{1d46}
@subsubsection API C



@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<79>,,API C<77>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id995}@anchor{1d47}
@subsubsection Windows



@itemize -

@item 
bpo-23465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23465}: Implement 
@geindex Propostas de Melhorias do Python; 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,Changelog
@anchor{whatsnew/changelog python-3-5-0-alpha-1}@anchor{1d48}
@subsection Python 3.5.0 alpha 1


`Data de lançamento: 2015-02-08'

@menu
* Núcleo e embutidos: Núcleo e embutidos<180>. 
* Biblioteca: Biblioteca<182>. 
* IDLE: IDLE<67>. 
* Construção: Construção<98>. 
* API C: API C<78>. 
* Documentação: Documentação<81>. 
* Testes: Testes<89>. 
* Ferramentas/Demos: Ferramentas/Demos<54>. 
* Windows: Windows<80>. 

@end menu

@node Núcleo e embutidos<180>,Biblioteca<182>,,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id996}@anchor{1d49}
@subsubsection Núcleo e embutidos



@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 Biblioteca<182>,IDLE<67>,Núcleo e embutidos<180>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id997}@anchor{1d4a}
@subsubsection Biblioteca



@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{a99,,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().  Pach 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{a69,,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 Propostas de Melhorias do Python; 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} incase 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{4c6,,tempfile.NamedTemporaryFile()}, close the file descriptor if
@ref{51d,,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{53d,,sys.stdin} and @ref{ae6,,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 usuable 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<67>,Construção<98>,Biblioteca<182>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id998}@anchor{1d4b}
@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 Propostas de Melhorias do Python; 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 Construção<98>,API C<78>,IDLE<67>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id999}@anchor{1d4c}
@subsubsection Construção



@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 API C<78>,Documentação<81>,Construção<98>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1000}@anchor{1d4d}
@subsubsection API C



@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{be0,,Py_DecodeLocale()},
rename @code{_Py_wchar2char()} to @ref{be1,,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 Documentação<81>,Testes<89>,API C<78>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1001}@anchor{1d4e}
@subsubsection Documentação



@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}: remove documentação da classe asynchat.fifo descontinuada.

@item 
bpo-17386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17386}: Expandida a funcionalidade do script @code{Doc/make.bat} para fazê-lo muito mais comparável a @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}: Adiciona documentação faltante para PurePath.with_name() e 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}: Documenta casos em que __main__.__spec__ é None.
@end itemize

@node Testes<89>,Ferramentas/Demos<54>,Documentação<81>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1002}@anchor{1d4f}
@subsubsection Testes



@itemize -

@item 
bpo-18982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18982}: Adiciona testes para ILC do módulo calendar.

@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 Ferramentas/Demos<54>,Windows<80>,Testes<89>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1003}@anchor{1d50}
@subsubsection Ferramentas/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 
Adiciona suporte a @code{yield from} para 2to3.

@item 
Adiciona suporte ao operador de multiplicação de matriz 
@geindex Propostas de Melhorias do Python; PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} para 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<80>,,Ferramentas/Demos<54>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1004}@anchor{1d51}
@subsubsection Windows



@itemize -

@item 
bpo-23260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23260}: Update Windows installer

@item 
A versão do pacote Tcl/Tk foi atualizada para 8.6.3. O resultado mais visível dessa alteração é a adição de novas caixas de diálogo de arquivo nativo ao executar no Windows Vista ou mais recente. Consulte o TIP 432 da Tcl/Tk para obter mais informações. Além disso, esta versão do Tcl/Tk inclui suporte ao 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}: arquivos .pyd com identificador de versão e plataforma (por exemplo, “.cp35-win32.pyd”) agora serão carregados em preferência aos que não tem identificadores.
@end itemize

`(Para informações sobre versões mais antigas, consulte o arquivo HISTORY.)'

@node O tutorial do Python,Configurações e Uso do Python,O que há de novo no Python,Top
@anchor{tutorial/index doc}@anchor{1d52}@anchor{tutorial/index the-python-tutorial}@anchor{1d53}@anchor{tutorial/index translation-repo}@anchor{1d54}@anchor{tutorial/index tutorial-index}@anchor{1d55}
@chapter O tutorial do Python


@cartouche
@quotation Dica 
Este tutorial foi desenvolvido para pessoas `que já programam', mas são recém-chegadas na linguagem Python, `não' pessoas `iniciantes' em programação.
@end quotation
@end cartouche

Python é uma linguagem fácil de aprender e poderosa. Ela tem estruturas de dados de alto nível eficientes e uma abordagem simples mas efetiva de programação orientada a objetos. A sintaxe elegante e a tipagem dinâmica do Python, aliadas com sua natureza interpretativa, o tornam uma linguagem ideal para fazer scripts e desenvolvimento de aplicações rápidas em diversas áreas e na maioria das plataformas.

O interpretador Python e a extensiva biblioteca padrão estão disponíveis gratuitamente em código ou na forma binária para toda as maiores plataformas no endereço eletrônico do Python, @indicateurl{https://www.python.org/}, e pode ser livremente distribuído. O mesmo endereço contém distribuições de diversos módulos, programas e ferramentas gratuitos produzidos por terceiros e documentação adicional.

O interpretador do Python pode ser facilmente estendido com novas funções e tipos de dados implementados em C ou C++ (ou outras linguagens chamáveis a partir de C). Python também é adequado como uma linguagem de extensão para aplicações personalizáveis.

Este tutorial introduz informalmente o leitor aos conceitos básicos e aos recursos da linguagem e do sistema Python. Esteja ciente de que ele espera que você tenha um conhecimento básico de programação em geral. É mais fácil se você possuir um interpretador Python para uma experiência prática, mas os exemplos são autossuficientes e, portanto, o tutorial pode apenas ser lido off-line também.

Para uma descrição detalhada dos módulos e objetos padrões, veja @ref{144,,A Biblioteca Padrão do Python}. Em @ref{145,,A Referência da Linguagem Python} você encontra uma definição mais formal da linguagem. Para escrever extensões em C ou C++, leia @ref{1d56,,Estendendo e incorporando o interpretador Python} e @ref{1d57,,Manual de referência da API Python/C}. Existe também uma série de livros que cobrem Python em profundidade.

Este tutorial não espera ser abrangente e cobrir todos os recursos ou mesmo os recursos mais usados. Ele busca introduzir diversos dos recursos mais notáveis do Python e lhe dará uma boa ideia do sabor e estilo da linguagem. Depois de lê-lo, você terá condições de ler e escrever programas e módulos Python e estará pronto para aprender mais sobre os diversos módulos descritos em @ref{144,,A Biblioteca Padrão do Python}.

O @ref{1d58,,Glossário} também vale a pena ser estudado.

@menu
* Abrindo seu apetite:: 
* Utilizando o interpretador Python:: 
* Uma introdução informal ao Python:: 
* Mais ferramentas de controle de fluxo:: 
* Estruturas de dados:: 
* Módulos: Módulos<2>. 
* Entrada e Saída:: 
* Erros e exceções:: 
* Classes:: 
* Um breve passeio pela biblioteca padrão:: 
* Um breve passeio pela biblioteca padrão — parte II:: 
* Ambientes virtuais e pacotes:: 
* E agora?:: 
* Edição de entrada interativa e substituição de histórico:: 
* Aritmética de ponto flutuante; problemas e limitações: Aritmética de ponto flutuante problemas e limitações. 
* Anexo:: 

@end menu

@node Abrindo seu apetite,Utilizando o interpretador Python,,O tutorial do Python
@anchor{tutorial/appetite doc}@anchor{1d59}@anchor{tutorial/appetite tut-intro}@anchor{1d5a}@anchor{tutorial/appetite whetting-your-appetite}@anchor{1d5b}
@section Abrindo seu apetite


Se você trabalha bastante com computadores, eventualmente perceberá que há alguma tarefa que gostaria de automatizar. Por exemplo, pode querer realizar uma busca e substituição em um grande número de arquivos de texto ou renomear e reorganizar um conjunto de fotos de maneira complexa. Talvez deseje criar um pequeno banco de dados personalizado, uma aplicação GUI especializada ou um jogo simples.

Se você é um desenvolvedor de software profissional, pode ter que trabalhar com várias bibliotecas C/C++/Java, mas o tradicional ciclo escrever/compilar/testar/recompilar é muito lento. Talvez você esteja escrevendo um conjunto de testes para uma biblioteca e está achando tedioso codificar os testes. Ou talvez você tenha escrito um programa que poderia utilizar uma linguagem de extensão, e você não quer conceber e implementar toda uma nova linguagem para sua aplicação.

Python é a linguagem para você.

Você pode escrever um script shell do Unix ou arquivos batch do Windows para algumas dessas tarefas, mas os scripts shell são melhores para mover arquivos e alterar dados de texto, não são adequados para aplicações GUI ou jogos. Você pode escrever um programa C/C++/Java, mas pode levar muito tempo de desenvolvimento para obter até mesmo um primeiro rascunho de programa. O Python é mais simples de usar, está disponível nos sistemas operacionais Windows, macOS e Unix e ajudará você a terminar o trabalho mais rapidamente.

Python é fácil de usar, sem deixar de ser uma linguagem de programação de verdade, oferecendo muito mais estruturação e suporte para programas extensos do que shell scripts ou arquivos de lote oferecem. Por outro lado, Python também oferece melhor verificação de erros do que C, e por ser uma linguagem de `muito alto nível', ela possui tipos nativos de alto nível, tais como dicionários e vetores (arrays) flexíveis. Devido ao suporte nativo a uma variedade de tipos de dados, Python é aplicável a um domínio de problemas muito mais vasto do que Awk ou até mesmo Perl, ainda assim muitas tarefas são pelo menos tão fáceis em Python quanto nessas linguagens.

Python permite que você organize seu programa em módulos que podem ser reutilizados em outros programas escritos em Python. A linguagem provê uma vasta coleção de módulos que podem ser utilizados como base para sua aplicação — ou como exemplos para estudo e aprofundamento. Alguns desses módulos implementam manipulação de arquivos, chamadas do sistema, sockets, e até mesmo acesso a bibliotecas de construção de interfaces gráficas, como Tk.

Python é uma linguagem interpretada, por isso você pode economizar um tempo considerável durante o desenvolvimento, uma vez que não há necessidade de compilação e ligação (`linking'). O interpretador pode ser usado interativamente, o que torna fácil experimentar diversas características da linguagem, escrever programas “descartáveis”, ou testar funções em um desenvolvimento debaixo para cima (`bottom-up'). É também uma útil calculadora de mesa.

Python permite a escrita de programas compactos e legíveis. Programas escritos em Python são tipicamente mais curtos do que seus equivalentes em C, C++ ou Java, por diversas razões:


@itemize *

@item 
os tipos de alto nível permitem que você expresse operações complexas em um único comando;

@item 
a definição de bloco é feita por indentação ao invés de marcadores de início e fim de bloco;

@item 
não há necessidade de declaração de variáveis ou parâmetros formais;
@end itemize

Python é `extensível': se você sabe como programar em C, é fácil adicionar módulos ou funções embutidas diretamente no interpretador, seja para desempenhar operações críticas em máxima velocidade, ou para vincular programas Python a bibliotecas que só estejam disponíveis em formato binário (como uma biblioteca gráfica de terceiros). Uma vez que você tenha sido fisgado, você pode vincular o interpretador Python a uma aplicação escrita em C e utilizá-la como linguagem de comandos ou extensão para esta aplicação.

A propósito, a linguagem foi batizada a partir do famoso programa da BBC “Monty Python’s Flying Circus” e não tem nada a ver com répteis. Fazer referências a citações do programa na documentação não é só permitido, como também é encorajado!

Agora que você se entusiasmou com o Python, vai querer conhecê-lo com mais detalhes. Partindo do princípio que a melhor maneira de aprender uma linguagem é usando-a, este tutorial lhe convida para fazê-lo com o interpretador do Python enquanto você o lê.

No próximo capítulo, a mecânica de utilização do interpretador é explicada. Essa informação, ainda que mundana, é essencial para a experimentação dos exemplos apresentados mais tarde.

O resto do tutorial introduz diversos aspectos do sistema e linguagem Python por intermédio de exemplos. Serão abordadas expressões simples, instruções, tipos, funções e módulos. Finalmente, serão explicados alguns conceitos avançados como exceções e classes definidas pelo usuário.

@node Utilizando o interpretador Python,Uma introdução informal ao Python,Abrindo seu apetite,O tutorial do Python
@anchor{tutorial/interpreter doc}@anchor{1d5c}@anchor{tutorial/interpreter translation-repo}@anchor{1d5d}@anchor{tutorial/interpreter tut-using}@anchor{1d5e}@anchor{tutorial/interpreter using-the-python-interpreter}@anchor{1d5f}
@section Utilizando o interpretador Python


@menu
* Chamando o interpretador:: 
* O interpretador e seu ambiente:: 

@end menu

@node Chamando o interpretador,O interpretador e seu ambiente,,Utilizando o interpretador Python
@anchor{tutorial/interpreter invoking-the-interpreter}@anchor{1d60}@anchor{tutorial/interpreter tut-invoking}@anchor{1d61}
@subsection Chamando o interpretador


O interpretador Python é frequentemente instalado como @code{/usr/local/bin/python3.13} nas máquinas onde está disponível; adicionando @code{/usr/local/bin} ao caminho de busca da shell de seu Unix torna-se possível iniciá-lo digitando o comando:

@example
python3.13
@end example

no shell. @footnote{
No Unix, o interpretador Python 3.x não é instalado por padrão com o executável nomeado @code{python}, então não vai conflitar com um executável Python 2.x instalado simultaneamente.
} Considerando que a escolha do diretório onde o interpretador está é uma opção de instalação, outros locais são possíveis; verifique com seu guru local de Python ou administrador do sistema local. (Por exemplo, @code{/usr/local/python} é um local alternativo popular.)

Em máquinas Windows onde você instalou Python a partir da @ref{1d62,,Microsoft Store}, o comando @code{python3.13} estará disponível. Se você tem o @ref{5be,,lançador py.exe} instalado, você pode usar o comando @code{py}. Veja @ref{1d63,,Excursus; Configurando variáveis de ambiente} para outras maneiras de executar o Python.

Digitar um caractere de fim de arquivo (@code{Control}-@code{D} no Unix, @code{Control}-@code{Z} no Windows) diretamente no prompt força o interpretador a sair com status de saída zero. Se isso não funcionar, você pode sair do interpretador digitando o seguinte comando: @code{quit()}.

Os recursos de edição de linha do interpretador incluem edição interativa, substituição de histórico e autocompletar código na maioria dos sistemas. Talvez a maneira mais rápida de verificar se a edição da linha de comando é suportada seja digitar uma palavra no prompt do Python e, em seguida, pressionar a seta para a esquerda (ou @code{Control}-@code{b}). Se o cursor mover-se, tem edição de linha de comando; consulte o Apêndice @ref{1d64,,Edição de entrada interativa e substituição de histórico} para uma introdução às teclas. Se nada parecer acontecer, ou se uma sequência como @code{^[[D} ou @code{^B} aparecer, a edição de linha de comando não está disponível; só poderá usar a tecla Backspace para remover caracteres da linha atual.

O interpretador trabalha de forma semelhante a uma shell de Unix: quando chamado com a saída padrão conectada a um console de terminal, ele lê e executa comandos interativamente; quando chamado com um nome de arquivo como argumento, ou com redirecionamento da entrada padrão para ler um arquivo, o interpretador lê e executa o `script' contido no arquivo.

Uma segunda forma de iniciar o interpretador é @code{python -c comando [arg] ...}, que executa uma ou mais instruções especificadas na posição `comando', analogamente à opção de shell @ref{5e0,,-c}. Considerando que comandos Python frequentemente têm espaços em branco (ou outros caracteres que são especiais para a shell) é aconselhável que todo o `comando' esteja entre as aspas.

Alguns módulos Python são também úteis como scripts. Estes podem ser chamados usando @code{python -m módulo [arg] ...} que executa o arquivo fonte do `módulo' como se você tivesse digitado seu caminho completo na linha de comando.

Quando um arquivo de script é utilizado, às vezes é útil executá-lo e logo em seguida entrar em modo interativo. Isto pode ser feito acrescentando o argumento @ref{1523,,-i} antes do nome do script.

Todas as opções de linha de comando são descritas em @ref{1b36,,Linha de comando e ambiente}.

@menu
* Passagem de argumentos:: 
* Modo interativo:: 

@end menu

@node Passagem de argumentos,Modo interativo,,Chamando o interpretador
@anchor{tutorial/interpreter argument-passing}@anchor{1d65}@anchor{tutorial/interpreter tut-argpassing}@anchor{1d66}
@subsubsection Passagem de argumentos


Quando são de conhecimento do interpretador, o nome do script e demais argumentos da linha de comando da shell são acessíveis ao próprio script através da variável @code{argv} do módulo @code{sys}. Pode-se acessar essa lista executando @code{import sys}. Essa lista tem sempre ao menos um elemento; quando nenhum script ou argumento for passado para o interpretador, @code{sys.argv[0]} será uma string vazia. Quando o nome do script for @code{'-'} (significando entrada padrão), o conteúdo de @code{sys.argv[0]} será @code{'-'}. Quando for utilizado @ref{5e0,,-c} `comando', @code{sys.argv[0]} conterá @code{'-c'}. Quando for utilizado @ref{5e1,,-m} `módulo', @code{sys.argv[0]} conterá o caminho completo do módulo localizado. Opções especificadas após @ref{5e0,,-c} `comando' ou @ref{5e1,,-m} `módulo' não serão consumidas pelo interpretador mas deixadas em @code{sys.argv} para serem tratadas pelo comando ou módulo.

@node Modo interativo,,Passagem de argumentos,Chamando o interpretador
@anchor{tutorial/interpreter interactive-mode}@anchor{1d67}@anchor{tutorial/interpreter tut-interactive}@anchor{ffc}
@subsubsection Modo interativo


Quando os comandos são lidos a partir do console, diz-se que o interpretador está em modo interativo. Nesse modo ele solicita um próximo comando através do `prompt primário', tipicamente três sinais de maior (@code{>>>}); para linhas de continuação do comando atual, o `prompt secundário' padrão é formado por três pontos (@code{...}). O interpretador exibe uma mensagem de boas vindas, informando seu número de versão e um aviso de copyright antes de exibir o primeiro prompt:

@example
$ python3.13
Python 3.13 (default, April 4 2023, 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

Linhas de continuação são necessárias em construções multi-linha. Como exemplo, dê uma olhada nesse comando @ref{2f3,,if}:

@example
>>> o_mundo_é_plano = True
>>> if o_mundo_é_plano:
...     print("Cuidado para não cair da borda!")
...
Cuidado para não cair da borda!
@end example

Para mais informações sobre o modo interativo, veja @ref{16f,,Modo interativo}.

@node O interpretador e seu ambiente,,Chamando o interpretador,Utilizando o interpretador Python
@anchor{tutorial/interpreter the-interpreter-and-its-environment}@anchor{1d68}@anchor{tutorial/interpreter tut-interp}@anchor{1d69}
@subsection O interpretador e seu ambiente


@menu
* Edição de código-fonte:: 

@end menu

@node Edição de código-fonte,,,O interpretador e seu ambiente
@anchor{tutorial/interpreter source-code-encoding}@anchor{1d6a}@anchor{tutorial/interpreter tut-source-encoding}@anchor{1d6b}
@subsubsection Edição de código-fonte


Por padrão, arquivos fonte de Python são tratados com codificação UTF-8. Nessa codificação, caracteres de muitos idiomas no mundo podem ser usados simultaneamente em literais string, identificadores e comentários — embora a biblioteca padrão use apenas caracteres ASCII para identificadores, uma convenção que qualquer código portável deve seguir. Para exibir todos esses caracteres corretamente, seu editor deve reconhecer que o arquivo é UTF-8 e deve usar uma fonte com suporte a todos os caracteres no arquivo.

Para declarar uma codificação diferente da padrão, uma linha de comentário especial deve ser adicionada como `primeira' linha do arquivo. A sintaxe é essa:

@example
# -*- coding: encoding -*-
@end example

onde `encoding' é uma das @ref{1b,,codecs} válidas com suporte do Python.

Por exemplo, para declarar que a codificação Windows-1252 deve ser usada, a primeira linha do seu arquivo fonte deve ser:

@example
# -*- coding: cp1252 -*-
@end example

Uma exceção para a regra da `primeira linha' é quando o código-fonte inicia com uma @ref{1d6c,,linha com UNIX “shebang”}. Nesse caso, a declaração de codificação deve ser adicionada como a segunda linha do arquivo. Por exemplo:

@example
#!/usr/bin/env python3
# -*- coding: cp1252 -*-
@end example

@node Uma introdução informal ao Python,Mais ferramentas de controle de fluxo,Utilizando o interpretador Python,O tutorial do Python
@anchor{tutorial/introduction doc}@anchor{1d6d}@anchor{tutorial/introduction an-informal-introduction-to-python}@anchor{1d6e}@anchor{tutorial/introduction translation-repo}@anchor{1d6f}@anchor{tutorial/introduction tut-informal}@anchor{1d70}
@section Uma introdução informal ao Python


Nos exemplos seguintes, pode-se distinguir entrada e saída pela presença ou ausência dos prompts (@ref{16c,,>>>} e @ref{16d,,…}): para repetir o exemplo, você deve digitar tudo após o prompt, quando o mesmo aparece; linhas que não começarem com um prompt são na verdade as saídas geradas pelo interpretador. Observe que quando aparece uma linha contendo apenas o prompt secundário você deve digitar uma linha em branco; é assim que se encerra um comando de múltiplas linhas.


@geindex # (cerquilha);comentário

Muitos exemplos neste manual, mesmo aqueles inscritos na linha de comando interativa, incluem comentários. Comentários em Python começam com o caractere cerquilha @code{#} e estende até o final da linha. Um comentário pode aparecer no inicio da linha ou após espaço em branco ou código, mas não dentro de uma string literal. O caractere cerquilha dentro de uma string literal é apenas uma cerquilha. Como os comentários são para esclarecer o código e não são interpretados pelo Python, eles podem ser omitidos ao digitar exemplos.

Alguns exemplos:

@example
# este é o primeiro comentário
spam = 1  # e este é o segundo comentário
          # ... e agora um terceiro!
texto = "# Este não é um comentário por estar entre aspas."
@end example

@menu
* Usando Python como uma calculadora:: 
* Primeiros passos para a programação:: 

@end menu

@node Usando Python como uma calculadora,Primeiros passos para a programação,,Uma introdução informal ao Python
@anchor{tutorial/introduction tut-calculator}@anchor{1d71}@anchor{tutorial/introduction using-python-as-a-calculator}@anchor{1d72}
@subsection Usando Python como uma calculadora


Vamos experimentar alguns comandos simples em Python. Inicie o interpretador e aguarde o prompt primário, @code{>>>}. (Não deve demorar muito.)

@menu
* Números:: 
* Texto:: 
* Listas:: 

@end menu

@node Números,Texto,,Usando Python como uma calculadora
@anchor{tutorial/introduction numbers}@anchor{1d73}@anchor{tutorial/introduction tut-numbers}@anchor{1d74}
@subsubsection Números


O interpretador funciona como uma calculadora bem simples: você pode digitar uma expressão nele e o resultado será apresentado. A sintaxe de expressões é a usual: operadores @code{+}, @code{-}, @code{*} e @code{/} podem ser usadas para realizar operações aritméticas; parênteses (@code{()}) podem ser usados para agrupar expressões. Por exemplo:

@example
>>> 2 + 2
4
>>> 50 - 5*6
20
>>> (50 - 5*6) / 4
5.0
>>> 8 / 5  # divisão sempre retorna um número de ponto flutuante
1.6
@end example

Os números inteiros (por exemplo, @code{2}, @code{4} e @code{20}) são do tipo @ref{257,,int}, aqueles com parte fracionária (por exemplo, @code{5.0} e @code{1.6}) são do tipo @ref{2f7,,float}. Veremos mais sobre tipos numéricos posteriormente neste tutorial.

Divisão (@code{/}) sempre retorna ponto flutuante (float). Para fazer uma @ref{94b,,divisão pelo piso} e receber um inteiro como resultado você pode usar o operador @code{//}; para calcular o resto você pode usar o @code{%}:

@example
>>> 17 / 3  # divisão clássica retorna um ponto flutuante
5.666666666666667
>>>
>>> 17 // 3  # divisão pelo piso descarta a parte fracionária
5
>>> 17 % 3  # o operador % retorna o resto da divisão
2
>>> 5 * 3 + 2  # quociente do piso * divisor + restante
17
@end example

Com Python, é possível usar o operador @code{**} para calcular potências @footnote{
Uma vez que @code{**} tem precedência mais alta que @code{-}, @code{-3**2} será interpretado como @code{-(3**2)} e assim resultará em @code{-9}. Para evitar isso e obter @code{9}, você pode usar @code{(-3)**2}.
}:

@example
>>> 5 ** 2  # 5 ao quadrado
25
>>> 2 ** 7  # 2 à potência de 7
128
@end example

O sinal de igual (@code{'='}) é usado para atribuir um valor a uma variável. Depois de uma atribuição, nenhum resultado é exibido antes do próximo prompt:

@example
>>> largura = 20
>>> altura = 5 * 9
>>> largura * altura
900
@end example

Se uma variável não é “definida” (não tem um valor atribuído), tentar utilizá-la levantará um erro:

@example
>>> n  # tenta acessar uma variável não definida
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'n' is not defined
@end example

Há suporte completo para ponto flutuante (`float'); operadores com operandos de diferentes tipos convertem o inteiro para ponto flutuante:

@example
>>> 4 * 3.75 - 1
14.0
@end example

No modo interativo, o valor da última expressão exibida é atribuída a variável @code{_}. Assim, ao utilizar Python como uma calculadora, fica mais fácil prosseguir com os cálculos, por exemplo:

@example
>>> taxa = 12.5 / 100
>>> preço = 100.50
>>> preço * taxa
12.5625
>>> preço + _
113.0625
>>> round(_, 2)
113.06
@end example

Essa variável especial deve ser tratada como `somente para leitura' pelo usuário. Nunca lhe atribua explicitamente um valor — do contrário, estaria criando uma outra variável (homônima) independente, que mascararia a variável especial com seu comportamento mágico.

Além de @ref{257,,int} e @ref{2f7,,float}, o Python oferece suporte a outros tipos de números, tais como @ref{29d,,Decimal} e @ref{1e7,,Fraction}. O Python também possui suporte embutido a @ref{1d75,,números complexos}, e usa os sufixos @code{j} ou @code{J} para indicar a parte imaginária (por exemplo, @code{3+5j}).

@node Texto,Listas,Números,Usando Python como uma calculadora
@anchor{tutorial/introduction text}@anchor{1d76}@anchor{tutorial/introduction tut-strings}@anchor{1d77}
@subsubsection Texto


Python pode manipular texto (representado pelo tipo @ref{44c,,str}, também chamado de “strings”), bem como números. Isso inclui caracteres “@code{!}”, palavras “@code{coelho}”, nomes “@code{Paris}”, frases “@code{Eu te protejo.}”, etc. “@code{Oba! :)}”. Eles podem ser colocados entre aspas simples (@code{'...'}) ou aspas duplas (@code{"..."}) com o mesmo resultado @footnote{
Ao contrário de outras linguagens, caracteres especiais como @code{\n} têm o mesmo significado com as aspas simples (@code{'...'}) e duplas (@code{"..."}) . A única diferença entre as duas é que, dentro de aspas simples, você não precisa escapar o @code{"} (mas você deve escapar a @code{\'}) e vice-versa.
}.

@example
>>> 'spam eggs'  # aspas simples
'spam eggs'
>>> "Coelho de Paris, eu te projeto :)! Viva!"  # aspas duplas
'Coelho de Paris, eu te projeto :)! Viva!'
>>> '1975'  # dígitos e numerais envoltos em aspas também são strings
'1975'
@end example

Para colocar aspas entre aspas, precisamos “escapá-la”, precedendo-as com @code{\}. Alternativamente, podemos usar o outro tipo de aspas:

@example
>>> 'd\'água'  # use \' para escapar a aspa simples...
"d'água"
>>> "d'água"  # ...ou use aspas duplas
"d'água"
>>> '"Sim", eles disseram.'
'"Sim", eles disseram.'
>>> "\"Sim\", eles disseram."
'"Sim", eles disseram.'
>>> '"Copo d\'água", eles pediram.'
'"Copo d'água", eles pediram.'
@end example

No shell do Python, a definição de string e a string de saída podem parecer diferentes. A função @ref{fa9,,print()} produz uma saída mais legível, omitindo as aspas delimitadoras e imprimindo caracteres de escape e especiais:

@example
>>> s = 'Primeira linha.\nSegunda linha.'  # \n significa nova linha
>>> s  # sem print(), caracteres especiais são incluídos na string
'Primeira linha.\nSegunda linha.'
>>> print(s)  # com print(), caracteres especiais são interpretados, então \n produz nova linha
Primeira linha.
Segunda linha.
@end example

Caso não queira que os caracteres sejam precedidos por @code{\} para serem interpretados como caracteres especiais, você pode usar `strings brutas' (`raw', em inglês) adicionando um @code{r} antes da primeira aspa:

@example
>>> print('C:\algum\nome')  # aqui \n significa nova linha!
C:\algum
ome
>>> print(r'C:\algum\nome')  # observe o r antes das aspas
C:\algum\nome
@end example

Há um aspecto sutil nas strings brutas: uma string bruta não pode terminar em um número ímpar de caracteres @code{\}; consulte @ref{1d78,,o FAQ relacionado} para mais informações e soluções alternativas.

As strings literais podem abranger várias linhas. Uma maneira é usar as aspas triplas: @code{"""..."""} ou @code{'@w{'}'...'@w{'}'}. Caracteres de fim de linha são incluídos automaticamente na string, mas é possível evitar isso adicionando uma @code{\} no final. No exemplo a seguir, a nova linha no início não é incluída:

@example
>>> print("""\
... Uso: coisinha [OPÇÕES]
...      -h                        Exibe esta mensagem de uso
...      -H hostname               Hostname para se conectar
... """)
Usage: coisinha [OPÇÕES]
     -h                        Exibe esta mensagem de ajuda
     -H hostname               Hostname para se conectar

>>>
@end example

Strings podem ser concatenadas (coladas) com o operador @code{+}, e repetidas com @code{*}:

@example
>>> # 3 vezes 'un', seguido por 'ium'
>>> 3 * 'un' + 'ium'
'unununium'
@end example

Duas ou mais `strings literais' (ou seja, entre aspas) ao lado da outra são automaticamente concatenados.

@example
>>> 'Py' 'thon'
'Python'
@end example

Esse recurso é particularmente útil quando você quer quebrar strings longas:

@example
>>> texto = ('Coloque várias strings dentro de parênteses '
...          'para fazer com que elas sejam concatenadas.')
>>> texto
'Coloque várias strings dentro de parênteses para fazer com que elas sejam concatenadas.'
@end example

Isso só funciona com duas strings literais, não com variáveis ou expressões:

@example
>>> prefixo = 'Py'
>>> prefixo 'thon'  # não é possível concatenar uma variável e um literal de string
  File "<stdin>", line 1
    prefixi 'thon'
           ^^^^^^
SyntaxError: invalid syntax
>>> ('un' * 3) 'ium'
  File "<stdin>", line 1
    ('un' * 3) 'ium'
               ^^^^^
SyntaxError: invalid syntax
@end example

Se você quiser concatenar variáveis ou uma variável e uma literal, use @code{+}:

@example
>>> prefixo + 'thon'
'Python'
@end example

As strings podem ser `indexadas' (subscritas), com o primeiro caractere como índice 0. Não existe um tipo específico para caracteres; um caractere é simplesmente uma string cujo tamanho é 1:

@example
>>> palavra = 'Python'
>>> palavra[0]  # caractere na posição 0
'P'
>>> palavra[5]  # caractere na posição 5
'n'
@end example

Índices também podem ser números negativos para iniciar a contagem pela direita:

@example
>>> palavra[-1]  # último caractere
'n'
>>> palavra[-2]  # penúltimo caractere
'o'
>>> palavra[-6]
'P'
@end example

Note que dado que -0 é o mesmo que 0, índices negativos começam em -1.

Além da indexação, o `fatiamento' também é permitido. Embora a indexação seja usada para obter caracteres individuais, `fatiar' permite que você obtenha uma substring:

@example
>>> palavra[0:2]  # caracteres da posição 0 (incluída) até 2 (excluída)
'Py'
>>> palavra[2:5]  # caracteres da posição 2 (incluída) até 5 (excluída)
'tho'
@end example

Os índices do fatiamento possuem padrões úteis; um primeiro índice omitido padrão é zero, um segundo índice omitido é por padrão o tamanho da string sendo fatiada:

@example
>>> palavra[:2]   # caracteres do início até a posição 2 (excluída)
'Py'
>>> palavra[4:]   # caracteres da posição 4 (incluída) até o fim
'on'
>>> palavra[-2:]  # caracteres da penúltima (incluída) até o fim
'on'
@end example

Observe como o início sempre está incluído, e o fim sempre é excluído. Isso garante que @code{s[:i] + s[i:]} seja sempre igual a @code{s}:

@example
>>> palavra[:2] + palavra[2:]
'Python'
>>> palavra[:4] + palavra[4:]
'Python'
@end example

Uma maneira de lembrar como fatias funcionam é pensar que os índices indicam posições `entre' caracteres, onde a borda esquerda do primeiro caractere é 0. Assim, a borda direita do último caractere de uma string de comprimento `n' tem índice `n', por exemplo:

@example
 +---+---+---+---+---+---+
 | P | y | t | h | o | n |
 +---+---+---+---+---+---+
 0   1   2   3   4   5   6
-6  -5  -4  -3  -2  -1
@end example

A primeira fileira de números indica a posição dos índices 0…6 na string; a segunda fileira indica a posição dos respectivos índices negativos. Uma fatia de `i' a `j' consiste em todos os caracteres entre as bordas `i' e `j', respectivamente.

Para índices positivos, o comprimento da fatia é a diferença entre os índices, se ambos estão dentro dos limites da string. Por exemplo, o comprimento de @code{word[1:3]} é 2.

A tentativa de usar um índice que seja muito grande resultará em um erro:

@example
>>> palavra[42]  # a palavra só tem 6 caracteres
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
IndexError: string index out of range
@end example

No entanto, os índices de fatiamento fora do alcance são tratados graciosamente (N.d.T: o termo original “gracefully” indica robustez no tratamento de erros) quando usados para fatiamento. Um índice maior que o comprimento é trocado pelo comprimento, um limite superior menor que o limite inferior produz uma string vazia:

@example
>>> palavra[4:42]
'on'
>>> palavra[42:]
'@w{'}
@end example

As strings do Python não podem ser alteradas — uma string é @ref{1d79,,imutável}. Portanto, atribuir a uma posição indexada na sequência resulta em um erro:

@example
>>> palavra[0] = 'J'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
>>> palavra[2:] = 'py'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
@end example

Se você precisar de uma string diferente, deverá criar uma nova:

@example
>>> 'J' + palavra[1:]
'Jython'
>>> palavra[:2] + 'py'
'Pypy'
@end example

A função embutida @ref{62e,,len()} devolve o comprimento de uma string:

@example
>>> s = 'supercalifragilisticexpialidoce'
>>> len(s)
31
@end example


@subsubheading Ver também



@table @asis

@item @ref{1d7a,,Tipo sequência de texto — str}

As strings são exemplos de `tipos de sequências' e suportam as operações comumente suportadas por esses tipos.

@item @ref{1d7b,,String Methods}

As strings suportam uma grande quantidade de métodos para transformações básicas e busca.

@item @ref{9b1,,f-strings}

Strings literais que possuem expressões embutidas.

@item @ref{13e2,,Sintaxe das strings de formato}

Informações sobre formatação de string com o método @ref{621,,str.format()}.

@item @ref{6cc,,Formatação de string no estilo printf}

As antigas operações de formatação invocadas quando as strings são o operando esquerdo do operador @code{%} são descritas com mais detalhes aqui.
@end table


@node Listas,,Texto,Usando Python como uma calculadora
@anchor{tutorial/introduction lists}@anchor{1d7c}@anchor{tutorial/introduction tut-lists}@anchor{1d7d}
@subsubsection Listas


Python inclui diversas estruturas de dados `compostas', usadas para agrupar outros valores. A mais versátil é `list' (lista), que pode ser escrita como uma lista de valores (itens) separados por vírgula, entre colchetes. Os valores contidos na lista não precisam ser todos do mesmo tipo.

@example
>>> quadrados = [1, 4, 9, 16, 25]
>>> quadrados
[1, 4, 9, 16, 25]
@end example

Como strings (e todos os tipos embutidos de @ref{4f1,,sequência}), listas pode ser indexados e fatiados:

@example
>>> quadrados[0]  # indexação retorna o item
1
>>> quadrados[-1]
25
>>> quadrados[-3:]  # fatiamento retorna uma nova lista
[9, 16, 25]
@end example

As listas também suportam operações como concatenação:

@example
>>> quadrados + [36, 49, 64, 81, 100]
[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]
@end example

Diferentemente de strings, que são @ref{1d79,,imutáveis}, listas são @ref{1d7e,,mutáveis}, ou seja, é possível alterar elementos individuais de uma lista:

@example
>>> cubos = [1, 8, 27, 65, 125]  # algo errado aqui
>>> 4 ** 3  # o cubo de 4 é 64, não 65!
64
>>> cubos[3] = 64  # substitui o valor errado
>>> cubos
[1, 8, 27, 64, 125]
@end example

Você também pode adicionar novos itens no final da lista, usando o `método' @ref{6cd,,list.append()} (estudaremos mais a respeito dos métodos posteriormente):

@example
>>> cubos.append(216)  # adiciona o cubo de 6
>>> cubos.append(7 ** 3)  # e o cubo de 7
>>> cubos
[1, 8, 27, 64, 125, 216, 343]
@end example

A atribuição simples em Python nunca copia dados. Quando você atribui uma lista a uma variável, a variável se refere à `lista existente'. Quaisquer alterações que você fizer na lista por meio de uma variável serão vistas por todas as outras variáveis que se referem a ela:

@example
>>> rgb = ["Vermelho", "Verde", "Azul"]
>>> rgba = rgb
>>> id(rgb) == id(rgba)  # elas referenciam o mesmo objeto
True
>>> rgba.append("Alf")
>>> rgb
["Vermelho", "Verde", "Azul", "Alf"]
@end example

Todas as operações de fatiamento devolvem uma nova lista contendo os elementos solicitados. Isso significa que o seguinte fatiamento devolve uma @ref{1d7f,,cópia rasa} da lista:

@example
>>> rgba_correto = rgba[:]
>>> rgba_correto[-1] = "Alfa"
>>> rgba_correto
["Vermelho", "Verde", "Azul", "Alfa"]
>>> rgba
["Vermelho", "Verde", "Azul", "Alf"]
@end example

Atribuição a fatias também é possível, e isso pode até alterar o tamanho da lista ou remover todos os itens dela:

@example
>>> letras = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> letras
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> # substitui alguns valores
>>> letras[2:5] = ['C', 'D', 'E']
>>> letras
['a', 'b', 'C', 'D', 'E', 'f', 'g']
>>> # agora remove-os
>>> letras[2:5] = []
>>> letras
['a', 'b', 'f', 'g']
>>> # limpa a lista substituindo todos os elementos por uma lista vazia
>>> letras[:] = []
>>> letras
[]
@end example

A função embutida @ref{62e,,len()} também se aplica a listas:

@example
>>> letras = ['a', 'b', 'c', 'd']
>>> len(letras)
4
@end example

É possível aninhar listas (criar listas contendo outras listas), por exemplo:

@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 Primeiros passos para a programação,,Usando Python como uma calculadora,Uma introdução informal ao Python
@anchor{tutorial/introduction first-steps-towards-programming}@anchor{1d80}@anchor{tutorial/introduction tut-firststeps}@anchor{1d81}
@subsection Primeiros passos para a programação


Claro, podemos usar o Python para tarefas mais complicadas do que somar 2+2. Por exemplo, podemos escrever o início da sequência de Fibonacci@footnote{https://pt.wikipedia.org/wiki/Sequência_de_Fibonacci} assim:

@example
>>> # Sequência de Fibonacci:
>>> # a soma de dois elementos define a próxima
>>> a, b = 0, 1
>>> while a < 10:
...     print(a)
...     a, b = b, a+b
...
0
1
1
2
3
5
8
@end example

Este exemplo introduz diversas características ainda não mencionadas.


@itemize *

@item 
A primeira linha contém uma atribuição múltipla: as variáveis @code{a} e @code{b} recebem simultaneamente os novos valores 0 e 1. Na última linha há outro exemplo de atribuição múltipla demonstrando que expressões do lado direito são sempre avaliadas primeiro, antes da atribuição. As expressões do lado direito são avaliadas da esquerda para a direita.

@item 
O laço de repetição @ref{1d82,,while} executa enquanto a condição (aqui: @code{a < 10}) permanece verdadeira. Em Python, como em C, qualquer valor inteiro que não seja zero é considerado verdadeiro; zero é considerado falso. A condição pode também ser uma cadeia de caracteres ou uma lista, ou qualquer sequência; qualquer coisa com um tamanho maior que zero é verdadeiro, enquanto sequências vazias são falsas. O teste usado no exemplo é uma comparação simples. Os operadores padrões de comparação são os mesmos de C: @code{<} (menor que), @code{>} (maior que), @code{==} (igual), @code{<=} (menor ou igual), @code{>=} (maior ou igual) e @code{!=} (diferente).

@item 
O `corpo' do laço é `indentado': indentação em Python é a maneira de agrupar comandos em blocos. No console interativo padrão você terá que digitar tab ou espaços para indentar cada linha. Na prática você vai preparar scripts Python mais complicados em um editor de texto; a maioria dos editores de texto tem facilidades de indentação automática. Quando um comando composto é digitado interativamente, deve ser finalizado por uma linha em branco (já que o interpretador não tem como adivinhar qual é a última linha do comando). Observe que toda linha de um mesmo bloco de comandos deve ter a mesma indentação.

@item 
A função @ref{fa9,,print()} escreve o valor dos argumentos fornecidos. É diferente de apenas escrever a expressão no interpretador (como fizemos anteriormente nos exemplos da calculadora) pela forma como lida com múltiplos argumentos, quantidades de ponto flutuante e strings. As strings são impressas sem aspas, e um espaço é inserido entre os itens, assim você pode formatar bem o resultado, dessa forma:

@example
>>> i = 256*256
>>> print('O valor de i é', i)
O valor de i é 65536
@end example

O argumento nomeado `end' pode ser usado para evitar uma nova linha após a saída ou finalizar a saída com uma string 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

@node Mais ferramentas de controle de fluxo,Estruturas de dados,Uma introdução informal ao Python,O tutorial do Python
@anchor{tutorial/controlflow doc}@anchor{1d83}@anchor{tutorial/controlflow more-control-flow-tools}@anchor{1d84}@anchor{tutorial/controlflow translation-repo}@anchor{1d85}@anchor{tutorial/controlflow tut-morecontrol}@anchor{1d86}
@section Mais ferramentas de controle de fluxo


Assim como a instrução @ref{1d82,,while} que acabou de ser apresentada, o Python usa mais algumas que encontraremos neste capítulo.

@menu
* Instruções if:: 
* Instruções for:: 
* A função range(): A função range. 
* Instruções break e continue:: 
* Cláusulas else em laços:: 
* Instruções pass:: 
* Instruções match:: 
* Definindo funções:: 
* Mais sobre definição de funções:: 
* Intermezzo; estilo de codificação: Intermezzo estilo de codificação. 

@end menu

@node Instruções if,Instruções for,,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow if-statements}@anchor{1d87}@anchor{tutorial/controlflow tut-if}@anchor{1d88}
@subsection Instruções @code{if}


Provavelmente a mais conhecida instrução de controle de fluxo é o @ref{2f3,,if}. Por exemplo:

@example
>>> x = int(input("Insira um número inteiro: "))
Insira um número inteiro: 42
>>> if x < 0:
...     x = 0
...     print('Negativo alterado para zero')
... elif x == 0:
...     print('Zero')
... elif x == 1:
...     print('Um')
... else:
...     print('Mais')
...
Mais
@end example

Pode haver zero ou mais partes @ref{1d89,,elif}, e a parte @ref{18c,,else} é opcional. A palavra-chave ‘@code{elif}’ é uma abreviação para ‘else if’, e é útil para evitar indentação excessiva. Uma sequência @code{if} … @code{elif} … @code{elif} … substitui as instruções @code{switch} ou @code{case}, encontrados em outras linguagens.

Se você está comparando o mesmo valor com várias constantes, ou verificando por tipos ou atributos específicos, você também pode achar a instrução @code{match} útil. Para mais detalhes veja @ref{1d8a,,Instruções match}.

@node Instruções for,A função range,Instruções if,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow for-statements}@anchor{1d8b}@anchor{tutorial/controlflow tut-for}@anchor{1d8c}
@subsection Instruções @code{for}


@geindex instrução;for

A instrução @ref{2f2,,for} em Python é um pouco diferente do que costuma ser em C ou Pascal. Ao invés de sempre iterar sobre uma progressão aritmética de números (como no Pascal), ou permitir ao usuário definir o passo de iteração e a condição de parada (como C), a instrução @code{for} do Python itera sobre os itens de qualquer sequência (seja uma lista ou uma string), na ordem que aparecem na sequência. Por exemplo:

@c One suggestion was to give a real C example here, but that may only serve to
@c confuse non-C programmers.

@example
>>> # Mede algumas strings:
>>> palavras = ['gato', 'janela', 'defenestrar']
>>> for p in palavras:
...     print(p, len(p))
...
gato 4
janela 6
defenestrar 11
@end example

Código que modifica uma coleção sobre a qual está iterando pode ser inseguro. No lugar disso, usualmente você deve iterar sobre uma cópia da coleção ou criar uma nova coleção:

@example
# Cria uma amostra de coleção
users = @{'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'@}

# Estratégia: iterar por uma cópia
for user, status in users.copy().items():
    if status == 'inactive':
        del users[user]

# Estratégia: criar uma nova coleção
active_users = @{@}
for user, status in users.items():
    if status == 'active':
        active_users[user] = status
@end example

@node A função range,Instruções break e continue,Instruções for,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow the-range-function}@anchor{1d8d}@anchor{tutorial/controlflow tut-range}@anchor{1d8e}
@subsection A função @code{range()}


Se você precisa iterar sobre sequências numéricas, a função embutida @ref{94a,,range()} é a resposta. Ela gera progressões aritméticas:

@example
>>> for i in range(5):
...     print(i)
...
0
1
2
3
4
@end example

O ponto de parada fornecido nunca é incluído na lista; @code{range(10)} gera uma lista com 10 valores, exatamente os índices válidos para uma sequência de comprimento 10. É possível iniciar o intervalo com outro número, ou alterar a razão da progressão (inclusive com passo negativo):

@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 os índices de uma sequência, combine @ref{94a,,range()} e @ref{62e,,len()} da seguinte forma:

@example
>>> a = ['Maria', 'tinha', 'um', 'carneirinho']
>>> for i in range(len(a)):
...     print(i, a[i])
...
0 Maria
1 tinha
2 um
3 carneirinho
@end example

Na maioria dos casos, porém, é mais conveniente usar a função @ref{14c9,,enumerate()}, veja @ref{1d8f,,Técnicas de iteração}.

Uma coisa estranha acontece se você imprime um intervalo:

@example
>>> range(10)
range(0, 10)
@end example

Em muitos aspectos, o objeto retornado pela função @ref{94a,,range()} se comporta como se fosse uma lista, mas na verdade não é. É um objeto que retorna os itens sucessivos da sequência desejada quando você itera sobre a mesma, mas na verdade ele não gera a lista, economizando espaço.

Dizemos que um objeto é @ref{1268,,iterável}, isso é, candidato a ser alvo de uma função ou construção que espera alguma coisa capaz de retornar sucessivamente seus elementos um de cada vez. Nós vimos que a instrução @ref{2f2,,for} é um exemplo de construção, enquanto que um exemplo de função que recebe um iterável é @ref{46a,,sum()}:

@example
>>> sum(range(4))  # 0 + 1 + 2 + 3
6
@end example

Mais tarde, veremos mais funções que retornam iteráveis e tomam iteráveis como argumentos. No capítulo @ref{1d90,,Estruturas de dados}, iremos discutir em mais detalhes sobre @ref{611,,list()}.

@node Instruções break e continue,Cláusulas else em laços,A função range,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow break-and-continue-statements}@anchor{1d91}@anchor{tutorial/controlflow tut-break}@anchor{1d92}
@subsection Instruções @code{break} e @code{continue}


A instrução @ref{ab8,,break} sai imediatamente do laço de repetição mais interno, seja @ref{2f2,,for} ou @ref{1d82,,while}:

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(f"@{n@} igual a @{x@} * @{n//x@}")
...             break
...
4 igual a 2 * 2
6 igual a 2 * 3
8 igual a 2 * 4
9 equals 3 * 3
@end example

A instrução @ref{9d1,,continue} continua com a próxima iteração do laço:

@example
>>> for num in range(2, 10):
...     if num % 2 == 0:
...         print(f"Encontrado um número par @{num@}")
...         continue
...     print(f"Encontrado um número ímpar @{num@}")
...
Encontrado um número par 2
Encontrado um número ímpar 3
Encontrado um número par 4
Encontrado um número ímpar 5
Encontrado um número par 6
Encontrado um número ímpar 7
Encontrado um número par 8
Encontrado um número ímpar 9
@end example
@anchor{tutorial/controlflow tut-for-else}@anchor{1d93}
@node Cláusulas else em laços,Instruções pass,Instruções break e continue,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow break-and-continue-statements-and-else-clauses-on-loops}@anchor{1d94}@anchor{tutorial/controlflow else-clauses-on-loops}@anchor{1d95}
@subsection Cláusulas @code{else} em laços


Em um laço @code{for} ou @code{while} a instrução @code{break} pode ser pareada com uma cláusula @code{else}. Se o laço terminar sem executar o @code{break}, a cláusula @code{else} será executada.

Em um laço @ref{2f2,,for}, a cláusula @code{else} é executada após o laço finalizar sua iteração final, ou seja, se não ocorrer nenhuma interrupção.

Em um laço @ref{1d82,,while}, ele é executado após a condição do laço se tornar falsa.

Em qualquer tipo de laço, a cláusula @code{else} `não' é executada se o laço foi encerrado por um @ref{ab8,,break}. Claro, outras maneiras de encerrar o laço mais cedo, como um @ref{9d6,,return} ou uma exceção levantada, também pularão a execução da cláusula @ref{18c,,else}.

Isso é exemplificado no seguinte laço @code{for}, que procura por números primos:

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(n, 'igual a', x, '*', n//x)
...             break
...     else:
...         # a iteração passou direto sem encontrar um fator
...         print(n, 'é um número primo')
...
2 é um número primo
3 é um número primo
4 igual a 2 * 2
5 é um número primo
6 igual a 2 * 3
7 é um número primo
8 igual a 2 * 4
9 igual a 3 * 3
@end example

(Sim, este é o código correto. Observe atentamente: a cláusula @code{else} pertence ao laço @code{for}, `não' à instrução @code{if}.)

Uma maneira de pensar na cláusula else é imaginá-la pareada com o @code{if} dentro do laço. Conforme o laço é executado, ele executará uma sequência como if/if/if/else. O @code{if} está dentro do laço, encontrado várias vezes. Se a condição for verdadeira, um @code{break} acontecerá. Se a condição nunca for verdadeira, a cláusula @code{else} fora do laço será executada.

Quando usado em um laço, a cláusula @code{else} tem mais em comum com a cláusula @code{else} de uma instrução @ref{6e9,,try} do que com a de instruções @code{if}: a cláusula @code{else} de uma instrução @code{try} é executada quando não ocorre exceção, e a cláusula @code{else} de um laço é executada quando não ocorre um @code{break}. Para mais informações sobre instrução @code{try} e exceções, veja @ref{1d96,,Tratamento de exceções}.

@geindex ...;literal de reticências

@node Instruções pass,Instruções match,Cláusulas else em laços,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow pass-statements}@anchor{1d97}@anchor{tutorial/controlflow tut-pass}@anchor{1d98}
@subsection Instruções @code{pass}


A instrução @ref{1d99,,pass} não faz nada. Pode ser usada quando a sintaxe exige uma instrução, mas a semântica do programa não requer nenhuma ação. Por exemplo:

@example
>>> while True:
...     pass  # Ocupado, aguardando interrupção por teclado (Ctrl+C)
...
@end example

Isto é usado muitas vezes para se definir classes mínimas:

@example
>>> class MinhaClasseVazia:
...     pass
...
@end example

Outra ocasião em que o @ref{1d99,,pass} pode ser usado é como um substituto temporário para uma função ou bloco condicional, quando se está trabalhando com código novo, ainda indefinido, permitindo que mantenha-se o pensamento num nível mais abstrato. O @code{pass} é silenciosamente ignorado:

@example
>>> def initlog(*args):
...     pass   # Lembre-se de implementar isso!
...
@end example

Para este último caso, muitas pessoas usam o literal de reticências @code{...} em vez de @code{pass}. Este uso não tem significado especial para Python e não faz parte da definição da linguagem (você pode usar qualquer expressão constante aqui), mas @code{...} também é usado convencionalmente como um espaço reservado. Consulte @ref{1d9a,,O Objeto Ellipsis}.

@node Instruções match,Definindo funções,Instruções pass,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow match-statements}@anchor{1d9b}@anchor{tutorial/controlflow tut-match}@anchor{1d8a}
@subsection Instruções @code{match}


Uma instrução @ref{810,,match} pega uma expressão e compara seu valor com padrões sucessivos fornecidos como um ou mais blocos de case. Isso é superficialmente semelhante a uma instrução switch em C, Java ou JavaScript (e muitas outras linguagens), mas também pode extrair componentes (elementos de sequência ou atributos de objeto) do valor em variáveis, mas muito mais parecido com a correspondência de padrões em linguages como Rust ou Haskell. Apenas o primeiro padrão que corresponder será executado, podendo também extrair componentes (elementos de sequência ou atributos de objetos) do valor para variáveis.

A forma mais simples compara um valor de assunto com um ou mais literais:

@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

Observe o último bloco: o “nome da variável” @code{_} atua como um `curinga' e nunca falha em corresponder. Se nenhum caso corresponder, nenhuma das ramificações será executada.

Você pode combinar vários literais em um único padrão usando @code{|} (“ou”):

@example
case 401 | 403 | 404:
    return "Não permitido"
@end example

Os padrões podem se parecer com atribuições de desempacotamento e podem ser usados para vincular variáveis:

@example
# ponto é uma tupla (x, y)
match ponto:
    case (0, 0):
        print("Origem")
    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("Não é um ponto")
@end example

Estude isso com cuidado! O primeiro padrão tem dois literais e pode ser considerado uma extensão do padrão literal mostrado acima. Mas os próximos dois padrões combinam um literal e uma variável, e a variável `vincula' um valor do assunto (@code{ponto}). O quarto padrão captura dois valores, o que o torna conceitualmente semelhante à atribuição de desempacotamento @code{(x, y) = ponto}.

Se você estiver usando classes para estruturar seus dados, você pode usar o nome da classe seguido por uma lista de argumentos semelhante a um construtor, mas com a capacidade de capturar atributos em variáveis:

@example
class Ponto:
    def __init__(self, x, y):
        self.x = x
        self.y = y

def onde_está(ponto):
    match ponto:
        case Ponto(x=0, y=0):
            print("Origem")
        case Ponto(x=0, y=y):
            print(f"Y=@{y@}")
        case Ponto(x=x, y=0):
            print(f"X=@{x@}")
        case Ponto():
            print("Em outro lugar")
        case _:
            print("Não é um ponto")
@end example

Você pode usar parâmetros posicionais com algumas classes embutidas que fornecem uma ordem para seus atributos (por exemplo, classes de dados). Você também pode definir uma posição específica para atributos em padrões configurando o atributo especial @code{__match_args__} em suas classes. Se for definido como (“x”, “y”), os seguintes padrões são todos equivalentes (e todos ligam o atributo @code{y} à variável @code{var}):

@example
Ponto(1, var)
Ponto(1, y=var)
Ponto(x=1, y=var)
Ponto(y=var, x=1)
@end example

Uma maneira recomendada de ler padrões é vê-los como uma forma estendida do que você colocaria à esquerda de uma atribuição, para entender quais variáveis seriam definidas para quê. Apenas os nomes autônomos (como @code{var} acima) são atribuídos por uma instrução de correspondência. Nomes pontilhados (como @code{foo.bar}), nomes de atributos (o @code{x=} e @code{y=} acima) ou nomes de classes (reconhecidos pelo “(…)” próximo a eles, como @code{Ponto} acima) nunca são atribuídos.

Os padrões podem ser aninhados arbitrariamente. Por exemplo, se tivermos uma pequena lista de Pontos, com @code{__match_args__} adicionado, poderíamos correspondê-la assim:

@example
class Ponto:
    __match_args__ = ('x', 'y')
    def __init__(self, x, y):
        self.x = x
        self.y = y

match pontos:
    case []:
        print("Sem pontos")
    case [Ponto(0, 0)]:
        print("A origem")
    case [Ponto(x, y)]:
        print(f"Ponto único @{x@}, @{y@}")
    case [Ponto(0, y1), Ponto(0, y2)]:
        print(f"Dois do eixo Y em @{y1@}, @{y2@}")
    case _:
        print("Outra coisa")
@end example

Podemos adicionar uma cláusula @code{if} a um padrão, conhecido como “guarda”. Se a guarda for falsa, @code{match} tenta o próximo bloco de caso. Observe que a captura de valor ocorre antes que a guarda seja avaliada:

@example
match ponto:
    case Ponto(x, y) if x == y:
        print(f"Y=X at @{x@}")
    case Ponto(x, y):
        print(f"Não está na diagonal")
@end example

Vários outros recursos importantes desta instrução:


@itemize -

@item 
Assim como desempacotar atribuições, os padrões de tupla e lista têm exatamente o mesmo significado e realmente correspondem a sequências arbitrárias. Uma exceção importante é que eles não correspondem a iteradores ou strings.

@item 
Os padrões de sequência têm suporte ao desempacotamento estendido: @code{[x, y, *rest]} e @code{(x, y, *rest)} funcionam de forma semelhante ao desempacotamento de atribuições. O nome depois de @code{*} também pode ser @code{_}, então @code{(x, y, *_)} corresponde a uma sequência de pelo menos dois itens sem ligar os itens restantes.

@item 
Padrões de mapeamento: @code{@{"bandwidth": b, "latency": l@}} captura os valores @code{"bandwidth"} e @code{"latency"} de um dicionário. Diferente dos padrões de sequência, chaves extra são ignoradas.  Um desempacotamento como @code{**rest} também é permitido.  (Mas @code{**_} seria redundante, então não é permitido.)

@item 
Subpadrões podem ser capturados usando a palavra reservada @code{as}

@example
case (Ponto(x1, y1), Ponto(x2, y2) as p2): ...
@end example

Vai capturar o segundo elemento da entrada como @code{p2} (se a entrada for uma sequência de dois pontos)

@item 
A maioria dos literais são comparados por igualdade, no entanto os singletons @code{True}, @code{False} e @code{None} são comparados por identidade.

@item 
Padrões podem usar constantes nomeadas. Estas devem ser nomes pontilhados para prevenir que sejam interpretadas como variáveis de captura:

@example
from enum import Enum
class Cor(Enum):
    VERMELHO = 'vermelho'
    VERDE = 'verde'
    AZUL = 'azul'

cor = Cor(input("Insira sua escolha de 'vermelho, 'azul' ou 'verde': "))

match color:
    case Cor.VERMELHO:
        print("Eu vejo vermelho!")
    case Cor.VERDE:
        print("Grama é verde")
    case Cor.AZUL:
        print("O céu é azul :)")
@end example
@end itemize

Para uma explicação mais detalhada e exemplos adicionais, você pode olhar 
@geindex Propostas de Melhorias do Python; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} que foi escrita em formato de tutorial.

@node Definindo funções,Mais sobre definição de funções,Instruções match,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow defining-functions}@anchor{1d9c}@anchor{tutorial/controlflow tut-functions}@anchor{1d9d}
@subsection Definindo funções


Podemos criar uma função que escreve a série de Fibonacci até um limite arbitrário:

@example
>>> def fib(n):    # escreve série de Fibonacci menor que n
...     """Imprime uma série de Fibonacci menor que n."""
...     a, b = 0, 1
...     while a < n:
...         print(a, end=' ')
...         a, b = b, a+b
...     print()
...
>>> # Agora chamamos a função que acabamos de definir:
>>> fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
@end example

@geindex strings@comma{} documentação
@geindex docstrings
@geindex strings@comma{} documentação

A palavra reservada @ref{14a2,,def} inicia a `definição' de uma função. Ela deve ser seguida do nome da função e da lista de parâmetros formais entre parênteses. As instruções que formam o corpo da função começam na linha seguinte e devem ser indentados.

Opcionalmente, a primeira linha do corpo da função pode ser uma literal string, cujo propósito é documentar a função. Se presente, essa string chama-se `docstring'. (Há mais informação sobre docstrings na seção @ref{1d9e,,Strings de documentação}.) Existem ferramentas que utilizam docstrings para produzir automaticamente documentação online ou para imprimir, ou ainda, permitir que o usuário navegue interativamente pelo código. É uma boa prática incluir sempre docstrings em suas funções, portanto, tente fazer disso um hábito.

A `execução' de uma função cria uma nova tabela de símbolos para as variáveis locais da função. Mais precisamente, todas as atribuições de variáveis numa função são armazenadas na tabela de símbolos local; referências a variáveis são buscadas primeiro na tabela de símbolos local, em seguida na tabela de símbolos locais de funções delimitadoras ou circundantes, depois na tabela de símbolos global e, finalmente, na tabela de nomes da própria linguagem. Embora possam ser referenciadas, variáveis globais e de funções externas não podem ter atribuições (a menos que seja utilizada a instrução @ref{18a,,global}, para variáveis globais, ou @ref{12ea,,nonlocal}, para variáveis de funções externas).

Os parâmetros reais (argumentos) de uma chamada de função são introduzidos na tabela de símbolos local da função no momento da chamada; portanto, argumentos são passados `por valor' (onde o `valor' é sempre uma `referência' para objeto, não o valor do objeto). @footnote{
Na verdade, `passagem por referência para objeto' seria uma descrição melhor, pois, se um objeto mutável for passado, quem chamou verá as alterações feitas por quem foi chamado (por exemplo, a inclusão de itens em uma lista).
} Quando uma função chama outra função, ou chama a si mesma recursivamente, uma nova tabela de símbolos é criada para tal chamada.

Uma definição de função associa o nome da função com o objeto função na tabela de símbolos atual. O interpretador reconhece o objeto apontado pelo nome como uma função definida pelo usuário. Outros nomes também podem apontar para o mesmo objeto função e também pode ser usados pra acessar a função:

@example
>>> fib
<function fib at 10042ed0>
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89
@end example

Conhecendo outras linguagens, pode-se questionar que @code{fib} não é uma função, mas um procedimento, pois ela não devolve um valor. Na verdade, mesmo funções que não usam a instrução @ref{9d6,,return} devolvem um valor, ainda que pouco interessante. Esse valor é chamado @code{None} (é um nome embutido). O interpretador interativo evita escrever @code{None} quando ele é o único resultado de uma expressão. Mas se quiser vê-lo pode usar a função @ref{fa9,,print()}:

@example
>>> fib(0)
>>> print(fib(0))
None
@end example

É fácil escrever uma função que retorna uma lista de números da série de Fibonacci, ao invés de exibi-los:

@example
>>> def fib2(n):  # retorna série de  Fibonacci até n
...     """Retorna uma lista contendo a série de Fibonacci até n."""
...     resultado = []
...     a, b = 0, 1
...     while a < n:
...         resultado.append(a)    # veja abaixo
...         a, b = b, a+b
...     return resultado
...
>>> f100 = fib2(100)    # chama-o
>>> f100                # escreve o resultado
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
@end example

Este exemplo demonstra novos recursos de Python:


@itemize *

@item 
A instrução @ref{9d6,,return} finaliza a execução e retorna um valor da função. @code{return} sem qualquer expressão como argumento retorna @code{None}. Atingir o final da função também retorna @code{None}.

@item 
A instrução @code{result.append(a)} chama um `método' do objeto lista @code{result}. Um método é uma função que ‘pertence’ a um objeto, e é chamada @code{obj.nomemetodo}, onde @code{obj} é um objeto qualquer (pode ser uma expressão), e @code{nomemetodo} é o nome de um método que foi definido pelo tipo do objeto. Tipos diferentes definem métodos diferentes. Métodos de diferentes tipos podem ter o mesmo nome sem ambiguidade. (É possível definir seus próprios tipos de objetos e métodos, utilizando `classes', veja em @ref{1d9f,,Classes}) O método @ref{6cd,,append()}, mostrado no exemplo é definido para objetos do tipo lista; adiciona um novo elemento ao final da lista. Neste exemplo, ele equivale a @code{result = result + [a]}, só que mais eficiente.
@end itemize

@node Mais sobre definição de funções,Intermezzo estilo de codificação,Definindo funções,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow more-on-defining-functions}@anchor{1da0}@anchor{tutorial/controlflow tut-defining}@anchor{1da1}
@subsection Mais sobre definição de funções


É possível definir funções com um número variável de argumentos. Existem três formas, que podem ser combinadas.

@menu
* Argumentos com valor padrão:: 
* Argumentos nomeados:: 
* Parâmetros especiais:: 
* Listas de argumentos arbitrárias:: 
* Desempacotando listas de argumentos:: 
* Expressões lambda:: 
* Strings de documentação:: 
* Anotações de função:: 

@end menu

@node Argumentos com valor padrão,Argumentos nomeados,,Mais sobre definição de funções
@anchor{tutorial/controlflow default-argument-values}@anchor{1da2}@anchor{tutorial/controlflow tut-defaultargs}@anchor{1da3}
@subsubsection Argumentos com valor padrão


A mais útil das três é especificar um valor padrão para um ou mais argumentos. Isso cria uma função que pode ser invocada com menos argumentos do que os que foram definidos. Por exemplo:

@example
def pergunta_ok(mensagem, tentativas=4, lembrete='Por favor, tente novamente!'):
    while True:
        resposta = input(mensagem)
        if resposta in @{'s', 'sim', 'é@}:
            return True
        if resposta in @{'n', 'não', 'nah'@}:
            return False
        tentativas = tentativas - 1
        if tentativas < 0:
            raise ValueError('resposta inválida de usuário')
        print(lembrete)
@end example

Essa função pode ser chamada de várias formas:


@itemize *

@item 
fornecendo apenas o argumento obrigatório: @code{ask_ok('Do you really want to quit?')}

@item 
fornecendo um dos argumentos opcionais: @code{ask_ok('OK to overwrite the file?', 2)}

@item 
ou fornecendo todos os argumentos: @code{ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')}
@end itemize

Este exemplo também introduz a palavra-chave @ref{2f4,,in}, que verifica se uma sequência contém ou não um determinado valor.

Os valores padrões são avaliados no momento da definição da função, e no escopo em que a função foi `definida', portanto:

@example
i = 5

def f(arg=i):
    print(arg)

i = 6
f()
@end example

irá exibir @code{5}.

`Aviso importante:' Valores padrões são avaliados apenas uma vez. Isso faz diferença quando o valor é um objeto mutável, como uma lista, dicionário, ou instâncias de classes. Por exemplo, a função a seguir acumula os argumentos passados, nas chamadas subsequentes:

@example
def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))
@end example

Isso exibirá:

@example
[1]
[1, 2]
[1, 2, 3]
@end example

Se não quiser que o valor padrão seja compartilhado entre chamadas subsequentes, pode reescrever a função assim:

@example
def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L
@end example

@node Argumentos nomeados,Parâmetros especiais,Argumentos com valor padrão,Mais sobre definição de funções
@anchor{tutorial/controlflow keyword-arguments}@anchor{1da4}@anchor{tutorial/controlflow tut-keywordargs}@anchor{1da5}
@subsubsection Argumentos nomeados


Funções também podem ser chamadas usando @ref{d34,,argumentos nomeados} da forma @code{chave=valor}. Por exemplo, a função a seguir:

@example
def papagaio(voltagem, estado='é um cadáver', ação='voar', tipo='Azul Norueguês'):
    print("-- Este papagaio não conseguiria", ação, end=' ')
    print("nem se você desse um choque de", voltagem, "de volts nele.")
    print("-- Plumagem formosa, o", tipo)
    print("-- Ele", estado, "!")
@end example

aceita um argumento obrigatório (@code{voltagem}) e três argumentos opcionais (@code{estado}, @code{ação}, e @code{tipo}). Esta função pode ser chamada de qualquer uma dessas formas:

@example
papagaio(1000)                                        # 1 argumento posicional
papagaio(voltagem=1000)                               # 1 argumento nomeado
papagaio(voltagem=1000000, ação='fazer VOOOOOM')      # 2 argumentos nomeados
papagaio(ação='fazer VOOOOOM', voltagem=1000000)      # 2 argumentos nomeados
papagaio('um milhão', 'sem vida', 'pular')            # 3 argumentos posicionais
papagaio('mil', estado='estaria no céu')              # 1 posicional, 1 argumento
@end example

mas todas as formas a seguir seriam inválidas:

@example
papagaio()                       # faltando argumento obrigatório
papagaio(voltagem=5.0, 'morto')  # argumento não nomeado após um argumento nomeado
papagaio(110, voltagem=220)      # valor duplicado para o mesmo argumento
papagaio(ator='John Cleese')     # argumento nomeado desconhecido
@end example

Em uma chamada de função, argumentos nomeados devem vir depois dos argumentos posicionais. Todos os argumentos nomeados passados devem corresponder com argumentos aceitos pela função (ex. @code{ator} não é um argumento nomeado válido para a função @code{papagaio}), mas sua ordem é irrelevante. Isto também inclui argumentos obrigatórios (ex.: @code{papagaio(voltagem=1000)} funciona). Nenhum argumento pode receber mais de um valor. Eis um exemplo que não funciona devido a esta restrição:

@example
>>> def função(a):
...     pass
...
>>> função(0, a=0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: função() got multiple values for argument 'a'
@end example

Quando um último parâmetro formal no formato @code{**nome} está presente, ele recebe um dicionário (veja @ref{ad6,,Tipo mapeamento — dict}) contendo todos os argumentos nomeados, exceto aqueles que correspondem a um parâmetro formal. Isto pode ser combinado com um parâmetro formal no formato @code{*nome} (descrito na próxima subseção) que recebe uma @ref{1da6,,tupla} contendo os argumentos posicionais, além da lista de parâmetros formais. (@code{*nome} deve ocorrer antes de @code{**nome}.) Por exemplo, se definirmos uma função assim:

@example
def loja_de_queijos(tipo, *argumentos, **argumentos_nomeados):
    print("-- Você tem algum", tipo, "?")
    print("-- Lamento, acabou o", tipo)
    for arg in argumentos:
        print(arg)
    print("-" * 40)
    for kw in argumentos_nomeados:
        print(kw, ":", argumentos_nomeados[kw])
@end example

Pode ser chamada assim:

@example
loja_de_queijos("Limburger", "Está muito mole, senhor",
           "Está realmente muito, MUITO mole, senhor.",
           vendedor="Michael Palin",
           cliente="John Cleese",
           sketch="Sketch da Loja de Queijos")
@end example

e, claro, exibiria:

@example
-- Você tem algum Limburger ?
-- Lamento, acabou o Limburger
Está muito mole, senhor.
Está realmente muito, MUITO mole, senhor.
----------------------------------------
vendedor : Michael Palin
cliente : John Cleese
sketch : Cheese Shop Sketch
@end example

Observe que a ordem em que os argumentos nomeados são exibidos é garantida para corresponder à ordem em que foram fornecidos na chamada da função.

@node Parâmetros especiais,Listas de argumentos arbitrárias,Argumentos nomeados,Mais sobre definição de funções
@anchor{tutorial/controlflow special-parameters}@anchor{1da7}
@subsubsection Parâmetros especiais


Por padrão, argumentos podem ser passadas para uma função Python tanto por posição quanto explicitamente pelo nome. Para uma melhor legibilidade e desempenho, faz sentido restringir a maneira pelo qual argumentos possam ser passados, assim um desenvolvedor precisa apenas olhar para a definição da função para determinar se os itens são passados por posição, por posição e nome, ou por nome.

A definição de uma função pode parecer com:

@example
def f(pos1, pos2, /, pos_ou_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        Posicional ou nomeado   |
        |                                - Somente nomeado
         -- Somente posicional
@end example

onde @code{/} e @code{*} são opcionais. Se usados, esses símbolos indicam o tipo de parâmetro pelo qual os argumentos podem ser passados para as funções: somente-posicional, posicional-ou-nomeado, e somente-nomeado. Parâmetros nomeados são também conhecidos como parâmetros palavra-chave.

@menu
* Argumentos posicional-ou-nomeados:: 
* Parâmetros somente-posicionais: Parâmetros somente-posicionais<2>. 
* Argumentos somente-nomeados:: 
* Exemplos de funções:: 
* Recapitulando:: 

@end menu

@node Argumentos posicional-ou-nomeados,Parâmetros somente-posicionais<2>,,Parâmetros especiais
@anchor{tutorial/controlflow positional-or-keyword-arguments}@anchor{1da8}
@subsubsection Argumentos posicional-ou-nomeados


Se @code{/} e @code{*} não estão presentes na definição da função, argumentos podem ser passados para uma função por posição ou por nome.

@node Parâmetros somente-posicionais<2>,Argumentos somente-nomeados,Argumentos posicional-ou-nomeados,Parâmetros especiais
@anchor{tutorial/controlflow positional-only-parameters}@anchor{1da9}
@subsubsection Parâmetros somente-posicionais


Olhando com um pouco mais de detalhes, é possível definir certos parâmetros como `somente-posicional'. Se `somente-posicional', a ordem do parâmetro importa, e os parâmetros não podem ser passados por nome. Parâmetros somente-posicional são colocados antes de @code{/} (barra). A @code{/} é usada para logicamente separar os argumentos somente-posicional dos demais parâmetros. Se não existe uma @code{/} na definição da função, não existe parâmetros somente-posicionais.

Parâmetros após a @code{/} podem ser `posicional-ou-nomeado' ou `somente-nomeado'.

@node Argumentos somente-nomeados,Exemplos de funções,Parâmetros somente-posicionais<2>,Parâmetros especiais
@anchor{tutorial/controlflow keyword-only-arguments}@anchor{1daa}
@subsubsection Argumentos somente-nomeados


Para definir parâmetros como `somente-nomeado', indicando que o parâmetro deve ser passado por argumento nomeado, colocamos um @code{*} na lista de argumentos imediatamente antes do primeiro parâmetro `somente-nomeado'.

@node Exemplos de funções,Recapitulando,Argumentos somente-nomeados,Parâmetros especiais
@anchor{tutorial/controlflow function-examples}@anchor{1dab}
@subsubsection Exemplos de funções


Considere o seguinte exemplo de definição de função com atenção redobrada para os marcadores @code{/} e @code{*}:

@example
>>> def arg_padrão(arg):
...     print(arg)
...
>>> def arg_somente_pos(arg, /):
...     print(arg)
...
>>> def arg_somente_nom(*, arg):
...     print(arg)
...
>>> def exemplo_combinado(somente_pos, /, padrão, *, somente_nom):
...     print(somente_pos, padrão, somente_nom)
@end example

A definição da primeira função, @code{arg_padrão}, a forma mais familiar, não coloca nenhuma restrição para a chamada da função e argumentos podem ser passados por posição ou nome:

@example
>>> arg_padrão(2)
2

>>> arg_padrão(arg=2)
2
@end example

A segunda função @code{arg_somente_pos} está restrita ao uso de parâmetros somente posicionais, uma vez que existe uma @code{/} na definição da função:

@example
>>> arg_somente_pos(1)
1

>>> arg_somente_pos(arg=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: arg_somente_pos() got some positional-only arguments passed as keyword arguments: 'arg'
@end example

A terceira função @code{arg_somente_nom} permite somente argumentos nomeados como indicado pelo @code{*} na definição da função:

@example
>>> arg_somente_nom(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: arg_somente_nom() takes 0 positional arguments but 1 was given

>>> arg_somente_nom(arg=3)
3
@end example

E a última usa as três convenções de chamada na mesma definição de função:

@example
>>> exemplo_combinado(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: exemplo_combinado() takes 2 positional arguments but 3 were given

>>> exemplo_combinado(1, 2, somente_nom=3)
1 2 3

>>> exemplo_combinado(1, padrão=2, somente_nom=3)
1 2 3

>>> exemplo_combinado(somente_pos=1, padrão=2, somente_nom=3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: exemplo_combinado() got some positional-only arguments passed as keyword arguments: 'somente_pos'
@end example

Finalmente, considere essa definição de função que possui uma potencial colisão entre o argumento posicional @code{nome} e @code{**kwds} que possui @code{nome} como uma chave:

@example
def foo(nome, **kwds):
    return 'nome' in kwds
@end example

Não é possível essa chamada devolver @code{True}, uma vez que o argumento nomeado @code{'nome'} sempre será aplicado para o primeiro parâmetro. Por exemplo:

@example
>>> foo(1, **@{'nome': 2@})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got multiple values for argument 'nome'
>>>
@end example

Mas usando @code{/} (argumentos somente-posicionais), isso é possível já que permite @code{nome} como um argumento posicional e @code{'nome'} como uma chave nos argumentos nomeados:

@example
>>> def foo(nome, /, **kwds):
...     return 'nome' in kwds
...
>>> foo(1, **@{'nome': 2@})
True
@end example

Em outras palavras, o nome de parâmetros somente-posicional podem ser usados em @code{**kwds} sem ambiguidade.

@node Recapitulando,,Exemplos de funções,Parâmetros especiais
@anchor{tutorial/controlflow recap}@anchor{1dac}
@subsubsection Recapitulando


A situação irá determinar quais parâmetros usar na definição da função:

@example
def f(pos1, pos2, /, pos_ou_nom *, nom1, nom2):
@end example

Como guia:


@itemize *

@item 
Use somente-posicional se você não quer que o nome do parâmetro esteja disponível para o usuário. Isso é útil quando nomes de parâmetros não tem um significado real, se você quer forçar a ordem dos argumentos da função quando ela é chamada ou se você precisa ter alguns parâmetros posicionais e alguns nomeados.

@item 
Use somente-nomeado quando os nomes tem significado e a definição da função fica mais clara deixando esses nomes explícitos ou se você quer evitar que usuários confiem na posição dos argumentos que estão sendo passados.

@item 
Para uma API, use somente-posicional para evitar quebras na mudança da API se os nomes dos parâmetros forem alterados no futuro.
@end itemize

@node Listas de argumentos arbitrárias,Desempacotando listas de argumentos,Parâmetros especiais,Mais sobre definição de funções
@anchor{tutorial/controlflow arbitrary-argument-lists}@anchor{1dad}@anchor{tutorial/controlflow tut-arbitraryargs}@anchor{1dae}
@subsubsection Listas de argumentos arbitrárias


@geindex * (asterisco);em chamadas de função

Finalmente, a opção menos usada é especificar que a função pode ser chamada com um número arbitrário de argumentos. Esses argumentos serão empacotados em uma tupla (ver @ref{1da6,,Tuplas e Sequências}). Antes dos argumentos em número variável, zero ou mais argumentos normais podem estar presentes.

@example
def escreve_vários_itens(arquivo, separador, *args):
    file.write(separador.join(args))
@end example

Normalmente, esses argumentos `variádicos' estarão no final da lista de parâmetros formais, porque eles englobam todos os argumentos de entrada restantes, que são passados para a função. Quaisquer parâmetros formais que ocorrem após o parâmetro @code{*args} são argumentos ‘somente-nomeados’ , o que significa que eles só podem ser usados como chave-valor, em vez de argumentos posicionais:

@example
>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("terra", "marte", "vênus")
'terra/marte/vênus'
>>> concat("terra", "marte", "vênus", sep=".")
'terra.marte.vênus'
@end example

@node Desempacotando listas de argumentos,Expressões lambda,Listas de argumentos arbitrárias,Mais sobre definição de funções
@anchor{tutorial/controlflow tut-unpacking-arguments}@anchor{1daf}@anchor{tutorial/controlflow unpacking-argument-lists}@anchor{1db0}
@subsubsection Desempacotando listas de argumentos


A situação inversa ocorre quando os argumentos já estão numa lista ou tupla mas ela precisa ser explodida para invocarmos uma função que requer argumentos posicionais separados. Por exemplo, a função @ref{94a,,range()} espera argumentos separados, `start' e `stop'. Se os valores já estiverem juntos em uma lista ou tupla, escreva a chamada de função com o operador @code{*} para desempacotá-los da sequência:

@example
>>> list(range(3, 6))            # chamada normal com argumentos separados
[3, 4, 5]
>>> args = [3, 6]
>>> list(range(*args))           # chamada com argumentos desempacotados a partir de uma lista
[3, 4, 5]
@end example

@geindex **;em chamadas de função

Da mesma forma, dicionários podem produzir argumentos nomeados com o operador @code{**}:

@example
>>> def papagaio(voltagem, estado='um cadáver', ação='voar'):
...     print("-- Este papagaio não conseguiria", ação, end=' ')
...     print("nem se você desse um choque de", voltagem, "de volts nele.", end=' ')
...     print("Ele", estado, "!")
...
>>> d = @{"voltagem": "quatro milhões", "estado": "está realmente morto", "ação": "voar"@}
>>> papagaio(**d)
-- Este papagaio não conseguiria voar nem se você desse um choque de quatro milhões de volts nele. Ele está realmente morto !
@end example

@node Expressões lambda,Strings de documentação,Desempacotando listas de argumentos,Mais sobre definição de funções
@anchor{tutorial/controlflow lambda-expressions}@anchor{1db1}@anchor{tutorial/controlflow tut-lambda}@anchor{1db2}
@subsubsection Expressões lambda


Pequenas funções anônimas podem ser criadas com a palavra-chave @ref{12df,,lambda}. Esta função retorna a soma de seus dois argumentos: @code{lambda a, b: a+b}. As funções lambda podem ser usadas sempre que objetos função forem necessários. Eles são sintaticamente restritos a uma única expressão. Semanticamente, eles são apenas açúcar sintático para uma definição de função normal. Como definições de funções aninhadas, as funções lambda podem referenciar variáveis contidas no escopo:

@example
>>> def cria_incrementador(n):
...     return lambda x: x + n
...
>>> f = cria_incrementador(42)
>>> f(0)
42
>>> f(1)
43
@end example

O exemplo acima usa uma expressão lambda para retornar uma função. Outro uso é passar uma pequena função como um argumento. Por exemplo, @ref{be8,,list.sort()} recebe uma função chave de ordenação `key' que pode ser uma função lambda:

@example
>>> pairs = [(1, 'um'), (2, 'dois'), (3, 'três), (4, 'quatro')]
>>> pairs.sort(key=lambda pair: pair[1])
>>> pairs
[(4, 'quatro'), (1, 'um'), (3, 'três'), (2, 'dois')]
@end example

@node Strings de documentação,Anotações de função,Expressões lambda,Mais sobre definição de funções
@anchor{tutorial/controlflow documentation-strings}@anchor{1db3}@anchor{tutorial/controlflow tut-docstrings}@anchor{1d9e}
@subsubsection Strings de documentação


@geindex docstrings
@geindex strings@comma{} documentação
@geindex strings@comma{} documentação

Aqui estão algumas convenções sobre o conteúdo e formatação de strings de documentação, também conhecidas como docstrings.

A primeira linha deve sempre ser curta, um resumo conciso do propósito do objeto. Por brevidade, não deve explicitamente se referir ao nome ou tipo do objeto, uma vez que estas informações estão disponíveis por outros meios (exceto se o nome da função for o próprio verbo que descreve a finalidade da função). Essa linha deve começar com letra maiúscula e terminar com ponto.

Se existem mais linhas na string de documentação, a segunda linha deve estar em branco, separando visualmente o resumo do resto da descrição. As linhas seguintes devem conter um ou mais parágrafos descrevendo as convenções de chamada ao objeto, seus efeitos colaterais, etc.

The Python parser strips indentation from multi-line string literals when they
serve as module, class, or function docstrings.

Eis um exemplo de uma string de documentação multilinha:

@example
>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything:
...
...         >>> my_function()
...         >>>
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

No, really, it doesn't do anything:

    >>> my_function()
    >>>
@end example

@node Anotações de função,,Strings de documentação,Mais sobre definição de funções
@anchor{tutorial/controlflow function-annotations}@anchor{1db4}@anchor{tutorial/controlflow tut-annotations}@anchor{1db5}
@subsubsection Anotações de função


@geindex função;annotations
@geindex ->;anotações de função
@geindex ; (dois pontos);anotações de função

@ref{1db6,,Anotações de função} são informações de metadados completamente opcionais sobre os tipos usados pelas funções definidas pelo usuário (veja 
@geindex Propostas de Melhorias do Python; PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} e 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para mais informações).

@ref{1db7,,Anotações} são armazenadas no atributo @code{__annotations__} da função como um dicionário e não tem nenhum efeito em qualquer outra parte da função. Anotações de parâmetro são definidas por dois-pontos (“:”) após o nome do parâmetro, seguida por uma expressão que quando avaliada determina o valor da anotação. Anotações do tipo do retorno são definidas por um literal @code{->}, seguida por uma expressão, entre a lista de parâmetro e os dois-pontos que marcam o fim da instrução @ref{14a2,,def} . O exemplo a seguir possui um argumento obrigatório, um argumento opcional e o valor de retorno anotados:

@example
>>> def f(ham: str, ovos: str = 'ovos') -> str:
...     print("Anotações:", f.__annotations__)
...     print("Argumentos:", ham, ovos)
...     return ham + ' e ' + ovos
...
>>> f('spam')
Anotações: @{'ham': <class 'str'>, 'return': <class 'str'>, 'ovos': <class 'str'>@}
Argumentos: spam ovos
'spam e ovos'
@end example

@node Intermezzo estilo de codificação,,Mais sobre definição de funções,Mais ferramentas de controle de fluxo
@anchor{tutorial/controlflow intermezzo-coding-style}@anchor{1db8}@anchor{tutorial/controlflow tut-codingstyle}@anchor{1db9}
@subsection Intermezzo: estilo de codificação


@geindex codificação;estilo

Agora que está prestes a escrever códigos mais longos e complexos em Python, é um bom momento para falar sobre `estilo de codificação'. A maioria das linguagens podem ser escritas (ou `formatadas') em diferentes estilos; alguns são mais legíveis do que outros. Tornar o seu código mais fácil de ler, para os outros, é sempre uma boa ideia, e adotar um estilo de codificação agradável ajuda bastante.

Em Python, a 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} tornou-se o guia de estilo adotado pela maioria dos projetos; promove um estilo de codificação muito legível e visualmente agradável. Todo desenvolvedor Python deve lê-lo em algum momento; eis os pontos mais importantes, selecionados para você:


@itemize *

@item 
Use indentação com 4 espaços, e não use tabulações.

4 espaços são um bom meio termo entre indentação estreita (permite maior profundidade de aninhamento) e indentação larga (mais fácil de ler). Tabulações trazem complicações, e o melhor é não usar.

@item 
Quebre as linhas de modo que não excedam 79 caracteres.

Isso ajuda os usuários com telas pequenas e torna possível abrir vários arquivos de código lado a lado em telas maiores.

@item 
Deixe linhas em branco para separar funções e classes, e blocos de código dentro de funções.

@item 
Quando possível, coloque comentários em uma linha própria.

@item 
Escreva strings de documentação.

@item 
Use espaços ao redor de operadores e após vírgulas, mas não diretamente dentro de parênteses, colchetes e chaves: @code{a = f(1, 2) + g(3, 4)}.

@item 
Nomeie suas classes e funções de forma consistente; a convenção é usar @code{MaiusculoCamelCase} para classes e @code{minusculo_com_sublinhado} para funções e métodos. Sempre use @code{self} como o nome para o primeiro argumento dos métodos (veja @ref{1dba,,Uma primeira olhada nas classes} para mais informações sobre classes e métodos).

@item 
Não use codificações exóticas se o seu código é feito para ser usado em um contexto internacional. O padrão do Python, UTF-8, ou mesmo ASCII puro funciona bem em qualquer caso.

@item 
Da mesma forma, não use caracteres não-ASCII em identificadores se houver apenas a menor chance de pessoas falando um idioma diferente ler ou manter o código.
@end itemize

@node Estruturas de dados,Módulos<2>,Mais ferramentas de controle de fluxo,O tutorial do Python
@anchor{tutorial/datastructures doc}@anchor{1dbb}@anchor{tutorial/datastructures data-structures}@anchor{1dbc}@anchor{tutorial/datastructures translation-repo}@anchor{1dbd}@anchor{tutorial/datastructures tut-structures}@anchor{1d90}
@section Estruturas de dados


Esse capítulo descreve algumas coisas que você já aprendeu em detalhes e adiciona algumas coisas novas também.

@menu
* Mais sobre listas:: 
* A instrução del:: 
* Tuplas e Sequências:: 
* Conjuntos:: 
* Dicionários:: 
* Técnicas de iteração:: 
* Mais sobre condições:: 
* Comparando sequências e outros tipos:: 

@end menu

@node Mais sobre listas,A instrução del,,Estruturas de dados
@anchor{tutorial/datastructures more-on-lists}@anchor{1dbe}@anchor{tutorial/datastructures tut-morelists}@anchor{1dbf}
@subsection Mais sobre listas


O tipo de dado @ref{1dc0,,lista} tem ainda mais métodos. Aqui estão apresentados todos os métodos de objetos do tipo lista:


@deffn {Método} list.append (x)

Adiciona um item ao fim da lista. Similar a @code{a[len(a):] = [x]}.
@end deffn


@deffn {Método} list.extend (iterable)

Estende a lista, adicionando no fim todos os elementos do argumento iterável passado como parâmetro. Similar a @code{a[len(a):] = iterable}.
@end deffn


@deffn {Método} list.insert (i, x)

Insere um item em uma dada posição. O primeiro argumento é o índice do elemento antes do qual será feita a inserção, assim @code{a.insert(0, x)} insere um elemento na frente da lista e @code{a.insert(len(a), x)} e equivale a @code{a.append(x)}.
@end deffn


@deffn {Método} list.remove (x)

Remove o primeiro item encontrado na lista cujo valor é igual a `x'. Se não existir valor igual, uma exceção @ref{202,,ValueError} é levantada.
@end deffn


@deffn {Método} list.pop ([i])

Remove o item na posição fornecida na lista e retorna. Se nenhum índice for especificado, @code{a.pop()} remove e retorna o último item da lista. Levanta um @ref{157e,,IndexError} se a lista estiver vazia ou o índice estiver fora do intervalo da lista.
@end deffn


@deffn {Método} list.clear ()

Remove todos os itens de uma lista. Similar a @code{del a[:]}.
@end deffn


@deffn {Método} list.index (x[, start[, end]])

Retorna o índice de base zero da primeira ocorrência de `x' na lista. Levanta @ref{202,,ValueError} se não houver tal item.

Os argumentos opcionais `start' e `end' são interpretados como nas notações de fatiamento e são usados para limitar a busca para uma subsequência específica da lista. O índice retornado é calculado relativo ao começo da sequência inteira e não referente ao argumento `start'.
@end deffn


@deffn {Método} list.count (x)

Devolve o número de vezes em que `x' aparece na lista.
@end deffn


@deffn {Método} list.sort (*, key=None, reverse=False)

Ordena os itens na lista (os argumentos podem ser usados para personalizar a ordenação, veja a função @ref{be7,,sorted()} para maiores explicações).
@end deffn


@deffn {Método} list.reverse ()

Inverte a ordem dos elementos na lista.
@end deffn


@deffn {Método} list.copy ()

Devolve uma cópia rasa da lista. Similar a @code{a[:]}.
@end deffn

Um exemplo que usa a maior parte dos métodos das listas:

@example
>>> frutas = ['laranja', 'maçã', 'pera', 'banana', 'kiwi', 'maçã', 'banana']
>>> frutas.count('maçã')
2
>>> frutas.count('tangerina')
0
>>> frutas.index('banana')
3
>>> frutas.index('banana', 4) # Encontra a próxima banana iniciando da posição 4
6
>>> frutas.reverse()
>>> frutas
['banana', 'maçã', 'kiwi', 'banana', 'pera', 'maçã', 'laranja']
>>> frutas.append('uva')
>>> frutas
['banana', 'maçã', 'kiwi', 'banana', 'pera', 'maçã', 'laranja', 'uva']
>>> frutas.sort()
>>> frutas
['maçã', 'maçã', 'banana', 'banana', 'uva', 'kiwi', 'laranja', 'pera']
>>> frutas.pop()
'pera'
@end example

Você pode ter percebido que métodos como @code{insert}, @code{remove} ou @code{sort}, que apenas modificam a lista, não têm valor de retorno impresso – eles retornam o @code{None} padrão. @footnote{
Outras linguagens podem retornar o objeto modificado, o que permite encadeamento de métodos, como @code{d->insert("a")->remove("b")->sort();}.
} Isto é um princípio de design para todas as estruturas de dados mutáveis em Python.

Outro aspecto que você pode notar é que nem todos os dados podem ser classificados ou comparados.  Por exemplo, @code{[None, 'hello', 10]} não é ordenável porque os inteiros não podem ser comparados a strings e @code{None} não pode ser comparado a outros tipos.  Além disso, há alguns tipos que não têm uma relação de ordenação definida.  Por exemplo, @code{3+4j < 5+7j} não é uma comparação válida.

@menu
* Usando listas como pilhas:: 
* Usando listas como filas:: 
* Compreensões de lista: Compreensões de lista<2>. 
* Compreensões de lista aninhadas:: 

@end menu

@node Usando listas como pilhas,Usando listas como filas,,Mais sobre listas
@anchor{tutorial/datastructures tut-lists-as-stacks}@anchor{1dc1}@anchor{tutorial/datastructures using-lists-as-stacks}@anchor{1dc2}
@subsubsection Usando listas como pilhas


Os métodos de lista tornam muito fácil utilizar listas como pilhas, onde o item adicionado por último é o primeiro a ser recuperado (política “último a entrar, primeiro a sair”). Para adicionar um item ao topo da pilha, use @ref{6cd,,append()}. Para recuperar um item do topo da pilha use @ref{1dc3,,pop()} sem nenhum índice. Por exemplo:

@example
>>> pilha = [3, 4, 5]
>>> pilha.append(6)
>>> pilha.append(7)
>>> pilha
[3, 4, 5, 6, 7]
>>> pilha.pop()
7
>>> pilha
[3, 4, 5, 6]
>>> pilha.pop()
6
>>> pilha.pop()
5
>>> pilha
[3, 4]
@end example

@node Usando listas como filas,Compreensões de lista<2>,Usando listas como pilhas,Mais sobre listas
@anchor{tutorial/datastructures tut-lists-as-queues}@anchor{1dc4}@anchor{tutorial/datastructures using-lists-as-queues}@anchor{1dc5}
@subsubsection Usando listas como filas


Você também pode usar uma lista como uma fila, onde o primeiro item adicionado é o primeiro a ser recuperado (política “primeiro a entrar, primeiro a sair”); porém, listas não são eficientes para esta finalidade. Embora `appends' e `pops' no final da lista sejam rápidos, fazer `inserts' ou `pops' no início da lista é lento (porque todos os demais elementos têm que ser deslocados).

Para implementar uma fila, use a classe @ref{5dc,,collections.deque} que foi projetada para permitir `appends' e `pops' eficientes nas duas extremidades. Por exemplo:

@example
>>> from collections import deque
>>> fila = deque(["Erik", "João", "Miguel"])
>>> fila.append("Tiago")            # Tiago chega
>>> fila.append("George")           # George chega
>>> fila.popleft()                  # O primeiro a chegar agora sai
'Erik'
>>> fila.popleft()                  # O segundo a chegar agora sai
'João'
>>> fila                            # A fila restante na ordem de chegada
deque(['Miguel', 'Tiago', 'George'])
@end example

@node Compreensões de lista<2>,Compreensões de lista aninhadas,Usando listas como filas,Mais sobre listas
@anchor{tutorial/datastructures list-comprehensions}@anchor{1dc6}@anchor{tutorial/datastructures tut-listcomps}@anchor{1dc7}
@subsubsection Compreensões de lista


Compreensões de lista fornece uma maneira concisa de criar uma lista. Aplicações comuns são criar novas listas onde cada elemento é o resultado de alguma operação aplicada a cada elemento de outra sequência ou iterável, ou criar uma subsequência de elementos que satisfaçam uma certa condição. (N.d.T. o termo original em inglês é `list comprehensions', muito utilizado no Brasil; também se usa a abreviação `listcomp').

Por exemplo, suponha que queremos criar uma lista de quadrados, assim:

@example
>>> quadrados = []
>>> for x in range(10):
...     quadrados.append(x**2)
...
>>> quadrados
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@end example

Note que isto cria (ou sobrescreve) uma variável chamada @code{x} que ainda existe após o término do laço. Podemos calcular a lista dos quadrados sem qualquer efeito colateral usando:

@example
quadrados = list(map(lambda x: x**2, range(10)))
@end example

ou, de maneira equivalente:

@example
quadrados = [x**2 for x in range(10)]
@end example

que é mais conciso e legível.

Um compreensão de lista consiste de um par de colchetes contendo uma expressão seguida de uma cláusula @code{for}, e então zero ou mais cláusulas @code{for} ou @code{if}. O resultado será uma nova lista resultante da avaliação da expressão no contexto das cláusulas @code{for} e @code{if}. Por exemplo, essa compreensão combina os elementos de duas listas se eles forem diferentes:

@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

e é equivalente a:

@example
>>> combos = []
>>> for x in [1,2,3]:
...     for y in [3,1,4]:
...         if x != y:
...             combos.append((x, y))
...
>>> combos
[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
@end example

Note como a ordem das instruções @ref{2f2,,for} e @ref{2f3,,if} é a mesma em ambos os trechos.

Se a expressão é uma tupla (ex., @code{(x, y)} no exemplo anterior), ela deve ser inserida entre parênteses.

@example
>>> vec = [-4, -2, 0, 2, 4]
>>> # cria uma nova lista com os valores dobrados
>>> [x*2 for x in vec]
[-8, -4, 0, 4, 8]
>>> # filtra a lista para excluir números negativos
>>> [x for x in vec if x >= 0]
[0, 2, 4]
>>> # aplica uma função para todos os elementos
>>> [abs(x) for x in vec]
[4, 2, 0, 2, 4]
>>> # chama um método em cada elemento
>>> frutafresca = ['  banana', '  baga-de-logan ', 'maracujá  ']
>>> [arma.strip() for arma in frutafresca]
['banana', 'baga-de-logan', 'maracujá']
>>> # cria uma lista de tuplas de 2 elementos como (número, quadrado)
>>> [(x, x**2) for x in range(6)]
[(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
>>> # a tupla deve estar entre parênteses, do contrário um erro é levantado
>>> [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?
>>> # achatamento de uma lista usando uma compreensão de lista com dois '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

Compreensões de lista podem conter expressões complexas e funções aninhadas:

@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 Compreensões de lista aninhadas,,Compreensões de lista<2>,Mais sobre listas
@anchor{tutorial/datastructures nested-list-comprehensions}@anchor{1dc8}
@subsubsection Compreensões de lista aninhadas


A expressão inicial em uma compreensão de lista pode ser qualquer expressão arbitrária, incluindo outra compreensão de lista.

Observe este exemplo de uma matriz 3x4 implementada como uma lista de 3 listas de comprimento 4:

@example
>>> matriz = [
...     [1, 2, 3, 4],
...     [5, 6, 7, 8],
...     [9, 10, 11, 12],
... ]
@end example

A compreensão de lista abaixo transpõe as linhas e colunas:

@example
>>> [[linha[i] for linha in matriz] for i in range(4)]
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

Como vimos na seção anterior, a compreensão de lista interna é computada no contexto da cláusula @ref{2f2,,for} seguinte, portanto o exemplo acima equivale a:

@example
>>> transposta = []
>>> for i in range(4):
...     transposta.append([row[i] for linha in matriz])
...
>>> transposta
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

e isso, por sua vez, faz o mesmo que isto:

@example
>>> transposta = []
>>> for i in range(4):
...     # as 3 linhas a seguir implementam uma compreensão de lista aninhada
...     linha_transposta = []
...     for linha in matriz:
...         linha_transposta.append(linha[i])
...     transposta.append(linha_transposta)
...
>>> transposta
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

Na prática, você deve dar preferência a funções embutidas em vez de instruções complexas. A função @ref{7d1,,zip()} resolve muito bem este caso de uso:

@example
>>> list(zip(*matriz))
[(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]
@end example

Veja @ref{1daf,,Desempacotando listas de argumentos} para entender o uso do asterisco neste exemplo.

@node A instrução del,Tuplas e Sequências,Mais sobre listas,Estruturas de dados
@anchor{tutorial/datastructures the-del-statement}@anchor{1dc9}@anchor{tutorial/datastructures tut-del}@anchor{1dca}
@subsection A instrução @code{del}


Existe uma maneira de remover um item de uma lista usando seu índice no lugar do seu valor: a instrução @ref{18a7,,del}. Ela difere do método @ref{1dc3,,pop()} que devolve um valor. A instrução @code{del} pode também ser utilizada para remover fatias de uma lista ou limpar a lista inteira (que fizemos antes atribuindo uma lista vazia à fatia @code{a[:]}). Por exemplo:

@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{18a7,,del} também pode ser usado para remover totalmente uma variável:

@example
>>> del a
@end example

Referenciar a variável @code{a} depois de sua remoção constitui erro (pelo menos até que seja feita uma nova atribuição para ela). Encontraremos outros usos para a instrução @ref{18a7,,del} mais tarde.

@node Tuplas e Sequências,Conjuntos,A instrução del,Estruturas de dados
@anchor{tutorial/datastructures tuples-and-sequences}@anchor{1dcb}@anchor{tutorial/datastructures tut-tuples}@anchor{1da6}
@subsection Tuplas e Sequências


Vimos que listas e strings têm muitas propriedades em comum, como indexação e operações de fatiamento. Elas são dois exemplos de `sequências' (veja @ref{1dcc,,Tipos sequências — list@comma{} tuple@comma{} range}). Como Python é uma linguagem em evolução, outros tipos de sequências podem ser adicionados. Existe ainda um outro tipo de sequência padrão na linguagem: a `tupla'.

Uma tupla consiste em uma sequência de valores separados por vírgulas, por exemplo:

@example
>>> t = 12345, 54321, 'olá!'
>>> t[0]
12345
>>> t
(12345, 54321, 'olá!')
>>> # Tuplas pode ser aninhadas:
>>> u = t, (1, 2, 3, 4, 5)
>>> u
((12345, 54321, 'olá!'), (1, 2, 3, 4, 5))
>>> # Tuplas são imutáveis:
>>> t[0] = 88888
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'tuple' object does not support item assignment
>>> # mas elas podem conter objetos mutáveis:
>>> v = ([1, 2, 3], [3, 2, 1])
>>> v
([1, 2, 3], [3, 2, 1])
@end example

Como você pode ver no trecho acima, na saída do console as tuplas são sempre envolvidas por parênteses, assim tuplas aninhadas podem ser lidas corretamente. Na criação, tuplas podem ser envolvidas ou não por parênteses, desde que o contexto não exija os parênteses (como no caso da tupla dentro de uma expressão maior). Não é possível atribuir itens individuais de uma tupla, contudo é possível criar tuplas que contenham objetos mutáveis, como listas.

Apesar de tuplas serem similares a listas, elas são frequentemente utilizadas em situações diferentes e com propósitos distintos. Tuplas são @ref{1d79,,imutáveis}, e usualmente contém uma sequência heterogênea de elementos que são acessados via desempacotamento (ver a seguir nessa seção) ou índice (ou mesmo por um atributo no caso de @ref{1ca,,namedtuples}). Listas são @ref{1d7e,,mutáveis}, e seus elementos geralmente são homogêneos e são acessados iterando sobre a lista.

Um problema especial é a criação de tuplas contendo 0 ou 1 itens: a sintaxe usa certos truques para acomodar estes casos. Tuplas vazias são construídas por um par de parênteses vazios; uma tupla unitária é construída por um único valor seguido de uma vírgula (não basta colocar um único valor entre parênteses). Feio, mas funciona. Por exemplo:

@example
>>> vazio = ()
>>> unitário = 'olá', # <!- note a vírgula ao final
>>> len(vazio)
0
>>> len(unitário)
1
>>> unitário
('olá',)
@end example

A instrução @code{t = 12345, 54321, 'bom dia!'} é um exemplo de `empacotamento de tupla': os valores @code{12345}, @code{54321} e @code{'bom dia!'} são empacotados em uma tupla. A operação inversa também é possível:

@example
>>> x, y, z = t
@end example

Isso é chamado, apropriadamente, de `desempacotamento de sequência' e funciona para qualquer sequência no lado direito. O desempacotamento de sequência requer que haja tantas variáveis no lado esquerdo do sinal de igual, quanto existem de elementos na sequência. Observe que a atribuição múltipla é, na verdade, apenas uma combinação de empacotamento de tupla e desempacotamento de sequência.

@node Conjuntos,Dicionários,Tuplas e Sequências,Estruturas de dados
@anchor{tutorial/datastructures sets}@anchor{1dcd}@anchor{tutorial/datastructures tut-sets}@anchor{1dce}
@subsection Conjuntos


Python também inclui um tipo de dados para @ref{1dcf,,conjuntos}, chamado @code{set}. Um conjunto é uma coleção desordenada de elementos, sem elementos repetidos. Usos comuns para conjuntos incluem a verificação eficiente da existência de objetos e a eliminação de itens duplicados. Conjuntos também suportam operações matemáticas como união, interseção, diferença e diferença simétrica.

Chaves ou a função @ref{5d9,,set()} podem ser usados para criar conjuntos. Note: para criar um conjunto vazio você precisa usar @code{set()}, não @code{@{@}}; este último cria um dicionário vazio, uma estrutura de dados que discutiremos na próxima seção.

Uma pequena demonstração:

@example
>>> cesta = @{'maçã', 'laranja', 'maçã', 'pera', 'laranja', 'banana'@}
>>> print(cesta)                       # mostra que itens duplicados foram removidos
@{'laranja', 'banana', 'pera', 'maçã'@}
>>> 'laranja' in cesta                 # teste de pertinência rápido
True
>>> 'crabgrass' in cesta
False

>>> # Demonstra operações de conjunto em letras únicas de duas palavras
>>>
>>> a = set('abracadabra')
>>> b = set('alacazam')
>>> a                                  # letras únicas em a
@{'a', 'r', 'b', 'c', 'd'@}
>>> a - b                              # letras em a, mas não em b
@{'r', 'd', 'b'@}
>>> a | b                              # letras em a ou em b ou ambos
@{'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'@}
>>> a & b                              # letras em ambos a e b
@{'a', 'c'@}
>>> a ^ b                              # letras em a ou b, mas não em ambos
@{'r', 'd', 'b', 'm', 'z', 'l'@}
@end example

Da mesma forma que @ref{1dc7,,compreensão de listas}, compreensões de conjunto também são suportadas:

@example
>>> a = @{x for x in 'abracadabra' if x not in 'abc'@}
>>> a
@{'r', 'd'@}
@end example

@node Dicionários,Técnicas de iteração,Conjuntos,Estruturas de dados
@anchor{tutorial/datastructures dictionaries}@anchor{1dd0}@anchor{tutorial/datastructures tut-dictionaries}@anchor{1dd1}
@subsection Dicionários


Outra estrutura de dados embutida muito útil em Python é o `dicionário', cujo tipo é @code{dict} (ver @ref{ad6,,Tipo mapeamento — dict}). Dicionários são também chamados de “memória associativa” ou “vetor associativo” em outras linguagens. Diferente de sequências que são indexadas por inteiros, dicionários são indexados por chaves (`keys'), que podem ser de qualquer tipo imutável (como strings e inteiros). Tuplas também podem ser chaves se contiverem apenas strings, inteiros ou outras tuplas. Se a tupla contiver, direta ou indiretamente, qualquer valor mutável, não poderá ser chave. Listas não podem ser usadas como chaves porque podem ser modificadas `internamente' pela atribuição em índices ou fatias, e por métodos como @ref{6cd,,append()} e @ref{35d,,extend()}.

Um bom modelo mental é imaginar um dicionário como um conjunto não-ordenado de pares `chave:valor', onde as chaves são únicas em uma dada instância do dicionário. Dicionários são delimitados por chaves: @code{@{@}}, e contém uma lista de pares chave:valor separada por vírgulas. Dessa forma também será exibido o conteúdo de um dicionário no console do Python. O dicionário vazio é @code{@{@}}.

As principais operações em um dicionário são armazenar e recuperar valores a partir de chaves. Também é possível remover um par `chave:valor' com o comando @code{del}. Se você armazenar um valor utilizando uma chave já presente, o antigo valor será substituído pelo novo.

Extrair um valor para uma chave inexistente por meio de um índice (@code{d[key]}) levanta @ref{344,,KeyError}. Para evitar esse erro ao tentar acessar uma chave possivelmente inexistente, use o método @ref{1dd2,,get()}, que retorna @code{None} (ou um valor padrão especificado) se a chave não estiver no dicionário.

Executar @code{list(d)} em um dicionário devolve a lista de todas as chaves presentes no dicionário, na ordem de inserção (se desejar ordená-las basta usar a função @code{sorted(d)}). Para verificar a existência de uma chave, use o operador @ref{2f4,,in}.

A seguir, um exemplo de uso do dicionário:

@example
>>> tel = @{'jack': 4098, 'sape': 4139@}
>>> tel['guido'] = 4127
>>> tel
@{'jack': 4098, 'sape': 4139, 'guido': 4127@}
>>> tel['jack']
4098
>>> tel['irv']
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'irv'
>>> print(tel.get('irv'))
None
>>> 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

O construtor @ref{256,,dict()} produz dicionários diretamente de sequências de pares chave-valor:

@example
>>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

Além disso, as compreensões de dicionários podem ser usadas para criar dicionários a partir de expressões arbitrárias de chave e valor:

@example
>>> @{x: x**2 for x in (2, 4, 6)@}
@{2: 4, 4: 16, 6: 36@}
@end example

Quando chaves são strings simples, é mais fácil especificar os pares usando argumentos nomeados no construtor:

@example
>>> dict(sape=4139, guido=4127, jack=4098)
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

@node Técnicas de iteração,Mais sobre condições,Dicionários,Estruturas de dados
@anchor{tutorial/datastructures looping-techniques}@anchor{1dd3}@anchor{tutorial/datastructures tut-loopidioms}@anchor{1d8f}
@subsection Técnicas de iteração


Ao iterar sobre dicionários, a chave e o valor correspondente podem ser obtidos simultaneamente usando o método @ref{7d0,,items()}.

@example
>>> cavaleiros = @{'gallahad': 'o puro', 'robin': 'o bravo'@}
>>> for k, v in cavaleiros.items():
...     print(k, v)
...
gallahad o puro
robin o bravo
@end example

Ao iterar sobre sequências, a posição e o valor correspondente podem ser obtidos simultaneamente usando a função @ref{14c9,,enumerate()}.

@example
>>> for i, v in enumerate(['jogo', 'da', 'velha']):
...     print(i, v)
...
0 jogo
1 da
2 velha
@end example

Para percorrer duas ou mais sequências ao mesmo tempo, as entradas podem ser pareadas com a função @ref{7d1,,zip()}.

@example
>>> perguntas = ['Nome', 'Missão', 'Cor favorita']
>>> respostas = ['Lancelot', 'o santo graal', 'azul']
>>> for q, a in zip(perguntas, respostas):
...     print('@{0@}? É @{1@}.'.format(q, a))
...
Nome? É Lancelot.
Missão? É o santo graal.
Cor favorita? É azul.
@end example

Para percorrer uma sequência em ordem inversa, chame a função @ref{869,,reversed()} com a sequência na ordem original.

@example
>>> for i in reversed(range(1, 10, 2)):
...     print(i)
...
9
7
5
3
1
@end example

Para percorrer uma sequência de maneira ordenada, use a função @ref{be7,,sorted()}, que retorna uma lista ordenada com os itens, mantendo a sequência original inalterada.

@example
>>> cesta = ['maçã', 'laranja', 'maçã', 'pera', 'laranja', 'banana']
>>> for i in sorted(cesta):
...     print(i)
...
maçã
maçã
banana
laranja
laranja
pera
@end example

Usar @ref{5d9,,set()} em uma sequência elimina elementos duplicados. O uso de @ref{be7,,sorted()} em combinação com @ref{5d9,,set()} sobre uma sequência é uma maneira idiomática de fazer um loop sobre elementos exclusivos da sequência na ordem de classificação.

@example
>>> cesta = ['maçã', 'laranja', 'maçã', 'pera', 'laranja', 'banana']
>>> for i in sorted(cesta):
...     print(i)
...
maçã
maçã
banana
laranja
laranja
pera
@end example

Às vezes é tentador alterar uma lista enquanto você itera sobre ela; porém, costuma ser mais simples e seguro criar uma nova lista.

@example
>>> import math
>>> dados_brutos = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8]
>>> dados_filtrados = []
>>> for valor in dados_brutos:
...     if not math.isnan(value):
...         dados_filtrados.append(valor)
...
>>> dados_filtrados
[56.2, 51.7, 55.3, 52.5, 47.8]
@end example

@node Mais sobre condições,Comparando sequências e outros tipos,Técnicas de iteração,Estruturas de dados
@anchor{tutorial/datastructures more-on-conditions}@anchor{1dd4}@anchor{tutorial/datastructures tut-conditions}@anchor{1dd5}
@subsection Mais sobre condições


As condições de controle usadas nas instruções @code{while} e @code{if} podem conter quaisquer operadores, não apenas comparações.

Os operadores de comparação @code{in} e @code{not in} fazem testes de inclusão que determinam se um valor está (ou não está) em um contêiner. Os operadores @code{is} e @code{is not} comparam se dois objetos são realmente o mesmo objeto.  Todos os operadores de comparação possuem a mesma prioridade, que é menor que a prioridade de todos os operadores numéricos.

Comparações podem ser encadeadas: Por exemplo @code{a < b == c} testa se @code{a} é menor que @code{b} e também se @code{b} é igual a @code{c}.

Comparações podem ser combinadas através de operadores booleanos @code{and} e @code{or}, e o resultado de uma comparação (ou de qualquer outra expressão), pode ter seu valor booleano negado através de @code{not}. Estes possuem menor prioridade que os demais operadores de comparação. Entre eles, @code{not} é o de maior prioridade e @code{or} o de menor. Dessa forma, a condição @code{A and not B or C} é equivalente a @code{(A and (not B)) or C}. Naturalmente, parênteses podem ser usados para expressar o agrupamento desejado.

Os operadores booleanos @code{and} e @code{or} são operadores `curto-circuito': seus argumentos são avaliados da esquerda para a direita, e a avaliação encerra quando o resultado é determinado. Por exemplo, se @code{A} e @code{C} são expressões verdadeiras, mas @code{B} é falsa, então @code{A and B and C} não chega a avaliar a expressão @code{C}. Em geral, quando usado sobre valores genéricos e não como booleanos, o valor do resultado de um operador curto-circuito é o último valor avaliado na expressão.

É possível atribuir o resultado de uma comparação ou outra expressão booleana para uma variável. Por exemplo:

@example
>>> string1, string2, string3 = '@w{'}, 'Trondheim', 'Hammer Dance'
>>> non_null = string1 or string2 or string3
>>> non_null
'Trondheim'
@end example

Observe que no Python, ao contrário de C, a atribuição dentro de expressões deve ser feita explicitamente com o @ref{1dd6,,operador morsa} @code{:=}. Isso evita uma classe comum de problemas encontrados nos programas C: digitar @code{=} em uma expressão quando @code{==} era o planejado.

@node Comparando sequências e outros tipos,,Mais sobre condições,Estruturas de dados
@anchor{tutorial/datastructures comparing-sequences-and-other-types}@anchor{1dd7}@anchor{tutorial/datastructures tut-comparing}@anchor{1dd8}
@subsection Comparando sequências e outros tipos


Objetos sequência podem ser comparados com outros objetos sequência, desde que o tipo das sequências seja o mesmo. A comparação utiliza a ordem lexicográfica: primeiramente os dois primeiros itens são comparados, e se diferirem isto determinará o resultado da comparação, caso contrário os próximos dois itens serão comparados, e assim por diante até que se tenha exaurido alguma das sequências. Se em uma comparação de itens, os mesmos forem também sequências (aninhadas), então é disparada recursivamente outra comparação lexicográfica. Se todos os itens da sequência forem iguais, então as sequências são ditas iguais. Se uma das sequências é uma subsequência da outra, então a subsequência é a menor. A comparação lexicográfica de strings utiliza codificação Unicode para definir a ordenação. Alguns exemplos de comparações entre sequências do mesmo 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

Note que comparar objetos de tipos diferentes com @code{<} ou @code{>} é permitido desde que os objetos possuam os métodos de comparação apropriados. Por exemplo, tipos numéricos mistos são comparados de acordo com os seus valores numéricos, portanto 0 é igual a 0.0, etc. Em caso contrário, ao invés de fornecer uma ordenação arbitrária, o interpretador levantará um @ref{2c3,,TypeError}.

@node Módulos<2>,Entrada e Saída,Estruturas de dados,O tutorial do Python
@anchor{tutorial/modules doc}@anchor{1dd9}@anchor{tutorial/modules modules}@anchor{1dda}@anchor{tutorial/modules translation-repo}@anchor{1ddb}@anchor{tutorial/modules tut-modules}@anchor{1ddc}
@section Módulos


Ao sair e entrar de novo no interpretador Python, as definições anteriores (funções e variáveis) são perdidas. Portanto, se quiser escrever um programa maior, será mais eficiente usar um editor de texto para preparar as entradas para o interpretador, e executá-lo usando o arquivo como entrada. Isso é conhecido como criar um `script'. Se o programa se torna ainda maior, é uma boa prática dividi-lo em arquivos menores, para facilitar a manutenção. Também é preferível usar um arquivo separado para uma função que você escreveria em vários programas diferentes, para não copiar a definição de função em cada um deles.

Para permitir isso, Python tem uma maneira de colocar as definições em um arquivo e então usá-las em um script ou em uma execução interativa do interpretador. Tal arquivo é chamado de `módulo'; definições de um módulo podem ser `importadas' para outros módulos, ou para o módulo `principal' (a coleção de variáveis a que você tem acesso num script executado como um programa e no modo calculadora).

Um módulo é um arquivo contendo definições e instruções Python. O nome do arquivo é o nome do módulo acrescido do sufixo @code{.py}. Dentro de um módulo, o nome do módulo (como uma string) está disponível como o valor da variável global @code{__name__}. Por exemplo, use seu editor de texto favorito para criar um arquivo chamado @code{fibo.py} no diretório atual com o seguinte conteúdo:

@example
# Módulo de números de Fibonacci

def fib(n):
    """Escreve a série de Fibonacci até n."""
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()

def fib2(n):
    """Retorna a série de Fibonacci até n."""
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result
@end example

Agora, entre no interpretador Python e importe esse módulo com o seguinte
comando:

@example
>>> import fibo
@end example

Isso não adiciona os nomes das funções definidas em @code{fibo} diretamente ao @ref{1ddd,,espaço de nomes} atual (veja @ref{1dde,,Escopos e espaços de nomes do Python} para mais detalhes); isso adiciona somente o nome do módulo @code{fibo}. Usando o nome do módulo você pode acessar as funções:

@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

Se você pretende usar uma função muitas vezes, você pode atribui-lá a um nome 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
* Mais sobre módulos:: 
* Módulos padrões:: 
* A função dir(): A função dir. 
* Pacotes:: 

@end menu

@node Mais sobre módulos,Módulos padrões,,Módulos<2>
@anchor{tutorial/modules more-on-modules}@anchor{1ddf}@anchor{tutorial/modules tut-moremodules}@anchor{1de0}
@subsection Mais sobre módulos


Um módulo pode conter tanto instruções executáveis quanto definições de funções e classes. Essas instruções servem para inicializar o módulo. Eles são executados somente na `primeira' vez que o módulo é encontrado em uma instrução de importação. @footnote{
[#] Na verdade, definições de funções também são ‘instruções’ que são ‘executados’; a execução da definição de uma função adiciona o nome da função no espaço de nomes global do módulo.
} (Também rodam se o arquivo é executado como um script.)

Cada módulo tem seu próprio espaço de nomes privado, que é usado como espaço de nomes global para todas as funções definidas no módulo. Assim, o autor de um módulo pode usar variáveis globais no seu módulo sem se preocupar com conflitos acidentais com as variáveis globais do usuário. Por outro lado, se você precisar usar uma variável global de um módulo, poderá fazê-lo com a mesma notação usada para se referir às suas funções, @code{nomemodulo.nomeitem}.

Módulos podem importar outros módulos. É costume, porém não obrigatório, colocar todas as instruções @ref{5e2,,import} no início do módulo (ou script , se preferir). As definições do módulo importado, se colocados no nível de um módulo (fora de quaisquer funções ou classes), elas são adicionadas a espaço de nomes global da módulo.

Existe uma variante da instrução @ref{5e2,,import} que importa definições de um módulo diretamente para o espaço de nomes do módulo importador. Por exemplo:

@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

Isso não coloca o nome do módulo de onde foram feitas as importações no espaço de nomes local (assim, no exemplo, @code{fibo} não está definido).

Existe ainda uma variante que importa todos os nomes definidos em um módulo:

@example
>>> from fibo import *
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

Isso importa todos as declarações de nomes, exceto aqueles que iniciam com um sublinhado (@code{_}). Na maioria dos casos, programadores Python não usam esta facilidade porque ela introduz um conjunto desconhecido de nomes no ambiente, podendo esconder outros nomes previamente definidos.

Note que, em geral, a prática do @code{import *} de um módulo ou pacote é desaprovada, uma vez que muitas vezes dificulta a leitura do código. Contudo, é aceitável para diminuir a digitação em sessões interativas.

Se o nome do módulo é seguido pela palavra-chave @code{as}, o nome a seguir é vinculado diretamente ao 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

Isto efetivamente importa o módulo, da mesma maneira que @code{import fibo} fará, com a única diferença de estar disponível com o nome @code{fib}.

Também pode ser utilizado com a palavra-chave @ref{12ee,,from}, com efeitos 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 
For efficiency reasons, each module is only imported once per interpreter
session.  Therefore, if you change your modules, you must restart the
interpreter – or, if it’s just one module you want to test interactively,
use @ref{519,,importlib.reload()}, e.g. @code{import importlib;
importlib.reload(modulename)}.
@end quotation
@end cartouche

@menu
* Executando módulos como scripts:: 
* O caminho de busca dos módulos:: 
* Arquivos Python “compilados”:: 

@end menu

@node Executando módulos como scripts,O caminho de busca dos módulos,,Mais sobre módulos
@anchor{tutorial/modules executing-modules-as-scripts}@anchor{1de1}@anchor{tutorial/modules tut-modulesasscripts}@anchor{1de2}
@subsubsection Executando módulos como scripts


Quando você rodar um módulo Python com

@example
python fibo.py <argumentos>
@end example

o código no módulo será executado, da mesma forma que quando é importado, mas com a variável @code{__name__} com valor @code{"__main__"}. Isto significa que adicionando este código ao final do seu módulo:

@example
if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))
@end example

você pode tornar o arquivo utilizável tanto como script quanto como um módulo importável, porque o código que analisa a linha de comando só roda se o módulo é executado como arquivo “principal”:

@example
$ python fibo.py 50
0 1 1 2 3 5 8 13 21 34
@end example

Se o módulo é importado, o código não é executado:

@example
>>> import fibo
>>>
@end example

Isso é frequentemente usado para fornecer uma interface de usuário conveniente para um módulo, ou para realizar testes (rodando o módulo como um script executa um conjunto de testes).

@node O caminho de busca dos módulos,Arquivos Python “compilados”,Executando módulos como scripts,Mais sobre módulos
@anchor{tutorial/modules the-module-search-path}@anchor{1de3}@anchor{tutorial/modules tut-searchpath}@anchor{1de4}
@subsubsection O caminho de busca dos módulos


@geindex módulo;pesquisa;caminho

Quando um módulo chamado @code{spam} é importado, o interpretador procura um módulo embutido com este nome. Estes nomes de módulo são listados em @ref{1de5,,sys.builtin_module_names}. Se não encontra, procura um arquivo chamado @code{spam.py} em uma lista de diretórios incluídos na variável @ref{3b4,,sys.path}. A @ref{3b4,,sys.path} é inicializada com estes locais:


@itemize *

@item 
O diretório que contém o script importador (ou o diretório atual quando nenhum arquivo é especificado).

@item 
A variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} (uma lista de nomes de diretórios, com a mesma sintaxe da variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}).

@item 
O padrão dependente da instalação (por convenção, incluindo um diretório @code{site-packages}, tratado pelo módulo @ref{c7,,site}).
@end itemize

Mais detalhes em @ref{1de6,,A inicialização do caminho de pesquisa de módulos sys.path}.

@cartouche
@quotation Nota 
Nos sistemas de arquivos que suportam links simbólicos, o diretório contendo o script de entrada é resultante do diretório apontado pelo link simbólico. Em outras palavras o diretório que contém o link simbólico `não' é adicionado ao caminho de busca de módulos.
@end quotation
@end cartouche

Após a inicialização, programas Python podem modificar @ref{3b4,,sys.path}. O diretório que contém o script sendo executado é colocado no início da lista de caminhos, à frente do caminho da biblioteca padrão. Isto significa que módulos nesse diretório serão carregados, no lugar de módulos com o mesmo nome na biblioteca padrão. Isso costuma ser um erro, a menos que seja intencional. Veja a seção @ref{1de7,,Módulos padrões} para mais informações.

@c %
@c Do we need stuff on zip files etc. ? DUBOIS

@node Arquivos Python “compilados”,,O caminho de busca dos módulos,Mais sobre módulos
@anchor{tutorial/modules compiled-python-files}@anchor{1de8}@anchor{tutorial/modules tut-pycache}@anchor{6dc}
@subsubsection Arquivos Python “compilados”


Para acelerar o carregamento de módulos, o Python guarda versões compiladas de cada módulo no diretório @code{__pycache__} com o nome @code{modulo.`versão'.pyc}, onde a versão corresponde ao formato do arquivo compilado; geralmente contêm o número da versão Python utilizada. Por exemplo, no CPython release 3.3 a versão compilada de spam.py será guardada como @code{__pycache__/spam.cpython-33.pyc}. Esta convenção de nomes permite a coexistência de módulos compilados de diferentes releases e versões de Python.

O Python verifica a data de modificação do arquivo fonte mediante a versão compilada, para ver se está desatualizada e precisa ser recompilada. É um processo completamente automático. Além disso, os módulos compilados são independentes de plataforma, portanto a mesma biblioteca pode ser compartilhada entre sistemas de arquiteturas diferentes.

O Python não verifica as versões compiladas em duas circunstâncias. Primeiro, sempre recompila e não armazena o resultado para módulos carregados diretamente da linha de comando. Segundo, não verifica se não houver um módulo fonte. Para suportar uma distribuição sem fontes (somente as versões compiladas), o módulo compilado deve estar no diretório de fontes, e não deve haver um módulo fonte.

Algumas dicas para especialistas:


@itemize *

@item 
Você pode usar as opções @ref{ddd,,-O} ou @ref{dde,,-OO} no comando Python para reduzir o tamanho de um módulo compilado. A opção @code{-O} remove as instruções assert, e a opção @code{-OO} remove, além das instruções assert, as strings de documentações. Como alguns programas podem contar com essa disponibilidade, só use essa opção se souber o que está fazendo. Módulos “otimizados” tem uma marcação @code{opt-} e são geralmente de menor tamanho. Futuros releases podem mudar os efeitos da otimização.

@item 
Um programa não roda mais rápido quando é lido de um arquivo @code{.pyc} do que quando lido de um arquivo @code{.py}; a única coisa que é mais rápida com arquivos @code{.pyc} é sua velocidade de carregamento.

@item 
O módulo @ref{20,,compileall} pode criar arquivos .pyc para todos os módulos de um diretório.

@item 
Há mais detalhes desse processo, incluindo um fluxograma de decisões, no 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}.
@end itemize

@node Módulos padrões,A função dir,Mais sobre módulos,Módulos<2>
@anchor{tutorial/modules standard-modules}@anchor{1de9}@anchor{tutorial/modules tut-standardmodules}@anchor{1de7}
@subsection Módulos padrões


@geindex módulo;sys

O Python traz uma biblioteca padrão de módulos, descrita em um documento em separado, a Referência da Biblioteca Python (doravante “Referência da Biblioteca”). Alguns módulos estão embutidos no interpretador; estes possibilitam acesso a operações que não são parte do núcleo da linguagem, mas estão no interpretador seja por eficiência ou para permitir o acesso a chamadas do sistema operacional. O conjunto destes módulos é uma opção de configuração que depende também da plataforma utilizada. Por exemplo, o módulo @ref{116,,winreg} só está disponível em sistemas Windows. Existe um módulo que requer especial atenção: @ref{d9,,sys}, que é embutido em qualquer interpretador Python. As variáveis @code{sys.ps1} e @code{sys.ps2} definem as strings utilizadas como prompt primário e secundário:

@example
>>> import sys
>>> sys.ps1
'>>> '
>>> sys.ps2
'... '
>>> sys.ps1 = 'C> '
C> print('ECA!')
Yuck!
C>
@end example

Essas variáveis só estão definidas se o interpretador está em modo interativo.

A variável @code{sys.path} contém uma lista de strings que determina os caminhos de busca de módulos conhecidos pelo interpretador. Ela é inicializada para um caminho padrão, determinado pela variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}, ou por um valor padrão embutido, se 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} não estiver definida. Você pode modificá-la com as operações típicas de lista, por exemplo:

@example
>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')
@end example

@node A função dir,Pacotes,Módulos padrões,Módulos<2>
@anchor{tutorial/modules the-dir-function}@anchor{1dea}@anchor{tutorial/modules tut-dir}@anchor{1deb}
@subsection A função @code{dir()}


A função embutida @ref{632,,dir()} é usada para descobrir quais nomes são definidos por um módulo. Ela devolve uma lista ordenada de strings:

@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

Sem argumentos, @ref{632,,dir()} lista os nomes atualmente definidos:

@example
>>> a = [1, 2, 3, 4, 5]
>>> import fibo
>>> fib = fibo.fib
>>> dir()
['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']
@end example

Observe que ela lista todo tipo de nomes: variáveis, módulos, funções, etc.

@geindex módulo;builtins

@ref{632,,dir()} não lista os nomes de variáveis e funções embutidas. Esta lista está disponível no módulo padrão @ref{12,,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 Pacotes,,A função dir,Módulos<2>
@anchor{tutorial/modules packages}@anchor{1dec}@anchor{tutorial/modules tut-packages}@anchor{1ded}
@subsection Pacotes


Os pacotes são uma maneira de estruturar o “espaço de nomes” dos módulos Python, usando “nomes de módulo com pontos”. Por exemplo, o nome do módulo @code{A.B} designa um submódulo chamado @code{B}, em um pacote chamado @code{A}. Assim como o uso de módulos evita que os autores de módulos diferentes tenham que se preocupar com nomes de variáveis globais, o uso de nomes de módulos com pontos evita que os autores de pacotes com muitos módulos, como NumPy ou Pillow, tenham que se preocupar com os nomes dos módulos uns dos outros.

Suponha que você queira projetar uma coleção de módulos (um “pacote”) para o gerenciamento uniforme de arquivos de som. Existem muitos formatos diferentes (normalmente identificados pela extensão do nome de arquivo, por exemplo @code{.wav}, @code{.aiff}, @code{.au}), de forma que você pode precisar criar e manter uma crescente coleção de módulos de conversão entre formatos. Ainda podem existir muitas operações diferentes, passíveis de aplicação sobre os arquivos de som (mixagem, eco, equalização, efeito stereo artificial). Logo, possivelmente você também estará escrevendo uma coleção sempre crescente de módulos para aplicar estas operações. Eis uma possível estrutura para o seu pacote (expressa em termos de um sistema de arquivos hierárquico):

@example
sound/                          pacote de nível superior
      __init__.py               Inicializa o pacote de som
      formats/                  Subpacote para as conversões entre formatos de arquivos
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  Subpacote para efeitos de som
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  Subpacote para filtros
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...
@end example

Ao importar esse pacote, Python busca pelo subdiretório com mesmo nome, nos diretórios listados em @code{sys.path}.

Os arquivos @code{__init__.py} são necessários para que o Python trate diretórios contendo o arquivo como pacotes (a menos que se esteja usando um @ref{1dee,,pacote de espaço de nomes}, um recurso relativamente avançado). Isso impede que diretórios com um nome comum, como @code{string}, ocultem, involuntariamente, módulos válidos que ocorrem posteriormente no caminho de busca do módulo. No caso mais simples, @code{__init__.py} pode ser apenas um arquivo vazio, mas pode também executar código de inicialização do pacote, ou configurar a variável @code{__all__}, descrita mais adiante.

Usuários do pacote podem importar módulos individuais, por exemplo:

@example
import sound.effects.echo
@end example

Isso carrega o submódulo @code{sound.effects.echo}. Ele deve ser referenciado com seu nome completo, como em:

@example
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)
@end example

Uma maneira alternativa para a importação desse módulo é:

@example
from sound.effects import echo
@end example

Isso carrega o submódulo @code{echo} sem necessidade de mencionar o prefixo do pacote no momento da utilização, assim:

@example
echo.echofilter(input, output, delay=0.7, atten=4)
@end example

Também é possível importar diretamente uma única variável ou função:

@example
from sound.effects.echo import echofilter
@end example

Novamente, isso carrega o submódulo @code{echo}, mas a função @code{echofilter()} está acessível diretamente sem prefixo:

@example
echofilter(input, output, delay=0.7, atten=4)
@end example

Observe que ao utilizar @code{from pacote import item}, o item pode ser um subpacote, submódulo, classe, função ou variável. A instrução @code{import} primeiro testa se o item está definido no pacote, senão presume que é um módulo e tenta carregá-lo. Se falhar em encontrar o módulo, uma exceção @ref{419,,ImportError} é levantada.

Em oposição, em uma construção como @code{import item.subitem.subsubitem}, cada item, com exceção do último, deve ser um pacote. O último pode ser também um pacote ou módulo, mas nunca uma classe, função ou variável contida em um módulo.

@menu
* Importando * de um pacote:: 
* Referências em um mesmo pacote:: 
* Pacotes em múltiplos diretórios:: 

@end menu

@node Importando * de um pacote,Referências em um mesmo pacote,,Pacotes
@anchor{tutorial/modules importing-from-a-package}@anchor{1def}@anchor{tutorial/modules tut-pkg-import-star}@anchor{1df0}
@subsubsection Importando * de um pacote


@geindex __all__

Agora, o que acontece quando um usuário escreve @code{from sound.effects import *} ? Idealmente, poderia se esperar que este comando vasculhasse o sistema de arquivos, encontrasse todos os submódulos presentes no pacote, e os importasse. Isso poderia demorar muito e a importação de submódulos pode ocasionar efeitos colaterais, que somente deveriam ocorrer quando o submódulo é explicitamente importado.

A única solução é o autor do pacote fornecer um índice explícito do pacote. A instrução @ref{5e2,,import} usa a seguinte convenção: se o arquivo @code{__init__.py} do pacote define uma lista chamada @code{__all__}, então esta lista indica os nomes dos módulos a serem importados quando a instrução @code{from pacote import *} é acionada. Fica a cargo do autor do pacote manter esta lista atualizada, inclusive fica a seu critério excluir inteiramente o suporte a importação direta de todo o pacote através de @code{from pacote import *}. Por exemplo, o arquivo @code{sounds/effects/__init__.py} poderia conter apenas:

@example
__all__ = ["echo", "surround", "reverse"]
@end example

Isso significaria que @code{from sound.effects import *} importaria os três submódulos nomeados do pacote @code{sound.effects}.

Esteja ciente de que os submódulos podem ficar sobrepostos por nomes definidos localmente. Por exemplo, se você adicionou uma função @code{reverse} ao arquivo @code{sound/effects/__init__.py}, usar @code{from sound.effects import *} só importaria os dois submódulos @code{echo} e @code{surround}, mas `não' o submódulo @code{reverse}, porque ele fica sobreposto pela função @code{reverse} definida localmente:

@example
__all__ = [
    "echo",      # refere-se ao arquivo 'echo.py'
    "surround",  # refere-se ao arquivo 'surround.py'
    "reverse",   # !!! refere-se à função 'reverse' agora !!!
]

def reverse(msg: str):  # <-- este nome ofusca o submódulo 'reverse.py'
    return msg[::-1]    #     no caso de uma importação 'from sound.effects import *'
@end example

Se @code{__all__} não estiver definido, a instrução @code{from sound.effects import *} não importa todos os submódulos do pacote @code{sound.effects} no espaço de nomes atual. Há apenas garantia que o pacote @code{sound.effects} foi importado (possivelmente executando qualquer código de inicialização em @code{__init__.py}) juntamente com os nomes definidos no pacote. Isso inclui todo nome definido em @code{__init__.py} bem como em qualquer submódulo importado a partir deste. Também inclui quaisquer submódulos do pacote que tenham sido carregados explicitamente por instruções @ref{5e2,,import} anteriores. Considere o código abaixo:

@example
import sound.effects.echo
import sound.effects.surround
from sound.effects import *
@end example

Nesse exemplo, os módulos @code{echo} e @code{surround} são importados no espaço de nomes atual, no momento em que a instrução @code{from...import} é executada, pois estão definidos no pacote @code{sound.effects}. (Isso também funciona quando @code{__all__} estiver definida.)

Apesar de que certos módulos são projetados para exportar apenas nomes conforme algum critério quando se faz @code{import *}, ainda assim essa sintaxe é considerada uma prática ruim em código de produção.

Lembre-se, não há nada errado em usar @code{from pacote import submodulo_especifico}! De fato, essa é a notação recomendada, a menos que o módulo importado necessite usar submódulos com o mesmo nome, de diferentes pacotes.

@node Referências em um mesmo pacote,Pacotes em múltiplos diretórios,Importando * de um pacote,Pacotes
@anchor{tutorial/modules id2}@anchor{1df1}@anchor{tutorial/modules intra-package-references}@anchor{1df2}
@subsubsection Referências em um mesmo pacote


Quando pacotes são estruturados em subpacotes (como no pacote @code{sound} do exemplo), pode-se usar a sintaxe de importações absolutas para se referir aos submódulos de pacotes irmãos (o que na prática é uma forma de fazer um import relativo, a partir da base do pacote). Por exemplo, se o módulo @code{sound.filters.vocoder} precisa usar o módulo @code{echo} do pacote @code{sound.effects}, é preciso importá-lo com @code{from sound.effects import echo}.

Também é possível escrever imports relativos, com a forma @code{from module import name}. Esses imports usam pontos para indicar o pacote pai e o atual, envolvidos no import relativo. Do módulo @code{surround}, por exemplo, pode-se usar:

@example
from . import echo
from .. import formats
from ..filters import equalizer
@end example

Observe que as importações relativas são baseadas no nome do pacote do módulo atual. Como o módulo principal não possui um pacote, os módulos destinados ao uso como módulo principal de uma aplicação Python devem sempre usar importações absolutas.

@node Pacotes em múltiplos diretórios,,Referências em um mesmo pacote,Pacotes
@anchor{tutorial/modules packages-in-multiple-directories}@anchor{1df3}
@subsubsection Pacotes em múltiplos diretórios


Pacotes possuem mais um atributo especial, @ref{1df4,,__path__}. Inicializado como uma @ref{4f1,,sequência} de strings contendo o nome do diretório onde está o arquivo @code{__init__.py} do pacote, antes do código naquele arquivo ser executado. Esta variável pode ser modificada; isso afeta a busca futura de módulos e subpacotes contidos no pacote.

Apesar de não ser muito usado, esse mecanismo permite estender o conjunto de módulos encontrados em um pacote.

@node Entrada e Saída,Erros e exceções,Módulos<2>,O tutorial do Python
@anchor{tutorial/inputoutput doc}@anchor{1df5}@anchor{tutorial/inputoutput input-and-output}@anchor{1df6}@anchor{tutorial/inputoutput translation-repo}@anchor{1df7}@anchor{tutorial/inputoutput tut-io}@anchor{1df8}
@section Entrada e Saída


Existem várias maneiras de apresentar a saída de um programa; os dados podem ser exibidos em forma legível para seres humanos, ou escritos em arquivos para uso posterior. Este capítulo apresentará algumas das possibilidades.

@menu
* Refinando a formatação de saída:: 
* Leitura e escrita de arquivos:: 

@end menu

@node Refinando a formatação de saída,Leitura e escrita de arquivos,,Entrada e Saída
@anchor{tutorial/inputoutput fancier-output-formatting}@anchor{1df9}@anchor{tutorial/inputoutput tut-formatting}@anchor{1dfa}
@subsection Refinando a formatação de saída


Até agora vimos duas maneiras de exibir valores: `expressões' e a função @ref{fa9,,print()}. (Uma outra maneira é utilizar o método @ref{1dfb,,write()} de objetos do tipo arquivo; o arquivo saída padrão pode ser referenciado como @code{sys.stdout}. Veja a Referência da Biblioteca Python para mais informações sobre isso.)

Muitas vezes se deseja mais controle sobre a formatação da saída do que simplesmente exibir valores separados por espaço. Existem várias maneiras de formatar a saída.


@itemize *

@item 
Para usar @ref{1dfc,,strings literais formatadas}, comece uma string com @code{f} ou @code{F}, antes de abrir as aspas ou aspas triplas. Dentro dessa string, pode-se escrever uma expressão Python entre caracteres @code{@{} e @code{@}}, que podem se referir a variáveis, ou valores literais.

@example
>>> ano = 2016
>>> evento = 'Referendo'
>>> f'Resultados do @{evento@} @{ano@}'
'Resultados do Referendo 2016'
@end example

@item 
O método de strings @ref{621,,str.format()} requer mais esforço manual. Ainda será necessário usar @code{@{} e @code{@}} para marcar onde a variável será substituída e pode-se incluir diretivas de formatação detalhadas, mas também precisará incluir a informação a ser formatada. No bloco de código a seguir há dois exemplos de como formatar variáveis:

@example
>>> votos_sim = 42_572_654
>>> votos_totais = 85_705_149
>>> porcentagem = votos_sim / votos_totais
>>> '@{:-9@} votos SIM  @{:2.2%@}'.format(votos_sim, porcentagem)
' 42572654 votos SIM  49.67%'
@end example

Observe como @code{yes_votes} são preenchidos com espaços e um sinal negativo apenas para números negativos. O exemplo também imprime @code{percentage} multiplicado por 100, com 2 casas decimais e seguido por um sinal de porcentagem (veja @ref{1e8,,Minilinguagem de especificação de formato} para detalhes).

@item 
Finalmente, pode-se fazer todo o tratamento da saída usando as operações de fatiamento e concatenação de strings para criar qualquer layout que se possa imaginar. O tipo string possui alguns métodos que realizam operações úteis para preenchimento de strings para uma determinada largura de coluna.
@end itemize

Quando não é necessário sofisticar a saída, mas apenas exibir algumas variáveis com propósito de depuração, pode-se converter qualquer valor para uma string com as funções @ref{800,,repr()} ou @ref{44c,,str()}.

A função @ref{44c,,str()} serve para retornar representações de valores que sejam legíveis para as pessoas, enquanto @ref{800,,repr()} é para gerar representações que o interpretador Python consegue ler (ou levantará uma exceção @ref{18d,,SyntaxError}, se não houver sintaxe equivalente). Para objetos que não têm uma representação adequada para consumo humano, @ref{44c,,str()} devolve o mesmo valor que @ref{800,,repr()}. Muitos valores, tal como números ou estruturas, como listas e dicionários, têm a mesma representação usando quaisquer das funções. Strings, em particular, têm duas representações distintas.

Alguns exemplos:

@example
>>> s = 'Olá, mundo.'
>>> str(s)
'Olá, mundo.'
>>> repr(s)
"'Olá, mundo.'"
>>> str(1/7)
'0.14285714285714285'
>>> x = 10 * 3.25
>>> y = 200 * 200
>>> s = 'O valor de x é ' + repr(x) + ' e de y é ' + repr(y) + '...'
>>> print(s)
O valor de x é 32.5 e de y é 40000...
>>> # A repr() da string adiciona aspas e contrabarras:
>>> olá = 'olá, mundo\n'
>>> olás = repr(olá)
>>> print(olás)
'olá, mundo\n'
>>> # O argumento de repr() pode ser qualquer objeto Python:
>>> repr((x, y, ('spam', 'ovos')))
"(32.5, 40000, ('spam', 'ovos'))"
@end example

O módulo @ref{d3,,string} contém uma classe @ref{687,,Template} que oferece ainda outra maneira de substituir valores em strings, usando espaços reservados como @code{$x} e substituindo-os por valores de um dicionário, mas oferece muito menos controle da formatação.

@geindex literal de string formatado
@geindex literal de string interpolada
@geindex string;literal formatado
@geindex string;literal interpolado
@geindex f-string
@geindex fstring

@menu
* Strings literais formatadas:: 
* O método format(): O método format. 
* Formatação manual de string:: 
* Formatação de strings à moda antiga:: 

@end menu

@node Strings literais formatadas,O método format,,Refinando a formatação de saída
@anchor{tutorial/inputoutput formatted-string-literals}@anchor{1dfd}@anchor{tutorial/inputoutput tut-f-strings}@anchor{1dfc}
@subsubsection Strings literais formatadas


@ref{9b1,,Strings literais formatadas} (também chamadas f-strings, para abreviar) permite que se inclua o valor de expressões Python dentro de uma string, prefixando-a com @code{f} ou @code{F} e escrevendo expressões na forma @code{@{expression@}}.

Um especificador opcional de formato pode ser incluído após a expressão. Isso permite maior controle sobre como o valor é formatado. O exemplo a seguir arredonda pi para três casas decimais:

@example
>>> import math
>>> print(f'O valor de pi é aproximadamente @{math.pi:.3f@}.')
O valor de pi é aproximadamente 3.142.
@end example

Passando um inteiro após o @code{':'} fará com que o campo tenha um número mínimo de caracteres de largura. Isso é útil para alinhar colunas.

@example
>>> tabela = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678@}
>>> for nome, telefone in tabela.items():
...     print(f'@{nome:10@} ==> @{telefone:10d@}')
...
Sjoerd     ==>       4127
Jack       ==>       4098
Dcab       ==>       7678
@end example

Outros modificadores podem ser usados para converter o valor antes de ser formatado. @code{'!a'} aplica a função @ref{142d,,ascii()}, @code{'!s'} aplica a função @ref{44c,,str()} e @code{'!r'} aplica a função @ref{800,,repr()}

@example
>>> animais = 'enguias'
>>> print(f'Meu hovercraft está cheio de @{animais@}.')
Meu hovercraft está cheio de enguias.
>>> print(f'Meu hovercraft está cheio de @{animais!r@}.')
Meu hovercraft está cheio de 'enguias'.
@end example

O especificador @code{=} pode ser usado para expandir uma expressão para o texto da expressão, um sinal de igual e, então, a representação da expressão avaliada:

@example
>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging @{bugs=@} @{count=@} @{area=@}')
Debugging bugs='roaches' count=13 area='living room'
@end example

Veja @ref{9af,,expressões autodocumentadas} para mais informações sobre o especificador @code{=}. Para obter uma referência sobre essas especificações de formato, consulte o guia de referência para a @ref{1e8,,Minilinguagem de especificação de formato}.

@node O método format,Formatação manual de string,Strings literais formatadas,Refinando a formatação de saída
@anchor{tutorial/inputoutput the-string-format-method}@anchor{1dfe}@anchor{tutorial/inputoutput tut-string-format}@anchor{1dff}
@subsubsection O método format()


Um uso básico do método @ref{621,,str.format()} tem esta forma:

@example
>>> print('Nós somos os @{@} que dizem "@{@}!"'.format('cavaleiros', 'Ni'))
Nós somos os cavaleiros que dizem "Ni!"
@end example

As chaves e seus conteúdos (chamados campos de formatação) são substituídos pelos objetos passados para o método @ref{621,,str.format()}. Um número nas chaves pode ser usado para referenciar a posição do objeto passado no método @ref{621,,str.format()}.

@example
>>> print('@{0@} e @{1@}'.format('spam', 'ovos'))
spam e eggs
>>> print('@{1@} e @{0@}'.format('spam', 'ovos'))
eggs e spam
@end example

Se argumentos nomeados são passados para o método @ref{621,,str.format()}, seus valores serão referenciados usando o nome do argumento:

@example
>>> print('Este @{comida@} está @{adjetivo@}.'.format(
...       comida='spam', adjetivo='absolutamente horrível'))
Este spam está absolutamente horrível.
@end example

Argumentos posicionais e nomeados podem ser combinados à vontade:

@example
>>> print('A história de @{0@}, @{1@} e @{outro@}.'.format('Bill', 'Manfred',
...                                                    outro='Georg'))
A história de Bill, Manfred e Georg.
@end example

Se uma string de formatação é muito longa, e não se deseja quebrá-la, pode ser bom fazer referência aos valores a serem formatados por nome, em vez de posição. Isto pode ser feito passando um dicionário usando colchetes @code{'[]'} para acessar as chaves.

@example
>>> tabela = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{0[Jack]:d@}; Sjoerd: @{0[Sjoerd]:d@}; '
...       'Dcab: @{0[Dcab]:d@}'.format(tabela))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

Isto também pode ser feito passando o dicionário @code{table} como argumentos nomeados com a notação @code{**}.

@example
>>> tabela = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{Jack:d@}; Sjoerd: @{Sjoerd:d@}; Dcab: @{Dcab:d@}'.format(**tabela))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

Isto é particularmente útil em conjunto com a função embutida @ref{1bba,,vars()}, que devolve um dicionário contendo todas as variáveis locais:

@example
>>> tabela = @{k: str(v) for k, v in vars().items()@}
>>> mensagem = " ".join([f'@{k@}: ' + '@{' + k +'@};' for k in tabela.keys()])
>>> print(mensagem.format(**tabela))
__name__: __main__; __doc__: None; __package__: None; __loader__: ...
@end example

Como exemplo, as linhas seguintes produzem um conjunto de colunas alinhadas, com alguns inteiros e seus quadrados e 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 uma visão completa da formatação de strings com @ref{621,,str.format()}, veja a seção @ref{13e2,,Sintaxe das strings de formato}.

@node Formatação manual de string,Formatação de strings à moda antiga,O método format,Refinando a formatação de saída
@anchor{tutorial/inputoutput manual-string-formatting}@anchor{1e00}
@subsubsection Formatação manual de string


Aqui está a mesma tabela de quadrados e cubos, formatados manualmente:

@example
>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # Observe o uso do 'end' na linha anterior
...     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

(Note que o espaço entre cada coluna foi adicionado pela forma que a função @ref{fa9,,print()} funciona: sempre adiciona espaços entre seus argumentos.)

O método @ref{1e01,,str.rjust()} justifica uma string à direita, num campo de tamanho definido, acrescentando espaços à esquerda. De forma similar, os métodos @ref{1e02,,str.ljust()}, justifica à esquerda, e @ref{1e03,,str.center()}, para centralizar. Esses métodos não escrevem nada, apenas retornam uma nova string. Se a string de entrada é muito longa, os métodos não truncarão a saída, e retornarão a mesma string, sem mudança; isso vai atrapalhar o layout da coluna, mas geralmente é melhor do que a alternativa, que estaria distorcendo o valor. (Se realmente quiser truncar, sempre se pode adicionar uma operação de fatiamento, como em @code{x.ljust(n)[:n]}.)

Existe ainda o método @ref{14fa,,str.zfill()} que preenche uma string numérica com zeros à esquerda, e sabe lidar com sinais positivos e negativos:

@example
>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'
@end example

@node Formatação de strings à moda antiga,,Formatação manual de string,Refinando a formatação de saída
@anchor{tutorial/inputoutput old-string-formatting}@anchor{1e04}
@subsubsection Formatação de strings à moda antiga


O operador % (módulo) também pode ser usado para formatação de string. Dado @code{formato % valores} (onde `formato' é uma string), as instâncias de @code{%} em @code{formato} serão substituídas por zero ou mais elementos de @code{valores}. Essa operação é conhecida como interpolação de string. Por exemplo:

@example
>>> import math
>>> print('O valor de pi é aproximadamente %5.3f.' % math.pi)
O valor de pi é aproximadamente 3.142.
@end example

Mais informação pode ser encontrada na seção @ref{6cc,,Formatação de string no estilo printf}.

@node Leitura e escrita de arquivos,,Refinando a formatação de saída,Entrada e Saída
@anchor{tutorial/inputoutput reading-and-writing-files}@anchor{1e05}@anchor{tutorial/inputoutput tut-files}@anchor{1e06}
@subsection Leitura e escrita de arquivos


@geindex função embutida;open
@geindex objeto;arquivo

@ref{51c,,open()} retorna um @ref{1203,,objeto arquivo}, e é mais utilizado com dois argumentos posicionais e um argumento nomeado: @code{open(filename, mode, encoding=None)}

@example
>>> f = open('arquivo_de_trabalho', '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>

O primeiro argumento é uma string contendo o nome do arquivo. O segundo argumento é outra string, contendo alguns caracteres que descrevem o modo como o arquivo será usado. `modo' pode ser @code{'r'} quando o arquivo será apenas lido, @code{'w'} para escrever (se o arquivo já existir seu conteúdo prévio será apagado), e @code{'a'} para abrir o arquivo para adição; qualquer escrita será adicionada ao final do arquivo. A opção @code{'r+'} abre o arquivo tanto para leitura como para escrita. O argumento `modo' é opcional, em caso de omissão será presumido @code{'r'}.

Normalmente, arquivos são abertos no `modo texto', o que significa que você lê strings de e para o arquivo, o qual está em um codificação específica. Se a `codificação' não for especificada, o padrão irá depender da plataforma (veja @ref{51c,,open()}). Como o UTF-8 é o padrão mais moderno, @code{encoding="utf-8"} é recomendado a não ser que você precise utilizar uma `codificação' diferente. Adicionando @code{'b'} ao modo irá abrir o o arquivo em `modo binário'. Dados no modo binário são lidos e escritos como objetos @ref{1c2,,bytes}.  Você não pode especificar a `codificação' quando estiver abrindo os arquivos em modo binário.

Em modo texto, o padrão durante a leitura é converter terminadores de linha específicos da plataforma (@code{\n} no Unix, @code{\r\n} no Windows) para apenas @code{\n}. Ao escrever no modo de texto, o padrão é converter as ocorrências de @code{\n} de volta para os finais de linha específicos da plataforma. Essa modificação de bastidores nos dados do arquivo é adequada para arquivos de texto, mas corromperá dados binários, como arquivos @code{JPEG} ou @code{EXE}. Tenha muito cuidado para só usar o modo binário, ao ler e gravar esses arquivos.

É uma boa prática usar a palavra-chave @ref{5d2,,with} ao lidar com arquivos. A vantagem é que o arquivo é fechado corretamente após o término de sua utilização, mesmo que uma exceção seja levantada em algum momento. Usar @code{with} também é muito mais curto que escrever seu bloco equivalente @ref{6e9,,try}-@ref{9d2,,finally}:

@example
>>> with open('arquivo_de_trabalho', encoding="utf-8") as f:
...     read_data = f.read()

>>> # Podemos verificar se o arquivo foi fechado automaticamente.
>>> f.closed
True
@end example

Se você não está usando a palavra reservada @ref{5d2,,with}, então você deveria chamar @code{f.close()} para fechar o arquivo e imediatamente liberar qualquer recurso do sistema usado por ele.

@cartouche
@quotation Aviso 
Chamar @code{f.write()} sem usar a palavra reservada @code{with} ou chamar @code{f.close()} `pode' resultar nos argumentos de @code{f.write()} não serem completamente escritos no disco, mesmo se o programa for encerrado com êxito.
@end quotation
@end cartouche

@c See also https://bugs.python.org/issue17852

Depois que um arquivo é fechado, seja por uma instrução @ref{5d2,,with} ou chamando @code{f.close()}, as tentativas de usar o arquivo falharão automaticamente.

@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 objetos arquivo:: 
* Gravando dados estruturados com json:: 

@end menu

@node Métodos de objetos arquivo,Gravando dados estruturados com json,,Leitura e escrita de arquivos
@anchor{tutorial/inputoutput methods-of-file-objects}@anchor{1e07}@anchor{tutorial/inputoutput tut-filemethods}@anchor{1e08}
@subsubsection Métodos de objetos arquivo


Para simplificar, o resto dos exemplos nesta seção presumem que um objeto arquivo chamado @code{f} já foi criado.

Para ler o conteúdo de um arquivo, chame @code{f.read(tamanho)}, que lê um punhado de dados devolvendo-os como uma string (em modo texto) ou bytes (em modo binário). `tamanho' é um argumento numérico opcional. Quando `tamanho' é omitido ou negativo, todo o conteúdo do arquivo é lido e devolvido; se o arquivo é duas vezes maior que memória da máquina, o problema é seu. Caso contrário, no máximo `tamanho' caracteres (em modo texto) ou `tamanho' bytes (em modo binário) são lidos e devolvidos. Se o fim do arquivo for atingido, @code{f.read()} devolve uma string vazia (@code{'@w{'}}).

@example
>>> f.read()
'Este é o arquivo inteiro.\n'
>>> f.read()
'@w{'}
@end example

O método @code{f.readline()} lê uma única linha do arquivo; o caractere de quebra de linha (@code{\n}) é mantido ao final da string, e só é omitido na última linha do arquivo, se o arquivo não terminar com uma quebra de linha. Isso elimina a ambiguidade do valor retornado; se @code{f.readline()} retorna uma string vazia, o fim do arquivo foi atingido. Linhas em branco são representadas por um @code{'\n'} – uma string contendo apenas o caractere terminador de linha.

@example
>>> f.readline()
'Está é a primeira linha do arquivo.\n'
>>> f.readline()
'Segunda linha do arquivo\n'
>>> f.readline()
'@w{'}
@end example

Uma maneira alternativa de ler linhas do arquivo é iterar diretamente pelo objeto arquivo. É eficiente, rápido e resulta em código mais simples:

@example
>>> for line in f:
...     print(line, end='@w{'})
...
Esta é a primeira linha do arquivo.
Segunda linha do arquivo
@end example

Se desejar ler todas as linhas de um arquivo em uma lista, pode-se usar @code{list(f)} ou @code{f.readlines()}.

@code{f.write(string)} escreve o conteúdo de `string' para o arquivo, retornando o número de caracteres escritos.

@example
>>> f.write('Este é um teste\n')
15
@end example

Outros tipos de objetos precisam ser convertidos – seja para uma string (em modo texto) ou para bytes (em modo binário) – antes de escrevê-los:

@example
>>> value = ('a resposta', 42)
>>> s = str(value)  # converte a tupla para string
>>> f.write(s)
18
@end example

@code{f.tell()} retorna um inteiro dando a posição atual do objeto arquivo, no arquivo representado, como número de bytes desde o início do arquivo, no modo binário, e um número ininteligível, quando no modo de texto.

Para mudar a posição, use @code{f.seek(offset, de_onde)}. A nova posição é computada pela soma do deslocamento `offset' a um ponto de referência especificado pelo argumento `de-onde'. Se o valor de `de_onde' é 0,a referência é o início do arquivo, 1 refere-se à posição atual, e 2 refere-se ao fim do arquivo. Este argumento pode ser omitido e o valor padrão é 0, usando o início do arquivo como referência.

@example
>>> f = open('arquivo_de_trabalho', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # Vai até o 6º byte no arquivo
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # Vai até o 3º byte antes do fim
13
>>> f.read(1)
b'd'
@end example

Em arquivos texto (abertos sem um @code{b}, em modo string), somente `seeks' relativos ao início do arquivo serão permitidos (exceto se for indicado o final do arquivo, com @code{seek(0, 2)}) e o único valor válido para `offset' são aqueles retornados por chamada à @code{f.tell()}, ou zero. Qualquer outro valor para `offset' produz um comportamento indefinido.

Objetos arquivo tem alguns métodos adicionais, como @ref{1e09,,isatty()} e @ref{1355,,truncate()} que não são usados com frequência; consulte a Biblioteca de Referência para um guia completo de objetos arquivo.

@node Gravando dados estruturados com json,,Métodos de objetos arquivo,Leitura e escrita de arquivos
@anchor{tutorial/inputoutput saving-structured-data-with-json}@anchor{1e0a}@anchor{tutorial/inputoutput tut-json}@anchor{1e0b}
@subsubsection Gravando dados estruturados com @code{json}


@geindex módulo;json

Strings podem ser facilmente gravadas e lidas em um arquivo. Números dão um pouco mais de trabalho, já que o método @ref{1e0c,,read()} só retorna strings, que terão que ser passadas para uma função como @ref{257,,int()}, que pega uma string como @code{'123'} e retorna seu valor numérico 123. Quando você deseja salvar tipos de dados mais complexos, como listas e dicionários aninhados, a análise e serialização manual tornam-se complicadas.

Ao invés de ter usuários constantemente escrevendo e depurando código para gravar tipos complicados de dados em arquivos, o Python permite que se use o popular formato de troca de dados chamado JSON (JavaScript Object Notation)@footnote{https://json.org}. O módulo padrão chamado @ref{82,,json} pode pegar hierarquias de dados em Python e convertê-las em representações de strings; esse processo é chamado `serialização'. Reconstruir os dados estruturados da representação string é chamado `desserialização'. Entre serializar e desserializar, a string que representa o objeto pode ser armazenada em um arquivo, ou estrutura de dados, ou enviada por uma conexão de rede para alguma outra máquina.

@cartouche
@quotation Nota 
O formato JSON é comumente usado por aplicativos modernos para permitir troca de dados. Pessoas que programam já estão familiarizadas com esse formato, o que o torna uma boa opção para interoperabilidade.
@end quotation
@end cartouche

Um objeto @code{x}, pode ser visualizado na sua representação JSON com uma simples linha de código:

@example
>>> import json
>>> x = [1, 'lista', 'simples']
>>> json.dumps(x)
'[1, "lista", "simples"]'
@end example

Outra variação da função @ref{d68,,dumps()}, chamada @ref{d67,,dump()}, serializa o objeto para um @ref{1e0d,,arquivo texto}. Se @code{f} é um @ref{1e0d,,arquivo texto} aberto para escrita, podemos fazer isto:

@example
json.dump(x, f)
@end example

Para decodificar o objeto novamente, se @code{f} é um objeto @ref{1e0e,,arquivo binário} ou @ref{1e0d,,arquivo texto} que foi aberto para leitura:

@example
x = json.load(f)
@end example

@cartouche
@quotation Nota 
Arquivos JSON devem ser codificados em UTF-8. Use @code{encoding="utf-8"} quando abrir um arquivo JSON como um @ref{1e0d,,arquivo texto} tanto para leitura quanto para escrita.
@end quotation
@end cartouche

Essa técnica de serialização simples pode manipular listas e dicionários, mas a serialização de instâncias de classes arbitrárias no JSON requer um pouco mais de esforço. A referência para o módulo @ref{82,,json} contém uma explicação disso.


@subsubheading Ver também


O módulo @ref{a6,,pickle}

Ao contrário do @ref{1e0b,,JSON}, `pickle' é um protocolo que permite a serialização de objetos Python arbitrariamente complexos. Por isso, é específico do Python e não pode ser usado para se comunicar com aplicativos escritos em outros linguagens. Também é inseguro por padrão: desserializar dados de pickle, provenientes de uma fonte não confiável, pode executar código arbitrário, se os dados foram criados por um invasor habilidoso.


@node Erros e exceções,Classes,Entrada e Saída,O tutorial do Python
@anchor{tutorial/errors doc}@anchor{1e0f}@anchor{tutorial/errors errors-and-exceptions}@anchor{1e10}@anchor{tutorial/errors translation-repo}@anchor{1e11}@anchor{tutorial/errors tut-errors}@anchor{1e12}
@section Erros e exceções


Até agora mensagens de erro foram apenas mencionadas, mas se você testou os exemplos, talvez tenha esbarrado em algumas. Existem pelo menos dois tipos distintos de erros: `erros de sintaxe' e `exceções'.

@menu
* Erros de sintaxe:: 
* Exceções:: 
* Tratamento de exceções:: 
* Levantando exceções:: 
* Encadeamento de exceções:: 
* Exceções definidas pelo usuário:: 
* Definindo ações de limpeza:: 
* Ações de limpeza predefinidas:: 
* Criando e tratando várias exceções não relacionadas:: 
* Enriquecendo exceções com notas:: 

@end menu

@node Erros de sintaxe,Exceções,,Erros e exceções
@anchor{tutorial/errors syntax-errors}@anchor{1e13}@anchor{tutorial/errors tut-syntaxerrors}@anchor{1e14}
@subsection Erros de sintaxe


Erros de sintaxe, também conhecidos como erros de parse, são provavelmente os mais frequentes entre aqueles que ainda estão aprendendo Python:

@example
>>> while True print('Olá mundo')
  File "<stdin>", line 1
    while True print('Olá mundo')
               ^^^^^
SyntaxError: invalid syntax
@end example

O analisador sintático repete a linha ofensiva e exibe pequenas setas apontando para o local onde o erro foi detectado. Note que esse nem sempre é o local que precisa ser corrigido. No exemplo, o erro é detectado na função @ref{fa9,,print()}, já que dois pontos (@code{':'}) estão faltando logo antes dele.

O nome do arquivo (@code{<stdin>} no nosso exemplo) e o número da linha são impressos para que você saiba onde procurar caso a entrada tenha vindo de um arquivo.

@node Exceções,Tratamento de exceções,Erros de sintaxe,Erros e exceções
@anchor{tutorial/errors exceptions}@anchor{1e15}@anchor{tutorial/errors tut-exceptions}@anchor{1e16}
@subsection Exceções


Mesmo que um comando ou expressão estejam sintaticamente corretos, talvez ocorra um erro na hora de sua execução. Erros detectados durante a execução são chamados `exceções' e não são necessariamente fatais: logo veremos como tratá-las em programas Python. A maioria das exceções não são tratadas pelos programas e acabam resultando em mensagens de erro:

@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

A última linha da mensagem de erro indica o que aconteceu. Exceções surgem com diferentes tipos, e o tipo é exibido como parte da mensagem: os tipos no exemplo são @ref{94c,,ZeroDivisionError}, @ref{43f,,NameError} e @ref{2c3,,TypeError}. A string exibida como sendo o tipo da exceção é o nome da exceção embutida que ocorreu. Isso é verdade para todas exceções pré-definidas em Python, mas não é necessariamente verdade para exceções definidas pelo usuário (embora seja uma convenção útil). Os nomes das exceções padrões são identificadores embutidos (não palavras reservadas).

O resto da linha é um detalhamento que depende do tipo da exceção ocorrida e sua causa.

A parte anterior da mensagem de erro apresenta o contexto onde ocorreu a exceção. Essa informação é denominada `stack traceback' (situação da pilha de execução). Em geral, contém uma lista de linhas do código-fonte, sem apresentar, no entanto, linhas lidas da entrada padrão.

@ref{19b1,,Exceções embutidas} lista as exceções pré-definidas e seus significados.

@node Tratamento de exceções,Levantando exceções,Exceções,Erros e exceções
@anchor{tutorial/errors handling-exceptions}@anchor{1e17}@anchor{tutorial/errors tut-handling}@anchor{1d96}
@subsection Tratamento de exceções


É possível escrever programas que tratam exceções específicas. Observe o exemplo seguinte, que pede dados ao usuário até que um inteiro válido seja fornecido, ainda permitindo que o programa seja interrompido (utilizando @code{Control}-@code{C} ou seja lá o que for que o sistema operacional suporte); note que uma interrupção gerada pelo usuário será sinalizada pela exceção @ref{9d9,,KeyboardInterrupt}.

@example
>>> while True:
...     try:
...         x = int(input("Insira um número: "))
...         break
...     except ValueError:
...         print("Ops! Esse não é um número válido. Tente novamente...")
...
@end example

A instrução @ref{6e9,,try} funciona da seguinte maneira:


@itemize *

@item 
Primeiramente, a `cláusula try' (o conjunto de instruções entre as palavras reservadas @ref{6e9,,try} e @ref{18b,,except} ) é executada.

@item 
Se nenhuma exceção ocorrer, a `cláusula except' é ignorada e a execução da instrução @ref{6e9,,try} é finalizada.

@item 
Se ocorrer uma exceção durante a execução de uma cláusula @ref{6e9,,try}, as instruções remanescentes na cláusula são ignoradas. Se o tipo da exceção ocorrida tiver sido previsto em algum @ref{18b,,except}, essa `cláusula except' é executada, e então depois a execução continua após o bloco try/except.

@item 
Se a exceção levantada não corresponder a nenhuma exceção listada na `cláusula de exceção', então ela é entregue a uma instrução @ref{6e9,,try} mais externa. Se não existir nenhum tratador previsto para tal exceção, trata-se de uma `exceção não tratada' e a execução do programa termina com uma mensagem de erro.
@end itemize

A instrução @ref{6e9,,try} pode ter uma ou mais `cláusula de exceção', para especificar múltiplos tratadores para diferentes exceções. No máximo um único tratador será executado. Tratadores só são sensíveis às exceções levantadas no interior da `cláusula de tentativa', e não às que tenham ocorrido no interior de outro tratador numa mesma instrução @code{try}. Uma `cláusula de exceção' pode ser sensível a múltiplas exceções, desde que as especifique em uma tupla, por exemplo:

@example
... except (RuntimeError, TypeError, NameError):
...     pass
@end example

Uma classe em uma cláusula @ref{18b,,except} corresponde a exceções que são instâncias da própria classe ou de uma de suas classes derivadas (mas o contrário não é válido — uma `cláusula except' listando uma classe derivada não corresponde a instâncias de suas classes base). Por exemplo, o seguinte código irá mostrar B, C, D nessa ordem:

@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

Se a ordem das `cláusulas de exceção' fosse invertida (@code{except B} no início), seria exibido B, B, B — somente a primeira `cláusula de exceção' compatível é ativada.

Quando uma exceção ocorre, ela pode estar associada a valores chamados `argumentos' da exceção. A presença e os tipos dos argumentos dependem do tipo da exceção.

A `cláusula except' pode especificar uma variável após o nome da exceção. A variável está vinculada à instância de exceção que normalmente possui um atributo @code{args} que armazena os argumentos. Por conveniência, os tipos de exceção embutidos definem @ref{61d,,__str__()} para exibir todos os argumentos sem acessar explicitamente @code{.args}.

@example
>>> try:
...     raise Exception('spam', 'ovos')
... except Exception as inst:
...     print(type(inst))    # o tipo da exceção
...     print(inst.args)     # argumentos armazenados em .args
...     print(inst)          # __str__ permite imprimir args diretamente,
...                          # mas pode ser substituído em subclasses de exceção
...     x, y = inst.args     # desempacota args
...     print('x =', x)
...     print('y =', y)
...
<class 'Exception'>
('spam', 'ovos')
('spam', 'ovos')
x = spam
y = ovos
@end example

A saída @ref{61d,,__str__()} da exceção é exibida como a última parte (“detalhe”) da mensagem para exceções não tratadas.

@ref{5bb,,BaseException} é a classe base comum de todas as exceções. Uma de suas subclasses, @ref{9e2,,Exception}, é a classe base de todas as exceções não fatais. Exceções que não são subclasses de @ref{9e2,,Exception} normalmente não são tratadas, pois são usadas para indicar que o programa deve terminar. Elas incluem @ref{d63,,SystemExit} que é levantada por @ref{138e,,sys.exit()} e @ref{9d9,,KeyboardInterrupt} que é levantada quando um usuário deseja interromper o programa.

@ref{9e2,,Exception} pode ser usada como um curinga que captura (quase) tudo. No entanto, é uma boa prática ser o mais específico possível com os tipos de exceções que pretendemos manipular e permitir que quaisquer exceções inesperadas se propaguem.

O padrão mais comum para lidar com @ref{9e2,,Exception} é imprimir ou registrar a exceção e então levantá-la novamente (permitindo que um chamador lide com a exceção também):

@example
import sys

try:
    f = open('meuarquivo.txt')
    s = f.readline()
    i = int(s.strip())
except OSError as err:
    print("Erro de E/S:", err)
except ValueError:
    print("Não foi possível converter dados para um inteiro.")
except Exception as err:
    print(f"Não esperava @{err=@}, @{type(err)=@}")
    raise
@end example

A construção @ref{6e9,,try} … @ref{18b,,except} possui uma `cláusula else' opcional, que quando presente, deve ser colocada depois de todas as outras cláusulas. É útil para um código que precisa ser executado se nenhuma exceção foi levantada. Por exemplo:

@example
for arg in sys.argv[1:]:
    try:
        f = open(arg, 'r')
    except OSError:
        print('não foi possível abrir', arg)
    else:
        print(arg, 'tem', len(f.readlines()), 'linhas')
        f.close()
@end example

É melhor usar a cláusula @code{else} do que adicionar código adicional à cláusula @ref{6e9,,try} porque ela evita que acidentalmente seja tratada uma exceção que não foi levantada pelo código protegido pela construção com as instruções @code{try} … @code{except}.

Os manipuladores de exceção não tratam apenas exceções que ocorrem imediatamente na `cláusula try', mas também aquelas que ocorrem dentro de funções que são chamadas (mesmo indiretamente) na `cláusula try'. Por exemplo:

@example
>>> def this_fails():
...     x = 1/0
...
>>> try:
...     isso_aqui_falha()
... except ZeroDivisionError as err:
...     print('Tratando o erro de tempo execução:', err)
...
Tratando o erro de tempo execução: division by zero
@end example

@node Levantando exceções,Encadeamento de exceções,Tratamento de exceções,Erros e exceções
@anchor{tutorial/errors raising-exceptions}@anchor{1e18}@anchor{tutorial/errors tut-raising}@anchor{1e19}
@subsection Levantando exceções


A instrução @ref{5ed,,raise} permite ao programador forçar a ocorrência de um determinado tipo de exceção. Por exemplo:

@example
>>> raise NameError('Olá')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    raise NameError('Olá')
NameError: Olá
@end example

O argumento de @ref{5ed,,raise} indica a exceção a ser levantada. Esse argumento deve ser uma instância de exceção ou uma classe de exceção (uma classe que deriva de @ref{5bb,,BaseException}, tal como @ref{9e2,,Exception} ou uma de suas subclasses). Se uma classe de exceção for passada, será implicitamente instanciada invocando o seu construtor sem argumentos:

@example
raise ValueError  # abreviação para 'raise ValueError()'
@end example

Caso você precise determinar se uma exceção foi levantada ou não, mas não quer manipular o erro, uma forma simples de instrução @ref{5ed,,raise} permite que você levante-a novamente:

@example
>>> try:
...     raise NameError('Olá')
... except NameError:
...     print('Uma exceção passou por aqui!')
...     raise
...
Uma exceção passou por aqui!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise NameError('Olá')
NameError: Olá
@end example

@node Encadeamento de exceções,Exceções definidas pelo usuário,Levantando exceções,Erros e exceções
@anchor{tutorial/errors exception-chaining}@anchor{1e1a}@anchor{tutorial/errors tut-exception-chaining}@anchor{1e1b}
@subsection Encadeamento de exceções


Se uma exceção não tratada ocorrer dentro de uma seção @ref{18b,,except}, ela terá a exceção sendo tratada anexada a ela e incluída na mensagem de erro:

@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 uma exceção é uma consequência direta de outra, a instrução @ref{5ed,,raise} permite uma cláusula opcional @ref{5ed,,from}:

@example
# exc deve ser uma instância de exceção ou None.
raise RuntimeError from exc
@end example

Isso pode ser útil quando você está transformando exceções. Por exemplo:

@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

Ele também permite desabilitar o encadeamento automático de exceções usando o idioma @code{from None}:

@example
>>> try:
...     open('bancodedados.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 mais informações sobre os mecanismos de encadeamento, veja @ref{19b1,,Exceções embutidas}.

@node Exceções definidas pelo usuário,Definindo ações de limpeza,Encadeamento de exceções,Erros e exceções
@anchor{tutorial/errors tut-userexceptions}@anchor{1e1c}@anchor{tutorial/errors user-defined-exceptions}@anchor{1e1d}
@subsection Exceções definidas pelo usuário


Programas podem definir novos tipos de exceções, através da criação de uma nova classe (veja @ref{1d9f,,Classes} para mais informações sobre classes Python). Exceções devem ser derivadas da classe @ref{9e2,,Exception}, direta ou indiretamente.

As classes de exceção podem ser definidas para fazer qualquer coisa que qualquer outra classe pode fazer, mas geralmente são mantidas simples, geralmente oferecendo apenas um número de atributos que permitem que informações sobre o erro sejam extraídas por manipuladores para a exceção.

É comum que novas exceções sejam definidas com nomes terminando em “Error”, semelhante a muitas exceções embutidas.

Muitos módulos padrão definem suas próprias exceções para relatar erros que podem ocorrer nas funções que definem.

@node Definindo ações de limpeza,Ações de limpeza predefinidas,Exceções definidas pelo usuário,Erros e exceções
@anchor{tutorial/errors defining-clean-up-actions}@anchor{1e1e}@anchor{tutorial/errors tut-cleanup}@anchor{1e1f}
@subsection Definindo ações de limpeza


A instrução @ref{6e9,,try} possui outra cláusula opcional, cuja finalidade é permitir a implementação de ações de limpeza, que sempre devem ser executadas independentemente da ocorrência de exceções. Como no exemplo:

@example
>>> try:
...     raise KeyboardInterrupt
... finally:
...     print('Adeus, mundo!')
...
Adeus, mundo!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise KeyboardInterrupt
KeyboardInterrupt
@end example

Se uma cláusula @ref{9d2,,finally} estiver presente, a cláusula @code{finally} será executada como a última tarefa antes da conclusão da instrução @ref{6e9,,try}. A cláusula @code{finally} executa se a instrução @code{try} produz uma exceção. Os pontos a seguir discutem casos mais complexos quando ocorre uma exceção:


@itemize *

@item 
Se ocorrer uma exceção durante a execução da cláusula @code{try}, a exceção poderá ser tratada por uma cláusula @ref{18b,,except}. Se a exceção não for tratada por uma cláusula @code{except}, a exceção será gerada novamente após a execução da cláusula @code{finally}.

@item 
Uma exceção pode ocorrer durante a execução de uma cláusula @code{except} ou @code{else}. Novamente, a exceção é re-levantada depois que @code{finally} é executada.

@item 
Se a cláusula @code{finally} executa uma instrução @ref{ab8,,break}, @ref{9d1,,continue} ou @ref{9d6,,return}, as exceções não são levantadas novamente.

@item 
Se a instrução @code{try} atingir uma instrução @ref{ab8,,break}, @ref{9d1,,continue} ou @ref{9d6,,return}, a cláusula @code{finally} será executada imediatamente antes da execução da instrução @code{break}, @code{continue} ou @code{return}.

@item 
Se uma cláusula @code{finally} incluir uma instrução @code{return}, o valor retornado será aquele da instrução @code{return} da cláusula @code{finally}, não o valor da instrução @code{return} da cláusula @code{try}.
@end itemize

Por exemplo:

@example
>>> def retorna_booleano():
...     try:
...         return True
...     finally:
...         return False
...
>>> retorna_booleano()
False
@end example

Um exemplo mais 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 você pode ver, a cláusula @ref{9d2,,finally} é executada em todos os casos. A exceção @ref{2c3,,TypeError} levantada pela divisão de duas strings não é tratada pela cláusula @ref{18b,,except} e portanto é re-levantada depois que a cláusula @code{finally} é executada.

Em aplicação do mundo real, a cláusula @ref{9d2,,finally} é útil para liberar recursos externos (como arquivos ou conexões de rede), independentemente do uso do recurso ter sido bem sucedido ou não.

@node Ações de limpeza predefinidas,Criando e tratando várias exceções não relacionadas,Definindo ações de limpeza,Erros e exceções
@anchor{tutorial/errors predefined-clean-up-actions}@anchor{1e20}@anchor{tutorial/errors tut-cleanup-with}@anchor{1e21}
@subsection Ações de limpeza predefinidas


Alguns objetos definem ações de limpeza padrões para serem executadas quando o objeto não é mais necessário, independentemente da operação que estava usando o objeto ter sido ou não bem sucedida. Veja o exemplo a seguir, que tenta abrir um arquivo e exibir seu conteúdo na tela.

@example
for linha in open("meuarquivo.txt"):
    print(linha, end="")
@end example

O problema com esse código é que ele deixa o arquivo aberto um período indeterminado depois que o código é executado. Isso não chega a ser problema em scripts simples, mas pode ser um problema para grandes aplicações. A palavra reservada @ref{5d2,,with} permite que objetos como arquivos sejam utilizados com a certeza de que sempre serão prontamente e corretamente finalizados.

@example
with open("meuarquivo.txt") as f:
    for linha in f:
        print(linha, end="")
@end example

Depois que a instrução é executada, o arquivo `f' é sempre fechado, mesmo se ocorrer um problema durante o processamento das linhas. Outros objetos que, como arquivos, fornecem ações de limpeza predefinidas as indicarão em suas documentações.

@node Criando e tratando várias exceções não relacionadas,Enriquecendo exceções com notas,Ações de limpeza predefinidas,Erros e exceções
@anchor{tutorial/errors raising-and-handling-multiple-unrelated-exceptions}@anchor{1e22}@anchor{tutorial/errors tut-exception-groups}@anchor{1e23}
@subsection Criando e tratando várias exceções não relacionadas


Existem situações em que é necessário relatar várias exceções que ocorreram. Isso geralmente ocorre em estruturas de simultaneidade, quando várias tarefas podem ter falhado em paralelo, mas também há outros casos de uso em que é desejável continuar a execução e coletar vários erros em vez de levantar a primeira exceção.

O @ref{1b6,,ExceptionGroup} integrado envolve uma lista de instâncias de exceção para que elas possam ser levantadas juntas. É uma exceção em si, portanto, pode ser capturada como qualquer outra exceção.

@example
>>> def f():
...     excs = [OSError('error 1'), SystemError('error 2')]
...     raise ExceptionGroup('houve problemas', excs)
...
>>> f()
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     f()
  |     ~^^
  |   File "<stdin>", line 3, in f
  | ExceptionGroup: houve problemas (2 sub-exceptions)
  +-+---------------- 1 ----------------
    | OSError: error 1
    +---------------- 2 ----------------
    | SystemError: error 2
    +------------------------------------
>>> try:
...     f()
... except Exception as e:
...     print(f'capturada @{type(e)@}: e')
...
capturada <class 'ExceptionGroup'>: e
>>>
@end example

Usando @code{except*} em vez de @code{except}, podemos manipular seletivamente apenas as exceções no grupo que correspondem a um determinado tipo. No exemplo a seguir, que mostra um grupo de exceção aninhado, cada cláusula @code{except*} extrai do grupo exceções de um certo tipo enquanto permite que todas as outras exceções se propaguem para outras cláusulas e eventualmente sejam levantadas novamente.

@example
>>> def f():
...     raise ExceptionGroup(
...         "group1",
...         [
...             OSError(1),
...             SystemError(2),
...             ExceptionGroup(
...                 "group2",
...                 [
...                     OSError(3),
...                     RecursionError(4)
...                 ]
...             )
...         ]
...     )
...
>>> try:
...     f()
... except* OSError as e:
...     print("Houve OSErrors")
... except* SystemError as e:
...     print("Houve SystemErrors")
...
Houve OSErrors
Houve 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 ----------------
    | ExceptionGroup: group2
    +-+---------------- 1 ----------------
      | RecursionError: 4
      +------------------------------------
>>>
@end example

Observe que as exceções aninhadas em um grupo de exceções devem ser instâncias, não tipos. Isso ocorre porque, na prática, as exceções normalmente seriam aquelas que já foram levantadas e capturadas pelo programa, seguindo o seguinte padrão:

@example
>>> excs = []
... for test in tests:
...     try:
...         test.run()
...     except Exception as e:
...         excs.append(e)
...
>>> if excs:
...    raise ExceptionGroup("Falhas no teste", excs)
...
@end example

@node Enriquecendo exceções com notas,,Criando e tratando várias exceções não relacionadas,Erros e exceções
@anchor{tutorial/errors enriching-exceptions-with-notes}@anchor{1e24}@anchor{tutorial/errors tut-exception-notes}@anchor{1e25}
@subsection Enriquecendo exceções com notas


Quando uma exceção é criada para ser levantada, geralmente é inicializada com informações que descrevem o erro ocorrido. Há casos em que é útil adicionar informações após a captura da exceção. Para este propósito, as exceções possuem um método @code{add_note(note)} que aceita uma string e a adiciona à lista de notas da exceção. A renderização de traceback padrão inclui todas as notas, na ordem em que foram adicionadas, após a exceção.

@example
>>> try:
...     raise TypeError('tipo inválido')
... except Exception as e:
...     e.add_note('Adiciona algumas informações')
...     e.add_note('Adiciona mais algumas informações')
...     raise
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise TypeError('tipo inválido')
TypeError: tipo inválido
Adiciona algumas informações
Adiciona mais algumas informações
>>>
@end example

Por exemplo, ao coletar exceções em um grupo de exceções, podemos querer adicionar informações de contexto para os erros individuais. A seguir, cada exceção no grupo tem uma nota indicando quando esse erro ocorreu.

@example
>>> def f():
...     raise OSError('operação falhou')
...
>>> excs = []
>>> for i in range(3):
...     try:
...         f()
...     except Exception as e:
...         e.add_note(f'Aconteceu na iteração @{i+1@}')
...         excs.append(e)
...
>>> raise ExceptionGroup('Nós temos alguns problemas', excs)
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     raise ExceptionGroup('Nós temos alguns problemas', excs)
  | ExceptionGroup: Nós temos alguns problemas (3 sub-exceptions)
  +-+---------------- 1 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operação falhou')
    | OSError: operação falhou
    | Aconteceu na iteração 1
    +---------------- 2 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operação falhou')
    | OSError: operação falhou
    | Aconteceu na iteração 2
    +---------------- 3 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operação falhou')
    | OSError: operação falhou
    | Aconteceu na iteração 3
    +------------------------------------
>>>
@end example

@node Classes,Um breve passeio pela biblioteca padrão,Erros e exceções,O tutorial do Python
@anchor{tutorial/classes doc}@anchor{1e26}@anchor{tutorial/classes classes}@anchor{1e27}@anchor{tutorial/classes translation-repo}@anchor{1e28}@anchor{tutorial/classes tut-classes}@anchor{1d9f}
@section Classes


Classes proporcionam uma forma de organizar dados e funcionalidades juntos. Criar uma nova classe cria um novo “tipo” de objeto, permitindo que novas “instâncias” desse tipo sejam produzidas. Cada instância da classe pode ter atributos anexados a ela, para manter seu estado. Instâncias da classe também podem ter métodos (definidos pela classe) para modificar seu estado.

Em comparação com outras linguagens de programação, o mecanismo de classes de Python introduz a programação orientada a objetos sem acrescentar muitas novidades de sintaxe ou semântica. É uma mistura de mecanismos equivalentes encontrados em C++ e Modula-3. As classes em Python oferecem todas as características tradicionais da programação orientada a objetos: o mecanismo de herança permite múltiplas classes base (herança múltipla), uma classe derivada pode sobrescrever quaisquer métodos de uma classe ancestral, e um método pode invocar outro método homônimo de uma classe ancestral. Objetos podem armazenar uma quantidade arbitrária de dados de qualquer tipo. Assim como acontece com os módulos, as classes fazem parte da natureza dinâmica de Python: são criadas em tempo de execução, e podem ser alteradas após sua criação.

Usando a terminologia de C++, todos os membros de uma classe (incluindo dados) são `públicos' (veja exceção abaixo @ref{1e29,,Variáveis privadas}), e todos as funções membro são `virtuais'. Como em Modula-3, não existem atalhos para referenciar membros do objeto de dentro dos seus métodos: o método (função definida em uma classe) é declarado com um primeiro argumento explícito representando o objeto (instância da classe), que é fornecido implicitamente pela chamada ao método. Como em Smalltalk, classes são objetos. Isso fornece uma semântica para importar e renomear. Ao contrário de C++ ou Modula-3, tipos pré-definidos podem ser utilizados como classes base para extensões por herança pelo usuário. Também, como em C++, a maioria dos operadores (aritméticos, indexação, etc) podem ser redefinidos por instâncias de classe.

(Na falta de uma terminologia universalmente aceita para falar sobre classes, ocasionalmente farei uso de termos comuns em Smalltalk ou C++. Eu usaria termos de Modula-3, já que sua semântica de orientação a objetos é mais próxima da de Python, mas creio que poucos leitores já ouviram falar dessa linguagem.)

@menu
* Uma palavra sobre nomes e objetos:: 
* Escopos e espaços de nomes do Python:: 
* Uma primeira olhada nas classes:: 
* Observações aleatórias:: 
* Herança:: 
* Variáveis privadas:: 
* Curiosidades e conclusões:: 
* Iteradores:: 
* Geradores:: 
* Expressões geradoras:: 

@end menu

@node Uma palavra sobre nomes e objetos,Escopos e espaços de nomes do Python,,Classes
@anchor{tutorial/classes a-word-about-names-and-objects}@anchor{1e2a}@anchor{tutorial/classes tut-object}@anchor{1e2b}
@subsection Uma palavra sobre nomes e objetos


Objetos têm individualidade, e vários nomes (em diferentes escopos) podem ser vinculados a um mesmo objeto. Isso é chamado de apelidamento em outras linguagens. Geralmente, esta característica não é muito apreciada, e pode ser ignorada com segurança ao lidar com tipos imutáveis (números, strings, tuplas). Entretanto, apelidamento pode ter um efeito surpreendente na semântica do código Python envolvendo objetos mutáveis como listas, dicionários e a maioria dos outros tipos. Isso pode ser usado em benefício do programa, porque os apelidos funcionam de certa forma como ponteiros. Por exemplo, passar um objeto como argumento é barato, pois só um ponteiro é passado na implementação; e se uma função modifica um objeto passado como argumento, o invocador verá a mudança — isso elimina a necessidade de ter dois mecanismos de passagem de parâmetros como em Pascal.

@node Escopos e espaços de nomes do Python,Uma primeira olhada nas classes,Uma palavra sobre nomes e objetos,Classes
@anchor{tutorial/classes python-scopes-and-namespaces}@anchor{1e2c}@anchor{tutorial/classes tut-scopes}@anchor{1dde}
@subsection Escopos e espaços de nomes do Python


Antes de introduzir classes, é preciso falar das regras de escopo em Python. Definições de classe fazem alguns truques com espaços de nomes. Portanto, primeiro é preciso entender claramente como escopos e espaços de nomes funcionam, para entender o que está acontecendo. Esse conhecimento é muito útil para qualquer programador Python avançado.

Vamos começar com algumas definições.

Um `espaço de nomes' é um mapeamento que associa nomes a objetos. Atualmente, são implementados como dicionários em Python, mas isso não é perceptível (a não ser pelo desempenho), e pode mudar no futuro. Exemplos de espaços de nomes são: o conjunto de nomes pré-definidos (funções como @ref{1e2d,,abs()} e as exceções pré-definidas); nomes globais em um módulo; e nomes locais na invocação de uma função. De certa forma, os atributos de um objeto também formam um espaço de nomes. O mais importante é saber que não existe nenhuma relação entre nomes em espaços de nomes distintos. Por exemplo, dois módulos podem definir uma função de nome @code{maximize} sem confusão — usuários dos módulos devem prefixar a função com o nome do módulo, para evitar colisão.

A propósito, utilizo a palavra `atributo' para qualquer nome depois de um ponto. Na expressão @code{z.real}, por exemplo, @code{real} é um atributo do objeto @code{z}. Estritamente falando, referências para nomes em módulos são atributos: na expressão @code{modname.funcname}, @code{modname} é um objeto módulo e @code{funcname} é um de seus atributos. Neste caso, existe um mapeamento direto entre os atributos de um módulo e os nomes globais definidos no módulo: eles compartilham o mesmo espaço de nomes! @footnote{
Exceto por uma coisa. Os objetos módulo têm um atributo secreto e somente para leitura chamado @ref{55b,,__dict__} que retorna o dicionário usado para implementar o espaço de nomes do módulo; o nome @code{__dict__} é um atributo, mas não um nome global. Obviamente, usar isso viola a abstração da implementação do espaço de nomes, e deve ser restrito a coisas como depuradores post-mortem.
}

Atributos podem ser somente leitura ou para leitura e escrita. No segundo caso, é possível atribuir um novo valor ao atributo. Atributos de módulos são passíveis de atribuição: você pode escrever @code{modname.the_answer = 42}. Atributos que aceitam escrita também podem ser apagados através da instrução @ref{18a7,,del}. Por exemplo, @code{del modname.the_answer} removerá o atributo @code{the_answer} do objeto referenciado por @code{modname}.

Espaços de nomes são criados em momentos diferentes e possuem diferentes ciclos de vida. O espaço de nomes que contém os nomes embutidos é criado quando o interpretador inicializa e nunca é removido. O espaço de nomes global de um módulo é criado quando a definição do módulo é lida, e normalmente duram até a terminação do interpretador. Os comandos executados pela invocação do interpretador, pela leitura de um script com programa principal, ou interativamente, são parte do módulo chamado @ref{1,,__main__}, e portanto possuem seu próprio espaço de nomes. (Os nomes embutidos possuem seu próprio espaço de nomes no módulo chamado @ref{12,,builtins}.).

O espaço de nomes local de uma função é criado quando a função é invocada, e apagado quando a função retorna ou levanta uma exceção que não é tratada na própria função. (Na verdade, uma forma melhor de descrever o que realmente acontece é que o espaço de nomes local é “esquecido” quando a função termina.) Naturalmente, cada invocação recursiva de uma função tem seu próprio espaço de nomes.

Um `escopo' é uma região textual de um programa Python onde um espaço de nomes é diretamente acessível. Aqui, “diretamente acessível” significa que uma referência sem um prefixo qualificador permite o acesso ao nome.

Ainda que escopos sejam determinados estaticamente, eles são usados dinamicamente. A qualquer momento durante a execução, existem 3 ou 4 escopos aninhados cujos espaços de nomes são diretamente acessíveis:


@itemize *

@item 
o escopo mais interno, que é acessado primeiro, contem os nomes locais

@item 
os escopos das funções que envolvem a função atual, que são acessados a partir do escopo mais próximo, contêm nomes não-locais, mas também não-globais

@item 
o penúltimo escopo contém os nomes globais do módulo atual

@item 
e o escopo mais externo (acessado por último) contém os nomes das funções embutidas e demais objetos pré-definidos do interpretador
@end itemize

Se um nome é declarado no escopo global, então todas as referências e atribuições de valores vão diretamente para o penúltimo escopo, que contém os nomes globais do módulo. Para alterar variáveis declaradas fora do escopo mais interno, a instrução @ref{12ea,,nonlocal} pode ser usada; caso contrário, todas essas variáveis serão apenas para leitura (a tentativa de atribuir valores a essas variáveis simplesmente criará uma `nova' variável local, no escopo interno, não alterando nada na variável de nome idêntico fora dele).

Normalmente, o escopo local referencia os nomes locais da função corrente no texto do programa. Fora de funções, o escopo local referencia os nomes do escopo global: espaço de nomes do módulo. Definições de classes adicionam um outro espaço de nomes ao escopo local.

É importante perceber que escopos são determinados estaticamente, pelo texto do código-fonte: o escopo global de uma função definida em um módulo é o espaço de nomes deste módulo, sem importar de onde ou por qual apelido a função é invocada. Por outro lado, a busca de nomes é dinâmica, ocorrendo durante a execução. Porém, a evolução da linguagem está caminhando para uma resolução de nomes estática, em “tempo de compilação”, portanto não conte com a resolução dinâmica de nomes! (De fato, variáveis locais já são resolvidas estaticamente.)

Uma peculiaridade especial do Python é que – se nenhuma instrução @ref{18a,,global} ou @ref{12ea,,nonlocal} estiver em vigor – as atribuições de nomes sempre entram no escopo mais interno. As atribuições não copiam dados — elas apenas vinculam nomes aos objetos. O mesmo vale para exclusões: a instrução @code{del x} remove a ligação de @code{x} do espaço de nomes referenciado pelo escopo local. De fato, todas as operações que introduzem novos nomes usam o escopo local: em particular, instruções @ref{5e2,,import} e definições de funções ligam o módulo ou o nome da função no escopo local.

A instrução @ref{18a,,global} pode ser usada para indicar que certas variáveis residem no escopo global ao invés do local; a instrução @ref{12ea,,nonlocal} indica que variáveis particulares estão em um espoco mais interno e devem ser recuperadas lá.

@menu
* Exemplo de escopos e espaço de nomes:: 

@end menu

@node Exemplo de escopos e espaço de nomes,,,Escopos e espaços de nomes do Python
@anchor{tutorial/classes scopes-and-namespaces-example}@anchor{1e2e}@anchor{tutorial/classes tut-scopeexample}@anchor{1e2f}
@subsubsection Exemplo de escopos e espaço de nomes


Este é um exemplo que demonstra como se referir aos diferentes escopos e aos espaços de nomes, e como @ref{18a,,global} e @ref{12ea,,nonlocal} pode afetar ligação entre as variáveis:

@example
def teste_de_escopo():
    def faz_local():
        spam = "spam local"

    def faz_nonlocal():
        nonlocal spam
        spam = "spam não-local"

    def faz_global():
        global spam
        spam = "spam global"

    spam = "spam teste"
    faz_local()
    print("Após atribuição local:", spam)
    faz_nonlocal()
    print("Após atribuição não-local:", spam)
    faz_global()
    print("Após atribuição global:", spam)

teste_de_escopo()
print("No escopo global:", spam)
@end example

A saída do código de exemplo é:

@example
Após atribuição local: spam teste
Após atribuição não-local: spam não-local
Após atribuição global: spam não-local
No escopo global: spam global
@end example

Observe como uma atribuição `local' (que é o padrão) não altera o vínculo de `teste_de_escopo' a `spam'. A instrução @ref{12ea,,nonlocal} mudou o vínculo de `teste_de_escopo' de `spam' e a atribuição @ref{18a,,global} alterou a ligação para o nível do módulo.

Você também pode ver que não havia nenhuma ligação anterior para `spam' antes da atribuição @ref{18a,,global}.

@node Uma primeira olhada nas classes,Observações aleatórias,Escopos e espaços de nomes do Python,Classes
@anchor{tutorial/classes a-first-look-at-classes}@anchor{1e30}@anchor{tutorial/classes tut-firstclasses}@anchor{1dba}
@subsection Uma primeira olhada nas classes


Classes introduzem novidades sintáticas, três novos tipos de objetos, e também alguma semântica nova.

@menu
* Sintaxe da definição de classe:: 
* Objetos classe:: 
* Objetos instância:: 
* Objetos método:: 
* Variáveis de classe e instância:: 

@end menu

@node Sintaxe da definição de classe,Objetos classe,,Uma primeira olhada nas classes
@anchor{tutorial/classes class-definition-syntax}@anchor{1e31}@anchor{tutorial/classes tut-classdefinition}@anchor{1e32}
@subsubsection Sintaxe da definição de classe


A forma mais simples de definir uma classe é:

@example
class NomeClasse:
    <instrução-1>
    .
    .
    .
    <instrução-N>
@end example

Definições de classe, assim como definições de função (instruções @ref{14a2,,def}), precisam ser executadas antes que tenham qualquer efeito. (Você pode colocar uma definição de classe dentro do teste condicional de um @ref{2f3,,if} ou dentro de uma função.)

Na prática, as instruções dentro da definição de classe geralmente serão definições de funções, mas outras instruções são permitidas, e às vezes são bem úteis — voltaremos a este tema depois. Definições de funções dentro da classe normalmente têm um forma peculiar de lista de argumentos, determinada pela convenção de chamada a métodos — isso também será explicado mais tarde.

Quando se inicia a definição de classe, um novo espaço de nomes é criado, e usado como escopo local — assim, todas atribuições a variáveis locais ocorrem nesse espaço de nomes. Em particular, funções definidas aqui são vinculadas a nomes nesse escopo.

Quando uma definição de classe é finalizada normalmente (até o fim), um `objeto classe' é criado. Este objeto encapsula o conteúdo do espaço de nomes criado pela definição da classe; aprenderemos mais sobre objetos classe na próxima seção. O escopo local (que estava vigente antes da definição da classe) é reativado, e o objeto classe é vinculado ao identificador da classe nesse escopo (@code{NomeClasse} no exemplo).

@node Objetos classe,Objetos instância,Sintaxe da definição de classe,Uma primeira olhada nas classes
@anchor{tutorial/classes class-objects}@anchor{1e33}@anchor{tutorial/classes tut-classobjects}@anchor{1e34}
@subsubsection Objetos classe


Objetos classe suportam dois tipos de operações: `referências a atributos' e `instanciação'.

`Referências a atributos' de classe utilizam a sintaxe padrão utilizada para quaisquer referências a atributos em Python: @code{obj.nome}. Nomes de atributos válidos são todos os nomes presentes dentro do espaço de nomes da classe, quando o objeto classe foi criado. Portanto, se a definição de classe tem esta forma:

@example
class MinhaClasse:
    """Um exemplo de classe simples"""
    i = 12345

    def f(self):
        return 'olá mundo'
@end example

então @code{MinhaClasse.i} e @code{MinhaClasse.f} são referências a atributo válidas, retornando, respectivamente, um inteiro e um objeto função. Atributos de classe podem receber valores, pode-se modificar o valor de @code{MinhaClasse.i} num atribuição. @ref{1e35,,__doc__} também é um atributo válido da classe, retornando a docstring associada à classe: @code{"Um exemplo de classe simples"}.

Para `instanciar' uma classe, usa-se a mesma sintaxe de invocar uma função. Apenas finja que o objeto classe do exemplo é uma função sem parâmetros, que devolve uma nova instância da classe. Por exemplo (presumindo a classe acima):

@example
x = MinhaClasse()
@end example

cria uma nova `instância' da classe e atribui o objeto resultante à variável local @code{x}.

A operação de instanciação (“invocar” um objeto classe) cria um objeto vazio. Muitas classes preferem criar novos objetos com um estado inicial predeterminado. Para tanto, a classe pode definir um método especial chamado @ref{6b0,,__init__()}, assim:

@example
def __init__(self):
    self.data = []
@end example

Quando uma classe define um método @ref{6b0,,__init__()}, o processo de instanciação automaticamente invoca @code{__init__()} sobre a instância recém criada. Em nosso exemplo, uma nova instância já inicializada pode ser obtida desta maneira:

@example
x = MinhaClasse()
@end example

Naturalmente, o método @ref{6b0,,__init__()} pode ter parâmetros para maior flexibilidade. Neste caso, os argumentos fornecidos na invocação da classe serão passados para o método @code{__init__()}. Por exemplo,

@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 instância,Objetos método,Objetos classe,Uma primeira olhada nas classes
@anchor{tutorial/classes instance-objects}@anchor{1e36}@anchor{tutorial/classes tut-instanceobjects}@anchor{1e37}
@subsubsection Objetos instância


Agora o que podemos fazer com objetos de instância? As únicas operações compreendidas por objetos de instância são os atributos de referência. Existem duas maneiras válidas para nomear atributos: atributos de dados e métodos.

Atributos de dados correspondem a “variáveis de instância” em Smalltalk, e a “membros de dados” em C++. Atributos de dados não precisam ser declarados. Assim como variáveis locais, eles passam a existir na primeira vez em que é feita uma atribuição. Por exemplo, se @code{x} é uma instância da @code{MinhaClasse} criada acima, o próximo trecho de código irá exibir o valor @code{16}, sem deixar nenhum rastro:

@example
x.contador = 1
while x.contador < 10:
    x.contador = x.contador * 2
print(x.contador)
del x.contador
@end example

O outro tipo de referência a um atributo de instância é um `método'. Um método é uma função que “pertence a” um objeto.

@geindex objeto;método

Nomes de métodos válidos de uma instância dependem de sua classe. Por definição, cada atributo de uma classe que é uma função corresponde a um método das instâncias. Em nosso exemplo, @code{x.f} é uma referência de método válida já que @code{MinhaClasse.f} é uma função, enquanto @code{x.i} não é, já que @code{MinhaClasse.i} não é uma função. Entretanto, @code{x.f} não é o mesmo que @code{MinhaClasse.f}. A referência @code{x.f} acessa um objeto método e a @code{MinhaClasse.f} acessa um objeto função.

@node Objetos método,Variáveis de classe e instância,Objetos instância,Uma primeira olhada nas classes
@anchor{tutorial/classes method-objects}@anchor{1e38}@anchor{tutorial/classes tut-methodobjects}@anchor{1e39}
@subsubsection Objetos método


Normalmente, um método é chamado imediatamente após ser referenciado:

@example
x.f()
@end example

Se @code{x = MinhaClasse()}, como acima, o resultado da expressão acima será a string @code{"olá mundo"}. No entanto, não é obrigatório invocar o método imediatamente: como @code{x.f} é também um objeto ele pode ser atribuído a uma variável e invocado depois. Por exemplo:

@example
xf = x.f
while True:
    print(xf())
@end example

exibirá o texto @code{olá mundo} até o mundo acabar.

O que ocorre precisamente quando um método é invocado? Você deve ter notado que @code{x.f()} foi chamado sem nenhum argumento, porém a definição da função @code{f()} especificava um argumento. O que aconteceu com esse argumento? Certamente Python levanta uma exceção quando uma função que declara um argumento é invocada sem nenhum argumento — mesmo que o argumento não seja usado no corpo da função…

Na verdade, pode-se supor a resposta: a particularidade sobre os métodos é que o objeto da instância é passado como o primeiro argumento da função. Em nosso exemplo, a chamada @code{x.f()} é exatamente equivalente a @code{MinhaClasse.f(x)}. Em geral, chamar um método com uma lista de `n' argumentos é equivalente a chamar a função correspondente com uma lista de argumentos que é criada inserindo o objeto de instância do método antes do primeiro argumento.

Em geral, os métodos funcionam da seguinte forma. Quando um atributo de uma instância, não relacionado a dados, é referenciado, a classe da instância é pesquisada. Se o nome é um atributo de classe válido que é um objeto função, referências ao objeto de instância e ao objeto função serão empacotadas em um objeto método. Quando o objeto método é chamado com uma lista de argumentos, uma nova lista de argumentos é construída a partir do objeto de instância e da lista de argumentos, e o objeto função é chamado com essa nova lista de argumentos.

@node Variáveis de classe e instância,,Objetos método,Uma primeira olhada nas classes
@anchor{tutorial/classes class-and-instance-variables}@anchor{1e3a}@anchor{tutorial/classes tut-class-and-instance-variables}@anchor{1e3b}
@subsubsection Variáveis de classe e instância


De forma geral, variáveis de instância são variáveis que indicam dados que são únicos a cada instância individual, e variáveis de classe são variáveis de atributos e de métodos que são comuns a todas as instâncias de uma classe:

@example
class Cachorro:

    tipo = 'canino'         # variável de classe compartilhada por todas as instâncias

    def __init__(self, nome):
        self.nome = nome    # variável de instância única para cada instância

>>> d = Cachorro('Fido')
>>> e = Cachorro('Buddy')
>>> d.tipo                  # compartilhada por todos os cachorros
'canino'
>>> e.tipo                  # compartilhada por todos os cachorros
'canino'
>>> d.nome                  # exclusiva do d
'Fido'
>>> e.nome                  # exclusiva do e
'Buddy'
@end example

Como vimos em @ref{1e2b,,Uma palavra sobre nomes e objetos}, dados compartilhados podem causar efeitos inesperados quando envolvem objetos (@ref{1d7e,,mutáveis}), como listas ou dicionários. Por exemplo, a lista `tricks' do código abaixo não deve ser usada como variável de classe, pois assim seria compartilhada por todas as instâncias de `Cachorro':

@example
class Cachorro:

    truques = []             # uso incorreto de uma variável de classe

    def __init__(self, nome):
        self.nome = nome

    def adicionar_truque(self, truque):
        self.truques.append(truque)

>>> d = Cachorro('Fido')
>>> e = Cachorro('Buddy')
>>> d.adicionar_truque('rolar')
>>> e.adicionar_truque('fingir de morto')
>>> d.truques                # inesperadamente compartilhado por todos os cães
['rolar', 'fingir de morto']
@end example

Em vez disso, o modelo correto da classe deve usar uma variável de instância:

@example
class Cachorro:

    def __init__(self, nome):
        self.nome = nome
        self.truques = []    # cria uma nova lista vazia para cada cachorro

    def adicionar_truque(self, truque):
        self.truques.append(truque)

>>> d = Cachorro('Fido')
>>> e = Cachorro('Buddy')
>>> d.adicionar_truque('rolar')
>>> e.adicionar_truque('fingir de morto')
>>> d.truques
['rolar']
>>> e.truques
['fingir de morto']
@end example

@node Observações aleatórias,Herança,Uma primeira olhada nas classes,Classes
@anchor{tutorial/classes random-remarks}@anchor{1e3c}@anchor{tutorial/classes tut-remarks}@anchor{1e3d}
@subsection Observações aleatórias


@c These should perhaps be placed more carefully...

Se um mesmo nome de atributo ocorre tanto na instância quanto na classe, a busca pelo atributo prioriza a instância:

@example
>>> class Armazém:
...    propósito = 'armazenar'
...    região = 'oeste'
...
>>> a1 = Armazém()
>>> print(a1.propósito, a1.região)
armazenar oeste
>>> a2 = Armazém()
>>> a2.região = 'leste'
>>> print(a2.propósito, a2.região)
armazenar leste
@end example

Atributos de dados podem ser referenciados por métodos da própria instância, bem como por qualquer outro usuário do objeto (também chamados “clientes” do objeto). Em outras palavras, classes não servem para implementar tipos puramente abstratos de dados. De fato, nada em Python torna possível assegurar o encapsulamento de dados — tudo é baseado em convenção. (Por outro lado, a implementação de Python, escrita em C, pode esconder completamente detalhes de um objeto e controlar o acesso ao objeto, se necessário; isto pode ser utilizado por extensões de Python escritas em C.)

Clientes devem utilizar atributos de dados com cuidado, pois podem bagunçar invariantes assumidas pelos métodos ao esbarrar em seus atributos de dados. Note que clientes podem adicionar atributos de dados a suas próprias instâncias, sem afetar a validade dos métodos, desde que seja evitado o conflito de nomes. Novamente, uma convenção de nomenclatura poupa muita dor de cabeça.

Não existe atalho para referenciar atributos de dados (ou outros métodos!) de dentro de um método. Isso aumenta a legibilidade dos métodos: não há como confundir variáveis locais com variáveis da instância quando lemos rapidamente um método.

Frequentemente, o primeiro argumento de um método é chamado @code{self}. Isso não passa de uma convenção: o identificador @code{self} não é uma palavra reservada nem possui qualquer significado especial em Python. Mas note que, ao seguir essa convenção, seu código se torna legível por uma grande comunidade de desenvolvedores Python e é possível que alguma `IDE' dependa dessa convenção para analisar seu código.

Qualquer objeto função que é atributo de uma classe, define um método para as instâncias dessa classe. Não é necessário que a definição da função esteja textualmente embutida na definição da classe. Atribuir um objeto função a uma variável local da classe é válido. Por exemplo:

@example
# Função definida fora da classe
def f1(self, x, y):
    return min(x, x+y)

class C:
    f = f1

    def g(self):
        return 'olá mundo'

    h = g
@end example

Agora @code{f}, @code{g} e @code{h} são todos atributos da classe @code{C} que referenciam funções, e consequentemente são todos métodos de instâncias da classe @code{C}, onde @code{h} é exatamente equivalente a @code{g}. No entanto, essa prática serve apenas para confundir o leitor do programa.

Métodos podem invocar outros métodos usando atributos de método do argumento @code{self}:

@example
class Bolsa:
    def __init__(self):
        self.data = []

    def adicionar(self, x):
        self.data.append(x)

    def adicionar_em_dobro(self, x):
        self.adicionar(x)
        self.adicionar(x)
@end example

Métodos podem referenciar nomes globais da mesma forma que funções comuns. O escopo global associado a um método é o módulo contendo sua definição na classe (a classe propriamente dita nunca é usada como escopo global!). Ainda que seja raro justificar o uso de dados globais em um método, há diversos usos legítimos do escopo global. Por exemplo, funções e módulos importados no escopo global podem ser usados por métodos, bem como as funções e classes definidas no próprio escopo global. Provavelmente, a classe contendo o método em questão também foi definida neste escopo global. Na próxima seção veremos razões pelas quais um método pode querer referenciar sua própria classe.

Cada valor é um objeto e, portanto, tem uma `classe' (também chamada de `tipo'). Ela é armazenada como @code{object.__class__}.

@node Herança,Variáveis privadas,Observações aleatórias,Classes
@anchor{tutorial/classes inheritance}@anchor{1e3e}@anchor{tutorial/classes tut-inheritance}@anchor{1e3f}
@subsection Herança


Obviamente, uma característica da linguagem não seria digna do nome “classe” se não suportasse herança. A sintaxe para uma classe derivada é assim:

@example
class NomeClasseDerivada(NomeClasseBase):
    <instrução-1>
    .
    .
    .
    <instrução-N>
@end example

O identificador @code{BaseClassName} deve estar definido em um espaço de nomes acessível do  escopo que contém a definição da classe derivada. No lugar do nome da classe base, também são aceitas outras expressões. Isso é muito útil, por exemplo, quando a classe base é definida em outro módulo:

@example
class NomeClasseDerivada(nomemódulo.NomeClasseBase):
@end example

A execução de uma definição de classe derivada procede da mesma forma que a de uma classe base. Quando o objeto classe é construído, a classe base é lembrada. Isso é utilizado para resolver referências a atributos. Se um atributo requisitado não for encontrado na classe, ele é procurado na classe base. Essa regra é aplicada recursivamente se a classe base por sua vez for derivada de outra.

Não há nada de especial sobre instanciação de classes derivadas: @code{NomeClasseDerivada()} cria uma nova instância da classe. Referências a métodos são resolvidas da seguinte forma: o atributo correspondente é procurado através da cadeia de classes base, e referências a métodos são válidas se essa procura produzir um objeto função.

Classes derivadas podem sobrescrever métodos das suas classes base. Uma vez que métodos não possuem privilégios especiais quando invocam outros métodos no mesmo objeto, um método na classe base que invoca um outro método da mesma classe base pode, efetivamente, acabar invocando um método sobreposto por uma classe derivada. (Para programadores C++ isso significa que todos os métodos em Python são realmente @code{virtuais}.)

Um método sobrescrito em uma classe derivada, de fato, pode querer estender, em vez de simplesmente substituir, o método da classe base, de mesmo nome. Existe uma maneira simples de chamar diretamente o método da classe base: apenas chame @code{BaseClassName.methodname(self, arguments)}. Isso é geralmente útil para os clientes também. (Note que isto só funciona se a classe base estiver acessível como @code{BaseClassName} no escopo global).

Python tem duas funções embutidas que trabalham com herança:


@itemize *

@item 
Use @ref{442,,isinstance()} para verificar o tipo de uma instância: @code{isinstance(obj, int)} será @code{True} somente se @code{obj.__class__} é a classe @ref{257,,int} ou alguma classe derivada de @ref{257,,int}.

@item 
Use @ref{7c2,,issubclass()} para verificar herança entre classes: @code{issubclass(bool, int)} é @code{True} porque @ref{468,,bool} é uma subclasse de @ref{257,,int}. Porém, @code{issubclass(float, int)} é @code{False} porque @ref{2f7,,float} não é uma subclasse de @ref{257,,int}.
@end itemize

@menu
* Herança múltipla:: 

@end menu

@node Herança múltipla,,,Herança
@anchor{tutorial/classes multiple-inheritance}@anchor{1e40}@anchor{tutorial/classes tut-multiple}@anchor{1e41}
@subsubsection Herança múltipla


Python também suporta uma forma de herança múltipla. Uma definição de classe com várias classes bases tem esta forma:

@example
class NomeClasseDerivada(Base1, Base2, Base3):
    <instrução-1>
    .
    .
    .
    <instrução-N>
@end example

Para a maioria dos casos mais simples, pense na pesquisa de atributos herdados de uma classe pai como o primeiro nível de profundidade, da esquerda para a direita, não pesquisando duas vezes na mesma classe em que há uma sobreposição na hierarquia. Assim, se um atributo não é encontrado em @code{DerivedClassName}, é procurado em @code{Base1}, depois, recursivamente, nas classes base de @code{Base1}, e se não for encontrado lá, é pesquisado em @code{Base2} e assim por diante.

De fato, é um pouco mais complexo que isso; a ordem de resolução de métodos muda dinamicamente para suportar chamadas cooperativas para @ref{4db,,super()}. Essa abordagem é conhecida em outras linguagens de herança múltipla como chamar-o-próximo-método, e é mais poderosa que a chamada à função super, encontrada em linguagens de herança única.

A ordenação dinâmica é necessária porque todos os casos de herança múltipla exibem um ou mais relacionamentos de diamante (em que pelo menos uma das classes bases pode ser acessada por meio de vários caminhos da classe mais inferior). Por exemplo, todas as classes herdam de @ref{a96,,object}, portanto, qualquer caso de herança múltipla fornece mais de um caminho para alcançar @ref{a96,,object}. Para evitar que as classes base sejam acessadas mais de uma vez, o algoritmo dinâmico lineariza a ordem de pesquisa, de forma a preservar a ordenação da esquerda para a direita, especificada em cada classe, que chama cada pai apenas uma vez, e que é monotônica (significando que uma classe pode ser subclassificada sem afetar a ordem de precedência de seus pais). Juntas, essas propriedades tornam possível projetar classes confiáveis e extensíveis com herança múltipla. Para mais detalhes, veja @ref{14f2,,A Ordem de Resolução de Métodos do Python 2.3}.

@node Variáveis privadas,Curiosidades e conclusões,Herança,Classes
@anchor{tutorial/classes private-variables}@anchor{1e42}@anchor{tutorial/classes tut-private}@anchor{1e29}
@subsection Variáveis privadas


Variáveis de instância “privadas”, que não podem ser acessadas, exceto em métodos do próprio objeto, não existem em Python. No entanto, existe uma convenção que é seguida pela maioria dos programas em Python: um nome prefixado com um sublinhado (por exemplo: @code{_spam} ) deve ser tratado como uma parte não-pública da API (seja uma função, um método ou um atributo de dados). Tais nomes devem ser considerados um detalhe de implementação e sujeito a alteração sem aviso prévio.

@geindex nome;desfiguração

Uma vez que existe um caso de uso válido para a definição de atributos privados em classes (especificamente para evitar conflitos com nomes definidos em subclasses), existe um suporte limitado a identificadores privados em classes, chamado `desfiguração de nomes'. Qualquer identificador no formato @code{__spam} (pelo menos dois sublinhados no início, e no máximo um sublinhado no final) é textualmente substituído por @code{_classname__spam}, onde @code{classname} é o nome da classe atual com sublinhado(s) iniciais omitidos. Essa desfiguração independe da posição sintática do identificador, desde que ele apareça dentro da definição de uma classe.


@subsubheading Ver também


O @ref{1e43,,especificações de desfiguração de nome privado} para detalhes e casos especiais.


A desfiguração de nomes é útil para que subclasses possam sobrescrever métodos sem quebrar invocações de métodos dentro de outra classe. Por exemplo:

@example
class Mapeamento:
    def __init__(self, iterável):
        self.lista_itens = []
        self.__atualizar(iterável)

    def atualizar(self, iterável):
        for item in iterável:
            self.lista_itens.append(item)

    __atualizar = atualizar   # cópia privada do método atualizar() original

class SubclasseMapeamento(Mapeamento):

    def update(self, chaves, valores):
        # fornece nova assinatura para atualizar(),
        # mas não quebra __init__()
        for item in zip(chaves, valores):
            self.lista_itens.append(item)
@end example

O exemplo acima deve funcionar mesmo se @code{SubclasseMapeamento} introduzisse um identificador @code{__atualizar} uma vez que é substituído por @code{_Mapeamento__atualizar} na classe @code{Mapeamento} e @code{_SubclasseMapeamento__atualizar} na classe @code{SubclasseMapeamento}, respectivamente.

Note que as regras de desfiguração de nomes foram projetadas para evitar acidentes; ainda é possível acessar ou modificar uma variável que é considerada privada. Isso pode ser útil em certas circunstâncias especiais, como depuração de código.

Código passado para @code{exec()} ou @code{eval()} não considera o nome da classe que invocou como sendo a classe corrente; isso é semelhante ao funcionamento da instrução @code{global}, cujo efeito se aplica somente ao código que é compilado junto. A mesma restrição se aplica às funções @code{getattr()}, @code{setattr()} e @code{delattr()}, e quando acessamos diretamente o @code{__dict__} da classe.

@node Curiosidades e conclusões,Iteradores,Variáveis privadas,Classes
@anchor{tutorial/classes odds-and-ends}@anchor{1e44}@anchor{tutorial/classes tut-odds}@anchor{1e45}
@subsection Curiosidades e conclusões


Às vezes, é útil ter um tipo semelhante ao “record” de Pascal ou ao “struct” de C, para agrupar alguns itens de dados. A maneira pythônica para este fim é usar @ref{2f,,dataclasses}:

@example
from dataclasses import dataclass

@@dataclass
class Empregado:
    nome: str
    dept: str
    salário: int
@end example

@example
>>> joão = Empregado('joão', 'lab de computadores', 1000)
>>> joão.dept
'lab de computadores'
>>> joão.salário
1000
@end example

Um trecho de código Python que espera um tipo de dado abstrato em particular, pode receber, ao invés disso, uma classe que imita os métodos que aquele tipo suporta. Por exemplo, se você tem uma função que formata dados obtidos de um objeto do tipo “arquivo”, pode definir uma classe com métodos @ref{1e0c,,read()} e @ref{1e46,,readline()} que obtém os dados de um “buffer de caracteres” e passar 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{1e47,,Métodos de instância} têm atributos também: @ref{140f,,m.__self__} é o objeto instância com o método @code{m()}, e @ref{1340,,m.__func__} é o @ref{299,,objeto função} correspondente ao método.

@node Iteradores,Geradores,Curiosidades e conclusões,Classes
@anchor{tutorial/classes iterators}@anchor{1e48}@anchor{tutorial/classes tut-iterators}@anchor{1e49}
@subsection Iteradores


Você já deve ter notado que pode usar laços @ref{2f2,,for} com a maioria das coleções em Python:

@example
for elemento in [1, 2, 3]:
    print(elemento)
for elemento in (1, 2, 3):
    print(elemento)
for chave in @{'um':1, 'dois':2@}:
    print(chave)
for char in "123":
    print(char)
for linha in open("meuarquivo.txt"):
    print(linha, end='@w{'})
@end example

Esse estilo de acesso é claro, conciso e conveniente. O uso de iteradores permeia e unifica o Python. Nos bastidores, a instrução @ref{2f2,,for} chama @ref{7d8,,iter()} no objeto contêiner. A função retorna um objeto iterador que define o método @ref{1310,,__next__()} que acessa elementos no contêiner, um de cada vez. Quando não há mais elementos, @ref{1310,,__next__()} levanta uma exceção @ref{c15,,StopIteration} que informa ao @code{for} para terminar. Você pode chamar o método @ref{1310,,__next__()} usando a função embutida @ref{7d9,,next()}; este exemplo mostra como tudo funciona:

@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

Observando o mecanismo por trás do protocolo dos iteradores, fica fácil adicionar esse comportamento às suas classes. Defina um método @ref{1e4a,,__iter__()} que retorna um objeto que tenha um método @ref{1310,,__next__()}. Se uma classe já define @code{__next__()}, então @code{__iter__()} pode simplesmente retornar @code{self}:

@example
class Inverter:
    """Iterador para fazer um laço em uma sequência de trás para frente."""
    def __init__(self, dados):
        self.dados = dados
        self.índice = len(dados)

    def __iter__(self):
        return self

    def __next__(self):
        if self.índice == 0:
            raise StopIteration
        self.índice = self.índice - 1
        return self.dados[self.índice]
@end example

@example
>>> rev = Interverter('spam')
>>> iter(rev)
<__main__.Interverter object at 0x00A1DB50>
>>> for char in rev:
...     print(char)
...
m
a
p
s
@end example

@node Geradores,Expressões geradoras,Iteradores,Classes
@anchor{tutorial/classes generators}@anchor{1e4b}@anchor{tutorial/classes tut-generators}@anchor{1e4c}
@subsection Geradores


@ref{109a,,Geradores} são uma ferramenta simples e poderosa para criar iteradores. São escritos como funções normais mas usam a instrução @ref{9d5,,yield} quando precisam retornar dados. Cada vez que @ref{7d9,,next()} é chamado, o gerador volta ao ponto onde parou (lembrando  todos os valores de dados e qual instrução foi executada pela última vez). Um exemplo mostra como geradores podem ser trivialmente fáceis de criar:

@example
def inverter(dados):
    for índice in range(len(dados)-1, -1, -1):
        yield dados[índice]
@end example

@example
>>> for char in inverter('golf'):
...     print(char)
...
f
l
o
g
@end example

Qualquer coisa que possa ser feita com geradores também pode ser feita com iteradores baseados numa classe, como descrito na seção anterior. O que torna geradores tão compactos é que os métodos @ref{1e4d,,__iter__()} e @ref{1e4e,,__next__()} são criados automaticamente.

Outro ponto chave é que as variáveis locais e o estado da execução são preservados automaticamente entre as chamadas. Isto torna a função mais fácil de escrever e muito mais clara do que uma implementação usando variáveis de instância como @code{self.index} e @code{self.data}.

Além disso, quando geradores terminam, eles levantam @ref{c15,,StopIteration} automaticamente. Combinados, todos estes aspectos tornam a criação de iteradores tão fácil quanto escrever uma função normal.

@node Expressões geradoras,,Geradores,Classes
@anchor{tutorial/classes generator-expressions}@anchor{1e4f}@anchor{tutorial/classes tut-genexps}@anchor{1e50}
@subsection Expressões geradoras


Alguns geradores simples podem ser codificados, de forma sucinta, como expressões, usando uma sintaxe semelhante a compreensões de lista, mas com parênteses em vez de colchetes. Essas expressões são projetadas para situações em que o gerador é usado imediatamente, pela função que o engloba. As expressões geradoras são mais compactas, mas menos versáteis do que as definições completas do gerador, e tendem a usar menos memória do que as compreensões de lista equivalentes.

Exemplos:

@example
>>> sum(i*i for i in range(10))                 # soma dos quadrados
285

>>> xvec = [10, 20, 30]
>>> yvec = [7, 5, 3]
>>> sum(x*y for x,y in zip(xvec, yvec))         # produto escalar
260

>>> palavras_únicas = set(palavra for linha página for palavra in linha.split())

>>> orador_da_turma = max((estudante.gpa, estudante.nome) for estudante in graduados)

>>> dados = 'golf'
>>> list(dados[i] for i in range(len(dados)-1, -1, -1))
['f', 'l', 'o', 'g']
@end example

@node Um breve passeio pela biblioteca padrão,Um breve passeio pela biblioteca padrão — parte II,Classes,O tutorial do Python
@anchor{tutorial/stdlib doc}@anchor{1e51}@anchor{tutorial/stdlib brief-tour-of-the-standard-library}@anchor{1e52}@anchor{tutorial/stdlib translation-repo}@anchor{1e53}@anchor{tutorial/stdlib tut-brieftour}@anchor{1e54}
@section Um breve passeio pela biblioteca padrão


@menu
* Interface com o sistema operacional:: 
* Caracteres curinga:: 
* Argumentos de linha de comando:: 
* Redirecionamento de erros e encerramento do programa:: 
* Reconhecimento de padrões em strings:: 
* Matemática:: 
* Acesso à internet:: 
* Data e hora:: 
* Compressão de dados:: 
* Medição de desempenho:: 
* Controle de qualidade:: 
* Baterias incluídas:: 

@end menu

@node Interface com o sistema operacional,Caracteres curinga,,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib operating-system-interface}@anchor{1e55}@anchor{tutorial/stdlib tut-os-interface}@anchor{1e56}
@subsection Interface com o sistema operacional


O módulo @ref{a1,,os} fornece dúzias de funções para interagir com o sistema operacional:

@example
>>> import os
>>> os.getcwd()      # Retorna o diretório de trabalho atual
'C:\\Python313'
>>> os.chdir('/server/accesslogs')   # Altera o diretório de trabalho atual
>>> os.system('mkdir hoje')   # Executa o comando mkdir no shell do sistema
0
@end example

Certifique-se de usar a forma @code{import os} ao invés de @code{from os import *}. Isso evitará que @ref{dba,,os.open()} oculte a função @ref{51c,,open()} que opera de forma muito diferente.

@geindex função embutida;help

As funções embutidas @ref{632,,dir()} e @ref{8dd,,help()} são úteis como um sistema de ajuda interativa para lidar com módulos grandes como @ref{a1,,os}:

@example
>>> import os
>>> dir(os)
<retorna uma lista de todas as funções do módulo>
>>> help(os)
<retorna uma página de manual extensa criada a partir das docstrings do módulo>
@end example

Para tarefas de gerenciamento cotidiano de arquivos e diretórios, o módulo @ref{c5,,shutil} fornece uma interface de alto nível que é mais simples de usar:

@example
>>> import shutil
>>> shutil.copyfile('dados.db', 'arquivo.db')
'arquivo.db'
>>> shutil.move('/build/executáveis', 'dir_instal')
'dir_instal'
@end example

@node Caracteres curinga,Argumentos de linha de comando,Interface com o sistema operacional,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib file-wildcards}@anchor{1e57}@anchor{tutorial/stdlib tut-file-wildcards}@anchor{1e58}
@subsection Caracteres curinga


O módulo @ref{64,,glob} fornece uma função para criar listas de arquivos a partir de buscas em diretórios usando caracteres curinga:

@example
>>> import glob
>>> glob.glob('*.py')
['primos.py', 'aleatorizar.py', 'aspas.py']
@end example

@node Argumentos de linha de comando,Redirecionamento de erros e encerramento do programa,Caracteres curinga,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib command-line-arguments}@anchor{1e59}@anchor{tutorial/stdlib tut-command-line-arguments}@anchor{1e5a}
@subsection Argumentos de linha de comando


Scripts geralmente precisam processar argumentos passados na linha de comando. Esses argumentos são armazenados como uma lista no atributo `argv' do módulo @ref{d9,,sys}. Por exemplo, consideremos o arquivo @code{demo.py} a seguir:

@example
# Arquivo demo.py
import sys
print(sys.argv)
@end example

Aqui está a saída da execução @code{python demo.py um dois três} na linha de comando:

@example
['demo.py', 'um', 'dois, 'três']
@end example

O módulo @ref{6,,argparse} fornece um mecanismo mais sofisticado para processar argumentos de linha de comando. O script seguinte extrai e exibe um ou mais nomes de arquivos e um número de linhas opcional:

@example
import argparse

parser = argparse.ArgumentParser(
    prog='topo',
    description='Mostra as primeiras linhas de cada arquivo')
parser.add_argument('arquivos, nargs='+')
parser.add_argument('-l', '--linhas', type=int, default=10)
args = parser.parse_args()
print(args)
@end example

Quando executada na linha de comando @code{python topo.py --linhas=5 alfa.txt beta.txt}, o script define @code{args.linhas} para @code{5} e @code{args.arquivos} para @code{['alfa.txt', 'beta.txt']}.

@node Redirecionamento de erros e encerramento do programa,Reconhecimento de padrões em strings,Argumentos de linha de comando,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib error-output-redirection-and-program-termination}@anchor{1e5b}@anchor{tutorial/stdlib tut-stderr}@anchor{1e5c}
@subsection Redirecionamento de erros e encerramento do programa


O módulo @ref{d9,,sys} também possui atributos para `stdin', `stdout' e `stderr'. O último é usado para emitir avisos e mensagens de erros visíveis mesmo quando `stdout' foi redirecionado:

@example
>>> sys.stderr.write('Aviso, arquivo log não encontrado, iniciando um novo\n')
Aviso, arquivo log não encontrado, iniciando um novo
@end example

A forma mais direta de encerrar um script é usando @code{sys.exit()}.

@node Reconhecimento de padrões em strings,Matemática,Redirecionamento de erros e encerramento do programa,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib string-pattern-matching}@anchor{1e5d}@anchor{tutorial/stdlib tut-string-pattern-matching}@anchor{1e5e}
@subsection Reconhecimento de padrões em strings


O módulo @ref{b9,,re} fornece ferramentas para lidar com processamento de strings através de expressões regulares. Para reconhecimento de padrões complexos, expressões regulares oferecem uma solução sucinta e eficiente:

@example
>>> import re
>>> re.findall(r'\br[a-z]*', 'o rato roeu a roupa do rei de roma')
['rato', 'roeu', 'roupa', 'rei', 'roma']
>>> re.sub(r'(\b[a-z]+) \1', r'\1', 'o gato de de chapéu')
'o gato de chapéu'
@end example

Quando as exigências são simples, métodos de strings são preferíveis por serem mais fáceis de ler e depurar:

@example
>>> 'xá para dois'.replace('xá', 'chá')
'chá para dois'
@end example

@node Matemática,Acesso à internet,Reconhecimento de padrões em strings,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib mathematics}@anchor{1e5f}@anchor{tutorial/stdlib tut-mathematics}@anchor{1e60}
@subsection Matemática


O módulo @ref{8e,,math} oferece acesso às funções da biblioteca C para matemática de ponto flutuante:

@example
>>> import math
>>> math.cos(math.pi / 4)
0.70710678118654757
>>> math.log(1024, 2)
10.0
@end example

O módulo @ref{b8,,random} fornece ferramentas para gerar seleções aleatórias:

@example
>>> import random
>>> random.choice(['maçã', 'pera', 'banana'])
'maçã'
>>> random.sample(range(100), 10)   # amostragem sem reposição
[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
>>> random.random()    # ponto flutuante aleatório do intervalo [0.0, 1.0)
0.17970987693706186
>>> random.randrange(6)    # inteiro aleatório escolhido de range(6)
4
@end example

O módulo @ref{d2,,statistics} calcula as propriedades estatísticas básicas (a média, a mediana, a variação, etc.) de dados numéricos:

@example
>>> import statistics
>>> dados = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> statistics.mean(dados)
1.6071428571428572
>>> statistics.median(dados)
1.25
>>> statistics.variance(dados)
1.3720238095238095
@end example

O projeto SciPy <@indicateurl{https://scipy.org}> tem muitos outros módulos para cálculos numéricos.

@node Acesso à internet,Data e hora,Matemática,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib internet-access}@anchor{1e61}@anchor{tutorial/stdlib tut-internet-access}@anchor{1e62}
@subsection Acesso à internet


Há diversos módulos para acesso e processamento de protocolos da internet. Dois dos mais simples são @ref{10b,,urllib.request} para efetuar download de dados a partir de URLs e @ref{ca,,smtplib} para enviar mensagens de correio eletrônico:

@example
>>> from urllib.request import urlopen
>>> with urlopen('https://docs.python.org/3/') as response:
...     for line in response:
...         line = line.decode()             # Converte bytes para um str
...         if 'updated' in line:
...             print(line.rstrip())         # Remove nova linha ao final
...
      Last updated on Nov 11, 2025 (20:11 UTC).

>>> import smtplib
>>> server = smtplib.SMTP('localhost')
>>> server.sendmail('soothsayer@@example.org', 'jcaesar@@example.org',
... """To: jcaesar@@example.org
... From: soothsayer@@example.org
...
... Cuidado com os Idos de Março.
... """)
>>> server.quit()
@end example

(Note que o segundo exemplo precisa de um servidor de email rodando em localhost.)

@node Data e hora,Compressão de dados,Acesso à internet,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib dates-and-times}@anchor{1e63}@anchor{tutorial/stdlib tut-dates-and-times}@anchor{1e64}
@subsection Data e hora


O módulo @ref{30,,datetime} fornece classes para manipulação de datas e horas nas mais variadas formas. Apesar da disponibilidade de aritmética com data e hora, o foco da implementação é na extração eficiente dos membros para formatação e manipulação. O módulo também oferece objetos que levam os fusos horários em consideração.

@example
>>> # datas são facilmente construídas e formatadas
>>> 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.'

>>> # datas têm suporte a matemática de calendário
>>> birthday = date(1964, 7, 31)
>>> age = now - birthday
>>> age.days
14368
@end example

@node Compressão de dados,Medição de desempenho,Data e hora,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib data-compression}@anchor{1e65}@anchor{tutorial/stdlib tut-data-compression}@anchor{1e66}
@subsection Compressão de dados


Formatos comuns de arquivamento e compressão de dados estão disponíveis diretamente através de alguns módulos, entre eles: @ref{133,,zlib}, @ref{67,,gzip}, @ref{13,,bz2}, @ref{8a,,lzma}, @ref{131,,zipfile} and @ref{de,,tarfile}.

@example
>>> import zlib
>>> s = b'A vaca malhada foi molhada por outra vaca molhada e malhada.'
>>> len(s)
60
>>> t = zlib.compress(s)
>>> len(t)
47
>>> zlib.decompress(t)
b'A vaca malhada foi molhada por outra vaca molhada e malhada.'
>>> zlib.crc32(s)
2444551089
@end example

@node Medição de desempenho,Controle de qualidade,Compressão de dados,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib performance-measurement}@anchor{1e67}@anchor{tutorial/stdlib tut-performance-measurement}@anchor{1e68}
@subsection Medição de desempenho


Alguns usuários de Python desenvolvem um interesse profundo pelo desempenho relativo de diferentes abordagens para o mesmo problema. Python oferece uma ferramenta de medição que esclarece essas dúvidas rapidamente.

Por exemplo, pode ser tentador usar o empacotamento e desempacotamento de tuplas ao invés da abordagem tradicional de permutar os argumentos. O módulo @ref{ef,,timeit} rapidamente mostra uma modesta vantagem de desempenho:

@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

Em contraste com a granularidade fina do módulo @ref{ef,,timeit}, os módulos @ref{af,,profile} e @ref{b0,,pstats} oferecem ferramentas para identificar os trechos mais críticos em grandes blocos de código.

@node Controle de qualidade,Baterias incluídas,Medição de desempenho,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib quality-control}@anchor{1e69}@anchor{tutorial/stdlib tut-quality-control}@anchor{1e6a}
@subsection Controle de qualidade


Uma das abordagens usadas no desenvolvimento de software de alta qualidade é escrever testes para cada função à medida que é desenvolvida e executar esses testes frequentemente durante o processo de desenvolvimento.

O módulo @ref{3a,,doctest} oferece uma ferramenta para realizar um trabalho de varredura e validação de testes escritos nas strings de documentação (docstrings) de um programa. A construção dos testes é tão simples quanto copiar uma chamada típica juntamente com seus resultados e colá-los na docstring. Isto aprimora a documentação, fornecendo ao usuário um exemplo real, e permite que o módulo doctest verifique se o código continua fiel à documentação:

@example
def average(values):
    """Calcula a média aritmética da lista de números.

    >>> print(average([20, 30, 70]))
    40.0
    """
    return sum(values) / len(values)

import doctest
doctest.testmod()   # valida automaticamente os testes incorporados
@end example

O módulo @ref{106,,unittest} não é tão simples de usar quanto o módulo @ref{3a,,doctest}, mas permite que um conjunto muito maior de testes seja mantido em um arquivo separado:

@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()  # Chamar a partir da linha de comando invoca todos os testes
@end example

@node Baterias incluídas,,Controle de qualidade,Um breve passeio pela biblioteca padrão
@anchor{tutorial/stdlib batteries-included}@anchor{1e6b}@anchor{tutorial/stdlib tut-batteries-included}@anchor{1e6c}
@subsection Baterias incluídas


Python tem uma filosofia de “baterias incluídas”. Isso fica mais evidente através da sofisticação e robustez dos seus maiores pacotes. Por exemplo:


@itemize *

@item 
Os módulos @ref{12e,,xmlrpc.client} e @ref{12f,,xmlrpc.server} tornam a implementação de chamadas remotas (remote procedure calls) em uma tarefa quase trivial. Apesar dos nomes dos módulos, nenhum conhecimento direto ou manipulação de XML é necessário.

@item 
O pacote @ref{3b,,email} é uma biblioteca para gerenciamento de mensagens de correio eletrônico, incluindo MIME e outros baseados no 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}. Diferente dos módulos @ref{ca,,smtplib} e @ref{ac,,poplib} que apenas enviam e recebem mensagens, o pacote de email tem um conjunto completo de ferramentas para construir ou decodificar a estrutura de mensagens complexas (incluindo anexos) e para implementação de protocolos de codificação e cabeçalhos.

@item 
O pacote @ref{82,,json} oferece um suporte robusto para analisar este popular formato para troca de dados. O módulo @ref{29,,csv} oferece suporte para leitura e escrita direta em arquivos no formato Comma-Separated Value, comumente suportado por bancos de dados e planilhas. O processamento XML é fornecido pelos pacotes @ref{125,,xml.etree.ElementTree}, @ref{121,,xml.dom} e @ref{129,,xml.sax}. Juntos, esses módulos e pacotes simplificam muito a troca de informações entre aplicativos Python e outras ferramentas.

@item 
O módulo @ref{cf,,sqlite3} é um wrapper para a biblioteca de banco de dados SQLite, fornecendo um banco de dados persistente que pode ser atualizado e acessado usando sintaxe SQL ligeiramente fora do padrão.

@item 
Internacionalização está disponível através de diversos módulos, como @ref{63,,gettext}, @ref{86,,locale}, e o pacote @ref{1b,,codecs}.
@end itemize

@node Um breve passeio pela biblioteca padrão — parte II,Ambientes virtuais e pacotes,Um breve passeio pela biblioteca padrão,O tutorial do Python
@anchor{tutorial/stdlib2 doc}@anchor{1e6d}@anchor{tutorial/stdlib2 brief-tour-of-the-standard-library-part-ii}@anchor{1e6e}@anchor{tutorial/stdlib2 translation-repo}@anchor{1e6f}@anchor{tutorial/stdlib2 tut-brieftourtwo}@anchor{1e70}
@section Um breve passeio pela biblioteca padrão — parte II


Este segundo passeio apresenta alguns módulos avançados que atendem necessidades de programação profissional. Estes módulos raramente aparecem em scripts pequenos.

@menu
* Formatando a saída:: 
* Usando templates:: 
* Trabalhando com formatos binários de dados:: 
* Multi-threading: Multi-threading<2>. 
* Gerando logs:: 
* Referências fracas:: 
* Ferramentas para trabalhar com listas:: 
* Aritmética decimal com ponto flutuante:: 

@end menu

@node Formatando a saída,Usando templates,,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 output-formatting}@anchor{1e71}@anchor{tutorial/stdlib2 tut-output-formatting}@anchor{1e72}
@subsection Formatando a saída


O módulo @ref{bb,,reprlib} fornece uma versão de @ref{800,,repr()} personalizado para exibições abreviadas de contêineres grandes ou profundamente aninhados:

@example
>>> import reprlib
>>> reprlib.repr(set('supercalifragilisticexpialidoce'))
"@{'a', 'c', 'd', 'e', 'f', 'g', ...@}"
@end example

O módulo @ref{ae,,pprint} oferece um controle mais sofisticado na exibição tanto de objetos embutidos quanto aqueles criados pelo usuário de maneira que fique legível para o interpretador. Quando o resultado é maior que uma linha, o “pretty printer” acrescenta quebras de linha e indentação para revelar as estruturas de maneira mais clara:

@example
>>> import pprint
>>> t = [[[['preto', 'ciano'], 'branco', ['verde', 'vermelho']], [['magenta',
...     'amarelo'], 'azul']]]
>>>
>>> pprint.pprint(t, width=30)
[[[['preto', 'ciano'],
   'branco',
   ['verde', 'vermelho']],
  [['magenta', 'amarelo'],
   'azul']]]
@end example

O módulo @ref{ec,,textwrap} formata parágrafos de texto para que caibam em uma dada largura de tela:

@example
>>> import textwrap
>>> doc = """O método wrap() é como fill(), exceto que ele retorna
... uma lista de strings em vez de uma string grande com quebras
... de linha para separar as linhas quebradas."""
...
>>> print(textwrap.fill(doc, width=40))
O método wrap() é como fill(), exceto
que ele retorna uma lista de strings em
vez de uma string grande com quebras de
linha para separar as linhas quebradas.
@end example

O módulo @ref{86,,locale} acessa uma base de dados de formatos específicos a determinada cultura. O atributo de agrupamento da função “format” oferece uma forma direta de formatar números com separadores de grupo:

@example
>>> import locale
>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
'English_United States.1252'
>>> conv = locale.localeconv()          # obtém mapeamento de convenções
>>> 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 Usando templates,Trabalhando com formatos binários de dados,Formatando a saída,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 templating}@anchor{1e73}@anchor{tutorial/stdlib2 tut-templating}@anchor{1e74}
@subsection Usando templates


módulo @ref{d3,,string} inclui a versátil classe @code{Template} com uma sintaxe simplificada, adequada para ser editada por usuários finais. Isso permite que usuários personalizem suas aplicações sem a necessidade de alterar a aplicação.

Em um template são colocadas marcações indicando o local onde o texto variável deve ser inserido. Uma marcação é formada por @code{$} seguido de um identificador Python válido (caracteres alfanuméricos e underscores). Envolvendo-se o identificador da marcação entre chaves, permite que ele seja seguido por mais caracteres alfanuméricos sem a necessidade de espaços. Escrevendo-se @code{$$} cria-se um único @code{$}:

@example
>>> from string import Template
>>> t = Template('O povo de $@{vila@} envia $$10 para $causa.')
>>> t.substitute(vila='Nottingham', causa='o fundo de recuperação')
'O povo de Nottingham envia $10 para o fundo de recuperação.'
@end example

O método @code{substitute()} levanta uma exceção @ref{344,,KeyError} quando o identificador de uma marcação não é fornecido em um dicionário ou em um argumento nomeado (`keyword argument'). Para aplicações que podem receber dados incompletos fornecidos pelo usuário, o método @code{safe_substitute()} pode ser mais apropriado — deixará os marcadores intactos se os dados estiverem faltando:

@example
>>> t = Template('Devolva $item para $dono.')
>>> d = dict(item='a andorinha descarregada')
>>> t.substitute(d)
Traceback (most recent call last):
  ...
KeyError: 'dono'
>>> t.safe_substitute(d)
'Devolva a andorinha descarregada para $dono.'
@end example

Subclasses de Template podem especificar um delimitador personalizado. Por exemplo, um utilitário para renomeação em lote de fotos pode usar o sinal de porcentagem para marcações como a data atual, número sequencial da imagem ou formato do aquivo:

@example
>>> import time, os.path
>>> arquivos_fotos = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
>>> class RenomeiaEmLote(Template):
...     delimiter = '%'
...
>>> formato = input('Informe o estilo de renomeação (%d-data %n-sequencia %f-formato):  ')
Informe o estilo de renomeação (%d-data %n-sequencia %f-formato):  Ashley_%n%f

>>> t = RenomeiaEmLote(formato)
>>> data = time.strftime('%d%b%y')
>>> for i, nome_arquivo in enumerate(arquivos_fotos):
...     base, extensão = os.path.splitext(nome_arquivo)
...     novo_nome = t.substitute(d=data, n=i, f=extensão)
...     print('@{0@} --> @{1@}'.format(nome_arquivo, novo_nome))

img_1074.jpg --> Ashley_0.jpg
img_1076.jpg --> Ashley_1.jpg
img_1077.jpg --> Ashley_2.jpg
@end example

Outra aplicação para templates é separar a lógica da aplicação dos detalhes de múltiplos formatos de saída. Assim é possível usar templates personalizados para gerar arquivos XML, relatórios em texto puro e relatórios web em HTML.

@node Trabalhando com formatos binários de dados,Multi-threading<2>,Usando templates,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 tut-binary-formats}@anchor{1e75}@anchor{tutorial/stdlib2 working-with-binary-data-record-layouts}@anchor{1e76}
@subsection Trabalhando com formatos binários de dados


O módulo @ref{d5,,struct} oferece as funções @code{pack()} e @code{unpack()} para trabalhar com registros binários de tamanho variável. O exemplo a seguir mostra como iterar através do cabeçalho de informação num aquivo ZIP sem usar o módulo @ref{131,,zipfile}. Os códigos de empacotamento @code{"H"} e @code{"I"} representam números sem sinal de dois e quatro bytes respectivamente. O @code{"<"} indica que os números têm tamanho padrão e são little-endian (bytes menos significativos primeiro):

@example
import struct

with open('meuarquivo.zip', 'rb') as arq:
    dados = arq.read()

inicio = 0
for i in range(3):                      # mostra o cabeçalho dos 3 primeiros arquivos
    inicio += 14
    campos = struct.unpack('<IIIHH', dados[inicio:inicio+16])
    crc32, tamanho_comprimido, tamanho_descomprimido, tamanho_nome_arquivo, tamanho_extra = campos

    inicio += 16
    nome_arquivo = dados[inicio:inicio+tamanho_nome_arquivo]
    inicio += tamanho_nome_arquivo
    extra = dados[inicio:inicio+tamanho_extra]
    print(nome_arquivo, hex(crc32), tamanho_comprimido, tamanho_descomprimido)

    inicio += tamanho_extra + tamanho_comprimido     # pula para o próximo cabeçalho
@end example

@node Multi-threading<2>,Gerando logs,Trabalhando com formatos binários de dados,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 multi-threading}@anchor{1e77}@anchor{tutorial/stdlib2 tut-multi-threading}@anchor{1e78}
@subsection Multi-threading


O uso de threads é uma técnica para desacoplar tarefas que não são sequencialmente dependentes. Threads podem ser usadas para melhorar o tempo de resposta de aplicações que aceitam entradas do usuário enquanto outras tarefas são executadas em segundo plano. Um caso relacionado é executar ações de entrada e saída (I/O) em uma thread paralelamente a cálculos em outra thread.

O código a seguir mostra como o módulo de alto nível @ref{ed,,threading} pode executar tarefas em segundo plano enquanto o programa principal continua a sua execução:

@example
import threading, zipfile

class AsyncZip(threading.Thread):
    def __init__(self, arquivo_entrada, arquivo_saida):
        threading.Thread.__init__(self)
        self.arquivo_entrada = arquivo_entrada
        self.arquivo_saida = arquivo_saida

    def run(self):
        arq = zipfile.ZipFile(self.arquivo_saida, 'w', zipfile.ZIP_DEFLATED)
        arq.write(self.)
        arq.close()
        print('Finalizou compactação em background de:', self.arquivo_entrada)

background = AsyncZip('meusdados.txt', 'meuarquivo.zip')
background.start()
print('O programa original continua a executar em primeiro plano.')

background.join()    # Aguarda a tarefa em background finalizar
print('Programa principal aguardou até a tarefa em background estar finalizada.')
@end example

O principal desafio para as aplicações que usam múltiplas threads é coordenar as threads que compartilham dados ou outros recursos. Para esta finalidade, o módulo threading oferece alguns mecanismos primitivos de sincronização, como travas, eventos, variáveis de condição e semáforos.

Ainda que todas essas ferramentas sejam poderosas, pequenos erros de design podem resultar em problemas difíceis de serem diagnosticados. Por isso, a abordagem preferida para a coordenação da tarefa é concentrar todo o acesso a um recurso em um único tópico e, em seguida, usar o módulo @ref{b6,,queue} para alimentar esse segmento com solicitações de outros tópicos. Aplicações que utilizam objetos @ref{13db,,Queue} para comunicação e coordenação inter-thread são mais fáceis de serem projetados, mais legíveis e mais confiáveis.

@node Gerando logs,Referências fracas,Multi-threading<2>,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 logging}@anchor{1e79}@anchor{tutorial/stdlib2 tut-logging}@anchor{1e7a}
@subsection Gerando logs


O módulo @ref{87,,logging} oferece um completo e flexível sistema de log. Da maneira mais simples, mensagens de log são enviadas para um arquivo ou para @code{sys.stderr}:

@example
import logging
logging.debug('Depurando informações')
logging.info('Mensagem informática')
logging.warning('Alerta: arquivo de configuração  %s não encontrado', 'server.conf')
logging.error('Ocorreu um erro')
logging.critical('Erro crítico -- desligando')
@end example

Isso produz a seguinte saída:

@example
WARNING:root:Alerta:arquivo de configuração server.conf não encontrado
ERROR:root:Ocorreu um erro
CRITICAL:root:Erro crítico -- shutting down
@end example

Por padrão, mensagens informativas e de depuração são suprimidas e a saída é enviada para a saída de erros padrão (stderr). Outras opções de saída incluem envio de mensagens através de correio eletrônico, datagramas, sockets ou para um servidor HTTP. Novos filtros podem selecionar diferentes formas de envio de mensagens, baseadas na prioridade da mensagem: @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} e @code{CRITICAL}.

O sistema de log pode ser configurado diretamente do Python ou pode ser carregado a partir de um arquivo de configuração editável pelo usuário para logs personalizados sem a necessidade de alterar a aplicação.

@node Referências fracas,Ferramentas para trabalhar com listas,Gerando logs,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 tut-weak-references}@anchor{1e7b}@anchor{tutorial/stdlib2 weak-references}@anchor{1e7c}
@subsection Referências fracas


Python faz gerenciamento automático de memória (contagem de referências para a maioria dos objetos e @ref{1a69,,coleta de lixo} para eliminar ciclos). A memória ocupada por um objeto é liberada logo depois da última referência a ele ser eliminada.

Essa abordagem funciona bem para a maioria das aplicações, mas ocasionalmente surge a necessidade de rastrear objetos apenas enquanto estão sendo usados por algum outro. Infelizmente rastreá-los cria uma referência, e isso os fazem permanentes. O módulo @ref{114,,weakref} oferece ferramentas para rastrear objetos sem criar uma referência. Quando o objeto não é mais necessário, ele é automaticamente removido de uma tabela de referências fracas e uma chamada (`callback') é disparada. Aplicações típicas incluem armazenamento em cache de objetos que são muito custosos para criar:

@example
>>> import weakref, gc
>>> class A:
...     def __init__(self, valor):
...         self.valor = valor
...     def __repr__(self):
...         return str(self.valor)
...
>>> a = A(10)                   # cria uma referência
>>> d = weakref.WeakValueDictionary()
>>> d['primaria'] = a            # não cria uma referência
>>> d['primaria']                # busca o objeto se ele estiver ativo
10
>>> del a                       # remove a referência criada
>>> gc.collect()                # roda imediatamente a coleta de lixo
0
>>> d['primaria']                # o acesso foi automaticamente removido
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    d['primaria']                # o acesso foi automaticamente removido
  File "C:/python313/lib/weakref.py", line 46, in __getitem__
    o = self.data[key]()
KeyError: 'primaria'
@end example

@node Ferramentas para trabalhar com listas,Aritmética decimal com ponto flutuante,Referências fracas,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 tools-for-working-with-lists}@anchor{1e7d}@anchor{tutorial/stdlib2 tut-list-tools}@anchor{1e7e}
@subsection Ferramentas para trabalhar com listas


Muitas necessidades envolvendo estruturas de dados podem ser satisfeitas com o tipo embutido lista. Entretanto, algumas vezes há uma necessidade por implementações alternativas que sacrificam algumas facilidades em nome de melhor desempenho.

O módulo @ref{7,,array} oferece uma classe @ref{1a0,,array}, semelhante a uma lista, mas que armazena apenas dados homogêneos e de maneira mais compacta. O exemplo a seguir mostra um vetor de números armazenados como números binários de dois bytes sem sinal (código de tipo @code{"H"}) ao invés dos 16 bytes usuais para cada item em uma lista de @code{int}:

@example
>>> from array import array
>>> a = array('H', [4000, 10, 700, 22222])
>>> sum(a)
26932
>>> a[1:3]
array('H', [10, 700])
@end example

O módulo @ref{1d,,collections} oferece um objeto @ref{5dc,,deque} que comporta-se como uma lista mas com `appends' e `pops' pela esquerda mais rápidos, porém mais lento ao percorrer o meio da sequência. Esses objetos são adequados para implementar filas e buscas em amplitude em árvores de dados:

@example
>>> from collections import deque
>>> d = deque(["tarefa1", "tarefa2", "tarefa3"])
>>> d.append("tarefa4")
>>> print("Tratando", d.popleft())
Tratando tarefa1
@end example

@example
nao_pesquisada = deque([no_inicial])
def busca_em_profundidade(nao_pesquisada):
    no = nao_pesquisada.popleft()
    for m in gen_moves(no):
        if eh_o_alvo(m):
            return m
        nao_pesquisada.append(m)
@end example

Além de implementações alternativas de listas, a biblioteca também oferece outras ferramentas como o módulo @ref{11,,bisect} com funções para manipulação de listas ordenadas:

@example
>>> import bisect
>>> notas = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
>>> bisect.insort(notas, (300, 'ruby'))
>>> notas
[(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]
@end example

O módulo @ref{69,,heapq} oferece funções para implementação de `heaps' baseadas em listas normais. O valor mais baixo é sempre mantido na posição zero. Isso é útil para aplicações que acessam repetidamente o menor elemento, mas não querem reordenar a lista toda a cada acesso:

@example
>>> from heapq import heapify, heappop, heappush
>>> dados = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
>>> heapify(dados)                      # reorganiza a lista como um heap
>>> heappush(dados, -5)                 # adiciona o valor -5 ao heap
>>> [heappop(dados) for i in range(3)]  # encontra as 3 menores entradas
[-5, 0, 1]
@end example

@node Aritmética decimal com ponto flutuante,,Ferramentas para trabalhar com listas,Um breve passeio pela biblioteca padrão — parte II
@anchor{tutorial/stdlib2 decimal-floating-point-arithmetic}@anchor{1e7f}@anchor{tutorial/stdlib2 tut-decimal-fp}@anchor{1e80}
@subsection Aritmética decimal com ponto flutuante


O módulo @ref{36,,decimal} oferece o tipo @ref{29d,,Decimal} para aritmética decimal com ponto flutuante. Comparado a implementação embutida @ref{2f7,,float} que usa aritmética binária de ponto flutuante, a classe é especialmente útil para:


@itemize *

@item 
aplicações financeiras que requerem representação decimal exata,

@item 
controle sobre a precisão,

@item 
controle sobre arredondamento para satisfazer requisitos legais,

@item 
rastreamento de casas decimais significativas, ou

@item 
aplicações onde o usuário espera que os resultados sejam os mesmos que os dos cálculos feitos à mão.
@end itemize

Por exemplo, calcular um imposto de 5% sobre uma chamada telefônica de 70 centavos devolve diferentes resultados com aritmética de ponto flutuante decimal ou binária. A diferença torna-se significativa se os resultados são arredondados para o centavo mais 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

O resultado de @ref{29d,,Decimal} considera zeros à direita, automaticamente inferindo quatro casas decimais a partir de multiplicandos com duas casas decimais. O módulo Decimal reproduz a aritmética como fazemos à mão e evita problemas que podem ocorrer quando a representação binária do ponto flutuante não consegue representar quantidades decimais com exatidão.

A representação exata permite à classe @ref{29d,,Decimal} executar cálculos de módulo e testes de igualdade que não funcionam bem em ponto flutuante binário:

@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

O módulo @ref{36,,decimal} implementa a aritmética com tanta precisão quanto necessária:

@example
>>> getcontext().prec = 36
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857')
@end example

@node Ambientes virtuais e pacotes,E agora?,Um breve passeio pela biblioteca padrão — parte II,O tutorial do Python
@anchor{tutorial/venv doc}@anchor{1e81}@anchor{tutorial/venv translation-repo}@anchor{1e82}@anchor{tutorial/venv tut-venv}@anchor{1e83}@anchor{tutorial/venv virtual-environments-and-packages}@anchor{1e84}
@section Ambientes virtuais e pacotes


@menu
* Introdução: Introdução<4>. 
* Criando ambientes virtuais:: 
* Gerenciando pacotes com o pip:: 

@end menu

@node Introdução<4>,Criando ambientes virtuais,,Ambientes virtuais e pacotes
@anchor{tutorial/venv introduction}@anchor{1e85}
@subsection Introdução


Aplicações em Python normalmente usam pacotes e módulos que não vêm como parte da instalação padrão. Aplicações às vezes necessitam uma versão específica de uma biblioteca, porque ela requer que algum problema em particular tenha sido consertado ou foi escrita utilizando-se de uma versão obsoleta da interface da biblioteca.

Isso significa que talvez não seja possível que uma instalação Python preencha os requisitos de qualquer aplicação. Se uma aplicação A necessita a versão 1.0 de um módulo particular mas a aplicação B necessita a versão 2.0, os requisitos entrarão em conflito e instalar qualquer uma das duas versões 1.0 ou 2.0 fará com que uma das aplicações não consiga executar.

A solução para este problema é criar um @ref{1e86,,ambiente virtual}, uma árvore de diretórios que contém uma instalação Python para uma versão particular do Python, além de uma série de pacotes adicionais.

Diferentes aplicações podem então usar diferentes ambientes virtuais. Para resolver o exemplo anterior de requisitos conflitantes, a aplicação A deve ter seu próprio ambiente virtual com a versão 1.0 instalada enquanto a aplicação B vai possuir outro ambiente virtual com a versão 2.0. Se a aplicação B precisar fazer uma atualização para a versão 3.0, isso não afetará o ambiente da aplicação A.

@node Criando ambientes virtuais,Gerenciando pacotes com o pip,Introdução<4>,Ambientes virtuais e pacotes
@anchor{tutorial/venv creating-virtual-environments}@anchor{1e87}
@subsection Criando ambientes virtuais


O módulo usado para criar e gerenciar ambientes virtuais é chamado @ref{111,,venv}. @ref{111,,venv} instalará a versão do Python a partir da qual o comando foi executado (conforme relatado pela opção @ref{d3d,,--version}). Por exemplo, executar o comando com @code{python3.12} instalará a versão 3.12.

Para criar um ambiente virtual, escolha um diretório onde deseja colocá-lo e execute o módulo @ref{111,,venv} como um script com o caminho do diretório:

@example
python -m venv tutorial-env
@end example

Isso irá criar o diretório @code{tutorial-env} se ele não existir, e também criará diretórios dentro dele contendo uma cópia do interpretador Python, a biblioteca padrão e diversos arquivos de suporte.

Um diretório de localização comum para um ambiente virtual é @code{.venv}. Esse nome tipicamente mantém o diretório oculto em seu ambiente, portanto é transparente, ao menos tempo que explica o motivo desse diretório existir. Também previne conflitos com @code{.env}, arquivos de definição de variáveis de ambiente que algumas ferramentas utilizam.

Uma vez criado seu ambiente virtual, você deve ativá-lo.

No Windows, execute:

@example
tutorial-env\Scripts\activate
@end example

No Unix ou no MacOS, executa:

@example
source tutorial-env/bin/activate
@end example

(Este script é escrito para o shell bash. Se você usa shells @code{csh} ou @code{fish}, existem scripts alternativos @code{activate.csh} e @code{activate.fish} para utilização.)

Ao ativar seu ambiente virtual haverá uma mudança no prompt do shell para mostrar qual ambiente virtual você está usando e modificará o ambiente para que quando você executar @code{python} ativar a versão e instalação do Python particular àquele ambiente. Por exemplo:

@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 desativar um ambiente virtual, digite:

@example
deactivate
@end example

no terminal.

@node Gerenciando pacotes com o pip,,Criando ambientes virtuais,Ambientes virtuais e pacotes
@anchor{tutorial/venv managing-packages-with-pip}@anchor{1e88}
@subsection Gerenciando pacotes com o pip


Você pode instalar, atualizar e remover pacotes usando um programa chamado @code{pip}. Por padrão @code{pip} irá instalar pacotes do Python Package Index@footnote{https://pypi.org}. Você pode navegar pelo Python Package Index através do seu navegador web.

@code{pip} tem uma série de subcomandos: “install”, “uninstall”, “freeze”, etc. (Consulte o guia @ref{f27,,Instalando módulos Python} para a documentação completa do @code{pip}.)

Você pode instalar a última versão de um pacote apenas especificando nome do pacote:

@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

Você também pode instalar uma versão específica de um pacote dando o nome do pacote seguido por @code{==} e o número da versão:

@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

Se você executar novamente o comando, @code{pip} será notificado de que a versão já está instalada, e não fará nada. Você pode fornecer um número de versão diferente para obter essa versão ou pode executar @code{python -m pip install --upgrade} para atualizar o pacote para a versão mais recente:

@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{python -m pip uninstall} seguido por um ou mais nomes de pacote removerá os pacotes do ambiente virtual.

@code{python -m pip show} exibirá informações sobre um pacote específico:

@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} exibirá todos os pacotes instalados no ambiente 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} produzirá uma lista semelhante dos pacotes instalados, mas a saída usa o formato que @code{python -m pip install} espera. Uma convenção comum é colocar esta lista em um arquivo @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

O arquivo @code{requirements.txt} pode ser submetido no controle de versão e adicionado como parte da aplicação. Usuários poderão então instalar todos os pacotes necessários com um @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} tem inúmeras outras opções. Consulte o guia @ref{f27,,Instalando módulos Python} para a documentação completa do @code{pip}. Quando você escrever um pacote e desejar deixá-lo disponível no Python Package Index, consulte o guia de usuário para empacotamento de Python@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}.

@node E agora?,Edição de entrada interativa e substituição de histórico,Ambientes virtuais e pacotes,O tutorial do Python
@anchor{tutorial/whatnow doc}@anchor{1e89}@anchor{tutorial/whatnow translation-repo}@anchor{1e8a}@anchor{tutorial/whatnow tut-whatnow}@anchor{1e8b}@anchor{tutorial/whatnow what-now}@anchor{1e8c}
@section E agora?


Ler este tutorial provavelmente reforçou seu interesse em usar Python — você deve estar ansioso para aplicar Python para resolver problemas do mundo real. Aonde você deveria ir para aprender mais?

Este tutorial é parte do conjunto de documentação da linguagem Python. Alguns outros documentos neste conjunto são:


@itemize *

@item 
@ref{144,,A Biblioteca Padrão do Python}:

Você deveria navegar através deste manual, que lhe dará material completo (ainda que breve) de referência sobre tipos, funções e módulos na biblioteca padrão. A distribuição padrão do Python inclui `muito' código adicional. Há módulos para ler caixa de correio Unix, baixar documentos via HTTP, gerar números aleatórios, processar opções de linha de comando, comprimir dados a muitas outras tarefas. Uma lida rápida da Referência da Biblioteca lhe dará uma ideia do que está disponível.

@item 
@ref{f27,,Instalando módulos Python} explica como instalar módulos adicionais escritos por outros usuários de Python.

@item 
@ref{145,,A Referência da Linguagem Python}: Uma explicação detalhada da sintaxe e da semântica de Python. É uma leitura pesada, mas é útil como um guia completo da linguagem propriamente dita.
@end itemize

Mais recursos Python:


@itemize *

@item 
@indicateurl{https://www.python.org}: o principal site sobre Python. Contém código, documentação, e referências para outras páginas relacionadas a Python ao redor da web.

@item 
@indicateurl{https://docs.python.org}: acesso rápido à documentação Python.

@item 
@indicateurl{https://pypi.org}: O Python Package Index, anteriormente apelidado de Cheese Shop @footnote{
“Cheese Shop” é o título de um quadro do grupo Monty Python: um freguês entra em uma loja especializada em queijos, mas qualquer queijo que ele pede, o balconista diz que está em falta.
}, é um índice de módulos Python criados pelos usuários. Uma vez que você começa a publicar código, pode registrar seus pacotes aqui para que outros possam encontrá-los.

@item 
@indicateurl{https://code.activestate.com/recipes/langs/python/}: O Python Cookbook (livro de receitas de Python) é uma grande coleção de exemplos de código, módulos maiores e scripts úteis.Contribuições particularmente notáveis são coletadas em um livro também chamado Python Cookbook (O’Reilly & Associates, ISBN 0-596-00797-3.)

@item 
@indicateurl{https://pyvideo.org} coleta links para vídeo relacionados a Python de conferências e reuniões de grupos de usuários.

@item 
@indicateurl{https://scipy.org}: o projeto Scientific Python ( Python Científico) inclui módulos para computação e manipulação rápida de vetores e também hospeda pacotes para coisas similares como álgebra linear, transformações de Fourier, resolvedores não-lineares, distribuições de números aleatórios, análise estatística e afins.
@end itemize

Para reportar questões e problemas relacionadas a Python, você pode postar no newsgroup @code{comp.lang.python} ou enviá-los para o grupo de e-mail em @email{python-list@@python.org}. O newsgroup e a lista são conectados, então mensagens postadas em um são automaticamente encaminhadas ao outro. Há centenas de postagem diárias perguntando (e respondendo) perguntas, sugerindo novas funcionalidades e anunciando novos módulos. E-mails arquivados estão disponíveis em @indicateurl{https://mail.python.org/pipermail/}. Existe também o grupo de discussão da comunidade brasileira de Python: python-brasil no Google Groups (@indicateurl{http://groups.google.com/group/python-brasil}), com discussões de ótimo nível técnico.

Antes de postar, certifique-se de checar a lista de @ref{1e8d,,perguntas frequentes} (também chamada de FAQ). O FAQ responde muitas das perguntas que aparecem com frequência e pode já conter a solução para o seu problema.

@node Edição de entrada interativa e substituição de histórico,Aritmética de ponto flutuante problemas e limitações,E agora?,O tutorial do Python
@anchor{tutorial/interactive doc}@anchor{1e8e}@anchor{tutorial/interactive interactive-input-editing-and-history-substitution}@anchor{1e8f}@anchor{tutorial/interactive translation-repo}@anchor{1e90}@anchor{tutorial/interactive tut-interacting}@anchor{1d64}
@section Edição de entrada interativa e substituição de histórico


Algumas versões do interpretador Python suportam a edição da linha de entrada atual e a substituição da história, semelhante às habilidade encontradas no shell Korn e no shell GNU Bash. Isso é implementado usando a biblioteca GNU Readline@footnote{https://tiswww.case.edu/php/chet/readline/rltop.html}, que oferece suporte a vários estilos de edição. Esta biblioteca possui sua própria documentação, que não vamos duplicar aqui.

@menu
* Tab completion e histórico de edição:: 
* Alternativas ao interpretador interativo:: 

@end menu

@node Tab completion e histórico de edição,Alternativas ao interpretador interativo,,Edição de entrada interativa e substituição de histórico
@anchor{tutorial/interactive tab-completion-and-history-editing}@anchor{1e91}@anchor{tutorial/interactive tut-keybindings}@anchor{1e92}
@subsection Tab completion e histórico de edição


A conclusão (“completion”) dos nomes de variáveis e módulos é @ref{fff,,ativado automaticamente} na inicialização do interpretador para que a tecla @code{Tab} invoque a função de conclusão. Ele analisa os nomes das instruções Python, as variáveis locais atuais e os nomes dos módulos disponíveis. Para expressões pontilhadas como @code{string.a}, ele avaliará a expressão até o @code{'.'} final e então sugerirá conclusões dos atributos do objeto resultante. Observe que isso pode executar o código definido pela aplicação se um objeto com um método @ref{4d3,,__getattr__()} faz parte da expressão. A configuração padrão também guarda seu histórico em um arquivo chamado @code{.python_history} no seu diretório de usuário. O histórico estará disponível novamente durante a próxima sessão do interpretador interativo.

@node Alternativas ao interpretador interativo,,Tab completion e histórico de edição,Edição de entrada interativa e substituição de histórico
@anchor{tutorial/interactive alternatives-to-the-interactive-interpreter}@anchor{1e93}@anchor{tutorial/interactive tut-commentary}@anchor{1e94}
@subsection Alternativas ao interpretador interativo


Esta facilidade é um enorme passo em frente em comparação com as versões anteriores do interpretador; No entanto, alguns desejos são deixados: seria bom se um @ref{1e95,,INDENT} adequado fosse sugerido nas linhas de continuação (o analisador sabe se é necessário um token de recuo). O mecanismo de conclusão pode usar a tabela de símbolos do interpretador. Um comando para verificar (ou mesmo sugerir) parênteses, aspas, etc., também seria útil.

Um interpretador interativo aprimorado e alternativo que existe há algum tempo é o IPython@footnote{https://ipython.org/}, que apresenta a conclusão da guia, a exploração de objetos e o gerenciamento de histórico avançado. Também pode ser completamente personalizado e incorporado em outras aplicações. Outro ambiente interativo aprimorado similar é bpython@footnote{https://bpython-interpreter.org/}.

@c import math
@c from fractions import Fraction

@node Aritmética de ponto flutuante problemas e limitações,Anexo,Edição de entrada interativa e substituição de histórico,O tutorial do Python
@anchor{tutorial/floatingpoint doc}@anchor{1e96}@anchor{tutorial/floatingpoint floating-point-arithmetic-issues-and-limitations}@anchor{1e97}@anchor{tutorial/floatingpoint translation-repo}@anchor{1e98}@anchor{tutorial/floatingpoint tut-fp-issues}@anchor{1e99}
@section Aritmética de ponto flutuante: problemas e limitações


Os números de ponto flutuante são representados no hardware do computador como frações de base 2 (binárias). Por exemplo, a fração `decimal' @code{0.625} tem valor 6/10 + 2/100 + 5/1000, e da mesma forma a fração `binária' @code{0.101} tem valor 0/2 + 0/4 + 1/8. Essas duas frações têm valores idênticos, a única diferença real é que a primeira é escrita em notação fracionária de base 10 e a segunda em base 2.

Infelizmente, muitas frações decimais não podem ser representadas precisamente como frações binárias. O resultado é que, em geral, os números decimais de ponto flutuante que você digita acabam sendo armazenados de forma apenas aproximada, na forma de números binários de ponto flutuante.

O problema é mais fácil de entender primeiro em base 10. Considere a fração 1/3. Podemos representá-la aproximadamente como uma fração base 10:

@example
0.3
@end example

ou melhor,

@example
0.33
@end example

ou melhor,

@example
0.333
@end example

e assim por diante. Não importa quantos dígitos você está disposto a escrever, o resultado nunca será exatamente 1/3, mas será uma aproximação de cada vez melhor de 1/3.

Da mesma forma, não importa quantos dígitos de base 2 estejas disposto a usar, o valor decimal 0.1 não pode ser representado exatamente como uma fração de base 2. No sistema de base 2, 1/10 é uma fração binária que se repete infinitamente:

@example
0.0001100110011001100110011001100110011001100110011...
@end example

Se parares em qualquer número finito de bits, obterás uma aproximação. Hoje em dia, na maioria dos computadores, as casas decimais são aproximados usando uma fração binária onde o numerado utiliza os primeiros 53 bits iniciando no bit mais significativo e tendo como denominador uma potência de dois. No caso de 1/10, a fração binária seria @code{602879701896397 / 2 ** 55} o que chega bem perto, mas mesmo assim, não é igual ao valor original de 1/10.

É fácil esquecer que o valor armazenado é uma aproximação da fração decimal original, devido à forma como os pontos flutuantes são exibidos no interpretador interativo. O Python exibe apenas uma aproximação decimal do verdadeiro valor decimal da aproximação binária armazenada pela máquina. Se o Python exibisse o verdadeiro valor decimal da aproximação binária que representa o decimal 0.1, seria necessário mostrar:

@example
>>> 0.1
0.1000000000000000055511151231257827021181583404541015625
@end example

Isto contém muito mais dígitos do que é o esperado e utilizado pela grande maioria dos desenvolvedores, portanto, o Python limita o número de dígitos exibidos, apresentando um valor arredondado, ao invés de mostrar todas as casas decimais:

@example
>>> 1 / 10
0.1
@end example

Lembre-se, mesmo que o resultado impresso seja o valor exato de 1/10, o valor que verdadeiramente estará armazenado será uma fração binária representável que mais se aproxima.

Curiosamente, existem muitos números decimais diferentes que compartilham a mesma fração binária aproximada. Por exemplo, os números @code{0.1} ou o @code{0.10000000000000001} e @code{0.1000000000000000055511151231257827021181583404541015625} são todos aproximações de @code{3602879701896397 / 2 ** 55}. Como todos esses valores decimais compartilham um mesma de aproximação, qualquer um poderá ser exibido enquanto for preservado o invariante @code{eval(repr(x)) == x}.

Historicamente, o prompt do Python e a função embutida @ref{800,,repr()} utilizariam o que contivesse 17 dígitos significativos, @code{0.10000000000000001}. Desde a versão do Python 3.1, o Python (na maioria dos sistemas) agora é possível optar pela forma mais reduzida, exibindo simplesmente o número @code{0.1}.

Note que essa é a própria natureza do ponto flutuante binário: não é um bug do Python, e nem é um bug do seu código. Essa situação pode ser observada em todas as linguagens que usam as instruções aritméticas de ponto flutuante do hardware (apesar de algumas linguagens não `mostrarem' a diferença, por padrão, ou em todos os modos de saída).

Para obter um valor mais agradável, poderás utilizar a formatação de sequência de caracteres para produzir um número limitado de dígitos significativos:

@example
>>> format(math.pi, '.12g')  # ponto flutuante fornece 12 dígitos significativos
'3.14159265359'

>>> format(math.pi, '.2f')   # ponto flutuante fornece 2 dígitos significativos
'3.14'

>>> repr(math.pi)
'3.141592653589793'
@end example

É importante perceber que tudo não passa de pura ilusão: estas simplesmente arredondando a `exibição' da verdadeira maquinaria do valor.

Uma ilusão pode gerar outra. Por exemplo, uma vez que 0.1 não é exatamente 1/10, somar três vezes o valor 0.1, não garantirá que o resultado seja exatamente 0.3, isso porque:

@example
>>> 0.1 + 0.1 + 0.1 == 0.3
False
@end example

Inclusive, uma vez que o 0.1 não consegue aproximar-se do valor exato de 1/10 e 0.3 não pode se aproximar mais do valor exato de 3/10, temos então que o pré-arredondamento com a função @ref{131d,,round()} não servirá como ajuda:

@example
>>> round(0.1, 1) + round(0.1, 1) + round(0.1, 1) == round(0.3, 1)
False
@end example

Embora os números não possam se aproximar mais dos exatos valores que desejamos, a função @ref{dd8,,math.isclose()} poderá ser útil para comparar valores inexatos:

@example
>>> math.isclose(0.1 + 0.1 + 0.1, 0.3)
True
@end example

Alternativamente, a função @ref{131d,,round()} pode ser usada para comparar aproximações aproximadas:

@example
>>> round(math.pi, ndigits=2) == round(22 / 7, ndigits=2)
True
@end example

A aritmética binária de ponto flutuante contém muitas surpresas como essa. O problema com “0.1” é explicado em detalhes precisos abaixo, na seção “Erro de representação”. Consulte Exemplos de problemas de ponto flutuante@footnote{https://jvns.ca/blog/2023/01/13/examples-of-floating-point-problems/} (em inglês) para obter um resumo agradável de como o ponto flutuante binário funciona e os tipos de problemas comumente encontrados na prática. Veja também Os perigos do ponto flutuante@footnote{http://www.indowsway.com/floatingpoint.htm} (em inglês) para um relato mais completo de outras surpresas comuns.

Como dizemos perto do final, “não há respostas fáceis”. Ainda assim, não se percam indevidamente no uso do ponto flutuante! Os erros nas operações do tipo float do Python são heranças do hardware de ponto flutuante e, a maioria dos computadores estão na ordem de não mais do que 1 parte em 2**53 por operação. Isso é mais do que o suficiente para a maioria das tarefas, portanto, é importante lembrar que não se trata de uma aritmética decimal e que toda operação com o tipo float poderá via a apresentar novos problemas referentes ao arredondamento.

Embora existam casos patológicos, na maior parte das vezes, terás como resultado final o valor esperado, se simplesmente arredondares a exibição final dos resultados para a quantidade de dígitos decimais que esperas a função @ref{44c,,str()} geralmente será o suficiente, e , para seja necessário um valor refinado, veja os especificadores de formato @ref{621,,str.format()} contido na seção @ref{13e2,,Sintaxe das strings de formato}.

Para as situações que exijam uma representação decimal exata, experimente o módulo @ref{36,,decimal} que possui, a implementação de uma adequada aritmética decimal bastante utilizada nas aplicações contábeis e pelas aplicações que demandam alta precisão.

Uma outra forma de obter uma aritmética exata tem suporte pelo módulo @code{fracções} que implementa a aritmética baseada em números racionais (portanto, os números fracionários como o 1/3 conseguem uma representação precisa).

Caso necessites fazer um intenso uso das operações de ponto flutuante, é importante que conheças o pacote NumPy e, também é importante dizer, que existem diversos pacotes destinados ao trabalho intenso com operações matemáticas e estatísticas que são fornecidas pelo projeto SciPy. Veja <@indicateurl{https://scipy.org}>.

O Python fornece ferramentas que podem ajudar nessas raras ocasiões em que realmente `faz' necessário conhecer o valor exato de um ponto flutuante. O método @ref{1e9a,,float.as_integer_ratio()} expressa o valor de um número do tipo float em sua forma fracionária:

@example
>>> x = 3.14159
>>> x.as_integer_ratio()
(3537115888337719, 1125899906842624)
@end example

Uma vez que a relação seja exata, será possível utiliza-la para obter, sem que haja quaisquer perda do valor original:

@example
>>> x == 3537115888337719 / 1125899906842624
True
@end example

O método @ref{1e9b,,float.hex()} expressa um ponto flutuante em hexadecimal (base 16), o mesmo também retornará o valor exato pelo computador:

@example
>>> x.hex()
'0x1.921f9f01b866ep+1'
@end example

Sua precisa representação hexadecimal poderá ser utilizada para reconstruir o valor exato do ponto flutuante:

@example
>>> x == float.fromhex('0x1.921f9f01b866ep+1')
True
@end example

Como a representação será exata, é interessante utilizar valores confiáveis em diferentes versões do Python (independente da plataforma) e a troca de dados entre idiomas diferentes que forneçam o mesmo formato (como o Java e o C99).

Uma outra ferramenta que poderá ser útil é a função @ref{46a,,sum()} que ajuda a mitigar a perda de precisão durante a soma. Ele usa precisão estendida para etapas intermediárias de arredondamento, pois os valores serão adicionados a um total em execução. Isso poderá fazer a diferença na precisão geral de forma que os erros não se acumulem chegando ao ponto de afetar o resultado 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

A função @ref{141b,,math.fsum()} vai além e rastreia todos os “dígitos perdidos” à medida que os valores são adicionados a um total contínuo, de modo que o resultado tenha apenas um único arredondamento. Isso é mais lento que @ref{46a,,sum()}, mas será mais preciso em casos incomuns em que entradas de grande magnitude se cancelam, deixando uma soma final próxima de zero:

@example
>>> arr = [-0.10430216751806065, -266310978.67179024, 143401161448607.16,
...        -143401161400469.7, 266262841.31058735, -0.003244936839808227]
>>> float(sum(map(Fraction, arr)))   # Soma exata com arredondamento simples
8.042173697819788e-13
>>> math.fsum(arr)                   # Arredondamento simples
8.042173697819788e-13
>>> sum(arr)                         # Arredondamentos múltiplos em precisão estendida
8.042178034628478e-13
>>> total = 0.0
>>> for x in arr:
...     total += x                   # Arredondamentos múltiplos em precisão padrão
...
>>> total                            # A adição direta não tem dígitos corretos!
-0.0051575902860057365
@end example

@menu
* Erro de representação:: 

@end menu

@node Erro de representação,,,Aritmética de ponto flutuante problemas e limitações
@anchor{tutorial/floatingpoint representation-error}@anchor{1e9c}@anchor{tutorial/floatingpoint tut-fp-error}@anchor{1e9d}
@subsection Erro de representação


Esta seção explica o exemplo do “0.1” em detalhes, e mostra como poderás realizar uma análise exata de casos semelhantes. Presumimos que tenhas uma familiaridade básica com a representação binária de ponto flutuante.

`Erro de representação' refere-se ao fato de que algumas frações decimais (a maioria, na verdade) não podem ser representadas exatamente como frações binárias (base 2). Esta é a principal razão por que o Python (ou Perl, C, C++, Java, Fortran, e muitas outras) frequentemente não exibe o número decimal exato conforme o esperado:

Por que isso acontece? 1/10 não é representado exatamente sendo fração binária. Desde pelo menos 2000, quase todas as máquinas usam aritmética binária de ponto flutuante da IEEE 754 e quase todas as plataformas representam pontos flutuante do Python como valores binary64 de “double precision” (dupla precisão) da IEEE 754. Os valores binary64 da IEEE 754 têm 53 bits de precisão, por isso na entrada o computador se esforça para converter “0.1” para a fração mais próxima que puder, na forma `J'/2**`N' onde `J' é um número inteiro contendo exatamente 53 bits. Reescrevendo:

@example
1 / 10 ~= J / (2**N)
@end example

como

@example
J ~= 2**N / 10
@end example

e recordando que `J' tenha exatamente 53 bits (é @code{>= 2**52}, mas @code{< 2**53}), o melhor valor para `N' é 56:

@example
>>> 2**52 <=  2**56 // 10  < 2**53
True
@end example

Ou seja, 56 é o único valor de `N' que deixa `J' com exatamente 53 bits. Portanto, o melhor valor que conseguimos obter pra `J' será aquele que possui o quociente arredondado:

@example
>>> q, r = divmod(2**56, 10)
>>> r
6
@end example

Uma vez que o resto seja maior do que a metade de 10, a melhor aproximação que poderá ser obtida se arredondarmos para cima:

@example
>>> q+1
7205759403792794
@end example

Portanto, a melhor aproximação possível de 1/10 como um “IEEE 754 double precision” é:

@example
7205759403792794 / 2 ** 56
@end example

Dividir o numerador e o denominador por dois reduzirá a fração para:

@example
3602879701896397 / 2 ** 55
@end example

Note que, como arredondamos para cima, esse valor é, de fato, um pouco maior que 1/10; se não tivéssemos arredondado para cima, o quociente teria sido um pouco menor que 1/10. Mas em nenhum caso seria possível obter `exatamente' o valor 1/10!

Por isso, o computador nunca “vê” 1/10: o que ele vê é exatamente a fração que é obtida pra cima, a melhor aproximação “IEEE 754 double” possível é:

@example
>>> 0.1 * 2 ** 55
3602879701896397.0
@end example

Se multiplicarmos essa fração por 10**55, podemos ver o valor contendo os 55 dígitos mais significativos:

@example
>>> 3602879701896397 * 10 ** 55 // 2 ** 55
1000000000000000055511151231257827021181583404541015625
@end example

o que significa que o número exato armazenado no computador é igual ao valor decimal 0.1000000000000000055511151231257827021181583404541015625. Em vez de exibir o valor decimal completo, muitas linguagens (incluindo versões mais antigas do Python), arredondam o resultado para 17 dígitos significativos:

@example
>>> format(0.1, '.17f')
'0.10000000000000001'
@end example

Módulos como o @ref{5d,,fractions} e o @ref{36,,decimal} tornam esses cálculos muito mais fáceis:

@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 Anexo,,Aritmética de ponto flutuante problemas e limitações,O tutorial do Python
@anchor{tutorial/appendix doc}@anchor{1e9e}@anchor{tutorial/appendix appendix}@anchor{1e9f}@anchor{tutorial/appendix translation-repo}@anchor{1ea0}@anchor{tutorial/appendix tut-appendix}@anchor{1ea1}
@section Anexo


@menu
* Modo interativo: Modo interativo<2>. 

@end menu

@node Modo interativo<2>,,,Anexo
@anchor{tutorial/appendix interactive-mode}@anchor{1ea2}@anchor{tutorial/appendix tut-interac}@anchor{16f}
@subsection Modo interativo


Existem duas variantes do @ref{16a,,REPL} interativo. O interpretador básico clássico é compatível com todas as plataformas com recursos mínimos de controle de linha.

No Windows, ou em sistemas do tipo Unix com suporte a @ref{2b,,curses}, um novo console interativo é usado por padrão desde o Python 3.13. Este oferece suporte a cores, edição multilinha, navegação no histórico e modo de colagem. Para desabilitar a cor, veja @ref{16b,,Controlando cores} para detalhes. As teclas de função fornecem algumas funcionalidades adicionais. @code{F1} entra no navegador de ajuda interativo @ref{b5,,pydoc}. @code{F2} permite navegar no histórico da linha de comando sem saída nem os prompts @ref{16c,,>>>} e @ref{16d,,…}. @code{F3} entra no “modo de colagem”, o que torna mais fácil colar blocos maiores de código. Pressione @code{F3} para retornar ao prompt normal.

Ao usar o novo console interativo, saia do console digitando @code{exit} ou @code{quit}. Não é necessário adicionar parênteses de chamada após esses comandos.

Se o novo console interativo não for desejado, ele pode ser desabilitado através da variável de ambiente 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL}.

@menu
* Tratamento de erros:: 
* Scripts Python executáveis:: 
* Arquivo de inicialização do modo interativo:: 
* Módulos de customização:: 

@end menu

@node Tratamento de erros,Scripts Python executáveis,,Modo interativo<2>
@anchor{tutorial/appendix error-handling}@anchor{1ea3}@anchor{tutorial/appendix tut-error}@anchor{1ea4}
@subsubsection Tratamento de erros


Quando um erro ocorre, o interpretador exibe uma mensagem de erro e um `stack trace' (rastreamento de pilha). Se estiver no modo interativo, ele volta para o prompt primário; se a entrada veio de um arquivo, a execução termina com um status de saída diferente de zero após a exibição do `stack trace'. (Exceções tratadas por uma cláusula @ref{18b,,except} numa instrução @ref{6e9,,try} não são consideradas erros, nesse contexto.) Alguns erros são irremediavelmente graves e causam términos de execução com status de saída diferente de zero; isso pode ocorrer devido a inconsistências internas e, em alguns casos, por falta de memória. Todas as mensagens de erro são escritas no fluxo de erros padrão; a saída normal resultante da execução de comandos é escrita no fluxo de saída padrão.

Digitar o caractere de interrupção (geralmente @code{Control}-@code{C} ou @code{Delete}) em prompts primários ou secundários interrompe a entrada de dados e retorna ao prompt primário. @footnote{
Um problema com o pacote GNU Readline pode impedir que isso aconteça.
} Digitar a interrupção durante a execução de um comando levanta a exceção @ref{9d9,,KeyboardInterrupt}, que pode ser tratada por meio de uma declaração @ref{6e9,,try}.

@node Scripts Python executáveis,Arquivo de inicialização do modo interativo,Tratamento de erros,Modo interativo<2>
@anchor{tutorial/appendix executable-python-scripts}@anchor{1ea5}@anchor{tutorial/appendix tut-scripts}@anchor{1d6c}
@subsubsection Scripts Python executáveis


Em sistemas Unix similares ao BSD, scripts Python podem ser executados diretamente, tal como scripts shell, se tiverem a linha de código

@example
#!/usr/bin/env python3
@end example

(presumindo que o interpretador está na 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} do usuário) no começo do script e configurando o arquivo no modo executável. Os dois primeiros caracteres do arquivo devem ser @code{#!}. Em algumas plataformas, essa primeira linha deve terminar com uma quebra de linha em estilo Unix (@code{'\n'}), e não em estilo Windows (@code{'\r\n'}). Note que o caractere cerquilha, @code{'#'}, é usado em Python para marcar o início de um comentário.

O script pode receber a permissão para atuar em modo executável através do comando @code{chmod}.

@example
$ chmod +x meuscript.py
@end example

Em sistemas Windows, não existe a noção de “modo executável”. O instalador do Python associa automaticamente os arquivos @code{.py} ao @code{python.exe}, de modo que um clique duplo em um arquivo Python o executará como um script. A extensão pode ser também @code{.pyw}, o que omite a janela de console que normalmente aparece.

@node Arquivo de inicialização do modo interativo,Módulos de customização,Scripts Python executáveis,Modo interativo<2>
@anchor{tutorial/appendix the-interactive-startup-file}@anchor{1ea6}@anchor{tutorial/appendix tut-startup}@anchor{1ea7}
@subsubsection Arquivo de inicialização do modo interativo


Quando se usa o Python no modo interativo, pode ser útil definir alguns comandos que sejam executados automaticamente toda vez que o interpretador for inicializado. Isso pode ser feito configurando-se uma variável de ambiente chamada 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} para que ela aponte para o arquivo contendo esses comandos. Isso é similar ao recurso @code{.profile} das shells Unix.

Esse arquivo será lido apenas em sessões do modo interativo, e não quando Python lê comandos de um script, tampouco quando @code{/dev/tty} é passado explicitamente como a origem dos comandos (neste caso, teremos um comportamento similar a uma sessão interativa padrão). Ele é executado no mesmo espaço de nomes em que os comandos interativos são executados, de modo que os objetos que ele define ou importa possam ser usados sem qualificação na sessão interativa. Também é possível alterar os prompts @code{sys.ps1} e @code{sys.ps2} no mesmo arquivo.

Caso deseje usar um arquivo de inicialização adicional a partir do atual diretório de trabalho, você pode programá-lo no arquivo de inicialização global usando um código parecido com @code{if os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read())}. Se quiser usar o arquivo de inicialização num script, será necessário fazê-lo explicitamente no script:

@example
import osfilename = 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 Módulos de customização,,Arquivo de inicialização do modo interativo,Modo interativo<2>
@anchor{tutorial/appendix the-customization-modules}@anchor{1ea8}@anchor{tutorial/appendix tut-customize}@anchor{1ea9}
@subsubsection Módulos de customização


Python oferece dois ganchos que permitem sua customização: 
@geindex sitecustomize
sitecustomize e 
@geindex usercustomize
usercustomize. Para entender como funcionam, primeiro você deve localizar o diretório site-packages do usuário. Inicie o Python e execute este código:

@example
>>> import site>>> site.getusersitepackages()'/home/user/.local/lib/python3.x/site-packages'
@end example

Agora você pode criar um arquivo chamado @code{usercustomize.py} neste diretório e colocar qualquer coisa que quiser dentro. Isto vai afetar toda invocação do Python, a menos que seja iniciado com a opção @ref{13d5,,-s} para desabilitar a importação automática.

@geindex sitecustomize
sitecustomize funciona da mesma forma, mas normalmente é criado por um administrador do computador no diretório site-packages global e é importado antes de 
@geindex usercustomize
usercustomize. Veja a documentação do módulo @ref{c7,,site} para mais detalhes.

@node Configurações e Uso do Python,A Referência da Linguagem Python,O tutorial do Python,Top
@anchor{using/index doc}@anchor{1eaa}@anchor{using/index python-setup-and-usage}@anchor{1eab}@anchor{using/index translation-repo}@anchor{1eac}@anchor{using/index using-index}@anchor{1ead}
@chapter Configurações e Uso do Python


Esta parte da documentação é dedicada a informações gerais sobre a configuração do ambiente Python em diferentes plataformas, a chamada do interpretador e outras coisas que facilitam o trabalho com o Python.

@c ATTENTION: You probably should update Misc/python.man, too, if you modify
@c this file.

@menu
* Linha de comando e ambiente:: 
* Utilizando Python em plataformas Unix:: 
* Configurando o Python:: 
* Utilizando Python no Windows:: 
* Usando Python em macOS:: 
* Utilizando Python no Android:: 
* Usando Python no iOS:: 
* Editores e IDEs:: 

@end menu

@node Linha de comando e ambiente,Utilizando Python em plataformas Unix,,Configurações e Uso do Python
@anchor{using/cmdline doc}@anchor{1eae}@anchor{using/cmdline command-line-and-environment}@anchor{1eaf}@anchor{using/cmdline using-on-general}@anchor{1b36}
@section Linha de comando e ambiente


O interpretador do CPython verifica a linha de comando e o ambiente em busca de várias configurações.

Os esquemas de linha de comando de outras implementações podem ser diferentes. Consulte @ref{1eb0,,Implementações Alternativas} para mais recursos.

@menu
* Linha de comando:: 
* Variáveis de ambiente:: 

@end menu

@node Linha de comando,Variáveis de ambiente,,Linha de comando e ambiente
@anchor{using/cmdline command-line}@anchor{1eb1}@anchor{using/cmdline using-on-cmdline}@anchor{103d}
@subsection Linha de comando


Ao invocar o Python, você pode especificar qualquer uma destas opções:

@example
python [-bBdEhiIOPqRsSuvVWx?] [-c comando | -m nome-módulo | script | - ] [args]
@end example

O caso de uso mais comum é, obviamente, uma simples invocação de um script:

@example
python meuscript.py
@end example

@menu
* Opções de interface:: 
* Opções genéricas:: 
* Opções diversas:: 
* Controlando cores:: 
* Opções que você não deve usar:: 

@end menu

@node Opções de interface,Opções genéricas,,Linha de comando
@anchor{using/cmdline interface-options}@anchor{1eb2}@anchor{using/cmdline using-on-interface-options}@anchor{1eb3}
@subsubsection Opções de interface


A interface do interpretador é semelhante à do console do UNIX, mas fornece alguns métodos adicionais de chamada:


@itemize *

@item 
Quando chamado com a entrada padrão conectada a um dispositivo tty, ele solicita comandos e os executa até um EOF (um caractere de fim de arquivo, você pode produzi-lo com @code{Ctrl}-@code{D} no UNIX ou @code{Ctrl}-@code{Z,} @code{Enter} no Windows) ser lido. Para mais sobre o modo interativo, veja @ref{16f,,Modo interativo}.

@item 
Quando chamado com um argumento de nome de arquivo ou com um arquivo como entrada padrão, ele lê e executa um script desse arquivo.

@item 
Quando chamado com um argumento de nome de diretório, ele lê e executa um script nomeado adequadamente desse diretório.

@item 
Quando chamado com @code{-c command}, ele executa as instruções Python fornecidas como `command'. Aqui `command' pode conter várias instruções separadas por novas linhas. O espaço em branco à esquerda é significativo nas instruções do Python!

@item 
Quando chamado com @code{-m module-name}, o módulo fornecido está localizado no caminho do módulo Python e é executado como um script.
@end itemize

No modo não interativo, toda a entrada é analisada antes de ser executada.

Uma opção de interface termina a lista de opções consumidas pelo interpretador, todos os argumentos consecutivos terminam em @ref{12a6,,sys.argv} – observe que o primeiro elemento, subscrito zero (@code{sys.argv[0]}) , é uma string que reflete a fonte do programa.

@geindex opção de linha de comando; -c
@anchor{using/cmdline cmdoption-c}@anchor{5e0}
@deffn {Option} @w{-}c <command>

Executa o código Python em `command'. `command' pode ser uma ou mais instruções separadas por novas linhas, com espaços em branco à esquerda significativos, como em um código de um módulo normal.

Se esta opção for fornecida, o primeiro elemento de @ref{12a6,,sys.argv} será @code{"-c"} e o diretório atual será adicionado ao início de @ref{3b4,,sys.path} (permitindo módulos nesse diretório serem importados como módulos de nível superior).

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_command} com o argumento @code{command}.
@end deffn

@geindex opção de linha de comando; -m
@anchor{using/cmdline cmdoption-m}@anchor{5e1}
@deffn {Option} @w{-}m <module@w{-}name>

Procura @ref{3b4,,sys.path} pelo módulo nomeado e executa seu conteúdo como o módulo @ref{1,,__main__}.

Como o argumento é um nome de `module', você não deve fornecer uma extensão de arquivo (@code{.py}). O nome do módulo deve ser um nome de módulo Python absoluto válido, mas a implementação nem sempre pode impor isso (por exemplo, pode permitir que você use um nome que inclua um hífen).

Nomes de pacotes (incluindo pacotes de espaço de nomes) também são permitidos. Quando um nome de pacote é fornecido ao invés de um módulo normal, o interpretador irá executar @code{<pkg>.__main__} como o módulo principal. Esse comportamento é deliberadamente semelhante ao tratamento de diretórios e arquivos zip que são passados para o interpretador como o argumento do script.

@cartouche
@quotation Nota 
Esta opção não pode ser usada com módulos embutidos e módulos de extensão escritos em C, uma vez que eles não possuem arquivos de módulo Python. No entanto, ele ainda pode ser usado para módulos pré-compilados, mesmo se o arquivo fonte original não estiver disponível.
@end quotation
@end cartouche

Se esta opção for fornecida, o primeiro elemento de @ref{12a6,,sys.argv} será o caminho completo para o arquivo do módulo (enquanto o arquivo do módulo está sendo localizado, o primeiro elemento será definido como @code{"-m"}). Como com a opção @ref{5e0,,-c}, o diretório atual será adicionado ao início de @ref{3b4,,sys.path}.

A opção @ref{965,,-I} pode ser usada para executar o script em modo isolado onde @ref{3b4,,sys.path} não contém nem o diretório atual nem o diretório de pacotes de sites do usuário. Todas as variáveis de ambiente @code{PYTHON*} são ignoradas também.

Muitos módulos de biblioteca padrão contêm código que é chamado em sua execução como um script. Um exemplo é o módulo @ref{ef,,timeit}:

@example
python -m timeit -s "configuração inicial aqui" "código a ser analisado aqui"
python -m timeit -h # para detalhes
@end example

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_module} com o argumento @code{module-name}.


@subsubheading Ver também



@table @asis

@item @ref{1922,,runpy.run_module()}

Funcionalidade equivalente diretamente disponível para o código Python
@end table

@geindex Propostas de Melhorias do Python; PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} – Executando módulos como scripts



Alterado na versão 3.1: Forneça o nome do pacote para executar um submódulo @code{__main__}.



Alterado na versão 3.4: pacotes de espaço de nomes também são suportados

@end deffn

@anchor{using/cmdline cmdarg-dash}@anchor{1eb4}
@deffn {Describe} @w{-}

Lê os comandos da entrada padrão (@ref{53d,,sys.stdin}). Se a entrada padrão for um terminal, @ref{1523,,-i} está implícito.

Se esta opção for fornecida, o primeiro elemento de @ref{12a6,,sys.argv} será @code{"-"} e o diretório atual será adicionado ao início de @ref{3b4,,sys.path}.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_stdin} sem argumentos.
@end deffn

@anchor{using/cmdline cmdarg-script}@anchor{1eb5}
@deffn {Describe} <script>

Executa o código Python contido em `script', que deve ser um caminho do sistema de arquivos (absoluto ou relativo) referindo-se a um arquivo Python, um diretório contendo um arquivo @code{__main__.py}, ou um arquivo zip contendo um arquivo @code{__main__.py}.

Se esta opção for fornecida, o primeiro elemento de @ref{12a6,,sys.argv} será o nome do script conforme fornecido na linha de comando.

Se o nome do script se referir diretamente a um arquivo Python, o diretório que contém esse arquivo é adicionado ao início de @ref{3b4,,sys.path}, e o arquivo é executado como o módulo @ref{1,,__main__}.

Se o nome do script se referir a um diretório ou arquivo zip, o nome do script será adicionado ao início de @ref{3b4,,sys.path} e o arquivo @code{__main__.py} nesse local será executado como o módulo @ref{1,,__main__}.

A opção @ref{965,,-I} pode ser usada para executar o script em modo isolado onde @ref{3b4,,sys.path} não contém nem o diretório do script nem o diretório de pacotes de sites do usuário. Todas as variáveis de ambiente @code{PYTHON*} são ignoradas também.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_file} com o argumento @code{filename}.


@subsubheading Ver também



@table @asis

@item @ref{181,,runpy.run_path()}

Funcionalidade equivalente diretamente disponível para o código Python
@end table

@end deffn

Se nenhuma opção de interface for fornecida, @ref{1523,,-i} está implícito, @code{sys.argv[0]} é uma string vazia (@code{""}) e o diretório atual será adicionado ao início de @ref{3b4,,sys.path}. Além disso, o preenchimento por tab e a edição do histórico são habilitados automaticamente, se disponíveis em sua plataforma (veja @ref{fff,,Configuração Readline}).


@subsubheading Ver também


@ref{1d61,,Chamando o interpretador}



Alterado na versão 3.4: Ativação automática de preenchimento com tab e edição de histórico.


@node Opções genéricas,Opções diversas,Opções de interface,Linha de comando
@anchor{using/cmdline generic-options}@anchor{1eb6}@anchor{using/cmdline using-on-generic-options}@anchor{1eb7}
@subsubsection Opções genéricas


@geindex opção de linha de comando; -?
@geindex opção de linha de comando; -h
@geindex opção de linha de comando; --help
@anchor{using/cmdline cmdoption-0}@anchor{146f}
@deffn {Option} @w{-}?
@anchor{using/cmdline cmdoption-h}@anchor{1eb8}
@deffnx {Option} @w{-}h
@anchor{using/cmdline cmdoption-help}@anchor{5f0}
@deffnx {Option} @w{-}@w{-}help

Imprime uma breve descrição de todas as opções de linha de comando e variáveis de ambiente correspondentes e sai.
@end deffn

@geindex opção de linha de comando; --help-env
@anchor{using/cmdline cmdoption-help-env}@anchor{5f2}
@deffn {Option} @w{-}@w{-}help@w{-}env

Imprime uma breve descrição das variáveis de ambiente específicas do Python e sai.


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --help-xoptions
@anchor{using/cmdline cmdoption-help-xoptions}@anchor{5f3}
@deffn {Option} @w{-}@w{-}help@w{-}xoptions

Imprime uma descrição das opções @ref{176,,-X} específica da implementação e sai.


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --help-all
@anchor{using/cmdline cmdoption-help-all}@anchor{5f4}
@deffn {Option} @w{-}@w{-}help@w{-}all

Imprime as informações de uso completas e sai.


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; -V
@geindex opção de linha de comando; --version
@anchor{using/cmdline cmdoption-V}@anchor{177}
@deffn {Option} @w{-}V
@anchor{using/cmdline cmdoption-version}@anchor{d3d}
@deffnx {Option} @w{-}@w{-}version

Exibe o número da versão do Python e saia. O exemplo de saída poderia ser:

@example
Python 3.8.0b2+
@end example

Quando fornecido duas vezes, exibe mais informações sobre a construção, como:

@example
Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
[GCC 6.2.0 20161005]
@end example


Adicionado na versão 3.6: A opção @code{-VV}.

@end deffn

@node Opções diversas,Controlando cores,Opções genéricas,Linha de comando
@anchor{using/cmdline miscellaneous-options}@anchor{1eb9}@anchor{using/cmdline using-on-misc-options}@anchor{103e}
@subsubsection Opções diversas


@geindex opção de linha de comando; -b
@anchor{using/cmdline cmdoption-b}@anchor{5e3}
@deffn {Option} @w{-}b

Emite um aviso ao converter @ref{1c2,,bytes} ou @ref{2ea,,bytearray} para @ref{44c,,str} sem especificar codificação ou comparar @code{bytes} ou @code{bytearray} com @code{str} ou @code{bytes} com @ref{257,,int}. Emite um erro quando a opção é fornecida duas vezes (@code{-bb}).


Alterado na versão 3.5: Afeta também comparações de @ref{1c2,,bytes} com @ref{257,,int}.

@end deffn

@geindex opção de linha de comando; -B
@anchor{using/cmdline cmdoption-B}@anchor{1414}
@deffn {Option} @w{-}B

Se fornecido, Python não tentará escrever arquivos @code{.pyc} na importação de módulos fonte. Veja também 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE}.
@end deffn

@geindex opção de linha de comando; --check-hash-based-pycs
@anchor{using/cmdline cmdoption-check-hash-based-pycs}@anchor{1eba}
@deffn {Option} @w{-}@w{-}check@w{-}hash@w{-}based@w{-}pycs default|always|never

Controla o comportamento de validação de arquivos @code{.pyc} baseados em hash. Veja @ref{5ec,,Invalidação de bytecode em cache}. Quando definido como @code{default}, os arquivos de cache bytecode baseados em hash verificados e não verificados são validados de acordo com sua semântica padrão. Quando definido como @code{always}, todos os arquivos @code{.pyc} baseados em hash, sejam verificados ou não verificados, são validados para seus arquivos fonte correspondentes. Quando definido como @code{never}, os arquivos @code{.pyc} baseados em hash não são validados para seus arquivos fonte correspondentes.

A semântica dos arquivos @code{.pyc} baseados em marca de tempo não é afetada por esta opção.
@end deffn

@geindex opção de linha de comando; -d
@anchor{using/cmdline cmdoption-d}@anchor{1ebb}
@deffn {Option} @w{-}d

Ativa a saída analisador sintático de depuração (uso avançado). Consulte também a variável de ambiente 
@geindex PYTHONDEBUG
@geindex variável de ambiente; PYTHONDEBUG
@ref{1ebc,,PYTHONDEBUG}.

Essa opção requer uma @ref{1f9,,construção de depuração do Python}, caso contrário, será ignorada.
@end deffn

@geindex opção de linha de comando; -E
@anchor{using/cmdline cmdoption-E}@anchor{964}
@deffn {Option} @w{-}E

Ignora todas as variáveis de ambiente @code{PYTHON*}, por exemplo 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} e 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}, que pode ser definido.

Veja também as opções @ref{5a4,,-P} e @ref{965,,-I} (isolado).
@end deffn

@geindex opção de linha de comando; -i
@anchor{using/cmdline cmdoption-i}@anchor{1523}
@deffn {Option} @w{-}i

Entra no modo interativo após a execução.

Usanr a opção @ref{1523,,-i} vai entrar no modo interativo em qualquer uma das circunstâncias:


@itemize *

@item 
quando um script é passado como primeiro argumento

@item 
quando a opção @ref{5e0,,-c} é usada

@item 
quando a opção @ref{5e1,,-m} é usada
@end itemize

O modo interativo vai ser iniciado mesmo quando a @ref{53d,,sys.stdin} não parecer ser um terminal. O arquivo 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} não é lido.

Isso pode ser útil para inspecionar variáveis globais ou um stack trace (situação da pilha de execução) quando um script levanta uma exceção. Veja também 
@geindex PYTHONINSPECT
@geindex variável de ambiente; PYTHONINSPECT
@ref{1522,,PYTHONINSPECT}.
@end deffn

@geindex opção de linha de comando; -I
@anchor{using/cmdline cmdoption-I}@anchor{965}
@deffn {Option} @w{-}I

Executa o Python no modo isolado. Isso também implica nas opções @ref{964,,-E}, @ref{5a4,,-P} e @ref{13d5,,-s}.

No modo isolado, @ref{3b4,,sys.path} não contém o diretório do script nem o diretório de pacotes do site do usuário. Todas as variáveis de ambiente @code{PYTHON*} são ignoradas também. Outras restrições podem ser impostas para evitar que o usuário injete código malicioso.


Adicionado na versão 3.4.

@end deffn

@geindex opção de linha de comando; -O
@anchor{using/cmdline cmdoption-O}@anchor{ddd}
@deffn {Option} @w{-}O

Remove as instruções de asserção e qualquer código condicional ao valor de @ref{7db,,__debug__}. Aumenta o nome do arquivo para arquivos compilados (@ref{187,,bytecode}) adicionando @code{.opt-1} antes da extensão @code{.pyc} (veja 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}). Veja também 
@geindex PYTHONOPTIMIZE
@geindex variável de ambiente; PYTHONOPTIMIZE
@ref{1ebd,,PYTHONOPTIMIZE}.


Alterado na versão 3.5: Modifica nomes de arquivos @code{.pyc} conforme a 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}.

@end deffn

@geindex opção de linha de comando; -OO
@anchor{using/cmdline cmdoption-OO}@anchor{dde}
@deffn {Option} @w{-}OO

Faz o mesmo que @ref{ddd,,-O} e também descarta strings de documentação. Aumenta o nome do arquivo para arquivos compilados (@ref{187,,bytecode}) adicionando @code{.opt-2} antes da extensão @code{.pyc} (veja 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}).


Alterado na versão 3.5: Modifica nomes de arquivos @code{.pyc} conforme a 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}.

@end deffn

@geindex opção de linha de comando; -P
@anchor{using/cmdline cmdoption-P}@anchor{5a4}
@deffn {Option} @w{-}P

Não anexa um caminho potencialmente inseguro a @ref{3b4,,sys.path}:


@itemize *

@item 
A linha de comando @code{python -m módulo}: Não anexa o diretório atual.

@item 
A linha de comando @code{python script.py}: não anexa o diretório do script. Se for um link simbólico, resolve os links simbólicos.

@item 
Linhas de comando @code{python -c código} e @code{python} (REPL): Não anexa uma string vazia, o que significa o diretório de trabalho atual.
@end itemize

Veja também a variável de ambiente 
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH} e as opções @ref{964,,-E} e @ref{965,,-I} (isolado).


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; -q
@anchor{using/cmdline cmdoption-q}@anchor{15a5}
@deffn {Option} @w{-}q

Não exibe as mensagens de direitos autorais e de versão nem mesmo no modo interativo.


Adicionado na versão 3.2.

@end deffn

@geindex opção de linha de comando; -R
@anchor{using/cmdline cmdoption-R}@anchor{1c11}
@deffn {Option} @w{-}R

Habilita a aleatorização com hash. Esta opção só tem efeito se a variável de ambiente 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} estiver configurada para qualquer valor diferente de @code{random}, uma vez que a aleatorização com hash é habilitada por padrão.

Em versões anteriores do Python, esta opção ativa a aleatorização com hash, para que os valores @ref{b0e,,__hash__()} dos objetos str e bytes sejam “salgados” com um valor aleatório imprevisível. Embora permaneçam constantes em um processo Python individual, eles não são previsíveis entre invocações repetidas de Python.

A aleatorização com hash se destina a fornecer proteção contra uma negação de serviço causada por entradas cuidadosamente escolhidas que exploram o pior caso de desempenho de uma inserção de dicionário, complexidade `O'(`n'@w{^2}). Consulte @indicateurl{http://ocert.org/advisories/ocert-2011-003.html} para obter detalhes.

@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} permite que você defina um valor fixo para o segredo da semente de hash.


Adicionado na versão 3.2.3.



Alterado na versão 3.7: A opção não é mais ignorada.

@end deffn

@geindex opção de linha de comando; -s
@anchor{using/cmdline cmdoption-s}@anchor{13d5}
@deffn {Option} @w{-}s

Não adiciona o @code{diretório site-packages de usuário} a @ref{3b4,,sys.path}.

Veja também 
@geindex PYTHONNOUSERSITE
@geindex variável de ambiente; PYTHONNOUSERSITE
@ref{13d6,,PYTHONNOUSERSITE}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Diretório site-packages por usuário.

@end deffn

@geindex opção de linha de comando; -S
@anchor{using/cmdline cmdoption-S}@anchor{11e7}
@deffn {Option} @w{-}S

Desabilita a importação do módulo @ref{c7,,site} e as manipulações dependentes do site de @ref{3b4,,sys.path} que isso acarreta. Também desabilita essas manipulações se @ref{c7,,site} for explicitamente importado mais tarde (chame @ref{1ebe,,site.main()} se você quiser que eles sejam acionados).
@end deffn

@geindex opção de linha de comando; -u
@anchor{using/cmdline cmdoption-u}@anchor{1b1c}
@deffn {Option} @w{-}u

Força os fluxos stdout e stderr a serem sem buffer. Esta opção não tem efeito no fluxo stdin.

Veja também 
@geindex PYTHONUNBUFFERED
@geindex variável de ambiente; PYTHONUNBUFFERED
@ref{1b1d,,PYTHONUNBUFFERED}.


Alterado na versão 3.7: A camada de texto dos fluxos stdout e stderr agora é sem buffer.

@end deffn

@geindex opção de linha de comando; -v
@anchor{using/cmdline cmdoption-v}@anchor{146c}
@deffn {Option} @w{-}v

Exibe uma mensagem cada vez que um módulo é inicializado, mostrando o local (nome do arquivo ou módulo embutido) de onde ele é carregado. Quando fornecido duas vezes (@code{-vv}), exibe uma mensagem para cada arquivo que é verificado durante a busca por um módulo. Também fornece informações sobre a limpeza do módulo na saída.


Alterado na versão 3.10: O módulo @ref{c7,,site} relata os caminhos específicos do site e os arquivos @code{.pth} sendo processados.


Veja também 
@geindex PYTHONVERBOSE
@geindex variável de ambiente; PYTHONVERBOSE
@ref{1ebf,,PYTHONVERBOSE}.
@end deffn

@geindex opção de linha de comando; -W
@anchor{using/cmdline using-on-warnings}@anchor{1ec0}@anchor{using/cmdline cmdoption-W}@anchor{8cd}
@deffn {Option} @w{-}W arg

Controle de advertência. O mecanismo de aviso do Python por padrão exibe mensagens de aviso para @ref{940,,sys.stderr}.

As configurações mais simples aplicam uma determinada ação incondicionalmente a todos os avisos emitidos por um processo (mesmo aqueles que são ignorados por padrão):

@example
-Wdefault  # Avisa uma vez por local de chamada
-Werror    # Converte para exceções
-Walways   # Avisa toda vez
-Wall      # Mesmo que -Walways
-Wmodule   # Avisa uma vez por módulo chamador
-Wonce     # Avisa uma vez por processo do Python
-Wignore   # Nunca avisar
@end example

Os nomes das ações podem ser abreviados conforme desejado e o interpretador irá resolvê-los para o nome da ação apropriado. Por exemplo, @code{-Wi} é o mesmo que @code{-Wignore}.

A forma completa de argumento é:

@example
ação:mensagem:categoria:módulo:número-da-linha
@end example

Os campos vazios correspondem a todos os valores; campos vazios à direita podem ser omitidos. Por exemplo, @code{-W ignore::DeprecationWarning} ignora todos os avisos de DeprecationWarning.

O campo `action' é explicado acima, mas se aplica apenas a avisos que correspondem aos campos restantes.

O campo `message' deve corresponder a toda a mensagem de aviso; essa correspondência não diferencia maiúsculas de minúsculas.

O campo `category' corresponde à categoria de aviso (ex: @code{DeprecationWarning}). Deve ser um nome de classe; o teste de correspondência se a categoria de aviso real da mensagem é uma subclasse da categoria de aviso especificada.

O campo `module' corresponde ao nome do módulo (totalmente qualificado); esta correspondência diferencia maiúsculas de minúsculas.

O campo `lineno' corresponde ao número da linha, onde zero corresponde a todos os números da linha e, portanto, é equivalente a um número da linha omitido.

Múltiplas opções @ref{8cd,,-W} podem ser fornecidas; quando um aviso corresponde a mais de uma opção, a ação para a última opção correspondente é executada. As opções @ref{8cd,,-W} inválidas são ignoradas (embora, uma mensagem de aviso seja exibida sobre opções inválidas quando o primeiro aviso for emitido).

Os avisos também podem ser controlados usando a variável de ambiente 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} e de dentro de um programa Python usando o módulo @ref{112,,warnings}. Por exemplo, a função @ref{14f1,,warnings.filterwarnings()} pode ser usada para usar uma expressão regular na mensagem de aviso.

Veja @ref{8cf,,O filtro de avisos} e @ref{1ec1,,Descrevendo filtros de aviso} para mais detalhes.
@end deffn

@geindex opção de linha de comando; -x
@anchor{using/cmdline cmdoption-x}@anchor{1ec2}
@deffn {Option} @w{-}x

Pula a primeira linha do código-fonte, permitindo o uso de formas não-Unix de @code{#!cmd}. Isso se destina apenas a um hack específico do DOS.
@end deffn

@geindex opção de linha de comando; -X
@anchor{using/cmdline cmdoption-X}@anchor{176}
@deffn {Option} @w{-}X

Reservado para várias opções específicas de implementação. CPython atualmente define os seguintes valores possíveis:


@itemize *

@item 
@code{-X faulthandler} para habilitar @ref{58,,faulthandler}. Veja também 
@geindex PYTHONFAULTHANDLER
@geindex variável de ambiente; PYTHONFAULTHANDLER
@ref{10be,,PYTHONFAULTHANDLER}.


Adicionado na versão 3.3.


@item 
@code{-X showrefcount} para emitir a contagem de referências total e o número de blocos de memória usados quando o programa termina ou após cada instrução no interpretador interativo. Isso só funciona em @ref{1f9,,construções de depuração}.


Adicionado na versão 3.4.


@item 
@code{-X tracemalloc} para começar a rastrear alocações de memória do Python usando o módulo @ref{ff,,tracemalloc}. Por padrão, apenas o quadro mais recente é armazenado no traceback (situação da pilha de execução) de um rastro. Use @code{-X tracemalloc=NFRAME} para iniciar o rastreamento com um limite de traceback de quadros `NFRAME'. Veja o @ref{1ec3,,tracemalloc.start()} e 
@geindex PYTHONTRACEMALLOC
@geindex variável de ambiente; PYTHONTRACEMALLOC
@ref{1ec4,,PYTHONTRACEMALLOC} para mais informações.


Adicionado na versão 3.4.


@item 
@code{-X int_max_str_digits} configura a @ref{5f5,,limitação de comprimento de string na conversão para inteiro}. Veja também 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,PYTHONINTMAXSTRDIGITS}.


Adicionado na versão 3.11.


@item 
@code{-X importtime} para mostrar quanto tempo leva cada importação. Mostra o nome do módulo, tempo cumulativo (incluindo importações aninhadas) e tempo próprio (excluindo importações aninhadas). Observe que sua saída pode ser interrompida em aplicações multithread. O uso típico é @code{python3 -X importtime -c 'import asyncio'}.  Veja também 
@geindex PYTHONPROFILEIMPORTTIME
@geindex variável de ambiente; PYTHONPROFILEIMPORTTIME
@ref{b08,,PYTHONPROFILEIMPORTTIME}.


Adicionado na versão 3.7.


@item 
@code{-X dev}: habilita @ref{1f8,,Modo de Desenvolvimento do Python}, introduzindo verificações adicionais de tempo de execução que são muito custosas para serem habilitadas por padrão. Veja também 
@geindex PYTHONDEVMODE
@geindex variável de ambiente; PYTHONDEVMODE
@ref{b00,,PYTHONDEVMODE}.


Adicionado na versão 3.7.


@item 
@code{-X utf8} habilita o @ref{656,,Modo UTF-8 do Python}. @code{-X utf8=0} explicitamente desabilita o @ref{656,,Modo UTF-8 do Python} (mesmo quando de outra forma seria ativado automaticamente). Veja também 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8}.


Adicionado na versão 3.7.


@item 
@code{-X pycache_prefix=PATH} permite a escrita de arquivos @code{.pyc} em uma árvore paralela enraizada em um determinado diretório em vez de na árvore de código. Veja também 
@geindex PYTHONPYCACHEPREFIX
@geindex variável de ambiente; PYTHONPYCACHEPREFIX
@ref{9ab,,PYTHONPYCACHEPREFIX}.


Adicionado na versão 3.8.


@item 
@code{-X warn_default_encoding} emite uma @ref{1ec5,,EncodingWarning} quando a codificação padrão específica da localidade é usada para abrir arquivos. Veja também  
@geindex PYTHONWARNDEFAULTENCODING
@geindex variável de ambiente; PYTHONWARNDEFAULTENCODING
@ref{7bd,,PYTHONWARNDEFAULTENCODING}.


Adicionado na versão 3.10.


@item 
@code{-X no_debug_ranges} desabilita a inclusão das tabelas que mapeiam informações de localização extra (linha final, deslocamento da coluna inicial e deslocamento da coluna final) para cada instrução em objetos código. Isso é útil quando objetos código menores e arquivos pyc são desejados, bem como suprimir os indicadores de localização visual extra quando o interpretador exibe tracebacks (situação da pilha de execução). Veja também 
@geindex PYTHONNODEBUGRANGES
@geindex variável de ambiente; PYTHONNODEBUGRANGES
@ref{5b6,,PYTHONNODEBUGRANGES}.


Adicionado na versão 3.11.


@item 
@code{-X frozen_modules} determina se os módulos congelados são ou não ignorados pelo maquinário de importação. Um valor de @code{on} significa que eles são importados e @code{off} significa que eles são ignorados. O padrão é @code{on} se este for um Python instalado (o caso normal). Se estiver em desenvolvimento (executando a partir da árvore de origem), o padrão é @code{off}. Observe que os módulos congelados @code{importlib_bootstrap} e @code{importlib_bootstrap_external} são sempre usados, mesmo que esse sinalizador esteja definido como @code{off}. Veja também 
@geindex PYTHON_FROZEN_MODULES
@geindex variável de ambiente; PYTHON_FROZEN_MODULES
@ref{18e,,PYTHON_FROZEN_MODULES}.


Adicionado na versão 3.11.


@item 
@code{-X perf} habilita o suporte para o perfilador do Linux @code{perf}. Quando essa opção for fornecida, o perfilador @code{perf} poderá relatar chamadas Python. Essa opção está disponível apenas em algumas plataformas e não fará nada se não for compatível com o sistema atual. O valor padrão é “off”. Consulte também: 
@geindex PYTHONPERFSUPPORT
@geindex variável de ambiente; PYTHONPERFSUPPORT
@ref{46e,,PYTHONPERFSUPPORT} e @ref{18f,,Suporte do Python ao perfilador perf do Linux}.


Adicionado na versão 3.12.


@item 
@code{-X perf_jit} habilita o suporte para o perfilador do Linux @code{perf} com suporte a DWARF. Quando essa opção for fornecida, o perfilador @code{perf} poderá relatar chamadas Python usando informações de DWARF. Essa opção está disponível somente em algumas plataformas e não fará nada se não for compatível com o sistema atual. O valor padrão é “off”. Veja também: 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@ref{190,,PYTHON_PERF_JIT_SUPPORT} e @ref{18f,,Suporte do Python ao perfilador perf do Linux}.


Adicionado na versão 3.13.


@item 
@code{-X cpu_count=@var{n}} substitui @ref{1c5,,os.cpu_count()}, @ref{1c4,,os.process_cpu_count()} e @ref{fa3,,multiprocessing.cpu_count()}. `n' deve ser maior ou igual a 1. Esta opção pode ser útil para usuários que precisam limitar os recursos da CPU de um sistema contêiner. Veja também 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT}. Se `n' for @code{default}, nada será substituído.


Adicionado na versão 3.13.


@item 
@code{-X presite=@var{pacote.módulo}} especifica um módulo que deve ser importado antes do módulo @ref{c7,,site} ser executado e antes do módulo @ref{1,,__main__} existir. Portanto, o módulo importado não é @ref{1,,__main__}. Isso pode ser usado para executar código antes da inicialização do Python. Python precisa ser @ref{1f9,,construído no modo de depuração} para que esta opção exista. Veja também 
@geindex PYTHON_PRESITE
@geindex variável de ambiente; PYTHON_PRESITE
@ref{1ec6,,PYTHON_PRESITE}.


Adicionado na versão 3.13.


@item 
@code{-X gil=@var{0,1}} força a GIL a ser desabilitada ou habilitada, respectivamente. A definição para @code{0} está disponível apenas em construções configuradas com @ref{174,,--disable-gil}. Veja também 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL} e @ref{13f,,CPython com threads livres}.


Adicionado na versão 3.13.

@end itemize

Também permite passar valores arbitrários e recuperá-los através do dicionário @ref{1ec7,,sys._xoptions}.


Adicionado na versão 3.2.



Alterado na versão 3.9: Removida a opção @code{-X showalloccount}.



Alterado na versão 3.10: Removida a opção @code{-X oldparser}.

@end deffn

@node Controlando cores,Opções que você não deve usar,Opções diversas,Linha de comando
@anchor{using/cmdline controlling-color}@anchor{1ec8}@anchor{using/cmdline using-on-controlling-color}@anchor{16b}
@subsubsection Controlando cores


O interpretador Python é configurado por padrão para usar cores para destacar a saída em determinadas situações, como ao exibir tracebacks (situação da pilha de execução). Este comportamento pode ser controlado ao definir diferentes variáveis de ambiente.

Definir a variável de ambiente @code{TERM} como @code{dumb} desativará a exibição de cores.

Se a variável de ambiente FORCE_COLOR@footnote{https://force-color.org/} estiver definida, a cor será habilitada independentemente do valor de TERM. Isso é útil em sistemas CI que não são terminais, mas ainda podem exibir sequências de escape ANSI.

Se a variável de ambiente NO_COLOR@footnote{https://no-color.org/} estiver definida, o Python desativará todas as cores na saída. Isto tem precedência sobre @code{FORCE_COLOR}.

Todas essas variáveis de ambiente também são usadas por outras ferramentas para controlar a saída de cores. Para controlar a saída de cores apenas no interpretador Python, a variável de ambiente 
@geindex PYTHON_COLORS
@geindex variável de ambiente; PYTHON_COLORS
@ref{14a,,PYTHON_COLORS} pode ser usada. Esta variável tem precedência sobre @code{NO_COLOR}, que, por sua vez, tem precedência sobre @code{FORCE_COLOR}.

@c Apparently this how you hack together a formatted link:

@node Opções que você não deve usar,,Controlando cores,Linha de comando
@anchor{using/cmdline no-color}@anchor{1ec9}@anchor{using/cmdline options-you-shouldn-t-use}@anchor{1eca}
@subsubsection Opções que você não deve usar


@geindex opção de linha de comando; -J
@anchor{using/cmdline cmdoption-J}@anchor{1413}
@deffn {Option} @w{-}J

Reservado para uso pelo Jython@footnote{https://www.jython.org/}.
@end deffn

@node Variáveis de ambiente,,Linha de comando,Linha de comando e ambiente
@anchor{using/cmdline environment-variables}@anchor{1ecb}@anchor{using/cmdline using-on-envvars}@anchor{5f1}
@subsection Variáveis de ambiente


Essas variáveis de ambiente influenciam o comportamento do Python, elas são processadas antes das opções de linha de comando diferentes de -E ou -I. É comum que as opções de linha de comando substituam as variáveis de ambiente quando há um conflito.

@geindex variável de ambiente; PYTHONHOME
@anchor{using/cmdline envvar-PYTHONHOME}@anchor{3bc}
@deffn {Variável De Ambiente} PYTHONHOME

Altera a localização das bibliotecas padrão do  Python. Por padrão, as bibliotecas são pesquisadas em @code{`prefix'/lib/python`version'} e @code{`exec_prefix'/lib/python`version'}, onde @code{`prefix'} e @code{`exec_prefix'} são diretórios dependentes da instalação, ambos padronizados para @code{/usr/local}.

Quando 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} é definido como um único diretório, seu valor substitui @code{`prefix'} e @code{`exec_prefix'}. Para especificar valores diferentes para estes, defina 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} para @code{`prefix':`exec_prefix'}.
@end deffn

@geindex variável de ambiente; PYTHONPATH
@anchor{using/cmdline envvar-PYTHONPATH}@anchor{1053}
@deffn {Variável De Ambiente} PYTHONPATH

Aumenta o caminho de pesquisa padrão para arquivos de módulo. O formato é o mesmo da variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} do shell: um ou mais caminhos de diretório separados por @ref{1ecc,,os.pathsep} (por exemplo, dois pontos no Unix ou ponto e vírgula no Windows). Os diretórios inexistentes são ignorados silenciosamente.

Além dos diretórios normais, entradas individuais 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} podem referir-se a arquivos zip contendo módulos Python puros (tanto no código-fonte quanto na forma compilada). Módulos de extensão não podem ser importados de arquivos zip.

O caminho de pesquisa padrão depende da instalação, mas geralmente começa com @code{`prefix'/lib/python`version'} (veja 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} acima). É `sempre' anexado a 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}.

Um diretório adicional será inserido no caminho de pesquisa antes de 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}, conforme descrito acima em @ref{1eb3,,Opções de interface}. O caminho de pesquisa pode ser manipulado de partir de um programa em Python, por meio da variável @ref{3b4,,sys.path}.
@end deffn

@geindex variável de ambiente; PYTHONSAFEPATH
@anchor{using/cmdline envvar-PYTHONSAFEPATH}@anchor{5a5}
@deffn {Variável De Ambiente} PYTHONSAFEPATH

Se for definido como uma string não vazia, não anexa um caminho potencialmente inseguro à @ref{3b4,,sys.path}: consulte a opção @ref{5a4,,-P} para obter detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex variável de ambiente; PYTHONPLATLIBDIR
@anchor{using/cmdline envvar-PYTHONPLATLIBDIR}@anchor{1ab0}
@deffn {Variável De Ambiente} PYTHONPLATLIBDIR

Se for definida como uma string não vazia, ela substitui o valor @ref{93f,,sys.platlibdir}.


Adicionado na versão 3.9.

@end deffn

@geindex variável de ambiente; PYTHONSTARTUP
@anchor{using/cmdline envvar-PYTHONSTARTUP}@anchor{ffe}
@deffn {Variável De Ambiente} PYTHONSTARTUP

Se este for o nome de um arquivo legível, os comandos Python nesse arquivo serão executados antes que o primeiro prompt seja exibido no modo interativo. O arquivo é executado no mesmo espaço de nomes em que os comandos interativos são executados, para que os objetos definidos ou importados nele possam ser usados sem qualificação na sessão interativa. Você também pode alterar os prompts @ref{1ecd,,sys.ps1} e @ref{1ece,,sys.ps2}, bem como o gancho @ref{ffd,,sys.__interactivehook__}, neste arquivo.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_startup} com o nome de arquivo como argumento quando chamado na inicialização.
@end deffn

@geindex variável de ambiente; PYTHONOPTIMIZE
@anchor{using/cmdline envvar-PYTHONOPTIMIZE}@anchor{1ebd}
@deffn {Variável De Ambiente} PYTHONOPTIMIZE

Se for definido como uma string não vazia, é equivalente a especificar a opção @ref{ddd,,-O}. Se definido como um inteiro, é equivalente a especificar @ref{ddd,,-O} várias vezes.
@end deffn

@geindex variável de ambiente; PYTHONBREAKPOINT
@anchor{using/cmdline envvar-PYTHONBREAKPOINT}@anchor{aeb}
@deffn {Variável De Ambiente} PYTHONBREAKPOINT

Se estiver definida, ela nomeia um chamável usando a notação de caminho com pontos. O módulo que contém o chamável será importado e então o chamável será executado pela implementação padrão de @ref{aea,,sys.breakpointhook()} que é chamado pelo @ref{234,,breakpoint()} embutido. Se não for definido, ou definido como uma string vazia, é equivalente ao valor “pdb.set_trace”. Definir isso para a string “0” faz com que a implementação padrão de @ref{aea,,sys.breakpointhook()} não faça nada além de retornar imediatamente.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; PYTHONDEBUG
@anchor{using/cmdline envvar-PYTHONDEBUG}@anchor{1ebc}
@deffn {Variável De Ambiente} PYTHONDEBUG

Se for definido como uma string não vazia, é equivalente a especificar a opção @ref{1ebb,,-d}. Se definido como um inteiro, é equivalente a especificar @ref{1ebb,,-d} várias vezes.

Essa variável de ambiente requer uma @ref{1f9,,construção de depuração do Python}, caso contrário, será ignorada.
@end deffn

@geindex variável de ambiente; PYTHONINSPECT
@anchor{using/cmdline envvar-PYTHONINSPECT}@anchor{1522}
@deffn {Variável De Ambiente} PYTHONINSPECT

Se for definido como uma string não vazia, é equivalente a especificar a opção @ref{1523,,-i}.

Esta variável também pode ser modificada pelo código Python usando @ref{11f9,,os.environ} para forçar o modo de inspeção no encerramento do programa.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_stdin} sem argumentos.


Alterado na versão 3.12.5: (também 3.11.10, 3.10.15, 3.9.20 e 3.8.20) Emite eventos de auditoria.



Alterado na versão 3.13: Usa PyrePL, se possível, nesse caso 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} também é executado. Emite eventos de auditoria.

@end deffn

@geindex variável de ambiente; PYTHONUNBUFFERED
@anchor{using/cmdline envvar-PYTHONUNBUFFERED}@anchor{1b1d}
@deffn {Variável De Ambiente} PYTHONUNBUFFERED

Se for definido como uma string não vazia, é equivalente a especificar a opção @ref{1b1c,,-u}.
@end deffn

@geindex variável de ambiente; PYTHONVERBOSE
@anchor{using/cmdline envvar-PYTHONVERBOSE}@anchor{1ebf}
@deffn {Variável De Ambiente} PYTHONVERBOSE

Se for definido como uma string não vazia, é equivalente a especificar a opção @ref{146c,,-v}. Se definido como um inteiro, é equivalente a especificar @ref{146c,,-v} várias vezes.
@end deffn

@geindex variável de ambiente; PYTHONCASEOK
@anchor{using/cmdline envvar-PYTHONCASEOK}@anchor{963}
@deffn {Variável De Ambiente} PYTHONCASEOK

Se estiver definido, Python não diferencia letras maiúsculas e minúsculas nas instruções @ref{5e2,,import}. Isso só funciona no Windows e OS X.
@end deffn

@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@anchor{using/cmdline envvar-PYTHONDONTWRITEBYTECODE}@anchor{1415}
@deffn {Variável De Ambiente} PYTHONDONTWRITEBYTECODE

Se for definido como uma string não vazia, o Python não tentará escrever arquivos @code{.pyc} na importação de módulos fonte. Isso é equivalente a especificar a opção @ref{1414,,-B}.
@end deffn

@geindex variável de ambiente; PYTHONPYCACHEPREFIX
@anchor{using/cmdline envvar-PYTHONPYCACHEPREFIX}@anchor{9ab}
@deffn {Variável De Ambiente} PYTHONPYCACHEPREFIX

Se estiver definido, o Python escreverá os arquivos @code{.pyc} em uma árvore de diretório espelho neste caminho, em vez de nos diretórios @code{__pycache__} dentro da árvore de fontes. Isso é equivalente a especificar a opção @ref{176,,-X} @code{pycache_prefix=PATH}.


Adicionado na versão 3.8.

@end deffn

@geindex variável de ambiente; PYTHONHASHSEED
@anchor{using/cmdline envvar-PYTHONHASHSEED}@anchor{10b6}
@deffn {Variável De Ambiente} PYTHONHASHSEED

Se esta variável não for definida ou definida como @code{random}, um valor aleatório é usado para semear os hashes de objetos str e bytes.

Se 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} for definido como um valor inteiro, ele é usado como uma semente fixa para gerar o hash() dos tipos cobertos pela aleatorização do hash.

Sua finalidade é permitir hash repetível, como autotestes do próprio interpretador, ou permitir que um cluster de processos Python compartilhe valores de hash.

O número inteiro deve ser um número decimal no intervalo [0,4294967295]. Especificar o valor 0 desabilitará a aleatorização de hash.


Adicionado na versão 3.2.3.

@end deffn

@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@anchor{using/cmdline envvar-PYTHONINTMAXSTRDIGITS}@anchor{18c2}
@deffn {Variável De Ambiente} PYTHONINTMAXSTRDIGITS

Se esta variável estiver definida para um inteiro, é usada para configurar a @ref{5f5,,limitação de comprimento de string na conversão para inteiro} global do interpretador.


Adicionado na versão 3.11.

@end deffn

@geindex variável de ambiente; PYTHONIOENCODING
@anchor{using/cmdline envvar-PYTHONIOENCODING}@anchor{1040}
@deffn {Variável De Ambiente} PYTHONIOENCODING

Se for definido antes de executar o interpretador, ele substitui a codificação usada para stdin/stdout/stderr, na sintaxe @code{encodingname:errorhandler}. Ambas as partes @code{encodingname} e @code{:errorhandler} são opcionais e têm o mesmo significado que em @ref{8db,,str.encode()}.

Para stderr, a parte @code{:errorhandler} é ignorada; o tratador sempre será @code{'backslashreplace'}.


Alterado na versão 3.4: A parte @code{encodingname} é agora opcional.



Alterado na versão 3.6: No Windows, a codificação especificada por esta variável é ignorada para buffers de console interativo, a menos que 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@ref{c76,,PYTHONLEGACYWINDOWSSTDIO} também seja especificado. Arquivos e canais redirecionados por meio de fluxos padrão não são afetados.

@end deffn

@geindex variável de ambiente; PYTHONNOUSERSITE
@anchor{using/cmdline envvar-PYTHONNOUSERSITE}@anchor{13d6}
@deffn {Variável De Ambiente} PYTHONNOUSERSITE

Se estiver definido, o Python não adicionará o @ref{1ecf,,diretório site-packages do usuário} a @ref{3b4,,sys.path}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Diretório site-packages por usuário.

@end deffn

@geindex variável de ambiente; PYTHONUSERBASE
@anchor{using/cmdline envvar-PYTHONUSERBASE}@anchor{13d4}
@deffn {Variável De Ambiente} PYTHONUSERBASE

Define o @ref{1361,,diretório base do usuário}, que é usado para calcular o caminho do @ref{1ecf,,diretório site-packages do usuário} e @ref{1ed0,,caminhos de instalação} para @code{python -m pip install --user}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Diretório site-packages por usuário.

@end deffn

@geindex variável de ambiente; PYTHONEXECUTABLE
@anchor{using/cmdline envvar-PYTHONEXECUTABLE}@anchor{1ed1}
@deffn {Variável De Ambiente} PYTHONEXECUTABLE

Se esta variável de ambiente for definida, @code{sys.argv[0]} será definido com seu valor em vez do valor obtido através do tempo de execução C. Funciona apenas no macOS.
@end deffn

@geindex variável de ambiente; PYTHONWARNINGS
@anchor{using/cmdline envvar-PYTHONWARNINGS}@anchor{bc2}
@deffn {Variável De Ambiente} PYTHONWARNINGS

Isso é equivalente à opção @ref{8cd,,-W}. Se definido como uma string separada por vírgulas, é equivalente a especificar @ref{8cd,,-W} várias vezes, com os filtros posteriores na lista tendo precedência sobre os anteriores na lista.

As configurações mais simples aplicam uma determinada ação incondicionalmente a todos os avisos emitidos por um processo (mesmo aqueles que são ignorados por padrão):

@example
PYTHONWARNINGS=default  # Avisa uma vez por local de chamada
PYTHONWARNINGS=error    # Converte para exceções
PYTHONWARNINGS=always   # Avisa toda vez
PYTHONWARNINGS=all      # Mesmo que PYTHONWARNINGS=always
PYTHONWARNINGS=module   # Avisa uma vez por módulo chamador
PYTHONWARNINGS=once     # Avisa uma vez por processo do Python
PYTHONWARNINGS=ignore   # Nunca avisar
@end example

Veja @ref{8cf,,O filtro de avisos} e @ref{1ec1,,Descrevendo filtros de aviso} para mais detalhes.
@end deffn

@geindex variável de ambiente; PYTHONFAULTHANDLER
@anchor{using/cmdline envvar-PYTHONFAULTHANDLER}@anchor{10be}
@deffn {Variável De Ambiente} PYTHONFAULTHANDLER

Se esta variável de ambiente for definida como uma string não vazia, @ref{cbe,,faulthandler.enable()} é chamado na inicialização: instale um tratador para os sinais @ref{10b9,,SIGSEGV}, @ref{10ba,,SIGFPE}, @ref{10bb,,SIGABRT}, @ref{10bc,,SIGBUS} e @ref{10bd,,SIGILL} para despejar o traceback (situação da pilha de execução) do Python. Isso é equivalente à opção @ref{176,,-X} @code{faulthandler}.


Adicionado na versão 3.3.

@end deffn

@geindex variável de ambiente; PYTHONTRACEMALLOC
@anchor{using/cmdline envvar-PYTHONTRACEMALLOC}@anchor{1ec4}
@deffn {Variável De Ambiente} PYTHONTRACEMALLOC

Se esta variável de ambiente for definida como uma string não vazia, começa a rastrear as alocações de memória Python usando o módulo @ref{ff,,tracemalloc}. O valor da variável é o número máximo de quadros armazenados em um traceback de um rastreamento. Por exemplo, @code{PYTHONTRACEMALLOC=1} armazena apenas o quadro mais recente. Veja a função @ref{1ec3,,tracemalloc.start()} para mais informações. Isso é o equivalente a definir a opção @ref{176,,-X} @code{tracemalloc}.


Adicionado na versão 3.4.

@end deffn

@geindex variável de ambiente; PYTHONPROFILEIMPORTTIME
@anchor{using/cmdline envvar-PYTHONPROFILEIMPORTTIME}@anchor{b08}
@deffn {Variável De Ambiente} PYTHONPROFILEIMPORTTIME

Se esta variável de ambiente for definida como uma string não vazia, o Python mostrará quanto tempo leva cada importação. Isso é o equivalente a definir a opção @ref{176,,-X} @code{importtime}.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; PYTHONASYNCIODEBUG
@anchor{using/cmdline envvar-PYTHONASYNCIODEBUG}@anchor{1ed2}
@deffn {Variável De Ambiente} PYTHONASYNCIODEBUG

Se esta variável de ambiente for definida como uma string não vazia, habilita o @ref{1ed3,,modo de depuração} do módulo @ref{a,,asyncio}.


Adicionado na versão 3.4.

@end deffn

@geindex variável de ambiente; PYTHONMALLOC
@anchor{using/cmdline envvar-PYTHONMALLOC}@anchor{c7f}
@deffn {Variável De Ambiente} PYTHONMALLOC

Define os alocadores de memória Python e/ou instale ganchos de depuração.

Define a família de alocadores de memória usados pelo Python:


@itemize *

@item 
@code{default}: usa os @ref{1ed4,,alocadores padrão de memória}.

@item 
@code{malloc}: usa a função @code{malloc()} da biblioteca C para todos os domínios (@ref{1ed5,,PYMEM_DOMAIN_RAW}, @ref{c84,,PYMEM_DOMAIN_MEM}, @ref{c82,,PYMEM_DOMAIN_OBJ}).

@item 
@code{pymalloc}: usa o @ref{d31,,alocador pymalloc} para domínios @ref{c84,,PYMEM_DOMAIN_MEM} e @ref{c82,,PYMEM_DOMAIN_OBJ} e usa a função @code{malloc()} para o domínio @ref{1ed5,,PYMEM_DOMAIN_RAW}.

@item 
@code{mimalloc}: usa o @ref{1ed6,,alocador mimalloc} para domínios @ref{c84,,PYMEM_DOMAIN_MEM} e @ref{c82,,PYMEM_DOMAIN_OBJ} e usa a função @code{malloc()} para o domínio @ref{1ed5,,PYMEM_DOMAIN_RAW}.
@end itemize

Instala @ref{1ed7,,ganchos de depuração}:


@itemize *

@item 
@code{debug}: instala os ganchos de depuração sobre os @ref{1ed4,,alocadores padrão de memória}.

@item 
@code{malloc_debug}: o mesmo que @code{malloc}, mas também instala ganchos de depuração.

@item 
@code{pymalloc_debug}: o mesmo que @code{pymalloc}, mas também instala ganchos de depuração.

@item 
@code{mimalloc_debug}: o mesmo que @code{mimalloc}, mas também instala ganchos de depuração.
@end itemize


Adicionado na versão 3.6.



Alterado na versão 3.7: Adicionado o alocador @code{"default"}.

@end deffn

@geindex variável de ambiente; PYTHONMALLOCSTATS
@anchor{using/cmdline envvar-PYTHONMALLOCSTATS}@anchor{1cd0}
@deffn {Variável De Ambiente} PYTHONMALLOCSTATS

Se definido como uma string não vazia, o Python exibe estatísticas do @ref{d31,,alocador de memória pymalloc} toda vez que uma nova arena de objeto pymalloc for criada e ao no desligamento.

Esta variável é ignorada se a variável de ambiente 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} é usada para forçar o alocador @code{malloc()} da biblioteca C, ou se Python está configurado sem suporte a @code{pymalloc}.


Alterado na versão 3.6: Esta variável agora também pode ser usada em Python compilado no modo de lançamento. Agora não tem efeito se definido como uma string vazia.

@end deffn

@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSFSENCODING}@anchor{2af}
@deffn {Variável De Ambiente} PYTHONLEGACYWINDOWSFSENCODING

Se definido como uma string não vazia, o modo padrão do @ref{53b,,tratador de erros e codificação do sistema de arquivos} irá reverter para seus valores pré-3.6 de “mbcs” e “replace”, respectivamente. Caso contrário, os novos padrões “utf-8” e “surrogatepass” serão usados.

Isso também pode ser habilitado em tempo de execução com @ref{2ae,,sys._enablelegacywindowsfsencoding()}.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.6: Veja 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para mais detalhes.

@end deffn

@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSSTDIO}@anchor{c76}
@deffn {Variável De Ambiente} PYTHONLEGACYWINDOWSSTDIO

Se definido como uma string não vazia, não usa o novo leitor e escritor de console. Isso significa que os caracteres Unicode serão codificados de acordo com a página de código do console ativo, em vez de usar utf-8.

Esta variável é ignorada se os fluxos padrão forem redirecionados (para arquivos ou canais) em vez de se referir aos buffers do console.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.6.

@end deffn

@geindex variável de ambiente; PYTHONCOERCECLOCALE
@anchor{using/cmdline envvar-PYTHONCOERCECLOCALE}@anchor{ae5}
@deffn {Variável De Ambiente} PYTHONCOERCECLOCALE

Se definido com o valor @code{0}, faz com que a aplicação principal de linha de comando Python ignore a coerção dos códigos de idioma legados C e POSIX baseados em ASCII para uma alternativa baseada em UTF-8 mais capaz.

Se esta variável `não' estiver definida (ou estiver definida para um valor diferente de @code{0}), a variável de ambiente de substituição de localidade @code{LC_ALL} também não será definida, e a localidade atual relatada para a categoria @code{LC_CTYPE} é a localidade @code{C} padrão, ou então a localidade @code{POSIX} explicitamente baseada em ASCII, então a CLI do Python tentará configurar as seguintes localidades para a categoria @code{LC_CTYPE} na ordem listada antes de carregar o tempo de execução do interpretador:


@itemize *

@item 
@code{C.UTF-8}

@item 
@code{C.utf8}

@item 
@code{UTF-8}
@end itemize

Se a configuração de uma dessas categorias de local for bem-sucedida, a variável de ambiente @code{LC_CTYPE} também será configurada de acordo no ambiente de processo atual antes que o tempo de execução do Python seja inicializado. Isso garante que, além de ser visto pelo próprio interpretador e outros componentes com reconhecimento de localidade em execução no mesmo processo (como a biblioteca GNU @code{readline}), a configuração atualizada também é vista em subprocessos (independentemente de ou não esses processos estão executando um interpretador Python), bem como em operações que consultam o ambiente em vez da localidade C atual (como o @ref{2d9,,locale.getdefaultlocale()} do próprio Python).

Configurar uma dessas localidades (explicitamente ou por meio da coerção de localidade implícita acima) habilita automaticamente o @ref{18fa,,tratador de erros} @code{surrogateescape} para @ref{53d,,sys.stdin} e @ref{ae6,,sys.stdout} (@ref{940,,sys.stderr} continua a usar @code{backslashreplace} como faz em qualquer outra localidade). Este comportamento de tratamento de fluxo pode ser substituído usando 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} como de costume.

Para fins de depuração, definir @code{PYTHONCOERCECLOCALE=warn} fará com que o Python emita mensagens de aviso em @code{stderr} se a coerção de localidade for ativada ou se uma localidade que `teria' acionado a coerção ainda estiver ativa quando o Python o tempo de execução é inicializado.

Observe também que mesmo quando a coerção de localidade está desabilitada, ou quando não consegue encontrar uma localidade de destino adequada, 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8} ainda será ativado por padrão em localidades baseadas em ASCII legadas. Ambos os recursos devem ser desabilitados para forçar o interpretador a usar @code{ASCII} ao invés de @code{UTF-8} para interfaces de sistema.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.7: Veja 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} para mais detalhes.

@end deffn

@geindex variável de ambiente; PYTHONDEVMODE
@anchor{using/cmdline envvar-PYTHONDEVMODE}@anchor{b00}
@deffn {Variável De Ambiente} PYTHONDEVMODE

Se esta variável de ambiente for definida como uma string não vazia, habilita @ref{1f8,,Modo de Desenvolvimento do Python}, introduzindo verificações adicionais de tempo de execução que são muito caras para serem habilitadas por padrão. Isso é o equivalente a definir a opção @ref{176,,-X} @code{dev}.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; PYTHONUTF8
@anchor{using/cmdline envvar-PYTHONUTF8}@anchor{ae8}
@deffn {Variável De Ambiente} PYTHONUTF8

Se definido para @code{1}, habilita o @ref{656,,modo UTF-8 do Python}.

Se definido para @code{0}, desabilita o @ref{656,,modo UTF-8 do Python}.

Definir qualquer outra string não vazia causa um erro durante a inicialização do interpretador.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; PYTHONWARNDEFAULTENCODING
@anchor{using/cmdline envvar-PYTHONWARNDEFAULTENCODING}@anchor{7bd}
@deffn {Variável De Ambiente} PYTHONWARNDEFAULTENCODING

Se esta variável de ambiente for definida como uma string não vazia, emite uma @ref{1ec5,,EncodingWarning} quando a codificação padrão específica da localidade é usada.

Veja @ref{1ed9,,Ativar EncodingWarning} para detalhes.


Adicionado na versão 3.10.

@end deffn

@geindex variável de ambiente; PYTHONNODEBUGRANGES
@anchor{using/cmdline envvar-PYTHONNODEBUGRANGES}@anchor{5b6}
@deffn {Variável De Ambiente} PYTHONNODEBUGRANGES

Se esta variável estiver definida, ela desabilita a inclusão das tabelas que mapeiam informações de localização extra (linha final, deslocamento da coluna inicial e deslocamento da coluna final) para cada instrução em objetos código. Isso é útil quando objetos código menores e arquivos pyc são desejados, bem como suprimir os indicadores de localização visual extra quando o interpretador exibe tracebacks.


Adicionado na versão 3.11.

@end deffn

@geindex variável de ambiente; PYTHONPERFSUPPORT
@anchor{using/cmdline envvar-PYTHONPERFSUPPORT}@anchor{46e}
@deffn {Variável De Ambiente} PYTHONPERFSUPPORT

Se essa variável for definida como valor diferente de zero, ela habilitará suporte para o perfilador do Linux @code{perf} para que as chamadas Python possam ser detectadas por ele.

Se definido como @code{0}, desativa o suporte ao perfilador do Linux @code{perf}.

Consulte também a opção de linha de comando @ref{176,,-X perf} e @ref{18f,,Suporte do Python ao perfilador perf do Linux}.


Adicionado na versão 3.12.

@end deffn

@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@anchor{using/cmdline envvar-PYTHON_PERF_JIT_SUPPORT}@anchor{190}
@deffn {Variável De Ambiente} PYTHON_PERF_JIT_SUPPORT

Se essa variável for definida como valor diferente de zero, ela habilitará suporte para o perfilador do Linux @code{perf} para que as chamadas Python possam ser detectadas por ele usando informações de DWARF.

Se definido como @code{0}, desativa o suporte ao perfilador do Linux @code{perf}.

Veja também a opção de linha de comando @ref{176,,-X perf_jit} e @ref{18f,,Suporte do Python ao perfilador perf do Linux}.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_CPU_COUNT
@anchor{using/cmdline envvar-PYTHON_CPU_COUNT}@anchor{210}
@deffn {Variável De Ambiente} PYTHON_CPU_COUNT

Se esta variável for definida como um número inteiro positivo, ela substitui os valores de retorno de @ref{1c5,,os.cpu_count()} e @ref{1c4,,os.process_cpu_count()}.

Veja também a opção de linha de comando @ref{176,,-X cpu_count}.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_FROZEN_MODULES
@anchor{using/cmdline envvar-PYTHON_FROZEN_MODULES}@anchor{18e}
@deffn {Variável De Ambiente} PYTHON_FROZEN_MODULES

Se esta variável for definida como @code{on} ou @code{off}, ela determina se os módulos congelados serão ou não ignorados pela maquinário de importação. Um valor @code{on} significa que eles serão importados e @code{off} significa que serão ignorados. O padrão é @code{on} para construções sem depuração (o caso normal) e @code{off} para construções com depuração. Observe que os módulos congelados @code{importlib_bootstrap} e @code{importlib_bootstrap_external} são sempre usados, mesmo se este sinalizador estiver definido como @code{off}.

Veja também a opção de linha de comando @ref{176,,-X frozen_modules}.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_COLORS
@anchor{using/cmdline envvar-PYTHON_COLORS}@anchor{14a}
@deffn {Variável De Ambiente} PYTHON_COLORS

Se esta variável for definida como @code{1}, o interpretador irá colorir vários tipos de saída. Definir como @code{0} desativa este comportamento. Veja também @ref{16b,,Controlando cores}.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_BASIC_REPL
@anchor{using/cmdline envvar-PYTHON_BASIC_REPL}@anchor{16e}
@deffn {Variável De Ambiente} PYTHON_BASIC_REPL

Se esta variável for definida como qualquer valor, o interpretador não tentará carregar o @ref{16a,,REPL} baseado em Python que requer @ref{2b,,curses} e @ref{ba,,readline}, e em vez disso usará o @ref{16a,,REPL} com o analisador sintático tradicional.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_HISTORY
@anchor{using/cmdline envvar-PYTHON_HISTORY}@anchor{191}
@deffn {Variável De Ambiente} PYTHON_HISTORY

Esta variável de ambiente pode ser usada para definir a localização de um arquivo @code{.python_history} (por padrão, é @code{.python_history} no diretório inicial do usuário).


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_GIL
@anchor{using/cmdline envvar-PYTHON_GIL}@anchor{175}
@deffn {Variável De Ambiente} PYTHON_GIL

Se esta variável for definida como @code{1}, a trava global do interpretador (GIL) será forçada. Definir como @code{0} força a GIL a desligar (precisa do Python configurado com a opção de construção @ref{174,,--disable-gil}).

Veja também a opção de linha de comando @ref{176,,-X gil}, que tem precedência sobre esta variável, e @ref{13f,,CPython com threads livres}.


Adicionado na versão 3.13.

@end deffn

@geindex variável de ambiente; PYTHON_JIT
@anchor{using/cmdline envvar-PYTHON_JIT}@anchor{17b}
@deffn {Variável De Ambiente} PYTHON_JIT

Em construções onde a compilação experimental just-in-time está disponível, esta variável pode forçar o JIT a ser desabilitado (@code{0}) ou habilitado (@code{1}) na inicialização do interpretador.


Adicionado na versão 3.13.

@end deffn

@menu
* Variáveis de modo de depuração:: 

@end menu

@node Variáveis de modo de depuração,,,Variáveis de ambiente
@anchor{using/cmdline debug-mode-variables}@anchor{1eda}
@subsubsection Variáveis de modo de depuração


@geindex variável de ambiente; PYTHONDUMPREFS
@anchor{using/cmdline envvar-PYTHONDUMPREFS}@anchor{9ae}
@deffn {Variável De Ambiente} PYTHONDUMPREFS

Se definido, Python irá despejar objetos e contagens de referências ainda vivas após desligar o interpretador.

Precisa do Python configurado com a opção de construção @ref{395,,--with-trace-refs}.
@end deffn

@geindex variável de ambiente; PYTHONDUMPREFSFILE
@anchor{using/cmdline envvar-PYTHONDUMPREFSFILE}@anchor{19ca}
@deffn {Variável De Ambiente} PYTHONDUMPREFSFILE

Se definido, o Python irá despejar objetos e contagens de referências ainda ativas após desligar o interpretador em um arquivo no caminho fornecido como valor para esta variável de ambiente.

Precisa do Python configurado com a opção de construção @ref{395,,--with-trace-refs}.


Adicionado na versão 3.11.

@end deffn

@geindex variável de ambiente; PYTHON_PRESITE
@anchor{using/cmdline envvar-PYTHON_PRESITE}@anchor{1ec6}
@deffn {Variável De Ambiente} PYTHON_PRESITE

Se esta variável for definida como um módulo, esse módulo será importado no início do ciclo de vida do interpretador, antes do módulo @ref{c7,,site} ser executado, e antes do módulo @ref{1,,__main__} ser criado. Portanto, o módulo importado não é tratado como @ref{1,,__main__}.

Isso pode ser usado para executar código antecipadamente durante a inicialização do Python.

Para importar um submódulo, use @code{pacote.módulo} como valor, como em uma instrução de importação.

Veja também a opção de linha de comando @ref{176,,-X presite}, que tem precedência sobre esta variável.

Precisa do Python configurado com a opção de construção @ref{424,,--with-pydebug}.


Adicionado na versão 3.13.

@end deffn

@node Utilizando Python em plataformas Unix,Configurando o Python,Linha de comando e ambiente,Configurações e Uso do Python
@anchor{using/unix doc}@anchor{1edb}@anchor{using/unix translation-repo}@anchor{1edc}@anchor{using/unix using-on-unix}@anchor{1edd}@anchor{using/unix using-python-on-unix-platforms}@anchor{1ede}
@section Utilizando Python em plataformas Unix


@menu
* Obtendo e instalando a versão mais recente do Python:: 
* Compilando o Python:: 
* Paths e arquivos relacionados com o Python:: 
* Diversos: Diversos<2>. 
* OpenSSL personalizado:: 

@end menu

@node Obtendo e instalando a versão mais recente do Python,Compilando o Python,,Utilizando Python em plataformas Unix
@anchor{using/unix getting-and-installing-the-latest-version-of-python}@anchor{1edf}
@subsection Obtendo e instalando a versão mais recente do Python


@menu
* No Linux:: 
* No FreeBSD e OpenBSD:: 

@end menu

@node No Linux,No FreeBSD e OpenBSD,,Obtendo e instalando a versão mais recente do Python
@anchor{using/unix on-linux}@anchor{1ee0}
@subsubsection No Linux


O Python vem pré-instalado na maioria das distribuições Linux e está disponível como um pacote em todas as outras. No entanto, há certos recursos que você pode querer usar que não estão disponíveis no pacote da sua distribuição. Você pode compilar a versão mais recente do Python a partir do código-fonte.

No caso de a versão mais recente do Python não vir pré-instalada e não estar nos repositórios também, você pode criar pacotes para sua própria distro. Dê uma olhada nos seguintes links:


@subsubheading Ver também



@table @asis

@item @indicateurl{https://www.debian.org/doc/manuals/maint-guide/first.en.html}

para usuários Debian

@item @indicateurl{https://en.opensuse.org/Portal:Packaging}

para usuários OpenSuse

@item @indicateurl{https://docs.fedoraproject.org/en-US/package-maintainers/Packaging_Tutorial_GNU_Hello/}

para usuários Fedora

@item @indicateurl{https://slackbook.org/html/package-management-making-packages.html}

para usuários do Slackware
@end table


@menu
* Instalação do IDLE:: 

@end menu

@node Instalação do IDLE,,,No Linux
@anchor{using/unix installing-idle}@anchor{1ee1}@anchor{using/unix installing-idle-on-linux}@anchor{1ee2}
@subsubsection Instalação do IDLE


Em alguns casos, o IDLE pode não estar incluído em sua instalação do Python.


@itemize *

@item 
Para usuários do Debian e do Ubuntu:

@example
sudo apt update
sudo apt install idle
@end example

@item 
Para usuários do Fedora, RHEL e CentOS:

@example
sudo dnf install python3-idle
@end example

@item 
Para usuários do SUSE e do OpenSUSE:

@example
sudo zypper install python3-idle
@end example

@item 
Para usuários do Alpine Linux:

@example
sudo apk add python3-idle
@end example
@end itemize

@node No FreeBSD e OpenBSD,,No Linux,Obtendo e instalando a versão mais recente do Python
@anchor{using/unix on-freebsd-and-openbsd}@anchor{1ee3}
@subsubsection No FreeBSD e OpenBSD



@itemize *

@item 
usuários do FreeBSD, para adicionar a utilização do pacote utilize:

@example
pkg install python3
@end example

@item 
Usuários do OpenBSD, para adicionar pacotes 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 exemplo, usuários i386 podem pegar a versão 2.5.1 do Python usando o comando:

@example
pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz
@end example
@end itemize

@node Compilando o Python,Paths e arquivos relacionados com o Python,Obtendo e instalando a versão mais recente do Python,Utilizando Python em plataformas Unix
@anchor{using/unix building-python}@anchor{1ee4}@anchor{using/unix building-python-on-unix}@anchor{f25}
@subsection Compilando o Python


Se você quer compilar o CPython, a primeira coisa que você precisa fazer é baixar o código-fonte@footnote{https://www.python.org/downloads/source/}. Você pode baixar a última versão ou usar o git para fazer um clone@footnote{https://devguide.python.org/setup/#get-the-source-code}. (Se você pretende contribuir modificações, você vai precisar um “clone”.)

O processo de compilação consiste nos comandos usuais:

@example
./configure
make
make install
@end example

@ref{1ee5,,Opções de configuração} e advertências para plataformas específicas do Unix estão amplamente documentadas no arquivo README.rst@footnote{https://github.com/python/cpython/tree/3.13/README.rst} na raiz da árvore de fontes Python.

@cartouche
@quotation Aviso 
@code{make install} pode sobrescrever ou mascarar o arquivo binário @code{python3}. @code{make altinstall} é, portanto, recomendado ao invés de @code{make install} uma vez que o mesmo apenas instala o arquivo @code{`exec_prefix'/bin/python`version'}.
@end quotation
@end cartouche

@node Paths e arquivos relacionados com o Python,Diversos<2>,Compilando o Python,Utilizando Python em plataformas Unix
@anchor{using/unix python-related-paths-and-files}@anchor{1ee6}
@subsection Paths e arquivos relacionados com o Python


Estes estão sujeitos a diferenças dependendo das convenções de instalação local; @ref{1ee7,,prefix} e @ref{1ee8,,exec_prefix} dependem da instalação e devem ser interpretados da mesma forma que para o software GNU; eles poderão ser os mesmos.

Por exemplo, na maioria dos sistemas Linux, o padrão para ambos é @code{/usr}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Arquivo/diretório

@tab

Significado

@item

@code{`exec_prefix'/bin/python3}

@tab

Localização recomendada do interpretador.

@item

@code{`prefix'/lib/python`version'},
@code{`exec_prefix'/lib/python`version'}

@tab

A localização recomendada dos diretórios contendo os módulos padrão.

@item

@code{`prefix'/include/python`version'},
@code{`exec_prefix'/include/python`version'}

@tab

Localizações recomendadas dos diretórios contendo os arquivos de inclusão necessários para o desenvolvimento de extensões Python e incorporação do interpretador.

@end multitable


@node Diversos<2>,OpenSSL personalizado,Paths e arquivos relacionados com o Python,Utilizando Python em plataformas Unix
@anchor{using/unix miscellaneous}@anchor{1ee9}
@subsection Diversos


Para usar facilmente scripts Python no Unix, você precisa torná-los executáveis, por exemplo, com

@example
$ chmod +x script
@end example

e colocar uma linha Shebang apropriada no topo do script. Uma boa escolha normalmente é

@example
#!/usr/bin/env python3
@end example

que procura o interpretador do Python no conjunto 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. No entanto, alguns sistemas Unix podem não ter o comando @code{env}, então você pode precisar codificar @code{/usr/bin/python3} como o caminho do interpretador.

Para usar comandos Shell em seus scripts Python, veja o módulo @ref{d6,,subprocess}.

@node OpenSSL personalizado,,Diversos<2>,Utilizando Python em plataformas Unix
@anchor{using/unix custom-openssl}@anchor{1eea}@anchor{using/unix unix-custom-openssl}@anchor{1eeb}
@subsection OpenSSL personalizado



@enumerate 

@item 
Para usar a configuração OpenSSL do seu fornecedor e armazenamento confiável do sistema, localize o diretório com o arquivo @code{openssl.cnf} ou link simbólico em @code{/etc}. Na maioria das distribuições o arquivo está em @code{/etc/ssl} ou em @code{/etc/pki/tls}. O diretório também deve conter um arquivo @code{cert.pem} e/ou um diretório @code{certs}.

@example
$ find /etc/ -name openssl.cnf -printf "%h\n"
/etc/ssl
@end example

@item 
Baixe, construa e instale o OpenSSL. Certifique-se de usar @code{install_sw} e não @code{install}. O destino @code{install_sw} não substitui o @code{openssl.cnf}.

@example
$ curl -O https://www.openssl.org/source/openssl-VERSÃO.tar.gz
$ tar xzf openssl-VERSÃO
$ pushd openssl-VERSÃO
$ ./config \
    --prefix=/usr/local/custom-openssl \
    --libdir=lib \
    --openssldir=/etc/ssl
$ make -j1 depend
$ make -j8
$ make install_sw
$ popd
@end example

@item 
Construa o Python com o OpenSSL personalizado (veja as opções configure @code{--with-openssl} e @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 
As versões de patches do OpenSSL têm uma ABI compatível com versões anteriores. Você não precisa recompilar o Python para atualizar o OpenSSL. É suficiente substituir a instalação personalizada do OpenSSL por uma versão mais recente.
@end quotation
@end cartouche

@node Configurando o Python,Utilizando Python no Windows,Utilizando Python em plataformas Unix,Configurações e Uso do Python
@anchor{using/configure doc}@anchor{1eec}@anchor{using/configure configure-python}@anchor{1eed}@anchor{using/configure translation-repo}@anchor{1eee}
@section Configurando o Python


@menu
* Requisitos de construção:: 
* Arquivos gerados:: 
* Opções de configuração:: 
* Sistema de Construção Python:: 
* Sinalizadores do compilador e do vinculador:: 

@end menu

@node Requisitos de construção,Arquivos gerados,,Configurando o Python
@anchor{using/configure build-requirements}@anchor{1eef}
@subsection Requisitos de construção


Recursos e versões mínimas necessários para construir o CPython:


@itemize *

@item 
Um compilador C11@footnote{https://en.cppreference.com/w/c/11}. Não são necessários recursos opcionais do C11@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features}.

@item 
No Windows, é necessário o Microsoft Visual Studio 2017 ou posterior.

@item 
Suporte para números de ponto flutuante do IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754} e Not-a-Number (NaN) de ponto flutuante@footnote{https://en.wikipedia.org/wiki/NaN#Floating_point}.

@item 
Suporte a threads.

@item 
OpenSSL 1.1.1 é a versão mínima e OpenSSL 3.0.18 é a versão mínima recomendada para os módulos de extensão @ref{d0,,ssl} e @ref{68,,hashlib}.

@item 
SQLite 3.15.2 para o módulo de extensão @ref{cf,,sqlite3}.

@item 
Tcl/Tk 8.5.12 para o módulo @ref{f0,,tkinter}.

@item 
libmpdec@footnote{https://www.bytereef.org/mpdecimal/doc/libmpdec/} 2.5.0 para o módulo @ref{36,,decimal}.

@item 
Autoconf 2.71 e aclocal 1.16.5 são necessários para regenerar o script @code{configure}.
@end itemize


Alterado na versão 3.1: Agora é necessária a versão 8.3.1 do Tcl/Tk.



Alterado na versão 3.5: No Windows, agora é necessário o Visual Studio 2015 ou posterior. Agora é necessária a versão 8.4 do Tcl/Tk.



Alterado na versão 3.6: Recursos selecionados do C99 agora são necessários, como funções @code{<stdint.h>} e @code{static inline}.



Alterado na versão 3.7: Suporte a threads e OpenSSL 1.0.2 agora são necessários.



Alterado na versão 3.10: OpenSSL 1.1.1 agora é necessário. Requer SQLite 3.7.15.



Alterado na versão 3.11: Compilador C11, suporte a IEEE 754 e NaN agora são necessários. No Windows, é necessário o Visual Studio 2017 ou posterior. A versão 8.5.12 do Tcl/Tk agora é necessária para o módulo @ref{f0,,tkinter}.



Alterado na versão 3.13: Autoconf 2.71, aclocal 1.16.5 e SQLite 3.15.2 agora são necessários.


Veja também 
@geindex Propostas de Melhorias do Python; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} “Guia de estilo para código C” e 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} “Suporte do CPython a plataformas”.

@node Arquivos gerados,Opções de configuração,Requisitos de construção,Configurando o Python
@anchor{using/configure generated-files}@anchor{1ef0}
@subsection Arquivos gerados


Para reduzir as dependências de construção, o código-fonte do Python contém vários arquivos gerados. Comandos para regenerar todos os arquivos gerados:

@example
make regen-all
make regen-stdlib-module-names
make regen-limited-abi
make regen-configure
@end example

O arquivo @code{Makefile.pre.in} documenta os arquivos gerados, suas entradas e ferramentas usadas para regenerá-los. Procure por alvos @code{regen-*} de make.

@menu
* Script configure:: 

@end menu

@node Script configure,,,Arquivos gerados
@anchor{using/configure configure-script}@anchor{1ef1}
@subsubsection Script configure


O comando @code{make regen-configure} regera o arquivo @code{aclocal.m4} e o script @code{configure} usando o shell script @code{Tools/build/regen-configure.sh}, o qual usa um contêiner Ubuntu para obter as mesmas versões de ferramentas e ter uma saída reproduzível.

O contêiner é opcional, o seguinte comando pode ser executado localmente:

@example
autoreconf -ivf -Werror
@end example

Os arquivos gerados podem mudar dependendo das versões exatas do @code{autoconf-archive}, @code{aclocal} e @code{pkg-config}.

@node Opções de configuração,Sistema de Construção Python,Arquivos gerados,Configurando o Python
@anchor{using/configure configure-options}@anchor{1ee5}@anchor{using/configure id1}@anchor{1ef2}
@subsection Opções de configuração


Liste todas as opções do @code{configure} usando:

@example
./configure --help
@end example

Veja também o @code{Misc/SpecialBuilds.txt} na distribuição de código-fonte do Python.

@menu
* Opções gerais:: 
* Opções do compilador C:: 
* Opções da ligação:: 
* Opções para dependências de terceiros:: 
* Opções de WebAssembly:: 
* Opções de instalação:: 
* Opções de desempenho:: 
* Compilação de depuração do Python:: 
* Opções de depuração:: 
* Opções da ligação: Opções da ligação<2>. 
* Opções da biblioteca:: 
* Opções de segurança:: 
* Opções do macOS:: 
* Opções do iOS:: 
* Opções de compilação cruzada:: 

@end menu

@node Opções gerais,Opções do compilador C,,Opções de configuração
@anchor{using/configure general-options}@anchor{1ef3}
@subsubsection Opções gerais


@geindex opção de linha de comando; --enable-loadable-sqlite-extensions
@anchor{using/configure cmdoption-enable-loadable-sqlite-extensions}@anchor{1ef4}
@deffn {Option} @w{-}@w{-}enable@w{-}loadable@w{-}sqlite@w{-}extensions

Suporte a extensões carregáveis no módulo de extensão @code{_sqlite} (o padrão é não) do módulo @ref{cf,,sqlite3}.

Veja o método @ref{841,,sqlite3.Connection.enable_load_extension()} do módulo @ref{cf,,sqlite3}.


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --disable-ipv6
@anchor{using/configure cmdoption-disable-ipv6}@anchor{1ef5}
@deffn {Option} @w{-}@w{-}disable@w{-}ipv6

Desabilita suporte a IPv6 (habilitado por padrão se houver suporte), veja o módulo @ref{cc,,socket}.
@end deffn

@geindex opção de linha de comando; --enable-big-digits
@anchor{using/configure cmdoption-enable-big-digits}@anchor{74d}
@deffn {Option} @w{-}@w{-}enable@w{-}big@w{-}digits=[15|30]

Define o tamanho em bits dos dígitos de @ref{257,,int} do Python: 15 ou 30 bits.

Por padrão, o tamanho dos dígitos é 30.

Define o @code{PYLONG_BITS_IN_DIGIT} para @code{15} ou @code{30}.

Veja @ref{12d5,,sys.int_info.bits_per_digit}.
@end deffn

@geindex opção de linha de comando; --with-suffix
@anchor{using/configure cmdoption-with-suffix}@anchor{1ef6}
@deffn {Option} @w{-}@w{-}with@w{-}suffix=SUFFIX

Define o sufixo do executável do Python para `SUFFIX'.

O sufixo padrão é @code{.exe} no Windows e macOS (executável @code{python.exe}), @code{.js} em nó Emscripten, @code{.html} em navegador Emscripten, @code{.wasm} em WASI e uma string vazia em outras plataformas (executável @code{python}).


Alterado na versão 3.11: O sufixo padrão na plataforma WASM é um entre @code{.js}, @code{.html} ou @code{.wasm}

@end deffn

@geindex opção de linha de comando; --with-tzpath
@anchor{using/configure cmdoption-with-tzpath}@anchor{1ef7}
@deffn {Option} @w{-}@w{-}with@w{-}tzpath=<list of absolute paths separated by pathsep>

Seleciona o caminho de pesquisa de fuso horário padrão para @ref{1ef8,,zoneinfo.TZPATH}. Veja a @ref{1ef9,,Configuração de tempo de compilação} do módulo @ref{134,,zoneinfo}.

Padrão: @code{/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo}.

Veja o separador de caminhos @ref{1ecc,,os.pathsep}.


Adicionado na versão 3.9.

@end deffn

@geindex opção de linha de comando; --without-decimal-contextvar
@anchor{using/configure cmdoption-without-decimal-contextvar}@anchor{1efa}
@deffn {Option} @w{-}@w{-}without@w{-}decimal@w{-}contextvar

Constrói o módulo de extensão @code{_decimal} usando um contexto local de thread ao invés de um contexto local de corrotina (padrão), veja o módulo @ref{36,,decimal}.

Veja @ref{1efb,,decimal.HAVE_CONTEXTVAR} e o módulo @ref{24,,contextvars}.


Adicionado na versão 3.9.

@end deffn

@geindex opção de linha de comando; --with-dbmliborder
@anchor{using/configure cmdoption-with-dbmliborder}@anchor{1efc}
@deffn {Option} @w{-}@w{-}with@w{-}dbmliborder=<list of backend names>

Substitui a ordem de verificação de backends de banco de dados para o módulo @ref{31,,dbm}

Um valor válido é uma string separada por dois pontos (@code{:}) com os nomes de backend:


@itemize *

@item 
@code{ndbm};

@item 
@code{gdbm};

@item 
@code{bdb}.
@end itemize
@end deffn

@geindex opção de linha de comando; --without-c-locale-coercion
@anchor{using/configure cmdoption-without-c-locale-coercion}@anchor{1efd}
@deffn {Option} @w{-}@w{-}without@w{-}c@w{-}locale@w{-}coercion

Desabilita a coerção de localidade C para uma localidade baseada em UTF-8 (ativada por padrão).

Não define a macro @code{PY_COERCE_C_LOCALE}.

Consulte 
@geindex PYTHONCOERCECLOCALE
@geindex variável de ambiente; PYTHONCOERCECLOCALE
@ref{ae5,,PYTHONCOERCECLOCALE} e a 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}.
@end deffn

@geindex opção de linha de comando; --without-freelists
@anchor{using/configure cmdoption-without-freelists}@anchor{74c}
@deffn {Option} @w{-}@w{-}without@w{-}freelists

Desabilita todas as listas livres, exceto o singleton de tupla vazia.


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --with-platlibdir
@anchor{using/configure cmdoption-with-platlibdir}@anchor{1efe}
@deffn {Option} @w{-}@w{-}with@w{-}platlibdir=DIRNAME

Nome do diretório da biblioteca Python (o padrão é @code{lib}).

Fedora e SuSE usam @code{lib64} em plataformas de 64 bits.

Veja @ref{93f,,sys.platlibdir}.


Adicionado na versão 3.9.

@end deffn

@geindex opção de linha de comando; --with-wheel-pkg-dir
@anchor{using/configure cmdoption-with-wheel-pkg-dir}@anchor{891}
@deffn {Option} @w{-}@w{-}with@w{-}wheel@w{-}pkg@w{-}dir=PATH

Diretório de pacotes de wheel usados pelo módulo @ref{55,,ensurepip} (nenhum por padrão).

Algumas políticas de empacotamento de distribuição do Linux recomendam contra o empacotamento de dependências. Por exemplo, o Fedora instala pacotes wheel no diretório @code{/usr/share/python-wheels/} e não instala o pacote @code{ensurepip._bundled}.


Adicionado na versão 3.10.

@end deffn

@geindex opção de linha de comando; --with-pkg-config
@anchor{using/configure cmdoption-with-pkg-config}@anchor{1eff}
@deffn {Option} @w{-}@w{-}with@w{-}pkg@w{-}config=[check|yes|no]

Se o configure deve usar @code{pkg-config} para detectar dependências de construção.


@itemize *

@item 
@code{check} (padrão): @code{pkg-config} é opcional

@item 
@code{yes}: @code{pkg-config} é obrigatório

@item 
@code{no}: configure não usa @code{pkg-config} mesmo quando presente
@end itemize


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --enable-pystats
@anchor{using/configure cmdoption-enable-pystats}@anchor{18c0}
@deffn {Option} @w{-}@w{-}enable@w{-}pystats

Ativa a coleta de estatísticas internas de desempenho do Python.

Por padrão, a coleta de estatísticas está desativada. Use o comando @code{python3 -X pystats} ou defina a variável de ambiente @code{PYTHONSTATS=1} para ativar a coleta de estatísticas na inicialização do Python.

Na saída do Python, despeja as estatísticas se a coleta de estatísticas estiver ativada e não apagada.

Efeitos:


@itemize *

@item 
Adiciona a opção de linha de comando @ref{176,,-X pystats}.

@item 
Adiciona a variável de ambiente @code{PYTHONSTATS}.

@item 
Define a macro @code{Py_STATS}.

@item 
Adiciona funções ao módulo @ref{d9,,sys}:


@itemize *

@item 
@code{sys._stats_on()}: Ativa a coleta de estatísticas.

@item 
@code{sys._stats_off()}: Desativa a coleta de estatísticas.

@item 
@code{sys._stats_clear()}: Apaga as estatísticas.

@item 
@code{sys._stats_dump()}: Despeja as estatísticas no arquivo e apaga as estatísticas.
@end itemize
@end itemize

As estatísticas serão despejadas em um arquivo arbitrário (provavelmente único) em @code{/tmp/py_stats/} (Unix) ou @code{C:\temp\py_stats\} (Windows). Se aquele diretório não existir, os resultados serão enviados para stderr.

Use @code{Tools/scripts/summarize_stats.py} para ler as estatísticas.

Estatísticas:


@itemize *

@item 
Código de operação:


@itemize *

@item 
Especialização: sucesso, fracasso, acerto, adiado, erro, deopt, falhas;

@item 
Contagem de execuções;

@item 
Contagem em pares.
@end itemize

@item 
Chamada:


@itemize *

@item 
Chamadas Python em linha;

@item 
Chamadas a PyEval;

@item 
Quadros enviados;

@item 
Objetos quadro criados;

@item 
Chamadas de Eval: vetor, gerador, legado, função VECTORCALL, classe de construção, slot, função “ex”, API, método.
@end itemize

@item 
Objeto:


@itemize *

@item 
incref e decref;

@item 
incref e decref do interpretador;

@item 
alocações: tudo, 512 bytes, 4 kiB, big;

@item 
memória livre;

@item 
listas de memória livre para/de;

@item 
Dicionário materializado/desmaterializado;

@item 
cache de tipo;

@item 
tentativas de otimização;

@item 
rastros de otimização criados/executados;

@item 
uops executados.
@end itemize

@item 
Coletor de lixo:


@itemize *

@item 
Coletas de lixo;

@item 
Objetos visitados;

@item 
Objetos coletados.
@end itemize
@end itemize


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --disable-gil
@anchor{using/configure free-threading-build}@anchor{1f00}@anchor{using/configure cmdoption-disable-gil}@anchor{174}
@deffn {Option} @w{-}@w{-}disable@w{-}gil

Habilita suporte `experimental' para execução de Python sem a @ref{148,,trava global do interpretador} (GIL): construção de com threads livres.

Define a macro @code{Py_GIL_DISABLED} e adiciona @code{"t"} a @ref{a6d,,sys.abiflags}.

Veja @ref{13f,,CPython com threads livres} para mais detalhes.


Adicionado na versão 3.13.

@end deffn

@geindex opção de linha de comando; --enable-experimental-jit
@anchor{using/configure cmdoption-enable-experimental-jit}@anchor{1f01}
@deffn {Option} @w{-}@w{-}enable@w{-}experimental@w{-}jit=[no|yes|yes@w{-}off|interpreter]

Indica como integrar o @ref{140,,compilador JIT}.


@itemize *

@item 
@code{no} - constrói o interpretador sem o JIT.

@item 
@code{yes} - constrói o interpretador com o JIT.

@item 
@code{yes-off} - constrói o interpretador com o JIT, mas desabilitado por padrão.

@item 
@code{interpreter} - constrói o interpretador sem o JIT, mas com o interpretador habilitado para nível 2.
@end itemize

Por convenção, @code{--enable-experimental-jit} é uma abreviação de @code{--enable-experimental-jit=yes}.

@cartouche
@quotation Nota 
Ao construir o CPython com o JIT habilitado, certifique-se de que seu sistema tenha o Python 3.11 ou posterior instalado.
@end quotation
@end cartouche


Adicionado na versão 3.13.

@end deffn

@geindex opção de linha de comando; PKG_CONFIG
@anchor{using/configure cmdoption-arg-PKG_CONFIG}@anchor{1f02}
@deffn {Option} PKG_CONFIG

Caminho para o utilitário @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; PKG_CONFIG_LIBDIR
@anchor{using/configure cmdoption-arg-PKG_CONFIG_LIBDIR}@anchor{1f03}
@deffn {Option} PKG_CONFIG_LIBDIR
@end deffn

@geindex opção de linha de comando; PKG_CONFIG_PATH
@anchor{using/configure cmdoption-arg-PKG_CONFIG_PATH}@anchor{1f04}
@deffn {Option} PKG_CONFIG_PATH

Opções do @code{pkg-config}.
@end deffn

@node Opções do compilador C,Opções da ligação,Opções gerais,Opções de configuração
@anchor{using/configure c-compiler-options}@anchor{1f05}
@subsubsection Opções do compilador C


@geindex opção de linha de comando; CC
@anchor{using/configure cmdoption-arg-CC}@anchor{1f06}
@deffn {Option} CC

Comando do compilador C.
@end deffn

@geindex opção de linha de comando; CFLAGS
@anchor{using/configure cmdoption-arg-CFLAGS}@anchor{1f07}
@deffn {Option} CFLAGS

Sinalizadores do compilador C.
@end deffn

@geindex opção de linha de comando; CPP
@anchor{using/configure cmdoption-arg-CPP}@anchor{1f08}
@deffn {Option} CPP

Comando do pré-processador C.
@end deffn

@geindex opção de linha de comando; CPPFLAGS
@anchor{using/configure cmdoption-arg-CPPFLAGS}@anchor{1f09}
@deffn {Option} CPPFLAGS

Sinalizadores do pré-processador C, p.ex., @code{-I@var{include_dir}}.
@end deffn

@node Opções da ligação,Opções para dependências de terceiros,Opções do compilador C,Opções de configuração
@anchor{using/configure linker-options}@anchor{1f0a}
@subsubsection Opções da ligação


@geindex opção de linha de comando; LDFLAGS
@anchor{using/configure cmdoption-arg-LDFLAGS}@anchor{1f0b}
@deffn {Option} LDFLAGS

Sinalizadores do vinculador. p.ex., @code{-L@var{library_directory}}.
@end deffn

@geindex opção de linha de comando; LIBS
@anchor{using/configure cmdoption-arg-LIBS}@anchor{1f0c}
@deffn {Option} LIBS

Bibliotecas para passar para o vinculador, p.ex. @code{-l@var{library}}.
@end deffn

@geindex opção de linha de comando; MACHDEP
@anchor{using/configure cmdoption-arg-MACHDEP}@anchor{1f0d}
@deffn {Option} MACHDEP

Nome para arquivos de biblioteca dependentes de máquina.
@end deffn

@node Opções para dependências de terceiros,Opções de WebAssembly,Opções da ligação,Opções de configuração
@anchor{using/configure options-for-third-party-dependencies}@anchor{1f0e}
@subsubsection Opções para dependências de terceiros



Adicionado na versão 3.11.


@geindex opção de linha de comando; BZIP2_CFLAGS
@anchor{using/configure cmdoption-arg-BZIP2_CFLAGS}@anchor{1f0f}
@deffn {Option} BZIP2_CFLAGS
@end deffn

@geindex opção de linha de comando; BZIP2_LIBS
@anchor{using/configure cmdoption-arg-BZIP2_LIBS}@anchor{1f10}
@deffn {Option} BZIP2_LIBS

Sinalizadores de compilador C e vinculador para vincular Python a @code{libbz2}, usados pelo módulo @ref{13,,bz2}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; CURSES_CFLAGS
@anchor{using/configure cmdoption-arg-CURSES_CFLAGS}@anchor{1f11}
@deffn {Option} CURSES_CFLAGS
@end deffn

@geindex opção de linha de comando; CURSES_LIBS
@anchor{using/configure cmdoption-arg-CURSES_LIBS}@anchor{1f12}
@deffn {Option} CURSES_LIBS

Sinalizadores de compilador C e vinculador para @code{libncurses} ou @code{libncursesw}, usados pelo módulo @ref{2b,,curses}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; GDBM_CFLAGS
@anchor{using/configure cmdoption-arg-GDBM_CFLAGS}@anchor{1f13}
@deffn {Option} GDBM_CFLAGS
@end deffn

@geindex opção de linha de comando; GDBM_LIBS
@anchor{using/configure cmdoption-arg-GDBM_LIBS}@anchor{1f14}
@deffn {Option} GDBM_LIBS

Sinalizadores de compilador C e vinculador para @code{gdbm}.
@end deffn

@geindex opção de linha de comando; LIBB2_CFLAGS
@anchor{using/configure cmdoption-arg-LIBB2_CFLAGS}@anchor{1f15}
@deffn {Option} LIBB2_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBB2_LIBS
@anchor{using/configure cmdoption-arg-LIBB2_LIBS}@anchor{1f16}
@deffn {Option} LIBB2_LIBS

Sinalizadores de compilador C e vinculador para @code{libb2} (@ref{1f17,,BLAKE2}), usados pelo módulo @ref{68,,hashlib}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBEDIT_CFLAGS
@anchor{using/configure cmdoption-arg-LIBEDIT_CFLAGS}@anchor{1f18}
@deffn {Option} LIBEDIT_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBEDIT_LIBS
@anchor{using/configure cmdoption-arg-LIBEDIT_LIBS}@anchor{1f19}
@deffn {Option} LIBEDIT_LIBS

Sinalizadores de compilador C e vinculador para @code{libedit}, usados pelo módulo @ref{ba,,readline}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBFFI_CFLAGS
@anchor{using/configure cmdoption-arg-LIBFFI_CFLAGS}@anchor{1f1a}
@deffn {Option} LIBFFI_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBFFI_LIBS
@anchor{using/configure cmdoption-arg-LIBFFI_LIBS}@anchor{1f1b}
@deffn {Option} LIBFFI_LIBS

Sinalizadores de compilador C e vinculador para @code{libffi}, usados pelo módulo @ref{2a,,ctypes}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBMPDEC_CFLAGS
@anchor{using/configure cmdoption-arg-LIBMPDEC_CFLAGS}@anchor{1f1c}
@deffn {Option} LIBMPDEC_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBMPDEC_LIBS
@anchor{using/configure cmdoption-arg-LIBMPDEC_LIBS}@anchor{1f1d}
@deffn {Option} LIBMPDEC_LIBS

Sinalizadores de compilador C e vinculador para @code{libmpdec}, usados pelo módulo @ref{36,,decimal}, substituindo @code{pkg-config}.

@cartouche
@quotation Nota 
Estas variáveis de ambiente não têm efeito a menos que @ref{412,,--with-system-libmpdec} seja especificado.
@end quotation
@end cartouche
@end deffn

@geindex opção de linha de comando; LIBLZMA_CFLAGS
@anchor{using/configure cmdoption-arg-LIBLZMA_CFLAGS}@anchor{1f1e}
@deffn {Option} LIBLZMA_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBLZMA_LIBS
@anchor{using/configure cmdoption-arg-LIBLZMA_LIBS}@anchor{1f1f}
@deffn {Option} LIBLZMA_LIBS

Sinalizadores de compilador C e vinculador para @code{liblzma}, usados pelo módulo @ref{8a,,lzma}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBREADLINE_CFLAGS
@anchor{using/configure cmdoption-arg-LIBREADLINE_CFLAGS}@anchor{1f20}
@deffn {Option} LIBREADLINE_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBREADLINE_LIBS
@anchor{using/configure cmdoption-arg-LIBREADLINE_LIBS}@anchor{1f21}
@deffn {Option} LIBREADLINE_LIBS

Sinalizadores de compilador C e vinculador para @code{libreadline}, usados pelo módulo @ref{ba,,readline}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBSQLITE3_CFLAGS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_CFLAGS}@anchor{1f22}
@deffn {Option} LIBSQLITE3_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBSQLITE3_LIBS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_LIBS}@anchor{1f23}
@deffn {Option} LIBSQLITE3_LIBS

Sinalizadores de compilador C e vinculador para @code{libsqlite3}, usados pelo módulo @ref{cf,,sqlite3}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; LIBUUID_CFLAGS
@anchor{using/configure cmdoption-arg-LIBUUID_CFLAGS}@anchor{1f24}
@deffn {Option} LIBUUID_CFLAGS
@end deffn

@geindex opção de linha de comando; LIBUUID_LIBS
@anchor{using/configure cmdoption-arg-LIBUUID_LIBS}@anchor{1f25}
@deffn {Option} LIBUUID_LIBS

Sinalizadores de compilador C e vinculador para @code{libuuid}, usados pelo módulo @ref{110,,uuid}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; PANEL_CFLAGS
@anchor{using/configure cmdoption-arg-PANEL_CFLAGS}@anchor{1f26}
@deffn {Option} PANEL_CFLAGS
@end deffn

@geindex opção de linha de comando; PANEL_LIBS
@anchor{using/configure cmdoption-arg-PANEL_LIBS}@anchor{1f27}
@deffn {Option} PANEL_LIBS

Sinalizadores de compilador C e vinculador para PANEL, substituindo @code{pkg-config}.

Sinalizadores de compilador C e vinculador para @code{libpanel} ou @code{libpanelw}, usados pelo módulo @ref{2d,,curses.panel}, substituindo @code{pkg-config}.
@end deffn

@geindex opção de linha de comando; TCLTK_CFLAGS
@anchor{using/configure cmdoption-arg-TCLTK_CFLAGS}@anchor{1f28}
@deffn {Option} TCLTK_CFLAGS
@end deffn

@geindex opção de linha de comando; TCLTK_LIBS
@anchor{using/configure cmdoption-arg-TCLTK_LIBS}@anchor{1f29}
@deffn {Option} TCLTK_LIBS

Sinalizadores de compilador C e vinculador para TCLTK, substituindo @code{pkg-config}.;
@end deffn

@geindex opção de linha de comando; ZLIB_CFLAGS
@anchor{using/configure cmdoption-arg-ZLIB_CFLAGS}@anchor{1f2a}
@deffn {Option} ZLIB_CFLAGS
@end deffn

@geindex opção de linha de comando; ZLIB_LIBS
@anchor{using/configure cmdoption-arg-ZLIB_LIBS}@anchor{1f2b}
@deffn {Option} ZLIB_LIBS

Sinalizadores de compilador C e vinculador para @code{libzlib}, usados pelo módulo @ref{67,,gzip}, substituindo @code{pkg-config}.
@end deffn

@node Opções de WebAssembly,Opções de instalação,Opções para dependências de terceiros,Opções de configuração
@anchor{using/configure webassembly-options}@anchor{1f2c}
@subsubsection Opções de WebAssembly


@geindex opção de linha de comando; --with-emscripten-target
@anchor{using/configure cmdoption-with-emscripten-target}@anchor{1f2d}
@deffn {Option} @w{-}@w{-}with@w{-}emscripten@w{-}target=[browser|node]

Define o “sabor” de construção para @code{wasm32-emscripten}.


@itemize *

@item 
@code{browser} (padrão): pré-carrega stdlib mínima, MEMFS padrão.

@item 
@code{node}: suporte a NODERAWFS e pthread.
@end itemize


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --enable-wasm-dynamic-linking
@anchor{using/configure cmdoption-enable-wasm-dynamic-linking}@anchor{1948}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}dynamic@w{-}linking

Ativa o suporte de vinculação dinâmica para WASM.

A vinculação dinâmica permite @code{dlopen}. O tamanho do arquivo executável aumenta devido à eliminação limitada de código morto e recursos adicionais.


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; --enable-wasm-pthreads
@anchor{using/configure cmdoption-enable-wasm-pthreads}@anchor{1918}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}pthreads

Ativa o suporte a pthreads para WASM.


Adicionado na versão 3.11.

@end deffn

@node Opções de instalação,Opções de desempenho,Opções de WebAssembly,Opções de configuração
@anchor{using/configure install-options}@anchor{1f2e}
@subsubsection Opções de instalação


@geindex opção de linha de comando; --prefix
@anchor{using/configure cmdoption-prefix}@anchor{1ee7}
@deffn {Option} @w{-}@w{-}prefix=PREFIX

Instala arquivos independentes de arquitetura em PREFIX. No Unix, o padrão é @code{/usr/local}.

Este valor pode ser recuperado em tempo de execução usando @ref{3b6,,sys.prefix}.

Como exemplo, pode-se usar @code{--prefix="$HOME/.local/"} para instalar um Python em seu diretório pessoal (home).
@end deffn

@geindex opção de linha de comando; --exec-prefix
@anchor{using/configure cmdoption-exec-prefix}@anchor{1ee8}
@deffn {Option} @w{-}@w{-}exec@w{-}prefix=EPREFIX

Instala arquivos dependentes de arquitetura no EPREFIX, o padrão é @ref{1ee7,,--prefix}.

Este valor pode ser recuperado em tempo de execução usando @ref{3b2,,sys.exec_prefix}.
@end deffn

@geindex opção de linha de comando; --disable-test-modules
@anchor{using/configure cmdoption-disable-test-modules}@anchor{890}
@deffn {Option} @w{-}@w{-}disable@w{-}test@w{-}modules

Não constrói nem instala módulos de teste, como o pacote @ref{e2,,test} ou o módulo de extensão @code{_testcapi} (construído e instalado por padrão).


Adicionado na versão 3.10.

@end deffn

@geindex opção de linha de comando; --with-ensurepip
@anchor{using/configure cmdoption-with-ensurepip}@anchor{1f2f}
@deffn {Option} @w{-}@w{-}with@w{-}ensurepip=[upgrade|install|no]

Seleciona o comando @ref{55,,ensurepip} executado na instalação do Python:


@itemize *

@item 
@code{upgrade} (padrão): executa o comando @code{python -m ensurepip --altinstall --upgrade}.

@item 
@code{install}: executa o comando @code{python -m ensurepip --altinstall};

@item 
@code{no}: não executa ensurepip;
@end itemize


Adicionado na versão 3.6.

@end deffn

@node Opções de desempenho,Compilação de depuração do Python,Opções de instalação,Opções de configuração
@anchor{using/configure performance-options}@anchor{1f30}
@subsubsection Opções de desempenho


Configurar o Python usando @code{--enable-optimizations --with-lto} (PGO + LTO) é o recomendado para melhor desempenho. O sinalizador experimental @code{--enable-bolt} também pode ser usado para melhorar o desempenho.

@geindex opção de linha de comando; --enable-optimizations
@anchor{using/configure cmdoption-enable-optimizations}@anchor{865}
@deffn {Option} @w{-}@w{-}enable@w{-}optimizations

Habilita a otimização guiada por perfil (PGO, do inglês Profile Guided Optimization) usando 
@geindex PROFILE_TASK
@geindex variável de ambiente; PROFILE_TASK
@ref{1800,,PROFILE_TASK} (desabilitado por padrão).

O compilador C Clang requer o programa @code{llvm-profdata} para PGO. No macOS, o GCC também exige: o GCC é apenas um apelido para o Clang no macOS.

Desabilita também a interposição semântica no libpython se @code{--enable-shared} e GCC forem usados: adiciona @code{-fno-semantic-interposition} aos sinalizadores do compilador e do vinculador.

@cartouche
@quotation Nota 
Durante a construção, você poderá encontrar avisos do compilador sobre a indisponibilidade de dados de perfil para alguns arquivos fonte. Esses avisos são inofensivos, pois apenas um subconjunto do código é exercido durante a aquisição de dados de perfil. Para desativar esses avisos no Clang, suprima-os manualmente adicionando @code{-Wno-profile-instr-unprofiled} a 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS}.
@end quotation
@end cartouche


Adicionado na versão 3.6.



Alterado na versão 3.10: Usa @code{-fno-semantic-interposition} no GCC.

@end deffn

@geindex variável de ambiente; PROFILE_TASK
@anchor{using/configure envvar-PROFILE_TASK}@anchor{1800}
@deffn {Variável De Ambiente} PROFILE_TASK

Variável de ambiente usada no Makefile: argumentos de linha de comando do Python para a tarefa de geração de PGO.

Padrão: @code{-m test --pgo --timeout=$(TESTTIMEOUT)}.


Adicionado na versão 3.8.



Alterado na versão 3.13: A falha da tarefa não é mais ignorada silenciosamente.

@end deffn

@geindex opção de linha de comando; --with-lto
@anchor{using/configure cmdoption-with-lto}@anchor{74b}
@deffn {Option} @w{-}@w{-}with@w{-}lto=[full|thin|no|yes]

Habilita o otimização em tempo de vinculação (LTO, do inglês Link Time Optimization) em qualquer construção (desabilitado por padrão).

O compilador C Clang requer @code{llvm-ar} para LTO (@code{ar} no macOS), bem como um vinculador compatível com LTO (@code{ld.gold} ou @code{lld}).


Adicionado na versão 3.6.



Adicionado na versão 3.11: Para usar o recurso ThinLTO, use @code{--with-lto=thin} no Clang.



Alterado na versão 3.12: Usa ThinLTO como política de otimização padrão no Clang se o compilador aceitar o sinalizador.

@end deffn

@geindex opção de linha de comando; --enable-bolt
@anchor{using/configure cmdoption-enable-bolt}@anchor{1f31}
@deffn {Option} @w{-}@w{-}enable@w{-}bolt

Habilita o uso do otimizador binário pós-vinculação BOLT@footnote{https://github.com/llvm/llvm-project/tree/main/bolt} (desabilitado por padrão).

BOLT faz parte do projeto LLVM, mas nem sempre está incluído em suas distribuições binárias. Este sinalizador requer que @code{llvm-bolt} e @code{merge-fdata} estejam disponíveis.

BOLT ainda é um projeto relativamente novo, então este sinalizador deve ser considerado experimental por enquanto. Como esta ferramenta opera em código de máquina, seu sucesso depende de uma combinação do ambiente de construção + os outros argumentos de configuração de otimização + a arquitetura da CPU, e nem todas as combinações são suportadas. Versões do BOLT anteriores ao LLVM 16 são conhecidas por travar o BOLT em alguns cenários. O uso do LLVM 16 ou mais recente para otimização do BOLT é fortemente incentivado.

As variáveis @code{BOLT_INSTRUMENT_FLAGS} e @code{BOLT_APPLY_FLAGS} do @code{configure} podem ser definidas para substituir o conjunto padrão de argumentos para @code{llvm-bolt} para instrumentar e aplicar dados BOLT aos binários , respectivamente.


Adicionado na versão 3.12.

@end deffn

@geindex opção de linha de comando; BOLT_APPLY_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_APPLY_FLAGS}@anchor{1f32}
@deffn {Option} BOLT_APPLY_FLAGS

Argumentos para @code{llvm-bolt} ao criar um binário otimizado com BOLT@footnote{https://github.com/facebookarchive/BOLT}.


Adicionado na versão 3.12.

@end deffn

@geindex opção de linha de comando; BOLT_INSTRUMENT_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_INSTRUMENT_FLAGS}@anchor{1f33}
@deffn {Option} BOLT_INSTRUMENT_FLAGS

Argumentos para @code{llvm-bolt} ao instrumentar binários.


Adicionado na versão 3.12.

@end deffn

@geindex opção de linha de comando; --with-computed-gotos
@anchor{using/configure cmdoption-with-computed-gotos}@anchor{1f34}
@deffn {Option} @w{-}@w{-}with@w{-}computed@w{-}gotos

Habilita “gotos” computados no laço de avaliação (habilitado por padrão em compiladores suportados).
@end deffn

@geindex opção de linha de comando; --without-mimalloc
@anchor{using/configure cmdoption-without-mimalloc}@anchor{1f35}
@deffn {Option} @w{-}@w{-}without@w{-}mimalloc

Desativa o alocador rápido @ref{1ed6,,mimalloc} (habilitado por padrão).

Veja também a variável de ambiente 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC}.
@end deffn

@geindex opção de linha de comando; --without-pymalloc
@anchor{using/configure cmdoption-without-pymalloc}@anchor{1f36}
@deffn {Option} @w{-}@w{-}without@w{-}pymalloc

Desabilita o alocador de memória especializado do Python @ref{d31,,pymalloc} (habilitado por padrão).

Veja também a variável de ambiente 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC}.
@end deffn

@geindex opção de linha de comando; --without-doc-strings
@anchor{using/configure cmdoption-without-doc-strings}@anchor{1f37}
@deffn {Option} @w{-}@w{-}without@w{-}doc@w{-}strings

Desabilita as strings de documentação estática para reduzir o consumo de memória (habilitado por padrão). As strings de documentação definidas em Python não são afetadas.

Não define a macro @code{WITH_DOC_STRINGS}.

Veja a macro @code{PyDoc_STRVAR()}.
@end deffn

@geindex opção de linha de comando; --enable-profiling
@anchor{using/configure cmdoption-enable-profiling}@anchor{1f38}
@deffn {Option} @w{-}@w{-}enable@w{-}profiling

Habilita o perfil de código a nível C com @code{gprof} (desabilitado por padrão).
@end deffn

@geindex opção de linha de comando; --with-strict-overflow
@anchor{using/configure cmdoption-with-strict-overflow}@anchor{185b}
@deffn {Option} @w{-}@w{-}with@w{-}strict@w{-}overflow

Adiciona @code{-fstrict-overflow} aos sinalizadores do compilador C (por padrão adicionamos @code{-fno-strict-overflow}).
@end deffn

@node Compilação de depuração do Python,Opções de depuração,Opções de desempenho,Opções de configuração
@anchor{using/configure debug-build}@anchor{1f9}@anchor{using/configure python-debug-build}@anchor{1f39}
@subsubsection Compilação de depuração do Python


Uma compilação de depuração é Python compilada com a opção de configuração @ref{424,,--with-pydebug}.

Efeitos de uma compilação de depuração:


@itemize *

@item 
Exibe todos os avisos por padrão: a lista de filtros de aviso padrão está vazia no módulo @ref{112,,warnings}.

@item 
Adiciona @code{d} a @ref{a6d,,sys.abiflags}.

@item 
Adiciona a função @code{sys.gettotalrefcount()}.

@item 
Adiciona a opção de linha de comando @ref{176,,-X showrefcount}.

@item 
Adiciona a opção de linha de comando @ref{1ebb,,-d} e a variável de ambiente 
@geindex PYTHONDEBUG
@geindex variável de ambiente; PYTHONDEBUG
@ref{1ebc,,PYTHONDEBUG} para depurar o analisador sintático.

@item 
Adiciona suporte para a variável @code{__lltrace__}: habilita o rastreamento de baixo nível no laço de avaliação de bytecode se a variável estiver definida.

@item 
Instala @ref{1ed4,,ganchos de depuração nos alocadores de memória} para detectar estouro de buffer e outros erros de memória.

@item 
Define as macros @code{Py_DEBUG} e @code{Py_REF_DEBUG}.

@item 
Adiciona verificações de tempo de execução: código cercado por @code{#ifdef Py_DEBUG} e @code{#endif}. Habilita as asserções @code{assert(...)} e @code{_PyObject_ASSERT(...)}: não define a macro @code{NDEBUG} (veja também a configuração @ref{38c,,--with-assertions} opção). Principais verificações de tempo de execução:


@itemize *

@item 
Adiciona verificações de sanidade nos argumentos da função.

@item 
Objetos Unicode e int são criados com sua memória preenchida com um padrão para detectar o uso de objetos não inicializados.

@item 
Garante que as funções que podem limpar ou substituir a exceção atual não sejam chamadas com uma exceção levantada.

@item 
Verifica se as funções desalocadoras não alteram a exceção atual.

@item 
O coletor de lixo (função @ref{a43,,gc.collect()}) executa algumas verificações básicas na consistência dos objetos.

@item 
A macro @code{Py_SAFE_DOWNCAST()} verifica o underflow e o overflow de inteiros ao fazer o downcast de tipos largos para tipos estreitos.
@end itemize
@end itemize

Veja também o @ref{1f8,,Modo de Desenvolvimento do Python} e a opção de configuração @ref{395,,--with-trace-refs}.


Alterado na versão 3.8: Construções de lançamento e construções de depuração agora são compatíveis com ABI: definir a macro @code{Py_DEBUG} não implica mais na macro @code{Py_TRACE_REFS} (consulte a opção @ref{395,,--with-trace-refs}).


@node Opções de depuração,Opções da ligação<2>,Compilação de depuração do Python,Opções de configuração
@anchor{using/configure debug-options}@anchor{1f3a}
@subsubsection Opções de depuração


@geindex opção de linha de comando; --with-pydebug
@anchor{using/configure cmdoption-with-pydebug}@anchor{424}
@deffn {Option} @w{-}@w{-}with@w{-}pydebug

@ref{1f9,,Construção de depuração do Python}: define a macro @code{Py_DEBUG} (desabilitada por padrão).
@end deffn

@geindex opção de linha de comando; --with-trace-refs
@anchor{using/configure cmdoption-with-trace-refs}@anchor{395}
@deffn {Option} @w{-}@w{-}with@w{-}trace@w{-}refs

Habilita referências de rastreamento para fins de depuração (desabilitado por padrão).

Efeitos:


@itemize *

@item 
Define a macro @code{Py_TRACE_REFS}.

@item 
Adiciona a função @ref{427,,sys.getobjects()}.

@item 
Adiciona a variável de ambiente 
@geindex PYTHONDUMPREFS
@geindex variável de ambiente; PYTHONDUMPREFS
@ref{9ae,,PYTHONDUMPREFS}.
@end itemize

A variável de ambiente 
@geindex PYTHONDUMPREFS
@geindex variável de ambiente; PYTHONDUMPREFS
@ref{9ae,,PYTHONDUMPREFS} pode ser usada para despejar objetos e contagens de referências ainda ativas na saída do Python.

@ref{77f,,Objetos alocados estaticamente} não são rastreados.


Adicionado na versão 3.8.



Alterado na versão 3.13: Esta construção agora é compatibilidade de ABI com a construção de lançamento e @ref{1f9,,construção de depuração}.

@end deffn

@geindex opção de linha de comando; --with-assertions
@anchor{using/configure cmdoption-with-assertions}@anchor{38c}
@deffn {Option} @w{-}@w{-}with@w{-}assertions

Constrói com asserções C habilitadas (o padrão é não): @code{assert(...);} e @code{_PyObject_ASSERT(...);}.

Se definido, a macro @code{NDEBUG} não é definida na variável do compilador 
@geindex OPT
@geindex variável de ambiente; OPT
@ref{1f3b,,OPT}.

Veja também a opção @ref{424,,--with-pydebug} (@ref{1f9,,construção de depuração}) que também habilita asserções.


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --with-valgrind
@anchor{using/configure cmdoption-with-valgrind}@anchor{1f3c}
@deffn {Option} @w{-}@w{-}with@w{-}valgrind

Habilita suporte ao Valgrind (o padrão é não).
@end deffn

@geindex opção de linha de comando; --with-dtrace
@anchor{using/configure cmdoption-with-dtrace}@anchor{1f3d}
@deffn {Option} @w{-}@w{-}with@w{-}dtrace

Habilita suporte ao DTrace (o padrão é não).

Veja @ref{c87,,Instrumentando o CPython com DTrace e SystemTap}.


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --with-address-sanitizer
@anchor{using/configure cmdoption-with-address-sanitizer}@anchor{1f3e}
@deffn {Option} @w{-}@w{-}with@w{-}address@w{-}sanitizer

Habilita o detector de erros de memória AddressSanitizer, @code{asan} (o padrão é não). Para melhorar os recursos de detecção do ASan, você também pode combinar isso com @ref{1f36,,--without-pymalloc} para desabilitar o alocador especializado de pequenos objetos cujas alocações não são rastreadas pelo ASan.


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --with-memory-sanitizer
@anchor{using/configure cmdoption-with-memory-sanitizer}@anchor{1f3f}
@deffn {Option} @w{-}@w{-}with@w{-}memory@w{-}sanitizer

Habilita o detector de erros de alocação do MemorySanitizer, @code{msan} (o padrão é não).


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --with-undefined-behavior-sanitizer
@anchor{using/configure cmdoption-with-undefined-behavior-sanitizer}@anchor{1f40}
@deffn {Option} @w{-}@w{-}with@w{-}undefined@w{-}behavior@w{-}sanitizer

Habilita o detector de comportamento indefinido UndefinedBehaviorSanitizer, @code{ubsan} (o padrão é não).


Adicionado na versão 3.6.

@end deffn

@geindex opção de linha de comando; --with-thread-sanitizer
@anchor{using/configure cmdoption-with-thread-sanitizer}@anchor{1f41}
@deffn {Option} @w{-}@w{-}with@w{-}thread@w{-}sanitizer

Habilita o detector de corrida de dados ThreadSanitizer, @code{tsan} (o padrão é não).


Adicionado na versão 3.13.

@end deffn

@node Opções da ligação<2>,Opções da biblioteca,Opções de depuração,Opções de configuração
@anchor{using/configure id2}@anchor{1f42}
@subsubsection Opções da ligação


@geindex opção de linha de comando; --enable-shared
@anchor{using/configure cmdoption-enable-shared}@anchor{866}
@deffn {Option} @w{-}@w{-}enable@w{-}shared

Habilita a construção de uma biblioteca Python compartilhada: @code{libpython} (o padrão é não).
@end deffn

@geindex opção de linha de comando; --without-static-libpython
@anchor{using/configure cmdoption-without-static-libpython}@anchor{892}
@deffn {Option} @w{-}@w{-}without@w{-}static@w{-}libpython

Não constrói @code{libpythonMAJOR.MINOR.a} e não instala @code{python.o} (construído e habilitado por padrão).


Adicionado na versão 3.10.

@end deffn

@node Opções da biblioteca,Opções de segurança,Opções da ligação<2>,Opções de configuração
@anchor{using/configure libraries-options}@anchor{1f43}
@subsubsection Opções da biblioteca


@geindex opção de linha de comando; --with-libs
@anchor{using/configure cmdoption-with-libs}@anchor{1f44}
@deffn {Option} @w{-}@w{-}with@w{-}libs='lib1 ...'

Vincula bibliotecas adicionais (o padrão é não).
@end deffn

@geindex opção de linha de comando; --with-system-expat
@anchor{using/configure cmdoption-with-system-expat}@anchor{18b5}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}expat

Constrói o módulo @code{pyexpat} usando uma biblioteca @code{expat} instalada (o padrão é não).
@end deffn

@geindex opção de linha de comando; --with-system-libmpdec
@anchor{using/configure cmdoption-with-system-libmpdec}@anchor{412}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}libmpdec

Constrói o módulo de extensão @code{_decimal} usando uma biblioteca @code{mpdecimal} instalada, veja o módulo @ref{36,,decimal} (o padrão é sim).


Adicionado na versão 3.3.



Alterado na versão 3.13: O padrão é usar a biblioteca @code{mpdecimal} instalada.



Descontinuado desde a versão 3.13, será removido na versão 3.16: Uma cópia dos fontes da biblioteca @code{mpdecimal} não será mais distribuída com Python 3.16.



@subsubheading Ver também


@ref{1f1c,,LIBMPDEC_CFLAGS} e @ref{1f1d,,LIBMPDEC_LIBS}.

@end deffn

@geindex opção de linha de comando; --with-readline
@anchor{using/configure cmdoption-with-readline}@anchor{1f45}
@deffn {Option} @w{-}@w{-}with@w{-}readline=readline|editline

Designa uma biblioteca backend para o módulo @ref{ba,,readline}.


@itemize *

@item 
readline: Usa readline como o backend.

@item 
editline: Usa editline como o backend.
@end itemize


Adicionado na versão 3.10.

@end deffn

@geindex opção de linha de comando; --without-readline
@anchor{using/configure cmdoption-without-readline}@anchor{1f46}
@deffn {Option} @w{-}@w{-}without@w{-}readline

Não constrói o módulo @ref{ba,,readline} (construído por padrão).

Não define a macro @code{HAVE_LIBREADLINE}.


Adicionado na versão 3.10.

@end deffn

@geindex opção de linha de comando; --with-libm
@anchor{using/configure cmdoption-with-libm}@anchor{1f47}
@deffn {Option} @w{-}@w{-}with@w{-}libm=STRING

Substitui a biblioteca matemática @code{libm} por `STRING' (o padrão depende do sistema).
@end deffn

@geindex opção de linha de comando; --with-libc
@anchor{using/configure cmdoption-with-libc}@anchor{1f48}
@deffn {Option} @w{-}@w{-}with@w{-}libc=STRING

Substitui a biblioteca C @code{libc} por `STRING' (o padrão depende do sistema).
@end deffn

@geindex opção de linha de comando; --with-openssl
@anchor{using/configure cmdoption-with-openssl}@anchor{1f49}
@deffn {Option} @w{-}@w{-}with@w{-}openssl=DIR

Raiz do diretório OpenSSL.


Adicionado na versão 3.7.

@end deffn

@geindex opção de linha de comando; --with-openssl-rpath
@anchor{using/configure cmdoption-with-openssl-rpath}@anchor{893}
@deffn {Option} @w{-}@w{-}with@w{-}openssl@w{-}rpath=[no|auto|DIR]

Define o diretório da biblioteca de tempo de execução (rpath) para bibliotecas OpenSSL:


@itemize *

@item 
@code{no} (padrão): não define o rpath;

@item 
@code{auto}: detecta automaticamente o rpath de @ref{1f49,,--with-openssl} e @code{pkg-config};

@item 
`DIR': define um rpath explícito.
@end itemize


Adicionado na versão 3.10.

@end deffn

@node Opções de segurança,Opções do macOS,Opções da biblioteca,Opções de configuração
@anchor{using/configure security-options}@anchor{1f4a}
@subsubsection Opções de segurança


@geindex opção de linha de comando; --with-hash-algorithm
@anchor{using/configure cmdoption-with-hash-algorithm}@anchor{1f4b}
@deffn {Option} @w{-}@w{-}with@w{-}hash@w{-}algorithm=[fnv|siphash13|siphash24]

Seleciona o algoritmo de hash para usar em @code{Python/pyhash.c}:


@itemize *

@item 
@code{siphash13} (padrão);

@item 
@code{siphash24};

@item 
@code{fnv}.
@end itemize


Adicionado na versão 3.4.



Adicionado na versão 3.11: @code{siphash13} é adicionado e é o novo padrão.

@end deffn

@geindex opção de linha de comando; --with-builtin-hashlib-hashes
@anchor{using/configure cmdoption-with-builtin-hashlib-hashes}@anchor{1f4c}
@deffn {Option} @w{-}@w{-}with@w{-}builtin@w{-}hashlib@w{-}hashes=md5,sha1,sha256,sha512,sha3,blake2

Módulos embutidos de hash


@itemize *

@item 
@code{md5};

@item 
@code{sha1};

@item 
@code{sha256};

@item 
@code{sha512};

@item 
@code{sha3} (com shake);

@item 
@code{blake2}.
@end itemize


Adicionado na versão 3.9.

@end deffn

@geindex opção de linha de comando; --with-ssl-default-suites
@anchor{using/configure cmdoption-with-ssl-default-suites}@anchor{1f4d}
@deffn {Option} @w{-}@w{-}with@w{-}ssl@w{-}default@w{-}suites=[python|openssl|STRING]

Substitui a string dos conjuntos de criptografia padrão do OpenSSL:


@itemize *

@item 
@code{python} (padrão): use a seleciona preferida do Python;

@item 
@code{openssl}: mantém inalterados os padrões do OpenSSL;

@item 
`STRING': usa uma string personalizada
@end itemize

Veja o módulo @ref{d0,,ssl}.


Adicionado na versão 3.7.



Alterado na versão 3.10: As configurações @code{python} e `STRING' também definem TLS 1.2 como versão mínima do protocolo.

@end deffn

@node Opções do macOS,Opções do iOS,Opções de segurança,Opções de configuração
@anchor{using/configure macos-options}@anchor{1f4e}
@subsubsection Opções do macOS


Veja Mac/README.rst@footnote{https://github.com/python/cpython/tree/3.13/Mac/README.rst}.

@geindex opção de linha de comando; --enable-universalsdk
@anchor{using/configure cmdoption-enable-universalsdk}@anchor{972}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk
@end deffn

@geindex opção de linha de comando; --enable-universalsdk
@anchor{using/configure cmdoption-0}@anchor{1f4f}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk=SDKDIR

Cria uma construção binária universal. `SDKDIR' especifica qual SDK do macOS deve ser usado para executar a construção (o padrão é não).
@end deffn

@geindex opção de linha de comando; --enable-framework
@anchor{using/configure cmdoption-enable-framework}@anchor{1f50}
@deffn {Option} @w{-}@w{-}enable@w{-}framework
@end deffn

@geindex opção de linha de comando; --enable-framework
@anchor{using/configure cmdoption-1}@anchor{1f51}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

Cria um Python.framework em vez de uma instalação tradicional do Unix. O `INSTALLDIR' opcional especifica o caminho de instalação (o padrão é não).
@end deffn

@geindex opção de linha de comando; --with-universal-archs
@anchor{using/configure cmdoption-with-universal-archs}@anchor{1f52}
@deffn {Option} @w{-}@w{-}with@w{-}universal@w{-}archs=ARCH

Especifica o tipo de binário universal que deve ser criado. Esta opção só é válida quando @ref{972,,--enable-universalsdk} está definido.

Opções:


@itemize *

@item 
@code{universal2} (x86-64 e arm64);

@item 
@code{32-bit} (PPC e i386);

@item 
@code{64-bit}  (PPC64 e x86-64);

@item 
@code{3-way} (i386, PPC e x86-64);

@item 
@code{intel} (i386 e x86-64);

@item 
@code{intel-32} (i386);

@item 
@code{intel-64} (x86-64);

@item 
@code{all}  (PPC, i386, PPC64 e x86-64).
@end itemize

Observe que os valores para este item de configuração `não' são os mesmos que os identificadores usados para rodas binárias universais no macOS. Veja o Guia de Empacotamento do Python para detalhes sobre as tags de compatibilidade de plataforma de empacotamento usadas no macOS@footnote{https://packaging.python.org/pt-br/latest/specifications/platform-compatibility-tags/#macos}
@end deffn

@geindex opção de linha de comando; --with-framework-name
@anchor{using/configure cmdoption-with-framework-name}@anchor{1f53}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

Especifica o nome do framework python no macOS válido apenas quando @ref{1f50,,--enable-framework} está definido (padrão: @code{Python}).
@end deffn

@geindex opção de linha de comando; --with-app-store-compliance
@anchor{using/configure cmdoption-with-app-store-compliance}@anchor{16de}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance
@end deffn

@geindex opção de linha de comando; --with-app-store-compliance
@anchor{using/configure cmdoption-2}@anchor{1f54}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance=PATCH@w{-}FILE

A biblioteca padrão do Python contém strings que são conhecidas por acionar erros de ferramentas de inspeção automatizadas quando enviadas para distribuição pelas App Stores do macOS e do iOS. Se ativada, esta opção aplicará a lista de patches que corrigem a conformidade da app store. Um arquivo de patch personalizado também pode ser especificado. Esta opção está desativada por padrão.


Adicionado na versão 3.13.

@end deffn

@node Opções do iOS,Opções de compilação cruzada,Opções do macOS,Opções de configuração
@anchor{using/configure ios-options}@anchor{1f55}
@subsubsection Opções do iOS


Veja iOS/README.rst@footnote{https://github.com/python/cpython/tree/3.13/iOS/README.rst}.

@geindex opção de linha de comando; --enable-framework
@anchor{using/configure cmdoption-3}@anchor{1f56}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

Cria um Python.framework. Ao contrário do macOS, o argumento `INSTALLDIR' que especifica o caminho de instalação é obrigatório.
@end deffn

@geindex opção de linha de comando; --with-framework-name
@anchor{using/configure cmdoption-4}@anchor{1f57}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

Especifica o nome do framework (padrão: @code{Python}).
@end deffn

@node Opções de compilação cruzada,,Opções do iOS,Opções de configuração
@anchor{using/configure cross-compiling-options}@anchor{1f58}
@subsubsection Opções de compilação cruzada


A compilação cruzada, também conhecida como construção cruzada, pode ser usada para construir Python para outra arquitetura ou plataforma de CPU. A compilação cruzada requer um interpretador Python para a plataforma de construção. A versão do Python para construção deve corresponder à versão do Python da compilação cruzada do host.

@geindex opção de linha de comando; --build
@anchor{using/configure cmdoption-build}@anchor{1f59}
@deffn {Option} @w{-}@w{-}build=BUILD

configura para construir em BUILD, geralmente adivinhado por @code{config.guess}.
@end deffn

@geindex opção de linha de comando; --host
@anchor{using/configure cmdoption-host}@anchor{1f5a}
@deffn {Option} @w{-}@w{-}host=HOST

faz compilação cruzada para construir programas para executar no HOST (plataforma de destino)
@end deffn

@geindex opção de linha de comando; --with-build-python
@anchor{using/configure cmdoption-with-build-python}@anchor{1f5b}
@deffn {Option} @w{-}@w{-}with@w{-}build@w{-}python=path/to/python

caminho para construir o binário @code{python} para compilação cruzada


Adicionado na versão 3.11.

@end deffn

@geindex opção de linha de comando; CONFIG_SITE
@anchor{using/configure cmdoption-arg-CONFIG_SITE}@anchor{1f5c}
@deffn {Option} CONFIG_SITE=file

Uma variável de ambiente que aponta para um arquivo com substituições de configuração.

Exemplo de arquivo `config.site':

@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 opção de linha de comando; HOSTRUNNER
@anchor{using/configure cmdoption-arg-HOSTRUNNER}@anchor{1f5d}
@deffn {Option} HOSTRUNNER

Programa para executar CPython para a plataforma host para compilação cruzada.


Adicionado na versão 3.11.

@end deffn

Exemplo de compilação 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 Construção Python,Sinalizadores do compilador e do vinculador,Opções de configuração,Configurando o Python
@anchor{using/configure python-build-system}@anchor{1f5e}
@subsection Sistema de Construção Python


@menu
* Arquivos principais do sistema de construção:: 
* Principais etapas de construção:: 
* Alvos principais do Makefile:: 
* Extensões C:: 

@end menu

@node Arquivos principais do sistema de construção,Principais etapas de construção,,Sistema de Construção Python
@anchor{using/configure main-files-of-the-build-system}@anchor{1f5f}
@subsubsection Arquivos principais do sistema de construção



@itemize *

@item 
@code{configure.ac} => @code{configure};

@item 
@code{Makefile.pre.in} => @code{Makefile} (criado por @code{configure});

@item 
@code{pyconfig.h} (criado por @code{configure});

@item 
@code{Modules/Setup}: Extensões C construídas pelo Makefile usando o shell script @code{Module/makesetup};
@end itemize

@node Principais etapas de construção,Alvos principais do Makefile,Arquivos principais do sistema de construção,Sistema de Construção Python
@anchor{using/configure main-build-steps}@anchor{1f60}
@subsubsection Principais etapas de construção



@itemize *

@item 
Arquivos C (@code{.c}) são construídos como arquivos objeto (@code{.o}).

@item 
Uma biblioteca estática @code{libpython} (@code{.a}) é criada a partir de arquivos de objetos.

@item 
@code{python.o} e a biblioteca estática @code{libpython} estão vinculadas ao programa final @code{python}.

@item 
Extensões C são construídas pelo Makefile (veja @code{Modules/Setup}).
@end itemize

@node Alvos principais do Makefile,Extensões C,Principais etapas de construção,Sistema de Construção Python
@anchor{using/configure main-makefile-targets}@anchor{1f61}
@subsubsection Alvos principais do Makefile


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

@end menu

@node make,make platform,,Alvos principais do Makefile
@anchor{using/configure make}@anchor{1f62}
@subsubsection make


Na maioria das vezes, ao reconstruir após editar algum código ou atualizar seu checkout do upstream, tudo que você precisa fazer é executar @code{make}, que (pela semântica do Make) constrói o alvo padrão, o primeiro definido no Makefile. Por tradição (inclusive no projeto CPython) este é geralmente o alvo @code{all}. O script @code{configure} expande uma variável @code{autoconf}, @code{@@DEF_MAKE_ALL_RULE@@} para descrever precisamente quais alvos @code{make all} serão construídos. As três opções são:


@itemize *

@item 
@code{profile-opt} (configurado com @code{--enable-optimizations})

@item 
@code{build_wasm} (configurado com @code{--with-emscripten-target})

@item 
@code{build_all} (configurado sem usar explicitamente nenhum dos outros)
@end itemize

Dependendo das alterações mais recentes no arquivo fonte, o Make irá reconstruir quaisquer alvos (arquivos objetos e executáveis) considerados desatualizados, incluindo executar @code{configure} novamente se necessário. As dependências de origem/alvo são muitas e mantidas manualmente, portanto, às vezes, o Make não tem todas as informações necessárias para detectar corretamente todos os alvos que precisam ser reconstruídos. Dependendo de quais destinos não são reconstruídos, você poderá enfrentar vários problemas. Se você tiver problemas de construção ou teste que você não pode explicar de outra forma, @code{make clean && make} deve resolver a maioria dos problemas de dependência, às custas de tempos de construção mais longos.

@node make platform,make profile-opt,make,Alvos principais do Makefile
@anchor{using/configure make-platform}@anchor{1f63}
@subsubsection make platform


Constrói o programa @code{python}, mas não constrói os módulos de extensão da biblioteca padrão. Isto gera um arquivo chamado @code{platform} que contém uma única linha descrevendo os detalhes da plataforma de construção, por exemplo, @code{macosx-14.3-arm64-3.12} ou @code{linux-x86_64-3.13}.

@node make profile-opt,make clean,make platform,Alvos principais do Makefile
@anchor{using/configure make-profile-opt}@anchor{1f64}
@subsubsection make profile-opt


Constrói Python usando otimização guiada por perfil (PGO). Você pode usar a opção @ref{865,,--enable-optimizations} do configure para tornar este o alvo padrão do comando @code{make} (@code{make all} ou apenas @code{make}).

@node make clean,make distclean,make profile-opt,Alvos principais do Makefile
@anchor{using/configure make-clean}@anchor{1f65}
@subsubsection make clean


Remove arquivos construídos.

@node make distclean,make install,make clean,Alvos principais do Makefile
@anchor{using/configure make-distclean}@anchor{1f66}
@subsubsection make distclean


Além do trabalho feito por @code{make clean}, remove os arquivos criados pelo script configure. @code{configure} terá que ser executado antes de construir novamente. @footnote{
@code{git clean -fdx} é uma maneira ainda mais extrema de “limpar” seu checkout. Ele remove todos os arquivos não conhecidos pelo Git. Ao procurar bugs usando @code{git bisect}, isso é @uref{https://github.com/python/cpython/issues/114505#issuecomment-1907021718,recomendado entre testes} para garantir uma construção completamente limpa. `Use com cuidado', pois isso excluirá todos os arquivos não registrados no Git, incluindo seu trabalho novo e não confirmado.
}

@node make install,make test,make distclean,Alvos principais do Makefile
@anchor{using/configure make-install}@anchor{1f67}
@subsubsection make install


Constrói o alvo @code{all} e instala o Python.

@node make test,make buildbottest,make install,Alvos principais do Makefile
@anchor{using/configure make-test}@anchor{1f68}
@subsubsection make test


Constrói o alvo @code{all} e execute o conjunto de testes Python com a opção @code{--fast-ci}. Variáveis:


@itemize *

@item 
@code{TESTOPTS}: opções adicionais de linha de comando regrtest.

@item 
@code{TESTPYTHONOPTS}: opções adicionais de linha de comando do Python.

@item 
@code{TESTTIMEOUT}: tempo limite em segundos (padrão: 10 minutos).
@end itemize

@node make buildbottest,make regen-all,make test,Alvos principais do Makefile
@anchor{using/configure make-buildbottest}@anchor{1f69}
@subsubsection make buildbottest


Isto é semelhante ao @code{make test}, mas usa a opção @code{--slow-ci} e o tempo limite padrão de 20 minutos, em vez da opção @code{--fast-ci}.

@node make regen-all,,make buildbottest,Alvos principais do Makefile
@anchor{using/configure make-regen-all}@anchor{1f6a}
@subsubsection make regen-all


Gera novamente (quase) todos os arquivos gerados. Isso inclui (mas não está limitado a) casos de bytecode e arquivo gerador de analisador sintático. @code{make regen-stdlib-module-names} e @code{autoconf} devem ser executados separadamente para os restantes @ref{1ef0,,arquivos gerados}.

@node Extensões C,,Alvos principais do Makefile,Sistema de Construção Python
@anchor{using/configure c-extensions}@anchor{1f6b}
@subsubsection Extensões C


Algumas extensões C são construídas como módulos embutidos, como o módulo @code{sys}. Eles são construídos com a macro @code{Py_BUILD_CORE_BUILTIN} definida. Módulos embutidos não possuem nenhum atributo @code{__file__}:

@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

Outras extensões C são construídas como bibliotecas dinâmicas, como o módulo @code{_asyncio}. Eles são construídos com a macro @code{Py_BUILD_CORE_MODULE} definida. Exemplo no 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} é usado para gerar alvos Makefile para construir extensões C. No início dos arquivos, as extensões C são construídas como módulos embutidos. Extensões definidas após o marcador @code{*shared*} são construídas como bibliotecas dinâmicas.

As macros @code{PyAPI_FUNC()}, @code{PyAPI_DATA()} e @ref{151b,,PyMODINIT_FUNC} de @code{Include/exports.h} são definidas de forma diferente dependendo se a macro @code{Py_BUILD_CORE_MODULE} está definida:


@itemize *

@item 
Usa @code{Py_EXPORTED_SYMBOL} se @code{Py_BUILD_CORE_MODULE} estiver definido

@item 
Do contrário, usa @code{Py_IMPORTED_SYMBOL}.
@end itemize

Se a macro @code{Py_BUILD_CORE_BUILTIN} for usada por engano em uma extensão C construída como uma biblioteca compartilhada, sua função @code{PyInit_@var{xxx}()} não será exportada, causando um @ref{419,,ImportError} na importação.

@node Sinalizadores do compilador e do vinculador,,Sistema de Construção Python,Configurando o Python
@anchor{using/configure compiler-and-linker-flags}@anchor{1f6c}
@subsection Sinalizadores do compilador e do vinculador


Opções definidas pelo script @code{./configure} e variáveis de ambiente e usadas por @code{Makefile}.

@menu
* Sinalizadores do pré-processador:: 
* Sinalizadores do compilador:: 
* Sinalizadores do vinculador:: 

@end menu

@node Sinalizadores do pré-processador,Sinalizadores do compilador,,Sinalizadores do compilador e do vinculador
@anchor{using/configure preprocessor-flags}@anchor{1f6d}
@subsubsection Sinalizadores do pré-processador


@geindex variável de ambiente; CONFIGURE_CPPFLAGS
@anchor{using/configure envvar-CONFIGURE_CPPFLAGS}@anchor{1f6e}
@deffn {Variável De Ambiente} CONFIGURE_CPPFLAGS

Valor da variável 
@geindex CPPFLAGS
@geindex variável de ambiente; CPPFLAGS
@ref{1501,,CPPFLAGS} passado para o script @code{./configure}.


Adicionado na versão 3.6.

@end deffn

@geindex variável de ambiente; CPPFLAGS
@anchor{using/configure envvar-CPPFLAGS}@anchor{1501}
@deffn {Variável De Ambiente} CPPFLAGS

Sinalizadores de pré-processador C++ / (Objective) C, p.ex. @code{-I@var{include_dir}} se você tiver cabeçalhos em um diretório não padrão `include_dir'.

Tanto 
@geindex CPPFLAGS
@geindex variável de ambiente; CPPFLAGS
@ref{1501,,CPPFLAGS} quanto 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} precisam conter o valor do shell para poder construir módulos de extensão usando os diretórios especificados nas variáveis de ambiente.
@end deffn

@geindex variável de ambiente; BASECPPFLAGS
@anchor{using/configure envvar-BASECPPFLAGS}@anchor{1f6f}
@deffn {Variável De Ambiente} BASECPPFLAGS


Adicionado na versão 3.4.

@end deffn

@geindex variável de ambiente; PY_CPPFLAGS
@anchor{using/configure envvar-PY_CPPFLAGS}@anchor{1f70}
@deffn {Variável De Ambiente} PY_CPPFLAGS

Sinalizadores extras de pré-processador adicionados para construir os arquivos de objeto do interpretador.

Padrão: @code{$(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS)}.


Adicionado na versão 3.2.

@end deffn

@node Sinalizadores do compilador,Sinalizadores do vinculador,Sinalizadores do pré-processador,Sinalizadores do compilador e do vinculador
@anchor{using/configure compiler-flags}@anchor{1f71}
@subsubsection Sinalizadores do compilador


@geindex variável de ambiente; CC
@anchor{using/configure envvar-CC}@anchor{14fe}
@deffn {Variável De Ambiente} CC

Comando do compilador C.

Exemplo: @code{gcc -pthread}.
@end deffn

@geindex variável de ambiente; CXX
@anchor{using/configure envvar-CXX}@anchor{1f72}
@deffn {Variável De Ambiente} CXX

Comando do compilador C++.

Exemplo: @code{g++ -pthread}.
@end deffn

@geindex variável de ambiente; CFLAGS
@anchor{using/configure envvar-CFLAGS}@anchor{14ff}
@deffn {Variável De Ambiente} CFLAGS

Sinalizadores do compilador C.
@end deffn

@geindex variável de ambiente; CFLAGS_NODIST
@anchor{using/configure envvar-CFLAGS_NODIST}@anchor{1f73}
@deffn {Variável De Ambiente} CFLAGS_NODIST

@geindex CFLAGS_NODIST
@geindex variável de ambiente; CFLAGS_NODIST
@ref{1f73,,CFLAGS_NODIST} é usado para construir o interpretador e extensões C da stdlib. Use-o quando um sinalizador do compilador `não' deve fazer parte de 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS} depois que o Python estiver instalado (gh-65320@footnote{https://github.com/python/cpython/issues/65320}).

Em particular, 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS} não deve conter:


@itemize *

@item 
o sinalizador do compilador @code{-I} (para definir o caminho de pesquisa para arquivos incluídos). Os sinalizadores @code{-I} são processadas da esquerda para a direita, e quaisquer sinalizadores em 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS} terão precedência sobre os sinalizadores @code{-I} fornecidos pelo usuário e pelo pacote.

@item 
sinalizadores de segurança como @code{-Werror} porque as distribuições não podem controlar se os pacotes instalados pelos usuários estão em conformidade com esses padrões elevados.
@end itemize


Adicionado na versão 3.5.

@end deffn

@geindex variável de ambiente; COMPILEALL_OPTS
@anchor{using/configure envvar-COMPILEALL_OPTS}@anchor{1f74}
@deffn {Variável De Ambiente} COMPILEALL_OPTS

Opções passadas para a linha de comando @ref{20,,compileall} ao construir arquivos PYC em @code{make install}. Padrão: @code{-j0}.


Adicionado na versão 3.12.

@end deffn

@geindex variável de ambiente; EXTRA_CFLAGS
@anchor{using/configure envvar-EXTRA_CFLAGS}@anchor{1f75}
@deffn {Variável De Ambiente} EXTRA_CFLAGS

Sinalizadores extra do compilador C.
@end deffn

@geindex variável de ambiente; CONFIGURE_CFLAGS
@anchor{using/configure envvar-CONFIGURE_CFLAGS}@anchor{1f76}
@deffn {Variável De Ambiente} CONFIGURE_CFLAGS

Valor da variável 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS} passado para o script @code{./configure}.


Adicionado na versão 3.2.

@end deffn

@geindex variável de ambiente; CONFIGURE_CFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_CFLAGS_NODIST}@anchor{1f77}
@deffn {Variável De Ambiente} CONFIGURE_CFLAGS_NODIST

Valor da variável 
@geindex CFLAGS_NODIST
@geindex variável de ambiente; CFLAGS_NODIST
@ref{1f73,,CFLAGS_NODIST} passado para o script @code{./configure}.


Adicionado na versão 3.5.

@end deffn

@geindex variável de ambiente; BASECFLAGS
@anchor{using/configure envvar-BASECFLAGS}@anchor{1f78}
@deffn {Variável De Ambiente} BASECFLAGS

Sinalizadores base do compilador.
@end deffn

@geindex variável de ambiente; OPT
@anchor{using/configure envvar-OPT}@anchor{1f3b}
@deffn {Variável De Ambiente} OPT

Sinalizadores de otimização.
@end deffn

@geindex variável de ambiente; CFLAGS_ALIASING
@anchor{using/configure envvar-CFLAGS_ALIASING}@anchor{1f79}
@deffn {Variável De Ambiente} CFLAGS_ALIASING

Sinalizadores de alias estritos ou não estritos usados para compilar @code{Python/dtoa.c}.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; CCSHARED
@anchor{using/configure envvar-CCSHARED}@anchor{1f7a}
@deffn {Variável De Ambiente} CCSHARED

Sinalizadores de compilador usados para construir uma biblioteca compartilhada.

Por exemplo, @code{-fPIC} é usado no Linux e no BSD.
@end deffn

@geindex variável de ambiente; CFLAGSFORSHARED
@anchor{using/configure envvar-CFLAGSFORSHARED}@anchor{1f7b}
@deffn {Variável De Ambiente} CFLAGSFORSHARED

Sinalizadores extras de C adicionados para construir os arquivos de objeto do interpretador.

Padrão: @code{$(CCSHARED)} quando @ref{866,,--enable-shared} é usado, ou uma string vazia caso contrário.
@end deffn

@geindex variável de ambiente; PY_CFLAGS
@anchor{using/configure envvar-PY_CFLAGS}@anchor{1f7c}
@deffn {Variável De Ambiente} PY_CFLAGS

Padrão: @code{$(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS)}.
@end deffn

@geindex variável de ambiente; PY_CFLAGS_NODIST
@anchor{using/configure envvar-PY_CFLAGS_NODIST}@anchor{1f7d}
@deffn {Variável De Ambiente} PY_CFLAGS_NODIST

Padrão: @code{$(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal}.


Adicionado na versão 3.5.

@end deffn

@geindex variável de ambiente; PY_STDMODULE_CFLAGS
@anchor{using/configure envvar-PY_STDMODULE_CFLAGS}@anchor{1f7e}
@deffn {Variável De Ambiente} PY_STDMODULE_CFLAGS

Sinalizadores do C usados para construir os arquivos de objeto do interpretador.

Padrão: @code{$(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)}.


Adicionado na versão 3.7.

@end deffn

@geindex variável de ambiente; PY_CORE_CFLAGS
@anchor{using/configure envvar-PY_CORE_CFLAGS}@anchor{1f7f}
@deffn {Variável De Ambiente} PY_CORE_CFLAGS

Padrão: @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE}.


Adicionado na versão 3.2.

@end deffn

@geindex variável de ambiente; PY_BUILTIN_MODULE_CFLAGS
@anchor{using/configure envvar-PY_BUILTIN_MODULE_CFLAGS}@anchor{1f80}
@deffn {Variável De Ambiente} PY_BUILTIN_MODULE_CFLAGS

Sinalizadores do compilador para construir um módulo de extensão de biblioteca padrão como um módulo embutido, como o módulo @ref{ad,,posix}.

Padrão: @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN}.


Adicionado na versão 3.8.

@end deffn

@geindex variável de ambiente; PURIFY
@anchor{using/configure envvar-PURIFY}@anchor{1f81}
@deffn {Variável De Ambiente} PURIFY

Comando de Purify. Purify é um programa depurador de memória.

Padrão: string vazia (não usada).
@end deffn

@node Sinalizadores do vinculador,,Sinalizadores do compilador,Sinalizadores do compilador e do vinculador
@anchor{using/configure linker-flags}@anchor{1f82}
@subsubsection Sinalizadores do vinculador


@geindex variável de ambiente; LINKCC
@anchor{using/configure envvar-LINKCC}@anchor{1f83}
@deffn {Variável De Ambiente} LINKCC

Comando do vinculador usado para construir programas como @code{python} e @code{_testembed}.

Padrão: @code{$(PURIFY) $(CC)}.
@end deffn

@geindex variável de ambiente; CONFIGURE_LDFLAGS
@anchor{using/configure envvar-CONFIGURE_LDFLAGS}@anchor{1f84}
@deffn {Variável De Ambiente} CONFIGURE_LDFLAGS

Valor da variável 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} passado para o script @code{./configure}.

Evite atribuir 
@geindex CFLAGS
@geindex variável de ambiente; CFLAGS
@ref{14ff,,CFLAGS}, 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS}, etc. para que os usuários possam usá-los na linha de comando para anexar a esses valores sem pisotear os valores predefinidos.


Adicionado na versão 3.2.

@end deffn

@geindex variável de ambiente; LDFLAGS_NODIST
@anchor{using/configure envvar-LDFLAGS_NODIST}@anchor{1f85}
@deffn {Variável De Ambiente} LDFLAGS_NODIST

@geindex LDFLAGS_NODIST
@geindex variável de ambiente; LDFLAGS_NODIST
@ref{1f85,,LDFLAGS_NODIST} é usado da mesma maneira que 
@geindex CFLAGS_NODIST
@geindex variável de ambiente; CFLAGS_NODIST
@ref{1f73,,CFLAGS_NODIST}. Use-o quando um sinalizador de vinculador `não' fizer parte de 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} depois que o Python estiver instalado (gh-65320@footnote{https://github.com/python/cpython/issues/65320}).

Em particular, 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} não deve conter:


@itemize *

@item 
o sinalizador do compilador @code{-L} (para definir o caminho de pesquisa para arquivos incluídos). Os sinalizadores @code{-L} são processadas da esquerda para a direita, e quaisquer sinalizadores em 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} terão precedência sobre os sinalizadores @code{-L} fornecidos pelo usuário e pelo pacote.
@end itemize
@end deffn

@geindex variável de ambiente; CONFIGURE_LDFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_LDFLAGS_NODIST}@anchor{1f86}
@deffn {Variável De Ambiente} CONFIGURE_LDFLAGS_NODIST

Valor da variável 
@geindex LDFLAGS_NODIST
@geindex variável de ambiente; LDFLAGS_NODIST
@ref{1f85,,LDFLAGS_NODIST} passado para o script @code{./configure}.


Adicionado na versão 3.8.

@end deffn

@geindex variável de ambiente; LDFLAGS
@anchor{using/configure envvar-LDFLAGS}@anchor{1500}
@deffn {Variável De Ambiente} LDFLAGS

Sinalizadores do vinculador, p.ex. @code{-L@var{lib_dir}}, se você tiver bibliotecas em um diretório não padrão `lib_dir'.

Tanto 
@geindex CPPFLAGS
@geindex variável de ambiente; CPPFLAGS
@ref{1501,,CPPFLAGS} quanto 
@geindex LDFLAGS
@geindex variável de ambiente; LDFLAGS
@ref{1500,,LDFLAGS} precisam conter o valor do shell para poder construir módulos de extensão usando os diretórios especificados nas variáveis de ambiente.
@end deffn

@geindex variável de ambiente; LIBS
@anchor{using/configure envvar-LIBS}@anchor{1f87}
@deffn {Variável De Ambiente} LIBS

Sinalizadores do vinculador para passar bibliotecas para o vinculador ao vincular o executável Python.

Exemplo: @code{-lrt}.
@end deffn

@geindex variável de ambiente; LDSHARED
@anchor{using/configure envvar-LDSHARED}@anchor{1f88}
@deffn {Variável De Ambiente} LDSHARED

Comando para construir uma biblioteca compartilhada.

Padrão: @code{@@LDSHARED@@ $(PY_LDFLAGS)}.
@end deffn

@geindex variável de ambiente; BLDSHARED
@anchor{using/configure envvar-BLDSHARED}@anchor{1f89}
@deffn {Variável De Ambiente} BLDSHARED

Comando para construir a biblioteca compartilhada @code{libpython}.

Padrão: @code{@@BLDSHARED@@ $(PY_CORE_LDFLAGS)}.
@end deffn

@geindex variável de ambiente; PY_LDFLAGS
@anchor{using/configure envvar-PY_LDFLAGS}@anchor{1f8a}
@deffn {Variável De Ambiente} PY_LDFLAGS

Padrão: @code{$(CONFIGURE_LDFLAGS) $(LDFLAGS)}.
@end deffn

@geindex variável de ambiente; PY_LDFLAGS_NODIST
@anchor{using/configure envvar-PY_LDFLAGS_NODIST}@anchor{1f8b}
@deffn {Variável De Ambiente} PY_LDFLAGS_NODIST

Padrão: @code{$(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST)}.


Adicionado na versão 3.8.

@end deffn

@geindex variável de ambiente; PY_CORE_LDFLAGS
@anchor{using/configure envvar-PY_CORE_LDFLAGS}@anchor{1f8c}
@deffn {Variável De Ambiente} PY_CORE_LDFLAGS

Sinalizadores de vinculador usados para construir os arquivos de objeto do interpretador.


Adicionado na versão 3.8.

@end deffn

@node Utilizando Python no Windows,Usando Python em macOS,Configurando o Python,Configurações e Uso do Python
@anchor{using/windows doc}@anchor{1f8d}@anchor{using/windows translation-repo}@anchor{1f8e}@anchor{using/windows using-on-windows}@anchor{ab6}@anchor{using/windows using-python-on-windows}@anchor{1f8f}
@section Utilizando Python no Windows


Este documento pretende dar uma visão geral do comportamento específico do Windows que você deve conhecer quando fores utilizar o Python no sistema operacional Microsoft Windows.

Diferente da maioria dos sistemas e serviços Unix, o Windows não inclui uma instalação suportada do Python. Para deixar o Python disponível, o time CPython compilou os instaladores do Windows com cada versão@footnote{https://www.python.org/downloads/} por vários anos. Esses instaladores têm a intenção primária de adicionar uma instalação de Python por usuário, com o interpretador e as bibliotecas núcleo sendo utilizadas por um único usuário. O instalador também é capaz de instalar para todos os usuários de uma única máquina, e um arquivo ZIP separado está disponível para distribuições locais de aplicação.

Como especificado na 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}, uma versão Python suporta apenas uma plataforma Windows enquanto a Microsoft considera a plataforma sob suporte estendido. Isso significa que o Python 3.13 suporta Windows 8.1 ou superiores. Se você requer suporte à Windows 7, por favor instale o Python 3.8.

Há uma quantidade de instaladores diferentes disponíveis para Windows, cada um com algumas vantagens e desvantagens.

@ref{1f90,,O instalador completo} contém todos os componentes e é a melhor opção para desenvolvedores usando Python para qualquer tipo de projeto.

@ref{1d62,,O pacote Microsoft Store} é uma instalação simples do Python que é adequada para executar scripts e pacotes, e para usar a IDLE ou outros ambientes de desenvolvimento. Ela requer Windows 10 e superior, mas pode ser instalada de forma segura sem corromper outros programas. Ela também fornece vários comandos convenientes para iniciar o Python e suas ferramentas.

@ref{1f91,,Os pacotes nuget.org} são instalações leves criadas para integração contínua de sistemas. Elas podem ser usadas para construir pacotes Python ou executar scripts, mas não são atualizáveis e não possuem ferramentas de interface de usuário.

@ref{1f92,,O pacote embutível} é um pacote mínimo de Python adequado para ser incorporado em uma aplicação maior.

@menu
* O instalador completo:: 
* O pacote Microsoft Store:: 
* Os pacotes nuget.org: Os pacotes nuget org. 
* O pacote embutível:: 
* Pacotes Alternativos:: 
* Configurando o Python: Configurando o Python<2>. 
* Modo UTF-8:: 
* Inicializador Python para Windows:: 
* Encontrando módulos:: 
* Módulos adicionais:: 
* Compilando Python no Windows:: 
* Outras plataformas:: 

@end menu

@node O instalador completo,O pacote Microsoft Store,,Utilizando Python no Windows
@anchor{using/windows the-full-installer}@anchor{1f93}@anchor{using/windows windows-full}@anchor{1f90}
@subsection O instalador completo


@menu
* Etapas de instalação:: 
* Removendo a Limitação do MAX_PATH:: 
* Instalando sem UI:: 
* Instalando Sem Download:: 
* Modificando uma instalação:: 
* Instalando binários com threads livres:: 

@end menu

@node Etapas de instalação,Removendo a Limitação do MAX_PATH,,O instalador completo
@anchor{using/windows installation-steps}@anchor{1f94}
@subsubsection Etapas de instalação


Quatro instaladores Python 3.13 estão disponíveis para download - dois de cada para as versões 32-bit e 64-bit do interpretador. O `instalador web' é um download inicial menor, e ele irá automaticamente fazer o download dos componentes solicitados na medida do necessário. O `instalador offline' inclui os componentes necessários para uma instalação padrão e requer apenas uma conexão de internet para recursos opcionais. Veja @ref{1f95,,Instalando Sem Download} para outras formas de evitar o download durante a instalação.

Após iniciar o instalador, uma de duas opções deve ser selecionada:

@image{python-figures/win_installer,,,,png}

Se você selecionar “Install Now”:


@itemize *

@item 
Você `não' precisará ser um administrador (a menos que uma atualização de sistema para a Biblioteca em Tempo de Execução C seja necessária ou que você instale o @ref{5be,,Inicializador Python para Windows} para todos os usuários)

@item 
Python será instalado dentro do seu diretório de usuário

@item 
O @ref{5be,,Inicializador Python para Windows} será instalado de acordo com a opção ao final da primeira página

@item 
A biblioteca padrão, a suíte de testes, o inicializador e o pip serão instalados

@item 
Se selecionado, o diretório de instalação será adicionado no seu 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}

@item 
Atalhos serão visíveis apenas para o usuário atual
@end itemize

Selecionando “Customize installation” irá permitir que você selecione os recursos a serem instalados, o local da instalação e outras opções ou ações pós-instalação. Para instalar símbolos de depuração ou binários, você precisará usar essa opção.

Para realizar uma instalação para todos os usuários, você deve selecionar “Customize installation”. Neste caso:


@itemize *

@item 
Você pode ser solicitado a providenciar credenciais administrativas ou aprovação

@item 
Python será instalado dentro do diretório Program Files (Arquivos de Programa)

@item 
O @ref{5be,,Inicializador Python para Windows} será instalado dentro do diretório Windows

@item 
Recursos opcionais podem ser selecionados durante a instalação

@item 
A biblioteca padrão pode ser pré-compilada em bytecode

@item 
Se selecionado, o diretório de instalação será adicionado ao 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} do sistema

@item 
Atalhos estão disponíveis para todos os usuários
@end itemize

@node Removendo a Limitação do MAX_PATH,Instalando sem UI,Etapas de instalação,O instalador completo
@anchor{using/windows max-path}@anchor{c5c}@anchor{using/windows removing-the-max-path-limitation}@anchor{1f96}
@subsubsection Removendo a Limitação do MAX_PATH


O Windows historicamente tem limitado os comprimentos dos caminhos de arquivos em 260 caracteres. Isso significava que caminhos maiores que isso não seriam resolvidos e resultariam em erros.

Nas últimas versões do Windows, essa limitação pode ser expandida para aproximadamente 32.000 caracteres. Seu administrador irá precisar ativar a política de grupo “Enable Win32 long paths”, ou definir @code{LongPathsEnabled} para @code{1} na chave de registro @code{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem}.

Isso permite que a função @ref{51c,,open()}, o módulo @ref{a1,,os} e a maior parte das outras funcionalidades de caminho aceitem e retornem caminhos maiores que 260 caracteres quando usando strings.

Após alterar a opção acima, nenhuma configuração adicional é necessária.


Alterado na versão 3.6: Suporte para caminhos longos foi ativado no Python.


@node Instalando sem UI,Instalando Sem Download,Removendo a Limitação do MAX_PATH,O instalador completo
@anchor{using/windows install-quiet-option}@anchor{5ee}@anchor{using/windows installing-without-ui}@anchor{1f97}
@subsubsection Instalando sem UI


Todas as opções disponíveis na IU do instalador também podem ser especificadas a partir da linha de comando, permitindo que instaladores por script repliquem uma instalação em várias máquinas sem interação do usuário. Essas opções também podem ser definidas sem suprimir a IU para alterar alguns dos padrões.

As seguintes opções (encontradas executando o instalador com @code{/?}) podem ser passadas para o instalador:


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Descrição

@item

/passive

@tab

para exibir o progresso sem exigir interação do usuário

@item

/quiet

@tab

para instalar/desinstalar sem exibir nenhuma UI

@item

/simple

@tab

para evitar a personalização do usuário

@item

/uninstall

@tab

para remover o Python (sem exigir confirmação)

@item

/layout [diretório]

@tab

para pré-baixar todos os componentes

@item

/log [nome-de-arquivo]

@tab

para especificar a localização dos arquivos de log

@end multitable


Todas as outras opções são passadas como @code{name=value}, onde o valor é usualmente @code{0} para desabilitar o recurso, @code{1} para ativar o recurso, ou um caminho. A lista completa de opções disponíveis é mostrada abaixo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Descrição

@tab

Default (padrão)

@item

InstallAllUsers (Instalar para Todos usuários)

@tab

Execute uma instalação em todo o sistema.

@tab

0

@item

TargetDir (Diretório Alvo)

@tab

O diretório de instalação

@tab

Selecionado com base em “Instalar para Todos os Usuários”

@item

DefaultAllUsersTargetDir (Diretório de Destino Padrão para Todos os usuários)

@tab

O diretório de instalação padrão para instalações de todos os usuários

@tab

@code{%ProgramFiles%\Python X.Y} or @code{%ProgramFiles(x86)%\Python X.Y}

@item

DefaultJustForMeTargetDir (Diretório Alvo Padrão Apenas Para Mim)

@tab

O diretório de instalação padrão para instalações just-for-me

@tab

@code{%LocalAppData%\Programs\Python\PythonXY} ou @code{%LocalAppData%\Programs\Python\PythonXY-32} ou @code{%LocalAppData%\Programs\Python\PythonXY-64}

@item

DefaultCustomTargetDir (Diretório de destino personalizado padrão)

@tab

Diretório de instalação personalizado padrão exibido na interface do usuário

@tab

(vazio)

@item

AssociateFiles (Arquivos Associados)

@tab

Criar associações de arquivos se o launcher também estiver instalado.

@tab

1

@item

CompileAll (Compilar Tudo)

@tab

Compile todos os arquivos @code{.py} para @code{.pyc}.

@tab

0

@item

PrependPath (path a ser percorrido)

@tab

Anexa os diretórios de instalação e Scripts ao início de 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} e adiciona @code{.PY} a 
@geindex PATHEXT
@geindex variável de ambiente; PATHEXT
@code{PATHEXT}

@tab

0

@item

AppendPath

@tab

Anexa os diretórios de instalação e Scripts ao final de 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} e adiciona @code{.PY} a 
@geindex PATHEXT
@geindex variável de ambiente; PATHEXT
@code{PATHEXT}

@tab

0

@item

Shortcuts (atalhos)

@tab

Crie atalhos para o interpretador, documentação e IDLE se instalado.

@tab

1

@item

Include_doc

@tab

Install Python manual (Instalação Manual do Python)

@tab

1

@item

Include_debug (Incluir o Modo de Depuração)

@tab

Instalar binários de Depuração

@tab

0

@item

Include_dev

@tab

Instala cabeçalhos e bibliotecas do desenvolvedor. Omitir isso pode levar a uma instalação inutilizável.

@tab

1

@item

Include_exe

@tab

Instala @code{python.exe} e arquivos relacionados. Omitir isso pode levar a uma instalação inutilizável.

@tab

1

@item

Include_launcher

@tab

Instalar @ref{5be,,Inicializador Python para Windows}.

@tab

1

@item

InstallLauncherAllUsers

@tab

Instala o iniciador para todos os usuários. Também requer @code{Include_launcher} para ser definido como 1

@tab

1

@item

Include_lib

@tab

Instala a biblioteca padrão e os módulos de extensão. Omitir isso pode levar a uma instalação inutilizável.

@tab

1

@item

Include_pip

@tab

Instale o pacote pip e setuptools

@tab

1

@item

Include_symbols

@tab

Instala símbolos de depuração (@code{*.pdb})

@tab

0

@item

Include_tcltk

@tab

Instale o suporte Tcl/Tk e o IDLE

@tab

1

@item

Include_test

@tab

Instalar o conjunto de testes da biblioteca padrão

@tab

1

@item

Include_tools

@tab

Instalar scripts com utilitários

@tab

1

@item

LauncherOnly

@tab

Instala apenas o launcher. Isso substituirá a maioria das outras opções.

@tab

0

@item

SimpleInstall

@tab

Desativar a maioria das UIs de instalação

@tab

0

@item

SimpleInstallDescription

@tab

Uma mensagem personalizada para exibir quando a IU de instalação simplificada é usada.

@tab

(vazio)

@end multitable


Por exemplo, para instalar silenciosamente uma instalação de Python padrão e em todo o sistema, você pode usar o seguinte comando (a partir de um terminal de comando autorizado):

@example
python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0
@end example

Para permitir que usuários instalem facilmente uma cópia do Python sem a suíte de testes, você pode fornecer um atalho com o seguinte comando. Isso irá exibir uma página inicial simplificado e bloquear a personalização:

@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

(Observe que omitir o inicializador também omite associações de arquivos, e só é recomendado para instalações por usuários quando também existe uma instalação por todo o sistema que inclui o inicializador.)

As opções listadas acima também podem ser fornecidas em um arquivo chamado @code{unattend.xml} juntamente com o executável. Esse arquivo especifica uma lista de opções e valores. Quando um valor é fornecido como um atributo, ele será convertido para um número se possível. Valores fornecidos como elementos de texto são sempre deixados como strings. Esse arquivo de exemplo define as mesmas opções que o exemplo 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 Instalando Sem Download,Modificando uma instalação,Instalando sem UI,O instalador completo
@anchor{using/windows install-layout-option}@anchor{1f95}@anchor{using/windows installing-without-downloading}@anchor{1f98}
@subsubsection Instalando Sem Download


Como alguns recursos do Python não estão inclusos no download inicial do instalador, selecionar esses recursos pode exigir uma conexão com a internet. Para evitar isso, todos os possíveis componentes podem ser baixados sob demanda para criar um `layout' completo que não irá precisar de uma conexão de internet independentemente dos recursos selecionados. Note que este download pode ser maior que o necessário, mas onde um grande número de instalações serão realizadas é bem útil ter uma cópia em cache local.

Execute o seguinte comando a partir do Prompt de Comando para fazer o download de todos os possíveis arquivos necessários. Lembre-se de substituir @code{python-3.9.0.exe} pelo nome real do seu instalador, e de criar layouts nos respectivos diretórios para evitar colisão entre arquivos com o mesmo nome.

@example
python-3.9.0.exe /layout [diretório alvo opcional]
@end example

Você também pode especificar a opção @code{/quiet} para esconder o acompanhamento de progresso.

@node Modificando uma instalação,Instalando binários com threads livres,Instalando Sem Download,O instalador completo
@anchor{using/windows modifying-an-install}@anchor{1f99}
@subsubsection Modificando uma instalação


Uma vez que o Python foi instalado, você pode adicionar ou remover recursos através da ferramenta Programas e Recursos que é parte do Windows. Selecione o registro do Python e escolha “Uninstall/Change” para abrir o instalador no modo de manutenção.

“Modify” permite que você adicione ou remova recursos modificando as caixas de entrada - caixas de entrada não modificadas não irão instalar ou remover nada. Algumas opções não podem ser modificadas dessa forma, como o diretório de instalação; para modificá-las, você precisará remover e então reinstalar o Python completamente.

“Repair” irá verificar todos os arquivos que devem ser instalados usando as configurações atuais e substituir qualquer um que tiver sido removido ou modificado.

“Uninstall” irá remover o Python completamente, com a exceção do @ref{5be,,Inicializador Python para Windows}, que tem seu próprio registro nos Programas e Recursos.

@node Instalando binários com threads livres,,Modificando uma instalação,O instalador completo
@anchor{using/windows install-freethreaded-windows}@anchor{172}@anchor{using/windows installing-free-threaded-binaries}@anchor{1f9a}
@subsubsection Instalando binários com threads livres



Adicionado na versão 3.13: (Experimental)


@cartouche
@quotation Nota 
Tudo descrito nesta seção é considerado experimental e espera-se que mude em versões futuras.
@end quotation
@end cartouche

Para instalar binários pré-construídos com recurso de threads livres habilitado (veja 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}), você deve selecionar “Customize installation” (Instalação personalizada). A segunda página de opções inclui a caixa de seleção “Download free-threaded binaries” (Baixar binários de threads livres).

@image{python-figures/win_install_freethreaded,,,,png}

Selecionar esta opção fará o download e instalará binários adicionais no mesmo local da instalação principal do Python. O executável principal é chamado @code{python3.13t.exe}, e outros binários recebem um sufixo @code{t} ou um sufixo ABI completo. Arquivos de origem do Python e dependências de terceiros empacotadas são compartilhadas com a instalação principal.

A versão com threads livres é registrada como uma instalação regular do Python com a tag @code{3.13t} (com um sufixo @code{-32} ou @code{-arm64} como normal para essas plataformas). Isso permite que as ferramentas o descubram e que o @ref{5be,,Inicializador Python para Windows} ofereça suporte a @code{py.exe -3.13t}. Observe que o inicializador interpretará @code{py.exe -3} (ou um shebang @code{python3}) como “a instalação 3.x mais recente”, que preferirá os binários com threads livres aos normais, enquanto @code{py.exe -3.13} não. Se você usar o estilo curto da opção, talvez prefira não instalar os binários com threads livres neste momento.

Para especificar a opção de instalação na linha de comando, use @code{Include_freethreaded=1}. Veja @ref{1f95,,Instalando Sem Download} para instruções sobre como baixar preventivamente os binários adicionais para instalação offline. As opções para incluir símbolos de depuração e binários também se aplicam às construções com threads livres.

Binários com threads livres também estão disponíveis @ref{1f91,,em nuget.org}.

@node O pacote Microsoft Store,Os pacotes nuget org,O instalador completo,Utilizando Python no Windows
@anchor{using/windows the-microsoft-store-package}@anchor{1f9b}@anchor{using/windows windows-store}@anchor{1d62}
@subsection O pacote Microsoft Store



Adicionado na versão 3.7.2.


O pacote Microsoft Store é um interpretador Python facilmente instalável criado principalmente para uso interativo, por exemplo, por estudantes.

Para instalar o pacote, certifique-se de que você possui as últimas 10 atualizações do Windows e procure o app “Python 3.13” na Microsoft Store. Certifique-se que o app que você selecionou foi publicado pela Python Software Foundation, e instale-o.

@cartouche
@quotation Aviso 
Python sempre estará disponível gratuitamente na Microsoft Store. Se você for solicitado a pagar por ele, você não selecionou o pacote correto.
@end quotation
@end cartouche

Após a instalação, o Python pode ser inicializado por pesquisa no menu Iniciar. Alternativamente, ele estará disponível a partir de qualquer Prompt de Comando ou sessão PowerShell apenas digitando @code{python}. Além disso, o pip e a IDLE podem ser usados digitando @code{pip} ou @code{idle}. A IDLE também pode ser encontrada no menu Iniciar.

Todos os três comandos também estão disponíveis com sufixos do número da versão, por exemplo, como em @code{python3.exe} e @code{python3.x.exe} bem como @code{python.exe} (onde @code{3.x} é a versão específica que você quer iniciar, como a 3.13). Abra o “Gerenciar aliases de execução de aplicativo” através do menu Iniciar para selecionar qual versão do Python está associada com cada comando. É recomendado que você se certifique que @code{pip} e @code{idle} são consistentes com qualquer versão do @code{python} que seja selecionada.

Ambientes virtuais podem ser criados com @code{python -m venv} e ativados e usados normalmente.

Se você instalou outra versão do Python e adicionou ela à sua variável @code{PATH}, ela estará disponível com @code{python.exe} ao invés de uma instalada pela Microsoft Store. Para acessar a nova instalação, use @code{python3.exe} ou @code{python3.x.exe}.

O instalador @code{py.exe} irá detectar essa instalação do Python, mas irá preferir instalações feitas pelo instalador tradicional.

Para remover o Python, abra as Configurações e use Aplicativos e Recursos, ou encontre o Python no menu Iniciar e clique com o botão direito para selecionar Desinstalar. A desinstalação irá remover todos os pacotes que você instalou diretamente dentro dessa instalação do Python, mas não irá remover nenhum ambiente virtual.

@menu
* Problemas conhecidos:: 

@end menu

@node Problemas conhecidos,,,O pacote Microsoft Store
@anchor{using/windows known-issues}@anchor{1f9c}
@subsubsection Problemas conhecidos


@menu
* Redirecionamento de dados locais@comma{} registro e caminhos temporários: Redirecionamento de dados locais registro e caminhos temporários. 

@end menu

@node Redirecionamento de dados locais registro e caminhos temporários,,,Problemas conhecidos
@anchor{using/windows redirection-of-local-data-registry-and-temporary-paths}@anchor{1f9d}
@subsubsection Redirecionamento de dados locais, registro e caminhos temporários


Por causa de restrições nos aplicativos da Microsoft Store, scripts Python podem não ter acesso de escrita completo em locais compartilhados como 
@geindex TEMP
@geindex variável de ambiente; TEMP
@code{TEMP} ou o registro. Ao invés disso, ele irá escrever uma cópia privada. Se seus scripts precisam modificar locais compartilhados, você terá que instalar o instalador completo.

At runtime, Python will use a private copy of well-known Windows folders and the registry.
For example, if the environment variable @code{%APPDATA%} is @code{c:\Users\<user>\AppData\},
then when writing to @code{C:\Users\<user>\AppData\Local} will write to
@code{C:\Users\<user>\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\LocalCache\Local\}.

Ao ler arquivos, o Windows retornará o arquivo da pasta privada ou, se não existir, o diretório real do Windows. Por exemplo, ler @code{C:\Windows\System32} retorna o conteúdo de @code{C:\Windows\System32} mais o conteúdo de @code{C:\Program Files\WindowsApps \nome_pacote\VFS\SystemX86}.

Você pode encontrar o caminho real de qualquer arquivo existente usando @ref{225,,os.path.realpath()}:

@example
>>> import os
>>> test_file = 'C:\\Users\\exemplo\\AppData\\Local\\test.txt'
>>> os.path.realpath(test_file)
'C:\\Users\\exemplo\\AppData\\Local\\Packages\\PythonSoftwareFoundation.Python.3.8_qbz5n2kfra8p0\\LocalCache\\Local\\test.txt'
@end example

Ao gravar no Registro do Windows, existem os seguintes comportamentos:


@itemize *

@item 
A leitura de @code{HKLM\\Software} é permitida e os resultados são mesclados com o arquivo @code{registry.dat} no pacote.

@item 
Gravar em @code{HKLM\\Software} não é permitido se a chave/valor correspondente existir, ou seja, modificar chaves existentes.

@item 
Gravar em @code{HKLM\\Software} é permitido desde que uma chave/valor correspondente não exista no pacote e o usuário tenha as permissões de acesso corretas.
@end itemize

Para obter mais detalhes sobre a base técnica dessas limitações, consulte a documentação da Microsoft sobre aplicativos de confiança total empacotados, atualmente disponíveis em docs.microsoft.com/pt-br/windows/msix/desktop/desktop-to-uwp-behind-the-scenes@footnote{https://learn.microsoft.com/windows/msix/desktop/desktop-to-uwp-behind-the-scenes}

@node Os pacotes nuget org,O pacote embutível,O pacote Microsoft Store,Utilizando Python no Windows
@anchor{using/windows the-nuget-org-packages}@anchor{1f9e}@anchor{using/windows windows-nuget}@anchor{1f91}
@subsection Os pacotes nuget.org



Adicionado na versão 3.5.2.


O pacote nuget.org é um ambiente Python de tamanho reduzido criado para uso em integração contínua e construção de sistemas que não precisam de uma instalação de Python por todo o sistema da máquina. Enquanto nuget é o “gerenciador de pacotes para .NET”, ele também funciona perfeitamente bem para pacotes contendo ferramentas em tempo de construção.

Visite nuget.org@footnote{https://www.nuget.org/} para informações mais atualizadas sobre utilização do nuget. A seguir está um sumário que é suficiente para desenvolvedores Python.

A ferramenta de linha de comando @code{nuget.exe} pode ser baixada diretamente de @code{https://aka.ms/nugetclidl}, por exemplo, usando o curl ou PowerShell. Com a ferramenta, a versão mais recente do Python para máquinas 64-bit ou 32-bit é instalada usando:

@example
nuget.exe install python -ExcludeVersion -OutputDirectory .
nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .
@end example

Para selecionar uma versão específica, adicione @code{-Version 3.x.y}. O diretório de saída pode ser mudado de @code{.}, e o pacote será instalado em um subdiretório. Por padrão, o subdiretório é nomeado igual ao pacote, e sem a opção @code{-ExcludeVersion} esse nome irá incluir a versão específica instalada. Dentro do subdiretório está um diretório @code{tools} que contém a instalação do Python:

@example
# Sem -ExcludeVersion
> .\python.3.5.2\tools\python.exe -V
Python 3.5.2

# Com -ExcludeVersion
> .\python\tools\python.exe -V
Python 3.5.2
@end example

Em geral, pacotes nuget não são atualizáveis, e novas versões devem ser instaladas lado-a-lado e referenciadas usando o caminho completo. Alternativamente, delete o diretório do pacote manualmente e instale novamente. Muitos sistemas CI irão fazer isso automaticamente se eles não preservam arquivos entre construções de projetos.

Juntamente com o diretório @code{tools} está o diretório @code{build\native}. Ele contém um arquivo de propriedades MSBuild @code{python.props} que pode ser usado em um projeto C++ para referenciar a instalação do Python. Incluir as configurações irá automaticamente usar os cabeçalhos e importar as bibliotecas na sua construção de projeto.

As páginas de informação dos pacotes em nuget.org são www.nuget.org/packages/python@footnote{https://www.nuget.org/packages/python} para a versão 64 bits, www.nuget.org/packages/pythonx86@footnote{https://www.nuget.org/packages/pythonx86} para a versão 32 bits e www.nuget.org/packages/pythonarm64@footnote{https://www.nuget.org/packages/pythonarm64} para a versão ARM64

@menu
* Pacotes com threads livres:: 

@end menu

@node Pacotes com threads livres,,,Os pacotes nuget org
@anchor{using/windows free-threaded-packages}@anchor{1f9f}
@subsubsection Pacotes com threads livres



Adicionado na versão 3.13: (Experimental)


@cartouche
@quotation Nota 
Tudo descrito nesta seção é considerado experimental e espera-se que mude em versões futuras.
@end quotation
@end cartouche

Pacotes contendo binários com threads livres são chamados python-freethreaded@footnote{https://www.nuget.org/packages/python-freethreaded} para a versão de 64 bits, pythonx86-freethreaded@footnote{https://www.nuget.org/packages/pythonx86-freethreaded} para a versão de 32 bits e pythonarm64-freethreaded@footnote{https://www.nuget.org/packages/pythonarm64-freethreaded} para a versão ARM64. Esses dois pacotes contêm os pontos de entrada @code{python3.13t.exe} e @code{python.exe}, os quais são executados com threads livres.

@node O pacote embutível,Pacotes Alternativos,Os pacotes nuget org,Utilizando Python no Windows
@anchor{using/windows the-embeddable-package}@anchor{1fa0}@anchor{using/windows windows-embeddable}@anchor{1f92}
@subsection O pacote embutível



Adicionado na versão 3.5.


A distribuição embutida é um arquivo ZIP contendo um ambiente Python mínimo. Ela foi criada para atuar como parte de outra aplicação, ao invés de ser diretamente acessada por usuários finais.

Quando extraída, a distribuição embutida é (quase) completamente isolada do sistema do usuário, incluindo variáveis de ambiente, configurações de registro de sistema, e pacotes instalados. A biblioteca padrão está inclusa como arquivos @code{.pyc} pré-compilados e otimizados em um ZIP, e @code{python3.dll}, @code{python37.dll}, @code{python.exe} e @code{pythonw.exe} estão todos disponíveis. Tcl/tk (incluindo todas as dependências, como a Idle), pip e a documentação do Python não estão inclusos.

@cartouche
@quotation Nota 
A distribuição embutida não inclui o Microsoft C Runtime@footnote{https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist#visual-studio-2015-2017-2019-and-2022} e é de responsabilidade do instalador da aplicação providenciar isso. O aplicativo de tempo de execução pode já ter sido instalado no sistema de um usuário previamente ou automaticamente via Windows Update, e pode ser detectado procurando por @code{ucrtbase.dll} no diretório do sistema.
@end quotation
@end cartouche

Pacotes de terceiros devem ser instalados pelo instalador da aplicação juntamente com a distribuição embutida. Usar o pip para gerenciar as dependências como em uma instalação regular do Python não é suportado nessa distribuição, apesar de que com algum cuidado pode ser possível incluir e usar o pip para atualizações automáticas. Em geral, pacotes de terceiros devem ser tratados como parte da aplicação (“vendoring”) para que o desenvolvedor consiga garantir compatibilidade com versões mais recentes antes de fornecer atualizações para os usuários.

Os dois casos de uso recomendados para essa distribuição são descritos abaixo.

@menu
* Aplicação Python:: 
* Incorporando Python:: 

@end menu

@node Aplicação Python,Incorporando Python,,O pacote embutível
@anchor{using/windows python-application}@anchor{1fa1}
@subsubsection Aplicação Python


Uma aplicação escrita em Python não requer necessariamente que os usuários estejam cientes deste fato. A distribuição embutida pode ser usada neste caso para incluir uma versão privada do pacote de instalação do Python. Dependendo de quão transparente deve ser (ou pelo contrário, quão profissional deve parecer), existem duas opções.

Usar um executável especializado como inicializador requer um pouco de código, mas fornece a experiência mais transparente para os usuários. Com um inicializador personalizado, não existem indicações óbvias que o programa está rodando em Python: ícones podem ser personalizados, informações da empresa e versão podem ser especificadas, e associações de arquivo se comportam de forma apropriada. Na maioria dos casos, um inicializador personalizado deve simplesmente ser capaz de chamar @code{Py_Main} com uma linha de comando predefinida (hard-coded).

A abordagem mais simples é fornecer um arquivo batch ou um atalho gerado que chama diretamente o @code{python.exe} ou @code{pythonw.exe} com os argumentos de linha de comando necessários. Neste caso, a aplicação irá aparecer como Python e não seu nome real, e os usuários podem ter problemas em distinguir ela de outros processos ou associações de arquivo em Python.

Com a abordagem anterior, pacotes devem ser instalados como diretórios juntamente do executável do Python para garantir que estarão disponíveis no caminho do ambiente. Com o instalador especializado, pacotes podem ser armazenados em outras localidades já que há uma oportunidade de especificar o caminho de busca antes de executar a aplicação.

@node Incorporando Python,,Aplicação Python,O pacote embutível
@anchor{using/windows embedding-python}@anchor{1fa2}
@subsubsection Incorporando Python


Aplicações escritas em código nativo frequentemente precisam de alguma forma de linguagem de script, e a distribuição embutida do Python pode ser usada para esse propósito. Em geral, a maior parte da aplicação é em código nativo, e uma parte irá ou invocar @code{python.exe} ou usar diretamente @code{python3.dll}. Para ambos os casos, extrair a distribuição embutida em um subdiretório da instalação da aplicação é suficiente para providenciar um interpretador Python carregável.

Para uso da aplicação, pacotes podem ser instalados em qualquer local já que há uma oportunidade de especificar caminhos de busca antes de inicializar o interpretador. De outra forma, não existem diferenças fundamentais entre usar a distribuição embutida ou a instalação regular.

@node Pacotes Alternativos,Configurando o Python<2>,O pacote embutível,Utilizando Python no Windows
@anchor{using/windows alternative-bundles}@anchor{1fa3}
@subsection Pacotes Alternativos


À parte da distribuição padrão CPython, existem pacotes modificados incluindo funcionalidades adicionais. A seguir está uma lista de versões populares e seus recursos chave:


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

Instalador com compatibilidade multi-plataforma, documentação, PyWin32

@item Anaconda@footnote{https://www.anaconda.com/download/}

Módulos científicos populares (como o numpy, scipy e pandas) e o gerenciador de pacotes @code{conda}.

@item Enthought Deployment Manager@footnote{https://assets.enthought.com/downloads/edm/}

“A próxima geração de ambiente Python e gerenciador de pacotes”.

Anteriormente, a Enthought fornecia Canopy, mas este chegou ao fim de vida em 2016@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/}

Distribuição específica do Windows com pacotes científicos pré-construídos e ferramentas para construir pacotes.
@end table

Note que esses pacotes podem não incluir as últimas versões do Python ou outras bibliotecas, e não são mantidos ou suportados pelo time do núcleo do Python.

@node Configurando o Python<2>,Modo UTF-8,Pacotes Alternativos,Utilizando Python no Windows
@anchor{using/windows configuring-python}@anchor{1fa4}
@subsection Configurando o Python


Para executar o Python convenientemente de um prompt de comando, você pode considerar mudar algumas variáveis de ambiente padrão do Windows. Ainda que o instalador forneça uma opção para configurar as variáveis PATH e PATHEXT para você, isso só é confiável para uma instalação única e global no sistema. Se você usa regularmente múltiplas versões do Python, considere usar o @ref{5be,,Inicializador Python para Windows}.

@menu
* Excursus; Configurando variáveis de ambiente: Excursus Configurando variáveis de ambiente. 
* Encontrando o executável do Python:: 

@end menu

@node Excursus Configurando variáveis de ambiente,Encontrando o executável do Python,,Configurando o Python<2>
@anchor{using/windows excursus-setting-environment-variables}@anchor{1fa5}@anchor{using/windows setting-envvars}@anchor{1d63}
@subsubsection Excursus: Configurando variáveis de ambiente


O Windows permite que variáveis de ambiente sejam configuradas de forma permanente em ambos os níveis de Usuário e de Sistema, ou temporariamente em um prompt de comando.

Para definir as variáveis de ambiente temporariamente, abra um Prompt de Comando e use o 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

Essas mudanças serão aplicadas em quaisquer comandos posteriores que forem executados neste console, e serão herdadas por quaisquer aplicações iniciadas pelo console.

Incluir o nome da variável com sinais de porcentagem irá expandir o valor existente, permitindo que você adicione seu novo valor ao início ou final. Modificar o 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} adicionando o diretório contendo @code{python.exe} ao início é o modo mais comum de garantir que a versão correta do Python seja iniciada.

Para modificar permanentemente as variáveis de ambiente padrão, clique em Iniciar e procure por ‘Editar as variáveis de ambiente do sistema`, ou abra as propriedades do Sistema, Configurações avançadas do sistema e clique no botão Variáveis de Ambiente. Neste diálogo, você pode adicionar ou modificar as variáveis de Usuário ou Sistema. Para mudar as variáveis do Sistema, você precisa de acesso não-restrito à sua máquina (isto é, direitos de Administrador).

@cartouche
@quotation Nota 
O Windows irá concatenar as variáveis de Usuário `após' as variáveis de Sistema, o que pode causar resultados inesperados quando modificando o 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.

A variável 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} é usada por todas as versões do Python, portanto, você não deve configurá-la permanentemente, a menos que os caminhos listados incluam apenas código compatível com todas as versões instaladas do Python.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item @indicateurl{https://learn.microsoft.com/windows/win32/procthread/environment-variables}

Visão geral das variáveis de ambiente no Windows

@item @indicateurl{https://learn.microsoft.com/windows-server/administration/windows-commands/set_1}

O comando @code{set}, para modificar temporariamente as variáveis de ambiente

@item @indicateurl{https://learn.microsoft.com/windows-server/administration/windows-commands/setx}

O comando @code{setx}, para modificar permanentemente as variáveis de ambiente
@end table


@node Encontrando o executável do Python,,Excursus Configurando variáveis de ambiente,Configurando o Python<2>
@anchor{using/windows finding-the-python-executable}@anchor{1fa6}@anchor{using/windows windows-path-mod}@anchor{1089}
@subsubsection Encontrando o executável do Python



Alterado na versão 3.5.


Além de usar o registro do menu Iniciar criado automaticamente para o interpretador do Python, você pode querer iniciar o Python no prompt de comando. O instalador possui uma opção para configurar isso pra você.

Na primeira página do instalador, uma opção chamada “Add Python to PATH” pode ser selecionada para que o instalador adicione o local de instalação na sua variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. O local da pasta de @code{Scripts\} também é adicionado. Isso permite que você digite @code{python} para executar o interpretador, e @code{pip} para o instalador de pacotes. Além disso, você pode também executar seus scripts com as opções de linha de comando, veja a documentação @ref{103d,,Linha de comando}.

Se você não habilitar essa opção no momento de instalação, você sempre pode re-executar o instalador, selecionar Modify, e habilitá-la. Alternativamente, você pode modificar manualmente a variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} usando os direcionamentos em @ref{1d63,,Excursus; Configurando variáveis de ambiente}. Você precisa definir sua variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para incluir o diretório da sua instalação Python, delimitado por um ponto e vírgula de outras entradas. Uma variável exemplo pode parecer com isso (presumindo que as duas primeiras entradas já existem):

@example
C:\WINDOWS\system32;C:\WINDOWS;C:\Program Files\Python 3.9
@end example

@node Modo UTF-8,Inicializador Python para Windows,Configurando o Python<2>,Utilizando Python no Windows
@anchor{using/windows utf-8-mode}@anchor{1fa7}@anchor{using/windows win-utf8-mode}@anchor{1fa8}
@subsection Modo UTF-8



Adicionado na versão 3.7.


O Windows ainda usa codificações legadas para a codificação do sistema (a Página de Código ANSI). O Python usa-o para a codificação padrão de arquivos de texto (por exemplo, @ref{2dc,,locale.getencoding()}).

Isso pode causar problemas, porque o UTF-8 é amplamente usado na Internet e na maioria dos sistemas Unix, incluindo o WSL (Subsistema Windows para Linux).

Você pode usar o @ref{656,,Modo UTF-8 do Python} para alterar a codificação de texto padrão para UTF-8. Você pode habilitar @ref{656,,Modo UTF-8 do Python} através da opção de linha de comando @code{-X utf8} ou da variável de ambiente @code{PYTHONUTF8=1}. Veja 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8} para habilitar o modo UTF-8, e @ref{1d63,,Excursus; Configurando variáveis de ambiente} para saber como modificar variáveis de ambiente.

Quando o @ref{656,,Modo UTF-8 do Python} está habilitado, você ainda pode usar a codificação do sistema (a página de código ANSI) através do codec “mbcs”.

Observe que adicionar @code{PYTHONUTF8=1} às variáveis de ambiente padrão afetará todas as aplicações Python 3.7+ em seu sistema. Se você tiver aplicações Python 3.7+ que dependem da codificação do sistema legado, é recomendável definir a variável de ambiente temporariamente ou usar a opção de linha de comando @code{-X utf8}.

@cartouche
@quotation Nota 
Mesmo quando o modo UTF-8 está desativado, o Python usa o UTF-8 por padrão no Windows para:


@itemize *

@item 
E/S do console, incluindo E/S padrão (consulte 
@geindex Propostas de Melhorias do Python; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} para detalhes).

@item 
A @ref{53b,,codificação do sistema de arquivos} (veja a 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para detalhes).
@end itemize
@end quotation
@end cartouche

@node Inicializador Python para Windows,Encontrando módulos,Modo UTF-8,Utilizando Python no Windows
@anchor{using/windows launcher}@anchor{5be}@anchor{using/windows python-launcher-for-windows}@anchor{1fa9}
@subsection Inicializador Python para Windows



Adicionado na versão 3.3.


O inicializador Python para Windows é um utilitário que auxilia na localização e execução de diferentes versões do Python. Ele permite que scripts (ou a linha de comando) indiquem uma preferência por uma versão do Python específica, e irá localizar e executar essa versão.

Ao contrário da variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}, o inicializador irá corretamente selecionar a versão mais apropriada do Python. Ele irá preferir instalações por usuário ao invés de instalações globais no sistema, e ordenará por versão da linguagem ao invés de usar a versão instalada mais recentemente.

O inicializador foi originalmente especificado na 
@geindex Propostas de Melhorias do Python; PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/}.

@menu
* Começando:: 
* Linhas Shebang:: 
* Argumentos em linhas shebang:: 
* Personalização:: 
* Diagnósticos:: 
* Teste de simulação:: 
* Instalar sob demanda:: 
* Códigos de retorno:: 

@end menu

@node Começando,Linhas Shebang,,Inicializador Python para Windows
@anchor{using/windows getting-started}@anchor{1faa}
@subsubsection Começando


@menu
* Pela linha de comando:: 
* Ambientes virtuais:: 
* Por um script:: 
* Por associação de arquivos:: 

@end menu

@node Pela linha de comando,Ambientes virtuais,,Começando
@anchor{using/windows from-the-command-line}@anchor{1fab}
@subsubsection Pela linha de comando



Alterado na versão 3.6.


Instalações globais no sistema do Python 3.3 ou posterior irão colocar o inicializador no seu 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. O inicializador é compatível com todas as versões disponíveis do Python, então não importa qual versão está instalada. Para verificar se o inicializador está disponível, execute o seguinte comando no Prompt de Comando:

@example
py
@end example

Você deve perceber que a última versão do Python que você tem é iniciada - ela pode ser fechada normalmente, e qualquer argumento da linha de comando adicional especificado será enviado diretamente para o Python.

Se você tem múltiplas versões do Python instaladas (por exemplo, 3.7 e 3.13) você deve ter notado que o Python 3.13 foi iniciado – para iniciar o Python 3.7, use o comando:

@example
py -3.7
@end example

Se você quer a versão mais recente do Python 2 que você tem instalada, tente o comando:

@example
py -2
@end example

Se você ver o seguinte erro, você não tem o inicializador instalado:

@example
'py' is not recognized as an internal or external command,
operable program or batch file.
@end example

O comando:

@example
py --list
@end example

exibe a(s) versão(ões) atualmente instalada(s) do Python.

O argumento @code{-x.y} é a forma abreviada do argumento @code{-V:Empresa/Tag}, que permite selecionar um ambiente de execução Python específico, incluindo aqueles que podem ter vindo de algum lugar diferente de python.org. Qualquer ambiente de execução registrado seguindo a 
@geindex Propostas de Melhorias do Python; PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} será detectável. O comando @code{--list} lista todos os ambientes de execução disponíveis usando o formato @code{-V:}.

Ao usar o argumento @code{-V:}, especificar a Empresa limitará a seleção aos ambientes de execução desse provedor, enquanto especificar apenas a Tag selecionará de todos os provedores. Observe que omitir a barra implica uma tag:

@example
# Seleciona qualquer ambiente de execução sinalizado como '3.*'
py -V:3

# Seleciona qualquer ambiente de execução lançado como 'PythonCore'
py -V:PythonCore/

# Seleciona o ambiente de execução Python 3 mais recente de PythonCore
py -V:PythonCore/3
@end example

A forma abreviada do argumento (@code{-3}) só seleciona a partir de versões principais do Python, e não de outras distribuições. No entanto, a forma mais longa (@code{-V:3}) selecionará qualquer um.

A Empresa é correspondida na string completa, sem distinção entre maiúsculas e minúsculas. A Tag corresponde a uma string completa ou a um prefixo, desde que o próximo caractere seja um ponto ou um hífen. Isso permite que @code{-V:3.1} corresponda a @code{3.1-32}, mas não a @code{3.10}. As tags são classificadas usando ordenação numérica (@code{3.10} é mais recente que @code{3.1}), mas são comparadas usando texto (@code{-V:3.01} não corresponde a @code{3.1}).

@node Ambientes virtuais,Por um script,Pela linha de comando,Começando
@anchor{using/windows virtual-environments}@anchor{1fac}
@subsubsection Ambientes virtuais



Adicionado na versão 3.5.


Se o inicializador é executado sem versão explícita do Python especificada, e um ambiente virtual (criado com o módulo da biblioteca padrão @ref{111,,venv} ou da ferramenta externa @code{virtualenv}) está ativo, o inicializador irá executar o interpretador do ambiente virtual ao invés do global. Para executar o interpretador global, ou desative o ambiente virtual, ou explicitamente especifique a versão global do Python.

@node Por um script,Por associação de arquivos,Ambientes virtuais,Começando
@anchor{using/windows from-a-script}@anchor{1fad}
@subsubsection Por um script


Vamos criar um script teste de Python - crie um arquivo chamado @code{hello.py} com os seguintes conteúdos:

@example
#! python
import sys
sys.stdout.write("olá do Python %s\n" % (sys.version,))
@end example

A partir do diretório onde hello.py está, execute o comando:

@example
py hello.py
@end example

Você deve notar que o número da versão da sua instalação mais recente do Python 2.x é exibido. Agora tente mudar a primeira linha para ser:

@example
#! python3
@end example

Re-executar o comando agora deve exibir informações da última versão do Python 3.x. Como nos exemplos da linha de comando acima, você pode especificar um qualificador de versão mais explícito. Presumindo que você tem o Python 3.7 instalado, tente mudar a primeira linha para @code{#! python3.7} e você deve ver as informações da versão 3.7 sendo exibidas.

Note que diferentemente do uso interativo, um simples “python” irá usar a última versão do Python 2.x que você tem instalada. Isso é para retrocompatibilidade e para compatibilidade com Unix, onde o comando @code{python} tipicamente se refere ao Python 2.

@node Por associação de arquivos,,Por um script,Começando
@anchor{using/windows from-file-associations}@anchor{1fae}
@subsubsection Por associação de arquivos


O inicializador deve ter sido associado com arquivos Python (isto é, arquivos @code{.py}, @code{.pyw}, @code{.pyc}) quando foi instalado. Isso significa que quando você clica duas vezes em um desses arquivos a partir do Explorador de Arquivos do Windows o inicializador será usado, e assim você pode usar as mesmas facilidades descritas acima para que o script especifique qual versão deve ser usada.

O benefício chave disso é que um único inicializador pode suportar múltiplas versões do Python ao mesmo tempo dependendo dos conteúdos da primeira linha.

@node Linhas Shebang,Argumentos em linhas shebang,Começando,Inicializador Python para Windows
@anchor{using/windows shebang-lines}@anchor{1faf}
@subsubsection Linhas Shebang


Se a primeira linha de um arquivo de script começa com @code{#!}, ela é conhecida como linha “shebang”. Linux e outros tipos de sistemas operacionais Unix têm suporte nativo para essas linhas e elas são comumente usadas nesses sistemas para indicar como um script deve ser executado. Esse inicializador permite que as mesmas facilidades sejam usadas com scripts Python no Windows e os exemplos acima demonstram seu uso.

Para permitir que linhas shebang em scripts Python sejam portáveis entre Unix e Windows, este inicializador suporta um número de comandos ‘virtuais’ para especificar qual interpretador deve ser usado. Os comandos virtuais suportados são:


@itemize *

@item 
@code{/usr/bin/env}

@item 
@code{/usr/bin/python}

@item 
@code{/usr/local/bin/python}

@item 
@code{python}
@end itemize

Por exemplo, se a primeira linha do seu script começa com

@example
#! /usr/bin/python
@end example

O Python padrão ou um ambiente virtual ativo será localizado e utilizado. Como muitos scripts Python escritos para funcionar no Unix já terão essa linha, você deve perceber que esses scripts podem ser usados pelo inicializador sem modificação. Se você está escrevendo um novo script no Windows que você espera que seja útil no Unix, você deve usar uma dessas linhas shebang começando com @code{/usr}.

Qualquer um dos comandos virtuais acima pode ser sufixado com uma versão explícita (ou apenas a maior versão, ou a maior e a menor versão). Além disso, a versão de 32 bits pode ser solicitada adicionando “-32” após a menor versão. Isto é, @code{/usr/bin/python3.7-32} irá solicitar o uso do python 3.7 32-bit. Se um ambiente virtual estiver ativo, a versão será ignorada e o ambiente será usado.


Adicionado na versão 3.7: A partir do inicializador do python 3.7 é possível solicitar a versão 64-bit adicionando o sufixo “-64”. Além disso é possível especificar uma versão maior e arquitetura sem a menor (isto é, @code{/usr/bin/python3-64}).



Alterado na versão 3.11: O sufixo “-64” foi descontinuado e agora implica “qualquer arquitetura que não seja comprovadamente i386/32 bits”. Para solicitar um ambiente específico, use o novo argumento @code{-V:@var{TAG}} com a tag completa.



Alterado na versão 3.13: Comandos virtuais que referenciam @code{python} agora preferem um ambiente virtual ativo em vez de pesquisar 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. Isso lida com casos em que o shebang especifica @code{/usr/bin/env python3}, mas @code{python3.exe} não está presente no ambiente ativo.


A forma @code{/usr/bin/env} da linha shebang tem mais uma propriedade especial. Antes de procurar por interpretadores Python instalados, este formulário pesquisará o executável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} por um executável Python correspondente ao nome fornecido como o primeiro argumento. Isso corresponde ao comportamento do programa Unix @code{env}, que executa uma pesquisa 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. Se um executável correspondente ao primeiro argumento após o comando @code{env} não puder ser encontrado, mas o argumento começar com @code{python}, ele será tratado conforme descrito para os outros comandos virtuais. A variável de ambiente @code{PYLAUNCHER_NO_SEARCH_PATH} pode ser definida (para qualquer valor) para ignorar esta pesquisa de 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.

As linhas Shebang que não correspondem a nenhum desses padrões são procuradas na seção @code{[commands]} do arquivo @ref{1fb0,,.INI} do lançador. Isso pode ser usado para lidar com certos comandos de uma maneira que faça sentido para o seu sistema. O nome do comando deve ser um único argumento (sem espaços no executável shebang) e o valor substituído é o caminho completo para o executável (argumentos adicionais especificados no .INI serão citados como parte do nome do arquivo).

@example
[commands]
/bin/xpython=C:\Program Files\XPython\python.exe
@end example

Quaisquer comandos não encontrados no arquivo .INI são tratados como caminhos executáveis do `Windows' que são absolutos ou relativos ao diretório que contém o arquivo de script. Isso é uma conveniência para scripts somente do Windows, como aqueles gerados por um instalador, pois o comportamento não é compatível com shells de estilo Unix. Esses caminhos podem ser citados e podem incluir vários argumentos, após os quais o caminho para o script e quaisquer argumentos adicionais serão anexados.

@node Argumentos em linhas shebang,Personalização,Linhas Shebang,Inicializador Python para Windows
@anchor{using/windows arguments-in-shebang-lines}@anchor{1fb1}
@subsubsection Argumentos em linhas shebang


As linhas shebang também podem especificar opções adicionais a serem passadas ao interpretador Python. Por exemplo, se você tem uma linha shebang:

@example
#! /usr/bin/python -v
@end example

O Python será iniciado com a opção @code{-v}

@node Personalização,Diagnósticos,Argumentos em linhas shebang,Inicializador Python para Windows
@anchor{using/windows customization}@anchor{1fb2}
@subsubsection Personalização


@menu
* Personalização via arquivos INI:: 
* Personalizando versões padrão do Python:: 

@end menu

@node Personalização via arquivos INI,Personalizando versões padrão do Python,,Personalização
@anchor{using/windows customization-via-ini-files}@anchor{1fb3}@anchor{using/windows launcher-ini}@anchor{1fb0}
@subsubsection Personalização via arquivos INI


Dois arquivos .ini serão pesquisados pelo inicializador - @code{py.ini} no diretório de dados de aplicações do usuário atual (@code{%LOCALAPPDATA%} ou @code{$env:LocalAppData}) e @code{py.ini} no mesmo diretório que o inicializador. Os mesmos arquivos .ini são usados para ambas a versão ‘console’ do inicializador (isto é, py.exe) e a versão ‘windows’ (isto é, pyw.exe).

Personalização especificada no “diretório da aplicação” terão precedência sobre àquela especificada junto do executável, portanto um usuário, que pode não ter acesso de escrita ao arquivo .ini junto do inicializador, pode sobrescrever comandos naquele arquivo .ini global.

@node Personalizando versões padrão do Python,,Personalização via arquivos INI,Personalização
@anchor{using/windows customizing-default-python-versions}@anchor{1fb4}
@subsubsection Personalizando versões padrão do Python


Em alguns casos, um qualificador de versão pode ser incluído em um comando para ditar qual versão do Python deve ser usada pelo comando. Um qualificador de versão começa com um número maior de versão e pode opcionalmente ser seguido por um ponto (‘.’) e uma especificação de versão menor. Além disso, é possível especificar se uma implementação de 32 ou 64 bit deve ser solicitada adicionando “-32” ou “-64”.

Por exemplo, uma linha shebang @code{#!python} não tem qualificador de versão, enquanto @code{#!python3} tem um qualificador de versão que especifica apenas uma versão maior.

Se nenhum qualificador de versão é encontrado em um comando, a variável de ambiente @code{PY_PYTHON} pode ser definida para especificar o qualificador de versão padrão. Se ela não está definida, o padrão é “3”. A variável pode especificar qualquer valor que pode ser passado para a linha de comando, como “3”, “3.7”, “3.7-32” ou “3.7-64”. (Note que a opção “-64” está disponível apenas com o inicializador incluso no Python 3.7 ou mais recente.)

Se nenhum qualificador de versão menor é encontrado, a variável de ambiente @code{PY_PYTHON@{major@}} (onde @code{@{major@}} é o qualificador da versão maior atual, como determinado acima) pode ser definida para especificar a versão completa. Se nenhuma opção é encontrada, o inicializador irá enumerar as versões do Python instaladas e usar a última versão menor encontrada como versão maior, o que é provavelmente, ainda que não garantido, a versão instalada mais recentemente naquela família.

Em um Windows 64-bit com ambas as implementações de 32-bit e 64-bit da mesma (maior.menor) versão do Python instaladas, a versão 64-bit sempre será preferida. Isso será verdadeiro para ambas as implementações de 32-bit e 64-bit do inicializador - um inicializador 32-bit irá preferir executar uma instalação 64-bit do Python da versão especificada, se disponível. Isso é para que o comportamento do inicializador possa ser previsto sabendo apenas quais versões estão instaladas no PC e sem considerar a ordem com que elas foram instaladas (isto é, sem saber se a última a ser instalada foi a versão 32 ou 64-bit do Python e do instalador correspondente). Como observado acima, um sufixo opcional “-32” ou “-64” pode ser usado como especificador de versão para mudar esse comportamento.

Exemplos:


@itemize *

@item 
Se nenhuma opção relevante for definida, os comandos @code{python} e @code{python2} irão usar a última versão instalada do Python 2.x e o comando @code{python3} irá usar o último Python 3.x instalado.

@item 
O comando @code{python3.7} não vai consultar nenhuma opção já que as versões estão completamente especificadas.

@item 
Se @code{PY_PYTHON=3}, os comandos @code{python} e @code{python3} irão ambos usar a última versão do Python 3 instalada.

@item 
Se @code{PY_PYTHON=3.7-32}, o comando @code{python} irá usar a implementação 32 bits do 3.7 enquanto o comando @code{python3} irá usar o último Python instalado (PY_PYTHON não foi considerado porque uma versão maior foi especificada).

@item 
Se @code{PY_PYTHON=3} e @code{PY_PYTHON3=3.7}, os comandos @code{python} e @code{python3} irão ambos usar especificamente 3.7
@end itemize

Em adição às variáveis de ambiente, as mesmas configurações podem ser feitas no arquivo .INI usado pelo inicializador. A seção nos arquivos INI é chamada @code{[defaults]} e o nome da chave será o mesmo que as variáveis de ambiente sem o prefixo @code{PY_} (e observe que os nomes das chaves no arquivo INI não diferem maiúsculas e minúsculas). Os conteúdos de uma variável de ambiente irão sobrescrever coisas especificadas em um arquivo INI.

Por exemplo:


@itemize *

@item 
Configurar @code{PY_PYTHON=3.7} é o equivalente ao arquivo INI contendo:
@end itemize

@example
[defaults]
python=3.7
@end example


@itemize *

@item 
Configurar @code{PY_PYTHON=3} e @code{PY_PYTHON3=3.7} é o equivalente ao arquivo INI contendo:
@end itemize

@example
[defaults]
python=3
python3=3.7
@end example

@node Diagnósticos,Teste de simulação,Personalização,Inicializador Python para Windows
@anchor{using/windows diagnostics}@anchor{1fb5}
@subsubsection Diagnósticos


Se uma variável de ambiente @code{PYLAUNCHER_DEBUG} é configurada (para qualquer valor), o inicializador irá exibir a informação de diagnóstico do stderr (isto é, no console). Enquanto essa informação consegue ser simultaneamente verbosa `e' concisa, ela deve permitir que você veja quais versões do Python foram localizadas, porquê uma versão particular foi escolhida e qual linha de comando exatamente foi usada para executar o Python alvo. Destina-se principalmente para testes e depuração.

@node Teste de simulação,Instalar sob demanda,Diagnósticos,Inicializador Python para Windows
@anchor{using/windows dry-run}@anchor{1fb6}
@subsubsection Teste de simulação


Se uma variável de ambiente @code{PYLAUNCHER_DRYRUN} for definida (para qualquer valor), o inicializador emitirá o comando que ele teria executado, mas não iniciará o Python de fato. Isso pode ser útil para ferramentas que desejam usar o inicializador para detectar e então iniciar o Python diretamente. Observe que o comando escrito na saída padrão é sempre codificado usando UTF-8 e pode não ser renderizado corretamente no console.

@node Instalar sob demanda,Códigos de retorno,Teste de simulação,Inicializador Python para Windows
@anchor{using/windows install-on-demand}@anchor{1fb7}
@subsubsection Instalar sob demanda


Se uma variável de ambiente @code{PYLAUNCHER_ALLOW_INSTALL} for definida (para qualquer valor), e a versão do Python solicitada não estiver instalada, mas estiver disponível na Microsoft Store, o inicializador tentará instalá-la. Isso pode exigir interação do usuário para ser concluído, e você pode precisar executar o comando novamente.

Uma variável adicional @code{PYLAUNCHER_ALWAYS_INSTALL} faz com que o inicializador sempre tente instalar o Python, mesmo se for detectado. Isso é destinado principalmente para teste (e deve ser usado com @code{PYLAUNCHER_DRYRUN}).

@node Códigos de retorno,,Instalar sob demanda,Inicializador Python para Windows
@anchor{using/windows return-codes}@anchor{1fb8}
@subsubsection Códigos de retorno


Os seguintes códigos de saída podem ser retornados pelo inicializador do Python. Infelizmente, não há como distingui-los do código de saída do próprio Python.

Os nomes dos códigos são como usados nas fontes e são apenas para referência. Não há como acessá-los ou resolvê-los além de ler esta página. As entradas são listadas em ordem alfabética de nomes.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Valor

@tab

Descrição

@item

RC_BAD_VENV_CFG

@tab

107

@tab

Um @code{pyvenv.cfg} foi encontrado, mas está corrompido.

@item

RC_CREATE_PROCESS

@tab

101

@tab

Falha ao iniciar o Python.

@item

RC_INSTALLING

@tab

111

@tab

Uma instalação foi iniciada, mas o comando precisará ser executado novamente após sua conclusão.

@item

RC_INTERNAL_ERROR

@tab

109

@tab

Erro inesperado. Por favor, relate um bug.

@item

RC_NO_COMMANDLINE

@tab

108

@tab

Não é possível obter a linha de comando do sistema operacional.

@item

RC_NO_PYTHON

@tab

103

@tab

Não foi possível localizar a versão solicitada.

@item

RC_NO_VENV_CFG

@tab

106

@tab

Um @code{pyvenv.cfg} era necessário, mas não foi encontrado.

@end multitable


@node Encontrando módulos,Módulos adicionais,Inicializador Python para Windows,Utilizando Python no Windows
@anchor{using/windows finding-modules}@anchor{1fb9}@anchor{using/windows windows-finding-modules}@anchor{c3b}
@subsection Encontrando módulos


Estas notas complementam a descrição em @ref{1de6,,A inicialização do caminho de pesquisa de módulos sys.path} com notas detalhadas do Windows.

Quando nenhum arquivo @code{._pth} é encontrado, assim é como @ref{3b4,,sys.path} é populado no Windows:


@itemize *

@item 
Uma entrada em branco é adicionada ao início, que corresponde ao diretório atual.

@item 
Se a variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} existe, como descrito em @ref{5f1,,Variáveis de ambiente}, suas entradas são adicionadas em seguida. Note que no Windows, caminhos nessa variável devem ser separados por ponto e vírgula, para distinguir eles dos dois pontos usados nos identificadores de drivers (@code{C:\} etc.).

@item 
“Caminhos da aplicação” adicionais podem ser adicionados ao registro como subchaves de @code{\SOFTWARE\Python\PythonCore@{version@}\PythonPath} sob ambas @code{HKEY_CURRENT_USER} e @code{HKEY_LOCAL_MACHINE}. Subchaves que possuem string de caminhos delimitados por ponto e vírgula como seu valor padrão farão com que cada caminho seja adicionado ao @ref{3b4,,sys.path}. (Note que todos os instaladores conhecidos usam apenas HKLM, portanto HKCU está tipicamente vazio.)

@item 
Se a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} está definida, ela é presumida como “Python Home”. Caso contrário, o caminho do principal executável do Python é usado para localizar um “arquivo de referência” (ou @code{Lib\os.py} ou @code{pythonXY.zip}) para deduzir o “Python Home”. Se um Python Home é encontrado, os subdiretórios relevantes adicionados ao @ref{3b4,,sys.path} (@code{Lib}, @code{plat-win}, etc) são baseados naquela pasta. Se não, o caminho núcleo do Python é construído a partir do PythonPath armazenado no registro.

@item 
Se o Python Home não puder ser localizado, nenhum 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} está especificado no ambiente, e nenhuma entrada de registro pôde ser encontrada, um caminho padrão com entradas relativas é usado (por exemplo, @code{.\Lib;.\plat-win}, etc).
@end itemize

Se um arquivo @code{pyvenv.cfg} for encontrado juntamente com o principal executável ou no diretório um nível acima do executável, as seguintes variações se aplicam:


@itemize *

@item 
Se @code{home} é um caminho absoluto e 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} não está definido, o caminho é usado ao invés do caminho ao principal executável quando deduzindo a localização do Home.
@end itemize

O resultado final de tudo isso é:


@itemize *

@item 
Quando executando @code{python.exe}, ou qualquer outro .exe no diretório principal do Python (ou uma versão instalada, ou diretamente do diretório PCbuild), o caminho núcleo é deduzido, e os caminhos núcleo no registro são ignorados. Outros “caminhos da aplicação” no registro são sempre lidos.

@item 
Quando Python é hospedado em outro .exe (diretório diferente, embutido via COM, etc), o “Python Home” não será deduzido, então o caminho núcleo do registro é usado. Outros “caminhos da aplicação” no registro sempre são lidos.

@item 
Se o Python não puder encontrar seu Home e não existem valores no registro (.exe imutáveis, algumas configurações de instalação bem estranhas) você recebe um caminho com alguns caminhos padrão, porém relativos.
@end itemize

Para aqueles que querem empacotar o Python em suas aplicações ou distribuições, o seguinte conselho irá prevenir conflitos com outras instalações:


@itemize *

@item 
Inclua um arquivo @code{._pth} juntamente do executável contendo os diretórios a serem incluídos. Isso irá ignorar caminhos listados no registro e variáveis de ambiente, e também ignorar @code{sites} a não ser que @code{import site} seja listado.

@item 
Se você estiver carregando @code{python3.dll} ou @code{python37.dll} em seu próprio executável, defina explicitamente @ref{3a2,,PyConfig.module_search_paths} antes de @ref{3c5,,Py_InitializeFromConfig()}.

@item 
Limpe e/ou sobrescreva 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} e defina 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} antes de iniciar o @code{python.exe} a partir da sua aplicação.

@item 
Se você não puder usar as sugestões anteriores (por exemplo, você é uma distribuição que permite que as pessoas executem o arquivo @code{python.exe} diretamente), certifique-se de que o arquivo de referência (@code{Lib\os.py}) existe no seu diretório de instalação. (Note que ele não será detectado dentro de um arquivo ZIP, mas um arquivo ZIP corretamente nomeado será detectado ao invés disso.)
@end itemize

Isso irá garantir que seus arquivos em uma instalação global no sistema não terão precedência sobre uma cópia da biblioteca padrão empacotada com a sua aplicação. Caso contrário, seus usuários podem experienciar problemas usando sua aplicação. Note que a primeira sugestão é a melhor, pois as outras podem ainda estar suscetíveis a caminhos não-padrão no registro e no site-packages do usuário.


Alterado na versão 3.6: Adiciona suporte a arquivos @code{._pth} e remove a opção @code{applocal} do @code{pyvenv.cfg}.



Alterado na versão 3.6: Adiciona @code{python`XX'.zip} como uma possível referência quando diretamente adjacente ao executável.



Descontinuado desde a versão 3.6: Módulos especificados no registro sob @code{Modules} (não @code{PythonPath}) podem ser importados por @ref{d4c,,importlib.machinery.WindowsRegistryFinder}. Este localizador está ativo no Windows no 3.6.0 e anteriores, mas pode precisar ser explicitamente adicionado ao @ref{d4d,,sys.meta_path} no futuro.


@node Módulos adicionais,Compilando Python no Windows,Encontrando módulos,Utilizando Python no Windows
@anchor{using/windows additional-modules}@anchor{1fba}
@subsection Módulos adicionais


Mesmo que o Python tenha como objetivo ser portável através de todas as plataformas, existem recursos que são únicos para o Windows. Alguns módulos, em ambas as bibliotecas padrão e externa, e trechos de código existem para usar esses recursos.

Os módulos padrão específicos para Windows estão documentados em @ref{1fbb,,Serviços Específicos do MS Windows}.

@menu
* PyWin32:: 
* cx_Freeze:: 

@end menu

@node PyWin32,cx_Freeze,,Módulos adicionais
@anchor{using/windows pywin32}@anchor{1fbc}
@subsubsection PyWin32


O módulo PyWin32@footnote{https://pypi.org/project/PyWin32/} de Mark Hammond é uma coleção de módulos para suporte avançado específico para Windows. Isso inclui utilitários para:


@itemize *

@item 
Component Object Model@footnote{https://learn.microsoft.com/windows/win32/com/component-object-model--com--portal}
(COM)

@item 
Chamadas à API Win32

@item 
Registro

@item 
Log de Eventos

@item 
Interfaces de usuário Microsoft Foundation Classes@footnote{https://learn.microsoft.com/cpp/mfc/mfc-desktop-applications} (MFC)
@end itemize

PythonWin@footnote{https://web.archive.org/web/20060524042422/https://www.python.org/windows/pythonwin/} é uma aplicação MFC de exemplo enviada com o PyWin32. É uma IDE embutível com um depurador embutido.


@subsubheading Ver também



@table @asis

@item Win32 How Do I...?@footnote{https://timgolden.me.uk/python/win32_how_do_i.html}

por Tim Golden

@item Python e COM@footnote{https://www.boddie.org.uk/python/COM.html}

by David and Paul Boddie
@end table


@node cx_Freeze,,PyWin32,Módulos adicionais
@anchor{using/windows cx-freeze}@anchor{1fbd}
@subsubsection cx_Freeze


cx_Freeze@footnote{https://cx-freeze.readthedocs.io/en/latest/} encapsula scripts Python em programas executáveis do Windows (arquivos @code{`*'.exe}). Quando você tiver feito isso, você pode distribuir sua aplicação sem solicitar que os seus usuários instalem o Python.

@node Compilando Python no Windows,Outras plataformas,Módulos adicionais,Utilizando Python no Windows
@anchor{using/windows compiling-python-on-windows}@anchor{1fbe}
@subsection Compilando Python no Windows


Se você quer compilar o CPython por conta própria, a primeira coisa que você precisa ter é a fonte@footnote{https://www.python.org/downloads/source/}. Você pode fazer o download tanto da fonte da última versão quanto pegar um novo checkout@footnote{https://devguide.python.org/setup/#get-the-source-code}.

A árvore de fontes contém uma solução de construção e arquivos de projeto para o Microsoft Visual Studio, que é o compilador usado para construir as versões do Python oficiais. Esses arquivos estão no diretório @code{PCbuild}.

Confira o @code{PCbuild/readme.txt} para informações gerais sobre o processo de construção.

Para módulos de extensão, consulte @ref{1fbf,,Construindo Extensões C e C++ no Windows}.

@node Outras plataformas,,Compilando Python no Windows,Utilizando Python no Windows
@anchor{using/windows other-platforms}@anchor{1fc0}
@subsection Outras plataformas


Com o desenvolvimento do Python em andamento, algumas plataformas que costumavam ser suportadas anteriormente não são mais suportadas (devido à falta de usuário ou desenvolvedores). Confira a 
@geindex Propostas de Melhorias do Python; PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} para detalhes de todas as plataformas não suportadas.


@itemize *

@item 
Windows CE@footnote{https://pythonce.sourceforge.net/} não é mais suportado@footnote{https://github.com/python/cpython/issues/71542} desde o Python 3 (se é que foi em algum momento).

@item 
O instalador do Cygwin@footnote{https://cygwin.com/} oferece instalar o interpretador do Python@footnote{https://cygwin.com/packages/summary/python3.html} também
@end itemize

Veja Python for Windows@footnote{https://www.python.org/downloads/windows/} para informação detalhada sobre as plataformas com instaladores pré-compilados.

@node Usando Python em macOS,Utilizando Python no Android,Utilizando Python no Windows,Configurações e Uso do Python
@anchor{using/mac doc}@anchor{1fc1}@anchor{using/mac translation-repo}@anchor{1fc2}@anchor{using/mac using-on-mac}@anchor{1fc3}@anchor{using/mac using-python-on-macos}@anchor{1fc4}
@section Usando Python em macOS


Este documento tem o objetivo de fornecer uma visão geral dos comportamentos específicos do macOS que você deve conhecer para começar a usar o Python em computadores Mac. O Python em um Mac com macOS é muito semelhante ao Python em outras plataformas derivadas do Unix, mas há algumas diferenças na instalação e alguns recursos.

Há várias maneiras de obter e instalar o Python para macOS. Versões pré-construídas das versões mais recentes do Python estão disponíveis em vários distribuidores. Grande parte deste documento descreve o uso dos Pythons fornecidos pela equipe de lançamento do CPython, disponíveis para download no site python.org@footnote{https://www.python.org/downloads/}. Consulte @ref{1fc5,,Distribuições alternativas} para conhecer outras opções.
@anchor{using/mac getting-osx}@anchor{1fc6}
@menu
* Usando Python para macOS do python.org: Usando Python para macOS do python org. 
* Distribuições alternativas:: 
* Instalando pacotes adicionais ao python:: 
* Programação de GUI:: 
* Tópicos Avançados:: 
* Outros recursos:: 

@end menu

@node Usando Python para macOS do python org,Distribuições alternativas,,Usando Python em macOS
@anchor{using/mac getting-and-installing-macpython}@anchor{173}@anchor{using/mac using-python-for-macos-from-python-org}@anchor{1fc7}
@subsection Usando Python para macOS do @code{python.org}


@menu
* Etapas de instalação: Etapas de instalação<2>. 
* Como executar um script Python:: 

@end menu

@node Etapas de instalação<2>,Como executar um script Python,,Usando Python para macOS do python org
@anchor{using/mac installation-steps}@anchor{1fc8}
@subsubsection Etapas de instalação


Para as versões atuais de Python@footnote{https://www.python.org/downloads/} (exceto as com status @code{security}), a equipe de lançamento produz um pacote de instalação `Python para macOS' em cada novo lançamento. Uma lista dos instaladores disponíveis está disponível aqui@footnote{https://www.python.org/downloads/macos/}. Recomendamos usar a versão suportada mais recente de Python sempre que possível. Os instaladores atuais fornecem uma versão de Python como binário universal 2@footnote{https://pt.wikipedia.org/wiki/Binário_universal} que é executado nativamente em todos os Macs (Apple Silicon e Intel) compatíveis com uma ampla gama de versões do macOS, atualmente do `macOS 10.13 High Sierra' em diante.

O arquivo baixado é um arquivo padrão do instalador de pacotes do macOS (@code{.pkg}). As informações de integridade do arquivo (soma de verificação, tamanho, assinatura de Sigstore, etc.) de cada arquivo estão inclusas na página de download dos lançamentos. Os pacotes de instalação e seus conteúdos são assinados e autenticados com certificados Apple Developer ID @code{Python Software Foundation} para atender aos requisitos do macOS Gatekeeper@footnote{https://support.apple.com/en-us/102445}.

Para uma instalação padrão, clique duas vezes no arquivo instalador de pacotes baixado. Isso deverá abrir o aplicativo padrão de instalação do macOS e exibir o primeiro de vários passos de instalação.

@image{python-figures/mac_installer_01_introduction,,,,png}

Ao clicar no botão `Continuar', é exibido o `Read Me' desse instalador. Além de outras informações importantes, o `Read Me' documenta qual versão de Python será instalada e em quais versões do macOS ele é compatível. Talvez você precise rolar a tela para ler o arquivo inteiro. Por padrão, esse `Read Me' também será instalado em @code{/Applications/Python 3.13/} e estará disponível para leitura a qualquer momento.

@image{python-figures/mac_installer_02_readme,,,,png}

Ao clicar em `Continuar', o instalador exibe a licença do Python e de outros softwares incluídos. Você precisará `Concordar' com os termos da licença antes de prosseguir para a próxima etapa. Esse arquivo de licença também será instalado e estará disponível para leitura a qualquer momento.

@image{python-figures/mac_installer_03_license,,,,png}

Após aceitar os termos da licença, a próxima etapa será a tela `Tipo de instalação'. Para a maioria dos usos, o conjunto padrão de operações de instalação é adequado.

@image{python-figures/mac_installer_04_installation_type,,,,png}

Ao pressionar o botão `Personalizar', você pode optar por omitir ou selecionar determinados componentes de pacote do instalador. Clique em cada nome de pacote para ver uma descrição do que ele instala. Para também instalar o suporte para o recurso experimental opcional de threads livres, consulte @ref{1fc9,,Instalando binários com threads livres}.

@image{python-figures/mac_installer_05_custom_install,,,,png}

Em ambos os casos, clicar em `Instalar' iniciará o processo de instalação solicitando a permissão para instalar um novo software. É necessário um nome de usuário do macOS com privilégio de @code{Administrador}, pois o Python instalado estará disponível para todos os usuários do Mac.

Quando a instalação for concluída, a janela `Resumo' será exibida.

@image{python-figures/mac_installer_06_summary,,,,png}

Clique duas vezes no ícone ou arquivo @code{Install Certificates.command} na janela @code{/Applications/Python 3.13/} para concluir a instalação.

@image{python-figures/mac_installer_07_applications,,,,png}

Isso abrirá uma janela temporária do console @code{Terminal} que usará o novo Python para baixar e instalar certificados raiz SSL para seu uso.

@image{python-figures/mac_installer_08_install_certificates,,,,png}

Se @code{Successfully installed certifi} e @code{update complete} aparecerem na janela do terminal, a instalação estará concluída. Feche essa janela do terminal e a janela do instalador.

Uma instalação do padrão incluirá:


@itemize *

@item 
Uma pasta @code{Python 3.13} em sua pasta @code{Applications}. Aqui você encontra o @code{IDLE}, o ambiente de desenvolvimento que é parte das distribuições oficiais do Python; e o @code{Python Launcher}, que executa scripts Python quando são clicados duas vezes dentro do Finder@footnote{https://support.apple.com/en-us/HT201732} .

@item 
Uma framework @code{/Library/Frameworks/Python.framework}, que inclui o executável Python e suas bibliotecas. O instalador adiciona esse local ao seu `path' do console. Para desinstalar o Python, você pode remover esses três itens. É um link simbólico para o executável Python armazenado na pasta @code{/usr/local/bin/}.
@end itemize

@cartouche
@quotation Nota 
As versões recentes do macOS incluem um comando @code{python3} em @code{/usr/bin/python3} que aponta para uma versão geralmente mais antiga e incompleta de Python fornecida por e para uso pelas ferramentas de desenvolvimento da Apple, @code{Xcode} ou o @code{Command Line Tools for Xcode}. Você nunca deve modificar ou tentar excluir essa instalação por ser controlada pela Apple e é usada por softwares da Apple ou de terceiros. Se você optar por instalar uma versão mais recente do Python a partir de @code{python.org}, você terá duas instalações diferentes, mas funcionais, de Python no computador que podem coexistir. As opções do instalador padrão devem garantir que o comando @code{python3} seja usado em vez do @code{python3} do sistema.
@end quotation
@end cartouche

@node Como executar um script Python,,Etapas de instalação<2>,Usando Python para macOS do python org
@anchor{using/mac how-to-run-a-python-script}@anchor{1fca}
@subsubsection Como executar um script Python


Há duas maneiras de invocar o interpretador Python. Se você estiver familiarizado com o uso de um console Unix em terminal, você pode invocar @code{python3.13} ou @code{python3}, opcionalmente seguido por uma ou mais opções da linha de comando (descritas em @ref{1b36,,Linha de comando e ambiente}). O tutorial de Python também tem uma seção útil sobre o @ref{16f,,uso interativo do Python a partir de um console}.

Você também pode invocar o interpretador por um ambiente de desenvolvimento integrado (IDE). O @ref{104b,,IDLE — editor e console Python} é um editor e ambiente de desenvolvimento básico incluído com a distribuição padrão de Python. @code{IDLE} inclui um menu Ajuda que te permite acessar a documentação de Python. Se você for completamente iniciante em Python, você pode ler o tutorial de introdução na documentação.

Há muitos outros editores e IDEs disponíveis. Consulte @ref{1fcb,,Editores e IDEs} para mais informações.

Para executar um script Python na janela do terminal, você pode invocar o interpretador com o nome do arquivo de script:

@quotation

@code{python3.13} @code{meuscript.py}
@end quotation

Para executar seu script a partir do Finder, você pode:


@itemize *

@item 
Arrastá-lo para o @code{Python Launcher}.

@item 
Selecione @code{Python Launcher} como a aplicação padrão para abrir seu script (ou qualquer script @code{.py}) na janela de informações Finder Info, e clique duas vezes nele. O @code{Python Launcher} tem várias preferências para controlar como o script é iniciado. Você pode arrastar opções para alterá-las por uma invocação, ou usar o menu @code{Preferências} para alterar configurações globalmente.
@end itemize

Saiba que executar o script diretamente do Finder pode produzir resultados diferentes daqueles obtidos em uma janela de terminal, pois o script não será executado no ambiente normal do console, incluindo qualquer configuração de variáveis de ambiente nos perfis do console. E, como em qualquer outro script ou programa, certifique-se do que está prestes a executar.

@node Distribuições alternativas,Instalando pacotes adicionais ao python,Usando Python para macOS do python org,Usando Python em macOS
@anchor{using/mac alternative-bundles}@anchor{1fc5}@anchor{using/mac alternative-distributions}@anchor{1fcc}
@subsection Distribuições alternativas


Além do instalador padrão do @code{python.org} para macOS, existem distribuições de terceiros para macOS que podem incluir funcionalidades adicionais. Algumas distribuições populares e seus recursos-chave são:


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

Instalador com compatibilidade multiplataforma, documentação

@item Anaconda@footnote{https://www.anaconda.com/download/}

Módulos científicos populares (como numpy, scipy e pandas) e o gerenciador de pacotes @code{conda}.

@item Homebrew@footnote{https://brew.sh}

Gerenciador de pacotes para macOS que inclui várias versões do Python e muitos pacotes Python de terceiros (incluindo numpy, scipy e pandas).

@item MacPorts@footnote{https://www.macports.org}

Outro gerenciador de pacotes para macOS, incluindo várias versões de Python e muitos pacotes Python de terceiros. Pode incluir versões pré-construídas do Python e muitos pacotes para versões mais antigas do macOS.
@end table

Note que distribuições podem não incluir versões mais recentes de Python ou de outras bibliotecas, e não são mantidas ou providas pela equipe do Python.

@node Instalando pacotes adicionais ao python,Programação de GUI,Distribuições alternativas,Usando Python em macOS
@anchor{using/mac installing-additional-python-packages}@anchor{1fcd}@anchor{using/mac mac-package-manager}@anchor{1fce}
@subsection Instalando pacotes adicionais ao python


Consulte o Guia de Usuário para Empacotamento de Python@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/} para mais informações.
@anchor{using/mac osx-gui-scripts}@anchor{1fcf}
@node Programação de GUI,Tópicos Avançados,Instalando pacotes adicionais ao python,Usando Python em macOS
@anchor{using/mac gui-programming}@anchor{1fd0}@anchor{using/mac gui-programming-on-the-mac}@anchor{1fd1}
@subsection Programação de GUI


Existem várias opções para criar aplicações GUI no Mac com Python.

O kit de ferramentas GUI padrão de Python é o módulo @ref{f0,,tkinter}, baseado no kit de ferramentas multiplataforma Tk (@indicateurl{https://www.tcl.tk}). Uma versão nativa do Tk para macOS está incluída no instalador.

`O PyObjC' é uma ligação em Python para o Objective-C/Cocoa da Apple framework. Informações sobre o PyObjC estão disponíveis em pyobjc@footnote{https://pypi.org/project/pyobjc/}.

Há vários kits de ferramentas GUI alternativas disponíveis para o macOS, incluindo:


@itemize *

@item 
PySide@footnote{https://www.qt.io/qt-for-python}: Ligações oficiais em Python ao kit de ferramentas Qt GUI@footnote{https://wiki.qt.io/Qt_for_Python} .

@item 
PyQt@footnote{https://riverbankcomputing.com/software/pyqt/}: Ligações alternativas em Python ao Qt.

@item 
Kivy@footnote{https://kivy.org}: Um kit de ferramentas GUI multiplataforma que dá suporte a plataformas de desktop e dispositivos móveis.

@item 
Toga@footnote{https://toga.readthedocs.io}: Parte do BeeWare Project@footnote{https://beeware.org}; dá suporte a aplicativos para desktop, dispositivos móveis, Web e console.

@item 
wxPython@footnote{https://wxpython.org}: Um kit de ferramentas multiplataforma que dá suporte a sistemas operacionais desktop.
@end itemize

@node Tópicos Avançados,Outros recursos,Programação de GUI,Usando Python em macOS
@anchor{using/mac advanced-topics}@anchor{1fd2}
@subsection Tópicos Avançados


@menu
* Instalando binários com threads livres: Instalando binários com threads livres<2>. 
* Instalação usando a linha de comando:: 
* Distribuindo aplicações Python:: 
* Conformidade com a App Store:: 

@end menu

@node Instalando binários com threads livres<2>,Instalação usando a linha de comando,,Tópicos Avançados
@anchor{using/mac install-freethreaded-macos}@anchor{1fc9}@anchor{using/mac installing-free-threaded-binaries}@anchor{1fd3}
@subsubsection Instalando binários com threads livres



Adicionado na versão 3.13: (Experimental)


@cartouche
@quotation Nota 
Tudo descrito nesta seção é considerado experimental e espera-se que mude em versões futuras.
@end quotation
@end cartouche

O pacote de instalação do @ref{173,,Python para macOS} em @code{python.org} pode, opcionalmente, instalar uma compilação adicional do Python 3.13 que dá suporte à 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}, o recurso experimental de threads livres (executado com o @ref{148,,trava global do interpretador} desativado). Verifique a página de lançamento em @code{python.org} para obter informações atualizadas.

Como esse recurso ainda é considerado experimental, seu suporte não é instalado por padrão. Ele é empacotado como uma opção de instalação separada, disponível clicando no botão `Personalizar' na etapa `Tipo de instalação' do instalador, como descrito acima.

@image{python-figures/mac_installer_09_custom_install_free_threaded,,,,png}

Se a caixa ao lado do nome `Free-Threaded Python' for marcada, um arquivo @code{PythonT.framework} também será instalado junto ao arquivo @code{Python.framework} em @code{/Library/Frameworks}. Essa configuração permite que a compilação de Python 3.13 com threads livres coexista no seu sistema com a compilação de Python 3.13 tradicional (com GIL) com risco mínimo durante instalação ou testagem. Esse layout de instalação é em si experimental e pode mudar em lançamentos futuros.

Precauções e limitações conhecidas:


@itemize -

@item 
O pacote `Unix command-line tools', que é selecionado por padrão, instalará links em @code{/usr/local/bin} para @code{python3.13t}, o interpretador com threads livres e @code{python3.13t-config}, um utilitário de configuração que pode ser útil para criadores de pacote. Como @code{/usr/local/bin} é normalmente incluído em seu @code{PATH} do console, geralmente não é necessário alterar as variáveis de ambiente do @code{PATH} para usar o @code{python3.13t}.

@item 
Neste lançamento, o pacote `Shell profile updater' e o comando @code{Update Shell Profile.command} em @code{/Applications/Python 3.13/} não dão suporte ao pacote com threads livres.

@item 
A construção com threads livres e a compilação tradicional têm caminhos de pesquisa separados e diretórios @code{site-packages} separados, portanto, por padrão, se você precisar de um pacote disponível em ambas construções, talvez seja necessário instalá-lo em ambos. O pacote com threads livres instalará uma instância separada do @code{pip} para uso com o @code{python3.13t}.


@itemize -

@item 
Para instalar um pacote usando @code{pip} sem um @code{venv}:

@example
python3.13t -m pip install <package_name>
@end example
@end itemize

@item 
Ao trabalhar com vários ambientes Python, geralmente é mais seguro e mais fácil @ref{1e83,,criar e usar ambientes virtuais}. Isso pode tanto evitar possíveis conflitos de comandos, quanto evitar a confusão sobre qual Python está sendo usado:

@example
python3.13t -m venv <venv_name>
@end example

e, em seguida, @code{activate}.

@item 
Para executar uma versão do IDLE com threads livres:

@example
python3.13t -m idlelib
@end example

@item 
Os interpretadores em ambos as construções respondem às mesmas variáveis de ambiente @ref{5f1,,PYTHON}, o que pode gerar resultados inesperados, por exemplo, se você tiver @code{PYTHONPATH} definido em um perfil de console. Se necessário, há @ref{1eb3,,opções de linha de comando} como @code{-E} para ignorar essas variáveis de ambiente.

@item 
A construção com threads livres é ligada às bibliotecas compartilhadas de terceiros, como @code{OpenSSL} e @code{Tk}, instaladas no framework tradicional. Isso significa que ambas as compilações também compartilham um conjunto de certificados, como instalados pelo script @code{Install Certificates.command}, portanto, ele só precisa ser executado uma vez.

@item 
Se você não puder depender do link em @code{/usr/local/bin} apontando para @code{python3.13t} com threads livres do @code{python.org} (por exemplo, se quiser instalar sua própria versão lá ou se alguma outra distribuição instalá-lo lá), você poderá definir explicitamente sua variável de ambiente de console @code{PATH} para incluir o diretório da framework @code{PythonT} @code{bin}:

@example
export PATH="/Library/Frameworks/PythonT.framework/Versions/3.13/bin":"$PATH"
@end example

A instalação tradicional do framework por padrão faz algo semelhante, exceto pelo arquivo @code{Python.framework}. Observe que ter dois diretórios @code{bin} do framework em @code{PATH} pode gerar confusão se houver nomes duplicados, como @code{python3.13}, em ambos; qual deles é realmente usado depende da ordem em que aparecem em @code{PATH}. Os comandos @code{which python3.x} ou @code{which python3.xt} pode mostrar qual caminho está sendo usado. Usar ambientes virtuais pode ajudar a evitar essas ambiguidades. Outra opção pode ser criar um @code{alias} no console para o interpretador desejado, como:

@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 Instalação usando a linha de comando,Distribuindo aplicações Python,Instalando binários com threads livres<2>,Tópicos Avançados
@anchor{using/mac installing-using-the-command-line}@anchor{1fd4}
@subsubsection Instalação usando a linha de comando


Se você quiser usar automação para instalar o pacote de instalação @code{python.org} (em vez de usar o aplicativo GUI @code{Installer} do macOS), o utilitário para linha de comando @code{installer} permite que você selecione opções que não sejam do padrão. Se você não estiver familiarizado com o @code{installer}, ele pode ser um tanto enigmático (consulte @code{man installer} para obter mais informações). Como exemplo, o seguinte trecho de console mostra uma maneira de fazer isso, usando a versão @code{3.13.0b2} e selecionando a opção de interpretador com threads livres:

@example
RELEASE="python-3.130b2-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

Você pode então testar que ambas as compilações de instaladores estão disponíveis com algo como:

@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 
Os instaladores atuais do @code{python.org} só instalam em locais fixos, como @code{/Library/Frameworks/}, @code{/Applications} e @code{/usr/local/bin}. Não é possível usar a opção @code{-domain} do @code{installer} para instalar em outros locais.
@end quotation
@end cartouche

@node Distribuindo aplicações Python,Conformidade com a App Store,Instalação usando a linha de comando,Tópicos Avançados
@anchor{using/mac distributing-python-applications}@anchor{1fd5}@anchor{using/mac distributing-python-applications-on-the-mac}@anchor{1fd6}
@subsubsection Distribuindo aplicações Python


Existe uma variedade de ferramentas para converter seu código Python em uma aplicação distribuível independente:


@itemize *

@item 
py2app@footnote{https://pypi.org/project/py2app/}: Oferece suporte à criação de pacotes @code{.app} do macOS a partir de um projeto Python.

@item 
Briefcase@footnote{https://briefcase.readthedocs.io}: Parte do BeeWare Project@footnote{https://beeware.org}; uma ferramenta de empacotamento multiplataforma que permite criar `bundles' @code{.app} no macOS, além de gerenciar assinaturas digitais e a notarização.

@item 
PyInstaller@footnote{https://pyinstaller.org/}: Uma ferramenta de empacotamento multiplataforma que cria um único arquivo ou pasta como um artefato distribuível.
@end itemize

@node Conformidade com a App Store,,Distribuindo aplicações Python,Tópicos Avançados
@anchor{using/mac app-store-compliance}@anchor{1fd7}
@subsubsection Conformidade com a App Store


As aplicações enviadas para distribuição pela macOS App Store devem passar pelo processo de revisão de aplicativos da Apple. Esse processo inclui um conjunto de regras de validação automatizadas que inspecionam o pacote de aplicativos enviado em busca de código problemático.

A biblioteca padrão do Python contém alguns códigos que violam essas regras automatizadas. Embora essas violações pareçam ser falsos positivos, as regras de revisão da Apple não podem ser contestadas. Portanto, é necessário modificar a biblioteca padrão do Python para que uma aplicação passe na revisão da App Store.

A árvore de fontes do Python contém um arquivo de patch@footnote{https://github.com/python/cpython/tree/3.13/Mac/Resources/app-store-compliance.patch} que removerá todo o código que é conhecido por causar problemas no processo de revisão da App Store. Este patch é aplicado automaticamente quando o CPython é configurado com a opção @ref{16de,,--with-app-store-compliance}.

Este patch normalmente não é necessário para usar o CPython em um Mac; nem é necessário se você estiver distribuindo uma aplicação `fora' da App Store do macOS. É necessário `apenas' se você estiver usando a App Store do macOS como canal de distribuição.

@node Outros recursos,,Tópicos Avançados,Usando Python em macOS
@anchor{using/mac other-resources}@anchor{1fd8}
@subsection Outros recursos


A página de ajuda do python.org@footnote{https://www.python.org/about/help/} contém links para vários recursos úteis. A lista de discussão Pythonmac-SIG@footnote{https://www.python.org/community/sigs/current/pythonmac-sig/} é outro recurso específico de suporte para usuários e desenvolvedores de Python no Mac.

@node Utilizando Python no Android,Usando Python no iOS,Usando Python em macOS,Configurações e Uso do Python
@anchor{using/android doc}@anchor{1fd9}@anchor{using/android translation-repo}@anchor{1fda}@anchor{using/android using-android}@anchor{1fdb}@anchor{using/android using-python-on-android}@anchor{1fdc}
@section Utilizando Python no Android


Python no Android é diferente do Python em plataformas de desktop. Em uma plataforma desktop, o Python geralmente é instalado como um recurso do sistema que pode ser usado por qualquer usuário daquele computador. Os usuários então interagem com o Python executando um executável @code{python} e inserindo comandos em um prompt interativo ou executando um script Python.

No Android, não existe o conceito de instalação como recurso do sistema. A única unidade de distribuição de software é uma aplicação, ou “app”. Também não há console onde você possa executar um executável @code{python} ou interagir com um REPL do Python.

Como resultado, a única maneira de usar Python no Andoid é no modo incorporado – ou seja, escrevendo uma aplicação Android nativo, incorporando um interpretador Python usando @code{libpython} e invocando o código Python usando @ref{1fdd,,API de incorporação do Python}. O interpretador Python completo, a biblioteca padrão e todo o seu código Python são então empacotados para sua aplicação para seu próprio uso privado.

A biblioteca padrão do Python tem algumas omissões e restrições notáveis no Andoid. Consulte o @ref{1fde,,guia de disponibilidade de API para Android} para obter detalhes.

@menu
* Adicionando Python a uma aplicação Android:: 
* Construindo um pacote Python para Android:: 

@end menu

@node Adicionando Python a uma aplicação Android,Construindo um pacote Python para Android,,Utilizando Python no Android
@anchor{using/android adding-python-to-an-android-app}@anchor{1fdf}
@subsection Adicionando Python a uma aplicação Android


A maioria dos desenvolvedores de aplicações deve usar uma das seguintes ferramentas, o que proporcionará uma experiência muito mais fácil:


@itemize *

@item 
Briefcase@footnote{https://briefcase.readthedocs.io}, do projeto BeeWare

@item 
Buildozer@footnote{https://buildozer.readthedocs.io}, do projeto Kivy

@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

Se você tem certeza de que quer fazer tudo isso manualmente, continue lendo. Você pode usar a aplicação testbed@footnote{https://github.com/python/cpython/tree/3.13/Android/testbed} como um guia; cada passo abaixo contém um link para o arquivo relevante.


@itemize *

@item 
Construa o Python seguindo as instruções em Android/README.md@footnote{https://github.com/python/cpython/tree/3.13/Android/README.md}. Isso vai criar o diretório @code{cross-build/HOST/prefix}.

@item 
Adicione código ao seu arquivo build.gradle@footnote{https://github.com/python/cpython/tree/3.13/Android/testbed/app/build.gradle.kts} para copiar os seguintes itens para o seu projeto. Todos, exceto seu próprio código Python, podem ser copiados de @code{prefix/lib}:


@itemize *

@item 
Em suas bibliotecas JNI:


@itemize *

@item 
@code{libpython*.*.so}

@item 
@code{lib*_python.so} (bibliotecas externas, tal como OpenSSL)
@end itemize

@item 
Em seus ativos (`assets'):


@itemize *

@item 
@code{python*.*} (a biblioteca padrão do Python)

@item 
@code{python*.*/site-packages} (seu próprio código Python)
@end itemize
@end itemize

@item 
Adicione código ao seu aplicativo para extrair os ativos para o sistema de arquivos@footnote{https://github.com/python/cpython/tree/3.13/Android/testbed/app/src/main/java/org/python/testbed/MainActivity.kt}.

@item 
Adicione código a sua aplicação para iniciar o Python em modo incorporado@footnote{https://github.com/python/cpython/tree/3.13/Android/testbed/app/src/main/c/main_activity.c}. Isso precisará ser código C chamado via JNI.
@end itemize

@node Construindo um pacote Python para Android,,Adicionando Python a uma aplicação Android,Utilizando Python no Android
@anchor{using/android building-a-python-package-for-android}@anchor{1fe0}
@subsection Construindo um pacote Python para Android


Pacotes Python podem ser criados para Android como wheels e lançados no PyPI. A ferramenta recomendada para isso é cibuildwheel@footnote{https://cibuildwheel.pypa.io/en/stable/platforms/#android}, que automatiza todos os detalhes da configuração de um ambiente de compilação cruzada, da construção da wheel e dos testes em um emulador.

@node Usando Python no iOS,Editores e IDEs,Utilizando Python no Android,Configurações e Uso do Python
@anchor{using/ios doc}@anchor{1fe1}@anchor{using/ios translation-repo}@anchor{1fe2}@anchor{using/ios using-ios}@anchor{1fe3}@anchor{using/ios using-python-on-ios}@anchor{1fe4}
@section Usando Python no iOS


@*Autores: 
Russell Keith-Magee (2024-03)


Python no iOS é diferente do Python em plataformas de desktop. Em uma plataforma desktop, o Python geralmente é instalado como um recurso do sistema que pode ser usado por qualquer usuário daquele computador. Os usuários então interagem com o Python executando um executável @code{python} e inserindo comandos em um prompt interativo ou executando um script Python.

No iOS, não existe o conceito de instalação como recurso do sistema. A única unidade de distribuição de software é uma aplicação, ou “app”. Também não há console onde você possa executar um executável @code{python} ou interagir com um REPL do Python.

Como resultado, a única maneira de usar Python no iOS é no modo incorporado – ou seja, escrevendo uma aplicação iOS nativo e incorporando um interpretador Python usando @code{libPython} e invocando o código Python usando @ref{1fdd,,API de incorporação do Python}. O interpretador Python completo, a biblioteca padrão e todo o seu código Python são então empacotados como um pacote independente que pode ser distribuído pela iOS App Store.

Se você deseja experimentar pela primeira vez escrever uma aplicação iOS em Python, projetos como BeeWare@footnote{https://beeware.org} e Kivy@footnote{https://kivy.org} irão fornecer uma experiência de usuário muito mais acessível. Esses projetos gerenciam as complexidades associadas à execução de um projeto iOS, portanto, você só precisa lidar com o próprio código Python.

@menu
* Python em tempo de execução no iOS:: 
* Instalando Python no iOS:: 
* Conformidade com a App Store: Conformidade com a App Store<2>. 

@end menu

@node Python em tempo de execução no iOS,Instalando Python no iOS,,Usando Python no iOS
@anchor{using/ios python-at-runtime-on-ios}@anchor{1fe5}
@subsection Python em tempo de execução no iOS


@menu
* Compatibilidade com a versão do iOS:: 
* Identificação da plataforma:: 
* Disponibilidade da biblioteca padrão:: 
* Módulos de extensão binária:: 
* Binários stub do compilador:: 

@end menu

@node Compatibilidade com a versão do iOS,Identificação da plataforma,,Python em tempo de execução no iOS
@anchor{using/ios ios-version-compatibility}@anchor{1fe6}
@subsubsection Compatibilidade com a versão do iOS


A versão mínima suportada do iOS é especificada em tempo de compilação, usando a opção @ref{1f5a,,--host} do @code{configure}. Por padrão, quando compilado para iOS, Python será compilado com uma versão iOS mínima suportada de 13.0. Para usar uma versão mínima diferente do iOS, forneça o número da versão como parte do argumento @code{--host} - por exemplo, @code{--host=arm64-apple-ios15.4-simulator} compilaria um simulador ARM64 construído com uma meta de implantação de 15.4.

@node Identificação da plataforma,Disponibilidade da biblioteca padrão,Compatibilidade com a versão do iOS,Python em tempo de execução no iOS
@anchor{using/ios platform-identification}@anchor{1fe7}
@subsubsection Identificação da plataforma


Ao executar no iOS, @code{sys.platform} reportará como @code{ios}. Este valor será retornado em um iPhone ou iPad, independentemente da aplicação estar executando no simulador ou em um dispositivo físico.

Informações sobre o ambiente de execução específico, incluindo a versão do iOS, modelo do dispositivo e se o dispositivo é um simulador, podem ser obtidas usando @ref{1fe8,,platform.ios_ver()}. @ref{1fe9,,platform.system()} reportará @code{iOS} ou @code{iPadOS}, dependendo do dispositivo.

@ref{1155,,os.uname()} reporta detalhes em nível de kernel; ele reportará o nome @code{Darwin}.

@node Disponibilidade da biblioteca padrão,Módulos de extensão binária,Identificação da plataforma,Python em tempo de execução no iOS
@anchor{using/ios standard-library-availability}@anchor{1fea}
@subsubsection Disponibilidade da biblioteca padrão


A biblioteca padrão do Python tem algumas omissões e restrições notáveis no iOS. Consulte o @ref{1fde,,guia de disponibilidade de API para iOS} para obter detalhes.

@node Módulos de extensão binária,Binários stub do compilador,Disponibilidade da biblioteca padrão,Python em tempo de execução no iOS
@anchor{using/ios binary-extension-modules}@anchor{1feb}
@subsubsection Módulos de extensão binária


Uma diferença notável sobre o iOS como plataforma é que a distribuição da App Store impõe requisitos rígidos ao empacotamento de uma aplicação. Um desses requisitos rege como os módulos de extensão binária são distribuídos.

A iOS App Store exige que `todos' os módulos binários em uma aplicação iOS sejam bibliotecas dinâmicas, contidas em um framework com metadados apropriados, armazenados na pasta @code{Frameworks} da aplicação empacotada. Pode haver apenas um único binário por framework, e não pode haver nenhum material binário executável fora da pasta @code{Frameworks}.

Isto entra em conflito com a abordagem usual do Python para distribuição de binários, que permite que um módulo de extensão binária seja carregado de qualquer local em @code{sys.path}. Para garantir a conformidade com as políticas da App Store, um projeto iOS deve pós-processar quaisquer pacotes Python, convertendo módulos binários @code{.so} em estruturas independentes individuais com metadados e assinatura apropriados. Para obter detalhes sobre como realizar esse pós-processamento, consulte o guia para @ref{1fec,,adicionar Python ao seu projeto}.

Para ajudar o Python a descobrir binários em seu novo local, o arquivo @code{.so} original em @code{sys.path} é substituído por um arquivo @code{.fwork}. Este arquivo é um arquivo texto que contém a localização do binário do framework, relativo ao pacote de aplicações. Para permitir que o framework retorne ao local original, o framework deve conter um arquivo @code{.origin} que contém a localização do arquivo @code{.fwork}, relativo ao pacote da aplicação.

Por exemplo, considere o caso de uma importação @code{from foo.bar import _whiz}, onde @code{_whiz} é implementado com o módulo binário @code{sources/foo/bar/_whiz.abi3.so}, com @code{sources} sendo o local registrado em @code{sys.path}, relativo ao pacote da aplicação. Este módulo `deve' ser distribuído como @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz} (criando o nome do framework a partir do caminho de importação completo do módulo), com um arquivo @code{Info.plist} no diretório @code{.framework} identificando o binário como um framework. O módulo @code{foo.bar._whiz} seria representado no local original com um arquivo marcador @code{sources/foo/bar/_whiz.abi3.fwork}, contendo o caminho @code{Frameworks/foo.bar._whiz/foo.bar._whiz}. O framework também conteria @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}, contendo o caminho para o arquivo @code{.fwork}.

Ao executar no iOS, o interpretador Python instalará um @ref{1fed,,AppleFrameworkLoader} que é capaz de ler e importar arquivos @code{.fwork}. Uma vez importado, o atributo @code{__file__} do módulo binário reportará como a localização do arquivo @code{.fwork}. Entretanto, o @ref{1fee,,ModuleSpec} para o módulo carregado reportará a @code{origin} como a localização do binário na pasta do framework.

@node Binários stub do compilador,,Módulos de extensão binária,Python em tempo de execução no iOS
@anchor{using/ios compiler-stub-binaries}@anchor{1fef}
@subsubsection Binários stub do compilador


O Xcode não expõe compiladores explícitos para iOS; em vez disso, ele usa um script @code{xcrun} que resolve um caminho  do compilador (por exemplo, @code{xcrun --sdk iphoneos clang} para obter o @code{clang} para um dispositivo iPhone). No entanto, usar este script apresenta dois problemas:


@itemize *

@item 
A saída de @code{xcrun} inclui caminhos que são específicos da máquina, resultando em um módulo sysconfig que não pode ser compartilhado entre usuários; e

@item 
Isso resulta em definições @code{CC}/@code{CPP}/@code{LD}/@code{AR} que incluem espaços. Existem muitas ferramentas do ecossistema C que pressupõem que você pode dividir uma linha de comando no primeiro espaço para obter o caminho para o executável do compilador; este não é o caso ao usar @code{xcrun}.
@end itemize

Para evitar esses problemas, o Python forneceu stubs para essas ferramentas. Esses stubs são wrappers de script de shell em torno das ferramentas subjacentes @code{xcrun}, distribuídos em uma pasta @code{bin} distribuída junto com a estrutura iOS compilada. Esses scripts são relocáveis e sempre serão resolvidos para os caminhos apropriados do sistema local. Ao incluir esses scripts na pasta bin que acompanha um framework, o conteúdo do módulo @code{sysconfig} se torna útil para usuários finais compilarem seus próprios módulos. Ao compilar módulos Python de terceiros para iOS, você deve garantir que esses binários stub estejam no seu caminho.

@node Instalando Python no iOS,Conformidade com a App Store<2>,Python em tempo de execução no iOS,Usando Python no iOS
@anchor{using/ios installing-python-on-ios}@anchor{1ff0}
@subsection Instalando Python no iOS


@menu
* Ferramentas para construir aplicações de iOS:: 
* Adicionando Python a um projeto iOS:: 
* Testando um pacote Python:: 

@end menu

@node Ferramentas para construir aplicações de iOS,Adicionando Python a um projeto iOS,,Instalando Python no iOS
@anchor{using/ios tools-for-building-ios-apps}@anchor{1ff1}
@subsubsection Ferramentas para construir aplicações de iOS


A construção para iOS requer o uso das ferramentas Xcode da Apple. É altamente recomendável que você use a versão estável mais recente do Xcode. Isso exigirá o uso da versão mais recente (ou segunda) do macOS lançada recentemente, já que a Apple não mantém o Xcode para versões mais antigas do macOS. As ferramentas de linha de comando do Xcode não são suficientes para o desenvolvimento iOS; você precisa de uma instalação `completa' do Xcode.

Se quiser executar seu código no simulador iOS, você também precisará instalar um iOS Simulator Platform. Você deverá ser solicitado a selecionar um iOS Simulator Platform ao executar o Xcode pela primeira vez. Alternativamente, você pode adicionar um iOS Simulator Platform selecionando na guia Platforms do painel Settings do Xcode.

@node Adicionando Python a um projeto iOS,Testando um pacote Python,Ferramentas para construir aplicações de iOS,Instalando Python no iOS
@anchor{using/ios adding-ios}@anchor{1fec}@anchor{using/ios adding-python-to-an-ios-project}@anchor{1ff2}
@subsubsection Adicionando Python a um projeto iOS


Python pode ser adicionado a qualquer projeto iOS, usando Swift ou Objective C. Os exemplos a seguir usarão Objective C; se você estiver usando Swift, poderá achar uma biblioteca como PythonKit@footnote{https://github.com/pvieito/PythonKit} útil.

Para adicionar Python a um projeto Xcode de iOS:


@enumerate 

@item 
Construa ou obtenha um @code{XCFramework} em Python. Veja as instruções em iOS/README.rst@footnote{https://github.com/python/cpython/tree/3.13/iOS/README.rst} (na distribuição fonte do CPython) para detalhes sobre como construir um @code{XCFramework} em Python. No mínimo, você precisará de uma construção que tenha suporte @code{arm64-apple-ios}, além de @code{arm64-apple-ios-simulator} ou @code{x86_64-apple-ios-simulator}.

@item 
Arraste o @code{XCframework} para o seu projeto iOS. Nas instruções a seguir, presumiremos que você colocou o @code{XCframework} na raiz do seu projeto; no entanto, você pode usar qualquer outro local desejado ajustando os caminhos conforme necessário.

@item 
Arraste o arquivo @code{iOS/Resources/dylib-Info-template.plist} para o seu projeto e certifique-se de que ele esteja associado ao destino da aplicação.

@item 
Adicione o código da sua aplicação como uma pasta no seu projeto Xcode. Nas instruções a seguir, presumiremos que seu código de usuário está em uma pasta chamada @code{app} na raiz do seu projeto; você pode usar qualquer outro local ajustando os caminhos conforme necessário. Certifique-se de que esta pasta esteja associada ao destino da sua aplicação.

@item 
Selecione o destino da aplicação selecionando o nó raiz do seu projeto Xcode e, em seguida, o nome do destino na barra lateral que aparece.

@item 
Nas configurações de “General”, em “Frameworks, Libraries and Embedded Content”, adicione @code{Python.xcframework}, com “Embed & Sign” selecionado.

@item 
Na guia “Build Settings”, modifique o seguinte:


@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 
Adicione uma etapa de construção que copie a biblioteca padrão do Python em sua aplicação. Na aba “Build Phases”, adicione uma nova etapa de construção “Run Script” `antes' da etapa “Embed Frameworks”, mas `depois' da etapa “Copy Bundle Resources”. Nomeie a etapa como “Install Target Specific Python Standard Library”, desative a caixa de seleção “Based on dependency analysis” e defina o conteúdo do script como:

@example
set -e

mkdir -p "$CODESIGNING_FOLDER_PATH/python/lib"
if [ "$EFFECTIVE_PLATFORM_NAME" = "-iphonesimulator" ]; then
    echo "Instalando módulos Python para iOS Simulator"
    rsync -au --delete "$PROJECT_DIR/Python.xcframework/ios-arm64_x86_64-simulator/lib/" "$CODESIGNING_FOLDER_PATH/python/lib/"
else
    echo "Instalando módulos Python para iOS Device"
    rsync -au --delete "$PROJECT_DIR/Python.xcframework/ios-arm64/lib/" "$CODESIGNING_FOLDER_PATH/python/lib/"
fi
@end example

Note que o nome da “fatia” do simulador no XCframework pode ser diferente, dependendo das arquiteturas de CPU que seu @code{XCFramework} provê suporte.

@item 
Adicione uma segunda etapa de construção que processe os módulos de extensão binária na biblioteca padrão no formato “Framework”. Adicione uma etapa de construção “Run Script” `diretamente após' aquela que você adicionou na etapa 8, chamada “Prepare Python Binary Modules”. Também deve ter “Based on dependency analysis” desmarcado, com o seguinte conteúdo de script:

@example
set -e

install_dylib () @{
    INSTALL_BASE=$1
    FULL_EXT=$2

    # O nome do arquivo da extensão
    EXT=$(basename "$FULL_EXT")
    # A localização do arquivo da extensão, relativo ao pacote
    RELATIVE_EXT=$@{FULL_EXT#$CODESIGNING_FOLDER_PATH/@}
    # O caminho para o arquivo da extensão, relativo à base de instalação
    PYTHON_EXT=$@{RELATIVE_EXT/$INSTALL_BASE/@}
    # O nome completo e pontilhado do módulo de extensão, construído a partir do caminho do arquivo.
    FULL_MODULE_NAME=$(echo $PYTHON_EXT | cut -d "." -f 1 | tr "/" ".");
    # Um identificador de pacote; não é realmente usado, mas é necessário para empacotamento de frameworks no Xcode
    FRAMEWORK_BUNDLE_ID=$(echo $PRODUCT_BUNDLE_IDENTIFIER.$FULL_MODULE_NAME | tr "_" "-")
    # O nome da pasta do framework.
    FRAMEWORK_FOLDER="Frameworks/$FULL_MODULE_NAME.framework"

    # Se a pasta do framework não existir, cria-a.
    if [ ! -d "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER" ]; then
        echo "Criando framework para $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 "Instalando binário para $FRAMEWORK_FOLDER/$FULL_MODULE_NAME"
    mv "$FULL_EXT" "$CODESIGNING_FOLDER_PATH/$FRAMEWORK_FOLDER/$FULL_MODULE_NAME"
    # Cria um arquivo substituto .fwork onde o .so estava
    echo "$FRAMEWORK_FOLDER/$FULL_MODULE_NAME" > $@{FULL_EXT%.so@}.fwork
    # Cria uma referência para o local do arquivo .so no 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 "Instalando módulos de extensão da biblioteca padrão para Python $PYTHON_VER..."
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

# Remove o modelo dylib
rm -f "$CODESIGNING_FOLDER_PATH/dylib-Info-template.plist"

echo "Assinando frameworks como $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 
Adicione código Objective C para inicializar e usar um interpretador Python em modo embarcado. Você deve garantir que:
@end enumerate

@quotation


@itemize *

@item 
Modo UTF-8 (@ref{3ea,,PyPreConfig.utf8_mode}) esteja habilitado;

@item 
Stdio buffered (@ref{3df,,PyConfig.buffered_stdio}) esteja desabilitado;

@item 
Escrita de bytecode (@ref{3db,,PyConfig.write_bytecode}) esteja desabilitada;

@item 
Manipuladores de sinais (@ref{8c3,,PyConfig.install_signal_handlers}) estejam habilitados;

@item 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} para o interpretador esteja configurado para apontar para a subpasta @code{python} do pacote da sua aplicação; e

@item 
O 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} para o interpretador inclui:


@itemize -

@item 
a subpasta @code{python/lib/python3.X} do pacote da sua aplicação,

@item 
a subpasta @code{python/lib/python3.X/lib-dynload} do pacote da sua aplicação, e

@item 
a subpasta @code{app} do pacote da sua aplicação
@end itemize
@end itemize

O local do pacote da sua aplicação pode ser determinada usando @code{[[NSBundle mainBundle] resourcePath]}.
@end quotation

Os passos 8, 9 e 10 destas instruções presumem que você tem uma única pasta de código de aplicação Python puro, chamada @code{app}. Se você tiver módulos binários de terceiros em sua aplicação, serão necessárias algumas etapas adicionais:


@itemize *

@item 
Você precisa garantir que todas as pastas que contenham binários de terceiros sejam associadas ao destino da aplicação ou copiadas como parte da etapa 8. A etapa 8 também deve limpar quaisquer binários que não sejam apropriados para a plataforma que uma construção específica está direcionando (ou seja, exclua todos os binários do dispositivo se estiver criando uma aplicação direcionado ao simulador).

@item 
Quaisquer pastas que contenham binários de terceiros devem ser processadas no formato framework no passo 9. A invocação de @code{install_dylib} que processa a pasta @code{lib-dynload} pode ser copiada e adaptada para este propósito.

@item 
Se você estiver usando uma pasta separada para pacotes de terceiros, certifique-se de que essa pasta esteja incluída como parte da configuração 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} no passo 10.

@item 
Se alguma das pastas que contêm pacotes de terceiros contiver arquivos @code{.pth}, você deverá adicionar essa pasta como um `diretório de site' (usando @ref{1ff3,,site.addsitedir()}), em vez de adicioná-la diretamente a 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} ou @ref{3b4,,sys.path}.
@end itemize

@node Testando um pacote Python,,Adicionando Python a um projeto iOS,Instalando Python no iOS
@anchor{using/ios testing-a-python-package}@anchor{1ff4}
@subsubsection Testando um pacote Python


A árvore de fontes do CPython contém um projeto de banco de testes@footnote{https://github.com/python/cpython/tree/3.13/iOS/testbed} que é usado para executar o conjunto de testes do CPython no simulador do iOS. Este banco de testes também pode ser usado como um projeto de banco de testes para executar o conjunto de testes da sua biblioteca Python no iOS.

Depois de criar ou obter um iOS XCFramework (consulte iOS/README.rst@footnote{https://github.com/python/cpython/tree/3.13/iOS/README.rst} para obter detalhes), crie um clone do projeto de banco de testes de iOS do Python executando:

@example
$ python iOS/testbed clone --framework <caminho/para/Python.xcframework> --app <caminho/para/módulo1> --app <caminho/para/módulo2> app-testbed
@end example

Você precisará modificar a referência @code{iOS/testbed} para apontar para esse diretório na árvore de fontes do CPython; todas as pastas especificadas com o sinalizador @code{--app} serão copiadas para o projeto de banco de testes clonado. O banco de testes resultante será criado na pasta @code{app-testbed}. Neste exemplo, @code{módulo1} e @code{módulo2} seriam módulos importáveis em tempo de execução. Se seu projeto tiver dependências adicionais, elas podem ser instaladas na pasta @code{app-testbed/iOSTestbed/app_packages} (usando @code{pip install --target app-testbed/iOSTestbed/app_packages} ou similar).

Você pode então usar a pasta @code{app-testbed} para executar o conjunto de testes para seu aplicativo. Por exemplo, se @code{módulo1.tests} fosse o ponto de entrada para seu conjunto de testes, você poderia executar:

@example
$ python app-testbed run -- módulo1.tests
@end example

Isso é o equivalente a executar @code{python -m módulo1.tests} em uma compilação Python de desktop. Quaisquer argumentos após @code{--} serão passados para o banco de testes como se fossem argumentos para @code{python -m} em uma máquina de desktop.

Você também pode abrir o projeto de teste no Xcode executando:

@example
$ open app-testbed/iOSTestbed.xcodeproj
@end example

Isso permitirá que você use o conjunto completo de ferramentas do Xcode para depuração.

Os argumentos usados para executar o conjunto de testes são definidos como parte do plano de teste. Para modificar o plano de teste, selecione o nó do plano de teste na árvore do projeto (deve ser o primeiro filho do nó raiz) e selecione a aba “Configurations”. Modifique o valor “Arguments Passed On Launch” para alterar os argumentos de teste.

O plano de teste também desabilita os testes paralelos e especifica o uso do arquivo @code{iOSTestbed.lldbinit} para fornecer a configuração do depurador. A configuração padrão do depurador desabilita pontos de interrupção automáticos nos sinais @code{SIGINT}, @code{SIGUSR1}, @code{SIGUSR2} e @code{SIGXFSZ}.

@node Conformidade com a App Store<2>,,Instalando Python no iOS,Usando Python no iOS
@anchor{using/ios app-store-compliance}@anchor{1ff5}
@subsection Conformidade com a App Store


O único mecanismo para distribuir aplicações para dispositivos iOS de terceiros é enviar a aplicação para a App Store do iOS; as aplicações enviadas para distribuição devem passar pelo processo de revisão de aplicações da Apple. Esse processo inclui um conjunto de regras de validação automatizadas que inspecionam o pacote de aplicação enviado em busca de código problemático.

A biblioteca padrão do Python contém alguns códigos que violam essas regras automatizadas. Embora essas violações pareçam ser falsos positivos, as regras de revisão da Apple não podem ser contestadas; portanto, é necessário modificar a biblioteca padrão do Python para que uma aplicação passe na revisão da App Store.

A árvore de fontes do Python contém um arquivo de patch@footnote{https://github.com/python/cpython/tree/3.13/Mac/Resources/app-store-compliance.patch} que removerá todo o código que é conhecido por causar problemas no processo de revisão da App Store. Este patch é aplicado automaticamente quando o ao construir para o iOS.

@node Editores e IDEs,,Usando Python no iOS,Configurações e Uso do Python
@anchor{using/editors doc}@anchor{1ff6}@anchor{using/editors editors}@anchor{1fcb}@anchor{using/editors editors-and-ides}@anchor{1ff7}@anchor{using/editors translation-repo}@anchor{1ff8}
@section Editores e IDEs


Há um grande número de IDEs com suporte à linguagem de programação Python. Vários editores e IDEs provêm destaques coloridos de sintaxe, ferramentas de depuração, e checagem do código conforme a 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}.

@menu
* IDLE — editor e console Python:: 
* Outros editores e IDEs:: 

@end menu

@node IDLE — editor e console Python,Outros editores e IDEs,,Editores e IDEs
@anchor{using/editors idle-python-editor-and-shell}@anchor{1ff9}
@subsection IDLE — editor e console Python


IDLE é o Ambiente Integrado de Desenvolvimento e Aprendizagem do Python (em inglês Integrated Development and Learning Environment) e geralmente vem junto com as instalações do Python. Se você estiver no Linux e não tiver o IDLE instalado consulte @ref{1ee2,,Instalando o IDLE no Linux}. Para obter mais informações consulte, consulte os documentos do @ref{104b,,IDLE}.

@node Outros editores e IDEs,,IDLE — editor e console Python,Editores e IDEs
@anchor{using/editors other-editors-and-ides}@anchor{1ffa}
@subsection Outros editores e IDEs


As wikis da comunidades Python têm informações enviadas pela comunidade sobre Editores e IDEs. Acesse Ferramentas de Desenvolvimento@footnote{https://python.org.br/ferramentas/} para obter uma lista abrangente enviada pela comunidade brasileira ou Python Editors@footnote{https://wiki.python.org/moin/PythonEditors} e Integrated Development Environments@footnote{https://wiki.python.org/moin/IntegratedDevelopmentEnvironments} para listas enviadas pela comunidade internacional (em inglês).

@node A Referência da Linguagem Python,A Biblioteca Padrão do Python,Configurações e Uso do Python,Top
@anchor{reference/index doc}@anchor{1ffb}@anchor{reference/index reference-index}@anchor{145}@anchor{reference/index the-python-language-reference}@anchor{1ffc}@anchor{reference/index translation-repo}@anchor{1ffd}
@chapter A Referência da Linguagem Python


Este manual de referência descreve a sintaxe e a “semântica central” da linguagem. É conciso, mas tenta ser exato e completo. A semântica dos tipos de objetos embutidos não essenciais e das funções e módulos embutidos é descrita em @ref{144,,A Biblioteca Padrão do Python}. Para uma introdução informal à linguagem, consulte @ref{1d55,,O tutorial do Python}. Para programadores em C ou C++, existem dois manuais adicionais: @ref{1d56,,Estendendo e incorporando o interpretador Python} descreve a imagem de alto nível de como escrever um módulo de extensão Python, e o @ref{1d57,,Manual de referência da API Python/C} descreve as interfaces disponíveis para programadores C/C++ em detalhes.

@menu
* Introdução: Introdução<5>. 
* Análise léxica:: 
* Modelo de dados:: 
* Modelo de execução:: 
* O sistema de importação:: 
* Expressões:: 
* Instruções simples:: 
* Instruções compostas:: 
* Componentes de Alto Nível:: 
* Especificação completa da gramática:: 

@end menu

@node Introdução<5>,Análise léxica,,A Referência da Linguagem Python
@anchor{reference/introduction doc}@anchor{1ffe}@anchor{reference/introduction id1}@anchor{1fff}@anchor{reference/introduction introduction}@anchor{2000}
@section Introdução


Este manual de referência descreve a linguagem de programação Python. O mesmo não tem como objetivo de ser um tutorial.

Enquanto estou tentando ser o mais preciso possível, optei por usar especificações em inglês e não formal para tudo, exceto para a sintaxe e análise léxica. Isso deve tornar o documento mais compreensível para o leitor intermediário, mas deixará margem para ambiguidades. Consequentemente, caso estivesses vindo de Marte e tentasse reimplementar o Python a partir deste documento, sozinho, talvez precisarias adivinhar algumas coisas e, na verdade, provavelmente acabaria por implementar um linguagem bem diferente. Por outro lado, se estiveres usando o Python e se perguntando quais são as regras precisas sobre uma determinada área da linguagem, você definitivamente encontrá neste documento o que estás procurando. Caso queiras ver uma definição mais formal do linguagem, talvez possas oferecer seu tempo – ou inventar uma máquina de clonagem :-).

É perigoso adicionar muitos detalhes de implementação num documento de referência de uma linguagem – a implementação pode mudar e outras implementações da mesma linguagem podem funcionar de forma diferente. Por outro lado, o CPython é a única implementação de Python em uso de forma generalizada (embora as implementações alternativas continuem a ganhar suporte), e suas peculiaridades e particulares são por vezes dignas de serem mencionadas, especialmente quando a implementação impõe limitações adicionais. Portanto, encontrarás poucas “notas sobre a implementação” espalhadas neste documento.

Cada implementação do Python vem com vários módulos embutidos e por padrão. Estes estão documentados em @ref{144,,A Biblioteca Padrão do Python}. Alguns módulos embutidos são mencionados ao interagirem de forma significativa com a definição da linguagem.

@menu
* Implementações Alternativas:: 
* Notação:: 

@end menu

@node Implementações Alternativas,Notação,,Introdução<5>
@anchor{reference/introduction alternate-implementations}@anchor{2001}@anchor{reference/introduction implementations}@anchor{1eb0}
@subsection Implementações Alternativas


Embora exista uma implementação do Python que seja, de longe, a mais popular, existem algumas implementações alternativas que são de de interesse particular e para públicos diferentes.

As implementações conhecidas são:


@table @asis

@item CPython

Esta é a implementação original e a é a versão do Python que mais vem sendo sendo desenvolvido e a mesma está escrita com a linguagem C. Novas funcionalidades ou recursos da linguagem aparecerão por aqui primeiro.

@item Jython

Versão do Python implementado em Java. Esta implementação pode ser usada como linguagem de Script em aplicações Java, ou pode ser usada para criar aplicativos usando as bibliotecas das classes do Java. Também vem sendo bastante utilizado para criar testes unitários para as bibliotecas do Java. Mais informações podem ser encontradas no the Jython website@footnote{https://www.jython.org/}.

@item Python for .NET

Essa implementação utiliza de fato a implementação CPython, mas é uma aplicação gerenciada .NET e disponibilizada como uma bibliotecas .NET. Foi desenvolvida por Brian Lloyd. Para obter mais informações, consulte o site do Python for .NET@footnote{https://pythonnet.github.io/}.

@item IronPython

Um versão alternativa do Python para a plataforma .NET. Ao contrário do Python.NET, esta é uma implementação completa do Python que gera IL e compila o código Python diretamente para assemblies .NET. Foi desenvolvida por Jim Hugunin, o criador original do Jython. Para obter mais informações, consulte o site do IronPython@footnote{https://ironpython.net/}.

@item PyPy

Uma implementação do Python escrita completamente em Python. A mesma suporta vários recursos avançados não encontrados em outras implementações, como suporte sem pilhas e um compilador Just in Time. Um dos objetivos do projeto é incentivar a construção de experimentos com a própria linguagem, facilitando a modificação do interpretador (uma vez que o mesmos está escrito em Python). Informações adicionais estão disponíveis no site do projeto PyPy@footnote{https://pypy.org/}.
@end table

Cada uma dessas implementações varia em alguma forma a linguagem conforme documentado neste manual, ou introduz informações específicas além do que está coberto na documentação padrão do Python. Consulte a documentação específica da implementação para determinar o que é necessário sobre a implementação específica que você está usando.

@node Notação,,Implementações Alternativas,Introdução<5>
@anchor{reference/introduction id2}@anchor{2002}@anchor{reference/introduction notation}@anchor{2003}
@subsection Notação


@geindex BNF
@geindex gramática
@geindex sintaxe
@geindex notação

As descrições de análise léxica e sintaxe usam uma notação de gramática de Formalismo de Backus-Naur (BNF)@footnote{https://pt.wikipedia.org/wiki/Formalismo_de_Backus-Naur} modificada.  Ela usa o seguinte estilo de definição:

@example
@anchor{reference/introduction grammar-token-notation-name}@anchor{2004}name      ::= @ref{2005,,lc_letter} (@ref{2005,,lc_letter} | "_")*
@anchor{reference/introduction grammar-token-notation-lc_letter}@anchor{2005}lc_letter ::= "a"..."z"
@end example

A primeira linha diz que um @code{name} é um @code{lc_letter} seguido de uma sequência de zero ou mais @code{lc_letter}s e underscores. Um @code{lc_letter} por sua vez é qualquer um dos caracteres simples @code{'a'} através de @code{'z'}. (Esta regra é aderida pelos nomes definidos nas regras léxicas e gramáticas deste documento.)

Cada regra começa com um nome (no caso, o nome definido pela regra) e @code{::=}. Uma barra vertical (@code{|}) é usada para separar alternativas; o mesmo é o operador menos vinculativo nesta notação. Uma estrela (@code{*}) significa zero ou mais repetições do item anterior; da mesma forma, o sinal de adição (@code{+}) significa uma ou mais repetições, e uma frase entre colchetes (@code{[ ]}) significa zero ou uma ocorrência (em outras palavras, a frase anexada é opcional). Os operadores @code{*} e @code{+} se ligam tão forte quanto possível; parêntesis são usados para o agrupamento. Os literais Strings são delimitados por aspas. O espaço em branco só é significativo para separar os tokens. As regras normalmente estão contidas numa única linha; as regras com muitas alternativas podem ser formatadas alternativamente com cada linha após o primeiro começo com uma barra vertical.

@geindex léxicas@comma{} definições
@geindex ASCII

Nas definições léxicas (como o exemplo acima), são utilizadas mais duas convenções: dois caracteres literais separados por três pontos significam a escolha de qualquer caractere único na faixa (inclusiva) fornecida pelos caracteres ASCII. Uma frase entre colchetes angulares (@code{<...>}) fornece uma descrição informal do símbolo definido; por exemplo, isso poderia ser usado para descrever a notação de ‘caractere de controle’, caso fosse necessário.

Embora a notação utilizada seja quase a mesma, há uma grande diferença entre o significado das definições lexicais e sintáticas: uma definição lexical opera nos caracteres individuais da fonte de entrada, enquanto uma definição de sintaxe opera no fluxo de tokens gerados pelo analisador léxico. Todos os usos do BNF no próximo capítulo (“Lexical Analysis”) são definições léxicas; os usos nos capítulos subsequentes são definições sintáticas.

@node Análise léxica,Modelo de dados,Introdução<5>,A Referência da Linguagem Python
@anchor{reference/lexical_analysis doc}@anchor{2006}@anchor{reference/lexical_analysis lexical}@anchor{2007}@anchor{reference/lexical_analysis lexical-analysis}@anchor{2008}@anchor{reference/lexical_analysis translation-repo}@anchor{2009}
@section Análise léxica


@geindex análise léxica
@geindex analisador sintático
@geindex token

Um programa Python é lido por um `analisador'. A entrada para o analisador é um fluxo de @ref{200a,,tokens}, gerados pelo `analisador léxico' (também conhecido como `tokenizador'). Este capítulo descreve como o analisador léxico divide um arquivo em tokens.

Python lê o texto do programa como pontos de código Unicode; a codificação de um arquivo de origem pode ser fornecida por uma declaração de codificação que por padrão é UTF-8, consulte 
@geindex Propostas de Melhorias do Python; PEP 3120
PEP 3120@footnote{https://peps.python.org/pep-3120/} para obter detalhes. Se o arquivo de origem não puder ser decodificado, uma exceção @ref{18d,,SyntaxError} será levantada.

@menu
* Estrutura das linhas:: 
* Outros tokens:: 
* Identificadores e palavras-chave:: 
* Literais:: 
* Operadores:: 
* Delimitadores:: 

@end menu

@node Estrutura das linhas,Outros tokens,,Análise léxica
@anchor{reference/lexical_analysis id1}@anchor{200b}@anchor{reference/lexical_analysis line-structure}@anchor{200c}
@subsection Estrutura das linhas


@geindex estrutura da linha

Um programa Python é dividido em uma série de `linhas lógicas'.

@menu
* Linhas lógicas:: 
* Linhas físicas:: 
* Comentários:: 
* Declarações de codificação:: 
* Junção de linha explícita:: 
* Junção de linha implícita:: 
* Linhas em branco:: 
* Indentação:: 
* Espaços em branco entre tokens:: 

@end menu

@node Linhas lógicas,Linhas físicas,,Estrutura das linhas
@anchor{reference/lexical_analysis id2}@anchor{200d}@anchor{reference/lexical_analysis logical-lines}@anchor{200e}
@subsubsection Linhas lógicas


@geindex linha lógica
@geindex linha física
@geindex junção de linha
@geindex token NEWLINE

O fim de uma linha lógica é representado pelo token NEWLINE. As declarações não podem cruzar os limites da linha lógica, exceto onde NEWLINE for permitido pela sintaxe (por exemplo, entre as declarações de declarações compostas). Uma linha lógica é construída a partir de uma ou mais `linhas físicas' seguindo as regras explícitas ou implícitas que `juntam as linhas'.

@node Linhas físicas,Comentários,Linhas lógicas,Estrutura das linhas
@anchor{reference/lexical_analysis id3}@anchor{200f}@anchor{reference/lexical_analysis physical-lines}@anchor{2010}
@subsubsection Linhas físicas


Uma linha física é uma sequência de caracteres terminada por uma sequência de fim de linha. Nos arquivos de origem e cadeias de caracteres, qualquer uma das sequências de terminação de linha de plataforma padrão pode ser usada - o formato Unix usando ASCII LF (linefeed), o formato Windows usando a sequência ASCII CR LF (return seguido de linefeed) ou o antigo formato Macintosh usando o caractere ASCII CR (return). Todos esses formatos podem ser usados igualmente, independentemente da plataforma. O final da entrada também serve como um finalizador implícito para a linha física final.

Ao incorporar o Python, strings de código-fonte devem ser passadas para APIs do Python usando as convenções C padrão para caracteres de nova linha (o caractere @code{\n}, representando ASCII LF, será o terminador de linha).

@node Comentários,Declarações de codificação,Linhas físicas,Estrutura das linhas
@anchor{reference/lexical_analysis comments}@anchor{2011}@anchor{reference/lexical_analysis id4}@anchor{2012}
@subsubsection Comentários


@geindex comentário
@geindex caractere cerquilha
@geindex # (cerquilha);comentário

Um  comentário inicia com um caracter cerquilha (@code{#}) que não é parte de uma string literal, e termina com o fim da linha física.  Um comentário significa o fim da linha lógica a menos que regras de junção de linha implicitas sejam invocadas. Comentários são ignorados pela sintaxe.

@node Declarações de codificação,Junção de linha explícita,Comentários,Estrutura das linhas
@anchor{reference/lexical_analysis encoding-declarations}@anchor{2013}@anchor{reference/lexical_analysis encodings}@anchor{2014}
@subsubsection Declarações de codificação


@geindex conjunto de caracteres do código-fonte
@geindex declaração de codificação (arquivo fonte)
@geindex # (cerquilha);declaração de codificação de código-fonte

Se um comentário na primeira ou segunda linha de um script Python corresponde com a expressão regular  @code{coding[=:]\s*([-\w.]+)}, esse comentário é processado com uma declaração de codificação; o primeiro grupo dessa expressão indica a codificação do arquivo do código-fonte. A declaração de codificação deve aparecer em uma linha exclusiva para tal. Se está na segunda linha, a primeira linha também deve ser uma linha somente com comentário. As formas recomendadas de uma declaração de codificação são:

@example
# -*- coding: <nome-codificação> -*-
@end example

que é reconhecido também por GNU Emacs, e

@example
# vim:fileencoding=<nome-codificação>
@end example

que é reconhecido pelo VIM de Bram Moolenaar.

Se nenhuma codificação é declarada, a codificação padrão é UTF-8. Se a codificação implícita ou explícita de um arquivo é UTF-8,  uma marca inicial de ordem de byte UTF-8 (@code{b'\xef\xbb\xbf'}) será ignorada em vez de ser um erro de sintaxe.

Se uma codificação é declarada, o nome da codificação deve ser reconhecida pelo Python (veja @ref{de1,,Standard Encodings}). A codificação é usada por toda análise léxica, incluindo literais strings, comment and identificadores.

@node Junção de linha explícita,Junção de linha implícita,Declarações de codificação,Estrutura das linhas
@anchor{reference/lexical_analysis explicit-joining}@anchor{2015}@anchor{reference/lexical_analysis explicit-line-joining}@anchor{2016}
@subsubsection Junção de linha explícita


@geindex linha física
@geindex junção de linha
@geindex continuação de linha
@geindex caractere contrabarra

Duas ou mais linhas físicas podem ser juntadas em linhas lógicas usando o caractere contrabarra  (@code{\}) da seguinte forma: quando uma linha física termina com uma contrabarra que não é parte da uma literal string ou comentário, ela é juntada com a linha seguinte formando uma única linha lógica, removendo a contrabarra e o caractere de fim de linha seguinte. Por exemplo:

@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:   # Parece ser uma data válida
        return 1
@end example

Uma linha terminada em uma contrabarra não pode conter um comentário.  Uma barra invertida não continua um comentário.  Uma contrabarra não continua um token, exceto para strings literais (ou seja, tokens diferentes de strings literais não podem ser divididos em linhas físicas usando uma contrabarra).  Uma contrabarra é ilegal em qualquer outro lugar em uma linha fora de uma string literal.

@node Junção de linha implícita,Linhas em branco,Junção de linha explícita,Estrutura das linhas
@anchor{reference/lexical_analysis implicit-joining}@anchor{2017}@anchor{reference/lexical_analysis implicit-line-joining}@anchor{2018}
@subsubsection Junção de linha implícita


Expressões entre parênteses, colchetes ou chaves podem ser quebradas em mais de uma linha física sem a necessidade do uso de contrabarras. Por exemplo:

@example
month_names = ['Januari', 'Februari', 'Maart',      # Estes são os
               'April',   'Mei',      'Juni',       # nomes holandeses
               'Juli',    'Augustus', 'September',  # para os meses
               'Oktober', 'November', 'December']   # do ano
@end example

Linhas continuadas implicitamente podem conter comentários. O recuo das linhas de continuação não é importante. Linhas de continuação em branco são permitidas. Não há token NEWLINE entre linhas de continuação implícitas. Linhas continuadas implicitamente também podem ocorrer dentro de strings com aspas triplas (veja abaixo); nesse caso, eles não podem conter comentários.

@node Linhas em branco,Indentação,Junção de linha implícita,Estrutura das linhas
@anchor{reference/lexical_analysis blank-lines}@anchor{2019}@anchor{reference/lexical_analysis id5}@anchor{201a}
@subsubsection Linhas em branco


@geindex linha em branco

Uma linha lógica que contém apenas espaços, tabulações, quebras de página e possivelmente um comentário é ignorada (ou seja, nenhum token NEWLINE é gerado). Durante a entrada interativa de instruções, o tratamento de uma linha em branco pode diferir dependendo da implementação do interpretador. No interpretador interativo padrão, uma linha lógica totalmente em branco (ou seja, uma que não contenha nem mesmo espaço em branco ou um comentário) encerra uma instrução de várias linhas.

@node Indentação,Espaços em branco entre tokens,Linhas em branco,Estrutura das linhas
@anchor{reference/lexical_analysis id6}@anchor{201b}@anchor{reference/lexical_analysis indentation}@anchor{201c}
@subsubsection Indentação


@geindex indentação
@geindex espaço em branco inicial
@geindex espaço
@geindex tabulação
@geindex agrupamento
@geindex agrupamento de instruções

O espaço em branco (espaços e tabulações) no início de uma linha lógica é usado para calcular o nível de indentação da linha, que por sua vez é usado para determinar o agrupamento de instruções.

As tabulações são substituídas (da esquerda para a direita) por um a oito espaços, de modo que o número total de caracteres até e incluindo a substituição seja um múltiplo de oito (essa é intencionalmente a mesma regra usada pelo Unix). O número total de espaços que precedem o primeiro caractere não em branco determina o recuo da linha. O recuo não pode ser dividido em várias linhas físicas usando contrabarra; o espaço em branco até a primeira contrabarra determina a indentação.

A indentação é rejeitada como inconsistente se um arquivo de origem mistura tabulações e espaços de uma forma que torna o significado dependente do valor de uma tabulação em espaços; uma exceção @ref{543,,TabError} é levantada nesse caso.

`Nota de compatibilidade entre plataformas:' devido à natureza dos editores de texto em plataformas não-UNIX, não é aconselhável usar uma mistura de espaços e tabulações para o recuo em um único arquivo de origem. Deve-se notar também que diferentes plataformas podem limitar explicitamente o nível máximo de indentação.

Um caractere de quebra de página pode estar presente no início da linha; ele será ignorado para os cálculos de indentação acima. Os caracteres de quebra de página que ocorrem em outro lugar além do espaço em branco inicial têm um efeito indefinido (por exemplo, eles podem redefinir a contagem de espaços para zero).

@geindex token INDENT
@geindex token DEDENT

Os níveis de indentação das linhas consecutivas são usados para gerar tokens INDENT e DEDENT, usando uma pilha, como segue.

Antes da leitura da primeira linha do arquivo, um único zero é colocado na pilha; isso nunca mais será exibido. Os números colocados na pilha sempre aumentarão estritamente de baixo para cima. No início de cada linha lógica, o nível de indentação da linha é comparado ao topo da pilha. Se for igual, nada acontece. Se for maior, ele é colocado na pilha e um token INDENT é gerado. Se for menor, `deve' ser um dos números que aparecem na pilha; todos os números maiores na pilha são retirados e, para cada número retirado, um token DEDENT é gerado. Ao final do arquivo, um token DEDENT é gerado para cada número restante na pilha que seja maior que zero.

Aqui está um exemplo de um trecho de código Python indentado corretamente (embora confuso):

@example
def perm(l):
        # Calcula a lista de todas as permutações de 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

O exemplo a seguir mostra vários erros de indentação:

@example
 def perm(l):                       # erro: primeira linha indentada
for i in range(len(l)):             # erro: não indentada
    s = l[:i] + l[i+1:]
        p = perm(l[:i] + l[i+1:])   # erro: indentação inesperada
        for x in p:
                r.append(l[i:i+1] + x)
            return r                # erro: desindentação inconsistente
@end example

(Na verdade, os três primeiros erros são detectados pelo analisador sintático; apenas o último erro é encontrado pelo analisador léxico — o recuo de não corresponde a um nível retirado da pilha.)

@node Espaços em branco entre tokens,,Indentação,Estrutura das linhas
@anchor{reference/lexical_analysis whitespace}@anchor{201d}@anchor{reference/lexical_analysis whitespace-between-tokens}@anchor{201e}
@subsubsection Espaços em branco entre tokens


Exceto no início de uma linha lógica ou em string literais, os caracteres de espaço em branco (espaço, tabulação e quebra de página) podem ser usados alternadamente para separar tokens. O espaço em branco é necessário entre dois tokens somente se sua concatenação puder ser interpretada como um token diferente (por exemplo, ab é um token, mas a b são dois tokens).

@node Outros tokens,Identificadores e palavras-chave,Estrutura das linhas,Análise léxica
@anchor{reference/lexical_analysis id7}@anchor{201f}@anchor{reference/lexical_analysis other-tokens}@anchor{2020}
@subsection Outros tokens


Além de NEWLINE, INDENT e DEDENT, existem as seguintes categorias de tokens: `identificadores', `palavras-chave', `literais', `operadores' e `delimitadores'. Caracteres de espaço em branco (exceto terminadores de linha, discutidos anteriormente) não são tokens, mas servem para delimitar tokens. Onde existe ambiguidade, um token compreende a string mais longa possível que forma um token legal, quando lido da esquerda para a direita.

@node Identificadores e palavras-chave,Literais,Outros tokens,Análise léxica
@anchor{reference/lexical_analysis identifiers}@anchor{2021}@anchor{reference/lexical_analysis identifiers-and-keywords}@anchor{2022}
@subsection Identificadores e palavras-chave


@geindex identificador
@geindex nome

Identificadores (também chamados de `nomes') são descritos pelas seguintes definições lexicais.

A sintaxe dos identificadores em Python é baseada no anexo do padrão Unicode UAX-31, com elaboração e alterações conforme definido abaixo; veja também 
@geindex Propostas de Melhorias do Python; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/} para mais detalhes.

Dentro do intervalo ASCII (U+0001..U+007F), os caracteres válidos para identificadores incluem as letras maiúsculas e minúsculas @code{A} a @code{Z}, o sublinhado @code{_} e, exceto pelo primeiro caractere, os dígitos @code{0} a @code{9}. O Python 3.0 introduziu caracteres adicionais de fora do intervalo ASCII (veja 
@geindex Propostas de Melhorias do Python; PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}). Para esses caracteres, a classificação usa a versão do Unicode Character Database conforme incluído no módulo @ref{105,,unicodedata}.

Os identificadores têm comprimento ilimitado. Maiúsculas são diferentes de minúsculas.

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-identifier}@anchor{2023}identifier   ::= @ref{2024,,xid_start} @ref{2025,,xid_continue}*
@anchor{reference/lexical_analysis grammar-token-python-grammar-id_start}@anchor{2026}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{2027}id_continue  ::= <all characters in @ref{2026,,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{2024}xid_start    ::= <all characters in @ref{2026,,id_start} whose NFKC normalization is in "id_start xid_continue*">
@anchor{reference/lexical_analysis grammar-token-python-grammar-xid_continue}@anchor{2025}xid_continue ::= <all characters in @ref{2027,,id_continue} whose NFKC normalization is in "id_continue*">
@end example

Os códigos de categoria Unicode mencionados acima significam:


@itemize *

@item 
`Lu' - letras maiúsculas

@item 
`Ll' - letras minúsculas

@item 
`Lt' - letras em titlecase

@item 
`Lm' - letras modificadoras

@item 
`Lo' - outras letras

@item 
`Nl' - letras numéricas

@item 
`Mn' - marcas sem espaçamento

@item 
`Mc' - marcas de combinação de espaçamento

@item 
`Nd' - números decimais

@item 
`Pc' - pontuações de conectores

@item 
`Other_ID_Start' - lista explícita de caracteres em PropList.txt@footnote{https://www.unicode.org/Public/15.1.0/ucd/PropList.txt} para oferecer suporte à compatibilidade com versões anteriores

@item 
`Other_ID_Continue' - igualmente
@end itemize

Todos os identificadores são convertidos no formato normal NFKC durante a análise; a comparação de identificadores é baseada no NFKC.

Um arquivo HTML não normativo listando todos os caracteres identificadores válidos para Unicode 15.1.0 pode ser encontrado em @indicateurl{https://www.unicode.org/Public/15.1.0/ucd/DerivedCoreProperties.txt}

@menu
* Palavras reservadas:: 
* Palavras reservadas contextuais:: 
* Classes reservadas de identificadores:: 

@end menu

@node Palavras reservadas,Palavras reservadas contextuais,,Identificadores e palavras-chave
@anchor{reference/lexical_analysis id8}@anchor{2028}@anchor{reference/lexical_analysis keywords}@anchor{2029}
@subsubsection Palavras reservadas


@geindex palavra reservada
@geindex palavra reservada

Os seguintes identificadores são usados como palavras reservadas, ou `palavras-chave' da linguagem, e não podem ser usados como identificadores comuns. Eles devem ser escritos exatamente como estão escritos aqui:

@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 Palavras reservadas contextuais,Classes reservadas de identificadores,Palavras reservadas,Identificadores e palavras-chave
@anchor{reference/lexical_analysis id9}@anchor{202a}@anchor{reference/lexical_analysis soft-keywords}@anchor{80f}
@subsubsection Palavras reservadas contextuais


@geindex palavra reservada contextual
@geindex palavra reservada


Adicionado na versão 3.10.


Alguns identificadores são reservados apenas em contextos específicos. Elas são conhecidas como `palavras reservadas contextuais'. Os identificadores @code{match}, @code{case}, @code{type} e @code{_} podem atuar sintaticamente como palavras reservadas em determinados contextos, mas essa distinção é feita no nível do analisador sintático, não durante a tokenização.

Como palavras reservadas contextuais, seu uso na gramática é possível preservando a compatibilidade com o código existente que usa esses nomes como identificadores.

@code{match}, @code{case} e @code{_} são usadas na instrução @ref{810,,match}, @code{type} é usado na instrução @ref{438,,type}.


Alterado na versão 3.12: @code{type} é agora uma palavra reservada contextual.


@geindex _@comma{} identificadores
@geindex __@comma{} identificadores

@node Classes reservadas de identificadores,,Palavras reservadas contextuais,Identificadores e palavras-chave
@anchor{reference/lexical_analysis id-classes}@anchor{202b}@anchor{reference/lexical_analysis reserved-classes-of-identifiers}@anchor{202c}
@subsubsection Classes reservadas de identificadores


Certas classes de identificadores (além de palavras reservadas) possuem significados especiais. Essas classes são identificadas pelos padrões de caracteres de sublinhado iniciais e finais:


@table @asis

@item @code{_*}

Não importado por @code{from module import *}.

@item @code{_}

Em um padrão @code{case} de uma instrução @ref{810,,match}, @code{_} é uma @ref{80f,,palavra reservada contextual} que denota um @ref{811,,curinga}.

Isoladamente, o interpretador interativo disponibiliza o resultado da última avaliação na variável @code{_}. (Ele é armazenado no módulo @ref{12,,builtins}, juntamente com funções embutidas como @code{print}.)

Em outros lugares, @code{_} é um identificador comum. Muitas vezes é usado para nomear itens “especiais”, mas não é especial para o Python em si.

@cartouche
@quotation Nota 
O nome @code{_} é frequentemente usado em conjunto com internacionalização; consulte a documentação do módulo @ref{63,,gettext} para obter mais informações sobre esta convenção.

Também é comumente usado para variáveis não utilizadas.
@end quotation
@end cartouche

@item @code{__*__}

Nomes definidos pelo sistema, informalmente conhecidos como nomes “dunder”. Esses nomes e suas implementações são definidos pelo interpretador (incluindo a biblioteca padrão). Os nomes de sistema atuais são discutidos na seção @ref{c89,,Nomes de métodos especiais} e em outros lugares. Provavelmente mais nomes serão definidos em versões futuras do Python. `Qualquer' uso de nomes @code{__*__}, em qualquer contexto, que não siga o uso explicitamente documentado, está sujeito a quebra sem aviso prévio.

@item @code{__*}

Nomes de classes privadas. Os nomes nesta categoria, quando usados no contexto de uma definição de classe, são reescritos para usar uma forma desfigurada para ajudar a evitar conflitos de nomes entre atributos “privados” de classes base e derivadas. Consulte a seção @ref{202d,,Identificadores (Nomes)}.
@end table

@node Literais,Operadores,Identificadores e palavras-chave,Análise léxica
@anchor{reference/lexical_analysis id10}@anchor{202e}@anchor{reference/lexical_analysis literals}@anchor{202f}
@subsection Literais


@geindex literal
@geindex constante

Literais são notações para valores constantes de alguns tipos embutidos.

@geindex literal de string
@geindex literal de bytes
@geindex ASCII
@geindex ' (aspas simples);literal de string
@geindex " (aspas duplas);literal de string
@geindex u';literal de string
@geindex u";literal de string

@menu
* Literais de string e bytes:: 
* Concatenação de literal de string:: 
* f-strings:: 
* Literais numéricos:: 
* Inteiros literais:: 
* Literais de ponto flutuante:: 
* Literais imaginários:: 

@end menu

@node Literais de string e bytes,Concatenação de literal de string,,Literais
@anchor{reference/lexical_analysis string-and-bytes-literals}@anchor{2030}@anchor{reference/lexical_analysis strings}@anchor{2031}
@subsubsection Literais de string e bytes


Literais de string são descritos pelas seguintes definições lexicais:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringliteral}@anchor{2032}stringliteral   ::= [@ref{2033,,stringprefix}](@ref{2034,,shortstring} | @ref{2035,,longstring})
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringprefix}@anchor{2033}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{2034}shortstring     ::= "'" @ref{2036,,shortstringitem}* "'" | '"' @ref{2036,,shortstringitem}* '"'
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstring}@anchor{2035}longstring      ::= "'@w{'}'" @ref{2037,,longstringitem}* "'@w{'}'" | '"""' @ref{2037,,longstringitem}* '"""'
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortstringitem}@anchor{2036}shortstringitem ::= @ref{2038,,shortstringchar} | @ref{2039,,stringescapeseq}
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstringitem}@anchor{2037}longstringitem  ::= @ref{203a,,longstringchar} | @ref{2039,,stringescapeseq}
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortstringchar}@anchor{2038}shortstringchar ::= <any source character except "\" or newline or the quote>
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstringchar}@anchor{203a}longstringchar  ::= <any source character except "\">
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringescapeseq}@anchor{2039}stringescapeseq ::= "\" <any source character>
@end example

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesliteral}@anchor{203b}bytesliteral   ::= @ref{203c,,bytesprefix}(@ref{203d,,shortbytes} | @ref{203e,,longbytes})
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesprefix}@anchor{203c}bytesprefix    ::= "b" | "B" | "br" | "Br" | "bR" | "BR" | "rb" | "rB" | "Rb" | "RB"
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbytes}@anchor{203d}shortbytes     ::= "'" @ref{203f,,shortbytesitem}* "'" | '"' @ref{203f,,shortbytesitem}* '"'
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbytes}@anchor{203e}longbytes      ::= "'@w{'}'" @ref{2040,,longbytesitem}* "'@w{'}'" | '"""' @ref{2040,,longbytesitem}* '"""'
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbytesitem}@anchor{203f}shortbytesitem ::= @ref{2041,,shortbyteschar} | @ref{2042,,bytesescapeseq}
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbytesitem}@anchor{2040}longbytesitem  ::= @ref{2043,,longbyteschar} | @ref{2042,,bytesescapeseq}
@anchor{reference/lexical_analysis grammar-token-python-grammar-shortbyteschar}@anchor{2041}shortbyteschar ::= <any ASCII character except "\" or newline or the quote>
@anchor{reference/lexical_analysis grammar-token-python-grammar-longbyteschar}@anchor{2043}longbyteschar  ::= <any ASCII character except "\">
@anchor{reference/lexical_analysis grammar-token-python-grammar-bytesescapeseq}@anchor{2042}bytesescapeseq ::= "\" <any ASCII character>
@end example

Uma restrição sintática não indicada por essas produções é que não são permitidos espaços em branco entre o @ref{2033,,stringprefix} ou @ref{203c,,bytesprefix} e o restante do literal. O conjunto de caracteres de origem é definido pela declaração de codificação; é UTF-8 se nenhuma declaração de codificação for fornecida no arquivo de origem; veja a seção @ref{2014,,Declarações de codificação}.

@geindex aspas triplas
@geindex Consórcio Unicode
@geindex string bruta
@geindex """;literal de string
@geindex '@w{'}';literal de string

Em inglês simples: ambos os tipos de literais podem ser colocados entre aspas simples (@code{'}) ou aspas duplas (@code{"}). Eles também podem ser colocados em grupos correspondentes de três aspas simples ou duplas (geralmente chamadas de `strings com aspas triplas'). O caractere de contrabarra (@code{\}) é usado para dar um significado especial a caracteres comuns como , que significa ‘nova linha’ quando escapado (@code{\n}). Também pode ser usado para caracteres de escape que, de outra forma, teriam um significado especial, como nova linha, contrabarra ou o caractere de aspas. Veja @ref{45a,,sequências de escape} abaixo para exemplos.

@geindex b';literal de bytes
@geindex b";literal de bytes

Literais de bytes são sempre prefixados com @code{'b'} ou @code{'B'}; eles produzem uma instância do tipo @ref{1c2,,bytes} em vez do tipo @ref{44c,,str}. Eles só podem conter caracteres ASCII; bytes com valor numérico igual ou superior a 128 devem ser expressos com escapes.

@geindex r';literal de string bruta
@geindex r";literal de string bruta

Literais de string e bytes podem opcionalmente ser prefixados com uma letra @code{'r'} ou @code{'R'}; tais construções são chamadas de `literais de strings brutas' e `literais de bytes brutos' tratam as contrabarras como caracteres literais. Como resultado, em literais de string, os escapes @code{'\U'} e @code{'\u'} em strings brutas não são tratados de maneira especial.


Adicionado na versão 3.3: O prefixo @code{'rb'} de literais de bytes brutos foi adicionado como sinônimo de @code{'br'}.

O suporte para o literal legado unicode (@code{u'value'}) foi reintroduzido para simplificar a manutenção de bases de código duplas Python 2.x e 3.x. Consulte 
@geindex Propostas de Melhorias do Python; PEP 414
PEP 414@footnote{https://peps.python.org/pep-0414/} para obter mais informações.


@geindex f';literal de string formatado
@geindex f";literal de string formatado

Uma string literal com @code{'f'} ou @code{'F'} em seu prefixo é uma string literal formatada; veja @ref{9b1,,f-strings}. O @code{'f'} pode ser combinado com @code{'r'}, mas não com @code{'b'} ou @code{'u'}, portanto strings formatadas brutas são possíveis, mas literais de bytes formatados não são.

Em literais com aspas triplas, novas linhas e aspas sem escape são permitidas (e são retidas), exceto que três aspas sem escape em uma linha encerram o literal. (Uma “aspas” é o caractere usado para abrir o literal, ou seja, @code{'} ou @code{"}.)

@geindex linha física
@geindex sequência de escape
@geindex Standard C
@geindex C
@geindex \ (contrabarra);sequência de escape
@geindex \\;sequência de escape
@geindex \a;sequência de escape
@geindex \b;sequência de escape
@geindex \f;sequência de escape
@geindex \n;sequência de escape
@geindex \r;sequência de escape
@geindex \t;sequência de escape
@geindex \v;sequência de escape
@geindex \x;sequência de escape
@geindex \N;sequência de escape
@geindex \u;sequência de escape
@geindex \U;sequência de escape

@menu
* Sequências de escape:: 

@end menu

@node Sequências de escape,,,Literais de string e bytes
@anchor{reference/lexical_analysis escape-sequences}@anchor{45a}@anchor{reference/lexical_analysis id11}@anchor{2044}
@subsubsection Sequências de escape


A menos que um prefixo @code{'r'} ou @code{'R'} esteja presente, as sequências de escape em literais de string e bytes são interpretadas de acordo com regras semelhantes àquelas usadas pelo Standard C. As sequências de escape reconhecidas são:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Sequência de escape

@tab

Significado

@tab

Notas

@item

@code{\}<newline>

@tab

A barra invertida e a nova linha foram ignoradas

@tab

(1)

@item

@code{\\}

@tab

Contrabarra (@code{\})

@tab

@item

@code{\'}

@tab

Aspas simples (@code{'})

@tab

@item

@code{\"}

@tab

Aspas duplas (@code{"})

@tab

@item

@code{\a}

@tab

ASCII Bell (BEL) - um sinal audível é emitido

@tab

@item

@code{\b}

@tab

ASCII Backspace (BS) - apaga caractere à esquerda

@tab

@item

@code{\f}

@tab

ASCII Formfeed (FF) - quebra de página

@tab

@item

@code{\n}

@tab

ASCII Linefeed (LF) - quebra de linha

@tab

@item

@code{\r}

@tab

ASCII Carriage Return (CR) - retorno de carro

@tab

@item

@code{\t}

@tab

ASCII Horizontal Tab (TAB) - tabulação horizontal

@tab

@item

@code{\v}

@tab

ASCII Vertical Tab (VT) - tabulação vertical

@tab

@item

@code{\@var{ooo}}

@tab

Caractere com valor octal `ooo'

@tab

(2,4)

@item

@code{\x@var{hh}}

@tab

Caractere com valor hexadecimal `hh'

@tab

(3,4)

@end multitable


As sequências de escape apenas reconhecidas em literais de strings são:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Sequência de escape

@tab

Significado

@tab

Notas

@item

@code{\N@{@var{name}@}}

@tab

Caractere chamado `name' no banco de dados Unicode

@tab

(5)

@item

@code{\u@var{xxxx}}

@tab

Caractere com valor hexadecimal de 16 bits `xxxx'

@tab

(6)

@item

@code{\U@var{xxxxxxxx}}

@tab

Caractere com valor hexadecimal de 32 bits `xxxxxxxx'

@tab

(7)

@end multitable


Notas:


@enumerate 

@item 
Uma contrabarra pode ser adicionada ao fim da linha para ignorar a nova linha:

@example
>>> 'Esta string não vai incluir \
... contrabarras e caracteres de nova linha.'
'Esta string não vai incluir contrabarras e caracteres de nova linha.'
@end example

O mesmo resultado pode ser obtido usando @ref{2031,,strings com aspas triplas}, ou parênteses e @ref{2045,,concatenação de literal string}.

@item 
Como no padrão C, são aceitos até três dígitos octais.


Alterado na versão 3.11: Escapes octais com valor maior que @code{0o377} produz uma @ref{1a5,,DeprecationWarning}.



Alterado na versão 3.12: Escapes octais com valor maior que @code{0o377} produzem um @ref{466,,SyntaxWarning}. Em uma versão futura do Python eles serão eventualmente um @ref{18d,,SyntaxError}.


@item 
Ao contrário do padrão C, são necessários exatamente dois dígitos hexadecimais.

@item 
Em um literal de bytes, os escapes hexadecimais e octais denotam o byte com o valor fornecido. Em uma literal de string, esses escapes denotam um caractere Unicode com o valor fornecido.

@item 

Alterado na versão 3.3: O suporte para apelidos de nome @footnote{
@indicateurl{https://www.unicode.org/Public/15.1.0/ucd/NameAliases.txt}
} foi adicionado.


@item 
São necessários exatos quatro dígitos hexadecimais.

@item 
Qualquer caractere Unicode pode ser codificado desta forma. São necessários exatamente oito dígitos hexadecimais.
@end enumerate

@geindex sequência de escape não reconhecida

Ao contrário do padrão C, todas as sequências de escape não reconhecidas são deixadas inalteradas na string, ou seja, `a contrabarra é deixada no resultado'. (Esse comportamento é útil durante a depuração: se uma sequência de escape for digitada incorretamente, a saída resultante será mais facilmente reconhecida como quebrada.) Também é importante observar que as sequências de escape reconhecidas apenas em literais de string se enquadram na categoria de escapes não reconhecidos para literais de bytes.


Alterado na versão 3.6: Sequências de escape não reconhecidas produzem um @ref{1a5,,DeprecationWarning}.



Alterado na versão 3.12: Sequências de escape não reconhecidas produzem um @ref{466,,SyntaxWarning}. Em uma versão futura do Python eles serão eventualmente um @ref{18d,,SyntaxError}.


Mesmo em um literal bruto, as aspas podem ser escapadas com uma contrabarra, mas a barra invertida permanece no resultado; por exemplo, @code{r"\""} é uma literal de string válida que consiste em dois caracteres: uma contrabarra e aspas duplas; @code{r"\"} não é uma literal de string válida (mesmo uma string bruta não pode terminar em um número ímpar de contrabarras). Especificamente, `um literal bruto não pode terminar em uma única contrabarra' (já que a contrabarra escaparia do seguinte caractere de aspas). Observe também que uma única contrabarra seguida por uma nova linha é interpretada como esses dois caracteres como parte do literal, `não' como uma continuação de linha.

@node Concatenação de literal de string,f-strings,Literais de string e bytes,Literais
@anchor{reference/lexical_analysis string-concatenation}@anchor{2045}@anchor{reference/lexical_analysis string-literal-concatenation}@anchor{2046}
@subsubsection Concatenação de literal de string


São permitidos vários literais de strings ou bytes adjacentes (delimitados por espaços em branco), possivelmente usando diferentes convenções de delimitação de strings, e seu significado é o mesmo de sua concatenação. Assim, @code{"hello" 'world'} é equivalente a @code{"helloworld"}. Este recurso pode ser usado para reduzir o número de barras invertidas necessárias, para dividir strings longas convenientemente em linhas longas ou até mesmo para adicionar comentários a partes de strings, por exemplo:

@example
re.compile("[A-Za-z_]"       # letra ou sublinhado
           "[A-Za-z0-9_]*"   # letra, dígito ou sublinhado
          )
@end example

Observe que esse recurso é definido no nível sintático, mas implementado em tempo de compilação. O operador ‘+’ deve ser usado para concatenar expressões de string em tempo de execução. Observe também que a concatenação literal pode usar diferentes estilos de delimitação de strings para cada componente (mesmo misturando strings brutas e strings com aspas triplas), e literais de string formatados podem ser concatenados com literais de string simples.

@geindex literal de string formatado
@geindex literal de string interpolada
@geindex string;literal formatado
@geindex string;literal interpolado
@geindex f-string
@geindex fstring
@geindex @{@} (chaves);em literal de string formatado
@geindex ! (exclamação);em literal de string formatado
@geindex ; (dois pontos);em literal de string formatado
@geindex = (igual);para ajudar na depuração usando literais de string
@anchor{reference/lexical_analysis f-strings}@anchor{9b1}
@node f-strings,Literais numéricos,Concatenação de literal de string,Literais
@anchor{reference/lexical_analysis formatted-string-literals}@anchor{2047}@anchor{reference/lexical_analysis id13}@anchor{2048}
@subsubsection f-strings



Adicionado na versão 3.6.


Um `literal de string formatado' ou `f-string'  é uma literal de string prefixado com @code{'f'} ou @code{'F'}. Essas strings podem conter campos de substituição, que são expressões delimitadas por chaves @code{@{@}}. Embora outros literais de string sempre tenham um valor constante, strings formatadas são, na verdade, expressões avaliadas em tempo de execução.

As sequências de escape são decodificadas como em literais de string comuns (exceto quando um literal também é marcado como uma string bruta). Após a decodificação, a gramática do conteúdo da string é:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_string}@anchor{2049}f_string          ::= (@ref{204a,,literal_char} | "@{@{" | "@}@}" | @ref{204b,,replacement_field})*
@anchor{reference/lexical_analysis grammar-token-python-grammar-replacement_field}@anchor{204b}replacement_field ::= "@{" @ref{204c,,f_expression} ["="] ["!" @ref{204d,,conversion}] [":" @ref{204e,,format_spec}] "@}"
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_expression}@anchor{204c}f_expression      ::= (@ref{204f,,conditional_expression} | "*" @ref{2050,,or_expr})
                      ("," @ref{204f,,conditional_expression} | "," "*" @ref{2050,,or_expr})* [","]
                      | @ref{2051,,yield_expression}
@anchor{reference/lexical_analysis grammar-token-python-grammar-conversion}@anchor{204d}conversion        ::= "s" | "r" | "a"
@anchor{reference/lexical_analysis grammar-token-python-grammar-format_spec}@anchor{204e}format_spec       ::= (@ref{204a,,literal_char} | @ref{204b,,replacement_field})*
@anchor{reference/lexical_analysis grammar-token-python-grammar-literal_char}@anchor{204a}literal_char      ::= <any code point except "@{", "@}" or NULL>
@end example

As partes da string fora das chaves são tratadas literalmente, exceto que quaisquer chaves duplas @code{'@{@{'} ou @code{'@}@}'} são substituídas pela chave única correspondente. Uma única chave de abertura @code{'@{'} marca um campo de substituição, que começa com uma expressão Python. Para exibir o texto da expressão e seu valor após a avaliação (útil na depuração), um sinal de igual @code{'='} pode ser adicionado após a expressão. Um campo de conversão, introduzido por um ponto de exclamação @code{'!'}, pode vir a seguir. Um especificador de formato também pode ser anexado, introduzido por dois pontos @code{':'}. Um campo de substituição termina com uma chave de fechamento @code{'@}'}.

Expressões em literais de strings formatadas são tratadas como expressões regulares do Python entre parênteses, com algumas exceções. Uma expressão vazia não é permitida e as expressões @ref{12df,,lambda} e de atribuição @code{:=} devem ser colocadas entre parênteses explícitos. Cada expressão é avaliada no contexto onde o literal de string formatada aparece, na ordem da esquerda para a direita. As expressões de substituição podem conter novas linhas em f-strings tanto entre aspas simples quanto em triplas e podem conter comentários. Tudo o que vem depois de um @code{#} dentro de um campo de substituição é um comentário (até mesmo chaves e aspas). Nesse caso, os campos de substituição deverão ser fechados em uma linha diferente.

@example
>>> f"abc@{a # Este é um comentário @}"
... + 3@}"
'abc5'
@end example


Alterado na versão 3.7: Antes do Python 3.7, uma expressão @ref{1b9,,await} e compreensões contendo uma cláusula @ref{aba,,async for}  eram ilegais nas expressões em literais de strings formatadas devido a um problema com a implementação.



Alterado na versão 3.12: Antes do Python 3.12, comentários não eram permitidos dentro de campos de substituição em f-strings.


Quando o sinal de igual @code{'='} for fornecido, a saída terá o texto da expressão, o @code{'='} e o valor avaliado. Os espaços após a chave de abertura @code{'@{'}, dentro da expressão e após @code{'='} são todos preservados na saída. Por padrão, @code{'='} faz com que @ref{800,,repr()} da expressão seja fornecida, a menos que haja um formato especificado. Quando um formato é especificado, o padrão é o @ref{44c,,str()} da expressão, a menos que uma conversão @code{'!r'} seja declarada.


Adicionado na versão 3.8: O sinal de igual @code{'='}.


Se uma conversão for especificada, o resultado da avaliação da expressão será convertido antes da formatação. A conversão @code{'!s'} chama @ref{44c,,str()} no resultado, @code{'!r'} chama @ref{800,,repr()} e @code{'!a'} chama @ref{142d,,ascii()}.

O resultado é então formatado usando o protocolo @ref{61f,,format()}. O especificador de formato é passado para o método @ref{61e,,__format__()} da expressão ou resultado da conversão. Uma string vazia é passada quando o especificador de formato é omitido. O resultado formatado é então incluído no valor final de toda a string.

Os especificadores de formato de nível superior podem incluir campos de substituição aninhados. Esses campos aninhados podem incluir seus próprios campos de conversão e  @ref{1e8,,especificadores de formato},  mas podem não incluir campos de substituição aninhados mais profundamente. A @ref{1e8,,minilinguagem do especificador de formato} é a mesma usada pelo método @ref{621,,str.format()}.

Literais de strings formatadas podem ser concatenados, mas os campos de substituição não podem ser divididos entre literais.

Alguns exemplos de literais de string formatada:

@example
>>> nome = "Fred"
>>> f"Ele falou que o nome dele é @{nome!r@}."
"Ele falou que o nome dele é 'Fred'."
>>> f"Ele falou que o nome dele é @{repr(nome)@}."  # repr() é um equivalente a !r
"Ele falou que o nome dele é 'Fred'."
>>> largura = 10
>>> precisão = 4
>>> valor = decimal.Decimal("12.34567")
>>> f"resultado: @{valor:@{largura@}.@{precisão@}@}"  # campos aninhados
'resultado: 12.35'
>>> hoje = datetime(year=2017, month=1, day=27)
>>> f"@{hoje:%B %d, %Y@}"  # usando especificador de formato de data
'January 27, 2017'
>>> f"@{hoje=:%B %d, %Y@}"  # usando especificador de formato de data e depuração
'hoje=January 27, 2017'
>>> número = 1024
>>> f"@{número:#0x@}"  # usando especificador de formato de número inteiro
'0x400'
>>> foo = "bar"
>>> f"@{ foo = @}"  # preserva espaço em branco
" foo = 'bar'"
>>> linha = "Olha a caixa d'água"
>>> f"@{linha = @}"
'linha = "Olha a caixa d\'água"'
>>> f"@{linha = :20@}"
"linha = Olha a caixa d'água "
>>> f"@{linha = !r:20@}"
'linha = "Olha a caixa d\'água"'
@end example

É permitido reutilizar o tipo de aspas externas da f-string dentro de um campo de substituição:

@example
>>> a = dict(x=2)
>>> f"abc @{a["x"]@} def"
'abc 2 def'
@end example


Alterado na versão 3.12: Antes do Python 3.12, a reutilização do mesmo tipo de aspas externas da f-string dentro de um campo de substituição não era possível.


Contrabarras também são permitidas em campos de substituição e são avaliadas da mesma forma que em qualquer outro contexto:

@example
>>> a = ["a", "b", "c"]
>>> print(f"A lista a contém:\n@{"\n".join(a)@}")
A lista a contém:
a
b
c
@end example


Alterado na versão 3.12: Antes do Python 3.12, contrabarras não eram permitidas dentro de um campo de substituição em uma f-string.


Literais de strings formatadas não podem ser usados como strings de documentação, mesmo que não incluam expressões.

@example
>>> def foo():
...     f"Não é uma docstring"
...
>>> foo.__doc__ is None
True
@end example

Consulte também 
@geindex Propostas de Melhorias do Python; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} para a proposta que adicionou literais de strings formatadas e @ref{621,,str.format()}, que usa um mecanismo de string de formato relacionado.

@node Literais numéricos,Inteiros literais,f-strings,Literais
@anchor{reference/lexical_analysis numbers}@anchor{2052}@anchor{reference/lexical_analysis numeric-literals}@anchor{2053}
@subsubsection Literais numéricos


@geindex número
@geindex literal numérico
@geindex literal de inteiro
@geindex literal de ponto flutuante
@geindex literal de hexadecimal
@geindex literal de octal
@geindex literal de binário
@geindex literal de decimal
@geindex literal de número imaginário
@geindex literal de número complexo

Existem três tipos de literais numéricos: inteiros, números de ponto flutuante e números imaginários. Não existem literais complexos (números complexos podem ser formados adicionando um número real e um número imaginário).

Observe que os literais numéricos não incluem um sinal; uma frase como @code{-1} é, na verdade, uma expressão composta pelo operador unário ‘@code{-2}’ e o literal @code{1}.

@geindex 0b;literal de inteiro
@geindex 0o;literal de inteiro
@geindex 0x;literal de inteiro
@geindex _ (sublinhado);em literal númerico

@node Inteiros literais,Literais de ponto flutuante,Literais numéricos,Literais
@anchor{reference/lexical_analysis integer-literals}@anchor{2054}@anchor{reference/lexical_analysis integers}@anchor{2055}
@subsubsection Inteiros literais


Literais inteiros são descritos pelas seguintes definições léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-integer}@anchor{2056}integer      ::= @ref{2057,,decinteger} | @ref{2058,,bininteger} | @ref{2059,,octinteger} | @ref{205a,,hexinteger}
@anchor{reference/lexical_analysis grammar-token-python-grammar-decinteger}@anchor{2057}decinteger   ::= @ref{205b,,nonzerodigit} (["_"] @ref{205c,,digit})* | "0"+ (["_"] "0")*
@anchor{reference/lexical_analysis grammar-token-python-grammar-bininteger}@anchor{2058}bininteger   ::= "0" ("b" | "B") (["_"] @ref{205d,,bindigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-octinteger}@anchor{2059}octinteger   ::= "0" ("o" | "O") (["_"] @ref{205e,,octdigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexinteger}@anchor{205a}hexinteger   ::= "0" ("x" | "X") (["_"] @ref{205f,,hexdigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-nonzerodigit}@anchor{205b}nonzerodigit ::= "1"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-digit}@anchor{205c}digit        ::= "0"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-bindigit}@anchor{205d}bindigit     ::= "0" | "1"
@anchor{reference/lexical_analysis grammar-token-python-grammar-octdigit}@anchor{205e}octdigit     ::= "0"..."7"
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexdigit}@anchor{205f}hexdigit     ::= @ref{205c,,digit} | "a"..."f" | "A"..."F"
@end example

Não há limite para o comprimento de literais inteiros além do que pode ser armazenado na memória disponível.

Os sublinhados são ignorados para determinar o valor numérico do literal. Eles podem ser usados para agrupar dígitos para maior legibilidade. Um sublinhado pode ocorrer entre dígitos e após especificadores de base como @code{0x}.

Observe que não são permitidos zeros à esquerda em um número decimal diferente de zero. Isto é para desambiguação com literais octais de estilo C, que o Python usava antes da versão 3.0.

Alguns exemplos de literais inteiros:

@example
7     2147483647                        0o177    0b100110111
3     79228162514264337593543950336     0o377    0xdeadbeef
      100_000_000_000                   0b_1110_0101
@end example


Alterado na versão 3.6: Os sublinhados agora são permitidos para fins de agrupamento de literais.


@geindex . (ponto);em literal númerico
@geindex e;em literal númerico
@geindex _ (sublinhado);em literal númerico

@node Literais de ponto flutuante,Literais imaginários,Inteiros literais,Literais
@anchor{reference/lexical_analysis floating}@anchor{2060}@anchor{reference/lexical_analysis floating-point-literals}@anchor{2061}
@subsubsection Literais de ponto flutuante


Literais de ponto flutuante são descritos pelas seguintes definições léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-floatnumber}@anchor{2062}floatnumber   ::= @ref{2063,,pointfloat} | @ref{2064,,exponentfloat}
@anchor{reference/lexical_analysis grammar-token-python-grammar-pointfloat}@anchor{2063}pointfloat    ::= [@ref{2065,,digitpart}] @ref{2066,,fraction} | @ref{2065,,digitpart} "."
@anchor{reference/lexical_analysis grammar-token-python-grammar-exponentfloat}@anchor{2064}exponentfloat ::= (@ref{2065,,digitpart} | @ref{2063,,pointfloat}) @ref{2067,,exponent}
@anchor{reference/lexical_analysis grammar-token-python-grammar-digitpart}@anchor{2065}digitpart     ::= @ref{205c,,digit} (["_"] @ref{205c,,digit})*
@anchor{reference/lexical_analysis grammar-token-python-grammar-fraction}@anchor{2066}fraction      ::= "." @ref{2065,,digitpart}
@anchor{reference/lexical_analysis grammar-token-python-grammar-exponent}@anchor{2067}exponent      ::= ("e" | "E") ["+" | "-"] @ref{2065,,digitpart}
@end example

Observe que as partes inteiras e expoentes são sempre interpretadas usando base 10. Por exemplo, @code{077e010} é válido e representa o mesmo número que @code{77e10}. O intervalo permitido de literais de ponto flutuante depende da implementação. Assim como em literais inteiros, os sublinhados são permitidos para agrupamento de dígitos.

Alguns exemplos de literais de ponto flutuante:

@example
3.14    10.    .001    1e100    3.14e-10    0e0    3.14_15_93
@end example


Alterado na versão 3.6: Os sublinhados agora são permitidos para fins de agrupamento de literais.


@geindex j;em literal númerico

@node Literais imaginários,,Literais de ponto flutuante,Literais
@anchor{reference/lexical_analysis imaginary}@anchor{2068}@anchor{reference/lexical_analysis imaginary-literals}@anchor{2069}
@subsubsection Literais imaginários


Os literais imaginários são descritos pelas seguintes definições léxicas:

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-imagnumber}@anchor{206a}imagnumber ::= (@ref{2062,,floatnumber} | @ref{2065,,digitpart}) ("j" | "J")
@end example

Um literal imaginário produz um número complexo com uma parte real igual a 0.0. Os números complexos são representados como um par de números de ponto flutuante e têm as mesmas restrições em seu alcance. Para criar um número complexo com uma parte real diferente de zero, adicione um número de ponto flutuante a ele, por exemplo, @code{(3+4j)}. Alguns exemplos de literais imaginários:

@example
3.14j   10.j    10j     .001j   1e100j   3.14e-10j   3.14_15_93j
@end example

@node Operadores,Delimitadores,Literais,Análise léxica
@anchor{reference/lexical_analysis id14}@anchor{206b}@anchor{reference/lexical_analysis operators}@anchor{206c}
@subsection Operadores


@geindex operadores

Os seguintes tokens são operadores:

@example
+       -       *       **      /       //      %      @@
<<      >>      &       |       ^       ~       :=
<       >       <=      >=      ==      !=
@end example

@node Delimitadores,,Operadores,Análise léxica
@anchor{reference/lexical_analysis delimiters}@anchor{206d}@anchor{reference/lexical_analysis id15}@anchor{206e}
@subsection Delimitadores


@geindex delimitadores

Os seguintes tokens servem como delimitadores na gramática:

@example
(       )       [       ]       @{       @}
,       :       !       .       ;       @@       =
->      +=      -=      *=      /=      //=     %=
@@=      &=      |=      ^=      >>=     <<=     **=
@end example

O ponto também pode ocorrer em literais de ponto flutuante e imaginário. Uma sequência de três períodos tem um significado especial como um literal de reticências. A segunda metade da lista, os operadores de atribuição aumentada, servem lexicalmente como delimitadores, mas também realizam uma operação.

Os seguintes caracteres ASCII imprimíveis têm um significado especial como parte de outros tokens ou são significativos para o analisador léxico:

@example
'       "       #       \
@end example

Os seguintes caracteres ASCII imprimíveis não são usados em Python. Sua ocorrência fora de literais de string e comentários é um erro incondicional:

@example
$       ?       `
@end example

@node Modelo de dados,Modelo de execução,Análise léxica,A Referência da Linguagem Python
@anchor{reference/datamodel doc}@anchor{206f}@anchor{reference/datamodel data-model}@anchor{2070}@anchor{reference/datamodel datamodel}@anchor{1ae9}@anchor{reference/datamodel translation-repo}@anchor{2071}
@section Modelo de dados


@menu
* Objetos@comma{} valores e tipos: Objetos valores e tipos. 
* A hierarquia de tipos padrão:: 
* Nomes de métodos especiais:: 
* Corrotinas:: 

@end menu

@node Objetos valores e tipos,A hierarquia de tipos padrão,,Modelo de dados
@anchor{reference/datamodel objects}@anchor{2072}@anchor{reference/datamodel objects-values-and-types}@anchor{2073}
@subsection Objetos, valores e tipos


@geindex objeto
@geindex dados

`Objetos' são abstrações do Python para dados. Todos os dados em um programa Python são representados por objetos ou por relações entre objetos. Código também é representado por objetos.

@geindex função embutida;id
@geindex função embutida;tipo
@geindex identidade de um objeto
@geindex valor de um objeto
@geindex tipo de um objeto
@geindex objeto mutável
@geindex objeto imutável

Todo objeto tem uma identidade, um tipo e um valor. A `identidade' de um objeto nunca muda depois de criado; você pode pensar nisso como endereço de objetos em memória. O operador @ref{2f5,,is} compara as identidades de dois objetos; a função @ref{146a,,id()} retorna um inteiro representando sua identidade.

Para CPython, @code{id(x)} é o endereço de memória em que @code{x} está armazenado.

O tipo de um objeto determina as operações que o objeto implementa (por exemplo, “ele tem um comprimento?”) e também define os valores possíveis para objetos desse tipo. A função @ref{d6b,,type()} retorna o tipo de um objeto (que é também um objeto). Como sua identidade, o `tipo' do objeto também é imutável. @footnote{
Em alguns casos, `é' possível alterar o tipo de um objeto, sob certas condições controladas. No entanto, geralmente não é uma boa ideia, pois pode levar a um comportamento muito estranho se for tratado incorretamente.
}

O `valor' de alguns objetos pode mudar. Objetos cujos valores podem mudar são descritos como `mutáveis', objetos cujo valor não pode ser mudado uma vez que foram criados são chamados `imutáveis'. (O valor de um objeto contêiner imutável que contém uma referência a um objeto mutável pode mudar quando o valor deste último for mudado; no entanto o contêiner é ainda assim considerada imutável, pois a coleção de objetos que contém não pode ser mudada. Então a imutabilidade não é estritamente o mesmo do que não haver mudanças de valor, é mais sutil.) A mutabilidade de um objeto é determinada pelo seu tipo; por exemplo, números, strings e tuplas são imutáveis, enquanto dicionários e listas são mutáveis.

@geindex coleta de lixo
@geindex contagem de referências
@geindex objeto inalcançável

Os objetos nunca são destruídos explicitamente; no entanto, quando eles se tornam inacessíveis, eles podem ser coletados como lixo. Uma implementação tem permissão para adiar a coleta de lixo ou omiti-la completamente – é uma questão de detalhe de implementação como a coleta de lixo é implementada, desde que nenhum objeto que ainda esteja acessível seja coletado.

CPython atualmente usa um esquema de contagem de referências com detecção atrasada (opcional) de lixo ligado ciclicamente, que coleta a maioria dos objetos assim que eles se tornam inacessíveis, mas não é garantido que coletará lixo contendo referências circulares. Veja a documentação do módulo @ref{60,,gc} para informações sobre como controlar a coleta de lixo cíclico. Outras implementações agem de forma diferente e o CPython pode mudar. Não dependa da finalização imediata dos objetos quando eles se tornarem inacessíveis (isto é, você deve sempre fechar os arquivos explicitamente).

Observe que o uso dos recursos de rastreamento ou depuração da implementação pode manter os objetos ativos que normalmente seriam coletáveis. Observe também que capturar uma exceção com uma instrução @ref{6e9,,try}…@ref{18b,,except} pode manter os objetos vivos.

Alguns objetos contêm referências a recursos “externos”, como arquivos abertos ou janelas. Entende-se que esses recursos são liberados quando o objeto é coletado como lixo, mas como a coleta de lixo não é garantida, tais objetos também fornecem uma maneira explícita de liberar o recurso externo, geralmente um método @code{close()}. Os programas são fortemente recomendados para fechar explicitamente esses objetos. A instrução @ref{6e9,,try}…@ref{9d2,,finally} e a instrução @ref{5d2,,with} fornecem maneiras convenientes de fazer isso.

@geindex contêiner

Alguns objetos contêm referências a outros objetos; eles são chamados de `contêineres'. Exemplos de contêineres são tuplas, listas e dicionários. As referências fazem parte do valor de um contêiner. Na maioria dos casos, quando falamos sobre o valor de um contêiner, nos referimos aos valores, não às identidades dos objetos contidos; entretanto, quando falamos sobre a mutabilidade de um contêiner, apenas as identidades dos objetos contidos imediatamente estão implícitas. Portanto, se um contêiner imutável (como uma tupla) contém uma referência a um objeto mutável, seu valor muda se esse objeto mutável for alterado.

Os tipos afetam quase todos os aspectos do comportamento do objeto. Até mesmo a importância da identidade do objeto é afetada em algum sentido: para tipos imutáveis, as operações que calculam novos valores podem realmente retornar uma referência a qualquer objeto existente com o mesmo tipo e valor, enquanto para objetos mutáveis isso não é permitido. Por exemplo, após @code{a = 1; b = 1}, `a' e `b' podem ou não se referir ao mesmo objeto com o valor um, dependendo da implementação. Isto ocorre porque @ref{257,,int} é um tipo imutável, então a referência a @code{1} pode ser reutilizada. Este comportamento depende da implementação usada, então não deve ser considerada confiável, mas é algo para se estar ciente ao fazer uso de testes de identidade de objeto. No entanto, após @code{c = []; d = []}, `c' e `d' têm a garantia de referir-se a duas listas vazias diferentes e únicas. (Observe que @code{e = f = []} atribui o `mesmo' objeto para `e' e `f'.)

@node A hierarquia de tipos padrão,Nomes de métodos especiais,Objetos valores e tipos,Modelo de dados
@anchor{reference/datamodel the-standard-type-hierarchy}@anchor{2074}@anchor{reference/datamodel types}@anchor{2075}
@subsection A hierarquia de tipos padrão


@geindex tipo
@geindex dados;tipo
@geindex tipo;hierarquia
@geindex extensão;módulo
@geindex C;linguagem

Abaixo está uma lista dos tipos que são embutidos no Python. Módulos de extensão (escritos em C, Java ou outras linguagens, dependendo da implementação) podem definir tipos adicionais. Versões futuras do Python podem adicionar tipos à hierarquia de tipo (por exemplo, números racionais, matrizes de inteiros armazenadas de forma eficiente, etc.), embora tais adições sejam frequentemente fornecidas por meio da biblioteca padrão.

@geindex atributo
@geindex especial;atributo
@geindex genérico;especial;atributo

Algumas das descrições de tipo abaixo contêm um parágrafo listando “atributos especiais”. Esses são atributos que fornecem acesso à implementação e não se destinam ao uso geral. Sua definição pode mudar no futuro.

@menu
* None:: 
* NotImplemented:: 
* Ellipsis:: 
* numbers.Number: numbers Number. 
* Sequências:: 
* Tipos de conjuntos:: 
* Mapeamentos:: 
* Tipos chamáveis:: 
* Módulos: Módulos<3>. 
* Classes personalizadas:: 
* Instâncias de classe: Instâncias de classe<2>. 
* Objetos de E/S (também conhecidos como objetos arquivo): Objetos de E/S também conhecidos como objetos arquivo. 
* Tipos internos:: 

@end menu

@node None,NotImplemented,,A hierarquia de tipos padrão
@anchor{reference/datamodel none}@anchor{2076}
@subsubsection None


@geindex objeto;None

Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do nome embutido @code{None}. É usado para significar a ausência de um valor em muitas situações, por exemplo, ele é retornado de funções que não retornam nada explicitamente. Seu valor verdade é falso.

@node NotImplemented,Ellipsis,None,A hierarquia de tipos padrão
@anchor{reference/datamodel notimplemented}@anchor{2077}
@subsubsection NotImplemented


@geindex objeto;NotImplemented

Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do nome embutido @ref{7d3,,NotImplemented}. Os métodos numéricos e métodos de comparação rica devem retornar esse valor se não implementarem a operação para os operandos fornecidos. (O interpretador tentará então a operação refletida ou alguma outra alternativa, dependendo do operador.) Não deve ser avaliado em um contexto booleano.

Veja a documentação @ref{2078,,Implementando as operações aritméticas} para mais detalhes.


Alterado na versão 3.9: A avaliação de @ref{7d3,,NotImplemented} em um contexto booleano foi descontinuada. Embora atualmente seja avaliada como verdadeiro, é emitida uma exceção @ref{1a5,,DeprecationWarning}. Levantará uma @ref{2c3,,TypeError} em uma versão futura do Python.


@node Ellipsis,numbers Number,NotImplemented,A hierarquia de tipos padrão
@anchor{reference/datamodel ellipsis}@anchor{2079}
@subsubsection Ellipsis


@geindex objeto;Ellipsis
@geindex ...;literal de reticências

Este tipo possui um único valor. Existe um único objeto com este valor. Este objeto é acessado através do literal @code{...} ou do nome embutido @code{Ellipsis} (reticências). Seu valor verdade é verdadeiro.

@node numbers Number,Sequências,Ellipsis,A hierarquia de tipos padrão
@anchor{reference/datamodel numbers-number}@anchor{207a}
@subsubsection @code{numbers.Number}


@geindex objeto;numérico

Esses são criados por literais numéricos e retornados como resultados por operadores aritméticos e funções aritméticas embutidas. Os objetos numéricos são imutáveis; uma vez criado, seu valor nunca muda. Os números do Python são, obviamente, fortemente relacionados aos números matemáticos, mas sujeitos às limitações da representação numérica em computadores.

As representações de string das classes numéricas, calculadas por @ref{61c,,__repr__()} e @ref{61d,,__str__()}, têm as seguintes propriedades:


@itemize *

@item 
Elas são literais numéricos válidos que, quando passados para seu construtor de classe, produzem um objeto com o valor do numérico original.

@item 
A representação está na base 10, quando possível.

@item 
Os zeros à esquerda, possivelmente com exceção de um único zero antes de um ponto decimal, não são mostrados.

@item 
Os zeros à direita, possivelmente com exceção de um único zero após um ponto decimal, não são mostrados.

@item 
Um sinal é mostrado apenas quando o número é negativo.
@end itemize

Python distingue entre inteiros, números de ponto flutuante e números complexos:

@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{207b}
@subsubsection @code{numbers.Integral}


@geindex objeto;inteiro

Estes representam elementos do conjunto matemático de inteiros (positivos e negativos).

@cartouche
@quotation Nota 
@geindex inteiro;representação

As regras para representação de inteiros têm como objetivo fornecer a interpretação mais significativa das operações de deslocamento e máscara envolvendo inteiros negativos.
@end quotation
@end cartouche

Existem dois tipos de inteiros:


@table @asis

@item Inteiros (@ref{257,,int})

Estes representam números em um intervalo ilimitado, sujeito apenas à memória (virtual) disponível. Para o propósito de operações de deslocamento e máscara, uma representação binária é presumida e os números negativos são representados em uma variante do complemento de 2 que dá a ilusão de uma string infinita de bits de sinal estendendo-se para a esquerda.

@item Booleanos (@ref{468,,bool})

@geindex objeto;Booleano
@geindex False
@geindex True

Estes representam os valores da verdade Falsos e Verdadeiros. Os dois objetos que representam os valores @code{False} e @code{True} são os únicos objetos booleanos. O tipo booleano é um subtipo do tipo inteiro, e os valores booleanos se comportam como os valores 0 e 1, respectivamente, em quase todos os contextos, com exceção de que, quando convertidos em uma string, as strings @code{"False"} ou @code{"True"} são retornados, respectivamente.
@end table

@node numbers Real float,numbers Complex complex,numbers Integral,numbers Number
@anchor{reference/datamodel numbers-real-float}@anchor{207c}
@subsubsection @code{numbers.Real} (@code{float})


@geindex objeto;ponto flutuante
@geindex ponto flutuante;número
@geindex C;linguagem
@geindex Java;linguagem

Estes representam números de ponto flutuante de precisão dupla no nível da máquina. Você está à mercê da arquitetura da máquina subjacente (e implementação C ou Java) para o intervalo aceito e tratamento de estouro. Python não oferece suporte a números de ponto flutuante de precisão única; a economia no uso do processador e da memória, que normalmente é o motivo de usá-los, é ofuscada pela sobrecarga do uso de objetos em Python, portanto, não há razão para complicar a linguagem com dois tipos de números de ponto flutuante.

@node numbers Complex complex,,numbers Real float,numbers Number
@anchor{reference/datamodel numbers-complex-complex}@anchor{207d}
@subsubsection @code{numbers.Complex} (@code{complex})


@geindex objeto;complexo
@geindex complexo;número

Estes representam números complexos como um par de números de ponto flutuante de precisão dupla no nível da máquina. As mesmas advertências se aplicam aos números de ponto flutuante. As partes reais e imaginárias de um número complexo @code{z} podem ser obtidas através dos atributos somente leitura @code{z.real} e @code{z.imag}.

@node Sequências,Tipos de conjuntos,numbers Number,A hierarquia de tipos padrão
@anchor{reference/datamodel sequences}@anchor{207e}
@subsubsection Sequências


@geindex função embutida;len
@geindex objeto;sequência
@geindex operação com índice
@geindex seleção item
@geindex subscrição

Estes representam conjuntos ordenados finitos indexados por números não negativos. A função embutida @ref{62e,,len()} retorna o número de itens de uma sequência. Quando o comprimento de uma sequência é `n', o conjunto de índices contém os números 0, 1, …, `n'-1. O item `i' da sequência `a' é selecionado por @code{a[i]}. Algumas sequências, incluindo sequências embutidas, interpretam subscritos negativos adicionando o comprimento da sequência. Por exemplo, @code{a[-2]} é igual a @code{a[n-2]}, o penúltimo item da sequência a com comprimento @code{n}.

@geindex fatiamento

Sequências também provê fatiamento: @code{a[i:j]} seleciona todos os itens com índice `k' de forma que `i' @code{<=} `k' @code{<} `j'. Quando usada como expressão, uma fatia é uma sequência do mesmo tipo. O comentário acima sobre índices negativos também se aplica a posições de fatias negativas.

Algumas sequências também suportam “fatiamento estendido” com um terceiro parâmetro de “etapa”: @code{a[i:j:k]} seleciona todos os itens de `a' com índice `x' onde @code{x = i + n*k}, `n' @code{>=} @code{0} e `i' @code{<=} `x' @code{<} `j'.

As sequências são distinguidas de acordo com sua mutabilidade:

@menu
* Sequências imutáveis:: 
* Sequências mutáveis:: 

@end menu

@node Sequências imutáveis,Sequências mutáveis,,Sequências
@anchor{reference/datamodel immutable-sequences}@anchor{207f}
@subsubsection Sequências imutáveis


@geindex objeto;sequência imutável
@geindex objeto;imutável

Um objeto de um tipo de sequência imutável não pode ser alterado depois de criado. (Se o objeto contiver referências a outros objetos, esses outros objetos podem ser mutáveis e podem ser alterados; no entanto, a coleção de objetos diretamente referenciada por um objeto imutável não pode ser alterada.)

Os tipos a seguir são sequências imutáveis:

@geindex string;sequências imutáveis


@table @asis

@item Strings

@geindex função embutida;chr
@geindex função embutida;ord
@geindex caractere
@geindex inteiro
@geindex Unicode

Uma string é uma sequência de valores que representam pontos de código Unicode. Todos os pontos de código no intervalo @code{U+0000 - U+10FFFF} podem ser representados em uma string. Python não tem um tipo char; em vez disso, cada ponto de código na string é representado como um objeto string com comprimento @code{1}. A função embutida @ref{2080,,ord()} converte um ponto de código de sua forma de string para um inteiro no intervalo @code{0 - 10FFFF}; @ref{1768,,chr()} converte um inteiro no intervalo @code{0 - 10FFFF} para o objeto de string correspondente de comprimento @code{1}. @ref{8db,,str.encode()} pode ser usado para converter uma @ref{44c,,str} para @ref{1c2,,bytes} usando a codificação de texto fornecida, e @ref{8dc,,bytes.decode()} pode ser usado para conseguir o oposto.

@item Tuplas

@geindex objeto;tupla
@geindex Singleton;tupla
@geindex vazia;tupla

Os itens de uma tupla são objetos Python arbitrários. Tuplas de dois ou mais itens são formadas por listas de expressões separadas por vírgulas. Uma tupla de um item (um “singleton”) pode ser formada afixando uma vírgula a uma expressão (uma expressão por si só não cria uma tupla, já que os parênteses devem ser usados para agrupamento de expressões). Uma tupla vazia pode ser formada por um par vazio de parênteses.

@item Bytes

@geindex bytes
@geindex byte

Um objeto bytes é um vetor imutável. Os itens são bytes de 8 bits, representados por inteiros no intervalo 0 <= x < 256. Literais de bytes (como @code{b'abc'}) e o construtor embutido @ref{1c2,,bytes()} podem ser usados para criar objetos bytes. Além disso, os objetos bytes podem ser decodificados em strings através do método @ref{8dc,,decode()}.
@end table

@node Sequências mutáveis,,Sequências imutáveis,Sequências
@anchor{reference/datamodel mutable-sequences}@anchor{2081}
@subsubsection Sequências mutáveis


@geindex objeto;sequência mutável
@geindex objeto;mutável
@geindex atribuição;instrução
@geindex subscrição
@geindex fatiamento

As sequências mutáveis podem ser alteradas após serem criadas. As notações de subscrição e fatiamento podem ser usadas como o destino da atribuição e instruções @ref{18a7,,del} (`delete', exclusão).

@cartouche
@quotation Nota 
@geindex módulo;array

@geindex módulo;collections

Os módulos @ref{1d,,collections} e @ref{7,,array} fornecem exemplos adicionais de tipos de sequência mutáveis.
@end quotation
@end cartouche

Atualmente, existem dois tipos de sequência mutável intrínseca:


@table @asis

@item Listas

@geindex objeto;lista

Os itens de uma lista são objetos Python arbitrários. As listas são formadas colocando uma lista de expressões separada por vírgulas entre colchetes. (Observe que não há casos especiais necessários para formar listas de comprimento 0 ou 1.)

@item Vetores de bytes

@geindex bytearray

Um objeto bytearray é um vetor mutável. Eles são criados pelo construtor embutido @ref{2ea,,bytearray()}. Além de serem mutáveis (e, portanto, não-hasheável), os vetores de bytes fornecem a mesma interface e funcionalidade que os objetos imutáveis @ref{1c2,,bytes}.
@end table

@node Tipos de conjuntos,Mapeamentos,Sequências,A hierarquia de tipos padrão
@anchor{reference/datamodel set-types}@anchor{2082}
@subsubsection Tipos de conjuntos


@geindex função embutida;len
@geindex objeto;tipo conjunto

Estes representam conjuntos finitos e não ordenados de objetos únicos e imutáveis. Como tal, eles não podem ser indexados por nenhum subscrito. No entanto, eles podem ser iterados, e a função embutida @ref{62e,,len()} retorna o número de itens em um conjunto. Os usos comuns para conjuntos são testes rápidos de associação, remoção de duplicatas de uma sequência e computação de operações matemáticas como interseção, união, diferença e diferença simétrica.

Para elementos de conjunto, as mesmas regras de imutabilidade se aplicam às chaves de dicionário. Observe que os tipos numéricos obedecem às regras normais para comparação numérica: se dois números forem iguais (por exemplo, @code{1} e @code{1.0}), apenas um deles pode estar contido em um conjunto.

Atualmente, existem dois tipos de conjuntos intrínsecos:


@table @asis

@item Conjuntos

@geindex objeto;set

Estes representam um conjunto mutável. Eles são criados pelo construtor embutido @ref{5d9,,set()} e podem ser modificados posteriormente por vários métodos, como @ref{2083,,add()}.

@item Conjuntos congelados

@geindex objeto;frozenset

Estes representam um conjunto imutável. Eles são criados pelo construtor embutido @ref{5da,,frozenset()}. Como um frozenset é imutável e @ref{610,,hasheável}, ele pode ser usado novamente como um elemento de outro conjunto, ou como uma chave de dicionário.
@end table

@node Mapeamentos,Tipos chamáveis,Tipos de conjuntos,A hierarquia de tipos padrão
@anchor{reference/datamodel mappings}@anchor{2084}
@subsubsection Mapeamentos


@geindex função embutida;len
@geindex subscrição
@geindex objeto;mapeamento

Eles representam conjuntos finitos de objetos indexados por conjuntos de índices arbitrários. A notação subscrito @code{a[k]} seleciona o item indexado por @code{k} do mapeamento @code{a}; isso pode ser usado em expressões e como alvo de atribuições ou instruções @ref{18a7,,del}. A função embutida @ref{62e,,len()} retorna o número de itens em um mapeamento.

Atualmente, há um único tipo de mapeamento intrínseco:

@menu
* Dicionários: Dicionários<2>. 

@end menu

@node Dicionários<2>,,,Mapeamentos
@anchor{reference/datamodel dictionaries}@anchor{2085}
@subsubsection Dicionários


@geindex objeto;dicionário

Eles representam conjuntos finitos de objetos indexados por valores quase arbitrários. Os únicos tipos de valores não aceitáveis como chaves são os valores que contêm listas ou dicionários ou outros tipos mutáveis que são comparados por valor em vez de por identidade de objeto, o motivo é que a implementação eficiente de dicionários requer que o valor de hash de uma chave permaneça constante. Os tipos numéricos usados para chaves obedecem às regras normais para comparação numérica: se dois números forem iguais (por exemplo, @code{1} e @code{1.0}), eles podem ser usados alternadamente para indexar a mesma entrada do dicionário.

Dicionários preservam a ordem de inserção, o que significa que as chaves serão produzidas na mesma ordem em que foram adicionadas sequencialmente no dicionário. Substituir uma chave existente não altera a ordem, no entanto, remover uma chave e inseri-la novamente irá adicioná-la ao final em vez de manter seu lugar anterior.

Os dicionários são mutáveis; eles podem ser criados pela notação @code{@{@}} (veja a seção @ref{da7,,Sintaxes de criação de dicionário}).

@geindex módulo;dbm.ndbm
@geindex módulo;dbm.gnu

Os módulos de extensão @ref{34,,dbm.ndbm} e @ref{33,,dbm.gnu} fornecem exemplos adicionais de tipos de mapeamento, assim como o módulo @ref{1d,,collections}.


Alterado na versão 3.7: Dicionários não preservavam a ordem de inserção nas versões do Python anteriores à 3.6. No CPython 3.6, a ordem de inserção foi preservada, mas foi considerada um detalhe de implementação naquela época, em vez de uma garantia da linguagem.


@node Tipos chamáveis,Módulos<3>,Mapeamentos,A hierarquia de tipos padrão
@anchor{reference/datamodel callable-types}@anchor{2086}
@subsubsection Tipos chamáveis


@geindex objeto;chamável
@geindex função;chamada
@geindex invocação
@geindex função;argumento

Estes são os tipos aos quais a operação de chamada de função (veja a seção @ref{da5,,Chamadas}) pode ser aplicada:

@menu
* Funções definidas pelo usuário:: 
* Métodos de instância:: 
* Funções geradoras:: 
* Funções de corrotina:: 
* Funções geradoras assíncronas:: 
* Funções embutidas: Funções embutidas<2>. 
* Métodos embutidos:: 
* Classes: Classes<2>. 
* Instâncias de classe:: 

@end menu

@node Funções definidas pelo usuário,Métodos de instância,,Tipos chamáveis
@anchor{reference/datamodel user-defined-funcs}@anchor{299}@anchor{reference/datamodel user-defined-functions}@anchor{2087}
@subsubsection Funções definidas pelo usuário


@geindex definida por usuário;função
@geindex objeto;função
@geindex objeto;função definida por usuário

Um objeto função definido pelo usuário será criado pela definição de função (veja a seção @ref{1db6,,Definições de função}). A mesma deverá ser invocada com uma lista de argumentos contendo o mesmo número de itens que a lista de parâmetros formais da função.

@menu
* Atributos especiais de somente leitura:: 
* Atributos especiais graváveis:: 

@end menu

@node Atributos especiais de somente leitura,Atributos especiais graváveis,,Funções definidas pelo usuário
@anchor{reference/datamodel special-read-only-attributes}@anchor{2088}
@subsubsection Atributos especiais de somente leitura


@geindex __builtins__ (function attribute)
@geindex __closure__ (atributo de função)
@geindex __globals__ (atributo de função)
@geindex global;espaço de nomes


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __builtins__ (atributo function)
@anchor{reference/datamodel function __builtins__}@anchor{2089}
@deffn {Atributo} function.__builtins__
@end deffn

@tab

A reference to the @ref{256,,dictionary} that holds the function’s
builtins namespace.


Adicionado na versão 3.10.


@item

@geindex __globals__ (atributo function)
@anchor{reference/datamodel function __globals__}@anchor{1316}
@deffn {Atributo} function.__globals__
@end deffn

@tab

Uma referência ao @ref{256,,dicionário} que contém as @ref{208a,,variáveis globais} da função – o espaço de nomes global do módulo no qual a função foi definida.

@item

@geindex __closure__ (atributo function)
@anchor{reference/datamodel function __closure__}@anchor{1313}
@deffn {Atributo} function.__closure__
@end deffn

@tab

@code{None} ou uma @ref{370,,tuple} de células que contêm ligação para os nomes especificados no atributo @ref{208b,,co_freevars} do @ref{29a,,objeto código} da função.

Um objeto de célula tem o atributo @code{cell_contents}. Isso pode ser usado para obter o valor da célula, bem como definir o valor.

@end multitable


@node Atributos especiais graváveis,,Atributos especiais de somente leitura,Funções definidas pelo usuário
@anchor{reference/datamodel special-writable-attributes}@anchor{208c}
@subsubsection Atributos especiais graváveis


@geindex __doc__ (atributo de função)
@geindex __name__ (atributo de função)
@geindex __module__ (atributo de função)
@geindex __dict__ (atributo de função)
@geindex __defaults__ (atributo de função)
@geindex __code__ (atributo de função)
@geindex __annotations__ (atributo de função)
@geindex __kwdefaults__ (atributo de função)
@geindex __type_params__ (atributo de função)

A maioria desses atributos verifica o tipo do valor atribuído:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __doc__ (atributo function)
@anchor{reference/datamodel function __doc__}@anchor{1219}
@deffn {Atributo} function.__doc__
@end deffn

@tab

A string de documentação da função, ou @code{None} se indisponível.

@item

@geindex __name__ (atributo function)
@anchor{reference/datamodel function __name__}@anchor{1317}
@deffn {Atributo} function.__name__
@end deffn

@tab

O nome da função. Veja também: @ref{109f,,atributos __name__}.

@item

@geindex __qualname__ (atributo function)
@anchor{reference/datamodel function __qualname__}@anchor{208d}
@deffn {Atributo} function.__qualname__
@end deffn

@tab

O @ref{1ab1,,nome qualificado} da função. Veja também: @ref{109e,,atributos __qualname__}.


Adicionado na versão 3.3.


@item

@geindex __module__ (atributo function)
@anchor{reference/datamodel function __module__}@anchor{208e}
@deffn {Atributo} function.__module__
@end deffn

@tab

O nome do módulo em que a função foi definida ou @code{None} se indisponível.

@item

@geindex __defaults__ (atributo function)
@anchor{reference/datamodel function __defaults__}@anchor{1314}
@deffn {Atributo} function.__defaults__
@end deffn

@tab

Uma @ref{370,,tuple} contendo valores de @ref{208f,,parâmetro} padrão para aqueles parâmetros que possuem padrões, ou @code{None} se nenhum parâmetro tiver um valor padrão.

@item

@geindex __code__ (atributo function)
@anchor{reference/datamodel function __code__}@anchor{29a}
@deffn {Atributo} function.__code__
@end deffn

@tab

O @ref{1d2,,objeto código} que representa o corpo da função compilada.

@item

@geindex __dict__ (atributo function)
@anchor{reference/datamodel function __dict__}@anchor{1315}
@deffn {Atributo} function.__dict__
@end deffn

@tab

O espaço de nomes que provê atributos de função arbitrários. Veja também: @ref{55b,,atributos __dict__}.

@item

@geindex __annotations__ (atributo function)
@anchor{reference/datamodel function __annotations__}@anchor{1218}
@deffn {Atributo} function.__annotations__
@end deffn

@tab

Um @ref{256,,dicionário} contendo anotações de @ref{208f,,parâmetros}. As chaves do dicionário são os nomes dos parâmetros e @code{'return'} para a anotação de retorno, se fornecida. Veja também: @ref{7da,,Boas práticas para anotações}.

@item

@geindex __kwdefaults__ (atributo function)
@anchor{reference/datamodel function __kwdefaults__}@anchor{105e}
@deffn {Atributo} function.__kwdefaults__
@end deffn

@tab

Um @ref{256,,dicionário} contendo padrões apenas para @ref{208f,,parâmetros} somente-nomeados.

@item

@geindex __type_params__ (atributo function)
@anchor{reference/datamodel function __type_params__}@anchor{2090}
@deffn {Atributo} function.__type_params__
@end deffn

@tab

Uma @ref{370,,tuple} contendo os @ref{2b3,,parâmetros de tipo} de uma @ref{453,,função genérica}.


Adicionado na versão 3.12.


@end multitable


Os objetos de função também dão suporte à obtenção e definição de atributos arbitrários, que podem ser usados, por exemplo, para anexar metadados a funções. A notação de ponto de atributo regular é usada para obter e definir tais atributos.

A implementação atual do CPython provê apenas atributos de função em funções definidas pelo usuário. Atributos de função em @ref{2091,,funções embutido} podem ser suportados no futuro.

Informações adicionais sobre a definição de uma função podem ser obtidas de seu @ref{1d2,,objeto código} (acessível através do atributo @ref{29a,,__code__}).

@node Métodos de instância,Funções geradoras,Funções definidas pelo usuário,Tipos chamáveis
@anchor{reference/datamodel id2}@anchor{2092}@anchor{reference/datamodel instance-methods}@anchor{1e47}
@subsubsection Métodos de instância


@geindex objeto;método
@geindex objeto;método definido por usuário
@geindex definida por usuário;método

Um objeto método de instância combina uma classe, uma instância de classe e qualquer objeto chamável (normalmente uma função definida pelo usuário).

@geindex __func__ (atributo de método)
@geindex __self__ (atributo de método)
@geindex __doc__ (atributo de método)
@geindex __name__ (atributo de método)
@geindex __module__ (atributo de método)

Atributos especiais de somente leitura:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex __self__ (atributo method)
@anchor{reference/datamodel method __self__}@anchor{140f}
@deffn {Atributo} method.__self__
@end deffn

@tab

Refere-se ao objeto instância da classe ao qual o método é @ref{2093,,vinculado}

@item

@geindex __func__ (atributo method)
@anchor{reference/datamodel method __func__}@anchor{1340}
@deffn {Atributo} method.__func__
@end deffn

@tab

Refere-se ao @ref{299,,objeto função} original

@item

@geindex __doc__ (atributo method)
@anchor{reference/datamodel method __doc__}@anchor{2094}
@deffn {Atributo} method.__doc__
@end deffn

@tab

A documentação do método (igual a @ref{1219,,method.__func__.__doc__}). Um @ref{44c,,string} se a função original tivesse uma docstring, caso contrário @code{None}.

@item

@geindex __name__ (atributo method)
@anchor{reference/datamodel method __name__}@anchor{2095}
@deffn {Atributo} method.__name__
@end deffn

@tab

O nome do método (mesmo que @ref{1317,,method.__func__.__name__})

@item

@geindex __module__ (atributo method)
@anchor{reference/datamodel method __module__}@anchor{2096}
@deffn {Atributo} method.__module__
@end deffn

@tab

O nome do módulo em que o método foi definido ou @code{None} se indisponível.

@end multitable


Os métodos também implementam o acesso (mas não a configuração) dos atributos arbitrários da função no @ref{299,,objeto função} subjacente.

Objetos método definidos pelo usuário podem ser criados ao obter um atributo de uma classe (talvez através de uma instância dessa classe), se esse atributo for um @ref{299,,objeto função} definido pelo usuário ou um objeto @ref{166,,classmethod} .
@anchor{reference/datamodel method-binding}@anchor{2093}
Quando um objeto método de instância é criado recuperando um @ref{299,,objeto função} definido pelo usuário de uma classe por meio de uma de suas instâncias, seu atributo @ref{140f,,__self__} é a instância, e o objeto método é considerado `vinculado'. O atributo @ref{1340,,__func__} do novo método é o objeto da função original.

Quando um objeto método de instância é criado obtendo um objeto @ref{166,,classmethod} de uma classe ou instância, seu atributo @ref{140f,,__self__} é a própria classe, e seu atributo @ref{1340,,__func__} é o objeto função subjacente ao método de classe.

Quando um objeto método de instância é chamado, a função subjacente (@ref{1340,,__func__}) é chamada, inserindo a instância de classe (@ref{140f,,__self__}) na frente da lista de argumentos. Por exemplo, quando @code{C} é uma classe que contém uma definição para uma função @code{f()}, e @code{x} é uma instância de @code{C}, chamando @code{x.f(1)} é equivalente a chamar @code{C.f(x, 1)}.

Quando um objeto método de instância é derivado de um objeto @ref{166,,classmethod}, a “instância de classe” armazenada em @ref{140f,,__self__} será, na verdade, a própria classe, de modo que chamar @code{x.f(1)} ou @code{C.f(1)} é equivalente a chamar @code{f(C,1)} sendo @code{f} a função subjacente.

É importante observar que funções definidas pelo usuário que são atributos de uma instância de classe não são convertidas em métodos vinculados; isso `somente' acontece quando a função é um atributo da classe.

@node Funções geradoras,Funções de corrotina,Métodos de instância,Tipos chamáveis
@anchor{reference/datamodel generator-functions}@anchor{2097}
@subsubsection Funções geradoras


@geindex gerador;função
@geindex gerador;iterador

Uma função ou método que usa a instrução @ref{9d5,,yield} (veja a seção @ref{9d5,,A instrução yield}) é chamada de `função geradora'. Tal função, quando chamada, sempre retorna um objeto @ref{1ac,,iterator}  que pode ser usado para executar o corpo da função: chamar o método @ref{1310,,iterator.__next__()} do iterador fará com que a função seja executada até que forneça um valor usando a instrução @code{yield}. Quando a função executa uma instrução @ref{9d6,,return} ou sai do fim, uma exceção @ref{c15,,StopIteration} é levantada e o iterador terá alcançado o fim do conjunto de valores a serem retornados.

@node Funções de corrotina,Funções geradoras assíncronas,Funções geradoras,Tipos chamáveis
@anchor{reference/datamodel coroutine-functions}@anchor{2098}
@subsubsection Funções de corrotina


@geindex corrotina;função

Uma função ou um método que é definida(o) usando @ref{5d1,,async def} é chamado de `função de corrotina'. Tal função, quando chamada, retorna um objeto de @ref{491,,corrotina}. Ele pode conter expressões @ref{1b9,,await}, bem como instruções @ref{5d5,,async with} e @ref{aba,,async for}. Veja também a seção @ref{2099,,Objetos corrotina}.

@node Funções geradoras assíncronas,Funções embutidas<2>,Funções de corrotina,Tipos chamáveis
@anchor{reference/datamodel asynchronous-generator-functions}@anchor{209a}
@subsubsection Funções geradoras assíncronas


@geindex gerador assíncrono;função
@geindex gerador assíncrono;iterador assíncrono

Uma função ou um método que é definida(o) usando @ref{5d1,,async def} e que usa a instrução @ref{9d5,,yield} é chamada de `função geradora assíncrona'. Tal função, quando chamada, retorna um objeto @ref{1ab,,iterador assíncrono} que pode ser usado em uma instrução @ref{aba,,async for} para executar o corpo da função.

Chamar o método @ref{1659,,aiterator.__anext__} do iterador assíncrono retornará um @ref{1ad,,aguardável} que, quando aguardado, será executado até fornecer um valor usando a expressão @ref{9d5,,yield}. Quando a função executa uma instrução vazia @ref{9d6,,return} ou chega ao final, uma exceção @ref{1ba5,,StopAsyncIteration} é levantada e o iterador assíncrono terá alcançado o final do conjunto de valores a serem produzidos.

@node Funções embutidas<2>,Métodos embutidos,Funções geradoras assíncronas,Tipos chamáveis
@anchor{reference/datamodel built-in-functions}@anchor{209b}@anchor{reference/datamodel builtin-functions}@anchor{2091}
@subsubsection Funções embutidas


@geindex objeto;função embutida
@geindex objeto;função
@geindex C;linguagem

Um objeto função embutida é um wrapper em torno de uma função C. Exemplos de funções embutidas são @ref{62e,,len()} e @ref{1506,,math.sin()} (@ref{8e,,math} é um módulo embutido padrão). O número e o tipo dos argumentos são determinados pela função C. Atributos especiais de somente leitura:


@itemize *

@item 
@code{__doc__} é a string de documentação da função, ou @code{None} se não estiver disponível. Veja @ref{1219,,function.__doc__}.

@item 
@code{__name__} é o nome da função. Veja @ref{1317,,function.__name__}.

@item 
@code{__self__} é definido para @code{None} (mas veja o próximo item).

@item 
@code{__module__} é o nome do módulo no qual a função foi definida ou @code{None} se não estiver disponível. Veja @ref{208e,,function.__module__}.
@end itemize

@node Métodos embutidos,Classes<2>,Funções embutidas<2>,Tipos chamáveis
@anchor{reference/datamodel built-in-methods}@anchor{209c}@anchor{reference/datamodel builtin-methods}@anchor{209d}
@subsubsection Métodos embutidos


@geindex objeto;método embutido
@geindex objeto;método
@geindex embutido;método

Este é realmente um disfarce diferente de uma função embutida, desta vez contendo um objeto passado para a função C como um argumento extra implícito. Um exemplo de método embutido é @code{alist.append()}, presumindo que `alist' é um objeto de lista. Nesse caso, o atributo especial de somente leitura @code{__self__} é definido como o objeto denotado por `alist'. (O atributo tem a mesma semântica de @ref{140f,,outros métodos de instância}.)

@node Classes<2>,Instâncias de classe,Métodos embutidos,Tipos chamáveis
@anchor{reference/datamodel classes}@anchor{209e}@anchor{reference/datamodel id3}@anchor{209f}
@subsubsection Classes


Classes são chamáveis. Esses objetos normalmente agem como fábricas para novas instâncias de si mesmos, mas variações são possíveis para tipos de classe que substituem @ref{580,,__new__()}. Os argumentos da chamada são passados para @code{__new__()} e, no caso típico, para @ref{6b0,,__init__()} para inicializar a nova instância.

@node Instâncias de classe,,Classes<2>,Tipos chamáveis
@anchor{reference/datamodel class-instances}@anchor{20a0}
@subsubsection Instâncias de classe


Instâncias de classes arbitrárias podem ser tornados chamáveis definindo um método @ref{558,,__call__()} em sua classe.

@node Módulos<3>,Classes personalizadas,Tipos chamáveis,A hierarquia de tipos padrão
@anchor{reference/datamodel module-objects}@anchor{20a1}@anchor{reference/datamodel modules}@anchor{20a2}
@subsubsection Módulos


@geindex instrução;import
@geindex objeto;módulo

Módulos são uma unidade organizacional básica do código Python, e são criados pelo @ref{20a3,,sistema de importação} quando invocado pela instrução @ref{5e2,,import}, ou chamando funções como @ref{518,,importlib.import_module()} e a embutida @ref{8da,,__import__()}. Um objeto módulo tem um espaço de nomes implementado por um objeto @ref{256,,dicionário} (este é o dicionário referenciado pelo atributo @ref{1316,,__globals__} das funções definidas no módulo). As referências de atributos são traduzidas para pesquisas neste dicionário, por exemplo, @code{m.x} é equivalente a @code{m.__dict__["x"]}. Um objeto módulo não contém o objeto código usado para inicializar o módulo (uma vez que não é necessário depois que a inicialização é concluída).

A atribuição de atributo atualiza o dicionário de espaço de nomes do módulo, por exemplo, @code{m.x = 1} é equivalente a @code{m.__dict__["x"] = 1}.

@geindex __name__ (atributo de módulo)
@geindex __spec__ (atributo de módulo)
@geindex __package__ (atributo de módulo)
@geindex __loader__ (atributo de módulo)
@geindex __path__ (atributo de módulo)
@geindex __file__ (atributo de módulo)
@geindex __cached__ (atributo de módulo)
@geindex __doc__ (atributo de módulo)
@geindex __annotations__ (atributo de módulo)
@geindex módulo;espaço de nomes

@menu
* Atributos relacionados à importação em objetos de módulo:: 
* Outros atributos graváveis em objetos de módulo:: 
* Dicionários do módulo:: 

@end menu

@node Atributos relacionados à importação em objetos de módulo,Outros atributos graváveis em objetos de módulo,,Módulos<3>
@anchor{reference/datamodel import-mod-attrs}@anchor{20a4}@anchor{reference/datamodel import-related-attributes-on-module-objects}@anchor{20a5}
@subsubsection Atributos relacionados à importação em objetos de módulo


Objetos de módulo têm os seguintes atributos que se relacionam ao @ref{20a3,,sistema de importação}. Quando um módulo é criado usando o maquinário associado ao sistema de importação, esses atributos são preenchidos com base no @ref{20a6,,spec} do módulo, antes que o @ref{17a4,,carregador} execute e carregue o módulo.

Para criar um módulo dinamicamente em vez de usar o sistema de importação, é recomendado usar @ref{e3e,,importlib.util.module_from_spec()}, que definirá os vários atributos controlados pela importação para valores apropriados. Também é possível usar o construtor @ref{e3f,,types.ModuleType} para criar módulos diretamente, mas essa técnica é mais propensa a erros, pois a maioria dos atributos deve ser definida manualmente no objeto do módulo após ele ter sido criado ao usar essa abordagem.

@cartouche
@quotation Cuidado 
Com exceção de @ref{13d2,,__name__}, é `fortemente' recomendado que você confie no @ref{20a7,,__spec__} e seus atributos em vez de qualquer um dos outros atributos individuais listados nesta subseção. Observe que atualizar um atributo em @code{__spec__} não atualizará o atributo correspondente no próprio módulo:

@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 module)
@anchor{reference/datamodel module __name__}@anchor{13d2}
@deffn {Atributo} module.__name__

O nome usado para identificar exclusivamente o módulo no sistema de importação. Para um módulo executado diretamente, isso será definido como @code{"__main__"}.

Este atributo deve ser definido como o nome totalmente qualificado do módulo. Espera-se que ele corresponda ao valor de @ref{20a8,,module.__spec__.name}.
@end deffn

@geindex __spec__ (atributo module)
@anchor{reference/datamodel module __spec__}@anchor{20a7}
@deffn {Atributo} module.__spec__

Um registro do estado relacionado ao sistema de importação do módulo.

Define com @ref{1fee,,spec de módulo} que foi usado ao importar o módulo. Veja @ref{20a9,,Especificações de módulo} para mais detalhes.


Adicionado na versão 3.4.

@end deffn

@geindex __package__ (atributo module)
@anchor{reference/datamodel module __package__}@anchor{2d7}
@deffn {Atributo} module.__package__

O @ref{20aa,,pacote} ao qual um módulo pertence.

Se o módulo for de nível superior (ou seja, não fizer parte de nenhum pacote específico), o atributo deve ser definido como @code{'@w{'}} (a string vazia). Caso contrário, deve ser definido como o nome do pacote do módulo (que pode ser igual a @ref{13d2,,module.__name__} se o módulo em si for um pacote). Veja 
@geindex Propostas de Melhorias do Python; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} para mais detalhes.

Este atributo é usado em vez de @ref{13d2,,__name__} para calcular importações relativas explícitas para módulos principais. O padrão é @code{None} para módulos criados dinamicamente usando o construtor @ref{e3f,,types.ModuleType}; use @ref{e3e,,importlib.util.module_from_spec()} em vez disso para garantir que o atributo seja definido como @ref{44c,,str}.

É `fortemente' recomendado que você use @ref{2d8,,module.__spec__.parent} em vez de @code{module.__package__}. @ref{2d7,,__package__} agora só é usado como fallback se @code{__spec__.parent} não estiver definido, e esse caminho de fallback está descontinuado.


Alterado na versão 3.4: Este atributo agora presume o padrão @code{None} para módulos criados dinamicamente usando o construtor @ref{e3f,,types.ModuleType}. Anteriormente, o atributo era opcional.



Alterado na versão 3.6: Espera-se que o valor de @code{__package__} seja o mesmo que @ref{2d8,,__spec__.parent}. @ref{2d7,,__package__} agora é usado apenas como fallback durante a resolução de importação se @code{__spec__.parent} não estiver definido.



Alterado na versão 3.10: @ref{4fa,,ImportWarning} é levantada se uma resolução de importação retorna para @code{__package__} em vez de @ref{2d8,,__spec__.parent}.



Alterado na versão 3.12: Levanta @ref{1a5,,DeprecationWarning} em vez de @ref{4fa,,ImportWarning} ao retornar para @code{__package__} durante a resolução de importação.



Descontinuado desde a versão 3.13, será removido na versão 3.15: @code{__package__} deixará de ser definido ou levado em consideração pelo sistema de importação ou biblioteca padrão.

@end deffn

@geindex __loader__ (atributo module)
@anchor{reference/datamodel module __loader__}@anchor{2e2}
@deffn {Atributo} module.__loader__

O objeto @ref{17a4,,carregador} que o maquinário de importação usou para carregar o módulo.

Este atributo é útil principalmente para introspecção, mas pode ser usado para funcionalidades adicionais específicas do carregador, por exemplo, para obter dados associados a um carregador.

@code{__loader__} assume como padrão @code{None} para módulos criados dinamicamente usando o construtor @ref{e3f,,types.ModuleType}; use @ref{e3e,,importlib.util.module_from_spec()} para garantir que o atributo seja definido como um objeto @ref{17a4,,carregador}.

É `fortemetne' recomendado que você use @ref{2e3,,module.__spec__.loader} em vez de @code{module.__loader__}.


Alterado na versão 3.4: Este atributo agora presume o padrão @code{None} para módulos criados dinamicamente usando o construtor @ref{e3f,,types.ModuleType}. Anteriormente, o atributo era opcional.



Descontinuado desde a versão 3.12, será removido na versão 3.16: A definição @code{__loader__} em um módulo enquanto falha na definição de @code{__spec__.loader} está descontinuado. No Python 3.16, @code{__loader__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão.

@end deffn

@geindex __path__ (atributo module)
@anchor{reference/datamodel module __path__}@anchor{1df4}
@deffn {Atributo} module.__path__

Uma @ref{4f1,,sequência} (possivelmente vazia) de strings enumerando os locais onde os submódulos do pacote serão encontrados. Módulos que não sejam de pacote não devem ter um atributo @code{__path__}. Veja @ref{20ab,,Atributo __path__ dos módulos} para mais detalhes.

É `fortemente' recomendado que você use @ref{20ac,,module.__spec__.submodule_search_locations} em vez de @code{module.__path__}.
@end deffn

@geindex __file__ (atributo module)
@anchor{reference/datamodel module __file__}@anchor{20ad}
@deffn {Atributo} module.__file__
@end deffn

@geindex __cached__ (atributo module)
@anchor{reference/datamodel module __cached__}@anchor{2d5}
@deffn {Atributo} module.__cached__

@code{__file__} e @code{__cached__} são atributos opcionais que podem ou não ser definidos. Ambos os atributos devem ser um @ref{44c,,str} quando estiverem disponíveis.

@code{__file__} indica o nome do caminho do arquivo do qual o módulo foi carregado (se carregado de um arquivo) ou o nome do caminho do arquivo da biblioteca compartilhada para módulos de extensão carregados dinamicamente de uma biblioteca compartilhada. Pode estar faltando para certos tipos de módulos, como módulos C que estão estaticamente vinculados ao interpretador, e o @ref{20a3,,sistema de importação} pode optar por deixá-lo sem definição se não tiver significado semântico (por exemplo, um módulo carregado de um banco de dados).

Se @code{__file__} estiver definido então o atributo @code{__cached__} também pode ser definido, que é o caminho para qualquer versão compilada do código (por exemplo, um arquivo compilado por byte). O arquivo não precisa existir para configurar esse atributo; o caminho pode simplesmente apontar para onde o arquivo compilado existiria (veja 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}).

Observe que @code{__cached__} pode ser definido mesmo se @code{__file__} não estiver definido. No entanto, esse cenário é bastante atípico. Em última análise, o @ref{17a4,,carregador} é o que faz uso do spec de módulo fornecido pelo @ref{20ae,,localizador} (do qual @code{__file__} e @code{__cached__} são derivados). Portanto, se um carregador puder carregar a partir de um módulo em cache, mas não carregar a partir de um arquivo, esse cenário atípico poderá ser apropriado.

É `fortemente' recomendado que você use @ref{2d6,,module.__spec__.cached} em vez de @code{module.__cached__}.


Descontinuado desde a versão 3.13, será removido na versão 3.15: A definição @code{__cached__} em um módulo enquanto falha na definição de @code{__spec__.cached} está descontinuado. No Python 3.15, @code{__cached__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão.

@end deffn

@node Outros atributos graváveis em objetos de módulo,Dicionários do módulo,Atributos relacionados à importação em objetos de módulo,Módulos<3>
@anchor{reference/datamodel other-writable-attributes-on-module-objects}@anchor{20af}
@subsubsection Outros atributos graváveis em objetos de módulo


Além dos atributos relacionados à importação listados acima, os objetos de módulo também têm os seguintes atributos graváveis:

@geindex __doc__ (atributo module)
@anchor{reference/datamodel module __doc__}@anchor{1978}
@deffn {Atributo} module.__doc__

A string de documentação do módulo, ou @code{None} se indisponível. Veja também: @ref{92e,,atributos __doc__}.
@end deffn

@geindex __annotations__ (atributo module)
@anchor{reference/datamodel module __annotations__}@anchor{20b0}
@deffn {Atributo} module.__annotations__

Um dicionário contendo @ref{d79,,anotações de variável}  coletadas durante a execução do corpo do módulo. Para as melhores práticas sobre como trabalhar com @ref{20b0,,__annotations__}, por favor veja @ref{7da,,Boas práticas para anotações}.
@end deffn

@node Dicionários do módulo,,Outros atributos graváveis em objetos de módulo,Módulos<3>
@anchor{reference/datamodel module-dictionaries}@anchor{20b1}
@subsubsection Dicionários do módulo


Os objetos de módulo também têm o seguinte atributo especial somente leitura:

@geindex __dict__ (atributo de módulo)

@geindex __dict__ (atributo module)
@anchor{reference/datamodel module __dict__}@anchor{20b2}
@deffn {Atributo} module.__dict__

O espaço de nomes do módulo como um objeto dicionário. Exclusivamente entre os atributos listados aqui, @code{__dict__} não pode ser acessado como uma variável global de dentro de um módulo; ele só pode ser acessado como um atributo em objetos de módulo.

Por causa da maneira como CPython limpa dicionários de módulos, o dicionário do módulo será limpo quando o módulo sair do escopo, mesmo se o dicionário ainda tiver referências ativas. Para evitar isso, copie o dicionário ou mantenha o módulo por perto enquanto usa seu dicionário diretamente.
@end deffn

@node Classes personalizadas,Instâncias de classe<2>,Módulos<3>,A hierarquia de tipos padrão
@anchor{reference/datamodel class-attrs-and-methods}@anchor{20b3}@anchor{reference/datamodel custom-classes}@anchor{20b4}
@subsubsection Classes personalizadas


Tipos de classe personalizados são tipicamente criados por definições de classe (veja a seção @ref{131a,,Definições de classe}). Uma classe possui um espaço de nomes implementado por um objeto dicionário. As referências de atributos de classe são traduzidas para pesquisas neste dicionário, por exemplo, @code{C.x} é traduzido para @code{C.__dict__["x"]} (embora haja uma série de ganchos que permitem outros meios de localizar atributos). Quando o nome do atributo não é encontrado lá, a pesquisa do atributo continua nas classes base. Essa pesquisa das classes base usa a ordem de resolução de métodos C3, que se comporta corretamente mesmo na presença de estruturas de herança em losango, onde há vários caminhos de herança que levam de volta a um ancestral comum. Detalhes adicionais sobre a ordem de resolução de métodos (MRO) C3 usado pelo Python podem ser encontrados em @ref{14f2,,A Ordem de Resolução de Métodos do Python 2.3}.

@geindex objeto;classe
@geindex objeto;instância de classe
@geindex objeto;instância
@geindex objeto classe;chamada
@geindex contêiner
@geindex objeto;dicionário
@geindex classe;atributo

Quando uma referência de atributo de classe (para uma classe @code{C}, digamos) produziria um objeto método de classe, ele é transformado em um objeto método de instância cujo atributo @ref{140f,,__self__} é @code{C}. Quando produziria um objeto @ref{416,,staticmethod}, ele é transformado no objeto encapsulado pelo objeto método estático. Veja a seção @ref{c6a,,Implementando descritores} para outra maneira em que os atributos recuperados de uma classe podem diferir daqueles realmente contidos em seu @ref{55b,,__dict__}.

@geindex classe;atributo;atribuição

As atribuições de atributos de classe atualizam o dicionário da classe, nunca o dicionário de uma classe base.

@geindex objeto classe;chamada

Um objeto classe pode ser chamado (veja acima) para produzir uma instância de classe (veja abaixo).

@menu
* Atributos especiais:: 
* Métodos especiais:: 

@end menu

@node Atributos especiais,Métodos especiais,,Classes personalizadas
@anchor{reference/datamodel special-attributes}@anchor{20b5}
@subsubsection Atributos especiais


@geindex __name__ (atributo de classe)
@geindex __module__ (atributo de classe)
@geindex __dict__ (atributo de classe)
@geindex __bases__ (atributo de classe)
@geindex __base__ (atributo de classe)
@geindex __doc__ (atributo de classe)
@geindex __annotations__ (atributo de classe)
@geindex __type_params__ (atributo de classe)
@geindex __static_attributes__ (atributo de classe)
@geindex __firstlineno__ (atributo de classe)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex __name__ (atributo type)
@anchor{reference/datamodel type __name__}@anchor{14f3}
@deffn {Atributo} type.__name__
@end deffn

@tab

O nome da classe. Veja também: @ref{109f,,atributos __name__}.

@item

@geindex __qualname__ (atributo type)
@anchor{reference/datamodel type __qualname__}@anchor{20b6}
@deffn {Atributo} type.__qualname__
@end deffn

@tab

O @ref{1ab1,,nome qualificado} da classe. Veja também: @ref{109e,,atributos __qualname__}.

@item

@geindex __module__ (atributo type)
@anchor{reference/datamodel type __module__}@anchor{374}
@deffn {Atributo} type.__module__
@end deffn

@tab

O nome do módulo no qual a classe foi definida.

@item

@geindex __dict__ (atributo type)
@anchor{reference/datamodel type __dict__}@anchor{c78}
@deffn {Atributo} type.__dict__
@end deffn

@tab

Um @ref{46d,,proxy de mapeamento} fornecendo uma visão somente leitura do espaço de nomes da classe. Veja também: @ref{55b,,atributos __dict__}.

@item

@geindex __bases__ (atributo type)
@anchor{reference/datamodel type __bases__}@anchor{14f4}
@deffn {Atributo} type.__bases__
@end deffn

@tab

Uma @ref{370,,tuple} contendo as bases da classe. Na maioria dos casos, para uma classe definida como @code{class X(A, B, C)}, @code{X.__bases__} será exatamente igual a @code{(A, B, C)}.

@item

@geindex __base__ (atributo type)
@anchor{reference/datamodel type __base__}@anchor{20b7}
@deffn {Atributo} type.__base__
@end deffn

@tab

A única classe base na cadeia de herança responsável pelo layout de memória das instâncias. Este atributo corresponde a @ref{20b8,,tp_base} no nível C.

@item

@geindex __doc__ (atributo type)
@anchor{reference/datamodel type __doc__}@anchor{1e35}
@deffn {Atributo} type.__doc__
@end deffn

@tab

A string de documentação da classe, ou @code{None} se não estiver definida. Não herdado por subclasses.

@item

@geindex __annotations__ (atributo type)
@anchor{reference/datamodel type __annotations__}@anchor{20b9}
@deffn {Atributo} type.__annotations__
@end deffn

@tab

Um dicionário contendo @ref{d79,,anotações de variável} coletadas durante a execução do corpo da classe. Para melhores práticas sobre como trabalhar com @code{__annotations__}, por favor veja @ref{7da,,Boas práticas para anotações}.

@cartouche
@quotation Cuidado 
Acessar o atributo @code{__annotations__} de um objeto classe diretamente pode produzir resultados incorretos na presença de metaclasses. Além disso, o atributo pode não existir para algumas classes. Use @ref{816,,inspect.get_annotations()} para recuperar anotações de classe com segurança.
@end quotation
@end cartouche

@item

@geindex __type_params__ (atributo type)
@anchor{reference/datamodel type __type_params__}@anchor{20ba}
@deffn {Atributo} type.__type_params__
@end deffn

@tab

Uma @ref{370,,tuple} contendo os @ref{2b3,,parâmetros de tipo} de uma @ref{452,,classe genérica}.


Adicionado na versão 3.12.


@item

@geindex __static_attributes__ (atributo type)
@anchor{reference/datamodel type __static_attributes__}@anchor{14b}
@deffn {Atributo} type.__static_attributes__
@end deffn

@tab

Uma @ref{370,,tuple} contendo nomes de atributos dessa classe que são atribuídos por meio de @code{self.X} de qualquer função em seu corpo.


Adicionado na versão 3.13.


@item

@geindex __firstlineno__ (atributo type)
@anchor{reference/datamodel type __firstlineno__}@anchor{14c}
@deffn {Atributo} type.__firstlineno__
@end deffn

@tab

O número da linha da primeira linha da definição de classe, incluindo decoradores. Definir o atributo @code{__module__} remove o item @code{__firstlineno__} do dicionário do tipo.


Adicionado na versão 3.13.


@item

@geindex __mro__ (atributo type)
@anchor{reference/datamodel type __mro__}@anchor{20bb}
@deffn {Atributo} type.__mro__
@end deffn

@tab

A @ref{370,,tuple} de classes que são consideradas ao procurar por classes bases durante resolução de métodos.

@end multitable


@node Métodos especiais,,Atributos especiais,Classes personalizadas
@anchor{reference/datamodel special-methods}@anchor{20bc}
@subsubsection Métodos especiais


Além dos atributos especiais descritos acima, todas as classes Python também têm os dois métodos a seguir disponíveis:

@geindex mro() (método type)
@anchor{reference/datamodel type mro}@anchor{20bd}
@deffn {Método} type.mro ()

Este método pode ser substituído por uma metaclasse para personalizar a ordem de resolução de métodos para suas instâncias. Ele é chamado na instanciação da classe, e o seu resultado é armazenado em @ref{20bb,,__mro__}.
@end deffn

@geindex __subclasses__() (método type)
@anchor{reference/datamodel type __subclasses__}@anchor{573}
@deffn {Método} type.__subclasses__ ()

Cada classe mantém uma lista de referências fracas para suas subclasses imediatas. Este método retorna uma lista de todas essas referências ainda vivas. A lista está na ordem que são definidas. Exemplo:

@example
>>> class A: pass
>>> class B(A): pass
>>> A.__subclasses__()
[<class 'B'>]
@end example
@end deffn

@node Instâncias de classe<2>,Objetos de E/S também conhecidos como objetos arquivo,Classes personalizadas,A hierarquia de tipos padrão
@anchor{reference/datamodel id4}@anchor{20be}
@subsubsection Instâncias de classe


@geindex objeto;instância de classe
@geindex objeto;instância
@geindex classe;instância
@geindex instância de classe;atributo

Uma instância de classe é criada chamando um objeto classe (veja acima). Uma instância de classe tem um espaço de nomes implementado como um dicionário que é o primeiro lugar no qual as referências de atributos são pesquisadas. Quando um atributo não é encontrado lá, e a classe da instância possui um atributo com esse nome, a pesquisa continua com os atributos da classe. Se for encontrado um atributo de classe que seja um objeto função definido pelo usuário, ele é transformado em um objeto método de instância cujo atributo @ref{140f,,__self__} é a instância. Métodos estáticos e métodos de classe também são transformados; veja acima em “Classes”. Veja a seção @ref{c6a,,Implementando descritores} para outra maneira em que os atributos de uma classe recuperados através de suas instâncias podem diferir dos objetos realmente armazenados no @ref{55b,,__dict__} da classe. Se nenhum atributo de classe for encontrado, e a classe do objeto tiver um método @ref{4d3,,__getattr__()}, este é chamado para satisfazer a pesquisa.

@geindex instância de classe;atributo;atribuição

As atribuições e exclusões de atributos atualizam o dicionário da instância, nunca o dicionário de uma classe. Se a classe tem um método @ref{20bf,,__setattr__()} ou @ref{20c0,,__delattr__()}, ele é chamado ao invés de atualizar o dicionário da instância diretamente.

@geindex objeto;numérico
@geindex objeto;sequência
@geindex objeto;mapeamento

As instâncias de classe podem fingir ser números, sequências ou mapeamentos se tiverem métodos com certos nomes especiais. Veja a seção @ref{c89,,Nomes de métodos especiais}.

@menu
* Atributos especiais: Atributos especiais<2>. 

@end menu

@node Atributos especiais<2>,,,Instâncias de classe<2>
@anchor{reference/datamodel id5}@anchor{20c1}
@subsubsection Atributos especiais


@geindex __dict__ (atributo de instância)
@geindex __class__ (atributo de instância)

@geindex __class__ (atributo object)
@anchor{reference/datamodel object __class__}@anchor{14f5}
@deffn {Atributo} object.__class__

A classe à qual pertence uma instância de classe.
@end deffn

@geindex __dict__ (atributo object)
@anchor{reference/datamodel object __dict__}@anchor{55b}
@deffn {Atributo} object.__dict__

Um dicionário ou outro objeto de mapeamento usado para armazenar atributos (graváveis) de um objeto. Nem todas as instâncias têm um atributo @code{__dict__}; veja a seção sobre @ref{20c2,,__slots__} para mais detalhes.
@end deffn

@node Objetos de E/S também conhecidos como objetos arquivo,Tipos internos,Instâncias de classe<2>,A hierarquia de tipos padrão
@anchor{reference/datamodel i-o-objects-also-known-as-file-objects}@anchor{20c3}
@subsubsection Objetos de E/S (também conhecidos como objetos arquivo)


@geindex função embutida;open
@geindex módulo;io
@geindex popen() (no módulo os)
@geindex makefile() (método de socket)
@geindex sys.stdin
@geindex sys.stdout
@geindex sys.stderr
@geindex stdio
@geindex stdin (no módulo sys)
@geindex stdout (no módulo sys)
@geindex stderr (no módulo sys)

O @ref{1203,,objeto arquivo} representa um arquivo aberto. Vários atalhos estão disponíveis para criar objetos arquivos: a função embutida @ref{51c,,open()}, e também @ref{a91,,os.popen()}, @ref{20c4,,os.fdopen()} e o método @ref{11de,,makefile()} de objetos soquete (e talvez por outras funções ou métodos fornecidos por módulos de extensão).

Os objetos @code{sys.stdin}, @code{sys.stdout} e @code{sys.stderr} são inicializados para objetos arquivo que correspondem aos fluxos de entrada, saída e erro padrão do interpretador; eles são todos abertos em modo texto e, portanto, seguem a interface definida pela classe abstrata @ref{695,,io.TextIOBase}.

@node Tipos internos,,Objetos de E/S também conhecidos como objetos arquivo,A hierarquia de tipos padrão
@anchor{reference/datamodel internal-types}@anchor{20c5}
@subsubsection Tipos internos


@geindex tipo interno
@geindex tipos@comma{} internos

Alguns tipos usados internamente pelo interpretador são expostos ao usuário. Suas definições podem mudar com versões futuras do interpretador, mas são mencionadas aqui para fins de integridade.

@menu
* Objetos código:: 
* Objetos quadro:: 
* Objetos traceback:: 
* Objetos slice:: 
* Objetos método estático:: 
* Objetos método de classe:: 

@end menu

@node Objetos código,Objetos quadro,,Tipos internos
@anchor{reference/datamodel code-objects}@anchor{1d2}@anchor{reference/datamodel id6}@anchor{20c6}
@subsubsection Objetos código


@geindex bytecode
@geindex objeto;código
@geindex objeto código

Objetos código representam código Python executável `compilados em bytes' ou @ref{187,,bytecode}. A diferença entre um objeto código e um objeto função é que o objeto função contém uma referência explícita aos globais da função (o módulo no qual foi definida), enquanto um objeto código não contém nenhum contexto; também os valores de argumento padrão são armazenados no objeto função, não no objeto código (porque eles representam os valores calculados em tempo de execução). Ao contrário dos objetos função, os objetos código são imutáveis e não contêm referências (direta ou indiretamente) a objetos mutáveis.

@geindex co_argcount (atributo de objeto código)
@geindex co_posonlyargcount (atributo de objeto código)
@geindex co_kwonlyargcount (atributo de objeto código)
@geindex co_code (atributo de objeto código)
@geindex co_consts (atributo de objeto código)
@geindex co_filename (atributo de objeto código)
@geindex co_firstlineno (atributo de objeto código)
@geindex co_flags (atributo de objeto código)
@geindex co_lnotab (atributo de objeto código)
@geindex co_name (atributo de objeto código)
@geindex co_names (atributo de objeto código)
@geindex co_nlocals (atributo de objeto código)
@geindex co_stacksize (atributo de objeto código)
@geindex co_varnames (atributo de objeto código)
@geindex co_cellvars (atributo de objeto código)
@geindex co_freevars (atributo de objeto código)
@geindex co_qualname (atributo de objeto código)

@menu
* Atributos especiais de somente leitura: Atributos especiais de somente leitura<2>. 
* Métodos de objetos código:: 

@end menu

@node Atributos especiais de somente leitura<2>,Métodos de objetos código,,Objetos código
@anchor{reference/datamodel id7}@anchor{20c7}
@subsubsection Atributos especiais de somente leitura



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex co_name (atributo codeobject)
@anchor{reference/datamodel codeobject co_name}@anchor{20c8}
@deffn {Atributo} codeobject.co_name
@end deffn

@tab

O nome da função

@item

@geindex co_qualname (atributo codeobject)
@anchor{reference/datamodel codeobject co_qualname}@anchor{20c9}
@deffn {Atributo} codeobject.co_qualname
@end deffn

@tab

O nome completo da função


Adicionado na versão 3.11.


@item

@geindex co_argcount (atributo codeobject)
@anchor{reference/datamodel codeobject co_argcount}@anchor{20ca}
@deffn {Atributo} codeobject.co_argcount
@end deffn

@tab

O número total de @ref{208f,,parâmetros} posicionais (incluindo parâmetros somente-posicionais e parâmetros com valores padrão) que a função possui

@item

@geindex co_posonlyargcount (atributo codeobject)
@anchor{reference/datamodel codeobject co_posonlyargcount}@anchor{20cb}
@deffn {Atributo} codeobject.co_posonlyargcount
@end deffn

@tab

O número de @ref{208f,,parâmetros} somente-posicionais (incluindo argumentos com valores padrão) que a função possui

@item

@geindex co_kwonlyargcount (atributo codeobject)
@anchor{reference/datamodel codeobject co_kwonlyargcount}@anchor{20cc}
@deffn {Atributo} codeobject.co_kwonlyargcount
@end deffn

@tab

O número de @ref{208f,,parâmetros} somente-nomeados (incluindo argumentos com valores padrão) que a função possui

@item

@geindex co_nlocals (atributo codeobject)
@anchor{reference/datamodel codeobject co_nlocals}@anchor{20cd}
@deffn {Atributo} codeobject.co_nlocals
@end deffn

@tab

O número de @ref{208a,,variáveis locais} usadas pela função (incluindo parâmetros)

@item

@geindex co_varnames (atributo codeobject)
@anchor{reference/datamodel codeobject co_varnames}@anchor{20ce}
@deffn {Atributo} codeobject.co_varnames
@end deffn

@tab

Uma @ref{370,,tuple} contendo os nomes das variáveis locais na função (começando com os nomes dos parâmetros)

@item

@geindex co_cellvars (atributo codeobject)
@anchor{reference/datamodel codeobject co_cellvars}@anchor{20cf}
@deffn {Atributo} codeobject.co_cellvars
@end deffn

@tab

Uma @ref{370,,tuple} contendo os nomes de @ref{208a,,variáveis locais} que são referenciadas a partir de pelo menos um @ref{20d0,,escopo aninhado} de dentro da função

@item

@geindex co_freevars (atributo codeobject)
@anchor{reference/datamodel codeobject co_freevars}@anchor{208b}
@deffn {Atributo} codeobject.co_freevars
@end deffn

@tab

Uma @ref{370,,tuple} contendo os nomes de @ref{20d1,,variáveis livres (de clausura)} que um @ref{20d0,,escopo aninhado} referencia em um escopo externo. Veja também @ref{1313,,function.__closure__}.

Observação: referências a nomes globais e embutidos `não' estão incluídas.

@item

@geindex co_code (atributo codeobject)
@anchor{reference/datamodel codeobject co_code}@anchor{20d2}
@deffn {Atributo} codeobject.co_code
@end deffn

@tab

Uma string representando a sequência de instruções @ref{187,,bytecode} na função

@item

@geindex co_consts (atributo codeobject)
@anchor{reference/datamodel codeobject co_consts}@anchor{165a}
@deffn {Atributo} codeobject.co_consts
@end deffn

@tab

Um @ref{370,,tuple} contendo os literais usados pelo @ref{187,,bytecode} na função

@item

@geindex co_names (atributo codeobject)
@anchor{reference/datamodel codeobject co_names}@anchor{20d3}
@deffn {Atributo} codeobject.co_names
@end deffn

@tab

Um @ref{370,,tuple} contendo os nomes usados pelo @ref{187,,bytecode} na função

@item

@geindex co_filename (atributo codeobject)
@anchor{reference/datamodel codeobject co_filename}@anchor{13b4}
@deffn {Atributo} codeobject.co_filename
@end deffn

@tab

O nome do arquivo do qual o código foi compilado

@item

@geindex co_firstlineno (atributo codeobject)
@anchor{reference/datamodel codeobject co_firstlineno}@anchor{20d4}
@deffn {Atributo} codeobject.co_firstlineno
@end deffn

@tab

O número da linha da primeira linha da função

@item

@geindex co_lnotab (atributo codeobject)
@anchor{reference/datamodel codeobject co_lnotab}@anchor{2e0}
@deffn {Atributo} codeobject.co_lnotab
@end deffn

@tab

Uma string que codifica o mapeamento de @ref{187,,bytecode} compensa para números de linha. Para obter detalhes, consulte o código-fonte do interpretador.


Descontinuado desde a versão 3.12: Este atributo de objetos código está descontinuado e pode ser removido no Python 3.15.


@item

@geindex co_stacksize (atributo codeobject)
@anchor{reference/datamodel codeobject co_stacksize}@anchor{20d5}
@deffn {Atributo} codeobject.co_stacksize
@end deffn

@tab

O tamanho de pilha necessário do objeto código

@item

@geindex co_flags (atributo codeobject)
@anchor{reference/datamodel codeobject co_flags}@anchor{20d6}
@deffn {Atributo} codeobject.co_flags
@end deffn

@tab

Um número @ref{257,,inteiro} codificando uma série de sinalizadores para o interpretador.

@end multitable


@geindex objeto;gerador

Os seguintes bits sinalizadores são definidos para @ref{20d6,,co_flags}: o bit @code{0x04} é definido se a função usa a sintaxe @code{*arguments} para aceitar um número arbitrário de argumentos posicionais; o bit @code{0x08} é definido se a função usa a sintaxe @code{**keywords} para aceitar argumentos nomeados arbitrários; o bit @code{0x20} é definido se a função for um gerador. Veja @ref{20d7,,Code Objects Bit Flags} para detalhes na semântica de cada sinalizadores que podem estar presentes.

Declarações de recursos futuros (por exemplo, @code{from __future__ import division}) também usam bits em @ref{20d6,,co_flags} para indicar se um objeto código foi compilado com um recurso específico habilitado. Veja @ref{20d8,,compiler_flag}.

Outros bits em @ref{20d6,,co_flags} são reservados para uso interno.

@geindex string de documentação

Se um objeto código representa uma função, o primeiro item em @ref{165a,,co_consts} é a string de documentação da função, ou @code{None} se indefinido.

@node Métodos de objetos código,,Atributos especiais de somente leitura<2>,Objetos código
@anchor{reference/datamodel methods-on-code-objects}@anchor{20d9}
@subsubsection Métodos de objetos código


@geindex co_positions() (método codeobject)
@anchor{reference/datamodel codeobject co_positions}@anchor{5b3}
@deffn {Método} codeobject.co_positions ()

Retorna um iterável das posições no código-fonte de cada instrução @ref{187,,bytecode} no objeto código.

O iterador retorna @ref{370,,tuple}s contendo @code{(start_line, end_line, start_column, end_column)}. A `i-nésima' tupla corresponde à posição do código-fonte que compilou para a `i-nésima' unidade de código. As informações da coluna são deslocamentos de bytes utf-8 indexados em 0 na linha de código fornecida.

A informação posicional pode estar ausente. Veja uma lista não-exaustiva de casos onde isso pode acontecer:


@itemize -

@item 
Executando o interpretador com @code{no_debug_ranges} @ref{176,,-X}.

@item 
Carregando um arquivo pyc compilado com @code{no_debug_ranges} @ref{176,,-X}.

@item 
Tuplas posicionais correspondendo a instruções artificiais.

@item 
Números de linha e coluna que não podem ser representados devido a limitações específicas de implementação.
@end itemize

Quando isso ocorre, alguns ou todos elementos da tupla podem ser @ref{675,,None}.


Adicionado na versão 3.11.


@cartouche
@quotation Nota 
Esse recurso requer o armazenamento de posições de coluna no objeto código, o que pode resultar em um pequeno aumento no uso de memória do interpretador e no uso de disco para arquivos Python compilados. Para evitar armazenar as informações extras e/ou desativar a exibição das informações extras de rastreamento, use a opção de linha de comando @code{no_debug_ranges}  @ref{176,,-X} ou a variável de ambiente 
@geindex PYTHONNODEBUGRANGES
@geindex variável de ambiente; PYTHONNODEBUGRANGES
@ref{5b6,,PYTHONNODEBUGRANGES}.
@end quotation
@end cartouche
@end deffn

@geindex co_lines() (método codeobject)
@anchor{reference/datamodel codeobject co_lines}@anchor{2fb}
@deffn {Método} codeobject.co_lines ()

Retorna um iterador que produz informações sobre intervalos sucessivos de @ref{187,,bytecode}s. Cada item gerado é uma @ref{370,,tuple} de @code{(start, end, lineno)}:


@itemize *

@item 
@code{start} (um @ref{257,,int}) representa o deslocamento (inclusivo) do início do intervalo @ref{187,,bytecode}

@item 
@code{end} (um @ref{257,,int}) representa o deslocamento (exclusivo) do fim do intervalo @ref{187,,bytecode}

@item 
@code{lineno} é um @ref{257,,int} representando o número da linha do intervalo do @ref{187,,bytecode}, ou @code{None} se os bytecodes no intervalo fornecido não tiverem número de linha
@end itemize

Os itens gerados terão as seguintes propriedades:


@itemize *

@item 
O primeiro intervalo gerado terá um @code{start} de 0.

@item 
Os intervalos @code{(start, end)} serão não decrescentes e consecutivos. Ou seja, para qualquer par de @ref{370,,tuple}s, o @code{start} do segundo será igual ao @code{end} do primeiro.

@item 
Nenhum intervalo será inverso: @code{end >= start} para todos os trios.

@item 
A última @ref{370,,tuple} gerada terá @code{end} igual ao tamanho do @ref{187,,bytecode}.
@end itemize

Intervalos de largura zero, onde @code{start == end}, são permitidos. Intervalos de largura zero são usados para linhas que estão presentes no código-fonte, mas foram eliminadas pelo compilador de @ref{187,,bytecode}.


Adicionado na versão 3.10.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 626

@item PEP 626@footnote{https://peps.python.org/pep-0626/} - Números de linha precisos para depuração e outras ferramentas.

A PEP que introduziu o método @code{co_lines()}.
@end table

@end deffn

@geindex replace() (método codeobject)
@anchor{reference/datamodel codeobject replace}@anchor{20da}
@deffn {Método} codeobject.replace (**kwargs)

Retorna uma cópia do objeto de código com novos valores para os campos especificados.

Objetos de código também são suportados pela função genérica @ref{151,,copy.replace()}.


Adicionado na versão 3.8.

@end deffn

@node Objetos quadro,Objetos traceback,Objetos código,Tipos internos
@anchor{reference/datamodel frame-objects}@anchor{6e0}@anchor{reference/datamodel id8}@anchor{20db}
@subsubsection Objetos quadro


@geindex objeto;quadro

Objetos quadro representam quadros de execução. Eles podem ocorrer em @ref{b07,,objetos traceback} e também são passados para funções de rastreamento registradas.

@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
* Atributos especiais de somente leitura: Atributos especiais de somente leitura<3>. 
* Atributos especiais graváveis: Atributos especiais graváveis<2>. 
* Métodos de objetos quadro:: 

@end menu

@node Atributos especiais de somente leitura<3>,Atributos especiais graváveis<2>,,Objetos quadro
@anchor{reference/datamodel id9}@anchor{20dc}
@subsubsection Atributos especiais de somente leitura



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_back (atributo frame)
@anchor{reference/datamodel frame f_back}@anchor{78c}
@deffn {Atributo} frame.f_back
@end deffn

@tab

Aponta para o quadro de pilha anterior (em direção ao chamador), ou @code{None} se este for o quadro de pilha mais abaixo.

@item

@geindex f_code (atributo frame)
@anchor{reference/datamodel frame f_code}@anchor{20dd}
@deffn {Atributo} frame.f_code
@end deffn

@tab

O @ref{1d2,,objeto código} sendo executado neste quadro. Acessar este atributo levanta um @ref{19fa,,evento de auditoria} @code{object.__getattr__} com os argumentos @code{obj} e @code{"f_code"}.

@item

@geindex f_locals (atributo frame)
@anchor{reference/datamodel frame f_locals}@anchor{182}
@deffn {Atributo} frame.f_locals
@end deffn

@tab

O mapeamento usado pelo quadro para procurar @ref{208a,,variáveis locais}. Se o quadro se referir a um @ref{17e,,escopo otimizado}, isso pode retornar um objeto proxy write-through.


Alterado na versão 3.13: Retorna um proxy para escopos otimizados.


@item

@geindex f_globals (atributo frame)
@anchor{reference/datamodel frame f_globals}@anchor{20de}
@deffn {Atributo} frame.f_globals
@end deffn

@tab

O dicionário usado pelo quadro para procurar @ref{208a,,variáveis globais}

@item

@geindex f_builtins (atributo frame)
@anchor{reference/datamodel frame f_builtins}@anchor{20df}
@deffn {Atributo} frame.f_builtins
@end deffn

@tab

O dicionário usado pelo quadro para procurar @ref{208a,,nomes embutidos (intrínsecos)}

@item

@geindex f_lasti (atributo frame)
@anchor{reference/datamodel frame f_lasti}@anchor{88c}
@deffn {Atributo} frame.f_lasti
@end deffn

@tab

A “instrução precisa” do objeto quadro (este é um índice na string @ref{187,,bytecode} do @ref{1d2,,objeto código})

@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 Atributos especiais graváveis<2>,Métodos de objetos quadro,Atributos especiais de somente leitura<3>,Objetos quadro
@anchor{reference/datamodel id10}@anchor{20e0}
@subsubsection Atributos especiais graváveis



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_trace (atributo frame)
@anchor{reference/datamodel frame f_trace}@anchor{20e1}
@deffn {Atributo} frame.f_trace
@end deffn

@tab

Se não for @code{None}, esta é uma função chamada para vários eventos durante a execução do código (isso é usado por depuradores). Normalmente, um evento é disparado para cada nova linha de origem (veja @ref{bf6,,f_trace_lines}).

@item

@geindex f_trace_lines (atributo frame)
@anchor{reference/datamodel frame f_trace_lines}@anchor{bf6}
@deffn {Atributo} frame.f_trace_lines
@end deffn

@tab

Defina este atributo como @ref{b49,,False} para desabilitar o acionamento de um evento de rastreamento para cada linha de origem.

@item

@geindex f_trace_opcodes (atributo frame)
@anchor{reference/datamodel frame f_trace_opcodes}@anchor{bf7}
@deffn {Atributo} frame.f_trace_opcodes
@end deffn

@tab

Defina este atributo para @ref{c27,,True} para permitir que eventos por opcode sejam solicitados. Observe que isso pode levar a um comportamento indefinido do interpretador se as exceções levantadas pela função de rastreamento escaparem para a função que está sendo rastreada.

@item

@geindex f_lineno (atributo frame)
@anchor{reference/datamodel frame f_lineno}@anchor{7ad}
@deffn {Atributo} frame.f_lineno
@end deffn

@tab

O número da linha atual do quadro – escrever para isso de dentro de uma função de rastreamento faz saltar para a linha dada (apenas para o quadro mais abaixo). Um depurador pode implementar um comando Jump (também conhecido como Set Next Statement) escrevendo para esse atributo.

@end multitable


@node Métodos de objetos quadro,,Atributos especiais graváveis<2>,Objetos quadro
@anchor{reference/datamodel frame-object-methods}@anchor{20e2}
@subsubsection Métodos de objetos quadro


Objetos quadro têm suporte a um método:

@geindex clear() (método frame)
@anchor{reference/datamodel frame clear}@anchor{280}
@deffn {Método} frame.clear ()

Este método limpa todas as referências a @ref{208a,,variáveis locais} mantidas pelo quadro. Além disso, se o quadro pertencer a um @ref{109a,,gerador}, o gerador é finalizado. Isso ajuda a quebrar os ciclos de referência que envolvem objetos quadro (por exemplo, ao capturar uma @ref{19b1,,exceção} e armazenar seu @ref{b07,,traceback} para uso posterior).

@ref{195,,RuntimeError} é levantada se o quadro estiver em execução ou suspenso.


Adicionado na versão 3.4.



Alterado na versão 3.13: Tentar limpar um quadro suspenso levanta @ref{195,,RuntimeError} (como sempre foi o caso para quadros em execução).

@end deffn

@node Objetos traceback,Objetos slice,Objetos quadro,Tipos internos
@anchor{reference/datamodel id11}@anchor{20e3}@anchor{reference/datamodel traceback-objects}@anchor{b07}
@subsubsection Objetos traceback


@geindex objeto;traceback
@geindex pilha (stack);rastro (trace)
@geindex exceção;manipulador (handler)
@geindex execução;pilha (stack)
@geindex exc_info (no módulo sys)
@geindex last_traceback (no módulo sys)
@geindex sys.exc_info
@geindex sys.exception
@geindex sys.last_traceback

Objetos traceback representam o stack trace (situação da pilha de execução) de uma @ref{1e12,,exceção}. Um objeto traceback é criado implicitamente quando ocorre uma exceção e também pode ser criado explicitamente chamando @ref{b05,,types.TracebackType}.


Alterado na versão 3.7: Objetos traceback agora podem ser instanciados explicitamente a partir de código Python.


Para tracebacks criados implicitamente, quando a busca por um manipulador de exceção desenrola a pilha de execução, em cada nível desenrolado um objeto traceback é inserido na frente do traceback atual. Quando um manipulador de exceção é inserido, o stack trace é disponibilizado para o programa. (Veja a seção @ref{6e9,,A instrução try}.) É acessível como o terceiro item da tupla retornada por @ref{68a,,sys.exc_info()}, e como o atributo @ref{1309,,__traceback__} da exceção capturada.

Quando o programa não contém um manipulador adequado, o stack trace é escrito (formatado de maneira adequada) no fluxo de erro padrão; se o interpretador for interativo, ele também é disponibilizado ao usuário como @ref{4c1,,sys.last_traceback}.

Para tracebacks criados explicitamente, cabe ao criador do traceback determinar como os atributos @ref{b06,,tb_next} devem ser vinculados para formar um stack trace completo.

@geindex tb_frame (atributo de traceback)
@geindex tb_lineno (atributo de traceback)
@geindex tb_lasti (atributo de traceback)
@geindex instrução;try

Atributos especiais de somente leitura:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex tb_frame (atributo traceback)
@anchor{reference/datamodel traceback tb_frame}@anchor{20e4}
@deffn {Atributo} traceback.tb_frame
@end deffn

@tab

Aponta para o @ref{6e0,,quadro} de execução do nível atual.

Acessar este atributo levanta um @ref{19fa,,evento de auditoria} @code{object.__getattr__} com os argumentos @code{obj} e @code{"tb_frame"}.

@item

@geindex tb_lineno (atributo traceback)
@anchor{reference/datamodel traceback tb_lineno}@anchor{20e5}
@deffn {Atributo} traceback.tb_lineno
@end deffn

@tab

Fornece o número da linha onde ocorreu a exceção

@item

@geindex tb_lasti (atributo traceback)
@anchor{reference/datamodel traceback tb_lasti}@anchor{20e6}
@deffn {Atributo} traceback.tb_lasti
@end deffn

@tab

Indica a “instrução precisa”.

@end multitable


O número da linha e a última instrução no traceback podem diferir do número da linha do seu @ref{6e0,,objeto quadro} se a exceção ocorreu em uma instrução @ref{6e9,,try} sem cláusula except correspondente ou com uma cláusula @ref{9d2,,finally}.

@geindex tb_next (atributo de traceback)

@geindex tb_next (atributo traceback)
@anchor{reference/datamodel traceback tb_next}@anchor{b06}
@deffn {Atributo} traceback.tb_next

O atributo especial de escrita @code{tb_next} é o próximo nível no stack trace (em direção ao quadro onde a exceção ocorreu), ou @code{None} se não houver próximo nível.


Alterado na versão 3.7: Este atributo agora é gravável

@end deffn

@node Objetos slice,Objetos método estático,Objetos traceback,Tipos internos
@anchor{reference/datamodel slice-objects}@anchor{20e7}
@subsubsection Objetos slice


@geindex função embutida;fatia

Objetos slice são usados para representar fatias para métodos @ref{283,,__getitem__()}. Eles também são criados pela função embutida @ref{469,,slice()}.

@geindex start (atributo de objeto fatia)
@geindex stop (atributo de objeto fatia)
@geindex step (atributo de objeto fatia)

Atributos especiais de somente leitura: @ref{20e8,,start} é o limite inferior; @ref{20e9,,stop} é o limite superior; @ref{20ea,,step} é o valor da diferença entre elementos subjacentes; cada um desses atributos é @code{None} se omitido. Esses atributos podem ter qualquer tipo.

Objetos slice têm suporte a um método:

@geindex indices() (método slice)
@anchor{reference/datamodel slice indices}@anchor{105d}
@deffn {Método} slice.indices (self, length)

Este método recebe um único argumento inteiro `length' e calcula informações sobre a fatia que o objeto slice descreveria se aplicado a uma sequência de itens de `length'. Ele retorna uma tupla de três inteiros; respectivamente, estes são os índices `start' e `stop' e o `step' ou comprimento de avanços da fatia. Índices ausentes ou fora dos limites são tratados de maneira consistente com fatias regulares.
@end deffn

@node Objetos método estático,Objetos método de classe,Objetos slice,Tipos internos
@anchor{reference/datamodel static-method-objects}@anchor{20eb}
@subsubsection Objetos método estático


Objetos método estático fornecem uma forma de transformar objetos função em objetos métodos descritos acima. Um objeto método estático é um invólucro em torno de qualquer outro objeto, comumente um objeto método definido pelo usuário. Quando um objeto método estático é recuperado de uma classe ou de uma instância de classe, o objeto retornado é o objeto encapsulado, do qual não está sujeito a nenhuma transformação adicional. Objetos método estático também são chamáveis. Objetos método estático são criados pelo construtor embutido @ref{416,,staticmethod()}.

@node Objetos método de classe,,Objetos método estático,Tipos internos
@anchor{reference/datamodel class-method-objects}@anchor{20ec}
@subsubsection Objetos método de classe


Um objeto método de classe, como um objeto método estático, é um invólucro em torno de outro objeto que altera a maneira como esse objeto é recuperado de classes e instâncias de classe. O comportamento dos objetos método de classe após tal recuperação é descrito acima, sob @ref{1e47,,“métodos de instância”}. Objetos método de classe são criados pelo construtor embutido @ref{166,,classmethod()}.

@node Nomes de métodos especiais,Corrotinas,A hierarquia de tipos padrão,Modelo de dados
@anchor{reference/datamodel special-method-names}@anchor{20ed}@anchor{reference/datamodel specialnames}@anchor{c89}
@subsection Nomes de métodos especiais


@geindex operador;sobrecarga
@geindex __getitem__() (método de objeto mapeamento)

Uma classe pode implementar certas operações que são chamadas por sintaxe especial (como operações aritméticas ou indexação e fatiamento), definindo métodos com nomes especiais. Esta é a abordagem do Python para `sobrecarga de operador', permitindo que as classes definam seu próprio comportamento em relação aos operadores da linguagem. Por exemplo, se uma classe define um método chamado @ref{283,,__getitem__()}, e @code{x} é uma instância desta classe, então @code{x[i]} é aproximadamente equivalente a @code{type(x).__getitem__(x, i)}. Exceto onde mencionado, as tentativas de executar uma operação levantam uma exceção quando nenhum método apropriado é definido (tipicamente @ref{34b,,AttributeError} ou @ref{2c3,,TypeError}).

Definir um método especial para @code{None} indica que a operação correspondente não está disponível. Por exemplo, se uma classe define @ref{c8a,,__iter__()} para @code{None}, a classe não é iterável, então chamar @ref{7d8,,iter()} em suas instâncias irá levantar um @ref{2c3,,TypeError} (sem recorrer a @ref{283,,__getitem__()}). @footnote{
Os métodos @ref{b0e,,__hash__()}, @ref{c8a,,__iter__()}, @ref{ca7,,__reversed__()} e @ref{1400,,__contains__()}, @ref{73b,,__class_getitem__()} e @ref{c6d,,__fspath__()} têm um tratamento especial para isso. Outros ainda irão levantar um @ref{2c3,,TypeError}, mas podem fazer isso contando com o comportamento de que @code{None} não é chamável.
}

Ao implementar uma classe que emula qualquer tipo embutido, é importante que a emulação seja implementada apenas na medida em que faça sentido para o objeto que está sendo modelado. Por exemplo, algumas sequências podem funcionar bem com a recuperação de elementos individuais, mas extrair uma fatia pode não fazer sentido. (Um exemplo disso é a interface @code{NodeList} no Document Object Model do W3C.)

@menu
* Personalização básica:: 
* Personalizando o acesso aos atributos:: 
* Personalizando a criação de classe:: 
* Personalizando verificações de instância e subclasse:: 
* Emulando tipos genéricos:: 
* Emulando objetos chamáveis:: 
* Emulando tipos contêineres:: 
* Emulando tipos numéricos:: 
* Gerenciadores de contexto da instrução with:: 
* Customizando argumentos posicionais na classe correspondência de padrão:: 
* Emulando tipos buffer:: 
* Pesquisa de método especial:: 

@end menu

@node Personalização básica,Personalizando o acesso aos atributos,,Nomes de métodos especiais
@anchor{reference/datamodel basic-customization}@anchor{20ee}@anchor{reference/datamodel customization}@anchor{20ef}
@subsubsection Personalização básica


@geindex __new__() (método object)
@anchor{reference/datamodel object __new__}@anchor{580}
@deffn {Método} object.__new__ (cls[, ...])

@geindex subclasse;tipos imutáveis

Chamado para criar uma nova instância da classe `cls'. @ref{580,,__new__()} é um método estático (é um caso especial, então você não precisa declará-lo como tal) que recebe a classe da qual uma instância foi solicitada como seu primeiro argumento. Os argumentos restantes são aqueles passados para a expressão do construtor do objeto (a chamada para a classe). O valor de retorno de @ref{580,,__new__()} deve ser a nova instância do objeto (geralmente uma instância de `cls').

Implementações típicas criam uma nova instância da classe invocando o método @ref{580,,__new__()} da superclasse usando @code{super().__new__(cls[, ...])} com os argumentos apropriados e, em seguida, modificando a instância recém-criada conforme necessário antes de retorná-la.

Se @ref{580,,__new__()} é chamado durante a construção do objeto e retorna uma instância de `cls', então o método @ref{6b0,,__init__()} da nova instância será chamado como @code{__init__(self[, ...])}, onde `self' é a nova instância e os argumentos restantes são os mesmos que foram passados para o construtor do objeto.

Se @ref{580,,__new__()} não retornar uma instância de `cls', então o método @ref{6b0,,__init__()} da nova instância não será invocado.

@ref{580,,__new__()} destina-se principalmente a permitir que subclasses de tipos imutáveis (como int, str ou tupla) personalizem a criação de instâncias. Também é comumente substituído em metaclasses personalizadas para personalizar a criação de classes.
@end deffn

@geindex __init__() (método object)
@anchor{reference/datamodel object __init__}@anchor{6b0}
@deffn {Método} object.__init__ (self[, ...])

@geindex classe;construtor

Chamado após a instância ter sido criada (por @ref{580,,__new__()}), mas antes de ser retornada ao chamador. Os argumentos são aqueles passados para a expressão do construtor da classe. Se uma classe base tem um método @ref{6b0,,__init__()}, o método @ref{6b0,,__init__()} da classe derivada, se houver, deve chamá-lo explicitamente para garantir a inicialização apropriada da parte da classe base da instância; por exemplo: @code{super().__init__([args...])}.

Porque @ref{580,,__new__()} e @ref{6b0,,__init__()} trabalham juntos na construção de objetos (@ref{580,,__new__()} para criá-lo e @ref{6b0,,__init__()} para personalizá-lo), nenhum valor diferente de @code{None} pode ser retornado por @ref{6b0,,__init__()}; fazer isso fará com que uma @ref{2c3,,TypeError} seja levantada em tempo de execução.
@end deffn

@geindex __del__() (método object)
@anchor{reference/datamodel object __del__}@anchor{1033}
@deffn {Método} object.__del__ (self)

@geindex destrutor
@geindex finalizador
@geindex instrução;del

Chamado quando a instância está prestes a ser destruída. Também é chamada de finalizador ou (incorretamente) de destruidor. Se uma classe base tem um método @ref{1033,,__del__()}, o método @ref{1033,,__del__()} da classe derivada, se houver, deve chamá-lo explicitamente para garantir a exclusão adequada da parte da classe base da instância.

É possível (embora não recomendado!) para o método @ref{1033,,__del__()} adiar a destruição da instância criando uma nova referência a ela. Isso é chamado de `ressurreição' de objeto. Depende se a implementação de @ref{1033,,__del__()} é chamado uma segunda vez quando um objeto ressuscitado está prestes a ser destruído; a implementação atual do @ref{6f6,,CPython} chama-o apenas uma vez.

Não há garantia de que os métodos @ref{1033,,__del__()} sejam chamados para objetos que ainda existem quando o interpretador sai. @ref{a86,,weakref.finalize} fornece uma maneira direta de registrar uma função de limpeza a ser chamada quando um objeto é coletado como lixo.

@cartouche
@quotation Nota 
@code{del x} não chama diretamente @code{x.__del__()} – o primeiro diminui a contagem de referências para @code{x} em um, e o segundo só é chamado quando a contagem de referências de @code{x} atinge zero.
@end quotation
@end cartouche

É possível que um ciclo de referência impeça que a contagem de referência de um objeto chegue a zero. Neste caso, mais tarde, o ciclo será detectado e deletado pelo @ref{1a69,,coletor de lixo cíclico}.  Uma causa comum de referências cíclicas é quando uma exceção foi capturada em uma variável local. O locals do quadro então referencia a exceção, que referencia seu próprio traceback, que referencia o locals de todos os quadros capturados no traceback.


@subsubheading Ver também


Documentação do módulo @ref{60,,gc}.


@cartouche
@quotation Aviso 
Devido às circunstâncias precárias sob as quais os métodos @ref{1033,,__del__()} são invocados, as exceções que ocorrem durante sua execução são ignoradas e um aviso é impresso em @code{sys.stderr} em seu lugar. Em particular:


@itemize *

@item 
@ref{1033,,__del__()} pode ser chamado quando um código arbitrário está sendo executado, incluindo de qualquer thread arbitrária. Se @ref{1033,,__del__()} precisa bloquear ou invocar qualquer outro recurso de bloqueio, pode ocorrer um impasse, pois o recurso já pode ter sido levado pelo código que é interrompido para executar @ref{1033,,__del__()}.

@item 
@ref{1033,,__del__()} pode ser executado durante o encerramento do interpretador. Como consequência, as variáveis globais que ele precisa acessar (incluindo outros módulos) podem já ter sido excluídas ou definidas como @code{None}. Python garante que os globais cujo nome comece com um único sublinhado sejam excluídos de seu módulo antes que outros globais sejam excluídos; se nenhuma outra referência a tais globais existir, isso pode ajudar a garantir que os módulos importados ainda estejam disponíveis no momento em que o método @ref{1033,,__del__()} for chamado.
@end itemize
@end quotation
@end cartouche

@geindex repr() (função embutida);__repr__() (método de objeto)
@end deffn

@geindex __repr__() (método object)
@anchor{reference/datamodel object __repr__}@anchor{61c}
@deffn {Método} object.__repr__ (self)

Chamado pela função embutida @ref{800,,repr()} para calcular a representação da string “oficial” de um objeto. Se possível, isso deve parecer uma expressão Python válida que pode ser usada para recriar um objeto com o mesmo valor (dado um ambiente apropriado). Se isso não for possível, uma string no formato @code{<...alguma descrição útil...>} deve ser retornada. O valor de retorno deve ser um objeto string. Se uma classe define @ref{61c,,__repr__()}, mas não @ref{61d,,__str__()}, então @ref{61c,,__repr__()} também é usado quando uma representação de string “informal” de instâncias daquela classe é necessária.

Isso é normalmente usado para depuração, portanto, é importante que a representação seja rica em informações e inequívoca. Uma implementação padrão é fornecida pela própria classe @ref{a96,,object}.

@geindex string;__str__() (método de objeto)
@geindex format() (função embutida);__str__() (método de objeto)
@geindex print() (função embutida);__str__() (método de objeto)
@end deffn

@geindex __str__() (método object)
@anchor{reference/datamodel object __str__}@anchor{61d}
@deffn {Método} object.__str__ (self)

Chamado por @ref{44c,,str(object)}, a implementação padrão de @ref{61e,,__format__()}, e as funções embutidas @ref{fa9,,print()}, para calcular a representação da string “informal” ou agradável para exibição de um objeto. O valor de retorno deve ser um objeto @ref{1d7a,,str}.

Este método difere de @ref{61c,,object.__repr__()} por não haver expectativa de que @ref{61d,,__str__()} retorne uma expressão Python válida: uma representação mais conveniente ou concisa pode ser usada.

A implementação padrão definida pelo tipo embutido @ref{a96,,object} chama @ref{61c,,object.__repr__()}.

@c XXX what about subclasses of string?
@end deffn

@geindex __bytes__() (método object)
@anchor{reference/datamodel object __bytes__}@anchor{5e8}
@deffn {Método} object.__bytes__ (self)

@geindex função embutida;bytes

Chamado por @ref{1c33,,bytes} para calcular uma representação de string de bytes de um objeto. Isso deve retornar um objeto @ref{1c2,,bytes}. A classe @ref{a96,,object} em si não fornece este método.

@geindex string;__format__() (método de objeto)
@geindex string;conversão
@geindex função embutida;print
@end deffn

@geindex __format__() (método object)
@anchor{reference/datamodel object __format__}@anchor{61e}
@deffn {Método} object.__format__ (self, format_spec)

Chamado pela função embutida @ref{61f,,format()} e, por extensão, avaliação de @ref{9b1,,literais de string formatadas} e o método @ref{621,,str.format()}, para produzir uma representação de string “formatada” de um objeto. O argumento `format_spec' é uma string que contém uma descrição das opções de formatação desejadas. A interpretação do argumento `format_spec' depende do tipo que implementa @ref{61e,,__format__()}, entretanto a maioria das classes delegará a formatação a um dos tipos embutidos ou usará uma sintaxe de opção de formatação semelhante.

Consulte @ref{1e8,,Minilinguagem de especificação de formato} para uma descrição da sintaxe de formatação padrão.

O valor de retorno deve ser um objeto string.

A implementação padrão pela classe @ref{a96,,object} deve receber uma string `format_spec' vazia. Ela delega para @ref{61d,,__str__()}.


Alterado na versão 3.4: O método __format__ do próprio @code{object} levanta uma @ref{2c3,,TypeError} se passada qualquer string não vazia.



Alterado na versão 3.7: @code{object.__format__(x, '@w{'})} é agora equivalente a @code{str(x)} em vez de @code{format(str(x), '@w{'})}.

@end deffn

@geindex __lt__() (método object)
@geindex __le__() (método object)
@geindex __eq__() (método object)
@geindex __ne__() (método object)
@geindex __gt__() (método object)
@geindex __ge__() (método object)
@anchor{reference/datamodel richcmpfuncs}@anchor{20f0}@anchor{reference/datamodel object __lt__}@anchor{12e2}
@deffn {Método} object.__lt__ (self, other)
@anchor{reference/datamodel object __le__}@anchor{134f}
@deffnx {Método} object.__le__ (self, other)
@anchor{reference/datamodel object __eq__}@anchor{b0d}
@deffnx {Método} object.__eq__ (self, other)
@anchor{reference/datamodel object __ne__}@anchor{1560}
@deffnx {Método} object.__ne__ (self, other)
@anchor{reference/datamodel object __gt__}@anchor{1350}
@deffnx {Método} object.__gt__ (self, other)
@anchor{reference/datamodel object __ge__}@anchor{1351}
@deffnx {Método} object.__ge__ (self, other)

@geindex comparações

Esses são os chamados métodos de “comparação rica”. A correspondência entre os símbolos do operador e os nomes dos métodos é a seguinte: @code{x<y} chama @code{x.__lt__(y)}, @code{x<=y} chama @code{x.__le__(y)}, @code{x==y} chama @code{x.__eq__(y)}, @code{x!=y} chama @code{x.__ne__(y)}, @code{x>y} chama @code{x.__gt__(y)} e @code{x>=y} chama @code{x.__ge__(y)}.

Um método de comparação rica pode retornar o singleton @ref{7d3,,NotImplemented} se não implementar a operação para um determinado par de argumentos. Por convenção, @code{False} e @code{True} são retornados para uma comparação bem-sucedida. No entanto, esses métodos podem retornar qualquer valor, portanto, se o operador de comparação for usado em um contexto booleano (por exemplo, na condição de uma instrução @code{if}), Python irá chamar @ref{468,,bool()} no valor para determinar se o resultado for verdadeiro ou falso.

Por padrão, @code{object} implementa @ref{b0d,,__eq__()} usando @code{is}, retornando @ref{7d3,,NotImplemented} no caso de uma comparação falsa: @code{True if x is y else NotImplemented}. Para @ref{1560,,__ne__()}, por padrão ele delega para @ref{b0d,,__eq__()} e inverte o resultado a menos que seja @code{NotImplemented}. Não há outras relações implícitas entre os operadores de comparação ou implementações padrão; por exemplo, o valor verdadeiro de @code{(x<y or x==y)} não implica @code{x<=y}. Para gerar operações de ordenação automaticamente a partir de uma única operação raiz, consulte @ref{f75,,functools.total_ordering()}.

Por padrão, a classe @ref{a96,,object} fornece implementações consistentes com @ref{19a9,,Comparações de valor}: igualdade compara de acordo com a identidade do objeto, e comparações de ordem levantam @ref{2c3,,TypeError}. Cada método padrão pode gerar esses resultados diretamente, mas também pode retornar @ref{7d3,,NotImplemented}.

Veja o parágrafo sobre @ref{b0e,,__hash__()} para algumas notas importantes sobre a criação de objetos @ref{610,,hasheáveis} que implementam operações de comparação personalizadas e são utilizáveis como chaves de dicionário.

Não há versões de argumentos trocados desses métodos (a serem usados quando o argumento esquerdo não tem suporte à operação, mas o argumento direito sim); em vez disso, @ref{12e2,,__lt__()} e @ref{1350,,__gt__()} são o reflexo um do outro, @ref{134f,,__le__()} e @ref{1351,,__ge__()} são o reflexo um do outro, e @ref{b0d,,__eq__()} e @ref{1560,,__ne__()} são seu próprio reflexo. Se os operandos são de tipos diferentes e o tipo do operando direito é uma subclasse direta ou indireta do tipo do operando esquerdo, o método refletido do operando direito tem prioridade, caso contrário, o método do operando esquerdo tem prioridade. Subclasse virtual não é considerada.

Quando nenhum método apropriado retorna qualquer valor diferente de @ref{7d3,,NotImplemented}, os operadores @code{==} e @code{!=} retornarão para @code{is} e @code{is not}, respectivamente.
@end deffn

@geindex __hash__() (método object)
@anchor{reference/datamodel object __hash__}@anchor{b0e}
@deffn {Método} object.__hash__ (self)

@geindex objeto;dicionário
@geindex função embutida;hash

Chamado pela função embutida @ref{5eb,,hash()} e para operações em membros de coleções com hash incluindo @ref{5d9,,set}, @ref{5da,,frozenset} e @ref{256,,dict}. O método @code{__hash__()} deve retornar um inteiro. A única propriedade necessária é que os objetos que são comparados iguais tenham o mesmo valor de hash; é aconselhável misturar os valores hash dos componentes do objeto que também desempenham um papel na comparação dos objetos, empacotando-os em uma tupla e fazendo o hash da tupla. Exemplo:

@example
def __hash__(self):
    return hash((self.name, self.nick, self.color))
@end example

@cartouche
@quotation Nota 
@ref{5eb,,hash()} trunca o valor retornado do método @ref{b0e,,__hash__()} personalizado de um objeto para o tamanho de um @ref{a69,,Py_ssize_t}. Isso é normalmente 8 bytes em compilações de 64 bits e 4 bytes em compilações de 32 bits. Se o @ref{b0e,,__hash__()} de um objeto deve interoperar em compilações de tamanhos de bits diferentes, certifique-se de verificar a largura em todas as compilações com suporte. Uma maneira fácil de fazer isso é com @code{python -c "import sys; print(sys.hash_info.width)"}.
@end quotation
@end cartouche

Se uma classe não define um método @ref{b0d,,__eq__()}, ela também não deve definir uma operação @ref{b0e,,__hash__()}; se define @ref{b0d,,__eq__()} mas não @ref{b0e,,__hash__()}, suas instâncias não serão utilizáveis como itens em coleções hasheáveis. Se uma classe define objetos mutáveis e implementa um método @ref{b0d,,__eq__()}, ela não deve implementar @ref{b0e,,__hash__()}, uma vez que a implementação de coleções  @ref{610,,hasheáveis} requer que o valor hash de uma chave seja imutável (se o valor hash do objeto mudar, estará no balde de hash errado).

As classes definidas pelo usuário têm os métodos @ref{b0d,,__eq__()} e @ref{b0e,,__hash__()} por padrão (herdados da classe @ref{a96,,object}); com eles, todos os objetos se comparam desiguais (exceto com eles mesmos) e @code{x.__hash__()} retorna um valor apropriado tal que @code{x == y} implica que @code{x is y} e @code{hash(x) == hash(y)}.

Uma classe que sobrescreve @ref{b0d,,__eq__()} e não define @ref{b0e,,__hash__()} terá seu @ref{b0e,,__hash__()} implicitamente definido como @code{None}. Quando o método @ref{b0e,,__hash__()} de uma classe é @code{None}, as instâncias da classe levantam uma @ref{2c3,,TypeError} apropriada quando um programa tenta recuperar seu valor hash, e também será identificado corretamente como não-hasheável ao verificar @code{isinstance(obj, collections.abc.Hashable)}.

Se uma classe que substitui @ref{b0d,,__eq__()} precisa manter a implementação de @ref{b0e,,__hash__()} de uma classe base, o interpretador deve ser informado disso explicitamente pela configuração @code{__hash__ = <ClasseBase>.__hash__}.

Se uma classe que não substitui @ref{b0d,,__eq__()} deseja suprimir o suporte a hash, deve incluir @code{__hash__ = None} na definição de classe. Uma classe que define seu próprio @ref{b0e,,__hash__()} que levanta explicitamente uma @ref{2c3,,TypeError} seria incorretamente identificada como hasheável por uma chamada @code{isinstance(obj, collections.abc.Hashable)}.

@cartouche
@quotation Nota 
Por padrão, os valores @ref{b0e,,__hash__()} dos objetos str e bytes são “salgados” com um valor aleatório imprevisível. Embora permaneçam constantes em um processo individual do Python, eles não são previsíveis entre invocações repetidas do Python.

Isso se destina a fornecer proteção contra uma negação de serviço causada por entradas cuidadosamente escolhidas que exploram o pior caso de desempenho de uma inserção de dicionário, complexidade `O'(`n'@w{^2}). Consulte @indicateurl{http://ocert.org/advisories/ocert-2011-003.html} para obter detalhes.

Alterar os valores de hash afeta a ordem de iteração dos conjuntos. Python nunca deu garantias sobre essa ordem (e normalmente varia entre compilações de 32 e 64 bits).

Consulte também 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED}.
@end quotation
@end cartouche


Alterado na versão 3.3: Aleatorização de hash está habilitada por padrão.

@end deffn

@geindex __bool__() (método object)
@anchor{reference/datamodel object __bool__}@anchor{1318}
@deffn {Método} object.__bool__ (self)

@geindex __len__() (método de objeto mapeamento)

Chamado para implementar o teste de valor verdade e a operação embutida @code{bool()}; deve retornar @code{False} ou @code{True}. Quando este método não é definido, @ref{15b4,,__len__()} é chamado, se estiver definido, e o objeto é considerado verdadeiro se seu resultado for diferente de zero. Se uma classe não define @code{__len__()} nem @code{__bool__()} (o que é verdadeiro da classe @ref{a96,,object} em si), todas as suas instâncias são consideradas verdadeiras.
@end deffn

@node Personalizando o acesso aos atributos,Personalizando a criação de classe,Personalização básica,Nomes de métodos especiais
@anchor{reference/datamodel attribute-access}@anchor{20f1}@anchor{reference/datamodel customizing-attribute-access}@anchor{20f2}
@subsubsection Personalizando o acesso aos atributos


Os seguintes métodos podem ser definidos para personalizar o significado do acesso aos atributos (uso, atribuição ou exclusão de @code{x.name}) para instâncias de classe.

@c XXX explain how descriptors interfere here!

@geindex __getattr__() (método object)
@anchor{reference/datamodel object __getattr__}@anchor{4d3}
@deffn {Método} object.__getattr__ (self, name)

Chamado quando o acesso padrão ao atributo falha com um @ref{34b,,AttributeError} (ou @ref{beb,,__getattribute__()} levanta uma @ref{34b,,AttributeError} porque `name' não é um atributo de instância ou um atributo na árvore de classes para @code{self}; ou @ref{1530,,__get__()} de uma propriedade `name' levanta @ref{34b,,AttributeError}). Este método deve retornar o valor do atributo (calculado) ou levantar uma exceção @ref{34b,,AttributeError}. A classe @ref{a96,,object} em si não fornece este método.

Observe que se o atributo for encontrado através do mecanismo normal, @ref{4d3,,__getattr__()} não é chamado. (Esta é uma assimetria intencional entre @ref{4d3,,__getattr__()} e @ref{20bf,,__setattr__()}.) Isso é feito tanto por razões de eficiência quanto porque @ref{4d3,,__getattr__()} não teria como acessar outros atributos da instância. Observe que pelo menos para variáveis de instâncias, você pode obter controle total não inserindo nenhum valor no dicionário de atributos de instância (mas, em vez disso, inserindo-os em outro objeto). Veja o método @ref{beb,,__getattribute__()} abaixo para uma maneira de realmente obter controle total sobre o acesso ao atributo.
@end deffn

@geindex __getattribute__() (método object)
@anchor{reference/datamodel object __getattribute__}@anchor{beb}
@deffn {Método} object.__getattribute__ (self, name)

Chamado incondicionalmente para implementar acessos a atributo para instâncias da classe. Se a classe também define @ref{4d3,,__getattr__()}, o último não será chamado a menos que @ref{beb,,__getattribute__()} o chame explicitamente ou levante um @ref{34b,,AttributeError}. Este método deve retornar o valor do atributo (calculado) ou levantar uma exceção @ref{34b,,AttributeError}. Para evitar recursão infinita neste método, sua implementação deve sempre chamar o método da classe base com o mesmo nome para acessar quaisquer atributos de que necessita, por exemplo, @code{object.__getattribute__(self, name)}.

@cartouche
@quotation Nota 
Este método ainda pode ser ignorado ao procurar métodos especiais como resultado de invocação implícita por meio da sintaxe da linguagem ou @ref{2091,,built-in functions}. Consulte @ref{20f3,,Pesquisa de método especial}.
@end quotation
@end cartouche

Para acessos a certos atributos sensíveis, levanta um @ref{19fa,,evento de auditoria} @code{object.__getattr__} com os argumentos @code{obj} e @code{name}.
@end deffn

@geindex __setattr__() (método object)
@anchor{reference/datamodel object __setattr__}@anchor{20bf}
@deffn {Método} object.__setattr__ (self, name, value)

Chamado quando se tenta efetuar uma atribuição de atributos. Esse método é chamado em vez do mecanismo normal (ou seja, armazena o valor no dicionário da instância). `name' é o nome do atributo, `value' é o valor a ser atribuído a ele.

Se @ref{20bf,,__setattr__()} deseja atribuir a um atributo de instância, ele deve chamar o método da classe base com o mesmo nome, por exemplo, @code{object.__setattr__(self, name, value)}.

Para atribuições de certos atributos sensíveis, levanta um @ref{19fa,,evento de auditoria} @code{object.__setattr__} com os argumentos @code{obj}, @code{name} e @code{value}.
@end deffn

@geindex __delattr__() (método object)
@anchor{reference/datamodel object __delattr__}@anchor{20c0}
@deffn {Método} object.__delattr__ (self, name)

Como @ref{20bf,,__setattr__()}, mas para exclusão de atributo em vez de atribuição. Este método só deve ser implementado se @code{del obj.name} for significativo para o objeto.

Para exclusões a certos atributos sensíveis, levanta um @ref{19fa,,evento de auditoria} @code{object.__delattr__} com os argumentos @code{obj} e @code{name}.
@end deffn

@geindex __dir__() (método object)
@anchor{reference/datamodel object __dir__}@anchor{15fe}
@deffn {Método} object.__dir__ (self)

Chamado quando @ref{632,,dir()} é chamado com o objeto como argumento. Um iterável deve ser retornada. @ref{632,,dir()} converte o iterável retornado em uma lista e o ordena.
@end deffn

@menu
* Personalizando acesso a atributos de módulos:: 
* Implementando descritores:: 
* Invocando descritores:: 
* __slots__: __slots__<2>. 

@end menu

@node Personalizando acesso a atributos de módulos,Implementando descritores,,Personalizando o acesso aos atributos
@anchor{reference/datamodel customizing-module-attribute-access}@anchor{20f4}
@subsubsection Personalizando acesso a atributos de módulos


@geindex __getattr__ (atributo de módulo)
@geindex __dir__ (atributo de módulo)
@geindex __class__ (atributo de módulo)

@geindex __getattr__() (método module)
@geindex __dir__() (método module)
@anchor{reference/datamodel module __getattr__}@anchor{af1}
@deffn {Método} module.__getattr__ ()
@anchor{reference/datamodel module __dir__}@anchor{af2}
@deffnx {Método} module.__dir__ ()
@end deffn

Os nomes especiais @code{__getattr__} e @code{__dir__} também podem ser usados para personalizar o acesso aos atributos dos módulos. A função @code{__getattr__} no nível do módulo deve aceitar um argumento que é o nome de um atributo e retornar o valor calculado ou levantar uma exceção @ref{34b,,AttributeError}. Se um atributo não for encontrado em um objeto de módulo por meio da pesquisa normal, por exemplo @ref{beb,,object.__getattribute__()}, então @code{__getattr__} é pesquisado no módulo @code{__dict__} antes de levantar @ref{34b,,AttributeError}. Se encontrado, ele é chamado com o nome do atributo e o resultado é retornado.

A função @code{__dir__} não deve aceitar nenhum argumento e retorna um iterável de strings que representa os nomes acessíveis no módulo. Se presente, esta função substitui a pesquisa padrão @ref{632,,dir()} em um módulo.

@geindex __class__ (atributo module)
@anchor{reference/datamodel module __class__}@anchor{20f5}
@deffn {Atributo} module.__class__
@end deffn

Para uma personalização mais refinada do comportamento do módulo (definição de atributos, propriedades etc.), pode-se definir o atributo @code{__class__} de um objeto de módulo para uma subclasse de @ref{e3f,,types.ModuleType}. Por exemplo:

@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 
Definir @code{__getattr__} no módulo e configurar o @code{__class__} do módulo só afeta as pesquisas feitas usando a sintaxe de acesso ao atributo – acessar diretamente os globais do módulo (seja por código dentro do módulo, ou por meio de uma referência ao dicionário global do módulo) não tem efeito.
@end quotation
@end cartouche


Alterado na versão 3.5: O atributo de módulo @code{__class__} pode agora ser escrito.



Adicionado na versão 3.7: Atributos de módulo @code{__getattr__} e @code{__dir__}.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} - __getattr__ e __dir__ de módulo

Descreve as funções @code{__getattr__} e @code{__dir__} nos módulos.
@end table


@node Implementando descritores,Invocando descritores,Personalizando acesso a atributos de módulos,Personalizando o acesso aos atributos
@anchor{reference/datamodel descriptors}@anchor{c6a}@anchor{reference/datamodel implementing-descriptors}@anchor{20f6}
@subsubsection Implementando descritores


Os métodos a seguir se aplicam apenas quando uma instância da classe que contém o método (uma classe chamada `descritora') aparece em uma classe proprietária `owner' (o descritor deve estar no dicionário de classe do proprietário ou no dicionário de classe para um dos seus pais). Nos exemplos abaixo, “o atributo” refere-se ao atributo cujo nome é a chave da propriedade no @ref{55b,,__dict__} da classe proprietária. A classe @ref{a96,,object} em si não implementa quaisquer desses protocolos.

@geindex __get__() (método object)
@anchor{reference/datamodel object __get__}@anchor{1530}
@deffn {Método} object.__get__ (self, instance, owner=None)

Chamado para obter o atributo da classe proprietária (acesso ao atributo da classe) ou de uma instância dessa classe (acesso ao atributo da instância). O argumento opcional `owner' é a classe proprietária, enquanto `instance' é a instância pela qual o atributo foi acessado, ou @code{None} quando o atributo é acessado por meio de `owner'.

Este método deve retornar o valor do atributo calculado ou levantar uma exceção @ref{34b,,AttributeError}.

@geindex Propostas de Melhorias do Python; PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} especifica que @ref{1530,,__get__()} é um chamável com um ou dois argumentos. Os próprios descritores embutidos do Python implementam esta especificação; no entanto, é provável que algumas ferramentas de terceiros tenham descritores que requerem ambos os argumentos. A implementação de @ref{beb,,__getattribute__()} do próprio Python sempre passa em ambos os argumentos sejam eles requeridos ou não.
@end deffn

@geindex __set__() (método object)
@anchor{reference/datamodel object __set__}@anchor{20f7}
@deffn {Método} object.__set__ (self, instance, value)

Chamado para definir o atributo em uma instância `instance' da classe proprietária para um novo valor, `value'.

Observe que adicionar @ref{20f7,,__set__()} ou @ref{16f5,,__delete__()} altera o tipo de descritor para um “descritor de dados”. Consulte @ref{20f8,,Invocando descritores} para mais detalhes.
@end deffn

@geindex __delete__() (método object)
@anchor{reference/datamodel object __delete__}@anchor{16f5}
@deffn {Método} object.__delete__ (self, instance)

Chamado para excluir o atributo em uma instância `instance' da classe proprietária.
@end deffn

Instâncias de descritores também podem ter o atributo @code{__objclass__} presente:

@geindex __objclass__ (atributo object)
@anchor{reference/datamodel object __objclass__}@anchor{20f9}
@deffn {Atributo} object.__objclass__

O atributo @code{__objclass__} é interpretado pelo módulo @ref{7e,,inspect} como sendo a classe onde este objeto foi definido (configurar isso apropriadamente pode ajudar na introspecção em tempo de execução dos atributos dinâmicos da classe). Para chamáveis, pode indicar que uma instância do tipo fornecido (ou uma subclasse) é esperada ou necessária como o primeiro argumento posicional (por exemplo, CPython define este atributo para métodos não acoplados que são implementados em C).
@end deffn

@node Invocando descritores,__slots__<2>,Implementando descritores,Personalizando o acesso aos atributos
@anchor{reference/datamodel descriptor-invocation}@anchor{20f8}@anchor{reference/datamodel invoking-descriptors}@anchor{20fa}
@subsubsection Invocando descritores


Em geral, um descritor é um atributo de objeto com “comportamento de ligação”, cujo acesso ao atributo foi substituído por métodos no protocolo do descritor: @ref{1530,,__get__()}, @ref{20f7,,__set__()} e @ref{16f5,,__delete__()}. Se qualquer um desses métodos for definido para um objeto, é considerado um descritor.

O comportamento padrão para acesso ao atributo é obter, definir ou excluir o atributo do dicionário de um objeto. Por exemplo, @code{a.x} tem uma cadeia de pesquisa começando com @code{a.__dict__['x']}, depois @code{type(a).__dict__['x']}, e continuando pelas classes bases de @code{type(a)} excluindo metaclasses.

No entanto, se o valor pesquisado for um objeto que define um dos métodos do descritor, Python pode substituir o comportamento padrão e invocar o método do descritor. Onde isso ocorre na cadeia de precedência depende de quais métodos descritores foram definidos e como eles foram chamados.

O ponto de partida para a invocação do descritor é uma ligação, @code{a.x}. Como os argumentos são montados depende de @code{a}:


@table @asis

@item Chamada direta

A chamada mais simples e menos comum é quando o código do usuário invoca diretamente um método descritor: @code{x.__get__(a)}.

@item Ligação de instâncias

Se estiver ligando a uma instância de objeto, @code{a.x} é transformado na chamada: @code{type(a).__dict__['x'].__get__(a, type(a))}.

@item Ligação de classes

Se estiver ligando a uma classe, @code{A.x} é transformado na chamada: @code{A.__dict__['x'].__get__(None, A)}.

@item Ligação de super

Uma pesquisa pontilhada, ou `dotted lookup', como @code{super(A, a).x} procura @code{a.__class__.__mro__} por uma classe base @code{B} seguindo @code{A} e então retorna @code{B.__dict__['x'].__get__(a, A)}. Se não for um descritor, @code{x} é retornado inalterado.
@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

Para ligações de instâncias, a precedência de invocação do descritor depende de quais métodos do descritor são definidos. Um descritor pode definir qualquer combinação de @ref{1530,,__get__()}, @ref{20f7,,__set__()} e @ref{16f5,,__delete__()}. Se ele não definir @code{__get__()}, então acessar o atributo retornará o próprio objeto descritor, a menos que haja um valor no dicionário de instância do objeto. Se o descritor define @code{__set__()} e/ou @code{__delete__()}, é um descritor de dados; se não definir nenhum, é um descritor sem dados. Normalmente, os descritores de dados definem @code{__get__()} e @code{__set__()}, enquanto os descritores sem dados têm apenas o método @code{__get__()}. Descritores de dados com @code{__get__()} e @code{__set__()} (e/ou @code{__delete__()}) definidos sempre substituem uma redefinição em um dicionário de instância. Em contraste, descritores sem dados podem ser substituídos por instâncias.

Os métodos Python (incluindo aqueles decorados com @ref{416,,@@staticmethod} e @ref{166,,@@classmethod}) são implementados como descritores sem dados. Assim, as instâncias podem redefinir e substituir métodos. Isso permite que instâncias individuais adquiram comportamentos que diferem de outras instâncias da mesma classe.

A função @ref{194,,property()} é implementada como um descritor de dados. Da mesma forma, as instâncias não podem substituir o comportamento de uma propriedade.

@node __slots__<2>,,Invocando descritores,Personalizando o acesso aos atributos
@anchor{reference/datamodel id13}@anchor{20fb}@anchor{reference/datamodel slots}@anchor{20c2}
@subsubsection __slots__


`__slots__' permite-nos declarar explicitamente membros de dados (como propriedades) e negar a criação de @ref{55b,,__dict__} e `__weakref__' (a menos que explicitamente declarado em `__slots__' ou disponível em uma classe base.)

O espaço economizado com o uso de @ref{55b,,__dict__} pode ser significativo. A velocidade de pesquisa de atributos também pode ser significativamente melhorada.

@geindex object.__slots__ (variável interna)
@anchor{reference/datamodel object __slots__}@anchor{1533}
@deffn {Dado} object.__slots__

Esta variável de classe pode ser atribuída a uma string, iterável ou sequência de strings com nomes de variáveis usados por instâncias. `__slots__' reserva espaço para as variáveis declaradas e evita a criação automática de @ref{55b,,__dict__} e `__weakref__' para cada instância.
@end deffn
@anchor{reference/datamodel datamodel-note-slots}@anchor{20fc}
Observações ao uso de `__slots__':


@itemize *

@item 
Ao herdar de uma classe sem `__slots__', os atributos @ref{55b,,__dict__} e `__weakref__' das instâncias sempre estarão acessíveis.

@item 
Sem uma variável @ref{55b,,__dict__}, as instâncias não podem ser atribuídas a novas variáveis não listadas na definição `__slots__'. As tentativas de atribuir a um nome de variável não listado levantam @ref{34b,,AttributeError}. Se a atribuição dinâmica de novas variáveis for desejada, então adicione @code{'__dict__'} à sequência de strings na declaração de `__slots__'.

@item 
Sem uma variável `__weakref__' para cada instância, as classes que definem `__slots__' não suportam @ref{114,,referências fracas} para suas instâncias. Se for necessário um suporte de referência fraca, adicione @code{'__weakref__'} à sequência de strings na declaração `__slots__'.

@item 
`__slots__' são implementados no nível de classe criando @ref{c6a,,descritores} para cada nome de variável. Como resultado, os atributos de classe não podem ser usados para definir valores padrão para variáveis de instância definidas por `__slots__'; caso contrário, o atributo de classe substituiria a atribuição do descritor.

@item 
A ação de uma declaração `__slots__' se limita à classe em que é definida. `__slots__' declarados em uma classe base estão disponíveis nas subclasses. No entanto, instâncias de uma subclasse filha vai receber um @ref{55b,,__dict__} e `__weakref__' a menos que a subclasse também defina `__slots__' (que deve conter apenas nomes de quaisquer slots `adicionais').

@item 
Se uma classe define um slot também definido em uma classe base, a variável de instância definida pelo slot da classe base fica inacessível (exceto por recuperar seu descritor diretamente da classe base). Isso torna o significado do programa indefinido. No futuro, uma verificação pode ser adicionada para evitar isso.

@item 
@ref{2c3,,TypeError} será levantada se `__slots__' não vazios forem definidos para uma classe derivada de um tipo embutido @ref{20fd,,"variable-length"} como @ref{257,,int}, @ref{1c2,,bytes} e @ref{370,,tuple}.

@item 
Qualquer @ref{1268,,iterável} não string pode ser atribuído a `__slots__'.

@item 
Se um @ref{256,,dicionário} for usado para atribuir `__slots__', as chaves do dicionário serão usadas como os nomes dos slots. Os valores do dicionário podem ser usados para fornecer docstrings por atributo que serão reconhecidos por @ref{a02,,inspect.getdoc()} e exibidos na saída de @ref{8dd,,help()}.

@item 
Atribuição de @ref{14f5,,__class__} funciona apenas se ambas as classes têm o mesmo `__slots__'.

@item 
A @ref{1e41,,herança múltipla} com várias classes bases com slots pode ser usada, mas apenas uma classe base tem permissão para ter atributos criados por slots (as outras classes bases devem ter layouts de slots vazios) – violações levantam @ref{2c3,,TypeError}.

@item 
Se um @ref{1ac,,iterador} for usado para `__slots__', um @ref{1658,,descritor} é criado para cada um dos valores do iterador. No entanto, o atributo `__slots__' será um iterador vazio.
@end itemize

@node Personalizando a criação de classe,Personalizando verificações de instância e subclasse,Personalizando o acesso aos atributos,Nomes de métodos especiais
@anchor{reference/datamodel class-customization}@anchor{c66}@anchor{reference/datamodel customizing-class-creation}@anchor{20fe}
@subsubsection Personalizando a criação de classe


Sempre que uma classe herda de outra classe, @ref{631,,__init_subclass__()} é chamado na classe base. Dessa forma, é possível escrever classes que alteram o comportamento das subclasses. Isso está intimamente relacionado aos decoradores de classe, mas onde decoradores de classe afetam apenas a classe específica à qual são aplicados, @code{__init_subclass__} aplica-se apenas a futuras subclasses da classe que define o método.

@geindex __init_subclass__() (método de classe object)
@anchor{reference/datamodel object __init_subclass__}@anchor{631}
@deffn {Método} classmethod object.__init_subclass__ (cls)

Este método é chamado sempre que a classe que contém é uma subclasse. `cls' é então a nova subclasse. Se definido como um método de instância normal, esse método é convertido implicitamente em um método de classe.

Argumentos nomeados dados a uma nova classe são passados para @code{__init_subclass__} da classe base. Para compatibilidade com outras classes usando @code{__init_subclass__}, deve-se retirar os argumentos nomeados necessários e passar os outros para a classe base, como em:

@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

A implementação padrão de @code{object.__init_subclass__} não faz nada, mas levanta um erro se for chamada com quaisquer argumentos.

@cartouche
@quotation Nota 
A dica da metaclasse @code{metaclass} é consumida pelo resto da maquinaria de tipo, e nunca é passada para implementações @code{__init_subclass__}. A metaclasse real (em vez da dica explícita) pode ser acessada como @code{type(cls)}.
@end quotation
@end cartouche


Adicionado na versão 3.6.

@end deffn

Quando uma classe é criada, @code{type.__new__()} verifica as variáveis de classe e faz chamadas a funções de retorno (callback) para aqueles com um gancho @ref{c69,,__set_name__()}.

@geindex __set_name__() (método object)
@anchor{reference/datamodel object __set_name__}@anchor{c69}
@deffn {Método} object.__set_name__ (self, owner, name)

Chamado automaticamente no momento em que a classe proprietária `owner' é criada. O objeto foi atribuído a `name' nessa classe:

@example
class A:
    x = C()  # Automaticamente chama: x.__set_name__(A, 'x')
@end example

Se a variável de classe for atribuída após a criação da classe, @ref{c69,,__set_name__()} não será chamado automaticamente. Se necessário, @ref{c69,,__set_name__()} pode ser chamado diretamente:

@example
class A:
   pass

c = C()
A.x = c                  # O gancho não é chamado
c.__set_name__(A, 'x')   # Invoca manualmente o gancho
@end example

Consulte @ref{c65,,Criando o objeto classe} para mais detalhes.


Adicionado na versão 3.6.

@end deffn

@menu
* Metaclasses:: 
* Resolvendo entradas de MRO:: 
* Determinando a metaclasse apropriada:: 
* Preparando o espaço de nomes da classe:: 
* Executando o corpo da classe:: 
* Criando o objeto classe:: 
* Usos para metaclasses:: 

@end menu

@node Metaclasses,Resolvendo entradas de MRO,,Personalizando a criação de classe
@anchor{reference/datamodel id14}@anchor{20ff}@anchor{reference/datamodel metaclasses}@anchor{2100}
@subsubsection Metaclasses


@geindex metaclasse
@geindex função embutida;tipo
@geindex = (igual);definição de classe

Por padrão, as classes são construídas usando @ref{d6b,,type()}. O corpo da classe é executado em um novo espaço de nomes e o nome da classe é vinculado localmente ao resultado de @code{type(name, bases, namespace)}.

O processo de criação da classe pode ser personalizado passando o argumento nomeado @code{metaclass} na linha de definição da classe, ou herdando de uma classe existente que incluiu tal argumento. No exemplo a seguir, @code{MyClass} e @code{MySubclass} são instâncias de @code{Meta}:

@example
class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass
@end example

Quaisquer outros argumentos nomeados especificados na definição de classe são transmitidos para todas as operações de metaclasse descritas abaixo.

Quando uma definição de classe é executada, as seguintes etapas ocorrem:


@itemize *

@item 
entradas de MRO são resolvidas;

@item 
a metaclasse apropriada é determinada;

@item 
o espaço de nomes da classe é preparada;

@item 
o corpo da classe é executado;

@item 
o objeto da classe é criado.
@end itemize

@node Resolvendo entradas de MRO,Determinando a metaclasse apropriada,Metaclasses,Personalizando a criação de classe
@anchor{reference/datamodel resolving-mro-entries}@anchor{2101}
@subsubsection Resolvendo entradas de MRO


@geindex __mro_entries__() (método object)
@anchor{reference/datamodel object __mro_entries__}@anchor{afc}
@deffn {Método} object.__mro_entries__ (self, bases)

Se uma classe base que aparece em uma definição de classe não é uma instância de @ref{d6b,,type}, então um método @code{__mro_entries__()} é procurado na base. Se um método @code{__mro_entries__()} é encontrado, a base é substituída pelo resultado de uma chamada para @code{__mro_entries__()} ao criar a classe. O método é chamado com a tupla de bases original passada como parâmetro `bases', e deve retornar uma tupla de classes que serão usadas no lugar da base. A tupla retornada pode estar vazia: nesses casos, a base original é ignorada.
@end deffn


@subsubheading Ver também



@table @asis

@item @ref{bb4,,types.resolve_bases()}

Dinamicamente resolve bases que não são instâncias de @ref{d6b,,type}.

@item @ref{4ce,,types.get_original_bases()}

Recupera as “bases originais” de uma classe antes das modificações feitas por @ref{afc,,__mro_entries__()}.

@geindex Propostas de Melhorias do Python; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/}

Suporte básico para módulo typing e tipos genéricos.
@end table


@node Determinando a metaclasse apropriada,Preparando o espaço de nomes da classe,Resolvendo entradas de MRO,Personalizando a criação de classe
@anchor{reference/datamodel determining-the-appropriate-metaclass}@anchor{2102}
@subsubsection Determinando a metaclasse apropriada


@geindex dica de metaclasse

A metaclasse apropriada para uma definição de classe é determinada da seguinte forma:


@itemize *

@item 
se nenhuma classe base e nenhuma metaclasse explícita forem fornecidas, então @ref{d6b,,type()} é usada;

@item 
se uma metaclasse explícita é fornecida e `não' é uma instância de @ref{d6b,,type()}, então ela é usada diretamente como a metaclasse;

@item 
se uma instância de @ref{d6b,,type()} é fornecida como a metaclasse explícita, ou classes bases são definidas, então a metaclasse mais derivada é usada.
@end itemize

A metaclasse mais derivada é selecionada a partir da metaclasse explicitamente especificada (se houver) e das metaclasses (ou seja, @code{type(cls)}) de todas as classes bases especificadas. A metaclasse mais derivada é aquela que é um subtipo de `todas' essas metaclasses candidatas. Se nenhuma das metaclasses candidatas atender a esse critério, a definição de classe falhará com @code{TypeError}.

@node Preparando o espaço de nomes da classe,Executando o corpo da classe,Determinando a metaclasse apropriada,Personalizando a criação de classe
@anchor{reference/datamodel prepare}@anchor{c79}@anchor{reference/datamodel preparing-the-class-namespace}@anchor{2103}
@subsubsection Preparando o espaço de nomes da classe


@geindex __prepare__ (método de metaclasse)

Uma vez identificada a metaclasse apropriada, o espaço de nomes da classe é preparado. Se a metaclasse tiver um atributo @code{__prepare__}, ela será chamada como @code{namespace = metaclass.__prepare__(name, bases, **kwds)} (onde os argumentos nomeados adicionais, se houver, vêm da definição de classe). O método @code{__prepare__} deve ser implementado como um @ref{166,,classmethod}. O espaço de nomes retornado por @code{__prepare__} é passado para @code{__new__}, mas quando o objeto classe final é criado, o espaço de nomes é copiado para um novo @code{dict}.

Se a metaclasse não tiver o atributo @code{__prepare__}, então o espaço de nomes da classe é inicializado como um mapeamento ordenado vazio.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclasses no Python 3000

Introduzido o gancho de espaço de nomes @code{__prepare__}
@end table


@node Executando o corpo da classe,Criando o objeto classe,Preparando o espaço de nomes da classe,Personalizando a criação de classe
@anchor{reference/datamodel executing-the-class-body}@anchor{2104}
@subsubsection Executando o corpo da classe


@geindex classe;corpo

O corpo da classe é executado (aproximadamente) como @code{exec(body, globals(), namespace)}. A principal diferença de uma chamada normal para @ref{17f,,exec()} é que o escopo léxico permite que o corpo da classe (incluindo quaisquer métodos) faça referência a nomes dos escopos atual e externo quando a definição de classe ocorre dentro de uma função.

No entanto, mesmo quando a definição de classe ocorre dentro da função, os métodos definidos dentro da classe ainda não podem ver os nomes definidos no escopo da classe. Variáveis de classe devem ser acessadas através do primeiro parâmetro de instância ou métodos de classe, ou através da referência implícita com escopo léxico @code{__class__} descrita na próxima seção.

@node Criando o objeto classe,Usos para metaclasses,Executando o corpo da classe,Personalizando a criação de classe
@anchor{reference/datamodel class-object-creation}@anchor{c65}@anchor{reference/datamodel creating-the-class-object}@anchor{2105}
@subsubsection Criando o objeto classe


@geindex __class__ (célula de método)
@geindex __classcell__ (entrada de espaço de nomes de classe)

Uma vez que o espaço de nomes da classe tenha sido preenchido executando o corpo da classe, o objeto classe é criado chamando @code{metaclass(name, bases, namespace, **kwds)} (os argumentos adicionais passados aqui são os mesmos passados para @code{__prepare__}).

Este objeto classe é aquele que será referenciado pela chamada a  @ref{4db,,super()} sem argumentos. @code{__class__} é uma referência de clausura implícita criada pelo compilador se algum método no corpo da classe se referir a @code{__class__} ou @code{super}. Isso permite que a forma de argumento zero de @ref{4db,,super()} identifique corretamente a classe sendo definida com base no escopo léxico, enquanto a classe ou instância que foi usada para fazer a chamada atual é identificada com base no primeiro argumento passado para o método.

No CPython 3.6 e posterior, a célula @code{__class__} é passada para a metaclasse como uma entrada de @code{__classcell__} no espaço de nomes da classe. Se estiver presente, deve ser propagado até a chamada a @code{type.__new__} para que a classe seja inicializada corretamente. Não fazer isso resultará em um @ref{195,,RuntimeError} no Python 3.8.

Quando usada a metaclasse padrão @ref{d6b,,type}, ou qualquer metaclasse que chame @code{type.__new__}, as seguintes etapas de personalização adicionais são executadas depois da criação do objeto classe:


@enumerate 

@item 
O método @code{type.__new__} coleta todos os atributos no espaço de nomes da classe que definem um método @ref{c69,,__set_name__()};

@item 
Esses métodos @code{__set_name__} são chamados com a classe sendo definida e o nome atribuído para este atributo específico;

@item 
O gancho @ref{631,,__init_subclass__()} é chamado na classe base imediata da nova classe em sua ordem de resolução de método.
@end enumerate

Depois que o objeto classe é criado, ele é passado para os decoradores de classe incluídos na definição de classe (se houver) e o objeto resultante é vinculado ao espaço de nomes local como a classe definida.

Quando uma nova classe é criada por @code{type.__new__}, o objeto fornecido como o parâmetro do espaço de nomes é copiado para um novo mapeamento ordenado e o objeto original é descartado. A nova cópia é envolta em um proxy de somente leitura, que se torna o atributo @ref{c78,,__dict__} do objeto classe.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3135

@item PEP 3135@footnote{https://peps.python.org/pep-3135/} - Novo super

Descreve a referência de clausura implícita de  @code{__class__}
@end table


@node Usos para metaclasses,,Criando o objeto classe,Personalizando a criação de classe
@anchor{reference/datamodel uses-for-metaclasses}@anchor{2106}
@subsubsection Usos para metaclasses


Os usos potenciais para metaclasses são ilimitados. Algumas ideias que foram exploradas incluem enumeradores, criação de log, verificação de interface, delegação automática, criação automática de propriedade, proxies, estruturas e travamento/sincronização automático/a de recursos.

@node Personalizando verificações de instância e subclasse,Emulando tipos genéricos,Personalizando a criação de classe,Nomes de métodos especiais
@anchor{reference/datamodel customizing-instance-and-subclass-checks}@anchor{2107}
@subsubsection Personalizando verificações de instância e subclasse


Os seguintes métodos são usados para substituir o comportamento padrão das funções embutidas @ref{442,,isinstance()} e @ref{7c2,,issubclass()}.

Em particular, a metaclasse @ref{f4a,,abc.ABCMeta} implementa esses métodos a fim de permitir a adição de classes base abstratas (ABCs) como “classes base virtuais” para qualquer classe ou tipo (incluindo tipos embutidos), incluindo outras ABCs.

@geindex __instancecheck__() (método type)
@anchor{reference/datamodel type __instancecheck__}@anchor{2108}
@deffn {Método} type.__instancecheck__ (self, instance)

Retorna verdadeiro se `instance' deve ser considerada uma instância (direta ou indireta) da classe `class'. Se definido, chamado para implementar @code{isinstance(instance, class)}.
@end deffn

@geindex __subclasscheck__() (método type)
@anchor{reference/datamodel type __subclasscheck__}@anchor{2109}
@deffn {Método} type.__subclasscheck__ (self, subclass)

Retorna verdadeiro se `subclass' deve ser considerada uma subclasse (direta ou indireta) da classe `class'. Se definido, chamado para implementar @code{issubclass(subclass, class)}.
@end deffn

Observe que esses métodos são pesquisados no tipo (metaclasse) de uma classe. Eles não podem ser definidos como métodos de classe na classe real. Isso é consistente com a pesquisa de métodos especiais que são chamados em instâncias, apenas neste caso a própria instância é uma classe.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - Introduzindo classes base abstratas

Inclui a especificação para personalizar o comportamento de @ref{442,,isinstance()} e @ref{7c2,,issubclass()} através de @ref{2108,,__instancecheck__()} e @ref{2109,,__subclasscheck__()}, com motivação para esta funcionalidade no contexto da adição de classes base abstratas (veja o módulo @ref{4,,abc}) para a linguagem.
@end table


@node Emulando tipos genéricos,Emulando objetos chamáveis,Personalizando verificações de instância e subclasse,Nomes de métodos especiais
@anchor{reference/datamodel emulating-generic-types}@anchor{210a}
@subsubsection Emulando tipos genéricos


Quando estiver usando @ref{458,,anotações de tipo}, é frequentemente útil `parametrizar' um @ref{439,,tipo genérico} usando a notação de colchetes do Python. Por exemplo, a anotação @code{list[int]} pode ser usada para indicar uma @ref{611,,list} em que todos os seus elementos são do tipo @ref{257,,int}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Dicas de tipo

Apresenta a estrutura do Python para anotações de tipo

@item @ref{6b2,,Tipos Generic Alias}

Documentação de objetos que representam classes genéricas parametrizadas

@item @ref{210b,,Genéricos}, @ref{4cf,,genéricos definidos pelo usuário} e @ref{15d7,,typing.Generic}

Documentação sobre como implementar classes genéricas que podem ser parametrizadas em tempo de execução e compreendidas por verificadores de tipo estático.
@end table


Uma classe pode `geralmente' ser parametrizada somente se ela define o método de classe especial @code{__class_getitem__()}.

@geindex __class_getitem__() (método de classe object)
@anchor{reference/datamodel object __class_getitem__}@anchor{73b}
@deffn {Método} classmethod object.__class_getitem__ (cls, key)

Retorna um objeto que representa a especialização de uma classe genérica por argumentos de tipo encontrados em `key'.

Quando definido em uma classe, @code{__class_getitem__()} é automaticamente um método de classe. Assim, não é necessário que seja decorado com @ref{166,,@@classmethod} quando de sua definição.
@end deffn

@menu
* O propósito de __class_getitem__:: 
* __class_getitem__ versus __getitem__:: 

@end menu

@node O propósito de __class_getitem__,__class_getitem__ versus __getitem__,,Emulando tipos genéricos
@anchor{reference/datamodel the-purpose-of-class-getitem}@anchor{210c}
@subsubsection O propósito de `__class_getitem__'


O propósito de @ref{73b,,__class_getitem__()} é permitir a parametrização em tempo de execução de classes genéricas da biblioteca padrão, a fim de aplicar mais facilmente @ref{210d,,dicas de tipo} a essas classes.

Para implementar classes genéricas personalizadas que podem ser parametrizadas em tempo de execução e compreendidas por verificadores de tipo estáticos, os usuários devem herdar de uma classe da biblioteca padrão que já implementa @ref{73b,,__class_getitem__()}, ou herdar de @ref{15d7,,typing.Generic}, que possui sua própria implementação de @code{__class_getitem__()}.

Implementações personalizadas de @ref{73b,,__class_getitem__()} em classes definidas fora da biblioteca padrão podem não ser compreendidas por verificadores de tipo de terceiros, como o mypy. O uso de @code{__class_getitem__()} em qualquer classe para fins diferentes de dicas de tipo é desencorajado.

@node __class_getitem__ versus __getitem__,,O propósito de __class_getitem__,Emulando tipos genéricos
@anchor{reference/datamodel class-getitem-versus-getitem}@anchor{210e}@anchor{reference/datamodel classgetitem-versus-getitem}@anchor{210f}
@subsubsection `__class_getitem__' versus `__getitem__'


Normalmente, a @ref{2110,,subscription} de um objeto usando colchetes chamará o método de instância @ref{283,,__getitem__()} definido na classe do objeto. No entanto, se o objeto sendo subscrito for ele mesmo uma classe, o método de classe @ref{73b,,__class_getitem__()} pode ser chamado em seu lugar. @code{__class_getitem__()} deve retornar um objeto @ref{6b2,,GenericAlias} se estiver devidamente definido.

Apresentado com a @ref{2111,,expressão} @code{obj[x]}, o interpretador de Python segue algo parecido com o seguinte processo para decidir se @ref{283,,__getitem__()} ou @ref{73b,,__class_getitem__()} deve ser chamado:

@example
from inspect import isclass

def subscribe(obj, x):
    """Return the result of the expression 'obj[x]'"""

    class_of_obj = type(obj)

    # Se a classe de  obj define __getitem__,
    # chama class_of_obj.__getitem__(obj, x)
    if hasattr(class_of_obj, '__getitem__'):
        return class_of_obj.__getitem__(obj, x)

    # Do contrário, se obj for uma classe e define __class_getitem__,
    # chama obj.__class_getitem__(x)
    elif isclass(obj) and hasattr(obj, '__class_getitem__'):
        return obj.__class_getitem__(x)

    # Do contrário, levanta uma exceção
    else:
        raise TypeError(
            f"'@{class_of_obj.__name__@}' object is not subscriptable"
        )
@end example

Em Python, todas as classes são elas mesmas instâncias de outras classes. A classe de uma classe é conhecida como @ref{2112,,metaclasse} dessa classe, e a maioria das classes tem a classe @ref{d6b,,type} como sua metaclasse. @ref{d6b,,type} não define @ref{283,,__getitem__()}, o que significa que expressões como @code{list[int]}, @code{dict[str, float]} e @code{tuple[str, bytes]} resultam em chamadas para @ref{73b,,__class_getitem__()}:

@example
>>> # lista tem a classe "type" como sua metaclasse, como a maioria das classes:
>>> type(list)
<class 'type'>
>>> type(dict) == type(list) == type(tuple) == type(str) == type(bytes)
True
>>> # "list[int]" chama "list.__class_getitem__(int)"
>>> list[int]
list[int]
>>> # list.__class_getitem__ retorna um objeto GenericAlias:
>>> type(list[int])
<class 'types.GenericAlias'>
@end example

No entanto, se uma classe tiver uma metaclasse personalizada que define @ref{283,,__getitem__()}, subscrever a classe pode resultar em comportamento diferente. Um exemplo disso pode ser encontrado no módulo @ref{56,,enum}:

@example
>>> from enum import Enum
>>> class Menu(Enum):
...     """A breakfast menu"""
...     SPAM = 'spam'
...     BACON = 'bacon'
...
>>> # Classes Enum têm uma metaclasses personalizada:
>>> type(Menu)
<class 'enum.EnumMeta'>
>>> # EnumMeta define __getitem__,
>>> # de forma que __class_getitem__ não é chamado,
>>> # e o resultado não é um objeto GenericAlias:
>>> Menu['SPAM']
<Menu.SPAM: 'spam'>
>>> type(Menu['SPAM'])
<enum 'Menu'>
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/} - Suporte básico para módulo typing e tipos genéricos

Introduz @ref{73b,,__class_getitem__()}, e define quando uma @ref{2110,,subscrição} resulta na chamada de @code{__class_getitem__()} em vez de @ref{283,,__getitem__()}
@end table


@node Emulando objetos chamáveis,Emulando tipos contêineres,Emulando tipos genéricos,Nomes de métodos especiais
@anchor{reference/datamodel emulating-callable-objects}@anchor{2113}@anchor{reference/datamodel id15}@anchor{2114}
@subsubsection Emulando objetos chamáveis


@geindex __call__() (método object)
@anchor{reference/datamodel object __call__}@anchor{558}
@deffn {Método} object.__call__ (self[, args...])

@geindex chamada;instância

Chamado quando a instância é “chamada” como uma função; se este método for definido, @code{x(arg1, arg2, ...)} basicamente traduz para @code{type(x).__call__(x, arg1, ...)}. A classe @ref{a96,,object} em si não fornece este método.
@end deffn

@node Emulando tipos contêineres,Emulando tipos numéricos,Emulando objetos chamáveis,Nomes de métodos especiais
@anchor{reference/datamodel emulating-container-types}@anchor{2115}@anchor{reference/datamodel sequence-types}@anchor{2116}
@subsubsection Emulando tipos contêineres


Os seguintes métodos podem ser definidos para implementar objetos contêineres. Nenhum deles é fornecido pela própria classe @ref{a96,,object}. Contêineres geralmente são @ref{4f1,,sequências} (como @ref{611,,listas} ou @ref{370,,tuplas}) ou @ref{11fb,,mapeamentos} (como @ref{2117,,dicionários}), mas também podem representar outros contêineres. O primeiro conjunto de métodos é usado para emular uma sequência ou um mapeamento; a diferença é que, para uma sequência, as chaves permitidas devem ser os inteiros `k' para os quais @code{0 <= k < N}, onde `N' é o comprimento da sequência, ou objetos @ref{469,,fatiamentos}, que definem um intervalo de itens. Também é recomendado que os mapeamentos forneçam os métodos @code{keys()}, @code{values()}, @code{items()}, @code{get()}, @code{clear()}, @code{setdefault()}, @code{pop()}, @code{popitem()}, @code{copy()} e @code{update()} se comportando de forma semelhante aos dos objetos @ref{256,,dicionário} padrão do Python. O módulo @ref{1e,,collections.abc} fornece uma @ref{11f5,,classe base abstrata} @ref{10eb,,MutableMapping} para ajudar a criar esses métodos a partir de um conjunto base de @ref{283,,__getitem__()}, @ref{130e,,__setitem__()}, @ref{130f,,__delitem__()} e @code{keys()}.

Sequências mutáveis devem fornecer métodos @ref{2118,,append()}, @ref{2119,,clear()}, @ref{211a,,count()}, @ref{211b,,extend()}, @ref{211c,,index()}, @ref{211d,,insert()}, @ref{211e,,pop()}, @ref{211f,,remove()} e @ref{2120,,reverse()}, como objetos @ref{611,,list} padrão do Python. Por fim, os tipos de sequência devem implementar adição (ou seja, concatenação) e multiplicação (ou seja, repetição) definindo os métodos @ref{2121,,__add__()}, @ref{2122,,__radd__()}, @ref{2123,,__iadd__()}, @ref{2124,,__mul__()}, @ref{2125,,__rmul__()} e @ref{2126,,__imul__()} descritos abaixo; eles não devem definir outros operadores numéricos.

Recomenda-se que tanto mapeamentos quanto sequências implementem o método @ref{1400,,__contains__()} para permitir o uso eficiente do operador @code{in}; para mapeamentos, @code{in} deve pesquisar as chaves do mapeamento; para sequências, deve pesquisar os valores. Recomenda-se ainda que tanto mapeamentos quanto sequências implementem o método @ref{c8a,,__iter__()} para permitir uma iteração eficiente pelo contêiner; para mapeamentos, @code{__iter__()} deve iterar pelas chaves do objeto; para sequências, deve iterar pelos valores.

@geindex __len__() (método object)
@anchor{reference/datamodel object __len__}@anchor{15b4}
@deffn {Método} object.__len__ (self)

@geindex função embutida;len
@geindex __bool__() (método de objeto)

Chamado para implementar a função embutida @ref{62e,,len()}. Deve retornar o comprimento do objeto, um inteiro @code{>=} 0. Além disso, um objeto que não define um método @ref{1318,,__bool__()} e cujo método @code{__len__()} retorna zero é considerado como falso em um contexto booleano.

No CPython, o comprimento deve ser no máximo @ref{1205,,sys.maxsize}. Se o comprimento for maior que @code{sys.maxsize}, alguns recursos (como @ref{62e,,len()}) podem levantar @ref{885,,OverflowError}. Para evitar levantar @code{OverflowError} pelo teste de valor de verdade, um objeto deve definir um método @ref{1318,,__bool__()}.
@end deffn

@geindex __length_hint__() (método object)
@anchor{reference/datamodel object __length_hint__}@anchor{f3d}
@deffn {Método} object.__length_hint__ (self)

Chamado para implementar @ref{fa1,,operator.length_hint()}. Deve retornar um comprimento estimado para o objeto (que pode ser maior ou menor que o comprimento real). O comprimento deve ser um inteiro @code{>=} 0. O valor de retorno também pode ser @ref{7d3,,NotImplemented}, que é tratado da mesma forma como se o método @code{__length_hint__} não existisse. Este método é puramente uma otimização e nunca é necessário para a correção.


Adicionado na versão 3.4.

@end deffn

@geindex objeto;fatia

@cartouche
@quotation Nota 
O fatiamento é feito exclusivamente com os três métodos a seguir. Uma chamada como

@example
a[1:2] = b
@end example

é traduzida com

@example
a[slice(1, 2, None)] = b
@end example

e assim por diante. Os itens de fatia ausentes são sempre preenchidos com @code{None}.
@end quotation
@end cartouche

@geindex __getitem__() (método object)
@anchor{reference/datamodel object __getitem__}@anchor{283}
@deffn {Método} object.__getitem__ (self, key)

Chamado para implementar a avaliação de @code{self[key]}. Para tipos de @ref{4f1,,sequência}, as chaves aceitas devem ser inteiros. Opcionalmente, eles também podem oferecer suporte a objetos @ref{469,,slice}. Suporte a índice negativo também é opcional. Se `key' for de um tipo impróprio, @ref{2c3,,TypeError} pode ser levantada; se `key' for de um valor fora do conjunto de índices para a sequência (após qualquer interpretação especial de valores negativos), @ref{157e,,IndexError} deve ser levantada. Para tipos @ref{11fb,,mapeamento}, se `key' estiver faltando (não no contêiner), @ref{344,,KeyError} deve ser levantada.

@cartouche
@quotation Nota 
Os loops @ref{2f2,,for} esperam que uma @ref{157e,,IndexError} seja levantada para índices ilegais para permitir a detecção apropriada do fim da sequência.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Ao fazer @ref{2110,,subscrição} de uma `classe', o método de classe especial @ref{73b,,__class_getitem__()} pode ser chamado em vez de @code{__getitem__()}. Veja @ref{210f,,__class_getitem__ versus __getitem__} para mais detalhes.
@end quotation
@end cartouche
@end deffn

@geindex __setitem__() (método object)
@anchor{reference/datamodel object __setitem__}@anchor{130e}
@deffn {Método} object.__setitem__ (self, key, value)

Chamado para implementar a atribuição de @code{self[key]}. Mesma nota que para @ref{283,,__getitem__()}. Isso só deve ser implementado para mapeamentos se os objetos suportarem alterações nos valores das chaves, ou se novas chaves puderem ser adicionadas, ou para sequências se os elementos puderem ser substituídos. As mesmas exceções devem ser levantadas para valores `key' impróprios do método @ref{283,,__getitem__()}.
@end deffn

@geindex __delitem__() (método object)
@anchor{reference/datamodel object __delitem__}@anchor{130f}
@deffn {Método} object.__delitem__ (self, key)

Chamado para implementar a exclusão de @code{self[key]}. Mesma nota que para @ref{283,,__getitem__()}. Isso só deve ser implementado para mapeamentos se os objetos suportarem remoções de chaves, ou para sequências se os elementos puderem ser removidos da sequência. As mesmas exceções devem ser levantadas para valores `key' impróprios do método @ref{283,,__getitem__()}.
@end deffn

@geindex __missing__() (método object)
@anchor{reference/datamodel object __missing__}@anchor{11fd}
@deffn {Método} object.__missing__ (self, key)

Chamado por @ref{256,,dict}.@ref{283,,__getitem__()} para implementar @code{self[key]} para subclasses de dicionário quando a chave não estiver no dicionário.
@end deffn

@geindex __iter__() (método object)
@anchor{reference/datamodel object __iter__}@anchor{c8a}
@deffn {Método} object.__iter__ (self)

Este método é chamado quando um @ref{1ac,,iterador} é necessário para um contêiner. Este método deve retornar um novo objeto iterador que pode iterar sobre todos os objetos no contêiner. Para mapeamentos, ele deve iterar sobre as chaves do contêiner.
@end deffn

@geindex __reversed__() (método object)
@anchor{reference/datamodel object __reversed__}@anchor{ca7}
@deffn {Método} object.__reversed__ (self)

Chamado (se presente) pelo @ref{869,,reversed()} embutido para implementar a iteração reversa. Ele deve retornar um novo objeto iterador que itera sobre todos os objetos no contêiner na ordem reversa.

Se o método @ref{ca7,,__reversed__()} não for fornecido, o @ref{869,,reversed()} embutido voltará a usar o protocolo de sequência (@ref{15b4,,__len__()} e @ref{283,,__getitem__()}). Objetos que suportam o protocolo de sequência só devem fornecer @ref{ca7,,__reversed__()} se eles puderem fornecer uma implementação que seja mais eficiente do que aquela fornecida por @ref{869,,reversed()}.
@end deffn

Os operadores de teste de associação (@ref{2f4,,in} e @ref{62f,,not in}) são normalmente implementados como uma iteração através de um contêiner. No entanto, os objetos contêiner podem fornecer o seguinte método especial com uma implementação mais eficiente, que também não requer que o objeto seja iterável.

@geindex __contains__() (método object)
@anchor{reference/datamodel object __contains__}@anchor{1400}
@deffn {Método} object.__contains__ (self, item)

Chamado para implementar operadores de teste de associação. Deve retornar verdadeiro se `item' estiver em `self', falso caso contrário. Para objetos de mapeamento, isso deve considerar as chaves do mapeamento em vez dos valores ou pares de itens-chave.

Para objetos que não definem @ref{1400,,__contains__()}, o teste de associação primeiro tenta a iteração via @ref{c8a,,__iter__()}, depois o protocolo de iteração de sequência antigo via @ref{283,,__getitem__()}, consulte @ref{2127,,esta seção em a referência da linguagem}.
@end deffn

@node Emulando tipos numéricos,Gerenciadores de contexto da instrução with,Emulando tipos contêineres,Nomes de métodos especiais
@anchor{reference/datamodel emulating-numeric-types}@anchor{2128}@anchor{reference/datamodel numeric-types}@anchor{2129}
@subsubsection Emulando tipos numéricos


Os métodos a seguir podem ser definidos para emular objetos numéricos. Métodos correspondentes a operações que não são suportadas pelo tipo particular de número implementado (por exemplo, operações bit a bit para números não inteiros) devem ser deixados indefinidos.

@geindex __add__() (método object)
@geindex __sub__() (método object)
@geindex __mul__() (método object)
@geindex __matmul__() (método object)
@geindex __truediv__() (método object)
@geindex __floordiv__() (método object)
@geindex __mod__() (método object)
@geindex __divmod__() (método object)
@geindex __pow__() (método object)
@geindex __lshift__() (método object)
@geindex __rshift__() (método object)
@geindex __and__() (método object)
@geindex __xor__() (método object)
@geindex __or__() (método object)
@anchor{reference/datamodel object __add__}@anchor{2121}
@deffn {Método} object.__add__ (self, other)
@anchor{reference/datamodel object __sub__}@anchor{212a}
@deffnx {Método} object.__sub__ (self, other)
@anchor{reference/datamodel object __mul__}@anchor{2124}
@deffnx {Método} object.__mul__ (self, other)
@anchor{reference/datamodel object __matmul__}@anchor{da1}
@deffnx {Método} object.__matmul__ (self, other)
@anchor{reference/datamodel object __truediv__}@anchor{ebf}
@deffnx {Método} object.__truediv__ (self, other)
@anchor{reference/datamodel object __floordiv__}@anchor{153c}
@deffnx {Método} object.__floordiv__ (self, other)
@anchor{reference/datamodel object __mod__}@anchor{212b}
@deffnx {Método} object.__mod__ (self, other)
@anchor{reference/datamodel object __divmod__}@anchor{ec0}
@deffnx {Método} object.__divmod__ (self, other)
@anchor{reference/datamodel object __pow__}@anchor{7d4}
@deffnx {Método} object.__pow__ (self, other[, modulo])
@anchor{reference/datamodel object __lshift__}@anchor{212c}
@deffnx {Método} object.__lshift__ (self, other)
@anchor{reference/datamodel object __rshift__}@anchor{212d}
@deffnx {Método} object.__rshift__ (self, other)
@anchor{reference/datamodel object __and__}@anchor{212e}
@deffnx {Método} object.__and__ (self, other)
@anchor{reference/datamodel object __xor__}@anchor{212f}
@deffnx {Método} object.__xor__ (self, other)
@anchor{reference/datamodel object __or__}@anchor{2130}
@deffnx {Método} object.__or__ (self, other)

@geindex função embutida;divmod
@geindex função embutida;pow
@geindex função embutida;pow

Esses métodos são chamados para implementar as operações aritméticas binárias (@code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{9a9,,divmod()}, @ref{9da,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}). Por exemplo, para avaliar a expressão @code{x + y}, onde `x' é uma instância de uma classe que tem um método @ref{2121,,__add__()}, @code{type(x).__add__(x, y)} é chamado. O método @ref{ec0,,__divmod__()} deve ser equivalente a usar @ref{153c,,__floordiv__()} e @ref{212b,,__mod__()}; não deve estar relacionado a @ref{ebf,,__truediv__()}. Note que @ref{7d4,,__pow__()} deve ser definido para aceitar um terceiro argumento opcional se a versão ternária da função embutida @ref{9da,,pow()} for suportada.

Se um desses métodos não suporta a operação com os argumentos fornecidos, ele deve retornar @ref{7d3,,NotImplemented}.
@end deffn

@geindex __radd__() (método object)
@geindex __rsub__() (método object)
@geindex __rmul__() (método object)
@geindex __rmatmul__() (método object)
@geindex __rtruediv__() (método object)
@geindex __rfloordiv__() (método object)
@geindex __rmod__() (método object)
@geindex __rdivmod__() (método object)
@geindex __rpow__() (método object)
@geindex __rlshift__() (método object)
@geindex __rrshift__() (método object)
@geindex __rand__() (método object)
@geindex __rxor__() (método object)
@geindex __ror__() (método object)
@anchor{reference/datamodel object __radd__}@anchor{2122}
@deffn {Método} object.__radd__ (self, other)
@anchor{reference/datamodel object __rsub__}@anchor{2131}
@deffnx {Método} object.__rsub__ (self, other)
@anchor{reference/datamodel object __rmul__}@anchor{2125}
@deffnx {Método} object.__rmul__ (self, other)
@anchor{reference/datamodel object __rmatmul__}@anchor{da2}
@deffnx {Método} object.__rmatmul__ (self, other)
@anchor{reference/datamodel object __rtruediv__}@anchor{2132}
@deffnx {Método} object.__rtruediv__ (self, other)
@anchor{reference/datamodel object __rfloordiv__}@anchor{2133}
@deffnx {Método} object.__rfloordiv__ (self, other)
@anchor{reference/datamodel object __rmod__}@anchor{dff}
@deffnx {Método} object.__rmod__ (self, other)
@anchor{reference/datamodel object __rdivmod__}@anchor{2134}
@deffnx {Método} object.__rdivmod__ (self, other)
@anchor{reference/datamodel object __rpow__}@anchor{7d5}
@deffnx {Método} object.__rpow__ (self, other[, modulo])
@anchor{reference/datamodel object __rlshift__}@anchor{2135}
@deffnx {Método} object.__rlshift__ (self, other)
@anchor{reference/datamodel object __rrshift__}@anchor{2136}
@deffnx {Método} object.__rrshift__ (self, other)
@anchor{reference/datamodel object __rand__}@anchor{2137}
@deffnx {Método} object.__rand__ (self, other)
@anchor{reference/datamodel object __rxor__}@anchor{2138}
@deffnx {Método} object.__rxor__ (self, other)
@anchor{reference/datamodel object __ror__}@anchor{2139}
@deffnx {Método} object.__ror__ (self, other)

@geindex função embutida;divmod
@geindex função embutida;pow

Esses métodos são chamados para implementar as operações aritméticas binárias (@code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{9a9,,divmod()}, @ref{9da,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}) com operandos refletidos (trocados). Essas funções são chamadas apenas se o operando esquerdo não suportar a operação correspondente @footnote{
“Não suportar” aqui significa que a classe não possui tal método, ou o método retorna @ref{7d3,,NotImplemented}. Não defina o método como @code{None} se quiser forçar o fallback para o método refletido do operando correto – isso terá o efeito oposto de `bloquear' explicitamente esse fallback.
} e os operandos forem de tipos diferentes. @footnote{
Para operandos do mesmo tipo, presume-se que se o método não refletido – como @ref{2121,,__add__()} – falhar, a operação geral não será suportada, razão pela qual o método refletido não é chamado.
} Por exemplo, para avaliar a expressão @code{x - y}, onde `y' é uma instância de uma classe que tem um método @ref{2131,,__rsub__()}, @code{type(y).__rsub__(y, x)} é chamado se @code{type(x).__sub__(x, y)} retorna @ref{7d3,,NotImplemented}.

@geindex função embutida;pow

Note que ternário @ref{9da,,pow()} não tentará chamar @ref{7d5,,__rpow__()} (as regras de coerção se tornariam muito complicadas).

@cartouche
@quotation Nota 
Se o tipo do operando direito for uma subclasse do tipo do operando esquerdo e essa subclasse fornecer uma implementação diferente do método refletido para a operação, este método será chamado antes do método não refletido do operando esquerdo. Esse comportamento permite que as subclasses substituam as operações de seus ancestrais.
@end quotation
@end cartouche
@end deffn

@geindex __iadd__() (método object)
@geindex __isub__() (método object)
@geindex __imul__() (método object)
@geindex __imatmul__() (método object)
@geindex __itruediv__() (método object)
@geindex __ifloordiv__() (método object)
@geindex __imod__() (método object)
@geindex __ipow__() (método object)
@geindex __ilshift__() (método object)
@geindex __irshift__() (método object)
@geindex __iand__() (método object)
@geindex __ixor__() (método object)
@geindex __ior__() (método object)
@anchor{reference/datamodel object __iadd__}@anchor{2123}
@deffn {Método} object.__iadd__ (self, other)
@anchor{reference/datamodel object __isub__}@anchor{213a}
@deffnx {Método} object.__isub__ (self, other)
@anchor{reference/datamodel object __imul__}@anchor{2126}
@deffnx {Método} object.__imul__ (self, other)
@anchor{reference/datamodel object __imatmul__}@anchor{da3}
@deffnx {Método} object.__imatmul__ (self, other)
@anchor{reference/datamodel object __itruediv__}@anchor{213b}
@deffnx {Método} object.__itruediv__ (self, other)
@anchor{reference/datamodel object __ifloordiv__}@anchor{213c}
@deffnx {Método} object.__ifloordiv__ (self, other)
@anchor{reference/datamodel object __imod__}@anchor{213d}
@deffnx {Método} object.__imod__ (self, other)
@anchor{reference/datamodel object __ipow__}@anchor{7d2}
@deffnx {Método} object.__ipow__ (self, other[, modulo])
@anchor{reference/datamodel object __ilshift__}@anchor{213e}
@deffnx {Método} object.__ilshift__ (self, other)
@anchor{reference/datamodel object __irshift__}@anchor{213f}
@deffnx {Método} object.__irshift__ (self, other)
@anchor{reference/datamodel object __iand__}@anchor{2140}
@deffnx {Método} object.__iand__ (self, other)
@anchor{reference/datamodel object __ixor__}@anchor{2141}
@deffnx {Método} object.__ixor__ (self, other)
@anchor{reference/datamodel object __ior__}@anchor{2142}
@deffnx {Método} object.__ior__ (self, other)

Esses métodos são chamados para implementar as atribuições aritméticas aumentadas (@code{+=}, @code{-=}, @code{*=}, @code{@@=}, @code{/=}, @code{//=}, @code{%=}, @code{**=}, @code{<<=}, @code{>>=}, @code{&=}, @code{^=}, @code{|=}). Esses métodos devem tentar fazer a operação no local (modificando `self') e retornar o resultado (que poderia ser, mas não precisa ser, `self'). Se um método específico não for definido, ou se esse método retorna @ref{7d3,,NotImplemented}, a atribuição aumentada volta aos métodos normais. Por exemplo, se `x' é uma instância de uma classe com um método @ref{2123,,__iadd__()}, @code{x += y} equivale a @code{x = x.__iadd__(y)}. Se @ref{2123,,__iadd__()} não existe, ou se @code{x.__iadd__(y)} retorna @code{NotImplemented}, @code{x.__add__(y)} e @code{y.__radd__(x)} são considerados, como com a avaliação de @code{x + y}. Em certas situações, a atribuição aumentada pode resultar em erros inesperados (veja @ref{2143,,Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?}), mas este comportamento é na verdade parte do modelo de dados.
@end deffn

@geindex __neg__() (método object)
@geindex __pos__() (método object)
@geindex __abs__() (método object)
@geindex __invert__() (método object)
@anchor{reference/datamodel object __neg__}@anchor{2144}
@deffn {Método} object.__neg__ (self)
@anchor{reference/datamodel object __pos__}@anchor{2145}
@deffnx {Método} object.__pos__ (self)
@anchor{reference/datamodel object __abs__}@anchor{2146}
@deffnx {Método} object.__abs__ (self)
@anchor{reference/datamodel object __invert__}@anchor{2147}
@deffnx {Método} object.__invert__ (self)

@geindex função embutida;abs

Chamado para implementar as operações aritméticas unárias (@code{-}, @code{+}, @ref{1e2d,,abs()} e @code{~}).
@end deffn

@geindex __complex__() (método object)
@geindex __int__() (método object)
@geindex __float__() (método object)
@anchor{reference/datamodel object __complex__}@anchor{5e7}
@deffn {Método} object.__complex__ (self)
@anchor{reference/datamodel object __int__}@anchor{71c}
@deffnx {Método} object.__int__ (self)
@anchor{reference/datamodel object __float__}@anchor{9d4}
@deffnx {Método} object.__float__ (self)

@geindex função embutida;complexo
@geindex função embutida;int
@geindex função embutida;ponto flutuante

Chamado para implementar as funções embutidas @ref{2f8,,complex()}, @ref{257,,int()} e @ref{2f7,,float()}. Deve retornar um valor do tipo apropriado.
@end deffn

@geindex __index__() (método object)
@anchor{reference/datamodel object __index__}@anchor{71d}
@deffn {Método} object.__index__ (self)

Chamado para implementar @ref{1a5e,,operator.index()}, e sempre que o Python precisar converter sem perdas o objeto numérico em um objeto inteiro (como no fatiamento ou nas funções embutidas @ref{12eb,,bin()}, @ref{1312,,hex()} e @ref{1311,,oct()}). A presença deste método indica que o objeto numérico é do tipo inteiro. Deve retornar um número inteiro.

Se @ref{71c,,__int__()}, @ref{9d4,,__float__()} e @ref{5e7,,__complex__()} não estiverem definidos, funções embutidas correspondentes @ref{257,,int()}, @ref{2f7,,float()} e @ref{2f8,,complex()} recorre a @ref{71d,,__index__()}.
@end deffn

@geindex __round__() (método object)
@geindex __trunc__() (método object)
@geindex __floor__() (método object)
@geindex __ceil__() (método object)
@anchor{reference/datamodel object __round__}@anchor{2148}
@deffn {Método} object.__round__ (self[, ndigits])
@anchor{reference/datamodel object __trunc__}@anchor{71b}
@deffnx {Método} object.__trunc__ (self)
@anchor{reference/datamodel object __floor__}@anchor{2149}
@deffnx {Método} object.__floor__ (self)
@anchor{reference/datamodel object __ceil__}@anchor{214a}
@deffnx {Método} object.__ceil__ (self)

@geindex função embutida;round

Chamado para implementar as funções embutidas @ref{131d,,round()} e @ref{1406,,trunc()}, @ref{1404,,floor()} e @ref{1405,,ceil()} de @ref{8e,,math}. A menos que `ndigits' sejam passados para @code{__round__()} todos estes métodos devem retornar o valor do objeto truncado para um @ref{214b,,Integral} (tipicamente um @ref{257,,int}).

A função embutida @ref{257,,int()} retorna para @ref{71b,,__trunc__()} se nem @ref{71c,,__int__()} nem @ref{71d,,__index__()} estiverem definidos.


Alterado na versão 3.11: A delegação de @ref{257,,int()} para @ref{71b,,__trunc__()} foi descontinuada.

@end deffn

@node Gerenciadores de contexto da instrução with,Customizando argumentos posicionais na classe correspondência de padrão,Emulando tipos numéricos,Nomes de métodos especiais
@anchor{reference/datamodel context-managers}@anchor{214c}@anchor{reference/datamodel with-statement-context-managers}@anchor{214d}
@subsubsection Gerenciadores de contexto da instrução with


Um `gerenciador de contexto' é um objeto que define o contexto de tempo de execução a ser estabelecido ao executar uma instrução @ref{5d2,,with}. O gerenciador de contexto lida com a entrada e a saída do contexto de tempo de execução desejado para a execução do bloco de código. Os gerenciadores de contexto são normalmente invocados usando a instrução @code{with} (descrita na seção @ref{5d2,,A instrução with}), mas também podem ser usados invocando diretamente seus métodos.

@geindex instrução;with
@geindex gerenciador de contexto

Os usos típicos de gerenciadores de contexto incluem salvar e restaurar vários tipos de estado global, travar e destravar recursos, fechar arquivos abertos, etc.

Para mais informações sobre gerenciadores de contexto, veja @ref{214e,,Tipos de Gerenciador de Contexto}. A classe @ref{a96,,object} em si não fornece os métodos do gerenciador de contexto.

@geindex __enter__() (método object)
@anchor{reference/datamodel object __enter__}@anchor{5c8}
@deffn {Método} object.__enter__ (self)

Insere o contexto de tempo de execução relacionado a este objeto. A instrução @ref{5d2,,with} vinculará o valor de retorno deste método ao(s) alvo(s) especificado(s) na cláusula @code{as} da instrução, se houver.
@end deffn

@geindex __exit__() (método object)
@anchor{reference/datamodel object __exit__}@anchor{1344}
@deffn {Método} object.__exit__ (self, exc_type, exc_value, traceback)

Sai do contexto de tempo de execução relacionado a este objeto. Os parâmetros descrevem a exceção que fez com que o contexto fosse encerrado. Se o contexto foi encerrado sem exceção, todos os três argumentos serão @ref{675,,None}.

Se uma exceção for fornecida e o método desejar suprimir a exceção (ou seja, evitar que ela seja propagada), ele deve retornar um valor verdadeiro. Caso contrário, a exceção será processada normalmente ao sair deste método.

Observe que os métodos @ref{1344,,__exit__()} não devem relançar a exceção passada; esta é a responsabilidade do chamador.
@end deffn


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - A instrução “with”

A especificação, o histórico e os exemplos para a instrução Python @ref{5d2,,with}.
@end table


@node Customizando argumentos posicionais na classe correspondência de padrão,Emulando tipos buffer,Gerenciadores de contexto da instrução with,Nomes de métodos especiais
@anchor{reference/datamodel class-pattern-matching}@anchor{214f}@anchor{reference/datamodel customizing-positional-arguments-in-class-pattern-matching}@anchor{2150}
@subsubsection Customizando argumentos posicionais na classe correspondência de padrão


Ao usar um nome de classe em um padrão, argumentos posicionais não são permitidos por padrão, ou seja, @code{case MyClass(x, y)} é tipicamente inválida sem suporte especial em @code{MyClass}. Para permitir a utilização desse tipo de padrão, a classe precisa definir um atributo `__match_args__'

@geindex object.__match_args__ (variável interna)
@anchor{reference/datamodel object __match_args__}@anchor{1a01}
@deffn {Dado} object.__match_args__

Essa variável de classe pode ser atribuída a uma tupla de strings. Quando essa classe é usada em uma classe padrão com argumentos posicionais, cada argumento posicional será convertido para um argumento nomeado, usando correspondência de valor em  `__match_args__' como palavra reservada. A ausência desse atributo é equivalente a defini-lo como @code{()}
@end deffn

Por exemplo, se @code{MyClass.__match_args__} é @code{("left", "center", "right")} significa que @code{case MyClass(x, y)} é equivalente a @code{case MyClass(left=x, center=y)}. Note que o número de argumentos no padrão deve ser menor ou igual ao número de elementos em `__match_args__'; caso seja maior, a tentativa de correspondência de padrão irá levantar uma @ref{2c3,,TypeError}.


Adicionado na versão 3.10.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 634

@item PEP 634@footnote{https://peps.python.org/pep-0634/} - Correspondência de Padrão Estrutural

A especificação para a instrução Python @code{match}
@end table


@node Emulando tipos buffer,Pesquisa de método especial,Customizando argumentos posicionais na classe correspondência de padrão,Nomes de métodos especiais
@anchor{reference/datamodel emulating-buffer-types}@anchor{2151}@anchor{reference/datamodel python-buffer-protocol}@anchor{2152}
@subsubsection Emulando tipos buffer


O @ref{2e8,,protocolo buffer} fornece uma maneira para objetos Python exporem acesso eficiente a um vetor de memória de baixo nível. Este protocolo é implementado por tipos embutido como @ref{1c2,,bytes} e @ref{2eb,,memoryview}, e bibliotecas de terceiros podem definir tipos de buffer adicionais.

Embora os tipos buffer sejam geralmente implementados em C, também é possível implementar o protocolo em Python.

@geindex __buffer__() (método object)
@anchor{reference/datamodel object __buffer__}@anchor{45f}
@deffn {Método} object.__buffer__ (self, flags)

Chamado quando um buffer é solicitado de `self' (por exemplo, pelo construtor de @ref{2eb,,memoryview}). O argumento `flags' é um inteiro que representa o tipo de buffer solicitado, afetando, por exemplo, se o buffer retornado é somente leitura ou gravável. @ref{460,,inspect.BufferFlags} fornece uma maneira conveniente de interpretar os sinalizadores. O método deve retornar um objeto @ref{2eb,,memoryview}.
@end deffn

@geindex __release_buffer__() (método object)
@anchor{reference/datamodel object __release_buffer__}@anchor{17e7}
@deffn {Método} object.__release_buffer__ (self, buffer)

Chamado quando um buffer não é mais necessário. O argumento `buffer' é um objeto @ref{2eb,,memoryview} que foi retornado anteriormente por @ref{45f,,__buffer__()}. O método deve liberar quaisquer recursos associados ao buffer. Este método deve retornar @code{None}. Objetos buffer que não precisam executar nenhuma limpeza não são necessários para implementar este método.
@end deffn


Adicionado na versão 3.12.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 688

@item PEP 688@footnote{https://peps.python.org/pep-0688/} - Tornando o protocolo de buffer acessível no Python

Introduz os métodos @code{__buffer__} e @code{__release_buffer__} no Python

@item @ref{2e9,,collections.abc.Buffer}

ABC para tipos buffer.
@end table


@node Pesquisa de método especial,,Emulando tipos buffer,Nomes de métodos especiais
@anchor{reference/datamodel special-lookup}@anchor{20f3}@anchor{reference/datamodel special-method-lookup}@anchor{2153}
@subsubsection Pesquisa de método especial


Para classes personalizadas, as invocações implícitas de métodos especiais só têm garantia de funcionar corretamente se definidas em um tipo de objeto, não no dicionário de instância do objeto. Esse comportamento é o motivo pelo qual o código a seguir levanta uma exceção:

@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

A justificativa por trás desse comportamento está em uma série de métodos especiais como @ref{b0e,,__hash__()} e @ref{61c,,__repr__()} que são implementados por todos os objetos, incluindo objetos de tipo. Se a pesquisa implícita desses métodos usasse o processo de pesquisa convencional, eles falhariam quando invocados no próprio objeto do tipo:

@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

A tentativa incorreta de invocar um método não vinculado de uma classe dessa maneira é às vezes referida como “confusão de metaclasse” e é evitada ignorando a instância ao pesquisar métodos especiais:

@example
>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True
@end example

Além de contornar quaisquer atributos de instância no interesse da correção, a pesquisa de método especial implícita geralmente também contorna o método @ref{beb,,__getattribute__()} mesmo da metaclasse do 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

Ignorar a maquinaria de @ref{beb,,__getattribute__()} desta forma fornece um escopo significativo para otimizações de velocidade dentro do interpretador, ao custo de alguma flexibilidade no tratamento de métodos especiais (o método especial `deve' ser definido no próprio objeto classe em ordem ser invocado de forma consistente pelo interpretador).

@geindex corrotina

@node Corrotinas,,Nomes de métodos especiais,Modelo de dados
@anchor{reference/datamodel coroutines}@anchor{2154}
@subsection Corrotinas


@menu
* Objetos aguardáveis:: 
* Objetos corrotina:: 
* Iteradores assíncronos:: 
* Gerenciadores de contexto assíncronos:: 

@end menu

@node Objetos aguardáveis,Objetos corrotina,,Corrotinas
@anchor{reference/datamodel awaitable-objects}@anchor{2155}
@subsubsection Objetos aguardáveis


Um objeto @ref{1ad,,aguardável} geralmente implementa um método @ref{d9d,,__await__()}. Os @ref{491,,objetos corrotina} retornados das funções @ref{5d1,,async def} são aguardáveis.

@cartouche
@quotation Nota 
Os objetos @ref{bf9,,iteradores geradores} retornados de geradores decorados com @ref{eb7,,types.coroutine()} também são aguardáveis, mas eles não implementam @ref{d9d,,__await__()}.
@end quotation
@end cartouche

@geindex __await__() (método object)
@anchor{reference/datamodel object __await__}@anchor{d9d}
@deffn {Método} object.__await__ (self)

Deve retornar um @ref{1ac,,iterador}. Deve ser usado para implementar objetos @ref{1ad,,aguardáveis}. Por exemplo, @ref{be6,,asyncio.Future} implementa este método para ser compatível com a expressão @ref{1b9,,await}. A classe @ref{a96,,object} em si não é aguardável e não fornece este método.

@cartouche
@quotation Nota 
A linguagem não impõe nenhuma restrição ao tipo ou valor dos objetos produzidos pelo iterador retornado por @code{__await__}, pois isso é específico para a implementação da estrutura de execução assíncrona (por exemplo, @ref{a,,asyncio}) que gerenciará o objeto @ref{1ad,,awaitable}.
@end quotation
@end cartouche
@end deffn


Adicionado na versão 3.5.



@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} para informações adicionais sobre objetos aguardáveis.


@node Objetos corrotina,Iteradores assíncronos,Objetos aguardáveis,Corrotinas
@anchor{reference/datamodel coroutine-objects}@anchor{2099}@anchor{reference/datamodel id18}@anchor{2156}
@subsubsection Objetos corrotina


@ref{491,,Objetos corrotina} são objetos @ref{1ad,,aguardáveis}. A execução de uma corrotina pode ser controlada chamando @ref{d9d,,__await__()} e iterando sobre o resultado. Quando a corrotina termina a execução e retorna, o iterador levanta @ref{c15,,StopIteration}, e o atributo @ref{2157,,value} da exceção contém o valor de retorno. Se a corrotina levantar uma exceção, ela será propagada pelo iterador. As corrotinas não devem levantar exceções @ref{c15,,StopIteration} diretamente não tratadas.

As corrotinas também têm os métodos listados abaixo, que são análogos aos dos geradores (ver @ref{2158,,Métodos de iterador gerador}). No entanto, ao contrário dos geradores, as corrotinas não suportam diretamente a iteração.


Alterado na versão 3.5.2: É uma @ref{195,,RuntimeError} para aguardar uma corrotina mais de uma vez.


@geindex send() (método coroutine)
@anchor{reference/datamodel coroutine send}@anchor{2159}
@deffn {Método} coroutine.send (value)

Inicia ou retoma a execução da corrotina. Se `value' for @code{None}, isso equivale a avançar o iterador retornado por @ref{d9d,,__await__()}. Se `value' não for @code{None}, este método delega para o método @ref{215a,,send()} do iterador que causou a suspensão da corrotina. O resultado (valor de retorno, @ref{c15,,StopIteration} ou outra exceção) é o mesmo de iterar sobre o valor de retorno @code{__await__()}, descrito acima.
@end deffn

@geindex throw() (método coroutine)
@anchor{reference/datamodel coroutine throw}@anchor{4f7}
@deffn {Método} coroutine.throw (value)

@deffnx {Método} coroutine.throw (type[, value[, traceback]])

Levanta a exceção especificada na corrotina. Este método delega ao método @ref{4f8,,throw()} do iterador que causou a suspensão da corrotina, se ela tiver tal método. Caso contrário, a exceção é levantada no ponto de suspensão. O resultado (valor de retorno, @ref{c15,,StopIteration} ou outra exceção) é o mesmo de iterar sobre o valor de retorno @ref{d9d,,__await__()}, descrito acima. Se a exceção não for capturada na corrotina, ela se propagará de volta para o chamador.


Alterado na versão 3.12: A segunda assinatura (tipo[, valor[, traceback]]) foi descontinuada e pode ser removida em uma versão futura do Python.

@end deffn

@geindex close() (método coroutine)
@anchor{reference/datamodel coroutine close}@anchor{215b}
@deffn {Método} coroutine.close ()

Faz com que a corrotina se limpe e saia. Se a corrotina for suspensa, este método primeiro delega para o método @ref{15b9,,close()} do iterador que causou a suspensão da corrotina, se tiver tal método. Então ele levanta @ref{140e,,GeneratorExit} no ponto de suspensão, fazendo com que a corrotina se limpe imediatamente. Por fim, a corrotina é marcada como tendo sua execução concluída, mesmo que nunca tenha sido iniciada.

Objetos corrotina são fechados automaticamente usando o processo acima quando estão prestes a ser destruídos.
@end deffn

@node Iteradores assíncronos,Gerenciadores de contexto assíncronos,Objetos corrotina,Corrotinas
@anchor{reference/datamodel async-iterators}@anchor{d9f}@anchor{reference/datamodel asynchronous-iterators}@anchor{215c}
@subsubsection Iteradores assíncronos


Um `iterador assíncrono' pode chamar código assíncrono em seu método @code{__anext__}.

Os iteradores assíncronos podem ser usados em uma instrução @ref{aba,,async for}.

A classe @ref{a96,,object} em si não fornece estes métodos.

@geindex __aiter__() (método object)
@anchor{reference/datamodel object __aiter__}@anchor{c16}
@deffn {Método} object.__aiter__ (self)

Deve retornar um objeto `iterador assíncrono'.
@end deffn

@geindex __anext__() (método object)
@anchor{reference/datamodel object __anext__}@anchor{1659}
@deffn {Método} object.__anext__ (self)

Deve retornar um `aguardável' resultando em um próximo valor do iterador. Deve levantar um erro @ref{1ba5,,StopAsyncIteration} quando a iteração terminar.
@end deffn

Um exemplo de objeto iterável assí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


Adicionado na versão 3.5.



Alterado na versão 3.7: Antes do Python 3.7, @ref{c16,,__aiter__()} poderia retornar um `aguardável' que resolveria para um @ref{1ab,,iterador assíncrono}.

A partir do Python 3.7, @ref{c16,,__aiter__()} deve retornar um objeto iterador assíncrono. Retornar qualquer outra coisa resultará em um erro @ref{2c3,,TypeError}.


@node Gerenciadores de contexto assíncronos,,Iteradores assíncronos,Corrotinas
@anchor{reference/datamodel async-context-managers}@anchor{5fc}@anchor{reference/datamodel asynchronous-context-managers}@anchor{215d}
@subsubsection Gerenciadores de contexto assíncronos


Um `gerenciador de contexto assíncrono' é um `gerenciador de contexto' que é capaz de suspender a execução em seus métodos @code{__aenter__} e @code{__aexit__}.

Os gerenciadores de contexto assíncronos podem ser usados em uma instrução @ref{5d5,,async with}.

A classe @ref{a96,,object} em si não fornece estes métodos.

@geindex __aenter__() (método object)
@anchor{reference/datamodel object __aenter__}@anchor{215e}
@deffn {Método} object.__aenter__ (self)

Semanticamente semelhante a @ref{5c8,,__enter__()}, a única diferença é que ele deve retornar um `aguardável'.
@end deffn

@geindex __aexit__() (método object)
@anchor{reference/datamodel object __aexit__}@anchor{1716}
@deffn {Método} object.__aexit__ (self, exc_type, exc_value, traceback)

Semanticamente semelhante a @ref{1344,,__exit__()}, a única diferença é que ele deve retornar um `aguardável'.
@end deffn

Um exemplo de uma classe gerenciadora de contexto assíncrona:

@example
class AsyncContextManager:
    async def __aenter__(self):
        await log('entrando no contexto')

    async def __aexit__(self, exc_type, exc, tb):
        await log('saindo do contexto')
@end example


Adicionado na versão 3.5.


@node Modelo de execução,O sistema de importação,Modelo de dados,A Referência da Linguagem Python
@anchor{reference/executionmodel doc}@anchor{215f}@anchor{reference/executionmodel execmodel}@anchor{2160}@anchor{reference/executionmodel execution-model}@anchor{2161}@anchor{reference/executionmodel translation-repo}@anchor{2162}
@section Modelo de execução


@geindex execução@comma{} modelo
@geindex código;bloco

@menu
* Estrutura de um programa:: 
* Nomeação e ligação:: 
* Exceções: Exceções<2>. 

@end menu

@node Estrutura de um programa,Nomeação e ligação,,Modelo de execução
@anchor{reference/executionmodel prog-structure}@anchor{2163}@anchor{reference/executionmodel structure-of-a-program}@anchor{2164}
@subsection Estrutura de um programa


@geindex bloco

Um programa Python é construído a partir de blocos de código. Um `bloco' é um pedaço do texto do programa Python que é executado como uma unidade. A seguir estão os blocos: um módulo, um corpo de função e uma definição de classe. Cada comando digitado interativamente é um bloco. Um arquivo de script (um arquivo fornecido como entrada padrão para o interpretador ou especificado como argumento de linha de comando para o interpretador) é um bloco de código. Um comando de script (um comando especificado na linha de comando do interpretador com a opção @ref{5e0,,-c}) é um bloco de código. Um módulo executado sobre um script de nível superior (como o módulo @code{__main__}) a partir da linha de comando usando um argumento @ref{5e1,,-m} também é um bloco de código. O argumento da string passado para as funções embutidas @ref{180,,eval()} e @ref{17f,,exec()} é um bloco de código.

@geindex execução;quadro

Um bloco de código é executado em um `quadro de execução'. Um quadro contém algumas informações administrativas (usadas para depuração) e determina onde e como a execução continua após a conclusão do bloco de código.

@node Nomeação e ligação,Exceções<2>,Estrutura de um programa,Modelo de execução
@anchor{reference/executionmodel naming}@anchor{208a}@anchor{reference/executionmodel naming-and-binding}@anchor{2165}
@subsection Nomeação e ligação


@geindex espaço de nomes
@geindex escopo

@menu
* Ligação de nomes:: 
* Resolução de nomes:: 
* Escopos de anotação:: 
* Avaliação preguiçosa:: 
* Builtins e execução restrita:: 
* Interação com recursos dinâmicos:: 

@end menu

@node Ligação de nomes,Resolução de nomes,,Nomeação e ligação
@anchor{reference/executionmodel bind-names}@anchor{2166}@anchor{reference/executionmodel binding-of-names}@anchor{2167}
@subsubsection Ligação de nomes


@geindex nome
@geindex vinculação; ligação;nome

`Nomes' referem-se a objetos. Os nomes são introduzidos por operações de ligação de nomes.

@geindex from;instrução import

As seguintes construções ligam nomes:


@itemize *

@item 
parâmetros formais para funções,

@item 
definições de classe,

@item 
definições de função,

@item 
expressões de atribuição,

@item 
@ref{2168,,alvos} que são identificadores se ocorrerem em uma atribuição:


@itemize +

@item 
cabeçalho de laço @ref{2f2,,for},

@item 
depois de @code{as} em uma instrução @ref{5d2,,with}, cláusula @ref{18b,,except}, cláusula @ref{5b8,,except*} ou no padrão as na correspondência de padrões estruturais,

@item 
em um padrão de captura na correspondência de padrões estruturais
@end itemize

@item 
instruções @ref{5e2,,import}.

@item 
instruções @ref{438,,type}.

@item 
@ref{2b3,,listas de parâmetros de tipo}.
@end itemize

A instrução @code{import} no formato @code{from ... import *} liga todos os nomes definidos no módulo importado, exceto aqueles que começam com um sublinhado. Este formulário só pode ser usado no nível do módulo.

Um alvo ocorrendo em uma instrução @ref{18a7,,del} também é considerado ligado a esse propósito (embora a semântica real seja para desligar do nome).

Cada atribuição ou instrução de importação ocorre dentro de um bloco definido por uma definição de classe ou função ou no nível do módulo (o bloco de código de nível superior).

@geindex livre;variável

Se um nome está ligado a um bloco, é uma variável local desse bloco, a menos que declarado como @ref{12ea,,nonlocal} ou @ref{18a,,global}. Se um nome está ligado a nível do módulo, é uma variável global. (As variáveis do bloco de código do módulo são locais e globais.) Se uma variável for usada em um bloco de código, mas não definida lá, é uma @ref{2169,,variável livre}.

Cada ocorrência de um nome no texto do programa se refere à `ligação' daquele nome estabelecido pelas seguintes regras de resolução de nome.

@node Resolução de nomes,Escopos de anotação,Ligação de nomes,Nomeação e ligação
@anchor{reference/executionmodel resolution-of-names}@anchor{216a}@anchor{reference/executionmodel resolve-names}@anchor{216b}
@subsubsection Resolução de nomes


@geindex escopo

O `escopo' define a visibilidade de um nome dentro de um bloco. Se uma variável local é definida em um bloco, seu escopo inclui esse bloco. Se a definição ocorrer em um bloco de função, o escopo se estende a quaisquer blocos contidos no bloco de definição, a menos que um bloco contido introduza uma ligação diferente para o nome.

@geindex ambiente

Quando um nome é usado em um bloco de código, ele é resolvido usando o escopo envolvente mais próximo. O conjunto de todos esses escopos visíveis a um bloco de código é chamado de `ambiente' do bloco.

@geindex NameError (exceção embutida)
@geindex UnboundLocalError

Quando um nome não é encontrado, uma exceção @ref{43f,,NameError} é levantada. Se o escopo atual for um escopo de função e o nome se referir a uma variável local que ainda não foi associada a um valor no ponto onde o nome é usado, uma exceção @ref{157f,,UnboundLocalError} é levantada. @ref{157f,,UnboundLocalError} é uma subclasse de @ref{43f,,NameError}.

Se a operação de ligação de nomes ocorre dentro de um bloco de código, todos os usos do nome dentro do bloco são tratadas como referências para o bloco atual. Isso pode. Isso pode levar a erros quando um nome é usado em um bloco antes de ser vinculado.  Esta regra é sutil.  Python carece de declarações e permite que as operações de ligação de nomes ocorram em qualquer lugar dentro de um bloco de código. As variáveis locais de um bloco de código podem ser determinadas pela varredura de todo o texto do bloco para operações de ligação de nome. Veja @ref{216c,,o FAQ sobre UnboundLocalError} para exemplos.

Se a instrução @ref{18a,,global} ocorrer dentro de um bloco, todos os usos dos nomes especificados na instrução referem-se às ligações desses nomes no espaço de nomes de nível superior. Os nomes são resolvidos no espaço de nomes de nível superior pesquisando o espaço de nomes global, ou seja, o espaço de nomes do módulo que contém o bloco de código, e o espaço de nomes embutido, o espaço de nomes do módulo @ref{12,,builtins}. O espaço de nomes global é pesquisado primeiro. Se os nomes não forem encontrados lá, o espaço de nomes embutidos será pesquisado em seguida. Se os nomes também não forem encontrados no espaço de nomes embutido, novas variáveis são criadas no espaço de nomes global. A instrução global deve preceder todos os usos dos nomes listados.

A instrução @ref{18a,,global} tem o mesmo escopo que uma operação de ligação de nome no mesmo bloco. Se o escopo mais próximo de uma variável livre contiver uma instrução global, a variável livre será tratada como global.

@c XXX say more about "nonlocal" semantics here

A instrução @ref{12ea,,nonlocal} faz com que os nomes correspondentes se refiram a variáveis previamente vinculadas no escopo da função delimitadora mais próxima. A exceção @ref{18d,,SyntaxError} é levantada em tempo de compilação se o nome fornecido não existir em nenhum escopo de função delimitador. @ref{2b3,,Parâmetros de tipo} não podem ser vinculadas novamente com a instrução @code{nonlocal}.

@geindex módulo;__main__

O espaço de nomes de um módulo é criado automaticamente na primeira vez que um módulo é importado. O módulo principal de um script é sempre chamado de @ref{1,,__main__}.

Blocos de definição de classe e argumentos para @ref{17f,,exec()} e @ref{180,,eval()} são especiais no contexto de resolução de nome. Uma definição de classe é uma instrução executável que pode usar e definir nomes. Essas referências seguem as regras normais para resolução de nome, com exceção de que variáveis locais não vinculadas são pesquisadas no espaço de nomes global global. O espaço de nomes global da definição de classe se torna o dicionário de atributos da classe. O escopo dos nomes definidos em um bloco de classe é limitado ao bloco de classe; ele não se estende aos blocos de código de métodos. Isso inclui compreensões e expressões geradoras, mas não inclui @ref{188,,escopos de anotação}, que têm acesso a seus escopos de classe delimitadores. Isso significa que o seguinte falhará:

@example
class A:
    a = 42
    b = list(a + i for i in range(10))
@end example

Porém, o seguinte vai funcionar:

@example
class A:
    type Alias = Nested
    class Nested: pass

print(A.Alias.__value__)  # <type 'A.Nested'>
@end example

@node Escopos de anotação,Avaliação preguiçosa,Resolução de nomes,Nomeação e ligação
@anchor{reference/executionmodel annotation-scopes}@anchor{188}@anchor{reference/executionmodel id1}@anchor{216d}
@subsubsection Escopos de anotação


As instruções @ref{438,,type} e @ref{2b3,,listas de parâmetros de tipo} introduzem `escopos de anotação', que se comportam principalmente como escopos de função, mas com algumas exceções discutidas abaixo. @ref{458,,Anotações} atualmente não usam escopos de anotação, mas espera-se que elas usem escopos de anotação no Python 3.13 quando 
@geindex Propostas de Melhorias do Python; PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} for implementada.

Os escopos de anotação são usados nos seguintes contextos:


@itemize *

@item 
Listas de parâmetros de tipo para @ref{456,,apelidos de tipo genérico}.

@item 
Listas de parâmetros de tipo para @ref{453,,funções genéricas}. As anotações de uma função genérica são executadas dentro do escopo de anotação, mas seus padrões e decoradores não.

@item 
Listas de parâmetros de tipo para @ref{453,,classes genéricas}. As classes base e argumentos nomeados de uma classe genérica são executadas dentro do escopo de anotação, mas seus decoradores não.

@item 
Os limites, restrições e valores padrão para parâmetros de tipo (@ref{457,,avaliados preguiçosamente}).

@item 
O valor dos apelidos de tipo (@ref{457,,avaliado preguiçosamente}).
@end itemize

Escopos de anotação diferenciam-se de escopos de função nas seguintes formas:


@itemize *

@item 
Os escopos de anotação têm acesso ao espaço de nomes da classe delimitadora. Se um escopo de anotação estiver imediatamente dentro de um escopo de classe ou dentro de outro escopo de anotação que esteja imediatamente dentro de um escopo de classe, o código no escopo de anotação poderá usar nomes definidos no escopo de classe como se fosse executado diretamente no corpo da classe. Isto contrasta com funções regulares definidas dentro de classes, que não podem acessar nomes definidos no escopo da classe.

@item 
Expressões em escopos de anotação não podem conter expressões @ref{9d5,,yield}, @code{yield from}, @ref{1b9,,await} ou @code{:= 1}. (Essas expressões são permitidas em outros escopos contidos no escopo de anotação.)

@item 
Nomes definidos em escopos de anotação não podem ser vinculados novamente com instruções @ref{12ea,,nonlocal} em escopos internos. Isso inclui apenas parâmetros de tipo, pois nenhum outro elemento sintático que pode aparecer nos escopos de anotação pode introduzir novos nomes.

@item 
Embora os escopos de anotação tenham um nome interno, esse nome não é refletido no @ref{1ab1,,nome qualificado} dos objetos definidos dentro do escopo. Em vez disso, o @ref{109e,,__qualname__} de tais objetos é como se o objeto fosse definido no escopo delimitador.
@end itemize


Adicionado na versão 3.12: Escopos de anotação foram introduzidos no Python 3.12 como parte da 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Alterado na versão 3.13: Os escopos de anotação também são usados para padrões de parâmetros de tipo, conforme introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}.


@node Avaliação preguiçosa,Builtins e execução restrita,Escopos de anotação,Nomeação e ligação
@anchor{reference/executionmodel id2}@anchor{216e}@anchor{reference/executionmodel lazy-evaluation}@anchor{457}
@subsubsection Avaliação preguiçosa


Os valores dos apelidos de tipo criados através da instrução @ref{438,,type} são `avaliados preguiçosamente'. O mesmo se aplica aos limites, restrições e valores padrão de variáveis de tipo criadas através da @ref{2b3,,sintaxe do parâmetro de tipo}. Isso significa que eles não são avaliados quando o apelido de tipo ou a variável de tipo é criado. Em vez disso, eles são avaliados apenas quando isso é necessário para resolver um acesso de atributo.

Exemplo:

@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

Aqui a exceção é levantada apenas quando o atributo @code{__value__} do apelido de tipo ou o atributo @code{__bound__} da variável de tipo é acessado.

Esse comportamento é útil principalmente para referências a tipos que ainda não foram definidos quando o alias de tipo ou variável de tipo é criado. Por exemplo, a avaliação preguiçosa permite a criação de apelidos 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

Valores avaliados preguiçosamente são avaliados em @ref{188,,escopo de anotação}, o que significa que os nomes que aparecem dentro do valor avaliado preguiçosamente são pesquisados como se fossem usados no escopo imediatamente envolvente.


Adicionado na versão 3.12.


@node Builtins e execução restrita,Interação com recursos dinâmicos,Avaliação preguiçosa,Nomeação e ligação
@anchor{reference/executionmodel builtins-and-restricted-execution}@anchor{216f}@anchor{reference/executionmodel restrict-exec}@anchor{2170}
@subsubsection Builtins e execução restrita


@geindex restrita;execução

Os usuários não devem tocar em @code{__builtins__}; é estritamente um detalhe de implementação. Usuários que desejam substituir valores no espaço de nomes interno devem @ref{5e2,,import} o módulo @ref{12,,builtins} e modificar seus atributos apropriadamente.

O espaço de nomes builtins associado com a execução de um bloco de código é encontrado procurando o nome @code{__builtins__} em seu espaço de nomes global; este deve ser um dicionário ou um módulo (no último caso, o dicionário do módulo é usado). Por padrão, quando no módulo @ref{1,,__main__}, @code{__builtins__} é o módulo embutido @ref{12,,builtins}; quando em qualquer outro módulo, @code{__builtins__} é um apelido para o dicionário do próprio módulo @ref{12,,builtins}.

@node Interação com recursos dinâmicos,,Builtins e execução restrita,Nomeação e ligação
@anchor{reference/executionmodel dynamic-features}@anchor{2171}@anchor{reference/executionmodel interaction-with-dynamic-features}@anchor{2172}
@subsubsection Interação com recursos dinâmicos


A resolução de nome de variáveis livres ocorre em tempo de execução, não em tempo de compilação. Isso significa que o código a seguir imprimirá 42:

@example
i = 10
def f():
    print(i)
i = 42
f()
@end example

@c XXX from * also invalid with relative imports (at least currently)

As funções @ref{180,,eval()} e @ref{17f,,exec()} não têm acesso ao ambiente completo para resolução de nome. Os nomes podem ser resolvidos nos espaços de nomes locais e globais do chamador. Variáveis livres não são resolvidas no espaço de nomes mais próximo, mas no espaço de nomes global. @footnote{
Essa limitação ocorre porque o código executado por essas operações não está disponível no momento em que o módulo é compilado.
} As funções @ref{17f,,exec()} e @ref{180,,eval()} possuem argumentos opcionais para substituir o espaço de nomes global e local. Se apenas um espaço de nomes for especificado, ele será usado 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 Exceções<2>,,Nomeação e ligação,Modelo de execução
@anchor{reference/executionmodel exceptions}@anchor{2173}@anchor{reference/executionmodel id4}@anchor{2174}
@subsection Exceções


@geindex exceção

@geindex levantar uma exceção
@geindex manipular uma exceção
@geindex tratador de exceção
@geindex erros
@geindex tratamento de erros

As exceções são um meio de romper o fluxo normal de controle de um bloco de código para tratar erros ou outras condições excepcionais. Uma exceção é `levantada' no ponto em que o erro é detectado; ele pode ser `tratado' pelo bloco de código circundante ou por qualquer bloco de código que invocou direta ou indiretamente o bloco de código onde ocorreu o erro.

O interpretador Python levanta uma exceção quando detecta um erro em tempo de execução (como divisão por zero). Um programa Python também pode levantar explicitamente uma exceção com a instrução @ref{5ed,,raise}. Os tratadores de exceção são especificados com a instrução @ref{6e9,,try} … @ref{18b,,except}. A cláusula @ref{9d2,,finally} de tal declaração pode ser usada para especificar o código de limpeza que não trata a exceção, mas é executado se uma exceção ocorreu ou não no código anterior.

@geindex modelo de terminação

Python usa o modelo de “terminação” da manipulação de erros: um manipulador de exceção pode descobrir o que aconteceu e continuar a execução em um nível externo, mas não pode reparar a causa do erro e tentar novamente a operação com falha (exceto reinserindo a parte incorreta de código de cima).

@geindex SystemExit (exceção embutida)

Quando uma exceção não é manipulada, o interpretador encerra a execução do programa ou retorna ao seu laço principal interativo. Em ambos os casos, ele exeibe um traceback (situação da pilha de execução), exceto quando a exceção é @ref{d63,,SystemExit}.

As exceções são identificadas por instâncias de classe. A cláusula @ref{18b,,except} é selecionada dependendo da classe da instância: ela deve referenciar a classe da instância ou uma @ref{11f5,,classe base não-virtual} dela. A instância pode ser recebida pelo manipulador e pode conter informações adicionais sobre a condição excepcional.

@cartouche
@quotation Nota 
As mensagens de exceção não fazem parte da API do Python. Seu conteúdo pode mudar de uma versão do Python para outra sem aviso e não deve ser invocado pelo código que será executado em várias versões do interpretador.
@end quotation
@end cartouche

Veja também a descrição da declaração @ref{6e9,,try} na seção @ref{6e9,,A instrução try} e a instrução @ref{5ed,,raise} na seção @ref{5ed,,A instrução raise}.

@node O sistema de importação,Expressões,Modelo de execução,A Referência da Linguagem Python
@anchor{reference/import doc}@anchor{2175}@anchor{reference/import importsystem}@anchor{20a3}@anchor{reference/import the-import-system}@anchor{2176}@anchor{reference/import translation-repo}@anchor{2177}
@section O sistema de importação


@geindex maquinário de importação

O código Python em um @ref{1755,,módulo} obtém acesso ao código em outro módulo pelo processo de @ref{2178,,importação} dele. A instrução @ref{5e2,,import} é a maneira mais comum de invocar o mecanismo de importação, mas não é a única maneira. Funções como @ref{518,,importlib.import_module()} e a função embutida @ref{8da,,__import__()} também podem ser usadas para chamar o mecanismo de importação.

A instrução @ref{5e2,,import} combina duas operações; ela procura o módulo nomeado e vincula os resultados dessa pesquisa a um nome no escopo local. A operação de busca da instrução @code{import} é definida como uma chamada para a função @ref{8da,,__import__()}, com os argumentos apropriados. O valor de retorno de @ref{8da,,__import__()} é usado para executar a operação de ligação de nome da instrução @code{import}. Veja a instrução @code{import} para os detalhes exatos da operação de ligação desse nome.

Uma chamada direta para @ref{8da,,__import__()} realiza apenas a pesquisa do módulo e, se encontrada, a operação de criação do módulo. Embora certos efeitos colaterais possam ocorrer, como a importação de pacotes pai e a atualização de vários caches (incluindo @ref{1636,,sys.modules}), apenas a instrução @ref{5e2,,import} realiza uma operação de ligação de nome.

Quando uma instrução @ref{5e2,,import} é executada, a função embutida padrão @ref{8da,,__import__()} é chamada. Outros mecanismos para chamar o sistema de importação (como @ref{518,,importlib.import_module()}) podem optar por ignorar @ref{8da,,__import__()} e usar suas próprias soluções para implementar a semântica de importação.

Quando um módulo é importado pela primeira vez, o Python procura pelo módulo e, se encontrado, cria um objeto de módulo @footnote{
Veja @ref{e3f,,types.ModuleType}.
}, inicializando-o. Se o módulo nomeado não puder ser encontrado, uma @ref{b5b,,ModuleNotFoundError} será levantada. O Python implementa várias estratégias para procurar o módulo nomeado quando o mecanismo de importação é chamado. Essas estratégias podem ser modificadas e estendidas usando vários ganchos descritos nas seções abaixo.


Alterado na versão 3.3: O sistema de importação foi atualizado para implementar completamente a segunda fase da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}. Não há mais um mecanismo de importação implícito – o sistema completo de importação é exposto através de @ref{d4d,,sys.meta_path}. Além disso, o suporte nativo a pacote de espaço de nomes foi implementado (consulte 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}).


@menu
* importlib: importlib<10>. 
* Pacotes: Pacotes<2>. 
* Caminho de busca:: 
* Carregando:: 
* O localizador baseado no caminho:: 
* Substituindo o sistema de importação padrão:: 
* Importações relativas ao pacote:: 
* Considerações especiais para __main__:: 
* Referências:: 

@end menu

@node importlib<10>,Pacotes<2>,,O sistema de importação
@anchor{reference/import importlib}@anchor{2179}
@subsection @code{importlib}


O módulo @ref{77,,importlib} fornece uma API rica para interagir com o sistema de importação. Por exemplo, @ref{518,,importlib.import_module()} fornece uma API mais simples e recomendada do que a função embutida @ref{8da,,__import__()} para chamar o mecanismo de importação. Consulte a documentação da biblioteca @ref{77,,importlib} para obter detalhes adicionais.

@node Pacotes<2>,Caminho de busca,importlib<10>,O sistema de importação
@anchor{reference/import packages}@anchor{217a}
@subsection Pacotes


@geindex pacote

O Python possui apenas um tipo de objeto de módulo e todos os módulos são desse tipo, independentemente de o módulo estar implementado em Python, C ou qualquer outra coisa. Para ajudar a organizar os módulos e fornecer uma hierarquia de nomes, o Python tem o conceito de @ref{20aa,,pacotes}.

Você pode pensar em pacotes como os diretórios em um sistema de arquivos e os módulos como arquivos nos diretórios, mas não tome essa analogia muito literalmente, já que pacotes e módulos não precisam se originar do sistema de arquivos. Para os fins desta documentação, usaremos essa analogia conveniente de diretórios e arquivos. Como os diretórios do sistema de arquivos, os pacotes são organizados hierarquicamente e os próprios pacotes podem conter subpacotes e módulos regulares.

É importante ter em mente que todos os pacotes são módulos, mas nem todos os módulos são pacotes. Ou, dito de outra forma, os pacotes são apenas um tipo especial de módulo. Especificamente, qualquer módulo que contenha um atributo @code{__path__} é considerado um pacote.

Todo módulo tem um nome. Nomes de subpacotes são separados do nome do pacote por um ponto, semelhante à sintaxe de acesso aos atributos padrão do Python. Assim pode ter um pacote chamado @ref{3b,,email}, que por sua vez tem um subpacote chamado @ref{45,,email.mime} e um módulo dentro dele chamado @ref{4d,,email.mime.text}.

@menu
* Pacotes regulares:: 
* Pacotes de espaço de nomes:: 

@end menu

@node Pacotes regulares,Pacotes de espaço de nomes,,Pacotes<2>
@anchor{reference/import regular-packages}@anchor{217b}
@subsubsection Pacotes regulares


@geindex pacote;regular

O Python define dois tipos de pacotes, @ref{217c,,pacotes regulares} e @ref{1dee,,pacotes de espaço de nomes}. Pacotes regulares são pacotes tradicionais, como existiam no Python 3.2 e versões anteriores. Um pacote regular é normalmente implementado como um diretório que contém um arquivo @code{__init__.py}. Quando um pacote regular é importado, esse arquivo @code{__init__.py} é executado implicitamente, e os objetos que ele define são vinculados aos nomes no espaço de nomes do pacote. O arquivo @code{__init__.py} pode conter o mesmo código Python que qualquer outro módulo pode conter, e o Python adicionará alguns atributos adicionais ao módulo quando ele for importado.

Por exemplo, o layout do sistema de arquivos a seguir define um pacote @code{parent} de nível superior com três subpacotes:

@example
parent/
    __init__.py
    one/
        __init__.py
    two/
        __init__.py
    three/
        __init__.py
@end example

A importação de @code{parent.one} vai executar implicitamente @code{parent/__init__.py} e @code{parent/one/__init__.py}.  Importações subsequentes de @code{parent.two} ou @code{parent.three} vão executar @code{parent/two/__init__.py} e @code{parent/three/__init__.py}, respectivamente.

@node Pacotes de espaço de nomes,,Pacotes regulares,Pacotes<2>
@anchor{reference/import namespace-packages}@anchor{217d}@anchor{reference/import reference-namespace-package}@anchor{217e}
@subsubsection Pacotes de espaço de nomes


@geindex pacote;espaço de nomes
@geindex pacote;porção

Um pacote de espaço de nomes é um composto de várias @ref{217f,,porções}, em que cada parte contribui com um subpacote para o pacote pai. Partes podem residir em locais diferentes no sistema de arquivos. Partes também podem ser encontradas em arquivos zip, na rede ou em qualquer outro lugar que o Python pesquisar durante a importação. Os pacotes de espaço de nomes podem ou não corresponder diretamente aos objetos no sistema de arquivos; eles podem ser módulos virtuais que não têm representação concreta.

Os pacotes de espaço de nomes não usam uma lista comum para o atributo @code{__path__}. Em vez disso, eles usam um tipo iterável personalizado que executará automaticamente uma nova pesquisa por partes do pacote na próxima tentativa de importação dentro desse pacote, se o caminho do pacote pai (ou @ref{3b4,,sys.path} para um pacote de nível superior) for alterado.

Com pacotes de espaço de nomes, não há arquivo @code{pai/__init__.py}. De fato, pode haver vários diretórios @code{pai} encontrados durante a pesquisa de importação, onde cada um é fornecido por uma parte diferente. Portanto, @code{pai/um} pode não estar fisicamente localizado próximo a @code{pai/dois}. Nesse caso, o Python criará um pacote de espaço de nomes para o pacote @code{pai} de nível superior sempre que ele ou um de seus subpacotes for importado.

Veja também 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} para a especificação de pacotes de espaço de nomes.

@node Caminho de busca,Carregando,Pacotes<2>,O sistema de importação
@anchor{reference/import searching}@anchor{2180}
@subsection Caminho de busca


Para iniciar a busca, o Python precisa do nome @ref{1ab1,,completo} do módulo (ou pacote, mas para o propósito dessa exposição, não há diferença) que se quer importar. Esse nome vem de vários argumentos passados para a instrução @ref{5e2,,import}, ou dos parâmetros das funções @ref{518,,importlib.import_module()} ou @ref{8da,,__import__()}.

Esse nome será usado em várias fases da busca da importação, e pode ser um nome com pontos para um submódulo como, por exemplo, @code{foo.bar.baz}. Nesse caso, Python primeiro tenta importar @code{foo}, depois @code{foo.bar} e, finalmente, @code{foo.bar.baz}. Se alguma das importações intermediárias falharem, uma exceção @ref{b5b,,ModuleNotFoundError} é levantada.

@menu
* O cache de módulos:: 
* Localizadores e carregadores:: 
* Ganchos de importação:: 
* O metacaminho:: 

@end menu

@node O cache de módulos,Localizadores e carregadores,,Caminho de busca
@anchor{reference/import the-module-cache}@anchor{2181}
@subsubsection O cache de módulos


@geindex sys.modules

A primeira verificação durante a busca da importação é feita no @ref{1636,,sys.modules}. Esse mapeamento serve como um cache de todos os módulos que já foram importados previamente, incluindo os caminhos intermediários. Se @code{foo.bar.baz} foi previamente importado, @ref{1636,,sys.modules} conterá entradas para @code{foo}, @code{foo.bar} e @code{foo.bar.baz}. Cada chave terá como valor um objeto módulo correspondente.

Durante a importação, o nome do módulo é procurado em @ref{1636,,sys.modules} e, se estiver presente, o valor associado é o módulo que satisfaz a importação, e o processo termina. Entretanto, se o valor é @code{None}, uma exceção @ref{b5b,,ModuleNotFoundError} é levantada. Se o nome do módulo não foi encontrado, Python continuará a busca pelo módulo.

É possível alterar @ref{1636,,sys.modules}. Apagar uma chave pode não destruir o objeto módulo associado (outros módulos podem manter referências para ele), mas a entrada do cache será invalidada para o nome daquele módulo, fazendo Python executar nova busca na próxima importação. Pode ser atribuído @code{None} para a chave, forçando que a próxima importação do módulo resulte numa exceção @ref{b5b,,ModuleNotFoundError}.

No entanto, tenha cuidado, pois se você mantiver uma referência para o objeto módulo, invalidar sua entrada de cache em @ref{1636,,sys.modules} e, em seguida, reimportar do módulo nomeado, os dois módulo objetos `não' serão os mesmos. Por outro lado, o @ref{519,,importlib.reload()} reutilizará o `mesmo' objeto módulo e simplesmente reinicializará o conteúdo do módulo executando novamente o código do módulo.

@node Localizadores e carregadores,Ganchos de importação,O cache de módulos,Caminho de busca
@anchor{reference/import finders-and-loaders}@anchor{2182}@anchor{reference/import id2}@anchor{2183}
@subsubsection Localizadores e carregadores


@geindex localizador
@geindex carregador
@geindex spec de módulo

Se o módulo nomeado não for encontrado em @ref{1636,,sys.modules}, então o protocolo de importação do Python é invocado para localizar e carregar o módulo. Este protocolo consiste em dois objetos conceituais, @ref{20ae,,localizadores} e @ref{17a4,,carregadores}. O trabalho de um localizador é determinar se ele pode localizar o módulo nomeado usando qualquer estratégia que ele conheça. Objetos que implementam ambas essas interfaces são referenciadas como @ref{2184,,importadores} – eles retornam a si mesmos, quando eles descobrem que eles podem carregar o módulo requisitado.

Python inclui um número de localizadores e carregadores padrões.  O primeiro sabe como localizar módulos embutidos, e o segundo sabe como localizar módulos congelados. Um terceiro localizador padrão procura em um @ref{2185,,caminho de importação} por módulos. O @ref{2185,,caminho de importação} é uma lista de localizações que podem nomear caminhos de sistema de arquivo ou arquivos zip. Ele também pode ser estendido para buscar por qualquer recurso localizável, tais como aqueles identificados por URLs.

O mecanismo de importação é extensível, então novos localizadores podem ser adicionados para estender o alcance e o escopo de buscar módulos.

Localizadores na verdade não carregam módulos. Se eles conseguirem encontrar o módulo nomeado, eles retornam um `spec de módulo', um encapsulamento da informação relacionada a importação do módulo, a qual o mecanismo de importação então usa quando o módulo é carregado.

As seguintes seções descrevem o protocolo para localizadores e carregadores em mais detalhes, incluindo como você pode criar e registrar novos para estender o mecanismo de importação.


Alterado na versão 3.4: Em versões anteriores do Python, localizadores retornavam @ref{17a4,,carregadores} diretamente, enquanto agora eles retornam especificações de módulo, as qual `contêm' carregadores. Carregadores ainda são usados durante a importação, mas possuem menos responsabilidades.


@node Ganchos de importação,O metacaminho,Localizadores e carregadores,Caminho de busca
@anchor{reference/import import-hooks}@anchor{2186}
@subsubsection Ganchos de importação


@geindex ganchos de importação
@geindex metaganchos
@geindex ganchos de caminho
@geindex ganchos;import
@geindex ganchos;meta
@geindex ganchos;caminho

O mecanismo de importação é desenhado para ser extensível; o mecanismo primário para isso são os `ganchos de importação'.  Existem dois tipos de ganchos de importação: `metaganchos' e `ganchos de importação de caminho'.

Metaganchos são chamados no início do processo de importação, antes que qualquer outro processo de importação tenha ocorrido, que não seja busca de cache de @ref{1636,,sys.modules}. Isso permite aos metaganchos substituir processamento de @ref{3b4,,sys.path}, módulos congelados ou mesmo módulos embutidos. Metaganchos são registrados adicionando novos objetos localizadores a @ref{d4d,,sys.meta_path}, conforme descrito abaixo.

Ganchos de caminho de importação são chamados como parte do processamento de @ref{3b4,,sys.path} (ou @code{package.__path__}), no ponto onde é encontrado o item do caminho associado. Ganchos de caminho de importação são registrados adicionando novos chamáveis para @ref{105a,,sys.path_hooks}, conforme descrito abaixo.

@node O metacaminho,,Ganchos de importação,Caminho de busca
@anchor{reference/import the-meta-path}@anchor{2187}
@subsubsection O metacaminho


@geindex sys.meta_path
@geindex localizador;find_spec

Quando o módulo nomeado não é encontrado em @ref{1636,,sys.modules}, o Python em seguida o busca em @ref{d4d,,sys.meta_path}, o qual contém uma lista de objetos localizadores de metacaminho. Esses localizadores são consultados a fim de verificar se eles sabem como manipular o módulo nomeado. Os localizadores de metacaminho devem implementar um método chamado @ref{86c,,find_spec()}, o qual recebe três argumentos: um nome, um caminho de importação, e (opcionalmente) um módulo alvo. O localizador de metacaminho pode usar qualquer estratégia que ele quiser para determinar se ele pode manipular o módulo nomeado ou não.

Se o localizador de metacaminho souber como tratar o módulo nomeado, ele retorna um objeto spec. Se ele não puder tratar o módulo nomeado, ele retorna @code{None}. Se o processamento de @ref{d4d,,sys.meta_path} alcançar o fim da sua lista sem retornar um spec, então @ref{b5b,,ModuleNotFoundError} é levantada. Quaisquer outras exceções levantadas são simplesmente propagadas para cima, abortando o processo de importação.

O método @ref{86c,,find_spec()} dos localizadores de metacaminhos é chamado com dois ou três argumentos. O primeiro é o nome totalmente qualificado do módulo sendo importado, por exemplo @code{foo.bar.baz}. O segundo argumento são as entradas do caminho a ser usado na busca do módulo. Para módulos de nível superior, o segundo argumento é @code{None}, mas para submódulos ou subpacotes, o segundo argumento é o valor do atributo @code{__path__} do pacote pai. Se o atributo @code{__path__} apropriado não puder ser acessado, uma exceção @ref{b5b,,ModuleNotFoundError} é levantada. O terceiro argumento é um objeto módulo existente que será o alvo do carregamento posteriormente. O sistema de importação passa um módulo alvo apenas durante o recarregamento.

O metacaminho pode ser percorrido múltiplas vezes para uma requisição de importação individual. Por exemplo, presumindo que nenhum dos módulos envolvidos já tenha sido cacheado, importar @code{foo.bar.baz} irá primeiro executar uma importação de alto nível, chamando @code{mpf.find_spec("foo", None, None)} em cada localizador de metacaminho (@code{mpf}). Depois que @code{foo} foi importado, @code{foo.bar} será importado percorrendo o metacaminho uma segunda vez, chamando @code{mpf.find_spec("foo.bar", foo.__path__, None)}. Uma vez que @code{foo.bar} tenha sido importado, a travessia final irá chamar @code{mpf.find_spec("foo.bar.baz", foo.bar.__path__, None)}.

Alguns localizadores de metacaminho apenas dão suporte a importações de alto nível. Estes importadores vão sempre retornar @code{None} quando qualquer coisa diferente de @code{None} for passada como o segundo argumento.

O @ref{d4d,,sys.meta_path} padrão do Python possui três localizador de metacaminho, um que sabe como importar módulos embutidos, um que sabe como importar módulos congelados, e outro que sabe como importar módulos de um @ref{2185,,caminho de importação} (isto é, o @ref{2188,,localizador baseado no caminho}).


Alterado na versão 3.4: O método @ref{86c,,find_spec()} dos localizador de metacaminho substituiu @code{find_module()}, o qual agora foi descontinuado. Embora continue a funcionar sem alterações, a mecanismo de importação só tentará fazê-lo se o localizador não implementar @ref{86c,,find_spec()}.



Alterado na versão 3.10: O uso de @code{find_module()} pelo sistema de importação agora levanta @ref{4fa,,ImportWarning}.



Alterado na versão 3.12: @code{find_module()} foi removido. Use @ref{86c,,find_spec()}.


@node Carregando,O localizador baseado no caminho,Caminho de busca,O sistema de importação
@anchor{reference/import loading}@anchor{2189}
@subsection Carregando


Se e quando uma spec de módulo é encontrada, o mecanismo de importação vai usá-la (e o carregador que ela contém) durante o carregamento do módulo. Esta é uma aproximação do que acontece durante a etapa de carregamento de uma importação:

@example
module = None
if spec.loader is not None and hasattr(spec.loader, 'create_module'):
    # É assumido que o carregador também define 'exec_module'.
    module = spec.loader.create_module(spec)
if module is None:
    module = ModuleType(spec.name)
# Define os atributos do módulo relacionados à importação:
_init_module_attrs(spec, module)

if spec.loader is None:
    # não suportado
    raise ImportError
if spec.origin is None and spec.submodule_search_locations is not None:
    # pacote espaço de nomes
    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

Perceba os seguintes detalhes:


@itemize *

@item 
Se houver um objeto módulo existente com o nome fornecido em @ref{1636,,sys.modules}, a importação já tera retornado ele.

@item 
O módulo irá existir em @ref{1636,,sys.modules} antes do carregador executar o código do módulo. Isso é crucial porque o código do módulo pode (direta ou indiretamente) importar a si mesmo; adicioná-lo a @ref{1636,,sys.modules} antecipadamente previne recursão infinita no pior caso e múltiplos carregamentos no melhor caso.

@item 
Se o carregamento falhar, o módulo com falha – e apenas o módulo com falha – é removido de @ref{1636,,sys.modules}. Qualquer módulo já presente no cache de @ref{1636,,sys.modules}, e qualquer módulo que tenha sido carregado com sucesso como um efeito colateral, deve permanecer no cache. Isso contrasta com recarregamento, onde mesmo o módulo com falha é mantido em @ref{1636,,sys.modules}.

@item 
Depois que o módulo é criado, mas antes da execução, o mecanismo de importação define os atributos de módulo relacionados a importação (“_init_module_attrs” no exemplo de pseudocódigo acima), assim como foi resumido em @ref{20a4,,uma seção posterior}.

@item 
Execução de módulo é o momento chave do carregamento, no qual o espaço de nomes do módulo é populado.  Execução é inteiramente delegada para o carregador, o qual pode decidir o que será populado e como.

@item 
O módulo criado durante o carregamento e passado para exec_module() pode não ser aquele retornado ao final da importação @footnote{
A implementação de importlib evita usar o valor de retorno diretamente. Em vez disso, ela obtém o objeto do módulo procurando o nome do módulo em @ref{1636,,sys.modules}. O efeito indireto disso é que um módulo importado pode substituir a si mesmo em @ref{1636,,sys.modules}. Esse é um comportamento específico da implementação que não tem garantia de funcionar em outras implementações do Python.
}.
@end itemize


Alterado na versão 3.4: O sistema de importação tem tomado conta das responsabilidades inerentes dos carregadores. Essas responsabilidades eram anteriormente executadas pelo método @ref{86d,,importlib.abc.Loader.load_module()}.


@menu
* Carregadores:: 
* Submódulos:: 
* Especificações de módulo:: 
* Atributo __path__ dos módulos:: 
* Representações do módulo:: 
* Invalidação de bytecode em cache:: 

@end menu

@node Carregadores,Submódulos,,Carregando
@anchor{reference/import loaders}@anchor{218a}
@subsubsection Carregadores


Os carregadores de módulo fornecem a função crítica de carregamento: execução do módulo. O mecanismo de importação chama o método @ref{86e,,importlib.abc.Loader.exec_module()} com um único argumento, o objeto do módulo a ser executado. Qualquer valor retornado de @ref{86e,,exec_module()} é ignorado.

Os carregadores devem atender aos seguintes requisitos:


@itemize *

@item 
Se o módulo for um módulo Python (em oposição a um módulo embutido ou uma extensão carregada dinamicamente), o carregador deve executar o código do módulo no espaço de nomes global do módulo (@code{module.__dict__}).

@item 
Se o carregador não puder executar o módulo, ele deve levantar uma exceção @ref{419,,ImportError}, embora qualquer outra exceção levantada durante @ref{86e,,exec_module()} será propagada.
@end itemize

Em muitos casos, o localizador e o carregador podem ser o mesmo objeto; nesses casos o método @ref{86c,,find_spec()} apenas retornaria um spec com o carregador definido como @code{self}.

Os carregadores de módulo podem optar por criar o objeto do módulo durante o carregamento, implementando um método @ref{cce,,create_module()}. Leva um argumento, o spec de módulo e retorna o novo objeto do módulo para usar durante o carregamento. @code{create_module()} não precisa definir nenhum atributo no objeto do módulo. Se o método retornar @code{None}, o mecanismo de importação criará ele mesmo o novo módulo.


Adicionado na versão 3.4: O método @ref{cce,,create_module()} de carregadores.



Alterado na versão 3.4: O método @ref{86d,,load_module()} foi substituído por @ref{86e,,exec_module()} e o mecanismo de importação assumiu todas as responsabilidades inerentes de carregamento.

Para compatibilidade com carregadores existentes, o mecanismo de importação usará o método @code{load_module()} de carregadores se ele existir e o carregador também não implementar @code{exec_module()}. No entanto, @code{load_module()} foi descontinuado e os carregadores devem implementar @code{exec_module()} em seu lugar.

O método @code{load_module()} deve implementar toda a funcionalidade inerente de carregamento descrita acima, além de executar o módulo. Todas as mesmas restrições se aplicam, com alguns esclarecimentos adicionais:


@itemize *

@item 
Se houver um objeto de módulo existente com o nome fornecido em @ref{1636,,sys.modules}, o carregador deverá usar esse módulo existente. (Caso contrário, @ref{519,,importlib.reload()} não funcionará corretamente.) Se o módulo nomeado não existir em @ref{1636,,sys.modules}, o carregador deverá criar um novo objeto de módulo e adicioná-lo a @ref{1636,,sys.modules}.

@item 
O módulo `deve' existir em @ref{1636,,sys.modules} antes que o carregador execute o código do módulo, para evitar recursão ilimitada ou carregamento múltiplo.

@item 
Se o carregamento falhar, o carregador deverá remover quaisquer módulos inseridos em @ref{1636,,sys.modules}, mas deverá remover `apenas' o(s) módulo(s) com falha, e somente se o próprio carregador tiver carregado o(s) módulo(s) explicitamente.
@end itemize



Alterado na versão 3.5: Uma exceção @ref{1a5,,DeprecationWarning} é levantada quando @code{exec_module()} está definido, mas @code{create_module()} não.



Alterado na versão 3.6: Uma exceção @ref{419,,ImportError} é levantada quando @code{exec_module()} está definido, mas @code{create_module()} não.



Alterado na versão 3.10: O uso de @code{load_module()} vai levantar @ref{4fa,,ImportWarning}.


@node Submódulos,Especificações de módulo,Carregadores,Carregando
@anchor{reference/import submodules}@anchor{218b}
@subsubsection Submódulos


Quando um submódulo é carregado usando qualquer mecanismo (por exemplo, APIs @code{importlib}, as instruções @code{import} ou @code{import-from}, ou a função @code{__import__()} embutida) uma ligação é colocada no espaço de nomes do módulo pai para o objeto submódulo. Por exemplo, se o pacote @code{spam} tiver um submódulo @code{foo}, após importar @code{spam.foo}, @code{spam} terá um atributo @code{foo} que está vinculado ao submódulo. Digamos que você tenha a seguinte estrutura de diretórios:

@example
spam/
    __init__.py
    foo.py
@end example

e @code{spam/__init__.py} tem a seguinte linha:

@example
from .foo import Foo
@end example

então executar o seguinte coloca ligações de nome para @code{foo} e @code{Foo} no 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 as conhecidas regras de ligação de nomes do Python, isso pode parecer surpreendente, mas na verdade é um recurso fundamental do sistema de importação. A propriedade invariante é que se você tiver @code{sys.modules['spam']} e @code{sys.modules['spam.foo']} (como faria após a importação acima), o último deve aparecer como o atributo @code{foo} do primeiro.

@node Especificações de módulo,Atributo __path__ dos módulos,Submódulos,Carregando
@anchor{reference/import id4}@anchor{218c}@anchor{reference/import module-specs}@anchor{20a9}
@subsubsection Especificações de módulo


O mecanismo de importação utiliza diversas informações sobre cada módulo durante a importação, principalmente antes do carregamento. A maior parte das informações é comum a todos os módulos. O propósito da spec do módulo é encapsular essas informações relacionadas à importação por módulo.

Usar um spec durante a importação permite que o estado seja transferido entre componentes do sistema de importação, por exemplo entre o localizador que cria o spec de módulo e o carregador que o executa. Mais importante ainda, permite que o mecanismo de importação execute as operações inerentes de carregamento, enquanto que sem um spec de módulo o carregador tinha essa responsabilidade.

O spec do módulo é exposto no atributo @ref{20a7,,module.__spec__}. A configuração oportuna do @code{__spec__} se aplica igualmente aos @ref{218d,,módulos inicializados durante a inicialização do interpretador}. A única exceção é o @code{__main__}, cujo @code{__spec__} é @ref{218e,,definido como None em alguns casos}.

Consulte @ref{1fee,,ModuleSpec} para detalhes sobre o conteúdo do spec de módulo.


Adicionado na versão 3.4.


@node Atributo __path__ dos módulos,Representações do módulo,Especificações de módulo,Carregando
@anchor{reference/import package-path-rules}@anchor{20ab}@anchor{reference/import path-attributes-on-modules}@anchor{218f}
@subsubsection Atributo __path__ dos módulos


O atributo @ref{1df4,,__path__} deve ser uma @ref{4f1,,sequência} (possivelmente vazia) de strings enumerando os locais onde os submódulos do pacote serão encontrados. Por definição, um módulo que tenha um atributo @code{__path__} é um @ref{20aa,,pacote}.

O atributo @ref{1df4,,__path__} de um pacote é usado durante as importações de seus subpacotes. Dentro do mecanismo de importação, funciona da mesma forma que @ref{3b4,,sys.path}, ou seja, fornecendo uma lista de locais para procurar módulos durante a importação. Entretanto, o @code{__path__} normalmente é muito mais restrito que @code{sys.path}.

As mesmas regras usadas para @ref{3b4,,sys.path} também se aplicam ao @code{__path__} de um pacote. Os @ref{105a,,sys.path_hooks} (descritos abaixo) são consultados ao percorrer o @code{__path__} de um pacote.

O arquivo @code{__init__.py} de um pacote pode definir ou alterar o atributo @ref{1df4,,__path__} do pacote, e esta era tipicamente a forma como os pacotes de espaço de nomes eram implementados antes da 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}. Com a adoção da 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}, os pacotes de espaço de nomes não precisam mais fornecer arquivos @code{__init__.py} contendo apenas código de manipulação do @code{__path__}; o mecanismo de importação define automaticamente o @code{__path__} corretamente para o pacote de espaço de nomes.

@node Representações do módulo,Invalidação de bytecode em cache,Atributo __path__ dos módulos,Carregando
@anchor{reference/import module-reprs}@anchor{2190}
@subsubsection Representações do módulo


Por padrão, todos os módulos têm uma representação (repr) utilizável, no entanto, dependendo dos atributos definidos acima e do spec do módulo, você pode controlar mais explicitamente a representação dos objetos módulo.

Se o módulo tiver um spec (@code{__spec__}), o mecanismo de importação tentará gerar uma representação a partir dele. Se isso falhar ou não houver nenhuma especificação, o sistema de importação criará uma representação padrão usando qualquer informação disponível no módulo. Ele tentará usar @code{module.__name__}, @code{module.__file__} e @code{module.__loader__} como entrada para a representação, com padrões para qualquer informação que esteja faltando.

Arquivo estão as exatas regras usadas:


@itemize *

@item 
Se o módulo tiver um atributo @code{__spec__}, a informação no spec é usada para gerar a representação. Os atributos “name”, “loader”, “origin” e “has_location” são consultados.

@item 
Se o módulo tiver um atributo @code{__file__}, ele será usado como parte da representação do módulo.

@item 
Se o módulo não tem @code{__file__} mas tem um @code{__loader__} que não seja @code{None}, então a representação do carregador é usado como parte da representação do módulo.

@item 
Caso contrário, basta usar o @code{__name__} do módulo na representação.
@end itemize


Alterado na versão 3.12: O uso de @code{module_repr()}, descontinuado desde o Python 3.4, foi removido no Python 3.12 e não é mais chamado durante a resolução da representação de um módulo.


@node Invalidação de bytecode em cache,,Representações do módulo,Carregando
@anchor{reference/import cached-bytecode-invalidation}@anchor{2191}@anchor{reference/import pyc-invalidation}@anchor{5ec}
@subsubsection Invalidação de bytecode em cache


Antes do Python carregar o bytecode armazenado em cache de um arquivo @code{.pyc}, ele verifica se o cache está atualizado com o arquivo fonte @code{.py}. Por padrão, o Python faz isso armazenando o registro de data e hora da última modificação da fonte e o tamanho no arquivo de cache ao escrevê-lo. No tempo de execução, o sistema de importação valida o arquivo de cache verificando os metadados armazenados no arquivo de cache em relação aos metadados do código-fonte.

Python também oferece suporte a arquivos de cache “baseados em hash”, que armazenam um hash do conteúdo do arquivo fonte em vez de seus metadados. Existem duas variantes de arquivos @code{.pyc} baseados em hash: verificados e não verificados. Para arquivos @code{.pyc} baseados em hash verificados, o Python valida o arquivo de cache fazendo hash do arquivo fonte e comparando o hash resultante com o hash no arquivo de cache. Se um arquivo de cache baseado em hash verificado for inválido, o Python o regenerará e gravará um novo arquivo de cache baseado em hash verificado. Para arquivos @code{.pyc} baseados em hash não verificados, o Python simplesmente presume que o arquivo de cache é válido, se existir. O comportamento de validação de arquivos @code{.pyc} baseados em hash pode ser substituído pelo sinalizador @ref{1eba,,--check-hash-based-pycs}.


Alterado na versão 3.7: Adicionados arquivos @code{.pyc} baseados em hash. Anteriormente, o Python oferecia suporte apenas à invalidação de caches de bytecode baseada em registro de data e hora.


@node O localizador baseado no caminho,Substituindo o sistema de importação padrão,Carregando,O sistema de importação
@anchor{reference/import the-path-based-finder}@anchor{2192}
@subsection O localizador baseado no caminho


@geindex localizador baseado no caminho

Conforme mencionado anteriormente, Python vem com vários localizadores de metacaminho padrão. Um deles, chamado @ref{2188,,localizador baseado no caminho} (@ref{1059,,PathFinder}), pesquisa um @ref{2185,,caminho de importação}, que contém uma lista de @ref{2193,,entradas de caminho}. Cada entrada de caminho nomeia um local para procurar módulos.

O próprio localizador baseado no caminho não sabe como importar nada. Em vez disso, ele percorre as entradas de caminho individuais, associando cada uma delas a um localizador de entrada de caminho que sabe como lidar com esse tipo específico de caminho.

O conjunto padrão de localizadores de entrada de caminho implementa toda a semântica para localizar módulos no sistema de arquivos, manipulando tipos de arquivos especiais, como código-fonte Python (arquivos @code{.py}), código de bytes Python (arquivos @code{.pyc}) e bibliotecas compartilhadas (por exemplo, arquivos @code{.so}). Quando suportado pelo módulo @ref{132,,zipimport} na biblioteca padrão, os localizadores de entrada de caminho padrão também lidam com o carregamento de todos esses tipos de arquivos (exceto bibliotecas compartilhadas) de arquivos zip.

As entradas de caminho não precisam ser limitadas aos locais do sistema de arquivos. Eles podem referir-se a URLs, consultas de banco de dados ou qualquer outro local que possa ser especificado como uma string.

O localizador baseado no caminho fornece ganchos e protocolos adicionais para que você possa estender e personalizar os tipos de entradas de caminho pesquisáveis. Por exemplo, se você quiser oferecer suporte a entradas de caminho como URLs de rede, poderá escrever um gancho que implemente a semântica HTTP para localizar módulos na web. Este gancho (um chamável) retornaria um @ref{10aa,,localizador de entrada de caminho} suportando o protocolo descrito abaixo, que foi então usado para obter um carregador para o módulo da web.

Uma palavra de advertência: esta seção e a anterior usam o termo `localizador', distinguindo-os usando os termos @ref{10a9,,localizador de metacaminho} e @ref{10aa,,localizador de entrada de caminho}. Esses dois tipos de localizadores são muito semelhantes, oferecem suporte a protocolos semelhantes e funcionam de maneira semelhante durante o processo de importação, mas é importante ter em mente que eles são sutilmente diferentes. Em particular, os localizadores de metacaminho operam no início do processo de importação, conforme a travessia de @ref{d4d,,sys.meta_path}.

Por outro lado, os localizadores de entrada de caminho são, em certo sentido, um detalhe de implementação do localizador baseado no caminho e, de fato, se o localizador baseado no caminho fosse removido de @ref{d4d,,sys.meta_path}, nenhuma semântica do localizador de entrada de caminho seria ser invocado.

@menu
* Localizadores de entrada de caminho:: 
* Protocolo do localizador de entrada de caminho:: 

@end menu

@node Localizadores de entrada de caminho,Protocolo do localizador de entrada de caminho,,O localizador baseado no caminho
@anchor{reference/import path-entry-finders}@anchor{2194}
@subsubsection Localizadores de entrada de caminho


@geindex sys.path
@geindex sys.path_hooks
@geindex sys.path_importer_cache
@geindex PYTHONPATH

O @ref{2188,,localizador baseado no caminho} é responsável por encontrar e carregar módulos e pacotes Python cuja localização é especificada com uma string @ref{2193,,entrada de caminho}. A maioria das entradas de caminho nomeiam locais no sistema de arquivos, mas não precisam ser limitadas a isso.

Como um localizador de metacaminho, o @ref{2188,,localizador baseado no caminho} implementa o protocolo @ref{86c,,find_spec()} descrito anteriormente, no entanto, ele expõe ganchos adicionais que podem ser usados para personalizar como os módulos são encontrados e carregado do @ref{2185,,caminho de importação}.

Três variáveis são usadas pelo @ref{2188,,localizador baseado no caminho}, @ref{3b4,,sys.path}, @ref{105a,,sys.path_hooks} e @ref{5e4,,sys.path_importer_cache}. Os atributos @code{__path__} em objetos de pacote também são usados. Eles fornecem maneiras adicionais de personalizar o mecanismo de importação.

@ref{3b4,,sys.path} contém uma lista de strings fornecendo locais de pesquisa para módulos e pacotes. Ele é inicializado a partir da variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} e vários outros padrões específicos de instalação e implementação. Entradas em @ref{3b4,,sys.path} podem nomear diretórios no sistema de arquivos, arquivos zip e potencialmente outros “locais” (veja o módulo @ref{c7,,site}) que devem ser pesquisados por módulos, como URLs, ou consultas ao banco de dados. Apenas strings devem estar presentes em @ref{3b4,,sys.path}; todos os outros tipos de dados são ignorados.

O @ref{2188,,localizador baseado no caminho} é um @ref{10a9,,localizador de metacaminho}, então o mecanismo de importação inicia a pesquisa no @ref{2185,,caminho de importação} chamando o método @ref{1047,,find_spec()} do localizador baseado no caminho conforme descrito anteriormente. Quando o argumento @code{path} para @ref{1047,,find_spec()} for fornecido, será uma lista de caminhos de string a serem percorridos – normalmente o atributo @code{__path__} de um pacote para uma importação dentro desse pacote. Se o argumento @code{path} for @code{None}, isso indica uma importação de nível superior e @ref{3b4,,sys.path} é usado.

O localizador baseado no caminho itera sobre cada entrada no caminho de pesquisa e, para cada uma delas, procura um @ref{10aa,,localizador de entrada de caminho} (@ref{873,,PathEntryFinder}) apropriado para a entrada do caminho. Como esta pode ser uma operação custosa (por exemplo, pode haver sobrecargas de chamada @code{stat()} para esta pesquisa), o localizador baseado no caminho mantém um cache mapeando entradas de caminho para localizadores de entrada de caminho. Este cache é mantido em @ref{5e4,,sys.path_importer_cache} (apesar do nome, este cache na verdade armazena objetos localizadores em vez de ser limitado a objetos @ref{2184,,importador}). Desta forma, a dispendiosa busca pelo @ref{10aa,,localizador de entrada de caminho} de local específico de uma @ref{2193,,entrada de caminho} só precisa ser feita uma vez. O código do usuário é livre para remover entradas de cache de @ref{5e4,,sys.path_importer_cache}, forçando o localizador baseado no caminho a realizar a pesquisa de entrada de caminho novamente.

Se a entrada de caminho não estiver presente no cache, o localizador baseado no caminho itera sobre cada chamável em @ref{105a,,sys.path_hooks}. Cada um dos @ref{2195,,ganchos de entrada de caminho} nesta lista é chamado com um único argumento, a entrada de caminho a ser pesquisada. Este chamável pode retornar um @ref{10aa,,localizador de entrada de caminho} que pode manipular a entrada de caminho ou pode levantar @ref{419,,ImportError}. Um @ref{419,,ImportError} é usado pelo localizador baseado no caminho para sinalizar que o gancho não consegue encontrar um @ref{10aa,,localizador de entrada de caminho} para aquela @ref{2193,,entrada de caminho}. A exceção é ignorada e a iteração com o @ref{2185,,caminho de importação} continua. O gancho deve esperar um objeto string ou bytes; a codificação de objetos bytes depende do gancho (por exemplo, pode ser uma codificação de sistema de arquivos, UTF-8 ou outra coisa) e, se o gancho não puder decodificar o argumento, ele deve levantar @ref{419,,ImportError}.

Se a iteração @ref{105a,,sys.path_hooks} terminar sem que nenhum @ref{10aa,,localizador de entrada de caminho} seja retornado, o método @ref{1047,,find_spec()} do localizador baseado no caminho armazenará @code{None} em @ref{5e4,,sys.path_importer_cache} (para indicar que não há um localizador para esta entrada de caminho) e retornará @code{None}, indicando que este @ref{10a9,,localizador de metacaminho} não conseguiu encontrar o módulo.

Se um @ref{10aa,,localizador de entrada de caminho} `for' retornado por um dos chamáveis de @ref{2195,,gancho de entrada de caminho} em @ref{105a,,sys.path_hooks}, então o seguinte protocolo é usado para solicitar ao localizador um spec de módulo, que é então usada ao carregar o módulo.

O diretório de trabalho atual – denotado por uma string vazia – é tratado de forma ligeiramente diferente de outras entradas em @ref{3b4,,sys.path}. Primeiro, se o diretório de trabalho atual for considerado inexistente, nenhum valor será armazenado em @ref{5e4,,sys.path_importer_cache}. Segundo, o valor para o diretório de trabalho atual é pesquisado novamente para cada pesquisa de módulo. Terceiro, o caminho usado para @ref{5e4,,sys.path_importer_cache} e retornado por @ref{1047,,importlib.machinery.PathFinder.find_spec()} será o diretório de trabalho atual real e não a string vazia.

@node Protocolo do localizador de entrada de caminho,,Localizadores de entrada de caminho,O localizador baseado no caminho
@anchor{reference/import path-entry-finder-protocol}@anchor{2196}
@subsubsection Protocolo do localizador de entrada de caminho


Para dar suporte a importações de módulos e pacotes inicializados e também contribuir com partes para pacotes de espaço de nomes, os localizadores de entrada de caminho devem implementar o método @ref{870,,find_spec()}.

@ref{870,,find_spec()} recebe dois argumentos: o nome totalmente qualificado do módulo que está sendo importado e o módulo de destino (opcional). @code{find_spec()} retorna um spec totalmente preenchido para o módulo. Este spec sempre terá “loader” definido (com uma exceção).

Para indicar ao maquinário de importação que o spec representa uma @ref{217f,,porção} de espaço de nomes, o localizador de entrada de caminho define @code{submodule_search_locations} como uma lista contendo a porção.


Alterado na versão 3.4: @ref{870,,find_spec()} substituiu @code{find_loader()} e @code{find_module()}, ambos descontinuados, mas serão usados se @code{find_spec()} não estiver definido.

Os localizadores de entrada de caminho mais antigos podem implementar um desses dois métodos descontinuados em vez de @code{find_spec()}. Os métodos ainda são respeitados para fins de compatibilidade com versões anteriores. No entanto, se @code{find_spec()} for implementado no localizador de entrada de caminho, os métodos legados serão ignorados.

@code{find_loader()} recebe um argumento, o nome totalmente qualificado do módulo que está sendo importado. @code{find_loader()} retorna uma tupla 2 onde o primeiro item é o carregador e o segundo item é uma @ref{217f,,porção} de espaço de nomes.

Para compatibilidade com versões anteriores de outras implementações do protocolo de importação, muitos localizadores de entrada de caminho também dão suporte ao mesmo método tradicional @code{find_module()} que os localizadores de metacaminho. No entanto, os métodos @code{find_module()} do localizador de entrada de caminho nunca são chamados com um argumento @code{path} (espera-se que eles registrem as informações de caminho apropriadas da chamada inicial para o gancho de caminho).

O método @code{find_module()} em localizadores de entrada de caminho foi descontinuado, pois não permite que o localizador de entrada de caminho contribua com porções para pacotes de espaço de nomes. Se @code{find_loader()} e @code{find_module()} existirem em um localizador de entrada de caminho, o sistema de importação sempre chamará @code{find_loader()} em preferência a @code{find_module()}.



Alterado na versão 3.10: Chamadas para @code{find_module()} e @code{find_loader()} pelo sistema de importação vão levantar @ref{4fa,,ImportWarning}.



Alterado na versão 3.12: @code{find_module()} e @code{find_loader()} foram removidos.


@node Substituindo o sistema de importação padrão,Importações relativas ao pacote,O localizador baseado no caminho,O sistema de importação
@anchor{reference/import replacing-the-standard-import-system}@anchor{2197}
@subsection Substituindo o sistema de importação padrão


O mecanismo mais confiável para substituir todo o sistema de importação é excluir o conteúdo padrão de @ref{d4d,,sys.meta_path}, substituindo-o inteiramente por um gancho de metacaminho personalizado.

If it is acceptable to only alter the behaviour of import statements
without affecting other APIs that access the import system, then replacing
the builtin @ref{8da,,__import__()} function may be sufficient.

Para impedir seletivamente a importação de alguns módulos de um gancho no início do metacaminho (em vez de desabilitar o sistema de importação padrão completamente), é suficiente levantar @ref{b5b,,ModuleNotFoundError} diretamente de @ref{86c,,find_spec()} em vez de retornar @code{None}. O último indica que a busca do metacaminho deve continuar, enquanto levantar uma exceção a encerra imediatamente.

@node Importações relativas ao pacote,Considerações especiais para __main__,Substituindo o sistema de importação padrão,O sistema de importação
@anchor{reference/import package-relative-imports}@anchor{2198}@anchor{reference/import relativeimports}@anchor{2199}
@subsection Importações relativas ao pacote


Importações relativas usam caracteres de ponto no início. Um único ponto no início indica uma importação relativa, começando com o pacote atual. Dois ou mais pontos no início indicam uma importação relativa para o(s) pai(s) do pacote atual, um nível por ponto após o primeiro. Por exemplo, dado o seguinte layout de pacote:

@example
package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py
@end example

Em @code{subpackage1/moduleX.py} ou @code{subpackage1/__init__.py}, as seguintes são importações 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

Importações absolutas podem usar a sintaxe @code{import <>} ou @code{from <> import <>}, mas importações relativas podem usar apenas a segunda forma; o motivo para isso é que:

@example
import XXX.YYY.ZZZ
@end example

deve expor @code{XXX.YYY.ZZZ} como uma expressão utilizável, mas .moduleY não é uma expressão válida.

@node Considerações especiais para __main__,Referências,Importações relativas ao pacote,O sistema de importação
@anchor{reference/import import-dunder-main}@anchor{219a}@anchor{reference/import special-considerations-for-main}@anchor{219b}
@subsection Considerações especiais para __main__


O módulo @ref{1,,__main__} é um caso especial em relação ao sistema de importação do Python. Conforme observado em @ref{218d,,em outro lugar}, o módulo @code{__main__} é inicializado diretamente na inicialização do interpretador, muito parecido com @ref{d9,,sys} e @ref{12,,builtins}. No entanto, diferentemente desses dois, ele não se qualifica estritamente como um módulo integrado. Isso ocorre porque a maneira como @code{__main__} é inicializado depende dos sinalizadores e outras opções com as quais o interpretador é invocado.

@menu
* __main__.__spec__: __main__ __spec__. 

@end menu

@node __main__ __spec__,,,Considerações especiais para __main__
@anchor{reference/import id5}@anchor{219c}@anchor{reference/import main-spec}@anchor{218e}
@subsubsection __main__.__spec__


Dependendo de como @ref{1,,__main__} é inicializado, @code{__main__.__spec__} é definido apropriadamente ou como @code{None}.

Quando o Python é iniciado com a opção @ref{5e1,,-m}, @code{__spec__} é definido como o spec de módulo ou pacote correspondente. @code{__spec__} também é preenchido quando o módulo @code{__main__} é carregado como parte da execução de um diretório, arquivo zip ou outra entrada @ref{3b4,,sys.path}.

@ref{1eb3,,Nos demais casos}, @code{__main__.__spec__} é definido como @code{None}, pois o código usado para preencher o @ref{1,,__main__} não corresponde diretamente a um módulo importável:


@itemize -

@item 
prompt interativo

@item 
opção @ref{5e0,,-c}

@item 
executar a partir de stdin

@item 
executar diretamente de um arquivo de código-fonte ou bytecode
@end itemize

Note que @code{__main__.__spec__} é sempre @code{None} no último caso, `mesmo se' o arquivo pudesse ser importado diretamente como um módulo. Use a opção @ref{5e1,,-m} se metadados de módulo válidos forem desejados em @ref{1,,__main__}.

Note também que mesmo quando @code{__main__} corresponde a um módulo importável e @code{__main__.__spec__} é definido adequadamente, eles ainda são considerados módulos `distintos'. Isso se deve ao fato de que os blocos protegidos por verificações @code{if __name__ == "__main__":} são executados somente quando o módulo é usado para preencher o espaço de nomes @code{__main__}, e não durante a importação normal.

@node Referências,,Considerações especiais para __main__,O sistema de importação
@anchor{reference/import references}@anchor{219d}
@subsection Referências


O maquinário de importação evoluiu consideravelmente desde os primeiros dias do Python. A especificação original para pacotes@footnote{https://www.python.org/doc/essays/packages/} ainda está disponível para leitura, embora alguns detalhes tenham mudado desde a escrita desse documento.

A especificação original para @ref{d4d,,sys.meta_path} era 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}, com extensão subsequente em 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}.

@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} introduziu @ref{1dee,,pacotes de espaço de nomes} para Python 3.3. 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} também introduziu o protocolo @code{find_loader()} como uma alternativa ao @code{find_module()}.

@geindex Propostas de Melhorias do Python; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} descreve a adição do atributo @code{__package__} para importações relativas explícitas em módulos principais.

@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} introduziu importações relativas absolutas e explícitas e inicialmente propôs @code{__name__} para semântica. 
@geindex Propostas de Melhorias do Python; PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} eventualmente especificaria @code{__package__}.

@geindex Propostas de Melhorias do Python; PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} define módulos de execução como scripts.

@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} adiciona o encapsulamento do estado de importação por módulo em objetos spec. Ele também descarrega a maioria das responsabilidades inerentes dos carregadores de volta para o maquinário de importação. Essas mudanças permitem a descontinuação de várias APIs no sistema de importação e também a adição de novos métodos para localizadores e carregadores.

@node Expressões,Instruções simples,O sistema de importação,A Referência da Linguagem Python
@anchor{reference/expressions doc}@anchor{219e}@anchor{reference/expressions expressions}@anchor{219f}@anchor{reference/expressions id1}@anchor{21a0}@anchor{reference/expressions translation-repo}@anchor{21a1}
@section Expressões


@geindex expressão
@geindex BNF

Este capítulo explica o significado dos elementos das expressões em Python.

`Notas de sintaxe:' Neste e nos capítulos seguintes, a notação BNF estendida será usada para descrever a sintaxe, não a análise lexical. Quando (uma alternativa de) uma regra de sintaxe tem a forma

@example
@anchor{reference/expressions grammar-token-python-grammar-name}@anchor{21a2}name ::= othername
@end example

e nenhuma semântica é fornecida, a semântica desta forma de @code{name} é a mesma que para @code{othername}.

@menu
* Conversões aritméticas:: 
* Átomos:: 
* Primárias:: 
* Expressão await:: 
* O operador de potência:: 
* Operações aritméticas unárias e bit a bit:: 
* Operações binárias aritméticas:: 
* Operações de deslocamento:: 
* Operações binárias bit a bit:: 
* Comparações:: 
* Operações booleanas:: 
* Expressões de atribuição: Expressões de atribuição<2>. 
* Expressões condicionais:: 
* Lambdas:: 
* Listas de expressões:: 
* Ordem de avaliação:: 
* Precedência de operadores:: 

@end menu

@node Conversões aritméticas,Átomos,,Expressões
@anchor{reference/expressions arithmetic-conversions}@anchor{21a3}@anchor{reference/expressions conversions}@anchor{21a4}
@subsection Conversões aritméticas


@geindex aritmética;conversão

Quando uma descrição de um operador aritmético abaixo usa a frase “os argumentos numéricos são convertidos em um tipo comum”, isso significa que a implementação do operador para tipos embutidos funciona da seguinte maneira:


@itemize *

@item 
Se um dos argumentos for um número complexo, o outro será convertido em complexo;

@item 
caso contrário, se um dos argumentos for um número de ponto flutuante, o outro será convertido em ponto flutuante;

@item 
caso contrário, ambos devem ser inteiros e nenhuma conversão é necessária.
@end itemize

Algumas regras adicionais se aplicam a certos operadores (por exemplo, uma string como um argumento à esquerda para o operador ‘%’). As extensões devem definir seu próprio comportamento de conversão.

@node Átomos,Primárias,Conversões aritméticas,Expressões
@anchor{reference/expressions atoms}@anchor{21a5}@anchor{reference/expressions id2}@anchor{21a6}
@subsection Átomos


@geindex átomo

Os átomos são os elementos mais básicos das expressões. Os átomos mais simples são identificadores ou literais. As formas entre parênteses, colchetes ou chaves também são categorizadas sintaticamente como átomos. A sintaxe para átomos é:

@example
@anchor{reference/expressions grammar-token-python-grammar-atom}@anchor{21a7}atom      ::= @ref{2023,,identifier} | @ref{21a8,,literal} | @ref{21a9,,enclosure}
@anchor{reference/expressions grammar-token-python-grammar-enclosure}@anchor{21a9}enclosure ::= @ref{21aa,,parenth_form} | @ref{21ab,,list_display} | @ref{21ac,,dict_display} | @ref{21ad,,set_display}
              | @ref{21ae,,generator_expression} | @ref{21af,,yield_atom}
@end example

@menu
* Identificadores (Nomes): Identificadores Nomes. 
* Literais: Literais<2>. 
* Formas de parênteses:: 
* Sintaxe de criação de listas@comma{} conjuntos e dicionários: Sintaxe de criação de listas conjuntos e dicionários. 
* Sintaxes de criação de lista:: 
* Sintaxes de criação de conjunto:: 
* Sintaxes de criação de dicionário:: 
* Expressões geradoras: Expressões geradoras<2>. 
* Expressões yield:: 

@end menu

@node Identificadores Nomes,Literais<2>,,Átomos
@anchor{reference/expressions atom-identifiers}@anchor{202d}@anchor{reference/expressions identifiers-names}@anchor{21b0}
@subsubsection Identificadores (Nomes)


@geindex nome
@geindex identificador

Um identificador que ocorre como um átomo é um nome. Veja a seção @ref{2021,,Identificadores e palavras-chave} para a definição lexical e a seção @ref{208a,,Nomeação e ligação} para documentação de nomenclatura e ligação.

@geindex exceção;NameError

Quando o nome está vinculado a um objeto, a avaliação do átomo produz esse objeto. Quando um nome não está vinculado, uma tentativa de avaliá-lo levanta uma exceção @ref{43f,,NameError}.

@geindex nome;desfiguração
@geindex privados;nomes
@anchor{reference/expressions private-name-mangling}@anchor{1e43}
@menu
* Desfiguração de nome privado:: 

@end menu

@node Desfiguração de nome privado,,,Identificadores Nomes
@anchor{reference/expressions id3}@anchor{21b1}
@subsubsection Desfiguração de nome privado


Quando um identificador que ocorre textualmente em uma definição de classe começa com dois ou mais caracteres de sublinhado e não termina com dois ou mais sublinhados, ele é considerado um `nome privado' daquela classe.


@subsubheading Ver também


As @ref{131a,,especificações de classe}.


Mais precisamente, os nomes privados são transformados em um formato mais longo antes que o código seja gerado para eles. Se o nome transformado tiver mais de 255 caracteres, poderá ocorrer truncamento definido pela implementação.

A transformação é independente do contexto sintático no qual o identificador é usado, mas apenas os seguintes identificadores privados são desfigurados:


@itemize -

@item 
Qualquer nome usado como nome de uma variável que é atribuída ou lida ou qualquer nome de um atributo que está sendo acessado.

O atributo @ref{109f,,__name__} de funções aninhadas, classes e apelidos de tipo, entretanto, não é desfigurado.

@item 
O nome dos módulos importados, por exemplo, @code{__spam} em @code{import __spam}. Se o módulo faz parte de um pacote (ou seja, seu nome contém um ponto), o nome `não' é desfigurado, por exemplo, o @code{__foo} em @code{import __foo.bar} não é desfigurado.

@item 
O nome de um membro importado, por exemplo, @code{__f} em @code{from spam import __f}.
@end itemize

A regra de transformação está definida da seguinte forma:


@itemize -

@item 
O nome da classe, com os sublinhados iniciais removidos e um único sublinhado inicial inserido, é inserido na frente do identificador, por exemplo, o identificador @code{__spam} ocorrendo em uma classe chamada @code{Foo}, @code{_Foo} ou @code{__Foo} é transformado em @code{_Foo__spam}.

@item 
Se o nome da classe consiste apenas em sublinhados, a transformação é a identidade, por exemplo, o identificador @code{__spam} que ocorre em uma classe chamada @code{_} ou @code{__} é deixado como está.
@end itemize

@node Literais<2>,Formas de parênteses,Identificadores Nomes,Átomos
@anchor{reference/expressions atom-literals}@anchor{21b2}@anchor{reference/expressions literals}@anchor{21b3}
@subsubsection Literais


@geindex literal

Python oferece suporte a strings e bytes literais e vários literais numéricos:

@example
@anchor{reference/expressions grammar-token-python-grammar-literal}@anchor{21a8}literal ::= @ref{2032,,stringliteral} | @ref{203b,,bytesliteral}
            | @ref{2056,,integer} | @ref{2062,,floatnumber} | @ref{206a,,imagnumber}
@end example

A avaliação de um literal produz um objeto do tipo fornecido (string, bytes, inteiro, número de ponto flutuante, número complexo) com o valor fornecido. O valor pode ser aproximado no caso de ponto flutuante e literais imaginários (complexos). Veja a seção @ref{202f,,Literais} para detalhes.

@geindex imutável;dados;tipo
@geindex imutável;objeto

Todos os literais correspondem a tipos de dados imutáveis e, portanto, a identidade do objeto é menos importante que seu valor. Múltiplas avaliações de literais com o mesmo valor (seja a mesma ocorrência no texto do programa ou uma ocorrência diferente) podem obter o mesmo objeto ou um objeto diferente com o mesmo valor.

@node Formas de parênteses,Sintaxe de criação de listas conjuntos e dicionários,Literais<2>,Átomos
@anchor{reference/expressions parenthesized}@anchor{21b4}@anchor{reference/expressions parenthesized-forms}@anchor{21b5}
@subsubsection Formas de parênteses


@geindex forma entre parênteses
@geindex () (parênteses);sintaxe de criação de tupla

Um forma entre parênteses é uma lista de expressões opcional entre parênteses:

@example
@anchor{reference/expressions grammar-token-python-grammar-parenth_form}@anchor{21aa}parenth_form ::= "(" [@ref{21b6,,starred_expression}] ")"
@end example

Uma lista de expressões entre parênteses produz tudo o que aquela lista de expressões produz: se a lista contiver pelo menos uma vírgula, ela produzirá uma tupla; caso contrário, produz a única expressão que compõe a lista de expressões.

@geindex vazia;tupla

Um par de parênteses vazio produz um objeto tupla vazio. Como as tuplas são imutáveis, aplicam-se as mesmas regras dos literais (isto é, duas ocorrências da tupla vazia podem ou não produzir o mesmo objeto).

@geindex vírgula
@geindex @comma{} (vírgula)

Observe que as tuplas não são formadas pelos parênteses, mas sim pelo uso da vírgula. A exceção é a tupla vazia, para a qual os parênteses `são' obrigatórios – permitir “nada” sem parênteses em expressões causaria ambiguidades e permitiria que erros de digitação comuns passassem sem serem detectados.

@node Sintaxe de criação de listas conjuntos e dicionários,Sintaxes de criação de lista,Formas de parênteses,Átomos
@anchor{reference/expressions comprehensions}@anchor{5d0}@anchor{reference/expressions displays-for-lists-sets-and-dictionaries}@anchor{21b7}
@subsubsection Sintaxe de criação de listas, conjuntos e dicionários


@geindex compreensões

Para construir uma lista, um conjunto ou um dicionário, o Python fornece uma sintaxe especial chamada “sintaxes de criação” (em inglês, `displays'), cada uma delas em dois tipos:


@itemize *

@item 
o conteúdo do contêiner é listado explicitamente ou

@item 
eles são calculados por meio de um conjunto de instruções de laço e filtragem, chamado de `compreensão'.
@end itemize

@geindex for;em compreensões
@geindex if;em compreensões
@geindex async for;em compreensões

Elementos de sintaxe comuns para compreensões são:

@example
@anchor{reference/expressions grammar-token-python-grammar-comprehension}@anchor{21b8}comprehension ::= @ref{21b9,,assignment_expression} @ref{21ba,,comp_for}
@anchor{reference/expressions grammar-token-python-grammar-comp_for}@anchor{21ba}comp_for      ::= ["async"] "for" @ref{21bb,,target_list} "in" @ref{21bc,,or_test} [@ref{21bd,,comp_iter}]
@anchor{reference/expressions grammar-token-python-grammar-comp_iter}@anchor{21bd}comp_iter     ::= @ref{21ba,,comp_for} | @ref{21be,,comp_if}
@anchor{reference/expressions grammar-token-python-grammar-comp_if}@anchor{21be}comp_if       ::= "if" @ref{21bc,,or_test} [@ref{21bd,,comp_iter}]
@end example

A compreensão consiste em uma única expressão seguida por pelo menos uma cláusula @code{for} e zero ou mais cláusulas @code{for} ou @code{if}. Neste caso, os elementos do novo contêiner são aqueles que seriam produzidos considerando cada uma das cláusulas @code{for} ou @code{if} de um bloco, aninhando da esquerda para a direita, e avaliando a expressão para produzir um elemento cada vez que o bloco mais interno é alcançado.

No entanto, além da expressão iterável na cláusula @code{for} mais à esquerda, a compreensão é executada em um escopo aninhado implicitamente separado. Isso garante que os nomes atribuídos na lista de destino não “vazem” para o escopo delimitador.

A expressão iterável na cláusula @code{for} mais à esquerda é avaliada diretamente no escopo envolvente e então passada como um argumento para o escopo aninhado implicitamente. Cláusulas @code{for} subsequentes e qualquer condição de filtro na cláusula @code{for} mais à esquerda não podem ser avaliadas no escopo delimitador, pois podem depender dos valores obtidos do iterável mais à esquerda. Por exemplo: @code{[x*y for x in range(10) for y in range(x, x+10)]}.

Para garantir que a compreensão sempre resulte em um contêiner do tipo apropriado, as expressões @code{yield} e @code{yield from} são proibidas no escopo aninhado implicitamente.

@geindex await;em compreensões

Desde o Python 3.6, em uma função @ref{5d1,,async def}, uma cláusula @code{async for} pode ser usada para iterar sobre um @ref{1ab,,iterador assíncrono}. Uma compreensão em uma função @code{async def} pode consistir em uma cláusula @code{for} ou @code{async for} seguindo a expressão inicial, pode conter @code{for} adicional ou @code{async for} e também pode usar expressões @ref{1b9,,await}.

Se uma compreensão contém cláusulas @code{async for}, ou se contém expressões @code{await} ou outras compreensões assíncronas em qualquer lugar, exceto a expressão iterável na cláusula @code{for} mais à esquerda, ela é chamada uma `compreensão assíncrona'. Uma compreensão assíncrona pode suspender a execução da função de corrotina em que aparece. Veja também a 
@geindex Propostas de Melhorias do Python; PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/}.


Adicionado na versão 3.6: Compreensões assíncronas foram introduzidas.



Alterado na versão 3.8: @code{yield} e @code{yield from} proibidos no escopo aninhado implícito.



Alterado na versão 3.11: Compreensões assíncronas agora são permitidas dentro de compreensões em funções assíncronas. As compreensões externas tornam-se implicitamente assíncronas.


@node Sintaxes de criação de lista,Sintaxes de criação de conjunto,Sintaxe de criação de listas conjuntos e dicionários,Átomos
@anchor{reference/expressions list-displays}@anchor{21bf}@anchor{reference/expressions lists}@anchor{21c0}
@subsubsection Sintaxes de criação de lista


@geindex lista;sintaxe de criação
@geindex lista;compreensões
@geindex vazia;lista
@geindex objeto;lista
@geindex [] (colchetes);expressão de lista
@geindex @comma{} (vírgula);expressão@comma{} lista de

Uma sintaxe de criação de lista é uma série possivelmente vazia de expressões entre colchetes:

@example
@anchor{reference/expressions grammar-token-python-grammar-list_display}@anchor{21ab}list_display ::= "[" [@ref{21c1,,flexible_expression_list} | @ref{21b8,,comprehension}] "]"
@end example

Uma sintaxe de criação de lista produz um novo objeto de lista, sendo o conteúdo especificado por uma lista de expressões ou uma compreensão. Quando uma lista de expressões separadas por vírgulas é fornecida, seus elementos são avaliados da esquerda para a direita e colocados no objeto de lista nessa ordem. Quando uma compreensão é fornecida, a lista é construída a partir dos elementos resultantes da compreensão.

@node Sintaxes de criação de conjunto,Sintaxes de criação de dicionário,Sintaxes de criação de lista,Átomos
@anchor{reference/expressions set}@anchor{21c2}@anchor{reference/expressions set-displays}@anchor{21c3}
@subsubsection Sintaxes de criação de conjunto


@geindex set;sintaxe de criação
@geindex set;compreensões
@geindex objeto;set
@geindex @{@} (chaves);expressão de conjunto
@geindex @comma{} (vírgula);expressão@comma{} lista de

Uma sintaxe de criação definida é denotada por chaves e distinguível de sintaxes de criação de dicionário pela falta de caractere de dois pontos separando chaves e valores:

@example
@anchor{reference/expressions grammar-token-python-grammar-set_display}@anchor{21ad}set_display ::= "@{" (@ref{21c1,,flexible_expression_list} | @ref{21b8,,comprehension}) "@}"
@end example

Uma sintaxe de criação de conjunto produz um novo objeto de conjunto mutável, sendo o conteúdo especificado por uma sequência de expressões ou uma compreensão. Quando uma lista de expressões separadas por vírgula é fornecida, seus elementos são avaliados da esquerda para a direita e adicionados ao objeto definido. Quando uma compreensão é fornecida, o conjunto é construído a partir dos elementos resultantes da compreensão.

Um conjunto vazio não pode ser construído com @code{@{@}}; este literal constrói um dicionário vazio.

@node Sintaxes de criação de dicionário,Expressões geradoras<2>,Sintaxes de criação de conjunto,Átomos
@anchor{reference/expressions dict}@anchor{da7}@anchor{reference/expressions dictionary-displays}@anchor{21c4}
@subsubsection Sintaxes de criação de dicionário


@geindex dicionário;sintaxe de criação
@geindex dicionário;compreensões
@geindex chave
@geindex valor
@geindex par chave/valor
@geindex objeto;dicionário
@geindex @{@} (chaves);expressão de dicionário
@geindex ; (dois pontos);em expressões de dicionário
@geindex @comma{} (vírgula);em sintaxes de criação de dicionário

Uma sintaxe de criação de dicionário é uma série possivelmente vazia de itens de dicionário (pares chave/valor) envolto entre chaves:

@example
@anchor{reference/expressions grammar-token-python-grammar-dict_display}@anchor{21ac}dict_display       ::= "@{" [@ref{21c5,,dict_item_list} | @ref{21c6,,dict_comprehension}] "@}"
@anchor{reference/expressions grammar-token-python-grammar-dict_item_list}@anchor{21c5}dict_item_list     ::= @ref{21c7,,dict_item} ("," @ref{21c7,,dict_item})* [","]
@anchor{reference/expressions grammar-token-python-grammar-dict_item}@anchor{21c7}dict_item          ::= @ref{21c8,,expression} ":" @ref{21c8,,expression} | "**" @ref{2050,,or_expr}
@anchor{reference/expressions grammar-token-python-grammar-dict_comprehension}@anchor{21c6}dict_comprehension ::= @ref{21c8,,expression} ":" @ref{21c8,,expression} @ref{21ba,,comp_for}
@end example

Uma sintaxe de criação de dicionário produz um novo objeto dicionário.

Se for fornecida uma sequência separada por vírgulas de itens de dicionário, eles são avaliados da esquerda para a direita para definir as entradas do dicionário: cada objeto chave é usado como uma chave no dicionário para armazenar o valor correspondente. Isso significa que você pode especificar a mesma chave várias vezes na lista de itens de dicionário, e o valor final do dicionário para essa chave será o último dado.

@geindex desempacotamento;dicionário
@geindex **;em sintaxes de criação de dicionário

Um asterisco duplo @code{**} denota `desempacotamento do dicionário'. Seu operando deve ser um @ref{11fb,,mapeamento}. Cada item de mapeamento é adicionado ao novo dicionário. Os valores posteriores substituem os valores já definidos por itens de dicionário anteriores e desempacotamentos de dicionário anteriores.


Adicionado na versão 3.5: Desempacotando em sintaxes de criação de dicionário, originalmente proposto pela 
@geindex Propostas de Melhorias do Python; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/}.


Uma compreensão de dict, em contraste com as compreensões de lista e conjunto, precisa de duas expressões separadas por dois pontos, seguidas pelas cláusulas usuais “for” e “if”. Quando a compreensão é executada, os elementos chave e valor resultantes são inseridos no novo dicionário na ordem em que são produzidos.

@geindex imutável;objeto
@geindex hasheável

Restrições nos tipos de valores de chave são listadas anteriormente na seção @ref{2075,,A hierarquia de tipos padrão}. (Para resumir, o tipo de chave deve ser @ref{610,,hasheável}, que exclui todos os objetos mutáveis.) Não são detectadas colisões entre chaves duplicadas; o último valor (textualmente mais à direita na sintaxe de criação) armazenado para um determinado valor de chave prevalece.


Alterado na versão 3.8: Antes do Python 3.8, em compreensões de dict, a ordem de avaliação de chave e valor não era bem definida. No CPython, o valor foi avaliado antes da chave. A partir de 3.8, a chave é avaliada antes do valor, conforme proposto pela 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}.


@node Expressões geradoras<2>,Expressões yield,Sintaxes de criação de dicionário,Átomos
@anchor{reference/expressions generator-expressions}@anchor{21c9}@anchor{reference/expressions genexpr}@anchor{21ca}
@subsubsection Expressões geradoras


@geindex gerador;expressão
@geindex objeto;gerador
@geindex () (parênteses);expressão geradora

Uma expressão geradora é uma notação geradora compacta entre parênteses:

@example
@anchor{reference/expressions grammar-token-python-grammar-generator_expression}@anchor{21ae}generator_expression ::= "(" @ref{21c8,,expression} @ref{21ba,,comp_for} ")"
@end example

Uma expressão geradora produz um novo objeto gerador. Sua sintaxe é a mesma das compreensões, exceto pelo fato de estar entre parênteses em vez de colchetes ou chaves.

As variáveis usadas na expressão geradora são avaliadas lentamente quando o método @ref{1e4e,,__next__()} é chamado para o objeto gerador (da mesma forma que os geradores normais). No entanto, a expressão iterável na cláusula @code{for} mais à esquerda é avaliada imediatamente e o @ref{1ac,,iterador} é imediatamente criado para aquele iterável, de modo que um erro produzido enquanto cria o iterador será emitido no ponto em que a expressão geradora é definida, em vez de no ponto em que o primeiro valor é recuperado. Cláusulas @code{for} subsequentes e qualquer condição de filtro na cláusula @code{for} mais à esquerda não podem ser avaliadas no escopo delimitador, pois podem depender dos valores obtidos do iterável mais à esquerda. Por exemplo: @code{(x*y for x in range(10) for y in range(x, x+10))}.

Os parênteses podem ser omitidos em chamadas com apenas um argumento. Veja a seção @ref{da5,,Chamadas} para detalhes.

Para evitar interferir com a operação esperada da própria expressão geradora, as expressões @code{yield} e @code{yield from} são proibidas no gerador definido implicitamente.

Se uma expressão geradora contém cláusulas @code{async for} ou expressões @ref{1b9,,await}, ela é chamada de `expressão geradora assíncrona'. Uma expressão geradora assíncrona retorna um novo objeto gerador assíncrono, que é um iterador assíncrono (consulte @ref{d9f,,Iteradores assíncronos}).


Adicionado na versão 3.6: Expressões geradoras assíncronas foram introduzidas.



Alterado na versão 3.7: Antes do Python 3.7, as expressões geradoras assíncronas só podiam aparecer em corrotinas @ref{5d1,,async def}. A partir da versão 3.7, qualquer função pode usar expressões geradoras assíncronas.



Alterado na versão 3.8: @code{yield} e @code{yield from} proibidos no escopo aninhado implícito.


@node Expressões yield,,Expressões geradoras<2>,Átomos
@anchor{reference/expressions yield-expressions}@anchor{21cb}@anchor{reference/expressions yieldexpr}@anchor{21cc}
@subsubsection Expressões yield


@geindex palavra reservada;yield
@geindex palavra reservada;from
@geindex yield;expressão
@geindex gerador;função

@example
@anchor{reference/expressions grammar-token-python-grammar-yield_atom}@anchor{21af}yield_atom       ::= "(" @ref{2051,,yield_expression} ")"
@anchor{reference/expressions grammar-token-python-grammar-yield_from}@anchor{21cd}yield_from       ::= "yield" "from" @ref{21c8,,expression}
@anchor{reference/expressions grammar-token-python-grammar-yield_expression}@anchor{2051}yield_expression ::= "yield" @ref{21ce,,yield_list} | @ref{21cd,,yield_from}
@end example

A expressão yield é usada ao definir uma função @ref{109a,,geradora} ou uma função @ref{21cf,,geradora assíncrona} e, portanto, só pode ser usada no corpo de uma definição de função. Usar uma expressão yield no corpo de uma função faz com que essa função seja uma função geradora, e usá-la no corpo de uma função @ref{5d1,,async def} faz com que essa função de corrotina seja uma função geradora assíncrona. Por exemplo:

@example
def gen():  # define uma função geradora
    yield 123

async def agen(): # define uma função geradora assíncrona
    yield 123
@end example

Devido a seus efeitos colaterais no escopo recipiente, as expressões @code{yield} não são permitidas como parte dos escopos definidos implicitamente usados para implementar compreensões e expressões geradoras.


Alterado na versão 3.8: Expressões yield proibidas nos escopos aninhados implicitamente usados para implementar compreensões e expressões geradoras.


As funções geradoras são descritas abaixo, enquanto as funções geradoras assíncronas são descritas separadamente na seção @ref{21d0,,Funções geradoras assíncronas}

Quando uma função geradora é chamada, ela retorna um iterador conhecido como gerador. Esse gerador então controla a execução da função geradora. A execução começa quando um dos métodos do gerador é chamado. Nesse momento, a execução segue para a primeira expressão yield, onde é suspensa novamente, retornando o valor de @ref{21ce,,yield_list} ao chamador do gerador, ou @code{None} se @ref{21ce,,yield_list} é omitido. Por suspenso, queremos dizer que todo o estado local é retido, incluindo as chamadas atuais de variáveis locais, o ponteiro de instrução, a pilha de avaliação interna e o estado de qualquer tratamento de exceção. Quando a execução é retomada chamando um dos métodos do gerador, a função pode prosseguir exatamente como se a expressão yield fosse apenas outra chamada externa. O valor da expressão yield após a retomada depende do método que retomou a execução. Se @ref{1e4e,,__next__()} for usado (tipicamente através de uma @ref{2f2,,for} ou do @ref{7d9,,next()} embutido) então o resultado será @ref{675,,None}. Caso contrário, se @ref{215a,,send()} for usado, o resultado será o valor passado para esse método.

@geindex corrotina

Tudo isso torna as funções geradoras bastante semelhantes às corrotinas; cedem múltiplas vezes, possuem mais de um ponto de entrada e sua execução pode ser suspensa. A única diferença é que uma função geradora não pode controlar onde a execução deve continuar após o seu rendimento; o controle é sempre transferido para o chamador do gerador.

Expressões yield são permitidas em qualquer lugar em uma construção @ref{6e9,,try}. Se o gerador não for retomado antes de ser finalizado (ao atingir uma contagem de referências zero ou ao ser coletado como lixo), o método @ref{15b9,,close()} do iterador de gerador será chamado, permitindo que quaisquer cláusulas @ref{9d2,,finally} pendentes sejam executadas.

@geindex from;yield from expressão

Quando @code{yield from <expr>} é usado, a expressão fornecida deve ser iterável. Os valores produzidos pela iteração desse iterável são passados diretamente para o chamador dos métodos do gerador atual. Quaisquer valores passados com @ref{215a,,send()} e quaisquer exceções passadas com @ref{4f8,,throw()} são passados para o iterador subjacente se ele tiver os métodos apropriados. Se este não for o caso, então @ref{215a,,send()} irá levantar @ref{34b,,AttributeError} ou @ref{2c3,,TypeError}, enquanto @ref{4f8,,throw()} irá apenas levantar a exceção passada imediatamente.

Quando o iterador subjacente estiver completo, o atributo @ref{2157,,value} da instância @ref{c15,,StopIteration} gerada torna-se o valor da expressão yield. Ele pode ser definido explicitamente ao levantar @ref{c15,,StopIteration} ou automaticamente quando o subiterador é um gerador (retornando um valor do subgerador).


Alterado na versão 3.3: Adicionado @code{yield from <expr>} para delegar o fluxo de controle a um subiterador.


Os parênteses podem ser omitidos quando a expressão yield é a única expressão no lado direito de uma instrução de atribuição.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - Simple Generators

A proposta para adicionar geradores e a instrução @ref{9d5,,yield} ao Python.

@geindex Propostas de Melhorias do Python; PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - Corrotinas via Geradores Aprimorados

A proposta de aprimorar a API e a sintaxe dos geradores, tornando-os utilizáveis como simples corrotinas.

@geindex Propostas de Melhorias do Python; PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - Sintaxe para Delegar a um Subgerador

A proposta de introduzir a sintaxe @ref{21cd,,yield_from}, facilitando a delegação a subgeradores.

@geindex Propostas de Melhorias do Python; PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/} - Geradores assíncronos

A proposta que se expandiu em 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} adicionando recursos de gerador a funções de corrotina.
@end table


@geindex objeto;gerador

@menu
* Métodos de iterador gerador:: 
* Exemplos:: 
* Funções geradoras assíncronas: Funções geradoras assíncronas<2>. 
* Métodos geradores-iteradores assíncronos:: 

@end menu

@node Métodos de iterador gerador,Exemplos,,Expressões yield
@anchor{reference/expressions generator-iterator-methods}@anchor{21d1}@anchor{reference/expressions generator-methods}@anchor{2158}
@subsubsection Métodos de iterador gerador


Esta subseção descreve os métodos de um iterador gerador. Eles podem ser usados para controlar a execução de uma função geradora.

Observe que chamar qualquer um dos métodos do gerador abaixo quando o gerador já estiver em execução levanta uma exceção @ref{202,,ValueError}.

@geindex exceção;StopIteration

@geindex __next__() (método generator)
@anchor{reference/expressions generator __next__}@anchor{1e4e}
@deffn {Método} generator.__next__ ()

Inicia a execução de uma função geradora ou a retoma na última expressão yield executada. Quando uma função geradora é retomada com um método @ref{1e4e,,__next__()}, a expressão yield atual sempre é avaliada como @ref{675,,None}. A execução então continua para a próxima expressão yield, onde o gerador é suspenso novamente, e o valor de @ref{21ce,,yield_list} é retornado para o chamador de @ref{1e4e,,__next__()}. Se o gerador sair sem produzir outro valor, uma exceção @ref{c15,,StopIteration} será levantada.

Este método é normalmente chamado implicitamente, por exemplo por um laço @ref{2f2,,for}, ou pela função embutida @ref{7d9,,next()}.
@end deffn

@geindex send() (método generator)
@anchor{reference/expressions generator send}@anchor{215a}
@deffn {Método} generator.send (value)

Retoma a execução e “envia” um valor para a função geradora. O argumento `value' torna-se o resultado da expressão yield atual. O método @ref{215a,,send()} retorna o próximo valor gerado pelo gerador, ou levanta @ref{c15,,StopIteration} se o gerador sair sem produzir outro valor. Quando @ref{215a,,send()} é chamado para iniciar o gerador, ele deve ser chamado com @ref{675,,None} como argumento, porque não há nenhuma expressão yield que possa receber o valor.
@end deffn

@geindex throw() (método generator)
@anchor{reference/expressions generator throw}@anchor{4f8}
@deffn {Método} generator.throw (value)

@deffnx {Método} generator.throw (type[, value[, traceback]])

Levanta uma exceção no ponto em que o gerador foi pausado e retorna o próximo valor gerado pela função geradora. Se o gerador sair sem gerar outro valor, uma exceção @ref{c15,,StopIteration} será levantada. Se a função geradora não detectar a exceção passada ou levanta uma exceção diferente, essa exceção se propagará para o chamador.

Em uso típico, isso é chamado com uma única instância de exceção semelhante à forma como a palavra reservada @ref{5ed,,raise} é usada.

Para compatibilidade com versões anteriores, no entanto, a segunda assinatura é suportada, seguindo uma convenção de versões mais antigas do Python. O argumento `type' deve ser uma classe de exceção e `value' deve ser uma instância de exceção. Se o `valor' não for fornecido, o construtor `tipo' será chamado para obter uma instância. Se `traceback' for fornecido, ele será definido na exceção, caso contrário, qualquer atributo @ref{1309,,__traceback__} existente armazenado em `value' poderá ser limpo.


Alterado na versão 3.12: A segunda assinatura (tipo[, valor[, traceback]]) foi descontinuada e pode ser removida em uma versão futura do Python.

@end deffn

@geindex exceção;GeneratorExit

@geindex close() (método generator)
@anchor{reference/expressions generator close}@anchor{15b9}
@deffn {Método} generator.close ()

Levanta uma exceção @ref{140e,,GeneratorExit} no ponto onde a função geradora foi pausada (equivalente a chamar @code{throw(GeneratorExit)}) A exceção é levantada pela expressão yield onde o gerador foi pausado. Se a função geradora captura a exceção, e retorna um valor, este valor é retornado de @ref{15b9,,close()}. Se a função geradora já estiver fechada ou levantar @ref{140e,,GeneratorExit} (por não capturar a exceção), @ref{15b9,,close()} retornará @ref{675,,None}. Se o gerador produzir um valor, uma exceção @ref{195,,RuntimeError} é levantada. Se o gerador levantar qualquer outra exceção, ela será propagada para o chamador. Se o gerador já saiu devido a uma exceção ou saída normal, @ref{15b9,,close()} retorna @ref{675,,None} e tem nenhum outro efeito.


Alterado na versão 3.13: Se um gerador retornar um valor ao ser fechado, o valor será retornado por @ref{15b9,,close()}.

@end deffn

@geindex yield;exemplos

@node Exemplos,Funções geradoras assíncronas<2>,Métodos de iterador gerador,Expressões yield
@anchor{reference/expressions examples}@anchor{21d2}
@subsubsection Exemplos


Aqui está um exemplo simples que demonstra o comportamento de geradores e funções geradoras:

@example
>>> def echo(value=None):
...     print("A execução inicia quando 'next()' é chamada pela primeira vez.")
...     try:
...         while True:
...             try:
...                 value = (yield value)
...             except Exception as e:
...                 value = e
...     finally:
...         print("Não se esqueça de fazer uma limpeza quando 'close()' for chamada.")
...
>>> generator = echo(1)
>>> print(next(generator))
A execução inicia quando 'next()' é chamada pela primeira vez.
1
>>> print(next(generator))
None
>>> print(generator.send(2))
2
>>> generator.throw(TypeError, "spam")
TypeError('spam',)
>>> generator.close()
Não se esqueça de fazer uma limpeza quando 'close()' for chamada.
@end example

Para exemplos usando @code{yield from}, consulte a @ref{1072,,PEP 380; Syntax for Delegating to a Subgenerator} em “O que há de novo no Python.”

@node Funções geradoras assíncronas<2>,Métodos geradores-iteradores assíncronos,Exemplos,Expressões yield
@anchor{reference/expressions asynchronous-generator-functions}@anchor{21d0}@anchor{reference/expressions id4}@anchor{21d3}
@subsubsection Funções geradoras assíncronas


A presença de uma expressão yield em uma função ou método definido usando a @ref{5d1,,async def} define ainda mais a função como uma função @ref{21cf,,geradora assíncrona}.

Quando uma função geradora assíncrona é chamada, ela retorna um iterador assíncrono conhecido como objeto gerador assíncrono. Esse objeto controla a execução da função geradora. Um objeto gerador assíncrono é normalmente usado em uma instrução @ref{aba,,async for} em uma função de corrotina de forma análoga a como um objeto gerador seria usado em uma instrução @ref{2f2,,for}.

A chamada de um dos métodos do gerador assíncrono retorna um objeto @ref{1ad,,aguardável}, e a execução começa quando esse objeto é aguardado. Nesse momento, a execução prossegue até a primeira expressão yield, onde é suspensa novamente, retornando o valor de @ref{21ce,,yield_list} para a corrotina em aguardo. Assim como ocorre com um gerador, a suspensão significa que todo o estado local é mantido, inclusive as ligações atuais das variáveis locais, o ponteiro de instruções, a pilha de avaliação interna e o estado de qualquer tratamento de exceção. Quando a execução é retomada, aguardando o próximo objeto retornado pelos métodos do gerador assíncrono, a função pode prosseguir exatamente como se a expressão de rendimento fosse apenas outra chamada externa. O valor da expressão yield após a retomada depende do método que retomou a execução.  Se @ref{21d4,,__anext__()} for usado, o resultado será @ref{675,,None}. Caso contrário, se @ref{8df,,asend()} for usado, o resultado será o valor passado para esse método.

Se um gerador assíncrono encerrar mais cedo por @ref{ab8,,break}, pela tarefa que fez sua chamada ser cancelada ou por outras exceções, o código de limpeza assíncrona do gerador será executado e possivelmente levantará alguma exceção ou acessará as variáveis de contexto em um contexto inesperado – talvez após o tempo de vida das tarefas das quais ele depende, ou durante o laço de eventos de encerramento quando o gancho de coleta de lixo do gerador assíncrono for chamado. Para prevenir isso, o chamador deve encerrar explicitamente o gerador assíncrono chamando o método @ref{8de,,aclose()} para finalizar o gerador e, por fim, desconectá-lo do laço de eventos.

Em uma função geradora assíncrona, expressões de yield são permitidas em qualquer lugar em uma construção @ref{6e9,,try}. No entanto, se um gerador assíncrono não for retomado antes de ser finalizado (alcançando uma contagem de referência zero ou sendo coletado pelo coletor de lixo), então uma expressão de yield dentro de um construção @code{try} pode resultar em uma falha na execução das cláusulas pendentes de @ref{9d2,,finally}. Nesse caso, é responsabilidade do laço de eventos ou escalonador que executa o gerador assíncrono chamar o método @ref{8de,,aclose()} do gerador iterador assíncrono e executar o objeto corrotina resultante, permitindo assim que quaisquer cláusulas pendentes de @code{finally} sejam executadas.

Para cuidar da finalização após o término do laço de eventos, um laço de eventos deve definir uma função `finalizer' que recebe um gerador assíncrono e provavelmente chama @ref{8de,,aclose()} e executa a corrotina. Este `finalizer' pode ser registrado chamando @ref{1712,,sys.set_asyncgen_hooks()}. Quando iterado pela primeira vez, um gerador assíncrono armazenará o `finalizer' registrado para ser chamado na finalização. Para um exemplo de referência de um método `finalizer', consulte a implementação de @code{asyncio.Loop.shutdown_asyncgens} em Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/base_events.py}.

O expressão @code{yield from <expr>} é um erro de sintaxe quando usado em uma função geradora assíncrona.

@geindex objeto;gerador assíncrono

@node Métodos geradores-iteradores assíncronos,,Funções geradoras assíncronas<2>,Expressões yield
@anchor{reference/expressions asynchronous-generator-iterator-methods}@anchor{21d5}@anchor{reference/expressions asynchronous-generator-methods}@anchor{21d6}
@subsubsection Métodos geradores-iteradores assíncronos


Esta subseção descreve os métodos de um iterador gerador assíncrono, que são usados para controlar a execução de uma função geradora.

@geindex exceção;StopAsyncIteration

@geindex __anext__() (método agen)
@anchor{reference/expressions agen __anext__}@anchor{21d4}
@deffn {Método} async agen.__anext__ ()

Retorna um objeto aguardável que, quando executado, começa a executar o gerador assíncrono ou o retoma na última expressão yield executada. Quando uma função geradora assíncrona é retomada com o método @ref{21d4,,__anext__()}, a expressão yield atual sempre avalia para @ref{675,,None} no objeto aguardável retornado, que, quando executado, continuará para a próxima expressão yield. O valor de @ref{21ce,,yield_list} da expressão yield é o valor da exceção @ref{c15,,StopIteration} levantada pela corrotina em conclusão. Se o gerador assíncrono sair sem produzir outro valor, o objeto aguardável em vez disso levanta uma exceção @ref{1ba5,,StopAsyncIteration}, sinalizando que a iteração assíncrona foi concluída.

Este método é normalmente chamado implicitamente por um laço @ref{aba,,async for}.
@end deffn

@geindex asend() (método agen)
@anchor{reference/expressions agen asend}@anchor{8df}
@deffn {Método} async agen.asend (value)

Retorna um objeto aguardável que, quando executado, retoma a execução do gerador assíncrono. Assim como o método @ref{215a,,send()} para um gerador, isso “envia” um valor para a função geradora assíncrona, e o argumento `value' se torna o resultado da expressão de yield atual. O objeto aguardável retornado pelo método @ref{8df,,asend()} retornará o próximo valor produzido pelo gerador como o valor da exceção @ref{c15,,StopIteration} levantada, ou lança @ref{1ba5,,StopAsyncIteration} se o gerador assíncrono sair sem produzir outro valor. Quando @ref{8df,,asend()} é chamado para iniciar o gerador assíncrono, ele deve ser chamado com @ref{675,,None} como argumento, pois não há expressão yield que possa receber o valor.
@end deffn

@geindex athrow() (método agen)
@anchor{reference/expressions agen athrow}@anchor{4f9}
@deffn {Método} async agen.athrow (value)

@deffnx {Método} async agen.athrow (type[, value[, traceback]])

Retorna um objeto aguardável que gera uma exceção do tipo @code{type} no ponto em que o gerador assíncrono foi pausado, e retorna o próximo valor produzido pela função geradora como o valor da exceção @ref{c15,,StopIteration} levantada. Se o gerador assíncrono terminar sem produzir outro valor, uma exceção @ref{1ba5,,StopAsyncIteration} é levantada pelo objeto aguardável. Se a função geradora não capturar a exceção passada ou gerar uma exceção diferente, então quando o objeto aguardável for executado, essa exceção se propagará para o chamador do objeto aguardável.


Alterado na versão 3.12: A segunda assinatura (tipo[, valor[, traceback]]) foi descontinuada e pode ser removida em uma versão futura do Python.

@end deffn

@geindex exceção;GeneratorExit

@geindex aclose() (método agen)
@anchor{reference/expressions agen aclose}@anchor{8de}
@deffn {Método} async agen.aclose ()

Retorna um objeto aguardável que, quando executado, levantará uma @ref{140e,,GeneratorExit} na função geradora assíncrona no ponto em que foi pausada. Se a função geradora assíncrona sair de forma normal, se estiver já estiver fechada ou levantar @ref{140e,,GeneratorExit} (não capturando a exceção), então o objeto aguardável retornado levantará uma exceção @ref{c15,,StopIteration}. Quaisquer outros objetos aguardáveis retornados por chamadas subsequentes à função geradora assíncrona levantarão uma exceção @ref{1ba5,,StopAsyncIteration}. Se a função geradora assíncrona levantar um valor, um @ref{195,,RuntimeError} será lançado pelo objeto aguardável. Se a função geradora assíncrona levantar qualquer outra exceção, ela será propagada para o chamador do objeto aguardável. Se a função geradora assíncrona já tiver saído devido a uma exceção ou saída normal, então chamadas posteriores ao método @ref{8de,,aclose()} retornarão um objeto aguardável que não faz nada.
@end deffn

@node Primárias,Expressão await,Átomos,Expressões
@anchor{reference/expressions id5}@anchor{21d7}@anchor{reference/expressions primaries}@anchor{21d8}
@subsection Primárias


@geindex primário

Primárias representam as operações mais fortemente vinculadas da linguagem. Sua sintaxe é:

@example
@anchor{reference/expressions grammar-token-python-grammar-primary}@anchor{21d9}primary ::= @ref{21a7,,atom} | @ref{21da,,attributeref} | @ref{21db,,subscription} | @ref{21dc,,slicing} | @ref{21dd,,call}
@end example

@menu
* Referências de atributo:: 
* Subscrições:: 
* Fatiamentos:: 
* Chamadas:: 

@end menu

@node Referências de atributo,Subscrições,,Primárias
@anchor{reference/expressions attribute-references}@anchor{21de}@anchor{reference/expressions id6}@anchor{21df}
@subsubsection Referências de atributo


@geindex atributo;referência
@geindex . (ponto);referência de atributo

Uma referência de atributo é um primário seguido de um ponto e um nome.

@example
@anchor{reference/expressions grammar-token-python-grammar-attributeref}@anchor{21da}attributeref ::= @ref{21d9,,primary} "." @ref{2023,,identifier}
@end example

@geindex exceção;AttributeError
@geindex objeto;módulo
@geindex objeto;lista

A primária deve avaliar para um objeto de um tipo que tem suporte a referências de atributo, o que a maioria dos objetos faz. Este objeto é então solicitado a produzir o atributo cujo nome é o identificador. O tipo e o valor produzido são determinados pelo objeto. Várias avaliações da mesma referência de atributo podem produzir diferentes objetos.

Esta produção pode ser personalizada substituindo o método @ref{beb,,__getattribute__()} ou o método @ref{4d3,,__getattr__()}. O método @code{__getattribute__()} é chamado primeiro e retorna um valor ou levanta uma @ref{34b,,AttributeError} se o atributo não estiver disponível.

Se for levantada uma @ref{34b,,AttributeError} e o objeto tiver um método @code{__getattr__()}, esse método será chamado como alternativa.

@node Subscrições,Fatiamentos,Referências de atributo,Primárias
@anchor{reference/expressions id7}@anchor{21e0}@anchor{reference/expressions subscriptions}@anchor{2110}
@subsubsection Subscrições


@geindex subscrição
@geindex [] (colchetes);subscrição

@geindex objeto;sequência
@geindex objeto;mapeamento
@geindex objeto;string
@geindex objeto;tupla
@geindex objeto;lista
@geindex objeto;dicionário
@geindex sequência;item

A subscrição de uma instância de uma classe de @ref{2116,,classe de contêiner} geralmente selecionará um elemento do contêiner. A subscrição de uma @ref{439,,classe genérica} geralmente retornará um objeto @ref{6b2,,GenericAlias}.

@example
@anchor{reference/expressions grammar-token-python-grammar-subscription}@anchor{21db}subscription ::= @ref{21d9,,primary} "[" @ref{21c1,,flexible_expression_list} "]"
@end example

Quando um objeto é subscrito, o interpretador avaliará o primário e a lista de expressões.

O primário deve ser avaliado como um objeto que dê suporte à subscrição. Um objeto pode prover suporte a subscrição através da definição de um ou ambos @ref{283,,__getitem__()} e @ref{73b,,__class_getitem__()}. Quando o primário é subscrito, o resultado avaliado da lista de expressões será passado para um desses métodos. Para mais detalhes sobre quando @code{__class_getitem__} é chamado em vez de @code{__getitem__}, veja @ref{210f,,__class_getitem__ versus __getitem__}.

Se a lista de expressões contiver pelo menos uma vírgula ou  se alguma das expressões for estrelada, ela será avaliada como uma @ref{370,,tuple} contendo os itens da lista de expressões. Caso contrário, a lista de expressões será avaliada como o valor do único membro da lista.


Alterado na versão 3.11: Expressões em uma lista de expressões podem ser estreladas. Veja a 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


Para objetos embutido, existem dois tipos de objetos que oferecem suporte a subscrição via @ref{283,,__getitem__()}:


@enumerate 

@item 
Mapeamentos. Se o primário for um @ref{11fb,,mapeamento}, a lista de expressões deve ser avaliada como um objeto cujo valor é uma das chaves do mapeamento, e a subscrição seleciona o valor no mapeamento que corresponde a essa chave. Um exemplo de classe de mapeamento integrada é a classe @ref{256,,dict}.

@item 
Sequências. Se o primário for uma @ref{4f1,,sequência}, a lista de expressões deve ser avaliada como @ref{257,,int} ou @ref{469,,slice} (conforme discutido na seção seguinte). Exemplos de classes de sequência embutidas incluem as classes @ref{44c,,str}, @ref{611,,list} e @ref{370,,tuple}.
@end enumerate

A sintaxe formal não faz nenhuma provisão especial para índices negativos em @ref{4f1,,sequências}. No entanto, todas as sequências embutidas fornecem um método @ref{283,,__getitem__()} que interpreta índices negativos adicionando o comprimento da sequência ao índice para que, por exemplo, @code{x[-1]} selecione o último item de @code{x}. O valor resultante deve ser um número inteiro não negativo menor que o número de itens na sequência, e a subscrição seleciona o item cujo índice é esse valor (contando a partir de zero). Como o suporte para índices negativos e fatiamento ocorre no método @ref{283,,__getitem__()} do objeto, as subclasses que substituem esse método precisarão adicionar explicitamente esse suporte.

@geindex caractere
@geindex string;item

Uma @ref{44c,,string} é um tipo especial de sequência cujos itens são `caracteres'. Um caractere não é um tipo de dados separado, mas uma string de exatamente um caractere.

@node Fatiamentos,Chamadas,Subscrições,Primárias
@anchor{reference/expressions id8}@anchor{21e1}@anchor{reference/expressions slicings}@anchor{21e2}
@subsubsection Fatiamentos


@geindex fatiamento
@geindex fatia
@geindex ; (dois pontos);fatiamento
@geindex @comma{} (vírgula);fatiamento

@geindex objeto;sequência
@geindex objeto;string
@geindex objeto;tupla
@geindex objeto;lista

Um fatiamento seleciona um intervalo de itens em um objeto sequência (por exemplo, uma string, tupla ou lista). As fatias podem ser usadas como expressões ou como alvos em instruções de atribuição ou @ref{18a7,,del}. A sintaxe para um fatiamento:

@example
@anchor{reference/expressions grammar-token-python-grammar-slicing}@anchor{21dc}slicing      ::= @ref{21d9,,primary} "[" @ref{21e3,,slice_list} "]"
@anchor{reference/expressions grammar-token-python-grammar-slice_list}@anchor{21e3}slice_list   ::= @ref{21e4,,slice_item} ("," @ref{21e4,,slice_item})* [","]
@anchor{reference/expressions grammar-token-python-grammar-slice_item}@anchor{21e4}slice_item   ::= @ref{21c8,,expression} | @ref{21e5,,proper_slice}
@anchor{reference/expressions grammar-token-python-grammar-proper_slice}@anchor{21e5}proper_slice ::= [@ref{21e6,,lower_bound}] ":" [@ref{21e7,,upper_bound}] [ ":" [@ref{21e8,,stride}] ]
@anchor{reference/expressions grammar-token-python-grammar-lower_bound}@anchor{21e6}lower_bound  ::= @ref{21c8,,expression}
@anchor{reference/expressions grammar-token-python-grammar-upper_bound}@anchor{21e7}upper_bound  ::= @ref{21c8,,expression}
@anchor{reference/expressions grammar-token-python-grammar-stride}@anchor{21e8}stride       ::= @ref{21c8,,expression}
@end example

Há ambiguidade na sintaxe formal aqui: qualquer coisa que se pareça com uma lista de expressões também se parece com uma lista de fatias, portanto qualquer subscrição pode ser interpretada como um fatiamento. Em vez de complicar ainda mais a sintaxe, isso é eliminado pela definição de que, neste caso, a interpretação como uma subscrição tem prioridade sobre a interpretação como um fatiamento (este é o caso se a lista de fatias não contiver uma fatia adequada).

@geindex start (atributo de objeto fatia)
@geindex stop (atributo de objeto fatia)
@geindex step (atributo de objeto fatia)

A semântica para um fatiamento é a seguinte. O primário é indexado (usando o mesmo método @ref{283,,__getitem__()} da subscrição normal) com uma chave que é construída a partir da lista de fatias, como segue. Se a lista de fatias contiver pelo menos uma vírgula, a chave será uma tupla contendo a conversão dos itens da fatia; caso contrário, a conversão do item de fatia isolada é a chave. A conversão de um item de fatia que é uma expressão é essa expressão. A conversão de uma fatia adequada é um objeto fatia (veja a seção @ref{2075,,A hierarquia de tipos padrão}) cujos @ref{20e8,,start}, @ref{20e9,,stop} e @ref{20ea,,step} atributos são os valores das expressões fornecidas como limite inferior, limite superior e passo, respectivamente, substituindo @code{None} pelas expressões ausentes.

@geindex objeto;chamável
@geindex chamada
@geindex argumento;semântica de chamadas
@geindex () (parênteses);chamada
@geindex @comma{} (vírgula);lista de argumentos
@geindex = (igual);em chamadas de função

@node Chamadas,,Fatiamentos,Primárias
@anchor{reference/expressions calls}@anchor{da5}@anchor{reference/expressions id9}@anchor{21e9}
@subsubsection Chamadas


Uma chamada chama um objeto que é um chamável (por exemplo, uma @ref{21ea,,função}) com uma série possivelmente vazia de @ref{449,,argumentos}:

@example
@anchor{reference/expressions grammar-token-python-grammar-call}@anchor{21dd}call                 ::= @ref{21d9,,primary} "(" [@ref{21eb,,argument_list} [","] | @ref{21b8,,comprehension}] ")"
@anchor{reference/expressions grammar-token-python-grammar-argument_list}@anchor{21eb}argument_list        ::= @ref{21ec,,positional_arguments} ["," @ref{21ed,,starred_and_keywords}]
                         ["," @ref{21ee,,keywords_arguments}]
                         | @ref{21ed,,starred_and_keywords} ["," @ref{21ee,,keywords_arguments}]
                         | @ref{21ee,,keywords_arguments}
@anchor{reference/expressions grammar-token-python-grammar-positional_arguments}@anchor{21ec}positional_arguments ::= @ref{21ef,,positional_item} ("," @ref{21ef,,positional_item})*
@anchor{reference/expressions grammar-token-python-grammar-positional_item}@anchor{21ef}positional_item      ::= @ref{21b9,,assignment_expression} | "*" @ref{21c8,,expression}
@anchor{reference/expressions grammar-token-python-grammar-starred_and_keywords}@anchor{21ed}starred_and_keywords ::= ("*" @ref{21c8,,expression} | @ref{21f0,,keyword_item})
                         ("," "*" @ref{21c8,,expression} | "," @ref{21f0,,keyword_item})*
@anchor{reference/expressions grammar-token-python-grammar-keywords_arguments}@anchor{21ee}keywords_arguments   ::= (@ref{21f0,,keyword_item} | "**" @ref{21c8,,expression})
                         ("," @ref{21f0,,keyword_item} | "," "**" @ref{21c8,,expression})*
@anchor{reference/expressions grammar-token-python-grammar-keyword_item}@anchor{21f0}keyword_item         ::= @ref{2023,,identifier} "=" @ref{21c8,,expression}
@end example

Uma vírgula final opcional pode estar presente após os argumentos posicionais e nomeados, mas não afeta a semântica.

@geindex parâmetro;semântica de chamadas

O primário deve ser avaliado como um objeto que pode ser chamado (funções definidas pelo usuário, funções embutidas, métodos de objetos embutidos, objetos de classe, métodos de instâncias de classe e todos os objetos que possuem um método @ref{558,,__call__()} são chamáveis). Todas as expressões de argumento são avaliadas antes da tentativa de chamada. Consulte a seção @ref{1db6,,Definições de função} para a sintaxe das listas formais de @ref{208f,,parâmetros}.

@c XXX update with kwonly args PEP

Se houver argumentos nomeados, eles serão primeiro convertidos em argumentos posicionais, como segue. Primeiro, é criada uma lista de slots não preenchidos para os parâmetros formais. Se houver N argumentos posicionais, eles serão colocados nos primeiros N slots. A seguir, para cada argumento nomeado, o identificador é usado para determinar o slot correspondente (se o identificador for igual ao primeiro nome formal do parâmetro, o primeiro slot será usado e assim por diante). Se o slot já estiver preenchido, uma exceção @ref{2c3,,TypeError} será levantada. Caso contrário, o argumento é colocado no slot, preenchendo-o (mesmo que a expressão seja @code{None}, ela preenche o slot). Quando todos os argumentos forem processados, os slots ainda não preenchidos serão preenchidos com o valor padrão correspondente da definição da função. (Os valores padrão são calculados, uma vez, quando a função é definida; assim, um objeto mutável, como uma lista ou dicionário usado como valor padrão, será compartilhado por todas as chamadas que não especificam um valor de argumento para o slot correspondente; isso deve geralmente ser evitado.) Se houver algum slot não preenchido para o qual nenhum valor padrão for especificado, uma exceção @ref{2c3,,TypeError} será levantada. Caso contrário, a lista de slots preenchidos será usada como lista de argumentos para a chamada.

Uma implementação pode fornecer funções integradas cujos parâmetros posicionais não possuem nomes, mesmo que sejam ‘nomeados’ para fins de documentação e que, portanto, não possam ser fornecidos por nomes. No CPython, este é o caso de funções implementadas em C que usam @ref{571,,PyArg_ParseTuple()} para analisar seus argumentos.

Se houver mais argumentos posicionais do que slots de parâmetros formais, uma exceção @ref{2c3,,TypeError} será levantada, a menos que um parâmetro formal usando a sintaxe @code{*identificador} esteja presente; neste caso, esse parâmetro formal recebe uma tupla contendo os argumentos posicionais em excesso (ou uma tupla vazia se não houver argumentos posicionais em excesso).

Se algum argumento nomeado não corresponder a um nome de parâmetro formal, uma exceção @ref{2c3,,TypeError} é levantada, a menos que um parâmetro formal usando a sintaxe @code{**identificador} esteja presente; neste caso, esse parâmetro formal recebe um dicionário contendo os argumentos nomeados em excesso (usando os nomes como chaves e os valores dos argumentos como valores correspondentes), ou um (novo) dicionário vazio se não houver argumentos nomeados em excesso.

@geindex * (asterisco);em chamadas de função
@geindex desempacotamento;em chamadas de função

Se a sintaxe @code{*expressão} aparecer na chamada da função, @code{expressão} deverá ser avaliada como @ref{1268,,iterável}. Os elementos desses iteráveis são tratados como se fossem argumentos posicionais adicionais. Para a chamada @code{f(x1, x2, *y, x3, x4)}, se `y' for avaliado como uma sequência `y1', …, `yM', isso é equivalente a uma chamada com M+4 argumentos posicionais `x1', `x2', `y1', …, `yM', `x3', `x4'.

Uma consequência disso é que embora a sintaxe @code{*expressão} possa aparecer `depois' de argumentos nomeados explícitos, ela é processada `antes' dos argumentos nomeados (e de quaisquer argumentos de @code{**expressão} – veja abaixo). Então:

@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

É incomum que ambos os argumentos nomeados e a sintaxe @code{*expressão} sejam usados na mesma chamada, portanto, na prática, essa confusão não surge com frequência.

@geindex **;em chamadas de função

Se a sintaxe @code{**expressão} aparecer na chamada de função, @code{expressão} deve ser avaliada como um @ref{11fb,,mapeamento}, cujo conteúdo é tratado como argumentos nomeados adicionais. Se um parâmetro que corresponde a uma chave já recebeu um valor (por um argumento nomeado explícito ou de outro desempacotamento), uma exceção @ref{2c3,,TypeError} é levantada.

Quando @code{**expressão} é usada, cada chave neste mapeamento deve ser uma string. Cada valor do mapeamento é atribuído ao primeiro parâmetro formal elegível para atribuição de nomeas cujo nome é igual à chave. Uma chave não precisa ser um identificador Python (por exemplo, @code{"max-temp °F"} é aceitável, embora não corresponda a nenhum parâmetro formal que possa ser declarado). Se não houver correspondência com um parâmetro formal, o par chave-valor é coletado pelo parâmetro @code{**}, se houver, ou se não houver, uma exceção @ref{2c3,,TypeError} é levantada.

Parâmetros formais usando a sintaxe @code{*identificador} ou @code{**identificador} não podem ser usados como slots de argumentos posicionais ou como nomes de argumentos nomeados.


Alterado na versão 3.5: Chamadas de função aceitam qualquer número de desempacotamentos @code{*} e @code{**}, argumentos posicionais podem seguir desempacotamentos iteráveis (@code{*}) e argumentos nomeados podem seguir desempacotamentos de dicionário (@code{**}). Originalmente proposto pela 
@geindex Propostas de Melhorias do Python; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/}.


Uma chamada sempre retorna algum valor, possivelmente @code{None}, a menos que levanta uma exceção. A forma como esse valor é calculado depende do tipo do objeto chamável.

Se for…


@table @asis

@item uma função definida por usuário:

@geindex função;chamada
@geindex definida por usuário;função;chamada
@geindex objeto;função definida por usuário
@geindex objeto;função

O bloco de código da função é executado, passando-lhe a lista de argumentos. A primeira coisa que o bloco de código fará é vincular os parâmetros formais aos argumentos; isso é descrito na seção @ref{1db6,,Definições de função}. Quando o bloco de código executa uma instrução @ref{9d6,,return}, isso especifica o valor de retorno da chamada de função. Se a execução atingir o final do bloco de código sem executar uma instrução @ref{9d6,,return}, o valor de retorno será @code{None}.

@item um método embutido ou uma função embutida:

@geindex função;chamada
@geindex função embutida;chamada
@geindex método;chamada
@geindex método embutido;chamada
@geindex objeto;método embutido
@geindex objeto;função embutida
@geindex objeto;método
@geindex objeto;função

O resultado fica por conta do interpretador; veja @ref{129e,,Funções embutidas} para descrições de funções embutidas e métodos embutidos.

@item um objeto classe:

@geindex objeto;classe
@geindex objeto classe;chamada

Uma nova instância dessa classe é retornada.

@item um método de instância de classe:

@geindex objeto;instância de classe
@geindex objeto;instância
@geindex instância de classe;chamada

A função correspondente definida pelo usuário é chamada, com uma lista de argumentos que é maior que a lista de argumentos da chamada: a instância se torna o primeiro argumento.

@item uma instância de classe:

@geindex instância;chamada
@geindex __call__() (método objeto)

A classe deve definir um método @ref{558,,__call__()}; o efeito é então o mesmo como se esse método fosse chamado.
@end table

@geindex palavra reservada;await

@node Expressão await,O operador de potência,Primárias,Expressões
@anchor{reference/expressions await}@anchor{1b9}@anchor{reference/expressions await-expression}@anchor{21f1}
@subsection Expressão await


Suspende a execução de @ref{491,,corrotina} em um objeto @ref{1ad,,aguardável}. Só pode ser usado dentro de uma @ref{d9b,,função de corrotina}.

@example
@anchor{reference/expressions grammar-token-python-grammar-await_expr}@anchor{21f2}await_expr ::= "await" @ref{21d9,,primary}
@end example


Adicionado na versão 3.5.


@node O operador de potência,Operações aritméticas unárias e bit a bit,Expressão await,Expressões
@anchor{reference/expressions power}@anchor{21f3}@anchor{reference/expressions the-power-operator}@anchor{21f4}
@subsection O operador de potência


@geindex potência;operação
@geindex operador;**

O operador de potência vincula-se com mais força do que os operadores unários à sua esquerda; ele se vincula com menos força do que os operadores unários à sua direita. A sintaxe é:

@example
@anchor{reference/expressions grammar-token-python-grammar-power}@anchor{21f5}power ::= (@ref{21f2,,await_expr} | @ref{21d9,,primary}) ["**" @ref{21f6,,u_expr}]
@end example

Assim, em uma sequência sem parênteses de operadores de potência e unários, os operadores são avaliados da direita para a esquerda (isso não restringe a ordem de avaliação dos operandos): @code{-1**2} resulta em @code{-1} .

O operador de potência tem a mesma semântica que a função embutida @ref{9da,,pow()}, quando chamado com dois argumentos: ele produz seu argumento esquerdo elevado à potência de seu argumento direito. Os argumentos numéricos são primeiro convertidos em um tipo comum e o resultado é desse tipo.

Para operandos int, o resultado tem o mesmo tipo que os operandos, a menos que o segundo argumento seja negativo; nesse caso, todos os argumentos são convertidos em ponto flutuante e um resultado ponto flutuante é entregue. Por exemplo, @code{10**2} retorna @code{100}, mas @code{10**-2} retorna @code{0.01}.

Elevar @code{0.0} a uma potência negativa resulta em uma exceção @ref{94c,,ZeroDivisionError}. Elevar um número negativo a uma potência fracionária resulta em um número @ref{2f8,,complex}. (Em versões anteriores, levantava @ref{202,,ValueError}.)

Esta operação pode ser personalizada usando os métodos especial @ref{7d4,,__pow__()} e @ref{7d5,,__rpow__()}.

@node Operações aritméticas unárias e bit a bit,Operações binárias aritméticas,O operador de potência,Expressões
@anchor{reference/expressions unary}@anchor{21f7}@anchor{reference/expressions unary-arithmetic-and-bitwise-operations}@anchor{21f8}
@subsection Operações aritméticas unárias e bit a bit


@geindex unária;aritmética;operação
@geindex unária;bit a bit;operação

Todas as operações aritméticas unárias e bit a bit têm a mesma prioridade:

@example
@anchor{reference/expressions grammar-token-python-grammar-u_expr}@anchor{21f6}u_expr ::= @ref{21f5,,power} | "-" @ref{21f6,,u_expr} | "+" @ref{21f6,,u_expr} | "~" @ref{21f6,,u_expr}
@end example

@geindex negação
@geindex menos
@geindex operador;- (menos)
@geindex - (menos);operador unário

O operador unário @code{-} (menos) produz a negação de seu argumento numérico; a operação pode ser substituída pelo método especial @ref{2144,,__neg__()}.

@geindex mais
@geindex operador;+ (mais)
@geindex + (mais);operador unário

O operador unário @code{+} (mais) produz seu argumento numérico inalterado; a operação pode ser substituída pelo método especial @ref{2145,,__pos__()}.

@geindex inversão
@geindex operador;~ (til)

O operador unário @code{~} (inverter) produz a inversão bit a bit de seu argumento inteiro. A inversão bit a bit de @code{x} é definida como @code{-(x+1)}. Aplica-se apenas a números inteiros ou a objetos personalizados que substituem o método especial @ref{2147,,__invert__()}.

@geindex exceção;TypeError

Em todos os três casos, se o argumento não tiver o tipo adequado, uma exceção @ref{2c3,,TypeError} é levantada.

@node Operações binárias aritméticas,Operações de deslocamento,Operações aritméticas unárias e bit a bit,Expressões
@anchor{reference/expressions binary}@anchor{21f9}@anchor{reference/expressions binary-arithmetic-operations}@anchor{21fa}
@subsection Operações binárias aritméticas


@geindex binário;aritmética;operação

As operações aritméticas binárias possuem os níveis de prioridade convencionais. Observe que algumas dessas operações também se aplicam a determinados tipos não numéricos. Além do operador potência, existem apenas dois níveis, um para operadores multiplicativos e outro para operadores aditivos:

@example
@anchor{reference/expressions grammar-token-python-grammar-m_expr}@anchor{21fb}m_expr ::= @ref{21f6,,u_expr} | @ref{21fb,,m_expr} "*" @ref{21f6,,u_expr} | @ref{21fb,,m_expr} "@@" @ref{21fb,,m_expr} |
           @ref{21fb,,m_expr} "//" @ref{21f6,,u_expr} | @ref{21fb,,m_expr} "/" @ref{21f6,,u_expr} |
           @ref{21fb,,m_expr} "%" @ref{21f6,,u_expr}
@anchor{reference/expressions grammar-token-python-grammar-a_expr}@anchor{21fc}a_expr ::= @ref{21fb,,m_expr} | @ref{21fc,,a_expr} "+" @ref{21fb,,m_expr} | @ref{21fc,,a_expr} "-" @ref{21fb,,m_expr}
@end example

@geindex multiplicação
@geindex operador;* (asterisco)

O operador @code{*} (multiplicação) produz o produto de seus argumentos. Os argumentos devem ser números ou um argumento deve ser um número inteiro e o outro deve ser uma sequência. No primeiro caso, os números são convertidos para um tipo comum e depois multiplicados. Neste último caso, é realizada a repetição da sequência; um fator de repetição negativo produz uma sequência vazia.

Esta operação pode ser personalizada usando os métodos especial @ref{2124,,__mul__()} e @ref{2125,,__rmul__()}.

@geindex multiplicação de matrizes
@geindex operador;@@ (arroba)

O operador @code{@@} (arroba) deve ser usado para multiplicação de matrizes. Nenhum tipo embutido do Python implementa este operador.

Esta operação pode ser personalizada usando os métodos especial @ref{da1,,__matmul__()} e @ref{da2,,__rmatmul__()}.


Adicionado na versão 3.5.


@geindex exceção;ZeroDivisionError
@geindex divisão
@geindex operador;/ (barra)
@geindex operador;//

Os operadores @code{/} (divisão) e @code{//} (divisão pelo piso) produzem o quociente de seus argumentos. Os argumentos numéricos são primeiro convertidos em um tipo comum. A divisão de inteiros produz um ponto flutuante, enquanto a divisão pelo piso de inteiros resulta em um inteiro; o resultado é o da divisão matemática com a função ‘floor’ aplicada ao resultado. A divisão por zero levanta a exceção @ref{94c,,ZeroDivisionError}.

A operação de divisão pode ser personalizada usando os métodos especiais @ref{ebf,,__truediv__()} e @ref{2132,,__rtruediv__()}. A operação de divisão pelo piso pode ser personalizada usando os métodos especiais @ref{153c,,__floordiv__()} e @ref{2133,,__rfloordiv__()}.

@geindex módulo
@geindex operador;% (porcentagem)

O operador @code{%} (módulo) produz o restante da divisão do primeiro argumento pelo segundo. Os argumentos numéricos são primeiro convertidos em um tipo comum. Um argumento zero à direita levanta a exceção @ref{94c,,ZeroDivisionError}. Os argumentos podem ser números de ponto flutuante, por exemplo, @code{3.14%0.7} é igual a @code{0.34} (já que @code{3.14} é igual a @code{4*0.7 + 0.34}.) O operador módulo sempre produz um resultado com o mesmo sinal do seu segundo operando (ou zero); o valor absoluto do resultado é estritamente menor que o valor absoluto do segundo operando @footnote{
Embora @code{abs(x%y) < abs(y)} seja verdadeiro matematicamente, para números flutuantes pode não ser verdadeiro numericamente devido ao arredondamento. Por exemplo, e presumindo uma plataforma na qual um float Python seja um número de precisão dupla IEEE 754, para que @code{-1e-100 % 1e100} tenha o mesmo sinal que @code{1e100}, o resultado calculado é @code{-1e-100 + 1e100}, que é numericamente exatamente igual a @code{1e100}. A função @ref{21fd,,math.fmod()} retorna um resultado cujo sinal corresponde ao sinal do primeiro argumento e, portanto, retorna @code{-1e-100} neste caso. Qual abordagem é mais apropriada depende da aplicação.
}.

Os operadores de divisão pelo piso e módulo são conectados pela seguinte identidade: @code{x == (x//y)*y + (x%y)}. A divisão pelo piso e o módulo também estão conectados com a função embutida @ref{9a9,,divmod()}: @code{divmod(x, y) == (x//y, x%y)}. @footnote{
Se x estiver muito próximo de um múltiplo inteiro exato de y, é possível que @code{x//y} seja maior que @code{(x-x%y)//y} devido ao arredondamento. Nesses casos, Python retorna o último resultado, para preservar que @code{divmod(x,y)[0] * y + x % y} esteja muito próximo de @code{x}.
}.

Além de realizar a operação de módulo em números, o operador @code{%} também é sobrecarregado por objetos string para realizar a formatação de string no estilo antigo (também conhecida como interpolação). A sintaxe para formatação de string é descrita na Referência da Biblioteca Python, seção @ref{6cc,,Formatação de string no estilo printf}.

A operação `módulo' pode ser personalizada usando os métodos especial @ref{212b,,__mod__()} e @ref{dff,,__rmod__()}.

O operador de divisão pelo piso, o operador de módulo e a função @ref{9a9,,divmod()} não são definidos para números complexos. Em vez disso, converta para um número de ponto flutuante usando a função @ref{1e2d,,abs()} se apropriado.

@geindex adição
@geindex operador;+ (mais)
@geindex + (mais);operador binário

O operador @code{+} (adição) produz a soma de seus argumentos. Os argumentos devem ser números ou sequências do mesmo tipo. No primeiro caso, os números são convertidos para um tipo comum e depois somados. Neste último caso, as sequências são concatenadas.

Esta operação pode ser personalizada usando os métodos especial @ref{2121,,__add__()} e @ref{2122,,__radd__()}.

@geindex substração
@geindex operador;- (menos)
@geindex - (menos);operador binário

O operador @code{-} (subtração) produz a diferença de seus argumentos. Os argumentos numéricos são primeiro convertidos em um tipo comum.

Esta operação pode ser personalizada usando os métodos especial @ref{212a,,__sub__()} e @ref{2131,,__rsub__()}.

@node Operações de deslocamento,Operações binárias bit a bit,Operações binárias aritméticas,Expressões
@anchor{reference/expressions shifting}@anchor{21fe}@anchor{reference/expressions shifting-operations}@anchor{21ff}
@subsection Operações de deslocamento


@geindex deslocamento;operação
@geindex operador;<<
@geindex operador;>>

As operações de deslocamento têm menor prioridade que as operações aritméticas:

@example
@anchor{reference/expressions grammar-token-python-grammar-shift_expr}@anchor{2200}shift_expr ::= @ref{21fc,,a_expr} | @ref{2200,,shift_expr} ("<<" | ">>") @ref{21fc,,a_expr}
@end example

Esses operadores aceitam números inteiros como argumentos. Eles deslocam o primeiro argumento para a esquerda ou para a direita pelo número de bits fornecido pelo segundo argumento.

A operação de deslocamento à esquerda pode ser personalizada usando os métodos especiais @ref{212c,,__lshift__()} e @ref{2135,,__rlshift__()}. A operação de deslocamento à direita pode ser personalizada usando os métodos especiais @ref{212d,,__rshift__()} e @ref{2136,,__rrshift__()}.

@geindex exceção;ValueError

Um deslocamento para a direita de `n' bits é definido como a divisão pelo piso por @code{pow(2,n)}. Um deslocamento à esquerda de `n' bits é definido como a multiplicação por @code{pow(2,n)}.

@node Operações binárias bit a bit,Comparações,Operações de deslocamento,Expressões
@anchor{reference/expressions binary-bitwise-operations}@anchor{2201}@anchor{reference/expressions bitwise}@anchor{2202}
@subsection Operações binárias bit a bit


@geindex binário;bit a bit;operação

Cada uma das três operações bit a bit tem um nível de prioridade diferente:

@example
@anchor{reference/expressions grammar-token-python-grammar-and_expr}@anchor{2203}and_expr ::= @ref{2200,,shift_expr} | @ref{2203,,and_expr} "&" @ref{2200,,shift_expr}
@anchor{reference/expressions grammar-token-python-grammar-xor_expr}@anchor{2204}xor_expr ::= @ref{2203,,and_expr} | @ref{2204,,xor_expr} "^" @ref{2203,,and_expr}
@anchor{reference/expressions grammar-token-python-grammar-or_expr}@anchor{2050}or_expr  ::= @ref{2204,,xor_expr} | @ref{2050,,or_expr} "|" @ref{2204,,xor_expr}
@end example

@geindex bit a bit;and
@geindex operador;& (e comercial)

O operador @code{&} produz o E (AND) bit a bit de seus argumentos, que devem ser inteiros ou um deles deve ser um objeto personalizado substituindo os métodos especiais @ref{212e,,__and__()} ou @ref{2137,,__rand__()}.

@geindex bit a bit;xor
@geindex exclusivo;or
@geindex operador;^ (circunflexo)

O operador @code{^} produz o XOR bit a bit (OU exclusivo) de seus argumentos, que devem ser inteiros ou um deles deve ser um objeto personalizado sobrescrevendo os métodos especiais @ref{212f,,__xor__()} ou @ref{2138,,__rxor__()}.

@geindex bit a bit;or
@geindex inclusive;or
@geindex operador;| (barra vertical)

O operador @code{|} produz o OU (OR) bit a bit de seus argumentos, que devem ser inteiros ou um deles deve ser um objeto personalizado sobrescrevendo os métodos especiais @ref{2130,,__or__()} ou @ref{2139,,__ror__()}.

@node Comparações,Operações booleanas,Operações binárias bit a bit,Expressões
@anchor{reference/expressions comparisons}@anchor{2205}@anchor{reference/expressions id12}@anchor{2206}
@subsection Comparações


@geindex comparação
@geindex C;linguagem
@geindex operador;< (menor que)
@geindex operador;> (maior)
@geindex operador;<=
@geindex operador;>=
@geindex operador;==
@geindex operador;!=

Ao contrário de C, todas as operações de comparação em Python têm a mesma prioridade, que é menor do que qualquer operação aritmética, de deslocamento ou bit a bit. Também diferentemente de C, expressões como @code{a < b < c} têm a interpretação que é convencional em matemática:

@example
@anchor{reference/expressions grammar-token-python-grammar-comparison}@anchor{2207}comparison    ::= @ref{2050,,or_expr} (@ref{2208,,comp_operator} @ref{2050,,or_expr})*
@anchor{reference/expressions grammar-token-python-grammar-comp_operator}@anchor{2208}comp_operator ::= "<" | ">" | "==" | ">=" | "<=" | "!="
                  | "is" ["not"] | ["not"] "in"
@end example

Comparações produzem valores booleanos: @code{True} ou @code{False}. `métodos de comparação rica' personalizados podem retornar valores não booleanos. Neste caso, o Python chamará @ref{468,,bool()} nesse valor em contextos booleanos.

@geindex encadeamento;comparações

As comparações podem ser encadeadas arbitrariamente, por exemplo, @code{x < y <= z} é equivalente a @code{x < y and y <= z}, exceto que @code{y} é avaliado apenas uma vez (mas em ambos os casos @code{z} não é avaliado quando @code{x < y} é considerado falso).

Formalmente, se `a', `b', `c', …, `y', `z' são expressões e `op1', `op2', …, `opN' são operadores de comparação, então @code{a op1 b op2 c ... y opN z} é equivalente a @code{a op1 b e b op2 c e ... y opN z}, exceto que cada expressão é avaliada no máximo uma vez.

Observe que @code{a op1 b op2 c} não implica qualquer tipo de comparação entre `a' e `c', de modo que, por exemplo, @code{x < y > z} é perfeitamente válido (embora talvez não seja bonito).

@menu
* Comparações de valor:: 
* Operações de teste de pertinência:: 
* Comparações de identidade:: 

@end menu

@node Comparações de valor,Operações de teste de pertinência,,Comparações
@anchor{reference/expressions expressions-value-comparisons}@anchor{19a9}@anchor{reference/expressions value-comparisons}@anchor{2209}
@subsubsection Comparações de valor


Os operadores @code{<}, @code{>}, @code{==}, @code{>=}, @code{<=} e @code{!=} comparam os valores de dois objetos. Os objetos não precisam ser do mesmo tipo.

O capítulo @ref{2072,,Objetos@comma{} valores e tipos} afirma que os objetos possuem um valor (além do tipo e da identidade). O valor de um objeto é uma noção bastante abstrata em Python: por exemplo, não existe um método de acesso canônico para o valor de um objeto. Além disso, não há exigência de que o valor de um objeto seja construído de uma maneira específica, por exemplo. composto por todos os seus atributos de dados. Os operadores de comparação implementam uma noção específica de qual é o valor de um objeto. Pode-se pensar neles como definindo o valor de um objeto indiretamente, por meio de sua implementação de comparação.

Como todos os tipos são subtipos (diretos ou indiretos) de @ref{a96,,object}, eles herdam o comportamento de comparação padrão de @ref{a96,,object}. Os tipos podem personalizar seu comportamento de comparação implementando `métodos de comparação rica' como @ref{12e2,,__lt__()}, descrito em @ref{20ef,,Personalização básica}.

O comportamento padrão para comparação de igualdade (@code{==} e @code{!=}) é baseado na identidade dos objetos. Consequentemente, a comparação da igualdade de instâncias com a mesma identidade resulta em igualdade, e a comparação da igualdade de instâncias com identidades diferentes resulta em desigualdade. Uma motivação para este comportamento padrão é o desejo de que todos os objetos sejam reflexivos (ou seja, @code{x is y} implica @code{x == y}).

Uma comparação de ordem padrão (@code{<}, @code{>}, @code{<=} e @code{>=}) não é fornecida; uma tentativa levanta @ref{2c3,,TypeError}. Uma motivação para este comportamento padrão é a falta de um invariante semelhante ao da igualdade.

O comportamento da comparação de igualdade padrão, de que instâncias com identidades diferentes são sempre desiguais, pode contrastar com o que os tipos precisarão ter uma definição sensata de valor de objeto e igualdade baseada em valor. Esses tipos precisarão personalizar seu comportamento de comparação e, de fato, vários tipos embutidos fizeram isso.

A lista a seguir descreve o comportamento de comparação dos tipos embutidos mais importantes.


@itemize *

@item 
Números de tipos numéricos embutidos (@ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}) e dos tipos de biblioteca padrão @ref{1e7,,fractions.Fraction} e @ref{29d,,decimal.Decimal} podem ser comparados dentro e entre seus tipos, com a restrição que os números complexos não oferecem suporte a comparação de ordens. Dentro dos limites dos tipos envolvidos, eles comparam matematicamente (algoritmicamente) corretos sem perda de precisão.

Os valores não numéricos @code{float('NaN')} e @code{decimal.Decimal('NaN')} são especiais. Qualquer comparação ordenada de um número com um valor que não é um número é falsa. Uma implicação contraintuitiva é que os valores que não são numéricos não são iguais a si mesmos. Por exemplo, se @code{x = float('NaN')}, @code{3 < x}, @code{x < 3} e @code{x == x} são todos falsos, enquanto @code{x != x} é verdadeiro. Esse comportamento é compatível com IEEE 754.

@item 
@code{None} e @ref{7d3,,NotImplemented} são singletons. 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} aconselha que comparações para singletons devem sempre ser feitas com @code{is} ou @code{is not}, nunca com os operadores de igualdade.

@item 
Sequências binárias (instâncias de @ref{1c2,,bytes} ou @ref{2ea,,bytearray}) podem ser comparadas dentro e entre seus tipos. Eles comparam lexicograficamente usando os valores numéricos de seus elementos.

@item 
Strings (instâncias de @ref{44c,,str}) são comparadas lexicograficamente usando os pontos de código Unicode numéricos (o resultado da função embutida @ref{2080,,ord()}) de seus caracteres. @footnote{
O padrão Unicode distingue entre `pontos de código' (por exemplo, U+0041) e `caracteres abstratos' (por exemplo, “LATIN CAPITAL LETTER A”). Embora a maioria dos caracteres abstratos em Unicode sejam representados apenas por meio de um ponto de código, há vários caracteres abstratos que também podem ser representados por meio de uma sequência de mais de um ponto de código. Por exemplo, o caractere abstrato “LATIN CAPITAL LETTER C WITH CEDILLA” pode ser representado como um único `caractere pré-composto' na posição de código U+00C7, ou como uma sequência de um `caractere base' na posição de código U+0043 (LATIN CAPITAL LETTER C), seguido por um `caractere de combinação' na posição de código U+0327 (COMBINING CEDILLA).

Os operadores de comparação em strings são comparados no nível dos pontos de código Unicode. Isso pode ser contraintuitivo para os humanos. Por exemplo, @code{"\u00C7" == "\u0043\u0327"} é @code{False}, mesmo que ambas as strings representem o mesmo caractere abstrato “LATIN CAPITAL LETTER C WITH CEDILLA”.

Para comparar strings no nível de caracteres abstratos (ou seja, de uma forma intuitiva para humanos), use @ref{6d5,,unicodedata.normalize()}.
}

Strings e sequências binárias não podem ser comparadas diretamente.

@item 
Sequências (instâncias de @ref{370,,tuple}, @ref{611,,list} ou @ref{94a,,range}) podem ser comparadas apenas dentro de cada um de seus tipos, com a restrição de que intervalos não oferecem suporte a comparação de ordem. A comparação de igualdade entre esses tipos resulta em desigualdade, e a comparação ordenada entre esses tipos levanta @ref{2c3,,TypeError}.

As sequências são comparadas lexicograficamente usando a comparação de elementos correspondentes. Os contêineres embutidos normalmente presumem que objetos idênticos são iguais a si mesmos. Isso permite ignorar testes de igualdade para objetos idênticos para melhorar o desempenho e manter seus invariantes internos.

A comparação lexicográfica entre coleções embutidas funciona da seguinte forma:


@itemize -

@item 
Para que duas coleções sejam comparadas iguais, elas devem ser do mesmo tipo, ter o mesmo comprimento e cada par de elementos correspondentes deve ser comparado igual (por exemplo, @code{[1,2] == (1,2)} é false porque o tipo não é o mesmo).

@item 
Coleções que oferecem suporte a comparação de ordem são ordenadas da mesma forma que seus primeiros elementos desiguais (por exemplo, @code{[1,2,x] <= [1,2,y]} tem o mesmo valor que @code{x <= y}). Se um elemento correspondente não existir, a coleção mais curta é ordenada primeiro (por exemplo, @code{[1,2] < [1,2,3]} é verdadeiro).
@end itemize

@item 
Mapeamentos (instâncias de @ref{256,,dict}) comparam iguais se e somente se eles tiverem pares @code{(chave, valor)} iguais. A comparação de igualdade das chaves e valores reforça a reflexividade.

Comparações de ordem (@code{<}, @code{>}, @code{<=} e @code{>=}) levantam @ref{2c3,,TypeError}.

@item 
Conjuntos (instâncias de @ref{5d9,,set} ou @ref{5da,,frozenset}) podem ser comparados dentro e entre seus tipos.

Eles definem operadores de comparação de ordem para significar testes de subconjunto e superconjunto. Essas relações não definem ordenações totais (por exemplo, os dois conjuntos @code{@{1,2@}} e @code{@{2,3@}} não são iguais, nem subconjuntos um do outro, nem superconjuntos um do outro). Consequentemente, conjuntos não são argumentos apropriados para funções que dependem de ordenação total (por exemplo, @ref{f3a,,min()}, @ref{f3b,,max()} e @ref{be7,,sorted()} produzem resultados indefinidos dada uma lista de conjuntos como entradas) .

A comparação de conjuntos reforça a reflexividade de seus elementos.

@item 
A maioria dos outros tipos embutidos não possui métodos de comparação implementados, portanto, eles herdam o comportamento de comparação padrão.
@end itemize

As classes definidas pelo usuário que personalizam seu comportamento de comparação devem seguir algumas regras de consistência, se possível:


@itemize *

@item 
A comparação da igualdade deve ser reflexiva. Em outras palavras, objetos idênticos devem ser comparados iguais:

@quotation

@code{x is y} implica em @code{x == y}
@end quotation

@item 
A comparação deve ser simétrica. Em outras palavras, as seguintes expressões devem ter o mesmo resultado:

@quotation

@code{x == y} e @code{y == x}

@code{x != y} e @code{y != x}

@code{x < y} e @code{y > x}

@code{x <= y} e @code{y >= x}
@end quotation

@item 
A comparação deve ser transitiva. Os seguintes exemplos (não exaustivos) ilustram isso:

@quotation

@code{x > y and y > z} implica em @code{x > z}

@code{x < y and y <= z} implica em @code{x < z}
@end quotation

@item 
A comparação inversa deve resultar na negação booleana. Em outras palavras, as seguintes expressões devem ter o mesmo resultado:

@quotation

@code{x == y} e @code{not x != y}

@code{x < y} e @code{not x >= y} (pra classificação total)

@code{x > y} e @code{not x <= y} (pra classificação total)
@end quotation

As duas últimas expressões aplicam-se a coleções totalmente ordenadas (por exemplo, a sequências, mas não a conjuntos ou mapeamentos). Veja também o decorador @ref{f75,,total_ordering()}.

@item 
O resultado @ref{5eb,,hash()} deve ser consistente com a igualdade. Objetos iguais devem ter o mesmo valor de hash ou ser marcados como não-hasheáveis.
@end itemize

Python não impõe essas regras de consistência. Na verdade, os valores não numéricos são um exemplo de não cumprimento dessas regras.
@anchor{reference/expressions in}@anchor{2f4}@anchor{reference/expressions not-in}@anchor{62f}
@node Operações de teste de pertinência,Comparações de identidade,Comparações de valor,Comparações
@anchor{reference/expressions membership-test-details}@anchor{2127}@anchor{reference/expressions membership-test-operations}@anchor{220a}
@subsubsection Operações de teste de pertinência


Os operadores @ref{2f4,,in} e @ref{62f,,not in} testam se um operando é membro ou não de outro. @code{x in s} é avaliado como @code{True} se `x' for membro de `s', e @code{False} caso contrário. @code{x not in s} retorna a negação de @code{x in s}. Todas as sequências e tipos de conjuntos embutidos oferecem suporte a isso, assim como o dicionário, para o qual @code{in} testa se o dicionário tem uma determinada chave. Para tipos de contêiner como list, tuple, set, frozenset, dict ou Collections.deque, a expressão @code{x in y} é equivalente a @code{any(x is e or x == e for e in y)}.

Para os tipos string e bytes, @code{x in y} é @code{True} se e somente se `x' for uma substring de `y'. Um teste equivalente é @code{y.find(x) != -1}. Strings vazias são sempre consideradas uma substring de qualquer outra string, então @code{"" in "abc"} retornará @code{True}.

Para classes definidas pelo usuário que definem o método @ref{1400,,__contains__()}, @code{x in y} retorna @code{True} se @code{y.__contains__(x)} retorna um valor verdadeiro, e @code{False} caso contrário.

Para classes definidas pelo usuário que não definem @ref{1400,,__contains__()}, mas definem @ref{c8a,,__iter__()}, @code{x in y} é @code{True} se algum valor @code{z}, para a qual a expressão @code{x is z or x == z} é verdadeira, é produzida durante a iteração sobre @code{y}. Se uma exceção for levantada durante a iteração, é como se @ref{2f4,,in} tivesse levantado essa exceção.

Por último, o protocolo de iteração de estilo antigo é tentado: se uma classe define @ref{283,,__getitem__()}, @code{x in y} é @code{True} se, e somente se, houver um índice inteiro não negativo `i' tal que @code{x is y[i] or x == y[i]}, e nenhum índice inteiro inferior levanta a exceção @ref{157e,,IndexError}. (Se qualquer outra exceção for levantada, é como se @ref{2f4,,in} levantasse essa exceção).

@geindex operador;in
@geindex operador;not in
@geindex pertinência;teste
@geindex objeto;sequência

O operador @ref{62f,,not in} é definido para ter o valor verdade inverso de @ref{2f4,,in}.

@geindex operador;is
@geindex operador;is not
@geindex identidade;teste
@anchor{reference/expressions is}@anchor{2f5}
@node Comparações de identidade,,Operações de teste de pertinência,Comparações
@anchor{reference/expressions identity-comparisons}@anchor{220b}@anchor{reference/expressions is-not}@anchor{220c}
@subsubsection Comparações de identidade


Os operadores @ref{2f5,,is} e @ref{220c,,is not} testam a identidade de um objeto: @code{x is y} é verdadeiro se, e somente se, `x' e `y' são o mesmo objeto. A identidade de um objeto é determinada usando a função @ref{146a,,id()}. @code{x is not y} produz o valor verdade inverso. @footnote{
Devido à coleta de lixo automática, às listas livres e à natureza dinâmica dos descritores, você pode notar um comportamento aparentemente incomum em certos usos do operador @ref{2f5,,is}, como aqueles que envolvem comparações entre métodos de instância ou constantes. Confira a documentação para obter mais informações.
}
@anchor{reference/expressions booleans}@anchor{220d}@anchor{reference/expressions and}@anchor{2f1}@anchor{reference/expressions or}@anchor{2f6}
@node Operações booleanas,Expressões de atribuição<2>,Comparações,Expressões
@anchor{reference/expressions boolean-operations}@anchor{220e}@anchor{reference/expressions not}@anchor{220f}
@subsection Operações booleanas


@geindex Condicional;expressão
@geindex Booleano;operação

@example
@anchor{reference/expressions grammar-token-python-grammar-or_test}@anchor{21bc}or_test  ::= @ref{2210,,and_test} | @ref{21bc,,or_test} "or" @ref{2210,,and_test}
@anchor{reference/expressions grammar-token-python-grammar-and_test}@anchor{2210}and_test ::= @ref{2211,,not_test} | @ref{2210,,and_test} "and" @ref{2211,,not_test}
@anchor{reference/expressions grammar-token-python-grammar-not_test}@anchor{2211}not_test ::= @ref{2207,,comparison} | "not" @ref{2211,,not_test}
@end example

No contexto de operações booleanas, e também quando expressões são usadas por instruções de fluxo de controle, os seguintes valores são interpretados como falsos: @code{False}, @code{None}, zero numérico de todos os tipos e strings e contêineres vazios (incluindo strings, tuplas, listas, dicionários, conjuntos e frozensets). Todos os outros valores são interpretados como verdadeiros. Objetos definidos pelo usuário podem personalizar seu valor verdade fornecendo um método @ref{1318,,__bool__()}.

@geindex operador;not

O operador @ref{220f,,not} produz @code{True} se seu argumento for falso, @code{False} caso contrário.

@geindex operador;and

A expressão @code{x and y} primeiro avalia `x'; se `x' for falso, seu valor será retornado; caso contrário, `y' será avaliado e o valor resultante será retornado.

@geindex operador;or

A expressão @code{x or y} primeiro avalia `x'; se `x' for verdadeiro, seu valor será retornado; caso contrário, `y' será avaliado e o valor resultante será retornado.

Observe que nem @ref{2f1,,and} nem @ref{2f6,,or} restringem o valor e o tipo que retornam para @code{False} e @code{True}, mas sim retornam o último argumento avaliado. Isso às vezes é útil, por exemplo, se @code{s} é uma string que deve ser substituída por um valor padrão se estiver vazia, a expressão @code{s or 'foo'} produz o valor desejado. Como @ref{220f,,not} precisa criar um novo valor, ele retorna um valor booleano independente do tipo de seu argumento (por exemplo, @code{not 'foo'} produz @code{False} em vez de @code{'@w{'}}.)

@geindex ;= (dois points igual)
@geindex expressão de atribuição
@geindex operador morsa
@geindex expressão nomeada
@geindex atribuição;expressão

@node Expressões de atribuição<2>,Expressões condicionais,Operações booleanas,Expressões
@anchor{reference/expressions assignment-expressions}@anchor{2212}@anchor{reference/expressions id15}@anchor{2213}
@subsection Expressões de atribuição


@example
@anchor{reference/expressions grammar-token-python-grammar-assignment_expression}@anchor{21b9}assignment_expression ::= [@ref{2023,,identifier} ":="] @ref{21c8,,expression}
@end example

Uma expressão de atribuição (às vezes também chamada de “expressão nomeada” ou “morsa”) atribui uma @ref{21c8,,expression} a um @ref{2023,,identifier}, ao mesmo tempo que retorna o valor de @ref{21c8,,expression}.

Um caso de uso comum é ao lidar com expressões regulares correspondentes:

@example
if matching := pattern.search(data):
    do_something(matching)
@end example

Ou, ao processar um fluxo de arquivos em partes:

@example
while chunk := file.read(9000):
    process(chunk)
@end example

As expressões de atribuição devem ser colocadas entre parênteses quando usadas como instruções de expressão e quando usadas como subexpressões em expressões de fatiamento, condicionais, de lambda, de argumento nomeado e de @code{if} de compreensão e em instruções @code{assert}, @code{with} e @code{assignment}. Em todos os outros lugares onde eles podem ser usados, os parênteses não são necessários, inclusive nas instruções @code{if} e @code{while}.


Adicionado na versão 3.8: Veja 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para mais detalhes sobre expressões de atribuição.


@node Expressões condicionais,Lambdas,Expressões de atribuição<2>,Expressões
@anchor{reference/expressions conditional-expressions}@anchor{2214}@anchor{reference/expressions if-expr}@anchor{2215}
@subsection Expressões condicionais


@geindex condicional;expressão
@geindex ternário;operador
@geindex if;expressão condicional
@geindex else;expressão condicional

@example
@anchor{reference/expressions grammar-token-python-grammar-conditional_expression}@anchor{204f}conditional_expression ::= @ref{21bc,,or_test} ["if" @ref{21bc,,or_test} "else" @ref{21c8,,expression}]
@anchor{reference/expressions grammar-token-python-grammar-expression}@anchor{21c8}expression             ::= @ref{204f,,conditional_expression} | @ref{2216,,lambda_expr}
@end example

Uma expressão condicional (às vezes chamada de “operador ternário”) é uma alternativa à instrução if-else. Como é uma expressão, ela retorna um valor e pode aparecer como uma subexpressão.

A expressão @code{x if C else y} primeiro avalia a condição, `C' em vez de `x'. Se `C' for verdadeiro, `x' é avaliado e seu valor é retornado; caso contrário, `y' será avaliado e seu valor será retornado.

Veja 
@geindex Propostas de Melhorias do Python; PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} para mais detalhes sobre expressões condicionais.
@anchor{reference/expressions lambdas}@anchor{2217}
@node Lambdas,Listas de expressões,Expressões condicionais,Expressões
@anchor{reference/expressions id16}@anchor{2218}@anchor{reference/expressions lambda}@anchor{12df}
@subsection Lambdas


@geindex lambda;expressão
@geindex lambda;função
@geindex anônima;função
@geindex ; (dois pontos);expressão lambda

@example
@anchor{reference/expressions grammar-token-python-grammar-lambda_expr}@anchor{2216}lambda_expr ::= "lambda" [@ref{2219,,parameter_list}] ":" @ref{21c8,,expression}
@end example

Expressões lambda (às vezes chamadas de funções lambda) são usadas para criar funções anônimas. A expressão @code{lambda parameters: expression} produz um objeto função. O objeto sem nome se comporta como um objeto de função definido com:

@example
def <lambda>(parâmetros):
    return expressão
@end example

Veja a seção @ref{1db6,,Definições de função} para a sintaxe das listas de parâmetros. Observe que as funções criadas com expressões lambda não podem conter instruções ou anotações.

@node Listas de expressões,Ordem de avaliação,Lambdas,Expressões
@anchor{reference/expressions expression-lists}@anchor{221a}@anchor{reference/expressions exprlists}@anchor{da6}
@subsection Listas de expressões


@geindex expressão;lista
@geindex @comma{} (vírgula);expressão@comma{} lista de

@example
@anchor{reference/expressions grammar-token-python-grammar-starred_expression}@anchor{21b6}starred_expression       ::= ["*"] @ref{2050,,or_expr}
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression}@anchor{221b}flexible_expression      ::= @ref{21b9,,assignment_expression} | @ref{21b6,,starred_expression}
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression_list}@anchor{21c1}flexible_expression_list ::= @ref{221b,,flexible_expression} ("," @ref{221b,,flexible_expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-starred_expression_list}@anchor{221c}starred_expression_list  ::= @ref{21b6,,starred_expression} ("," @ref{21b6,,starred_expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-expression_list}@anchor{221d}expression_list          ::= @ref{21c8,,expression} ("," @ref{21c8,,expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-yield_list}@anchor{21ce}yield_list               ::= @ref{221d,,expression_list} | @ref{21b6,,starred_expression} "," [@ref{221c,,starred_expression_list}]
@end example

@geindex objeto;tupla

Exceto quando parte de uma sintaxe de criação de lista ou conjunto, uma lista de expressões contendo pelo menos uma vírgula produz uma tupla. O comprimento da tupla é o número de expressões na lista. As expressões são avaliadas da esquerda para a direita.

@geindex iterável;desempacotamento
@geindex * (asterisco);em listas de expressões

Um asterisco @code{*} denota `desempacotamento de iterável'. Seu operando deve ser um @ref{1268,,iterável}. O iterável é expandido em uma sequência de itens, que são incluídos na nova tupla, lista ou conjunto, no local do desempacotamento.


Adicionado na versão 3.5: Desempacotamento de iterável em listas de expressões, originalmente proposta pela 
@geindex Propostas de Melhorias do Python; PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/}.



Adicionado na versão 3.11: Qualquer item em uma lista de expressões pode ser estrelado. Veja a 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


@geindex ao final;vírgula

Uma vírgula final é necessária apenas para criar uma tupla de um item, como @code{1,}; é opcional em todos os outros casos. Uma única expressão sem vírgula final não cria uma tupla, mas produz o valor dessa expressão. (Para criar uma tupla vazia, use um par vazio de parênteses: @code{()}.)

@node Ordem de avaliação,Precedência de operadores,Listas de expressões,Expressões
@anchor{reference/expressions evalorder}@anchor{221e}@anchor{reference/expressions evaluation-order}@anchor{221f}
@subsection Ordem de avaliação


@geindex avaliação;ordem

Python avalia expressões da esquerda para a direita. Observe que ao avaliar uma tarefa, o lado direito é avaliado antes do lado esquerdo.

Nas linhas a seguir, as expressões serão avaliadas na ordem aritmética de seus sufixos:

@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 Precedência de operadores,,Ordem de avaliação,Expressões
@anchor{reference/expressions operator-precedence}@anchor{2220}@anchor{reference/expressions operator-summary}@anchor{2221}
@subsection Precedência de operadores


@geindex operador;precedência

A tabela a seguir resume a precedência de operadores no Python, da precedência mais alta (mais vinculativa) à precedência mais baixa (menos vinculativa). Os operadores na mesma caixa têm a mesma precedência. A menos que a sintaxe seja fornecida explicitamente, os operadores são binários. Os operadores na mesma caixa agrupam-se da esquerda para a direita (exceto exponenciação e expressões condicionais, que agrupam da direita para a esquerda).

Observe que comparações, testes de pertinência e testes de identidade têm todos a mesma precedência e possuem um recurso de encadeamento da esquerda para a direita, conforme descrito na seção @ref{2205,,Comparações}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operador

@tab

Descrição

@item

@code{(expressions...)},

@code{[expressões...]}, @code{@{chave: valor...@}}, @code{@{expressões...@}}

@tab

Expressão entre parênteses ou de ligação, sintaxe de criação de lista, sintaxe de criação de dicionário, sintaxe de criação de conjunto

@item

@code{x[índice]}, @code{x[índice:índice]}, @code{x(argumentos...)}, @code{x.atributo}

@tab

subscrição, fatiamento, chamada, referência a atributo

@item

@ref{1b9,,await x}

@tab

Expressão await

@item

@code{**}

@tab

Exponenciação @footnote{
O operador de potência @code{**} liga-se com menos força do que um operador aritmético ou unário bit a bit à sua direita, ou seja, @code{2**-1} é @code{0.5}.
}

@item

@code{+x}, @code{-x}, @code{~x}

@tab

positivo, negativo, NEGAÇÃO (NOT) bit a bit

@item

@code{*}, @code{@@}, @code{/}, @code{//}, @code{%}

@tab

Multiplicação, multiplicação de matrizes, divisão, divisão pelo piso, resto @footnote{
O operador @code{%} também é usado para formatação de strings; a mesma precedência se aplica.
}

@item

@code{+}, @code{-}

@tab

Adição e subtração

@item

@code{<<}, @code{>>}

@tab

Deslocamentos

@item

@code{&}

@tab

E (AND) bit a bit

@item

@code{^}

@tab

OU EXCLUSIVO (XOR) bit a bit

@item

@code{|}

@tab

OU (OR) bit a bit

@item

@ref{2f4,,in}, @ref{62f,,not in},
@ref{2f5,,is}, @ref{220c,,is not}, @code{<},
@code{<=}, @code{>}, @code{>=}, @code{!=}, @code{==}

@tab

Comparações, incluindo testes de pertinência e testes de identidade

@item

@ref{220f,,not x}

@tab

NEGAÇÃO (NOT) booleana

@item

@ref{2f1,,and}

@tab

E (AND) booleano

@item

@ref{2f6,,or}

@tab

OU (OR) booleano

@item

@ref{2215,,if} – @code{else}

@tab

Expressão condicional

@item

@ref{12df,,lambda}

@tab

Expressão lambda

@item

@code{:=}

@tab

Expressão de atribuição

@end multitable


@node Instruções simples,Instruções compostas,Expressões,A Referência da Linguagem Python
@anchor{reference/simple_stmts doc}@anchor{2222}@anchor{reference/simple_stmts simple}@anchor{2223}@anchor{reference/simple_stmts simple-statements}@anchor{2224}@anchor{reference/simple_stmts translation-repo}@anchor{2225}
@section Instruções simples


@geindex simples;instrução

Uma instrução simples consiste uma única linha lógica. Várias instruções simples podem ocorrer em uma única linha separada por ponto e vírgula. A sintaxe para instruções simples é:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-simple_stmt}@anchor{2226}simple_stmt ::= @ref{2227,,expression_stmt}
                | @ref{2228,,assert_stmt}
                | @ref{2229,,assignment_stmt}
                | @ref{222a,,augmented_assignment_stmt}
                | @ref{222b,,annotated_assignment_stmt}
                | @ref{222c,,pass_stmt}
                | @ref{222d,,del_stmt}
                | @ref{222e,,return_stmt}
                | @ref{222f,,yield_stmt}
                | @ref{2230,,raise_stmt}
                | @ref{2231,,break_stmt}
                | @ref{2232,,continue_stmt}
                | @ref{2233,,import_stmt}
                | @ref{2234,,future_stmt}
                | @ref{2235,,global_stmt}
                | @ref{2236,,nonlocal_stmt}
                | @ref{2237,,type_stmt}
@end example

@menu
* Instruções de expressão:: 
* Instruções de atribuição:: 
* A instrução assert:: 
* A instrução pass:: 
* A instrução del: A instrução del<2>. 
* A instrução return:: 
* A instrução yield:: 
* A instrução raise:: 
* A instrução break:: 
* A instrução continue:: 
* A instrução import:: 
* A instrução global:: 
* A instrução nonlocal:: 
* A instrução type:: 

@end menu

@node Instruções de expressão,Instruções de atribuição,,Instruções simples
@anchor{reference/simple_stmts expression-statements}@anchor{2238}@anchor{reference/simple_stmts exprstmts}@anchor{2239}
@subsection Instruções de expressão


@geindex expressão;instrução
@geindex expressão;lista

@geindex expressão;lista

As instruções de expressão são usadas (principalmente interativamente) para calcular e escrever um valor, ou (geralmente) para chamar um procedimento (uma função que não retorna nenhum resultado significativo; em Python, os procedimentos retornam o valor @code{None}). Outros usos de instruções de expressão são permitidos e ocasionalmente úteis. A sintaxe para uma instrução de expressão é:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-expression_stmt}@anchor{2227}expression_stmt ::= @ref{21b6,,starred_expression}
@end example

Uma instrução de expressão avalia a lista de expressões (que pode ser uma única expressão).

@geindex função embutida;repr
@geindex objeto;None
@geindex string;conversão
@geindex saída
@geindex padrão;saída
@geindex escrita; gravação;valores
@geindex procedimento;chamada

No modo interativo, se o valor não for @code{None}, ele será convertido em uma string usando a função embutida @ref{800,,repr()} e a string resultante será gravada na saída padrão em uma linha sozinha (exceto se o resultado é @code{None}, de modo que as chamadas de procedimento não causam nenhuma saída.)

@node Instruções de atribuição,A instrução assert,Instruções de expressão,Instruções simples
@anchor{reference/simple_stmts assignment}@anchor{2168}@anchor{reference/simple_stmts assignment-statements}@anchor{223a}
@subsection Instruções de atribuição


@geindex = (igual);atribuição@comma{} instrução de
@geindex atribuição;instrução
@geindex vinculação; ligação;nome
@geindex nova vinculação; nova ligação;nome
@geindex objeto;mutável
@geindex atributo;atribuição

As instruções de atribuição são usadas para (re)vincular nomes a valores e modificar atributos ou itens de objetos mutáveis:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assignment_stmt}@anchor{2229}assignment_stmt ::= (@ref{21bb,,target_list} "=")+ (@ref{21b6,,starred_expression} | @ref{2051,,yield_expression})
@anchor{reference/simple_stmts grammar-token-python-grammar-target_list}@anchor{21bb}target_list     ::= @ref{223b,,target} ("," @ref{223b,,target})* [","]
@anchor{reference/simple_stmts grammar-token-python-grammar-target}@anchor{223b}target          ::= @ref{2023,,identifier}
                    | "(" [@ref{21bb,,target_list}] ")"
                    | "[" [@ref{21bb,,target_list}] "]"
                    | @ref{21da,,attributeref}
                    | @ref{21db,,subscription}
                    | @ref{21dc,,slicing}
                    | "*" @ref{223b,,target}
@end example

(Veja a seção @ref{21d8,,Primárias} para as definições de sintaxe de `attributeref', `subscription' e `slicing'.)

Uma instrução de atribuição avalia a lista de expressões (lembre-se de que pode ser uma única expressão ou uma lista separada por vírgulas, a última produzindo uma tupla) e atribui o único objeto resultante a cada uma das listas alvos, da esquerda para a direita.

@geindex alvo
@geindex alvo;lista

A atribuição é definida recursivamente dependendo da forma do alvo (lista). Quando um alvo faz parte de um objeto mutável (uma referência de atributo, assinatura ou divisão), o objeto mutável deve, em última análise, executar a atribuição e decidir sobre sua validade e pode levantar uma exceção se a atribuição for inaceitável. As regras observadas pelos vários tipos e as exceções levantadas são dadas com a definição dos tipos de objetos (ver seção @ref{2075,,A hierarquia de tipos padrão}).

@geindex alvo;lista;atribuição
@geindex @comma{} (vírgula);na lista de alvos
@geindex * (asterisco);na lista de alvo de atribuição
@geindex [] (colchetes);na lista de alvo de atribuição
@geindex () (parênteses);na lista de alvo de atribuição

A atribuição de um objeto a uma lista alvo, opcionalmente entre parênteses ou colchetes, é definida recursivamente da maneira a seguir.


@itemize *

@item 
Se a lista alvo contiver um único alvo sem vírgula à direita, opcionalmente entre parênteses, o objeto será atribuído a esse alvo.

@item 
Senão:


@itemize *

@item 
Se a lista alvo contiver um alvo prefixado com um asterisco, chamado de alvo “com estrela” `(starred)': o objeto deve ser um iterável com pelo menos tantos itens quantos os alvos na lista alvo, menos um. Os primeiros itens do iterável são atribuídos, da esquerda para a direita, aos alvos antes do alvo com estrela. Os itens finais do iterável são atribuídos aos alvos após o alvo com estrela. Uma lista dos itens restantes no iterável é então atribuída ao alvo com estrela (a lista pode estar vazia).

@item 
Senão: o objeto deve ser um iterável com o mesmo número de itens que existem alvos na lista alvos, e os itens são atribuídos, da esquerda para a direita, aos alvos correspondentes.
@end itemize
@end itemize

A atribuição de um objeto a um único alvo é definida recursivamente da maneira a seguir.


@itemize *

@item 
Se o alvo for um identificador (nome):


@itemize *

@item 
Se o nome não ocorrer em uma instrução @ref{18a,,global} ou @ref{12ea,,nonlocal} no bloco de código atual: o nome está vinculado ao objeto no espaço de nomes local atual.

@item 
Caso contrário: o nome é vinculado ao objeto no espaço de nomes global global ou no espaço de nomes global externo determinado por @ref{12ea,,nonlocal}, respectivamente.
@end itemize

@geindex destrutor

O nome é vinculado novamente se já estiver vinculado. Isso pode fazer com que a contagem de referências para o objeto anteriormente vinculado ao nome chegue a zero, fazendo com que o objeto seja desalocado e seu destrutor (se houver) seja chamado.

@geindex atributo;atribuição

@item 
Se o alvo for uma referência de atributo: a expressão primária na referência é avaliada. Deve produzir um objeto com atributos atribuíveis; se este não for o caso, a exceção @ref{2c3,,TypeError} é levanta. Esse objeto é então solicitado a atribuir o objeto atribuído ao atributo fornecido; se não puder executar a atribuição, ele levanta uma exceção (geralmente, mas não necessariamente @ref{34b,,AttributeError}).
@anchor{reference/simple_stmts attr-target-note}@anchor{223c}
Nota: Se o objeto for uma instância de classe e a referência de atributo ocorrer em ambos os lados do operador de atribuição, a expressão do lado direito, @code{a.x} pode acessar um atributo de instância ou (se não existir nenhum atributo de instância) uma classe atributo. O alvo do lado esquerdo @code{a.x} é sempre definido como um atributo de instância, criando-o se necessário. Assim, as duas ocorrências de @code{a.x} não necessariamente se referem ao mesmo atributo: se a expressão do lado direito se refere a um atributo de classe, o lado esquerdo cria um novo atributo de instância como alvo da atribuição:

@example
class Cls:
    x = 3             # variável de classe
inst = Cls()
inst.x = inst.x + 1   # escreve inst.x como 4 deixando Cls.x como 3
@end example

Esta descrição não se aplica necessariamente aos atributos do descritor, como propriedades criadas com @ref{194,,property()}.

@geindex subscrição;atribuição
@geindex objeto;mutável

@item 
Se o alvo for uma assinatura: a expressão primária na referência é avaliada. Deve produzir um objeto de sequência mutável (como uma lista) ou um objeto de mapeamento (como um dicionário). Em seguida, a expressão subscrito é avaliada.

@geindex objeto;sequência
@geindex objeto;lista

Se o primário for um objeto de sequência mutável (como uma lista), o subscrito deverá produzir um inteiro. Se for negativo, o comprimento da sequência é adicionado a ela. O valor resultante deve ser um inteiro não negativo menor que o comprimento da sequência, e a sequência é solicitada a atribuir o objeto atribuído ao seu item com esse índice. Se o índice estiver fora do intervalo, a exceção @ref{157e,,IndexError} será levantada (a atribuição a uma sequência subscrita não pode adicionar novos itens a uma lista).

@geindex objeto;mapeamento
@geindex objeto;dicionário

Se o primário for um objeto de mapeamento (como um dicionário), o subscrito deve ter um tipo compatível com o tipo de chave do mapeamento, e o mapeamento é solicitado a criar um par chave/valore que mapeia o subscrito para o objeto atribuído. Isso pode substituir um par de chave/valor existente pelo mesmo valor de chave ou inserir um novo par de chave/valor (se não existir nenhuma chave com o mesmo valor).

Para objetos definidos pelo usuário, o método @ref{130e,,__setitem__()} é chamado com argumentos apropriados.

@geindex fatiamento;atribuição

@item 
Se o alvo for um fatiamento: a expressão primária na referência é avaliada. Deve produzir um objeto de sequência mutável (como uma lista). O objeto atribuído deve ser um objeto de sequência do mesmo tipo. Em seguida, as expressões de limite inferior e superior são avaliadas, na medida em que estiverem presentes; os padrões são zero e o comprimento da sequência. Os limites devem ser avaliados como inteiros. Se um dos limites for negativo, o comprimento da sequência será adicionado a ele. Os limites resultantes são cortados para ficarem entre zero e o comprimento da sequência, inclusive. Finalmente, o objeto de sequência é solicitado a substituir a fatia pelos itens da sequência atribuída. O comprimento da fatia pode ser diferente do comprimento da sequência atribuída, alterando assim o comprimento da sequência alvo, se a sequência alvo permitir.
@end itemize

Na implementação atual, a sintaxe dos alvos é considerada a mesma das expressões e a sintaxe inválida é rejeitada durante a fase de geração do código, causando mensagens de erro menos detalhadas.

Embora a definição de atribuição implique que as sobreposições entre o lado esquerdo e o lado direito sejam “simultâneas” (por exemplo, @code{a, b = b, a} troca duas variáveis), sobreposições `dentro' da coleção de variáveis atribuídas ocorrem da esquerda para a direita, às vezes resultando em confusão. Por exemplo, o programa a seguir imprime @code{[0, 2]}:

@example
x = [0, 1]
i = 0
i, x[i] = 1, 2         # i é atualizado e, em seguida, x[i] é atualizado
print(x)
@end example


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3132

@item PEP 3132@footnote{https://peps.python.org/pep-3132/} - Desempacotamento estendido de iterável

A especificação para o recurso @code{*target}.
@end table


@menu
* Instruções de atribuição aumentada:: 
* instruções de atribuição anotado:: 

@end menu

@node Instruções de atribuição aumentada,instruções de atribuição anotado,,Instruções de atribuição
@anchor{reference/simple_stmts augassign}@anchor{223d}@anchor{reference/simple_stmts augmented-assignment-statements}@anchor{223e}
@subsubsection Instruções de atribuição aumentada


@geindex aumentada;atribuição
@geindex instrução;aumentada@comma{} atribuição
@geindex +=;atribuição aumentada
@geindex -=;atribuição aumentada
@geindex *=;atribuição aumentada
@geindex /=;atribuição aumentada
@geindex %=;atribuição aumentada
@geindex &=;atribuição aumentada
@geindex ^=;atribuição aumentada
@geindex |=;atribuição aumentada
@geindex **=;atribuição aumentada
@geindex //=;atribuição aumentada
@geindex >>=;atribuição aumentada
@geindex <<=;atribuição aumentada

A atribuição aumentada é a combinação, em uma única instrução, de uma operação binária e uma instrução de atribuição:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-augmented_assignment_stmt}@anchor{222a}augmented_assignment_stmt ::= @ref{223f,,augtarget} @ref{2240,,augop} (@ref{221d,,expression_list} | @ref{2051,,yield_expression})
@anchor{reference/simple_stmts grammar-token-python-grammar-augtarget}@anchor{223f}augtarget                 ::= @ref{2023,,identifier} | @ref{21da,,attributeref} | @ref{21db,,subscription} | @ref{21dc,,slicing}
@anchor{reference/simple_stmts grammar-token-python-grammar-augop}@anchor{2240}augop                     ::= "+=" | "-=" | "*=" | "@@=" | "/=" | "//=" | "%=" | "**="
                              | ">>=" | "<<=" | "&=" | "^=" | "|="
@end example

(Veja a seção @ref{21d8,,Primárias} para as definições de sintaxe dos últimos três símbolos.)

Uma atribuição aumentada avalia o alvo (que, diferentemente das instruções de atribuição normais, não pode ser um desempacotamento) e a lista de expressões, executa a operação binária específica para o tipo de atribuição nos dois operandos e atribui o resultado ao alvo original. O alvo é avaliado apenas uma vez.

Uma instrução de atribuição aumentada como @code{x += 1} pode ser reescrita como @code{x = x + 1} para obter um efeito semelhante, mas não exatamente igual. Na versão aumentada, @code{x} é avaliado apenas uma vez. Além disso, quando possível, a operação real é executada `no local', o que significa que, em vez de criar um novo objeto e atribuí-lo ao alvo, o objeto antigo é modificado.

Ao contrário das atribuições normais, as atribuições aumentadas avaliam o lado esquerdo `antes' de avaliar o lado direito. Por exemplo, @code{a[i] += f(x)} primeiro procura @code{a[i]}, então avalia @code{f(x)} e executa a adição e, por último, escreve o resultado de volta para @code{a[i]}.

Com exceção da atribuição a tuplas e vários alvos em uma única instrução, a atribuição feita por instruções de atribuição aumentada é tratada da mesma maneira que atribuições normais. Da mesma forma, com exceção do possível comportamento `in-place', a operação binária executada por atribuição aumentada é a mesma que as operações binárias normais.

Para alvos que são referências de atributos, a mesma @ref{223c,,advertência sobre atributos de classe e instância} se aplica a atribuições regulares.

@node instruções de atribuição anotado,,Instruções de atribuição aumentada,Instruções de atribuição
@anchor{reference/simple_stmts annassign}@anchor{2241}@anchor{reference/simple_stmts annotated-assignment-statements}@anchor{2242}
@subsubsection instruções de atribuição anotado


@geindex anotada;atribuição
@geindex instrução;atribuição@comma{} anotada
@geindex ; (dois pontos);anotada@comma{} variável

A atribuição de @ref{d79,,anotação} é a combinação, em uma única instrução, de uma anotação de variável ou atributo e uma instrução de atribuição opcional:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-annotated_assignment_stmt}@anchor{222b}annotated_assignment_stmt ::= @ref{223f,,augtarget} ":" @ref{21c8,,expression}
                              ["=" (@ref{21b6,,starred_expression} | @ref{2051,,yield_expression})]
@end example

A diferença para as @ref{2168,,Instruções de atribuição} normal é que apenas um único alvo é permitido.

O alvo da atribuição é considerado “simples” se consistir em um único nome que não esteja entre parênteses. Para alvos de atribuição simples, se no escopo de classe ou módulo, as anotações são avaliadas e armazenadas em uma classe especial ou atributo de módulo @code{__annotations__} que é um mapeamento de dicionário de nomes de variáveis (desconfigurados se privados) para anotações avaliadas. Este atributo é gravável e é criado automaticamente no início da execução do corpo da classe ou módulo, se as anotações forem encontradas estaticamente.

Se o alvo da atribuição não for simples (um atributo, nó subscrito ou nome entre parênteses), a anotação será avaliada se estiver no escopo da classe ou do módulo, mas não será armazenada.

Se um nome for anotado em um escopo de função, esse nome será local para esse escopo. As anotações nunca são avaliadas e armazenadas em escopos de função.

Se o lado direito estiver presente, uma atribuição anotada executa a atribuição real antes de avaliar as anotações (quando aplicável). Se o lado direito não estiver presente para um alvo de expressão, então o interpretador avalia o alvo, exceto para a última chamada @ref{130e,,__setitem__()} ou @ref{20bf,,__setattr__()}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - Sintaxe para Anotações de Variáveis

A proposta que adicionou sintaxe para anotar os tipos de variáveis (incluindo variáveis de classe e variáveis de instância), em vez de expressá-las por meio de comentários.

@geindex Propostas de Melhorias do Python; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Dicas de tipo

A proposta que adicionou o módulo @ref{104,,typing} para fornecer uma sintaxe padrão para anotações de tipo que podem ser usadas em ferramentas de análise estática e IDEs.
@end table



Alterado na versão 3.8: Agora, as atribuições anotadas permitem as mesmas expressões no lado direito que as atribuições regulares. Anteriormente, algumas expressões (como expressões de tupla sem parênteses) causavam um erro de sintaxe.


@node A instrução assert,A instrução pass,Instruções de atribuição,Instruções simples
@anchor{reference/simple_stmts assert}@anchor{96f}@anchor{reference/simple_stmts the-assert-statement}@anchor{2243}
@subsection A instrução @code{assert}


@geindex instrução;assert
@geindex depuração;asserções
@geindex @comma{} (vírgula);expressão@comma{} lista de

As instruções assert são uma maneira conveniente de inserir asserções de depuração em um programa:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assert_stmt}@anchor{2228}assert_stmt ::= "assert" @ref{21c8,,expression} ["," @ref{21c8,,expression}]
@end example

A forma simples, @code{assert expression}, é equivalente a

@example
if __debug__:
    if not expression: raise AssertionError
@end example

A forma estendida, @code{assert expression1, expression2}, é equivalente a

@example
if __debug__:
    if not expression1: raise AssertionError(expression2)
@end example

@geindex __debug__
@geindex exceção;AssertionError

Essas equivalências presumem que @ref{7db,,__debug__} e @ref{6a9,,AssertionError} referem-se às variáveis embutidas com esses nomes. Na implementação atual, a variável embutida @code{__debug__} é @code{True} em circunstâncias normais, @code{False} quando a otimização é solicitada (opção de linha de comando @ref{ddd,,-O}). O gerador de código atual não emite código para uma instrução @ref{96f,,assert} quando a otimização é solicitada em tempo de compilação. Observe que não é necessário incluir o código-fonte da expressão que falhou na mensagem de erro; ele será exibido como parte do stack trace (situação da pilha de execução).

Atribuições a @ref{7db,,__debug__} são ilegais. O valor da variável embutida é determinado quando o interpretador é iniciado.

@node A instrução pass,A instrução del<2>,A instrução assert,Instruções simples
@anchor{reference/simple_stmts pass}@anchor{1d99}@anchor{reference/simple_stmts the-pass-statement}@anchor{2244}
@subsection A instrução @code{pass}


@geindex instrução;pass
@geindex null;operação
@geindex null;operação

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-pass_stmt}@anchor{222c}pass_stmt ::= "pass"
@end example

@ref{1d99,,pass} é uma operação nula — quando é executada, nada acontece. É útil como um espaço reservado quando uma instrução é necessária sintaticamente, mas nenhum código precisa ser executado, por exemplo:

@example
def f(arg): pass    # uma função que faz nada (ainda)

class C: pass       # uma classe com nenhum método (ainda)
@end example

@node A instrução del<2>,A instrução return,A instrução pass,Instruções simples
@anchor{reference/simple_stmts del}@anchor{18a7}@anchor{reference/simple_stmts the-del-statement}@anchor{2245}
@subsection A instrução @code{del}


@geindex instrução;del
@geindex exclusão;alvo
@geindex exclusão;alvo;lista

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-del_stmt}@anchor{222d}del_stmt ::= "del" @ref{21bb,,target_list}
@end example

A exclusão é definida recursivamente de maneira muito semelhante à maneira como a atribuição é definida. Em vez de explicar em detalhes, aqui estão algumas dicas.

A exclusão de uma lista alvo exclui recursivamente cada alvo, da esquerda para a direita.

@geindex instrução;global
@geindex desvinculação;nome

A exclusão de um nome remove a ligação desse nome do espaço de nomes local ou global, dependendo se o nome ocorre em uma instrução @ref{18a,,global} no mesmo bloco de código. Tentar excluir um nome  desvinculado levanta uma exceção @ref{43f,,NameError}.

@geindex atributo;exclusão

A exclusão de referências de atributos, assinaturas e fatias é passada para o objeto principal envolvido; a exclusão de um fatiamento é em geral equivalente à atribuição de uma fatia vazia do tipo certo (mas mesmo isso é determinado pelo objeto fatiado).


Alterado na versão 3.2: Anteriormente, era ilegal excluir um nome do espaço de nomes local se ele ocorresse como uma variável livre em um bloco aninhado.


@node A instrução return,A instrução yield,A instrução del<2>,Instruções simples
@anchor{reference/simple_stmts return}@anchor{9d6}@anchor{reference/simple_stmts the-return-statement}@anchor{2246}
@subsection A instrução @code{return}


@geindex instrução;return
@geindex função;definição
@geindex classe;definição

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-return_stmt}@anchor{222e}return_stmt ::= "return" [@ref{221d,,expression_list}]
@end example

@ref{9d6,,return} só pode ocorrer sintaticamente aninhado em uma definição de função, não em uma definição de classe aninhada.

Se uma lista de expressões estiver presente, ela será avaliada, caso contrário, será usado o valor @code{None}.

@ref{9d6,,return} deixa a chamada da função atual com a lista de expressões (ou @code{None}) como valor de retorno.

@geindex palavra reservada;finally

Quando @ref{9d6,,return} passa o controle de uma instrução @ref{6e9,,try} com uma cláusula @ref{9d2,,finally}, essa cláusula @code{finally} é executada antes de realmente sair da função.

Em uma função geradora, a instrução @ref{9d6,,return} indica que o gerador está pronto e fará com que uma exceção @ref{c15,,StopIteration} seja levantada. O valor retornado (se houver) é usado como argumento para construir @ref{c15,,StopIteration} e se torna o atributo @ref{2157,,StopIteration.value}.

Em uma função de gerador assíncrono, uma instrução @ref{9d6,,return} vazia indica que o gerador assíncrono está pronto e fará com que uma exceção @ref{1ba5,,StopAsyncIteration} seja levantada. Uma instrução @code{return} não vazia é um erro de sintaxe em uma função de gerador assíncrono.

@node A instrução yield,A instrução raise,A instrução return,Instruções simples
@anchor{reference/simple_stmts the-yield-statement}@anchor{2247}@anchor{reference/simple_stmts yield}@anchor{9d5}
@subsection A instrução @code{yield}


@geindex instrução;yield
@geindex gerador;função
@geindex gerador;iterador
@geindex função;gerador
@geindex exceção;StopIteration

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-yield_stmt}@anchor{222f}yield_stmt ::= @ref{2051,,yield_expression}
@end example

Uma instrução @ref{9d5,,yield} é semanticamente equivalente a uma @ref{21cc,,expressão yield}. A instrução @code{yield} pode ser usada para omitir os parênteses que, de outra forma, seriam necessários na instrução de expressão yield equivalente. Por exemplo, as instruções yield

@example
yield <expr>
yield from <expr>
@end example

são equivalentes às instruções de expressão yield

@example
(yield <expr>)
(yield from <expr>)
@end example

Expressões e instruções yield são usadas apenas ao definir uma função @ref{109a,,geradora} e são usadas apenas no corpo da função geradora. Usar @ref{9d5,,yield} em uma definição de função é suficiente para fazer com que essa definição crie uma função geradora em vez de uma função normal.

Para detalhes completos da semântica @ref{9d5,,yield}, consulte a seção @ref{21cc,,Expressões yield}.

@node A instrução raise,A instrução break,A instrução yield,Instruções simples
@anchor{reference/simple_stmts raise}@anchor{5ed}@anchor{reference/simple_stmts the-raise-statement}@anchor{2248}
@subsection A instrução @code{raise}


@geindex instrução;raise
@geindex exceção
@geindex levantamento;exceção
@geindex __traceback__ (atributo de exceção)

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-raise_stmt}@anchor{2230}raise_stmt ::= "raise" [@ref{21c8,,expression} ["from" @ref{21c8,,expression}]]
@end example

Se nenhuma expressão estiver presente, @ref{5ed,,raise} reativa a exceção em tratamento no momento, também conhecida como `exceção ativa'. Se não houver uma exceção ativa no momento, uma exceção @ref{195,,RuntimeError} é levantada indicando que isso é um erro.

Caso contrário, @ref{5ed,,raise} avalia a primeira expressão como o objeto de exceção. Deve ser uma subclasse ou uma instância de @ref{5bb,,BaseException}. Se for uma classe, a instância de exceção será obtida quando necessário, instanciando a classe sem argumentos.

O `tipo' da exceção é a classe da instância de exceção, o `valor' é a própria instância.

@geindex objeto;traceback

Um objeto traceback (situação da pilha de execução) normalmente é criado automaticamente quando uma exceção é levantada e anexada a ele como o atributo @ref{1309,,__traceback__}. Você pode criar uma exceção e definir seu próprio traceback em uma etapa usando o método de exceção @ref{2249,,with_traceback()} (que retorna a mesma instância de exceção, com seu traceback definido para seu argumento), assim:

@example
raise Exception("ocorreu foo").with_traceback(tracebackobj)
@end example

@geindex exceção;encadeamento
@geindex __cause__ (atributo de exceção)
@geindex __context__ (atributo de exceção)

A cláusula @code{from} é usada para encadeamento de exceções: se fornecida, a segunda expressão, `expression', deve ser outra classe ou instância de exceção. Se a segunda expressão for uma instância de exceção, ela será anexada à exceção levantada como o atributo @ref{130b,,__cause__} (que é gravável). Se a expressão for uma classe de exceção, a classe será instanciada e a instância resultante será anexada à exceção levantada como o atributo @code{__cause__}. Se a exceção levantada não for tratada, ambas as exceções serão impressas:

@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

Um mecanismo semelhante funciona implicitamente quando uma nova exceção for levantada enquanto outra já estiver sendo tratada. Uma exceção pode ser tratada quando uma cláusula @ref{18b,,except} ou @ref{9d2,,finally}, ou uma instrução @ref{5d2,,with}, é usada. A exceção anterior é então anexada como o atributo @ref{130a,,__context__} da nova exceção:

@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

O encadeamento de exceção pode ser explicitamente suprimido especificando @ref{675,,None} na cláusula @code{from}:

@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

Informações adicionais sobre exceções podem ser encontradas na seção @ref{2173,,Exceções}, e informações sobre como lidar com exceções estão na seção @ref{6e9,,A instrução try}.


Alterado na versão 3.3: @ref{675,,None} agora é permitido como @code{Y} em @code{raise X from Y}.

Adicionado o atributo @ref{224a,,__suppress_context__} para suprimir a exibição automática do contexto de exceção.



Alterado na versão 3.11: Se o traceback da exceção ativa for modificado em uma cláusula @ref{18b,,except}, uma instrução @code{raise} subsequente levantará novamente a exceção com o traceback modificado. Anteriormente, a exceção era levantada novamente com o traceback que tinha quando foi capturada.


@node A instrução break,A instrução continue,A instrução raise,Instruções simples
@anchor{reference/simple_stmts break}@anchor{ab8}@anchor{reference/simple_stmts the-break-statement}@anchor{224b}
@subsection A instrução @code{break}


@geindex instrução;break
@geindex instrução;for
@geindex instrução;while
@geindex laço;instrução

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-break_stmt}@anchor{2231}break_stmt ::= "break"
@end example

@ref{ab8,,break} só pode ocorrer sintaticamente aninhado em um laço @ref{2f2,,for} ou @ref{1d82,,while}, mas não aninhado em uma função ou definição de classe dentro desse laço.

@geindex palavra reservada;else
@geindex controle de laço;alvo

Ele termina o laço de repetição mais próximo, pulando a cláusula opcional @code{else} se o laço tiver uma.

Se um laço @ref{2f2,,for} é encerrado por @ref{ab8,,break}, o alvo de controle do laço mantém seu valor atual.

@geindex palavra reservada;finally

Quando @ref{ab8,,break} passa o controle de uma instrução @ref{6e9,,try} com uma cláusula @ref{9d2,,finally}, essa cláusula @code{finally} é executada antes de realmente sair do laço.

@node A instrução continue,A instrução import,A instrução break,Instruções simples
@anchor{reference/simple_stmts continue}@anchor{9d1}@anchor{reference/simple_stmts the-continue-statement}@anchor{224c}
@subsection A instrução @code{continue}


@geindex instrução;continue
@geindex instrução;for
@geindex instrução;while
@geindex laço;instrução
@geindex palavra reservada;finally

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-continue_stmt}@anchor{2232}continue_stmt ::= "continue"
@end example

@ref{9d1,,continue} só pode ocorrer sintaticamente aninhado em um laço @ref{2f2,,for} ou @ref{1d82,,while}, mas não em uma função ou definição de classe dentro desse laço. Ele continua com o próximo ciclo do laço de repetição mais próximo.

Quando @ref{9d1,,continue} passa o controle de uma instrução @ref{6e9,,try} com uma cláusula @ref{9d2,,finally}, essa cláusula @code{finally} é executada antes de realmente iniciar o próximo ciclo do laço.
@anchor{reference/simple_stmts import}@anchor{5e2}
@node A instrução import,A instrução global,A instrução continue,Instruções simples
@anchor{reference/simple_stmts from}@anchor{12ee}@anchor{reference/simple_stmts the-import-statement}@anchor{224d}
@subsection A instrução @code{import}


@geindex instrução;import
@geindex módulo;importação
@geindex nome;vinculação; ligação
@geindex palavra reservada;from
@geindex palavra reservada;as
@geindex exceção;ImportError
@geindex @comma{} (vírgula);instrução import

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-import_stmt}@anchor{2233}import_stmt     ::= "import" @ref{224e,,module} ["as" @ref{2023,,identifier}] ("," @ref{224e,,module} ["as" @ref{2023,,identifier}])*
                    | "from" @ref{224f,,relative_module} "import" @ref{2023,,identifier} ["as" @ref{2023,,identifier}]
                    ("," @ref{2023,,identifier} ["as" @ref{2023,,identifier}])*
                    | "from" @ref{224f,,relative_module} "import" "(" @ref{2023,,identifier} ["as" @ref{2023,,identifier}]
                    ("," @ref{2023,,identifier} ["as" @ref{2023,,identifier}])* [","] ")"
                    | "from" @ref{224f,,relative_module} "import" "*"
@anchor{reference/simple_stmts grammar-token-python-grammar-module}@anchor{224e}module          ::= (@ref{2023,,identifier} ".")* @ref{2023,,identifier}
@anchor{reference/simple_stmts grammar-token-python-grammar-relative_module}@anchor{224f}relative_module ::= "."* @ref{224e,,module} | "."+
@end example

A instrução de importação básica (sem cláusula @ref{12ee,,from}) é executada em duas etapas:


@enumerate 

@item 
encontra um módulo, carregando e inicializando-o se necessário

@item 
define um nome ou nomes no espaço de nomes local para o escopo onde ocorre a instrução @ref{5e2,,import}.
@end enumerate

Quando a instrução contém várias cláusulas (separadas por vírgulas), as duas etapas são executadas separadamente para cada cláusula, como se as cláusulas tivessem sido separadas em instruções de importação individuais.

Os detalhes da primeira etapa, encontrar e carregar módulos, estão descritos com mais detalhes na seção sobre o @ref{20a3,,sistema de importação}, que também descreve os vários tipos de pacotes e módulos que podem ser importados, bem como todos os os ganchos que podem ser usados para personalizar o sistema de importação. Observe que falhas nesta etapa podem indicar que o módulo não pôde ser localizado `ou' que ocorreu um erro durante a inicialização do módulo, o que inclui a execução do código do módulo.

Se o módulo solicitado for recuperado com sucesso, ele será disponibilizado no espaço de nomes local de três maneiras:

@geindex as;instrução import


@itemize *

@item 
Se o nome do módulo é seguido pela palavra-chave @code{as}, o nome a seguir é vinculado diretamente ao módulo importado.

@item 
Se nenhum outro nome for especificado e o módulo que está sendo importado for um módulo de nível superior, o nome do módulo será vinculado ao espaço de nomes local como uma referência ao módulo importado

@item 
Se o módulo que está sendo importado `não' for um módulo de nível superior, o nome do pacote de nível superior que contém o módulo será vinculado ao espaço de nomes local como uma referência ao pacote de nível superior. O módulo importado deve ser acessado usando seu nome completo e não diretamente
@end itemize

@geindex nome;vinculação; ligação
@geindex from;instrução import

O formulário @ref{12ee,,from} usa um processo um pouco mais complexo:


@enumerate 

@item 
encontra o módulo especificado na cláusula @ref{12ee,,from}, carregando e inicializando-o se necessário;

@item 
para cada um dos identificadores especificados nas cláusulas @ref{5e2,,import}:


@enumerate 

@item 
verifica se o módulo importado tem um atributo com esse nome

@item 
caso contrário, tenta importar um submódulo com esse nome e verifica o módulo importado novamente para esse atributo

@item 
se o atributo não for encontrado, a exceção @ref{419,,ImportError} é levantada.

@item 
caso contrário, uma referência a esse valor é armazenada no espaço de nomes local, usando o nome na cláusula @code{as} se estiver presente, caso contrário, usando o nome do atributo
@end enumerate
@end enumerate

Exemplos:

@example
import foo                 # foo importado e vinculado localmente
import foo.bar.baz         # foo, foo.bar e foo.bar.baz importados, foo vinculado localmente
import foo.bar.baz as fbb  # foo, foo.bar e foo.bar.baz importados, foo.bar.baz vinculado como fbb
from foo.bar import baz    # foo, foo.bar e foo.bar.baz importados, foo.bar.baz vinculado como baz
from foo import attr       # foo importado e foo.attr vinculado como attr
@end example

@geindex * (asterisco);instrução import

Se a lista de identificadores for substituída por uma estrela (@code{'*'}), todos os nomes públicos definidos no módulo serão vinculados ao espaço de nomes local para o escopo onde ocorre a instrução @ref{5e2,,import}.

@geindex __all__ (atributo opcional de módulo)

@geindex __all__ (atributo module)
@anchor{reference/simple_stmts module __all__}@anchor{d62}
Os `nomes públicos' definidos por um módulo são determinados verificando o espaço de nomes do módulo para uma variável chamada @code{__all__}; se definido, deve ser uma sequência de strings que são nomes definidos ou importados por esse módulo. Os nomes dados em @code{__all__} são todos considerados públicos e devem existir. Se @code{__all__} não estiver definido, o conjunto de nomes públicos inclui todos os nomes encontrados no espaço de nomes do módulo que não começam com um caractere sublinhado (@code{'_'}). @code{__all__} deve conter toda a API pública. Destina-se a evitar a exportação acidental de itens que não fazem parte da API (como módulos de biblioteca que foram importados e usados no módulo).

A forma curinga de importação — @code{from module import *} — só é permitida no nível do módulo. Tentar usá-lo em definições de classe ou função irá levantar uma @ref{18d,,SyntaxError}.

@geindex relativa;import

Ao especificar qual módulo importar, você não precisa especificar o nome absoluto do módulo. Quando um módulo ou pacote está contido em outro pacote, é possível fazer uma importação relativa dentro do mesmo pacote superior sem precisar mencionar o nome do pacote. Usando pontos iniciais no módulo ou pacote especificado após @ref{12ee,,from} você pode especificar quão alto percorrer a hierarquia de pacotes atual sem especificar nomes exatos. Um ponto inicial significa o pacote atual onde o módulo que faz a importação existe. Dois pontos significam um nível de pacote acima. Três pontos são dois níveis acima, etc. Então, se você executar @code{from . import mod} de um módulo no pacote @code{pkg} então você acabará importando o @code{pkg.mod}. Se você executar @code{from ..subpkg2 import mod} de dentro de @code{pkg.subpkg1} você irá importar @code{pkg.subpkg2.mod}. A especificação para importações relativas está contida na seção @ref{2199,,Importações relativas ao pacote}.

@ref{518,,importlib.import_module()} é fornecida para dar suporte a aplicações que determinam dinamicamente os módulos a serem carregados.

Levanta um @ref{19fa,,evento de auditoria} @code{import} com os argumentos @code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}.

@menu
* Instruções future:: 

@end menu

@node Instruções future,,,A instrução import
@anchor{reference/simple_stmts future}@anchor{189}@anchor{reference/simple_stmts future-statements}@anchor{2250}
@subsubsection Instruções future


@geindex future;instrução
@geindex __future__;instrução future

Uma `instrução future' é uma diretiva para o compilador de que um determinado módulo deve ser compilado usando sintaxe ou semântica que estará disponível em uma versão futura especificada do Python, onde o recurso se tornará padrão.

A instrução future destina-se a facilitar a migração para versões futuras do Python que introduzem alterações incompatíveis na linguagem. Ele permite o uso dos novos recursos por módulo antes do lançamento em que o recurso se torna padrão.

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-future_stmt}@anchor{2234}future_stmt ::= "from" "__future__" "import" @ref{2251,,feature} ["as" @ref{2023,,identifier}]
                ("," @ref{2251,,feature} ["as" @ref{2023,,identifier}])*
                | "from" "__future__" "import" "(" @ref{2251,,feature} ["as" @ref{2023,,identifier}]
                ("," @ref{2251,,feature} ["as" @ref{2023,,identifier}])* [","] ")"
@anchor{reference/simple_stmts grammar-token-python-grammar-feature}@anchor{2251}feature     ::= @ref{2023,,identifier}
@end example

Uma instrução future deve aparecer perto do topo do módulo. As únicas linhas que podem aparecer antes de uma instrução future são:


@itemize *

@item 
o módulo docstring (se houver),

@item 
comentários,

@item 
linhas vazias e

@item 
outras instruções future.
@end itemize

O único recurso que requer o uso da instrução future é @code{annotations} (veja 
@geindex Propostas de Melhorias do Python; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}).

Todos os recursos históricos habilitados pela instrução future ainda são reconhecidos pelo Python 3. A lista inclui @code{absolute_import}, @code{division}, @code{generators}, @code{generator_stop}, @code{unicode_literals}, @code{print_function}, @code{nested_scopes} e @code{with_statement}. Eles são todos redundantes porque estão sempre habilitados e mantidos apenas para compatibilidade com versões anteriores.

Uma instrução future é reconhecida e tratada especialmente em tempo de compilação: as alterações na semântica das construções principais são frequentemente implementadas gerando código diferente. Pode até ser o caso de um novo recurso introduzir uma nova sintaxe incompatível (como uma nova palavra reservada), caso em que o compilador pode precisar analisar o módulo de maneira diferente. Tais decisões não podem ser adiadas até o tempo de execução.

Para qualquer versão, o compilador sabe quais nomes de recursos foram definidos e levanta um erro em tempo de compilação se uma instrução future contiver um recurso desconhecido.

A semântica do tempo de execução direto é a mesma de qualquer instrução de importação: existe um módulo padrão @ref{0,,__future__}, descrito posteriormente, e será importado da maneira usual no momento em que a instrução future for executada.

A semântica interessante do tempo de execução depende do recurso específico ativado pela instrução future.

Observe que não há nada de especial sobre a instrução:

@example
import __future__ [as name]
@end example

Essa não é uma instrução future; é uma instrução de importação comum sem nenhuma semântica especial ou restrições de sintaxe.

O código compilado por chamadas para as funções embutidas @ref{17f,,exec()} e @ref{192,,compile()} que ocorrem em um módulo @code{M} contendo uma instrução future usará, por padrão, a nova sintaxe ou semântica associada com a instrução future. Isso pode ser controlado por argumentos opcionais para @ref{192,,compile()} – veja a documentação dessa função para detalhes.

Uma instrução future tipada digitada em um prompt do interpretador interativo terá efeito no restante da sessão do interpretador. Se um interpretador for iniciado com a opção @ref{1523,,-i}, for passado um nome de script para ser executado e o script incluir uma instrução future, ela entrará em vigor na sessão interativa iniciada após a execução do script.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - De volta ao __future__

A proposta original para o mecanismo do __future__.
@end table


@node A instrução global,A instrução nonlocal,A instrução import,Instruções simples
@anchor{reference/simple_stmts global}@anchor{18a}@anchor{reference/simple_stmts the-global-statement}@anchor{2252}
@subsection A instrução @code{global}


@geindex instrução;global
@geindex global;nome;vinculação; ligação
@geindex @comma{} (vírgula);identificadores@comma{} lista de

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-global_stmt}@anchor{2235}global_stmt ::= "global" @ref{2023,,identifier} ("," @ref{2023,,identifier})*
@end example

A instrução @ref{18a,,global} faz com que os identificadores listados a serem interpretados como globais. Seria impossível atribuir a uma variável global sem @code{global}, embora variáveis livres possam se referir a globais sem serem declaradas globais.

A instrução @code{global} se aplica a todo o escopo atual (módulo, corpo da função ou definição de classe). Uma exceção @ref{18d,,SyntaxError} é levantada se uma variável for usada ou atribuída antes de sua declaração global no escopo.

No nível do módulo, todas as variáveis são globais, portanto, uma instrução @code{global} não tem efeito. No entanto, as variáveis ainda não devem ser usadas ou atribuídas antes de sua declaração @code{global}. Este requisito é flexibilizado no prompt interativo (@ref{16a,,REPL}).

@geindex função embutida;exec
@geindex função embutida;eval
@geindex função embutida;compile

`Nota do programador:' @ref{18a,,global} é uma diretiva para o analisador sintático. Aplica-se apenas ao código analisado ao mesmo tempo que a instrução @code{global}. Em particular, uma instrução @code{global} contida em uma string ou objeto código fornecido à função embutida @ref{17f,,exec()} não afeta o bloco de código `contendo' a chamada da função e o código contido em tal uma string não é afetada por instruções @code{global} no código que contém a chamada da função. O mesmo se aplica às funções @ref{180,,eval()} e @ref{192,,compile()}.

@node A instrução nonlocal,A instrução type,A instrução global,Instruções simples
@anchor{reference/simple_stmts nonlocal}@anchor{12ea}@anchor{reference/simple_stmts the-nonlocal-statement}@anchor{2253}
@subsection A instrução @code{nonlocal}


@geindex instrução;nonlocal
@geindex @comma{} (vírgula);identificadores@comma{} lista de

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-nonlocal_stmt}@anchor{2236}nonlocal_stmt ::= "nonlocal" @ref{2023,,identifier} ("," @ref{2023,,identifier})*
@end example

Quando a definição de uma função ou classe está aninhada (incluída) nas definições de outras funções, seus escopos não locais são os escopos locais das funções envolventes. A instrução @ref{12ea,,nonlocal} faz com que os identificadores listados se refiram a nomes previamente vinculados a escopos não locais. Ele permite que o código encapsulado religue esses identificadores não locais. Se um nome estiver ligado a mais de um escopo não local, a ligação mais próxima será usada. Se um nome não estiver vinculado a nenhum escopo não local, ou se não houver escopo não local, uma exceção @ref{18d,,SyntaxError} será levantada.

A instrução @ref{12ea,,nonlocal} se aplica a todo o escopo de uma função ou corpo da classe. Uma exceção @ref{18d,,SyntaxError} é levantada se uma variável for usada ou atribuída antes de sua declaração nonlocal no escopo.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3104

@item PEP 3104@footnote{https://peps.python.org/pep-3104/} - Acesso a nomes em escopos externos

A especificação para a instrução @ref{12ea,,nonlocal}.
@end table


`Nota do programador:' @ref{12ea,,nonlocal} é uma diretiva para o analisador sintático e se aplica apenas ao código analisado junto com ele. Veja a nota para a instrução @ref{18a,,global}.

@node A instrução type,,A instrução nonlocal,Instruções simples
@anchor{reference/simple_stmts the-type-statement}@anchor{2254}@anchor{reference/simple_stmts type}@anchor{438}
@subsection A instrução @code{type}


@geindex instrução;tipo

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-type_stmt}@anchor{2237}type_stmt ::= 'type' @ref{2023,,identifier} [@ref{2255,,type_params}] "=" @ref{21c8,,expression}
@end example

A instrução @code{type} declara um apelido de tipo, que é uma instância de @ref{455,,typing.TypeAliasType}.

Por exemplo, a instrução a seguir cria um apelido de tipo:

@example
type Point = tuple[float, float]
@end example

Este código é aproximadamente equivalente a:

@example
annotation-def VALUE_OF_Point():
    return tuple[float, float]
Point = typing.TypeAliasType("Point", VALUE_OF_Point())
@end example

@code{annotation-def} indica um @ref{188,,escopo de anotação}, que se comporta principalmente como uma função, mas com diversas pequenas diferenças.

O valor do apelido de tipo é avaliado no escopo de anotação. Ele não é avaliado quando o apelido de tipo é criado, mas somente quando o valor é acessado através do atributo @code{__value__} do apelido de tipo (veja @ref{457,,Avaliação preguiçosa}). Isso permite que o apelido de tipo se refira a nomes que ainda não estão definidos.

Apelidos de tipo podem se tornar genéricos adicionando uma @ref{2b3,,lista de parâmetros de tipo} após o nome. Veja @ref{456,,Apelidos de tipo genérico} para mais.

@code{type} é uma @ref{80f,,palavra reservada contextual}.


Adicionado na versão 3.12.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 695

@item PEP 695@footnote{https://peps.python.org/pep-0695/} - Sintaxe de parâmetros de tipo

Introduziu a instrução @code{type} e sintaxe para classes e funções genéricas.
@end table


@node Instruções compostas,Componentes de Alto Nível,Instruções simples,A Referência da Linguagem Python
@anchor{reference/compound_stmts doc}@anchor{2256}@anchor{reference/compound_stmts compound}@anchor{2257}@anchor{reference/compound_stmts compound-statements}@anchor{2258}@anchor{reference/compound_stmts translation-repo}@anchor{2259}
@section Instruções compostas


@geindex compound;instrução

Instruções compostas contém (grupos de) outras instruções; Elas afetam ou controlam a execução dessas outras instruções de alguma maneira. Em geral, instruções compostas abrangem múltiplas linhas, no entanto em algumas manifestações simples uma instrução composta inteira pode estar contida em uma linha.

As instruções @ref{2f3,,if}, @ref{1d82,,while} e @ref{2f2,,for} implementam construções  tradicionais de controle do fluxo de execução. @ref{6e9,,try} especifica tratadores de exceção e/ou código de limpeza para uma instrução ou grupo de instruções, enquanto a palavra reservada @ref{5d2,,with} permite a execução de código de inicialização e finalização em volta de um bloco de código. Definições de função e classe também são sintaticamente instruções compostas.

@geindex cláusula
@geindex conjunto (suite)
@geindex ; (ponto e vírgula)

Uma instrução composta consiste em uma ou mais “cláusulas”. Uma cláusula consiste em um cabeçalho e um “conjunto”. Os cabeçalhos das cláusulas de uma instrução composta específica estão todos no mesmo nível de indentação. Cada cabeçalho de cláusula começa com uma palavra reservada de identificação exclusiva e termina com dois pontos. Um conjunto é um grupo de instruções controladas por uma cláusula. Um conjunto pode ser uma ou mais instruções simples separadas por ponto e vírgula na mesma linha do cabeçalho, após os dois pontos do cabeçalho, ou pode ser uma ou mais instruções indentadas nas linhas subsequentes. Somente a última forma de conjunto pode conter instruções compostas aninhadas; o seguinte é ilegal, principalmente porque não ficaria claro a qual cláusula @ref{2f3,,if} a seguinte cláusula @ref{18c,,else} pertenceria:

@example
if test1: if test2: print(x)
@end example

Observe também que o ponto e vírgula é mais vinculado que os dois pontos neste contexto, de modo que no exemplo a seguir, todas ou nenhuma das chamadas @ref{fa9,,print()} são executadas:

@example
if x < y < z: print(x); print(y); print(z)
@end example

Resumindo:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-compound_stmt}@anchor{225a}compound_stmt ::= @ref{225b,,if_stmt}
                  | @ref{225c,,while_stmt}
                  | @ref{225d,,for_stmt}
                  | @ref{225e,,try_stmt}
                  | @ref{225f,,with_stmt}
                  | @ref{2260,,match_stmt}
                  | @ref{2261,,funcdef}
                  | @ref{2262,,classdef}
                  | @ref{2263,,async_with_stmt}
                  | @ref{2264,,async_for_stmt}
                  | @ref{2265,,async_funcdef}
@anchor{reference/compound_stmts grammar-token-python-grammar-suite}@anchor{2266}suite         ::= @ref{2267,,stmt_list} NEWLINE | NEWLINE INDENT @ref{2268,,statement}+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-statement}@anchor{2268}statement     ::= @ref{2267,,stmt_list} NEWLINE | @ref{225a,,compound_stmt}
@anchor{reference/compound_stmts grammar-token-python-grammar-stmt_list}@anchor{2267}stmt_list     ::= @ref{2226,,simple_stmt} (";" @ref{2226,,simple_stmt})* [";"]
@end example

@geindex token NEWLINE
@geindex token DEDENT
@geindex pendurado;else

Note que instruções sempre terminam em uma @code{NEWLINE} possivelmente seguida por uma @code{DEDENT}. Note também que cláusulas opcionais de continuação sempre começam com uma palavra reservada que não pode iniciar uma instrução, desta forma não há ambiguidades (o problema do “@ref{18c,,else} pendurado” é resolvido em Python obrigando que instruções @ref{2f3,,if} aninhadas tenham indentação)

A formatação das regras de gramática nas próximas seções põe cada cláusula em uma linha separada para as tornar mais claras.
@anchor{reference/compound_stmts if}@anchor{2f3}@anchor{reference/compound_stmts elif}@anchor{1d89}
@menu
* A instrução if:: 
* A instrução while:: 
* A instrução for:: 
* A instrução try:: 
* A instrução with:: 
* A instrução match:: 
* Definições de função:: 
* Definições de classe:: 
* Corrotinas: Corrotinas<2>. 
* Listas de parâmetros de tipo:: 

@end menu

@node A instrução if,A instrução while,,Instruções compostas
@anchor{reference/compound_stmts else}@anchor{18c}@anchor{reference/compound_stmts the-if-statement}@anchor{2269}
@subsection A instrução @code{if}


@geindex instrução;if
@geindex palavra reservada;elif
@geindex palavra reservada;else
@geindex ; (dois pontos);instrução composta

A instrução @ref{2f3,,if} é usada para execução condicional:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-if_stmt}@anchor{225b}if_stmt ::= "if" @ref{21b9,,assignment_expression} ":" @ref{2266,,suite}
            ("elif" @ref{21b9,,assignment_expression} ":" @ref{2266,,suite})*
            ["else" ":" @ref{2266,,suite}]
@end example

Ela seleciona exatamente um dos conjuntos `suite' avaliando as expressões `assigment_expression' uma por uma até que uma seja considerada verdadeira (veja a seção @ref{220d,,Operações booleanas} para a definição de verdadeiro e falso); então esse conjunto é executado (e nenhuma outra parte da instrução @ref{2f3,,if} é executada ou avaliada). Se todas as expressões forem falsas, o `suite' da cláusula @ref{18c,,else}, se presente, é executado.

@node A instrução while,A instrução for,A instrução if,Instruções compostas
@anchor{reference/compound_stmts the-while-statement}@anchor{226a}@anchor{reference/compound_stmts while}@anchor{1d82}
@subsection A instrução @code{while}


@geindex instrução;while
@geindex palavra reservada;else
@geindex laço;instrução
@geindex ; (dois pontos);instrução composta

A instrução @ref{1d82,,while} é usada para execução repetida desde que uma expressão seja verdadeira:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-while_stmt}@anchor{225c}while_stmt ::= "while" @ref{21b9,,assignment_expression} ":" @ref{2266,,suite}
               ["else" ":" @ref{2266,,suite}]
@end example

Isto testa repetidamente a expressão e, se for verdadeira, executa o primeiro conjunto; se a expressão for falsa (o que pode ser a primeira vez que ela é testada) o conjunto da cláusula @code{else}, se presente, é executado e o laço termina.

@geindex instrução;break
@geindex instrução;continue

Uma instrução @ref{ab8,,break} executada no primeiro conjunto termina o laço sem executar o conjunto da cláusula @code{else}. Uma instrução @ref{9d1,,continue} executada no primeiro conjunto ignora o resto do conjunto e volta a testar a expressão.

@node A instrução for,A instrução try,A instrução while,Instruções compostas
@anchor{reference/compound_stmts for}@anchor{2f2}@anchor{reference/compound_stmts the-for-statement}@anchor{226b}
@subsection A instrução @code{for}


@geindex instrução;for
@geindex palavra reservada;in
@geindex palavra reservada;else
@geindex alvo;lista
@geindex laço;instrução
@geindex objeto;sequência
@geindex ; (dois pontos);instrução composta

A instrução @ref{2f2,,for} é usada para iterar sobre os elementos de uma sequência (como uma string, tupla ou lista) ou outro objeto iterável:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-for_stmt}@anchor{225d}for_stmt ::= "for" @ref{21bb,,target_list} "in" @code{starred_list} ":" @ref{2266,,suite}
             ["else" ":" @ref{2266,,suite}]
@end example

A expressão @code{starred_list} é avaliada uma vez; deve produzir um objeto @ref{1268,,iterável}. Um @ref{1ac,,iterador} é criado para esse iterável. O primeiro item fornecido pelo iterador é então atribuído à lista de alvos usando as regras padrão para atribuições (veja @ref{2168,,Instruções de atribuição}), e o conjunto é executado. Isso se repete para cada item fornecido pelo iterador. Quando o iterador se esgota, o conjunto na cláusula @code{else}, se presente, é executado e o loop termina.

@geindex instrução;break
@geindex instrução;continue

Uma instrução @ref{ab8,,break} executada no primeiro conjunto termina o loop sem executar o conjunto da cláusula @code{else}. Uma instrução @ref{9d1,,continue} executada no primeiro conjunto pula o resto do conjunto e continua com o próximo item, ou com a cláusula @code{else} se não houver próximo item.

O laço for faz atribuições às variáveis na lista de destino. Isso substitui todas as atribuições anteriores a essas variáveis, incluindo aquelas feitas no conjunto do laço for:

@example
for i in range(10):
    print(i)
    i = 5             # não afeta o laço for, porque i será
                      # substituída pelo índice seguinte no range
@end example

@geindex função embutida;range

Os nomes na lista de destinos não são excluídos quando o laço termina, mas se a sequência estiver vazia, eles não serão atribuídos pelo laço. Dica: o tipo embutido @ref{94a,,range()} representa sequências aritméticas imutáveis de inteiros. Por exemplo, iterar @code{range(3)} sucessivamente produz 0, 1 e depois 2.


Alterado na versão 3.11: Elementos marcados com estrela agora são permitidos na lista de expressões.


@node A instrução try,A instrução with,A instrução for,Instruções compostas
@anchor{reference/compound_stmts the-try-statement}@anchor{226c}@anchor{reference/compound_stmts try}@anchor{6e9}
@subsection A instrução @code{try}


@geindex instrução;try
@geindex palavra reservada;except
@geindex palavra reservada;finally
@geindex palavra reservada;else
@geindex palavra reservada;as
@geindex ; (dois pontos);instrução composta

A instrução @code{try} especifica manipuladores de exceção e/ou código de limpeza para um grupo de instruções:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-try_stmt}@anchor{225e}try_stmt  ::= @ref{226d,,try1_stmt} | @ref{226e,,try2_stmt} | @ref{226f,,try3_stmt}
@anchor{reference/compound_stmts grammar-token-python-grammar-try1_stmt}@anchor{226d}try1_stmt ::= "try" ":" @ref{2266,,suite}
              ("except" [@ref{21c8,,expression} ["as" @ref{2023,,identifier}]] ":" @ref{2266,,suite})+
              ["else" ":" @ref{2266,,suite}]
              ["finally" ":" @ref{2266,,suite}]
@anchor{reference/compound_stmts grammar-token-python-grammar-try2_stmt}@anchor{226e}try2_stmt ::= "try" ":" @ref{2266,,suite}
              ("except" "*" @ref{21c8,,expression} ["as" @ref{2023,,identifier}] ":" @ref{2266,,suite})+
              ["else" ":" @ref{2266,,suite}]
              ["finally" ":" @ref{2266,,suite}]
@anchor{reference/compound_stmts grammar-token-python-grammar-try3_stmt}@anchor{226f}try3_stmt ::= "try" ":" @ref{2266,,suite}
              "finally" ":" @ref{2266,,suite}
@end example

Informações adicionais sobre exceções podem ser encontradas na seção @ref{2173,,Exceções}, e informações sobre como usar a instrução @ref{5ed,,raise} para gerar exceções podem ser encontradas na seção @ref{5ed,,A instrução raise}.

@menu
* Cláusula except:: 
* Cláusula except*:: 
* Cláusula else:: 
* Cláusula finally:: 

@end menu

@node Cláusula except,Cláusula except*,,A instrução try
@anchor{reference/compound_stmts except}@anchor{18b}@anchor{reference/compound_stmts except-clause}@anchor{2270}
@subsubsection Cláusula @code{except}


As cláusulas @code{except} especificam um ou mais manipuladores de exceção. Quando nenhuma exceção ocorre na cláusula @ref{6e9,,try}, nenhum manipulador de exceção é executado. Quando uma exceção ocorre no bloco @code{try}, uma busca por um manipulador de exceção é iniciada. Essa busca inspeciona as cláusulas @code{except} por vez até encontrar uma que corresponda à exceção. Uma cláusula @code{except} sem expressão, se presente, deve ser a última; ela corresponde a qualquer exceção.

Para uma cláusula @code{except} com uma expressão, a expressão deve ser avaliada como um tipo de exceção ou uma tupla de tipos de exceção. A exceção levantada corresponde a uma cláusula @code{except} cuja expressão é avaliada como a classe ou uma @ref{11f5,,classe base não virtual} do objeto exceção, ou como uma tupla que contém tal classe.

Se nenhuma cláusula @code{except} corresponder à exceção, a busca por um manipulador de exceção continua no código circundante e na pilha de invocação. @footnote{
A exceção é propagada para a pilha de invocação, a menos que haja uma cláusula @ref{9d2,,finally} que por acaso levante outra exceção. Essa nova exceção faz com que a antiga seja perdida.
}

Se a avaliação de uma expressão no cabeçalho de uma cláusula @code{except} levantar uma exceção, a busca original por um manipulador será cancelada e uma busca pela nova exceção será iniciada no código circundante e na pilha de chamadas (ela é tratada como se toda a instrução @ref{6e9,,try} levantasse a exceção).

@geindex as;cláusula except

Quando uma cláusula @code{except} correspondente é encontrada, a exceção é atribuída ao destino especificado após a palavra reservada @code{as} nessa cláusula @code{except}, se presente, e o conjunto da cláusula @code{except} é executado. Todas as cláusulas @code{except} devem ter um bloco executável. Quando o final deste bloco é atingido, a execução continua normalmente após toda a instrução @ref{6e9,,try}. (Isso significa que, se existirem dois manipuladores aninhados para a mesma exceção e a exceção ocorrer na cláusula @code{try} do manipulador interno, o manipulador externo não tratará a exceção.)

Quando uma exceção é atribuída usando @code{as target}, ela é limpa no final da cláusula @code{except}. É como se

@example
except E as N:
    foo
@end example

fosse traduzido para

@example
except E as N:
    try:
        foo
    finally:
        del N
@end example

Isso significa que a exceção deve ser atribuída a um nome diferente para poder ser referenciada após a cláusula @code{except}. As exceções são limpas porque, com o traceback (situação da pilha de execução) anexado a elas, formam um ciclo de referência com o quadro de pilha, mantendo todos os locais nesse quadro vivos até que ocorra a próxima coleta de lixo.

@geindex módulo;sys
@geindex objeto;traceback

Antes de um conjunto de cláusulas @code{except} ser executado, a exceção é armazenada no módulo @ref{d9,,sys}, onde pode ser acessada no corpo da cláusula @code{except} chamando @ref{68b,,sys.exception()}. Ao sair de um manipulador de exceções, a exceção armazenada no módulo @ref{d9,,sys} é redefinida para seu valor anterior:

@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 palavra reservada;except_star

@node Cláusula except*,Cláusula else,Cláusula except,A instrução try
@anchor{reference/compound_stmts except-star}@anchor{5b8}@anchor{reference/compound_stmts id2}@anchor{2271}
@subsubsection Cláusula @code{except*}


A cláusula @code{except*} especifica um ou mais manipuladores para grupos de exceções (instâncias de @ref{25f,,BaseExceptionGroup}). Uma instrução @ref{6e9,,try} pode ter cláusulas @ref{18b,,except} ou @code{except*}, mas não ambas. O tipo de exceção para correspondência é obrigatório no caso de @code{except*}, portanto, @code{except*:} resulta em um erro de sintaxe. O tipo é interpretado como no caso de @code{except}, mas a correspondência é realizada com as exceções contidas no grupo que está sendo tratado. Uma exceção @ref{2c3,,TypeError} é levantada se um tipo correspondente for uma subclasse de @code{BaseExceptionGroup}, pois isso teria uma semântica ambígua.

Quando um grupo de exceções é levantado dentro de um bloco try, cada cláusula @code{except*} o divide (consulte @ref{1670,,split()}) em subgrupos de exceções correspondentes e não correspondentes. Se o subgrupo correspondente não estiver vazio, ele se torna a exceção tratada (o valor retornado por @ref{68b,,sys.exception()}) e é atribuído ao alvo da cláusula @code{except*} (se houver). Em seguida, o corpo da cláusula @code{except*} é executado. Se o subgrupo não correspondente não estiver vazio, ele é processado pela próxima cláusula @code{except*} da mesma maneira. Isso continua até que todas as exceções do grupo tenham sido tratadas ou até que a última cláusula @code{except*} tenha sido executada.

Após a execução de todas as cláusulas @code{except*}, o grupo de exceções não tratadas é mesclado com quaisquer exceções que foram levantadas uma ou mais vezes em cláusulas @code{except*}. Esse grupo de exceções mesclado se propaga.

@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 "<doctest default[0]>", line 2, in <module>
  |     raise ExceptionGroup("eg",
  |         [ValueError(1), TypeError(2), OSError(3), OSError(4)])
  | ExceptionGroup: eg (1 sub-exception)
  +-+---------------- 1 ----------------
    | ValueError: 1
    +------------------------------------
@end example

Se a exceção levantada do bloco @ref{6e9,,try} não for um grupo de exceções e seu tipo corresponder a uma das cláusulas @code{except*}, ela será capturada e encapsulada por um grupo de exceções com uma string de mensagem vazia. Isso garante que o tipo do alvo @code{e} seja @ref{25f,,BaseExceptionGroup} de forma consistente:

@example
>>> try:
...     raise BlockingIOError
... except* BlockingIOError as e:
...     print(repr(e))
...
ExceptionGroup('@w{'}, (BlockingIOError(),))
@end example

@ref{ab8,,break}, @ref{9d1,,continue} e @ref{9d6,,return} não podem aparecer em uma cláusula @code{except*}.

@geindex palavra reservada;else
@geindex instrução;return
@geindex instrução;break
@geindex instrução;continue

@node Cláusula else,Cláusula finally,Cláusula except*,A instrução try
@anchor{reference/compound_stmts else-clause}@anchor{2272}@anchor{reference/compound_stmts except-else}@anchor{2273}
@subsubsection Cláusula @code{else}


A cláusula opcional @code{else} é executada se o fluxo de controle deixar o conjunto @ref{6e9,,try}, nenhuma exceção foi levantada e nenhuma instrução @ref{9d6,,return}, @ref{9d1,,continue} ou @ref{ab8,,break} foi executada. Exceções na cláusula @code{else} não são manipuladas pelas cláusulas @ref{18b,,except} precedentes.

@geindex palavra reservada;finally

@node Cláusula finally,,Cláusula else,A instrução try
@anchor{reference/compound_stmts finally}@anchor{9d2}@anchor{reference/compound_stmts finally-clause}@anchor{2274}
@subsubsection Cláusula @code{finally}


If @code{finally} is present, it specifies a ‘cleanup’ handler.  The
@ref{6e9,,try} clause is executed, including any @ref{18b,,except}
and @ref{2273,,else} clauses.
If an exception occurs in any of the clauses and is not handled,
the exception is temporarily saved.
The @code{finally} clause is executed.  If there is a saved exception
it is re-raised at the end of the @code{finally} clause.
If the @code{finally} clause raises another exception, the saved exception
is set as the context of the new exception.
If the @code{finally} clause executes a @ref{9d6,,return}, @ref{ab8,,break}
or @ref{9d1,,continue} statement, the saved exception is discarded:

@example
>>> def f():
...     try:
...         1/0
...     finally:
...         return 42
...
>>> f()
42
@end example

As informações de exceção não estão disponíveis para o programa durante a execução da cláusula @code{finally}.

@geindex instrução;return
@geindex instrução;break
@geindex instrução;continue

Quando uma instrução @ref{9d6,,return}, @ref{ab8,,break} ou @ref{9d1,,continue} é executada no conjunto @ref{6e9,,try} de uma instrução @code{try}…@code{finally}, a cláusula @code{finally} também é executada “na saída”.

O valor de retorno de uma função é determinado pela última instrução @ref{9d6,,return} executada. Como a cláusula @code{finally} sempre é executada, uma instrução @code{return} executada na cláusula @code{finally} sempre será a última executada:

@example
>>> def foo():
...     try:
...         return 'try'
...     finally:
...         return 'finally'
...
>>> foo()
'finally'
@end example


Alterado na versão 3.8: Antes do Python 3.8, uma instrução @ref{9d1,,continue} era ilegal na cláusula @code{finally} devido a um problema com a implementação.

@anchor{reference/compound_stmts with}@anchor{5d2}
@node A instrução with,A instrução match,A instrução try,Instruções compostas
@anchor{reference/compound_stmts as}@anchor{2275}@anchor{reference/compound_stmts the-with-statement}@anchor{2276}
@subsection A instrução @code{with}


@geindex instrução;with
@geindex palavra reservada;as
@geindex as;instrução with
@geindex @comma{} (vírgula);instrução with
@geindex ; (dois pontos);instrução composta

A instrução @ref{5d2,,with} envolve a execução de um bloco com métodos definidos por um gerenciador de contexto (veja a seção @ref{214c,,Gerenciadores de contexto da instrução with}). Isso permite que padrões comuns de uso de @ref{6e9,,try}…@ref{18b,,except}…@ref{9d2,,finally} sejam encapsulados para reutilização conveniente.

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt}@anchor{225f}with_stmt          ::= "with" ( "(" @ref{2277,,with_stmt_contents} ","? ")" | @ref{2277,,with_stmt_contents} ) ":" @ref{2266,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt_contents}@anchor{2277}with_stmt_contents ::= @ref{2278,,with_item} ("," @ref{2278,,with_item})*
@anchor{reference/compound_stmts grammar-token-python-grammar-with_item}@anchor{2278}with_item          ::= @ref{21c8,,expression} ["as" @ref{223b,,target}]
@end example

A execução da instrução @ref{5d2,,with} com um “item” ocorre da seguinte maneira:


@enumerate 

@item 
A expressão de contexto (a expressão fornecida em @ref{2278,,with_item}) é avaliada para obter um gerenciador de contexto.

@item 
O método @ref{5c8,,__enter__()} do gerenciador de contexto é carregado para uso posterior.

@item 
O método @ref{1344,,__exit__()} do gerenciador de contexto é carregado para uso posterior.

@item 
O método @ref{5c8,,__enter__()} do gerenciador de contexto é invocado.

@item 
Se um alvo foi incluído na instrução @ref{5d2,,with}, o valor de retorno de @ref{5c8,,__enter__()} é atribuído a esse alvo.

@cartouche
@quotation Nota 
A instrução @ref{5d2,,with} garante que, se o método @ref{5c8,,__enter__()} retornar sem erro, @ref{1344,,__exit__()} sempre será chamado. Assim, se ocorrer um erro durante a atribuição à lista de alvos, ele será tratado da mesma forma que um erro ocorrendo dentro do conjunto seria. Veja a etapa 7 abaixo.
@end quotation
@end cartouche

@item 
O conjunto `suite' é executado.

@item 
O método @ref{1344,,__exit__()} do gerenciador de contexto é invocado. Se uma exceção fez com que o conjunto fosse encerrado, seu tipo, valor e traceback são passados como argumentos para @ref{1344,,__exit__()}. Caso contrário, três argumentos @ref{675,,None} são fornecidos.

Se o conjunto foi encerrado devido a uma exceção, e o valor de retorno do método @ref{1344,,__exit__()} for falso, a exceção é levantada novamente. Se o valor de retorno era verdadeiro, a exceção é suprimida, e a execução continua com a instrução após a instrução @ref{5d2,,with}.

Se o conjunto foi encerrado por qualquer motivo diferente de uma exceção, o valor de retorno de @ref{1344,,__exit__()} é ignorado e a execução prossegue no local normal para o tipo de saída que foi gerada.
@end enumerate

O seguinte código:

@example
with EXPRESSION as TARGET:
    SUITE
@end example

é semanticamente equivalente a:

@example
manager = (EXPRESSION)
enter = type(manager).__enter__
exit = type(manager).__exit__
value = enter(manager)
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not exit(manager, *sys.exc_info()):
        raise
finally:
    if not hit_except:
        exit(manager, None, None, None)
@end example

Com mais de um item, os gerenciadores de contexto são processados como se várias instruções @ref{5d2,,with} estivessem aninhadas:

@example
with A() as a, B() as b:
    SUITE
@end example

é semanticamente equivalente a:

@example
with A() as a:
    with B() as b:
        SUITE
@end example

Você também pode escrever gerenciadores de contexto multi-item em várias linhas se os itens estiverem entre parênteses. Por exemplo:

@example
with (
    A() as a,
    B() as b,
):
    SUITE
@end example


Alterado na versão 3.1: Suporte para múltiplas expressões de contexto.



Alterado na versão 3.10: Suporte para usar parênteses de agrupamento para dividir a instrução em várias linhas.



@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - A instrução “with”

A especificação, o histórico e os exemplos para a instrução Python @ref{5d2,,with}.
@end table

@anchor{reference/compound_stmts match}@anchor{810}
@node A instrução match,Definições de função,A instrução with,Instruções compostas
@anchor{reference/compound_stmts case}@anchor{2279}@anchor{reference/compound_stmts the-match-statement}@anchor{227a}
@subsection A instrução @code{match}


@geindex instrução;match
@geindex palavra reservada;case
@geindex correspondência de padrões
@geindex palavra reservada;if
@geindex palavra reservada;as
@geindex match;case
@geindex as;instrução match
@geindex ; (dois pontos);instrução composta


Adicionado na versão 3.10.


A instrução match é usada para correspondência de padrões. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-match_stmt}@anchor{2260}match_stmt   ::= 'match' @ref{227b,,subject_expr} ":" NEWLINE INDENT @ref{227c,,case_block}+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-subject_expr}@anchor{227b}subject_expr ::= @code{star_named_expression} "," @code{star_named_expressions}?
                 | @code{named_expression}
@anchor{reference/compound_stmts grammar-token-python-grammar-case_block}@anchor{227c}case_block   ::= 'case' @ref{227d,,patterns} [@ref{227e,,guard}] ":" @code{block}
@end example

@cartouche
@quotation Nota 
Esta seção usa aspas simples para denotar @ref{80f,,palavras reservadas contextuais}.
@end quotation
@end cartouche

A correspondência de padrões aceita um padrão como entrada (seguindo @code{case}) e um valor de sujeito (seguindo @code{match}). O padrão (que pode conter subpadrões) é correspondido ao valor de assunto. Os resultados são:


@itemize *

@item 
Um sucesso ou falha de correspondência (também chamado de sucesso ou falha de padrão).

@item 
Possível vinculação de valores correspondentes a um nome. Os pré-requisitos para isso são discutidos mais adiante.
@end itemize

As palavras reservadas @code{match} e @code{case} são @ref{80f,,palavras reservadas contextuais}.


@subsubheading Ver também



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Structural Pattern Matching: Specification

@item 
@geindex Propostas de Melhorias do Python; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} – Correspondência de padrões estruturais: Tutorial
@end itemize


@menu
* Visão Geral:: 
* Guards:: 
* Blocos irrefutáveis de case:: 
* Padrões:: 

@end menu

@node Visão Geral,Guards,,A instrução match
@anchor{reference/compound_stmts overview}@anchor{227f}
@subsubsection Visão Geral


Aqui está uma visão geral do fluxo lógico de uma instrução match:


@enumerate 

@item 
A expressão de sujeito @code{subject_expr} é avaliada e um valor de sujeito resultante é obtido. Se a expressão de sujeito contiver uma vírgula, uma tupla é construída usando @ref{2280,,as regras padrão}.

@item 
Cada padrão em um @code{case_block} é tentado para corresponder ao valor de sujeito. As regras específicas para sucesso ou falha são descritas abaixo. A tentativa de correspondência também pode vincular alguns ou todos os nomes autônomos dentro do padrão. As regras precisas de vinculação de padrão variam por tipo de padrão e são especificadas abaixo. `As vinculações de nome feitas durante uma correspondência de padrão bem-sucedida sobrevivem ao bloco executado e podem ser usadas após a instrução match'.

@cartouche
@quotation Nota 
Durante correspondências de padrões com falha, alguns subpadrões podem ter sucesso. Não confie em vinculações sendo feitas para uma correspondência com falha. Por outro lado, não confie em variáveis permanecendo inalteradas após uma correspondência com falha. O comportamento exato depende da implementação e pode variar. Esta é uma decisão intencional feita para permitir que diferentes implementações adicionem otimizações.
@end quotation
@end cartouche

@item 
Se o padrão for bem-sucedido, o `guard' correspondente (se presente) é avaliado. Neste caso, todas as vinculações de nome são garantidas como tendo acontecido.


@itemize *

@item 
Se o `guard' for avaliado como verdadeiro ou estiver ausente, o @code{block} dentro de @code{case_block} será executado.

@item 
Caso contrário, o próximo @code{case_block} será tentado conforme descrito acima.

@item 
Se não houver mais blocos de caso, a instrução match será concluída.
@end itemize
@end enumerate

@cartouche
@quotation Nota 
Os usuários geralmente nunca devem confiar em um padrão sendo avaliado. Dependendo da implementação, o interpretador pode armazenar valores em cache ou usar outras otimizações que pulam avaliações repetidas.
@end quotation
@end cartouche

Um exemplo de instrução match:

@example
>>> flag = False
>>> match (100, 200):
...    case (100, 300):  # Não corresponde: 200 != 300
...        print('Case 1')
...    case (100, 200) if flag:  # Corresponde com sucesso, mas o guard falha...
        print('Case 2')
...    case (100, y):  # Corresponde e vincula y a 200
...        print(f'Case 3, y: @{y@}')
...    case _:  # Padrão não testado
...        print('Case 4, I match anything!')
...
Case 3, y: 200
@end example

Neste caso, @code{if flag} é um `guard'. Leia mais sobre isso na próxima seção.

@node Guards,Blocos irrefutáveis de case,Visão Geral,A instrução match
@anchor{reference/compound_stmts guards}@anchor{2281}
@subsubsection Guards


@geindex guard

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-guard}@anchor{227e}guard ::= "if" @code{named_expression}
@end example

Um @code{guard} (que faz parte do @code{case}) deve ter sucesso para que o código dentro do bloco @code{case} seja executado. Ele assume a forma: @ref{2f3,,if} seguido por uma expressão.

O fluxo lógico de um bloco @code{case} com um @code{guard} é o seguinte:


@enumerate 

@item 
Verifique se o padrão no bloco @code{case} foi bem-sucedido. Se o padrão falhou, o @code{guard} não é avaliado e o próximo bloco @code{case} é verificado.

@item 
Se o padrão for bem-sucedido, avalia o @code{guard}.


@itemize *

@item 
Se a condição @code{guard} for avaliada como verdadeira, o bloco de caso será selecionado.

@item 
Se a condição @code{guard} for avaliada como falsa, o bloco de caso não será selecionado.

@item 
Se o @code{guard} levantar uma exceção durante a avaliação, a exceção surgirá.
@end itemize
@end enumerate

Guards podem ter efeitos colaterais, pois são expressões. A avaliação de guards deve prosseguir do primeiro ao último bloco de caso, um de cada vez, pulando blocos de caso cujos padrões não são todos bem-sucedidos. (Isto é, a avaliação de guardas deve acontecer em ordem.) A avaliação de guards deve parar quando um bloco de caso for selecionado.

@node Blocos irrefutáveis de case,Padrões,Guards,A instrução match
@anchor{reference/compound_stmts irrefutable-case}@anchor{2282}@anchor{reference/compound_stmts irrefutable-case-blocks}@anchor{2283}
@subsubsection Blocos irrefutáveis de case


@geindex bloco irrefutável de case
@geindex bloco de case

Um bloco irrefutável de case é um bloco de case que corresponde a qualquer valor. Uma instrução match pode ter no máximo um bloco irrefutável de case, e ele deve ser o último.

Um bloco de case é considerado irrefutável se não tiver guard e seu padrão for irrefutável. Um padrão é considerado irrefutável se pudermos provar somente por sua sintaxe que ele sempre terá sucesso. Somente os seguintes padrões são irrefutáveis:


@itemize *

@item 
@ref{2284,,Padrões AS} cujo lado esquerdo é irrefutável

@item 
@ref{2285,,Padrões OR} contendo pelo menos um padrão irrefutável

@item 
@ref{2286,,Padrões de captura}

@item 
@ref{811,,Padrões curingas}

@item 
padrões irrefutáveis entre parêteses
@end itemize

@node Padrões,,Blocos irrefutáveis de case,A instrução match
@anchor{reference/compound_stmts patterns}@anchor{2287}
@subsubsection Padrões


@geindex padrões !
@geindex padrão AS@comma{} padrão OR@comma{} padrão de captura@comma{} padrão curinga

@cartouche
@quotation Nota 
Esta seção usa notações de gramática para além do padrão de EBNF:


@itemize *

@item 
a notação @code{SEP.RULE+} é uma abreviação para @code{RULE (SEP RULE)*}

@item 
a notação @code{!RULE} é uma abreviação para uma asserção de negação antecipada.
@end itemize
@end quotation
@end cartouche

Esta é a sintaxe de nível superior para @code{patterns} (padrões):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-patterns}@anchor{227d}patterns       ::= @ref{2288,,open_sequence_pattern} | @ref{2289,,pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern}@anchor{2289}pattern        ::= @ref{228a,,as_pattern} | @ref{228b,,or_pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-closed_pattern}@anchor{228c}closed_pattern ::= | @ref{228d,,literal_pattern}
                   | @ref{228e,,capture_pattern}
                   | @ref{228f,,wildcard_pattern}
                   | @ref{2290,,value_pattern}
                   | @ref{2291,,group_pattern}
                   | @ref{2292,,sequence_pattern}
                   | @ref{2293,,mapping_pattern}
                   | @ref{2294,,class_pattern}
@end example

As descrições abaixo incluirão uma descrição “em termos simples” de o que o padrão faz para fins ilustrativos (créditos a Raymond Hettinger pelo documento que inspirou a maioria das descrições). Note que essas descrições são puramente para fins ilustrativos, e `não necessariamente' refletem a implementação subjacente.  Além disso, elas não cobrem todas as formas válidas.

@menu
* Padrões OR:: 
* Padrões AS:: 
* Padrões literais:: 
* Padrões de captura:: 
* Padrões curingas:: 
* Padrões de valor:: 
* Padrões de grupo:: 
* Padrões de sequência:: 
* Padrões de mapeamento:: 
* Padrões de classe:: 

@end menu

@node Padrões OR,Padrões AS,,Padrões
@anchor{reference/compound_stmts id3}@anchor{2295}@anchor{reference/compound_stmts or-patterns}@anchor{2285}
@subsubsection Padrões OR


Um padrão OR é composto por dois ou mais padrões separados por barras verticais @code{|}.  Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-or_pattern}@anchor{228b}or_pattern ::= "|".@ref{228c,,closed_pattern}+
@end example

Somente o último subpadrão pode ser @ref{2282,,irrefutável}, e cada subpadrão deve vincular o mesmo conjunto de nomes para evitar ambiguidades.

Um padrão OR testa a correspondência de cada um dos seus subpadrões, em sequência, ao valor do sujeito, até que uma delas seja bem sucedida.  O padrão OR é então considerado bem sucedido.  Caso contrário, se todas elas falharam, o padrão OR falhou.

Em termos simples, @code{P1 | P2 | ...} vai tentar fazer corresponder @code{P1}, se falhar vai tentar @code{P2}, declarando sucesso se houver sucesso em qualquer uma das tentativas, e falhando caso contrário.

@node Padrões AS,Padrões literais,Padrões OR,Padrões
@anchor{reference/compound_stmts as-patterns}@anchor{2284}@anchor{reference/compound_stmts id4}@anchor{2296}
@subsubsection Padrões AS


Um padrão AS corresponde a um padrão OR à esquerda da palavra reservada @ref{2275,,as} de um assunto. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-as_pattern}@anchor{228a}as_pattern ::= @ref{228b,,or_pattern} "as" @ref{228e,,capture_pattern}
@end example

Se o padrão OR falhar, o padrão AS falhará. Caso contrário, o padrão AS vincula o assunto ao nome à direita da palavra-chave as e obtém sucesso. @code{capture_pattern} não pode ser um @code{_}.

Em termos simples, @code{P as NAME} corresponderá a @code{P} e, em caso de sucesso, definirá @code{NAME = <assunto>}.

@node Padrões literais,Padrões de captura,Padrões AS,Padrões
@anchor{reference/compound_stmts id5}@anchor{2297}@anchor{reference/compound_stmts literal-patterns}@anchor{2298}
@subsubsection Padrões literais


Um padrão literal corresponde à maioria dos @ref{202f,,literais} em Python. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-literal_pattern}@anchor{228d}literal_pattern ::= @ref{2299,,signed_number}
                    | @ref{2299,,signed_number} "+" NUMBER
                    | @ref{2299,,signed_number} "-" NUMBER
                    | @code{strings}
                    | "None"
                    | "True"
                    | "False"
@anchor{reference/compound_stmts grammar-token-python-grammar-signed_number}@anchor{2299}signed_number   ::= ["-"] NUMBER
@end example

A regra @code{strings} e o token @code{NUMBER} são definidos na @ref{229a,,gramática Python padrão}. Strings entre aspas triplas são suportadas. Strings brutas e strings de bytes são suportadas. @ref{9b1,,f-strings} não são suportadas.

As formas @code{signed_number '+' NUMBER} e @code{signed_number '-' NUMBER} são para expressar @ref{2068,,números complexos}; elas requerem um número real à esquerda e um número imaginário à direita. Por exemplo, @code{3 + 4j}.

Em termos simples, @code{LITERAL} terá sucesso somente se @code{<assunto> == LITERAL}. Para os singletons @code{None}, @code{True} e @code{False}, o operador @ref{2f5,,is} é usado.

@node Padrões de captura,Padrões curingas,Padrões literais,Padrões
@anchor{reference/compound_stmts capture-patterns}@anchor{2286}@anchor{reference/compound_stmts id6}@anchor{229b}
@subsubsection Padrões de captura


Um padrão de captura vincula o valor do assunto a um nome. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-capture_pattern}@anchor{228e}capture_pattern ::= !'_' NAME
@end example

Um único sublinhado @code{_} não é um padrão de captura (é o que @code{!'_'} expressa). Em vez disso, ele é tratado como um @ref{228f,,wildcard_pattern}.

Em um determinado padrão, um determinado nome só pode ser vinculado uma vez. Por exemplo, @code{case x, x: ...} é inválido enquanto @code{case [x] | x: ...} é permitido.

Os padrões de captura sempre são bem-sucedidos. A vinculação segue regras de escopo estabelecidas pelo operador de expressão de atribuição na 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}; o nome se torna uma variável local no escopo de função de contenção mais próximo, a menos que haja uma instrução @ref{18a,,global} ou @ref{12ea,,nonlocal} aplicável.

Em termos simples, @code{NAME} sempre terá sucesso e definirá @code{NAME = <assunto>}.

@node Padrões curingas,Padrões de valor,Padrões de captura,Padrões
@anchor{reference/compound_stmts id7}@anchor{229c}@anchor{reference/compound_stmts wildcard-patterns}@anchor{811}
@subsubsection Padrões curingas


Um padrão curinga sempre tem sucesso (corresponde a qualquer coisa) e não vincula nenhum nome. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-wildcard_pattern}@anchor{228f}wildcard_pattern ::= '_'
@end example

@code{_} é uma @ref{80f,,palavra reservada contextual} dentro de qualquer padrão, mas somente dentro de padrões. É um identificador, como de costume, mesmo dentro de expressões de assunto @code{match}s, @code{guard}s e blocos @code{case}.

Em termos simples, @code{_} sempre terá sucesso.

@node Padrões de valor,Padrões de grupo,Padrões curingas,Padrões
@anchor{reference/compound_stmts id8}@anchor{229d}@anchor{reference/compound_stmts value-patterns}@anchor{229e}
@subsubsection Padrões de valor


Um padrão de valor representa um valor nomeado em Python. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-value_pattern}@anchor{2290}value_pattern ::= @ref{229f,,attr}
@anchor{reference/compound_stmts grammar-token-python-grammar-attr}@anchor{229f}attr          ::= @ref{22a0,,name_or_attr} "." NAME
@anchor{reference/compound_stmts grammar-token-python-grammar-name_or_attr}@anchor{22a0}name_or_attr  ::= @ref{229f,,attr} | NAME
@end example

O nome pontilhado no padrão é pesquisado usando as @ref{216b,,regras de resolução de nomes} padrão do Python. O padrão é bem-sucedido se o valor encontrado for comparado igual ao valor do assunto (usando o operador de igualdade @code{==}).

Em termos simples, @code{NAME1.NAME2} terá sucesso somente se @code{<assunto> == NAME1.NAME2}

@cartouche
@quotation Nota 
Se o mesmo valor ocorrer várias vezes na mesma instrução match, o interpretador pode armazenar em cache o primeiro valor encontrado e reutilizá-lo em vez de repetir a mesma pesquisa. Esse cache é estritamente vinculado a uma determinada execução de uma determinada instrução match.
@end quotation
@end cartouche

@node Padrões de grupo,Padrões de sequência,Padrões de valor,Padrões
@anchor{reference/compound_stmts group-patterns}@anchor{22a1}@anchor{reference/compound_stmts id9}@anchor{22a2}
@subsubsection Padrões de grupo


Um padrão de grupo permite que os usuários adicionem parênteses em torno de padrões para enfatizar o agrupamento pretendido. Caso contrário, não há sintaxe adicional. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-group_pattern}@anchor{2291}group_pattern ::= "(" @ref{2289,,pattern} ")"
@end example

Em termos simples, @code{(P)} tem o mesmo efeito que @code{P}.

@node Padrões de sequência,Padrões de mapeamento,Padrões de grupo,Padrões
@anchor{reference/compound_stmts id10}@anchor{22a3}@anchor{reference/compound_stmts sequence-patterns}@anchor{22a4}
@subsubsection Padrões de sequência


Um padrão de sequência contém vários subpadrões a serem correspondidos com elementos de sequência. A sintaxe é similar ao desempacotamento de uma lista ou tupla.

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-sequence_pattern}@anchor{2292}sequence_pattern       ::= "[" [@ref{22a5,,maybe_sequence_pattern}] "]"
                           | "(" [@ref{2288,,open_sequence_pattern}] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-open_sequence_pattern}@anchor{2288}open_sequence_pattern  ::= @ref{22a6,,maybe_star_pattern} "," [@ref{22a5,,maybe_sequence_pattern}]
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_sequence_pattern}@anchor{22a5}maybe_sequence_pattern ::= ",".@ref{22a6,,maybe_star_pattern}+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_star_pattern}@anchor{22a6}maybe_star_pattern     ::= @ref{22a7,,star_pattern} | @ref{2289,,pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-star_pattern}@anchor{22a7}star_pattern           ::= "*" (@ref{228e,,capture_pattern} | @ref{228f,,wildcard_pattern})
@end example

Não há diferença se parênteses ou colchetes são usados para padrões de sequência (por exemplo, @code{(...)} vs @code{[...]}).

@cartouche
@quotation Nota 
Um único padrão entre parênteses sem uma vírgula final (por exemplo, @code{(3 | 4)}) é um @ref{22a1,,padrão de grupo}. Enquanto um único padrão entre colchetes (por exemplo, @code{[3 | 4]}) ainda é um padrão de sequência.
@end quotation
@end cartouche

No máximo um subpadrão de estrela pode estar em um padrão de sequência. O subpadrão de estrela pode ocorrer em qualquer posição. Se nenhum subpadrão de estrela estiver presente, o padrão de sequência é um padrão de sequência de comprimento fixo; caso contrário, é um padrão de sequência de comprimento variável.

A seguir está o fluxo lógico para corresponder um padrão de sequência com um valor de assunto:


@enumerate 

@item 
Se o valor do assunto não for uma sequência @footnote{
Na correspondência de padrões, uma sequência é definida como uma das seguintes:


@itemize *

@item 
uma classe que herda de @ref{1204,,collections.abc.Sequence}

@item 
uma classe Python que foi registrada como @ref{1204,,collections.abc.Sequence}

@item 
uma classe embutida que tem seu bit @ref{19e4,,Py_TPFLAGS_SEQUENCE} (CPython) definido

@item 
uma classe que herda de qualquer uma das anteriores
@end itemize

As seguintes classes de biblioteca padrão são sequências:


@itemize *

@item 
@ref{1a0,,array.array}

@item 
@ref{5dc,,collections.deque}

@item 
@ref{611,,list}

@item 
@ref{2eb,,memoryview}

@item 
@ref{94a,,range}

@item 
@ref{370,,tuple}
@end itemize

@cartouche
@quotation Nota 
Valores de assunto do tipo @code{str}, @code{bytes} e @code{bytearray} não correspondem aos padrões de sequência.
@end quotation
@end cartouche
}, o padrão de sequência falhará.

@item 
Se o valor do assunto for uma instância de @code{str}, @code{bytes} ou @code{bytearray}, o padrão de sequência falhará.

@item 
As etapas subsequentes dependem se o padrão de sequência é fixo ou de comprimento variável.

Se o padrão de sequência for de comprimento fixo:


@enumerate 

@item 
Se o comprimento da sequência do assunto não for igual ao número de subpadrões, o padrão da sequência falha

@item 
Subpadrões no padrão de sequência são correspondidos aos seus itens correspondentes na sequência de assunto da esquerda para a direita. A correspondência para assim que um subpadrão falha. Se todos os subpadrões tiverem sucesso em corresponder ao seu item correspondente, o padrão de sequência é bem-sucedido.
@end enumerate

Caso contrário, se o padrão de sequência for de comprimento variável:


@enumerate 

@item 
Se o comprimento da sequência do assunto for menor que o número de subpadrões não-estrela, o padrão da sequência falha.

@item 
Os principais subpadrões não estelares são correspondidos aos seus itens correspondentes, como nas sequências de comprimento fixo.

@item 
Se a etapa anterior for bem-sucedida, o subpadrão estrela corresponde a uma lista formada pelos itens de assunto restantes, excluindo os itens restantes correspondentes aos subpadrões não-estrela que seguem o subpadrão estrela.

@item 
Os subpadrões não-estrela restantes são correspondidos aos seus itens de assunto correspondentes, como em uma sequência de comprimento fixo.
@end enumerate

@cartouche
@quotation Nota 
O comprimento da sequência de assunto é obtido via @ref{62e,,len()} (ou seja, via protocolo @code{__len__()}). Esse comprimento pode ser armazenado em cache pelo interpretador de forma similar a @ref{229e,,padrões de valor}.
@end quotation
@end cartouche
@end enumerate

Em termos simples, @code{[P1, P2, P3,} … @code{, P<N>]} corresponde somente se tudo o seguinte acontecer:


@itemize *

@item 
verifica se @code{<subject>} é uma sequência

@item 
@code{len(subject) == <N>}

@item 
@code{P1} corresponde a @code{<subject>[0]} (observe que esta correspondência também pode vincular nomes)

@item 
@code{P2} corresponde a @code{<subject>[1]} (observe que esta correspondência também pode vincular nomes)

@item 
… e assim por diante para o padrão/elemento correspondente.
@end itemize

@node Padrões de mapeamento,Padrões de classe,Padrões de sequência,Padrões
@anchor{reference/compound_stmts id12}@anchor{22a8}@anchor{reference/compound_stmts mapping-patterns}@anchor{22a9}
@subsubsection Padrões de mapeamento


Um padrão de mapeamento contém um ou mais padrões de chave-valor. A sintaxe é similar à construção de um dicionário. Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-mapping_pattern}@anchor{2293}mapping_pattern     ::= "@{" [@ref{22aa,,items_pattern}] "@}"
@anchor{reference/compound_stmts grammar-token-python-grammar-items_pattern}@anchor{22aa}items_pattern       ::= ",".@ref{22ab,,key_value_pattern}+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-key_value_pattern}@anchor{22ab}key_value_pattern   ::= (@ref{228d,,literal_pattern} | @ref{2290,,value_pattern}) ":" @ref{2289,,pattern}
                        | @ref{22ac,,double_star_pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-double_star_pattern}@anchor{22ac}double_star_pattern ::= "**" @ref{228e,,capture_pattern}
@end example

No máximo um padrão de estrela dupla pode estar em um padrão de mapeamento. O padrão de estrela dupla deve ser o último subpadrão no padrão de mapeamento.

Chaves duplicadas em padrões de mapeamento não são permitidas. Chaves literais duplicadas levantarão um @ref{18d,,SyntaxError}. Duas chaves que de outra forma têm o mesmo valor levantarão @ref{202,,ValueError} em tempo de execução.

A seguir está o fluxo lógico para comparar um padrão de mapeamento com um valor de assunto:


@enumerate 

@item 
Se o valor do assunto não for um mapeamento @footnote{
Na correspondência de padrões, um mapeamento é definido como uma das seguintes:


@itemize *

@item 
uma classe que herda de @ref{8d0,,collections.abc.Mapping}

@item 
uma classe Python que foi registrada como @ref{8d0,,collections.abc.Mapping}

@item 
uma classe embutida que tem seu bit @ref{19e3,,Py_TPFLAGS_MAPPING} (CPython) definido

@item 
uma classe que herda de qualquer uma das anteriores
@end itemize

As classes de biblioteca padrão @ref{256,,dict} e @ref{46d,,types.MappingProxyType} são mapeamentos.
}, o padrão de mapeamento falhará.

@item 
Se cada chave fornecida no padrão de mapeamento estiver presente no mapeamento de assunto, e o padrão para cada chave corresponder ao item correspondente do mapeamento de assunto, o padrão de mapeamento será bem-sucedido.

@item 
Se chaves duplicadas forem detectadas no padrão de mapeamento, o padrão será considerado inválido. Uma exceção @ref{18d,,SyntaxError} é levantada para valores literais duplicados; ou @ref{202,,ValueError} para chaves nomeadas do mesmo valor.
@end enumerate

@cartouche
@quotation Nota 
Os pares de chave-valor são correspondidos usando o formato de dois argumentos do método @code{get()} do assunto do mapeamento. Os pares de chave-valor correspondidos já devem estar presentes no mapeamento e não devem ser criados em tempo de uso via @ref{11fd,,__missing__()} ou @ref{283,,__getitem__()}.
@end quotation
@end cartouche

Em termos simples, @code{@{KEY1: P1, KEY2: P2, ... @}} corresponde somente se tudo o seguinte acontecer:


@itemize *

@item 
verifica se @code{<assunto>} é um mapeamento

@item 
@code{KEY1 in <assunto>}

@item 
@code{P1} corresponde a @code{<assunto>[KEY1]}

@item 
… e assim por diante para o par KEY/elemento correspondente.
@end itemize

@node Padrões de classe,,Padrões de mapeamento,Padrões
@anchor{reference/compound_stmts class-patterns}@anchor{22ad}@anchor{reference/compound_stmts id14}@anchor{22ae}
@subsubsection Padrões de classe


Um padrão de classe representa uma classe e seus argumentos nomeados e posicionais (se houver). Sintaxe:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-class_pattern}@anchor{2294}class_pattern       ::= @ref{22a0,,name_or_attr} "(" [@ref{22af,,pattern_arguments} ","?] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern_arguments}@anchor{22af}pattern_arguments   ::= @ref{22b0,,positional_patterns} ["," @ref{22b1,,keyword_patterns}]
                        | @ref{22b1,,keyword_patterns}
@anchor{reference/compound_stmts grammar-token-python-grammar-positional_patterns}@anchor{22b0}positional_patterns ::= ",".@ref{2289,,pattern}+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_patterns}@anchor{22b1}keyword_patterns    ::= ",".@ref{22b2,,keyword_pattern}+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_pattern}@anchor{22b2}keyword_pattern     ::= NAME "=" @ref{2289,,pattern}
@end example

O mesmo argumento nomeado não deve ser repetido em padrões de classe.

A seguir está o fluxo lógico para corresponder a um padrão de classe com um valor de assunto:


@enumerate 

@item 
Se @code{name_or_attr} não for uma instância do tipo embutido @ref{d6b,,type} , levanta @ref{2c3,,TypeError}.

@item 
Se o valor do assunto não for uma instância de @code{name_or_attr} (testado via @ref{442,,isinstance()}), o padrão de classe falhará.

@item 
Se nenhum argumento de padrão estiver presente, o padrão é bem-sucedido. Caso contrário, as etapas subsequentes dependem se os padrões de argumento posicional ou nomeado estão presentes.

Para vários tipos embutidos (especificados abaixo), um único subpadrão posicional é aceito, o qual corresponderá a todo o assunto; para esses tipos, os padrões de argumentos nomeados também funcionam como para outros tipos.

Se apenas padrões de argumentos nomeados estiverem presentes, eles serão processados da seguinte forma, um por um:


@enumerate 

@item 
A palavra reservada é procurada como um atributo no assunto.


@itemize *

@item 
Se isso levantar uma exceção diferente de @ref{34b,,AttributeError}, a exceção será exibida.

@item 
Se isso levantar @ref{34b,,AttributeError}, o padrão de classe falhou.

@item 
Caso contrário, o subpadrão associado ao padrão de argumento nomeado é correspondido ao valor de atributo do sujeito. Se isso falhar, o padrão de classe falha; se isso for bem-sucedido, a correspondência prossegue para o próximo argumento nomeado.
@end itemize

@item 
Se todos os padrões de argumento nomeado forem bem-sucedidos, o padrão de classe será bem-sucedido.
@end enumerate

Se houver algum padrão posicional presente, ele será convertido em padrões de argumento nomeado usando o atributo @ref{1a01,,__match_args__} na classe @code{name_or_attr} antes da correspondência:


@enumerate 

@item 
O equivalente de @code{getattr(cls, "__match_args__", ())} é chamado.


@itemize *

@item 
Se isso levantar uma exceção, a exceção surgirá.

@item 
Se o valor retornado não for uma tupla, a conversão falhará e @ref{2c3,,TypeError} será levantada.

@item 
Se houver mais padrões posicionais do que @code{len(cls.__match_args__)}, @ref{2c3,,TypeError} será levantada.

@item 
Caso contrário, o padrão posicional @code{i} é convertido em um padrão de argumento nomeado usando @code{__match_args__[i]} como argumento nomeado. @code{__match_args__[i]} deve ser uma string; caso contrário, @ref{2c3,,TypeError} é levantada.

@item 
Se houver argumentos nomeados duplicados, @ref{2c3,,TypeError} será levantada.
@end itemize


@subsubheading Ver também


@ref{214f,,Customizando argumentos posicionais na classe correspondência de padrão}


@item 
Uma vez que todos os padrões posicionais foram convertidos em padrões de argumentos nomeados, a correspondência continua como se houvesse apenas padrões de palavras reservadas.
@end enumerate

Para os seguintes tipos embutidos, o tratamento de subpadrões posicionais é diferente:


@itemize *

@item 
@ref{468,,bool}

@item 
@ref{2ea,,bytearray}

@item 
@ref{1c2,,bytes}

@item 
@ref{256,,dict}

@item 
@ref{2f7,,float}

@item 
@ref{5da,,frozenset}

@item 
@ref{257,,int}

@item 
@ref{611,,list}

@item 
@ref{5d9,,set}

@item 
@ref{44c,,str}

@item 
@ref{370,,tuple}
@end itemize

Essas classes aceitam um único argumento posicional, e o padrão ali é correspondido ao objeto inteiro em vez de um atributo. Por exemplo, @code{int(0|1)} corresponde ao valor @code{0}, mas não ao valor @code{0.0}.
@end enumerate

Em termos simples, @code{CLS(P1, attr=P2)} corresponde somente se o seguinte acontecer:


@itemize *

@item 
@code{isinstance(<assunto>, CLS)}

@item 
converte @code{P1} em um padrão de argumento nomeado usando @code{CLS.__match_args__}

@item 
Para cada argumento de palavra-chave @code{attr=P2}:


@itemize *

@item 
@code{hasattr(<assunto>, "attr")}

@item 
@code{P2} corresponde a @code{<assunto>.attr}
@end itemize

@item 
… e assim por diante para o par argumento nomeado/elemento correspondente.
@end itemize


@subsubheading Ver também



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Structural Pattern Matching: Specification

@item 
@geindex Propostas de Melhorias do Python; PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} – Correspondência de padrões estruturais: Tutorial
@end itemize


@geindex parâmetro;definição de função
@anchor{reference/compound_stmts function}@anchor{1db6}
@node Definições de função,Definições de classe,A instrução match,Instruções compostas
@anchor{reference/compound_stmts def}@anchor{14a2}@anchor{reference/compound_stmts function-definitions}@anchor{22b3}
@subsection Definições de função


@geindex instrução;def
@geindex função;definição
@geindex função;nome
@geindex nome;vinculação; ligação
@geindex objeto;função definida por usuário
@geindex objeto;função
@geindex função;nome
@geindex nome;vinculação; ligação
@geindex () (parênteses);definição de função
@geindex @comma{} (vírgula);lista de parâmetros
@geindex ; (dois pontos);instrução composta

Uma definição de função define um objeto de função definido pelo usuário (veja a seção @ref{2075,,A hierarquia de tipos padrão}):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-funcdef}@anchor{2261}funcdef                   ::= [@ref{22b4,,decorators}] "def" @ref{22b5,,funcname} [@ref{2255,,type_params}] "(" [@ref{2219,,parameter_list}] ")"
                              ["->" @ref{21c8,,expression}] ":" @ref{2266,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-decorators}@anchor{22b4}decorators                ::= @ref{22b6,,decorator}+
@anchor{reference/compound_stmts grammar-token-python-grammar-decorator}@anchor{22b6}decorator                 ::= "@@" @ref{21b9,,assignment_expression} NEWLINE
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list}@anchor{2219}parameter_list            ::= @ref{22b7,,defparameter} ("," @ref{22b7,,defparameter})* "," "/" ["," [@ref{22b8,,parameter_list_no_posonly}]]
                              | @ref{22b8,,parameter_list_no_posonly}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_no_posonly}@anchor{22b8}parameter_list_no_posonly ::= @ref{22b7,,defparameter} ("," @ref{22b7,,defparameter})* ["," [@ref{22b9,,parameter_list_starargs}]]
                              | @ref{22b9,,parameter_list_starargs}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_starargs}@anchor{22b9}parameter_list_starargs   ::= "*" [@ref{22ba,,star_parameter}] ("," @ref{22b7,,defparameter})* ["," [@ref{22bb,,parameter_star_kwargs}]]
                              | "*" ("," @ref{22b7,,defparameter})+ ["," [@ref{22bb,,parameter_star_kwargs}]]
                              | @ref{22bb,,parameter_star_kwargs}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_star_kwargs}@anchor{22bb}parameter_star_kwargs     ::= "**" @ref{22bc,,parameter} [","]
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter}@anchor{22bc}parameter                 ::= @ref{2023,,identifier} [":" @ref{21c8,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-star_parameter}@anchor{22ba}star_parameter            ::= @ref{2023,,identifier} [":" ["*"] @ref{21c8,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-defparameter}@anchor{22b7}defparameter              ::= @ref{22bc,,parameter} ["=" @ref{21c8,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-funcname}@anchor{22b5}funcname                  ::= @ref{2023,,identifier}
@end example

Uma definição de função é uma instrução executável. Sua execução vincula o nome da função no espaço de nomes local atual a um objeto função (um invólucro em torno do código executável para a função). Este objeto função contém uma referência ao espaço de nomes global atual como o espaço de nomes global a ser usado quando a função é chamada.

A definição da função não executa o corpo da função; ela é executada somente quando a função é chamada. @footnote{
Um literal de string que aparece como a primeira instrução no corpo da função é transformado no atributo @ref{1219,,__doc__} da função e, portanto, no @ref{22bd,,docstring} da função.
}

@geindex @@ (arroba);definição de função

Uma definição de função pode ser encapsulada por uma ou mais expressões @ref{731,,decoradoras}. Expressões decoradoras são avaliadas quando a função é definida, no escopo que contém a definição da função. O resultado deve ser um chamável, que é invocado com o objeto de função como o único argumento. O valor retornado é vinculado ao nome da função em vez do objeto de função. Vários decoradores são aplicados de forma aninhada. Por exemplo, o código a seguir

@example
@@f1(arg)
@@f2
def func(): pass
@end example

é aproximadamente equivalente a

@example
def func(): pass
func = f1(arg)(f2(func))
@end example

exceto que a função original não está temporariamente vinculada ao nome @code{func}.


Alterado na versão 3.9: Funções podem ser decoradas com qualquer @ref{21b9,,assignment_expression} válida. Anteriormente, a gramática era muito mais restritiva; veja 
@geindex Propostas de Melhorias do Python; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para detalhes.


Uma lista de @ref{2b3,,parâmetros de tipo} pode ser dada entre colchetes entre o nome da função e o parêntese de abertura para sua lista de parâmetros. Isso indica aos verificadores de tipo estático que a função é genérica. Em tempo de execução, os parâmetros de tipo podem ser recuperados do atributo @ref{2090,,__type_params__} da função. Veja @ref{453,,Funções genéricas} para mais.


Alterado na versão 3.12: Listas de parâmetros de tipo são novas no Python 3.12.


@geindex default;parâmetro;valor
@geindex argumento;definição de função
@geindex = (igual);definição de função

Quando um ou mais @ref{208f,,parâmetros} têm a forma `parameter' @code{=} `expression', diz-se que a função tem “valores de parâmetro padrão”. Para um parâmetro com um valor padrão, o @ref{449,,argumento} correspondente pode ser omitido de uma chamada, em cujo caso o valor padrão do parâmetro é substituído. Se um parâmetro tiver um valor padrão, todos os parâmetros seguintes até “@code{*}” também devem ter um valor padrão — esta é uma restrição sintática que não é expressa pela gramática.

`Os valores de parâmetro padrão são avaliados da esquerda para a direita quando a definição da função é executada.' Isso significa que a expressão é avaliada uma vez, quando a função é definida, e que o mesmo valor “pré-calculado” é usado para cada chamada. Isso é especialmente importante para entender quando um valor de parâmetro padrão é um objeto mutável, como uma lista ou um dicionário: se a função modifica o objeto (por exemplo, anexando um item a uma lista), o valor de parâmetro padrão é efetivamente modificado. Isso geralmente não é o que se pretendia. Uma maneira de contornar isso é usar @code{None} como o padrão e testá-lo explicitamente no corpo da função, por exemplo:

@example
def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin
@end example

@geindex / (barra);definição de função
@geindex * (asterisco);definição de função
@geindex **;definição de função

A semântica de chamada de função é descrita em mais detalhes na seção @ref{da5,,Chamadas}. Uma chamada de função sempre atribui valores a todos os parâmetros mencionados na lista de parâmetros, seja de argumentos posicionais, de argumentos nomeados ou de valores padrão. Se o formato “@code{*identifier}” estiver presente, ele será inicializado para uma tupla que recebe quaisquer parâmetros posicionais excedentes, padronizando para a tupla vazia. Se o formato “@code{**identifier}” estiver presente, ele será inicializado para um novo mapeamento ordenado que recebe quaisquer argumentos nomeados excedentes, padronizando para um novo mapeamento vazio do mesmo tipo. Parâmetros após “@code{*}” ou “@code{*identifier}” são parâmetros somente-nomeados e podem ser passados somente por argumentos nomeados. Parâmetros antes de “@code{/}” são parâmetros somente-posicionais e podem ser passados somente por argumentos posicionais.


Alterado na versão 3.8: A sintaxe do parâmetro de função @code{/} pode ser usada para indicar parâmetros somente-posicionais. Veja a 
@geindex Propostas de Melhorias do Python; PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} para detalhes.


@geindex função;annotations
@geindex ->;anotações de função
@geindex ; (dois pontos);anotações de função

Os parâmetros podem ter uma @ref{1db7,,anotação} do formato “@code{: expressão}” após o nome do parâmetro. Qualquer parâmetro pode ter uma anotação, mesmo aqueles do formato @code{*identificador} ou @code{**identificador}. (Como um caso especial, parâmetros do formato @code{*identificador} podem ter uma anotação “@code{: *expressão}”.) As funções podem ter uma anotação “return” do formato “@code{-> expressão}” após a lista de parâmetros. Essas anotações podem ser qualquer expressão Python válida. A presença de anotações não altera a semântica de uma função. Os valores de anotação estão disponíveis como valores de um dicionário indexados pelos nomes dos parâmetros no atributo @code{__annotations__} do objeto função. Se a importação de @code{annotations} de @ref{0,,__future__} for usada, as anotações serão preservadas como strings em tempo de execução, o que permite avaliação adiada. Caso contrário, elas são avaliadas quando a definição da função é executada. Nesse caso, as anotações podem ser avaliadas em uma ordem diferente daquela em que aparecem no código-fonte.


Alterado na versão 3.11: Parâmetros do formato “@code{*identificador}” podem ter uma anotação “@code{: *expressão}”. Veja 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}.


@geindex lambda;expressão

Também é possível criar funções anônimas (funções não vinculadas a um nome), para uso imediato em expressões. Isso usa expressões lambda, descritas na seção @ref{12df,,Lambdas}. Observe que a expressão lambda é meramente uma abreviação para uma definição de função simplificada; uma função definida em uma instrução “@ref{14a2,,def}” pode ser passada adiante ou atribuída a outro nome, assim como uma função definida por uma expressão lambda. O formato “@code{def}” é, na verdade, mais poderoso, pois permite a execução de várias instruções e anotações.

`Nota do programador:' Funções são objetos de primeira classe. Uma instrução “@code{def}” executada dentro de uma definição de função define uma função local que pode ser retornada ou passada adiante. Variáveis livres usadas na função aninhada podem acessar as variáveis locais da função que contém o “def”. Veja a seção @ref{208a,,Nomeação e ligação} para detalhes.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3107

@item PEP 3107@footnote{https://peps.python.org/pep-3107/} - Anotações de função

A especificação original para anotações de funções.

@geindex Propostas de Melhorias do Python; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Dicas de tipo

Definição de um significado padrão para anotações: dicas de tipo.

@geindex Propostas de Melhorias do Python; PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - Sintaxe para Anotações de Variáveis

Capacidade de fornecer dica de tipo para declarações de variáveis, incluindo variáveis de classe e variáveis de instância.

@geindex Propostas de Melhorias do Python; PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} - Avaliação postergada de anotações

Suporte para referências futuras dentro de anotações, preservando anotações em um formato de string em tempo de execução em vez de avaliação antecipada.

@geindex Propostas de Melhorias do Python; PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} - Decoradores para funções e métodos

Decoradores de função e método foram introduzidos. Decoradores de classe foram introduzidos na 
@geindex Propostas de Melhorias do Python; PEP 3129
PEP 3129@footnote{https://peps.python.org/pep-3129/}.
@end table


@node Definições de classe,Corrotinas<2>,Definições de função,Instruções compostas
@anchor{reference/compound_stmts class}@anchor{131a}@anchor{reference/compound_stmts class-definitions}@anchor{22be}
@subsection Definições de classe


@geindex objeto;classe
@geindex instrução;classe
@geindex classe;definição
@geindex classe;nome
@geindex nome;vinculação; ligação
@geindex execução;quadro
@geindex herança
@geindex docstring
@geindex () (parênteses);definição de classe
@geindex @comma{} (vírgula);expressão@comma{} lista de
@geindex ; (dois pontos);instrução composta

Uma definição de classe define um objeto classe (veja a seção @ref{2075,,A hierarquia de tipos padrão}):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-classdef}@anchor{2262}classdef    ::= [@ref{22b4,,decorators}] "class" @ref{22bf,,classname} [@ref{2255,,type_params}] [@ref{22c0,,inheritance}] ":" @ref{2266,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-inheritance}@anchor{22c0}inheritance ::= "(" [@ref{21eb,,argument_list}] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-classname}@anchor{22bf}classname   ::= @ref{2023,,identifier}
@end example

Uma definição de classe é uma instrução executável. A lista de herança geralmente fornece uma lista de classes base (veja @ref{2100,,Metaclasses} para usos mais avançados), então cada item na lista deve ser executada como um objeto classe que permite extensão via subclasse. Classes sem uma lista de herança herdam, por padrão, da classe base @ref{a96,,object}; portanto,

@example
class Foo:
    pass
@end example

equivale a

@example
class Foo(object):
    pass
@end example

O conjunto da classe é então executado em um novo quadro de execução (veja @ref{208a,,Nomeação e ligação}), usando um espaço de nomes local recém-criado e o espaço de nomes global original. (Normalmente, o conjunto contém principalmente definições de função.) Quando o conjunto da classe termina a execução, seu quadro de execução é descartado, mas seu espaço de nomes local é salvo. @footnote{
Um literal de string que aparece como a primeira instrução no corpo da classe é transformado no item @ref{1e35,,__doc__} do espaço de nomes e, portanto, no @ref{22bd,,docstring} da classe.
} Um objeto classe é então criado usando a lista de herança para as classes base e o espaço de nomes local salvo para o dicionário de atributos. O nome da classe é vinculado a este objeto classe no espaço de nomes local original.

A ordem em que os atributos são definidos no corpo da classe é preservada no @ref{c78,,__dict__} da nova classe. Observe que isso é confiável somente logo após a classe ser criada e somente para classes que foram definidas usando a sintaxe de definição.

A criação de classes pode ser bastante personalizada usando @ref{2100,,metaclasses}.

@geindex @@ (arroba);definição de classe

As classes também podem ser decoradas: assim como na decoração de funções,

@example
@@f1(arg)
@@f2
class Foo: pass
@end example

é aproximadamente equivalente a

@example
class Foo: pass
Foo = f1(arg)(f2(Foo))
@end example

As regras de execução para as expressões de decorador são as mesmas que para decoradores de função. O resultado é então vinculado ao nome da classe.


Alterado na versão 3.9: Classes podem ser decoradas com qualquer @ref{21b9,,assignment_expression} válida. Anteriormente, a gramática era muito mais restritiva; veja 
@geindex Propostas de Melhorias do Python; PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} para detalhes.


Uma lista de @ref{2b3,,parâmetros de tipo} pode ser dada entre colchetes imediatamente após o nome da classe. Isso indica aos verificadores de tipo estático que a classe é genérica. Em tempo de execução, os parâmetros de tipo podem ser recuperados do atributo @ref{20ba,,__type_params__} da classe. Veja @ref{452,,Classes genéricas} para mais.


Alterado na versão 3.12: Listas de parâmetros de tipo são novas no Python 3.12.


`Nota do programador:' Variáveis definidas na definição de classe são atributos de classe; elas são compartilhadas por instâncias. Atributos de instância podem ser definidos em um método com @code{self.nome = valor}. Atributos de classe e instância são acessíveis por meio da notação “@code{self.nome}”, e um atributo de instância oculta um atributo de classe com o mesmo nome quando acessado dessa forma. Atributos de classe podem ser usados como padrões para atributos de instância, mas usar valores mutáveis pode levar a resultados inesperados. @ref{c6a,,Descritores} podem ser usados para criar variáveis de instância com diferentes detalhes de implementação.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclasses no Python 3000

A proposta que alterou a declaração de metaclasses para a sintaxe atual e a semântica de como as classes com metaclasses são construídas.

@geindex Propostas de Melhorias do Python; PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - Class Decorators

A proposta que adicionou decoradores de classe. Decoradores de função e método foram introduzidos na 
@geindex Propostas de Melhorias do Python; PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/}.
@end table


@node Corrotinas<2>,Listas de parâmetros de tipo,Definições de classe,Instruções compostas
@anchor{reference/compound_stmts async}@anchor{732}@anchor{reference/compound_stmts coroutines}@anchor{22c1}
@subsection Corrotinas



Adicionado na versão 3.5.


@geindex instrução;async def

@menu
* Definição de função de corrotina:: 
* A instrução async for:: 
* A instrução async with:: 

@end menu

@node Definição de função de corrotina,A instrução async for,,Corrotinas<2>
@anchor{reference/compound_stmts async-def}@anchor{5d1}@anchor{reference/compound_stmts coroutine-function-definition}@anchor{22c2}
@subsubsection Definição de função de corrotina


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_funcdef}@anchor{2265}async_funcdef ::= [@ref{22b4,,decorators}] "async" "def" @ref{22b5,,funcname} "(" [@ref{2219,,parameter_list}] ")"
                  ["->" @ref{21c8,,expression}] ":" @ref{2266,,suite}
@end example

@geindex palavra reservada;async
@geindex palavra reservada;await

A execução de corrotinas do Python pode ser suspensa e retomada em muitos pontos (consulte @ref{491,,coroutine}). As expressões @ref{1b9,,await}, @ref{aba,,async for} e @ref{5d5,,async with} só podem ser usadas no corpo de uma função de corrotina.

Funções definidas com a sintaxe @code{async def} são sempre funções de corrotina, mesmo que não contenham palavras reservadas @code{await} ou @code{async}.

Ocorre uma @ref{18d,,SyntaxError} se usada uma expressão @code{yield from} dentro do corpo de uma função de corrotina.

Um exemplo de uma função de corrotina:

@example
async def func(param1, param2):
    faz_algo()
    await alguma_corrotina()
@end example


Alterado na versão 3.7: @code{await} e @code{async} agora são palavras reservadas; anteriormente, elas só eram tratadas como tal dentro do corpo de uma função de corrotina.


@geindex instrução;async for

@node A instrução async for,A instrução async with,Definição de função de corrotina,Corrotinas<2>
@anchor{reference/compound_stmts async-for}@anchor{aba}@anchor{reference/compound_stmts the-async-for-statement}@anchor{22c3}
@subsubsection A instrução @code{async for}


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_for_stmt}@anchor{2264}async_for_stmt ::= "async" @ref{225d,,for_stmt}
@end example

Um @ref{d9c,,iterável assíncrono} fornece um método @code{__aiter__} que retorna diretamente um @ref{1ab,,iterador assíncrono}, que pode chamar código assíncrono em seu método @code{__anext__}.

A instrução @code{async for} permite iteração conveniente sobre iteráveis assíncronos.

O seguinte código:

@example
async for TARGET in ITER:
    SUITE
else:
    SUITE2
@end example

É semanticamente 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

Veja também @ref{c16,,__aiter__()} e @ref{1659,,__anext__()} para detalhes.

Ocorre uma @ref{18d,,SyntaxError} se usada uma instrução @code{async for} fora do corpo de uma função de corrotina.

@geindex instrução;async with

@node A instrução async with,,A instrução async for,Corrotinas<2>
@anchor{reference/compound_stmts async-with}@anchor{5d5}@anchor{reference/compound_stmts the-async-with-statement}@anchor{22c4}
@subsubsection A instrução @code{async with}


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_with_stmt}@anchor{2263}async_with_stmt ::= "async" @ref{225f,,with_stmt}
@end example

Um @ref{5d7,,gerenciador de contexto assíncrono} é um @ref{5d4,,gerenciador de contexto} que é capaz de suspender a execução em seus métodos `enter' e `exit'.

O seguinte código:

@example
async with EXPRESSÃO as ALVO:
    COMANDOS
@end example

é semanticamente equivalente a:

@example
manager = (EXPRESSÃO)
aenter = type(manager).__aenter__
aexit = type(manager).__aexit__
value = await aenter(manager)
hit_except = False

try:
    ALVO = value
    COMANDOS
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

Veja também  @ref{215e,,__aenter__()} e @ref{1716,,__aexit__()} para detalhes.

Ocorre uma @ref{18d,,SyntaxError} se usada uma instrução @code{async with} fora do corpo de uma função de corrotina.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} - Corrotina com sintaxe de async e wait

A proposta que tornou as corrotinas um conceito autônomo em Python e adicionou sintaxe de suporte.
@end table


@node Listas de parâmetros de tipo,,Corrotinas<2>,Instruções compostas
@anchor{reference/compound_stmts type-parameter-lists}@anchor{22c5}@anchor{reference/compound_stmts type-params}@anchor{2b3}
@subsection Listas de parâmetros de tipo



Adicionado na versão 3.12.



Alterado na versão 3.13: Foi adicionado suporte para valores padrão (veja 
@geindex Propostas de Melhorias do Python; PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}).


@geindex parâmetros de tipo

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-type_params}@anchor{2255}type_params  ::= "[" @ref{22c6,,type_param} ("," @ref{22c6,,type_param})* "]"
@anchor{reference/compound_stmts grammar-token-python-grammar-type_param}@anchor{22c6}type_param   ::= @ref{22c7,,typevar} | @ref{22c8,,typevartuple} | @ref{22c9,,paramspec}
@anchor{reference/compound_stmts grammar-token-python-grammar-typevar}@anchor{22c7}typevar      ::= @ref{2023,,identifier} (":" @ref{21c8,,expression})? ("=" @ref{21c8,,expression})?
@anchor{reference/compound_stmts grammar-token-python-grammar-typevartuple}@anchor{22c8}typevartuple ::= "*" @ref{2023,,identifier} ("=" @ref{21c8,,expression})?
@anchor{reference/compound_stmts grammar-token-python-grammar-paramspec}@anchor{22c9}paramspec    ::= "**" @ref{2023,,identifier} ("=" @ref{21c8,,expression})?
@end example

@ref{14a2,,Funções} (incluindo @ref{5d1,,corrotinas}), @ref{131a,,classes} e @ref{438,,apelidos de tipo} podem conter uma lista de parâmetros de tipo:

@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

Semanticamente, isso indica que a função, classe ou apelido de tipo é genérico sobre uma variável de tipo. Essas informações são usadas principalmente por verificadores de tipo estático e, em tempo de execução, objetos genéricos se comportam muito como suas contrapartes não genéricas.

Parâmetros de tipo são declarados entre colchetes (@code{[]}) imediatamente após o nome da função, classe ou apelido de tipo. Os parâmetros de tipo são acessíveis dentro do escopo do objeto genérico, mas não em outro lugar. Assim, após uma declaração @code{def func[T](): pass}, o nome @code{T} não está disponível no escopo do módulo. Abaixo, a semântica de objetos genéricos é descrita com mais precisão. O escopo de parâmetros de tipo é modelado com uma função especial (tecnicamente, um @ref{188,,escopo de anotação}) que encapsula a criação do objeto genérico.

Funções genéricas, classes e apelidos de tipo têm um atributo @ref{22ca,,__type_params__} listando seus parâmetros de tipo.

Existem três espécies de parâmetros de tipo:


@itemize *

@item 
@ref{15d,,typing.TypeVar}, introduzido por um nome simples (por exemplo, @code{T}). Semanticamente, isso representa um único tipo para um verificador de tipos.

@item 
@ref{15f,,typing.TypeVarTuple}, introduzido por um nome prefixado com um único asterisco (por exemplo, @code{*Ts}). Semanticamente, isso representa uma tupla de qualquer número de tipos.

@item 
@ref{15e,,typing.ParamSpec}, introduzido por um nome prefixado com dois asteriscos (por exemplo, @code{**P}). Semanticamente, isso representa os parâmetros de um chamável.
@end itemize

As declarações de @ref{15d,,typing.TypeVar} podem definir delimitações (`bounds') e restrições (`constraints') com dois pontos (@code{:}) seguidos por uma expressão. Uma única expressão após os dois pontos indica uma delimitação (por exemplo, @code{T: int}). Semanticamente, isso significa que o @code{typing.TypeVar} pode representar apenas tipos que são um subtipo desse limite. Uma tupla de expressões entre parênteses após os dois pontos indica um conjunto de restrições (por exemplo, @code{T: (str, bytes)}). Cada membro da tupla deve ser um tipo (novamente, isso não é imposto em tempo de execução). Variáveis de tipo restrito podem assumir apenas um dos tipos na lista de restrições.

Para @code{typing.TypeVar}s declarados usando a sintaxe de lista de parâmetros de tipo, a delimitação e as restrições não são avaliados quando o objeto genérico é criado, mas somente quando o valor é acessado explicitamente por meio dos atributos @code{__bound__} e @code{__constraints__}. Para fazer isso, as delimitações ou restrições são avaliados em um @ref{188,,escopo de anotação} separado.

@ref{15f,,typing.TypeVarTuple}s e @ref{15e,,typing.ParamSpec}s não pode ter delimitações e restrições.

Todas as três espécies de parâmetros de tipo também podem ter um `valor padrão', que é usado quando o parâmetro de tipo não é fornecido explicitamente. Isso é adicionado anexando um único sinal de igual (@code{=}) seguido por uma expressão. Como os limites e restrições de tipos variáveis, o valor padrão não é avaliado quando o objeto é criado, mas apenas quando o atributo @code{__default__} do parâmetro de tipo é acessado. Para esse fim, o valor padrão é avaliado em um @ref{188,,escopo de anotação} separado. Se nenhum valor padrão for especificado para um parâmetro de tipo, o atributo @code{__default__} é definido como o objeto sinalizador especial @ref{262,,typing.NoDefault}.

O exemplo a seguir indica o conjunto completo de declarações de parâmetros de tipo permitidas:

@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
* Funções genéricas:: 
* Classes genéricas:: 
* Apelidos de tipo genérico:: 

@end menu

@node Funções genéricas,Classes genéricas,,Listas de parâmetros de tipo
@anchor{reference/compound_stmts generic-functions}@anchor{453}@anchor{reference/compound_stmts id17}@anchor{22cb}
@subsubsection Funções genéricas


Funções genéricas são declaradas assim:

@example
def func[T](arg: T): ...
@end example

Essa sintaxe é equivalente a:

@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

Aqui, @code{annotation-def} indica um @ref{188,,escopo de anotação}, que não é vinculado de verdade a nenhum nome em tempo de execução. (Uma outra liberdade foi tomada na tradução: essa sintaxe não faz ocorrer um acesso de atributo no módulo @ref{104,,typing}; ao invés disso é criada uma instância de @ref{15d,,typing.TypeVar} diretamente.)

As anotações das funções genéricas são lidas dentro do escopo de anotação usado para declarar os parâmetros de tipo, mas os valores padrão dos argumentos e decoradores da função não são.

Este exemplo ilustra as regras de escopo para estes casos, bem como para outras espécies de parâmetros de tipo:

@example
@@decorator
def func[T: int, *Ts, **P](*args: *Ts, arg: Callable[P, T] = some_default):
    ...
@end example

Tirando a @ref{457,,avaliação preguiçosa} da delimitação da @ref{15d,,TypeVar}, isso é equivalente a:

@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

Os nomes com maiúsculas como @code{DEFAULT_OF_arg} não são realmente vinculados em tempo de execução.

@node Classes genéricas,Apelidos de tipo genérico,Funções genéricas,Listas de parâmetros de tipo
@anchor{reference/compound_stmts generic-classes}@anchor{452}@anchor{reference/compound_stmts id18}@anchor{22cc}
@subsubsection Classes genéricas


Classes genéricas são declaradas assim:

@example
class Bag[T]: ...
@end example

Essa sintaxe é equivalente a:

@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

Aqui novamente @code{annotation-def} (não é uma palavra reservada real) indica um @ref{188,,escopo de anotação}, e o nome @code{TYPE_PARAMS_OF_Bag} não é realmente vinculado em tempo de execução.

Classes genéricas herdam implicitamente de @ref{15d7,,typing.Generic}. As classes base e os argumentos nomeados de classes genéricas são avaliados dentro do escopo de tipo para os parâmetros de tipo, e os decoradores são avaliados fora desse escopo. Isso é ilustrado por este exemplo:

@example
@@decorator
class Bag(Base[T], arg=T): ...
@end example

Isso equivale a:

@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 Apelidos de tipo genérico,,Classes genéricas,Listas de parâmetros de tipo
@anchor{reference/compound_stmts generic-type-aliases}@anchor{456}@anchor{reference/compound_stmts id19}@anchor{22cd}
@subsubsection Apelidos de tipo genérico


A instrução @ref{438,,type} também pode ser usada para criar um apelido de tipo genérico:

@example
type ListOrSet[T] = list[T] | set[T]
@end example

Exceto pela @ref{457,,avaliação preguiçosa} do valor, isso é equivalente a:

@example
annotation-def TYPE_PARAMS_OF_ListOrSet():
    T = typing.TypeVar("T")

    annotation-def VALUE_OF_ListOrSet():
        return list[T] | set[T]
    # Na realidade, o valor é avaliado preguiçosamente
    return typing.TypeAliasType("ListOrSet", VALUE_OF_ListOrSet(), type_params=(T,))
ListOrSet = TYPE_PARAMS_OF_ListOrSet()
@end example

Aqui, @code{annotation-def} (não é uma palavra reservada real) indica um @ref{188,,escopo de anotação}. Os nomes em maiúsculas como @code{TYPE_PARAMS_OF_ListOrSet} não são realmente vinculados em tempo de execução.

@node Componentes de Alto Nível,Especificação completa da gramática,Instruções compostas,A Referência da Linguagem Python
@anchor{reference/toplevel_components doc}@anchor{22ce}@anchor{reference/toplevel_components top-level}@anchor{22cf}@anchor{reference/toplevel_components top-level-components}@anchor{22d0}@anchor{reference/toplevel_components translation-repo}@anchor{22d1}
@section Componentes de Alto Nível


@geindex interpretador

O interpretador Python pode receber suas entradas de uma quantidade de fontes: de um script passado a ele como entrada padrão ou como um argumento do programa, digitado interativamente, de um arquivo fonte de um módulo, etc. Este capítulo mostra a sintaxe usada nesses casos.

@menu
* Programas Python completos:: 
* Entrada de arquivo:: 
* Entrada interativa:: 
* Entrada de expressão:: 

@end menu

@node Programas Python completos,Entrada de arquivo,,Componentes de Alto Nível
@anchor{reference/toplevel_components complete-python-programs}@anchor{22d2}@anchor{reference/toplevel_components programs}@anchor{218d}
@subsection Programas Python completos


@geindex programa

@geindex módulo;sys
@geindex módulo;__main__
@geindex módulo;builtins

Ainda que uma especificação de linguagem não precise prescrever como o interpretador da linguagem é invocado, é útil ter uma noção de um programa Python completo. Um programa Python completo é executado em um ambiente minimamente inicializado: todos os módulos embutidos e padrões estão disponíveis, mas nenhum foi inicializado, exceto por @ref{d9,,sys} (serviços de sistema diversos), @ref{12,,builtins} (funções embutidas, exceções e @code{None}) e @ref{1,,__main__}. O último é usado para fornecer o espaço de nomes global e local para execução de um programa completo.

A sintaxe para um programa Python completo é esta para uma entrada de arquivo, descrita na próxima seção.

@geindex modo interativo
@geindex módulo;__main__

O interpretador também pode ser invocado no modo interativo; neste caso, ele não lê e executa um programa completo, mas lê e executa uma instrução (possivelmente composta) por vez. O ambiente inicial é idêntico àquele de um programa completo; cada instrução é executada no espaço de nomes de @ref{1,,__main__}.

@geindex UNIX
@geindex Windows
@geindex linha de comando
@geindex entrada padrão

Um programa completo pode ser passado ao interpretador de três formas: com a opção de linha de comando @ref{5e0,,-c} `string', como um arquivo passado como o primeiro argumento da linha de comando, ou como uma entrada padrão. Se o arquivo ou a entrada padrão é um dispositivo tty, o interpretador entra em modo interativo; caso contrário, ele executa o arquivo como um programa completo.

@node Entrada de arquivo,Entrada interativa,Programas Python completos,Componentes de Alto Nível
@anchor{reference/toplevel_components file-input}@anchor{22d3}@anchor{reference/toplevel_components id1}@anchor{22d4}
@subsection Entrada de arquivo


Toda entrada lida de arquivos não-interativos têm a mesma forma:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-file_input}@anchor{22d5}file_input ::= (NEWLINE | @ref{2268,,statement})*
@end example

Essa sintaxe é usada nas seguintes situações:


@itemize *

@item 
quando analisando um programa Python completo (a partir de um arquivo ou de uma string);

@item 
quando analisando um módulo;

@item 
quando analisando uma string passada à função @ref{17f,,exec()};
@end itemize

@node Entrada interativa,Entrada de expressão,Entrada de arquivo,Componentes de Alto Nível
@anchor{reference/toplevel_components interactive}@anchor{22d6}@anchor{reference/toplevel_components interactive-input}@anchor{22d7}
@subsection Entrada interativa


A entrada em modo interativo é analisada usando a seguinte gramática:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-interactive_input}@anchor{22d8}interactive_input ::= [@ref{2267,,stmt_list}] NEWLINE | @ref{225a,,compound_stmt} NEWLINE
@end example

Note que uma instrução composta (de alto-nível) deve ser seguida por uma linha em branco no modo interativo; isso é necessário para ajudar o analisador sintático a detectar o fim da entrada.

@node Entrada de expressão,,Entrada interativa,Componentes de Alto Nível
@anchor{reference/toplevel_components expression-input}@anchor{22d9}@anchor{reference/toplevel_components id2}@anchor{22da}
@subsection Entrada de expressão


@geindex entrada

@geindex função embutida;eval

A função @ref{180,,eval()} é usada para uma entrada de expressão. Ela ignora espaços à esquerda. O argumento em string para @ref{180,,eval()} deve ter a seguinte forma:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-eval_input}@anchor{22db}eval_input ::= @ref{221d,,expression_list} NEWLINE*
@end example

@node Especificação completa da gramática,,Componentes de Alto Nível,A Referência da Linguagem Python
@anchor{reference/grammar doc}@anchor{229a}@anchor{reference/grammar full-grammar-specification}@anchor{22dc}@anchor{reference/grammar id1}@anchor{22dd}@anchor{reference/grammar translation-repo}@anchor{22de}
@section Especificação completa da gramática


Esta é a gramática completa do Python, derivada diretamente da gramática usada para gerar o analisador sintático de CPython (consulte Grammar/python.gram@footnote{https://github.com/python/cpython/tree/3.13/Grammar/python.gram}). A versão aqui omite detalhes relacionados à geração de código e recuperação de erros.

A notação é uma mistura de EBNF@footnote{https://pt.wikipedia.org/wiki/Formalismo_de_Backus-Naur_Estendido} e GASE@footnote{https://pt.wikipedia.org/wiki/Gramática_de_análise_sintática_de_expressão} (em inglês, PEG@footnote{https://en.wikipedia.org/wiki/Parsing_expression_grammar}). Em particular, @code{&} seguido por um símbolo, token ou grupo entre parênteses indica um “olhar a frente” positivo (ou seja, é necessário para corresponder, mas não consumido), enquanto @code{!} indica um “olhar a frente” negativo (ou seja, é necessário `não' combinar). Usamos o separador @code{|} para significar a “escolha ordenada” do GASE (escrito como @code{/} nas gramáticas GASE tradicionais). Veja 
@geindex Propostas de Melhorias do Python; PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} para mais detalhes sobre a sintaxe da gramática.

@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=(yield_expr | star_expressions) !'=' tc=[TYPE_COMMENT] @{
         _PyAST_Assign(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | a=single_target b=augassign ~ c=(yield_expr | star_expressions) @{
         _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 @{
        _PyPegen_checked_future_import(p, 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_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) @}
    | '*' 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 b=[type_param_starred_default] @{ _PyAST_TypeVarTuple(a->v.Name.id, b, EXTRA) @}
    | '**' 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")
        @}
    | '**' 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) @}
    | 'async'? 'for' (bitwise_or (',' bitwise_or)* [',']) !'in' @{
        RAISE_SYNTAX_ERROR("'in' expected after for-loop variables") @}
    | 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
    | '*' a=expression @{ _PyAST_Starred(a, Load, EXTRA) @}
    | '*' @{ RAISE_SYNTAX_ERROR("Invalid star 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_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_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 ':'") @}
    | a='except' '*' (NEWLINE | ':') @{ RAISE_SYNTAX_ERROR("expected one or more exception types") @}
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' !NAME a=expression @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "invalid pattern target") @}
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:
    | a='*' expression '=' b=expression @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to iterable argument unpacking") @}

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 A Biblioteca Padrão do Python,Estendendo e incorporando o interpretador Python,A Referência da Linguagem Python,Top
@anchor{library/index doc}@anchor{22df}@anchor{library/index library-index}@anchor{144}@anchor{library/index the-python-standard-library}@anchor{22e0}@anchor{library/index translation-repo}@anchor{22e1}
@chapter A Biblioteca Padrão do Python


Enquanto @ref{145,,A Referência da Linguagem Python} descreve a sintaxe e a semântica exatas da linguagem Python, este manual de referência de bibliotecas descreve a biblioteca padrão que é distribuída com o Python. Ele também descreve alguns dos componentes opcionais que são comumente incluídos nas distribuições do Python.

A biblioteca padrão do Python é muito extensa, oferecendo uma ampla gama de recursos, conforme indicado pelo longo índice listado abaixo. A biblioteca contém módulos embutidos (escritos em C) que fornecem acesso à funcionalidade do sistema, como E/S de arquivos que de outra forma seriam inacessíveis para programadores Python, bem como módulos escritos em Python que fornecem soluções padronizadas para muitos problemas que ocorrem em programação cotidiana. Alguns desses módulos são explicitamente projetados para incentivar e aprimorar a portabilidade de programas em Python, abstraindo os detalhes da plataforma em APIs neutras em plataforma.

Os instaladores do Python para a plataforma Windows geralmente incluem toda a biblioteca padrão e muitas vezes também incluem muitos componentes adicionais. Para sistemas operacionais semelhantes a Unix, o Python é normalmente fornecido como uma coleção de pacotes, portanto, pode ser necessário usar as ferramentas de empacotamento fornecidas com o sistema operacional para obter alguns ou todos os componentes opcionais.

Além da biblioteca padrão, há uma coleção ativa de centenas de milhares de componentes (de programas e módulos individuais a pacotes e frameworks de desenvolvimento de aplicativos inteiros), disponíveis no 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
* Introdução: Introdução<6>. 
* Funções embutidas: Funções embutidas<3>. 
* Constantes embutidas:: 
* Tipos embutidos:: 
* Exceções embutidas:: 
* Serviços de Processamento de Texto:: 
* Serviços de Dados Binários:: 
* Tipos de Dados:: 
* Módulos Matemáticos e Numéricos:: 
* Módulos de Programação Funcional:: 
* Acesso a arquivos e diretórios:: 
* Persistência de Dados:: 
* Compressão de Dados e Arquivamento:: 
* Formatos de Arquivo:: 
* Serviços Criptográficos:: 
* Serviços Genéricos do Sistema Operacional:: 
* Bibliotecas de interface de linha de comando:: 
* Execução Concorrente:: 
* Comunicação em Rede e Interprocesso:: 
* Manuseio de Dados na Internet:: 
* Ferramentas de Processamento de Markup Estruturado:: 
* Protocolos de Internet e Suporte:: 
* Serviços Multimídia:: 
* Internacionalização:: 
* Interfaces gráficas de usuário com Tk:: 
* Ferramentas de Desenvolvimento:: 
* Depuração e perfilamento:: 
* Empacotamento e Distribuição de Software:: 
* Serviços de Tempo de Execução Python:: 
* Interpretadores Python Personalizados:: 
* Importando módulos:: 
* Serviços da Linguagem Python:: 
* Serviços Específicos do MS Windows:: 
* Serviços específicos do Unix:: 
* Interface de linha de comando (CLI) de módulos: Interface de linha de comando CLI de módulos. 
* Módulos substituídos:: 
* Módulos removidos:: 
* Considerações de Segurança: Considerações de Segurança<3>. 

@end menu

@node Introdução<6>,Funções embutidas<3>,,A Biblioteca Padrão do Python
@anchor{library/intro doc}@anchor{22e2}@anchor{library/intro introduction}@anchor{22e3}@anchor{library/intro library-intro}@anchor{22e4}
@section Introdução


A “biblioteca Python” contém vários tipos diferentes de componentes.

Ela contém tipos de dados que seriam normalmente considerados como parte “central” de uma linguagem, tais como números e listas. Para esses tipos, o núcleo da linguagem Python define a forma de literais e coloca algumas restrições em suas semânticas, mas não define completamente as semânticas. (Por outro lado, o núcleo da linguagem define propriedades sintáticas como a ortografia e a prioridade de operadores.)

A biblioteca também contém exceções e funções embutidas — objetos que podem ser usados por todo o código Python sem a necessidade de uma instrução @ref{5e2,,import}. Alguns desses são definidos pelo núcleo da linguagem, mas muitos não são essenciais para as semânticas principais e são apenas descritos aqui.

A maior parte da biblioteca, entretanto, consiste em uma coleção de módulos. Há muitas formas de dissecar essa coleção. Alguns módulos são escritos em C e colocados no interpretador do Python; outros são escritos em Python e importados na forma de código. Alguns módulos fornecem interfaces que são muito específicas do Python, como imprimir um stack trace (situação da pilha de execução); alguns fornecem interfaces que são específicas para um sistema operacional em particular, tais como acessar hardware específico; outros fornecem interfaces que são específicas de um domínio de aplicação em particular, como a World Wide Web. Alguns módulos estão disponíveis em todas as versões do Python; outros estão apenas disponíveis quando o sistema subjacente suporta ou necessita deles; e ainda outros estão disponíveis apenas quando uma opção de configuração em particular foi escolhida no momento em que o Python foi compilado e instalado.

Este manual está organizado “de dentro para fora”: ele primeiro descreve as funções embutidas, tipos de dados e exceções, e finalmente os módulos, agrupados em capítulos de módulos relacionados.

Isto significa que, se você começar a ler este manual do início, e pular para o próximo capítulo quando estiver entediado, você terá uma visão geral razoável dos módulos disponíveis e áreas de aplicação que são suportadas pela biblioteca Python. É claro, você não `tem' que ler como se fosse um romance — você também pode navegar pela tabela de conteúdos (no início do manual), ou procurar por uma função, módulo ou termo específicos no índice (na parte final). E finalmente, se você gostar de aprender sobre assuntos diversos, você pode escolher um número de página aleatório (veja o módulo @ref{b8,,random}) e leia uma seção ou duas. Independente da ordem na qual você leia as seções deste manual, ajuda iniciar pelo capítulo @ref{129e,,Funções embutidas}, já que o resto do manual requer familiaridade com este material.

E que o show comece!

@menu
* Observações sobre disponibilidade:: 

@end menu

@node Observações sobre disponibilidade,,,Introdução<6>
@anchor{library/intro availability}@anchor{1ed8}@anchor{library/intro notes-on-availability}@anchor{22e5}
@subsection Observações sobre disponibilidade



@itemize *

@item 
Uma observação “Disponibilidade: Unix” significa que essa função é comumente encontrada em sistemas Unix. Não faz nenhuma reivindicação sobre sua existência em um sistema operacional específico.

@item 
Caso não seja definido separadamente, todas as funções que se definem como “Disponibilidade: Unix” são suportadas no macOS, IOS e Android, todas construídas em um Unix core.

@item 
Se uma nota de disponibilidade contiver uma versão mínima do Kernel e uma versão mínima da libc, ambas as condições deverão ser atendidas. Por exemplo, um recurso com a observação `Disponibilidade: Linux >= 3.17 com glibc >= 2.27' requer Linux 3.17 ou mais recente e glibc 2.27 ou mais recente.
@end itemize

@menu
* Plataformas WebAssembly:: 
* Plataformas móveis:: 

@end menu

@node Plataformas WebAssembly,Plataformas móveis,,Observações sobre disponibilidade
@anchor{library/intro wasm-availability}@anchor{18f5}@anchor{library/intro webassembly-platforms}@anchor{22e6}
@subsubsection Plataformas WebAssembly


As plataformas WebAssembly@footnote{https://webassembly.org/} @code{wasm32-emscripten} (Emscripten@footnote{https://emscripten.org/}) e @code{wasm32-wasi} (WASI@footnote{https://wasi.dev/}) fornecem um subconjunto de APIs POSIX. Os tempos de execução e navegadores do WebAssembly são colocados em área restrita e têm acesso limitado ao host e aos recursos externos. Qualquer módulo de biblioteca padrão do Python que usa processos, encadeamento, rede, sinais ou outras formas de comunicação entre processos (IPC) não está disponível ou pode não funcionar como em outros sistemas semelhantes ao Unix. E/S de arquivo, sistema de arquivos e funções relacionadas à permissão do Unix também são restritas. Emscripten não permite bloqueio de E/S. Outras operações de bloqueio como @ref{69d,,sleep()} bloqueiam o laço de eventos do navegador.

As propriedades e o comportamento do Python em plataformas WebAssembly dependem da versão Emscripten@footnote{https://emscripten.org/}-SDK ou WASI@footnote{https://wasi.dev/}-SDK, tempos de execução WASM (navegador, NodeJS, wasmtime@footnote{https://wasmtime.dev/}) e sinalizadores de tempo de construção do Python. WebAssembly, Emscripten e WASI são padrões em evolução; alguns recursos como rede podem ser suportados no futuro.

Para Python no navegador, os usuários devem considerar Pyodide@footnote{https://pyodide.org/} ou PyScript@footnote{https://pyscript.net/}. O PyScript é construído sobre o Pyodide, que por sua vez é construído sobre o CPython e o Emscripten. O Pyodide fornece acesso às APIs JavaScript e DOM dos navegadores, bem como recursos de rede limitados com as APIs @code{XMLHttpRequest} e @code{Fetch} do JavaScript.


@itemize *

@item 
As APIs relacionadas a processo não estão disponíveis ou sempre falham com um erro. Isso inclui APIs que geram novos processos (@ref{197,,fork()}, @ref{1138,,execve()}), aguardam processos (@ref{dc2,,waitpid()}), enviam sinais (@ref{13ae,,kill()}), ou interagir com processos. O @ref{d6,,subprocess} é importável, mas não funciona.

@item 
O módulo @ref{cc,,socket} está disponível, mas é limitado e se comporta de maneira diferente de outras plataformas. No Emscripten, os soquetes são sempre não bloqueantes e requerem código JavaScript adicional e auxiliares no servidor para intermediar TCP por meio de WebSockets; veja Emscripten Networking@footnote{https://emscripten.org/docs/porting/networking.html} para mais informações. A primeira snapshot de preview do WASI permite apenas soquetes de um descritor de arquivo existente.

@item 
Algumas funções são esboço que não fazem nada e sempre retornam valores definidos no código.

@item 
As funções relacionadas a descritores de arquivo, permissões de arquivo, propriedade de arquivo e links são limitadas e não suportam algumas operações. Por exemplo, WASI não permite links simbólicos com nomes de arquivo absolutos.
@end itemize
@anchor{library/intro mobile-availability}@anchor{1fde}
@node Plataformas móveis,,Plataformas WebAssembly,Observações sobre disponibilidade
@anchor{library/intro ios-availability}@anchor{22e7}@anchor{library/intro mobile-platforms}@anchor{22e8}
@subsubsection Plataformas móveis


O Android e o IOS são em linhas gerais sistemas operacionais POSIX. File I/O, socket handling, e threading se comportam como em qualquer sistema operacional POSIX. Entretanto, existem diversas diferenças:


@itemize *

@item 
Plataformas móveis podem usar o Python apenas no modo “incorporado”. Não existe um Python REPL, e não existe possibilidade para usar executáveis em separado como @code{python} ou @code{pip}. Para adicionar código Python para seu aplicativo móvel, você deve usar a @ref{1fdd,,API de incorporação do Python}. Para maiores detalhes veja @ref{1fdb,,Utilizando Python no Android} e @ref{1fe3,,Usando Python no iOS}.

@item 
Subprocessos:


@itemize *

@item 
No Android, criar subprocessos é possível mas oficialmente sem suporte@footnote{https://issuetracker.google.com/issues/128554619#comment4}. Em particular, Android não oferece suporte para nenhuma parte da API System V IPC, assim @ref{94,,multiprocessing} não está disponível.

@item 
Uma aplicação de iOS não pode usar qualquer forma de subprocessamento, multiprocessamento ou comunicação entre processos. Se uma aplicação de iOS tentar criar um subprocesso, o processo que cria o subprocesso será travado ou encerrado abruptamente. Uma aplicação de iOS não tem visibilidade de outras aplicações em execução, nem capacidade de comunicação com outras aplicações em execução, fora das APIs específicas do iOS que existem para essa finalidade.
@end itemize

@item 
Aplicativos móveis possuem acesso limitado a recursos do sistema (como o relógio do sistema). Esses recursos serão em sua maioria apenas `leitura', e tentativas de modificar esses recusos geralmente falhará.

@item 
Entrada e saída do console:


@itemize *

@item 
No Android, o @code{stdout} e o @code{stderr} nativos não estão conectados a nada, então o Python instala seus próprios fluxos que redirecionam mensagens para o log do sistema. Esses podem ser vistos sob a tags @code{python.stdout} e @code{python.stderr}, respectivamente.

@item 
As aplicações de iOS têm um conceito limitado de saída do console. @code{stdout} e @code{stderr} `existem', e o conteúdo escrito em @code{stdout} e @code{stderr} será visível nos registros (logs) quando executado no Xcode, mas este conteúdo `não' será gravado no registro do sistema. Se um usuário que instalou sua aplicação fornecer os registros da aplicação como ajuda de diagnóstico, eles não incluirão nenhum detalhe escrito em @code{stdout} ou @code{stderr}.

@item 
As aplicações para dispositivos móveis não têm nenhum conceito de @code{stdin}. Embora essas aplicações possam exibir um teclado na tele, este é um recurso de software, não algo anexado ao @code{stdin}.

Como consequência, módulos Python que envolvem manipulação de console (como @ref{2b,,curses} e @ref{ba,,readline}) não estão disponíveis em plataformas móveis.
@end itemize
@end itemize

@c XXX document all delegations to __special__ methods

@node Funções embutidas<3>,Constantes embutidas,Introdução<6>,A Biblioteca Padrão do Python
@anchor{library/functions doc}@anchor{22e9}@anchor{library/functions built-in-funcs}@anchor{129e}@anchor{library/functions built-in-functions}@anchor{22ea}@anchor{library/functions translation-repo}@anchor{22eb}
@section Funções embutidas


O interpretador do Python possui várias funções e tipos embutidos que sempre estão disponíveis. A seguir listamos todas as funções em ordem alfabética.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Funções embutidas

@tab

@tab

@tab

@item


@display
`A'@w{ }
@ref{1e2d,,abs()}@w{ }
@ref{7d6,,aiter()}@w{ }
@ref{1469,,all()}@w{ }
@ref{7d7,,anext()}@w{ }
@ref{1468,,any()}@w{ }
@ref{142d,,ascii()}@w{ }
@w{ }
`B'@w{ }
@ref{12eb,,bin()}@w{ }
@ref{468,,bool()}@w{ }
@ref{234,,breakpoint()}@w{ }
@ref{1c34,,bytearray()}@w{ }
@ref{1c33,,bytes()}@w{ }
@w{ }
`C'@w{ }
@ref{1206,,callable()}@w{ }
@ref{1768,,chr()}@w{ }
@ref{166,,classmethod()}@w{ }
@ref{192,,compile()}@w{ }
@ref{2f8,,complex()}@w{ }
@w{ }
`D'@w{ }
@ref{22ec,,delattr()}@w{ }
@ref{22ed,,dict()}@w{ }
@ref{632,,dir()}@w{ }
@ref{9a9,,divmod()}@w{ }
@w{ }
@end display



@tab


@display
`E'@w{ }
@ref{14c9,,enumerate()}@w{ }
@ref{180,,eval()}@w{ }
@ref{17f,,exec()}@w{ }
@w{ }
`F'@w{ }
@ref{868,,filter()}@w{ }
@ref{2f7,,float()}@w{ }
@ref{61f,,format()}@w{ }
@ref{22ee,,frozenset()}@w{ }
@w{ }
`G'@w{ }
@ref{bea,,getattr()}@w{ }
@ref{1993,,globals()}@w{ }
@w{ }
`H'@w{ }
@ref{4d2,,hasattr()}@w{ }
@ref{5eb,,hash()}@w{ }
@ref{8dd,,help()}@w{ }
@ref{1312,,hex()}@w{ }
@w{ }
`I'@w{ }
@ref{146a,,id()}@w{ }
@ref{131b,,input()}@w{ }
@ref{257,,int()}@w{ }
@ref{442,,isinstance()}@w{ }
@ref{7c2,,issubclass()}@w{ }
@ref{7d8,,iter()}@w{ }
@end display



@tab


@display
`L'@w{ }
@ref{62e,,len()}@w{ }
@ref{22ef,,list()}@w{ }
@ref{141,,locals()}@w{ }
@w{ }
`M'@w{ }
@ref{867,,map()}@w{ }
@ref{f3b,,max()}@w{ }
@ref{22f0,,memoryview()}@w{ }
@ref{f3a,,min()}@w{ }
@w{ }
`N'@w{ }
@ref{7d9,,next()}@w{ }
@w{ }
`O'@w{ }
@ref{a96,,object()}@w{ }
@ref{1311,,oct()}@w{ }
@ref{51c,,open()}@w{ }
@ref{2080,,ord()}@w{ }
@w{ }
`P'@w{ }
@ref{9da,,pow()}@w{ }
@ref{fa9,,print()}@w{ }
@ref{194,,property()}@w{ }
@w{ }
@w{ }
@w{ }
@w{ }
@end display



@tab


@display
`R'@w{ }
@ref{22f1,,range()}@w{ }
@ref{800,,repr()}@w{ }
@ref{869,,reversed()}@w{ }
@ref{131d,,round()}@w{ }
@w{ }
`S'@w{ }
@ref{22f2,,set()}@w{ }
@ref{22f3,,setattr()}@w{ }
@ref{469,,slice()}@w{ }
@ref{be7,,sorted()}@w{ }
@ref{416,,staticmethod()}@w{ }
@ref{22f4,,str()}@w{ }
@ref{46a,,sum()}@w{ }
@ref{4db,,super()}@w{ }
@w{ }
`T'@w{ }
@ref{22f5,,tuple()}@w{ }
@ref{d6b,,type()}@w{ }
@w{ }
`V'@w{ }
@ref{1bba,,vars()}@w{ }
@w{ }
`Z'@w{ }
@ref{7d1,,zip()}@w{ }
@w{ }
`_'@w{ }
@ref{8da,,__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{1e2d}
@deffn {Função} abs (number, /)

Retorna o valor absoluto de um número. O argumento pode ser um inteiro, um número de ponto flutuante ou um objeto implementando @ref{2146,,__abs__()}. Se o argumento é um número complexo, sua magnitude é retornada.
@end deffn

@geindex built-in function; aiter()
@anchor{library/functions aiter}@anchor{7d6}
@deffn {Função} aiter (async_iterable, /)

Retorna um @ref{1ab,,iterador assíncrono} para um @ref{d9c,,iterável assíncrono}. Equivalente a chamar @code{x.__aiter__()}.

Nota: Ao contrário de @ref{7d8,,iter()}, @ref{7d6,,aiter()} não tem uma variante de 2 argumentos.


Adicionado na versão 3.10.

@end deffn

@geindex built-in function; all()
@anchor{library/functions all}@anchor{1469}
@deffn {Função} all (iterable, /)

Retorna @code{True} se todos os elementos de `iterable' são verdadeiros (ou se `iterable' estiver vazio). Equivalente a:

@example
def all(iterable):
    for elemento in iterable:
        if not elemento:
            return False
    return True
@end example
@end deffn

@geindex built-in function; anext()
@anchor{library/functions anext}@anchor{7d7}
@deffn {Função} awaitable anext (async_iterator, /)

@deffnx {Função} awaitable anext (async_iterator, default, /)

Quando aguardado, retorna o próximo item do @ref{1ab,,iterador assíncrono} fornecido, ou `default' se fornecido e o iterador for esgotado.

Esta é a variante assíncrona do @ref{7d9,,next()} embutido, e se comporta de forma semelhante.

Isso chama o método @ref{1659,,__anext__()} de `async_iterator', retornando um @ref{1ad,,aguardável}. Ao aguardar isso, retorna o próximo valor do iterador. Se `default' for fornecido, ele será retornado se o iterador for esgotado, caso contrário, a exceção @ref{1ba5,,StopAsyncIteration} será levantada.


Adicionado na versão 3.10.

@end deffn

@geindex built-in function; any()
@anchor{library/functions any}@anchor{1468}
@deffn {Função} any (iterable, /)

Retorna @code{True} se algum elemento de `iterable' for verdadeiro. Se `iterable' estiver vazio, retorna @code{False}. Equivalente a:

@example
def any(iterable):
    for elemento in iterable:
        if elemento:
            return True
    return False
@end example
@end deffn

@geindex built-in function; ascii()
@anchor{library/functions ascii}@anchor{142d}
@deffn {Função} ascii (object, /)

Como @ref{800,,repr()}, retorna uma string contendo uma representação imprimível de um objeto, mas faz escape de caracteres não-ASCII na string retornada por @ref{800,,repr()} usando sequências de escapes @code{\x}, @code{\u} ou @code{\U}. Isto gera uma string similar ao que é retornado por @ref{800,,repr()} no Python 2.
@end deffn

@geindex built-in function; bin()
@anchor{library/functions bin}@anchor{12eb}
@deffn {Função} bin (integer, /)

Converte um número inteiro para uma string de binários prefixada com “0b”. O resultado é uma expressão Python válida. Se `integer' não é um objeto Python @ref{257,,int}, ele tem que definir um método @ref{71d,,__index__()} que devolve um inteiro. Alguns exemplos:

@example
>>> bin(3)
'0b11'
>>> bin(-10)
'-0b1010'
@end example

Se o prefixo “0b” é desejado ou não, você pode usar uma das seguintes maneiras.

@example
>>> format(14, '#b'), format(14, 'b')
('0b1110', '1110')
>>> f'@{14:#b@}', f'@{14:b@}'
('0b1110', '1110')
@end example

Veja também @ref{61f,,format()} para mais informações.
@end deffn

@geindex bool (classe interna)
@anchor{library/functions bool}@anchor{468}
@deffn {Classe} bool (object=False, /)

Retorna um valor Booleano, isto é, @code{True} ou @code{False}. O argumento é convertido usando o @ref{162d,,procedimento de teste de verdade} padrão. Se o argumento for falso ou foi omitido, isso retorna @code{False}; senão @code{True}. A classe @ref{468,,bool} é uma subclasse de @ref{257,,int} (veja @ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}). Ela não pode ser usada para criar outra subclasse. Suas únicas instâncias são @code{False} e @code{True} (veja @ref{22f6,,Tipo booleano - bool}).

@geindex Booleano;tipo


Alterado na versão 3.7: O parâmetro agora é somente-posicional

@end deffn

@geindex built-in function; breakpoint()
@anchor{library/functions breakpoint}@anchor{234}
@deffn {Função} breakpoint (*args, **kws)

Esta função coloca você no depurador no local da chamada. Especificamente, ela chama @ref{aea,,sys.breakpointhook()}, passando @code{args} e @code{kws} diretamente. Por padrão, @code{sys.breakpointhook()} chama @ref{235,,pdb.set_trace()} não esperando nenhum argumento. Neste caso, isso é puramente uma função de conveniência para você não precisar importar @ref{a5,,pdb} explicitamente ou digitar mais código para entrar no depurador. Contudo, @ref{aea,,sys.breakpointhook()} pode ser configurado para alguma outra função e @ref{234,,breakpoint()} irá automaticamente chamá-la, permitindo você ir para o depurador de sua escolha. Se @ref{aea,,sys.breakpointhook()} não estiver acessível, esta função vai levantar @ref{195,,RuntimeError}.

Por padrão, o comportamento de @ref{234,,breakpoint()} pode ser alterado com a variável de ambiente 
@geindex PYTHONBREAKPOINT
@geindex variável de ambiente; PYTHONBREAKPOINT
@ref{aeb,,PYTHONBREAKPOINT}. Veja @ref{aea,,sys.breakpointhook()} para detalhes de uso.

Observe que isso não é garantido se @ref{aea,,sys.breakpointhook()} tiver sido substituído.

Levanta um @ref{19fa,,evento de auditoria} @code{builtins.breakpoint} com o argumento @code{breakpointhook}.


Adicionado na versão 3.7.

@end deffn

@anchor{library/functions func-bytearray}@anchor{1c34}
@deffn {Classe} bytearray (source=b'@w{'})

@deffnx {Classe} bytearray (source, encoding, errors='strict')

Retorna um novo vetor de bytes. A classe @ref{2ea,,bytearray} é uma sequência mutável de inteiros no intervalo 0 <= x < 256. Ela tem a maior parte dos métodos mais comuns de sequências mutáveis, descritas em @ref{22f7,,Tipos sequências mutáveis}, assim como a maior parte dos métodos que o tipo @ref{1c2,,bytes} tem, veja @ref{22f8,,Operações com Bytes e Bytearray}.

O parâmetro opcional `source' pode ser usado para inicializar o vetor de algumas maneiras diferentes:


@itemize *

@item 
Se é uma `string', você deve informar o parâmetro `encoding' (e opcionalmente, `errors'); @ref{2ea,,bytearray()} então converte a string para bytes usando @ref{8db,,str.encode()}.

@item 
Se é um `inteiro', o vetor terá esse tamanho e será inicializado com bytes nulos.

@item 
Se é um objeto em conformidade com a @ref{2e8,,interface de buffer}, um buffer somente leitura do objeto será usado para inicializar o vetor de bytes.

@item 
Se é um `iterável', deve ser um iterável de inteiros no intervalo @code{0 <= x < 256}, que serão usados como o conteúdo inicial do vetor.
@end itemize

Sem nenhum argumento, um vetor de tamanho 0 é criado.

Veja também @ref{22f9,,Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview} e @ref{22fa,,Objetos Bytearray}.
@end deffn

@anchor{library/functions func-bytes}@anchor{1c33}
@deffn {Classe} bytes (source=b'@w{'})

@deffnx {Classe} bytes (source, encoding, errors='strict')

Retorna um novo objeto “bytes” que é uma sequência imutável de inteiros no intervalo @code{0 <= x < 256}. @ref{1c2,,bytes} é uma versão imutável de @ref{2ea,,bytearray} – tem os mesmos métodos de objetos imutáveis e o mesmo comportamento de índices e fatiamento.

Consequentemente, argumentos do construtor são interpretados como os de @ref{2ea,,bytearray()}.

Objetos bytes também podem ser criados com literais, veja @ref{2031,,Literais de string e bytes}.

Veja também @ref{22f9,,Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview}, @ref{22fb,,Objetos bytes}, e @ref{22f8,,Operações com Bytes e Bytearray}.
@end deffn

@geindex built-in function; callable()
@anchor{library/functions callable}@anchor{1206}
@deffn {Função} callable (object, /)

Retorna @ref{c27,,True} se o argumento `object' parece ser chamável, @ref{b49,,False} caso contrário. Se retorna @code{True}, ainda é possível que a chamada falhe, mas se é @code{False}, chamar `object' nunca será bem sucedido. Note que classes são chamáveis (chamar uma classe devolve uma nova instância); instâncias são chamáveis se suas classes possuem um método @ref{558,,__call__()}.


Adicionado na versão 3.2: Esta função foi removida na versão 3.0, mas retornou no Python 3.2.

@end deffn

@geindex built-in function; chr()
@anchor{library/functions chr}@anchor{1768}
@deffn {Função} chr (codepoint, /)

Retorna a string representando um caractere com o ponto de código Unicode especificado. Por exemplo, @code{chr(97)} retorna a string @code{'a'}, enquanto @code{chr(8364)} retorna a string @code{'€'}. É o inverso de @ref{2080,,ord()}.

O intervalo válido para o argumento vai de 0 até 1.114.111 (0x10FFFF na base 16). Será lançada uma exceção @ref{202,,ValueError} se ele estiver fora desse intervalo.
@end deffn

@geindex built-in function; classmethod()
@anchor{library/functions classmethod}@anchor{166}
@deffn {Função} @@classmethod

Transforma um método em um método de classe.

Um método de classe recebe a classe como um primeiro argumento implícito, exatamente como um método de instância recebe a instância. Para declarar um método de classe, faça dessa forma:

@example
class C:
    @@classmethod
    def f(cls, arg1, arg2): ...
@end example

O termo @code{@@classmethod} é uma função @ref{731,,decoradora} – veja @ref{1db6,,Definições de função} para detalhes.

Um método de classe pode ser chamado tanto da classe (como em @code{C.f()}) quanto da instância (como em @code{C().f()}). A instância é ignorada, exceto por sua classe. Se um método de classe é chamado por uma classe derivada, o objeto da classe derivada é passado como primeiro argumento implícito.

Métodos de classe são diferentes de métodos estáticos em C++ ou Java. Se você quer saber desses, veja @ref{416,,staticmethod()} nesta seção. Para mais informações sobre métodos de classe, consulte @ref{2075,,A hierarquia de tipos padrão}.


Alterado na versão 3.9: Métodos de classe agora podem envolver outros @ref{1658,,descritores} tal como @ref{194,,property()}.



Alterado na versão 3.10: Métodos de classe agora herdam os atributos do método (@ref{208e,,__module__}, @ref{1317,,__name__}, @ref{208d,,__qualname__}, @ref{1219,,__doc__} e @ref{1218,,__annotations__}) e têm um novo atributo @code{__wrapped__}.



Descontinuado desde a versão 3.11, removido na versão 3.13: Métodos de classe não podem mais envolver outros @ref{1658,,descritores} tal como @ref{194,,property()}.

@end deffn

@geindex built-in function; compile()
@anchor{library/functions compile}@anchor{192}
@deffn {Função} compile (source, filename, mode, flags=0, dont_inherit=False, optimize=-1)

Compila o argumento `source' em código ou objeto AST. Objetos código podem ser executados por @ref{17f,,exec()} ou @ref{180,,eval()}. `source' pode ser uma string normal, uma string byte, ou um objeto AST. Consulte a documentação do módulo @ref{8,,ast} para saber como trabalhar com objetos AST.

O argumento `filename' deve ser o arquivo de onde o código será lido; passe algum valor reconhecível se isso não foi lido de um arquivo (@code{'<string>'} é comumente usado).

O argumento `mode' especifica qual o tipo de código deve ser compilado; pode ser @code{'exec'} se `source' consiste em uma sequência de instruções, @code{'eval'} se consiste de uma única expressão, ou @code{'single'} se consiste de uma única instrução interativa (neste último caso, instruções que são avaliadas para alguma coisa diferente de @code{None} serão exibidas).

Os argumentos opcionais `flags' e `dont_inherit' controlam quais @ref{22fc,,opções do compilador} devem ser ativadas e quais @ref{189,,recursos futuros} devem ser permitidos. Se nenhum estiver presente (ou ambos forem zero), o código é compilado com os mesmos sinalizadores que afetam o código que está chamando @ref{192,,compile()}. Se o argumento `flags' for fornecido e `dont_inherit' não for (ou for zero), as opções do compilador e as instruções futuras especificadas pelo argumento `flags' são usadas além daquelas que seriam usadas de qualquer maneira. Se `dont_inherit' for um inteiro diferente de zero, então o argumento `flags' é – os sinalizadores (recursos futuros e opções do compilador) no código circundante são ignorados.

Opções de compilador e instruções futuras são especificadas por bits, assim pode ocorrer uma operação `OU' bit a bit para especificar múltiplas instruções. O sinalizador necessário para especificar um dado recurso futuro pode ser encontrado no atributo @ref{20d8,,compiler_flag} na instância @ref{22fd,,_Feature} do módulo @ref{0,,__future__}. @ref{22fc,,Sinalizadores de compilador} podem ser encontrados no módulo @ref{8,,ast}, com o prefixo @code{PyCF_}.

O argumento `optimize' especifica o nível de otimização do compilador; o valor padrão de @code{-1} seleciona o nível de otimização do interpretador dado pela opção @ref{ddd,,-O}. Níveis explícitos são @code{0} (nenhuma otimização; @code{__debug__} é verdadeiro), @code{1} (instruções @code{assert} são removidas, @code{__debug__} é falso) ou @code{2} (strings de documentação também são removidas).

Essa função levanta @ref{18d,,SyntaxError} ou @ref{202,,ValueError} se a fonte compilada for inválida.

Se você quer analisar código Python em sua representação AST, veja @ref{1a8,,ast.parse()}.

Levanta um @ref{19fa,,evento de auditoria} @code{compile} com os argumentos @code{source}, @code{filename}. Esse evento pode também ser levantando por uma compilação implícita.

@cartouche
@quotation Nota 
Quando compilando uma string com código multi-linhas em modo @code{'single'} ou @code{'eval'}, entrada deve ser terminada por ao menos um caractere de nova linhas. Isso é para facilitar a detecção de instruções completas e incompletas no módulo @ref{1a,,code}.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
É possível quebrar o interpretador Python com uma string suficientemente grande/complexa ao compilar para um objeto AST, devido limitações do tamanho da pilha no compilador AST do Python.
@end quotation
@end cartouche


Alterado na versão 3.2: Permitido o uso de marcadores de novas linhas no estilo Windows e Mac. Além disso, em modo @code{'exec'} a entrada não precisa mais terminar com uma nova linha. Também foi adicionado o parâmetro `optimize'.



Alterado na versão 3.5: Anteriormente, @ref{2c3,,TypeError} era levantada quando havia bytes nulos em `source'.



Adicionado na versão 3.8: @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT} agora pode ser passado em `flags' para habilitar o suporte em nível superior a @code{await}, @code{async for}, e @code{async with}.

@end deffn

@geindex complex (classe interna)
@anchor{library/functions complex}@anchor{2f8}
@deffn {Classe} complex (number=0, /)

@deffnx {Classe} complex (string, /)

@deffnx {Classe} complex (real=0, imag=0)

Converte uma única string ou número para um número complexo, ou cria um número complexo a partir de partes real e imaginária.

Exemplos:

@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

Se o argumento for uma string, ele deve conter ou a parte real (com o mesmo formato usado em @ref{2f7,,float()}) ou uma parte imaginária (com o mesmo formato, mas com um sufixo @code{'j'} ou @code{'J'}), ou então ambas as partes real e imaginária (caso no qual o sinal da parte imaginária é obrigatório). A string pode opcionalmente ser cercada por espaços em branco e parênteses @code{'('} e @code{')'}, que são ignorados. A string não deve conter espaços em branco entre os símbolos @code{'+'}, @code{'-'}, o sufixo @code{'j'} ou @code{'J'}, e o número decimal. Por exemplo, @code{complex('1+2j')} é ok, mas @code{complex('1 + 2j')} levanta @ref{202,,ValueError}. Mais precisamente, após descartar os parênteses e os espaços em branco do início e do final, a entrada deve ser conforme a regra de produção @ref{22fe,,complexvalue} da gramática a seguir:

@example
@anchor{library/functions grammar-token-float-complexvalue}@anchor{22fe}complexvalue ::= @ref{22ff,,floatvalue} |
                 @ref{22ff,,floatvalue} ("j" | "J") |
                 @ref{22ff,,floatvalue} @ref{2300,,sign} @ref{2301,,absfloatvalue} ("j" | "J")
@end example

Se o argumento for um número, o construtor serve como uma conversão numérica tal qual @ref{257,,int} e @ref{2f7,,float}. Para um objeto Python @code{x} qualquer, @code{complex(x)} delega para @code{x.__complex__()}. Se @ref{5e7,,__complex__()} não está definido então a chamada é repassada para @ref{9d4,,__float__()}. Se @code{__float__()} não está definido então a chamada é, novamente, repassada para @ref{71d,,__index__()}.

Se dois argumentos forem passados ou argumentos nomeados forem usados, cada argumento pode ser de qualquer tipo numérico (incluindo complexo). Se ambos argumentos forem números reais, é retornado um número complexo com `real' como parte real e `imag' como parte imaginária. Se ambos os argumentos forem números complexos, é retornado um número complexo com parte real @code{real.real-imag.imag} e parte imaginária @code{real.imag+imag.real}. Se um dos argumentos for um número real, somente a sua parte real é usada nas expressões anteriores.

Se todos os argumentos forem omitidos, retorna @code{0j}.

O tipo complexo está descrito em @ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}.


Alterado na versão 3.6: Agrupar dígitos com sublinhados como em literais de código é permitido.



Alterado na versão 3.8: Chamadas para @ref{71d,,__index__()} se @ref{5e7,,__complex__()} e @ref{9d4,,__float__()} não estão definidas.

@end deffn

@geindex built-in function; delattr()
@anchor{library/functions delattr}@anchor{22ec}
@deffn {Função} delattr (object, name, /)

Essa função está relacionada com @ref{22f3,,setattr()}. Os argumentos são um objeto e uma string. A string deve ser o nome de um dos atributos do objeto. A função remove o atributo indicado, desde que o objeto permita. Por exemplo, @code{delattr(x, 'foobar')} é equivalente a @code{del x.foobar}. `name' não precisa ser um identificador Python  (veja @ref{22f3,,setattr()}).
@end deffn

@anchor{library/functions func-dict}@anchor{22ed}
@deffn {Classe} dict (**kwargs)

@deffnx {Classe} dict (mapping, /, **kwargs)

@deffnx {Classe} dict (iterable, /, **kwargs)

Cria um novo dicionário. O objeto @ref{256,,dict} é a classe do dicionário. Veja @ref{256,,dict} e @ref{ad6,,Tipo mapeamento — dict} para documentação sobre esta classe.

Para outros contêineres, consulte as classes embutidas @ref{611,,list}, @ref{5d9,,set} e @ref{370,,tuple}, bem como o módulo @ref{1d,,collections}.
@end deffn

@geindex built-in function; dir()
@anchor{library/functions dir}@anchor{632}
@deffn {Função} dir ()

@deffnx {Função} dir (object, /)

Sem argumentos, devolve a lista de nomes no escopo local atual. Com um argumento, tentará devolver uma lista de atributos válidos para esse objeto.

Se o objeto tiver um método chamado @ref{15fe,,__dir__()}, esse método será chamado e deve devolver a lista de atributos. Isso permite que objetos que implementam uma função personalizada @ref{4d3,,__getattr__()} ou @ref{beb,,__getattribute__()} personalizem a maneira como @ref{632,,dir()} relata seus atributos.

Se o objeto não fornecer @code{__dir__()}, a função tentará o melhor possível para coletar informações do atributo @ref{55b,,__dict__} do objeto, se definido, e do seu objeto de tipo. A lista resultante não está necessariamente completa e pode ser imprecisa quando o objeto possui um @ref{4d3,,__getattr__()} personalizado.

O mecanismo padrão @ref{632,,dir()} se comporta de maneira diferente com diferentes tipos de objetos, pois tenta produzir as informações mais relevantes e não completas:


@itemize *

@item 
Se o objeto for um objeto de módulo, a lista conterá os nomes dos atributos do módulo.

@item 
Se o objeto for um objeto de tipo ou classe, a lista conterá os nomes de seus atributos e recursivamente os atributos de suas bases.

@item 
Caso contrário, a lista conterá os nomes dos atributos do objeto, os nomes dos atributos da classe e recursivamente os atributos das classes base da classe.
@end itemize

A lista resultante é alfabeticamente ordenada. Por exemplo:

@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 
Como @ref{632,,dir()} é fornecido principalmente como uma conveniência para uso em um prompt interativo, ele tenta fornecer um conjunto interessante de nomes mais do que tenta fornecer um conjunto de nomes definido de forma rigorosa ou consistente, e seu comportamento detalhado pode mudar nos lançamentos. Por exemplo, os atributos de metaclasse não estão na lista de resultados quando o argumento é uma classe.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; divmod()
@anchor{library/functions divmod}@anchor{9a9}
@deffn {Função} divmod (a, b, /)

Recebe dois números (não complexos) como argumentos e retorna um par de números que consiste em seu quociente e resto ao usar a divisão inteira. Com tipos de operandos mistos, as regras para operadores aritméticos binários se aplicam. Para números inteiros, o resultado é o mesmo que @code{(a // b, a % b)}. Para números de ponto flutuante, o resultado é @code{(q, a % b)}, onde `q' geralmente é @code{math.floor(a / b)}, mas pode ser 1 a menos que isso. Em qualquer caso, @code{q * b + a % b} está muito próximo de `a', se @code{a % b} é diferente de zero, tem o mesmo sinal que `b' e @code{0 <= abs(a % b) < abs(b)}.
@end deffn

@geindex built-in function; enumerate()
@anchor{library/functions enumerate}@anchor{14c9}
@deffn {Função} enumerate (iterable, start=0)

Devolve um objeto enumerado. `iterable' deve ser uma sequência, um @ref{1ac,,iterador} ou algum outro objeto que suporte a iteração. O método @ref{1310,,__next__()} do iterador retornado por @ref{14c9,,enumerate()} devolve uma tupla contendo uma contagem (a partir de `start', cujo padrão é 0) e os valores obtidos na iteração 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{2302}@anchor{library/functions eval}@anchor{180}
@deffn {Função} eval (source, /, globals=None, locals=None)

@*Parâmetros: 

@itemize *

@item 
@code{source} (@ref{44c,,str} | @ref{1d2,,code object}) – Uma expressão Python.

@item 
@code{globals} (@ref{256,,dict} | @code{None}) – O espaço de nomes global (por padrão, @code{None}).

@item 
@code{locals} (@ref{11fb,,mapping} | @code{None}) – O espaço de nomes local (por padrão, @code{None}).
@end itemize


@*Retorna: 
O resultado da expressão avaliada.


@*levanta: 
Erros de sintaxe são reportados como exceções.


@cartouche
@quotation Aviso 
Esta função executa código arbitrário. Chamá-la com entrada fornecida pelo usuário pode levar a vulnerabilidades de segurança.
@end quotation
@end cartouche

O argumento `source' é analisado e avaliado como uma expressão Python (tecnicamente, uma lista de condições), usando os dicionários `globals' e `locals' como espaço de nomes global e local. Se o dicionário `globals' estiver presente e não contiver um valor para a chave @code{__builtins__}, uma referência ao dicionário do módulo @ref{12,,builtins} é inserida sob essa chave antes de `source' ser analisado. Dessa forma, pode controlar quais embutidos estão disponíveis para o código executado, inserindo o seu próprio dicionário @code{__builtins__} em `globals' antes de passá-lo à função @ref{180,,eval()}. Se o dicionário `locals' for omitido, o valor predefinido é o dicionário `globals'. Se ambos os mapeamentos forem omitidos, `source' é executado com os `globals' e `locals' do ambiente em que @ref{180,,eval()} é chamada. Note que `eval()' só terá acesso aos @ref{20d0,,escopos aninhados} (`non-locals') no ambiente que a contém se eles já estiverem referenciados no escopo que chama @ref{180,,eval()} (por exemplo, através de uma instrução @ref{12ea,,nonlocal}).

Exemplo:

@example
>>> x = 1
>>> eval('x+1')
2
@end example

Esta função também pode ser usada para executar objetos código arbitrários (como os criados por @ref{192,,compile()}). Nesse caso, passe um objeto código em vez de uma string. Se o objeto código foi compilado com @code{'exec'} como o argumento `mode', o valor de retorno de @ref{180,,eval()} será @code{None}.

Dicas: a execução dinâmica de instruções é suportada pela função @ref{17f,,exec()}. As funções @ref{1993,,globals()} e @ref{141,,locals()} retornam o dicionário global e local atual, respectivamente, o que pode ser útil para ser usado por @ref{180,,eval()} ou @ref{17f,,exec()}.

Se a fonte fornecida for uma string, os espaços e tabulações à esquerda ou à direita serão removidos.

Veja @ref{c32,,ast.literal_eval()} para uma função que pode avaliar com segurança strings com expressões contendo apenas literais.

Levanta um @ref{19fa,,evento de auditoria} @code{exec} com o código objeto como argumento. Eventos de compilação de código também podem ser levantados.


Alterado na versão 3.13: Os argumentos `globals' e `locals' podem agora ser passados como argumentos nomeados.



Alterado na versão 3.13: A forma de uso do espaço de nomes `locals' padrão foi ajustado conforme descrito na função embutida @ref{141,,locals()}.

@end deffn

@geindex função embutida;exec

@geindex built-in function; exec()
@anchor{library/functions exec}@anchor{17f}
@deffn {Função} exec (source, /, globals=None, locals=None, *, closure=None)

@cartouche
@quotation Aviso 
Esta função executa código arbitrário. Chamá-la com entrada fornecida pelo usuário pode levar a vulnerabilidades de segurança.
@end quotation
@end cartouche

Esta função suporta a execução dinâmica de código Python. O parâmetro `source' deve ser ou uma string ou um objeto código. Se for uma string, a mesma é analisada como um conjunto de instruções Python, o qual é então executado (exceto caso um erro de sintaxe ocorra). @footnote{
Observe que o analisador sintático aceita apenas a convenção de fim de linha no estilo Unix. Se você estiver lendo o código de um arquivo, use o modo de conversão de nova linha para converter novas linhas no estilo Windows ou Mac.
} Se for um objeto código, ele é simplesmente executado. Em todos os casos, espera-se que o código a ser executado seja válido como um arquivo de entrada (veja a seção @ref{22d3,,Entrada de arquivo} no Manual de Referência). Tenha cuidado, pois as instruções @ref{12ea,,nonlocal}, @ref{9d5,,yield} e @ref{9d6,,return} não podem ser usadas fora das definições de funções mesmo dentro do contexto do código passado para a função @ref{17f,,exec()} . O valor de retorno é sempre @code{None}.

Em todos os casos, se os parâmetros opcionais são omitidos, o código é executado no escopo atual. Se somente `globals' é fornecido, deve ser um dicionário (e não uma subclasse de dicionário), que será usado tanto para as variáveis globais quanto para locais. Se `globals' e `locals' são fornecidos, eles são usados para as variáveis globais e locais, respectivamente. Se fornecido, `locals' pode ser qualquer objeto de mapeamento. Lembre que no nível de módulo, globais e locais são o mesmo dicionário.

@cartouche
@quotation Nota 
Quando or @code{exec} recebe dois objetos separados como `globals' and `locals', o código será executado como se estivesse embutido em uma definição de classe. Isso significa que funções e classes definidas no código executado não poderão acessar variáveis que sofreram atribuições no escopo mais externo (pois, em uma definição de classe, tais variáveis seriam tratadas como variáveis de classe).
@end quotation
@end cartouche

Se o dicionário `globals' não contém um valor para a chave @code{__builtins__}, a referência para o dicionário do módulo embutido @ref{12,,builtins} é inserido com essa chave. A maneira que você pode controlar quais embutidos estão disponíveis para o código executado é inserindo seu próprio @code{__builtins__} dicionário em `globals' antes de passar para @ref{17f,,exec()}.

O argumento `closure' especifica uma clausura – uma tupla de cellvars. Só é válido quando o `objeto' é um objeto código contendo @ref{20d1,,variáveis livres (de clausura)}. O comprimento da tupla deve corresponder exatamente ao comprimento do atributo @ref{208b,,co_freevars} do objeto código.

Levanta um @ref{19fa,,evento de auditoria} @code{exec} com o código objeto como argumento. Eventos de compilação de código também podem ser levantados.

@cartouche
@quotation Nota 
As funções embutidas @ref{1993,,globals()} e @ref{141,,locals()} devolvem o espaço de nomes global e local, respectivamente, o que pode ser útil para passar adiante e usar como segundo ou terceiro argumento para @ref{17f,,exec()}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
`locals' padrão atua como descrito pela função @ref{141,,locals()} abaixo. Se você precisa ver efeitos do código em `locals' depois da função @ref{17f,,exec()} retornar passe um dicionário `locals' explícito.
@end quotation
@end cartouche


Alterado na versão 3.11: Adicionado o parâmetro `closure'.



Alterado na versão 3.13: Os argumentos `globals' e `locals' podem agora ser passados como argumentos nomeados.



Alterado na versão 3.13: A forma de uso do espaço de nomes `locals' padrão foi ajustado conforme descrito na função embutida @ref{141,,locals()}.

@end deffn

@geindex built-in function; filter()
@anchor{library/functions filter}@anchor{868}
@deffn {Função} filter (function, iterable, /)

Constrói um iterador a partir dos elementos de `iterable' para os quais `function' é verdadeiro. `iterable' pode ser uma sequência, um contêiner que com suporte a iteração, ou um iterador. Se `function' for @code{None}, a função identidade será usada, isto é, todos os elementos de `iterable' que são falsos são removidos.

Note que @code{filter(function, iterable)} é equivalente a expressão geradora @code{(item for item in iterable if function(item))} se `function' não for @code{None} e @code{(item for item in iterable if item)} se `function' for @code{None}.

Veja @ref{2303,,itertools.filterfalse()} para a função complementar que devolve elementos de `iterable' para os quais `function' é falso.
@end deffn

@geindex float (classe interna)
@anchor{library/functions float}@anchor{2f7}
@deffn {Classe} float (number=0.0, /)

@deffnx {Classe} float (string, /)

@geindex NaN
@geindex Infinity

Retorna um número de ponto flutuante construído a partir de um número ou string.

Exemplos:

@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

Se o argumento for uma string, ele deve conter um número decimal, opcionalmente precedido por um sinal e opcionalmente embutido em um espaço em branco. O sinal opcional pode ser @code{'+'} ou @code{'-'}; um sinal @code{'+'} não tem efeito no valor produzido. O argumento também pode ser uma string representando um NaN (não um número) ou infinito positivo ou negativo. Mais precisamente, a entrada deve estar de acordo com a regra de produção @ref{22ff,,floatvalue} na seguinte gramática, depois que os espaços em branco iniciais e finais forem removidos:

@example
@anchor{library/functions grammar-token-float-sign}@anchor{2300}sign          ::= "+" | "-"
@anchor{library/functions grammar-token-float-infinity}@anchor{2304}infinity      ::= "Infinity" | "inf"
@anchor{library/functions grammar-token-float-nan}@anchor{2305}nan           ::= "nan"
@anchor{library/functions grammar-token-float-digit}@anchor{2306}digit         ::= <a Unicode decimal digit, i.e. characters in Unicode general category Nd>
@anchor{library/functions grammar-token-float-digitpart}@anchor{2307}digitpart     ::= @ref{2306,,digit} (["_"] @ref{2306,,digit})*
@anchor{library/functions grammar-token-float-number}@anchor{2308}number        ::= [@ref{2307,,digitpart}] "." @ref{2307,,digitpart} | @ref{2307,,digitpart} ["."]
@anchor{library/functions grammar-token-float-exponent}@anchor{2309}exponent      ::= ("e" | "E") [@ref{2300,,sign}] @ref{2307,,digitpart}
@anchor{library/functions grammar-token-float-floatnumber}@anchor{230a}floatnumber   ::= @ref{2308,,number} [@ref{2309,,exponent}]
@anchor{library/functions grammar-token-float-absfloatvalue}@anchor{2301}absfloatvalue ::= @ref{230a,,floatnumber} | @ref{2304,,infinity} | @ref{2305,,nan}
@anchor{library/functions grammar-token-float-floatvalue}@anchor{22ff}floatvalue    ::= [@ref{2300,,sign}] @ref{2301,,absfloatvalue}
@end example

O caso não é significativo, então, por exemplo, “inf”, “Inf”, “INFINITY” e “iNfINity” são todas grafias aceitáveis para o infinito positivo.

Caso contrário, se o argumento é um inteiro ou um número de ponto flutuante, um número de ponto flutuante com o mesmo valor (com a precisão de ponto flutuante de Python) é retornado. Se o argumento está fora do intervalo de um ponto flutuante Python, uma exceção @ref{885,,OverflowError} será lançada.

Para um objeto Python genérico @code{x}, @code{float(x)} delega para o método @code{x.__float__()}. Se @ref{9d4,,__float__()} não estiver definido, então ele delega para o método @ref{71d,,__index__()}.

Se nenhum argumento for fornecido, será retornado @code{0.0}.

O tipo float é descrito em @ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}.


Alterado na versão 3.6: Agrupar dígitos com sublinhados como em literais de código é permitido.



Alterado na versão 3.7: O parâmetro agora é somente-posicional



Alterado na versão 3.8: Chamada para @ref{71d,,__index__()} se @ref{9d4,,__float__()} não está definido.

@end deffn

@geindex __format__
@geindex string;format() (função embutida)

@geindex built-in function; format()
@anchor{library/functions format}@anchor{61f}
@deffn {Função} format (value, format_spec='@w{'}, /)

Converte um valor `value' em uma representação “formatada”, controlado por `format_spec'. A interpretação de `format_spec' dependerá do tipo do argumento `value'; no entanto há uma sintaxe de formatação padrão usada pela maioria dos tipos embutidos: @ref{1e8,,Minilinguagem de especificação de formato}.

O `format_spec' padrão é uma string vazia que geralmente produz o mesmo efeito que chamar @ref{44c,,str(value)}.

Uma chamada de @code{format(value, format_spec)} é convertida em @code{type(value).__format__(value, format_spec)}, que ignora o dicionário da instância ao pesquisar o método @ref{61e,,__format__()} de @code{value}. Uma exceção @ref{2c3,,TypeError} é levantada se a pesquisa do método atingir @ref{a96,,object} e o `format_spec' não estiver vazio, ou se o `format_spec' ou o valor de retorno não forem strings.


Alterado na versão 3.4: @code{object().__format__(format_spec)} levanta um @ref{2c3,,TypeError} se `format_spec' não for uma string vazia.

@end deffn

@anchor{library/functions func-frozenset}@anchor{22ee}
@deffn {Classe} frozenset (iterable=(), /)

Devolve um novo objeto @ref{5da,,frozenset}, opcionalmente com elementos obtidos de `iterable'. @code{frozenset} é uma classe embutida. Veja @ref{5da,,frozenset} e @ref{1dcf,,Tipo conjuntos — set@comma{} frozenset} para documentação sobre essas classes.

Para outros contêineres veja as classes embutidas @ref{5d9,,set}, @ref{611,,list}, @ref{370,,tuple}, e @ref{256,,dict}, assim como o módulo @ref{1d,,collections}.
@end deffn

@geindex built-in function; getattr()
@anchor{library/functions getattr}@anchor{bea}
@deffn {Função} getattr (object, name, /)

@deffnx {Função} getattr (object, name, default, /)

Devolve o valor do atributo `name' de `object'. `name' deve ser uma string. Se a string é o nome de um dos atributos do objeto, o resultado é o valor de tal atributo. Por exemplo, @code{getattr(x, 'foobar')} é equivalente a @code{x.foobar}. Se o atributo não existir, `default' é devolvido se tiver sido fornecido, caso contrário a exceção @ref{34b,,AttributeError} é levantada. `name' não precisa ser um identificador Python (veja @ref{22f3,,setattr()}).

@cartouche
@quotation Nota 
Uma vez que @ref{1e43,,desfiguração de nome privado} acontece em tempo de compilação, deve-se manualmente mutilar o nome de um atributo privado (atributos com dois sublinhados à esquerda) para recuperá-lo com @ref{bea,,getattr()}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; globals()
@anchor{library/functions globals}@anchor{1993}
@deffn {Função} globals ()

Retorna o dicionário implementando o espaço de nomes do módulo atual. Para código dentro de funções, isso é definido quando a função é definida e permanece o mesmo, independentemente de onde a função é chamada.
@end deffn

@geindex built-in function; hasattr()
@anchor{library/functions hasattr}@anchor{4d2}
@deffn {Função} hasattr (object, name, /)

Os argumentos são um objeto e uma string. O resultado é @code{True} se a string é o nome de um dos atributos do objeto, e @code{False} se ela não for. (Isto é implementado chamando @code{getattr(object, name)} e vendo se levanta um @ref{34b,,AttributeError} ou não.)
@end deffn

@geindex built-in function; hash()
@anchor{library/functions hash}@anchor{5eb}
@deffn {Função} hash (object, /)

Retorna o valor hash de um objeto (se houver um). Valores hash são números inteiros. Eles são usados para rapidamente comparar chaves de dicionários durante uma pesquisa em um dicionário. Valores numéricos que ao serem comparados são iguais, possuem o mesmo valor hash (mesmo que eles sejam de tipos diferentes, como é o caso de 1 e 1.0).

@cartouche
@quotation Nota 
Para objetos com métodos @ref{b0e,,__hash__()} personalizados, fique atento que @ref{5eb,,hash()} trunca o valor devolvido baseado no comprimento de bits da máquina hospedeira.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; help()
@anchor{library/functions help}@anchor{8dd}
@deffn {Função} help ()

@deffnx {Função} help (request)

Invoca o sistema de ajuda embutido. (Esta função é destinada para uso interativo.) Se nenhum argumento é passado, o sistema interativo de ajuda inicia no interpretador do console. Se o argumento é uma string, então a string é pesquisada como o nome de um módulo, função, classe, método, palavra-chave, ou tópico de documentação, e a página de ajuda é exibida no console. Se o argumento é qualquer outro tipo de objeto, uma página de ajuda para o objeto é gerada.

Note que se uma barra(/) aparecer na lista de parâmetros de uma função, quando invocando @ref{8dd,,help()}, significa que os parâmetros anteriores a barra são apenas posicionais. Para mais informações, veja @ref{230b,,a entrada no FAQ sobre parâmetros somente-posicionais}.

Esta função é adicionada ao espaço de nomes embutido pelo módulo @ref{c7,,site}.


Alterado na versão 3.4: Mudanças em @ref{b5,,pydoc} e @ref{7e,,inspect} significam que as assinaturas reportadas para chamáveis agora são mais compreensíveis e consistentes.

@end deffn

@geindex built-in function; hex()
@anchor{library/functions hex}@anchor{1312}
@deffn {Função} hex (integer, /)

Converte um número inteiro para uma string hexadecimal em letras minúsculas prefixada com “0x”. Se `integer' não é um objeto @ref{257,,int} do Python, ele tem que definir um método @ref{71d,,__index__()} que retorne um inteiro. Alguns exemplos:

@example
>>> hex(255)
'0xff'
>>> hex(-42)
'-0x2a'
@end example

Se você quer converter um número inteiro para uma string hexadecimal em letras maiúsculas ou minúsculas, com prefixo ou sem, você pode usar qualquer uma das seguintes maneiras:

@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

Veja também @ref{61f,,format()} para mais informações.

Veja também @ref{257,,int()} para converter uma string hexadecimal para um inteiro usando a base 16.

@cartouche
@quotation Nota 
Para obter uma string hexadecimal de um ponto flutuante, use o método @ref{1e9b,,float.hex()}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; id()
@anchor{library/functions id}@anchor{146a}
@deffn {Função} id (object, /)

Devolve a “identidade” de um objeto. Ele é um inteiro, o qual é garantido que será único e constante para este objeto durante todo o seu ciclo de vida. Dois objetos com ciclos de vida não sobrepostos podem ter o mesmo valor para @ref{146a,,id()}.

Este é o endereço do objeto na memória.

Levanta um @ref{19fa,,evento de auditoria} @code{builtins.id} com o argumento @code{id}.
@end deffn

@geindex built-in function; input()
@anchor{library/functions input}@anchor{131b}
@deffn {Função} input ()

@deffnx {Função} input (prompt, /)

Se o argumento `prompt' estiver presente, escreve na saída padrão sem uma nova linha ao final. A função então lê uma linha da fonte de entrada, converte a mesma para uma string (removendo o caractere de nova linha ao final), e devolve isso. Quando o final do arquivo (EOF / end-of-file) é encontrado, um erro @ref{131c,,EOFError} é levantado. Exemplo:

@example
>>> s = input('--> ')
--> Monty Python's Flying Circus
>>> s
"Monty Python's Flying Circus"
@end example

Se o módulo @ref{ba,,readline} foi carregado, então @ref{131b,,input()} usará ele para prover edição de linhas elaboradas e funcionalidades de histórico.

Levanta um @ref{19fa,,evento de auditoria} @code{builtins.input} com argumento @code{prompt} antes de ler a entrada.

Levanta um @ref{19fa,,evento de auditoria} @code{builtins.input/result} com o resultado depois de ler a entrada com sucesso.
@end deffn

@geindex int (classe interna)
@anchor{library/functions int}@anchor{257}
@deffn {Classe} int (number=0, /)

@deffnx {Classe} int (string, /, base=10)

Retorna um objeto do tipo inteiro construído a partir de um número ou string, ou retorna @code{0} caso nenhum argumento seja passado.

Exemplos:

@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

Se o argumento definir um método @ref{71c,,__int__()}, então @code{int(x)} retorna @code{x.__int__()}. Se `x' definir um método @ref{71d,,__index__()}, então ele retorna @code{x.__index__()}. Se o argumento definir um método @ref{71b,,__trunc__()}, então ele retorna @code{x.__trunc__()}. Para números de ponto flutuante, isto trunca o número na direção do zero.

Se o argumento não for um número ou se `base' for fornecido, então o argumento deve ser uma instância de string, @ref{1c2,,bytes} ou @ref{2ea,,bytearray} representando um inteiro na base `base'. Opcionalmente, a string pode ser precedida por @code{+} ou @code{-} (sem espaço entre eles), ter zeros à esquerda, estar entre espaços em branco e ter sublinhados simples intercalados entre os dígitos.

Uma string de inteiro de base n contém dígitos, cada um representando um valor de 0 a n-1. Os valores 0–9 podem ser representados por qualquer dígito decimal Unicode. Os valores 10–35 podem ser representados por @code{a} a @code{z} (ou @code{A} a @code{Z}). A `base' padrão é 10. As bases permitidas são 0 e 2–36. As strings base-2, -8 e -16 podem ser opcionalmente prefixadas com @code{0b}/@code{0B}, @code{0o}/@code{0O} ou @code{0x}/@code{0X}, como acontece com literais inteiros no código. Para a base 0, a string é interpretada de maneira semelhante a um @ref{2055,,literal inteiro no código}, em que a base real é 2, 8, 10 ou 16 conforme determinado pelo prefixo. A base 0 também não permite zeros à esquerda: @code{int('010', 0)} não é válido, enquanto @code{int('010')} e @code{int('010', 8)} são.

O tipo inteiro está descrito em @ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}.


Alterado na versão 3.4: Se `base' não é uma instância de @ref{257,,int} e o objeto `base' tem um método @ref{71d,,base.__index__}, então esse método é chamado para obter um inteiro para a base. Versões anteriores usavam @ref{71c,,base.__int__} ao invés de @ref{71d,,base.__index__}.



Alterado na versão 3.6: Agrupar dígitos com sublinhados como em literais de código é permitido.



Alterado na versão 3.7: O primeiro parâmetro agora é somente-posicional.



Alterado na versão 3.8: Chamada para @ref{71d,,__index__()} se @ref{71c,,__int__()} não está definido.



Alterado na versão 3.11: A delegação de @ref{71b,,__trunc__()} foi descontinuada.



Alterado na versão 3.11: Entradas de strings para @ref{257,,int} e representações em strings podem ser limitadas para ajudar a evitar ataques de negação de serviço. Uma exceção @ref{202,,ValueError} é levantada quando o limite é excedido durante a conversão de uma string em um @ref{257,,int} ou quando a conversão de um @ref{257,,int} em uma string excede o limite. Consulte a documentação sobre @ref{5f5,,limitação de comprimento de conversão de string em inteiro}.

@end deffn

@geindex built-in function; isinstance()
@anchor{library/functions isinstance}@anchor{442}
@deffn {Função} isinstance (object, classinfo, /)

Retorna @code{True} se o argumento `object' é uma instância do argumento `classinfo', ou de uma subclasse dele (direta, indireta ou @ref{11f5,,virtual}). Se `object' não é um objeto do tipo dado, a função sempre devolve @code{False}. Se `classinfo' é uma tupla de tipos de objetos (ou recursivamente, como outras tuplas) ou um @ref{7c3,,Tipo União} de vários tipos, retorna @code{True} se `object' é uma instância de qualquer um dos tipos. Se `classinfo' não é um tipo ou tupla de tipos ou outras tuplas, é levantada uma exceção @ref{2c3,,TypeError}. @ref{2c3,,TypeError} pode não ser levantada por um tipo inválido se uma verificação anterior for bem-sucedida.


Alterado na versão 3.10: `classinfo' pode ser um @ref{7c3,,Tipo União}.

@end deffn

@geindex built-in function; issubclass()
@anchor{library/functions issubclass}@anchor{7c2}
@deffn {Função} issubclass (class, classinfo, /)

Retorna @code{True} se `class' for uma subclasse (direta, indireta ou @ref{11f5,,virtual}) de `classinfo'. Uma classe é considerada uma subclasse de si mesma. `classinfo' pode ser uma tupla de objetos de classe (ou recursivamente, outras tuplas) ou um @ref{7c3,,Tipo União}, caso em que retorna @code{True} se `class' for uma subclasse de qualquer entrada em `classinfo'. Em qualquer outro caso, é levantada uma exceção @ref{2c3,,TypeError}.


Alterado na versão 3.10: `classinfo' pode ser um @ref{7c3,,Tipo União}.

@end deffn

@geindex built-in function; iter()
@anchor{library/functions iter}@anchor{7d8}
@deffn {Função} iter (iterable, /)

@deffnx {Função} iter (callable, sentinel, /)

Retorna um objeto @ref{1ac,,iterador}. O primeiro argumento é interpretado muito diferentemente dependendo da presença do segundo argumento. Sem um segundo argumento, o primeiro argumento deve ser uma coleção de objetos com suporte ao protocolo @ref{1268,,iterável} (o método @ref{c8a,,__iter__()}), ou ele deve ter suporte ao protocolo de sequência (o método @ref{283,,__getitem__()} com argumentos inteiros começando em @code{0}). Se ele não tem suporte nenhum desses protocolos, uma @ref{2c3,,TypeError} é levantada. Se o segundo argumento, `sentinel', é fornecido, então o primeiro argumento deve ser um objeto chamável. O iterador criado neste caso irá chamar `callable' sem nenhum argumento para cada chamada para o seu método @ref{1310,,__next__()}; se o valor devolvido é igual a `sentinel', então @ref{c15,,StopIteration} será levantado, caso contrário o valor será devolvido.

Veja também @ref{230c,,Tipos iteradores}.

Uma aplicação útil da segunda forma de @ref{7d8,,iter()} é para construir um bloco de leitura. Por exemplo, ler blocos de comprimento fixo de um arquivo binário de banco de dados até que o final do arquivo seja atingido:

@example
from functools import partial
with open('meusdados.db', 'rb') as f:
    for bloco in iter(partial(f.read, 64), b'@w{'}):
        process_block(bloco)
@end example
@end deffn

@geindex built-in function; len()
@anchor{library/functions len}@anchor{62e}
@deffn {Função} len (object, /)

Devolve o comprimento (o número de itens) de um objeto. O argumento pode ser uma sequência (tal como uma string, bytes, tupla, lista, ou um intervalo) ou uma coleção (tal como um dicionário, conjunto, ou conjunto imutável).

@code{len} levanta @ref{885,,OverflowError} em tamanhos maiores que @ref{1205,,sys.maxsize}, tal como @ref{94a,,range(2 ** 100)}.
@end deffn

@anchor{library/functions func-list}@anchor{22ef}
@deffn {Classe} list (iterable=(), /)

Ao invés de ser uma função, @ref{611,,list} é na verdade um tipo de sequência mutável, conforme documentado em @ref{1dc0,,Listas} e @ref{1dcc,,Tipos sequências — list@comma{} tuple@comma{} range}.
@end deffn

@geindex built-in function; locals()
@anchor{library/functions locals}@anchor{141}
@deffn {Função} locals ()

Retorna um objeto de mapeamento representando a tabela de símbolos atual, com nomes de variáveis como as chaves, e as referências às quais cada variável está atrelada no momento como os valores.

Em um escopo de módulo, assim como quando usando @ref{17f,,exec()} ou @ref{180,,eval()} com um único espaço de nomes, esta função retorna o mesmo espaço de nomes que @ref{1993,,globals()}.

Em um escopo de classe, ela retorna o espaço de nomes que será passado para o construtor da metaclasse.

Quando usando @code{exec()} ou @code{eval()} com argumentos de espaço local e global distintos, ela retorna o espaço de nomes local passado na chamada.

Em todos os casos acima, cada chamada a @code{locals()} em um dado quadro de execução vai retornar o `mesmo' objeto de mapeamento. Mudanças feitas através do objeto de mapeamento retornado por @code{locals()} serão visíveis tal qual variáveis locais atribuídas, reatribuídas ou deletadas, e atribuir, reatribuir ou deletar variáveis locais afetará imediatamente o conteúdo do objeto de mapeamento retornado.

Em contraste aos casos acima, em um @ref{17e,,escopo otimizado} (incluindo funções, geradores e corrotinas), cada chamada a @code{locals()} retorna um dicionário novo contendo as ligações atuais das variáveis locais da função e de quaisquer células com referências não-locais. Nesse caso, mudanças em ligações de nomes feitas através do dicionário retornado `não' são escritas de volta nas variáveis locais correspondentes nem nas células com referências não-locais, e atribuir, reatribuir ou deletar variáveis locais e células com referências não-locais `não' afeta o conteúdo dos dicionários que já foram retornados.

Chamar a função @code{locals()} como parte de uma compreensão em uma função, gerador ou corrotina é equivalente a chamá-la no escopo que contém a compreensão, exceto que as variáveis de iteração inicializadas da compreensão serão incluídas. Em outros escopos, essa função se comporta como se a compreensão estivesse executando como uma função aninhada.

Chamar a função @code{locals()} como parte de uma expressão geradora é equivalente a chamá-la em uma função geradora aninhada.


Alterado na versão 3.12: O comportamento de @code{locals()} em uma compreensão foi atualizado conforme descrito na 
@geindex Propostas de Melhorias do Python; PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}.



Alterado na versão 3.13: Como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, o que acontece após a mutação de objetos de mapeamento retornados desta função está agora definido. O comportamento em @ref{17e,,escopos otimizados} agora é o descrito acima. Além de estar definido, o comportamento em outros escopos não foi modificado em relação aos comportamentos em versões passadas.

@end deffn

@geindex built-in function; map()
@anchor{library/functions map}@anchor{867}
@deffn {Função} map (function, iterable, *iterables)

Devolve um iterador que aplica `function' para cada item de `iterable', gerando os resultados. Se argumentos `iterables' adicionais são passados, `function' deve ter a mesma quantidade de argumentos e ela é aplicada aos itens de todos os iteráveis em paralelo. Com múltiplos iteráveis, o iterador para quando o iterador mais curto é encontrado. Para casos onde os parâmetros de entrada da função já estão organizados em tuplas, veja @ref{1123,,itertools.starmap()}.
@end deffn

@geindex built-in function; max()
@anchor{library/functions max}@anchor{f3b}
@deffn {Função} max (iterable, /, *, key=None)

@deffnx {Função} max (iterable, /, *, default, key=None)

@deffnx {Função} max (arg1, arg2, /, *args, key=None)

Devolve o maior item em um iterável ou o maior de dois ou mais argumentos.

Se um argumento posicional é fornecido, ele deve ser um @ref{1268,,iterável}. O maior item no iterável é retornado. Se dois ou mais argumentos posicionais são fornecidos, o maior dos argumentos posicionais é devolvido.

Existem dois parâmetros somente-nomeados opcionais. O parâmetro `key' especifica uma função de ordenamento de um argumento, como aquelas usadas por @ref{be8,,list.sort()}. O parâmetro `default' especifica um objeto a ser devolvido se o iterável fornecido estiver vazio. Se o iterável estiver vazio, e `default' não foi fornecido, uma exceção @ref{202,,ValueError} é levantada.

Se múltiplos itens são máximos, a função devolve o primeiro encontrado. Isto é consistente com outras ferramentas de ordenamento que preservam a estabilidade, tais como @code{sorted(iterable, key=keyfunc, reverse=True)[0]} e @code{heapq.nlargest(1, iterable, key=keyfunc)}.


Alterado na versão 3.4: Adicionado o parâmetro `default' somente-nomeado.



Alterado na versão 3.8: O valor de `key' pode ser @code{None}.

@end deffn

@anchor{library/functions func-memoryview}@anchor{22f0}
@deffn {Classe} memoryview (object)

Devolve um objeto de “visão da memória” criado a partir do argumento fornecido. Veja @ref{230d,,Memory Views} para mais informações.
@end deffn

@geindex built-in function; min()
@anchor{library/functions min}@anchor{f3a}
@deffn {Função} min (iterable, /, *, key=None)

@deffnx {Função} min (iterable, /, *, default, key=None)

@deffnx {Função} min (arg1, arg2, /, *args, key=None)

Devolve o menor item de um iterável ou o menor de dois ou mais argumentos.

Se um argumento posicional é fornecido, ele deve ser um @ref{1268,,iterável}. O menor item no iterável é devolvido. Se dois ou mais argumentos posicionais são fornecidos, o menor dos argumentos posicionais é devolvido.

Existem dois parâmetros somente-nomeados opcionais. O parâmetro `key' especifica uma função de ordenamento de um argumento, como aquelas usadas por @ref{be8,,list.sort()}. O parâmetro `default' especifica um objeto a ser devolvido se o iterável fornecido estiver vazio. Se o iterável estiver vazio, e `default' não foi fornecido, uma exceção @ref{202,,ValueError} é levantada.

Se múltiplos itens são mínimos, a função devolve o primeiro encontrado. Isto é consistente com outras ferramentas de ordenamento que preservam a estabilidade, tais como @code{sorted(iterable, key=keyfunc)[0]} e @code{heapq.nsmallest(1, iterable, key=keyfunc)}.


Alterado na versão 3.4: Adicionado o parâmetro `default' somente-nomeado.



Alterado na versão 3.8: O valor de `key' pode ser @code{None}.

@end deffn

@geindex built-in function; next()
@anchor{library/functions next}@anchor{7d9}
@deffn {Função} next (iterator, /)

@deffnx {Função} next (iterator, default, /)

Recupera o próximo item do @ref{1ac,,iterador} chamando o seu método @ref{1310,,__next__()}. Se `default' foi fornecido, ele é devolvido caso o iterável tenha sido percorrido por completo, caso contrário @ref{c15,,StopIteration} é levantada.
@end deffn

@geindex object (classe interna)
@anchor{library/functions object}@anchor{a96}
@deffn {Classe} object

Esta é a classe base definitiva de todas as outras classes. Ela tem métodos que são comuns a todas as instâncias de classes Python. Quando o construtor é chamado, ele retorna um novo objeto sem características. O construtor não aceita nenhum argumento.

@cartouche
@quotation Nota 
Instâncias de @ref{a96,,object} `não' têm atributos @ref{55b,,__dict__}, então você não pode atribuir atributos arbitrários a uma instância de @ref{a96,,object}.
@end quotation
@end cartouche
@end deffn

@geindex built-in function; oct()
@anchor{library/functions oct}@anchor{1311}
@deffn {Função} oct (integer, /)

Converte um número inteiro para uma string em base octal, prefixada com “0o”. O resultado é uma expressão Python válida. Se `integer' não for um objeto @ref{257,,int} Python, ele tem que definir um método @ref{71d,,__index__()} que devolve um inteiro. Por exemplo:

@example
>>> oct(8)
'0o10'
>>> oct(-56)
'-0o70'
@end example

Se você quiser converter um número inteiro para uma string octal, com o prefixo “0o” ou não, você pode usar qualquer uma das formas a seguir.

@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

Veja também @ref{61f,,format()} para mais informações.
@end deffn

@geindex objeto arquivo;função embutida open()

@geindex built-in function; open()
@anchor{library/functions open}@anchor{51c}
@deffn {Função} open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Abre `file' e retorna um @ref{1203,,objeto arquivo} correspondente. Se o arquivo não puder ser aberto, uma @ref{417,,OSError} é levantada. Veja @ref{1e06,,Leitura e escrita de arquivos} para mais exemplos de como usar esta função.

`file' é um @ref{2a0,,objeto caminho ou similar} fornecendo o caminho (absoluto ou relativo ao diretório de trabalho atual) do arquivo que será aberto, ou de um inteiro descritor de arquivo a ser manipulado (Se um descritor de arquivo é fornecido, ele é fechado quando o objeto de I/O retornado é fechado, a não ser que `closefd' esteja marcado como @code{False}).

`mode' é uma string opcional que especifica o modo no qual o arquivo é aberto. O valor padrão é @code{'r'}, o qual significa abrir para leitura em modo texto. Outros valores comuns são @code{'w'} para escrever (truncando o arquivo se ele já existe), @code{'x'} para criação exclusiva e @code{'a'} para anexar (o qual em `alguns' sistemas Unix, significa que `todas' as escritas anexam ao final do arquivo independentemente da posição de busca atual). No modo texto, se `encoding' não for especificada, a codificação usada depende da plataforma: @ref{2dc,,locale.getencoding()} é chamada para obter a codificação da localidade atual (Para ler e escrever bytes diretamente, use o modo binário e não especifique `encoding'). Os modos disponíveis são:

@geindex arquivo;modos
@anchor{library/functions filemodes}@anchor{230e}

@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caractere

@tab

Significado

@item

@code{'r'}

@tab

abre para leitura (padrão)

@item

@code{'w'}

@tab

abre para escrita, truncando o arquivo primeiro (removendo tudo o que estiver contido no mesmo)

@item

@code{'x'}

@tab

abre para criação exclusiva, falhando caso o arquivo exista

@item

@code{'a'}

@tab

abre para escrita, anexando ao final do arquivo caso o mesmo exista

@item

@code{'b'}

@tab

modo binário

@item

@code{'t'}

@tab

modo texto (padrão)

@item

@code{'+'}

@tab

aberto para atualização (leitura e escrita)

@end multitable


O modo padrão é @code{'r'} (abre para leitura de texto, um sinônimo de @code{'rt'}). Modos @code{'w+'} e @code{'w+b'} abrem e truncam o arquivo. Modos @code{'r+'} e @code{'r+b'} abrem o arquivo sem truncar o mesmo.

Conforme mencionado em @ref{230f,,Visão Geral}, Python diferencia entre entrada/saída binária e de texto. Arquivos abertos em modo binário (incluindo @code{'b'} no parâmetro `mode') retornam o conteúdo como objetos @ref{1c2,,bytes} sem usar nenhuma decodificação. No modo texto (o padrão, ou quando @code{'t'} é incluído no parâmetro `mode'), o conteúdo do arquivo é retornado como @ref{44c,,str}, sendo os bytes primeiramente decodificados usando uma codificação dependente da plataforma, ou usando a codificação definida em `encoding' se fornecida.

@cartouche
@quotation Nota 
Python não depende da noção básica do sistema operacional sobre arquivos de texto; todo processamento é feito pelo próprio Python, e é então independente de plataforma.
@end quotation
@end cartouche

`buffering' é um número inteiro opcional usado para definir a política de buffering. Passe 0 para desativar o buffer (permitido apenas no modo binário), 1 para selecionar o buffer de linha (usável apenas ao gravar no modo de texto) e um inteiro > 1 para indicar o tamanho em bytes de um buffer de bloco de tamanho fixo. Observe que especificar um tamanho de buffer dessa maneira se aplica a E/S com buffer binário, mas @code{TextIOWrapper} (ou seja, arquivos abertos com @code{mode='r+'}) teriam outro buffer. Para desabilitar o buffer em @code{TextIOWrapper}, considere usar o sinalizador @code{write_through} para @ref{b5e,,io.TextIOWrapper.reconfigure()}. Quando nenhum argumento `buffering' é fornecido, a política de buffering padrão funciona da seguinte forma:


@itemize *

@item 
Arquivos binários são armazenados em pedaços de tamanho fixo; o tamanho do buffer é escolhido usando uma heurística que tenta determinar o “tamanho de bloco” subjacente do dispositivo, e usa @ref{17ba,,io.DEFAULT_BUFFER_SIZE} caso não consiga. Em muitos sistemas, o buffer possuirá tipicamente 4096 ou 8192 bytes de comprimento.

@item 
Arquivos de texto “interativos” (arquivos para os quais @ref{1e09,,isatty()} retornam @code{True}) usam buffering de linha. Outros arquivos de texto usam a política descrita acima para arquivos binários.
@end itemize

`encoding' é o nome da codificação usada para codificar ou decodificar o arquivo. Isto deve ser usado apenas no modo texto. A codificação padrão depende da plataforma (seja qual valor @ref{2dc,,locale.getencoding()} retornar), mas qualquer @ref{2310,,codificador de texto} suportado pelo Python pode ser usada. Veja o módulo @ref{1b,,codecs} para a lista de codificações suportadas.

`errors' é uma string opcional que especifica como erros de codificação e de decodificação devem ser tratados — isso não pode ser utilizado no modo binário. Uma variedade de tratadores de erro padrão estão disponíveis (listados em @ref{18fa,,Error Handlers}), apesar que qualquer nome para tratamento de erro registrado com @ref{14e3,,codecs.register_error()} também é válido. Os nomes padrões incluem:


@itemize *

@item 
@code{'strict'} para levantar uma exceção @ref{202,,ValueError} se existir um erro de codificação. O valor padrão @code{None} tem o mesmo efeito.

@item 
@code{'ignore'} ignora erros. Note que ignorar erros de código pode levar à perda de dados.

@item 
@code{'replace'} faz um marcador de substituição (tal como @code{'?'}) ser inserido onde existem dados malformados.

@item 
representará quaisquer bytes incorretos como unidades de código substituto baixo variando de U + DC80 a U + DCFF. Essas unidades de código substituto serão então transformadas de volta nos mesmos bytes quando o manipulador de erros for usado ao gravar dados. Isso é útil para processar arquivos em uma codificação desconhecida.

@item 
@code{'xmlcharrefreplace'} é suportado apenas ao gravar em um arquivo. Os caracteres não suportados pela codificação são substituídos pela referência de caracteres XML apropriada @code{&#@var{nnn};}.

@item 
@code{'backslashreplace'} substitui dados malformados pela sequência de escape utilizando contrabarra do Python.

@item 
@code{'namereplace'} (também é suportado somente quando estiver escrevendo) substitui caractere não suportados com sequências de escape @code{\N@{...@}}.
@end itemize

@geindex novas linhas universais;função embutida open()
@anchor{library/functions open-newline-parameter}@anchor{741}
`newline' determina como analisar caracteres de nova linha do fluxo. Ele pode ser @code{None}, @code{'@w{'}}, @code{'\n'}, @code{'\r'} e @code{'\r\n'}. Ele funciona da seguinte forma:


@itemize *

@item 
Ao ler a entrada do fluxo, se `newline' for @code{None}, o modo universal de novas linhas será ativado. As linhas na entrada podem terminar em @code{'\n'}, @code{'\r'} ou @code{'\r\n'}, e são traduzidas para @code{'\n'} antes de retornar ao chamador. Se for @code{'@w{'}}, o modo de novas linhas universais será ativado, mas as terminações de linha serão retornadas ao chamador sem tradução. Se houver algum dos outros valores legais, as linhas de entrada são finalizadas apenas pela string especificada e a finalização da linha é retornada ao chamador sem tradução.

@item 
Ao gravar a saída no fluxo, se `newline' for @code{None}, quaisquer caracteres @code{'\n'} gravados serão traduzidos para o separador de linhas padrão do sistema, @ref{2311,,os.linesep}. Se `newline' for @code{'@w{'}} ou @code{'\n'}, nenhuma tradução ocorrerá. Se `newline' for um dos outros valores legais, qualquer caractere @code{'\n'} escrito será traduzido para a string especificada.
@end itemize

Se `closefd' for @code{False} e um descritor de arquivo em vez de um nome de arquivo for fornecido, o descritor de arquivo subjacente será mantido aberto quando o arquivo for fechado. Se um nome de arquivo for fornecido `closefd' deve ser @code{True} (o padrão), caso contrário, um erro será levantado.

Um abridor personalizado pode ser usado passando um chamável como `opener'. O descritor de arquivo subjacente para o objeto arquivo é obtido chamando `opener' com (`file', `flags'). `opener' deve retornar um descritor de arquivo aberto (passando @ref{dba,,os.open} como `opener' resulta em funcionalidade semelhante à passagem de @code{None}).

O arquivo recém-criado é @ref{f2b,,non-inheritable}.

O exemplo a seguir usa o parâmetro @ref{1129,,dir_fd} da função @ref{dba,,os.open()} para abrir um arquivo relativo a um determinado diretório:

@example
>>> import os
>>> dir_fd = os.open('algum_dir', 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('Isso será escrito para algum_dir/spamspam.txt', file=f)
...
>>> os.close(dir_fd)  # não deixe vazar um descritor de arquivo
@end example

O tipo de @ref{1203,,objeto arquivo} retornado pela função @ref{51c,,open()} depende do modo. Quando @ref{51c,,open()} é usado para abrir um arquivo no modo texto (@code{'w'}, @code{'r'}, @code{'wt'}, @code{'rt'}, etc.), retorna uma subclasse de @ref{695,,io.TextIOBase} (especificamente @ref{7bc,,io.TextIOWrapper}). Quando usada para abrir um arquivo em modo binário com buffer, a classe retornada é uma subclasse de @ref{694,,io.BufferedIOBase}. A classe exata varia: no modo binário de leitura, ele retorna uma @ref{124e,,io.BufferedReader}; nos modos binário de gravação e binário anexado, ele retorna um @ref{13f8,,io.BufferedWriter} e, no modo leitura/gravação, retorna um @ref{13f9,,io.BufferedRandom}. Quando o buffer está desativado, o fluxo bruto, uma subclasse de @ref{110f,,io.RawIOBase}, @ref{1354,,io.FileIO}, é retornado.

@geindex E/S com buffer de linha
@geindex E/S sem buffer
@geindex buffer@comma{} tamanho@comma{} E/S
@geindex controle de E/S;buffering
@geindex modo binário
@geindex texto@comma{} modo
@geindex módulo;sys

Veja também os módulos de para lidar com arquivos, tais como @ref{5b,,fileinput}, @ref{7f,,io} (onde @ref{51c,,open()} é declarado), @ref{a1,,os}, @ref{a2,,os.path}, @ref{e0,,tempfile} e @ref{c5,,shutil}.

Levanta um @ref{19fa,,evento de auditoria} @code{open} com os argumentos @code{path}, @code{mode}, @code{flags}.

Os argumentos @code{mode} e @code{flags} podem ter sido modificados ou inferidos a partir da chamada original.


Alterado na versão 3.3: 


@itemize *

@item 
O parâmetro `opener' foi adicionado.

@item 
O modo @code{'x'} foi adicionado.

@item 
@ref{108b,,IOError} costumava ser levantada, agora ela é um apelido para @ref{417,,OSError}.

@item 
@ref{1056,,FileExistsError} agora é levantado se o arquivo aberto no modo de criação exclusivo (@code{'x'}) já existir.
@end itemize



Alterado na versão 3.4: 


@itemize *

@item 
O arquivo agora é não herdável.
@end itemize



Alterado na versão 3.5: 


@itemize *

@item 
Se a chamada de sistema é interrompida e o tratador de sinal não levanta uma exceção, a função agora tenta novamente a chamada de sistema em vez de levantar uma exceção @ref{db0,,InterruptedError} (consulte 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para entender a justificativa).

@item 
O tratador de erros @code{'namereplace'} foi adicionado.
@end itemize



Alterado na versão 3.6: 


@itemize *

@item 
Suporte adicionado para aceitar objetos implementados @ref{c6c,,os.PathLike}.

@item 
No Windows, a abertura de um buffer do console pode retornar uma subclasse de @ref{110f,,io.RawIOBase} que não seja @ref{1354,,io.FileIO}.
@end itemize



Alterado na versão 3.11: O modo @code{'U'} foi removido.

@end deffn

@geindex built-in function; ord()
@anchor{library/functions ord}@anchor{2080}
@deffn {Função} ord (character, /)

Retorna o valor ordinal de um caractere.

Se o argumento for uma string de um caractere, retorna o ponto de código Unicode desse caractere.. Por exemplo, @code{ord('a')} retorna o número inteiro @code{97} e @code{ord('€')} (sinal do Euro) retorna @code{8364}. Este é o inverso de @ref{1768,,chr()}.

Se o argumento for um objeto @ref{1c2,,bytes} ou @ref{2ea,,bytearray} de comprimento 1, retorna seu valor de byte único. Por exemplo, @code{ord(b'a')} retorna o inteiro @code{97}.
@end deffn

@geindex built-in function; pow()
@anchor{library/functions pow}@anchor{9da}
@deffn {Função} pow (base, exp, mod=None)

Retorna `base' à potência de `exp'; se `mod' estiver presente, retorna `base' à potência `exp', módulo `mod' (calculado com mais eficiência do que @code{pow(base, exp) % mod}). A forma de dois argumentos @code{pow(base, exp)} é equivalente a usar o operador de potência: @code{base**exp}.

Quando argumentos são tipos numéricos embutidos com tipos de operandos mistos, aplicam-se as regras de coerção para operadores aritméticos binários. Para operandos @ref{257,,int}, o resultado tem o mesmo tipo que os operandos (após coerção), a menos que o segundo argumento seja negativo; nesse caso, todos os argumentos são convertidos em ponto flutuante e um resultado ponto flutuante é entregue. Por exemplo, @code{pow(10, 2)} retorna @code{100}, mas @code{pow(10, -2)} retorna @code{0.01}. Para uma base negativa do tipo @ref{257,,int} ou @ref{2f7,,float} e um expoente não integral, um resultado complexo é entregue. Por exemplo, @code{pow(-9, 0.5)} retorna um valor próximo a @code{3j}. Enquanto isso, para uma base negativa do tipo @ref{257,,int} ou @ref{2f7,,float} com um expoente integral, um resultado de ponto flutuante é retornado. Por exemplo, @code{pow(-9, 2.0)} retorna @code{81.0}.

Para operandos @ref{257,,int} `base' e `exp', se `mod' estiver presente, `mod' também deve ser do tipo inteiro e `mod' deve ser diferente de zero. Se `mod' estiver presente e `exp' for negativo, `base' deve ser relativamente primo para `mod'. Nesse caso, @code{pow(inv_base, -exp, mod)} é retornado, onde `inv_base' é um inverso ao `base' módulo `mod'.

Aqui está um exemplo de computação de um inverso para @code{38} módulo @code{97}:

@example
>>> pow(38, -1, mod=97)
23
>>> 23 * 38 % 97 == 1
True
@end example


Alterado na versão 3.8: Para operandos @ref{257,,int}, a forma de três argumentos de @code{pow} agora permite que o segundo argumento seja negativo, permitindo o cálculo de inversos modulares.



Alterado na versão 3.8: Permite argumentos de palavra reservada. Anteriormente, apenas argumentos posicionais eram suportados.

@end deffn

@geindex built-in function; print()
@anchor{library/functions print}@anchor{fa9}
@deffn {Função} print (*objects, sep=' ', end='\n', file=None, flush=False)

Exibe `objects' no fluxo de texto `arquivo', separado por `sep' e seguido por `end'. `sep', `end', `file' e `flush', se houver, devem ser fornecidos como argumentos nomeados.

Todos os argumentos que não são nomeados são convertidos em strings como @ref{44c,,str()} faz e gravados no fluxo, separados por `sep' e seguidos por `end'. `sep' e `end' devem ser strings; eles também podem ser @code{None}, o que significa usar os valores padrão. Se nenhum `object' for fornecido, @ref{fa9,,print()} escreverá apenas `end'.

O argumento `file' deve ser um objeto com um método @code{write(string)}; se ele não estiver presente ou @code{None}, então @ref{ae6,,sys.stdout} será usado. Como argumentos exibidos no console são convertidos para strings de texto, @ref{fa9,,print()} não pode ser usado com objetos arquivo em modo binário. Para esses casos, use @code{file.write(...)} ao invés.

O buffer de saída geralmente é determinado por `arquivo'. No entanto, se `flush' for verdadeiro, o fluxo será descarregado à força.


Alterado na versão 3.3: Adicionado o argumento nomeado `flush'.

@end deffn

@geindex property (classe interna)
@anchor{library/functions property}@anchor{194}
@deffn {Classe} property (fget=None, fset=None, fdel=None, doc=None)

Retorna um atributo de propriedade.

`fget' é uma função para obter o valor de um atributo. `fset' é uma função para definir um valor para um atributo. `fdel' é uma função para deletar um valor de um atributo. E `doc' cria um docstring para um atributo.

Um uso comum é para definir um atributo gerenciável @code{x}:

@example
class C:
    def __init__(self):
        self._x = None

    def getx(self):
        return self._x

    def setx(self, valor):
        self._x = valor

    def delx(self):
        del self._x

    x = property(getx, setx, delx, "Eu sou a propriedade de 'x'.")
@end example

Se `c' é uma instância de `C', @code{c.x} irá invocar o método getter, @code{c.x = valor} irá invocar o método setter, e @code{del c.x} o método deleter.

Se fornecido, `doc' será a docstring do atributo definido por property. Caso contrário, a property copiará a docstring de `fget' (se ela existir). Isso torna possível criar facilmente propriedades apenas para leitura usando @ref{194,,property()} como um @ref{731,,decorador}:

@example
class Parrot:
    def __init__(self):
        self._voltagem = 100000

    @@property
    def voltagem(self):
        """Obtém a voltagem atual."""
        return self._voltagem
@end example

O decorador @code{@@property} transforma o método @code{voltage()} em um “getter” para um atributo somente leitura com o mesmo nome, e define a docstring de `voltage' para “Get the current voltage.”

@geindex built-in function; property.getter()
@anchor{library/functions property getter}@anchor{1750}
@deffn {Função} @@getter
@end deffn

@geindex built-in function; property.setter()
@anchor{library/functions property setter}@anchor{1751}
@deffn {Função} @@setter
@end deffn

@geindex built-in function; property.deleter()
@anchor{library/functions property deleter}@anchor{1752}
@deffn {Função} @@deleter

Um objeto property possui métodos @code{getter}, @code{setter} e @code{deleter} usáveis como decoradores, que criam uma cópia da property com o assessor correspondente a função definida para a função com decorador. Isso é explicado melhor com um exemplo:

@example
class C:
    def __init__(self):
        self._x = None

    @@property
    def x(self):
        """Sou a propriedade de 'x'."""
        return self._x

    @@x.setter
    def x(self, value):
        self._x = value

    @@x.deleter
    def x(self):
        del self._x
@end example

Esse código é exatamente equivalente ao primeiro exemplo. Tenha certeza de nas funções adicionais usar o mesmo nome que a property original (@code{x} neste caso).

O objeto property retornado também tem os atributos @code{fget}, @code{fset}, e @code{fdel} correspondendo aos argumentos do construtor.
@end deffn


Alterado na versão 3.5: Agora é possível escrever nas docstrings de objetos property.


@geindex __name__ (atributo property)
@anchor{library/functions property __name__}@anchor{193}
@deffn {Atributo} __name__

Atributo que contém o nome da propriedade. O nome da propriedade pode ser alterado em tempo de execução.


Adicionado na versão 3.13.

@end deffn
@end deffn

@anchor{library/functions func-range}@anchor{22f1}
@deffn {Classe} range (stop, /)

@deffnx {Classe} range (start, stop, step=1, /)

Em vez de ser uma função, @ref{94a,,range} é realmente um tipo de sequência imutável, conforme documentado em @ref{2312,,Intervalos} e @ref{1dcc,,Tipos sequências — list@comma{} tuple@comma{} range}.
@end deffn

@geindex built-in function; repr()
@anchor{library/functions repr}@anchor{800}
@deffn {Função} repr (object, /)

Retorna uma string contendo uma representação imprimível de um objeto. Para muitos tipos, essa função tenta retornar uma string que produziria um objeto com o mesmo valor quando passado para @ref{180,,eval()}, caso contrário, a representação é uma string entre colchetes angulares que contém o nome do tipo do objeto juntamente com informações adicionais, geralmente incluindo o nome e o endereço do objeto. Uma classe pode controlar o que essa função retorna para suas instâncias, definindo um método @ref{61c,,__repr__()}. Se @ref{1568,,sys.displayhook()} não estiver acessível, esta função vai levantar @ref{195,,RuntimeError}.

Esta classe possui uma representação personalizada que pode ser executada:

@example
class Pessoa:   def __init__(self, nome, idade):      self.nome = nome      self.idade = idade   def __repr__(self):      return f"Pessoa('@{self.nome@}', @{self.idade@})"
@end example
@end deffn

@geindex built-in function; reversed()
@anchor{library/functions reversed}@anchor{869}
@deffn {Função} reversed (object, /)

Retorna um @ref{1ac,,iterador} reverso. `seq' deve ser um objeto que possui o método @ref{ca7,,__reversed__()} ou suporta o protocolo de sequência (o método @ref{15b4,,__len__()} e o método @ref{283,,__getitem__()} com argumentos inteiros começando em @code{0}).
@end deffn

@geindex built-in function; round()
@anchor{library/functions round}@anchor{131d}
@deffn {Função} round (number, ndigits=None)

Retorna `number' arredondado para `ndigits' precisão após o ponto decimal. Se `ndigits' for omitido ou for @code{None}, ele retornará o número inteiro mais próximo de sua entrada.

Para os tipos embutidos com suporte a @ref{131d,,round()}, os valores são arredondados para o múltiplo mais próximo de 10 para a potência de menos `ndigit'; se dois múltiplos são igualmente próximos, o arredondamento é feito para a opção par (por exemplo, @code{round(0.5)} e @code{round(-0.5)} são @code{0} e @code{round(1.5)} é @code{2}). Qualquer valor inteiro é válido para `ndigits' (positivo, zero ou negativo). O valor de retorno é um número inteiro se `ndigits' for omitido ou @code{None}. Caso contrário, o valor de retorno tem o mesmo tipo que `number'.

Para um objeto Python geral @code{number}, @code{round} delega para @code{number.__round__}.

@cartouche
@quotation Nota 
O comportamento de @ref{131d,,round()} para pontos flutuantes pode ser surpreendente: por exemplo, @code{round(2.675, 2)} fornece @code{2.67} em vez do esperado @code{2.68}. Isso não é um bug: é resultado do fato de que a maioria das frações decimais não pode ser representada exatamente como um ponto flutuante. Veja @ref{1e99,,Aritmética de ponto flutuante; problemas e limitações} para mais informações.
@end quotation
@end cartouche
@end deffn

@anchor{library/functions func-set}@anchor{22f2}
@deffn {Classe} set (iterable=(), /)

Retorna um novo objeto @ref{5d9,,set}, opcionalmente com elementos retirados de `iterable'. @code{set} é uma classe embutida. Veja @ref{5d9,,set} e @ref{1dcf,,Tipo conjuntos — set@comma{} frozenset} para documentação sobre esta classe.

Para outros contêineres, consulte as classes embutidas @ref{5da,,frozenset}, @ref{611,,list}, @ref{370,,tuple} e @ref{256,,dict}, bem como o módulo @ref{1d,,collections}.
@end deffn

@geindex built-in function; setattr()
@anchor{library/functions setattr}@anchor{22f3}
@deffn {Função} setattr (object, name, value, /)

Esta é a contrapartida de @ref{bea,,getattr()}. Os argumentos são um objeto, uma string e um valor arbitrário. A string pode nomear um atributo existente ou um novo atributo. A função atribui o valor ao atributo, desde que o objeto permita. Por exemplo, @code{setattr(x, 'foobar', 123)} é equivalente a @code{x.foobar = 123}.

`name' não precisa ser um identificador do Python conforme definido em @ref{2021,,Identificadores e palavras-chave} a menos que o objeto opte por impor isso, por exemplo, em um @ref{beb,,__getattribute__()} personalizado ou via @ref{1533,,__slots__}. Um atributo cujo nome não é um identificador não será acessível usando a notação de ponto, mas pode ser acessado através de @ref{bea,,getattr()} etc.

@cartouche
@quotation Nota 
Uma vez que @ref{1e43,,desfiguração de nome privado} acontece em tempo de compilação, deve-se manualmente mutilar o nome de um atributo privado (atributos com dois sublinhados à esquerda) para defini-lo com @ref{22f3,,setattr()}.
@end quotation
@end cartouche
@end deffn

@geindex slice (classe interna)
@anchor{library/functions slice}@anchor{469}
@deffn {Classe} slice (stop, /)

@deffnx {Classe} slice (start, stop, step=None, /)

Retorna um objeto @ref{2313,,fatia} representando o conjunto de índices especificados por @code{range(start, stop, step)}. Os argumentos `start' e `step' têm o padrão @code{None}.

Objetos fatia têm atributos de dados somente leitura @code{start}, @code{stop} e @code{step} que simplesmente retornam os valores dos argumentos (ou seus padrões). Eles não possuem outra funcionalidade explícita; no entanto, eles são usados pelo NumPy e outros pacotes de terceiros.

@geindex start (atributo slice)
@anchor{library/functions slice start}@anchor{20e8}
@deffn {Atributo} start
@end deffn

@geindex stop (atributo slice)
@anchor{library/functions slice stop}@anchor{20e9}
@deffn {Atributo} stop
@end deffn

@geindex step (atributo slice)
@anchor{library/functions slice step}@anchor{20ea}
@deffn {Atributo} step
@end deffn

Objetos fatia também são gerados quando a sintaxe de indexação estendida é usada. Por exemplo: @code{a[start:stop:step]} ou @code{a[start:stop, i]}. Veja @ref{b61,,itertools.islice()} para uma versão alternativa que retorna um @ref{1ac,,iterador}.


Alterado na versão 3.12: Os objetos slice agora são @ref{610,,hasheáveis} (desde que @ref{20e8,,start}, @ref{20e9,,stop} e @ref{20ea,,step} sejam hasheáveis).

@end deffn

@geindex built-in function; sorted()
@anchor{library/functions sorted}@anchor{be7}
@deffn {Função} sorted (iterable, /, *, key=None, reverse=False)

Retorna uma nova lista classificada dos itens em `iterable'.

Possui dois argumentos opcionais que devem ser especificados como argumentos nomeados.

`key' especifica a função de um argumento usado para extrair uma chave de comparação de cada elemento em `iterable' (por exemplo, @code{key=str.lower}). O valor padrão é @code{None} (compara os elementos diretamente).

`reverse' é um valor booleano. Se definido igual a @code{True}, então os elementos da lista são classificados como se cada comparação estivesse invertida.

Usa @ref{121a,,functools.cmp_to_key()} para converter a função das antigas `cmp' para uma função `key'.

A função embutida @ref{be7,,sorted()} é garantida como estável. Uma ordenação é estável se garantir não alterar a ordem relativa dos elementos que se comparam da mesma forma — isso é útil para ordenar em várias passagens (por exemplo, ordenar por departamento e depois por nível de salário).

O algoritmo de classificação usa apenas comparações @code{<} entre itens. Embora definir um método @ref{12e2,,__lt__()} seja suficiente para ordenação, 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} recomenda que todas as seis @ref{2205,,comparações ricas} sejam implementadas. Isso ajudará a evitar erros ao usar os mesmos dados com outras ferramentas de ordenação, como @ref{f3b,,max()}, que dependem de um método subjacente diferente. Implementar todas as seis comparações também ajuda a evitar confusão para comparações de tipo misto que podem chamar o método espelhado @ref{1350,,__gt__()}.

Para exemplos de classificação e um breve tutorial de classificação, veja @ref{2314,,Técnicas de ordenação}.
@end deffn

@geindex built-in function; staticmethod()
@anchor{library/functions staticmethod}@anchor{416}
@deffn {Função} @@staticmethod

Transforma um método em método estático.

Um método estático não recebe um primeiro argumento implícito. Para declarar um método estático, use este idioma:

@example
class C:
    @@staticmethod
    def f(arg1, arg2, argN): ...
@end example

A forma @code{@@staticmethod} é uma função de @ref{731,,decorador} – veja @ref{1db6,,Definições de função} para detalhes.

Um método estático pode ser chamado na classe (tal como @code{C.f()}) ou em uma instância (tal como @code{C().f()}). Além disso, o @ref{1658,,descritor} de método estático também é um chamável, então ele pode ser usado na definição de classe (como @code{f()}).

Métodos estáticos em Python são similares àqueles encontrados em Java ou C++. Veja também @ref{166,,classmethod()} para uma variante útil na criação de construtores de classe alternativos.

Como todos os decoradores, também é possível chamar @code{staticmethod} como uma função regular e fazer algo com seu resultado. Isso é necessário em alguns casos em que você precisa de uma referência para uma função de um corpo de classe e deseja evitar a transformação automática em método de instância. Para esses casos, use este idioma:

@example
def função_comum():
    ...

class C:
    método = staticmethod(função_comum)
@end example

Para mais informações sobre métodos estáticos, consulte @ref{2075,,A hierarquia de tipos padrão}.


Alterado na versão 3.10: Métodos estáticos agora herdam os atributos do método (@ref{208e,,__module__}, @ref{1317,,__name__}, @ref{208d,,__qualname__}, @ref{1219,,__doc__} e @ref{1218,,__annotations__}), têm um novo atributo @code{__wrapped__} e são agora chamáveis como funções regulares.

@end deffn

@geindex string;str() (função embutida)

@anchor{library/functions func-str}@anchor{22f4}
@deffn {Classe} str (*, encoding='utf-8', errors='strict')

@deffnx {Classe} str (object)

@deffnx {Classe} str (object, encoding, errors='strict')

@deffnx {Classe} str (object, *, errors)

Retorna uma versão @ref{44c,,str} de `object'. Consulte @ref{44c,,str()} para detalhes.

@code{str} é uma @ref{1a8a,,classe} de string embutida. Para informações gerais sobre strings, consulte @ref{1d7a,,Tipo sequência de texto — str}.
@end deffn

@geindex built-in function; sum()
@anchor{library/functions sum}@anchor{46a}
@deffn {Função} sum (iterable, /, start=0)

Soma `start' e os itens de um `iterable' da esquerda para a direita e retornam o total. Os itens do `iterable' são normalmente números e o valor inicial não pode ser uma string.

Para alguns casos de uso, existem boas alternativas para @ref{46a,,sum()}. A maneira rápida e preferida de concatenar uma sequência de strings é chamando @code{'@w{'}.join(sequence)}. Para adicionar valores de ponto flutuante com precisão estendida, consulte @ref{141b,,math.fsum()}. Para concatenar uma série de iteráveis, considere usar @ref{2315,,itertools.chain()}.


Alterado na versão 3.8: O parâmetro `start' pode ser especificado como um argumento nomeado.



Alterado na versão 3.12: A soma dos pontos flutuantes foi alterada para um algoritmo que oferece maior precisão e melhor comutatividade na maioria das compilações.

@end deffn

@geindex super (classe interna)
@anchor{library/functions super}@anchor{4db}
@deffn {Classe} super

@deffnx {Classe} super (type, object_or_type=None, /)

Retorna um objeto proxy que delega chamadas de método a uma classe pai ou irmão do `type'. Isso é útil para acessar métodos herdados que foram substituídos em uma classe.

O `object_or_type' determina a @ref{2316,,ordem de resolução de métodos} a ser pesquisada. A pesquisa inicia a partir da classe logo após o `type'.

Por exemplo, se @ref{20bb,,__mro__} de `object_or_type' é @code{D -> B -> C -> A -> object} e o valor de `type' é @code{B}, então @ref{4db,,super()} procura por @code{C -> A -> object}.

O atributo @ref{20bb,,__mro__} da classe correspondente ao `object_or_type' lista a ordem de pesquisa de resolução de método usada por @ref{bea,,getattr()} e @ref{4db,,super()}. O atributo é dinâmico e pode mudar sempre que a hierarquia da herança é atualizada.

Se o segundo argumento for omitido, o objeto super retornado é desacoplado. Se o segundo argumento é um objeto, @code{isinstance(obj, type)} deve ser verdadeiro. Se o segundo argumento é um tipo, @code{issubclass(type2, type)} deve ser verdadeiro (isto é útil para classmethods).

Quando chamado diretamente de dentro de um método comum de uma classe, pode-se omitir ambos os argumentos (”@code{super()} de zero argumentos”). Neste caso, `type' será a classe em questão, e `obj' será o primeiro argumento da função que imediatamente chamou @code{super()} (geralmente o @code{self}). (Isso significa que o @code{super()} de zero argumentos não vai funcionar como esperado em funções aninhadas, incluindo expressões geradoras, que criam funções aninhadas implicitamente.)

Existem dois casos de uso típicos para `super'. Em uma hierarquia de classes com herança única, `super' pode ser usado para se referir a classes base sem nomeá-las explicitamente, tornando o código mais sustentável. Esse uso é paralelo ao uso de `super' em outras linguagens de programação.

O segundo caso de uso é oferecer suporte à herança múltipla cooperativa em um ambiente de execução dinâmica. Esse caso de uso é exclusivo do Python e não é encontrado em idiomas ou linguagens compiladas estaticamente que suportam apenas herança única. Isso torna possível implementar “diagramas em losango”, onde várias classes base implementam o mesmo método. Um bom design exige que tais implementações tenham a mesma assinatura de chamada em todos os casos (porque a ordem das chamadas é determinada em tempo de execução, porque essa ordem se adapta às alterações na hierarquia de classes e porque essa ordem pode incluir classes de irmãos desconhecidas antes do tempo de execução).

Nos dois casos de uso, uma chamada típica de superclasse se parece com isso:

@example
class C(B):
    def método(self, arg):
        super().método(arg)    # Isso faz o mesmo que:
                               # super(C, self).método(arg)
@end example

Além das pesquisas de método, @ref{4db,,super()} também funciona para pesquisas de atributo. Um possível caso de uso para isso é chamar @ref{1658,,descritores} em uma classe pai ou irmã.

Observe que @ref{4db,,super()} é implementada como parte do processo de vinculação para procura explícita de atributos com ponto, tal como @code{super().__getitem__(nome)}. Ela faz isso implementando seu próprio método @ref{beb,,__getattribute__()} para pesquisar classes em uma ordem predizível que possui suporte a herança múltipla cooperativa. Logo, @ref{4db,,super()} não é definida para procuras implícitas usando instruções ou operadores como @code{super()[name]}.

Observe também que, além da forma de argumento zero, @ref{4db,,super()} não se limita ao uso de métodos internos. O formulário de dois argumentos especifica exatamente os argumentos e faz as referências apropriadas. O formulário de argumento zero funciona apenas dentro de uma definição de classe, pois o compilador preenche os detalhes necessários para recuperar corretamente a classe que está sendo definida, além de acessar a instância atual para métodos comuns.

Para sugestões práticas sobre como projetar classes cooperativas usando @ref{4db,,super()}, consulte o guia para uso de super()@footnote{https://rhettinger.wordpress.com/2011/05/26/super-considered-super/}.
@end deffn

@anchor{library/functions func-tuple}@anchor{22f5}
@deffn {Classe} tuple (iterable=(), /)

Ao invés de ser uma função, @ref{370,,tuple} é na verdade um tipo de sequência imutável, conforme documentado em @ref{2280,,Tuplas} e @ref{1dcc,,Tipos sequências — list@comma{} tuple@comma{} range}.
@end deffn

@geindex type (classe interna)
@anchor{library/functions type}@anchor{d6b}
@deffn {Classe} type (object, /)

@deffnx {Classe} type (name, bases, dict, /, **kwargs)

@geindex objeto;tipo

Com um argumento, retorna o tipo de um `object'. O valor de retorno é um tipo de objeto e geralmente o mesmo objeto retornado por @ref{14f5,,object.__class__}.

A função embutida @ref{442,,isinstance()} é recomendada para testar o tipo de um objeto, porque ela leva sub-classes em consideração.

Com três argumentos, retorna um novo objeto type. Esta é essencialmente a forma dinâmica da instrução @ref{131a,,class}. A string `name' é o nome da classe e se torna o atributo @ref{14f3,,__name__}. A tupla `bases' contém as classes bases e se torna o atributo @ref{14f4,,__bases__}; se vazio, @ref{a96,,object}, a base final de todas as classes é adicionada. O dicionário `dict' contém definições de atributo e método para o corpo da classe; ele pode ser copiado ou envolto antes de se tornar o atributo @ref{c78,,__dict__}. As duas instruções a seguir criam objetos @code{type} idênticos:

@example
>>> class X:
...     a = 1
...
>>> X = type('X', (), dict(a=1))
@end example

Veja também:


@itemize *

@item 
@ref{20b3,,Documentação sobre atributos e métodos em classes}.

@item 
@ref{2317,,Objetos tipo}
@end itemize

Argumentos nomeados fornecidos para a forma de três argumentos são passados para a máquina metaclasse apropriada (geralmente @ref{631,,__init_subclass__()}) da mesma forma que palavras-chave em uma definição de classe (além de `metaclasse') fariam.

Veja também @ref{c66,,Personalizando a criação de classe}.


Alterado na versão 3.6: Subclasses de @code{type} que não substituem @code{type.__new__} não podem mais usar a forma com apenas um argumento para obter o tipo de um objeto.

@end deffn

@geindex built-in function; vars()
@anchor{library/functions vars}@anchor{1bba}
@deffn {Função} vars ()

@deffnx {Função} vars (object, /)

Retorna o atributo @ref{55b,,__dict__} para um módulo, classe, instância, or qualquer outro objeto com um atributo @code{__dict__}.

Objetos como modelos e instâncias têm um atributo atualizável @ref{55b,,__dict__}; porém, outros projetos podem ter restrições de escrita em seus atributos @code{__dict__} (por exemplo, classes usam um @ref{46d,,types.MappingProxyType} para prevenir atualizações diretas a dicionário).

Sem nenhum argumento, @ref{1bba,,vars()} age como @ref{141,,locals()}.

Uma exceção @ref{2c3,,TypeError} é levantada se um objeto é especificado, mas ela não tem um atributo @ref{55b,,__dict__} (por exemplo, se sua classe define o atributo @ref{1533,,__slots__}).


Alterado na versão 3.13: O resultado de chamar esta função sem um argumento foi atualizado conforme descrito na embutida @ref{141,,locals()}.

@end deffn

@geindex built-in function; zip()
@anchor{library/functions zip}@anchor{7d1}
@deffn {Função} zip (*iterables, strict=False)

Itera sobre vários iteráveis em paralelo, produzindo tuplas com um item de cada um.

Exemplo:

@example
>>> for item in zip([1, 2, 3], ['açúcar', 'tempero', 'tudo que há de bom']):
...     print(item)
...
(1, 'açúcar')
(2, 'tempero')
(3, 'tudo que há de bom')
@end example

Mais formalmente: @ref{7d1,,zip()} retorna um iterador de tuplas, onde a `i'-ésima tupla contém o `i'-ésimo elemento de cada um dos iteráveis do argumento.

Outra maneira de pensar em @ref{7d1,,zip()} é que ela transforma linhas em colunas e colunas em linhas. Isso é semelhante a transpor uma matriz@footnote{https://en.wikipedia.org/wiki/Transpose}.

@ref{7d1,,zip()} é preguiçoso: Os elementos não serão processados até que o iterável seja iterado. Por exemplo, por um loop @code{for} ou por um @ref{611,,list}.

Uma coisa a considerar é que os iteráveis passados para @ref{7d1,,zip()} podem ter comprimentos diferentes; às vezes por design e às vezes por causa de um bug no código que preparou esses iteráveis. Python oferece três abordagens diferentes para lidar com esse problema:


@itemize *

@item 
Por padrão, @ref{7d1,,zip()} para quando o iterável mais curto se esgota. Ele irá ignorar os itens restantes nos iteráveis mais longos, cortando o resultado para o comprimento do iterável mais curto:

@example
>>> list(zip(range(3), ['fi', 'fa', 'fo', 'fum']))
[(0, 'fi'), (1, 'fa'), (2, 'fo')]
@end example

@item 
@ref{7d1,,zip()} é frequentemente usado em casos onde os iteráveis são considerados de tamanho igual. Nesses casos, é recomendado usar a opção @code{strict=True}. Sua saída é a mesma do @ref{7d1,,zip()}:: normal

@example
>>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True))
[('a', 1), ('b', 2), ('c', 3)]
@end example

Ao contrário do comportamento padrão, ele levanta uma exceção @ref{202,,ValueError} se um iterável for esgotado antes dos outros:

@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

Sem o argumento @code{strict=True}, qualquer bug que resulte em iteráveis de diferentes comprimentos será silenciado, possivelmente se manifestando como um bug difícil de encontrar em outra parte do programa.

@item 
Iteráveis mais curtos podem ser preenchidos com um valor constante para fazer com que todos os iteráveis tenham o mesmo comprimento. Isso é feito por @ref{12e0,,itertools.zip_longest()}.
@end itemize

Casos extremos: Com um único argumento iterável, @ref{7d1,,zip()} retorna um iterador de tuplas de um elemento. Sem argumentos, retorna um iterador vazio.

Dicas e truques:


@itemize *

@item 
A ordem de avaliação da esquerda para a direita dos iteráveis é garantida. Isso torna possível um idioma para agrupar uma série de dados em grupos de comprimento n usando @code{zip(*[iter(s)]*n, strict=True)}. Isso repete o `mesmo' iterador @code{n} vezes para que cada tupla de saída tenha o resultado de chamadas @code{n} para o iterador. Isso tem o efeito de dividir a entrada em pedaços de n comprimentos.

@item 
@ref{7d1,,zip()} em conjunto com o operador @code{*} pode ser usado para descompactar uma 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


Alterado na versão 3.10: Adicionado o argumento @code{strict}.

@end deffn

@geindex built-in function; __import__()
@anchor{library/functions import__}@anchor{8da}
@deffn {Função} __import__ (name, globals=None, locals=None, fromlist=(), level=0)

@geindex instrução;import
@geindex módulo;builtins

@cartouche
@quotation Nota 
Esta é uma função avançada que não é necessária na programação diária do Python, ao contrário de @ref{518,,importlib.import_module()}.
@end quotation
@end cartouche

Esta função é chamada pela instrução @ref{5e2,,import}. Ela pode ser substituída (importando o módulo @ref{12,,builtins} e atribuindo a @code{builtins.__import__}) para alterar a semântica da instrução @code{import}, mas isso é `fortemente' desencorajado, pois geralmente é mais simples usar ganchos de importação (consulte 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}) para atingir os mesmos objetivos e não causa problemas com o código que pressupõe que a implementação de importação padrão esteja em uso. O uso direto de @ref{8da,,__import__()} também é desencorajado em favor de @ref{518,,importlib.import_module()}.

A função importa o módulo `name', potencialmente usando os dados `globals' e `locals' para determinar como interpretar o nome em um contexto de pacote. O `fromlist' fornece os nomes de objetos ou submódulos que devem ser importados do módulo, fornecidos por `name'. A implementação padrão não usa seu argumento `locals' e usa seus `globals' apenas para determinar o contexto do pacote da instrução @ref{5e2,,import}.

`level' especifica se é necessário usar importações absolutas ou relativas. @code{0} (o padrão) significa apenas realizar importações absolutas. Valores positivos para `level' indicam o número de diretórios pai a serem pesquisados em relação ao diretório do módulo que chama @ref{8da,,__import__()} (consulte 
@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} para obter detalhes).

Quando a variável `name' está no formato @code{pacote.módulo}, normalmente, o pacote de nível superior (o nome até o primeiro ponto) é retornado, `não' o módulo nomeado por `name'. No entanto, quando um argumento `fromlist' não vazio é fornecido, o módulo nomeado por `name' é retornado.

Por exemplo, a instrução @code{import spam} resulta em bytecode semelhante ao seguinte código:

@example
spam = __import__('spam', globals(), locals(), [], 0)
@end example

A instrução @code{import spam.presunto} resulta nesta chamada:

@example
spam = __import__('spam.presunto', globals(), locals(), [], 0)
@end example

Observe como @ref{8da,,__import__()} retorna o módulo de nível superior aqui, porque este é o objeto vinculado a um nome pela instrução @ref{5e2,,import}.

Por outro lado, a instrução @code{from spam.presunto import ovos, salsicha as sals} resulta em

@example
_temp = __import__('spam.presunto', globals(), locals(), ['ovos', 'salsicha'], 0)
ovos = _temp.ovos
sals = _temp.salsicha
@end example

Aqui, o módulo @code{spam.ham} é retornado de @ref{8da,,__import__()}. A partir desse objeto, os nomes a serem importados são recuperados e atribuídos aos seus respectivos nomes.

Se você simplesmente deseja importar um módulo (potencialmente dentro de um pacote) pelo nome, use @ref{518,,importlib.import_module()}.


Alterado na versão 3.3: Valores negativos para `level' não são mais suportados (o que também altera o valor padrão para 0).



Alterado na versão 3.9: Quando as opções de linha de comando @ref{964,,-E} ou @ref{965,,-I} estão sendo usadas, a variável de ambiente 
@geindex PYTHONCASEOK
@geindex variável de ambiente; PYTHONCASEOK
@ref{963,,PYTHONCASEOK} é agora ignorada.

@end deffn

@node Constantes embutidas,Tipos embutidos,Funções embutidas<3>,A Biblioteca Padrão do Python
@anchor{library/constants doc}@anchor{2318}@anchor{library/constants built-in-constants}@anchor{2319}@anchor{library/constants built-in-consts}@anchor{231a}@anchor{library/constants translation-repo}@anchor{231b}
@section Constantes embutidas


Um pequeno número de constantes são definidas no espaço de nomes embutido da linguagem. São elas:

@geindex False (variável interna)
@anchor{library/constants False}@anchor{b49}
@deffn {Dado} False

O valor falso do tipo @ref{468,,bool}. As atribuições a @code{False} são ilegais e levantam @ref{18d,,SyntaxError}.
@end deffn

@geindex True (variável interna)
@anchor{library/constants True}@anchor{c27}
@deffn {Dado} True

O valor verdadeiro do tipo @ref{468,,bool}. As atribuições a @code{True} são ilegais e levantam @ref{18d,,SyntaxError}.
@end deffn

@geindex None (variável interna)
@anchor{library/constants None}@anchor{675}
@deffn {Dado} None

Um objeto frequentemente usado para representar a ausência de um valor, como quando os argumentos padrões não são passados para uma função. As atribuições a @code{None} são ilegais e levantam @ref{18d,,SyntaxError}. @code{None} é a única instância do tipo @ref{855,,NoneType}.
@end deffn

@geindex NotImplemented (variável interna)
@anchor{library/constants NotImplemented}@anchor{7d3}
@deffn {Dado} NotImplemented

Um valor especial que deve ser retornado pelos métodos binários especiais (por exemplo: @ref{b0d,,__eq__()}, @ref{12e2,,__lt__()}, @ref{2121,,__add__()}, @ref{2131,,__rsub__()}, etc.) não é implementado em relação ao outro tipo; pode ser retornado pelos métodos especiais binários no local (por exemplo: @ref{2126,,__imul__()}, @ref{2140,,__iand__()}, etc.) para o mesmo propósito. Ele não deve ser avaliado em um contexto booleano. @code{NotImplemented} é a única instância do tipo @ref{856,,types.NotImplementedType}.

@cartouche
@quotation Nota 
Quando um método binário (ou local) retorna @code{NotImplemented}, o interpretador tentará a operação refletida no outro tipo (ou algum outro fallback, dependendo do operador). Se todas as tentativas retornarem @code{NotImplemented}, o interpretador levantará uma exceção apropriada. Retornar incorretamente @code{NotImplemented} resultará em uma mensagem de erro enganosa ou no valor @code{NotImplemented} sendo retornado ao código Python.

Consulte @ref{2078,,Implementando as operações aritméticas} para ver exemplos.
@end quotation
@end cartouche

@cartouche
@quotation Cuidado 
@code{NotImplemented} e @code{NotImplementedError} não são intercambiáveis. Esta constante deve ser usada somente conforme descrito acima; veja @ref{228,,NotImplementedError} para detalhes sobre o uso correto da exceção.
@end quotation
@end cartouche


Alterado na versão 3.9: A avaliação de @code{NotImplemented} em um contexto booleano foi descontinuado. Embora atualmente seja avaliado como verdadeiro, ele emitirá um @ref{1a5,,DeprecationWarning}. Ele levantará uma @ref{2c3,,TypeError} em uma versão futura do Python.

@end deffn

@geindex ...;literal de reticências

@geindex Ellipsis (variável interna)
@anchor{library/constants Ellipsis}@anchor{231c}
@deffn {Dado} Ellipsis

O mesmo que o literal de reticências “@code{...}”, um objeto frequentemente usado para indicar que algo foi omitido. A atribuição a @code{Ellipsis} é possível, mas a atribuição a @code{...} levanta um @ref{18d,,SyntaxError}. @code{Ellipsis} é a única instância do tipo @ref{854,,types.EllipsisType}.
@end deffn

@geindex __debug__ (variável interna)
@anchor{library/constants debug__}@anchor{7db}
@deffn {Dado} __debug__

Esta constante é verdadeira se o Python não foi iniciado com uma opção @ref{ddd,,-O}. Veja também a instrução @ref{96f,,assert}.
@end deffn

@cartouche
@quotation Nota 
Os nomes @ref{675,,None}, @ref{b49,,False}, @ref{c27,,True} e @ref{7db,,__debug__} não podem ser reatribuídos (atribuições a eles, mesmo como um nome de atributo, levantam @ref{18d,,SyntaxError} ), para que possam ser consideradas “verdadeiras” constantes.
@end quotation
@end cartouche

@menu
* Constantes adicionadas pelo módulo site:: 

@end menu

@node Constantes adicionadas pelo módulo site,,,Constantes embutidas
@anchor{library/constants constants-added-by-the-site-module}@anchor{231d}@anchor{library/constants site-consts}@anchor{231e}
@subsection Constantes adicionadas pelo módulo @code{site}


O módulo @ref{c7,,site} (que é importado automaticamente durante a inicialização, exceto se a opção de linha de comando @ref{11e7,,-S} for fornecida) adiciona várias constantes ao espaço de nomes embutido. Eles são úteis para o console do interpretador interativo e não devem ser usados em programas.

@geindex quit (variável interna)
@geindex exit (variável interna)
@anchor{library/constants quit}@anchor{231f}
@deffn {Dado} quit (code=None)
@anchor{library/constants exit}@anchor{2320}
@deffnx {Dado} exit (code=None)

Objetos que, quando exibidos, exibem uma mensagem como “Use quit() or Ctrl-D (i.e. EOF) to exit” e, quando acessados diretamente no interpretador interativo ou chamados como funções, levantam @ref{d63,,SystemExit} com o código de saída especificado.
@end deffn


@deffn {Dado} help

Objeto que, quando exibido, exibe a mensagem “Type help() for interactive help, or help(object) for help about object.” e, quando acessado diretamente no interpretador interativo, invoca o sistema de ajuda embutido (veja @ref{8dd,,help()}).
@end deffn

@geindex copyright (variável interna)
@geindex credits (variável interna)
@anchor{library/constants copyright}@anchor{15b0}
@deffn {Dado} copyright
@anchor{library/constants credits}@anchor{15b1}
@deffnx {Dado} credits

Objetos que ao serem impressos ou chamados, imprimem o texto dos direitos autorais ou créditos, respectivamente.
@end deffn

@geindex license (variável interna)
@anchor{library/constants license}@anchor{15af}
@deffn {Dado} license

Objeto que, quando impresso, imprime a mensagem “Type license() to see the full license text” e, quando chamado, exibe o texto completo da licença de maneira semelhante a um paginador (uma tela por vez).
@end deffn

@c XXX: reference/datamodel and this have quite a few overlaps!

@node Tipos embutidos,Exceções embutidas,Constantes embutidas,A Biblioteca Padrão do Python
@anchor{library/stdtypes doc}@anchor{2321}@anchor{library/stdtypes bltin-types}@anchor{2322}@anchor{library/stdtypes built-in-types}@anchor{2323}@anchor{library/stdtypes translation-repo}@anchor{2324}
@section Tipos embutidos


As seções a seguir descrevem os tipos padrão que são embutidos ao interpretador.

@geindex embutido;types

Os principais tipos embutidos são numéricos, sequências, mapeamentos, classes, instâncias e exceções.

Algumas classes de coleção são mutáveis. Os métodos que adicionam, subtraem ou reorganizam seus membros no lugar, e não retornam um item específico, nunca retornam a instância da coleção propriamente dita, mas um @code{None}.

Algumas operações são suportadas por vários tipos de objetos; em particular, praticamente todos os objetos podem ser comparados em termos de igualdade, testados quanto ao valor verdade e convertidos em uma string (com a função @ref{800,,repr()} ou a função ligeiramente diferente @ref{44c,,str()}). A última função é implicitamente usada quando um objeto é escrito pela função @ref{fa9,,print()}.

@menu
* Teste do valor verdade:: 
* Operações booleanas — and@comma{} or@comma{} not: Operações booleanas — and or not. 
* Comparações: Comparações<2>. 
* Tipos numéricos — int@comma{} float@comma{} complex: Tipos numéricos — int float complex. 
* Tipo booleano - bool:: 
* Tipos iteradores:: 
* Tipos sequências — list@comma{} tuple@comma{} range: Tipos sequências — list tuple range. 
* Tipo sequência de texto — str:: 
* Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview: Tipos de sequência binária — bytes bytearray memoryview. 
* Tipo conjuntos — set@comma{} frozenset: Tipo conjuntos — set frozenset. 
* Tipo mapeamento — dict:: 
* Tipos de Gerenciador de Contexto:: 
* Tipos de anotação de tipo — Apelido genérico@comma{} União: Tipos de anotação de tipo — Apelido genérico União. 
* Outros tipos embutidos:: 
* Atributos Especiais:: 
* Limitação de comprimento de string na conversão para inteiro:: 

@end menu

@node Teste do valor verdade,Operações booleanas — and or not,,Tipos embutidos
@anchor{library/stdtypes truth}@anchor{162d}@anchor{library/stdtypes truth-value-testing}@anchor{2325}
@subsection Teste do valor verdade


@geindex instrução;if
@geindex instrução;while
@geindex verdade;valor
@geindex Booleano;operações
@geindex false

Qualquer objeto pode ser testado quanto ao valor verdade, para uso em uma condição @ref{2f3,,if} ou @ref{1d82,,while} ou como operando das operações booleanas abaixo.

@geindex true

Por padrão, um objeto é considerado verdadeiro, a menos que sua a classe defina um método @ref{1318,,__bool__()} que retorne @code{False} ou um método @ref{15b4,,__len__()} que retorna zero, quando chamado com o objeto. @footnote{
Informações adicionais sobre esses métodos especiais podem ser encontradas no Manual de Referência do Python (@ref{20ef,,Customização básica}).
} Aqui estão a maioria dos objetos embutidos considerados falsos:

@geindex None (Objeto embutido)
@geindex False (objeto embutido)


@itemize *

@item 
constantes definidas para serem falsas: @code{None} e @code{False}

@item 
zero de qualquer tipo numérico: @code{0}, @code{0.0}, @code{0j}, @code{Decimal(0)}, @code{Fraction(0, 1)}

@item 
sequências e coleções vazias: @code{'@w{'}}, @code{()}, @code{[]}, @code{@{@}}, @code{set()}, @code{range(0)}
@end itemize

@geindex operador;or
@geindex operador;and
@geindex False
@geindex True

Operações e funções embutidas que têm um resultado Booleano retornam @code{0} ou @code{False} para falso e @code{1} ou @code{True} para verdadeiro, salvo indicações ao contrário. (Exceção importante: as operações Booleanas @code{or} e @code{and} sempre retornam um de seus operandos.)

@node Operações booleanas — and or not,Comparações<2>,Teste do valor verdade,Tipos embutidos
@anchor{library/stdtypes boolean}@anchor{2326}@anchor{library/stdtypes boolean-operations-and-or-not}@anchor{2327}
@subsection Operações booleanas — @code{and}, @code{or}, @code{not}


@geindex Booleano;operações

Esses são as operações booleanas, ordenados por prioridade ascendente:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@tab

Notas

@item

@code{x or y}

@tab

se `x' é true, então `x', do contrário `y'

@tab

(1)

@item

@code{x and y}

@tab

se `x' é falso, então `x', do contrário `y'

@tab

(2)

@item

@code{not x}

@tab

se `x' é falso, então @code{True}, caso contrário @code{False}

@tab

(3)

@end multitable


@geindex operador;and
@geindex operador;or
@geindex operador;not

Notas:


@enumerate 

@item 
Esse é um operador de curto-circuito, por isso só avalia o segundo argumento se o primeiro é falso.

@item 
Este é um operador de curto-circuito, por isso só avalia o segundo argumento se o primeiro é verdadeiro.

@item 
@code{not} tem uma prioridade mais baixa do que operadores não booleanos, então @code{not a == b} é interpretado como @code{not (a == b)} e @code{a == not b} é um erro de sintaxe.
@end enumerate

@node Comparações<2>,Tipos numéricos — int float complex,Operações booleanas — and or not,Tipos embutidos
@anchor{library/stdtypes comparisons}@anchor{2328}@anchor{library/stdtypes stdcomparisons}@anchor{2329}
@subsection Comparações


@geindex encadeamento;comparações
@geindex operador;comparação
@geindex operador;==
@geindex operador;< (menor que)
@geindex operador;<=
@geindex operador;> (maior)
@geindex operador;>=
@geindex operador;!=
@geindex operador;is
@geindex operador;is not

Há oito operadores comparativos no Python. Todos eles possuem a mesma prioridade (que é maior do que aquela das operações Booleanas). Comparações podem ser encadeadas arbitrariamente; por exemplo, @code{x < y <= z} é equivalente a @code{x < y and y <= z}, exceto que `y' é avaliado apenas uma vez (porém em ambos os casos `z' não é avaliado de todo quando @code{x < y} é sabido ser falso).

Esta tabela resume as operações de comparação:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Significado

@item

@code{<}

@tab

estritamente menor que

@item

@code{<=}

@tab

menor que ou igual

@item

@code{>}

@tab

estritamente maior que

@item

@code{>=}

@tab

maior que ou igual

@item

@code{==}

@tab

igual

@item

@code{!=}

@tab

não é igual

@item

@code{is}

@tab

identidade do objeto

@item

@code{is not}

@tab

identidade de objeto negada

@end multitable


@geindex objeto;numérico
@geindex objetos;comparando

Unless stated otherwise, objects of different types never compare equal.
The @code{==} operator is always defined but for some object types (for example,
class objects) is equivalent to @ref{2f5,,is}. The @code{<}, @code{<=}, @code{>} and @code{>=}
operators are only defined where they make sense; for example, they raise a
@ref{2c3,,TypeError} exception when one of the arguments is a complex number.

@geindex __eq__() (método de instância)
@geindex __ne__() (método de instância)
@geindex __lt__() (método de instância)
@geindex __le__() (método de instância)
@geindex __gt__() (método de instância)
@geindex __ge__() (método de instância)

Instâncias não idênticas de uma classe normalmente comparam-se como desiguais ao menos que a classe defina o método @ref{b0d,,__eq__()}.

Instâncias de uma classe não podem ser ordenadas com respeito a outras instâncias da mesma classe, ou outros tipos de objeto, ao menos que a classe defina o suficiente dos métodos @ref{12e2,,__lt__()}, @ref{134f,,__le__()}, @ref{1350,,__gt__()} e @ref{1351,,__ge__()} (no geral, @ref{12e2,,__lt__()} e @ref{b0d,,__eq__()} são suficientes, se você quiser o significado convencional dos operadores de comparação).

O comportamento dos operadores @ref{2f5,,is} e @ref{220c,,is not} não pode ser personalizado; além disso eles podem ser aplicados a quaisquer dois objetos e nunca levantam uma exceção.

@geindex operador;in
@geindex operador;not in

Mais duas operações com a mesma prioridade sintática, @ref{2f4,,in} e @ref{62f,,not in}, são suportadas por tipos que são @ref{1268,,iteráveis} ou implementam o método @ref{1400,,__contains__()}.

@node Tipos numéricos — int float complex,Tipo booleano - bool,Comparações<2>,Tipos embutidos
@anchor{library/stdtypes numeric-types-int-float-complex}@anchor{232a}@anchor{library/stdtypes typesnumeric}@anchor{1d75}
@subsection Tipos numéricos — @code{int}, @code{float}, @code{complex}


@geindex objeto;numérico
@geindex objeto;Booleano
@geindex objeto;inteiro
@geindex objeto;ponto flutuante
@geindex objeto;número complexo
@geindex C;linguagem

Existem três tipos numéricos distintos: `inteiros', `números de ponto flutuante' e `números complexos'. Além disso, os booleanos são um subtipo de números inteiros. Inteiros têm precisão ilimitada. Números de ponto flutuante são geralmente implementados usando double em C; informações sobre a precisão e representação interna dos números de ponto flutuante para a máquina na qual seu programa está sendo executado estão disponíveis em @ref{1b62,,sys.float_info}. Números complexos têm uma parte real e imaginária, cada um com um número de ponto flutuante. Para extrair essas partes de um número complexo `z', use @code{z.real} e @code{z.imag}. (A biblioteca padrão inclui os tipos numéricos adicionais @ref{1e7,,fractions.Fraction}, para racionais, e @ref{29d,,decimal.Decimal}, para números de ponto flutuante com precisão definida pelo usuário.)

@geindex numérico;literais
@geindex inteiro;literais
@geindex ponto flutuante;literais
@geindex número complexo;literais
@geindex hexadecimal;literais
@geindex octal;literais
@geindex binário;literais

Números são criados por literais numéricos ou como resultado de operadores e funções embutidas. Integrais literais planos (incluindo números hexadecimais, octais e binários) culminam em integrais. Literais numéricos contendo um ponto decimal ou um sinal exponencial resultam em números de ponto flutuante. Anexando @code{'j'} ou @code{'J'} para um literal numérico resulta em um número imaginário (um número complexo com uma parte real zero) com a qual você pode adicionar a um integral ou flutuante para receber um número complexo com partes reais e imaginárias.

@geindex aritmética
@geindex função embutida;int
@geindex função embutida;ponto flutuante
@geindex função embutida;complexo
@geindex operador;+ (mais)
@geindex + (mais);operador unário
@geindex + (mais);operador binário
@geindex operador;- (menos)
@geindex - (menos);operador unário
@geindex - (menos);operador binário
@geindex operador;* (asterisco)
@geindex operador;/ (barra)
@geindex operador;//
@geindex operador;% (porcentagem)
@geindex operador;**

Python suporta completamente aritmética mista: quando um operador de aritmética binária tem operandos de tipos numéricos diferentes, o operando com o tipo “mais estreito” é ampliado para o tipo do outro operando, onde um inteiro é mais estreito do que um ponto flutuante, que por sua vez é mais estreito que um número complexo. Uma comparação entre números de diferentes tipos se comporta como se os valores exatos desses números estivessem sendo comparados. @footnote{
Como uma consequência, a lista @code{[1, 2]} é considerada igual a @code{[1.0, 2.0]}, e similarmente para tuplas.
}

Os construtores @ref{257,,int()}, @ref{2f7,,float()}, e @ref{2f8,,complex()} podem ser usados para produzir números de um tipo específico.

Todos os tipos numéricos (exceto complexos) suportam as seguintes operações (para prioridades das operações, consulte @ref{2221,,Precedência de operadores}):


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@tab

Notas

@tab

Documentação completa

@item

@code{x + y}

@tab

soma de `x' e `y'

@tab

@tab

@item

@code{x - y}

@tab

diferença de `x' e `y'

@tab

@tab

@item

@code{x * y}

@tab

produto de `x' e `y'

@tab

@tab

@item

@code{x / y}

@tab

quociente de `x' e `y'

@tab

@tab

@item

@code{x // y}

@tab

piso do quociente de `x' e `y'

@tab

(1)(2)

@tab

@item

@code{x % y}

@tab

restante de @code{x / y}

@tab

(2)

@tab

@item

@code{-x}

@tab

`x' negado

@tab

@tab

@item

@code{+x}

@tab

`x' inalterado

@tab

@tab

@item

@code{abs(x)}

@tab

valor absoluto ou magnitude de `x'

@tab

@tab

@ref{1e2d,,abs()}

@item

@code{int(x)}

@tab

`x' convertido em inteiro

@tab

(3)(6)

@tab

@ref{257,,int()}

@item

@code{float(x)}

@tab

`x' convertido em ponto flutuante

@tab

(4)(6)

@tab

@ref{2f7,,float()}

@item

@code{complex(re, im)}

@tab

um número complexo com parte real `re', parte imaginária `im'. `im' tem como padrão zero.

@tab

(6)

@tab

@ref{2f8,,complex()}

@item

@code{c.conjugate()}

@tab

conjugado do número complexo `c'

@tab

@tab

@item

@code{divmod(x, y)}

@tab

o par @code{(x // y, x % y)}

@tab

(2)

@tab

@ref{9a9,,divmod()}

@item

@code{pow(x, y)}

@tab

`x' elevado a `y'

@tab

(5)

@tab

@ref{9da,,pow()}

@item

@code{x ** y}

@tab

`x' elevado a `y'

@tab

(5)

@tab

@end multitable


@geindex operações em;numérico;types
@geindex conjugate() (método de número complexo)

Notas:


@enumerate 

@item 
Também referido como uma divisão inteira. Para operandos do tipo @ref{257,,int}, o resultado tem o tipo @ref{257,,int}; Para operandos do tipo @ref{2f7,,float}, o resultado tem o tipo @ref{2f7,,float}. Em geral o resultado é inteiro como todo, apesar do tipo do resultado não necessariamente ser @ref{257,,int}. O resultado é sempre arredondado para menos infinito: @code{1//2} é @code{0}, @code{(-1)//2} é @code{-1}, @code{1//(-2)} é @code{-1} e @code{(-1)//(-2)} é @code{0}.

@item 
Não para números complexos. Ao invés disso, converte para pontos flutuantes usando @ref{1e2d,,abs()} se for apropriado.

@item 
@geindex módulo;math
@geindex floor() (no módulo math)
@geindex ceil() (no módulo math)
@geindex trunc() (no módulo math)
@geindex numérico;conversões

Conversão de @ref{2f7,,float} para @ref{257,,int} trunca, descartando a parte fracionária. Veja as funções @ref{1404,,math.floor()} e @ref{1405,,math.ceil()} para conversões alternativas.

@item 
ponto flutuante também aceita a string “nan” e “inf” com um prefixo opcional “+” ou “-” a Não é um Número (NaN) e infinidade positiva ou negativa.

@item 
Python define @code{pow(0, 0)} e @code{0 ** 0} sendo @code{1}, como é comum para linguagens de programação.

@item 
Os literais numéricos aceitos incluem os dígitos de @code{0} a @code{9} ou qualquer equivalente Unicode (pontos de código com a propriedade @code{Nd}).

Veja o Unicode Standard@footnote{https://unicode.org/Public/UNIDATA/extracted/DerivedNumericType.txt} para obter uma lista completa de pontos de código com a propriedade @code{Nd}.
@end enumerate

Todos os tipos @ref{232b,,numbers.Real} (@ref{257,,int} e @ref{2f7,,float}) também incluem as seguintes operações.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@item

@ref{1406,,math.trunc(x)}

@tab

`x' truncado para @ref{214b,,Integral}

@item

@ref{131d,,round(x[@comma{} n])}

@tab

`x' arredondado para `n' dígitos, arredondando metade para igualar. Se `n' é omitido, ele toma o padrão de 0.

@item

@ref{1404,,math.floor(x)}

@tab

o maior @ref{214b,,Integral} <= `x'

@item

@ref{1405,,math.ceil(x)}

@tab

pelo menos @ref{214b,,Integral} >= `x'

@end multitable


Para operações numéricas adicionais, consulte os módulos @ref{8e,,math} e @ref{18,,cmath}.

@c XXXJH exceptions: overflow (when? what operations?) zerodivision

@menu
* Operações de bits em tipos inteiros:: 
* Métodos adicionais em tipos inteiros:: 
* Métodos adicionais em ponto flutuante:: 
* Hashing de tipos numéricos:: 

@end menu

@node Operações de bits em tipos inteiros,Métodos adicionais em tipos inteiros,,Tipos numéricos — int float complex
@anchor{library/stdtypes bitstring-ops}@anchor{232c}@anchor{library/stdtypes bitwise-operations-on-integer-types}@anchor{232d}
@subsubsection Operações de bits em tipos inteiros


@geindex operações em;inteiro;types
@geindex bit a bit;operações
@geindex deslocamento;operações
@geindex mascaramento;operações
@geindex operador;| (barra vertical)
@geindex operador;^ (circunflexo)
@geindex operador;& (e comercial)
@geindex operador;<<
@geindex operador;>>
@geindex operador;~ (til)

Operações bit a bit só fazem sentido para números inteiros. O resultado de operações bit a bit é calculado como se fosse realizado no complemento de dois com um número infinito de bits de sinal.

As prioridades das operações bit a bit binárias são todas menores do que as operações numéricas e maiores que as comparações; a operação unária @code{~} tem a mesma prioridade que as outras operações numéricas unárias (@code{+} e @code{-}).

Esta tabela lista as operações de bits classificadas em prioridade ascendente:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@tab

Notas

@item

@code{x | y}

@tab

`ou' bit a bit de `x' e `y'

@tab

(4)

@item

@code{x ^ y}

@tab

`ou exclusivo' bit a bit de `x' e `y'

@tab

(4)

@item

@code{x & y}

@tab

`e' bit a bit de `x' e `y'

@tab

(4)

@item

@code{x << n}

@tab

`x' deslocado para a esquerda por `n' bits

@tab

(1)(2)

@item

@code{x >> n}

@tab

`x' deslocado para a direita por `n' bits

@tab

(1)(3)

@item

@code{~x}

@tab

os bits de `x' invertidos

@tab

@end multitable


Notas:


@enumerate 

@item 
Contagens de deslocamento negativo são ilegais e levantam uma @ref{202,,ValueError} .

@item 
Um deslocamento à esquerda por `n' bits é equivalente à multiplicação por @code{pow(2, n)}.

@item 
Um deslocamento à direita por `n' bits é equivalente à divisão pelo piso por @code{pow(2, n)}.

@item 
Executar esses cálculos com pelo menos um bit extra de extensão de sinal na representação de complemento de dois finitos (uma largura de bit de trabalho @code{1 + max(x.bit_length(), y.bit_length())} ou mais) é suficiente para obter o mesmo resultado como se houvesse um número infinito de bits de sinal.
@end enumerate

@node Métodos adicionais em tipos inteiros,Métodos adicionais em ponto flutuante,Operações de bits em tipos inteiros,Tipos numéricos — int float complex
@anchor{library/stdtypes additional-methods-on-integer-types}@anchor{232e}
@subsubsection Métodos adicionais em tipos inteiros


O tipo int implementa a @ref{11f5,,classe base abstrata} @ref{214b,,numbers.Integral}. Além disso, ele provê mais alguns métodos:

@geindex bit_length() (método int)
@anchor{library/stdtypes int bit_length}@anchor{232f}
@deffn {Método} int.bit_length ()

Retorna o número de bits necessários para representar um inteiro em binário, excluindo o sinal e entrelinha zeros:

@example
>>> n = -37
>>> bin(n)
'-0b100101'
>>> n.bit_length()
6
@end example

Mais precisamente, se @code{x} for diferente de zero, então @code{x.bit_length()} é o único positivo inteiro @code{k} tal que @code{2**(k-1) <= abs(x) < 2**k}. Equivalentemente, quando @code{abs(x)} for pequeno o suficiente para ter um logaritmo corretamente arrendondado, então @code{k = 1 + int(log(abs(x), 2))}. Se @code{x} é zero, então @code{x.bit_length()} retorna @code{0}.

Equivalente a:

@example
def bit_length(self):
    s = bin(self)       # representação binária:  bin(-37) --> '-0b100101'
    s = s.lstrip('-0b') # remove zeros no início e sinal negativo
    return len(s)       # len('100101') --> 6
@end example


Adicionado na versão 3.1.

@end deffn

@geindex bit_count() (método int)
@anchor{library/stdtypes int bit_count}@anchor{7cd}
@deffn {Método} int.bit_count ()

Retorna o número de unidades na representação binária do valor absoluto do inteiro. Isso também é conhecido como contagem da população. Exemplo:

@example
>>> n = 19
>>> bin(n)
'0b10011'
>>> n.bit_count()
3
>>> (-n).bit_count()
3
@end example

Equivalente a:

@example
def bit_count(self):
    return bin(self).count("1")
@end example


Adicionado na versão 3.10.

@end deffn

@geindex to_bytes() (método int)
@anchor{library/stdtypes int to_bytes}@anchor{19bd}
@deffn {Método} int.to_bytes (length=1, byteorder='big', *, signed=False)

Retorna um vetor de bytes representando um inteiro.

@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

O inteiro é representado usando `length' bytes, e o padrão é 1. Uma @ref{885,,OverflowError} é levantada se um inteiro não é representável com o dado número de bytes.

O argumento `byteorder' determina a ordem de bytes usada para representar um inteiro, e o padrão é @code{"big"}. Se o `byteorder' é @code{"big"}, o byte mais significativo está no início do vetor de byte. Se `byteorder' é @code{"little"}, o byte mais significativo está no final do vetor de byte.

O argumento `signed' determina aonde o modo de complemento de dois é usado para representar o inteiro. Se `signed' é @code{False} e um inteiro negativo é dado, uma @ref{885,,OverflowError} é levantada. O valor padrão para `signed' é @code{False}.

Os valores padrão podem ser usados para transformar convenientemente um inteiro em um objeto de byte único:

@example
>>> (65).to_bytes()
b'A'
@end example

No entanto, ao usar os argumentos padrão, não tente converter um valor maior que 255 ou você obterá um @ref{885,,OverflowError}.

Equivalente 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


Adicionado na versão 3.2.



Alterado na versão 3.11: Adicionados valores de argumento padrão para @code{length} e @code{byteorder}.

@end deffn

@geindex from_bytes() (método de classe int)
@anchor{library/stdtypes int from_bytes}@anchor{1972}
@deffn {Método} classmethod int.from_bytes (bytes, byteorder='big', *, signed=False)

Retorna o inteiro representado pelo vetor de bytes dado.

@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

O argumento `bytes' precisa ou ser um @ref{d4f,,objeto bytes ou similar} ou um iterador produzindo bytes.

O argumento `byteorder' determina a ordem de bytes usada para representar um inteiro, e o padrão é @code{"big"}. Se o `byteorder' é @code{"big"}, o byte mais significativo está no início do vetor de byte. Se `byteorder' é @code{"little"}, o byte mais significativo está no final do vetor de byte. Para requisitar a ordem nativa de byte do sistema hospedeiro, use @ref{2330,,sys.byteorder} como o valor da ordem de byte.

O argumento `signed' indica quando o complemento de dois é usado para representar o inteiro.

Equivalente 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


Adicionado na versão 3.2.



Alterado na versão 3.11: Adicionado valor de argumento padrão para @code{byteorder}.

@end deffn

@geindex as_integer_ratio() (método int)
@anchor{library/stdtypes int as_integer_ratio}@anchor{9d3}
@deffn {Método} int.as_integer_ratio ()

Retorna um par de números inteiros cuja razão é igual ao número inteiro original e tem um denominador positivo. A proporção inteira de números inteiros (números inteiros) é sempre o número inteiro como numerador e @code{1} como denominador.


Adicionado na versão 3.8.

@end deffn

@geindex is_integer() (método int)
@anchor{library/stdtypes int is_integer}@anchor{1873}
@deffn {Método} int.is_integer ()

Retorna @code{True}. Existe para compatibilidade com tipo pato com @ref{2331,,float.is_integer()}.


Adicionado na versão 3.12.

@end deffn

@node Métodos adicionais em ponto flutuante,Hashing de tipos numéricos,Métodos adicionais em tipos inteiros,Tipos numéricos — int float complex
@anchor{library/stdtypes additional-methods-on-float}@anchor{2332}
@subsubsection Métodos adicionais em ponto flutuante


O tipo float implementa a @ref{11f5,,classe base abstrata} @ref{232b,,numbers.Real}. float também possui os seguintes métodos adicionais.

@geindex as_integer_ratio() (método float)
@anchor{library/stdtypes float as_integer_ratio}@anchor{1e9a}
@deffn {Método} float.as_integer_ratio ()

Retorna um par de inteiros dos quais a proporção é exatamente igual ao float original.  A proporção está em seus termos mais baixos e tem um denominador positivo. Levanta um @ref{885,,OverflowError} em infinidades e um @ref{202,,ValueError} em NaNs.
@end deffn

@geindex is_integer() (método float)
@anchor{library/stdtypes float is_integer}@anchor{2331}
@deffn {Método} float.is_integer ()

Retorna @code{True} se a instância do float for finita com o valor integral e @code{False}, caso contrário:

@example
>>> (-2.0).is_integer()
True
>>> (3.2).is_integer()
False
@end example
@end deffn

Dois métodos suportam conversão para e de strings hexadecimais. Uma vez que os pontos flutuantes do Python são armazenados internamente como números binários, a conversão de um ponto flutuante para ou de uma string `decimal' geralmente envolve um pequeno erro de arredondamento. Em contraste, as strings hexadecimais permitem a representação exata e a especificação de números de ponto flutuante. Isso pode ser útil na depuração e no trabalho numérico.

@geindex hex() (método float)
@anchor{library/stdtypes float hex}@anchor{1e9b}
@deffn {Método} float.hex ()

Retorna a representação de um número de ponto flutuante como uma string hexadecimal. Para números de ponto flutuante finitos, essa representação vai sempre incluir um @code{0x} inicial e um @code{p} final e expoente.
@end deffn

@geindex fromhex() (método de classe float)
@anchor{library/stdtypes float fromhex}@anchor{2333}
@deffn {Método} classmethod float.fromhex (s)

Método de classe para retornar um ponto flutuante representado por uma string hexadecimal `s'. A string `s' pode ter espaços em branco iniciais e finais.
@end deffn

Note que @ref{1e9b,,float.hex()} é um método de instância, enquanto @ref{2333,,float.fromhex()} é um método de classe.

Uma string hexadecimal toma a forma:

@example
[sign] ['0x'] integer ['.' fraction] ['p' exponent]
@end example

onde o sinal opcional @code{sign} pode ser tanto @code{+} or @code{-}, @code{integer} e @code{fraction} são strings de dígitos hexadecimais, e @code{exponent} é um inteiro decimal com um sinal opcional no início. Maiúsculo ou minúsculo não é significativo, e deve haver ao menos um dígito hexadecimal tanto no inteiro ou na fração. Essa sintaxe é similar à sintaxe especificada na seção 6.4.4.2 do padrão C99, e também do da sintaxe usada no Java 1.5 em diante. Em particular, a saída de @ref{1e9b,,float.hex()} é usável como um literal hexadecimal de ponto flutuante em código C ou Java, e strings hexadecimais produzidas pelo formato do caractere @code{%a} do C ou @code{Double.toHexString} do Java são aceitos pelo @ref{2333,,float.fromhex()}.

Note que o expoente é escrito em decimal ao invés de hexadecimal, e que ele dá a potência de 2 pela qual se multiplica o coeficiente. Por exemplo, a string hexadecimal @code{0x3.a7p10} representa o número de ponto flutuante @code{(3 + 10./16 + 7./16**2) * 2.0**10} ou @code{3740.0}:

@example
>>> float.fromhex('0x3.a7p10')
3740.0
@end example

Aplicando a conversão inversa a @code{3740.0} retorna uma string hexadecimal diferente representada pelo mesmo número:

@example
>>> float.hex(3740.0)
'0x1.d380000000000p+11'
@end example

@node Hashing de tipos numéricos,,Métodos adicionais em ponto flutuante,Tipos numéricos — int float complex
@anchor{library/stdtypes hashing-of-numeric-types}@anchor{2334}@anchor{library/stdtypes numeric-hash}@anchor{2335}
@subsubsection Hashing de tipos numéricos


Para números @code{x} e @code{y}, possivelmente de diferentes tipos, é um requisito que @code{hash(x) == hash(y)} sempre que @code{x == y} (veja a documentação do método @ref{b0e,,__hash__()} para mais detalhes). Para facilitar a implementação e eficiência através de uma variedade de tipos numéricos (incluindo @ref{257,,int}, @ref{2f7,,float}, @ref{29d,,decimal.Decimal} e @ref{1e7,,fractions.Fraction}), o hash do Python para tipos numéricos é baseado em uma única função matemática que é definida para qualquer número racional e, portanto, se aplica para todas as instâncias de @ref{257,,int} e @ref{1e7,,fractions.Fraction}, e todas as instâncias finitas das classes @ref{2f7,,float} e @ref{29d,,decimal.Decimal}. Essencialmente, essa função é dada pelo módulo de redução @code{P} para um primo fixado @code{P}. O valor de @code{P} é disponibilizado ao Python como um atributo @ref{2336,,modulus} do @ref{1035,,sys.hash_info}.

Atualmente, o primo usado é @code{P = 2**31 - 1} em máquinas com longos de 32 bits do C e @code{P = 2**61 - 1} em máquinas com longos de 64 bits do C.

Aqui estão as regras em detalhe:


@itemize -

@item 
Se @code{x = m / n} é um número racional não negativo e @code{n} não é divisível por @code{P}, define @code{hash(x)} como @code{m * invmod(n, P) % P}, onde @code{invmod(n, P)} retorna o inverso do módulo de @code{n} com @code{P}.

@item 
Se @code{x = m / n} é um número racional não negativo e @code{n} é divisível por @code{P} (porém @code{m} não é) então @code{n} não possui modulo @code{P} inverso e a regra acima não se aplica; nesse caso defina @code{hash(x)} para ser o valor constante @code{sys.hash_info.inf}.

@item 
Se @code{x = m / n} é um número racional negativo, defina @code{hash(x)} como @code{-hash(-x)}. Se a hash resultante é @code{-1}, a substituo com @code{-2}.

@item 
Os valores particulares @code{sys.hash_info.inf} e @code{-sys.hash_info.inf} são usados como valores de hash para infinidade positiva ou infinidade negativa (respectivamente).

@item 
Para número @ref{2f8,,complex} @code{z}, o valor da hash do número real partes imaginárias são combinados calculando @code{hash(z.real) + sys.hash_info.imag * hash(z.imag)}, módulo reduzido @code{2**sys.hash_info.width} de modo que isto permaneça em @code{range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - 1))}. Novamente, se o resultado é @code{-1}, ele é substituído por @code{-2}.
@end itemize

Para esclarecer as regras acima, aqui estão alguns exemplos de código em Python, equivalentes ao hash embutido, para calcular o hash de números racionais, @ref{2f7,,float} ou @ref{2f8,,complex}:

@example
import sys, math

def hash_fraction(m, n):
    """Calcula o hash de um número racional m / n.

    Presume que m e n são inteiros, com n positivo.
    Equivalente a hash(fractions.Fraction(m, n)).

    """
    P = sys.hash_info.modulus
    # Remove fatores comuns de P.  (Desnecessário se m e n são primos entre si.)
    while m % P == n % P == 0:
        m, n = m // P, n // P

    if n % P == 0:
        hash_value = sys.hash_info.inf
    else:
        # Pequeno teorema de Fermat: pow(n, P-1, P) é 1, então
        # pow(n, P-2, P) dá o inverso de n módulo 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):
    """Calcula o hash de um ponto flutuante 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):
    """Calcula o hash de um número complexo z."""

    hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag)
    # faz um módulo para redução de sinal 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{2337}
@node Tipo booleano - bool,Tipos iteradores,Tipos numéricos — int float complex,Tipos embutidos
@anchor{library/stdtypes boolean-type-bool}@anchor{2338}@anchor{library/stdtypes typebool}@anchor{22f6}
@subsection Tipo booleano - @code{bool}


Booleanos representam valores verdade. O tipo @ref{468,,bool} tem exatamente duas instâncias constantes: @code{True} e @code{False}.

@geindex False
@geindex True
@geindex Booleano;valores

A função embutida @ref{468,,bool()} converte qualquer valor em um booleano, se o valor puder ser interpretado como um valor verdade (consultar seção @ref{162d,,Teste do valor verdade} acima).

Para operações lógicas, use @ref{2326,,operadores booleanos} @code{and}, @code{or} e @code{not}. Ao aplicar operadores bit a bit @code{&}, @code{|}, @code{^} a dois booleanos, o resultado é um booleano equivalente às operações lógicas “e”, “ou”, “xor”. Entretanto, é preferível usar os operadores lógicos @code{and}, @code{or} e @code{!=} em relação aos @code{&}, @code{|} e @code{^}.


Descontinuado desde a versão 3.12: O uso do operador de inversão bit a bit @code{~} foi descontinuado e levantará um erro no Python 3.16.


@ref{468,,bool} é uma subclasse @ref{257,,int} (veja @ref{1d75,,Tipos numéricos — int@comma{} float@comma{} complex}). Em diversos contextos numéricos, @code{False} e @code{True} se comportam como 0 e 1, respectivamente. Entretanto, basear-se somente nisso,  é desencorajado; ao invés disso, a conversão deve ser feita explicitamente usando @ref{257,,int()}.

@node Tipos iteradores,Tipos sequências — list tuple range,Tipo booleano - bool,Tipos embutidos
@anchor{library/stdtypes iterator-types}@anchor{2339}@anchor{library/stdtypes typeiter}@anchor{230c}
@subsection Tipos iteradores


@geindex protocolo iterador
@geindex protocolo;iterador
@geindex sequência;iteração
@geindex contêiner;iteração por

Python suporta o conceito de iteração por contêineres. Isso é implementado usando dois métodos distintos; estes são usados para permitir classes definidas pelo usuário suportem iteração. Sequências, descritas abaixo em mais detalhes, sempre suportam os métodos de iteração.

Um método necessita ser definido para objetos contêineres afim destes proverem suporte a @ref{1268,,iterável}:

@c XXX duplicated in reference/datamodel!

@geindex __iter__() (método container)
@anchor{library/stdtypes container __iter__}@anchor{1e4a}
@deffn {Método} container.__iter__ ()

Retorna um objeto @ref{1ac,,iterador}. O objeto deve suportar o protocolo iterador descrito abaixo. Se um contêiner suporta diferentes tipos de iterador, métodos adicionais podem ser providenciados para requisitar especificamente iteradores para aqueles tipos de iterações. (Um exemplo de um objeto suportando múltiplas formas de iteração seria uma estrutura em árvore a qual suporta ambas travessias de travessia em largura e em profundidade.) Esse método corresponde ao slot @ref{1537,,tp_iter} da estrutura de tipos para objetos Python na API Python/C.
@end deffn

Os próprios objetos iteradores são obrigados a suportarem os dois métodos a seguir, que juntos formam o `protocolo iterador':

@geindex __iter__() (método iterator)
@anchor{library/stdtypes iterator __iter__}@anchor{1e4d}
@deffn {Método} iterator.__iter__ ()

Retorna o próprio objeto @ref{1ac,,iterador} em si. Isso é necessário para permitir que ambos os contêineres e iteradores sejam usados com as instruções @ref{2f2,,for} e @ref{2f4,,in}. Este método corresponde ao slot @ref{1537,,tp_iter} da estrutura de tipos para objetos Python na API Python/C.
@end deffn

@geindex __next__() (método iterator)
@anchor{library/stdtypes iterator __next__}@anchor{1310}
@deffn {Método} iterator.__next__ ()

Retorna o próximo item do @ref{1ac,,iterador}. Se não houver itens além, a exceção @ref{c15,,StopIteration} é levantada. Esse método corresponde ao slot @ref{1538,,tp_iternext} da estrutura de tipos para objetos Python na API Python/C.
@end deffn

Python define diversos objetos iteradores para suportar iterações sobre tipos de sequências gerais e específicas, dicionários, e outras formas mais especializadas. Os tipos específicos não são importantes além de sua implementação do protocolo iterador.

Uma vez que o método @ref{1310,,__next__()} do iterador levantou @ref{c15,,StopIteration}, ele deve continuar fazendo isso em chamadas subsequentes. Implementações que não obedecem essa propriedade são consideradas quebradas.

@menu
* Tipos geradores:: 

@end menu

@node Tipos geradores,,,Tipos iteradores
@anchor{library/stdtypes generator-types}@anchor{233a}@anchor{library/stdtypes id3}@anchor{233b}
@subsubsection Tipos geradores


Os @ref{109a,,geradores} do Python proveem uma maneira conveniente para implementar o protocolo iterador. Se o método @ref{c8a,,__iter__()} de um objeto contêiner é implementado como um gerador, ele irá automaticamente retornar um objeto iterador (tecnicamente, um objeto gerador) fornecendo os métodos @ref{1e4d,,__iter__()} e @ref{1e4e,,__next__()}. Mais informações sobre geradores podem ser encontradas na @ref{21cc,,documentação para a expressão yield}.

@node Tipos sequências — list tuple range,Tipo sequência de texto — str,Tipos iteradores,Tipos embutidos
@anchor{library/stdtypes sequence-types-list-tuple-range}@anchor{233c}@anchor{library/stdtypes typesseq}@anchor{1dcc}
@subsection Tipos sequências — @code{list}, @code{tuple}, @code{range}


Existem três tipos básicos de sequência: listas, tuplas e objetos range. Tipos de sequência adicionais adaptados para o processamento de @ref{22f9,,dados binários} e @ref{1d7a,,strings de texto} são descritos em seções dedicadas.

@menu
* Operações comuns de sequências:: 
* Tipos sequência imutáveis:: 
* Tipos sequências mutáveis:: 
* Listas: Listas<2>. 
* Tuplas:: 
* Intervalos:: 

@end menu

@node Operações comuns de sequências,Tipos sequência imutáveis,,Tipos sequências — list tuple range
@anchor{library/stdtypes common-sequence-operations}@anchor{233d}@anchor{library/stdtypes typesseq-common}@anchor{233e}
@subsubsection Operações comuns de sequências


@geindex objeto;sequência

As operações nas seguintes tabelas são suportadas pela maioria dos tipos sequências, ambos mutáveis e imutáveis. A classe ABC @ref{1204,,collections.abc.Sequence} é fornecida para tornar fácil a correta implementação desses operadores em tipos sequências personalizados.

Essa tabela lista as operações de sequência ordenadas em prioridade ascendente. Na tabela, `s' e `t' são sequências do mesmo tipo, `n', `i', `j' e `k' são inteiros e `x' é um objeto arbitrário que atende a qualquer restrição de valor e tipo imposta por `s'.

As operações @code{in} e @code{not in} têm as mesmas prioridades que as operações de comparação. As operações @code{+} (concatenação) e @code{*} (repetição) têm a mesma prioridade que as operações numéricas correspondentes. @footnote{
Eles precisam ter, já que o analisador sintático não consegue dizer o tipo dos operandos.
}

@geindex operações em;sequência;types
@geindex função embutida;len
@geindex função embutida;min
@geindex função embutida;max
@geindex concatenação;operação
@geindex repetição;operação
@geindex subscrição;operação
@geindex fatia;operação
@geindex operador;in
@geindex operador;not in


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@tab

Notas

@item

@code{x in s}

@tab

@code{True} caso um item de `s' seja igual a `x', caso contrário @code{False}

@tab

(1)

@item

@code{x not in s}

@tab

@code{False} caso um item de `s' for igual a `x', caso contrário @code{True}

@tab

(1)

@item

@code{s + t}

@tab

a concatenação de `s' e `t'

@tab

(6)(7)

@item

@code{s * n} ou @code{n * s}

@tab

equivalente a adicionar `s' a si mesmo `n' vezes

@tab

(2)(7)

@item

@code{s[i]}

@tab

`i'-ésimo item de `s', origem 0

@tab

(3)(8)

@item

@code{s[i:j]}

@tab

fatia de `s' de `i' até `j'

@tab

(3)(4)

@item

@code{s[i:j:k]}

@tab

fatia de `s' de `i' até `j' com passo `k'

@tab

(3)(5)

@item

@code{len(s)}

@tab

comprimento de `s'

@tab

@item

@code{min(s)}

@tab

menor item de `s'

@tab

@item

@code{max(s)}

@tab

maior item de `s'

@tab

@end multitable


Sequências do mesmo tipo também admitem comparações. Em particular, tuplas e listas são comparadas lexicograficamente por meio da comparação de elementos correspondentes. Isso significa que, para comparar igualmente, cada elemento deve ser comparado igual e as duas sequências devem ser do mesmo tipo e possuir o mesmo comprimento. (Para detalhes completos, veja @ref{2205,,Comparações} na referência da linguagem.)

@geindex laço;sobre sequência mutável
@geindex sequência mutável;laço sobre

Iteradores para frente e reversos sobre sequências mutáveis acessam valores usando um índice. Esse índice continuará avançando (ou retrocedendo) mesmo que a sequência subjacente seja alterada. O iterador termina somente quando um @ref{157e,,IndexError} ou um @ref{c15,,StopIteration} é encontrado (ou quando o índice cai abaixo de zero).

Notas:


@enumerate 

@item 
Enquanto as operações @code{in} e @code{not in} são usadas somente para testes de contenção simples em modo geral, algumas sequências especializadas (tais como @ref{44c,,str}, @ref{1c2,,bytes} e @ref{2ea,,bytearray}) também usam-nas para testes de subsequências:

@example
>>> "gg" in "eggs"
True
@end example

@item 
Os valores de `n' menos @code{0} são tratados como @code{0} (o que produz uma sequência vazia do mesmo tipo que `s'). Observe que os itens na sequência `s' não são copiados; eles são referenciados várias vezes. Isso frequentemente assombra novos programadores Python; considere então que:

@example
>>> lists = [[]] * 3
>>> lists
[[], [], []]
>>> lists[0].append(3)
>>> lists
[[3], [3], [3]]
@end example

O que aconteceu é que @code{[[]]} é uma lista de um elemento contendo uma lista vazia, então todos os três elementos de @code{[[]] * 3} são referências a esta única lista vazia. Modificar qualquer um dos elementos de @code{lists} modifica a lista vazia. Podemos criar uma lista de listas diferentes dessa maneira:

@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

Mais explicação está disponível no FAQ @ref{233f,,Como faço para criar uma lista multidimensional?}.

@item 
Se `i' ou `j' for negativo, o índice será relativo ao fim da sequência `s': @code{len(s) + i} ou @code{len(s) + j} será substituído. Mas note que @code{-0} ainda será @code{0}.

@item 
The slice of `s' from `i' to `j' is defined as the sequence of items with
index `k' such that @code{i <= k < j}.


@itemize *

@item 
If `i' is omitted or @code{None}, use @code{0}.

@item 
If `j' is omitted or @code{None}, use @code{len(s)}.

@item 
If `i' or `j' is less than @code{-len(s)}, use @code{0}.

@item 
If `i' or `j' is greater than @code{len(s)}, use @code{len(s)}.

@item 
If `i' is greater than or equal to `j', the slice is empty.
@end itemize

@item 
A fatia `s' de `i' até `j' com passo `k' é definida como sendo a sequência de itens com índice @code{x = i + n*k} tal que @code{0 <= n < (j-i)/k}. Em outras palavras, os índices são @code{i}, @code{i+k}, @code{i+2*k}, @code{i+3*k} e assim por diante, parando quando `j' for atingido (mas nunca incluindo `j'). Quando `k' for positivo, `i' e `j' serão reduzidos a @code{len(s)} se forem maiores. Quando `k' for negativo, `i' e `j' são reduzidos para @code{len(s) - 1} se forem maiores. Se `i' ou `j' forem omitidos ou @code{None}, eles se tornam valores “finais” (cujo final depende de `k'). Nota: `k' não pode ser zero. Se `k' for @code{None}, o mesmo será tratado como sendo igual a @code{1}.

@item 
Concatenar sequências imutáveis sempre resulta em um novo objeto. Isso significa que a criação de uma sequência por concatenação repetida terá um custo quadrático de tempo de execução no comprimento total da sequência. Para obter um custo de tempo de execução linear, devemos alternar para uma das alternativas abaixo:


@itemize *

@item 
Se estiver concatenando objetos @ref{44c,,str}, você pode criar uma lista e usar @ref{2340,,str.join()} no final ou então escrever numa instância de @ref{f59,,io.StringIO} e recuperar o seu valor ao final

@item 
Se estiver concatenando objetos @ref{1c2,,bytes}, você também pode usar o método @ref{2341,,bytes.join()} ou @ref{ed3,,io.BytesIO}, ou você pode fazer concatenação interna com um objeto @ref{2ea,,bytearray}. A classe @ref{2ea,,bytearray} são objetos mutáveis e possuem um eficiente mecanismo de superalocação

@item 
Se estiver concatenando objetos @ref{370,,tuple}, estenda a classe @ref{611,,list} em vez disso

@item 
para outros tipos, busque na documentação relevante da classe
@end itemize

@item 
Alguns tipos de sequências (como @ref{94a,,range}) apenas aceitam sequências de itens que seguem padrões específicos e, portanto, não implementam concatenação nem repetição de sequências.

@item 
Uma @ref{157e,,IndexError} é levantada se `i' estiver fora do intervalo da sequência.
@end enumerate

@subsubheading Métodos de sequência


Tipos de sequência também oferecem suporte aos seguintes métodos:


@geindex count() (método sequence)
@anchor{library/stdtypes list count}@anchor{140c}@anchor{library/stdtypes sequence count}@anchor{211a}
@deffn {Método} sequence.count (value, /)

Retorna o número total de ocorrências de `value' em `sequence'.
@end deffn


@geindex index() (método sequence)
@anchor{library/stdtypes list index}@anchor{140b}@anchor{library/stdtypes sequence index}@anchor{211c}
@deffn {Método} sequence.index (value[, start[, stop])

Retorna o índice da primeira ocorrência de `value' em `sequence'.

Levanta @ref{202,,ValueError} se `value' não for encontrado em `sequence'.

Os argumentos `start' ou `stop' permitem uma busca eficiente de subseções da sequência, começando em `start' e terminando em `stop'. Isso é aproximadamente equivalente a @code{start + sequence[start:stop].index(value)}, só que sem copiar nenhum dado.

@cartouche
@quotation Cuidado 
Nem todos os tipos de sequência oferecem suporte a passagem dos argumentos `start' e `stop'.
@end quotation
@end cartouche
@end deffn

@node Tipos sequência imutáveis,Tipos sequências mutáveis,Operações comuns de sequências,Tipos sequências — list tuple range
@anchor{library/stdtypes immutable-sequence-types}@anchor{2342}@anchor{library/stdtypes typesseq-immutable}@anchor{2343}
@subsubsection Tipos sequência imutáveis


@geindex imutável;sequência;types
@geindex objeto;tupla
@geindex função embutida;hash

A única operação que os tipos sequências imutáveis geralmente implementam que também não é implementada pelos tipos sequências mutáveis é suporte para a função embutida @ref{5eb,,hash()}.

Esse suporte permite sequências imutáveis, tais como instâncias da classe @ref{370,,tuple}, serem usadas como chaves de dicionários @ref{256,,dict} e armazenados em instâncias de @ref{5d9,,set} e de @ref{5da,,frozenset}.

A tentativa de obter um hash de uma sequência imutável que contém valores desnecessários resultará em um erro @ref{2c3,,TypeError}.

@node Tipos sequências mutáveis,Listas<2>,Tipos sequência imutáveis,Tipos sequências — list tuple range
@anchor{library/stdtypes mutable-sequence-types}@anchor{2344}@anchor{library/stdtypes typesseq-mutable}@anchor{22f7}
@subsubsection Tipos sequências mutáveis


@geindex mutável;sequência;types
@geindex objeto;lista
@geindex objeto;bytearray

As operações na tabela a seguir são definidas em tipos sequência mutáveis. A ABC @ref{1a1,,collections.abc.MutableSequence} é fornecida para tornar mais fácil a implementação correta dessas operações em tipos sequências personalizados.

Na tabela `s' é uma instância de um tipo de sequência mutável, `t' é qualquer objeto iterável e `x' é um objeto arbitrário que atende a qualquer restrição de tipo e valor imposto por `s' (por exemplo @ref{2ea,,bytearray} só aceita inteiros que atendam a restrição de valor @code{0 <= x <= 255}).

@geindex operações em;sequência;types
@geindex operações em;lista;tipo
@geindex subscrição;atribuição
@geindex fatia;atribuição
@geindex instrução;del


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@tab

Notas

@item

@code{s[i] = x}

@tab

item `i' de `s' é substituído por `x'

@tab

@item

@code{del s[i]}

@tab

remove o item `i' de `s'

@tab

@item

@code{s[i:j] = t}

@tab

fatias de `s' de `i' até `j' são substituídas pelo conteúdo do iterável `t'

@tab

@item

@code{del s[i:j]}

@tab

remove os elementos de @code{s[i:j]} da lista (mesmo que @code{s[i:j] = []})

@tab

@item

@code{s[i:j:k] = t}

@tab

os elementos de @code{s[i:j:k]} são substituídos por aqueles de `t'

@tab

(1)

@item

@code{del s[i:j:k]}

@tab

remove os elementos de @code{s[i:j:k]} desde a listas

@tab

@item

@code{s += t}

@tab

estende `s' com o conteúdo de `t' (na maior parte do mesmo @code{s[len(s):len(s)] = t})

@tab

@item

@code{s *= n}

@tab

atualiza `s' com o seu conteúdo por `n' vezes

@tab

(2)

@end multitable


Notas:


@enumerate 

@item 
se `k' não for igual a @code{1}, `t' deve ter o mesmo comprimento que a fatia a qual ele está substituindo.

@item 
O valor `n' é um inteiro, ou um objeto implementando @ref{71d,,__index__()}. Valores zero e negativos de `n' limparão a sequência. Os itens na sequência não são copiados; eles são referenciados várias vezes, como explicado para @code{s * n} em @ref{233e,,Operações comuns de sequências}.
@end enumerate

@subsubheading Métodos de sequências mutáveis


Tipos de sequências mutáveis também oferecem suporte aos seguintes métodos:


@geindex append() (método sequence)
@anchor{library/stdtypes bytearray append}@anchor{13ec}@anchor{library/stdtypes sequence append}@anchor{2118}
@deffn {Método} sequence.append (value, /)

Adiciona `value' ao final da sequência. Isso equivale a escrever @code{seq[len(seq):len(seq)] = [value]}.
@end deffn


@geindex clear() (método sequence)
@anchor{library/stdtypes bytearray clear}@anchor{2345}@anchor{library/stdtypes sequence clear}@anchor{2119}
@deffn {Método} sequence.clear ()


Adicionado na versão 3.3.


Remove todos os itens de `sequence'. Isso equivale a escrever @code{del sequence[:]}.
@end deffn


@geindex copy() (método sequence)
@anchor{library/stdtypes bytearray copy}@anchor{2346}@anchor{library/stdtypes sequence copy}@anchor{2347}
@deffn {Método} sequence.copy ()


Adicionado na versão 3.3.


Cria uma cópia rasa de `sequence'. Isso equivale a escrever @code{sequence[:]}.

@cartouche
@quotation Dica 
O método @code{copy()} não faz parte de @ref{1a1,,MutableSequence} @ref{f49,,ABC}, mas a maioria dos tipos de sequências mutáveis concretas o fornecem.
@end quotation
@end cartouche
@end deffn


@geindex extend() (método sequence)
@anchor{library/stdtypes bytearray extend}@anchor{15b6}@anchor{library/stdtypes sequence extend}@anchor{211b}
@deffn {Método} sequence.extend (iterable, /)

Estende `sequence' com o conteúdo de `iterable'. Em geral, isso equivale a escrever @code{seq[len(seq):len(seq)] = iterable}.
@end deffn


@geindex insert() (método sequence)
@anchor{library/stdtypes bytearray insert}@anchor{2348}@anchor{library/stdtypes sequence insert}@anchor{211d}
@deffn {Método} sequence.insert (index, value, /)

Insire `value' em `sequence' no `index' fornecido. Isso equivale a escrever @code{sequence[index:index] = [value]}.
@end deffn


@geindex pop() (método sequence)
@anchor{library/stdtypes bytearray pop}@anchor{13ed}@anchor{library/stdtypes sequence pop}@anchor{211e}
@deffn {Método} sequence.pop (index=-1, /)

Recupera o item em `index' e também o remove de `sequence'. Por padrão, o último item em `sequence' é removido e retornado.
@end deffn


@geindex remove() (método sequence)
@anchor{library/stdtypes bytearray remove}@anchor{2349}@anchor{library/stdtypes sequence remove}@anchor{211f}
@deffn {Método} sequence.remove (value, /)

Remove o primeiro item de `sequence' onde @code{sequence[i] == value}.

Levanta @ref{202,,ValueError} se `value' não for encontrado em `sequence'.
@end deffn


@geindex reverse() (método sequence)
@anchor{library/stdtypes bytearray reverse}@anchor{13ee}@anchor{library/stdtypes sequence reverse}@anchor{2120}
@deffn {Método} sequence.reverse ()

Inverte os itens da `sequence' no lugar. Este método mantém a economia de espaço ao inverter uma sequência grande. Para lembrar aos usuários que ele opera por efeito colateral, ele retorna @code{None}.
@end deffn

@node Listas<2>,Tuplas,Tipos sequências mutáveis,Tipos sequências — list tuple range
@anchor{library/stdtypes lists}@anchor{234a}@anchor{library/stdtypes typesseq-list}@anchor{1dc0}
@subsubsection Listas


@geindex objeto;lista

As listas são sequências mutáveis, normalmente usadas para armazenar coleções de itens homogêneos (onde o grau preciso de similaridade variará de acordo com a aplicação).

@geindex list (classe interna)
@anchor{library/stdtypes list}@anchor{611}
@deffn {Classe} list (iterable=(), /)

As listas podem ser construídas de várias maneiras:


@itemize *

@item 
Usando um par de colchetes para denotar uma lista vazia: @code{[]}

@item 
Usando colchetes, separando itens por vírgulas: @code{[a]}, @code{[a, b, c]}

@item 
Usando uma compreensão de lista: @code{[x for x in iterable]}

@item 
Usando o construtor de tipo: @code{list()} ou @code{list(iterable)}
@end itemize

O construtor produz uma lista cujos itens são iguais e na mesma ordem que os itens de `iterable'. `iterable' pode ser uma sequência, um contêiner que suporte iteração ou um objeto iterador. Se `iterable' já for uma lista, uma cópia será feita e retornada, semelhante a @code{iterable[:]}. Por exemplo, @code{list('abc')} retorna @code{['a', 'b', 'c']} e @code{list( (1, 2, 3) )} retorna @code{[1, 2, 3]}. Se nenhum argumento for dado, o construtor criará uma nova lista vazia @code{[]}.

Muitas outras operações também produzem listas, incluindo a função embutida @ref{be7,,sorted()}.

Listas implementam todas as operações de sequências @ref{233e,,comuns} e @ref{22f7,,mutáveis}. As listas também fornecem o seguinte método adicional:

@geindex sort() (método list)
@anchor{library/stdtypes list sort}@anchor{be8}
@deffn {Método} sort (*, key=None, reverse=False)

Esse método classifica a lista in-place, usando apenas comparações @code{<} entre itens. As exceções não são suprimidas – se qualquer operação de comparação falhar, toda a operação de ordenação falhará (e a lista provavelmente será deixada em um estado parcialmente modificado).

@ref{be8,,sort()} aceita 2 argumentos que só podem ser passados como @ref{2a5,,argumentos somente-nomeados}:

`key' especifica uma função de um argumento que é usado para extrair uma chave de comparação de cada elemento da lista (por exemplo, @code{key=str.lower}). A chave correspondente a cada item na lista é calculada uma vez e depois usada para todo o processo de classificação. O valor padrão @code{None} significa que os itens da lista são classificados diretamente sem calcular um valor de chave separado.

A função utilitária @ref{121a,,functools.cmp_to_key()} está disponível para converter a função `cmp' no estilo 2.x para uma função `key'.

`reverse' é um valor booleano. Se definido igual a @code{True}, então os elementos da lista são classificados como se cada comparação estivesse invertida.

Este método modifica a sequência in-place para economizar espaço ao classificar uma sequência grande. Para lembrar aos usuários que os mesmos operam por efeito colateral, ele não retorna a sequência ordenada (utilize a função @ref{be7,,sorted()} para solicitar explicitamente uma nova instância da lista ordenada).

O método @ref{be8,,sort()} é garantido como sendo estável. Uma classificação é estável se ela garantir não alterar a ordem relativa de elementos que comparam igual – isso é útil para classificar em várias passagens (por exemplo, classificar por departamento, depois por nota salarial).

Para exemplos de classificação e um breve tutorial de classificação, veja @ref{2314,,Técnicas de ordenação}.

No momento em que uma lista está sendo ordenada, o efeito de tentar alterar, ou mesmo inspecionar, a lista é indefinida. A implementação C do Python faz com que a lista apareça vazia durante o tempo de processamento, e levanta a exceção @ref{202,,ValueError} se puder detectar que a lista foi alterada durante uma ordenação.
@end deffn
@end deffn

@node Tuplas,Intervalos,Listas<2>,Tipos sequências — list tuple range
@anchor{library/stdtypes tuples}@anchor{234b}@anchor{library/stdtypes typesseq-tuple}@anchor{2280}
@subsubsection Tuplas


@geindex objeto;tupla

Tuplas são sequências imutáveis, tipicamente usadas para armazenar coleções de dados heterogêneos (como as tuplas de 2 elementos produzidas pelo função embutida @ref{14c9,,enumerate()}). Tuplas também são usadas para casos em que seja necessária uma sequência imutável de dados homogêneos (como permitir o armazenamento em uma instância @ref{5d9,,set} ou @ref{256,,dict}).

@geindex tuple (classe interna)
@anchor{library/stdtypes tuple}@anchor{370}
@deffn {Classe} tuple (iterable=(), /)

As tuplas podem ser construídas de várias maneiras:


@itemize *

@item 
Usando um par de parênteses para denotar a tupla vazia: @code{()}

@item 
Usando uma vírgula à direita para uma tupla singleton: @code{a,} ou @code{(a,)}

@item 
Separando os itens com vírgulas: @code{a, b, c} ou @code{(a, b, c)}

@item 
Usando a função embutida @ref{370,,tuple()}: @code{tuple()} ou @code{tuple(iterable)}
@end itemize

O construtor constrói uma tupla cujos itens são iguais e na mesma ordem dos itens de `iterable'. `iterable' pode ser uma sequência, um contêiner que suporta iteração ou um objeto iterador. Se `iterable' já for uma tupla, este será retornado inalterado. Por exemplo, @code{tuple('abc')} retorna @code{('a', 'b', 'c')} e @code{tuple( [1, 2, 3] )} retorna @code{(1, 2, 3)}. Se nenhum argumento for dado, o construtor criará uma tupla vazia, @code{()}.

Observe que, na verdade, é a vírgula que faz uma tupla, e não os parênteses. Os parênteses são opcionais, exceto no caso de tupla vazia, ou quando são necessários para evitar ambiguidades sintáticas. Por exemplo, @code{f(a, b, c)} é uma chamada da função com três argumentos, enquanto que @code{f((a, b, c))} é uma chamada de função com uma tupla de 3 elementos com um único argumento.

As tuplas implementam todas as operações @ref{233e,,comuns} de sequência.
@end deffn

Para coleções heterogêneas de dados onde o acesso pelo nome é mais claro do que o acesso pelo índice, @ref{1ca,,collections.namedtuple()} pode ser uma escolha mais apropriada do que um objeto tupla simples.

@node Intervalos,,Tuplas,Tipos sequências — list tuple range
@anchor{library/stdtypes ranges}@anchor{234c}@anchor{library/stdtypes typesseq-range}@anchor{2312}
@subsubsection Intervalos


@geindex objeto;range

O tipo @ref{94a,,range} representa uma sequência imutável de números e é comumente usado para percorrer um número determinado de vezes em um laço @ref{2f2,,for}.

@geindex range (classe interna)
@anchor{library/stdtypes range}@anchor{94a}
@deffn {Classe} range (stop, /)

@deffnx {Classe} range (start, stop, step=1, /)

Os argumentos para o construtor de intervalo devem ser inteiros (@ref{257,,int} embutido ou qualquer objeto que implemente o método especial @ref{71d,,__index__()}). Se o argumento `step' for omitido, será usado o padrão @code{1}. Se o argumento `start' for omitido, será usado o padrão @code{0}. Se `step' for zero, uma exceção @ref{202,,ValueError} será levantada.

Para um `step' positivo, o conteúdo de um intervalo @code{r} será determinado pela fórmula @code{r[i] = start + step*i} onde @code{i >= 0} e @code{r[i] < stop}.

Para um `step' negativo, o conteúdo do intervalo ainda será determinado pela fórmula @code{r[i] = start + step*i}, mas as restrições serão @code{i >= 0} e @code{r[i] > stop}.

Um objeto intervalo estará vazio se @code{r[0]} não atender à restrição de valor. Intervalos suportam índices negativos, mas estes são interpretados como indexadores partindo do final da sequência determinada pelos índices positivos.

Intervalos contendo valores absolutos maiores que @ref{1205,,sys.maxsize} são permitidos, mas alguns recursos (como @ref{62e,,len()}) podem levantar @ref{885,,OverflowError}.

Exemplos de intervalos:

@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

Ranges implementam todas as operações @ref{233e,,comuns} de sequência, exceto a concatenação e a repetição (devido ao fato de que os objetos intervalos só podem representar sequências que seguem um padrão rígido. e a repetição e a concatenação geralmente vão violar esse padrão).

@geindex start (atributo range)
@anchor{library/stdtypes range start}@anchor{234d}
@deffn {Atributo} start

O valor do parâmetro `start' (ou @code{0} se o parâmetro não for fornecido)
@end deffn

@geindex stop (atributo range)
@anchor{library/stdtypes range stop}@anchor{234e}
@deffn {Atributo} stop

O valor do parâmetro `stop'
@end deffn

@geindex step (atributo range)
@anchor{library/stdtypes range step}@anchor{234f}
@deffn {Atributo} step

O valor do parâmetro `step' (ou @code{1} se o parâmetro não for fornecido)
@end deffn
@end deffn

A vantagem do tipo @ref{94a,,range} sobre um @ref{611,,list} ou @ref{370,,tuple} regular é que um objeto @ref{94a,,range} sempre terá a mesma quantidade (pequena) de memória, não importa o tamanho do intervalo o mesmo esteja representando (como ele apenas armazena os valores @code{start}, @code{stop} e @code{step}, calculando itens individuais e subintervalos conforme necessário).

Objetos intervalos implementam a ABC @ref{1204,,collections.abc.Sequence}, e fornecem recursos como testes de contenção, pesquisa de índice de elemento, fatiamento e suporte a índices negativos (veja @ref{1dcc,,Tipos sequências — 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

Testar objetos intervalos por igualdade com @code{==} e @code{!=} os compara como sequências. Ou seja, dois objetos intervalos são considerados iguais se representarem a mesma sequência de valores. (Observe que dois objetos intervalos considerados iguais podem ter diferentes atributos @ref{234d,,start}, @ref{234e,,stop} e @ref{234f,,step}, por exemplo @code{range(0) == range(2, 1, 3)} ou @code{range(0, 3, 2) == range(0, 4, 2)}.)


Alterado na versão 3.2: Implementa a ABC Sequence. Suporte a fatiamento e a índices negativos. Testa objetos @ref{257,,int} para associação em tempo constante em vez de iterar através de todos os itens.



Alterado na versão 3.3: Define ‘==’ e ‘!=’ para comparar objetos intervalos com base na sequência de valores que eles definem (em vez de comparar com base na identidade do objeto).

Adicionados os atributos @ref{234d,,start}, @ref{234e,,stop} e @ref{234f,,step}.



@subsubheading Ver também



@itemize *

@item 
A receita de linspace@footnote{https://code.activestate.com/recipes/579000-equally-spaced-numbers-linspace/} mostra como implementar uma versão preguiçosa de um intervalo adequado para aplicações de ponto flutuante.
@end itemize


@geindex string;tipo sequência de texto
@geindex str (classe embutida);(veja também string)
@geindex objeto;string

@node Tipo sequência de texto — str,Tipos de sequência binária — bytes bytearray memoryview,Tipos sequências — list tuple range,Tipos embutidos
@anchor{library/stdtypes text-sequence-type-str}@anchor{2350}@anchor{library/stdtypes textseq}@anchor{1d7a}
@subsection Tipo sequência de texto — @code{str}


Os dados textuais em Python são tratados com objetos @ref{44c,,str}, ou `strings'. Strings são @ref{1dcc,,sequências} imutáveis de pontos de código Unicode. As strings literais são escritas de diversas maneiras:


@itemize *

@item 
Aspas simples: @code{'permitem aspas "duplas" internas'}

@item 
Aspas duplas: @code{"permitem aspas 'simples' internas"}

@item 
Aspas triplas: @code{'@w{'}'Três aspas simples'@w{'}'}, @code{"""Três aspas duplas"""}
@end itemize

Strings de aspas triplas podem expandir por várias linhas – todos os espaços em branco associados serão incluídos em literal string.

Os literais strings que fazem parte de uma única expressão e têm apenas espaços em branco entre eles serão implicitamente convertidos em um único literal string. Isso é, @code{("spam " "eggs") == "spam eggs"}.

Veja @ref{2031,,Literais de string e bytes} para mais informações sobre as várias formas de literal de string, incluindo o suporte a @ref{45a,,sequêncis de escape}, e o prefixo @code{r} (“raw”) que desabilita a maioria dos processos de sequência de escape.

As strings também podem ser criadas a partir de outros objetos usando o construtor @ref{44c,,str}.

Uma vez que não há nenhum tipo de “caractere” separador, indexar uma string produz strings de comprimento 1. Ou seja, para uma string não vazia `s', @code{s[0] == s[0:1]}.

@geindex objeto;io.StringIO

Também não existe um tipo string mutável, mas o método @ref{2340,,str.join()} ou a classe @ref{f59,,io.StringIO} podem ser usados para construir strings de forma eficiente a partir de vários partes distintas.


Alterado na versão 3.3: Para a compatibilidade com versões anteriores do Python 2, o prefixo @code{u} foi mais uma vez permitido em literais strings. Não possui quaisquer efeito sobre o significado de literais strings e não pode ser combinado com o prefixo @code{r}.


@geindex string;str (classe embutida)

@geindex str (classe interna)
@anchor{library/stdtypes str}@anchor{44c}
@deffn {Classe} str (*, encoding='utf-8', errors='strict')

@deffnx {Classe} str (object)

@deffnx {Classe} str (object, encoding, errors='strict')

@deffnx {Classe} str (object, *, errors)

Retorna uma versão @ref{1d7a,,string} de `object'. Se `object' não é fornecido, retorna uma string vazia. Caso contrário, o comportamento de @code{str()} dependerá se o `encoding' ou `errors' são fornecidos, da seguinte forma.

Se nem `encoding' nem `errors' for fornecido, @code{str(object)} retornará @ref{61d,,type(object).__str__(object)}, que é a representação da string “informal” ou que pode ser facilmente imprimível  de `object'. Para objetos string, esta é a própria string. Se `object' não tiver um método:@ref{61d,,__str__()}, então a função @ref{44c,,str()} retornará @ref{800,,repr(object)}.

@geindex protocolo de buffer;str (classe embutida)
@geindex bytes;str (classe embutida)

Se pelo menos um de `encoding' ou `errors' for fornecido, `object' deve ser um @ref{d4f,,objeto bytes ou similar} (por exemplo, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}). Nesse caso, se `object' for um objeto @ref{1c2,,bytes} (ou @ref{2ea,,bytearray}), então @code{str(bytes, encoding, errors)} equivale a @ref{8dc,,bytes.decode(encoding@comma{} errors)}. Caso contrário, o objeto bytes subjacente ao objeto buffer é obtido antes de chamar @ref{8dc,,bytes.decode()}. Veja @ref{22f9,,Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview} e @ref{2e8,,Protocolo de buffer} para obter informações sobre objetos buffer.

Passando um objeto @ref{1c2,,bytes} para @ref{44c,,str()} sem os argumentos `encoding' ou `errors' se enquadra no primeiro caso de retornar a representação informal de strings (consulte também a opção de linha de comando @ref{5e3,,-b} para Python). Por exemplo:

@example
>>> str(b'Zoot!')
"b'Zoot!'"
@end example

Para mais informações sobre a classe @code{str} e seus métodos, veja @ref{1d7a,,Tipo sequência de texto — str} e a seção @ref{1d7b,,String Methods} abaixo.  Para gerar strings formatadas, veja as seções @ref{9b1,,f-strings} e @ref{13e2,,Sintaxe das strings de formato}. Além disso, veja a seção @ref{2351,,Serviços de Processamento de Texto}.
@end deffn

@geindex string;métodos

@menu
* String Methods: String Methods<2>. 
* Strings literais formatadas (f-strings): Strings literais formatadas f-strings. 
* Formatação de string no estilo printf:: 

@end menu

@node String Methods<2>,Strings literais formatadas f-strings,,Tipo sequência de texto — str
@anchor{library/stdtypes id5}@anchor{2352}@anchor{library/stdtypes string-methods}@anchor{1d7b}
@subsubsection String Methods


@geindex módulo;re

Strings implementam todas as operações @ref{233e,,comuns} de sequências, juntamente com os métodos adicionais descritos abaixo.

Strings também possuem suporte para duas formas de formatação de string, uma fornecendo uma ampla gama de flexibilidade e customização (veja @ref{621,,str.format()}, @ref{13e2,,Sintaxe das strings de formato} e @ref{2353,,Formatação personalizada de strings}) e a outra baseada no estilo de formatação @code{printf} da linguagem C, que lida com uma gama menor de tipos e é levemente mais difícil de utilizar corretamente, mas é frequentemente mais rápida para os casos na qual ela consegue manipular (@ref{6cc,,Formatação de string no estilo printf}).

A seção @ref{2354,,Serviços de Processamento de Texto} da biblioteca padrão cobre um número de diversos outros módulos que fornecem vários utilitários relacionados a texto (incluindo suporte a expressões regulares no módulo @ref{b9,,re}).

@geindex capitalize() (método str)
@anchor{library/stdtypes str capitalize}@anchor{2355}
@deffn {Método} str.capitalize ()

Retorna uma cópia da string com o seu primeiro caractere em maiúsculo e o restante em minúsculo.


Alterado na versão 3.8: O primeiro caractere agora é colocado em `titlecase' ao invés de letras maiúsculas. Isso significa que caracteres como dígrafos apenas terão sua primeira letra alterada para maiúscula, ao invés de todos os caracteres.

@end deffn

@geindex casefold() (método str)
@anchor{library/stdtypes str casefold}@anchor{e00}
@deffn {Método} str.casefold ()

Retorna uma cópia da string em `casefolded'. Strings em `casefold' podem ser usadas para corresponder letras sem importar se são minúsculas ou maiúsculas.

Casefolding is similar to lowercasing but more aggressive because it is
intended to remove all case distinctions in a string. For example, the German
lowercase letter @code{'ß'} is equivalent to @code{"ss"}. Since it is already
lowercase, @ref{1901,,lower()} would do nothing to @code{'ß'}; @ref{e00,,casefold()}
converts it to @code{"ss"}.
For example:

@example
>>> 'straße'.lower()
'straße'
>>> 'straße'.casefold()
'strasse'
@end example

O algoritmo `casefolding' está descrito na seção 3.13 'Default Case Folding' do Padrão Unicode@footnote{https://www.unicode.org/versions/Unicode15.1.0/ch03.pdf}.


Adicionado na versão 3.3.

@end deffn

@geindex center() (método str)
@anchor{library/stdtypes str center}@anchor{1e03}
@deffn {Método} str.center (width, fillchar=' ', /)

Retorna um texto centralizado em uma string de comprimento `width'. Preenchimento é feito usando o parâmetro `fillchar' especificado (padrão é o caractere de espaço ASCII). A string original é retornada se `width' é menor ou igual que @code{len(s)}. Por exemplo:

@example
>>> 'Python'.center(10)
'  Python  '
>>> 'Python'.center(10, '-')
'--Python--'
>>> 'Python'.center(4)
'Python'
@end example
@end deffn

@geindex count() (método str)
@anchor{library/stdtypes str count}@anchor{1732}
@deffn {Método} str.count (sub[, start[, end]])

Retorna o número de ocorrências da sub-string `sub' que não se sobrepõem no intervalo [`start', `end']. Argumentos opcionais `start' e `end' são interpretados como na notação de fatias.

Se `sub' estiver vazio, retorna o número de strings vazias entre os caracteres, que é o comprimento da string mais um. Por exemplo:

@example
>>> 'spam, spam, spam'.count('spam')
3
>>> 'spam, spam, spam'.count('spam', 5)
2
>>> 'spam, spam, spam'.count('spam', 5, 10)
1
>>> 'spam, spam, spam'.count('eggs')
0
>>> 'spam, spam, spam'.count('@w{'})
17
@end example
@end deffn

@geindex encode() (método str)
@anchor{library/stdtypes str encode}@anchor{8db}
@deffn {Método} str.encode (encoding='utf-8', errors='strict')

Retorna a string codificada para @ref{1c2,,bytes}.

`encoding' tem como padrão @code{'utf-8'}; veja @ref{de1,,Standard Encodings} para valores possíveis.

`errors' controla como os erros de codificação são tratados. Se @code{'strict'} (o padrão), uma exceção @ref{12e6,,UnicodeError} é levantada. Outros valores possíveis são @code{'ignore'}, @code{'replace'}, @code{'xmlcharrefreplace'}, @code{'backslashreplace'} e qualquer outro nome registrado via @ref{14e3,,codecs.register_error()}. Veja @ref{18fa,,Error Handlers} para detalhes.

Por motivos de desempenho, o valor de `errors' não é verificado quanto à validade, a menos que um erro de codificação realmente ocorra, @ref{1f8,,Modo de Desenvolvimento do Python} esteja ativado ou uma @ref{1f9,,construção de depuração} seja usada. Por exemplo:

@example
>>> encoded_str_to_bytes = 'Python'.encode()
>>> type(encoded_str_to_bytes)
<class 'bytes'>
>>> encoded_str_to_bytes
b'Python'
@end example


Alterado na versão 3.1: Adicionado suporte para argumentos nomeados.



Alterado na versão 3.9: O valor do argumento `errors' agora é verificado em @ref{1f8,,Modo de Desenvolvimento do Python} e no @ref{1f9,,modo de depuração}.

@end deffn

@geindex endswith() (método str)
@anchor{library/stdtypes str endswith}@anchor{efb}
@deffn {Método} str.endswith (suffix[, start[, end]])

Retorna @code{True} se a string terminar com o `suffix' especificado, caso contrário retorna @code{False}.  `suffix' também pode ser uma tupla de sufixos para procurar. Com o parâmetro opcional `start', começamos a testar a partir daquela posição. Com o parâmetro opcional `end', devemos parar de comparar na posição especificada. Usar `start' e `end' equivale a @code{str[start:end].endswith(suffix)}. Por exemplo:

@example
>>> 'Python'.endswith('on')
True
>>> 'a tuple of suffixes'.endswith(('at', 'in'))
False
>>> 'a tuple of suffixes'.endswith(('at', 'es'))
True
>>> 'Python is amazing'.endswith('is', 0, 9)
True
@end example

Veja também @ref{efa,,startswith()} e @ref{8d6,,removesuffix()}.
@end deffn

@geindex expandtabs() (método str)
@anchor{library/stdtypes str expandtabs}@anchor{2356}
@deffn {Método} str.expandtabs (tabsize=8)

Retorna uma cópia da string onde todos os caracteres de tabulação são substituídos por um ou mais espaços, dependendo da coluna atual e do tamanho fornecido para a tabulação. Posições de tabulação ocorrem a cada `tabsize' caracteres (o padrão é 8, dada as posições de tabulação nas colunas 0, 8, 16 e assim por diante). Para expandir a string, a coluna atual é definida como zero e a string é examinada caractere por caractere. Se o caractere é uma tabulação (@code{\t}), um ou mais caracteres de espaço são inseridos no resultado até que a coluna atual seja igual a próxima posição de tabulação. (O caractere de tabulação em si não é copiado.) Se o caractere é um caractere de nova linha (@code{\n}) ou de retorno (@code{\r}), ele é copiado e a coluna atual é redefinida para zero. Qualquer outro caractere é copiado sem ser modificado e a coluna atual é incrementada em uma unidade independentemente de como o caractere é representado quando é impresso. Por exemplo:

@example
>>> '01\t012\t0123\t01234'.expandtabs()
'01      012     0123    01234'
>>> '01\t012\t0123\t01234'.expandtabs(4)
'01  012 0123    01234'
>>> print('01\t012\n0123\t01234'.expandtabs(4))
01  012
0123    01234
@end example
@end deffn

@geindex find() (método str)
@anchor{library/stdtypes str find}@anchor{ed7}
@deffn {Método} str.find (sub[, start[, end]])

Retorna o índice mais baixo na string onde a substring `sub' é encontrado dentro da fatia @code{s[start:end]}. Argumentos opcionais como `start' e `end' são interpretados como na notação de fatiamento. Retorna @code{-1} se `sub' não for localizado. Por exemplo:

@example
>>> 'spam, spam, spam'.find('sp')
0
>>> 'spam, spam, spam'.find('sp', 5)
6
@end example

Veja também @ref{ed8,,rfind()} e @ref{1733,,index()}.

@cartouche
@quotation Nota 
O método @ref{ed7,,find()} deve ser usado apenas se precisarmos conhecer a posição de `sub'. Para verificar se `sub' é ou não uma substring, use o operador @ref{2f4,,in}:

@example
>>> 'Py' in 'Python'
True
@end example
@end quotation
@end cartouche
@end deffn

@geindex format() (método str)
@anchor{library/stdtypes str format}@anchor{621}
@deffn {Método} str.format (*args, **kwargs)

Executa uma operação de formatação de string. A string na qual este método é chamado pode conter texto literal ou campos para substituição delimitados por chaves @code{@{@}}. Cada campo de substituição contém um índice numérico de um argumento posicional ou o nome de um argumento nomeado. Retorna a cópia da string onde cada campo para substituição é substituído com o valor da string do argumento correspondente. Por exemplo:

@example
>>> "A soma de 1 + 2 é @{0@}".format(1+2)
'A soma de 1 + 2 é 3'
>>> "A soma de @{a@} + @{b@} é @{answer@}".format(answer=1+2, a=1, b=2)
'A soma de 1 + 2 é 3'
>>> "@{1@} espera a inquisição @{0@}!".format("espanhola", "Ninguém")
'Ninguém espera a inquisição espanhola!'
@end example

Veja @ref{13e2,,Sintaxe das strings de formato} para uma descrição das várias opções de formatação que podem ser especificadas em uma strings de formato.

@cartouche
@quotation Nota 
Ao formatar um número (@ref{257,,int}, @ref{2f7,,float}, @ref{2f8,,complex}, @ref{29d,,decimal.Decimal} e sub-classes) com o tipo @code{n} (ex: @code{'@{:n@}'.format(1234)}), a função define temporariamente a localidade @code{LC_CTYPE} para a localidade @code{LC_NUMERIC} a fim de decodificar campos @code{decimal_point} e @code{thousands_sep} de @code{localeconv()} se eles são caracteres não-ASCII ou maiores que 1 byte, e a localidade @code{LC_NUMERIC} é diferente da localidade @code{LC_CTYPE}. Esta mudança temporária afeta outras threads.
@end quotation
@end cartouche


Alterado na versão 3.7: Ao formatar um número com o tipo @code{n}, a função define temporariamente a localidade @code{LC_CTYPE} para a localidade @code{LC_NUMERIC} em alguns casos.

@end deffn

@geindex format_map() (método str)
@anchor{library/stdtypes str format_map}@anchor{e01}
@deffn {Método} str.format_map (mapping, /)

Semelhante a @code{str.format(**mapping)}, exceto pelo fato de que @code{mapping} é usado diretamente e não copiado para uma classe @ref{256,,dict}. Isso é útil se, por exemplo, @code{mapping} é uma subclasse de 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


Adicionado na versão 3.2.

@end deffn

@geindex index() (método str)
@anchor{library/stdtypes str index}@anchor{1733}
@deffn {Método} str.index (sub[, start[, end]])

Like @ref{ed7,,find()}, but raise @ref{202,,ValueError} when the substring is
not found. For example:

@example
>>> 'spam, spam, spam'.index('eggs')
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    'spam, spam, spam'.index('eggs')
    ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
ValueError: substring not found
@end example

See also @ref{1299,,rindex()}.
@end deffn

@geindex isalnum() (método str)
@anchor{library/stdtypes str isalnum}@anchor{2357}
@deffn {Método} str.isalnum ()

Retorna @code{True} se todos os caracteres na string são alfanuméricos e existe pelo menos um caractere, ou @code{False} caso contrário. Um caractere @code{c} é alfanumérico se um dos seguintes retorna @code{True}: @code{c.isalpha()}, @code{c.isdecimal()}, @code{c.isdigit()}, ou @code{c.isnumeric()}.
@end deffn

@geindex isalpha() (método str)
@anchor{library/stdtypes str isalpha}@anchor{2358}
@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/Unicode15.1.0/ch04.pdf}.
For example:

@example
>>> 'Letras e espaços'.isalpha()
False
>>> 'LetrasApenas'.isalpha()
True
>>> 'µ'.isalpha()  # Caracteres não-ASCII podem ser considerados alfabeticamente também
True
@end example

Consulte @ref{2359,,Propriedades Unicode}.
@end deffn

@geindex isascii() (método str)
@anchor{library/stdtypes str isascii}@anchor{b04}
@deffn {Método} str.isascii ()

Retorna @code{True} se a string é vazia ou se todos os caracteres na string são ASCII, @code{False} caso contrário. Caracteres ASCII têm pontos de código no intervalo U+0000-U+007F. Por exemplo:

@example
>>> 'Caracteres ASCII'.isascii()
True
>>> 'µ'.isascii()
False
@end example


Adicionado na versão 3.7.

@end deffn

@geindex isdecimal() (método str)
@anchor{library/stdtypes str isdecimal}@anchor{235a}
@deffn {Método} str.isdecimal ()

Retorna @code{True} se todos os caracteres na string são caracteres decimais e existe pelo menos um caractere, @code{False} caso contrário. Caracteres decimais são aqueles que podem ser usados para formar números na base 10, tal como U+0660, ou dígito zero para arábico-índico. Formalmente, um caractere decimal é um caractere em Unicode cuja categoria geral é “Nd”. Por exemplo:

@example
>>> '0123456789'.isdecimal()
True
>>> '٠١٢٣٤٥٦٧٨٩'.isdecimal()  # Dígitos árabe-índico zero até nove
True
>>> 'alfabético'.isdecimal()
False
@end example
@end deffn

@geindex isdigit() (método str)
@anchor{library/stdtypes str isdigit}@anchor{235b}
@deffn {Método} str.isdigit ()

Retorna @code{True} se todos os caracteres na string são dígitos e existe pelo menos um caractere, @code{False} caso contrário. Dígitos incluem caracteres decimais e dígitos que precisam de tratamento especial, tal como a compatibilidade com dígitos sobre-escritos. Isso inclui dígitos que não podem ser usados para formar números na base 10, como por exemplo os números de Kharosthi. Formalmente, um dígito é um caractere que tem a propriedade com valor Numeric_Type=Digit ou Numeric_Type=Decimal.
@end deffn

@geindex isidentifier() (método str)
@anchor{library/stdtypes str isidentifier}@anchor{1ad3}
@deffn {Método} str.isidentifier ()

Retorna @code{True} se a string é um identificador válido conforme a definição da linguagem, seção @ref{2021,,Identificadores e palavras-chave}.

@ref{235c,,keyword.iskeyword()} pode ser usada para testar se a string @code{s} é uma palavra reservada, tal como @ref{14a2,,def} e @ref{131a,,class}.

Exemplo:

@example
>>> from keyword import iskeyword

>>> 'olá.isidentifier(), iskeyword('olá')
(True, False)
>>> 'def'.isidentifier(), iskeyword('def')
(True, True)
@end example
@end deffn

@geindex islower() (método str)
@anchor{library/stdtypes str islower}@anchor{235d}
@deffn {Método} str.islower ()

Retorna @code{True} se todos os caracteres em caixa (que possuem maiúsculo e minúsculo) @footnote{
Caracteres que possuem maiúsculo e minúsculo são aqueles com a propriedade de categoria geral igual a “Lu” (Letra, maiúscula), “Ll” (Letra, minúscula), ou “Lt” (Letra, em formato de título).
} na string são minúsculos e existe pelo menos um caractere em caixa, @code{False} caso contrário.
@end deffn

@geindex isnumeric() (método str)
@anchor{library/stdtypes str isnumeric}@anchor{235e}
@deffn {Método} str.isnumeric ()

Return @code{True} if all characters in the string are numeric
characters, and there is at least one character, @code{False}
otherwise. Numeric characters include digit characters, and all characters
that have the Unicode numeric value property, e.g. U+2155,
VULGAR FRACTION ONE FIFTH.  Formally, numeric characters are those with the property
value Numeric_Type=Digit, Numeric_Type=Decimal or Numeric_Type=Numeric.
For example:

@example
>>> '0123456789'.isnumeric()
True
>>> '٠١٢٣٤٥٦٧٨٩'.isnumeric()  # Arabic-indic digit zero to nine
True
>>> '⅕'.isnumeric()  # Vulgar fraction one fifth
True
>>> '²'.isdecimal(), '²'.isdigit(),  '²'.isnumeric()
(False, True, True)
@end example

See also @ref{235a,,isdecimal()} and @ref{235b,,isdigit()}. Numeric characters are
a superset of decimal numbers.
@end deffn

@geindex isprintable() (método str)
@anchor{library/stdtypes str isprintable}@anchor{e02}
@deffn {Método} str.isprintable ()

Retorna @code{True} se todos os caracteres na string forem imprimíveis, @code{False} se contiver pelo menos um caractere não imprimível.

Aqui, “imprimíveis” significa que o caractere é adequado para @ref{800,,repr()} usar em sua saída; “não imprimível” significa que @ref{800,,repr()} em tipos embutidos fará o escape hexadecimal do caractere. Não tem relação com o tratamento de strings escritas em @ref{ae6,,sys.stdout} ou @ref{940,,sys.stderr}.

Os caracteres imprimíveis são aqueles que no banco de dados de caracteres Unicode (veja @ref{105,,unicodedata}) têm uma categoria geral no grupo Letra, Marca, Número, Pontuação ou Símbolo (L, M, N, P ou S); mais o espaço ASCII 0x20. Caracteres não imprimíveis são aqueles no grupo Separador ou Outro (Z ou C), exceto o espaço ASCII.

Por exemplo:

@example
>>> '@w{'}.isprintable(), ' '.isprintable()
(True, True)
>>> '\t'.isprintable(), '\n'.isprintable()
(False, False)
@end example
@end deffn

@geindex isspace() (método str)
@anchor{library/stdtypes str isspace}@anchor{235f}
@deffn {Método} str.isspace ()

Retorna @code{True} se existem apenas caracteres de espaço em branco na string e existe pelo menos um caractere, @code{False} caso contrário.

Um caractere é `espaço em branco' se no banco de dados de caracteres Unicode (veja @ref{105,,unicodedata}), ou pertence a categoria geral @code{Zs} (“Separador, espaço”), ou sua classe bidirecional é @code{WS}, @code{B} ou @code{S}.
@end deffn

@geindex istitle() (método str)
@anchor{library/stdtypes str istitle}@anchor{2360}
@deffn {Método} str.istitle ()

Retorna @code{True} se a string é titlecased e existe pelo menos um caractere, por exemplo caracteres maiúsculos somente podem proceder caracteres que não diferenciam maiúsculas/minúsculas, e caracteres minúsculos somente podem proceder caracteres que permitem ambos. Retorna @code{False} caso contrário.

Por exemplo:

@example
>>> 'Spam, Spam, Spam'.istitle()
True
>>> 'spam, spam, spam'.istitle()
False
>>> 'SPAM, SPAM, SPAM'.istitle()
False
@end example

Veja também @ref{2361,,title()}.
@end deffn

@geindex isupper() (método str)
@anchor{library/stdtypes str isupper}@anchor{2362}
@deffn {Método} str.isupper ()

Retorna @code{True} se todos os caracteres que permitem maiúsculas ou minúsculas @footnote{
Caracteres que possuem maiúsculo e minúsculo são aqueles com a propriedade de categoria geral igual a “Lu” (Letra, maiúscula), “Ll” (Letra, minúscula), ou “Lt” (Letra, em formato de título).
} na string estão com letras maiúsculas, e existe pelo menos um caractere maiúsculo, @code{False} caso contrário.

@example
>>> 'BANANA'.isupper()
True
>>> 'banana'.isupper()
False
>>> 'baNana'.isupper()
False
>>> ' '.isupper()
False
@end example
@end deffn

@geindex join() (método str)
@anchor{library/stdtypes meth-str-join}@anchor{2363}@anchor{library/stdtypes str join}@anchor{2340}
@deffn {Método} str.join (iterable, /)

Retorna a string que é a concatenação das strings no `iterável'. Uma @ref{2c3,,TypeError} será levantada se existirem quaisquer valores que não sejam strings no `iterável', incluindo objetos @ref{1c2,,bytes}. O separador entre elementos é a string que está fornecendo este método. Por exemplo:

@example
>>> ', '.join(['spam', 'spam', 'spam'])
'spam, spam, spam'
>>> '-'.join('Python')
'P-y-t-h-o-n'
@end example

Veja também @ref{ed9,,split()}.
@end deffn

@geindex ljust() (método str)
@anchor{library/stdtypes str ljust}@anchor{1e02}
@deffn {Método} str.ljust (width, fillchar=' ', /)

Retorna a string alinhada a esquerda em uma string de comprimento `width'. Preenchimento é feito usando `fillchar' que for especificado (o padrão é o caractere ASCII de espaço). A string original é retornada se `width' é menor ou igual que @code{len(s)}.

Por exemplo:

@example
>>> 'Python'.ljust(10)
'Python    '
>>> 'Python'.ljust(10, '.')
'Python....'
>>> 'Monty Python'.ljust(10, '.')
'Monty Python'
@end example

See also @ref{1e01,,rjust()}.
@end deffn

@geindex lower() (método str)
@anchor{library/stdtypes str lower}@anchor{1901}
@deffn {Método} str.lower ()

Return a copy of the string with all the cased characters @footnote{
Caracteres que possuem maiúsculo e minúsculo são aqueles com a propriedade de categoria geral igual a “Lu” (Letra, maiúscula), “Ll” (Letra, minúscula), ou “Lt” (Letra, em formato de título).
} converted to
lowercase. For example:

@example
>>> 'Lower Method Example'.lower()
'lower method example'
@end example

O algoritmo de letras minúsculas está descrito na seção 3.13 'Default Case Folding' do Padrão Unicode@footnote{https://www.unicode.org/versions/Unicode15.1.0/ch03.pdf}.
@end deffn

@geindex lstrip() (método str)
@anchor{library/stdtypes str lstrip}@anchor{14f8}
@deffn {Método} str.lstrip (chars=None, /)

Retorna uma cópia da string com caracteres iniciais removidos. O argumento `chars' é uma string que especifica o conjunto de caracteres a serem removidos. Se for omitido ou se for @code{None}, o argumento `chars' será considerado como espaço em branco por padrão para a remoção. O argumento `chars' não é um prefixo; ao invés disso, todas as combinações dos seus valores são removidas:

@example
>>> '   spacious   '.lstrip()
'spacious   '
>>> 'www.example.com'.lstrip('cmowz.')
'example.com'
@end example

Consulte @ref{8d5,,str.removeprefix()} para um método que removerá uma única string de prefixo em vez de todo um conjunto de caracteres. Por exemplo:

@example
>>> 'Arthur: three!'.lstrip('Arthur: ')
'ee!'
>>> 'Arthur: three!'.removeprefix('Arthur: ')
'three!'
@end example
@end deffn

@geindex maketrans() (método estático str)
@anchor{library/stdtypes str maketrans}@anchor{e03}
@deffn {Método} static str.maketrans (dict, /)

@deffnx {Método} static str.maketrans (from, to, remove='@w{'}, /)

Este método estático retorna uma tabela de tradução usável para @ref{2364,,str.translate()}.

Se existe apenas um argumento, ele deve ser um dicionário mapeando números Unicode (inteiros) ou caracteres (strings de comprimento 1) para números Unicode, strings (de comprimento arbitrário) ou @code{None}. Caracteres chave serão então convertidos para números ordinais.

Se existirem dois argumentos, eles devem ser strings de igual comprimento, e no dicionário resultante, cada caractere em `from' será mapeado para o caractere na mesma posição em `to'. Se existir um terceiro argumento, ele deve ser uma string, cujos caracteres serão mapeados para @code{None} no resultado.
@end deffn

@geindex partition() (método str)
@anchor{library/stdtypes str partition}@anchor{eda}
@deffn {Método} str.partition (sep, /)

Quebra a string na primeira ocorrência de `sep', e retorna uma tupla com 3 elementos contendo a parte antes do separador, o próprio separador, e a parte após o separador. Se o separador não for encontrado, retorna uma tupla com 3 elementos contendo a string, seguido de duas strings vazias.
@end deffn

@geindex removeprefix() (método str)
@anchor{library/stdtypes str removeprefix}@anchor{8d5}
@deffn {Método} str.removeprefix (prefix, /)

If the string starts with the `prefix' string, return
@code{string[len(prefix):]}. Otherwise, return a copy of the original
string:

@example
>>> 'TestHook'.removeprefix('Test')
'Hook'
>>> 'BaseTestCase'.removeprefix('Test')
'BaseTestCase'
@end example


Adicionado na versão 3.9.


See also @ref{8d6,,removesuffix()} and @ref{efa,,startswith()}.
@end deffn

@geindex removesuffix() (método str)
@anchor{library/stdtypes str removesuffix}@anchor{8d6}
@deffn {Método} str.removesuffix (suffix, /)

If the string ends with the `suffix' string and that `suffix' is not empty,
return @code{string[:-len(suffix)]}. Otherwise, return a copy of the
original string:

@example
>>> 'MiscTests'.removesuffix('Tests')
'Misc'
>>> 'TmpDirMixin'.removesuffix('Tests')
'TmpDirMixin'
@end example


Adicionado na versão 3.9.


See also @ref{8d5,,removeprefix()} and @ref{efb,,endswith()}.
@end deffn

@geindex replace() (método str)
@anchor{library/stdtypes str replace}@anchor{19a}
@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.
For example:

@example
>>> 'spam, spam, spam'.replace('spam', 'eggs')
'eggs, eggs, eggs'
>>> 'spam, spam, spam'.replace('spam', 'eggs', 1)
'eggs, spam, spam'
@end example


Alterado na versão 3.13: `count' agora é suportado como um argumento nomeado.

@end deffn

@geindex rfind() (método str)
@anchor{library/stdtypes str rfind}@anchor{ed8}
@deffn {Método} str.rfind (sub[, start[, end]])

Return the highest index in the string where substring `sub' is found, such
that `sub' is contained within @code{s[start:end]}.  Optional arguments `start'
and `end' are interpreted as in slice notation.  Return @code{-1} on failure.
For example:

@example
>>> 'spam, spam, spam'.rfind('sp')
12
>>> 'spam, spam, spam'.rfind('sp', 0, 10)
6
@end example

See also @ref{ed7,,find()} and @ref{1299,,rindex()}.
@end deffn

@geindex rindex() (método str)
@anchor{library/stdtypes str rindex}@anchor{1299}
@deffn {Método} str.rindex (sub[, start[, end]])

Similar a @ref{ed8,,rfind()} mas levanta um @ref{202,,ValueError} quando a substring `sub' não é encontrada.
@end deffn

@geindex rjust() (método str)
@anchor{library/stdtypes str rjust}@anchor{1e01}
@deffn {Método} str.rjust (width, fillchar=' ', /)

Retorna a string alinhada à direita em uma string de comprimento `width'. Preenchimento é feito usando o caractere `fillchar' especificado (o padrão é um caractere de espaço ASCII). A string original é retornada se `width' é menor que ou igual a @code{len(s)}.
@end deffn

@geindex rpartition() (método str)
@anchor{library/stdtypes str rpartition}@anchor{129a}
@deffn {Método} str.rpartition (sep, /)

Quebra a string na última ocorrência de `sep', e retorna uma tupla com 3 elementos contendo a parte antes do separador, o próprio separador, e a parte após o separador. Se o separador não for encontrado, retorna uma tupla com 3 elementos contendo duas strings vazias, seguido da própria string original.

Por exemplo:

@example
>>> 'Monty Python'.rpartition(' ')
('Monty', ' ', 'Python')
>>> "Monty Python's Flying Circus".rpartition(' ')
("Monty Python's Flying", ' ', 'Circus')
>>> 'Monty Python'.rpartition('-')
('@w{'}, '@w{'}, 'Monty Python')
@end example

See also @ref{eda,,partition()}.
@end deffn

@geindex rsplit() (método str)
@anchor{library/stdtypes str rsplit}@anchor{1297}
@deffn {Método} str.rsplit (sep=None, maxsplit=-1)

Retorna uma lista de palavras na string, usando `sep' como a string delimitadora. Se `maxsplit' é fornecido, no máximo `maxsplit' cortes são feitos, sendo estes mais `à direita'. Se `sep' não foi especificado ou @code{None} foi informado, qualquer string de espaço em branco é um separador. Exceto pelo fato de separar pela direita, @ref{1297,,rsplit()} se comporta como @ref{ed9,,split()}, o qual é descrito em detalhes abaixo.
@end deffn

@geindex rstrip() (método str)
@anchor{library/stdtypes str rstrip}@anchor{14f9}
@deffn {Método} str.rstrip (chars=None, /)

Retorna uma cópia da string com caracteres no final removidos. O argumento `chars' é uma string que especifica o conjunto de caracteres para serem removidos. Se omitidos ou tiver o valor @code{None}, o argumento `chars' considera como padrão a remoção dos espaços em branco. O argumento `chars' não é um sufixo; ao invés disso, todas as combinações dos seus valores são removidas:

@example
>>> '   spacious   '.rstrip()
'   spacious'
>>> 'mississippi'.rstrip('ipz')
'mississ'
@end example

Consulte @ref{8d6,,str.removesuffix()} para um método que removerá uma única string de sufixo em vez de todo um conjunto de caracteres. Por exemplo:

@example
>>> 'Monty Python'.rstrip(' Python')
'M'
>>> 'Monty Python'.removesuffix(' Python')
'Monty'
@end example
@end deffn

@geindex split() (método str)
@anchor{library/stdtypes str split}@anchor{ed9}
@deffn {Método} str.split (sep=None, maxsplit=-1)

Retorna uma lista de palavras na string, usando `sep' como a string delimitadora. Se `maxsplit' é fornecido, no máximo `maxsplit' cortes são feitos (portando, a lista terá no máximo @code{maxsplit+1} elementos). Se `maxsplit' não foi especificado ou @code{-1} foi informado, então não existe limite no número de cortes (todos os cortes possíveis são realizados).

Se `sep' é fornecido, delimitadores consecutivos não são agrupados juntos e eles são destinados para delimitar strings vazias (por exemplo, @code{'1,,2'.split(',')} retorna @code{['1', '@w{'}, '2']}). O argumento `sep' pode consistir em vários caracteres como um único delimitador (para separar com vários delimitadores, use @ref{2a2,,re.split()}). Separar uma string vazia com um separador especificado retorna @code{['@w{'}]}.

Por exemplo:

@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

Se `sep' não for especificado ou for @code{None}, um algoritmo diferente de separação é aplicado: ocorrências consecutivas de espaços em branco são consideradas como um separador único, e o resultado não conterá strings vazias no início ou no final, se a string tiver espaços em branco no início ou no final. Consequentemente, separar uma string vazia ou uma string que consiste apenas de espaços em branco com o separador @code{None}, retorna @code{[]}.

Por exemplo:

@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

Se `sep' não for especificado ou for @code{None} e `maxsplit' for @code{0}, somente as sequências iniciais de espaços em branco consecutivos serão consideradas.

Por exemplo:

@example
>>> "".split(None, 0)
[]
>>> "   ".split(None, 0)
[]
>>> "   foo   ".split(maxsplit=0)
['foo   ']
@end example

Veja também @ref{2340,,join()}.
@end deffn

@geindex novas linhas universais;método str.splitlines

@geindex splitlines() (método str)
@anchor{library/stdtypes str splitlines}@anchor{1298}
@deffn {Método} str.splitlines (keepends=False)

Retorna uma lista das linhas na string, quebrando a mesma nas fronteiras de cada linha. Quebras de linhas não são incluídas na lista resultante a não ser que `keepends' seja fornecido e seja verdadeiro.

Este método divide nos seguintes limites das linhas. Em particular, os limites são um superconjunto de @ref{d5c,,novas linhas universais}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Representação

@tab

Descrição

@item

@code{\n}

@tab

Feed de linha

@item

@code{\r}

@tab

Retorno de Carro

@item

@code{\r\n}

@tab

Retorno do Carro + Feed da Linha

@item

@code{\v} ou @code{\x0b}

@tab

Tabulação de Linha

@item

@code{\f} ou @code{\x0c}

@tab

Formulário de Feed

@item

@code{\x1c}

@tab

Separador de Arquivos

@item

@code{\x1d}

@tab

Separador de Grupo

@item

@code{\x1e}

@tab

Separador de Registro

@item

@code{\x85}

@tab

Próxima Linha (C1 Control Code)

@item

@code{\u2028}

@tab

Separador de Linha

@item

@code{\u2029}

@tab

Separador de Parágrafo

@end multitable



Alterado na versão 3.2: @code{\v} e @code{\f} adicionado à lista de limites de linha.


Por exemplo:

@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

Ao contrário do método @ref{ed9,,split()} quando um delimitador de String `sep' é fornecido, este método retorna uma lista vazia para a uma String vazia e uma quebra de linha de terminal não resulta numa linha extra:

@example
>>> "".splitlines()
[]
>>> "Uma linha\n".splitlines()
['Uma linha']
@end example

Para comparação, temos @code{split('\n')}:

@example
>>> '@w{'}.split('\n')
['@w{'}]
>>> 'Duas linhas\n'.split('\n')
['Duas linhas', '@w{'}]
@end example
@end deffn

@geindex startswith() (método str)
@anchor{library/stdtypes str startswith}@anchor{efa}
@deffn {Método} str.startswith (prefix[, start[, end]])

Retorne @code{True} se a String começar com o `prefixo', caso contrário, retorna @code{False}. `prefixo' também pode ser uma tupla de prefixos a serem procurados. Com `start' opcional, a String de teste começa nessa posição. Com `fim' opcional, interrompe a comparação de String nessa posição.
@end deffn

@geindex strip() (método str)
@anchor{library/stdtypes str strip}@anchor{14f7}
@deffn {Método} str.strip (chars=None, /)

Retorna uma cópia da string com caracteres no início e no final removidos. O argumento `chars' é uma string que especifica o conjunto de caracteres a serem removidos. Se for omitido ou for @code{None}, o argumento `chars' irá remover por padrão os caracteres em branco. O argumento `chars' não é um prefixo, nem um sufixo; ao contrário disso, todas as combinações dos seus seus valores são removidas:

@example
>>> '   spacious   '.strip()
'spacious'
>>> 'www.example.com'.strip('cmowz.')
'example'
@end example

Os valores do argumento `chars' são removidos dos extremos inicial e final da string. Caracteres são removidos do extremo inicial até atingir um caractere da string que não está contido no conjunto de caracteres em `chars'. Uma ação similar acontece no extremo final da string. Por exemplo:

@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 str)
@anchor{library/stdtypes str swapcase}@anchor{2365}
@deffn {Método} str.swapcase ()

Retorna uma cópia da string com caracteres maiúsculos convertidos para minúsculos e vice-versa. Perceba que não é necessariamente verdade que @code{s.swapcase().swapcase() == s}.
@end deffn

@geindex title() (método str)
@anchor{library/stdtypes str title}@anchor{2361}
@deffn {Método} str.title ()

Retorna uma versão titlecased da string, onde palavras iniciam com um caractere com letra maiúscula e os caracteres restantes são em letras minúsculas.

Por exemplo:

@example
>>> 'Olá mundo'.title()
'Olá mundo'
@end example

O algoritmo usa uma definição simples independente de idioma para uma palavra, como grupos de letras consecutivas. A definição funciona em muitos contextos, mas isso significa que apóstrofes em contrações e possessivos formam limites de palavras, os quais podem não ser o resultado desejado:

@example
>>> "a caixa d'água do joe's bar está vazia".title()
"A Caixa D'Água Do Joe'S Bar Está Vazia"
@end example

A função @ref{2366,,string.capwords()} não tem esse problema, pois ela divide palavras apenas em espaços.

Alternativamente, uma solução alternativa para os apóstrofes pode ser construída usando expressões 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("o joe's bar está aberto")
"O Joe's Bar Está Aberto"
@end example

Veja também @ref{2360,,istitle()}.
@end deffn

@geindex translate() (método str)
@anchor{library/stdtypes str translate}@anchor{2364}
@deffn {Método} str.translate (table, /)

Retorna uma cópia da string na qual cada caractere foi mapeado através da tabela de tradução fornecida. A tabela deve ser um objeto que implementa indexação através de @ref{283,,__getitem__()}, tipicamente um @ref{11fb,,mapeamento} ou uma @ref{4f1,,sequência}. Quando indexada por um ordinal unicode (um inteiro), o objeto tabela pode fazer qualquer uma das seguintes ações: retornar um ordinal unicode ou uma string, para mapear o caractere para um ou mais caracteres; retornar @code{None}, para deletar o caractere da string de retorno; ou levantar uma exceção @ref{2367,,LookupError}, para mapear o caractere para si mesmo.

Você pode usar @ref{e03,,str.maketrans()} para criar um mapa de tradução com mapeamentos caractere para caractere em diferentes formatos.

Veja também o módulo @ref{1b,,codecs} para uma abordagem mais flexível para mapeamento de caractere customizado.
@end deffn

@geindex upper() (método str)
@anchor{library/stdtypes str upper}@anchor{2368}
@deffn {Método} str.upper ()

Retorna uma cópia da string com todos os caracteres que permitem maiúsculo e minúsculo @footnote{
Caracteres que possuem maiúsculo e minúsculo são aqueles com a propriedade de categoria geral igual a “Lu” (Letra, maiúscula), “Ll” (Letra, minúscula), ou “Lt” (Letra, em formato de título).
} convertidos para letras maiúsculas. Perceba que @code{s.upper().isupper()} pode ser @code{False} se @code{s} contiver caracteres que não possuem maiúsculas e minúsculas, ou se a categoria Unicode do(s) caractere(s) resultante(s) não for “Lu” (Letra maiúscula), mas por ex “Lt” (Letra em titlecase).

O algoritmo de letras maiúsculas está descrito na seção 3.13 'Default Case Folding' do Padrão Unicode@footnote{https://www.unicode.org/versions/Unicode15.1.0/ch03.pdf}.
@end deffn

@geindex zfill() (método str)
@anchor{library/stdtypes str zfill}@anchor{14fa}
@deffn {Método} str.zfill (width, /)

Retorna uma cópia da String deixada preenchida com dígitos ASCII @code{'0'} para fazer uma string de comprimento `width'. Um prefixo sinalizador principal (@code{'+'}/@code{'-'}) será tratado inserindo o preenchimento `após' o caractere de sinal em vez de antes. A String original será retornada se o `width' for menor ou igual a @code{len(s)}.

Por exemplo:

@example
>>> "42".zfill(5)
'00042'
>>> "-42".zfill(5)
'-0042'
@end example
@end deffn

@geindex literal de string formatada com !
@geindex literais de string formatadas
@geindex ! f-string
@geindex f-strings
@geindex fstring
@geindex literal de string interpolada
@geindex string;literal formatado
@geindex string;literal interpolado
@geindex @{@} (chaves);em literal de string formatado
@geindex ! (ponto de exclamação);em literal de string formatado
@geindex ; (dois pontos);em literal de string formatado
@geindex = (igual);para ajudar na depuração usando literais de string

@node Strings literais formatadas f-strings,Formatação de string no estilo printf,String Methods<2>,Tipo sequência de texto — str
@anchor{library/stdtypes formatted-string-literals-f-strings}@anchor{2369}
@subsubsection Strings literais formatadas (f-strings)



Adicionado na versão 3.6.



Alterado na versão 3.7: @ref{1b9,,await} e @ref{aba,,async for} podem ser usados em expressões dentro de f-strings.



Alterado na versão 3.8: Adicionado o operador de depuração (@code{=})



Alterado na versão 3.12: Muitas restrições a expressões dentro de f-strings foram removidas. Notavelmente, strings aninhadas, comentários e contrabarras agora são permitidos.


Uma `f-string' (formalmente uma `literal de string formatada') é uma literal de string prefixada com @code{f} ou @code{F}. Esse tipo de literal de string permite incorporar expressões Python arbitrárias dentro de `campos de substituição', delimitados por chaves (@code{@{@}}). Essas expressões são avaliadas em tempo de execução, de forma semelhante a @ref{621,,str.format()}, e convertidas em objetos @ref{44c,,str} regulares. Por exemplo:

@example
>>> who = 'Ninguém'
>>> nationality = 'Espanhola'
>>> f'@{who.title()@} está à espera da Inquisição @{nationality@}!'
'Ninguém está à espera da Inquisição Espanhola!'
@end example

Também é possível usar uma f-string de várias linhas:

@example
>>> f'@w{'}'Esta é uma string
... em duas linhas'@w{'}'
'Esta é uma string\nem duas linhas'
@end example

Uma única chave de abertura, @code{'@{'}, marca um `campo de substituição' que pode conter qualquer expressão Python:

@example
>>> nationality = 'Espanhola'
>>> f'A Inquisição @{nationality@}!'
'A Inquisição Espanhola!'
@end example

Para incluir um literal @code{@{} ou @code{@}}, use chaves duplas:

@example
>>> x = 42
>>> f'@{@{x@}@} is @{x@}'
'@{x@} is 42'
@end example

Funções também podem ser usadas, como @ref{13e2,,especificadores de formato}:

@example
>>> from math import sqrt
>>> f'√2 \N@{ALMOST EQUAL TO@} @{sqrt(2):.5f@}'
'√2 ≈ 1.41421'
@end example

Qualquer expressão que não seja string é convertida usando @ref{44c,,str()}, por padrão:

@example
>>> from fractions import Fraction
>>> f'@{Fraction(1, 3)@}'
'1/3'
@end example

Para usar uma conversão explícita, use o operador @code{!} (ponto de exclamação), seguido por qualquer um dos formatos válidos, que são:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Conversão

@tab

Significado

@item

@code{!a}

@tab

@ref{142d,,ascii()}

@item

@code{!r}

@tab

@ref{800,,repr()}

@item

@code{!s}

@tab

@ref{44c,,str()}

@end multitable


Por exemplo:

@example
>>> from fractions import Fraction
>>> f'@{Fraction(1, 3)!s@}'
'1/3'
>>> f'@{Fraction(1, 3)!r@}'
'Fraction(1, 3)'
>>> question = '¿Dónde está el Presidente?'
>>> print(f'@{question!a@}')
'\xbfD\xf3nde est\xe1 el Presidente?'
@end example

Durante a depuração, pode ser útil visualizar tanto a expressão quanto seu valor, usando o sinal de igual (@code{=}) após a expressão. Isso preserva os espaços entre chaves e pode ser usado com um conversor. Por padrão, o operador de depuração usa a conversão @ref{800,,repr()} (@code{!r}). Por exemplo:

@example
>>> from fractions import Fraction
>>> calculation = Fraction(1, 3)
>>> f'@{calculation=@}'
'calculation=Fraction(1, 3)'
>>> f'@{calculation = @}'
'calculation = Fraction(1, 3)'
>>> f'@{calculation = !s@}'
'calculation = 1/3'
@end example

Após a avaliação da saída, ela pode ser formatada usando um @ref{13e2,,especificador de formato} seguido de dois pontos (@code{':'}). Após a avaliação da expressão e sua possível conversão para uma string, o método @code{__format__()} do resultado é chamado com o especificador de formato, ou a string vazia, caso nenhum especificador de formato seja fornecido. O resultado formatado é então usado como o valor final para o campo de substituição. Por exemplo:

@example
>>> from fractions import Fraction
>>> f'@{Fraction(1, 7):.6f@}'
'0.142857'
>>> f'@{Fraction(1, 7):_^+10@}'
'___+1/7___'
@end example

@node Formatação de string no estilo printf,,Strings literais formatadas f-strings,Tipo sequência de texto — str
@anchor{library/stdtypes old-string-formatting}@anchor{6cc}@anchor{library/stdtypes printf-style-string-formatting}@anchor{236a}
@subsubsection Formatação de string no estilo @code{printf}


@geindex formatação@comma{} string (%)
@geindex interpolação@comma{} string (%)
@geindex string;formatação@comma{} printf
@geindex string;interpolação@comma{} printf
@geindex printf@comma{} estilo de formatação
@geindex sprintf@comma{} estilo de formatação
@geindex % (porcentagem);printf@comma{} estilo de formatação

@cartouche
@quotation Nota 
As operações de formatação descritas aqui exibem uma variedade de peculiaridades que levam a diversos erros comuns (tais como não conseguir exibir tuplas e dicionários corretamente). Usar o novo @ref{9b1,,formatador de string literal (f-strings)}, a interface @ref{621,,str.format()}, ou @ref{236b,,templates de strings} pode ajudar a evitar esses erros. Cada uma dessas alternativas fornece seus próprios custos e benefícios de simplicidade, flexibilidade, e/ou extensibilidade.
@end quotation
@end cartouche

Os objetos string possuem um único operador embutido: o operador @code{%} (módulo). O mesmo também é conhecido como o operador de `formatação' ou `interpolação'. Dado @code{format % values} (onde `format' é uma string), as especificações de conversão @code{%} em `format' são substituídas por zero ou mais elementos de `values'. O efeito é semelhante ao uso da função @code{sprintf()} na linguagem C. Por exemplo:

@example
>>> print('%s tem %d tipos de aspas.' % ('Python', 2))
Python tem 2 tipos de aspas.
@end example

Se `format' precisar de um único operador, `valores' podem ser objetos simples ou que não sejam uma tupla. @footnote{
Para formatar apenas uma tupla, você deve portanto fornecer uma tupla com apenas um elemento, que é a tupla a ser formatada.
} Caso contrário, `valores' precisarão ser uma tupla com exatamente o número de itens especificados pela string de formatação, ou um único mapa de objetos (por exemplo, um dicionário).

@geindex () (parênteses);em formatação no estilo printf
@geindex * (asterisco);em formatação no estilo printf
@geindex . (ponto);em formatação no estilo printf

Um especificador de conversão contém dois ou mais caracteres e tem os seguintes componentes, que devem aparecer nesta ordem:


@enumerate 

@item 
O caractere @code{'%'}, que determina o início do especificador.

@item 
Mapeamento de chaves (opcional), consistindo de uma sequência entre parênteses de caracteres (por exemplo, @code{(algumnome)}).

@item 
Flags de conversão (opcional), que afetam o resultado de alguns tipos de conversão.

@item 
Largura mínima do campo (opcional). Se for especificado como um @code{'*'} (asterisco), a largura real será lida a partir do próximo elemento da tupla em `values' e o objeto a converter virá após a largura mínima do campo e a precisão que é opcional.

@item 
Precisão (opcional), fornecido como uma @code{'.'} (ponto) seguido pela precisão. Se determinado como um @code{'*'} (um asterisco), a precisão real será lida a partir do próximo elemento da tupla em `values', e o valor a converter virá após a precisão.

@item 
Modificador de comprimento (opcional).

@item 
Tipo de conversão.
@end enumerate

Quando o argumento certo for um dicionário (ou outro tipo de mapeamento), então os formatos na string `deverão' incluir uma chave de mapeamento entre parênteses nesse dicionário inserido imediatamente após o caractere @code{'%'}. A key de mapeamento seleciona o valor a ser formatado a partir do mapeamento. Por exemplo:

@example
>>> print('%(language)s has %(number)03d quote types.' %
...       @{'language': "Python", "number": 2@})
Python has 002 quote types.
@end example

Nesse caso, nenhum especificador @code{*} poderá ocorrer num formato (uma vez que eles exigem uma lista de parâmetros sequenciais).

Os caracteres flags de conversão são:

@geindex # (cerquilha);em formatação no estilo printf
@geindex - (menos);em formatação no estilo printf
@geindex + (mais);em formatação no estilo printf
@geindex espaço;em formatação no estilo printf


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@item

@code{'#'}

@tab

A conversão de valor usará o “formulário alternativo” (conforme definido abaixo).

@item

@code{'0'}

@tab

A conversão será preenchida por zeros para valores numéricos.

@item

@code{'-'}

@tab

O valor convertido será ajustado à esquerda (substitui a conversão @code{'0'} se ambos forem fornecidos).

@item

@code{' '}

@tab

(um espaço) Um espaço em branco deverá ser deixado antes de um número positivo (ou uma string vazia) produzido por uma conversão assinada.

@item

@code{'+'}

@tab

Um sinal de caractere (@code{'+'} ou @code{'-'}) precederá a conversão (substituindo o sinalizador de “espaço”).

@end multitable


Um modificador de comprimento (@code{h}, @code{l}, ou @code{L}) pode estar presente, mas será ignorado, pois o mesmo não é necessário para o Python – então, por exemplo, @code{%ld} é idêntico a @code{%d}.

Os tipos de conversão são:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Conversão

@tab

Significado

@tab

Notas

@item

@code{'d'}

@tab

Número decimal inteiro sinalizador.

@tab

@item

@code{'i'}

@tab

Número decimal inteiro sinalizador.

@tab

@item

@code{'o'}

@tab

Valor octal sinalizador.

@tab

(1)

@item

@code{'u'}

@tab

Tipo obsoleto – é idêntico a @code{'d'}.

@tab

(6)

@item

@code{'x'}

@tab

Hexadecimal com sinal (minúsculo).

@tab

(2)

@item

@code{'X'}

@tab

Hexadecimal com sinal (maiúsculo).

@tab

(2)

@item

@code{'e'}

@tab

Formato exponencial de ponto flutuante (minúsculo).

@tab

(3)

@item

@code{'E'}

@tab

Formato exponencial de ponto flutuante (maiúsculo).

@tab

(3)

@item

@code{'f'}

@tab

Formato decimal de ponto flutuante.

@tab

(3)

@item

@code{'F'}

@tab

Formato decimal de ponto flutuante.

@tab

(3)

@item

@code{'g'}

@tab

O formato de ponto flutuante. Usa o formato exponencial em minúsculo se o expoente for inferior a -4 ou não inferior a precisão, formato decimal, caso contrário.

@tab

(4)

@item

@code{'G'}

@tab

Formato de ponto flutuante. Usa o formato exponencial em maiúsculo se o expoente for inferior a -4 ou não inferior que a precisão, formato decimal, caso contrário.

@tab

(4)

@item

@code{'c'}

@tab

Caractere único (aceita inteiro ou um único caractere string).

@tab

@item

@code{'r'}

@tab

String (converte qualquer objeto Python usando a função @ref{800,,repr()}).

@tab

(5)

@item

@code{'s'}

@tab

String (converte qualquer objeto Python usando a função @ref{44c,,str()}).

@tab

(5)

@item

@code{'a'}

@tab

String (converte qualquer objeto Python usando a função @ref{142d,,ascii()}).

@tab

(5)

@item

@code{'%'}

@tab

Nenhum argumento é convertido, resultando em um caractere @code{'%'} no resultado.

@tab

@end multitable


Notas:


@enumerate 

@item 
A forma alternativa faz com que um especificador octal principal (@code{'0o'}) seja inserido antes do primeiro dígito.

@item 
O formato alternativo produz um @code{'0x'} ou @code{'0X'} (dependendo se o formato @code{'x'} or @code{'X'} foi usado) para ser inserido antes do primeiro dígito.

@item 
A forma alternativa faz com que o resultado sempre contenha um ponto decimal, mesmo que nenhum dígito o siga.

A precisão determina o número de dígitos após o ponto decimal e o padrão é 6.

@item 
A forma alternativa faz com que o resultado sempre contenha um ponto decimal e os zeros à direita não sejam removidos, como de outra forma seriam.

A precisão determina o número de dígitos significativos antes e depois do ponto decimal e o padrão seja 6.

@item 
Se a precisão for @code{N}, a saída será truncada em @code{N} caracteres.

@item 
Veja 
@geindex Propostas de Melhorias do Python; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}.
@end enumerate

Como as strings no Python possuem comprimento explícito, conversões de @code{%s} não presumem que @code{'\0'} seja o fim da string.

@c XXX Examples?


Alterado na versão 3.1: @code{%f} as conversões para números cujo valor absoluto é superior a 1e50 não são mais substituídas pela conversão @code{%g}.


@geindex protocolo de buffer;tipos de sequência binária

@node Tipos de sequência binária — bytes bytearray memoryview,Tipo conjuntos — set frozenset,Tipo sequência de texto — str,Tipos embutidos
@anchor{library/stdtypes binary-sequence-types-bytes-bytearray-memoryview}@anchor{236c}@anchor{library/stdtypes binaryseq}@anchor{22f9}
@subsection Tipos de sequência binária — @code{bytes}, @code{bytearray}, @code{memoryview}


@geindex objeto;bytes
@geindex objeto;bytearray
@geindex objeto;memoryview
@geindex módulo;array

Os principais tipos embutidos para manipular dados binários são @ref{1c2,,bytes} e @ref{2ea,,bytearray}. Eles são suportados por @ref{2eb,,memoryview} a qual usa o @ref{2e8,,protocolo buffer} para acessar a memória de outros objetos binários sem precisar fazer uma cópia.

O módulo @ref{7,,array} provê suporte a um armazenamento eficiente de tipos de dados básicos como inteiros de 32 bits e valores de ponto flutuante com precisão dupla IEEE754.

@menu
* Objetos bytes:: 
* Objetos Bytearray:: 
* Operações com Bytes e Bytearray:: 
* Estilo de Formatação de bytes printf-style:: 
* Memory Views:: 

@end menu

@node Objetos bytes,Objetos Bytearray,,Tipos de sequência binária — bytes bytearray memoryview
@anchor{library/stdtypes bytes-objects}@anchor{236d}@anchor{library/stdtypes typebytes}@anchor{22fb}
@subsubsection Objetos bytes


@geindex objeto;bytes

Objetos bytes são sequências imutáveis de bytes simples. Como muitos protocolos binários importantes são baseados em codificação ASCII de texto, objetos bytes oferecem diversos métodos que são válidos apenas quando trabalhamos com dados compatíveis com ASCII, e são proximamente relacionados com objetos string em uma variedade de outros sentidos.

@geindex bytes (classe interna)
@anchor{library/stdtypes bytes}@anchor{1c2}
@deffn {Classe} bytes (source=b'@w{'})

@deffnx {Classe} bytes (source, encoding, errors='strict')

Em primeiro lugar, a sintaxe para literais de bytes é em grande parte a mesma para literais de string, exceto que um prefixo @code{b} é adicionado:


@itemize *

@item 
Aspas simples: @code{b'ainda permite aspas "duplas" dentro'}

@item 
Aspas duplas: @code{b"ainda permite aspas 'simples' dentro"}

@item 
Aspas triplas: @code{b'@w{'}'3 aspas simples'@w{'}'}, @code{b"""3 aspas duplas"""}
@end itemize

Apenas caracteres ASCII são permitidos em literais de bytes (independentemente da codificação declarada no código-fonte). Qualquer valor binário superior a 127 deverá ser inserido em literais de bytes usando a sequência de escape apropriada.

Assim como string literais, bytes literais também podem usar um prefixo @code{r} para desabilitar o processamento de sequências de escape. Veja @ref{2031,,Literais de string e bytes} para mais sobre as várias formas de bytes literais, incluindo suporte a sequências de escape.

Enquanto bytes literais e representações são baseados em texto ASCII, objetos bytes na verdade se comportam como sequências imutáveis de inteiros, com cada valor na sequência restrito aos limites @code{0 <= x < 256} (tentativas de violar essa restrição irão disparar @ref{202,,ValueError}). Isto é feito deliberadamente para enfatizar que enquanto muitos formatos binários incluem elementos baseados em ASCII e podem ser utilmente manipulados com alguns algoritmos orientados a texto, esse não é geralmente o caso para dados binários arbitrários (aplicar algoritmos de processamento de texto cegamente em formatos de dados binários que não são compatíveis com ASCII irá usualmente resultar em dados corrompidos).

Além das formas literais, os objetos bytes podem ser criados de várias outras maneiras:


@itemize *

@item 
Um bytes preenchido com objetos zero com um comprimento especificado: @code{bytes(10)}

@item 
De um iterável de inteiros: @code{bytes(range(20))}

@item 
Copiando dados binários existentes através do protocolo de Buffer: @code{bytes(obj)}
@end itemize

Veja também os embutidos @ref{1c33,,bytes}.

Como 2 dígitos hexadecimais correspondem precisamente a apenas um byte, números hexadecimais são um formato comumente usado para descrever dados binários. Portanto, o tipo bytes tem um método de classe adicional para ler dados nesse formato:

@geindex fromhex() (método de classe bytes)
@anchor{library/stdtypes bytes fromhex}@anchor{b02}
@deffn {Método} classmethod fromhex (string, /)

Este método de classe da classe @ref{1c2,,bytes} retorna um objeto bytes, decodificando o objeto string fornecido. A string deve conter dois dígitos hexadecimais por byte, com espaço em branco ASCII sendo ignorado.

@example
>>> bytes.fromhex('2Ef0 F1f2  ')
b'.\xf0\xf1\xf2'
@end example


Alterado na versão 3.7: @ref{b02,,bytes.fromhex()} agora ignora todos os espaços em branco em ASCII na string, não apenas espaços.

@end deffn

Uma função de conversão reversa existe para transformar um objeto bytes na sua representação hexadecimal.

@geindex hex() (método bytes)
@anchor{library/stdtypes bytes hex}@anchor{d8d}
@deffn {Método} hex (*, bytes_per_sep=1)

@deffnx {Método} hex (sep, bytes_per_sep=1)

Retorna um objeto string contendo dois dígitos hexadecimais para cada byte na instância.

@example
>>> b'\xf0\xf1\xf2'.hex()
'f0f1f2'
@end example

Se você quiser tornar a string hexadecimal mais fácil de ler, você pode especificar um caractere separador através do parâmetro `sep', que será incluído no resultado. Por padrão, este separador será incluído entre cada byte. Um segundo parâmetro opcional `bytes_per_sep' controla o espaçamento. Valores positivos calculam a posição do separador a partir da direita, valores negativos calculam a partir da esquerda.

@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


Adicionado na versão 3.5.



Alterado na versão 3.8: @ref{d8d,,bytes.hex()} agora suporta os parâmetros opcionais `sep' e `bytes_per_sep' para inserir separadores entre bytes na saída hexadecimal.

@end deffn
@end deffn

Como objetos bytes são sequências de inteiros (certo parentesco a uma tupla), para um objeto bytes `b', @code{b[0]} será um inteiro, enquanto @code{b[0:1]} será um objeto bytes de comprimento 1. (Isso contrasta com strings de texto, onde tanto o uso por índice quanto por fatiamento irão produzir uma string de comprimento 1)

A representação de objetos bytes utiliza o formato literal (@code{b'...'}), uma vez que ela é frequentemente mais útil do que, por exemplo, @code{bytes([46, 46, 46])}. Você sempre pode converter um objeto bytes em uma lista de inteiros usando @code{list(b)}.

@node Objetos Bytearray,Operações com Bytes e Bytearray,Objetos bytes,Tipos de sequência binária — bytes bytearray memoryview
@anchor{library/stdtypes bytearray-objects}@anchor{236e}@anchor{library/stdtypes typebytearray}@anchor{22fa}
@subsubsection Objetos Bytearray


@geindex objeto;bytearray

Objetos @ref{2ea,,bytearray} são mutáveis, em contrapartida a objetos @ref{1c2,,bytes}.

@geindex bytearray (classe interna)
@anchor{library/stdtypes bytearray}@anchor{2ea}
@deffn {Classe} bytearray (source=b'@w{'})

@deffnx {Classe} bytearray (source, encoding, errors='strict')

Não existe sintaxe literal dedicada para objetos de bytearray, ao invés disso eles sempre são criados através da chamada do construtor:


@itemize *

@item 
Criando uma instância vazia: @code{bytearray()}

@item 
Criando uma instância cheia de zero com um determinado comprimento: @code{bytearray(10)}

@item 
A partir de inteiros iteráveis: @code{bytearray(range(20))}

@item 
Copiando dados binários existentes através do protocolo de buffer: @code{bytearray(b'Hi!')}
@end itemize

Como os objetos bytearray são mutáveis, os mesmos suportam as operações de sequência @ref{22f7,,mutable} além das operações comuns de bytes e bytearray descritas em @ref{22f8,,Operações com Bytes e Bytearray}.

Veja também o tipo embutido @ref{1c34,,bytearray}.

Uma vez que 2 dígitos hexadecimais correspondem precisamente a um único byte, os números hexadecimais são um formato comumente usado para descrever dados binários. Consequentemente, o tipo de bytearray tem um método de classe adicional para ler dados nesse formato:

@geindex fromhex() (método de classe bytearray)
@anchor{library/stdtypes bytearray fromhex}@anchor{b03}
@deffn {Método} classmethod fromhex (string, /)

Este método de classe da classe @ref{2ea,,bytearray} retorna um objeto bytearray, decodificando o objeto string fornecido. A string deve conter dois dígitos hexadecimais por byte, com espaços em branco ASCII sendo ignorados.

@example
>>> bytearray.fromhex('2Ef0 F1f2  ')
bytearray(b'.\xf0\xf1\xf2')
@end example


Alterado na versão 3.7: @ref{b03,,bytearray.fromhex()} agora ignora todos os espaços em branco em ASCII na string, não apenas espaços.

@end deffn

Existe uma função de conversão reversa para transformar um objeto bytearray em sua representação hexadecimal.

@geindex hex() (método bytearray)
@anchor{library/stdtypes bytearray hex}@anchor{d8e}
@deffn {Método} hex (*, bytes_per_sep=1)

@deffnx {Método} hex (sep, bytes_per_sep=1)

Retorna um objeto string contendo dois dígitos hexadecimais para cada byte na instância.

@example
>>> bytearray(b'\xf0\xf1\xf2').hex()
'f0f1f2'
@end example


Adicionado na versão 3.5.



Alterado na versão 3.8: Similar a @ref{d8d,,bytes.hex()}, @ref{d8e,,bytearray.hex()} agora suporta os parâmetros opcionais `sep' e `bytes_per_sep' para inserir separadores entre bytes na saída hexadecimal.

@end deffn
@end deffn

Como os objetos bytearray são sequências de inteiros (semelhante a uma lista), para um objeto bytearray `b', @code{b[0]} será um inteiro, enquanto que @code{b[0:1]} será um objeto bytearray de comprimento 1. (Isso contrasta com as Strings de texto, onde tanto a indexação como o fatiamento produzirão sequências de comprimento 1)

A representação de objetos bytearray utiliza o formato literal bytes (@code{bytearray(b'...')}), uma vez que muitas vezes é mais útil do que, por exemplo, @code{bytearray([46, 46, 46])}. Você sempre pode converter um objeto bytearray em uma lista de inteiros usando @code{list(b)}.

@node Operações com Bytes e Bytearray,Estilo de Formatação de bytes printf-style,Objetos Bytearray,Tipos de sequência binária — bytes bytearray memoryview
@anchor{library/stdtypes bytes-and-bytearray-operations}@anchor{236f}@anchor{library/stdtypes bytes-methods}@anchor{22f8}
@subsubsection Operações com Bytes e Bytearray


@geindex bytes;métodos
@geindex bytearray;métodos

Ambos os tipos, bytes e objetos do tipo bytearray, aceitam as operações de sequências @ref{233e,,comuns}. Os mesmos interagem não apenas com operandos do mesmo tipo, mas também com qualquer @ref{d4f,,objeto bytes ou similar}. Devido a esta flexibilidade, os mesmos podem ser misturados livremente em operações sem causar erros. No entanto, o tipo de retorno do resultado pode depender da ordem dos operandos.

@cartouche
@quotation Nota 
Os métodos em bytes e objetos Bytearray não aceitam Strings como argumentos, assim como os métodos de Strings não aceitam bytes como argumentos. Por exemplo, devemos escrever:

@example
a = "abc"
b = a.replace("a", "f")
@end example

e:

@example
a = b"abc"
b = a.replace(b"a", b"f")
@end example
@end quotation
@end cartouche

Alguns operações com bytes e bytearray presumem o uso de formatos binários compatíveis com ASCII e, portanto, devem ser evitados ao trabalhar com dados binários arbitrários. Essas restrições são abordadas a seguir.

@cartouche
@quotation Nota 
O uso dessas operações baseadas em ASCII para manipular dados binários que não são armazenados num formato baseado em ASCII poderá resultar na corrupção de dados.
@end quotation
@end cartouche

Os métodos a seguir em Bytes e Bytearray podem ser usados com dados binários arbitrários.

@geindex count() (método bytes)
@geindex count() (método bytearray)
@anchor{library/stdtypes bytes count}@anchor{2370}
@deffn {Método} bytes.count (sub[, start[, end]])
@anchor{library/stdtypes bytearray count}@anchor{15ba}
@deffnx {Método} bytearray.count (sub[, start[, end]])

Retorna o número de ocorrências não sobrepostas de subsequência `sub' no intervalo [`start', `end']. Os argumentos opcionais `start' e `end' são interpretados como na notação de fatiamento.

A subsequência a ser procurada poderá ser qualquer @ref{d4f,,objeto bytes ou similar} ou um inteiro no intervalo de 0 a 255.

Se `sub' estiver vazio, retorna o número de fatias vazias entre os caracteres, que é o comprimento do objeto bytes mais um.


Alterado na versão 3.3: Também aceita um número inteiro no intervalo de 0 a 255 como subsequência.

@end deffn

@geindex removeprefix() (método bytes)
@geindex removeprefix() (método bytearray)
@anchor{library/stdtypes bytes removeprefix}@anchor{2371}
@deffn {Método} bytes.removeprefix (prefix, /)
@anchor{library/stdtypes bytearray removeprefix}@anchor{2372}
@deffnx {Método} bytearray.removeprefix (prefix, /)

Se os dados binários começarem com a string `prefix', retorna @code{bytes[len(prefix):]}. Caso contrário, retorna uma cópia dos dados binários originais:

@example
>>> b'TestHook'.removeprefix(b'Test')
b'Hook'
>>> b'BaseTestCase'.removeprefix(b'Test')
b'BaseTestCase'
@end example

O `prefix' pode ser qualquer @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche


Adicionado na versão 3.9.

@end deffn

@geindex removesuffix() (método bytes)
@geindex removesuffix() (método bytearray)
@anchor{library/stdtypes bytes removesuffix}@anchor{2373}
@deffn {Método} bytes.removesuffix (suffix, /)
@anchor{library/stdtypes bytearray removesuffix}@anchor{2374}
@deffnx {Método} bytearray.removesuffix (suffix, /)

Se os dados binários terminarem com a string `suffix' e a `suffix' não estiver vazia, retorna @code{bytes[:-len(suffix)]}. Caso contrário, retorna uma cópia dos dados binários originais:

@example
>>> b'MiscTests'.removesuffix(b'Tests')
b'Misc'
>>> b'TmpDirMixin'.removesuffix(b'Tests')
b'TmpDirMixin'
@end example

O `suffix' pode ser qualquer @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche


Adicionado na versão 3.9.

@end deffn

@geindex decode() (método bytes)
@geindex decode() (método bytearray)
@anchor{library/stdtypes bytes decode}@anchor{8dc}
@deffn {Método} bytes.decode (encoding='utf-8', errors='strict')
@anchor{library/stdtypes bytearray decode}@anchor{2375}
@deffnx {Método} bytearray.decode (encoding='utf-8', errors='strict')

Retorna os bytes decodificados para uma @ref{44c,,str}.

`encoding' tem como padrão @code{'utf-8'}; veja @ref{de1,,Standard Encodings} para valores possíveis.

`errors' controla como os erros de decodificação são tratados. Se @code{'strict'} (o padrão), uma exceção @ref{12e6,,UnicodeError} é levantada. Outros valores possíveis são @code{'ignore'}, @code{'replace'} e qualquer outro nome registrado via @ref{14e3,,codecs.register_error()}. Veja @ref{18fa,,Error Handlers} para detalhes.

Por motivos de desempenho, o valor de `errors' não é verificado quanto à validade, a menos que um erro de decodificação realmente ocorra, @ref{1f8,,Modo de Desenvolvimento do Python} esteja ativado ou uma @ref{1f9,,construção de depuração} seja usada.

@cartouche
@quotation Nota 
Passar o argumento `encoding' para @ref{44c,,str} permite decodificar qualquer objeto @ref{d4f,,objeto bytes ou similar} diretamente, sem a necessidade de criar um objeto @code{bytes} ou @code{bytearray} temporário.
@end quotation
@end cartouche


Alterado na versão 3.1: Adicionado suporte para argumentos nomeados.



Alterado na versão 3.9: O valor do argumento `errors' agora é verificado em @ref{1f8,,Modo de Desenvolvimento do Python} e no @ref{1f9,,modo de depuração}.

@end deffn

@geindex endswith() (método bytes)
@geindex endswith() (método bytearray)
@anchor{library/stdtypes bytes endswith}@anchor{2376}
@deffn {Método} bytes.endswith (suffix[, start[, end]])
@anchor{library/stdtypes bytearray endswith}@anchor{13e9}
@deffnx {Método} bytearray.endswith (suffix[, start[, end]])

Retorna @code{True} se os dados binários encerra com o parâmetro `suffix' especificado, caso contrário retorna @code{False}. `suffix' também pode ser uma tupla de sufixos para averiguar. Com o parâmetro opcional `start', a procura começa naquela posição. Com o parâmetro opcional `end', o método encerra a comparação na posição fornecida.

O sufixo(es) para buscas pode ser qualquer termos @ref{d4f,,objeto bytes ou similar}.
@end deffn

@geindex find() (método bytes)
@geindex find() (método bytearray)
@anchor{library/stdtypes bytes find}@anchor{195e}
@deffn {Método} bytes.find (sub[, start[, end]])
@anchor{library/stdtypes bytearray find}@anchor{13ea}
@deffnx {Método} bytearray.find (sub[, start[, end]])

Retorna o índice mais baixo nos dados onde a sub-sequência `sub' é encontrada, tal que `sub' está contida na fatia @code{s[start:end]}. Argumentos opcionais `start' e `end' são interpretados como na notação de fatiamento. Retorna @code{-1} se `sub' não for localizada.

A subsequência a ser procurada poderá ser qualquer @ref{d4f,,objeto bytes ou similar} ou um inteiro no intervalo de 0 a 255.

@cartouche
@quotation Nota 
O método @ref{195e,,find()} deve ser usado apenas se você precisa saber a posição de `sub'. Para verificar se `sub' é uma substring ou não, use o operador @ref{2f4,,in}:

@example
>>> b'Py' in b'Python'
True
@end example
@end quotation
@end cartouche


Alterado na versão 3.3: Também aceita um número inteiro no intervalo de 0 a 255 como subsequência.

@end deffn

@geindex index() (método bytes)
@geindex index() (método bytearray)
@anchor{library/stdtypes bytes index}@anchor{2377}
@deffn {Método} bytes.index (sub[, start[, end]])
@anchor{library/stdtypes bytearray index}@anchor{15bb}
@deffnx {Método} bytearray.index (sub[, start[, end]])

Como @ref{195e,,find()}, mas levanta a exceção @ref{202,,ValueError} quando a subsequência não for encontrada.

A subsequência a ser procurada poderá ser qualquer @ref{d4f,,objeto bytes ou similar} ou um inteiro no intervalo de 0 a 255.


Alterado na versão 3.3: Também aceita um número inteiro no intervalo de 0 a 255 como subsequência.

@end deffn

@geindex join() (método bytes)
@geindex join() (método bytearray)
@anchor{library/stdtypes bytes join}@anchor{2341}
@deffn {Método} bytes.join (iterable, /)
@anchor{library/stdtypes bytearray join}@anchor{2378}
@deffnx {Método} bytearray.join (iterable, /)

Retorna um objeto bytes ou bytearray que é a concatenação das sequências de dados binários no iterável `iterable'. Uma exceção @ref{2c3,,TypeError} será levantada se existirem quaisquer valores que não sejam @ref{d4f,,objeto bytes ou similar}, no `iterable', incluindo objetos @ref{44c,,str}. O separador entre elementos é o conteúdo do objeto bytes ou bytearray que está fornecendo este método.
@end deffn

@geindex maketrans() (método estático bytes)
@geindex maketrans() (método estático bytearray)
@anchor{library/stdtypes bytes maketrans}@anchor{12b6}
@deffn {Método} static bytes.maketrans (from, to, /)
@anchor{library/stdtypes bytearray maketrans}@anchor{12b7}
@deffnx {Método} static bytearray.maketrans (from, to, /)

Este método estático retorna uma tabela de tradução usável para @ref{2379,,bytes.translate()}, que irá mapear cada caractere em `from' no caractere na mesma posição em `to'; `from' e `to' devem ambos ser @ref{d4f,,objetos bytes ou similares} e ter o mesmo comprimento.


Adicionado na versão 3.1.

@end deffn

@geindex partition() (método bytes)
@geindex partition() (método bytearray)
@anchor{library/stdtypes bytes partition}@anchor{237a}
@deffn {Método} bytes.partition (sep, /)
@anchor{library/stdtypes bytearray partition}@anchor{237b}
@deffnx {Método} bytearray.partition (sep, /)

Quebra a sequência na primeira ocorrência de `sep', e retorna uma tupla com 3 elementos contendo a parte antes do separador, o próprio separador, e a parte após o separador. Se o separador não for encontrado, retorna uma tupla com 3 elementos contendo uma cópia da sequência original, seguido de dois bytes ou objetos bytearray vazios.

O separador para buscar pode ser qualquer @ref{d4f,,objeto bytes ou similar}.
@end deffn

@geindex replace() (método bytes)
@geindex replace() (método bytearray)
@anchor{library/stdtypes bytes replace}@anchor{237c}
@deffn {Método} bytes.replace (old, new, count=-1, /)
@anchor{library/stdtypes bytearray replace}@anchor{237d}
@deffnx {Método} bytearray.replace (old, new, count=-1, /)

Retornar uma cópia da sequência com todas as ocorrências de subsequências `antigas' substituídas por `novo'. Se o argumento opcional `count' for fornecido, apenas as primeiras ocorrências de `count' serão substituídas.

A subsequência para buscar e substituição pode ser qualquer termos @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex rfind() (método bytes)
@geindex rfind() (método bytearray)
@anchor{library/stdtypes bytes rfind}@anchor{195f}
@deffn {Método} bytes.rfind (sub[, start[, end]])
@anchor{library/stdtypes bytearray rfind}@anchor{13eb}
@deffnx {Método} bytearray.rfind (sub[, start[, end]])

Retorna o índice mais alto na sequência onde a subsequência `sub' foi encontrada, de modo que `sub' esteja contido dentro de @code{s[start:end]}. Os argumentos opcionais `start' e `end' são interpretados como na notação de fatiamento. Caso ocorra algum problema será retornado @code{-1}.

A subsequência a ser procurada poderá ser qualquer @ref{d4f,,objeto bytes ou similar} ou um inteiro no intervalo de 0 a 255.


Alterado na versão 3.3: Também aceita um número inteiro no intervalo de 0 a 255 como subsequência.

@end deffn

@geindex rindex() (método bytes)
@geindex rindex() (método bytearray)
@anchor{library/stdtypes bytes rindex}@anchor{237e}
@deffn {Método} bytes.rindex (sub[, start[, end]])
@anchor{library/stdtypes bytearray rindex}@anchor{15bc}
@deffnx {Método} bytearray.rindex (sub[, start[, end]])

Semelhante a @ref{195f,,rfind()} mas levanta @ref{202,,ValueError} quando a subsequência `sub' não é encontrada.

A subsequência a ser procurada poderá ser qualquer @ref{d4f,,objeto bytes ou similar} ou um inteiro no intervalo de 0 a 255.


Alterado na versão 3.3: Também aceita um número inteiro no intervalo de 0 a 255 como subsequência.

@end deffn

@geindex rpartition() (método bytes)
@geindex rpartition() (método bytearray)
@anchor{library/stdtypes bytes rpartition}@anchor{237f}
@deffn {Método} bytes.rpartition (sep, /)
@anchor{library/stdtypes bytearray rpartition}@anchor{2380}
@deffnx {Método} bytearray.rpartition (sep, /)

Quebra a sequência na primeira ocorrência de `sep', e retorna uma tupla com 3 elementos contendo a parte antes do separador, o próprio separador, e a parte após o separador. Se o separador não for encontrado, retorna uma tupla com 3 elementos contendo dois bytes ou objetos bytearray vazios, seguido por uma cópia da sequência original.

O separador para buscar pode ser qualquer @ref{d4f,,objeto bytes ou similar}.
@end deffn

@geindex startswith() (método bytes)
@geindex startswith() (método bytearray)
@anchor{library/stdtypes bytes startswith}@anchor{2381}
@deffn {Método} bytes.startswith (prefix[, start[, end]])
@anchor{library/stdtypes bytearray startswith}@anchor{13e8}
@deffnx {Método} bytearray.startswith (prefix[, start[, end]])

Retorna @code{True} se os dados binários começam com o `prefix' especificado, caso contrário retorna @code{False}. `prefix' também pode ser uma tupla de prefixos para procurar. Com o parâmetro opcional `start', começa a procura na posição indicada. Com o parâmetro opcional `end', encerra a procura na posição indicada.

Os prefixos para pesquisar podem ser qualquer @ref{d4f,,objeto bytes ou similar}.
@end deffn

@geindex translate() (método bytes)
@geindex translate() (método bytearray)
@anchor{library/stdtypes bytes translate}@anchor{2379}
@deffn {Método} bytes.translate (table, /, delete=b'@w{'})
@anchor{library/stdtypes bytearray translate}@anchor{133f}
@deffnx {Método} bytearray.translate (table, /, delete=b'@w{'})

Retorna uma cópia dos bytes ou objeto bytearray, onde todas as ocorrências de bytes do argumento opcional `delete' são removidas, e os bytes restantes foram mapeados através da tabela de tradução fornecida, a qual deve ser um objeto bytes de comprimento 256.

Você pode usar o método @ref{12b6,,bytes.maketrans()} para criar uma tabela de tradução.

Define o argumento `table' como @code{None} para traduções que excluem apenas caracteres:

@example
>>> b'leia este curto texto'.translate(None, b'aeiou')
b'l st crt txt'
@end example


Alterado na versão 3.6: `delete' agora é suportado como um argumento nomeado.

@end deffn

Os seguintes métodos de objetos bytes e bytearray tem comportamentos padrões que presumem o uso de formatos binários compatíveis com ASCII, mas ainda podem ser usados com dados binários arbitrários através da passagem argumentos apropriados. Perceba que todos os métodos de bytearray nesta seção `não' alteram os argumentos, e ao invés disso produzem novos objetos.

@geindex center() (método bytes)
@geindex center() (método bytearray)
@anchor{library/stdtypes bytes center}@anchor{2382}
@deffn {Método} bytes.center (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray center}@anchor{2383}
@deffnx {Método} bytearray.center (width, fillbyte=b' ', /)

Retorna uma cópia do objeto centralizado em uma sequência de comprimento `width'. Preenchimento é feito usando o `fillbyte' especificado (o padrão é um espaço ASCII). Para objetos @ref{1c2,,bytes}, a sequência original é retornada se `width' é menor que ou igual a @code{len(s)}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex ljust() (método bytes)
@geindex ljust() (método bytearray)
@anchor{library/stdtypes bytes ljust}@anchor{2384}
@deffn {Método} bytes.ljust (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray ljust}@anchor{2385}
@deffnx {Método} bytearray.ljust (width, fillbyte=b' ', /)

Retorna uma cópia do objeto alinhado a esquerda em uma sequência de comprimento `width'. Preenchimento é feito usando o `fillbyte' especificado (o padrão é um espaço ASCII). Para objetos @ref{1c2,,bytes}, a sequência original é retornada se `width' é menor que ou igual a @code{len(s)}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex lstrip() (método bytes)
@geindex lstrip() (método bytearray)
@anchor{library/stdtypes bytes lstrip}@anchor{2386}
@deffn {Método} bytes.lstrip (bytes=None, /)
@anchor{library/stdtypes bytearray lstrip}@anchor{2387}
@deffnx {Método} bytearray.lstrip (bytes=None, /)

Retorna uma cópia da sequência com bytes iniciais especificados removidos. O argumento `bytes' é uma sequência binária que especifica o conjunto de valores de bytes a serem removidos. Se for omitido ou se for @code{None}, o argumento `bytes' será considerado como espaço em branco ASCII por padrão para a remoção. O argumento `bytes' não é um prefixo; ao invés disso, todas as combinações dos seus valores são removidas:

@example
>>> b'   spacious   '.lstrip()
b'spacious   '
>>> b'www.example.com'.lstrip(b'cmowz.')
b'example.com'
@end example

A sequência binária de valores de bytes a serem removidos pode ser @ref{d4f,,objeto bytes ou similar}. Consulte @ref{2371,,removeprefix()} para um método que removerá uma única string de prefixo em vez de todo um conjunto de caracteres. Por exemplo:

@example
>>> b'Arthur: three!'.lstrip(b'Arthur: ')
b'ee!'
>>> b'Arthur: three!'.removeprefix(b'Arthur: ')
b'three!'
@end example

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex rjust() (método bytes)
@geindex rjust() (método bytearray)
@anchor{library/stdtypes bytes rjust}@anchor{2388}
@deffn {Método} bytes.rjust (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray rjust}@anchor{2389}
@deffnx {Método} bytearray.rjust (width, fillbyte=b' ', /)

Retorna uma cópia do objeto alinhado a direita em uma sequência de comprimento `width'. Preenchimento é feito usando o `fillbyte' especificado (o padrão é um espaço ASCII). Para objetos @ref{1c2,,bytes}, a sequência original é retornada se `width' é menor que ou igual a @code{len(s)}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex rsplit() (método bytes)
@geindex rsplit() (método bytearray)
@anchor{library/stdtypes bytes rsplit}@anchor{238a}
@deffn {Método} bytes.rsplit (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray rsplit}@anchor{15bf}
@deffnx {Método} bytearray.rsplit (sep=None, maxsplit=-1)

Divide a sequência binária em subsequência do mesmo tipo, usando `sep' como um delimitador de string. Se `maxsplit' é fornecido, no máximo `maxsplit' divisões são feitas, aquelas que estão `mais à direita'. Se `sep' não é especificado ou é @code{None}, qualquer subsequência consistindo unicamente de espaço em branco ASCII é um separador. Exceto por dividir pela direita, @ref{15bf,,rsplit()} comporta-se como @ref{15be,,split()}, o qual é descrito em detalhes abaixo.
@end deffn

@geindex rstrip() (método bytes)
@geindex rstrip() (método bytearray)
@anchor{library/stdtypes bytes rstrip}@anchor{238b}
@deffn {Método} bytes.rstrip (bytes=None, /)
@anchor{library/stdtypes bytearray rstrip}@anchor{238c}
@deffnx {Método} bytearray.rstrip (bytes=None, /)

Retorna uma cópia da sequência com bytes finais especificados removidos. O argumento `bytes' é uma sequência binária que especifica o conjunto de valores de bytes a serem removidos. Se for omitido ou se for @code{None}, o argumento `bytes' será considerado como espaço em branco ASCII por padrão para a remoção. O argumento `bytes' não é um sufixo; ao invés disso, todas as combinações dos seus valores são removidas:

@example
>>> b'   spacious   '.rstrip()
b'   spacious'
>>> b'mississippi'.rstrip(b'ipz')
b'mississ'
@end example

A sequência binária de valores de bytes a serem removidos pode ser @ref{d4f,,objeto bytes ou similar}. Consulte @ref{2373,,removesuffix()} para um método que removerá uma única string de sufixo em vez de todo um conjunto de caracteres. Por exemplo:

@example
>>> b'Monty Python'.rstrip(b' Python')
b'M'
>>> b'Monty Python'.removesuffix(b' Python')
b'Monty'
@end example

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex split() (método bytes)
@geindex split() (método bytearray)
@anchor{library/stdtypes bytes split}@anchor{238d}
@deffn {Método} bytes.split (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray split}@anchor{15be}
@deffnx {Método} bytearray.split (sep=None, maxsplit=-1)

Divide a sequência binária em subsequências do mesmo tipo, usando `sep' como o delimitador de string. Se `maxsplit' é fornecido e não-negativo, no máximo `maxsplit' divisões são feitas (logo, a lista terá no máximo @code{maxsplit+1} elementos). Se `maxsplit' não é especificado ou é @code{-1}, então não existe limite no número de divisões (todas as divisões possíveis são feitas).

Se `sep' é fornecido, delimitadores consecutivos não são agrupados juntos e eles são destinados para delimitar strings vazias (por exemplo, @code{b'1,,2'.split(b',')} retorna @code{[b'1', b'@w{'}, b'2']}). O argumento `sep' pode consistir de uma sequência de múltiplos bytes como um único delimitador. Separar uma sequência vazia com um separador especificado retorna @code{[b'@w{'}]} ou @code{[bytearray(b'@w{'})]} dependendo do tipo do objeto que está sendo separado. O argumento `sep' pode ser qualquer @ref{d4f,,objeto bytes ou similar}.

Por exemplo:

@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

Se `sep' não for especificado ou for @code{None}, um algoritmo diferente de separação é aplicado: ocorrências consecutivas de espaços em branco ASCII são consideradas como um separador único, e o resultado não conterá strings vazias no início ou no final, se a sequência tiver espaços em branco no início ou no final. Consequentemente, separar uma sequência vazia ou uma sequência que consiste apenas de espaços em branco ASCII sem um separador especificado, retorna @code{[]}.

Por exemplo:

@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 bytes)
@geindex strip() (método bytearray)
@anchor{library/stdtypes bytes strip}@anchor{238e}
@deffn {Método} bytes.strip (bytes=None, /)
@anchor{library/stdtypes bytearray strip}@anchor{238f}
@deffnx {Método} bytearray.strip (bytes=None, /)

Retorna uma cópia da sequência com bytes iniciais e finais especificados removidos. O argumento `bytes' é uma sequência binária que especifica o conjunto de valores de bytes a serem removidos. Se for omitido ou se for @code{None}, o argumento `bytes' será considerado como espaço em branco ASCII por padrão para a remoção. O argumento `bytes' não é um prefixo ou sufixo; ao invés disso, todas as combinações dos seus valores são removidas:

@example
>>> b'   spacious   '.strip()
b'spacious'
>>> b'www.example.com'.strip(b'cmowz.')
b'example'
@end example

A sequência binária de valores de bytes a serem removidos pode ser qualquer @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

O seguintes métodos de bytes e objetos bytearray presumem o uso de formatos binários compatíveis com ASCII e não devem ser aplicados a dados binários arbitrários. Perceba que todos os métodos de bytearray nesta seção `não' alteram os argumentos, e ao invés disso produzem novos objetos.

@geindex capitalize() (método bytes)
@geindex capitalize() (método bytearray)
@anchor{library/stdtypes bytes capitalize}@anchor{2390}
@deffn {Método} bytes.capitalize ()
@anchor{library/stdtypes bytearray capitalize}@anchor{2391}
@deffnx {Método} bytearray.capitalize ()

Retorna uma cópia da sequência com cada byte interpretado como um caractere ASCII, e o primeiro byte em letra maiúscula e o resto em letras minúsculas. Valores de bytes que não são ASCII são passados adiante sem mudanças.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex expandtabs() (método bytes)
@geindex expandtabs() (método bytearray)
@anchor{library/stdtypes bytes expandtabs}@anchor{2392}
@deffn {Método} bytes.expandtabs (tabsize=8)
@anchor{library/stdtypes bytearray expandtabs}@anchor{2393}
@deffnx {Método} bytearray.expandtabs (tabsize=8)

Retorna uma cópia da sequência onde todos os caracteres de tabulação ASCII são substituídos por um ou mais espaços ASCII, dependendo da coluna atual e do tamanho fornecido para a tabulação. Posições de tabulação ocorrem a cada `tabsize' bytes (o padrão é 8, dada as posições de tabulação nas colunas 0, 8, 16 e assim por diante). Para expandir a sequência, a coluna atual é definida como zero e a sequência é examinada byte por byte. Se o byte é um caractere ASCII de tabulação (@code{b'\t'}), um ou mais caracteres de espaço são inseridos no resultado até que a coluna atual seja igual a próxima posição de tabulação. (O caractere de tabulação em si não é copiado.) Se o byte atual é um caractere ASCII de nova linha (@code{b'\n'}) ou de retorno (@code{b'\r'}), ele é copiado e a coluna atual é redefinida para zero. Qualquer outro byte é copiado sem ser modificado e a coluna atual é incrementada em uma unidade independentemente de como o byte é representado quanto é impresso:

@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 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex isalnum() (método bytes)
@geindex isalnum() (método bytearray)
@anchor{library/stdtypes bytes isalnum}@anchor{2394}
@deffn {Método} bytes.isalnum ()
@anchor{library/stdtypes bytearray isalnum}@anchor{2395}
@deffnx {Método} bytearray.isalnum ()

Retorna @code{True} se todos os bytes na sequência são caracteres alfabéticos ASCII ou dígitos decimais ASCII e a sequência não é vazia, @code{False} caso contrário. Caracteres alfabéticos ASCII são aqueles valores de byte na sequência @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'}. Dígitos decimais ASCII são aqueles valores de byte na sequência @code{b'0123456789'}.

Por exemplo:

@example
>>> b'ABCabc1'.isalnum()
True
>>> b'ABC abc1'.isalnum()
False
@end example
@end deffn

@geindex isalpha() (método bytes)
@geindex isalpha() (método bytearray)
@anchor{library/stdtypes bytes isalpha}@anchor{2396}
@deffn {Método} bytes.isalpha ()
@anchor{library/stdtypes bytearray isalpha}@anchor{2397}
@deffnx {Método} bytearray.isalpha ()

Retorna @code{True} se todos os bytes na sequência são caracteres alfabéticos ASCII e a sequência não é vazia, @code{False} caso contrário. Caracteres alfabéticos ASCII são aqueles cujo valor dos bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

Por exemplo:

@example
>>> b'ABCabc'.isalpha()
True
>>> b'ABCabc1'.isalpha()
False
@end example
@end deffn

@geindex isascii() (método bytes)
@geindex isascii() (método bytearray)
@anchor{library/stdtypes bytes isascii}@anchor{2398}
@deffn {Método} bytes.isascii ()
@anchor{library/stdtypes bytearray isascii}@anchor{2399}
@deffnx {Método} bytearray.isascii ()

Retorna @code{True} se a sequência é vazia ou todos os bytes na sequência são ASCII, @code{False} caso contrário. Bytes ASCII estão no intervalo 0-0x7F.


Adicionado na versão 3.7.

@end deffn

@geindex isdigit() (método bytes)
@geindex isdigit() (método bytearray)
@anchor{library/stdtypes bytes isdigit}@anchor{239a}
@deffn {Método} bytes.isdigit ()
@anchor{library/stdtypes bytearray isdigit}@anchor{239b}
@deffnx {Método} bytearray.isdigit ()

Retorna @code{True} se todos os bytes na sequência são dígitos decimais ASCII e a sequência não é vazia, @code{False} caso contrário. Dígitos decimais ASCII são aqueles cujos valores dos bytes estão na sequência @code{b'0123456789'}.

Por exemplo:

@example
>>> b'1234'.isdigit()
True
>>> b'1.23'.isdigit()
False
@end example
@end deffn

@geindex islower() (método bytes)
@geindex islower() (método bytearray)
@anchor{library/stdtypes bytes islower}@anchor{239c}
@deffn {Método} bytes.islower ()
@anchor{library/stdtypes bytearray islower}@anchor{239d}
@deffnx {Método} bytearray.islower ()

Retorna @code{True} se existe pelo menos um caractere minúsculo ASCII na sequência e nenhum caractere maiúsculo ASCII, @code{False} caso contrário.

Por exemplo:

@example
>>> b'hello world'.islower()
True
>>> b'Hello world'.islower()
False
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.
@end deffn

@geindex isspace() (método bytes)
@geindex isspace() (método bytearray)
@anchor{library/stdtypes bytes isspace}@anchor{239e}
@deffn {Método} bytes.isspace ()
@anchor{library/stdtypes bytearray isspace}@anchor{239f}
@deffnx {Método} bytearray.isspace ()

Retorna @code{True} se todos os bytes na sequência são espaço em branco ASCII e a sequência não é vazia, @code{False} caso contrário. Caracteres de espaço em branco ASCII são aqueles cujos valores de bytes estão na sequência @code{b' \t\n\r\x0b\f'} (espaço, tabulação, nova linha, retorno do cursor, tabulação vertical, formulário de entrada).
@end deffn

@geindex istitle() (método bytes)
@geindex istitle() (método bytearray)
@anchor{library/stdtypes bytes istitle}@anchor{23a0}
@deffn {Método} bytes.istitle ()
@anchor{library/stdtypes bytearray istitle}@anchor{23a1}
@deffnx {Método} bytearray.istitle ()

Retorna @code{True} se a sequência é titlecased ASCII e a sequência não é vazia, @code{False} caso contrário. Veja @ref{23a2,,bytes.title()} para mais detalhes sobre a definição de “titlecased”.

Por exemplo:

@example
>>> b'Hello World'.istitle()
True
>>> b'Hello world'.istitle()
False
@end example
@end deffn

@geindex isupper() (método bytes)
@geindex isupper() (método bytearray)
@anchor{library/stdtypes bytes isupper}@anchor{23a3}
@deffn {Método} bytes.isupper ()
@anchor{library/stdtypes bytearray isupper}@anchor{23a4}
@deffnx {Método} bytearray.isupper ()

Retorna @code{True} se existe pelo menos um caractere maiúsculo alfabético ASCII na sequência e nenhum caractere minúsculo ASCII, @code{False} caso contrário.

Por exemplo:

@example
>>> b'HELLO WORLD'.isupper()
True
>>> b'Hello world'.isupper()
False
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.
@end deffn

@geindex lower() (método bytes)
@geindex lower() (método bytearray)
@anchor{library/stdtypes bytes lower}@anchor{23a5}
@deffn {Método} bytes.lower ()
@anchor{library/stdtypes bytearray lower}@anchor{23a6}
@deffnx {Método} bytearray.lower ()

Retorna uma cópia da sequência com todos os caracteres maiúsculos ASCII convertidos para os seus correspondentes caracteres minúsculos.

Por exemplo:

@example
>>> b'Hello World'.lower()
b'hello world'
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex novas linhas universais;método bytes.splitlines
@geindex novas linhas universais;método bytearray.splitlines

@geindex splitlines() (método bytes)
@geindex splitlines() (método bytearray)
@anchor{library/stdtypes bytes splitlines}@anchor{23a7}
@deffn {Método} bytes.splitlines (keepends=False)
@anchor{library/stdtypes bytearray splitlines}@anchor{23a8}
@deffnx {Método} bytearray.splitlines (keepends=False)

Retorna uma lista das linhas na sequência binária, quebrando nos limites ASCII das linhas. Este método usa a abordagem de @ref{d5c,,novas linhas universais} para separar as linhas. Quebras de linhas não são incluídas na lista resultante a não ser que `keepends' seja fornecido e verdadeiro.

Por exemplo:

@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

Ao contrário de @ref{238d,,split()}, quando uma string delimitadora `sep' é fornecida, este método retorna uma lista vazia para a string vazia, e uma quebra de linha terminal não resulta em uma linha 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 bytes)
@geindex swapcase() (método bytearray)
@anchor{library/stdtypes bytes swapcase}@anchor{23a9}
@deffn {Método} bytes.swapcase ()
@anchor{library/stdtypes bytearray swapcase}@anchor{23aa}
@deffnx {Método} bytearray.swapcase ()

Retorna uma cópia da sequência com todos os caracteres minúsculos ASCII convertidos para caracteres maiúsculos correspondentes, e vice-versa.

Por exemplo:

@example
>>> b'Hello World'.swapcase()
b'hELLO wORLD'
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

Ao contrário de @ref{2365,,str.swapcase()}, é sempre fato que @code{bin.swapcase().swapcase() == bin} para as versões binárias. Conversões maiúsculas/minúsculas são simétricas em ASCII, apesar que isso não é geralmente verdade para pontos de código arbitrários Unicode.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex title() (método bytes)
@geindex title() (método bytearray)
@anchor{library/stdtypes bytes title}@anchor{23a2}
@deffn {Método} bytes.title ()
@anchor{library/stdtypes bytearray title}@anchor{23ab}
@deffnx {Método} bytearray.title ()

Retorna uma versão titlecased da sequência binária, onde palavras iniciam com um caractere ASCII com letra maiúscula e os caracteres restantes são em letras minúsculas. Bytes quem não possuem diferença entre maiúscula/minúscula não são alterados.

Por exemplo:

@example
>>> b'Hello world'.title()
b'Hello World'
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de byte estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de byte estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}. Todos os outros valores de bytes ignoram maiúsculas/minúsculas.

O algoritmo usa uma definição simples independente de idioma para uma palavra, como grupos de letras consecutivas. A definição funciona em muitos contextos, mas isso significa que apóstrofes em contrações e possessivos formam limites de palavras, os quais podem não ser o resultado desejado:

@example
>>> b"they're bill's friends from the UK".title()
b"They'Re Bill'S Friends From The Uk"
@end example

Uma solução alternativa para os apóstrofes pode ser construída usando expressões 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 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex upper() (método bytes)
@geindex upper() (método bytearray)
@anchor{library/stdtypes bytes upper}@anchor{23ac}
@deffn {Método} bytes.upper ()
@anchor{library/stdtypes bytearray upper}@anchor{23ad}
@deffnx {Método} bytearray.upper ()

Retorna uma cópia da sequência com todos os caracteres minúsculos ASCII convertidos para sua contraparte maiúscula correspondente.

Por exemplo:

@example
>>> b'Hello World'.upper()
b'HELLO WORLD'
@end example

Caracteres minúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'abcdefghijklmnopqrstuvwxyz'}. Caracteres maiúsculos ASCII são aqueles cujos valores de bytes estão na sequência @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}.

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@geindex zfill() (método bytes)
@geindex zfill() (método bytearray)
@anchor{library/stdtypes bytes zfill}@anchor{23ae}
@deffn {Método} bytes.zfill (width, /)
@anchor{library/stdtypes bytearray zfill}@anchor{23af}
@deffnx {Método} bytearray.zfill (width, /)

Retorna uma cópia da sequência preenchida a esquerda com dígitos @code{b'0'} ASCII para produzir uma sequência se comprimento `width'. Um sinal de prefixo inicial (@code{b'+'}/ @code{b'-'}) é controlado através da inserção de preenchimento `depois' do caractere de sinal, ao invés de antes. Para objetos @ref{1c2,,bytes}, a sequência original é retornada se `width' é menor que ou igual a @code{len(seq)}.

Por exemplo:

@example
>>> b"42".zfill(5)
b'00042'
>>> b"-42".zfill(5)
b'-0042'
@end example

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche
@end deffn

@node Estilo de Formatação de bytes printf-style,Memory Views,Operações com Bytes e Bytearray,Tipos de sequência binária — bytes bytearray memoryview
@anchor{library/stdtypes bytes-formatting}@anchor{da9}@anchor{library/stdtypes printf-style-bytes-formatting}@anchor{23b0}
@subsubsection Estilo de Formatação de bytes @code{printf}-style


@geindex formatação;bytes (%)
@geindex formatação;bytearray (%)
@geindex interpolação;bytes (%)
@geindex interpolação;bytearray (%)
@geindex bytes;formatação
@geindex bytearray;formatação
@geindex bytes;interpolação
@geindex bytearray;interpolação
@geindex printf@comma{} estilo de formatação
@geindex sprintf@comma{} estilo de formatação
@geindex % (porcentagem);printf@comma{} estilo de formatação

@cartouche
@quotation Nota 
As operações de formatação descritas aqui exibem uma variedade de peculiaridades que levam a uma série de erros comuns (como a falha na exibição de Tuplas e Dicionários corretamente). Se o valor que está sendo impresso puder ser uma tupla ou dicionário, envolva-o numa tupla.
@end quotation
@end cartouche

Objetos Bytes (@code{bytes}/@code{bytearray}) possuem uma operação integrada exclusiva: o operador @code{%} (modulo). Isso também é conhecido como o bytes de `formatação' ou o operador de `interpolação'. Dado @code{format % values} (onde `format' é um objeto bytes), as especificações de conversão @code{%} em `format' são substituídas por zero ou mais elementos de `values'. O efeito é semelhante ao uso da função @code{sprintf()} na linguagem C.

Se `format' requer um único argumento, `values' poderá ser um único objeto não-tuple. @footnote{
Para formatar apenas uma tupla, você deve portanto fornecer uma tupla com apenas um elemento, que é a tupla a ser formatada.
} Caso contrário, `values' deverá ser uma tupla com exatamente o número de itens especificados pelo objeto de formatação de Bytes, ou um único objeto de mapeamento (por exemplo, um dicionário).

@geindex () (parênteses);em formatação no estilo printf
@geindex * (asterisco);em formatação no estilo printf
@geindex . (ponto);em formatação no estilo printf

Um especificador de conversão contém dois ou mais caracteres e tem os seguintes componentes, que devem aparecer nesta ordem:


@enumerate 

@item 
O caractere @code{'%'}, que determina o início do especificador.

@item 
Mapeamento de chaves (opcional), consistindo de uma sequência entre parênteses de caracteres (por exemplo, @code{(algumnome)}).

@item 
Flags de conversão (opcional), que afetam o resultado de alguns tipos de conversão.

@item 
Largura mínima do campo (opcional). Se for especificado como um @code{'*'} (asterisco), a largura real será lida a partir do próximo elemento da tupla em `values' e o objeto a converter virá após a largura mínima do campo e a precisão que é opcional.

@item 
Precisão (opcional), fornecido como uma @code{'.'} (ponto) seguido pela precisão. Se determinado como um @code{'*'} (um asterisco), a precisão real será lida a partir do próximo elemento da tupla em `values', e o valor a converter virá após a precisão.

@item 
Modificador de comprimento (opcional).

@item 
Tipo de conversão.
@end enumerate

Quando o argumento a direita é um dicionário (ou outro tipo de mapeamento), então o formato no objeto bytes `deve' incluir um mapeamento de chaves entre parêntesis neste dicionário inserido imediatamente após o caractere @code{'%'}. O mapeamento de chaves seleciona o valor a ser formatado a partir do mapeamento. Por exemplo:

@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

Nesse caso, nenhum especificador @code{*} poderá ocorrer num formato (uma vez que eles exigem uma lista de parâmetros sequenciais).

Os caracteres flags de conversão são:

@geindex # (cerquilha);em formatação no estilo printf
@geindex - (menos);em formatação no estilo printf
@geindex + (mais);em formatação no estilo printf
@geindex espaço;em formatação no estilo printf


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@item

@code{'#'}

@tab

A conversão de valor usará o “formulário alternativo” (conforme definido abaixo).

@item

@code{'0'}

@tab

A conversão será preenchida por zeros para valores numéricos.

@item

@code{'-'}

@tab

O valor convertido será ajustado à esquerda (substitui a conversão @code{'0'} se ambos forem fornecidos).

@item

@code{' '}

@tab

(um espaço) Um espaço em branco deverá ser deixado antes de um número positivo (ou uma string vazia) produzido por uma conversão assinada.

@item

@code{'+'}

@tab

Um sinal de caractere (@code{'+'} ou @code{'-'}) precederá a conversão (substituindo o sinalizador de “espaço”).

@end multitable


Um modificador de comprimento (@code{h}, @code{l}, ou @code{L}) pode estar presente, mas será ignorado, pois o mesmo não é necessário para o Python – então, por exemplo, @code{%ld} é idêntico a @code{%d}.

Os tipos de conversão são:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Conversão

@tab

Significado

@tab

Notas

@item

@code{'d'}

@tab

Número decimal inteiro sinalizador.

@tab

@item

@code{'i'}

@tab

Número decimal inteiro sinalizador.

@tab

@item

@code{'o'}

@tab

Valor octal sinalizador.

@tab

(1)

@item

@code{'u'}

@tab

Tipo obsoleto – é idêntico a @code{'d'}.

@tab

(8)

@item

@code{'x'}

@tab

Hexadecimal com sinal (minúsculo).

@tab

(2)

@item

@code{'X'}

@tab

Hexadecimal com sinal (maiúsculo).

@tab

(2)

@item

@code{'e'}

@tab

Formato exponencial de ponto flutuante (minúsculo).

@tab

(3)

@item

@code{'E'}

@tab

Formato exponencial de ponto flutuante (maiúsculo).

@tab

(3)

@item

@code{'f'}

@tab

Formato decimal de ponto flutuante.

@tab

(3)

@item

@code{'F'}

@tab

Formato decimal de ponto flutuante.

@tab

(3)

@item

@code{'g'}

@tab

O formato de ponto flutuante. Usa o formato exponencial em minúsculo se o expoente for inferior a -4 ou não inferior a precisão, formato decimal, caso contrário.

@tab

(4)

@item

@code{'G'}

@tab

Formato de ponto flutuante. Usa o formato exponencial em maiúsculo se o expoente for inferior a -4 ou não inferior que a precisão, formato decimal, caso contrário.

@tab

(4)

@item

@code{'c'}

@tab

Byte simples (aceita objetos inteiros ou de byte único).

@tab

@item

@code{'b'}

@tab

Bytes (qualquer objeto que segue o @ref{2e8,,buffer protocol} o que possui @ref{5e8,,__bytes__()}).

@tab

(5)

@item

@code{'s'}

@tab

@code{'s'} é um alias para @code{'b'} e só deve ser usado para bases de código Python2/3.

@tab

(6)

@item

@code{'a'}

@tab

Bytes (converte qualquer objeto Python usando @code{repr(obj).encode('ascii', 'backslashreplace')}).

@tab

(5)

@item

@code{'r'}

@tab

@code{'r'} é um alias para @code{'a'} e só deve ser usado para bases de código Python2/3.

@tab

(7)

@item

@code{'%'}

@tab

Nenhum argumento é convertido, resultando em um caractere @code{'%'} no resultado.

@tab

@end multitable


Notas:


@enumerate 

@item 
A forma alternativa faz com que um especificador octal principal (@code{'0o'}) seja inserido antes do primeiro dígito.

@item 
O formato alternativo produz um @code{'0x'} ou @code{'0X'} (dependendo se o formato @code{'x'} or @code{'X'} foi usado) para ser inserido antes do primeiro dígito.

@item 
A forma alternativa faz com que o resultado sempre contenha um ponto decimal, mesmo que nenhum dígito o siga.

A precisão determina o número de dígitos após o ponto decimal e o padrão é 6.

@item 
A forma alternativa faz com que o resultado sempre contenha um ponto decimal e os zeros à direita não sejam removidos, como de outra forma seriam.

A precisão determina o número de dígitos significativos antes e depois do ponto decimal e o padrão seja 6.

@item 
Se a precisão for @code{N}, a saída será truncada em @code{N} caracteres.

@item 
@code{b'%s'} está descontinuado, mas não será removido durante a versão 3.x.

@item 
@code{b'%r'} entrou em desuso, mas não serão removidos na versão 3.x.

@item 
Veja 
@geindex Propostas de Melhorias do Python; PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}.
@end enumerate

@cartouche
@quotation Nota 
A versão Bytearray deste método `não' opera no local – o mesmo sempre produz um novo objeto, mesmo que não tenha sido feitas alterações.
@end quotation
@end cartouche


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} - Adicionar formatação % para to bytes e bytearray



Adicionado na versão 3.5.


@node Memory Views,,Estilo de Formatação de bytes printf-style,Tipos de sequência binária — bytes bytearray memoryview
@anchor{library/stdtypes memory-views}@anchor{23b1}@anchor{library/stdtypes typememoryview}@anchor{230d}
@subsubsection Memory Views


O objeto @ref{2eb,,memoryview} permite que o código Python acesse os dados internos de um objeto que suporte o @ref{2e8,,buffer protocol} sem copiá-lo.

@geindex memoryview (classe interna)
@anchor{library/stdtypes memoryview}@anchor{2eb}
@deffn {Classe} memoryview (object)

Cria uma @ref{2eb,,memoryview} que referencia `object'. `object' deve ter suporte ao protocolo de buffer. Objetos embutidos com suporte ao protocolo de buffer incluem: @ref{1c2,,bytes} e @ref{2ea,,bytearray}.

Uma @ref{2eb,,memoryview} tem a noção de um `elemento', o qual é a unidade de memória atômica manipulada pelo objeto de origem `object'. Para muitos tipos simples tais como @ref{1c2,,bytes} e @ref{2ea,,bytearray}, um elemento é um byte único, mas outros tipos tais como @ref{1a0,,array.array} podem ter elementos maiores.

@code{len(view)} é igual ao comprimento de @ref{23b2,,tolist}, que é a representação de lista aninhada da view. Se @code{view.ndim = 1}, isso é igual ao número de elementos na visualização.


Alterado na versão 3.12: Se @code{view.ndim == 0}, @code{len(view)} agora levanta @ref{2c3,,TypeError} em vez de retornar 1.


O atributo @ref{23b3,,itemsize} vai lhe dar um número de bytes em um único elemento.

Um @ref{2eb,,memoryview} suporta fatiamento e indexação para expor seus dados. Fatiamento unidimensional irá resultar em uma subview:

@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

Se @ref{23b4,,format} é um dos especificadores de formatação nativos do módulo @ref{d5,,struct}, indexar com um inteiro ou uma tupla de inteiros também é suportado, e retorna um `element' único com o tipo correto. Memoryviews unidimensionais podem ser indexadas com um inteiro ou uma tupla contendo um inteiro. Memoryviews multi-dimensionais podem ser indexadas com tuplas de exatamente `ndim' inteiros, onde `ndim' é o número de dimensões. Memoryviews zero-dimensionais podem ser indexadas com uma tupla vazia.

Aqui temos um exemplo usando um formato não-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

Se o objeto subjacente é gravável, a memoryview suporta atribuição de fatias unidimensionais. Redimensionamento não é permitido:

@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

Memoryviews unidimensionais de tipos @ref{610,,hasheáveis} (somente leitura) com formatos ‘B’, ‘b’ ou ‘c’ também são hasheáveis. O hash é definido como @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


Alterado na versão 3.3: Memoryviews unidimensionais agora podem ser fatiadas. Memoryviews unidimensionais com formatos ‘B’, ‘b’ ou ‘c’ agora são @ref{610,,hasheáveis}.



Alterado na versão 3.4: O memoryview agora é registrado automaticamente como uma classe @ref{1204,,collections.abc.Sequence}



Alterado na versão 3.5: Atualmente, os memoryvies podem ser indexadas com uma tupla de números inteiros.


@ref{2eb,,memoryview} possui vários métodos:

@geindex __eq__() (método memoryview)
@anchor{library/stdtypes memoryview __eq__}@anchor{23b5}
@deffn {Método} __eq__ (exporter)

Uma memoryview e um exportador 
@geindex Propostas de Melhorias do Python; PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} são iguais se as suas formas são equivalentes e se todos os valores correspondentes são iguais quando os códigos de formatação dos respectivos operadores são interpretados usando a sintaxe @ref{d5,,struct}.

Para o subconjunto @ref{d5,,struct} a formatação de Strings atualmente suportadas por @ref{23b2,,tolist()}, @code{v} e @code{w} são iguais se @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

Se qualquer string de formatação não for suportada pelo módulo @ref{d5,,struct}, então os objetos irão sempre comparar como diferentes (mesmo se as strings de formatação e o conteúdo do buffer são 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

Perceba que, assim como com números de ponto flutuante, @code{v is w} `não' implica em @code{v == w} para objetos memoryview.


Alterado na versão 3.3: Versões anteriores comparavam a memória bruta desconsiderando o formato do item e estrutura lógica do array.

@end deffn

@geindex tobytes() (método memoryview)
@anchor{library/stdtypes memoryview tobytes}@anchor{23b6}
@deffn {Método} tobytes (order='C')

Retorna os dados no buffer como um bytestring. Isso é equivalente a chamar o construtor de @ref{1c2,,bytes} na memoryview.

@example
>>> m = memoryview(b"abc")
>>> m.tobytes()
b'abc'
>>> bytes(m)
b'abc'
@end example

Para arrays não contíguos, o resultado é igual a representação de lista achatada com todos os elementos convertidos para bytes. @ref{23b6,,tobytes()} suporta todos os formatos de strings, incluindo aqueles que não estão na sintaxe do módulo @ref{d5,,struct}.


Adicionado na versão 3.8: `order' pode ser @{‘C’, ‘F’, ‘A’@}. Quando `order' é ‘C’ ou ‘F’, os dados do array original são convertidos para a ordem de C our Fortran. Para views contígua, ‘A’ retorna uma cópia exata da memória física. Em particular, ordem de Fortran em memória é preservada. Para views não contígua, os dados são convertidos primeiro para C. `order=None' é o mesmo que `order=’C’'.

@end deffn

@geindex hex() (método memoryview)
@anchor{library/stdtypes memoryview hex}@anchor{d8f}
@deffn {Método} hex (*, bytes_per_sep=1)

@deffnx {Método} hex (sep, bytes_per_sep=1)

Retorna um objeto string contendo dois dígitos hexadecimais para cada byte no buffer.

@example
>>> m = memoryview(b"abc")
>>> m.hex()
'616263'
@end example


Adicionado na versão 3.5.



Alterado na versão 3.8: Similar a @ref{d8d,,bytes.hex()}, @ref{d8f,,memoryview.hex()} agora suporta os parâmetros opcionais `sep' e `bytes_per_sep' para inserir separadores entre bytes na saída hexadecimal.

@end deffn

@geindex tolist() (método memoryview)
@anchor{library/stdtypes memoryview tolist}@anchor{23b2}
@deffn {Método} tolist ()

Retorna os dados no buffer como uma 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


Alterado na versão 3.3: @ref{23b2,,tolist()} agora suporta todos os formatos nativos de caracteres únicos na sintaxe do módulo @ref{d5,,struct}, assim como representações multi-dimensionais.

@end deffn

@geindex toreadonly() (método memoryview)
@anchor{library/stdtypes memoryview toreadonly}@anchor{23b7}
@deffn {Método} toreadonly ()

Retorna uma versão somente leitura do objeto memoryview. O objeto memoryview original não é alterado.

@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


Adicionado na versão 3.8.

@end deffn

@geindex release() (método memoryview)
@anchor{library/stdtypes memoryview release}@anchor{11fe}
@deffn {Método} release ()

Libera o buffer subjacente exposto pelo objeto memoryview. Muitos objetos aceitam ações especiais quando a view é mantida com eles (por exemplo, um @ref{2ea,,bytearray} iria temporariamente proibir o redimensionamento); portanto, chamar release() é útil para remover essas restrições (e liberar quaisquer recursos pendurados) o mais breve possível.

Depois que este método foi chamado, qualquer operação posterior na visão levanta um @ref{202,,ValueError} (exceto @ref{11fe,,release()}, o qual pode ser chamado múltiplas vezes):

@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

O protocolo de gerenciamento de contexto pode ser usado para efeitos similares, usando a instrução @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


Adicionado na versão 3.2.

@end deffn

@geindex cast() (método memoryview)
@anchor{library/stdtypes memoryview cast}@anchor{23b8}
@deffn {Método} cast (format, /)

@deffnx {Método} cast (format, shape, /)

Converte uma memoryview para um novo formato ou forma. `shape' por padrão é @code{[byte_length//new_itemsize]}, o que significa que a visão resultante será unidimensional. O valor de retorno é uma nova memoryview, mas o buffer por si mesmo não é copiado. Conversões suportadas são 1D -> C-@ref{23b9,,contíguo} r C-contíguo -> 1D.

O formato de destino é restrito a um elemento em formato nativo na sintaxe @ref{d5,,struct}. Um dos formatos deve ser um formato de byte (‘B’, ‘b’ ou ‘c’). O comprimento de bytes do resultado deve ser o mesmo que o comprimento original. Observe que todos os comprimentos de bytes podem depender do sistema operacional.

Converte de 1D/long para 1D/unsigned bytes:

@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

Converte de 1D/unsigned bytes para 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

Converte de 1D/bytes para 3D/ints para 1D/signed char:

@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

Converte 1D/unsigned long para 2D/unsigned long:

@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


Adicionado na versão 3.3.



Alterado na versão 3.5: O formato fonte não é mais restrito ao converter para uma visão de byte.

@end deffn

Existem também diversos atributos somente leitura disponíveis:

@geindex obj (atributo memoryview)
@anchor{library/stdtypes memoryview obj}@anchor{23ba}
@deffn {Atributo} obj

O objeto subjacente da memoryview:

@example
>>> b  = bytearray(b'xyz')
>>> m = memoryview(b)
>>> m.obj is b
True
@end example


Adicionado na versão 3.3.

@end deffn

@geindex nbytes (atributo memoryview)
@anchor{library/stdtypes memoryview nbytes}@anchor{23bb}
@deffn {Atributo} nbytes

@code{nbytes == product(shape) * itemsize == len(m.tobytes())}. Este é a quantidade de espaço em bytes que o array deve usar em uma representação contígua. Ela não é necessariamente 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

Arrays Multi-dimensional:

@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


Adicionado na versão 3.3.

@end deffn

@geindex readonly (atributo memoryview)
@anchor{library/stdtypes memoryview readonly}@anchor{23bc}
@deffn {Atributo} readonly

Um bool que indica se a memória é somente leitura.
@end deffn

@geindex format (atributo memoryview)
@anchor{library/stdtypes memoryview format}@anchor{23b4}
@deffn {Atributo} format

Uma string contendo o formato (no estilo do módulo @ref{d5,,struct}) para cada elemento na visão. Uma memoryview pode ser criada a partir de exportadores com strings de formato arbitrário, mas alguns métodos (ex: @ref{23b2,,tolist()}) são restritos a formatos de elementos nativos.


Alterado na versão 3.3: formato @code{'B'} agora é tratado de acordo com a sintaxe do módulo struct. Isso significa que @code{memoryview(b'abc')[0] == b'abc'[0] == 97}.

@end deffn

@geindex itemsize (atributo memoryview)
@anchor{library/stdtypes memoryview itemsize}@anchor{23b3}
@deffn {Atributo} itemsize

O tamanho em Bytes de cada elemento do 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 memoryview)
@anchor{library/stdtypes memoryview ndim}@anchor{23bd}
@deffn {Atributo} ndim

Um número inteiro que indica quantas dimensões de uma matriz multidimensional a memória representa.
@end deffn

@geindex shape (atributo memoryview)
@anchor{library/stdtypes memoryview shape}@anchor{23be}
@deffn {Atributo} shape

Uma tupla de inteiros de comprimento @ref{23bd,,ndim} dando a forma da memória como uma matriz N-dimensional.


Alterado na versão 3.3: Uma tupla vazia ao invés de @code{None} quando ndim = 0.

@end deffn

@geindex strides (atributo memoryview)
@anchor{library/stdtypes memoryview strides}@anchor{23bf}
@deffn {Atributo} strides

Uma tupla de inteiros de comprimento de @ref{23bd,,ndim} dando o tamanho em bytes para acessar cada elemento de cada dimensão da matriz.


Alterado na versão 3.3: Uma tupla vazia ao invés de @code{None} quando ndim = 0.

@end deffn

@geindex suboffsets (atributo memoryview)
@anchor{library/stdtypes memoryview suboffsets}@anchor{23c0}
@deffn {Atributo} suboffsets

Usado internamente para estilos de Arrays PIL. O valor é apenas informativo.
@end deffn

@geindex c_contiguous (atributo memoryview)
@anchor{library/stdtypes memoryview c_contiguous}@anchor{23c1}
@deffn {Atributo} c_contiguous

Um bool que indica se a memória é @ref{23b9,,contígua} C.


Adicionado na versão 3.3.

@end deffn

@geindex f_contiguous (atributo memoryview)
@anchor{library/stdtypes memoryview f_contiguous}@anchor{23c2}
@deffn {Atributo} f_contiguous

Um bool que indica se a memória é @ref{23b9,,contígua} Fortran.


Adicionado na versão 3.3.

@end deffn

@geindex contiguous (atributo memoryview)
@anchor{library/stdtypes memoryview contiguous}@anchor{23c3}
@deffn {Atributo} contiguous

Um bool que indica se a memória é @ref{23b9,,contígua}.


Adicionado na versão 3.3.

@end deffn
@end deffn

@node Tipo conjuntos — set frozenset,Tipo mapeamento — dict,Tipos de sequência binária — bytes bytearray memoryview,Tipos embutidos
@anchor{library/stdtypes set-types-set-frozenset}@anchor{23c4}@anchor{library/stdtypes types-set}@anchor{1dcf}
@subsection Tipo conjuntos — @code{set}, @code{frozenset}


@geindex objeto;set

Um objeto `conjunto' é uma coleção não ordenada de objetos @ref{610,,hasheáveis} distintos. Usos comuns incluem testes de associação, remover duplicatas de uma sequência e computar operações matemáticas tais como interseção, união, diferença e diferença simétrica. (Para outros tipos de contêineres veja as classes embutidas @ref{256,,dict}, @ref{611,,list} e @ref{370,,tuple}, e o módulo @ref{1d,,collections}.)

Assim como outras coleções, conjuntos suportam @code{x in set}, @code{len(set)} e @code{for x in set}. Sendo uma coleção não ordenada, conjuntos não armazenam posição de elementos ou ordem de inserção. Portanto, conjuntos não suportam indexação, fatiamento ou outros comportamentos de sequências ou similares.

Existem atualmente dois tipos de conjuntos embutidos, @ref{5d9,,set} e @ref{5da,,frozenset}. O tipo @ref{5d9,,set} é mutável – o conteúdo pode ser alterado usando métodos como @ref{2083,,add()} e @ref{23c5,,remove()}. Como ele é mutável, ele não tem valor hash e não pode ser usado como chave de dicionário ou um elemento de um outro conjunto. O tipo @ref{5da,,frozenset} é imutável e @ref{610,,hasheável} – seu conteúdo não pode ser alterado depois de ter sido criado; ele pode então ser usado como chave de dicionário ou como um elemento de outro conjunto.

Conjuntos não vazios (que não sejam frozensets) podem ser criados posicionando uma lista de elementos separados por vírgula dentro de chaves, por exemplo: @code{@{'jack', 'sjoerd'@}}, além do construtor @ref{5d9,,set}.

Os construtores de ambas as classes funcionam da mesma forma:

@geindex set (classe interna)
@geindex frozenset (classe interna)
@anchor{library/stdtypes set}@anchor{5d9}
@deffn {Classe} set (iterable=(), /)
@anchor{library/stdtypes frozenset}@anchor{5da}
@deffnx {Classe} frozenset (iterable=(), /)

Retorna um novo objeto set ou frozenset, cujos elementos são obtidos a partir de um `iterable'. Os elementos de um conjunto devem ser @ref{610,,hasheáveis}. Para representar conjuntos de sets, os sets internos devem ser objetos @ref{5da,,frozenset}. Se `iterable' não for especificado, um novo conjunto vazio é retornado.
@end deffn

Conjuntos podem ser criados de várias formas:


@itemize *

@item 
Usar uma lista de elementos separados por vírgulas entre chaves: @code{@{'jack', 'sjoerd'@}}

@item 
Usar uma compreensão de conjunto: @code{@{c for c in 'abracadabra' if c not in 'abc'@}}

@item 
Usar o construtor da classe: @code{set()}, @code{set('foobar')}, @code{set(['a', 'b', 'foo'])}
@end itemize

Instâncias de @ref{5d9,,set} e @ref{5da,,frozenset} fornecem as seguintes operações:


@deffn {Describe} len(s)

Retorna o número de elementos no set `s' (cardinalidade de `s').
@end deffn


@deffn {Describe} x in s

Testa se `x' pertence a `s'.
@end deffn


@deffn {Describe} x not in s

Testa se `x' não pertence a `s'.
@end deffn

@geindex isdisjoint() (método frozenset)
@geindex isdisjoint() (método set)
@anchor{library/stdtypes frozenset isdisjoint}@anchor{23c6}
@deffn {Método} frozenset.isdisjoint (other, /)
@anchor{library/stdtypes set isdisjoint}@anchor{23c7}
@deffnx {Método} set.isdisjoint (other, /)

Retorna @code{True} se o conjunto não tem elementos em comum com `other'. Conjuntos são disjuntos se e somente se a sua interseção é o conjunto vazio.
@end deffn

@geindex issubset() (método frozenset)
@geindex issubset() (método set)
@anchor{library/stdtypes frozenset issubset}@anchor{23c8}
@deffn {Método} frozenset.issubset (other, /)
@anchor{library/stdtypes set issubset}@anchor{23c9}
@deffnx {Método} set.issubset (other, /)
@end deffn


@deffn {Describe} set <= other

Testa se cada elemento do conjunto está contido em `other'.
@end deffn


@deffn {Describe} set < other

Testa se o conjunto é um subconjunto próprio de `other', isto é, @code{set <= other and set != other}.
@end deffn

@geindex issuperset() (método frozenset)
@geindex issuperset() (método set)
@anchor{library/stdtypes frozenset issuperset}@anchor{23ca}
@deffn {Método} frozenset.issuperset (other, /)
@anchor{library/stdtypes set issuperset}@anchor{1910}
@deffnx {Método} set.issuperset (other, /)
@end deffn


@deffn {Describe} set >= other

Testa se cada elemento em `other' está contido no conjunto.
@end deffn


@deffn {Describe} set > other

Testa se o conjunto é um superconjunto próprio de `other', isto é, @code{set >= other and set != other}.
@end deffn

@geindex union() (método frozenset)
@geindex union() (método set)
@anchor{library/stdtypes frozenset union}@anchor{14cb}
@deffn {Método} frozenset.union (*others)
@anchor{library/stdtypes set union}@anchor{23cb}
@deffnx {Método} set.union (*others)
@end deffn


@deffn {Describe} set | other | ...

Retorna um novo conjunto com elementos do conjunto e de todos os outros.
@end deffn

@geindex intersection() (método frozenset)
@geindex intersection() (método set)
@anchor{library/stdtypes frozenset intersection}@anchor{14cc}
@deffn {Método} frozenset.intersection (*others)
@anchor{library/stdtypes set intersection}@anchor{190f}
@deffnx {Método} set.intersection (*others)
@end deffn


@deffn {Describe} set & other & ...

Retorna um novo conjunto com elementos comuns do conjunto e de todos os outros.
@end deffn

@geindex difference() (método frozenset)
@geindex difference() (método set)
@anchor{library/stdtypes frozenset difference}@anchor{23cc}
@deffn {Método} frozenset.difference (*others)
@anchor{library/stdtypes set difference}@anchor{23cd}
@deffnx {Método} set.difference (*others)
@end deffn


@deffn {Describe} set @w{-} other @w{-} ...

Retorna um novo conjunto com elementos no conjunto que não estão nos outros.
@end deffn

@geindex symmetric_difference() (método frozenset)
@geindex symmetric_difference() (método set)
@anchor{library/stdtypes frozenset symmetric_difference}@anchor{23ce}
@deffn {Método} frozenset.symmetric_difference (other, /)
@anchor{library/stdtypes set symmetric_difference}@anchor{23cf}
@deffnx {Método} set.symmetric_difference (other, /)
@end deffn


@deffn {Describe} set ^ other

Retorna um novo conjunto com elementos estejam ou no conjunto ou em `other', mas não em ambos.
@end deffn

@geindex copy() (método frozenset)
@geindex copy() (método set)
@anchor{library/stdtypes frozenset copy}@anchor{23d0}
@deffn {Método} frozenset.copy ()
@anchor{library/stdtypes set copy}@anchor{23d1}
@deffnx {Método} set.copy ()

Retorna uma cópia rasa do conjunto.
@end deffn

Observe que, as versões não-operador dos métodos @ref{14cb,,union()}, @ref{14cc,,intersection()}, @ref{23cc,,difference()}, @ref{23ce,,symmetric_difference()}, @ref{23c8,,issubset()} e @ref{23ca,,issuperset()} irão aceitar qualquer iterável como um argumento. Em contraste, suas contrapartes baseadas em operadores exigem que seus argumentos sejam conjuntos. Isso impede construções suscetíveis a erros como @code{set('abc') & 'cbs'} e favorece a forma mais legível @code{set('abc').intersection('cbs')}.

Tanto @ref{5d9,,set} quanto @ref{5da,,frozenset} aceitam comparações entre conjuntos. Dois conjuntos são iguais se e somente se cada elemento de um está contido no outro (cada um é um subconjunto do outro). Um conjunto é menor que outro se, e somente se, o primeiro conjunto é um subconjunto adequado do segundo (é um subconjunto, mas não é igual). Um conjunto é maior que outro conjunto se, e somente se, o primeiro conjunto é um superconjunto próprio do segundo conjunto (é um superconjunto, mas não é igual).

Instâncias de @ref{5d9,,set} são comparadas a instâncias de @ref{5da,,frozenset} baseados nos seus membros. Por exemplo, @code{set('abc') == frozenset('abc')} retorna @code{True} e assim como @code{set('abc') in set([frozenset('abc')])}.

O subconjunto e comparações de igualdade não generalizam para a função de ordenamento total. Por exemplo, quaisquer dois conjuntos deslocados não vazios, não são iguais e não são subconjuntos um do outro, então `todos' os seguintes retornam @code{False}: @code{a<b}, @code{a==b} ou @code{a>b}.

Como conjuntos apenas definem ordenamento parcial (subconjunto de relacionamentos), a saída do método @ref{be8,,list.sort()} é indefinida para listas e conjuntos.

Elementos de conjuntos, assim como chaves de dicionário, devem ser @ref{610,,hasheáveis}.

Operações binárias que misturam instâncias de @ref{5d9,,set} com @ref{5da,,frozenset} retornam o tipo do primeiro operando. Por exemplo: @code{frozenset('ab') | set('bc')} retorna uma instância de @ref{5da,,frozenset}.

A seguinte tabela lista operações disponíveis para @ref{5d9,,set} que não se aplicam para instâncias imutáveis de @ref{5da,,frozenset}:

@geindex update() (método set)
@anchor{library/stdtypes set update}@anchor{23d2}
@deffn {Método} set.update (*others)
@end deffn


@deffn {Describe} set |= other | ...

Atualiza o conjunto, adicionando elementos dos outros.
@end deffn

@geindex intersection_update() (método set)
@anchor{library/stdtypes set intersection_update}@anchor{14cd}
@deffn {Método} set.intersection_update (*others)
@end deffn


@deffn {Describe} set &= other & ...

Atualiza o conjunto, mantendo somente elementos encontrados nele e em outros.
@end deffn

@geindex difference_update() (método set)
@anchor{library/stdtypes set difference_update}@anchor{23d3}
@deffn {Método} set.difference_update (*others)
@end deffn


@deffn {Describe} set @w{-}= other | ...

Atualiza o conjunto, removendo elementos encontrados em outros.
@end deffn

@geindex symmetric_difference_update() (método set)
@anchor{library/stdtypes set symmetric_difference_update}@anchor{14ce}
@deffn {Método} set.symmetric_difference_update (other, /)
@end deffn


@deffn {Describe} set ^= other

Atualiza o conjunto, mantendo somente elementos encontrados em qualquer conjunto, mas não em ambos.
@end deffn

@geindex add() (método set)
@anchor{library/stdtypes set add}@anchor{2083}
@deffn {Método} set.add (elem, /)

Adiciona o elemento `elem' ao conjunto.
@end deffn

@geindex remove() (método set)
@anchor{library/stdtypes set remove}@anchor{23c5}
@deffn {Método} set.remove (elem, /)

Remove o elemento `elem' do conjunto. Levanta @ref{344,,KeyError} se `elem' não estiver contido no conjunto.
@end deffn

@geindex discard() (método set)
@anchor{library/stdtypes set discard}@anchor{23d4}
@deffn {Método} set.discard (elem, /)

Remove o elemento `elem' do conjunto se ele estiver presente.
@end deffn

@geindex pop() (método set)
@anchor{library/stdtypes set pop}@anchor{23d5}
@deffn {Método} set.pop ()

Remove e retorna um elemento arbitrário do conjunto. Levanta @ref{344,,KeyError} se o conjunto estiver vazio.
@end deffn

@geindex clear() (método set)
@anchor{library/stdtypes set clear}@anchor{23d6}
@deffn {Método} set.clear ()

Remove todos os elementos do conjunto.
@end deffn

Perceba, as versões sem operador dos métodos @ref{23d2,,update()}, @ref{14cd,,intersection_update()}, @ref{23d3,,difference_update()} e @ref{14ce,,symmetric_difference_update()} irão aceitar qualquer iterável como um argumento.

Perceba, o argumento `elem' para os métodos @ref{1400,,__contains__()}, @ref{23c5,,remove()} e @ref{23d4,,discard()} pode ser um conjunto. Para suportar pesquisas por um frozenset equivalente, um frozenset temporário é criado a partir de `elem'.

@node Tipo mapeamento — dict,Tipos de Gerenciador de Contexto,Tipo conjuntos — set frozenset,Tipos embutidos
@anchor{library/stdtypes mapping-types-dict}@anchor{23d7}@anchor{library/stdtypes typesmapping}@anchor{ad6}
@subsection Tipo mapeamento — @code{dict}


@geindex objeto;mapeamento
@geindex objeto;dicionário
@geindex operações em;mapeamento;types
@geindex operações em;dicionário;tipo
@geindex instrução;del
@geindex função embutida;len

Um objeto @ref{11fb,,mapeamento} mapeia valores @ref{610,,hasheáveis} para objetos arbitrários. Mapeamentos são objetos mutáveis. Existe no momento apenas um tipo de mapeamento padrão, o `dicionário'. (Para outros contêineres, veja as classes embutidas @ref{611,,list}, @ref{5d9,,set} e @ref{370,,tuple}, e o módulo @ref{1d,,collections}.)

As chaves de um dicionário são `quase' valores arbitrários. Valores que não são @ref{610,,hasheáveis}, ou seja, valores contendo listas, dicionários ou outros tipos mutáveis (que são comparados por valor e não por identidade de objeto) não podem ser usados como chaves. Valores que comparam iguais (como @code{1}, @code{1.0} e @code{True}) podem ser usados alternadamente para indexar a mesma entrada do dicionário.

@geindex dict (classe interna)
@anchor{library/stdtypes dict}@anchor{256}
@deffn {Classe} dict (**kwargs)

@deffnx {Classe} dict (mapping, /, **kwargs)

@deffnx {Classe} dict (iterable, /, **kwargs)

Retorna um novo dicionário inicializado a partir de um argumento posicional opcional, e um conjunto de argumentos nomeados possivelmente vazio.

Os dicionários podem ser criados de várias formas:


@itemize *

@item 
Usar uma lista de pares @code{key: value} separados por vírgula com chaves: @code{@{'jack': 4098, 'sjoerd': 4127@}} ou @code{@{4098: 'jack', 4127: 'sjoerd'@}}

@item 
Usar uma compreensão de dicionário: @code{@{@}}, @code{@{x: x ** 2 for x in range(10)@}}

@item 
Usar o construtor de tipo: @code{dict()}, @code{dict([('foo', 100), ('bar', 200)])}, @code{dict(foo=100, bar=200)}
@end itemize

Se nenhum argumento posicional é fornecido, um dicionário vazio é criado. Se um argumento posicional é fornecido e ele define um método @code{keys()}, um dicionário é criado chamando @ref{283,,__getitem__()} no argumento com cada chave retornada pelo método. Caso contrário, o argumento posicional deve ser um objeto @ref{1268,,iterável}. Cada item no iterável deve ser por si mesmo um iterável com exatamente dois elementos. O primeiro elemento de cada item torna-se a chave no novo dicionário, e o segundo elemento, o valor correspondente. Se a chave ocorrer mais do que uma vez, o último valor para aquela chave torna-se o valor correspondente no novo dicionário.

Se argumentos nomeados são fornecidos, os argumentos nomeados e seus valores são adicionados ao dicionário criado a partir do argumento posicional. Se uma chave sendo adicionada já está presente, o valor do argumento nomeado substitui o valor do argumento posicional.

Dicionários são iguais se e somente se eles os mesmos pares @code{(key, value)} (independente de ordem). Comparações de ordem (‘<’, ‘<=’, ‘>=’, ‘>’) levantam @ref{2c3,,TypeError}. Para ilustrar a criação e igualdade de dicionários, os exemplos a seguir retornam um dicionário igual a @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

Fornecer argumentos nomeados conforme no primeiro exemplo somente funciona para chaves que são identificadores válidos no Python. Caso contrário, quaisquer chaves válidas podem ser usadas.

Dicionários preservam a ordem de inserção. Perceba que atualizar a chave não afeta a ordem. Chaves adicionadas após a deleção são inseridas no final.

@example
>>> d = @{"um": 1, "dois": 2, "três": 3, "quatro": 4@}
>>> d
@{'um': 1, 'dois': 2, 'três': 3, 'quatro': 4@}
>>> list(d)
['um', 'dois', 'três', 'quatro']
>>> list(d.values())
[1, 2, 3, 4]
>>> d["um"] = 42
>>> d
@{'um': 42, 'dois': 2, 'três': 3, 'quatro': 4@}
>>> del d["dois"]
>>> d["dois"] = None
>>> d
@{'um': 42, 'três': 3, 'quatro': 4, 'dois': None@}
@end example


Alterado na versão 3.7: Ordem do dicionário é garantida conforme a ordem de inserção. Este comportamento era um detalhe de implementação do CPython a partir da versão 3.6.


Estas são as operações que dicionários aceitam (e, portanto, tipos de mapeamento personalizados devem aceitar também):


@deffn {Describe} list(d)

Retorna uma lista de todas as chaves usadas no dicionário `d'.
@end deffn


@deffn {Describe} len(d)

Retorna o número de itens no dicionário `d'.
@end deffn


@deffn {Describe} d[key]

Retorna o item de `d' com a chave `key'. Levanta um @ref{344,,KeyError} se `key' não estiver no mapeamento.

@geindex __missing__()

Se uma subclasse de um dict define um método @ref{11fd,,__missing__()} e `key' não estiver presente, a operação @code{d[key]} chama aquele método com a chave `key' como argumento. A operação @code{d[key]} então retorna ou levanta o que é retornado ou levantado pela chamada de @code{__missing__(key)}. Nenhuma operação ou métodos invocam @ref{11fd,,__missing__()}. Se @ref{11fd,,__missing__()} não for definido, então @ref{344,,KeyError} é levantada. @ref{11fd,,__missing__()} deve ser um método; ele não pode ser uma variável de instância:

@example
>>> class Counter(dict):
...     def __missing__(self, key):
...         return 0
...
>>> c = Counter()
>>> c['red']
0
>>> c['red'] += 1
>>> c['red']
1
@end example

O exemplo acima mostra parte da implementação de @ref{10d0,,collections.Counter}. Um método @code{__missing__()} diferente é usado para @ref{11fc,,collections.defaultdict}.
@end deffn


@deffn {Describe} d[key] = value

Define @code{d[key]} para `value'.
@end deffn


@deffn {Describe} del d[key]

Remove @code{d[key]} do `d'. Levanta uma exceção @ref{344,,KeyError} se `key' não estiver no mapeamento.
@end deffn


@deffn {Describe} key in d

Retorna @code{True} se `d' tiver uma chave `key', caso contrário @code{False}.
@end deffn


@deffn {Describe} key not in d

Equivalente a @code{not key in d}.
@end deffn


@deffn {Describe} iter(d)

Retorna um iterador para as chaves do dicionário. Isso é um atalho para @code{iter(d.keys())}.
@end deffn

@geindex clear() (método dict)
@anchor{library/stdtypes dict clear}@anchor{15e2}
@deffn {Método} clear ()

Remove todos os itens do dicionário.
@end deffn

@geindex copy() (método dict)
@anchor{library/stdtypes dict copy}@anchor{be9}
@deffn {Método} copy ()

Retorna uma cópia superficial do dicionário.
@end deffn

@geindex fromkeys() (método de classe dict)
@anchor{library/stdtypes dict fromkeys}@anchor{1637}
@deffn {Método} classmethod fromkeys (iterable, value=None, /)

Cria um novo dicionário com chaves provenientes de `iterable' e valores definidos como `value'.

@ref{1637,,fromkeys()} é um método de classe que retorna um novo dicionário. `value' tem como valor padrão @code{None}. Todos os valores referem-se a apenas uma única instância, então geralmente não faz sentido que `value' seja um objeto mutável tal como uma lista vazia. Para obter valores distintos, use uma @ref{da7,,compreensão de dicionário} ao invés.
@end deffn

@geindex get() (método dict)
@anchor{library/stdtypes dict get}@anchor{1dd2}
@deffn {Método} get (key, default=None, /)

Retorna o valor para `key' se `key' está no dicionário, caso contrário `default'. Se `default' não é fornecido, será usado o valor padrão @code{None}, de tal forma que este método nunca levanta um @ref{344,,KeyError}.
@end deffn

@geindex items() (método dict)
@anchor{library/stdtypes dict items}@anchor{7d0}
@deffn {Método} items ()

Retorna uma nova visão dos itens do dicionário (pares de @code{(key, value)}). Veja a @ref{23d8,,documentação de objetos de visão de dicionário}.
@end deffn

@geindex keys() (método dict)
@anchor{library/stdtypes dict keys}@anchor{7ce}
@deffn {Método} keys ()

Retorna uma nova visão das chaves do dicionário. Veja a @ref{23d8,,documentação de objetos de visão de dicionário}.
@end deffn

@geindex pop() (método dict)
@anchor{library/stdtypes dict pop}@anchor{343}
@deffn {Método} pop (key, /)

@deffnx {Método} pop (key, default, /)

Se `key' está no dicionário, remove a mesma e retorna o seu valor, caso contrário retorna `default'. Se `default' não foi fornecido e `key' não está no dicionário, um @ref{344,,KeyError} é levantado.
@end deffn

@geindex popitem() (método dict)
@anchor{library/stdtypes dict popitem}@anchor{156f}
@deffn {Método} popitem ()

Remove e retorna um par @code{(key, value)} do dicionário. Pares são retornados como uma pilha, ou seja em ordem @abbr{LIFO,last-in@comma{} first-out}.

@ref{156f,,popitem()} é útil para destrutivamente iterar sobre um dicionário, algo comumente usado em algoritmos de conjunto. Se o dicionário estiver vazio, chamar @ref{156f,,popitem()} levanta um @ref{344,,KeyError}.


Alterado na versão 3.7: Ordem LIFO agora é garantida. Em versões anteriores, @ref{156f,,popitem()} iria retornar um par chave/valor arbitrário.

@end deffn


@deffn {Describe} reversed(d)

Retorna um iterador revertido sobre as chaves do dicionário. Isso é um atalho para @code{reversed(d.keys())}.


Adicionado na versão 3.8.

@end deffn

@geindex setdefault() (método dict)
@anchor{library/stdtypes dict setdefault}@anchor{10b2}
@deffn {Método} setdefault (key, default=None, /)

Se `key' está no dicionário, retorna o seu valor. Se não, insere `key' com o valor `default' e retorna `default'. `default' por padrão usa o valor @code{None}.
@end deffn

@geindex update() (método dict)
@anchor{library/stdtypes dict update}@anchor{14ad}
@deffn {Método} update (**kwargs)

@deffnx {Método} update (mapping, /, **kwargs)

@deffnx {Método} update (iterable, /, **kwargs)

Atualiza o dicionário com os pares chave/valor de `mapping' ou `iterable' e `kwargs', sobrescrevendo chaves existentes. Retorna @code{None}.

@ref{14ad,,update()} aceita ou outro objeto com um método @code{keys()} (em cada caso @ref{283,,__getitem__()} é chamado com cada chave retornada pelo método) ou um iterável de pares de chave/valor (como tuplas ou outros iteráveis de comprimento dois). Se argumentos nomeados são especificados, o dicionário é então atualizado com esses pares de chave/valor: @code{d.update(red=1, blue=2)}.
@end deffn

@geindex values() (método dict)
@anchor{library/stdtypes dict values}@anchor{7cf}
@deffn {Método} values ()

Retorna uma nova visão dos valores do dicionário. Veja a @ref{23d8,,documentação de objetos de visão de dicionário}.

Uma comparação de igualdade entre uma visão de @code{dict.values()} e outra, sempre irá retornar @code{False}. Isso também se aplica ao comparar @code{dict.values()} entre si:

@example
>>> d = @{'a': 1@}
>>> d.values() == d.values()
False
@end example
@end deffn


@deffn {Describe} d | other

Cria um novo dicionário com as chaves e os valores mesclados de `d' e `other', que devem ser dicionários. Os valores de `other' têm prioridade quando `d' e `other' compartilham chaves.


Adicionado na versão 3.9.

@end deffn


@deffn {Describe} d |= other

Atualiza o dicionário `d' com chaves e valores de `other', que podem ser a @ref{11fb,,mapeamento} ou um @ref{1268,,iterável} dos pares chave/valor. Os valores de `other' têm prioridade quando `d' e `other' compartilham chaves.


Adicionado na versão 3.9.

@end deffn

Dicionários e visões de dicionários são reversíveis.

@example
>>> d = @{"um": 1, "dois": 2, "três": 3, "quatro": 4@}
>>> d
@{'um': 1, 'dois': 2, 'três': 3, 'quatro': 4@}
>>> list(reversed(d))
['quatro', 'três', 'dois', 'um']
>>> list(reversed(d.values()))
[4, 3, 2, 1]
>>> list(reversed(d.items()))
[('quatro', 4), ('três', 3), ('dois', 2), ('um', 1)]
@end example


Alterado na versão 3.8: Dicionários agora são reversíveis.

@end deffn


@subsubheading Ver também


@ref{46d,,types.MappingProxyType} podem ser usados para criar uma visão somente leitura de um @ref{256,,dict}.


@menu
* Objetos de visão de dicionário:: 

@end menu

@node Objetos de visão de dicionário,,,Tipo mapeamento — dict
@anchor{library/stdtypes dict-views}@anchor{23d8}@anchor{library/stdtypes dictionary-view-objects}@anchor{23d9}
@subsubsection Objetos de visão de dicionário


Os objetos retornados por @ref{7ce,,dict.keys()}, @ref{7cf,,dict.values()} e @ref{7d0,,dict.items()} são `objetos de visão'. Eles fornecem uma visão dinâmica das entradas do dicionário, o que significa que quando o dicionário muda, a visão reflete essas mudanças.

Visões de dicionários podem ser iteradas para apresentar seus respectivos dados, e suportar testes de existência:


@deffn {Describe} len(dictview)

Retorna o número de entradas no dicionário.
@end deffn


@deffn {Describe} iter(dictview)

Retorna um iterador sobre as chaves, valores ou itens (representados como tuplas de @code{(key, value)}) no dicionário.

Chaves e valores são iterados em ordem de inserção. Isso permite a criação de pares @code{(value, key)} usando @ref{7d1,,zip()}: @code{pairs = zip(d.values(), d.keys())}. Outra maneira de criar a mesma lista é @code{pairs = [(v, k) for (k, v) in d.items()]}.

Iterar sobre visões enquanto adiciona ou deleta entradas no dicionário pode levantar um @ref{195,,RuntimeError} ou falhar a iteração sobre todas as entradas.


Alterado na versão 3.7: Ordem do dicionário é garantida como a ordem de inserção.

@end deffn


@deffn {Describe} x in dictview

Retorna @code{True} se `x' está nas chaves, valores ou itens do dicionário subjacente (no último caso, `x' deve ser uma tupla de @code{(key, value)}).
@end deffn


@deffn {Describe} reversed(dictview)

Retorna um iterador reverso sobre as chaves, valores ou itens do dicionário. A visão será iterada na ordem reversa de inserção.


Alterado na versão 3.8: Visões de dicionário agora são reversíveis.

@end deffn


@deffn {Describe} dictview.mapping

Retorna um @ref{46d,,types.MappingProxyType} que envolve o dicionário original ao qual a visão se refere.


Adicionado na versão 3.10.

@end deffn

Visões chave são similar a conjunto, como suas entradas são únicas e @ref{610,,hasheáveis}. As visões de itens também têm operações semelhantes a conjuntos, uma vez que os pares (chave, valor) são únicos e as chaves são hasheáveis. Se todos os valores em uma visão de itens também forem hasheáveis, a visão de itens poderá interoperar com outros conjuntos. (Visões de valores não são tratadas de como similar a conjunto, pois as entradas geralmente não são únicas.) Para visões similares a conjunto, todas as operações definidas para a classe base abstrata @ref{23da,,collections.abc.Set} estão disponíveis (por exemplo, @code{==}, @code{<} ou @code{^}). Ao usar operadores de conjunto, visões de conjunto ou similares aceitam qualquer iterável como outro operando, ao contrário de conjuntos que aceitam apenas conjuntos como entrada.

Um exemplo da utilização da visualização de dicionário:

@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

>>> # a iteração sobre chaves e valores é feita na mesma ordem (ordem de inserção)
>>> list(keys)
['eggs', 'sausage', 'bacon', 'spam']
>>> list(values)
[2, 1, 1, 500]

>>> # objetos de visualização são dinâmicos e refletem mudanças no dicionário
>>> del dishes['eggs']
>>> del dishes['sausage']
>>> list(keys)
['bacon', 'spam']

>>> # operações de conjunto
>>> keys & @{'eggs', 'bacon', 'salad'@}
@{'bacon'@}
>>> keys ^ @{'sausage', 'juice'@} == @{'juice', 'sausage', 'bacon', 'spam'@}
True
>>> keys | ['juice', 'juice', 'juice'] == @{'bacon', 'spam', 'juice'@}
True

>>> # recupera um proxy somente de leitura para o dicionário original
>>> values.mapping
mappingproxy(@{'bacon': 1, 'spam': 500@})
>>> values.mapping['spam']
500
@end example

@node Tipos de Gerenciador de Contexto,Tipos de anotação de tipo — Apelido genérico União,Tipo mapeamento — dict,Tipos embutidos
@anchor{library/stdtypes context-manager-types}@anchor{23db}@anchor{library/stdtypes typecontextmanager}@anchor{214e}
@subsection Tipos de Gerenciador de Contexto


@geindex gerenciador de contexto
@geindex protocolo de gerenciamento de contexto
@geindex protocolo;gerenciamento de contexto

A instrução @ref{5d2,,with} do Python suporta o conceito de um contexto em tempo de execução definido por um gerenciador de contexto. Isto é implementado usando um par de métodos, que permitem que classes definidas pelo usuário especifiquem um contexto em tempo de execução, o qual é inicializado antes da execução das instruções, e encerrado quando as instruções terminam:

@geindex __enter__() (método contextmanager)
@anchor{library/stdtypes contextmanager __enter__}@anchor{23dc}
@deffn {Método} contextmanager.__enter__ ()

Entra no contexto em tempo de execução e retorna este objeto ou outro objeto relacionado ao contexto em tempo de execução. O valor retornado por este método é ligado ao identificador na cláusula @code{as} das instruções @ref{5d2,,with} usando este gerenciador de contexto.

Um exemplo de gerenciador de contexto que retorna a si mesmo é um @ref{1203,,objeto arquivo}. Objeto arquivos retornam a si mesmos do método __enter__() para permitir que @ref{51c,,open()} seja usado como a expressão de contexto em uma instrução @ref{5d2,,with}.

Um exemplo de gerenciador de contexto que retorna um objeto relacionado é aquele retornado por @ref{13cd,,decimal.localcontext()}. Esses gerenciadores definem o contexto decimal ativo para uma cópia do contexto decimal original, e então retornam a cópia. Isso permite que mudanças sejam feitas no contexto decimal atual, no corpo contido na instrução @ref{5d2,,with}, sem afetar o código fora da instrução @code{with}.
@end deffn

@geindex __exit__() (método contextmanager)
@anchor{library/stdtypes contextmanager __exit__}@anchor{23dd}
@deffn {Método} contextmanager.__exit__ (exc_type, exc_val, exc_tb)

Sai do contexto em tempo de execução e retorna um sinalizador booleano indicando se qualquer exceção que ocorreu deve ser suprimida. Se uma exceção ocorreu enquanto era executado o corpo da instrução @ref{5d2,,with}, os argumentos contêm o tipo da exceção, valor e informação da traceback (situação da pilha de execução). Caso contrário, os três argumentos são @code{None}.

Returning a true value from this method will cause the @ref{5d2,,with} statement
to suppress the exception and continue execution with the statement immediately
following the @code{with} statement. Otherwise the exception continues
propagating after this method has finished executing.

If this method raises an exception while handling an earlier exception from the
@ref{5d2,,with} block, the new exception is raised, and the original exception
is stored in its @ref{130a,,__context__} attribute.

A exceção passada nunca deve ser re-levantada explicitamente - ao invés disso, este método deve retornar um valor falso para indicar que o método completou sua execução com sucesso, e não quer suprimir a exceção levantada. Isso permite ao código do gerenciador de contexto facilmente detectar se um método @ref{1344,,__exit__()} realmente falhou ou não.
@end deffn

Python define diversos gerenciadores de contexto para suportar facilmente sincronização de threads, solicita o fechamento de arquivos ou outros objetos, e manipula de forma simples o contexto ativo de aritmética decimal. Os tipos especificados não são tratados de forma especial além da sua implementação e do protocolo do gerenciador de contexto. Veja o módulo @ref{23,,contextlib} para alguns exemplos.

Os @ref{109a,,gerador}es do Python e o decorador @ref{1242,,contextlib.contextmanager} fornecem uma maneira conveniente de implementar esses protocolos. Se uma função geradora for decorada com o decorador @ref{1242,,contextlib.contextmanager}, ela retornará um gerenciador de contexto implementando os métodos necessários @ref{23dc,,__enter__()} e @ref{23dd,,__exit__()}, em vez de o iterador produzido por uma função geradora não decorada.

Observe que não existe nenhum slot específico para qualquer um desses métodos na estrutura de tipos para objetos Python na API Python/C. Tipos de extensão que desejam definir estes métodos devem fornecê-los como um método acessível normal do Python. Comparado com a sobrecarga de configurar o contexto em tempo de execução, a sobrecarga na pesquisa de dicionário em uma única classe é negligenciável.

@node Tipos de anotação de tipo — Apelido genérico União,Outros tipos embutidos,Tipos de Gerenciador de Contexto,Tipos embutidos
@anchor{library/stdtypes type-annotation-types-generic-alias-union}@anchor{23de}
@subsection Tipos de anotação de tipo — Apelido genérico, União


@geindex anotação;tipo@comma{} anotação de; tipo@comma{} dica de

Os principais tipos embutidos para @ref{458,,anotações de tipo} são @ref{6b2,,Apelido genérico} e @ref{7c3,,União}.

@menu
* Tipo Generic Alias:: 
* Tipo União:: 

@end menu

@node Tipo Generic Alias,Tipo União,,Tipos de anotação de tipo — Apelido genérico União
@anchor{library/stdtypes generic-alias-type}@anchor{23df}@anchor{library/stdtypes types-genericalias}@anchor{6b2}
@subsubsection Tipo Generic Alias


@geindex objeto;GenericAlias
@geindex Generic;Alias

Objetos @code{GenericAlias} são geralmente criados @ref{2110,,subscrevendo} uma classe. Eles são mais usados com @ref{2116,,classes contêineres}, como @ref{611,,list} ou @ref{256,,dict}. Por exemplo, @code{list[int]} é um objeto @code{GenericAlias} criado pela subscrição da classe @code{list} com o argumento @ref{257,,int}. Objetos @code{GenericAlias} são destinados principalmente para uso com @ref{458,,anotações de tipo}.

@cartouche
@quotation Nota 
Geralmente só é possível subscrever uma classe se a classe implementar o método especial @ref{73b,,__class_getitem__()}.
@end quotation
@end cartouche

Um objeto @code{GenericAlias} atua como um proxy para um @ref{439,,tipo genérico}, implementando `genéricos parametrizados'.

Para uma classe contêiner, o(s) argumento(s) fornecido(s) para uma @ref{2110,,subscrição} da classe pode indicar o(s) tipo(s) dos elementos que um objeto contém. Por exemplo, @code{set[bytes]} pode ser usado em anotações de tipo para significar um @ref{5d9,,set} em que todos os elementos são do tipo @ref{1c2,,bytes}.

Para uma classe que define @ref{73b,,__class_getitem__()}, mas não é um contêiner, o(s) argumento(s) fornecido(s) para uma subscrição da classe geralmente indicará o(s) tipo(s) de retorno de um ou mais métodos definidos em um objeto. Por exemplo, @ref{b9,,expressões regulares} podem ser usadas tanto no tipo de dados @ref{44c,,str} quanto no tipo de dados @ref{1c2,,bytes}:


@itemize *

@item 
Se @code{x = re.search('foo', 'foo')}, @code{x} será um objeto @ref{fbc,,re.Match} onde os valores de retorno de @code{x.group(0)} e @code{x[0]} serão ambos do tipo @ref{44c,,str}. Podemos representar este tipo de objeto em anotações de tipo com o @code{GenericAlias} @code{re.Match[str]}.

@item 
Se @code{y = re.search(b'bar', b'bar')} (observe o @code{b} para @ref{1c2,,bytes}), @code{y} também será uma instância de @code{re.Match}, mas os valores de retorno de @code{y.group(0)} e @code{y[0]} serão ambos do tipo @ref{1c2,,bytes}. Em anotações de tipo, representaríamos esta variedade de objetos @ref{fbc,,re.Match} com @code{re.Match[bytes]}.
@end itemize

Objetos @code{GenericAlias} são instâncias da classe @ref{7ed,,types.GenericAlias}, que também podem ser usadas para criar objetos @code{GenericAlias} diretamente.


@deffn {Describe} T[X, Y, ...]

Cria um @code{GenericAlias} representando um tipo @code{T} parametrizado por tipos `X', `Y' e mais, dependendo do @code{T} usados. Por exemplo, uma função esperando uma @ref{611,,list} contendo elementos @ref{2f7,,float}:

@example
def average(values: list[float]) -> float:
    return sum(values) / len(values)
@end example

Outro exemplo para @ref{11fb,,mapeamento} de objetos, usando um @ref{256,,dict}, o qual é um tipo genérico esperando 2 tipos de parâmetros representando o tipo da chave e o tipo do valor. Neste exemplo, a função espera um @code{dict} com chaves do tipo @ref{44c,,str} e valores do tipo @ref{257,,int}:

@example
def send_post_request(url: str, body: dict[str, int]) -> None:
    ...
@end example
@end deffn

As funções embutidas @ref{442,,isinstance()} e @ref{7c2,,issubclass()} não aceitam tipos @code{GenericAlias} para o seu 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

O runtime Python não obriga @ref{458,,anotações de tipo}. Isso se aplica a tipos genéricos e seus parâmetros tipados. Ao criar um objeto contêiner a partir de um @code{GenericAlias}, os elementos no contêiner não são verificados pelo seu tipo. Por exemplo, o seguinte código é desencorajado, mas irá executar sem erros:

@example
>>> t = list[str]
>>> t([1, 2, 3])
[1, 2, 3]
@end example

Além disso, genéricos parametrizados removem parâmetros tipados durante a criação do objeto:

@example
>>> t = list[str]
>>> type(t)
<class 'types.GenericAlias'>

>>> l = t()
>>> type(l)
<class 'list'>
@end example

Chamar @ref{800,,repr()} ou @ref{44c,,str()} sobre um genérico mostra o tipo parametrizado:

@example
>>> repr(list[int])
'list[int]'

>>> str(list[int])
'list[int]'
@end example

O método @ref{283,,__getitem__()} de contêineres genéricos irá levantar uma exceção para não permitir erros como @code{dict[str][str]}:

@example
>>> dict[str][str]
Traceback (most recent call last):
  ...
TypeError: dict[str] is not a generic class
@end example

Entretanto, tais expressões são válidas quando @ref{210b,,type variáveis} são usadas. O índice deve ter tantos elementos quantos forem os itens de variável de tipo no objeto @code{GenericAlias} @ref{23e0,,__args__}.

@example
>>> from typing import TypeVar
>>> Y = TypeVar('Y')
>>> dict[str, Y][int]
dict[str, int]
@end example

@menu
* Classes genéricas padrão:: 
* Atributos especiais de objetos GenericAlias:: 

@end menu

@node Classes genéricas padrão,Atributos especiais de objetos GenericAlias,,Tipo Generic Alias
@anchor{library/stdtypes standard-generic-classes}@anchor{23e1}
@subsubsection Classes genéricas padrão


As seguintes classes de biblioteca padrão oferecem suporte a genéricos parametrizados. Esta lista não é exaustiva.


@itemize *

@item 
@ref{370,,tuple}

@item 
@ref{611,,list}

@item 
@ref{256,,dict}

@item 
@ref{5d9,,set}

@item 
@ref{5da,,frozenset}

@item 
@ref{d6b,,type}

@item 
@ref{be6,,asyncio.Future}

@item 
@ref{1be,,asyncio.Task}

@item 
@ref{5dc,,collections.deque}

@item 
@ref{11fc,,collections.defaultdict}

@item 
@ref{5db,,collections.OrderedDict}

@item 
@ref{10d0,,collections.Counter}

@item 
@ref{c36,,collections.ChainMap}

@item 
@ref{e06,,collections.abc.Awaitable}

@item 
@ref{e07,,collections.abc.Coroutine}

@item 
@ref{e09,,collections.abc.AsyncIterable}

@item 
@ref{e08,,collections.abc.AsyncIterator}

@item 
@ref{ca8,,collections.abc.AsyncGenerator}

@item 
@ref{23e2,,collections.abc.Iterable}

@item 
@ref{23e3,,collections.abc.Iterator}

@item 
@ref{e05,,collections.abc.Generator}

@item 
@ref{ca6,,collections.abc.Reversible}

@item 
@ref{23e4,,collections.abc.Container}

@item 
@ref{ca5,,collections.abc.Collection}

@item 
@ref{7ec,,collections.abc.Callable}

@item 
@ref{23da,,collections.abc.Set}

@item 
@ref{23e5,,collections.abc.MutableSet}

@item 
@ref{8d0,,collections.abc.Mapping}

@item 
@ref{10eb,,collections.abc.MutableMapping}

@item 
@ref{1204,,collections.abc.Sequence}

@item 
@ref{1a1,,collections.abc.MutableSequence}

@item 
@ref{2e7,,collections.abc.ByteString}

@item 
@ref{23e6,,collections.abc.MappingView}

@item 
@ref{23e7,,collections.abc.KeysView}

@item 
@ref{23e8,,collections.abc.ItemsView}

@item 
@ref{23e9,,collections.abc.ValuesView}

@item 
@ref{cab,,contextlib.AbstractContextManager}

@item 
@ref{b3d,,contextlib.AbstractAsyncContextManager}

@item 
@ref{23ea,,dataclasses.Field}

@item 
@ref{541,,functools.cached_property}

@item 
@ref{a85,,functools.partialmethod}

@item 
@ref{c6c,,os.PathLike}

@item 
@ref{23eb,,queue.LifoQueue}

@item 
@ref{13db,,queue.Queue}

@item 
@ref{23ec,,queue.PriorityQueue}

@item 
@ref{b80,,queue.SimpleQueue}

@item 
@ref{fbb,,re.Pattern}

@item 
@ref{fbc,,re.Match}

@item 
@ref{23ed,,shelve.BsdDbShelf}

@item 
@ref{23ee,,shelve.DbfilenameShelf}

@item 
@ref{fcf,,shelve.Shelf}

@item 
@ref{46d,,types.MappingProxyType}

@item 
@ref{1ae6,,weakref.WeakKeyDictionary}

@item 
@ref{1025,,weakref.WeakMethod}

@item 
@ref{5dd,,weakref.WeakSet}

@item 
@ref{1ae5,,weakref.WeakValueDictionary}
@end itemize

@node Atributos especiais de objetos GenericAlias,,Classes genéricas padrão,Tipo Generic Alias
@anchor{library/stdtypes special-attributes-of-genericalias-objects}@anchor{23ef}
@subsubsection Atributos especiais de objetos @code{GenericAlias}


Todos os genéricos parametrizados implementam atributos especiais somente leitura.

@geindex __origin__ (atributo genericalias)
@anchor{library/stdtypes genericalias __origin__}@anchor{23f0}
@deffn {Atributo} genericalias.__origin__

Este atributo aponta para a classe genérica não parametrizada:

@example
>>> list[int].__origin__
<class 'list'>
@end example
@end deffn

@geindex __args__ (atributo genericalias)
@anchor{library/stdtypes genericalias __args__}@anchor{23e0}
@deffn {Atributo} genericalias.__args__

Este atributo é uma @ref{370,,tuple} (possivelmente de comprimento 1) de tipos genéricos passado para o método @ref{73b,,__class_getitem__()} original da classe genérica:

@example
>>> dict[str, list[int]].__args__
(<class 'str'>, list[int])
@end example
@end deffn

@geindex __parameters__ (atributo genericalias)
@anchor{library/stdtypes genericalias __parameters__}@anchor{23f1}
@deffn {Atributo} genericalias.__parameters__

O atributo é uma tupla computada preguiçosamente (possivelmente vazia) de variáveis de tipo único encontradas em @code{__args__}:

@example
>>> from typing import TypeVar

>>> T = TypeVar('T')
>>> list[T].__parameters__
(~T,)
@end example

@cartouche
@quotation Nota 
Um objeto @code{GenericAlias} com os parâmetros @ref{15e,,typing.ParamSpec} pode não ter @code{__parameters__} correto após a substituição porque @ref{15e,,typing.ParamSpec} se destina principalmente à verificação de tipo estático.
@end quotation
@end cartouche
@end deffn

@geindex __unpacked__ (atributo genericalias)
@anchor{library/stdtypes genericalias __unpacked__}@anchor{23f2}
@deffn {Atributo} genericalias.__unpacked__

Um booleano que é true se o apelido foi desempacotado usando o operador @code{*} (consulte @ref{15f,,TypeVarTuple}).


Adicionado na versão 3.11.

@end deffn


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - Dicas de tipo

Apresentando a estrutura do Python para anotações de tipo.

@geindex Propostas de Melhorias do Python; PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - Sugestão de tipo para Genéricos em coleções padrão

Apresentando a capacidade de parametrizar nativamente as classes da biblioteca padrão, desde que implementem o método de classe especial @ref{73b,,__class_getitem__()}.

@item @ref{210b,,Genéricos}, @ref{4cf,,genéricos definidos pelo usuário} e @ref{15d7,,typing.Generic}

Documentação sobre como implementar classes genéricas que podem ser parametrizadas em tempo de execução e compreendidas por verificadores de tipo estático.
@end table



Adicionado na versão 3.9.


@node Tipo União,,Tipo Generic Alias,Tipos de anotação de tipo — Apelido genérico União
@anchor{library/stdtypes types-union}@anchor{7c3}@anchor{library/stdtypes union-type}@anchor{23f3}
@subsubsection Tipo União


@geindex objeto;União
@geindex união;tipo

Um objeto união contém o valor da operação @code{|} (bit a bit ou) em vários @ref{2317,,objetos tipo}. Esses tipos são destinados principalmente para @ref{458,,anotações de tipo}. A expressão de tipo de união habilita a sintaxe de sugestão de tipo mais limpo em comparação com @ref{63b,,typing.Union}.


@deffn {Describe} X | Y | ...

Define um objeto união que contém os tipos `X', `Y' e assim por diante. @code{X | Y} significa X ou Y. É equivalente a @code{typing.Union[X, Y]}. Por exemplo, a seguinte função espera um argumento do tipo @ref{257,,int} ou @ref{2f7,,float}:

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

@cartouche
@quotation Nota 
O operando @code{|} não pode ser usado em tempo de execução para definir uniões onde um ou mais membros são uma referência direta. Por exemplo, @code{int | "Foo"}, onde @code{"Foo"} é uma referência a uma classe ainda não definida, falhará em tempo de execução. Para uniões que incluem referências futuras, apresente a expressão inteira como uma string, por exemplo. @code{"int | Foo"}.
@end quotation
@end cartouche
@end deffn


@deffn {Describe} union_object == other

Os objetos união podem ser testados quanto à igualdade com outros objetos união. Detalhes:


@itemize *

@item 
Uniões de uniões são achatadas:

@example
(int | str) | float == int | str | float
@end example

@item 
Tipos redundantes são removidos:

@example
int | str | int == int | str
@end example

@item 
Ao comparar uniões, a ordem é ignorada:

@example
int | str == str | int
@end example

@item 
É compatível com @ref{63b,,typing.Union}:

@example
int | str == typing.Union[int, str]
@end example

@item 
Tipos opcionais podem ser escritos como uma união com @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)

Chamadas para @ref{442,,isinstance()} e @ref{7c2,,issubclass()} também são suportados com um objeto união:

@example
>>> isinstance("", int | str)
True
@end example

No entanto, @ref{6b2,,genéricos parametrizados} em objetos de união não podem ser verificados:

@example
>>> isinstance(1, int | list[int])  # cálculo em curto-circuito
True
>>> isinstance([1], int | list[int])
Traceback (most recent call last):
  ...
TypeError: isinstance() argument 2 cannot be a parameterized generic
@end example
@end deffn

O tipo exposto ao usuário para o objeto união pode ser acessado a partir de @ref{63a,,types.UnionType} e usado por verificações de @ref{442,,isinstance()}. Um objeto não pode ser instanciado a partir do 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 
O método @code{__or__()} para objetos de tipo foi adicionado para suportar a sintaxe @code{X | Y}. Se uma metaclasse implementa @code{__or__()}, a União pode substituí-la:

@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 também


@geindex Propostas de Melhorias do Python; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} – PEP propondo a sintaxe @code{X | Y} e o tipo União.



Adicionado na versão 3.10.


@node Outros tipos embutidos,Atributos Especiais,Tipos de anotação de tipo — Apelido genérico União,Tipos embutidos
@anchor{library/stdtypes other-built-in-types}@anchor{23f4}@anchor{library/stdtypes typesother}@anchor{23f5}
@subsection Outros tipos embutidos


O interpretador suporta diversos outros tipos de objetos. Maior parte desses, suporta apenas uma ou duas operações.

@menu
* Módulos: Módulos<4>. 
* Classes e Instâncias de Classes:: 
* Funções:: 
* Métodos:: 
* Objetos código: Objetos código<2>. 
* Objetos tipo:: 
* O objeto nulo:: 
* O Objeto Ellipsis:: 
* O Objeto NotImplemented:: 
* Objetos Internos:: 

@end menu

@node Módulos<4>,Classes e Instâncias de Classes,,Outros tipos embutidos
@anchor{library/stdtypes modules}@anchor{23f6}@anchor{library/stdtypes typesmodules}@anchor{23f7}
@subsubsection Módulos


A única operação especial em um módulo é o acesso a um atributo: @code{m.name}, onde `m' é um módulo e `name' acessa o nome defino na tabela de símbolos de `m'. Atributos de módulo podem receber atribuição. (Perceba que a instrução @ref{5e2,,import} não é, estritamente falando, uma operação em um objeto do módulo; @code{import foo} não requer que um objeto do módulo chamado `foo' exista, ao invés disso requer uma `definição' (externa) de um módulo chamado `foo' em algum lugar.)

Um atributo especial de cada módulo é @ref{55b,,__dict__}. Este é o dicionário contendo a tabela de símbolos do modulo. Modificar este dicionário vai na verdade modificar a tabela de símbolos do módulo, mas atribuição direta para o atributo @ref{55b,,__dict__} não é possível (você pode escrever @code{m.__dict__['a'] = 1}, o qual define @code{m.a} para ser @code{1}, mas você não consegue escrever @code{m.__dict__ = @{@}}). Modificar @ref{55b,,__dict__} diretamente não é recomendado.

Módulos embutidos no interpretador são escritos desta forma: @code{<module 'sys' (built-in)>}. Se carregados a partir de um arquivo, eles são escritos como @code{<module 'os' from '/usr/local/lib/pythonX.Y/os.pyc'>}.

@node Classes e Instâncias de Classes,Funções,Módulos<4>,Outros tipos embutidos
@anchor{library/stdtypes classes-and-class-instances}@anchor{23f8}@anchor{library/stdtypes typesobjects}@anchor{23f9}
@subsubsection Classes e Instâncias de Classes


Veja @ref{2072,,Objetos@comma{} valores e tipos} e @ref{131a,,Definições de classe} para estes.

@node Funções,Métodos,Classes e Instâncias de Classes,Outros tipos embutidos
@anchor{library/stdtypes functions}@anchor{23fa}@anchor{library/stdtypes typesfunctions}@anchor{23fb}
@subsubsection Funções


Objetos função são criados através da definição de funções. A única operação que pode ser feita em um objeto função é chamá-la: @code{func(lista-de-argumentos)}.

Existem na verdade duas possibilidades de objetos função: funções embutidas e funções definidas pelo usuário. Ambas suportam a mesma operação (chamar a função), mas a implementação é diferente, portanto os diferentes tipos de objetos.

Veja a função @ref{1db6,,Definições de função} para mais informações.

@node Métodos,Objetos código<2>,Funções,Outros tipos embutidos
@anchor{library/stdtypes methods}@anchor{23fc}@anchor{library/stdtypes typesmethods}@anchor{23fd}
@subsubsection Métodos


@geindex objeto;método

Métodos são funções que são chamadas usando a notação de atributo. Existem duas opções: @ref{209d,,métodos embutidos} (tal como @ref{6cd,,append()} em listas) e @ref{1e47,,métodos de instância de classe}. Métodos embutidos são descritos com os tipos que os implementam.

Se você acessar um método (uma função definida em um espaço de nomes de uma classe) através de uma instância, você obtém um objeto especial: um objeto com `método vinculado' (também chamado de @ref{1e47,,método de instância}). Quando chamado, ele irá adicionar o argumento @code{self} para a lista de argumentos. Métodos vinculados tem dois atributos somente leitura especiais: @ref{140f,,m.__self__} é o objeto no qual o método opera, e @ref{1340,,m.__func__} é a função que implementa o método. Chamar @code{m(arg-1, arg-2, ..., arg-n)} é completamente equivalente a chamar @code{m.__func__(m.__self__, arg-1, arg-2, ..., arg-n)}.

Assim como @ref{299,,objetos função}, objetos de métodos vinculados tem suporte para receber atributos arbitrários. Entretanto, como atributos de método na verdade são armazenados no objeto função subjacente (@ref{1340,,method.__func__}), definir atributos de método em métodos vinculados não é permitido. Tentar definir um atributo em um método resulta em um @ref{34b,,AttributeError} sendo levantado. A fim de definir um atributo de método, você precisa definir explicitamente ele no objeto função subjacente:

@example
>>> class C:
...     def method(self):
...         pass
...
>>> c = C()
>>> c.method.whoami = 'my name is method'  # proibido atribuir diretamente no método
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

Veja @ref{1e47,,Métodos de instância} para mais informações.

@geindex objeto;código
@geindex objeto código

@node Objetos código<2>,Objetos tipo,Métodos,Outros tipos embutidos
@anchor{library/stdtypes bltin-code-objects}@anchor{23fe}@anchor{library/stdtypes code-objects}@anchor{23ff}
@subsubsection Objetos código


@geindex função embutida;compile
@geindex __code__ (atributo de objeto função)

Objetos código são usados pela implementação para representar código Python executável “pseudo-compilado”, tal como corpo de uma função. Eles são diferentes de objetos função porque eles não contém uma referência para os seus ambientes de execução global. Objetos código são retornados pela função embutida @ref{192,,compile()} e podem ser extraídos de objetos função através do seu atributo @ref{29a,,__code__}. Veja também o módulo @ref{1a,,code}.

Acessar @ref{29a,,__code__} levanta um @ref{19fa,,evento de auditoria} @code{object.__getattr__} com os argumentos @code{obj} e @code{"__code__"}.

@geindex função embutida;exec
@geindex função embutida;eval

Um objeto de código pode ser executado ou avaliado passando-o (ao invés da string fonte) para as funções embutidas @ref{17f,,exec()} ou @ref{180,,eval()}.

Veja o tipo @ref{2075,,A hierarquia de tipos padrão} para maiores informações.

@node Objetos tipo,O objeto nulo,Objetos código<2>,Outros tipos embutidos
@anchor{library/stdtypes bltin-type-objects}@anchor{2317}@anchor{library/stdtypes type-objects}@anchor{2400}
@subsubsection Objetos tipo


@geindex função embutida;tipo
@geindex módulo;types

Objetos de tipos representam os vários tipos de objetos. Um tipo de um objeto é acessado pela função embutida @ref{d6b,,type()}. Não existem operações especiais sobre tipos. O módulo padrão @ref{103,,types} define nomes para todos os tipos padrão embutidos.

Tipos são escritos como isto: @code{<class 'int'>}.

@node O objeto nulo,O Objeto Ellipsis,Objetos tipo,Outros tipos embutidos
@anchor{library/stdtypes bltin-null-object}@anchor{2401}@anchor{library/stdtypes the-null-object}@anchor{2402}
@subsubsection O objeto nulo


Este objeto é retornado por funções que não retornam um valor explicitamente. Ele não suporta operações especiais. Existe exatamente um objeto nulo, chamado de @code{None} (um nome embutido). @code{type(None)()} produz o mesmo singleton.

Ele é escrito como @code{None}.

@geindex ...;literal de reticências

@node O Objeto Ellipsis,O Objeto NotImplemented,O objeto nulo,Outros tipos embutidos
@anchor{library/stdtypes bltin-ellipsis-object}@anchor{1d9a}@anchor{library/stdtypes the-ellipsis-object}@anchor{2403}
@subsubsection O Objeto Ellipsis


Este objeto é comumente usado para indicar que algo foi omitido. Ela não suporta operações especiais. Existe exatamente um objeto ellipsis, nomeado @ref{231c,,Ellipsis} (um nome embutido). @code{type(Ellipsis)()} produz o singleton @ref{231c,,Ellipsis}.

Está escrito com @code{Ellipsis} ou @code{...}.

No uso típico, @code{...} como o objeto @code{Ellipsis} aparece em alguns lugares diferentes, por exemplo:


@itemize -

@item 
Em anotações de tipo, como @ref{2404,,argumentos chamáveis} ou @ref{2405,,elementos de tupla}.

@item 
Como o corpo de uma função em vez de uma @ref{1d98,,instrução pass}.

@item 
Em bibliotecas de terceiros, como slicing e striding do Numpy@footnote{https://numpy.org/doc/stable/user/basics.indexing.html#slicing-and-striding}.
@end itemize

Python também usa três pontos de maneiras que não são objetos @code{Ellipsis}, por exemplo:


@itemize -

@item 
@ref{14b6,,ELLIPSIS} do doctest, como um padrão para conteúdo ausente.

@item 
O prompt Python padrão do console @ref{169,,interativo} quando a entrada parcial está incompleta.
@end itemize

Por fim, a documentação do Python geralmente usa três pontos no uso convencional do inglês para indicar conteúdo omitido, mesmo em exemplos de código que também os usam como @code{Ellipsis}.

@node O Objeto NotImplemented,Objetos Internos,O Objeto Ellipsis,Outros tipos embutidos
@anchor{library/stdtypes bltin-notimplemented-object}@anchor{2406}@anchor{library/stdtypes the-notimplemented-object}@anchor{2407}
@subsubsection O Objeto NotImplemented


Este objeto é retornado a partir de comparações e operações binárias quando elas são solicitadas para operar em tipos nos quais eles não suportam. Veja @ref{2205,,Comparações} para mais informações. Existe exatamente um objeto @ref{7d3,,NotImplemented}. @code{type(NotImplemented)()} produz o mesmo valor.

Está escrito como @code{NotImplemented}.

@node Objetos Internos,,O Objeto NotImplemented,Outros tipos embutidos
@anchor{library/stdtypes internal-objects}@anchor{2408}@anchor{library/stdtypes typesinternal}@anchor{2409}
@subsubsection Objetos Internos


Veja @ref{2075,,A hierarquia de tipos padrão} para esta informação. Descreve @ref{6e0,,objetos de quadro de pilha}, @ref{b07,,objetos traceback (situação da pilha de execução)}, e objetos fatia.

@node Atributos Especiais,Limitação de comprimento de string na conversão para inteiro,Outros tipos embutidos,Tipos embutidos
@anchor{library/stdtypes special-attributes}@anchor{240a}@anchor{library/stdtypes specialattrs}@anchor{240b}
@subsection Atributos Especiais


A implementação adiciona alguns atributos especiais somente leitura para diversos tipos de objetos, onde eles são relevantes. Alguns desses não são reportados pela função embutida @ref{632,,dir()}.

@geindex __name__ (atributo definition)
@anchor{library/stdtypes definition __name__}@anchor{109f}
@deffn {Atributo} definition.__name__

O nome da classe, função, método, descritor, ou instância geradora.
@end deffn

@geindex __qualname__ (atributo definition)
@anchor{library/stdtypes definition __qualname__}@anchor{109e}
@deffn {Atributo} definition.__qualname__

O @ref{1ab1,,nome qualificado} da classe, função, método, descritor, ou instância geradora.


Adicionado na versão 3.3.

@end deffn

@geindex __module__ (atributo definition)
@anchor{library/stdtypes definition __module__}@anchor{240c}
@deffn {Atributo} definition.__module__

O nome do módulo no qual uma classe ou função foi definida.
@end deffn

@geindex __doc__ (atributo definition)
@anchor{library/stdtypes definition __doc__}@anchor{92e}
@deffn {Atributo} definition.__doc__

A string de documentação de uma classe ou função, ou @code{None} se não definida.
@end deffn

@geindex __type_params__ (atributo definition)
@anchor{library/stdtypes definition __type_params__}@anchor{22ca}
@deffn {Atributo} definition.__type_params__

Os @ref{2b3,,parâmetros de tipo} de classes genéricas, funções e @ref{454,,apelidos de tipo}. Para classes e funções que não são genéricas, isso será uma tupla vazia.


Adicionado na versão 3.12.

@end deffn

@node Limitação de comprimento de string na conversão para inteiro,,Atributos Especiais,Tipos embutidos
@anchor{library/stdtypes int-max-str-digits}@anchor{5f5}@anchor{library/stdtypes integer-string-conversion-length-limitation}@anchor{240d}
@subsection Limitação de comprimento de string na conversão para inteiro


CPython tem um limite global para conversão entre @ref{257,,int} e @ref{44c,,str} para mitigar ataques de negação de serviço. Esse limite `somente' se aplica a bases numéricas decimais ou outras que não sejam potência de dois. As conversões hexadecimais, octais e binárias são ilimitadas. O limite pode ser configurado.

O tipo @ref{257,,int} no CPython é um número de comprimento arbitrário armazenado em formato binário (comumente conhecido como “bignum”). Não existe nenhum algoritmo que possa converter uma string em um inteiro binário ou um inteiro binário em uma string em tempo linear, `a menos que' a base seja uma potência de 2. Mesmo os algoritmos mais conhecidos para a base 10 têm complexidade subquadrática. Converter um valor grande como @code{int('1' * 500_000)} pode levar mais de um segundo em uma CPU rápida.

Limitar o tamanho da conversão oferece uma maneira prática de evitar 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735}.

O limite é aplicado ao número de caracteres de dígitos na string de entrada ou saída quando um algoritmo de conversão não linear estiver envolvido. Sublinhados e o sinal não são contados para o limite.

Quando uma operação excede o limite, uma exceção @ref{202,,ValueError} é levantada:

@example
>>> import sys
>>> sys.set_int_max_str_digits(4300)  # Illustrativo, este é o padrão.
>>> _ = 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  # Conversão envolvendo hexadecimais é ilimitada.
@end example

O limite padrão é de 4300 dígitos conforme fornecido em @ref{12d5,,sys.int_info.default_max_str_digits}. O limite mínimo que pode ser configurado é de 640 dígitos conforme fornecido em @ref{12d5,,sys.int_info.str_digits_check_threshold}.

Verificação:

@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


Adicionado na versão 3.11.


@menu
* APIs afetadas:: 
* Configurando o limiter:: 
* Configuração recomendada:: 

@end menu

@node APIs afetadas,Configurando o limiter,,Limitação de comprimento de string na conversão para inteiro
@anchor{library/stdtypes affected-apis}@anchor{240e}
@subsubsection APIs afetadas


A limitação só se aplica a conversões potencialmente lentas entre @ref{257,,int} e @ref{44c,,str} ou @ref{1c2,,bytes}:


@itemize *

@item 
@code{int(string)} com padrão sendo base 10.

@item 
@code{int(string, base)} para todas as bases que não são uma potência de 2.

@item 
@code{str(integer)}.

@item 
@code{repr(integer)}.

@item 
qualquer outra conversão de string para base 10 como, por exemplo, @code{f"@{integer@}"}, @code{"@{@}".format(integer)} ou @code{b"%d" % integer}.
@end itemize

As limitações não se aplicam a funções com um algoritmo linear:


@itemize *

@item 
@code{int(string, base)} com base 2, 4, 8, 16 ou 32.

@item 
@ref{1972,,int.from_bytes()} e @ref{19bd,,int.to_bytes()}.

@item 
@ref{1312,,hex()}, @ref{1311,,oct()}, @ref{12eb,,bin()}.

@item 
@ref{1e8,,Minilinguagem de especificação de formato} para números hexa, octal e binários

@item 
@ref{44c,,str} para @ref{2f7,,float}.

@item 
@ref{44c,,str} para @ref{29d,,decimal.Decimal}.
@end itemize

@node Configurando o limiter,Configuração recomendada,APIs afetadas,Limitação de comprimento de string na conversão para inteiro
@anchor{library/stdtypes configuring-the-limit}@anchor{240f}
@subsubsection Configurando o limiter


Antes de iniciar o Python, você pode usar uma variável de ambiente ou um sinalizador de linha de comando do interpretador para configurar o limite:


@itemize *

@item 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,PYTHONINTMAXSTRDIGITS}, por exemplo @code{PYTHONINTMAXSTRDIGITS=640 python3} para definir o limite para 640 ou @code{PYTHONINTMAXSTRDIGITS=0 python3} para desabilitar a limitação.

@item 
@ref{176,,-X int_max_str_digits}, por exemplo @code{python3 -X int_max_str_digits=640}

@item 
@ref{2410,,sys.flags.int_max_str_digits} contém o valor de 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,PYTHONINTMAXSTRDIGITS} ou @ref{176,,-X int_max_str_digits}. Se a variável env e a opção @code{-X} estiverem definidas, a opção @code{-X} terá precedência. Um valor de `-1' indica que ambos não foram definidos, portanto, um valor de @ref{2411,,sys.int_info.default_max_str_digits} foi usado durante a inicialização.
@end itemize

A partir do código, você pode inspecionar o limite atual e definir um novo usando estas APIs @ref{d9,,sys}:


@itemize *

@item 
@ref{1614,,sys.get_int_max_str_digits()} e @ref{18c5,,sys.set_int_max_str_digits()} são um getter e um setter para o limite de todo o interpretador. Os subinterpretadores têm seu próprio limite.
@end itemize

Informações sobre o padrão e o mínimo podem ser encontradas em @ref{12d5,,sys.int_info}:


@itemize *

@item 
@ref{12d5,,sys.int_info.default_max_str_digits} é o limite padrão compilado.

@item 
@ref{12d5,,sys.int_info.str_digits_check_threshold} é o menor valor aceito para o limite (diferente de 0 que o desabilita).
@end itemize


Adicionado na versão 3.11.


@cartouche
@quotation Cuidado 
Definir um limite baixo `pode' levar a problemas. Embora raro, existe um código que contém constantes inteiras em decimal em sua origem que excedem o limite mínimo. Uma consequência de definir o limite é que o código-fonte do Python contendo literais inteiros decimais maiores que o limite encontrará um erro durante a análise, geralmente no momento da inicialização ou no momento da importação ou até mesmo no momento da instalação – sempre que um @code{.pyc} atualizado ainda não existe para o código. Uma solução alternativa para source que contém tais constantes grandes é convertê-las para a forma hexadecimal @code{0x}, pois não há limite.

Teste sua aplicação completamente se você usar um limite baixo. Certifique-se de que seus testes sejam executados com o limite definido anteriormente por meio do ambiente ou sinalizador para que ele seja aplicado durante a inicialização e até mesmo durante qualquer etapa de instalação que possa invocar o Python para pré-compilar fontes @code{.py} para arquivos @code{.pyc}.
@end quotation
@end cartouche

@node Configuração recomendada,,Configurando o limiter,Limitação de comprimento de string na conversão para inteiro
@anchor{library/stdtypes recommended-configuration}@anchor{2412}
@subsubsection Configuração recomendada


Espera-se que o padrão @ref{2411,,sys.int_info.default_max_str_digits} seja razoável para a maioria das aplicações. Se sua aplicação exigir um limite diferente, defina-o em seu ponto de entrada principal usando código agnóstico de versão Python, pois essas APIs foram adicionadas em lançamentos de patch de segurança em versões anteriores a 3.12.

Exemplo:

@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

Se você precisar desativá-lo totalmente, defina-o como @code{0}.

@node Exceções embutidas,Serviços de Processamento de Texto,Tipos embutidos,A Biblioteca Padrão do Python
@anchor{library/exceptions doc}@anchor{2413}@anchor{library/exceptions bltin-exceptions}@anchor{19b1}@anchor{library/exceptions built-in-exceptions}@anchor{2414}@anchor{library/exceptions translation-repo}@anchor{2415}
@section Exceções embutidas


@geindex instrução;try
@geindex instrução;except

No Python, todas as exceções devem ser instâncias de uma classe derivada de @ref{5bb,,BaseException}. Em uma instrução @ref{6e9,,try} com uma cláusula @ref{18b,,except} que menciona uma classe específica, essa cláusula também lida com qualquer classe de exceção derivada dessa classe (mas não com as classes de exceção a partir das quais `ela' é derivada). Duas classes de exceção que não são relacionadas por subclasse nunca são equivalentes, mesmo que tenham o mesmo nome.

@geindex instrução;raise

As exceções embutidas listadas neste capítulo podem ser geradas pelo interpretador ou pelas funções embutidas. Exceto onde mencionado, eles têm um “valor associado” indicando a causa detalhada do erro. Pode ser uma string ou uma tupla de vários itens de informação (por exemplo, um código de erro e uma string que explica o código). O valor associado geralmente é passado como argumentos para o construtor da classe de exceção.

O código do usuário pode gerar exceções embutidas. Isso pode ser usado para testar um manipulador de exceções ou para relatar uma condição de erro “exatamente como” a situação na qual o interpretador gera a mesma exceção; mas lembre-se de que nada impede o código do usuário de gerar um erro inadequado.

As classes de exceções embutidas podem ser usadas como subclasses para definir novas exceções; Os programadores são incentivados a derivar novas exceções da classe @ref{9e2,,Exception} ou de uma de suas subclasses, e não de @ref{5bb,,BaseException}. Mais informações sobre a definição de exceções estão disponíveis no Tutorial do Python em @ref{1e1c,,Exceções definidas pelo usuário}.

@menu
* Contexto da exceção:: 
* Herdando de exceções embutidas:: 
* Classes base:: 
* Exceções concretas:: 
* Avisos:: 
* Grupos de exceções:: 
* Hierarquia das exceções:: 

@end menu

@node Contexto da exceção,Herdando de exceções embutidas,,Exceções embutidas
@anchor{library/exceptions exception-context}@anchor{2416}
@subsection Contexto da exceção


@geindex exceção;encadeamento
@geindex __cause__ (atributo de exceção)
@geindex __context__ (atributo de exceção)
@geindex __suppress_context__ (atributo de exceção)

Três atributos em objetos exceções fornecem informações sobre o contexto em que a exceção foi levantada.

@geindex __context__ (atributo BaseException)
@geindex __cause__ (atributo BaseException)
@geindex __suppress_context__ (atributo BaseException)
@anchor{library/exceptions BaseException __context__}@anchor{130a}
@deffn {Atributo} BaseException.__context__
@anchor{library/exceptions BaseException __cause__}@anchor{130b}
@deffnx {Atributo} BaseException.__cause__
@anchor{library/exceptions BaseException __suppress_context__}@anchor{224a}
@deffnx {Atributo} BaseException.__suppress_context__

Ao levantar uma nova exceção enquanto outra exceção já está sendo tratada, o atributo @code{__context__} da nova exceção é automaticamente definido para a exceção tratada. Uma exceção pode ser tratada quando uma cláusula @ref{18b,,except} ou @ref{9d2,,finally}, ou uma instrução @ref{5d2,,with}, é usada.

Esse contexto implícito da exceção pode ser complementado com uma causa explícita usando @code{from} com @ref{5ed,,raise}:

@example
raise new_exc from original_exc
@end example

A expressão a seguir @ref{5ed,,from} deve ser uma exceção ou @code{None}. Ela será definida como @code{__cause__} na exceção levantada. A definição de @code{__cause__} também define implicitamente o atributo @code{__suppress_context__} como @code{True}, de modo que o uso de @code{raise new_exc from None} substitui efetivamente a exceção antiga pela nova para fins de exibição (por exemplo, convertendo @ref{344,,KeyError} para @ref{34b,,AttributeError}), deixando a exceção antiga disponível em @code{__context__} para introspecção durante a depuração.

O código de exibição padrão do traceback mostra essas exceções encadeadas, além do traceback da própria exceção. Uma exceção explicitamente encadeada em @code{__cause__} sempre é mostrada quando presente. Uma exceção implicitamente encadeada em @code{__context__} é mostrada apenas se @code{__cause__} for @ref{675,,None} e @code{__suppress_context__} for falso.

Em qualquer um dos casos, a exceção em si sempre é mostrada após todas as exceções encadeadas, de modo que a linha final do traceback sempre mostre a última exceção que foi levantada.
@end deffn

@node Herdando de exceções embutidas,Classes base,Contexto da exceção,Exceções embutidas
@anchor{library/exceptions inheriting-from-built-in-exceptions}@anchor{2417}
@subsection Herdando de exceções embutidas


O código do usuário pode criar subclasses que herdam de um tipo de exceção. É recomendado criar subclasse de apenas um tipo de exceção por vez para evitar possíveis conflitos entre como as bases tratam o atributo @code{args}, bem como devido a possíveis incompatibilidades de layout de memória.

A maioria das exceções embutidas são implementadas em C para eficiência, veja: Objects/exceptions.c@footnote{https://github.com/python/cpython/tree/3.13/Objects/exceptions.c}. Algumas têm layouts de memória personalizados, o que impossibilita a criação de uma subclasse que herda de vários tipos de exceção. O layout de memória de um tipo é um detalhe de implementação e pode mudar entre as versões do Python, levando a novos conflitos no futuro. Portanto, é recomendável evitar criar subclasses de vários tipos de exceção.

@node Classes base,Exceções concretas,Herdando de exceções embutidas,Exceções embutidas
@anchor{library/exceptions base-classes}@anchor{2418}
@subsection Classes base


As seguintes exceções são usadas principalmente como classes base para outras exceções.

@geindex BaseException
@anchor{library/exceptions BaseException}@anchor{5bb}
@deffn {Exceção} BaseException

A classe base para todas as exceções embutidas. Não é para ser herdada diretamente por classes definidas pelo usuário (para isso, use @ref{9e2,,Exception}). Se @ref{44c,,str()} for chamado em uma instância desta classe, a representação do(s) argumento(s) para a instância será retornada ou a string vazia quando não houver argumentos.

@geindex args (atributo BaseException)
@anchor{library/exceptions BaseException args}@anchor{56c}
@deffn {Atributo} args

A tupla de argumentos fornecidos ao construtor de exceções. Algumas exceções embutidas (como @ref{417,,OSError}) esperam um certo número de argumentos e atribuem um significado especial aos elementos dessa tupla, enquanto outras são normalmente chamadas apenas com uma única string que fornece uma mensagem de erro.
@end deffn

@geindex with_traceback() (método BaseException)
@anchor{library/exceptions BaseException with_traceback}@anchor{2249}
@deffn {Método} with_traceback (tb)

Este método define `tb' como o novo traceback (situação da pilha de execução) para a exceção e retorna o objeto exceção. Era mais comumente usado antes que os recursos de encadeamento de exceções de 
@geindex Propostas de Melhorias do Python; PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/} se tornassem disponíveis. O exemplo a seguir mostra como podemos converter uma instância de @code{SomeException} em uma instância de @code{OtherException} enquanto preservamos o traceback. Uma vez gerado, o quadro atual é empurrado para o traceback de @code{OtherException}, como teria acontecido com o traceback de @code{SomeException} original se tivéssemos permitido que ele se propagasse para o chamador.

@example
try:
    ...
except SomeException:
    tb = sys.exception().__traceback__
    raise OtherException(...).with_traceback(tb)
@end example
@end deffn

@geindex __traceback__ (atributo BaseException)
@anchor{library/exceptions BaseException __traceback__}@anchor{1309}
@deffn {Atributo} __traceback__

Um campo gravável que contém o @ref{b07,,objeto traceback} associado a esta exceção. Veja também: @ref{5ed,,A instrução raise}.
@end deffn

@geindex add_note() (método BaseException)
@anchor{library/exceptions BaseException add_note}@anchor{5ba}
@deffn {Método} add_note (note)

Adiciona a string @code{note} às notas da exceção que aparecem no traceback padrão após a string de exceção. Uma exceção @ref{2c3,,TypeError} é levantada se @code{note} não for uma string.


Adicionado na versão 3.11.

@end deffn

@geindex __notes__ (atributo BaseException)
@anchor{library/exceptions BaseException __notes__}@anchor{2419}
@deffn {Atributo} __notes__

Uma lista das notas desta exceção, que foram adicionadas com @ref{5ba,,add_note()}. Este atributo é criado quando @ref{5ba,,add_note()} é chamado.


Adicionado na versão 3.11.

@end deffn
@end deffn

@geindex Exception
@anchor{library/exceptions Exception}@anchor{9e2}
@deffn {Exceção} Exception

Todas as exceções embutidas que não saem para o sistema são derivadas dessa classe. Todas as exceções definidas pelo usuário também devem ser derivadas dessa classe.
@end deffn

@geindex ArithmeticError
@anchor{library/exceptions ArithmeticError}@anchor{241a}
@deffn {Exceção} ArithmeticError

A classe base para as exceções embutidas levantadas para vários erros aritméticos: @ref{885,,OverflowError}, @ref{94c,,ZeroDivisionError}, @ref{241b,,FloatingPointError}.
@end deffn

@geindex BufferError
@anchor{library/exceptions BufferError}@anchor{15bd}
@deffn {Exceção} BufferError

Levantado quando uma operação relacionada a @ref{2e8,,buffer} não puder ser realizada.
@end deffn

@geindex LookupError
@anchor{library/exceptions LookupError}@anchor{2367}
@deffn {Exceção} LookupError

A classe base para as exceções levantadas quando uma chave ou índice usado em um mapeamento ou sequência é inválido: @ref{157e,,IndexError}, @ref{344,,KeyError}. Isso pode ser levantado diretamente por @ref{96a,,codecs.lookup()}.
@end deffn

@node Exceções concretas,Avisos,Classes base,Exceções embutidas
@anchor{library/exceptions concrete-exceptions}@anchor{241c}
@subsection Exceções concretas


As seguintes exceções são as que geralmente são levantados.

@geindex AssertionError
@anchor{library/exceptions AssertionError}@anchor{6a9}
@deffn {Exceção} AssertionError

@geindex instrução;assert

Levantado quando uma instrução @ref{96f,,assert} falha.
@end deffn

@geindex AttributeError
@anchor{library/exceptions AttributeError}@anchor{34b}
@deffn {Exceção} AttributeError

Levantado quando uma referência de atributo (consulte @ref{21de,,Referências de atributo}) ou atribuição falha. (Quando um objeto não oferece suporte a referências ou atribuições de atributos, @ref{2c3,,TypeError} é levantado.)

O argumentos somente-nomeados opcionais `name' e o `obj' definem o atributos correspondente:

@geindex name (atributo AttributeError)
@anchor{library/exceptions AttributeError name}@anchor{241d}
@deffn {Atributo} name

O nome do atributo que tentou-se fazer o acesso.
@end deffn

@geindex obj (atributo AttributeError)
@anchor{library/exceptions AttributeError obj}@anchor{241e}
@deffn {Atributo} obj

O objeto que foi acessado para o atributo nomeado.
@end deffn


Alterado na versão 3.10: Adicionado os atributos @ref{241d,,name} e @ref{241e,,obj}.

@end deffn

@geindex EOFError
@anchor{library/exceptions EOFError}@anchor{131c}
@deffn {Exceção} EOFError

Levantado quando a função @ref{131b,,input()} atinge uma condição de fim de arquivo (EOF) sem ler nenhum dado. (Note: os métodos @code{io.IOBase.read()} e @ref{241f,,io.IOBase.readline()} retornam uma string vazia quando pressionam o EOF.)
@end deffn

@geindex FloatingPointError
@anchor{library/exceptions FloatingPointError}@anchor{241b}
@deffn {Exceção} FloatingPointError

Não usado atualmente.
@end deffn

@geindex GeneratorExit
@anchor{library/exceptions GeneratorExit}@anchor{140e}
@deffn {Exceção} GeneratorExit

Levantado quando um @ref{109a,,gerador} ou uma @ref{491,,corrotina} está fechado(a); veja @ref{15b9,,generator.close()} e @ref{215b,,coroutine.close()}. Herda diretamente de @ref{5bb,,BaseException} em vez de @ref{9e2,,Exception}, já que tecnicamente não é um erro.
@end deffn

@geindex ImportError
@anchor{library/exceptions ImportError}@anchor{419}
@deffn {Exceção} ImportError

Levantada quando a instrução @ref{5e2,,import} tem problemas ao tentar carregar um módulo. Também é gerado quando o “from list” em @code{from ... import} tem um nome que não pode ser encontrado.

O argumentos somente-nomeados opcionais `name' e o `path' definem o atributos correspondente:

@geindex name (atributo ImportError)
@anchor{library/exceptions ImportError name}@anchor{2420}
@deffn {Atributo} name

O nome do módulo que tentou-se fazer a importação.
@end deffn

@geindex path (atributo ImportError)
@anchor{library/exceptions ImportError path}@anchor{2421}
@deffn {Atributo} path

O caminho para qualquer arquivo que acionou a exceção.
@end deffn


Alterado na versão 3.3: Adicionados os atributos @ref{2420,,name} e @ref{2421,,path}.

@end deffn

@geindex ModuleNotFoundError
@anchor{library/exceptions ModuleNotFoundError}@anchor{b5b}
@deffn {Exceção} ModuleNotFoundError

Uma subclasse de @ref{419,,ImportError} que é levantada por @ref{5e2,,import} quando um módulo não pôde ser localizado. Também é levantada quando @code{None} é encontrado em @ref{1636,,sys.modules}.


Adicionado na versão 3.6.

@end deffn

@geindex IndexError
@anchor{library/exceptions IndexError}@anchor{157e}
@deffn {Exceção} IndexError

Levantada quando um índice de alguma sequência está fora do intervalo.  (Índices de fatia são truncados silenciosamente para cair num intervalo permitido; se um índice não for um inteiro, @ref{2c3,,TypeError} é levantada.)

@c XXX xref to sequences
@end deffn

@geindex KeyError
@anchor{library/exceptions KeyError}@anchor{344}
@deffn {Exceção} KeyError

Levantada quando uma chave de mapeamento (dicionário) não é encontrada no conjunto de chaves existentes.

@c XXX xref to mapping objects?
@end deffn

@geindex KeyboardInterrupt
@anchor{library/exceptions KeyboardInterrupt}@anchor{9d9}
@deffn {Exceção} KeyboardInterrupt

Levantada quando um usuário aperta a tecla de interrupção (normalmente @code{Control}-@code{C} ou @code{Delete}).  Durante a execução, uma checagem de interrupção é feita regularmente. A exceção herda de @ref{5bb,,BaseException} para que não seja capturada acidentalmente por códigos que tratam @ref{9e2,,Exception} e assim evita que o interpretador saia.

@cartouche
@quotation Nota 
Capturar uma @ref{9d9,,KeyboardInterrupt} requer consideração especial. Como pode ser levantada em pontos imprevisíveis, pode, em algumas circunstâncias, deixar o programa em execução em um estado inconsistente. Geralmente é melhor permitir que @ref{9d9,,KeyboardInterrupt} termine o programa o mais rápido possível ou evitar levantá-la de todo. (Veja @ref{2422,,Nota sobre manipuladores de sinais e exceções}.)
@end quotation
@end cartouche
@end deffn

@geindex MemoryError
@anchor{library/exceptions MemoryError}@anchor{15c5}
@deffn {Exceção} MemoryError

Levantada quando uma operação fica sem memória mas a situação ainda pode ser recuperada (excluindo alguns objetos).  O valor associado é uma string que indica o tipo de operação (interna) que ficou sem memória. Observe que, por causa da arquitetura de gerenciamento de memória subjacente (função @code{malloc()} do C), o interpretador pode não ser capaz de se recuperar completamente da situação; no entanto, levanta uma exceção para que um traceback possa ser impresso, no caso de um outro programa ser a causa.
@end deffn

@geindex NameError
@anchor{library/exceptions NameError}@anchor{43f}
@deffn {Exceção} NameError

Levantada quando um nome local ou global não é encontrado. Isso se aplica apenas a nomes não qualificados. O valor associado é uma mensagem de erro que inclui o nome que não pode ser encontrado.

O argumento somente-nomeado opcional `name' define o atributo:

@geindex name (atributo NameError)
@anchor{library/exceptions NameError name}@anchor{2423}
@deffn {Atributo} name

O nome do variável que tentou-se fazer o acesso.
@end deffn


Alterado na versão 3.10: Adicionado o atributo @ref{2423,,name}.

@end deffn

@geindex NotImplementedError
@anchor{library/exceptions NotImplementedError}@anchor{228}
@deffn {Exceção} NotImplementedError

Essa exceção é derivada da @ref{195,,RuntimeError}.  Em classes base, definidas pelo usuário, os métodos abstratos devem gerar essa exceção quando requerem que classes derivadas substituam o método, ou enquanto a classe está sendo desenvolvida, para indicar que a implementação real ainda precisa ser adicionada.

@cartouche
@quotation Nota 
Não deve ser usada para indicar que um operador ou método não será mais suportado – nesse caso deixe o operador / método indefinido ou, se é uma subclasse, defina-o como @ref{675,,None}.
@end quotation
@end cartouche

@cartouche
@quotation Cuidado 
@code{NotImplementedError} e @code{NotImplemented} não são intercambiáveis. Esta exceção deve ser usada somente conforme descrito acima; veja @ref{7d3,,NotImplemented} para detalhes sobre o uso correto da constante embutida.
@end quotation
@end cartouche
@end deffn

@geindex OSError
@anchor{library/exceptions OSError}@anchor{417}
@deffn {Exceção} OSError ([arg])

@deffnx {Exceção} OSError (errno, strerror[, filename[, winerror[, filename2]]])

@geindex módulo;errno

Esta exceção é levantada quando uma função do sistema retorna um erro relacionado ao sistema, incluindo falhas do tipo E/S como “file not found” ou “disk full” (não para tipos de argumentos não permitidos ou outro erro acessório).

A segunda forma do construtor definir os atributos correspondentes, descritos abaixo.  Os atributos usarão o valor padrão @ref{675,,None} se não forem especificados.  Por compatibilidade com versões anteriores, se três argumentos são passados, o atributo @ref{56c,,args} contêm somente uma tupla de 2 elementos, os dois primeiros argumentos do construtor.

O construtor geralmente retorna uma subclasse de @ref{417,,OSError}, como descrito abaixo em @ref{2424,,OS exceptions} .  A subclasse particular depende do valor final de @ref{15d5,,errno}.  Este comportamento ocorre apenas durante a construção direta ou por meio de um apelido de @ref{417,,OSError}, e não é herdado na criação de subclasses.

@geindex errno (atributo OSError)
@anchor{library/exceptions OSError errno}@anchor{15d5}
@deffn {Atributo} errno

Um código de erro numérico da variável C @code{errno}.
@end deffn

@geindex winerror (atributo OSError)
@anchor{library/exceptions OSError winerror}@anchor{2425}
@deffn {Atributo} winerror

No Windows, isso fornece o código de erro nativo do Windows. O atributo @ref{15d5,,errno} é então uma tradução aproximada, em termos POSIX, desse código de erro nativo.

No Windows, se o argumento de construtor `winerror' for um inteiro, o atributo @ref{15d5,,errno} é determinado a partir do código de erro do Windows e o argumento `errno' é ignorado. Em outras plataformas, o argumento `winerror' é ignorado e o atributo @ref{2425,,winerror} não existe.
@end deffn

@geindex strerror (atributo OSError)
@anchor{library/exceptions OSError strerror}@anchor{2426}
@deffn {Atributo} strerror

A mensagem de erro correspondente, conforme fornecida pelo sistema operacional. É formatada pelas funções C @code{perror()} no POSIX e @code{FormatMessage()} no Windows.
@end deffn

@geindex filename (atributo OSError)
@geindex filename2 (atributo OSError)
@anchor{library/exceptions OSError filename}@anchor{2427}
@deffn {Atributo} filename
@anchor{library/exceptions OSError filename2}@anchor{2428}
@deffnx {Atributo} filename2

Para exceções que envolvem um caminho do sistema de arquivos (como @ref{51c,,open()} ou @ref{1134,,os.unlink()}), @ref{2427,,filename} é o nome do arquivo passado para a função. Para funções que envolvem dois caminhos de sistema de arquivos (como @ref{1130,,os.rename()}), @ref{2428,,filename2} corresponde ao segundo nome de arquivo passado para a função.
@end deffn


Alterado na versão 3.3: @ref{108c,,EnvironmentError}, @ref{108b,,IOError}, @ref{108d,,WindowsError}, @ref{108e,,socket.error}, @ref{108f,,select.error} e @code{mmap.error} foram fundidos em @ref{417,,OSError}, e o construtor pode retornar uma subclasse.



Alterado na versão 3.4: O atributo @ref{2427,,filename} agora é o nome do arquivo original passado para a função, ao invés do nome codificado ou decodificado da @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Além disso, o argumento e o atributo de construtor `filename2' foi adicionado.

@end deffn

@geindex OverflowError
@anchor{library/exceptions OverflowError}@anchor{885}
@deffn {Exceção} OverflowError

Levantada quando o resultado de uma operação aritmética é muito grande para ser representada. Isso não pode ocorrer para inteiros (que prefere levantar @ref{15c5,,MemoryError} a desistir). No entanto, por motivos históricos, OverflowError às vezes é levantada para inteiros que estão fora de um intervalo obrigatório. Devido à falta de padronização do tratamento de exceção de ponto flutuante em C, a maioria das operações de ponto flutuante não são verificadas.
@end deffn

@geindex PythonFinalizationError
@anchor{library/exceptions PythonFinalizationError}@anchor{14d}
@deffn {Exceção} PythonFinalizationError

Este exceção é derivada de @ref{195,,RuntimeError}. É levantada quando uma operação é bloqueada durante o encerramento do interpretador e também conhecido como @ref{14e,,finalização do Python}.

Exemplos de operações que podem ser bloqueadas com um @ref{14d,,PythonFinalizationError} durante a finalização do Python:


@itemize *

@item 
Criação de uma nova thread no Python.

@item 
@ref{197,,os.fork()}.
@end itemize

Veja também a função @ref{a99,,sys.is_finalizing()}.


Adicionado na versão 3.13: Anteriormente, uma @ref{195,,RuntimeError} simples era levantada.

@end deffn

@geindex RecursionError
@anchor{library/exceptions RecursionError}@anchor{d90}
@deffn {Exceção} RecursionError

Esta exceção é derivada de @ref{195,,RuntimeError}. É levantada quando o interpretador detecta que a profundidade máxima de recursão (veja @ref{4c4,,sys.getrecursionlimit()}) foi excedida.


Adicionado na versão 3.5: Anteriormente, uma @ref{195,,RuntimeError} simples era levantada.

@end deffn

@geindex ReferenceError
@anchor{library/exceptions ReferenceError}@anchor{1556}
@deffn {Exceção} ReferenceError

Esta exceção é levantada quando um intermediário de referência fraca, criado pela função @ref{a5b,,weakref.proxy()}, é usado para acessar um atributo do referente após ter sido coletado como lixo. Para mais informações sobre referências fracas, veja o módulo @ref{114,,weakref}.
@end deffn

@geindex RuntimeError
@anchor{library/exceptions RuntimeError}@anchor{195}
@deffn {Exceção} RuntimeError

Levantada quando um erro é detectado e não se encaixa em nenhuma das outras categorias. O valor associado é uma string indicando o que precisamente deu errado.
@end deffn

@geindex StopIteration
@anchor{library/exceptions StopIteration}@anchor{c15}
@deffn {Exceção} StopIteration

Levantada pela função embutida @ref{7d9,,next()} e o método @ref{1310,,__next__()} de um @ref{1ac,,iterador} para sinalizar que não há mais itens produzidos pelo iterador.

@geindex value (atributo StopIteration)
@anchor{library/exceptions StopIteration value}@anchor{2157}
@deffn {Atributo} value

O objeto exceção tem um único atributo @code{value}, que é fornecido como um argumento ao construir a exceção, e o padrão é @ref{675,,None}.
@end deffn

Quando uma função @ref{109a,,geradora} ou @ref{491,,corrotina} retorna, uma nova instância @ref{c15,,StopIteration} é levantada, e o valor retornado pela função é usado como o parâmetro @ref{2157,,value} para o construtor da exceção.

Se um código gerador direta ou indiretamente levantar @ref{c15,,StopIteration}, ele é convertido em uma @ref{195,,RuntimeError} (mantendo o @ref{c15,,StopIteration} como a nova causa da exceção).


Alterado na versão 3.3: Adicionado o atributo @code{value} e a capacidade das funções geradoras de usá-lo para retornar um valor.



Alterado na versão 3.5: Introduzida a transformação RuntimeError via @code{from __future__ import generator_stop}, consulte 
@geindex Propostas de Melhorias do Python; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.



Alterado na versão 3.7: Habilita 
@geindex Propostas de Melhorias do Python; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} para todo o código por padrão: um erro @ref{c15,,StopIteration} levantado em um gerador é transformado em uma @ref{195,,RuntimeError}.

@end deffn

@geindex StopAsyncIteration
@anchor{library/exceptions StopAsyncIteration}@anchor{1ba5}
@deffn {Exceção} StopAsyncIteration

Deve ser levantada pelo método @ref{1659,,__anext__()} de um objeto @ref{1ab,,iterador assíncrono} para parar a iteração.


Adicionado na versão 3.5.

@end deffn

@geindex SyntaxError
@anchor{library/exceptions SyntaxError}@anchor{18d}
@deffn {Exceção} SyntaxError (message, details)

Levantada quando o analisador encontra um erro de sintaxe. Isso pode ocorrer em uma instrução @ref{5e2,,import}, em uma chamada às funções embutidas @ref{192,,compile()}, @ref{17f,,exec()} ou @ref{180,,eval()}, ou ao ler o script inicial ou entrada padrão (também interativamente).

A função @ref{44c,,str()} da instância de exceção retorna apenas a mensagem de erro. Detalhes é uma tupla cujos membros também estão disponíveis como atributos separados.

@geindex filename (atributo SyntaxError)
@anchor{library/exceptions SyntaxError filename}@anchor{2429}
@deffn {Atributo} filename

O nome do arquivo em que ocorreu o erro de sintaxe.
@end deffn

@geindex lineno (atributo SyntaxError)
@anchor{library/exceptions SyntaxError lineno}@anchor{242a}
@deffn {Atributo} lineno

Em qual número de linha no arquivo o erro ocorreu. Este é indexado em 1: a primeira linha no arquivo tem um @code{lineno} de 1.
@end deffn

@geindex offset (atributo SyntaxError)
@anchor{library/exceptions SyntaxError offset}@anchor{242b}
@deffn {Atributo} offset

A coluna da linha em que ocorreu o erro. Este é indexado em 1: o primeiro caractere na linha tem um @code{offset} de 1.
@end deffn

@geindex text (atributo SyntaxError)
@anchor{library/exceptions SyntaxError text}@anchor{242c}
@deffn {Atributo} text

O texto do código-fonte envolvido no erro.
@end deffn

@geindex end_lineno (atributo SyntaxError)
@anchor{library/exceptions SyntaxError end_lineno}@anchor{242d}
@deffn {Atributo} end_lineno

Em qual número de linha no arquivo o erro ocorrido termina. Este é indexado em 1: a primeira linha no arquivo tem um @code{lineno} de 1.
@end deffn

@geindex end_offset (atributo SyntaxError)
@anchor{library/exceptions SyntaxError end_offset}@anchor{242e}
@deffn {Atributo} end_offset

A coluna da linha final em que o erro ocorreu termina. Este é indexado em 1: o primeiro caractere na linha tem um @code{offset} de 1.
@end deffn

Para erros em campos de f-string, a mensagem é prefixada por “f-string: “ e os “offsets” são deslocamentos em um texto construído a partir da expressão de substituição. Por exemplo, compilar o campo f’Bad @{a b@}’ resulta neste atributo de argumentos: (‘f-string: …’, (‘’, 1, 2, ‘(a b)n’, 1, 5)).


Alterado na versão 3.10: Adicionados os atributos @ref{242d,,end_lineno} e @ref{242e,,end_offset}.

@end deffn

@geindex IndentationError
@anchor{library/exceptions IndentationError}@anchor{7a9}
@deffn {Exceção} IndentationError

Classe base para erros de sintaxe relacionados a indentação incorreta. Esta é uma subclasse de @ref{18d,,SyntaxError}.
@end deffn

@geindex TabError
@anchor{library/exceptions TabError}@anchor{543}
@deffn {Exceção} TabError

Levantada quando o indentação contém um uso inconsistente de tabulações e espaços. Esta é uma subclasse de @ref{7a9,,IndentationError}.
@end deffn

@geindex SystemError
@anchor{library/exceptions SystemError}@anchor{575}
@deffn {Exceção} SystemError

Levantada quando o interpretador encontra um erro interno, mas a situação não parece tão grave para fazer com que perca todas as esperanças. O valor associado é uma string que indica o que deu errado (em termos de baixo nível). Em @ref{6f6,,CPython}, isso pode ser causado pelo uso incorreto da API C do Python, como retornar um valor @code{NULL} sem um conjunto de exceções.

Se você tem certeza de que essa exceção não foi culpa sua ou de um pacote que você está usando, você deve relatar isso ao autor ou mantenedor do seu interpretador Python. Certifique-se de relatar a versão do interpretador Python (@code{sys.version}; também é impresso no início de uma sessão Python interativa), a mensagem de erro exata (o valor associado da exceção) e se possível a fonte do programa que acionou o erro.
@end deffn

@geindex SystemExit
@anchor{library/exceptions SystemExit}@anchor{d63}
@deffn {Exceção} SystemExit

Esta exceção é levantada pela função @ref{138e,,sys.exit()}. Ele herda de @ref{5bb,,BaseException} em vez de  @ref{9e2,,Exception} para que não seja acidentalmente capturado pelo código que captura @ref{9e2,,Exception}. Isso permite que a exceção se propague corretamente e faça com que o interpretador saia. Quando não é tratado, o interpretador Python sai; nenhum traceback (situação da pilha de execução) é impresso. O construtor aceita o mesmo argumento opcional passado para @ref{138e,,sys.exit()}. Se o valor for um inteiro, ele especifica o status de saída do sistema (passado para a função C @code{exit()}); se for @code{None}, o status de saída é zero; se tiver outro tipo (como uma string), o valor do objeto é exibido e o status de saída é um.

Uma chamada para @ref{138e,,sys.exit()} é traduzida em uma exceção para que os tratadores de limpeza (cláusulas @ref{9d2,,finally} das instruções @ref{6e9,,try}) possam ser executados, e para que um depurador possa executar um script sem correr o risco de perder o controle. A função @ref{242f,,os._exit()} pode ser usada se for absolutamente necessário sair imediatamente (por exemplo, no processo filho após uma chamada para @ref{197,,os.fork()}).

@geindex code (atributo SystemExit)
@anchor{library/exceptions SystemExit code}@anchor{2430}
@deffn {Atributo} code

O status de saída ou mensagem de erro transmitida ao construtor. (O padrão é @code{None}.)
@end deffn
@end deffn

@geindex TypeError
@anchor{library/exceptions TypeError}@anchor{2c3}
@deffn {Exceção} TypeError

Levantada quando uma operação ou função é aplicada a um objeto de tipo inadequado. O valor associado é uma string que fornece detalhes sobre a incompatibilidade de tipo.

Essa exceção pode ser levantada pelo código do usuário para indicar que uma tentativa de operação em um objeto não é suportada e não deveria ser. Se um objeto deve ter suporte a uma dada operação, mas ainda não forneceu uma implementação, @ref{228,,NotImplementedError} é a exceção apropriada a ser levantada.

Passar argumentos do tipo errado (por exemplo, passar uma @ref{611,,list} quando um @ref{257,,int} é esperado) deve resultar em uma @ref{2c3,,TypeError}, mas passar argumentos com o valor errado (por exemplo, um número fora dos limites esperados) deve resultar em uma @ref{202,,ValueError}.
@end deffn

@geindex UnboundLocalError
@anchor{library/exceptions UnboundLocalError}@anchor{157f}
@deffn {Exceção} UnboundLocalError

Levantada quando uma referência é feita a uma variável local em uma função ou método, mas nenhum valor foi vinculado a essa variável. Esta é uma subclasse de @ref{43f,,NameError}.
@end deffn

@geindex UnicodeError
@anchor{library/exceptions UnicodeError}@anchor{12e6}
@deffn {Exceção} UnicodeError

Levantada quando ocorre um erro de codificação ou decodificação relacionado ao Unicode. É uma subclasse de @ref{202,,ValueError}.

@ref{12e6,,UnicodeError} possui atributos que descrevem o erro de codificação ou decodificação. Por exemplo, @code{err.object[err.start:err.end]} fornece a entrada inválida específica na qual o codec falhou.

@geindex encoding (atributo UnicodeError)
@anchor{library/exceptions UnicodeError encoding}@anchor{2431}
@deffn {Atributo} encoding

O nome da codificação que levantou o erro.
@end deffn

@geindex reason (atributo UnicodeError)
@anchor{library/exceptions UnicodeError reason}@anchor{2432}
@deffn {Atributo} reason

Uma string que descreve o erro de codec específico.
@end deffn

@geindex object (atributo UnicodeError)
@anchor{library/exceptions UnicodeError object}@anchor{2433}
@deffn {Atributo} object

O objeto que o codec estava tentando codificar ou decodificar.
@end deffn

@geindex start (atributo UnicodeError)
@anchor{library/exceptions UnicodeError start}@anchor{16a2}
@deffn {Atributo} start

O primeiro índice de dados inválidos em @ref{a96,,object}.
@end deffn

@geindex end (atributo UnicodeError)
@anchor{library/exceptions UnicodeError end}@anchor{16a3}
@deffn {Atributo} end

O índice após os últimos dados inválidos em @ref{a96,,object}.
@end deffn
@end deffn

@geindex UnicodeEncodeError
@anchor{library/exceptions UnicodeEncodeError}@anchor{677}
@deffn {Exceção} UnicodeEncodeError

Levantada quando ocorre um erro relacionado ao Unicode durante a codificação. É uma subclasse de @ref{12e6,,UnicodeError}.
@end deffn

@geindex UnicodeDecodeError
@anchor{library/exceptions UnicodeDecodeError}@anchor{a1d}
@deffn {Exceção} UnicodeDecodeError

Levantada quando ocorre um erro relacionado ao Unicode durante a decodificação. É uma subclasse de @ref{12e6,,UnicodeError}.
@end deffn

@geindex UnicodeTranslateError
@anchor{library/exceptions UnicodeTranslateError}@anchor{2434}
@deffn {Exceção} UnicodeTranslateError

Levantada quando ocorre um erro relacionado ao Unicode durante a tradução. É uma subclasse de @ref{12e6,,UnicodeError}.
@end deffn

@geindex ValueError
@anchor{library/exceptions ValueError}@anchor{202}
@deffn {Exceção} ValueError

Levantada quando uma operação ou função recebe um argumento que tem o tipo certo, mas um valor inadequado, e a situação não é descrita por uma exceção mais precisa, como @ref{157e,,IndexError}.
@end deffn

@geindex ZeroDivisionError
@anchor{library/exceptions ZeroDivisionError}@anchor{94c}
@deffn {Exceção} ZeroDivisionError

Levantada quando o segundo argumento de uma divisão ou operação de módulo é zero. O valor associado é uma string que indica o tipo dos operandos e a operação.
@end deffn

As seguintes exceções são mantidas para compatibilidade com versões anteriores; a partir do Python 3.3, eles são apelidos de @ref{417,,OSError}.

@geindex EnvironmentError
@anchor{library/exceptions EnvironmentError}@anchor{108c}
@deffn {Exceção} EnvironmentError
@end deffn

@geindex IOError
@anchor{library/exceptions IOError}@anchor{108b}
@deffn {Exceção} IOError
@end deffn

@geindex WindowsError
@anchor{library/exceptions WindowsError}@anchor{108d}
@deffn {Exceção} WindowsError

Disponível apenas no Windows.
@end deffn

@menu
* Exceções de sistema operacional:: 

@end menu

@node Exceções de sistema operacional,,,Exceções concretas
@anchor{library/exceptions os-exceptions}@anchor{2424}
@subsubsection Exceções de sistema operacional


As seguintes exceções são subclasses de @ref{417,,OSError}, elas são levantadas dependendo do código de erro do sistema.

@geindex BlockingIOError
@anchor{library/exceptions BlockingIOError}@anchor{1090}
@deffn {Exceção} BlockingIOError

Levantada quando uma operação bloquearia em um objeto (por exemplo, soquete) definido para operação sem bloqueio. Corresponde a @code{errno} @ref{2435,,EAGAIN}, @ref{2436,,EALREADY}, @ref{2437,,EWOULDBLOCK} e @ref{2438,,EINPROGRESS}.

Além daquelas de @ref{417,,OSError}, @ref{1090,,BlockingIOError} pode ter mais um atributo:

@geindex characters_written (atributo BlockingIOError)
@anchor{library/exceptions BlockingIOError characters_written}@anchor{2439}
@deffn {Atributo} characters_written

An integer containing the number of `bytes' written to the stream
before it blocked. This attribute is available when using the
buffered I/O classes from the @ref{7f,,io} module.
@end deffn
@end deffn

@geindex ChildProcessError
@anchor{library/exceptions ChildProcessError}@anchor{1091}
@deffn {Exceção} ChildProcessError

Levantada quando uma operação em um processo filho falha. Corresponde a @code{errno} @ref{243a,,ECHILD}.
@end deffn

@geindex ConnectionError
@anchor{library/exceptions ConnectionError}@anchor{e36}
@deffn {Exceção} ConnectionError

Uma classe base para problemas relacionados à conexão.

Suas subclasses são @ref{1095,,BrokenPipeError}, @ref{1096,,ConnectionAbortedError}, @ref{1097,,ConnectionRefusedError} e @ref{1098,,ConnectionResetError}.
@end deffn

@geindex BrokenPipeError
@anchor{library/exceptions BrokenPipeError}@anchor{1095}
@deffn {Exceção} BrokenPipeError

Uma subclasse de @ref{e36,,ConnectionError},  levantada ao tentar escrever em um encadeamento, enquanto a outra extremidade foi fechada, ou ao tentar escrever em um soquete que foi desligado para escrita. Corresponde a  @code{errno} @ref{243b,,EPIPE} e @ref{243c,,ESHUTDOWN}.
@end deffn

@geindex ConnectionAbortedError
@anchor{library/exceptions ConnectionAbortedError}@anchor{1096}
@deffn {Exceção} ConnectionAbortedError

Uma subclasse de @ref{e36,,ConnectionError}, levantada quando uma tentativa de conexão é cancelada pelo par. Corresponde a @code{errno} @ref{243d,,ECONNABORTED}.
@end deffn

@geindex ConnectionRefusedError
@anchor{library/exceptions ConnectionRefusedError}@anchor{1097}
@deffn {Exceção} ConnectionRefusedError

Uma subclasse de @ref{e36,,ConnectionError}, levantada quando uma tentativa de conexão é recusada pelo par. Corresponde a @code{errno} @ref{243e,,ECONNREFUSED}.
@end deffn

@geindex ConnectionResetError
@anchor{library/exceptions ConnectionResetError}@anchor{1098}
@deffn {Exceção} ConnectionResetError

Uma subclasse de @ref{e36,,ConnectionError}, levantada quando uma conexão é redefinida pelo par. Corresponde a @code{errno} @ref{243f,,ECONNRESET}.
@end deffn

@geindex FileExistsError
@anchor{library/exceptions FileExistsError}@anchor{1056}
@deffn {Exceção} FileExistsError

Levantada ao tentar criar um arquivo ou diretório que já existe. Corresponde a @code{errno} @ref{2440,,EEXIST}.
@end deffn

@geindex FileNotFoundError
@anchor{library/exceptions FileNotFoundError}@anchor{42b}
@deffn {Exceção} FileNotFoundError

Levantada quando um arquivo ou diretório é solicitado, mas não existe. Corresponde a @code{errno} @ref{2441,,ENOENT}.
@end deffn

@geindex InterruptedError
@anchor{library/exceptions InterruptedError}@anchor{db0}
@deffn {Exceção} InterruptedError

Levantada quando uma chamada do sistema é interrompida por um sinal de entrada. Corresponde a @code{errno} @ref{daf,,EINTR}.


Alterado na versão 3.5: Python agora tenta novamente chamadas de sistema quando uma `syscall' é interrompida por um sinal, exceto se o tratador de sinal levanta uma exceção (veja 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para a justificativa), em vez de levantar @ref{db0,,InterruptedError}.

@end deffn

@geindex IsADirectoryError
@anchor{library/exceptions IsADirectoryError}@anchor{1092}
@deffn {Exceção} IsADirectoryError

Levantada quando uma operação de arquivo (como @ref{112f,,os.remove()}) é solicitada em um diretório. Corresponde a @code{errno} @ref{2442,,EISDIR}.
@end deffn

@geindex NotADirectoryError
@anchor{library/exceptions NotADirectoryError}@anchor{1093}
@deffn {Exceção} NotADirectoryError

Levantada quando uma operação de diretório (como @ref{1139,,os.listdir()}) é solicitada em algo que não é um diretório. Na maioria das plataformas POSIX, ela também pode ser levantada se uma operação tentar abrir ou percorrer um arquivo não pertencente ao diretório como se fosse um diretório. Corresponde a @code{errno} @ref{2443,,ENOTDIR}.
@end deffn

@geindex PermissionError
@anchor{library/exceptions PermissionError}@anchor{d65}
@deffn {Exceção} PermissionError

Levantada ao tentar executar uma operação sem os direitos de acesso adequados - por exemplo, permissões do sistema de arquivos. Corresponde a @code{errno} @ref{2444,,EACCES}, @ref{18e1,,EPERM}, e @ref{18c8,,ENOTCAPABLE}.


Alterado na versão 3.11.1: @ref{18c8,,ENOTCAPABLE} do WASI agora é mapeado para @ref{d65,,PermissionError}.

@end deffn

@geindex ProcessLookupError
@anchor{library/exceptions ProcessLookupError}@anchor{1094}
@deffn {Exceção} ProcessLookupError

Levantada quando um determinado processo não existe. Corresponde a @code{errno} @ref{2445,,ESRCH}.
@end deffn

@geindex TimeoutError
@anchor{library/exceptions TimeoutError}@anchor{838}
@deffn {Exceção} TimeoutError

Levantada quando uma função do sistema expirou no nível do sistema. Corresponde a @code{errno} @ref{2446,,ETIMEDOUT}.
@end deffn


Adicionado na versão 3.3: Todas as subclasses de @ref{417,,OSError} acima foram adicionadas.



@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/} - Reworking the OS and IO exception hierarchy


@node Avisos,Grupos de exceções,Exceções concretas,Exceções embutidas
@anchor{library/exceptions warning-categories-as-exceptions}@anchor{2447}@anchor{library/exceptions warnings}@anchor{2448}
@subsection Avisos


As seguintes exceções são usadas como categorias de aviso; veja a documentação de @ref{2449,,Categorias de avisos} para mais detalhes.

@geindex Warning
@anchor{library/exceptions Warning}@anchor{244a}
@deffn {Exceção} Warning

Classe base para categorias de aviso.
@end deffn

@geindex UserWarning
@anchor{library/exceptions UserWarning}@anchor{244b}
@deffn {Exceção} UserWarning

Classe base para avisos gerados pelo código do usuário.
@end deffn

@geindex DeprecationWarning
@anchor{library/exceptions DeprecationWarning}@anchor{1a5}
@deffn {Exceção} DeprecationWarning

Classe base para avisos sobre recursos descontinuados destinados a outros desenvolvedores Python.

Ignorado pelos filtros de aviso padrão, exceto no módulo @code{__main__} (
@geindex Propostas de Melhorias do Python; PEP 565
PEP 565@footnote{https://peps.python.org/pep-0565/}). Habilitar o @ref{1f8,,Modo de Desenvolvimento do Python} exibe este aviso.

A política de descontinuação está descrita na 
@geindex Propostas de Melhorias do Python; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}.
@end deffn

@geindex PendingDeprecationWarning
@anchor{library/exceptions PendingDeprecationWarning}@anchor{8ce}
@deffn {Exceção} PendingDeprecationWarning

Classe base para avisos sobre recursos obsoletos que devem ser descontinuados no futuro, mas ainda não foram.

Esta classe raramente é usada para emitir um aviso de possível descontinuação futura, é incomum, e @ref{1a5,,DeprecationWarning} é preferível para descontinuações já ativas.

Ignorado pelos filtros de aviso padrão. Habilitar o @ref{1f8,,Modo de Desenvolvimento do Python} exibe este aviso.

A política de descontinuação está descrita na 
@geindex Propostas de Melhorias do Python; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}.
@end deffn

@geindex SyntaxWarning
@anchor{library/exceptions SyntaxWarning}@anchor{466}
@deffn {Exceção} SyntaxWarning

Classe base para avisos sobre sintaxe duvidosa.

Este aviso é tipicamente emitido ao compilar código-fonte Python e, normalmente, não será exibido ao executar código já compilado.
@end deffn

@geindex RuntimeWarning
@anchor{library/exceptions RuntimeWarning}@anchor{1bd}
@deffn {Exceção} RuntimeWarning

Classe base para avisos sobre comportamento duvidoso de tempo de execução.
@end deffn

@geindex FutureWarning
@anchor{library/exceptions FutureWarning}@anchor{415}
@deffn {Exceção} FutureWarning

Classe base para avisos sobre recursos descontinuados destinados a usuários finais de aplicações escritas em Python.
@end deffn

@geindex ImportWarning
@anchor{library/exceptions ImportWarning}@anchor{4fa}
@deffn {Exceção} ImportWarning

Classe base para avisos sobre prováveis erros na importação de módulos.

Ignorado pelos filtros de aviso padrão. Habilitar o @ref{1f8,,Modo de Desenvolvimento do Python} exibe este aviso.
@end deffn

@geindex UnicodeWarning
@anchor{library/exceptions UnicodeWarning}@anchor{146b}
@deffn {Exceção} UnicodeWarning

Classe base para avisos relacionados a Unicode.
@end deffn

@geindex EncodingWarning
@anchor{library/exceptions EncodingWarning}@anchor{1ec5}
@deffn {Exceção} EncodingWarning

Classe base para avisos relacionados a codificações.

Veja @ref{1ed9,,Ativar EncodingWarning} para detalhes.


Adicionado na versão 3.10.

@end deffn

@geindex BytesWarning
@anchor{library/exceptions BytesWarning}@anchor{c3d}
@deffn {Exceção} BytesWarning

Classe base para avisos relacionados a @ref{1c2,,bytes} e @ref{2ea,,bytearray}.
@end deffn

@geindex ResourceWarning
@anchor{library/exceptions ResourceWarning}@anchor{244}
@deffn {Exceção} ResourceWarning

Classe base para avisos relacionados ao uso de recursos.

Ignorado pelos filtros de aviso padrão. Habilitar o @ref{1f8,,Modo de Desenvolvimento do Python} exibe este aviso.


Adicionado na versão 3.2.

@end deffn

@node Grupos de exceções,Hierarquia das exceções,Avisos,Exceções embutidas
@anchor{library/exceptions exception-groups}@anchor{244c}@anchor{library/exceptions lib-exception-groups}@anchor{244d}
@subsection Grupos de exceções


Os itens a seguir são usados quando é necessário levantar várias exceções não relacionadas. Eles fazem parte da hierarquia de exceção, portanto, podem ser tratados com @ref{18b,,except} como todas as outras exceções. Além disso, eles são reconhecidos por @ref{5b8,,except*}, que corresponde a seus subgrupos com base nos tipos de exceções contidas.

@geindex ExceptionGroup
@anchor{library/exceptions ExceptionGroup}@anchor{1b6}
@deffn {Exceção} ExceptionGroup (msg, excs)
@end deffn

@geindex BaseExceptionGroup
@anchor{library/exceptions BaseExceptionGroup}@anchor{25f}
@deffn {Exceção} BaseExceptionGroup (msg, excs)

Ambos os tipos de exceção agrupam as exceções na sequência @code{excs}. O parâmetro @code{msg} deve ser uma string. A diferença entre as duas classes é que @ref{25f,,BaseExceptionGroup} estende @ref{5bb,,BaseException} e pode envolver qualquer exceção, enquanto @ref{1b6,,ExceptionGroup} estende @ref{9e2,,Exception} e só pode agrupar subclasses de @ref{9e2,,Exception}. Este design é para que @code{except Exception} capture um @ref{1b6,,ExceptionGroup} mas não @ref{25f,,BaseExceptionGroup}.

O construtor de @ref{25f,,BaseExceptionGroup} retorna uma @ref{1b6,,ExceptionGroup} ao invés de uma @ref{25f,,BaseExceptionGroup} se todas as exceções contidas forem instâncias @ref{9e2,,Exception}, então ela pode ser usada para tornar a seleção automática. O construtor de @ref{1b6,,ExceptionGroup}, por outro lado, levanta @ref{2c3,,TypeError} se qualquer exceção contida não for uma subclasse de @ref{9e2,,Exception}.

`Detalhes da implementação do CPython:' The @code{excs} parameter may be any sequence, but lists and tuples are
specifically processed more efficiently here. For optimal performance,
pass a tuple as @code{excs}.

@geindex message (atributo BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup message}@anchor{244e}
@deffn {Atributo} message

O argumento @code{msg} para o construtor. Este é um atributo somente leitura.
@end deffn

@geindex exceptions (atributo BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup exceptions}@anchor{244f}
@deffn {Atributo} exceptions

Uma tupla de exceções na sequência @code{excs} dada ao construtor. Este é um atributo somente leitura.
@end deffn

@geindex subgroup() (método BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup subgroup}@anchor{17b4}
@deffn {Método} subgroup (condition)

Retorna um grupo de exceções que contém apenas as exceções do grupo atual que correspondem à condição `condition' ou @code{None} se o resultado estiver vazio.

A condição pode ser um tipo exceção ou tupla de tipos de exceção. Nesse caso, cada exceção é verificada quanto a um match usando a mesma verificação que é usada em uma cláusula de @code{except}. A condição também pode ser um chamável (diferente de um objeto de tipo) que aceita uma exceção como seu único argumento e retorna verdadeiro para a exceção que deve estar no subgrupo.

A estrutura de aninhamento da exceção atual é preservada no resultado, assim como os valores de seus campos @ref{244e,,message}, @ref{1309,,__traceback__}, @ref{130b,,__cause__}, @ref{130a,,__context__} e @ref{2419,,__notes__}. Grupos aninhados vazios são omitidos do resultado.

A condição é verificada para todas as exceções no grupo de exceções aninhadas, incluindo o nível superior e quaisquer grupos de exceções aninhadas. Se a condição for verdadeira para tal grupo de exceções, ela será incluída no resultado por completo.


Adicionado na versão 3.13: @code{condition} pode ser qualquer chamável que não seja um objeto de tipo.

@end deffn

@geindex split() (método BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup split}@anchor{1670}
@deffn {Método} split (condition)

Como @ref{17b4,,subgroup()}, mas retorna o par @code{(match, rest)} onde @code{match} é @code{subgroup(condition)} e @code{rest} é a parte restante não correspondente.
@end deffn

@geindex derive() (método BaseExceptionGroup)
@anchor{library/exceptions BaseExceptionGroup derive}@anchor{17b3}
@deffn {Método} derive (excs)

Retorna um grupo de exceções com o mesmo @ref{244e,,message}, mas que agrupa as exceções em @code{excs}.

Este método é usado por @ref{17b4,,subgroup()} e @ref{1670,,split()}, que são usados em vários contextos para dividir um grupo de exceções. Uma subclasse precisa substituí-la para fazer com que @ref{17b4,,subgroup()} e @ref{1670,,split()} retorne instâncias da subclasse em vez de @ref{1b6,,ExceptionGroup}.

@ref{17b4,,subgroup()} e @ref{1670,,split()} copiam os campos @ref{1309,,__traceback__}, @ref{130b,,__cause__}, @ref{130a,,__context__} e @ref{2419,,__notes__} do grupo de exceções original para o retornado por @ref{17b3,,derive()}, então esses campos não precisam ser atualizados por @ref{17b3,,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

Observe que @ref{25f,,BaseExceptionGroup} define @ref{580,,__new__()}, então subclasses que precisam de uma assinatura de construtor diferente precisam substituir isso ao invés de @ref{6b0,,__init__()}. Por exemplo, o seguinte define uma subclasse de grupo de exceções que aceita um exit_code e constrói a mensagem do grupo a partir dele.

@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

Como @ref{1b6,,ExceptionGroup}, qualquer subclasse de @ref{25f,,BaseExceptionGroup} que também é uma subclasse de @ref{9e2,,Exception} só pode agrupar instâncias de @ref{9e2,,Exception}.


Adicionado na versão 3.11.

@end deffn

@node Hierarquia das exceções,,Grupos de exceções,Exceções embutidas
@anchor{library/exceptions exception-hierarchy}@anchor{2450}
@subsection Hierarquia das exceções


A hierarquia de classes para exceções embutidas é:

@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{2351}
@node Serviços de Processamento de Texto,Serviços de Dados Binários,Exceções embutidas,A Biblioteca Padrão do Python
@anchor{library/text doc}@anchor{2451}@anchor{library/text text-processing-services}@anchor{2452}@anchor{library/text textservices}@anchor{2354}@anchor{library/text translation-repo}@anchor{2453}
@section Serviços de Processamento de Texto


Os módulos descritos neste capítulo fornecem uma ampla variedade de operações de manipulação de string e outros serviços de processamento de texto.

O módulo @ref{1b,,codecs} descrito em @ref{2454,,Serviços de Dados Binários} também é altamente relevante para o processamento de texto. Além disso, consulte a documentação do tipo string do Python em @ref{1d7a,,Tipo sequência de texto — str}.

@menu
* string — Operações comuns de strings:: 
* re — Operações com expressões regulares:: 
* difflib — Helpers for computing deltas:: 
* textwrap — Quebra automática e preenchimento de texto:: 
* unicodedata — Banco de dados de Unicode:: 
* stringprep — Preparação de string para internet:: 
* readline — Interface para o GNU readline:: 
* rlcompleter — Função de autocomplemento para GNU readline:: 

@end menu

@node string — Operações comuns de strings,re — Operações com expressões regulares,,Serviços de Processamento de Texto
@anchor{library/string doc}@anchor{2455}@anchor{library/string module-string}@anchor{d3}@anchor{library/string string-common-string-operations}@anchor{2456}
@subsection @code{string} — Operações comuns de strings


@geindex module; string

`Código-fonte:' Lib/string.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/string.py}


__________________________________________________________________



@subsubheading Ver também


@ref{1d7a,,Tipo sequência de texto — str}

@ref{1d7b,,String Methods}


@menu
* Constantes de strings:: 
* Formatação personalizada de strings:: 
* Sintaxe das strings de formato:: 
* Strings template:: 
* Funções auxiliares:: 

@end menu

@node Constantes de strings,Formatação personalizada de strings,,string — Operações comuns de strings
@anchor{library/string string-constants}@anchor{2457}
@subsubsection Constantes de strings


As constantes definidas neste módulo são:

@geindex ascii_letters (no módulo string)
@anchor{library/string string ascii_letters}@anchor{1306}
@deffn {Dado} string.ascii_letters

A concatenação das constantes @ref{2458,,ascii_lowercase} e @ref{2459,,ascii_uppercase} descritas abaixo. Este valor não depende da localidade.
@end deffn

@geindex ascii_lowercase (no módulo string)
@anchor{library/string string ascii_lowercase}@anchor{2458}
@deffn {Dado} string.ascii_lowercase

As letras minúsculas @code{'abcdefghijklmnopqrstuvwxyz'}. Este valor não depende da localidade e não mudará.
@end deffn

@geindex ascii_uppercase (no módulo string)
@anchor{library/string string ascii_uppercase}@anchor{2459}
@deffn {Dado} string.ascii_uppercase

As letras maiúsculas @code{'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}. Este valor não depende da localidade e não mudará.
@end deffn

@geindex digits (no módulo string)
@anchor{library/string string digits}@anchor{245a}
@deffn {Dado} string.digits

A string @code{'0123456789'}.
@end deffn

@geindex hexdigits (no módulo string)
@anchor{library/string string hexdigits}@anchor{245b}
@deffn {Dado} string.hexdigits

A string @code{'0123456789abcdefABCDEF'}.
@end deffn

@geindex octdigits (no módulo string)
@anchor{library/string string octdigits}@anchor{245c}
@deffn {Dado} string.octdigits

A string @code{'01234567'}.
@end deffn

@geindex punctuation (no módulo string)
@anchor{library/string string punctuation}@anchor{245d}
@deffn {Dado} string.punctuation

String de caracteres ASCII que são considerados caracteres de pontuação na localidade @code{C}: @code{!"#$%&'()*+,-./:;<=>?@@[\]^_`@{|@}~}.
@end deffn

@geindex printable (no módulo string)
@anchor{library/string string printable}@anchor{166d}
@deffn {Dado} string.printable

String de caracteres ASCII que são considerados imprimíveis pelo Python. Esta é uma combinação de @ref{245a,,digits}, @ref{1306,,ascii_letters}, @ref{245d,,punctuation} e @ref{245e,,whitespace}.

@cartouche
@quotation Nota 
Por design, @ref{e02,,string.printable.isprintable()} retorna @ref{b49,,False}. Em particular, @code{string.printable} não é imprimível no sentido POSIX (veja @code{LC_CTYPE@footnote{https://manpages.debian.org/locale(5)}}).
@end quotation
@end cartouche
@end deffn

@geindex whitespace (no módulo string)
@anchor{library/string string whitespace}@anchor{245e}
@deffn {Dado} string.whitespace

Uma string contendo todos os caracteres ASCII que são considerados espaços em branco. Isso inclui espaço de caracteres, tabulação, avanço de linha, retorno, avanço de formulário e tabulação vertical.
@end deffn

@node Formatação personalizada de strings,Sintaxe das strings de formato,Constantes de strings,string — Operações comuns de strings
@anchor{library/string custom-string-formatting}@anchor{245f}@anchor{library/string string-formatting}@anchor{2353}
@subsubsection Formatação personalizada de strings


A classe embutida de string fornece a capacidade de fazer substituições de variáveis complexas e formatação de valor por meio do método @ref{621,,format()} descrito na 
@geindex Propostas de Melhorias do Python; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/}. A classe @ref{eec,,Formatter} no módulo @ref{d3,,string} permite que você crie e personalize seus próprios comportamentos de formatação de strings usando a mesma implementação que o método embutido @ref{621,,format()}.

@geindex Formatter (classe em string)
@anchor{library/string string Formatter}@anchor{eec}
@deffn {Classe} string.Formatter

A classe @ref{eec,,Formatter} tem os seguintes métodos públicos:

@geindex format() (método string.Formatter)
@anchor{library/string string Formatter format}@anchor{c1a}
@deffn {Método} format (format_string, /, *args, **kwargs)

O método principal da API. Ele aceita uma string de formato e um conjunto arbitrário de argumentos posicionais e nomeados. É apenas um invólucro que chama @ref{2460,,vformat()}.


Alterado na versão 3.7: Um argumento de string de formato é agora @ref{a8f,,somente-posicional}.

@end deffn

@geindex vformat() (método string.Formatter)
@anchor{library/string string Formatter vformat}@anchor{2460}
@deffn {Método} vformat (format_string, args, kwargs)

Esta função realiza o trabalho real de formatação. Ela é exposta como uma função separada para casos onde você deseja passar um dicionário predefinido de argumentos, ao invés de desempacotar e empacotar novamente o dicionário como argumentos individuais usando a sintaxe @code{*args} e @code{**kwargs}. @ref{2460,,vformat()} faz o trabalho de quebrar a string de formato em dados de caracteres e campos de substituição. Ela chama os vários métodos descritos abaixo.
@end deffn

Além disso, o @ref{eec,,Formatter} define uma série de métodos que devem ser substituídos por subclasses:

@geindex parse() (método string.Formatter)
@anchor{library/string string Formatter parse}@anchor{2461}
@deffn {Método} parse (format_string)

Percorre format_string e retorna um iterável de tuplas (`literal_text', `field_name', `format_spec', `conversion'). Isso é usado por @ref{2460,,vformat()} para quebrar a string em texto literal ou campos de substituição.

Os valores na tupla representam conceitualmente um intervalo de texto literal seguido por um único campo de substituição. Se não houver texto literal (o que pode acontecer se dois campos de substituição ocorrerem consecutivamente), então `literal_text' será uma string de comprimento zero. Se não houver campo de substituição, então os valores de `field_name', `format_spec' e `conversion' serão @code{None}.
@end deffn

@geindex get_field() (método string.Formatter)
@anchor{library/string string Formatter get_field}@anchor{2462}
@deffn {Método} get_field (field_name, args, kwargs)

Dado `field_name' conforme retornado por @ref{2461,,parse()} (veja acima), converte-o em um objeto a ser formatado. Retorna uma tupla (obj, used_key). A versão padrão aceita strings no formato definido na 
@geindex Propostas de Melhorias do Python; PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/}, como “0[name]” ou “label.title”. `args' e `kwargs' são como passados para @ref{2460,,vformat()}. O valor de retorno `used_key' tem o mesmo significado que o parâmetro `key' para @ref{2463,,get_value()}.
@end deffn

@geindex get_value() (método string.Formatter)
@anchor{library/string string Formatter get_value}@anchor{2463}
@deffn {Método} get_value (key, args, kwargs)

Obtém um determinado valor de campo. O argumento `key' será um inteiro ou uma string. Se for um inteiro, ele representa o índice do argumento posicional em `args'; se for uma string, então representa um argumento nomeado em `kwargs'.

O parâmetro `args' é definido para a lista de argumentos posicionais para @ref{2460,,vformat()}, e o parâmetro `kwargs' é definido para o dicionário de argumentos nomeados.

Para nomes de campos compostos, essas funções são chamadas apenas para o primeiro componente do nome do campo; os componentes subsequentes são tratados por meio de operações normais de atributo e indexação.

Então, por exemplo, a expressão de campo ‘0.name’ faria com que @ref{2463,,get_value()} fosse chamado com um argumento `key' de 0. O atributo @code{name} será pesquisado após @ref{2463,,get_value()} retorna chamando a função embutida @ref{bea,,getattr()}.

Se o índice ou palavra-chave se referir a um item que não existe, um @ref{157e,,IndexError} ou @ref{344,,KeyError} deve ser levantada.
@end deffn

@geindex check_unused_args() (método string.Formatter)
@anchor{library/string string Formatter check_unused_args}@anchor{2464}
@deffn {Método} check_unused_args (used_args, args, kwargs)

Implementa a verificação de argumentos não usados, se desejar. Os argumentos para esta função são o conjunto de todas as chaves de argumento que foram realmente referidas na string de formato (inteiros para argumentos posicionais e strings para argumentos nomeados) e uma referência a `args' e `kwargs' que foi passada para vformat. O conjunto de argumentos não utilizados pode ser calculado a partir desses parâmetros. Presume-se que  @ref{2464,,check_unused_args()} levata uma exceção se a verificação falhar.
@end deffn

@geindex format_field() (método string.Formatter)
@anchor{library/string string Formatter format_field}@anchor{2465}
@deffn {Método} format_field (value, format_spec)

@ref{2465,,format_field()} simplesmente chama o global embutido @ref{61f,,format()}. O método é fornecido para que as subclasses possam substituí-lo.
@end deffn

@geindex convert_field() (método string.Formatter)
@anchor{library/string string Formatter convert_field}@anchor{2466}
@deffn {Método} convert_field (value, conversion)

Converte o valor (retornado por @ref{2462,,get_field()}) dado um tipo de conversão (como na tupla retornada pelo método @ref{2461,,parse()}). A versão padrão entende os tipos de conversão “s” (str), “r” (repr) e “a” (ascii).
@end deffn
@end deffn

@node Sintaxe das strings de formato,Strings template,Formatação personalizada de strings,string — Operações comuns de strings
@anchor{library/string format-string-syntax}@anchor{2467}@anchor{library/string formatstrings}@anchor{13e2}
@subsubsection Sintaxe das strings de formato


O método @ref{621,,str.format()} e a classe @ref{eec,,Formatter} compartilham a mesma sintaxe para strings de formato (embora no caso de @ref{eec,,Formatter}, as subclasses possam definir sua própria sintaxe de string de formato). A sintaxe é relacionada a @ref{9b1,,literais de string formatadas}, mas é menos sofisticada e, em especial, não tem suporte a expressões arbitrárias.

@geindex @{@} (chaves);na formatação de strings
@geindex . (ponto);na formatação de strings
@geindex [] (colchetes);na formatação de strings
@geindex ! (exclamação);na formatação de strings
@geindex ; (dois pontos);na formatação de strings

As strings de formato contêm “campos de substituição” entre chaves @code{@{@}}. Tudo o que não estiver entre chaves é considerado texto literal, que é copiado inalterado para a saída. Se você precisar incluir um caractere de chave no texto literal, ele pode ser escapado duplicando: @code{@{@{} e @code{@}@}}.

A gramática para um campo de substituição é a seguinte:

@example
@anchor{library/string grammar-token-format-string-replacement_field}@anchor{2468}replacement_field ::= "@{" [@ref{2469,,field_name}] ["!" @ref{246a,,conversion}] [":" @ref{246b,,format_spec}] "@}"
@anchor{library/string grammar-token-format-string-field_name}@anchor{2469}field_name        ::= @ref{246c,,arg_name} ("." @ref{246d,,attribute_name} | "[" @ref{246e,,element_index} "]")*
@anchor{library/string grammar-token-format-string-arg_name}@anchor{246c}arg_name          ::= [@ref{2023,,identifier} | @ref{205c,,digit}+]
@anchor{library/string grammar-token-format-string-attribute_name}@anchor{246d}attribute_name    ::= @ref{2023,,identifier}
@anchor{library/string grammar-token-format-string-element_index}@anchor{246e}element_index     ::= @ref{205c,,digit}+ | @ref{246f,,index_string}
@anchor{library/string grammar-token-format-string-index_string}@anchor{246f}index_string      ::= <any source character except "]"> +
@anchor{library/string grammar-token-format-string-conversion}@anchor{246a}conversion        ::= "r" | "s" | "a"
@anchor{library/string grammar-token-format-string-format_spec}@anchor{246b}format_spec       ::= @ref{2470,,format-spec;format_spec}
@end example

Em termos menos formais, o campo de substituição pode começar com um `field_name' que especifica o objeto cujo valor deve ser formatado e inserido na saída em vez do campo de substituição. O `field_name' é opcionalmente seguido por um campo `conversion', que é precedido por um ponto de exclamação @code{'!'}, e um `format_spec', que é precedido por dois pontos @code{':'}. Eles especificam um formato não padrão para o valor de substituição.

Veja também a seção @ref{1e8,,Minilinguagem de especificação de formato}.

O próprio `field_name' começa com um `arg_name' que é um número ou uma palavra-chave. Se for um número, ele se refere a um argumento posicional, e se for uma palavra-chave, ele se refere a um argumento nomeado. Um `arg_name' é tratado como um número se uma chamada para @ref{235a,,str.isdecimal()} na string retorna verdadeira. Se os arg_names numéricos em uma string de formato forem 0, 1, 2, … em sequência, eles podem ser todos omitidos (não apenas alguns) e os números 0, 1, 2, … serão inseridos automaticamente nessa ordem. Como `arg_name' não é delimitado por aspas, não é possível especificar chaves de dicionário arbitrárias (por exemplo, as strings @code{'10'} ou @code{':-]'}) dentro de uma string de formato. O `arg_name' pode ser seguido por qualquer número de expressões de índice ou atributo. Uma expressão da forma @code{'.name'} seleciona o atributo nomeado usando @ref{bea,,getattr()}, enquanto uma expressão da forma @code{'[index]'} faz uma pesquisa de índice usando @ref{283,,__getitem__()}.


Alterado na versão 3.1: Os especificadores de argumento posicional podem ser omitidos para @ref{621,,str.format()}, de forma que @code{'@{@} @{@}'.format(a, b)} é equivalente a @code{'@{0@} @{1@}'.format(a, b)}.



Alterado na versão 3.4: Os especificadores de argumento posicional podem ser omitidos para @ref{eec,,Formatter}.


Alguns exemplos simples de string de formato:

@example
"Primeiro, tu deverás contar até @{0@}"  # Referencia o primeiro argumento posicional
"Traga-me um @{@}"                       # Referencia implicitamente o primeiro argumento posicional
"De @{@} para @{@}"                        # Mesmo que "De @{0@} para @{1@}"
"Minha missão é @{nome@}"                # Referencia argumento nomeado 'nome'
"Peso em toneladas @{0.peso@}"           # O atributo 'peso' do primeiro argumento posicional
"Unidades destruídas: @{jogadores[0]@}"  # Primeiro elemento do argumento nomeado 'jogadores'.
@end example

O campo `conversion' causa uma coerção de tipo antes da formatação. Normalmente, o trabalho de formatação de um valor é feito pelo método @ref{61e,,__format__()} do próprio valor. No entanto, em alguns casos, é desejável forçar um tipo a ser formatado como uma string, substituindo sua própria definição de formatação. Ao converter o valor em uma string antes de chamar @ref{61e,,__format__()}, a lógica de formatação normal é contornada.

Três sinalizadores de conversão são atualmente suportados: @code{'!s'}, que chama @ref{44c,,str()} no valor; @code{'!r'}, que chama @ref{800,,repr()}; e @code{'!a'}, que chama @ref{142d,,ascii()}.

Alguns exemplos:

@example
"Harold's a clever @{0!s@}"        # Chama str() no primeiro argumento
"Bring out the holy @{name!r@}"    # Chama repr() no primeiro argumento
"More @{!a@}"                      # Chama ascii() no primeiro argumento
@end example

O campo `format_spec' contém uma especificação de como o valor deve ser apresentado, incluindo detalhes como largura do campo, alinhamento, preenchimento, precisão decimal e assim por diante. Cada tipo de valor pode definir sua própria “minilinguagem de formatação” ou interpretação de `format_spec'.

A maioria dos tipos embutidos oferece suporte a uma minilinguagem de formatação comum, que é descrita na próxima seção.

Um campo `format_spec' também pode incluir campos de substituição aninhados dentro dele. Esses campos de substituição aninhados podem conter um nome de campo, sinalizador de conversão e especificação de formato, mas um aninhamento mais profundo não é permitido. Os campos de substituição em format_spec são substituídos antes que a string `format_spec' seja interpretada. Isso permite que a formatação de um valor seja especificada dinamicamente.

Veja a seção @ref{2471,,Exemplos de formato} para alguns exemplos.

@menu
* Minilinguagem de especificação de formato:: 
* Exemplos de formato:: 

@end menu

@node Minilinguagem de especificação de formato,Exemplos de formato,,Sintaxe das strings de formato
@anchor{library/string format-specification-mini-language}@anchor{2472}@anchor{library/string formatspec}@anchor{1e8}
@subsubsection Minilinguagem de especificação de formato


“Especificações de formato” são usadas nos campos de substituição contidos em uma string de formato para definir como os valores individuais são apresentados (consulte @ref{13e2,,Sintaxe das strings de formato} e @ref{9b1,,f-strings}). Elas também podem ser passadas diretamente para a função embutida @ref{61f,,format()}. Cada tipo formatável pode definir como a especificação do formato deve ser interpretada.

A maioria dos tipos embutidos implementa as seguintes opções para especificações de formato, embora algumas das opções de formatação sejam suportadas apenas pelos tipos numéricos.

Uma convenção geral é que uma especificação de formato vazia produz o mesmo resultado como se você tivesse chamado @ref{44c,,str()} no valor. Uma especificação de formato não vazio normalmente modifica o resultado.

A forma geral de um `especificador de formato padrão' é:

@example
@anchor{library/string grammar-token-format-spec-format_spec}@anchor{2470}format_spec ::= [@ref{2473,,options}][@ref{2474,,width}][@ref{2475,,grouping}]["." @ref{2476,,precision}][@ref{2477,,type}]
@anchor{library/string grammar-token-format-spec-options}@anchor{2473}options     ::= [[@ref{2478,,fill}]@ref{2479,,align}][@ref{247a,,sign}]["z"]["#"]["0"]
@anchor{library/string grammar-token-format-spec-fill}@anchor{2478}fill        ::= <any character>
@anchor{library/string grammar-token-format-spec-align}@anchor{2479}align       ::= "<" | ">" | "=" | "^"
@anchor{library/string grammar-token-format-spec-sign}@anchor{247a}sign        ::= "+" | "-" | " "
@anchor{library/string grammar-token-format-spec-width}@anchor{2474}width       ::= @ref{205c,,digit}+
@anchor{library/string grammar-token-format-spec-grouping}@anchor{2475}grouping    ::= "," | "_"
@anchor{library/string grammar-token-format-spec-precision}@anchor{2476}precision   ::= @ref{205c,,digit}+
@anchor{library/string grammar-token-format-spec-type}@anchor{2477}type        ::= "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g"
                | "G" | "n" | "o" | "s" | "x" | "X" | "%"
@end example

Se um valor `align'  válido for especificado, ele pode ser precedido por um caractere de preenchimento `fill' que pode ser qualquer caractere e o padrão é um espaço se omitido. Não é possível usar uma chave literal (”@code{@{}” ou “@code{@}}”) como o caractere `fill' em uma @ref{9b1,,string formatada literal} ou ao usar o método @ref{621,,str.format()}. No entanto, é possível inserir uma chave com um campo de substituição aninhado. Esta limitação não afeta a função @ref{61f,,format()}.

O significado das várias opções de alinhamento é o seguinte:

@geindex < (menor que);na formatação de strings
@geindex > (maior);na formatação de strings
@geindex = (igual);na formatação de strings
@geindex ^ (circunflexo);na formatação de strings


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Significado

@item

@code{'<'}

@tab

Força o alinhamento à esquerda do campo dentro do espaço disponível (este é o padrão para a maioria dos objetos).

@item

@code{'>'}

@tab

Força o alinhamento à direita do campo dentro do espaço disponível (este é o padrão para números).

@item

@code{'='}

@tab

Força o preenchimento a ser colocado após o sinal (se houver), mas antes dos dígitos. É usado para imprimir campos na forma “+000000120”. Esta opção de alinhamento só é válida para tipos numéricos, excluindo @ref{2f8,,complex}. Torna-se o padrão para números quando “0” precede imediatamente a largura do campo.

@item

@code{'^'}

@tab

Força a centralização do campo no espaço disponível.

@end multitable


Observe que, a menos que uma largura de campo mínima seja definida, a largura do campo sempre será do mesmo tamanho que os dados para preenchê-lo, de modo que a opção de alinhamento não tem significado neste caso.

A opção `sign' só é válida para tipos numéricos e pode ser um dos seguintes:

@geindex + (mais);na formatação de strings
@geindex - (menos);na formatação de strings
@geindex espaço;na formatação de strings


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Significado

@item

@code{'+'}

@tab

indica que um sinal deve ser usado para números positivos e negativos.

@item

@code{'-'}

@tab

indica que um sinal deve ser usado apenas para números negativos (este é o comportamento padrão).

@item

espaço

@tab

indica que um espaço inicial deve ser usado em números positivos e um sinal de menos em números negativos.

@end multitable


@geindex z;na formatação de strings

A opção @code{'z'} força valores de ponto flutuante de zero negativo para zero positivo após o arredondamento para a precisão do formato. Esta opção só é válida para tipos de apresentação de ponto flutuante.


Alterado na versão 3.11: Adicionada a opção @code{'z'} (veja também 
@geindex Propostas de Melhorias do Python; PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/}).


@geindex # (cerquilha);na formatação de strings

A opção @code{'#'} faz com que a “forma alternativa” seja usada para a conversão. A forma alternativa é definida de forma diferente para diferentes tipos. Esta opção é válida apenas para tipos inteiros, pontos flutuantes e complexos. Para inteiros, quando a saída binária, octal ou hexadecimal é usada, esta opção adiciona o prefixo respectivo @code{'0b'}, @code{'0o'}, @code{'0x'} ou @code{'0X'} ao valor de saída. Para pontos flutuante e complexo, a forma alternativa faz com que o resultado da conversão sempre contenha um caractere de ponto decimal, mesmo se nenhum dígito o seguir. Normalmente, um caractere de ponto decimal aparece no resultado dessas conversões apenas se um dígito o seguir. Além disso, para conversões @code{'g'} e @code{'G'}, os zeros finais não são removidos do resultado.

O `width' é um número inteiro decimal que define a largura total mínima do campo, incluindo quaisquer prefixos, separadores e outros caracteres de formatação. Se não for especificado, a largura do campo será determinada pelo conteúdo.

Quando nenhum alinhamento explícito é fornecido, preceder o campo `width' com um caractere zero (@code{'0'}) habilita o preenchimento por zero com reconhecimento de sinal para tipos numéricos excluindo @ref{2f8,,complex}. Isso é equivalente a um caractere de `fill' de valor @code{'0'} com um tipo de `alignment' de @code{'='}.


Alterado na versão 3.10: Precedendo o campo `width' com @code{'0'} não afeta mais o alinhamento padrão para strings.


A opção `grouping' após o campo `width' especifica um separador de grupo de dígitos para a parte inteira de um número. Pode ser um dos seguintes:

@geindex @comma{} (vírgula);na formatação de strings
@geindex _ (sublinhado);na formatação de strings


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Significado

@item

@code{','}

@tab

Insere uma vírgula a cada 3 dígitos para tipos de apresentação inteiros @code{'d'} e de ponto flutuante, excluindo @code{'n'}. Para outros tipos de apresentação, esta opção não é suportada.

@item

@code{'_'}

@tab

Insere um sublinhado a cada 3 dígitos para tipos de apresentação inteiros @code{'d'} e tipos de apresentação de ponto flutuante, excluindo @code{'n'}. Para tipos de apresentação inteiros @code{'b'}, @code{'o'}, @code{'x'} e @code{'X'}, os sublinhados são inseridos a cada 4 dígitos. Para outros tipos de apresentação, esta opção não é suportada.

@end multitable


Para um separador com reconhecimento de localidade, usa o tipo de apresentação @code{'n'}.


Alterado na versão 3.1: Adicionada a opção @code{','} (veja também 
@geindex Propostas de Melhorias do Python; PEP 378
PEP 378@footnote{https://peps.python.org/pep-0378/}).



Alterado na versão 3.6: Adicionada a opção @code{'_'} (veja também 
@geindex Propostas de Melhorias do Python; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}).


`precision' é um número decimal que indica quantos dígitos devem ser exibidos depois do ponto decimal para um valor de ponto flutuante formatado com @code{'f'} e @code{'F'}, ou antes e depois do ponto decimal para um valor de ponto flutuante formatado com @code{'g'} ou @code{'G'}. Para tipos não numéricos, o campo indica o tamanho máximo do campo – em outras palavras, quantos caracteres serão usados do conteúdo do campo. `precision' não é permitido para valores inteiros.

Finalmente, o `type' determina como os dados devem ser apresentados.

Os tipos de apresentação de string disponíveis são:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'s'}

@tab

Formato de string. Este é o tipo padrão para strings e pode ser omitido.

@item

None

@tab

O mesmo que @code{'s'}.

@end multitable

@end quotation

Os tipos de apresentação inteira disponíveis são:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'b'}

@tab

Formato binário. Exibe o número na base 2.

@item

@code{'c'}

@tab

Caractere. Converte o inteiro no caractere Unicode correspondente antes de imprimir.

@item

@code{'d'}

@tab

Inteiro decimal. Exibe o número na base 10.

@item

@code{'o'}

@tab

Formato octal. Exibe o número na base 8.

@item

@code{'x'}

@tab

Formato hexadecimal. Produz o número na base 16, usando letras minúsculas para os dígitos acima de 9.

@item

@code{'X'}

@tab

Formato hexadecimal. Produz o número na base 16, usando letras maiúsculas para os dígitos acima de 9. No caso de @code{'#'} ser especificado, o prefixo @code{'0x'} será maiúsculo para @code{'0X'} também.

@item

@code{'n'}

@tab

Número. É o mesmo que @code{'d'}, exceto que usa a configuração de localidade atual para inserir os separadores de grupo de dígitos apropriados.

@item

None

@tab

O mesmo que @code{'d'}.

@end multitable

@end quotation

Além dos tipos de apresentação acima, os inteiros podem ser formatados com os tipos de apresentação de ponto flutuante listados abaixo (exceto @code{'n'} e @code{None}). Ao fazer isso, @ref{2f7,,float()} é usado para converter o inteiro em um número de ponto flutuante antes da formatação.

Os tipos de apresentação disponíveis para @ref{2f7,,float} e @ref{29d,,Decimal} valores são:

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Significado

@item

@code{'e'}

@tab

Notação científica. Para uma dada precisão @code{p}, formata o número em notação científica com a letra “e” separando o coeficiente do expoente. O coeficiente tem um dígito antes e @code{p} dígitos depois do ponto decimal, para um total de @code{p + 1} dígitos significativos. Sem precisão fornecida, usa uma precisão de @code{6} dígitos após o ponto decimal para @ref{2f7,,float}, e mostra todos os dígitos de coeficiente para @ref{29d,,Decimal}. Se @code{p=0}, o ponto decimal é omitido a menos que a opção @code{#} seja usada.

For @ref{2f7,,float}, the exponent always contains at
least two digits, and is zero if the value is zero.

@item

@code{'E'}

@tab

Notação científica. O mesmo que @code{'e'}, exceto que usa um ‘E’ maiúsculo como caractere separador.

@item

@code{'f'}

@tab

Notação de ponto fixo. Para uma dada precisão @code{p}, formata o número como um número decimal com exatamente os @code{p} dígitos após o ponto decimal. Sem precisão fornecida, usa uma precisão de @code{6} dígitos após o ponto decimal para @ref{2f7,,float}, e usa uma precisão grande o suficiente para mostrar todos os dígitos de coeficiente para @ref{29d,,Decimal}. Se @code{p=0}, o ponto decimal é omitido a menos que a opção @code{#} seja usada.

@item

@code{'F'}

@tab

Notação de ponto fixo. O mesmo que @code{'f'}, mas converte @code{nan} para  @code{NAN} e @code{inf} para @code{INF}.

@item

@code{'g'}

@tab

Formato geral. Para uma determinada precisão @code{p >= 1}, isso arredonda o número para @code{p} dígitos significativos e então formata o resultado em formato de ponto fixo ou em notação científica, dependendo de sua magnitude. Uma precisão de @code{0} é tratada como equivalente a uma precisão de @code{1}.

As regras precisas são as seguintes: suponha que o resultado formatado com tipo de apresentação @code{'e'} e precisão @code{p-1} teria o expoente @code{exp}. Então, se @code{m <= exp < p}, onde @code{m} é -4 para pontos flutuantes e -6 para @ref{29d,,Decimals}, o número é formatado com o tipo de apresentação @code{'f'} e precisão @code{p-1-exp}. Caso contrário, o número é formatado com tipo de apresentação @code{'e'} e precisão @code{p-1}. Em ambos os casos, zeros à direita insignificantes são removidos do significando, e o ponto decimal também é removido se não houver dígitos restantes após ele, a menos que a opção @code{'#'} seja usada.

Sem precisão fornecida, usa uma precisão de @code{6} dígitos significativos para @ref{2f7,,float}. Para @ref{29d,,Decimal}, o coeficiente do resultado é formado a partir dos dígitos do coeficiente do valor; a notação científica é usada para valores menores que @code{1e-6} em valor absoluto e valores onde o valor posicional do dígito menos significativo é maior que 1, e a notação de ponto fixo é usada de outra forma.

Infinito positivo e negativo, zero positivo e negativo e nans, são formatados como @code{inf}, @code{-inf}, @code{0}, @code{-0} e @code{nan}, respectivamente, independentemente da precisão.

@item

@code{'G'}

@tab

Formato geral. O mesmo que @code{'g'}, exceto muda para @code{'E'} se o número ficar muito grande. As representações de infinito e NaN também são maiúsculas.

@item

@code{'n'}

@tab

Número. É o mesmo que @code{'g'}, exceto que usa a configuração de localidade atual para inserir os separadores de grupo de dígitos apropriados para a parte inteira de um número.

@item

@code{'%'}

@tab

Porcentagem. Multiplica o número por 100 e exibe no formato fixo (@code{'f'}), seguido por um sinal de porcentagem.

@item

None

@tab

Para @ref{2f7,,float}, é o como o tipo @code{'g'}, exceto que quando a notação de ponto fixo é usada para formatar o resultado, ela sempre inclui pelo menos um dígito após a ponto decimal, e troca para a notação científica quando @code{exp >= p - 1}. Quando a precisão não é especificada, este último será tão grande quanto necessário para representar o valor fornecido fielmente.

Para @ref{29d,,Decimal}, é o mesmo que @code{'g'} ou @code{'G'} dependendo do valor de @code{context.capitals} para o contexto decimal atual.

O efeito geral é combinar a saída de @ref{44c,,str()} conforme alterada pelos outros modificadores de formato.

@end multitable

@end quotation

O resultado deve ser arredondado corretamente para uma precisão dada @code{p} de dígitos após o ponto decimal. O modo de arredondamento para @ref{2f7,,float} corresponde ao do builtin @ref{131d,,round()}. Para @ref{29d,,Decimal}, o modo de arredondamento do @ref{247b,,contexto} atual será usado.

Os tipos de apresentação disponíveis para @ref{2f8,,complex} são os mesmos que para @ref{2f7,,float} (@code{'%'} não é permitido). Os componentes real e imaginário de um número complexo são formatados como números de ponto flutuante, de acordo com o tipo de apresentação especificado. Eles são separados pelo sinal obrigatório da parte imaginária, sendo esta última terminada por um sufixo @code{j}. Se o tipo de apresentação estiver faltando, o resultado corresponderá à saída de @ref{44c,,str()} (números complexos com uma parte real diferente de zero também são cercados por parênteses), possivelmente alterados por outros modificadores de formato.

@node Exemplos de formato,,Minilinguagem de especificação de formato,Sintaxe das strings de formato
@anchor{library/string format-examples}@anchor{247c}@anchor{library/string formatexamples}@anchor{2471}
@subsubsection Exemplos de formato


Esta seção contém exemplos da sintaxe de @ref{621,,str.format()} e comparação com a antiga formatação @code{%}.

Na maioria dos casos a sintaxe é semelhante à antiga formatação de @code{%}, com a adição de @code{@{@}} e com @code{:} usado em vez de @code{%}. Por exemplo, @code{'%03.2f'} pode ser traduzido para @code{'@{:03.2f@}'}.

A nova sintaxe de formato também oferece suporte a opções novas e diferentes, mostradas nos exemplos a seguir.

Acessando os argumentos por posição:

@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')      # desempacotando sequência de argumentos
'c, b, a'
>>> '@{0@}@{1@}@{0@}'.format('abra', 'cad')   # índices dos argumentos podem ser repetidos
'abracadabra'
@end example

Acessando os argumentos por nome:

@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

Acessando os atributos dos 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

Acessando os itens dos argumentos:

@example
>>> coord = (3, 5)
>>> 'X: @{0[0]@};  Y: @{0[1]@}'.format(coord)
'X: 3;  Y: 5'
@end example

Substituindo @code{%s} e @code{%r}:

@example
>>> "repr() mostra aspas: @{!r@}; str() não mostra: @{!s@}".format('teste1', 'teste2')
"repr() mostra aspas: 'teste1'; str() não mostra: teste2"
@end example

Alinhando o texto e especificando uma largura:

@example
>>> '@{:<30@}'.format('alinhado à esquerda')
'alinhado à esquerda           '
>>> '@{:>30@}'.format('alinhado à direita')
'            alinhado à direita'
>>> '@{:^30@}'.format('centralizado')
'         centralizado         '
>>> '@{:*^30@}'.format('centralizado')  # usa '*' como preenchimento
'*********centralizado*********'
@end example

Substituindo @code{%+f}, @code{%-f} e @code{% f} e especificando um sinal:

@example
>>> '@{:+f@}; @{:+f@}'.format(3.14, -3.14)  # mostra sempre
'+3.140000; -3.140000'
>>> '@{: f@}; @{: f@}'.format(3.14, -3.14)  # mostra um espaço para números positivos
' 3.140000; -3.140000'
>>> '@{:-f@}; @{:-f@}'.format(3.14, -3.14)  # mostra apenas o sinal de menos -- mesmo que '@{:f@}; @{:f@}'
'3.140000; -3.140000'
@end example

Substituindo @code{%x} e @code{%o} e convertendo o valor para bases diferentes:

@example
>>> # format também tem suporte a números binários
>>> "int: @{0:d@};  hex: @{0:x@};  oct: @{0:o@};  bin: @{0:b@}".format(42)
'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
>>> # com 0x, 0o ou 0b como prefixo:
>>> "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 a vírgula ou o sublinhado como separador de grupos de dígitos:

@example
>>> '@{:,@}'.format(1234567890)
'1,234,567,890'
>>> '@{:_@}'.format(1234567890)
'1_234_567_890'
>>> '@{:_b@}'.format(1234567890)
'100_1001_1001_0110_0000_0010_1101_0010'
>>> '@{:_x@}'.format(1234567890)
'4996_02d2'
@end example

Expressando uma porcentagem:

@example
>>> points = 19
>>> total = 22
>>> 'Correct answers: @{:.2%@}'.format(points/total)
'Correct answers: 86.36%'
@end example

Usando formatação específica do 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

Argumentos de aninhamento e exemplos mais complexos:

@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 Strings template,Funções auxiliares,Sintaxe das strings de formato,string — Operações comuns de strings
@anchor{library/string id1}@anchor{247d}@anchor{library/string template-strings}@anchor{236b}
@subsubsection Strings template


Strings template fornecem substituições de string mais simples, conforme descrito em 
@geindex Propostas de Melhorias do Python; PEP 292
PEP 292@footnote{https://peps.python.org/pep-0292/}. Um caso de uso primário para strings template é para internacionalização (i18n), uma vez que, nesse contexto, a sintaxe e a funcionalidade mais simples tornam mais fácil traduzir do que outros recursos embutidos de formatação de strings no Python. Como um exemplo de biblioteca construída sobre strings template para i18n, veja o pacote flufl.i18n@footnote{https://flufli18n.readthedocs.io/en/latest/}.

@geindex $ (dólar);em strings template

Strings template oferecem suporte a substituições baseadas em @code{$}, usando as seguintes regras:


@itemize *

@item 
@code{$$} é um escape; é substituído por um único @code{$}.

@item 
@code{$identifier} nomeia um espaço reservado de substituição correspondendo a uma chave de mapeamento de @code{"identifier"}. Por padrão, @code{"identifier"} é restrito a qualquer string ASCII alfanumérica que não faz distinção entre maiúsculas e minúsculas (incluindo sublinhados) que começa com um sublinhado ou letra ASCII. O primeiro caractere não identificador após o caractere @code{$} termina esta especificação de espaço reservado.

@item 
@code{$@{identifier@}}  é equivalente a @code{$identifier}. É necessário quando caracteres identificadores válidos seguem o marcador de posição, mas não fazem parte do marcador, como @code{"$@{noun@}ification"}.
@end itemize

Qualquer outra ocorrência de @code{$} na string resultará em uma @ref{202,,ValueError} sendo levantada.

O módulo @ref{d3,,string} fornece uma classe @ref{687,,Template} que implementa essas regras. Os métodos de @ref{687,,Template} são:

@geindex Template (classe em string)
@anchor{library/string string Template}@anchor{687}
@deffn {Classe} string.Template (template)

O construtor recebe um único argumento que é a string template

@geindex substitute() (método string.Template)
@anchor{library/string string Template substitute}@anchor{247e}
@deffn {Método} substitute (mapping=@{@}, /, **kwds)

Executa a substituição do modelo, retornando uma nova string. `mapping' é qualquer objeto dicionário ou similar com chaves que correspondem aos marcadores de posição no modelo. Como alternativa, você pode fornecer argumentos nomeados, os quais são espaços reservados. Quando `mapping' e `kwds' são fornecidos e há duplicatas, os marcadores de `kwds' têm precedência.
@end deffn

@geindex safe_substitute() (método string.Template)
@anchor{library/string string Template safe_substitute}@anchor{247f}
@deffn {Método} safe_substitute (mapping=@{@}, /, **kwds)

Como @ref{247e,,substitute()}, exceto que se os espaços reservados estiverem faltando em `mapping' e `kwds', em vez de levantar uma exceção @ref{344,,KeyError}, o espaço reservado original aparecerá na string resultante intacta. Além disso, ao contrário de @ref{247e,,substitute()}, qualquer outra ocorrência de @code{$} simplesmente retornará @code{$} em vez de levantar @ref{202,,ValueError}.

Embora outras exceções ainda possam ocorrer, esse método é chamado de “seguro” porque sempre tenta retornar uma string utilizável em vez de levantar uma exceção. Em outro sentido, @ref{247f,,safe_substitute()} pode ser qualquer coisa diferente de seguro, uma vez que irá ignorar silenciosamente modelos malformados contendo delimitadores pendentes, chaves não correspondidas ou espaços reservados que não são identificadores Python válidos.
@end deffn

@geindex is_valid() (método string.Template)
@anchor{library/string string Template is_valid}@anchor{686}
@deffn {Método} is_valid ()

Retorna @code{False} se o modelo tiver espaços reservados inválidos que farão com que @ref{247e,,substitute()} levante @ref{202,,ValueError}.


Adicionado na versão 3.11.

@end deffn

@geindex get_identifiers() (método string.Template)
@anchor{library/string string Template get_identifiers}@anchor{685}
@deffn {Método} get_identifiers ()

Retorna uma lista dos identificadores válidos no modelo, na ordem em que aparecem pela primeira vez, ignorando quaisquer identificadores inválidos.


Adicionado na versão 3.11.

@end deffn

Instâncias de @ref{687,,Template} também fornecem um atributo de dados públicos:

@geindex template (atributo string.Template)
@anchor{library/string string Template template}@anchor{2480}
@deffn {Atributo} template

Este é o objeto passado para o argumento `template' do construtor. Em geral, você não deve alterá-lo, mas o acesso somente leitura não é obrigatório.
@end deffn
@end deffn

Aqui está um exemplo de como usar uma instância de 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 avançado: você pode derivar subclasses de @ref{687,,Template} para personalizar a sintaxe do espaço reservado, caractere delimitador ou toda a expressão regular usada para analisar strings template. Para fazer isso, você pode substituir estes atributos de classe:


@itemize *

@item 
`delimiter' – Este é a string literal que descreve um delimitador de introdução do espaço reservado. O valor padrão é @code{$}. Note que esta `não' deve ser uma expressão regular, já que a implementação irá chamar @ref{c23,,re.escape()} nesta string conforme necessário. Observe também que você não pode alterar o delimitador após a criação da classe (ou seja, um delimitador diferente deve ser definido no espaço de nomes da classe da subclasse).

@item 
`idpattern' – Esta é a expressão regular que descreve o padrão para espaço reservado sem envolto em chaves. O valor padrão é a expressão regular @code{(?a:[_a-z][_a-z0-9]*)}. Se for fornecido e `braceidpattern' for @code{None}, esse padrão também se aplicará o espaço reservado com chaves.

@cartouche
@quotation Nota 
Uma vez que `flags' padrão é @code{re.IGNORECASE}, o padrão @code{[a-z]} pode corresponder a alguns caracteres não ASCII. É por isso que usamos o sinalizador local @code{a} aqui.
@end quotation
@end cartouche


Alterado na versão 3.7: `braceidpattern' pode ser usado para definir padrões separados usados dentro e fora das chaves.


@item 
`braceidpattern' – É como `idpattern', mas descreve o padrão para espaços reservados com chaves. O padrão é @code{None}, o que significa recorrer a `idpattern' (ou seja, o mesmo padrão é usado dentro e fora das chaves). Se fornecido, permite definir padrões diferentes para espaço reservado com e sem chaves.


Adicionado na versão 3.7.


@item 
`flags' – Os sinalizadores de expressão regular que serão aplicados ao compilar a expressão regular usada para reconhecer substituições. O valor padrão é @code{re.IGNORECASE}. Note que @code{re.VERBOSE} sempre será adicionado aos sinalizadores, então `idpattern's personalizados devem seguir as convenções para expressões regulares verbosas.


Adicionado na versão 3.2.

@end itemize

Como alternativa, você pode fornecer todo o padrão de expressão regular substituindo o atributo `pattern' de classe. Se você fizer isso, o valor deve ser um objeto de expressão regular com quatro grupos de captura nomeados. Os grupos de captura correspondem às regras fornecidas acima, junto com a regra inválida do espaço reservado:


@itemize *

@item 
`escaped' – Este grupo corresponde à sequência de escape, por exemplo @code{$$}, no padrão.

@item 
`named' – Este grupo corresponde ao nome do espaço reservado sem chaves; não deve incluir o delimitador no grupo de captura.

@item 
`braced' – Este grupo corresponde ao nome do espaço reservado entre chaves; ele não deve incluir o delimitador ou chaves no grupo de captura.

@item 
`invalid' – Esse grupo corresponde a qualquer outro padrão de delimitador (geralmente um único delimitador) e deve aparecer por último na expressão regular.
@end itemize

Os métodos nesta classe irão levantar @ref{202,,ValueError} se o padrão corresponder ao modelo sem que um desses grupos nomeados corresponda.

@node Funções auxiliares,,Strings template,string — Operações comuns de strings
@anchor{library/string helper-functions}@anchor{2481}
@subsubsection Funções auxiliares


@geindex capwords() (no módulo string)
@anchor{library/string string capwords}@anchor{2366}
@deffn {Função} string.capwords (s, sep=None)

Divide o argumento em palavras usando @ref{ed9,,str.split()}, coloca cada palavra em maiúscula usando @ref{2355,,str.capitalize()}, e junte as palavras em maiúsculas usando @ref{2340,,str.join()}. Se o segundo argumento opcional `sep' estiver ausente ou @code{None}, os caracteres de espaço em branco são substituídos por um único espaço e os espaços em branco à esquerda e à direita são removidos, caso contrário `sep' é usado para dividir e unir as palavras.
@end deffn

@node re — Operações com expressões regulares,difflib — Helpers for computing deltas,string — Operações comuns de strings,Serviços de Processamento de Texto
@anchor{library/re doc}@anchor{2482}@anchor{library/re module-re}@anchor{b9}@anchor{library/re re-regular-expression-operations}@anchor{2483}@anchor{library/re translation-repo}@anchor{2484}
@subsection @code{re} — Operações com expressões regulares


@geindex module; re

`Código-fonte:' Lib/re/@footnote{https://github.com/python/cpython/tree/3.13/Lib/re/}


__________________________________________________________________


Este módulo fornece operações para correspondência de expressões regulares semelhantes às encontradas em Perl. O nome do módulo vem das iniciais do termo em inglês `regular expressions', também frequentemente chamadas de `regex'.

Tanto os padrões quanto as strings a serem pesquisados podem ser strings Unicode (@ref{44c,,str}) assim como strings de 8 bits (@ref{1c2,,bytes}). No entanto, strings Unicode e strings de 8 bits não podem ser misturadas: ou seja, você não pode corresponder uma string Unicode com um padrão de bytes ou vice-versa; da mesma forma, ao solicitar uma substituição, a string de substituição deve ser do mesmo tipo que o padrão e a string de pesquisa.

Expressões regulares usam o caractere de contrabarra (@code{'\'}) para indicar formas especiais ou para permitir que caracteres especiais sejam usados sem invocar seu significado especial. Isso colide com o uso em Python do mesmo caractere para o mesmo propósito em literais de string; por exemplo, para corresponder a uma contrabarra literal, pode-se ter que escrever @code{'\\\\'} como a string do padrão, porque a expressão regular deve ser @code{\\}, e cada contrabarra deve ser expressa como @code{\\} dentro de um literal de string Python regular. Além disso, observe que quaisquer sequências de escape inválidas no uso do Python da contrabarra em literais de string agora levantam uma exceção @ref{466,,SyntaxWarning} e no futuro isso se tornará um @ref{18d,,SyntaxError}. Esse comportamento acontecerá mesmo se for uma sequência de escape válida para uma expressão regular.

A solução é usar a notação de string bruta do Python para padrões de expressão regular; as contrabarras não são tratadas de nenhuma maneira especial em uma string literal com o prefixo @code{'r'}. Portanto, @code{r"\n"} é uma string de dois caracteres contendo @code{'\'} e @code{'n'}, enquanto @code{"\n"} é uma string de um caractere contendo uma nova linha. Normalmente, os padrões serão expressos em código Python usando esta notação de string bruta.

É importante notar que a maioria das operações de expressão regular estão disponíveis como funções e métodos em nível de módulo em @ref{fbb,,expressões regulares compiladas}. As funções são atalhos que não exigem que você compile um objeto de expressão regular primeiro, mas perdem-se alguns parâmetros de ajuste fino.


@subsubheading Ver também


O módulo de terceiros regex@footnote{https://pypi.org/project/regex/} possui uma API compatível com o módulo da biblioteca padrão @ref{b9,,re}, mas oferece funcionalidades adicionais e um suporte mais completo a Unicode.


@menu
* Sintaxe de expressão regular:: 
* Conteúdo do módulo:: 
* Objetos expressão regular:: 
* Objetos correspondência:: 
* Exemplos de expressão regular:: 

@end menu

@node Sintaxe de expressão regular,Conteúdo do módulo,,re — Operações com expressões regulares
@anchor{library/re re-syntax}@anchor{724}@anchor{library/re regular-expression-syntax}@anchor{2485}
@subsubsection Sintaxe de expressão regular


Uma expressão regular (ou ER) especifica um conjunto de strings que corresponde a ela; as funções neste módulo permitem que você verifique se uma determinada string corresponde a uma determinada expressão regular (ou se uma determinada expressão regular corresponde a uma determinada string, o que resulta na mesma coisa).

As expressões regulares podem ser concatenadas para formar novas expressões regulares; se `A' e `B' forem expressões regulares, então `AB' também será uma expressão regular. Em geral, se uma string `p' corresponder a `A' e outra string `q' corresponder a `B', a string `pq' corresponderá a AB. Isso é válido, a menos que `A' ou `B' contenham operações de baixa precedência; condições de contorno entre `A' e `B'; ou ter referências de grupo numeradas. Assim, expressões complexas podem ser facilmente construídas a partir de expressões primitivas mais simples, como as descritas aqui. Para obter detalhes sobre a teoria e implementação de expressões regulares, consulte o livro de Friedl @ref{2486,,[Frie09]}, ou quase qualquer livro sobre construção de compiladores.

Segue uma breve explicação do formato das expressões regulares. Para mais informações e uma apresentação mais suave, consulte o tutorial de @ref{2487,,Expressões Regulares}.

As expressões regulares podem conter caracteres especiais e comuns. A maioria dos caracteres comuns, como @code{'A'}, @code{'a'} ou @code{'0'}, são as expressões regulares mais simples; eles simplesmente se correspondem. Você pode concatenar caracteres comuns, de forma que @code{último} corresponda à string @code{'último'}. (No restante desta seção, escreveremos ERs @code{neste estilo especial}, geralmente sem aspas, e strings para serem correspondidas @code{'entre aspas simples'}.)

Alguns caracteres, como @code{'|'} ou @code{'('}, são especiais. Os caracteres especiais representam classes de caracteres comuns ou afetam como as expressões regulares em torno deles são interpretadas.

Operadores de repetição ou quantificadores (@code{*}, @code{+}, @code{?}, @code{@{m,n@}} etc) não podem ser aninhados diretamente. Isso evita ambiguidade com o sufixo modificador não guloso @code{?}, e com outros modificadores em outras implementações. Para aplicar uma segunda repetição a uma repetição interna, podem ser usados parênteses. Por exemplo, a expressão @code{(?:a@{6@})*} corresponde a qualquer múltiplo de seis caracteres @code{'a'}.

Os caracteres especiais são:

@geindex . (ponto);em expressões regulares


@table @asis

@item @code{.}

(Ponto.) No modo padrão, corresponde a qualquer caractere, exceto uma nova linha. Se o sinalizador @ref{2488,,DOTALL} foi especificado, ele corresponde a qualquer caractere, incluindo uma nova linha. @code{(?s:.)} corresponde a qualquer caractere independente de sinalizadores.
@end table

@geindex ^ (circunflexo);em expressões regulares


@table @asis

@item @code{^}

(Sinal de circunflexo.) Corresponde ao início da string, e no modo @ref{2489,,MULTILINE} também corresponde imediatamente após cada nova linha.
@end table

@geindex $ (dólar);em expressões regulares


@table @asis

@item @code{$}

Corresponde ao final da string ou logo antes da nova linha no final da string, e no modo @ref{2489,,MULTILINE} também corresponde antes de uma nova linha. @code{foo} corresponde a ‘foo’ e ‘foobar’, enquanto a expressão regular @code{foo$} corresponde apenas a ‘foo’. Mais interessante, pesquisar por @code{foo.$} em @code{'foo1\nfoo2\n'} corresponde a ‘foo2’ normalmente, mas ‘foo1’ no modo @ref{2489,,MULTILINE}; procurando por um único @code{$} em @code{'foo\n'} encontrará duas correspondências (vazias): uma logo antes da nova linha e uma no final da string.
@end table

@geindex * (asterisco);em expressões regulares


@table @asis

@item @code{*}

Faz a ER resultante corresponder a 0 ou mais repetições da ER anterior, tantas repetições quantas forem possíveis. @code{ab*} corresponderá a ‘a’, ‘ab’ ou ‘a’ seguido por uma quantidade qualquer de ‘b’s.
@end table

@geindex + (mais);em expressões regulares


@table @asis

@item @code{+}

Faz com que a ER resultante corresponda a 1 ou mais repetições da ER anterior. @code{ab+} irá corresponder a ‘a’ seguido por qualquer número diferente de zero de ‘b’s; não corresponderá apenas a ‘a’.
@end table

@geindex ? (interrogação);em expressões regulares


@table @asis

@item @code{?}

Faz a ER resultante corresponder a 0 ou 1 repetição da ER anterior. @code{ab?} irá corresponder a ‘a’ ou ‘ab’.
@end table

@geindex *?;em expressões regulares
@geindex +?;em expressões regulares
@geindex ??;em expressões regulares


@table @asis

@item @code{*?}, @code{+?}, @code{??}

Os quantificadores @code{'*'}, @code{'+'} e @code{'?'} são todos `gulosos'; eles correspondem ao máximo de texto possível. Às vezes, esse comportamento não é desejado; se a ER @code{<.*>} for correspondida com @code{'<a> b <c>'}, ela irá corresponder a toda a string, e não apenas @code{'<a>'}. Adicionar @code{?} após o quantificador faz com que ele execute a correspondência da maneira `não gulosa' ou `minimalista'; tão `poucos' caracteres quanto possível serão correspondidos. Usando a ER @code{<.*?>} irá corresponder apenas @code{'<a>'}.
@end table

@geindex *+;em expressões regulares
@geindex ++;em expressões regulares
@geindex ?+;em expressões regulares


@table @asis

@item @code{*+}, @code{++}, @code{?+}

Como os quantificadores @code{'*'}, @code{'+'} e @code{'?'}, aqueles em que @code{'+'} é anexado também correspondem tantas vezes quanto possível. No entanto, ao contrário dos quantificadores realmente gulosos, eles não permitem retrocesso quando a expressão que o segue não corresponde. Estes são conhecidos como quantificadores `possessivos'. Por exemplo, @code{a*a} corresponderá a @code{'aaaa'} porque o @code{a*} corresponderá a todos os 4 @code{'a'}s, mas, quando o final @code{'a'} for encontrado, a expressão é retrocedida para que no final o @code{a*} acabe correspondendo a 3 @code{'a'}s no total, e o quarto @code{'a'} seja correspondido por o final @code{'a'}. No entanto, quando @code{a*+a} é usado para corresponder a @code{'aaaa'}, o @code{a*+} corresponderá a todos os 4 @code{'a'}, mas quando o @code{'a'} final não encontrar mais caracteres para corresponder, a expressão não pode ser retrocedida e, portanto, não corresponderá. @code{x*+}, @code{x++} e @code{x?+} são equivalentes a @code{(?>x*)}, @code{(?>x+)} e @code{(?>x?)} respectivamente.


Adicionado na versão 3.11.

@end table

@geindex @{@} (chaves);em expressões regulares


@table @asis

@item @code{@{m@}}

Especifica que exatamente `m' cópias da ER anterior devem ser correspondidas; menos correspondências fazem com que toda a ER não seja correspondida. Por exemplo, @code{a@{6@}} irá corresponder exatamente a seis caracteres @code{'a'}, mas não a cinco.

@item @code{@{m,n@}}

Faz a ER resultante corresponder de `m' a `n' repetições da ER anterior, tentando corresponder ao máximo de repetições possível. Por exemplo, @code{a@{3,5@}} irá corresponder de 3 a 5 caracteres @code{'a'}. A omissão de `m' especifica um limite inferior de zero e a omissão de `n' especifica um limite superior infinito. Como exemplo, @code{a@{4,@}b} irá corresponder a @code{'aaaab'} ou mil caracteres @code{'a'} seguidos por um @code{'b'}, mas não @code{'aaab'}. A vírgula não pode ser omitida ou o modificador será confundido com a forma descrita anteriormente.

@item @code{@{m,n@}?}

Faz a ER resultante corresponder de `m' a `n' repetições da ER anterior, tentando corresponder o `mínimo' de repetições possível. Esta é a versão não gulosa do quantificador anterior. Por exemplo, na string de 6 caracteres @code{'aaaaaa'}, @code{a@{3,5@}} irá corresponder a 5 caracteres @code{'a'}, enquanto @code{a@{3,5@}?} corresponderá apenas a 3 caracteres.

@item @code{@{m,n@}+}

Faz a ER resultante corresponder de `m' a `n' repetições da ER anterior, tentando corresponder o maior número possível de repetições `sem' estabelecer nenhum ponto de retrocesso. Esta é a versão possessiva do quantificador acima. Por exemplo, na string de 6 caracteres @code{'aaaaaa'}, @code{a@{3,5@}+aa} tenta corresponder 5 caracteres @code{'a'}, então, requerer mais 2 @code{'a'}s, precisará de mais caracteres do que os disponíveis e, portanto, falhará, enquanto @code{a@{3,5@}aa} corresponderá a @code{a@{3,5@}} capturando 5, depois 4 @code{'a'}s por retrocesso e então os 2 @code{'a'}s finais são combinados com o @code{aa} final no padrão. @code{x@{m,n@}+} é equivalente a @code{(?>x@{m,n@})}.


Adicionado na versão 3.11.

@end table

@geindex \ (contrabarra);em expressões regulares


@table @asis

@item @code{\}

Ou anula o efeito de caracteres especiais (permitindo a você corresponder caracteres como @code{'*'}, @code{'?'} e assim por diante), ou sinaliza uma sequência especial; sequências especiais são discutidas abaixo.

Se você não estiver usando uma string bruta para expressar o padrão, lembre-se de que o Python também usa a contrabarra como uma sequência de escape em literais de string; se a sequência de escape não for reconhecida pelo analisador sintático do Python, a contrabarra e o caractere subsequente serão incluídos na string resultante. No entanto, se Python reconhecer a sequência resultante, a contrabarra deve ser repetida duas vezes. Isso é complicado e difícil de entender, portanto, é altamente recomendável que você use strings brutas para todas as expressões, exceto as mais simples.
@end table

@geindex [] (colchetes);em expressões regulares


@table @asis

@item @code{[]}

Usado para indicar um conjunto de caracteres. Em um conjunto:


@itemize *

@item 
Caracteres podem ser listados individualmente, por exemplo, @code{[amk]} vai corresponder a @code{'a'}, @code{'m'} ou @code{'k'}.
@end itemize

@geindex - (menos);em expressões regulares


@itemize *

@item 
Intervalos de caracteres podem ser indicados fornecendo dois caracteres e separando-os por @code{'-'}, por exemplo @code{[a-z]} irá corresponder a qualquer letra ASCII minúscula, @code{[0-5][0-9]} irá corresponder a todos os números de dois dígitos de @code{00} a @code{59}, e @code{[0-9A-Fa-f]} irá corresponder a qualquer dígito hexadecimal. Se @code{-} for precedido de uma contrabarra (por exemplo, @code{[a\-z]}) ou se for colocado como o primeiro ou último caractere (por exemplo, @code{[-a]} ou @code{[a-]}), ele corresponderá a um literal @code{'-'}.

@item 
Os caracteres especiais, exceto contrabarra, perdem seu significado especial dentro dos conjuntos. Por exemplo, @code{[(+*)]} vai corresponder a qualquer um dos caracteres literais @code{'('}, @code{'+'}, @code{'*'} ou @code{')'}.
@end itemize

@geindex \ (contrabarra);em expressões regulares


@itemize *

@item 
A contrabarra escapa caracteres que têm significado especial em um conjunto, como @code{'-'}, @code{']'}, @code{'^'} e @code{'\\'}, ou sinaliza uma sequência especial que representa um único caractere, como @code{\xa0} ou @code{\n}, ou uma classe de caracteres como @code{\w} ou @code{\S} (definida abaixo). Observe que @code{\b} representa um único caractere de “backspace”, não um limite de palavra como fora de um conjunto, e escapes numéricos como @code{\1} são sempre escapes octais, não referências de grupo. Sequências especiais que não correspondem a um único caractere, como @code{\A} e @code{\Z}, não são permitidas.
@end itemize

@geindex ^ (circunflexo);em expressões regulares


@itemize *

@item 
Os caracteres que não estão dentro de um intervalo podem ser correspondidos `complementando' o conjunto. Se o primeiro caractere do conjunto for @code{'^'}, todos os caracteres que `não' estiverem no conjunto serão correspondidos. Por exemplo, @code{[^5]} irá corresponder a qualquer caractere exceto @code{'5'}, e @code{[^^]} irá corresponder a qualquer caractere exceto @code{'^'}. @code{^} não tem nenhum significado especial se não for o primeiro caractere do conjunto.

@item 
Para corresponder a um @code{']'} literal dentro de um conjunto, preceda-o com uma contrabarra ou coloque-o no início do conjunto. Por exemplo, @code{[()[\]@{@}]} e @code{[]()[@{@}]} vai corresponder ao colchete à direita, assim como o colchete, chave ou parêntese à esquerda.
@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 
Suporte para conjuntos aninhados e operações de conjunto como no Padrão Técnico do Unicode #18@footnote{https://unicode.org/reports/tr18/} podem ser adicionados no futuro. Isso mudaria a sintaxe, então para facilitar essa mudança uma @ref{415,,FutureWarning} será levantada em casos ambíguos por enquanto. Isso inclui conjuntos que começam com um @code{'['} literal ou contendo sequências de caracteres literais @code{'--'}, @code{'&&'}, @code{'~~'} e @code{'||'}. Para evitar um aviso, use uma contrabarra antes deles.
@end itemize


Alterado na versão 3.7: @ref{415,,FutureWarning} é levantada se um conjunto de caracteres contém construções que mudarão semanticamente no futuro.

@end table

@geindex | (barra vertical);em expressões regulares


@table @asis

@item @code{|}

@code{A|B}, onde `A' e `B' podem ser ERs arbitrárias, cria uma expressão regular que corresponderá a `A' ou `B'. Um número arbitrário de ERs pode ser separado por @code{'|'} desta forma. Isso também pode ser usado dentro de grupos (veja abaixo). Conforme a string alvo é percorrida, ERs separadas por @code{'|'} são avaliadas da esquerda para a direita. Quando um padrão corresponde completamente, essa ramificação é aceita. Isso significa que, assim que `A' corresponder, `B' não será avaliado posteriormente, mesmo que produza uma correspondência geral mais longa. Em outras palavras, o operador @code{'|'} nunca é guloso. Para corresponder a um @code{'|'} literal, use @code{\|}, ou coloque-o dentro de uma classe de caractere, como em @code{[|]}.
@end table

@geindex () (parênteses);em expressões regulares


@table @asis

@item @code{(...)}

Corresponde a qualquer expressão regular que esteja entre parênteses e indica o início e o fim de um grupo; o conteúdo de um grupo pode ser recuperado após uma correspondência ter sido realizada e pode ser correspondido posteriormente na string com a sequência especial @code{\número}, descrita abaixo. Para corresponder aos literais @code{'('} ou @code{')'}, use @code{\(} ou @code{\)}, ou coloque-os dentro de uma classe de caracteres: @code{[(]}, @code{[)]}.
@end table

@geindex (?;em expressões regulares


@table @asis

@item @code{(?...)}

Esta é uma notação de extensão (um @code{'?'} após um @code{'('} não é significativo de outra forma). O primeiro caractere após o @code{'?'} determina qual o significado e sintaxe posterior da construção. As extensões normalmente não criam um novo grupo; @code{(?P<nome>...)} é a única exceção a esta regra. A seguir estão as extensões atualmente implementadas.

@item @code{(?aiLmsux)}

(Uma ou mais letras do conjunto @code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'}.) O grupo corresponde à string vazia; as letras definem os sinalizadores correspondentes para toda a expressão regular:


@itemize *

@item 
@ref{248a,,re.A} (correspondência somente ASCII)

@item 
@ref{248b,,re.I} (ignorar maiúsculas/minúsculas)

@item 
@ref{248c,,re.L} (dependente da localidade)

@item 
@ref{248d,,re.M} (multi-linha)

@item 
@ref{248e,,re.S} (ponto corresponde a tudo)

@item 
@ref{248f,,re.U} (correspondência Unicode)

@item 
@ref{2490,,re.X} (verboso)
@end itemize

(Os sinalizadores são descritos em @ref{2491,,Conteúdo do módulo}.) Isso é útil se você deseja incluir os sinalizadores como parte da expressão regular, em vez de passar um argumento `flag' para a função @ref{bee,,re.compile()}. Os sinalizadores devem ser usados primeiro na string de expressão.


Alterado na versão 3.11: Esta construção só pode ser usada no início da expressão.

@end table

@geindex (?;;em expressões regulares


@table @asis

@item @code{(?:...)}

Uma versão de não-captura de parênteses regulares. Corresponde a qualquer expressão regular que esteja entre parênteses, mas a substring correspondida pelo grupo `não pode' ser recuperada após realizar uma correspondência ou referenciada posteriormente no padrão.

@item @code{(?aiLmsux-imsx:...)}

(Zero ou mais letras do conjunto @code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'}, opcionalmente seguidas por @code{'-'} seguido por uma ou mais letras do conjunto @code{'i'}, @code{'m'}, @code{'s'}, @code{'x'}.) O conjunto de letras define ou remove os sinalizadores correspondentes para a parte da expressão:


@itemize *

@item 
@ref{248a,,re.A} (correspondência somente ASCII)

@item 
@ref{248b,,re.I} (ignorar maiúsculas/minúsculas)

@item 
@ref{248c,,re.L} (dependente da localidade)

@item 
@ref{248d,,re.M} (multi-linha)

@item 
@ref{248e,,re.S} (ponto corresponde a tudo)

@item 
@ref{248f,,re.U} (correspondência Unicode)

@item 
@ref{2490,,re.X} (verboso)
@end itemize

(Os sinalizadores são descritos em @ref{2491,,Conteúdo do módulo}.)

As letras @code{'a'}, @code{'L'} e @code{'u'} são mutuamente exclusivas quando usadas como sinalizadores em linha, portanto, não podem ser combinadas ou seguir @code{'-'}. Em vez disso, quando um deles aparece em um grupo embutido, ele substitui o modo de correspondência no grupo anexo. Em padrões Unicode @code{(?a:...)} muda para correspondência somente ASCII, e @code{(?u:...)} muda para correspondência Unicode (padrão). Em padrões de bytes @code{(?L:...)} muda para a correspondência dependente da localidade, e @code{(?a:...)} muda para correspondência apenas ASCII (padrão). Esta substituição só tem efeito para o grupo estreito em linha e o modo de correspondência original é restaurado fora do grupo.


Adicionado na versão 3.6.



Alterado na versão 3.7: As letras @code{'a'}, @code{'L'} e @code{'u'} também podem ser usadas em um grupo.


@item @code{(?>...)}

Tenta corresponder @code{...} como se fosse uma expressão regular separada e, se for bem-sucedida, continua correspondendo ao restante do padrão que a segue. Se o padrão subsequente não corresponder, a pilha só pode ser desenrolada até um ponto `antes' do @code{(?>...)} porque, uma vez encerrada, a expressão, conhecida como `grupo atômico', jogou fora todos os pontos de pilha dentro de si. Assim, @code{(?>.*).} nunca corresponderia a nada porque primeiro o @code{.*} corresponderia a todos os caracteres possíveis, então, não tendo mais nada para corresponder, o @code{.} final falharia em corresponder. Como não há pontos de pilha salvos no Grupo Atômico e não há ponto de pilha antes dele, a expressão inteira não corresponderia.


Adicionado na versão 3.11.

@end table

@geindex (?P<;em expressões regulares


@table @asis

@item @code{(?P<nome>...)}

Semelhante aos parênteses regulares, mas a substring correspondida pelo grupo é acessível por meio do nome de grupo simbólico `nome'. Os nomes de grupo devem ser identificadores Python válidos e em padrões @ref{1c2,,bytes} eles só podem conter bytes no intervalo ASCII. Cada nome de grupo deve ser definido apenas uma vez em uma expressão regular. Um grupo simbólico também é um grupo numerado, como se o grupo não tivesse um nome.

Grupos nomeados podem ser referenciados em três contextos. Se o padrão for @code{(?P<citação>['"]).*?(?P=citação)} (ou seja, corresponder a uma string entre aspas simples ou duplas):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Contexto de referência ao grupo “citação”

@tab

Formas de referenciá-lo

@item

no mesmo padrão

@tab


@itemize *

@item 
@code{(?P=citação)} (como mostrado)

@item 
@code{\1}
@end itemize

@item

ao processar a correspondência do objeto `m'

@tab


@itemize *

@item 
@code{m.group('citação')}

@item 
@code{m.end('citação')} (etc.)
@end itemize

@item

em uma string passada para o argumento `repl' de @code{re.sub()}

@tab


@itemize *

@item 
@code{\g<citação>}

@item 
@code{\g<1>}

@item 
@code{\1}
@end itemize

@end multitable



Alterado na versão 3.12: Nos padrões @ref{1c2,,bytes}, o grupo `nome' só pode conter bytes no intervalo ASCII (@code{b'\x00'}-@code{b'\x7f'}).

@end table

@geindex (?P=;em expressões regulares


@table @asis

@item @code{(?P=nome)}

Uma referência anterior a um grupo nomeado; corresponde a qualquer texto que corresponda ao grupo anterior denominado `nome'.
@end table

@geindex (?#;em expressões regulares


@table @asis

@item @code{(?#...)}

Um comentário; o conteúdo dos parênteses é simplesmente ignorado.
@end table

@geindex (?=;em expressões regulares


@table @asis

@item @code{(?=...)}

Corresponde se @code{...} corresponder a próxima, mas não consome nada da string. Isso é chamado de `asserção preditiva'. Por exemplo, @code{Isaac (?=Asimov)} corresponderá a @code{'Isaac '} apenas se for seguido por @code{'Asimov'}.
@end table

@geindex (?!;em expressões regulares


@table @asis

@item @code{(?!...)}

Corresponde se @code{...} não corresponder a próxima. Isso é uma `asserção preditiva negativa'. Por exemplo, @code{Isaac (?!Asimov)} corresponderá a @code{'Isaac '} apenas se `não' for seguido por @code{'Asimov'}.
@end table

@geindex (?<=;em expressões regulares


@table @asis

@item @code{(?<=...)}

Corresponde se a posição atual na string for precedida por uma correspondência para @code{...} que termina na posição atual. Isso é chamado de `asserção retroativa positiva'. @code{(?<=abc)def} irá encontrar uma correspondência em @code{'abcdef'}, uma vez que a expressão regular vai voltar 3 caracteres e verificar se o padrão contido corresponde. O padrão contido deve corresponder apenas a strings de algum comprimento fixo, o que significa que @code{abc} ou @code{a|b} são permitidos, mas @code{a*} e @code{a@{3,4@}} não são. Observe que os padrões que começam com asserções retroativas positivas não corresponderão ao início da string que está sendo pesquisada; você provavelmente desejará usar a função @ref{126d,,search()} em vez da função @ref{126e,,match()}:

@example
>>> import re
>>> m = re.search('(?<=abc)def', 'abcdef')
>>> m.group(0)
'def'
@end example

Este exemplo procura por uma palavra logo após um hífen:

@example
>>> m = re.search(r'(?<=-)\w+', 'spam-egg')
>>> m.group(0)
'egg'
@end example


Alterado na versão 3.5: Adicionado suporte para referências de grupo de comprimento fixo.

@end table

@geindex (?<!;em expressões regulares


@table @asis

@item @code{(?<!...)}

Corresponde se a posição atual na string não for precedida por uma correspondência para @code{...}. Isso é chamado de `asserção retroativa negativa'. Semelhante às asserções retroativas positivas, o padrão contido deve corresponder apenas a strings de algum comprimento fixo. Os padrões que começam com asserções retroativas negativas podem corresponder ao início da string que está sendo pesquisada.
@end table

@geindex (?(;em expressões regulares
@anchor{library/re re-conditional-expression}@anchor{18b0}

@table @asis

@item @code{(?(id/nome)padrão-sim|padrão-não)}

Tentará corresponder com @code{padrão-sim} se o grupo com determinado `id' ou `nome' existir, e com @code{padrão-não} se não existir. @code{padrão-não} é opcional e pode ser omitido. Por exemplo,  @code{(<)?(\w+@@\w+(?:\.\w+)+)(?(1)>|$)} é um padrão ruim de correspondência de e-mail, que corresponderá com @code{'<usuario@@host.com>'} bem como @code{'usuario@@host.com'}, mas não com @code{'<usuario@@host.com>'} nem @code{'usuario@@host.com>'}.


Alterado na versão 3.12: O grupo `id' só podem conter dígitos ASCII. Nos padrões @ref{1c2,,bytes}, o grupo `nome' só pode conter bytes no intervalo ASCII (@code{b'\x00'}-@code{b'\x7f'}).

@end table
@anchor{library/re re-special-sequences}@anchor{2492}
As sequências especiais consistem em @code{'\'} e um caractere da lista abaixo. Se o caractere comum não for um dígito ASCII ou uma letra ASCII, a ER resultante corresponderá ao segundo caractere. Por exemplo, @code{\$} corresponde ao caractere @code{'$'}.

@geindex \ (contrabarra);em expressões regulares


@table @asis

@item @code{\número}

Corresponde ao conteúdo do grupo de mesmo número. Os grupos são numerados a partir de 1. Por exemplo, @code{(.+) \1} corresponde a @code{'de de'} ou @code{'55 55'}, mas não @code{'dede'} (note o espaço após o grupo). Esta sequência especial só pode ser usada para corresponder a um dos primeiros 99 grupos. Se o primeiro dígito de `número' for 0, ou `número' tiver 3 dígitos octais de comprimento, ele não será interpretado como uma correspondência de grupo, mas como o caractere com `número' de valor octal. Dentro de @code{'['} e @code{']'} de uma classe de caracteres, todos os escapes numéricos são tratados como caracteres.
@end table

@geindex \A;em expressões regulares


@table @asis

@item @code{\A}

Corresponde apenas ao início da string.
@end table

@geindex \b;em expressões regulares


@table @asis

@item @code{\b}

Corresponde à string vazia, mas apenas no início ou no final de uma palavra. Uma palavra é definida como uma sequência de caracteres de palavras. Observe que, formalmente, @code{\b} é definido como a fronteira entre um caractere @code{\w} e um @code{\W} (ou vice-versa), ou entre @code{\w} e o início/fim da string. Isso significa que @code{r'\bat\b'} corresponde a @code{'at'}, @code{'at.'}, @code{'(at)'}, @code{'as at ay'}, mas não a @code{'attempt'} ou @code{'atlas'}.

Os caracteres de palavras predefinidos em padrões Unicode (str) são alfanuméricos Unicode e o sublinhado, mas isso pode ser alterado usando o sinalizador @ref{62c,,ASCII}. Os limites das palavras são determinados pela localidade atual se o sinalizador @ref{b82,,LOCALE} for usado.

@cartouche
@quotation Nota 
Dentro de um intervalo de caracteres, @code{\b} representa o caractere backspace, para compatibilidade com strings literais do Python.
@end quotation
@end cartouche
@end table

@geindex \B;em expressões regulares


@table @asis

@item @code{\B}

Corresponde à string vazia, mas apenas quando `não' estiver no início ou no final de uma palavra. Isso significa que @code{r'at\B'} corresponde a @code{'athens'}, @code{'atom'}, @code{'attorney'}, mas não @code{'at'}, @code{'at.'} ou @code{'at!'}. @code{\B} é exatamente o oposto de @code{\b}, então caracteres de palavras em padrões Unicode são alfanuméricos Unicode ou o sublinhado, embora isso possa ser alterado usando o sinalizador @ref{62c,,ASCII}. Os limites das palavras são determinados pela localidade atual se o sinalizador @ref{b82,,LOCALE} for usado.

@cartouche
@quotation Nota 
Note que @code{\B} não corresponde uma string vazia, o que difere das implementações de ER em outros linguagens de programação, como Perl. Este comportamento é mantido por razões de compatibilidade.
@end quotation
@end cartouche
@end table

@geindex \d;em expressões regulares


@table @asis

@item @code{\d}


@table @asis

@item Para padrões Unicode (str):

Corresponde a qualquer dígito decimal Unicode (ou seja, qualquer caractere na categoria de caractere Unicode [Nd]@footnote{https://www.unicode.org/versions/Unicode15.0.0/ch04.pdf#G134153}). Isso inclui @code{[0-9]}, e também muitos outros caracteres de dígitos.

Se o sinalizador @ref{62c,,ASCII} for usado, apenas @code{[0-9]} será correspondido.

@item Para padrões de 8 bits (isto é, bytes):

Corresponde a qualquer dígito decimal no conjunto de caracteres ASCII; isso é equivalente a @code{[0-9]}.
@end table
@end table

@geindex \D;em expressões regulares


@table @asis

@item @code{\D}

Corresponde a qualquer caractere que não seja um dígito decimal. Isso é o oposto de @code{\d}.

Se o sinalizador @ref{62c,,ASCII} for usado, apenas @code{[^0-9]} será correspondido.
@end table

@geindex \s;em expressões regulares


@table @asis

@item @code{\s}


@table @asis

@item Para padrões Unicode (str):

Corresponde a caracteres de espaço em branco Unicode (como definido por @ref{235f,,str.isspace()}) . Isso inclui @code{[ \t\n\r\f\v]}, e também muitos outros caracteres, como, por exemplo, os espaços não separáveis exigidos pelas regras de tipografia em muitos idiomas.

Se o sinalizador  @ref{62c,,ASCII} for usado, apenas @code{[ \t\n\r\f\v]} é correspondido.

@item Para padrões de 8 bits (isto é, bytes):

Corresponde a caracteres considerados espaços em branco no conjunto de caracteres ASCII; isso é equivalente a @code{[ \t\n\r\f\v]}.
@end table
@end table

@geindex \S;em expressões regulares


@table @asis

@item @code{\S}

Corresponde a qualquer caractere que não seja um espaço em branco. Isso é o oposto de @code{\s}.

Se o sinalizador  @ref{62c,,ASCII} for usado, apenas @code{[^ \t\n\r\f\v]} é correspondido.
@end table

@geindex \w;em expressões regulares


@table @asis

@item @code{\w}


@table @asis

@item Para padrões Unicode (str):

Corresponde a caracteres de palavras Unicode; isso inclui todos os caracteres alfanuméricos Unicode (conforme definido por @ref{2357,,str.isalnum()}), bem como o sublinhado (@code{_}).

Se o sinalizador @ref{62c,,ASCII} for usado, apenas @code{[a-zA-Z0-9_]} será correspondido.

@item Para padrões de 8 bits (isto é, bytes):

Corresponde a caracteres considerados alfanuméricos no conjunto de caracteres ASCII; isso é equivalente a @code{[a-zA-Z0-9_]}. Se o sinalizador @ref{b82,,LOCALE} for usado, corresponde aos caracteres considerados alfanuméricos na localidade atual e o sublinhado.
@end table
@end table

@geindex \W;em expressões regulares


@table @asis

@item @code{\W}

Corresponde a qualquer caractere que não seja um caractere de palavra. Isso é o oposto de @code{\w}. Por padrão, corresponde a caracteres que não são sublinhados (@code{_}) para os quais @ref{2357,,str.isalnum()} retorna @code{False}.

Se o sinalizador @ref{62c,,ASCII} for usado, apenas @code{[^a-zA-Z0-9_]} será correspondido.

Se o sinalizador @ref{b82,,LOCALE} for usado, corresponde a caracteres que não são alfanuméricos na localidade atual nem ao sublinhado.
@end table

@geindex \Z;em expressões regulares


@table @asis

@item @code{\Z}

Corresponde apenas ao final da string.
@end table

@geindex \a;em expressões regulares
@geindex \b;em expressões regulares
@geindex \f;em expressões regulares
@geindex \n;em expressões regulares
@geindex \N;em expressões regulares
@geindex \r;em expressões regulares
@geindex \t;em expressões regulares
@geindex \u;em expressões regulares
@geindex \U;em expressões regulares
@geindex \v;em expressões regulares
@geindex \x;em expressões regulares
@geindex \\;em expressões regulares

A maioria das @ref{45a,,sequências de escape} com suporte das literais de string Python também são aceitos pelo analisador sintático de expressão regular:

@example
\a      \b      \f      \n
\N      \r      \t      \u
\U      \v      \x      \\
@end example

(Observe que @code{\b} é usado para representar limites de palavras e significa fazer “backspace” apenas dentro das classes de caracteres.)

As sequências de escape @code{'\u'}, @code{'\U'} e @code{'\N'} são reconhecidas apenas em padrões Unicode (str). Em padrões de bytes, eles são erros. Escapes desconhecidos de letras ASCII são reservados para uso futuro e tratados como erros.

Os escapes octais são incluídos em um formulário limitado. Se o primeiro dígito for 0, ou se houver três dígitos octais, é considerado um escape octal. Caso contrário, é uma referência de grupo. Quanto aos literais de string, os escapes octais têm sempre no máximo três dígitos.


Alterado na versão 3.3: As sequências de escape @code{'\u'} e @code{'\U'} foram adicionadas.



Alterado na versão 3.6: Escapes desconhecidos consistindo em @code{'\'} e uma letra ASCII agora são erros.



Alterado na versão 3.8: A sequência de escape @code{'\N@{@var{name}@}'} foi adicionada. Como em literais de string, ela se expande para o caractere Unicode nomeado (por exemplo, @code{'\N@{EM DASH@}'}).


@node Conteúdo do módulo,Objetos expressão regular,Sintaxe de expressão regular,re — Operações com expressões regulares
@anchor{library/re contents-of-module-re}@anchor{2491}@anchor{library/re module-contents}@anchor{2493}
@subsubsection Conteúdo do módulo


O módulo define várias funções, constantes e uma exceção. Algumas das funções são versões simplificadas dos métodos completos para expressões regulares compiladas. A maioria das aplicações não triviais sempre usa a forma compilada.

@menu
* Sinalizadores:: 
* Funções: Funções<2>. 
* Exceções: Exceções<3>. 

@end menu

@node Sinalizadores,Funções<2>,,Conteúdo do módulo
@anchor{library/re flags}@anchor{2494}
@subsubsection Sinalizadores



Alterado na versão 3.6: Constantes de sinalizadores agora são instâncias de @ref{62d,,RegexFlag}, que é uma subclasse de @ref{cbb,,enum.IntFlag}.


@geindex RegexFlag (classe em re)
@anchor{library/re re RegexFlag}@anchor{62d}
@deffn {Classe} re.RegexFlag

Uma subclasse de @ref{cbb,,enum.IntFlag} contendo as opções de expressão regular listadas abaixo.


Adicionado na versão 3.11: - added to @code{__all__}

@end deffn

@geindex A (no módulo re)
@geindex ASCII (no módulo re)
@anchor{library/re re A}@anchor{248a}
@deffn {Dado} re.A
@anchor{library/re re ASCII}@anchor{62c}
@deffnx {Dado} re.ASCII

Faz com que @code{\w}, @code{\W}, @code{\b}, @code{\B}, @code{\d}, @code{\D}, @code{\s} e @code{\S} executem a correspondência somente ASCII em vez da correspondência Unicode completa. Isso é significativo apenas para padrões Unicode (str) e é ignorado para padrões de bytes.

Corresponde ao sinalizador em linha @code{(?a)}.

@cartouche
@quotation Nota 
O sinalizador @ref{248f,,U} ainda existe para compatibilidade com versões anteriores, mas é redundante no Python 3, pois as correspondências são feitas em Unicode por padrão para padrões de @code{str} e correspondência Unicode não é permitida para padrões de “bytes”. @ref{b83,,UNICODE} e o sinalizador em linha @code{(?u)} são igualmente redundantes.
@end quotation
@end cartouche
@end deffn

@geindex DEBUG (no módulo re)
@anchor{library/re re DEBUG}@anchor{2495}
@deffn {Dado} re.DEBUG

Exibe informações de depuração sobre a expressão compilada.

Nenhum sinalizador em linha correspondente.
@end deffn

@geindex I (no módulo re)
@geindex IGNORECASE (no módulo re)
@anchor{library/re re I}@anchor{248b}
@deffn {Dado} re.I
@anchor{library/re re IGNORECASE}@anchor{181a}
@deffnx {Dado} re.IGNORECASE

Faz uma correspondência que não diferencia maiúsculas de minúsculas; expressões como @code{[A-Z]} também corresponderão a letras minúsculas. A correspondência Unicode completa (como @code{Ü} correspondendo a @code{ü}) também funciona, a menos que o sinalizador @ref{62c,,ASCII} seja usado para desabilitar correspondências não ASCII. A localidade atual não muda o efeito deste sinalizador a menos que o sinalizador @ref{b82,,LOCALE} também seja usado.

Corresponde ao sinalizador em linha @code{(?i)}.

Observe que quando os padrões Unicode @code{[a-z]} ou @code{[A-Z]} são usados em combinação com o sinalizador @ref{181a,,IGNORECASE}, eles corresponderão às 52 letras ASCII e 4 letras não-ASCII adicionais: ‘İ’ (U+0130, letra latina I maiúscula com ponto em cima), ‘ı’ (U+0131, letra latina i minúscula sem ponto), ‘ſ’ (U+017F, letra latina s minúscula longa) e ‘K’ (U+212A, sinal de Kelvin). Se o sinalizador @ref{62c,,ASCII} for usado, apenas as letras ‘a’ a ‘z’ e ‘A’ a ‘Z’ serão correspondidas.
@end deffn

@geindex L (no módulo re)
@geindex LOCALE (no módulo re)
@anchor{library/re re L}@anchor{248c}
@deffn {Dado} re.L
@anchor{library/re re LOCALE}@anchor{b82}
@deffnx {Dado} re.LOCALE

Faz com que @code{\w}, @code{\W}, @code{\b}, @code{\B} e a correspondência sem diferenciação de maiúsculas e minúsculas dependam da localidade atual. Esse sinalizador só pode ser usado com padrões de bytes.

Corresponde ao sinalizador em linha @code{(?L)}.

@cartouche
@quotation Aviso 
Este sinalizador é desencorajado; considere usar correspondência Unicode em vez disso. O mecanismo de localidade é muito pouco confiável, pois só manipula uma “cultura” por vez e só funciona com localidades de 8 bits. A correspondência Unicode é habilitada por padrão para padrões Unicode (str) e é capaz de manipular diferentes localidades e idiomas.
@end quotation
@end cartouche


Alterado na versão 3.6: @ref{b82,,LOCALE} pode ser usado apenas com padrões de bytes e não é compatível com @ref{62c,,ASCII}.



Alterado na versão 3.7: Objetos de expressão regular compilados com o sinalizador @ref{b82,,LOCALE} não dependem mais da localidade em tempo de compilação. Apenas a localidade no momento da correspondência afeta o resultado da correspondência.

@end deffn

@geindex M (no módulo re)
@geindex MULTILINE (no módulo re)
@anchor{library/re re M}@anchor{248d}
@deffn {Dado} re.M
@anchor{library/re re MULTILINE}@anchor{2489}
@deffnx {Dado} re.MULTILINE

Quando especificado, o caractere padrão @code{'^'} corresponde ao início da string e ao início de cada linha (imediatamente após cada nova linha); e o caractere padrão @code{'$'} corresponde ao final da string e ao final de cada linha (imediatamente antes de cada nova linha). Por padrão, @code{'^'} corresponde apenas no início da string, e @code{'$'} apenas no final da string e imediatamente antes da nova linha (se houver) no final da string.

Corresponde ao sinalizador em linha @code{(?m)}.
@end deffn

@geindex NOFLAG (no módulo re)
@anchor{library/re re NOFLAG}@anchor{2496}
@deffn {Dado} re.NOFLAG

Indica que nenhum sinalizador está sendo aplicado, o valor é @code{0}. Este sinalizador pode ser usado como um valor padrão para um argumento nomeado de função ou como um valor base que será condicionalmente OU com outros sinalizadores. Exemplo de uso como valor padrão:

@example
def minha_funcao(texto, sinalizador=re.NOFLAG):
    return re.match(texto, sinalizador)
@end example


Adicionado na versão 3.11.

@end deffn

@geindex S (no módulo re)
@geindex DOTALL (no módulo re)
@anchor{library/re re S}@anchor{248e}
@deffn {Dado} re.S
@anchor{library/re re DOTALL}@anchor{2488}
@deffnx {Dado} re.DOTALL

Faz o caractere especial @code{'.'} corresponder com qualquer caractere que seja, incluindo uma nova linha; sem este sinalizador, @code{'.'} irá corresponder a qualquer coisa, `exceto' uma nova linha.

Corresponde ao sinalizador em linha @code{(?s)}.
@end deffn

@geindex U (no módulo re)
@geindex UNICODE (no módulo re)
@anchor{library/re re U}@anchor{248f}
@deffn {Dado} re.U
@anchor{library/re re UNICODE}@anchor{b83}
@deffnx {Dado} re.UNICODE

Em Python 3, os caracteres Unicode são correspondidos por padrão para padrões @code{str}. Esse sinalizador é, portanto, redundante e `sem efeito', sendo mantido apenas para compatibilidade com versões anteriores.

Veja @ref{62c,,ASCII} para restringir a correspondência apenas a caracteres ASCII.
@end deffn

@geindex X (no módulo re)
@geindex VERBOSE (no módulo re)
@anchor{library/re re X}@anchor{2490}
@deffn {Dado} re.X
@anchor{library/re re VERBOSE}@anchor{2497}
@deffnx {Dado} re.VERBOSE

@geindex # (cerquilha);em expressões regulares

Este sinalizador permite que você escreva expressões regulares que parecem mais agradáveis e são mais legíveis, permitindo que você separe visualmente seções lógicas do padrão e adicione comentários. O espaço em branco dentro do padrão é ignorado, exceto quando em uma classe de caractere, ou quando precedido por uma contrabarra sem escape, ou dentro de tokens como @code{*?}, @code{(?:} ou @code{(?P<...>}. Por exemplo, @code{(? :} e @code{* ?} não são permitidos. Quando uma linha contém um @code{#} que não está em uma classe de caractere e não é precedido por uma contrabarra sem escape, todos os caracteres a partir do @code{#} mais à esquerda até o final da linha são ignorados.

Isso significa que os dois seguintes objetos expressão regular que correspondem a um número decimal são funcionalmente iguais:

@example
a = re.compile(r"""\d +  # a parte inteira
                   \.    # o ponto decimal
                   \d *  # alguns digitos fracionários""", re.X)
b = re.compile(r"\d+\.\d*")
@end example

Corresponde ao sinalizador em linha @code{(?x)}.
@end deffn

@node Funções<2>,Exceções<3>,Sinalizadores,Conteúdo do módulo
@anchor{library/re functions}@anchor{2498}
@subsubsection Funções


@geindex compile() (no módulo re)
@anchor{library/re re compile}@anchor{bee}
@deffn {Função} re.compile (pattern, flags=0)

Compila um padrão de expressão regular em um @ref{fbb,,objeto expressão regular}, que pode ser usado para correspondência usando seu @ref{2499,,match()}, @ref{249a,,search()} e outros métodos, descritos abaixo.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).

A sequência

@example
prog = re.compile(pattern)
result = prog.match(string)
@end example

equivale a

@example
result = re.match(pattern, string)
@end example

mas usar @ref{bee,,re.compile()} e salvar o objeto expressão regular resultante para reutilização é mais eficiente quando a expressão será usada várias vezes em um único programa.

@cartouche
@quotation Nota 
As versões compiladas dos padrões mais recentes passados para @ref{bee,,re.compile()} e as funções de correspondência em nível de módulo são armazenadas em cache, de modo que programas que usam apenas algumas expressões regulares por vez não precisam se preocupar em compilar expressões regulares.
@end quotation
@end cartouche
@end deffn

@geindex search() (no módulo re)
@anchor{library/re re search}@anchor{126d}
@deffn {Função} re.search (pattern, string, flags=0)

Percorre a `string' procurando o primeiro local onde o padrão `pattern' de expressão regular produz uma correspondência e retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se nenhuma posição na string corresponder ao padrão; observe que isso é diferente de encontrar uma correspondência de comprimento zero em algum ponto da string.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).
@end deffn

@geindex match() (no módulo re)
@anchor{library/re re match}@anchor{126e}
@deffn {Função} re.match (pattern, string, flags=0)

Se zero ou mais caracteres no início da `string' corresponderem ao padrão `pattern' da expressão regular, retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se a string não corresponder ao padrão; observe que isso é diferente de uma correspondência de comprimento zero.

Observe que mesmo no modo @ref{2489,,MULTILINE}, @ref{126e,,re.match()} irá corresponder apenas no início da string e não no início de cada linha.

Se você quiser localizar uma correspondência em qualquer lugar em `string', use @ref{126d,,search()} (veja também @ref{249b,,search() vs. match()}).

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).
@end deffn

@geindex fullmatch() (no módulo re)
@anchor{library/re re fullmatch}@anchor{fb9}
@deffn {Função} re.fullmatch (pattern, string, flags=0)

Se toda a `string' corresponder ao padrão `pattern' da expressão regular, retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se a string não corresponder ao padrão; observe que isso é diferente de uma correspondência de comprimento zero.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).


Adicionado na versão 3.4.

@end deffn

@geindex split() (no módulo re)
@anchor{library/re re split}@anchor{2a2}
@deffn {Função} re.split (pattern, string, maxsplit=0, flags=0)

Divide a `string' pelas ocorrências do padrão `pattern'. Se parênteses de captura forem usados em `pattern', o texto de todos os grupos no padrão também será retornado como parte da lista resultante. Se `maxsplit' for diferente de zero, no máximo `maxsplit' divisões ocorrerão e o restante da string será retornado como o elemento final da lista.

@example
>>> re.split(r'\W+', 'Palavras, palavras, palavras.')
['Palavras', 'palavras', 'palavras', '@w{'}]
>>> re.split(r'(\W+)', 'Palavras, palavras, palavras.')
['Palavras', ', ', 'palavras', ', ', 'palavras', '.', '@w{'}]
>>> re.split(r'\W+', 'Palavras, palavras, palavras.', maxsplit=1)
['Palavras', 'palavras, palavras.']
>>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
['0', '3', '9']
@end example

Se houver grupos de captura no separador e ele corresponder ao início da string, o resultado começará com uma string vazia. O mesmo vale para o final da string:

@example
>>> re.split(r'(\W+)', '...palavras, palavras...')
['@w{'}, '...', 'palavras', ', ', 'palavras', '...', '@w{'}]
@end example

Dessa forma, os componentes do separador são sempre encontrados nos mesmos índices relativos na lista de resultados.

Correspondências vazias adjacentes não são possíveis, mas uma correspondência vazia pode ocorrer imediatamente após uma correspondência não-vazia.

@example
>>> re.split(r'\b', 'Palavras, palavras, palavras.')
['@w{'}, 'Palavras', ', ', 'palavras', ', ', 'palavras', '.']
>>> re.split(r'\W*', '...palavras...')
['@w{'}, '@w{'}, 'p', 'a', 'l', 'a', 'v', 'r', 'a', 's', '@w{'}, '@w{'}]
>>> re.split(r'(\W*)', '...palavras...')
['@w{'}, '...', '@w{'}, '@w{'}, 'p', '@w{'}, 'a', '@w{'}, 'l', '@w{'}, 'a', '@w{'}, 'v', '@w{'}, 'r', '@w{'}, 'a', '@w{'}, 's', '...', '@w{'}, '@w{'}, '@w{'}]
@end example

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).


Alterado na versão 3.1: Adicionado o argumento de sinalizadores opcionais.



Alterado na versão 3.7: Adicionado suporte de divisão em um padrão que pode corresponder a uma string vazia.



Descontinuado desde a versão 3.13: Passar `maxsplit' e `flags' como argumentos posicionais foi descontinuado. Nas versões futuras do Python eles serão @ref{2a5,,parâmetros somente-nomeados}.

@end deffn

@geindex findall() (no módulo re)
@anchor{library/re re findall}@anchor{1060}
@deffn {Função} re.findall (pattern, string, flags=0)

Retorna todas as correspondências não sobrepostas do padrão `pattern' em `string', como uma lista de strings ou tuplas. A `string' é verificada da esquerda para a direita e as correspondências são retornadas na ordem encontrada. Correspondências vazias são incluídas no resultado.

O resultado depende do número de grupos de captura no padrão. Se não houver grupos, retorna uma lista de strings que correspondem a todo o padrão. Se houver exatamente um grupo, retorna uma lista de strings correspondentes a esse grupo. Se vários grupos estiverem presentes, retorna uma lista de tuplas de strings correspondentes aos grupos. Grupos de não-captura não afetam a forma do 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

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).


Alterado na versão 3.7: Correspondências não vazias agora podem começar logo após uma correspondência vazia anterior.

@end deffn

@geindex finditer() (no módulo re)
@anchor{library/re re finditer}@anchor{1542}
@deffn {Função} re.finditer (pattern, string, flags=0)

Retorna um @ref{1ac,,iterador} produzindo objetos @ref{ce8,,Match} sobre todas as correspondências não sobrepostas para o padrão `pattern' em `string'. A `string' é percorrida da esquerda para a direita e as correspondências são retornadas na ordem encontrada. Correspondências vazias são incluídas no resultado.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).


Alterado na versão 3.7: Correspondências não vazias agora podem começar logo após uma correspondência vazia anterior.

@end deffn

@geindex sub() (no módulo re)
@anchor{library/re re sub}@anchor{2a3}
@deffn {Função} re.sub (pattern, repl, string, count=0, flags=0)

Retorna a string obtida substituindo as ocorrências não sobrepostas da extremidade esquerda do padrão `pattern' na `string' por `repl'. Se o padrão não for encontrado, `string' será retornado inalterado. `repl' pode ser uma string ou uma função; se for uma string, qualquer escape de contrabarra será processado. Ou seja, @code{\n} é convertido em um único caractere de nova linha, @code{\r} é convertido em um retorno de carro e assim por diante. Escapes desconhecidos de letras ASCII são reservados para uso futuro e tratados como erros. Outros escapes desconhecidos como @code{\&} são deixados como estão. Referências anteriores, como @code{\6}, são substituídos pela substring correspondida pelo grupo 6 no padrão. Por exemplo:

@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

Se `repl' for uma função, ela será chamada para cada ocorrência não sobreposta do padrão `pattern'. A função recebe um único argumento @ref{ce8,,Match} e retorna a string de substituição. Por exemplo:

@example
>>> def dashrepl(matchobj):
...     if matchobj.group(0) == '-': return ' '
...     else: return '-'
...
>>> re.sub('-@{1,2@}', dashrepl, 'arquivos-de-pro----grama')
'arquivos de pro--grama'
>>> re.sub(r'\sE\s', ' & ', 'Feijões queimados e spam', flags=re.IGNORECASE)
'Feijões queimados & spam'
@end example

O padrão pode ser uma string ou um @ref{18f2,,Pattern}.

O argumento opcional @code{count} é o número máximo de ocorrências do padrão a ser substituído; @code{count} deve ser um número inteiro não negativo. Se omitido ou igual a zero, todas as ocorrências serão substituídas.

Correspondências vazias adjacentes não são possíveis, mas uma correspondência vazia pode ocorrer imediatamente após uma correspondência não-vazia. Como resultado, @code{sub('x*', '-', 'abxd')} retorna @code{'-a-b--d-'} invés de @code{'-a-b-d-'}.

@geindex \g;em expressões regulares

Em argumentos `repl' do tipo string, além dos escapes de caractere e referências anteriores descritas acima, @code{\g<nome>} usará a substring correspondida pelo grupo denominado @code{nome}, conforme definido pela sintaxe @code{(?P<nome>...)}. @code{\g<número>} usa o número do grupo correspondente; @code{\g<2>} é portanto equivalente a @code{\2}, mas não é ambíguo em uma substituição como @code{\g<2>0}. @code{\20} seria interpretado como uma referência ao grupo 20, não uma referência ao grupo 2 seguida pelo caractere literal @code{'0'}. A referência anterior @code{\g6} substitui em toda a substring correspondida pela ER.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).


Alterado na versão 3.1: Adicionado o argumento de sinalizadores opcionais.



Alterado na versão 3.5: Grupos sem correspondência são substituídos por uma string vazia.



Alterado na versão 3.6: Escapes desconhecidos no padrão `pattern' consistindo em @code{'\'} e uma letra ASCII agora são erros.



Alterado na versão 3.7: Escapes desconhecidos em `repl' consistindo em @code{'\'} e uma letra ASCII agora são erros. Uma correspondência vazia pode ocorrer imediatamente após uma correspondência não-vazia.



Alterado na versão 3.12: O grupo `id' só pode conter dígitos ASCII. Nas strings de substituição @ref{1c2,,bytes}, o grupo `name' só pode conter bytes no intervalo ASCII (@code{b'\x00'}-@code{b'\x7f'}).



Descontinuado desde a versão 3.13: Passar `count' e `flags' como argumentos posicionais foi descontinuado. Nas versões futuras do Python eles serão @ref{2a5,,parâmetros somente-nomeados}.

@end deffn

@geindex subn() (no módulo re)
@anchor{library/re re subn}@anchor{2a4}
@deffn {Função} re.subn (pattern, repl, string, count=0, flags=0)

Executa a mesma operação que @ref{2a3,,sub()}, mas retorna uma tupla @code{(nova_string, número_de_substituições_feitas)}.

O comportamento da expressão pode ser modificado especificando um valor para o parâmetro `flags'. Os valores podem ser qualquer um dos @ref{2494,,sinalizadores}, combinados usando OU bit a bit (o operador @code{|}).
@end deffn

@geindex escape() (no módulo re)
@anchor{library/re re escape}@anchor{c23}
@deffn {Função} re.escape (pattern)

Escapa caracteres especiais no padrão `pattern'. Isso é útil se você deseja corresponder uma string literal arbitrária que pode conter metacaracteres de expressão regular. Por exemplo:

@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 função não deve ser usada para a string de substituição em @ref{2a3,,sub()} e @ref{2a4,,subn()}, apenas contrabarras devem ser escapadas. Por exemplo:

@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


Alterado na versão 3.3: O caractere @code{'_'} não é mais escapado.



Alterado na versão 3.7: Somente caracteres que podem ter um significado especial em uma expressão regular são escapados. Como resultado, @code{'!'}, @code{'"'}, @code{'%'}, @code{"'"}, @code{','}, @code{'/'}, @code{':'}, @code{';'}, @code{'<'}, @code{'='}, @code{'>'}, @code{'@@'}, e @code{"`"} não são mais escapados.

@end deffn

@geindex purge() (no módulo re)
@anchor{library/re re purge}@anchor{249c}
@deffn {Função} re.purge ()

Limpa o cache da expressão regular.
@end deffn

@node Exceções<3>,,Funções<2>,Conteúdo do módulo
@anchor{library/re exceptions}@anchor{249d}
@subsubsection Exceções


@geindex PatternError
@anchor{library/re re PatternError}@anchor{23e}
@deffn {Exceção} re.PatternError (msg, pattern=None, pos=None)

Exceção levantada quando uma string passada para uma das funções desde módulo não é uma expressão regular válida (por exemplo, ela pode conter parênteses não correspondentes) ou quando algum outro erro ocorre durante a compilação ou correspondência. Nunca é um erro se uma string não contém correspondência para um padrão. A instância de @code{PatternError} possui os seguintes atributos adicionais:

@geindex msg (atributo re.PatternError)
@anchor{library/re re PatternError msg}@anchor{e79}
@deffn {Atributo} msg

A mensagem de erro não formatada.
@end deffn

@geindex pattern (atributo re.PatternError)
@anchor{library/re re PatternError pattern}@anchor{e7a}
@deffn {Atributo} pattern

O padrão da expressão regular.
@end deffn

@geindex pos (atributo re.PatternError)
@anchor{library/re re PatternError pos}@anchor{e7b}
@deffn {Atributo} pos

O índice no padrão `pattern' no qual a compilação falhou (pode ser @code{None}).
@end deffn

@geindex lineno (atributo re.PatternError)
@anchor{library/re re PatternError lineno}@anchor{e7c}
@deffn {Atributo} lineno

A linha correspondente a `pos' (pode ser @code{None}).
@end deffn

@geindex colno (atributo re.PatternError)
@anchor{library/re re PatternError colno}@anchor{e7d}
@deffn {Atributo} colno

A coluna correspondente a `pos' (pode ser @code{None}).
@end deffn


Alterado na versão 3.5: Adicionados os atributos adicionais.



Alterado na versão 3.13: @code{PatternError} era originalmente chamado de @code{error}; o último é mantido como um apelido para compatibilidade com versões anteriores.

@end deffn

@node Objetos expressão regular,Objetos correspondência,Conteúdo do módulo,re — Operações com expressões regulares
@anchor{library/re re-objects}@anchor{fbb}@anchor{library/re regular-expression-objects}@anchor{249e}
@subsubsection Objetos expressão regular


@geindex Pattern (classe em re)
@anchor{library/re re Pattern}@anchor{18f2}
@deffn {Classe} re.Pattern

Objeto expressão regular compilado retornado por @ref{bee,,re.compile()}.


Alterado na versão 3.9: @ref{18f2,,re.Pattern} tem suporte a @code{[]} para indicar um padrão Unicode (str) ou bytes. Veja @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex search() (método re.Pattern)
@anchor{library/re re Pattern search}@anchor{249a}
@deffn {Método} Pattern.search (string[, pos[, endpos]])

Percorre a `string' procurando o primeiro local onde esta expressão regular produz uma correspondência e retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se nenhuma posição na string corresponder ao padrão; observe que isso é diferente de encontrar uma correspondência de comprimento zero em algum ponto da string.

O segundo parâmetro opcional `pos' fornece um índice na string onde a pesquisa deve começar; o padrão é @code{0}. Isso não é totalmente equivalente a fatiar a string; o caractere padrão @code{'^'} corresponde no início real da string e nas posições logo após uma nova linha, mas não necessariamente no índice onde a pesquisa deve começar.

O parâmetro opcional `endpos' limita o quão longe a string será pesquisada; será como se a string tivesse `endpos' caracteres, então apenas os caracteres de `pos' a @code{endpos - 1} serão procurados por uma correspondência. Se `endpos' for menor que `pos', nenhuma correspondência será encontrada; caso contrário, se `rx' é um objeto de expressão regular compilado, @code{rx.search(string, 0, 50)} é equivalente a @code{rx.search(string[:50], 0)}.

@example
>>> pattern = re.compile("d")
>>> pattern.search("dog")     # Correspondeu no índice 0
<re.Match object; span=(0, 1), match='d'>
>>> pattern.search("dog", 1)  # Não correspondeu; a busca não inclui "d"
@end example
@end deffn

@geindex match() (método re.Pattern)
@anchor{library/re re Pattern match}@anchor{2499}
@deffn {Método} Pattern.match (string[, pos[, endpos]])

Se zero ou mais caracteres no início da `string' corresponderem a esta expressão regular, retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se a string não corresponder ao padrão; observe que isso é diferente de uma correspondência de comprimento zero.

Os parâmetros opcionais `pos' e `endpos' têm o mesmo significado que para o método @ref{249a,,search()}.

@example
>>> pattern = re.compile("o")
>>> pattern.match("dog")      # Não correspondeu, pois "o" não é o início de "dog".
>>> pattern.match("dog", 1)   # Correspondeu, pois "o" é o 2º caractere de "dog".
<re.Match object; span=(1, 2), match='o'>
@end example

Se você quiser localizar uma correspondência em qualquer lugar em `string', use @ref{249a,,search()} ao invés (veja também @ref{249b,,search() vs. match()}).
@end deffn

@geindex fullmatch() (método re.Pattern)
@anchor{library/re re Pattern fullmatch}@anchor{fba}
@deffn {Método} Pattern.fullmatch (string[, pos[, endpos]])

Se toda a `string' corresponder a esta expressão regular, retorna um @ref{ce8,,Match} correspondente. Retorna @code{None} se a string não corresponder ao padrão; observe que isso é diferente de uma correspondência de comprimento zero.

Os parâmetros opcionais `pos' e `endpos' têm o mesmo significado que para o método @ref{249a,,search()}.

@example
>>> pattern = re.compile("o[gh]")
>>> pattern.fullmatch("dog")      # Não correspondeu, pois "o" não é o início de "dog".
>>> pattern.fullmatch("ogre")     # Não correspondeu, pois não é uma correspondência da string inteira.
>>> pattern.fullmatch("doggie", 1, 3)   # Corresponde dentro dos limites dados.
<re.Match object; span=(1, 3), match='og'>
@end example


Adicionado na versão 3.4.

@end deffn

@geindex split() (método re.Pattern)
@anchor{library/re re Pattern split}@anchor{249f}
@deffn {Método} Pattern.split (string, maxsplit=0)

Idêntico à função @ref{2a2,,split()}, usando o padrão compilado.
@end deffn

@geindex findall() (método re.Pattern)
@anchor{library/re re Pattern findall}@anchor{24a0}
@deffn {Método} Pattern.findall (string[, pos[, endpos]])

Semelhante à função @ref{1060,,findall()}, usando o padrão compilado, mas também aceita os parâmetros `pos' e `endpos' opcionais que limitam a região de pesquisa como para @ref{126d,,search()}.
@end deffn

@geindex finditer() (método re.Pattern)
@anchor{library/re re Pattern finditer}@anchor{24a1}
@deffn {Método} Pattern.finditer (string[, pos[, endpos]])

Semelhante à função @ref{1542,,finditer()}, usando o padrão compilado, mas também aceita os parâmetros `pos' e `endpos' opcionais que limitam a região de pesquisa como para @ref{126d,,search()}.
@end deffn

@geindex sub() (método re.Pattern)
@anchor{library/re re Pattern sub}@anchor{24a2}
@deffn {Método} Pattern.sub (repl, string, count=0)

Idêntico à função @ref{2a3,,sub()}, usando o padrão compilado.
@end deffn

@geindex subn() (método re.Pattern)
@anchor{library/re re Pattern subn}@anchor{24a3}
@deffn {Método} Pattern.subn (repl, string, count=0)

Idêntico à função @ref{2a4,,subn()}, usando o padrão compilado.
@end deffn

@geindex flags (atributo re.Pattern)
@anchor{library/re re Pattern flags}@anchor{24a4}
@deffn {Atributo} Pattern.flags

Os sinalizadores de correspondência de expressões regulares. Esta é uma combinação dos sinalizadores fornecidos para @ref{bee,,compile()}, qualquer  sinalizador em linha @code{(?...)} no padrão e sinalizadores implícitos como @ref{b83,,UNICODE} se o padrão for uma string Unicode.
@end deffn

@geindex groups (atributo re.Pattern)
@anchor{library/re re Pattern groups}@anchor{24a5}
@deffn {Atributo} Pattern.groups

O número de grupos de captura no padrão.
@end deffn

@geindex groupindex (atributo re.Pattern)
@anchor{library/re re Pattern groupindex}@anchor{24a6}
@deffn {Atributo} Pattern.groupindex

Um dicionário que mapeia qualquer nome de grupo simbólico definido por @code{(?P<id>)} para números de grupo. O dicionário estará vazio se nenhum grupo simbólico for usado no padrão.
@end deffn

@geindex pattern (atributo re.Pattern)
@anchor{library/re re Pattern pattern}@anchor{24a7}
@deffn {Atributo} Pattern.pattern

A string de padrão da qual o objeto de padrão foi compilado.
@end deffn


Alterado na versão 3.7: Adicionado suporte de @ref{534,,copy.copy()} e @ref{b84,,copy.deepcopy()}. Os objetos expressão regular compilados são considerados atômicos.


@node Objetos correspondência,Exemplos de expressão regular,Objetos expressão regular,re — Operações com expressões regulares
@anchor{library/re id3}@anchor{24a8}@anchor{library/re match-objects}@anchor{fbc}
@subsubsection Objetos correspondência


Objetos correspondência sempre têm um valor booleano de @code{True}. Como @ref{2499,,match()} e @ref{249a,,search()} retornam @code{None} quando não há correspondência, você pode testar se houve uma correspondência com uma simples instrução @code{if}:

@example
match = re.search(pattern, string)
if match:
    process(match)
@end example

@geindex Match (classe em re)
@anchor{library/re re Match}@anchor{ce8}
@deffn {Classe} re.Match

Objeto correspondência retornado por @code{match}s e @code{search}s bem sucedidos.


Alterado na versão 3.9: @ref{ce8,,re.Match} tem suporte a @code{[]} para indicar uma correspondência Unicode (str) ou bytes. Veja @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex expand() (método re.Match)
@anchor{library/re re Match expand}@anchor{24a9}
@deffn {Método} Match.expand (template)

Retorna a string obtida fazendo a substituição da contrabarra na string template `template', como feito pelo método @ref{24a2,,sub()}. Escapes como @code{\n} são convertidos para os caracteres apropriados, e referências anteriores numéricas (@code{\1}, @code{\2}) e referências anteriores nomeadas (@code{\g<1>}, @code{\g<nome>}) são substituídas pelo conteúdo do grupo correspondente. A referência anterior @code{\g<0>} será substituída pela correspondência completa.


Alterado na versão 3.5: Grupos sem correspondência são substituídos por uma string vazia.

@end deffn

@geindex group() (método re.Match)
@anchor{library/re re Match group}@anchor{1061}
@deffn {Método} Match.group ([group1, ...])

Retorna um ou mais subgrupos da correspondência. Se houver um único argumento, o resultado será uma única string; se houver vários argumentos, o resultado é uma tupla com um item por argumento. Sem argumentos, `group1' padroniza para zero (toda a correspondência é retornada). Se um argumento `groupN' for zero, o valor de retorno correspondente será toda a string correspondente; se estiver no intervalo inclusivo [1..99], é a string que corresponde ao grupo entre parênteses correspondente. Se um número de grupo for negativo ou maior do que o número de grupos definidos no padrão, uma exceção @ref{157e,,IndexError} é levantada. Se um grupo estiver contido em uma parte do padrão que não correspondeu, o resultado correspondente será @code{None}. Se um grupo estiver contido em uma parte do padrão que correspondeu várias vezes, a última correspondência será retornada.

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, físico")
>>> m.group(0)       # A correspondência inteira
'Isaac Newton'
>>> m.group(1)       # O primeiro subgrupo entre parênteses.
'Isaac'
>>> m.group(2)       # O segundo subgrupo entre parênteses.
'Newton'
>>> m.group(1, 2)    # Múltiplos argumentos retornam uma tupla.
('Isaac', 'Newton')
@end example

Se a expressão regular usa a sintaxe @code{(?P<nome>...)}, os argumentos `groupN' também podem ser strings que identificam grupos por seus nomes de grupo. Se um argumento string não for usado como um nome de grupo no padrão, uma exceção @ref{157e,,IndexError} é levantada.

Um exemplo moderadamente complicado:

@example
>>> m = re.match(r"(?P<primeiro_nome>\w+) (?P<sobrenome>\w+)", "Malcolm Reynolds")
>>> m.group('primeiro_nome')
'Malcolm'
>>> m.group('sobrenome')
'Reynolds'
@end example

Grupos nomeados também podem ser referidos por seu índice:

@example
>>> m.group(1)
'Malcolm'
>>> m.group(2)
'Reynolds'
@end example

Se um grupo corresponder várias vezes, apenas a última correspondência estará acessível:

@example
>>> m = re.match(r"(..)+", "a1b2c3")  # Corresponde 3 vezes.
>>> m.group(1)                        # Retorna somente a última correspondência.
'c3'
@end example
@end deffn

@geindex __getitem__() (método re.Match)
@anchor{library/re re Match __getitem__}@anchor{24aa}
@deffn {Método} Match.__getitem__ (g)

Isso é idêntico a @code{m.group(g)}. Isso permite acesso mais fácil a um grupo individual de uma correspondência:

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, físico")
>>> m[0]       # A correspondência inteira
'Isaac Newton'
>>> m[1]       # O primeiro subgrupo entre parênteses.
'Isaac'
>>> m[2]       # O segundo subgrupo entre parênteses.
'Newton'
@end example

Também há suporte para grupos nomeados:

@example
>>> m = re.match(r"(?P<primeiro_nome>\w+) (?P<sobrenome>\w+)", "Isaac Newton")
>>> m['primeiro_nome']
'Isaac'
>>> m['sobrenome']
'Newton'
@end example


Adicionado na versão 3.6.

@end deffn

@geindex groups() (método re.Match)
@anchor{library/re re Match groups}@anchor{1062}
@deffn {Método} Match.groups (default=None)

Retorna uma tupla contendo todos os subgrupos da correspondência, de 1 até quantos grupos estiverem no padrão. O argumento `default' é usado para grupos que não participaram da correspondência; o padrão é @code{None}.

Por exemplo:

@example
>>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
>>> m.groups()
('24', '1632')
@end example

Se colocarmos a casa decimal e tudo depois dela opcional, nem todos os grupos podem participar da correspondência. Esses grupos serão padronizados como @code{None}, a menos que o argumento `default' seja fornecido:

@example
>>> m = re.match(r"(\d+)\.?(\d+)?", "24")
>>> m.groups()      # Segundo grupo padronizado para None.
('24', None)
>>> m.groups('0')   # Agora, o segundo grupo é padronizado para '0'.
('24', '0')
@end example
@end deffn

@geindex groupdict() (método re.Match)
@anchor{library/re re Match groupdict}@anchor{24ab}
@deffn {Método} Match.groupdict (default=None)

Retorna um dicionário contendo todos os subgrupos `nomeados' da correspondência, tendo como chave o nome do subgrupo. O argumento `default' usado para grupos que não participaram da correspondência; o padrão é @code{None}. Por exemplo:

@example
>>> m = re.match(r"(?P<primeiro_nome>\w+) (?P<sobrenome>\w+)", "Malcolm Reynolds")
>>> m.groupdict()
@{'primeiro_nome': 'Malcolm', 'sobrenome': 'Reynolds'@}
@end example
@end deffn

@geindex start() (método re.Match)
@geindex end() (método re.Match)
@anchor{library/re re Match start}@anchor{24ac}
@deffn {Método} Match.start ([group])
@anchor{library/re re Match end}@anchor{24ad}
@deffnx {Método} Match.end ([group])

Retorna os índices de início e fim da substring correspondida pelo grupo `group'; `group' tem como padrão  zero (o que significa que toda a substring é correspondida). Retorna @code{-1} se `group' existe, mas não contribuiu para a correspondência. Para um objeto correspondência `m' e um grupo `g' que contribuiu para a correspondência, a substring correspondida pelo grupo `g' (equivalente a @code{m.group(g)}) é

@example
m.string[m.start(g):m.end(g)]
@end example

Observe que @code{m.start(group)} será igual a @code{m.end(group)} se `group' correspondeu a uma string nula. Por exemplo, após @code{m = re.search('b(c?)', 'cba')}, @code{m.start(0)} é 1, @code{m.end(0)} é 2, @code{m.start(1)} e @code{m.end(1)} são 2, e @code{m.start(2)} levanta uma exceção @ref{157e,,IndexError}.

Um exemplo que removerá `remova_isto' dos endereços de e-mail:

@example
>>> email = "tony@@tiremova_istoger.net"
>>> m = re.search("remova_isto", email)
>>> email[:m.start()] + email[m.end():]
'tony@@tiger.net'
@end example
@end deffn

@geindex span() (método re.Match)
@anchor{library/re re Match span}@anchor{24ae}
@deffn {Método} Match.span ([group])

Para uma correspondência `m', retorna a tupla com dois elementos @code{(m.start(group), m.end(group))}. Observe que se `group' não contribuiu para a correspondência, isso é @code{(-1, -1)}. `group' tem como padrão zero, a correspondência inteira.
@end deffn

@geindex pos (atributo re.Match)
@anchor{library/re re Match pos}@anchor{24af}
@deffn {Atributo} Match.pos

O valor de `pos' que foi passado para o método @ref{249a,,search()} ou @ref{2499,,match()} de um @ref{fbb,,objeto expressão regular}. Este é o índice da string na qual o mecanismo de ER começou a procurar uma correspondência.
@end deffn

@geindex endpos (atributo re.Match)
@anchor{library/re re Match endpos}@anchor{24b0}
@deffn {Atributo} Match.endpos

O valor de `endpos' que foi passado para o método @ref{249a,,search()} ou @ref{2499,,match()} de um @ref{fbb,,objeto expressão regular}. Este é o índice da string após o qual o mecanismo de ER não vai chegar.
@end deffn

@geindex lastindex (atributo re.Match)
@anchor{library/re re Match lastindex}@anchor{24b1}
@deffn {Atributo} Match.lastindex

O índice em número inteiro do último grupo de captura correspondido, ou @code{None} se nenhum grupo foi correspondido. Por exemplo, as expressões @code{(a)b}, @code{((a)(b))} e @code{((ab))} terão @code{lastindex == 1} se aplicadas à string @code{'ab'}, enquanto a expressão @code{(a)(b)} terá @code{lastindex == 2}, se aplicada à mesma string.
@end deffn

@geindex lastgroup (atributo re.Match)
@anchor{library/re re Match lastgroup}@anchor{24b2}
@deffn {Atributo} Match.lastgroup

O nome do último grupo de captura correspondido, ou @code{None} se o grupo não tinha um nome, ou se nenhum grupo foi correspondido.
@end deffn

@geindex re (atributo re.Match)
@anchor{library/re re Match re}@anchor{24b3}
@deffn {Atributo} Match.re

O @ref{fbb,,objeto expressão regular} cujo método @ref{2499,,match()} ou @ref{249a,,search()} produziu esta instância de correspondência.
@end deffn

@geindex string (atributo re.Match)
@anchor{library/re re Match string}@anchor{24b4}
@deffn {Atributo} Match.string

A string passada para @ref{2499,,match()} ou @ref{249a,,search()}.
@end deffn


Alterado na versão 3.7: Adicionado suporte para @ref{534,,copy.copy()} e @ref{b84,,copy.deepcopy()}. Objetos correspondência são considerados atômicos.


@node Exemplos de expressão regular,,Objetos correspondência,re — Operações com expressões regulares
@anchor{library/re re-examples}@anchor{129f}@anchor{library/re regular-expression-examples}@anchor{24b5}
@subsubsection Exemplos de expressão regular


@menu
* Verificando por um par:: 
* Simulando scanf(): Simulando scanf. 
* search() vs. match(): search vs match. 
* Criando uma lista telefônica:: 
* Mastigando texto:: 
* Encontrando todos os advérbios:: 
* Encontrando todos os advérbios e suas posições:: 
* Notação de string bruta:: 
* Escrevendo um tokenizador:: 

@end menu

@node Verificando por um par,Simulando scanf,,Exemplos de expressão regular
@anchor{library/re checking-for-a-pair}@anchor{24b6}
@subsubsection Verificando por um par


Neste exemplo, usaremos a seguinte função auxiliar para exibir objetos correspondência com um pouco mais de elegância:

@example
def displaymatch(match):
    if match is None:
        return None
    return '<Match: %r, groups=%r>' % (match.group(), match.groups())
@end example

Suponha que você esteja escrevendo um programa de pôquer onde a mão de um jogador é representada como uma string de 5 caracteres com cada caractere representando uma carta, “a” para ás, “k” para rei, “q” para dama, “j” para valete, “t” para 10 e “2” a “9” representando a carta com esse valor.

Para ver se uma determinada string é uma mão válida, pode-se fazer o seguinte:

@example
>>> valid = re.compile(r"^[a2-9tjqk]@{5@}$")
>>> displaymatch(valid.match("akt5q"))  # Válida.
"<Match: 'akt5q', groups=()>"
>>> displaymatch(valid.match("akt5e"))  # Inválida.
>>> displaymatch(valid.match("akt"))    # Inválida.
>>> displaymatch(valid.match("727ak"))  # Válida.
"<Match: '727ak', groups=()>"
@end example

Essa última mão, @code{"727ak"}, continha um par, ou duas cartas com o mesmo valor. Para combinar isso com uma expressão regular, pode-se usar referências anteriores como:

@example
>>> pair = re.compile(r".*(.).*\1")
>>> displaymatch(pair.match("717ak"))     # Par de 7s.
"<Match: '717', groups=('7',)>"
>>> displaymatch(pair.match("718ak"))     # Sem pares.
>>> displaymatch(pair.match("354aa"))     # Par de áses.
"<Match: '354aa', groups=('a',)>"
@end example

Para descobrir em que carta o par consiste, pode-se usar o método @ref{1061,,group()} do objeto correspondência da seguinte maneira:

@example
>>> pair = re.compile(r".*(.).*\1")
>>> pair.match("717ak").group(1)
'7'

# Erro porque re.match() retorna None, que não tem um método group()::
>>> 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 Simulando scanf,search vs match,Verificando por um par,Exemplos de expressão regular
@anchor{library/re simulating-scanf}@anchor{24b7}
@subsubsection Simulando scanf()


@geindex scanf (função C)

Atualmente, Python não possui um equivalente a @code{scanf()}. Expressões regulares são geralmente mais poderosas, embora também mais prolixas, do que strings de formato @code{scanf()}. A tabela abaixo oferece alguns mapeamentos mais ou menos equivalentes entre strings de formato @code{scanf()} e expressões regulares.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Símbolo do @code{scanf()}

@tab

Expressão 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 extrair um nome de arquivo e números de uma string como

@example
/usr/sbin/sendmail - 0 errors, 4 warnings
@end example

você usaria um formato @code{scanf()} como

@example
%s - %d errors, %d warnings
@end example

A expressão regular equivalente seria

@example
(\S+) - (\d+) errors, (\d+) warnings
@end example

@node search vs match,Criando uma lista telefônica,Simulando scanf,Exemplos de expressão regular
@anchor{library/re id4}@anchor{24b8}@anchor{library/re search-vs-match}@anchor{249b}
@subsubsection search() vs. match()


Python oferece diferentes operações primitivas baseadas em expressões regulares:


@itemize +

@item 
@ref{126e,,re.match()} verifica uma correspondência apenas no início da string

@item 
@ref{126d,,re.search()} verifica uma correspondência em qualquer lugar na string (isso é o que o Perl faz por padrão)

@item 
@ref{fb9,,re.fullmatch()} verifica toda a string para ser uma correspondência
@end itemize

Por exemplo:

@example
>>> re.match("c", "abcdef")    # Sem correspondência
>>> re.search("c", "abcdef")   # Correspondência
<re.Match object; span=(2, 3), match='c'>
>>> re.fullmatch("p.*n", "python") # Correspondência
<re.Match object; span=(0, 6), match='python'>
>>> re.fullmatch("r.*n", "python") # Sem correspondência
@end example

Expressões regulares começando com @code{'^'} podem ser usadas com @ref{126d,,search()} para restringir a correspondência no início da string:

@example
>>> re.match("c", "abcdef")    # Sem correspondência
>>> re.search("^c", "abcdef")  # Sem correspondência
>>> re.search("^a", "abcdef")  # Correspondência
<re.Match object; span=(0, 1), match='a'>
@end example

Observe, entretanto, que no modo @ref{2489,,MULTILINE} @ref{126e,,match()} apenas corresponde ao início da string, enquanto que usar @ref{126d,,search()} com uma expressão regular começando com @code{'^'} irá corresponder no início de cada linha.

@example
>>> re.match("X", "A\nB\nX", re.MULTILINE)  # Sem correspondência
>>> re.search("^X", "A\nB\nX", re.MULTILINE)  # Correspondência
<re.Match object; span=(4, 5), match='X'>
@end example

@node Criando uma lista telefônica,Mastigando texto,search vs match,Exemplos de expressão regular
@anchor{library/re making-a-phonebook}@anchor{24b9}
@subsubsection Criando uma lista telefônica


@ref{2a2,,split()} divide uma string em uma lista delimitada pelo padrão passado. O método é inestimável para converter dados textuais em estruturas de dados que podem ser facilmente lidas e modificadas pelo Python, conforme demonstrado no exemplo a seguir que cria uma lista telefônica.

Primeiro, aqui está a entrada. Normalmente pode vir de um arquivo, aqui estamos usando a sintaxe de string entre aspas triplas.

@example
>>> texto = """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

Os registros são separados por uma ou mais novas linhas. Agora, convertemos a string em uma lista com cada linha não vazia tendo seu próprio registro:

@example
>>> registros = re.split("\n+", texto)
>>> registros
['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, divida cada registro em uma lista com nome, sobrenome, número de telefone e endereço. Usamos o parâmetro @code{maxsplit} de @ref{2a2,,split()} porque o endereço contém espaços, nosso padrão de divisão:

@example
>>> [re.split(":? ", registro, maxsplit=3) for registro in registros]
[['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

O padrão @code{:?} corresponde ao caractere de dois pontos após o sobrenome, de modo que não ocorre na lista de resultados. Com um @code{maxsplit} de @code{4}, podemos separar o número da casa do nome da rua:

@example
>>> [re.split(":? ", registro, maxsplit=4) for registro in registros]
[['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 Mastigando texto,Encontrando todos os advérbios,Criando uma lista telefônica,Exemplos de expressão regular
@anchor{library/re text-munging}@anchor{24ba}
@subsubsection Mastigando texto


@ref{2a3,,sub()} substitui cada ocorrência de um padrão por uma string ou o resultado de uma função. Este exemplo demonstra o uso de @ref{2a3,,sub()} com uma função para “mastigar” o texto ou aleatorizar a ordem de todos os caracteres em cada palavra de uma frase, exceto o primeiro e o último caracteres:

@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 Masanori, favor comunicar suas ausências imediatamente."
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Psesforor Mranoasi, favor cmounacir suas acaêiusns idaaeemttnmie.'
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Prfseosor Monsaari, fovar camonucir saus acuêsains ientdaammetie.'
@end example

@node Encontrando todos os advérbios,Encontrando todos os advérbios e suas posições,Mastigando texto,Exemplos de expressão regular
@anchor{library/re finding-all-adverbs}@anchor{24bb}
@subsubsection Encontrando todos os advérbios


@ref{1060,,findall()} corresponde `todas' as ocorrências de um padrão, não apenas a primeira como @ref{126d,,search()} faz. Por exemplo, se uma pessoa deseja encontrar todos os advérbios em algum texto, ela pode usar @ref{1060,,findall()} da seguinte maneira:

@example
>>> text = "Ele estava cuidadosamente disfarçado, mas foi rapidamente capturado pela polícia."
>>> re.findall(r"\w+mente\b", text)
['cuidadosamente', 'rapidamente']
@end example

@node Encontrando todos os advérbios e suas posições,Notação de string bruta,Encontrando todos os advérbios,Exemplos de expressão regular
@anchor{library/re finding-all-adverbs-and-their-positions}@anchor{24bc}
@subsubsection Encontrando todos os advérbios e suas posições


Se alguém deseja obter mais informações sobre todas as correspondências de um padrão além do texto correspondido, @ref{1542,,finditer()} é útil, pois fornece objetos @ref{ce8,,Match} em vez de strings. Continuando com o exemplo anterior, se um escritor quisesse encontrar todos os advérbios `e suas posições' em algum texto, ele usaria @ref{1542,,finditer()} da seguinte maneira:

@example
>>> text = "Ele estava cuidadosamente disfarçado, mas foi rapidamente capturado pela polícia."
>>> for m in re.finditer(r"\w+mente\b", text):
... print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0)))
11-25: cuidadosamente
46-57: rapidamente
@end example

@node Notação de string bruta,Escrevendo um tokenizador,Encontrando todos os advérbios e suas posições,Exemplos de expressão regular
@anchor{library/re raw-string-notation}@anchor{24bd}
@subsubsection Notação de string bruta


A notação de string bruta (@code{r"texto"}) mantém as expressões regulares sãs. Sem ela, cada contrabarra (@code{'\'}) em uma expressão regular teria que ser prefixada com outra para ter seu efeito de caractere especial anulado. Por exemplo, as duas linhas de código a seguir são 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

Quando se deseja corresponder a uma contrabarra literal, ela deve ser prefixada com outra contrabarra na expressão regular. Com a notação de string bruta, isso significa @code{r"\\"}. Sem a notação de string bruta, deve-se usar @code{"\\\\"}, tornando as seguintes linhas de código 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 Escrevendo um tokenizador,,Notação de string bruta,Exemplos de expressão regular
@anchor{library/re writing-a-tokenizer}@anchor{24be}
@subsubsection Escrevendo um tokenizador


Um tokenizador ou scanner@footnote{https://pt.wikipedia.org/wiki/Análise_léxica} analisa uma string para categorizar grupos de caracteres. Este é um primeiro passo útil para escrever um compilador ou interpretador.

As categorias de texto são especificadas com expressões regulares. A técnica é combiná-las em uma única expressão regular mestre e fazer um laço em correspondências sucessivas:

@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*)?'),  # Número inteiro ou decimal
        ('ASSIGN',   r':='),           # Operador de atribuição
        ('END',      r';'),            # Fiinalizador de instrução
        ('ID',       r'[A-Za-z]+'),    # Identificadores
        ('OP',       r'[+\-*/]'),      # Operadores aritméticos
        ('NEWLINE',  r'\n'),           # Finais de linha
        ('SKIP',     r'[ \t]+'),       # Pula espaços e tabulações
        ('MISMATCH', r'.'),            # Qualquer outro caracter
    ]
    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

O tokenizador produz a seguinte saída:

@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{2486}@w{(Frie09)} 
Friedl, Jeffrey. Mastering Regular Expressions. 3ª ed., O’Reilly Media, 2009. A terceira edição do livro não cobre mais o Python, mas a primeira edição cobriu a escrita de bons padrões de expressão regular em grandes detalhes.

@node difflib — Helpers for computing deltas,textwrap — Quebra automática e preenchimento de texto,re — Operações com expressões regulares,Serviços de Processamento de Texto
@anchor{library/difflib doc}@anchor{24bf}@anchor{library/difflib difflib-helpers-for-computing-deltas}@anchor{24c0}@anchor{library/difflib module-difflib}@anchor{37}@anchor{library/difflib translation-repo}@anchor{24c1}
@subsection @code{difflib} — Helpers for computing deltas


@geindex module; difflib

@c Markup by Fred L. Drake, Jr. <fdrake@acm.org>

`Código-fonte:' Lib/difflib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/difflib.py}

@c import sys
@c from difflib import *


__________________________________________________________________


This module provides classes and functions for comparing sequences. It
can be used for example, for comparing files, and can produce information
about file differences in various formats, including HTML and context and unified
diffs. For comparing directories and files, see also, the @ref{5a,,filecmp} module.


@deffn {Classe} difflib.SequenceMatcher

This is a flexible class for comparing pairs of sequences of any type, so long
as the sequence elements are @ref{610,,hashable}.  The basic algorithm predates, and is a
little fancier than, an algorithm published in the late 1980’s by Ratcliff and
Obershelp under the hyperbolic name “gestalt pattern matching.”  The idea is to
find the longest contiguous matching subsequence that contains no “junk”
elements; these “junk” elements are ones that are uninteresting in some
sense, such as blank lines or whitespace.  (Handling junk is an
extension to the Ratcliff and Obershelp algorithm.) The same
idea is then applied recursively to the pieces of the sequences to the left and
to the right of the matching subsequence.  This does not yield minimal edit
sequences, but does tend to yield matches that “look right” to people.

`Timing:' The basic Ratcliff-Obershelp algorithm is cubic time in the worst
case and quadratic time in the expected case. @ref{104f,,SequenceMatcher} is
quadratic time for the worst case and has expected-case behavior dependent in a
complicated way on how many elements the sequences have in common; best case
time is linear.

`Automatic junk heuristic:' @ref{104f,,SequenceMatcher} supports a heuristic that
automatically treats certain sequence items as junk. The heuristic counts how many
times each individual item appears in the sequence. If an item’s duplicates (after
the first one) account for more than 1% of the sequence and the sequence is at least
200 items long, this item is marked as “popular” and is treated as junk for
the purpose of sequence matching. This heuristic can be turned off by setting
the @code{autojunk} argument to @code{False} when creating the @ref{104f,,SequenceMatcher}.


Alterado na versão 3.2: Added the `autojunk' parameter.

@end deffn

@geindex Differ (classe em difflib)
@anchor{library/difflib difflib Differ}@anchor{24c2}
@deffn {Classe} difflib.Differ

This is a class for comparing sequences of lines of text, and producing
human-readable differences or deltas.  Differ uses @ref{104f,,SequenceMatcher}
both to compare sequences of lines, and to compare sequences of characters
within similar (near-matching) lines.

Each line of a @ref{24c2,,Differ} delta begins with a two-letter code:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código

@tab

Significado

@item

@code{'- '}

@tab

line unique to sequence 1

@item

@code{'+ '}

@tab

line unique to sequence 2

@item

@code{'  '}

@tab

line common to both sequences

@item

@code{'? '}

@tab

line not present in either input sequence

@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 (classe em difflib)
@anchor{library/difflib difflib HtmlDiff}@anchor{1644}
@deffn {Classe} difflib.HtmlDiff

This class can be used to create an HTML table (or a complete HTML file
containing the table) showing a side by side, line by line comparison of text
with inter-line and intra-line change highlights.  The table can be generated in
either full or contextual difference mode.

The constructor for this class is:

@geindex __init__() (método difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff __init__}@anchor{24c3}
@deffn {Método} __init__ (tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)

Initializes instance of @ref{1644,,HtmlDiff}.

`tabsize' is an optional keyword argument to specify tab stop spacing and
defaults to @code{8}.

`wrapcolumn' is an optional keyword to specify column number where lines are
broken and wrapped, defaults to @code{None} where lines are not wrapped.

`linejunk' and `charjunk' are optional keyword arguments passed into @ref{24c4,,ndiff()}
(used by @ref{1644,,HtmlDiff} to generate the side by side HTML differences).  See
@ref{24c4,,ndiff()} documentation for argument default values and descriptions.
@end deffn

The following methods are public:

@geindex make_file() (método difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff make_file}@anchor{e1b}
@deffn {Método} make_file (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5, *, charset='utf-8')

Compares `fromlines' and `tolines' (lists of strings) and returns a string which
is a complete HTML file containing a table showing line by line differences with
inter-line and intra-line changes highlighted.

`fromdesc' and `todesc' are optional keyword arguments to specify from/to file
column header strings (both default to an empty string).

`context' and `numlines' are both optional keyword arguments. Set `context' to
@code{True} when contextual differences are to be shown, else the default is
@code{False} to show the full files. `numlines' defaults to @code{5}.  When `context'
is @code{True} `numlines' controls the number of context lines which surround the
difference highlights.  When `context' is @code{False} `numlines' controls the
number of lines which are shown before a difference highlight when using the
“next” hyperlinks (setting to zero would cause the “next” hyperlinks to place
the next difference highlight at the top of the browser without any leading
context).

@cartouche
@quotation Nota 
`fromdesc' and `todesc' are interpreted as unescaped HTML and should be
properly escaped while receiving input from untrusted sources.
@end quotation
@end cartouche


Alterado na versão 3.5: `charset' keyword-only argument was added.  The default charset of
HTML document changed from @code{'ISO-8859-1'} to @code{'utf-8'}.

@end deffn

@geindex make_table() (método difflib.HtmlDiff)
@anchor{library/difflib difflib HtmlDiff make_table}@anchor{24c5}
@deffn {Método} make_table (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5)

Compares `fromlines' and `tolines' (lists of strings) and returns a string which
is a complete HTML table showing line by line differences with inter-line and
intra-line changes highlighted.

The arguments for this method are the same as those for the @ref{e1b,,make_file()}
method.
@end deffn
@end deffn

@geindex context_diff() (no módulo difflib)
@anchor{library/difflib difflib context_diff}@anchor{24c6}
@deffn {Função} difflib.context_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

Compare `a' and `b' (lists of strings); return a delta (a @ref{109a,,generator}
generating the delta lines) in context diff format.

Context diffs are a compact way of showing just the lines that have changed plus
a few lines of context.  The changes are shown in a before/after style.  The
number of context lines is set by `n' which defaults to three.

By default, the diff control lines (those with @code{***} or @code{---}) are created
with a trailing newline.  This is helpful so that inputs created from
@ref{24c7,,io.IOBase.readlines()} result in diffs that are suitable for use with
@ref{15a1,,io.IOBase.writelines()} since both the inputs and outputs have trailing
newlines.

For inputs that do not have trailing newlines, set the `lineterm' argument to
@code{""} so that the output will be uniformly newline free.

The context 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
>>> 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

See @ref{24c8,,A command-line interface to difflib} for a more detailed example.
@end deffn

@geindex get_close_matches() (no módulo difflib)
@anchor{library/difflib difflib get_close_matches}@anchor{24c9}
@deffn {Função} difflib.get_close_matches (word, possibilities, n=3, cutoff=0.6)

Return a list of the best “good enough” matches.  `word' is a sequence for which
close matches are desired (typically a string), and `possibilities' is a list of
sequences against which to match `word' (typically a list of strings).

Optional argument `n' (default @code{3}) is the maximum number of close matches to
return; `n' must be greater than @code{0}.

Optional argument `cutoff' (default @code{0.6}) is a float in the range [0, 1].
Possibilities that don’t score at least that similar to `word' are ignored.

The best (no more than `n') matches among the possibilities are returned in a
list, sorted by similarity score, most similar first.

@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() (no módulo difflib)
@anchor{library/difflib difflib ndiff}@anchor{24c4}
@deffn {Função} difflib.ndiff (a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)

Compare `a' and `b' (lists of strings); return a @ref{24c2,,Differ}-style
delta (a @ref{109a,,generator} generating the delta lines).

Optional keyword parameters `linejunk' and `charjunk' are filtering functions
(or @code{None}):

`linejunk': A function that accepts a single string argument, and returns
true if the string is junk, or false if not. The default is @code{None}. There
is also a module-level function @ref{24ca,,IS_LINE_JUNK()}, which filters out lines
without visible characters, except for at most one hash character (@code{'#'})
– however the underlying @ref{104f,,SequenceMatcher} class does a dynamic
analysis of which lines are so frequent as to constitute noise, and this
usually works better than using this function.

`charjunk': A function that accepts a character (a string of length 1), and
returns if the character is junk, or false if not. The default is module-level
function @ref{24cb,,IS_CHARACTER_JUNK()}, which filters out whitespace characters (a
blank or tab; it’s a bad idea to include newline in this!).

@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() (no módulo difflib)
@anchor{library/difflib difflib restore}@anchor{24cc}
@deffn {Função} difflib.restore (sequence, which)

Return one of the two sequences that generated a delta.

Given a `sequence' produced by @ref{24cd,,Differ.compare()} or @ref{24c4,,ndiff()}, extract
lines originating from file 1 or 2 (parameter `which'), stripping off line
prefixes.

Exemplo:

@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() (no módulo difflib)
@anchor{library/difflib difflib unified_diff}@anchor{24ce}
@deffn {Função} difflib.unified_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

Compare `a' and `b' (lists of strings); return a delta (a @ref{109a,,generator}
generating the delta lines) in unified diff format.

Unified diffs are a compact way of showing just the lines that have changed plus
a few lines of context.  The changes are shown in an inline style (instead of
separate before/after blocks).  The number of context lines is set by `n' which
defaults to three.

By default, the diff control lines (those with @code{---}, @code{+++}, or @code{@@@@}) are
created with a trailing newline.  This is helpful so that inputs created from
@ref{24c7,,io.IOBase.readlines()} result in diffs that are suitable for use with
@ref{15a1,,io.IOBase.writelines()} since both the inputs and outputs have trailing
newlines.

For inputs that do not have trailing newlines, set the `lineterm' argument to
@code{""} so that the output will be uniformly newline free.

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

See @ref{24c8,,A command-line interface to difflib} for a more detailed example.
@end deffn

@geindex diff_bytes() (no módulo difflib)
@anchor{library/difflib difflib diff_bytes}@anchor{e1c}
@deffn {Função} difflib.diff_bytes (dfunc, a, b, fromfile=b'@w{'}, tofile=b'@w{'}, fromfiledate=b'@w{'}, tofiledate=b'@w{'}, n=3, lineterm=b'\n')

Compare `a' and `b' (lists of bytes objects) using `dfunc'; yield a
sequence of delta lines (also bytes) in the format returned by `dfunc'.
`dfunc' must be a callable, typically either @ref{24ce,,unified_diff()} or
@ref{24c6,,context_diff()}.

Allows you to compare data with unknown or inconsistent encoding. All
inputs except `n' must be bytes objects, not str. Works by losslessly
converting all inputs (except `n') to str, and calling @code{dfunc(a, b,
fromfile, tofile, fromfiledate, tofiledate, n, lineterm)}. The output of
`dfunc' is then converted back to bytes, so the delta lines that you
receive have the same unknown/inconsistent encodings as `a' and `b'.


Adicionado na versão 3.5.

@end deffn

@geindex IS_LINE_JUNK() (no módulo difflib)
@anchor{library/difflib difflib IS_LINE_JUNK}@anchor{24ca}
@deffn {Função} difflib.IS_LINE_JUNK (line)

Return @code{True} for ignorable lines.  The line `line' is ignorable if `line' is
blank or contains a single @code{'#'}, otherwise it is not ignorable.  Used as a
default for parameter `linejunk' in @ref{24c4,,ndiff()} in older versions.
@end deffn

@geindex IS_CHARACTER_JUNK() (no módulo difflib)
@anchor{library/difflib difflib IS_CHARACTER_JUNK}@anchor{24cb}
@deffn {Função} difflib.IS_CHARACTER_JUNK (ch)

Return @code{True} for ignorable characters.  The character `ch' is ignorable if `ch'
is a space or tab, otherwise it is not ignorable.  Used as a default for
parameter `charjunk' in @ref{24c4,,ndiff()}.
@end deffn


@subsubheading Ver também



@table @asis

@item Pattern Matching: The Gestalt Approach@footnote{https://jacobfilipp.com/DrDobbs/articles/DDJ/1988/8807/8807c/8807c.htm}

Discussion of a similar algorithm by John W. Ratcliff and D. E. Metzener. This
was published in Dr. Dobb’s Journal in July, 1988.
@end table


@menu
* SequenceMatcher Objects:: 
* SequenceMatcher Examples:: 
* Differ Objects:: 
* Differ Example:: 
* A command-line interface to difflib:: 
* ndiff example:: 

@end menu

@node SequenceMatcher Objects,SequenceMatcher Examples,,difflib — Helpers for computing deltas
@anchor{library/difflib sequence-matcher}@anchor{24cf}@anchor{library/difflib sequencematcher-objects}@anchor{24d0}
@subsubsection SequenceMatcher Objects


The @ref{104f,,SequenceMatcher} class has this constructor:

@geindex SequenceMatcher (classe em difflib)
@anchor{library/difflib difflib SequenceMatcher}@anchor{104f}
@deffn {Classe} difflib.SequenceMatcher (isjunk=None, a='@w{'}, b='@w{'}, autojunk=True)

Optional argument `isjunk' must be @code{None} (the default) or a one-argument
function that takes a sequence element and returns true if and only if the
element is “junk” and should be ignored. Passing @code{None} for `isjunk' is
equivalent to passing @code{lambda x: False}; in other words, no elements are ignored.
For example, pass:

@example
lambda x: x in " \t"
@end example

if you’re comparing lines as sequences of characters, and don’t want to synch up
on blanks or hard tabs.

The optional arguments `a' and `b' are sequences to be compared; both default to
empty strings.  The elements of both sequences must be @ref{610,,hashable}.

The optional argument `autojunk' can be used to disable the automatic junk
heuristic.


Alterado na versão 3.2: Added the `autojunk' parameter.


SequenceMatcher objects get three data attributes: `bjunk' is the
set of elements of `b' for which `isjunk' is @code{True}; `bpopular' is the set of
non-junk elements considered popular by the heuristic (if it is not
disabled); `b2j' is a dict mapping the remaining elements of `b' to a list
of positions where they occur. All three are reset whenever `b' is reset
with @ref{24d1,,set_seqs()} or @ref{24d2,,set_seq2()}.


Adicionado na versão 3.2: The `bjunk' and `bpopular' attributes.


@ref{104f,,SequenceMatcher} objects have the following methods:

@geindex set_seqs() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seqs}@anchor{24d1}
@deffn {Método} set_seqs (a, b)

Set the two sequences to be compared.
@end deffn

@ref{104f,,SequenceMatcher} computes and caches detailed information about the
second sequence, so if you want to compare one sequence against many
sequences, use @ref{24d2,,set_seq2()} to set the commonly used sequence once and
call @ref{24d3,,set_seq1()} repeatedly, once for each of the other sequences.

@geindex set_seq1() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seq1}@anchor{24d3}
@deffn {Método} set_seq1 (a)

Set the first sequence to be compared.  The second sequence to be compared
is not changed.
@end deffn

@geindex set_seq2() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher set_seq2}@anchor{24d2}
@deffn {Método} set_seq2 (b)

Set the second sequence to be compared.  The first sequence to be compared
is not changed.
@end deffn

@geindex find_longest_match() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher find_longest_match}@anchor{1ad8}
@deffn {Método} find_longest_match (alo=0, ahi=None, blo=0, bhi=None)

Find longest matching block in @code{a[alo:ahi]} and @code{b[blo:bhi]}.

If `isjunk' was omitted or @code{None}, @ref{1ad8,,find_longest_match()} returns
@code{(i, j, k)} such that @code{a[i:i+k]} is equal to @code{b[j:j+k]}, where @code{alo
<= i <= i+k <= ahi} and @code{blo <= j <= j+k <= bhi}. For all @code{(i', j',
k')} meeting those conditions, the additional conditions @code{k >= k'}, @code{i
<= i'}, and if @code{i == i'}, @code{j <= j'} are also met. In other words, of
all maximal matching blocks, return one that starts earliest in `a', and
of all those maximal matching blocks that start earliest in `a', return
the one that starts earliest in `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

If `isjunk' was provided, first the longest matching block is determined
as above, but with the additional restriction that no junk element appears
in the block.  Then that block is extended as far as possible by matching
(only) junk elements on both sides. So the resulting block never matches
on junk except as identical junk happens to be adjacent to an interesting
match.

Here’s the same example as before, but considering blanks to be junk. That
prevents @code{' abcd'} from matching the @code{' abcd'} at the tail end of the
second sequence directly.  Instead only the @code{'abcd'} can match, and
matches the leftmost @code{'abcd'} in the second sequence:

@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

If no blocks match, this returns @code{(alo, blo, 0)}.

This method returns a @ref{64e,,named tuple} @code{Match(a, b, size)}.


Alterado na versão 3.9: Added default arguments.

@end deffn

@geindex get_matching_blocks() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_matching_blocks}@anchor{24d4}
@deffn {Método} get_matching_blocks ()

Return list of triples describing non-overlapping matching subsequences.
Each triple is of the form @code{(i, j, n)},
and means that @code{a[i:i+n] == b[j:j+n]}.  The
triples are monotonically increasing in `i' and `j'.

The last triple is a dummy, and has the value @code{(len(a), len(b), 0)}.  It
is the only triple with @code{n == 0}.  If @code{(i, j, n)} and @code{(i', j', n')}
are adjacent triples in the list, and the second is not the last triple in
the list, then @code{i+n < i'} or @code{j+n < j'}; in other words, adjacent
triples always describe non-adjacent equal blocks.

@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 difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_opcodes}@anchor{24d5}
@deffn {Método} get_opcodes ()

Return list of 5-tuples describing how to turn `a' into `b'. Each tuple is
of the form @code{(tag, i1, i2, j1, j2)}.  The first tuple has @code{i1 == j1 ==
0}, and remaining tuples have `i1' equal to the `i2' from the preceding
tuple, and, likewise, `j1' equal to the previous `j2'.

The `tag' values are strings, with these meanings:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'replace'}

@tab

@code{a[i1:i2]} should be replaced by
@code{b[j1:j2]}.

@item

@code{'delete'}

@tab

@code{a[i1:i2]} should be deleted.  Note that
@code{j1 == j2} in this case.

@item

@code{'insert'}

@tab

@code{b[j1:j2]} should be inserted at
@code{a[i1:i1]}. Note that @code{i1 == i2} in
this case.

@item

@code{'equal'}

@tab

@code{a[i1:i2] == b[j1:j2]} (the sub-sequences
are equal).

@end multitable


Por exemplo:

@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 difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher get_grouped_opcodes}@anchor{24d6}
@deffn {Método} get_grouped_opcodes (n=3)

Return a @ref{109a,,generator} of groups with up to `n' lines of context.

Starting with the groups returned by @ref{24d5,,get_opcodes()}, this method
splits out smaller change clusters and eliminates intervening ranges which
have no changes.

The groups are returned in the same format as @ref{24d5,,get_opcodes()}.
@end deffn

@geindex ratio() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher ratio}@anchor{24d7}
@deffn {Método} ratio ()

Return a measure of the sequences’ similarity as a float in the range [0,
1].

Where T is the total number of elements in both sequences, and M is the
number of matches, this is 2.0*M / T. Note that this is @code{1.0} if the
sequences are identical, and @code{0.0} if they have nothing in common.

This is expensive to compute if @ref{24d4,,get_matching_blocks()} or
@ref{24d5,,get_opcodes()} hasn’t already been called, in which case you may want
to try @ref{24d8,,quick_ratio()} or @ref{24d9,,real_quick_ratio()} first to get an
upper bound.

@cartouche
@quotation Nota 
Caution: The result of a @ref{24d7,,ratio()} call may depend on the order of
the arguments. For instance:

@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 difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher quick_ratio}@anchor{24d8}
@deffn {Método} quick_ratio ()

Return an upper bound on @ref{24d7,,ratio()} relatively quickly.
@end deffn

@geindex real_quick_ratio() (método difflib.SequenceMatcher)
@anchor{library/difflib difflib SequenceMatcher real_quick_ratio}@anchor{24d9}
@deffn {Método} real_quick_ratio ()

Return an upper bound on @ref{24d7,,ratio()} very quickly.
@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{24d8,,quick_ratio()} and @ref{24d9,,real_quick_ratio()}
are always at least as large as @ref{24d7,,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 Examples,Differ Objects,SequenceMatcher Objects,difflib — Helpers for computing deltas
@anchor{library/difflib id1}@anchor{24da}@anchor{library/difflib sequencematcher-examples}@anchor{24db}
@subsubsection SequenceMatcher Examples


This example compares two strings, considering blanks to be “junk”:

@example
>>> s = SequenceMatcher(lambda x: x == " ",
...                     "private Thread currentThread;",
...                     "private volatile Thread currentThread;")
@end example

@ref{24d7,,ratio()} returns a float in [0, 1], measuring the similarity of the
sequences.  As a rule of thumb, a @ref{24d7,,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{24d4,,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{24d4,,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{24d5,,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 também



@itemize *

@item 
The @ref{24c9,,get_close_matches()} function in this module which shows how
simple code building on @ref{104f,,SequenceMatcher} can be used to do useful
work.

@item 
Simple version control recipe@footnote{https://code.activestate.com/recipes/576729-simple-version-control/} for a small application
built with @ref{104f,,SequenceMatcher}.
@end itemize


@node Differ Objects,Differ Example,SequenceMatcher Examples,difflib — Helpers for computing deltas
@anchor{library/difflib differ-objects}@anchor{24dc}@anchor{library/difflib id2}@anchor{24dd}
@subsubsection Differ Objects


Note that @ref{24c2,,Differ}-generated deltas make no claim to be `minimal'
diffs. To the contrary, minimal diffs are often counter-intuitive, because they
synch up anywhere possible, sometimes accidental matches 100 pages apart.
Restricting synch points to contiguous matches preserves some notion of
locality, at the occasional cost of producing a longer diff.

The @ref{24c2,,Differ} class has this constructor:


@deffn {Classe} difflib.Differ (linejunk=None, charjunk=None)

Optional keyword parameters `linejunk' and `charjunk' are for filter functions
(or @code{None}):

`linejunk': A function that accepts a single string argument, and returns true
if the string is junk.  The default is @code{None}, meaning that no line is
considered junk.

`charjunk': A function that accepts a single character argument (a string of
length 1), and returns true if the character is junk. The default is @code{None},
meaning that no character is considered junk.

These junk-filtering functions speed up matching to find
differences and do not cause any differing lines or characters to
be ignored.  Read the description of the
@ref{1ad8,,find_longest_match()} method’s `isjunk'
parameter for an explanation.

@ref{24c2,,Differ} objects are used (deltas generated) via a single method:

@geindex compare() (método difflib.Differ)
@anchor{library/difflib difflib Differ compare}@anchor{24cd}
@deffn {Método} compare (a, b)

Compare two sequences of lines, and generate the delta (a sequence of lines).

Each sequence must contain individual single-line strings ending with
newlines.  Such sequences can be obtained from the
@ref{24c7,,readlines()} method of file-like objects.  The delta
generated also consists of newline-terminated strings, ready to be
printed as-is via the @ref{15a1,,writelines()} method of a
file-like object.
@end deffn
@end deffn

@node Differ Example,A command-line interface to difflib,Differ Objects,difflib — Helpers for computing deltas
@anchor{library/difflib differ-example}@anchor{24de}@anchor{library/difflib differ-examples}@anchor{24df}
@subsubsection Differ Example


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{24c7,,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

Next we instantiate a Differ object:

@example
>>> d = Differ()
@end example

Note that when instantiating a @ref{24c2,,Differ} object we may pass functions to
filter out line and character “junk.”  See the @ref{24c2,,Differ()} constructor for
details.

Finally, we compare the two:

@example
>>> result = list(d.compare(text1, text2))
@end example

@code{result} is a list of strings, so let’s pretty-print it:

@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

As a single multi-line string it looks like this:

@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 A command-line interface to difflib,ndiff example,Differ Example,difflib — Helpers for computing deltas
@anchor{library/difflib a-command-line-interface-to-difflib}@anchor{24e0}@anchor{library/difflib difflib-interface}@anchor{24c8}
@subsubsection A command-line interface to 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,,A command-line interface to difflib,difflib — Helpers for computing deltas
@anchor{library/difflib ndiff-example}@anchor{24e1}
@subsubsection ndiff example


This example shows how to use @ref{24c4,,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 — Quebra automática e preenchimento de texto,unicodedata — Banco de dados de Unicode,difflib — Helpers for computing deltas,Serviços de Processamento de Texto
@anchor{library/textwrap doc}@anchor{24e2}@anchor{library/textwrap module-textwrap}@anchor{ec}@anchor{library/textwrap textwrap-text-wrapping-and-filling}@anchor{24e3}@anchor{library/textwrap translation-repo}@anchor{24e4}
@subsection @code{textwrap} — Quebra automática e preenchimento de texto


@geindex module; textwrap

`Código-fonte:' Lib/textwrap.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/textwrap.py}


__________________________________________________________________


O módulo @ref{ec,,textwrap} fornece algumas funções convenientes, assim como @ref{1003,,TextWrapper}, a classe que faz todo o trabalho. Se você estiver apenas preenchendo ou fazendo quebra de linha de uma ou duas strings, as funções de conveniência deverão ser boas o suficiente; caso contrário, você deve usar uma instância de @ref{1003,,TextWrapper} para eficiência.

@geindex wrap() (no módulo textwrap)
@anchor{library/textwrap textwrap wrap}@anchor{150f}
@deffn {Função} 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=' [...]')

Quebra do parágrafo único em `text' (uma string) para que cada linha tenha no máximo `width' caracteres. Retorna uma lista de linhas de saída, sem novas linhas ao final.

Argumentos nomeados opcionais correspondem aos atributos de instância de @ref{1003,,TextWrapper}, documentados abaixo.

Veja o método @ref{24e5,,TextWrapper.wrap()} para detalhes adicionais sobre como @ref{150f,,wrap()} se comporta.
@end deffn

@geindex fill() (no módulo textwrap)
@anchor{library/textwrap textwrap fill}@anchor{150e}
@deffn {Função} 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=' [...]')

Quebra o parágrafo único em `text' e retorna uma única string contendo o parágrafo quebrado. @ref{150e,,fill()} é uma abreviação de

@example
"\n".join(wrap(text, ...))
@end example

Em particular, @ref{150e,,fill()} aceita exatamente os mesmos argumentos nomeados que @ref{150f,,wrap()}.
@end deffn

@geindex shorten() (no módulo textwrap)
@anchor{library/textwrap textwrap shorten}@anchor{1006}
@deffn {Função} textwrap.shorten (text, width, *, fix_sentence_endings=False, break_long_words=True, break_on_hyphens=True, placeholder=' [...]')

Recolhe e trunca o texto `text' fornecido para caber na largura `width' fornecida.

Primeiro, o espaço em branco em `text' é recolhido (todos os espaços em branco são substituídos por espaços simples). Se o resultado couber em `width', ele será retornado. Caso contrário, palavras suficientes serão eliminadas do final para que as palavras restantes mais o `placeholder' caibam em `largura':

@example
>>> textwrap.shorten("Olá  mundo!", width=12)
'Olá mundo!'
>>> textwrap.shorten("Olá  mundo!", width=11)
'Olá [...]'
>>> textwrap.shorten("Olá mundo", width=10, placeholder="...")
'Olá...'
@end example

Argumentos nomeados opcionais correspondem aos atributos de instância de @ref{1003,,TextWrapper}, documentados abaixo. Observe que o espaço em branco é recolhido antes do texto ser passado para a função @ref{1003,,TextWrapper} @ref{150e,,fill()}, alterando assim o valor de @ref{24e6,,tabsize}, @ref{24e7,,expand_tabs}, @ref{24e8,,drop_whitespace} e @ref{24e9,,replace_whitespace} não terão efeito.


Adicionado na versão 3.4.

@end deffn

@geindex dedent() (no módulo textwrap)
@anchor{library/textwrap textwrap dedent}@anchor{24ea}
@deffn {Função} textwrap.dedent (text)

Remove qualquer espaço em branco inicial em comum de toda linha em `text'.

Isso pode ser usado para alinhar strings entre aspas triplas com a borda esquerda da tela, enquanto ainda as apresenta no código-fonte em formato com indentação.

Observe que tabulações e espaços são tratados como espaços em branco, mas não são iguais: as linhas @code{"  hello"} e @code{"\thello"} são consideradas como não tendo espaços em branco iniciais comuns.

Linhas contendo apenas espaços em branco são ignoradas na entrada e normalizadas para um único caractere de nova linha na saída.

Por exemplo:

@example
def test():
    # fim da primeira linha com \ para evitar uma linha vazia!
    s = '@w{'}'\
    olá
      mundo
    '@w{'}'
    print(repr(s))          # exibe '    olá\n      mundo\n    '
    print(repr(dedent(s)))  # exibe 'olá\n  mundo\n'
@end example
@end deffn

@geindex indent() (no módulo textwrap)
@anchor{library/textwrap textwrap indent}@anchor{276}
@deffn {Função} textwrap.indent (text, prefix, predicate=None)

Adiciona `prefix' ao início das linhas selecionadas em `text'.

As linhas são separadas chamando @code{text.splitlines(True)}.

Por padrão, `prefix' é adicionado a todas as linhas que não consistem apenas em espaços em branco (incluindo quaisquer finais de linha).

Por exemplo:

@example
>>> s = 'olá\n\n \nmundo'
>>> indent(s, '  ')
'  olá\n\n \n  mundo'
@end example

O argumento opcional `predicate' pode ser usado para controlar quais linhas têm indentação. Por exemplo, é fácil adicionar `prefix' até mesmo em linhas vazias e apenas com espaços em branco:

@example
>>> print(indent(s, '+ ', lambda line: True))
+ olá
+
+
+ mundo
@end example


Adicionado na versão 3.3.

@end deffn

@ref{150f,,wrap()}, @ref{150e,,fill()} e @ref{1006,,shorten()} funcionam criando uma instância @ref{1003,,TextWrapper} e chamando um único método nela. Essa instância não é reutilizada, então para aplicações que processam muitas strings de texto usando @ref{150f,,wrap()} e/ou @ref{150e,,fill()}, pode ser mais eficiente criar seu próprio objeto @ref{1003,,TextWrapper}.

O texto é preferencialmente colocado em espaços em branco e logo após os hífens nas palavras hifenizadas; somente então palavras longas serão quebradas se necessário, a menos que @ref{24eb,,TextWrapper.break_long_words} seja definido como falso.

@geindex TextWrapper (classe em textwrap)
@anchor{library/textwrap textwrap TextWrapper}@anchor{1003}
@deffn {Classe} textwrap.TextWrapper (**kwargs)

O construtor @ref{1003,,TextWrapper} aceita vários argumentos nomeados opcionais. Cada argumento nomeado corresponde a um atributo de instância, por exemplo:

@example
wrapper = TextWrapper(initial_indent="* ")
@end example

é o mesmo que

@example
wrapper = TextWrapper()
wrapper.initial_indent = "* "
@end example

Você pode reutilizar o mesmo objeto @ref{1003,,TextWrapper} muitas vezes e pode alterar qualquer uma de suas opções através de atribuição direta a atributos de instância entre os usos.

Os atributos de instância @ref{1003,,TextWrapper} (e argumentos nomeados para o construtor) são os seguintes:

@geindex width (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper width}@anchor{24ec}
@deffn {Atributo} width

(padrão: @code{70}) O comprimento máximo das linhas quebradas. Contanto que não existam palavras individuais no texto de entrada maiores que @ref{24ec,,width}, @ref{1003,,TextWrapper} garante que nenhuma linha de saída será maior que @ref{24ec,,width} caracteres.
@end deffn

@geindex expand_tabs (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper expand_tabs}@anchor{24e7}
@deffn {Atributo} expand_tabs

(padrão: @code{True}) Se verdadeiro, então todos os caracteres de tabulação em `text' serão expandidos para espaços usando o método @ref{2356,,expandtabs()} de `text'.
@end deffn

@geindex tabsize (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper tabsize}@anchor{24e6}
@deffn {Atributo} tabsize

(padrão: @code{8}) Se @ref{24e7,,expand_tabs} for verdadeiro, então todos os caracteres de tabulação em `text' serão expandidos para zero ou mais espaços, dependendo da coluna atual e do tamanho da tabulação fornecido.


Adicionado na versão 3.3.

@end deffn

@geindex replace_whitespace (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper replace_whitespace}@anchor{24e9}
@deffn {Atributo} replace_whitespace

(padrão: @code{True}) Se verdadeiro, após a expansão da tabulação, mas antes da quebra, o método @ref{150f,,wrap()} substituirá cada caractere de espaço em branco por um único espaço. Os caracteres de espaço em branco substituídos são os seguintes: tabulação, nova linha, tabulação vertical, feed de formulário e retorno de carro (@code{'\t\n\v\f\r'}).

@cartouche
@quotation Nota 
Se @ref{24e7,,expand_tabs} for falso e @ref{24e9,,replace_whitespace} for verdadeiro, cada caractere de tabulação será substituído por um único espaço, que `não' é o mesmo que expansão de tabulação.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se @ref{24e9,,replace_whitespace} for falso, novas linhas podem aparecer no meio de uma linha e causar uma saída estranha. Por esta razão, o texto deve ser dividido em parágrafos (usando @ref{1298,,str.splitlines()} ou similar) que são agrupados separadamente.
@end quotation
@end cartouche
@end deffn

@geindex drop_whitespace (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper drop_whitespace}@anchor{24e8}
@deffn {Atributo} drop_whitespace

(padrão: @code{True}) Se verdadeiro, os espaços em branco no início e no final de cada linha (após quebra automática, mas antes do recuo) são eliminados. O espaço em branco no início do parágrafo, entretanto, não será eliminado se não houver espaço em branco após ele. Se o espaço em branco eliminado ocupar uma linha inteira, a linha inteira será eliminada.
@end deffn

@geindex initial_indent (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper initial_indent}@anchor{24ed}
@deffn {Atributo} initial_indent

(padrão: @code{'@w{'}}) String que será anexada à primeira linha da saída com quebra de linha. Conta para o comprimento da primeira linha. A string vazia não recebe indentação.
@end deffn

@geindex subsequent_indent (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper subsequent_indent}@anchor{24ee}
@deffn {Atributo} subsequent_indent

(padrão: @code{'@w{'}}) String que será anexada a todas as linhas da saída com quebra de linha, exceto a primeira. Conta para o comprimento de cada linha, exceto a primeira.
@end deffn

@geindex fix_sentence_endings (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper fix_sentence_endings}@anchor{24ef}
@deffn {Atributo} fix_sentence_endings

(padrão: @code{False}) Se verdadeiro, @ref{1003,,TextWrapper} tenta detectar finais de sentenças e garantir que as sentenças sejam sempre separadas por exatamente dois espaços. Isso geralmente é desejado para texto em fonte monoespaçada. No entanto, o algoritmo de detecção de frase é imperfeito: ele presume que o final de uma frase consiste em uma letra minúscula seguida por uma de @code{'.'}, @code{'!'} ou @code{'?'}, possivelmente seguido por um de @code{'"'} ou @code{"'"}, seguido por um espaço. Um problema com este algoritmo é que ele é incapaz de detectar a diferença entre “Dr.” em

@example
[...] Dr. Frankenstein's monster [...]
@end example

e “Spot.” em

@example
[...] See Spot. See Spot run [...]
@end example

@ref{24ef,,fix_sentence_endings} é falso por padrão

Como o algoritmo de detecção de frase depende de @code{string.lowercase} para a definição de “letra minúscula” e de uma convenção de usar dois espaços após um ponto final para separar frases na mesma linha, ele é específico para textos em inglês.
@end deffn

@geindex break_long_words (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper break_long_words}@anchor{24eb}
@deffn {Atributo} break_long_words

(padrão: @code{True}) Se verdadeiro, palavras maiores que @ref{24ec,,width} serão quebradas para garantir que nenhuma linha seja maior que @ref{24ec,,width}. Se for falso, palavras longas não serão quebradas e algumas linhas poderão ser maiores que @ref{24ec,,width}. (Palavras longas serão colocadas sozinhas em uma linha, a fim de minimizar o valor pelo qual @ref{24ec,,width} é excedido.)
@end deffn

@geindex break_on_hyphens (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper break_on_hyphens}@anchor{24f0}
@deffn {Atributo} break_on_hyphens

(padrão: @code{True}) Se verdadeiro, a quebra ocorrerá preferencialmente em espaços em branco e logo após hífens em palavras compostas, como é habitual em inglês. Se for falso, apenas os espaços em branco serão considerados locais potencialmente bons para quebras de linha, mas você precisa definir @ref{24eb,,break_long_words} como falso se quiser palavras verdadeiramente inseparáveis. O comportamento padrão nas versões anteriores era sempre permitir a quebra de palavras hifenizadas.
@end deffn

@geindex max_lines (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper max_lines}@anchor{1004}
@deffn {Atributo} max_lines

(padrão: @code{None}) Se não for @code{None}, então a saída conterá no máximo `max_lines' linhas, com `placeholder' aparecendo no final da saída.


Adicionado na versão 3.4.

@end deffn

@geindex ...;espaço reservado

@geindex placeholder (atributo textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper placeholder}@anchor{1005}
@deffn {Atributo} placeholder

(padrão: @code{' [...]'}) String que aparecerá no final do texto de saída se ele tiver sido truncado.


Adicionado na versão 3.4.

@end deffn

@ref{1003,,TextWrapper} também fornece alguns métodos públicos, análogos às funções de conveniência em nível de módulo:

@geindex wrap() (método textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper wrap}@anchor{24e5}
@deffn {Método} wrap (text)

Quebra o parágrafo único em `text' (uma string) para que cada linha tenha no máximo @ref{24ec,,width} caracteres. Todas as opções de quebra de linha são obtidas dos atributos da instância @ref{1003,,TextWrapper}. Retorna uma lista de linhas de saída, sem novas linhas finais. Se a saída agrupada não tiver conteúdo, a lista retornada estará vazia.
@end deffn

@geindex fill() (método textwrap.TextWrapper)
@anchor{library/textwrap textwrap TextWrapper fill}@anchor{24f1}
@deffn {Método} fill (text)

Quebra o parágrafo único em `text' e retorna uma única string contendo o parágrafo quebrado.
@end deffn
@end deffn

@node unicodedata — Banco de dados de Unicode,stringprep — Preparação de string para internet,textwrap — Quebra automática e preenchimento de texto,Serviços de Processamento de Texto
@anchor{library/unicodedata doc}@anchor{24f2}@anchor{library/unicodedata module-unicodedata}@anchor{105}@anchor{library/unicodedata translation-repo}@anchor{24f3}@anchor{library/unicodedata unicodedata-unicode-database}@anchor{24f4}
@subsection @code{unicodedata} — Banco de dados de Unicode


@geindex module; unicodedata

@geindex Unicode
@geindex caractere
@geindex Unicode;banco de dados


__________________________________________________________________


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 15.1.0@footnote{https://www.unicode.org/Public/15.1.0/ucd}.

O módulo utiliza os mesmos nomes e símbolos definidos no Anexo 44 do Padrão Unicode, "Unicode Character Database"@footnote{https://www.unicode.org/reports/tr44/}. Ele define as seguintes funções:


@subsubheading Ver também


O @ref{12e7,,Unicode} para mais informações sobre Unicode e como usar este módulo.


@geindex lookup() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata lookup}@anchor{10b1}
@deffn {Função} unicodedata.lookup (name)

Procurar personagem pelo nome. Se um personagem com o nome fornecido for encontrado, retornar o personagem correspondente. Se não for encontrado, @ref{344,,KeyError} é levantada. Por exemplo:

@example
>>> unicodedata.lookup('LEFT CURLY BRACKET')
'@{'
@end example

Os caracteres retornados por esta função são os mesmos produzidos pela sequência de escape @code{\N} em literais de string. Por exemplo:

@example
>>> unicodedata.lookup('MIDDLE DOT') == '\N@{MIDDLE DOT@}'
True
@end example


Alterado na versão 3.3: Foi adicionado suporte para apelidos de nomes @footnote{
@indicateurl{https://www.unicode.org/Public/15.1.0/ucd/NameAliases.txt}
} e sequências nomeadas @footnote{
@indicateurl{https://www.unicode.org/Public/15.1.0/ucd/NamedSequences.txt}
}.

@end deffn

@geindex name() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata name}@anchor{24f5}
@deffn {Função} unicodedata.name (chr, default=None, /)

Retorna o nome atribuído ao caractere `chr' como uma string. Se nenhum nome for definido, `default' será retornado ou, se não for fornecido, @ref{202,,ValueError} será levantada. Por exemplo:

@example
>>> unicodedata.name('½')
'VULGAR FRACTION ONE HALF'
>>> unicodedata.name('\uFFFF', 'fallback')
'fallback'
@end example
@end deffn

@geindex decimal() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata decimal}@anchor{24f6}
@deffn {Função} unicodedata.decimal (chr, default=None, /)

Retorna o valor decimal atribuído ao caractere `chr' como inteiro. Se nenhum valor for definido, `default' será retornado ou, se não for fornecido, @ref{202,,ValueError} será levantada. Por exemplo:

@example
>>> unicodedata.decimal('\N@{ARABIC-INDIC DIGIT NINE@}')
9
>>> unicodedata.decimal('\N@{SUPERSCRIPT NINE@}', -1)
-1
@end example
@end deffn

@geindex digit() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata digit}@anchor{24f7}
@deffn {Função} unicodedata.digit (chr, default=None, /)

Retorna o valor de dígito atribuído ao caractere `chr' como inteiro. Se nenhum valor for definido, `default' será retornado ou, se não for fornecido, @ref{202,,ValueError} será levantada.

@example
>>> unicodedata.digit('\N@{SUPERSCRIPT NINE@}')
9
@end example
@end deffn

@geindex numeric() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata numeric}@anchor{12a4}
@deffn {Função} unicodedata.numeric (chr, default=None, /)

Retorna o valor numérico atribuído ao caractere `chr' como float. Se nenhum valor for definido, `default' será retornado ou, se não for fornecido, @ref{202,,ValueError} será levantada.

@example
>>> unicodedata.numeric('½')
0.5
@end example
@end deffn

@geindex category() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata category}@anchor{24f8}
@deffn {Função} unicodedata.category (chr)

Returns the general category assigned to the character `chr' as
string. General category names consist of two letters.
See the General Category Values section of the Unicode Character Database documentation@footnote{https://www.unicode.org/reports/tr44/tr44-30.html#General_Category_Values}
for a list of category codes. For example:

@example
>>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
'Lu'
@end example
@end deffn

@geindex bidirectional() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata bidirectional}@anchor{24f9}
@deffn {Função} unicodedata.bidirectional (chr)

Returns the bidirectional class assigned to the character `chr' as
string. If no such value is defined, an empty string is returned.
See the Bidirectional Class Values section of the Unicode Character Database@footnote{https://www.unicode.org/reports/tr44/tr44-30.html#Bidi_Class_Values}
documentation for a list of bidirectional codes. For example:

@example
>>> unicodedata.bidirectional('\N@{ARABIC-INDIC DIGIT SEVEN@}') # 'A'rabic, 'N'umber
'AN'
@end example
@end deffn

@geindex combining() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata combining}@anchor{24fa}
@deffn {Função} unicodedata.combining (chr)

Returns the canonical combining class assigned to the character `chr'
as integer. Returns @code{0} if no combining class is defined.
See the Canonical Combining Class Values section of the Unicode Character Database@footnote{https://www.unicode.org/reports/tr44/tr44-30.html#Canonical_Combining_Class_Values}
for more information.
@end deffn

@geindex east_asian_width() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata east_asian_width}@anchor{24fb}
@deffn {Função} unicodedata.east_asian_width (chr)

Returns the east asian width assigned to the character `chr' as
string. For a list of widths and or more information, see the
Unicode Standard Annex #11@footnote{https://www.unicode.org/reports/tr11/tr11-41.html}.
@end deffn

@geindex mirrored() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata mirrored}@anchor{24fc}
@deffn {Função} unicodedata.mirrored (chr)

Returns the mirrored property assigned to the character `chr' as
integer. Returns @code{1} if the character has been identified as a “mirrored”
character in bidirectional text, @code{0} otherwise. For example:

@example
>>> unicodedata.mirrored('>')
1
@end example
@end deffn

@geindex decomposition() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata decomposition}@anchor{24fd}
@deffn {Função} unicodedata.decomposition (chr)

Returns the character decomposition mapping assigned to the character
`chr' as string. An empty string is returned in case no such mapping is
defined. For example:

@example
>>> unicodedata.decomposition('Ã')
'0041 0303'
@end example
@end deffn

@geindex normalize() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata normalize}@anchor{6d5}
@deffn {Função} unicodedata.normalize (form, unistr)

Return the normal form `form' for the Unicode string `unistr'. Valid values for
`form' are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

The Unicode standard defines various normalization forms of a Unicode string,
based on the definition of canonical equivalence and compatibility equivalence.
In Unicode, several characters can be expressed in various way. For example, the
character U+00C7 (LATIN CAPITAL LETTER C WITH CEDILLA) can also be expressed as
the sequence U+0043 (LATIN CAPITAL LETTER C) U+0327 (COMBINING CEDILLA).

For each character, there are two normal forms: normal form C and normal form D.
Normal form D (NFD) is also known as canonical decomposition, and translates
each character into its decomposed form. Normal form C (NFC) first applies a
canonical decomposition, then composes pre-combined characters again.

In addition to these two forms, there are two additional normal forms based on
compatibility equivalence. In Unicode, certain characters are supported which
normally would be unified with other characters. For example, U+2160 (ROMAN
NUMERAL ONE) is really the same thing as U+0049 (LATIN CAPITAL LETTER I).
However, it is supported in Unicode for compatibility with existing character
sets (for example, gb2312).

The normal form KD (NFKD) will apply the compatibility decomposition, that is,
replace all compatibility characters with their equivalents. The normal form KC
(NFKC) first applies the compatibility decomposition, followed by the canonical
composition.

Even if two unicode strings are normalized and look the same to
a human reader, if one has combining characters and the other
doesn’t, they may not compare equal.
@end deffn

@geindex is_normalized() (no módulo unicodedata)
@anchor{library/unicodedata unicodedata is_normalized}@anchor{a51}
@deffn {Função} unicodedata.is_normalized (form, unistr)

Return whether the Unicode string `unistr' is in the normal form `form'. Valid
values for `form' are ‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.


Adicionado na versão 3.8.

@end deffn

In addition, the module exposes the following constant:

@geindex unidata_version (no módulo unicodedata)
@anchor{library/unicodedata unicodedata unidata_version}@anchor{24fe}
@deffn {Dado} unicodedata.unidata_version

The version of the Unicode database used in this module.
@end deffn

@geindex ucd_3_2_0 (no módulo unicodedata)
@anchor{library/unicodedata unicodedata ucd_3_2_0}@anchor{147b}
@deffn {Dado} unicodedata.ucd_3_2_0

This is an object that has the same methods as the entire module, but uses the
Unicode database version 3.2 instead, for applications that require this
specific version of the Unicode database (such as IDNA).
@end deffn

@node stringprep — Preparação de string para internet,readline — Interface para o GNU readline,unicodedata — Banco de dados de Unicode,Serviços de Processamento de Texto
@anchor{library/stringprep doc}@anchor{24ff}@anchor{library/stringprep module-stringprep}@anchor{d4}@anchor{library/stringprep stringprep-internet-string-preparation}@anchor{2500}@anchor{library/stringprep translation-repo}@anchor{2501}
@subsection @code{stringprep} — Preparação de string para internet


@geindex module; stringprep

`Código-fonte:' Lib/stringprep.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/stringprep.py}


__________________________________________________________________


Ao identificar coisas (como nomes de host) na internet, muitas vezes é necessário comparar tais identificações para “igualdade”. Exatamente como essa comparação é executada pode depender do domínio da aplicação, por exemplo, se deve ser insensível a maiúsculas e minúsculas ou não. Também pode ser necessário restringir as possíveis identificações, para permitir apenas identificações consistindo de caracteres “imprimíveis”.

@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} define um procedimento para “preparar” strings Unicode em protocolos de internet. Antes de passar strings para o fio, elas são processadas com o procedimento de preparação, após o qual elas têm uma certa forma normalizada. O RFC define um conjunto de tabelas, que podem ser combinadas em perfis. Cada perfil deve definir quais tabelas ele usa, e quais outras partes opcionais do procedimento @code{stringprep} são parte do perfil. Um exemplo de um perfil @code{stringprep} é @code{nameprep}, que é usado para nomes de domínio internacionalizados.

O módulo @ref{d4,,stringprep} expõe apenas as tabelas do 
@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html}. Como essas tabelas seriam muito grandes para representar como dicionários ou listas, o módulo usa o banco de dados de caracteres Unicode internamente. O código-fonte do módulo em si foi gerado usando o utilitário @code{mkstringprep.py}.

Como resultado, essas tabelas são expostas como funções, não como estruturas de dados. Existem dois tipos de tabelas no RFC: conjuntos e mapeamentos. Para um conjunto, @ref{d4,,stringprep} fornece a “função característica”, ou seja, uma função que retorna @code{True} se o parâmetro fizer parte do conjunto. Para mapeamentos, ele fornece a função de mapeamento: dada a chave, ele retorna o valor associado. Abaixo está uma lista de todas as funções disponíveis no módulo.

@geindex in_table_a1() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_a1}@anchor{2502}
@deffn {Função} stringprep.in_table_a1 (code)

Determina se `code' está na tabela A.1 (pontos de código não atribuídos no Unicode 3.2).
@end deffn

@geindex in_table_b1() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_b1}@anchor{2503}
@deffn {Função} stringprep.in_table_b1 (code)

Determina se `code' está na tabela B.1 (comumente mapeado para nada).
@end deffn

@geindex map_table_b2() (no módulo stringprep)
@anchor{library/stringprep stringprep map_table_b2}@anchor{2504}
@deffn {Função} stringprep.map_table_b2 (code)

Retorna o valor mapeado para `code' de acordo com a tabela B.2 (mapeamento para dobramento de casos usado com NFKC).
@end deffn

@geindex map_table_b3() (no módulo stringprep)
@anchor{library/stringprep stringprep map_table_b3}@anchor{2505}
@deffn {Função} stringprep.map_table_b3 (code)

Retorna o valor mapeado para `code' de acordo com a tabela B.3 (mapeamento para dobramento de casos usado com nenhuma normalização).
@end deffn

@geindex in_table_c11() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c11}@anchor{2506}
@deffn {Função} stringprep.in_table_c11 (code)

Determina se `code' está na tabela C.1.1 (caracteres de espaço ASCII).
@end deffn

@geindex in_table_c12() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c12}@anchor{2507}
@deffn {Função} stringprep.in_table_c12 (code)

Determina se `code' está na tabela C.1.2 (caracteres de espaço não-ASCII).
@end deffn

@geindex in_table_c11_c12() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c11_c12}@anchor{2508}
@deffn {Função} stringprep.in_table_c11_c12 (code)

Determina se `code' está na tabela C.1 (caracteres de espaço, união de C.1.1 e C.1.2).
@end deffn

@geindex in_table_c21() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c21}@anchor{2509}
@deffn {Função} stringprep.in_table_c21 (code)

Determina se `code' está na tabela C.2.1 (caracteres de controle ASCII).
@end deffn

@geindex in_table_c22() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c22}@anchor{250a}
@deffn {Função} stringprep.in_table_c22 (code)

Determina se `code' está na tabela C.2.2 (caracteres de controle não-ASCII).
@end deffn

@geindex in_table_c21_c22() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c21_c22}@anchor{250b}
@deffn {Função} stringprep.in_table_c21_c22 (code)

Determina se `code' está na tabela C.2 (caracteres de controle, união de C.2.1 e C.2.2).
@end deffn

@geindex in_table_c3() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c3}@anchor{250c}
@deffn {Função} stringprep.in_table_c3 (code)

Determina se `code' está na tabela C.3 (uso privado).
@end deffn

@geindex in_table_c4() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c4}@anchor{250d}
@deffn {Função} stringprep.in_table_c4 (code)

Determina se `code' está na tabela C.4 (pontos de código não-caracteres).
@end deffn

@geindex in_table_c5() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c5}@anchor{250e}
@deffn {Função} stringprep.in_table_c5 (code)

Determina se `code' está na tabela C.5 (códigos substitutos).
@end deffn

@geindex in_table_c6() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c6}@anchor{250f}
@deffn {Função} stringprep.in_table_c6 (code)

Determina se `code' está na tabela C.6 (inapropriado para texto simples).
@end deffn

@geindex in_table_c7() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c7}@anchor{2510}
@deffn {Função} stringprep.in_table_c7 (code)

Determina se `code' está na tabela C.7 (inapropriado para para representação canônica).
@end deffn

@geindex in_table_c8() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c8}@anchor{2511}
@deffn {Função} stringprep.in_table_c8 (code)

Determina se `code' está na tabela C.8 (alteram propriedades de exibição ou estão descontinuadas).
@end deffn

@geindex in_table_c9() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_c9}@anchor{2512}
@deffn {Função} stringprep.in_table_c9 (code)

Determina se `code' está na tabela C.9 (caracteres de tag).
@end deffn

@geindex in_table_d1() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_d1}@anchor{2513}
@deffn {Função} stringprep.in_table_d1 (code)

Determina se `code' está na tabela D.1 (Caracteres com propriedade bidirecional “R” ou “AL”).
@end deffn

@geindex in_table_d2() (no módulo stringprep)
@anchor{library/stringprep stringprep in_table_d2}@anchor{2514}
@deffn {Função} stringprep.in_table_d2 (code)

Determina se `code' está na tabela D.2 (Caracteres com propriedade bidirecional “L”).
@end deffn

@node readline — Interface para o GNU readline,rlcompleter — Função de autocomplemento para GNU readline,stringprep — Preparação de string para internet,Serviços de Processamento de Texto
@anchor{library/readline doc}@anchor{2515}@anchor{library/readline module-readline}@anchor{ba}@anchor{library/readline readline-gnu-readline-interface}@anchor{2516}@anchor{library/readline translation-repo}@anchor{2517}
@subsection @code{readline} — Interface para o GNU readline


@geindex module; readline


__________________________________________________________________


O módulo @ref{ba,,readline} define uma série de funções para facilitar o autocomplemento e leitura/gravação de arquivos históricos do interpretador Python. Este módulo pode ser usado diretamente ou através do módulo @ref{bd,,rlcompleter}, que provê o autocomplemento de identificadores Python no prompt interativo. As configurações feitas usando este módulo afetam o comportamento do prompt interativo do interpretador e dos prompts oferecidos pela função embutida @ref{131b,,input()}.

As combinações de teclas do Readline podem ser configuradas através de um arquivo de inicialização, normalmente @code{.inputrc} em seu diretório inicial. Consulte Readline Init File@footnote{https://tiswww.cwru.edu/php/chet/readline/rluserman.html#Readline-Init-File} no manual do GNU Readline para obter informações sobre o formato e construções permitidas desse arquivo e os recursos da biblioteca do Readline em geral.

@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@cartouche
@quotation Nota 
A API da biblioteca subjacente do Readline pode ser implementada pela biblioteca @code{editline} (@code{libedit}) em vez do GNU readline. No macOS, o módulo @ref{ba,,readline} detecta qual biblioteca está sendo usada em tempo de execução.

O arquivo de configuração do @code{editline} é diferente daquele do GNU readline. Se você carregar strings de configuração programaticamente, você pode usar @ref{17a3,,backend} para determinar qual biblioteca está sendo usada.

Se você usar a emulação de readline do @code{editline}/@code{libedit} no macOS, o arquivo de inicialização localizado em seu diretório inicial será denominado @code{.editrc}. Por exemplo, o seguinte conteúdo em @code{~/.editrc} ativará os atalhos de teclado `vi' e o autocomplemento de TAB:

@example
python:bind -v
python:bind ^I rl_complete
@end example

Observe também que bibliotecas diferentes podem usar formatos de arquivo de histórico diferentes. Ao alternar a biblioteca subjacente, os arquivos de histórico existentes podem se tornar inutilizáveis.
@end quotation
@end cartouche

@geindex backend (no módulo readline)
@anchor{library/readline readline backend}@anchor{17a3}
@deffn {Dado} readline.backend

O nome da biblioteca Readline subjacente que está sendo usada, seja @code{"readline"} ou @code{"editline"}.


Adicionado na versão 3.13.

@end deffn

@menu
* Arquivo init:: 
* Buffer de linha:: 
* Arquivo de histórico:: 
* Lista de histórico:: 
* Ganchos de inicialização:: 
* Autocomplemento:: 
* Exemplo:: 

@end menu

@node Arquivo init,Buffer de linha,,readline — Interface para o GNU readline
@anchor{library/readline init-file}@anchor{2518}
@subsubsection Arquivo init


As seguintes funções estão relacionadas ao arquivo init e à configuração do usuário:

@geindex parse_and_bind() (no módulo readline)
@anchor{library/readline readline parse_and_bind}@anchor{2519}
@deffn {Função} readline.parse_and_bind (string)

Executa a linha de init fornecida no argumento `string'. Isso chama @code{rl_parse_and_bind()} na biblioteca subjacente.
@end deffn

@geindex read_init_file() (no módulo readline)
@anchor{library/readline readline read_init_file}@anchor{251a}
@deffn {Função} readline.read_init_file ([filename])

Executa um arquivo de inicialização do readline. O nome de arquivo padrão é o último nome de arquivo usado. Isso chama @code{rl_read_init_file()} na biblioteca subjacente.
@end deffn

@node Buffer de linha,Arquivo de histórico,Arquivo init,readline — Interface para o GNU readline
@anchor{library/readline line-buffer}@anchor{251b}
@subsubsection Buffer de linha


As seguintes funções operam no buffer de linha:

@geindex get_line_buffer() (no módulo readline)
@anchor{library/readline readline get_line_buffer}@anchor{251c}
@deffn {Função} readline.get_line_buffer ()

Retorna o conteúdo atual do buffer de linha (@code{rl_line_buffer} na biblioteca subjacente).
@end deffn

@geindex insert_text() (no módulo readline)
@anchor{library/readline readline insert_text}@anchor{251d}
@deffn {Função} readline.insert_text (string)

Insere texto no buffer de linha na posição do cursor. Isso chama @code{rl_insert_text()} na biblioteca subjacente, mas ignora o valor de retorno.
@end deffn

@geindex redisplay() (no módulo readline)
@anchor{library/readline readline redisplay}@anchor{150d}
@deffn {Função} readline.redisplay ()

Altera o que é exibido na tela para refletir o conteúdo atual do buffer de linha. Isso chama @code{rl_redisplay()} na biblioteca subjacente.
@end deffn

@node Arquivo de histórico,Lista de histórico,Buffer de linha,readline — Interface para o GNU readline
@anchor{library/readline history-file}@anchor{251e}
@subsubsection Arquivo de histórico


As seguintes funções operam em um arquivo histórico:

@geindex read_history_file() (no módulo readline)
@anchor{library/readline readline read_history_file}@anchor{251f}
@deffn {Função} readline.read_history_file ([filename])

Carrega um arquivo de histórico do readline e anexa-o à lista de histórico. O nome do arquivo padrão é @code{~/.history}. Isso chama @code{read_history()} na biblioteca subjacente.
@end deffn

@geindex write_history_file() (no módulo readline)
@anchor{library/readline readline write_history_file}@anchor{2520}
@deffn {Função} readline.write_history_file ([filename])

Salva a lista de histórico em um arquivo de histórico readline, substituindo qualquer arquivo existente. O nome do arquivo padrão é @code{~/.history}. Isso chama @code{write_history()} na biblioteca subjacente.
@end deffn

@geindex append_history_file() (no módulo readline)
@anchor{library/readline readline append_history_file}@anchor{e7f}
@deffn {Função} readline.append_history_file (nelements[, filename])

Anexa os últimos `nelements' itens do histórico a um arquivo. O nome do arquivo padrão é @code{~/.history}. O arquivo já deve existir. Isso chama @code{append_history()} na biblioteca subjacente. Esta função só existe se o Python foi compilado para uma versão da biblioteca que a suporta.


Adicionado na versão 3.5.

@end deffn

@geindex get_history_length() (no módulo readline)
@geindex set_history_length() (no módulo readline)
@anchor{library/readline readline get_history_length}@anchor{2521}
@deffn {Função} readline.get_history_length ()
@anchor{library/readline readline set_history_length}@anchor{16e1}
@deffnx {Função} readline.set_history_length (length)

Define ou retorna o número desejado de linhas para salvar no arquivo de histórico. A função @ref{2520,,write_history_file()} usa este valor para truncar o arquivo de histórico, chamando @code{history_truncate_file()} na biblioteca subjacente. Valores negativos implicam tamanho ilimitado do arquivo de histórico.
@end deffn

@node Lista de histórico,Ganchos de inicialização,Arquivo de histórico,readline — Interface para o GNU readline
@anchor{library/readline history-list}@anchor{2522}
@subsubsection Lista de histórico


As seguintes funções operam em uma lista de histórico global:

@geindex clear_history() (no módulo readline)
@anchor{library/readline readline clear_history}@anchor{2523}
@deffn {Função} readline.clear_history ()

Limpa o histórico atual. Isso chama @code{clear_history()} na biblioteca subjacente. A função Python só existe se o Python foi compilado para uma versão da biblioteca que a suporta.
@end deffn

@geindex get_current_history_length() (no módulo readline)
@anchor{library/readline readline get_current_history_length}@anchor{150c}
@deffn {Função} readline.get_current_history_length ()

Retorna o número de itens atualmente no histórico. (Isso é diferente de @ref{2521,,get_history_length()}, que retorna o número máximo de linhas que serão gravadas em um arquivo de histórico.)
@end deffn

@geindex get_history_item() (no módulo readline)
@anchor{library/readline readline get_history_item}@anchor{150b}
@deffn {Função} readline.get_history_item (index)

Retorna o conteúdo atual do item do histórico em `index'. O índice do item é baseado em um. Isso chama @code{history_get()} na biblioteca subjacente.
@end deffn

@geindex remove_history_item() (no módulo readline)
@anchor{library/readline readline remove_history_item}@anchor{2524}
@deffn {Função} readline.remove_history_item (pos)

Remove o item de histórico especificado por sua posição do histórico. A posição conta a partir de zero. Isso chama @code{remove_history()} na biblioteca subjacente.
@end deffn

@geindex replace_history_item() (no módulo readline)
@anchor{library/readline readline replace_history_item}@anchor{2525}
@deffn {Função} readline.replace_history_item (pos, line)

Substitui o item de histórico especificado pela sua posição por `linha'. A posição conta a partir do zero. Isso chama @code{replace_history_entry()} na biblioteca subjacente.
@end deffn

@geindex add_history() (no módulo readline)
@anchor{library/readline readline add_history}@anchor{2526}
@deffn {Função} readline.add_history (line)

Acrescenta `line' ao buffer do histórico, como se fosse a última linha digitada. Isso chama @code{add_history()} na biblioteca subjacente.
@end deffn

@geindex set_auto_history() (no módulo readline)
@anchor{library/readline readline set_auto_history}@anchor{cea}
@deffn {Função} readline.set_auto_history (enabled)

Habilita ou desabilita chamadas automáticas para @code{add_history()} ao ler a entrada via readline. O argumento `enabled' deve ser um valor booleano que, quando verdadeiro, ativa o histórico automático e, quando falso, desativa o histórico automático.


Adicionado na versão 3.6.


O histórico automático está ativado por padrão e as alterações não persistem em várias sessões.
@end deffn

@node Ganchos de inicialização,Autocomplemento,Lista de histórico,readline — Interface para o GNU readline
@anchor{library/readline startup-hooks}@anchor{2527}
@subsubsection Ganchos de inicialização


@geindex set_startup_hook() (no módulo readline)
@anchor{library/readline readline set_startup_hook}@anchor{2528}
@deffn {Função} readline.set_startup_hook ([function])

Define ou remove a função invocada pelo retorno de chamada @code{rl_startup_hook} da biblioteca subjacente. Se `function' for especificada, ela será usada como a nova função de gancho; se omitido ou @code{None}, qualquer função já instalada será removida. O gancho é chamado sem argumentos antes de readline imprimir o primeiro prompt.
@end deffn

@geindex set_pre_input_hook() (no módulo readline)
@anchor{library/readline readline set_pre_input_hook}@anchor{2529}
@deffn {Função} readline.set_pre_input_hook ([function])

Define ou remove a função invocada pelo retorno de chamada @code{rl_pre_input_hook} da biblioteca subjacente. Se `function' for especificada, ela será usada como a nova função de gancho; se omitida ou @code{None}, qualquer função já instalada será removida. O gancho é chamado sem argumentos após a impressão do primeiro prompt e pouco antes de readline começar a ler os caracteres de entrada. Esta função só existe se o Python foi compilado para uma versão da biblioteca que a suporta.
@end deffn

@node Autocomplemento,Exemplo,Ganchos de inicialização,readline — Interface para o GNU readline
@anchor{library/readline completion}@anchor{252a}@anchor{library/readline readline-completion}@anchor{252b}
@subsubsection Autocomplemento


As funções a seguir estão relacionadas à implementação de uma função personalizada de autocomplemento ou `completion', em inglês, de palavras. Isso normalmente é operado pela tecla Tab e pode sugerir e completar automaticamente uma palavra que está sendo digitada. Por padrão, Readline está configurado para ser usado por @ref{bd,,rlcompleter} para completar identificadores Python para o interpretador interativo. Se o módulo @ref{ba,,readline} for usado com um autocomplemento personalizado, um conjunto diferente de delimitadores de palavras deverá ser definido.

@geindex set_completer() (no módulo readline)
@anchor{library/readline readline set_completer}@anchor{252c}
@deffn {Função} readline.set_completer ([function])

Define ou remove a função de autocomplemento. Se `function' for especificada, ela será usada como a nova função de autocomplemento; se omitido ou @code{None}, qualquer função de autocomplemento já instalada será removida. A função de autocomplemento é chamada como @code{function(text, state)}, para `state' em @code{0}, @code{1}, @code{2}, …, até retornar um valor que não seja string. Deve retornar o próximo autocomplemento possível começando com `text'.

A função de autocomplemento instalada é invocada pelo retorno de chamada `entry_func' passado para @code{rl_completion_matches()} na biblioteca subjacente. A string `text' vem do primeiro parâmetro para o retorno de chamada @code{rl_attempted_completion_function} da biblioteca subjacente.
@end deffn

@geindex get_completer() (no módulo readline)
@anchor{library/readline readline get_completer}@anchor{252d}
@deffn {Função} readline.get_completer ()

Obtém a função de autocomplemento ou @code{None} se nenhuma função de autocomplemento tiver sido definida.
@end deffn

@geindex get_completion_type() (no módulo readline)
@anchor{library/readline readline get_completion_type}@anchor{252e}
@deffn {Função} readline.get_completion_type ()

Obtém o tipo de autocomplemento que está sendo tentado. Isso retorna a variável @code{rl_completion_type} na biblioteca subjacente como um número inteiro.
@end deffn

@geindex get_begidx() (no módulo readline)
@geindex get_endidx() (no módulo readline)
@anchor{library/readline readline get_begidx}@anchor{1a30}
@deffn {Função} readline.get_begidx ()
@anchor{library/readline readline get_endidx}@anchor{1a31}
@deffnx {Função} readline.get_endidx ()

Obtém o índice inicial ou final do escopo de autocomplemento. Esses índices são os argumentos `start' e `end' passados para o retorno de chamada @code{rl_attempted_completion_function} da biblioteca subjacente. Os valores podem ser diferentes no mesmo cenário de edição de entrada com base na implementação de C readline subjacente. Por exemplo, sabe-se que o libedit se comporta de maneira diferente do libreadline.
@end deffn

@geindex set_completer_delims() (no módulo readline)
@geindex get_completer_delims() (no módulo readline)
@anchor{library/readline readline set_completer_delims}@anchor{17a6}
@deffn {Função} readline.set_completer_delims (string)
@anchor{library/readline readline get_completer_delims}@anchor{252f}
@deffnx {Função} readline.get_completer_delims ()

Define ou obtém os delimitadores de palavras para autocomplemento. Estes determinam o início da palavra a ser considerada para autocomplemento (o escopo de autocomplemento). Essas funções acessam a variável @code{rl_completer_word_break_characters} na biblioteca subjacente.
@end deffn

@geindex set_completion_display_matches_hook() (no módulo readline)
@anchor{library/readline readline set_completion_display_matches_hook}@anchor{2530}
@deffn {Função} readline.set_completion_display_matches_hook ([function])

Define ou remove a função de exibição de autocomplemento. Se `function' for especificada, ela será usada como a nova função de exibição de autocomplemento; se omitida ou @code{None}, qualquer função de exibição de autocomplemento já instalada será removida. Isso define ou limpa o retorno de chamada @code{rl_completion_display_matches_hook} na biblioteca subjacente. A função de exibição de autocomplemento é chamada como @code{function(substitution, [matches], longest_match_length)} uma vez que cada correspondência precisa ser exibida.
@end deffn

@node Exemplo,,Autocomplemento,readline — Interface para o GNU readline
@anchor{library/readline example}@anchor{2531}@anchor{library/readline readline-example}@anchor{2532}
@subsubsection Exemplo


O exemplo a seguir demonstra como usar as funções de leitura e gravação de histórico do módulo @ref{ba,,readline} para carregar e salvar automaticamente um arquivo de histórico chamado @code{.python_history} do diretório inicial do usuário. O código abaixo normalmente seria executado automaticamente durante sessões interativas do arquivo 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} do usuário.

@example
import atexit
import os
import readline

histfile = os.path.join(os.path.expanduser("~"), ".python_history")
try:
    readline.read_history_file(histfile)
    # comprimento padrão do histórico é -1 (infinito), que pode crescer sem controle
    readline.set_history_length(1000)
except FileNotFoundError:
    pass

atexit.register(readline.write_history_file, histfile)
@end example

Na verdade, este código é executado automaticamente quando o Python é executado no @ref{ffc,,modo interativo} (veja @ref{fff,,Configuração Readline}).

O exemplo a seguir atinge o mesmo objetivo, mas oferece suporte a sessões interativas simultâneas, anexando apenas o novo histórico.

@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

O exemplo a seguir estende a classe @ref{2533,,code.InteractiveConsole} para prover salvamento/restauração do histórico.

@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

@cartouche
@quotation Nota 
O novo @ref{16a,,REPL} introduzido na versão 3.13 não oferece suporte a readline. No entanto, readline ainda pode ser usado definindo a variável de ambiente 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL}.
@end quotation
@end cartouche

@node rlcompleter — Função de autocomplemento para GNU readline,,readline — Interface para o GNU readline,Serviços de Processamento de Texto
@anchor{library/rlcompleter doc}@anchor{2534}@anchor{library/rlcompleter module-rlcompleter}@anchor{bd}@anchor{library/rlcompleter rlcompleter-completion-function-for-gnu-readline}@anchor{2535}@anchor{library/rlcompleter translation-repo}@anchor{2536}
@subsection @code{rlcompleter} — Função de autocomplemento para GNU readline


@geindex module; rlcompleter

`Código-fonte:' Lib/rlcompleter.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/rlcompleter.py}


__________________________________________________________________


O módulo @code{rlcompleter} define uma função de autocompletamento adequada para ser passada para @ref{252c,,set_completer()} no módulo @ref{ba,,readline}.

Quando este módulo é importado em uma plataforma Unix com o módulo @ref{ba,,readline} disponível, uma instância da classe @ref{1ab8,,Completer} é criada automaticamente e seu método @ref{2537,,complete()} é definido como o @ref{252b,,autocompletamento do readline}. O método fornece o autocompletamento de @ref{2021,,identificadores e palavras-chaves} válidas do Python.

Exemplo:

@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

O módulo @code{rlcompleter} é projetado para uso com o @ref{ffc,,modo interativo} do Python. A menos que Python seja executado com a opção @ref{11e7,,-S}, o módulo é automaticamente importado e configurado (veja @ref{fff,,Configuração Readline}).

Em plataformas sem @ref{ba,,readline}, a classe @ref{1ab8,,Completer} definida por este módulo ainda pode ser usada para propósitos personalizados.

@geindex Completer (classe em rlcompleter)
@anchor{library/rlcompleter completer-objects}@anchor{2538}@anchor{library/rlcompleter rlcompleter Completer}@anchor{1ab8}
@deffn {Classe} rlcompleter.Completer

Os objetos Completer têm o seguinte método:

@geindex complete() (método rlcompleter.Completer)
@anchor{library/rlcompleter rlcompleter Completer complete}@anchor{2537}
@deffn {Método} complete (text, state)

Retorna o próximo completamento possível para `text'.

Quando chamado pelo módulo @ref{ba,,readline}, este método é chamado sucessivamente com @code{state == 0, 1, 2, ...} até que o método retorne @code{None}.

Se chamado para `text' que não inclui um caractere de ponto (@code{'.'}), ele será completado a partir dos nomes atualmente definidos em @ref{1,,__main__}, @ref{12,,builtins} e palavras reservadas (conforme definido pelo módulo @ref{84,,keyword}).

Se chamado por um nome pontilhado, vai tentar avaliar qualquer coisa sem efeitos colaterais óbvios (as funções não serão avaliadas, mas pode levantar chamadas para @ref{4d3,,__getattr__()}) até a última parte e encontrar correspondências para o resto por meio da função @ref{632,,dir()}. Qualquer exceção levantada durante a avaliação da expressão é capturada, silenciada e @ref{675,,None} é retornado.
@end deffn
@end deffn

@node Serviços de Dados Binários,Tipos de Dados,Serviços de Processamento de Texto,A Biblioteca Padrão do Python
@anchor{library/binary doc}@anchor{2539}@anchor{library/binary binary-data-services}@anchor{253a}@anchor{library/binary binaryservices}@anchor{2454}@anchor{library/binary translation-repo}@anchor{253b}
@section Serviços de Dados Binários


Os módulos descritos neste capítulo fornecem algumas operações de serviços básicos para manipulação de dados binários. Outras operações sobre dados binários, especificamente em relação a formatos de arquivo e protocolos de rede, são descritas nas seções relevantes.

Algumas bibliotecas descritas em @ref{2354,,Serviços de Processamento de Texto} também funcionam com formatos binários compatíveis com ASCII (por exemplo @ref{b9,,re}) ou com todos os dados binários (por exemplo @ref{37,,difflib}).

Além disso, consulte a documentação dos tipos de dados binários embutidos do Python em @ref{22f9,,Tipos de sequência binária — bytes@comma{} bytearray@comma{} memoryview}.

@menu
* struct — Interpreta bytes como dados binários empacotados:: 
* codecs — Codec registry and base classes:: 

@end menu

@node struct — Interpreta bytes como dados binários empacotados,codecs — Codec registry and base classes,,Serviços de Dados Binários
@anchor{library/struct doc}@anchor{253c}@anchor{library/struct struct-interpret-bytes-as-packed-binary-data}@anchor{253d}
@subsection @code{struct} — Interpreta bytes como dados binários empacotados


@c from struct import *

@geindex module; struct
@anchor{library/struct module-struct}@anchor{d5}
`Código-fonte:' Lib/struct.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/struct.py}

@geindex C;structures
@geindex packing;binário;dados


__________________________________________________________________


Este módulo converte entre valores Python e structs C representados como objetos @ref{1c2,,bytes} do Python. @ref{253e,,Strings de formato} compactas descrevem as conversões pretendidas de/para valores Python. As funções e objetos do módulo podem ser usados para duas aplicações amplamente distintas, troca de dados com fontes externas (arquivos ou conexões de rede) ou transferência de dados entre a aplicação Python e a camada C.

@cartouche
@quotation Nota 
Quando nenhum caractere de prefixo é fornecido, o modo nativo é o padrão. Ele empacota ou descompacta dados com base na plataforma e no compilador nos quais o interpretador Python foi construído. O resultado do empacotamento de uma dada estrutura C inclui bytes de preenchimento que mantêm o alinhamento adequado para os tipos C envolvidos; similarmente, o alinhamento é levado em conta ao desempacotar. Em contraste, ao comunicar dados entre fontes externas, o programador é responsável por definir a ordenação de bytes e o preenchimento entre os elementos. Veja @ref{253f,,Byte Order@comma{} Size@comma{} and Alignment} para detalhes.
@end quotation
@end cartouche

Várias funções @ref{d5,,struct} (e métodos de @ref{15a0,,Struct}) recebem um argumento `buffer'. Isso se refere a objetos que implementam @ref{2e8,,Protocolo de buffer} e fornecem um buffer legível ou de leitura-gravação. Os tipos mais comuns usados para esse propósito são @ref{1c2,,bytes} e @ref{2ea,,bytearray}, mas muitos outros tipos que podem ser vistos como uma matriz de bytes implementam o protocolo de buffer, para que possam ser lidos/preenchidos sem cópia adicional de um objeto @ref{1c2,,bytes}.

@menu
* Funções e exceções:: 
* Format Strings:: 
* Applications:: 
* Classes: Classes<3>. 

@end menu

@node Funções e exceções,Format Strings,,struct — Interpreta bytes como dados binários empacotados
@anchor{library/struct functions-and-exceptions}@anchor{2540}
@subsubsection Funções e exceções


O módulo define as seguintes exceções e funções:

@geindex error
@anchor{library/struct struct error}@anchor{1368}
@deffn {Exceção} struct.error

Exceção levantada em várias ocasiões; argumento é uma string que descreve o que está errado.
@end deffn

@geindex pack() (no módulo struct)
@anchor{library/struct struct pack}@anchor{12b8}
@deffn {Função} struct.pack (format, v1, v2, ...)

Return a bytes object containing the values `v1', `v2', … packed according
to the format string `format'.  The arguments must match the values required by
the format exactly.
@end deffn

@geindex pack_into() (no módulo struct)
@anchor{library/struct struct pack_into}@anchor{2541}
@deffn {Função} struct.pack_into (format, buffer, offset, v1, v2, ...)

Pack the values `v1', `v2', … according to the format string `format' and
write the packed bytes into the writable buffer `buffer' starting at
position `offset'.  Note that `offset' is a required argument.
@end deffn

@geindex unpack() (no módulo struct)
@anchor{library/struct struct unpack}@anchor{18db}
@deffn {Função} struct.unpack (format, buffer)

Unpack from the buffer `buffer' (presumably packed by @code{pack(format, ...)})
according to the format string `format'.  The result is a tuple even if it
contains exactly one item.  The buffer’s size in bytes must match the
size required by the format, as reflected by @ref{1b3b,,calcsize()}.
@end deffn

@geindex unpack_from() (no módulo struct)
@anchor{library/struct struct unpack_from}@anchor{2542}
@deffn {Função} struct.unpack_from (format, /, buffer, offset=0)

Unpack from `buffer' starting at position `offset', according to the format
string `format'.  The result is a tuple even if it contains exactly one
item.  The buffer’s size in bytes, starting at position `offset', must be at
least the size required by the format, as reflected by @ref{1b3b,,calcsize()}.
@end deffn

@geindex iter_unpack() (no módulo struct)
@anchor{library/struct struct iter_unpack}@anchor{ff3}
@deffn {Função} struct.iter_unpack (format, buffer)

Iteratively unpack from the buffer `buffer' according to the format
string `format'.  This function returns an iterator which will read
equally sized chunks from the buffer until all its contents have been
consumed.  The buffer’s size in bytes must be a multiple of the size
required by the format, as reflected by @ref{1b3b,,calcsize()}.

Each iteration yields a tuple as specified by the format string.


Adicionado na versão 3.4.

@end deffn

@geindex calcsize() (no módulo struct)
@anchor{library/struct struct calcsize}@anchor{1b3b}
@deffn {Função} struct.calcsize (format)

Return the size of the struct (and hence of the bytes object produced by
@code{pack(format, ...)}) corresponding to the format string `format'.
@end deffn

@node Format Strings,Applications,Funções e exceções,struct — Interpreta bytes como dados binários empacotados
@anchor{library/struct format-strings}@anchor{2543}@anchor{library/struct struct-format-strings}@anchor{253e}
@subsubsection Format Strings


Format strings describe the data layout when
packing and unpacking data.  They are built up from @ref{2544,,format characters},
which specify the type of data being packed/unpacked.  In addition,
special characters control the @ref{253f,,byte order@comma{} size and alignment}.
Each format string consists of an optional prefix character which
describes the overall properties of the data and one or more format
characters which describe the actual data values and padding.

@menu
* Byte Order@comma{} Size@comma{} and Alignment: Byte Order Size and Alignment. 
* Caracteres Formatados:: 
* Exemplos: Exemplos<2>. 

@end menu

@node Byte Order Size and Alignment,Caracteres Formatados,,Format Strings
@anchor{library/struct byte-order-size-and-alignment}@anchor{2545}@anchor{library/struct struct-alignment}@anchor{253f}
@subsubsection Byte Order, Size, and Alignment


By default, C types are represented in the machine’s native format and byte
order, and properly aligned by skipping pad bytes if necessary (according to the
rules used by the C compiler).
This behavior is chosen so
that the bytes of a packed struct correspond exactly to the memory layout
of the corresponding C struct.
Whether to use native byte ordering
and padding or standard formats depends on the application.

@geindex @@ (arroba);in struct format strings
@geindex = (igual);in struct format strings
@geindex < (menor que);in struct format strings
@geindex > (maior);in struct format strings
@geindex ! (exclamação);in struct format strings

Alternatively, the first character of the format string can be used to indicate
the byte order, size and alignment of the packed data, according to the
following table:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Caractere

@tab

Ordem de bytes

@tab

Tamanho

@tab

Alinhamento

@item

@code{@@}

@tab

nativo

@tab

nativo

@tab

nativo

@item

@code{=}

@tab

nativo

@tab

padrão

@tab

nenhum

@item

@code{<}

@tab

little-endian

@tab

padrão

@tab

nenhum

@item

@code{>}

@tab

big-endian

@tab

padrão

@tab

nenhum

@item

@code{!}

@tab

rede (= big-endian)

@tab

padrão

@tab

nenhum

@end multitable


Se o primeiro caractere não for um destes, @code{'@@'} é presumido.

@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

Native byte order is big-endian or little-endian, depending on the
host system. For example, Intel x86, AMD64 (x86-64), and Apple M1 are
little-endian; IBM z and many legacy architectures are big-endian.
Use @ref{2330,,sys.byteorder} to check the endianness of your system.

Native size and alignment are determined using the C compiler’s
@code{sizeof} expression.  This is always combined with native byte order.

Standard size depends only on the format character;  see the table in
the @ref{2544,,Caracteres Formatados} section.

Note the difference between @code{'@@'} and @code{'='}: both use native byte order, but
the size and alignment of the latter is standardized.

The form @code{'!'} represents the network byte order which is always big-endian
as defined in IETF RFC 1700@footnote{https://datatracker.ietf.org/doc/html/rfc1700}.

There is no way to indicate non-native byte order (force byte-swapping); use the
appropriate choice of @code{'<'} or @code{'>'}.

Notas:


@enumerate 

@item 
Padding is only automatically added between successive structure members.
No padding is added at the beginning or the end of the encoded struct.

@item 
No padding is added when using non-native size and alignment, e.g.
with ‘<’, ‘>’, ‘=’, and ‘!’.

@item 
To align the end of a structure to the alignment requirement of a
particular type, end the format with the code for that type with a repeat
count of zero.  See @ref{2546,,Exemplos}.
@end enumerate

@node Caracteres Formatados,Exemplos<2>,Byte Order Size and Alignment,Format Strings
@anchor{library/struct format-characters}@anchor{2544}@anchor{library/struct id1}@anchor{2547}
@subsubsection Caracteres Formatados


Format characters have the following meaning; the conversion between C and
Python values should be obvious given their types.  The ‘Standard size’ column
refers to the size of the packed value in bytes when using standard size; that
is, when the format string starts with one of @code{'<'}, @code{'>'}, @code{'!'} or
@code{'='}.  When using native size, the size of the packed value is
platform-dependent.


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Formatação

@tab

Tipo em C

@tab

Tipo em Python

@tab

Standard size

@tab

Notas

@item

@code{x}

@tab

pad byte

@tab

no value

@tab

@tab

(7)

@item

@code{c}

@tab

char

@tab

bytes of length 1

@tab

1

@tab

@item

@code{b}

@tab

signed char

@tab

inteiro

@tab

1

@tab

(1), (2)

@item

@code{B}

@tab

unsigned char

@tab

inteiro

@tab

1

@tab

(2)

@item

@code{?}

@tab

_Bool

@tab

bool

@tab

1

@tab

(1)

@item

@code{h}

@tab

short

@tab

inteiro

@tab

2

@tab

(2)

@item

@code{H}

@tab

unsigned short

@tab

inteiro

@tab

2

@tab

(2)

@item

@code{i}

@tab

int

@tab

inteiro

@tab

4

@tab

(2)

@item

@code{I}

@tab

unsigned int

@tab

inteiro

@tab

4

@tab

(2)

@item

@code{l}

@tab

long

@tab

inteiro

@tab

4

@tab

(2)

@item

@code{L}

@tab

unsigned long

@tab

inteiro

@tab

4

@tab

(2)

@item

@code{q}

@tab

long long

@tab

inteiro

@tab

8

@tab

(2)

@item

@code{Q}

@tab

unsigned long long

@tab

inteiro

@tab

8

@tab

(2)

@item

@code{n}

@tab

@code{ssize_t}

@tab

inteiro

@tab

@tab

(3)

@item

@code{N}

@tab

@code{size_t}

@tab

inteiro

@tab

@tab

(3)

@item

@code{e}

@tab

(6)

@tab

ponto flutuante

@tab

2

@tab

(4)

@item

@code{f}

@tab

float

@tab

ponto flutuante

@tab

4

@tab

(4)

@item

@code{d}

@tab

double

@tab

ponto flutuante

@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

inteiro

@tab

@tab

(5)

@end multitable



Alterado na versão 3.3: Added support for the @code{'n'} and @code{'N'} formats.



Alterado na versão 3.6: Added support for the @code{'e'} format.


Notas:


@enumerate 

@item 
@geindex ? (interrogação);in struct format strings

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 
When attempting to pack a non-integer using any of the integer conversion
codes, if the non-integer has a @ref{71d,,__index__()} method then that method is
called to convert the argument to an integer before packing.


Alterado na versão 3.2: Added use of the @ref{71d,,__index__()} method for non-integers.


@item 
The @code{'n'} and @code{'N'} conversion codes are only available for the native
size (selected as the default or with the @code{'@@'} byte order character).
For the standard size, you can use whichever of the other integer formats
fits your application.

@item 
For the @code{'f'}, @code{'d'} and @code{'e'} conversion codes, the packed
representation uses the IEEE 754 binary32, binary64 or binary16 format (for
@code{'f'}, @code{'d'} or @code{'e'} respectively), regardless of the floating-point
format used by the platform.

@item 
The @code{'P'} format character is only available for the native byte ordering
(selected as the default or with the @code{'@@'} byte order character). The byte
order character @code{'='} chooses to use little- or big-endian ordering based
on the host system. The struct module does not interpret this as native
ordering, so the @code{'P'} format is not available.

@item 
The IEEE 754 binary16 “half precision” type was introduced in the 2008
revision of the IEEE 754 standard@footnote{https://en.wikipedia.org/wiki/IEEE_754-2008_revision}. It has a sign
bit, a 5-bit exponent and 11-bit precision (with 10 bits explicitly stored),
and can represent numbers between approximately @code{6.1e-05} and @code{6.5e+04}
at full precision. This type is not widely supported by C compilers: on a
typical machine, an unsigned short can be used for storage, but not for math
operations. See the Wikipedia page on the half-precision floating-point format@footnote{https://en.wikipedia.org/wiki/Half-precision_floating-point_format} for more information.

@item 
When packing, @code{'x'} inserts one NUL byte.

@item 
The @code{'p'} format character encodes a “Pascal string”, meaning a short
variable-length string stored in a `fixed number of bytes', given by the count.
The first byte stored is the length of the string, or 255, whichever is
smaller.  The bytes of the string follow.  If the string passed in to
@ref{12b8,,pack()} is too long (longer than the count minus 1), only the leading
@code{count-1} bytes of the string are stored.  If the string is shorter than
@code{count-1}, it is padded with null bytes so that exactly count bytes in all
are used.  Note that for @ref{18db,,unpack()}, the @code{'p'} format character consumes
@code{count} bytes, but that the string returned can never contain more than 255
bytes.

@item 
For the @code{'s'} format character, the count is interpreted as the length of the
bytes, not a repeat count like for the other format characters; for example,
@code{'10s'} means a single 10-byte string mapping to or from a single
Python byte string, while @code{'10c'} means 10
separate one byte character elements (e.g., @code{cccccccccc}) mapping
to or from ten different Python byte objects. (See @ref{2546,,Exemplos}
for a concrete demonstration of the difference.)
If a count is not given, it defaults to 1.  For packing, the string is
truncated or padded with null bytes as appropriate to make it fit. For
unpacking, the resulting bytes object always has exactly the specified number
of bytes.  As a special case, @code{'0s'} means a single, empty string (while
@code{'0c'} means 0 characters).
@end enumerate

A format character may be preceded by an integral repeat count.  For example,
the format string @code{'4h'} means exactly the same as @code{'hhhh'}.

Whitespace characters between formats are ignored; a count and its format must
not contain whitespace though.

When packing a value @code{x} using one of the integer formats (@code{'b'},
@code{'B'}, @code{'h'}, @code{'H'}, @code{'i'}, @code{'I'}, @code{'l'}, @code{'L'},
@code{'q'}, @code{'Q'}), if @code{x} is outside the valid range for that format
then @ref{1368,,struct.error} is raised.


Alterado na versão 3.1: Previously, some of the integer formats wrapped out-of-range values and
raised @ref{1a5,,DeprecationWarning} instead of @ref{1368,,struct.error}.


@geindex ? (interrogação);in struct format strings

For the @code{'?'} format character, the return value is either @ref{c27,,True} or
@ref{b49,,False}. When packing, the truth value of the argument object is used.
Either 0 or 1 in the native or standard bool representation will be packed, and
any non-zero value will be @code{True} when unpacking.

@node Exemplos<2>,,Caracteres Formatados,Format Strings
@anchor{library/struct examples}@anchor{2548}@anchor{library/struct struct-examples}@anchor{2546}
@subsubsection Exemplos


@cartouche
@quotation Nota 
Native byte order examples (designated by the @code{'@@'} format prefix or
lack of any prefix character) may not match what the reader’s
machine produces as
that depends on the platform and compiler.
@end quotation
@end cartouche

Pack and unpack integers of three different sizes, using big endian
ordering:

@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

Attempt to pack an integer which is too large for the defined field:

@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

Demonstrate the difference between @code{'s'} and @code{'c'} format
characters:

@example
>>> pack("@@ccc", b'1', b'2', b'3')
b'123'
>>> pack("@@3s", b'123')
b'123'
@end example

Unpacked fields can be named by assigning them to variables or by wrapping
the result in a named tuple:

@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

The ordering of format characters may have an impact on size in native
mode since padding is implicit. In standard mode, the user is
responsible for inserting any desired padding.
Note in
the first @code{pack} call below that three NUL bytes were added after the
packed @code{'#'} to align the following integer on a four-byte boundary.
In this example, the output was produced on a little endian machine:

@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

The following format @code{'llh0l'} results in two pad bytes being added
at the end, assuming the platform’s longs are aligned on 4-byte boundaries:

@example
>>> pack('@@llh0l', 1, 2, 3)
b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'
@end example


@subsubheading Ver também



@table @asis

@item Module @ref{7,,array}

Packed binary storage of homogeneous data.

@item Módulo @ref{82,,json}

JSON encoder and decoder.

@item Módulo @ref{a6,,pickle}

Python object serialization.
@end table


@node Applications,Classes<3>,Format Strings,struct — Interpreta bytes como dados binários empacotados
@anchor{library/struct applications}@anchor{2549}@anchor{library/struct id2}@anchor{254a}
@subsubsection Applications


Two main applications for the @ref{d5,,struct} module exist, data
interchange between Python and C code within an application or another
application compiled using the same compiler (@ref{254b,,native formats}), and
data interchange between applications using agreed upon data layout
(@ref{254c,,standard formats}).  Generally speaking, the format strings
constructed for these two domains are distinct.

@menu
* Native Formats:: 
* Standard Formats:: 

@end menu

@node Native Formats,Standard Formats,,Applications
@anchor{library/struct native-formats}@anchor{254d}@anchor{library/struct struct-native-formats}@anchor{254b}
@subsubsection Native Formats


When constructing format strings which mimic native layouts, the
compiler and machine architecture determine byte ordering and padding.
In such cases, the @code{@@} format character should be used to specify
native byte ordering and data sizes.  Internal pad bytes are normally inserted
automatically.  It is possible that a zero-repeat format code will be
needed at the end of a format string to round up to the correct
byte boundary for proper alignment of consecutive chunks of data.

Consider these two simple examples (on a 64-bit, little-endian
machine):

@example
>>> calcsize('@@lhl')
24
>>> calcsize('@@llh')
18
@end example

Data is not padded to an 8-byte boundary at the end of the second
format string without the use of extra padding.  A zero-repeat format
code solves that problem:

@example
>>> calcsize('@@llh0l')
24
@end example

The @code{'x'} format code can be used to specify the repeat, but for
native formats it is better to use a zero-repeat format like @code{'0l'}.

By default, native byte ordering and alignment is used, but it is
better to be explicit and use the @code{'@@'} prefix character.

@node Standard Formats,,Native Formats,Applications
@anchor{library/struct standard-formats}@anchor{254e}@anchor{library/struct struct-standard-formats}@anchor{254c}
@subsubsection Standard Formats


When exchanging data beyond your process such as networking or storage,
be precise.  Specify the exact byte order, size, and alignment.  Do
not assume they match the native order of a particular machine.
For example, network byte order is big-endian, while many popular CPUs
are little-endian.  By defining this explicitly, the user need not
care about the specifics of the platform their code is running on.
The first character should typically be @code{<} or @code{>}
(or @code{!}).  Padding is the responsibility of the programmer.  The
zero-repeat format character won’t work.  Instead, the user must
explicitly add @code{'x'} pad bytes where needed.  Revisiting the
examples from the previous section, we have:

@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

The above results (executed on a 64-bit machine) aren’t guaranteed to
match when executed on different machines.  For example, the examples
below were executed on a 32-bit machine:

@example
>>> calcsize('<qqh6x')
24
>>> calcsize('@@llh0l')
12
>>> pack('@@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
False
@end example

@node Classes<3>,,Applications,struct — Interpreta bytes como dados binários empacotados
@anchor{library/struct classes}@anchor{254f}@anchor{library/struct struct-objects}@anchor{2550}
@subsubsection Classes


The @ref{d5,,struct} module also defines the following type:

@geindex Struct (classe em struct)
@anchor{library/struct struct Struct}@anchor{15a0}
@deffn {Classe} struct.Struct (format)

Return a new Struct object which writes and reads binary data according to
the format string `format'.  Creating a @code{Struct} object once and calling its
methods is more efficient than calling module-level functions with the
same format since the format string is only compiled once.

@cartouche
@quotation Nota 
The compiled versions of the most recent format strings passed to
the module-level functions are cached, so programs that use only a few
format strings needn’t worry about reusing a single @ref{15a0,,Struct}
instance.
@end quotation
@end cartouche

Compiled Struct objects support the following methods and attributes:

@geindex pack() (método struct.Struct)
@anchor{library/struct struct Struct pack}@anchor{2551}
@deffn {Método} pack (v1, v2, ...)

Identical to the @ref{12b8,,pack()} function, using the compiled format.
(@code{len(result)} will equal @ref{2552,,size}.)
@end deffn

@geindex pack_into() (método struct.Struct)
@anchor{library/struct struct Struct pack_into}@anchor{2553}
@deffn {Método} pack_into (buffer, offset, v1, v2, ...)

Identical to the @ref{2541,,pack_into()} function, using the compiled format.
@end deffn

@geindex unpack() (método struct.Struct)
@anchor{library/struct struct Struct unpack}@anchor{2554}
@deffn {Método} unpack (buffer)

Identical to the @ref{18db,,unpack()} function, using the compiled format.
The buffer’s size in bytes must equal @ref{2552,,size}.
@end deffn

@geindex unpack_from() (método struct.Struct)
@anchor{library/struct struct Struct unpack_from}@anchor{2555}
@deffn {Método} unpack_from (buffer, offset=0)

Identical to the @ref{2542,,unpack_from()} function, using the compiled format.
The buffer’s size in bytes, starting at position `offset', must be at least
@ref{2552,,size}.
@end deffn

@geindex iter_unpack() (método struct.Struct)
@anchor{library/struct struct Struct iter_unpack}@anchor{ff4}
@deffn {Método} iter_unpack (buffer)

Identical to the @ref{ff3,,iter_unpack()} function, using the compiled format.
The buffer’s size in bytes must be a multiple of @ref{2552,,size}.


Adicionado na versão 3.4.

@end deffn

@geindex format (atributo struct.Struct)
@anchor{library/struct struct Struct format}@anchor{c20}
@deffn {Atributo} format

The format string used to construct this Struct object.


Alterado na versão 3.7: The format string type is now @ref{44c,,str} instead of @ref{1c2,,bytes}.

@end deffn

@geindex size (atributo struct.Struct)
@anchor{library/struct struct Struct size}@anchor{2552}
@deffn {Atributo} size

The calculated size of the struct (and hence of the bytes object produced
by the @ref{12b8,,pack()} method) corresponding to @ref{61f,,format}.
@end deffn


Alterado na versão 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 — Interpreta bytes como dados binários empacotados,Serviços de Dados Binários
@anchor{library/codecs doc}@anchor{2556}@anchor{library/codecs codecs-codec-registry-and-base-classes}@anchor{2557}@anchor{library/codecs module-codecs}@anchor{1b}@anchor{library/codecs translation-repo}@anchor{2558}
@subsection @code{codecs} — Codec registry and base classes


@geindex module; codecs

`Código-fonte:' Lib/codecs.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/codecs.py}

@geindex Unicode
@geindex Codecs
@geindex Codecs;encode
@geindex Codecs;decode
@geindex streams
@geindex stackable;streams


__________________________________________________________________


This module defines base classes for standard Python codecs (encoders and
decoders) and provides access to the internal Python codec registry, which
manages the codec and error handling lookup process. Most standard codecs
are @ref{2310,,text encodings}, which encode text to bytes (and
decode bytes to text), but there are also codecs provided that encode text to
text, and bytes to bytes. Custom codecs may encode and decode between arbitrary
types, but some module features are restricted to be used specifically with
@ref{2310,,text encodings} or with codecs that encode to
@ref{1c2,,bytes}.

The module defines the following functions for encoding and decoding with
any codec:

@geindex encode() (no módulo codecs)
@anchor{library/codecs codecs encode}@anchor{f33}
@deffn {Função} codecs.encode (obj, encoding='utf-8', errors='strict')

Encodes `obj' using the codec registered for `encoding'.

`Errors' may be given to set the desired error handling scheme. The
default error handler is @code{'strict'} meaning that encoding errors raise
@ref{202,,ValueError} (or a more codec specific subclass, such as
@ref{677,,UnicodeEncodeError}). Refer to @ref{2559,,Codec Base Classes} for more
information on codec error handling.
@end deffn

@geindex decode() (no módulo codecs)
@anchor{library/codecs codecs decode}@anchor{f34}
@deffn {Função} codecs.decode (obj, encoding='utf-8', errors='strict')

Decodes `obj' using the codec registered for `encoding'.

`Errors' may be given to set the desired error handling scheme. The
default error handler is @code{'strict'} meaning that decoding errors raise
@ref{202,,ValueError} (or a more codec specific subclass, such as
@ref{a1d,,UnicodeDecodeError}). Refer to @ref{2559,,Codec Base Classes} for more
information on codec error handling.
@end deffn

@geindex charmap_build() (no módulo codecs)
@anchor{library/codecs codecs charmap_build}@anchor{255a}
@deffn {Função} codecs.charmap_build (string)

Return a mapping suitable for encoding with a custom single-byte encoding.
Given a @ref{44c,,str} `string' of up to 256 characters representing a
decoding table, returns either a compact internal mapping object
@code{EncodingMap} or a @ref{256,,dictionary} mapping character ordinals
to byte values. Raises a @ref{2c3,,TypeError} on invalid input.
@end deffn

The full details for each codec can also be looked up directly:

@geindex lookup() (no módulo codecs)
@anchor{library/codecs codecs lookup}@anchor{96a}
@deffn {Função} codecs.lookup (encoding)

Looks up the codec info in the Python codec registry and returns a
@ref{17ee,,CodecInfo} object as defined below.

Encodings are first looked up in the registry’s cache. If not found, the list of
registered search functions is scanned. If no @ref{17ee,,CodecInfo} object is
found, a @ref{2367,,LookupError} is raised. Otherwise, the @ref{17ee,,CodecInfo} object
is stored in the cache and returned to the caller.
@end deffn

@geindex CodecInfo (classe em codecs)
@anchor{library/codecs codecs CodecInfo}@anchor{17ee}
@deffn {Classe} codecs.CodecInfo (encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)

Codec details when looking up the codec registry. The constructor
arguments are stored in attributes of the same name:

@geindex name (atributo codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo name}@anchor{255b}
@deffn {Atributo} name

The name of the encoding.
@end deffn

@geindex encode (atributo codecs.CodecInfo)
@geindex decode (atributo codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo encode}@anchor{255c}
@deffn {Atributo} encode
@anchor{library/codecs codecs CodecInfo decode}@anchor{255d}
@deffnx {Atributo} decode

The stateless encoding and decoding functions. These must be
functions or methods which have the same interface as
the @ref{255e,,encode()} and @ref{255f,,decode()} methods of Codec
instances (see @ref{2560,,Codec Interface}).
The functions or methods are expected to work in a stateless mode.
@end deffn

@geindex incrementalencoder (atributo codecs.CodecInfo)
@geindex incrementaldecoder (atributo codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo incrementalencoder}@anchor{2561}
@deffn {Atributo} incrementalencoder
@anchor{library/codecs codecs CodecInfo incrementaldecoder}@anchor{2562}
@deffnx {Atributo} incrementaldecoder

Incremental encoder and decoder classes or factory functions.
These have to provide the interface defined by the base classes
@ref{2563,,IncrementalEncoder} and @ref{2564,,IncrementalDecoder},
respectively. Incremental codecs can maintain state.
@end deffn

@geindex streamwriter (atributo codecs.CodecInfo)
@geindex streamreader (atributo codecs.CodecInfo)
@anchor{library/codecs codecs CodecInfo streamwriter}@anchor{2565}
@deffn {Atributo} streamwriter
@anchor{library/codecs codecs CodecInfo streamreader}@anchor{2566}
@deffnx {Atributo} streamreader

Stream writer and reader classes or factory functions. These have to
provide the interface defined by the base classes
@ref{2567,,StreamWriter} and @ref{2568,,StreamReader}, respectively.
Stream codecs can maintain state.
@end deffn
@end deffn

To simplify access to the various codec components, the module provides
these additional functions which use @ref{96a,,lookup()} for the codec lookup:

@geindex getencoder() (no módulo codecs)
@anchor{library/codecs codecs getencoder}@anchor{2569}
@deffn {Função} codecs.getencoder (encoding)

Look up the codec for the given encoding and return its encoder function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found.
@end deffn

@geindex getdecoder() (no módulo codecs)
@anchor{library/codecs codecs getdecoder}@anchor{256a}
@deffn {Função} codecs.getdecoder (encoding)

Look up the codec for the given encoding and return its decoder function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found.
@end deffn

@geindex getincrementalencoder() (no módulo codecs)
@anchor{library/codecs codecs getincrementalencoder}@anchor{256b}
@deffn {Função} codecs.getincrementalencoder (encoding)

Look up the codec for the given encoding and return its incremental encoder
class or factory function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found or the codec
doesn’t support an incremental encoder.
@end deffn

@geindex getincrementaldecoder() (no módulo codecs)
@anchor{library/codecs codecs getincrementaldecoder}@anchor{256c}
@deffn {Função} codecs.getincrementaldecoder (encoding)

Look up the codec for the given encoding and return its incremental decoder
class or factory function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found or the codec
doesn’t support an incremental decoder.
@end deffn

@geindex getreader() (no módulo codecs)
@anchor{library/codecs codecs getreader}@anchor{256d}
@deffn {Função} codecs.getreader (encoding)

Look up the codec for the given encoding and return its @ref{2568,,StreamReader}
class or factory function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found.
@end deffn

@geindex getwriter() (no módulo codecs)
@anchor{library/codecs codecs getwriter}@anchor{256e}
@deffn {Função} codecs.getwriter (encoding)

Look up the codec for the given encoding and return its @ref{2567,,StreamWriter}
class or factory function.

Raises a @ref{2367,,LookupError} in case the encoding cannot be found.
@end deffn

Custom codecs are made available by registering a suitable codec search
function:

@geindex register() (no módulo codecs)
@anchor{library/codecs codecs register}@anchor{256f}
@deffn {Função} codecs.register (search_function)

Register a codec search function. Search functions are expected to take one
argument, being the encoding name in all lower case letters with hyphens
and spaces converted to underscores, and return a @ref{17ee,,CodecInfo} object.
In case a search function cannot find a given encoding, it should return
@code{None}.


Alterado na versão 3.9: Hyphens and spaces are converted to underscore.

@end deffn

@geindex unregister() (no módulo codecs)
@anchor{library/codecs codecs unregister}@anchor{7ea}
@deffn {Função} codecs.unregister (search_function)

Unregister a codec search function and clear the registry’s cache.
If the search function is not registered, do nothing.


Adicionado na versão 3.10.

@end deffn

While the builtin @ref{51c,,open()} and the associated @ref{7f,,io} module are the
recommended approach for working with encoded text files, this module
provides additional utility functions and classes that allow the use of a
wider range of codecs when working with binary files:

@geindex open() (no módulo codecs)
@anchor{library/codecs codecs open}@anchor{740}
@deffn {Função} codecs.open (filename, mode='r', encoding=None, errors='strict', buffering=-1)

Open an encoded file using the given `mode' and return an instance of
@ref{2570,,StreamReaderWriter}, providing transparent encoding/decoding.
The default file mode is @code{'r'}, meaning to open the file in read mode.

@cartouche
@quotation Nota 
If `encoding' is not @code{None}, then the
underlying encoded files are always opened in binary mode.
No automatic conversion of @code{'\n'} is done on reading and writing.
The `mode' argument may be any binary mode acceptable to the built-in
@ref{51c,,open()} function; the @code{'b'} is automatically added.
@end quotation
@end cartouche

`encoding' specifies the encoding which is to be used for the file.
Any encoding that encodes to and decodes from bytes is allowed, and
the data types supported by the file methods depend on the codec used.

`errors' may be given to define the error handling. It defaults to @code{'strict'}
which causes a @ref{202,,ValueError} to be raised in case an encoding error occurs.

`buffering' has the same meaning as for the built-in @ref{51c,,open()} function.
It defaults to -1 which means that the default buffer size will be used.


Alterado na versão 3.11: O modo @code{'U'} foi removido.

@end deffn

@geindex EncodedFile() (no módulo codecs)
@anchor{library/codecs codecs EncodedFile}@anchor{2571}
@deffn {Função} codecs.EncodedFile (file, data_encoding, file_encoding=None, errors='strict')

Return a @ref{1b68,,StreamRecoder} instance, a wrapped version of `file'
which provides transparent transcoding. The original file is closed
when the wrapped version is closed.

Data written to the wrapped file is decoded according to the given
`data_encoding' and then written to the original file as bytes using
`file_encoding'. Bytes read from the original file are decoded
according to `file_encoding', and the result is encoded
using `data_encoding'.

If `file_encoding' is not given, it defaults to `data_encoding'.

`errors' may be given to define the error handling. It defaults to
@code{'strict'}, which causes @ref{202,,ValueError} to be raised in case an encoding
error occurs.
@end deffn

@geindex iterencode() (no módulo codecs)
@anchor{library/codecs codecs iterencode}@anchor{2572}
@deffn {Função} codecs.iterencode (iterator, encoding, errors='strict', **kwargs)

Uses an incremental encoder to iteratively encode the input provided by
`iterator'. `iterator' must yield @ref{44c,,str} objects.
This function is a @ref{109a,,generator}. The `errors' argument (as well as any
other keyword argument) is passed through to the incremental encoder.

This function requires that the codec accept text @ref{44c,,str} objects
to encode. Therefore it does not support bytes-to-bytes encoders such as
@code{base64_codec}.
@end deffn

@geindex iterdecode() (no módulo codecs)
@anchor{library/codecs codecs iterdecode}@anchor{2573}
@deffn {Função} codecs.iterdecode (iterator, encoding, errors='strict', **kwargs)

Uses an incremental decoder to iteratively decode the input provided by
`iterator'. `iterator' must yield @ref{1c2,,bytes} objects.
This function is a @ref{109a,,generator}. The `errors' argument (as well as any
other keyword argument) is passed through to the incremental decoder.

This function requires that the codec accept @ref{1c2,,bytes} objects
to decode. Therefore it does not support text-to-text encoders such as
@code{rot_13}, although @code{rot_13} may be used equivalently with
@ref{2572,,iterencode()}.
@end deffn

@geindex readbuffer_encode() (no módulo codecs)
@anchor{library/codecs codecs readbuffer_encode}@anchor{2574}
@deffn {Função} codecs.readbuffer_encode (buffer, errors=None, /)

Return a @ref{370,,tuple} containing the raw bytes of `buffer', a
@ref{2e8,,buffer-compatible object} or @ref{44c,,str}
(encoded to UTF-8 before processing), and their length in bytes.

The `errors' argument is ignored.

@example
>>> codecs.readbuffer_encode(b"Zito")
(b'Zito', 4)
@end example
@end deffn

The module also provides the following constants which are useful for reading
and writing to platform dependent files:

@geindex BOM (no módulo codecs)
@geindex BOM_BE (no módulo codecs)
@geindex BOM_LE (no módulo codecs)
@geindex BOM_UTF8 (no módulo codecs)
@geindex BOM_UTF16 (no módulo codecs)
@geindex BOM_UTF16_BE (no módulo codecs)
@geindex BOM_UTF16_LE (no módulo codecs)
@geindex BOM_UTF32 (no módulo codecs)
@geindex BOM_UTF32_BE (no módulo codecs)
@geindex BOM_UTF32_LE (no módulo codecs)
@anchor{library/codecs codecs BOM}@anchor{2575}
@deffn {Dado} codecs.BOM
@anchor{library/codecs codecs BOM_BE}@anchor{2576}
@deffnx {Dado} codecs.BOM_BE
@anchor{library/codecs codecs BOM_LE}@anchor{2577}
@deffnx {Dado} codecs.BOM_LE
@anchor{library/codecs codecs BOM_UTF8}@anchor{2578}
@deffnx {Dado} codecs.BOM_UTF8
@anchor{library/codecs codecs BOM_UTF16}@anchor{2579}
@deffnx {Dado} codecs.BOM_UTF16
@anchor{library/codecs codecs BOM_UTF16_BE}@anchor{257a}
@deffnx {Dado} codecs.BOM_UTF16_BE
@anchor{library/codecs codecs BOM_UTF16_LE}@anchor{257b}
@deffnx {Dado} codecs.BOM_UTF16_LE
@anchor{library/codecs codecs BOM_UTF32}@anchor{257c}
@deffnx {Dado} codecs.BOM_UTF32
@anchor{library/codecs codecs BOM_UTF32_BE}@anchor{257d}
@deffnx {Dado} codecs.BOM_UTF32_BE
@anchor{library/codecs codecs BOM_UTF32_LE}@anchor{257e}
@deffnx {Dado} codecs.BOM_UTF32_LE

These constants define various byte sequences,
being Unicode byte order marks (BOMs) for several encodings. They are
used in UTF-16 and UTF-32 data streams to indicate the byte order used,
and in UTF-8 as a Unicode signature. @ref{2579,,BOM_UTF16} is either
@ref{257a,,BOM_UTF16_BE} or @ref{257b,,BOM_UTF16_LE} depending on the platform’s
native byte order, @ref{2575,,BOM} is an alias for @ref{2579,,BOM_UTF16},
@ref{2577,,BOM_LE} for @ref{257b,,BOM_UTF16_LE} and @ref{2576,,BOM_BE} for
@ref{257a,,BOM_UTF16_BE}. The others represent the BOM in UTF-8 and UTF-32
encodings.
@end deffn

@menu
* Codec Base Classes:: 
* Encodings and Unicode:: 
* Standard Encodings:: 
* Python Specific Encodings:: 
* encodings — Encodings package:: 
* encodings.idna — Internationalized Domain Names in Applications: encodings idna — Internationalized Domain Names in Applications. 
* encodings.mbcs — Windows ANSI codepage: encodings mbcs — Windows ANSI codepage. 
* encodings.utf_8_sig — UTF-8 codec with BOM signature: encodings utf_8_sig — UTF-8 codec with BOM signature. 

@end menu

@node Codec Base Classes,Encodings and Unicode,,codecs — Codec registry and base classes
@anchor{library/codecs codec-base-classes}@anchor{2559}@anchor{library/codecs id1}@anchor{257f}
@subsubsection Codec Base Classes


The @ref{1b,,codecs} module defines a set of base classes which define the
interfaces for working with codec objects, and can also be used as the basis
for custom codec implementations.

Each codec has to define four interfaces to make it usable as codec in Python:
stateless encoder, stateless decoder, stream reader and stream writer. The
stream reader and writers typically reuse the stateless encoder/decoder to
implement the file protocols. Codec authors also need to define how the
codec will handle encoding and decoding errors.
@anchor{library/codecs surrogateescape}@anchor{2580}
@menu
* Error Handlers:: 
* Stateless Encoding and Decoding:: 
* Incremental Encoding and Decoding:: 
* Stream Encoding and Decoding:: 

@end menu

@node Error Handlers,Stateless Encoding and Decoding,,Codec Base Classes
@anchor{library/codecs error-handlers}@anchor{18fa}@anchor{library/codecs id2}@anchor{2581}
@subsubsection Error Handlers


To simplify and standardize error handling, codecs may implement different
error handling schemes by accepting the `errors' string argument:

@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;error handler's name
@geindex ignore;error handler's name
@geindex replace;error handler's name
@geindex backslashreplace;error handler's name
@geindex surrogateescape;error handler's name
@geindex ? (interrogação);replacement character
@geindex \ (contrabarra);sequência de escape
@geindex \x;sequência de escape
@geindex \u;sequência de escape
@geindex \U;sequência de escape

The following error handlers can be used with all Python
@ref{de1,,Standard Encodings} codecs:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'strict'}

@tab

Raise @ref{12e6,,UnicodeError} (or a subclass),
this is the default. Implemented in
@ref{2582,,strict_errors()}.

@item

@code{'ignore'}

@tab

Ignore the malformed data and continue without
further notice. Implemented in
@ref{2583,,ignore_errors()}.

@item

@code{'replace'}

@tab

Replace with a replacement marker. On
encoding, use @code{?} (ASCII character). On
decoding, use @code{�} (U+FFFD, the official
REPLACEMENT CHARACTER). Implemented in
@ref{2584,,replace_errors()}.

@item

@code{'backslashreplace'}

@tab

Replace with backslashed escape sequences.
On encoding, use hexadecimal form of Unicode
code point with formats @code{\x@var{hh}}
@code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}}.
On decoding, use hexadecimal form of byte
value with format @code{\x@var{hh}}.
Implemented in
@ref{2585,,backslashreplace_errors()}.

@item

@code{'surrogateescape'}

@tab

On decoding, replace byte with individual
surrogate code ranging from @code{U+DC80} to
@code{U+DCFF}. This code will then be turned
back into the same byte when the
@code{'surrogateescape'} error handler is used
when encoding the data. (See 
@geindex Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} for
more.)

@end multitable


@geindex xmlcharrefreplace;error handler's name
@geindex namereplace;error handler's name
@geindex \N;sequência de escape

The following error handlers are only applicable to encoding (within
@ref{2310,,text encodings}):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Significado

@item

@code{'xmlcharrefreplace'}

@tab

Replace with XML/HTML numeric character
reference, which is a decimal form of Unicode
code point with format @code{&#@var{num};}.
Implemented in
@ref{2586,,xmlcharrefreplace_errors()}.

@item

@code{'namereplace'}

@tab

Replace with @code{\N@{...@}} escape sequences,
what appears in the braces is the Name
property from Unicode Character Database.
Implemented in @ref{2587,,namereplace_errors()}.

@end multitable


@geindex surrogatepass;error handler's name

In addition, the following error handler is specific to the given codecs:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Codecs

@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

Allow encoding and decoding surrogate code
point (@code{U+D800} - @code{U+DFFF}) as normal
code point. Otherwise these codecs treat
the presence of surrogate code point in
@ref{44c,,str} as an error.

@end multitable



Adicionado na versão 3.1: The @code{'surrogateescape'} and @code{'surrogatepass'} error handlers.



Alterado na versão 3.4: The @code{'surrogatepass'} error handler now works with utf-16* and utf-32*
codecs.



Adicionado na versão 3.5: The @code{'namereplace'} error handler.



Alterado na versão 3.5: The @code{'backslashreplace'} error handler now works with decoding and
translating.


The set of allowed values can be extended by registering a new named error
handler:

@geindex register_error() (no módulo codecs)
@anchor{library/codecs codecs register_error}@anchor{14e3}
@deffn {Função} codecs.register_error (name, error_handler)

Register the error handling function `error_handler' under the name `name'.
The `error_handler' argument will be called during encoding and decoding
in case of an error, when `name' is specified as the errors parameter.

For encoding, `error_handler' will be called with a @ref{677,,UnicodeEncodeError}
instance, which contains information about the location of the error. The
error handler must either raise this or a different exception, or return a
tuple with a replacement for the unencodable part of the input and a position
where encoding should continue. The replacement may be either @ref{44c,,str} or
@ref{1c2,,bytes}. If the replacement is bytes, the encoder will simply copy
them into the output buffer. If the replacement is a string, the encoder will
encode the replacement. Encoding continues on original input at the
specified position. Negative position values will be treated as being
relative to the end of the input string. If the resulting position is out of
bound an @ref{157e,,IndexError} will be raised.

Decoding and translating works similarly, except @ref{a1d,,UnicodeDecodeError} or
@ref{2434,,UnicodeTranslateError} will be passed to the handler and that the
replacement from the error handler will be put into the output directly.
@end deffn

Previously registered error handlers (including the standard error handlers)
can be looked up by name:

@geindex lookup_error() (no módulo codecs)
@anchor{library/codecs codecs lookup_error}@anchor{14e4}
@deffn {Função} codecs.lookup_error (name)

Return the error handler previously registered under the name `name'.

Raises a @ref{2367,,LookupError} in case the handler cannot be found.
@end deffn

The following standard error handlers are also made available as module level
functions:

@geindex strict_errors() (no módulo codecs)
@anchor{library/codecs codecs strict_errors}@anchor{2582}
@deffn {Função} codecs.strict_errors (exception)

Implementa a tratativa de erro @code{'strict'}.

Each encoding or decoding error raises a @ref{12e6,,UnicodeError}.
@end deffn

@geindex ignore_errors() (no módulo codecs)
@anchor{library/codecs codecs ignore_errors}@anchor{2583}
@deffn {Função} codecs.ignore_errors (exception)

Implementa a tratativa de erro @code{'ignore'}.

Malformed data is ignored; encoding or decoding is continued without
further notice.
@end deffn

@geindex replace_errors() (no módulo codecs)
@anchor{library/codecs codecs replace_errors}@anchor{2584}
@deffn {Função} codecs.replace_errors (exception)

Implementa a tratativa de erro @code{'replace'}.

Substitutes @code{?} (ASCII character) for encoding errors or @code{�} (U+FFFD,
the official REPLACEMENT CHARACTER) for decoding errors.
@end deffn

@geindex backslashreplace_errors() (no módulo codecs)
@anchor{library/codecs codecs backslashreplace_errors}@anchor{2585}
@deffn {Função} codecs.backslashreplace_errors (exception)

Implementa a tratativa de erro @code{'backslashreplace'}.

Malformed data is replaced by a backslashed escape sequence.
On encoding, use the hexadecimal form of Unicode code point with formats
@code{\x@var{hh}} @code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}}.
On decoding, use the hexadecimal form of
byte value with format @code{\x@var{hh}}.


Alterado na versão 3.5: Works with decoding and translating.

@end deffn

@geindex xmlcharrefreplace_errors() (no módulo codecs)
@anchor{library/codecs codecs xmlcharrefreplace_errors}@anchor{2586}
@deffn {Função} codecs.xmlcharrefreplace_errors (exception)

Implements the @code{'xmlcharrefreplace'} error handling (for encoding within
@ref{2310,,text encoding} only).

The unencodable character is replaced by an appropriate XML/HTML numeric
character reference, which is a decimal form of Unicode code point with
format @code{&#@var{num};} .
@end deffn

@geindex namereplace_errors() (no módulo codecs)
@anchor{library/codecs codecs namereplace_errors}@anchor{2587}
@deffn {Função} codecs.namereplace_errors (exception)

Implements the @code{'namereplace'} error handling (for encoding within
@ref{2310,,text encoding} only).

The unencodable character is replaced by a @code{\N@{...@}} escape sequence. The
set of characters that appear in the braces is the Name property from
Unicode Character Database. For example, the German lowercase letter @code{'ß'}
will be converted to byte sequence @code{\N@{LATIN SMALL LETTER SHARP S@}} .


Adicionado na versão 3.5.

@end deffn

@node Stateless Encoding and Decoding,Incremental Encoding and Decoding,Error Handlers,Codec Base Classes
@anchor{library/codecs codec-objects}@anchor{2560}@anchor{library/codecs stateless-encoding-and-decoding}@anchor{2588}
@subsubsection Stateless Encoding and Decoding


The base @ref{2589,,Codec} class defines these methods which also define the
function interfaces of the stateless encoder and decoder:

@geindex Codec (classe em codecs)
@anchor{library/codecs codecs Codec}@anchor{2589}
@deffn {Classe} codecs.Codec

@geindex encode() (método codecs.Codec)
@anchor{library/codecs codecs Codec encode}@anchor{255e}
@deffn {Método} encode (input, errors='strict')

Encodes the object `input' and returns a tuple (output object, length consumed).
For instance, @ref{2310,,text encoding} converts
a string object to a bytes object using a particular
character set encoding (e.g., @code{cp1252} or @code{iso-8859-1}).

The `errors' argument defines the error handling to apply.
It defaults to @code{'strict'} handling.

The method may not store state in the @ref{2589,,Codec} instance. Use
@ref{2567,,StreamWriter} for codecs which have to keep state in order to make
encoding efficient.

The encoder must be able to handle zero length input and return an empty object
of the output object type in this situation.
@end deffn

@geindex decode() (método codecs.Codec)
@anchor{library/codecs codecs Codec decode}@anchor{255f}
@deffn {Método} decode (input, errors='strict')

Decodes the object `input' and returns a tuple (output object, length
consumed). For instance, for a @ref{2310,,text encoding}, decoding converts
a bytes object encoded using a particular
character set encoding to a string object.

For text encodings and bytes-to-bytes codecs,
`input' must be a bytes object or one which provides the read-only
buffer interface – for example, buffer objects and memory mapped files.

The `errors' argument defines the error handling to apply.
It defaults to @code{'strict'} handling.

The method may not store state in the @ref{2589,,Codec} instance. Use
@ref{2568,,StreamReader} for codecs which have to keep state in order to make
decoding efficient.

The decoder must be able to handle zero length input and return an empty object
of the output object type in this situation.
@end deffn
@end deffn

@node Incremental Encoding and Decoding,Stream Encoding and Decoding,Stateless Encoding and Decoding,Codec Base Classes
@anchor{library/codecs incremental-encoding-and-decoding}@anchor{258a}
@subsubsection Incremental Encoding and Decoding


The @ref{2563,,IncrementalEncoder} and @ref{2564,,IncrementalDecoder} classes provide
the basic interface for incremental encoding and decoding. Encoding/decoding the
input isn’t done with one call to the stateless encoder/decoder function, but
with multiple calls to the
@ref{258b,,encode()}/@ref{258c,,decode()} method of
the incremental encoder/decoder. The incremental encoder/decoder keeps track of
the encoding/decoding process during method calls.

The joined output of calls to the
@ref{258b,,encode()}/@ref{258c,,decode()} method is
the same as if all the single inputs were joined into one, and this input was
encoded/decoded with the stateless encoder/decoder.

@menu
* IncrementalEncoder Objects:: 
* IncrementalDecoder Objects:: 

@end menu

@node IncrementalEncoder Objects,IncrementalDecoder Objects,,Incremental Encoding and Decoding
@anchor{library/codecs incremental-encoder-objects}@anchor{258d}@anchor{library/codecs incrementalencoder-objects}@anchor{258e}
@subsubsection IncrementalEncoder Objects


The @ref{2563,,IncrementalEncoder} class is used for encoding an input in multiple
steps. It defines the following methods which every incremental encoder must
define in order to be compatible with the Python codec registry.

@geindex IncrementalEncoder (classe em codecs)
@anchor{library/codecs codecs IncrementalEncoder}@anchor{2563}
@deffn {Classe} codecs.IncrementalEncoder (errors='strict')

Constructor for an @ref{2563,,IncrementalEncoder} instance.

All incremental encoders must provide this constructor interface. They are free
to add additional keyword arguments, but only the ones defined here are used by
the Python codec registry.

The @ref{2563,,IncrementalEncoder} may implement different error handling schemes
by providing the `errors' keyword argument. See @ref{18fa,,Error Handlers} for
possible values.

The `errors' argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of the @ref{2563,,IncrementalEncoder}
object.

@geindex encode() (método codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder encode}@anchor{258b}
@deffn {Método} encode (object, final=False)

Encodes `object' (taking the current state of the encoder into account)
and returns the resulting encoded object. If this is the last call to
@ref{f33,,encode()} `final' must be true (the default is false).
@end deffn

@geindex reset() (método codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder reset}@anchor{258f}
@deffn {Método} reset ()

Reset the encoder to the initial state. The output is discarded: call
@code{.encode(object, final=True)}, passing an empty byte or text string
if necessary, to reset the encoder and to get the output.
@end deffn

@geindex getstate() (método codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder getstate}@anchor{2590}
@deffn {Método} getstate ()

Return the current state of the encoder which must be an integer. The
implementation should make sure that @code{0} is the most common
state. (States that are more complicated than integers can be converted
into an integer by marshaling/pickling the state and encoding the bytes
of the resulting string into an integer.)
@end deffn

@geindex setstate() (método codecs.IncrementalEncoder)
@anchor{library/codecs codecs IncrementalEncoder setstate}@anchor{2591}
@deffn {Método} setstate (state)

Set the state of the encoder to `state'. `state' must be an encoder state
returned by @ref{2590,,getstate()}.
@end deffn
@end deffn

@node IncrementalDecoder Objects,,IncrementalEncoder Objects,Incremental Encoding and Decoding
@anchor{library/codecs incremental-decoder-objects}@anchor{2592}@anchor{library/codecs incrementaldecoder-objects}@anchor{2593}
@subsubsection IncrementalDecoder Objects


The @ref{2564,,IncrementalDecoder} class is used for decoding an input in multiple
steps. It defines the following methods which every incremental decoder must
define in order to be compatible with the Python codec registry.

@geindex IncrementalDecoder (classe em codecs)
@anchor{library/codecs codecs IncrementalDecoder}@anchor{2564}
@deffn {Classe} codecs.IncrementalDecoder (errors='strict')

Constructor for an @ref{2564,,IncrementalDecoder} instance.

All incremental decoders must provide this constructor interface. They are free
to add additional keyword arguments, but only the ones defined here are used by
the Python codec registry.

The @ref{2564,,IncrementalDecoder} may implement different error handling schemes
by providing the `errors' keyword argument. See @ref{18fa,,Error Handlers} for
possible values.

The `errors' argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of the @ref{2564,,IncrementalDecoder}
object.

@geindex decode() (método codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder decode}@anchor{258c}
@deffn {Método} decode (object, final=False)

Decodes `object' (taking the current state of the decoder into account)
and returns the resulting decoded object. If this is the last call to
@ref{f34,,decode()} `final' must be true (the default is false). If `final' is
true the decoder must decode the input completely and must flush all
buffers. If this isn’t possible (e.g. because of incomplete byte sequences
at the end of the input) it must initiate error handling just like in the
stateless case (which might raise an exception).
@end deffn

@geindex reset() (método codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder reset}@anchor{2594}
@deffn {Método} reset ()

Reset the decoder to the initial state.
@end deffn

@geindex getstate() (método codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder getstate}@anchor{2595}
@deffn {Método} getstate ()

Return the current state of the decoder. This must be a tuple with two
items, the first must be the buffer containing the still undecoded
input. The second must be an integer and can be additional state
info. (The implementation should make sure that @code{0} is the most common
additional state info.) If this additional state info is @code{0} it must be
possible to set the decoder to the state which has no input buffered and
@code{0} as the additional state info, so that feeding the previously
buffered input to the decoder returns it to the previous state without
producing any output. (Additional state info that is more complicated than
integers can be converted into an integer by marshaling/pickling the info
and encoding the bytes of the resulting string into an integer.)
@end deffn

@geindex setstate() (método codecs.IncrementalDecoder)
@anchor{library/codecs codecs IncrementalDecoder setstate}@anchor{2596}
@deffn {Método} setstate (state)

Set the state of the decoder to `state'. `state' must be a decoder state
returned by @ref{2595,,getstate()}.
@end deffn
@end deffn

@node Stream Encoding and Decoding,,Incremental Encoding and Decoding,Codec Base Classes
@anchor{library/codecs stream-encoding-and-decoding}@anchor{2597}
@subsubsection Stream Encoding and Decoding


The @ref{2567,,StreamWriter} and @ref{2568,,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
* StreamWriter Objects:: 
* StreamReader Objects:: 
* StreamReaderWriter Objects:: 
* StreamRecoder Objects:: 

@end menu

@node StreamWriter Objects,StreamReader Objects,,Stream Encoding and Decoding
@anchor{library/codecs stream-writer-objects}@anchor{2598}@anchor{library/codecs streamwriter-objects}@anchor{2599}
@subsubsection StreamWriter Objects


The @ref{2567,,StreamWriter} class is a subclass of @ref{2589,,Codec} and defines the
following methods which every stream writer must define in order to be
compatible with the Python codec registry.

@geindex StreamWriter (classe em codecs)
@anchor{library/codecs codecs StreamWriter}@anchor{2567}
@deffn {Classe} codecs.StreamWriter (stream, errors='strict')

Constructor for a @ref{2567,,StreamWriter} instance.

All stream writers must provide this constructor interface. They are free to add
additional keyword arguments, but only the ones defined here are used by the
Python codec registry.

The `stream' argument must be a file-like object open for writing
text or binary data, as appropriate for the specific codec.

The @ref{2567,,StreamWriter} may implement different error handling schemes by
providing the `errors' keyword argument. See @ref{18fa,,Error Handlers} for
the standard error handlers the underlying stream codec may support.

The `errors' argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of the @ref{2567,,StreamWriter} object.

@geindex write() (método codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter write}@anchor{259a}
@deffn {Método} write (object)

Writes the object’s contents encoded to the stream.
@end deffn

@geindex writelines() (método codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter writelines}@anchor{259b}
@deffn {Método} writelines (list)

Writes the concatenated iterable of strings to the stream (possibly by reusing
the @ref{259a,,write()} method). Infinite or
very large iterables are not supported. The standard bytes-to-bytes codecs
do not support this method.
@end deffn

@geindex reset() (método codecs.StreamWriter)
@anchor{library/codecs codecs StreamWriter reset}@anchor{259c}
@deffn {Método} reset ()

Resets the codec buffers used for keeping internal state.

Chamar este método deve garantir que os dados na saída estejam num estado limpo, que permite anexar novos dados sem ter que verificar novamente todo o fluxo para recuperar o estado.
@end deffn
@end deffn

In addition to the above methods, the @ref{2567,,StreamWriter} must also inherit
all other methods and attributes from the underlying stream.

@node StreamReader Objects,StreamReaderWriter Objects,StreamWriter Objects,Stream Encoding and Decoding
@anchor{library/codecs stream-reader-objects}@anchor{259d}@anchor{library/codecs streamreader-objects}@anchor{259e}
@subsubsection StreamReader Objects


The @ref{2568,,StreamReader} class is a subclass of @ref{2589,,Codec} and defines the
following methods which every stream reader must define in order to be
compatible with the Python codec registry.

@geindex StreamReader (classe em codecs)
@anchor{library/codecs codecs StreamReader}@anchor{2568}
@deffn {Classe} codecs.StreamReader (stream, errors='strict')

Constructor for a @ref{2568,,StreamReader} instance.

All stream readers must provide this constructor interface. They are free to add
additional keyword arguments, but only the ones defined here are used by the
Python codec registry.

The `stream' argument must be a file-like object open for reading
text or binary data, as appropriate for the specific codec.

The @ref{2568,,StreamReader} may implement different error handling schemes by
providing the `errors' keyword argument. See @ref{18fa,,Error Handlers} for
the standard error handlers the underlying stream codec may support.

The `errors' argument will be assigned to an attribute of the same name.
Assigning to this attribute makes it possible to switch between different error
handling strategies during the lifetime of the @ref{2568,,StreamReader} object.

The set of allowed values for the `errors' argument can be extended with
@ref{14e3,,register_error()}.

@geindex read() (método codecs.StreamReader)
@anchor{library/codecs codecs StreamReader read}@anchor{259f}
@deffn {Método} read (size=-1, chars=-1, firstline=False)

Decodes data from the stream and returns the resulting object.

The `chars' argument indicates the number of decoded
code points or bytes to return. The @ref{259f,,read()} method will
never return more data than requested, but it might return less,
if there is not enough available.

The `size' argument indicates the approximate maximum
number of encoded bytes or code points to read
for decoding. The decoder can modify this setting as
appropriate. The default value -1 indicates to read and decode as much as
possible. This parameter is intended to
prevent having to decode huge files in one step.

The `firstline' flag indicates that
it would be sufficient to only return the first
line, if there are decoding errors on later lines.

The method should use a greedy read strategy meaning that it should read
as much data as is allowed within the definition of the encoding and the
given size, e.g.  if optional encoding endings or state markers are
available on the stream, these should be read too.
@end deffn

@geindex readline() (método codecs.StreamReader)
@anchor{library/codecs codecs StreamReader readline}@anchor{25a0}
@deffn {Método} readline (size=None, keepends=True)

Read one line from the input stream and return the decoded data.

`size', if given, is passed as size argument to the stream’s
@ref{259f,,read()} method.

If `keepends' is false line-endings will be stripped from the lines
returned.
@end deffn

@geindex readlines() (método codecs.StreamReader)
@anchor{library/codecs codecs StreamReader readlines}@anchor{25a1}
@deffn {Método} readlines (sizehint=None, keepends=True)

Read all lines available on the input stream and return them as a list of
lines.

Line-endings are implemented using the codec’s @ref{f34,,decode()} method and
are included in the list entries if `keepends' is true.

`sizehint', if given, is passed as the `size' argument to the stream’s
@ref{259f,,read()} method.
@end deffn

@geindex reset() (método codecs.StreamReader)
@anchor{library/codecs codecs StreamReader reset}@anchor{25a2}
@deffn {Método} reset ()

Resets the codec buffers used for keeping internal state.

Note that no stream repositioning should take place. This method is
primarily intended to be able to recover from decoding errors.
@end deffn
@end deffn

In addition to the above methods, the @ref{2568,,StreamReader} must also inherit
all other methods and attributes from the underlying stream.

@node StreamReaderWriter Objects,StreamRecoder Objects,StreamReader Objects,Stream Encoding and Decoding
@anchor{library/codecs stream-reader-writer}@anchor{25a3}@anchor{library/codecs streamreaderwriter-objects}@anchor{25a4}
@subsubsection StreamReaderWriter Objects


The @ref{2570,,StreamReaderWriter} is a convenience class that allows wrapping
streams which work in both read and write modes.

The design is such that one can use the factory functions returned by the
@ref{96a,,lookup()} function to construct the instance.

@geindex StreamReaderWriter (classe em codecs)
@anchor{library/codecs codecs StreamReaderWriter}@anchor{2570}
@deffn {Classe} codecs.StreamReaderWriter (stream, Reader, Writer, errors='strict')

Creates a @ref{2570,,StreamReaderWriter} instance. `stream' must be a file-like
object. `Reader' and `Writer' must be factory functions or classes providing the
@ref{2568,,StreamReader} and @ref{2567,,StreamWriter} interface resp. Error handling
is done in the same way as defined for the stream readers and writers.
@end deffn

@ref{2570,,StreamReaderWriter} instances define the combined interfaces of
@ref{2568,,StreamReader} and @ref{2567,,StreamWriter} classes. They inherit all other
methods and attributes from the underlying stream.

@node StreamRecoder Objects,,StreamReaderWriter Objects,Stream Encoding and Decoding
@anchor{library/codecs stream-recoder-objects}@anchor{25a5}@anchor{library/codecs streamrecoder-objects}@anchor{25a6}
@subsubsection StreamRecoder Objects


The @ref{1b68,,StreamRecoder} translates data from one encoding to another,
which is sometimes useful when dealing with different encoding environments.

The design is such that one can use the factory functions returned by the
@ref{96a,,lookup()} function to construct the instance.

@geindex StreamRecoder (classe em codecs)
@anchor{library/codecs codecs StreamRecoder}@anchor{1b68}
@deffn {Classe} codecs.StreamRecoder (stream, encode, decode, Reader, Writer, errors='strict')

Creates a @ref{1b68,,StreamRecoder} instance which implements a two-way conversion:
`encode' and `decode' work on the frontend — the data visible to
code calling @ref{259f,,read()} and @ref{259a,,write()},
while `Reader' and `Writer'
work on the backend — the data in `stream'.

You can use these objects to do transparent transcodings, e.g., from Latin-1
to UTF-8 and back.

The `stream' argument must be a file-like object.

The `encode' and `decode' arguments must
adhere to the @ref{2589,,Codec} interface. `Reader' and
`Writer' must be factory functions or classes providing objects of the
@ref{2568,,StreamReader} and @ref{2567,,StreamWriter} interface respectively.

Error handling is done in the same way as defined for the stream readers and
writers.
@end deffn

@ref{1b68,,StreamRecoder} instances define the combined interfaces of
@ref{2568,,StreamReader} and @ref{2567,,StreamWriter} classes. They inherit all other
methods and attributes from the underlying stream.

@node Encodings and Unicode,Standard Encodings,Codec Base Classes,codecs — Codec registry and base classes
@anchor{library/codecs encodings-and-unicode}@anchor{25a7}@anchor{library/codecs encodings-overview}@anchor{25a8}
@subsubsection Encodings and Unicode


Strings are stored internally as sequences of code points in
range @code{U+0000}–@code{U+10FFFF}. (See 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} for
more details about the implementation.)
Once a string object is used outside of CPU and memory, endianness
and how these arrays are stored as bytes become an issue. As with other
codecs, serialising a string into a sequence of bytes is known as `encoding',
and recreating the string from the sequence of bytes is known as `decoding'.
There are a variety of different text serialisation codecs, which are
collectivity referred to as @ref{2310,,text encodings}.

The simplest text encoding (called @code{'latin-1'} or @code{'iso-8859-1'}) maps
the code points 0–255 to the bytes @code{0x0}–@code{0xff}, which means that a string
object that contains code points above @code{U+00FF} can’t be encoded with this
codec. Doing so will raise a @ref{677,,UnicodeEncodeError} that looks
like the following (although the details of the error message may differ):
@code{UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' in
position 3: ordinal not in range(256)}.

There’s another group of encodings (the so called charmap encodings) that choose
a different subset of all Unicode code points and how these code points are
mapped to the bytes @code{0x0}–@code{0xff}. To see how this is done simply open
e.g. @code{encodings/cp1252.py} (which is an encoding that is used primarily on
Windows). There’s a string constant with 256 characters that shows you which
character is mapped to which byte value.

All of these encodings can only encode 256 of the 1114112 code points
defined in Unicode. A simple and straightforward way that can store each Unicode
code point, is to store each code point as four consecutive bytes. There are two
possibilities: store the bytes in big endian or in little endian order. These
two encodings are called @code{UTF-32-BE} and @code{UTF-32-LE} respectively. Their
disadvantage is that if, for example, you use @code{UTF-32-BE} on a little endian
machine you will always have to swap bytes on encoding and decoding.
Python’s @code{UTF-16} and @code{UTF-32} codecs avoid this problem by using the
platform’s native byte order when no BOM is present.
Python follows prevailing platform
practice, so native-endian data round-trips without redundant byte swapping,
even though the Unicode Standard defaults to big-endian when the byte order is
unspecified. When these bytes are read by a CPU with a different endianness,
the bytes have to be swapped. To be able to detect the endianness of a
@code{UTF-16} or @code{UTF-32} byte sequence, a BOM (“Byte Order Mark”) is used.
This is the Unicode character @code{U+FEFF}. This character can be prepended to every
@code{UTF-16} or @code{UTF-32} byte sequence. The byte swapped version of this character
(@code{0xFFFE}) is an illegal character that may not appear in a Unicode text.
When the first character of a @code{UTF-16} or @code{UTF-32} byte sequence is
@code{U+FFFE}, the bytes have to be swapped on decoding.

Unfortunately the character @code{U+FEFF} had a second purpose as
a @code{ZERO WIDTH NO-BREAK SPACE}: a character that has no width and doesn’t allow
a word to be split. It can e.g. be used to give hints to a ligature algorithm.
With Unicode 4.0 using @code{U+FEFF} as a @code{ZERO WIDTH NO-BREAK SPACE} has been
deprecated (with @code{U+2060} (@code{WORD JOINER}) assuming this role). Nevertheless
Unicode software still must be able to handle @code{U+FEFF} in both roles: as a BOM
it’s a device to determine the storage layout of the encoded bytes, and vanishes
once the byte sequence has been decoded into a string; as a @code{ZERO WIDTH
NO-BREAK SPACE} it’s a normal character that will be decoded like any other.

There’s another encoding that is able to encode the full range of Unicode
characters: UTF-8. UTF-8 is an 8-bit encoding, which means there are no issues
with byte order in UTF-8. Each byte in a UTF-8 byte sequence consists of two
parts: marker bits (the most significant bits) and payload bits. The marker bits
are a sequence of zero to four @code{1} bits followed by a @code{0} bit. Unicode characters are
encoded like this (with x being payload bits, which when concatenated give the
Unicode character):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Range

@tab

Encoding

@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


The least significant bit of the Unicode character is the rightmost x bit.

As UTF-8 is an 8-bit encoding no BOM is required and any @code{U+FEFF} character in
the decoded string (even if it’s the first character) is treated as a @code{ZERO
WIDTH NO-BREAK SPACE}.

Without external information it’s impossible to reliably determine which
encoding was used for encoding a string. Each charmap encoding can
decode any random byte sequence. However that’s not possible with UTF-8, as
UTF-8 byte sequences have a structure that doesn’t allow arbitrary byte
sequences. To increase the reliability with which a UTF-8 encoding can be
detected, Microsoft invented a variant of UTF-8 (that Python calls
@code{"utf-8-sig"}) for its Notepad program: Before any of the Unicode characters
is written to the file, a UTF-8 encoded BOM (which looks like this as a byte
sequence: @code{0xef}, @code{0xbb}, @code{0xbf}) is written. As it’s rather improbable
that any charmap encoded file starts with these byte values (which would e.g.
map to

@quotation


@display
LATIN SMALL LETTER I WITH DIAERESIS@w{ }
RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK@w{ }
INVERTED QUESTION MARK@w{ }
@end display


@end quotation

in iso-8859-1), this increases the probability that a @code{utf-8-sig} encoding can be
correctly guessed from the byte sequence. So here the BOM is not used to be able
to determine the byte order used for generating the byte sequence, but as a
signature that helps in guessing the encoding. On encoding the utf-8-sig codec
will write @code{0xef}, @code{0xbb}, @code{0xbf} as the first three bytes to the file. On
decoding @code{utf-8-sig} will skip those three bytes if they appear as the first
three bytes in the file. In UTF-8, the use of the BOM is discouraged and
should generally be avoided.

@node Standard Encodings,Python Specific Encodings,Encodings and Unicode,codecs — Codec registry and base classes
@anchor{library/codecs id3}@anchor{25a9}@anchor{library/codecs standard-encodings}@anchor{de1}
@subsubsection Standard Encodings


Python comes with a number of codecs built-in, either implemented as C functions
or with dictionaries as mapping tables. The following table lists the codecs by
name, together with a few common aliases, and the languages for which the
encoding is likely used. Neither the list of aliases nor the list of languages
is meant to be exhaustive. Notice that spelling alternatives that only differ in
case or use a hyphen instead of an underscore are also valid aliases
because they are equivalent when normalized by
@ref{7fe,,normalize_encoding()}. For example, @code{'utf-8'} is a valid
alias for the @code{'utf_8'} codec.

@cartouche
@quotation Nota 
The below table lists the most common aliases, for a complete list
refer to the source aliases.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/encodings/aliases.py} file.
@end quotation
@end cartouche

`Detalhes da implementação do CPython:' Some common encodings can bypass the codecs lookup machinery to
improve performance. These optimization opportunities are only
recognized by CPython for a limited set of (case insensitive)
aliases: utf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs
(Windows only), ascii, us-ascii, utf-16, utf16, utf-32, utf32, and
the same using underscores instead of dashes. Using alternative
aliases for these encodings may result in slower execution.


Alterado na versão 3.6: Optimization opportunity recognized for us-ascii.


Many of the character sets support the same languages. They vary in individual
characters (e.g. whether the EURO SIGN is supported or not), and in the
assignment of characters to code positions. For the European languages in
particular, the following variants typically exist:


@itemize *

@item 
an ISO 8859 codeset

@item 
a Microsoft Windows code page, which is typically derived from an 8859 codeset,
but replaces control characters with additional graphic characters

@item 
an IBM EBCDIC code page

@item 
an IBM PC code page, which is ASCII compatible
@end itemize


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Codec

@tab

Aliases

@tab

Idiomas

@item

ascii

@tab

646, us-ascii

@tab

Inglês

@item

big5

@tab

big5-tw, csbig5

@tab

Traditional Chinese

@item

big5hkscs

@tab

big5-hkscs, hkscs

@tab

Traditional Chinese

@item

cp037

@tab

IBM037, IBM039

@tab

Inglês

@item

cp273

@tab

273, IBM273, csIBM273

@tab

Alemão


Adicionado na versão 3.4.


@item

cp424

@tab

EBCDIC-CP-HE, IBM424

@tab

Hebraico

@item

cp437

@tab

437, IBM437

@tab

Inglês

@item

cp500

@tab

EBCDIC-CP-BE, EBCDIC-CP-CH,
IBM500

@tab

Western Europe

@item

cp720

@tab

@tab

Árabe

@item

cp737

@tab

@tab

Grego

@item

cp775

@tab

IBM775

@tab

Baltic languages

@item

cp850

@tab

850, IBM850

@tab

Western Europe

@item

cp852

@tab

852, IBM852

@tab

Central and Eastern Europe

@item

cp855

@tab

855, IBM855

@tab

Belarusian, Bulgarian,
Macedonian, Russian, Serbian

@item

cp856

@tab

@tab

Hebraico

@item

cp857

@tab

857, IBM857

@tab

Turco

@item

cp858

@tab

858, IBM858

@tab

Western Europe

@item

cp860

@tab

860, IBM860

@tab

Português

@item

cp861

@tab

861, CP-IS, IBM861

@tab

Islandês

@item

cp862

@tab

862, IBM862

@tab

Hebraico

@item

cp863

@tab

863, IBM863

@tab

Canadense

@item

cp864

@tab

IBM864

@tab

Árabe

@item

cp865

@tab

865, IBM865

@tab

Danish, Norwegian

@item

cp866

@tab

866, IBM866

@tab

Russo

@item

cp869

@tab

869, CP-GR, IBM869

@tab

Grego

@item

cp874

@tab

@tab

Tailandês

@item

cp875

@tab

@tab

Grego

@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

Traditional Chinese

@item

cp1006

@tab

@tab

Urdu

@item

cp1026

@tab

ibm1026

@tab

Turco

@item

cp1125

@tab

1125, ibm1125, cp866u, ruscii

@tab

Ucraniano


Adicionado na versão 3.4.


@item

cp1140

@tab

ibm1140

@tab

Western Europe

@item

cp1250

@tab

windows-1250

@tab

Central and Eastern Europe

@item

cp1251

@tab

windows-1251

@tab

Belarusian, Bulgarian,
Macedonian, Russian, Serbian

@item

cp1252

@tab

windows-1252

@tab

Western Europe

@item

cp1253

@tab

windows-1253

@tab

Grego

@item

cp1254

@tab

windows-1254

@tab

Turco

@item

cp1255

@tab

windows-1255

@tab

Hebraico

@item

cp1256

@tab

windows-1256

@tab

Árabe

@item

cp1257

@tab

windows-1257

@tab

Baltic languages

@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

Simplified Chinese

@item

gbk

@tab

936, cp936, ms936

@tab

Unified Chinese

@item

gb18030

@tab

gb18030-2000

@tab

Unified Chinese

@item

hz

@tab

hzgb, hz-gb, hz-gb-2312

@tab

Simplified Chinese

@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

Japanese, Korean, Simplified
Chinese, Western Europe, Greek

@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

Western Europe

@item

iso8859_2

@tab

iso-8859-2, latin2, L2

@tab

Central and Eastern Europe

@item

iso8859_3

@tab

iso-8859-3, latin3, L3

@tab

Esperanto, Maltese

@item

iso8859_4

@tab

iso-8859-4, latin4, L4

@tab

Northern Europe

@item

iso8859_5

@tab

iso-8859-5, cyrillic

@tab

Belarusian, Bulgarian,
Macedonian, Russian, Serbian

@item

iso8859_6

@tab

iso-8859-6, arabic

@tab

Árabe

@item

iso8859_7

@tab

iso-8859-7, greek, greek8

@tab

Grego

@item

iso8859_8

@tab

iso-8859-8, hebrew

@tab

Hebraico

@item

iso8859_9

@tab

iso-8859-9, latin5, L5

@tab

Turco

@item

iso8859_10

@tab

iso-8859-10, latin6, L6

@tab

Nordic languages

@item

iso8859_11

@tab

iso-8859-11, thai

@tab

Thai languages

@item

iso8859_13

@tab

iso-8859-13, latin7, L7

@tab

Baltic languages

@item

iso8859_14

@tab

iso-8859-14, latin8, L8

@tab

Celtic languages

@item

iso8859_15

@tab

iso-8859-15, latin9, L9

@tab

Western Europe

@item

iso8859_16

@tab

iso-8859-16, latin10, L10

@tab

South-Eastern Europe

@item

johab

@tab

cp1361, ms1361

@tab

Coreano

@item

koi8_r

@tab

@tab

Russo

@item

koi8_t

@tab

@tab

Tajik


Adicionado na versão 3.5.


@item

koi8_u

@tab

@tab

Ucraniano

@item

kz1048

@tab

kz_1048, strk1048_2002, rk1048

@tab

Cazaque


Adicionado na versão 3.5.


@item

mac_cyrillic

@tab

maccyrillic

@tab

Belarusian, Bulgarian,
Macedonian, Russian, Serbian

@item

mac_greek

@tab

macgreek

@tab

Grego

@item

mac_iceland

@tab

maciceland

@tab

Islandês

@item

mac_latin2

@tab

maclatin2, maccentraleurope,
mac_centeuro

@tab

Central and Eastern Europe

@item

mac_roman

@tab

macroman, macintosh

@tab

Western Europe

@item

mac_turkish

@tab

macturkish

@tab

Turco

@item

ptcp154

@tab

csptcp154, pt154, cp154,
cyrillic-asian

@tab

Cazaque

@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

todas linguagens

@item

utf_32_be

@tab

UTF-32BE

@tab

todas linguagens

@item

utf_32_le

@tab

UTF-32LE

@tab

todas linguagens

@item

utf_16

@tab

U16, utf16

@tab

todas linguagens

@item

utf_16_be

@tab

UTF-16BE

@tab

todas linguagens

@item

utf_16_le

@tab

UTF-16LE

@tab

todas linguagens

@item

utf_7

@tab

U7, unicode-1-1-utf-7

@tab

todas linguagens

@item

utf_8

@tab

U8, UTF, utf8, cp65001

@tab

todas linguagens

@item

utf_8_sig

@tab

@tab

todas linguagens

@end multitable



Alterado na versão 3.4: The utf-16* and utf-32* encoders no longer allow surrogate code points
(@code{U+D800}–@code{U+DFFF}) to be encoded.
The utf-32* decoders no longer decode
byte sequences that correspond to surrogate code points.



Alterado na versão 3.8: @code{cp65001} is now an alias to @code{utf_8}.


@node Python Specific Encodings,encodings — Encodings package,Standard Encodings,codecs — Codec registry and base classes
@anchor{library/codecs python-specific-encodings}@anchor{25aa}
@subsubsection Python Specific Encodings


A number of predefined codecs are specific to Python, so their codec names have
no meaning outside Python. These are listed in the tables below based on the
expected input and output types (note that while text encodings are the most
common use case for codecs, the underlying codec infrastructure supports
arbitrary data transforms rather than just text encodings). For asymmetric
codecs, the stated meaning describes the encoding direction.

@menu
* Text Encodings:: 
* Binary Transforms:: 
* Standalone Codec Functions:: 
* Text Transforms:: 

@end menu

@node Text Encodings,Binary Transforms,,Python Specific Encodings
@anchor{library/codecs text-encodings}@anchor{25ab}
@subsubsection Text Encodings


The following codecs provide @ref{44c,,str} to @ref{1c2,,bytes} encoding and
@ref{d4f,,bytes-like object} to @ref{44c,,str} decoding, similar to the Unicode text
encodings.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Codec

@tab

Aliases

@tab

Significado

@item

idna

@tab

@tab

Implement 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html},
see also
@ref{52,,encodings.idna}.
Only @code{errors='strict'}
is supported.

@item

mbcs

@tab

ansi,
dbcs

@tab

Windows only: Encode the
operand according to the
ANSI codepage (CP_ACP).

@item

oem

@tab

@tab

Windows only: Encode the
operand according to the
OEM codepage (CP_OEMCP).


Adicionado na versão 3.6.


@item

palmos

@tab

@tab

Encoding of PalmOS 3.5.

@item

punycode

@tab

@tab

Implement 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html}.
Stateful codecs are not
supported.

@item

raw_unicode_escape

@tab

@tab

Latin-1 encoding with
@code{\u@var{XXXX}} and
@code{\U@var{XXXXXXXX}}
for other code points.
Existing
backslashes are not
escaped in any way.
It is used in the Python
pickle protocol.

@item

undefined

@tab

@tab

This Codec should only
be used for testing
purposes.

Raise an exception for
all conversions, even
empty strings. The error
handler is ignored.

@item

unicode_escape

@tab

@tab

Encoding suitable as the
contents of a Unicode
literal in ASCII-encoded
Python source code,
except that quotes are
not escaped. Decode
from Latin-1 source code.
Beware that Python source
code actually uses UTF-8
by default.

@end multitable



Alterado na versão 3.8: “unicode_internal” codec is removed.


@node Binary Transforms,Standalone Codec Functions,Text Encodings,Python Specific Encodings
@anchor{library/codecs binary-transforms}@anchor{f35}@anchor{library/codecs id4}@anchor{25ac}
@subsubsection Binary Transforms


The following codecs provide binary transforms: @ref{d4f,,bytes-like object}
to @ref{1c2,,bytes} mappings. They are not supported by @ref{8dc,,bytes.decode()}
(which only produces @ref{44c,,str} output).


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Codec

@tab

Aliases

@tab

Significado

@tab

Encoder / decoder

@item

base64_codec @footnote{
In addition to @ref{d4f,,bytes-like objects},
@code{'base64_codec'} also accepts ASCII-only instances of @ref{44c,,str} for
decoding
}

@tab

base64, base_64

@tab

Convert the operand to
multiline MIME base64 (the
result always includes a
trailing @code{'\n'}).


Alterado na versão 3.4: accepts any
@ref{d4f,,bytes-like object}
as input for encoding and
decoding


@tab

@ref{95a,,base64.encodebytes()} /
@ref{95b,,base64.decodebytes()}

@item

bz2_codec

@tab

bz2

@tab

Compress the operand using
bz2.

@tab

@ref{25ad,,bz2.compress()} /
@ref{10cd,,bz2.decompress()}

@item

hex_codec

@tab

hex

@tab

Convert the operand to
hexadecimal
representation, with two
digits per byte.

@tab

@ref{25ae,,binascii.b2a_hex()} /
@ref{25af,,binascii.a2b_hex()}

@item

quopri_codec

@tab

quopri,
quotedprintable,
quoted_printable

@tab

Convert the operand to MIME
quoted printable.

@tab

@ref{25b0,,quopri.encode()} with
@code{quotetabs=True} /
@ref{25b1,,quopri.decode()}

@item

uu_codec

@tab

uu

@tab

Convert the operand using
uuencode.

@tab

@item

zlib_codec

@tab

zip, zlib

@tab

Compress the operand using
gzip.

@tab

@ref{63f,,zlib.compress()} /
@ref{d2f,,zlib.decompress()}

@end multitable



Adicionado na versão 3.2: Restoration of the binary transforms.



Alterado na versão 3.4: Restoration of the aliases for the binary transforms.


@node Standalone Codec Functions,Text Transforms,Binary Transforms,Python Specific Encodings
@anchor{library/codecs id6}@anchor{25b2}@anchor{library/codecs standalone-codec-functions}@anchor{25b3}
@subsubsection Standalone Codec Functions


The following functions provide encoding and decoding functionality similar to codecs,
but are not available as named codecs through @ref{f33,,codecs.encode()} or @ref{f34,,codecs.decode()}.
They are used internally (for example, by @ref{a6,,pickle}) and behave similarly to the
@code{string_escape} codec that was removed in Python 3.

@geindex codecs.escape_encode() (no módulo codecs)
@anchor{library/codecs codecs codecs escape_encode}@anchor{25b4}
@deffn {Função} codecs.escape_encode (input, errors=None)

Encode `input' using escape sequences. Similar to how @ref{800,,repr()} on bytes
produces escaped byte values.

`input' must be a @ref{1c2,,bytes} object.

Returns a tuple @code{(output, length)} where `output' is a @ref{1c2,,bytes}
object and `length' is the number of bytes consumed.
@end deffn

@geindex codecs.escape_decode() (no módulo codecs)
@anchor{library/codecs codecs codecs escape_decode}@anchor{25b5}
@deffn {Função} codecs.escape_decode (input, errors=None)

Decode `input' from escape sequences back to the original bytes.

`input' must be a @ref{d4f,,bytes-like object}.

Returns a tuple @code{(output, length)} where `output' is a @ref{1c2,,bytes}
object and `length' is the number of bytes consumed.
@end deffn

@node Text Transforms,,Standalone Codec Functions,Python Specific Encodings
@anchor{library/codecs id7}@anchor{25b6}@anchor{library/codecs text-transforms}@anchor{f36}
@subsubsection Text Transforms


The following codec provides a text transform: a @ref{44c,,str} to @ref{44c,,str}
mapping. It is not supported by @ref{8db,,str.encode()} (which only produces
@ref{1c2,,bytes} output).


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Codec

@tab

Aliases

@tab

Significado

@item

rot_13

@tab

rot13

@tab

Return the Caesar-cypher
encryption of the
operand.

@end multitable



Adicionado na versão 3.2: Restoration of the @code{rot_13} text transform.



Alterado na versão 3.4: Restoration of the @code{rot13} alias.


@node encodings — Encodings package,encodings idna — Internationalized Domain Names in Applications,Python Specific Encodings,codecs — Codec registry and base classes
@anchor{library/codecs encodings-encodings-package}@anchor{25b7}@anchor{library/codecs module-encodings}@anchor{51}
@subsubsection @code{encodings} — Encodings package


@geindex module; encodings

This module implements the following functions:

@geindex normalize_encoding() (no módulo encodings)
@anchor{library/codecs encodings normalize_encoding}@anchor{7fe}
@deffn {Função} encodings.normalize_encoding (encoding)

Normalize encoding name `encoding'.

Normalization works as follows: all non-alphanumeric characters except the
dot used for Python package names are collapsed and replaced with a single
underscore, leading and trailing underscores are removed.
For example, @code{'  -;#'} becomes @code{'_'}.

Note that `encoding' should be ASCII only.
@end deffn

@cartouche
@quotation Nota 
The following function should not be used directly, except for testing
purposes; @ref{96a,,codecs.lookup()} should be used instead.
@end quotation
@end cartouche

@geindex search_function() (no módulo encodings)
@anchor{library/codecs encodings search_function}@anchor{25b8}
@deffn {Função} encodings.search_function (encoding)

Search for the codec module corresponding to the given encoding name
`encoding'.

This function first normalizes the `encoding' using
@ref{7fe,,normalize_encoding()}, then looks for a corresponding alias.
It attempts to import a codec module from the encodings package using either
the alias or the normalized name. If the module is found and defines a valid
@code{getregentry()} function that returns a @ref{17ee,,codecs.CodecInfo} object,
the codec is cached and returned.

If the codec module defines a @code{getaliases()} function any returned aliases
are registered for future use.
@end deffn

This module implements the following exception:

@geindex CodecRegistryError
@anchor{library/codecs encodings CodecRegistryError}@anchor{25b9}
@deffn {Exceção} encodings.CodecRegistryError

Raised when a codec is invalid or incompatible.
@end deffn

@node encodings idna — Internationalized Domain Names in Applications,encodings mbcs — Windows ANSI codepage,encodings — Encodings package,codecs — Codec registry and base classes
@anchor{library/codecs encodings-idna-internationalized-domain-names-in-applications}@anchor{25ba}@anchor{library/codecs module-encodings idna}@anchor{52}
@subsubsection @code{encodings.idna} — Internationalized Domain Names in Applications


@geindex module; encodings.idna

This module implements 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html} (Internationalized Domain Names in
Applications) and 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html} (Nameprep: A Stringprep Profile for
Internationalized Domain Names (IDN)). It builds upon the @code{punycode} encoding
and @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.

These RFCs together define a protocol to support non-ASCII characters in domain
names. A domain name containing non-ASCII characters (such as
@code{www.Alliancefrançaise.nu}) is converted into an ASCII-compatible encoding
(ACE, such as @code{www.xn--alliancefranaise-npb.nu}). The ACE form of the domain
name is then used in all places where arbitrary characters are not allowed by
the protocol, such as DNS queries, HTTP @code{Host} fields, and so
on. This conversion is carried out in the application; if possible invisible to
the user: The application should transparently convert Unicode domain labels to
IDNA on the wire, and convert back ACE labels to Unicode before presenting them
to the user.

Python supports this conversion in several ways:  the @code{idna} codec performs
conversion between Unicode and ACE, separating an input string into labels
based on the separator characters defined in 
@geindex RFC; RFC 3490 Section 3.1
section 3.1 of RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html#section-3.1}
and converting each label to ACE as required, and conversely separating an input
byte string into labels based on the @code{.} separator and converting any ACE
labels found into unicode. Furthermore, the @ref{cc,,socket} module
transparently converts Unicode host names to ACE, so that applications need not
be concerned about converting host names themselves when they pass them to the
socket module. On top of that, modules that have host names as function
parameters, such as @ref{6f,,http.client} and @ref{5e,,ftplib}, accept Unicode host
names (@ref{6f,,http.client} then also transparently sends an IDNA hostname in the
@code{Host} field if it sends that field at all).

When receiving host names from the wire (such as in reverse name lookup), no
automatic conversion to Unicode is performed: applications wishing to present
such host names to the user should decode them to Unicode.

The module @ref{52,,encodings.idna} also implements the nameprep procedure, which
performs certain normalizations on host names, to achieve case-insensitivity of
international domain names, and to unify similar characters. The nameprep
functions can be used directly if desired.

@geindex nameprep() (no módulo encodings.idna)
@anchor{library/codecs encodings idna nameprep}@anchor{25bb}
@deffn {Função} encodings.idna.nameprep (label)

Return the nameprepped version of `label'. The implementation currently assumes
query strings, so @code{AllowUnassigned} is true.
@end deffn

@geindex ToASCII() (no módulo encodings.idna)
@anchor{library/codecs encodings idna ToASCII}@anchor{25bc}
@deffn {Função} encodings.idna.ToASCII (label)

Convert a label to ASCII, as specified in 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}. @code{UseSTD3ASCIIRules} is
assumed to be false.
@end deffn

@geindex ToUnicode() (no módulo encodings.idna)
@anchor{library/codecs encodings idna ToUnicode}@anchor{25bd}
@deffn {Função} encodings.idna.ToUnicode (label)

Convert a label to Unicode, as specified in 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}.
@end deffn

@node encodings mbcs — Windows ANSI codepage,encodings utf_8_sig — UTF-8 codec with BOM signature,encodings idna — Internationalized Domain Names in Applications,codecs — Codec registry and base classes
@anchor{library/codecs encodings-mbcs-windows-ansi-codepage}@anchor{25be}@anchor{library/codecs module-encodings mbcs}@anchor{53}
@subsubsection @code{encodings.mbcs} — Windows ANSI codepage


@geindex module; encodings.mbcs

This module implements the ANSI codepage (CP_ACP).

@ref{1ed8,,Disponibilidade}: Windows.


Alterado na versão 3.2: Before 3.2, the `errors' argument was ignored; @code{'replace'} was always used
to encode, and @code{'ignore'} to decode.



Alterado na versão 3.3: Support any error handler.


@node encodings utf_8_sig — UTF-8 codec with BOM signature,,encodings mbcs — Windows ANSI codepage,codecs — Codec registry and base classes
@anchor{library/codecs encodings-utf-8-sig-utf-8-codec-with-bom-signature}@anchor{25bf}@anchor{library/codecs module-encodings utf_8_sig}@anchor{54}
@subsubsection @code{encodings.utf_8_sig} — UTF-8 codec with BOM signature


@geindex module; encodings.utf_8_sig

This module implements a variant of the UTF-8 codec. On encoding, a UTF-8 encoded
BOM will be prepended to the UTF-8 encoded bytes. For the stateful encoder this
is only done once (on the first write to the byte stream). On decoding, an
optional UTF-8 encoded BOM at the start of the data will be skipped.

@node Tipos de Dados,Módulos Matemáticos e Numéricos,Serviços de Dados Binários,A Biblioteca Padrão do Python
@anchor{library/datatypes doc}@anchor{25c0}@anchor{library/datatypes data-types}@anchor{25c1}@anchor{library/datatypes datatypes}@anchor{25c2}@anchor{library/datatypes translation-repo}@anchor{25c3}
@section Tipos de Dados


Os módulos descritos neste capítulo fornecem uma variedade de tipos de dados especializados, como datas e horas, vetores de tipo fixo, filas de heap, filas de extremidade dupla e enumerações.

O Python também fornece alguns tipos de dados embutidos, em especial @ref{256,,dict}, @ref{611,,list}, @ref{5d9,,set} e @ref{5da,,frozenset} e @ref{370,,tuple}. A classe @ref{44c,,str} é usada para armazenar strings Unicode, e as classes @ref{1c2,,bytes} e @ref{2ea,,bytearray} são usadas para armazenar dados binários.

Os seguintes módulos estão documentados neste capítulo:

@menu
* datetime — Tipos básicos de data e hora:: 
* zoneinfo — Suporte a fuso horário da IANA:: 
* calendar — Funções gerais relacionadas ao calendário:: 
* collections — Tipos de dados de contêineres:: 
* collections.abc — Classes Base Abstratas para Contêineres: collections abc — Classes Base Abstratas para Contêineres. 
* heapq — Algoritmo de fila heap:: 
* bisect — Algoritmo de bisseção de vetor:: 
* array— Vetores eficientes de valores numéricos:: 
* weakref — Referências fracas:: 
* types — Criação de tipos dinâmicos e nomes para tipos embutidos:: 
* copy — Operações de cópia profunda e cópia rasa:: 
* pprint — Impressão bonita de dados:: 
* reprlib — Implementação alternativa à repr(): reprlib — Implementação alternativa à repr. 
* enum — Suporte a enumerações:: 
* graphlib — Funcionalidade para operar com estruturas do tipo grafo:: 

@end menu

@node datetime — Tipos básicos de data e hora,zoneinfo — Suporte a fuso horário da IANA,,Tipos de Dados
@anchor{library/datetime doc}@anchor{25c4}@anchor{library/datetime datetime-basic-date-and-time-types}@anchor{25c5}@anchor{library/datetime module-datetime}@anchor{30}
@subsection @code{datetime} — Tipos básicos de data e hora


@geindex module; datetime

`Código-fonte:' Lib/datetime.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/datetime.py}


__________________________________________________________________


@c XXX what order should the types be discussed in?

O módulo @code{datetime} fornece as classes para manipulação de datas e horas.

Ainda que a aritmética de data e hora seja suportada, o foco da implementação é na extração eficiente do atributo para formatação da saída e manipulação.

@cartouche
@quotation Dica 
Pular para @ref{25c6,,os códigos de formatação}.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item Módulo @ref{14,,calendar}

Funções gerais relacionadas ao calendário.

@item Módulo @ref{ee,,time}

Acesso de hora e conversões.

@item Módulo @ref{134,,zoneinfo}

Fusos horários concretos representando o banco de dados de fusos horários IANA.

@item Pacote dateutil@footnote{https://dateutil.readthedocs.io/en/stable/}

Biblioteca de terceiros com fuso horário expandido e suporte à análise.

@item Pacote DateType@footnote{https://pypi.org/project/DateType/}

Biblioteca de terceiros que apresenta tipos estáticos distintos para, por exemplo, permitir que @ref{26d,,verificadores de tipo estático} diferenciem datas ingênuas e conscientes.
@end table


@menu
* Objetos Conscientes e Ingênuos:: 
* Constantes:: 
* Tipos disponíveis:: 
* Objetos timedelta:: 
* Objetos date:: 
* Objetos datetime:: 
* Objetos time:: 
* Objetos tzinfo:: 
* Objetos timezone:: 
* Comportamento de strftime() e strptime(): Comportamento de strftime e strptime. 

@end menu

@node Objetos Conscientes e Ingênuos,Constantes,,datetime — Tipos básicos de data e hora
@anchor{library/datetime aware-and-naive-objects}@anchor{25c7}@anchor{library/datetime datetime-naive-aware}@anchor{25c8}
@subsubsection Objetos Conscientes e Ingênuos


Objetos de data e hora podem ser categorizados como “consciente” ou “ingênuo” dependendo se eles incluem ou não informação sobre fuso horário.

Com conhecimento suficiente dos ajustes de tempo algorítmicos e políticos aplicáveis, como informações de fuso horário e horário de verão, um objeto `consciente' pode se localizar em relação a outros objetos conscientes. Um objeto consciente representa um momento específico no tempo que não está aberto à interpretação. @footnote{
Se, isto é, nós ignoramos os efeitos da Relatividade
}

Um objeto `ingênuo' não contém informações suficientes para se localizar inequivocamente em relação a outros objetos de data/hora. Se um objeto ingênuo representa o Coordinated Universal Time (UTC), a hora local, ou a hora em algum outro fuso horário, isso depende exclusivamente do programa, assim como é tarefa do programa decidir se um número específico representa metros, milhas ou massa. Objetos ingênuos são fáceis de entender e trabalhar, com o custo de ignorar alguns aspectos da realidade.

Para aplicativos que requerem objetos conscientes, os objetos @ref{1cc,,datetime} e @ref{1ce,,time} possuem um atributo opcional de informações do fuso horário, @code{tzinfo}, que pode ser definido como uma instância de uma subclasse da classe abstrata @ref{5de,,tzinfo}. Esses objetos @ref{5de,,tzinfo} capturam informações sobre a diferença da hora UTC, o nome do fuso horário e se o horário de verão está em vigor.

Somente uma classe concreta @ref{5de,,tzinfo}, a classe @ref{10fe,,timezone}, é fornecida pelo módulo @code{datetime}. A classe @code{timezone} pode representar fusos horários simples com diferenças fixas do UTC, como o próprio UTC, ou os fusos horários norte-americanos EST e EDT. O suporte a fusos horários em níveis mais detalhados depende da aplicação. As regras para ajuste de tempo em todo o mundo são mais políticas do que racionais, mudam com frequência e não há um padrão adequado para todas as aplicações além da UTC.

@node Constantes,Tipos disponíveis,Objetos Conscientes e Ingênuos,datetime — Tipos básicos de data e hora
@anchor{library/datetime constants}@anchor{25c9}
@subsubsection Constantes


O módulo @code{datetime} exporta as seguintes constantes:

@geindex MINYEAR (no módulo datetime)
@anchor{library/datetime datetime MINYEAR}@anchor{25ca}
@deffn {Dado} datetime.MINYEAR

O menor número de ano permitido em um objeto @ref{1cd,,date} ou @ref{1cc,,datetime}. @ref{25ca,,MINYEAR} é 1.
@end deffn

@geindex MAXYEAR (no módulo datetime)
@anchor{library/datetime datetime MAXYEAR}@anchor{25cb}
@deffn {Dado} datetime.MAXYEAR

O maior número de ano permitido no objeto @ref{1cd,,date} ou @ref{1cc,,datetime}. @ref{25cb,,MAXYEAR} é 9999.
@end deffn

@geindex UTC (no módulo datetime)
@anchor{library/datetime datetime UTC}@anchor{4ee}
@deffn {Dado} datetime.UTC

Apelido para o singleton de fuso horário UTC @ref{614,,datetime.timezone.utc}.


Adicionado na versão 3.11.

@end deffn

@node Tipos disponíveis,Objetos timedelta,Constantes,datetime — Tipos básicos de data e hora
@anchor{library/datetime available-types}@anchor{25cc}
@subsubsection Tipos disponíveis



@deffn {Classe} datetime.date

Uma data ingênua idealizada, presumindo que o atual calendário Gregoriano sempre foi, e sempre estará em vigor. Atributos: @ref{25cd,,year}, @ref{25ce,,month} e @ref{25cf,,day}.
@end deffn


@deffn {Classe} datetime.time

Um horário ideal, independente de qualquer dia em particular, presumindo que todos os dias tenham exatamente 24*60*60 segundos. (Não há noção de “segundos bissextos” aqui.) Atributos: @ref{25d0,,hour}, @ref{25d1,,minute}, @ref{25d2,,second}, @ref{25d3,,microsecond} e @ref{25d4,,tzinfo}.
@end deffn


@deffn {Classe} datetime.datetime

Uma combinação de uma data e uma hora. Atributos: @ref{25d5,,year}, @ref{25d6,,month}, @ref{25d7,,day}, @ref{25d8,,hour}, @ref{25d9,,minute}, @ref{25da,,second}, @ref{25db,,microsecond} e @ref{25dc,,tzinfo}.
@end deffn


@deffn {Classe} datetime.timedelta

Uma duração que expressa a diferença entre duas instâncias @ref{1cc,,datetime} ou @ref{1cd,,date} para resolução de microssegundos.
@end deffn


@deffn {Classe} datetime.tzinfo

Uma classe base abstrata para objetos de informações de fuso horário. Eles são usados pelas classes @ref{1cc,,datetime} e @ref{1ce,,time} para fornecer uma noção personalizável de ajuste de horário (por exemplo, para considerar o fuso horário e/ou o horário de verão).
@end deffn


@deffn {Classe} datetime.timezone

Uma classe que implementa a classe base abstrata @ref{5de,,tzinfo} como uma diferença fixa do UTC.


Adicionado na versão 3.2.

@end deffn

Objetos desse tipo são imutáveis.

Relacionamentos de subclasse:

@example
object
    timedelta
    tzinfo
        timezone
    time
    date
        datetime
@end example

@menu
* Propriedades Comuns:: 
* Determinando se um Objeto é Consciente ou Ingênuo:: 

@end menu

@node Propriedades Comuns,Determinando se um Objeto é Consciente ou Ingênuo,,Tipos disponíveis
@anchor{library/datetime common-properties}@anchor{25dd}
@subsubsection Propriedades Comuns


Os tipos @ref{1cd,,date}, @ref{1cc,,datetime}, @ref{1ce,,time} e @ref{10fe,,timezone} compartilham esses recursos comuns:


@itemize -

@item 
Objetos desse tipo são imutáveis.

@item 
Objetos desses tipos são @ref{610,,hasheáveis}, o que significa que podem ser usados como chaves de dicionário.

@item 
Objetos desse tipo suportam decapagem eficiente através do módulo @ref{a6,,pickle}.
@end itemize

@node Determinando se um Objeto é Consciente ou Ingênuo,,Propriedades Comuns,Tipos disponíveis
@anchor{library/datetime determining-if-an-object-is-aware-or-naive}@anchor{25de}
@subsubsection Determinando se um Objeto é Consciente ou Ingênuo


Objetos do tipo @ref{1cd,,date} são sempre ingênuos.

Um objeto do tipo @ref{1ce,,time} ou @ref{1cc,,datetime} pode ser consciente ou ingênuo.

O objeto @ref{1cc,,datetime} @code{d} é consciente se ambos os seguintes itens forem verdadeiros:


@enumerate 

@item 
@code{d.tzinfo} não é @code{None}

@item 
@code{d.tzinfo.utcoffset(d)} não retorna @code{None}
@end enumerate

Caso contrário, @code{d} é ingênuo.

O objeto @ref{1ce,,time} @code{t} é consciente, se os seguintes itens são verdadeiros:


@enumerate 

@item 
@code{t.tzinfo} não é @code{None}

@item 
@code{t.tzinfo.utcoffset(None)} não retorna @code{None}.
@end enumerate

Caso contrário, @code{t} é ingênuo.

A distinção entre consciente e ingênuo não se aplica a objetos @ref{9d7,,timedelta}.

@node Objetos timedelta,Objetos date,Tipos disponíveis,datetime — Tipos básicos de data e hora
@anchor{library/datetime datetime-timedelta}@anchor{25df}@anchor{library/datetime timedelta-objects}@anchor{25e0}
@subsubsection Objetos @code{timedelta}


O objeto @ref{9d7,,timedelta} representa uma duração, a diferença entre duas instâncias @ref{1cc,,datetime} ou @ref{1cd,,date}.

@geindex timedelta (classe em datetime)
@anchor{library/datetime datetime timedelta}@anchor{9d7}
@deffn {Classe} datetime.timedelta (days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

Todos os argumentos são opcionais e o padrão é 0. Os argumentos podem ser números inteiros ou ponto flutuantes, e podem ser positivos ou negativos.

Apenas `days', `seconds' e `microseconds' são armazenados internamente. Os argumentos são convertidos para essas unidades:


@itemize *

@item 
Um milissegundo é convertido em 1000 microssegundos.

@item 
Um minuto é convertido em 60 segundos.

@item 
Uma hora é convertida em 3600 segundos.

@item 
Uma semana é convertida para 7 dias.
@end itemize

e dias, segundos e microssegundos são normalizados para que a representação seja única, com


@itemize *

@item 
@code{0 <= microseconds < 1000000}

@item 
@code{0 <= seconds < 3600*24} (o número de segundos em um dia)

@item 
@code{-999999999 <= days <= 999999999}
@end itemize

O exemplo a seguir ilustra como quaisquer argumentos além de `days', `seconds' e `microseconds' são “mesclados” e normalizados nos três atributos resultantes:

@example
>>> from datetime import timedelta
>>> delta = timedelta(
...     days=50,
...     seconds=27,
...     microseconds=10,
...     milliseconds=29000,
...     minutes=5,
...     hours=8,
...     weeks=2
... )
>>> # sá restam dias, segundos e microssegundos
>>> delta
datetime.timedelta(days=64, seconds=29156, microseconds=10)
@end example

Se qualquer argumento for um ponto flutuante e houver microssegundos fracionários, os microssegundos fracionários restantes de todos os argumentos serão combinados e sua soma será arredondada para o microssegundo mais próximo usando o desempatador de metade da metade para o par. Se nenhum argumento é ponto flutuante, os processos de conversão e normalização são exatos (nenhuma informação é perdida).

Se o valor normalizado de dias estiver fora do intervalo indicado, a exceção @ref{885,,OverflowError} é levantada.

Observe que a normalização de valores negativos pode ser surpreendente a princípio. Por exemplo:

@example
>>> from datetime import timedelta
>>> d = timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)
@end example

Como a representação de string dos objetos @code{timedelta} pode ser confusa, use a seguinte receita para produzir um formato mais legível:

@example
>>> def pretty_timedelta(td):
...     if td.days >= 0:
...         return str(td)
...     return f'-(@{-td!s@})'
...
>>> d = timedelta(hours=-1)
>>> str(d)  # not human-friendly
'-1 day, 23:00:00'
>>> pretty_timedelta(d)
'-(1:00:00)'
@end example
@end deffn

Atributos de classe:

@geindex min (atributo datetime.timedelta)
@anchor{library/datetime datetime timedelta min}@anchor{25e1}
@deffn {Atributo} timedelta.min

O mais negativo objeto @ref{9d7,,timedelta}, @code{timedelta(-999999999)}.
@end deffn

@geindex max (atributo datetime.timedelta)
@anchor{library/datetime datetime timedelta max}@anchor{25e2}
@deffn {Atributo} timedelta.max

O mais positivo objeto @ref{9d7,,timedelta}, @code{timedelta(days=999999999, hours=23, minutes=59, seconds=59, microseconds=999999)}.
@end deffn

@geindex resolution (atributo datetime.timedelta)
@anchor{library/datetime datetime timedelta resolution}@anchor{25e3}
@deffn {Atributo} timedelta.resolution

A menor diferença possível entre objetos não iguais @ref{9d7,,timedelta}, @code{timedelta(microseconds=1)}.
@end deffn

Observe que, devido à normalização, @code{timedelta.max} é maior que @code{-timedelta.min}. @code{-timedelta.max} não é representável como um objeto @ref{9d7,,timedelta}.

Atributos de instância (somente leitura):

@geindex days (atributo datetime.timedelta)
@anchor{library/datetime datetime timedelta days}@anchor{25e4}
@deffn {Atributo} timedelta.days

Entre -999.999.999 e 999.999.999 inclusive
@end deffn

@geindex seconds (atributo datetime.timedelta)
@anchor{library/datetime datetime timedelta seconds}@anchor{25e5}
@deffn {Atributo} timedelta.seconds

Entre 0 e 86.399 inclusive.

@cartouche
@quotation Cuidado 
É um bug relativamente comum utilizar este atributo de forma não intencional quando, na verdade, o objetivo é obter o valor de @ref{134a,,total_seconds()}:

@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 datetime.timedelta)
@anchor{library/datetime datetime timedelta microseconds}@anchor{25e6}
@deffn {Atributo} timedelta.microseconds

Entre 0 e 999.999 inclusive.
@end deffn

Operações suportadas:

@c XXX this table is too wide!


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@item

@code{t1 = t2 + t3}

@tab

Soma de @code{t2} e @code{t3}. Depois @code{t1 - t2 == t3} e @code{t1 - t3 == t2} são verdadeiros. (1)

@item

@code{t1 = t2 - t3}

@tab

Diferença de @code{t2} e @code{t3}. Depois @code{t1 == t2 - t3} e @code{t2 == t1 + t3} são verdadeiros (1)(6)

@item

@code{t1 = t2 * i or t1 = i * t2}

@tab

Delta multiplicado por um número inteiro. Depois @code{t1 // i == t2} é verdadeiro, desde que @code{i != 0}.

@item

@tab

Em geral, @code{t1 * i == t1 * (i-1) + t1} é verdadeiro. (1)

@item

@code{t1 = t2 * f or t1 = f * t2}

@tab

Delta multiplicado por um float, ponto flutuante. O resultado é arredondado para o múltiplo mais próximo de timedelta.resolution usando a metade da metade para o par.

@item

@code{f = t2 / t3}

@tab

Divisão (3) da duração total @code{t2} por unidade de intervalo @code{t3}. Retorna um objeto @ref{2f7,,float}.

@item

@code{t1 = t2 / f or t1 = t2 / i}

@tab

Delta dividido por um float ou um int. O resultado é arredondado para o múltiplo mais próximo de timedelta.resolution usando a metade da metade para o par.

@item

@code{t1 = t2 // i} ou @code{t1 = t2 // t3}

@tab

O piso é calculado e o restante (se houver) é jogado fora. No segundo caso, um número inteiro é retornado. (3)

@item

@code{t1 = t2 % t3}

@tab

O restante é calculado como um objeto @ref{9d7,,timedelta}. (3)

@item

@code{q, r = divmod(t1, t2)}

@tab

Calcula o quociente e o resto: @code{q = t1 // t2} (3) e @code{r = t1 % t2}. @code{q} é um inteiro e @code{r} é um objeto @ref{9d7,,timedelta}.

@item

@code{+t1}

@tab

Retorna um objeto @ref{9d7,,timedelta} com o mesmo valor. (2)

@item

@code{-t1}

@tab

Equivalente a @code{timedelta(-t1.days, -t1.seconds, -t1.microseconds)} e a @code{t1 * -1}. (1)(4)

@item

@code{abs(t)}

@tab

Equivalente a @code{+t} quando @code{t.days >= 0} e a @code{-t} quando @code{t.days < 0}. (2)

@item

@code{str(t)}

@tab

Retorna uma string no formato @code{[D day[s], ][H]H:MM:SS[.UUUUUU]}, onde D é negativo para @code{t} negativo. (5)

@item

@code{repr(t)}

@tab

Retorna uma representação em string do objeto @ref{9d7,,timedelta} como uma chamada do construtor com valores de atributos canônicos.

@end multitable


Notas:


@enumerate 

@item 
Isso é exato, mas pode transbordar.

@item 
Isso é exato e não pode transbordar.

@item 
A divisão por zero levanta @ref{94c,,ZeroDivisionError}.

@item 
@code{-timedelta.max} não é representável como um objeto @ref{9d7,,timedelta}.

@item 
As representações de string de objetos @ref{9d7,,timedelta} são normalizadas de maneira semelhante à sua representação interna. Isso leva a resultados um tanto incomuns para timedeltas negativos. Por exemplo:

@example
>>> timedelta(hours=-5)
datetime.timedelta(days=-1, seconds=68400)
>>> print(_)
-1 day, 19:00:00
@end example

@item 
A expressão @code{t2 - t3} sempre será igual à expressão @code{t2 + (-t3)} exceto quando t3 for igual a @code{timedelta.max}; nesse caso, o primeiro produzirá um resultado enquanto o último transbordará.
@end enumerate

Além das operações listadas acima, os objetos @ref{9d7,,timedelta} suportam certas adições e subtrações com os objetos @ref{1cd,,date} e @ref{1cc,,datetime} (veja abaixo).


Alterado na versão 3.2: A divisão pelo piso e a divisão verdadeira de um objeto @ref{9d7,,timedelta} por outro objeto @ref{9d7,,timedelta} agora são suportadas, assim como as operações restantes e a função @ref{9a9,,divmod()}. A divisão verdadeira e multiplicação de um objeto @ref{9d7,,timedelta} por um objeto @ref{2f7,,float} agora são suportadas.


Objetos @ref{9d7,,timedelta} dão suporte a comparações de igualdade e ordem.

Em contexto booleano, um objeto @ref{9d7,,timedelta} é considerado verdadeiro se, e somente se, não for igual a @code{timedelta(0)}.

Métodos de instância:

@geindex total_seconds() (método datetime.timedelta)
@anchor{library/datetime datetime timedelta total_seconds}@anchor{134a}
@deffn {Método} timedelta.total_seconds ()

Retorna o número total de segundos contidos na duração. Equivalente a @code{td / timedelta(seconds=1)}. Para unidades de intervalo diferentes de segundos, use a forma de divisão diretamente (por exemplo @code{td / timedelta(microseconds=1)}).

Observe que, em intervalos de tempo muito grandes (mais de 270 anos na maioria das plataformas), esse método perde a precisão de microssegundos.


Adicionado na versão 3.2.

@end deffn

@menu
* Exemplos de uso; timedelta: Exemplos de uso timedelta. 

@end menu

@node Exemplos de uso timedelta,,,Objetos timedelta
@anchor{library/datetime examples-of-usage-timedelta}@anchor{25e7}
@subsubsection Exemplos de uso: @code{timedelta}


Um exemplo adicional de normalização:

@example
>>> # Os componentes de outro_ano somam exatamente 365 dias
>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> outro_ano = timedelta(weeks=40, days=84, hours=23,
...                       minutes=50, seconds=600)
>>> year == outro_ano
True
>>> year.total_seconds()
31536000.0
@end example

Exemplos de aritmética com @ref{9d7,,timedelta}:

@example
>>> from datetime import timedelta
>>> ano = timedelta(days=365)
>>> dez_anos = 10 * ano
>>> dez_anos
datetime.timedelta(days=3650)
>>> dez_anos.days // 365
10
>>> nove_anos = dez_anos - ano
>>> nove_anos
datetime.timedelta(days=3285)
>>> três_anos = nove_anos // 3
>>> três_anos, três_anos.days // 365
(datetime.timedelta(days=1095), 3)
@end example

@node Objetos date,Objetos datetime,Objetos timedelta,datetime — Tipos básicos de data e hora
@anchor{library/datetime date-objects}@anchor{25e8}@anchor{library/datetime datetime-date}@anchor{25e9}
@subsubsection Objetos @code{date}


O objeto @ref{1cd,,date} representa uma data (ano, mês e dia) em um calendário idealizado, o atual calendário Gregoriano estendido indefinidamente em ambas as direções.

1º de janeiro do ano 1 é chamado de dia número 1, 2º de janeiro do ano 1 é chamado de dia número 2, e assim por diante. @footnote{
Isso combina com a definição do calendário “proléptico Gregoriano” no livro `Cálculos Calendáricos' de Dershowitz e Reingold, onde ele é o calendário base para todas as computações. Veja o livro para algoritmos para conversão entre ordinais proléptico Gregoriano e muitos outros sistemas de calendário.
}

@geindex date (classe em datetime)
@anchor{library/datetime datetime date}@anchor{1cd}
@deffn {Classe} datetime.date (year, month, day)

Todos os argumentos são obrigatórios. Os argumentos devem ser números inteiros, nos seguintes intervalos:


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR}

@item 
@code{1 <= month <= 12}

@item 
@code{1 <= day <= número de dias no mês e ano fornecidos}
@end itemize

Se um argumento fora desses intervalos for fornecido, a exceção @ref{202,,ValueError} é levantada.
@end deffn

Outros construtores, todos os métodos de classe.

@geindex today() (método de classe datetime.date)
@anchor{library/datetime datetime date today}@anchor{1512}
@deffn {Método} classmethod date.today ()

Retorna a data local atual.

Isso é equivalente a @code{date.fromtimestamp(time.time())}.
@end deffn

@geindex fromtimestamp() (método de classe datetime.date)
@anchor{library/datetime datetime date fromtimestamp}@anchor{bed}
@deffn {Método} classmethod date.fromtimestamp (timestamp)

Retorna a data local correspondente ao registro de data e hora do POSIX, como é retornado por @ref{254,,time.time()}.

Isso pode levantar @ref{885,,OverflowError}, se o registro de data e hora estiver fora do intervalo de valores suportados pela função C @code{localtime()} da plataforma, e em caso de falha @ref{417,,OSError} em @code{localtime()}. É comum que isso seja restrito a anos de 1970 a 2038. Observe que, em sistemas não POSIX que incluem segundos bissextos na sua notação de registro de data e hora, os segundos bissextos são ignorados por @ref{bed,,fromtimestamp()}.


Alterado na versão 3.3: Levanta @ref{885,,OverflowError} ao invés de @ref{202,,ValueError} se o registro de data e hora estiver fora do intervalo de valores suportados pela plataforma C @code{localtime()} função. Levanta @ref{417,,OSError} ao invés de @ref{202,,ValueError} em falha de @code{localtime()} .

@end deffn

@geindex fromordinal() (método de classe datetime.date)
@anchor{library/datetime datetime date fromordinal}@anchor{bec}
@deffn {Método} classmethod date.fromordinal (ordinal)

Retorna a data correspondente ao ordinal proléptico gregoriano, considerando que 1º de janeiro do ano 1 tem o ordinal 1.

@ref{202,,ValueError} é levantado a menos que @code{1 <= ordinal <= date.max.toordinal()}. Para qualquer data @code{d}, @code{date.fromordinal(d.toordinal()) == d}.
@end deffn

@geindex fromisoformat() (método de classe datetime.date)
@anchor{library/datetime datetime date fromisoformat}@anchor{615}
@deffn {Método} classmethod date.fromisoformat (date_string)

Retorna um @ref{1cd,,date} correspondendo a `date_string' dada em qualquer formato válido de ISO 8601, com as seguintes exceções:


@enumerate 

@item 
Datas de precisão reduzida não são atualmente suportadas (@code{YYYY-MM}, @code{YYYY}).

@item 
Representações de data estendidas não são atualmente suportadas (@code{±YYYYYY-MM-DD}).

@item 
Atualmente, as datas ordinais não são suportadas (@code{YYYY-OOO}).
@end enumerate

Exemplos:

@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


Adicionado na versão 3.7.



Alterado na versão 3.11: Anteriormente, este método tinha suporte apenas ao formato @code{YYYY-MM-DD}.

@end deffn

@geindex fromisocalendar() (método de classe datetime.date)
@anchor{library/datetime datetime date fromisocalendar}@anchor{9f4}
@deffn {Método} classmethod date.fromisocalendar (year, week, day)

Retorna um objeto @ref{1cd,,date} correspondendo a data em calendário ISO especificada por year, week e day. Esta é o inverso da função @ref{8fb,,date.isocalendar()}.


Adicionado na versão 3.8.

@end deffn

Atributos de classe:

@geindex min (atributo datetime.date)
@anchor{library/datetime datetime date min}@anchor{25ea}
@deffn {Atributo} date.min

A data representável mais antiga, @code{date(MINYEAR, 1, 1)}.
@end deffn

@geindex max (atributo datetime.date)
@anchor{library/datetime datetime date max}@anchor{25eb}
@deffn {Atributo} date.max

A data representável mais tardia, @code{date(MAXYEAR, 12, 31)}.
@end deffn

@geindex resolution (atributo datetime.date)
@anchor{library/datetime datetime date resolution}@anchor{25ec}
@deffn {Atributo} date.resolution

A menor diferença possível entre objetos date não iguais, @code{timedelta(days=1)}.
@end deffn

Atributos de instância (somente leitura):

@geindex year (atributo datetime.date)
@anchor{library/datetime datetime date year}@anchor{25cd}
@deffn {Atributo} date.year

Entre @ref{25ca,,MINYEAR} e @ref{25cb,,MAXYEAR} incluindo extremos.
@end deffn

@geindex month (atributo datetime.date)
@anchor{library/datetime datetime date month}@anchor{25ce}
@deffn {Atributo} date.month

Entre 1 e 12 incluindo extremos.
@end deffn

@geindex day (atributo datetime.date)
@anchor{library/datetime datetime date day}@anchor{25cf}
@deffn {Atributo} date.day

Entre 1 e o número de dias no mês especificado do ano especificado.
@end deffn

Operações suportadas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Resultado

@item

@code{date2 = date1 + timedelta}

@tab

@code{date2} terá @code{timedelta.days} dias após @code{date1}. (1)

@item

@code{date2 = date1 - timedelta}

@tab

Calcula @code{date2} de modo que @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

Comparação de igualdade. (4)

@item


@display
@code{date1 < date2}@w{ }
@code{date1 > date2}@w{ }
@code{date1 <= date2}@w{ }
@code{date1 >= date2}@w{ }
@end display



@tab

Comparação de ordem. (5)

@end multitable


Notas:


@enumerate 

@item 
`date2' é movida para frente no tempo se @code{timedelta.days > 0}, ou para trás se @code{timedelta.days < 0}. Posteriormente @code{date2 - date1 == timedelta.days}. @code{timedelta.seconds} e @code{timedelta.microseconds} são ignorados. A exceção @ref{885,,OverflowError} é levantada se @code{date2.year} for menor que @ref{25ca,,MINYEAR} ou maior que @ref{25cb,,MAXYEAR}.

@item 
@code{timedelta.seconds} e @code{timedelta.microseconds} são ignoradas.

@item 
Isso é exato e não pode estourar. @code{timedelta.seconds} e @code{timedelta.microseconds} são 0, e @code{date2 + timedelta == date1} depois.

@item 
Objetos @ref{1cd,,date} são iguais se representam a mesma data.

Objetos @code{date} que não são também instâncias @ref{1cc,,datetime} nunca são iguais a objetos @code{datetime}, mesmo que representem a mesma data.

@item 
`date1' é considerado menor que `date2' quando `date1' preceder `date2' no tempo. Em outras palavras, @code{date1 < date2} se e somente se @code{date1.toordinal() < date2.toordinal()}.

A comparação de ordem entre um objeto @code{date} que não é também uma instância @ref{1cc,,datetime} e um objeto @code{datetime} levanta @ref{2c3,,TypeError}.
@end enumerate


Alterado na versão 3.13: A comparação entre o objeto @ref{1cc,,datetime} e uma instância da subclasse @ref{1cd,,date} que não é uma subclasse @code{datetime} não converte mais a última para @code{date}, ignorando o parte horária e o fuso horário. O comportamento padrão pode ser alterado substituindo os métodos especiais de comparação nas subclasses.


Em contextos booleanos, todo objeto @ref{1cd,,date} é considerado verdadeiro.

Métodos de instância:

@geindex replace() (método datetime.date)
@anchor{library/datetime datetime date replace}@anchor{1773}
@deffn {Método} date.replace (year=self.year, month=self.month, day=self.day)

Retorna um novo objeto @ref{1cd,,date} com os mesmos valores, mas com os parâmetros especificados atualizados.

Exemplo:

@example
>>> from datetime import date
>>> d = date(2002, 12, 31)
>>> d.replace(day=26)
datetime.date(2002, 12, 26)
@end example

A função genérica @ref{151,,copy.replace()} também oferece suporte a objetos @ref{1cd,,date}.
@end deffn

@geindex timetuple() (método datetime.date)
@anchor{library/datetime datetime date timetuple}@anchor{25ed}
@deffn {Método} date.timetuple ()

Retorna uma @ref{d0b,,time.struct_time} tal como retornado por @ref{1541,,time.localtime()}.

As horas, minutos e segundos são 0, e o sinalizador de horário de verão é -1.

@code{d.timetuple()} é equivalente a:

@example
time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))
@end example

sendo @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1} o número do dia no ano atual, começando com 1 para 1º de janeiro.
@end deffn

@geindex toordinal() (método datetime.date)
@anchor{library/datetime datetime date toordinal}@anchor{25ee}
@deffn {Método} date.toordinal ()

Retorna o ordinal proléptico gregoriano da data, considerando que 1º de janeiro do ano 1 tem o ordinal 1. Para qualquer objeto @ref{1cd,,date} @code{d}, @code{date.fromordinal(d.toordinal()) == d}.
@end deffn

@geindex weekday() (método datetime.date)
@anchor{library/datetime datetime date weekday}@anchor{25ef}
@deffn {Método} date.weekday ()

Retorna o dia da semana como um inteiro, onde Segunda é 0 e Domingo é 6. Por exemplo, @code{date(2002, 12, 4).weekday() == 2}, uma Quarta-feira. Veja também @ref{25f0,,isoweekday()}.
@end deffn

@geindex isoweekday() (método datetime.date)
@anchor{library/datetime datetime date isoweekday}@anchor{25f0}
@deffn {Método} date.isoweekday ()

Retorna o dia da semana como um inteiro, onde Segunda é 1 e Domingo é 7. Por exemplo, @code{date(2002, 12, 4).isoweekday() == 3}, uma Quarta-feira. Veja também @ref{25ef,,weekday()}, @ref{8fb,,isocalendar()}.
@end deffn

@geindex isocalendar() (método datetime.date)
@anchor{library/datetime datetime date isocalendar}@anchor{8fb}
@deffn {Método} date.isocalendar ()

Retorna um objeto @ref{64e,,tupla nomeada} com três componentes: @code{year}, @code{week} e @code{weekday}.

O calendário ISO é uma variação amplamente usada do calendário gregoriano. @footnote{
Veja @uref{https://web.archive.org/web/20220531051136/https://webspace.science.uu.nl/~gent0113/calendar/isocalendar.htm,O guia para a matemática de calendário ISO 8601} de R. H. van Gent para uma boa explicação.
}

O ano ISO consiste de 52 ou 53 semanas completas, e onde uma semana começa na segunda-feira e termina no domingo. A primeira semana de um ano ISO é a primeira semana no calendário (Gregoriano) de um ano contendo uma quinta-feira. Isso é chamado de semana número 1, e o ano ISO dessa quinta-feira é o mesmo que o seu ano Gregoriano.

Por exemplo, 2004 começa em uma quinta-feira, então a primeira semana do ano ISO 2004 começa na segunda-feira, 29 de dezembro de 2003, e termina no domingo, 4 de janeiro 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


Alterado na versão 3.9: Resultado alterado de uma tupla para uma @ref{64e,,tupla nomeada}.

@end deffn

@geindex isoformat() (método datetime.date)
@anchor{library/datetime datetime date isoformat}@anchor{25f1}
@deffn {Método} date.isoformat ()

Retorna uma string representando a data no formato ISO 8601, @code{YYYY-MM-DD}:

@example
>>> from datetime import date
>>> date(2002, 12, 4).isoformat()
'2002-12-04'
@end example
@end deffn

@geindex __str__() (método datetime.date)
@anchor{library/datetime datetime date __str__}@anchor{25f2}
@deffn {Método} date.__str__ ()

Para um data @code{d}, @code{str(d)} é equivalente a @code{d.isoformat()}.
@end deffn

@geindex ctime() (método datetime.date)
@anchor{library/datetime datetime date ctime}@anchor{25f3}
@deffn {Método} date.ctime ()

Retorna uma string representando a data:

@example
>>> from datetime import date
>>> date(2002, 12, 4).ctime()
'Wed Dec  4 00:00:00 2002'
@end example

@code{d.ctime()} é equivalente a:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

em plataformas em que a função C nativa @code{ctime()} (que é invocada pela função @ref{25f4,,time.ctime()}, mas não pelo método @ref{25f3,,date.ctime()}) se conforma com o padrão C.
@end deffn

@geindex strftime() (método datetime.date)
@anchor{library/datetime datetime date strftime}@anchor{cb0}
@deffn {Método} date.strftime (format)

Retorna uma string representando a data, controlado por uma string explícita de formatação. Códigos de formatação referenciando horas, minutos ou segundos irão ver valores 0. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{25f1,,date.isoformat()}.
@end deffn

@geindex __format__() (método datetime.date)
@anchor{library/datetime datetime date __format__}@anchor{25f5}
@deffn {Método} date.__format__ (format)

O mesmo que @ref{cb0,,date.strftime()}. Isso torna possível especificar uma string de formatação para o objeto @ref{1cd,,date} em @ref{9b1,,literais de string formatados} e ao usar @ref{621,,str.format()}. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{25f1,,date.isoformat()}.
@end deffn

@menu
* Exemplos de uso; date: Exemplos de uso date. 

@end menu

@node Exemplos de uso date,,,Objetos date
@anchor{library/datetime examples-of-usage-date}@anchor{25f6}
@subsubsection Exemplos de uso: @code{date}


Exemplo de contagem de dias para um evento:

@example
>>> import time
>>> from datetime import date
>>> hoje = date.today()
>>> hoje
datetime.date(2007, 12, 5)
>>> hoje == date.fromtimestamp(time.time())
True
>>> meu_aniversário = date(hoje.year, 6, 24)
>>> if meu_aniversário < hoje:
...     meu_aniversário = meu_aniversário.replace(year=hoje.year + 1)
...
>>> meu_aniversário
datetime.date(2008, 6, 24)
>>> tempo_até_aniversário = abs(meu_aniversário - hoje)
>>> tempo_até_aniversário.days
202
@end example

Mais exemplos de uso da classe @ref{1cd,,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,Objetos date,datetime — Tipos básicos de data e hora
@anchor{library/datetime datetime-datetime}@anchor{25f7}@anchor{library/datetime datetime-objects}@anchor{25f8}
@subsubsection Objetos @code{datetime}


Um objeto @ref{1cc,,datetime} é um único objeto contendo todas as informações de um objeto @ref{1cd,,date} e um objeto @ref{1ce,,time}.

Assim como um objeto @ref{1cd,,date}, @ref{1cc,,datetime} presume o atual calendário Gregoriano estendido em ambas as direções; assim como um objeto @ref{1ce,,time}, @ref{1cc,,datetime} presume que existem exatamente 3600*24 segundos em cada dia.

Construtor:

@geindex datetime (classe em datetime)
@anchor{library/datetime datetime datetime}@anchor{1cc}
@deffn {Classe} datetime.datetime (year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Os argumentos `year', `month' e `day' são obrigatórios. `tzinfo' pode ser @code{None}, ou uma instância de subclasse de @ref{5de,,tzinfo}. Os argumentos remanescentes devem ser inteiros nos seguintes intervalos:


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR},

@item 
@code{1 <= month <= 12},

@item 
@code{1 <= day <= número de dias no mês e ano fornecidos},

@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

Se um argumento fora desses intervalos for fornecido, a exceção @ref{202,,ValueError} é levantada.


Alterado na versão 3.6: Adicionado o parâmetro `fold'.

@end deffn

Outros construtores, todos os métodos de classe.

@geindex today() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime today}@anchor{25f9}
@deffn {Método} classmethod datetime.today ()

Retorna a data e hora local atual, com o atributo @ref{25dc,,tzinfo} definido para @code{None}.

Equivalente a:

@example
datetime.fromtimestamp(time.time())
@end example

Veja também @ref{4ec,,now()}, @ref{4ed,,fromtimestamp()}.

Este método é funcionalmente equivalente a @ref{4ec,,now()}, mas sem um parâmetro @code{tz}.
@end deffn

@geindex now() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime now}@anchor{4ec}
@deffn {Método} classmethod datetime.now (tz=None)

Retorna a data e hora local atual.

Se o argumento opcional `tz' é @code{None} ou não especificado, isto é o mesmo que @ref{25f9,,today()}, mas, se possível, fornece mais precisão do que pode ser obtido indo por um registro de data e hora da função @ref{254,,time.time()} (por exemplo, isto pode ser possível em plataformas que fornecem a função C @code{gettimeofday()}).

Se `tz' não for @code{None}, ele deve ser uma instância de uma subclasse de @ref{5de,,tzinfo}, e a data e hora local atual são convertidas para o fuso horário de `tz'.

Esta função é preferida ao invés de @ref{25f9,,today()} e @ref{2fc,,utcnow()}.

@cartouche
@quotation Nota 
Chamadas subsequentes para @code{datetime.now()} podem retornar o mesmo instante, dependendo da precisão do relógio subjacente.
@end quotation
@end cartouche
@end deffn

@geindex utcnow() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime utcnow}@anchor{2fc}
@deffn {Método} classmethod datetime.utcnow ()

Retorna a data e hora atual em UTC, com @ref{25dc,,tzinfo} como @code{None}.

Este é similar a @ref{4ec,,now()}, mas retorna a data e hora atual em UTC, como um objeto @ref{1cc,,datetime} ingênuo. Um datetime UTC consciente pode ser obtido chamando @code{datetime.now(timezone.utc)}. Veja também @ref{4ec,,now()}.

@cartouche
@quotation Aviso 
Devido ao fato de objetos @code{datetime} ingênuos serem tratados por muitos métodos @code{datetime} como hora local, é preferível usar datetimes conscientes para representar horas em UTC. De tal forma, a maneira recomendada para criar um objeto representando a hora local em UTC é chamando @code{datetime.now(timezone.utc)}.
@end quotation
@end cartouche


Descontinuado desde a versão 3.12: Use @ref{4ec,,datetime.now()} com @ref{4ee,,UTC}.

@end deffn

@geindex fromtimestamp() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime fromtimestamp}@anchor{4ed}
@deffn {Método} classmethod datetime.fromtimestamp (timestamp, tz=None)

Retorna a data e hora local correspondente ao registro de data e hora POSIX, como é retornado por @ref{254,,time.time()}. Se o argumento opcional `tz' é @code{None} ou não especificado, o registro de data e hora é convertido para a data e hora local da plataforma, e o objeto @ref{1cc,,datetime} retornado é ingênuo.

Se `tz' não for @code{None}, ela deve ser uma instância de uma subclasse de @ref{5de,,tzinfo}, e o registro de data e hora é convertido para o fuso horário de `tz'.

@ref{4ed,,fromtimestamp()} pode levantar @ref{885,,OverflowError}, se o registro de data e hora estiver fora do intervalo de valores suportados pelas funções em C @code{localtime()} ou @code{gmtime()} da plataforma, e ocorrer uma falha de @ref{417,,OSError} em @code{localtime()} ou @code{gmtime()}. É comum para isso ser restrito aos anos 1970 até 2038. Perceba que em sistemas não-POSIX que incluem segundos bissextos na sua notação de registro de data e hora, segundos bissextos são ignorados por @ref{4ed,,fromtimestamp()}, e então é possível ter dois registros de data e hora com diferença de um segundo que apresentam objetos @ref{1cc,,datetime} idênticos. Este método é preferido sobre @ref{2fd,,utcfromtimestamp()}.


Alterado na versão 3.3: Levanta um @ref{885,,OverflowError} ao invés de @ref{202,,ValueError} se o registro de data e hora estiver fora do intervalo dos valores suportados pelas funções C @code{localtime()} ou @code{gmtime()} da plataforma. Levanta @ref{417,,OSError} ao invés de @ref{202,,ValueError} em falhas de @code{localtime()} ou @code{gmtime()}.



Alterado na versão 3.6: @ref{4ed,,fromtimestamp()} pode retornar instâncias com @ref{c72,,fold} igual a 1.

@end deffn

@geindex utcfromtimestamp() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime utcfromtimestamp}@anchor{2fd}
@deffn {Método} classmethod datetime.utcfromtimestamp (timestamp)

Retorna o @ref{1cc,,datetime} UTC correspondente ao registro de data e hora POSIX, com @ref{25dc,,tzinfo} setado para @code{None}. (O objeto resultante é ingênuo.)

Isso pode levantar @ref{885,,OverflowError}, se o registro de data e hora estiver fora do intervalo de valores suportados pela função C @code{gmtime()} da plataforma, e em caso de falha @ref{417,,OSError} em @code{gmtime()}. É comum que isso seja restrito a anos de 1970 a 2038.

Para conseguir um objeto @ref{1cc,,datetime} consciente, chame @ref{4ed,,fromtimestamp()}:

@example
datetime.fromtimestamp(timestamp, timezone.utc)
@end example

Nas plataformas compatíveis com POSIX, é equivalente à seguinte expressão:

@example
datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)
@end example

com a exceção de que a última fórmula sempre dá suporte ao intervalo completo de anos: entre @ref{25ca,,MINYEAR} e @ref{25cb,,MAXYEAR} inclusive.

@cartouche
@quotation Aviso 
Devido ao fato de objetos @code{datetime} ingênuos serem tratados por muitos métodos @code{datetime} como hora local, é preferível usar datetimes conscientes para representar horas em UTC. De tal forma, a maneira recomendada para criar um objeto representando um registro de data e hora específico em UTC é chamando @code{datetime.fromtimestamp(timestamp, tz=timezone.utc)}.
@end quotation
@end cartouche


Alterado na versão 3.3: Levanta @ref{885,,OverflowError} ao invés de @ref{202,,ValueError} se o registro de data e hora estiver fora do intervalo de valores suportados pela função C @code{gmtime()} da plataforma. Levanta @ref{417,,OSError} ao invés de @ref{202,,ValueError} em caso de falha @code{gmtime()}.



Descontinuado desde a versão 3.12: Use @ref{4ed,,datetime.fromtimestamp()} com @ref{4ee,,UTC}.

@end deffn

@geindex fromordinal() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime fromordinal}@anchor{25fa}
@deffn {Método} classmethod datetime.fromordinal (ordinal)

Retorna um @ref{1cc,,datetime} correspondente ao ordinal proléptico Gregoriano, onde 1º de janeiro do ano 1 tem ordinal 1. @ref{202,,ValueError} é levantado a não ser que @code{1 <= ordinal <= datetime.max.toordinal()}. As horas, minutos, segundos e micro segundos do resultado são todos 0, e @ref{25dc,,tzinfo} é @code{None}.
@end deffn

@geindex combine() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime combine}@anchor{cb1}
@deffn {Método} classmethod datetime.combine (date, time, tzinfo=time.tzinfo)

Retorna um novo objeto @ref{1cc,,datetime} no qual os componentes de data são iguais ao objeto @ref{1cd,,date} fornecido, e nos quais os componentes de hora são iguais ao do objeto @ref{1ce,,time} fornecido. Se o argumento `tzinfo' é fornecido, seu valor é usado para definir o atributo @ref{25dc,,tzinfo} do resultado, caso contrário o atributo @ref{25d4,,tzinfo} do argumento `time' é usado. Se o argumento `date' é um objeto @ref{1cc,,datetime}, seus componentes de hora e atributos @ref{25dc,,tzinfo} são ignorados.

Para qualquer objeto @ref{1cc,,datetime} @code{d}, @code{d == datetime.combine(d.date(), d.time(), d.tzinfo)}.


Alterado na versão 3.6: Adicionado o argumento `tzinfo'.

@end deffn

@geindex fromisoformat() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime fromisoformat}@anchor{617}
@deffn {Método} classmethod datetime.fromisoformat (date_string)

Retorna um @ref{1cc,,datetime} correspondendo a `date_string' em qualquer formato válido de ISO 8601, com as seguintes exceções:


@enumerate 

@item 
Os deslocamentos de fuso horário podem ter segundos fracionários.

@item 
O separador @code{T} pode ser substituído por qualquer caractere unicode único.

@item 
Horas e minutos fracionários não são suportados.

@item 
Datas de precisão reduzida não são atualmente suportadas (@code{YYYY-MM}, @code{YYYY}).

@item 
Representações de data estendidas não são atualmente suportadas (@code{±YYYYYY-MM-DD}).

@item 
Atualmente, as datas ordinais não são suportadas (@code{YYYY-OOO}).
@end enumerate

Exemplos:

@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


Adicionado na versão 3.7.



Alterado na versão 3.11: Anteriormente, este método suportava apenas formatos que podiam ser emitidos por @ref{25f1,,date.isoformat()} ou @ref{b42,,datetime.isoformat()}.

@end deffn

@geindex fromisocalendar() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime fromisocalendar}@anchor{9f5}
@deffn {Método} classmethod datetime.fromisocalendar (year, week, day)

Retorna um @ref{1cc,,datetime} correspondente à data no calendário ISO especificada por `year', `week' e `day'. Os componentes não-data do datetime são preenchidos normalmente com seus valores padrões. Isso é o inverso da função @ref{8fc,,datetime.isocalendar()}.


Adicionado na versão 3.8.

@end deffn

@geindex strptime() (método de classe datetime.datetime)
@anchor{library/datetime datetime datetime strptime}@anchor{16f6}
@deffn {Método} classmethod datetime.strptime (date_string, format)

Retorna um @ref{1cc,,datetime} correspondente ao `date_string', analisado de acordo com `format'.

Se `format' não contiver microssegundos ou informações de fuso horário, isso é equivalente a:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

@ref{202,,ValueError} é levantado se o date_string e o format não puderem ser interpretados por @ref{1474,,time.strptime()} ou se ele retorna um valor o qual não é uma tupla temporal. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{617,,datetime.fromisoformat()}.


Alterado na versão 3.13: Se `format' especificar um dia do mês sem um ano, um @ref{1a5,,DeprecationWarning} agora é emitido. Isso é para evitar um bug de ano bissexto quadrienal no código que busca analisar apenas um mês e dia, pois o ano padrão usado na ausência de um no formato não é um ano bissexto. Esses valores de `format' podem gerar um erro a partir do Python 3.15. A solução alternativa é sempre incluir um ano em seu `format'. Se estiver analisando valores de `date_string' que não têm um ano, adicione explicitamente um ano que seja um ano bissexto antes da análise:

@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 classe:

@geindex min (atributo datetime.datetime)
@anchor{library/datetime datetime datetime min}@anchor{18f0}
@deffn {Atributo} datetime.min

O primeiro @ref{1cc,,datetime} representável, @code{datetime(MINYEAR, 1, 1, tzinfo=None)}.
@end deffn

@geindex max (atributo datetime.datetime)
@anchor{library/datetime datetime datetime max}@anchor{25fb}
@deffn {Atributo} datetime.max

O último @ref{1cc,,datetime} representável, @code{datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None)}.
@end deffn

@geindex resolution (atributo datetime.datetime)
@anchor{library/datetime datetime datetime resolution}@anchor{25fc}
@deffn {Atributo} datetime.resolution

A menor diferença possível entre objetos @ref{1cc,,datetime} diferentes, @code{timedelta(microseconds=1)}.
@end deffn

Atributos de instância (somente leitura):

@geindex year (atributo datetime.datetime)
@anchor{library/datetime datetime datetime year}@anchor{25d5}
@deffn {Atributo} datetime.year

Entre @ref{25ca,,MINYEAR} e @ref{25cb,,MAXYEAR} incluindo extremos.
@end deffn

@geindex month (atributo datetime.datetime)
@anchor{library/datetime datetime datetime month}@anchor{25d6}
@deffn {Atributo} datetime.month

Entre 1 e 12 incluindo extremos.
@end deffn

@geindex day (atributo datetime.datetime)
@anchor{library/datetime datetime datetime day}@anchor{25d7}
@deffn {Atributo} datetime.day

Entre 1 e o número de dias no mês especificado do ano especificado.
@end deffn

@geindex hour (atributo datetime.datetime)
@anchor{library/datetime datetime datetime hour}@anchor{25d8}
@deffn {Atributo} datetime.hour

No intervalo @code{range(24)}.
@end deffn

@geindex minute (atributo datetime.datetime)
@anchor{library/datetime datetime datetime minute}@anchor{25d9}
@deffn {Atributo} datetime.minute

No intervalo @code{range(60)}.
@end deffn

@geindex second (atributo datetime.datetime)
@anchor{library/datetime datetime datetime second}@anchor{25da}
@deffn {Atributo} datetime.second

No intervalo @code{range(60)}.
@end deffn

@geindex microsecond (atributo datetime.datetime)
@anchor{library/datetime datetime datetime microsecond}@anchor{25db}
@deffn {Atributo} datetime.microsecond

No intervalo @code{range(1000000)}.
@end deffn

@geindex tzinfo (atributo datetime.datetime)
@anchor{library/datetime datetime datetime tzinfo}@anchor{25dc}
@deffn {Atributo} datetime.tzinfo

O objeto passado como o argumento `tzinfo' do construtor @ref{1cc,,datetime}, ou @code{None} se nada foi passado.
@end deffn

@geindex fold (atributo datetime.datetime)
@anchor{library/datetime datetime datetime fold}@anchor{c72}
@deffn {Atributo} datetime.fold

Entre @code{[0, 1]}. Usado para desambiguar tempos reais durante um intervalo repetido. (Um intervalo repetido ocorre quando relógios são atrasados ao final do horário de verão ou quando a diferença UTC para o fuso horário atual é reduzida por razões políticas.) Os valores 0 e 1 representam, respectivamente, o primeiro e o segundo dos dois momentos com a mesma representação de tempo real.


Adicionado na versão 3.6.

@end deffn

Operações suportadas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@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

Comparação de igualdade. (4)

@item


@display
@code{datetime1 < datetime2}@w{ }
@code{datetime1 > datetime2}@w{ }
@code{datetime1 <= datetime2}@w{ }
@code{datetime1 >= datetime2}@w{ }
@end display



@tab

Comparação de ordem. (5)

@end multitable



@enumerate 

@item 
@code{datetime2} representa a duração de @code{timedelta} removido de @code{datetime1}, movendo o tempo para frente se @code{timedelta.days > 0}, ou para trás se @code{timedelta.days < 0}. O resultado tem o mesmo atributo @ref{25dc,,tzinfo} que o datetime de entrada, e @code{datetime2 - datetime1 == timedelta} após. @ref{885,,OverflowError} é levantada se @code{datetime2.year} fosse menor que @ref{25ca,,MINYEAR} ou maior que @ref{25cb,,MAXYEAR}. Perceba que nenhum ajuste no fuso horário é feito mesmo se a entrada é um objeto consciente disso.

@item 
Computa o @code{datetime2} tal que @code{datetime2 + timedelta == datetime1}. Assim como para adição, o resultado tem o mesmo atributo @ref{25dc,,tzinfo} que datetime de entrada, e nenhum ajuste de fuso horário é feito mesmo que a entrada seja consciente disso.

@item 
Subtração de um @ref{1cc,,datetime} de outro @ref{1cc,,datetime} é definido apenas se ambos os operandos são ingênuos, ou se ambos são conscientes. Se um deles é consciente e o outro é ingênuo, @ref{2c3,,TypeError} é levantado.

Se ambos são ingênuos, ou ambos são conscientes e tiverem o mesmo atributo @ref{25dc,,tzinfo}, os atributos @ref{25dc,,tzinfo} são ignorados, e o resultado é um objeto @code{t} do tipo @ref{9d7,,timedelta}, tal que @code{datetime2 + t == datetime1}. Nenhum ajuste de fuso horário é feito neste caso.

Se ambas são conscientes e têm atributos @ref{25dc,,tzinfo} diferentes, @code{a-b} age como se @code{a} e @code{b} tivessem sido primeiro convertidos para datetimes ingênuas em UTC. O resultado é @code{(a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset())} exceto que a implementação nunca estoura.

@item 
Objetos @ref{1cc,,datetime} são iguais se representarem a mesma data e hora, levando em consideração o fuso horário.

Objetos @code{datetime} ingênuos e conscientes nunca são iguais.

Se ambos os comparandos forem conscientes e tiverem o mesmo atributo @code{tzinfo}, os atributos @code{tzinfo} e @ref{c72,,fold} serão ignorados e os datetimes base serão comparados. Se ambos os comparandos forem conscientes e tiverem atributos @ref{25dc,,tzinfo} diferentes, a comparação atua como se os comparandos fossem primeiro convertidos para datetimes UTC, exceto que a implementação nunca estoura. Instâncias @code{datetime} em um intervalo repetido nunca são iguais a instâncias @code{datetime} em outro fuso horário.

@item 
`datetime1' é considerado menor que `datetime2' quando `datetime1' precede `datetime2' no tempo. levando em consideração o fuso horário.

A comparação de ordens entre objetos @ref{1cc,,datetime} ingênuos e conscientes levanta @ref{2c3,,TypeError}.

Se ambos os comparandos forem conscientes e tiverem o mesmo atributo @code{tzinfo}, os atributos @code{tzinfo} e @ref{c72,,fold} serão ignorados e os datetimes base serão comparados. Se ambos os comparandos forem conscientes e tiverem atributos @ref{25dc,,tzinfo} diferentes, a comparação atua como se os comparandos fossem primeiro convertidos para datetimes UTC, exceto que a implementação nunca estoura.
@end enumerate


Alterado na versão 3.3: Comparações de igualdade entre instâncias de @ref{1cc,,datetime} conscientes e nativas não levantam @ref{2c3,,TypeError}.



Alterado na versão 3.13: A comparação entre o objeto @ref{1cc,,datetime} e uma instância da subclasse @ref{1cd,,date} que não é uma subclasse @code{datetime} não converte mais a última para @code{date}, ignorando o parte horária e o fuso horário. O comportamento padrão pode ser alterado substituindo os métodos especiais de comparação nas subclasses.


Métodos de instância:

@geindex date() (método datetime.datetime)
@anchor{library/datetime datetime datetime date}@anchor{25fd}
@deffn {Método} datetime.date ()

Retorna um objeto @ref{1cd,,date} com o mesmo ano, mês e dia.
@end deffn

@geindex time() (método datetime.datetime)
@anchor{library/datetime datetime datetime time}@anchor{25fe}
@deffn {Método} datetime.time ()

Retorna um objeto @ref{1ce,,time} com a mesma hora, minuto, segundo, microssegundo e fold. O atributo @ref{25dc,,tzinfo} é @code{None}. Veja também o método @ref{25ff,,timetz()}.


Alterado na versão 3.6: O valor fold é copiado para o objeto @ref{1ce,,time} retornado.

@end deffn

@geindex timetz() (método datetime.datetime)
@anchor{library/datetime datetime datetime timetz}@anchor{25ff}
@deffn {Método} datetime.timetz ()

Retorna um objeto @ref{1ce,,time} com os mesmos atributos de hora, minuto, segundo, microssegundo, fold e tzinfo. Veja também o método @ref{ee,,time()}.


Alterado na versão 3.6: O valor fold é copiado para o objeto @ref{1ce,,time} retornado.

@end deffn

@geindex replace() (método datetime.datetime)
@anchor{library/datetime datetime datetime replace}@anchor{1513}
@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 um novo objeto @ref{30,,datetime} com os mesmos atributos, mas com os parâmetros especificados atualizados. Perceba que @code{tzinfo=None} pode ser especificado para criar um datetime ingênuo a partir de um datetime consciente, sem conversão de dados da data ou hora.

Objetos @ref{1cc,,datetime} também são suportados pela função genérica @ref{151,,copy.replace()}.


Alterado na versão 3.6: Adicionado o parâmetro `fold'.

@end deffn

@geindex astimezone() (método datetime.datetime)
@anchor{library/datetime datetime datetime astimezone}@anchor{9d8}
@deffn {Método} datetime.astimezone (tz=None)

Retorna um objeto @ref{1cc,,datetime} com novo atributo @ref{25dc,,tzinfo} definido por `tz', ajustando a data e hora de forma que o resultado seja o mesmo horário UTC que `self', mas na hora local de `tz'.

Se fornecido, `tz' deve ser uma instância de uma subclasse @ref{5de,,tzinfo}, e seus métodos @ref{2600,,utcoffset()} e @ref{2601,,dst()} não devem retornar @code{None}. Se `self' for ingênuo, é presumido que ele representa o tempo no fuso horário do sistema.

Se for chamado sem argumentos (ou com @code{tz=None}) o fuso horário do sistema local é presumido como o fuso horário desejado. O atributo @code{.tzinfo} da instância datetime convertida será definido para uma instância de @ref{10fe,,timezone} com o nome da zona e um deslocamento obtido a partir do sistema operacional.

Se @code{self.tzinfo} for `tz', @code{self.astimezone(tz)} é igual a `self': nenhum ajuste nos dados de data ou hora é realizado. Caso contrário o resultado é a hora local no fuso horário `tz', representando a mesma hora UTC que `self': depois @code{astz = dt.astimezone(tz)}, @code{astz - astz.utcoffset()} terá os mesmos dados de data e hora que @code{dt - dt.utcoffset()}.

Se você quer meramente anexar um objeto @ref{10fe,,timezone} `tz' a um datetime `dt' sem ajustes de dados de data e hora, use @code{dt.replace(tzinfo=tz)}. Se você meramente quer remover o objeto @code{timezone} de um datetime consciente `dt' sem conversão de dados de data e hora, use @code{dt.replace(tzinfo=None)}.

Perceba que o método padrão @ref{2602,,tzinfo.fromutc()} pode ser substituído em uma subclasse @ref{5de,,tzinfo} para afetar o resultado retornado por @ref{9d8,,astimezone()}. Ignorando erros de letras maiúsculas/minúsculas, @ref{9d8,,astimezone()} funciona como:

@example
def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # Converte self para UTC e anexa o novo objeto timezone.
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # Converte o horário local de UTC para tz.
    return tz.fromutc(utc)
@end example


Alterado na versão 3.3: `tz' agora pode ser omitido.



Alterado na versão 3.6: O método @ref{9d8,,astimezone()} agora pode ser chamado em instâncias ingênuas que presumidamente representam a hora local do sistema.

@end deffn

@geindex utcoffset() (método datetime.datetime)
@anchor{library/datetime datetime datetime utcoffset}@anchor{2600}
@deffn {Método} datetime.utcoffset ()

Se @ref{25dc,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.utcoffset(self)}, e levanta uma exceção se o segundo não retornar @code{None} ou um objeto @ref{9d7,,timedelta} com magnitude menor que um dia.


Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.

@end deffn

@geindex dst() (método datetime.datetime)
@anchor{library/datetime datetime datetime dst}@anchor{2601}
@deffn {Método} datetime.dst ()

Se @ref{25dc,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.dst(self)}, e levanta uma exceção se o segundo não retornar @code{None} ou um objeto @ref{9d7,,timedelta} com magnitude menor que um dia.


Alterado na versão 3.7: A diferença de horário de verão não é restrita a um número completo de minutos.

@end deffn

@geindex tzname() (método datetime.datetime)
@anchor{library/datetime datetime datetime tzname}@anchor{2603}
@deffn {Método} datetime.tzname ()

Se @ref{25dc,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.tzname(self)}, levanta uma exceção se o segundo não retornar @code{None} ou um objeto string.
@end deffn

@geindex timetuple() (método datetime.datetime)
@anchor{library/datetime datetime datetime timetuple}@anchor{2604}
@deffn {Método} datetime.timetuple ()

Retorna uma @ref{d0b,,time.struct_time} tal como retornado por @ref{1541,,time.localtime()}.

@code{d.timetuple()} é equivalente a:

@example
time.struct_time((d.year, d.month, d.day,
                  d.hour, d.minute, d.second,
                  d.weekday(), yday, dst))
@end example

onde @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1} é o número de dias dentro do ano atual, começando com 1 para 1º de janeiro. O sinalizador @ref{2605,,tm_isdst} do resultado é definido conforme o método @ref{2601,,dst()}: @ref{25dc,,tzinfo} é @code{None} ou @ref{2601,,dst()} retorna @code{None}, @code{tm_isdst} é definido para @code{-1}; caso contrário se @ref{2601,,dst()} retornar um valor diferente de zero, @code{tm_isdst} é definido para 1; caso contrário @code{tm_isdst} é definido para 0.
@end deffn

@geindex utctimetuple() (método datetime.datetime)
@anchor{library/datetime datetime datetime utctimetuple}@anchor{2606}
@deffn {Método} datetime.utctimetuple ()

Se a instância @ref{1cc,,datetime} @code{d} é ingênua, isto é o mesmo que @code{d.timetuple()}, exceto que @ref{2605,,tm_isdst} é forçado para 0, independentemente do que @code{d.dst()} retornar. O horário de verão nunca é afetado por um horário UTC.

Se @code{d} é consciente, @code{d} é normalizado para horário UTC, subtraindo @code{d.utcoffset()}, e um @ref{d0b,,time.struct_time} para o horário normalizado é retornado. @code{tm_isdst} é forçado para 0. Observe que uma exceção @ref{885,,OverflowError} pode ser levantada se @code{d.year} for @code{MINYEAR} ou @code{MAXYEAR} e os ajustes UTC ultrapassar o limite de um ano.

@cartouche
@quotation Aviso 
Por causa que objetos @code{datetime} ingênuos são tratados por muitos métodos @code{datetime} como hora local, é preferido usar datetimes conscientes para representar horários em UTC; como resultado, usar @ref{2606,,datetime.utctimetuple()} pode dar resultados enganosos. Se você tem um @code{datetime} ingênuo representando UTC, use @code{datetime.replace(tzinfo=timezone.utc)} para torná-lo consciente, ponto no qual você pode usar @ref{2604,,datetime.timetuple()}.
@end quotation
@end cartouche
@end deffn

@geindex toordinal() (método datetime.datetime)
@anchor{library/datetime datetime datetime toordinal}@anchor{2607}
@deffn {Método} datetime.toordinal ()

Retorna o ordinal proléptico gregoriano da data. o mesmo que @code{self.date().toordinal()}.
@end deffn

@geindex timestamp() (método datetime.datetime)
@anchor{library/datetime datetime datetime timestamp}@anchor{10d9}
@deffn {Método} datetime.timestamp ()

Retorna o registro de data e hora POSIX correspondente a instância @ref{1cc,,datetime}. O valor de retorno é um @ref{2f7,,float} similar aquele retornado por @ref{254,,time.time()}.

Presume-se que instâncias @ref{1cc,,datetime} ingênuas representam a hora local e este método depende da função C @code{mktime()} da plataforma para realizar a conversão. Como @ref{1cc,,datetime} suporta um intervalo maior de valores que @code{mktime()} em muitas plataformas, este método pode levantar @ref{885,,OverflowError} ou @ref{417,,OSError} para horários longe no passado ou longe no futuro.

Para instâncias conscientes de @ref{1cc,,datetime}, o valor retornado é computado como:

@example
(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()
@end example


Adicionado na versão 3.3.



Alterado na versão 3.6: O método @ref{10d9,,timestamp()} usa o atributo @ref{c72,,fold} para desambiguar os tempos durante um intervalo repetido.


@cartouche
@quotation Nota 
Não existe método para obter o timestamp POSIX diretamente de uma instância @ref{1cc,,datetime} ingênua representando tempo em UTC. Se a sua aplicação usa esta convenção e o fuso horário do seu sistema não está setado para UTC, você pode obter o registro de data e hora POSIX fornecendo @code{tzinfo=timezone.utc}:

@example
timestamp = dt.replace(tzinfo=timezone.utc).timestamp()
@end example

ou calculando o registro de data e hora diretamente:

@example
timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
@end example
@end quotation
@end cartouche
@end deffn

@geindex weekday() (método datetime.datetime)
@anchor{library/datetime datetime datetime weekday}@anchor{2608}
@deffn {Método} datetime.weekday ()

Retorna o dia da semana como um inteiro, em que segunda-feira é 0 e domingo é 6. O mesmo que @code{self.date().weekday()}. Veja também @ref{2609,,isoweekday()}.
@end deffn

@geindex isoweekday() (método datetime.datetime)
@anchor{library/datetime datetime datetime isoweekday}@anchor{2609}
@deffn {Método} datetime.isoweekday ()

Retorna o dia da semana como um inteiro, em que segunda-feira é 1 e domingo é 7. O mesmo que @code{self.date().isoweekday()}. Veja também @ref{2608,,weekday()}, @ref{8fc,,isocalendar()}.
@end deffn

@geindex isocalendar() (método datetime.datetime)
@anchor{library/datetime datetime datetime isocalendar}@anchor{8fc}
@deffn {Método} datetime.isocalendar ()

Retorna uma @ref{64e,,tupla nomeada} com três componentes: @code{year}, @code{week} e @code{weekday}. O mesmo que  @code{self.date().isocalendar()}.
@end deffn

@geindex isoformat() (método datetime.datetime)
@anchor{library/datetime datetime datetime isoformat}@anchor{b42}
@deffn {Método} datetime.isoformat (sep='T', timespec='auto')

Retorna uma string representando a data e o tempo no formato ISO 8601:


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff}, se @ref{25db,,microsecond} não é 0

@item 
@code{YYYY-MM-DDTHH:MM:SS}, se @ref{25db,,microsecond} é 0
@end itemize

Se @ref{2600,,utcoffset()} não retorna @code{None}, uma string é adicionada com a diferença UTC:


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}, se @ref{25db,,microsecond} não é 0

@item 
@code{YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]},  se @ref{25db,,microsecond} é 0
@end itemize

Exemplos:

@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

O argumento opcional `sep' (por padrão, @code{'T'}) é um separador de caractere único, colocado entre as porções de data e tempo do resultado. Por exemplo:

@example
>>> from datetime import tzinfo, timedelta, datetime
>>> class TZ(tzinfo):
...     """Um fuso horário com uma posição arbitrária constante de -06:39."""
...     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

O argumento opcional `timespec' especifica o número de componentes adicionais do tempo a incluir (o padrão é @code{'auto'}). Pode ser uma das seguintes strings:


@itemize -

@item 
@code{'auto'}: O mesmo que @code{'seconds'} se @ref{25db,,microsecond} é 0, o mesmo que @code{'microseconds'} caso contrário.

@item 
@code{'hours'}: Inclui o atributo @ref{25d8,,hour} no formato de dois dígitos @code{HH}.

@item 
@code{'minutes'}: Inclui os atributos @ref{25d8,,hour} e @ref{25d9,,minute} no formato @code{HH:MM}.

@item 
@code{'seconds'}: Inclui os atributos  @ref{25d8,,hour}, @ref{25d9,,minute} e @ref{25da,,second} no formato @code{HH:MM:SS}.

@item 
@code{'milliseconds'}: Inclui o tempo completo, mas trunca a parte fracional dos segundos em milissegundos. Formato @code{HH:MM:SS.sss}.

@item 
@code{'microseconds'}: Inclui o tempo completo no formato @code{HH:MM:SS.ffffff}.
@end itemize

@cartouche
@quotation Nota 
Componentes do tempo excluídos são truncados, não arredondados.
@end quotation
@end cartouche

A exceção @ref{202,,ValueError} vai ser levantada no caso de um argumento `timespec' inválido:

@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


Alterado na versão 3.6: Adicionado o  parâmetro `timespec'.

@end deffn

@geindex __str__() (método datetime.datetime)
@anchor{library/datetime datetime datetime __str__}@anchor{260a}
@deffn {Método} datetime.__str__ ()

Para uma instância @ref{1cc,,datetime} @code{d}, @code{str(d)} é equivalente a @code{d.isoformat(' ')}.
@end deffn

@geindex ctime() (método datetime.datetime)
@anchor{library/datetime datetime datetime ctime}@anchor{260b}
@deffn {Método} datetime.ctime ()

Retorna uma string representando a data e hora:

@example
>>> from datetime import datetime
>>> datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'
@end example

A string de saída `não' irá incluir informações de fuso horário, independente de a entrada ser consciente ou ingênua.

@code{d.ctime()} é equivalente a:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

em plataformas onde a função nativa em C @code{ctime()} (a qual @ref{25f4,,time.ctime()} invoca, mas a qual @ref{260b,,datetime.ctime()} não invoca) conforma com o padrão C.
@end deffn

@geindex strftime() (método datetime.datetime)
@anchor{library/datetime datetime datetime strftime}@anchor{caf}
@deffn {Método} datetime.strftime (format)

Retorna uma string representando a data e hora, controladas por uma string com formato explícito. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{b42,,datetime.isoformat()}.
@end deffn

@geindex __format__() (método datetime.datetime)
@anchor{library/datetime datetime datetime __format__}@anchor{260c}
@deffn {Método} datetime.__format__ (format)

O mesmo que @ref{caf,,datetime.strftime()}. Isso torna possível especificar uma string de formatação para o objeto @ref{1cc,,datetime} em @ref{9b1,,literais de string formatados} e ao usar @ref{621,,str.format()}. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{b42,,datetime.isoformat()}.
@end deffn

@menu
* Exemplos de uso; datetime: Exemplos de uso datetime. 

@end menu

@node Exemplos de uso datetime,,,Objetos datetime
@anchor{library/datetime examples-of-usage-datetime}@anchor{260d}
@subsubsection Exemplos de uso: @code{datetime}


Exemplos para trabalhar com objetos @ref{1cc,,datetime}:

@example
>>> from datetime import datetime, date, time, timezone

>>> # Usando datetime.combine()
>>> d = date(2005, 7, 14)
>>> t = time(12, 30)
>>> datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)

>>> # Usando 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)

>>> # Usando datetime.strptime()
>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> dt
datetime.datetime(2006, 11, 21, 16, 30)

>>> # Usando datetime.timetuple() para obter uma tupla de todos os atributos
>>> tt = dt.timetuple()
>>> for it in tt:
...     print(it)
...
2006    # ano
11      # mês
21      # dia
16      # hora
30      # minuto
0       # segundo
1       # dia da semana (0 = Segunda-feira)
325     # número de dias desde 1º de janeiro
-1      # dst - método tzinfo.dst() retornou None

>>> # Data em formato ISO
>>> ic = dt.isocalendar()
>>> for it in ic:
...     print(it)
...
2006    # ano ISO
47      # semana ISO
2       # dia da semana ISO

>>> # Formatando um datetime
>>> dt.strftime("%A, %d. %B %Y %I:%M%p")
'Tuesday, 21. November 2006 04:30PM'
>>> 'O @{1@} é @{0:%d@}, o @{2@} é @{0:%B@}, a @{3@} é @{0:%I:%M%p@}.'.format(dt, "dia", "mês", "hora")
'O dia é 21, o mês é November, a hora é 04:30PM.'
@end example

O exemplo abaixo define uma subclasse @ref{5de,,tzinfo} capturando informações de fuso horário para Kabul, Afeganistão, o qual usou +4 UTC até 1945 e depois +4:30 UTC após esse período:

@example
from datetime import timedelta, datetime, tzinfo, timezone

class KabulTz(tzinfo):
    # Kabul usou +4 até 1945, quando eles moveram para +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):
            # Um intervalo de meia hora ambíguo ("imaginário") representando
            # um 'fold' no tempo por causa da troca de +4 para +4:30.
            # Se dt cair no intervalo imaginário, usa a fold para decidir como
            # para resolver. Veja PEP495.
            return timedelta(hours=4, minutes=(30 if dt.fold else 0))
        else:
            return timedelta(hours=4, minutes=30)

    def fromutc(self, dt):
        # Segue as mesmas validações como em datetime.tzinfo
        if not isinstance(dt, datetime):
            raise TypeError("fromutc() requer um argumento datetime")
        if dt.tzinfo is not self:
            raise ValueError("dt.tzinfo não é self")

        # Uma implementação personalizada é necessária para fromutc
        # como a entrada para esta função é um datetime com valores utc
        # mas com um tzinfo definido para self.
        # Veja datetime.astimezone ou 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 não tem horário de verão.
        return timedelta(0)

    def tzname(self, dt):
        if dt >= self.UTC_MOVE_DATE:
            return "+04:30"
        return "+04"
@end example

Uso de @code{KabulTz} mostrado acima:

@example
>>> tz1 = KabulTz()

>>> # Datetime antes da alteração
>>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
>>> print(dt1.utcoffset())
4:00:00

>>> # Datetime após a alteração
>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
>>> print(dt2.utcoffset())
4:30:00

>>> # Converte datetime para outro fuso horário
>>> 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 — Tipos básicos de data e hora
@anchor{library/datetime datetime-time}@anchor{260e}@anchor{library/datetime time-objects}@anchor{260f}
@subsubsection Objetos @code{time}


Um objeto @ref{1ce,,time} representa a hora (local) do dia, independente de qualquer dia em particular, e sujeito a ajustes através de um objeto @ref{5de,,tzinfo}.

@geindex time (classe em datetime)
@anchor{library/datetime datetime time}@anchor{1ce}
@deffn {Classe} datetime.time (hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Todos os argumentos são opcionais. `tzinfo' pode ser @code{None}, ou uma instância de uma subclasse de @ref{5de,,tzinfo}. Os argumentos remanescentes devem ser inteiros nos seguintes intervalos:


@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

Se um argumento fora desses intervalos é fornecido, @ref{202,,ValueError} é levantada. Todos tem como padrão o valor 0 exceto `tzinfo', o qual tem o valor padrão @code{None}.
@end deffn

Atributos de classe:

@geindex min (atributo datetime.time)
@anchor{library/datetime datetime time min}@anchor{2610}
@deffn {Atributo} time.min

O @ref{1ce,,time} mais cedo que pode ser representado, @code{time(0, 0, 0, 0)}.
@end deffn

@geindex max (atributo datetime.time)
@anchor{library/datetime datetime time max}@anchor{2611}
@deffn {Atributo} time.max

O @ref{1ce,,time} mais tardio que pode ser representado, @code{time(23, 59, 59, 999999)}.
@end deffn

@geindex resolution (atributo datetime.time)
@anchor{library/datetime datetime time resolution}@anchor{2612}
@deffn {Atributo} time.resolution

A menor diferença possível entre objetos @ref{1ce,,time} diferentes, @code{timedelta(microseconds=1)}, embora perceba que aritmética sobre objetos @ref{1ce,,time} não é suportada.
@end deffn

Atributos de instância (somente leitura):

@geindex hour (atributo datetime.time)
@anchor{library/datetime datetime time hour}@anchor{25d0}
@deffn {Atributo} time.hour

No intervalo @code{range(24)}.
@end deffn

@geindex minute (atributo datetime.time)
@anchor{library/datetime datetime time minute}@anchor{25d1}
@deffn {Atributo} time.minute

No intervalo @code{range(60)}.
@end deffn

@geindex second (atributo datetime.time)
@anchor{library/datetime datetime time second}@anchor{25d2}
@deffn {Atributo} time.second

No intervalo @code{range(60)}.
@end deffn

@geindex microsecond (atributo datetime.time)
@anchor{library/datetime datetime time microsecond}@anchor{25d3}
@deffn {Atributo} time.microsecond

No intervalo @code{range(1000000)}.
@end deffn

@geindex tzinfo (atributo datetime.time)
@anchor{library/datetime datetime time tzinfo}@anchor{25d4}
@deffn {Atributo} time.tzinfo

O objeto passado como argumento tzinfo para o construtor da classe @ref{1ce,,time}, ou @code{None} se nada foi passado.
@end deffn

@geindex fold (atributo datetime.time)
@anchor{library/datetime datetime time fold}@anchor{cae}
@deffn {Atributo} time.fold

Entre @code{[0, 1]}. Usado para desambiguar tempos reais durante um intervalo repetido. (Um intervalo repetido ocorre quando relógios são atrasados ao final do horário de verão ou quando a diferença UTC para o fuso horário atual é reduzida por razões políticas.) Os valores 0 e 1 representam, respectivamente, o primeiro e o segundo dos dois momentos com a mesma representação de tempo real.


Adicionado na versão 3.6.

@end deffn

Objetos @ref{1ce,,time} oferecem suporte para comparações de igualdade e ordem, onde @code{a} é considerado menor que @code{b} quando @code{a} precede @code{b} no tempo.

Objetos @code{time} ingênuos e conscientes nunca são iguais. A comparação de ordem entre objetos @code{time} ingênuos e conscientes levanta @ref{2c3,,TypeError}.

Se ambos os comparandos são conscientes, e tem o mesmo atributo @ref{25d4,,tzinfo}, os atributos @code{tzinfo} e @code{fold} são ignorados e os tempos base são comparados. Se ambos os comparandos são conscientes e tem atributos @code{tzinfo} diferentes, os comparandos são primeiro ajustados subtraindo sua diferença em UTC (obtida através de @code{self.utcoffset()}).


Alterado na versão 3.3: Comparações de igualdade entre instâncias de @ref{1ce,,time} conscientes e nativas não levantam @ref{2c3,,TypeError}.


Em contextos Booleanos, um objeto @ref{1ce,,time} é sempre considerado como verdadeiro.


Alterado na versão 3.5: Antes do Python 3.5, um objeto @ref{1ce,,time} era considerado falso se ele representava meia-noite em UTC. Este comportamento era considerado obscuro e suscetível a erros, e foi removido no Python 3.5. Veja bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936} para todos os detalhes.


Outro construtor:

@geindex fromisoformat() (método de classe datetime.time)
@anchor{library/datetime datetime time fromisoformat}@anchor{616}
@deffn {Método} classmethod time.fromisoformat (time_string)

Retorna um @ref{1ce,,time} correspondendo a `time_string' em qualquer formato válido de ISO 8601, com as seguintes exceções:


@enumerate 

@item 
Os deslocamentos de fuso horário podem ter segundos fracionários.

@item 
O @code{T} inicial, normalmente exigido nos casos em que pode haver ambiguidade entre uma data e uma hora, não é necessário.

@item 
Segundos fracionários podem ter qualquer número de dígitos (algo além de 6 será truncado).

@item 
Horas e minutos fracionários não são suportados.
@end enumerate

Exemplos:

@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


Adicionado na versão 3.7.



Alterado na versão 3.11: Anteriormente, este método suportava apenas formatos que podiam ser emitidos por @ref{2613,,time.isoformat()}.

@end deffn

Métodos de instância:

@geindex replace() (método datetime.time)
@anchor{library/datetime datetime time replace}@anchor{1774}
@deffn {Método} time.replace (hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Retorna um novo @ref{1ce,,time} com os mesmos valores, mas com os parâmetros especificados atualizados. Perceba que @code{tzinfo=None} pode ser especificado para criar um @ref{1ce,,time} ingênuo a partir de um @ref{1ce,,time} consciente, sem conversão de dados do tempo.

Objetos @ref{1ce,,time} também são suportados pela função genérica @ref{151,,copy.replace()}.


Alterado na versão 3.6: Adicionado o parâmetro `fold'.

@end deffn

@geindex isoformat() (método datetime.time)
@anchor{library/datetime datetime time isoformat}@anchor{2613}
@deffn {Método} time.isoformat (timespec='auto')

Retorna uma string representando a hora em formato ISO 8601, um destes:


@itemize -

@item 
@code{HH:MM:SS.ffffff}, se @ref{25d3,,microsecond} não é 0

@item 
@code{HH:MM:SS}, se @ref{25d3,,microsecond} é 0

@item 
@code{HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}, se @ref{2614,,utcoffset()} não retorna @code{None}

@item 
@code{HH:MM:SS+HH:MM[:SS[.ffffff]]}, se @ref{25d3,,microsecond} é 0 e @ref{2614,,utcoffset()} não retorna @code{None}
@end itemize

O argumento opcional `timespec' especifica o número de componentes adicionais do tempo a incluir (o padrão é @code{'auto'}). Pode ser uma das seguintes strings:


@itemize -

@item 
@code{'auto'}: O mesmo que @code{'seconds'} se @ref{25d3,,microsecond} é 0, o mesmo que @code{'microseconds'} caso contrário.

@item 
@code{'hours'}: Inclui o atributo @ref{25d0,,hour} no formato de dois dígitos @code{HH}.

@item 
@code{'minutes'}: Inclui os atributos @ref{25d0,,hour} e @ref{25d1,,minute} no formato @code{HH:MM}.

@item 
@code{'seconds'}: Inclui os atributos  @ref{25d0,,hour}, @ref{25d1,,minute} e @ref{25d2,,second} no formato @code{HH:MM:SS}.

@item 
@code{'milliseconds'}: Inclui o tempo completo, mas trunca a parte fracional dos segundos em milissegundos. Formato @code{HH:MM:SS.sss}.

@item 
@code{'microseconds'}: Inclui o tempo completo no formato @code{HH:MM:SS.ffffff}.
@end itemize

@cartouche
@quotation Nota 
Componentes do tempo excluídos são truncados, não arredondados.
@end quotation
@end cartouche

@ref{202,,ValueError} será levantado com um argumento `timespec' inválido.

Exemplo:

@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


Alterado na versão 3.6: Adicionado o  parâmetro `timespec'.

@end deffn

@geindex __str__() (método datetime.time)
@anchor{library/datetime datetime time __str__}@anchor{2615}
@deffn {Método} time.__str__ ()

Para um tempo @code{t}, @code{str(t)} é equivalente a @code{t.isoformat()}.
@end deffn

@geindex strftime() (método datetime.time)
@anchor{library/datetime datetime time strftime}@anchor{1880}
@deffn {Método} time.strftime (format)

Retorna uma string representando a hora, controladas por uma string com formato explícito. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{2613,,time.isoformat()}.
@end deffn

@geindex __format__() (método datetime.time)
@anchor{library/datetime datetime time __format__}@anchor{2616}
@deffn {Método} time.__format__ (format)

O mesmo que @ref{1880,,time.strftime()}. Isso torna possível especificar uma string de formatação para o objeto @ref{1ce,,time} em @ref{9b1,,literais de string formatados} e ao usar @ref{621,,str.format()}. Veja também @ref{18de,,Comportamento de strftime() e strptime()} e @ref{2613,,time.isoformat()}.
@end deffn

@geindex utcoffset() (método datetime.time)
@anchor{library/datetime datetime time utcoffset}@anchor{2614}
@deffn {Método} time.utcoffset ()

Se @ref{25d4,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.utcoffset(None)}, e levanta uma exceção se o segundo não retornar @code{None} ou um objeto @ref{9d7,,timedelta} com magnitude menor que um dia.


Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.

@end deffn

@geindex dst() (método datetime.time)
@anchor{library/datetime datetime time dst}@anchor{2617}
@deffn {Método} time.dst ()

Se @ref{25d4,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.dst(None)}, e levanta uma exceção se o segundo não retornar @code{None}, ou um objeto @ref{9d7,,timedelta} com magnitude menor que um dia.


Alterado na versão 3.7: A diferença de horário de verão não é restrita a um número completo de minutos.

@end deffn

@geindex tzname() (método datetime.time)
@anchor{library/datetime datetime time tzname}@anchor{2618}
@deffn {Método} time.tzname ()

Se @ref{25d4,,tzinfo} for @code{None}, retorna @code{None}, caso contrário retorna @code{self.tzinfo.tzname(None)}, ou levanta uma exceção se o último caso não retornar @code{None} ou um objeto string.
@end deffn

@menu
* Exemplos de uso; time: Exemplos de uso time. 

@end menu

@node Exemplos de uso time,,,Objetos time
@anchor{library/datetime examples-of-usage-time}@anchor{2619}
@subsubsection Exemplos de uso: @code{time}


Exemplos para trabalhar com um objeto @ref{1ce,,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'
>>> 'A @{@} é @{:%H:%M@}.'.format("hora", t)
'A hora é 12:10.'
@end example

@node Objetos tzinfo,Objetos timezone,Objetos time,datetime — Tipos básicos de data e hora
@anchor{library/datetime datetime-tzinfo}@anchor{261a}@anchor{library/datetime tzinfo-objects}@anchor{261b}
@subsubsection Objetos @code{tzinfo}


@geindex tzinfo (classe em datetime)
@anchor{library/datetime datetime tzinfo}@anchor{5de}
@deffn {Classe} datetime.tzinfo

Esta é uma classe base abstrata, o que significa que esta classe não deve ser instanciada diretamente. Defina uma subclasse de @ref{5de,,tzinfo} para capturar informações sobre um fuso horário em particular.

Uma instância de (uma subclasse concreta de) @ref{5de,,tzinfo} pode ser passada para os construtores de objetos @ref{1cc,,datetime} e @ref{1ce,,time}. Os objetos time veem seus atributos como se estivessem em horário local, e o objeto @ref{5de,,tzinfo} suporta métodos revelando a diferença da hora local a partir de UTC, o nome do fuso horário, e diferença de horário em horário de verão, todos relativos ao objeto date ou time passado para eles.

Você precisa derivar uma subclasse concreta, e (pelo menos) fornecer implementações dos métodos padrões de @ref{5de,,tzinfo} necessários pelos métodos @ref{1cc,,datetime} que você usa. O módulo @code{datetime} fornece @ref{10fe,,timezone}, uma subclasse concreta simples de @ref{5de,,tzinfo}, que pode representar fusos horários com diferença fixa a partir de UTC, tais como o próprio UTC, ou EST (Eastern Standard Time ou Horário padrão oriental) e EDT (Eastern Daylight Time ou Horário de verão oriental) na América do Norte.

Requisito especial para preservação: uma subclasse @ref{5de,,tzinfo} deve ter um método @ref{6b0,,__init__()} que pode ser chamado sem nenhum argumento, caso contrário ele pode ser conservado, mas não alterado novamente. Isso é um requisito técnico que pode ser relaxado no futuro.

Uma subclasse concreta de @ref{5de,,tzinfo} pode precisar implementar os seguintes métodos. Exatamente quais métodos são necessários depende do uso feito de objetos @code{datetime} conscientes. Se estiver em dúvida, simplesmente implemente todos eles.
@end deffn

@geindex utcoffset() (método datetime.tzinfo)
@anchor{library/datetime datetime tzinfo utcoffset}@anchor{261c}
@deffn {Método} tzinfo.utcoffset (dt)

Retorna a diferença da hora local a partir do UTC, como um objeto @ref{9d7,,timedelta}, que é positivo a leste do UTC. Se a hora local está a oeste do UTC, isto deve ser negativo.

Isto representa a diferença `total' a partir de UTC; por exemplo, se um objeto @ref{5de,,tzinfo} representa fuso horário e ajustes de horário de verão, @ref{261c,,utcoffset()} deve retornar a soma deles. Se a diferença UTC não é conhecida, retorna @code{None}. Caso contrário o valor retornado deve ser um objeto @ref{9d7,,timedelta} estritamente contido entre @code{-timedelta(hours=24)} e @code{timedelta(hours=24)} (a magnitude da diferença deve ser menor que um dia). A maior parte das implementações de @ref{261c,,utcoffset()} irá provavelmente parecer com um destes dois:

@example
return CONSTANT                 # classe de posição fixa
return CONSTANT + self.dst(dt)  # classe consciente de horário de verão
@end example

Se @ref{261c,,utcoffset()} não retorna @code{None}, @ref{261d,,dst()} também não deve retornar @code{None}.

A implementação padrão de @ref{261c,,utcoffset()} levanta @ref{228,,NotImplementedError}.


Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.

@end deffn

@geindex dst() (método datetime.tzinfo)
@anchor{library/datetime datetime tzinfo dst}@anchor{261d}
@deffn {Método} tzinfo.dst (dt)

Retorna o ajuste para o horário de verão (DST - daylight saving time), como um objeto @ref{9d7,,timedelta} ou @code{None} se informação para o horário de verão é desconhecida.

Retorna @code{timedelta(0)} se o horário de verão não estiver ativo. Se o horário de verão estiver ativo, retorna a diferença como um objeto @ref{9d7,,timedelta} (veja @ref{261c,,utcoffset()} para detalhes). Perceba que a diferença do horário de verão, se aplicável, já foi adicionada a diferença UTC retornada por @ref{261c,,utcoffset()}, então não existe necessidade de consultar @ref{261d,,dst()} a não ser que você esteja interessado em obter a informação de horário de verão separadamente. Por exemplo, @ref{2604,,datetime.timetuple()} chama o método @ref{261d,,dst()} do seu atributo @ref{25dc,,tzinfo} para determinar como o flag @ref{2605,,tm_isdst} deve ser definido, e @ref{2602,,tzinfo.fromutc()} chama @ref{261d,,dst()} para contabilizar as mudanças de horário de verão quando ocorrem mudanças de fuso horário.

Uma instância `tz' de uma subclasse @ref{5de,,tzinfo} que modela tanto horário padrão quanto horário de verão deve ser consistente neste sentido:

@code{tz.utcoffset(dt) - tz.dst(dt)}

deve retornar o mesmo resultado para cada @ref{1cc,,datetime} `dt' com @code{dt.tzinfo == tz} para subclasses @ref{5de,,tzinfo} sãs, esta expressão produz a “diferença padrão” do fuso horário, a qual não deve depender de data ou hora, mas apenas de localização geográfica. A implementação de @ref{9d8,,datetime.astimezone()} depende disso, mas não pode detectar violações; é responsabilidade do programador garantir isso. Se uma subclasse @ref{5de,,tzinfo} não pode garantir isso, ele pode ser capaz de substituir a implementação padrão de @ref{2602,,tzinfo.fromutc()} para funcionar corretamente com @ref{9d8,,astimezone()} independente disso.

Maior parte das implementações de @ref{261d,,dst()} provavelmente irá parecer com um destes dois:

@example
def dst(self, dt):
    # uma classe de posição fixa: não levam em conta DST
    return timedelta(0)
@end example

ou:

@example
def dst(self, dt):
    # Código para definir dston e dstoff para os horários
    # de transição do horário de versão com base
    # no dt.year de entrada e expresso no horário local padrão.

    if dston <= dt.replace(tzinfo=None) < dstoff:
        return timedelta(hours=1)
    else:
        return timedelta(0)
@end example

A implementação padrão de @ref{261d,,dst()} levanta @ref{228,,NotImplementedError}.


Alterado na versão 3.7: A diferença de horário de verão não é restrita a um número completo de minutos.

@end deffn

@geindex tzname() (método datetime.tzinfo)
@anchor{library/datetime datetime tzinfo tzname}@anchor{261e}
@deffn {Método} tzinfo.tzname (dt)

Retorna o nome do fuso horário correspondente ao objeto @ref{1cc,,datetime} `dt', como uma string. Nada sobre nomes de strings é definido pelo módulo @code{datetime}, e não há nenhuma exigência de que signifique algo em particular. Por exemplo, @code{"GMT"}, @code{"UTC"}, @code{"-500"}, @code{"-5:00"}, @code{"EDT"}, @code{"US/Eastern"}, @code{"America/New York"} são todas respostas válidas. Retorna @code{None} se um nome de string não for conhecido. Observe que este é um método em vez de uma string fixa, principalmente porque algumas subclasses @ref{5de,,tzinfo} desejarão retornar nomes diferentes dependendo do valor específico de `dt' passado, especialmente se a classe @ref{5de,,tzinfo} estiver contabilizando o horário de verão.

A implementação padrão de @ref{261e,,tzname()} levanta @ref{228,,NotImplementedError}.
@end deffn

Estes métodos são chamados por um objeto @ref{1cc,,datetime} ou @ref{1ce,,time}, em resposta aos seus métodos de mesmo nome. Um objeto @ref{1cc,,datetime} passa a si mesmo como argumento, e um objeto @ref{1ce,,time} passa @code{None} como o argumento. Os métodos de uma subclasse @ref{5de,,tzinfo} devem portanto estar preparados para aceitar um argumento `dt' com valor @code{None}, ou uma classe @ref{1cc,,datetime}.

Quando @code{None} é passado, cabe ao projetista da classe decidir a melhor resposta. Por exemplo, retornar @code{None} é apropriado se a classe deseja dizer que objetos time não participam nos protocolos da classe @ref{5de,,tzinfo}. Pode ser mais útil para @code{utcoffset(None)} retornar a diferença UTC padrão, como não existe outra convenção para descobrir a diferença padrão.

Quando um objeto @ref{1cc,,datetime} é passado em resposta a um método @ref{1cc,,datetime}, @code{dt.tzinfo} é o mesmo objeto que `self'. Os métodos @ref{5de,,tzinfo} podem confiar nisso, a menos que o código do usuário chame métodos @ref{5de,,tzinfo} diretamente. A intenção é que os métodos @ref{5de,,tzinfo} interpretem `dt' como estando no horário local, e não precisem se preocupar com objetos em outros fusos horários.

Existe mais um método @ref{5de,,tzinfo} que uma subclasse pode desejar substituição:

@geindex fromutc() (método datetime.tzinfo)
@anchor{library/datetime datetime tzinfo fromutc}@anchor{2602}
@deffn {Método} tzinfo.fromutc (dt)

Isto é chamado a partir do padrão implementação de @ref{9d8,,datetime.astimezone()}. Quando chamado a partir dele, @code{dt.tzinfo} é `self', e os dados de data e hora de `dt' devem ser vistos como expressando um Horário Universal Coordenado (UTC). O propósito de @ref{2602,,fromutc()} é ajustar os dados de data e hora, retornando um `datetime' equivalente na hora local de `self'.

A maioria das subclasses de @ref{5de,,tzinfo} deve ser capaz de herdar a implementação padrão de @ref{2602,,fromutc()} sem problemas. Ela é robusta o suficiente para lidar com fusos horários de deslocamento fixo, e fusos horários que contabilizam tanto o horário padrão quanto o horário de verão, sendo que este último é tratado mesmo que os horários de transição do horário de verão sejam diferentes em anos distintos. Um exemplo de fuso horário que a implementação padrão de @ref{2602,,fromutc()} pode não lidar corretamente em todos os casos é aquele onde o deslocamento padrão (de UTC) depende da data e hora específicas passadas, o que pode acontecer por razões políticas. As implementações padrão de @ref{9d8,,astimezone()} e @ref{2602,,fromutc()} podem não produzir o resultado desejado se o resultado estiver entre as horas que abrangem o momento em que o deslocamento padrão muda.

Ignorando o código para casos de erros, a implementação padrão @ref{2602,,fromutc()} funciona como:

@example
def fromutc(self, dt):
    # levanta o erro ValueError se dt.tzinfo não é o self
    dtoff = dt.utcoffset()
    dtdst = dt.dst()
    # levanta ValueError se dtoff é None ou dtdst é None
    delta = dtoff - dtdst  # este é o deslocamento padrão do self
    if delta:
        dt += delta   # converter para hora local padrão
        dtdst = dt.dst()
        # levanta ValueError se dtdst é None
    if dtdst:
        return dt + dtdst
    else:
        return dt
@end example
@end deffn

No seguinte arquivo @code{tzinfo_examples.py} existem alguns exemplos de classes @ref{5de,,tzinfo}:

@example
from datetime import tzinfo, timedelta, datetime

ZERO = timedelta(0)
HOUR = timedelta(hours=1)
SECOND = timedelta(seconds=1)

# Uma classe que captura a ideia da plataforma sobre o horário local.
# (Pode resultar em valores errados em horários históricos em fusos horários
#  onde o deslocamento UTC e/ou as regras de horário de verão
#  foram alteradas no passado.)
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()


# Uma implementação completa das regras atuais do horário de verão para os principais fusos horários dos EUA.

def first_sunday_on_or_after(dt):
    days_to_go = 6 - dt.weekday()
    if days_to_go:
        dt += timedelta(days_to_go)
    return dt


# Regras do horário de verão dos EUA
#
# Este é um conjunto simplificado (ou seja, incorreto em alguns casos)
# de regras para os horários de início e término do horário de verão dos EUA.
# Para um conjunto completo e atualizado de regras de horário de verão
# e definições de fuso horário, visite o Olson Database (ou tente pytz):
# http://www.twinsun.com/tz/tz-link.htm
# https://sourceforge.net/projects/pytz/ (pode não estar atualizado)
#
# Nos EUA, desde 2007, o horário de verão começa às 2h (horário padrão) no
# segundo domingo de março, que é o primeiro domingo em ou após 8 de março.
DSTSTART_2007 = datetime(1, 3, 8, 2)
# e termina às 2h (horário de verão) no primeiro domingo de novembro.
DSTEND_2007 = datetime(1, 11, 1, 2)
# De 1987 a 2006, o horário de verão costumava começar às 2h
# (horário padrão) no primeiro domingo de abril e terminar às 2h
# (horário de verão) no último Domingo de outubro, que é o primeiro
# domingo em ou após 25 de outubro.
DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
DSTEND_1987_2006 = datetime(1, 10, 25, 2)
# De 1967 a 1986, o horário de verão costumava começar às 2h
# (horário padrão) no último domingo de abril (aquele em ou após
# 24 de abril) e terminar às 2h (horário de verão) no último domingo
# de outubro, que é o primeiro domingo em ou após 25 de outubro.
DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
DSTEND_1967_1986 = DSTEND_1987_2006

def us_dst_range(year):
    # Encontra os horários de início e fim do horário de verão dos EUA.
    # Para anos anteriores a 1967, retorne start = end para nenhum horário
    # de verão.
    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:
            # Uma exceção pode ser sensata aqui, em um ou ambos os casos.
            # Depende de como você quer tratá-las. A implementação padrão
            # fromutc() (chamada pela implementação padrão astimezone()) passa
            # um datetime com dt.tzinfo é self.
            return ZERO
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        # Não é possível comparar objetos ingênuos com objetos conscientes,
        # então retira o fuso horário de dt primeiro.
        dt = dt.replace(tzinfo=None)
        if start + HOUR <= dt < end - HOUR:
            # Horário de verão está em vigor.
            return HOUR
        if end - HOUR <= dt < end:
            # Fold (uma hora ambígua): usa dt.fold para desambiguar.
            return ZERO if dt.fold else HOUR
        if start <= dt < start + HOUR:
            # Intervalo (uma hora inexistente): inverta a regra da dobra.
            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:
            # Hora repetida
            return std_time.replace(fold=1)
        if std_time < start or dst_time >= end:
            # Horário padrão
            return std_time
        if start <= std_time < end - HOUR:
            # Horário de verão
            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

Perceba que existem sutilezas inevitáveis duas vezes por ano em uma subclasse @ref{5de,,tzinfo} contabilizando tanto hora normal e horário de verão, nos pontos de transição do horário de verão. Para concretude, considere a costa leste dos EUA (UTC -0500), onde o horário de verão EDT começa no minuto após 1:59 (EST, hora padrão) no segundo domingo de Março, e termina no minuto posterior a 1:59 (EDT, horário de verão) no primeiro domingo de Novembro:

@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

Quando o horário de verão inicia (a linha de “início”), o relógio de parede local salta de 1:59 para 3:00. Um horário de parede da forma 2:MM realmente não faz sentido nesse dia, então @code{astimezone(Eastern)} não irá entregar um resultado com @code{hour == 2} no dia que o horário de verão começar. Por exemplo, na primavera de transição para frente em 2016, nós tivemos:

@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

Quando o horário de verão termina (a linha “end”), há um problema potencialmente pior: existe uma hora que não pode ser expressa de forma inequívoca no horário local: a última hora do horário de verão. No fuso Eastern, isso corresponde a horários no formato 5:MM UTC no dia em que o horário de verão termina. O relógio de parede local salta de 1:59 (horário de verão) para 1:00 (horário padrão) novamente. Horários locais no formato 1:MM são ambíguos. @ref{9d8,,astimezone()} imita o comportamento do relógio local mapeando então duas horas UTC adjacentes para a mesma hora local. No exemplo do fuso Eastern, horários UTC no formato 5:MM e 6:MM ambos se transformam em 1:MM quando convertidos para o fuso Eastern, mas os horários anteriores têm o atributo @ref{c72,,fold} definido como 0 e os horários posteriores têm o atributo definido como 1. Por exemplo, na transição de retorno de 2016, obtemos:

@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

Observe que as instâncias de @ref{1cc,,datetime} que diferem apenas pelo valor do atributo @ref{c72,,fold} são consideradas iguais nas comparações.

Aplicações que não suportam ambiguidades de tempo devem verificar explicitamente o valor do atributo @ref{c72,,fold} ou evitar utilizar subclasses híbridas @ref{5de,,tzinfo}; não há ambiguidades ao usar @ref{10fe,,timezone} ou qualquer outra subclasse @ref{5de,,tzinfo} de deslocamento fixo (como uma classe que representa apenas EST (deslocamento fixo de -5 horas) ou apenas EDT (deslocamento fixo de -4 horas)).


@subsubheading Ver também


@quotation


@table @asis

@item @ref{134,,zoneinfo}

O módulo @code{datetime} possui uma classe básica @ref{10fe,,timezone} (para lidar com deslocamentos fixos arbitrários do UTC) e seu atributo @ref{614,,timezone.utc} (uma instância UTC @code{timezone} ).

@code{zoneinfo} traz o `banco de dados de fuso horário IANA' (também conhecido como banco de dados Olson) para Python, e seu uso é recomendado.
@end table
@end quotation


@table @asis

@item Banco de dados de fuso horário da IANA@footnote{https://www.iana.org/time-zones}

O banco de dados de fuso horário (comumente chamado de tz, tzdata ou zoneinfo) contém código e dados que representam o histórico de hora local para muitas localizações representativas ao redor do globo. Ele é atualizado periodicamente para refletir mudanças feitas por corpos políticos para limites de fuso horário, diferenças UTC, e regras de horário de verão.
@end table


@node Objetos timezone,Comportamento de strftime e strptime,Objetos tzinfo,datetime — Tipos básicos de data e hora
@anchor{library/datetime datetime-timezone}@anchor{261f}@anchor{library/datetime timezone-objects}@anchor{2620}
@subsubsection Objetos @code{timezone}


A classe @ref{10fe,,timezone} é uma subclasse de @ref{5de,,tzinfo}, cada instância da qual representa um fuso horário definido por um deslocamento fixo do UTC.

Objetos desta classe não podem ser usados para representar informações de fuso horário em locais onde diferentes deslocamentos são usados em diferentes dias do ano ou onde mudanças históricas foram feitas no horário civil.

@geindex timezone (classe em datetime)
@anchor{library/datetime datetime timezone}@anchor{10fe}
@deffn {Classe} datetime.timezone (offset, name=None)

O argumento `offset' deve ser especificado como um objeto @ref{9d7,,timedelta} representando a diferença entre o tempo local e o UTC. Ele deve estar estritamente entre @code{-timedelta(hours=24)} e @code{timedelta(hous=24)}, caso contrário a exceção @ref{202,,ValueError} será provocada.

O argumento `name' é opcional. Se especificado, deve ser uma string que será usada como o valor retornado pelo método @ref{2603,,datetime.tzname()}.


Adicionado na versão 3.2.



Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.

@end deffn

@geindex utcoffset() (método datetime.timezone)
@anchor{library/datetime datetime timezone utcoffset}@anchor{2621}
@deffn {Método} timezone.utcoffset (dt)

Retorna o valor fixo especificado quando a instância @ref{10fe,,timezone} é construída.

O argumento `dt' é ignorado. O valor de retorno é uma instância @ref{9d7,,timedelta} equivalente à diferença entre o tempo local e o UTC.


Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.

@end deffn

@geindex tzname() (método datetime.timezone)
@anchor{library/datetime datetime timezone tzname}@anchor{2622}
@deffn {Método} timezone.tzname (dt)

Retorna o valor fixo especificado quando a instância @ref{10fe,,timezone} é construída.

Se `name' não é passado ao construtor, o nome retornado por @code{tzname(dt)} é gerado a partir do valor de @code{offset} do seguinte modo: Se `offset' é @code{timedelta(0)}, o nome é “UTC”, caso contrário é uma string no formato @code{UTC±HH:MM}, na qual ± é o sinal do @code{offset}, HH e MM são dois dígitos de @code{offset.hours} e @code{offset.minutes} respectivamente.


Alterado na versão 3.6: Nome gerado de @code{offset=timedelta(0)} é agora simplesmente @code{'UTC'}, não @code{'UTC+00:00'}.

@end deffn

@geindex dst() (método datetime.timezone)
@anchor{library/datetime datetime timezone dst}@anchor{2623}
@deffn {Método} timezone.dst (dt)

Sempre retorna @code{None}.
@end deffn

@geindex fromutc() (método datetime.timezone)
@anchor{library/datetime datetime timezone fromutc}@anchor{2624}
@deffn {Método} timezone.fromutc (dt)

Retorna @code{dt + offset}. O argumento `dt' deve ser uma instância @ref{1cc,,datetime} consciente, com @code{tzinfo} definida para @code{self}.
@end deffn

Atributos de classe:

@geindex utc (atributo datetime.timezone)
@anchor{library/datetime datetime timezone utc}@anchor{614}
@deffn {Atributo} timezone.utc

O fuso horário UTC, @code{timezone(timedelta(0))}.
@end deffn

@geindex % (porcentagem);datetime@comma{} formato

@node Comportamento de strftime e strptime,,Objetos timezone,datetime — Tipos básicos de data e hora
@anchor{library/datetime strftime-and-strptime-behavior}@anchor{2625}@anchor{library/datetime strftime-strptime-behavior}@anchor{18de}
@subsubsection Comportamento de @code{strftime()} e @code{strptime()}


Todos os objetos @ref{1cd,,date}, @ref{1cc,,datetime} e @ref{1ce,,time} dão suporte ao método @code{strftime(format)}, para criar uma string representando o tempo sob o controle de uma string de formatação explícita.

Em recíproca, o método de classe @ref{16f6,,datetime.strptime()} cria um objeto @ref{1cc,,datetime} a partir de uma string representando a data e a hora e uma string de formatação correspondente.

A tabela abaixo fornece uma comparação de alto nível entre @ref{caf,,strftime()} e @ref{16f6,,strptime()}:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

@code{strftime}

@tab

@code{strptime}

@item

Uso

@tab

Converte objeto para uma string conforme um formato fornecido

@tab

Interpreta uma string como um objeto @ref{1cc,,datetime} dado um formato correspondente

@item

Tipo de método

@tab

Método de instância

@tab

Método de classe

@item

Método de

@tab

@ref{1cd,,date}; @ref{1cc,,datetime}; @ref{1ce,,time}

@tab

@ref{1cc,,datetime}

@item

Assinatura

@tab

@code{strftime(format)}

@tab

@code{strptime(date_string, format)}

@end multitable


@quotation
@anchor{library/datetime format-codes}@anchor{25c6}
@end quotation

@menu
* Códigos de formato strftime() e strptime(): Códigos de formato strftime e strptime. 
* Detalhes técnicos:: 

@end menu

@node Códigos de formato strftime e strptime,Detalhes técnicos,,Comportamento de strftime e strptime
@anchor{library/datetime strftime-and-strptime-format-codes}@anchor{2626}
@subsubsection Códigos de formato @code{strftime()} e @code{strptime()}


Esses métodos aceitam códigos de formato que podem ser usados para analisar e formatar datas:

@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

A seguir é exibida uma lista de todos os códigos de formatação que o padrão C de 1989 requer, e eles funcionam em todas as plataformas com implementação padrão C.


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Diretiva

@tab

Significado

@tab

Exemplo

@tab

Notas

@item

@code{%a}

@tab

Dias da semana como nomes abreviados da localidade.

@tab


@display
Sun, Mon, …, Sat (en_US);@w{ }
So, Mo, …, Sa (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%A}

@tab

Dia da semana como nome completo da localidade.

@tab


@display
Sunday, Monday, …, Saturday (en_US);@w{ }
Sonntag, Montag, …, Samstag (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%w}

@tab

Dia da semana como um número decimal, onde 0 é domingo e 6 é sábado.

@tab

0, 1, …, 6

@tab

@item

@code{%d}

@tab

Dia do mês como um número decimal com zeros a esquerda.

@tab

01, 02, …, 31

@tab

(9)

@item

@code{%b}

@tab

Mês como nome da localidade abreviado.

@tab


@display
Jan, Feb, …, Dec (en_US);@w{ }
Jan, Feb, …, Dez (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%B}

@tab

Mês como nome completo da localidade.

@tab


@display
January, February, …, December (en_US);@w{ }
janeiro, fevereiro, …, dezembro (pt_BR)@w{ }
@end display



@tab

(1)

@item

@code{%m}

@tab

Mês como um número decimal com zeros a esquerda.

@tab

01, 02, …, 12

@tab

(9)

@item

@code{%y}

@tab

Ano sem século como um número decimal com zeros a esquerda.

@tab

00, 01, …, 99

@tab

(9)

@item

@code{%Y}

@tab

Ano com século como um número decimal.

@tab

0001, 0002, …, 2013,
2014, …, 9998, 9999

@tab

(2)

@item

@code{%H}

@tab

Hora (relógio de 24 horas) como um número decimal com zeros a esquerda.

@tab

00, 01, …, 23

@tab

(9)

@item

@code{%I}

@tab

Hora (relógio de 12 horas) como um número decimal com zeros a esquerda.

@tab

01, 02, …, 12

@tab

(9)

@item

@code{%p}

@tab

Equivalente da localidade a AM ou PM.

@tab


@display
AM, PM (en_US);@w{ }
am, pm (de_DE)@w{ }
@end display



@tab

(1),
(3)

@item

@code{%M}

@tab

Minutos como um número decimal, com zeros a esquerda.

@tab

00, 01, …, 59

@tab

(9)

@item

@code{%S}

@tab

Segundos como um número decimal, com zeros a esquerda.

@tab

00, 01, …, 59

@tab

(4),
(9)

@item

@code{%f}

@tab

Microssegundos como um número decimal, com zeros à esquerda até completar 6 dígitos.

@tab

000000, 000001, …,
999999

@tab

(5)

@item

@code{%z}

@tab

Diferença UTC no formato @code{±HHMM[SS[.ffffff]]} (string vazia se o objeto é ingênuo).

@tab

(vazio), +0000, -0400, +1030, +063415, -030712.345216

@tab

(6)

@item

@code{%Z}

@tab

Nome do fuso horário (string vazia se o objeto é ingênuo).

@tab

(vazio), UTC, GMT

@tab

(6)

@item

@code{%j}

@tab

Dia do ano como um número decimal, com zeros a esquerda.

@tab

001, 002, …, 366

@tab

(9)

@item

@code{%U}

@tab

Número da semana do ano (Domingo como o primeiro dia da semana) como um número decimal, com zeros a esquerda. Todos os dias em um ano novo precedendo o primeiro domingo são considerados como estando na semana 0.

@tab

00, 01, …, 53

@tab

(7),
(9)

@item

@code{%W}

@tab

Número da semana do ano (Segunda-feira como o primeiro dia da semana) como um número decimal, com zeros a esquerda. Todos os dias em um ano novo precedendo a primeira segunda-feira são considerados como estando na semana 0.

@tab

00, 01, …, 53

@tab

(7),
(9)

@item

@code{%c}

@tab

Representação de data e hora apropriada da localidade.

@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

Representação de data apropriada de localidade.

@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

Representação de hora apropriada da localidade.

@tab


@display
21:30:00 (en_US);@w{ }
21:30:00 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%%}

@tab

Um caractere literal @code{'%'}.

@tab

%

@tab

@end multitable


Diversas diretivas adicionais não necessárias pelo padrão C89 são incluídas para conveniência. Estes parâmetros todos correspondem a valores de datas na ISO 8601.


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Diretiva

@tab

Significado

@tab

Exemplo

@tab

Notas

@item

@code{%G}

@tab

Ano ISO 8601 com o século representando o ano que a maior parte da semana ISO (@code{%V}).

@tab

0001, 0002, …, 2013,
2014, …, 9998, 9999

@tab

(8)

@item

@code{%u}

@tab

Dia de semana ISO 8601 como um número decimal onde 1 é segunda-feira.

@tab

1, 2, …, 7

@tab

@item

@code{%V}

@tab

Semana ISO 8601 como um número decimal, com segunda-feira como o primeiro dia da semana. A semana 01 é a semana contendo o dia 4 de Janeiro.

@tab

01, 02, …, 53

@tab

(8),
(9)

@item

@code{%:z}

@tab

Diferença UTC no formato @code{±HH:MM[:SS[.ffffff]]} (string vazia se o objeto é ingênuo).

@tab

(vazio), +00:00, -04:00, +10:30, +06:34:15, -03:07:12.345216

@tab

(6)

@end multitable


Eles podem não estar disponíveis em todas as plataformas quando usados com o método @ref{caf,,strftime()}. As diretivas de ano e semana da ISO 8601 e ISO 8601 não são intercambiáveis com as diretivas ano e número da semana acima. Chamar @ref{16f6,,strptime()} com diretivas ISO 8601 incompletas ou ambíguas levantará um @ref{202,,ValueError}.

O conjunto completo de códigos de formato suportados varia entre as plataformas, porque o Python chama a função @code{strftime()} da biblioteca C da plataforma, e variações de plataforma são comuns. Para ver o conjunto completo de códigos de formato suportados em sua plataforma, consulte a documentação @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}}. Também existem diferenças entre plataformas no tratamento de especificadores de formato não suportados.


Adicionado na versão 3.6: @code{%G}, @code{%u} e @code{%V} foram adicionados.



Adicionado na versão 3.12: @code{%:z} foi adicionado.


@node Detalhes técnicos,,Códigos de formato strftime e strptime,Comportamento de strftime e strptime
@anchor{library/datetime technical-detail}@anchor{2627}
@subsubsection Detalhes técnicos


Em termos gerais, @code{d.strftime(fmt)} age como @code{time.strftime(fmt, d.timetuple())} do módulo @ref{ee,,time}, embora nem todos os objetos suportem um método @ref{25ed,,timetuple()}.

For the @ref{16f6,,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.

@cartouche
@quotation Nota 
When used to parse partial dates lacking a year, @ref{16f6,,datetime.strptime()}
will raise when encountering February 29 because the default year of 1900 is
`not' a leap year.  Always add a default leap year to partial date strings
before parsing.
@end quotation
@end cartouche

@c # doctest seems to turn the warning into an error which makes it
@c # show up and require matching and prevents the actual interesting
@c # exception from being raised.
@c # Manually apply the catch_warnings context manager
@c import warnings
@c catch_warnings = warnings.catch_warnings()
@c catch_warnings.__enter__()
@c warnings.simplefilter("ignore")

@c catch_warnings.__exit__()

@example
>>> from datetime import datetime
>>> value = "2/29"
>>> datetime.strptime(value, "%m/%d")
Traceback (most recent call last):
...
ValueError: day 29 must be in range 1..28 for month 2 in year 1900
>>> datetime.strptime(f"1904 @{value@}", "%Y %m/%d")
datetime.datetime(1904, 2, 29, 0, 0)
@end example

Usar @code{datetime.strptime(date_string, format)} é equivalente a:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

exceto quando o formato inclui componentes de sub-segundos ou informações de deslocamento de fuso horário, que são suportados em @code{datetime.strptime} mas são descartados por @code{time.strptime}.

Para objetos @ref{1ce,,time}, os códigos de formato para ano, mês e dia não devem ser usados, pois objetos @code{time} não têm tais valores. Se forem usados de qualquer forma, o ano é substituído por 1900, e o mês e dia por 1.

Para objetos @ref{1cd,,date}, os códigos de formato para horas, minutos, segundos e microssegundos não devem ser usados, pois objetos @ref{1cd,,date} não têm tais valores. Se forem usados de qualquer forma, são substituídos por 0.

Pela mesma razão, o tratamento de formato de strings contendo pontos de código Unicode que não podem ser representados no conjunto de caracteres da localidade atual também é dependente da plataforma. Em algumas plataformas, tais pontos de código são preservados intactos na saída, enquanto em outros @code{strftime} pode levantar @ref{12e6,,UnicodeError} ou retornar uma string vazia ao invés.

Notas:


@enumerate 

@item 
Como o formato depende da localidade atual, deve-se tomar cuidado ao fazer suposições sobre o valor de saída. A ordenação dos campos irá variar (por exemplo, “mês/dia/ano” versus “dia/mês/ano”) e a saída pode conter caracteres não ASCII.

@item 
O método @ref{16f6,,strptime()} pode analisar anos no intervalo completo de [1, 9999], mas anos < 1000 devem ser preenchidos com zeros até uma largura de 4 dígitos.


Alterado na versão 3.2: Em versões anteriores, o método @ref{caf,,strftime()} era limitado a anos >= 1900.



Alterado na versão 3.3: Na versão 3.2, o método @ref{caf,,strftime()} era limitado a anos >= 1000.


@item 
Quando usado com o método @ref{16f6,,strptime()}, a diretiva @code{%p} afeta somente o campo de hora de saída se a diretiva @code{%I} for usada para analisar a hora.

@item 
Ao contrário do módulo @ref{ee,,time}, o módulo @code{datetime} não oferece suporte para segundos intercalares.

@item 
Quando usado com o método @ref{16f6,,strptime()}, a diretiva @code{%f} aceita de um a seis dígitos e zeros à direita. @code{%f} é uma extensão do conjunto de caracteres de formato no padrão do C (mas implementado separadamente em objetos datetime e, portanto, sempre disponível).

@item 
Para um objeto ingênuo, os códigos de formatação @code{%z}, @code{%:z} e @code{%Z} são substituídos por strings vazias.

Para um objeto consciente:


@table @asis

@item @code{%z}

@ref{2600,,utcoffset()} é transformado em uma string do formato @code{±HHMM[SS[.ffffff]]}, onde @code{HH} é uma string de 2 dígitos que fornece o número de horas de deslocamento UTC, @code{MM} é uma string de 2 dígitos que fornece o número de minutos de deslocamento UTC, @code{SS} é uma string de 2 dígitos que fornece o número de segundos de deslocamento UTC e @code{ffffff} é uma string de 6 dígitos que fornece o número de microssegundos de deslocamento UTC. A parte @code{ffffff} é omitida quando o deslocamento é um número inteiro de segundos e tanto a parte @code{ffffff} quanto a parte @code{SS} são omitidas quando o deslocamento é um número inteiro de minutos. Por exemplo, se @ref{2600,,utcoffset()} retornar @code{timedelta(hours=-3, minutes=-30)}, @code{%z} será substituído pela string @code{'-0330'}.
@end table


Alterado na versão 3.7: A diferença UTC não é restrita a um número completo de minutos.



Alterado na versão 3.7: Quando a diretiva @code{%z} é fornecida ao método @ref{16f6,,strptime()}, os deslocamentos UTC podem ter dois pontos como separador entre horas, minutos e segundos. Por exemplo, @code{'+01:00:00'} será analisado como um deslocamento de uma hora. Além disso, fornecer @code{'Z'} é idêntico a @code{'+00:00'}.



@table @asis

@item @code{%:z}

Comporta-se exatamente como @code{%z}, mas possui um separador de dois pontos adicionado entre horas, minutos e segundos.

@item @code{%Z}

Em @ref{caf,,strftime()}, @code{%Z} é substituído por uma string vazia se @ref{2603,,tzname()} retornar @code{None}; caso contrário, @code{%Z} é substituído pelo valor retornado, que deve ser uma string.

@ref{16f6,,strptime()} aceita apenas certos valores para @code{%Z}:


@enumerate 

@item 
qualquer valor em @code{time.tzname} para a localidade da sua máquina

@item 
os valores codificados @code{UTC} e @code{GMT}
@end enumerate

Então alguém vivendo no Japão pode ter @code{JST}, @code{UTC}, e @code{GMT} como valores válidos, mas provavelmente não @code{EST}. Isso levantará @code{ValueError} para valores inválidos.
@end table


Alterado na versão 3.2: Quando a diretiva @code{%z} é fornecida ao método @ref{16f6,,strptime()}, um objeto @ref{1cc,,datetime} consciente será produzido. O @code{tzinfo} do resultado será definido para uma instância @ref{10fe,,timezone}.


@item 
Quando utilizados com o método @ref{16f6,,strptime()}, @code{%U} e @code{%W} são usados somente em cálculos quando o dia da semana e o ano (@code{%Y}) são especificados.

@item 
Semelhante a @code{%U} e @code{%W}, @code{%V} é usado apenas em cálculos quando o dia da semana e o ano ISO (@code{%G}) são especificados em um formato de string @ref{16f6,,strptime()}. Observe também que @code{%G} e @code{%Y} não são intercambiáveis.

@item 
Quando usado com o método @ref{16f6,,strptime()}, o zero à esquerda é opcional para os formatos @code{%d}, @code{%m}, @code{%H}, @code{%I}, @code{%M}, @code{%S}, @code{%j}, @code{%U}, @code{%W} e @code{%V}. O formato @code{%y} requer um zero à esquerda.

@item 
When parsing a month and day using @ref{16f6,,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 (1900) is not a leap year.  Users run into that bug every leap year.

@example
>>> month_day = "02/29"
>>> datetime.strptime(f"@{month_day@};1984", "%m/%d;%Y")  # Sem bug de ano bissexto.
datetime.datetime(1984, 2, 29, 0, 0)
@end example


Descontinuado desde a versão 3.13, será removido na versão 3.15: Chamadas ao método @ref{16f6,,strptime()} usando uma string de formato contendo um dia do mês sem um ano agora emitem um @ref{1a5,,DeprecationWarning}. Na versão 3.15 ou posterior, podemos mudar isso para um erro ou mudar o ano padrão para um ano bissexto. Consulte gh-70647@footnote{https://github.com/python/cpython/issues/70647}.

@end enumerate

@node zoneinfo — Suporte a fuso horário da IANA,calendar — Funções gerais relacionadas ao calendário,datetime — Tipos básicos de data e hora,Tipos de Dados
@anchor{library/zoneinfo doc}@anchor{2628}@anchor{library/zoneinfo module-zoneinfo}@anchor{134}@anchor{library/zoneinfo translation-repo}@anchor{2629}@anchor{library/zoneinfo zoneinfo-iana-time-zone-support}@anchor{262a}
@subsection @code{zoneinfo} — Suporte a fuso horário da IANA


@geindex module; zoneinfo


Adicionado na versão 3.9.


`Código-fonte:' Lib/zoneinfo@footnote{https://github.com/python/cpython/tree/3.13/Lib/zoneinfo}


__________________________________________________________________


O módulo @ref{134,,zoneinfo} fornece uma implementação concreta de fuso horário para oferecer suporte ao banco de dados de fuso horário da IANA, conforme especificado originalmente na 
@geindex Propostas de Melhorias do Python; PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}. Por padrão, @ref{134,,zoneinfo} usa os dados de fuso horário do sistema, se disponíveis; se nenhum dado de fuso horário do sistema estiver disponível, a biblioteca voltará a usar o pacote original tzdata@footnote{https://pypi.org/project/tzdata/} disponível no PyPI.


@subsubheading Ver também



@table @asis

@item Módulo: @ref{30,,datetime}

Fornece os tipos @ref{1ce,,time} e @ref{1cc,,datetime} com os quais a classe @ref{8e5,,ZoneInfo} foi projetada para ser usada.

@item Pacote tzdata@footnote{https://pypi.org/project/tzdata/}

Pacote próprio mantido pelos desenvolvedores principais do CPython para fornecer dados de fuso horário via PyPI.
@end table


@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@menu
* Usando ZoneInfo:: 
* Fontes de dados:: 
* A classe ZoneInfo:: 
* Funções: Funções<3>. 
* Globals:: 
* Exceptions and warnings:: 

@end menu

@node Usando ZoneInfo,Fontes de dados,,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo using-zoneinfo}@anchor{262b}
@subsubsection Usando @code{ZoneInfo}


@ref{8e5,,ZoneInfo} é uma implementação concreta da classe base abstrata @ref{5de,,datetime.tzinfo} e deve ser anexada a @code{tzinfo}, por meio do construtor, do método @ref{1513,,datetime.replace} ou @ref{9d8,,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

Datas e horas construídas dessa maneira são compatíveis com a aritmética de data e hora e lidam com transições de horário de verão sem intervenção adicional:

@example
>>> dt_add = dt + timedelta(days=1)

>>> print(dt_add)
2020-11-01 12:00:00-08:00

>>> dt_add.tzname()
'PST'
@end example

Esses fusos horários também oferecem suporte ao atributo @ref{c72,,fold} introduzido em 
@geindex Propostas de Melhorias do Python; PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/}. Durante transições de deslocamento que induzem horários ambíguos (como uma transição do horário de verão para o horário padrão), o deslocamento `anterior' à transição é usado quando @code{fold=0}, e o deslocamento `posterior' à transição é usado quando @code{fold=1}, por exemplo:

@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

Ao converter de outro fuso horário, a dobra será definida para o valor correto:

@example
>>> from datetime import timezone
>>> LOS_ANGELES = ZoneInfo("America/Los_Angeles")
>>> dt_utc = datetime(2020, 11, 1, 8, tzinfo=timezone.utc)

>>> # Antes da transição PDT -> PST
>>> print(dt_utc.astimezone(LOS_ANGELES))
2020-11-01 01:00:00-07:00

>>> # Após a transição PDT -> PST
>>> print((dt_utc + timedelta(hours=1)).astimezone(LOS_ANGELES))
2020-11-01 01:00:00-08:00
@end example

@node Fontes de dados,A classe ZoneInfo,Usando ZoneInfo,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo data-sources}@anchor{262c}
@subsubsection Fontes de dados


O módulo @code{zoneinfo} não fornece dados de fuso horário diretamente, mas, em vez disso, extrai informações de fuso horário do banco de dados de fuso horário do sistema ou do pacote PyPI original tzdata@footnote{https://pypi.org/project/tzdata/}, se disponível. Alguns sistemas, incluindo principalmente os Windows, não possuem um banco de dados IANA disponível e, portanto, para projetos que buscam compatibilidade multiplataforma e exigem dados de fuso horário, recomenda-se declarar uma dependência em tzdata. Se nem os dados do sistema nem o tzdata estiverem disponíveis, todas as chamadas para @ref{8e5,,ZoneInfo} levantarão @ref{1611,,ZoneInfoNotFoundError}.

@menu
* Configurando as fontes de dados:: 

@end menu

@node Configurando as fontes de dados,,,Fontes de dados
@anchor{library/zoneinfo configuring-the-data-sources}@anchor{262d}@anchor{library/zoneinfo zoneinfo-data-configuration}@anchor{262e}
@subsubsection Configurando as fontes de dados


Quando @code{ZoneInfo(key)} é chamado, o construtor primeiro pesquisa nos diretórios especificados em @ref{1ef8,,TZPATH} por um arquivo que corresponda a @code{key} e, em caso de falha, procura uma correspondência no pacote tzdata. Esse comportamento pode ser configurado de três maneiras:


@enumerate 

@item 
O padrão @ref{1ef8,,TZPATH}, quando não especificado de outra forma, pode ser configurado em @ref{1ef9,,tempo de compilação}.

@item 
@ref{1ef8,,TZPATH} pode ser configurado usando @ref{262f,,uma variável de ambiente}.

@item 
Em @ref{2630,,tempo de execução}, o caminho de pesquisa pode ser manipulado usando a função @ref{15f5,,reset_tzpath()}.
@end enumerate

@menu
* Configuração em tempo de compilação:: 
* Configuração do ambiente:: 
* Configuração em tempo de execução:: 

@end menu

@node Configuração em tempo de compilação,Configuração do ambiente,,Configurando as fontes de dados
@anchor{library/zoneinfo compile-time-configuration}@anchor{2631}@anchor{library/zoneinfo zoneinfo-data-compile-time-config}@anchor{1ef9}
@subsubsection Configuração em tempo de compilação


O @ref{1ef8,,TZPATH} padrão inclui vários locais de implantação comuns para o banco de dados de fuso horário (exceto no Windows, onde não há locais “conhecidos” para dados de fuso horário). Em sistemas POSIX, distribuidores downstream e aqueles que constroem o Python a partir do código-fonte e que sabem onde os dados de fuso horário do sistema estão implantados podem alterar o caminho do fuso horário padrão especificando a opção de tempo de compilação @code{TZPATH} (ou, mais provavelmente, o @ref{1ef7,,sinalizador de configuração --with-tzpath}), que deve ser uma string delimitada por @ref{1ecc,,os.pathsep}.

Em todas as plataformas, o valor configurado está disponível como a chave @code{TZPATH} em @ref{1063,,sysconfig.get_config_var()}.

@node Configuração do ambiente,Configuração em tempo de execução,Configuração em tempo de compilação,Configurando as fontes de dados
@anchor{library/zoneinfo environment-configuration}@anchor{2632}@anchor{library/zoneinfo zoneinfo-data-environment-var}@anchor{262f}
@subsubsection Configuração do ambiente


Ao inicializar @ref{1ef8,,TZPATH} (no momento da importação ou sempre que @ref{15f5,,reset_tzpath()} for chamado sem argumentos), o módulo @code{zoneinfo} usará a variável de ambiente @code{PYTHONTZPATH}, se existir, para definir o caminho de pesquisa.

@geindex variável de ambiente; PYTHONTZPATH
@anchor{library/zoneinfo envvar-PYTHONTZPATH}@anchor{2633}
@deffn {Variável De Ambiente} PYTHONTZPATH

Esta é uma string separada por @ref{1ecc,,os.pathsep} contendo o caminho de pesquisa de fuso horário a ser usado. Ela deve consistir apenas em caminhos absolutos, e não relativos. Componentes relativos especificados em @code{PYTHONTZPATH} não serão usados, mas, caso contrário, o comportamento quando um caminho relativo é especificado é definido pela implementação; o CPython levantará @ref{2634,,InvalidTZPathWarning}, mas outras implementações podem ignorar silenciosamente o componente incorreto ou levantar uma exceção.
@end deffn

Para configurar o sistema para ignorar os dados do sistema e usar o pacote tzdata, defina @code{PYTHONTZPATH=""}.

@node Configuração em tempo de execução,,Configuração do ambiente,Configurando as fontes de dados
@anchor{library/zoneinfo runtime-configuration}@anchor{2635}@anchor{library/zoneinfo zoneinfo-data-runtime-config}@anchor{2630}
@subsubsection Configuração em tempo de execução


O caminho de busca TZ também pode ser configurado em tempo de execução usando a função @ref{15f5,,reset_tzpath()}. Geralmente, essa não é uma operação aconselhável, embora seja razoável usá-la em funções de teste que exigem o uso de um caminho de fuso horário específico (ou que exijam a desativação do acesso aos fusos horários do sistema).

@node A classe ZoneInfo,Funções<3>,Fontes de dados,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo the-zoneinfo-class}@anchor{2636}
@subsubsection A classe @code{ZoneInfo}


@geindex ZoneInfo (classe em zoneinfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo}@anchor{8e5}
@deffn {Classe} zoneinfo.ZoneInfo (key)

Uma subclasse concreta de @ref{5de,,datetime.tzinfo} que representa um fuso horário IANA especificado pela string @code{key}. Chamadas ao construtor primário sempre retornarão objetos que sejam idênticos em comparação; em outras palavras, exceto pela invalidação de cache via @ref{2637,,ZoneInfo.clear_cache()}, para todos os valores de @code{key}, a seguinte asserção será sempre verdadeira:

@example
a = ZoneInfo(key)
b = ZoneInfo(key)
assert a is b
@end example

@code{key} deve estar no formato de um caminho POSIX relativo e normalizado, sem referências de nível superior. O construtor levantará @ref{202,,ValueError} se uma chave não conforme for passada.

Se nenhum arquivo correspondente a @code{key} for encontrado, o construtor levantará @ref{1611,,ZoneInfoNotFoundError}.
@end deffn

A classe @code{ZoneInfo} tem dois construtores alternativos:

@geindex from_file() (método de classe zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo from_file}@anchor{15a3}
@deffn {Método} classmethod ZoneInfo.from_file (file_obj, /, key=None)

Constructs a @code{ZoneInfo} object from a file-like object returning bytes
(e.g. a file opened in binary mode or an @ref{ed3,,io.BytesIO} object).
Unlike the primary constructor, this always constructs a new object.

The @code{key} parameter sets the name of the zone for the purposes of
@ref{61d,,__str__()} and @ref{61c,,__repr__()}.

Objects created via this constructor cannot be pickled (see @ref{2638,,pickling}).

@ref{202,,ValueError} is raised if the data read from `file_obj' is not a valid
TZif file.
@end deffn

@geindex no_cache() (método de classe zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo no_cache}@anchor{2639}
@deffn {Método} classmethod ZoneInfo.no_cache (key)

An alternate constructor that bypasses the constructor’s cache. It is
identical to the primary constructor, but returns a new object on each
call. This is most likely to be useful for testing or demonstration
purposes, but it can also be used to create a system with a different cache
invalidation strategy.

Objects created via this constructor will also bypass the cache of a
deserializing process when unpickled.

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation Cuidado 
Using this constructor may change the semantics of your datetimes in
surprising ways, only use it if you know that you need to.
@end quotation
@end cartouche
@end deffn

The following class methods are also available:

@geindex clear_cache() (método de classe zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo clear_cache}@anchor{2637}
@deffn {Método} classmethod ZoneInfo.clear_cache (*, only_keys=None)

A method for invalidating the cache on the @code{ZoneInfo} class. If no
arguments are passed, all caches are invalidated and the next call to
the primary constructor for each key will return a new instance.

If an iterable of key names is passed to the @code{only_keys} parameter, only
the specified keys will be removed from the cache. Keys passed to
@code{only_keys} but not found in the cache are ignored.

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation Aviso 
Invoking this function may change the semantics of datetimes using
@code{ZoneInfo} in surprising ways; this modifies module state
and thus may have wide-ranging effects. Only use it if you know that you
need to.
@end quotation
@end cartouche
@end deffn

A classe possui um atributo:

@geindex key (atributo zoneinfo.ZoneInfo)
@anchor{library/zoneinfo zoneinfo ZoneInfo key}@anchor{263a}
@deffn {Atributo} ZoneInfo.key

This is a read-only @ref{263b,,attribute} that returns the value of @code{key}
passed to the constructor, which should be a lookup key in the IANA time
zone database (e.g. @code{America/New_York}, @code{Europe/Paris} or
@code{Asia/Tokyo}).

For zones constructed from file without specifying a @code{key} parameter,
this will be set to @code{None}.

@cartouche
@quotation Nota 
Although it is a somewhat common practice to expose these to end users,
these values are designed to be primary keys for representing the
relevant zones and not necessarily user-facing elements.  Projects like
CLDR (the Unicode Common Locale Data Repository) can be used to get
more user-friendly strings from these keys.
@end quotation
@end cartouche
@end deffn

@menu
* String representations:: 
* Pickle serialization:: 

@end menu

@node String representations,Pickle serialization,,A classe ZoneInfo
@anchor{library/zoneinfo string-representations}@anchor{263c}
@subsubsection String representations


The string representation returned when calling @ref{44c,,str} on a
@ref{8e5,,ZoneInfo} object defaults to using the @ref{263a,,ZoneInfo.key} attribute (see
the note on usage in the attribute documentation):

@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

For objects constructed from a file without specifying a @code{key} parameter,
@code{str} falls back to calling @ref{800,,repr()}. @code{ZoneInfo}’s @code{repr} is
implementation-defined and not necessarily stable between versions, but it is
guaranteed not to be a valid @code{ZoneInfo} key.

@node Pickle serialization,,String representations,A classe ZoneInfo
@anchor{library/zoneinfo pickle-serialization}@anchor{263d}@anchor{library/zoneinfo pickling}@anchor{2638}
@subsubsection Pickle serialization


Rather than serializing all transition data, @code{ZoneInfo} objects are
serialized by key, and @code{ZoneInfo} objects constructed from files (even those
with a value for @code{key} specified) cannot be pickled.

The behavior of a @code{ZoneInfo} file depends on how it was constructed:


@enumerate 

@item 
@code{ZoneInfo(key)}: When constructed with the primary constructor, a
@code{ZoneInfo} object is serialized by key, and when deserialized, the
deserializing process uses the primary and thus it is expected that these
are the same object as other references to the same time
zone.  For example, if @code{europe_berlin_pkl} is a string containing a pickle
constructed from @code{ZoneInfo("Europe/Berlin")}, one would expect the
following behavior:

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl)
>>> a is b
True
@end example

@item 
@code{ZoneInfo.no_cache(key)}: When constructed from the cache-bypassing
constructor, the @code{ZoneInfo} object is also serialized by key, but when
deserialized, the deserializing process uses the cache bypassing
constructor. If @code{europe_berlin_pkl_nc} is a string containing a pickle
constructed from @code{ZoneInfo.no_cache("Europe/Berlin")}, one would expect
the following behavior:

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl_nc)
>>> a is b
False
@end example

@item 
@code{ZoneInfo.from_file(file_obj, /, key=None)}: When constructed from a file, the
@code{ZoneInfo} object raises an exception on pickling. If an end user wants to
pickle a @code{ZoneInfo} constructed from a file, it is recommended that they
use a wrapper type or a custom serialization function: either serializing by
key or storing the contents of the file object and serializing that.
@end enumerate

This method of serialization requires that the time zone data for the required
key be available on both the serializing and deserializing side, similar to the
way that references to classes and functions are expected to exist in both the
serializing and deserializing environments. It also means that no guarantees
are made about the consistency of results when unpickling a @code{ZoneInfo}
pickled in an environment with a different version of the time zone data.

@node Funções<3>,Globals,A classe ZoneInfo,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo functions}@anchor{263e}
@subsubsection Funções


@geindex available_timezones() (no módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo available_timezones}@anchor{1ad5}
@deffn {Função} zoneinfo.available_timezones ()

Get a set containing all the valid keys for IANA time zones available
anywhere on the time zone path. This is recalculated on every call to the
function.

This function only includes canonical zone names and does not include
“special” zones such as those under the @code{posix/} and @code{right/}
directories, or the @code{posixrules} zone.

@cartouche
@quotation Cuidado 
This function may open a large number of files, as the best way to
determine if a file on the time zone path is a valid time zone is to
read the “magic string” at the beginning.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
These values are not designed to be exposed to end-users; for user
facing elements, applications should use something like CLDR (the
Unicode Common Locale Data Repository) to get more user-friendly
strings. See also the cautionary note on @ref{263a,,ZoneInfo.key}.
@end quotation
@end cartouche
@end deffn

@geindex reset_tzpath() (no módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo reset_tzpath}@anchor{15f5}
@deffn {Função} zoneinfo.reset_tzpath (to=None)

Sets or resets the time zone search path (@ref{1ef8,,TZPATH}) for the module.
When called with no arguments, @ref{1ef8,,TZPATH} is set to the default value.

Calling @code{reset_tzpath} will not invalidate the @ref{8e5,,ZoneInfo} cache,
and so calls to the primary @code{ZoneInfo} constructor will only use the new
@code{TZPATH} in the case of a cache miss.

The @code{to} parameter must be a @ref{4f1,,sequence} of strings or
@ref{c6c,,os.PathLike} and not a string, all of which must be absolute paths.
@ref{202,,ValueError} will be raised if something other than an absolute path
is passed.
@end deffn

@node Globals,Exceptions and warnings,Funções<3>,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo globals}@anchor{263f}
@subsubsection Globals


@geindex TZPATH (no módulo zoneinfo)
@anchor{library/zoneinfo zoneinfo TZPATH}@anchor{1ef8}
@deffn {Dado} zoneinfo.TZPATH

A read-only sequence representing the time zone search path – when
constructing a @code{ZoneInfo} from a key, the key is joined to each entry in
the @code{TZPATH}, and the first file found is used.

@code{TZPATH} may contain only absolute paths, never relative paths,
regardless of how it is configured.

The object that @code{zoneinfo.TZPATH} points to may change in response to a
call to @ref{15f5,,reset_tzpath()}, so it is recommended to use
@code{zoneinfo.TZPATH} rather than importing @code{TZPATH} from @code{zoneinfo} or
assigning a long-lived variable to @code{zoneinfo.TZPATH}.

For more information on configuring the time zone search path, see
@ref{262e,,Configurando as fontes de dados}.
@end deffn

@node Exceptions and warnings,,Globals,zoneinfo — Suporte a fuso horário da IANA
@anchor{library/zoneinfo exceptions-and-warnings}@anchor{2640}
@subsubsection Exceptions and warnings


@geindex ZoneInfoNotFoundError
@anchor{library/zoneinfo zoneinfo ZoneInfoNotFoundError}@anchor{1611}
@deffn {Exceção} zoneinfo.ZoneInfoNotFoundError

Raised when construction of a @ref{8e5,,ZoneInfo} object fails because the
specified key could not be found on the system. This is a subclass of
@ref{344,,KeyError}.
@end deffn

@geindex InvalidTZPathWarning
@anchor{library/zoneinfo zoneinfo InvalidTZPathWarning}@anchor{2634}
@deffn {Exceção} zoneinfo.InvalidTZPathWarning

Raised when 
@geindex PYTHONTZPATH
@geindex variável de ambiente; PYTHONTZPATH
@ref{2633,,PYTHONTZPATH} contains an invalid component that will
be filtered out, such as a relative path.
@end deffn

@c Links and references:

@node calendar — Funções gerais relacionadas ao calendário,collections — Tipos de dados de contêineres,zoneinfo — Suporte a fuso horário da IANA,Tipos de Dados
@anchor{library/calendar doc}@anchor{2641}@anchor{library/calendar calendar-general-calendar-related-functions}@anchor{2642}@anchor{library/calendar module-calendar}@anchor{14}@anchor{library/calendar translation-repo}@anchor{2643}
@subsection @code{calendar} — Funções gerais relacionadas ao calendário


@geindex module; calendar

`Código-fonte:' Lib/calendar.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/calendar.py}


__________________________________________________________________


Este módulo permite que você exiba calendários como o programa Unix @code{cal}, e fornece funções adicionais úteis relacionadas ao calendário. Por padrão, esses calendários têm a segunda-feira como o primeiro dia da semana, e domingo como o último (a convenção europeia). Use @ref{2644,,setfirstweekday()} para colocar o primeiro dia da semana como domingo (6) ou para qualquer outro dia da semana. Parâmetros que especificam datas são dados como inteiros. Para funcionalidade relacionada, veja também os módulos @ref{30,,datetime} e @ref{ee,,time}.

As funções e classes definidas neste módulo usam um calendário idealizado, o calendário Gregoriano atual estendido indefinidamente nas duas direções. Isso corresponde à definição do calendário “proleptic Gregorian” (gregoriano proléptico) no livro “Calendrical Calculations” de Dershowitz e Reingold, onde está o calendário base para todas os cálculos. Anos com zero ou negativos são interpretados e prescritos pelo padrão ISO 8601. Ano 0 é 1 A.C., ano -1 é 2 A.C, e de assim em diante.

@geindex Calendar (classe em calendar)
@anchor{library/calendar calendar Calendar}@anchor{2645}
@deffn {Classe} calendar.Calendar (firstweekday=0)

Cria um objeto @ref{2645,,Calendar}. `firstweekday' é um inteiro que especifica o primeiro dia da semana. @ref{2646,,MONDAY} é @code{0} (o padrão), @ref{2647,,SUNDAY} é @code{6}.

Um objeto @ref{2645,,Calendar} fornece vários métodos que podem ser usados para preparar os dados do calendário para formatação. Esta classe não realiza nenhuma formatação por si mesma. Esse é o trabalho das subclasses.

Instâncias de @ref{2645,,Calendar} têm os seguintes métodos e atributos:

@geindex firstweekday (atributo calendar.Calendar)
@anchor{library/calendar calendar Calendar firstweekday}@anchor{2648}
@deffn {Atributo} firstweekday

O primeiro dia da semana como um inteiro (0–6).

Esta propriedade também pode ser definida e lida usando @ref{2649,,setfirstweekday()} e @ref{264a,,getfirstweekday()} respectivamente.
@end deffn

@geindex getfirstweekday() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar getfirstweekday}@anchor{264a}
@deffn {Método} getfirstweekday ()

Retorna um @ref{257,,int} correspondente ao primeiro dia da semana atual (0-6).

Idêntico à leitura da propriedade @ref{2648,,firstweekday}.
@end deffn

@geindex setfirstweekday() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar setfirstweekday}@anchor{2649}
@deffn {Método} setfirstweekday (firstweekday)

Define o primeiro dia da semana como `firstweekday', passado como @ref{257,,int} (0–6)

Idêntico à definição da propriedade @ref{2648,,firstweekday}.
@end deffn

@geindex iterweekdays() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar iterweekdays}@anchor{264b}
@deffn {Método} iterweekdays ()

Retorna um iterador dos números dos dias da semana que serão usados em uma semana. O primeiro valor do iterador será o mesmo que o da propriedade @ref{2648,,firstweekday}.
@end deffn

@geindex itermonthdates() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdates}@anchor{c33}
@deffn {Método} itermonthdates (year, month)

Retorna um iterador para o mês `month' (1–12) no ano `year'. Este iterador retornará todos os dias (como objetos @ref{1cd,,datetime.date}) do mês, bem como os dias antes do início do mês ou após o final do mês, necessários para obter uma semana completa.
@end deffn

@geindex itermonthdays() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays}@anchor{264c}
@deffn {Método} itermonthdays (year, month)

Retorna um iterador para o mês `month' no ano `year' semelhante a @ref{c33,,itermonthdates()}, mas não restrito pelo intervalo de @ref{1cd,,datetime.date}. Os dias retornados serão simplesmente os números dos dias do mês. Para os dias fora do mês especificado, o número do dia será @code{0}.
@end deffn

@geindex itermonthdays2() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays2}@anchor{264d}
@deffn {Método} itermonthdays2 (year, month)

Retorna um iterador para o mês `month' no ano `year' semelhante a @ref{c33,,itermonthdates()}, mas não restrito pelo intervalo de @ref{1cd,,datetime.date}. Os dias retornados serão tuplas consistindo de um número de dia do mês e um número de dia da semana.
@end deffn

@geindex itermonthdays3() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays3}@anchor{c34}
@deffn {Método} itermonthdays3 (year, month)

Retorna um iterador para o mês `month' no ano `year' semelhante a @ref{c33,,itermonthdates()}, mas não restrito pelo intervalo de @ref{1cd,,datetime.date}. Os dias retornados serão tuplas consistindo de números de um ano, um mês e um dia do mês.


Adicionado na versão 3.7.

@end deffn

@geindex itermonthdays4() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar itermonthdays4}@anchor{c35}
@deffn {Método} itermonthdays4 (year, month)

Retorna um iterador para o mês `month' no ano `year' semelhante a @ref{c33,,itermonthdates()}, mas não restrito pelo intervalo de @ref{1cd,,datetime.date}. Os dias retornados serão tuplas consistindo de números de um ano, um mês, um dia do mês e um dia da semana.


Adicionado na versão 3.7.

@end deffn

@geindex monthdatescalendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdatescalendar}@anchor{264e}
@deffn {Método} monthdatescalendar (year, month)

Retorna uma lista das semanas do mês `month' do `year' como semanas completas. As semanas são listas de sete objetos @ref{1cd,,datetime.date}.
@end deffn

@geindex monthdays2calendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdays2calendar}@anchor{264f}
@deffn {Método} monthdays2calendar (year, month)

Retorna uma lista das semanas do mês `month' do ano `year' como semanas completas. As semanas são listas de sete tuplas de números dias e de dias de semanas.
@end deffn

@geindex monthdayscalendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar monthdayscalendar}@anchor{2650}
@deffn {Método} monthdayscalendar (year, month)

Retorna uma lista das semanas do mês `month' do ano `year' como semanas completas. As semanas são listas de números de sete dias.
@end deffn

@geindex yeardatescalendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardatescalendar}@anchor{2651}
@deffn {Método} yeardatescalendar (year, width=3)

Retorna os dados para o ano especificado prontos para formatação. O valor de retorno é uma lista de linhas de meses. Cada linha de mês contém até `width' meses (padrão é 3). Cada mês contém entre 4 e 6 semanas, e cada semana contém 1–7 dias. Os dias são objetos @ref{1cd,,datetime.date}.
@end deffn

@geindex yeardays2calendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardays2calendar}@anchor{2652}
@deffn {Método} yeardays2calendar (year, width=3)

Retorna os dados para o ano especificado prontos para formatação (semelhante a @ref{2651,,yeardatescalendar()}). Entradas nas listas semanais são tuplas de números de dias e números de dias de semana. Números de dias fora deste mês são zero.
@end deffn

@geindex yeardayscalendar() (método calendar.Calendar)
@anchor{library/calendar calendar Calendar yeardayscalendar}@anchor{2653}
@deffn {Método} yeardayscalendar (year, width=3)

Retorna a data para o ano especificado prontos para formatação (semelhante a @ref{2651,,yeardatescalendar()}). Entradas nas listas de semanas são números de dias. Números de dias fora deste mês são zero.
@end deffn
@end deffn

@geindex TextCalendar (classe em calendar)
@anchor{library/calendar calendar TextCalendar}@anchor{2654}
@deffn {Classe} calendar.TextCalendar (firstweekday=0)

Esta classe pode ser usada para gerar texto plano para calendários.

Instâncias de @ref{2654,,TextCalendar} têm os seguintes métodos:

@geindex formatday() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatday}@anchor{2655}
@deffn {Método} formatday (theday, weekday, width)

Retorna uma string representando um único dia formatado com a largura fornecida em `width'. Se `theday' for @code{0}, retorna uma string de espaços da largura especificada, representando um dia vazio. O parâmetro `weekday' não é usado.
@end deffn

@geindex formatweek() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatweek}@anchor{2656}
@deffn {Método} formatweek (theweek, w=0)

Retorna uma única semana em uma string sem nova linha. Se `w' for providenciado, isto especifica a largura das colunas de data, que são centrais. Dependendo do primeiro dia da semana conforme especificado no construtor ou configurado pelo método @ref{2644,,setfirstweekday()}.
@end deffn

@geindex formatweekday() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatweekday}@anchor{2657}
@deffn {Método} formatweekday (weekday, width)

Retorna uma string representando o nome de um único dia da semana formatado para a largura especificada em `width'. O parâmetro `weekday' é um inteiro representando o dia da semana, onde @code{0} é segunda-feira e @code{6} é domingo.
@end deffn

@geindex formatweekheader() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatweekheader}@anchor{2658}
@deffn {Método} formatweekheader (width)

Retorna uma string contendo a linha de cabeçalho dos nomes dos dias da semana, formatada com a largura fornecida por `width' para cada coluna. Os nomes dependem das configurações de localidade e são preenchidos até a largura especificada.
@end deffn

@geindex formatmonth() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatmonth}@anchor{2659}
@deffn {Método} formatmonth (theyear, themonth, w=0, l=0)

Retorna o calendário do mês em uma string multilinha. Se `w' for providenciado, isto especifica a largura das colunas de data, que são centrais. Se `l' for dado, este especifica o número de linhas que cada semana vai usar. Dependendo do primeiro dia da semana conforme especificado no construtor ou configurado pelo método @ref{2644,,setfirstweekday()}.
@end deffn

@geindex formatmonthname() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatmonthname}@anchor{265a}
@deffn {Método} formatmonthname (theyear, themonth, width=0, withyear=True)

Retorna uma string representando o nome do mês centralizado dentro da largura especificada em `width'. Se `withyear' for @code{True}, inclui o ano na saída. Os parâmetros `theyear' e `themonth' especificam o ano e o mês para o nome a ser formatado, respectivamente.
@end deffn

@geindex prmonth() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar prmonth}@anchor{265b}
@deffn {Método} prmonth (theyear, themonth, w=0, l=0)

Imprime um calendário do mês conforme retornado pelo @ref{2659,,formatmonth()}.
@end deffn

@geindex formatyear() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar formatyear}@anchor{265c}
@deffn {Método} formatyear (theyear, w=2, l=1, c=6, m=3)

Retorna um calendário com `m' colunas para um ano inteiro conforme uma string multilinha. Parâmetros opcionais `w', `l' e `c' definem a largura da coluna data, linhas por semana e números de espaços entre as colunas dos meses, respectivamente. Depende do primeiro dia da semana conforme especificado no construtor ou definido pelo método @ref{2644,,setfirstweekday()}. O ano mais novo para o qual o calendário pode ser gerado depende da plataforma.
@end deffn

@geindex pryear() (método calendar.TextCalendar)
@anchor{library/calendar calendar TextCalendar pryear}@anchor{265d}
@deffn {Método} pryear (theyear, w=2, l=1, c=6, m=3)

Imprime o calendário para um ano inteiro conforme retornado por @ref{265c,,formatyear()}.
@end deffn
@end deffn

@geindex HTMLCalendar (classe em calendar)
@anchor{library/calendar calendar HTMLCalendar}@anchor{b35}
@deffn {Classe} calendar.HTMLCalendar (firstweekday=0)

Esta classse pode ser usada para gerar calendários HTML.

Instâncias de @code{HTMLCalendar} têm os seguintes métodos:

@geindex formatmonth() (método calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatmonth}@anchor{265e}
@deffn {Método} formatmonth (theyear, themonth, withyear=True)

Retorna um calendário do mês como uma tabela HTML. Se `withyear' for verdadeiro, o ano será incluído no cabeçalho, senão apenas o nome do mês será utilizado.
@end deffn

@geindex formatyear() (método calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatyear}@anchor{265f}
@deffn {Método} formatyear (theyear, width=3)

Retorna um calendário do ano como uma tabela HTML. `width' (padronizada para 3) especifica o número de meses por linha.
@end deffn

@geindex formatyearpage() (método calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatyearpage}@anchor{2660}
@deffn {Método} formatyearpage (theyear, width=3, css='calendar.css', encoding=None)

Retorna o calendário de um ano como uma página HTML completa. `width' (padrão 3) especifica o número de meses por linha. `css' é o nome da folha de estilo em cascata a ser usada. @ref{675,,None} pode ser passado se nenhuma folha de estilo deve ser usada. `encoding' especifica a codificação a ser usada para a saída (padrão para a codificação padrão do sistema).
@end deffn

@geindex formatmonthname() (método calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar formatmonthname}@anchor{2661}
@deffn {Método} formatmonthname (theyear, themonth, withyear=True)

Retorna um nome de mês como uma linha de tabela HTML. Se `withyear' for verdadeiro, o ano será incluído na linha, senão apenas o nome do mês será utilizado.
@end deffn

@code{HTMLCalendar} tem os seguintes atributos que você pode substituir para personalizar as classes CSS usadas pelo calendário:

@geindex cssclasses (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclasses}@anchor{2662}
@deffn {Atributo} cssclasses

Uma lista de classes CSS usadas para cada dia da semana. A lista de classes padrão é:

@example
cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
@end example

mais estilos podem ser adicionados para cada dia:

@example
cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
@end example

Observe que o comprimento desta lista deve ser de sete itens.
@end deffn

@geindex cssclass_noday (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_noday}@anchor{2663}
@deffn {Atributo} cssclass_noday

A classe CSS para um dia da semana que ocorre no mês anterior ou seguinte.


Adicionado na versão 3.7.

@end deffn

@geindex cssclasses_weekday_head (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclasses_weekday_head}@anchor{2664}
@deffn {Atributo} cssclasses_weekday_head

Uma lista de classes CSS usadas para nomes de dias da semana na linha de cabeçalho. O padrão é o mesmo que @ref{2662,,cssclasses}.


Adicionado na versão 3.7.

@end deffn

@geindex cssclass_month_head (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_month_head}@anchor{2665}
@deffn {Atributo} cssclass_month_head

A classe CSS principal do mês (usada por @ref{2661,,formatmonthname()}). O valor padrão é @code{"month"}.


Adicionado na versão 3.7.

@end deffn

@geindex cssclass_month (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_month}@anchor{2666}
@deffn {Atributo} cssclass_month

A classe CSS para a tabela do mês inteiro (usada por @ref{265e,,formatmonth()}). O valor padrão é @code{"month"}.


Adicionado na versão 3.7.

@end deffn

@geindex cssclass_year (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_year}@anchor{2667}
@deffn {Atributo} cssclass_year

A classe CSS para a tabela de tabelas do ano inteiro (usada por @ref{265f,,formatyear()}). O valor padrão é @code{"year"}.


Adicionado na versão 3.7.

@end deffn

@geindex cssclass_year_head (atributo calendar.HTMLCalendar)
@anchor{library/calendar calendar HTMLCalendar cssclass_year_head}@anchor{2668}
@deffn {Atributo} cssclass_year_head

A classe CSS para o cabeçalho da tabela para o ano inteiro (usado por @ref{265f,,formatyear()}). O valor padrão é @code{"year"}.


Adicionado na versão 3.7.

@end deffn

Observe que, embora a nomenclatura dos atributos de classe descritos acima seja singular (por exemplo, @code{cssclass_month} @code{cssclass_noday}), é possível substituir a única classe CSS por uma lista de classes CSS separadas por espaços, por exemplo:

@example
"text-bold text-red"
@end example

Aqui está um exemplo de como @code{HTMLCalendar} pode 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 (classe em calendar)
@anchor{library/calendar calendar LocaleTextCalendar}@anchor{744}
@deffn {Classe} calendar.LocaleTextCalendar (firstweekday=0, locale=None)

Esta subclasse de @ref{2654,,TextCalendar} pode receber um nome de localidade no construtor e retornará nomes de meses e dias da semana na localidade especificada.
@end deffn

@geindex LocaleHTMLCalendar (classe em calendar)
@anchor{library/calendar calendar LocaleHTMLCalendar}@anchor{745}
@deffn {Classe} calendar.LocaleHTMLCalendar (firstweekday=0, locale=None)

Esta subclasse de @ref{b35,,HTMLCalendar} pode receber um nome de localidade no construtor e retornará nomes de meses e dias da semana na localidade especificada.
@end deffn

@cartouche
@quotation Nota 
Os métodos construtores @code{formatweekday()} e @code{formatmonthname()} dessas duas classes alteram temporariamente a localidade @code{LC_TIME} para o `locale' fornecido. Como a localidade atual é uma configuração de todo o processo, eles não são seguros para threads.
@end quotation
@end cartouche

Para calendários de texto simples, este módulo fornece as seguintes funções.

@geindex setfirstweekday() (no módulo calendar)
@anchor{library/calendar calendar setfirstweekday}@anchor{2644}
@deffn {Função} calendar.setfirstweekday (weekday)

Define o dia da semana (@code{0} é segunda-feira, @code{6} é domingo) para começar cada semana. Os valores @ref{2646,,MONDAY}, @ref{2669,,TUESDAY}, @ref{266a,,WEDNESDAY}, @ref{266b,,THURSDAY}, @ref{266c,,FRIDAY}, @ref{266d,,SATURDAY} e @ref{2647,,SUNDAY} são fornecidos para conveniência. Por exemplo, para definir o primeiro dia da semana como domingo:

@example
import calendar
calendar.setfirstweekday(calendar.SUNDAY)
@end example
@end deffn

@geindex firstweekday() (no módulo calendar)
@anchor{library/calendar calendar firstweekday}@anchor{266e}
@deffn {Função} calendar.firstweekday ()

Retorna a configuração atual para o dia da semana que inicia cada semana.
@end deffn

@geindex isleap() (no módulo calendar)
@anchor{library/calendar calendar isleap}@anchor{266f}
@deffn {Função} calendar.isleap (year)

Retorna @ref{c27,,True} se `year' for um ano bissexto, caso contrário, @ref{b49,,False}.
@end deffn

@geindex leapdays() (no módulo calendar)
@anchor{library/calendar calendar leapdays}@anchor{2670}
@deffn {Função} calendar.leapdays (y1, y2)

Retorna o número de anos bissextos no intervalo de `y1' a `y2' (exclusivo), onde `y1' e `y2' são anos.

Esta função funciona para intervalos que abrangem uma mudança de século.
@end deffn

@geindex weekday() (no módulo calendar)
@anchor{library/calendar calendar weekday}@anchor{2671}
@deffn {Função} calendar.weekday (year, month, day)

Retorna o dia da semana (@code{0} é segunda-feira) para `year' (@code{1970}–…), `month' (@code{1}–@code{12}), `day' (@code{1}–@code{31}).
@end deffn

@geindex weekheader() (no módulo calendar)
@anchor{library/calendar calendar weekheader}@anchor{2672}
@deffn {Função} calendar.weekheader (n)

Retorna um cabeçalho contendo nomes abreviados de dias da semana. `n' especifica a largura em caracteres para um dia da semana.
@end deffn

@geindex monthrange() (no módulo calendar)
@anchor{library/calendar calendar monthrange}@anchor{2673}
@deffn {Função} calendar.monthrange (year, month)

Retorna o dia da semana do primeiro dia do mês e o número de dias do mês, para o `year' e `month' especificados.
@end deffn

@geindex monthcalendar() (no módulo calendar)
@anchor{library/calendar calendar monthcalendar}@anchor{2674}
@deffn {Função} calendar.monthcalendar (year, month)

Retorna uma matriz representando o calendário de um mês. Cada linha representa uma semana; dias fora do mês são representados por zeros. Cada semana começa com segunda-feira, a menos que seja definida por @ref{2644,,setfirstweekday()}.
@end deffn

@geindex prmonth() (no módulo calendar)
@anchor{library/calendar calendar prmonth}@anchor{2675}
@deffn {Função} calendar.prmonth (theyear, themonth, w=0, l=0)

Imprime um calendário do mês conforme retornado pelo @ref{1686,,month()}.
@end deffn

@geindex month() (no módulo calendar)
@anchor{library/calendar calendar month}@anchor{1686}
@deffn {Função} calendar.month (theyear, themonth, w=0, l=0)

Retorna o calendário de um mês em uma string de várias linhas usando @ref{2659,,formatmonth()} da classe @ref{2654,,TextCalendar}.
@end deffn

@geindex prcal() (no módulo calendar)
@anchor{library/calendar calendar prcal}@anchor{2676}
@deffn {Função} calendar.prcal (year, w=0, l=0, c=6, m=3)

Imprime o calendário para um ano inteiro conforme retornado por @ref{14,,calendar()}.
@end deffn

@geindex calendar() (no módulo calendar)
@anchor{library/calendar calendar calendar}@anchor{2677}
@deffn {Função} calendar.calendar (year, w=2, l=1, c=6, m=3)

Retorna um calendário de 3 colunas para um ano inteiro como uma string de várias linhas usando @ref{265c,,formatyear()} da classe @ref{2654,,TextCalendar}.
@end deffn

@geindex timegm() (no módulo calendar)
@anchor{library/calendar calendar timegm}@anchor{2678}
@deffn {Função} calendar.timegm (tuple)

Uma função não relacionada, mas útil, que pega uma tupla de tempo, como a retornada pela função @ref{1200,,gmtime()} no módulo @ref{ee,,time}, e retorna o valor de registro de data e hora Unix correspondente, presumindo uma época de 1970 e a codificação POSIX. Na verdade, @ref{1200,,time.gmtime()} e @ref{2678,,timegm()} são inversos um do outro.
@end deffn

O módulo @ref{14,,calendar} exporta os seguintes atributos de dados:

@geindex day_name (no módulo calendar)
@anchor{library/calendar calendar day_name}@anchor{2679}
@deffn {Dado} calendar.day_name

Uma sequência que representa os dias da semana no local atual, onde Monday é o dia número 0.

@example
>>> import calendar
>>> list(calendar.day_name)
['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
@end example
@end deffn

@geindex day_abbr (no módulo calendar)
@anchor{library/calendar calendar day_abbr}@anchor{267a}
@deffn {Dado} calendar.day_abbr

Uma sequência que representa os dias abreviados da semana no local atual, onde Mon é o dia número 0.

@example
>>> import calendar
>>> list(calendar.day_abbr)
['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
@end example
@end deffn

@geindex MONDAY (no módulo calendar)
@geindex TUESDAY (no módulo calendar)
@geindex WEDNESDAY (no módulo calendar)
@geindex THURSDAY (no módulo calendar)
@geindex FRIDAY (no módulo calendar)
@geindex SATURDAY (no módulo calendar)
@geindex SUNDAY (no módulo calendar)
@anchor{library/calendar calendar MONDAY}@anchor{2646}
@deffn {Dado} calendar.MONDAY
@anchor{library/calendar calendar TUESDAY}@anchor{2669}
@deffnx {Dado} calendar.TUESDAY
@anchor{library/calendar calendar WEDNESDAY}@anchor{266a}
@deffnx {Dado} calendar.WEDNESDAY
@anchor{library/calendar calendar THURSDAY}@anchor{266b}
@deffnx {Dado} calendar.THURSDAY
@anchor{library/calendar calendar FRIDAY}@anchor{266c}
@deffnx {Dado} calendar.FRIDAY
@anchor{library/calendar calendar SATURDAY}@anchor{266d}
@deffnx {Dado} calendar.SATURDAY
@anchor{library/calendar calendar SUNDAY}@anchor{2647}
@deffnx {Dado} calendar.SUNDAY

Apelidos para os dias da semana, onde @code{MONDAY} é @code{0} e @code{SUNDAY} é @code{6}.


Adicionado na versão 3.12.

@end deffn

@geindex Day (classe em calendar)
@anchor{library/calendar calendar Day}@anchor{482}
@deffn {Classe} calendar.Day

Enumeração que define os dias da semana como constantes inteiras. Os membros dessa enumeração são exportados para o escopo do módulo como @ref{2646,,MONDAY} até @ref{2647,,SUNDAY}.


Adicionado na versão 3.12.

@end deffn

@geindex month_name (no módulo calendar)
@anchor{library/calendar calendar month_name}@anchor{267b}
@deffn {Dado} calendar.month_name

Uma sequência que representa os meses do ano na localidade atual. Isso segue a convenção normal de janeiro sendo o mês número 1, então tem um comprimento de 13 e @code{month_name[0]} é a string vazia.

@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 (no módulo calendar)
@anchor{library/calendar calendar month_abbr}@anchor{267c}
@deffn {Dado} calendar.month_abbr

Uma sequência que representa os meses abreviados do ano na localidade atual. Isso segue a convenção normal de janeiro sendo o mês número 1, então tem um comprimento de 13 e @code{month_abbr[0]} é a string vazia.

@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 (no módulo calendar)
@geindex FEBRUARY (no módulo calendar)
@geindex MARCH (no módulo calendar)
@geindex APRIL (no módulo calendar)
@geindex MAY (no módulo calendar)
@geindex JUNE (no módulo calendar)
@geindex JULY (no módulo calendar)
@geindex AUGUST (no módulo calendar)
@geindex SEPTEMBER (no módulo calendar)
@geindex OCTOBER (no módulo calendar)
@geindex NOVEMBER (no módulo calendar)
@geindex DECEMBER (no módulo calendar)
@anchor{library/calendar calendar JANUARY}@anchor{2f9}
@deffn {Dado} calendar.JANUARY
@anchor{library/calendar calendar FEBRUARY}@anchor{2fa}
@deffnx {Dado} calendar.FEBRUARY
@anchor{library/calendar calendar MARCH}@anchor{267d}
@deffnx {Dado} calendar.MARCH
@anchor{library/calendar calendar APRIL}@anchor{267e}
@deffnx {Dado} calendar.APRIL
@anchor{library/calendar calendar MAY}@anchor{267f}
@deffnx {Dado} calendar.MAY
@anchor{library/calendar calendar JUNE}@anchor{2680}
@deffnx {Dado} calendar.JUNE
@anchor{library/calendar calendar JULY}@anchor{2681}
@deffnx {Dado} calendar.JULY
@anchor{library/calendar calendar AUGUST}@anchor{2682}
@deffnx {Dado} calendar.AUGUST
@anchor{library/calendar calendar SEPTEMBER}@anchor{2683}
@deffnx {Dado} calendar.SEPTEMBER
@anchor{library/calendar calendar OCTOBER}@anchor{2684}
@deffnx {Dado} calendar.OCTOBER
@anchor{library/calendar calendar NOVEMBER}@anchor{2685}
@deffnx {Dado} calendar.NOVEMBER
@anchor{library/calendar calendar DECEMBER}@anchor{2686}
@deffnx {Dado} calendar.DECEMBER

Apelidos para os meses do ano, onde @code{JANUARY} é @code{1} e @code{DECEMBER} é @code{12}.


Adicionado na versão 3.12.

@end deffn

@geindex Month (classe em calendar)
@anchor{library/calendar calendar Month}@anchor{481}
@deffn {Classe} calendar.Month

Enumeração que define os meses do ano como constantes inteiras. Os membros dessa enumeração são exportados para o escopo do módulo como @ref{2f9,,JANUARY} até @ref{2686,,DECEMBER}.


Adicionado na versão 3.12.

@end deffn

O módulo @ref{14,,calendar} define as seguintes exceções:

@geindex IllegalMonthError
@anchor{library/calendar calendar IllegalMonthError}@anchor{1685}
@deffn {Exceção} calendar.IllegalMonthError (month)

Uma subclasse de @ref{202,,ValueError}, levantada quando o número do mês fornecido está fora do intervalo de 1 a 12 (inclusive).

@geindex month (atributo calendar.IllegalMonthError)
@anchor{library/calendar calendar IllegalMonthError month}@anchor{2687}
@deffn {Atributo} month

O número de meses inválidos.
@end deffn
@end deffn

@geindex IllegalWeekdayError
@anchor{library/calendar calendar IllegalWeekdayError}@anchor{2688}
@deffn {Exceção} calendar.IllegalWeekdayError (weekday)

Uma subclasse de @ref{202,,ValueError}, levantada quando o número do dia da semana fornecido está fora do intervalo de 0 a 6 (inclusive).

@geindex weekday (atributo calendar.IllegalWeekdayError)
@anchor{library/calendar calendar IllegalWeekdayError weekday}@anchor{2689}
@deffn {Atributo} weekday

O número de dias da semana inválidos.
@end deffn
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{30,,datetime}

Interface orientada a objetos para datas e horas com funcionalidade semelhante ao módulo @ref{ee,,time}.

@item Módulo @ref{ee,,time}

Funções de baixo nível relacionadas ao tempo.
@end table


@menu
* Uso na linha de comando:: 

@end menu

@node Uso na linha de comando,,,calendar — Funções gerais relacionadas ao calendário
@anchor{library/calendar calendar-cli}@anchor{268a}@anchor{library/calendar command-line-usage}@anchor{268b}
@subsubsection Uso na linha de comando



Adicionado na versão 2.5.


O módulo @ref{14,,calendar} pode ser executado como um script na linha de comando para exibir um calendário interativamente.

@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 exemplo, para exibir um calendário para o ano 2000:

@example
$ python -m calendar 2000                                  2000      January                   February                   MarchMo 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 1210 11 12 13 14 15 16      14 15 16 17 18 19 20      13 14 15 16 17 18 1917 18 19 20 21 22 23      21 22 23 24 25 26 27      20 21 22 23 24 25 2624 25 26 27 28 29 30      28 29                     27 28 29 30 3131       April                      May                       JuneMo 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 1110 11 12 13 14 15 16      15 16 17 18 19 20 21      12 13 14 15 16 17 1817 18 19 20 21 22 23      22 23 24 25 26 27 28      19 20 21 22 23 24 2524 25 26 27 28 29 30      29 30 31                  26 27 28 29 30        July                     August                  SeptemberMo 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 1010 11 12 13 14 15 16      14 15 16 17 18 19 20      11 12 13 14 15 16 1717 18 19 20 21 22 23      21 22 23 24 25 26 27      18 19 20 21 22 23 2424 25 26 27 28 29 30      28 29 30 31               25 26 27 28 29 3031      October                   November                  DecemberMo 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 1716 17 18 19 20 21 22      20 21 22 23 24 25 26      18 19 20 21 22 23 2423 24 25 26 27 28 29      27 28 29 30               25 26 27 28 29 30 3130 31
@end example

As seguintes opções são aceitas:

@geindex calendar opção de linha de comando; --help
@geindex calendar opção de linha de comando; -h
@anchor{library/calendar cmdoption-calendar-help}@anchor{268c}@anchor{library/calendar cmdoption-calendar-h}@anchor{268d}
@deffn {Option} @w{-}@w{-}help, @w{-}h

Mostra a mensagem de ajuda e sai.
@end deffn

@geindex calendar opção de linha de comando; --locale
@geindex calendar opção de linha de comando; -L
@anchor{library/calendar cmdoption-calendar-locale}@anchor{268e}@anchor{library/calendar cmdoption-calendar-L}@anchor{268f}
@deffn {Option} @w{-}@w{-}locale LOCALE, @w{-}L LOCALE

A localidade a ser usada para nomes de meses e dias da semana. O padrão é inglês.
@end deffn

@geindex calendar opção de linha de comando; --encoding
@geindex calendar opção de linha de comando; -e
@anchor{library/calendar cmdoption-calendar-encoding}@anchor{2690}@anchor{library/calendar cmdoption-calendar-e}@anchor{2691}
@deffn {Option} @w{-}@w{-}encoding ENCODING, @w{-}e ENCODING

A codificação a ser usada na saída. @ref{2690,,--encoding} é necessário se @ref{268e,,--locale} estiver definido.
@end deffn

@geindex calendar opção de linha de comando; --type
@geindex calendar opção de linha de comando; -t
@anchor{library/calendar cmdoption-calendar-type}@anchor{2692}@anchor{library/calendar cmdoption-calendar-t}@anchor{2693}
@deffn {Option} @w{-}@w{-}type @{text,html@}, @w{-}t @{text,html@}

Exibe o calendário no terminal como texto ou como um documento HTML.
@end deffn

@geindex calendar opção de linha de comando; --first-weekday
@geindex calendar opção de linha de comando; -f
@anchor{library/calendar cmdoption-calendar-first-weekday}@anchor{2694}@anchor{library/calendar cmdoption-calendar-f}@anchor{2695}
@deffn {Option} @w{-}@w{-}first@w{-}weekday FIRST_WEEKDAY, @w{-}f FIRST_WEEKDAY

O dia da semana para começar cada semana. Deve ser um número entre 0 (segunda-feira) e 6 (domingo). O padrão é 0.


Adicionado na versão 3.13.

@end deffn

@geindex calendar opção de linha de comando; year
@anchor{library/calendar cmdoption-calendar-arg-year}@anchor{2696}
@deffn {Option} year

O ano para exibir o calendário. O padrão é o ano atual.
@end deffn

@geindex calendar opção de linha de comando; month
@anchor{library/calendar cmdoption-calendar-arg-month}@anchor{2697}
@deffn {Option} month

O mês do @ref{2696,,year} especificado para exibir o calendário. Deve ser um número entre 1 e 12 e pode ser usado somente no modo texto. O padrão é exibir um calendário para todo o ano.
@end deffn

`Opções de modo texto:'

@geindex calendar opção de linha de comando; --width
@geindex calendar opção de linha de comando; -w
@anchor{library/calendar cmdoption-calendar-width}@anchor{2698}@anchor{library/calendar cmdoption-calendar-w}@anchor{2699}
@deffn {Option} @w{-}@w{-}width WIDTH, @w{-}w WIDTH

A largura da coluna de data no terminal. A data é exibida centralizada na coluna. Qualquer valor inferior a 2 é ignorado. O padrão é 2.
@end deffn

@geindex calendar opção de linha de comando; --lines
@geindex calendar opção de linha de comando; -l
@anchor{library/calendar cmdoption-calendar-lines}@anchor{269a}@anchor{library/calendar cmdoption-calendar-l}@anchor{269b}
@deffn {Option} @w{-}@w{-}lines LINES, @w{-}l LINES

O número de linhas por semana no terminal. A data é exibida alinhada no topo. Qualquer valor inferior a 1 é ignorado. O padrão é 1.
@end deffn

@geindex calendar opção de linha de comando; --spacing
@geindex calendar opção de linha de comando; -s
@anchor{library/calendar cmdoption-calendar-spacing}@anchor{269c}@anchor{library/calendar cmdoption-calendar-s}@anchor{269d}
@deffn {Option} @w{-}@w{-}spacing SPACING, @w{-}s SPACING

O espaço entre os meses nas colunas. Qualquer valor inferior a 2 é ignorado. O padrão é 6.
@end deffn

@geindex calendar opção de linha de comando; --months
@geindex calendar opção de linha de comando; -m
@anchor{library/calendar cmdoption-calendar-months}@anchor{269e}@anchor{library/calendar cmdoption-calendar-m}@anchor{269f}
@deffn {Option} @w{-}@w{-}months MONTHS, @w{-}m MONTHS

O número de meses exibidos por linha. O padrão é 3.
@end deffn

`Opções do modo HTML:'

@geindex calendar opção de linha de comando; --css
@geindex calendar opção de linha de comando; -c
@anchor{library/calendar cmdoption-calendar-css}@anchor{26a0}@anchor{library/calendar cmdoption-calendar-c}@anchor{26a1}
@deffn {Option} @w{-}@w{-}css CSS, @w{-}c CSS

O caminho de uma folha de estilo CSS a ser usada no calendário. Isso deve ser relativo ao HTML gerado ou a um HTTP absoluto ou a uma URL @code{file:///}.
@end deffn

@node collections — Tipos de dados de contêineres,collections abc — Classes Base Abstratas para Contêineres,calendar — Funções gerais relacionadas ao calendário,Tipos de Dados
@anchor{library/collections doc}@anchor{26a2}@anchor{library/collections collections-container-datatypes}@anchor{26a3}@anchor{library/collections module-collections}@anchor{1d}@anchor{library/collections translation-repo}@anchor{26a4}
@subsection @code{collections} — Tipos de dados de contêineres


@geindex module; collections

`Código-fonte:' Lib/collections/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/collections/__init__.py}

@c from collections import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


Este módulo implementa tipos de dados de contêineres especializados que fornecem alternativas aos contêineres embutidos do Python, @ref{256,,dict}, @ref{611,,list}, @ref{5d9,,set} e @ref{370,,tuple}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{1ca,,namedtuple()}

@tab

função fábrica (`factory function') para criar subclasses de tuplas com campos nomeados

@item

@ref{5dc,,deque}

@tab

contêiner lista ou similar com acréscimos e retiradas rápidas nas duas extremidades

@item

@ref{c36,,ChainMap}

@tab

classe dict ou similar para criar uma visão única de vários mapeamentos

@item

@ref{10d0,,Counter}

@tab

subclasse de dict para contar objetos @ref{610,,hasheáveis}

@item

@ref{5db,,OrderedDict}

@tab

subclasse de dict que lembra a ordem que as entradas foram adicionadas

@item

@ref{11fc,,defaultdict}

@tab

subclasse de dict que chama uma função fábrica para fornecer valores não encontrados

@item

@ref{1b0c,,UserDict}

@tab

invólucro em torno de objetos dicionário para facilitar fazer subclasse de dict

@item

@ref{152c,,UserList}

@tab

invólucro em torno de objetos lista para facilitar criação de subclasse de lista

@item

@ref{dfd,,UserString}

@tab

invólucro em torno de objetos string para uma facilitar criação de subclasse de string

@end multitable


@menu
* Objetos ChainMap:: 
* Objetos Counter:: 
* Objetos deque:: 
* Objetos defaultdict:: 
* Função de fábrica para tuplas com campos nomeados namedtuple(): Função de fábrica para tuplas com campos nomeados namedtuple. 
* Objetos OrderedDict:: 
* Objetos UserDict:: 
* Objetos UserList:: 
* Objetos UserString:: 

@end menu

@node Objetos ChainMap,Objetos Counter,,collections — Tipos de dados de contêineres
@anchor{library/collections chainmap-objects}@anchor{26a5}
@subsubsection Objetos @code{ChainMap}



Adicionado na versão 3.3.


Uma classe @ref{c36,,ChainMap} é fornecida para ligar rapidamente uma série de mapeamentos de forma que possam ser tratados como um só. O que é frequentemente mais rápido do que criar um novo dicionário e executar múltiplas chamadas de @ref{14ad,,update()}.

A classe pode ser usada para simular escopos aninhados e é útil em modelos.

@geindex ChainMap (classe em collections)
@anchor{library/collections collections ChainMap}@anchor{c36}
@deffn {Classe} collections.ChainMap (*maps)

@ref{c36,,ChainMap} agrupa múltiplos dicts ou outros mapeamentos para criar uma única vista atualizável. Se nenhum `maps' for especificado, um dicionário vazio será fornecido para que uma nova cadeia tenha sempre pelo menos um mapeamento.

Os mapeamentos subjacentes são armazenados em uma lista. Essa lista é pública e pode ser acessada ou atualizada usando o atributo `maps'. Não existe outro estado.

Faz uma busca nos mapeamentos subjacentes sucessivamente até que uma chave seja encontrada. Em contraste, escrita, atualizações e remoções operam apenas no primeiro mapeamento.

Uma @ref{c36,,ChainMap} incorpora os mapeamentos subjacentes por referência. Então, se um dos mapeamentos subjacentes for atualizado, essas alterações serão refletidas na @ref{c36,,ChainMap}.

Todos os métodos usuais do dicionário são suportados. Além disso, existe um atributo `maps', um método para criar novos subcontextos e uma propriedade para acessar todos, exceto o primeiro mapeamento:

@geindex maps (atributo collections.ChainMap)
@anchor{library/collections collections ChainMap maps}@anchor{26a6}
@deffn {Atributo} maps

Uma lista de mapeamentos atualizáveis pelo usuário. A lista é ordenada desde o primeiro pesquisado até a última pesquisado. É o único estado armazenado e pode ser modificado para alterar quais mapeamentos são pesquisados. A lista deve sempre conter pelo menos um mapeamento.
@end deffn

@geindex new_child() (método collections.ChainMap)
@anchor{library/collections collections ChainMap new_child}@anchor{f55}
@deffn {Método} new_child (m=None, **kwargs)

Retorna uma nova @ref{c36,,ChainMap} contendo um novo mapa seguido de todos os mapas na instância atual. Se @code{m} for especificado, torna-se o novo mapa na frente da lista de mapeamentos; Se não especificado, é usado um dicionário vazio, de modo que chamar @code{d.new_child()} é equivalente a: @code{ChainMap(@{@}, *d.maps)}. Se algum argumento nomeado for especificado, ele atualizará o mapa passado ou o novo dicionário vazio. Esse método é usado para criar subcontextos que podem ser atualizados sem alterar valores em nenhum dos mapeamentos pai.


Alterado na versão 3.4: O parâmetro opcional @code{m} foi adicionado.



Alterado na versão 3.10: Suporte a argumentos nomeados foi adicionado.

@end deffn

@geindex parents (atributo collections.ChainMap)
@anchor{library/collections collections ChainMap parents}@anchor{26a7}
@deffn {Atributo} parents

Propriedade que retorna um novo @ref{c36,,ChainMap} contendo todos os mapas da instância atual, exceto o primeiro. Isso é útil para pular o primeiro mapa da pesquisa. Os casos de uso são semelhantes aos do argumento nomeado @ref{12ea,,nonlocal} usada em @ref{20d0,,escopos aninhados}. Os casos de uso também são paralelos aos da função embutida @ref{4db,,super()}. Uma referência a @code{d.parents} é equivalente a: @code{ChainMap(*d.maps[1:])}.
@end deffn

Observe, a ordem de iteração de um @ref{c36,,ChainMap} é determinada pela varredura dos mapeamentos do último ao primeiro:

@example
>>> baseline = @{'music': 'bach', 'art': 'rembrandt'@}
>>> adjustments = @{'art': 'van gogh', 'opera': 'carmen'@}
>>> list(ChainMap(adjustments, baseline))
['music', 'art', 'opera']
@end example

Isso dá a mesma ordem de uma série de chamadas de @ref{14ad,,dict.update()} começando com o último mapeamento:

@example
>>> combined = baseline.copy()
>>> combined.update(adjustments)
>>> list(combined)
['music', 'art', 'opera']
@end example


Alterado na versão 3.9: Adicionado suporte para os operadores @code{|} e @code{|=}, especificados na 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn


@subsubheading Ver também



@itemize *

@item 
A classe MultiContext@footnote{https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py} no pacote CodeTools@footnote{https://github.com/enthought/codetools} de Enthought tem opções para oferecer suporte à escrita em qualquer mapeamento na cadeia.

@item 
A classe Context@footnote{https://github.com/django/django/blob/main/django/template/context.py} do Django para modelos é uma cadeia de mapeamentos somente leitura. Ela também oferece o recurso de push e pop (inserir e retirar) contextos semelhantes ao método @code{new_child()} e a propriedade @code{parents}.

@item 
A receita de Contextos Aninhados@footnote{https://code.activestate.com/recipes/577434-nested-contexts-a-chain-of-mapping-objects/} possui opções para controlar se escritas e outras mutações se aplicam a apenas o primeiro mapeamento ou para qualquer mapeamento na cadeia.

@item 
Uma versão muito simplificada somente leitura do Chainmap@footnote{https://code.activestate.com/recipes/305268/}.
@end itemize


@menu
* Exemplos e Receitas de ChainMap:: 

@end menu

@node Exemplos e Receitas de ChainMap,,,Objetos ChainMap
@anchor{library/collections chainmap-examples-and-recipes}@anchor{26a8}
@subsubsection Exemplos e Receitas de @code{ChainMap}


Esta seção mostra várias abordagens para trabalhar com mapas encadeados.

Exemplo de simulação da cadeia de busca interna do Python:

@example
import builtins
pylookup = ChainMap(locals(), globals(), vars(builtins))
@end example

Exemplo de como permitir que os argumentos de linha de comando especificados pelo usuário tenham precedência sobre as variáveis de ambiente que, por sua vez, têm precedência sobre os valores padrão:

@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

Padrões de exemplo para utilização da classe @ref{c36,,ChainMap} para simular contextos aninhados:

@example
c = ChainMap()        # Cria o contexto raiz
d = c.new_child()     # Cria um contexto filho aninhado
e = c.new_child()     # Filho de c, independente de d
e.maps[0]             # Dicionário do contexto atual -- como locals() do Python
e.maps[-1]            # Contexto raiz -- como globals() do Python
e.parents             # Envolvendo cadeia de contexto -- como os nonlocals do Python

d['x'] = 1            # Define valor no contexto atual
d['x']                # Obtém a primeira chave na cadeia de contextos
del d['x']            # Exclui do contexto atual
list(d)               # Todos os valores aninhados
k in d                # Verifica todos os valores aninhados
len(d)                # Número de valores aninhados
d.items()             # Todos os itens aninhados
dict(d)               # Achata em um dicionário comum
@end example

A classe @ref{c36,,ChainMap} só faz atualizações (escritas e remoções) no primeiro mapeamento na cadeia, enquanto as pesquisas irão buscar em toda a cadeia. Contudo, se há o desejo de escritas e remoções profundas, é fácil fazer uma  subclasse que atualiza chaves encontradas mais a fundo na cadeia:

@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'         # atualiza uma chave existente dois níveis abaixo
>>> d['snake'] = 'red'           # novas chaves são adicionadas ao dict mais acima
>>> del d['elephant']            # remove uma chave existente um nível abaixo
>>> d                            # exibe o resultado
DeepChainMap(@{'zebra': 'black', 'snake': 'red'@}, @{@}, @{'lion': 'orange'@})
@end example

@node Objetos Counter,Objetos deque,Objetos ChainMap,collections — Tipos de dados de contêineres
@anchor{library/collections counter-objects}@anchor{26a9}
@subsubsection Objetos @code{Counter}


Uma ferramenta de contagem é fornecida para apoiar contas rápidas e convenientes. Por exemplo:

@example
>>> # Conta ocorrências de palavras em uma lista
>>> cnt = Counter()
>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
...     cnt[word] += 1
...
>>> cnt
Counter(@{'blue': 3, 'red': 2, 'green': 1@})

>>> # Encontra as dez palavras mais comuns em 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 (classe em collections)
@anchor{library/collections collections Counter}@anchor{10d0}
@deffn {Classe} collections.Counter ([iterable-or-mapping])

Um @ref{10d0,,Counter} é uma subclasse de @ref{256,,dict} subclass para contagem de objetos @ref{610,,hasheáveis}. É uma coleção na qual elementos são armazenados como chaves de dicionário e suas contagens são armazenadas como valores de dicionário.  Contagens podem ser qualquer valor inteiro incluindo zero e contagens negativas.  A classe @ref{10d0,,Counter} é similar a sacos ou multiconjuntos em outras linguagens.

Os elementos são contados a partir de um iterável `iterable' ou inicializado a partir de um outro mapeamento `mapping' (ou 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

Objetos Counter tem uma interface de dicionário, com a diferença que devolvem uma contagem zero para itens que não estão presentes em vez de levantar a exceção @ref{344,,KeyError}:

@example
>>> c = Counter(['eggs', 'ham'])
>>> c['bacon']                              # count of a missing element is zero
0
@end example

Definir uma contagem como zero não remove um elemento do contador. Use @code{del} para o remover completamente.

@example
>>> c['sausage'] = 0                        # counter entry with a zero count
>>> del c['sausage']                        # del actually removes the entry
@end example


Adicionado na versão 3.1.



Alterado na versão 3.7: Como uma subclasse de @ref{256,,dict}, @ref{10d0,,Counter} herda a capacidade de lembrar a ordem de inserção. Operações matemáticas em objetos `Counter' também preservam ordem. Os resultados são ordenados de acordo com o momento que um elemento é encontrado pela primeira vez no operando da esquerda e, em seguida, pela ordem encontrada no operando da direita.


Objetos Counter têm suporte a métodos adicionais além daqueles que já estão disponíveis para todos os dicionários:

@geindex elements() (método collections.Counter)
@anchor{library/collections collections Counter elements}@anchor{1348}
@deffn {Método} elements ()

Retorna um iterador sobre os elementos, repetindo cada um tantas vezes quanto sua contagem. Os elementos são retornados na ordem em que foram encontrados pela primeira vez. Se a contagem de um elemento é menor que um, ele será ignorado por @ref{1348,,elements()} .

@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 collections.Counter)
@anchor{library/collections collections Counter most_common}@anchor{1347}
@deffn {Método} most_common ([n])

Retorna uma lista dos `n' elementos mais comuns e suas contagens, do mais comum para o menos comum.  Se `n' for omitido ou igual a @code{None}, @ref{1347,,most_common()} retorna `todos' os elementos no contador. Elementos com contagens iguais são ordenados na ordem em que foram encontrados pela primeira vez:

@example
>>> Counter('abracadabra').most_common(3)
[('a', 5), ('b', 2), ('r', 2)]
@end example
@end deffn

@geindex subtract() (método collections.Counter)
@anchor{library/collections collections Counter subtract}@anchor{121e}
@deffn {Método} subtract ([iterable-or-mapping])

Os elementos são subtraídos de um iterável `iterable' ou de outro mapeamento `mapping' (ou contador).  Funciona como @ref{14ad,,dict.update()}, mas subtraindo contagens ao invés de substituí-las.  Tanto as entradas quanto as saídas podem ser zero ou 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


Adicionado na versão 3.2.

@end deffn

@geindex total() (método collections.Counter)
@anchor{library/collections collections Counter total}@anchor{26aa}
@deffn {Método} total ()

Calcula a soma das contagens.

@example
>>> c = Counter(a=10, b=5, c=0)
>>> c.total()
15
@end example


Adicionado na versão 3.10.

@end deffn

Os métodos usuais de dicionário estão disponíveis para objetos @ref{10d0,,Counter}, exceto por dois que funcionam de forma diferente para contadores.

@geindex fromkeys() (método collections.Counter)
@anchor{library/collections collections Counter fromkeys}@anchor{26ab}
@deffn {Método} fromkeys (iterable)

Este método de classe não está implementado para objetos @ref{10d0,,Counter}.
@end deffn

@geindex update() (método collections.Counter)
@anchor{library/collections collections Counter update}@anchor{15a4}
@deffn {Método} update ([iterable-or-mapping])

Elementos são contados a partir de um iterável `iterable' ou adicionados de outro mapeamento `mapping' (ou contador). Funciona como @ref{14ad,,dict.update()}, mas adiciona contagens em vez de substituí-las. Além disso, é esperado que o `iterable' seja uma sequência de elementos, e não uma sequência de pares @code{(key, value)}.
@end deffn
@end deffn

Os contadores oferecem suporte a operadores de comparação rica para relacionamentos de igualdade, subconjunto e superconjunto: @code{==}, @code{!=}, @code{<}, @code{<=}, @code{>}, @code{>=}. Todos esses testes tratam os elementos ausentes como tendo contagens zero para que @code{Counter(a=1) == Counter(a=1, b=0)} retorne verdadeiro.


Alterado na versão 3.10: Foram adicionadas operações de rica comparação.



Alterado na versão 3.10: Em testes de igualdade, os elementos ausentes são tratados como tendo contagens zero. Anteriormente, @code{Counter(a=3)} e @code{Counter(a=3, b=0)} eram considerados distintos.


Padrões comuns para trabalhar com objetos @ref{10d0,,Counter}:

@example
c.total()                       # total de todas as contagens
c.clear()                       # redefine todas as contagens
list(c)                         # lista elementos únicos
set(c)                          # converte para um conjunto
dict(c)                         # converte para um dicionário comum
c.items()                       # acessa os pares (elem, cnt)
Counter(dict(list_of_pairs))    # converte de uma lista de pares (elem, cnt)
c.most_common()[:-n-1:-1]       # n últimos elementos comuns
+c                              # remove zero e contagens negativas
@end example

Diversas operações matemáticas são fornecidas combinando objetos do tipo @ref{10d0,,Counter} afim de se produzir multiconjuntos (Counters que possuem contagens maiores que 0). Adição e subtração combinam contadores adicionando ou subtraindo o contagem do elemento correspondente. Intersecção ou união retorna o mínimo e máximo da contagem correspondente. Igualdade e inclusão compara as contagens correspondentes. Cada operação aceita entradas com contagens assinadas, mas a saída vai excluir resultados com contagens de zero ou menos.

@example
>>> c = Counter(a=3, b=1)
>>> d = Counter(a=1, b=2)
>>> c + d                       # adiciona dois contadores juntos:  c[x] + d[x]
Counter(@{'a': 4, 'b': 3@})
>>> c - d                       # subtrai (mantendo apenas contagens positivas)
Counter(@{'a': 2@})
>>> c & d                       # interseção:  min(c[x], d[x])
Counter(@{'a': 1, 'b': 1@})
>>> c | d                       # união:  max(c[x], d[x])
Counter(@{'a': 3, 'b': 2@})
>>> c == d                      # igualdade:  c[x] == d[x]
False
>>> c <= d                      # inclusão:  c[x] <= d[x]
False
@end example

A adição e subtração unárias são atalhos para adicionar um contador vazio ou subtrair de um contador vazio.

@example
>>> c = Counter(a=2, b=-4)
>>> +c
Counter(@{'a': 2@})
>>> -c
Counter(@{'b': 4@})
@end example


Adicionado na versão 3.3: Adicionado suporte para operador unário mais, unário menos e operações `in-place' em multiconjuntos.


@cartouche
@quotation Nota 
Os contadores foram projetados principalmente para funcionar com números inteiros positivos para representar contagens contínuas; no entanto, foi tomado cuidado para não impedir desnecessariamente os casos de uso que precisassem de outros tipos ou valores negativos.  Para ajudar nesses casos de uso, esta seção documenta o intervalo mínimo e as restrições de tipo.


@itemize *

@item 
A própria classe @ref{10d0,,Counter} é uma subclasse de dicionário sem restrições em suas chaves e valores. Os valores pretendem ser números que representam contagens, mas você `pode' armazenar qualquer coisa no campo de valor.

@item 
O método @ref{1347,,most_common()} requer apenas que os valores sejam ordenáveis.

@item 
Para operações in-place, como @code{c[key] += 1}, o tipo de valor precisa oferecer suporte a apenas adição e subtração. Portanto, frações, números de ponto flutuante e decimais funcionariam e os valores negativos são suportados. O mesmo também é verdadeiro para @ref{15a4,,update()} e @ref{121e,,subtract()} que permitem valores negativos e zero para entradas e saídas.

@item 
Os métodos de multiconjuntos são projetados apenas para casos de uso com valores positivos. As entradas podem ser negativas ou zero, mas apenas saídas com valores positivos são criadas. Não há restrições de tipo, mas o tipo de valor precisa suportar adição, subtração e comparação.

@item 
O método @ref{1348,,elements()} requer contagens de inteiros. Ele ignora contagens zero e negativas.
@end itemize
@end quotation
@end cartouche


@subsubheading Ver também



@itemize *

@item 
Classe Bag@footnote{https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html} do Smalltalk.

@item 
Entrada da Wikipédia para Multiconjuntos@footnote{https://pt.wikipedia.org/wiki/Multiconjunto}.

@item 
Tutorial com exemplos de multiconjuntos no C++@footnote{http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm}.

@item 
Para operações matemáticas em multiconjuntos e seus casos de uso, consulte `Knuth, Donald. The Art of Computer Programming Volume II, Seção 4.6.3, Exercício 19'.

@item 
Para enumerar todos os multiconjuntos distintos de um determinado tamanho em um determinado conjunto de elementos, consulte @ref{12c3,,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 — Tipos de dados de contêineres
@anchor{library/collections deque-objects}@anchor{26ac}
@subsubsection Objetos @code{deque}


@geindex deque (classe em collections)
@anchor{library/collections collections deque}@anchor{5dc}
@deffn {Classe} collections.deque ([iterable[, maxlen]])

Retorna um novo objeto deque inicializado da esquerda para a direita (usando @ref{26ad,,append()}) com dados do iterável `iterable'. Se `iterable' não for especificado, o novo deque estará vazio.

Deques são uma generalização de pilhas e filas (o nome é pronunciado “deck” e é abreviação de “double-ended queue”, e conhecida como “fila duplamente terminada” em português). O Deques oferece suporte para acréscimos e retiradas seguros para thread e eficientes em uso memória de ambos os lados do deque com aproximadamente o mesmo desempenho `O'(1) em qualquer direção.

Embora os objetos @ref{611,,list} ofereçam suporte a operações semelhantes, eles são otimizados para operações rápidas de comprimento fixo e sujeitam em custos de movimentação de memória `O'(`n') para as operações @code{pop(0)} e @code{insert(0, v)} que alteram o tamanho e a posição da representação de dados subjacente.

Se `maxlen' não for especificado ou for @code{None}, deques podem crescer para um comprimento arbitrário. Caso contrário, o deque é limitado ao comprimento máximo especificado. Quando um deque de comprimento limitado está cheio, quando novos itens são adicionados, um número correspondente de itens é descartado da extremidade oposta. Deques de comprimento limitado fornecem funcionalidade semelhante ao filtro @code{tail} no Unix. Eles também são úteis para rastrear transações e outras pools de dados onde apenas a atividade mais recente é de interesse.

Os objetos Deque oferecem suporte aos seguintes métodos:

@geindex append() (método collections.deque)
@anchor{library/collections collections deque append}@anchor{26ad}
@deffn {Método} append (x)

Adiciona `x' ao lado direito do deque.
@end deffn

@geindex appendleft() (método collections.deque)
@anchor{library/collections collections deque appendleft}@anchor{26ae}
@deffn {Método} appendleft (x)

Adiciona `x' ao lado esquerdo do deque
@end deffn

@geindex clear() (método collections.deque)
@anchor{library/collections collections deque clear}@anchor{26af}
@deffn {Método} clear ()

Remove todos os elementos do deque deixando-o com comprimento 0.
@end deffn

@geindex copy() (método collections.deque)
@anchor{library/collections collections deque copy}@anchor{dfc}
@deffn {Método} copy ()

Cria uma cópia rasa do deque.


Adicionado na versão 3.5.

@end deffn

@geindex count() (método collections.deque)
@anchor{library/collections collections deque count}@anchor{1220}
@deffn {Método} count (x)

Conta o número de elementos deque igual a `x'.


Adicionado na versão 3.2.

@end deffn

@geindex extend() (método collections.deque)
@anchor{library/collections collections deque extend}@anchor{26b0}
@deffn {Método} extend (iterable)

Estende o lado direito do deque anexando elementos do argumento iterável.
@end deffn

@geindex extendleft() (método collections.deque)
@anchor{library/collections collections deque extendleft}@anchor{26b1}
@deffn {Método} extendleft (iterable)

Estende o lado esquerdo do deque anexando elementos de `iterable'. Observe que a série de acréscimos à esquerda resulta na reversão da ordem dos elementos no argumento iterável.
@end deffn

@geindex index() (método collections.deque)
@anchor{library/collections collections deque index}@anchor{dfa}
@deffn {Método} index (x[, start[, stop]])

Retorna a posição de `x' no deque (no ou após o índice `start' e antes do índice `stop'). Retorna a primeira correspondência ou levanta @ref{202,,ValueError} se não for encontrado.


Adicionado na versão 3.5.

@end deffn

@geindex insert() (método collections.deque)
@anchor{library/collections collections deque insert}@anchor{dfb}
@deffn {Método} insert (i, x)

Insere `x' no deque na posição `i'.

Se a inserção fizer com que um deque limitado cresça além de `maxlen', uma @ref{157e,,IndexError} é levantada.


Adicionado na versão 3.5.

@end deffn

@geindex pop() (método collections.deque)
@anchor{library/collections collections deque pop}@anchor{26b2}
@deffn {Método} pop ()

Remove e devolve um elemento do lado direito do deque. Se nenhum elemento estiver presente, levanta um @ref{157e,,IndexError}.
@end deffn

@geindex popleft() (método collections.deque)
@anchor{library/collections collections deque popleft}@anchor{26b3}
@deffn {Método} popleft ()

Remove e devolve um elemento do lado esquerdo do deque. Se nenhum elemento estiver presente, levanta um @ref{157e,,IndexError}.
@end deffn

@geindex remove() (método collections.deque)
@anchor{library/collections collections deque remove}@anchor{1a5b}
@deffn {Método} remove (value)

Remove a primeira ocorrência de `value'. Se não for encontrado, levanta um @ref{202,,ValueError}.
@end deffn

@geindex reverse() (método collections.deque)
@anchor{library/collections collections deque reverse}@anchor{1221}
@deffn {Método} reverse ()

Inverte os elementos do deque no local e, em seguida, retorna @code{None}.


Adicionado na versão 3.2.

@end deffn

@geindex rotate() (método collections.deque)
@anchor{library/collections collections deque rotate}@anchor{1a1c}
@deffn {Método} rotate (n=1)

Gira o deque `n' passos para a direita. Se `n' for negativo, gire para a esquerda.

Quando o deque não está vazio, girar um passo para a direita é equivalente a @code{d.appendleft(d.pop())} e girar um passo para a esquerda é equivalente a @code{d.append(d.popleft())}.
@end deffn

Os objetos Deque também fornecem um atributo somente leitura:

@geindex maxlen (atributo collections.deque)
@anchor{library/collections collections deque maxlen}@anchor{1349}
@deffn {Atributo} maxlen

Tamanho máximo de um deque ou @code{None} se ilimitado.


Adicionado na versão 3.1.

@end deffn
@end deffn

Além do acima, deques oferece suporte a iteração, serialização com pickle, @code{len(d)}, @code{reversed(d)}, @code{copy.copy(d)}, @code{copy.deepcopy(d)} e teste de associação com o operador @ref{2f4,,in} e referências subscritas, como @code{d[0]} para acessar o primeiro elemento. O acesso indexado é `O'(1) em ambas as extremidades, mas diminui para `O'(`n') no meio. Para acesso aleatório rápido, use listas.

A partir da versão 3.5, deques oferecem suporte a @code{__add__()},`@w{`}__mul__()`@w{`} e @code{__imul__()}.

Exemplo:

@example
>>> from collections import deque
>>> d = deque('ghi')                 # torna um novo deque com três itens
>>> for elem in d:                   # itera os elementos do deque
...     print(elem.upper())
G
H
I

>>> d.append('j')                    # adiciona uma nova entrada ao lado direito
>>> d.appendleft('f')                # adiciona uma nova entrada ao lado esquerdo
>>> d                                # mostra a representação do deque
deque(['f', 'g', 'h', 'i', 'j'])

>>> d.pop()                          # retorna e remove o item mais à direita
'j'
>>> d.popleft()                      # retorna e remove o item mais à esquerda
'f'
>>> list(d)                          # lista o conteúdo do deque
['g', 'h', 'i']
>>> d[0]                             # exibe o item mais à esquerda
'g'
>>> d[-1]                            # exibe o item mais à direita
'i'

>>> list(reversed(d))                # lista o conteúdo de um deque ao inverso
['i', 'h', 'g']
>>> 'h' in d                         # pesquisa no deque
True
>>> d.extend('jkl')                  # adiciona vários elementos de uma só vez
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> d.rotate(1)                      # rotação para direita
>>> d
deque(['l', 'g', 'h', 'i', 'j', 'k'])
>>> d.rotate(-1)                     # rotação para esquerda
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])

>>> deque(reversed(d))               # cria um novo deque na ordem inversa
deque(['l', 'k', 'j', 'i', 'h', 'g'])
>>> d.clear()                        # esvazia o deque
>>> d.pop()                          # não é possível retirar um item de um deque vazio
Traceback (most recent call last):
    File "<pyshell#6>", line 1, in -toplevel-
        d.pop()
IndexError: pop from an empty deque

>>> d.extendleft('abc')              # extendleft() inverte a ordem da entrada
>>> d
deque(['c', 'b', 'a'])
@end example

@menu
* Receitas de deque:: 

@end menu

@node Receitas de deque,,,Objetos deque
@anchor{library/collections deque-recipes}@anchor{26b4}
@subsubsection Receitas de @code{deque}


Esta seção mostra várias abordagens para trabalhar com deques.

Deques de comprimento limitado fornecem funcionalidade semelhante ao filtro @code{tail} em 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

Outra abordagem para usar deques é manter uma sequência de elementos adicionados recentemente, acrescentando à direita e clicando à esquerda:

@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

Um escalonador round robin@footnote{https://en.wikipedia.org/wiki/Round-robin_scheduling} pode ser implementado com iteradores de entrada armazenados em um @ref{5dc,,deque}. Os valores são produzidos a partir do iterador ativo na posição zero. Se esse iterador estiver esgotado, ele pode ser removido com @ref{26b3,,popleft()}; caso contrário, ele pode voltar ao fim com o método @ref{1a1c,,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 um iterador esgotado.
            iterators.popleft()
@end example

O método @ref{1a1c,,rotate()} fornece uma maneira de implementar o fatiamento e exclusão @ref{5dc,,deque}. Por exemplo, uma implementação Python pura de @code{del d[n]} depende do método @code{rotate()} para posicionar os elementos a serem retirados:

@example
def delete_nth(d, n):
    d.rotate(-n)
    d.popleft()
    d.rotate(n)
@end example

Para implementar o fatiamento de @ref{5dc,,deque}, use uma abordagem semelhante aplicando @ref{1a1c,,rotate()} para trazer um elemento alvo para o lado esquerdo do deque. Remova as entradas antigas com @ref{26b3,,popleft()}, adicione novas entradas com @ref{26b0,,extend()}, e, então, inverta a rotação. Com pequenas variações dessa abordagem, é fácil implementar manipulações de pilha de estilo Forth, como @code{dup}, @code{drop}, @code{swap}, @code{over}, @code{pick}, @code{rot} e @code{roll}.

@node Objetos defaultdict,Função de fábrica para tuplas com campos nomeados namedtuple,Objetos deque,collections — Tipos de dados de contêineres
@anchor{library/collections defaultdict-objects}@anchor{26b5}
@subsubsection Objetos @code{defaultdict}


@geindex defaultdict (classe em collections)
@anchor{library/collections collections defaultdict}@anchor{11fc}
@deffn {Classe} collections.defaultdict (default_factory=None, /[, ...])

Retorna um novo objeto dicionário ou similar. @ref{11fc,,defaultdict} é uma subclasse da classe embutida @ref{256,,dict}. Ele substitui um método e adiciona uma variável de instância gravável. A funcionalidade restante é a mesma da classe @ref{256,,dict} e não está documentada aqui.

O primeiro argumento fornece o valor inicial para o atributo @ref{26b6,,default_factory}; o padrão é @code{None}. Todos os argumentos restantes são tratados da mesma forma como se fossem passados para o construtor @ref{256,,dict}, incluindo argumentos nomeados.

Os objetos @ref{11fc,,defaultdict} oferecem suporta ao seguinte método além das operações padrão @ref{256,,dict}:

@geindex __missing__() (método collections.defaultdict)
@anchor{library/collections collections defaultdict __missing__}@anchor{26b7}
@deffn {Método} __missing__ (key)

Se o atributo @ref{26b6,,default_factory} for @code{None}, isso levanta uma exceção @ref{344,,KeyError} com `key' como argumento.

Se @ref{26b6,,default_factory} não for @code{None}, ele é chamado sem argumentos para fornecer um valor padrão para a chave `key' fornecida, este valor é inserido no dicionário para `key' e retornado.

Se chamar @ref{26b6,,default_factory} levanta uma exceção, esta exceção é propagada inalterada.

Este método é chamado pelo método @ref{283,,__getitem__()} da classe @ref{256,,dict} quando a chave solicitada não é encontrada; tudo o que ele retorna ou levanta é então retornado ou levantado por @ref{283,,__getitem__()}.

Observe que @ref{26b7,,__missing__()} `não' é chamado para nenhuma operação além de @ref{283,,__getitem__()}. Isso significa que @ref{1dd2,,get()} irá, como dicionários normais, retornar @code{None} como padrão ao invés de usar @ref{26b6,,default_factory}.
@end deffn

Objetos @ref{11fc,,defaultdict} permitem a seguinte variável de instância:

@geindex default_factory (atributo collections.defaultdict)
@anchor{library/collections collections defaultdict default_factory}@anchor{26b6}
@deffn {Atributo} default_factory

Este atributo é usado pelo método @ref{26b7,,__missing__()}; ele é inicializado a partir do primeiro argumento para o construtor, se presente, ou para @code{None}, se ausente.
@end deffn


Alterado na versão 3.9: Adicionado operadores de mesclagem (@code{|}) e de atualização (@code{|=}), especificados na 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

@menu
* Exemplos de defaultdict:: 

@end menu

@node Exemplos de defaultdict,,,Objetos defaultdict
@anchor{library/collections defaultdict-examples}@anchor{26b8}
@subsubsection Exemplos de @code{defaultdict}


Usando @ref{611,,list} como @ref{26b6,,default_factory}, se for fácil agrupar a sequencia dos pares chave-valores num dicionário 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

Quando cada chave é encontrada pela primeira vez, ela ainda não está no mapeamento; então uma entrada é criada automaticamente usando a função @ref{26b6,,default_factory} que retorna uma @ref{611,,list} vazia. A operação @ref{6cd,,list.append()} então anexa o valor à nova lista. Quando as chaves são encontradas novamente, a pesquisa prossegue normalmente (retornando a lista daquela chave) e a operação @ref{6cd,,list.append()} adiciona outro valor à lista. Esta técnica é mais simples e rápida que uma técnica equivalente usando @ref{10b2,,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

Definir @ref{26b6,,default_factory} como @ref{257,,int} torna @ref{11fc,,defaultdict} útil para contagem (como um multiconjunto em outras linguagens):

@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

Quando uma letra é encontrada pela primeira vez, ela está ausente no mapeamento, então a função @ref{26b6,,default_factory} chama @ref{257,,int()} para fornecer uma contagem padrão de zero. A operação de incremento então cria a contagem para cada letra.

A função @ref{257,,int()} que sempre retorna zero é apenas um caso especial de funções constantes. Uma maneira mais rápida e flexível de criar funções constantes é usar uma função lambda que pode fornecer qualquer valor constante (não apenas zero):

@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

Definir @ref{26b6,,default_factory} como @ref{5d9,,set} torna @ref{11fc,,defaultdict} útil para construir um dicionário 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 Função de fábrica para tuplas com campos nomeados namedtuple,Objetos OrderedDict,Objetos defaultdict,collections — Tipos de dados de contêineres
@anchor{library/collections namedtuple-factory-function-for-tuples-with-named-fields}@anchor{26b9}
@subsubsection Função de fábrica para tuplas com campos nomeados @code{namedtuple()}


Tuplas nomeadas determinam o significado de cada posição numa tupla e permitem um código mais legível e autodocumentado. Podem ser usadas sempre que tuplas regulares forem utilizadas, e adicionam a possibilidade de acessar campos pelo nome ao invés da posição do índice.

@geindex namedtuple() (no módulo collections)
@anchor{library/collections collections namedtuple}@anchor{1ca}
@deffn {Função} collections.namedtuple (typename, field_names, *, rename=False, defaults=None, module=None)

Retorna uma nova subclasse de tupla chamada `typename'. A nova subclasse é usada para criar objetos tupla ou similares que possuem campos acessíveis por pesquisa de atributos, além de serem indexáveis e iteráveis. As instâncias da subclasse também possuem uma docstring útil (com `typename' e `field_names') e um método útil @ref{61c,,__repr__()} que lista o conteúdo da tupla em um formato @code{nome=valor}.

`field_names' são uma sequência de strings como @code{['x', 'y']}. Alternativamente, `field_names' pode ser uma única string com cada nome de campo separado por espaços em branco e/ou vírgulas como, por exemplo, @code{'x y'} ou @code{'x, y'}.

Qualquer identificador Python válido pode ser usado para um nome de campo, exceto para nomes que começam com um sublinhado. Identificadores válidos consistem em letras, dígitos e sublinhados, mas não começam com um dígito ou sublinhado e não podem ser uma @ref{84,,keyword} como `class', `for', `return', `global', `pass' ou `raise'.

Se `rename' for verdadeiro, nomes de campos inválidos serão automaticamente substituídos por nomes posicionais. Por exemplo, @code{['abc', 'def', 'ghi', 'abc']} é convertido para @code{['abc', '_1', 'ghi', '_3']}, eliminando a palavra reservada @code{def} e o nome de campo duplicado @code{abc}.

`defaults' pode ser @code{None} ou um @ref{1268,,iterável} de valores padrão. Como os campos com valor padrão devem vir depois de qualquer campo sem padrão, os `padrões' são aplicados aos parâmetros mais à direita. Por exemplo, se os nomes dos campos forem @code{['x', 'y', 'z']} e os padrões forem @code{(1, 2)}, então @code{x} será um argumento obrigatório, @code{y} será o padrão @code{1}, e @code{z} será o padrão @code{2}.

Se `module' for definido, o atributo @ref{374,,__module__} da tupla nomeada será definido com esse valor.

As instâncias de tuplas nomeadas não possuem dicionários por instância, portanto são leves e não requerem mais memória do que as tuplas normais.

Para prover suporte para a serialização com pickle, a classe de tupla nomeada deve ser atribuída a uma variável que corresponda a `typename'.


Alterado na versão 3.1: Adicionado suporte a `rename'.



Alterado na versão 3.6: Os parâmetros `verbose' e `rename' tornaram-se @ref{2a5,,argumentos somente-nomeados}.



Alterado na versão 3.6: Adicionado o parâmetro `module'.



Alterado na versão 3.7: Removido o parâmetro `verbose' e o atributo @code{_source}.



Alterado na versão 3.7: Adicionado o parâmetro `defaults' e o atributo @ref{26ba,,_field_defaults}.

@end deffn

@example
>>> # Exemplo básico
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(11, y=22)     # instancia com argumentos nomeados ou posicionais
>>> p[0] + p[1]             # indexável como a tupla plana (11, 22)
33
>>> x, y = p                # desempacota como uma tupla normal
>>> x, y
(11, 22)
>>> p.x + p.y               # campos também acessíveis pelo nome
33
>>> p                       # __repr__ legível com o estilo nome=valor
Point(x=11, y=22)
@end example

Tuplas nomeadas são especialmente úteis para atribuir nomes de campos a tuplas de resultados retornadas pelos módulos @ref{29,,csv} ou @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

Além dos métodos herdados das tuplas, as tuplas nomeadas oferecem suporte a três métodos adicionais e dois atributos. Para evitar conflitos com nomes de campos, os nomes de métodos e atributos começam com um sublinhado.

@geindex _make() (método de classe collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _make}@anchor{26bb}
@deffn {Método} classmethod somenamedtuple._make (iterable)

Método de classe que cria uma nova instância a partir de uma sequência existente ou iterável.

@example
>>> t = [11, 22]
>>> Point._make(t)
Point(x=11, y=22)
@end example
@end deffn

@geindex _asdict() (método collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _asdict}@anchor{9e9}
@deffn {Método} somenamedtuple._asdict ()

Retorna um novo @ref{256,,dict} que mapeia nomes de campo para seus respectivos valores:

@example
>>> p = Point(x=11, y=22)
>>> p._asdict()
@{'x': 11, 'y': 22@}
@end example


Alterado na versão 3.1: Retorna um @ref{5db,,OrderedDict} em vez de um @ref{256,,dict} normal.



Alterado na versão 3.8: Retorna um @ref{256,,dict} regular em vez de um @ref{5db,,OrderedDict}. A partir do Python 3.7, é garantido que os dicionários regulares sejam ordenados. Se os recursos extras de @ref{5db,,OrderedDict} forem necessários, a correção sugerida é converter o resultado para o tipo desejado: @code{OrderedDict(nt._asdict())}.

@end deffn

@geindex _replace() (método collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _replace}@anchor{26bc}
@deffn {Método} somenamedtuple._replace (**kwargs)

Retorna uma nova instância da tupla nomeada substituindo os campos especificados por novos 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

Tuplas nomeadas também são suportados pela função genérica @ref{151,,copy.replace()}.


Alterado na versão 3.13: Levanta @ref{2c3,,TypeError} em vez de @ref{202,,ValueError} para argumentos nomeados inválidos.

@end deffn

@geindex _fields (atributo collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _fields}@anchor{26bd}
@deffn {Atributo} somenamedtuple._fields

Tupla de strings listando os nomes dos campos. Útil para introspecção e para criar novos tipos de tuplas nomeadas a partir de tuplas nomeadas existentes.

@example
>>> p._fields            # exibe os nomes de campos
('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 collections.somenamedtuple)
@anchor{library/collections collections somenamedtuple _field_defaults}@anchor{26ba}
@deffn {Atributo} somenamedtuple._field_defaults

Dicionário mapeando nomes de campos para valores padrão.

@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 um campo cujo nome está armazenado em uma string, use a função @ref{bea,,getattr()}:

@example
>>> getattr(p, 'x')
11
@end example

Para converter um dicionário em uma tupla nomeada, use o operador estrela dupla (conforme descrito em @ref{1daf,,Desempacotando listas de argumentos}):

@example
>>> d = @{'x': 11, 'y': 22@}
>>> Point(**d)
Point(x=11, y=22)
@end example

Como uma tupla nomeada é uma classe regular do Python, é fácil adicionar ou alterar funcionalidades com uma subclasse. Veja como adicionar um campo calculado e um formato de impressão de largura fixa:

@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

A subclasse mostrada acima define @code{__slots__} como uma tupla vazia. Isso ajuda a manter baixos os requisitos de memória, evitando a criação de dicionários de instância.

A criação de subclasse não é útil para adicionar novos campos armazenados. Em vez disso, simplesmente crie um novo tipo de tupla nomeado a partir do atributo @ref{26bd,,_fields}:

@example
>>> Point3D = namedtuple('Point3D', Point._fields + ('z',))
@end example

Docstrings podem ser personalizados fazendo atribuições diretas aos 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


Alterado na versão 3.5: Os docstrings de propriedade tornaram-se graváveis.



@subsubheading Ver também



@itemize *

@item 
Veja @ref{2b0,,typing.NamedTuple} para uma maneira de adicionar dicas de tipo para tuplas nomeadas. Ele também fornece uma notação elegante usando a palavra reservada @ref{131a,,class}:

@example
class Component(NamedTuple):
    part_number: int
    weight: float
    description: Optional[str] = None
@end example

@item 
Veja @ref{1d1,,types.SimpleNamespace()} para um espaço de nomes mutável baseado em um dicionário subjacente em vez de uma tupla.

@item 
O módulo @ref{2f,,dataclasses} fornece um decorador e funções para adicionar automaticamente métodos especiais gerados a classes definidas pelo usuário.
@end itemize


@node Objetos OrderedDict,Objetos UserDict,Função de fábrica para tuplas com campos nomeados namedtuple,collections — Tipos de dados de contêineres
@anchor{library/collections ordereddict-objects}@anchor{26be}
@subsubsection Objetos @code{OrderedDict}


Os dicionários ordenados são como os dicionários normais, mas possuem alguns recursos extras relacionados às operações de pedido. Eles se tornaram menos importantes agora que a classe embutida @ref{256,,dict} ganhou a capacidade de lembrar a ordem de inserção (esse novo comportamento foi garantido no Python 3.7).

Algumas diferenças de @ref{256,,dict} ainda permanecem:


@itemize *

@item 
O @ref{256,,dict} regular foi projetado para ser muito bom em operações de mapeamento. O rastreamento do pedido de inserção era secundário.

@item 
O @ref{5db,,OrderedDict} foi projetado para ser bom em operações de reordenação. A eficiência de espaço, a velocidade de iteração e o desempenho das operações de atualização eram secundários.

@item 
O algoritmo @ref{5db,,OrderedDict} pode lidar com operações de reordenação frequentes melhor do que @ref{256,,dict}. Conforme mostrado nas receitas abaixo, isso o torna adequado para implementar vários tipos de caches LRU.

@item 
A operação de igualdade para @ref{5db,,OrderedDict} verifica a ordem correspondente.

Um @ref{256,,dict} regular pode emular o teste de igualdade sensível à ordem com @code{p == q and all(k1 == k2 for k1, k2 in zip(p, q))}.

@item 
O método @ref{1331,,popitem()} de @ref{5db,,OrderedDict} tem uma assinatura diferente. Ele aceita um argumento opcional para especificar qual item será exibido.

Um @ref{256,,dict} normal pode emular o @code{od.popitem(last=True)} do OrderedDict com @code{d.popitem()} que é garantido para exibir o (último) item mais à direita.

Um @ref{256,,dict} normal pode emular o @code{od.popitem(last=False)} do OrderedDict com @code{(k := next(iter(d)), d.pop(k))} que retornará e remova o item mais à esquerda (primeiro), se existir.

@item 
@ref{5db,,OrderedDict} possui um método @ref{121f,,move_to_end()} para reposicionar eficientemente um elemento em um endpoint.

Um @ref{256,,dict} normal pode emular o @code{od.move_to_end(k, last=True)} do OrderedDict com @code{d[k] = d.pop(k)} que moverá a chave e seu valor associado para a posição mais à direita (última).

Um @ref{256,,dict} regular não tem um equivalente eficiente para o @code{od.move_to_end(k, last=False)} do OrderedDict, que move a chave e seu valor associado para a posição mais à esquerda (primeira).

@item 
Até o Python 3.8, @ref{256,,dict} não tinha um método @ref{ca7,,__reversed__()}.
@end itemize

@geindex OrderedDict (classe em collections)
@anchor{library/collections collections OrderedDict}@anchor{5db}
@deffn {Classe} collections.OrderedDict ([items])

Retorna uma instância de uma subclasse @ref{256,,dict} que possui métodos especializados para reorganizar a ordem do dicionário.


Adicionado na versão 3.1.


@geindex popitem() (método collections.OrderedDict)
@anchor{library/collections collections OrderedDict popitem}@anchor{1331}
@deffn {Método} popitem (last=True)

O método @ref{1331,,popitem()} para dicionários ordenados retorna e remove um par (chave, valor). Os pares são retornados na ordem @abbr{LIFO} se `last' for verdadeiro ou na ordem @abbr{FIFO,primeiro a entrar@comma{} primeiro a sair} se for falso.
@end deffn

@geindex move_to_end() (método collections.OrderedDict)
@anchor{library/collections collections OrderedDict move_to_end}@anchor{121f}
@deffn {Método} move_to_end (key, last=True)

Move uma chave `key' existente para qualquer extremidade de um dicionário ordenado. O item é movido para a extremidade direita se `last' for verdadeiro (o padrão) ou para o início se `último' for falso. Levanta @ref{344,,KeyError} se a `key' não existir:

@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


Adicionado na versão 3.2.

@end deffn
@end deffn

Além dos métodos usuais de mapeamento, dicionários ordenados também oferecem suporte a iteração reversa usando a função @ref{869,,reversed()}.
@anchor{library/collections collections-ordereddict-eq}@anchor{16b1}
Testes de igualdade entre objetos @ref{5db,,OrderedDict} são sensíveis à ordem e são aproximadamente equivalentes a @code{list(od1.items())==list(od2.items())}.

Testes de igualdade entre objetos @ref{5db,,OrderedDict} e outros objetos @ref{8d0,,Mapping} não diferenciam a ordem como dicionários regulares. Isso permite que objetos @ref{5db,,OrderedDict} sejam substituídos em qualquer lugar que um dicionário regular seja usado.


Alterado na versão 3.5: Os itens, chaves e valores de @ref{26bf,,visões} de @ref{5db,,OrderedDict} agora oferecem suporte a iteração reversa usando @ref{869,,reversed()}.



Alterado na versão 3.6: Com a aceitação da 
@geindex Propostas de Melhorias do Python; PEP 468
PEP 468@footnote{https://peps.python.org/pep-0468/}, a ordem é mantida para argumentos nomeados passados para o construtor @ref{5db,,OrderedDict} e seu método @ref{14ad,,update()}.



Alterado na versão 3.9: Adicionado operadores de mesclagem (@code{|}) e de atualização (@code{|=}), especificados na 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.


@menu
* Exemplos e receitas de OrderedDict:: 

@end menu

@node Exemplos e receitas de OrderedDict,,,Objetos OrderedDict
@anchor{library/collections ordereddict-examples-and-recipes}@anchor{26c0}
@subsubsection Exemplos e receitas de @code{OrderedDict}


É simples criar uma variante de dicionário ordenado que lembre a ordem em que as chaves foram inseridas pela `última' vez. Se uma nova entrada substituir uma entrada existente, a posição de inserção original será alterada e movida para o 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

Um @ref{5db,,OrderedDict} também seria útil para implementar variantes de @ref{9f7,,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 — Tipos de dados de contêineres
@anchor{library/collections userdict-objects}@anchor{26c1}
@subsubsection Objetos @code{UserDict}


A classe @ref{1b0c,,UserDict} atua como um invólucro em torno de objetos dicionário. A necessidade desta classe foi parcialmente suplantada pela capacidade de criar subclasses diretamente de @ref{256,,dict}; entretanto, essa classe pode ser mais fácil de trabalhar porque o dicionário subjacente é acessível como um atributo.

@geindex UserDict (classe em collections)
@anchor{library/collections collections UserDict}@anchor{1b0c}
@deffn {Classe} collections.UserDict ([initialdata])

Classe que simula um dicionário. O conteúdo da instância é mantido em um dicionário regular, que é acessível através do atributo @ref{26c2,,data} das instâncias @ref{1b0c,,UserDict}. Se `initialdata' for fornecido, @ref{26c2,,data} é inicializado com seu conteúdo; observe que a referência a `initialdata' não será mantida, permitindo sua utilização para outros fins.

Além de prover suporte aos métodos e operações de mapeamentos, as instâncias @ref{1b0c,,UserDict} fornecem o seguinte atributo:

@geindex data (atributo collections.UserDict)
@anchor{library/collections collections UserDict data}@anchor{26c2}
@deffn {Atributo} data

Um dicionário real usado para armazenar o conteúdo da classe @ref{1b0c,,UserDict}.
@end deffn
@end deffn

@node Objetos UserList,Objetos UserString,Objetos UserDict,collections — Tipos de dados de contêineres
@anchor{library/collections userlist-objects}@anchor{26c3}
@subsubsection Objetos @code{UserList}


Esta classe atua como um invólucro em torno de objetos de lista. É uma classe base útil para suas próprias classes semelhantes a listas, que podem herdar delas e substituir métodos existentes ou adicionar novos. Desta forma, é possível adicionar novos comportamentos às listas.

A necessidade desta classe foi parcialmente suplantada pela capacidade de criar subclasses diretamente de @ref{611,,list}; no entanto, pode ser mais fácil trabalhar com essa classe porque a lista subjacente pode ser acessada como um atributo.

@geindex UserList (classe em collections)
@anchor{library/collections collections UserList}@anchor{152c}
@deffn {Classe} collections.UserList ([list])

Classe que simula uma lista. O conteúdo da instância é mantido em uma lista regular, que é acessível através do atributo @ref{26c4,,data} das instâncias @ref{152c,,UserList}. O conteúdo da instância é inicialmente definido como uma cópia de `list', padronizando a lista vazia @code{[]}. `list' pode ser qualquer iterável, por exemplo, uma lista Python real ou um objeto @ref{152c,,UserList}.

Além de prover suporte aos métodos e operações de sequências mutáveis, as instâncias @ref{152c,,UserList} fornecem o seguinte atributo:

@geindex data (atributo collections.UserList)
@anchor{library/collections collections UserList data}@anchor{26c4}
@deffn {Atributo} data

Um objeto @ref{611,,list} real usado para armazenar o conteúdo da classe @ref{152c,,UserList}.
@end deffn
@end deffn

`Requisitos para criar subclasse:' Espera-se que as subclasses de @ref{152c,,UserList} ofereçam um construtor que pode ser chamado sem argumentos ou com um argumento. Listar operações que retornam uma nova sequência tenta criar uma instância da classe de implementação real. Para isso, presume que o construtor pode ser chamado com um único parâmetro, que é um objeto de sequência usado como fonte de dados.

Se uma classe derivada não desejar atender a este requisito, todos os métodos especiais suportados por esta classe precisarão ser substituídos; consulte as fontes para obter informações sobre os métodos que precisam ser fornecidos nesse caso.

@node Objetos UserString,,Objetos UserList,collections — Tipos de dados de contêineres
@anchor{library/collections userstring-objects}@anchor{26c5}
@subsubsection Objetos @code{UserString}


A classe @ref{dfd,,UserString} atua como um invólucro em torno de objetos string. A necessidade desta classe foi parcialmente suplantada pela capacidade de criar subclasses diretamente de @ref{44c,,str}; entretanto, essa classe pode ser mais fácil de trabalhar porque a string subjacente é acessível como um atributo.

@geindex UserString (classe em collections)
@anchor{library/collections collections UserString}@anchor{dfd}
@deffn {Classe} collections.UserString (seq)

Classe que simula um objeto string. O conteúdo da instância é mantido em um objeto string regular, que é acessível através do atributo @ref{26c6,,data} das instâncias @ref{dfd,,UserString}. O conteúdo da instância é inicialmente definido como uma cópia de `seq'. O argumento `seq' pode ser qualquer objeto que possa ser convertido em uma string usando a função embutida @ref{44c,,str()}.

Além de prover suporte aos métodos e operações de strings, as instâncias @ref{dfd,,UserString} fornecem o seguinte atributo:

@geindex data (atributo collections.UserString)
@anchor{library/collections collections UserString data}@anchor{26c6}
@deffn {Atributo} data

Um objeto @ref{44c,,str} real usado para armazenar o conteúdo da classe @ref{dfd,,UserString}.
@end deffn


Alterado na versão 3.5: Novos métodos @code{__getnewargs__}, @code{__rmod__}, @code{casefold}, @code{format_map}, @code{isprintable} e @code{maketrans}.

@end deffn

@node collections abc — Classes Base Abstratas para Contêineres,heapq — Algoritmo de fila heap,collections — Tipos de dados de contêineres,Tipos de Dados
@anchor{library/collections abc doc}@anchor{26c7}@anchor{library/collections abc collections-abc-abstract-base-classes-for-containers}@anchor{26c8}@anchor{library/collections abc module-collections abc}@anchor{1e}@anchor{library/collections abc translation-repo}@anchor{26c9}
@subsection @code{collections.abc} — Classes Base Abstratas para Contêineres


@geindex module; collections.abc


Adicionado na versão 3.3: Anteriormente, esse módulo fazia parte do módulo @ref{1d,,collections}.


`Código-fonte:' Lib/_collections_abc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/_collections_abc.py}

@c from collections.abc import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


Esse módulo fornece @ref{11f5,,classes base abstratas} que podem ser usadas para testar se uma classe fornece uma interface específica; por exemplo, se é @ref{610,,hasheável} ou se é um @ref{11fb,,mapeamento}.

Um teste @ref{7c2,,issubclass()} ou @ref{442,,isinstance()} para uma interface funciona em uma das três formas.


@enumerate 

@item 
Uma classe recém-escrita pode herdar diretamente de uma das classes base abstratas. A classe deve fornecer os métodos abstratos necessários. Os métodos mixin restantes vêm da herança e podem ser substituídos se desejado. Outros métodos podem ser adicionados conforme necessário:

@example
class C(Sequence):                      # Herança direta
    def __init__(self): ...             # Método extra não exigido pela ABC
    def __getitem__(self, index):  ...  # Método abstrato exigido
    def __len__(self):  ...             # Método abstrato exigido
    def count(self, value): ...         # Opcionalmente substitui um método mixin
@end example

@example
>>> issubclass(C, Sequence)
True
>>> isinstance(C(), Sequence)
True
@end example

@item 
Classes existentes e classes embutidas podem ser registradas como “subclasses virtuais” dos ABCs. Essas classes devem definir a API completa, incluindo todos os métodos abstratos e todos os métodos mixin. Isso permite que os usuários confiem nos testes @ref{7c2,,issubclass()} ou @ref{442,,isinstance()} para determinar se a interface completa é suportada. A exceção a essa regra é para métodos que são automaticamente inferidos do restante da API:

@example
class D:                                 # Sem herança
    def __init__(self): ...              # Método extra exigido pela ABC
    def __getitem__(self, index):  ...   # Método abstrato
    def __len__(self):  ...              # Método abstrato
    def count(self, value): ...          # Método mixin
    def index(self, value): ...          # Método mixin

Sequence.register(D)                     # Registra ao invés de herdar
@end example

@example
>>> issubclass(D, Sequence)
True
>>> isinstance(D(), Sequence)
True
@end example

Neste exemplo, a classe @code{D} não precisa definir @code{__contains__}, @code{__iter__} e @code{__reversed__} porque o @ref{2205,,operador in}, a lógica @ref{1268,,iteration} e a função @ref{869,,reversed()} retornam automaticamente para o uso de @code{__getitem__} e @code{__len__}.

@item 
Algumas interfaces simples são diretamente reconhecíveis pela presença dos métodos necessários (a menos que esses métodos tenham sido definidos como @ref{675,,None}):

@example
class E:
    def __iter__(self): ...
    def __next__(self): ...
@end example

@example
>>> issubclass(E, Iterable)
True
>>> isinstance(E(), Iterable)
True
@end example

Interfaces complexas não oferecem suporte a esta última técnica porque uma interface é mais do que apenas a presença de nomes de métodos. Interfaces especificam semântica e relacionamentos entre métodos que não podem ser inferidos somente da presença de nomes de métodos específicos. Por exemplo, saber que uma classe fornece @code{__getitem__}, @code{__len__} e @code{__iter__} é insuficiente para distinguir uma @ref{1204,,Sequence} de uma @ref{8d0,,Mapping}.
@end enumerate


Adicionado na versão 3.9: Essas classes abstratas agora oferecem suporte a @code{[]}. Veja @ref{6b2,,Tipo Generic Alias} e 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}.


@menu
* Classes Base Abstratas de Coleções:: 
* Classes Base Abstrata de Coleções – Descrições Detalhadas:: 
* Exemplos e receitas:: 

@end menu

@node Classes Base Abstratas de Coleções,Classes Base Abstrata de Coleções – Descrições Detalhadas,,collections abc — Classes Base Abstratas para Contêineres
@anchor{library/collections abc collections-abstract-base-classes}@anchor{87c}@anchor{library/collections abc id1}@anchor{26ca}
@subsubsection Classes Base Abstratas de Coleções


O módulo de coleções oferece o seguinte @ref{11f5,,ABCs}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ABC

@tab

Herda de

@tab

Métodos abstratos

@tab

Métodos mixin

@item

@ref{23e4,,Container} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__contains__}

@tab

@item

@ref{4f5,,Hashable} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__hash__}

@tab

@item

@ref{23e2,,Iterable} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
} @footnote{
A verificação @code{isinstance(obj, Iterable)} detecta classes que são registradas como @ref{23e2,,Iterable} ou que possuem um método @ref{1e4a,,__iter__()}, mas que não detecta classes que iteram com o método @ref{283,,__getitem__()}. A única maneira confiável de determinar se um objeto é @ref{1268,,iterável} é chamar @code{iter(obj)}.
}

@tab

@tab

@code{__iter__}

@tab

@item

@ref{23e3,,Iterator} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{23e2,,Iterable}

@tab

@code{__next__}

@tab

@code{__iter__}

@item

@ref{ca6,,Reversible} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{23e2,,Iterable}

@tab

@code{__reversed__}

@tab

@item

@ref{e05,,Generator}  @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{23e3,,Iterator}

@tab

@code{send}, @code{throw}

@tab

@code{close}, @code{__iter__}, @code{__next__}

@item

@ref{4f6,,Sized}  @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__len__}

@tab

@item

@ref{7ec,,Callable}  @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__call__}

@tab

@item

@ref{ca5,,Collection}  @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{4f6,,Sized},
@ref{23e2,,Iterable},
@ref{23e4,,Container}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__}

@tab

@item

@ref{1204,,Sequence}

@tab

@ref{ca6,,Reversible},
@ref{ca5,,Collection}

@tab

@code{__getitem__},
@code{__len__}

@tab

@code{__contains__}, @code{__iter__}, @code{__reversed__},
@code{index}, and @code{count}

@item

@ref{1a1,,MutableSequence}

@tab

@ref{1204,,Sequence}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__len__},
@code{insert}

@tab

Herdados métodos de @ref{1204,,Sequence} e @code{append}, @code{clear}, @code{reverse}, @code{extend}, @code{pop}, @code{remove} e @code{__iadd__}

@item

@ref{2e7,,ByteString}

@tab

@ref{1204,,Sequence}

@tab

@code{__getitem__},
@code{__len__}

@tab

Métodos herdados de @ref{1204,,Sequence}

@item

@ref{23da,,Set}

@tab

@ref{ca5,,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__} e @code{isdisjoint}

@item

@ref{23e5,,MutableSet}

@tab

@ref{23da,,Set}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__},
@code{add},
@code{discard}

@tab

Herdado @ref{23da,,Set} métodos e @code{clear}, @code{pop}, @code{remove}, @code{__ior__}, @code{__iand__}, @code{__ixor__}, e @code{__isub__}

@item

@ref{8d0,,Mapping}

@tab

@ref{ca5,,Collection}

@tab

@code{__getitem__},
@code{__iter__},
@code{__len__}

@tab

@code{__contains__}, @code{keys}, @code{items}, @code{values}, @code{get}, @code{__eq__}, e @code{__ne__}

@item

@ref{10eb,,MutableMapping}

@tab

@ref{8d0,,Mapping}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__iter__},
@code{__len__}

@tab

Herdado @ref{8d0,,Mapping} métodos e @code{pop}, @code{popitem}, @code{clear}, @code{update}, e @code{setdefault}

@item

@ref{23e6,,MappingView}

@tab

@ref{4f6,,Sized}

@tab

@tab

@code{__init__}, @code{__len__} e @code{__repr__}

@item

@ref{23e8,,ItemsView}

@tab

@ref{23e6,,MappingView},
@ref{23da,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{23e7,,KeysView}

@tab

@ref{23e6,,MappingView},
@ref{23da,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{23e9,,ValuesView}

@tab

@ref{23e6,,MappingView},
@ref{ca5,,Collection}

@tab

@tab

@code{__contains__}, @code{__iter__}

@item

@ref{e06,,Awaitable} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__await__}

@tab

@item

@ref{e07,,Coroutine} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{e06,,Awaitable}

@tab

@code{send}, @code{throw}

@tab

@code{close}

@item

@ref{e09,,AsyncIterable} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__aiter__}

@tab

@item

@ref{e08,,AsyncIterator} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{e09,,AsyncIterable}

@tab

@code{__anext__}

@tab

@code{__aiter__}

@item

@ref{ca8,,AsyncGenerator} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@ref{e08,,AsyncIterator}

@tab

@code{asend}, @code{athrow}

@tab

@code{aclose}, @code{__aiter__}, @code{__anext__}

@item

@ref{2e9,,Buffer} @footnote{
Essas ABCs substituem @ref{26cb,,__subclasshook__()} para dar suporte ao teste de uma interface verificando se os métodos necessários estão presentes e não foram definidos como @ref{675,,None}. Isso só funciona para interfaces simples. Interfaces mais complexas exigem registro ou subclassificação direta.
}

@tab

@tab

@code{__buffer__}

@tab

@end multitable


@node Classes Base Abstrata de Coleções – Descrições Detalhadas,Exemplos e receitas,Classes Base Abstratas de Coleções,collections abc — Classes Base Abstratas para Contêineres
@anchor{library/collections abc collections-abstract-base-classes-detailed-descriptions}@anchor{26cc}
@subsubsection Classes Base Abstrata de Coleções – Descrições Detalhadas


@geindex Container (classe em collections.abc)
@anchor{library/collections abc collections abc Container}@anchor{23e4}
@deffn {Classe} collections.abc.Container

ABC para classes que fornecem o método @ref{1400,,__contains__()}.
@end deffn

@geindex Hashable (classe em collections.abc)
@anchor{library/collections abc collections abc Hashable}@anchor{4f5}
@deffn {Classe} collections.abc.Hashable

ABC para classes que fornecem o método @ref{b0e,,__hash__()}.
@end deffn

@geindex Sized (classe em collections.abc)
@anchor{library/collections abc collections abc Sized}@anchor{4f6}
@deffn {Classe} collections.abc.Sized

ABC para classes que fornecem o método @ref{15b4,,__len__()}.
@end deffn

@geindex Callable (classe em collections.abc)
@anchor{library/collections abc collections abc Callable}@anchor{7ec}
@deffn {Classe} collections.abc.Callable

ABC para classes que fornecem o método @ref{558,,__call__()}.

Veja @ref{2404,,Anotações de objetos chamáveis} para detalhes sobre como usar @code{Callable} em anotações de tipos.
@end deffn

@geindex Iterable (classe em collections.abc)
@anchor{library/collections abc collections abc Iterable}@anchor{23e2}
@deffn {Classe} collections.abc.Iterable

ABC para classes que fornecem o método @ref{1e4a,,__iter__()}.

A verificação @code{isinstance(obj, Iterable)} detecta classes que são registradas como @ref{23e2,,Iterable} ou que possuem um método @ref{1e4a,,__iter__()}, mas que não detecta classes que iteram com o método @ref{283,,__getitem__()}. A única maneira confiável de determinar se um objeto é @ref{1268,,iterável} é chamar @code{iter(obj)}.
@end deffn

@geindex Collection (classe em collections.abc)
@anchor{library/collections abc collections abc Collection}@anchor{ca5}
@deffn {Classe} collections.abc.Collection

ABC para classes de contêiner iterável de tamanho.


Adicionado na versão 3.6.

@end deffn

@geindex Iterator (classe em collections.abc)
@anchor{library/collections abc collections abc Iterator}@anchor{23e3}
@deffn {Classe} collections.abc.Iterator

ABC para classes que fornecem os métodos @ref{1e4d,,__iter__()} e métodos @ref{1310,,__next__()}. Veja também a definição de @ref{1ac,,iterator}.
@end deffn

@geindex Reversible (classe em collections.abc)
@anchor{library/collections abc collections abc Reversible}@anchor{ca6}
@deffn {Classe} collections.abc.Reversible

ABC para classes iteráveis que também fornecem o método @ref{ca7,,__reversed__()}.


Adicionado na versão 3.6.

@end deffn

@geindex Generator (classe em collections.abc)
@anchor{library/collections abc collections abc Generator}@anchor{e05}
@deffn {Classe} collections.abc.Generator

ABC para classes @ref{109a,,geradores} que implementam o protocolo definido em 
@geindex Propostas de Melhorias do Python; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} que estende os @ref{1ac,,iteradores} com os métodos @ref{215a,,send()}, @ref{4f8,,throw()} e @ref{15b9,,close()}.

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @code{Generator} em anotações de tipos.


Adicionado na versão 3.5.

@end deffn

@geindex Sequence (classe em collections.abc)
@geindex MutableSequence (classe em collections.abc)
@geindex ByteString (classe em collections.abc)
@anchor{library/collections abc collections abc Sequence}@anchor{1204}
@deffn {Classe} collections.abc.Sequence
@anchor{library/collections abc collections abc MutableSequence}@anchor{1a1}
@deffnx {Classe} collections.abc.MutableSequence
@anchor{library/collections abc collections abc ByteString}@anchor{2e7}
@deffnx {Classe} collections.abc.ByteString

ABCs para @ref{4f1,,sequências} somente de leitura e mutáveis.

Nota de implementação: Alguns métodos mixin, como @ref{1e4a,,__iter__()}, @ref{ca7,,__reversed__()} e @ref{211c,,index()}, fazem chamadas repetidas ao método subjacente @ref{283,,__getitem__()}. Consequentemente, se @ref{283,,__getitem__()} for implementado com velocidade de acesso constante, os métodos mixin terão desempenho linear; no entanto, se o método subjacente for linear (como seria com uma lista encadeada), os mixins terão desempenho quadrático e provavelmente precisarão ser substituídos.

@geindex index() (método collections.abc.ByteString)
@anchor{library/collections abc collections abc ByteString index}@anchor{26ce}
@deffn {Método} index (value, start=0, stop=None)

Retorna o primeiro índice de `valor'.

Levanta @ref{202,,ValueError} se o valor não estiver presente.

Suporte aos argumentos `start' e `stop' é opcional, mas recomendado.


Alterado na versão 3.5: O método @ref{211c,,index()} ganhou suporte para os argumentos `stop' e `start'.

@end deffn


Descontinuado desde a versão 3.12, será removido na versão 3.17: A ABC @ref{2e7,,ByteString} foi descontinuada.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

See 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} for more details.

@end deffn

@geindex Set (classe em collections.abc)
@geindex MutableSet (classe em collections.abc)
@anchor{library/collections abc collections abc Set}@anchor{23da}
@deffn {Classe} collections.abc.Set
@anchor{library/collections abc collections abc MutableSet}@anchor{23e5}
@deffnx {Classe} collections.abc.MutableSet

ABCs para @ref{1dcf,,conjuntos} somente leitura e mutáveis.
@end deffn

@geindex Mapping (classe em collections.abc)
@geindex MutableMapping (classe em collections.abc)
@anchor{library/collections abc collections abc Mapping}@anchor{8d0}
@deffn {Classe} collections.abc.Mapping
@anchor{library/collections abc collections abc MutableMapping}@anchor{10eb}
@deffnx {Classe} collections.abc.MutableMapping

ABCs para somente leitura e mutável @ref{11fb,,mappings}.
@end deffn

@geindex MappingView (classe em collections.abc)
@geindex ItemsView (classe em collections.abc)
@geindex KeysView (classe em collections.abc)
@geindex ValuesView (classe em collections.abc)
@anchor{library/collections abc collections abc MappingView}@anchor{23e6}
@deffn {Classe} collections.abc.MappingView
@anchor{library/collections abc collections abc ItemsView}@anchor{23e8}
@deffnx {Classe} collections.abc.ItemsView
@anchor{library/collections abc collections abc KeysView}@anchor{23e7}
@deffnx {Classe} collections.abc.KeysView
@anchor{library/collections abc collections abc ValuesView}@anchor{23e9}
@deffnx {Classe} collections.abc.ValuesView

ABCs para mapeamento, itens, chaves e valores @ref{26bf,,views}.
@end deffn

@geindex Awaitable (classe em collections.abc)
@anchor{library/collections abc collections abc Awaitable}@anchor{e06}
@deffn {Classe} collections.abc.Awaitable

ABC para objetos @ref{1ad,,aguardáveis}, que podem ser usados em expressões de @ref{1b9,,await}. Implementações personalizadas devem fornecer o método @ref{d9d,,__await__()}.

Objetos e instâncias de @ref{491,,corrotina} da ABC @ref{e07,,Coroutine} são todas instâncias dessa ABC.

@cartouche
@quotation Nota 
No CPython, as corrotinas baseados em gerador (@ref{109a,,geradores} decorados com @ref{eb7,,@@types.coroutine}) são `aguardáveis', embora não possuam o método @ref{d9d,,__await__()}. Usar @code{isinstance(gencoro, Awaitable)} para eles retornará @code{False}. Use @ref{e43,,inspect.isawaitable()} para detectá-los.
@end quotation
@end cartouche


Adicionado na versão 3.5.

@end deffn

@geindex Coroutine (classe em collections.abc)
@anchor{library/collections abc collections abc Coroutine}@anchor{e07}
@deffn {Classe} collections.abc.Coroutine

ABC para classes compatíveis com @ref{491,,corrotina}. Eles implementam os seguintes métodos, definidos em @ref{2099,,Objetos corrotina}: @ref{2159,,send()}, @ref{4f7,,throw()}, e @ref{215b,,close()}. Implementações personalizadas também devem implementar @ref{d9d,,__await__()}. Todas as instâncias @ref{e07,,Coroutine} também são instâncias de @ref{e06,,Awaitable}.

@cartouche
@quotation Nota 
No CPython, as corrotinas baseados em gerador (@ref{109a,,geradores} decorados com @ref{eb7,,@@types.coroutine}) são `aguardáveis', embora não possuam o método @ref{d9d,,__await__()}. Usar @code{isinstance(gencoro, Coroutine)} para eles retornará @code{False}. Use @ref{e43,,inspect.isawaitable()} para detectá-los.
@end quotation
@end cartouche

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @code{Coroutine} em anotações de tipos. A variância e a ordem dos parâmetros de tipo correspondem às de @ref{e05,,Generator}.


Adicionado na versão 3.5.

@end deffn

@geindex AsyncIterable (classe em collections.abc)
@anchor{library/collections abc collections abc AsyncIterable}@anchor{e09}
@deffn {Classe} collections.abc.AsyncIterable

ABC para classes que fornecem um método @code{__aiter__}. Veja também a definição de @ref{d9c,,iterável assíncrono}.


Adicionado na versão 3.5.

@end deffn

@geindex AsyncIterator (classe em collections.abc)
@anchor{library/collections abc collections abc AsyncIterator}@anchor{e08}
@deffn {Classe} collections.abc.AsyncIterator

ABC para classes que fornecem os métodos @code{__aiter__} e @code{__anext__}. Veja também a definição de @ref{1ab,,iterador assíncrono}.


Adicionado na versão 3.5.

@end deffn

@geindex AsyncGenerator (classe em collections.abc)
@anchor{library/collections abc collections abc AsyncGenerator}@anchor{ca8}
@deffn {Classe} collections.abc.AsyncGenerator

ABC para classes de @ref{21cf,,gerador assíncrono} que implementam o protocolo definido em 
@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} e 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @code{AsyncGenerator} em anotações de tipos.


Adicionado na versão 3.6.

@end deffn

@geindex Buffer (classe em collections.abc)
@anchor{library/collections abc collections abc Buffer}@anchor{2e9}
@deffn {Classe} collections.abc.Buffer

ABC para classes que fornecem o método @ref{45f,,__buffer__()}, implementando o @ref{2e8,,protocolo buffer}. Veja 
@geindex Propostas de Melhorias do Python; PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/}.


Adicionado na versão 3.12.

@end deffn

@node Exemplos e receitas,,Classes Base Abstrata de Coleções – Descrições Detalhadas,collections abc — Classes Base Abstratas para Contêineres
@anchor{library/collections abc examples-and-recipes}@anchor{26cf}
@subsubsection Exemplos e receitas


ABCs nos permitem perguntar a classes ou instâncias se elas fornecem funcionalidades específicas, por exemplo:

@example
size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)
@end example

Vários ABCs também são também úteis como mixins que facilitam o desenvolvimento de classes que suportam APIs de contêiner. Por exemplo, para escrever uma classe que suporte toda a API @ref{23da,,Set} , é necessário fornecer apenas os três métodos abstratos subjacentes: @ref{1400,,__contains__()}, @ref{1e4a,,__iter__()}, e @ref{15b4,,__len__()}. O ABC fornece os métodos restantes, como @code{__and__()} e @ref{23c6,,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            # O método __and__() é automaticamente suportado
@end example

Notas sobre o uso de @ref{23da,,Set} e @ref{23e5,,MutableSet} como um mixin:


@enumerate 

@item 
Como algumas operações de conjunto criam novos conjuntos, os métodos de mixin padrão precisam de uma maneira de criar novas instâncias a partir de um @ref{1268,,iterável}. Supõe-se que a classe construtor tenha uma assinatura no formato @code{ClassName(iterable)}. Essa suposição é fatorada em um @ref{166,,classmethod} interno chamado @code{_from_iterable()} que chama @code{cls(iterable)} para produzir um novo conjunto. Se o mixin @ref{23da,,Set} estiver sendo usado em uma classe com uma assinatura de construtor diferente, você precisará substituir @code{_from_iterable()} por um método de classe ou um método regular que possa construir novas instâncias a partir de um argumento iterável.

@item 
Para substituir as comparações (presumivelmente para velocidade, já que a semântica é fixa), redefina @ref{134f,,__le__()} e @ref{1351,,__ge__()}, então as outras operações seguirão o exemplo automaticamente.

@item 
O mixin @ref{23da,,Set} fornece um método @code{_hash()} para calcular um valor de hash para o conjunto; no entanto, @ref{b0e,,__hash__()} não é definido porque nem todos os conjuntos são @ref{610,,hasheáveis} ou imutáveis. Para adicionar hasheabilidade em conjuntos usando mixin, herde de ambos @ref{23da,,Set()} e @ref{4f5,,Hashable()}, e então defina @code{__hash__ = Set._hash}.
@end enumerate


@subsubheading Ver também



@itemize *

@item 
OrderedSet receita@footnote{https://code.activestate.com/recipes/576694/} para um exemplo baseado em @ref{23e5,,MutableSet}.

@item 
Para mais informações sobre ABCs, consulte o módulo @ref{4,,abc} e 
@geindex Propostas de Melhorias do Python; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}.
@end itemize


@node heapq — Algoritmo de fila heap,bisect — Algoritmo de bisseção de vetor,collections abc — Classes Base Abstratas para Contêineres,Tipos de Dados
@anchor{library/heapq doc}@anchor{26d0}@anchor{library/heapq heapq-heap-queue-algorithm}@anchor{26d1}@anchor{library/heapq module-heapq}@anchor{69}@anchor{library/heapq translation-repo}@anchor{26d2}
@subsection @code{heapq} — Algoritmo de fila heap


@geindex module; heapq

`Código-fonte:' Lib/heapq.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/heapq.py}


__________________________________________________________________


Este módulo fornece uma implementação do algoritmo de fila heap, também conhecido como algoritmo de fila de prioridade.

Heaps são árvores binárias para as quais cada nó pai tem um valor menor ou igual a qualquer um de seus filhos. Chamamos essa condição de invariante de heap.

Esta implementação usa arrays para os quais @code{heap[k] <= heap[2*k+1]} e @code{heap[k] <= heap[2*k+2]} para todos `k', contando elementos de zero. Para efeito de comparação, os elementos inexistentes são considerados infinitos. A propriedade interessante de um heap é que seu menor elemento é sempre a raiz, @code{heap[0]}.

A API abaixo difere dos algoritmos de heap de livros didáticos em dois aspectos: (a) Usamos indexação baseada em zero. Isso torna o relacionamento entre o índice de um nó e os índices de seus filhos um pouco menos óbvio, mas é mais adequado, pois o Python usa indexação baseada em zero. (b) Nosso método pop retorna o menor item, não o maior (chamado de “min heap” em livros didáticos; um “max heap” é mais comum em textos devido à sua adequação para classificação no local).

Esses dois tornam possível visualizar o heap como uma lista regular do Python sem surpresas: @code{heap[0]} é o menor item, e @code{heap.sort()} mantém o invariante de heap!

Para criar um heap, use uma lista inicializada com @code{[]}, ou você pode transformar uma lista preenchida em um heap através da função @ref{26d3,,heapify()}.

As seguintes funções são fornecidas:

@geindex heapify() (no módulo heapq)
@anchor{library/heapq heapq heapify}@anchor{26d3}
@deffn {Função} heapq.heapify (x)

Transforma a lista `x' em um heap, no local, em tempo linear.
@end deffn

@geindex heappush() (no módulo heapq)
@anchor{library/heapq heapq heappush}@anchor{1504}
@deffn {Função} heapq.heappush (heap, item)

Coloca o valor `item' no `heap', mantendo o invariante de heap.
@end deffn

@geindex heappop() (no módulo heapq)
@anchor{library/heapq heapq heappop}@anchor{1505}
@deffn {Função} heapq.heappop (heap)

Retira e retorna o menor item do `heap', mantendo o invariante de heap. Se o heap estiver vazio, a exceção @ref{157e,,IndexError} será levantada. Para acessar o menor item sem retirá-lo, use @code{heap[0]}.
@end deffn

@geindex heappushpop() (no módulo heapq)
@anchor{library/heapq heapq heappushpop}@anchor{26d4}
@deffn {Função} heapq.heappushpop (heap, item)

Coloca `item' no heap, depois retira e retorna o menor item do `heap'. A ação combinada é executada com mais eficiência do que @ref{1504,,heappush()} seguida por uma chamada separada para @ref{1505,,heappop()}.
@end deffn

@geindex heapreplace() (no módulo heapq)
@anchor{library/heapq heapq heapreplace}@anchor{26d5}
@deffn {Função} heapq.heapreplace (heap, item)

Abre e retorna o menor item da `heap' e também coloca o novo `item'. O tamanho do heap não muda. Se o heap estiver vazio, a exceção @ref{157e,,IndexError} será levantada.

Esta operação de uma etapa é mais eficiente que @ref{1505,,heappop()} seguida por @ref{1504,,heappush()} e pode ser mais apropriada ao usar um heap de tamanho fixo. A combinação de retirar/colocar sempre retorna um elemento do heap e o substitui por `item'.

O valor retornado pode ser maior que o `item' adicionado. Se isso não for desejado, considere usar @ref{26d4,,heappushpop()}. Sua combinação de retirar/colocar retorna o menor dos dois valores, deixando o valor maior no heap.
@end deffn

O módulo também oferece três funções de propósito geral baseadas em heaps.

@geindex merge() (no módulo heapq)
@anchor{library/heapq heapq merge}@anchor{e30}
@deffn {Função} heapq.merge (*iterables, key=None, reverse=False)

Mescla diversas entradas classificadas em uma única saída classificada (por exemplo, mescla entradas com registro de data e hora de vários arquivos de log). Retorna um @ref{1ac,,iterador} sobre os valores classificados.

Semelhante a @code{sorted(itertools.chain(*iterables))} mas retorna um iterável, não puxa os dados para a memória todos de uma vez e presume que cada um dos fluxos de entrada já está classificado (do menor para o maior).

Possui dois argumentos opcionais que devem ser especificados como argumentos nomeados.

`key' especifica uma @ref{e31,,função chave} de um argumento que é usado para extrair uma chave de comparação de cada elemento de entrada. O valor padrão é @code{None} (compare os elementos diretamente).

`reverse' é um valor booleano. Se definido como @code{True}, então os elementos de entrada serão mesclados como se cada comparação fosse invertida. Para obter um comportamento semelhante a @code{sorted(itertools.chain(*iterables), reverse=True)}, todos os iteráveis devem ser classificados do maior para o menor.


Alterado na versão 3.5: Adicionados os parâmetros opcionais `key' e `reverse'.

@end deffn

@geindex nlargest() (no módulo heapq)
@anchor{library/heapq heapq nlargest}@anchor{26d6}
@deffn {Função} heapq.nlargest (n, iterable, key=None)

Retorna uma lista com os `n' maiores elementos do conjunto de dados definido por `iterable'. `key', se fornecido, especifica uma função de um argumento que é usado para extrair uma chave de comparação de cada elemento em `iterable' (por exemplo, @code{key=str.lower}). Equivalente a: @code{sorted(iterable, key=key, reverse=True)[:n]}.
@end deffn

@geindex nsmallest() (no módulo heapq)
@anchor{library/heapq heapq nsmallest}@anchor{26d7}
@deffn {Função} heapq.nsmallest (n, iterable, key=None)

Retorna uma lista com os `n' menores elementos do conjunto de dados definido por `iterable'. `key', se fornecido, especifica uma função de um argumento que é usado para extrair uma chave de comparação de cada elemento em `iterable' (por exemplo, @code{key=str.lower}). Equivalente a: @code{sorted(iterable, key=key)[:n]}.
@end deffn

As duas últimas funções têm melhor desempenho para valores menores de `n'. Para valores maiores, é mais eficiente usar a função @ref{be7,,sorted()}. Além disso, quando @code{n==1}, é mais eficiente usar as funções embutidas @ref{f3a,,min()} e @ref{f3b,,max()}. Se for necessário o uso repetido dessas funções, considere transformar o iterável em um heap real.

@menu
* Exemplos básicos:: 
* Notas de implementação da fila de prioridade:: 
* Teoria:: 

@end menu

@node Exemplos básicos,Notas de implementação da fila de prioridade,,heapq — Algoritmo de fila heap
@anchor{library/heapq basic-examples}@anchor{26d8}
@subsubsection Exemplos básicos


Um heapsort@footnote{https://en.wikipedia.org/wiki/Heapsort} pode ser implementado colocando todos os valores em um heap e, em seguida, retirando os menores valores, um de cada 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

Isto é semelhante a @code{sorted(iterable)}, mas diferente de @ref{be7,,sorted()}, esta implementação não é estável.

Os elementos de heap podem ser tuplas. Isto é útil para atribuir valores de comparação (como prioridades de tarefas) juntamente com o registro principal que está sendo rastreado:

@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 implementação da fila de prioridade,Teoria,Exemplos básicos,heapq — Algoritmo de fila heap
@anchor{library/heapq priority-queue-implementation-notes}@anchor{26d9}
@subsubsection Notas de implementação da fila de prioridade


Uma fila de prioridade@footnote{https://en.wikipedia.org/wiki/Priority_queue} é de uso comum para um heap e apresenta vários desafios de implementação:


@itemize *

@item 
Estabilidade de classificação: como fazer com que duas tarefas com prioridades iguais sejam retornadas na ordem em que foram adicionadas originalmente?

@item 
A comparação de tuplas quebra para pares (prioridade, tarefa) se as prioridades forem iguais e as tarefas não tiverem uma ordem de comparação padrão.

@item 
Se a prioridade de uma tarefa mudar, como movê-la para uma nova posição no heap?

@item 
Ou se uma tarefa pendente precisar ser excluída, como encontrá-la e removê-la da fila?
@end itemize

Uma solução para os dois primeiros desafios é armazenar as entradas como uma lista de 3 elementos, incluindo a prioridade, uma contagem de entradas e a tarefa. A contagem de entradas serve de desempate para que duas tarefas com a mesma prioridade sejam retornadas na ordem em que foram adicionadas. E como não há duas contagens de entradas iguais, a comparação de tuplas nunca tentará comparar diretamente duas tarefas.

Outra solução para o problema de tarefas não comparáveis é criar uma classe wrapper que ignore o item da tarefa e compare apenas o campo de prioridade:

@example
from dataclasses import dataclass, field
from typing import Any

@@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)
@end example

Os desafios restantes giram em torno de encontrar uma tarefa pendente e fazer alterações em sua prioridade ou removê-la totalmente. Encontrar uma tarefa pode ser feito com um dicionário apontando para uma entrada na fila.

Remover a entrada ou alterar sua prioridade é mais difícil porque quebraria os invariantes da estrutura de heap. Assim, uma possível solução é marcar a entrada como removida e adicionar uma nova entrada com a prioridade revisada:

@example
pq = []                         # lista de entradas organizadas em uma heap
entry_finder = @{@}               # mapeamentos de tarefas para entradas
REMOVED = '<removed-task>'      # espaço reservado para uma tarefa removida
counter = itertools.count()     # contagem de sequência única

def add_task(task, priority=0):
    'Adiciona uma nova tarefa ou atualiza a prioridade de uma tarefa existente'
    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):
    'Marca uma tarefa existente com REMOVED (removida). Levanta KeyError se não encontrada.'
    entry = entry_finder.pop(task)
    entry[-1] = REMOVED

def pop_task():
    'Remove e retorna a tarefa de mais baixa prioridade. Levanta KeyError se vazio.'
    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 Teoria,,Notas de implementação da fila de prioridade,heapq — Algoritmo de fila heap
@anchor{library/heapq theory}@anchor{26da}
@subsubsection Teoria


Heaps são arrays para os quais @code{a[k] <= a[2*k+1]} e @code{a[k] <= a[2*k+2]} para todos `k', contando elementos de 0. Para fins de comparação, os elementos inexistentes são considerados infinitos. A propriedade interessante de um heap é que @code{a[0]} é sempre seu menor elemento.

O estranho invariante acima pretende ser uma representação de memória eficiente para um torneio. Os números abaixo são `k', não @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

Na árvore acima, cada célula `k' está no topo de @code{2*k+1} e @code{2*k+2}. Num torneio binário normal que vemos nos desportos, cada célula é a vencedora das duas células que está no topo, e podemos rastrear o vencedor na árvore para ver todos os adversários que teve. Contudo, em muitas aplicações informáticas de tais torneios, não precisamos de traçar a história de um vencedor. Para sermos mais eficientes em termos de memória, quando um vencedor é promovido, tentamos substituí-lo por algo de nível inferior, e a regra passa a ser que uma célula e as duas células que ela cobre contêm três itens diferentes, mas a célula de cima “ganha” sobre as duas células superiores.

Se esse invariante de heap estiver protegido o tempo todo, o índice 0 é claramente o vencedor geral. A maneira algorítmica mais simples de removê-lo e encontrar o “próximo” vencedor é mover algum perdedor (digamos a célula 30 no diagrama acima) para a posição 0 e, em seguida, filtrar esse novo 0 pela árvore, trocando valores, até que o invariante é restabelecido. Isto é claramente logarítmico do número total de itens na árvore. Ao iterar todos os itens, você obtém uma classificação `O'(`n' log `n').

Um recurso interessante desse tipo é que você pode inserir novos itens com eficiência enquanto a classificação está em andamento, desde que os itens inseridos não sejam “melhores” que o último 0º elemento extraído. Isto é especialmente útil em contextos de simulação, onde a árvore contém todos os eventos recebidos e a condição “vitória” significa o menor tempo programado. Quando um evento agenda outros eventos para execução, eles são agendados para o futuro, para que possam entrar facilmente no heap. Portanto, um heap é uma boa estrutura para implementar escalonadores (foi isso que usei no meu sequenciador MIDI :-).

Várias estruturas para implementação de escalonadores foram extensivamente estudadas, e os heaps são bons para isso, pois são razoavelmente rápidos, a velocidade é quase constante e o pior caso não é muito diferente do caso médio. No entanto, existem outras representações que são globalmente mais eficientes, embora os piores casos possam ser terríveis.

Heaps também são muito úteis em classificações de discos grandes. Provavelmente todos vocês sabem que uma classificação grande implica a produção de “execuções” (que são sequências pré-classificadas, cujo tamanho geralmente está relacionado à quantidade de memória da CPU), seguidas de passagens de fusão para essas execuções, cuja fusão geralmente é muito inteligente. organizado @footnote{
Os algoritmos de balanceamento de disco atuais, hoje em dia, são mais incômodos do que inteligentes, e isso é consequência da capacidade de busca dos discos. Em dispositivos que não são capazes de buscar, como grandes drives de fita, a história era bem diferente, e era preciso ser muito inteligente para garantir (com muita antecedência) que cada movimento da fita seria o mais eficaz possível (isto é, participaria melhor na “progressão” da fusão). Algumas fitas podiam até ser lidas de trás para frente, o que também era usado para evitar o tempo de rebobinar. Acredite em mim, fitas realmente boas eram espetaculares de assistir! Desde sempre, ordenar sempre foi uma Grande Arte! :-)
}. É muito importante que a classificação inicial produza as execuções mais longas possíveis. Os torneios são uma boa maneira de conseguir isso. Se, usando toda a memória disponível para realizar um torneio, você substituir e filtrar itens que se encaixem na corrida atual, você produzirá corridas que têm o dobro do tamanho da memória para entradas aleatórias e muito melhores para entradas ordenadas de maneira imprecisa.

Além disso, se você gerar o 0º item no disco e obter uma entrada que pode não caber no torneio atual (porque o valor “ganha” sobre o último valor de saída), ele não poderá caber no heap, então o tamanho do heap diminui. A memória liberada poderia ser reutilizada de maneira inteligente e imediata para a construção progressiva de um segundo heap, que cresce exatamente na mesma proporção que o primeiro heap está derretendo. Quando o primeiro heap desaparece completamente, você troca os heaps e inicia uma nova execução. Inteligente e bastante eficaz!

Em uma palavra, heaps são estruturas de memória úteis para conhecer. Eu os uso em alguns aplicativos e acho bom manter um módulo “heap” por perto. :-)

@node bisect — Algoritmo de bisseção de vetor,array— Vetores eficientes de valores numéricos,heapq — Algoritmo de fila heap,Tipos de Dados
@anchor{library/bisect doc}@anchor{26db}@anchor{library/bisect bisect-array-bisection-algorithm}@anchor{26dc}@anchor{library/bisect module-bisect}@anchor{11}@anchor{library/bisect translation-repo}@anchor{26dd}
@subsection @code{bisect} — Algoritmo de bisseção de vetor


@geindex module; bisect

@c example based on the PyModules FAQ entry by Aaron Watters <arw@pythonpros.com>

`Código-fonte:' Lib/bisect.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/bisect.py}


__________________________________________________________________


Este módulo fornece suporte para manter uma lista em ordem de classificação sem ter que classificar a lista após cada inserção. Para longas listas de itens com operações de comparação caras, isso pode ser uma melhoria em relação a pesquisas lineares ou recorrência frequente.

O módulo é chamado de @ref{11,,bisect} porque usa um algoritmo básico de bisseção para fazer seu trabalho. Ao contrário de outras ferramentas de bisseção que buscam um valor específico, as funções neste módulo são projetadas para localizar um ponto de inserção. Da mesma forma, as funções nunca chamam um método @ref{b0d,,__eq__()} para determinar se um valor foi encontrado. Em vez disso, as funções apenas chamam o método @ref{12e2,,__lt__()} e retornarão um ponto de inserção entre valores em um vetor.

@cartouche
@quotation Nota 
As funções neste módulo não são seguras para thread. Se várias threads usarem funções de @ref{11,,bisect} simultaneamente na mesma sequência, isso poderá resultar em um comportamento indefinido. Da mesma forma, se a sequência fornecida for mutada por uma thread diferente enquanto uma função de @ref{11,,bisect} estiver operando nela, o resultado será indefinido. Por exemplo, usar @ref{26de,,insort_left()} na mesma lista de várias threads pode fazer com que a lista fique desordenada.
@end quotation
@end cartouche
@anchor{library/bisect bisect-functions}@anchor{26df}
As seguintes funções são fornecidas:

@geindex bisect_left() (no módulo bisect)
@anchor{library/bisect bisect bisect_left}@anchor{26e0}
@deffn {Função} bisect.bisect_left (a, x, lo=0, hi=len(a), *, key=None)

Localiza o ponto de inserção de `x' em `a' para manter a ordem de classificação. Os parâmetros `lo' e `hi' podem ser usados para especificar um subconjunto da lista que deve ser considerado; por padrão, toda a lista é usada. Se `x' já estiver presente em `a', o ponto de inserção estará antes (à esquerda) de qualquer entrada existente. O valor de retorno é adequado para uso como o primeiro parâmetro para @code{list.insert()} supondo que `a' já esteja ordenado.

O ponto de inserção retornado `ip' particiona o vetor `a' em duas fatias de forma que @code{all(elem < x for elem in a[lo : ip])} seja verdadeiro para a fatia esquerda e @code{all(elem >= x for elem in a[ip : hi])} é verdadeiro para a fatia certa.

`key' especifica uma @ref{e31,,função chave} de um argumento que é usado para extrair uma chave de comparação de cada elemento no vetor. Para oferecer suporte à pesquisa de registros complexos, a função chave não é aplicada ao valor `x'.

Se `key' for @code{None}, os elementos serão comparados diretamente e nenhuma função chave será chamada.


Alterado na versão 3.10: Adicionado o  parâmetro `key'.

@end deffn

@geindex bisect_right() (no módulo bisect)
@geindex bisect() (no módulo bisect)
@anchor{library/bisect bisect bisect_right}@anchor{26e1}
@deffn {Função} bisect.bisect_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect bisect}@anchor{26e2}
@deffnx {Função} bisect.bisect (a, x, lo=0, hi=len(a), *, key=None)

Semelhante a @ref{26e0,,bisect_left()}, mas retorna um ponto de inserção que vem depois (à direita de) qualquer entrada existente de `x' em `a'.

O ponto de inserção retornado `ip' particiona o vetor `a' em duas fatias de forma que @code{all(elem <= x for elem in a[lo : ip])} seja verdadeiro para a fatia esquerda e @code{all(elem > x for elem in a[ip : hi])} é verdadeiro para a fatia certa.


Alterado na versão 3.10: Adicionado o  parâmetro `key'.

@end deffn

@geindex insort_left() (no módulo bisect)
@anchor{library/bisect bisect insort_left}@anchor{26de}
@deffn {Função} bisect.insort_left (a, x, lo=0, hi=len(a), *, key=None)

Insere `x' em `a' na ordem de classificação.

Esta função primeiro executa @ref{26e0,,bisect_left()} para localizar um ponto de inserção. Em seguida, executa o método @ref{211d,,insert()} em `a' para inserir `x' na posição apropriada para manter a ordem de classificação.

Para oferecer suporte à inserção de registros em uma tabela, a função `key' (se houver) é aplicada a `x' para a etapa de pesquisa, mas não para a etapa de inserção.

Tenha em mente que a busca `O'(log `n') é dominada pelo etapa de inserção lenta O(n).


Alterado na versão 3.10: Adicionado o  parâmetro `key'.

@end deffn

@geindex insort_right() (no módulo bisect)
@geindex insort() (no módulo bisect)
@anchor{library/bisect bisect insort_right}@anchor{26e3}
@deffn {Função} bisect.insort_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect insort}@anchor{26e4}
@deffnx {Função} bisect.insort (a, x, lo=0, hi=len(a), *, key=None)

Semelhante a @ref{26de,,insort_left()}, mas inserindo `x' em `a' após qualquer entrada existente de `x'.

Esta função primeiro executa @ref{26e1,,bisect_right()} para localizar um ponto de inserção. Em seguida, executa o método @ref{211d,,insert()} em `a' para inserir `x' na posição apropriada para manter a ordem de classificação.

Para oferecer suporte à inserção de registros em uma tabela, a função `key' (se houver) é aplicada a `x' para a etapa de pesquisa, mas não para a etapa de inserção.

Tenha em mente que a busca `O'(log `n') é dominada pelo etapa de inserção lenta O(n).


Alterado na versão 3.10: Adicionado o  parâmetro `key'.

@end deffn

@menu
* Observações sobre desempenho:: 
* Buscando em listas ordenadas:: 
* Exemplos: Exemplos<3>. 

@end menu

@node Observações sobre desempenho,Buscando em listas ordenadas,,bisect — Algoritmo de bisseção de vetor
@anchor{library/bisect performance-notes}@anchor{26e5}
@subsubsection Observações sobre desempenho


Ao escrever um código sensível ao tempo usando `bisect()' e `insort()', lembre-se do seguinte:


@itemize *

@item 
A bisseção é eficaz para pesquisar intervalos de valores. Para localizar valores específicos, os dicionários são mais eficientes.

@item 
As funções `insort()' são `O'(`n') porque a etapa de busca logarítmica é dominada pela etapa de inserção de tempo linear.

@item 
As funções de busca são stateless e descartam os resultados da função chave depois que são usadas. Consequentemente, se as funções de busca forem usadas em um laço, a função chave pode ser chamada repetidamente nos mesmos elementos do vetor. Se a função chave não for rápida, considere envolvê-la com @ref{1607,,functools.cache()} para evitar cálculos duplicados. Como alternativa, considere buscar um vetor de chaves pré-calculadas para localizar o ponto de inserção (conforme mostrado na seção de exemplos abaixo).
@end itemize


@subsubheading Ver também



@itemize *

@item 
Sorted Collections@footnote{https://grantjenks.com/docs/sortedcollections/} é um módulo de alto desempenho que usa bisseção para gerenciar coleções de dados classificadas.

@item 
A receita de SortedCollection@footnote{https://code.activestate.com/recipes/577197-sortedcollection/} usa bisseção para construir uma classe de coleção completa com métodos de busca diretos e suporte para uma função chave. As chaves são pré-calculadas para economizar em chamadas desnecessárias para a função chave durante as buscas.
@end itemize


@node Buscando em listas ordenadas,Exemplos<3>,Observações sobre desempenho,bisect — Algoritmo de bisseção de vetor
@anchor{library/bisect searching-sorted-lists}@anchor{26e6}
@subsubsection Buscando em listas ordenadas


As @ref{26df,,funções de bisseção} acima são úteis para encontrar pontos de inserção, mas podem ser complicadas ou difíceis de usar para tarefas comuns de busca. As cinco funções a seguir mostram como transformá-las nas buscas padrão para listas ordenadas:

@example
def index(a, x):
    'Encontra o valor mais à esquerda exatamente igual a x'
    i = bisect_left(a, x)
    if i != len(a) and a[i] == x:
        return i
    raise ValueError

def find_lt(a, x):
    'Encontra o valor mais à direita menor que x'
    i = bisect_left(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_le(a, x):
    'Encontra o valor mais à direita menor ou igual a x'
    i = bisect_right(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_gt(a, x):
    'Encontra o valor mais à esquerda maior que x'
    i = bisect_right(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

def find_ge(a, x):
    'Encontra o item mais à esquerda maior ou igual a x'
    i = bisect_left(a, x)
    if i != len(a):
        return a[i]
    raise ValueError
@end example

@node Exemplos<3>,,Buscando em listas ordenadas,bisect — Algoritmo de bisseção de vetor
@anchor{library/bisect examples}@anchor{26e7}
@subsubsection Exemplos

@anchor{library/bisect bisect-example}@anchor{26e8}
A função @ref{26e2,,bisect()} pode ser útil para buscas em tabelas numéricas. Este exemplo usa @ref{26e2,,bisect()} para buscar uma nota em letra para uma pontuação de exame (digamos) com base em um conjunto de pontos de interrupção numéricos ordenados: 90 e acima é um “A”, 80 a 89 é um “B” e por aí vai:

@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

As funções @ref{26e2,,bisect()} e @ref{26e4,,insort()} também funcionam com listas de tuplas. O argumento `key' pode servir para extrair o campo usado para ordenar registros em uma tabela:

@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')
... ]

>>> # Encontra o primeiro filme lançado após 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')

>>> # Insere um filme enquanto mantém a ordem de classificação
>>> 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

Se a função chave for custosa, é possível evitar chamadas de função repetidas buscando uma lista de chaves pré-calculadas para encontrar o índice de um registro:

@example
>>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
>>> data.sort(key=lambda r: r[1])       # Ou use operator.itemgetter(1).
>>> keys = [r[1] for r in data]         # Pré-calcula uma lista de chaves.
>>> 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— Vetores eficientes de valores numéricos,weakref — Referências fracas,bisect — Algoritmo de bisseção de vetor,Tipos de Dados
@anchor{library/array doc}@anchor{26e9}@anchor{library/array array-efficient-arrays-of-numeric-values}@anchor{26ea}@anchor{library/array module-array}@anchor{7}@anchor{library/array translation-repo}@anchor{26eb}
@subsection @code{array}— Vetores eficientes de valores numéricos


@geindex module; array

@geindex vetores


__________________________________________________________________


This module defines an object type which can compactly represent an array of
basic values: characters, integers, floating-point numbers.  Arrays are mutable @ref{4f1,,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 em C

@tab

Tipo em Python

@tab

Tamanho mínimo em 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

Caractere unicode

@tab

2

@tab

(1)

@item

@code{'w'}

@tab

Py_UCS4

@tab

Caractere unicode

@tab

4

@tab

(2)

@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

ponto flutuante

@tab

ponto flutuante

@tab

4

@tab

@item

@code{'d'}

@tab

double

@tab

ponto flutuante

@tab

8

@tab

@end multitable


Notas:


@enumerate 

@item 
Pode ser de 16 ou 32 bits dependendo da plataforma.


Alterado na versão 3.9: @code{array('u')} agora usa @code{wchar_t} como tipo C no lugar do descontinuado @code{Py_UNICODE}. Essa mudança não afeta o comportamento pois @code{Py_UNICODE} é um apelido para @code{wchar_t} desde Python 3.3.



Descontinuado desde a versão 3.3, será removido na versão 3.16: Por favor, migre para o código de tipo @code{'w'}.


@item 

Adicionado na versão 3.13.

@end enumerate

A representação dos valores é definida pela arquitetura da máquina, mais especificamente da implementação do C. O tamanho real pode ser acessado pelo atributo @ref{26ec,,array.itemsize}.

O módulo define o seguinte item:

@geindex typecodes (no módulo array)
@anchor{library/array array typecodes}@anchor{26ed}
@deffn {Dado} array.typecodes

String com todos os códigos de tipo disponíveis.
@end deffn

O módulo define o seguinte tipo:

@geindex array (classe em array)
@anchor{library/array array array}@anchor{1a0}
@deffn {Classe} array.array (typecode[, initializer])

Um novo vetor cujos itens são restritos por `typecode' e inicializados a partir do valor opcional `initializer', que deve ser um objeto @ref{1c2,,bytes} ou @ref{2ea,,bytearray}, uma string Unicode ou iterável sobre elementos do tipo apropriado.

Se for fornecido um objeto @ref{1c2,,bytes} ou @ref{2ea,,bytearray}, o inicializador é passado para o método @ref{12b3,,frombytes()} do novo vetor; se for fornecida uma string Unicode, o inicializador é passado para o método @ref{26ee,,fromunicode()}; caso contrário, o iterador do inicializador é passado para o método @ref{26ef,,extend()} para adicionar itens iniciais ao vetor.

Array objects support the ordinary @ref{22f7,,mutable} @ref{4f1,,sequence} operations of indexing, slicing,
concatenation, and multiplication.  When using slice assignment, the assigned
value must be an array object with the same type code; in all other cases,
@ref{2c3,,TypeError} is raised. Array objects also implement the buffer interface,
and may be used wherever @ref{d4f,,bytes-like objects} are supported.

Levanta um @ref{19fa,,evento de auditoria} @code{array.__new__} com os argumentos @code{typecode}, @code{initializer}.

@geindex typecode (atributo array.array)
@anchor{library/array array array typecode}@anchor{26f0}
@deffn {Atributo} typecode

O caractere de código de tipo usado para criar o vetor.
@end deffn

@geindex itemsize (atributo array.array)
@anchor{library/array array array itemsize}@anchor{26ec}
@deffn {Atributo} itemsize

O tamanho em bytes de um item do vetor em representação interna.
@end deffn

@geindex append() (método array.array)
@anchor{library/array array array append}@anchor{26f1}
@deffn {Método} append (x)

Adiciona um novo item com valor `x' ao final do vetor.
@end deffn

@geindex buffer_info() (método array.array)
@anchor{library/array array array buffer_info}@anchor{26f2}
@deffn {Método} buffer_info ()

Retorna uma tupla @code{(address, length)} com o endereço corrente da memória e o tamanho em elementos do buffer usado para armazenar conteúdos do vetor. O tamanho do buffer da memória em bytes pode ser computado como @code{array.buffer_info()[1] * array.itemsize}. Isso é ocasionalmente útil quando se está trabalhando com interfaces I/O de baixo nível (inerentemente inseguras) que precisam de endereços de memória, como algumas operações @code{ioctl()}. Os números retornados são válidos enquanto o vetor existir e nenhuma operação de alteração de tamanho for aplicada a ele.

@cartouche
@quotation Nota 
Quando se está usando vetores de código escrito em C ou C++ (o único jeito efetivo de usar essa informação), faz mais sentido usar a interface do buffer suportada pelos vetores. Esse método é mantido para retrocompatibilidade e deve ser evitado em código novo. A interface de buffers está documentada em @ref{2e8,,Protocolo de buffer}.
@end quotation
@end cartouche
@end deffn

@geindex byteswap() (método array.array)
@anchor{library/array array array byteswap}@anchor{26f3}
@deffn {Método} byteswap ()

“Byteswap” todos os itens do vetor. Isso é somente suportado para valores de 1, 2, 4 ou 8 bytes de tamanho; para outros tipos de valores é levantada @ref{195,,RuntimeError}. Isso é útil quando estamos lendo dados de um arquivo para serem escritos em um arquivo de outra máquina de ordem de bytes diferente.
@end deffn

@geindex count() (método array.array)
@anchor{library/array array array count}@anchor{26f4}
@deffn {Método} count (x)

Retorna a quantidade de ocorrências de `x' no vetor.
@end deffn

@geindex extend() (método array.array)
@anchor{library/array array array extend}@anchor{26ef}
@deffn {Método} extend (iterable)

Acrescenta os itens de `iterable' ao final do vetor. Se `iterable' for outro vetor, ele deve ter `exatamente' o mesmo código de tipo; senão, ocorrerá uma @ref{2c3,,TypeError}. Se `iterable' não for um vetor, ele deve ser iterável e seus elementos devem ser do tipo correto para ser acrescentado ao vetor.
@end deffn

@geindex frombytes() (método array.array)
@anchor{library/array array array frombytes}@anchor{12b3}
@deffn {Método} frombytes (buffer)

Adiciona itens do @ref{d4f,,objeto bytes ou similar}, interpretando seu conteúdo como um vetor de valores de máquina (como se tivesse sido lido de um arquivo usando o método @ref{1303,,fromfile()}).


Adicionado na versão 3.2: @code{fromstring()} foi renomeado para @ref{12b3,,frombytes()} para maior clareza.

@end deffn

@geindex fromfile() (método array.array)
@anchor{library/array array array fromfile}@anchor{1303}
@deffn {Método} fromfile (f, n)

Lê `n' itens (como valores de máquinas) do @ref{1203,,objeto arquivo} `f' e adiciona-os ao fim do vetor. Se estão disponíveis menos de `n' itens, @ref{131c,,EOFError} é levantada, mas os itens disponíveis ainda são inseridos ao final do vetor.
@end deffn

@geindex fromlist() (método array.array)
@anchor{library/array array array fromlist}@anchor{26f5}
@deffn {Método} fromlist (list)

Adiciona itens de `list'.  Isso é equivalente a @code{for x in list: a.append(x)} exceto que se ocorrer um erro de tipo, o vetor não é alterado.
@end deffn

@geindex fromunicode() (método array.array)
@anchor{library/array array array fromunicode}@anchor{26ee}
@deffn {Método} fromunicode (s)

Estende este vetor com dados da string Unicode fornecida. O vetor deve ter o código de tipo @code{'u'} ou @code{'w'}; caso contrário, uma @ref{202,,ValueError} é levantada. Use @code{array.frombytes(unicodestring.encode(enc))} para anexar dados Unicode a um vetor de algum outro tipo.
@end deffn

@geindex index() (método array.array)
@anchor{library/array array array index}@anchor{7e2}
@deffn {Método} index (x[, start[, stop]])

Retorna o menor `i' tal que `i' seja o índice da primeira ocorrência de `x' no vetor. Os argumentos opcionais `start' e `stop' podem ser especificados para procurar por `x' dentro de uma subseção do vetor. Levanta @ref{202,,ValueError} se `x' não for encontrado.


Alterado na versão 3.10: Adicionados os parâmetros opcionais `start e *stop'.

@end deffn

@geindex insert() (método array.array)
@anchor{library/array array array insert}@anchor{26f6}
@deffn {Método} insert (i, x)

Insere um novo item com o valor `x' no vetor antes da posição `i'. Valores negativos são tratados como sendo em relação ao fim do vetor.
@end deffn

@geindex pop() (método array.array)
@anchor{library/array array array pop}@anchor{26f7}
@deffn {Método} pop ([i])

Remove o item com o índice `i' do vetor e retorna este item. O valor padrão do argumento opcional é @code{-1}, assim por padrão o último item é removido e retornado.
@end deffn

@geindex remove() (método array.array)
@anchor{library/array array array remove}@anchor{26f8}
@deffn {Método} remove (x)

Remove a primeira ocorrência de `x' do vetor.
@end deffn

@geindex clear() (método array.array)
@anchor{library/array array array clear}@anchor{1a2}
@deffn {Método} clear ()

Remove todos os elementos do vetor.


Adicionado na versão 3.13.

@end deffn

@geindex reverse() (método array.array)
@anchor{library/array array array reverse}@anchor{26f9}
@deffn {Método} reverse ()

Inverte a ordem dos itens no vetor.
@end deffn

@geindex tobytes() (método array.array)
@anchor{library/array array array tobytes}@anchor{12b2}
@deffn {Método} tobytes ()

Devolve os itens do vetor como um vetor de valores de máquina com a representação em bytes (a mesma sequência de bytes que seria escrita pelo método @ref{1304,,tofile()}.)


Adicionado na versão 3.2: @code{tostring()} foi nomeado para @ref{12b2,,tobytes()} para maior clareza.

@end deffn

@geindex tofile() (método array.array)
@anchor{library/array array array tofile}@anchor{1304}
@deffn {Método} tofile (f)

Escreve todos os itens (como valores de máquinas) para o @ref{1203,,objeto arquivo} `f'.
@end deffn

@geindex tolist() (método array.array)
@anchor{library/array array array tolist}@anchor{26fa}
@deffn {Método} tolist ()

Devolve os itens do vetor como uma lista comum.
@end deffn

@geindex tounicode() (método array.array)
@anchor{library/array array array tounicode}@anchor{26fb}
@deffn {Método} tounicode ()

Devolve os itens do vetor como uma string Unicode. O vetor deve ser do tipo @code{'u'} ou @code{'w'}; caso contrário @ref{202,,ValueError} é levantada. Use @code{array.tobytes().decode(enc)} para obter uma string Unicode de um vetor de outros tipos.
@end deffn
@end deffn

A representação em string de objetos vetor tem o formato @code{array(typecode, initializer)}. O `initializer' é omitido se o vetor estiver vazio; caso contrário, é uma string Unicode se o `typecode' for @code{'u'} ou @code{'w'}; caso contrário, é uma lista de números. A representação em string pode ser convertida novamente para um array com o mesmo tipo e valor usando @ref{180,,eval()}, desde que a classe @ref{1a0,,array} tenha sido importada usando @code{from array import array}. As variáveis @code{inf} e @code{nan} também devem ser definidas se contiverem valores de ponto flutuante correspondentes. Exemplos:

@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 também



@table @asis

@item Módulo @ref{d5,,struct}

Empacotamento e desempacotamento de dados binários heterogêneos.

@item NumPy@footnote{https://numpy.org/}

O pacote NumPy define outro tipo de vetor.
@end table


@node weakref — Referências fracas,types — Criação de tipos dinâmicos e nomes para tipos embutidos,array— Vetores eficientes de valores numéricos,Tipos de Dados
@anchor{library/weakref doc}@anchor{26fc}@anchor{library/weakref mod-weakref}@anchor{f3c}@anchor{library/weakref module-weakref}@anchor{114}@anchor{library/weakref translation-repo}@anchor{26fd}@anchor{library/weakref weakref-weak-references}@anchor{26fe}
@subsection @code{weakref} — Referências fracas


@geindex module; weakref

`Código-fonte:' Lib/weakref.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/weakref.py}


__________________________________________________________________


O módulo @ref{114,,weakref} permite ao programador Python criar `referências fracas' para objetos.

@c When making changes to the examples in this file, be sure to update
@c Lib/test/test_weakref.py::libreftest too!

A seguir, o termo `referente' significa o objeto ao qual é referido por uma referência fraca.

Uma referência fraca a um objeto não é suficiente para mantê-lo vivo: quando as únicas referências restantes a um referente são referências fracas, a @ref{1a69,,coleta de lixo} está livre para destruir o referente e reutilizar sua memória para outra coisa. Entretanto, até que o objeto seja realmente destruído, a referência fraca poderá retornar o objeto mesmo que não haja referências fortes a ele.

Um uso principal para referências fracas é implementar caches ou mapeamentos contendo objetos grandes, onde é desejado que um objeto grande não seja mantido ativo apenas porque aparece em um cache ou mapeamento.

Por exemplo, se você tiver vários objetos de imagem binária grandes, poderá associar um nome a cada um. Se você usasse um dicionário Python para mapear nomes para imagens, ou imagens para nomes, os objetos de imagem permaneceriam vivos apenas porque apareceriam como valores ou chaves nos dicionários. As classes @ref{1ae6,,WeakKeyDictionary} e @ref{1ae5,,WeakValueDictionary} fornecidas pelo módulo @ref{114,,weakref} são uma alternativa, usando referências fracas para construir mapeamentos que não mantêm objetos vivos apenas porque aparecem nos objetos de mapeamento. Se, por exemplo, um objeto de imagem for um valor em um @ref{1ae5,,WeakValueDictionary}, então quando as últimas referências restantes a esse objeto de imagem forem as referências fracas mantidas por mapeamentos fracos, a coleta de lixo poderá recuperar o objeto e suas entradas correspondentes em mapeamentos fracos são simplesmente excluídos.

@ref{1ae6,,WeakKeyDictionary} e @ref{1ae5,,WeakValueDictionary} usam referências fracas em sua implementação, configurando funções de retorno de chamada nas referências fracas que notificam os dicionários fracos quando uma chave ou valor foi recuperado pela coleta de lixo. @ref{5dd,,WeakSet} implementa a interface @ref{5d9,,set}, mas mantém referências fracas aos seus elementos, assim como @ref{1ae6,,WeakKeyDictionary} faz.

@ref{a86,,finalize} fornece uma maneira direta de registrar uma função de limpeza a ser chamada quando um objeto é coletado como lixo. Isso é mais simples de usar do que configurar uma função de retorno de chamada em uma referência fraca não tratada, pois o módulo garante automaticamente que o finalizador permaneça ativo até que o objeto seja coletado.

A maioria dos programas deve descobrir que usar um desses tipos de contêineres fracos ou @ref{a86,,finalize} é tudo que eles precisam – geralmente não é necessário criar suas próprias referências fracas diretamente. O maquinário de baixo nível é exposto pelo módulo @ref{114,,weakref} para benefício de usos avançados.

Nem todos os objetos podem ser referenciados de maneira fraca. Objetos que oferecem suporte a referências fracas incluem instâncias de classe, funções escritas em Python (mas não em C), métodos de instância, conjuntos, frozensets, alguns @ref{1203,,objetos arquivos}, @ref{109a,,geradores}, objetos tipo, sockets, arrays, deques, objetos padrão de expressão regular e objetos código.


Alterado na versão 3.2: Adicionado suporte para thread.lock, threading.Lock e objetos código.


Vários tipos embutidos como @ref{611,,list} e @ref{256,,dict} não oferecem suporta diretamente a referências fracas, mas podem adicionar suporte através de subclasses:

@example
class Dict(dict):
    pass

obj = Dict(red=1, green=2, blue=3)   # este objeto é potencialmente fracamente referenciável
@end example

Outros tipos embutidos como @ref{370,,tuple} e @ref{257,,int} não oferecem suporte a referências fracas mesmo em subclasses.

Os tipos de extensão podem ser facilmente criados para oferecer suporte a referências fracas; veja @ref{26ff,,Weak Reference Support}.

Quando @code{__slots__} são definidos para um determinado tipo, o suporte a referência fraca é desativado a menos que uma string @code{'__weakref__'} também esteja presente na sequência de strings na declaração de @code{__slots__}. Veja a @ref{20c2,,documentação de __slots__} para detalhes.

@geindex ref (classe em weakref)
@anchor{library/weakref weakref ref}@anchor{1026}
@deffn {Classe} weakref.ref (object[, callback])

Retorna uma referência fraca para `object'. O objeto original pode ser recuperado chamando o objeto referência se o referente ainda estiver ativo; se o referente não estiver mais ativo, chamar o objeto referência fará com que @ref{675,,None} seja retornado. Se `callback' for fornecido e não for @ref{675,,None}, e o objeto referência fraca retornado ainda estiver ativo, o função de retorno será chamada quando o objeto estiver prestes a ser finalizado; o objeto referência fraca será passado como único parâmetro para a função de retorno; o referente não estará mais disponível.

É permitido que muitas referências fracas sejam construídas para o mesmo objeto. As funções de retorno registradas para cada referência fraca serão chamadas da função de retorno registrada mais recentemente para a função de retorno registrada mais antiga.

As exceções levantadas pela função de retorno serão anotadas na saída de erro padrão, mas não poderão ser propagadas; elas são tratadas exatamente da mesma maneira que as exceções levantadas pelo método @ref{1033,,__del__()} de um objeto.

Referências fracas são @ref{610,,hasheáveis} se o `object' for hasheável. Elas manterão seu valor de hash mesmo depois que `object' for excluído. Se @ref{5eb,,hash()} for chamada pela primeira vez somente após o `object' ter sido excluído, a chamada vai levantar @ref{2c3,,TypeError}.

Referências fracas oferecem suporte a testes de igualdade, mas não de ordenação. Se os referentes ainda estiverem vivos, duas referências terão a mesma relação de igualdade que seus referentes (independentemente do `callback'). Se um dos referentes tiver sido excluído, as referências serão iguais somente se os objetos referência forem o mesmo objeto.

Este é um tipo do qual pode ser feita subclasse em vez de uma função de fábrica.

@geindex __callback__ (atributo weakref.ref)
@anchor{library/weakref weakref ref __callback__}@anchor{1027}
@deffn {Atributo} __callback__

Este atributo somente leitura retorna a função de retorno atualmente associada à referência fraca. Se não houver função de retorno ou se o referente da referência fraca não estiver mais ativo, então este atributo terá o valor @code{None}.
@end deffn


Alterado na versão 3.4: Adicionado o atributo @ref{1027,,__callback__}.

@end deffn

@geindex proxy() (no módulo weakref)
@anchor{library/weakref weakref proxy}@anchor{a5b}
@deffn {Função} weakref.proxy (object[, callback])

Retorna um intermediário (proxy, em inglês) para `object' que usa uma referência fraca. Isto provê suporte ao uso do intermediário na maioria dos contextos, em vez de exigir a desreferenciação explícita usada com objetos de referência fraca. O objeto retornado terá um tipo @code{ProxyType} ou @code{CallableProxyType}, dependendo se `object' é chamável. Objetos intermediários não são @ref{610,,hasheáveis} independentemente do referente; isso evita uma série de problemas relacionados à sua natureza fundamentalmente mutável e impede seu uso como chaves de dicionário. `callback' é igual ao parâmetro de mesmo nome da função @ref{1026,,ref()}.

Acessar um atributo do objeto intermediário depois que o referente é coletado como lixo levanta @ref{1556,,ReferenceError}.


Alterado na versão 3.8: Estendeu o suporte ao operador em objetos intermediários para incluir os operadores @code{@@} e @code{@@=} para multiplicação de matrizes.

@end deffn

@geindex getweakrefcount() (no módulo weakref)
@anchor{library/weakref weakref getweakrefcount}@anchor{2700}
@deffn {Função} weakref.getweakrefcount (object)

Retorna o número de referências fracas e intermediários que fazem referência a `object'.
@end deffn

@geindex getweakrefs() (no módulo weakref)
@anchor{library/weakref weakref getweakrefs}@anchor{2701}
@deffn {Função} weakref.getweakrefs (object)

Retorna uma lista de todos os objetos intermediários e de referência fraca que fazem referência a `object'.
@end deffn

@geindex WeakKeyDictionary (classe em weakref)
@anchor{library/weakref weakref WeakKeyDictionary}@anchor{1ae6}
@deffn {Classe} weakref.WeakKeyDictionary ([dict])

Classe de mapeamento que faz referência fraca a chaves. Entradas no dicionário serão descartadas quando não houver mais uma referência forte à chave. Isso pode ser usado para associar dados adicionais a um objeto de propriedade de outras partes de uma aplicação sem adicionar atributos a esses objetos. Isso pode ser especialmente útil com objetos que substituem acessos de atributos.

Note que quando uma chave com valor igual a uma chave existente (mas não identidade igual) é inserida no dicionário, ela substitui o valor, mas não substitui a chave existente. Devido a isso, quando a referência à chave original é excluída, ela também exclui a entrada no dicionário:

@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

Uma solução alternativa seria remover a chave antes da reatribuição:

@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


Alterado na versão 3.9: Adicionado suporte para operadores @code{|} e @code{|=}, conforme especificado na 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

Objetos @ref{1ae6,,WeakKeyDictionary} têm um método adicional que expõe as referências internas diretamente. Não há garantia de que as referências estejam “ativas” no momento em que são usadas, então o resultado da chamada das referências precisa ser verificado antes de ser usado. Isso pode ser usado para evitar a criação de referências que farão com que o coletor de lixo mantenha as chaves por mais tempo do que o necessário.

@geindex keyrefs() (método weakref.WeakKeyDictionary)
@anchor{library/weakref weakref WeakKeyDictionary keyrefs}@anchor{2702}
@deffn {Método} WeakKeyDictionary.keyrefs ()

Retorna um iterável das referências fracas às chaves.
@end deffn

@geindex WeakValueDictionary (classe em weakref)
@anchor{library/weakref weakref WeakValueDictionary}@anchor{1ae5}
@deffn {Classe} weakref.WeakValueDictionary ([dict])

Classe de mapeamento que faz referência fraca a valores. Entradas no dicionário serão descartadas quando nenhuma referência forte ao valor existir mais.


Alterado na versão 3.9: Adicionado suporte para operadores @code{|} e @code{|=}, conforme especificado na 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

Os objetos @ref{1ae5,,WeakValueDictionary} têm um método adicional que apresenta os mesmos problemas que o método @ref{2702,,WeakKeyDictionary.keyrefs()}.

@geindex valuerefs() (método weakref.WeakValueDictionary)
@anchor{library/weakref weakref WeakValueDictionary valuerefs}@anchor{2703}
@deffn {Método} WeakValueDictionary.valuerefs ()

Retorna um iterável das referências fracas aos valores.
@end deffn

@geindex WeakSet (classe em weakref)
@anchor{library/weakref weakref WeakSet}@anchor{5dd}
@deffn {Classe} weakref.WeakSet ([elements])

Define a classe que mantém referências fracas para seus elementos. Um elemento será descartado quando nenhuma referência forte a ele existir mais.
@end deffn

@geindex WeakMethod (classe em weakref)
@anchor{library/weakref weakref WeakMethod}@anchor{1025}
@deffn {Classe} weakref.WeakMethod (method[, callback])

Uma subclasse personalizada de @ref{1026,,ref} que simula uma referência fraca a um método vinculado (ou seja, um método definido em uma classe e pesquisado em uma instância). Como um método vinculado é efêmero, uma referência fraca padrão não pode mantê-lo. @ref{1025,,WeakMethod} tem um código especial para recriar o método vinculado até que o objeto ou a função original morra:

@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' é o mesmo que o parâmetro de mesmo nome da função @ref{1026,,ref()}.


Adicionado na versão 3.4.

@end deffn

@geindex finalize (classe em weakref)
@anchor{library/weakref weakref finalize}@anchor{a86}
@deffn {Classe} weakref.finalize (obj, func, /, *args, **kwargs)

Retorna um objeto finalizador chamável que será chamado quando `obj' for coletado como lixo. Diferentemente de uma referência fraca comum, um finalizador sempre sobreviverá até que o objeto referência seja coletado, simplificando muito o gerenciamento do ciclo de vida.

Um finalizador é considerado `alive' (vivo) até ser chamado (explicitamente ou na coleta de lixo), e depois disso ele é `dead' (morto). Chamar um finalizador vivo retorna o resultado da avaliação de @code{func(*arg, **kwargs)}, enquanto chamar um finalizador morto retorna @ref{675,,None}.

Exceções levantadas por funções de retorno do finalizador durante a coleta de lixo serão mostradas na saída de erro padrão, mas não podem ser propagadas. Elas são tratadas da mesma forma que exceções levantadas de um método @ref{1033,,__del__()} de um objeto ou de uma função de retorno da referência fraca.

Quando o programa é encerrado, cada finalizador vivo restante é chamado, a menos que seu atributo @ref{c,,atexit} tenha sido definido como falso. Eles são chamados na ordem reversa da criação.

Um finalizador nunca vai invocar sua função de retorno durante a parte posterior do @ref{14e,,desligamento do interpretador} quando os globais do módulo podem ter sido substituídos por @ref{675,,None}.

@geindex __call__() (método weakref.finalize)
@anchor{library/weakref weakref finalize __call__}@anchor{2704}
@deffn {Método} __call__ ()

Se `self' estiver vivo, marca-o como morto e retorna o resultado da chamada @code{func(*args, **kwargs)}. Se `self' estiver morto, retorna @ref{675,,None}.
@end deffn

@geindex detach() (método weakref.finalize)
@anchor{library/weakref weakref finalize detach}@anchor{2705}
@deffn {Método} detach ()

Se `self' estiver vivo, marca-o como morto e retorna a tupla @code{(obj, func, args, kwargs)}. Se `self' estiver morto, retorna @ref{675,,None}.
@end deffn

@geindex peek() (método weakref.finalize)
@anchor{library/weakref weakref finalize peek}@anchor{2706}
@deffn {Método} peek ()

Se `self' estiver vivo, retorna a tupla @code{(obj, func, args, kwargs)}. Se `self' estiver morto, retorna @ref{675,,None}.
@end deffn

@geindex alive (atributo weakref.finalize)
@anchor{library/weakref weakref finalize alive}@anchor{2707}
@deffn {Atributo} alive

Propriedade que é verdadeiro se o finalizador estiver ativo, falsa caso contrário.
@end deffn

@geindex atexit (atributo weakref.finalize)
@anchor{library/weakref weakref finalize atexit}@anchor{2708}
@deffn {Atributo} atexit

Uma propriedade booleana gravável que por padrão é verdadeiro. Quando o programa sai, ele chama todos os finalizadores vivos restantes para os quais @ref{2708,,atexit} é verdadeiro. Eles são chamados na ordem reversa da criação.
@end deffn

@cartouche
@quotation Nota 
É importante garantir que `func', `args' e `kwargs' não possuam nenhuma referência a `obj', direta ou indiretamente, pois, caso contrário, `obj' nunca será coletado como lixo. Em particular, `func' não deve ser um método vinculado de `obj'.
@end quotation
@end cartouche


Adicionado na versão 3.4.

@end deffn

@geindex ReferenceType (no módulo weakref)
@anchor{library/weakref weakref ReferenceType}@anchor{18e8}
@deffn {Dado} weakref.ReferenceType

O objeto tipo para objetos referências fracas.
@end deffn

@geindex ProxyType (no módulo weakref)
@anchor{library/weakref weakref ProxyType}@anchor{18e9}
@deffn {Dado} weakref.ProxyType

O tipo de objeto para intermediários de objetos que não são chamáveis.
@end deffn

@geindex CallableProxyType (no módulo weakref)
@anchor{library/weakref weakref CallableProxyType}@anchor{18ea}
@deffn {Dado} weakref.CallableProxyType

O objeto de tipo para intermediários de objetos chamáveis.
@end deffn

@geindex ProxyTypes (no módulo weakref)
@anchor{library/weakref weakref ProxyTypes}@anchor{2709}
@deffn {Dado} weakref.ProxyTypes

Sequência contendo todos os objetos de tipo para intermediários. Isso pode tornar mais simples testar se um objeto é um intermediário sem depender da nomeação de ambos os tipos de intermediário.
@end deffn


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - Weak References

A proposta e a justificativa para esse recurso, incluindo links para implementações anteriores e informações sobre recursos semelhantes em outras linguagens.
@end table


@menu
* Objetos referência fraca:: 
* Exemplo: Exemplo<2>. 
* Objetos finalizadores:: 
* Comparando finalizadores com métodos __del__(): Comparando finalizadores com métodos __del__. 

@end menu

@node Objetos referência fraca,Exemplo<2>,,weakref — Referências fracas
@anchor{library/weakref weak-reference-objects}@anchor{270a}@anchor{library/weakref weakref-objects}@anchor{270b}
@subsubsection Objetos referência fraca


Objetos referência fraca não têm métodos nem atributos além de @ref{1027,,ref.__callback__}. Um objeto referência fraca permite que o referente seja obtido, se ele ainda existir, chamando-o:

@example
>>> import weakref
>>> class Object:
...     pass
...
>>> o = Object()
>>> r = weakref.ref(o)
>>> o2 = r()
>>> o is o2
True
@end example

Se o referente não existir mais, chamar o objeto referência retornará @ref{675,,None}:

@example
>>> del o, o2
>>> print(r())
None
@end example

O teste de se um objeto referência fraca ainda está vivo deve ser feito usando a expressão @code{ref() is not None}. Normalmente, o código da aplicação que precisa usar um objeto de referência deve seguir este padrão:

@example
# r é um objeto referência fraca
o = r()
if o is None:
    # referente foi coletado como lixo
    print("O objeto foi desalocado; não é possível mexer com ele.")
else:
    print("O objeto ainda está vivo!")
    o.faz_algo_útil()
@end example

Usar um teste separado para “vivacidade” cria condições de corrida em aplicações que usam mais de uma thread; uma outra thread pode fazer com que uma referência fraca seja invalidada antes que a referência fraca seja chamada; o idioma mostrado acima é seguro em aplicações que usam mais de uma thread, bem como em aplicações de thread única.

Versões especializadas de objetos @ref{1026,,ref} podem ser criadas por meio de subclasse. Isso é usado na implementação do @ref{1ae5,,WeakValueDictionary} para reduzir a sobrecarga de memória para cada entrada no mapeamento. Isso pode ser mais útil para associar informações adicionais a uma referência, mas também pode ser usado para inserir processamento adicional em chamadas para recuperar o referente.

Este exemplo mostra como uma subclasse de @ref{1026,,ref} pode ser usada para armazenar informações adicionais sobre um objeto e afetar o valor retornado quando o referente é acessado:

@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):
        """Retorna um par contendo o referente e o número de
        vezes que a referência foi chamada.
        """
        ob = super().__call__()
        if ob is not None:
            self.__counter += 1
            ob = (ob, self.__counter)
        return ob
@end example

@node Exemplo<2>,Objetos finalizadores,Objetos referência fraca,weakref — Referências fracas
@anchor{library/weakref example}@anchor{270c}@anchor{library/weakref weakref-example}@anchor{270d}
@subsubsection Exemplo


Este exemplo simples mostra como uma aplicação pode usar IDs de objeto para recuperar objetos que ele viu antes. Os IDs dos objetos podem então ser usados em outras estruturas de dados sem forçar os objetos a permanecerem vivos, mas os objetos ainda podem ser recuperados por ID se o fizerem.

@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 com métodos __del__,Exemplo<2>,weakref — Referências fracas
@anchor{library/weakref finalize-examples}@anchor{270e}@anchor{library/weakref finalizer-objects}@anchor{270f}
@subsubsection Objetos finalizadores


O principal benefício de usar @ref{a86,,finalize} é que ele simplifica o registro de um retorno de chamada sem precisar preservar o objeto finalizador retornado. Por exemplo

@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

O finalizador pode ser chamado diretamente também. No entanto, o finalizador vai invocar a função de retorno no máximo uma 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

Você pode desfazer o registro de um finalizador usando seu método @ref{2705,,detach()}. Isso elimina o finalizador e retorna os argumentos passados ao construtor quando ele foi criado.

@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 você defina o atributo @ref{2708,,atexit} como @ref{b49,,False}, um finalizador será chamado quando o programa sair se ele ainda estiver vivo. Por exemplo

@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 com métodos __del__,,Objetos finalizadores,weakref — Referências fracas
@anchor{library/weakref comparing-finalizers-with-del-methods}@anchor{2710}
@subsubsection Comparando finalizadores com métodos @code{__del__()}


Suponha que queremos criar uma classe cujas instâncias representam diretórios temporários. Os diretórios devem ser excluídos com seus conteúdos quando o primeiro dos seguintes eventos ocorrer:


@itemize *

@item 
o objeto é um lixo coletado,

@item 
o método @code{remove()} do objeto é chamado, ou

@item 
o programa finaliza.
@end itemize

Podemos tentar implementar a classe usando um método @ref{1033,,__del__()} da seguinte maneira:

@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 do Python 3.4, os métodos @ref{1033,,__del__()} não impedem mais que os ciclos de referência sejam coletados como lixo, e os módulos globais não são mais forçados a @ref{675,,None} durante @ref{14e,,desligamento do interpretador}. Então, esse código deve funcionar sem problemas no CPython.

Entretanto, o tratamento dos métodos @ref{1033,,__del__()} é notoriamente específico da implementação, pois depende de detalhes internos da implementação do coletor de lixo do interpretador.

Uma alternativa mais robusta pode ser definir um finalizador que faça referência apenas às funções e objetos específicos de que necessita, em vez de ter acesso ao estado completo do 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 assim, nosso finalizador recebe apenas uma referência aos detalhes que ele precisa para limpar o diretório apropriadamente. Se o objeto nunca for coletado como lixo, o finalizador ainda será chamado na saída.

A outra vantagem dos finalizadores baseados em referências fracas é que eles podem ser usados para registrar finalizadores para classes onde a definição é controlada por terceiros, como executar código quando um módulo é descarregado:

@example
import weakref, sys
def unloading_module():
    # referência implícita aos globais do módulo do corpo da função
weakref.finalize(sys.modules[__name__], unloading_module)
@end example

@cartouche
@quotation Nota 
Se você criar um objeto finalizador em uma thread em um daemon assim que o programa sair, então há a possibilidade de que o finalizador não seja chamado na saída. No entanto, em um thread em um daemon @ref{882,,atexit.register()}, @code{try: ... finally: ...} e @code{with: ...} não garantem que a limpeza ocorra também.
@end quotation
@end cartouche

@node types — Criação de tipos dinâmicos e nomes para tipos embutidos,copy — Operações de cópia profunda e cópia rasa,weakref — Referências fracas,Tipos de Dados
@anchor{library/types doc}@anchor{2711}@anchor{library/types module-types}@anchor{103}@anchor{library/types translation-repo}@anchor{2712}@anchor{library/types types-dynamic-type-creation-and-names-for-built-in-types}@anchor{2713}
@subsection @code{types} — Criação de tipos dinâmicos e nomes para tipos embutidos


@geindex module; types

`Código-fonte:' Lib/types.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/types.py}


__________________________________________________________________


Este módulo define funções utilitárias para auxiliar na criação dinâmica de novos tipos.

Também define nomes para alguns tipos de objetos usados pelo interpretador Python padrão, mas não expostos como componentes embutidos como @ref{257,,int} ou @ref{44c,,str} são.

Por fim, fornece algumas classes e funções adicionais relacionadas ao tipo que não são fundamentais o suficiente para serem incorporadas.

@menu
* Criação de tipos dinâmicos:: 
* Tipos padrão do interpretador:: 
* Classes e funções de utilidades adicionais:: 
* Funções de utilidade de corrotina:: 

@end menu

@node Criação de tipos dinâmicos,Tipos padrão do interpretador,,types — Criação de tipos dinâmicos e nomes para tipos embutidos
@anchor{library/types dynamic-type-creation}@anchor{2714}
@subsubsection Criação de tipos dinâmicos


@geindex new_class() (no módulo types)
@anchor{library/types types new_class}@anchor{11a0}
@deffn {Função} types.new_class (name, bases=(), kwds=None, exec_body=None)

Cria um objeto de classe dinamicamente usando a metaclasse apropriada.

Os três primeiros argumentos são os componentes que compõem um cabeçalho de definição de classe: o nome da classe, as classes base (em ordem), os argumentos nomeados (como @code{metaclass}).

O argumento `exec_body' é um retorno de chamada usado para preencher o espaço para nome da classe recém-criado. Ele deve aceitar o espaço para nome da classe como seu único argumento e atualizar o espaço para nome diretamente com o conteúdo da classe. Se nenhum retorno de chamada for fornecido, ele terá o mesmo efeito que passar em @code{lambda ns: None}.


Adicionado na versão 3.3.

@end deffn

@geindex prepare_class() (no módulo types)
@anchor{library/types types prepare_class}@anchor{11a1}
@deffn {Função} types.prepare_class (name, bases=(), kwds=None)

Calcula a metaclasse apropriada e cria o espaço de nomes da classe.

Os argumentos são os componentes que compõem um cabeçalho de definição de classe: o nome da classe, as classes base (em ordem) e os argumentos nomeados (como @code{metaclass}).

O valor de retorno é uma tupla de 3: @code{metaclass, namespace, kwds}

`metaclass' é a metaclasse apropriada, `namespace' é o espaço de nomes da classe preparada e `kwds' é uma cópia atualizada do argumento passado no `kwds' com qualquer entrada @code{'metaclass'} removida. Se nenhum argumento `kwds' for passado, este será um ditado vazio.


Adicionado na versão 3.3.



Alterado na versão 3.6: O valor padrão para o elemento @code{namespace} da tupla retornada foi alterado. Agora, um mapeamento preservando-ordem-inserção é usado quando a metaclasse não possui um método @code{__prepare__}.

@end deffn


@subsubheading Ver também



@table @asis

@item @ref{2100,,Metaclasses}

Detalhes completos do processo de criação de classe suportado por essas funções

@geindex Propostas de Melhorias do Python; PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Metaclasses no Python 3000

Introduzido o gancho de espaço de nomes @code{__prepare__}
@end table


@geindex resolve_bases() (no módulo types)
@anchor{library/types types resolve_bases}@anchor{bb4}
@deffn {Função} types.resolve_bases (bases)

Resolve entradas MRO dinamicamente, conforme especificado pela 
@geindex Propostas de Melhorias do Python; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}.

Esta função procura por itens em `bases' que não sejam instâncias de @ref{d6b,,type} e retorna uma tupla onde cada objeto que possui um método @ref{afc,,__mro_entries__()} é substituído por um resultado desempacotado da chamada desse método. Se um item `bases' é uma instância de @ref{d6b,,type}, ou não possui o método @code{__mro_entries__()}, ele é incluído na tupla de retorno inalterada.


Adicionado na versão 3.7.

@end deffn

@geindex get_original_bases() (no módulo types)
@anchor{library/types types get_original_bases}@anchor{4ce}
@deffn {Função} types.get_original_bases (cls, /)

Retorna a tupla de objetos originalmente dados como as bases de `cls' antes do método @ref{afc,,__mro_entries__()} ter sido chamado em qualquer base (seguindo os mecanismos apresentados na 
@geindex Propostas de Melhorias do Python; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}). Isso é útil para introspecção de @ref{4cf,,Generics}.

Para classes que possuem um atributo @code{__orig_bases__}, esta função retorna o valor de @code{cls.__orig_bases__}. Para classes sem o atributo @code{__orig_bases__}, @ref{14f4,,cls.__bases__} é retornado.

Exemplos:

@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


Adicionado na versão 3.12.

@end deffn


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/} - Suporte básico para módulo typing e tipos genéricos


@node Tipos padrão do interpretador,Classes e funções de utilidades adicionais,Criação de tipos dinâmicos,types — Criação de tipos dinâmicos e nomes para tipos embutidos
@anchor{library/types standard-interpreter-types}@anchor{2715}
@subsubsection Tipos padrão do interpretador


Este módulo fornece nomes para muitos dos tipos necessários para implementar um interpretador Python. Evita deliberadamente incluir alguns dos tipos que surgem apenas incidentalmente durante o processamento, como o tipo @code{listiterator}.

O uso típico desses nomes é para verificações @ref{442,,isinstance()} ou @ref{7c2,,issubclass()}.

Se você instanciar algum desses tipos, observe que as assinaturas podem variar entre as versões do Python.

Os nomes padrão são definidos para os seguintes tipos:

@geindex NoneType (no módulo types)
@anchor{library/types types NoneType}@anchor{855}
@deffn {Dado} types.NoneType

O tipo de @ref{675,,None}.


Adicionado na versão 3.10.

@end deffn

@geindex FunctionType (no módulo types)
@geindex LambdaType (no módulo types)
@anchor{library/types types FunctionType}@anchor{887}
@deffn {Dado} types.FunctionType
@anchor{library/types types LambdaType}@anchor{2716}
@deffnx {Dado} types.LambdaType

O tipo de funções definidas pelo usuário e funções criadas por expressões @ref{12df,,lambda}.

Levanta um @ref{19fa,,evento de auditoria} @code{function.__new__} com o argumento @code{code}.

O evento de auditoria ocorre apenas para instanciação direta de objetos de função e não é levantado para compilação normal.
@end deffn

@geindex GeneratorType (no módulo types)
@anchor{library/types types GeneratorType}@anchor{1721}
@deffn {Dado} types.GeneratorType

O tipo de objetos de iterador @ref{109a,,gerador}, criados pelas funções de gerador.
@end deffn

@geindex CoroutineType (no módulo types)
@anchor{library/types types CoroutineType}@anchor{eb8}
@deffn {Dado} types.CoroutineType

O tipo de objetos de @ref{491,,corrotina}, criado por funções de @ref{5d1,,async def}.


Adicionado na versão 3.5.

@end deffn

@geindex AsyncGeneratorType (no módulo types)
@anchor{library/types types AsyncGeneratorType}@anchor{2717}
@deffn {Dado} types.AsyncGeneratorType

O tipo de objetos de iterador @ref{21cf,,gerador assíncrono}, criados pelas funções do gerador assíncrono.


Adicionado na versão 3.6.

@end deffn

@geindex CodeType (classe em types)
@anchor{library/types types CodeType}@anchor{2df}
@deffn {Classe} types.CodeType (**kwargs)

@geindex função embutida;compile

O tipo de @ref{1d2,,objetos código} retornados por @ref{192,,compile()}.

Levanta um @code{code.__new__} de @ref{19fa,,evento de auditoria} com os argumentos @code{code}, @code{filename}, @code{name}, @code{argcount}, @code{posonlyargcount}, @code{kwonlyargcount}, @code{nlocals}, @code{stacksize}, @code{flags}.

Observe que os argumentos auditados podem não corresponder aos nomes ou posições exigidos pelo inicializador. O evento de auditoria ocorre apenas para instanciação direta de objetos de código e não é levantado para compilação normal.
@end deffn

@geindex CellType (no módulo types)
@anchor{library/types types CellType}@anchor{2718}
@deffn {Dado} types.CellType

O tipo para objetos de célula: tais objetos são usados como contêineres para as @ref{20d1,,variáveis de clausura} de uma função.


Adicionado na versão 3.8.

@end deffn

@geindex MethodType (no módulo types)
@anchor{library/types types MethodType}@anchor{190e}
@deffn {Dado} types.MethodType

O tipo de método de instâncias de classe definidas pelo usuário.
@end deffn

@geindex BuiltinFunctionType (no módulo types)
@geindex BuiltinMethodType (no módulo types)
@anchor{library/types types BuiltinFunctionType}@anchor{2719}
@deffn {Dado} types.BuiltinFunctionType
@anchor{library/types types BuiltinMethodType}@anchor{271a}
@deffnx {Dado} types.BuiltinMethodType

O tipo de funções embutidas como @ref{62e,,len()} ou @ref{138e,,sys.exit()}, e métodos de classes embutidas. (Aqui, o termo “embutidas” significa “escrito em C”.)
@end deffn

@geindex WrapperDescriptorType (no módulo types)
@anchor{library/types types WrapperDescriptorType}@anchor{bb1}
@deffn {Dado} types.WrapperDescriptorType

O tipo de método de alguns tipos de dados embutidos e classes base, como @ref{6b0,,object.__init__()} ou @ref{12e2,,object.__lt__()}.


Adicionado na versão 3.7.

@end deffn

@geindex MethodWrapperType (no módulo types)
@anchor{library/types types MethodWrapperType}@anchor{64b}
@deffn {Dado} types.MethodWrapperType

O tipo de métodos `vinculados' de alguns tipos de dados embutidos e classes base. Por exemplo, é o tipo de @code{object().__str__}.


Adicionado na versão 3.7.

@end deffn

@geindex NotImplementedType (no módulo types)
@anchor{library/types types NotImplementedType}@anchor{856}
@deffn {Dado} types.NotImplementedType

O tipo de @ref{7d3,,NotImplemented}.


Adicionado na versão 3.10.

@end deffn

@geindex MethodDescriptorType (no módulo types)
@anchor{library/types types MethodDescriptorType}@anchor{bb2}
@deffn {Dado} types.MethodDescriptorType

O tipo de método de alguns tipos de dados embutidos, como @ref{2340,,str.join()}.


Adicionado na versão 3.7.

@end deffn

@geindex ClassMethodDescriptorType (no módulo types)
@anchor{library/types types ClassMethodDescriptorType}@anchor{bb3}
@deffn {Dado} types.ClassMethodDescriptorType

O tipo de métodos de classe `não vinculados' de alguns tipos de dados embutidos, como @code{dict.__dict__['fromkeys']}.


Adicionado na versão 3.7.

@end deffn

@geindex ModuleType (classe em types)
@anchor{library/types types ModuleType}@anchor{e3f}
@deffn {Classe} types.ModuleType (name, doc=None)

O tipo de @ref{1755,,módulos}. O construtor aceita o nome do módulo a ser criado e, opcionalmente, seu @ref{22bd,,docstring}.


@subsubheading Ver também



@table @asis

@item @ref{20a1,,Documentação em objetos de módulo}

Fornece detalhes sobre os atributos especiais que podem ser encontrados em instâncias de @code{ModuleType}.

@item @ref{e3e,,importlib.util.module_from_spec()}

Módulos criados usando o construtor @code{ModuleType} são criados com muitos de seus atributos especiais não definidos ou definidos com valores padrão. @code{module_from_spec()} fornece uma maneira mais robusta de criar instâncias @code{ModuleType}, o que garante que os vários atributos sejam definidos adequadamente.
@end table

@end deffn

@geindex EllipsisType (no módulo types)
@anchor{library/types types EllipsisType}@anchor{854}
@deffn {Dado} types.EllipsisType

O tipo de @ref{231c,,Ellipsis}.


Adicionado na versão 3.10.

@end deffn

@geindex GenericAlias (classe em types)
@anchor{library/types types GenericAlias}@anchor{7ed}
@deffn {Classe} types.GenericAlias (t_origin, t_args)

O tipo dos @ref{6b2,,genéricos parametrizados} como @code{list[int]}.

@code{t_origin} deve ser uma classe genérica não parametrizada, como @code{list}, @code{tuple} ou @code{dict}.  @code{t_args} deve ser uma @ref{370,,tuple} (possivelmente com comprimento 1) de tipos que parametrizam @code{t_origin}:

@example
>>> from types import GenericAlias

>>> list[int] == GenericAlias(list, (int,))
True
>>> dict[str, int] == GenericAlias(dict, (str, int))
True
@end example


Adicionado na versão 3.9.



Alterado na versão 3.9.2: Este tipo pode agora ter uma subclasse.



@subsubheading Ver também



@table @asis

@item @ref{6b2,,Tipos Generic Alias}

Documentação detalhada sobre instâncias de @code{types.GenericAlias}

@geindex Propostas de Melhorias do Python; PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - Sugestão de tipo para Genéricos em coleções padrão

Apresentação da classe @code{types.GenericAlias}
@end table

@end deffn

@geindex UnionType (classe em types)
@anchor{library/types types UnionType}@anchor{63a}
@deffn {Classe} types.UnionType

The type of @ref{7c3,,union type expressions}.


Adicionado na versão 3.10.

@end deffn

@geindex TracebackType (classe em types)
@anchor{library/types types TracebackType}@anchor{b05}
@deffn {Classe} types.TracebackType (tb_next, tb_frame, tb_lasti, tb_lineno)

O tipo de objetos traceback, como encontrados em @code{sys.exception().__traceback__}.

Veja @ref{b07,,a referência de linguagem} para detalhes dos atributos e operações disponíveis, e orientação sobre como criar tracebacks dinamicamente.
@end deffn

@geindex FrameType (no módulo types)
@anchor{library/types types FrameType}@anchor{1977}
@deffn {Dado} types.FrameType

O tipo de @ref{6e0,,objetos de quadro} como encontrado em @ref{20e4,,tb.tb_frame} se @code{tb} é um objeto traceback.
@end deffn

@geindex GetSetDescriptorType (no módulo types)
@anchor{library/types types GetSetDescriptorType}@anchor{271b}
@deffn {Dado} types.GetSetDescriptorType

O tipo de objetos definidos em módulos de extensão com @code{PyGetSetDef}, como @ref{182,,FrameType.f_locals} ou @code{array.array.typecode}. Este tipo é usado como descritor para atributos de objeto; tem o mesmo propósito que o tipo @ref{194,,property}, mas para classes definidas em módulos de extensão.
@end deffn

@geindex MemberDescriptorType (no módulo types)
@anchor{library/types types MemberDescriptorType}@anchor{271c}
@deffn {Dado} types.MemberDescriptorType

O tipo de objetos definidos em módulos de extensão com @code{PyMemberDef}, como @code{datetime.timedelta.days}. Este tipo é usado como descritor para membros de dados C simples que usam funções de conversão padrão; tem o mesmo propósito que o tipo @ref{194,,property}, mas para classes definidas em módulos de extensão.

Além disso, quando uma classe é definida com um atributo @ref{1533,,__slots__}, então para cada atributo, uma instância de @code{MemberDescriptorType} será adicionada como um atributo na classe. Isso permite que o atributo apareça no @ref{c78,,__dict__} da classe.

Em outras implementações de Python, este tipo pode ser idêntico a @code{GetSetDescriptorType}.
@end deffn

@geindex MappingProxyType (classe em types)
@anchor{library/types types MappingProxyType}@anchor{46d}
@deffn {Classe} types.MappingProxyType (mapping)

Proxy somente leitura de um mapeamento. Ele fornece uma visão dinâmica das entradas do mapeamento, o que significa que quando o mapeamento muda, a visão reflete essas mudanças.


Adicionado na versão 3.3.



Alterado na versão 3.9: Atualizado para ter suporte ao novo operador de união (@code{|}) da 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}, que simplesmente delega para o mapeamento subjacente.



@deffn {Describe} key in proxy

Retorna @code{True} se o mapeamento subjacente tiver uma chave `key', senão @code{False}.
@end deffn


@deffn {Describe} proxy[key]

Retorna e o item do mapeamento subjacente com a chave `key'. Levanta um @ref{344,,KeyError} se `key' não estiver no mapeamento subjacente.
@end deffn


@deffn {Describe} iter(proxy)

Retorna um iterador sobre as chaves do mapeamento subjacente. Este é um atalho para @code{iter(proxy.keys())}.
@end deffn


@deffn {Describe} len(proxy)

Retorna o número de itens no mapeamento subjacente.
@end deffn

@geindex copy() (método types.MappingProxyType)
@anchor{library/types types MappingProxyType copy}@anchor{271d}
@deffn {Método} copy ()

Retorna uma cópia rasa do mapeamento subjacente.
@end deffn

@geindex get() (método types.MappingProxyType)
@anchor{library/types types MappingProxyType get}@anchor{271e}
@deffn {Método} get (key[, default])

Retorna o valor para `key' se `key' estiver no mapeamento subjacente, caso contrário, `default'. Se `default' não for fornecido, o padrão é @code{None}, de forma que este método nunca levante uma @ref{344,,KeyError}.
@end deffn

@geindex items() (método types.MappingProxyType)
@anchor{library/types types MappingProxyType items}@anchor{271f}
@deffn {Método} items ()

Retorna uma nova visão dos itens do mapeamento subjacente (pares @code{(chave, valor)}).
@end deffn

@geindex keys() (método types.MappingProxyType)
@anchor{library/types types MappingProxyType keys}@anchor{2720}
@deffn {Método} keys ()

Retorna uma nova visão das chaves do mapeamento subjacente.
@end deffn

@geindex values() (método types.MappingProxyType)
@anchor{library/types types MappingProxyType values}@anchor{2721}
@deffn {Método} values ()

Retorna uma nova visão dos valores do mapeamento subjacente.
@end deffn


@deffn {Describe} reversed(proxy)

Retorna um iterador reverso sobre as chaves do mapeamento subjacente.


Adicionado na versão 3.9.

@end deffn


@deffn {Describe} hash(proxy)

Retorna um hash do mapeamento subjacente.


Adicionado na versão 3.12.

@end deffn
@end deffn

@geindex CapsuleType (classe em types)
@anchor{library/types types CapsuleType}@anchor{2722}
@deffn {Classe} types.CapsuleType

O tipo de @ref{2723,,objetos cápsula}.


Adicionado na versão 3.13.

@end deffn

@node Classes e funções de utilidades adicionais,Funções de utilidade de corrotina,Tipos padrão do interpretador,types — Criação de tipos dinâmicos e nomes para tipos embutidos
@anchor{library/types additional-utility-classes-and-functions}@anchor{2724}
@subsubsection Classes e funções de utilidades adicionais


@geindex SimpleNamespace (classe em types)
@anchor{library/types types SimpleNamespace}@anchor{1d1}
@deffn {Classe} types.SimpleNamespace

Uma subclasse @ref{a96,,object} simples que fornece acesso de atributo ao seu espaço de nomes, bem como um repr significativo.

Ao contrário de @ref{a96,,object}, com @code{SimpleNamespace} você pode adicionar e remover atributos.

Objetos @ref{1d1,,SimpleNamespace} podem ser inicializados da mesma forma que @ref{256,,dict}: ou com argumentos nomeados, com um único argumento posicional, ou com ambos. Quando inicializados com argumentos nomeados, eles são adicionados diretamente ao espaço de nomes subjacente. Alternativamente, quando inicializado com um argumento posicional, o espaço de nomes subjacente será atualizado com pares de valores-chave desse argumento (um objeto mapeamento ou um objeto @ref{1268,,iterável} produzindo pares de valores-chave). Todas essas chaves devem ser strings.

O tipo é aproximadamente equivalente ao seguinte código:

@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} pode ser útil como um substituto para @code{class NS: pass}. No entanto, para um tipo de registro estruturado, use @ref{1ca,,namedtuple()}.

Objetos @code{SimpleNamespace} são suportados por @ref{151,,copy.replace()}.


Adicionado na versão 3.3.



Alterado na versão 3.9: A ordem dos atributos no repr mudou de alfabética para inserção (como no @code{dict}).



Alterado na versão 3.13: Adicionado suporte para um argumento posicional opcional.

@end deffn

@geindex DynamicClassAttribute() (no módulo types)
@anchor{library/types types DynamicClassAttribute}@anchor{62a}
@deffn {Função} types.DynamicClassAttribute (fget=None, fset=None, fdel=None, doc=None)

Roteia o acesso ao atributo em uma classe para __getattr__.

Este é um descritor, usado para definir atributos que atuam de forma diferente quando acessados por meio de uma instância e por meio de uma classe. O acesso à instância permanece normal, mas o acesso a um atributo por meio de uma classe será roteado para o método __getattr__ da classe; isso é feito levantando AttributeError.

Isso permite ter propriedades ativas em uma instância, e ter atributos virtuais na classe com o mesmo nome (veja @ref{630,,enum.Enum} para um exemplo).


Adicionado na versão 3.4.

@end deffn

@node Funções de utilidade de corrotina,,Classes e funções de utilidades adicionais,types — Criação de tipos dinâmicos e nomes para tipos embutidos
@anchor{library/types coroutine-utility-functions}@anchor{2725}
@subsubsection Funções de utilidade de corrotina


@geindex coroutine() (no módulo types)
@anchor{library/types types coroutine}@anchor{eb7}
@deffn {Função} types.coroutine (gen_func)

Esta função transforma uma função @ref{109a,,geradora} em uma @ref{d9b,,função de corrotina} que retorna uma corrotina baseada em gerador. A corrotina baseada em gerador ainda é um @ref{bf9,,iterador gerador}, mas também é considerada um objeto @ref{491,,corrotina} e é @ref{1ad,,aguardável}. No entanto, pode não necessariamente implementar o método @ref{d9d,,__await__()}.

Se `gen_func' for uma função geradora, ela será modificada no local.

Se `gen_func' não for uma função geradora, ela será envolta. Se ele retornar uma instância de @code{Collections.abc.Generator}, a instância será envolvida em um objeto proxy `aguardável'. Todos os outros tipos de objetos serão retornados como estão.


Adicionado na versão 3.5.

@end deffn

@node copy — Operações de cópia profunda e cópia rasa,pprint — Impressão bonita de dados,types — Criação de tipos dinâmicos e nomes para tipos embutidos,Tipos de Dados
@anchor{library/copy doc}@anchor{2726}@anchor{library/copy copy-shallow-and-deep-copy-operations}@anchor{2727}@anchor{library/copy module-copy}@anchor{25}@anchor{library/copy translation-repo}@anchor{2728}
@subsection @code{copy} — Operações de cópia profunda e cópia rasa


@geindex module; copy

`Código-fonte:' Lib/copy.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/copy.py}


__________________________________________________________________


As instruções de atribuição no Python não copiam objetos; elas criam ligações entre um destino e um objeto. Para coleções mutáveis ou que contêm itens mutáveis, às vezes é necessária uma cópia para que seja possível alterar uma sem alterar a outra. Este módulo fornece operações genéricas de cópia profunda e rasa (explicadas abaixo).

Resumo da interface:

@geindex copy() (no módulo copy)
@anchor{library/copy copy copy}@anchor{534}
@deffn {Função} copy.copy (obj)

Retorna uma cópia rasa de `obj'.
@end deffn

@geindex deepcopy() (no módulo copy)
@anchor{library/copy copy deepcopy}@anchor{b84}
@deffn {Função} copy.deepcopy (obj[, memo])

Retorna uma cópia profunda  de `obj'.
@end deffn

@geindex replace() (no módulo copy)
@anchor{library/copy copy replace}@anchor{151}
@deffn {Função} copy.replace (obj, /, **changes)

Cria um novo objeto do mesmo tipo que `obj', substituindo os campos pelos valores de `changes'.


Adicionado na versão 3.13.

@end deffn

@geindex Error
@anchor{library/copy copy Error}@anchor{2729}
@deffn {Exceção} copy.Error

Levantada para erros específicos do módulo.
@end deffn
@anchor{library/copy shallow-vs-deep-copy}@anchor{1d7f}
A diferença entre cópia profunda e rasa é relevante apenas para objetos compostos (objetos que contêm outros objetos, como listas ou instâncias de classe):


@itemize *

@item 
Uma `cópia rasa' constrói um novo objeto composto e, na medida do possível, insere nele `referências' aos objetos encontrados no original.

@item 
Uma `cópia profunda' constrói um novo objeto composto e então, recursivamente, insere nele `cópias' dos objetos encontrados no original.
@end itemize

Frequentemente, existem dois problemas com operações de cópia profunda que não existem com operações de cópia rasa:


@itemize *

@item 
Objetos recursivos (objetos compostos que, direta ou indiretamente, contêm uma referência a si mesmos) podem causar um laço recursivo.

@item 
Como a cópia profunda copia tudo, ela pode copiar muito, incluindo dados que devem ser compartilhados entre as cópias.
@end itemize

A função @ref{b84,,deepcopy()} evita esses problemas:


@itemize *

@item 
mantendo um dicionário @code{memo} de objetos já copiados durante a passagem de cópia atual; e

@item 
permitindo que as classes definidas pelo usuário substituam a operação de cópia ou o conjunto de componentes copiados.
@end itemize

Este módulo não copia tipos como módulo, método, stack trace (situação da pilha de execução), quadro de empilhamento, arquivo, soquete, janela ou outros tipos semelhantes. Ele “copia” funções e classes (rasas e profundamente), devolvendo o objeto original inalterado; isso é compatível com a maneira como estes itens são tratados pelo módulo @ref{a6,,pickle}.

Cópias rasas de dicionários podem ser feitas usando @ref{be9,,dict.copy()}, e de listas, atribuindo uma fatia de toda a lista, por exemplo: @code{lista_copiada = lista_original[:]}.

@geindex módulo;pickle

As classes podem usar as mesmas interfaces para controlar a cópia que usam para controlar a serialização com pickle. Veja a descrição do módulo @ref{a6,,pickle} para obter informações sobre esses métodos. Na verdade, o módulo @ref{25,,copy} usa as funções pickle registradas do módulo @ref{26,,copyreg}.

@geindex __copy__() (protocolo de cópia)
@geindex __deepcopy__() (protocolo de cópia)

Para que uma classe defina sua própria implementação de cópia, ela pode definir métodos especiais @ref{15fc,,__copy__()} e @ref{15fd,,__deepcopy__()}.

@anchor{library/copy object __copy__}@anchor{15fc}
@deffn {Método} object.__copy__ (self)

Chamado para implementar a operação de cópia rasa; não é fornecido nenhum argumento adicional.
@end deffn

@anchor{library/copy object __deepcopy__}@anchor{15fd}
@deffn {Método} object.__deepcopy__ (self, memo)

Chamado para implementar a operação de cópia profunda; é passado um argumento, o dicionário `memo'. Se a implementação @code{__deepcopy__} precisar fazer uma cópia profunda de um componente, ela deve chamar a função @ref{b84,,deepcopy()} com o componente como primeiro argumento e o dicionário `memo' como segundo argumento. O dicionário `memo' deve ser tratado como um objeto opaco.
@end deffn

@geindex __replace__() (protocolo de substituição)

A função @code{copy.replace()} é mais limitada que @ref{534,,copy()} e @ref{b84,,deepcopy()}, e tem suporte apenas a tuplas nomeadas criadas por @ref{1ca,,namedtuple()}, @ref{2f,,dataclasses} e outras classes que definem o método @ref{152,,__replace__()}.

@anchor{library/copy object __replace__}@anchor{152}
@deffn {Método} object.__replace__ (self, /, **changes)

Este método deve criar um novo objeto do mesmo tipo, substituindo os campos pelos valores de `changes'.


Adicionado na versão 3.13.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{a6,,pickle}

Discussão dos métodos especiais usados para dar suporte à recuperação e à restauração do estado do objeto.
@end table


@node pprint — Impressão bonita de dados,reprlib — Implementação alternativa à repr,copy — Operações de cópia profunda e cópia rasa,Tipos de Dados
@anchor{library/pprint doc}@anchor{272a}@anchor{library/pprint module-pprint}@anchor{ae}@anchor{library/pprint pprint-data-pretty-printer}@anchor{272b}@anchor{library/pprint translation-repo}@anchor{272c}
@subsection @code{pprint} — Impressão bonita de dados


@geindex module; pprint

`Código-fonte:' Lib/pprint.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pprint.py}


__________________________________________________________________


O módulo @ref{ae,,pprint} fornece a capacidade de “imprimir de forma bonita” estruturas de dados Python arbitrárias em um formato que pode ser usado como entrada para o interpretador. Se as estruturas formatadas incluírem objetos que não sejam tipos fundamentais do Python, a representação poderá não ser carregável. Este pode ser o caso se objetos como arquivos, soquetes ou classes forem incluídos, bem como muitos outros objetos que não são representáveis como literais do Python.

A representação formatada mantém os objetos em uma única linha, se possível, e os divide em múltiplas linhas se eles não couberem na largura permitida, ajustável pelo parâmetro `width' padrão para 80 caracteres.


Alterado na versão 3.9: Adicionado suporte para impressão bonita de @ref{1d1,,types.SimpleNamespace}.



Alterado na versão 3.10: Adicionado suporte para impressão bonita de @ref{1cb,,dataclasses.dataclass}.


@menu
* Funções: Funções<4>. 
* Objetos PrettyPrinter:: 
* Exemplo: Exemplo<3>. 

@end menu

@node Funções<4>,Objetos PrettyPrinter,,pprint — Impressão bonita de dados
@anchor{library/pprint functions}@anchor{272d}@anchor{library/pprint pprint-functions}@anchor{272e}
@subsubsection Funções


@geindex pp() (no módulo pprint)
@anchor{library/pprint pprint pp}@anchor{a2d}
@deffn {Função} pprint.pp (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=False, underscore_numbers=False)

Imprime a representação formatada de `object', seguida por uma nova linha. Esta função pode ser usado no interpretador interativo em vez da função @ref{fa9,,print()} para inspecionar valores. Dica: você pode reatribuir @code{print = pprint.pp} para uso dentro de um escopo.

@*Parâmetros: 

@itemize *

@item 
@code{object} – O objeto a ser impresso.

@item 
@code{stream} (@ref{15cf,,file-like object} | None) – Um objeto arquivo ou similar no qual a saída será gravada chamando seu método @code{write()}. Se @code{None} (o padrão), @ref{ae6,,sys.stdout} será usado.

@item 
@code{indent} (@ref{257,,int}) – A quantidade de indentação adicionado para cada nível de aninhamento.

@item 
@code{width} (@ref{257,,int}) – O número máximo desejado de caracteres por linha na saída. Se uma estrutura não puder ser formatada dentro da restrição de largura, será feito o melhor esforço.

@item 
@code{depth} (@ref{257,,int}@code{ | }@code{None}) – O número de níveis de aninhamento que podem ser impressos. Se a estrutura de dados que está sendo impressa for muito profunda, o próximo nível contido será substituído por @code{...}. Se @code{None} (o padrão), não há restrição na profundidade dos objetos que estão sendo formatados.

@item 
@code{compact} (@ref{468,,bool}) – Controla a forma como @ref{4f1,,sequências} são formatadas. Se @code{False} (o padrão), cada item de uma sequência será formatado em uma linha separada, caso contrário, tantos itens quantos couberem na `largura' serão formatados em cada linha de saída.

@item 
@code{sort_dicts} (@ref{468,,bool}) – Se @code{True}, os dicionários serão formatados com suas chaves classificadas, caso contrário, serão exibidos na ordem de inserção (o padrão).

@item 
@code{underscore_numbers} (@ref{468,,bool}) – Se @code{True}, os números inteiros serão formatados com o caractere @code{_} para um separador de milhares, caso contrário, os sublinhados não serão exibidos (o padrão).
@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


Adicionado na versão 3.8.

@end deffn

@geindex pprint() (no módulo pprint)
@anchor{library/pprint pprint pprint}@anchor{82b}
@deffn {Função} pprint.pprint (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Apelido para @ref{a2d,,pp()} com `sort_dicts' definido como @code{True} por padrão, o que classificaria automaticamente as chaves dos dicionários, você pode querer usar @ref{a2d,,pp()} em vez disso, onde é @code{False} por padrão.
@end deffn

@geindex pformat() (no módulo pprint)
@anchor{library/pprint pprint pformat}@anchor{fb4}
@deffn {Função} pprint.pformat (object, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Retorna a representação formatada de `object' como uma string. `indent', `width', `depth', `compact', `sort_dicts' e `underscore_numbers' são passados para o construtor de @ref{fb3,,PrettyPrinter} como parâmetros de formatação e seus significados são descritos na documentação acima.
@end deffn

@geindex isreadable() (no módulo pprint)
@anchor{library/pprint pprint isreadable}@anchor{272f}
@deffn {Função} pprint.isreadable (object)

@geindex função embutida;eval

Determina se a representação formatada de `object' é “legível” ou pode ser usada para reconstruir o valor usando @ref{180,,eval()}. Isso sempre retorna @code{False} para objetos recursivos.

@example
>>> pprint.isreadable(stuff)
False
@end example
@end deffn

@geindex isrecursive() (no módulo pprint)
@anchor{library/pprint pprint isrecursive}@anchor{2730}
@deffn {Função} pprint.isrecursive (object)

Determina se `object' requer uma representação recursiva. Esta função está sujeita às mesmas limitações mencionadas em @ref{2731,,saferepr()} abaixo e pode levantar uma exceção @ref{d90,,RecursionError} se falhar em detectar um objeto recursivo.
@end deffn

@geindex saferepr() (no módulo pprint)
@anchor{library/pprint pprint saferepr}@anchor{2731}
@deffn {Função} pprint.saferepr (object)

Retorna uma representação de string de `object', protegida contra recursão em algumas estruturas de dados comuns, nomeadamente instâncias de @ref{256,,dict}, @ref{611,,list} e @ref{370,,tuple} ou subclasses cujo @code{__repr__} não foi substituído. Se a representação do objeto expõe uma entrada recursiva, a referência recursiva será representada como @code{<Recursion on typename with id=number>}. A representação não é formatada de outra forma.

@example
>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"
@end example
@end deffn

@node Objetos PrettyPrinter,Exemplo<3>,Funções<4>,pprint — Impressão bonita de dados
@anchor{library/pprint id1}@anchor{2732}@anchor{library/pprint prettyprinter-objects}@anchor{2733}
@subsubsection Objetos PrettyPrinter


@geindex ...;espaço reservado

@geindex PrettyPrinter (classe em pprint)
@anchor{library/pprint pprint PrettyPrinter}@anchor{fb3}
@deffn {Classe} pprint.PrettyPrinter (indent=1, width=80, depth=None, stream=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

Constrói uma instância @ref{fb3,,PrettyPrinter}.

Os argumentos têm o mesmo significado que para @ref{a2d,,pp()}. Observe que eles estão em uma ordem diferente e que o padrão `sort_dicts' é @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


Alterado na versão 3.4: Adicionado o parâmetro `compact'.



Alterado na versão 3.8: Adicionado o parâmetro `sort_dicts'.



Alterado na versão 3.10: Adicionado o parâmetro `underscore_numbers'.



Alterado na versão 3.11: Não tenta mais escrever em @code{sys.stdout} se for @code{None}.

@end deffn

Instâncias @ref{fb3,,PrettyPrinter} contêm os seguintes métodos:

@geindex pformat() (método pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter pformat}@anchor{2734}
@deffn {Método} PrettyPrinter.pformat (object)

Retorna a representação formatada de `object'. Isso leva em consideração as opções passadas para o construtor @ref{fb3,,PrettyPrinter}.
@end deffn

@geindex pprint() (método pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter pprint}@anchor{2735}
@deffn {Método} PrettyPrinter.pprint (object)

Exibe a representação formatada de `object' no fluxo configurado, seguida por uma nova linha.
@end deffn

Os métodos a seguir fornecem as implementações para as funções correspondentes com os mesmos nomes. Usar esses métodos em uma instância é um pouco mais eficiente já que novos objetos @ref{fb3,,PrettyPrinter} não precisam ser criados.

@geindex isreadable() (método pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter isreadable}@anchor{2736}
@deffn {Método} PrettyPrinter.isreadable (object)

@geindex função embutida;eval

Determina se a representação formatada do objeto é “legível” ou pode ser usada para reconstruir o valor usando @ref{180,,eval()}. Observe que isso retorna @code{False} para objetos recursivos. Se o parâmetro `depth' de @ref{fb3,,PrettyPrinter} estiver definido e o objeto for mais profundo que o permitido, isso retornará @code{False}.
@end deffn

@geindex isrecursive() (método pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter isrecursive}@anchor{2737}
@deffn {Método} PrettyPrinter.isrecursive (object)

Determina se o objeto requer uma representação recursiva.
@end deffn

Este método é fornecido como um gancho para permitir que as subclasses modifiquem a maneira como os objetos são convertidos em strings.  A implementação padrão usa os componentes internos da implementação de @ref{2731,,saferepr()}.

@geindex format() (método pprint.PrettyPrinter)
@anchor{library/pprint pprint PrettyPrinter format}@anchor{1a74}
@deffn {Método} PrettyPrinter.format (object, context, maxlevels, level)

Retorna três valores: a versão formatada de `object' como uma string, um sinalizador indicando se o resultado é legível e um sinalizador indicando se a recursão foi detectada.  O primeiro argumento é o objeto a ser apresentado.  O segundo é um dicionário que contém o @ref{146a,,id()} de objetos que fazem parte do contexto de apresentação atual (contêineres diretos e indiretos para `objects' que estão afetando a apresentação) como chaves; se for necessário apresentar um objeto que já esteja representado em `context', o terceiro valor de retorno deverá ser @code{True}.  Chamadas recursivas ao método @ref{1a74,,format()} devem adicionar entradas adicionais para contêineres neste dicionário.  O terceiro argumento, `maxlevels', fornece o limite solicitado para recursão;  será @code{0} se não houver limite solicitado.  Este argumento deve ser passado sem modificações para chamadas recursivas. O quarto argumento, `level', fornece o nível atual; chamadas recursivas devem receber um valor menor que o da chamada atual.
@end deffn

@node Exemplo<3>,,Objetos PrettyPrinter,pprint — Impressão bonita de dados
@anchor{library/pprint example}@anchor{2738}@anchor{library/pprint pprint-example}@anchor{2739}
@subsubsection Exemplo


Para demonstrar vários usos da função @ref{a2d,,pp()} e seus parâmetros, vamos buscar informações sobre um projeto no 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

Em sua forma básica, @ref{a2d,,pp()} mostra o objeto inteiro:

@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

O resultado pode ser limitado a uma certa `depth' (reticências são usadas para conteúdos mais 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

Além disso, a largura `width' máxima do caractere pode ser sugerida.  Se um objeto longo não puder ser dividido, a largura especificada será excedida:

@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 — Implementação alternativa à repr,enum — Suporte a enumerações,pprint — Impressão bonita de dados,Tipos de Dados
@anchor{library/reprlib doc}@anchor{273a}@anchor{library/reprlib module-reprlib}@anchor{bb}@anchor{library/reprlib reprlib-alternate-repr-implementation}@anchor{273b}@anchor{library/reprlib translation-repo}@anchor{273c}
@subsection @code{reprlib} — Implementação alternativa à @code{repr()}


@geindex module; reprlib

`Código-fonte:' Lib/reprlib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/reprlib.py}


__________________________________________________________________


O módulo @code{reprlib} fornece um meio de produzir representações de objetos com limites no tamanho das strings resultantes. Isso é usado no depurador Python e pode ser útil em outros contextos também.

Este módulo fornece uma classe, uma instância e uma função.

@geindex Repr (classe em reprlib)
@anchor{library/reprlib reprlib Repr}@anchor{273d}
@deffn {Classe} 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)

Classe que fornece serviços de formatação úteis na implementação de funções semelhantes à embutida @ref{800,,repr()}; limites de tamanho para diferentes tipos de objetos são adicionados para evitar a geração de representações excessivamente longas.

Os argumentos nomeados do construtor podem ser usados como um atalho para definir os atributos da instância de @ref{273d,,Repr}. O que significa que a inicialização a seguir:

@example
aRepr = reprlib.Repr(maxlevel=3)
@end example

É equivalente a:

@example
aRepr = reprlib.Repr()
aRepr.maxlevel = 3
@end example

Consulte a seção @ref{273e,,Objetos Repr} para obter mais informações sobre atributos @ref{273d,,Repr}.


Alterado na versão 3.12: Permite que atributos sejam definidos por meio de argumentos nomeados.

@end deffn

@geindex aRepr (no módulo reprlib)
@anchor{library/reprlib reprlib aRepr}@anchor{273f}
@deffn {Dado} reprlib.aRepr

Esta é uma instância de @ref{273d,,Repr} que é usada para fornecer a função @ref{2740,,repr()} descrita abaixo. Alterar os atributos deste objeto afetará os limites de tamanho usados por @ref{2740,,repr()} e pelo depurador Python.
@end deffn

@geindex repr() (no módulo reprlib)
@anchor{library/reprlib reprlib repr}@anchor{2740}
@deffn {Função} reprlib.repr (obj)

Este é o método @ref{2741,,repr()} de @code{aRepr}. Ele retorna uma string semelhante à retornada pela função embutida de mesmo nome, mas com limites na maioria dos tamanhos.
@end deffn

Além das ferramentas de limitação de tamanho, o módulo também fornece um decorador para detectar chamadas recursivas para @ref{61c,,__repr__()} e substituir uma string de espaço reservado.

@geindex ...;espaço reservado

@geindex recursive_repr() (no módulo reprlib)
@anchor{library/reprlib reprlib recursive_repr}@anchor{1233}
@deffn {Função} @@reprlib.recursive_repr (fillvalue='...')

Decorador para métodos @ref{61c,,__repr__()} para detectar chamadas recursivas dentro da mesma thread. Se uma chamada recursiva for feita, o `fillvalue' é retornado; caso contrário, a chamada usual @code{__repr__()} é feita. Por exemplo:

@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


Adicionado na versão 3.2.

@end deffn

@menu
* Objetos Repr:: 
* Estendendo objetos Repr:: 

@end menu

@node Objetos Repr,Estendendo objetos Repr,,reprlib — Implementação alternativa à repr
@anchor{library/reprlib id1}@anchor{273e}@anchor{library/reprlib repr-objects}@anchor{2742}
@subsubsection Objetos Repr


Instâncias @ref{273d,,Repr} fornecem vários atributos que podem ser usados para fornecer limites de tamanho para as representações de diferentes tipos de objetos e métodos que formatam tipos de objetos específicos.

@geindex fillvalue (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr fillvalue}@anchor{2743}
@deffn {Atributo} Repr.fillvalue

Esta string é exibida para referências recursivas. O padrão é @code{...}.


Adicionado na versão 3.11.

@end deffn

@geindex maxlevel (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxlevel}@anchor{2744}
@deffn {Atributo} Repr.maxlevel

Limite de profundidade na criação de representações recursivas. O padrão é @code{6}.
@end deffn

@geindex maxdict (atributo reprlib.Repr)
@geindex maxlist (atributo reprlib.Repr)
@geindex maxtuple (atributo reprlib.Repr)
@geindex maxset (atributo reprlib.Repr)
@geindex maxfrozenset (atributo reprlib.Repr)
@geindex maxdeque (atributo reprlib.Repr)
@geindex maxarray (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxdict}@anchor{2745}
@deffn {Atributo} Repr.maxdict
@anchor{library/reprlib reprlib Repr maxlist}@anchor{2746}
@deffnx {Atributo} Repr.maxlist
@anchor{library/reprlib reprlib Repr maxtuple}@anchor{2747}
@deffnx {Atributo} Repr.maxtuple
@anchor{library/reprlib reprlib Repr maxset}@anchor{2748}
@deffnx {Atributo} Repr.maxset
@anchor{library/reprlib reprlib Repr maxfrozenset}@anchor{2749}
@deffnx {Atributo} Repr.maxfrozenset
@anchor{library/reprlib reprlib Repr maxdeque}@anchor{274a}
@deffnx {Atributo} Repr.maxdeque
@anchor{library/reprlib reprlib Repr maxarray}@anchor{274b}
@deffnx {Atributo} Repr.maxarray

Limites no número de entradas representadas para o tipo de objeto nomeado. O padrão é @code{4} para @ref{2745,,maxdict}, @code{5} para @ref{274b,,maxarray} e @code{6} para os demais.
@end deffn

@geindex maxlong (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxlong}@anchor{274c}
@deffn {Atributo} Repr.maxlong

Número máximo de caracteres na representação para um inteiro. Os dígitos são omitidos a partir do meio. O padrão é @code{40}.
@end deffn

@geindex maxstring (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxstring}@anchor{274d}
@deffn {Atributo} Repr.maxstring

Limite no número de caracteres na representação da string. Observe que a representação “normal” da string é usada como fonte de caracteres: se sequências de escape forem necessárias na representação, elas poderão ser distorcidas quando a representação for encurtada. O padrão é @code{30}.
@end deffn

@geindex maxother (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr maxother}@anchor{274e}
@deffn {Atributo} Repr.maxother

Este limite é usado para controlar o tamanho de tipos de objetos para os quais nenhum método de formatação específico está disponível no objeto @ref{273d,,Repr}. Ele é aplicado de maneira semelhante a @ref{274d,,maxstring}. O padrão é @code{20}.
@end deffn

@geindex indent (atributo reprlib.Repr)
@anchor{library/reprlib reprlib Repr indent}@anchor{274f}
@deffn {Atributo} Repr.indent

Se este atributo for definido como @code{None} (o padrão), a saída será formatada sem quebras de linha ou recuo, como o padrão @ref{800,,repr()}. Por exemplo:

@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

Se @ref{274f,,indent} for definido como uma string, cada nível de recursão será colocado em sua própria linha, recuado por essa string:

@example
>>> aRepr.indent = '-->'
>>> print(aRepr.repr(example))
[
-->1,
-->'spam',
-->@{
-->-->'a': 2,
-->-->'b': 'spam eggs',
-->-->'c': @{
-->-->-->3: 4.5,
-->-->-->6: [],
-->-->@},
-->@},
-->'ham',
]
@end example

Definir @ref{274f,,indent} como um valor inteiro positivo se comporta como se fosse definido como uma string com esse número de espaços:

@example
>>> aRepr.indent = 4
>>> print(aRepr.repr(example))
[
    1,
    'spam',
    @{
        'a': 2,
        'b': 'spam eggs',
        'c': @{
            3: 4.5,
            6: [],
        @},
    @},
    'ham',
]
@end example


Adicionado na versão 3.12.

@end deffn

@geindex repr() (método reprlib.Repr)
@anchor{library/reprlib reprlib Repr repr}@anchor{2741}
@deffn {Método} Repr.repr (obj)

O equivalente ao @ref{800,,repr()} embutido que usa a formatação imposta pela instância.
@end deffn

@geindex repr1() (método reprlib.Repr)
@anchor{library/reprlib reprlib Repr repr1}@anchor{2750}
@deffn {Método} Repr.repr1 (obj, level)

Implementação recursiva usada por @ref{2741,,repr()}. Esta usa o tipo de `obj' para determinar qual método de formatação chamar, passando `obj' e `level'. Os métodos específicos de tipo devem chamar @ref{2750,,repr1()} para realizar a formatação recursiva, com @code{level - 1} para o valor de `level' na chamada recursiva.
@end deffn


@deffn {Método} Repr.repr_TYPE (obj, level)

Métodos de formatação para tipos específicos são implementados como métodos com um nome baseado no nome do tipo. No nome do método, `TYPE' é substituído por @code{'_'.join(type(obj).__name__.split())}. O despacho para esses métodos é tratado por @ref{2750,,repr1()}. Métodos específicos de tipo que precisam formatar um valor recursivamente devem chamar @code{self.repr1(subobj, level - 1)}.
@end deffn

@node Estendendo objetos Repr,,Objetos Repr,reprlib — Implementação alternativa à repr
@anchor{library/reprlib subclassing-repr-objects}@anchor{2751}@anchor{library/reprlib subclassing-reprs}@anchor{2752}
@subsubsection Estendendo objetos Repr


O uso de despacho dinâmico por @ref{2750,,Repr.repr1()} permite que subclasses de @ref{273d,,Repr} adicionem suporte para tipos de objetos embutidos adicionais ou modifiquem o tratamento de tipos já suportados. Este exemplo mostra como suporte especial para objetos arquivo pode ser adicionado:

@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))         # exibe '<stdin>'
@end example

@example
<stdin>
@end example

@node enum — Suporte a enumerações,graphlib — Funcionalidade para operar com estruturas do tipo grafo,reprlib — Implementação alternativa à repr,Tipos de Dados
@anchor{library/enum doc}@anchor{2753}@anchor{library/enum enum-support-for-enumerations}@anchor{2754}@anchor{library/enum module-enum}@anchor{56}@anchor{library/enum translation-repo}@anchor{2755}
@subsection @code{enum} — Suporte a enumerações


@geindex module; enum


Adicionado na versão 3.4.


`Código-fonte:' Lib/enum.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/enum.py}

@subsubheading Important



Esta página contêm informação de referência da API. Para tutorial e discussão de tópicos mais avançados, consulte


@itemize *

@item 
@ref{2756,,Tutorial básico}

@item 
@ref{2757,,Tutorial avançado}

@item 
@ref{2758,,Livro de receitas de enum}
@end itemize


__________________________________________________________________


Uma enumeração:


@itemize *

@item 
é um conjunto de nomes simbólicos (membros) vinculados a valores únicos

@item 
pode ser iterado para retornar seus membros canônicos (ou seja, não incluindo apelidos) na ordem de definição

@item 
usa a sintaxe `call' para retornar membros por valor

@item 
usa a sintaxe `index' para retornar membros por nome
@end itemize

As enumerações são criadas usando a sintaxe de @ref{131a,,class} ou usando a sintaxe de chamada de função:

@example
>>> from enum import Enum

>>> # sintaxe de classe
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3

>>> # sintaxe funcional
>>> Color = Enum('Color', [('RED', 1), ('GREEN', 2), ('BLUE', 3)])
@end example

Embora possamos usar a sintaxe @ref{131a,,class} para criar Enums, Enums não são classes Python normais. Veja @ref{2759,,Como Enums são diferentes?} para mais detalhes.

@cartouche
@quotation Nota 
Nomenclatura


@itemize -

@item 
A classe @code{Color} é uma `enumeração' (ou `enum')

@item 
Os atributos @code{Color.RED}, @code{Color.GREEN}, etc., são `membros de enumeração' (ou `membros') e são constantes funcionalmente.

@item 
Os membros enum têm `nomes' e `valores' (o nome de @code{Color.RED} é @code{RED}, o valor de @code{Color.BLUE} é @code{3}, etc.)
@end itemize
@end quotation
@end cartouche


__________________________________________________________________


@menu
* Conteúdo do módulo: Conteúdo do módulo<2>. 
* Tipos de Dados: Tipos de Dados<2>. 
* Utilities and Decorators:: 
* Notas:: 

@end menu

@node Conteúdo do módulo<2>,Tipos de Dados<2>,,enum — Suporte a enumerações
@anchor{library/enum module-contents}@anchor{275a}
@subsubsection Conteúdo do módulo


@quotation

@ref{1e5,,EnumType}

@quotation

O @code{type} para Enum e suas subclasses.
@end quotation

@ref{630,,Enum}

@quotation

Classe base para criação de constantes enumeradas.
@end quotation

@ref{d00,,IntEnum}

@quotation

Classe base para criar constantes enumeradas que também são subclasses de @ref{257,,int}. (@ref{275b,,Notas})
@end quotation

@ref{61a,,StrEnum}

@quotation

Classe base para criar constantes enumeradas que também são subclasses de @ref{44c,,str}. (@ref{275b,,Notas})
@end quotation

@ref{623,,Flag}

@quotation

Classe base para criar constantes enumeradas que podem ser combinadas usando operações bit a bit sem perder sua associação @ref{623,,Flag}.
@end quotation

@ref{cbb,,IntFlag}

@quotation

Classe base para criar constantes enumeradas que podem ser combinadas usando operadores bit a bit sem perder sua associação @ref{cbb,,IntFlag}. Membros de @ref{cbb,,IntFlag} também são subclasses de @ref{257,,int}. (@ref{275b,,Notas})
@end quotation

@ref{61b,,ReprEnum}

@quotation

Usado por @ref{d00,,IntEnum}, @ref{61a,,StrEnum} e @ref{cbb,,IntFlag} para manter o @ref{44c,,str()} do tipo misto.
@end quotation

@ref{626,,EnumCheck}

@quotation

Uma enumeração com os valores @code{CONTINUOUS}, @code{NAMED_FLAGS} e @code{UNIQUE}, para uso com @ref{625,,verify()} para garantir que várias restrições sejam atendidas por uma determinada enumeração.
@end quotation

@ref{624,,FlagBoundary}

@quotation

Uma enumeração com os valores @code{STRICT}, @code{CONFORM}, @code{EJECT} e @code{KEEP} que permite um controle mais refinado sobre como valores inválidos são tratados em uma enumeração.
@end quotation

@ref{1e4,,EnumDict}

@quotation

Uma subclasse de @ref{256,,dict} para uso ao criar subclasse de @ref{1e5,,EnumType}.
@end quotation

@ref{cbc,,auto}

@quotation

As instâncias são substituídas por um valor apropriado para membros Enum. @ref{61a,,StrEnum} assume como padrão a versão em minúsculas do nome do membro, enquanto outros Enums assumem como padrão 1 e aumentam a partir daí.
@end quotation

@ref{629,,property()}

@quotation

Permite que membros @ref{630,,Enum} tenham atributos sem conflitar com nomes de membros. Os atributos @code{value} e @code{name} são implementados dessa forma.
@end quotation

@ref{275c,,unique()}

@quotation

Decorador de classe Enum que garante que apenas um nome seja vinculado a cada valor.
@end quotation

@ref{625,,verify()}

@quotation

Decorador de classe Enum que verifica restrições selecionáveis pelo usuário em uma enumeração.
@end quotation

@ref{627,,member()}

@quotation

Torna @code{obj} um membro. Pode ser usado como um decorador.
@end quotation

@ref{628,,nonmember()}

@quotation

Não torna @code{obj} um membro. Pode ser usado como um decorador.
@end quotation

@ref{62b,,global_enum()}

@quotation

Modifica @ref{44c,,str()} e @ref{800,,repr()} de uma enumeração para mostrar seus membros como pertencentes ao módulo em vez de sua classe, e exporta os membros da enumeração para o espaço de nomes global.
@end quotation

@ref{275d,,show_flag_values()}

@quotation

Retorna uma lista de todos os inteiros de potência de dois contidos em um sinalizador.
@end quotation
@end quotation


Adicionado na versão 3.6: @code{Flag}, @code{IntFlag}, @code{auto}



Adicionado na versão 3.11: @code{StrEnum}, @code{EnumCheck}, @code{ReprEnum}, @code{FlagBoundary}, @code{property}, @code{member}, @code{nonmember}, @code{global_enum}, @code{show_flag_values}



Adicionado na versão 3.13: @code{EnumDict}



__________________________________________________________________


@node Tipos de Dados<2>,Utilities and Decorators,Conteúdo do módulo<2>,enum — Suporte a enumerações
@anchor{library/enum data-types}@anchor{275e}
@subsubsection Tipos de Dados


@geindex EnumType (classe em enum)
@anchor{library/enum enum EnumType}@anchor{1e5}
@deffn {Classe} enum.EnumType

`EnumType' é a @ref{2112,,metaclasse} para enumerações `enum'. É possível criar subclasse de `EnumType' – veja @ref{275f,,Criando subclasses de EnumType} para detalhes.

@code{EnumType} é responsável por definir os métodos @code{__repr__()}, @code{__str__()}, @code{__format__()} e @code{__reduce__()} corretos no `enum' final, bem como criar os membros do enum, manipular adequadamente as duplicatas, fornecer iteração sobre a classe do enum, etc.


Adicionado na versão 3.11: Antes da versão 3.11, @code{EnumType} era chamado de @code{EnumMeta}, que ainda está disponível como um apelido.


@geindex __call__() (método enum.EnumType)
@anchor{library/enum enum EnumType __call__}@anchor{2760}
@deffn {Método} __call__ (cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Este método é chamado de formas diferentes:


@itemize *

@item 
para procurar um membro existente:

@quotation

@*cls: 
A classe enum sendo chamada.


@*valor: 
O valor para procurar.

@end quotation

@item 
para usar a enumeração @code{cls} para criar uma nova enumeração (somente se a enumeração existente não tiver nenhum membro):

@quotation

@*cls: 
A classe enum sendo chamada.


@*valor: 
O nome do novo Enum para criar.


@*nomes: 
Os nomes/valores dos membros para o novo Enum.


@*módulo: 
O nome do módulo no qual o novo Enum é criado.


@*qualname: 
O local real no módulo onde este Enum pode ser encontrado.


@*tipo: 
Um tipo de mix-in para o novo Enum.


@*start: 
O primeiro valor inteiro para o Enum (usado por @ref{cbc,,auto}).


@*boundary: 
Como lidar com valores fora do intervalo de operações de bits (somente @ref{623,,Flag}).

@end quotation
@end itemize
@end deffn

@geindex __contains__() (método enum.EnumType)
@anchor{library/enum enum EnumType __contains__}@anchor{2761}
@deffn {Método} __contains__ (cls, member)

Retorna @code{True} se o membro pertencer a @code{cls}:

@example
>>> some_var = Color.RED
>>> some_var in Color
True
>>> Color.RED.value in Color
True
@end example


Alterado na versão 3.12: Antes do Python 3.12, um @code{TypeError} era levantado se um membro não Enum fosse usado em uma verificação de contenção.

@end deffn

@geindex __dir__() (método enum.EnumType)
@anchor{library/enum enum EnumType __dir__}@anchor{2762}
@deffn {Método} __dir__ (cls)

Retorna @code{['__class__', '__doc__', '__members__', '__module__']} e os nomes dos membros em `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 enum.EnumType)
@anchor{library/enum enum EnumType __getitem__}@anchor{2763}
@deffn {Método} __getitem__ (cls, name)

Retorna o membro Enum em `cls' correspondente a `name' ou levanta @ref{344,,KeyError}:

@example
>>> Color['BLUE']
<Color.BLUE: 3>
@end example
@end deffn

@geindex __iter__() (método enum.EnumType)
@anchor{library/enum enum EnumType __iter__}@anchor{2764}
@deffn {Método} __iter__ (cls)

Retorna cada membro em `cls' na ordem de definição:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
@end example
@end deffn

@geindex __len__() (método enum.EnumType)
@anchor{library/enum enum EnumType __len__}@anchor{2765}
@deffn {Método} __len__ (cls)

Retorna o número de membros em `cls':

@example
>>> len(Color)
3
@end example
@end deffn

@geindex __members__ (atributo enum.EnumType)
@anchor{library/enum enum EnumType __members__}@anchor{2766}
@deffn {Atributo} __members__

Retorna um mapeamento de cada nome de enumeração para seu membro, incluindo apelidos
@end deffn

@geindex __reversed__() (método enum.EnumType)
@anchor{library/enum enum EnumType __reversed__}@anchor{2767}
@deffn {Método} __reversed__ (cls)

Retorna cada membro em `cls' na ordem inversa de definição:

@example
>>> list(reversed(Color))
[<Color.BLUE: 3>, <Color.GREEN: 2>, <Color.RED: 1>]
@end example
@end deffn
@end deffn

@geindex Enum (classe em enum)
@anchor{library/enum enum Enum}@anchor{630}
@deffn {Classe} enum.Enum

`Enum' é a classe base para todas as enumerações `enum'.

@geindex name (atributo enum.Enum)
@anchor{library/enum enum Enum name}@anchor{2768}
@deffn {Atributo} name

O nome usado para definir o membro @code{Enum}:

@example
>>> Color.BLUE.name
'BLUE'
@end example
@end deffn

@geindex value (atributo enum.Enum)
@anchor{library/enum enum Enum value}@anchor{2769}
@deffn {Atributo} value

O valor dado ao membro @code{Enum}:

@example
>>> Color.RED.value
1
@end example

O valor do membro pode ser definido em @ref{276a,,__new__()}.

@cartouche
@quotation Nota 
Valores de membros de Enum

Os valores dos membros podem ser qualquer coisa: @ref{257,,int}, @ref{44c,,str}, etc. Se o valor exato não for importante, você pode usar instâncias de @ref{cbc,,auto} e um valor apropriado será escolhido para você. Consulte @ref{cbc,,auto} para obter detalhes.

Embora valores mutáveis/não hasheáveis, como @ref{256,,dict}, @ref{611,,list} ou um mutável @ref{1cb,,dataclass}, possam ser usados, eles terão um impacto quadrático no desempenho durante a criação em relação ao número total de valores mutáveis/não hasheáveis na enumeração.
@end quotation
@end cartouche
@end deffn

@geindex _name_ (atributo enum.Enum)
@anchor{library/enum enum Enum _name_}@anchor{276b}
@deffn {Atributo} _name_

Nome do membro.
@end deffn

@geindex _value_ (atributo enum.Enum)
@anchor{library/enum enum Enum _value_}@anchor{276c}
@deffn {Atributo} _value_

O valor do membro pode ser definido em @ref{276a,,__new__()}.
@end deffn

@geindex _order_ (atributo enum.Enum)
@anchor{library/enum enum Enum _order_}@anchor{276d}
@deffn {Atributo} _order_

Não é mais usado, mantido para compatibilidade com versões anteriores. (atributo de classe, removido durante a criação da classe).
@end deffn

@geindex _ignore_ (atributo enum.Enum)
@anchor{library/enum enum Enum _ignore_}@anchor{276e}
@deffn {Atributo} _ignore_

@code{_ignore_} é usado somente durante a criação e é removido da enumeração quando a criação é concluída.

@code{_ignore_} é uma lista de nomes que não se tornarão membros e cujos nomes também serão removidos da enumeração concluída. Veja @ref{276f,,TimePeriod} para um exemplo.
@end deffn

@geindex __dir__() (método enum.Enum)
@anchor{library/enum enum Enum __dir__}@anchor{198d}
@deffn {Método} __dir__ (self)

Retorna @code{['__class__', '__doc__', '__module__', 'name', 'value']} e quaisquer métodos públicos definidos em `self.__class__':

@example
>>> from enum import Enum
>>> 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 enum.Enum)
@anchor{library/enum enum Enum _generate_next_value_}@anchor{2770}
@deffn {Método} _generate_next_value_ (name, start, count, last_values)

@quotation

@*nome: 
O nome do membro que está sendo definido (por exemplo, ‘RED’).


@*start: 
O valor inicial do Enum; o padrão é 1.


@*count: 
O número de membros atualmente definido, sem incluir este.


@*last_values: 
Uma lista de valores anteriores.

@end quotation

Um `staticmethod' que é usado para determinar o próximo valor retornado por @ref{cbc,,auto}:

@example
>>> from enum import auto, Enum
>>> 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 enum.Enum)
@anchor{library/enum enum Enum __init__}@anchor{2771}
@deffn {Método} __init__ (self, *args, **kwds)

Por padrão, não faz nada. Se vários valores forem fornecidos na atribuição de membro, esses valores se tornarão argumentos separados para @code{__init__}; por exemplo.:

@example
>>> from enum import Enum
>>> class Weekday(Enum):
...     MONDAY = 1, 'Mon'
@end example

@code{Weekday.__init__()} seria chamado como @code{Weekday.__init__(self, 1, 'Mon')}
@end deffn

@geindex __init_subclass__() (método enum.Enum)
@anchor{library/enum enum Enum __init_subclass__}@anchor{2772}
@deffn {Método} __init_subclass__ (cls, **kwds)

Um `classmethod' usado para configurar subclasses subsequentes. Por padrão, não faz nada.
@end deffn

@geindex _missing_() (método enum.Enum)
@anchor{library/enum enum Enum _missing_}@anchor{2773}
@deffn {Método} _missing_ (cls, value)

Um `classmethod' para procurar valores não encontrados em `cls'. Por padrão, ele não faz nada, mas pode ser substituído para implementar um comportamento de pesquisa personalizado:

@example
>>> from enum import auto, 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 enum.Enum)
@anchor{library/enum enum Enum __new__}@anchor{276a}
@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 enum.Enum)
@anchor{library/enum enum Enum __repr__}@anchor{1882}
@deffn {Método} __repr__ (self)

Returns the string used for `repr()' calls.  By default, returns the
`Enum' name, member name, and value, but can be overridden:

@example
>>> from enum import auto, Enum
>>> 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 enum.Enum)
@anchor{library/enum enum Enum __str__}@anchor{622}
@deffn {Método} __str__ (self)

Returns the string used for `str()' calls.  By default, returns the
`Enum' name and member name, but can be overridden:

@example
>>> from enum import auto, Enum
>>> 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 enum.Enum)
@anchor{library/enum enum Enum __format__}@anchor{620}
@deffn {Método} __format__ (self)

Returns the string used for `format()' and `f-string' calls.  By default,
returns @ref{622,,__str__()} return value, but can be overridden:

@example
>>> from enum import auto, Enum
>>> 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 
Using @ref{cbc,,auto} with @ref{630,,Enum} results in integers of increasing value,
starting with @code{1}.
@end quotation
@end cartouche


Alterado na versão 3.12: Added @ref{1881,,Suporte a dataclass}


@geindex _add_alias_() (método enum.Enum)
@anchor{library/enum enum Enum _add_alias_}@anchor{2774}
@deffn {Método} _add_alias_ ()

Adds a new name as an alias to an existing member:

@example
>>> Color.RED._add_alias_("ERROR")
>>> Color.ERROR
<Color.RED: 1>
@end example

Raises a @ref{43f,,NameError} if the name is already assigned to a different member.


Adicionado na versão 3.13.

@end deffn

@geindex _add_value_alias_() (método enum.Enum)
@anchor{library/enum enum Enum _add_value_alias_}@anchor{2775}
@deffn {Método} _add_value_alias_ ()

Adds a new value as an alias to an existing member:

@example
>>> Color.RED._add_value_alias_(42)
>>> Color(42)
<Color.RED: 1>
@end example

Raises a @ref{202,,ValueError} if the value is already linked with a different member.


Adicionado na versão 3.13.

@end deffn
@end deffn

@geindex IntEnum (classe em enum)
@anchor{library/enum enum IntEnum}@anchor{d00}
@deffn {Classe} enum.IntEnum

`IntEnum' is the same as @ref{630,,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 
Using @ref{cbc,,auto} with @ref{d00,,IntEnum} results in integers of increasing
value, starting with @code{1}.
@end quotation
@end cartouche


Alterado na versão 3.11: @ref{61d,,__str__()} is now @code{int.__str__()} to
better support the `replacement of existing constants' use-case.
@ref{61e,,__format__()} was already @code{int.__format__()} for that same reason.

@end deffn

@geindex StrEnum (classe em enum)
@anchor{library/enum enum StrEnum}@anchor{61a}
@deffn {Classe} enum.StrEnum

`StrEnum' is the same as @ref{630,,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.

@example
>>> from enum import StrEnum, auto
>>> class Color(StrEnum):
...     RED = 'r'
...     GREEN = 'g'
...     BLUE = 'b'
...     UNKNOWN = auto()
...
>>> Color.RED
<Color.RED: 'r'>
>>> Color.UNKNOWN
<Color.UNKNOWN: 'unknown'>
>>> str(Color.UNKNOWN)
'unknown'
@end example

@cartouche
@quotation Nota 
There are places in the stdlib that check for an exact @ref{44c,,str}
instead of a @ref{44c,,str} subclass (i.e. @code{type(unknown) == str}
instead of @code{isinstance(unknown, str)}), and in those locations you
will need to use @code{str(MyStrEnum.MY_MEMBER)}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Using @ref{cbc,,auto} with @ref{61a,,StrEnum} results in the lower-cased member
name as the value.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@ref{61d,,__str__()} is @code{str.__str__()} to better support the
`replacement of existing constants' use-case.  @ref{61e,,__format__()} is likewise
@code{str.__format__()} for that same reason.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex Flag (classe em enum)
@anchor{library/enum enum Flag}@anchor{623}
@deffn {Classe} enum.Flag

@code{Flag} is the same as @ref{630,,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 enum.Flag)
@anchor{library/enum enum Flag __contains__}@anchor{2776}
@deffn {Método} __contains__ (self, value)

Returns `True' if value is in self:

@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


Adicionado na versão 3.11.

@end deffn


@deffn {Método} __len__(self):

Returns number of members in flag:

@example
>>> len(Color.GREEN)
1
>>> len(white)
3
@end example


Adicionado na versão 3.11.

@end deffn


@deffn {Método} __bool__(self):

Returns `True' if any members in flag, `False' otherwise:

@example
>>> bool(Color.GREEN)
True
>>> bool(white)
True
>>> black = Color(0)
>>> bool(black)
False
@end example
@end deffn

@geindex __or__() (método enum.Flag)
@anchor{library/enum enum Flag __or__}@anchor{2777}
@deffn {Método} __or__ (self, other)

Returns current flag binary or’ed with other:

@example
>>> Color.RED | Color.GREEN
<Color.RED|GREEN: 3>
@end example
@end deffn

@geindex __and__() (método enum.Flag)
@anchor{library/enum enum Flag __and__}@anchor{2778}
@deffn {Método} __and__ (self, other)

Returns current flag binary and’ed with other:

@example
>>> purple & white
<Color.RED|BLUE: 5>
>>> purple & Color.GREEN
<Color: 0>
@end example
@end deffn

@geindex __xor__() (método enum.Flag)
@anchor{library/enum enum Flag __xor__}@anchor{2779}
@deffn {Método} __xor__ (self, other)

Returns current flag binary xor’ed with other:

@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 enum.Flag)
@anchor{library/enum enum Flag _numeric_repr_}@anchor{277a}
@deffn {Método} _numeric_repr_ ()

Function used to format any remaining unnamed numeric values.  Default is
the value’s repr; common choices are @ref{1312,,hex()} and @ref{1311,,oct()}.
@end deffn

@cartouche
@quotation Nota 
Using @ref{cbc,,auto} with @ref{623,,Flag} results in integers that are powers
of two, starting with @code{1}.
@end quotation
@end cartouche


Alterado na versão 3.11: The `repr()' of zero-valued flags has changed.  It
is now::

@example
>>> Color(0)
<Color: 0>
@end example

@end deffn

@geindex IntFlag (classe em enum)
@anchor{library/enum enum IntFlag}@anchor{cbb}
@deffn {Classe} enum.IntFlag

@code{IntFlag} is the same as @ref{623,,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

If any integer operation is performed with an `IntFlag' member, the result is
not an `IntFlag':

@example
>>> Color.RED + 2
3
@end example

If a @ref{623,,Flag} operation is performed with an `IntFlag' member and:


@itemize *

@item 
the result is a valid `IntFlag': an `IntFlag' is returned

@item 
the result is not a valid `IntFlag': the result depends on the @ref{624,,FlagBoundary} setting
@end itemize

The @ref{800,,repr()} of unnamed zero-valued flags has changed.  It is now:

@example
>>> Color(0)
<Color: 0>
@end example

@cartouche
@quotation Nota 
Using @ref{cbc,,auto} with @ref{cbb,,IntFlag} results in integers that are powers
of two, starting with @code{1}.
@end quotation
@end cartouche


Alterado na versão 3.11: @ref{61d,,__str__()} is now @code{int.__str__()} to better support the
`replacement of existing constants' use-case.  @ref{61e,,__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{623,,Flag} behavior.

@end deffn

@geindex ReprEnum (classe em enum)
@anchor{library/enum enum ReprEnum}@anchor{61b}
@deffn {Classe} enum.ReprEnum

@code{ReprEnum} uses the @ref{1882,,repr()} of @ref{630,,Enum},
but the @ref{44c,,str()} of the mixed-in data type:


@itemize *

@item 
@code{int.__str__()} for @ref{d00,,IntEnum} and @ref{cbb,,IntFlag}

@item 
@code{str.__str__()} for @ref{61a,,StrEnum}
@end itemize

Inherit from @code{ReprEnum} to keep the @ref{44c,,str()} / @ref{61f,,format()}
of the mixed-in data type instead of using the
@ref{630,,Enum}-default @ref{622,,str()}.


Adicionado na versão 3.11.

@end deffn

@geindex EnumCheck (classe em enum)
@anchor{library/enum enum EnumCheck}@anchor{626}
@deffn {Classe} enum.EnumCheck

`EnumCheck' contains the options used by the @ref{625,,verify()} decorator to ensure
various constraints; failed constraints result in a @ref{202,,ValueError}.

@geindex UNIQUE (atributo enum.EnumCheck)
@anchor{library/enum enum EnumCheck UNIQUE}@anchor{277b}
@deffn {Atributo} UNIQUE

Ensure that each value has only one name:

@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 enum.EnumCheck)
@anchor{library/enum enum EnumCheck CONTINUOUS}@anchor{277c}
@deffn {Atributo} CONTINUOUS

Ensure that there are no missing values between the lowest-valued member
and the highest-valued member:

@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 enum.EnumCheck)
@anchor{library/enum enum EnumCheck NAMED_FLAGS}@anchor{277d}
@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{cbc,,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 and NAMED_FLAGS are designed to work with integer-valued members.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex FlagBoundary (classe em enum)
@anchor{library/enum enum FlagBoundary}@anchor{624}
@deffn {Classe} enum.FlagBoundary

@code{FlagBoundary} controls how out-of-range values are handled in @ref{623,,Flag} and its
subclasses.

@geindex STRICT (atributo enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary STRICT}@anchor{277e}
@deffn {Atributo} STRICT

Out-of-range values cause a @ref{202,,ValueError} to be raised. This is the
default for @ref{623,,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 enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary CONFORM}@anchor{277f}
@deffn {Atributo} CONFORM

Out-of-range values have invalid values removed, leaving a valid @ref{623,,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 enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary EJECT}@anchor{2780}
@deffn {Atributo} EJECT

Out-of-range values lose their @ref{623,,Flag} membership and revert to @ref{257,,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 enum.FlagBoundary)
@anchor{library/enum enum FlagBoundary KEEP}@anchor{2781}
@deffn {Atributo} KEEP

Out-of-range values are kept, and the @ref{623,,Flag} membership is kept.
This is the default for @ref{cbb,,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


Adicionado na versão 3.11.

@end deffn

@geindex EnumDict (classe em enum)
@anchor{library/enum enum EnumDict}@anchor{1e4}
@deffn {Classe} enum.EnumDict

`EnumDict' is a subclass of @ref{256,,dict} that is used as the namespace
for defining enum classes (see @ref{c79,,Preparando o espaço de nomes da classe}).
It is exposed to allow subclasses of @ref{1e5,,EnumType} with advanced
behavior like having multiple values per member.
It should be called with the name of the enum class being created, otherwise
private names and internal classes will not be handled correctly.

Note that only the @ref{10eb,,MutableMapping} interface
(@ref{130e,,__setitem__()} and @ref{14ad,,update()}) is overridden.
It may be possible to bypass the checks using other @code{dict}
operations like @ref{2142,,|=}.

@geindex member_names (atributo enum.EnumDict)
@anchor{library/enum enum EnumDict member_names}@anchor{2782}
@deffn {Atributo} member_names

A list of member names.
@end deffn


Adicionado na versão 3.13.

@end deffn


__________________________________________________________________


@menu
* Nomes __dunder__ suportados:: 
* Nomes _sunder_ suportados:: 

@end menu

@node Nomes __dunder__ suportados,Nomes _sunder_ suportados,,Tipos de Dados<2>
@anchor{library/enum supported-dunder-names}@anchor{2783}
@subsubsection Nomes @code{__dunder__} suportados


@ref{2766,,__members__} is a read-only ordered mapping of @code{member_name}:@code{member}
items.  It is only available on the class.

@ref{276a,,__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 Nomes _sunder_ suportados,,Nomes __dunder__ suportados,Tipos de Dados<2>
@anchor{library/enum supported-sunder-names}@anchor{2784}
@subsubsection Nomes @code{_sunder_} suportados



@itemize -

@item 
@ref{276b,,_name_} – name of the member

@item 
@ref{276c,,_value_} – value of the member; can be set in @code{__new__}

@item 
@ref{2773,,_missing_()} – a lookup function used when a value is not found;
may be overridden

@item 
@ref{276e,,_ignore_} – a list of names, either as a @ref{611,,list} or a
@ref{44c,,str}, that will not be transformed into members, and will be removed
from the final class

@item 
@ref{276d,,_order_} – no longer used, kept for backward
compatibility (class attribute, removed during class creation)

@item 
@ref{2770,,_generate_next_value_()} – used to get an appropriate value for
an enum member; may be overridden

@cartouche
@quotation Nota 
For standard @ref{630,,Enum} classes the next value chosen is the highest
value seen incremented by one.

For @ref{623,,Flag} classes the next value chosen will be the next highest
power-of-two.
@end quotation
@end cartouche

@item 
@ref{2774,,_add_alias_()} – adds a new name as an alias to an existing
member.

@item 
@ref{2775,,_add_value_alias_()} – adds a new value as an alias to an
existing member.

@item 
While @code{_sunder_} names are generally reserved for the further development
of the @ref{630,,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


Adicionado na versão 3.6: @code{_missing_}, @code{_order_}, @code{_generate_next_value_}



Adicionado na versão 3.7: @code{_ignore_}



Adicionado na versão 3.13: @code{_add_alias_}, @code{_add_value_alias_}, @code{_repr_*}



__________________________________________________________________


@node Utilities and Decorators,Notas,Tipos de Dados<2>,enum — Suporte a enumerações
@anchor{library/enum ipython-s-rich-display}@anchor{2785}@anchor{library/enum utilities-and-decorators}@anchor{2786}
@subsubsection Utilities and Decorators


@geindex auto (classe em enum)
@anchor{library/enum enum auto}@anchor{cbc}
@deffn {Classe} enum.auto

`auto' can be used in place of a value.  If used, the `Enum' machinery will
call an @ref{630,,Enum}’s @ref{2770,,_generate_next_value_()} to get an appropriate value.
For @ref{630,,Enum} and @ref{d00,,IntEnum} that appropriate value will be the last value plus
one; for @ref{623,,Flag} and @ref{cbb,,IntFlag} it will be the first power-of-two greater
than the highest value; for @ref{61a,,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, either by
itself or as part of a tuple:


@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


Alterado na versão 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_} can be overridden to customize the values used by
`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() (no módulo enum)
@anchor{library/enum enum property}@anchor{629}
@deffn {Função} @@enum.property

A decorator similar to the built-in `property', but specifically for
enumerations.  It allows member attributes to have the same names as members
themselves.

@cartouche
@quotation Nota 
the `property' and the member must be defined in separate classes;
for example, the `value' and `name' attributes are defined in the
`Enum' class, and `Enum' subclasses can define members with the
names @code{value} and @code{name}.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex unique() (no módulo enum)
@anchor{library/enum enum unique}@anchor{275c}
@deffn {Função} @@enum.unique

A @ref{131a,,class} decorator specifically for enumerations.  It searches an
enumeration’s @ref{2766,,__members__}, gathering any aliases it finds; if any are
found @ref{202,,ValueError} is raised with the details:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Errado(Enum):
...     UM = 1
...     DOIS = 2
...     TRES = 3
...     QUATRO = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Errado'>: QUATRO -> TRES
@end example
@end deffn

@geindex verify() (no módulo enum)
@anchor{library/enum enum verify}@anchor{625}
@deffn {Função} @@enum.verify

A @ref{131a,,class} decorator specifically for enumerations.  Members from
@ref{626,,EnumCheck} are used to specify which constraints should be checked
on the decorated enumeration.


Adicionado na versão 3.11.

@end deffn

@geindex member() (no módulo enum)
@anchor{library/enum enum member}@anchor{627}
@deffn {Função} @@enum.member

A decorator for use in enums: its target will become a member.


Adicionado na versão 3.11.

@end deffn

@geindex nonmember() (no módulo enum)
@anchor{library/enum enum nonmember}@anchor{628}
@deffn {Função} @@enum.nonmember

A decorator for use in enums: its target will not become a member.


Adicionado na versão 3.11.

@end deffn

@geindex global_enum() (no módulo enum)
@anchor{library/enum enum global_enum}@anchor{62b}
@deffn {Função} @@enum.global_enum

A decorator to change the @ref{44c,,str()} and @ref{800,,repr()} of an enum
to show its members as belonging to the module instead of its class.
Should only be used when the enum members are exported
to the module global namespace (see @ref{62d,,re.RegexFlag} for an example).


Adicionado na versão 3.11.

@end deffn

@geindex show_flag_values() (no módulo enum)
@anchor{library/enum enum show_flag_values}@anchor{275d}
@deffn {Função} enum.show_flag_values (value)

Return a list of all power-of-two integers contained in a flag `value'.


Adicionado na versão 3.11.

@end deffn


__________________________________________________________________


@node Notas,,Utilities and Decorators,enum — Suporte a enumerações
@anchor{library/enum notes}@anchor{275b}
@subsubsection Notas


@ref{d00,,IntEnum}, @ref{61a,,StrEnum}, and @ref{cbb,,IntFlag}

@quotation

These three enum types are designed to be drop-in replacements for existing
integer- and string-based values; as such, they have extra limitations:


@itemize -

@item 
@code{__str__} uses the value and not the name of the enum member

@item 
@code{__format__}, because it uses @code{__str__}, will also use the value of
the enum member instead of its name
@end itemize

If you do not need/want those limitations, you can either create your own
base class by mixing in the @code{int} or @code{str} type yourself:

@example
>>> from enum import Enum
>>> class MyIntEnum(int, Enum):
...     pass
@end example

or you can reassign the appropriate @ref{44c,,str()}, etc., in your enum:

@example
>>> from enum import Enum, IntEnum
>>> class MyIntEnum(IntEnum):
...     __str__ = Enum.__str__
@end example
@end quotation

@node graphlib — Funcionalidade para operar com estruturas do tipo grafo,,enum — Suporte a enumerações,Tipos de Dados
@anchor{library/graphlib doc}@anchor{2787}@anchor{library/graphlib graphlib-functionality-to-operate-with-graph-like-structures}@anchor{2788}@anchor{library/graphlib module-graphlib}@anchor{65}@anchor{library/graphlib translation-repo}@anchor{2789}
@subsection @code{graphlib} — Funcionalidade para operar com estruturas do tipo grafo


@geindex module; graphlib

`Código-fonte:' Lib/graphlib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/graphlib.py}

@c import graphlib
@c from graphlib import *


__________________________________________________________________


@geindex TopologicalSorter (classe em graphlib)
@anchor{library/graphlib graphlib TopologicalSorter}@anchor{8e7}
@deffn {Classe} graphlib.TopologicalSorter (graph=None)

Fornece funcionalidade para classificar topologicamente um grafo de nós @ref{610,,hasheáveis}.

Uma ordem topológica é uma ordenação linear dos vértices em um grafo, de modo que para cada aresta direcionada u -> v do vértice u ao vértice v, o vértice u vem antes do vértice v na ordenação. Por exemplo, os vértices do grafo podem representar tarefas a serem executadas e as arestas podem representar restrições de que uma tarefa deve ser executada antes de outra; neste exemplo, uma ordem topológica é apenas uma sequência válida para as tarefas. Uma ordenação topológica completa é possível se e somente se o grafo não tiver ciclos direcionados, ou seja, se for um grafo acíclico direcionado.

Se o argumento opcional `graph' for fornecido, ele deverá ser um dicionário que represente um grafo acíclico direcionado no qual as chaves sejam nós e os valores sejam iteráveis de todos os predecessores desse nó no grafo (os nós que possuem bordas que apontam para o valor na chave). Nós adicionais podem ser adicionados ao grafo usando o método @ref{278a,,add()}.

No caso geral, as etapas necessárias para executar a classificação de um determinado grafo são as seguintes:


@itemize *

@item 
Cria uma instância da classe @ref{8e7,,TopologicalSorter} com um grafo inicial opcional.

@item 
Adiciona nós adicionais ao grafo.

@item 
Chama o método @ref{278b,,prepare()} no grafo.

@item 
Enquanto @ref{278c,,is_active()} é @code{True}, itera pelos nós retornados por @ref{278d,,get_ready()} e os processa. Chama @ref{278e,,done()} em cada nó na medida em que finaliza o processamento.
@end itemize

Caso apenas uma classificação imediata dos nós no grafo seja necessária e nenhum paralelismo esteja envolvido, o método de conveniência @ref{278f,,TopologicalSorter.static_order()} pode ser usado diretamente:

@example
>>> graph = @{"D": @{"B", "C"@}, "C": @{"A"@}, "B": @{"A"@}@}
>>> ts = TopologicalSorter(graph)
>>> tuple(ts.static_order())
('A', 'C', 'B', 'D')
@end example

A classe foi projetada para suportar facilmente o processamento paralelo dos nós à medida que eles se tornam prontos. Por exemplo:

@example
topological_sorter = TopologicalSorter()

# Adiciona nodos para 'topological_sorter'...

topological_sorter.prepare()
while topological_sorter.is_active():
    for node in topological_sorter.get_ready():
        # Processos ou threads de workers obtém nós para
        # trabalhar na fila 'task_queue'.
        task_queue.put(node)

    # Quando o trabalho para um nó é feito, os workers colocam o
    # nó em 'finalized_tasks_queue' para que possamos obter mais
    # nós para trabalhar. A definição de 'is_active()' garante que,
    # neste ponto, pelo menos um nó foi colocado em 'task_queue'
    # que ainda não foi passado para 'done()', então este 'get()' de
    # bloqueio deve (eventualmente) ter sucesso. Depois de chamar
    # 'done()', fazemos um laço de volta para chamar 'get_ready()'
    # novamente, então colocamos nós recém-liberados em
    # 'task_queue' o mais rápido possível.
    node = finalized_tasks_queue.get()
    topological_sorter.done(node)
@end example

@geindex add() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter add}@anchor{278a}
@deffn {Método} add (node, *predecessors)

Adiciona um novo nó e seus predecessores ao grafo. O `node' e todos os elementos em `predecessors' devem ser @ref{610,,hasheáveis}.

Se chamado várias vezes com o mesmo argumento do nó, o conjunto de dependências será a união de todas as dependências transmitidas.

É possível adicionar um nó sem dependências (`predecessors' não são fornecidos) ou fornecer uma dependência duas vezes. Se um nó que não foi fornecido anteriormente for incluído entre os `predecessors', ele será automaticamente adicionado ao grafo sem predecessores próprios.

Levanta @ref{202,,ValueError} se chamado após @ref{278b,,prepare()}.
@end deffn

@geindex prepare() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter prepare}@anchor{278b}
@deffn {Método} prepare ()

Marca o grafo como concluído e verifica os ciclos no grafo. Se qualquer ciclo for detectado, @ref{2790,,CycleError} será gerado, mas @ref{278d,,get_ready()} ainda poderá ser usado para obter o maior número possível de nós até que os ciclos bloqueiem mais progressos. Após uma chamada para esta função, o grafo não pode ser modificado e, portanto, nenhum nó pode ser adicionado usando @ref{278a,,add()}.
@end deffn

@geindex is_active() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter is_active}@anchor{278c}
@deffn {Método} is_active ()

Retorna @code{True} se mais progresso puder ser feito e @code{False} caso contrário. É possível progredir se os ciclos não bloquearem a resolução e ainda houver nós prontos que ainda não foram retornados por @ref{278d,,TopologicalSorter.get_ready()} ou o número de nós marcados @ref{278e,,TopologicalSorter.done()} é menor que o número retornado por @ref{278d,,TopologicalSorter.get_ready()}.

O método @ref{1318,,__bool__()} desta classe adia para essa função, então, em vez de:

@example
if ts.is_active():
    ...
@end example

é possível simplesmente fazer:

@example
if ts:
    ...
@end example

Levanta @ref{202,,ValueError} se chamado sem chamar @ref{278b,,prepare()} anteriormente.
@end deffn

@geindex done() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter done}@anchor{278e}
@deffn {Método} done (*nodes)

Marca um conjunto de nós retornados por @ref{278d,,TopologicalSorter.get_ready()} como processado, desbloqueando qualquer sucessor de cada nó em `nodes' para ser retornado no futuro por uma chamada para @ref{278d,,TopologicalSorter.get_ready()}.

Levanta @ref{202,,ValueError} se algum nó em `nodes' já foi marcado como processado por uma chamada anterior a este método ou se um nó não foi adicionado ao grafo usando @ref{278a,,TopologicalSorter.add()}, se chamado sem chamar @code{prepare()} ou se o nó ainda não foi retornado por @ref{278d,,get_ready()}.
@end deffn

@geindex get_ready() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter get_ready}@anchor{278d}
@deffn {Método} get_ready ()

Retorna uma @code{tupla} com todos os nós que estão prontos. Inicialmente, ele retorna todos os nós sem predecessores e, uma vez marcados como processados, chamando @ref{278e,,TopologicalSorter.done()}, novas chamadas retornarão todos os novos nós que já tenham seus antecessores já processados. Quando não for possível fazer mais progresso, as tuplas vazias serão retornadas.

Levanta @ref{202,,ValueError} se chamado sem chamar @ref{278b,,prepare()} anteriormente.
@end deffn

@geindex static_order() (método graphlib.TopologicalSorter)
@anchor{library/graphlib graphlib TopologicalSorter static_order}@anchor{278f}
@deffn {Método} static_order ()

Retorna um objeto iterador que irá iterar sobre os nós em uma ordem topológica. Ao usar este método, @ref{278b,,prepare()} e @ref{278e,,done()} não devem ser chamados. Este método é 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

A ordem específica retornada pode depender da ordem específica em que os itens foram inseridos no grafo. Por exemplo:

@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

Isso se deve ao fato de que “0” e “2” estão no mesmo nível no grafo (eles teriam sido retornados na mesma chamada para @ref{278d,,get_ready()}) e a ordem entre eles é determinada pela ordem de inserção.

Se qualquer ciclo for detectado, @ref{2790,,CycleError} será levantada.
@end deffn


Adicionado na versão 3.9.

@end deffn

@menu
* Exceções: Exceções<4>. 

@end menu

@node Exceções<4>,,,graphlib — Funcionalidade para operar com estruturas do tipo grafo
@anchor{library/graphlib exceptions}@anchor{2791}
@subsubsection Exceções


O módulo @ref{65,,graphlib} define as seguintes classes de exceção:

@geindex CycleError
@anchor{library/graphlib graphlib CycleError}@anchor{2790}
@deffn {Exceção} graphlib.CycleError

Subclasse de @ref{202,,ValueError} levantada por @ref{278b,,TopologicalSorter.prepare()} se houver ciclos no grafo de trabalho. Se existirem vários ciclos, apenas uma opção indefinida entre eles será relatada e incluída na exceção.

O ciclo detectado pode ser acessado através do segundo elemento no atributo @ref{56c,,args} da instância de exceção e consiste em uma lista de nós, de modo que cada nó seja, no grafo, um predecessor imediato do próximo nó na lista. Na lista relatada, o primeiro e o último nó serão os mesmos, para deixar claro que é cíclico.
@end deffn

@node Módulos Matemáticos e Numéricos,Módulos de Programação Funcional,Tipos de Dados,A Biblioteca Padrão do Python
@anchor{library/numeric doc}@anchor{2792}@anchor{library/numeric numeric}@anchor{2793}@anchor{library/numeric numeric-and-mathematical-modules}@anchor{2794}@anchor{library/numeric translation-repo}@anchor{2795}
@section Módulos Matemáticos e Numéricos


Os módulos descritos neste capítulo fornecem funções e tipos de dados relacionados com o numérico e matemática. O módulo @ref{9e,,numbers} define uma hierarquia abstrata de tipos numéricos. Os módulos @ref{8e,,math} e @ref{18,,cmath} contêm várias funções matemáticas para números de ponto flutuante e números complexos. O módulo @ref{36,,decimal} suporta representações exatas de números decimais, usando aritmética de precisão arbitrária.

Os seguintes módulos estão documentados neste capítulo:

@menu
* numbers — Classes base abstratas numéricas:: 
* math — Funções matemáticas:: 
* cmath — Funções matemáticas para números complexos:: 
* decimal — Aritmética de ponto fixo decimal e ponto flutuante:: 
* fractions — Números racionais:: 
* random — Gera números pseudoaleatórios:: 
* statistics — Funções estatísticas:: 

@end menu

@node numbers — Classes base abstratas numéricas,math — Funções matemáticas,,Módulos Matemáticos e Numéricos
@anchor{library/numbers doc}@anchor{2796}@anchor{library/numbers module-numbers}@anchor{9e}@anchor{library/numbers numbers-numeric-abstract-base-classes}@anchor{2797}
@subsection @code{numbers} — Classes base abstratas numéricas


@geindex module; numbers

`Código-fonte:' Lib/numbers.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/numbers.py}


__________________________________________________________________


O módulo @code{numbers} (
@geindex Propostas de Melhorias do Python; PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/}) define uma hierarquia de @ref{11f5,,classes base abstratas} que progressivamente definem mais operações. Nenhum dos tipos definidos neste módulo se destina a ser instanciado.

@geindex Number (classe em numbers)
@anchor{library/numbers numbers Number}@anchor{2798}
@deffn {Classe} numbers.Number

A raiz da hierarquia numérica. Se você quiser apenas verificar se um argumento `x' é um número, sem se importar com o tipo, use @code{isinstance(x, Number)}.
@end deffn

@menu
* A torre numérica:: 
* Notas para implementadores de tipos:: 

@end menu

@node A torre numérica,Notas para implementadores de tipos,,numbers — Classes base abstratas numéricas
@anchor{library/numbers the-numeric-tower}@anchor{2799}
@subsubsection A torre numérica


@geindex Complex (classe em numbers)
@anchor{library/numbers numbers Complex}@anchor{279a}
@deffn {Classe} numbers.Complex

As subclasses deste tipo descrevem números complexos e incluem as operações que funcionam no tipo embutido @ref{2f8,,complex}. Elas são: conversões para @ref{2f8,,complex} e @ref{468,,bool}, @ref{279b,,real}, @ref{279c,,imag}, @code{+}, @code{-}, @code{*}, @code{/}, @code{**}, @ref{1e2d,,abs()}, @ref{279d,,conjugate()}, @code{==} e @code{!=}. Todos exceto @code{-} e @code{!=} são abstratos.

@geindex real (atributo numbers.Complex)
@anchor{library/numbers numbers Complex real}@anchor{279b}
@deffn {Atributo} real

Abstrata. Obtém o componente real deste número.
@end deffn

@geindex imag (atributo numbers.Complex)
@anchor{library/numbers numbers Complex imag}@anchor{279c}
@deffn {Atributo} imag

Abstrata. Obtém o componente imaginário deste número.
@end deffn

@geindex conjugate() (método numbers.Complex)
@anchor{library/numbers numbers Complex conjugate}@anchor{279d}
@deffn {Método} abstractmethod conjugate ()

Abstrata. Retorna o conjugado complexo. Por exemplo, @code{(1+3j).conjugate() == (1-3j)}.
@end deffn
@end deffn

@geindex Real (classe em numbers)
@anchor{library/numbers numbers Real}@anchor{232b}
@deffn {Classe} numbers.Real

Para @ref{279a,,Complex}, @code{Real} adiciona as operações que funcionam em números reais.

Em suma, são: uma conversão para @ref{2f7,,float}, @ref{1406,,math.trunc()}, @ref{131d,,round()}, @ref{1404,,math.floor()}, @ref{1405,,math.ceil()}, @ref{9a9,,divmod()}, @code{//}, @code{%}, @code{<}, @code{<=}, @code{>} e @code{>=}.

Real também fornece padrão para @ref{2f8,,complex()}, @ref{279b,,real}, @ref{279c,,imag} e @ref{279d,,conjugate()}.
@end deffn

@geindex Rational (classe em numbers)
@anchor{library/numbers numbers Rational}@anchor{1301}
@deffn {Classe} numbers.Rational

Estende @ref{232b,,Real} e adiciona as propriedades @ref{279e,,numerator} e @ref{279f,,denominator}. Ele fornece um padrão para @ref{2f7,,float()}.

Os valores @ref{279e,,numerator} e @ref{279f,,denominator} devem ser instâncias de @ref{214b,,Integral} e devem estar nos termos mais baixos com @ref{279f,,denominator} positivo.

@geindex numerator (atributo numbers.Rational)
@anchor{library/numbers numbers Rational numerator}@anchor{279e}
@deffn {Atributo} numerator

Abstrato. O numerador deste número racional.
@end deffn

@geindex denominator (atributo numbers.Rational)
@anchor{library/numbers numbers Rational denominator}@anchor{279f}
@deffn {Atributo} denominator

Abstrato. O denominador deste número racional.
@end deffn
@end deffn

@geindex Integral (classe em numbers)
@anchor{library/numbers numbers Integral}@anchor{214b}
@deffn {Classe} numbers.Integral

Estende @ref{1301,,Rational} e adiciona uma conversão para @ref{257,,int}. Fornece padrões para @ref{2f7,,float()}, @ref{279e,,numerator} e @ref{279f,,denominator}. Adiciona métodos abstratos para @ref{9da,,pow()} com operações de módulo e de string de bits: @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}, @code{~}.
@end deffn

@node Notas para implementadores de tipos,,A torre numérica,numbers — Classes base abstratas numéricas
@anchor{library/numbers notes-for-type-implementers}@anchor{27a0}
@subsubsection Notas para implementadores de tipos


Os implementadores devem ter o cuidado de tornar iguais números iguais e fazer hash deles com os mesmos valores. Isso pode ser sutil se houver duas extensões diferentes dos números reais. Por exemplo, @ref{1e7,,fractions.Fraction} implementa @ref{5eb,,hash()} desta forma:

@example
def __hash__(self):
    if self.denominator == 1:
        # Obtém inteiros corretamente.
        return hash(self.numerator)
    # Verificação custosa, mas certamente correta.
    if self == float(self):
        return hash(float(self))
    else:
        # Use o hash da tupla para evitar uma alta taxa de colisão
        # em frações simples.
        return hash((self.numerator, self.denominator))
@end example

@menu
* Adicionando mais ABCs numéricas:: 
* Implementando as operações aritméticas:: 

@end menu

@node Adicionando mais ABCs numéricas,Implementando as operações aritméticas,,Notas para implementadores de tipos
@anchor{library/numbers adding-more-numeric-abcs}@anchor{27a1}
@subsubsection Adicionando mais ABCs numéricas


Existem, é claro, mais ABCs possíveis para números, e isso seria uma hierarquia pobre se excluísse a possibilidade de adicioná-los. Você pode adicionar @code{MyFoo} entre @ref{279a,,Complex} e @ref{232b,,Real} com:

@example
class MyFoo(Complex): ...
MyFoo.register(Real)
@end example

@node Implementando as operações aritméticas,,Adicionando mais ABCs numéricas,Notas para implementadores de tipos
@anchor{library/numbers id1}@anchor{27a2}@anchor{library/numbers implementing-the-arithmetic-operations}@anchor{2078}
@subsubsection Implementando as operações aritméticas


Queremos implementar as operações aritméticas de forma que as operações de modo misto chamem uma implementação cujo autor conhecia os tipos de ambos os argumentos ou convertam ambos para o tipo embutido mais próximo e façam a operação lá. Para subtipos de @ref{214b,,Integral}, isso significa que @ref{2121,,__add__()} e @ref{2122,,__radd__()} devem ser definidos com:

@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

Existem 5 casos diferentes para uma operação de tipo misto em subclasses de @ref{279a,,Complex}. Vou me referir a todo o código acima que não se refere a @code{MyIntegral} e @code{OtherTypeIKnowAbout} com um “modelo”. @code{a} será uma instância de @code{A}, que é um subtipo de @ref{279a,,Complex} (@code{a : A <: Complex}) e @code{b : B <: Complex}. Vou considerar @code{a + b}:


@enumerate 

@item 
Se @code{A} define um @ref{2121,,__add__()}, que aceita @code{b}, está tudo bem.

@item 
Se @code{A} voltar ao código padrão e tivesse que retornar um valor de @ref{2121,,__add__()}, perderíamos a possibilidade de que @code{B} definisse um @ref{2122,,__radd__()} mais inteligente, então o código padrão deve retornar @ref{7d3,,NotImplemented} de @code{__add__()}. (Ou @code{A} pode não implementar @code{__add__()}.)

@item 
Então, @ref{2122,,__radd__()} do @code{B} consegue uma chance. Se ele aceitar @code{a}, está tudo bem.

@item 
Se ele recorrer ao padrão, não há mais métodos possíveis para tentar, então é aqui que a implementação padrão deve residir.

@item 
Se @code{B <: A}, Python tenta @code{B.__radd__} antes de @code{A.__add__}. Isso está ok, porque foi implementado com conhecimento de @code{A}, então ele pode lidar com essas instâncias antes de delegar para @ref{279a,,Complex}.
@end enumerate

Se @code{A <: Complex} e @code{B <: Real} sem compartilhar nenhum outro conhecimento, então a operação compartilhada apropriada é aquela envolvendo a @ref{2f8,,complex} embutida, e @ref{2122,,__radd__()} de ambos chegam lá, de forma que @code{a+b == b+a}.

Como a maioria das operações em qualquer tipo será muito semelhante, pode ser útil definir uma função auxiliar que gera as instâncias de avanço e reversão de qualquer operador. Por exemplo, @ref{1e7,,fractions.Fraction} usa:

@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):
            # Inclui 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 — Funções matemáticas,cmath — Funções matemáticas para números complexos,numbers — Classes base abstratas numéricas,Módulos Matemáticos e Numéricos
@anchor{library/math doc}@anchor{27a3}@anchor{library/math math-mathematical-functions}@anchor{27a4}@anchor{library/math module-math}@anchor{8e}@anchor{library/math translation-repo}@anchor{27a5}
@subsection @code{math} — Funções matemáticas


@geindex module; math

@c from math import fsum


__________________________________________________________________


Este módulo fornece acesso à constantes e funções matemáticas comuns, incluindo aquelas definidas pelo padrão C.

Essas funções não podem ser usadas com números complexos; use as funções de mesmo nome do módulo @ref{18,,cmath} se você precisar de suporte para números complexos. A distinção entre funções que suportam números complexos e aquelas que não suportam é feita uma vez que a maioria dos usuários não quer aprender a matemática necessária para entender números complexos. Receber uma exceção em vez de um resultado complexo permite a detecção antecipada do número complexo inesperado usado como parâmetro, para que o programador possa determinar como e por que ele foi gerado em primeiro lugar.

As funções a seguir são fornecidas por este módulo. Exceto quando explicitamente indicado de outra forma, todos os valores de retorno são pontos flutuantes.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

`Funções de teoria dos números'

@tab

@item

@ref{6d0,,comb(n@comma{} k)}

@tab

Número de maneiras de escolher `k' itens a partir de `n' itens sem repetição e sem ordem

@item

@ref{94e,,factorial(n)}

@tab

Fatorial de `n'

@item

@ref{916,,gcd(*integers)}

@tab

Máximo divisor comum dos argumentos inteiros

@item

@ref{a0d,,isqrt(n)}

@tab

Raiz quadrada inteira de um inteiro não negativo `n'

@item

@ref{917,,lcm(*integers)}

@tab

Mínimo múltiplo comum dos argumentos inteiros

@item

@ref{6d1,,perm(n@comma{} k)}

@tab

Número de maneiras de escolher `k' itens de `n' itens sem repetição e com ordem

@item

`Arimética de ponto flutuante'

@tab

@item

@ref{1405,,ceil(x)}

@tab

Teto de `x', o menor número inteiro maior ou igual a `x'

@item

@ref{27a6,,fabs(x)}

@tab

Valor absoluto de `x'

@item

@ref{1404,,floor(x)}

@tab

Piso de `x', o maior inteiro menor ou igual a `x'

@item

@ref{205,,fma(x@comma{} y@comma{} z)}

@tab

Operação de multiplicação e adição combinadas: @code{(x * y) + z}

@item

@ref{21fd,,fmod(x@comma{} y)}

@tab

Resto da divisão @code{x / y}

@item

@ref{27a7,,modf(x)}

@tab

Partes fracionárias e inteiras de `x'

@item

@ref{b68,,remainder(x@comma{} y)}

@tab

Resto de `x' em relação a `y'

@item

@ref{1406,,trunc(x)}

@tab

Parte inteira de `x'

@item

`Funções de manipulação de ponto flutuante'

@tab

@item

@ref{141a,,copysign(x@comma{} y)}

@tab

Magnitude (valor absoluto) de `x' com o sinal de `y'

@item

@ref{27a8,,frexp(x)}

@tab

Mantissa e expoente de `x'

@item

@ref{dd8,,isclose(a@comma{} b@comma{} rel_tol@comma{} abs_tol)}

@tab

Verifica se os valores `a' e `b' estão próximos um do outro

@item

@ref{122b,,isfinite(x)}

@tab

Verifica se `x' não é infinito e nem um NaN

@item

@ref{1418,,isinf(x)}

@tab

Verifica se `x' é um infinito positivo ou negativo

@item

@ref{1419,,isnan(x)}

@tab

Verifica se `x' é um NaN (não um número)

@item

@ref{162b,,ldexp(x@comma{} i)}

@tab

@code{x * (2**i)}, inverso da função @ref{27a8,,frexp()}

@item

@ref{498,,nextafter(x@comma{} y@comma{} steps)}

@tab

Valor de ponto flutuante de `steps' passos depois de `x' em direção a `y'

@item

@ref{918,,ulp(x)}

@tab

Valor do bit menos significativo de `x'

@item

`Funções de potências, exponenciais e logarítmicas'

@tab

@item

@ref{661,,cbrt(x)}

@tab

Raiz cúbica de `x'

@item

@ref{1358,,exp(x)}

@tab

`e' elevado à potência `x'

@item

@ref{660,,exp2(x)}

@tab

`2' elevado a potência de `x'

@item

@ref{122c,,expm1(x)}

@tab

`e' elevado a potência de `x', menos 1

@item

@ref{1508,,log(x@comma{} base)}

@tab

Logaritmo de `x' para a base fornecida (`e' por padrão)

@item

@ref{141f,,log1p(x)}

@tab

Logaritmo natural de `1+x' (base `e')

@item

@ref{111a,,log2(x)}

@tab

Logaritmo de base 2 de `x'

@item

@ref{27a9,,log10(x)}

@tab

Logaritmo de base 10 de `x'

@item

@ref{662,,pow(x@comma{} y)}

@tab

`x' elevado à potência `y'

@item

@ref{a0e,,sqrt(x)}

@tab

Raiz quadrada de `x'

@item

`Funções de soma e produto'

@tab

@item

@ref{a0a,,dist(p@comma{} q)}

@tab

Distância euclidiana entre dois pontos `p' e `q' dada como um iterável de coordenadas

@item

@ref{141b,,fsum(iterable)}

@tab

Soma dos valores na entrada `iterable'

@item

@ref{a0b,,hypot(*coordinates)}

@tab

Norma euclidiana de um iterável de coordenadas

@item

@ref{a0c,,prod(iterable@comma{} start)}

@tab

Produto de elementos da entrada `iterable' com um valor `start'

@item

@ref{497,,sumprod(p@comma{} q)}

@tab

Soma dos produtos de dois iteráveis `p' e `q'

@item

`Conversão angular'

@tab

@item

@ref{27aa,,degrees(x)}

@tab

Converte o ângulo `x' de radianos para graus

@item

@ref{27ab,,radians(x)}

@tab

Converte o ângulo `x' de graus para radianos

@item

`Funções trigonométricas'

@tab

@item

@ref{27ac,,acos(x)}

@tab

Arco cosseno de `x'

@item

@ref{27ad,,asin(x)}

@tab

Arco seno de `x'/

@item

@ref{27ae,,atan(x)}

@tab

Arco tangente de `x'

@item

@ref{27af,,atan2(y@comma{} x)}

@tab

@code{atan(y / x)}

@item

@ref{1507,,cos(x)}

@tab

Cosseno de `x'

@item

@ref{1506,,sin(x)}

@tab

Seno de `x'

@item

@ref{27b0,,tan(x)}

@tab

Tangente de `x'

@item

`Funções hiperbólicas'

@tab

@item

@ref{141c,,acosh(x)}

@tab

Cosseno hiperbólico inverso de `x'

@item

@ref{141d,,asinh(x)}

@tab

Seno hiperbólico inverso de `x'

@item

@ref{141e,,atanh(x)}

@tab

Tangente hiperbólico inverso de `x'

@item

@ref{27b1,,cosh(x)}

@tab

Cosseno hiperbólico de `x'

@item

@ref{27b2,,sinh(x)}

@tab

Seno hiperbólico de `x'

@item

@ref{27b3,,tanh(x)}

@tab

Tangente hiperbólico de `x'

@item

`Funções especiais'

@tab

@item

@ref{bf3,,erf(x)}

@tab

Função erro@footnote{https://pt.wikipedia.org/wiki/Função_erro} em `x'

@item

@ref{bf4,,erfc(x)}

@tab

Função erro complementar@footnote{https://pt.wikipedia.org/wiki/Função_erro} em `x'

@item

@ref{122d,,gamma(x)}

@tab

Função gama@footnote{https://pt.wikipedia.org/wiki/Função_gama} em `x'

@item

@ref{122e,,lgamma(x)}

@tab

Logaritmo natural do valor absoluto da função gama@footnote{https://pt.wikipedia.org/wiki/Função_gama} em `x'

@item

`Constantes'

@tab

@item

@ref{27b4,,pi}

@tab

`π' = 3.141592…

@item

@ref{27b5,,e}

@tab

`e' = 2.718281…

@item

@ref{27b6,,tau}

@tab

`τ' = 2`π' = 6.283185…

@item

@ref{ca1,,inf}

@tab

Infinito positivo

@item

@ref{663,,nan}

@tab

“Not a number” (NaN)

@end multitable


@menu
* Funções de teoria dos números:: 
* Arimética de ponto flutuante:: 
* Funções de manipulação de ponto flutuante:: 
* Funções de potências@comma{} exponenciais e logarítmicas: Funções de potências exponenciais e logarítmicas. 
* Funções de soma e produto:: 
* Conversão angular:: 
* Funções trigonométricas:: 
* Funções hiperbólicas:: 
* Funções especiais:: 
* Constantes: Constantes<2>. 

@end menu

@node Funções de teoria dos números,Arimética de ponto flutuante,,math — Funções matemáticas
@anchor{library/math number-theoretic-functions}@anchor{27b7}
@subsubsection Funções de teoria dos números


@geindex comb() (no módulo math)
@anchor{library/math math comb}@anchor{6d0}
@deffn {Função} math.comb (n, k)

Retorna o número de maneiras de escolher `k' itens de `n' itens sem repetição e sem ordem.

Avalia para @code{n! / (k! * (n - k)!)} quando @code{k <= n} e avalia para zero quando @code{k > n}.

Também conhecido como coeficiente binomial pois equivale ao coeficiente do k-ésimo termo na expansão polinomial @code{(1 + x)ⁿ}

Levanta @ref{2c3,,TypeError} se algum dos argumentos não for inteiro. Levanta @ref{202,,ValueError} se algum dos argumentos for negativo.


Adicionado na versão 3.8.

@end deffn

@geindex factorial() (no módulo math)
@anchor{library/math math factorial}@anchor{94e}
@deffn {Função} math.factorial (n)

Retorna fatorial do inteiro não negativo `n'.


Alterado na versão 3.10: Números de ponto flutuate com valor integral (como @code{5.0}) não são mais aceitos.

@end deffn

@geindex gcd() (no módulo math)
@anchor{library/math math gcd}@anchor{916}
@deffn {Função} math.gcd (*integers)

Retorna o maior divisor comum dos argumentos inteiros especificados. Se algum dos argumentos for diferente de zero, o valor retornado será o maior inteiro positivo que é um divisor de todos os argumentos. Se todos os argumentos forem zero, o valor retornado será @code{0}. @code{gcd()} sem argumentos retorna @code{0}.


Adicionado na versão 3.5.



Alterado na versão 3.9: Adicionado suporte para um número arbitrário de argumentos. Anteriormente, apenas dois argumentos eram suportados.

@end deffn

@geindex isqrt() (no módulo math)
@anchor{library/math math isqrt}@anchor{a0d}
@deffn {Função} math.isqrt (n)

Retorna a raiz quadrada inteira do inteiro não negativo `n'. Este é o piso da raiz quadrada exata de `n', ou equivalentemente o maior inteiro `a' tal que `a'² ≤ `n'.

Para algumas aplicações, pode ser mais conveniente ter o menor número inteiro `a' tal que `n' ≤ `a'² ou, em outras palavras, o teto da raiz quadrada exata de `n'. Para `n' positivo, isso pode ser calculado usando @code{a = 1 + isqrt(n - 1)}.


Adicionado na versão 3.8.

@end deffn

@geindex lcm() (no módulo math)
@anchor{library/math math lcm}@anchor{917}
@deffn {Função} math.lcm (*integers)

Retorna o mínimo múltiplo comum dos argumentos inteiros especificados. Se todos os argumentos forem diferentes de zero, o valor retornado será o menor inteiro positivo que é um múltiplo de todos os argumentos. Se algum dos argumentos for zero, o valor retornado será @code{0}. @code{lcm()} sem argumentos retorna @code{1}.


Adicionado na versão 3.9.

@end deffn

@geindex perm() (no módulo math)
@anchor{library/math math perm}@anchor{6d1}
@deffn {Função} math.perm (n, k=None)

Retorna o número de maneiras de escolher `k' itens de `n' itens sem repetição e com ordem.

Avalia para @code{n! / (n - k)!} quando @code{k <= n} e avalia para zero quando @code{k > n}.

Se `k' não for especificado ou for @code{None}, `k' usará o padrão `n' e a função retornará @code{n!}.

Levanta @ref{2c3,,TypeError} se algum dos argumentos não for inteiro. Levanta @ref{202,,ValueError} se algum dos argumentos for negativo.


Adicionado na versão 3.8.

@end deffn

@node Arimética de ponto flutuante,Funções de manipulação de ponto flutuante,Funções de teoria dos números,math — Funções matemáticas
@anchor{library/math floating-point-arithmetic}@anchor{27b8}
@subsubsection Arimética de ponto flutuante


@geindex ceil() (no módulo math)
@anchor{library/math math ceil}@anchor{1405}
@deffn {Função} math.ceil (x)

Retorna o teto de `x', o menor inteiro maior ou igual que `x'. Se `x' não é um float, delega para @ref{214a,,x.__ceil__}, que deve retornar um valor do tipo @ref{214b,,Integral}.
@end deffn

@geindex fabs() (no módulo math)
@anchor{library/math math fabs}@anchor{27a6}
@deffn {Função} math.fabs (x)

Retorna o valor absoluto de `x'.
@end deffn

@geindex floor() (no módulo math)
@anchor{library/math math floor}@anchor{1404}
@deffn {Função} math.floor (x)

Retorna o chão de `x', o maior inteiro menor ou igual a `x'. Se `x' não é um ponto flutuante, delega para @ref{2149,,x.__floor__}, que deve retornar um valor do tipo @ref{214b,,Integral}
@end deffn

@geindex fma() (no módulo math)
@anchor{library/math math fma}@anchor{205}
@deffn {Função} math.fma (x, y, z)

Operação de multiplicação-adição combinada. Retorna @code{(x * y) + z}, calculado de forma a obter o mesmo resultado que seria obtido se o cálculo desfrutasse de precisão e limites infinitos, seguido de um único arredondamento para o formato @code{float}. Esta operação frequentemente oferece acurácia melhor do que a expressão direta @code{(x * y) + z} ofereceria.

Esta função segue a especificação da operação fusedMultiplyAdd descrita no padrão IEEE 754. O padrão deixa um caso a ser definido pela implementação, que são os resultados de @code{fma(0, inf, nan)} e @code{fma(inf, 0, nan)}. Nestes casos, @code{math.fma} retorna NaN, e não levanta nenhuma exceção.


Adicionado na versão 3.13.

@end deffn

@geindex fmod() (no módulo math)
@anchor{library/math math fmod}@anchor{21fd}
@deffn {Função} math.fmod (x, y)

Retorna o resto ponto flutuante de @code{x / y}, conforme definido pela função @code{fmod(x, y)} da biblioteca C da plataforma. Observe que a expressão Python @code{x % y} pode não retornar o mesmo resultado. A intenção do padrão C é que @code{fmod(x, y)} seja exatamente (matematicamente; com precisão infinita) igual a @code{x - n*y} para algum inteiro `n' de modo que o resultado tenha o mesmo sinal que `x' e magnitude menor que @code{abs(y)}. O @code{x % y} do Python retorna um resultado com o sinal de `y', e pode não ser exatamente computável para argumentos de ponto flutuante. Por exemplo, @code{fmod(-1e-100, 1e100)} é @code{-1e-100}, mas o resultado de @code{-1e-100 % 1e100} do Python é @code{1e100-1e-100}, que não pode ser representado exatamente como um ponto flutuante, e é arredondado para o surpreendente @code{1e100}. Por esta razão, a função @ref{21fd,,fmod()} é geralmente preferida ao trabalhar com pontos flutuantes, enquanto o @code{x % y} do Python é preferido ao trabalhar com inteiros.
@end deffn

@geindex modf() (no módulo math)
@anchor{library/math math modf}@anchor{27a7}
@deffn {Função} math.modf (x)

Retorna as partes fracionárias e inteiras de `x'. Ambos os resultados carregam o sinal de `x' e são pontos flutuantes.

Observe que @ref{27a7,,modf()} tem um padrão de chamada/retorno diferente de seu equivalente C: elas pegam um único argumento e retornam um par de valores, ao invés de retornar seu segundo valor de retorno por meio de um “parâmetro de saída” (não existe tal coisa em Python).
@end deffn

@geindex remainder() (no módulo math)
@anchor{library/math math remainder}@anchor{b68}
@deffn {Função} math.remainder (x, y)

Retorna o resto no estilo IEEE 754 de `x' em relação a `y'. Para o finito `x' e o finito diferente de zero `y', esta é a diferença @code{x - n*y}, onde @code{n} é o número inteiro mais próximo do valor exato do quociente @code{x / y} . Se @code{x / y} está exatamente no meio do caminho entre dois inteiros consecutivos, o inteiro `par' mais próximo é usado para @code{n}. O resto @code{r = remainder(x, y)} assim sempre satisfaz @code{abs(r) <= 0.5 * abs(y)}.

Casos especiais seguem IEEE 754: em particular, @code{remainder(x, math.inf)} é `x' para qualquer `x' finito, e @code{remainder(x, 0)} e @code{remainder(math.inf, x)} levantam @ref{202,,ValueError} para qualquer `x' não NaN. Se o resultado da operação @code{remainder} for zero, esse zero terá o mesmo sinal de `x'.

Em plataformas que usam ponto flutuante binário do IEEE 754, o resultado dessa operação é sempre exatamente representável: nenhum erro de arredondamento é introduzido.


Adicionado na versão 3.7.

@end deffn

@geindex trunc() (no módulo math)
@anchor{library/math math trunc}@anchor{1406}
@deffn {Função} math.trunc (x)

Retorna `x' com a parte fracionária removida, deixando a parte inteira. Isso arredonda para 0: @code{trunc()} é equivalente a @ref{1404,,floor()} para `x' positivos, e equivalentes a @ref{1405,,ceil()} para `x' negativos. Se `x' não é um ponto flutuante, então delega para @ref{71b,,x.__trunc__}, cujo qual deve retornar um valor do tipo @ref{214b,,Integral}.
@end deffn

Para as funções @ref{1405,,ceil()}, @ref{1404,,floor()} e @ref{27a7,,modf()}, observe que `todos' os números de ponto flutuante de magnitude suficientemente grande são inteiros exatos. Os pontos flutuantes do Python normalmente não carregam mais do que 53 bits de precisão (o mesmo que o tipo duplo da plataforma C), caso em que qualquer ponto flutuante `x' com @code{abs(x) >= 2**52} necessariamente não tem bits fracionários.

@node Funções de manipulação de ponto flutuante,Funções de potências exponenciais e logarítmicas,Arimética de ponto flutuante,math — Funções matemáticas
@anchor{library/math floating-point-manipulation-functions}@anchor{27b9}
@subsubsection Funções de manipulação de ponto flutuante


@geindex copysign() (no módulo math)
@anchor{library/math math copysign}@anchor{141a}
@deffn {Função} math.copysign (x, y)

Retorna um ponto flutuante com a magnitude (valor absoluto) de `x', mas o sinal de `y'. Em plataformas que suportam zeros com sinal, @code{copysign(1.0, -0.0)} retorna `-1.0'.
@end deffn

@geindex frexp() (no módulo math)
@anchor{library/math math frexp}@anchor{27a8}
@deffn {Função} math.frexp (x)

Retorna a mantissa e o expoente de `x' como o par @code{(m, e)}. `m' é um ponto flutuante e `e' é um inteiro tal que @code{x == m * 2**e} exatamente. Se `x' for zero, retorna @code{(0.0, 0)}, caso contrário, @code{0.5 <= abs(m) < 1}. Isso é usado para “separar” a representação interna de um ponto flutuante de forma portátil.

Observe que @ref{27a8,,frexp()} tem um padrão de chamada/retorno diferente de seu equivalente C: elas pegam um único argumento e retornam um par de valores, ao invés de retornar seu segundo valor de retorno por meio de um “parâmetro de saída” (não existe tal coisa em Python).
@end deffn

@geindex isclose() (no módulo math)
@anchor{library/math math isclose}@anchor{dd8}
@deffn {Função} math.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

Retorna @code{True} se os valores `a' e `b' estiverem próximos e @code{False} caso contrário.

Se dois valores são considerados próximos ou não é determinado de acordo com tolerâncias absolutas e relativas fornecidas. Se nenhum erro ocorrer, o resultado será: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}.

`rel_tol' é a tolerância relativa – é a diferença máxima permitida entre `a' e `b', em relação ao maior valor absoluto de `a' ou `b'. Por exemplo, para definir uma tolerância de 5%, passe @code{rel_tol=0.05}. A tolerância padrão é @code{1e-09}, o que garante que os dois valores sejam iguais em cerca de 9 dígitos decimais. `rel_tol' deve ser não negativo e menor que @code{1.0}.

`abs_tol' é a tolerância absoluta; o padrão é @code{0.0} e deve ser não negativo. Ao comparar @code{x} com @code{0.0}, @code{isclose(x, 0)} é computado como @code{abs(x) <= rel_tol * abs(x)}, que é @code{False} para qualquer @code{x} não zero e `rel_tol' menor que @code{1.0}. Então adicione um argumento `abs_tol' positivo apropriado à chamada.

Os valores especiais do IEEE 754 de @code{NaN}, @code{inf} e @code{-inf} serão tratados de acordo com as regras do IEEE. Especificamente, @code{NaN} não é considerado próximo a qualquer outro valor, incluindo @code{NaN}. @code{inf} e @code{-inf} são considerados apenas próximos a si mesmos.


Adicionado na versão 3.5.



@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} – Uma função para testar igualdade aproximada

@end deffn

@geindex isfinite() (no módulo math)
@anchor{library/math math isfinite}@anchor{122b}
@deffn {Função} math.isfinite (x)

Retorna @code{True} se `x' não for um infinito nem um NaN, e @code{False} caso contrário.  (Observe que @code{0.0} `é' considerado finito.)


Adicionado na versão 3.2.

@end deffn

@geindex isinf() (no módulo math)
@anchor{library/math math isinf}@anchor{1418}
@deffn {Função} math.isinf (x)

Retorna @code{True} se `x' for um infinito positivo ou negativo, e @code{False} caso contrário.
@end deffn

@geindex isnan() (no módulo math)
@anchor{library/math math isnan}@anchor{1419}
@deffn {Função} math.isnan (x)

Retorna @code{True} se `x' for um NaN (não um número), e @code{False} caso contrário.
@end deffn

@geindex ldexp() (no módulo math)
@anchor{library/math math ldexp}@anchor{162b}
@deffn {Função} math.ldexp (x, i)

Retorna @code{x * (2**i)}. Este é essencialmente o inverso da função @ref{27a8,,frexp()}.
@end deffn

@geindex nextafter() (no módulo math)
@anchor{library/math math nextafter}@anchor{498}
@deffn {Função} math.nextafter (x, y, steps=1)

Retorna o valor de ponto flutuante com `steps' passos após `x' em direção a `y'.

Se `x' for igual a `y', retorna `y', a menos que `steps' seja zero.

Exemplos:


@itemize *

@item 
@code{math.nextafter(x, math.inf)} sobe: em direção ao infinito positivo.

@item 
@code{math.nextafter(x, -math.inf)} desce: em direção ao menos infinito.

@item 
@code{math.nextafter(x, 0.0)} vai em direção a zero.

@item 
@code{math.nextafter(x, math.copysign(math.inf, x))} se afasta do zero.
@end itemize

Veja também @code{math.ulp.()}


Adicionado na versão 3.9.



Alterado na versão 3.12: Adicionado o argumento `steps'.

@end deffn

@geindex ulp() (no módulo math)
@anchor{library/math math ulp}@anchor{918}
@deffn {Função} math.ulp (x)

Retorna o valor do bit menos significativo do ponto flutuante `x':


@itemize *

@item 
Se `x' for um NaN (não um número), retorna `x'.

@item 
Se `x' for negativo, retorna @code{ulp(-x)}.

@item 
Se `x' for um infinito positivo, retorna `x'.

@item 
Se `x' for igual a zero, retorna o menor valor flutuante positivo `desnormalizado' representável (menor que o ponto flutuante de valor mínimo positivo `normalizado', @ref{1b62,,sys.float_info.min}).

@item 
Se `x' for igual ao maior ponto flutuante positivo representável, retorna o valor do bit menos significativo de `x', tal que o primeiro ponto flutuante menor que `x' seja @code{x - ulp(x)}.

@item 
Caso contrário (`x' é um número finito positivo), retorna o valor do bit menos significativo de `x', de modo que o primeiro ponto flutuante maior que `x' seja @code{x + ulp(x)}.
@end itemize

ULP significa “Unit in the Last Place” ou, em português, unidade na última posição.

Veja também @ref{498,,math.nextafter()} e @ref{1b62,,sys.float_info.epsilon}.


Adicionado na versão 3.9.

@end deffn

@node Funções de potências exponenciais e logarítmicas,Funções de soma e produto,Funções de manipulação de ponto flutuante,math — Funções matemáticas
@anchor{library/math power-exponential-and-logarithmic-functions}@anchor{27ba}
@subsubsection Funções de potências, exponenciais e logarítmicas


@geindex cbrt() (no módulo math)
@anchor{library/math math cbrt}@anchor{661}
@deffn {Função} math.cbrt (x)

Retorna a raiz cúbica de `x'.


Adicionado na versão 3.11.

@end deffn

@geindex exp() (no módulo math)
@anchor{library/math math exp}@anchor{1358}
@deffn {Função} math.exp (x)

Retorna `e' elevado à potência `x', onde `e' = 2.718281… é a base dos logaritmos naturais. Isso geralmente é mais preciso do que @code{math.e ** x} ou @code{pow(math.e, x)}.
@end deffn

@geindex exp2() (no módulo math)
@anchor{library/math math exp2}@anchor{660}
@deffn {Função} math.exp2 (x)

Retorna `2' elevado a `x'


Adicionado na versão 3.11.

@end deffn

@geindex expm1() (no módulo math)
@anchor{library/math math expm1}@anchor{122c}
@deffn {Função} math.expm1 (x)

Retorna `e' elevado à potência `x', menos 1. Aqui `e' é a base dos logaritmos naturais. Para pequenos pontos flutuantes `x', a subtração em @code{exp(x) - 1} pode resultar em uma perda significativa de precisão@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}; a função @ref{122c,,expm1()} fornece uma maneira de calcular essa quantidade com precisão 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


Adicionado na versão 3.2.

@end deffn

@geindex log() (no módulo math)
@anchor{library/math math log}@anchor{1508}
@deffn {Função} math.log (x[, base])

Com um argumento, retorna o logaritmo natural de `x' (para base `e').

Com dois argumentos, retorna o logaritmo de `x' para a `base' fornecida, calculada como @code{log(x)/log(base)}.
@end deffn

@geindex log1p() (no módulo math)
@anchor{library/math math log1p}@anchor{141f}
@deffn {Função} math.log1p (x)

Retorna o logaritmo natural de `1+x' (base `e'). O resultado é calculado de forma precisa para `x' próximo a zero.
@end deffn

@geindex log2() (no módulo math)
@anchor{library/math math log2}@anchor{111a}
@deffn {Função} math.log2 (x)

Retorna o logaritmo de base 2 de `x'. Isso geralmente é mais preciso do que @code{log(x, 2)}.


Adicionado na versão 3.3.



@subsubheading Ver também


@ref{232f,,int.bit_length()} retorna o número de bits necessários para representar um inteiro em binário, excluindo o sinal e os zeros à esquerda.

@end deffn

@geindex log10() (no módulo math)
@anchor{library/math math log10}@anchor{27a9}
@deffn {Função} math.log10 (x)

Retorna o logaritmo de base 10 de `x'. Isso geralmente é mais preciso do que @code{log(x, 10)}.
@end deffn

@geindex pow() (no módulo math)
@anchor{library/math math pow}@anchor{662}
@deffn {Função} math.pow (x, y)

Retorna `x' elevado a potência de `y'. Exceções seguem o padrão IEEE 754 o máximo possível. @code{pow(1.0, x)} e @code{pow(x, 0.0)} em particular sempre retornam @code{1.0}, mesmo quando `x' é ZERO ou NaN. Se ambos `x' e `y' são números finitos, `x' é negativo, e `y' não é um inteiro então @code{pow(x, y)} é indefinido e levanta @ref{202,,ValueError}.

Ao contrário do operador embutido @code{**}, @ref{662,,math.pow()} converte ambos os seus argumentos para o tipo @ref{2f7,,float}. Use @code{**} ou a função embutida @ref{9da,,pow()} para calcular potências inteiras exatas.


Alterado na versão 3.11: Os casos especiais @code{pow(0.0, -inf)} e @code{pow(-0.0, -inf)} foram alterados para retornar @code{inf} ao invés de levantar @ref{202,,ValueError}, para ter consistência com a IEEE 754.

@end deffn

@geindex sqrt() (no módulo math)
@anchor{library/math math sqrt}@anchor{a0e}
@deffn {Função} math.sqrt (x)

Retorna a raiz quadrada de `x'.
@end deffn

@node Funções de soma e produto,Conversão angular,Funções de potências exponenciais e logarítmicas,math — Funções matemáticas
@anchor{library/math summation-and-product-functions}@anchor{27bb}
@subsubsection Funções de soma e produto


@geindex dist() (no módulo math)
@anchor{library/math math dist}@anchor{a0a}
@deffn {Função} math.dist (p, q)

Retorna a distância euclidiana entre dois pontos `p' e `q', cada um dado como uma sequência (ou iterável) de coordenadas. Os dois pontos devem ter a mesma dimensão.

Aproximadamente equivalente a:

@example
sqrt(sum((px - qx) ** 2.0 for px, qx in zip(p, q)))
@end example


Adicionado na versão 3.8.

@end deffn

@geindex fsum() (no módulo math)
@anchor{library/math math fsum}@anchor{141b}
@deffn {Função} math.fsum (iterable)

Retorna uma soma precisa dos valores de ponto flutuante no iterável. Evita perda de precisão rastreando várias somas parciais intermediárias.

A precisão do algoritmo depende das garantias aritméticas do IEEE-754 e do caso típico em que o modo de arredondamento é meio par. Em algumas compilações que não são do Windows, a biblioteca C subjacente usa adição de precisão estendida e pode ocasionalmente arredondar uma soma intermediária fazendo com que ela introduza um erro no bit menos significativo.

Para uma discussão mais aprofundada e duas abordagens alternativas, consulte o 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 hypot() (no módulo math)
@anchor{library/math math hypot}@anchor{a0b}
@deffn {Função} math.hypot (*coordinates)

Retorna a norma euclidiana, @code{sqrt(sum(x**2 for x in coordinates))}. Este é o comprimento do vetor da origem até o ponto dado pelas coordenadas.

Para um ponto bidimensional @code{(x, y)}, isso é equivalente a calcular a hipotenusa de um triângulo retângulo usando o teorema de Pitágoras, @code{sqrt(x*x + y*y)}.


Alterado na versão 3.8: Adicionado suporte para pontos n-dimensionais. Anteriormente, apenas o caso bidimensional era suportado.



Alterado na versão 3.10: Melhorou a precisão do algoritmo para que o erro máximo seja inferior a 1 ulp (unidade no último lugar). Mais tipicamente, o resultado é quase sempre arredondado corretamente para 1/2 ulp.

@end deffn

@geindex prod() (no módulo math)
@anchor{library/math math prod}@anchor{a0c}
@deffn {Função} math.prod (iterable, *, start=1)

Calcula o produto de todos os elementos na entrada `iterable'. O valor `start' padrão para o produto é @code{1}.

Quando o iterável estiver vazio, retorna o valor de start. Esta função deve ser usada especificamente com valores numéricos e pode rejeitar tipos não numéricos.


Adicionado na versão 3.8.

@end deffn

@geindex sumprod() (no módulo math)
@anchor{library/math math sumprod}@anchor{497}
@deffn {Função} math.sumprod (p, q)

Retorna a soma dos produtos dos valores de dois iteráveis `p' e `q'.

Levanta @ref{202,,ValueError} se as entradas não tiverem o mesmo comprimento.

Aproximadamente equivalente a:

@example
sum(itertools.starmap(operator.mul, zip(p, q, strict=True)))
@end example

Para entradas float e mistas int/float, os produtos intermediários e as somas são calculados com precisão estendida.


Adicionado na versão 3.12.

@end deffn

@node Conversão angular,Funções trigonométricas,Funções de soma e produto,math — Funções matemáticas
@anchor{library/math angular-conversion}@anchor{27bc}
@subsubsection Conversão angular


@geindex degrees() (no módulo math)
@anchor{library/math math degrees}@anchor{27aa}
@deffn {Função} math.degrees (x)

Converte o ângulo `x' de radianos para graus.
@end deffn

@geindex radians() (no módulo math)
@anchor{library/math math radians}@anchor{27ab}
@deffn {Função} math.radians (x)

Converte o ângulo `x' de graus para radianos.
@end deffn

@node Funções trigonométricas,Funções hiperbólicas,Conversão angular,math — Funções matemáticas
@anchor{library/math trigonometric-functions}@anchor{27bd}
@subsubsection Funções trigonométricas


@geindex acos() (no módulo math)
@anchor{library/math math acos}@anchor{27ac}
@deffn {Função} math.acos (x)

Retorna o arco cosseno de `x', em radianos. O resultado está entre @code{0} e @code{pi}.
@end deffn

@geindex asin() (no módulo math)
@anchor{library/math math asin}@anchor{27ad}
@deffn {Função} math.asin (x)

Retorna o arco seno de `x', em radianos. O resultado está entre @code{-pi/2} e @code{pi/2}.
@end deffn

@geindex atan() (no módulo math)
@anchor{library/math math atan}@anchor{27ae}
@deffn {Função} math.atan (x)

Retorna o arco tangente de `x', em radianos. O resultado está entre @code{-pi/2} e @code{pi/2}.
@end deffn

@geindex atan2() (no módulo math)
@anchor{library/math math atan2}@anchor{27af}
@deffn {Função} math.atan2 (y, x)

Retorna @code{atan(y / x)}, em radianos. O resultado está entre @code{-pi} e @code{pi}. O vetor no plano da origem ao ponto @code{(x, y)} faz este ângulo com o eixo X positivo. O ponto de @ref{27af,,atan2()} é que os sinais de ambas as entradas são conhecidos por ele, então ele pode calcular o quadrante correto para o ângulo. Por exemplo, @code{atan(1)} e @code{atan2(1, 1)} são ambos @code{pi/4}, mas @code{atan2(-1, -1)} é @code{-3*pi/4}.
@end deffn

@geindex cos() (no módulo math)
@anchor{library/math math cos}@anchor{1507}
@deffn {Função} math.cos (x)

Retorna o cosseno de `x' radianos.
@end deffn

@geindex sin() (no módulo math)
@anchor{library/math math sin}@anchor{1506}
@deffn {Função} math.sin (x)

Retorna o seno de `x' radianos.
@end deffn

@geindex tan() (no módulo math)
@anchor{library/math math tan}@anchor{27b0}
@deffn {Função} math.tan (x)

Retorna o tangente de `x' radianos.
@end deffn

@node Funções hiperbólicas,Funções especiais,Funções trigonométricas,math — Funções matemáticas
@anchor{library/math hyperbolic-functions}@anchor{27be}
@subsubsection Funções hiperbólicas


Funções hiperbólicas@footnote{https://en.wikipedia.org/wiki/Hyperbolic_functions} são análogas às funções trigonométricas baseadas em hipérboles em vez de círculos.

@geindex acosh() (no módulo math)
@anchor{library/math math acosh}@anchor{141c}
@deffn {Função} math.acosh (x)

Retorna o cosseno hiperbólico inverso de `x'.
@end deffn

@geindex asinh() (no módulo math)
@anchor{library/math math asinh}@anchor{141d}
@deffn {Função} math.asinh (x)

Retorna o seno hiperbólico inverso de `x'.
@end deffn

@geindex atanh() (no módulo math)
@anchor{library/math math atanh}@anchor{141e}
@deffn {Função} math.atanh (x)

Retorna a tangente hiperbólica inversa de `x'.
@end deffn

@geindex cosh() (no módulo math)
@anchor{library/math math cosh}@anchor{27b1}
@deffn {Função} math.cosh (x)

Retorna o cosseno hiperbólico de `x'.
@end deffn

@geindex sinh() (no módulo math)
@anchor{library/math math sinh}@anchor{27b2}
@deffn {Função} math.sinh (x)

Retorna o seno hiperbólico de `x'.
@end deffn

@geindex tanh() (no módulo math)
@anchor{library/math math tanh}@anchor{27b3}
@deffn {Função} math.tanh (x)

Retorna a tangente hiperbólica de `x'.
@end deffn

@node Funções especiais,Constantes<2>,Funções hiperbólicas,math — Funções matemáticas
@anchor{library/math special-functions}@anchor{27bf}
@subsubsection Funções especiais


@geindex erf() (no módulo math)
@anchor{library/math math erf}@anchor{bf3}
@deffn {Função} math.erf (x)

Retorna a função erro@footnote{https://pt.wikipedia.org/wiki/Função_erro} em `x'.

A função @ref{bf3,,erf()} pode ser usada para calcular funções estatísticas tradicionais, como a distribuição normal padrão cumulativa@footnote{https://en.wikipedia.org/wiki/Cumulative_distribution_function}:

@example
def phi(x):
    'Função de distribuição cumulativa para a distribuição normal padrão.'
    return (1.0 + erf(x / sqrt(2.0))) / 2.0
@end example


Adicionado na versão 3.2.

@end deffn

@geindex erfc() (no módulo math)
@anchor{library/math math erfc}@anchor{bf4}
@deffn {Função} math.erfc (x)

Retorna a função erro complementar em `x'. A função erro complementar@footnote{https://en.wikipedia.org/wiki/Error_function} é definida como @code{1.0 - erf(x)}. É usado para grandes valores de `x' onde uma subtração de um causaria uma perda de significância@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}.


Adicionado na versão 3.2.

@end deffn

@geindex gamma() (no módulo math)
@anchor{library/math math gamma}@anchor{122d}
@deffn {Função} math.gamma (x)

Retorna a função gama@footnote{https://pt.wikipedia.org/wiki/Função_gama} em `x'.


Adicionado na versão 3.2.

@end deffn

@geindex lgamma() (no módulo math)
@anchor{library/math math lgamma}@anchor{122e}
@deffn {Função} math.lgamma (x)

Retorna o logaritmo natural do valor absoluto da função gama em `x'.


Adicionado na versão 3.2.

@end deffn

@node Constantes<2>,,Funções especiais,math — Funções matemáticas
@anchor{library/math constants}@anchor{27c0}
@subsubsection Constantes


@geindex pi (no módulo math)
@anchor{library/math math pi}@anchor{27b4}
@deffn {Dado} math.pi

A constante matemática `π' = 3.141592…, para a precisão disponível.
@end deffn

@geindex e (no módulo math)
@anchor{library/math math e}@anchor{27b5}
@deffn {Dado} math.e

A constante matemática `e' = 2.718281…, para a precisão disponível.
@end deffn

@geindex tau (no módulo math)
@anchor{library/math math tau}@anchor{27b6}
@deffn {Dado} math.tau

A constante matemática `τ' = 6.283185…, para a precisão disponível. Tau é uma constante de círculo igual a 2`π', a razão entre a circunferência de um círculo e seu raio. Para saber mais sobre Tau, confira o vídeo Pi is (still) Wrong@footnote{https://vimeo.com/147792667} de Vi Hart, e comece a comemorar o dia do Tau@footnote{https://tauday.com/} comendo duas vezes mais torta!


Adicionado na versão 3.6.

@end deffn

@geindex inf (no módulo math)
@anchor{library/math math inf}@anchor{ca1}
@deffn {Dado} math.inf

Um infinito positivo de ponto flutuante. (Para infinito negativo, use @code{-math.inf}.) Equivalente à saída de @code{float('inf')}.


Adicionado na versão 3.5.

@end deffn

@geindex nan (no módulo math)
@anchor{library/math math nan}@anchor{663}
@deffn {Dado} math.nan

Um valor de ponto flutuante “não é um número” (NaN). Equivalente à saída de @code{float('nan')}. Devido aos requisitos do padrão IEEE-754@footnote{https://en.wikipedia.org/wiki/IEEE_754}, @code{math.nan} e @code{float('nan')} não são considerados para ser igual a qualquer outro valor numérico, incluindo eles próprios. Para verificar se um número é NaN, use a função @ref{1419,,isnan()} para testar NaNs em vez de @code{is} ou @code{==}. Exemplo:

@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


Adicionado na versão 3.5.



Alterado na versão 3.11: Agora está sempre disponível

@end deffn

O módulo @ref{8e,,math} consiste principalmente em invólucros finos em torno das funções da biblioteca matemática C da plataforma. O comportamento em casos excepcionais segue o Anexo F da norma C99 quando apropriado. A implementação atual levantará @ref{202,,ValueError} para operações inválidas como @code{sqrt(-1.0)} ou @code{log(0.0)} (onde C99 Anexo F recomenda sinalizar operação inválida ou divisão por zero), e @ref{885,,OverflowError} para resultados que estouram (por exemplo, @code{exp(1000.0)}). Um NaN não será retornado de nenhuma das funções acima, a menos que um ou mais dos argumentos de entrada sejam um NaN; nesse caso, a maioria das funções retornará um NaN, mas (novamente seguindo C99 Anexo F) há algumas exceções a esta regra, por exemplo, @code{pow(float('nan'), 0.0)} ou @code{hypot(float('nan'), float('inf'))}.

Observe que o Python não faz nenhum esforço para distinguir NaNs de sinalização de NaNs silenciosos, e o comportamento para NaNs de sinalização permanece não especificado. O comportamento típico é tratar todos os NaNs como se estivessem quietos.


@subsubheading Ver também



@table @asis

@item Módulo @ref{18,,cmath}

Versões de números complexos de muitas dessas funções.
@end table


@node cmath — Funções matemáticas para números complexos,decimal — Aritmética de ponto fixo decimal e ponto flutuante,math — Funções matemáticas,Módulos Matemáticos e Numéricos
@anchor{library/cmath doc}@anchor{27c1}@anchor{library/cmath cmath-mathematical-functions-for-complex-numbers}@anchor{27c2}@anchor{library/cmath module-cmath}@anchor{18}@anchor{library/cmath translation-repo}@anchor{27c3}
@subsection @code{cmath} — Funções matemáticas para números complexos


@geindex module; cmath


__________________________________________________________________


Este módulo fornece acesso a funções matemáticas para números complexos. As funções neste módulo aceitam inteiros, números de ponto flutuante ou números complexos como argumentos. Eles também aceitarão qualquer objeto Python que tenha um método @ref{5e7,,__complex__()} ou @ref{9d4,,__float__()}: esses métodos são usados para converter o objeto em um número complexo ou de ponto flutuante, respectivamente, e a função é então aplicada ao resultado da conversão.

@cartouche
@quotation Nota 
Para funções que envolvem cortes de ramificação, temos o problema de decidir como definir essas funções no próprio corte. Seguindo o artigo de Kahan intitulado “Branch cuts for complex elementary functions” (em tradução livre, “Cortes de ramificação para funções complexas elementares”), bem como o Anexo G do C99 e padrões C posteriores, usamos o sinal de zero para distinguir um lado do outro no corte de ramificação: para um corte de ramificação ao longo (de uma porção) do eixo real olhamos para o sinal da parte imaginária, enquanto para um corte de ramificação ao longo do eixo imaginário olhamos para o sinal da parte real.

Por exemplo, a função @ref{27c4,,cmath.sqrt()} tem um corte de ramificação ao longo do eixo real negativo. Um argumento de @code{complex(-2.0, -0.0)} é tratado como se estivesse `abaixo' do corte de ramificação, e assim dá um resultado no eixo imaginário negativo:

@example
>>> cmath.sqrt(complex(-2.0, -0.0))
-1.4142135623730951j
@end example

Mas um argumento de @code{complex(-2.0, 0.0)} é tratado como se estivesse acima do corte de ramificação:

@example
>>> cmath.sqrt(complex(-2.0, 0.0))
1.4142135623730951j
@end example
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

`Conversões de e para coordenadas polares'

@tab

@item

@ref{27c5,,phase(z)}

@tab

Retorna a fase de `z'

@item

@ref{27c6,,polar(z)}

@tab

Retorna a representação de `z' em coordenadas polares

@item

@ref{27c7,,rect(r@comma{} phi)}

@tab

Retorna o número complexo `z' com coordenadas polares `r' e `phi'

@item

`Funções de potência e logarítmicas'

@tab

@item

@ref{27c8,,exp(z)}

@tab

Retorna `e' elevado à potência `z'

@item

@ref{27c9,,log(z[@comma{} base])}

@tab

Retorna o logaritmo de `z' para a `base' fornecida (`e' por padrão)

@item

@ref{27ca,,log10(z)}

@tab

Retorna o logaritmo de base 10 de `z'

@item

@ref{27c4,,sqrt(z)}

@tab

Retorna a raiz quadrada de `z'

@item

`Funções trigonométricas'

@tab

@item

@ref{27cb,,acos(z)}

@tab

Retorna o arco cosseno de `z'

@item

@ref{27cc,,asin(z)}

@tab

Retorna o arco seno de `z'

@item

@ref{27cd,,atan(z)}

@tab

Retorna o arco tangente de `z'

@item

@ref{27ce,,cos(z)}

@tab

Retorna o cosseno de `z'

@item

@ref{27cf,,sin(z)}

@tab

Retorna o seno de `z'

@item

@ref{27d0,,tan(z)}

@tab

Retorna a tangente de `z'

@item

`Funções hiperbólicas'

@tab

@item

@ref{27d1,,acosh(z)}

@tab

Retorna o cosseno hiperbólico inverso de `z'

@item

@ref{27d2,,asinh(z)}

@tab

Retorna o seno hiperbólico inverso de `z'

@item

@ref{27d3,,atanh(z)}

@tab

Retorna a tangente hiperbólica inversa de `z'

@item

@ref{27d4,,cosh(z)}

@tab

Retorna o cosseno hiperbólico de `z'

@item

@ref{27d5,,sinh(z)}

@tab

Retorna o seno hiperbólico de `z'

@item

@ref{27d6,,tanh(z)}

@tab

Retorna a tangente hiperbólica de `z'

@item

`Funções de classificação'

@tab

@item

@ref{27d7,,isfinite(z)}

@tab

Verifica se todos os componentes de `z' são finitos

@item

@ref{27d8,,isinf(z)}

@tab

Verifica se algum componente de `z' é infinito

@item

@ref{27d9,,isnan(z)}

@tab

Verifica se algum componente de `z' é NaN

@item

@ref{dd9,,isclose(a@comma{} b@comma{} *@comma{} rel_tol@comma{} abs_tol)}

@tab

Verifica se os valores `a' e `b' estão próximos um do outro

@item

`Constantes'

@tab

@item

@ref{27da,,pi}

@tab

`π' = 3.141592…

@item

@ref{27db,,e}

@tab

`e' = 2.718281…

@item

@ref{c9e,,tau}

@tab

`τ' = 2`π' = 6.283185…

@item

@ref{c9f,,inf}

@tab

Infinito positivo

@item

@ref{ca2,,infj}

@tab

Infinito imaginário puro

@item

@ref{ca0,,nan}

@tab

“Not a number” (NaN)

@item

@ref{ca3,,nanj}

@tab

NaN imaginário puro

@end multitable


@menu
* Conversões de e para coordenadas polares:: 
* Funções de potência e logarítmicas:: 
* Funções trigonométricas: Funções trigonométricas<2>. 
* Funções hiperbólicas: Funções hiperbólicas<2>. 
* Funções de classificação:: 
* Constantes: Constantes<3>. 

@end menu

@node Conversões de e para coordenadas polares,Funções de potência e logarítmicas,,cmath — Funções matemáticas para números complexos
@anchor{library/cmath conversions-to-and-from-polar-coordinates}@anchor{27dc}
@subsubsection Conversões de e para coordenadas polares


Um número complexo Python @code{z} é armazenado internamente usando coordenadas `retangulares' ou `cartesianas'. É completamente determinado por sua `parte real' @code{z.real} e sua `parte imaginária' @code{z.imag}.

`Coordenadas polares' fornecem uma forma alternativa de representar um número complexo. Em coordenadas polares, um número complexo `z' é definido pelo módulo `r' e pelo ângulo de fase `phi'. O módulo `r' é a distância de `z' à origem, enquanto a fase `phi' é o ângulo anti-horário, medido em radianos, do eixo x positivo ao segmento de reta que une a origem a `z'.

As funções a seguir podem ser usadas para converter coordenadas retangulares nativas em coordenadas polares e vice-versa.

@geindex phase() (no módulo cmath)
@anchor{library/cmath cmath phase}@anchor{27c5}
@deffn {Função} cmath.phase (z)

Retorna a fase de `z' (também conhecido como `argumento' de `z'), como um ponto flutuante. @code{phase(z)} equivale a @code{math.atan2(z.imag, z.real)}. O resultado está no intervalo [-`π', `π'], e o corte de ramificação para esta operação está ao longo do eixo real negativo. O sinal do resultado é igual ao sinal de @code{z.imag}, mesmo quando @code{z.imag} é 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 
O módulo (valor absoluto) de um número complexo `z' pode ser calculado usando a função embutida @ref{1e2d,,abs()}. Não há função do módulo @ref{18,,cmath} separada para esta operação.
@end quotation
@end cartouche

@geindex polar() (no módulo cmath)
@anchor{library/cmath cmath polar}@anchor{27c6}
@deffn {Função} cmath.polar (z)

Retorna a representação de `z' em coordenadas polares. Retorna um par @code{(r, phi)} onde `r' é o módulo de `z' e phi é a fase de `z'. @code{polar(z)} equivale a @code{(abs(z), phase(z))}.
@end deffn

@geindex rect() (no módulo cmath)
@anchor{library/cmath cmath rect}@anchor{27c7}
@deffn {Função} cmath.rect (r, phi)

Retorna o número complexo `z' com coordenadas polares `r' e `phi'. Equivale a @code{complex(r * math.cos(phi), r * math.sin(phi))}.
@end deffn

@node Funções de potência e logarítmicas,Funções trigonométricas<2>,Conversões de e para coordenadas polares,cmath — Funções matemáticas para números complexos
@anchor{library/cmath power-and-logarithmic-functions}@anchor{27dd}
@subsubsection Funções de potência e logarítmicas


@geindex exp() (no módulo cmath)
@anchor{library/cmath cmath exp}@anchor{27c8}
@deffn {Função} cmath.exp (z)

Retorna `e' elevado à potência `z', onde `e' é a base de logaritmos naturais.
@end deffn

@geindex log() (no módulo cmath)
@anchor{library/cmath cmath log}@anchor{27c9}
@deffn {Função} cmath.log (z[, base])

Retorna o logaritmo de `z' para a `base' fornecida. Se a `base' não for especificada, retorna o logaritmo natural de `z'. Há um corte de ramificação, de 0 ao longo do eixo real negativo até -∞.
@end deffn

@geindex log10() (no módulo cmath)
@anchor{library/cmath cmath log10}@anchor{27ca}
@deffn {Função} cmath.log10 (z)

Retorna o logaritmo de `z' na base 10. Este tem o mesmo corte de ramificação que @ref{27c9,,log()}.
@end deffn

@geindex sqrt() (no módulo cmath)
@anchor{library/cmath cmath sqrt}@anchor{27c4}
@deffn {Função} cmath.sqrt (z)

Retorna a raiz quadrada de `z'. Este tem o mesmo corte de ramificação que @ref{27c9,,log()}.
@end deffn

@node Funções trigonométricas<2>,Funções hiperbólicas<2>,Funções de potência e logarítmicas,cmath — Funções matemáticas para números complexos
@anchor{library/cmath trigonometric-functions}@anchor{27de}
@subsubsection Funções trigonométricas


@geindex acos() (no módulo cmath)
@anchor{library/cmath cmath acos}@anchor{27cb}
@deffn {Função} cmath.acos (z)

Retorna o arco cosseno de `z'. Existem dois cortes de ramificação: um se estende desde 1 ao longo do eixo real até ∞. O outro se estende para a esquerda de -1 ao longo do eixo real até -∞.
@end deffn

@geindex asin() (no módulo cmath)
@anchor{library/cmath cmath asin}@anchor{27cc}
@deffn {Função} cmath.asin (z)

Retorna o arco seno de `z'. Tem os mesmos cortes de ramificação que @ref{27cb,,acos()}.
@end deffn

@geindex atan() (no módulo cmath)
@anchor{library/cmath cmath atan}@anchor{27cd}
@deffn {Função} cmath.atan (z)

Retorna o arco tangente de `z'. Existem dois cortes de ramificação: Um se estende de @code{1j} ao longo do eixo imaginário até @code{∞j}. O outro se estende de @code{-1j} ao longo do eixo imaginário até @code{-∞j}.
@end deffn

@geindex cos() (no módulo cmath)
@anchor{library/cmath cmath cos}@anchor{27ce}
@deffn {Função} cmath.cos (z)

Retorna o cosseno de `z'.
@end deffn

@geindex sin() (no módulo cmath)
@anchor{library/cmath cmath sin}@anchor{27cf}
@deffn {Função} cmath.sin (z)

Retorna o seno de `z'.
@end deffn

@geindex tan() (no módulo cmath)
@anchor{library/cmath cmath tan}@anchor{27d0}
@deffn {Função} cmath.tan (z)

Retorna a tangente de `z'.
@end deffn

@node Funções hiperbólicas<2>,Funções de classificação,Funções trigonométricas<2>,cmath — Funções matemáticas para números complexos
@anchor{library/cmath hyperbolic-functions}@anchor{27df}
@subsubsection Funções hiperbólicas


@geindex acosh() (no módulo cmath)
@anchor{library/cmath cmath acosh}@anchor{27d1}
@deffn {Função} cmath.acosh (z)

Retorna o cosseno hiperbólico inverso de `z'. Há um corte de ramificação, estendendo-se para a esquerda de 1 ao longo do eixo real até -∞.
@end deffn

@geindex asinh() (no módulo cmath)
@anchor{library/cmath cmath asinh}@anchor{27d2}
@deffn {Função} cmath.asinh (z)

Retorna o seno hiperbólico inverso de `z'. Existem dois cortes de ramificação: Um se estende de @code{1j} ao longo do eixo imaginário até @code{∞j}. O outro se estende de @code{-1j} ao longo do eixo imaginário até @code{-∞j}.
@end deffn

@geindex atanh() (no módulo cmath)
@anchor{library/cmath cmath atanh}@anchor{27d3}
@deffn {Função} cmath.atanh (z)

Retorna a tangente hiperbólica inversa de `z'. Existem dois cortes de ramificação: Um se estende de @code{1} ao longo do eixo real até @code{∞}. O outro se estende de @code{-1} ao longo do eixo real até @code{-∞}.
@end deffn

@geindex cosh() (no módulo cmath)
@anchor{library/cmath cmath cosh}@anchor{27d4}
@deffn {Função} cmath.cosh (z)

Retorna o cosseno hiperbólico de `z'.
@end deffn

@geindex sinh() (no módulo cmath)
@anchor{library/cmath cmath sinh}@anchor{27d5}
@deffn {Função} cmath.sinh (z)

Retorna o seno hiperbólico de `z'.
@end deffn

@geindex tanh() (no módulo cmath)
@anchor{library/cmath cmath tanh}@anchor{27d6}
@deffn {Função} cmath.tanh (z)

Retorna a tangente hiperbólica de `z'.
@end deffn

@node Funções de classificação,Constantes<3>,Funções hiperbólicas<2>,cmath — Funções matemáticas para números complexos
@anchor{library/cmath classification-functions}@anchor{27e0}
@subsubsection Funções de classificação


@geindex isfinite() (no módulo cmath)
@anchor{library/cmath cmath isfinite}@anchor{27d7}
@deffn {Função} cmath.isfinite (z)

Retorna @code{True} se ambas as partes real e imaginária de `z' forem finitas, e @code{False} caso contrário.


Adicionado na versão 3.2.

@end deffn

@geindex isinf() (no módulo cmath)
@anchor{library/cmath cmath isinf}@anchor{27d8}
@deffn {Função} cmath.isinf (z)

Retorna @code{True} se ou a parte real ou a imaginária de `z' for infinita, e @code{False} caso contrário.
@end deffn

@geindex isnan() (no módulo cmath)
@anchor{library/cmath cmath isnan}@anchor{27d9}
@deffn {Função} cmath.isnan (z)

Retorna @code{True} se ou a parte real ou a imaginária de `z' for NaN, e @code{False} caso contrário.
@end deffn

@geindex isclose() (no módulo cmath)
@anchor{library/cmath cmath isclose}@anchor{dd9}
@deffn {Função} cmath.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

Retorna @code{True} se os valores `a' e `b' estiverem próximos e @code{False} caso contrário.

Se dois valores são considerados próximos ou não é determinado de acordo com tolerâncias absolutas e relativas fornecidas. Se nenhum erro ocorrer, o resultado será: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}.

`rel_tol' é a tolerância relativa – é a diferença máxima permitida entre `a' e `b', em relação ao maior valor absoluto de `a' ou `b'. Por exemplo, para definir uma tolerância de 5%, passe @code{rel_tol=0.05}. A tolerância padrão é @code{1e-09}, o que garante que os dois valores sejam iguais em cerca de 9 dígitos decimais. `rel_tol' deve ser não negativo e menor que @code{1.0}.

`abs_tol' é a tolerância absoluta; o padrão é @code{0.0} e deve ser não negativo. Ao comparar @code{x} com @code{0.0}, @code{isclose(x, 0)} é computado como @code{abs(x) <= rel_tol * abs(x)}, que é @code{False} para qualquer @code{x} e rel_tol menor que @code{1.0}. Então adicione um argumento abs_tol positivo apropriado à chamada.

Os valores especiais do IEEE 754 de @code{NaN}, @code{inf} e @code{-inf} serão tratados de acordo com as regras do IEEE. Especificamente, @code{NaN} não é considerado próximo a qualquer outro valor, incluindo @code{NaN}. @code{inf} e @code{-inf} são considerados apenas próximos a si mesmos.


Adicionado na versão 3.5.



@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} – Uma função para testar igualdade aproximada

@end deffn

@node Constantes<3>,,Funções de classificação,cmath — Funções matemáticas para números complexos
@anchor{library/cmath constants}@anchor{27e1}
@subsubsection Constantes


@geindex pi (no módulo cmath)
@anchor{library/cmath cmath pi}@anchor{27da}
@deffn {Dado} cmath.pi

A constante matemática `π', como um ponto flutuante.
@end deffn

@geindex e (no módulo cmath)
@anchor{library/cmath cmath e}@anchor{27db}
@deffn {Dado} cmath.e

A constante matemática `e', como um ponto flutuante.
@end deffn

@geindex tau (no módulo cmath)
@anchor{library/cmath cmath tau}@anchor{c9e}
@deffn {Dado} cmath.tau

A constante matemática `τ', como um ponto flutuante.


Adicionado na versão 3.6.

@end deffn

@geindex inf (no módulo cmath)
@anchor{library/cmath cmath inf}@anchor{c9f}
@deffn {Dado} cmath.inf

Infinito positivo de ponto flutuante. Equivale a @code{float('inf')}.


Adicionado na versão 3.6.

@end deffn

@geindex infj (no módulo cmath)
@anchor{library/cmath cmath infj}@anchor{ca2}
@deffn {Dado} cmath.infj

Número complexo com parte real zero e parte imaginária infinita positiva. Equivale a @code{complex(0.0, float('inf'))}.


Adicionado na versão 3.6.

@end deffn

@geindex nan (no módulo cmath)
@anchor{library/cmath cmath nan}@anchor{ca0}
@deffn {Dado} cmath.nan

Um valor de ponto flutuante “não um número” (NaN). Equivale a @code{float('nan')}. Veja também @ref{663,,math.nan}.


Adicionado na versão 3.6.

@end deffn

@geindex nanj (no módulo cmath)
@anchor{library/cmath cmath nanj}@anchor{ca3}
@deffn {Dado} cmath.nanj

Número complexo com parte real zero e parte imaginária NaN. Equivale a @code{complex(0.0, float('nan'))}.


Adicionado na versão 3.6.

@end deffn

@geindex módulo;math

Observe que a seleção de funções é semelhante, mas não idêntica, àquela no módulo @ref{8e,,math}. A razão para ter dois módulos é que alguns usuários não estão interessados em números complexos e talvez nem saibam o que são. Eles preferem que @code{math.sqrt(-1)} gere uma exceção do que retorne um número complexo. Observe também que as funções definidas em @ref{18,,cmath} sempre retornam um número complexo, mesmo que a resposta possa ser expressa como um número real (nesse caso o número complexo tem uma parte imaginária de zero).

Uma nota sobre cortes de ramificação: são curvas ao longo das quais a função dada não é contínua. Eles são um recurso necessário de muitas funções complexas. Presume-se que se você precisar calcular com funções complexas, você entenderá sobre cortes de ramificação. Consulte quase qualquer livro (não muito elementar) sobre variáveis complexas para obter esclarecimento. Para informações sobre a escolha adequada dos cortes de ramificação para fins numéricos, uma boa referência deve ser a seguinte:


@subsubheading Ver também


Kahan, W:  Branch cuts for complex elementary functions; or, Much ado about nothing’s sign bit.  Em Iserles, A. e Powell, M. (eds.), The state of the art in numerical analysis. Clarendon Press (1987) pp165–211.


@node decimal — Aritmética de ponto fixo decimal e ponto flutuante,fractions — Números racionais,cmath — Funções matemáticas para números complexos,Módulos Matemáticos e Numéricos
@anchor{library/decimal doc}@anchor{27e2}@anchor{library/decimal decimal-decimal-fixed-point-and-floating-point-arithmetic}@anchor{27e3}@anchor{library/decimal module-decimal}@anchor{36}@anchor{library/decimal translation-repo}@anchor{27e4}
@subsection @code{decimal} — Aritmética de ponto fixo decimal e ponto flutuante


@geindex module; decimal

`Código-fonte:' Lib/decimal.py@footnote{https://github.com/python/cpython/tree/3.13/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())


__________________________________________________________________


O módulo @ref{36,,decimal} fornece suporte a aritmética rápida de ponto flutuante decimal corretamente arredondado. Oferece várias vantagens sobre o tipo de dados @ref{2f7,,float}:


@itemize *

@item 
Decimal “is based on a floating-point model@footnote{https://speleotrove.com/decimal/damodel.html#refnumber} which was designed
with people in mind, and necessarily has a paramount guiding principle –
computers must provide an arithmetic that works in the same way as the
arithmetic that people learn at school.” – excerpt from the decimal
arithmetic specification.

@item 
Os números decimais podem ser representados exatamente. Por outro lado, números como @code{1.1} e @code{2.2} não possuem representações exatas em ponto flutuante binário. Os usuários finais normalmente não esperam que @code{1.1 + 2.2} sejam exibidos como @code{3.3000000000000003}, como acontece com o ponto flutuante binário.

@item 
A exatidão transita para a aritmética. No ponto flutuante decimal, @code{0.1 + 0.1 + 0.1 - 0.3} é exatamente igual a zero. No ponto flutuante binário, o resultado é @code{5.5511151231257827e-017}. Embora próximas de zero, as diferenças impedem o teste de igualdade confiável e as diferenças podem se acumular. Por esse motivo, o decimal é preferido em aplicações de contabilidade que possuem invariáveis estritos de igualdade.

@item 
O módulo decimal incorpora uma noção de casas significativas para que @code{1.30 + 1.20} seja @code{2.50}. O zero à direita é mantido para indicar significância. Esta é a apresentação habitual para aplicações monetárias. Para multiplicação, a abordagem “livro escolar” usa todas as figuras nos multiplicandos. Por exemplo, @code{1.3 * 1.2} é igual a @code{1.56} enquanto @code{1.30 * 1.20} é igual a @code{1.5600}.

@item 
Diferentemente do ponto flutuante binário baseado em hardware, o módulo decimal possui uma precisão alterável pelo usuário (padrão de 28 casas), que pode ser tão grande quanto necessário para um determinado problema:

@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 
O ponto flutuante binário e decimal é implementado em termos de padrões publicados. Enquanto o tipo ponto flutuante embutido expõe apenas uma parte modesta de seus recursos, o módulo decimal expõe todas as partes necessárias do padrão. Quando necessário, o programador tem controle total sobre o arredondamento e o manuseio do sinal. Isso inclui uma opção para impor aritmética exata usando exceções para bloquear quaisquer operações inexatas.

@item 
O módulo decimal foi projetado para dar suporte, “sem prejuízo, a aritmética decimal não arredondada exata (às vezes chamada aritmética de ponto fixo) e aritmética arredondada de ponto flutuante”. – trecho da especificação aritmética decimal.
@end itemize

O design do módulo é centrado em torno de três conceitos: o número decimal, o contexto da aritmética e os sinais.

Um número decimal é imutável. Possui um sinal, dígitos de coeficiente e um expoente. Para preservar a significância, os dígitos do coeficiente não truncam zeros à direita. Os decimais também incluem valores especiais, tais como @code{Infinity}, @code{-Infinity} e @code{NaN}. O padrão também diferencia @code{-0} de @code{+0}.

O contexto da aritmética é um ambiente que especifica precisão, regras de arredondamento, limites de expoentes, sinalizadores indicando os resultados das operações e ativadores de interceptação que determinam se os sinais são tratados como exceções. As opções de arredondamento incluem @ref{27e5,,ROUND_CEILING}, @ref{27e6,,ROUND_DOWN}, @ref{27e7,,ROUND_FLOOR}, @ref{27e8,,ROUND_HALF_DOWN}, @ref{27e9,,ROUND_HALF_EVEN}, @ref{27ea,,ROUND_HALF_UP}, @ref{27eb,,ROUND_UP} e @ref{27ec,,ROUND_05UP}.

Sinais são grupos de condições excepcionais que surgem durante o curso da computação. Dependendo das necessidades da aplicação, os sinais podem ser ignorados, considerados informativos ou tratados como exceções. Os sinais no módulo decimal são: @ref{27ed,,Clamped}, @ref{10e7,,InvalidOperation}, @ref{27ee,,DivisionByZero}, @ref{27ef,,Inexact}, @ref{27f0,,Rounded}, @ref{27f1,,Subnormal}, @ref{27f2,,Overflow}, @ref{27f3,,Underflow} e @ref{10dc,,FloatOperation}.

Para cada sinal, há um sinalizador e um ativador de interceptação. Quando um sinal é encontrado, seu sinalizador é definido como um e, se o ativador de interceptação estiver definido como um, uma exceção será gerada. Os sinalizadores são fixos; portanto, o usuário precisa redefini-los antes de monitorar um cálculo.


@subsubheading Ver também



@itemize *

@item 
A especificação geral aritmética decimal da IBM, The General Decimal Arithmetic Specification@footnote{https://speleotrove.com/decimal/decarith.html}.
@end itemize


@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@menu
* Tutorial de início rápido:: 
* Objetos de Decimal:: 
* Objetos de contexto:: 
* Constantes: Constantes<4>. 
* Modos de arredondamento:: 
* Sinais:: 
* Observações sobre ponto flutuante:: 
* Trabalhando com threads:: 
* Receitas:: 
* FAQ sobre Decimal:: 

@end menu

@node Tutorial de início rápido,Objetos de Decimal,,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-tutorial}@anchor{27f4}@anchor{library/decimal quick-start-tutorial}@anchor{27f5}
@subsubsection Tutorial de início rápido


O início usual do uso de decimais é importar o módulo, exibir o contexto atual com @ref{16be,,getcontext()} e, se necessário, definir novos valores para precisão, arredondamento ou armadilhas ativados:

@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       # Define uma nova precisão
@end example

Instâncias decimais podem ser construídas a partir de números inteiros, strings, pontos flutuantes ou tuplas. A construção de um número inteiro ou de um ponto flutuante realiza uma conversão exata do valor desse número inteiro ou ponto flutuante. Os números decimais incluem valores especiais como @code{NaN}, que significa “Não é um número”, @code{Infinity} positivo e negativo e @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

Se o sinal @ref{10dc,,FloatOperation} for capturado na armadilha, a mistura acidental de decimais e pontos flutuantes em construtores ou comparações de ordenação levanta uma exceção:

@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


Adicionado na versão 3.3.


O significado de um novo decimal é determinado apenas pelo número de dígitos inseridos. A precisão e o arredondamento do contexto só entram em jogo durante operações 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 os limites internos da versão C forem excedidos, a construção de um decimal levanta @ref{10e7,,InvalidOperation}:

@example
>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]
@end example


Alterado na versão 3.3.


Os decimais interagem bem com grande parte do resto do Python. Aqui está um pequeno circo voador de ponto flutuante decimal:

@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

Decimals can be formatted (with @ref{61f,,format()} built-in or @ref{9b1,,f-strings}) in
fixed-point or scientific notation, using the same formatting syntax (see
@ref{1e8,,Minilinguagem de especificação de formato}) as builtin @ref{2f7,,float} type:

@example
>>> format(Decimal('2.675'), "f")
'2.675'
>>> format(Decimal('2.675'), ".2f")
'2.68'
>>> f"@{Decimal('2.675'):.2f@}"
'2.68'
>>> format(Decimal('2.675'), ".2e")
'2.68e+0'
>>> with localcontext() as ctx:
...     ctx.rounding = ROUND_DOWN
...     print(format(Decimal('2.675'), ".2f"))
...
2.67
@end example

E algumas funções matemáticas também estão disponíveis no 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

O método @ref{10ef,,quantize()} arredonda um número para um expoente fixo. Esse método é útil para aplicações monetárias que geralmente arredondam os resultados para um número fixo de locais:

@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 mostrado acima, a função @ref{16be,,getcontext()} acessa o contexto atual e permite que as configurações sejam alteradas. Essa abordagem atende às necessidades da maioria das aplicações.

Para trabalhos mais avançados, pode ser útil criar contextos alternativos usando o construtor @ref{10ee,,Context()}. Para ativar uma alternativa, use a função @ref{27f6,,setcontext()}.

De acordo com o padrão, o módulo @ref{36,,decimal} fornece dois contextos padrão prontos para uso, @ref{10e3,,BasicContext} e @ref{10e4,,ExtendedContext}. O primeiro é especialmente útil para depuração porque muitas das armadilhas estão ativadas:

@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

Os contextos também possuem sinalizadores para monitorar condições excepcionais encontradas durante os cálculos. Os sinalizadores permanecem definidos até que sejam explicitamente limpos, portanto, é melhor limpar os sinalizadores antes de cada conjunto de cálculos monitorados usando o método @ref{27f7,,clear_flags()}.

@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

A entrada `flags' mostra que a aproximação racional de pi foi arredondada (dígitos além da precisão do contexto foram descartados) e que o resultado é inexato (alguns dos dígitos descartados eram diferentes de zero).

As armadilhas individuais são definidas usando o dicionário no atributo @ref{10ed,,traps} de um contexto:

@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

A maioria dos programas ajusta o contexto atual apenas uma vez, no início do programa. E, em muitas aplicações, os dados são convertidos para @ref{29d,,Decimal} com uma única conversão dentro de um loop. Com o conjunto de contextos e decimais criados, a maior parte do programa manipula os dados de maneira diferente do que com outros tipos numéricos do Python.

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Objetos de Decimal,Objetos de contexto,Tutorial de início rápido,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-decimal}@anchor{27f8}@anchor{library/decimal decimal-objects}@anchor{27f9}
@subsubsection Objetos de Decimal


@geindex Decimal (classe em decimal)
@anchor{library/decimal decimal Decimal}@anchor{29d}
@deffn {Classe} decimal.Decimal (value='0', context=None)

Constrói um novo objeto de @ref{29d,,Decimal} com base em `value'.

`value' pode ser um inteiro, string, tupla, @ref{2f7,,float} ou outro objeto de @ref{29d,,Decimal}. Se nenhum `value' for fornecido, retornará @code{Decimal('0')}. Se `value' for uma string, ele deverá estar em conformidade com a sintaxe da string numérica decimal após caracteres de espaço em branco à esquerda e à direita, bem como sublinhados em toda parte, serem removidos:

@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

Outros dígitos decimais Unicode também são permitidos onde @code{digit} aparece acima. Isso inclui dígitos decimais de vários outros alfabetos (por exemplo, dígitos em árabes-índicos e devanágaris), além dos dígitos de largura total @code{'\uff10'} a @code{'\uff19'}. A capitalização não é significativa, então, por exemplo, @code{inf}, @code{Inf}, @code{INFINITY} e @code{iNfINity} são todas grafias aceitáveis para infinito positivo.

Se `value' for um @ref{370,,tuple}, ele deverá ter três componentes, um sinal (@code{0} para positivo ou @code{1} para negativo), um @ref{370,,tuple} de dígitos e um expoente inteiro. Por exemplo, @code{Decimal((0, (1, 4, 1, 4), -3))} returna @code{Decimal('1.414')}.

Se `value' é um @ref{2f7,,float}, o valor do ponto flutuante binário é convertido sem perdas no seu equivalente decimal exato. Essa conversão geralmente requer 53 ou mais dígitos de precisão. Por exemplo, @code{Decimal(float('1.1'))} converte para @code{Decimal('1.100000000000000088817841970012523233890533447265625')}.

A precisão `context' não afeta quantos dígitos estão armazenados. Isso é determinado exclusivamente pelo número de dígitos em `value'. Por exemplo, @code{Decimal('3.00000')} registra todos os cinco zeros, mesmo que a precisão do contexto seja apenas três.

O objetivo do argumento `context' é determinar o que fazer se `value' for uma string malformada. Se o contexto capturar @ref{10e7,,InvalidOperation}, uma exceção será levantada; caso contrário, o construtor retornará um novo decimal com o valor de @code{NaN}.

Uma vez construídos, objetos de @ref{29d,,Decimal} são imutáveis.


Alterado na versão 3.2: O argumento para o construtor agora pode ser uma instância de @ref{2f7,,float}.



Alterado na versão 3.3: Os argumentos de @ref{2f7,,float} levantam uma exceção se a armadilha @ref{10dc,,FloatOperation} estiver definida. Por padrão, a armadilha está desativada.



Alterado na versão 3.6: Sublinhados são permitidos para agrupamento, como nos literais de ponto flutuante e integral no código.


Objetos decimais de ponto flutuante compartilham muitas propriedades com outros tipos numéricos embutidos, como @ref{2f7,,float} e @ref{257,,int}. Todas as operações matemáticas usuais e métodos especiais se aplicam. Da mesma forma, objetos decimais podem ser copiados, separados, impressos, usados como chaves de dicionário, usados como elementos de conjunto, comparados, classificados e convertidos a outro tipo (como @ref{2f7,,float} ou @ref{257,,int}).

Existem algumas pequenas diferenças entre aritmética em objetos decimais e aritmética em números inteiros e flutuantes. Quando o operador de resto @code{%} é aplicado a objetos decimais, o sinal do resultado é o sinal do `dividend' em vez do sinal do divisor:

@example
>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')
@end example

O operador de divisão inteira @code{//} se comporta de maneira análoga, retornando a parte inteira do quociente verdadeiro (truncando em direção a zero) em vez de seu resto, de modo a preservar a identidade usual @code{x == (x // y) * y + x % y}:

@example
>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')
@end example

Os operadores @code{%} e @code{//} implementam as operações de @code{remainder} e @code{divide-integer} (respectivamente) como descrito na especificação.

Objetos decimais geralmente não podem ser combinados com pontos flutuantes ou instâncias de @ref{1e7,,fractions.Fraction} em operações aritméticas: uma tentativa de adicionar um @ref{29d,,Decimal} a um @ref{2f7,,float}, por exemplo, vai levantar um @ref{2c3,,TypeError}. No entanto, é possível usar os operadores de comparação do Python para comparar uma instância de @ref{29d,,Decimal} @code{x} com outro número @code{y}. Isso evita resultados confusos ao fazer comparações de igualdade entre números de tipos diferentes.


Alterado na versão 3.2: As comparações de tipos mistos entre instâncias de @ref{29d,,Decimal} e outros tipos numéricos agora são totalmente suportadas.


Além das propriedades numéricas padrões, os objetos de ponto flutuante decimal também possuem vários métodos especializados:

@geindex adjusted() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal adjusted}@anchor{27fa}
@deffn {Método} adjusted ()

Retorna o expoente ajustado depois de deslocar os dígitos mais à direita do coeficiente até restar apenas o dígito principal: @code{Decimal('321e+5').adjusted()} retorna sete. Usado para determinar a posição do dígito mais significativo em relação ao ponto decimal.
@end deffn

@geindex as_integer_ratio() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal as_integer_ratio}@anchor{cb3}
@deffn {Método} as_integer_ratio ()

Retorna um par @code{(n, d)} de números inteiros que representam a instância dada @ref{29d,,Decimal} como uma fração, nos termos mais baixos e com um denominador positivo:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

A conversão é exata. Levanta OverflowError em infinitos e ValueError em NaNs.
@end deffn


Adicionado na versão 3.6.


@geindex as_tuple() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal as_tuple}@anchor{27fb}
@deffn {Método} as_tuple ()

Retorna uma representação de @ref{64e,,tupla nomeada} do número: @code{DecimalTuple(sign, digits, exponent)}.
@end deffn

@geindex canonical() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal canonical}@anchor{27fc}
@deffn {Método} canonical ()

Retorna a codificação canônica do argumento. Atualmente, a codificação de uma instância de @ref{29d,,Decimal} é sempre canônica, portanto, esta operação retorna seu argumento inalterado.
@end deffn

@geindex compare() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal compare}@anchor{27fd}
@deffn {Método} compare (other, context=None)

Compara os valores de duas instâncias decimais. @ref{27fd,,compare()} retorna uma instância decimal, e se qualquer operando for um NaN, o resultado será um 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 decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_signal}@anchor{27fe}
@deffn {Método} compare_signal (other, context=None)

Esta operação é idêntica ao método @ref{27fd,,compare()}, exceto que todos os NaNs sinalizam. Ou seja, se nenhum operando for um NaN sinalizador, qualquer operando NaN silencioso será tratado como se fosse um NaN sinalizador.
@end deffn

@geindex compare_total() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_total}@anchor{27ff}
@deffn {Método} compare_total (other, context=None)

Compara dois operandos usando sua representação abstrata em vez de seu valor numérico. Semelhante ao método @ref{27fd,,compare()}, mas o resultado fornece uma ordem total nas instâncias de @ref{29d,,Decimal}. Duas instâncias de @ref{29d,,Decimal} com o mesmo valor numérico, mas diferentes representações, se comparam desiguais nesta ordem:

@example
>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')
@end example

Os NaNs silenciosos e sinalizadores também estão incluídos no pedido total. O resultado dessa função é @code{Decimal('0')} se os dois operandos tiverem a mesma representação, @code{Decimal('-1')} se o primeiro operando for menor na ordem total que o segundo e @code{Decimal('1')} se o primeiro operando for maior na ordem total que o segundo operando. Veja a especificação para detalhes da ordem total.

Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado. Como uma exceção, a versão C pode levantar InvalidOperation se o segundo operando não puder ser convertido exatamente.
@end deffn

@geindex compare_total_mag() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal compare_total_mag}@anchor{2800}
@deffn {Método} compare_total_mag (other, context=None)

Compara dois operandos usando sua representação abstrata em vez de seu valor, como em @ref{27ff,,compare_total()}, mas ignorando o sinal de cada operando. @code{x.compare_total_mag(y)} é equivalente a @code{x.copy_abs().compare_total(y.copy_abs())}.

Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado. Como uma exceção, a versão C pode levantar InvalidOperation se o segundo operando não puder ser convertido exatamente.
@end deffn

@geindex conjugate() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal conjugate}@anchor{2801}
@deffn {Método} conjugate ()

Apenas retorna a si próprio, sendo esse método apenas para atender à Especificação de Decimal.
@end deffn

@geindex copy_abs() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_abs}@anchor{2802}
@deffn {Método} copy_abs ()

Retorna o valor absoluto do argumento. Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado.
@end deffn

@geindex copy_negate() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_negate}@anchor{2803}
@deffn {Método} copy_negate ()

Retorna a negação do argumento. Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado.
@end deffn

@geindex copy_sign() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal copy_sign}@anchor{2804}
@deffn {Método} copy_sign (other, context=None)

Retorna uma cópia do primeiro operando com o sinal definido para ser o mesmo que o sinal do segundo operando. Por exemplo:

@example
>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')
@end example

Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado. Como uma exceção, a versão C pode levantar InvalidOperation se o segundo operando não puder ser convertido exatamente.
@end deffn

@geindex exp() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal exp}@anchor{10e9}
@deffn {Método} exp (context=None)

Retorna o valor da função exponencial (natural) @code{e**x} no número especificado. O resultado é arredondado corretamente usando o modo de arredondamento @ref{27e9,,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 classe decimal.Decimal)
@anchor{library/decimal decimal Decimal from_float}@anchor{1244}
@deffn {Método} classmethod from_float (f, /)

Construtor alternativo que aceita apenas instâncias de @ref{2f7,,float} ou @ref{257,,int}.

Observe que @code{Decimal.from_float(0.1)} não é o mesmo que @code{Decimal('0.1')}. Como 0.1 não é exatamente representável no ponto flutuante binário, o valor é armazenado como o valor representável mais próximo que é @code{0x1.999999999999ap-4}.; Esse valor equivalente em decimal é @code{0.1000000000000000055511151231257827021181583404541015625}.

@cartouche
@quotation Nota 
A partir do Python 3.2 em diante, uma instância de @ref{29d,,Decimal} também pode ser construída diretamente a partir de um @ref{2f7,,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


Adicionado na versão 3.1.

@end deffn

@geindex fma() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal fma}@anchor{2805}
@deffn {Método} fma (other, third, context=None)

Multiplicação e adição fundidos. Retorna self*other+third sem arredondamento do produto intermediário self*other.

@example
>>> Decimal(2).fma(3, 5)
Decimal('11')
@end example
@end deffn

@geindex is_canonical() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_canonical}@anchor{2806}
@deffn {Método} is_canonical ()

Retorna @ref{c27,,True} se o argumento for canônico e @ref{b49,,False} caso contrário. Atualmente, uma instância de @ref{29d,,Decimal} é sempre canônica, portanto, esta operação sempre retorna @ref{c27,,True}.
@end deffn

@geindex is_finite() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_finite}@anchor{2807}
@deffn {Método} is_finite ()

Retorna @ref{c27,,True} se o argumento for um número finito e @ref{b49,,False} se o argumento for um infinito ou um NaN.
@end deffn

@geindex is_infinite() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_infinite}@anchor{2808}
@deffn {Método} is_infinite ()

Retorna @ref{c27,,True} se o argumento for infinito positivo ou negativo e @ref{b49,,False} caso contrário.
@end deffn

@geindex is_nan() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_nan}@anchor{2809}
@deffn {Método} is_nan ()

Retorna @ref{c27,,True} se o argumento for NaN (silencioso ou sinalizador) e @ref{b49,,False} caso contrário.
@end deffn

@geindex is_normal() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_normal}@anchor{280a}
@deffn {Método} is_normal (context=None)

Retorna @ref{c27,,True} se o argumento for um número finito `normal'. Retorna @ref{b49,,False} se o argumento for zero, subnormal, infinito ou NaN.
@end deffn

@geindex is_qnan() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_qnan}@anchor{280b}
@deffn {Método} is_qnan ()

Retorna @ref{c27,,True} se o argumento for um NaN silencioso, e @ref{b49,,False} caso contrário.
@end deffn

@geindex is_signed() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_signed}@anchor{280c}
@deffn {Método} is_signed ()

Retorna @ref{c27,,True} se o argumento tiver um sinal negativo e @ref{b49,,False} caso contrário. Observe que zeros e NaNs podem carregar sinais.
@end deffn

@geindex is_snan() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_snan}@anchor{280d}
@deffn {Método} is_snan ()

Retorna @ref{c27,,True} se o argumento for um sinal NaN e @ref{b49,,False} caso contrário.
@end deffn

@geindex is_subnormal() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_subnormal}@anchor{280e}
@deffn {Método} is_subnormal (context=None)

Retorna @ref{c27,,True} se o argumento for subnormal e @ref{b49,,False} caso contrário.
@end deffn

@geindex is_zero() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal is_zero}@anchor{280f}
@deffn {Método} is_zero ()

Retorna @ref{c27,,True} se o argumento for um zero (positivo ou negativo) e @ref{b49,,False} caso contrário.
@end deffn

@geindex ln() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal ln}@anchor{10ea}
@deffn {Método} ln (context=None)

Retorna o logaritmo (base e) natural do operando. O resultado é arredondado corretamente usando o modo de arredondamento @ref{27e9,,ROUND_HALF_EVEN}.
@end deffn

@geindex log10() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal log10}@anchor{2810}
@deffn {Método} log10 (context=None)

Retorna o logaritmo da base dez do operando. O resultado é arredondado corretamente usando o modo de arredondamento @ref{27e9,,ROUND_HALF_EVEN}.
@end deffn

@geindex logb() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal logb}@anchor{2811}
@deffn {Método} logb (context=None)

Para um número diferente de zero, retorna o expoente ajustado de seu operando como uma instância de @ref{29d,,Decimal}. Se o operando é zero, @code{Decimal('-Infinity')} é retornado e o sinalizador @ref{27ee,,DivisionByZero} é levantado. Se o operando for um infinito, @code{Decimal('Infinity')} será retornado.
@end deffn

@geindex logical_and() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_and}@anchor{2812}
@deffn {Método} logical_and (other, context=None)

@ref{2812,,logical_and()} é uma operação lógica que leva dois `operandos lógicos' (consulte @ref{2813,,Operandos lógicos}). O resultado é o @code{and} dígito a dígito dos dois operandos.
@end deffn

@geindex logical_invert() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_invert}@anchor{2814}
@deffn {Método} logical_invert (context=None)

@ref{2814,,logical_invert()} é uma operação lógica. O resultado é a inversão dígito a dígito do operando.
@end deffn

@geindex logical_or() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_or}@anchor{2815}
@deffn {Método} logical_or (other, context=None)

@ref{2815,,logical_or()} é uma operação lógica que leva dois `operandos lógicos' (consulte @ref{2813,,Operandos lógicos}). O resultado é o @code{or} dígito a dígito dos dois operandos.
@end deffn

@geindex logical_xor() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal logical_xor}@anchor{2816}
@deffn {Método} logical_xor (other, context=None)

@ref{2816,,logical_xor()} é uma operação lógica que leva dois `operandos lógicos' (consulte @ref{2813,,Operandos lógicos}). O resultado é o “ou exclusivo” dígito a dígito ou dos dois operandos.
@end deffn

@geindex max() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal max}@anchor{2817}
@deffn {Método} max (other, context=None)

Como @code{max(self, other)}, exceto que a regra de arredondamento de contexto é aplicada antes de retornar e que os valores @code{NaN} são sinalizados ou ignorados (dependendo do contexto e se estão sinalizando ou silenciosos).
@end deffn

@geindex max_mag() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal max_mag}@anchor{2818}
@deffn {Método} max_mag (other, context=None)

Semelhante ao método @ref{2817,,max()}, mas a comparação é feita usando os valores absolutos dos operandos.
@end deffn

@geindex min() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal min}@anchor{2819}
@deffn {Método} min (other, context=None)

Como @code{min(self, other)}, exceto que a regra de arredondamento de contexto é aplicada antes de retornar e que os valores @code{NaN} são sinalizados ou ignorados (dependendo do contexto e se estão sinalizando ou silenciosos).
@end deffn

@geindex min_mag() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal min_mag}@anchor{281a}
@deffn {Método} min_mag (other, context=None)

Semelhante ao método @ref{2819,,min()}, mas a comparação é feita usando os valores absolutos dos operandos.
@end deffn

@geindex next_minus() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal next_minus}@anchor{281b}
@deffn {Método} next_minus (context=None)

Retorna o maior número representável no contexto fornecido (ou no contexto atual da thread, se nenhum contexto for fornecido) que seja menor que o operando especificado.
@end deffn

@geindex next_plus() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal next_plus}@anchor{281c}
@deffn {Método} next_plus (context=None)

Retorna o menor número representável no contexto fornecido (ou no contexto atual da thread, se nenhum contexto for fornecido) que seja maior que o operando fornecido.
@end deffn

@geindex next_toward() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal next_toward}@anchor{281d}
@deffn {Método} next_toward (other, context=None)

Se os dois operandos forem desiguais, retorna o número mais próximo ao primeiro operando na direção do segundo operando. Se os dois operandos forem numericamente iguais, retorna uma cópia do primeiro operando com o sinal configurado para ser o mesmo que o sinal do segundo operando.
@end deffn

@geindex normalize() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal normalize}@anchor{281e}
@deffn {Método} normalize (context=None)

Usado para produzir valores canônicos de uma classe de equivalência no contexto atual ou no contexto especificado.

Esta tem a mesma semântica que a operação unária mais, exceto que se o resultado final for finito, ele será reduzido à sua forma mais simples, com todos os zeros à direita removidos e seu sinal preservado. Ou seja, enquanto o coeficiente for diferente de zero e múltiplo de dez, o coeficiente é dividido por dez e o expoente é incrementado em 1. Caso contrário (o coeficiente é zero), o expoente é definido como 0. Em todos os casos, o sinal permanece inalterado. .

Por exemplo, @code{Decimal('32.100')} e @code{Decimal('0.321000e+2')} ambos normalizam para o valor equivalente @code{Decimal('32.1')}.

Observe que o arredondamento é aplicado `antes' de reduzir para a forma mais simples.

Nas versões mais recentes da especificação, esta operação também é conhecida como @code{reduce}.
@end deffn

@geindex number_class() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal number_class}@anchor{281f}
@deffn {Método} number_class (context=None)

Retorna uma string descrevendo a `classe' do operando. O valor retornado é uma das dez sequências a seguir.


@itemize *

@item 
@code{"-Infinity"}, indicando que o operando é infinito negativo.

@item 
@code{"-Normal"}, indicando que o operando é um número normal negativo.

@item 
@code{"-Subnormal"}, indicando que o operando é negativo e subnormal.

@item 
@code{"-Zero"}, indicando que o operando é um zero negativo.

@item 
@code{"+Zero"}, indicando que o operando é um zero positivo.

@item 
@code{"+Subnormal"}, indicando que o operando é positivo e subnormal.

@item 
@code{"+Normal"}, indicando que o operando é um número normal positivo.

@item 
@code{"+Infinity"}, indicando que o operando é infinito positivo.

@item 
@code{"NaN"}, indicando que o operando é um NaN (“Not a Number”) silencioso.

@item 
@code{"sNaN"}, indicando que o operando é um NaN sinalizador.
@end itemize
@end deffn

@geindex quantize() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal quantize}@anchor{10ef}
@deffn {Método} quantize (exp, rounding=None, context=None)

Retorna um valor igual ao primeiro operando após o arredondamento e com o expoente do segundo operando.

@example
>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')
@end example

Diferentemente de outras operações, se o comprimento do coeficiente após a operação de quantização for maior que a precisão, então @ref{10e7,,InvalidOperation} é sinalizado. Isso garante que, a menos que haja uma condição de erro, o expoente quantizado é sempre igual ao do operando do lado direito.

Também, diferentemente de outras operações, a quantização nunca sinaliza Underflow, mesmo que o resultado seja subnormal e inexato.

Se o expoente do segundo operando for maior que o do primeiro, o arredondamento poderá ser necessário. Nesse caso, o modo de arredondamento é determinado pelo argumento @code{rounding}, se fornecido, ou pelo argumento @code{context} fornecido; se nenhum argumento for fornecido, o modo de arredondamento do contexto da thread atual será usado.

Um erro é retornado sempre que o expoente resultante for maior que @ref{10e5,,Emax} ou menor que @ref{2820,,Etiny()}.
@end deffn

@geindex radix() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal radix}@anchor{2821}
@deffn {Método} radix ()

Retorna @code{Decimal(10)}, a raiz (base) na qual a classe @ref{29d,,Decimal} faz toda a sua aritmética. Incluído para compatibilidade com a especificação.
@end deffn

@geindex remainder_near() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal remainder_near}@anchor{2822}
@deffn {Método} remainder_near (other, context=None)

Retorna o resto da divisão de `self' por `other'. Isso é diferente de @code{self % other}, pois o sinal do resto é escolhido para minimizar seu valor absoluto. Mais precisamente, o valor de retorno é @code{self - n * other}, onde @code{n} é o número inteiro mais próximo do valor exato de @code{self / other}, e se dois números inteiros estiverem igualmente próximos, o par será é escolhido.

Se o resultado for zero, seu sinal será o sinal 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 decimal.Decimal)
@anchor{library/decimal decimal Decimal rotate}@anchor{2823}
@deffn {Método} rotate (other, context=None)

Retorna o resultado da rotação dos dígitos do primeiro operando em uma quantidade especificada pelo segundo operando. O segundo operando deve ser um número inteiro no intervalo - precisão através da precisão. O valor absoluto do segundo operando fornece o número de locais a serem rotacionados. Se o segundo operando for positivo, a rotação será para a esquerda; caso contrário, a rotação será para a direita. O coeficiente do primeiro operando é preenchido à esquerda com zeros na precisão do comprimento, se necessário. O sinal e o expoente do primeiro operando não são alterados.
@end deffn

@geindex same_quantum() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal same_quantum}@anchor{2824}
@deffn {Método} same_quantum (other, context=None)

Testa se “self” e “other” têm o mesmo expoente ou se ambos são @code{NaN}.

Esta operação não é afetada pelo contexto e é silenciosa: nenhum sinalizador é alterado e nenhum arredondamento é executado. Como uma exceção, a versão C pode levantar InvalidOperation se o segundo operando não puder ser convertido exatamente.
@end deffn

@geindex scaleb() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal scaleb}@anchor{2825}
@deffn {Método} scaleb (other, context=None)

Retorna o primeiro operando com o expoente ajustado pelo segundo. Da mesma forma, retorna o primeiro operando multiplicado por @code{10**other}. O segundo operando deve ser um número inteiro.
@end deffn

@geindex shift() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal shift}@anchor{2826}
@deffn {Método} shift (other, context=None)

Retorna o resultado da troca dos dígitos do primeiro operando em uma quantidade especificada pelo segundo operando. O segundo operando deve ser um número inteiro no intervalo - precisão através da precisão. O valor absoluto do segundo operando fornece o número de locais a serem deslocados. Se o segundo operando for positivo, o deslocamento será para a esquerda; caso contrário, a mudança é para a direita. Os dígitos deslocados para o coeficiente são zeros. O sinal e o expoente do primeiro operando não são alterados.
@end deffn

@geindex sqrt() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal sqrt}@anchor{2827}
@deffn {Método} sqrt (context=None)

Retorna a raiz quadrada do argumento para a precisão total.
@end deffn

@geindex to_eng_string() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal to_eng_string}@anchor{2828}
@deffn {Método} to_eng_string (context=None)

Converte em uma string, usando notação de engenharia, se for necessário um expoente.

A notação de engenharia possui um expoente que é múltiplo de 3. Isso pode deixar até 3 dígitos à esquerda da casa decimal e pode exigir a adição de um ou dois zeros à direita.

Por exemplo, isso converte @code{Decimal('123E+1')} para @code{Decimal('1.23E+3')}.
@end deffn

@geindex to_integral() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral}@anchor{2829}
@deffn {Método} to_integral (rounding=None, context=None)

Idêntico ao método @ref{282a,,to_integral_value()}. O nome @code{to_integral} foi mantido para compatibilidade com versões mais antigas.
@end deffn

@geindex to_integral_exact() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral_exact}@anchor{282b}
@deffn {Método} to_integral_exact (rounding=None, context=None)

Arredonda para o número inteiro mais próximo, sinalizando @ref{27ef,,Inexact} ou @ref{27f0,,Rounded}, conforme apropriado, se o arredondamento ocorrer. O modo de arredondamento é determinado pelo parâmetro @code{rounding}, se fornecido, ou pelo @code{context} especificado. Se nenhum parâmetro for fornecido, o modo de arredondamento do contexto atual será usado.
@end deffn

@geindex to_integral_value() (método decimal.Decimal)
@anchor{library/decimal decimal Decimal to_integral_value}@anchor{282a}
@deffn {Método} to_integral_value (rounding=None, context=None)

Arredonda para o número inteiro mais próximo sem sinalizar @ref{27ef,,Inexact} ou @code{Rounding}. Se fornecido, aplica `rounding'; caso contrário, usa o método de arredondamento no `context' especificado ou no contexto atual.
@end deffn

Os números decimais podem ser arredondados usando a função @ref{131d,,round()}:


@deffn {Describe} round(number)
@end deffn


@deffn {Describe} round(number, ndigits)

Se `ndigits' não for fornecido ou @code{None}, retorna o @ref{257,,int} de `number' mais próximo, arredondando até chegar em par, e ignorando o modo de arredondamento do contexto @ref{29d,,Decimal}. Levanta @ref{885,,OverflowError} se `number' for um infinito ou @ref{202,,ValueError} se for um NaN (silencioso ou de sinalização).

Se `ndigits' for um @ref{257,,int}, o modo de arredondamento do contexto é respeitado e um @ref{29d,,Decimal} representando `número' arredondado para o múltiplo mais próximo de @code{Decimal('1E-ndigits')} é retornado; neste caso, @code{round(number, ndigits)} é equivalente a @code{self.quantize(Decimal('1E-ndigits'))}. Retorna @code{Decimal('NaN')} se `number' for um NaN silencioso. Levanta @ref{10e7,,InvalidOperation} se `number' for um infinito, uma sinalização NaN, ou se o comprimento do coeficiente após a operação de quantização for maior que a precisão do contexto atual. Em outras palavras, para os situações comuns:


@itemize *

@item 
se `ndigits' for positivo, retorna `number' arredondado para `ndigits' casas decimais;

@item 
se `ndigits' for zero, retorna `number' arredondado para o número inteiro mais próximo;

@item 
se `ndigits' for negativo, retorna `number' arredondado para o múltiplo mais próximo de @code{10**abs(ndigits)}.
@end itemize

Por exemplo:

@example
>>> from decimal import Decimal, getcontext, ROUND_DOWN
>>> getcontext().rounding = ROUND_DOWN
>>> round(Decimal('3.75'))     # arredondamento de contexto ignorado
4
>>> round(Decimal('3.5'))      # arredondamento para par mais próximo
4
>>> round(Decimal('3.75'), 0)  # usa o arredondamento de contexto
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 de Decimal
@anchor{library/decimal logical-operands}@anchor{282c}@anchor{library/decimal logical-operands-label}@anchor{2813}
@subsubsection Operandos lógicos


Os métodos @ref{2812,,logical_and()}, @ref{2814,,logical_invert()}, @ref{2815,,logical_or()} e @ref{2816,,logical_xor()} esperam que seus argumentos sejam `operandos lógicos'. Um `operando lógico' é uma instância de @ref{29d,,Decimal} cujo expoente e sinal são zero e cujos dígitos são todos @code{0} ou @code{1}.

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Objetos de contexto,Constantes<4>,Objetos de Decimal,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal context-objects}@anchor{282d}@anchor{library/decimal decimal-context}@anchor{247b}
@subsubsection Objetos de contexto


Contextos são ambientes para operações aritméticas. Eles governam a precisão, estabelecem regras para arredondamento, determinam quais sinais são tratados como exceções e limitam o intervalo dos expoentes.

Cada thread possui seu próprio contexto atual que é acessado ou alterado usando as funções @ref{16be,,getcontext()} e @ref{27f6,,setcontext()}:

@geindex getcontext() (no módulo decimal)
@anchor{library/decimal decimal getcontext}@anchor{16be}
@deffn {Função} decimal.getcontext ()

Retorna o contexto atual para a thread ativa.
@end deffn

@geindex setcontext() (no módulo decimal)
@anchor{library/decimal decimal setcontext}@anchor{27f6}
@deffn {Função} decimal.setcontext (c, /)

Define o contexto atual para a thread ativa como `C'.
@end deffn

Você também pode usar a instrução @ref{5d2,,with} e a função @ref{13cd,,localcontext()} para alterar temporariamente o contexto ativo.

@geindex localcontext() (no módulo decimal)
@anchor{library/decimal decimal localcontext}@anchor{13cd}
@deffn {Função} decimal.localcontext (ctx=None, **kwargs)

Retorna um gerenciador de contexto que vai definir o contexto atual da thread ativa para uma cópia de `ctx' na entrada da instrução “with” e restaurar o contexto anterior ao sair da instrução “with”. Se nenhum contexto for especificado, uma cópia do contexto atual será usada. O argumento `kwargs' é usado para definir os atributos do novo contexto.

Por exemplo, o código a seguir define a precisão decimal atual para 42 casas, executa um cálculo e restaura automaticamente o contexto anterior:

@example
from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Efetua um cálculo de alta precisão
    s = calculate_something()
s = +s  # Arredonda o resultado final de volta para a precisão padrão
@end example

Usando argumentos nomeados, o código seria o seguinte:

@example
from decimal import localcontext

with localcontext(prec=42) as ctx:
    s = calculate_something()
s = +s
@end example

Levanta @ref{2c3,,TypeError} se `kwargs' fornecer um atributo que @ref{10ee,,Context} não oferecer suporte. Levanta @ref{2c3,,TypeError} ou @ref{202,,ValueError} se `kwargs' fornecer um valor inválido para um atributo.


Alterado na versão 3.11: @ref{13cd,,localcontext()} agora tem suporte à configuração de atributos de contexto através do uso de argumentos nomeados.

@end deffn

Novos contextos também podem ser criados usando o construtor @ref{10ee,,Context} descrito abaixo. Além disso, o módulo fornece três contextos pré-criados:

@geindex BasicContext (no módulo decimal)
@anchor{library/decimal decimal BasicContext}@anchor{10e3}
@deffn {Dado} decimal.BasicContext

Este é um contexto padrão definido pela Especificação Aritmética Decimal Geral. A precisão está definida como nove. O arredondamento está definido como @ref{27ea,,ROUND_HALF_UP}. Todos os sinalizadores estão limpos. Todos as armadilhas estão ativadas (tratadas como exceções), exceto por @ref{27ef,,Inexact}, @ref{27f0,,Rounded} e @ref{27f1,,Subnormal}.

Como muitas das armadilhas estão ativadas, esse contexto é útil para depuração.
@end deffn

@geindex ExtendedContext (no módulo decimal)
@anchor{library/decimal decimal ExtendedContext}@anchor{10e4}
@deffn {Dado} decimal.ExtendedContext

Este é um contexto padrão definido pela Especificação Aritmética Decimal Geral. A precisão está definida como nove. O arredondamento está definido como @ref{27e9,,ROUND_HALF_EVEN}. Todos os sinalizadores estão limpos. Nenhuma armadilha está ativada (de forma que exceções não são levantadas durante os cálculos).

Como as armadilhas estão desativadas, esse contexto é útil para aplicativos que preferem ter o valor de resultado de @code{NaN} ou @code{Infinity} em vez de levantar exceções. Isso permite que uma aplicação conclua uma execução na presença de condições que interromperiam o programa.
@end deffn

@geindex DefaultContext (no módulo decimal)
@anchor{library/decimal decimal DefaultContext}@anchor{10e2}
@deffn {Dado} decimal.DefaultContext

Este contexto é usado pelo construtor @ref{10ee,,Context} como um protótipo para novos contextos. Alterar um campo (tal como precisão) tem o efeito de alterar o padrão para novos contextos criados pelo construtor @ref{10ee,,Context}.

Esse contexto é mais útil em ambientes multithread. A alteração de um dos campos antes do início das threads tem o efeito de definir os padrões para todo o sistema. Não é recomendável alterar os campos após o início das threads, pois exigiria sincronização de threads para evitar condições de corrida.

Em ambientes de thread única, é preferível não usar esse contexto. Em vez disso, basta criar contextos explicitamente, conforme descrito abaixo.

Os valores padrão são @ref{282e,,Context.prec}=@code{28}, @ref{282f,,Context.rounding}=@ref{27e9,,ROUND_HALF_EVEN} e armadilhas ativadas para @ref{27f2,,Overflow}, @ref{10e7,,InvalidOperation} e @ref{27ee,,DivisionByZero}.
@end deffn

Além dos três contextos fornecidos, novos contextos podem ser criados com o construtor @ref{10ee,,Context}.

@geindex Context (classe em decimal)
@anchor{library/decimal decimal Context}@anchor{10ee}
@deffn {Classe} decimal.Context (prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

Cria um novo contexto. Se um campo não for especificado ou for @ref{675,,None}, os valores padrão serão copiados de @ref{10e2,,DefaultContext}. Se o campo `flags' não for especificado ou for @ref{675,,None}, todos os sinalizadores serão limpados.

@geindex prec (atributo decimal.Context)
@anchor{library/decimal decimal Context prec}@anchor{282e}
@deffn {Atributo} prec

Um inteiro no intervalo [@code{1}, @ref{10df,,MAX_PREC}] que define a precisão para operações aritméticas no contexto.
@end deffn

@geindex rounding (atributo decimal.Context)
@anchor{library/decimal decimal Context rounding}@anchor{282f}
@deffn {Atributo} rounding

Uma das constantes listadas na seção @ref{2830,,Modos de arredondamento}.
@end deffn

@geindex traps (atributo decimal.Context)
@geindex flags (atributo decimal.Context)
@anchor{library/decimal decimal Context traps}@anchor{10ed}
@deffn {Atributo} traps
@anchor{library/decimal decimal Context flags}@anchor{10ec}
@deffnx {Atributo} flags

Listas de todos os sinais a serem configurados. Geralmente, novos contextos devem apenas definir armadilhas e deixar os sinalizadores limpos.
@end deffn

@geindex Emin (atributo decimal.Context)
@geindex Emax (atributo decimal.Context)
@anchor{library/decimal decimal Context Emin}@anchor{10e6}
@deffn {Atributo} Emin
@anchor{library/decimal decimal Context Emax}@anchor{10e5}
@deffnx {Atributo} Emax

Números inteiros que especificam os limites externos permitidos para expoentes. `Emin' deve estar no intervalo [@ref{10e1,,MIN_EMIN}, @code{0}], `Emax' no intervalo [@code{0}, @ref{10e0,,MAX_EMAX}].
@end deffn

@geindex capitals (atributo decimal.Context)
@anchor{library/decimal decimal Context capitals}@anchor{2831}
@deffn {Atributo} capitals

Assume @code{0} ou @code{1} (o padrão). Se definido como @code{1}, os expoentes serão impressos com um @code{E} maiúsculo; caso contrário, um @code{e} minúsculo é usado: @code{Decimal('6.02e+23')}.
@end deffn

@geindex clamp (atributo decimal.Context)
@anchor{library/decimal decimal Context clamp}@anchor{11dd}
@deffn {Atributo} clamp

Assume @code{0} (o padrão) ou @code{1}. Se definido como @code{1}, o expoente @code{e} de uma instância de @ref{29d,,Decimal} representável nesse contexto é estritamente limitado ao intervalo @code{Emin - prec + 1 <= e <= Emax - prec + 1}. Se `clamp' for @code{0}, uma condição mais fraca será mantida: o expoente ajustado da instância de @ref{29d,,Decimal} é no máximo @ref{10e5,,Emax}. Quando `clamp' é @code{1}, um grande número normal terá, sempre que possível, seu expoente reduzido e um número correspondente de zeros adicionado ao seu coeficiente, para ajustar as restrições do expoente; isso preserva o valor do número, mas perde informações sobre zeros à direita significativos. Por exemplo:

@example
>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')
@end example

Um valor de `clamp' de @code{1} permite compatibilidade com os formatos de intercâmbio decimal de largura fixa especificados na IEEE 754.
@end deffn

A classe @ref{10ee,,Context} define vários métodos de uso geral, bem como um grande número de métodos para fazer aritmética diretamente em um determinado contexto. Além disso, para cada um dos métodos de @ref{29d,,Decimal} descritos acima (com exceção dos métodos @ref{27fa,,adjusted()} e @ref{27fb,,as_tuple()}) existe um método correspondente em @ref{10ee,,Context}. Por exemplo, para uma instância @code{C} de @ref{10ee,,Context} e uma instância @code{x} de @ref{29d,,Decimal}, @code{C.exp(x)} é equivalente a @code{x.exp(context=C)}. Cada método de @ref{10ee,,Context} aceita um número inteiro do Python (uma instância de @ref{257,,int}) em qualquer lugar em que uma instância de Decimal seja aceita.

@geindex clear_flags() (método decimal.Context)
@anchor{library/decimal decimal Context clear_flags}@anchor{27f7}
@deffn {Método} clear_flags ()

Redefine todos os sinalizadores para @code{0}.
@end deffn

@geindex clear_traps() (método decimal.Context)
@anchor{library/decimal decimal Context clear_traps}@anchor{2832}
@deffn {Método} clear_traps ()

Redefine todas as armadilhas para @code{0}.


Adicionado na versão 3.3.

@end deffn

@geindex copy() (método decimal.Context)
@anchor{library/decimal decimal Context copy}@anchor{2833}
@deffn {Método} copy ()

Retorna uma duplicata do contexto.
@end deffn

@geindex copy_decimal() (método decimal.Context)
@anchor{library/decimal decimal Context copy_decimal}@anchor{2834}
@deffn {Método} copy_decimal (num, /)

Retorna uma cópia da instância de Decimal `num'.
@end deffn

@geindex create_decimal() (método decimal.Context)
@anchor{library/decimal decimal Context create_decimal}@anchor{10e8}
@deffn {Método} create_decimal (num='0', /)

Cria uma nova instância decimal a partir de `num', mas usando `self' como contexto. Diferentemente do construtor de @ref{29d,,Decimal}, a precisão do contexto, o método de arredondamento, os sinalizadores e as armadilhas são aplicadas à conversão.

Isso é útil porque as constantes geralmente são fornecidas com uma precisão maior do que a necessária pela aplicação. Outro benefício é que o arredondamento elimina imediatamente os efeitos indesejados dos dígitos além da precisão atual. No exemplo a seguir, o uso de entradas não arredondadas significa que adicionar zero a uma soma pode alterar o 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 a operação “to-number” da especificação IBM. Se o argumento for uma string, nenhum espaço em branco à esquerda ou à direita ou sublinhado serão permitidos.
@end deffn

@geindex create_decimal_from_float() (método decimal.Context)
@anchor{library/decimal decimal Context create_decimal_from_float}@anchor{2835}
@deffn {Método} create_decimal_from_float (f, /)

Cria uma nova instância de Decimal a partir de um ponto flutuante `f', mas arredondando usando `self' como contexto. Diferentemente do método da classe @ref{1244,,Decimal.from_float()}, a precisão do contexto, o método de arredondamento, os sinalizadores e as armadilhas são aplicados à conversão.

@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


Adicionado na versão 3.1.

@end deffn

@geindex Etiny() (método decimal.Context)
@anchor{library/decimal decimal Context Etiny}@anchor{2820}
@deffn {Método} Etiny ()

Retorna um valor igual a @code{Emin - prec + 1}, que é o valor mínimo do expoente para resultados subnormais. Quando ocorre o estouro negativo, o expoente é definido como @ref{2820,,Etiny}.
@end deffn

@geindex Etop() (método decimal.Context)
@anchor{library/decimal decimal Context Etop}@anchor{2836}
@deffn {Método} Etop ()

Retorna um valor igual a @code{Emax - prec + 1}.
@end deffn

A abordagem usual para trabalhar com decimais é criar instâncias de @ref{29d,,Decimal} e depois aplicar operações aritméticas que ocorrem no contexto atual da thread ativa. Uma abordagem alternativa é usar métodos de contexto para calcular dentro de um contexto específico. Os métodos são semelhantes aos da classe @ref{29d,,Decimal} e são contados apenas brevemente aqui.

@geindex abs() (método decimal.Context)
@anchor{library/decimal decimal Context abs}@anchor{2837}
@deffn {Método} abs (x, /)

Retorna o valor absoluto de `x'.
@end deffn

@geindex add() (método decimal.Context)
@anchor{library/decimal decimal Context add}@anchor{2838}
@deffn {Método} add (x, y, /)

Retorna a soma de `x' e `y'.
@end deffn

@geindex canonical() (método decimal.Context)
@anchor{library/decimal decimal Context canonical}@anchor{134b}
@deffn {Método} canonical (x, /)

Retorna o mesmo objeto de Decimal `x'.
@end deffn

@geindex compare() (método decimal.Context)
@anchor{library/decimal decimal Context compare}@anchor{2839}
@deffn {Método} compare (x, y, /)

Compara `x' e `y' numericamente.
@end deffn

@geindex compare_signal() (método decimal.Context)
@anchor{library/decimal decimal Context compare_signal}@anchor{283a}
@deffn {Método} compare_signal (x, y, /)

Compara os valores dos dois operandos numericamente.
@end deffn

@geindex compare_total() (método decimal.Context)
@anchor{library/decimal decimal Context compare_total}@anchor{283b}
@deffn {Método} compare_total (x, y, /)

Compara dois operandos usando sua representação abstrata.
@end deffn

@geindex compare_total_mag() (método decimal.Context)
@anchor{library/decimal decimal Context compare_total_mag}@anchor{283c}
@deffn {Método} compare_total_mag (x, y, /)

Compara dois operandos usando sua representação abstrata, ignorando o sinal.
@end deffn

@geindex copy_abs() (método decimal.Context)
@anchor{library/decimal decimal Context copy_abs}@anchor{283d}
@deffn {Método} copy_abs (x, /)

Retorna uma cópia de `x' com o sinal definido para 0.
@end deffn

@geindex copy_negate() (método decimal.Context)
@anchor{library/decimal decimal Context copy_negate}@anchor{283e}
@deffn {Método} copy_negate (x, /)

Retorna uma cópia de `x' com o sinal invertido.
@end deffn

@geindex copy_sign() (método decimal.Context)
@anchor{library/decimal decimal Context copy_sign}@anchor{283f}
@deffn {Método} copy_sign (x, y, /)

Copia o sinal de `y' para `x'.
@end deffn

@geindex divide() (método decimal.Context)
@anchor{library/decimal decimal Context divide}@anchor{2840}
@deffn {Método} divide (x, y, /)

Retorna `x' dividido por `y'.
@end deffn

@geindex divide_int() (método decimal.Context)
@anchor{library/decimal decimal Context divide_int}@anchor{2841}
@deffn {Método} divide_int (x, y, /)

Retorna `x' dividido por `y', truncado para um inteiro.
@end deffn

@geindex divmod() (método decimal.Context)
@anchor{library/decimal decimal Context divmod}@anchor{2842}
@deffn {Método} divmod (x, y, /)

Divide dois números e retorna a parte inteira do resultado.
@end deffn

@geindex exp() (método decimal.Context)
@anchor{library/decimal decimal Context exp}@anchor{2843}
@deffn {Método} exp (x, /)

Retorna @code{e ** x}.
@end deffn

@geindex fma() (método decimal.Context)
@anchor{library/decimal decimal Context fma}@anchor{2844}
@deffn {Método} fma (x, y, z, /)

Retorna `x' multiplicado por `y', mais `z'.
@end deffn

@geindex is_canonical() (método decimal.Context)
@anchor{library/decimal decimal Context is_canonical}@anchor{134c}
@deffn {Método} is_canonical (x, /)

Retorna @code{True} se `x' for canonical; caso contrário, retorna @code{False}.
@end deffn

@geindex is_finite() (método decimal.Context)
@anchor{library/decimal decimal Context is_finite}@anchor{2845}
@deffn {Método} is_finite (x, /)

Retorna @code{True} se `x' for finito; caso contrário, retorna @code{False}.
@end deffn

@geindex is_infinite() (método decimal.Context)
@anchor{library/decimal decimal Context is_infinite}@anchor{2846}
@deffn {Método} is_infinite (x, /)

Retorna @code{True} se `x' for infinito; caso contrário, retorna @code{False}.
@end deffn

@geindex is_nan() (método decimal.Context)
@anchor{library/decimal decimal Context is_nan}@anchor{2847}
@deffn {Método} is_nan (x, /)

Retorna @code{True} se `x' for qNaN ou sNaN; caso contrário, retorna @code{False}.
@end deffn

@geindex is_normal() (método decimal.Context)
@anchor{library/decimal decimal Context is_normal}@anchor{2848}
@deffn {Método} is_normal (x, /)

Retorna @code{True} se `x' for um número normal; caso contrário, retorna @code{False}.
@end deffn

@geindex is_qnan() (método decimal.Context)
@anchor{library/decimal decimal Context is_qnan}@anchor{2849}
@deffn {Método} is_qnan (x, /)

Retorna @code{True} se `x' for um NaN silencioso; caso contrário, retorna @code{False}.
@end deffn

@geindex is_signed() (método decimal.Context)
@anchor{library/decimal decimal Context is_signed}@anchor{284a}
@deffn {Método} is_signed (x, /)

Retorna @code{True} se `x' for negativo; caso contrário, retorna @code{False}.
@end deffn

@geindex is_snan() (método decimal.Context)
@anchor{library/decimal decimal Context is_snan}@anchor{284b}
@deffn {Método} is_snan (x, /)

Retorna @code{True} se `x' for um NaN sinalizador; caso contrário, retorna @code{False}.
@end deffn

@geindex is_subnormal() (método decimal.Context)
@anchor{library/decimal decimal Context is_subnormal}@anchor{284c}
@deffn {Método} is_subnormal (x, /)

Retorna @code{True} se `x' for subnormal; caso contrário, retorna @code{False}.
@end deffn

@geindex is_zero() (método decimal.Context)
@anchor{library/decimal decimal Context is_zero}@anchor{284d}
@deffn {Método} is_zero (x, /)

Retorna @code{True} se `x' for zero; caso contrário, retorna @code{False}.
@end deffn

@geindex ln() (método decimal.Context)
@anchor{library/decimal decimal Context ln}@anchor{284e}
@deffn {Método} ln (x, /)

Retorna o logaritmo natural (base e) de `x'.
@end deffn

@geindex log10() (método decimal.Context)
@anchor{library/decimal decimal Context log10}@anchor{284f}
@deffn {Método} log10 (x, /)

Retorna o logaritmo de base 10 de `x'.
@end deffn

@geindex logb() (método decimal.Context)
@anchor{library/decimal decimal Context logb}@anchor{2850}
@deffn {Método} logb (x, /)

Retorna o expoente da magnitude do MSD do operando.
@end deffn

@geindex logical_and() (método decimal.Context)
@anchor{library/decimal decimal Context logical_and}@anchor{2851}
@deffn {Método} logical_and (x, y, /)

Aplica a operação lógica `e' entre cada dígito do operando.
@end deffn

@geindex logical_invert() (método decimal.Context)
@anchor{library/decimal decimal Context logical_invert}@anchor{2852}
@deffn {Método} logical_invert (x, /)

Inverte todos os dígitos em `x'.
@end deffn

@geindex logical_or() (método decimal.Context)
@anchor{library/decimal decimal Context logical_or}@anchor{2853}
@deffn {Método} logical_or (x, y, /)

Aplica a operação lógica `ou' entre cada dígito do operando.
@end deffn

@geindex logical_xor() (método decimal.Context)
@anchor{library/decimal decimal Context logical_xor}@anchor{2854}
@deffn {Método} logical_xor (x, y, /)

Aplica a operação lógica `ou exclusivo' entre cada dígito do operando.
@end deffn

@geindex max() (método decimal.Context)
@anchor{library/decimal decimal Context max}@anchor{2855}
@deffn {Método} max (x, y, /)

Compara dois valores numericamente e retorna o máximo.
@end deffn

@geindex max_mag() (método decimal.Context)
@anchor{library/decimal decimal Context max_mag}@anchor{2856}
@deffn {Método} max_mag (x, y, /)

Compara dois valores numericamente com seu sinal ignorado.
@end deffn

@geindex min() (método decimal.Context)
@anchor{library/decimal decimal Context min}@anchor{2857}
@deffn {Método} min (x, y, /)

Compara dois valores numericamente e retorna o mínimo.
@end deffn

@geindex min_mag() (método decimal.Context)
@anchor{library/decimal decimal Context min_mag}@anchor{2858}
@deffn {Método} min_mag (x, y, /)

Compara dois valores numericamente com seu sinal ignorado.
@end deffn

@geindex minus() (método decimal.Context)
@anchor{library/decimal decimal Context minus}@anchor{2859}
@deffn {Método} minus (x, /)

Minus corresponde ao operador de subtração de prefixo unário no Python.
@end deffn

@geindex multiply() (método decimal.Context)
@anchor{library/decimal decimal Context multiply}@anchor{285a}
@deffn {Método} multiply (x, y, /)

Retorna o produto de `x' e `y'.
@end deffn

@geindex next_minus() (método decimal.Context)
@anchor{library/decimal decimal Context next_minus}@anchor{285b}
@deffn {Método} next_minus (x, /)

Retorna o maior número representável menor que `x'.
@end deffn

@geindex next_plus() (método decimal.Context)
@anchor{library/decimal decimal Context next_plus}@anchor{285c}
@deffn {Método} next_plus (x, /)

Retorna o menor número representável maior que `x'.
@end deffn

@geindex next_toward() (método decimal.Context)
@anchor{library/decimal decimal Context next_toward}@anchor{285d}
@deffn {Método} next_toward (x, y, /)

Retorna o número mais próximo a `x', em direção a `y'.
@end deffn

@geindex normalize() (método decimal.Context)
@anchor{library/decimal decimal Context normalize}@anchor{285e}
@deffn {Método} normalize (x, /)

Reduz `x' para sua forma mais simples.
@end deffn

@geindex number_class() (método decimal.Context)
@anchor{library/decimal decimal Context number_class}@anchor{285f}
@deffn {Método} number_class (x, /)

Retorna uma indicação da classe de `x'.
@end deffn

@geindex plus() (método decimal.Context)
@anchor{library/decimal decimal Context plus}@anchor{2860}
@deffn {Método} plus (x, /)

Plus corresponde ao operador de soma de prefixo unário no Python. Esta operação aplica a precisão e o arredondamento do contexto, portanto `não' é uma operação de identidade.
@end deffn

@geindex power() (método decimal.Context)
@anchor{library/decimal decimal Context power}@anchor{2861}
@deffn {Método} power (x, y, modulo=None)

Retorna @code{x} à potência de @code{y}, com a redução de módulo @code{modulo} se fornecido.

Com dois argumentos, calcula @code{x**y}. Se @code{x} for negativo, @code{y} deve ser inteiro. O resultado será inexato, a menos que @code{y} seja inteiro e o resultado seja finito e possa ser expresso exatamente em “precisão” dígitos. O modo de arredondamento do contexto é usado. Os resultados são sempre arredondados corretamente na versão Python.

@code{Decimal(0) ** Decimal(0)} resulta em @code{InvalidOperation}, e se @code{InvalidOperation} não for capturado, resulta em @code{Decimal('NaN')}.


Alterado na versão 3.3: O módulo C calcula @ref{2861,,power()} em termos das funções corretamente arredondadas @ref{2843,,exp()} e @ref{284e,,ln()}. O resultado é bem definido, mas apenas “quase sempre corretamente arredondado”.


Com três argumentos, calcula @code{(x**y) % modulo}. Para o formulário de três argumentos, as seguintes restrições nos argumentos são válidas:


@itemize -

@item 
todos os três argumentos devem ser inteiros

@item 
@code{y} não pode ser negativo

@item 
pelo menos um de @code{x} ou @code{y} não pode ser negativo

@item 
@code{modulo} não pode ser zero e deve ter pelo menos “precisão” dígitos
@end itemize

O valor resultante de @code{Context.power(x, y, modulo)} é igual ao valor que seria obtido ao computar @code{(x**y) % modulo} com precisão ilimitada, mas é calculado com mais eficiência . O expoente do resultado é zero, independentemente dos expoentes de @code{x}, @code{y} e @code{modulo}. O resultado é sempre exato.
@end deffn

@geindex quantize() (método decimal.Context)
@anchor{library/decimal decimal Context quantize}@anchor{2862}
@deffn {Método} quantize (x, y, /)

Retorna um valor igual a `x' (arredondado), com o expoente de `y'.
@end deffn

@geindex radix() (método decimal.Context)
@anchor{library/decimal decimal Context radix}@anchor{2863}
@deffn {Método} radix ()

Só retorna 10, já que isso é Decimal, :)
@end deffn

@geindex remainder() (método decimal.Context)
@anchor{library/decimal decimal Context remainder}@anchor{2864}
@deffn {Método} remainder (x, y, /)

Retorna o resto da divisão inteira.

O sinal do resultado, se diferente de zero, é o mesmo que o do dividendo original.
@end deffn

@geindex remainder_near() (método decimal.Context)
@anchor{library/decimal decimal Context remainder_near}@anchor{2865}
@deffn {Método} remainder_near (x, y, /)

Retorna @code{x - y * n}, onde `n' é o número inteiro mais próximo do valor exato de @code{x / y} (se o resultado for 0, seu sinal será o sinal de `x').
@end deffn

@geindex rotate() (método decimal.Context)
@anchor{library/decimal decimal Context rotate}@anchor{2866}
@deffn {Método} rotate (x, y, /)

Retorna uma cópia re de `x', `y' vezes.
@end deffn

@geindex same_quantum() (método decimal.Context)
@anchor{library/decimal decimal Context same_quantum}@anchor{2867}
@deffn {Método} same_quantum (x, y, /)

Retorna @code{True} se os dois operandos tiverem o mesmo expoente.
@end deffn

@geindex scaleb() (método decimal.Context)
@anchor{library/decimal decimal Context scaleb}@anchor{2868}
@deffn {Método} scaleb (x, y, /)

Retorna o primeiro operando após adicionar o segundo valor seu exp.
@end deffn

@geindex shift() (método decimal.Context)
@anchor{library/decimal decimal Context shift}@anchor{2869}
@deffn {Método} shift (x, y, /)

Retorna uma cópia deslocada de `x', `y' vezes.
@end deffn

@geindex sqrt() (método decimal.Context)
@anchor{library/decimal decimal Context sqrt}@anchor{286a}
@deffn {Método} sqrt (x, /)

Raiz quadrada de um número não negativo para precisão do contexto.
@end deffn

@geindex subtract() (método decimal.Context)
@anchor{library/decimal decimal Context subtract}@anchor{286b}
@deffn {Método} subtract (x, y, /)

Retorna a diferença entre `x' e `y'.
@end deffn

@geindex to_eng_string() (método decimal.Context)
@anchor{library/decimal decimal Context to_eng_string}@anchor{286c}
@deffn {Método} to_eng_string (x, /)

Converte em uma string, usando notação de engenharia, se for necessário um expoente.

A notação de engenharia possui um expoente que é múltiplo de 3. Isso pode deixar até 3 dígitos à esquerda da casa decimal e pode exigir a adição de um ou dois zeros à direita.
@end deffn

@geindex to_integral_exact() (método decimal.Context)
@anchor{library/decimal decimal Context to_integral_exact}@anchor{286d}
@deffn {Método} to_integral_exact (x, /)

Arredonda para um número inteiro.
@end deffn

@geindex to_sci_string() (método decimal.Context)
@anchor{library/decimal decimal Context to_sci_string}@anchor{286e}
@deffn {Método} to_sci_string (x, /)

Converte um número em uma string usando notação científica.
@end deffn
@end deffn

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Constantes<4>,Modos de arredondamento,Objetos de contexto,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal constants}@anchor{286f}@anchor{library/decimal decimal-rounding-modes}@anchor{2870}
@subsubsection Constantes


As constantes nesta seção são relevantes apenas para o módulo C. Eles também estão incluídos na versão pura do Python para compatibilidade.


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32 bits

@tab

64 bits

@item

@geindex MAX_PREC (no módulo decimal)
@anchor{library/decimal decimal MAX_PREC}@anchor{10df}
@deffn {Dado} decimal.MAX_PREC
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MAX_EMAX (no módulo decimal)
@anchor{library/decimal decimal MAX_EMAX}@anchor{10e0}
@deffn {Dado} decimal.MAX_EMAX
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MIN_EMIN (no módulo decimal)
@anchor{library/decimal decimal MIN_EMIN}@anchor{10e1}
@deffn {Dado} decimal.MIN_EMIN
@end deffn

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@item

@geindex MIN_ETINY (no módulo decimal)
@anchor{library/decimal decimal MIN_ETINY}@anchor{2871}
@deffn {Dado} decimal.MIN_ETINY
@end deffn

@tab

@code{-849999999}

@tab

@code{-1999999999999999997}

@end multitable


@geindex HAVE_THREADS (no módulo decimal)
@anchor{library/decimal decimal HAVE_THREADS}@anchor{10dd}
@deffn {Dado} decimal.HAVE_THREADS

O valor é @code{True}. Descontinuado porque o Python agora sempre tem threads.


Descontinuado desde a versão 3.9.

@end deffn

@geindex HAVE_CONTEXTVAR (no módulo decimal)
@anchor{library/decimal decimal HAVE_CONTEXTVAR}@anchor{1efb}
@deffn {Dado} decimal.HAVE_CONTEXTVAR

O valor padrão é @code{True}. Se o Python for @ref{1efa,,configurado usando a opção --without-decimal-contextvar}, a versão C usará um contexto local de thread em vez de local de corrotina e o valor será @code{False}. Isso é um pouco mais rápido em alguns cenários de contexto aninhados.


Adicionado na versão 3.8.3.

@end deffn

@node Modos de arredondamento,Sinais,Constantes<4>,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal rounding-modes}@anchor{2830}
@subsubsection Modos de arredondamento


@geindex ROUND_CEILING (no módulo decimal)
@anchor{library/decimal decimal ROUND_CEILING}@anchor{27e5}
@deffn {Dado} decimal.ROUND_CEILING

Arredonda para @code{Infinity}.
@end deffn

@geindex ROUND_DOWN (no módulo decimal)
@anchor{library/decimal decimal ROUND_DOWN}@anchor{27e6}
@deffn {Dado} decimal.ROUND_DOWN

Arredonda para zero.
@end deffn

@geindex ROUND_FLOOR (no módulo decimal)
@anchor{library/decimal decimal ROUND_FLOOR}@anchor{27e7}
@deffn {Dado} decimal.ROUND_FLOOR

Arredonda para @code{-Infinity}.
@end deffn

@geindex ROUND_HALF_DOWN (no módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_DOWN}@anchor{27e8}
@deffn {Dado} decimal.ROUND_HALF_DOWN

Arrendonda para o mais próximo com empates tendendo a zero.
@end deffn

@geindex ROUND_HALF_EVEN (no módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_EVEN}@anchor{27e9}
@deffn {Dado} decimal.ROUND_HALF_EVEN

Arredonda para o mais próximo com empates indo para o mais próximo inteiro par.
@end deffn

@geindex ROUND_HALF_UP (no módulo decimal)
@anchor{library/decimal decimal ROUND_HALF_UP}@anchor{27ea}
@deffn {Dado} decimal.ROUND_HALF_UP

Arrendonda para o mais próximo com empates se afastando de zero.
@end deffn

@geindex ROUND_UP (no módulo decimal)
@anchor{library/decimal decimal ROUND_UP}@anchor{27eb}
@deffn {Dado} decimal.ROUND_UP

Arredonda se afastando de zero.
@end deffn

@geindex ROUND_05UP (no módulo decimal)
@anchor{library/decimal decimal ROUND_05UP}@anchor{27ec}
@deffn {Dado} decimal.ROUND_05UP

Arredonda se afastando de zero se o último dígito após o arredondamento para zero fosse 0 ou 5; caso contrário, arredonda para zero.
@end deffn

@node Sinais,Observações sobre ponto flutuante,Modos de arredondamento,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-signals}@anchor{2872}@anchor{library/decimal signals}@anchor{2873}
@subsubsection Sinais


Sinais representam condições que surgem durante o cálculo. Cada um corresponde a um sinalizador de contexto e um ativador de armadilha de contexto.

O sinalizador de contexto é definido sempre que a condição é encontrada. Após o cálculo, os sinalizadores podem ser verificados para fins informativos (por exemplo, para determinar se um cálculo era exato). Depois de verificar os sinalizadores, certifique-se de limpar todos os sinalizadores antes de iniciar o próximo cálculo.

Se o ativador de armadilha de contexto estiver definido para o sinal, a condição fará com que uma exceção Python seja levantada. Por exemplo, se a armadilha @ref{27ee,,DivisionByZero} for configurada, uma exceção @ref{27ee,,DivisionByZero} será levantada ao encontrar a condição.

@geindex Clamped (classe em decimal)
@anchor{library/decimal decimal Clamped}@anchor{27ed}
@deffn {Classe} decimal.Clamped

Altera um expoente para ajustar as restrições de representação.

Normalmente, `clamping' ocorre quando um expoente fica fora dos limites do contexto @ref{10e6,,Emin} e @ref{10e5,,Emax}. Se possível, o expoente é reduzido para caber adicionando zeros ao coeficiente.
@end deffn

@geindex DecimalException (classe em decimal)
@anchor{library/decimal decimal DecimalException}@anchor{2874}
@deffn {Classe} decimal.DecimalException

Classe base para outros sinais e uma subclasse de @ref{241a,,ArithmeticError}.
@end deffn

@geindex DivisionByZero (classe em decimal)
@anchor{library/decimal decimal DivisionByZero}@anchor{27ee}
@deffn {Classe} decimal.DivisionByZero

Sinaliza a divisão de um número não infinito por zero.

Pode ocorrer com divisão, divisão de módulo ou ao elevar um número a uma potência negativa. Se este sinal não for capturado, retornará @code{Infinity} ou @code{-Infinity} com o sinal determinado pelas entradas do cálculo.
@end deffn

@geindex Inexact (classe em decimal)
@anchor{library/decimal decimal Inexact}@anchor{27ef}
@deffn {Classe} decimal.Inexact

Indica que o arredondamento ocorreu e o resultado não é exato.

Sinaliza quando dígitos diferentes de zero foram descartados durante o arredondamento. O resultado arredondado é retornado. O sinalizador ou armadilha de sinal é usado para detectar quando os resultados são inexatos.
@end deffn

@geindex InvalidOperation (classe em decimal)
@anchor{library/decimal decimal InvalidOperation}@anchor{10e7}
@deffn {Classe} decimal.InvalidOperation

Uma operação inválida foi realizada.

Indica que uma operação foi solicitada que não faz sentido. Se não for capturado, retorna @code{NaN}. As possíveis causas incluem:

@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 (classe em decimal)
@anchor{library/decimal decimal Overflow}@anchor{27f2}
@deffn {Classe} decimal.Overflow

Estouro numérico.

Indica que o expoente é maior que @ref{10e5,,Context.Emax} após o arredondamento ocorrer. Se não for capturado, o resultado depende do modo de arredondamento, puxando para dentro para o maior número finito representável ou arredondando para fora para @code{Infinity}. Nos dois casos, @ref{27ef,,Inexact} e @ref{27f0,,Rounded} também são sinalizados.
@end deffn

@geindex Rounded (classe em decimal)
@anchor{library/decimal decimal Rounded}@anchor{27f0}
@deffn {Classe} decimal.Rounded

O arredondamento ocorreu, embora possivelmente nenhuma informação tenha sido perdida.

Sinalizado sempre que o arredondamento descarta dígitos; mesmo que esses dígitos sejam zero (como arredondamento @code{5.00} a @code{5.0}). Se não for capturado, retorna o resultado inalterado. Este sinal é usado para detectar a perda de dígitos significativos.
@end deffn

@geindex Subnormal (classe em decimal)
@anchor{library/decimal decimal Subnormal}@anchor{27f1}
@deffn {Classe} decimal.Subnormal

O expoente foi menor que @ref{10e6,,Emin} antes do arredondamento.

Ocorre quando um resultado da operação é subnormal (o expoente é muito pequeno). Se não for capturado, retorna o resultado inalterado.
@end deffn

@geindex Underflow (classe em decimal)
@anchor{library/decimal decimal Underflow}@anchor{27f3}
@deffn {Classe} decimal.Underflow

Estouro negativo numérico com resultado arredondado para zero.

Ocorre quando um resultado subnormal é empurrado para zero arredondando. @ref{27ef,,Inexact} e @ref{27f1,,Subnormal} também são sinalizados.
@end deffn

@geindex FloatOperation (classe em decimal)
@anchor{library/decimal decimal FloatOperation}@anchor{10dc}
@deffn {Classe} decimal.FloatOperation

Ativa semânticas mais rigorosas para misturar objetos de float com de Decimal.

Se o sinal não for capturado (padrão), a mistura de tipos float e Decimal será permitida no construtor @ref{29d,,Decimal}, @ref{10e8,,create_decimal()} e em todos os operadores de comparação. Tanto a conversão quanto as comparações são exatas. Qualquer ocorrência de uma operação mista é registrada silenciosamente pela configuração @ref{10dc,,FloatOperation} nos sinalizadores de contexto. Conversões explícitas com @ref{1244,,from_float()} ou @ref{2835,,create_decimal_from_float()} não definem o sinalizador.

Caso contrário (o sinal é capturado), apenas comparações de igualdade e conversões explícitas são silenciosas. Todas as outras operações mistas levantam @ref{10dc,,FloatOperation}.
@end deffn

A tabela a seguir resume a hierarquia de sinais:

@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 Observações sobre ponto flutuante,Trabalhando com threads,Sinais,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-notes}@anchor{2875}@anchor{library/decimal floating-point-notes}@anchor{2876}
@subsubsection Observações sobre ponto flutuante


@menu
* Atenuando o erro de arredondamento com maior precisão:: 
* Valores especiais:: 

@end menu

@node Atenuando o erro de arredondamento com maior precisão,Valores especiais,,Observações sobre ponto flutuante
@anchor{library/decimal mitigating-round-off-error-with-increased-precision}@anchor{2877}
@subsubsection Atenuando o erro de arredondamento com maior precisão


O uso do ponto flutuante decimal elimina o erro de representação decimal (possibilitando representar @code{0.1} de forma exata); no entanto, algumas operações ainda podem sofrer erros de arredondamento quando dígitos diferentes de zero excederem a precisão fixa.

Os efeitos do erro de arredondamento podem ser amplificados pela adição ou subtração de quantidades quase compensadoras, resultando em perda de significância. Knuth fornece dois exemplos instrutivos em que a aritmética de ponto flutuante arredondado com precisão insuficiente causa a quebra das propriedades associativas e distributivas da adição:

@example
# exemplos de 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

O módulo @ref{36,,decimal} permite restaurar as identidades expandindo a precisão o suficiente para evitar perda de significância:

@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 especiais,,Atenuando o erro de arredondamento com maior precisão,Observações sobre ponto flutuante
@anchor{library/decimal special-values}@anchor{2878}
@subsubsection Valores especiais


O sistema numérico para o módulo @ref{36,,decimal} fornece valores especiais, incluindo @code{NaN}, @code{sNaN}, @code{-Infinity}, @code{Infinity}, e dois zeros, @code{+0} e @code{-0}.

Os infinitos podem ser construídos diretamente com: @code{Decimal('Infinity')}. Além disso, eles podem resultar da divisão por zero quando o sinal @ref{27ee,,DivisionByZero} não é capturado. Da mesma forma, quando o sinal @ref{27f2,,Overflow} não é capturado, o infinito pode resultar do arredondamento além dos limites do maior número representável.

Os infinitos contêm sinais (afins) e podem ser usados em operações aritméticas, onde são tratados como números muito grandes e indeterminados. Por exemplo, adicionar uma constante ao infinito fornece outro resultado infinito.

Algumas operações são indeterminadas e retornam @code{NaN} ou, se o sinal @ref{10e7,,InvalidOperation} for capturado, levanta uma exceção. Por exemplo, @code{0/0} retorna @code{NaN}, que significa “não é um número” em inglês. Esta variação de @code{NaN} é silenciosa e, uma vez criada, fluirá através de outros cálculos sempre resultando em outra @code{NaN}. Esse comportamento pode ser útil para uma série de cálculos que ocasionalmente têm entradas ausentes — ele permite que o cálculo continue enquanto sinaliza resultados específicos como inválidos.

Uma variante é @code{sNaN}, que sinaliza em vez de permanecer em silêncio após cada operação. Esse é um valor de retorno útil quando um resultado inválido precisa interromper um cálculo para tratamento especial.

O comportamento dos operadores de comparação do Python pode ser um pouco surpreendente onde um @code{NaN} está envolvido. Um teste de igualdade em que um dos operandos é um @code{NaN} silencioso ou sinalizador sempre retorna @ref{b49,,False} (mesmo ao fazer @code{Decimal('NaN')==Decimal('NaN')}), enquanto um teste de desigualdade sempre retorna @ref{c27,,True}. Uma tentativa de comparar dois decimais usando qualquer um dos operadores @code{<}, @code{<=}, @code{>} ou @code{>=} levantará o sinal @ref{10e7,,InvalidOperation} se um dos operandos for um @code{NaN} e retorna @ref{b49,,False} se esse sinal não for capturado. Observe que a especificação aritmética decimal geral não especifica o comportamento das comparações diretas; estas regras para comparações envolvendo a @code{NaN} foram retiradas do padrão IEEE 854 (consulte a Tabela 3 na seção 5.7). Para garantir uma rígida conformidade com os padrões, use os métodos @ref{27fd,,compare()} e @ref{27fe,,compare_signal()}.

Os zeros com sinais podem resultar de cálculos insuficientes. Eles mantêm o sinal que teria resultado se o cálculo tivesse sido realizado com maior precisão. Como sua magnitude é zero, os zeros positivos e negativos são tratados como iguais e seu sinal é informacional.

Além dos dois zeros com sinais que são distintos e iguais, existem várias representações de zero com diferentes precisões e ainda com valor equivalente. Isso leva um pouco de tempo para se acostumar. Para um olho acostumado a representações de ponto flutuante normalizadas, não é imediatamente óbvio que o seguinte cálculo retorne um valor igual a zero:

@example
>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Trabalhando com threads,Receitas,Observações sobre ponto flutuante,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-threads}@anchor{2879}@anchor{library/decimal working-with-threads}@anchor{287a}
@subsubsection Trabalhando com threads


A função @ref{16be,,getcontext()} acessa um objeto @ref{10ee,,Context} diferente para cada thread. Ter contextos de threads separadas significa que as threads podem fazer alterações (como @code{getcontext().prec=10}) sem interferir em outras threads.

Da mesma forma, a função @ref{27f6,,setcontext()} atribui automaticamente seu alvo à thread atual.

Se @ref{27f6,,setcontext()} não tiver sido chamado antes de @ref{16be,,getcontext()}, então @ref{16be,,getcontext()} criará automaticamente um novo contexto para uso na thread atual.

O novo contexto é copiado de um contexto protótipo chamado `DefaultContext'. Para controlar os padrões para que cada thread, use os mesmos valores em todo a aplicação, modifique diretamente o objeto `DefaultContext'. Isso deve ser feito `antes' de qualquer thread ser iniciada, para que não haja uma condição de corrida entre as threads chamando @ref{16be,,getcontext()}. Por exemplo:

@example
# Define padrões para todo a aplicação para todas as threads prestes a serem iniciadas
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# Depois, as threads podem ser iniciadas
t1.start()
t2.start()
t3.start()
 . . .
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Receitas,FAQ sobre Decimal,Trabalhando com threads,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-recipes}@anchor{287b}@anchor{library/decimal recipes}@anchor{287c}
@subsubsection Receitas


Aqui estão algumas receitas que servem como funções utilitárias e que demonstram maneiras de trabalhar com a classe @ref{29d,,Decimal}:

@example
def moneyfmt(value, places=2, curr='@w{'}, sep=',', dp='.',
             pos='@w{'}, neg='-', trailneg='@w{'}):
    """Converte Decimal para uma string formatada de moeda.

    places:  número obrigatório de casas após o ponto decimal
    curr:    símbolo de moeda opcional antes do sinal (pode estar em branco)
    sep:     separador de agrupamento opcional (vírgula, ponto, espaço ou espaço em branco)
    dp:      indicador de ponto decimal (vírgula ou ponto)
             especificar como espaço em branco somente quando places for zero
    pos:     sinal opcional para números positivos: '+', espaço ou espaço em branco
    neg:     sinal opcional para números negativos: '-', '(', espaço ou espaço em branco
    trailneg:indicador de menos final opcional: '-', ')', espaço ou espaço em branco

    >>> 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 casas --> '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():
    """Calcula Pi com a precisão atual.

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # dígitos extras para casas intermediárias
    three = Decimal(3)      # substitui "three=3.0" para pontos flutuantes regulares
    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               # unário com mais aplica a nova precisão

def exp(x):
    """Retorna e elevado à potência de x. O tipo de resultado corresponde ao tipo de entrada.

    >>> 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):
    """Retorna o cosseno de x medido em radianos.

    A aproximação da série de Taylor funciona melhor para um valor pequeno de x.
    Para valores maiores, primeiro calcule 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):
    """Retorna o seno de x medido em radianos.

    A aproximação da série de Taylor funciona melhor para um valor pequeno de x.
    Para valores maiores, primeiro calcule 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 FAQ sobre Decimal,,Receitas,decimal — Aritmética de ponto fixo decimal e ponto flutuante
@anchor{library/decimal decimal-faq}@anchor{287d}@anchor{library/decimal id1}@anchor{287e}
@subsubsection FAQ sobre Decimal


P: É complicado digitar @code{decimal.Decimal('1234.5')}. Existe uma maneira de minimizar a digitação ao usar o interpretador interativo?

R: Alguns usuários abreviam o construtor para apenas uma única letra:

@example
>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')
@end example

P: Em uma aplicação de ponto fixo com duas casas decimais, algumas entradas têm muitas casas e precisam ser arredondadas. Outros não devem ter dígitos em excesso e precisam ser validados. Quais métodos devem ser usados?

R: O método @ref{10ef,,quantize()} arredonda para um número fixo de casas decimais. Se a armadilha @ref{27ef,,Inexact} estiver configurada, também será útil para validação:

@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: Assim que eu tiver entradas de duas casas válidas, como mantenho essa invariante em uma aplicação?

R: Algumas operações como adição, subtração e multiplicação por um número inteiro preservam automaticamente o ponto fixo. Outras operações, como divisão e multiplicação não inteira, alteram o número de casas decimais e precisam ser seguidas com uma etapa @ref{10ef,,quantize()}:

@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

No desenvolvimento de aplicações de ponto fixo, é conveniente definir funções para manipular a etapa @ref{10ef,,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: Existem várias maneiras de expressar o mesmo valor. Os números @code{200}, @code{200.000}, @code{2E2} e @code{.02E+4} têm todos o mesmo valor em várias precisões. Existe uma maneira de transformá-los em um único valor canônico reconhecível?

R: O método @ref{281e,,normalize()} mapeia todos os valores equivalentes para um único representativo:

@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: Quando ocorre o arredondamento em um cálculo?

R: Ocorre `após' o cálculo. A filosofia da especificação decimal é que os números são considerados exatos e criados independentemente do contexto atual. Eles podem até ter maior precisão do que o contexto atual. O processo de cálculo com essas entradas exatas e, em seguida, o arredondamento (ou outras operações de contexto) é aplicado ao `resultado' do cálculo:

@example
>>> getcontext().prec = 5
>>> pi = Decimal('3.1415926535')   # Mais de 5 dígitos
>>> pi                             # Todos os dígitos são retidos
Decimal('3.1415926535')
>>> pi + 0                         # Arredondado após uma adição
Decimal('3.1416')
>>> pi - Decimal('0.00005')        # Subtrai números não arredondados e depois arredonda
Decimal('3.1415')
>>> pi + 0 - Decimal('0.00005').   # Os valores intermediários são arredondados
Decimal('3.1416')
@end example

P: Alguns valores decimais sempre são exibidas com notação exponencial. Existe uma maneira de obter uma representação não exponencial?

R: Para alguns valores, a notação exponencial é a única maneira de expressar o número de casas significativas no coeficiente. Por exemplo, expressar @code{5.0E+3} como @code{5000} mantém o valor constante, mas não pode mostrar a significância de duas casa do original.

Se uma aplicação não se importa com o rastreamento da significância, é fácil remover o expoente e os zeros à direita, perdendo a significância, mas mantendo o valor inalterado:

@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: Existe uma maneira de converter um float comum em um @ref{29d,,Decimal}?

R: Sim, qualquer número de ponto flutuante binário pode ser expresso exatamente como um Decimal, embora uma conversão exata possa exigir mais precisão do que a intuição sugere:

@example
>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')
@end example

P: Em um cálculo complexo, como posso ter certeza de que não obtive um resultado falso devido à precisão insuficiente ou a anomalias de arredondamento.

R: O módulo decimal facilita o teste de resultados. Uma boa prática é executar novamente os cálculos usando maior precisão e com vários modos de arredondamento. Resultados amplamente diferentes indicam precisão insuficiente, problemas no modo de arredondamento, entradas mal condicionadas ou um algoritmo numericamente instável.

P: Notei que a precisão do contexto é aplicada aos resultados das operações, mas não às entradas. Há algo a observar ao misturar valores de diferentes precisões?

R: Sim. O princípio é que todos os valores são considerados exatos, assim como a aritmética desses valores. Somente os resultados são arredondados. A vantagem das entradas é que “o que você vê é o que você obtém”. Uma desvantagem é que os resultados podem parecer estranhos se você esquecer que as entradas não foram arredondadas:

@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

A solução é aumentar a precisão ou forçar o arredondamento das entradas usando a operação unária de mais:

@example
>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # unary plus triggers rounding
Decimal('1.23')
@end example

Como alternativa, as entradas podem ser arredondadas na criação usando o método @ref{10e8,,Context.create_decimal()}:

@example
>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')
@end example

P: A implementação do CPython é rápida para números grandes?

A: Sim. Nas implementações CPython e PyPy3, as versões C/CFFI do módulo decimal integram a biblioteca de alta velocidade libmpdec@footnote{https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html} para precisão arbitrária de aritmética de ponto flutuante decimal corretamente arredondado @footnote{

Adicionado na versão 3.3.

}. @code{libmpdec} usa a multiplicação de Karatsuba@footnote{https://pt.wikipedia.org/wiki/Algoritmo_de_Karatsuba} para números com tamanho médio e a Transformada Numérica de Fourier@footnote{https://en.wikipedia.org/wiki/Discrete_Fourier_transform_(general)#Number-theoretic_transform} para números muito grandes.

O contexto deve ser adaptado para uma aritmética exata de precisão arbitrária. @ref{10e6,,Emin} e @ref{10e5,,Emax} devem sempre ser configurados com os valores máximos, @ref{11dd,,clamp} deve sempre ser 0 (o padrão). A configuração de @ref{282e,,prec} requer alguns cuidados.

A abordagem mais fácil para testar a aritmética do bignum é usar o valor máximo para @ref{282e,,prec} também @footnote{

Alterado na versão 3.9: Esta abordagem agora funciona para todos os resultados exatos, exceto para potências de números que não sejam inteiros.

}:

@example
>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')
@end example

Para resultados inexatos, @ref{10df,,MAX_PREC} é muito grande em plataformas de 64 bits e a memória disponível será insuficiente:

@example
>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError
@end example

Em sistemas com alocação excessiva (por exemplo, Linux), uma abordagem mais sofisticada é ajustar @ref{282e,,prec} à quantidade de RAM disponível. Suponha que você tenha 8 GB de RAM e espere 10 operandos simultâneos usando no máximo 500 MB cada:

@example
>>> import sys
>>>
>>> # Número máximo de dígitos para um único operando usando 500 MB
>>> # em palavras de 8 bytes com 19 dígitos por palavra (4 bytes e 9 dígitos
>>> # para a construção de 32 bits):
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # Confere que isso funciona:
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # Preenche a precisão disponível com noves:
>>> 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

Em geral (e especialmente em sistemas sem alocação excessiva), recomenda-se estimar limites ainda mais apertados e definir a armadilha @ref{27ef,,Inexact} se for esperado que todos os cálculos sejam mais precisos.

@node fractions — Números racionais,random — Gera números pseudoaleatórios,decimal — Aritmética de ponto fixo decimal e ponto flutuante,Módulos Matemáticos e Numéricos
@anchor{library/fractions doc}@anchor{287f}@anchor{library/fractions fractions-rational-numbers}@anchor{2880}@anchor{library/fractions module-fractions}@anchor{5d}@anchor{library/fractions translation-repo}@anchor{2881}
@subsection @code{fractions} — Números racionais


@geindex module; fractions

`Código-fonte:' Lib/fractions.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/fractions.py}


__________________________________________________________________


O módulo @ref{5d,,fractions} fornece suporte para aritmética de números racionais.

Uma instância de Fraction pode ser construída a partir de um par de números racionais, de um único número ou de uma string.

@geindex Fraction (classe em fractions)
@anchor{library/fractions fractions Fraction}@anchor{1e7}
@deffn {Classe} fractions.Fraction (numerator=0, denominator=1)

@deffnx {Classe} fractions.Fraction (other_fraction)

@deffnx {Classe} fractions.Fraction (float)

@deffnx {Classe} fractions.Fraction (decimal)

@deffnx {Classe} fractions.Fraction (string)

A primeira versão requer que `numerator' e `denominator' sejam instâncias de @ref{1301,,numbers.Rational} e retorna uma nova instância de @ref{1e7,,Fraction} com um valor igual a @code{numerator/denominator}. Se `denominator' for zero, ele levanta uma @ref{94c,,ZeroDivisionError}. A segunda versão requer que `other_fraction' seja uma instância de @ref{1301,,numbers.Rational} e retorna uma instância de @ref{1e7,,Fraction} com o mesmo valor. As próximas duas versões aceitam uma instância de @ref{2f7,,float} ou @ref{29d,,decimal.Decimal} e retornam uma instância de @ref{1e7,,Fraction} com exatamente o mesmo valor. Note que devido aos problemas usuais com ponto flutuante binário (veja @ref{1e99,,Aritmética de ponto flutuante; problemas e limitações}), o argumento para @code{Fraction(1.1)} não é exatamente igual a 11/10, e então @code{Fraction(1.1)} `não' retorna @code{Fraction(11, 10)} como seria de se esperar. (Mas veja a documentação para o método @ref{2882,,limit_denominator()} abaixo.) A última versão do construtor espera uma instância de string ou unicode. A forma usual para esta instância é:

@example
[sinal] numerador ['/' denominador]
@end example

onde o @code{sign} opcional pode ser ‘+’ ou ‘-’ e @code{numerator} e @code{denominator} (se presente) são strings de dígitos decimais (sublinhados podem ser usados para delimitar dígitos como com literais integrais no código). Além disso, qualquer string que represente um valor finito e seja aceita pelo construtor @ref{2f7,,float} também é aceita pelo construtor @ref{1e7,,Fraction}. Em qualquer forma, a string de entrada também pode ter espaços em branco à esquerda e/ou à direita. Aqui estão alguns exemplos:

@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

A classe @ref{1e7,,Fraction} herda da classe base abstrata @ref{1301,,numbers.Rational} e implementa todos os métodos e operações dessa classe. As instâncias de @ref{1e7,,Fraction} são @ref{610,,hasheável} e devem ser tratadas como imutáveis. Além disso, @ref{1e7,,Fraction} tem as seguintes propriedades e métodos:


Alterado na versão 3.2: O construtor @ref{1e7,,Fraction} agora aceita instâncias @ref{2f7,,float} e @ref{29d,,decimal.Decimal}.



Alterado na versão 3.9: A função @ref{916,,math.gcd()} agora é usada para normalizar o `numerator' e o `denominator'. @ref{916,,math.gcd()} sempre retorna um tipo @ref{257,,int}. Anteriormente, o tipo GCD dependia do `numerator' e do `denominator'.



Alterado na versão 3.11: Sublinhados agora são permitidos ao criar uma instância @ref{1e7,,Fraction} a partir de uma string, seguindo as regras 
@geindex Propostas de Melhorias do Python; PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/}.



Alterado na versão 3.11: @ref{1e7,,Fraction} implementa @code{__int__} agora para satisfazer verificações de instância @code{typing.SupportsInt}.



Alterado na versão 3.12: É permitido espaço ao redor da barra para entradas de string: @code{Fraction('2 / 3')}.



Alterado na versão 3.12: Instâncias de @ref{1e7,,Fraction} agora oferecem suporte à formatação no estilo float, com tipos de apresentação @code{"e"}, @code{"E"}, @code{"f"}, @code{"F"}, @code{"g"}, @code{"G"} e @code{"%""}.



Alterado na versão 3.13: A formatação de instâncias @ref{1e7,,Fraction} sem um tipo de apresentação agora oferece suporte a preenchimento, alinhamento, tratamento de sinais, largura mínima e agrupamento.


@geindex numerator (atributo fractions.Fraction)
@anchor{library/fractions fractions Fraction numerator}@anchor{2883}
@deffn {Atributo} numerator

Numerador de Fraction no menor termo.
@end deffn

@geindex denominator (atributo fractions.Fraction)
@anchor{library/fractions fractions Fraction denominator}@anchor{2884}
@deffn {Atributo} denominator

Denominador de Fraction em termos mínimos. Garantidamente positivo.
@end deffn

@geindex as_integer_ratio() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction as_integer_ratio}@anchor{2885}
@deffn {Método} as_integer_ratio ()

Retorna uma tupla de dois inteiros, cuja razão é igual a Fraction original. A razão está em termos mais baixos e tem um denominador positivo.


Adicionado na versão 3.8.

@end deffn

@geindex is_integer() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction is_integer}@anchor{2886}
@deffn {Método} is_integer ()

Retorna @code{True} se a Fraction for um inteiro.


Adicionado na versão 3.12.

@end deffn

@geindex from_float() (método de classe fractions.Fraction)
@anchor{library/fractions fractions Fraction from_float}@anchor{1245}
@deffn {Método} classmethod from_float (f)

Construtor alternativo que aceita apenas instâncias de @ref{2f7,,float} ou @ref{214b,,numbers.Integral}. Esteja ciente de que @code{Fraction.from_float(0.3)} não é o mesmo valor que @code{Fraction(3, 10)}.

@cartouche
@quotation Nota 
A partir do Python 3.2, você também pode construir uma instância @ref{1e7,,Fraction} diretamente de um @ref{2f7,,float}.
@end quotation
@end cartouche
@end deffn

@geindex from_decimal() (método de classe fractions.Fraction)
@anchor{library/fractions fractions Fraction from_decimal}@anchor{1246}
@deffn {Método} classmethod from_decimal (dec)

Construtor alternativo que aceita somente instâncias de @ref{29d,,decimal.Decimal} ou @ref{214b,,numbers.Integral}.

@cartouche
@quotation Nota 
A partir do Python 3.2, você também pode construir uma instância @ref{1e7,,Fraction} diretamente de uma instância de @ref{29d,,decimal.Decimal}.
@end quotation
@end cartouche
@end deffn

@geindex limit_denominator() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction limit_denominator}@anchor{2882}
@deffn {Método} limit_denominator (max_denominator=1000000)

Encontra e retorna o @ref{1e7,,Fraction} mais próximo de @code{self} que tem denominador no máximo max_denominator. Este método é útil para encontrar aproximações racionais para um dado número de ponto flutuante:

@example
>>> from fractions import Fraction
>>> Fraction('3.1415926535897932').limit_denominator(1000)
Fraction(355, 113)
@end example

ou para recuperar um número racional que é representado como um ponto flutuante:

@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 fractions.Fraction)
@anchor{library/fractions fractions Fraction __floor__}@anchor{187f}
@deffn {Método} __floor__ ()

Retorna o maior @ref{257,,int} @code{<= self}. Este método também pode ser acessado por meio da função @ref{1404,,math.floor()}:

@example
>>> from math import floor
>>> floor(Fraction(355, 113))
3
@end example
@end deffn

@geindex __ceil__() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction __ceil__}@anchor{187e}
@deffn {Método} __ceil__ ()

Retorna o menor @ref{257,,int} @code{>= self}. Este método também pode ser acessado por meio da função @ref{1405,,math.ceil()}.
@end deffn

@geindex __round__() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction __round__}@anchor{187d}
@deffn {Método} __round__ ()

@deffnx {Método} __round__ (ndigits)

A primeira versão retorna o @ref{257,,int} mais próximo de @code{self}, arredondando a metade para par. A segunda versão arredonda @code{self} para o múltiplo mais próximo de @code{Fraction(1, 10**ndigits)} (logicamente, se @code{ndigits} for negativo), novamente arredondando a metade para par. Este método também pode ser acessado por meio da função @ref{131d,,round()}.
@end deffn

@geindex __format__() (método fractions.Fraction)
@anchor{library/fractions fractions Fraction __format__}@anchor{2887}
@deffn {Método} __format__ (format_spec, /)

Fornece suporte para formatação de instâncias de @ref{1e7,,Fraction} por meio do método @ref{621,,str.format()}, da função embutida @ref{61f,,format()} ou @ref{9b1,,literais de strings formatadas}.

Se a string de especificação de formato @code{format_spec} não terminar com um dos tipos de apresentação @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} ou @code{'%'}, então a formatação segue as regras gerais para preenchimento, alinhamento, tratamento de sinais, largura mínima e agrupamento, conforme descrito na @ref{1e8,,minilinguagem de especificação de formato}. O sinalizador de “formato alternativo” @code{'#'} é suportado: se presente, ele força a string de saída a sempre incluir um denominador explícito, mesmo quando o valor que está sendo formatado é um inteiro exato. O sinalizador de preenchimento de zeros @code{'0'} não é suportado.

Se a string de especificação de formato @code{format_spec} terminar com um dos tipos de apresentação @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} ou @code{'%'}, então a formatação segue as regras descritas para o tipo @ref{2f7,,float} na seção @ref{1e8,,Minilinguagem de especificação de formato}.

Veja alguns exemplos:

@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 também



@table @asis

@item Módulo @ref{9e,,numbers}

As classes base abstratas que compõem a torre numérica.
@end table


@node random — Gera números pseudoaleatórios,statistics — Funções estatísticas,fractions — Números racionais,Módulos Matemáticos e Numéricos
@anchor{library/random doc}@anchor{2888}@anchor{library/random module-random}@anchor{b8}@anchor{library/random random-generate-pseudo-random-numbers}@anchor{2889}@anchor{library/random translation-repo}@anchor{288a}
@subsection @code{random} — Gera números pseudoaleatórios


@geindex module; random

`Código-fonte:' Lib/random.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/random.py}


__________________________________________________________________


Este módulo implementa geradores de números pseudoaleatórios para várias distribuições.

Para números inteiros, há uma seleção uniforme de um intervalo. Para sequências, há uma seleção uniforme de um elemento aleatório, uma função para gerar uma permutação aleatória de uma lista localmente e uma função para amostragem aleatória sem substituição.

Na linha real, existem funções para calcular distribuições uniforme, normal (gaussiana), log-normal, exponencial negativa, gama e beta. Para gerar distribuições de ângulos, a distribuição de von Mises está disponível.

Quase todas as funções do módulo dependem da função básica @ref{748,,random()}, que gera um ponto flutuante aleatório uniformemente no intervalo semiaberto @code{0.0 <= X < 1.0}. Python usa o Mersenne Twister como gerador de núcleo. Produz pontos flutuantes de precisão de 53 bits e possui um período de 2**19937-1. A implementação subjacente em C é rápida e segura para threads. O Mersenne Twister é um dos geradores de números aleatórios mais amplamente testados existentes. No entanto, sendo completamente determinístico, não é adequado para todos os fins e é totalmente inadequado para fins criptográficos.

As funções fornecidas por este módulo são, na verdade, métodos vinculados de uma instância oculta da classe @ref{19e7,,random.Random}. Você pode instanciar suas próprias instâncias de @ref{19e7,,Random} para obter geradores que não compartilham estado.

A classe @ref{19e7,,Random} também pode ser subclassificada se você quiser usar um gerador básico diferente de sua própria criação: veja a documentação dessa classe para mais detalhes.

O módulo @ref{b8,,random} também fornece a classe @ref{288b,,SystemRandom} que usa a função do sistema @ref{523,,os.urandom()} para gerar números aleatórios a partir de fontes fornecidas pelo sistema operacional.

@cartouche
@quotation Aviso 
Os geradores pseudoaleatórios deste módulo não devem ser usados para fins de segurança. Para segurança ou uso criptográfico, veja o módulo @ref{c0,,secrets}.
@end quotation
@end cartouche


@subsubheading Ver também


M. Matsumoto and 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.

Receita de Complementary-Multiply-with-Carry@footnote{https://code.activestate.com/recipes/576707-long-period-random-number-generator/} para um gerador de números aleatórios alternativo compatível com um longo período e operações de atualização comparativamente simples.


@cartouche
@quotation Nota 
O gerador global de números aleatórios e as instâncias de @ref{19e7,,Random} são seguros para thread. No entanto, na construção com threads livres, chamadas simultâneas ao gerador global ou à mesma instância de @ref{19e7,,Random} podem encontrar contenção e baixo desempenho. Considere usar instâncias separadas de @ref{19e7,,Random} por thread.
@end quotation
@end cartouche

@menu
* Funções de contabilidade:: 
* Funções para bytes:: 
* Funções para inteiros:: 
* Funções para sequências:: 
* Distribuições discretas:: 
* Distribuições com valor real:: 
* Gerador alternativo:: 
* Notas sobre reprodutibilidade:: 
* Exemplos: Exemplos<4>. 
* Receitas: Receitas<2>. 
* Uso na linha de comando: Uso na linha de comando<2>. 
* Exemplos na linha de comando:: 

@end menu

@node Funções de contabilidade,Funções para bytes,,random — Gera números pseudoaleatórios
@anchor{library/random bookkeeping-functions}@anchor{288c}
@subsubsection Funções de contabilidade


@geindex seed() (no módulo random)
@anchor{library/random random seed}@anchor{12b5}
@deffn {Função} random.seed (a=None, version=2)

Inicializa o gerador de números aleatórios.

Se `a' for omitido ou @code{None}, a hora atual do sistema será usada. Se fontes de aleatoriedade são fornecidas pelo sistema operacional, elas são usadas no lugar da hora do sistema (consulte a função @ref{523,,os.urandom()} para detalhes sobre disponibilidade).

If `a' is an int, its absolute value is used directly.

Com a versão 2 (o padrão), o objeto a @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray} é convertido em um objeto @ref{257,,int} e todos os seus bits são usados.

Com a versão 1 (fornecida para reproduzir sequências aleatórias de versões mais antigas do Python), o algoritmo para @ref{44c,,str} e @ref{1c2,,bytes} gera um intervalo mais restrito de sementes.


Alterado na versão 3.2: Movido para o esquema da versão 2, que usa todos os bits em uma semente de strings.



Alterado na versão 3.11: `seed' deve ser um dos seguintes tipos: @code{None}, @ref{257,,int}, @ref{2f7,,float}, @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}.

@end deffn

@geindex getstate() (no módulo random)
@anchor{library/random random getstate}@anchor{288d}
@deffn {Função} random.getstate ()

Retorna um objeto capturando o estado interno atual do gerador. Este objeto pode ser passado para @ref{288e,,setstate()} para restaurar o estado.
@end deffn

@geindex setstate() (no módulo random)
@anchor{library/random random setstate}@anchor{288e}
@deffn {Função} random.setstate (state)

`state' deveria ter sido obtido de uma chamada anterior para @ref{288d,,getstate()}, e @ref{288e,,setstate()} restaura o estado interno do gerador para o que era no momento que @ref{288d,,getstate()} foi chamado.
@end deffn

@node Funções para bytes,Funções para inteiros,Funções de contabilidade,random — Gera números pseudoaleatórios
@anchor{library/random functions-for-bytes}@anchor{288f}
@subsubsection Funções para bytes


@geindex randbytes() (no módulo random)
@anchor{library/random random randbytes}@anchor{1629}
@deffn {Função} random.randbytes (n)

Gera `n' bytes aleatórios.

Este método não deve ser usado para gerar tokens de segurança. Use @ref{2890,,secrets.token_bytes()}.


Adicionado na versão 3.9.

@end deffn

@node Funções para inteiros,Funções para sequências,Funções para bytes,random — Gera números pseudoaleatórios
@anchor{library/random functions-for-integers}@anchor{2891}
@subsubsection Funções para inteiros


@geindex randrange() (no módulo random)
@anchor{library/random random randrange}@anchor{86f}
@deffn {Função} random.randrange (stop)

@deffnx {Função} random.randrange (start, stop[, step])

Retorna um elemento selecionado aleatoriamente de @code{range(start, stop, step)}.

Isso é aproximadamente equivalente a @code{choice(range(start, stop, step))} mas provê suporte a intervalos arbitrariamente grandes e é otimizado para casos comuns.

O padrão de argumento posicional corresponde à função @ref{94a,,range()}.

Argumentos nomeados não devem ser usados porque podem ser interpretados de maneiras inesperadas. Por exemplo @code{randrange(start=100)} é interpretado como @code{randrange(0, 100, 1)}.


Alterado na versão 3.2: @ref{86f,,randrange()} é mais sofisticado em produzir valores igualmente distribuídos. Anteriormente, usava um estilo como @code{int(random()*n)}, que poderia produzir distribuições ligeiramente desiguais.



Alterado na versão 3.12: A conversão automática de tipos não inteiros não é mais suportada. Chamadas como @code{randrange(10.0)} e @code{randrange(Fraction(10, 1))} agora levantam uma @ref{2c3,,TypeError}.

@end deffn

@geindex randint() (no módulo random)
@anchor{library/random random randint}@anchor{1270}
@deffn {Função} random.randint (a, b)

Retorna um inteiro aleatório `N' de forma que @code{a <= N <= b}. Apelido para @code{randrange(a, b+1)}.
@end deffn

@geindex getrandbits() (no módulo random)
@anchor{library/random random getrandbits}@anchor{1043}
@deffn {Função} random.getrandbits (k)

Retorna um número inteiro Python não-negativo com bits aleatórios `k'. Este método é fornecido com o gerador Mersenne Twister e alguns outros geradores também podem fornecê-lo como uma parte opcional da API. Quando disponível, @ref{1043,,getrandbits()} permite que @ref{86f,,randrange()} manipule intervalos arbitrariamente grandes.


Alterado na versão 3.9: Este método agora aceita zero em `k'.

@end deffn

@node Funções para sequências,Distribuições discretas,Funções para inteiros,random — Gera números pseudoaleatórios
@anchor{library/random functions-for-sequences}@anchor{2892}
@subsubsection Funções para sequências


@geindex choice() (no módulo random)
@anchor{library/random random choice}@anchor{1271}
@deffn {Função} random.choice (seq)

Retorna um elemento aleatório da sequência não vazia `seq'. Se `seq' estiver vazio, levanta @ref{157e,,IndexError}.
@end deffn

@geindex choices() (no módulo random)
@anchor{library/random random choices}@anchor{ce6}
@deffn {Função} random.choices (population, weights=None, *, cum_weights=None, k=1)

Retorna uma lista do tamanho de `k' de elementos escolhidos da `population' com substituição. Se a `population' estiver vazio, levanta @ref{157e,,IndexError}.

Se uma sequência `weights' for especificada, as seleções serão feitas de acordo com os pesos relativos. Alternativamente, se uma sequência `cum_weights' for fornecida, as seleções serão feitas de acordo com os pesos cumulativos (talvez calculados usando @ref{a05,,itertools.accumulate()}). Por exemplo, os pesos relativos @code{[10, 5, 30, 5]} são equivalentes aos pesos cumulativos @code{[10, 15, 45, 50]}. Internamente, os pesos relativos são convertidos em pesos acumulados antes de fazer seleções, portanto, fornecer pesos cumulativos economiza trabalho.

Se nem `weights' nem `cum_weights' forem especificados, as seleções serão feitas com igual probabilidade. Se uma sequência de pesos for fornecida, ela deverá ter o mesmo comprimento que a sequência `population'. É um @ref{2c3,,TypeError} para especificar ambos os `weights' e `cum_weights'.

`weights' ou `cum_weights' pode usar qualquer tipo numérico que interopera com os valores @ref{2f7,,float} retornados por @ref{b8,,random()} (que inclui inteiros, pontos flutuantes, e frações mas exclui decimais). Presume-se que pesos serão não-negativos e finitos. Uma @ref{202,,ValueError} é levantada se todos os pesos forem zero.

Para uma dada semente, a função @ref{ce6,,choices()} com igual peso normalmente produz uma sequência diferente das chamadas repetidas para @ref{1271,,choice()}. O algoritmo usado por @ref{1271,,choice()} usa aritmética de ponto flutuante para consistência e velocidade internas. O algoritmo usado por @ref{1271,,choice()} assume como padrão aritmética inteira com seleções repetidas para evitar pequenos vieses de erro de arredondamento.


Adicionado na versão 3.6.



Alterado na versão 3.9: Levanta uma @ref{202,,ValueError} se todos os pesos forem zero.

@end deffn

@geindex shuffle() (no módulo random)
@anchor{library/random random shuffle}@anchor{747}
@deffn {Função} random.shuffle (x)

Embaralha a sequência `x' internamente.

Para embaralhar uma sequência imutável e retornar uma nova lista embaralhada, use @code{sample(x, k=len(x))}.

Observe que, mesmo para pequenos @code{len(x)}, o número total de permutações de `x' pode crescer rapidamente maior que o período da maioria dos geradores de números aleatórios. Isso implica que a maioria das permutações de uma longa sequência nunca pode ser gerada. Por exemplo, uma sequência de comprimento 2080 é a maior que pode caber no período do gerador de números aleatórios Mersenne Twister.


Alterado na versão 3.11: Removido o parâmetro opcional `random'.

@end deffn

@geindex sample() (no módulo random)
@anchor{library/random random sample}@anchor{746}
@deffn {Função} random.sample (population, k, *, counts=None)

Retorna uma lista de comprimento `k' de elementos únicos escolhidos na sequência populacional. Usado para amostragem aleatória sem reposição.

Retorna uma nova lista contendo elementos da população, mantendo a população original inalterada. A lista resultante está na ordem de seleção, para que todas as subfatias também sejam amostras aleatórias válidas. Isso permite que os vencedores do sorteio (a amostra) sejam divididos em grandes prêmios e vencedores de segundo lugar (as subfatias).

Os membros da população não precisam ser @ref{610,,hasheáveis} ou únicos. Se a população contiver repetições, cada ocorrência é uma seleção possível na amostra.

Elementos repetidos podem ser especificados um de cada vez ou com o parâmetro somente-nomeado opcional `count'. Por exemplo, @code{sample(['red', 'blue'], counts=[4, 2], k=5)} é equivalente a @code{sample(['red', 'red', 'red', 'red', 'blue', 'blue'], k=5)}.

Para escolher uma amostra de um intervalo de números inteiros, use um objeto @ref{94a,,range()} como argumento. Isso é especialmente rápido e com eficiência de espaço para amostragem de uma grande população: @code{sample(range(10000000), k=60)}.

Se o tamanho da amostra for maior que o tamanho da população, uma @ref{202,,ValueError} é levantada.


Alterado na versão 3.9: Adicionado o parâmetro `counts'.



Alterado na versão 3.11: `population' deve ser uma sequência. A conversão automática de conjuntos em listas não é mais suportada.

@end deffn

@node Distribuições discretas,Distribuições com valor real,Funções para sequências,random — Gera números pseudoaleatórios
@anchor{library/random discrete-distributions}@anchor{2893}
@subsubsection Distribuições discretas


A função a seguir gera uma distribuição discreta.

@geindex binomialvariate() (no módulo random)
@anchor{library/random random binomialvariate}@anchor{4b0}
@deffn {Função} random.binomialvariate (n=1, p=0.5)

Distribuição binomial@footnote{https://mathworld.wolfram.com/BinomialDistribution.html}. Retorna o número de sucessos para `n' tentativas independentes com a probabilidade de sucesso em cada tentativa sendo `p':

Matematicamente equivalente a:

@example
sum(random() < p for i in range(n))
@end example

O número de tentativas `n' deve ser um número inteiro não negativo. A probabilidade de sucesso `p' deve estar entre @code{0.0 <= p <= 1.0}. O resultado é um número inteiro no intervalo @code{0 <= X <= n}.


Adicionado na versão 3.12.

@end deffn

@node Distribuições com valor real,Gerador alternativo,Distribuições discretas,random — Gera números pseudoaleatórios
@anchor{library/random id1}@anchor{2894}@anchor{library/random real-valued-distributions}@anchor{2895}
@subsubsection Distribuições com valor real


As funções a seguir geram distribuições específicas com valor real. Os parâmetros de função são nomeados após as variáveis correspondentes na equação da distribuição, conforme usadas na prática matemática comum; a maioria dessas equações pode ser encontrada em qualquer texto estatístico.

@geindex random() (no módulo random)
@anchor{library/random random random}@anchor{748}
@deffn {Função} random.random ()

Retorna o próximo número aleatório de ponto flutuante no intervalo @code{0.0 <= X < 1.0}.
@end deffn

@geindex uniform() (no módulo random)
@anchor{library/random random uniform}@anchor{2896}
@deffn {Função} random.uniform (a, b)

Retorna um número de ponto flutuante aleatório `N' de forma que @code{a <= N <= b} para @code{a <= b} e @code{b <= N <= a} para @code{b < a}.

O valor final @code{b} pode ou não ser incluído no intervalo dependendo do arredondamento de ponto flutuante na expressão @code{a + (b-a) * random()}.
@end deffn

@geindex triangular() (no módulo random)
@anchor{library/random random triangular}@anchor{2897}
@deffn {Função} random.triangular (low, high, mode)

Retorna um número de ponto flutuante aleatório `N' de forma que @code{low <= N <= high} e com o `mode' especificado entre esses limites. Os limites `low' e `high' são padronizados como zero e um. O argumento `mode' assume como padrão o ponto médio entre os limites, fornecendo uma distribuição simétrica.
@end deffn

@geindex betavariate() (no módulo random)
@anchor{library/random random betavariate}@anchor{2898}
@deffn {Função} random.betavariate (alpha, beta)

Distribuição beta. As condições nos parâmetros são @code{alpha > 0} e @code{beta > 0}. Os valores retornados variam entre 0 e 1.
@end deffn

@geindex expovariate() (no módulo random)
@anchor{library/random random expovariate}@anchor{4b1}
@deffn {Função} random.expovariate (lambd=1.0)

Distribuição exponencial. `lambd' é 1.0 dividido pela média desejada. Deve ser diferente de zero. (O parâmetro seria chamado “lambda”, mas é uma palavra reservada em Python.) Os valores retornados variam de 0 a infinito positivo se `lambd' for positivo e de infinito negativo a 0 se `lambd' for negativo.


Alterado na versão 3.12: Adicionado o valor padrão para @code{lambd}.

@end deffn

@geindex gammavariate() (no módulo random)
@anchor{library/random random gammavariate}@anchor{2899}
@deffn {Função} random.gammavariate (alpha, beta)

Distribuição gama. (`Não' a função gama!) Os parâmetros de forma e escala, `alfa' e `beta', devem ter valores positivos. (As convenções de chamada variam e algumas fontes definem ‘beta’ como o inverso da escala).

A função de distribuição de probabilidade é:

@example
          x ** (alpha - 1) * math.exp(-x / beta)
pdf(x) =  --------------------------------------
            math.gamma(alpha) * beta ** alpha
@end example
@end deffn

@geindex gauss() (no módulo random)
@anchor{library/random random gauss}@anchor{1962}
@deffn {Função} random.gauss (mu=0.0, sigma=1.0)

Distribuição normal, também chamada de distribuição gaussiana. `mu' é a média e `sigma' é o desvio padrão. Isto é um pouco mais rápido que a função @ref{1963,,normalvariate()} definida abaixo.

Nota sobre multithreading: quando duas threads chamam esta função simultaneamente, é possível que recebam o mesmo valor de retorno. Isso pode ser evitado de três maneiras. 1) Fazer com que cada thread use uma instância diferente do gerador de números aleatórios. 2) Colocar travas em todas as chamadas. 3) Usar a função mais lenta, mas segura para thread @ref{1963,,normalvariate()}.


Alterado na versão 3.11: `mu' e `sigma' agora têm argumentos padrão.

@end deffn

@geindex lognormvariate() (no módulo random)
@anchor{library/random random lognormvariate}@anchor{289a}
@deffn {Função} random.lognormvariate (mu, sigma)

Distribuição log normal. Se você usar o logaritmo natural dessa distribuição, obterá uma distribuição normal com média `mu' e desvio padrão `sigma'. `mu' pode ter qualquer valor e `sigma' deve ser maior que zero.
@end deffn

@geindex normalvariate() (no módulo random)
@anchor{library/random random normalvariate}@anchor{1963}
@deffn {Função} random.normalvariate (mu=0.0, sigma=1.0)

Distribuição normal. `mu' é a média e `sigma' é o desvio padrão.


Alterado na versão 3.11: `mu' e `sigma' agora têm argumentos padrão.

@end deffn

@geindex vonmisesvariate() (no módulo random)
@anchor{library/random random vonmisesvariate}@anchor{289b}
@deffn {Função} random.vonmisesvariate (mu, kappa)

`mu' é o ângulo médio, expresso em radianos entre 0 e 2*`pi', e `kappa' é o parâmetro de concentração, que deve ser maior ou igual a zero. Se `kappa' for igual a zero, essa distribuição será reduzida para um ângulo aleatório uniforme no intervalo de 0 a 2*`pi'.
@end deffn

@geindex paretovariate() (no módulo random)
@anchor{library/random random paretovariate}@anchor{289c}
@deffn {Função} random.paretovariate (alpha)

Distribuição de Pareto. `alpha' é o parâmetro de forma.
@end deffn

@geindex weibullvariate() (no módulo random)
@anchor{library/random random weibullvariate}@anchor{289d}
@deffn {Função} random.weibullvariate (alpha, beta)

Distribuição Weibull. `alpha' é o parâmetro de escala e `beta' é o parâmetro de forma.
@end deffn

@node Gerador alternativo,Notas sobre reprodutibilidade,Distribuições com valor real,random — Gera números pseudoaleatórios
@anchor{library/random alternative-generator}@anchor{289e}
@subsubsection Gerador alternativo


@geindex Random (classe em random)
@anchor{library/random random Random}@anchor{19e7}
@deffn {Classe} random.Random ([seed])

Classe que implementa o gerador de números pseudoaleatórios padrão usado pelo módulo @ref{b8,,random}.


Alterado na versão 3.11: Anteriormente, o `seed' poderia ser qualquer objeto hasheável. Agora está limitado a: @code{None}, @ref{257,,int}, @ref{2f7,,float}, @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}.


Subclasses de @code{Random} devem substituir os seguintes métodos se desejarem fazer uso de um gerador básico diferente:

@geindex seed() (método random.Random)
@anchor{library/random random Random seed}@anchor{1af9}
@deffn {Método} seed (a=None, version=2)

Substitua este método nas subclasses para personalizar o comportamento de @ref{12b5,,seed()} das instâncias de @code{Random}.
@end deffn

@geindex getstate() (método random.Random)
@anchor{library/random random Random getstate}@anchor{289f}
@deffn {Método} getstate ()

Substitua este método nas subclasses para personalizar o comportamento de @ref{288d,,getstate()} das instâncias de @code{Random}.
@end deffn

@geindex setstate() (método random.Random)
@anchor{library/random random Random setstate}@anchor{28a0}
@deffn {Método} setstate (state)

Substitua este método nas subclasses para personalizar o comportamento de @ref{288e,,setstate()} das instâncias de @code{Random}.
@end deffn

@geindex random() (método random.Random)
@anchor{library/random random Random random}@anchor{28a1}
@deffn {Método} random ()

Substitua este método nas subclasses para personalizar o comportamento de @ref{748,,random()} das instâncias de @code{Random}.
@end deffn

Opcionalmente, uma subclasse geradora personalizada também pode fornecer o seguinte método:

@geindex getrandbits() (método random.Random)
@anchor{library/random random Random getrandbits}@anchor{28a2}
@deffn {Método} getrandbits (k)

Substitua este método nas subclasses para personalizar o comportamento de @ref{1043,,getrandbits()} das instâncias de @code{Random}.
@end deffn

@geindex randbytes() (método random.Random)
@anchor{library/random random Random randbytes}@anchor{930}
@deffn {Método} randbytes (n)

Substitua este método nas subclasses para personalizar o comportamento de @ref{1629,,randbytes()} das instâncias de @code{Random}.
@end deffn
@end deffn

@geindex SystemRandom (classe em random)
@anchor{library/random random SystemRandom}@anchor{288b}
@deffn {Classe} random.SystemRandom ([seed])

Classe que usa a função @ref{523,,os.urandom()} para gerar números aleatórios a partir de fontes fornecidas pelo sistema operacional. Não disponível em todos os sistemas. Não depende do estado do software e as sequências não são reproduzíveis. Assim, o método @ref{12b5,,seed()} não tem efeito e é ignorado. Os métodos @ref{288d,,getstate()} e @ref{288e,,setstate()} levantam @ref{228,,NotImplementedError} se chamados.
@end deffn

@node Notas sobre reprodutibilidade,Exemplos<4>,Gerador alternativo,random — Gera números pseudoaleatórios
@anchor{library/random notes-on-reproducibility}@anchor{28a3}
@subsubsection Notas sobre reprodutibilidade


Às vezes, é útil poder reproduzir as sequências fornecidas por um gerador de números pseudoaleatórios. Reutilizando um valor inicial, a mesma sequência deve ser reproduzível de execução para execução, desde que mais de uma thread não estejam em execução.

A maioria dos algoritmos e funções de propagação do módulo aleatório está sujeita a alterações nas versões de Python, mas dois aspectos são garantidos para não serem alterados:


@itemize *

@item 
Se um novo método de semeadura for adicionado, será oferecida um semeador compatível com versões anteriores.

@item 
O método @ref{28a1,,random()} do gerador continuará produzindo a mesma sequência quando o semeador compatível receber a mesma semente.
@end itemize

@node Exemplos<4>,Receitas<2>,Notas sobre reprodutibilidade,random — Gera números pseudoaleatórios
@anchor{library/random examples}@anchor{28a4}@anchor{library/random random-examples}@anchor{121c}
@subsubsection Exemplos


Exemplos básicos:

@example
>>> random()                          # Ponto flutuante aleatório:  0.0 <= x < 1.0
0.37444887175646646

>>> uniform(2.5, 10.0)                # Ponto flutuante aleatório:  2.5 <= x <= 10.0
3.1800146073117523

>>> expovariate(1 / 5)                # Intervalo entre chegadas com médias de 5 segundos
5.148957571865031

>>> randrange(10)                     # Inteiro de 0 até 9 inclusivo
7

>>> randrange(0, 101, 2)              # Inteiro par entre 0 até 100 inclusivo
26

>>> choice(['win', 'lose', 'draw'])   # Um único elemento aleatório de uma sequência
'draw'

>>> deck = 'ace two three four'.split()
>>> shuffle(deck)                     # Embaralha uma lista
>>> deck
['four', 'two', 'ace', 'three']

>>> sample([10, 20, 30, 40, 50], k=4) # Quatro amostras sem substitutos
[40, 10, 50, 30]
@end example

Simulações:

@example
>>> # Seis giros da roleta (amostragem ponderada com substituição)
>>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
['red', 'green', 'black', 'black', 'red', 'black']

>>> # Distribui 20 cartas sem reposição de um baralho de
>>> # 52 cartas e determine a proporção de cartas com
>>> # valor dez: dez, valete, rainha ou rei.
>>> deal = sample(['tens', 'low cards'], counts=[16, 36], k=20)
>>> deal.count('tens') / 20
0.15

>>> # Estima a probabilidade de obter 5 ou mais caras em 7 giros
>>> # de uma moeda viciada que cai em cara 60% das vezes.
>>> sum(binomialvariate(n=7, p=0.6) >= 5 for i in range(10_000)) / 10_000
0.4169

>>> # Probabilidade da mediana de 5 amostras estar nos dois quartis do meio
>>> 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

Exemplo de bootstrapping estatístico@footnote{https://pt.wikipedia.org/wiki/Bootstrapping_(estatística)} usando reamostragem com substituição para estimar um intervalo de confiança para a média de uma amostra:

@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

Exemplo de um teste de permutação de reamostragem@footnote{https://en.wikipedia.org/wiki/Resampling_(statistics)#Permutation_tests} para determinar a significância estatística ou valor-p@footnote{https://pt.wikipedia.org/wiki/Valor-p} de uma diferença observada entre os efeitos de uma droga em comparação com um placebo:

@example
# Exemplo de "Statistics is Easy" de Dennis Shasha e 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

Simulação de tempos de chegada e entregas de serviços para uma fila multisservidor:

@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  # hora em que cada servidor fica disponível
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 também


Statistics for Hackers@footnote{https://www.youtube.com/watch?v=Iq9DzN6mvYA} um tutorial em vídeo por Jake Vanderplas@footnote{https://us.pycon.org/2016/speaker/profile/295/} sobre análise estatística usando apenas alguns conceitos fundamentais, incluindo simulação, amostragem, embaralhamento e validação cruzada.

Economics Simulation@footnote{https://nbviewer.org/url/norvig.com/ipython/Economics.ipynb} uma simulação de um mercado por Peter Norvig@footnote{https://norvig.com/bio.html} que mostra o uso eficaz de muitas das ferramentas e distribuições fornecidas por este módulo (gauss, uniform, sample, betavariate, choice, triangular e randrange).

A Concrete Introduction to Probability (using Python)@footnote{https://nbviewer.org/url/norvig.com/ipython/Probability.ipynb} um tutorial de Peter Norvig@footnote{https://norvig.com/bio.html} cobrindo os fundamentos da teoria das probabilidades, como escrever simulações e como realizar análises de dados usando Python.


@node Receitas<2>,Uso na linha de comando<2>,Exemplos<4>,random — Gera números pseudoaleatórios
@anchor{library/random recipes}@anchor{28a5}
@subsubsection Receitas


Estas receitas mostram como fazer seleções aleatórias de forma eficiente a partir dos iteradores combinatórios no módulo @ref{81,,itertools}:

@example
import random

def random_product(*iterables, repeat=1):
    "Random selection from itertools.product(*iterables, repeat=repeat)"
    pools = tuple(map(tuple, iterables)) * 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)

def random_derangement(iterable):
    "Choose a permutation where no element stays in its original position."
    seq = tuple(iterable)
    if len(seq) < 2:
        if not seq:
            return ()
        raise IndexError('No derangments to choose from')
    perm = list(range(len(seq)))
    start = tuple(perm)
    while True:
        random.shuffle(perm)
        if all(p != q for p, q in zip(start, perm)):
            return tuple([seq[i] for i in perm])
@end example

@c >>> import random
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_product('ABCDEFG', repeat=5)
@c ('D', 'B', 'E', 'F', 'E')
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_permutation('ABCDEFG')
@c ('D', 'B', 'E', 'C', 'G', 'A', 'F')
@c >>> random_permutation('ABCDEFG', 5)
@c ('A', 'G', 'D', 'C', 'B')
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_combination('ABCDEFG', 7)
@c ('A', 'B', 'C', 'D', 'E', 'F', 'G')
@c >>> random_combination('ABCDEFG', 6)
@c ('A', 'B', 'C', 'D', 'F', 'G')
@c >>> random_combination('ABCDEFG', 5)
@c ('A', 'B', 'C', 'E', 'F')
@c >>> random_combination('ABCDEFG', 4)
@c ('B', 'C', 'D', 'G')
@c >>> random_combination('ABCDEFG', 3)
@c ('B', 'E', 'G')
@c >>> random_combination('ABCDEFG', 2)
@c ('E', 'G')
@c >>> random_combination('ABCDEFG', 1)
@c ('C',)
@c >>> random_combination('ABCDEFG', 0)
@c ()
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_combination_with_replacement('ABCDEFG', 7)
@c ('B', 'C', 'D', 'E', 'E', 'E', 'G')
@c >>> random_combination_with_replacement('ABCDEFG', 3)
@c ('A', 'B', 'E')
@c >>> random_combination_with_replacement('ABCDEFG', 2)
@c ('A', 'G')
@c >>> random_combination_with_replacement('ABCDEFG', 1)
@c ('E',)
@c >>> random_combination_with_replacement('ABCDEFG', 0)
@c ()
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_derangement('')
@c ()
@c >>> random_derangement('A')
@c Traceback (most recent call last):
@c ...
@c IndexError: No derangments to choose from
@c >>> random_derangement('AB')
@c ('B', 'A')
@c >>> random_derangement('ABC')
@c ('C', 'A', 'B')
@c >>> random_derangement('ABCD')
@c ('B', 'A', 'D', 'C')
@c >>> random_derangement('ABCDE')
@c ('B', 'C', 'A', 'E', 'D')
@c >>> # Identical inputs treated as distinct
@c >>> identical = 20
@c >>> random_derangement((10, identical, 30, identical))
@c (20, 30, 10, 20)

O padrão de @ref{748,,random()} é retornar múltiplos de 2⁻⁵³ no intervalo `0.0 ≤ x < 1.0'. Todos esses números são espaçados uniformemente e são representáveis exatamente como pontos flutuantes Python. No entanto, muitos outros pontos flutuantes representados nesse intervalo não são seleções possíveis. Por exemplo, @code{0.05954861408025609} não é um múltiplo inteiro de 2⁻⁵³.

A receita a seguir tem uma abordagem diferente. Todos os pontos flutuantes no intervalo são seleções possíveis. A mantissa vem de uma distribuição uniforme de inteiros no intervalo `2⁵² ≤ mantissa < 2⁵³'. O expoente vem de uma distribuição geométrica onde expoentes menores que `-53' ocorrem com metade da frequência do próximo expoente maior.

@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 as @ref{2895,,distribuições reais valoradas} na classe usarão o novo método:

@example
>>> fr = FullRandom()
>>> fr.random()
0.05954861408025609
>>> fr.expovariate(0.25)
8.87925541791544
@end example

A receita é conceitualmente equivalente a um algoritmo que escolhe entre todos os múltiplos de 2⁻¹⁰⁷⁴ no intervalo `0.0 ≤ x < 1.0'. Todos esses números são espaçados uniformemente, mas a maioria deve ser arredondada para o ponto flutuante Python representável mais próximo. (O valor 2⁻¹⁰⁷⁴ é o menor ponto flutuante positivo não normalizado e é igual a @code{math.ulp(0.0)}.)


@subsubheading Ver também


Generating Pseudo-random Floating-Point Values@footnote{https://allendowney.com/research/rand/downey07randfloat.pdf} um artigo de Allen B. Downey descrevendo formas de gerar pontos flutuantes mais refinados do que normalmente gerados por @ref{748,,random()}.


@node Uso na linha de comando<2>,Exemplos na linha de comando,Receitas<2>,random — Gera números pseudoaleatórios
@anchor{library/random command-line-usage}@anchor{28a6}@anchor{library/random random-cli}@anchor{154}
@subsubsection Uso na linha de comando



Adicionado na versão 3.13.


O módulo @code{random} pode ser invocado como um script na linha de comando:

@example
python -m random [-h] [-c ESCOLHA [ESCOLHA ...] | -i N | -f N] [entrada ...]
@end example

As seguintes opções são aceitas:

@geindex random opção de linha de comando; -h
@geindex random opção de linha de comando; --help
@anchor{library/random cmdoption-random-h}@anchor{28a7}@anchor{library/random cmdoption-random-help}@anchor{28a8}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Mostra a mensagem de ajuda e sai.
@end deffn

@geindex random opção de linha de comando; -c
@geindex random opção de linha de comando; --choice
@anchor{library/random cmdoption-random-c}@anchor{28a9}
@deffn {Option} @w{-}c CHOICE [CHOICE ...]
@anchor{library/random cmdoption-random-choice}@anchor{28aa}
@deffnx {Option} @w{-}@w{-}choice CHOICE [CHOICE ...]

Imprime uma escolha aleatória, usando @ref{1271,,choice()}.
@end deffn

@geindex random opção de linha de comando; -i
@geindex random opção de linha de comando; --integer
@anchor{library/random cmdoption-random-i}@anchor{28ab}
@deffn {Option} @w{-}i <N>
@anchor{library/random cmdoption-random-integer}@anchor{28ac}
@deffnx {Option} @w{-}@w{-}integer <N>

Imprime um inteiro aleatório entre 1 e N inclusive, usando @ref{1270,,randint()}.
@end deffn

@geindex random opção de linha de comando; -f
@geindex random opção de linha de comando; --float
@anchor{library/random cmdoption-random-f}@anchor{28ad}
@deffn {Option} @w{-}f <N>
@anchor{library/random cmdoption-random-float}@anchor{28ae}
@deffnx {Option} @w{-}@w{-}float <N>

Imprime um número de ponto flutuante aleatório entre 0 e N inclusive, usando @ref{2896,,uniform()}.
@end deffn

Se nenhuma opção for fornecida, a saída dependerá da entrada:


@itemize *

@item 
String ou vários: mesmo que @ref{28aa,,--choice}.

@item 
Inteiro mesmo que @ref{28ac,,--integer}.

@item 
Ponto flutuante: mesmo que @ref{28ae,,--float}.
@end itemize

@node Exemplos na linha de comando,,Uso na linha de comando<2>,random — Gera números pseudoaleatórios
@anchor{library/random command-line-example}@anchor{28af}@anchor{library/random random-cli-example}@anchor{28b0}
@subsubsection Exemplos na linha de comando


Aqui estão alguns exemplos da interface de linha de comando @code{random}:

@example
$ # Escolhe um aleatório
$ python -m random egg bacon sausage spam "Lobster Thermidor aux crevettes with a Mornay sauce"
Lobster Thermidor aux crevettes with a Mornay sauce

$ # Inteiro aleatório
$ python -m random 6
6

$ # Número de ponto flutuante aleatório
$ python -m random 1.8
1.7080016272295635

$ # Com argumentos explícitos
$ 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 — Funções estatísticas,,random — Gera números pseudoaleatórios,Módulos Matemáticos e Numéricos
@anchor{library/statistics doc}@anchor{28b1}@anchor{library/statistics module-statistics}@anchor{d2}@anchor{library/statistics statistics-mathematical-statistics-functions}@anchor{28b2}@anchor{library/statistics translation-repo}@anchor{28b3}
@subsection @code{statistics} — Funções estatísticas


@geindex module; statistics


Adicionado na versão 3.4.


`Código-fonte:' Lib/statistics.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/statistics.py}

@c from statistics import *
@c import math
@c __name__ = '<doctest>'


__________________________________________________________________


Esse módulo fornece funções para o cálculo de estatísticas matemáticas de dados numéricos (para valores do tipo @ref{232b,,Real}).

O módulo não tem a intenção de competir com bibliotecas de terceiros como NumPy@footnote{https://numpy.org}, SciPy@footnote{https://scipy.org/}, ou pacotes proprietários de estatísticas com todos os recursos destinados a estatísticos profissionais como Minitab, SAS e Matlab. Ela destina-se ao nível de calculadoras gráficas e científicas.

A menos que seja explicitamente indicado, essas funções suportam @ref{257,,int}, @ref{2f7,,float}, @ref{29d,,Decimal} e @ref{1e7,,Fraction}. O uso com outros tipos (sejam numéricos ou não) não é atualmente suportado. Coleções com uma mistura de tipos também são indefinidas e dependentes da implementação. Se os seus dados de entrada consistem de tipos misturados, você pode usar @ref{867,,map()} para garantir um resultado consistente, por exemplo @code{map(float, dado_entrada)}.

Alguns conjuntos de dados usam valores @code{NaN} (não um número) para representar dados ausentes. Como os NaNs possuem semântica de comparação incomum, eles causam comportamentos surpreendentes ou indefinidos nas funções estatísticas que classificam dados ou contam ocorrências. As funções afetadas são @code{median()}, @code{median_low()}, @code{median_high()}, @code{median_grouped()}, @code{mode()}, @code{multimode()} e @code{quantiles()}. Os valores @code{NaN} devem ser removidos antes de chamar estas funções:

@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)  # Isso tem um comportamento surpreendente
[20.7, nan, 14.4, 18.3, 19.2, nan]
>>> median(data)  # Este resultado é inesperado
16.35

>>> sum(map(isnan, data))    # Número de valores em falta
2
>>> clean = list(filterfalse(isnan, data))  # Remove valores NaN
>>> clean
[20.7, 19.2, 18.3, 14.4]
>>> sorted(clean)  # A classificação agora funciona como esperado
[14.4, 18.3, 19.2, 20.7]
>>> median(clean)       # Este resultado é agora bem definido
18.75
@end example

@menu
* Médias e medidas de valor central:: 
* Medidas de espalhamento:: 
* Estatísticas para relações entre duas entradas:: 
* Detalhes das funções:: 
* Exceções: Exceções<5>. 
* Objetos NormalDist:: 
* Exemplos e receitas: Exemplos e receitas<2>. 

@end menu

@node Médias e medidas de valor central,Medidas de espalhamento,,statistics — Funções estatísticas
@anchor{library/statistics averages-and-measures-of-central-location}@anchor{28b4}
@subsubsection Médias e medidas de valor central


Essas funções calculam a média ou o valor típico de uma população ou amostra.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{6d2,,mean()}

@tab

Média aritmética dos dados.

@item

@ref{a3e,,fmean()}

@tab

Média aritmética rápida de ponto flutuante, com ponderação opcional.

@item

@ref{a3f,,geometric_mean()}

@tab

Média geométrica dos dados.

@item

@ref{d02,,harmonic_mean()}

@tab

Média harmônica dos dados.

@item

@ref{24a,,kde()}

@tab

Estima a distribuição de densidade de probabilidade dos dados.

@item

@ref{24b,,kde_random()}

@tab

Amostragem aleatória do PDF gerado por kde().

@item

@ref{28b5,,median()}

@tab

Mediana (valor do meio) dos dados.

@item

@ref{28b6,,median_low()}

@tab

Mediana inferior dos dados.

@item

@ref{28b7,,median_high()}

@tab

Mediana superior dos dados.

@item

@ref{28b8,,median_grouped()}

@tab

Mediana (50º percentil) dos dados agrupados.

@item

@ref{28b9,,mode()}

@tab

Moda (valor mais comum) de dados discretos ou nominais.

@item

@ref{28ba,,multimode()}

@tab

Lista de modas (valores mais comuns) de dados discretos ou nominais.

@item

@ref{a40,,quantiles()}

@tab

Divide os dados em intervalos com probabilidade igual.

@end multitable


@node Medidas de espalhamento,Estatísticas para relações entre duas entradas,Médias e medidas de valor central,statistics — Funções estatísticas
@anchor{library/statistics measures-of-spread}@anchor{28bb}
@subsubsection Medidas de espalhamento


Essas funções calculam o quanto a população ou amostra tendem a desviar dos valores típicos ou médios.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{15d3,,pstdev()}

@tab

Desvio padrão populacional dos dados.

@item

@ref{28bc,,pvariance()}

@tab

Variância populacional dos dados.

@item

@ref{6d4,,stdev()}

@tab

Desvio padrão amostral dos dados.

@item

@ref{6d3,,variance()}

@tab

Variância amostral dos dados.

@end multitable


@node Estatísticas para relações entre duas entradas,Detalhes das funções,Medidas de espalhamento,statistics — Funções estatísticas
@anchor{library/statistics statistics-for-relations-between-two-inputs}@anchor{28bd}
@subsubsection Estatísticas para relações entre duas entradas


Essas funções calculam estatísticas sobre relações entre duas entradas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{833,,covariance()}

@tab

Covariância amostral para duas variáveis.

@item

@ref{4bc,,correlation()}

@tab

Coeficientes de correlação de Pearson e Spearman.

@item

@ref{834,,linear_regression()}

@tab

Inclinação e intersecção para regressão linear simples.

@end multitable


@node Detalhes das funções,Exceções<5>,Estatísticas para relações entre duas entradas,statistics — Funções estatísticas
@anchor{library/statistics function-details}@anchor{28be}
@subsubsection Detalhes das funções


Nota: as funções não exigem que os dados estejam ordenados. No entanto, para conveniência do leitor, a maioria dos exemplos mostrará sequências ordenadas.

@geindex mean() (no módulo statistics)
@anchor{library/statistics statistics mean}@anchor{6d2}
@deffn {Função} statistics.mean (data)

Retorna a média aritmética amostral de `data' que pode ser uma sequência ou iterável.

A média aritmética é a soma dos dados dividida pela quantidade de dados. É comumente chamada apenas de “média”, apesar de ser uma das diversas médias matemáticas. Ela representa uma medida da localização central dos dados.

Se `data' for vazio, uma exceção do tipo @ref{28bf,,StatisticsError} será levantada.

Alguns exemplos 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 
A média é fortemente afetada por outliers@footnote{https://pt.wikipedia.org/wiki/Outlier} (valor atípico) e não é necessariamente um exemplo típico dos pontos de dados. Para uma medida mais robusta, embora menos eficiente, de tendência central@footnote{https://pt.m.wikipedia.org/wiki/Tendência_central}, veja @ref{28b5,,median()}.

A média amostral fornece uma estimativa não enviesada da média populacional verdadeira, ou seja, quando a média é obtida para todas as possíveis amostras, @code{mean(sample)} converge para a média verdadeira de toda população. Se `data' representa toda população ao invés de uma amostra, então @code{mean(data)} é equivalente a calcular a verdadeira média populacional μ.
@end quotation
@end cartouche
@end deffn

@geindex fmean() (no módulo statistics)
@anchor{library/statistics statistics fmean}@anchor{a3e}
@deffn {Função} statistics.fmean (data, weights=None)

Converte valores em `data' para ponto flutuante e calcula a média aritmética.

Essa função executa mais rapidamente do que a função @ref{6d2,,mean()} e sempre retorna um @ref{2f7,,float}. `data' pode ser uma sequência ou iterável. Se o conjunto de dados de entrada estiver vazio, levanta uma exceção @ref{28bf,,StatisticsError}.

@example
>>> fmean([3.5, 4.0, 5.25])
4.25
@end example

A ponderação opcional é suportada. Por exemplo, um professor atribui uma nota para um curso ponderando questionários em 20%, trabalhos de casa em 20%, um exame de meio de período em 30% e um exame final em 30%:

@example
>>> grades = [85, 92, 83, 91]
>>> weights = [0.20, 0.20, 0.30, 0.30]
>>> fmean(grades, weights)
87.6
@end example

Se `weights' for fornecido, deve ter o mesmo comprimento que `data' ou uma @ref{202,,ValueError} será levantada.


Adicionado na versão 3.8.



Alterado na versão 3.11: Adicionado suporte a `weights'.

@end deffn

@geindex geometric_mean() (no módulo statistics)
@anchor{library/statistics statistics geometric_mean}@anchor{a3f}
@deffn {Função} statistics.geometric_mean (data)

Converte valores em `data' para ponto flutuante e calcula a média geométrica.

A média geométrica indica a tendência central ou valor típico de `data' usando o produto dos valores (em oposição à média aritmética que usa a soma deles).

Levanta uma exceção @ref{28bf,,StatisticsError} se a entrada do conjunto de dados for vazia, contiver um zero ou um valor negativo. `data' pode ser uma sequência ou iterável.

Nenhum esforço especial é feito para alcançar resultados exatos. (Mas, isso pode mudar no futuro).

@example
>>> round(geometric_mean([54, 24, 36]), 1)
36.0
@end example


Adicionado na versão 3.8.

@end deffn

@geindex harmonic_mean() (no módulo statistics)
@anchor{library/statistics statistics harmonic_mean}@anchor{d02}
@deffn {Função} statistics.harmonic_mean (data, weights=None)

Retorna a média harmônica de `data', uma sequência ou iterável de números de valor real. Se `weights' for omitido ou @code{None}, então a ponderação igual é presumida.

A média harmônica é a recíproca da média arimética calculada pela função @ref{6d2,,mean()} dos recíprocos dos dados. Por exemplo, a média harmônica de três valores `a', `b' e `c' será equivalente a @code{3/(1/a + 1/b + 1/c)}. Se um dos valores for zero, o resultado também será zero.

A média harmônica é um tipo de média, uma medida de localização central dos dados. Ela é geralmente apropriada quando se está calculando a média de razões e taxas; por exemplo, velocidades.

Suponha que um carro viaje 10 km a 40 km/h, e em seguida viaje mais 10 km a 60 km/h. Qual é a velocidade média?

@example
>>> harmonic_mean([40, 60])
48.0
@end example

Suponha que um carro viaja a 40 km/h por 5 km e, quando o trânsito melhora, acelera para 60 km/h pelos 30 km restantes da viagem. Qual é a velocidade média?

@example
>>> harmonic_mean([40, 60], weights=[5, 30])
56.0
@end example

@ref{28bf,,StatisticsError} é levantada se `data' for vazio, qualquer elemento for menor que zero, ou se a soma ponderada não for positiva.

O algoritmo atual tem uma saída antecipada quando encontra um zero na entrada. Isso significa que as entradas subsequentes não tem a validade testada. (Esse comportamento pode mudar no futuro.)


Adicionado na versão 3.6.



Alterado na versão 3.10: Adicionado suporte a `weights'.

@end deffn

@geindex kde() (no módulo statistics)
@anchor{library/statistics statistics kde}@anchor{24a}
@deffn {Função} statistics.kde (data, h, kernel='normal', *, cumulative=False)

Estimativa de densidade por Kernel (KDE)@footnote{https://www.itm-conferences.org/articles/itmconf/pdf/2018/08/itmconf_sam2018_00037.pdf}: Cria uma função de densidade de probabilidade contínua ou uma função de distribuição cumulativa a partir de amostras discretas.

A ideia básica é suavizar os dados usando uma função kernel@footnote{https://en.wikipedia.org/wiki/Kernel_(statistics)}. para ajudar a tirar inferências sobre uma população a partir de uma amostra.

O grau de suavização é controlado pelo parâmetro de escala `h', que é chamado de largura de banda. Valores menores enfatizam características locais, enquanto valores maiores dão resultados mais suaves.

O `kernel' determina os pesos relativos dos pontos de dados da amostra. Geralmente, a escolha do formato de kernel não importa tanto quanto o parâmetro de suavização de largura de banda mais influente.

Os kernels que dão algum peso a cada ponto de amostra incluem `normal' (`gauss'), `logistic' e `sigmoid'.

Os kernels que apenas dão peso aos pontos de amostra dentro da largura de banda incluem `rectangular' (`uniform'), `triangular', `parabolic' (`epanechnikov'), `quartic' (`biweight'), `triweight' e `cosine'.

Se `cumulative' for verdadeiro, retornará uma função de distribuição cumulativa.

Uma @ref{28bf,,StatisticsError} será levantada se a sequência de dados em `data' estiver vazia.

A Wikipédia tem um exemplo@footnote{hhttps://pt.wikipedia.org/wiki/Estimativa_de_densidade_kernel#Exemplo} onde podemos usar @ref{24a,,kde()} para gerar e plotar uma função de densidade de probabilidade estimada a partir de uma pequena amostra:

@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

Os pontos em @code{xarr} e @code{yarr} podem ser usados para fazer um gráfico PDF:

@image{python-figures/kde_example,,,Gráfico de dispersão da função de densidade de probabilidade estimada.,png}


Adicionado na versão 3.13.

@end deffn

@geindex kde_random() (no módulo statistics)
@anchor{library/statistics statistics kde_random}@anchor{24b}
@deffn {Função} statistics.kde_random (data, h, kernel='normal', *, seed=None)

Retorna uma função que faz uma seleção aleatória da função de densidade de probabilidade estimada produzida por @code{kde(data, h, kernel)}.

Fornecer uma `seed' permite seleções reproduzíveis. No futuro, os valores podem mudar um pouco conforme estimativas de funções de distribuição acumulada (CDF) inversas de kernel mais precisas forem implementadas. `seed' pode ser um inteiro, float, str ou bytes.

Uma @ref{28bf,,StatisticsError} será levantada se a sequência de dados em `data' estiver vazia.

Continuando o exemplo de @ref{24a,,kde()}, podemos usar @ref{24b,,kde_random()} para gerar novas seleções aleatórias a partir de uma função de densidade de probabilidade estimada:

@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


Adicionado na versão 3.13.

@end deffn

@geindex median() (no módulo statistics)
@anchor{library/statistics statistics median}@anchor{28b5}
@deffn {Função} statistics.median (data)

Retorna a mediana (o valor do meio) de dados numéricos, usando o método comum de “média entre os dois do meio”. Se `data' for vazio, é levantada uma exceção @ref{28bf,,StatisticsError}. `data' pode ser uma sequência ou um iterável.

A mediana é uma medida robusta de localização central e é menos afetada por valores discrepantes. Quando a quantidade de pontos de dados for ímpar, o valor de meio é retornado:

@example
>>> median([1, 3, 5])
3
@end example

Quando o número de elementos for par, a mediana é calculada tomando-se a média entre os dois valores no meio:

@example
>>> median([1, 3, 5, 7])
4.0
@end example

Isso serve quando seus dados forem discretos e você não se importa que a média possa não ser um valor que de fato ocorre nos seus dados.

Caso os dados sejam ordinais (oferecem suporte para operações de ordenação) mas não são numéricos (não oferecem suporte para adição), considere usar a função @ref{28b6,,median_low()} ou @ref{28b7,,median_high()} no lugar.
@end deffn

@geindex median_low() (no módulo statistics)
@anchor{library/statistics statistics median_low}@anchor{28b6}
@deffn {Função} statistics.median_low (data)

Retorna a mediana inferior de dados numéricos. Se `data' for vazio, a exceção @ref{28bf,,StatisticsError} é levantada. `data' pode ser uma sequência ou um iterável.

A mediana inferior sempre é um membro do conjunto de dados. Quando o número de elementos for ímpar, o valor intermediário é retornado. Se houver um número par de elementos, o menor entre os dois valores centrais é retornado.

@example
>>> median_low([1, 3, 5])
3
>>> median_low([1, 3, 5, 7])
3
@end example

Use a mediana inferior caso seus dados forem discretos e você prefira que a mediana seja um valor que de fato existe nos seus dados ao invés de um valor interpolado.
@end deffn

@geindex median_high() (no módulo statistics)
@anchor{library/statistics statistics median_high}@anchor{28b7}
@deffn {Função} statistics.median_high (data)

Retorna a mediana superior de dados numéricos. Se `data' for vazio, a exceção @ref{28bf,,StatisticsError} é levantada. `data' pode ser uma sequência ou um iterável.

A mediana superior sempre é um membro do conjunto de dados. Quando o número de elementos for ímpar, o valor intermediário é retornado. Se houver um número par de elementos, o maior entre os dois valores centrais é retornado.

@example
>>> median_high([1, 3, 5])
3
>>> median_high([1, 3, 5, 7])
5
@end example

Use a mediana superior caso seus dados forem discretos e você prefira que a mediana seja um valor que de fato existe nos seus dados ao invés de um valor interpolado.
@end deffn

@geindex median_grouped() (no módulo statistics)
@anchor{library/statistics statistics median_grouped}@anchor{28b8}
@deffn {Função} statistics.median_grouped (data, interval=1.0)

Estima a mediana para dados numéricos que foram agrupados ou "binned"@footnote{https://en.wikipedia.org/wiki/Data_binning} em torno dos pontos médios de intervalos consecutivos de largura fixa.

`data' pode ser qualquer iterável de dados numéricos com cada valor sendo exatamente o ponto médio de um bin. Pelo menos um valor deve estar presente.

`interval' é a largura de cada compartimento.

Por exemplo, as informações demográficas podem ter sido resumidas em grupos etários consecutivos de dez anos, com cada grupo sendo representado pelos pontos médios de cinco anos dos intervalos:

@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

O 50º percentil (mediana) é a 536ª pessoa de 1071 membros. Essa pessoa está na faixa etária de 30 a 40 anos.

A função regular @ref{28b5,,median()} iria presumir que todos na faixa etária tricenariana tinham exatamente 35 anos. Uma suposição mais sustentável é que os 484 membros dessa faixa etária estão distribuídos uniformemente entre 30 e 40. Para isso, usamos @ref{28b8,,median_grouped()}:

@example
>>> data = list(demographics.elements())
>>> median(data)
35
>>> round(median_grouped(data, interval=10), 1)
37.5
@end example

O chamador é responsável por garantir que os pontos de dados sejam separados por múltiplos exatos de `intervalo'. Isso é essencial para obter um resultado correto. A função não verifica essa pré-condição.

As entradas podem ser qualquer tipo numérico que possa ser convertido para um ponto flutuante durante a etapa de interpolação.
@end deffn

@geindex mode() (no módulo statistics)
@anchor{library/statistics statistics mode}@anchor{28b9}
@deffn {Função} statistics.mode (data)

Retorna o valor mais comum dos dados discretos ou nominais em `data'. A moda (quando existe) é o valor mais típico e serve como uma medida de localização central.

Se existirem múltiplas modas com a mesma frequência, retorna a primeira encontrada em `data'. Se ao invés disso se desejar a menor ou a maior dentre elas, use @code{min(multimode(data))} ou @code{max(multimode(data))}. Se a entrada `data' é vazia, a exceção @ref{28bf,,StatisticsError} é levantada.

@code{mode} presume que os dados são discretos e retorna um único valor. Esse é o tratamento padrão do conceito de moda normalmente ensinado nas escolas:

@example
>>> mode([1, 1, 2, 3, 3, 3, 3, 4])
3
@end example

A moda é única no sentido que é a única medida estatística nesse módulo que também se aplica a dados nominais (não-numéricos):

@example
>>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
'red'
@end example

Somente entradas hasheáveis são suportadas. Para manipular o tipo @ref{5d9,,set}, considere fazer a conversão para @ref{5da,,frozenset}. Para manipular o tipo @ref{611,,list}, considere fazer a conversão para @ref{370,,tuple}. Para entradas mistas ou aninhadas, considere usar este algoritmo quadrático mais lento que depende apenas de testes de igualdade: @code{max(data, key=data.count)}.


Alterado na versão 3.8: Agora lida com conjunto de dados multimodais retornando a primeira moda encontrada. Anteriormente, ela levantava a exceção @ref{28bf,,StatisticsError} quando mais do que uma moda era encontrada.

@end deffn

@geindex multimode() (no módulo statistics)
@anchor{library/statistics statistics multimode}@anchor{28ba}
@deffn {Função} statistics.multimode (data)

Retorna uma lista dos valores mais frequentes na ordem em que eles foram encontrados em `data'. Irá retornar mais do que um resultado se houver múltiplas modas ou uma lista vazia se `data' for vazio.

@example
>>> multimode('aabbbbccddddeeffffgg')
['b', 'd', 'f']
>>> multimode('@w{'})
[]
@end example


Adicionado na versão 3.8.

@end deffn

@geindex pstdev() (no módulo statistics)
@anchor{library/statistics statistics pstdev}@anchor{15d3}
@deffn {Função} statistics.pstdev (data, mu=None)

Retorna o desvio padrão populacional (a raiz quadrada da variância populacional). Veja os argumentos e outros detalhes em @ref{28bc,,pvariance()}.

@example
>>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
0.986893273527251
@end example
@end deffn

@geindex pvariance() (no módulo statistics)
@anchor{library/statistics statistics pvariance}@anchor{28bc}
@deffn {Função} statistics.pvariance (data, mu=None)

Retorna a variância populacional de `data', que deve ser uma sequência ou iterável não-vazio de números reais. A variância, o segundo momento estatístico a partir da média, é uma medida da variabilidade (espalhamento ou dispersão) dos dados. Uma variância grande indica que os dados são espalhados; uma variância menor indica que os dados estão agrupado em volta da média.

Se o segundo argumento opcional `mu' for fornecido, ele deve ser a média da `população' dos dados em `data'. Ele também pode ser usado para calcular o segundo momento em torno de um ponto que não é a média. Se estiver faltando ou for @code{None} (o padrão), a média aritmética é calculada automaticamente.

Use essa função para calcular a variância de toda a população. Para estimar a variância de uma amostra, a função @ref{6d3,,variance()} costuma ser uma escolha melhor.

Levanta @ref{28bf,,StatisticsError} se `data' for vazio.

Exemplos:

@example
>>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
>>> pvariance(data)
1.25
@end example

Se você já calculou a média dos seus dados, você pode passar o valor no segundo argumento opcional `mu' para evitar recálculos:

@example
>>> mu = mean(data)
>>> pvariance(data, mu)
1.25
@end example

Decimais e frações são suportadas:

@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 
Quando os dados de entrada representarem toda a população, ele retorna a variância populacional σ². Se em vez disso, amostras forem usadas, então a variância amostral enviesada s², também conhecida como variância com N graus de liberdade é retornada.

Se de alguma forma você souber a verdadeira média populacional μ, você pode usar essa função para calcular a variância de uma amostra, fornecendo a média populacional conhecida como segundo argumento. Caso seja fornecido um conjunto de amostras aleatórias da população, o resultado será um estimador não enviesado da variância populacional.
@end quotation
@end cartouche
@end deffn

@geindex stdev() (no módulo statistics)
@anchor{library/statistics statistics stdev}@anchor{6d4}
@deffn {Função} statistics.stdev (data, xbar=None)

Retorna o desvio padrão amostral (a raiz quadrada da variância amostral). Veja @ref{6d3,,variance()} para argumentos e outros detalhes.

@example
>>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
1.0810874155219827
@end example
@end deffn

@geindex variance() (no módulo statistics)
@anchor{library/statistics statistics variance}@anchor{6d3}
@deffn {Função} statistics.variance (data, xbar=None)

Retorna a variância amostral de `data', que deve ser um iterável com pelo menos dois números reais. Variância, ou o segundo momento estatístico a partir da média, é uma medida de variabilidade (espalhamento ou dispersão) dos dados. Uma variância grande indica que os dados são espalhados, uma variância menor indica que os dados estão agrupados em volta da média.

Se o segundo argumento opcional `xbar' for dado, ele deve a média `sample' de `data'. Se ele não estiver presente ou for @code{None} (valor padrão), a média é automaticamente calculada.

Use essa função quando seus dados representarem uma amostra da população. Para calcular a variância de toda população veja @ref{28bc,,pvariance()}.

Levanta a exceção @ref{28bf,,StatisticsError} se `data' tiver menos do que dois valores.

Exemplos:

@example
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> variance(data)
1.3720238095238095
@end example

Se você já calculou a média amostral dos seus dados, você pode passar o valor no segundo argumento opcional `xbar' para evitar recálculos:

@example
>>> m = mean(data)
>>> variance(data, m)
1.3720238095238095
@end example

Essa função não verifica se você passou a média verdadeira como `xbar'. Usar valores arbitrários para `xbar' pode levar a resultados inválidos ou impossíveis.

Decimais e frações são suportados.

@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 
Essa é a variância amostral s² com a correção de Bessel, também conhecida como variância com N-1 graus de liberdade. Desde que os pontos de dados sejam representativos (por exemplo, independentes e distribuídos de forma idêntica), o resultado deve ser uma estimativa não enviesada da verdadeira variação populacional.

Caso você de alguma forma saiba a verdadeira média populacional μ você deveria passar para a função @ref{28bc,,pvariance()} como o parâmetro `mu' para obter a variância da amostra.
@end quotation
@end cartouche
@end deffn

@geindex quantiles() (no módulo statistics)
@anchor{library/statistics statistics quantiles}@anchor{a40}
@deffn {Função} statistics.quantiles (data, *, n=4, method='exclusive')

Divide `data' em `n' intervalos contínuos com igual probabilidade. Retorna uma lista de @code{n - 1} pontos de corte separando os intervalos.

Defina `n' como 4 para quartis (o padrão). Defina `n' como 10 para decis. Defina `n' como 100 para percentis, o que fornece os 99 pontos de corte que separam `data' em 100 grupos de tamanhos iguais. Levanta a exceção @ref{28bf,,StatisticsError} se `n' não for pelo menos 1.

`data' pode ser qualquer iterável contendo dados amostrais. Para resultados significativos, a quantidade de dados em `data' deve ser maior do que `n'. Levanta a exceção @ref{28bf,,StatisticsError} se não houver pelo menos um ponto de dados.

Os pontos de corte são linearmente interpolados a partir dos dois pontos mais próximos. Por exemplo, se um ponto de corte cair em um terço da distância entre dois valores, @code{100} e @code{112}, o ponto de corte será avaliado como @code{104}.

O `method' para computar quantis pode variar dependendo se `data' incluir ou excluir os menores e maiores valores possíveis da população.

O valor padrão do parâmetro `method' é “exclusive” e é usado para dados amostrados de uma população que pode ter valores mais extremos do que os encontrados nas amostras. A porção da população que fica abaixo do `i-ésimo' item de `m' pontos ordenados é calculada como @code{i / (m + 1)}. Dados nove valores, o método os ordena e atribui a eles os seguintes percentis: 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%.

Definimos o parâmetro `method' para “inclusive” para descrever dados da população ou para amostras que são conhecidas por incluir os valores mais extremos da população. O mínimo valor em `data' é tratado como o percentil 0 e o máximo valor é tratado como percentil 100. A porção da população que fica abaixo do `i-ésimo' item de `m' pontos ordenados é calculada como @code{(i - 1) / (m - 1)}. Dados 11 valores, o método os ordena e atribui a eles os seguintes percentis: 0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%, 100%.

@example
# Pontos de corte de decil para dados amostrados empiricamente
>>> 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


Adicionado na versão 3.8.



Alterado na versão 3.13: Não levanta mais uma exceção para uma entrada com apenas um único ponto de dados. Isso permite que estimativas de quantil sejam construídas um ponto de amostra por vez, tornando-se gradualmente mais refinadas com cada novo ponto de dados.

@end deffn

@geindex covariance() (no módulo statistics)
@anchor{library/statistics statistics covariance}@anchor{833}
@deffn {Função} statistics.covariance (x, y, /)

Retorna a covariância da amostra de duas entradas `x' e `y'. Covariância é uma medida da variabilidade conjunta de duas entradas.

Ambas as entradas devem ter o mesmo comprimento (não menos que dois), caso contrário, @ref{28bf,,StatisticsError} será levantada.

Exemplos:

@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


Adicionado na versão 3.10.

@end deffn

@geindex correlation() (no módulo statistics)
@anchor{library/statistics statistics correlation}@anchor{4bc}
@deffn {Função} statistics.correlation (x, y, /, *, method='linear')

Retorna o coeficiente de correlação de Pearson@footnote{https://en.wikipedia.org/wiki/Pearson_correlation_coefficient} para duas entradas. O coeficiente de correlação de Pearson `r' assume valores entre -1 e +1. Ele mede a força e a direção de uma relação linear.

Se `method' for “ranked”, calcula coeficiente de correlação de classificação de Spearman@footnote{https://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient} para duas entradas. Os dados são substituídos por classificações. Os empates são calculados em média para que valores iguais recebam a mesma classificação. O coeficiente resultante mede a força de um relacionamento monotônico.

O coeficiente de correlação de Spearman é apropriado para dados ordinais ou para dados contínuos que não atendem ao requisito de proporção linear para o coeficiente de correlação de Pearson.

Ambas as entradas devem ter o mesmo comprimento (não menos que dois) e não precisam ser constantes, caso contrário, @ref{28bf,,StatisticsError} será levantada.

Exemplo com leis de Kepler do movimento planetário@footnote{https://en.wikipedia.org/wiki/Kepler's_laws_of_planetary_motion}:

@example
>>> # Mercúrio, Venus, Terra, Marte, Jupiter, Saturno, Urano e Netuno
>>> orbital_period = [88, 225, 365, 687, 4331, 10_756, 30_687, 60_190]    # dias
>>> dist_from_sun = [58, 108, 150, 228, 778, 1_400, 2_900, 4_500] # milhões de km

>>> # Mostra que existe uma perfeita relação monótona
>>> correlation(orbital_period, dist_from_sun, method='ranked')
1.0

>>> # Observe que uma relação linear é imperfeita
>>> round(correlation(orbital_period, dist_from_sun), 4)
0.9882

>>> # Demonstra a terceira lei de Kepler: Há uma correlação linear
>>> # entre o quadrado do período orbital e o cubo da
>>> # distância a partir do sol.
>>> 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


Adicionado na versão 3.10.



Alterado na versão 3.12: Adicionado suporte para o coeficiente de correlação de classificação de Spearman.

@end deffn

@geindex linear_regression() (no módulo statistics)
@anchor{library/statistics statistics linear_regression}@anchor{834}
@deffn {Função} statistics.linear_regression (x, y, /, *, proportional=False)

Retorna a inclinação e a interceptação dos parâmetros de regressão linear simples@footnote{https://en.wikipedia.org/wiki/Simple_linear_regression} estimados usando mínimos quadrados ordinários. A regressão linear simples descreve a relação entre uma variável independente `x' e uma variável dependente `y' em termos desta função linear:

@quotation

`y = slope * x + intercept + noise'
@end quotation

onde @code{slope} e @code{intercept} são os parâmetros de regressão que são estimados, e @code{noise} representa a variabilidade dos dados que não foi explicada pela regressão linear (é igual à diferença entre os valores previstos e reais da variável dependente).

Ambas as entradas devem ter o mesmo comprimento (não menos que dois) e a variável independente `x' não pode ser constante; caso contrário, um @ref{28bf,,StatisticsError} será levantada.

Por exemplo, podemos usar as datas de lançamento dos filmes do Monty Python@footnote{https://en.wikipedia.org/wiki/Monty_Python#Films} para prever o número cumulativo de filmes do Monty Python que teriam sido produzidos até 2019, supondo que eles tivessem mantido o 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

Se `proportional' for verdadeiro, a variável independente `x' e a variável dependente `y' são assumidas como diretamente proporcionais. Os dados são ajustados a uma linha que passa pela origem. Como o `intercept' sempre será 0,0, a função linear subjacente simplifica para:

@quotation

`y = slope * x + noise'
@end quotation

Continuando o exemplo de @ref{4bc,,correlation()}, vamos ver o quão bem um modelo baseado em planetas principais pode prever as distâncias orbitais de planetas anões:

@example
>>> model = linear_regression(period_squared, dist_cubed, proportional=True)
>>> slope = model.slope

>>> # Planetas anões:   Pluto,  Eris,    Makemake, Haumea, Ceres
>>> orbital_periods = [90_560, 204_199, 111_845, 103_410, 1_680]  # dias
>>> 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]  # distância real em milhões de km
[5906, 10152, 6796, 6450, 414]
@end example


Adicionado na versão 3.10.



Alterado na versão 3.11: Adicionado suporte a `proportional'.

@end deffn

@node Exceções<5>,Objetos NormalDist,Detalhes das funções,statistics — Funções estatísticas
@anchor{library/statistics exceptions}@anchor{28c0}
@subsubsection Exceções


Uma única exceção é definida:

@geindex StatisticsError
@anchor{library/statistics statistics StatisticsError}@anchor{28bf}
@deffn {Exceção} statistics.StatisticsError

Subclasse de @ref{202,,ValueError} para exceções relacionadas a estatísticas.
@end deffn

@node Objetos NormalDist,Exemplos e receitas<2>,Exceções<5>,statistics — Funções estatísticas
@anchor{library/statistics normaldist-objects}@anchor{28c1}
@subsubsection Objetos @code{NormalDist}


@ref{a41,,NormalDist} é uma ferramenta para criar e manipular distribuições normais de uma variável aleatória@footnote{https://pt.wikipedia.org/wiki/Variável_aleatória}. É uma classe que trata a média e o desvio padrão das medições de dados como uma entidade única.

Distribuições normais surgem do Teorema Central do Limite@footnote{https://pt.wikipedia.org/wiki/Teorema_central_do_limite} e possuem uma gama de aplicações em estatísticas.

@geindex NormalDist (classe em statistics)
@anchor{library/statistics statistics NormalDist}@anchor{a41}
@deffn {Classe} statistics.NormalDist (mu=0.0, sigma=1.0)

Retorna um novo objeto `NormalDist' onde `mu' representa a média aritmética@footnote{https://pt.wikipedia.org/wiki/Média_aritmética} e `sigma' representa o desvio padrão@footnote{https://pt.wikipedia.org/wiki/Desvio_padrão}.

Se `sigma' for negativo, levanta a exceção @ref{28bf,,StatisticsError}.

@geindex mean (atributo statistics.NormalDist)
@anchor{library/statistics statistics NormalDist mean}@anchor{28c2}
@deffn {Atributo} mean

Uma propriedade somente leitura para a média aritmética@footnote{https://pt.wikipedia.org/wiki/Média_aritmética} de uma distribuição normal.
@end deffn

@geindex median (atributo statistics.NormalDist)
@anchor{library/statistics statistics NormalDist median}@anchor{28c3}
@deffn {Atributo} median

Uma propriedade somente leitura para a mediana@footnote{https://pt.wikipedia.org/wiki/Mediana_(estatística)} de uma distribuição normal.
@end deffn

@geindex mode (atributo statistics.NormalDist)
@anchor{library/statistics statistics NormalDist mode}@anchor{28c4}
@deffn {Atributo} mode

Uma propriedade somente leitura para a moda@footnote{https://pt.wikipedia.org/wiki/Moda_(estatística)} de uma distribuição normal.
@end deffn

@geindex stdev (atributo statistics.NormalDist)
@anchor{library/statistics statistics NormalDist stdev}@anchor{28c5}
@deffn {Atributo} stdev

Uma propriedade somente leitura para o desvio padrão@footnote{https://pt.wikipedia.org/wiki/Desvio_padrão} de uma distribuição normal.
@end deffn

@geindex variance (atributo statistics.NormalDist)
@anchor{library/statistics statistics NormalDist variance}@anchor{28c6}
@deffn {Atributo} variance

Uma propriedade somente leitura para a variância@footnote{https://pt.wikipedia.org/wiki/Variáncia} de uma distribuição normal. Igual ao quadrado do desvio padrão.
@end deffn

@geindex from_samples() (método de classe statistics.NormalDist)
@anchor{library/statistics statistics NormalDist from_samples}@anchor{28c7}
@deffn {Método} classmethod from_samples (data)

Faz uma instância da distribuição normal com os parâmetros `mu' e `sigma' estimados a partir de `data' usando @ref{a3e,,fmean()} e @ref{6d4,,stdev()}.

`data' pode ser qualquer @ref{1268,,iterável} e deve consistir de valores que pode ser convertidos para o tipo @ref{2f7,,float}. Se `data' não contém pelo menos dois elementos, levanta a exceção @ref{28bf,,StatisticsError} porque é preciso pelo menos um ponto para estimar um valor central e pelo menos dois pontos para estimar a dispersão.
@end deffn

@geindex samples() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist samples}@anchor{28c8}
@deffn {Método} samples (n, *, seed=None)

Gera `n' amostras aleatórias para uma dada média e desvio padrão. Retorna uma @ref{611,,list} de valores @ref{2f7,,float}.

Se o parâmetro `seed' for fornecido, cria uma nova instância do gerador de número aleatório subjacente. Isso é útil para criar resultados reproduzíveis, mesmo em um contexto multithreading.


Alterado na versão 3.13.


Alterado para um algoritmo mais rápido. Para reproduzir amostras de versões anteriores, use @ref{12b5,,random.seed()} e @ref{1962,,random.gauss()}.
@end deffn

@geindex pdf() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist pdf}@anchor{28c9}
@deffn {Método} pdf (x)

Usando uma função densidade de probabilidade (fdp)@footnote{https://pt.wikipedia.org/wiki/Função_densidade}, calcula a probabilidade relativa que uma variável aleatória `X' estará perto do valor dado `x'. Matematicamente, é o limite da razão @code{P(x <= X < x+dx) / dx} quando `dx' se aproxima de zero.

A probabilidade relativa é calculada como a probabilidade de uma amostra ocorrer em um intervalo estreito dividida pela largura do intervalo (daí a palavra “densidade”). Como a probabilidade é relativa a outros pontos, seu valor pode ser maior que @code{1.0}.
@end deffn

@geindex cdf() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist cdf}@anchor{28ca}
@deffn {Método} cdf (x)

Usando uma função distribuição acumulada (fda)@footnote{https://pt.wikipedia.org/wiki/Função_distribuição_acumulada}, calcula a probabilidade de que uma variável aleatória `X' seja menor ou igual a `x'. Matematicamente, é representada da seguinte maneira: @code{P(X <= x)}.
@end deffn

@geindex inv_cdf() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist inv_cdf}@anchor{28cb}
@deffn {Método} inv_cdf (p)

Calcula a função distribuição acumulada inversa, também conhecida como função quantil@footnote{https://pt.wikipedia.org/wiki/Quantil} ou o função ponto percentual@footnote{https://web.archive.org/web/20190203145224/https://www.statisticshowto.datasciencecentral.com/inverse-distribution-function/}. Matematicamente, é representada como @code{x : P(X <= x) = p}.

Encontra o valor `x' da variável aleatória `X' de tal forma que a probabilidade da variável ser menor ou igual a esse valor seja igual à probabilidade dada `p'.
@end deffn

@geindex overlap() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist overlap}@anchor{28cc}
@deffn {Método} overlap (other)

Mede a concordância entre duas distribuições de probabilidade normais. Retorna um valor entre 0,0 e 1,0 fornecendo a área de sobreposição para as duas funções de densidade de probabilidade@footnote{https://www.rasch.org/rmt/rmt101r.htm}.
@end deffn

@geindex quantiles() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist quantiles}@anchor{28cd}
@deffn {Método} quantiles (n=4)

Divide a distribuição normal em `n' intervalos contínuos com probabilidade igual. Retorna uma lista de (n - 1) pontos de corte separando os intervalos.

Defina `n' como 4 para quartis (o padrão). Defina `n' como 10 para decis. Defina `n' como 100 para percentis, o que dá os 99 pontos de corte que separam a distribuição normal em 100 grupos de tamanhos iguais.
@end deffn

@geindex zscore() (método statistics.NormalDist)
@anchor{library/statistics statistics NormalDist zscore}@anchor{28ce}
@deffn {Método} zscore (x)

Calcula a Pontuação Padrão (z-score)@footnote{https://www.statisticshowto.com/probability-and-statistics/z-score/} descrevendo `x' em termos do número de desvios padrão acima ou abaixo da média da distribuição normal: @code{(x - mean) / stdev}.


Adicionado na versão 3.9.

@end deffn

Instâncias de @ref{a41,,NormalDist} suportam adição, subtração, multiplicação e divisão por uma constante. Essas operações são usadas para translação e dimensionamento. Por exemplo:

@example
>>> temperature_february = NormalDist(5, 2.5)             # Celsius
>>> temperature_february * (9/5) + 32                     # Fahrenheit
NormalDist(mu=41.0, sigma=4.5)
@end example

A divisão de uma constante por uma instância de @ref{a41,,NormalDist} não é suportada porque o resultado não seria distribuído normalmente.

Uma vez que distribuições normais surgem de efeitos aditivos de variáveis independentes, é possível adicionar e subtrair duas variáveis aleatórias independentes normalmente distribuídas@footnote{https://en.wikipedia.org/wiki/Sum_of_normally_distributed_random_variables} representadas como instâncias de @ref{a41,,NormalDist}. Por exemplo:

@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


Adicionado na versão 3.8.

@end deffn

@node Exemplos e receitas<2>,,Objetos NormalDist,statistics — Funções estatísticas
@anchor{library/statistics examples-and-recipes}@anchor{28cf}
@subsubsection Exemplos e receitas


@menu
* Problemas clássicos de probabilidade:: 
* Entradas de Monte Carlo para simulações:: 
* Aproximação de distribuições binomiais:: 
* Classificador bayesiano ingênuo:: 

@end menu

@node Problemas clássicos de probabilidade,Entradas de Monte Carlo para simulações,,Exemplos e receitas<2>
@anchor{library/statistics classic-probability-problems}@anchor{28d0}
@subsubsection Problemas clássicos de probabilidade


@ref{a41,,NormalDist} facilmente resolve problemas de probabilidade clássicos.

Por exemplo, considerando os dados históricos para exames SAT@footnote{https://nces.ed.gov/programs/digest/d17/tables/dt17_226.40.asp} mostrando que as pontuações são normalmente distribuídas com média de 1060 e desvio padrão de 195, determine o percentual de alunos com pontuações de teste entre 1100 e 1200, após arredondar para o número inteiro mais próximo:

@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

Encontrar os quartis@footnote{https://pt.wikipedia.org/wiki/Quartil} e decis@footnote{https://pt.wikipedia.org/wiki/Decil} para as pontuações 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 simulações,Aproximação de distribuições binomiais,Problemas clássicos de probabilidade,Exemplos e receitas<2>
@anchor{library/statistics monte-carlo-inputs-for-simulations}@anchor{28d1}
@subsubsection Entradas de Monte Carlo para simulações


Para estimar a distribuição de um modelo que não seja fácil de resolver analiticamente, @ref{a41,,NormalDist} pode gerar amostras de entrada para uma simulação Monte Carlo@footnote{https://pt.wikipedia.org/wiki/Método_de_Monte_Carlo}:

@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 Aproximação de distribuições binomiais,Classificador bayesiano ingênuo,Entradas de Monte Carlo para simulações,Exemplos e receitas<2>
@anchor{library/statistics approximating-binomial-distributions}@anchor{28d2}
@subsubsection Aproximação de distribuições binomiais


As distribuições normais podem ser usadas para aproximar distribuições binomiais@footnote{https://mathworld.wolfram.com/BinomialDistribution.html} quando o tamanho da amostra é grande e quando a probabilidade de um teste bem-sucedido é próximo a 50%.

Por exemplo, uma conferência de código aberto tem 750 participantes e duas salas com capacidade para 500 pessoas. Há uma palestra sobre Python e outra sobre Ruby. Em conferências anteriores, 65% dos participantes preferiram ouvir palestras sobre Python. Supondo que as preferências da população não tenham mudado, qual é a probabilidade da sala de Python permanecer dentro de seus limites de capacidade?

@example
>>> n = 750             # Tamanho da amostra
>>> p = 0.65            # Preferência para Python
>>> q = 1.0 - p         # Preferência para Ruby
>>> k = 500             # Capacidade

>>> # Aproximação usando a distribuição normal cumulativa
>>> from math import sqrt
>>> round(NormalDist(mu=n*p, sigma=sqrt(n*p*q)).cdf(k + 0.5), 4)
0.8402

>>> # Solução exata usando a distribuição binomial cumulativa
>>> from math import comb, fsum
>>> round(fsum(comb(n, r) * p**r * q**(n-r) for r in range(k+1)), 4)
0.8402

>>> # Aproximação usando uma simulação
>>> from random import seed, binomialvariate
>>> seed(8675309)
>>> mean(binomialvariate(n, p) <= k for i in range(10_000))
0.8406
@end example

@node Classificador bayesiano ingênuo,,Aproximação de distribuições binomiais,Exemplos e receitas<2>
@anchor{library/statistics naive-bayesian-classifier}@anchor{28d3}
@subsubsection Classificador bayesiano ingênuo


Distribuições normais geralmente surgem em problemas de aprendizado de máquina.

A Wikipedia tem um bom exemplo de um Classificador Bayesiano Ingênuo@footnote{https://en.wikipedia.org/wiki/Naive_Bayes_classifier#Person_classification}. O desafio é prever o sexo de uma pessoa a partir de medidas de características normalmente distribuídas, incluindo altura, peso e tamanho do pé.

Recebemos um conjunto de dados de treinamento com medições para oito pessoas. As medidas são consideradas normalmente distribuídas, então resumimos os dados com @ref{a41,,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

Em seguida, encontramos uma nova pessoa cujas características de medidas são conhecidas, mas cujo gênero é desconhecido:

@example
>>> ht = 6.0        # altura
>>> wt = 130        # peso
>>> fs = 8          # tamanho do pé
@end example

Começando com uma probabilidade a priori@footnote{https://pt.wikipedia.org/wiki/Probabilidade_a_priori} de 50% de ser homem ou mulher, calculamos a posteriori como a priori vezes o produto das probabilidade para as características de medidas dado o 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

A previsão final vai para a probabilidade posterior maior. Isso é conhecido como máximo a posteriori@footnote{https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation}  ou 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 Programação Funcional,Acesso a arquivos e diretórios,Módulos Matemáticos e Numéricos,A Biblioteca Padrão do Python
@anchor{library/functional doc}@anchor{28d4}@anchor{library/functional functional-programming-modules}@anchor{28d5}@anchor{library/functional translation-repo}@anchor{28d6}
@section Módulos de Programação Funcional


Os módulos descritos neste capítulo fornecem funções e classes que suportam um estilo de programação funcional e operações gerais em chamáveis.

Os seguintes módulos estão documentados neste capítulo:

@menu
* itertools — Funções que criam iteradores para laços eficientes:: 
* functools — Funções e operações de ordem superior em objetos chamáveis:: 
* operator — Operadores padrões como funções:: 

@end menu

@node itertools — Funções que criam iteradores para laços eficientes,functools — Funções e operações de ordem superior em objetos chamáveis,,Módulos de Programação Funcional
@anchor{library/itertools doc}@anchor{28d7}@anchor{library/itertools itertools-functions-creating-iterators-for-efficient-looping}@anchor{28d8}@anchor{library/itertools module-itertools}@anchor{81}
@subsection @code{itertools} — Funções que criam iteradores para laços eficientes


@geindex module; itertools

@c from itertools import *
@c import collections
@c import math
@c import operator
@c import random


__________________________________________________________________


Esse módulo implementa diversos blocos de instruções com @ref{1ac,,iteradores}, inspirados por construções de APL, Haskell, e SML. Cada uma foi adequadamente reformulada para Python.

Esse módulo padroniza um conjunto central de ferramentas rápidas e de uso eficiente da memória, que podem ser utilizadas sozinhas ou combinadas. Juntas, eles formam uma “álgebra de iteradores” tornando possível construir ferramentas sucintas e eficientes em Python puro.

Por exemplo, SML fornece uma ferramenta para tabulação: @code{tabulate(f)} que produz uma sequência @code{f(0), f(1), ...}.  O mesmo efeito pode ser obtido em Python combinando @ref{867,,map()} e @ref{12c5,,count()} para formar @code{map(f, count())}.

`Iteradores infinitos:'


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultado

@tab

Exemplo

@item

@ref{12c5,,count()}

@tab

[start[, step]]

@tab

start, start+step, start+2*step, …

@tab

@code{count(10) → 10 11 12 13 14 ...}

@item

@ref{28d9,,cycle()}

@tab

p

@tab

p0, p1, … ultimo elemento de p, p0, p1, …

@tab

@code{cycle('ABCD') → A B C D A B C D ...}

@item

@ref{28da,,repeat()}

@tab

elem [,n]

@tab

elem, elem, elem, … repete infinitamente ou até n vezes

@tab

@code{repeat(10, 3) → 10 10 10}

@end multitable


`Iteradores terminando na sequencia de entrada mais curta:'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultado

@tab

Exemplo

@item

@ref{a05,,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{201,,batched()}

@tab

p, n

@tab

(p0, p1, …, p_n-1), …

@tab

@code{batched('ABCDEFG', n=3) → ABC DEF G}

@item

@ref{2315,,chain()}

@tab

p, q, …

@tab

p0, p1, … último elemento de p, q0, q1, …

@tab

@code{chain('ABC', 'DEF') → A B C D E F}

@item

@ref{28db,,chain.from_iterable()}

@tab

iterável

@tab

p0, p1, … último elemento de p, q0, q1, …

@tab

@code{chain.from_iterable(['ABC', 'DEF']) → A B C D E F}

@item

@ref{12c4,,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{28dc,,dropwhile()}

@tab

predicate, seq

@tab

seq[n], seq[n+1], começando quando o predicate falha

@tab

@code{dropwhile(lambda x: x<5, [1,4,6,3,8]) → 6 3 8}

@item

@ref{2303,,filterfalse()}

@tab

predicate, seq

@tab

elementos de seq onde predicate(elem) falha

@tab

@code{filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8}

@item

@ref{28dd,,groupby()}

@tab

iterable[, key]

@tab

sub-iteradores agrupados pelo valor de key(v)

@tab

@code{groupby(['A','B','DEF'], len) → (1, A B) (3, DEF)}

@item

@ref{b61,,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{818,,pairwise()}

@tab

iterável

@tab

(p[0], p[1]), (p[1], p[2])

@tab

@code{pairwise('ABCDEFG') → AB BC CD DE EF FG}

@item

@ref{1123,,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{28de,,takewhile()}

@tab

predicate, seq

@tab

seq[0], seq[1], até predicate falhar

@tab

@code{takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4}

@item

@ref{28df,,tee()}

@tab

it, n

@tab

n iteradores it independentes

@tab

@item

@ref{12e0,,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 combinatórios:'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Iterador

@tab

Argumentos

@tab

Resultado

@item

@ref{1357,,product()}

@tab

p, q, … [repeat=1]

@tab

produto cartesiano, equivalente a laços @code{for} aninhados

@item

@ref{1a6a,,permutations()}

@tab

p[, r]

@tab

tuplas de tamanho r, com todas ordenações possíveis, sem elementos repetidos

@item

@ref{1356,,combinations()}

@tab

p, r

@tab

tuplas de tamanho r, ordenadas, sem elementos repetidos

@item

@ref{12c3,,combinations_with_replacement()}

@tab

p, r

@tab

tuplas de tamanho r, ordenadas, com elementos repetidos

@end multitable



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Exemplos

@tab

Resultado

@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
* Funções do intertools:: 
* Receitas com itertools:: 

@end menu

@node Funções do intertools,Receitas com itertools,,itertools — Funções que criam iteradores para laços eficientes
@anchor{library/itertools itertool-functions}@anchor{28e0}@anchor{library/itertools itertools-functions}@anchor{28e1}
@subsubsection Funções do intertools


Todas as funções a seguir constroem e retornam iteradores. Algumas fornecem fluxos de comprimento infinito, então elas devem ser acessadas somente por funções ou laços que truncam o fluxo.

@geindex accumulate() (no módulo itertools)
@anchor{library/itertools itertools accumulate}@anchor{a05}
@deffn {Função} itertools.accumulate (iterable[, function, *, initial=None])

Constrói um iterador que retorna somas acumuladas, ou resultados acumulados de outras funções binárias.

A função `function' assume como padrão a adição. `function' deve aceitar dois argumentos, um total acumulado e um valor de `iterable'.

Se um valor inicial `initial' for fornecido, o acúmulo começará com esse valor e a saída terá um elemento a mais que o iterável de entrada.

Aproximadamente equivalente a:

@example
def accumulate(iterable, function=operator.add, *, initial=None):
    'Retorna totais atuais'
    # 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

Para calcular um mínimo atual, defina `function' como @ref{f3a,,min()}. Para um máximo atual, defina `function' como @ref{f3b,,max()}. Ou para um produto atual, defina `function' como @ref{28e2,,operator.mul()}. Para construir uma tabela de amortização@footnote{https://www.ramseysolutions.com/real-estate/amortization-schedule}, acumular os juros e aplicar os pagamentos:

@example
>>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
>>> list(accumulate(data, max))              # máximo atual
[3, 4, 6, 6, 6, 9, 9, 9, 9, 9]
>>> list(accumulate(data, operator.mul))     # produto atual
[3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]

# Amortiza um empréstimo de 5% de 1000 com 10 pagamentos anuais de 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

Veja @ref{131f,,functools.reduce()} para uma função similar que devolve apenas o valor acumulado final.


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionado o parâmetro opcional `function'.



Alterado na versão 3.8: Adicionado o parâmetro opcional `initial'.

@end deffn

@geindex batched() (no módulo itertools)
@anchor{library/itertools itertools batched}@anchor{201}
@deffn {Função} itertools.batched (iterable, n, *, strict=False)

Dados de lote do `iterable' em tuplas de comprimento `n'. O último lote pode ser menor que `n'.

Se `strict' for verdadeiro, será levantada uma @ref{202,,ValueError} se o lote final for menor que `n'.

Faz um laço sobre o iterável de entrada e acumula dados em tuplas de até o tamanho `n'. A entrada é consumida preguiçosamente, apenas o suficiente para preencher um lote. O resultado é produzido assim que o lote estiver cheio ou quando o iterável de entrada estiver esgotado:

@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


Adicionado na versão 3.12.



Alterado na versão 3.13: Adicionada a opção `strict'.

@end deffn

@geindex chain() (no módulo itertools)
@anchor{library/itertools itertools chain}@anchor{2315}
@deffn {Função} itertools.chain (*iterables)

Cria um iterador que devolve elementos do primeiro iterável até o esgotamento, então prossiga para o próximo iterável, até que todos os iteráveis sejam esgotados Isso combina várias fontes de dados em um único iterador. Aproximadamente equivalente a:

@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 classe itertools.chain)
@anchor{library/itertools itertools chain from_iterable}@anchor{28db}
@deffn {Método} classmethod chain.from_iterable (iterable)

Construtor alternativo para @ref{2315,,chain()}. Obtém entradas encadeadas a partir de um único argumento iterável que avaliado preguiçosamente. 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() (no módulo itertools)
@anchor{library/itertools itertools combinations}@anchor{1356}
@deffn {Função} itertools.combinations (iterable, r)

Devolve subsequências de elementos com comprimento `r' a partir da entrada `iterável'

A saída é uma subsequência de @ref{1357,,product()} mantendo apenas entradas que são subsequências do `iterable'. O comprimento da saída é dado por @ref{6d0,,math.comb()} que calcula @code{n! / r! / (n - r)!} quando @code{0 ≤ r ≤ n} ou zero quando @code{r > n}.

As tuplas das combinações são emitidas em ordem lexicográfica de acordo com a ordem do iterável de entrada. Se o iterável estiver ordenado, as tuplas de combinação serão produzidas em sequência ordenada.

Os elementos são tratados como únicos baseado em suas posições, não em seus valores. Se os elementos de entrada são únicos, não haverá repetição de valores nas sucessivas combinações.

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() (no módulo itertools)
@anchor{library/itertools itertools combinations_with_replacement}@anchor{12c3}
@deffn {Função} itertools.combinations_with_replacement (iterable, r)

Devolve subsequências de comprimento `r' de elementos do `iterável' de entrada permitindo que elementos individuais sejam repetidos mais de uma vez.

A saída é uma subsequência de @ref{1357,,product()} que mantém apenas entradas que são subsequências (com possíveis elementos repetidos) do `iterable'. O número de subsequências retornadas é @code{(n + r - 1)! / r! / (n - 1)!} quando @code{n > 0}.

As tuplas das combinações são emitidas em ordem lexicográfica de acordo com a ordem do iterável de entrada. Se o iterável estiver ordenado, as tuplas de combinação serão produzidas em sequência ordenada.

Os elementos são tratados como únicos baseado em suas posições, não em seus valores. Se os elementos de entrada forem únicos, não haverá repetição de valores nas combinações geradas.

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


Adicionado na versão 3.1.

@end deffn

@geindex compress() (no módulo itertools)
@anchor{library/itertools itertools compress}@anchor{12c4}
@deffn {Função} itertools.compress (data, selectors)

Cria um iterador que retorne elementos de `data' onde o elemento correspondente em `selectors' é verdadeiro. Para quando os iteráveis `data' ou `selectors' forem esgotados. Aproximadamente equivalente a:

@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


Adicionado na versão 3.1.

@end deffn

@geindex count() (no módulo itertools)
@anchor{library/itertools itertools count}@anchor{12c5}
@deffn {Função} itertools.count (start=0, step=1)

Cria um iterador que retorne valores uniformemente espaçados começando com `start'. Pode ser usado com @ref{867,,map()} para gerar pontos de dados consecutivos ou com @ref{7d1,,zip()} para adicionar números de sequência. Aproximadamente equivalente a:

@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

Quando é feita uma contagem usando números de ponto flutuante, é possível ter melhor precisão substituindo código multiplicativo como  @code{(start + step * i for i in count())}.


Alterado na versão 3.1: Adicionou argumento `step' e permitiu argumentos não-inteiros.

@end deffn

@geindex cycle() (no módulo itertools)
@anchor{library/itertools itertools cycle}@anchor{28d9}
@deffn {Função} itertools.cycle (iterable)

Crie um iterador que devolve elementos do `iterable' assim como salva uma cópia de cada um. Quando o iterável é esgotado, devolve elementos da cópia salva. Repete indefinidamente. Aproximadamente equivalente a:

@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

Esta itertool pode exigir armazenamento auxiliar significativo (dependendo do comprimento do iterável).
@end deffn

@geindex dropwhile() (no módulo itertools)
@anchor{library/itertools itertools dropwhile}@anchor{28dc}
@deffn {Função} itertools.dropwhile (predicate, iterable)

Cria um iterador que remove elementos do `iterable' enquanto o `predicate' for verdadeiro e, em seguida, retorna todos os elementos. Equivalente a:

@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

Observe que isso não produz `nenhuma' saída até que o predicado se torne falso, portanto, esta itertool pode ter um longo tempo de inicialização.
@end deffn

@geindex filterfalse() (no módulo itertools)
@anchor{library/itertools itertools filterfalse}@anchor{2303}
@deffn {Função} itertools.filterfalse (predicate, iterable)

Cria um iterador que filtre elementos do `iterable', retornando apenas aqueles para os quais o `predicate' retorna um valor falso. Se o `predicate' for @code{None}, retorna os itens que são falsos. Equivalente aproximadamente a:

@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() (no módulo itertools)
@anchor{library/itertools itertools groupby}@anchor{28dd}
@deffn {Função} itertools.groupby (iterable, key=None)

Cria um iterador que retorna chaves e grupos consecutivos do `iterable'. A `key' é uma função que calcula um valor-chave para cada elemento. Se não for especificado ou for @code{None}, `key' assume como padrão uma função de identidade e retorna o elemento inalterado. Geralmente, o iterável precisa já estar ordenado na mesma função chave.

O funcionamento de @ref{28dd,,groupby()} é semelhante ao filtro @code{uniq} no Unix. Ele gera uma quebra ou um novo grupo sempre que o valor da função da tecla muda (razão pela qual geralmente é necessário ordenar os dados usando a mesma função da tecla). Esse comportamento difere do GROUP BY do SQL, que agrega elementos comuns independentemente da ordem de entrada.

O grupo retornado é, ele próprio, um iterador que compartilha o iterável subjacente com @ref{28dd,,groupby()}. Como a origem é compartilhada, quando o objeto @ref{28dd,,groupby()} avança, o grupo anterior não fica mais visível. Portanto, se esses dados forem necessários posteriormente, eles devem ser armazenados como uma lista:

@example
groups = []
uniquekeys = []
data = sorted(data, key=keyfunc)
for k, g in groupby(data, keyfunc):
    groups.append(list(g))      # armazena um iterador de grupo como uma lista
    uniquekeys.append(k)
@end example

@ref{28dd,,groupby()} é 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() (no módulo itertools)
@anchor{library/itertools itertools islice}@anchor{b61}
@deffn {Função} itertools.islice (iterable, stop)

@deffnx {Função} itertools.islice (iterable, start, stop[, step])

Cria um iterador que retorna os elementos selecionados do iterável. Funciona como o fatiamento de sequência, mas não oferece suporte a valores negativos para `start', `stop' ou `step'.

Se `start' for zero ou @code{None}, a iteração começa em zero. Caso contrário, os elementos do iterável são pulados até que `start' seja alcançado.

Se `stop' for @code{None}, a iteração continua até que a entrada se esgote, se for o caso. Caso contrário, ela para na posição especificada.

Se `step' for @code{None}, o padrão do passo é 1. Os elementos são retornados consecutivamente, a menos que `step' seja definido como maior que um, o que resulta na omissão de itens.

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

Se a entrada for um iterador, o consumo total do `islice' avança o iterador de entrada em @code{max(start, stop)} passos, independentemente do valor do `step'.
@end deffn

@geindex pairwise() (no módulo itertools)
@anchor{library/itertools itertools pairwise}@anchor{818}
@deffn {Função} itertools.pairwise (iterable)

Return successive overlapping pairs taken from the input `iterable'.

The number of 2-tuples in the output iterator will be one fewer than the
number of inputs.  It will be empty if the input iterable has fewer than
two values.

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


Adicionado na versão 3.10.

@end deffn

@geindex permutations() (no módulo itertools)
@anchor{library/itertools itertools permutations}@anchor{1a6a}
@deffn {Função} itertools.permutations (iterable, r=None)

Return successive `r' length permutations of elements@footnote{https://www.britannica.com/science/permutation} from the `iterable'.

If `r' is not specified or is @code{None}, then `r' defaults to the length
of the `iterable' and all possible full-length permutations
are generated.

The output is a subsequence of @ref{1357,,product()} where entries with
repeated elements have been filtered out.  The length of the output is
given by @ref{6d1,,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() (no módulo itertools)
@anchor{library/itertools itertools product}@anchor{1357}
@deffn {Função} itertools.product (*iterables, repeat=1)

Cartesian product@footnote{https://en.wikipedia.org/wiki/Cartesian_product}
of the input iterables.

Aproximadamente equivalente a laços for aninhados em uma expressão geradora. Por exemplo, @code{product(A, B)} devolve o mesmo que @code{((x,y) for x in A for y in B)}.

Os laços aninhados circulam como um hodômetro com o elemento mais à direita avançando a cada iteração. Este padrão cria uma ordenação lexicográfica de maneira que se os iteráveis de entrada estiverem ordenados, as tuplas produzidas são emitidas de maneira ordenada.

To compute the product of an iterable with itself, specify the number of
repetitions with the optional `repeat' keyword argument.  For example,
@code{product(A, repeat=4)} means the same as @code{product(A, A, A, A)}.

This function is roughly equivalent to the following code, except that the
actual implementation does not build up intermediate results in memory:

@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

Before @ref{1357,,product()} runs, it completely consumes the input iterables,
keeping pools of values in memory to generate the products.  Accordingly,
it is only useful with finite inputs.
@end deffn

@geindex repeat() (no módulo itertools)
@anchor{library/itertools itertools repeat}@anchor{28da}
@deffn {Função} itertools.repeat (object[, times])

Make an iterator that returns `object' over and over again. Runs indefinitely
unless the `times' argument is specified.

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

Um uso comum de `repeat' é para fornecer um fluxo de valores constantes para `map' ou `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() (no módulo itertools)
@anchor{library/itertools itertools starmap}@anchor{1123}
@deffn {Função} itertools.starmap (function, iterable)

Make an iterator that computes the `function' using arguments obtained
from the `iterable'.  Used instead of @ref{867,,map()} when argument
parameters have already been “pre-zipped” into tuples.

The difference between @ref{867,,map()} and @ref{1123,,starmap()} parallels the
distinction between @code{function(a,b)} and @code{function(*c)}. Roughly
equivalent to:

@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() (no módulo itertools)
@anchor{library/itertools itertools takewhile}@anchor{28de}
@deffn {Função} 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-itertools before_and_after()@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.before_and_after}
instead.
@end deffn

@geindex tee() (no módulo itertools)
@anchor{library/itertools itertools tee}@anchor{28df}
@deffn {Função} itertools.tee (iterable, n=2)

Return `n' independent iterators from a single iterable.

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{28df,,tee()} call.  This “flattening step”
allows nested @ref{28df,,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{195,,RuntimeError} may be
raised when simultaneously using iterators returned by the same @ref{28df,,tee()}
call, even if the original `iterable' is threadsafe.

This itertool may require significant auxiliary storage (depending on how
much temporary data needs to be stored). In general, if one iterator uses
most or all of the data before another iterator starts, it is faster to use
@ref{611,,list()} instead of @ref{28df,,tee()}.
@end deffn

@geindex zip_longest() (no módulo itertools)
@anchor{library/itertools itertools zip_longest}@anchor{12e0}
@deffn {Função} 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{12e0,,zip_longest()}
function should be wrapped with something that limits the number of calls
(for example @ref{b61,,islice()} or @ref{28de,,takewhile()}).
@end deffn

@node Receitas com itertools,,Funções do intertools,itertools — Funções que criam iteradores para laços eficientes
@anchor{library/itertools id1}@anchor{28e3}@anchor{library/itertools itertools-recipes}@anchor{12a0}
@subsubsection Receitas com itertools


Esta seção mostra receitas para criação de um ferramental ampliado usando as ferramentas existentes de itertools como elementos construtivos.

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{1d,,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{109a,,generators} which incur interpreter overhead.

@example
from collections import Counter, deque
from contextlib import suppress
from functools import reduce
from math import comb, prod, sumprod, isqrt
from operator import itemgetter, getitem, mul, neg

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(function, times=None, *args):
    "Repeat calls to a function with specified arguments."
    if times is None:
        return starmap(function, repeat(args))
    return starmap(function, 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 loops(n):
    "Loop n times. Like range(n) but without creating integers."
    # for _ in loops(100): ...
    return repeat(None, n)

def tail(n, iterable):
    "Return an iterator over the last n items."
    # tail(3, 'ABCDEFG') → E F G
    return iter(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:
        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(itemgetter(0), groupby(iterable))
    return map(next, map(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]
   sequenced = sorted(iterable, key=key, reverse=reverse)
   return unique_justseen(sequenced, 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 = 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(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 suppress(ValueError):
            while True:
                yield (i := seq_index(value, i, stop))
                i += 1

def iter_except(function, exception, first=None):
    "Convert a call-until-exception interface to an iterator interface."
    # iter_except(d.popitem, KeyError) → non-blocking dictionary iterator
    with suppress(exception):
        if first is not None:
            yield first()
        while True:
            yield function()
@end example

The following recipes have a more mathematical flavor:

@example
def multinomial(*counts):
    "Number of distinct arrangements of a multiset."
    # Counter('abracadabra').values() → 5 2 2 1 1
    # multinomial(5, 2, 2, 1, 1) → 83160
    return prod(map(comb, accumulate(counts), counts))

def powerset(iterable):
    "Subsequences of the iterable from shortest to longest."
    # 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 sumprod(*tee(iterable))

def reshape(matrix, columns):
    "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), columns, 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(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(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(neg, roots))
    return list(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 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(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=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(isqrt(n) + 1):
        while not n % prime:
            yield prime
            n //= prime
            if n == 1:
                return
    if n > 1:
        yield n

def is_prime(n):
    "Return True if n is prime."
    # is_prime(1_000_000_000_000_403) → True
    return n > 1 and next(factor(n)) == 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 >>> for _ in loops(5):
@c ...     print('hi')
@c ...
@c hi
@c hi
@c hi
@c hi
@c hi
@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 >>> 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 >>> list(filter(is_prime, range(-100, 100))) == small_primes
@c True
@c >>> carmichael = {561, 1105, 1729, 2465, 2821, 6601, 8911}  # https://oeis.org/A002997
@c >>> any(map(is_prime, carmichael))
@c False
@c >>> # https://www.wolframalpha.com/input?i=is+128884753939+prime
@c >>> is_prime(128_884_753_939)           # large prime
@c True
@c >>> is_prime(999953 * 999983)           # large semiprime
@c False
@c >>> is_prime(1_000_000_000_000_007)     # factor() example
@c False
@c >>> is_prime(1_000_000_000_000_403)     # factor() example
@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 
@c >>> multinomial(5, 2, 2, 1, 1)
@c 83160
@c >>> word = 'coffee'
@c >>> multinomial(*Counter(word).values()) == len(set(permutations(word)))
@c True

@c # Old recipes and their tests which are guaranteed to continue to work.
@c 
@c def old_sumprod_recipe(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 >>> old_sumprod_recipe([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 — Funções e operações de ordem superior em objetos chamáveis,operator — Operadores padrões como funções,itertools — Funções que criam iteradores para laços eficientes,Módulos de Programação Funcional
@anchor{library/functools doc}@anchor{28e4}@anchor{library/functools functools-higher-order-functions-and-operations-on-callable-objects}@anchor{28e5}@anchor{library/functools module-functools}@anchor{5f}@anchor{library/functools translation-repo}@anchor{28e6}
@subsection @code{functools} — Funções e operações de ordem superior em objetos chamáveis


@geindex module; functools

`Código-fonte:' Lib/functools.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/functools.py}

@c import functools
@c from functools import *


__________________________________________________________________


O módulo @ref{5f,,functools} é para funções de ordem superior: funções que atuam ou retornam outras funções. Em geral, qualquer objeto chamável pode ser tratado como uma função para os propósitos deste módulo.

O módulo @ref{5f,,functools} define as seguintes funções:

@geindex cache() (no módulo functools)
@anchor{library/functools functools cache}@anchor{1607}
@deffn {Função} @@functools.cache (user_function)

Cache simples e leve de funções sem vínculo. Às vezes chamado de "memoizar"@footnote{https://en.wikipedia.org/wiki/Memoization}.

Retorna o mesmo que @code{lru_cache(maxsize=None)}, criando um invólucro fino em torno de uma pesquisa de dicionário para os argumentos da função. Como nunca precisa remover valores antigos, isso é menor e mais rápido do que @ref{9f7,,lru_cache()} com um limite de tamanho.

Por exemplo:

@example
@@cache
def factorial(n):
    return n * factorial(n-1) if n else 1

>>> factorial(10)   # sem nenhum resultado previamente armazenado em cache, faz 11 chamadas recursivas.
3628800
>>> factorial(5)    # sem novas chamadas, apenas retorna o resultado em cache.
120
>>> factorial(12)   # duas novas chamadas recursivas, factorial(10) é armazenado em cache
479001600
@end example

O cache é seguro para thread, permitindo que a função encapsulada seja usada em múltiplas threads. Isso significa que a estrutura de dados subjacente permanecerá coerente durante atualizações simultâneas.

É possível que a função encapsulada seja chamada mais de uma vez se outra thread fizer uma chamada adicional antes que a chamada inicial seja concluída e armazenada em cache.


Adicionado na versão 3.9.

@end deffn

@geindex cached_property() (no módulo functools)
@anchor{library/functools functools cached_property}@anchor{541}
@deffn {Função} @@functools.cached_property (func)

Transforma um método de uma classe em uma propriedade cujo valor é calculado uma vez e, em seguida, armazenado em cache como um atributo normal para a vida útil da instância. Semelhante a @ref{194,,property()}, com a adição de armazenamento em cache. Útil para propriedades computadas caras de instâncias que são efetivamente imutáveis.

Exemplo:

@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

A mecânica de @ref{541,,cached_property()} difere um pouco da de @ref{194,,property()}. Uma propriedade comum bloqueia a escrita de atributos, a menos que um método setter seja definido. Em contraste, uma `cached_property' permite escritas.

O decorador `cached_property' só é executado em pesquisas e apenas quando um atributo com o mesmo nome não existe. Quando executado, o `cached_property' escreve no atributo com o mesmo nome. Leituras e escritas subsequentes do atributo têm precedência sobre o método `cached_property' e ele funciona como um atributo normal.

O valor em cache pode ser apagado excluindo o atributo. Isso permite que o método `cached_property' seja executado novamente.

A propriedade `cached_property' não impede uma possível condição de corrida em uso multithread. A função getter pode ser executada mais de uma vez na mesma instância, com a última execução definindo o valor em cache. Se a propriedade em cache for idempotente ou não causar problemas ao ser executada mais de uma vez em uma instância, isso não será um problema. Caso seja necessária sincronização, implemente a trava necessária dentro da função getter decorada ou em torno do acesso à propriedade em cache.

Observe que este decorador interfere com a operação dos dicionários que compartilham chaves da 
@geindex Propostas de Melhorias do Python; PEP 412
PEP 412@footnote{https://peps.python.org/pep-0412/}. Isso significa que os dicionários de instância podem ocupar mais espaço do que o normal.

Also, this decorator requires that the @code{__dict__} attribute on each instance
be a mutable mapping. This means it will not work with some types, such as
metaclasses (since the @code{__dict__} attributes on type instances are
read-only proxies for the class namespace), and those that specify
@code{__slots__} without including @code{__dict__} as one of the defined slots
(as such classes don’t provide a @code{__dict__} attribute at all).

If a mutable mapping is not available or if space-efficient key sharing is
desired, an effect similar to @ref{541,,cached_property()} can also be achieved by
stacking @ref{194,,property()} on top of @ref{9f7,,lru_cache()}. See
@ref{28e7,,Como faço para armazenar em cache as chamadas de um método?} for more details on how this differs from @ref{541,,cached_property()}.


Adicionado na versão 3.8.



Alterado na versão 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() (no módulo functools)
@anchor{library/functools functools cmp_to_key}@anchor{121a}
@deffn {Função} functools.cmp_to_key (func)

Transforma uma função de comparação de estilo antigo para um @ref{e31,,função chave}. Usado com ferramentas que aceitam funções chave (como @ref{be7,,sorted()}, @ref{f3a,,min()}, @ref{f3b,,max()}, @ref{26d6,,heapq.nlargest()}, @ref{26d7,,heapq.nsmallest()}, @ref{28dd,,itertools.groupby()}). Esta função é usada principalmente como uma ferramenta de transição para programas que estão sendo convertidos a partir do Python 2, que suportou o uso de funções de comparação.

A comparison function is any callable that accepts two arguments, compares them,
and returns a negative number for less-than, zero for equality, or a positive
number for greater-than.  A key function is a callable that accepts one
argument and returns another value to be used as the sort key.

Exemplo:

@example
sorted(iterable, key=cmp_to_key(locale.strcoll))  # locale-aware sort order
@end example

Para exemplos de classificação e um breve tutorial de classificação, veja @ref{2314,,Técnicas de ordenação}.


Adicionado na versão 3.2.

@end deffn

@geindex lru_cache() (no módulo functools)
@anchor{library/functools functools lru_cache}@anchor{9f7}
@deffn {Função} @@functools.lru_cache (user_function)

@deffnx {Função} @@functools.lru_cache (maxsize=128, typed=False)

Decorador para embrulhar uma função com um chamável memoizável que economiza até as chamadas mais recentes `maxsize'. Pode economizar tempo quando uma função cara ou E/S é periodicamente chamada com os mesmos argumentos.

O cache é seguro para thread, permitindo que a função encapsulada seja usada em múltiplas threads. Isso significa que a estrutura de dados subjacente permanecerá coerente durante atualizações simultâneas.

É possível que a função encapsulada seja chamada mais de uma vez se outra thread fizer uma chamada adicional antes que a chamada inicial seja concluída e armazenada em cache.

Since a dictionary is used to cache results, the positional and keyword
arguments to the function must be @ref{610,,hashable}.

Distinct argument patterns may be considered to be distinct calls with
separate cache entries.  For example, @code{f(a=1, b=2)} and @code{f(b=2, a=1)}
differ in their keyword argument order and may have two separate cache
entries.

Se `user_function' especificado, deve ser um chamável. Isso permite que o decorador `lru_cache' seja aplicado diretamente a uma função do usuário, deixando `maxsize' em seu valor padrão de 128:

@example
@@lru_cache
def count_vowels(sentence):
    return sum(sentence.count(vowel) for vowel in 'AEIOUaeiou')
@end example

Se `maxsize' for definido como @code{None}, o recurso LRU é desabilitado e o cache pode crescer sem limites.

If `typed' is set to true, function arguments of different types will be
cached separately.  If `typed' is false, the implementation will usually
regard them as equivalent calls and only cache a single result. (Some
types such as `str' and `int' may be cached separately even when `typed'
is false.)

Note, type specificity applies only to the function’s immediate arguments
rather than their contents.  The scalar arguments, @code{Decimal(42)} and
@code{Fraction(42)} are be treated as distinct calls with distinct results.
In contrast, the tuple arguments @code{('answer', Decimal(42))} and
@code{('answer', Fraction(42))} are treated as equivalent.

The wrapped function is instrumented with a @code{cache_parameters()}
function that returns a new @ref{256,,dict} showing the values for `maxsize'
and `typed'.  This is for information purposes only.  Mutating the values
has no effect.

@geindex cache_info() (método functools.lru_cache)
@anchor{library/functools functools lru_cache cache_info}@anchor{28e8}
To help measure the effectiveness of the cache and tune the `maxsize'
parameter, the wrapped function is instrumented with a @code{cache_info()}
function that returns a @ref{64e,,named tuple} showing `hits', `misses',
`maxsize' and `currsize'.

@geindex cache_clear() (método functools.lru_cache)
@anchor{library/functools functools lru_cache cache_clear}@anchor{28e9}
The decorator also provides a @code{cache_clear()} function for clearing or
invalidating the cache.

A função subjacente original é acessível através do atributo @code{__wrapped__}. Isso é útil para introspecção, para ignorar o cache, ou para reinstalar a função com um cache diferente.

The cache keeps references to the arguments and return values until they age
out of the cache or until the cache is cleared.

If a method is cached, the @code{self} instance argument is included in the
cache.  See @ref{28e7,,Como faço para armazenar em cache as chamadas de um 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().

Exemplo de um cache LRU para conteúdo 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

Exemplo de computação eficiente dos números Fibonacci@footnote{https://pt.wikipedia.org/wiki/Sequência_de_Fibonacci} usando um cache para implementar uma programação dinâmica@footnote{https://pt.wikipedia.org/wiki/Programação_dinâmica} técnica:

@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


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionada a opção `typed'.



Alterado na versão 3.8: Adicionada a opção `user_function'.



Alterado na versão 3.9: Added the function @code{cache_parameters()}

@end deffn

@geindex total_ordering() (no módulo functools)
@anchor{library/functools functools total_ordering}@anchor{f75}
@deffn {Função} @@functools.total_ordering

Given a class defining one or more rich comparison ordering methods, this
class decorator supplies the rest.  This simplifies the effort involved
in specifying all of the possible rich comparison operations:

The class must define one of @ref{12e2,,__lt__()}, @ref{134f,,__le__()},
@ref{1350,,__gt__()}, or @ref{1351,,__ge__()}.
In addition, the class should supply an @ref{b0d,,__eq__()} method.

Por exemplo:

@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 
While this decorator makes it easy to create well behaved totally
ordered types, it `does' come at the cost of slower execution and
more complex stack traces for the derived comparison methods. If
performance benchmarking indicates this is a bottleneck for a given
application, implementing all six rich comparison methods instead is
likely to provide an easy speed boost.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
This decorator makes no attempt to override methods that have been
declared in the class `or its superclasses'. Meaning that if a
superclass defines a comparison operator, `total_ordering' will not
implement it again, even if the original method is abstract.
@end quotation
@end cartouche


Adicionado na versão 3.2.



Alterado na versão 3.4: Returning @code{NotImplemented} from the underlying comparison function for
unrecognised types is now supported.

@end deffn

@geindex partial() (no módulo functools)
@anchor{library/functools functools partial}@anchor{414}
@deffn {Função} functools.partial (func, /, *args, **keywords)

Return a new @ref{28ea,,partial object} which when called
will behave like `func' called with the positional arguments `args'
and keyword arguments `keywords'. If more arguments are supplied to the
call, they are appended to `args'. If additional keyword arguments are
supplied, they extend and override `keywords'.
Roughly equivalent to:

@example
def partial(func, /, *args, **keywords):
    def newfunc(*fargs, **fkeywords):
        newkeywords = @{**keywords, **fkeywords@}
        return func(*args, *fargs, **newkeywords)
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc
@end example

The @ref{414,,partial()} 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{414,,partial()} can be used to create
a callable that behaves like the @ref{257,,int()} function where the `base' argument
defaults to two:

@example
>>> from functools import partial
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18
@end example
@end deffn

@geindex partialmethod (classe em functools)
@anchor{library/functools functools partialmethod}@anchor{a85}
@deffn {Classe} functools.partialmethod (func, /, *args, **keywords)

Return a new @ref{a85,,partialmethod} descriptor which behaves
like @ref{414,,partial} except that it is designed to be used as a method
definition rather than being directly callable.

`func' must be a @ref{1658,,descriptor} or a callable (objects which are both,
like normal functions, are handled as descriptors).

When `func' is a descriptor (such as a normal Python function,
@ref{166,,classmethod()}, @ref{416,,staticmethod()}, @ref{10c4,,abstractmethod()} or
another instance of @ref{a85,,partialmethod}), calls to @code{__get__} are
delegated to the underlying descriptor, and an appropriate
@ref{28ea,,partial object} returned as the result.

When `func' is a non-descriptor callable, an appropriate bound method is
created dynamically. This behaves like a normal Python function when
used as a method: the `self' argument will be inserted as the first
positional argument, even before the `args' and `keywords' supplied to
the @ref{a85,,partialmethod} constructor.

Exemplo:

@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


Adicionado na versão 3.4.

@end deffn

@geindex reduce() (no módulo functools)
@anchor{library/functools functools reduce}@anchor{131f}
@deffn {Função} 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

See @ref{a05,,itertools.accumulate()} for an iterator that yields all intermediate
values.
@end deffn

@geindex singledispatch() (no módulo functools)
@anchor{library/functools functools singledispatch}@anchor{639}
@deffn {Função} @@functools.singledispatch

Transform a function into a @ref{9fa,,single-dispatch} @ref{9f9,,generic function}.

To define a generic function, decorate it with the @code{@@singledispatch}
decorator. When defining a function using @code{@@singledispatch}, note that the
dispatch happens on the type of the first argument:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)
@end example

@geindex register() (método functools.singledispatch)
@anchor{library/functools functools singledispatch register}@anchor{28eb}
To add overloaded implementations to the function, use the @code{register()}
attribute of the generic function, which can be used as a decorator.  For
functions annotated with types, the decorator will infer the type of the
first argument automatically:

@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

@ref{63a,,types.UnionType} and @ref{63b,,typing.Union} can also be used:

@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

For code which doesn’t use type annotations, the appropriate type
argument can be passed explicitly to the decorator itself:

@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

To enable registering @ref{28ec,,lambdas} and pre-existing functions,
the @ref{28eb,,register()} attribute can also be used in a functional form:

@example
>>> def nothing(arg, verbose=False):
...     print("Nothing.")
...
>>> fun.register(type(None), nothing)
@end example

The @ref{28eb,,register()} attribute returns the undecorated function. This
enables decorator stacking, @ref{a6,,pickling}, and the creation
of unit tests for each variant independently:

@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

When called, the generic function dispatches on the type of the first
argument:

@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

Where there is no registered implementation for a specific type, its
method resolution order is used to find a more generic implementation.
The original function decorated with @code{@@singledispatch} is registered
for the base @ref{a96,,object} type, which means it is used if no better
implementation is found.

If an implementation is registered to an @ref{11f5,,abstract base class},
virtual subclasses of the base class will be dispatched to that
implementation:

@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

To check which implementation the generic function will choose for
a given type, use the @code{dispatch()} attribute:

@example
>>> fun.dispatch(float)
<function fun_num at 0x1035a2840>
>>> fun.dispatch(dict)    # note: default implementation
<function fun at 0x103fe0000>
@end example

To access all registered implementations, use the read-only @code{registry}
attribute:

@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


Adicionado na versão 3.4.



Alterado na versão 3.7: The @ref{28eb,,register()} attribute now supports using type annotations.



Alterado na versão 3.11: The @ref{28eb,,register()} attribute now supports @ref{63a,,types.UnionType}
and @ref{63b,,typing.Union} as type annotations.

@end deffn

@geindex singledispatchmethod (classe em functools)
@anchor{library/functools functools singledispatchmethod}@anchor{9f8}
@deffn {Classe} functools.singledispatchmethod (func)

Transform a method into a @ref{9fa,,single-dispatch} @ref{9f9,,generic function}.

To define a generic method, decorate it with the @code{@@singledispatchmethod}
decorator. When defining a method using @code{@@singledispatchmethod}, note
that the dispatch happens on the type of the first non-`self' or non-`cls'
argument:

@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} supports nesting with other decorators such as
@ref{166,,@@classmethod}. Note that to allow for
@code{dispatcher.register}, @code{singledispatchmethod} must be the `outer most'
decorator. Here is the @code{Negator} class with the @code{neg} methods bound to
the class, rather than an instance of the class:

@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

The same pattern can be used for other similar decorators:
@ref{416,,@@staticmethod}, @ref{10c4,,@@~abc.abstractmethod}, and others.


Adicionado na versão 3.8.

@end deffn

@geindex update_wrapper() (no módulo functools)
@anchor{library/functools functools update_wrapper}@anchor{1058}
@deffn {Função} 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{208e,,__module__}, @ref{1317,,__name__},
@ref{208d,,__qualname__}, @ref{1218,,__annotations__},
@ref{2090,,__type_params__}, and @ref{1219,,__doc__}, the
documentation string) and @code{WRAPPER_UPDATES} (which updates the wrapper
function’s @ref{1315,,__dict__}, i.e. the instance dictionary).

To allow access to the original function for introspection and other purposes
(e.g. bypassing a caching decorator such as @ref{9f7,,lru_cache()}), this function
automatically adds a @code{__wrapped__} attribute to the wrapper that refers to
the function being wrapped.

The main intended use for this function is in @ref{731,,decorator} functions which
wrap the decorated function and return the wrapper. If the wrapper function is
not updated, the metadata of the returned function will reflect the wrapper
definition rather than the original function definition, which is typically less
than helpful.

@ref{1058,,update_wrapper()} may be used with callables other than functions. Any
attributes named in `assigned' or `updated' that are missing from the object
being wrapped are ignored (i.e. this function will not attempt to set them
on the wrapper function). @ref{34b,,AttributeError} is still raised if the
wrapper function itself is missing any attributes named in `updated'.


Alterado na versão 3.2: The @code{__wrapped__} attribute is now automatically added.
The @ref{1218,,__annotations__} attribute is now copied by default.
Missing attributes no longer trigger an @ref{34b,,AttributeError}.



Alterado na versão 3.4: The @code{__wrapped__} attribute now always refers to the wrapped
function, even if that function defined a @code{__wrapped__} attribute.
(see bpo-17482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17482})



Alterado na versão 3.12: The @ref{2090,,__type_params__} attribute is now copied by default.

@end deffn

@geindex wraps() (no módulo functools)
@anchor{library/functools functools wraps}@anchor{f91}
@deffn {Função} @@functools.wraps (wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

This is a convenience function for invoking @ref{1058,,update_wrapper()} as a
function decorator when defining a wrapper function.  It is equivalent to
@code{partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)}.
For example:

@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

Without the use of this decorator factory, the name of the example function
would have been @code{'wrapper'}, and the docstring of the original @code{example()}
would have been lost.
@end deffn

@menu
* Objetos partial:: 

@end menu

@node Objetos partial,,,functools — Funções e operações de ordem superior em objetos chamáveis
@anchor{library/functools id1}@anchor{28ed}@anchor{library/functools partial-objects}@anchor{28ea}
@subsubsection Objetos @code{partial}


@ref{414,,partial} objects are callable objects created by @ref{414,,partial()}. They
have three read-only attributes:

@geindex func (atributo functools.partial)
@anchor{library/functools functools partial func}@anchor{28ee}
@deffn {Atributo} partial.func

A callable object or function.  Calls to the @ref{414,,partial} object will be
forwarded to @ref{28ee,,func} with new arguments and keywords.
@end deffn

@geindex args (atributo functools.partial)
@anchor{library/functools functools partial args}@anchor{28ef}
@deffn {Atributo} partial.args

The leftmost positional arguments that will be prepended to the positional
arguments provided to a @ref{414,,partial} object call.
@end deffn

@geindex keywords (atributo functools.partial)
@anchor{library/functools functools partial keywords}@anchor{28f0}
@deffn {Atributo} partial.keywords

The keyword arguments that will be supplied when the @ref{414,,partial} object is
called.
@end deffn

@ref{414,,partial} objects are like @ref{299,,function objects}
in that they are callable, weak referenceable, and can have attributes.
There are some important differences.  For instance, the
@ref{1317,,__name__} and @ref{1219,,function.__doc__} attributes
are not created automatically.  Also, @ref{414,,partial} objects defined in
classes behave like static methods and do not transform into bound methods
during instance attribute look-up.

@node operator — Operadores padrões como funções,,functools — Funções e operações de ordem superior em objetos chamáveis,Módulos de Programação Funcional
@anchor{library/operator doc}@anchor{28f1}@anchor{library/operator module-operator}@anchor{9f}@anchor{library/operator operator-standard-operators-as-functions}@anchor{28f2}@anchor{library/operator translation-repo}@anchor{28f3}
@subsection @code{operator} — Operadores padrões como funções


@geindex module; operator

`Código-fonte:' Lib/operator.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/operator.py}

@c import operator
@c from operator import itemgetter, iadd


__________________________________________________________________


O módulo @ref{9f,,operator} exporta um conjunto de funções eficientes correspondentes aos operadores intrínsecos do Python. Por exemplo, @code{operator.add(x,y)} é equivalente à expressão @code{x+y}. Muitos nomes de função são aqueles usados para métodos especiais, sem os sublinhados duplos. Para compatibilidade com versões anteriores, muitos deles têm uma variante com os sublinhados duplos mantidos. As variantes sem os sublinhados duplos são preferenciais para maior clareza.

As funções se enquadram em categorias que realizam comparações de objetos, operações lógicas, operações matemáticas e operações de sequência.

As funções de comparação de objetos são úteis para todos os objetos e são nomeadas conforme os operadores de comparação que os mesmos suportam:

@geindex lt() (no módulo operator)
@geindex le() (no módulo operator)
@geindex eq() (no módulo operator)
@geindex ne() (no módulo operator)
@geindex ge() (no módulo operator)
@geindex gt() (no módulo operator)
@geindex __lt__() (no módulo operator)
@geindex __le__() (no módulo operator)
@geindex __eq__() (no módulo operator)
@geindex __ne__() (no módulo operator)
@geindex __ge__() (no módulo operator)
@geindex __gt__() (no módulo operator)
@anchor{library/operator operator lt}@anchor{28f4}
@deffn {Função} operator.lt (a, b)
@anchor{library/operator operator le}@anchor{28f5}
@deffnx {Função} operator.le (a, b)
@anchor{library/operator operator eq}@anchor{28f6}
@deffnx {Função} operator.eq (a, b)
@anchor{library/operator operator ne}@anchor{28f7}
@deffnx {Função} operator.ne (a, b)
@anchor{library/operator operator ge}@anchor{28f8}
@deffnx {Função} operator.ge (a, b)
@anchor{library/operator operator gt}@anchor{28f9}
@deffnx {Função} operator.gt (a, b)
@anchor{library/operator operator __lt__}@anchor{28fa}
@deffnx {Função} operator.__lt__ (a, b)
@anchor{library/operator operator __le__}@anchor{28fb}
@deffnx {Função} operator.__le__ (a, b)
@anchor{library/operator operator __eq__}@anchor{28fc}
@deffnx {Função} operator.__eq__ (a, b)
@anchor{library/operator operator __ne__}@anchor{28fd}
@deffnx {Função} operator.__ne__ (a, b)
@anchor{library/operator operator __ge__}@anchor{28fe}
@deffnx {Função} operator.__ge__ (a, b)
@anchor{library/operator operator __gt__}@anchor{28ff}
@deffnx {Função} operator.__gt__ (a, b)

Executam “comparações ricas” entre `a' e `b'. Especialmente, @code{lt(a, b)} é equivalente a @code{a < b}, @code{le(a, b)} é equivalente a @code{a <= b}, @code{eq(a, b)} é equivalente a @code{a == b}, @code{ne(a, b)} é equivalente a @code{a != b}, @code{gt(a, b)} é equivalente a @code{a > b} e @code{ge(a, b)} é equivalente a @code{a >= b}. Observe que essas funções podem retornar qualquer valor, que pode ou não ser interpretável como um valor booleano. Consulte @ref{2205,,Comparações} para obter mais informações sobre comparações ricas.
@end deffn

As operações lógicas também são geralmente aplicáveis a todos os objetos e tem suporte para testes de verdade, testes de identidade e operações booleanas:

@geindex not_() (no módulo operator)
@geindex __not__() (no módulo operator)
@anchor{library/operator operator not_}@anchor{2900}
@deffn {Função} operator.not_ (obj)
@anchor{library/operator operator __not__}@anchor{2901}
@deffnx {Função} operator.__not__ (obj)

Retorna o resultado de @ref{220f,,not} `obj'. (Veja que não existe nenhum método @code{__not__()} para instâncias de objetos; apenas o núcleo do interpretador definirá esta operação. O resultado será afetado pelos métodos @ref{1318,,__bool__()} e @ref{15b4,,__len__()}.)
@end deffn

@geindex truth() (no módulo operator)
@anchor{library/operator operator truth}@anchor{2902}
@deffn {Função} operator.truth (obj)

Retorna @ref{c27,,True} se o `obj' for verdadeiro, e @ref{b49,,False} caso contrário. Isso é equivalente a utilizar a construção @ref{468,,bool}.
@end deffn

@geindex is_() (no módulo operator)
@anchor{library/operator operator is_}@anchor{2903}
@deffn {Função} operator.is_ (a, b)

Retorna @code{a is b}. Testa a identidade do objeto.
@end deffn

@geindex is_not() (no módulo operator)
@anchor{library/operator operator is_not}@anchor{2904}
@deffn {Função} operator.is_not (a, b)

Retorna @code{a is not b}. Testa a identidade do objeto.
@end deffn

As operações matemáticas bit a bit são as mais numerosas:

@geindex abs() (no módulo operator)
@geindex __abs__() (no módulo operator)
@anchor{library/operator operator abs}@anchor{2905}
@deffn {Função} operator.abs (obj)
@anchor{library/operator operator __abs__}@anchor{2906}
@deffnx {Função} operator.__abs__ (obj)

Retorna o valor absoluto de `obj'.
@end deffn

@geindex add() (no módulo operator)
@geindex __add__() (no módulo operator)
@anchor{library/operator operator add}@anchor{2907}
@deffn {Função} operator.add (a, b)
@anchor{library/operator operator __add__}@anchor{2908}
@deffnx {Função} operator.__add__ (a, b)

Retorna @code{a + b}, onde `a' e `b' são números.
@end deffn

@geindex and_() (no módulo operator)
@geindex __and__() (no módulo operator)
@anchor{library/operator operator and_}@anchor{2909}
@deffn {Função} operator.and_ (a, b)
@anchor{library/operator operator __and__}@anchor{290a}
@deffnx {Função} operator.__and__ (a, b)

Retorna bit a bit de `a' e `b'.
@end deffn

@geindex floordiv() (no módulo operator)
@geindex __floordiv__() (no módulo operator)
@anchor{library/operator operator floordiv}@anchor{290b}
@deffn {Função} operator.floordiv (a, b)
@anchor{library/operator operator __floordiv__}@anchor{290c}
@deffnx {Função} operator.__floordiv__ (a, b)

Retorna @code{a // b}.
@end deffn

@geindex index() (no módulo operator)
@geindex __index__() (no módulo operator)
@anchor{library/operator operator index}@anchor{1a5e}
@deffn {Função} operator.index (a)
@anchor{library/operator operator __index__}@anchor{290d}
@deffnx {Função} operator.__index__ (a)

Retorna `a' convertendo para um inteiro. Equivalente a @code{a.__index__()}.


Alterado na versão 3.10: O resultado sempre tem o tipo exato @ref{257,,int}. Anteriormente, o resultado poderia ter sido uma instância de uma subclasse de @code{int}.

@end deffn

@geindex inv() (no módulo operator)
@geindex invert() (no módulo operator)
@geindex __inv__() (no módulo operator)
@geindex __invert__() (no módulo operator)
@anchor{library/operator operator inv}@anchor{290e}
@deffn {Função} operator.inv (obj)
@anchor{library/operator operator invert}@anchor{290f}
@deffnx {Função} operator.invert (obj)
@anchor{library/operator operator __inv__}@anchor{2910}
@deffnx {Função} operator.__inv__ (obj)
@anchor{library/operator operator __invert__}@anchor{2911}
@deffnx {Função} operator.__invert__ (obj)

Retorna o inverso bit a bit do número `obj'. Isso equivale a @code{~obj}.
@end deffn

@geindex lshift() (no módulo operator)
@geindex __lshift__() (no módulo operator)
@anchor{library/operator operator lshift}@anchor{2912}
@deffn {Função} operator.lshift (a, b)
@anchor{library/operator operator __lshift__}@anchor{2913}
@deffnx {Função} operator.__lshift__ (a, b)

Retorna `a' deslocado para a esquerda por `b'.
@end deffn

@geindex mod() (no módulo operator)
@geindex __mod__() (no módulo operator)
@anchor{library/operator operator mod}@anchor{2914}
@deffn {Função} operator.mod (a, b)
@anchor{library/operator operator __mod__}@anchor{2915}
@deffnx {Função} operator.__mod__ (a, b)

Retorna @code{a % b}.
@end deffn

@geindex mul() (no módulo operator)
@geindex __mul__() (no módulo operator)
@anchor{library/operator operator mul}@anchor{28e2}
@deffn {Função} operator.mul (a, b)
@anchor{library/operator operator __mul__}@anchor{2916}
@deffnx {Função} operator.__mul__ (a, b)

Retorna @code{a * b}, onde `a' e `b' são números.
@end deffn

@geindex matmul() (no módulo operator)
@geindex __matmul__() (no módulo operator)
@anchor{library/operator operator matmul}@anchor{e62}
@deffn {Função} operator.matmul (a, b)
@anchor{library/operator operator __matmul__}@anchor{2917}
@deffnx {Função} operator.__matmul__ (a, b)

Retorna @code{a @@ b}.


Adicionado na versão 3.5.

@end deffn

@geindex neg() (no módulo operator)
@geindex __neg__() (no módulo operator)
@anchor{library/operator operator neg}@anchor{2918}
@deffn {Função} operator.neg (obj)
@anchor{library/operator operator __neg__}@anchor{2919}
@deffnx {Função} operator.__neg__ (obj)

Retorna `obj' negado (@code{-obj}).
@end deffn

@geindex or_() (no módulo operator)
@geindex __or__() (no módulo operator)
@anchor{library/operator operator or_}@anchor{291a}
@deffn {Função} operator.or_ (a, b)
@anchor{library/operator operator __or__}@anchor{291b}
@deffnx {Função} operator.__or__ (a, b)

Retorna bit a bit de `a' e `b'.
@end deffn

@geindex pos() (no módulo operator)
@geindex __pos__() (no módulo operator)
@anchor{library/operator operator pos}@anchor{291c}
@deffn {Função} operator.pos (obj)
@anchor{library/operator operator __pos__}@anchor{291d}
@deffnx {Função} operator.__pos__ (obj)

Retorna `obj' positivo (@code{+obj}).
@end deffn

@geindex pow() (no módulo operator)
@geindex __pow__() (no módulo operator)
@anchor{library/operator operator pow}@anchor{291e}
@deffn {Função} operator.pow (a, b)
@anchor{library/operator operator __pow__}@anchor{291f}
@deffnx {Função} operator.__pow__ (a, b)

Retorna @code{a ** b}, onde `a' e `b' são números.
@end deffn

@geindex rshift() (no módulo operator)
@geindex __rshift__() (no módulo operator)
@anchor{library/operator operator rshift}@anchor{2920}
@deffn {Função} operator.rshift (a, b)
@anchor{library/operator operator __rshift__}@anchor{2921}
@deffnx {Função} operator.__rshift__ (a, b)

Retorna `a' deslocado para a direita por `b'.
@end deffn

@geindex sub() (no módulo operator)
@geindex __sub__() (no módulo operator)
@anchor{library/operator operator sub}@anchor{2922}
@deffn {Função} operator.sub (a, b)
@anchor{library/operator operator __sub__}@anchor{2923}
@deffnx {Função} operator.__sub__ (a, b)

Retorna @code{a - b}.
@end deffn

@geindex truediv() (no módulo operator)
@geindex __truediv__() (no módulo operator)
@anchor{library/operator operator truediv}@anchor{2924}
@deffn {Função} operator.truediv (a, b)
@anchor{library/operator operator __truediv__}@anchor{2925}
@deffnx {Função} operator.__truediv__ (a, b)

Retorna @code{a / b} onde 2/3 é .66 em vez de 0. Isso também é conhecido como divisão “verdadeira”.
@end deffn

@geindex xor() (no módulo operator)
@geindex __xor__() (no módulo operator)
@anchor{library/operator operator xor}@anchor{2926}
@deffn {Função} operator.xor (a, b)
@anchor{library/operator operator __xor__}@anchor{2927}
@deffnx {Função} operator.__xor__ (a, b)

Retorna o OU exclusivo bit a bit de `a' e `b'.
@end deffn

Operações que funcionam com sequências (algumas delas com mapas também) incluem:

@geindex concat() (no módulo operator)
@geindex __concat__() (no módulo operator)
@anchor{library/operator operator concat}@anchor{2928}
@deffn {Função} operator.concat (a, b)
@anchor{library/operator operator __concat__}@anchor{2929}
@deffnx {Função} operator.__concat__ (a, b)

Retorna @code{a + b} para as sequências `a' e `b'.
@end deffn

@geindex contains() (no módulo operator)
@geindex __contains__() (no módulo operator)
@anchor{library/operator operator contains}@anchor{8e0}
@deffn {Função} operator.contains (a, b)
@anchor{library/operator operator __contains__}@anchor{292a}
@deffnx {Função} operator.__contains__ (a, b)

Retorna o resultado do teste @code{b in a}. Observe os operandos invertidos.
@end deffn

@geindex countOf() (no módulo operator)
@anchor{library/operator operator countOf}@anchor{8e2}
@deffn {Função} operator.countOf (a, b)

Retorna o número de ocorrências de `b' em `a'.
@end deffn

@geindex delitem() (no módulo operator)
@geindex __delitem__() (no módulo operator)
@anchor{library/operator operator delitem}@anchor{292b}
@deffn {Função} operator.delitem (a, b)
@anchor{library/operator operator __delitem__}@anchor{292c}
@deffnx {Função} operator.__delitem__ (a, b)

Remove de `a' o valor no índice `b'.
@end deffn

@geindex getitem() (no módulo operator)
@geindex __getitem__() (no módulo operator)
@anchor{library/operator operator getitem}@anchor{292d}
@deffn {Função} operator.getitem (a, b)
@anchor{library/operator operator __getitem__}@anchor{292e}
@deffnx {Função} operator.__getitem__ (a, b)

Retorna de `a' o valor no índice `b'.
@end deffn

@geindex indexOf() (no módulo operator)
@anchor{library/operator operator indexOf}@anchor{8e1}
@deffn {Função} operator.indexOf (a, b)

Retorna o índice da primeira ocorrência de `b' em `a'.
@end deffn

@geindex setitem() (no módulo operator)
@geindex __setitem__() (no módulo operator)
@anchor{library/operator operator setitem}@anchor{292f}
@deffn {Função} operator.setitem (a, b, c)
@anchor{library/operator operator __setitem__}@anchor{2930}
@deffnx {Função} operator.__setitem__ (a, b, c)

Define em `a' o valor no índice `b' para `c'.
@end deffn

@geindex length_hint() (no módulo operator)
@anchor{library/operator operator length_hint}@anchor{fa1}
@deffn {Função} operator.length_hint (obj, default=0)

Retorna um comprimento estimado para o objeto `obj'. Primeiro tenta retornar o seu comprimento real, em seguida, uma estimativa utilizando @ref{f3d,,object.__length_hint__()}, e finalmente retorna o valor padrão.


Adicionado na versão 3.4.

@end deffn

Os operadores seguintes funcionam com chamáveis:

@geindex call() (no módulo operator)
@geindex __call__() (no módulo operator)
@anchor{library/operator operator call}@anchor{19ab}
@deffn {Função} operator.call (obj, /, *args, **kwargs)
@anchor{library/operator operator __call__}@anchor{2931}
@deffnx {Função} operator.__call__ (obj, /, *args, **kwargs)

Retorna @code{obj(*args, **kwargs)}.


Adicionado na versão 3.11.

@end deffn

O módulo @ref{9f,,operator} também define ferramentas para procura de itens e atributos generalizados. Estes são úteis para fazer extração de campo rapidamente como argumentos para as funções @ref{867,,map()}, @ref{be7,,sorted()}, @ref{28dd,,itertools.groupby()}, ou outra função que espera uma função como argumento.

@geindex attrgetter() (no módulo operator)
@anchor{library/operator operator attrgetter}@anchor{e60}
@deffn {Função} operator.attrgetter (attr)

@deffnx {Função} operator.attrgetter (*attrs)

Retorna um objeto chamável que pode buscar o `attr' do seu operando. Caso seja solicitado mais de um atributo, retorna uma tupla de atributos. Os nomes dos atributos também podem conter pontos. Por exemplo:


@itemize *

@item 
Depois de @code{f = attrgetter('name')}, a chamada a @code{f(b)} retorna @code{b.name}.

@item 
Depois de @code{f = attrgetter('name', 'date')}, a chamada a @code{f(b)} retorna @code{(b.name, b.date)}.

@item 
Depois de @code{f = attrgetter('name.first', 'name.last')}, a chamada a @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() (no módulo operator)
@anchor{library/operator operator itemgetter}@anchor{a6b}
@deffn {Função} operator.itemgetter (item)

@deffnx {Função} operator.itemgetter (*items)

Retorna um objeto chamável que busca `item' de seu operando usando o método @ref{283,,__getitem__()} do operando.  Se vários itens forem especificados, retorna um tupla de valores de pesquisa. Por exemplo:


@itemize *

@item 
Depois de @code{f = itemgetter(2)}, a chamada a @code{f(r)} retorna @code{r[2]}.

@item 
Depois de @code{g = itemgetter(2, 5, 3)}, a chamada a @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

Os itens podem ser de qualquer tipo aceito pelo método @ref{283,,__getitem__()} do operando.  Dicionários aceitam qualquer valor @ref{610,,hasheável} . Listas, tuplas e strings aceitam um índice ou um fatiamento:

@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

Exemplo de uso @ref{a6b,,itemgetter()} para recuperar campos específicos de um registro de 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() (no módulo operator)
@anchor{library/operator operator methodcaller}@anchor{e61}
@deffn {Função} operator.methodcaller (name, /, *args, **kwargs)

Retorna um objeto chamável que invoca o método `name' em seu operando. Se argumentos adicionais e/ou argumentos nomeados forem fornecidos, os mesmos serão passados para o método. Por exemplo:


@itemize *

@item 
Depois de @code{f = methodcaller('name')}, a chamada a @code{f(b)} retorna @code{b.name()}.

@item 
Depois de @code{f = methodcaller('name', 'foo', bar=1)}, a chamada @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
* Mapeando os operadores para suas respectivas funções:: 
* Operadores in-place:: 

@end menu

@node Mapeando os operadores para suas respectivas funções,Operadores in-place,,operator — Operadores padrões como funções
@anchor{library/operator mapping-operators-to-functions}@anchor{2932}@anchor{library/operator operator-map}@anchor{2933}
@subsubsection Mapeando os operadores para suas respectivas funções


Esta tabela mostra como as operações abstratas correspondem aos símbolos do operador na sintaxe Python e às funções no módulo @ref{9f,,operator}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Operação

@tab

Sintaxe

@tab

Função

@item

Adição

@tab

@code{a + b}

@tab

@code{add(a, b)}

@item

Concatenação

@tab

@code{seq1 + seq2}

@tab

@code{concat(seq1, seq2)}

@item

Teste de pertinência

@tab

@code{obj in seq}

@tab

@code{contains(seq, obj)}

@item

Divisão

@tab

@code{a / b}

@tab

@code{truediv(a, b)}

@item

Divisão

@tab

@code{a // b}

@tab

@code{floordiv(a, b)}

@item

E bit a bit

@tab

@code{a & b}

@tab

@code{and_(a, b)}

@item

Ou exclusivo bit a bit

@tab

@code{a ^ b}

@tab

@code{xor(a, b)}

@item

Inversão bit a bit

@tab

@code{~ a}

@tab

@code{invert(a)}

@item

Ou bit a bit

@tab

@code{a | b}

@tab

@code{or_(a, b)}

@item

Exponenciação

@tab

@code{a ** b}

@tab

@code{pow(a, b)}

@item

Identidade

@tab

@code{a is b}

@tab

@code{is_(a, b)}

@item

Identidade

@tab

@code{a is not b}

@tab

@code{is_not(a, b)}

@item

Atribuição Indexada

@tab

@code{obj[k] = v}

@tab

@code{setitem(obj, k, v)}

@item

Eliminação indexada

@tab

@code{del obj[k]}

@tab

@code{delitem(obj, k)}

@item

Indexação

@tab

@code{obj[k]}

@tab

@code{getitem(obj, k)}

@item

Deslocamento à esquerda

@tab

@code{a << b}

@tab

@code{lshift(a, b)}

@item

Módulo

@tab

@code{a % b}

@tab

@code{mod(a, b)}

@item

Multiplicação

@tab

@code{a * b}

@tab

@code{mul(a, b)}

@item

Multiplicação de matrizes

@tab

@code{a @@ b}

@tab

@code{matmul(a, b)}

@item

Negação (aritmética)

@tab

@code{- a}

@tab

@code{neg(a)}

@item

Negação (lógica)

@tab

@code{not a}

@tab

@code{not_(a)}

@item

Positivo

@tab

@code{+ a}

@tab

@code{pos(a)}

@item

Deslocamento à direita

@tab

@code{a >> b}

@tab

@code{rshift(a, b)}

@item

Atribuição de fatia

@tab

@code{seq[i:j] = values}

@tab

@code{setitem(seq, slice(i, j), values)}

@item

Remoção de fatia

@tab

@code{del seq[i:j]}

@tab

@code{delitem(seq, slice(i, j))}

@item

Fatiamento

@tab

@code{seq[i:j]}

@tab

@code{getitem(seq, slice(i, j))}

@item

Formatação de strings

@tab

@code{s % obj}

@tab

@code{mod(s, obj)}

@item

Subtração

@tab

@code{a - b}

@tab

@code{sub(a, b)}

@item

Teste verdadeiro

@tab

@code{obj}

@tab

@code{truth(obj)}

@item

Ordenação

@tab

@code{a < b}

@tab

@code{lt(a, b)}

@item

Ordenação

@tab

@code{a <= b}

@tab

@code{le(a, b)}

@item

Igualdade

@tab

@code{a == b}

@tab

@code{eq(a, b)}

@item

Diferença

@tab

@code{a != b}

@tab

@code{ne(a, b)}

@item

Ordenação

@tab

@code{a >= b}

@tab

@code{ge(a, b)}

@item

Ordenação

@tab

@code{a > b}

@tab

@code{gt(a, b)}

@end multitable


@node Operadores in-place,,Mapeando os operadores para suas respectivas funções,operator — Operadores padrões como funções
@anchor{library/operator in-place-operators}@anchor{2934}
@subsubsection Operadores in-place


Muitas operações possuem uma versão “in-place”. Listadas abaixo, as funções fornecem um acesso mais primitivo aos operadores locais do que a sintaxe usual; por exemplo, a @ref{2935,,instrução} @code{x += y} é equivalente a @code{x = operator.iadd(x, y)}. Outra maneira de colocá-lo é dizendo que @code{z = operator.iadd(x, y)} é equivalente à instrução composta @code{z = x; z += y}.

Nesses exemplos, note que, quando um método in-place é invocado, a computação e a atribuição são realizadas em duas etapas separadas. As funções in-place listadas abaixo apenas fazem o primeiro passo, invocando o método in-place. O segundo passo, a atribuição, não é tratado.

Para os casos imutáveis, como as strings, números e tuplas, o valor atualizado será calculado, mas não será atribuído de volta à variável de entrada:

@example
>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'
@end example

Para alvos mutáveis tal como listas e dicionários, o método in-place vai realizar a atualização, então nenhuma atribuição subsequente é necessária:

@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() (no módulo operator)
@geindex __iadd__() (no módulo operator)
@anchor{library/operator operator iadd}@anchor{2936}
@deffn {Função} operator.iadd (a, b)
@anchor{library/operator operator __iadd__}@anchor{2937}
@deffnx {Função} operator.__iadd__ (a, b)

@code{a = iadd(a, b)} é equivalente a @code{a += b}.
@end deffn

@geindex iand() (no módulo operator)
@geindex __iand__() (no módulo operator)
@anchor{library/operator operator iand}@anchor{2938}
@deffn {Função} operator.iand (a, b)
@anchor{library/operator operator __iand__}@anchor{2939}
@deffnx {Função} operator.__iand__ (a, b)

@code{a = iand(a, b)} é equivalente a @code{a &= b}.
@end deffn

@geindex iconcat() (no módulo operator)
@geindex __iconcat__() (no módulo operator)
@anchor{library/operator operator iconcat}@anchor{293a}
@deffn {Função} operator.iconcat (a, b)
@anchor{library/operator operator __iconcat__}@anchor{293b}
@deffnx {Função} operator.__iconcat__ (a, b)

@code{a = iconcat(a, b)} é equivalente a @code{a += b} onde `a' e `b' são sequências.
@end deffn

@geindex ifloordiv() (no módulo operator)
@geindex __ifloordiv__() (no módulo operator)
@anchor{library/operator operator ifloordiv}@anchor{293c}
@deffn {Função} operator.ifloordiv (a, b)
@anchor{library/operator operator __ifloordiv__}@anchor{293d}
@deffnx {Função} operator.__ifloordiv__ (a, b)

@code{a = ifloordiv(a, b)} é equivalente a @code{a //= b}.
@end deffn

@geindex ilshift() (no módulo operator)
@geindex __ilshift__() (no módulo operator)
@anchor{library/operator operator ilshift}@anchor{293e}
@deffn {Função} operator.ilshift (a, b)
@anchor{library/operator operator __ilshift__}@anchor{293f}
@deffnx {Função} operator.__ilshift__ (a, b)

@code{a = ilshift(a, b)} é equivalente a @code{a <<= b}.
@end deffn

@geindex imod() (no módulo operator)
@geindex __imod__() (no módulo operator)
@anchor{library/operator operator imod}@anchor{2940}
@deffn {Função} operator.imod (a, b)
@anchor{library/operator operator __imod__}@anchor{2941}
@deffnx {Função} operator.__imod__ (a, b)

@code{a = imod(a, b)} é equivalente a @code{a %= b}.
@end deffn

@geindex imul() (no módulo operator)
@geindex __imul__() (no módulo operator)
@anchor{library/operator operator imul}@anchor{2942}
@deffn {Função} operator.imul (a, b)
@anchor{library/operator operator __imul__}@anchor{2943}
@deffnx {Função} operator.__imul__ (a, b)

@code{a = imul(a, b)} é equivalente a @code{a *= b}.
@end deffn

@geindex imatmul() (no módulo operator)
@geindex __imatmul__() (no módulo operator)
@anchor{library/operator operator imatmul}@anchor{e63}
@deffn {Função} operator.imatmul (a, b)
@anchor{library/operator operator __imatmul__}@anchor{2944}
@deffnx {Função} operator.__imatmul__ (a, b)

@code{a = imatmul(a, b)} é equivalente a @code{a @@= b}.


Adicionado na versão 3.5.

@end deffn

@geindex ior() (no módulo operator)
@geindex __ior__() (no módulo operator)
@anchor{library/operator operator ior}@anchor{2945}
@deffn {Função} operator.ior (a, b)
@anchor{library/operator operator __ior__}@anchor{2946}
@deffnx {Função} operator.__ior__ (a, b)

@code{a = ior(a, b)} é equivalente a @code{a |= b}.
@end deffn

@geindex ipow() (no módulo operator)
@geindex __ipow__() (no módulo operator)
@anchor{library/operator operator ipow}@anchor{2947}
@deffn {Função} operator.ipow (a, b)
@anchor{library/operator operator __ipow__}@anchor{2948}
@deffnx {Função} operator.__ipow__ (a, b)

@code{a = ipow(a, b)} é equivalente a @code{a **= b}.
@end deffn

@geindex irshift() (no módulo operator)
@geindex __irshift__() (no módulo operator)
@anchor{library/operator operator irshift}@anchor{2949}
@deffn {Função} operator.irshift (a, b)
@anchor{library/operator operator __irshift__}@anchor{294a}
@deffnx {Função} operator.__irshift__ (a, b)

@code{a = irshift(a, b)} é equivalente a @code{a >>= b}.
@end deffn

@geindex isub() (no módulo operator)
@geindex __isub__() (no módulo operator)
@anchor{library/operator operator isub}@anchor{294b}
@deffn {Função} operator.isub (a, b)
@anchor{library/operator operator __isub__}@anchor{294c}
@deffnx {Função} operator.__isub__ (a, b)

@code{a = isub(a, b)} é equivalente a @code{a -= b}.
@end deffn

@geindex itruediv() (no módulo operator)
@geindex __itruediv__() (no módulo operator)
@anchor{library/operator operator itruediv}@anchor{294d}
@deffn {Função} operator.itruediv (a, b)
@anchor{library/operator operator __itruediv__}@anchor{294e}
@deffnx {Função} operator.__itruediv__ (a, b)

@code{a = itruediv(a, b)} é equivalente a @code{a /= b}.
@end deffn

@geindex ixor() (no módulo operator)
@geindex __ixor__() (no módulo operator)
@anchor{library/operator operator ixor}@anchor{294f}
@deffn {Função} operator.ixor (a, b)
@anchor{library/operator operator __ixor__}@anchor{2950}
@deffnx {Função} operator.__ixor__ (a, b)

@code{a = ixor(a, b)} é equivalente a @code{a ^= b}.
@end deffn

@node Acesso a arquivos e diretórios,Persistência de Dados,Módulos de Programação Funcional,A Biblioteca Padrão do Python
@anchor{library/filesys doc}@anchor{2951}@anchor{library/filesys file-and-directory-access}@anchor{2952}@anchor{library/filesys filesys}@anchor{2953}@anchor{library/filesys translation-repo}@anchor{2954}
@section Acesso a arquivos e diretórios


Os módulos descritos neste capítulo dizem respeito aos arquivos e diretórios no disco. Por exemplo, existem módulos para ler as propriedades dos arquivos, manipular o caminhos de forma multiplataforma e para criar arquivos temporários. A lista completa de módulos neste capítulo é:

@menu
* pathlib — Caminhos do sistema de arquivos orientados a objetos:: 
* os.path — Manipulações comuns de nomes de caminhos: os path — Manipulações comuns de nomes de caminhos. 
* stat — Interpretando resultados de stat(): stat — Interpretando resultados de stat. 
* filecmp — Comparações de arquivos e diretórios:: 
* tempfile — Generate temporary files and directories:: 
* glob — Expansão de padrão de nome de arquivo no estilo Unix:: 
* fnmatch — Correspondência de padrões de nome de arquivo Unix:: 
* linecache — Acesso aleatório a linhas de texto:: 
* shutil — Operações de arquivo de alto nível:: 

@end menu

@node pathlib — Caminhos do sistema de arquivos orientados a objetos,os path — Manipulações comuns de nomes de caminhos,,Acesso a arquivos e diretórios
@anchor{library/pathlib doc}@anchor{2955}@anchor{library/pathlib module-pathlib}@anchor{a4}@anchor{library/pathlib pathlib-object-oriented-filesystem-paths}@anchor{2956}
@subsection @code{pathlib} — Caminhos do sistema de arquivos orientados a objetos


@geindex module; pathlib


Adicionado na versão 3.4.


`Código-fonte:' Lib/pathlib/@footnote{https://github.com/python/cpython/tree/3.13/Lib/pathlib/}

@geindex caminho;operações


__________________________________________________________________


Este módulo oferece classes que representam caminhos de sistema de arquivos com semântica apropriada para diferentes sistemas operacionais. As classes de caminho são divididas entre @ref{2957,,caminhos puros}, que fornecem operações puramente computacionais sem E/S, e @ref{2958,,caminhos concretos}, que herdam de caminhos puros, mas também fornecem operações de E/S.

@image{python-figures/pathlib-inheritance,,,Diagrama de herança mostrando as classes disponíveis em pathlib. A classe mais básica é PurePath@comma{} que tem três subclasses diretas: PurePosixPath@comma{} PureWindowsPath e Path. Além dessas quatro classes@comma{} há duas classes que usam herança múltipla: subclasses de PosixPath chamadas PurePosixPath e Path@comma{} e subclasses de WindowsPath chamadas PureWindowsPath e Path.,png}

Se você nunca usou este módulo antes ou apenas não tem certeza de qual classe é a certa para sua tarefa, provavelmente @ref{229,,Path} é o que você precisa. Esta classe instancia um @ref{2958,,caminho concreto} para a plataforma em que o código está sendo executado.

Caminhos puros são úteis em alguns casos especiais. Por exemplo:


@enumerate 

@item 
Se você deseja manipular os caminhos do Windows em uma máquina Unix (ou vice-versa). Você não pode instanciar @ref{2959,,WindowsPath} quando está no Unix, mas você pode instanciar @ref{17f7,,PureWindowsPath}.

@item 
Você quer ter certeza de que seu código apenas manipula caminhos, sem realmente acessar o sistema operacional. Nesse caso, instanciar uma das classes puras pode ser útil, pois elas simplesmente não têm nenhuma operação de acesso ao sistema operacional.
@end enumerate


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/}: O módulo pathlib – caminhos de sistema de arquivos orientados a objetos.



@subsubheading Ver também


Para manipulação de caminho de baixo nível em strings, você também pode usar o módulo @ref{a2,,os.path}.


@menu
* Uso básico:: 
* Exceções: Exceções<6>. 
* Caminhos puros:: 
* Caminhos concretos:: 
* Linguagem de padrões:: 
* Comparação com o módulo glob:: 
* Comparação com os módulos os e os.path: Comparação com os módulos os e os path. 

@end menu

@node Uso básico,Exceções<6>,,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib basic-use}@anchor{295a}
@subsubsection Uso básico


Importando a classe principal:

@example
>>> from pathlib import Path
@end example

Listando os subdiretórios:

@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

Listando os arquivos fontes do Python e sua árvore de diretórios:

@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

Navegando dentro da árvore de diretórios:

@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

Consultando as propriedades do path:

@example
>>> q.exists()
True
>>> q.is_dir()
False
@end example

Abrindo um arquivo:

@example
>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'
@end example

@node Exceções<6>,Caminhos puros,Uso básico,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib exceptions}@anchor{295b}
@subsubsection Exceções


@geindex UnsupportedOperation
@anchor{library/pathlib pathlib UnsupportedOperation}@anchor{227}
@deffn {Exceção} pathlib.UnsupportedOperation

Uma exceção herdada de @ref{228,,NotImplementedError} que é levantada quando uma operação não suportada é chamada em um objeto caminho.


Adicionado na versão 3.13.

@end deffn

@node Caminhos puros,Caminhos concretos,Exceções<6>,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib id1}@anchor{295c}@anchor{library/pathlib pure-paths}@anchor{2957}
@subsubsection Caminhos puros


Objetos de caminho puro fornecem operações de manipulação de caminho que, na verdade, não acessam um sistema de arquivos. Existem três maneiras de acessar essas classes, que também chamamos de `sabores':

@geindex PurePath (classe em pathlib)
@anchor{library/pathlib pathlib PurePath}@anchor{4a6}
@deffn {Classe} pathlib.PurePath (*pathsegments)

Uma classe genérica que representa o tipo de caminho do sistema (ao instanciá-la, cria-se uma @ref{295d,,PurePosixPath} ou uma @ref{17f7,,PureWindowsPath}):

@example
>>> PurePath('setup.py')      # Executando em uma máquina Unix
PurePosixPath('setup.py')
@end example

Cada elemento de `pathsegments' pode ser uma string representando um segmento de caminho, um objeto que implementa a interface  que retorna uma string ou um objeto implementando a interface @ref{c6c,,os.PathLike}, onde o método @ref{c6d,,__fspath__()} retorna uma string, como outro objeto caminho:

@example
>>> PurePath('foo', 'algum/caminho', 'bar')
PurePosixPath('foo/algum/caminho/bar')
>>> PurePath(Path('foo'), Path('bar'))
PurePosixPath('foo/bar')
@end example

Quando `pathsegments' está vazio, o diretório atual é presumido:

@example
>>> PurePath()
PurePosixPath('.')
@end example

Se um segmento for um caminho absoluto, todos os segmentos anteriores serão ignorados (como @ref{171f,,os.path.join()}):

@example
>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')
@end example

No Windows, a unidade não é redefinida quando um segmento de caminho relativo enraizado (por exemplo, @code{r'\foo'}) é encontrado:

@example
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

Barras espúrias e pontos simples são recolhidos, mas pontos duplos (@code{'..'}) e barras duplas iniciais (@code{'//'}) não são, pois isso mudaria o significado de um caminho por vários motivos (por exemplo, links simbólicos, caminhos 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

(uma abordagem ingênua seria criar @code{PurePosixPath('foo/../bar')} equivalente a @code{PurePosixPath('bar')}, o que é errado se @code{foo} for um link simbólico para outro diretório)

Objetos caminho puro implementam a interface @ref{c6c,,os.PathLike}, permitindo que sejam usados em qualquer lugar em que a interface seja aceita.


Alterado na versão 3.6: Adicionado suporte para a interface @ref{c6c,,os.PathLike}.

@end deffn

@geindex PurePosixPath (classe em pathlib)
@anchor{library/pathlib pathlib PurePosixPath}@anchor{295d}
@deffn {Classe} pathlib.PurePosixPath (*pathsegments)

Uma subclasse de @ref{4a6,,PurePath}, este tipo de caminho representa caminhos de sistema de arquivos não Windows:

@example
>>> PurePosixPath('/etc/hosts')
PurePosixPath('/etc/hosts')
@end example

`pathsegments' é especificado de forma similar para @ref{4a6,,PurePath}.
@end deffn

@geindex PureWindowsPath (classe em pathlib)
@anchor{library/pathlib pathlib PureWindowsPath}@anchor{17f7}
@deffn {Classe} pathlib.PureWindowsPath (*pathsegments)

Uma subclasse de @ref{4a6,,PurePath}, este tipo de caminho representa os caminhos do sistema de arquivos do Windows, incluindo Caminhos UNC@footnote{https://en.wikipedia.org/wiki/Path_(computing)#UNC}:

@example
>>> PureWindowsPath('c:/', 'Users', 'Ximénez')
PureWindowsPath('c:/Users/Ximénez')
>>> PureWindowsPath('//servidor/compartilhamento/arquivo')
PureWindowsPath('//servidor/compartilhamento/arquivo')
@end example

`pathsegments' é especificado de forma similar para @ref{4a6,,PurePath}.
@end deffn

Independentemente do sistema em que você está usando, você pode instanciar todas essas classes, uma vez que elas não fornecem nenhuma operação que faça chamadas de sistema.

@menu
* Propriedades gerais:: 
* Operadores: Operadores<2>. 
* Acessando partes individuais:: 
* Métodos e propriedades:: 

@end menu

@node Propriedades gerais,Operadores<2>,,Caminhos puros
@anchor{library/pathlib general-properties}@anchor{295e}
@subsubsection Propriedades gerais


Os caminhos são imutáveis e @ref{610,,hasheáveis}. Os caminhos do mesmo sabor são comparáveis e ordenáveis. Essas propriedades respeitam a semântica de caixa alta e baixa do sabor:

@example
>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in @{ PureWindowsPath('foo') @}
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True
@end example

Caminhos de um sabor diferente são comparados de forma desigual e não podem ser ordenados:

@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>,Acessando partes individuais,Propriedades gerais,Caminhos puros
@anchor{library/pathlib operators}@anchor{295f}
@subsubsection Operadores


O operador barra ajuda a criar caminhos filhos, como @ref{171f,,os.path.join()}. Se o argumento for um caminho absoluto, o caminho anterior será ignorado. No Windows, a unidade não é redefinida quando o argumento é um caminho relativo enraizado (por exemplo, @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 / '/um_caminho_absoluto'
PurePosixPath('/um_caminho_absoluto')
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

Um objeto de caminho pode ser usado em qualquer lugar em que um objeto implementando @ref{c6c,,os.PathLike} seja aceito:

@example
>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'
@end example

A representação de string de um caminho é o próprio caminho do sistema de arquivos bruto (na forma nativa, por exemplo, com contrabarras no Windows), que você pode passar para qualquer função usando um caminho de arquivo como uma string:

@example
>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'
@end example

Da mesma forma, chamar @ref{1c2,,bytes} em um caminho fornece o caminho do sistema de arquivos bruto como um objeto bytes, codificado por @ref{c70,,os.fsencode()}:

@example
>>> bytes(p)
b'/etc'
@end example

@cartouche
@quotation Nota 
A chamada de @ref{1c2,,bytes} só é recomendada no Unix. No Windows, a forma Unicode é a representação canônica dos caminhos do sistema de arquivos.
@end quotation
@end cartouche

@node Acessando partes individuais,Métodos e propriedades,Operadores<2>,Caminhos puros
@anchor{library/pathlib accessing-individual-parts}@anchor{2960}
@subsubsection Acessando partes individuais


Para acessar as “partes” individuais (componentes) de um caminho, use a seguinte propriedade:

@geindex parts (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parts}@anchor{2961}
@deffn {Atributo} PurePath.parts

Uma tupla que dá acesso aos vários componentes do caminho:

@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

(observe como a unidade e a raiz local são reagrupadas em uma única parte)
@end deffn

@node Métodos e propriedades,,Acessando partes individuais,Caminhos puros
@anchor{library/pathlib methods-and-properties}@anchor{2962}
@subsubsection Métodos e propriedades


@c from pathlib import PurePath, PurePosixPath, PureWindowsPath

Caminhos puros fornecem os seguintes métodos e propriedades:

@geindex parser (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parser}@anchor{22c}
@deffn {Atributo} PurePath.parser

A implementação do módulo @ref{a2,,os.path} usado para análise e junção de caminhos de baixo nível: @code{posixpath} ou @code{ntpath}.


Adicionado na versão 3.13.

@end deffn

@geindex drive (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath drive}@anchor{2963}
@deffn {Atributo} PurePath.drive

Uma string que representa a letra ou nome da unidade, se houver:

@example
>>> PureWindowsPath('c:/Program Files/').drive
'c:'
>>> PureWindowsPath('/Program Files/').drive
'@w{'}
>>> PurePosixPath('/etc').drive
'@w{'}
@end example

Os compartilhamentos UNC também são considerados unidades:

@example
>>> PureWindowsPath('//host/compartilhamento/foo.txt').drive
'\\\\host\\compartilhamento'
@end example
@end deffn

@geindex root (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath root}@anchor{2964}
@deffn {Atributo} PurePath.root

Uma string que representa a raiz (local ou global), se houver:

@example
>>> PureWindowsPath('c:/Program Files/').root
'\\'
>>> PureWindowsPath('c:Program Files/').root
'@w{'}
>>> PurePosixPath('/etc').root
'/'
@end example

Os compartilhamentos UNC sempre têm uma raiz:

@example
>>> PureWindowsPath('//host/compartilhamento').root
'\\'
@end example

Se o caminho começa com mais de duas barras sucessivas, @ref{295d,,PurePosixPath} as recolhe:

@example
>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'
@end example

@cartouche
@quotation Nota 
Este comportamento está em conformidade com o parágrafo 4.11 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11} do `The Open Group Base Specifications Issue 6':

`“Um nome de caminho que começa com duas barras sucessivas pode ser interpretado de maneira definida pela implementação, embora mais de duas barras iniciais devam ser tratadas como uma única barra.”'
@end quotation
@end cartouche
@end deffn

@geindex anchor (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath anchor}@anchor{2965}
@deffn {Atributo} PurePath.anchor

A concatenação da unidade e da raiz:

@example
>>> PureWindowsPath('c:/Program Files/').anchor
'c:\\'
>>> PureWindowsPath('c:Program Files/').anchor
'c:'
>>> PurePosixPath('/etc').anchor
'/'
>>> PureWindowsPath('//host/compartilhamento').anchor
'\\\\host\\compartilhamento\\'
@end example
@end deffn

@geindex parents (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parents}@anchor{823}
@deffn {Atributo} PurePath.parents

Uma sequência imutável que fornece acesso aos ancestrais lógicos do caminho:

@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


Alterado na versão 3.10: A sequência pai agora tem suporte @ref{2313,,fatias} e valores de índice negativos.

@end deffn

@geindex parent (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath parent}@anchor{1821}
@deffn {Atributo} PurePath.parent

O pai lógico do caminho:

@example
>>> p = PurePosixPath('/a/b/c/d')
>>> p.parent
PurePosixPath('/a/b/c')
@end example

Você não pode passar por uma âncora ou caminho vazio:

@example
>>> p = PurePosixPath('/')
>>> p.parent
PurePosixPath('/')
>>> p = PurePosixPath('.')
>>> p.parent
PurePosixPath('.')
@end example

@cartouche
@quotation Nota 
Esta é uma operação puramente lexical, daí o seguinte comportamento:

@example
>>> p = PurePosixPath('foo/..')
>>> p.parent
PurePosixPath('foo')
@end example

Se você deseja percorrer um caminho arbitrário do sistema de arquivos para cima, é recomendável primeiro chamar @ref{17ef,,Path.resolve()} para resolver os links simbólicos e eliminar os componentes @code{".."}.
@end quotation
@end cartouche
@end deffn

@geindex name (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath name}@anchor{2966}
@deffn {Atributo} PurePath.name

Uma string que representa o componente do caminho final, excluindo a unidade e a raiz, se houver:

@example
>>> PurePosixPath('minha/biblioteca/setup.py').name
'setup.py'
@end example

Nomes de unidades UNC não são considerados::

@example
>>> PureWindowsPath('//algum/compartilhamento/setup.py').name
'setup.py'
>>> PureWindowsPath('//algum/compartilhamento').name
'@w{'}
@end example
@end deffn

@geindex suffix (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath suffix}@anchor{2967}
@deffn {Atributo} PurePath.suffix

A última parte separada por pontos do componente final, se houver:

@example
>>> PurePosixPath('minha/biblioteca/setup.py').suffix
'.py'
>>> PurePosixPath('minha/biblioteca.tar.gz').suffix
'.gz'
>>> PurePosixPath('minha/biblioteca').suffix
'@w{'}
@end example

Isso é comumente chamado de extensão de arquivo.
@end deffn

@geindex suffixes (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath suffixes}@anchor{2968}
@deffn {Atributo} PurePath.suffixes

Uma lista dos sufixos do caminho, com frequência chamados de extensões de arquivo:

@example
>>> PurePosixPath('minha/biblioteca.tar.gar').suffixes
['.tar', '.gar']
>>> PurePosixPath('minha/biblioteca.tar.gz').suffixes
['.tar', '.gz']
>>> PurePosixPath('minha/biblioteca').suffixes
[]
@end example
@end deffn

@geindex stem (atributo pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath stem}@anchor{2969}
@deffn {Atributo} PurePath.stem

O componente final do caminho, sem seu sufixo:

@example
>>> PurePosixPath('minha/biblioteca.tar.gz').stem
'library.tar'
>>> PurePosixPath('minha/biblioteca.tar').stem
'library'
>>> PurePosixPath('minha/biblioteca').stem
'library'
@end example
@end deffn

@geindex as_posix() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath as_posix}@anchor{296a}
@deffn {Método} PurePath.as_posix ()

Retorna uma representação de string do caminho com barras (@code{/}):

@example
>>> p = PureWindowsPath('c:\\windows')
>>> str(p)
'c:\\windows'
>>> p.as_posix()
'c:/windows'
@end example
@end deffn

@geindex is_absolute() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_absolute}@anchor{1820}
@deffn {Método} PurePath.is_absolute ()

Retorna se o caminho é absoluto ou não. Um caminho é considerado absoluto se tiver uma raiz e (se o tipo permitir) uma unidade:

@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 pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_relative_to}@anchor{2c9}
@deffn {Método} PurePath.is_relative_to (other)

Retorna se este caminho é ou não relativo a outro caminho, representado por `other'.

@example
>>> p = PurePath('/etc/passwd')
>>> p.is_relative_to('/etc')
True
>>> p.is_relative_to('/usr')
False
@end example

Este método é baseado em string; ele não acessa o sistema de arquivos nem trata segmentos “@code{..}” especialmente. O código a seguir é equivalente:

@example
>>> u = PurePath('/usr')
>>> u == p or u in p.parents
False
@end example


Adicionado na versão 3.9.



Descontinuado desde a versão 3.12, será removido na versão 3.14: A passagem de argumentos adicionais está descontinuada; se fornecidos, eles são unidos com `other'.

@end deffn

@geindex is_reserved() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath is_reserved}@anchor{2a6}
@deffn {Método} PurePath.is_reserved ()

Com @ref{17f7,,PureWindowsPath}, retorna @code{True} se o caminho é considerado reservado no Windows, @code{False} caso contrário. Com @ref{295d,,PurePosixPath}, @code{False} é sempre retornado.


Alterado na versão 3.13: Nomes de caminho do Windows que contêm dois pontos, ou terminam com um ponto ou um espaço, são considerados reservados. Caminhos UNC podem ser reservados.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Este método está descontinuado; use @ref{223,,os.path.isreserved()} para detectar caminhos reservados no Windows.

@end deffn

@geindex joinpath() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath joinpath}@anchor{296b}
@deffn {Método} PurePath.joinpath (*pathsegments)

Chamar este método é equivalente a combinar o caminho com cada um dos `pathsegments' por vez:

@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 pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath full_match}@anchor{22b}
@deffn {Método} PurePath.full_match (pattern, *, case_sensitive=None)

Compara esse caminho com o padrão de estilo glob fornecido. Retorna @code{True} se a correspondência for bem-sucedida, @code{False} caso contrário. Por exemplo:

@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 também


Documentação de @ref{296c,,Linguagem de padrões}.


Tal como acontece com outros métodos, a distinção entre maiúsculas e minúsculas segue os padrões da plataforma:

@example
>>> PurePosixPath('b.py').full_match('*.PY')
False
>>> PureWindowsPath('b.py').full_match('*.PY')
True
@end example

Defina `case_sensitive' como @code{True} ou @code{False} para substituir esse comportamento.


Adicionado na versão 3.13.

@end deffn

@geindex match() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath match}@anchor{4ac}
@deffn {Método} PurePath.match (pattern, *, case_sensitive=None)

Compara esse caminho com o padrão no recursivo de estilo glob fornecido. Retorna @code{True} se a correspondência for bem-sucedida, @code{False} caso contrário.

Este método é semelhante a @ref{22b,,full_match()}, mas padrões vazios não são permitidos (@ref{202,,ValueError} é levantada), o curinga recursivo “@code{**}” não é suportado (ele age como o “@code{*}” não recursivo) e, se um padrão relativo for fornecido, a correspondência será feita da direita:

@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


Alterado na versão 3.12: O parâmetro `pattern' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.12: O parâmetro `case_sensitive' foi adicionado.

@end deffn

@geindex relative_to() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath relative_to}@anchor{2ca}
@deffn {Método} PurePath.relative_to (other, walk_up=False)

Calcula uma versão deste caminho em relação ao caminho representado por `other'. Se for impossível, @ref{202,,ValueError} é levantada:

@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

Quando `walk_up' é falso (o padrão), o caminho deve começar com `other'. Quando o argumento é verdadeiro, entradas @code{..} podem ser adicionadas para formar o caminho relativo. Em todos os outros casos, como os caminhos que fazem referência a unidades diferentes, @ref{202,,ValueError} é levantada.:

@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 Aviso 
Esta função faz parte de @ref{4a6,,PurePath} e funciona com strings. Ela não verifica ou acessa a estrutura do arquivo subjacente. Isso pode impactar a opção `walk_up', pois ela presume que não há links simbólicos presentes no caminho; chame @ref{17ef,,resolve()} primeiro se necessário para resolver links simbólicos.
@end quotation
@end cartouche


Alterado na versão 3.12: O parâmetro `walk_up' foi adicionado (o comportamento antigo é o mesmo de @code{walk_up=False}).



Descontinuado desde a versão 3.12, será removido na versão 3.14: A passagem de argumentos posicionais adicionais está descontinuada; se fornecidos, eles são unidos com `other'.

@end deffn

@geindex with_name() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_name}@anchor{17ea}
@deffn {Método} PurePath.with_name (name)

Retorna um novo caminho com o @ref{2966,,name} alterado. Se o caminho original não tiver um nome, ValueError é levantada:

@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 pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_stem}@anchor{1753}
@deffn {Método} PurePath.with_stem (stem)

Retorna um novo caminho com o @ref{2969,,stem} alterado. Se o caminho original não tiver um nome, ValueError é levantada:

@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


Adicionado na versão 3.9.

@end deffn

@geindex with_suffix() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_suffix}@anchor{1703}
@deffn {Método} PurePath.with_suffix (suffix)

Retorna um novo caminho com o @ref{2967,,suffix} alterado. Se o caminho original não tiver um sufixo, o novo `suffixo' será anexado. Se o `suffix' for uma string vazia, o sufixo original será removido:

@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
@end deffn

@geindex with_segments() (método pathlib.PurePath)
@anchor{library/pathlib pathlib PurePath with_segments}@anchor{4a7}
@deffn {Método} PurePath.with_segments (*pathsegments)

Cria um novo objeto caminho do mesmo tipo combinando os `pathsegments' fornecidos. Este método é chamado sempre que um caminho derivado é criado, como de @ref{1821,,parent} e @ref{2ca,,relative_to()}. Subclasses podem substituir este método para passar informações para caminhos derivados, por exemplo:

@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


Adicionado na versão 3.12.

@end deffn

@node Caminhos concretos,Linguagem de padrões,Caminhos puros,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib concrete-paths}@anchor{2958}@anchor{library/pathlib id2}@anchor{296d}
@subsubsection Caminhos concretos


Caminhos concretos são subclasses das classes de caminho puro. Além das operações fornecidas por este último, eles também fornecem métodos para fazer chamadas de sistema em objetos de caminho. Existem três maneiras de instanciar caminhos concretos:

@geindex Path (classe em pathlib)
@anchor{library/pathlib pathlib Path}@anchor{229}
@deffn {Classe} pathlib.Path (*pathsegments)

Uma subclasse de @ref{4a6,,PurePath}, esta classe representa caminhos concretos do tipo de caminho do sistema (instanciando-o cria uma @ref{296e,,PosixPath} ou uma @ref{2959,,WindowsPath}):

@example
>>> Path('setup.py')
PosixPath('setup.py')
@end example

`pathsegments' é especificado de forma similar para @ref{4a6,,PurePath}.
@end deffn

@geindex PosixPath (classe em pathlib)
@anchor{library/pathlib pathlib PosixPath}@anchor{296e}
@deffn {Classe} pathlib.PosixPath (*pathsegments)

Uma subclasse de @ref{229,,Path} e @ref{295d,,PurePosixPath}, esta classe representa caminhos concretos de sistemas de arquivos não-Windows:

@example
>>> PosixPath('/etc/hosts')
PosixPath('/etc/hosts')
@end example

`pathsegments' é especificado de forma similar para @ref{4a6,,PurePath}.


Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} no Windows. Em versões anteriores, @ref{228,,NotImplementedError} era levantada em vez disso.

@end deffn

@geindex WindowsPath (classe em pathlib)
@anchor{library/pathlib pathlib WindowsPath}@anchor{2959}
@deffn {Classe} pathlib.WindowsPath (*pathsegments)

Uma subclasse de @ref{229,,Path} e @ref{17f7,,PureWindowsPath}, esta classe representa caminhos concretos de sistemas de arquivos do Windows:

@example
>>> WindowsPath('c:/', 'Users', 'Ximénez')
WindowsPath('c:/Users/Ximénez')
@end example

`pathsegments' é especificado de forma similar para @ref{4a6,,PurePath}.


Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} em plataformas não-Windows. Em versões anteriores, @ref{228,,NotImplementedError} era levantada em vez disso.

@end deffn

Você só pode instanciar o tipo de classe que corresponde ao seu sistema (permitir chamadas de sistema em tipos de caminho não compatíveis pode levar a bugs ou falhas em sua aplicação):

@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

Alguns métodos de caminho concretos podem levantar um @ref{417,,OSError} se uma chamada de sistema falhar (por exemplo, porque o caminho não existe).

@menu
* Analisando e gerando URIs:: 
* Expandindo e resolvendo caminhos:: 
* Consultando tipo de arquivo e status:: 
* Lendo e escrevendo arquivos:: 
* Lendo diretórios:: 
* Criando arquivos e diretórios:: 
* Renomeando e excluindo:: 
* Permissões e propriedade:: 

@end menu

@node Analisando e gerando URIs,Expandindo e resolvendo caminhos,,Caminhos concretos
@anchor{library/pathlib parsing-and-generating-uris}@anchor{296f}
@subsubsection Analisando e gerando URIs


Objetos caminho concretos podem ser criados e representados como URIs de ‘file’ em conformidade com 
@geindex RFC; RFC 8089
RFC 8089@footnote{https://datatracker.ietf.org/doc/html/rfc8089.html}.

@cartouche
@quotation Nota 
URIs de arquivos não são portáteis entre máquinas com diferentes @ref{2970,,codificações de sistema de arquivos}.
@end quotation
@end cartouche

@geindex from_uri() (método de classe pathlib.Path)
@anchor{library/pathlib pathlib Path from_uri}@anchor{22a}
@deffn {Método} classmethod Path.from_uri (uri)

Retorna um novo objeto de caminho a partir da análise sintática de um URI ‘file’. Por exemplo:

@example
>>> p = Path.from_uri('file:///etc/hosts')
PosixPath('/etc/hosts')
@end example

No Windows, os caminhos do dispositivo DOS e UNC podem ser analisados a partir de URIs:

@example
>>> p = Path.from_uri('file:///c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file://servidor/compartilhamento')
WindowsPath('//servidor/compartilhamento')
@end example

Várias formas variantes são suportadas:

@example
>>> p = Path.from_uri('file:////servidor/compartilhamento')
WindowsPath('//servidor/compartilhamento')
>>> p = Path.from_uri('file://///servidor/compartilhamento')
WindowsPath('//servidor/compartilhamento')
>>> p = Path.from_uri('file:c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file:/c|/windows')
WindowsPath('c:/windows')
@end example

@ref{202,,ValueError} é levantada se o URI não começar com @code{file:} ou se o caminho analisado não for absoluto.


Adicionado na versão 3.13.

@end deffn

@geindex as_uri() (método pathlib.Path)
@anchor{library/pathlib pathlib Path as_uri}@anchor{2971}
@deffn {Método} Path.as_uri ()

Representa o caminho como um URI ‘file’. @ref{202,,ValueError} é levantada se o caminho não for absoluto.

@example
>>> p = PosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = WindowsPath('c:/Windows')
>>> p.as_uri()
'file:///c:/Windows'
@end example

Por razões históricas, esse método também está disponível em objetos @ref{4a6,,PurePath}. No entanto, seu uso de @ref{c70,,os.fsencode()} o torna estritamente impuro.
@end deffn

@node Expandindo e resolvendo caminhos,Consultando tipo de arquivo e status,Analisando e gerando URIs,Caminhos concretos
@anchor{library/pathlib expanding-and-resolving-paths}@anchor{2972}
@subsubsection Expandindo e resolvendo caminhos


@geindex home() (método de classe pathlib.Path)
@anchor{library/pathlib pathlib Path home}@anchor{e70}
@deffn {Método} classmethod Path.home ()

Retorna um novo objeto caminho representando o diretório pessoal do usuário (conforme retornado por @ref{a1e,,os.path.expanduser()} com a construção @code{~}). Se o diretório pessoal não puder ser resolvido, @ref{195,,RuntimeError} é levantada.

@example
>>> Path.home()
PosixPath('/home/antoine')
@end example


Adicionado na versão 3.5.

@end deffn

@geindex expanduser() (método pathlib.Path)
@anchor{library/pathlib pathlib Path expanduser}@anchor{e6f}
@deffn {Método} Path.expanduser ()

Retorna um novo caminho com as construções @code{~} e @code{~user} expandidas,  como retornado por @ref{a1e,,os.path.expanduser()}. Se um diretório pessoal não puder ser resolvido, @ref{195,,RuntimeError} é levantada.

@example
>>> p = PosixPath('~/filmes/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/filmes/Monty Python')
@end example


Adicionado na versão 3.5.

@end deffn

@geindex cwd() (método de classe pathlib.Path)
@anchor{library/pathlib pathlib Path cwd}@anchor{181f}
@deffn {Método} classmethod Path.cwd ()

Retorna um novo objeto caminho que representa o diretório atual (conforme retornado por @ref{1682,,os.getcwd()}):

@example
>>> Path.cwd()
PosixPath('/home/antoine/pathlib')
@end example
@end deffn

@geindex absolute() (método pathlib.Path)
@anchor{library/pathlib pathlib Path absolute}@anchor{17a2}
@deffn {Método} Path.absolute ()

Torna o caminho absoluto, sem normalização ou resolução de links simbólicos. Retorna um novo objeto de caminho:

@example
>>> p = Path('tests')
>>> p
PosixPath('tests')
>>> p.absolute()
PosixPath('/home/antoine/pathlib/tests')
@end example
@end deffn

@geindex resolve() (método pathlib.Path)
@anchor{library/pathlib pathlib Path resolve}@anchor{17ef}
@deffn {Método} Path.resolve (strict=False)

Torna o caminho absoluto, resolvendo quaisquer links simbólicos. Um novo objeto de caminho é retornado:

@example
>>> p = Path()
>>> p
PosixPath('.')
>>> p.resolve()
PosixPath('/home/antoine/pathlib')
@end example

Componentes “@code{..}” também são eliminados (este é o único método para fazer isso):

@example
>>> p = Path('docs/../setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
@end example

Se um caminho não existe ou um laço de link simbólico é encontrado, e `strict' é @code{True}, @ref{417,,OSError} é levantada. Se `strict' for @code{False}, o caminho será resolvido tanto quanto possível e qualquer resto é anexado sem verificar se existe.


Alterado na versão 3.6: O parâmetro `strict' foi adicionado (comportamento pré-3.6 é estrito).



Alterado na versão 3.13: Os laços em link simbólico são tratados como outros erros: @ref{417,,OSError} é levantada no modo estrito, e nenhuma exceção é levantada no modo não estrito. Em versões anteriores, @ref{195,,RuntimeError} é levantada não importando o valor de `strict'.

@end deffn

@geindex readlink() (método pathlib.Path)
@anchor{library/pathlib pathlib Path readlink}@anchor{925}
@deffn {Método} Path.readlink ()

Retorna o caminho para o qual o link simbólico aponta (conforme retornado por @ref{926,,os.readlink()}):

@example
>>> p = Path('meulink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')
@end example


Adicionado na versão 3.9.



Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} se @ref{926,,os.readlink()} não estiver disponível. Em versões anteriores, @ref{228,,NotImplementedError} era levantada.

@end deffn

@node Consultando tipo de arquivo e status,Lendo e escrevendo arquivos,Expandindo e resolvendo caminhos,Caminhos concretos
@anchor{library/pathlib querying-file-type-and-status}@anchor{2973}
@subsubsection Consultando tipo de arquivo e status



Alterado na versão 3.8: @ref{a20,,exists()}, @ref{230,,is_dir()}, @ref{22f,,is_file()}, @ref{a21,,is_mount()}, @ref{a22,,is_symlink()}, @ref{a23,,is_block_device()}, @ref{a24,,is_char_device()}, @ref{a25,,is_fifo()}, @ref{a26,,is_socket()} agora retornam @code{False} em vez de levantar uma exceção para caminhos que contêm caracteres não representáveis no nível do sistema operacional.


@geindex stat() (método pathlib.Path)
@anchor{library/pathlib pathlib Path stat}@anchor{826}
@deffn {Método} Path.stat (*, follow_symlinks=True)

Retorna um objeto @ref{1509,,os.stat_result} contendo informações sobre este caminho, como @ref{4a0,,os.stat()}. O resultado é consultado em cada chamada para este método.

Este método normalmente segue links simbólicos; para obter estado de um link simbólico, adicione o argumento @code{follow_symlinks=False}, ou use @ref{2974,,lstat()}.

@example
>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554
@end example


Alterado na versão 3.10: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex lstat() (método pathlib.Path)
@anchor{library/pathlib pathlib Path lstat}@anchor{2974}
@deffn {Método} Path.lstat ()

Como @ref{826,,Path.stat()}, mas, se o caminho apontar para um link simbólico, retorna as informações do link simbólico ao invés de seu alvo.
@end deffn

@geindex exists() (método pathlib.Path)
@anchor{library/pathlib pathlib Path exists}@anchor{a20}
@deffn {Método} Path.exists (*, follow_symlinks=True)

Retorna @code{True} se o caminho aponta para um arquivo ou diretório existente.

Este método normalmente segue links simbólicos; para verificar se um link simbólico existe, adicione o argumento @code{follow_symlinks=False}.

@example
>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('arquivoienxistente').exists()
False
@end example


Alterado na versão 3.12: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex is_file() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_file}@anchor{22f}
@deffn {Método} Path.is_file (*, follow_symlinks=True)

Retorna @code{True} se o caminho aponta para um arquivo regular, @code{False} se aponta para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.

Este método normalmente segue links simbólicos; para excluir links simbólicos, adicione o argumento @code{follow_symlinks=False}.


Alterado na versão 3.13: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex is_dir() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_dir}@anchor{230}
@deffn {Método} Path.is_dir (*, follow_symlinks=True)

Retorna @code{True} se o caminho aponta para um diretório, @code{False} se aponta para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.

Este método normalmente segue links simbólicos; para excluir links simbólicos para diretórios, adicione o argumento @code{follow_symlinks=False}.


Alterado na versão 3.13: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex is_symlink() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_symlink}@anchor{a22}
@deffn {Método} Path.is_symlink ()

Retorna @code{True} se o caminho apontar para um link simbólico, @code{False} caso contrário.

@code{False} também é retornado se o caminho não existir; outros erros (como erros de permissão) são propagados.
@end deffn

@geindex is_junction() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_junction}@anchor{4ab}
@deffn {Método} Path.is_junction ()

Retorna @code{True} se o caminho apontar para uma junção, e @code{False} para qualquer outro tipo de arquivo. Atualmente, apenas o Windows dá suporte a junções.


Adicionado na versão 3.12.

@end deffn

@geindex is_mount() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_mount}@anchor{a21}
@deffn {Método} Path.is_mount ()

Retorna @code{True} se o caminho for um `ponto de montagem': um ponto em um sistema de arquivos onde um sistema de arquivos diferente foi montado. No POSIX, a função verifica se o pai do `path', @code{path/..}, está em um dispositivo diferente de `path', ou se @code{path/..} e `path' apontam para o mesmo nó-i no mesmo dispositivo – isso deve detectar pontos de montagem para todas as variantes Unix e POSIX. No Windows, um ponto de montagem é considerado uma raiz de letra de unidade (por exemplo, @code{c:\}), um compartilhamento UNC (por exemplo, @code{\\server\share}) ou um diretório de sistema de arquivos montado.


Adicionado na versão 3.7.



Alterado na versão 3.12: Suporte ao Windows foi adicionado.

@end deffn

@geindex is_socket() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_socket}@anchor{a26}
@deffn {Método} Path.is_socket ()

Retorna @code{True} se o caminho apontar para um soquete Unix (ou um link simbólico apontando para um soquete Unix), @code{False} se apontar para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.
@end deffn

@geindex is_fifo() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_fifo}@anchor{a25}
@deffn {Método} Path.is_fifo ()

Retorna @code{True} se o caminho apontar para um FIFO (ou um link simbólico apontando para um FIFO), @code{False} se apontar para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.
@end deffn

@geindex is_block_device() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_block_device}@anchor{a23}
@deffn {Método} Path.is_block_device ()

Retorna @code{True} se o caminho apontar para um dispositivo de bloco (ou um link simbólico apontando para um dispositivo de bloco), @code{False} se apontar para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.
@end deffn

@geindex is_char_device() (método pathlib.Path)
@anchor{library/pathlib pathlib Path is_char_device}@anchor{a24}
@deffn {Método} Path.is_char_device ()

Retorna @code{True} se o caminho apontar para um dispositivo de caractere (ou um link simbólico apontando para um dispositivo de caractere), @code{False} se apontar para outro tipo de arquivo.

@code{False} também é retornado se o caminho não existir ou se for um link simbólico quebrado; outros erros (como erros de permissão) são propagados.
@end deffn

@geindex samefile() (método pathlib.Path)
@anchor{library/pathlib pathlib Path samefile}@anchor{e6d}
@deffn {Método} Path.samefile (other_path)

Retorna se este path apontar para o mesmo arquivo como `other_path', que pode ser um objeto PATH ou uma String. A semântica é semelhante a função @ref{fa5,,os.path.samefile()} e a função @ref{fa4,,os.path.samestat()}.

Um @ref{417,,OSError} poderá ser levantado caso algum arquivo não puder ser acessado por alguma razão.

@example
>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True
@end example


Adicionado na versão 3.5.

@end deffn

@node Lendo e escrevendo arquivos,Lendo diretórios,Consultando tipo de arquivo e status,Caminhos concretos
@anchor{library/pathlib reading-and-writing-files}@anchor{2975}
@subsubsection Lendo e escrevendo arquivos


@geindex open() (método pathlib.Path)
@anchor{library/pathlib pathlib Path open}@anchor{2976}
@deffn {Método} Path.open (mode='r', buffering=-1, encoding=None, errors=None, newline=None)

Abre o arquivo apontado pelo caminho, como a função embutida @ref{51c,,open()} faz:

@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 pathlib.Path)
@anchor{library/pathlib pathlib Path read_text}@anchor{e72}
@deffn {Método} Path.read_text (encoding=None, errors=None, newline=None)

Retorna o conteúdo decodificado do arquivo apontado como uma string:

@example
>>> p = Path('meu_arquivo_texto')
>>> p.write_text('Conteúdo de arquivo texto')
18
>>> p.read_text()
'Conteúdo de arquivo texto'
@end example

O arquivo é aberto e, então, fechado. Os parâmetros opcionais têm o mesmo significado que em @ref{51c,,open()}.


Adicionado na versão 3.5.



Alterado na versão 3.13: O parâmetro `newline' foi adicionado.

@end deffn

@geindex read_bytes() (método pathlib.Path)
@anchor{library/pathlib pathlib Path read_bytes}@anchor{e74}
@deffn {Método} Path.read_bytes ()

Retorna o conteúdo binário do arquivo apontado como um objeto bytes:

@example
>>> p = Path('meu_arquivo_binário')
>>> p.write_bytes(b'meu_arquivo_binário')
20
>>> p.read_bytes()
b'Binary file contents'
@end example


Adicionado na versão 3.5.

@end deffn

@geindex write_text() (método pathlib.Path)
@anchor{library/pathlib pathlib Path write_text}@anchor{e71}
@deffn {Método} Path.write_text (data, encoding=None, errors=None, newline=None)

Abre o arquivo apontado no modo de texto, escreve `data' e fecha o arquivo:

@example
>>> p = Path('meu_arquivo_texto')
>>> p.write_text('Conteúdo de arquivo texto')
18
>>> p.read_text()
'Conteúdo de arquivo texto'
@end example

Um arquivo existente com o mesmo nome é sobrescrito. Os parâmetros opcionais têm o mesmo significado que em @ref{51c,,open()}.


Adicionado na versão 3.5.



Alterado na versão 3.10: O parâmetro `newline' foi adicionado.

@end deffn

@geindex write_bytes() (método pathlib.Path)
@anchor{library/pathlib pathlib Path write_bytes}@anchor{e73}
@deffn {Método} Path.write_bytes (data)

Abre o arquivo apontado no modo bytes, escreve `data' e fecha o arquivo:

@example
>>> p = Path('meu_arquivo_binário')
>>> p.write_bytes(b'meu_arquivo_binário')
20
>>> p.read_bytes()
b'Binary file contents'
@end example

Um arquivo existente de mesmo nome será substituído.


Adicionado na versão 3.5.

@end deffn

@node Lendo diretórios,Criando arquivos e diretórios,Lendo e escrevendo arquivos,Caminhos concretos
@anchor{library/pathlib reading-directories}@anchor{2977}
@subsubsection Lendo diretórios


@geindex iterdir() (método pathlib.Path)
@anchor{library/pathlib pathlib Path iterdir}@anchor{171d}
@deffn {Método} Path.iterdir ()

Quando o caminho aponta para um diretório, produz objetos caminho do conteúdo do diretório:

@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

Os filhos são gerados em ordem arbitrária e as entradas especiais @code{'.'} e @code{'..'} não são incluídas. Se um arquivo for removido ou adicionado ao diretório após a criação do iterador, não está especificado se um objeto caminho para esse arquivo é incluído.

Se o caminho não for um diretório ou estiver inacessível, @ref{417,,OSError} será levantada.
@end deffn

@geindex glob() (método pathlib.Path)
@anchor{library/pathlib pathlib Path glob}@anchor{22d}
@deffn {Método} Path.glob (pattern, *, case_sensitive=None, recurse_symlinks=False)

Faz o glob do `pattern' relativo fornecido no diretório representado por este caminho, produzindo todos os arquivos correspondentes (de qualquer 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

@cartouche
@quotation Nota 
The paths are returned in no particular order.
If you need a specific order, sort the results.
@end quotation
@end cartouche


@subsubheading Ver também


Documentação de @ref{296c,,Linguagem de padrões}.


Por padrão, ou quando o argumento somente-nomeado `case_sensitive' é definido como @code{None}, esse método corresponde a caminhos usando regras de capitalização específicas da plataforma: normalmente, diferencia maiúsculas de minúsculas no POSIX e não diferencia maiúsculas de minúsculas no Windows. Defina `case_sensitive' como @code{True} ou @code{False} para substituir esse comportamento.

Por padrão, ou quando o argumento somente-nomeado `recurse_symlinks' é definido como @code{False}, este método segue links simbólicos, exceto ao expandir curingas “@code{**}”. Defina `recurse_symlinks' como @code{True} para sempre seguir links simbólicos.

Levanta um @ref{19fa,,evento de auditoria} @code{pathlib.Path.glob} com os argumentos @code{self}, @code{pattern}.


Alterado na versão 3.12: O parâmetro `case_sensitive' foi adicionado.



Alterado na versão 3.13: O parâmetro `recurse_symlinks' foi adicionado.



Alterado na versão 3.13: O parâmetro `pattern' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: Quaisquer exceções @ref{417,,OSError} levantadas pela varredura do sistema de arquivos são suprimidas. Em versões anteriores, tais exceções são suprimidas em muitos casos, mas não em todos.

@end deffn

@geindex rglob() (método pathlib.Path)
@anchor{library/pathlib pathlib Path rglob}@anchor{22e}
@deffn {Método} Path.rglob (pattern, *, case_sensitive=None, recurse_symlinks=False)

Faz um glob no `pattern' relativo dado recursivamente. Isso é como chamar @ref{22d,,Path.glob()} com “@code{**/}” adicionado na frente do `pattern'.

@cartouche
@quotation Nota 
The paths are returned in no particular order.
If you need a specific order, sort the results.
@end quotation
@end cartouche


@subsubheading Ver também


Documentação de @ref{296c,,Linguagem de padrões} e @ref{22d,,Path.glob()}.


Levanta um @ref{19fa,,evento de auditoria} @code{pathlib.Path.rglob} com argumentos @code{self}, @code{pattern}.


Alterado na versão 3.12: O parâmetro `case_sensitive' foi adicionado.



Alterado na versão 3.13: O parâmetro `recurse_symlinks' foi adicionado.



Alterado na versão 3.13: O parâmetro `pattern' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex walk() (método pathlib.Path)
@anchor{library/pathlib pathlib Path walk}@anchor{4a8}
@deffn {Método} Path.walk (top_down=True, on_error=None, follow_symlinks=False)

Gera os nomes de arquivos em uma árvore de diretórios percorrendo a árvore de cima para baixo ou de baixo para cima.

Para cada diretório na árvore de diretórios com raiz em `self' (incluindo `self', mas excluindo ‘.’ e ‘..’), o método produz uma tupla de 3 elementos de @code{(dirpath, dirnames, filenames)}.

`dirpath' é um @ref{229,,Path} para o diretório que está sendo percorrido no momento, `dirnames' é uma lista de strings para os nomes dos subdiretórios em `dirpath' (excluindo @code{'.'} e @code{'..'}), e `filenames' é uma lista de strings para os nomes dos arquivos não diretório em `dirpath'. Para obter um caminho completo (que começa com `self') para um arquivo ou diretório em `dirpath', faça @code{dirpath / name}. Se as listas são ou não classificadas depende do sistema de arquivos.

Se o argumento opcional `top_down' for verdadeiro (que é o padrão), o trio para um diretório é gerado antes dos trios para qualquer um de seus subdiretórios (os diretórios são percorridos de cima para baixo). Se `top_down' for falso, o trio para um diretório é gerado após os trios para todos os seus subdiretórios (os diretórios são percorridos de baixo para cima). Não importa o valor de `top_down', a lista de subdiretórios é recuperada antes que os trios para o diretório e seus subdiretórios sejam percorridos.

Quando `top_down' é verdadeiro, o chamador pode modificar a lista `dirnames' no local (por exemplo, usando @ref{18a7,,del} ou atribuição de fatias), e @ref{4a8,,Path.walk()} só recursivamente nos subdiretórios cujos nomes permanecem em `dirnames'. Isso pode ser usado para podar a pesquisa, ou para impor uma ordem específica de visita, ou mesmo para informar @ref{4a8,,Path.walk()} sobre diretórios que o chamador cria ou renomeia antes de retomar @ref{4a8,,Path.walk()} novamente. Modificar `dirnames' quando `top_down' é false não tem efeito no comportamento de @ref{4a8,,Path.walk()}, pois os diretórios em `dirnames' já foram gerados no momento em que `dirnames' é cedido ao chamador.

Por padrão, os erros de @ref{a68,,os.scandir()} são ignorados. Se o argumento opcional `on_error' for especificado, deve ser um chamável; ela será chamado com um argumento, uma instância da exceção @ref{417,,OSError}. O chamável pode tratar do erro para continuar a caminhada ou levantá-la novamente para parar a caminhada. Observe que o nome do arquivo está disponível como o atributo @code{filename} do objeto de exceção.

Por padrão, @ref{4a8,,Path.walk()} não segue links simbólicos e, em vez disso, os adiciona à lista `filenames'. Defina `follow_symlinks' como true para resolver links simbólicos e colocá-los em `dirnames' e `filenames' conforme apropriado para seus alvos e, consequentemente, visitar diretórios apontados por links simbólicos (quando suportado).

@cartouche
@quotation Nota 
Esteja ciente de que definir `follow_symlinks' como true pode levar a uma recursão infinita se um link apontar para um diretório pai dele mesmo. @ref{4a8,,Path.walk()} não rastreia os diretórios que já visitou.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@ref{4a8,,Path.walk()} presume que os diretórios que percorre não sejam modificados durante a execução. Por exemplo, se um diretório de `dirnames' tiver sido substituído por um link simbólico e `follow_symlinks' for falso, @ref{4a8,,Path.walk()} ainda tentará descer até ele. Para evitar esse comportamento, remova os diretórios de `dirnames' conforme apropriado.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Diferentemente de @ref{4a9,,os.walk()}, @ref{4a8,,Path.walk()} lista links simbólicos para diretórios em `filenames' se `follow_symlinks' for falso.
@end quotation
@end cartouche

Esse exemplo mostra o número de bytes usados por todos os arquivos em cada diretório, ignorando diretórios @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

O próximo exemplo é uma implementação simples de @ref{301,,shutil.rmtree()}. Percorrer a árvore de baixo para cima é essencial, pois @ref{2978,,rmdir()} não permite excluir um diretório antes que ele esteja vazio.

@example
# Exclui tudo o que estiver acessível no diretório "top".
# CUIDADO: Isso é perigoso! Por exemplo, se top == Path('/'),
# todos os seus arquivos poderão ser excluídos.
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


Adicionado na versão 3.12.

@end deffn

@node Criando arquivos e diretórios,Renomeando e excluindo,Lendo diretórios,Caminhos concretos
@anchor{library/pathlib creating-files-and-directories}@anchor{2979}
@subsubsection Criando arquivos e diretórios


@geindex touch() (método pathlib.Path)
@anchor{library/pathlib pathlib Path touch}@anchor{297a}
@deffn {Método} Path.touch (mode=0o666, exist_ok=True)

Cria um arquivo neste caminho especifico. Caso o `modo' for dado, ele será combinado com o valor do processo @code{umask} para determinar o modo de arquivo e as flags de acesso. Se o arquivo já existir, a função será bem-sucedida quando `exist_ok' for verdadeiro (e o tempo de modificação for atualizado para a hora atual), caso contrário a exceção @ref{1056,,FileExistsError} será levantada.


@subsubheading Ver também


Os métodos @ref{2976,,open()}, @ref{e71,,write_text()} e @ref{e73,,write_bytes()} são frequentemente usados para criar arquivos.

@end deffn

@geindex mkdir() (método pathlib.Path)
@anchor{library/pathlib pathlib Path mkdir}@anchor{e6e}
@deffn {Método} Path.mkdir (mode=0o777, parents=False, exist_ok=False)

Cria um novo diretório neste caminho fornecido. Se `mode' for fornecido, ele é combinado com o valor @code{umask} do processo para determinar o modo do arquivo e os sinalizadores de acesso. Se o caminho já existe, @ref{1056,,FileExistsError} é levantada.

Se `parents' for verdadeiro, quaisquer pais ausentes neste caminho serão criados conforme necessário; eles são criados com as permissões padrão sem levar o `mode' em consideração (imitando o comando POSIX @code{mkdir -p}).

Se `parents' for falso (o padrão), um pai ausente levanta @ref{42b,,FileNotFoundError}.

Se `exist_ok' for falso (o padrão), @ref{1056,,FileExistsError} será levantada se o diretório alvo já existir.

Se `exist_ok' for verdadeiro, a exceção @ref{1056,,FileExistsError} não será levantada, a menos que o caminho fornecido já exista no sistema de arquivos e não seja um diretório (mesmo comportamento do comando POSIX @code{mkdir -p}).


Alterado na versão 3.5: O parâmetro `exist_ok' foi adicionado.

@end deffn

@geindex symlink_to() (método pathlib.Path)
@anchor{library/pathlib pathlib Path symlink_to}@anchor{825}
@deffn {Método} Path.symlink_to (target, target_is_directory=False)

Faça desse path um symbolic link apontando para um `target'

No Windows, um link simbólico representa um arquivo ou um diretório e não se transforma no destino dinamicamente. Se o alvo estiver presente, será criado um link simbólico de mesmo tipo. Caso contrário, o link simbólico será criado como um diretório se `target_is_directory' for verdadeiro ou um link simbólico de arquivo (o padrão) caso contrário. Em plataformas não Windows, `target_is_directory' é ignorado.

@example
>>> p = Path('meulink')
>>> 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 
A ordem dos argumentos (link, target) é o inverso da função @ref{1133,,os.symlink()}’s.
@end quotation
@end cartouche


Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} se @ref{1133,,os.symlink()} não estiver disponível. Em versões anteriores, @ref{228,,NotImplementedError} era levantada.

@end deffn

@geindex hardlink_to() (método pathlib.Path)
@anchor{library/pathlib pathlib Path hardlink_to}@anchor{824}
@deffn {Método} Path.hardlink_to (target)

Faz deste caminho um link físico para o mesmo arquivo que `target'.

@cartouche
@quotation Nota 
A ordem dos argumentos (link, target) é o inverso da função @ref{112e,,os.link()}’s.
@end quotation
@end cartouche


Adicionado na versão 3.10.



Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} se @ref{112e,,os.link()} não estiver disponível. Em versões anteriores, @ref{228,,NotImplementedError} era levantada.

@end deffn

@node Renomeando e excluindo,Permissões e propriedade,Criando arquivos e diretórios,Caminhos concretos
@anchor{library/pathlib renaming-and-deleting}@anchor{297b}
@subsubsection Renomeando e excluindo


@geindex rename() (método pathlib.Path)
@anchor{library/pathlib pathlib Path rename}@anchor{297c}
@deffn {Método} Path.rename (target)

Renomeia este arquivo ou diretório para o `target' fornecido e retorna uma nova instância de @code{Path} apontando para `target'. No Unix, se `target' existir e for um arquivo, ele será substituído silenciosamente se o usuário tiver permissão. No Windows, se `target' existir, a exceção @ref{1056,,FileExistsError} será levantada. `target' pode ser uma string ou outro objeto caminho:

@example
>>> p = Path('foo')
>>> p.open('w').write('algum texto')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'algum texto'
@end example

O caminho de destino pode ser absoluto ou relativo. Caminhos relativos são interpretados em relação ao diretório de trabalho atual, `não' ao diretório do objeto @code{Path}.

Está implementada em termos de @ref{1130,,os.rename()} e fornece as mesmas garantias.


Alterado na versão 3.8: Adicionado valor de retorno, retorna a nova instância de @code{Path}.

@end deffn

@geindex replace() (método pathlib.Path)
@anchor{library/pathlib pathlib Path replace}@anchor{297d}
@deffn {Método} Path.replace (target)

Renomeia este arquivo ou diretório para o `target' fornecido e retorna uma nova instância de @code{Path} apontando para `target'. Se `target' apontar para um arquivo ou diretório vazio, ele será substituído incondicionalmente.

O caminho de destino pode ser absoluto ou relativo. Caminhos relativos são interpretados em relação ao diretório de trabalho atual, `não' ao diretório do objeto @code{Path}.


Alterado na versão 3.8: Adicionado valor de retorno, retorna a nova instância de @code{Path}.

@end deffn

@geindex unlink() (método pathlib.Path)
@anchor{library/pathlib pathlib Path unlink}@anchor{1b69}
@deffn {Método} Path.unlink (missing_ok=False)

Remova esse arquivo ou link simbólico. Caso o caminho aponte para um diretório, use a função @ref{2978,,Path.rmdir()} em vez disso.

Se `missing_ok' for falso (o padrão), @ref{42b,,FileNotFoundError} é levantada se o caminho não existir.

Se `missing_ok' for verdadeiro, exceções de @ref{42b,,FileNotFoundError} serão ignoradas (mesmo comportamento que o comando POSIX @code{rm -f}).


Alterado na versão 3.8: O parâmetro `missing_ok' foi adicionado.

@end deffn

@geindex rmdir() (método pathlib.Path)
@anchor{library/pathlib pathlib Path rmdir}@anchor{2978}
@deffn {Método} Path.rmdir ()

Remove este diretório. O diretório deve estar vazio.
@end deffn

@node Permissões e propriedade,,Renomeando e excluindo,Caminhos concretos
@anchor{library/pathlib permissions-and-ownership}@anchor{297e}
@subsubsection Permissões e propriedade


@geindex owner() (método pathlib.Path)
@anchor{library/pathlib pathlib Path owner}@anchor{231}
@deffn {Método} Path.owner (*, follow_symlinks=True)

Retorna o nome do usuário que possui o arquivo. @ref{344,,KeyError} é levantada caso o identificador de usuário (UID) não for encontrado no banco de dados do sistema.

Esse método normalmente segue links simbólicos; para retornar o dono do link simbólico, adicione o argumento @code{follow_symlinks=False}.


Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} se o módulo @ref{b2,,pwd} não estiver disponível. Em versões anteriores, @ref{228,,NotImplementedError} era levantada.



Alterado na versão 3.13: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex group() (método pathlib.Path)
@anchor{library/pathlib pathlib Path group}@anchor{232}
@deffn {Método} Path.group (*, follow_symlinks=True)

Retorna o nome do usuário que possui o grupo. @ref{344,,KeyError} é levantada caso o identificador de grupo (GID) não for encontrado no banco de dados do sistema.

Esse método normalmente segue links simbólicos; para retornar o grupo do link simbólico, adicione o argumento @code{follow_symlinks=False}.


Alterado na versão 3.13: Levanta @ref{227,,UnsupportedOperation} se o módulo @ref{66,,grp} não estiver disponível. Em versões anteriores, @ref{228,,NotImplementedError} era levantada.



Alterado na versão 3.13: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex chmod() (método pathlib.Path)
@anchor{library/pathlib pathlib Path chmod}@anchor{827}
@deffn {Método} Path.chmod (mode, *, follow_symlinks=True)

Altera o modo de arquivo e as permissões, como @ref{21b,,os.chmod()}.

This method normally follows symlinks. Some Unix flavours support changing
permissions on the symlink itself; on these platforms you may add the
argument @code{follow_symlinks=False}, or use @ref{297f,,lchmod()}.

@example
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
@end example


Alterado na versão 3.10: O parâmetro `follow_symlinks' foi adicionado.

@end deffn

@geindex lchmod() (método pathlib.Path)
@anchor{library/pathlib pathlib Path lchmod}@anchor{297f}
@deffn {Método} Path.lchmod (mode)

Como @ref{827,,Path.chmod()}, mas, se o caminho apontar para um link simbólico, o modo do link simbólico é alterado ao invés de seu alvo.
@end deffn

@node Linguagem de padrões,Comparação com o módulo glob,Caminhos concretos,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib pathlib-pattern-language}@anchor{296c}@anchor{library/pathlib pattern-language}@anchor{2980}
@subsubsection Linguagem de padrões


Os seguintes curingas são suportados em padrões para @ref{22b,,full_match()}, @ref{22d,,glob()} e @ref{22e,,rglob()}:


@table @asis

@item @code{**} (todo o segmento)

Corresponde a qualquer número de segmentos de arquivo ou diretório, incluindo zero.

@item @code{*} (todo o segmento)

Corresponde a um segmento de arquivo ou diretório.

@item @code{*} (parte de um segmento)

Corresponde a qualquer número de caracteres não separadores, incluindo zero.

@item @code{?}

Corresponde a um caractere não separador.

@item @code{[seq]}

Corresponde a um caractere em `seq', onde `seq' é uma sequência de caracteres. Expressões de intervalo são suportadas; por exemplo, @code{[a-z]} corresponde a qualquer letra ASCII minúscula. Vários intervalos podem ser combinados: @code{[a-zA-Z0-9_]} corresponde a qualquer letra, dígito ou sublinhado ASCII.

@item @code{[!seq]}

Corresponde a um caractere que não está em `seq', onde `seq' segue as mesmas regras acima.
@end table

Para uma correspondência literal, coloque os metacaracteres entre colchetes. Por exemplo, @code{"[?]"} corresponde ao caractere @code{"?"}.

O curinga “@code{**}” habilita fazer glob recursivo. Alguns exemplos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Padrão

@tab

Significado

@item

“@code{**/*}”

@tab

Qualquer caminho com pelo menos um segmento.

@item

“@code{**/*.py}”

@tab

Qualquer caminho com um segmento final terminando em “@code{.py}”.

@item

“@code{assets/**}”

@tab

Qualquer caminho que comece com “@code{assets/}”.

@item

“@code{assets/**/*}”

@tab

Qualquer caminho que comece com “@code{assets/}”, excluindo o próprio “@code{assets/}”.

@end multitable


@cartouche
@quotation Nota 
Fazer globs com o curinga “@code{**}” visita todos os diretórios da árvore. Árvores de diretórios grandes podem levar muito tempo para serem pesquisadas.
@end quotation
@end cartouche


Alterado na versão 3.13: Fazer glob com um padrão que termina com “@code{**}” retorna arquivos e diretórios. Em versões anteriores, apenas diretórios eram retornados.


Em @ref{22d,,Path.glob()} e @ref{22e,,rglob()}, uma barra final pode ser adicionada ao padrão para corresponder apenas aos diretórios.


Alterado na versão 3.11: Fazer glob com um padrão que termina com um separador de componentes de caminho (@ref{66a,,sep} ou @ref{66b,,altsep}) retorna apenas diretórios.


@node Comparação com o módulo glob,Comparação com os módulos os e os path,Linguagem de padrões,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib comparison-to-the-glob-module}@anchor{2981}
@subsubsection Comparação com o módulo @code{glob}


Os padrões aceitos e os resultados gerados por @ref{22d,,Path.glob()} e @ref{22e,,Path.rglob()} diferem ligeiramente daqueles pelo módulo @ref{64,,glob}:


@enumerate 

@item 
Arquivos que começam com um ponto não são especiais em pathlib. Isso é como passar @code{include_hidden=True} para @ref{29f,,glob.glob()}.

@item 
Os componentes do padrão “@code{**}” são sempre recursivos em pathlib. Isso é como passar @code{recursive=True} para @ref{29f,,glob.glob()}.

@item 
Os componentes do padrão “@code{**}” não seguem links simbólicos por padrão em pathlib. Esse comportamento não tem equivalente em @ref{29f,,glob.glob()}, mas você pode passar @code{recurse_symlinks=True} para @ref{22d,,Path.glob()} para obter um comportamento compatível.

@item 
Como todos os objetos @ref{4a6,,PurePath} e @ref{229,,Path}, os valores retornados de @ref{22d,,Path.glob()} e @ref{22e,,Path.rglob()} não incluem barras finais.

@item 
Os valores retornados de @code{path.glob()} e @code{path.rglob()} do pathlib incluem o `path' como prefixo, diferente dos resultados de @code{glob.glob(root_dir=path)}.

@item 
Os valores retornados de @code{path.glob()} e @code{path.rglob()} do pathlib podem incluir o próprio `path', por exemplo, ao globar “@code{**}”, enquanto os resultados de @code{glob.glob(root_dir=path)} nunca incluem uma string vazia que corresponderia a `path'.
@end enumerate

@node Comparação com os módulos os e os path,,Comparação com o módulo glob,pathlib — Caminhos do sistema de arquivos orientados a objetos
@anchor{library/pathlib comparison-to-the-os-and-os-path-modules}@anchor{2982}
@subsubsection Comparação com os módulos @code{os} e @code{os.path}


pathlib implementa operações de caminho usando os objetos @ref{4a6,,PurePath} e @ref{229,,Path}, e por isso é considerado `orientado a objetos'. Por outro lado, os módulos @ref{a1,,os} e @ref{a2,,os.path} fornecem funções que funcionam com objetos de baixo nível @code{str} e @code{bytes}, o que é uma abordagem mais `procedimental'. Alguns usuários consideram o estilo orientado a objetos mais legível.

Muitas funções em @ref{a1,,os} e @ref{a2,,os.path} oferecem suporte a caminhos @code{bytes} e @ref{1129,,caminhos relativos aos descritores de diretório}. Esses recursos não estão disponíveis em pathlib.

Os tipos @code{str} e @code{bytes} do Python e partes dos módulos @ref{a1,,os} e @ref{a2,,os.path} são escritos em C e são muito rápidos. pathlib é escrito em Python puro e geralmente é mais lento, mas raramente lento o suficiente para fazer diferença.

A normalização de caminho do pathlib é um pouco mais opinativa e consistente do que a do @ref{a2,,os.path}. Por exemplo, enquanto @ref{135f,,os.path.abspath()} elimina segmentos “@code{..}” de um caminho, o que pode alterar seu significado se links simbólicos estiverem envolvidos, @ref{17a2,,Path.absolute()} preserva esses segmentos para maior segurança.

A normalização de caminho do pathlib pode torná-lo inadequado para algumas aplicações:


@enumerate 

@item 
pathlib normaliza @code{Path("minha_pasta/")} para @code{Path("minha_pasta")}, o que altera o significado de um caminho quando fornecido a diversas APIs de sistemas operacionais e utilitários de linha de comando. Especificamente, a ausência de um separador final pode permitir que o caminho seja resolvido como um arquivo ou diretório, em vez de apenas um diretório.

@item 
pathlib normaliza @code{Path("./meu_programa")} para @code{Path("meu_programa")}, o que altera o significado de um caminho quando usado como um caminho de pesquisa executável, como em um shell ou ao gerar um processo filho. Especificamente, a ausência de um separador no caminho pode forçar a busca em 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} em vez do diretório atual.
@end enumerate

Como consequência dessas diferenças, pathlib não é um substituto imediato para @ref{a2,,os.path}.

@menu
* Ferramentas correspondentes:: 

@end menu

@node Ferramentas correspondentes,,,Comparação com os módulos os e os path
@anchor{library/pathlib corresponding-tools}@anchor{2983}
@subsubsection Ferramentas correspondentes


Abaixo está uma tabela mapeando várias funções @ref{a1,,os} a sua @ref{4a6,,PurePath}/@ref{229,,Path} equivalente.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@ref{a1,,os} e @ref{a2,,os.path}

@tab

@ref{a4,,pathlib}

@item

@ref{2984,,os.path.dirname()}

@tab

@ref{1821,,PurePath.parent}

@item

@ref{2985,,os.path.basename()}

@tab

@ref{2966,,PurePath.name}

@item

@ref{2986,,os.path.splitext()}

@tab

@ref{2969,,PurePath.stem}, @ref{2967,,PurePath.suffix}

@item

@ref{171f,,os.path.join()}

@tab

@ref{296b,,PurePath.joinpath()}

@item

@ref{224,,os.path.isabs()}

@tab

@ref{1820,,PurePath.is_absolute()}

@item

@ref{4aa,,os.path.relpath()}

@tab

@ref{2ca,,PurePath.relative_to()} @footnote{
@ref{4aa,,os.path.relpath()} chama @ref{135f,,abspath()} para tornar os caminhos absolutos e remover partes “@code{..}”, enquanto @ref{2ca,,PurePath.relative_to()} é uma operação lexical que levanta @ref{202,,ValueError} quando as âncoras de suas entradas são diferentes (por exemplo, se um caminho for absoluto e o outro relativo).
}

@item

@ref{a1e,,os.path.expanduser()}

@tab

@ref{e6f,,Path.expanduser()} @footnote{
@ref{a1e,,os.path.expanduser()} retorna o caminho inalterado se o diretório inicial não puder ser resolvido, enquanto @ref{e6f,,Path.expanduser()} levanta @ref{195,,RuntimeError}.
}

@item

@ref{225,,os.path.realpath()}

@tab

@ref{17ef,,Path.resolve()}

@item

@ref{135f,,os.path.abspath()}

@tab

@ref{17a2,,Path.absolute()} @footnote{
@ref{135f,,os.path.abspath()} remove componentes “@code{..}” sem resolver links simbólicos, o que pode alterar o significado do caminho, enquanto @ref{17a2,,Path.absolute()} deixa quaisquer componentes “@code{..}” no caminho.
}

@item

@ref{a18,,os.path.exists()}

@tab

@ref{a20,,Path.exists()}

@item

@ref{a1b,,os.path.isfile()}

@tab

@ref{22f,,Path.is_file()}

@item

@ref{a1a,,os.path.isdir()}

@tab

@ref{230,,Path.is_dir()}

@item

@ref{a16,,os.path.islink()}

@tab

@ref{a22,,Path.is_symlink()}

@item

@ref{4a3,,os.path.isjunction()}

@tab

@ref{4ab,,Path.is_junction()}

@item

@ref{a1c,,os.path.ismount()}

@tab

@ref{a21,,Path.is_mount()}

@item

@ref{fa5,,os.path.samefile()}

@tab

@ref{e6d,,Path.samefile()}

@item

@ref{1682,,os.getcwd()}

@tab

@ref{181f,,Path.cwd()}

@item

@ref{4a0,,os.stat()}

@tab

@ref{826,,Path.stat()}

@item

@ref{4a1,,os.lstat()}

@tab

@ref{2974,,Path.lstat()}

@item

@ref{1139,,os.listdir()}

@tab

@ref{171d,,Path.iterdir()}

@item

@ref{4a9,,os.walk()}

@tab

@ref{4a8,,Path.walk()} @footnote{
@ref{4a9,,os.walk()} sempre segue links simbólicos ao categorizar caminhos em `dirnames' e `filenames', enquanto @ref{4a8,,Path.walk()} categoriza todos os links simbólicos em `filenames' quando `follow_symlinks' é falso (o padrão).
}

@item

@ref{21d,,os.mkdir()}, @ref{21e,,os.makedirs()}

@tab

@ref{e6e,,Path.mkdir()}

@item

@ref{112e,,os.link()}

@tab

@ref{824,,Path.hardlink_to()}

@item

@ref{1133,,os.symlink()}

@tab

@ref{825,,Path.symlink_to()}

@item

@ref{926,,os.readlink()}

@tab

@ref{925,,Path.readlink()}

@item

@ref{1130,,os.rename()}

@tab

@ref{297c,,Path.rename()}

@item

@ref{1131,,os.replace()}

@tab

@ref{297d,,Path.replace()}

@item

@ref{112f,,os.remove()}, @ref{1134,,os.unlink()}

@tab

@ref{1b69,,Path.unlink()}

@item

@ref{1132,,os.rmdir()}

@tab

@ref{2978,,Path.rmdir()}

@item

@ref{21b,,os.chmod()}

@tab

@ref{827,,Path.chmod()}

@item

@ref{21a,,os.lchmod()}

@tab

@ref{297f,,Path.lchmod()}

@end multitable


@node os path — Manipulações comuns de nomes de caminhos,stat — Interpretando resultados de stat,pathlib — Caminhos do sistema de arquivos orientados a objetos,Acesso a arquivos e diretórios
@anchor{library/os path doc}@anchor{2987}@anchor{library/os path module-os path}@anchor{a2}@anchor{library/os path os-path-common-pathname-manipulations}@anchor{2988}@anchor{library/os path translation-repo}@anchor{2989}
@subsection @code{os.path} — Manipulações comuns de nomes de caminhos


@geindex module; os.path

`Código-fonte:' Lib/genericpath.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/genericpath.py}, Lib/posixpath.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/posixpath.py} (para POSIX) e Lib/ntpath.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/ntpath.py} (para Windows).

@geindex caminho;operações


__________________________________________________________________


Este módulo implementa algumas funções úteis em nomes de caminho. Para ler ou escrever arquivos veja @ref{51c,,open()}, e para acessar o sistema de arquivos veja o módulo @ref{a1,,os}. Os parâmetros de caminho podem ser passados como strings, ou bytes, ou qualquer objeto que implemente o protocolo @ref{c6c,,os.PathLike}.

Ao contrário de um shell Unix, Python não faz nenhuma expansão `automática' de caminho. Funções como @ref{a1e,,expanduser()} e @ref{1420,,expandvars()} podem ser invocadas explicitamente quando uma aplicação deseja uma expansão de caminho no estilo do shell. (Veja também o módulo @ref{64,,glob}.)


@subsubheading Ver também


O módulo @ref{a4,,pathlib} oferece objetos de caminho de alto nível.


@cartouche
@quotation Nota 
Todas essas funções aceitam apenas bytes ou apenas objetos de string como seus parâmetros. O resultado é um objeto do mesmo tipo, se um caminho ou nome de arquivo for retornado.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Uma vez que diferentes sistemas operacionais têm diferentes convenções de nome de caminho, existem várias versões deste módulo na biblioteca padrão. O módulo @ref{a2,,os.path} é sempre o módulo de caminho adequado para o sistema operacional em que o Python está sendo executado e, portanto, pode ser usado para caminhos locais. No entanto, você também pode importar e usar os módulos individuais se quiser manipular um caminho que esteja `sempre' em um dos diferentes formatos. Todos eles têm a mesma interface:


@itemize *

@item 
@code{posixpath} para caminhos no estilo UNIX

@item 
@code{ntpath} para caminhos do Windows
@end itemize
@end quotation
@end cartouche


Alterado na versão 3.8: @ref{a18,,exists()}, @ref{a19,,lexists()}, @ref{a1a,,isdir()}, @ref{a1b,,isfile()}, @ref{a16,,islink()} e @ref{a1c,,ismount()} agora retornam @code{False} em vez de levantar uma exceção para caminhos que contêm caracteres ou bytes não representáveis no nível de sistema de operacional.


@geindex abspath() (no módulo os.path)
@anchor{library/os path os path abspath}@anchor{135f}
@deffn {Função} os.path.abspath (path)

Return a normalized absolutized version of the pathname `path'. On most
platforms, this is equivalent to calling @code{normpath(join(os.getcwd(), path))}.


@subsubheading Ver também


@ref{171f,,os.path.join()} and @ref{135e,,os.path.normpath()}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex basename() (no módulo os.path)
@anchor{library/os path os path basename}@anchor{2985}
@deffn {Função} os.path.basename (path, /)

Retorna o nome base do caminho `path'. Este é o segundo elemento do par retornado pela passagem de `path' para a função @ref{298a,,split()}. Observe que o resultado desta função é diferente do programa Unix @code{basename}; onde @code{basename} para @code{'/foo/bar/'} retorna @code{'bar'}, a função @ref{2985,,basename()} retorna uma string vazia (@code{'@w{'}}).


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex commonpath() (no módulo os.path)
@anchor{library/os path os path commonpath}@anchor{e6a}
@deffn {Função} os.path.commonpath (paths)

Retorna o subcaminho comum mais longo de cada nome de caminho no iterável `paths'. Levanta @ref{202,,ValueError} se `paths' contiverem nomes de caminho absolutos e relativos, os `paths' estiverem em unidades diferentes ou se `paths' estiverem vazios. Ao contrário de @ref{e6b,,commonprefix()}, retorna um caminho válido.


Adicionado na versão 3.5.



Alterado na versão 3.6: Aceita uma sequência de @ref{2a0,,objetos caminho ou similares}.



Alterado na versão 3.13: Qualquer iterável agora pode ser passado, em vez de apenas sequências.

@end deffn

@geindex commonprefix() (no módulo os.path)
@anchor{library/os path os path commonprefix}@anchor{e6b}
@deffn {Função} os.path.commonprefix (list, /)

Retorna o prefixo de caminho mais longo (obtido caractere por caractere) que é um prefixo de todos os caminhos em `list'. Se `list' estiver vazia, retorna a string vazia (@code{'@w{'}}).

@cartouche
@quotation Nota 
Esta função pode retornar caminhos inválidos porque funciona um caractere por vez. Para obter um caminho válido, consulte @ref{e6a,,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


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex dirname() (no módulo os.path)
@anchor{library/os path os path dirname}@anchor{2984}
@deffn {Função} os.path.dirname (path, /)

Retorna o nome do diretório do nome de caminho `path'. Este é o primeiro elemento do par retornado passando `path' para a função @ref{298a,,split()}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex exists() (no módulo os.path)
@anchor{library/os path os path exists}@anchor{a18}
@deffn {Função} os.path.exists (path)

Retorna @code{True} se `path' se referir a um caminho existente ou um descritor de arquivo aberto. Retorna @code{False} para links simbólicos quebrados. Em algumas plataformas, esta função pode retornar @code{False} se a permissão não for concedida para executar @ref{4a0,,os.stat()} no arquivo solicitado, mesmo se o `path' existir fisicamente.


Alterado na versão 3.3: `path' agora pode ser um inteiro: @code{True} é retornado se for um descritor de arquivo aberto, @code{False} caso contrário.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex lexists() (no módulo os.path)
@anchor{library/os path os path lexists}@anchor{a19}
@deffn {Função} os.path.lexists (path)

Retorna @code{True} se `path' se referir a um caminho existente, incluindo links simbólicos quebrados. Equivalente a @ref{a18,,exists()} em plataformas sem @ref{4a1,,os.lstat()}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex ~ (til);expansão de diretório home

@geindex expanduser() (no módulo os.path)
@anchor{library/os path os path expanduser}@anchor{a1e}
@deffn {Função} os.path.expanduser (path)

No Unix e no Windows, retorna o argumento com um componente inicial de @code{~} ou @code{~user} substituído pelo diretório inicial daquele usuário `user'.

@geindex módulo;pwd

No Unix, um @code{~} no início é substituído pela variável de ambiente 
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME} se estiver definida; caso contrário, o diretório pessoal do usuário atual é procurado no diretório de senha através do módulo embutido @ref{b2,,pwd}. Um @code{~user} no início é procurado diretamente no diretório de senhas.

No Windows, 
@geindex USERPROFILE
@geindex variável de ambiente; USERPROFILE
@code{USERPROFILE} será usada se definida; caso contrário, uma combinação de 
@geindex HOMEPATH
@geindex variável de ambiente; HOMEPATH
@code{HOMEPATH} e 
@geindex HOMEDRIVE
@geindex variável de ambiente; HOMEDRIVE
@code{HOMEDRIVE} será usada. Um @code{~user} inicial é tratado verificando se o último componente do diretório home do usuário atual corresponde a 
@geindex USERNAME
@geindex variável de ambiente; USERNAME
@code{USERNAME}, e substituindo-o se for o caso.

Se a expansão falhar ou se o caminho não começar com um til, o caminho será retornado inalterado.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.8: Não usa mais 
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME} no Windows.

@end deffn

@geindex $ (dólar);expansão de variáveis de ambiente
@geindex % (porcentagem);expansão de variáveis de ambiente (Windows)

@geindex expandvars() (no módulo os.path)
@anchor{library/os path os path expandvars}@anchor{1420}
@deffn {Função} os.path.expandvars (path)

Retorna o argumento com as variáveis de ambiente expandidas. Substrings da forma @code{$name} ou @code{$@{name@}} são substituídas pelo valor da variável de ambiente `name'. Nomes de variáveis malformados e referências a variáveis não existentes permanecem inalterados.

No Windows, expansões @code{%name%} são suportadas juntamente a @code{$name} e @code{$@{name@}}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex getatime() (no módulo os.path)
@anchor{library/os path os path getatime}@anchor{298b}
@deffn {Função} os.path.getatime (path, /)

Retorna a hora do último acesso de `path'. O valor de retorno é um número de ponto flutuante dando o número de segundos desde a Era Unix (veja o módulo @ref{ee,,time}). Levanta @ref{417,,OSError} se o arquivo não existe ou está inacessível.
@end deffn

@geindex getmtime() (no módulo os.path)
@anchor{library/os path os path getmtime}@anchor{298c}
@deffn {Função} os.path.getmtime (path, /)

Retorna a hora da última modificação de `path'. O valor de retorno é um número de ponto flutuante dando o número de segundos desde a Era Unix (veja o módulo @ref{ee,,time}). Levanta @ref{417,,OSError} se o arquivo não existe ou está inacessível.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex getctime() (no módulo os.path)
@anchor{library/os path os path getctime}@anchor{298d}
@deffn {Função} os.path.getctime (path, /)

Retorna o ctime do sistema que, em alguns sistemas (como Unix) é a hora da última alteração de metadados, e, em outros (como Windows), é a hora de criação de `path'. O valor de retorno é um número que fornece o número de segundos desde a Era Unix (veja o módulo @ref{ee,,time}). Levanta @ref{417,,OSError} se o arquivo não existe ou está inacessível.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex getsize() (no módulo os.path)
@anchor{library/os path os path getsize}@anchor{298e}
@deffn {Função} os.path.getsize (path, /)

Retorna o tamanho, em bytes, de `path'. Levanta @ref{417,,OSError} se o arquivo não existe ou está inacessível.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex isabs() (no módulo os.path)
@anchor{library/os path os path isabs}@anchor{224}
@deffn {Função} os.path.isabs (path, /)

Retorna @code{True} se `path' for um nome de caminho absoluto. No Unix, isso significa que começa com uma barra, no Windows começa com duas (contra)barras ou uma letra de unidade, caractere de dois pontos e (contra)barra juntos.


@subsubheading Ver também


@ref{135f,,abspath()}



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: No Windows, retorna @code{False} se o caminho fornecido começar com exatamente uma (contra)barra.

@end deffn

@geindex isfile() (no módulo os.path)
@anchor{library/os path os path isfile}@anchor{a1b}
@deffn {Função} os.path.isfile (path)

Retorna @code{True} se `path' for um arquivo regular @ref{a18,,existente}. Isso segue links simbólicos, então @ref{a16,,islink()} e @ref{a1b,,isfile()} podem ser verdadeiros para o mesmo caminho.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex isdir() (no módulo os.path)
@anchor{library/os path os path isdir}@anchor{a1a}
@deffn {Função} os.path.isdir (path, /)

Retorna @code{True} se `path' for um diretório @ref{a18,,existente}. Isso segue links simbólicos, então @ref{a16,,islink()} e @ref{a1a,,isdir()} podem ser verdadeiros para o mesmo caminho.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex isjunction() (no módulo os.path)
@anchor{library/os path os path isjunction}@anchor{4a3}
@deffn {Função} os.path.isjunction (path)

Retorna @code{True} se `path' se referir a uma entrada de diretório @ref{a19,,existente} que é uma junção. Sempre retorna @code{False} se junções não forem suportados na plataforma atual.


Adicionado na versão 3.12.

@end deffn

@geindex islink() (no módulo os.path)
@anchor{library/os path os path islink}@anchor{a16}
@deffn {Função} os.path.islink (path)

Retorna @code{True} se `path' se referir a uma entrada de diretório @ref{a18,,existente} que é um link simbólico. Sempre @code{False} se links simbólicos não forem suportados pelo tempo de execução Python.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex ismount() (no módulo os.path)
@anchor{library/os path os path ismount}@anchor{a1c}
@deffn {Função} os.path.ismount (path)

Retorna @code{True} se o nome de caminho `path' for um `ponto de montagem': um ponto em um sistema de arquivos onde um sistema de arquivos diferente foi montado. No POSIX, a função verifica se o pai de `path', @code{`path'/..}, está em um dispositivo diferente de `path', ou se @code{`path'/..} e `path' apontam para o mesmo nó-i no mesmo dispositivo – isso deve detectar pontos de montagem para todas as variantes Unix e POSIX. Não é capaz de detectar confiavelmente montagens bind no mesmo sistema de arquivos. Em sistemas Linux, sempre vai retornar @code{True} para subvolumes btrfs, mesmo se eles não forem pontos de montagem. No Windows, uma raiz de letra de unidade e um UNC de compartilhamento são sempre pontos de montagem e, para qualquer outro caminho, @code{GetVolumePathName} é chamado para ver se é diferente do caminho de entrada.


Alterado na versão 3.4: Adicionado suporte para detecção de pontos de montagem não raiz no Windows.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex isdevdrive() (no módulo os.path)
@anchor{library/os path os path isdevdrive}@anchor{1739}
@deffn {Função} os.path.isdevdrive (path)

Retorna @code{True} se o nome do caminho `path' estiver localizado em um Windows Dev Drive. Um Dev Drive é otimizado para cenários de desenvolvedor e oferece desempenho mais rápido para leitura e gravação de arquivos. É recomendado para uso em código-fonte, diretórios de construção temporários, caches de pacotes e outras operações com uso intensivo de ES.

Pode levantar um erro para um caminho inválido, por exemplo, um sem uma unidade reconhecível, mas retorna @code{False} em plataformas que não provêm suporte a Dev Drives. Consulte a documentação do Windows@footnote{https://learn.microsoft.com/windows/dev-drive/} para obter informações sobre como habilitar e criar Dev Drives.


Adicionado na versão 3.12.



Alterado na versão 3.13: A função já está disponível em todas as plataformas, e sempre retornará @code{False} naquelas que não possuem suporte para Dev Drives

@end deffn

@geindex isreserved() (no módulo os.path)
@anchor{library/os path os path isreserved}@anchor{223}
@deffn {Função} os.path.isreserved (path)

Retorna @code{True} se `path' for um caminho reservado no sistema atual.

No Windows, os nomes de arquivos reservados incluem aqueles que terminam com espaço ou ponto; aqueles que contêm dois pontos (ou seja, fluxos de arquivos como “nome:fluxo”), caracteres curinga (ou seja, @code{'*?"<>'}), encadeamento (pipe) ou caracteres de controle ASCII; bem como nomes de dispositivos DOS, como “NUL”, “CON”, “CONIN$”, “CONOUT$”, “AUX”, “PRN”, “COM1” e “LPT1”.

@cartouche
@quotation Nota 
Esta função aproxima regras para caminhos reservados na maioria dos sistemas Windows. Essas regras mudam com o tempo em diversas versões do Windows. Esta função pode ser atualizada em versões futuras do Python à medida que as alterações nas regras se tornarem amplamente disponíveis.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.13.

@end deffn

@geindex join() (no módulo os.path)
@anchor{library/os path os path join}@anchor{171f}
@deffn {Função} 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 Linux, for example:

@example
>>> os.path.join('/home/foo', 'bar')
'/home/foo/bar'
>>> os.path.join('/home/foo', '/home/bar')
'/home/bar'
@end example

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. For
example:

@example
>>> os.path.join('c:\\', 'foo')
'c:\\foo'
>>> os.path.join('c:\\foo', 'd:\\bar')
'd:\\bar'
@end example

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


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `path' e `paths'.

@end deffn

@geindex normcase() (no módulo os.path)
@anchor{library/os path os path normcase}@anchor{298f}
@deffn {Função} os.path.normcase (path, /)

Normaliza o estado de letras maiúsculas/minúsculas de um nome de caminho. No Windows, converte todos os caracteres do nome do caminho em minúsculas e também converte barras normais em barras invertidas. Em outros sistemas operacionais, retorna o caminho inalterado.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex normpath() (no módulo os.path)
@anchor{library/os path os path normpath}@anchor{135e}
@deffn {Função} os.path.normpath (path)

Normaliza um nome de caminho retirando separadores redundantes e referências de nível superior para que @code{A//B}, @code{A/B/}, @code{A/./B} e @code{A/foo/../B} todos se tornem @code{A/B}. Essa manipulação de string pode mudar o significado de um caminho que contém links simbólicos. No Windows, ele converte barras normais em barras invertidas. Para normalizar o estado de letras maiúsculas/minúsculas, use @ref{298f,,normcase()}.

@cartouche
@quotation Nota 
Em sistemas POSIX, de acordo com IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13}, se um nome de caminho começa com exatamente duas barras, o primeiro componente após os caracteres iniciais pode ser interpretado em um forma definida pela implementação, embora mais de dois caracteres iniciais devam ser tratados como um único caractere.
@end quotation
@end cartouche


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex realpath() (no módulo os.path)
@anchor{library/os path os path realpath}@anchor{225}
@deffn {Função} os.path.realpath (path, /, *, strict=False)

Retorna o caminho canônico do nome de arquivo especificado, eliminando quaisquer links simbólicos encontrados no caminho (se forem suportados pelo sistema operacional). No Windows, esta função também resolverá nomes de estilo do MS-DOS (também chamado de 8.3), como @code{C:\\PROGRA~1} para @code{C:\\Program Files}.

Por padrão, o caminho é avaliado até o primeiro componente que não existe, é um laço de link simbólico ou cuja avaliação levanta @ref{417,,OSError}. Todos esses componentes são anexados inalterados à parte existente do caminho.

Alguns erros tratados dessa forma incluem “acesso negado”, “não é um diretório” ou “argumento inválido para função interna”. Assim, o caminho resultante pode estar ausente ou inacessível, ainda pode conter links ou laços e pode passar por diretórios não especificados.

Esse comportamento pode ser modificado por argumentos nomeados:

Se `strict' for @code{True}, o primeiro erro encontrado ao avaliar o caminho será levantado novamente. Em particular, @ref{42b,,FileNotFoundError} é levantada se `path' não existir, ou outro @ref{417,,OSError} se ele estiver inacessível.

Se `strict' for @ref{42a,,os.path.ALLOW_MISSING}, erros diferentes de @ref{42b,,FileNotFoundError} serão levantados novamente (como em @code{strict=True}). Portanto, o caminho retornado não conterá nenhum link simbólico, mas o arquivo nomeado e alguns de seus diretórios pais podem estar ausentes.

@cartouche
@quotation Nota 
Esta função emula o procedimento do sistema operacional para tornar um caminho canônico, que difere ligeiramente entre o Windows e o UNIX  em relação a como links e componentes de caminho subsequentes interagem.

As APIs do sistema operacional tornam os caminhos canônicos conforme necessário, portanto, normalmente não é necessário chamar esta função.
@end quotation
@end cartouche


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.8: Links simbólicos e junções agora são resolvidos no Windows.



Alterado na versão 3.10: O parâmetro `strict' foi adicionado.



Alterado na versão 3.13.4: O valor @ref{42a,,ALLOW_MISSING} para o parâmetro `strict' foi adicionado.

@end deffn

@geindex ALLOW_MISSING (no módulo os.path)
@anchor{library/os path os path ALLOW_MISSING}@anchor{42a}
@deffn {Dado} os.path.ALLOW_MISSING

Valor especial usado para o argumento `strict' em @ref{225,,realpath()}.


Adicionado na versão 3.13.4.

@end deffn

@geindex relpath() (no módulo os.path)
@anchor{library/os path os path relpath}@anchor{4aa}
@deffn {Função} os.path.relpath (path, start=os.curdir)

Retorna um caminho de arquivo relativo a `caminho' do diretório atual ou de um diretório `start' opcional. Este é um cálculo de caminho: o sistema de arquivos não é acessado para confirmar a existência ou natureza de `path' ou `start'. No Windows, @ref{202,,ValueError} é levantada quando `path' e `start' estão em unidades diferentes.

`start' tem como padrão @ref{2990,,os.curdir}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex samefile() (no módulo os.path)
@anchor{library/os path os path samefile}@anchor{fa5}
@deffn {Função} os.path.samefile (path1, path2, /)

Retorna @code{True} se ambos os argumentos de nome de caminho se referem ao mesmo arquivo ou diretório. Isso é determinado pelo número do dispositivo e número do nó-i e levanta uma exceção se uma chamada @ref{4a0,,os.stat()} em qualquer um dos caminhos falhar.


Alterado na versão 3.2: Adicionado suporte ao Windows.



Alterado na versão 3.4: O Windows agora usa a mesma implementação que todas as outras plataformas.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex sameopenfile() (no módulo os.path)
@anchor{library/os path os path sameopenfile}@anchor{2991}
@deffn {Função} os.path.sameopenfile (fp1, fp2)

Retorna @code{True} se os descritores de arquivo `fp1' e `fp2' fazem referência ao mesmo arquivo.


Alterado na versão 3.2: Adicionado suporte ao Windows.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex samestat() (no módulo os.path)
@anchor{library/os path os path samestat}@anchor{fa4}
@deffn {Função} os.path.samestat (stat1, stat2, /)

Retorna @code{True} se as tuplas de estatísticas `stat1' e `stat2' fazem referência ao mesmo arquivo. Essas estruturas podem ter sido retornadas por @ref{db4,,os.fstat()}, @ref{4a1,,os.lstat()} ou @ref{4a0,,os.stat()}. Esta função implementa a comparação subjacente usada por @ref{fa5,,samefile()} e @ref{2991,,sameopenfile()}.


Alterado na versão 3.4: Adicionado suporte ao Windows.

@end deffn

@geindex split() (no módulo os.path)
@anchor{library/os path os path split}@anchor{298a}
@deffn {Função} os.path.split (path, /)

Split the pathname `path' into a pair, @code{(head, tail)} where `tail' is the
last pathname component and `head' is everything leading up to that.  The
`tail' part will never contain a slash; if `path' ends in a slash, `tail'
will be empty.  If there is no slash in `path', `head' will be empty.  If
`path' is empty, both `head' and `tail' are empty.  Trailing slashes are
stripped from `head' unless it is the root (one or more slashes only).  In
all cases, @code{join(head, tail)} returns a path to the same location as `path'
(but the strings may differ).  Also see the functions @ref{171f,,join()},
@ref{2984,,dirname()} and @ref{2985,,basename()}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex splitdrive() (no módulo os.path)
@anchor{library/os path os path splitdrive}@anchor{c0f}
@deffn {Função} os.path.splitdrive (path, /)

Divide o nome do caminho `path' em um par @code{(unidade, rabo)} onde `unidade' é um ponto de montagem ou uma string vazia. Em sistemas que não usam especificações de unidade, `unidade' sempre será a string vazia. Em todos os casos, @code{unidade + rabo} será o mesmo que `path'.

No Windows, divide um nome de caminho em unidade/ponto de compartilhamento UNC e caminho relativo.

Se o caminho contiver uma letra de unidade, a unidade conterá tudo, incluindo os dois pontos:

@example
>>> splitdrive("c:/dir")
("c:", "/dir")
@end example

Se o caminho contiver um caminho UNC, a unidade conterá o nome do host e o compartilhamento:

@example
>>> splitdrive("//host/computador/diretório")
("//host/computador", "/diretório")
@end example


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex splitroot() (no módulo os.path)
@anchor{library/os path os path splitroot}@anchor{4a4}
@deffn {Função} os.path.splitroot (path, /)

Divide o nome de caminho `path' em uma tupla de 3 itens @code{(drive, root, tail)} onde `drive' é um nome de dispositivo ou ponto de montagem, `root' é uma string de separadores após a unidade e `tail' é tudo depois da raiz. Qualquer um desses itens pode ser uma string vazia. Em todos os casos, @code{drive + root + tail} será igual a `path'.

Em sistemas POSIX, `drive' está sempre vazio. A `root' pode estar vazia (se `path' for relativo), uma única barra (se `path' for absoluto) ou duas barras (definidas pela implementação de acordo com IEEE Std 1003.1-2017; 4.13 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13}.) Por exemplo:

@example
>>> splitroot('/home/sam')
('@w{'}, '/', 'home/sam')
>>> splitroot('//home/sam')
('@w{'}, '//', 'home/sam')
>>> splitroot('///home/sam')
('@w{'}, '/', '//home/sam')
@end example

No Windows, `drive' pode estar vazio, ser um nome de letra de unidade, um compartilhamento UNC ou um nome de dispositivo. `root' pode estar vazio, ser uma barra ou uma barra invertida. Por exemplo:

@example
>>> splitroot('C:/Users/Sam')
('C:', '/', 'Users/Sam')
>>> splitroot('//Server/Share/Users/Sam')
('//Server/Share', '/', 'Users/Sam')
@end example


Adicionado na versão 3.12.

@end deffn

@geindex splitext() (no módulo os.path)
@anchor{library/os path os path splitext}@anchor{2986}
@deffn {Função} os.path.splitext (path, /)

Divida o nome do caminho `path' em um par @code{(root, ext)} de modo que @code{root + ext == path}, e a extensão, `ext', esteja vazia ou comece com um ponto e contenha no máximo um período.

Se o caminho não contiver extensão, `ext' será @code{'@w{'}}:

@example
>>> splitext('bar')
('bar', '@w{'})
@end example

Se o caminho contiver uma extensão, `ext' será definido para esta extensão, incluindo o ponto inicial. Observe que os períodos anteriores serão ignorados:

@example
>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
>>> splitext('/foo/bar.exe')
('/foo/bar', '.exe')
@end example

Os períodos iniciais do último componente do caminho são considerados parte da raiz:

@example
>>> splitext('.cshrc')
('.cshrc', '@w{'})
>>> splitext('/foo/....jpg')
('/foo/....jpg', '@w{'})
@end example


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex supports_unicode_filenames (no módulo os.path)
@anchor{library/os path os path supports_unicode_filenames}@anchor{14d6}
@deffn {Dado} os.path.supports_unicode_filenames

@code{True} se strings Unicode arbitrárias podem ser usadas como nomes de arquivo (dentro das limitações impostas pelo sistema de arquivos).
@end deffn

@node stat — Interpretando resultados de stat,filecmp — Comparações de arquivos e diretórios,os path — Manipulações comuns de nomes de caminhos,Acesso a arquivos e diretórios
@anchor{library/stat doc}@anchor{2992}@anchor{library/stat module-stat}@anchor{d1}@anchor{library/stat stat-interpreting-stat-results}@anchor{2993}@anchor{library/stat translation-repo}@anchor{2994}
@subsection @code{stat} — Interpretando resultados de @code{stat()}


@geindex module; stat

`Código-fonte:' Lib/stat.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/stat.py}


__________________________________________________________________


O módulo @ref{d1,,stat} define constantes e funções para interpretar os resultados de @ref{4a0,,os.stat()}, @ref{db4,,os.fstat()} e @ref{4a1,,os.lstat()} (se existirem). Para detalhes completos sobre chamadas @code{stat()}, @code{fstat()} e @code{lstat()}, consulte a documentação do seu sistema.


Alterado na versão 3.4: O módulo stat é apoiado por uma implementação C.


O módulo @ref{d1,,stat} define as seguintes funções para testar tipos de arquivos específicos:

@geindex S_ISDIR() (no módulo stat)
@anchor{library/stat stat S_ISDIR}@anchor{2995}
@deffn {Função} stat.S_ISDIR (mode)

Retorna diferente de zero se o modo for de um diretório.
@end deffn

@geindex S_ISCHR() (no módulo stat)
@anchor{library/stat stat S_ISCHR}@anchor{2996}
@deffn {Função} stat.S_ISCHR (mode)

Retorna diferente de zero se o modo for de um arquivo de dispositivo especial de caractere.
@end deffn

@geindex S_ISBLK() (no módulo stat)
@anchor{library/stat stat S_ISBLK}@anchor{2997}
@deffn {Função} stat.S_ISBLK (mode)

Retorna diferente de zero se o modo for de um arquivo de dispositivo especial de bloco.
@end deffn

@geindex S_ISREG() (no módulo stat)
@anchor{library/stat stat S_ISREG}@anchor{2998}
@deffn {Função} stat.S_ISREG (mode)

Retorna diferente de zero se o modo for de um arquivo regular.
@end deffn

@geindex S_ISFIFO() (no módulo stat)
@anchor{library/stat stat S_ISFIFO}@anchor{2999}
@deffn {Função} stat.S_ISFIFO (mode)

Retorna diferente de zero se o modo for de um FIFO (encadeamento nomeado).
@end deffn

@geindex S_ISLNK() (no módulo stat)
@anchor{library/stat stat S_ISLNK}@anchor{299a}
@deffn {Função} stat.S_ISLNK (mode)

Retorna diferente de zero se o modo for de um link simbólico.
@end deffn

@geindex S_ISSOCK() (no módulo stat)
@anchor{library/stat stat S_ISSOCK}@anchor{299b}
@deffn {Função} stat.S_ISSOCK (mode)

Retorna diferente de zero se o modo for de um soquete.
@end deffn

@geindex S_ISDOOR() (no módulo stat)
@anchor{library/stat stat S_ISDOOR}@anchor{1b3d}
@deffn {Função} stat.S_ISDOOR (mode)

Retorna diferente de zero se o modo for de uma porta.


Adicionado na versão 3.4.

@end deffn

@geindex S_ISPORT() (no módulo stat)
@anchor{library/stat stat S_ISPORT}@anchor{1b3e}
@deffn {Função} stat.S_ISPORT (mode)

Retorna diferente de zero se o modo for de uma porta de eventos.


Adicionado na versão 3.4.

@end deffn

@geindex S_ISWHT() (no módulo stat)
@anchor{library/stat stat S_ISWHT}@anchor{1b3f}
@deffn {Função} stat.S_ISWHT (mode)

Retorna diferente de zero se o modo for de um apagamento.


Adicionado na versão 3.4.

@end deffn

Duas funções adicionais são definidas para manipulação mais geral do modo do arquivo:

@geindex S_IMODE() (no módulo stat)
@anchor{library/stat stat S_IMODE}@anchor{299c}
@deffn {Função} stat.S_IMODE (mode)

Retorna a parte do modo do arquivo que pode ser definido por @ref{21b,,os.chmod()} — ou seja, os bits de permissão do arquivo, mais os bits sticky bit, set-group-id e set-user-id (em sistemas que têm suporte a eles).
@end deffn

@geindex S_IFMT() (no módulo stat)
@anchor{library/stat stat S_IFMT}@anchor{299d}
@deffn {Função} stat.S_IFMT (mode)

Retorna a parte do modo do arquivo que descreve o tipo de arquivo (usado pelas funções @code{S_IS*()} acima).
@end deffn

Normalmente, você usaria as funções @code{os.path.is*()} para testar o tipo de um arquivo; as funções aqui são úteis quando você está fazendo vários testes do mesmo arquivo e deseja evitar a sobrecarga da chamada de sistema @code{stat()} para cada teste. Eles também são úteis ao verificar informações sobre um arquivo que não é manipulado por @ref{a2,,os.path}, como os testes para dispositivos de blocos e caracteres.

Exemplo:

@example
import os, sys
from stat import *

def walktree(top, callback):
    '@w{'}'desce recursivamente a árvore de diretórios com raiz no topo,
     chamando a função de retorno de chamada para cada arquivo regular'@w{'}'

    for f in os.listdir(top):
        pathname = os.path.join(top, f)
        mode = os.lstat(pathname).st_mode
        if S_ISDIR(mode):
            # É um diretório, percorre recursivamente nele
            walktree(pathname, callback)
        elif S_ISREG(mode):
            # É um arquivo, chama a função de retorno
            callback(pathname)
        else:
            # Tipo de arquivo desconhecido, imprime uma mensagem
            print('Pulando %s' % pathname)

def visitfile(file):
    print('visitando, file)

if __name__ == '__main__':
    walktree(sys.argv[1], visitfile)
@end example

Uma função utilitária adicional é fornecida para converter o modo de um arquivo em uma string legível por humanos:

@geindex filemode() (no módulo stat)
@anchor{library/stat stat filemode}@anchor{118a}
@deffn {Função} stat.filemode (mode)

Converte o modo de um arquivo em uma string no formato ‘-rwxrwxrwx’.


Adicionado na versão 3.3.



Alterado na versão 3.4: A função tem suporte a @ref{fef,,S_IFDOOR}, @ref{ff0,,S_IFPORT} e @ref{ff1,,S_IFWHT}.

@end deffn

Todas as variáveis abaixo são simplesmente índices simbólicos nas 10 tuplas retornadas por @ref{4a0,,os.stat()}, @ref{db4,,os.fstat()} ou @ref{4a1,,os.lstat()}.

@geindex ST_MODE (no módulo stat)
@anchor{library/stat stat ST_MODE}@anchor{fee}
@deffn {Dado} stat.ST_MODE

Modo de proteção de nó-i.
@end deffn

@geindex ST_INO (no módulo stat)
@anchor{library/stat stat ST_INO}@anchor{299e}
@deffn {Dado} stat.ST_INO

Número de nó-i.
@end deffn

@geindex ST_DEV (no módulo stat)
@anchor{library/stat stat ST_DEV}@anchor{299f}
@deffn {Dado} stat.ST_DEV

Nó-i em que o dispositivo reside.
@end deffn

@geindex ST_NLINK (no módulo stat)
@anchor{library/stat stat ST_NLINK}@anchor{29a0}
@deffn {Dado} stat.ST_NLINK

Número de links para o nó-i.
@end deffn

@geindex ST_UID (no módulo stat)
@anchor{library/stat stat ST_UID}@anchor{29a1}
@deffn {Dado} stat.ST_UID

O ID de usuário para o proprietário.
@end deffn

@geindex ST_GID (no módulo stat)
@anchor{library/stat stat ST_GID}@anchor{29a2}
@deffn {Dado} stat.ST_GID

O ID de grupo para o proprietário.
@end deffn

@geindex ST_SIZE (no módulo stat)
@anchor{library/stat stat ST_SIZE}@anchor{29a3}
@deffn {Dado} stat.ST_SIZE

Tamanho em bytes de um arquivo simples; quantidade de dados aguardando em alguns arquivos especiais.
@end deffn

@geindex ST_ATIME (no módulo stat)
@anchor{library/stat stat ST_ATIME}@anchor{29a4}
@deffn {Dado} stat.ST_ATIME

Hora do último acesso.
@end deffn

@geindex ST_MTIME (no módulo stat)
@anchor{library/stat stat ST_MTIME}@anchor{29a5}
@deffn {Dado} stat.ST_MTIME

Hora da última modificação.
@end deffn

@geindex ST_CTIME (no módulo stat)
@anchor{library/stat stat ST_CTIME}@anchor{29a6}
@deffn {Dado} stat.ST_CTIME

O “ctime” conforme relatado pelo sistema operacional. Em alguns sistemas (como Unix) é o horário da última alteração de metadados e, em outros (como Windows), é o horário de criação (consulte a documentação da plataforma para obter detalhes).
@end deffn

A interpretação do “tamanho do arquivo” muda de acordo com o tipo de arquivo. Para arquivos simples, este é o tamanho do arquivo em bytes. Para FIFOs e soquetes na maioria dos tipos de Unix (incluindo Linux em particular), o “tamanho” é o número de bytes aguardando para serem lidos no momento da chamada para @ref{4a0,,os.stat()}, @ref{db4,,os.fstat()} ou @ref{4a1,,os.lstat()}; isso às vezes pode ser útil, especialmente para pesquisar um desses arquivos especiais após uma abertura sem bloqueio. O significado do campo de tamanho para outros dispositivos de caracteres e blocos varia mais, dependendo da implementação da chamada de sistema subjacente.

As variáveis abaixo definem os sinalizadores utilizadas no campo @ref{fee,,ST_MODE}.

O uso das funções acima é mais portátil do que o uso do primeiro conjunto de sinalizadores:

@geindex S_IFSOCK (no módulo stat)
@anchor{library/stat stat S_IFSOCK}@anchor{29a7}
@deffn {Dado} stat.S_IFSOCK

Soquete.
@end deffn

@geindex S_IFLNK (no módulo stat)
@anchor{library/stat stat S_IFLNK}@anchor{29a8}
@deffn {Dado} stat.S_IFLNK

Link simbólico.
@end deffn

@geindex S_IFREG (no módulo stat)
@anchor{library/stat stat S_IFREG}@anchor{29a9}
@deffn {Dado} stat.S_IFREG

Arquivo regular.
@end deffn

@geindex S_IFBLK (no módulo stat)
@anchor{library/stat stat S_IFBLK}@anchor{29aa}
@deffn {Dado} stat.S_IFBLK

Dispositivo de bloco.
@end deffn

@geindex S_IFDIR (no módulo stat)
@anchor{library/stat stat S_IFDIR}@anchor{29ab}
@deffn {Dado} stat.S_IFDIR

Diretório.
@end deffn

@geindex S_IFCHR (no módulo stat)
@anchor{library/stat stat S_IFCHR}@anchor{29ac}
@deffn {Dado} stat.S_IFCHR

Dispositivo de caracteres.
@end deffn

@geindex S_IFIFO (no módulo stat)
@anchor{library/stat stat S_IFIFO}@anchor{29ad}
@deffn {Dado} stat.S_IFIFO

FIFO.
@end deffn

@geindex S_IFDOOR (no módulo stat)
@anchor{library/stat stat S_IFDOOR}@anchor{fef}
@deffn {Dado} stat.S_IFDOOR

Porta.


Adicionado na versão 3.4.

@end deffn

@geindex S_IFPORT (no módulo stat)
@anchor{library/stat stat S_IFPORT}@anchor{ff0}
@deffn {Dado} stat.S_IFPORT

Porta de eventos.


Adicionado na versão 3.4.

@end deffn

@geindex S_IFWHT (no módulo stat)
@anchor{library/stat stat S_IFWHT}@anchor{ff1}
@deffn {Dado} stat.S_IFWHT

Apagamento.


Adicionado na versão 3.4.

@end deffn

@cartouche
@quotation Nota 
@ref{fef,,S_IFDOOR}, @ref{ff0,,S_IFPORT} ou @ref{ff1,,S_IFWHT} são definidos como 0 quando a plataforma não possui suporte para os tipos de arquivo.
@end quotation
@end cartouche

Os seguintes sinalizadores também podem ser usados no argumento `mode' de @ref{21b,,os.chmod()}:

@geindex S_ISUID (no módulo stat)
@anchor{library/stat stat S_ISUID}@anchor{29ae}
@deffn {Dado} stat.S_ISUID

Define o bit de UID.
@end deffn

@geindex S_ISGID (no módulo stat)
@anchor{library/stat stat S_ISGID}@anchor{29af}
@deffn {Dado} stat.S_ISGID

Bit de set-group-ID. Este bit tem vários usos especiais. Para um diretório, indica que a semântica BSD deve ser usada para esse diretório: os arquivos criados lá herdam seu ID de grupo do diretório, não do ID de grupo efetivo do processo de criação, e os diretórios criados lá também receberão o conjunto de bits @ref{29af,,S_ISGID}. Para um arquivo que não possui o bit de execução de grupo (@ref{29b0,,S_IXGRP}) definido, o bit de set-group-ID indica trava obrigatória de arquivo/registro (veja também @ref{29b1,,S_ENFMT}).
@end deffn

@geindex S_ISVTX (no módulo stat)
@anchor{library/stat stat S_ISVTX}@anchor{29b2}
@deffn {Dado} stat.S_ISVTX

Sticky bit. Quando este bit é definido em um diretório, significa que um arquivo nesse diretório pode ser renomeado ou excluído apenas pelo proprietário do arquivo, pelo proprietário do diretório ou por um processo privilegiado.
@end deffn

@geindex S_IRWXU (no módulo stat)
@anchor{library/stat stat S_IRWXU}@anchor{29b3}
@deffn {Dado} stat.S_IRWXU

Máscara para permissões de proprietário de arquivo.
@end deffn

@geindex S_IRUSR (no módulo stat)
@anchor{library/stat stat S_IRUSR}@anchor{29b4}
@deffn {Dado} stat.S_IRUSR

Proprietário tem permissão de leitura.
@end deffn

@geindex S_IWUSR (no módulo stat)
@anchor{library/stat stat S_IWUSR}@anchor{29b5}
@deffn {Dado} stat.S_IWUSR

Proprietário tem permissão de escrita.
@end deffn

@geindex S_IXUSR (no módulo stat)
@anchor{library/stat stat S_IXUSR}@anchor{29b6}
@deffn {Dado} stat.S_IXUSR

Proprietário tem permissão de execução.
@end deffn

@geindex S_IRWXG (no módulo stat)
@anchor{library/stat stat S_IRWXG}@anchor{29b7}
@deffn {Dado} stat.S_IRWXG

Máscara para permissões de grupo.
@end deffn

@geindex S_IRGRP (no módulo stat)
@anchor{library/stat stat S_IRGRP}@anchor{29b8}
@deffn {Dado} stat.S_IRGRP

Grupo tem permissão de leitura.
@end deffn

@geindex S_IWGRP (no módulo stat)
@anchor{library/stat stat S_IWGRP}@anchor{29b9}
@deffn {Dado} stat.S_IWGRP

Grupo tem permissão de escrita.
@end deffn

@geindex S_IXGRP (no módulo stat)
@anchor{library/stat stat S_IXGRP}@anchor{29b0}
@deffn {Dado} stat.S_IXGRP

Grupo tem permissão de execução.
@end deffn

@geindex S_IRWXO (no módulo stat)
@anchor{library/stat stat S_IRWXO}@anchor{29ba}
@deffn {Dado} stat.S_IRWXO

Máscara para permissões para outros (não no grupo).
@end deffn

@geindex S_IROTH (no módulo stat)
@anchor{library/stat stat S_IROTH}@anchor{29bb}
@deffn {Dado} stat.S_IROTH

Outros têm permissão de leitura.
@end deffn

@geindex S_IWOTH (no módulo stat)
@anchor{library/stat stat S_IWOTH}@anchor{29bc}
@deffn {Dado} stat.S_IWOTH

Outros têm permissão de escrita.
@end deffn

@geindex S_IXOTH (no módulo stat)
@anchor{library/stat stat S_IXOTH}@anchor{29bd}
@deffn {Dado} stat.S_IXOTH

Outros têm permissão de execução.
@end deffn

@geindex S_ENFMT (no módulo stat)
@anchor{library/stat stat S_ENFMT}@anchor{29b1}
@deffn {Dado} stat.S_ENFMT

Aplicação de trava de arquivo do System V. Este sinalizador é compartilhada com @ref{29af,,S_ISGID}: a trava de arquivo/registro é aplicada em arquivos que não possuem o bit de execução de grupo (@ref{29b0,,S_IXGRP}) definido.
@end deffn

@geindex S_IREAD (no módulo stat)
@anchor{library/stat stat S_IREAD}@anchor{29be}
@deffn {Dado} stat.S_IREAD

Sinônimo Unix V7 para @ref{29b4,,S_IRUSR}.
@end deffn

@geindex S_IWRITE (no módulo stat)
@anchor{library/stat stat S_IWRITE}@anchor{29bf}
@deffn {Dado} stat.S_IWRITE

Sinônimo Unix V7 para @ref{29b5,,S_IWUSR}.
@end deffn

@geindex S_IEXEC (no módulo stat)
@anchor{library/stat stat S_IEXEC}@anchor{29c0}
@deffn {Dado} stat.S_IEXEC

Sinônimo Unix V7 para @ref{29b6,,S_IXUSR}.
@end deffn

Os seguintes sinalizadores podem ser usados no argumento `flags' de @ref{112c,,os.chflags()}:

@geindex UF_SETTABLE (no módulo stat)
@anchor{library/stat stat UF_SETTABLE}@anchor{29c1}
@deffn {Dado} stat.UF_SETTABLE

Todos os sinalizadores definíveis pelo usuário


Adicionado na versão 3.13.

@end deffn

@geindex UF_NODUMP (no módulo stat)
@anchor{library/stat stat UF_NODUMP}@anchor{29c2}
@deffn {Dado} stat.UF_NODUMP

Não despeja o arquivo.
@end deffn

@geindex UF_IMMUTABLE (no módulo stat)
@anchor{library/stat stat UF_IMMUTABLE}@anchor{29c3}
@deffn {Dado} stat.UF_IMMUTABLE

O arquivo não pode ser alterado.
@end deffn

@geindex UF_APPEND (no módulo stat)
@anchor{library/stat stat UF_APPEND}@anchor{29c4}
@deffn {Dado} stat.UF_APPEND

O arquivo só pode sofrer acréscimos.
@end deffn

@geindex UF_OPAQUE (no módulo stat)
@anchor{library/stat stat UF_OPAQUE}@anchor{29c5}
@deffn {Dado} stat.UF_OPAQUE

O diretório é opaco quando visualizado por meio de uma pilha de união.
@end deffn

@geindex UF_NOUNLINK (no módulo stat)
@anchor{library/stat stat UF_NOUNLINK}@anchor{29c6}
@deffn {Dado} stat.UF_NOUNLINK

O arquivo não pode ser renomeado ou excluído.
@end deffn

@geindex UF_COMPRESSED (no módulo stat)
@anchor{library/stat stat UF_COMPRESSED}@anchor{29c7}
@deffn {Dado} stat.UF_COMPRESSED

O arquivo é armazenado compactado (macOS 10.6+).
@end deffn

@geindex UF_TRACKED (no módulo stat)
@anchor{library/stat stat UF_TRACKED}@anchor{29c8}
@deffn {Dado} stat.UF_TRACKED

Usado para manipular IDs de documentos (macOS)


Adicionado na versão 3.13.

@end deffn

@geindex UF_DATAVAULT (no módulo stat)
@anchor{library/stat stat UF_DATAVAULT}@anchor{29c9}
@deffn {Dado} stat.UF_DATAVAULT

O arquivo precisa de direito para leitura ou gravação (macOS 10.13+)


Adicionado na versão 3.13.

@end deffn

@geindex UF_HIDDEN (no módulo stat)
@anchor{library/stat stat UF_HIDDEN}@anchor{29ca}
@deffn {Dado} stat.UF_HIDDEN

O arquivo não deve ser exibido em uma GUI (macOS 10.5+).
@end deffn

@geindex SF_SETTABLE (no módulo stat)
@anchor{library/stat stat SF_SETTABLE}@anchor{29cb}
@deffn {Dado} stat.SF_SETTABLE

Todos os sinalizadores mutáveis de superusuário


Adicionado na versão 3.13.

@end deffn

@geindex SF_SUPPORTED (no módulo stat)
@anchor{library/stat stat SF_SUPPORTED}@anchor{29cc}
@deffn {Dado} stat.SF_SUPPORTED

Todos os sinalizadores válidos de superusuário

@ref{1ed8,,Disponibilidade}: macOS


Adicionado na versão 3.13.

@end deffn

@geindex SF_SYNTHETIC (no módulo stat)
@anchor{library/stat stat SF_SYNTHETIC}@anchor{29cd}
@deffn {Dado} stat.SF_SYNTHETIC

Todos os sinalizadores sintéticos de somente leitura de superusuário

@ref{1ed8,,Disponibilidade}: macOS


Adicionado na versão 3.13.

@end deffn

@geindex SF_ARCHIVED (no módulo stat)
@anchor{library/stat stat SF_ARCHIVED}@anchor{29ce}
@deffn {Dado} stat.SF_ARCHIVED

O arquivo não pode ser arquivado.
@end deffn

@geindex SF_IMMUTABLE (no módulo stat)
@anchor{library/stat stat SF_IMMUTABLE}@anchor{29cf}
@deffn {Dado} stat.SF_IMMUTABLE

O arquivo não pode ser alterado.
@end deffn

@geindex SF_APPEND (no módulo stat)
@anchor{library/stat stat SF_APPEND}@anchor{29d0}
@deffn {Dado} stat.SF_APPEND

O arquivo só pode sofrer acréscimos.
@end deffn

@geindex SF_RESTRICTED (no módulo stat)
@anchor{library/stat stat SF_RESTRICTED}@anchor{29d1}
@deffn {Dado} stat.SF_RESTRICTED

O arquivo precisa de um direito para ser escrito (macOS 10.13+)


Adicionado na versão 3.13.

@end deffn

@geindex SF_NOUNLINK (no módulo stat)
@anchor{library/stat stat SF_NOUNLINK}@anchor{29d2}
@deffn {Dado} stat.SF_NOUNLINK

O arquivo não pode ser renomeado ou excluído.
@end deffn

@geindex SF_SNAPSHOT (no módulo stat)
@anchor{library/stat stat SF_SNAPSHOT}@anchor{29d3}
@deffn {Dado} stat.SF_SNAPSHOT

O arquivo é um arquivo de captura (snapshot).
@end deffn

@geindex SF_FIRMLINK (no módulo stat)
@anchor{library/stat stat SF_FIRMLINK}@anchor{29d4}
@deffn {Dado} stat.SF_FIRMLINK

O arquivo é um firmlink (macOS 10.15+)


Adicionado na versão 3.13.

@end deffn

@geindex SF_DATALESS (no módulo stat)
@anchor{library/stat stat SF_DATALESS}@anchor{29d5}
@deffn {Dado} stat.SF_DATALESS

O arquivo é um objeto sem dados (macOS 10.15+)


Adicionado na versão 3.13.

@end deffn

Consulte a página man dos sistemas *BSD ou macOS @code{chflags(2)@footnote{https://manpages.debian.org/chflags(2)}} para obter mais informações.

No Windows, as seguintes constantes de atributos de arquivo estão disponíveis para uso ao testar bits no membro @code{st_file_attributes} retornado por @ref{4a0,,os.stat()}. Consulte a documentação da API do Windows@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx} para obter mais detalhes sobre o significado dessas constantes.

@geindex FILE_ATTRIBUTE_ARCHIVE (no módulo stat)
@geindex FILE_ATTRIBUTE_COMPRESSED (no módulo stat)
@geindex FILE_ATTRIBUTE_DEVICE (no módulo stat)
@geindex FILE_ATTRIBUTE_DIRECTORY (no módulo stat)
@geindex FILE_ATTRIBUTE_ENCRYPTED (no módulo stat)
@geindex FILE_ATTRIBUTE_HIDDEN (no módulo stat)
@geindex FILE_ATTRIBUTE_INTEGRITY_STREAM (no módulo stat)
@geindex FILE_ATTRIBUTE_NORMAL (no módulo stat)
@geindex FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (no módulo stat)
@geindex FILE_ATTRIBUTE_NO_SCRUB_DATA (no módulo stat)
@geindex FILE_ATTRIBUTE_OFFLINE (no módulo stat)
@geindex FILE_ATTRIBUTE_READONLY (no módulo stat)
@geindex FILE_ATTRIBUTE_REPARSE_POINT (no módulo stat)
@geindex FILE_ATTRIBUTE_SPARSE_FILE (no módulo stat)
@geindex FILE_ATTRIBUTE_SYSTEM (no módulo stat)
@geindex FILE_ATTRIBUTE_TEMPORARY (no módulo stat)
@geindex FILE_ATTRIBUTE_VIRTUAL (no módulo stat)
@anchor{library/stat stat FILE_ATTRIBUTE_ARCHIVE}@anchor{29d6}
@deffn {Dado} stat.FILE_ATTRIBUTE_ARCHIVE
@anchor{library/stat stat FILE_ATTRIBUTE_COMPRESSED}@anchor{29d7}
@deffnx {Dado} stat.FILE_ATTRIBUTE_COMPRESSED
@anchor{library/stat stat FILE_ATTRIBUTE_DEVICE}@anchor{29d8}
@deffnx {Dado} stat.FILE_ATTRIBUTE_DEVICE
@anchor{library/stat stat FILE_ATTRIBUTE_DIRECTORY}@anchor{29d9}
@deffnx {Dado} stat.FILE_ATTRIBUTE_DIRECTORY
@anchor{library/stat stat FILE_ATTRIBUTE_ENCRYPTED}@anchor{29da}
@deffnx {Dado} stat.FILE_ATTRIBUTE_ENCRYPTED
@anchor{library/stat stat FILE_ATTRIBUTE_HIDDEN}@anchor{29db}
@deffnx {Dado} stat.FILE_ATTRIBUTE_HIDDEN
@anchor{library/stat stat FILE_ATTRIBUTE_INTEGRITY_STREAM}@anchor{29dc}
@deffnx {Dado} stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
@anchor{library/stat stat FILE_ATTRIBUTE_NORMAL}@anchor{29dd}
@deffnx {Dado} stat.FILE_ATTRIBUTE_NORMAL
@anchor{library/stat stat FILE_ATTRIBUTE_NOT_CONTENT_INDEXED}@anchor{29de}
@deffnx {Dado} stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
@anchor{library/stat stat FILE_ATTRIBUTE_NO_SCRUB_DATA}@anchor{29df}
@deffnx {Dado} stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
@anchor{library/stat stat FILE_ATTRIBUTE_OFFLINE}@anchor{29e0}
@deffnx {Dado} stat.FILE_ATTRIBUTE_OFFLINE
@anchor{library/stat stat FILE_ATTRIBUTE_READONLY}@anchor{29e1}
@deffnx {Dado} stat.FILE_ATTRIBUTE_READONLY
@anchor{library/stat stat FILE_ATTRIBUTE_REPARSE_POINT}@anchor{29e2}
@deffnx {Dado} stat.FILE_ATTRIBUTE_REPARSE_POINT
@anchor{library/stat stat FILE_ATTRIBUTE_SPARSE_FILE}@anchor{29e3}
@deffnx {Dado} stat.FILE_ATTRIBUTE_SPARSE_FILE
@anchor{library/stat stat FILE_ATTRIBUTE_SYSTEM}@anchor{29e4}
@deffnx {Dado} stat.FILE_ATTRIBUTE_SYSTEM
@anchor{library/stat stat FILE_ATTRIBUTE_TEMPORARY}@anchor{29e5}
@deffnx {Dado} stat.FILE_ATTRIBUTE_TEMPORARY
@anchor{library/stat stat FILE_ATTRIBUTE_VIRTUAL}@anchor{29e6}
@deffnx {Dado} stat.FILE_ATTRIBUTE_VIRTUAL


Adicionado na versão 3.5.

@end deffn

No Windows, as seguintes constantes estão disponíveis para comparação com o membro @code{st_reparse_tag} retornado por @ref{4a1,,os.lstat()}. Estas são constantes bem conhecidas, mas não são uma lista exaustiva.

@geindex IO_REPARSE_TAG_SYMLINK (no módulo stat)
@geindex IO_REPARSE_TAG_MOUNT_POINT (no módulo stat)
@geindex IO_REPARSE_TAG_APPEXECLINK (no módulo stat)
@anchor{library/stat stat IO_REPARSE_TAG_SYMLINK}@anchor{29e7}
@deffn {Dado} stat.IO_REPARSE_TAG_SYMLINK
@anchor{library/stat stat IO_REPARSE_TAG_MOUNT_POINT}@anchor{29e8}
@deffnx {Dado} stat.IO_REPARSE_TAG_MOUNT_POINT
@anchor{library/stat stat IO_REPARSE_TAG_APPEXECLINK}@anchor{29e9}
@deffnx {Dado} stat.IO_REPARSE_TAG_APPEXECLINK


Adicionado na versão 3.8.

@end deffn

@node filecmp — Comparações de arquivos e diretórios,tempfile — Generate temporary files and directories,stat — Interpretando resultados de stat,Acesso a arquivos e diretórios
@anchor{library/filecmp doc}@anchor{29ea}@anchor{library/filecmp filecmp-file-and-directory-comparisons}@anchor{29eb}@anchor{library/filecmp module-filecmp}@anchor{5a}@anchor{library/filecmp translation-repo}@anchor{29ec}
@subsection @code{filecmp} — Comparações de arquivos e diretórios


@geindex module; filecmp

`Código-fonte:' Lib/filecmp.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/filecmp.py}


__________________________________________________________________


O módulo @ref{5a,,filecmp} define funções para comparar arquivos e diretórios, com várias compensações opcionais de tempo/correção. Para comparar arquivos, veja também o módulo @ref{37,,difflib}.

O módulo @ref{5a,,filecmp} define as seguintes funções:

@geindex cmp() (no módulo filecmp)
@anchor{library/filecmp filecmp cmp}@anchor{1754}
@deffn {Função} filecmp.cmp (f1, f2, shallow=True)

Compara os arquivos chamados `f1' e `f2', retornando @code{True} se eles parecerem iguais, @code{False} caso contrário.

Se `shallow' for verdadeiro e as assinaturas de @ref{4a0,,os.stat()} (tipo de arquivo, tamanho e hora de modificação) de ambos os arquivos forem idênticas, os arquivos serão considerados iguais.

Caso contrário, os arquivos serão tratados como diferentes se seus tamanhos ou conteúdos forem diferentes.

Observe que nenhum programa externo é chamado a partir desta função, o que lhe confere portabilidade e eficiência.

Esta função usa um cache para comparações passadas e os resultados, com entradas de cache invalidadas se as informações de @ref{4a0,,os.stat()} para o arquivo mudarem. O cache inteiro pode ser limpo usando @ref{f71,,clear_cache()}.
@end deffn

@geindex cmpfiles() (no módulo filecmp)
@anchor{library/filecmp filecmp cmpfiles}@anchor{16d4}
@deffn {Função} filecmp.cmpfiles (dir1, dir2, common, shallow=True)

Compara os arquivos nos dois diretórios `dir1' e `dir2' cujos nomes são dados por `common'.

Retorna três listas de nomes de arquivos: `match', `mismatch', `errors'. `match' contém a lista de arquivos que correspondem, `mismatch' contém os nomes daqueles que não correspondem e `errors' lista os nomes dos arquivos que não puderam ser comparados. Os arquivos são listados em `errors' se não existirem em um dos diretórios, o usuário não tiver permissão para lê-los ou se a comparação não puder ser feita por algum outro motivo.

O parâmetro `shallow' tem o mesmo significado e valor padrão que @ref{1754,,filecmp.cmp()}.

Por exemplo, @code{cmpfiles('a', 'b', ['c', 'd/e'])} comparará @code{a/c} com @code{b/c} e @code{a/d/e} com @code{b/d/e}. @code{'c'} e @code{'d/e'} estarão cada um em uma das três listas retornadas.
@end deffn

@geindex clear_cache() (no módulo filecmp)
@anchor{library/filecmp filecmp clear_cache}@anchor{f71}
@deffn {Função} filecmp.clear_cache ()

Limpa o cache do filecmp. Isso pode ser útil se um arquivo for comparado tão rapidamente após ser modificado que ele esteja dentro da resolução de mtime do sistema de arquivos subjacente.


Adicionado na versão 3.4.

@end deffn

@menu
* A classe dircmp:: 

@end menu

@node A classe dircmp,,,filecmp — Comparações de arquivos e diretórios
@anchor{library/filecmp dircmp-objects}@anchor{29ed}@anchor{library/filecmp the-dircmp-class}@anchor{29ee}
@subsubsection A classe @code{dircmp}


@geindex dircmp (classe em filecmp)
@anchor{library/filecmp filecmp dircmp}@anchor{f73}
@deffn {Classe} filecmp.dircmp (a, b, ignore=None, hide=None, *, shallow=True)

Constrói um novo objeto de comparação de diretórios para comparar os diretórios `a' e `b'. `ignore' é uma lista de nomes a serem ignorados e o padrão é @ref{f72,,filecmp.DEFAULT_IGNORES}. `hide' é uma lista de nomes a serem ocultados e o padrão é @code{[os.curdir, os.pardir]}.

A classe @ref{f73,,dircmp} compara arquivos fazendo comparações rasas, isto é, `shallow' conforme descrito para @ref{1754,,filecmp.cmp()} por padrão usando o parâmetro `shallow'.


Alterado na versão 3.13: Adicionado o parâmetro `shallow'.


A classe @ref{f73,,dircmp} fornece os seguintes métodos:

@geindex report() (método filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report}@anchor{29ef}
@deffn {Método} report ()

Exibe (para @ref{ae6,,sys.stdout}) uma comparação entre `a' e `b'.
@end deffn

@geindex report_partial_closure() (método filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report_partial_closure}@anchor{29f0}
@deffn {Método} report_partial_closure ()

Exibe uma comparação entre `a' e `b' e subdiretórios imediatos comuns.
@end deffn

@geindex report_full_closure() (método filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp report_full_closure}@anchor{29f1}
@deffn {Método} report_full_closure ()

Exibe uma comparação entre `a' e `b' e subdiretórios comuns (recursivamente).
@end deffn

A classe @ref{f73,,dircmp} oferece uma série de atributos interessantes que podem ser usados para obter várias informações sobre as árvores de diretórios que estão sendo comparadas.

Observe que, por meio dos ganchos @ref{4d3,,__getattr__()}, todos os atributos são computados preguiçosamente, portanto, não há perda de velocidade se apenas os atributos que são leves para computar forem usados.

@geindex left (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left}@anchor{29f2}
@deffn {Atributo} left

O diretório `a'.
@end deffn

@geindex right (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right}@anchor{29f3}
@deffn {Atributo} right

O diretório `b'.
@end deffn

@geindex left_list (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left_list}@anchor{29f4}
@deffn {Atributo} left_list

Arquivos e subdiretórios em `a', filtrados por `hide' e `ignore'.
@end deffn

@geindex right_list (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right_list}@anchor{29f5}
@deffn {Atributo} right_list

Arquivos e subdiretórios em `b', filtrados por `hide' e `ignore'.
@end deffn

@geindex common (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common}@anchor{29f6}
@deffn {Atributo} common

Arquivos e subdiretórios em `a' e `b'.
@end deffn

@geindex left_only (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp left_only}@anchor{29f7}
@deffn {Atributo} left_only

Arquivos e subdiretórios em apenas `a'.
@end deffn

@geindex right_only (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp right_only}@anchor{29f8}
@deffn {Atributo} right_only

Arquivos e subdiretórios em apenas `b'.
@end deffn

@geindex common_dirs (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_dirs}@anchor{29f9}
@deffn {Atributo} common_dirs

Subdiretórios em `a' e `b'.
@end deffn

@geindex common_files (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_files}@anchor{29fa}
@deffn {Atributo} common_files

Arquivos em `a' e `b'.
@end deffn

@geindex common_funny (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp common_funny}@anchor{29fb}
@deffn {Atributo} common_funny

Nomes em `a' e `b', de modo que o tipo difere entre os diretórios, ou nomes para os quais @ref{4a0,,os.stat()} relata um erro.
@end deffn

@geindex same_files (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp same_files}@anchor{29fc}
@deffn {Atributo} same_files

Arquivos que são idênticos em `a' e `b', usando o operador de comparação de arquivos da classe.
@end deffn

@geindex diff_files (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp diff_files}@anchor{29fd}
@deffn {Atributo} diff_files

Arquivos que estão em `a' e `b', cujos conteúdos diferem de acordo com o operador de comparação de arquivos da classe.
@end deffn

@geindex funny_files (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp funny_files}@anchor{29fe}
@deffn {Atributo} funny_files

Arquivos que estão em `a' e `b', mas não puderam ser comparados.
@end deffn

@geindex subdirs (atributo filecmp.dircmp)
@anchor{library/filecmp filecmp dircmp subdirs}@anchor{1a72}
@deffn {Atributo} subdirs

Um dicionário que mapeia nomes em @ref{29f9,,common_dirs} para instâncias @ref{f73,,dircmp} (ou instâncias MyDirCmp se esta instância for do tipo MyDirCmp, uma subclasse de @ref{f73,,dircmp}).


Alterado na versão 3.10: Anteriormente, as entradas eram sempre instâncias de @ref{f73,,dircmp}. Agora, as entradas são do mesmo tipo que `self', se `self' for uma subclasse de @ref{f73,,dircmp}.

@end deffn
@end deffn

@geindex DEFAULT_IGNORES (no módulo filecmp)
@anchor{library/filecmp filecmp DEFAULT_IGNORES}@anchor{f72}
@deffn {Dado} filecmp.DEFAULT_IGNORES


Adicionado na versão 3.4.


Lista de diretórios ignorados por @ref{f73,,dircmp} por padrão.
@end deffn

Aqui está um exemplo simplificado do uso do atributo @code{subdirs} para pesquisar recursivamente em dois diretórios para mostrar arquivos diferentes em comum:

@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 — Expansão de padrão de nome de arquivo no estilo Unix,filecmp — Comparações de arquivos e diretórios,Acesso a arquivos e diretórios
@anchor{library/tempfile doc}@anchor{29ff}@anchor{library/tempfile module-tempfile}@anchor{e0}@anchor{library/tempfile tempfile-generate-temporary-files-and-directories}@anchor{2a00}@anchor{library/tempfile translation-repo}@anchor{2a01}
@subsection @code{tempfile} — Generate temporary files and directories


@geindex module; tempfile

`Código-fonte:' Lib/tempfile.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tempfile.py}

@geindex temporary;file name
@geindex temporary;arquivo


__________________________________________________________________


This module creates temporary files and directories.  It works on all
supported platforms. @ref{2a02,,TemporaryFile}, @ref{4c6,,NamedTemporaryFile},
@ref{1275,,TemporaryDirectory}, and @ref{693,,SpooledTemporaryFile} are high-level
interfaces which provide automatic cleanup and can be used as
@ref{5d4,,context managers}. @ref{2a03,,mkstemp()} and
@ref{21f,,mkdtemp()} are lower-level functions which require manual cleanup.

All the user-callable functions and constructors take additional arguments which
allow direct control over the location and name of temporary files and
directories. Files names used by this module include a string of
random characters which allows those files to be securely created in
shared temporary directories.
To maintain backward compatibility, the argument order is somewhat odd; it
is recommended to use keyword arguments for clarity.

The module defines the following user-callable items:

@geindex TemporaryFile() (no módulo tempfile)
@anchor{library/tempfile tempfile TemporaryFile}@anchor{2a02}
@deffn {Função} tempfile.TemporaryFile (mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

Return a @ref{15cf,,file-like object} that can be used as a temporary storage area.
The file is created securely, using the same rules as @ref{2a03,,mkstemp()}. It will be destroyed as soon
as it is closed (including an implicit close when the object is garbage
collected).  Under Unix, the directory entry for the file is either not created at all or is removed
immediately after the file is created.  Other platforms do not support
this; your code should not rely on a temporary file created using this
function having or not having a visible name in the file system.

The resulting object can be used as a @ref{5d4,,context manager} (see
@ref{2a04,,Exemplos}).  On completion of the context or
destruction of the file object the temporary file will be removed
from the filesystem.

The `mode' parameter defaults to @code{'w+b'} so that the file created can
be read and written without being closed.  Binary mode is used so that it
behaves consistently on all platforms without regard for the data that is
stored.  `buffering', `encoding', `errors' and `newline' are interpreted as for
@ref{51c,,open()}.

The `dir', `prefix' and `suffix' parameters have the same meaning and
defaults as with @ref{2a03,,mkstemp()}.

The returned object is a true file object on POSIX platforms.  On other
platforms, it is a file-like object whose @code{file} attribute is the
underlying true file object.

The @ref{fa7,,os.O_TMPFILE} flag is used if it is available and works
(Linux-specific, requires Linux kernel 3.11 or later).

On platforms that are neither Posix nor Cygwin, TemporaryFile is an alias
for NamedTemporaryFile.

Levanta um @ref{19fa,,evento de auditoria} @code{tempfile.mkstemp} com o argumento @code{fullpath}.


Alterado na versão 3.5: The @ref{fa7,,os.O_TMPFILE} flag is now used if available.



Alterado na versão 3.8: Parâmetro `errors' foi adicionado.

@end deffn

@geindex NamedTemporaryFile() (no módulo tempfile)
@anchor{library/tempfile tempfile NamedTemporaryFile}@anchor{4c6}
@deffn {Função} 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)

This function operates exactly as @ref{2a02,,TemporaryFile()} does, except the
following differences:


@itemize *

@item 
This function returns a file that is guaranteed to have a visible name in
the file system.

@item 
To manage the named file, it extends the parameters of
@ref{2a02,,TemporaryFile()} with `delete' and `delete_on_close' parameters that
determine whether and how the named file should be automatically deleted.
@end itemize

The returned object is always a @ref{15cf,,file-like object} whose @code{file}
attribute is the underlying true file object. This file-like object
can be used in a @ref{5d2,,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{2a02,,TemporaryFile()}, the directory entry does not get unlinked immediately
after the file creation.

If `delete' is true (the default) and `delete_on_close' is true (the
default), the file is deleted as soon as it is closed. If `delete' is true
and `delete_on_close' is false, the file is deleted on context manager exit
only, or else when the @ref{15cf,,file-like object} is finalized. Deletion is not
always guaranteed in this case (see @ref{1033,,object.__del__()}). If `delete' is
false, the value of `delete_on_close' is ignored.

Therefore to use the name of the temporary file to reopen the file after
closing it, either make sure not to delete the file upon closure (set the
`delete' parameter to be false) or, in case the temporary file is created in
a @ref{5d2,,with} statement, set the `delete_on_close' parameter to be false.
The latter approach is recommended as it provides assistance in automatic
cleaning of the temporary file upon the context manager exit.

Opening the temporary file again by its name while it is still open works as
follows:


@itemize *

@item 
On POSIX the file can always be opened again.

@item 
On Windows, make sure that at least one of the following conditions are
fulfilled:


@itemize *

@item 
`delete' is false

@item 
additional open shares delete access (e.g. by calling @ref{dba,,os.open()}
with the flag @code{O_TEMPORARY})

@item 
`delete' is true but `delete_on_close' is false. Note, that in this
case the additional opens that do not share delete access (e.g.
created via builtin @ref{51c,,open()}) must be closed before exiting the
context manager, else the @ref{1134,,os.unlink()} call on context manager
exit will fail with a @ref{d65,,PermissionError}.
@end itemize
@end itemize

On Windows, if `delete_on_close' is false, and the file is created in a
directory for which the user lacks delete access, then the @ref{1134,,os.unlink()}
call on exit of the context manager will fail with a @ref{d65,,PermissionError}.
This cannot happen when `delete_on_close' is true because delete access is
requested by the open, which fails immediately if the requested access is not
granted.

On POSIX (only), a process that is terminated abruptly with SIGKILL
cannot automatically delete any NamedTemporaryFiles it created.

Levanta um @ref{19fa,,evento de auditoria} @code{tempfile.mkstemp} com o argumento @code{fullpath}.


Alterado na versão 3.8: Parâmetro `errors' foi adicionado.



Alterado na versão 3.12: Added `delete_on_close' parameter.

@end deffn

@geindex SpooledTemporaryFile (classe em tempfile)
@anchor{library/tempfile tempfile SpooledTemporaryFile}@anchor{693}
@deffn {Classe} 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{2a02,,TemporaryFile()} does, except that
data is spooled in memory until the file size exceeds `max_size', or
until the file’s @ref{15d0,,fileno()} method is called, at which point the
contents are written to disk and operation proceeds as with
@ref{2a02,,TemporaryFile()}.

@geindex rollover() (método tempfile.SpooledTemporaryFile)
@anchor{library/tempfile tempfile SpooledTemporaryFile rollover}@anchor{2a05}
@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{ed3,,io.BytesIO} or @ref{7bc,,io.TextIOWrapper} object
(depending on whether binary or text `mode' was specified) or a true file
object, depending on whether @ref{2a05,,rollover()} has been called.  This
file-like object can be used in a @ref{5d2,,with} statement, just like
a normal file.


Alterado na versão 3.3: the truncate method now accepts a `size' argument.



Alterado na versão 3.8: Parâmetro `errors' foi adicionado.



Alterado na versão 3.11: Fully implements the @ref{694,,io.BufferedIOBase} and
@ref{695,,io.TextIOBase} abstract base classes (depending on whether binary
or text `mode' was specified).

@end deffn

@geindex TemporaryDirectory (classe em tempfile)
@anchor{library/tempfile tempfile TemporaryDirectory}@anchor{1275}
@deffn {Classe} 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{21f,,mkdtemp()}.
The resulting object can be used as a @ref{5d4,,context manager} (see
@ref{2a04,,Exemplos}).  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 tempfile.TemporaryDirectory)
@anchor{library/tempfile tempfile TemporaryDirectory name}@anchor{2a06}
@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{5d4,,context manager}, the
@code{name} will be assigned to the target of the @code{as} clause in
the @ref{5d2,,with} statement, if there is one.
@end deffn

@geindex cleanup() (método tempfile.TemporaryDirectory)
@anchor{library/tempfile tempfile TemporaryDirectory cleanup}@anchor{2a07}
@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{d65,,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

The `delete' parameter can be used to disable cleanup of the directory tree
upon exiting the context.  While it may seem unusual for a context manager
to disable the action taken when exiting the context, it can be useful during
debugging or when you need your cleanup behavior to be conditional based on
other logic.

Levanta um @ref{19fa,,evento de auditoria} @code{tempfile.mkdtemp} com o argumento @code{fullpath}.


Adicionado na versão 3.2.



Alterado na versão 3.10: Added `ignore_cleanup_errors' parameter.



Alterado na versão 3.12: Added the `delete' parameter.

@end deffn

@geindex mkstemp() (no módulo tempfile)
@anchor{library/tempfile tempfile mkstemp}@anchor{2a03}
@deffn {Função} tempfile.mkstemp (suffix=None, prefix=None, dir=None, text=False)

Creates a temporary file in the most secure manner possible.  There are
no race conditions in the file’s creation, assuming that the platform
properly implements the @ref{2a08,,os.O_EXCL} flag for @ref{dba,,os.open()}.  The
file is readable and writable only by the creating user ID.  If the
platform uses permission bits to indicate whether a file is executable,
the file is executable by no one.

The file descriptor is @ref{f2b,,not inherited by child processes}.

Unlike @ref{2a02,,TemporaryFile()}, the user of @ref{2a03,,mkstemp()} is responsible
for deleting the temporary file when done with it.

If `suffix' is not @code{None}, the file name will end with that suffix,
otherwise there will be no suffix.  @ref{2a03,,mkstemp()} does not put a dot
between the file name and the suffix; if you need one, put it at the
beginning of `suffix'.

If `prefix' is not @code{None}, the file name will begin with that prefix;
otherwise, a default prefix is used.  The default is the return value of
@ref{2a09,,gettempprefix()} or @ref{2a0a,,gettempprefixb()}, as appropriate.

If `dir' is not @code{None}, the file will be created in that directory;
otherwise, a default directory is used.  The default directory is chosen
from a platform-dependent list, but the user of the application can
control the directory location by setting the `TMPDIR', `TEMP' or `TMP'
environment variables.  There is thus no guarantee that the generated
filename will have any nice properties, such as not requiring quoting
when passed to external commands via @code{os.popen()}.

If any of `suffix', `prefix', and `dir' are not
@code{None}, they must be the same type.
If they are bytes, the returned name will be bytes instead of str.
If you want to force a bytes return value with otherwise default behavior,
pass @code{suffix=b'@w{'}}.

If `text' is specified and true, the file is opened in text mode.
Otherwise, (the default) the file is opened in binary mode.

@ref{2a03,,mkstemp()} returns a tuple containing an OS-level handle to an open
file (as would be returned by @ref{dba,,os.open()}) and the absolute pathname
of that file, in that order.

Levanta um @ref{19fa,,evento de auditoria} @code{tempfile.mkstemp} com o argumento @code{fullpath}.


Alterado na versão 3.5: `suffix', `prefix', and `dir' may now be supplied in bytes in order to
obtain a bytes return value.  Prior to this, only str was allowed.
`suffix' and `prefix' now accept and default to @code{None} to cause
an appropriate default value to be used.



Alterado na versão 3.6: The `dir' parameter now accepts a @ref{2a0,,path-like object}.

@end deffn

@geindex mkdtemp() (no módulo tempfile)
@anchor{library/tempfile tempfile mkdtemp}@anchor{21f}
@deffn {Função} tempfile.mkdtemp (suffix=None, prefix=None, dir=None)

Creates a temporary directory in the most secure manner possible. There
are no race conditions in the directory’s creation.  The directory is
readable, writable, and searchable only by the creating user ID.

The user of @ref{21f,,mkdtemp()} is responsible for deleting the temporary
directory and its contents when done with it.

The `prefix', `suffix', and `dir' arguments are the same as for
@ref{2a03,,mkstemp()}.

@ref{21f,,mkdtemp()} returns the absolute pathname of the new directory.

Levanta um @ref{19fa,,evento de auditoria} @code{tempfile.mkdtemp} com o argumento @code{fullpath}.


Alterado na versão 3.5: `suffix', `prefix', and `dir' may now be supplied in bytes in order to
obtain a bytes return value.  Prior to this, only str was allowed.
`suffix' and `prefix' now accept and default to @code{None} to cause
an appropriate default value to be used.



Alterado na versão 3.6: The `dir' parameter now accepts a @ref{2a0,,path-like object}.



Alterado na versão 3.12: @ref{21f,,mkdtemp()} now always returns an absolute path, even if `dir' is relative.

@end deffn

@geindex gettempdir() (no módulo tempfile)
@anchor{library/tempfile tempfile gettempdir}@anchor{1a1f}
@deffn {Função} tempfile.gettempdir ()

Return the name of the directory used for temporary files. This
defines the default value for the `dir' argument to all functions
in this module.

Python searches a standard list of directories to find one which
the calling user can create files in.  The list is:


@enumerate 

@item 
The directory named by the 
@geindex TMPDIR
@geindex variável de ambiente; TMPDIR
@code{TMPDIR} environment variable.

@item 
The directory named by the 
@geindex TEMP
@geindex variável de ambiente; TEMP
@code{TEMP} environment variable.

@item 
The directory named by the 
@geindex TMP
@geindex variável de ambiente; TMP
@code{TMP} environment variable.

@item 
Uma localização específica por plataforma:


@itemize *

@item 
On Windows, the directories @code{C:\TEMP}, @code{C:\TMP},
@code{\TEMP}, and @code{\TMP}, in that order.

@item 
On all other platforms, the directories @code{/tmp}, @code{/var/tmp}, and
@code{/usr/tmp}, in that order.
@end itemize

@item 
As a last resort, the current working directory.
@end enumerate

The result of this search is cached, see the description of
@ref{1a1e,,tempdir} below.


Alterado na versão 3.10: Always returns a str.  Previously it would return any @ref{1a1e,,tempdir}
value regardless of type so long as it was not @code{None}.

@end deffn

@geindex gettempdirb() (no módulo tempfile)
@anchor{library/tempfile tempfile gettempdirb}@anchor{1a20}
@deffn {Função} tempfile.gettempdirb ()

Same as @ref{1a1f,,gettempdir()} but the return value is in bytes.


Adicionado na versão 3.5.

@end deffn

@geindex gettempprefix() (no módulo tempfile)
@anchor{library/tempfile tempfile gettempprefix}@anchor{2a09}
@deffn {Função} tempfile.gettempprefix ()

Return the filename prefix used to create temporary files.  This does not
contain the directory component.
@end deffn

@geindex gettempprefixb() (no módulo tempfile)
@anchor{library/tempfile tempfile gettempprefixb}@anchor{2a0a}
@deffn {Função} tempfile.gettempprefixb ()

Same as @ref{2a09,,gettempprefix()} but the return value is in bytes.


Adicionado na versão 3.5.

@end deffn

The module uses a global variable to store the name of the directory
used for temporary files returned by @ref{1a1f,,gettempdir()}.  It can be
set directly to override the selection process, but this is discouraged.
All functions in this module take a `dir' argument which can be used
to specify the directory. This is the recommended approach that does
not surprise other unsuspecting code by changing global API behavior.

@geindex tempdir (no módulo tempfile)
@anchor{library/tempfile tempfile tempdir}@anchor{1a1e}
@deffn {Dado} tempfile.tempdir

When set to a value other than @code{None}, this variable defines the
default value for the `dir' argument to the functions defined in this
module, including its type, bytes or str.  It cannot be a
@ref{2a0,,path-like object}.

If @code{tempdir} is @code{None} (the default) at any call to any of the above
functions except @ref{2a09,,gettempprefix()} it is initialized following the
algorithm described in @ref{1a1f,,gettempdir()}.

@cartouche
@quotation Nota 
Beware that if you set @code{tempdir} to a bytes value, there is a
nasty side effect: The global default return type of
@ref{2a03,,mkstemp()} and @ref{21f,,mkdtemp()} changes to bytes when no
explicit @code{prefix}, @code{suffix}, or @code{dir} arguments of type
str are supplied. Please do not write code expecting or
depending on this. This awkward behavior is maintained for
compatibility with the historical implementation.
@end quotation
@end cartouche
@end deffn

@menu
* Exemplos: Exemplos<5>. 
* Deprecated functions and variables:: 

@end menu

@node Exemplos<5>,Deprecated functions and variables,,tempfile — Generate temporary files and directories
@anchor{library/tempfile examples}@anchor{2a0b}@anchor{library/tempfile tempfile-examples}@anchor{2a04}
@subsubsection Exemplos


Here are some examples of typical usage of the @ref{e0,,tempfile} module:

@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 Deprecated functions and variables,,Exemplos<5>,tempfile — Generate temporary files and directories
@anchor{library/tempfile deprecated-functions-and-variables}@anchor{2a0c}@anchor{library/tempfile tempfile-mktemp-deprecated}@anchor{2a0d}
@subsubsection Deprecated functions and variables


A historical way to create temporary files was to first generate a
file name with the @ref{19bb,,mktemp()} function and then create a file
using this name. Unfortunately this is not secure, because a different
process may create a file with this name in the time between the call
to @ref{19bb,,mktemp()} and the subsequent attempt to create the file by the
first process. The solution is to combine the two steps and create the
file immediately. This approach is used by @ref{2a03,,mkstemp()} and the
other functions described above.

@geindex mktemp() (no módulo tempfile)
@anchor{library/tempfile tempfile mktemp}@anchor{19bb}
@deffn {Função} tempfile.mktemp (suffix='@w{'}, prefix='tmp', dir=None)


Descontinuado desde a versão 2.3: Use @ref{2a03,,mkstemp()}.


Return an absolute pathname of a file that did not exist at the time the
call is made.  The `prefix', `suffix', and `dir' arguments are similar
to those of @ref{2a03,,mkstemp()}, except that bytes file names, @code{suffix=None}
and @code{prefix=None} are not supported.

@cartouche
@quotation Aviso 
Use of this function may introduce a security hole in your program.  By
the time you get around to doing anything with the file name it returns,
someone else may have beaten you to the punch.  @ref{19bb,,mktemp()} usage can
be replaced easily with @ref{4c6,,NamedTemporaryFile()}, passing it the
@code{delete=False} parameter:

@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 — Expansão de padrão de nome de arquivo no estilo Unix,fnmatch — Correspondência de padrões de nome de arquivo Unix,tempfile — Generate temporary files and directories,Acesso a arquivos e diretórios
@anchor{library/glob doc}@anchor{2a0e}@anchor{library/glob glob-unix-style-pathname-pattern-expansion}@anchor{2a0f}@anchor{library/glob module-glob}@anchor{64}@anchor{library/glob translation-repo}@anchor{2a10}
@subsection @code{glob} — Expansão de padrão de nome de arquivo no estilo Unix


@geindex module; glob

`Código-fonte:' Lib/glob.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/glob.py}

@geindex nomes de arquivos;expansão de nome de arquivo


__________________________________________________________________


@geindex * (asterisco);caracteres curingas no estilo blog
@geindex ? (interrogação);caracteres curingas no estilo blog
@geindex [] (colchetes);caracteres curingas no estilo blog
@geindex ! (exclamação);caracteres curingas no estilo blog
@geindex - (menos);caracteres curingas no estilo blog
@geindex . (ponto);caracteres curingas no estilo blog

O módulo @code{glob} encontra caminhos usando regras de correspondência de padrões semelhante a do shell Unix. Nenhuma expansão de til é feita, mas @code{*}, @code{?} e os intervalos de caracteres expressos com @code{[]} serão correspondidos corretamente. Isso é feito usando as funções @ref{a68,,os.scandir()} e @ref{19df,,fnmatch.fnmatch()} em conjunto, e não invocando realmente um subshell.

@cartouche
@quotation Nota 
Os caminhos são retornados sem uma ordem específica. Se precisar de uma ordem específica, classifique os resultados.
@end quotation
@end cartouche

Arquivos iniciando com um ponto (@code{.}) só podem ser correspondidos com padrões que também iniciam com um ponto, ao contrário de @ref{19df,,fnmatch.fnmatch()} ou @ref{22d,,pathlib.Path.glob()}. Para expansão de til e variável de shell, use @ref{a1e,,os.path.expanduser()} e @ref{1420,,os.path.expandvars()}.

Para uma correspondência literal, coloque os metacaracteres entre colchetes. Por exemplo, @code{'[?]'} corresponde ao caractere @code{'?'}.

O módulo @code{glob} define as seguintes funções:

@geindex glob() (no módulo glob)
@anchor{library/glob glob glob}@anchor{29f}
@deffn {Função} glob.glob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

Retorna uma lista possivelmente vazia de nomes de caminho que correspondem a `pathname', que deve ser uma string contendo uma especificação de caminho. `pathname' pode ser absoluto (como @code{/usr/src/Python-1.5/Makefile}) ou relativo (como @code{../../Tools/*/*.gif}) e pode conter curingas no estilo shell. Links simbólicos quebrados são incluídos nos resultados (como no shell). Se os resultados são classificados ou não depende do sistema de arquivos. Se um arquivo que satisfaz as condições for removido ou adicionado durante a chamada desta função, não é especificado se um nome de caminho para esse arquivo será incluído.

Se `root_dir' não for @code{None}, deve ser um @ref{2a0,,objeto caminho ou similar} especificando o diretório raiz para pesquisa. Tem o mesmo efeito em @code{glob()} que alterar o diretório atual antes de chamá-lo. Se `pathname' for relativo, o resultado conterá caminhos relativos a `root_dir'.

Esta função oferece suporte para @ref{1129,,caminhos relativos aos descritores de diretório} com o parâmetro `dir_fd'.

@geindex **;caracteres curingas no estilo blog

Se `recursive' for verdadeiro, o padrão “@code{**}” corresponderá a qualquer arquivo e zero ou mais diretórios, subdiretórios e links simbólicos para diretórios. Se o padrão for seguido por um @ref{66a,,os.sep} ou @ref{66b,,os.altsep}, então os arquivos não irão corresponder.

Se `include_hidden' for verdadeiro, o padrão “@code{**}” corresponderá aos diretórios ocultos.

Levanta um @ref{19fa,,evento de auditoria} @code{glob.glob} com os argumentos @code{pathname}, @code{recursive}.

Levanta um @ref{19fa,,evento de auditoria} @code{glob.glob/2} com os argumentos @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation Nota 
Usar o padrão “@code{**}” em grandes árvores de diretório pode consumir uma quantidade excessiva de tempo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Esta função pode retornar nomes de caminhos duplicados se `pathname' contiver vários padrões “@code{**}” e `recursive' for verdadeiro.
@end quotation
@end cartouche


Alterado na versão 3.5: Suporte a globs recursivos usando “@code{**}”.



Alterado na versão 3.10: Adicionados os parâmetros `root_dir' e `dir_fd'.



Alterado na versão 3.11: Adicionado o parâmetro `include_hidden'.

@end deffn

@geindex iglob() (no módulo glob)
@anchor{library/glob glob iglob}@anchor{80a}
@deffn {Função} glob.iglob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

Retorna um @ref{1ac,,iterador} que produz os mesmos valores que @ref{64,,glob()} sem realmente armazená-los todos simultaneamente.

Levanta um @ref{19fa,,evento de auditoria} @code{glob.glob} com os argumentos @code{pathname}, @code{recursive}.

Levanta um @ref{19fa,,evento de auditoria} @code{glob.glob/2} com os argumentos @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation Nota 
Esta função pode retornar nomes de caminhos duplicados se `pathname' contiver vários padrões “@code{**}” e `recursive' for verdadeiro.
@end quotation
@end cartouche


Alterado na versão 3.5: Suporte a globs recursivos usando “@code{**}”.



Alterado na versão 3.10: Adicionados os parâmetros `root_dir' e `dir_fd'.



Alterado na versão 3.11: Adicionado o parâmetro `include_hidden'.

@end deffn

@geindex escape() (no módulo glob)
@anchor{library/glob glob escape}@anchor{f79}
@deffn {Função} glob.escape (pathname)

Escapa todos os caracteres especiais (@code{'?'}, @code{'*'} e @code{'['}). Isso é útil se você deseja corresponder a uma string literal arbitrária que pode conter caracteres especiais. Os caracteres especiais nos pontos de compartilhamento de unidade/UNC não têm escape, por exemplo, no Windows  @code{escape('//?/c:/Quo vadis?.txt')} retorna @code{'//?/c:/Quo vadis[?].txt'}.


Adicionado na versão 3.4.

@end deffn

@geindex translate() (no módulo glob)
@anchor{library/glob glob translate}@anchor{1ea}
@deffn {Função} glob.translate (pathname, *, recursive=False, include_hidden=False, seps=None)

Converte a especificação de caminho dada para uma expressão regular para uso com @ref{126e,,re.match()}. A especificação de caminho pode conter curingas no estilo shell.

Por exemplo:

@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

Separadores de caminho e segmentos são significativos para esta função, diferentemente de @ref{1bbe,,fnmatch.translate()}. Por padrão, curingas não correspondem a separadores de caminho, e segmentos de padrão @code{*} correspondem precisamente a um segmento de caminho.

Se `recursive' for verdadeiro, o segmento de padrão “@code{**}” corresponderá a qualquer número de segmentos de caminho.

Se `include_hidden' for verdadeiro, os curingas poderão corresponder a segmentos de caminho que começam com um ponto (@code{.}).

Uma sequência de separadores de caminho pode ser fornecida ao argumento `seps'. Se não for fornecido, @ref{66a,,os.sep} e @ref{66b,,altsep} (se disponível) são usados.


@subsubheading Ver também


Os métodos @ref{22b,,pathlib.PurePath.full_match()} e @ref{22d,,pathlib.Path.glob()}, que chamam esta função para implementar correspondência de padrões e globbing.



Adicionado na versão 3.13.

@end deffn

@menu
* Exemplos: Exemplos<6>. 

@end menu

@node Exemplos<6>,,,glob — Expansão de padrão de nome de arquivo no estilo Unix
@anchor{library/glob examples}@anchor{2a11}
@subsubsection Exemplos


Considere um diretório contendo os seguintes arquivos: @code{1.gif}, @code{2.txt}, @code{card.gif} e um subdiretório @code{sub} que contém apenas o arquivo @code{3.txt}. @ref{64,,glob()} produzirá os seguintes resultados. Observe como todos os componentes principais do caminho são preservados.

@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

Se o diretório contém arquivos começando com @code{.} eles não serão correspondidos por padrão. Por exemplo, considere um diretório contendo @code{card.gif} e @code{.card.gif}

@example
>>> import glob
>>> glob.glob('*.gif')
['card.gif']
>>> glob.glob('.c*')
['.card.gif']
@end example


@subsubheading Ver também


O módulo @ref{5c,,fnmatch} oferece expansão de nome de arquivo (não caminho) no estilo shell.



@subsubheading Ver também


O módulo @ref{a4,,pathlib} oferece objetos de caminho de alto nível.


@node fnmatch — Correspondência de padrões de nome de arquivo Unix,linecache — Acesso aleatório a linhas de texto,glob — Expansão de padrão de nome de arquivo no estilo Unix,Acesso a arquivos e diretórios
@anchor{library/fnmatch doc}@anchor{2a12}@anchor{library/fnmatch fnmatch-unix-filename-pattern-matching}@anchor{2a13}@anchor{library/fnmatch module-fnmatch}@anchor{5c}@anchor{library/fnmatch translation-repo}@anchor{2a14}
@subsection @code{fnmatch} — Correspondência de padrões de nome de arquivo Unix


@geindex module; fnmatch

`Código-fonte:' Lib/fnmatch.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/fnmatch.py}

@geindex nomes de arquivos;expansão de curingas

@geindex módulo;re


__________________________________________________________________


Este módulo fornece suporte para curingas no estilo shell do Unix, que `não' são iguais às expressões regulares (documentadas no módulo @ref{b9,,re}). Os caracteres especiais usados nos curingas no estilo de shell são:

@geindex * (asterisco);caracteres curingas no estilo blog
@geindex ? (interrogação);caracteres curingas no estilo blog
@geindex [] (colchetes);caracteres curingas no estilo blog
@geindex ! (exclamação);caracteres curingas no estilo blog
@geindex - (menos);caracteres curingas no estilo blog


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Padrão

@tab

Significado

@item

@code{*}

@tab

corresponde a tudo

@item

@code{?}

@tab

Corresponde a qualquer caractere único

@item

@code{[seq]}

@tab

corresponde a qualquer caractere em `seq'

@item

@code{[!seq]}

@tab

corresponde a qualquer caractere ausente em `seq'

@end multitable


Para uma correspondência literal, coloque os metacaracteres entre colchetes. Por exemplo, @code{'[?]'} corresponde ao caractere @code{'?'}.

@geindex módulo;glob

Note que o separador de nome de arquivo (@code{'/'} no Unix) `não' é especial para este módulo. Veja o módulo @ref{64,,glob} para expansão do nome do caminho (@ref{64,,glob} usa @ref{19e1,,filter()} para corresponder aos segmentos do nome do caminho). Da mesma forma, os nomes de arquivos que começam com um ponto final não são especiais para este módulo e são correspondidos pelos padrões @code{*} e @code{?}.

A menos que indicado de outra forma, “string de nome de arquivo” e “string de padrão” referem-se a objetos @ref{44c,,str} ou @ref{1c2,,bytes} codificados em @code{ISO-8859-1}. Observe que as funções documentadas abaixo não permitem misturar um padrão @code{bytes} com um nome de arquivo @code{str} e vice-versa.

Finalmente, observe também que @ref{9f7,,functools.lru_cache()} com um `maxsize' de 32768 é usado para armazenar em cache os padrões de regex compilados (tipados) nas seguintes funções: @ref{5c,,fnmatch()}, @ref{19e0,,fnmatchcase()}, @ref{19e1,,filter()}.

@geindex fnmatch() (no módulo fnmatch)
@anchor{library/fnmatch fnmatch fnmatch}@anchor{19df}
@deffn {Função} fnmatch.fnmatch (name, pat)

Testa se a string do nome de arquivo `name' corresponde à string de padrão `pat', retornando @code{True} ou @code{False}. Ambos os parâmetros são normalizados em maiúsculas e minúsculas usando @ref{298f,,os.path.normcase()}. @ref{19e0,,fnmatchcase()} pode ser usado para realizar uma comparação com distinção entre maiúsculas e minúsculas, independentemente de ser padrão para o sistema operacional.

Este exemplo vai exibir todos os nomes de arquivos no diretório atual com a extensão @code{.txt}:

@example
import fnmatch
import os

for arquivo in os.listdir('.'):
    if fnmatch.fnmatch(arquivo, '*.txt'):
        print(arquivo)
@end example
@end deffn

@geindex fnmatchcase() (no módulo fnmatch)
@anchor{library/fnmatch fnmatch fnmatchcase}@anchor{19e0}
@deffn {Função} fnmatch.fnmatchcase (name, pat)

Testa se a string do nome de arquivo `name' corresponde à string de padrão `pat', retornando @code{True} ou @code{False}; a comparação diferencia maiúsculas de minúsculas e não se aplica a @ref{298f,,os.path.normcase()}.
@end deffn

@geindex filter() (no módulo fnmatch)
@anchor{library/fnmatch fnmatch filter}@anchor{19e1}
@deffn {Função} fnmatch.filter (names, pat)

Constrói uma lista a partir daqueles elementos do @ref{1268,,iterável} de strings de nome de arquivo `names' que correspondem à string de padrão `pat'. É o mesmo que @code{[n for n in names if fnmatch(n, pat)]}, mas implementado com mais eficiência.
@end deffn

@geindex translate() (no módulo fnmatch)
@anchor{library/fnmatch fnmatch translate}@anchor{1bbe}
@deffn {Função} fnmatch.translate (pat)

Retorna o padrão `pat' no estilo shell convertido em uma expressão regular para usar com @ref{126e,,re.match()}. O padrão é esperado ser um @ref{44c,,str}.

Exemplo:

@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 também



@table @asis

@item Módulo @ref{64,,glob}

Expansão de caminho no estilo shell do Unix.
@end table


@node linecache — Acesso aleatório a linhas de texto,shutil — Operações de arquivo de alto nível,fnmatch — Correspondência de padrões de nome de arquivo Unix,Acesso a arquivos e diretórios
@anchor{library/linecache doc}@anchor{2a15}@anchor{library/linecache linecache-random-access-to-text-lines}@anchor{2a16}@anchor{library/linecache module-linecache}@anchor{85}@anchor{library/linecache translation-repo}@anchor{2a17}
@subsection @code{linecache} — Acesso aleatório a linhas de texto


@geindex module; linecache

`Código-fonte:' Lib/linecache.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/linecache.py}


__________________________________________________________________


O módulo @ref{85,,linecache} permite obter qualquer linha de um arquivo fonte Python, enquanto tenta otimizar internamente, usando um cache, o caso comum em que muitas linhas são lidas em um único arquivo. Isso é usado pelo módulo @ref{fe,,traceback} para recuperar as linhas de origem para inclusão no traceback (situação da pilha de execução) formatado.

A função @ref{2a18,,tokenize.open()} é usada para abrir arquivos. Esta função usa @ref{2a19,,tokenize.detect_encoding()} para obter a codificação do arquivo; na ausência de um token de codificação, o padrão de codificação do arquivo é UTF-8.

O módulo @ref{85,,linecache} define as seguintes funções:

@geindex getline() (no módulo linecache)
@anchor{library/linecache linecache getline}@anchor{e50}
@deffn {Função} linecache.getline (filename, lineno, module_globals=None)

Obtém a linha `lineno' do arquivo chamado `filename'. Essa função nunca levanta uma exceção — ela retornará @code{'@w{'}} em erros (o caractere de nova linha final será incluído para as linhas encontradas).

@geindex módulo;pesquisa;caminho

Se um arquivo chamado `filename' não for encontrado, a função primeiro verifica por um @code{__loader__} da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} em `module_globals'. Se existe um carregador e ele define um método @code{get_source}, isso determina as linhas fonte (se @code{get_source()} retornar @code{None}, então @code{'@w{'}} será retornado). Por fim, se `filename' for um nome de arquivo relativo, ele será procurado em relação às entradas no caminho de pesquisa do módulo, @code{sys.path}.
@end deffn

@geindex clearcache() (no módulo linecache)
@anchor{library/linecache linecache clearcache}@anchor{2a1a}
@deffn {Função} linecache.clearcache ()

Limpa o cache. Use esta função se você não precisar mais de linhas de arquivos lidos anteriormente usando @ref{e50,,getline()}.
@end deffn

@geindex checkcache() (no módulo linecache)
@anchor{library/linecache linecache checkcache}@anchor{166a}
@deffn {Função} linecache.checkcache (filename=None)

Verifica a validade do cache. Use esta função se os arquivos no cache tiverem sido alterados no disco e você precisar da versão atualizada. Se `filename' for omitido, ele verificará todas as entradas no cache.
@end deffn

@geindex lazycache() (no módulo linecache)
@anchor{library/linecache linecache lazycache}@anchor{e4f}
@deffn {Função} linecache.lazycache (filename, module_globals)

Captura detalhes suficientes sobre um módulo não baseado em arquivo para permitir obter suas linhas posteriormente via @ref{e50,,getline()} mesmo se `module_globals' for @code{None} na chamada posterior. Isso evita a execução de E/S até que uma linha seja realmente necessária, sem ter que carregar o módulo global indefinidamente.


Adicionado na versão 3.5.

@end deffn

Exemplo:

@example
>>> import linecache
>>> linecache.getline(linecache.__file__, 8)
'import sys\n'
@end example

@node shutil — Operações de arquivo de alto nível,,linecache — Acesso aleatório a linhas de texto,Acesso a arquivos e diretórios
@anchor{library/shutil doc}@anchor{2a1b}@anchor{library/shutil module-shutil}@anchor{c5}@anchor{library/shutil shutil-high-level-file-operations}@anchor{2a1c}@anchor{library/shutil translation-repo}@anchor{2a1d}
@subsection @code{shutil} — Operações de arquivo de alto nível


@geindex module; shutil

@c partly based on the docstrings

`Código-fonte:' Lib/shutil.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/shutil.py}

@geindex arquivo;cópia
@geindex cópia de arquivos


__________________________________________________________________


O módulo @ref{c5,,shutil} oferece várias operações de alto nível em arquivos e coleções de arquivos. Em particular, são fornecidas funções que possuem suporte a cópia e remoção de arquivos. Para operações em arquivos individuais, veja também o módulo @ref{a1,,os}.

@cartouche
@quotation Aviso 
Mesmo as funções de cópia de arquivos de nível mais alto (@ref{a64,,shutil.copy()}, @ref{a65,,shutil.copy2()}) não podem copiar todos os metadados do arquivo.

Nas plataformas POSIX, isso significa que o proprietário e o grupo do arquivo são perdidos, bem como as ACLs. No Mac OS, a bifurcação de recursos e outros metadados não são usados. Isso significa que os recursos serão perdidos e o tipo de arquivo e os códigos do criador não estarão corretos. No Windows, os proprietários de arquivos, ACLs e fluxos de dados alternativos não são copiados.
@end quotation
@end cartouche

@menu
* Operações de diretório e arquivos:: 
* Operações de arquivamento:: 
* Consultando o tamanho do terminal de saída:: 

@end menu

@node Operações de diretório e arquivos,Operações de arquivamento,,shutil — Operações de arquivo de alto nível
@anchor{library/shutil directory-and-files-operations}@anchor{2a1e}@anchor{library/shutil file-operations}@anchor{2a1f}
@subsubsection Operações de diretório e arquivos


@geindex copyfileobj() (no módulo shutil)
@anchor{library/shutil shutil copyfileobj}@anchor{a66}
@deffn {Função} shutil.copyfileobj (fsrc, fdst[, length])

Copia o conteúdo do @ref{1203,,objeto arquivo ou similar} `fsrc' para o objeto arquivo ou similar `fdst'. O número inteiro `length', se fornecido, é o tamanho do buffer. Em particular, um valor negativo `length' significa copiar os dados sem repetir os dados de origem em pedaços; por padrão, os dados são lidos em pedaços para evitar o consumo descontrolado de memória. Observe que, se a posição atual do arquivo do objeto `fsrc' não for 0, apenas o conteúdo da posição atual do arquivo até o final do arquivo será copiado.
@end deffn

@geindex copyfile() (no módulo shutil)
@anchor{library/shutil shutil copyfile}@anchor{a63}
@deffn {Função} shutil.copyfile (src, dst, *, follow_symlinks=True)

Copia o conteúdo (sem metadados) do arquivo chamado `src' para um arquivo chamado `dst' e retorna `dst' da maneira mais eficiente possível. `src' e `dst' são @ref{2a0,,objetos caminho ou similares} ou nomes de caminhos dados como strings.

`dst' deve ser o nome completo do arquivo de destino; veja @ref{a64,,copy()} para uma cópia que aceita um caminho de diretório de destino. Se `src' e `dst' especificarem o mesmo arquivo, @ref{fd2,,SameFileError} será levantada.

O local de destino deve ser gravável; caso contrário, uma exceção @ref{417,,OSError} será levantada. Se o `dst' já existir, ele será substituído. Arquivos especiais como dispositivos de caractere ou bloco e encadeamentos (pipe) não podem ser copiados com esta função.

Se `follow_symlinks' for falso e `src' for um link simbólico, um novo link simbólico será criado em vez de copiar o arquivo `src' para o qual o arquivo aponta.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copyfile} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: @ref{108b,,IOError} costumava ser levantada em vez de @ref{417,,OSError}. Adicionado argumento `follow_symlinks'. Agora retorna `dst'.



Alterado na versão 3.4: Levanta @ref{fd2,,SameFileError} em vez de @ref{fd1,,Error}. Como a primeira é uma subclasse da última, essa alteração é compatível com versões anteriores.



Alterado na versão 3.8: As chamadas de sistema de cópia rápida específicas da plataforma podem ser usadas internamente para copiar o arquivo com mais eficiência. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}.

@end deffn

@geindex SpecialFileError
@anchor{library/shutil shutil SpecialFileError}@anchor{1360}
@deffn {Exceção} shutil.SpecialFileError

Esta exceção é levantada quando @ref{a63,,copyfile()} ou @ref{a33,,copytree()} tenta copiar um pipe nomeado.


Adicionado na versão 2.7.

@end deffn

@geindex SameFileError
@anchor{library/shutil shutil SameFileError}@anchor{fd2}
@deffn {Exceção} shutil.SameFileError

Essa exceção é levantada se a origem e o destino em @ref{a63,,copyfile()} forem o mesmo arquivo.


Adicionado na versão 3.4.

@end deffn

@geindex copymode() (no módulo shutil)
@anchor{library/shutil shutil copymode}@anchor{179f}
@deffn {Função} shutil.copymode (src, dst, *, follow_symlinks=True)

Copia os bits de permissão de `src' para `dst'. O conteúdo do arquivo, o proprietário e o grupo não são afetados. `src' e `dst' são @ref{2a0,,objetos caminho ou similares} ou nomes de caminhos dados como strings. Se `follow_symlinks' for falso e `src' e `dst' forem links simbólicos, @ref{179f,,copymode()} tentará modificar o modo do `dst' (e não o arquivo para o qual ele aponta). Essa funcionalidade não está disponível em todas as plataformas; veja @ref{116d,,copystat()} para mais informações. Se @ref{179f,,copymode()} não puder modificar links simbólicos na plataforma local, e for solicitado a fazê-lo, não fará nada e retornará.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copymode} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: Adicionado argumento `follow_symlinks'.

@end deffn

@geindex copystat() (no módulo shutil)
@anchor{library/shutil shutil copystat}@anchor{116d}
@deffn {Função} shutil.copystat (src, dst, *, follow_symlinks=True)

Copia os bits de permissão, hora do último acesso, hora da última modificação e sinalizadores de `src' para `dst'. No Linux, @ref{116d,,copystat()} também copia os “atributos estendidos” sempre que possível. O conteúdo do arquivo, o proprietário e o grupo não são afetados. `src' e `dst' são @ref{2a0,,objetos caminho ou similares} ou nomes de caminhos dados como strings.

Se `follow_symlinks' for falso e `src' e `dst' se referirem a links simbólicos, @ref{116d,,copystat()} operará nos próprios links simbólicos, e não nos arquivos aos quais os links simbólicos se referem - lendo as informações do link simbólico `src' e gravando as informações no link simbólico `dst'.

@cartouche
@quotation Nota 
Nem todas as plataformas oferecem a capacidade de examinar e modificar links simbólicos. O próprio Python pode dizer qual funcionalidade está disponível localmente.


@itemize *

@item 
Se @code{os.chmod in os.supports_follow_symlinks} for @code{True}, @ref{116d,,copystat()} pode modificar os bits de permissão de um link simbólico.

@item 
Se @code{os.utime in os.supports_follow_symlinks} for @code{True}, @ref{116d,,copystat()} pode modificar as horas da última modificação e do último acesso de um link simbólico.

@item 
Se @code{os.chflags in os.supports_follow_symlinks} for @code{True}, @ref{116d,,copystat()} pode modificar os sinalizadores de um link simbólico. (@code{os.chflags} não está disponível em todas as plataformas.)
@end itemize

Nas plataformas em que algumas ou todas essas funcionalidades não estão disponíveis, quando solicitado a modificar um link simbólico, @ref{116d,,copystat()} copiará tudo o que puder. @ref{116d,,copystat()} nunca retorna falha.

Por favor, veja @ref{1137,,os.supports_follow_symlinks} para mais informações.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copystat} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: Adicionado argumento `follow_symlinks' e suporte a atributos estendidos do Linux.

@end deffn

@geindex copy() (no módulo shutil)
@anchor{library/shutil shutil copy}@anchor{a64}
@deffn {Função} shutil.copy (src, dst, *, follow_symlinks=True)

Copia o arquivo `src' para o arquivo ou diretório `dst'. `src' e `dst' devem ser @ref{2a0,,objetos arquivo ou similares} ou strings. Se `dst' especificar um diretório, o arquivo será copiado para `dst' usando o nome de arquivo base de `src'. Se `dst' especifica um arquivo que já existe, ele será substituído. Retorna o caminho para o arquivo recém-criado.

Se `follow_symlinks' for falso e `src' for um link simbólico, `dst' será criado como um link simbólico. Se `follow_symlinks' for verdadeiro e `src' for um link simbólico, `dst' será uma cópia do arquivo ao qual `src' se refere.

@ref{a64,,copy()} copia os dados do arquivo e o modo de permissão do arquivo (consulte @ref{21b,,os.chmod()}). Outros metadados, como os tempos de criação e modificação do arquivo, não são preservados. Para preservar todos os metadados do arquivo do original, use @ref{a65,,copy2()}.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copyfile} com os argumentos @code{src}, @code{dst}.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copymode} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: Adicionado argumento `follow_symlinks'. Agora retorna o caminho para o arquivo recém-criado.



Alterado na versão 3.8: As chamadas de sistema de cópia rápida específicas da plataforma podem ser usadas internamente para copiar o arquivo com mais eficiência. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}.

@end deffn

@geindex copy2() (no módulo shutil)
@anchor{library/shutil shutil copy2}@anchor{a65}
@deffn {Função} shutil.copy2 (src, dst, *, follow_symlinks=True)

Idêntico a @ref{a64,,copy()}, exceto que @ref{a65,,copy2()} também tenta preservar os metadados do arquivo.

Quando `follow_symlinks' for falso e `src' for um link simbólico, @ref{a65,,copy2()} tenta copiar todos os metadados do link simbólico `src' para o link simbólico `dst' recém-criado. No entanto, essa funcionalidade não está disponível em todas as plataformas. Nas plataformas em que algumas ou todas essas funcionalidades não estão disponíveis, @ref{a65,,copy2()} preservará todos os metadados que puder; @ref{a65,,copy2()} nunca levanta uma exceção porque não pode preservar os metadados do arquivo.

@ref{a65,,copy2()} usa @ref{116d,,copystat()} para copiar os metadados do arquivo. Por favor, veja @ref{116d,,copystat()} para obter mais informações sobre o suporte da plataforma para modificar os metadados do link simbólico.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copyfile} com os argumentos @code{src}, @code{dst}.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copystat} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: Adicionado argumento `follow_symlinks', tenta copiar também atributos estendidos do sistema de arquivos (atualmente apenas no Linux). Agora retorna o caminho para o arquivo recém-criado.



Alterado na versão 3.8: As chamadas de sistema de cópia rápida específicas da plataforma podem ser usadas internamente para copiar o arquivo com mais eficiência. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}.

@end deffn

@geindex ignore_patterns() (no módulo shutil)
@anchor{library/shutil shutil ignore_patterns}@anchor{2a20}
@deffn {Função} shutil.ignore_patterns (*patterns)

Esta função de fábrica cria uma função que pode ser usada como um chamável para o argumento `ignore' de @ref{a33,,copytree()}, ignorando arquivos e diretórios que correspondem a um dos padrões `patterns' de estilo glob fornecidos. Veja o exemplo abaixo.
@end deffn

@geindex copytree() (no módulo shutil)
@anchor{library/shutil shutil copytree}@anchor{a33}
@deffn {Função} shutil.copytree (src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)

Copia recursivamente uma árvore de diretórios inteira com raiz em `src' para um diretório chamado `dst' e retorna o diretório de destino. Todos os diretórios intermediários necessários para conter `dst' também serão criados por padrão.

Permissões e horas dos diretórios são copiados com @ref{116d,,copystat()}, arquivos individuais são copiados usando @ref{a65,,copy2()}.

Se `symlinks' for verdadeiro, os links simbólicos na árvore de origem são representados como links simbólicos na nova árvore e os metadados dos links originais serão copiados na medida do permitido pela plataforma; se falso ou omitido, o conteúdo e os metadados dos arquivos vinculados são copiados para a nova árvore.

Quando `symlinks' for falso, se o arquivo apontado pelo link simbólico não existir, uma exceção será adicionada na lista de erros levantada em uma exceção @ref{fd1,,Error} no final do processo de cópia. Você pode definir o sinalizador opcional `ignore_dangling_symlinks' como true se desejar silenciar esta exceção. Observe que esta opção não tem efeito em plataformas que não possuem suporte a @ref{1133,,os.symlink()}.

Se `ignore' for fornecido, deve ser um chamável que receberá como argumento o diretório que está sendo visitado por @ref{a33,,copytree()}, e uma lista de seu conteúdo, retornada por @ref{1139,,os.listdir()}. Como @ref{a33,,copytree()} é chamada recursivamente, o chamável `ignore' será chamado uma vez para cada diretório que é copiado. O chamável deve retornar uma sequência de nomes de diretório e arquivo em relação ao diretório atual (ou seja, um subconjunto dos itens em seu segundo argumento); esses nomes serão ignorados no processo de cópia. @ref{2a20,,ignore_patterns()} pode ser usado para criar um chamável que ignore nomes com base em padrões de estilo glob.

Se uma ou mais exceções ocorrerem, uma @ref{fd1,,Error} é levantada com uma lista dos motivos.

Se `copy_function' for fornecida, deverá ser um chamável que será usado para copiar cada arquivo. Ele será chamado com o caminho de origem e o caminho de destino como argumentos. Por padrão, @ref{a65,,copy2()} é usada, mas qualquer função que possua suporte à mesma assinatura (como @ref{a64,,copy()}) pode ser usada.

Se `dirs_exist_ok' for false (o padrão) e `dst' já existir, uma @ref{1056,,FileExistsError} será levantada. Se `dirs_exist_ok' for true, a operação de cópia continuará se encontrar diretórios existentes, e os arquivos dentro da árvore `dst' serão sobrescritos pelos arquivos correspondentes da árvore `src'.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.copytree} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.2: Adicionado o argumento `copy_function' para poder fornecer uma função de cópia personalizada. Adicionado o argumento `ignore_dangling_symlinks' para silenciar erros de links simbólicos quando `symlinks' for falso.



Alterado na versão 3.3: Copia metadados quando `symlinks' for falso. Agora, retorna `dst'.



Alterado na versão 3.8: As chamadas de sistema de cópia rápida específicas da plataforma podem ser usadas internamente para copiar o arquivo com mais eficiência. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}.



Alterado na versão 3.8: Adicionado o parâmetro `dirs_exist_ok'.

@end deffn

@geindex rmtree() (no módulo shutil)
@anchor{library/shutil shutil rmtree}@anchor{301}
@deffn {Função} shutil.rmtree (path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None)

@geindex diretório;exclusão

Exclui uma árvore de diretório inteira; `path' deve apontar para um diretório (mas não um link simbólico para um diretório). Se `ignore_errors' for verdadeiro, os erros resultantes de remoções com falha serão ignorados; se falso ou omitido, tais erros são tratados chamando um manipulador especificado por `onexc' ou `onerror' ou, se ambos forem omitidos, exceções são propagadas para o chamador.

Esta função tem suporte a @ref{1129,,caminhos relativos para descritores de diretório}.

@cartouche
@quotation Nota 
Em plataformas que suportam as funções baseadas em descritores de arquivo necessárias, uma versão resistente a ataques de links simbólicos de @ref{301,,rmtree()} é usada por padrão. Em outras plataformas, a implementação @ref{301,,rmtree()} é suscetível a um ataque de link simbólico: dados o tempo e as circunstâncias apropriados, os invasores podem manipular links simbólicos no sistema de arquivos para excluir arquivos que eles não seriam capazes de acessar de outra forma. Os aplicativos podem usar o atributo de função @ref{2a21,,rmtree.avoids_symlink_attacks} para determinar qual caso se aplica.
@end quotation
@end cartouche

Se `onexc' for fornecido, deve ser um chamável que aceite três parâmetros: `function', `path', e `excinfo'.

O primeiro parâmetro, `function', é a função que levantou a exceção; depende da plataforma e da implementação. O segundo parâmetro, `path', será o nome do caminho passado para a `função'. O terceiro parâmetro, `excinfo', é a exceção que foi levantada. Exceções levantadas por `onexc' não serão capturadas.

O descontinuado `onerror' é semelhante ao `onexc', exceto que o terceiro parâmetro que ele recebe é a tupla retornada de @ref{68a,,sys.exc_info()}.


@subsubheading Ver também


@ref{2a22,,exemplo rmtree} para um exemplo de tratamento da remoção de uma árvore de diretórios que contém arquivos somente leitura.


Levanta um @ref{19fa,,evento de auditoria} @code{shutil.rmtree} com os argumentos @code{path}, @code{dir_fd}.


Alterado na versão 3.3: Adicionada uma versão resistente a ataques de link simbólico que é usada automaticamente se a plataforma suportar funções baseadas em descritor de arquivo.



Alterado na versão 3.8: No Windows, não excluirá mais o conteúdo de uma junção de diretório antes de remover a junção.



Alterado na versão 3.11: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.12: Adicionado o parâmetro `onexc', descontinuado `onerror'.



Alterado na versão 3.13: @code{rmtree()} agora ignora exceções @ref{42b,,FileNotFoundError} para todos, exceto o caminho de nível superior. Exceções diferentes de @ref{417,,OSError} e subclasses de @code{OSError} agora são sempre propagadas para o chamador.


@geindex avoids_symlink_attacks (atributo shutil.rmtree)
@anchor{library/shutil shutil rmtree avoids_symlink_attacks}@anchor{2a21}
@deffn {Atributo} rmtree.avoids_symlink_attacks

Indica se a plataforma e implementação atuais fornecem uma versão resistente a ataques de link simbólico de @ref{301,,rmtree()}. Atualmente, isso só é verdade para plataformas que suportam funções de acesso ao diretório baseadas em descritor de arquivo.


Adicionado na versão 3.3.

@end deffn
@end deffn

@geindex move() (no módulo shutil)
@anchor{library/shutil shutil move}@anchor{e82}
@deffn {Função} shutil.move (src, dst, copy_function=copy2)

Move recursivamente um arquivo ou diretório (`src') para outro local e retorna ao destino.

Se `dst' for um diretório existente ou um symlink para um diretório, então `src' é movido para dentro desse diretório. O caminho de destino nesse diretório não deve existir ainda.

Se `dst' já existir, mas não for um diretório, ele poderá ser substituído dependendo da semântica de @ref{1130,,os.rename()}.

Se o destino está no sistema de arquivos atual, então @ref{1130,,os.rename()} é usado. Caso contrário, `src' é copiado para o destino usando `copy_function' e depois removido. No caso de links simbólicos, um novo link simbólico apontando para o destino de `src' será criado como o destino e `src' serão removidos.

Se `copy_function' for fornecido, deve ser um chamável que leva dois argumentos `src' e a destinação, e será usado para copiar `src' para a destinação se @ref{1130,,os.rename()} não puder ser usado. Se a fonte for um diretório, @ref{a33,,copytree()} é chamado, passando `copy_function'. A `copy_function' padrão é @ref{a65,,copy2()}. Usar @ref{a64,,copy()} como `copy_function' permite que a movimentação seja bem-sucedida quando não é possível copiar também os metadados, às custas de não copiar nenhum dos metadados.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.move} com os argumentos @code{src}, @code{dst}.


Alterado na versão 3.3: Adicionada manipulação de links simbólicos explícitos para sistemas de arquivos externos, adaptando-os ao comportamento do GNU @code{mv}. Agora retorna `dst'.



Alterado na versão 3.5: Adicionado o argumento nomeado `copy_function'.



Alterado na versão 3.8: As chamadas de sistema de cópia rápida específicas da plataforma podem ser usadas internamente para copiar o arquivo com mais eficiência. Veja a seção @ref{a67,,Operações de cópia eficientes dependentes da plataforma}.



Alterado na versão 3.9: Aceita um @ref{2a0,,objeto caminho ou similar} para `src' e `dst'.

@end deffn

@geindex disk_usage() (no módulo shutil)
@anchor{library/shutil shutil disk_usage}@anchor{116c}
@deffn {Função} shutil.disk_usage (path)

Retorna estatísticas de uso de disco sobre o caminho fornecido como @ref{64e,,tupla nomeada} com os atributos `total', `used' e `free', que são a quantidade de espaço total, usado e livre, em bytes. `path' pode ser um arquivo ou diretório.

@cartouche
@quotation Nota 
Em sistemas de arquivos Unix, `path' deve apontar para um caminho dentro de uma partição de sistema de arquivos `montada'. Nessas plataformas, o CPython não tenta recuperar informações de uso de disco de sistemas de arquivos não montados.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 3.8: No Windows, `path' pode agora ser um arquivo ou diretório.


@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex chown() (no módulo shutil)
@anchor{library/shutil shutil chown}@anchor{240}
@deffn {Função} shutil.chown (path, user=None, group=None, *, dir_fd=None, follow_symlinks=True)

Altera o proprietário `usuário' e/ou `group' do `path' fornecido.

`user' pode ser um nome de usuário do sistema ou um uid; o mesmo se aplica ao `group'. É necessário pelo menos um argumento.

Veja também @ref{112d,,os.chown()}, a função subjacente.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.chown} com os argumentos @code{path}, @code{user}, @code{group}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.



Alterado na versão 3.13: Adicionados os parâmetros `dir_fd' e `follow_symlinks'.

@end deffn

@geindex which() (no módulo shutil)
@anchor{library/shutil shutil which}@anchor{4b4}
@deffn {Função} shutil.which (cmd, mode=os.F_OK | os.X_OK, path=None)

Retorna o caminho para um executável que seria executado se o `cmd' fornecido fosse chamado. Se nenhum `cmd' for chamado, retorna @code{None}.

`mode' é uma máscara de permissão passada para @ref{112b,,os.access()}, por padrão determinando se o arquivo existe e é executável.

`path' é uma “string @code{PATH}” que especifica os diretórios a serem procurados, delimitados por @ref{1ecc,,os.pathsep}. Quando nenhum `path' é especificado, a variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} é lida de @ref{11f9,,os.environ}, retornando para @ref{1b79,,os.defpath} se não estiver definida.

Se `cmd' contiver um componente de diretório, @code{which()} verificará apenas o caminho especificado diretamente e não pesquisará os diretórios listados em `path' ou na variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} do sistema.

No Windows, o diretório atual é prefixado ao `path' se o `mode' não incluir @code{os.X_OK}. Quando o `mode' inclui @code{os.X_OK}, a API do Windows @code{NeedCurrentDirectoryForExePathW} será consultada para determinar se o diretório atual deve ser prefixado ao `path'. Para evitar consultar o diretório de trabalho atual para executáveis: defina a variável de ambiente @code{NoDefaultCurrentDirectoryInExePath}.

Também no Windows, a variável de ambiente 
@geindex PATHEXT
@geindex variável de ambiente; PATHEXT
@code{PATHEXT} é usada para resolver comandos que podem não incluir uma extensão. Por exemplo, se você chamar @code{shutil.which("python")}, @ref{4b4,,which()} pesquisará @code{PATHEXT} para saber que deve procurar por @code{python.exe} dentro dos diretórios `path'. Por exemplo, no Windows:

@example
>>> shutil.which("python")
'C:\\Python33\\python.EXE'
@end example

Isso também se aplica quando `cmd' é um caminho que contém um componente de diretório:

@example
>>> shutil.which("C:\\Python33\\python")
'C:\\Python33\\python.EXE'
@end example


Adicionado na versão 3.3.



Alterado na versão 3.8: O tipo @ref{1c2,,bytes} é agora aceitado. Se o tipo de `cmd' é @ref{1c2,,bytes}, o tipo resultante também é @ref{1c2,,bytes}.



Alterado na versão 3.12: No Windows, o diretório atual não é mais adicionado ao caminho de pesquisa se `mode' incluir @code{os.X_OK} e WinAPI @code{NeedCurrentDirectoryForExePathW(cmd)} for falso, caso contrário, o diretório atual será adicionado mesmo se já estiver no caminho de pesquisa; @code{PATHEXT} agora é usado mesmo quando `cmd' inclui um componente de diretório ou termina com uma extensão que está em @code{PATHEXT}; e nomes de arquivos que não têm extensão agora podem ser encontrados.

@end deffn

@geindex Error
@anchor{library/shutil shutil Error}@anchor{fd1}
@deffn {Exceção} shutil.Error

Esta exceção coleta exceções que são levantadas durante uma operação de vários arquivos. Para @ref{a33,,copytree()}, o argumento de exceção é uma lista de tuplas de 3 elementos (`srcname', `dstname', `exception').
@end deffn

@menu
* Operações de cópia eficientes dependentes da plataforma:: 
* Exemplo de copytree:: 
* exemplo rmtree:: 

@end menu

@node Operações de cópia eficientes dependentes da plataforma,Exemplo de copytree,,Operações de diretório e arquivos
@anchor{library/shutil platform-dependent-efficient-copy-operations}@anchor{2a23}@anchor{library/shutil shutil-platform-dependent-efficient-copy-operations}@anchor{a67}
@subsubsection Operações de cópia eficientes dependentes da plataforma


A partir do Python 3.8, todas as funções envolvendo uma cópia de arquivo (@ref{a63,,copyfile()}, @ref{a64,,copy()}, @ref{a65,,copy2()}, @ref{a33,,copytree()} e @ref{e82,,move()} ) podem usar chamadas do sistema de “cópia rápida” específicas da plataforma para copiar o arquivo de forma mais eficiente (veja bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}). “cópia rápida” significa que a operação de cópia ocorre dentro do kernel, evitando o uso de buffers de espaço de usuário em Python como em “@code{outfd.write(infd.read())}”.

No macOS, fcopyfile@footnote{http://www.manpagez.com/man/3/copyfile/} é usado para copiar o conteúdo do arquivo (não metadados).

No Linux, @ref{b21,,os.sendfile()} é usado.

No Windows, @ref{a63,,shutil.copyfile()} usa um tamanho de buffer padrão maior (1 MiB ao invés de 64 KiB) e uma variante de @ref{a66,,shutil.copyfileobj()} baseada em @ref{2eb,,memoryview()} é usada.

Se a operação de cópia rápida falhar e nenhum dado foi escrito no arquivo de destino, o shutil irá silenciosamente voltar a usar a função menos eficiente @ref{a66,,copyfileobj()} internamente.


Alterado na versão 3.8.


@node Exemplo de copytree,exemplo rmtree,Operações de cópia eficientes dependentes da plataforma,Operações de diretório e arquivos
@anchor{library/shutil copytree-example}@anchor{2a24}@anchor{library/shutil shutil-copytree-example}@anchor{2a25}
@subsubsection Exemplo de copytree


Um exemplo que usa o auxiliar @ref{2a20,,ignore_patterns()}:

@example
from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))
@end example

Isso irá copiar tudo, exceto os arquivos @code{.pyc} e arquivos ou diretórios cujo nome começa com @code{tmp}.

Outro exemplo que usa o argumento `ignore' para adicionar uma chamada de registro:

@example
from shutil import copytree
import logging

def _logpath(path, names):
    logging.info('Working in %s', path)
    return []   # nada será ignorado

copytree(source, destination, ignore=_logpath)
@end example

@node exemplo rmtree,,Exemplo de copytree,Operações de diretório e arquivos
@anchor{library/shutil rmtree-example}@anchor{2a26}@anchor{library/shutil shutil-rmtree-example}@anchor{2a22}
@subsubsection exemplo rmtree


Este exemplo mostra como remover uma árvore de diretório no Windows onde alguns dos arquivos têm seu conjunto de bits somente leitura. Ele usa a função de retorno onexc para limpar o bit somente leitura e tentar remover novamente. Qualquer falha subsequente se propagará.

@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 Operações de arquivamento,Consultando o tamanho do terminal de saída,Operações de diretório e arquivos,shutil — Operações de arquivo de alto nível
@anchor{library/shutil archiving-operations}@anchor{1259}@anchor{library/shutil id1}@anchor{2a27}
@subsubsection Operações de arquivamento



Adicionado na versão 3.2.



Alterado na versão 3.5: Adicionado suporte ao formato `xztar'.


Utilitários de alto nível para criar e ler arquivos compactados e arquivados também são fornecidos. Eles contam com os módulos @ref{131,,zipfile} e @ref{de,,tarfile}.

@geindex make_archive() (no módulo shutil)
@anchor{library/shutil shutil make_archive}@anchor{4b3}
@deffn {Função} shutil.make_archive (base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

Cria um arquivo compactado (como zip ou tar) e retorna seu nome.

`base_name' é o nome do arquivo a ser criado, incluindo o caminho, menos qualquer extensão específica do formato.

`format' é o formato do arquivo: um de “zip” (se o módulo @ref{133,,zlib} estiver disponível), “tar”, “gztar” (se o módulo @ref{133,,zlib} estiver disponível), “bztar” (se o módulo @ref{13,,bz2} estiver disponível) ou “xztar” (se o módulo @ref{8a,,lzma} estiver disponível).

`root_dir' é um diretório que será o diretório raiz do arquivo, todos os caminhos no arquivo serão relativos a ele; por exemplo, normalmente chdir em `root_dir' antes de criar o arquivo.

`base_dir' é o diretório de onde iniciamos o arquivamento; ou seja, `base_dir' será o prefixo comum de todos os arquivos e diretórios no arquivo. `base_dir' deve ser fornecido em relação a `root_dir'. Veja @ref{2a28,,Exemplo de arquivamento com base_dir} para como usar `base_dir' e `root_dir' juntos.

`root_dir' e `base_dir' têm com padrão o diretório atual.

Se `dry_run' for verdadeiro, nenhum arquivo é criado, mas as operações que seriam executadas são registradas no `logger'.

`owner' e `group' são usados ao criar um arquivo tar. Por padrão, usa o proprietário e grupo atuais.

`logger' deve ser um objeto compatível com a 
@geindex Propostas de Melhorias do Python; PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/}, geralmente uma instância de @ref{b64,,logging.Logger}.

O argumento `verbose' não é usado e foi descontinuado.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.make_archive} com os argumentos @code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}.

@cartouche
@quotation Nota 
Esta função não é segura para thread quando arquivadores personalizados registrados com @ref{2a29,,register_archive_format()} não suportam o argumento `root_dir'. Neste caso, ele altera temporariamente o diretório de trabalho atual do processo para `root_dir' para executar o arquivamento.
@end quotation
@end cartouche


Alterado na versão 3.8: O formato pax moderno (POSIX.1-2001) agora é usado em vez do formato GNU legado para arquivos criados com @code{format="tar"}.



Alterado na versão 3.10.6: Esta função agora é segura para thread durante a criação de arquivos @code{.zip} e tar padrão.

@end deffn

@geindex get_archive_formats() (no módulo shutil)
@anchor{library/shutil shutil get_archive_formats}@anchor{2a2a}
@deffn {Função} shutil.get_archive_formats ()

Retorna uma lista de formatos suportados para arquivamento. Cada elemento da sequência retornada é uma tupla @code{(nome, descrição)}.

Por padrão, @ref{c5,,shutil} fornece estes formatos:


@itemize -

@item 
`zip': arquivo ZIP (se o módulo @ref{133,,zlib} estiver disponível).

@item 
`tar': Arquivo tar não compactado. Usa o formato POSIX.1-2001 pax para novos arquivos.

@item 
`gztar': arquivo tar compactado com gzip (se o módulo @ref{133,,zlib} estiver disponível).

@item 
`bztar': arquivo tar compactado com bzip2 (se o módulo @ref{13,,bz2} estiver disponível).

@item 
`xztar': Arquivo tar compactado com xz (se o módulo @ref{8a,,lzma} estiver disponível).
@end itemize

Você pode registrar novos formatos ou fornecer seu próprio arquivador para quaisquer formatos existentes, usando @ref{2a29,,register_archive_format()}.
@end deffn

@geindex register_archive_format() (no módulo shutil)
@anchor{library/shutil shutil register_archive_format}@anchor{2a29}
@deffn {Função} shutil.register_archive_format (name, function[, extra_args[, description]])

Registra um arquivador para o formato `name'.

`function' é o chamável que será usado para desempacotar arquivos. O chamável receberá o `base_name' do arquivo a ser criado, seguido pelo `base_dir' (cujo padrão é @ref{2990,,os.curdir}) para iniciar o arquivamento. Outros argumentos são passados como argumentos nomeados `owner', `group', `dry_run' e `logger' (como passado em @ref{4b3,,make_archive()}).

Se `function' tiver o atributo personalizado @code{function.supports_root_dir} definido como @code{True}, o argumento `root_dir' será passado como um argumento nomeado. Caso contrário, o diretório de trabalho atual do processo será temporariamente alterado para `root_dir' antes de chamar `function'. Nesse caso, @ref{4b3,,make_archive()} não é segura para thread.

Se fornecido, `extra_args' é uma sequência de pares @code{(nome, valor)} que serão usados como argumentos nomeados extras quando o arquivador chamável for usado.

`description' é usado por @ref{2a2a,,get_archive_formats()} que retorna a lista de arquivadores. O padrão é uma string vazia.


Alterado na versão 3.12: Adicionado suporte para funções que suportam o argumento `root_dir'.

@end deffn

@geindex unregister_archive_format() (no módulo shutil)
@anchor{library/shutil shutil unregister_archive_format}@anchor{2a2b}
@deffn {Função} shutil.unregister_archive_format (name)

Remove o formato de arquivo `name' da lista de formatos suportados.
@end deffn

@geindex unpack_archive() (no módulo shutil)
@anchor{library/shutil shutil unpack_archive}@anchor{46b}
@deffn {Função} shutil.unpack_archive (filename[, extract_dir[, format[, filter]]])

Desempacota um arquivo. `filename' é o caminho completo do arquivo.

`extract_dir' é o nome do diretório de destino onde o arquivo é desempacotado. Se não for fornecido, o diretório de trabalho atual será usado.

`format' é o formato do arquivo: um de “zip”, “tar”, “gztar”, “bztar” ou “xztar”. Ou qualquer outro formato registrado com @ref{2a2c,,register_unpack_format()}. Se não for fornecido, @ref{46b,,unpack_archive()} irá usar a extensão do nome do arquivo e ver se um desempacotador foi registrado para essa extensão. Caso nenhum seja encontrado, uma @ref{202,,ValueError} é levantada.

O argumento somente-nomeado `filter' é passado para a função de desempacotamento subjacente. Para arquivos zip, `filter' não é aceito. Para arquivos tar, é recomendado defini-lo como @code{'data'}, a menos que esteja usando recursos específicos para tar e sistemas de arquivos do tipo UNIX. (Veja @ref{46c,,Filtros de extração} para detalhes.) O filtro @code{'data'} se tornará o padrão para arquivos tar no Python 3.14.

Levanta um @ref{19fa,,evento de auditoria} @code{shutil.unpack_archive} com os argumentos @code{filename}, @code{extract_dir}, @code{format}.

@cartouche
@quotation Aviso 
Nunca extrai arquivos de fontes não confiáveis sem inspeção prévia. É possível que arquivos sejam criados fora do caminho especificado no argumento `extract_dir', por exemplo, membros que têm nomes de arquivo absolutos começando com “/” ou nomes de arquivo com dois pontos “..”.
@end quotation
@end cartouche


Alterado na versão 3.7: Aceita um @ref{2a0,,objeto caminho ou similar} para `filename' e `extract_dir'.



Alterado na versão 3.12: Adicionado o argumento `filter'.

@end deffn

@geindex register_unpack_format() (no módulo shutil)
@anchor{library/shutil shutil register_unpack_format}@anchor{2a2c}
@deffn {Função} shutil.register_unpack_format (name, extensions, function[, extra_args[, description]])

Registra um formato de desempacotamento. `name' é o nome do formato e `extensions' é uma lista de extensões correspondentes ao formato, como @code{.zip} para arquivos Zip.

`function' é o chamável que será usado para desempacotar arquivos. O chamável receberá:


@itemize -

@item 
o caminho do arquivo, como argumento posicional;

@item 
o diretório para o qual o arquivo deve ser extraído, como um argumento posicional;

@item 
possivelmente um argumento nomeado `filter', se foi dado a @ref{46b,,unpack_archive()};

@item 
argumentos nomeados adicionais, especificados por `extra_args' como uma sequência de tuplas @code{(nome, valor)}.
@end itemize

`description' pode ser fornecido para descrever o formato e será devolvido pela função @ref{2a2d,,get_unpack_formats()}.
@end deffn

@geindex unregister_unpack_format() (no módulo shutil)
@anchor{library/shutil shutil unregister_unpack_format}@anchor{2a2e}
@deffn {Função} shutil.unregister_unpack_format (name)

Cancela o registro de um formato de desempacotamento. `name' é o nome do formato.
@end deffn

@geindex get_unpack_formats() (no módulo shutil)
@anchor{library/shutil shutil get_unpack_formats}@anchor{2a2d}
@deffn {Função} shutil.get_unpack_formats ()

Retorna uma lista de todos os formatos registrados para desempacotamento. Cada elemento da sequência retornada é uma tupla @code{(name, extensions, description)}.

Por padrão, @ref{c5,,shutil} fornece estes formatos:


@itemize -

@item 
`zip': arquivo ZIP (desempacotar arquivos compactados funciona apenas se o módulo correspondente estiver disponível).

@item 
`tar': arquivo tar não comprimido.

@item 
`gztar': arquivo tar compactado com gzip (se o módulo @ref{133,,zlib} estiver disponível).

@item 
`bztar': arquivo tar compactado com bzip2 (se o módulo @ref{13,,bz2} estiver disponível).

@item 
`xztar': Arquivo tar compactado com xz (se o módulo @ref{8a,,lzma} estiver disponível).
@end itemize

Você pode registrar novos formatos ou fornecer seu próprio desempacotador para quaisquer formatos existentes, usando @ref{2a2c,,register_unpack_format()}.
@end deffn

@menu
* Exemplo de arquivo:: 
* Exemplo de arquivamento com base_dir:: 

@end menu

@node Exemplo de arquivo,Exemplo de arquivamento com base_dir,,Operações de arquivamento
@anchor{library/shutil archiving-example}@anchor{2a2f}@anchor{library/shutil shutil-archiving-example}@anchor{2a30}
@subsubsection Exemplo de arquivo


Neste exemplo, criamos um arquivo tar compactado com gzip contendo todos os arquivos encontrados no diretório @code{.ssh} do usuário:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'meuarquivo'))
>>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
>>> make_archive(archive_name, 'gztar', root_dir)
'/Users/tarek/meuarquivo.tar.gz'
@end example

O arquivo resultante contém:

@example
$ tar -tzvf /Users/tarek/meuarquivo.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 Exemplo de arquivamento com base_dir,,Exemplo de arquivo,Operações de arquivamento
@anchor{library/shutil archiving-example-with-base-dir}@anchor{2a31}@anchor{library/shutil shutil-archiving-example-with-basedir}@anchor{2a28}
@subsubsection Exemplo de arquivamento com `base_dir'


Neste exemplo, semelhante ao @ref{2a30,,acima}, mostramos como usar @ref{4b3,,make_archive()}, mas desta vez com o uso de `base_dir'. Agora temos a seguinte estrutura de diretório:

@example
$ tree tmp
tmp
└── root
    └── estrutura
        ├── conteudo
            └── por_favor_adicionar.txt
        └── nao_adicionar.txt
@end example

No arquivo final, @code{please_add.txt} deve ser incluído, mas @code{do_not_add.txt} não deve. Portanto, usamos o seguinte:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'meuarquivo'))
>>> make_archive(
...     archive_name,
...     'tar',
...     root_dir='tmp/root',
...     base_dir='estrutura/conteudo',
... )
'/Users/tarek/meu_arquivo.tar'
@end example

Listar os arquivos no arquivo resultante nos dá:

@example
$ python -m tarfile -l /Users/tarek/meuarquivo.tar
estrutura/conteudo/
estrutura/conteudo/por_favor_adicionar.txt
@end example

@node Consultando o tamanho do terminal de saída,,Operações de arquivamento,shutil — Operações de arquivo de alto nível
@anchor{library/shutil querying-the-size-of-the-output-terminal}@anchor{2a32}
@subsubsection Consultando o tamanho do terminal de saída


@geindex get_terminal_size() (no módulo shutil)
@anchor{library/shutil shutil get_terminal_size}@anchor{1142}
@deffn {Função} shutil.get_terminal_size (fallback=(columns, lines))

Obtém o tamanho da janela do terminal.

Para cada uma das duas dimensões, a variável de ambiente, @code{COLUMNS} e @code{LINES} respectivamente, é verificada. Se a variável estiver definida e o valor for um número inteiro positivo, ela será usada.

Quando @code{COLUMNS} ou @code{LINES} não está definida, que é o caso comum, o terminal conectado a @ref{2a33,,sys.__stdout__} é consultado invocando @ref{1141,,os.get_terminal_size()}.

Se o tamanho do terminal não pode ser consultado com sucesso, ou porque o sistema não tem suporte a consultas, ou porque não estamos conectados a um terminal, o valor dado no parâmetro @code{fallback} é usado. O padrão de @code{fallback} é @code{(80, 24)}, que é o tamanho padrão usado por muitos emuladores de terminal.

O valor retornado é uma tupla nomeada do tipo @ref{2a34,,os.terminal_size}.

Veja também: The Single UNIX Specification, Versão 2, Other Environment Variables@footnote{https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003}.


Adicionado na versão 3.3.



Alterado na versão 3.11: Os valores @code{fallback} também são usados se @ref{1141,,os.get_terminal_size()} retornar zeros.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{a1,,os}

Interfaces do sistema operacional, incluindo funções para trabalhar com arquivos num nível inferior a @ref{1203,,objetos arquivos} do Python.

@item Módulo @ref{7f,,io}

A biblioteca embutida de E/S do Python, incluindo as classes abstratas e algumas classes concretas, como E/S de arquivos.

@item Função embutida @ref{51c,,open()}

A maneira padrão de abrir arquivos para ler e escrever em Python.
@end table


@node Persistência de Dados,Compressão de Dados e Arquivamento,Acesso a arquivos e diretórios,A Biblioteca Padrão do Python
@anchor{library/persistence doc}@anchor{2a35}@anchor{library/persistence data-persistence}@anchor{2a36}@anchor{library/persistence persistence}@anchor{2a37}@anchor{library/persistence translation-repo}@anchor{2a38}
@section Persistência de Dados


Os módulos descritos neste capítulo possuem suporte ao armazenamento de dados do Python em um formato persistente no disco. Os módulos @ref{a6,,pickle} e @ref{8d,,marshal} podem transformar muitos tipos de dados do Python em um fluxo de bytes e então recriar os objetos a partir dos bytes. Os vários módulos relacionados ao DBM possuem suporte a uma família de formatos de arquivo baseados em hash que armazenam um mapeamento de strings para outras strings.

A lista de módulos descritos neste capítulo é:

@menu
* pickle — Serialização de objetos Python:: 
* copyreg — Registra funções de suporte pickle:: 
* shelve — Python object persistence:: 
* marshal — Serialização interna de objetos Python:: 
* dbm — Interfaces para “banco de dados” Unix:: 
* sqlite3 —- interface DB-API 2.0 interface para bancos de dados SQLite: sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite. 

@end menu

@node pickle — Serialização de objetos Python,copyreg — Registra funções de suporte pickle,,Persistência de Dados
@anchor{library/pickle doc}@anchor{2a39}@anchor{library/pickle module-pickle}@anchor{a6}@anchor{library/pickle pickle-python-object-serialization}@anchor{2a3a}
@subsection @code{pickle} — Serialização de objetos Python


@geindex module; pickle

`Código-fonte:' Lib/pickle.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pickle.py}

@geindex persistência
@geindex persistente;objetos
@geindex serialização;objetos
@geindex marshalling;objetos
@geindex flattening;objetos
@geindex pickling;objetos


__________________________________________________________________


O módulo @ref{a6,,pickle} implementa protocolos binários para serializar e desserializar uma estrutura de objeto Python. `“Pickling”' é o processo pelo qual uma hierarquia de objetos Python é convertida em um fluxo de bytes, e `“unpickling”' é a operação inversa, em que um fluxo de bytes (de um @ref{1e0e,,arquivo binário} ou @ref{d4f,,objeto bytes ou similar}) é convertido de volta em uma hierarquia de objetos. Pickling (e unpickling) com pickle é alternativamente conhecido como “serialização”, “marshalling” @footnote{
Não confunda isso com o módulo @ref{8d,,marshal}
} ou “flattening”; no entanto, para evitar confusão, usa-se is termos “pickling” e “unpickling”. Nesta documentação traduzida, usaremos “serialização com pickle” e “desserialização com pickle”, respectivamente.

@cartouche
@quotation Aviso 
O módulo @code{pickle} `não é seguro'. Desserialize com pickle apenas os dados em que você confia.

É possível construir dados maliciosos em pickle que irão `executar código arbitrário durante o processo de desserialização com pickle'. Nunca desserialize com pickle os dados que possam vir de uma fonte não confiável ou que possam ter sido adulterados.

Considere assinar dados com @ref{6a,,hmac} se você precisar garantir que eles não foram adulterados.

Formatos de serialização mais seguros como @ref{82,,json} podem ser mais apropriados se você estiver processando dados não confiáveis. Vejo @ref{2a3b,,Comparação com json}.
@end quotation
@end cartouche

@menu
* Relacionamento com outros módulos Python:: 
* Formato de fluxo de dados:: 
* Interface do módulo:: 
* O que pode ser serializado e desserializado com pickle?:: 
* Serializando com pickle instâncias de classes:: 
* Redução personalizada para tipos@comma{} funções e outros objetos: Redução personalizada para tipos funções e outros objetos. 
* Buffers fora da banda:: 
* Restringindo globais:: 
* Desempenho: Desempenho<2>. 
* Exemplos: Exemplos<7>. 

@end menu

@node Relacionamento com outros módulos Python,Formato de fluxo de dados,,pickle — Serialização de objetos Python
@anchor{library/pickle relationship-to-other-python-modules}@anchor{2a3c}
@subsubsection Relacionamento com outros módulos Python


@menu
* Comparação com marshal:: 
* Comparação com json:: 

@end menu

@node Comparação com marshal,Comparação com json,,Relacionamento com outros módulos Python
@anchor{library/pickle comparison-with-marshal}@anchor{2a3d}
@subsubsection Comparação com @code{marshal}


Python tem um módulo de serialização mais primitivo chamado @ref{8d,,marshal}, mas em geral @ref{a6,,pickle} deve ser sempre a forma preferida de serializar objetos Python. @ref{8d,,marshal} existe principalmente para oferecer suporte a arquivos @code{.pyc} do Python.

O módulo @ref{a6,,pickle} difere do @ref{8d,,marshal} de várias maneiras significativas:


@itemize *

@item 
@ref{8d,,marshal} não pode ser usado para serializar classes definidas pelo usuário e suas instâncias. @ref{a6,,pickle} pode salvar e restaurar instâncias de classe de forma transparente, no entanto, a definição de classe deve ser importável e viver no mesmo módulo de quando o objeto foi armazenado.

@item 
O formato de serialização do @ref{8d,,marshal} não tem garantia de portabilidade entre as versões do Python. Como sua principal tarefa em vida é oferecer suporte a arquivos @code{.pyc}, os implementadores do Python se reservam o direito de alterar o formato de serialização de maneiras não compatíveis com versões anteriores, caso haja necessidade. O formato de serialização do @ref{a6,,pickle} tem a garantia de ser compatível com versões anteriores em todas as versões do Python, desde que um protocolo pickle compatível seja escolhido e o código de serialização e desserialização com pickle lide com diferenças de tipo Python 2 a Python 3 se seus dados estiverem cruzando aquele limite de mudança de linguagem exclusivo.
@end itemize

@node Comparação com json,,Comparação com marshal,Relacionamento com outros módulos Python
@anchor{library/pickle comparison-with-json}@anchor{2a3b}@anchor{library/pickle id2}@anchor{2a3e}
@subsubsection Comparação com @code{json}


Existem diferenças fundamentais entre os protocolos pickle e JSON (JavaScript Object Notation)@footnote{https://json.org}:


@itemize *

@item 
JSON é um formato de serialização de texto (ele produz texto unicode, embora na maioria das vezes seja codificado para @code{utf-8}), enquanto pickle é um formato de serialização binário;

@item 
JSON é legível por humanos, enquanto pickle não é;

@item 
JSON é interoperável e amplamente usado fora do ecossistema Python, enquanto pickle é específico para Python;

@item 
JSON, por padrão, só pode representar um subconjunto dos tipos embutidos do Python, e nenhuma classe personalizada; pickle pode representar um número extremamente grande de tipos Python (muitos deles automaticamente, pelo uso inteligente dos recursos de introspecção do Python; casos complexos podem ser resolvidos implementando @ref{2a3f,,APIs de objetos específicos});

@item 
Ao contrário do pickle, a desserialização não confiável do JSON não cria, por si só, uma vulnerabilidade de execução de código arbitrário.
@end itemize


@subsubheading Ver também


O módulo @ref{82,,json}: um módulo de biblioteca padrão que permite a serialização e desserialização JSON.


@node Formato de fluxo de dados,Interface do módulo,Relacionamento com outros módulos Python,pickle — Serialização de objetos Python
@anchor{library/pickle data-stream-format}@anchor{2a40}@anchor{library/pickle pickle-protocols}@anchor{ce1}
@subsubsection Formato de fluxo de dados


@geindex External Data Representation

O formato de dados usado pelo @ref{a6,,pickle} é específico do Python. Isso tem a vantagem de não haver restrições impostas por padrões externos, como JSON (que não pode representar o compartilhamento de ponteiros); no entanto, isso significa que programas não Python podem não ser capazes de reconstruir objetos Python serializados com pickle.

Por padrão, o formato de dados do @ref{a6,,pickle} usa uma representação binária relativamente compacta. Se você precisa de características de tamanho ideal, pode com eficiência @ref{2a41,,comprimir} dados processados com pickle.

O módulo @ref{a7,,pickletools} contém ferramentas para analisar fluxos de dados gerados por @ref{a6,,pickle}. O código-fonte do @ref{a7,,pickletools} tem extensos comentários sobre códigos de operações usados por protocolos de pickle.

Existem atualmente 6 protocolos diferentes que podem ser usados para a serialização com pickle. Quanto mais alto o protocolo usado, mais recente é a versão do Python necessária para ler o pickle produzido.


@itemize *

@item 
A versão 0 do protocolo é o protocolo original “legível por humanos” e é compatível com versões anteriores do Python.

@item 
A versão 1 do protocolo é um formato binário antigo que também é compatível com versões anteriores do Python.

@item 
A versão 2 do protocolo foi introduzida no Python 2.3. Ela fornece uma serialização com pickle muito mais eficiente de @ref{2a42,,classes estilo novo}. Consulte 
@geindex Propostas de Melhorias do Python; PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} para obter informações sobre as melhorias trazidas pelo protocolo 2.

@item 
A versão 3 do protocolo foi adicionada ao Python 3.0. Ela tem suporte explícito a objetos @ref{1c2,,bytes} e não é possível desserializar com pickle a partir do Python 2.x. Este era o protocolo padrão no Python 3.0–3.7.

@item 
A versão 4 do protocolo foi adicionada ao Python 3.4. Ela adiciona suporte para objetos muito grandes, serialização com pickle de mais tipos de objetos e algumas otimizações de formato de dados. É o protocolo padrão a partir do Python 3.8. Consulte 
@geindex Propostas de Melhorias do Python; PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/} para obter informações sobre as melhorias trazidas pelo protocolo 4.

@item 
A versão 5 do protocolo foi adicionada ao Python 3.8. Ela adiciona suporte a dados fora da banda e aumento de velocidade para dados dentro da banda. Consulte 
@geindex Propostas de Melhorias do Python; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} para obter informações sobre as melhorias trazidas pelo protocolo 5.
@end itemize

@cartouche
@quotation Nota 
A serialização é uma noção mais primitiva do que a persistência; embora o @ref{a6,,pickle} leia e escreva objetos arquivo, ele não lida com a questão de nomear objetos persistentes, nem a questão (ainda mais complicada) de acesso simultâneo a objetos persistentes. O módulo @ref{a6,,pickle} pode transformar um objeto complexo em um fluxo de bytes e pode transformar o fluxo de bytes em um objeto com a mesma estrutura interna. Talvez a coisa mais óbvia a fazer com esses fluxos de bytes seja escrevê-los em um arquivo, mas também é concebível enviá-los através de uma rede ou armazená-los em um banco de dados. O módulo @ref{c3,,shelve} fornece uma interface simples para serializar e desserializar com pickle os objetos em arquivos de banco de dados no estilo DBM.
@end quotation
@end cartouche

@node Interface do módulo,O que pode ser serializado e desserializado com pickle?,Formato de fluxo de dados,pickle — Serialização de objetos Python
@anchor{library/pickle module-interface}@anchor{2a43}
@subsubsection Interface do módulo


Para serializar uma hierarquia de objeto, você simplesmente chama a função @ref{14ec,,dumps()}. Da mesma forma, para desserializar um fluxo de dados, você chama a função @ref{d33,,loads()}. No entanto, se você quiser mais controle sobre a serialização e desserialização, pode criar um objeto @ref{a28,,Pickler} ou @ref{159f,,Unpickler}, respectivamente.

O módulo @ref{a6,,pickle} fornece as seguintes constantes:

@geindex HIGHEST_PROTOCOL (no módulo pickle)
@anchor{library/pickle pickle HIGHEST_PROTOCOL}@anchor{14ed}
@deffn {Dado} pickle.HIGHEST_PROTOCOL

Um inteiro, a mais alta @ref{ce1,,versão de protocolo} disponível. Este valor pode ser passado como um valor de `protocol' para as funções @ref{2a44,,dump()} e @ref{14ec,,dumps()}, bem como o construtor de @ref{a28,,Pickler}.
@end deffn

@geindex DEFAULT_PROTOCOL (no módulo pickle)
@anchor{library/pickle pickle DEFAULT_PROTOCOL}@anchor{831}
@deffn {Dado} pickle.DEFAULT_PROTOCOL

Um inteiro, a @ref{ce1,,versão de protocolo} padrão usada para a serialização com pickle. Pode ser menor que @ref{14ed,,HIGHEST_PROTOCOL}. Atualmente, o protocolo padrão é 4, introduzido pela primeira vez no Python 3.4 e incompatível com as versões anteriores.


Alterado na versão 3.0: O protocolo padrão é 3.



Alterado na versão 3.8: O protocolo padrão é 4.

@end deffn

O módulo @ref{a6,,pickle} fornece as seguintes funções para tornar o processo de serialização com pickle mais conveniente:

@geindex dump() (no módulo pickle)
@anchor{library/pickle pickle dump}@anchor{2a44}
@deffn {Função} pickle.dump (obj, file, protocol=None, *, fix_imports=True, buffer_callback=None)

Escreve a representação após a serialização com pickle do objeto `obj' no @ref{1203,,objeto arquivo} aberto `file'. Isso é equivalente a @code{Pickler(file, protocol).dump(obj)}.

Os argumentos `file', `protocol', `fix_imports' e `buffer_callback' têm o mesmo sentido que no construtor de @ref{a28,,Pickler}.


Alterado na versão 3.8: O argumento `buffer_callback' foi adicionado.

@end deffn

@geindex dumps() (no módulo pickle)
@anchor{library/pickle pickle dumps}@anchor{14ec}
@deffn {Função} pickle.dumps (obj, protocol=None, *, fix_imports=True, buffer_callback=None)

Retorna a representação em após a serialização com pickle do objeto `obj' como um objeto @ref{1c2,,bytes}, ao invés de escrevê-lo em um arquivo.

Os argumentos `protocol', `fix_imports' e `buffer_callback' têm o mesmo sentido que no construtor de @ref{a28,,Pickler}.


Alterado na versão 3.8: O argumento `buffer_callback' foi adicionado.

@end deffn

@geindex load() (no módulo pickle)
@anchor{library/pickle pickle load}@anchor{d32}
@deffn {Função} pickle.load (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Lê a representação serializada com pickle de um objeto a partir de @ref{1203,,objeto arquivo} aberto `file' e retorna a hierarquia de objeto reconstituído especificada nele. Isso é equivalente a @code{Unpickler(file).load()}.

A versão do protocolo pickle é detectada automaticamente, portanto, nenhum argumento de protocolo é necessário. Bytes após a representação serializada com pickle do objeto são ignorados.

Os argumentos `file', `fix_imports', `encoding', `errors', `strict' e `buffers' têm o mesmo significado que no construtor construtor @ref{159f,,Unpickler}.


Alterado na versão 3.8: O argumento `buffers' foi adicionado.

@end deffn

@geindex loads() (no módulo pickle)
@anchor{library/pickle pickle loads}@anchor{d33}
@deffn {Função} pickle.loads (data, /, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Retorna a hierarquia de objeto reconstituído da representação serializada com pickle `data' de um objeto. `data' deve ser um @ref{d4f,,objeto bytes ou similar}.

A versão do protocolo pickle é detectada automaticamente, portanto, nenhum argumento de protocolo é necessário. Bytes após a representação serializada com pickle do objeto são ignorados.

Os argumentos `fix_imports', `encoding', `errors', `strict' e `buffers' têm o mesmo significado que no construtor construtor @ref{159f,,Unpickler}.


Alterado na versão 3.8: O argumento `buffers' foi adicionado.

@end deffn

O módulo @ref{a6,,pickle} define três exceções:

@geindex PickleError
@anchor{library/pickle pickle PickleError}@anchor{2a45}
@deffn {Exceção} pickle.PickleError

Classe base comum para as outras exceções de serialização com pickle. Herda de @ref{9e2,,Exception}.
@end deffn

@geindex PicklingError
@anchor{library/pickle pickle PicklingError}@anchor{2a46}
@deffn {Exceção} pickle.PicklingError

Erro levantado quando um objeto não serializável com pickle é encontrado por @ref{a28,,Pickler}. Herda de @ref{2a45,,PickleError}.

Consulte @ref{2a47,,O que pode ser serializado e desserializado com pickle?} para saber quais tipos de objetos podem ser serializados com pickle.
@end deffn

@geindex UnpicklingError
@anchor{library/pickle pickle UnpicklingError}@anchor{2a48}
@deffn {Exceção} pickle.UnpicklingError

Erro levantado quando há um problema ao desserializar com pickle um objeto, como dados corrompidos ou violação de segurança. Herda de @ref{2a45,,PickleError}.

Observe que outras exceções também podem ser levantadas durante a desserialização com pickle, incluindo (mas não necessariamente limitado a) AttributeError, EOFError, ImportError e IndexError.
@end deffn

O módulo @ref{a6,,pickle} exporta três classes, @ref{a28,,Pickler}, @ref{159f,,Unpickler} e @ref{15a2,,PickleBuffer}:

@geindex Pickler (classe em pickle)
@anchor{library/pickle pickle Pickler}@anchor{a28}
@deffn {Classe} pickle.Pickler (file, protocol=None, *, fix_imports=True, buffer_callback=None)

Isso leva um arquivo binário a escrever um fluxo de dados pickle.

O argumento opcional `protocol', um inteiro, diz ao pickler para usar o protocolo fornecido; os protocolos suportados são de 0 a @ref{14ed,,HIGHEST_PROTOCOL}. Se não for especificado, o padrão é @ref{831,,DEFAULT_PROTOCOL}. Se um número negativo for especificado, @ref{14ed,,HIGHEST_PROTOCOL} é selecionado.

O argumento `file' deve ter um método write() que aceite um argumento de um único byte. Portanto, pode ser um arquivo em disco aberto para escrita binária, uma instância @ref{ed3,,io.BytesIO} ou qualquer outro objeto personalizado que atenda a esta interface.

Se `fix_imports' for verdadeiro e `protocolo' for menor que 3, pickle tentará mapear os novos nomes do Python 3 para os nomes dos módulos antigos usados no Python 2, de modo que o fluxo de dados pickle seja legível com o Python 2.

Se `buffer_callback' for @code{None} (o padrão), as visualizações de buffer são serializadas em `file' como parte do fluxo pickle.

Se `buffer_callback' não for @code{None}, ele pode ser chamado qualquer número de vezes com uma visualização de buffer. Se essa chamada retornar um valor falso (tal como @code{None}), o buffer fornecido é @ref{2a49,,fora da banda}; caso contrário, o buffer é serializado dentro da banda, ou seja, dentro do fluxo pickle.

É um erro se `buffer_callback' não for @code{None} e `protocol' for @code{None} ou menor que 5.


Alterado na versão 3.8: O argumento `buffer_callback' foi adicionado.


@geindex dump() (método pickle.Pickler)
@anchor{library/pickle pickle Pickler dump}@anchor{1bbd}
@deffn {Método} dump (obj)

Escreve a representação serializada em pickle de `obj' no objeto arquivo aberto fornecido no construtor.
@end deffn

@geindex persistent_id() (método pickle.Pickler)
@anchor{library/pickle pickle Pickler persistent_id}@anchor{1687}
@deffn {Método} persistent_id (obj)

Não faz nada por padrão. Isso existe para que uma subclasse possa substituí-lo.

Se @ref{1687,,persistent_id()} retornar @code{None}, `obj' é serializado com pickle como de costume. Qualquer outro valor faz com que @ref{a28,,Pickler} emita o valor retornado como um ID persistente para `obj'. O significado deste ID persistente deve ser definido por @ref{168e,,Unpickler.persistent_load()}. Observe que o valor retornado por @ref{1687,,persistent_id()} não pode ter um ID persistente.

Consulte @ref{2a4a,,Persistência de objetos externos} para detalhes e exemplos de usos.


Alterado na versão 3.13: Foi adicionada a implementação padrão desse método na implementação em C da @code{Pickler}.

@end deffn

@geindex dispatch_table (atributo pickle.Pickler)
@anchor{library/pickle pickle Pickler dispatch_table}@anchor{1161}
@deffn {Atributo} dispatch_table

A tabela de despacho de um objeto pickler é um registro de `funções de redução' do tipo que pode ser declarado usando @ref{2a4b,,copyreg.pickle()}. É um mapeamento cujas chaves são classes e cujos valores são funções de redução. Uma função de redução leva um único argumento da classe associada e deve estar de acordo com a mesma interface de um método @ref{9db,,__reduce__()}.

Por padrão, um objeto pickler não terá um atributo @ref{1161,,dispatch_table}, e em vez disso usará a tabela de despacho global gerenciada pelo módulo @ref{26,,copyreg}. No entanto, para personalizar a serialização com pickle de um objeto pickler específico, pode-se definir o atributo @ref{1161,,dispatch_table} para um objeto do tipo dict. Alternativamente, se uma subclasse de @ref{a28,,Pickler} tem um atributo @ref{1161,,dispatch_table} então ele será usado como a tabela de despacho padrão para instâncias daquela classe.

Consulte @ref{2a4c,,Tabelas de despacho} para exemplos de uso.


Adicionado na versão 3.3.

@end deffn

@geindex reducer_override() (método pickle.Pickler)
@anchor{library/pickle pickle Pickler reducer_override}@anchor{a29}
@deffn {Método} reducer_override (obj)

Redutor especial que pode ser definido em subclasses de @ref{a28,,Pickler}. Este método tem prioridade sobre qualquer redutor em @ref{1161,,dispatch_table}. Ele deve estar de acordo com a mesma interface que um método @ref{9db,,__reduce__()} e pode opcionalmente retornar @ref{7d3,,NotImplemented} como alternativa em redutores registrados em @ref{1161,,dispatch_table} para serializar com pickle @code{obj}.

Para exemplo detalhado, consulte @ref{2a4d,,Redução personalizada para tipos@comma{} funções e outros objetos}.


Adicionado na versão 3.8.

@end deffn

@geindex fast (atributo pickle.Pickler)
@anchor{library/pickle pickle Pickler fast}@anchor{2a4e}
@deffn {Atributo} fast

Descontinuado. Ative o modo rápido se definido como um valor verdadeiro. O modo rápido desabilita o uso de memo, portanto, agilizando o processo de serialização com pickle por não gerar códigos de operação PUT supérfluos. Ele não deve ser usado com objetos autorreferenciais, fazer o contrário fará com que @ref{a28,,Pickler} recorra infinitamente.

Use @ref{2a4f,,pickletools.optimize()} se você precisar de serializações com pickle mais compactas.
@end deffn
@end deffn

@geindex Unpickler (classe em pickle)
@anchor{library/pickle pickle Unpickler}@anchor{159f}
@deffn {Classe} pickle.Unpickler (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

Recebe um arquivo binário para ler um fluxo de dados pickle.

A versão do protocolo do pickle é detectada automaticamente, portanto, nenhum argumento de protocolo é necessário.

O argumento `file' deve ter três métodos: um método read() que recebe um argumento inteiro, um método readinto() que recebe um argumento buffer e um método readline() que não requer argumentos, como na interface @ref{694,,io.BufferedIOBase}. Assim, `file' pode ser um arquivo em disco aberto para leitura binária, um objeto @ref{ed3,,io.BytesIO} ou qualquer outro objeto personalizado que atenda a esta interface.

Os argumentos opcionais `fix_imports', `encoding' e `errors' são usados para controlar o suporte de compatibilidade ao fluxo pickle gerado pelo Python 2. Se `fix_imports' for verdadeiro, pickle tentará mapear os nomes antigos do Python 2 para os novos nomes usados no Python 3. Os `encoding' e `erros' dizem ao pickle como decodificar instâncias de string de 8 bits capturadas pelo Python 2; o padrão é ‘ASCII’ e ‘strict’, respectivamente. O argumento `encoding' pode ser ‘bytes’ para ler essas instâncias de string de 8 bits como objetos de bytes. Usar @code{encoding='latin1'} é necessário para a desserialização com pickle de vetores NumPy e instâncias de @ref{1cc,,datetime}, @ref{1cd,,date} e @ref{1ce,,time} serializadas com pickle pelo Python 2.

Se `buffers' for @code{None} (o padrão), todos os dados necessários para desserialização devem estar contidos no fluxo pickle. Isso significa que o argumento `buffer_callback' era @code{None} quando um @ref{a28,,Pickler} foi instanciado (ou quando @ref{2a44,,dump()} ou @ref{14ec,,dumps()} foi chamado).

Se `buffers' for @code{None}, deve ser um iterável de objetos habilitados para buffer que é consumido cada vez que o fluxo de serialização com pickle faz referência a uma visualização de buffer @ref{2a49,,fora da banda}. Esses buffers foram fornecidos em ordem para o `buffer_callback' de um objeto Pickler.


Alterado na versão 3.8: O argumento `buffers' foi adicionado.


@geindex load() (método pickle.Unpickler)
@anchor{library/pickle pickle Unpickler load}@anchor{2a50}
@deffn {Método} load ()

Lê a representação serializada com pickle de um objeto a partir do objeto arquivo aberto fornecido no construtor e retorna a hierarquia de objeto reconstituído especificada nele. Os bytes após a representação serializada com pickle do objeto são ignorados.
@end deffn

@geindex persistent_load() (método pickle.Unpickler)
@anchor{library/pickle pickle Unpickler persistent_load}@anchor{168e}
@deffn {Método} persistent_load (pid)

Levanta um @ref{2a48,,UnpicklingError} por padrão.

Se definido, @ref{168e,,persistent_load()} deve retornar o objeto especificado pelo ID persistente `pid'. Se um ID persistente inválido for encontrado, uma @ref{2a48,,UnpicklingError} deve ser levantada.

Consulte @ref{2a4a,,Persistência de objetos externos} para detalhes e exemplos de usos.


Alterado na versão 3.13: Foi adicionada a implementação padrão desse método na implementação em C da @code{Unpickler}.

@end deffn

@geindex find_class() (método pickle.Unpickler)
@anchor{library/pickle pickle Unpickler find_class}@anchor{2a51}
@deffn {Método} find_class (module, name)

Importa `module' se necessário e retorna o objeto chamado `name' dele, onde os argumentos `module' e `name' são objetos @ref{44c,,str}. Observe, ao contrário do que seu nome sugere, @ref{2a51,,find_class()} também é usado para encontrar funções.

As subclasses podem substituir isso para obter controle sobre quais tipos de objetos e como eles podem ser carregados, reduzindo potencialmente os riscos de segurança. Confira @ref{2a52,,Restringindo globais} para detalhes.

Levanta um @ref{19fa,,evento de auditoria} @code{pickle.find_class} com os argumentos @code{module}, @code{name}.
@end deffn
@end deffn

@geindex PickleBuffer (classe em pickle)
@anchor{library/pickle pickle PickleBuffer}@anchor{15a2}
@deffn {Classe} pickle.PickleBuffer (buffer)

Um invólucro para um buffer que representa dados serializáveis com pickle. `buffer' deve ser um objeto @ref{2e8,,provedor de buffer}, como um @ref{d4f,,objeto bytes ou similar} ou um vetor N-dimensional.

@ref{15a2,,PickleBuffer} é ele próprio um provedor de buffer, de forma que é possível passá-lo para outras APIs que esperam um objeto provedor de buffer, como @ref{2eb,,memoryview}.

Objetos @ref{15a2,,PickleBuffer} só podem ser serializados usando o protocolo pickle 5 ou superior. Eles são elegíveis para @ref{2a49,,serialização fora de banda}.


Adicionado na versão 3.8.


@geindex raw() (método pickle.PickleBuffer)
@anchor{library/pickle pickle PickleBuffer raw}@anchor{2a53}
@deffn {Método} raw ()

Retorna um @ref{2eb,,memoryview} da área de memória subjacente a este buffer. O objeto retornado é um memoryview unidimensional, contíguo C com formato @code{B} (bytes não assinados). @ref{15bd,,BufferError} é levantada se o buffer não for contíguo C nem Fortran.
@end deffn

@geindex release() (método pickle.PickleBuffer)
@anchor{library/pickle pickle PickleBuffer release}@anchor{2a54}
@deffn {Método} release ()

Libera o buffer subjacente exposto pelo objeto PickleBuffer.
@end deffn
@end deffn

@node O que pode ser serializado e desserializado com pickle?,Serializando com pickle instâncias de classes,Interface do módulo,pickle — Serialização de objetos Python
@anchor{library/pickle pickle-picklable}@anchor{2a47}@anchor{library/pickle what-can-be-pickled-and-unpickled}@anchor{2a55}
@subsubsection O que pode ser serializado e desserializado com pickle?


Os seguintes tipos podem ser serializados com pickle:


@itemize *

@item 
constantes embutidas (@code{None}, @code{True}, @code{False}, @code{Ellipsis} e @ref{7d3,,NotImplemented});

@item 
inteiros, números de ponto flutuante, números complexos;

@item 
strings, bytes, bytearrays;

@item 
tuplas, listas, conjuntos e dicionários contendo apenas objetos serializáveis com pickle;

@item 
funções (embutidas ou definidas pelo usuário) acessíveis no nível superior de um módulo (usando @ref{14a2,,def}, não @ref{12df,,lambda});

@item 
classes acessíveis no nível superior de um módulo;

@item 
instâncias de classes cujo o resultado da chamada de @ref{5d8,,__getstate__()} seja serializável com pickle (veja a seção @ref{2a3f,,Serializando com pickle instâncias de classes} para detalhes).
@end itemize

As tentativas de serializar objetos não serializáveis com pickle vão levantar a exceção @ref{2a46,,PicklingError}; quando isso acontece, um número não especificado de bytes pode já ter sido escrito no arquivo subjacente. Tentar serializar com pickle uma estrutura de dados altamente recursiva pode exceder a profundidade máxima de recursão, a @ref{d90,,RecursionError} será levantada neste caso. Você pode aumentar este limite cuidadosamente com @ref{4c3,,sys.setrecursionlimit()}.

Observe que as funções (embutidas e definidas pelo usuário) são serializadas com pickle pelo @ref{1ab1,,nome qualificado}, não pelo valor. @footnote{
É por isso que funções @ref{12df,,lambda} não podem ser serializadas com pickle: todas as funções @code{lambda} compartilham o mesmo nome:  @code{<lambda>}.
} Isso significa que apenas o nome da função é serializado com pickle, junto com o nome do módulo e das classes contidos. Nem o código da função, nem qualquer um de seus atributos de função são serializados com pickle. Assim, o módulo de definição deve ser importável no ambiente de desserialização com pickle, e o módulo deve conter o objeto nomeado, caso contrário, uma exceção será levantada. @footnote{
A exceção levantada provavelmente será uma @ref{419,,ImportError} ou uma @ref{34b,,AttributeError}, mas poderia ser outra coisa.
}

Da mesma forma, as classes são serializadas com pickle pelo nome qualificado, portanto, aplicam-se as mesmas restrições no ambiente de desserialização com pickle. Observe que nenhum código ou dado da classe é coletado, portanto, no exemplo a seguir, o atributo de classe @code{attr} não é restaurado no ambiente de desserialização com pickle:

@example
class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)
@end example

Essas restrições são a razão pela qual as funções e classes serializáveis com pickle devem ser definidas no nível superior de um módulo.

Da mesma forma, quando as instâncias da classe são serializadas com pickle, o código e os dados de sua classe não são serializados junto com elas. Apenas os dados da instância são serializados com pickle. Isso é feito de propósito para que você possa corrigir bugs em uma classe ou adicionar métodos à classe e ainda carregar objetos que foram criados com uma versão anterior da classe. Se você planeja ter objetos de longa duração que verão muitas versões de uma classe, pode valer a pena colocar um número de versão nos objetos para que as conversões adequadas possam ser feitas pelo método @ref{9dc,,__setstate__()} da classe.

@node Serializando com pickle instâncias de classes,Redução personalizada para tipos funções e outros objetos,O que pode ser serializado e desserializado com pickle?,pickle — Serialização de objetos Python
@anchor{library/pickle pickle-inst}@anchor{2a3f}@anchor{library/pickle pickling-class-instances}@anchor{2a56}
@subsubsection Serializando com pickle instâncias de classes


Nesta seção, descrevemos os mecanismos gerais disponíveis para você definir, personalizar e controlar como as instâncias de classe são serializadas e desserializadas com pickle.

Na maioria dos casos, nenhum código adicional é necessário para tornar as instâncias serializáveis com pickle. Por padrão, o pickle recuperará a classe e os atributos de uma instância por meio de introspecção. Quando uma instância de classe não está serializada com pickle, seu método @ref{6b0,,__init__()} geralmente `não' é invocado. O comportamento padrão primeiro cria uma instância não inicializada e, em seguida, restaura os atributos salvos. O código a seguir mostra uma implementação desse comportamento:

@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

As classes podem alterar o comportamento padrão, fornecendo um ou vários métodos especiais:

@geindex __getnewargs_ex__() (método object)
@anchor{library/pickle object __getnewargs_ex__}@anchor{2a57}
@deffn {Método} object.__getnewargs_ex__ ()

Nos protocolos 2 e mais recentes, as classes que implementam o método @ref{2a57,,__getnewargs_ex__()} podem ditar os valores passados para o método @ref{580,,__new__()} após a desserialização com pickle. O método deve retornar um par @code{(args, kwargs)} onde `args' é uma tupla de argumentos posicionais e `kwargs' um dicionário de argumentos nomeados para construir o objeto. Esses serão passados para o método @ref{580,,__new__()} após a desserialização com pickle.

Você deve implementar este método se o método @ref{580,,__new__()} de sua classe requer argumentos somente-nomeados. Caso contrário, é recomendado para compatibilidade implementar @ref{dfe,,__getnewargs__()}.


Alterado na versão 3.6: @ref{2a57,,__getnewargs_ex__()} é agora usado em protocolos 2 e 3.

@end deffn

@geindex __getnewargs__() (método object)
@anchor{library/pickle object __getnewargs__}@anchor{dfe}
@deffn {Método} object.__getnewargs__ ()

Este método serve a um propósito semelhante ao de @ref{2a57,,__getnewargs_ex__()}, mas tem suporte apenas a argumentos posicionais. Ele deve retornar uma tupla de argumentos @code{args} que serão passados para o método @ref{580,,__new__()} após a desserialização com pickle.

@ref{dfe,,__getnewargs__()} não será chamado se @ref{2a57,,__getnewargs_ex__()} estiver definido.


Alterado na versão 3.6: Antes do Python 3.6, @ref{dfe,,__getnewargs__()} era chamado em vez de @ref{2a57,,__getnewargs_ex__()} nos protocolos 2 e 3.

@end deffn

@geindex __getstate__() (método object)
@anchor{library/pickle object __getstate__}@anchor{5d8}
@deffn {Método} object.__getstate__ ()

Classes podem influenciar ainda mais como suas instâncias são serializadas com pickle, substituindo o método @ref{5d8,,__getstate__()}. Ele é chamado e o objeto retornado é serializado com pickle como o conteúdo da instância, em vez de um estado padrão. Existem vários casos:


@itemize *

@item 
Para uma classe que não possui instância @ref{55b,,__dict__} e não possui @ref{1533,,__slots__}, o estado padrão é @code{None}.

@item 
Para uma classe que não uma possui instância @ref{55b,,__dict__} nem @ref{1533,,__slots__}, o estado padrão é @code{self.__dict__}.

@item 
Para uma classe que possui uma instância @ref{55b,,__dict__} e @ref{1533,,__slots__}, o estado padrão é uma tupla consistindo de dois dicionários: @code{self.__dict__}, e um dicionário de mapeamento de nomes de slot para valores de slot. Apenas os slots que possuem um valor são incluídos neste último.

@item 
Para uma classe que possui @ref{1533,,__slots__} e nenhuma @ref{55b,,__dict__} de instância, o estado padrão é uma tupla cujo primeiro item é @code{None} e cujo segundo item é um dicionário mapeando os nomes dos slots para os valores dos slots descritos no tópico anterior.
@end itemize


Alterado na versão 3.11: Adicionada a implementação padrão do método @code{__getstate__()} na classe @code{objeto}.

@end deffn

@geindex __setstate__() (método object)
@anchor{library/pickle object __setstate__}@anchor{9dc}
@deffn {Método} object.__setstate__ (state)

Ao desserializar com pickle, se a classe define @ref{9dc,,__setstate__()}, ela é chamada com o estado não desserializado. Nesse caso, não há nenhum requisito para que o objeto de estado seja um dicionário. Caso contrário, o estado serializado com pickle deve ser um dicionário e seus itens são atribuídos ao dicionário da nova instância.

@cartouche
@quotation Nota 
Se @ref{9db,,__reduce__()} retorna um estado com valor @code{None} na serialização com pickle, o método @ref{9dc,,__setstate__()} não será chamado quando da desserialização com pickle.
@end quotation
@end cartouche
@end deffn

Confira a seção @ref{2a58,,Manipulação de objetos com estado} para mais informações sobre como usar os métodos @ref{5d8,,__getstate__()} e @ref{9dc,,__setstate__()}.

@cartouche
@quotation Nota 
Quando da desserialização com pickle, alguns métodos, como @ref{4d3,,__getattr__()}, @ref{beb,,__getattribute__()} ou @ref{20bf,,__setattr__()}, podem ser chamados na instância. No caso desses métodos dependerem de alguma invariante interna ser verdadeira, o tipo deve ser implementado @ref{580,,__new__()} para estabelecer tal invariante, pois @ref{6b0,,__init__()} não é chamada quando da desserialização com pickle em uma instância.
@end quotation
@end cartouche

@geindex copy;protocolo

Como veremos, o pickle não usa diretamente os métodos descritos acima. Na verdade, esses métodos são parte do protocolo de cópia que implementa o método especial @ref{9db,,__reduce__()}. O protocolo de cópia fornece uma interface unificada para recuperar os dados necessários para serialização com pickle e cópia de objetos. @footnote{
O módulo @ref{25,,copy} usa este protocolo para operações de cópia rasa e cópia profunda.
}

Apesar de poderoso, implementar @ref{9db,,__reduce__()} diretamente em sua classe é algo propenso a erro. Por este motivo, designers de classe devem usar a interface de alto nível (ou seja, @ref{2a57,,__getnewargs_ex__()}, @ref{5d8,,__getstate__()} e @ref{9dc,,__setstate__()}) sempre que possível. Vamos mostrar, porém, casos em que o uso de @code{__reduce__()} é a única opção ou leva a uma serialização com pickle mais eficiente, ou as ambas.

@geindex __reduce__() (método object)
@anchor{library/pickle object __reduce__}@anchor{9db}
@deffn {Método} object.__reduce__ ()

A interface está atualmente definida da seguinte maneira. O método @ref{9db,,__reduce__()} não aceita nenhum argumento e deve retornar uma string ou preferencialmente uma tupla (o objeto retornado é frequentemente referido como o “valor de redução”).

Se uma string é retornada, ela deve ser interpretada como o nome de uma variável global. Deve ser o nome local do objeto relativo ao seu módulo; o módulo pickle pesquisa o espaço de nomes do módulo para determinar o módulo do objeto. Esse comportamento é normalmente útil para singletons.

Quando uma tupla é retornada, ela deve ter entre dois e seis itens. Os itens opcionais podem ser omitidos ou @code{None} pode ser fornecido como seu valor. A semântica de cada item está em ordem:

@c XXX Mention __newobj__ special-case?


@itemize *

@item 
Um objeto chamável que será chamado para criar a versão inicial do objeto.

@item 
Uma tupla de argumentos para o objeto chamável. Uma tupla vazia deve ser fornecida se o chamável não aceitar nenhum argumento.

@item 
Opcionalmente, o estado do objeto, que será passado para o método @ref{9dc,,__setstate__()} do objeto conforme descrito anteriormente. Se o objeto não tiver tal método, o valor deve ser um dicionário e será adicionado ao atributo @ref{55b,,__dict__} do objeto.

@item 
Opcionalmente, um iterador (e não uma sequência) produzindo itens sucessivos. Esses itens serão anexados ao objeto usando @code{obj.append(item)} ou, em lote, usando @code{obj.extend(list_of_items)}. Isso é usado principalmente para subclasses de lista, mas pode ser usado por outras classes, desde que tenham os métodos @ref{2118,,append()} e @ref{211b,,extend()} com a assinatura apropriada. (Se @code{append()} ou @code{extend()} é usado depende de qual versão do protocolo pickle é usada, bem como o número de itens a anexar, então ambos devem ser suportados.)

@item 
Opcionalmente, um iterador (não uma sequência) produzindo pares de valor-chave sucessivos. Esses itens serão armazenados no objeto usando @code{obj[chave]=valor}. Isso é usado principalmente para subclasses de dicionário, mas pode ser usado por outras classes, desde que implementem @ref{130e,,__setitem__()}.

@item 
Opcionalmente, um chamável com uma assinatura @code{(obj, estado)}. Este chamável permite ao usuário controlar programaticamente o comportamento de atualização de estado de um objeto específico, ao invés de usar o método estático @ref{9dc,,__setstate__()} de @code{obj}. Se não for @code{None}, este chamável terá prioridade sobre o @ref{9dc,,__setstate__()} de @code{obj}.


Adicionado na versão 3.8: O sexto item opcional de tupla, @code{(obj, estado)}, foi adicionado.

@end itemize
@end deffn

@geindex __reduce_ex__() (método object)
@anchor{library/pickle object __reduce_ex__}@anchor{16a1}
@deffn {Método} object.__reduce_ex__ (protocol)

Alternativamente, um método @ref{16a1,,__reduce_ex__()} pode ser definido. A única diferença é que este método deve ter um único argumento inteiro, a versão do protocolo. Quando definido, pickle irá preferir isso ao método @ref{9db,,__reduce__()}. Além disso, @ref{9db,,__reduce__()} automaticamente se torna um sinônimo para a versão estendida. O principal uso desse método é fornecer valores de redução com compatibilidade reversa para versões mais antigas do Python.
@end deffn

@menu
* Persistência de objetos externos:: 
* Tabelas de despacho:: 
* Manipulação de objetos com estado:: 

@end menu

@node Persistência de objetos externos,Tabelas de despacho,,Serializando com pickle instâncias de classes
@anchor{library/pickle persistence-of-external-objects}@anchor{2a59}@anchor{library/pickle pickle-persistent}@anchor{2a4a}
@subsubsection Persistência de objetos externos


@geindex persistent_id (protocolo pickle)
@geindex persistent_load (protocolo pickle)

Para o benefício da persistência do objeto, o módulo @ref{a6,,pickle} tem suporte à noção de uma referência a um objeto fora do fluxo de dados serializados com pickle. Esses objetos são referenciados por um ID persistente, que deve ser uma string de caracteres alfanuméricos (para o protocolo 0) @footnote{
A limitação de caracteres alfanuméricos se deve ao fato de que os IDs persistentes, no protocolo 0, serem delimitados pelo caractere de nova linha. Portanto, se qualquer tipo de caractere de nova linha ocorrer em IDs persistentes, os dados resultantes da serialização com pickle se tornarão ilegíveis.
} ou apenas um objeto arbitrário (para qualquer protocolo mais recente).

A resolução de tais IDs persistentes não é definida pelo módulo @ref{a6,,pickle}; ele vai delegar esta resolução aos métodos definidos pelo usuário no selecionador e no separador, @ref{1687,,persistent_id()} e @ref{168e,,persistent_load()} respectivamente.

Para serializar com pickle objetos que têm um ID externo persistente, o pickler deve ter um método @ref{1687,,persistent_id()} personalizado que recebe um objeto como um argumento e retorna @code{None} ou o ID persistente para esse objeto. Quando @code{None} é retornado, o pickler simplesmente serializa o objeto normalmente. Quando uma string de ID persistente é retornada, o pickler serializa aquele objeto, junto com um marcador para que o unpickler o reconheça como um ID persistente.

Para desserializar com pickle objetos externos, o unpickler deve ter um método @ref{168e,,persistent_load()} personalizado que recebe um objeto de ID persistente e retorna o objeto referenciado.

Aqui está um exemplo abrangente que apresenta como o ID persistente pode ser usado para serializar com pickle objetos externos por referência.

@example
# Exemplo simples que mostra como o ID persistente pode ser usado
# serializar com pickle objetos externos por referência.

import pickle
import sqlite3
from collections import namedtuple

# Classe simples que representa um registro em nosso banco de dados.
MemoRecord = namedtuple("MemoRecord", "key, task")

class DBPickler(pickle.Pickler):

    def persistent_id(self, obj):
        # Em vez de conservar MemoRecord como uma instância de classe regular,
        # emitimos um ID persistente.
        if isinstance(obj, MemoRecord):
            # Aqui, nosso ID persistente é simplesmente uma tupla, contendo
            # uma tag e uma chave, que se refere a um registro específico
            # no banco de dados.
            return ("MemoRecord", obj.key)
        else:
            # Se obj não tiver um ID persistente, retorna None. Significa que
            # obj precisa ser conservado como de costume.
            return None


class DBUnpickler(pickle.Unpickler):

    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection

    def persistent_load(self, pid):
        # Este método é invocado sempre que um ID persistente é encontrado.
        # Aqui, pid é a tupla retornada por DBPickler.
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # Busca o registro referenciado no banco de dados e retorna-o.
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # Sempre levanta um erro se você puder retornar o objeto correto.
            # Caso contrário, a desserialização com pickle considerará que
            # None é o objeto referenciado pelo ID persistente.
            raise pickle.UnpicklingError("unsupported persistent object")


def main():
    import io
    import pprint

    # Inicializa e popula nosso banco de dados.
    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,))

    # Busca os registros a serem serializados com pickle.
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # Salva os registros usando nosso DBPickler personalizado.
    file = io.BytesIO()
    DBPickler(file).dump(memos)

    print("Pickled records:")
    pprint.pprint(memos)

    # Atualiza um registro, só por precaução.
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

    # Carrega os registros do fluxo de dados pickle.
    file.seek(0)
    memos = DBUnpickler(file, conn).load()

    print("Unpickled records:")
    pprint.pprint(memos)


if __name__ == '__main__':
    main()
@end example

@node Tabelas de despacho,Manipulação de objetos com estado,Persistência de objetos externos,Serializando com pickle instâncias de classes
@anchor{library/pickle dispatch-tables}@anchor{2a5a}@anchor{library/pickle pickle-dispatch}@anchor{2a4c}
@subsubsection Tabelas de despacho


Se alguém quiser personalizar a serialização com pickle de algumas classes sem perturbar nenhum outro código que dependa da serialização, pode-se criar um pickler com uma tabela de despacho privada.

A tabela de despacho global gerenciada pelo módulo @ref{26,,copyreg} está disponível como @code{copyreg.dispatch_table}. Portanto, pode-se escolher usar uma cópia modificada de @code{copyreg.dispatch_table} como uma tabela de despacho privada.

Por exemplo

@example
f = io.BytesIO()
p = pickle.Pickler(f)
p.dispatch_table = copyreg.dispatch_table.copy()
p.dispatch_table[SomeClass] = reduce_SomeClass
@end example

cria uma instância de @ref{a28,,pickle.Pickler} com uma tabela de despacho privada que trata a classe @code{SomeClass} especialmente. Alternativamente, o 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

faz o mesmo, mas todas as instâncias de @code{MyPickler} compartilharão por padrão a tabela de despacho privada. Por outro lado, o código

@example
copyreg.pickle(SomeClass, reduce_SomeClass)
f = io.BytesIO()
p = pickle.Pickler(f)
@end example

modifica a tabela de despacho global compartilhada por todos os usuários do módulo @ref{26,,copyreg}.

@node Manipulação de objetos com estado,,Tabelas de despacho,Serializando com pickle instâncias de classes
@anchor{library/pickle handling-stateful-objects}@anchor{2a5b}@anchor{library/pickle pickle-state}@anchor{2a58}
@subsubsection Manipulação de objetos com estado


@geindex __getstate__() (protocolo de cópia)
@geindex __setstate__() (protocolo de cópia)

Aqui está um exemplo que mostra como modificar o comportamento de serialização com pickle de uma classe. A classe @code{TextReader} abaixo abre um arquivo texto e retorna o número da linha e o conteúdo da linha cada vez que seu método @code{readline()} é chamado. Se uma instância de @code{TextReader} for selecionada, todos os atributos `exceto' o membro do objeto arquivo são salvos. Quando a instância é removida, o arquivo é reaberto e a leitura continua a partir do último local. Os métodos @code{__setstate__()} e @code{__getstate__()} são usados para implementar este comportamento.

@example
class TextReader:
    """Exibe e numera linhas em um arquivo texto."""

    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):
        # Copia o estado do objeto de self.__dict__, que
        # contém todos os nossos atributos de instância.
        # Sempre use o método dict.copy() para evitar
        # modificar o estado original.
        state = self.__dict__.copy()
        # Remove as entradas não serializáveis com pickle.
        del state['file']
        return state

    def __setstate__(self, state):
        # Restaura os atributos da instância (isto é, filename e lineno).
        self.__dict__.update(state)
        # Restaura o estado do arquivo aberto anteriormente.
        # Para fazer isso, precisamos reabri-lo e ler dele até
        # a contagem de linha ser restaurada.
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # Ao final, salva o arquivo.
        self.file = file
@end example

Um exemplo de uso pode ser algo assim:

@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 Redução personalizada para tipos funções e outros objetos,Buffers fora da banda,Serializando com pickle instâncias de classes,pickle — Serialização de objetos Python
@anchor{library/pickle custom-reduction-for-types-functions-and-other-objects}@anchor{2a5c}@anchor{library/pickle reducer-override}@anchor{2a4d}
@subsubsection Redução personalizada para tipos, funções e outros objetos



Adicionado na versão 3.8.


Às vezes, @ref{1161,,dispatch_table} pode não ser flexível o suficiente. Em particular, podemos querer personalizar a serialização com pickle com base em outro critério que não o tipo do objeto, ou podemos personalizar a serialização com pickle de funções e classes.

Para esses casos, é possível criar uma subclasse da classe @ref{a28,,Pickler} e implementar um método @ref{a29,,reducer_override()}. Este método pode retornar uma tupla de redução arbitrária (veja @ref{9db,,__reduce__()}). Ele pode, alternativamente, retornar @ref{7d3,,NotImplemented} para retornar ao comportamento tradicional.

Se @ref{1161,,dispatch_table} e @ref{a29,,reducer_override()} forem definidos, o método @ref{a29,,reducer_override()} tem prioridade.

@cartouche
@quotation Nota 
Por motivos de desempenho, @ref{a29,,reducer_override()} não pode ser chamado para os seguintes objetos: @code{None}, @code{True}, @code{False}, e as instâncias exatas de @ref{257,,int}, @ref{2f7,,float}, @ref{1c2,,bytes}, @ref{44c,,str}, @ref{256,,dict}, @ref{5d9,,set}, @ref{5da,,frozenset}, @ref{611,,list} e @ref{370,,tuple}.
@end quotation
@end cartouche

Aqui está um exemplo simples onde permitimos serialização com pickle e reconstrução de uma determinada classe:

@example
import io
import pickle

class MyClass:
    my_attribute = 1

class MyPickler(pickle.Pickler):
    def reducer_override(self, obj):
        """Redutor personalizado para MyClass."""
        if getattr(obj, "__name__", None) == "MyClass":
            return type, (obj.__name__, obj.__bases__,
                          @{'my_attribute': obj.my_attribute@})
        else:
            # Para qualquer outro objeto, recorre à redução de costume
            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 Buffers fora da banda,Restringindo globais,Redução personalizada para tipos funções e outros objetos,pickle — Serialização de objetos Python
@anchor{library/pickle out-of-band-buffers}@anchor{2a5d}@anchor{library/pickle pickle-oob}@anchor{2a49}
@subsubsection Buffers fora da banda



Adicionado na versão 3.8.


Em alguns contextos, o módulo @ref{a6,,pickle} é usado para transferir grandes quantidades de dados. Portanto, pode ser importante minimizar o número de cópias de memória para preservar o desempenho e o consumo de recursos. No entanto, a operação normal do módulo @ref{a6,,pickle}, à medida que transforma uma estrutura semelhante a um gráfico de objetos em um fluxo sequencial de bytes, envolve intrinsecamente a cópia de dados de e para o fluxo pickle.

Esta restrição pode ser evitada se tanto o `fornecedor' (a implementação dos tipos de objetos a serem transferidos) e o `consumidor' (a implementação do sistema de comunicações) tiverem suporte aos recursos de transferência fora de banda fornecidos pelo protocolo pickle 5 e superior.

@menu
* API de provedor:: 
* API de consumidor:: 
* Exemplo: Exemplo<4>. 

@end menu

@node API de provedor,API de consumidor,,Buffers fora da banda
@anchor{library/pickle provider-api}@anchor{2a5e}
@subsubsection API de provedor


Os grandes objetos de dados a serem serializados com pickle devem implementar um método @ref{16a1,,__reduce_ex__()} especializado para o protocolo 5 e superior, que retorna uma instância @ref{15a2,,PickleBuffer} (em vez de, por exemplo, um objeto @ref{1c2,,bytes}) para quaisquer dados grandes.

Um objeto @ref{15a2,,PickleBuffer} `sinaliza' que o buffer subjacente é elegível para transferência de dados fora de banda. Esses objetos permanecem compatíveis com o uso normal do módulo @ref{a6,,pickle}. No entanto, os consumidores também podem optar por dizer ao @ref{a6,,pickle} que eles irão lidar com esses buffers por conta própria.

@node API de consumidor,Exemplo<4>,API de provedor,Buffers fora da banda
@anchor{library/pickle consumer-api}@anchor{2a5f}
@subsubsection API de consumidor


Um sistema de comunicação pode permitir o manuseio personalizado dos objetos @ref{15a2,,PickleBuffer} gerados ao serializar um grafo de objeto.

No lado emissor, é necessário passar um argumento `buffer_callback' para @ref{a28,,Pickler} (ou para a função @ref{2a44,,dump()} ou @ref{14ec,,dumps()}), que será chamada com cada @ref{15a2,,PickleBuffer} gerado durante a serialização com pickle do grafo do objeto. Os buffers acumulados pelo `buffer_callback' não verão seus dados copiados no fluxo pickle, apenas um marcador barato será inserido.

No lado receptor, é necessário passar um argumento `buffers' para @ref{159f,,Unpickler} (ou para a função @ref{d32,,load()} ou @ref{d32,,load()}), que é um iterável dos buffers que foram passado para `buffer_callback'. Esse iterável deve produzir buffers na mesma ordem em que foram passados para `buffer_callback'. Esses buffers fornecerão os dados esperados pelos reconstrutores dos objetos cuja serialização com pickle produziu os objetos @ref{15a2,,PickleBuffer} originais.

Entre o lado emissor e o lado receptor, o sistema de comunicações está livre para implementar seu próprio mecanismo de transferência para buffers fora de banda. As otimizações potenciais incluem o uso de memória compartilhada ou compactação dependente do tipo de dados.

@node Exemplo<4>,,API de consumidor,Buffers fora da banda
@anchor{library/pickle example}@anchor{2a60}
@subsubsection Exemplo


Aqui está um exemplo trivial onde implementamos uma subclasse de @ref{2ea,,bytearray} capaz de participar de serialização com pickle de buffer fora de banda:

@example
class ZeroCopyByteArray(bytearray):

    def __reduce_ex__(self, protocol):
        if protocol >= 5:
            return type(self)._reconstruct, (PickleBuffer(self),), None
        else:
            # PickleBuffer é proibido no pickle nos protocolos <= 4.
            return type(self)._reconstruct, (bytearray(self),)

    @@classmethod
    def _reconstruct(cls, obj):
        with memoryview(obj) as m:
            # Obtém um controle sobre o objeto buffer original
            obj = m.obj
            if type(obj) is cls:
                # O objeto do buffer original é um ZeroCopyByteArray,
                # retorna-o como está.
                return obj
            else:
                return cls(obj)
@end example

O reconstrutor (o método de classe @code{_reconstruct}) retorna o objeto de fornecimento do buffer se ele tiver o tipo correto. Esta é uma maneira fácil de simular o comportamento de cópia zero neste exemplo de brinquedo.

Do lado consumidor, podemos serializar com pickle esses objetos da maneira usual, que quando não serializados nos dará uma cópia do 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: uma cópia foi feita
@end example

Mas se passarmos um `buffer_callback' e, em seguida, retornarmos os buffers acumulados ao desserializar, seremos capazes de recuperar o 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: nenhuma cópia foi feita
@end example

Este exemplo é limitado pelo fato de que @ref{2ea,,bytearray} aloca sua própria memória: você não pode criar uma instância de @ref{2ea,,bytearray} que é apoiada pela memória de outro objeto. No entanto, tipos de dados de terceiros, como arrays de NumPy, não têm essa limitação e permitem o uso de serialização com pickle de cópia zero (ou fazer o mínimo de cópias possível) ao transferir entre processos ou sistemas distintos.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} – Protocolo de Pickle 5 com buffers de dados fora da banda


@node Restringindo globais,Desempenho<2>,Buffers fora da banda,pickle — Serialização de objetos Python
@anchor{library/pickle pickle-restrict}@anchor{2a52}@anchor{library/pickle restricting-globals}@anchor{2a61}
@subsubsection Restringindo globais


@geindex find_class() (protocolo pickle)

Por padrão, a desserialização com pickle importará qualquer classe ou função que encontrar nos dados pickle. Para muitos aplicativos, esse comportamento é inaceitável, pois permite que o unpickler importe e invoque código arbitrário. Basta considerar o que este fluxo de dados pickle feito à mão faz quando carregado:

@example
>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0
@end example

Neste exemplo, o unpickler importa a função @ref{14a5,,os.system()} e então aplica o argumento string “echo hello world”. Embora este exemplo seja inofensivo, não é difícil imaginar um que possa danificar seu sistema.

Por esta razão, você pode querer controlar o que é desserializado com pickle personalizando @ref{2a51,,Unpickler.find_class()}. Ao contrário do que seu nome sugere, @ref{2a51,,Unpickler.find_class()} é chamado sempre que um global (ou seja, uma classe ou uma função) é solicitado. Assim, é possível proibir completamente os globais ou restringi-los a um subconjunto seguro.

Aqui está um exemplo de um unpickler que permite que apenas algumas classes seguras do módulo @ref{12,,builtins} sejam carregadas:

@example
import builtins
import io
import pickle

safe_builtins = @{
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
@}

class RestrictedUnpickler(pickle.Unpickler):

    def find_class(self, module, name):
        # Só permite classes seguras de bultins.
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # Proíbe todo o resto.
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))

def restricted_loads(s):
    """Função auxiliar análoga a pickle.loads()."""
    return RestrictedUnpickler(io.BytesIO(s)).load()
@end example

Um exemplo de uso do nosso unpickler funcionando como esperado:

@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 nossos exemplos mostram, você deve ter cuidado com o que permite que seja desserializado com pickle. Portanto, se a segurança é uma preocupação, você pode querer considerar alternativas como a API de marshalling em @ref{12e,,xmlrpc.client} ou soluções de terceiros.

@node Desempenho<2>,Exemplos<7>,Restringindo globais,pickle — Serialização de objetos Python
@anchor{library/pickle performance}@anchor{2a62}
@subsubsection Desempenho


Versões recentes do protocolo pickle (do protocolo 2 em diante) apresentam codificações binárias eficientes para vários recursos comuns e tipos embutidos. Além disso, o módulo @ref{a6,,pickle} tem um otimizador transparente escrito em C.

@node Exemplos<7>,,Desempenho<2>,pickle — Serialização de objetos Python
@anchor{library/pickle examples}@anchor{2a63}@anchor{library/pickle pickle-example}@anchor{2a64}
@subsubsection Exemplos


Para código mais simples, use as funções @ref{2a44,,dump()} e @ref{d32,,load()}.

@example
import pickle

# Uma coleção arbitrária de objetos aceitos por 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:
    # Serializa com pickle o dicionário 'data' usando
    # o protocolo mais alto disponível.
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)
@end example

O exemplo a seguir lê os dados resultantes em serializados com pickle.

@example
import pickle

with open('data.pickle', 'rb') as f:
    # A versão do protocolo utilizada é detectada automaticamente,
    # portanto não precisamos especificá-la.
    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 também



@table @asis

@item Módulo @ref{26,,copyreg}

Registro de construtor de interface Pickle para tipos de extensão.

@item Módulo @ref{a7,,pickletools}

Ferramentas para trabalhar e analisar dados serializados com pickle.

@item Módulo @ref{c3,,shelve}

Banco de dados indexado de objetos; usa @ref{a6,,pickle}.

@item Módulo @ref{25,,copy}

Cópia rasa e cópia profunda de objeto.

@item Módulo @ref{8d,,marshal}

Serialização de alto desempenho de tipos embutidos.
@end table


@node copyreg — Registra funções de suporte pickle,shelve — Python object persistence,pickle — Serialização de objetos Python,Persistência de Dados
@anchor{library/copyreg doc}@anchor{2a65}@anchor{library/copyreg copyreg-register-pickle-support-functions}@anchor{2a66}@anchor{library/copyreg module-copyreg}@anchor{26}@anchor{library/copyreg translation-repo}@anchor{2a67}
@subsection @code{copyreg} — Registra funções de suporte @code{pickle}


@geindex module; copyreg

`Código-fonte:' Lib/copyreg.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/copyreg.py}

@geindex módulo;pickle
@geindex módulo;copy


__________________________________________________________________


O módulo @ref{26,,copyreg} oferece uma maneira de definir as funções usadas durante a remoção de objetos específicos. Os módulos @ref{a6,,pickle} e @ref{25,,copy} usam essas funções ao selecionar/copiar esses objetos. O módulo fornece informações de configuração sobre construtores de objetos que não são classes. Esses construtores podem ser funções de fábrica ou instâncias de classes.

@geindex constructor() (no módulo copyreg)
@anchor{library/copyreg copyreg constructor}@anchor{2a68}
@deffn {Função} copyreg.constructor (object)

Declara `object' para ser um construtor válido. Se `object' não for chamável (e, portanto, não for válido como um construtor), levanta @ref{2c3,,TypeError}.
@end deffn

@geindex pickle() (no módulo copyreg)
@anchor{library/copyreg copyreg pickle}@anchor{2a4b}
@deffn {Função} copyreg.pickle (type, function, constructor_ob=None)

Declara que a `function' deve ser usada como uma função de “redução” para objetos do tipo `type'. `function' deve retornar uma string ou uma tupla contendo entre dois e seis elementos. Veja @ref{1161,,dispatch_table} para mais detalhes sobre a interface da `function'.

O parâmetro `constructor_ob' é um recurso herdado e agora é ignorado, mas se passado deve ser UM chamável.

Note que o atributo @ref{1161,,dispatch_table} de um objeto pickler ou subclasse de @ref{a28,,pickle.Pickler} também podem ser usados para declarar funções de redução.
@end deffn

@menu
* Exemplo: Exemplo<5>. 

@end menu

@node Exemplo<5>,,,copyreg — Registra funções de suporte pickle
@anchor{library/copyreg example}@anchor{2a69}
@subsubsection Exemplo


O exemplo abaixo gostaria de mostrar como registrar uma função de pickle e como ela será usada:

@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 — Serialização interna de objetos Python,copyreg — Registra funções de suporte pickle,Persistência de Dados
@anchor{library/shelve doc}@anchor{2a6a}@anchor{library/shelve module-shelve}@anchor{c3}@anchor{library/shelve shelve-python-object-persistence}@anchor{2a6b}@anchor{library/shelve translation-repo}@anchor{2a6c}
@subsection @code{shelve} — Python object persistence


@geindex module; shelve

`Código-fonte:' Lib/shelve.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/shelve.py}

@geindex módulo;pickle


__________________________________________________________________


A “shelf” is a persistent, dictionary-like object.  The difference with “dbm”
databases is that the values (not the keys!) in a shelf can be essentially
arbitrary Python objects — anything that the @ref{a6,,pickle} module can handle.
This includes most class instances, recursive data types, and objects containing
lots of shared  sub-objects.  The keys are ordinary strings.

@geindex open() (no módulo shelve)
@anchor{library/shelve shelve open}@anchor{17f3}
@deffn {Função} shelve.open (filename, flag='c', protocol=None, writeback=False)

Open a persistent dictionary.  The filename specified is the base filename for
the underlying database.  As a side-effect, an extension may be added to the
filename and more than one file may be created.  By default, the underlying
database file is opened for reading and writing.  The optional `flag' parameter
has the same interpretation as the `flag' parameter of @ref{f5c,,dbm.open()}.

By default, pickles created with @ref{831,,pickle.DEFAULT_PROTOCOL} are used
to serialize values.  The version of the pickle protocol can be specified
with the `protocol' parameter.

Because of Python semantics, a shelf cannot know when a mutable
persistent-dictionary entry is modified.  By default modified objects are
written `only' when assigned to the shelf (see @ref{2a6d,,Exemplo}).  If the
optional `writeback' parameter is set to @code{True}, all entries accessed are also
cached in memory, and written back on @ref{2a6e,,sync()} and
@ref{2a6f,,close()}; this can make it handier to mutate mutable entries in
the persistent dictionary, but, if many entries are accessed, it can consume
vast amounts of memory for the cache, and it can make the close operation
very slow since all accessed entries are written back (there is no way to
determine which accessed entries are mutable, nor which ones were actually
mutated).


Alterado na versão 3.10: @ref{831,,pickle.DEFAULT_PROTOCOL} is now used as the default pickle
protocol.



Alterado na versão 3.11: Aceita um @ref{2a0,,objeto caminho ou similar} como nome de arquivo.


@cartouche
@quotation Nota 
Do not rely on the shelf being closed automatically; always call
@ref{2a6f,,close()} explicitly when you don’t need it any more, or
use @ref{17f3,,shelve.open()} as a context manager:

@example
with shelve.open('spam') as db:
    db['eggs'] = 'eggs'
@end example
@end quotation
@end cartouche
@end deffn
@anchor{library/shelve shelve-security}@anchor{2a70}
@cartouche
@quotation Aviso 
Because the @ref{c3,,shelve} module is backed by @ref{a6,,pickle}, it is insecure
to load a shelf from an untrusted source.  Like with pickle, loading a shelf
can execute arbitrary code.
@end quotation
@end cartouche

Shelf objects support most of methods and operations supported by dictionaries
(except copying, constructors and operators @code{|} and @code{|=}).  This eases the
transition from dictionary based scripts to those requiring persistent storage.

Two additional methods are supported:

@geindex sync() (método shelve.Shelf)
@anchor{library/shelve shelve Shelf sync}@anchor{2a6e}
@deffn {Método} Shelf.sync ()

Write back all entries in the cache if the shelf was opened with `writeback'
set to @ref{c27,,True}.  Also empty the cache and synchronize the persistent
dictionary on disk, if feasible.  This is called automatically when the shelf
is closed with @ref{2a6f,,close()}.
@end deffn

@geindex close() (método shelve.Shelf)
@anchor{library/shelve shelve Shelf close}@anchor{2a6f}
@deffn {Método} Shelf.close ()

Synchronize and close the persistent `dict' object.  Operations on a closed
shelf will fail with a @ref{202,,ValueError}.
@end deffn


@subsubheading Ver também


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
* Restrições:: 
* Exemplo: Exemplo<6>. 

@end menu

@node Restrições,Exemplo<6>,,shelve — Python object persistence
@anchor{library/shelve restrictions}@anchor{2a71}
@subsubsection Restrições


@geindex módulo;dbm.ndbm
@geindex módulo;dbm.gnu


@itemize *

@item 
The choice of which database package will be used (such as @ref{34,,dbm.ndbm} or
@ref{33,,dbm.gnu}) depends on which interface is available.  Therefore it is not
safe to open the database directly using @ref{31,,dbm}.  The database is also
(unfortunately) subject to the limitations of @ref{31,,dbm}, if it is used —
this means that (the pickled representation of) the objects stored in the
database should be fairly small, and in rare cases key collisions may cause
the database to refuse updates.

@item 
The @ref{c3,,shelve} module does not support `concurrent' read/write access to
shelved objects.  (Multiple simultaneous read accesses are safe.)  When a
program has a shelf open for writing, no other program should have it open for
reading or writing.  Unix file locking can be used to solve this, but this
differs across Unix versions and requires knowledge about the database
implementation used.

@item 
On macOS @ref{34,,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 (classe em shelve)
@anchor{library/shelve shelve Shelf}@anchor{fcf}
@deffn {Classe} shelve.Shelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

A subclass of @ref{10eb,,collections.abc.MutableMapping} which stores pickled
values in the `dict' object.

By default, pickles created with @ref{831,,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.

If the `writeback' parameter is @code{True}, the object will hold a cache of all
entries accessed and write them back to the `dict' at sync and close times.
This allows natural operations on mutable entries, but can consume much more
memory and make sync and close take a long time.

The `keyencoding' parameter is the encoding used to encode keys before they
are used with the underlying dict.

A @ref{fcf,,Shelf} object can also be used as a context manager, in which
case it will be automatically closed when the @ref{5d2,,with} block ends.


Alterado na versão 3.2: Added the `keyencoding' parameter; previously, keys were always encoded in
UTF-8.



Alterado na versão 3.4: Adicionado suporte a gerenciador de contexto.



Alterado na versão 3.10: @ref{831,,pickle.DEFAULT_PROTOCOL} is now used as the default pickle
protocol.

@end deffn

@geindex BsdDbShelf (classe em shelve)
@anchor{library/shelve shelve BsdDbShelf}@anchor{23ed}
@deffn {Classe} shelve.BsdDbShelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

A subclass of @ref{fcf,,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{fcf,,Shelf} class.
@end deffn

@geindex DbfilenameShelf (classe em shelve)
@anchor{library/shelve shelve DbfilenameShelf}@anchor{23ee}
@deffn {Classe} shelve.DbfilenameShelf (filename, flag='c', protocol=None, writeback=False)

A subclass of @ref{fcf,,Shelf} which accepts a `filename' instead of a dict-like
object.  The underlying file will be opened using @ref{f5c,,dbm.open()}.  By
default, the file will be created and opened for both read and write.  The
optional `flag' parameter has the same interpretation as for the @ref{17f3,,open()}
function.  The optional `protocol' and `writeback' parameters have the same
interpretation as for the @ref{fcf,,Shelf} class.
@end deffn

@node Exemplo<6>,,Restrições,shelve — Python object persistence
@anchor{library/shelve example}@anchor{2a72}@anchor{library/shelve shelve-example}@anchor{2a6d}
@subsubsection Exemplo


To summarize the interface (@code{key} is a string, @code{data} is an arbitrary
object):

@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 também



@table @asis

@item Módulo @ref{31,,dbm}

Generic interface to @code{dbm}-style databases.

@item Módulo @ref{a6,,pickle}

Object serialization used by @ref{c3,,shelve}.
@end table


@node marshal — Serialização interna de objetos Python,dbm — Interfaces para “banco de dados” Unix,shelve — Python object persistence,Persistência de Dados
@anchor{library/marshal doc}@anchor{2a73}@anchor{library/marshal marshal-internal-python-object-serialization}@anchor{2a74}@anchor{library/marshal module-marshal}@anchor{8d}@anchor{library/marshal translation-repo}@anchor{2a75}
@subsection @code{marshal} — Serialização interna de objetos Python


@geindex module; marshal


__________________________________________________________________


Este módulo contém funções que podem ler e gravar valores Python em formato binário. O formato é específico para Python, mas independente dos problemas de arquitetura da máquina (por exemplo, você pode gravar um valor Python em um arquivo em um PC, transportar o arquivo para um Mac e lê-lo de volta lá). Os detalhes do formato não são documentados propositalmente; ele pode mudar entre as versões do Python (embora raramente mude). @footnote{
O nome deste módulo deriva de um pouco da terminologia usada pelos designers do Modula-3 (entre outros), que usam o termo “marshalling” para enviar dados em um formato independente. Estritamente falando, “to marshal” significa converter alguns dados da forma interna para a externa (em um buffer RPC, por exemplo) e “unmarshalling” para o processo reverso.
}

@geindex módulo;pickle
@geindex módulo;shelve

Este não é um módulo de “persistência” geral. Para persistência geral e transferência de objetos Python através de chamadas RPC, veja os módulos @ref{a6,,pickle} e @ref{c3,,shelve}. O módulo @ref{8d,,marshal} existe principalmente para ter suporte à leitura e escrita do código “pseudocompilado” para módulos Python de arquivos @code{.pyc}. Portanto, os mantenedores do Python se reservam o direito de modificar o formato do marshal de maneiras incompatíveis com versões anteriores, caso seja necessário. O formato dos objetos código não é compatível entre as versões do Python, mesmo que a versão do formato seja a mesma. Desserializar um objeto código na versão incorreta do Python tem um comportamento indefinido. Se você estiver serializando e desserializando objetos Python, use o módulo @ref{a6,,pickle} – o desempenho é comparável, a independência de versão é garantida e pickle tem suporte a uma gama substancialmente maior de objetos do que marshal.

@cartouche
@quotation Aviso 
O módulo @ref{8d,,marshal} não se destina a ser seguro contra dados errôneos ou construídos de forma maliciosa. Nunca faça o unmarshalling de dados recebidos de uma fonte não confiável ou não autenticada.
@end quotation
@end cartouche

@geindex objeto;código
@geindex objeto código

Nem todos os tipos de objetos Python são manipuláveis com marshal; em geral, apenas objetos cujo valor é independente de uma invocação particular de Python podem ser escritos e lidos por este módulo. Os seguintes tipos são suportados: booleanos, inteiros, números de ponto flutuante, números complexos, strings, bytes, bytearrays, tuplas, listas, conjuntos, conjuntos congelados, dicionários e objetos código (se `allow_code' for verdadeiro), onde deve ser entendido que tuplas, listas, conjuntos, conjuntos congelados e os dicionários são suportados apenas enquanto os próprios valores contidos neles forem suportados. Os valores únicos @ref{675,,None}, @ref{231c,,Ellipsis} e @ref{c15,,StopIteration} também podem ser serializados e dessarializados com marshal. Para formato `version' inferior a 3, listas recursivas, conjuntos e dicionários não podem ser escritos (veja abaixo).

Existem funções que leem/gravam arquivos, bem como funções que operam em objetos bytes ou similares.

O módulo define estas funções:

@geindex dump() (no módulo marshal)
@anchor{library/marshal marshal dump}@anchor{2a76}
@deffn {Função} marshal.dump (value, file, version=version, /, *, allow_code=True)

Grava o valor no arquivo aberto. O valor deve ser um tipo compatível. O arquivo deve ser @ref{1e0e,,arquivo binário} gravável.

Se o valor tem (ou contém um objeto que tem) um tipo não suportado, uma exceção @ref{202,,ValueError} é levantada – mas dados de lixo também serão gravados no arquivo. O objeto não será lido corretamente por @ref{1b8b,,load()}. Há suporte a @ref{1d2,,objetos código} somente se `allow_code' for verdadeiro.

O argumento `version' indica o formato de dados que o @code{dump} deve usar (veja abaixo).

Levanta um @ref{19fa,,evento de auditoria} @code{marshal.dumps} com os argumentos @code{value}, @code{version}.


Alterado na versão 3.13: Adicionado o parâmetro `allow_code'.

@end deffn

@geindex load() (no módulo marshal)
@anchor{library/marshal marshal load}@anchor{1b8b}
@deffn {Função} marshal.load (file, /, *, allow_code=True)

Lê um valor do arquivo aberto e retorna-o. Se nenhum valor válido for lido (por exemplo, porque os dados têm um formato de empacotamento incompatível com uma versão diferente do Python), levanta @ref{131c,,EOFError}, @ref{202,,ValueError} ou @ref{2c3,,TypeError}. Há suporte a @ref{1d2,,objetos código} somente se `allow_code' for verdadeiro. O arquivo deve ser um @ref{1e0e,,arquivo binário} legível.

Levanta um @ref{19fa,,evento de auditoria} @code{marshal.load} sem argumentos.

@cartouche
@quotation Nota 
Se um objeto contendo um tipo não suportado foi empacotado com @ref{2a76,,dump()}, @ref{1b8b,,load()} irá substituir @code{None} pelo tipo não empacotável.
@end quotation
@end cartouche


Alterado na versão 3.10: Esta chamada costumava levantar um evento de auditoria @code{code.__new__} para cada objeto código. Agora, ele levanta um único evento @code{marshal.load} para toda a operação de carregamento.



Alterado na versão 3.13: Adicionado o parâmetro `allow_code'.

@end deffn

@geindex dumps() (no módulo marshal)
@anchor{library/marshal marshal dumps}@anchor{ed4}
@deffn {Função} marshal.dumps (value, version=version, /, *, allow_code=True)

Retorna o objeto bytes que seria escrito em um arquivo por @code{dump(value, file)}. O valor deve ser um tipo compatível. Levanta uma exceção @ref{202,,ValueError} se o valor tem (ou contém um objeto que tem) um tipo não suportado. Há suporte a @ref{1d2,,objetos código} somente se `allow_code' for verdadeiro.

O argumento `version' indica o formato de dados que @code{dumps} deve usar (veja abaixo).

Levanta um @ref{19fa,,evento de auditoria} @code{marshal.dumps} com os argumentos @code{value}, @code{version}.


Alterado na versão 3.13: Adicionado o parâmetro `allow_code'.

@end deffn

@geindex loads() (no módulo marshal)
@anchor{library/marshal marshal loads}@anchor{2a77}
@deffn {Função} marshal.loads (bytes, /, *, allow_code=True)

Converte o @ref{d4f,,objeto bytes ou similar} em um valor. Se nenhum valor válido for encontrado, levanta @ref{131c,,EOFError}, @ref{202,,ValueError} ou @ref{2c3,,TypeError}. Há suporte a @ref{1d2,,objetos código} somente se `allow_code' for verdadeiro. Bytes extras na entrada são ignorados.

Levanta um @ref{19fa,,evento de auditoria} @code{marshal.loads} com o argumento @code{bytes}.


Alterado na versão 3.10: Esta chamada costumava levantar um evento de auditoria @code{code.__new__} para cada objeto código. Agora, ele levanta um único evento @code{marshal.loads} para toda a operação de carregamento.



Alterado na versão 3.13: Adicionado o parâmetro `allow_code'.

@end deffn

Além disso, as seguintes constantes são definidas:

@geindex version (no módulo marshal)
@anchor{library/marshal marshal version}@anchor{2a78}
@deffn {Dado} marshal.version

Indica o formato que o módulo usa. A versão 0 é o formato histórico, a versão 1 compartilha strings internas e a versão 2 usa um formato binário para números de ponto flutuante. A versão 3 adiciona suporte para instanciação e recursão de objetos. A versão atual é a 4.
@end deffn

@node dbm — Interfaces para “banco de dados” Unix,sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite,marshal — Serialização interna de objetos Python,Persistência de Dados
@anchor{library/dbm doc}@anchor{2a79}@anchor{library/dbm dbm-interfaces-to-unix-databases}@anchor{2a7a}@anchor{library/dbm module-dbm}@anchor{31}@anchor{library/dbm translation-repo}@anchor{2a7b}
@subsection @code{dbm} — Interfaces para “banco de dados” Unix


@geindex module; dbm

`Código-fonte:' Lib/dbm/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dbm/__init__.py}


__________________________________________________________________


@ref{31,,dbm} é uma interface genérica para variantes do banco de dados DBM:


@itemize *

@item 
@ref{35,,dbm.sqlite3}

@item 
@ref{33,,dbm.gnu}

@item 
@ref{34,,dbm.ndbm}
@end itemize

Se nenhum desses módulos estiverem instalados, a implementação lenta, mas simples, no módulo @ref{32,,dbm.dumb} será usada. Há uma interface de terceiros@footnote{https://www.jcea.es/programacion/pybsddb.htm} para o Oracle Berkeley DB.

@geindex error
@anchor{library/dbm dbm error}@anchor{2a7c}
@deffn {Exceção} dbm.error

Uma tupla contendo as exceções que podem ser levantadas por cada um dos módulos suportados, com a única exceção também chamada @ref{2a7c,,dbm.error} como o primeiro item — o último é usado quando @ref{2a7c,,dbm.error} é levantada.
@end deffn

@geindex whichdb() (no módulo dbm)
@anchor{library/dbm dbm whichdb}@anchor{2a7d}
@deffn {Função} dbm.whichdb (filename)

Esta função tenta adivinhar qual dos vários módulos de banco de dados simples disponíveis — @ref{35,,dbm.sqlite3}, @ref{33,,dbm.gnu}, @ref{34,,dbm.ndbm} ou @ref{32,,dbm.dumb} — deve ser usado para abrir o arquivo fornecido.

Retorna um dos seguintes valores:


@itemize *

@item 
@code{None} se o arquivo não puder ser aberto porque está ilegível ou não existe

@item 
a string vazia (@code{'@w{'}}) se o formato do arquivo não puder ser adivinhado

@item 
uma string contendo o nome do módulo necessário, tal como @code{'dbm.ndbm'} ou @code{'dbm.gnu'}
@end itemize


Alterado na versão 3.11: `filename' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@c Substitutions for the open() flag param docs;
@c all submodules use the same text.

@geindex open() (no módulo dbm)
@anchor{library/dbm dbm open}@anchor{f5c}
@deffn {Função} dbm.open (file, flag='r', mode=0o666)

Abre um banco de dados e retorna o objeto banco de dados correspondendo.

@*Parâmetros: 

@itemize *

@item 
@code{file} (@ref{2a0,,path-like object}) – O arquivo de banco de dados para abrir. Se o arquivo de banco de dados já existe, a função @ref{2a7d,,whichdb()} é usada para determinar seu tipo e o módulo apropriado é usado; se ele não existir, o primeiro submódulo listado acima que pode ser importado é usado.

@item 
@code{flag} (@ref{44c,,str}) – 

@itemize *

@item 
@code{'r'} (padrão): 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{257,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize



Alterado na versão 3.11: `file' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

O objeto retornado por @ref{f5c,,open()} oferece suporte à funcionalidade básica de @ref{11fb,,mapeamentos} mutáveis; chaves e seus valores correspondentes podem ser armazenados, recuperados e excluídos, e iteração, o operador @ref{2f4,,in} e os métodos @code{keys()}, @code{get()}, @code{setdefault()} e @code{clear()} estão disponíveis. O método @code{keys()} retorna uma lista em vez de um objeto de visualização. O método @code{setdefault()} requer dois argumentos.

Chaves e valores são sempre armazenados como @ref{1c2,,bytes}. Isso significa que quando strings são usadas, elas são implicitamente convertidas para a codificação padrão antes de serem armazenadas.

Estes objetos também oferecem suporte a serem usados em uma instrução @ref{5d2,,with}, que vai fechá-los automaticamente quando estiver concluída.


Alterado na versão 3.2: O métodos @code{get()} e @code{setdefault()} estão agora disponíveis para todos os backends do @ref{31,,dbm}.



Alterado na versão 3.4: Adicionado suporte nativo para o protocolo de gerenciamento de contexto para os objetos retornados por @ref{f5c,,open()}.



Alterado na versão 3.8: Excluir uma chave de um banco de dados somente leitura levanta uma exceção de banco de dados específica do módulo em vez de @ref{344,,KeyError}.



Alterado na versão 3.13: Os métodos @code{clear()} estão agora disponíveis para todos os backends do @ref{31,,dbm}.


Os seguintes exemplos registram alguns hostnames e um título correspondente, e então exibe o conteúdo do banco de dados:

@example
import dbm

# Abre o banco de dados, criando-o se necessário.
with dbm.open('cache', 'c') as db:

    # Registra alguns valores
    db[b'hello'] = b'there'
    db['www.python.org'] = 'Python Website'
    db['www.cnn.com'] = 'Cable News Network'

    # Note que as chaves são consideradas bytes agora.
    assert db[b'www.python.org'] == b'Python Website'
    # Observe como o valor é agora em bytes.
    assert db['www.cnn.com'] == b'Cable News Network'

    # Métodos geralmente usados da interface dict funcionam também.
    print(db.get('python.org', b'not present'))

    # Armazenar uma chave não-string ou valor  vai levantar uma exceção
    # (provavelmente uma TypeError).
    db['www.yahoo.com'] = 4

# db é automaticamente fechado a sair da instrução with.
@end example


@subsubheading Ver também



@table @asis

@item Módulo @ref{c3,,shelve}

Módulo persistente que armazena dados não-string.
@end table


Os submódulos individuais são descritos nas seções a seguir.

@menu
* dbm.sqlite3 — Backend de SQLite para dbm: dbm sqlite3 — Backend de SQLite para dbm. 
* dbm.gnu — Gerenciador de banco de dados do GNU: dbm gnu — Gerenciador de banco de dados do GNU. 
* dbm.ndbm — New Database Manager: dbm ndbm — New Database Manager. 
* dbm.dumb — Implementação portátil do DBM: dbm dumb — Implementação portátil do DBM. 

@end menu

@node dbm sqlite3 — Backend de SQLite para dbm,dbm gnu — Gerenciador de banco de dados do GNU,,dbm — Interfaces para “banco de dados” Unix
@anchor{library/dbm dbm-sqlite3-sqlite-backend-for-dbm}@anchor{2a7e}@anchor{library/dbm module-dbm sqlite3}@anchor{35}
@subsubsection @code{dbm.sqlite3} — Backend de SQLite para dbm


@geindex module; dbm.sqlite3


Adicionado na versão 3.13.


`Código-fonte:' Lib/dbm/sqlite3.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dbm/sqlite3.py}


__________________________________________________________________


Este módulo usa o módulo da biblioteca padrão @ref{cf,,sqlite3} para fornecer um backend de SQLite para o módulo @ref{31,,dbm}. Os arquivos criados por @ref{35,,dbm.sqlite3} podem então ser abertos por @ref{cf,,sqlite3} ou quaisquer outros navegadores de SQLite, incluindo CLI do SQLite.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@geindex open() (no módulo dbm.sqlite3)
@anchor{library/dbm dbm sqlite3 open}@anchor{2a7f}
@deffn {Função} dbm.sqlite3.open (filename, /, flag='r', mode=0o666)

Abre um banco de dados SQLite.

@*Parâmetros: 

@itemize *

@item 
@code{filename} (@ref{2a0,,path-like object}) – O caminho para o banco de dados a ser aberta.

@item 
@code{flag} (@ref{44c,,str}) – 

@itemize *

@item 
@code{'r'} (padrão): 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} – O modo de acesso a arquivos do Unix do arquivo (padrão: octal @code{0o666}), usado apenas quando o banco de dados tem que ser criado.
@end itemize


O objeto de banco de dados retornado se comporta de forma semelhante a um @ref{11fb,,mapeamento} mutável, mas o método @code{keys()} retorna uma lista e o método @code{setdefault()} requer dois argumentos. Ele também oferece suporte a um gerenciador de contexto de “fechamento” por meio da palavra reservada @ref{5d2,,with}.

O seguinte método também é fornecido:

@geindex close() (método dbm.sqlite3.sqlite3)
@anchor{library/dbm dbm sqlite3 sqlite3 close}@anchor{2a80}
@deffn {Método} sqlite3.close ()

Fecha o banco de dados SQLite.
@end deffn
@end deffn

@node dbm gnu — Gerenciador de banco de dados do GNU,dbm ndbm — New Database Manager,dbm sqlite3 — Backend de SQLite para dbm,dbm — Interfaces para “banco de dados” Unix
@anchor{library/dbm dbm-gnu-gnu-database-manager}@anchor{2a81}@anchor{library/dbm module-dbm gnu}@anchor{33}
@subsubsection @code{dbm.gnu} — Gerenciador de banco de dados do GNU


@geindex module; dbm.gnu

`Código-fonte:' Lib/dbm/gnu.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dbm/gnu.py}


__________________________________________________________________


O módulo @ref{33,,dbm.gnu} fornece uma interface para a biblioteca @abbr{GDBM,GNU dbm}, semelhante ao módulo @ref{34,,dbm.ndbm}, mas com funcionalidades adicionais, como tolerância a falhas.

@cartouche
@quotation Nota 
Os formatos de arquivo criados por @ref{33,,dbm.gnu} e @ref{34,,dbm.ndbm} são incompatíveis e não podem ser usados de forma intercambiável.
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@geindex error
@anchor{library/dbm dbm gnu error}@anchor{aa9}
@deffn {Exceção} dbm.gnu.error

Levantada em erros específicos do @ref{33,,dbm.gnu}, como erros de E/S. @ref{344,,KeyError} é levantada para erros gerais de mapeamento, como especificar uma chave incorreta.
@end deffn

@geindex open_flags (no módulo dbm.gnu)
@anchor{library/dbm dbm gnu open_flags}@anchor{2a82}
@deffn {Dado} dbm.gnu.open_flags

Uma sequência de caracteres que o parâmetro `flag' de @ref{1bb7,,open()} suporta.
@end deffn

@geindex open() (no módulo dbm.gnu)
@anchor{library/dbm dbm gnu open}@anchor{1bb7}
@deffn {Função} dbm.gnu.open (filename, flag='r', mode=0o666, /)

Abre um banco de dados GDBM e retorna um objeto @code{gdbm}.

@*Parâmetros: 

@itemize *

@item 
@code{filename} (@ref{2a0,,path-like object}) – O arquivo de banco de dados para abrir.

@item 
@code{flag} (@ref{44c,,str}) – 

@itemize *

@item 
@code{'r'} (padrão): 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

Os seguintes caracteres adicionais podem ser acrescentados para controlar como o banco de dados é aberto:


@itemize *

@item 
@code{'f'}: Abre o banco de dados em modo rápido. As gravações no banco de dados não serão sincronizadas.

@item 
@code{'s'}: Modo sincronizado. Alterações no banco de dados serão gravadas imediatamente no arquivo.

@item 
@code{'u'}: Não trava o banco de dados.
@end itemize

Nem todos os sinalizadores são válidos para todas as versões do GDBM. Veja o membro @ref{2a82,,open_flags} para uma lista de caracteres de sinalizadores suportados.


@item 
@code{mode} (@ref{257,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@*Levanta: 
@ref{aa9,,error} – Se um argumento `flag' inválido for passado.



Alterado na versão 3.11: `filename' aceita um @ref{2a0,,objeto caminho ou similar}.


Objetos @code{gdbm} se comportam de forma semelhante aos @ref{11fb,,mapeamentos} mutáveis, mas os métodos @code{items()}, @code{values()}, @code{pop()}, @code{popitem()} e @code{update()} não são suportados, @code{keys()} retorna uma lista e o método @code{setdefault()} requer dois argumentos. Ele também oferece suporte a um gerenciador de contexto de “fechamento” por meio da palavra reservada @ref{5d2,,with}.


Alterado na versão 3.2: Adiciionados os métodos @code{get()} e @code{setdefault()}.



Alterado na versão 3.13: Adicionado o método @code{clear()}.


Os seguintes métodos também são fornecidos:

@geindex close() (método dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm close}@anchor{2a83}
@deffn {Método} gdbm.close ()

Fecha o banco de dados GDBM.
@end deffn

@geindex firstkey() (método dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm firstkey}@anchor{2a84}
@deffn {Método} gdbm.firstkey ()

É possível fazer um laço em cada chave no banco de dados usando este método e o método @ref{2a85,,nextkey()}. A travessia é ordenada pelos valores de hash internos do GDBM e não será classificada pelos valores de chave. Este método retorna a chave inicial.
@end deffn

@geindex nextkey() (método dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm nextkey}@anchor{2a85}
@deffn {Método} gdbm.nextkey (key)

Retorna a chave que segue `key' na travessia. O código a seguir imprime cada chave no banco de dados @code{db}, sem precisar criar uma lista na memória que contenha todas elas:

@example
k = db.firstkey()
while k is not None:
    print(k)
    k = db.nextkey(k)
@end example
@end deffn

@geindex reorganize() (método dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm reorganize}@anchor{2a86}
@deffn {Método} gdbm.reorganize ()

Se você realizou muitas exclusões e gostaria de reduzir o espaço usado pelo arquivo GDBM, esta rotina reorganizará o banco de dados. Objetos @code{gdbm} não reduzirão o tamanho de um arquivo de banco de dados, exceto usando esta reorganização; caso contrário, o espaço de arquivo excluído será mantido e reutilizado à medida que novos pares (chave, valor) forem adicionados.
@end deffn

@geindex sync() (método dbm.gnu.gdbm)
@anchor{library/dbm dbm gnu gdbm sync}@anchor{2a87}
@deffn {Método} gdbm.sync ()

Quando o banco de dados é aberto no modo rápido, esse método força a gravação de todos os dados não gravados no disco.
@end deffn
@end deffn

@node dbm ndbm — New Database Manager,dbm dumb — Implementação portátil do DBM,dbm gnu — Gerenciador de banco de dados do GNU,dbm — Interfaces para “banco de dados” Unix
@anchor{library/dbm dbm-ndbm-new-database-manager}@anchor{2a88}@anchor{library/dbm module-dbm ndbm}@anchor{34}
@subsubsection @code{dbm.ndbm} — New Database Manager


@geindex module; dbm.ndbm

`Código-fonte:' Lib/dbm/ndbm.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dbm/ndbm.py}


__________________________________________________________________


O módulo @ref{34,,dbm.ndbm} fornece uma interface para a biblioteca @abbr{NDBM,New Database Manager}. Este módulo pode ser usado com a interface NDBM “clássica” ou a interface de compatibilidade @abbr{GDBM}.

@cartouche
@quotation Nota 
Os formatos de arquivo criados por @ref{33,,dbm.gnu} e @ref{34,,dbm.ndbm} são incompatíveis e não podem ser usados de forma intercambiável.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
A biblioteca NDBM enviada como parte do macOS tem uma limitação não documentada no tamanho dos valores, o que pode resultar em arquivos de banco de dados corrompidos ao armazenar valores maiores que esse limite. Ler esses arquivos corrompidos pode resultar em uma falha grave (falha de segmentação).
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@geindex error
@anchor{library/dbm dbm ndbm error}@anchor{aaa}
@deffn {Exceção} dbm.ndbm.error

Levantada em erros específicos de @ref{34,,dbm.ndbm}, como erros de E/S. @ref{344,,KeyError} é levantada para erros gerais de mapeamento, como especificar uma chave incorreta.
@end deffn

@geindex library (no módulo dbm.ndbm)
@anchor{library/dbm dbm ndbm library}@anchor{2a89}
@deffn {Dado} dbm.ndbm.library

Nome da biblioteca de implementação NDBM usada.
@end deffn

@geindex open() (no módulo dbm.ndbm)
@anchor{library/dbm dbm ndbm open}@anchor{1bb8}
@deffn {Função} dbm.ndbm.open (filename, flag='r', mode=0o666, /)

Abre um banco de dados NDBM e retorna um objeto @code{ndbm}.

@*Parâmetros: 

@itemize *

@item 
@code{filename} (@ref{2a0,,path-like object}) – O nome base do arquivo de banco de dados (sem as extensões @code{.dir} ou @code{.pag}).

@item 
@code{flag} (@ref{44c,,str}) – 

@itemize *

@item 
@code{'r'} (padrão): 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{257,,int}) – The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize



Alterado na versão 3.11: Aceita um @ref{2a0,,objeto caminho ou similar} como nome de arquivo.


Objetos @code{ndbm} se comportam de forma semelhante aos @ref{11fb,,mapeamentos} mutáveis, mas os métodos @code{items()}, @code{values()}, @code{pop()}, @code{popitem()} e @code{update()} não são suportados, @code{keys()} retorna uma lista e o método @code{setdefault()} requer dois argumentos. Ele também oferece suporte a um gerenciador de contexto de “fechamento” por meio da palavra reservada @ref{5d2,,with}.


Alterado na versão 3.2: Adiciionados os métodos @code{get()} e @code{setdefault()}.



Alterado na versão 3.13: Adicionado o método @code{clear()}.


O seguinte método também é fornecido:

@geindex close() (método dbm.ndbm.ndbm)
@anchor{library/dbm dbm ndbm ndbm close}@anchor{2a8a}
@deffn {Método} ndbm.close ()

Fecha o banco de dados NDBM.
@end deffn
@end deffn

@node dbm dumb — Implementação portátil do DBM,,dbm ndbm — New Database Manager,dbm — Interfaces para “banco de dados” Unix
@anchor{library/dbm dbm-dumb-portable-dbm-implementation}@anchor{2a8b}@anchor{library/dbm module-dbm dumb}@anchor{32}
@subsubsection @code{dbm.dumb} — Implementação portátil do DBM


@geindex module; dbm.dumb

`Código-fonte:' Lib/dbm/dumb.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dbm/dumb.py}

@geindex bancos de dados

@cartouche
@quotation Nota 
O módulo @ref{32,,dbm.dumb} é pensado como um último recurso alternativo para o módulo @ref{31,,dbm} quando um módulo mais robusto não está disponível. O módulo @ref{32,,dbm.dumb} não é escrito para velocidade e não é tão usado quanto os outros módulos de banco de dados.
@end quotation
@end cartouche


__________________________________________________________________


O módulo @ref{32,,dbm.dumb} fornece uma interface persistente do tipo @ref{256,,dict} que é escrita inteiramente em Python. Ao contrário de outros backends @ref{31,,dbm}, como @ref{33,,dbm.gnu}, nenhuma biblioteca externa é necessária.

O módulo @code{dbm.dumb} define o seguinte:

@geindex error
@anchor{library/dbm dbm dumb error}@anchor{aa8}
@deffn {Exceção} dbm.dumb.error

Levantada em erros específicos de @ref{32,,dbm.dumb}, como erros de E/S. @ref{344,,KeyError} é levantada para erros gerais de mapeamento, como especificar uma chave incorreta.
@end deffn

@geindex open() (no módulo dbm.dumb)
@anchor{library/dbm dbm dumb open}@anchor{aa5}
@deffn {Função} dbm.dumb.open (filename, flag='c', mode=0o666)

Abre um banco de dados @code{dbm.dumb}.

@*Parâmetros: 

@itemize *

@item 
@code{filename} – O nome base do arquivo do banco de dados (sem extensões). Um novo banco de dados cria os seguintes arquivos: - @code{`filename'.dat} - @code{`filename'.dir}

@item 
@code{flag} (@ref{44c,,str}) – 

@itemize *

@item 
@code{'r'}: Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'} (padrão): 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{257,,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 Aviso 
É possível travar o interpretador Python ao carregar um banco de dados com uma entrada suficientemente grande/complexa devido a limitações de profundidade de pilha no compilador AST do Python.
@end quotation
@end cartouche


Alterado na versão 3.5: @ref{aa5,,open()} sempre cria um novo banco de dados quando `flag' é @code{'n'}.



Alterado na versão 3.8: Um banco de dados aberto somente leitura se `flag' for @code{'r'}. Um banco de dados não é criado se não existir se `flag' for @code{'r'} ou @code{'w'}.



Alterado na versão 3.11: `filename' aceita um @ref{2a0,,objeto caminho ou similar}.


O objeto de banco de dados retornado se comporta de forma semelhante a um @ref{11fb,,mapeamento} mutável, mas os métodos @code{keys()} e @code{items()} retornam uma lista e o método @code{setdefault()} requer dois argumentos. Ele também oferece suporte a um gerenciador de contexto de “fechamento” por meio da palavra reservada @ref{5d2,,with}.

Os seguintes métodos também são fornecidos:

@geindex close() (método dbm.dumb.dumbdbm)
@anchor{library/dbm dbm dumb dumbdbm close}@anchor{2a8c}
@deffn {Método} dumbdbm.close ()

Fecha o banco de dados.
@end deffn

@geindex sync() (método dbm.dumb.dumbdbm)
@anchor{library/dbm dbm dumb dumbdbm sync}@anchor{2a8d}
@deffn {Método} dumbdbm.sync ()

Sincroniza o diretório no disco e os arquivos de dados. Este método é chamado pelo método @ref{2a6e,,shelve.Shelf.sync()}.
@end deffn
@end deffn

@node sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite,,dbm — Interfaces para “banco de dados” Unix,Persistência de Dados
@anchor{library/sqlite3 doc}@anchor{2a8e}@anchor{library/sqlite3 module-sqlite3}@anchor{cf}@anchor{library/sqlite3 sqlite3-db-api-2-0-interface-for-sqlite-databases}@anchor{2a8f}@anchor{library/sqlite3 translation-repo}@anchor{2a90}
@subsection @code{sqlite3} —- interface DB-API 2.0 interface para bancos de dados SQLite


@geindex module; sqlite3

`Código-fonte:' Lib/sqlite3/@footnote{https://github.com/python/cpython/tree/3.13/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{2a91}
SQLite é uma biblioteca C que fornece um banco de dados leve baseado em disco que não requer um processo de servidor separado e permite acessar o banco de dados usando uma variante não padrão da linguagem de consulta SQL. Algumas aplicações podem usar SQLite para armazenamento interno de dados. Também é possível prototipar um aplicativo usando SQLite e, em seguida, portar o código para um banco de dados maior, como PostgreSQL ou Oracle.

O módulo @code{sqlite3} foi escrito por Gerhard Häring. Ele oferece uma interface SQL compatível com a especificação DB-API 2.0 descrita pela 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} e requer o SQLite 3.15.2 ou o mais recente.

Esse documento inclui quatro seções principais:


@itemize *

@item 
@ref{2a92,,Tutorial} ensina como usar o módulo @code{sqlite3}.

@item 
@ref{2a93,,Referência} descreve as classes e funções que este módulo define.

@item 
@ref{2a94,,Guias de como fazer} detalha como lidar com tarefas específicas.

@item 
@ref{2a95,,Explicação} fornece informações detalhadas sobre controle de transações.
@end itemize


@subsubheading Ver também



@table @asis

@item @indicateurl{https://www.sqlite.org}

A página web do SQLite; a documentação descreve a sintaxe e os tipos de dados disponíveis para o dialeto SQL suportado.

@item @indicateurl{https://www.w3schools.com/sql/}

Tutoriais, referências e exemplos para aprender a sintaxe SQL.

@geindex Propostas de Melhorias do Python; PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - Especificação 2.0 da API de banco de dados

PEP escrita 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:: 
* Referência:: 
* Guias de como fazer:: 
* Explicação:: 

@end menu

@node Tutorial,Referência,,sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite
@anchor{library/sqlite3 sqlite3-tutorial}@anchor{2a92}@anchor{library/sqlite3 tutorial}@anchor{2a96}
@subsubsection Tutorial


Neste tutorial, você criará um banco de dados de filmes do Monty Python usando a funcionalidade básica @code{sqlite3}. Ele pressupõe uma compreensão fundamental dos conceitos de banco de dados, incluindo cursores@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)} e transações@footnote{https://en.wikipedia.org/wiki/Database_transaction}.

Primeiro, precisamos criar um novo banco de dados e abrir uma conexão com o banco de dados para permitir que @code{sqlite3} funcione com ele. Chame @ref{2a8,,sqlite3.connect()} para criar uma conexão com o banco de dados @code{tutorial.db} no diretório de trabalho atual, criando-o implicitamente se ele não existir:

@example
import sqlite3
con = sqlite3.connect("tutorial.db")
@end example

O objeto @ref{245,,Connection} @code{con} retornado representa a conexão com o banco de dados em disco.

Para executar instruções SQL e buscar resultados de consultas SQL, precisaremos usar um cursor de banco de dados. Chame @ref{2a97,,con.cursor()} para criar o @ref{2a98,,Cursor}:

@example
cur = con.cursor()
@end example

Agora que temos uma conexão com o banco de dados e um cursor, podemos criar uma tabela de banco de dados @code{movie} com colunas para título, ano de lançamento e pontuação da revisão. Para simplificar, podemos apenas usar nomes de colunas na declaração da tabela - graças ao recurso tipagem flexível@footnote{https://www.sqlite.org/flextypegood.html} do SQLite, especificar os tipos de dados é opcional. Execute a instrução @code{CREATE TABLE} chamando @ref{2d1,,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 se a nova tabela foi criada consultando a tabela embutida @code{sqlite_master} no SQLite, que agora deve conter uma entrada para a definição da tabela @code{movie} (veja The Schema Table@footnote{https://www.sqlite.org/schematab.html} para detalhes). Execute essa consulta chamando @ref{2d1,,cur.execute(...)}, atribua o resultado a @code{res} e chame @ref{2a99,,res.fetchone()} para buscar a linha resultante:

@example
>>> res = cur.execute("SELECT name FROM sqlite_master")
>>> res.fetchone()
('movie',)
@end example

Podemos ver que a tabela foi criada, pois a consulta retorna @ref{370,,tuple} contendo o nome da tabela. Se fizermos uma consulta @code{sqlite_master} para uma tabela inexistente @code{spam}, @code{res.fetchone()} ela retornará @code{None}:

@example
>>> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'")
>>> res.fetchone() is None
True
@end example

Agora, adicione duas linhas de dados fornecidos como literais SQL executando uma instrução @code{INSERT}, mais uma vez chamando @ref{2d1,,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

A instrução @code{INSERT} abre implicitamente uma transação, que precisa ser confirmada antes que as alterações sejam salvas no banco de dados (veja @ref{2a9a,,Controle de transações} para detalhes). Chame @ref{2a9b,,con.commit()} no objeto de conexão para confirmar a transação:

@example
con.commit()
@end example

Podemos verificar que os dados foram inseridos corretamente executando uma consulta @code{SELECT}. Use o já conhecido @ref{2d1,,cur.execute(...)} para atribuir o resultado a @code{res} e chame @ref{2a9c,,res.fetchall()} para retornar todas as linhas resultantes.

@example
>>> res = cur.execute("SELECT score FROM movie")
>>> res.fetchall()
[(8.2,), (7.5,)]
@end example

O resultado é uma @ref{611,,list} de duas @code{tuple}s, uma por linha, cada uma contendo o valor @code{score} dessa linha.

Agora, insira mais três linhas chamando @ref{2d2,,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()  # Lembre-sede executar a transação após o INSERT.
@end example

Observe que espaços reservados @code{?} são usados para vincular @code{data} à consulta. Sempre use espaços reservados em vez de @ref{1dfa,,formatação de string} para vincular valores Python a instruções SQL, para evitar ataques de injeção de SQL@footnote{https://en.wikipedia.org/wiki/SQL_injection} (consulte @ref{2d3,,How to use placeholders to bind values in SQL queries} para mais detalhes).

Podemos verificar que as novas linhas foram inseridas executando uma consulta @code{SELECT}, desta vez iterando sobre os resultados da 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 linha é uma @ref{370,,tuple} de dois itens @code{(year, title)}, correspondendo às colunas selecionadas na consulta.

Finalmente, verifique se o banco de dados foi gravado no disco chamando @ref{246,,con.close()} para fechar a conexão existente, abrir uma nova, criar um novo cursor e, em seguida, consultar o banco de dados.

@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

Você agora criou um banco de dados SQLite usando o módulo @code{sqlite3}, inseriu dados e recuperou valores dele de várias maneiras.


@subsubheading Ver também



@itemize *

@item 
@ref{2a94,,Guias de como fazer} para leitura adicional:


@itemize *

@item 
@ref{2d3,,How to use placeholders to bind values in SQL queries}

@item 
@ref{2a9d,,How to adapt custom Python types to SQLite values}

@item 
@ref{2a9e,,How to convert SQLite values to custom Python types}

@item 
@ref{18f7,,How to use the connection context manager}

@item 
@ref{2a9f,,How to create and use row factories}
@end itemize

@item 
@ref{2a95,,Explicação} para obter informações detalhadas sobre o controle de transações.
@end itemize


@node Referência,Guias de como fazer,Tutorial,sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite
@anchor{library/sqlite3 reference}@anchor{2aa0}@anchor{library/sqlite3 sqlite3-reference}@anchor{2a93}
@subsubsection Referência


@c We keep the old sqlite3-module-contents ref to prevent breaking links.
@anchor{library/sqlite3 sqlite3-module-contents}@anchor{2aa1}
@menu
* Funções do módulo:: 
* Constantes do módulo:: 
* Connection objects:: 
* Cursor objects:: 
* Row objects:: 
* Blob objects:: 
* PrepareProtocol objects:: 
* Exceções: Exceções<7>. 
* SQLite and Python types:: 
* Default adapters and converters (deprecated): Default adapters and converters deprecated. 
* Interface de linha de comando:: 

@end menu

@node Funções do módulo,Constantes do módulo,,Referência
@anchor{library/sqlite3 module-functions}@anchor{2aa2}@anchor{library/sqlite3 sqlite3-module-functions}@anchor{2aa3}
@subsubsection Funções do módulo


@geindex connect() (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 connect}@anchor{2a8}
@deffn {Função} 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)

Abra uma conexão com um banco de dados SQLite.

@*Parâmetros: 

@itemize *

@item 
@code{database} (@ref{2a0,,path-like object}) – O caminho para o arquivo do banco de dados a ser aberto. Você pode passar @code{":memory:"} para criar um banco de dados SQLite que existirá apenas na memória@footnote{https://sqlite.org/inmemorydb.html}, e abrir uma conexão com ele.

@item 
@code{timeout} (@ref{2f7,,float}) – Quantos segundos a conexão deve aguardar antes de levantar uma exceção @ref{19dd,,OperationalError} quando uma tabela estiver bloqueada. Se outra conexão abrir uma transação para modificar uma tabela, essa tabela permanecerá bloqueada até que a transação seja confirmada. O padrão é cinco segundos.

@item 
@code{detect_types} (@ref{257,,int}) – Control whether and how data types not
@ref{2aa4,,natively supported by SQLite}
are looked up to be converted to Python types,
using the converters registered with @ref{2aa5,,register_converter()}.
Set it to any combination (using @code{|}, bitwise or) of
@ref{2aa6,,PARSE_DECLTYPES} and @ref{2aa7,,PARSE_COLNAMES}
to enable this.
Column names takes precedence over declared types if both flags are set.
By default (@code{0}), type detection is disabled.

@item 
@code{isolation_level} (@ref{44c,,str}@code{ | }@code{None}) – Control legacy transaction handling behaviour.
See @ref{2aa8,,Connection.isolation_level} and
@ref{2aa9,,Controle de transação através do atributo isolation_level} 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{4b6,,Connection.autocommit} is set to
@ref{2aaa,,LEGACY_TRANSACTION_CONTROL} (the default).

@item 
@code{check_same_thread} (@ref{468,,bool}) – If @code{True} (default), @ref{4f2,,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{67c,,threadsafety} for more information.

@item 
@code{factory} (@ref{245,,Connection}) – A custom subclass of @ref{245,,Connection} to create the connection with,
if not the default @ref{245,,Connection} class.

@item 
@code{cached_statements} (@ref{257,,int}) – The number of statements that @code{sqlite3}
should internally cache for this connection, to avoid parsing overhead.
By default, 128 statements.

@item 
@code{uri} (@ref{468,,bool}) – If set to @code{True}, `database' is interpreted as a
@abbr{URI,Uniform Resource Identifier} with a file path
and an optional query string.
The scheme part `must' be @code{"file:"},
and the path can be relative or absolute.
The query string allows passing parameters to SQLite,
enabling various @ref{2aab,,How to work with SQLite URIs}.

@item 
@code{autocommit} (@ref{468,,bool}) – Control 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} transaction handling behaviour.
See @ref{4b6,,Connection.autocommit} and
@ref{4b7,,Controle de transações através do atributo autocommit} for more information.
`autocommit' currently defaults to
@ref{2aaa,,LEGACY_TRANSACTION_CONTROL}.
The default will change to @code{False} in a future Python release.
@end itemize


@*Tipo de retorno: 
@ref{245,,Connection}


Levanta um @ref{19fa,,evento de auditoria} @code{sqlite3.connect} com o argumento @code{database}.

Levanta um @ref{19fa,,evento de auditoria} @code{sqlite3.connect/handle} com o argumento @code{connection_handle}.


Alterado na versão 3.4: Adicionado o parâmetro `uri'.



Alterado na versão 3.7: `database' can now also be a @ref{2a0,,path-like object}, not only a string.



Alterado na versão 3.10: Added the @code{sqlite3.connect/handle} auditing event.



Alterado na versão 3.12: Added the `autocommit' parameter.



Alterado na versão 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() (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 complete_statement}@anchor{2aac}
@deffn {Função} sqlite3.complete_statement (statement)

Return @code{True} if the string `statement' appears to contain
one or more complete SQL statements.
No syntactic verification or parsing of any kind is performed,
other than checking that there are no unclosed string literals
and the statement is terminated by a semicolon.

Por exemplo:

@example
>>> sqlite3.complete_statement("SELECT foo FROM bar;")
True
>>> sqlite3.complete_statement("SELECT foo")
False
@end example

This function may be useful during command-line input
to determine if the entered text seems to form a complete SQL statement,
or if additional input is needed before calling @ref{2d1,,execute()}.

See @code{runsource()} in Lib/sqlite3/__main__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/sqlite3/__main__.py}
for real-world use.
@end deffn

@geindex enable_callback_tracebacks() (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 enable_callback_tracebacks}@anchor{2aad}
@deffn {Função} sqlite3.enable_callback_tracebacks (flag, /)

Enable or disable callback tracebacks.
By default you will not get any tracebacks in user-defined functions,
aggregates, converters, authorizer callbacks etc. If you want to debug them,
you can call this function with `flag' set to @code{True}. Afterwards, you
will get tracebacks from callbacks on @ref{940,,sys.stderr}. Use @code{False}
to disable the feature again.

@cartouche
@quotation Nota 
Errors in user-defined function callbacks are logged as unraisable exceptions.
Use an @ref{1f7,,unraisable hook handler} for
introspection of the failed callback.
@end quotation
@end cartouche
@end deffn

@geindex register_adapter() (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 register_adapter}@anchor{2aae}
@deffn {Função} sqlite3.register_adapter (type, adapter, /)

Register an `adapter' @ref{2aaf,,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{2aa4,,type that SQLite natively understands}.
@end deffn

@geindex register_converter() (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 register_converter}@anchor{2aa5}
@deffn {Função} sqlite3.register_converter (typename, converter, /)

Register the `converter' @ref{2aaf,,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{1c2,,bytes} object and should return an object of the
desired Python type.
Consult the parameter `detect_types' of
@ref{2a8,,connect()} for information regarding how type detection works.

Note: `typename' and the name of the type in your query are matched
case-insensitively.
@end deffn

@node Constantes do módulo,Connection objects,Funções do módulo,Referência
@anchor{library/sqlite3 module-constants}@anchor{2ab0}@anchor{library/sqlite3 sqlite3-module-constants}@anchor{2ab1}
@subsubsection Constantes do módulo


@geindex LEGACY_TRANSACTION_CONTROL (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 LEGACY_TRANSACTION_CONTROL}@anchor{2aaa}
@deffn {Dado} sqlite3.LEGACY_TRANSACTION_CONTROL

Set @ref{4b6,,autocommit} to this constant to select
old style (pre-Python 3.12) transaction control behaviour.
See @ref{2aa9,,Controle de transação através do atributo isolation_level} for more information.
@end deffn

@geindex PARSE_DECLTYPES (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 PARSE_DECLTYPES}@anchor{2aa6}
@deffn {Dado} sqlite3.PARSE_DECLTYPES

Pass this flag value to the `detect_types' parameter of
@ref{2a8,,connect()} to look up a converter function using
the declared types for each column.
The types are declared when the database table is created.
@code{sqlite3} will look up a converter function using the first word of the
declared type as the converter dictionary key.
For example:

@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

This flag may be combined with @ref{2aa7,,PARSE_COLNAMES} using the @code{|}
(bitwise or) operator.

@cartouche
@quotation Nota 
Generated fields (for example @code{MAX(p)}) are returned as @ref{44c,,str}.
Use @code{PARSE_COLNAMES} to enforce types for such queries.
@end quotation
@end cartouche
@end deffn

@geindex PARSE_COLNAMES (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 PARSE_COLNAMES}@anchor{2aa7}
@deffn {Dado} sqlite3.PARSE_COLNAMES

Pass this flag value to the `detect_types' parameter of
@ref{2a8,,connect()} to look up a converter function by
using the type name, parsed from the query column name,
as the converter dictionary key.
The query column name must be wrapped in double quotes (@code{"})
and the type name must be wrapped in square brackets (@code{[]}).

@example
SELECT MAX(p) as "p [point]" FROM test;  ! will look up converter "point"
@end example

This flag may be combined with @ref{2aa6,,PARSE_DECLTYPES} using the @code{|}
(bitwise or) operator.
@end deffn

@geindex SQLITE_OK (no módulo sqlite3)
@geindex SQLITE_DENY (no módulo sqlite3)
@geindex SQLITE_IGNORE (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 SQLITE_OK}@anchor{2ab2}
@deffn {Dado} sqlite3.SQLITE_OK
@anchor{library/sqlite3 sqlite3 SQLITE_DENY}@anchor{2ab3}
@deffnx {Dado} sqlite3.SQLITE_DENY
@anchor{library/sqlite3 sqlite3 SQLITE_IGNORE}@anchor{2ab4}
@deffnx {Dado} sqlite3.SQLITE_IGNORE

Flags that should be returned by the `authorizer_callback' @ref{2aaf,,callable}
passed to @ref{2ab,,Connection.set_authorizer()}, to indicate whether:


@itemize *

@item 
Access is allowed (@code{SQLITE_OK}),

@item 
The SQL statement should be aborted with an error (@code{SQLITE_DENY})

@item 
The column should be treated as a @code{NULL} value (@code{SQLITE_IGNORE})
@end itemize
@end deffn

@geindex apilevel (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 apilevel}@anchor{2ab5}
@deffn {Dado} sqlite3.apilevel

String constant stating the supported DB-API level. Required by the DB-API.
Hard-coded to @code{"2.0"}.
@end deffn

@geindex paramstyle (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 paramstyle}@anchor{2ab6}
@deffn {Dado} sqlite3.paramstyle

String constant stating the type of parameter marker formatting expected by
the @code{sqlite3} module. Required by the DB-API. Hard-coded to
@code{"qmark"}.

@cartouche
@quotation Nota 
The @code{named} DB-API parameter style is also supported.
@end quotation
@end cartouche
@end deffn

@geindex sqlite_version (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 sqlite_version}@anchor{2ab7}
@deffn {Dado} sqlite3.sqlite_version

Version number of the runtime SQLite library as a @ref{44c,,string}.
@end deffn

@geindex sqlite_version_info (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 sqlite_version_info}@anchor{2ab8}
@deffn {Dado} sqlite3.sqlite_version_info

Version number of the runtime SQLite library as a @ref{370,,tuple} of
@ref{257,,integers}.
@end deffn

@geindex threadsafety (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 threadsafety}@anchor{67c}
@deffn {Dado} sqlite3.threadsafety

Integer constant required by the DB-API 2.0, stating the level of thread
safety the @code{sqlite3} module supports. This attribute is set based on
the default threading mode@footnote{https://sqlite.org/threadsafe.html} the
underlying SQLite library is compiled with. The SQLite threading modes are:


@enumerate 

@item 
`Single-thread': In this mode, all mutexes are disabled and SQLite is
unsafe to use in more than a single thread at once.

@item 
`Multi-thread': In this mode, SQLite can be safely used by multiple
threads provided that no single database connection is used
simultaneously in two or more threads.

@item 
`Serialized': In serialized mode, SQLite can be safely used by
multiple threads with no restriction.
@end enumerate

The mappings from SQLite threading modes to DB-API 2.0 threadsafety levels
are as follows:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

SQLite threading
mode

@tab

@geindex Propostas de Melhorias do Python; PEP 0249#threadsafety
threadsafety@footnote{https://peps.python.org/pep-0249/#threadsafety}

@tab

SQLITE_THREADSAFE@footnote{https://sqlite.org/compile.html#threadsafe}

@tab

DB-API 2.0 meaning

@item

single-thread

@tab

0

@tab

0

@tab

Threads may not share the
module

@item

multi-thread

@tab

1

@tab

2

@tab

Threads may share the module,
but not connections

@item

serialized

@tab

3

@tab

1

@tab

Threads may share the module,
connections and cursors

@end multitable



Alterado na versão 3.11: Set `threadsafety' dynamically instead of hard-coding it to @code{1}.

@end deffn

@geindex version (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 version}@anchor{2cf}
@deffn {Dado} sqlite3.version

Version number of this module as a @ref{44c,,string}.
This is not the version of the SQLite library.


Descontinuado desde a versão 3.12, será removido na versão 3.14: This constant used to reflect the version number of the @code{pysqlite}
package, a third-party library which used to upstream changes to
@code{sqlite3}. Today, it carries no meaning or practical value.

@end deffn

@geindex version_info (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3 version_info}@anchor{2d0}
@deffn {Dado} sqlite3.version_info

Version number of this module as a @ref{370,,tuple} of @ref{257,,integers}.
This is not the version of the SQLite library.


Descontinuado desde a versão 3.12, será removido na versão 3.14: This constant used to reflect the version number of the @code{pysqlite}
package, a third-party library which used to upstream changes to
@code{sqlite3}. Today, it carries no meaning or practical value.

@end deffn

@geindex SQLITE_DBCONFIG_DEFENSIVE (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_DQS_DDL (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_DQS_DML (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_FKEY (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_QPSG (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_TRIGGER (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_ENABLE_VIEW (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_LEGACY_ALTER_TABLE (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_LEGACY_FILE_FORMAT (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_RESET_DATABASE (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_TRIGGER_EQP (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_TRUSTED_SCHEMA (no módulo sqlite3)
@geindex SQLITE_DBCONFIG_WRITABLE_SCHEMA (no módulo sqlite3)
@anchor{library/sqlite3 sqlite3-dbconfig-constants}@anchor{2ab9}@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DEFENSIVE}@anchor{2aba}
@deffn {Dado} sqlite3.SQLITE_DBCONFIG_DEFENSIVE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DDL}@anchor{2abb}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_DQS_DDL
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DML}@anchor{2abc}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_DQS_DML
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FKEY}@anchor{2abd}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER}@anchor{2abe}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION}@anchor{2abf}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_QPSG}@anchor{2ac0}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_TRIGGER}@anchor{2ac1}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_VIEW}@anchor{2ac2}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_ALTER_TABLE}@anchor{2ac3}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_FILE_FORMAT}@anchor{2ac4}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE}@anchor{2ac5}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_RESET_DATABASE}@anchor{2ac6}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_RESET_DATABASE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRIGGER_EQP}@anchor{2ac7}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRUSTED_SCHEMA}@anchor{2ac8}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_WRITABLE_SCHEMA}@anchor{2ac9}
@deffnx {Dado} sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA

These constants are used for the @ref{4ba,,Connection.setconfig()}
and @ref{4b9,,getconfig()} methods.

The availability of these constants varies depending on the version of SQLite
Python was compiled with.


Adicionado na versão 3.12.



@subsubheading Ver também



@table @asis

@item @indicateurl{https://www.sqlite.org/c3ref/c_dbconfig_defensive.html}

SQLite docs: Database Connection Configuration Options
@end table

@end deffn

@node Connection objects,Cursor objects,Constantes do módulo,Referência
@anchor{library/sqlite3 connection-objects}@anchor{2aca}@anchor{library/sqlite3 sqlite3-connection-objects}@anchor{2acb}
@subsubsection Connection objects


@geindex Connection (classe em sqlite3)
@anchor{library/sqlite3 sqlite3 Connection}@anchor{245}
@deffn {Classe} sqlite3.Connection

Each open SQLite database is represented by a @code{Connection} object,
which is created using @ref{2a8,,sqlite3.connect()}.
Their main purpose is creating @ref{2a98,,Cursor} objects,
and @ref{2a9a,,Controle de transações}.


@subsubheading Ver também



@itemize *

@item 
@ref{2acc,,How to use connection shortcut methods}

@item 
@ref{18f7,,How to use the connection context manager}
@end itemize



Alterado na versão 3.13: A @ref{244,,ResourceWarning} is emitted if @ref{246,,close()} is not called before
a @code{Connection} object is deleted.


An SQLite database connection has the following attributes and methods:

@geindex cursor() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection cursor}@anchor{2a97}
@deffn {Método} cursor (factory=Cursor)

Create and return a @ref{2a98,,Cursor} object.
The cursor method accepts a single optional parameter `factory'. If
supplied, this must be a @ref{2aaf,,callable} returning
an instance of @ref{2a98,,Cursor} or its subclasses.
@end deffn

@geindex blobopen() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection blobopen}@anchor{681}
@deffn {Método} blobopen (table, column, rowid, /, *, readonly=False, name='main')

Open a @ref{682,,Blob} handle to an existing
@abbr{BLOB,Binary Large OBject}.

@*Parâmetros: 

@itemize *

@item 
@code{table} (@ref{44c,,str}) – The name of the table where the blob is located.

@item 
@code{column} (@ref{44c,,str}) – The name of the column where the blob is located.

@item 
@code{rowid} (@ref{257,,int}) – The row id where the blob is located.

@item 
@code{readonly} (@ref{468,,bool}) – Set to @code{True} if the blob should be opened without write
permissions.
Defaults to @code{False}.

@item 
@code{name} (@ref{44c,,str}) – The name of the database where the blob is located.
Defaults to @code{"main"}.
@end itemize


@*Levanta: 
@ref{19dd,,OperationalError} – When trying to open a blob in a @code{WITHOUT ROWID} table.


@*Tipo de retorno: 
@ref{682,,Blob}


@cartouche
@quotation Nota 
The blob size cannot be changed using the @ref{682,,Blob} class.
Use the SQL function @code{zeroblob} to create a blob with a fixed size.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex commit() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection commit}@anchor{2a9b}
@deffn {Método} commit ()

Commit any pending transaction to the database.
If @ref{4b6,,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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection rollback}@anchor{2acd}
@deffn {Método} rollback ()

Roll back to the start of any pending transaction.
If @ref{4b6,,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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection close}@anchor{246}
@deffn {Método} close ()

Close the database connection.
If @ref{4b6,,autocommit} is @code{False},
any pending transaction is implicitly rolled back.
If @code{autocommit} is @code{True} or @ref{2aaa,,LEGACY_TRANSACTION_CONTROL},
no implicit transaction control is executed.
Make sure to @ref{2a9b,,commit()} before closing
to avoid losing pending changes.
@end deffn

@geindex execute() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection execute}@anchor{2ace}
@deffn {Método} execute (sql, parameters=(), /)

Create a new @ref{2a98,,Cursor} object and call
@ref{2d1,,execute()} on it with the given `sql' and `parameters'.
Return the new cursor object.
@end deffn

@geindex executemany() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection executemany}@anchor{2acf}
@deffn {Método} executemany (sql, parameters, /)

Create a new @ref{2a98,,Cursor} object and call
@ref{2d2,,executemany()} on it with the given `sql' and `parameters'.
Return the new cursor object.
@end deffn

@geindex executescript() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection executescript}@anchor{2ad0}
@deffn {Método} executescript (sql_script, /)

Create a new @ref{2a98,,Cursor} object and call
@ref{2ad1,,executescript()} on it with the given `sql_script'.
Return the new cursor object.
@end deffn

@geindex create_function() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_function}@anchor{2a9}
@deffn {Método} create_function (name, narg, func, *, deterministic=False)

Create or remove a user-defined SQL function.

@*Parâmetros: 

@itemize *

@item 
@code{name} (@ref{44c,,str}) – O nome da função SQL.

@item 
@code{narg} (@ref{257,,int}) – The number of arguments the SQL function can accept.
If @code{-1}, it may take any number of arguments.

@item 
@code{func} (@ref{2ad2,,callback} | None) – A @ref{2aaf,,callable} that is called when the SQL function is invoked.
The callable must return @ref{2aa4,,a type natively supported by SQLite}.
Set to @code{None} to remove an existing SQL function.

@item 
@code{deterministic} (@ref{468,,bool}) – If @code{True}, the created SQL function is marked as
deterministic@footnote{https://sqlite.org/deterministic.html},
which allows SQLite to perform additional optimizations.
@end itemize



Alterado na versão 3.8: Added the `deterministic' parameter.


Exemplo:

@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


Alterado na versão 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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_aggregate}@anchor{2aa}
@deffn {Método} create_aggregate (name, n_arg, aggregate_class)

Create or remove a user-defined SQL aggregate function.

@*Parâmetros: 

@itemize *

@item 
@code{name} (@ref{44c,,str}) – The name of the SQL aggregate function.

@item 
@code{n_arg} (@ref{257,,int}) – The number of arguments the SQL aggregate function can accept.
If @code{-1}, it may take any number of arguments.

@item 
@code{aggregate_class} (@ref{1a8a,,class} | None) – 
Uma classe deve implementar os seguintes métodos:


@itemize *

@item 
@code{step()}: Add a row to the aggregate.

@item 
@code{finalize()}: Return the final result of the aggregate as
@ref{2aa4,,a type natively supported by SQLite}.
@end itemize

The number of arguments that the @code{step()} method must accept
is controlled by `n_arg'.

Set to @code{None} to remove an existing SQL aggregate function.

@end itemize


Exemplo:

@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


Alterado na versão 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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_window_function}@anchor{680}
@deffn {Método} create_window_function (name, num_params, aggregate_class, /)

Create or remove a user-defined aggregate window function.

@*Parâmetros: 

@itemize *

@item 
@code{name} (@ref{44c,,str}) – The name of the SQL aggregate window function to create or remove.

@item 
@code{num_params} (@ref{257,,int}) – The number of arguments the SQL aggregate window function can accept.
If @code{-1}, it may take any number of arguments.

@item 
@code{aggregate_class} (@ref{1a8a,,class} | None) – 
Uma classe que deve implementar os seguintes métodos:


@itemize *

@item 
@code{step()}: Add a row to the current window.

@item 
@code{value()}: Return the current value of the aggregate.

@item 
@code{inverse()}: Remove a row from the current window.

@item 
@code{finalize()}: Return the final result of the aggregate as
@ref{2aa4,,a type natively supported by SQLite}.
@end itemize

The number of arguments that the @code{step()} and @code{value()} methods
must accept is controlled by `num_params'.

Set to @code{None} to remove an existing SQL aggregate window function.

@end itemize


@*Levanta: 
@ref{2ad3,,NotSupportedError} – If used with a version of SQLite older than 3.25.0,
which does not support aggregate window functions.



Adicionado na versão 3.11.


Exemplo:

@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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection create_collation}@anchor{676}
@deffn {Método} create_collation (name, callable, /)

Create a collation named `name' using the collating function `callable'.
`callable' is passed two @ref{44c,,string} arguments,
and it should return an @ref{257,,integer}:


@itemize *

@item 
@code{1} if the first is ordered higher than the second

@item 
@code{-1} if the first is ordered lower than the second

@item 
@code{0} if they are ordered equal
@end itemize

The following example shows a reverse sorting collation:

@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',)

Remove a collation function by setting `callable' to @code{None}.


Alterado na versão 3.11: The collation name can contain any Unicode character.  Earlier, only
ASCII characters were allowed.

@end deffn

@geindex interrupt() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection interrupt}@anchor{2ad4}
@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{19dd,,OperationalError}.
@end deffn

@geindex set_authorizer() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_authorizer}@anchor{2ab}
@deffn {Método} set_authorizer (authorizer_callback)

Register @ref{2aaf,,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{2ab2,,SQLITE_OK},
@ref{2ab3,,SQLITE_DENY}, or @ref{2ab4,,SQLITE_IGNORE}
to signal how access to the column should be handled
by the underlying SQLite library.

The first argument to the callback signifies what kind of operation is to be
authorized. The second and third argument will be arguments or @code{None}
depending on the first argument. The 4th argument is the name of the database
(“main”, “temp”, etc.) if applicable. The 5th argument is the name of the
inner-most trigger or view that is responsible for the access attempt or
@code{None} if this access attempt is directly from input SQL code.

Please consult the SQLite documentation about the possible values for the first
argument and the meaning of the second and third argument depending on the first
one. All necessary constants are available in the @code{sqlite3} module.

Passing @code{None} as `authorizer_callback' will disable the authorizer.


Alterado na versão 3.11: Added support for disabling the authorizer using @code{None}.



Alterado na versão 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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_progress_handler}@anchor{2ac}
@deffn {Método} set_progress_handler (progress_handler, n)

Register @ref{2aaf,,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.

If you want to clear any previously installed progress handler, call the
method with @code{None} for `progress_handler'.

Returning a non-zero value from the handler function will terminate the
currently executing query and cause it to raise a @ref{2ad5,,DatabaseError}
exception.


Alterado na versão 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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection set_trace_callback}@anchor{2ad}
@deffn {Método} set_trace_callback (trace_callback)

Register @ref{2aaf,,callable} `trace_callback' to be invoked
for each SQL statement that is actually executed by the SQLite backend.

The only argument passed to the callback is the statement (as
@ref{44c,,str}) that is being executed. The return value of the callback is
ignored. Note that the backend does not only run statements passed to the
@ref{2d1,,Cursor.execute()} methods.  Other sources include the
@ref{2a9a,,transaction management} of the
@code{sqlite3} module and the execution of triggers defined in the current
database.

Passing @code{None} as `trace_callback' will disable the trace callback.

@cartouche
@quotation Nota 
Exceptions raised in the trace callback are not propagated. As a
development and debugging aid, use
@ref{2aad,,enable_callback_tracebacks()} to enable printing
tracebacks from exceptions raised in the trace callback.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection enable_load_extension}@anchor{841}
@deffn {Método} enable_load_extension (enabled, /)

Enable the SQLite engine to load SQLite extensions from shared libraries
if `enabled' is @code{True};
else, disallow loading SQLite extensions.
SQLite extensions can define new functions,
aggregates or whole new virtual table implementations.  One well-known
extension is the fulltext-search extension distributed with SQLite.

@cartouche
@quotation Nota 
The @code{sqlite3} module is not built with loadable extension support by
default, because some platforms (notably macOS) have SQLite
libraries which are compiled without this feature.
To get loadable extension support,
you must pass the @ref{1ef4,,--enable-loadable-sqlite-extensions} option
to @code{configure}.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{sqlite3.enable_load_extension} com os argumentos @code{connection}, @code{enabled}.


Adicionado na versão 3.2.



Alterado na versão 3.10: Added the @code{sqlite3.enable_load_extension} auditing event.


@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 sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection load_extension}@anchor{4b8}
@deffn {Método} load_extension (path, /, *, entrypoint=None)

Load an SQLite extension from a shared library.
Enable extension loading with @ref{841,,enable_load_extension()} before
calling this method.

@*Parâmetros: 

@itemize *

@item 
@code{path} (@ref{44c,,str}) – The path to the SQLite extension.

@item 
@code{entrypoint} (@ref{44c,,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


Levanta um @ref{19fa,,evento de auditoria} @code{sqlite3.load_extension} com os argumentos @code{connection}, @code{path}.


Adicionado na versão 3.2.



Alterado na versão 3.10: Added the @code{sqlite3.load_extension} auditing event.



Alterado na versão 3.12: Added the `entrypoint' parameter.

@end deffn

@geindex iterdump() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection iterdump}@anchor{247}
@deffn {Método} iterdump (*, filter=None)

Return an @ref{1ac,,iterator} to dump the database as SQL source code.
Useful when saving an in-memory database for later restoration.
Similar to the @code{.dump} command in the @code{sqlite3} shell.

@*Parâmetros: 
@code{filter} (@ref{44c,,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.


Exemplo:

@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 também


@ref{2ad6,,How to handle non-UTF-8 text encodings}



Alterado na versão 3.13: Adicionado o parâmetro `filter'.

@end deffn

@geindex backup() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection backup}@anchor{b92}
@deffn {Método} backup (target, *, pages=-1, progress=None, name='main', sleep=0.250)

Create a backup of an SQLite database.

Works even if the database is being accessed by other clients
or concurrently by the same connection.

@*Parâmetros: 

@itemize *

@item 
@code{target} (@ref{245,,Connection}) – The database connection to save the backup to.

@item 
@code{pages} (@ref{257,,int}) – The number of pages to copy at a time.
If equal to or less than @code{0},
the entire database is copied in a single step.
Defaults to @code{-1}.

@item 
@code{progress} (@ref{2ad2,,callback} | None) – If set to a @ref{2aaf,,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{44c,,str}) – The name of the database to back up.
Either @code{"main"} (the default) for the main database,
@code{"temp"} for the temporary database,
or the name of a custom database as attached using the
@code{ATTACH DATABASE} SQL statement.

@item 
@code{sleep} (@ref{2f7,,float}) – The number of seconds to sleep between successive attempts
to back up remaining pages.
@end itemize


Example 1, copy an existing database into another:

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

Example 2, copy an existing database into a transient copy:

@example
src = sqlite3.connect('example.db')
dst = sqlite3.connect(':memory:')
src.backup(dst)
dst.close()
src.close()
@end example


Adicionado na versão 3.7.



@subsubheading Ver também


@ref{2ad6,,How to handle non-UTF-8 text encodings}

@end deffn

@geindex getlimit() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection getlimit}@anchor{67b}
@deffn {Método} getlimit (category, /)

Get a connection runtime limit.

@*Parâmetros: 
@code{category} (@ref{257,,int}) – The SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html} to be queried.


@*Tipo de retorno: 
@ref{257,,int}


@*Levanta: 
@ref{4f2,,ProgrammingError} – If `category' is not recognised by the underlying SQLite library.


Example, query the maximum length of an SQL statement
for @ref{245,,Connection} @code{con} (the default is 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


Adicionado na versão 3.11.

@end deffn

@geindex setlimit() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection setlimit}@anchor{67a}
@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{257,,int}) – The SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html} to be set.

@item 
@code{limit} (@ref{257,,int}) – The value of the new limit.
If negative, the current limit is unchanged.
@end itemize


@*Tipo de retorno: 
@ref{257,,int}


@*Levanta: 
@ref{4f2,,ProgrammingError} – If `category' is not recognised by the underlying SQLite library.


Example, limit the number of attached databases to 1
for @ref{245,,Connection} @code{con} (the default limit is 10):

@example
>>> con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 1)
10
>>> con.getlimit(sqlite3.SQLITE_LIMIT_ATTACHED)
1
@end example

@c con.close()


Adicionado na versão 3.11.

@end deffn

@geindex getconfig() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection getconfig}@anchor{4b9}
@deffn {Método} getconfig (op, /)

Query a boolean connection configuration option.

@*Parâmetros: 
@code{op} (@ref{257,,int}) – A @ref{2ab9,,SQLITE_DBCONFIG code}.


@*Tipo de retorno: 
@ref{468,,bool}



Adicionado na versão 3.12.

@end deffn

@geindex setconfig() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection setconfig}@anchor{4ba}
@deffn {Método} setconfig (op, enable=True, /)

Set a boolean connection configuration option.

@*Parâmetros: 

@itemize *

@item 
@code{op} (@ref{257,,int}) – A @ref{2ab9,,SQLITE_DBCONFIG code}.

@item 
@code{enable} (@ref{468,,bool}) – @code{True} if the configuration option should be enabled (default);
@code{False} if it should be disabled.
@end itemize



Adicionado na versão 3.12.

@end deffn

@geindex serialize() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection serialize}@anchor{67e}
@deffn {Método} serialize (*, name='main')

Serialize a database into a @ref{1c2,,bytes} object.  For an
ordinary on-disk database file, the serialization is just a copy of the
disk file.  For an in-memory database or a “temp” database, the
serialization is the same sequence of bytes which would be written to
disk if that database were backed up to disk.

@*Parâmetros: 
@code{name} (@ref{44c,,str}) – The database name to be serialized.
Defaults to @code{"main"}.


@*Tipo de retorno: 
@ref{1c2,,bytes}


@cartouche
@quotation Nota 
This method is only available if the underlying SQLite library has the
serialize API.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex deserialize() (método sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection deserialize}@anchor{67f}
@deffn {Método} deserialize (data, /, *, name='main')

Deserialize a @ref{67e,,serialized} database into a
@ref{245,,Connection}.
This method causes the database connection to disconnect from database
`name', and reopen `name' as an in-memory database based on the
serialization contained in `data'.

@*Parâmetros: 

@itemize *

@item 
@code{data} (@ref{1c2,,bytes}) – A serialized database.

@item 
@code{name} (@ref{44c,,str}) – The database name to deserialize into.
Defaults to @code{"main"}.
@end itemize


@*Levanta: 

@itemize *

@item 
@ref{19dd,,OperationalError} – If the database connection is currently involved in a read
transaction or a backup operation.

@item 
@ref{2ad5,,DatabaseError} – If `data' does not contain a valid SQLite database.

@item 
@ref{885,,OverflowError} – If @ref{62e,,len(data)} is larger than @code{2**63 - 1}.
@end itemize


@cartouche
@quotation Nota 
This method is only available if the underlying SQLite library has the
deserialize API.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex autocommit (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection autocommit}@anchor{4b6}
@deffn {Atributo} autocommit

This attribute controls 
@geindex Propostas de Melhorias do Python; 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 Propostas de Melhorias do Python; 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{2a9b,,commit()} and @ref{2acd,,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{2a9b,,commit()} and @ref{2acd,,rollback()} have no effect in this mode.

@item 
@ref{2aaa,,LEGACY_TRANSACTION_CONTROL}:
Pre-Python 3.12 (non-
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}-compliant) transaction control.
See @ref{2aa8,,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{4b7,,Controle de transações através do atributo autocommit} for more details.

@cartouche
@quotation Nota 
The @ref{2aa8,,isolation_level} attribute has no effect unless
@ref{4b6,,autocommit} is @ref{2aaa,,LEGACY_TRANSACTION_CONTROL}.
@end quotation
@end cartouche


Adicionado na versão 3.12.

@end deffn

@geindex in_transaction (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection in_transaction}@anchor{2ad7}
@deffn {Atributo} in_transaction

This read-only attribute corresponds to the low-level SQLite
autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}.

@code{True} if a transaction is active (there are uncommitted changes),
@code{False} otherwise.


Adicionado na versão 3.2.

@end deffn

@geindex isolation_level (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection isolation_level}@anchor{2aa8}
@deffn {Atributo} isolation_level

Controls the @ref{2aa9,,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{2aa9,,implicit transaction management} is performed.

If not overridden by the `isolation_level' parameter of @ref{2a8,,connect()},
the default is @code{""}, which is an alias for @code{"DEFERRED"}.

@cartouche
@quotation Nota 
Using @ref{4b6,,autocommit} to control transaction handling is
recommended over using @code{isolation_level}.
@code{isolation_level} has no effect unless @ref{4b6,,autocommit} is
set to @ref{2aaa,,LEGACY_TRANSACTION_CONTROL} (the default).
@end quotation
@end cartouche
@end deffn

@geindex row_factory (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection row_factory}@anchor{171a}
@deffn {Atributo} row_factory

The initial @ref{2ad8,,row_factory}
for @ref{2a98,,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{370,,tuple}.

Consulte @ref{2a9f,,How to create and use row factories} para mais detalhes.
@end deffn

@geindex text_factory (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection text_factory}@anchor{2ad9}
@deffn {Atributo} text_factory

A @ref{2aaf,,callable} that accepts a @ref{1c2,,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{44c,,str}.

Consulte @ref{2ad6,,How to handle non-UTF-8 text encodings} para mais detalhes.
@end deffn

@geindex total_changes (atributo sqlite3.Connection)
@anchor{library/sqlite3 sqlite3 Connection total_changes}@anchor{2ada}
@deffn {Atributo} total_changes

Return the total number of database rows that have been modified, inserted, or
deleted since the database connection was opened.
@end deffn
@end deffn

@node Cursor objects,Row objects,Connection objects,Referência
@anchor{library/sqlite3 cursor-objects}@anchor{2adb}@anchor{library/sqlite3 sqlite3-cursor-objects}@anchor{2adc}
@subsubsection Cursor objects


@quotation

A @code{Cursor} object represents a database cursor@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)}
which is used to execute SQL statements,
and manage the context of a fetch operation.
Cursors are created using @ref{2a97,,Connection.cursor()},
or by using any of the @ref{2acc,,connection shortcut methods}.

Cursor objects are @ref{1ac,,iterators},
meaning that if you @ref{2d1,,execute()} a @code{SELECT} query,
you can simply iterate over the cursor to fetch the resulting rows:

@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 (classe em sqlite3)
@anchor{library/sqlite3 sqlite3 Cursor}@anchor{2a98}
@deffn {Classe} sqlite3.Cursor

A @ref{2a98,,Cursor} instance has the following attributes and methods.

@geindex ? (interrogação);em instruções SQL

@geindex ; (dois pontos);em instruções SQL

@geindex execute() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor execute}@anchor{2d1}
@deffn {Método} execute (sql, parameters=(), /)

Execute a single SQL statement,
optionally binding Python values using
@ref{2d3,,placeholders}.

@*Parâmetros: 

@itemize *

@item 
@code{sql} (@ref{44c,,str}) – A single SQL statement.

@item 
@code{parameters} (@ref{256,,dict} | @ref{4f1,,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{2d3,,How to use placeholders to bind values in SQL queries}.
@end itemize


@*Levanta: 
@ref{4f2,,ProgrammingError} – If `sql' contains more than one SQL statement.


If @ref{4b6,,autocommit} is
@ref{2aaa,,LEGACY_TRANSACTION_CONTROL},
@ref{2aa8,,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'.


Descontinuado desde a versão 3.12, será removido na versão 3.14: @ref{1a5,,DeprecationWarning} is emitted if
@ref{2d3,,named placeholders} are used
and `parameters' is a sequence instead of a @ref{256,,dict}.
Starting with Python 3.14, @ref{4f2,,ProgrammingError} will
be raised instead.


Use @ref{2ad1,,executescript()} to execute multiple SQL statements.
@end deffn

@geindex executemany() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor executemany}@anchor{2d2}
@deffn {Método} executemany (sql, parameters, /)

For every item in `parameters',
repeatedly execute the @ref{2d3,,parameterized}
@abbr{DML,Data Manipulation Language} SQL statement `sql'.

Uses the same implicit transaction handling as @ref{2d1,,execute()}.

@*Parâmetros: 

@itemize *

@item 
@code{sql} (@ref{44c,,str}) – A single SQL DML statement.

@item 
@code{parameters} (@ref{1268,,iterable}) – An iterable of parameters to bind with
the placeholders in `sql'.
See @ref{2d3,,How to use placeholders to bind values in SQL queries}.
@end itemize


@*Levanta: 
@ref{4f2,,ProgrammingError} – If `sql' contains more than one SQL statement,
or is not a DML statement.


Exemplo:

@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


Descontinuado desde a versão 3.12, será removido na versão 3.14: @ref{1a5,,DeprecationWarning} is emitted if
@ref{2d3,,named placeholders} are used
and the items in `parameters' are sequences
instead of @ref{256,,dict}s.
Starting with Python 3.14, @ref{4f2,,ProgrammingError} will
be raised instead.

@end deffn

@geindex executescript() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor executescript}@anchor{2ad1}
@deffn {Método} executescript (sql_script, /)

Execute the SQL statements in `sql_script'.
If the @ref{4b6,,autocommit} is
@ref{2aaa,,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' must be a @ref{44c,,string}.

Exemplo:

@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 sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchone}@anchor{2a99}
@deffn {Método} fetchone ()

If @ref{2ad8,,row_factory} is @code{None},
return the next row query result set as a @ref{370,,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 sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchmany}@anchor{15f0}
@deffn {Método} fetchmany (size=cursor.arraysize)

Return the next set of rows of a query result as a @ref{611,,list}.
Return an empty list if no more rows are available.

The number of rows to fetch per call is specified by the `size' parameter.
If `size' is not given, @ref{15f1,,arraysize} determines the number of rows
to be fetched.
If fewer than `size' rows are available,
as many rows as are available are returned.

Note there are performance considerations involved with the `size' parameter.
For optimal performance, it is usually best to use the arraysize attribute.
If the `size' parameter is used, then it is best for it to retain the same
value from one @ref{15f0,,fetchmany()} call to the next.


Alterado na versão 3.13.8: Negative `size' values are rejected by raising @ref{202,,ValueError}.

@end deffn

@geindex fetchall() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor fetchall}@anchor{2a9c}
@deffn {Método} fetchall ()

Return all (remaining) rows of a query result as a @ref{611,,list}.
Return an empty list if no rows are available.
Note that the @ref{15f1,,arraysize} attribute can affect the performance of
this operation.
@end deffn

@geindex close() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor close}@anchor{2add}
@deffn {Método} close ()

Close the cursor now (rather than whenever @code{__del__} is called).

The cursor will be unusable from this point forward; a @ref{4f2,,ProgrammingError}
exception will be raised if any operation is attempted with the cursor.
@end deffn

@geindex setinputsizes() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor setinputsizes}@anchor{2ade}
@deffn {Método} setinputsizes (sizes, /)

Required by the DB-API. Does nothing in @code{sqlite3}.
@end deffn

@geindex setoutputsize() (método sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor setoutputsize}@anchor{2adf}
@deffn {Método} setoutputsize (size, column=None, /)

Required by the DB-API. Does nothing in @code{sqlite3}.
@end deffn

@geindex arraysize (atributo sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor arraysize}@anchor{15f1}
@deffn {Atributo} arraysize

Read/write attribute that controls the number of rows returned by @ref{15f0,,fetchmany()}.
The default value is 1 which means a single row would be fetched per call.


Alterado na versão 3.13.8: Negative values are rejected by raising @ref{202,,ValueError}.

@end deffn

@geindex connection (atributo sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor connection}@anchor{2ae0}
@deffn {Atributo} connection

Read-only attribute that provides the SQLite database @ref{245,,Connection}
belonging to the cursor.  A @ref{2a98,,Cursor} object created by
calling @ref{2a97,,con.cursor()} will have a
@ref{2ae0,,connection} attribute that refers to `con':

@example
>>> con = sqlite3.connect(":memory:")
>>> cur = con.cursor()
>>> cur.connection == con
True
>>> con.close()
@end example
@end deffn

@geindex description (atributo sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor description}@anchor{1649}
@deffn {Atributo} description

Read-only attribute that provides the column names of the last query. To
remain compatible with the Python DB API, it returns a 7-tuple for each
column where the last six items of each tuple are @code{None}.

It is set for @code{SELECT} statements without any matching rows as well.
@end deffn

@geindex lastrowid (atributo sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor lastrowid}@anchor{cf1}
@deffn {Atributo} lastrowid

Read-only attribute that provides the row id of the last inserted row. It
is only updated after successful @code{INSERT} or @code{REPLACE} statements
using the @ref{2d1,,execute()} method.  For other statements, after
@ref{2d2,,executemany()} or @ref{2ad1,,executescript()}, or if the insertion failed,
the value of @code{lastrowid} is left unchanged.  The initial value of
@code{lastrowid} is @code{None}.

@cartouche
@quotation Nota 
Inserts into @code{WITHOUT ROWID} tables are not recorded.
@end quotation
@end cartouche


Alterado na versão 3.6: Added support for the @code{REPLACE} statement.

@end deffn

@geindex rowcount (atributo sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor rowcount}@anchor{18eb}
@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{2d1,,execute()} and @ref{2d2,,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 sqlite3.Cursor)
@anchor{library/sqlite3 sqlite3 Cursor row_factory}@anchor{2ad8}
@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{370,,tuple}.
Can be set to the included @ref{ea0,,sqlite3.Row};
or a @ref{2aaf,,callable} that accepts two arguments,
a @ref{2a98,,Cursor} object and the @code{tuple} of row values,
and returns a custom object representing an SQLite row.

Defaults to what @ref{171a,,Connection.row_factory} was set to
when the @code{Cursor} was created.
Assigning to this attribute does not affect
@ref{171a,,Connection.row_factory} of the parent connection.

Consulte @ref{2a9f,,How to create and use row factories} para mais detalhes.
@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{2ae1}
@node Row objects,Blob objects,Cursor objects,Referência
@anchor{library/sqlite3 row-objects}@anchor{2ae2}@anchor{library/sqlite3 sqlite3-row-objects}@anchor{2ae3}
@subsubsection Row objects


@geindex Row (classe em sqlite3)
@anchor{library/sqlite3 sqlite3 Row}@anchor{ea0}
@deffn {Classe} sqlite3.Row

A @code{Row} instance serves as a highly optimized
@ref{171a,,row_factory} for @ref{245,,Connection} objects.
It supports iteration, equality testing, @ref{62e,,len()},
and @ref{11fb,,mapping} access by column name and index.

Two @code{Row} objects compare equal
if they have identical column names and values.

Consulte @ref{2a9f,,How to create and use row factories} para mais detalhes.

@geindex keys() (método sqlite3.Row)
@anchor{library/sqlite3 sqlite3 Row keys}@anchor{2ae4}
@deffn {Método} keys ()

Return a @ref{611,,list} of column names as @ref{44c,,strings}.
Immediately after a query,
it is the first member of each tuple in @ref{1649,,Cursor.description}.
@end deffn


Alterado na versão 3.5: Added support of slicing.

@end deffn

@node Blob objects,PrepareProtocol objects,Row objects,Referência
@anchor{library/sqlite3 blob-objects}@anchor{2ae5}@anchor{library/sqlite3 sqlite3-blob-objects}@anchor{2ae6}
@subsubsection Blob objects


@geindex Blob (classe em sqlite3)
@anchor{library/sqlite3 sqlite3 Blob}@anchor{682}
@deffn {Classe} sqlite3.Blob


Adicionado na versão 3.11.


A @ref{682,,Blob} instance is a @ref{15cf,,file-like object}
that can read and write data in an SQLite @abbr{BLOB}.
Call @ref{62e,,len(blob)} to get the size (number of bytes) of the blob.
Use indices and @ref{2313,,slices} for direct access to the blob data.

Use the @ref{682,,Blob} as a @ref{5d4,,context manager} to ensure that the blob
handle is closed after use.

@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 sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob close}@anchor{2ae7}
@deffn {Método} close ()

Close the blob.

The blob will be unusable from this point onward.  An
@ref{19ae,,Error} (or subclass) exception will be raised if any
further operation is attempted with the blob.
@end deffn

@geindex read() (método sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob read}@anchor{2ae8}
@deffn {Método} read (length=-1, /)

Read `length' bytes of data from the blob at the current offset position.
If the end of the blob is reached, the data up to
@abbr{EOF,End of File} will be returned.  When `length' is not
specified, or is negative, @ref{2ae8,,read()} will read until the end of
the blob.
@end deffn

@geindex write() (método sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob write}@anchor{2ae9}
@deffn {Método} write (data, /)

Write `data' to the blob at the current offset.  This function cannot
change the blob length.  Writing beyond the end of the blob will raise
@ref{202,,ValueError}.
@end deffn

@geindex tell() (método sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob tell}@anchor{2aea}
@deffn {Método} tell ()

Return the current access position of the blob.
@end deffn

@geindex seek() (método sqlite3.Blob)
@anchor{library/sqlite3 sqlite3 Blob seek}@anchor{2aeb}
@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{12cf,,os.SEEK_SET} (absolute blob positioning).
Other values for `origin' are @ref{12d0,,os.SEEK_CUR} (seek relative to the
current position) and @ref{12d1,,os.SEEK_END} (seek relative to the blob’s
end).
@end deffn
@end deffn

@node PrepareProtocol objects,Exceções<7>,Blob objects,Referência
@anchor{library/sqlite3 prepareprotocol-objects}@anchor{2aec}
@subsubsection PrepareProtocol objects


@geindex PrepareProtocol (classe em sqlite3)
@anchor{library/sqlite3 sqlite3 PrepareProtocol}@anchor{18f6}
@deffn {Classe} sqlite3.PrepareProtocol

The PrepareProtocol type’s single purpose is to act as a 
@geindex Propostas de Melhorias do Python; PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} style
adaption protocol for objects that can @ref{2aed,,adapt themselves} to @ref{2aa4,,native SQLite types}.
@end deffn

@node Exceções<7>,SQLite and Python types,PrepareProtocol objects,Referência
@anchor{library/sqlite3 exceptions}@anchor{2aee}@anchor{library/sqlite3 sqlite3-exceptions}@anchor{2aef}
@subsubsection Exceções


The exception hierarchy is defined by the DB-API 2.0 (
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}).

@geindex Warning
@anchor{library/sqlite3 sqlite3 Warning}@anchor{1940}
@deffn {Exceção} sqlite3.Warning

This exception is not currently raised by the @code{sqlite3} module,
but may be raised by applications using @code{sqlite3},
for example if a user-defined function truncates data while inserting.
@code{Warning} is a subclass of @ref{9e2,,Exception}.
@end deffn

@geindex Error
@anchor{library/sqlite3 sqlite3 Error}@anchor{19ae}
@deffn {Exceção} sqlite3.Error

The base class of the other exceptions in this module.
Use this to catch all errors with one single @ref{18b,,except} statement.
@code{Error} is a subclass of @ref{9e2,,Exception}.

If the exception originated from within the SQLite library,
the following two attributes are added to the exception:

@geindex sqlite_errorcode (atributo sqlite3.Error)
@anchor{library/sqlite3 sqlite3 Error sqlite_errorcode}@anchor{678}
@deffn {Atributo} sqlite_errorcode

The numeric error code from the
SQLite API@footnote{https://sqlite.org/rescode.html}


Adicionado na versão 3.11.

@end deffn

@geindex sqlite_errorname (atributo sqlite3.Error)
@anchor{library/sqlite3 sqlite3 Error sqlite_errorname}@anchor{679}
@deffn {Atributo} sqlite_errorname

The symbolic name of the numeric error code
from the SQLite API@footnote{https://sqlite.org/rescode.html}


Adicionado na versão 3.11.

@end deffn
@end deffn

@geindex InterfaceError
@anchor{library/sqlite3 sqlite3 InterfaceError}@anchor{67d}
@deffn {Exceção} sqlite3.InterfaceError

Exception raised for misuse of the low-level SQLite C API.
In other words, if this exception is raised, it probably indicates a bug in the
@code{sqlite3} module.
@code{InterfaceError} is a subclass of @ref{19ae,,Error}.
@end deffn

@geindex DatabaseError
@anchor{library/sqlite3 sqlite3 DatabaseError}@anchor{2ad5}
@deffn {Exceção} sqlite3.DatabaseError

Exception raised for errors that are related to the database.
This serves as the base exception for several types of database errors.
It is only raised implicitly through the specialised subclasses.
@code{DatabaseError} is a subclass of @ref{19ae,,Error}.
@end deffn

@geindex DataError
@anchor{library/sqlite3 sqlite3 DataError}@anchor{19dc}
@deffn {Exceção} sqlite3.DataError

Exception raised for errors caused by problems with the processed data,
like numeric values out of range, and strings which are too long.
@code{DataError} is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@geindex OperationalError
@anchor{library/sqlite3 sqlite3 OperationalError}@anchor{19dd}
@deffn {Exceção} sqlite3.OperationalError

Exception raised for errors that are related to the database’s operation,
and not necessarily under the control of the programmer.
For example, the database path is not found,
or a transaction could not be processed.
@code{OperationalError} is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@geindex IntegrityError
@anchor{library/sqlite3 sqlite3 IntegrityError}@anchor{2af0}
@deffn {Exceção} sqlite3.IntegrityError

Exception raised when the relational integrity of the database is affected,
e.g. a foreign key check fails.  It is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@geindex InternalError
@anchor{library/sqlite3 sqlite3 InternalError}@anchor{2af1}
@deffn {Exceção} sqlite3.InternalError

Exception raised when SQLite encounters an internal error.
If this is raised, it may indicate that there is a problem with the runtime
SQLite library.
@code{InternalError} is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@geindex ProgrammingError
@anchor{library/sqlite3 sqlite3 ProgrammingError}@anchor{4f2}
@deffn {Exceção} sqlite3.ProgrammingError

Exception raised for @code{sqlite3} API programming errors,
for example supplying the wrong number of bindings to a query,
or trying to operate on a closed @ref{245,,Connection}.
@code{ProgrammingError} is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@geindex NotSupportedError
@anchor{library/sqlite3 sqlite3 NotSupportedError}@anchor{2ad3}
@deffn {Exceção} sqlite3.NotSupportedError

Exception raised in case a method or database API is not supported by the
underlying SQLite library. For example, setting `deterministic' to
@code{True} in @ref{2a9,,create_function()}, if the underlying SQLite library
does not support deterministic functions.
@code{NotSupportedError} is a subclass of @ref{2ad5,,DatabaseError}.
@end deffn

@node SQLite and Python types,Default adapters and converters deprecated,Exceções<7>,Referência
@anchor{library/sqlite3 sqlite-and-python-types}@anchor{2af2}@anchor{library/sqlite3 sqlite3-types}@anchor{2aa4}
@subsubsection SQLite and Python types


SQLite natively supports the following types: @code{NULL}, @code{INTEGER},
@code{REAL}, @code{TEXT}, @code{BLOB}.

The following Python types can thus be sent to SQLite without any problem:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} 
@headitem

Tipo em Python

@tab

Tipo em SQLite

@item

@code{None}

@tab

@code{NULL}

@item

@ref{257,,int}

@tab

@code{INTEGER}

@item

@ref{2f7,,float}

@tab

@code{REAL}

@item

@ref{44c,,str}

@tab

@code{TEXT}

@item

@ref{1c2,,bytes}

@tab

@code{BLOB}

@end multitable


This is how SQLite types are converted to Python types by default:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo em SQLite

@tab

Tipo em Python

@item

@code{NULL}

@tab

@code{None}

@item

@code{INTEGER}

@tab

@ref{257,,int}

@item

@code{REAL}

@tab

@ref{2f7,,float}

@item

@code{TEXT}

@tab

depends on @ref{2ad9,,text_factory},
@ref{44c,,str} by default

@item

@code{BLOB}

@tab

@ref{1c2,,bytes}

@end multitable


The type system of the @code{sqlite3} module is extensible in two ways: you can
store additional Python types in an SQLite database via
@ref{2a9d,,object adapters},
and you can let the @code{sqlite3} module convert SQLite types to
Python types via @ref{2a9e,,converters}.

@node Default adapters and converters deprecated,Interface de linha de comando,SQLite and Python types,Referência
@anchor{library/sqlite3 default-adapters-and-converters-deprecated}@anchor{2af3}@anchor{library/sqlite3 sqlite3-default-converters}@anchor{4ef}
@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{4f0,,Adapter and converter recipes}
and tailor them to your needs.
@end quotation
@end cartouche

The deprecated default adapters and converters consist of:


@itemize *

@item 
An adapter for @ref{1cd,,datetime.date} objects to @ref{44c,,strings} in
ISO 8601@footnote{https://en.wikipedia.org/wiki/ISO_8601} format.

@item 
An adapter for @ref{1cc,,datetime.datetime} objects to strings in
ISO 8601 format.

@item 
A converter for @ref{2a9e,,declared} “date” types to
@ref{1cd,,datetime.date} objects.

@item 
A converter for declared “timestamp” types to
@ref{1cc,,datetime.datetime} objects.
Fractional parts will be truncated to 6 digits (microsecond precision).
@end itemize

@cartouche
@quotation Nota 
The default “timestamp” converter ignores UTC offsets in the database and
always returns a naive @ref{1cc,,datetime.datetime} object. To preserve UTC
offsets in timestamps, either leave converters disabled, or register an
offset-aware converter with @ref{2aa5,,register_converter()}.
@end quotation
@end cartouche


Descontinuado desde a versão 3.12.


@node Interface de linha de comando,,Default adapters and converters deprecated,Referência
@anchor{library/sqlite3 command-line-interface}@anchor{2af4}@anchor{library/sqlite3 sqlite3-cli}@anchor{441}
@subsubsection Interface de linha de comando


The @code{sqlite3} module can be invoked as a script,
using the interpreter’s @ref{5e1,,-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 python--m-sqlite3-[-h]-[-v]-[filename]-[sql] opção de linha de comando; -h
@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql] opção de linha de comando; --help
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-h}@anchor{2af5}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-help}@anchor{2af6}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Print CLI help.
@end deffn

@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql] opção de linha de comando; -v
@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql] opção de linha de comando; --version
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-v}@anchor{2af7}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-version}@anchor{2af8}
@deffn {Option} @w{-}v, @w{-}@w{-}version

Print underlying SQLite library version.
@end deffn


Adicionado na versão 3.12.


@node Guias de como fazer,Explicação,Referência,sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite
@anchor{library/sqlite3 how-to-guides}@anchor{2af9}@anchor{library/sqlite3 sqlite3-howtos}@anchor{2a94}
@subsubsection Guias de como fazer


@menu
* How to use placeholders to bind values in SQL queries:: 
* How to adapt custom Python types to SQLite values:: 
* How to convert SQLite values to custom Python types:: 
* Adapter and converter recipes:: 
* How to use connection shortcut methods:: 
* How to use the connection context manager:: 
* How to work with SQLite URIs:: 
* How to create and use row factories:: 
* How to handle non-UTF-8 text encodings:: 

@end menu

@node How to use placeholders to bind values in SQL queries,How to adapt custom Python types to SQLite values,,Guias de como fazer
@anchor{library/sqlite3 how-to-use-placeholders-to-bind-values-in-sql-queries}@anchor{2afa}@anchor{library/sqlite3 sqlite3-placeholders}@anchor{2d3}
@subsubsection How to use placeholders to bind values in SQL queries


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{370,,tuple} of values to the second
argument of the cursor’s @ref{2d1,,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{4f1,,sequence} whose length must match the number of placeholders,
or a @ref{4f2,,ProgrammingError} is raised.
For the named style, `parameters' must be
an instance of a @ref{256,,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 Propostas de Melhorias do Python; 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 How to adapt custom Python types to SQLite values,How to convert SQLite values to custom Python types,How to use placeholders to bind values in SQL queries,Guias de como fazer
@anchor{library/sqlite3 how-to-adapt-custom-python-types-to-sqlite-values}@anchor{2afb}@anchor{library/sqlite3 sqlite3-adapters}@anchor{2a9d}
@subsubsection How to adapt custom Python types to SQLite values


SQLite supports only a limited set of data types natively.
To store custom Python types in SQLite databases, `adapt' them to one of the
@ref{2aa4,,Python types SQLite natively understands}.

There are two ways to adapt Python objects to SQLite types:
letting your object adapt itself, or using an `adapter callable'.
The latter will take precedence above the former.
For a library that exports a custom type,
it may make sense to enable that type to adapt itself.
As an application developer, it may make more sense to take direct control by
registering custom adapter functions.

@menu
* How to write adaptable objects:: 
* How to register adapter callables:: 

@end menu

@node How to write adaptable objects,How to register adapter callables,,How to adapt custom Python types to SQLite values
@anchor{library/sqlite3 how-to-write-adaptable-objects}@anchor{2afc}@anchor{library/sqlite3 sqlite3-conform}@anchor{2aed}
@subsubsection How to write adaptable objects


Suppose we have a @code{Point} class that represents a pair of coordinates,
@code{x} and @code{y}, in a Cartesian coordinate system.
The coordinate pair will be stored as a text string in the database,
using a semicolon to separate the coordinates.
This can be implemented by adding a @code{__conform__(self, protocol)}
method which returns the adapted value.
The object passed to `protocol' will be of type @ref{18f6,,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 How to register adapter callables,,How to write adaptable objects,How to adapt custom Python types to SQLite values
@anchor{library/sqlite3 how-to-register-adapter-callables}@anchor{2afd}
@subsubsection How to register adapter callables


The other possibility is to create a function that converts the Python object
to an SQLite-compatible type.
This function can then be registered using @ref{2aae,,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 How to convert SQLite values to custom Python types,Adapter and converter recipes,How to adapt custom Python types to SQLite values,Guias de como fazer
@anchor{library/sqlite3 how-to-convert-sqlite-values-to-custom-python-types}@anchor{2afe}@anchor{library/sqlite3 sqlite3-converters}@anchor{2a9e}
@subsubsection How to convert SQLite values to custom Python types


Writing an adapter lets you convert `from' custom Python types `to' SQLite
values.
To be able to convert `from' SQLite values `to' custom Python types,
we use `converters'.

Let’s go back to the @code{Point} class. We stored the x and y coordinates
separated via semicolons as strings in SQLite.

First, we’ll define a converter function that accepts the string as a parameter
and constructs a @code{Point} object from it.

@cartouche
@quotation Nota 
Converter functions are `always' passed a @ref{1c2,,bytes} object,
no matter the underlying SQLite data type.
@end quotation
@end cartouche

@example
def convert_point(s):
    x, y = map(float, s.split(b";"))
    return Point(x, y)
@end example

We now need to tell @code{sqlite3} when it should convert a given SQLite value.
This is done when connecting to a database, using the `detect_types' parameter
of @ref{2a8,,connect()}. There are three options:


@itemize *

@item 
Implicit: set `detect_types' to @ref{2aa6,,PARSE_DECLTYPES}

@item 
Explicit: set `detect_types' to @ref{2aa7,,PARSE_COLNAMES}

@item 
Both: set `detect_types' to
@code{sqlite3.PARSE_DECLTYPES | sqlite3.PARSE_COLNAMES}.
Column names take precedence over declared types.
@end itemize

The following example illustrates the implicit and explicit approaches:

@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 Adapter and converter recipes,How to use connection shortcut methods,How to convert SQLite values to custom Python types,Guias de como fazer
@anchor{library/sqlite3 adapter-and-converter-recipes}@anchor{2aff}@anchor{library/sqlite3 sqlite3-adapter-converter-recipes}@anchor{4f0}
@subsubsection Adapter and converter recipes


This section shows recipes for common adapters and converters.

@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.replace(tzinfo=None).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 How to use connection shortcut methods,How to use the connection context manager,Adapter and converter recipes,Guias de como fazer
@anchor{library/sqlite3 how-to-use-connection-shortcut-methods}@anchor{2b00}@anchor{library/sqlite3 sqlite3-connection-shortcuts}@anchor{2acc}
@subsubsection How to use connection shortcut methods


Using the @ref{2ace,,execute()},
@ref{2acf,,executemany()}, and @ref{2ad0,,executescript()}
methods of the @ref{245,,Connection} class, your code can
be written more concisely because you don’t have to create the (often
superfluous) @ref{2a98,,Cursor} objects explicitly. Instead, the @ref{2a98,,Cursor}
objects are created implicitly and these shortcut methods return the cursor
objects. This way, you can execute a @code{SELECT} statement and iterate over it
directly using only a single call on the @ref{245,,Connection} object.

@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 How to use the connection context manager,How to work with SQLite URIs,How to use connection shortcut methods,Guias de como fazer
@anchor{library/sqlite3 how-to-use-the-connection-context-manager}@anchor{2b01}@anchor{library/sqlite3 sqlite3-connection-context-manager}@anchor{18f7}
@subsubsection How to use the connection context manager


A @ref{245,,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{5d2,,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{4b6,,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{4b6,,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{13d0,,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 How to work with SQLite URIs,How to create and use row factories,How to use the connection context manager,Guias de como fazer
@anchor{library/sqlite3 how-to-work-with-sqlite-uris}@anchor{2b02}@anchor{library/sqlite3 sqlite3-uri-tricks}@anchor{2aab}
@subsubsection How to work with SQLite URIs


Some useful URI tricks include:


@itemize *

@item 
Open a database in read-only mode:
@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 
Do not implicitly create a new database file if it does not already exist;
will raise @ref{19dd,,OperationalError} if unable to create a new file:
@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 
Create a shared named in-memory database:
@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

More information about this feature, including a list of parameters,
can be found in the 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,How to work with SQLite URIs,Guias de como fazer
@anchor{library/sqlite3 how-to-create-and-use-row-factories}@anchor{2b03}@anchor{library/sqlite3 sqlite3-howto-row-factory}@anchor{2a9f}
@subsubsection How to create and use row factories


By default, @code{sqlite3} represents each row as a @ref{370,,tuple}.
If a @code{tuple} does not suit your needs,
you can use the @ref{ea0,,sqlite3.Row} class
or a custom @ref{2ad8,,row_factory}.

While @code{row_factory} exists as an attribute both on the
@ref{2a98,,Cursor} and the @ref{245,,Connection},
it is recommended to set @ref{171a,,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{2ad8,,row_factory}
that returns each row as a @ref{256,,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{64e,,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{1cb,,dataclass}, or any other custom class,
instead of a @ref{1ca,,namedtuple}.

@node How to handle non-UTF-8 text encodings,,How to create and use row factories,Guias de como fazer
@anchor{library/sqlite3 how-to-handle-non-utf-8-text-encodings}@anchor{2b04}@anchor{library/sqlite3 sqlite3-howto-encoding}@anchor{2ad6}
@subsubsection How to handle non-UTF-8 text encodings


By default, @code{sqlite3} uses @ref{44c,,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{2ad9,,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{245,,Connection} instance @code{con}
connected to this database,
we can decode the Latin-2 encoded text using this @ref{2ad9,,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{12e7,,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 também


@ref{12e7,,Unicode}


@node Explicação,,Guias de como fazer,sqlite3 —- interface DB-API 2 0 interface para bancos de dados SQLite
@anchor{library/sqlite3 explanation}@anchor{2b05}@anchor{library/sqlite3 sqlite3-explanation}@anchor{2a95}
@subsubsection Explicação

@anchor{library/sqlite3 sqlite3-transaction-control}@anchor{2b06}
@menu
* Controle de transações:: 

@end menu

@node Controle de transações,,,Explicação
@anchor{library/sqlite3 sqlite3-controlling-transactions}@anchor{2a9a}@anchor{library/sqlite3 transaction-control}@anchor{2b07}
@subsubsection Controle de transações


@code{sqlite3} oferece vários métodos para controlar se, quando e como as transações do banco de dados são abertas e fechadas. @ref{4b7,,Controle de transações através do atributo autocommit} é recomendado, enquanto @ref{2aa9,,Controle de transação através do atributo isolation_level} mantém o comportamento pré-Python 3.12.

@menu
* Controle de transações através do atributo autocommit:: 
* Controle de transação através do atributo isolation_level:: 

@end menu

@node Controle de transações através do atributo autocommit,Controle de transação através do atributo isolation_level,,Controle de transações
@anchor{library/sqlite3 sqlite3-transaction-control-autocommit}@anchor{4b7}@anchor{library/sqlite3 transaction-control-via-the-autocommit-attribute}@anchor{2b08}
@subsubsection Controle de transações através do atributo @code{autocommit}


A forma recomendada de controlar o comportamento da transação é através do atributo @ref{4b6,,Connection.autocommit}, que deve ser preferencialmente definido usando o parâmetro `autocommit' de @ref{2a8,,connect()}.

É sugerido definir `autocommit' como @code{False}, o que implica controle de transação compatível com a 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}. Isso significa:


@itemize *

@item 
@code{sqlite3} garante que uma transação esteja sempre aberta, então @ref{2a8,,connect()}, @ref{2a9b,,Connection.commit()} e @ref{2acd,,Connection.rollback()} abrirão implicitamente uma nova transação (imediatamente após fechando a pendência, para as duas últimas). @code{sqlite3} usa instruções @code{BEGIN DEFERRED} ao abrir transações.

@item 
Transações devem ser executadas explicitamente usando @code{commit()}.

@item 
Transações devem ser revertidas explicitamente usando @code{rollback()}.

@item 
Uma reversão implícita é executada se o banco de dados estiver em estado @ref{246,,close()} com alterações pendentes.
@end itemize

Defina `autocommit' como @code{True} para ativar o modo autocommit@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions} do SQLite. Neste modo, @ref{2a9b,,Connection.commit()} e @ref{2acd,,Connection.rollback()} não têm efeito. Observe que o modo autocommit do SQLite é distinto do atributo @ref{4b6,,Connection.autocommit} compatível com 
@geindex Propostas de Melhorias do Python; PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}; use @ref{2ad7,,Connection.in_transaction} para consultar o modo de confirmação automática do SQLite de baixo nível.

Defina `autocommit' como @ref{2aaa,,LEGACY_TRANSACTION_CONTROL} para deixar o comportamento de controle de transação para o atributo @ref{2aa8,,Connection.isolation_level}. Veja @ref{2aa9,,Controle de transação através do atributo isolation_level} para mais informações.

@node Controle de transação através do atributo isolation_level,,Controle de transações através do atributo autocommit,Controle de transações
@anchor{library/sqlite3 sqlite3-transaction-control-isolation-level}@anchor{2aa9}@anchor{library/sqlite3 transaction-control-via-the-isolation-level-attribute}@anchor{2b09}
@subsubsection Controle de transação através do atributo @code{isolation_level}


@cartouche
@quotation Nota 
A forma recomendada de controlar transações é através do atributo @ref{4b6,,autocommit}. Veja @ref{4b7,,Controle de transações através do atributo autocommit}.
@end quotation
@end cartouche

Se @ref{4b6,,Connection.autocommit} estiver definido como @ref{2aaa,,LEGACY_TRANSACTION_CONTROL} (o padrão), o comportamento da transação é controlado usando o atributo @ref{2aa8,,Connection.isolation_level}. Caso contrário, @code{isolation_level} não tem efeito.

Se o atributo de conexão @ref{2aa8,,isolation_level} não for @code{None}, novas transações são abertas implicitamente antes de @ref{2d1,,execute()} e @ref{2d2,,executemany()} executa instruções @code{INSERT}, @code{UPDATE}, @code{DELETE} ou @code{REPLACE}; para outras instruções, nenhuma manipulação de transação implícita é executada. Use os métodos @ref{2a9b,,commit()} e @ref{2acd,,rollback()} para fazer commit e reverter respectivamente transações pendentes. Você pode escolher o comportamento subjacente de transação do SQLite@footnote{https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions} – isto é, se e que tipo de instruções @code{BEGIN} do @code{sqlite3} são executadas implicitamente – através do atributo @ref{2aa8,,isolation_level}.

Se @ref{2aa8,,isolation_level} estiver definido como @code{None}, nenhuma transação será aberta implicitamente. Isso deixa a biblioteca SQLite subjacente no modo autocommit@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}, mas também permite que o usuário execute sua própria manipulação de transações usando instruções SQL explícitas. O modo de autocommit da biblioteca SQLite subjacente pode ser consultado usando o atributo @ref{2ad7,,in_transaction}.

O método @ref{2ad1,,executescript()} compromete implicitamente qualquer transação pendente antes da execução do script SQL fornecido, independentemente do valor de @ref{2aa8,,isolation_level}.


Alterado na versão 3.6: @code{sqlite3} costumava fazer commit de forma implícita de uma transação aberta antes das instruções DDL. Este não é mais o caso.



Alterado na versão 3.12: A forma recomendada de controlar transações agora é através do atributo @ref{4b6,,autocommit}.


@c import os
@c os.remove("backup.db")
@c os.remove("dump.sql")
@c os.remove("example.db")
@c os.remove("tutorial.db")

@node Compressão de Dados e Arquivamento,Formatos de Arquivo,Persistência de Dados,A Biblioteca Padrão do Python
@anchor{library/archiving doc}@anchor{2a41}@anchor{library/archiving archiving}@anchor{2b0a}@anchor{library/archiving data-compression-and-archiving}@anchor{2b0b}@anchor{library/archiving translation-repo}@anchor{2b0c}
@section Compressão de Dados e Arquivamento


Os módulos descritos neste capítulo suportam a compressão de dados com os algoritmos zlib, gzip, bzip2 e lzma e a criação de arquivos ZIP e tar. Consulte também @ref{1259,,Operações de arquivamento} fornecido pelo módulo @ref{c5,,shutil}.

@menu
* zlib — Compactação compatível com gzip:: 
* gzip — Suporte para arquivos gzip:: 
* bz2 — Suporte para compressão bzip2:: 
* lzma — Compressão usando o algoritmo LZMA:: 
* zipfile — Trabalha com arquivos ZIP:: 
* tarfile — Ler e gravar arquivos do tipo tar:: 

@end menu

@node zlib — Compactação compatível com gzip,gzip — Suporte para arquivos gzip,,Compressão de Dados e Arquivamento
@anchor{library/zlib doc}@anchor{2b0d}@anchor{library/zlib module-zlib}@anchor{133}@anchor{library/zlib zlib-compression-compatible-with-gzip}@anchor{2b0e}
@subsection @code{zlib} — Compactação compatível com @code{gzip}


@geindex module; zlib


__________________________________________________________________


Para aplicações que exigem compactação de dados, as funções deste módulo permitem a compactação e a descompactação, usando a biblioteca zlib. A biblioteca zlib tem sua própria página em @indicateurl{https://www.zlib.net}. Existem algumas incompatibilidades conhecidas entre o Python módulo e as versões da biblioteca zlib anteriores à 1.1.3; a 1.1.3 tem uma vulnerabilidade de segurança@footnote{https://zlib.net/zlib_faq.html#faq33}, portanto, recomendamos o uso da 1.1.4 ou posterior.

As funções do zlib têm muitas opções e geralmente precisam ser usadas em uma ordem específica. Esta documentação não tenta cobrir todas as permutações; consulte o manual do zlib@footnote{https://www.zlib.net/manual.html} para obter informações oficiais.

Para leitura e escrita de arquivos @code{.gz}, consulte o módulo @ref{67,,gzip}.

A exceção e as funções disponíveis neste módulo são:

@geindex error
@anchor{library/zlib zlib error}@anchor{2b0f}
@deffn {Exceção} zlib.error

Exceção levantada em erros de compactação e descompactação.
@end deffn

@geindex adler32() (no módulo zlib)
@anchor{library/zlib zlib adler32}@anchor{1944}
@deffn {Função} zlib.adler32 (data[, value])

Calcula uma soma de verificação Adler-32 de `data'. (Uma soma de verificação Adler-32 é quase tão confiável quanto uma CRC32, mas pode ser calculada muito mais rapidamente.) O resultado é um número inteiro sem sinal de 32 bits. Se `value' estiver presente, ele será usado como o valor inicial da soma de verificação; caso contrário, um valor padrão de 1 é usado. A passagem de `value' permite calcular uma soma de verificação em execução através da concatenação de várias entradas. O algoritmo não é criptograficamente forte e não deve ser usado para autenticação ou assinaturas digitais. Como o algoritmo foi projetado para uso como um algoritmo de soma de verificação, não é adequado para uso como um algoritmo de hash geral.


Alterado na versão 3.0: O resultado é sempre sem sinal.

@end deffn

@geindex compress() (no módulo zlib)
@anchor{library/zlib zlib compress}@anchor{63f}
@deffn {Função} zlib.compress (data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS)

Compacta os bytes em `data', retornando um objeto bytes contendo dados compactados. `level' é um inteiro de @code{0} a @code{9} ou @code{-1} que controla o nível de compactação; Consulte @ref{2b10,,Z_BEST_SPEED} (@code{1}), @ref{2b11,,Z_BEST_COMPRESSION} (@code{9}), @ref{2b12,,Z_NO_COMPRESSION} (@code{0}) e o padrão, @ref{2b13,,Z_DEFAULT_COMPRESSION} (@code{-1}) para obter mais informações sobre esses valores.
@anchor{library/zlib compress-wbits}@anchor{2b14}
O argumento `wbits' controla o tamanho do buffer do histórico (ou o “tamanho da janela”) usado ao compactar dados e se um cabeçalho e um trailer estão incluídos na saída. Pode levar vários intervalos de valores, padronizando para @code{15} (@ref{2b15,,MAX_WBITS}):


@itemize *

@item 
+9 a +15: o logaritmo de base dois do tamanho da janela, que varia entre 512 e 32768. Valores maiores produzem melhor compactação às custas de maior uso de memória. A saída resultante incluirá um cabeçalho e uma sequência específicos para zlib.

@item 
-9 a -15: Usa o valor absoluto de `wbits' como o logaritmo do tamanho da janela, enquanto produz um fluxo de saída bruto sem cabeçalho ou soma de verificação à direita.

@item 
+25 a +31 = 16 + (9 a 15): Usa os 4 bits baixos do valor como logaritmo do tamanho da janela, incluindo um cabeçalho básico @code{gzip} e a soma de verificação à direita na saída.
@end itemize

Levanta uma exceção do tipo @ref{2b0f,,error}, se ocorrer algum erro.


Alterado na versão 3.6: `level' pode agora ser usado como um palavra reservada nomeada.



Alterado na versão 3.11: O parâmetro `wbits' agora está disponível para definir janelas de bits e tipo de compactação.

@end deffn

@geindex compressobj() (no módulo zlib)
@anchor{library/zlib zlib compressobj}@anchor{2b16}
@deffn {Função} zlib.compressobj (level=Z_DEFAULT_COMPRESSION, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])

Retorna um objeto de compactação, a ser usado para compactar fluxos de dados que não cabem na memória de uma só vez.

`level' é um nível de compactação – um inteiro de @code{0} a @code{9} ou @code{-1}. Consulte @ref{2b10,,Z_BEST_SPEED} (@code{1}), @ref{2b11,,Z_BEST_COMPRESSION} (@code{9}), @ref{2b12,,Z_NO_COMPRESSION} (@code{0}) e o padrão, @ref{2b13,,Z_DEFAULT_COMPRESSION} (@code{-1}) para obter mais informações sobre esses valores.

`method' é o algoritmo de compactação. Atualmente, o único valor suportado é @ref{2b17,,DEFLATED}.

O parâmetro `wbits' controla o tamanho do histórico buffer (ou o “tamanho da janela do buffer”) e qual o formato do cabeçalho e do trailer serão usados. Ele tem o mesmo significado que o @ref{2b14,,descrito para compress()}.

O argumento `memLevel' controla a quantidade de memória usada para o estado de compactação interno. Os valores válidos variam de @code{1} a @code{9}. Valores mais altos usam mais memória, mas são mais rápidos e produzem uma saída menor.

`strategy' é usado para ajustar o algoritmo de compactação. Os valores possíveis são @ref{2b18,,Z_DEFAULT_STRATEGY}, @ref{2b19,,Z_FILTERED}, @ref{2b1a,,Z_HUFFMAN_ONLY}, @ref{2b1b,,Z_RLE} e @ref{2b1c,,Z_FIXED}.

`zdict' é um dicionário de compactação predefinido. Esta é uma sequência de bytes (como um objeto @ref{1c2,,bytes}) que contém subsequências que se espera que ocorram com frequência nos dados a serem compactados. As subsequências que se espera serem mais comuns devem aparecer no final do dicionário.


Alterado na versão 3.3: Adicionado o suporte ao parâmetro e argumento nomeado `zdict'.

@end deffn

@geindex crc32() (no módulo zlib)
@anchor{library/zlib zlib crc32}@anchor{178b}
@deffn {Função} zlib.crc32 (data[, value])

@geindex Do inglês; Cyclic Redundancy Check
@geindex soma de verificação;Do inglês; Cyclic Redundancy Check

Calcula uma soma de verificação CRC (Cyclic Redundancy Check) de `data'. O resultado é um número inteiro sem sinal de 32 bits. Se `value' estiver presente, ele será usado como o valor inicial da soma de verificação; caso contrário, um valor padrão de 1 é usado. A passagem de `value' permite calcular uma soma de verificação em execução através da concatenação de várias entradas. O algoritmo não é criptograficamente forte e não deve ser usado para autenticação ou assinaturas digitais. Como o algoritmo foi projetado para uso como um algoritmo de soma de verificação, não é adequado para uso como um algoritmo de hash geral.


Alterado na versão 3.0: O resultado é sempre sem sinal.

@end deffn

@geindex decompress() (no módulo zlib)
@anchor{library/zlib zlib decompress}@anchor{d2f}
@deffn {Função} zlib.decompress (data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)

Descompacta os bytes em `data', retornando um objeto de bytes que contém os dados não compactados. O parâmetro `wbits' depende do formato de `data' e é discutido mais abaixo. Se `bufsize' for fornecido, ele será usado como o tamanho inicial do buffer de saída. Levanta a exceção @ref{2b0f,,error} se ocorrer algum erro.
@anchor{library/zlib decompress-wbits}@anchor{2b1d}
O parâmetro `wbits' controla o tamanho do buffer do histórico (ou “tamanho da janela”) e qual formato de cabeçalho e sequência é esperado. É semelhante ao parâmetro para @ref{2b16,,compressobj()}, mas aceita mais intervalos de valores:


@itemize *

@item 
+8 a +15: O logaritmo de base dois do tamanho da janela. A entrada deve incluir um cabeçalho e uma sequência de zlib.

@item 
0: Determina automaticamente o tamanho da janela no cabeçalho zlib. Suportado apenas desde o zlib 1.2.3.5.

@item 
−8 a −15: Usa o valor absoluto de `wbits' como o logaritmo do tamanho da janela. A entrada deve ser um fluxo bruto sem cabeçalho ou sequência.

@item 
+24 a +31 = 16 + (8 a 15): Usa os 4 bits baixos do valor como logaritmo do tamanho da janela. A entrada deve incluir um cabeçalho e sequência de gzip.

@item 
+40 a +47 = 32 + (8 a 15): Usa os 4 bits baixos do valor como logaritmo do tamanho da janela e aceita automaticamente o formato zlib ou gzip.
@end itemize

Ao descompactar um fluxo, o tamanho da janela não deve ser menor que o tamanho originalmente usado para compactar o fluxo; o uso de um valor muito pequeno pode resultar em uma exceção @ref{2b0f,,error}. O valor padrão `wbits' corresponde ao maior tamanho da janela e requer que um cabeçalho e uma sequência de zlib sejam incluídos.

`bufsize' é o tamanho inicial do buffer usado para armazenar dados descompactados. Se for necessário mais espaço, o tamanho do buffer será aumentado conforme necessário, para que você não precise obter esse valor exatamente correto; sintonizando, apenas algumas chamadas serão salvas em @code{malloc()}.


Alterado na versão 3.6: `wbits' e `bufsize' podem ser usados como argumentos nomeados.

@end deffn

@geindex decompressobj() (no módulo zlib)
@anchor{library/zlib zlib decompressobj}@anchor{2b1e}
@deffn {Função} zlib.decompressobj (wbits=MAX_WBITS[, zdict])

Retorna um objeto descompactado, a ser usado para descompactar fluxos de dados que não cabem na memória de uma só vez.

O parâmetro `wbits' controla o tamanho do histórico do buffer (ou o “tamanho da janela do buffer”) e qual formato do cabeçalho e trailer são esperados. Ele tem o mesmo significado que o @ref{2b1d,,descrito para decompress()}.

O parâmetro `zdict' especifica uma dicionário predefinido de compactação. Se fornecido, deve ser o mesmo dicionário usado pelo compactador que produziu os dados a serem descompactados.

@cartouche
@quotation Nota 
Se `zdict' for um objeto mutável (como um @ref{2ea,,bytearray}), você não deve modificar seu conteúdo entre a chamada de @ref{2b1e,,decompressobj()} e a primeira chamada para o método de descompatação @code{decompress()}.
@end quotation
@end cartouche


Alterado na versão 3.3: Adicionado o parâmetro `zdict'.

@end deffn

Um objeto do tipo Compress oferece suporte aos seguintes métodos:

@geindex compress() (método zlib.Compress)
@anchor{library/zlib zlib Compress compress}@anchor{2b1f}
@deffn {Método} Compress.compress (data)

Comprime `data', retornando um objeto de bytes que contém dados compactados para pelo menos parte dos dados em `data'.  Esses dados devem ser concatenados à saída produzida por quaisquer chamadas anteriores ao método @ref{63f,,compress()}. Algumas entradas podem ser mantidas em buffers internos para processamento posterior.
@end deffn

@geindex flush() (método zlib.Compress)
@anchor{library/zlib zlib Compress flush}@anchor{2b20}
@deffn {Método} Compress.flush ([mode])

Toda a entrada pendente é processada e um objeto de bytes contendo a saída compactada restante é retornado.  O `mode' pode ser selecionado entre constantes @ref{2b21,,Z_NO_FLUSH} , @ref{2b22,,Z_PARTIAL_FLUSH}, @ref{2b23,,Z_SYNC_FLUSH}, @ref{2b24,,Z_FULL_FLUSH}, @ref{2b25,,Z_BLOCK} ou @ref{2b26,,Z_FINISH}, com o padrão sendo @ref{2b26,,Z_FINISH}. Exceto @ref{2b26,,Z_FINISH}, todas as demais constantes permitem a compactação de mais bytestrings de dados, enquanto @ref{2b26,,Z_FINISH} finaliza o fluxo compactado e impede a compactação de mais dados.  Depois de chamar @ref{2b20,,flush()} com `mode' definido como @ref{2b26,,Z_FINISH}, o método @ref{63f,,compress()} não pode ser chamado novamente; a única ação restante possível é excluir o objeto.
@end deffn

@geindex copy() (método zlib.Compress)
@anchor{library/zlib zlib Compress copy}@anchor{2b27}
@deffn {Método} Compress.copy ()

Retorna uma cópia do objeto de compactação.  Isso pode ser usado para compactar com eficiência um conjunto de dados que compartilham um prefixo inicial comum.
@end deffn


Alterado na versão 3.8: As funções @ref{534,,copy.copy()} e @ref{b84,,copy.deepcopy()} foram adicionadas como suporte para a compactação de objetos.


Um objeto de descompactação oferece suporte aos seguintes métodos:

@geindex unused_data (atributo zlib.Decompress)
@anchor{library/zlib zlib Decompress unused_data}@anchor{2b28}
@deffn {Atributo} Decompress.unused_data

Um objeto de bytes que contém todos os bytes após o final dos dados compactados. Ou seja, ele permanece @code{b""} até que o último byte que contém dados compactados esteja disponível.  Se todo o bytestring contiver dados compactados, este será @code{b""}, um objeto de bytes vazio.
@end deffn

@geindex unconsumed_tail (atributo zlib.Decompress)
@anchor{library/zlib zlib Decompress unconsumed_tail}@anchor{2b29}
@deffn {Atributo} Decompress.unconsumed_tail

Um objeto de bytes que contém todos os dados que não foram consumidos pela última chamada @ref{d2f,,decompress()} porque excederam o limite dos dados não compactados no buffer.  Esses dados ainda não foram vistos pela zlib, portanto, você deve alimentá-los (possivelmente com outros dados concatenados a eles) em uma chamada  subsequente para o método @ref{d2f,,decompress()} e, com isso, obter a saída correta.
@end deffn

@geindex eof (atributo zlib.Decompress)
@anchor{library/zlib zlib Decompress eof}@anchor{11ac}
@deffn {Atributo} Decompress.eof

Um booleano indicando se o fim do fluxo de dados compactados foi alcançado.

Isso permite distinguir entre um fluxo compactado formado corretamente e um fluxo incompleto ou truncado.


Adicionado na versão 3.3.

@end deffn

@geindex decompress() (método zlib.Decompress)
@anchor{library/zlib zlib Decompress decompress}@anchor{2b2a}
@deffn {Método} Decompress.decompress (data, max_length=0)

Descompacta `data', retornando um objeto de bytes que contém os dados não compactados correspondentes a pelo menos uma parte dos dados em `string'. Esses dados devem ser concatenados com a saída produzida por quaisquer chamadas anteriores ao método @ref{d2f,,decompress()} . Alguns dos dados de entrada podem ser preservados em buffers internos para processamento posterior.

Se o parâmetro opcional `max_length' for diferente de zero, o valor retornado não será maior que `max_length'. Isso pode significar que nem toda a entrada compactada poderá ser processada, e os dados não consumidos serão armazenados no atributo @ref{2b29,,unconsumed_tail} . Esse bytestring deve ser passado para uma chamada subsequente a @ref{d2f,,decompress()} se a descompactação tiver que continuar.  Se `max_length' for zero, toda a entrada será descompactada e @ref{2b29,,unconsumed_tail} ficará vazio.


Alterado na versão 3.6: `max_length' pode ser usado como argumento nomeado.

@end deffn

@geindex flush() (método zlib.Decompress)
@anchor{library/zlib zlib Decompress flush}@anchor{2b2b}
@deffn {Método} Decompress.flush ([length])

Toda a entrada que estiver pendente é processada e um objeto de bytes contendo a saída descompactada restante é retornado.  Depois de chamar @ref{2b2b,,flush()}, o método @ref{d2f,,decompress()} não pode ser chamado novamente; a única ação possível é excluir o objeto.

O parâmetro opcional `comprimento' define o tamanho inicial da saída do buffer.
@end deffn

@geindex copy() (método zlib.Decompress)
@anchor{library/zlib zlib Decompress copy}@anchor{2b2c}
@deffn {Método} Decompress.copy ()

Retorna uma cópia do objeto de descompactação. Isso pode ser usado para salvar o estado do descompactador no meio do fluxo de dados, a fim de acelerar as buscas aleatórias no fluxo em um ponto futuro.
@end deffn


Alterado na versão 3.8: As funções @ref{534,,copy.copy()} e @ref{b84,,copy.deepcopy()} foram adicionadas como suporte para a objetos de descompactação.


As constantes a seguir estão disponíveis para configurar o comportamento de compactação e descompactação:

@geindex DEFLATED (no módulo zlib)
@anchor{library/zlib zlib DEFLATED}@anchor{2b17}
@deffn {Dado} zlib.DEFLATED

O método de compactação de deflação.
@end deffn

@geindex MAX_WBITS (no módulo zlib)
@anchor{library/zlib zlib MAX_WBITS}@anchor{2b15}
@deffn {Dado} zlib.MAX_WBITS

O tamanho máximo da janela, expresso como uma potência de 2. Por exemplo, se @code{MAX_WBITS} for @code{15}, isso resultará em um tamanho de janela de @code{32 KiB}.
@end deffn

@geindex DEF_MEM_LEVEL (no módulo zlib)
@anchor{library/zlib zlib DEF_MEM_LEVEL}@anchor{2b2d}
@deffn {Dado} zlib.DEF_MEM_LEVEL

O nível de memória padrão para objetos de compactação.
@end deffn

@geindex DEF_BUF_SIZE (no módulo zlib)
@anchor{library/zlib zlib DEF_BUF_SIZE}@anchor{2b2e}
@deffn {Dado} zlib.DEF_BUF_SIZE

O tamanho padrão do buffer para operações de descompactação.
@end deffn

@geindex Z_NO_COMPRESSION (no módulo zlib)
@anchor{library/zlib zlib Z_NO_COMPRESSION}@anchor{2b12}
@deffn {Dado} zlib.Z_NO_COMPRESSION

Nível de compactação @code{0}; sem compactação.


Adicionado na versão 3.6.

@end deffn

@geindex Z_BEST_SPEED (no módulo zlib)
@anchor{library/zlib zlib Z_BEST_SPEED}@anchor{2b10}
@deffn {Dado} zlib.Z_BEST_SPEED

Nível de compactação @code{1}; mais rápido e produz a menor compactação.
@end deffn

@geindex Z_BEST_COMPRESSION (no módulo zlib)
@anchor{library/zlib zlib Z_BEST_COMPRESSION}@anchor{2b11}
@deffn {Dado} zlib.Z_BEST_COMPRESSION

Nível de compactação @code{9}; mais lento e produz a maior compactação.
@end deffn

@geindex Z_DEFAULT_COMPRESSION (no módulo zlib)
@anchor{library/zlib zlib Z_DEFAULT_COMPRESSION}@anchor{2b13}
@deffn {Dado} zlib.Z_DEFAULT_COMPRESSION

Nível de compactação padrão (@code{-1}); um meio-termo entre velocidade e compactação. Atualmente equivalente ao nível de compactação @code{6}.
@end deffn

@geindex Z_DEFAULT_STRATEGY (no módulo zlib)
@anchor{library/zlib zlib Z_DEFAULT_STRATEGY}@anchor{2b18}
@deffn {Dado} zlib.Z_DEFAULT_STRATEGY

Estratégia de compactação padrão, para dados normais.
@end deffn

@geindex Z_FILTERED (no módulo zlib)
@anchor{library/zlib zlib Z_FILTERED}@anchor{2b19}
@deffn {Dado} zlib.Z_FILTERED

Estratégia de compactação para dados produzidos por um filtro (ou preditor).
@end deffn

@geindex Z_HUFFMAN_ONLY (no módulo zlib)
@anchor{library/zlib zlib Z_HUFFMAN_ONLY}@anchor{2b1a}
@deffn {Dado} zlib.Z_HUFFMAN_ONLY

Estratégia de compactação que força codificação Huffman apenas.
@end deffn

@geindex Z_RLE (no módulo zlib)
@anchor{library/zlib zlib Z_RLE}@anchor{2b1b}
@deffn {Dado} zlib.Z_RLE

Estratégia de compactação que limita distâncias de correspondência a um (codificação run-length).

Esta constante só estará disponível se o Python foi construído com zlib 1.2.0.1 ou superior.


Adicionado na versão 3.6.

@end deffn

@geindex Z_FIXED (no módulo zlib)
@anchor{library/zlib zlib Z_FIXED}@anchor{2b1c}
@deffn {Dado} zlib.Z_FIXED

Estratégia de compactação que impede o uso de códigos dinâmicos de Huffman.

Esta constante só estará disponível se o Python foi construído com zlib 1.2.2.2 ou superior.


Adicionado na versão 3.6.

@end deffn

@geindex Z_NO_FLUSH (no módulo zlib)
@anchor{library/zlib zlib Z_NO_FLUSH}@anchor{2b21}
@deffn {Dado} zlib.Z_NO_FLUSH

Modo de saída @code{0}. Nenhum comportamento especial de saída.


Adicionado na versão 3.6.

@end deffn

@geindex Z_PARTIAL_FLUSH (no módulo zlib)
@anchor{library/zlib zlib Z_PARTIAL_FLUSH}@anchor{2b22}
@deffn {Dado} zlib.Z_PARTIAL_FLUSH

Modo de saída @code{1}. Emite o máximo de saída possível.
@end deffn

@geindex Z_SYNC_FLUSH (no módulo zlib)
@anchor{library/zlib zlib Z_SYNC_FLUSH}@anchor{2b23}
@deffn {Dado} zlib.Z_SYNC_FLUSH

Modo de saída @code{2}. Toda saída é emitida e é alinhada a um limite de bytes.
@end deffn

@geindex Z_FULL_FLUSH (no módulo zlib)
@anchor{library/zlib zlib Z_FULL_FLUSH}@anchor{2b24}
@deffn {Dado} zlib.Z_FULL_FLUSH

Modo de saída @code{3}. Toda a saída é emitida e o estado de compactação é redefinido.
@end deffn

@geindex Z_FINISH (no módulo zlib)
@anchor{library/zlib zlib Z_FINISH}@anchor{2b26}
@deffn {Dado} zlib.Z_FINISH

Modo de saída @code{4}. Toda entrada pendente é processada, nenhuma outra entrada é esperada.
@end deffn

@geindex Z_BLOCK (no módulo zlib)
@anchor{library/zlib zlib Z_BLOCK}@anchor{2b25}
@deffn {Dado} zlib.Z_BLOCK

Modo de saída @code{5}. Um bloco de deflação é concluído e emitido.

Esta constante só estará disponível se o Python foi construído com zlib 1.2.2.2 ou superior.


Adicionado na versão 3.6.

@end deffn

@geindex Z_TREES (no módulo zlib)
@anchor{library/zlib zlib Z_TREES}@anchor{2b2f}
@deffn {Dado} zlib.Z_TREES

Modo de saída @code{6}, para operações de inflação. Instrui a inflação a retornar ao atingir o próximo limite do bloco de desinflação.

Esta constante está disponível apenas se o Python foi compilado com zlib 1.2.3.4 ou superior.


Adicionado na versão 3.6.

@end deffn

As informações sobre o versão da biblioteca zlib em uso estão disponíveis no seguinte constantes:

@geindex ZLIB_VERSION (no módulo zlib)
@anchor{library/zlib zlib ZLIB_VERSION}@anchor{2b30}
@deffn {Dado} zlib.ZLIB_VERSION

Uma string com a versão da biblioteca zlib que foi usada para construir o módulo. Isso pode ser diferente da biblioteca zlib realmente usada no tempo de execução, que está disponível como @ref{11ad,,ZLIB_RUNTIME_VERSION}.
@end deffn

@geindex ZLIB_RUNTIME_VERSION (no módulo zlib)
@anchor{library/zlib zlib ZLIB_RUNTIME_VERSION}@anchor{11ad}
@deffn {Dado} zlib.ZLIB_RUNTIME_VERSION

Uma string com a versão da biblioteca zlib atualmente utilizada pelo interpretador.


Adicionado na versão 3.3.

@end deffn


@subsubheading Ver também



@table @asis

@item módulo @ref{67,,gzip}

Leia e escreva arquivos no formato @code{gzip}

@item @indicateurl{https://www.zlib.net}

A página inicial da biblioteca zlib.

@item @indicateurl{https://www.zlib.net/manual.html}

O manual da zlib explica a semântica e uso de diversas funções desta biblioteca.
@end table

Caso a (des)compactação do gzip seja um gargalo, o pacote python-isal@footnote{https://github.com/pycompression/python-isal} acelera a (des)compactação com uma API quase sempre compatível.


@node gzip — Suporte para arquivos gzip,bz2 — Suporte para compressão bzip2,zlib — Compactação compatível com gzip,Compressão de Dados e Arquivamento
@anchor{library/gzip doc}@anchor{2b31}@anchor{library/gzip gzip-support-for-gzip-files}@anchor{2b32}@anchor{library/gzip module-gzip}@anchor{67}@anchor{library/gzip translation-repo}@anchor{2b33}
@subsection @code{gzip} — Suporte para arquivos @code{gzip}


@geindex module; gzip

`Código-fonte:' Lib/gzip.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/gzip.py}


__________________________________________________________________


Esse módulo disponibiliza uma interface simples para comprimir e extrair arquivos como os programas GNU @code{gzip} e @code{gunzip} fazem.

A compressão de dados é realizada pelo módulo @ref{133,,zlib}.

O módulo @ref{67,,gzip} fornece a classe @ref{41a,,GzipFile}, bem como as funções de conveniência @ref{2b34,,open()}, @ref{63e,,compress()} e @ref{124d,,decompress()}. A classe @ref{41a,,GzipFile} lê e grava arquivos no formato @code{gzip}, compactando ou descompactando automaticamente os dados para que se pareçam com um @ref{1203,,objeto arquivo} comum.

Observe que formatos de arquivo adicionais que podem ser descompactados pelos programas @code{gzip} e @code{gunzip}, como aqueles produzidos por @code{compress} e @code{pack}, não são suportados por este módulo.

Este módulo define os seguintes itens:

@geindex open() (no módulo gzip)
@anchor{library/gzip gzip open}@anchor{2b34}
@deffn {Função} gzip.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

Abre um arquivo comprimido com gzip em modo binário ou texto, retornando @ref{1203,,objeto arquivo}.

O argumento `filename' pode ser um nome de arquivo real (um objeto @ref{44c,,str} ou @ref{1c2,,bytes}), ou um objeto arquivo existente para ler ou gravar.

O argumento `mode' pode ser qualquer um de @code{'r'}, @code{'rb'}, @code{'a'}, @code{'ab'}, @code{'w'}, @code{'wb'}, @code{'x'} ou @code{'xb'} para modo binário, ou @code{'rt'}, @code{'at'}, @code{'wt'} ou @code{'xt'} para modo texto. O padrão é @code{'rb'}.

O argumento `compresslevel' é um inteiro de 0 a 9, como para o construtor de @ref{41a,,GzipFile}.

Para o modo binário, esta função equivale ao construtor de @ref{41a,,GzipFile}: @code{GzipFile(filename, mode, compresslevel)}. Neste caso, os argumentos `encoding', `errors' e `newline' não devem ser fornecidos.

Para o modo texto, um objeto @ref{41a,,GzipFile} é criado e encapsulado em uma instância @ref{7bc,,io.TextIOWrapper} com a codificação especificada, comportamento de tratamento de erros e final(is) de linha.


Alterado na versão 3.3: Adicionado suporte para `filename' ser um objeto arquivo, suporte para modo texto e os argumentos `encoding', `errors' e `newline'.



Alterado na versão 3.4: Adicionado suporte para os modos @code{'x'}, @code{'xb'} e @code{'xt'}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex BadGzipFile
@anchor{library/gzip gzip BadGzipFile}@anchor{9ff}
@deffn {Exceção} gzip.BadGzipFile

Uma exceção levantada para arquivos gzip inválidos. Herda de @ref{417,,OSError}. @ref{131c,,EOFError} e @ref{2b0f,,zlib.error} também podem ser levantadas para arquivos gzip inválidos.


Adicionado na versão 3.8.

@end deffn

@geindex GzipFile (classe em gzip)
@anchor{library/gzip gzip GzipFile}@anchor{41a}
@deffn {Classe} gzip.GzipFile (filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)

Construtor para a classe @ref{41a,,GzipFile}, que simula a maioria dos métodos de um @ref{1203,,objeto arquivo}, com exceção do método @ref{1355,,truncate()}. Pelo menos um dos métodos `fileobj' e `filename' deve receber um valor não trivial.

A nova instância de classe é baseada em `fileobj', que pode ser um arquivo comum, um objeto @ref{ed3,,io.BytesIO} ou qualquer outro objeto que simule um arquivo. O padrão é @code{None}, caso em que `filename' é aberto para fornecer um objeto arquivo.

Quando `fileobj' não é @code{None}, o argumento `filename' é usado apenas para ser incluído no cabeçalho do arquivo @code{gzip}, que pode incluir o nome original do arquivo descompactado. O padrão é o nome de arquivo `fileobj', se discernível; caso contrário, o padrão é a string vazia e, neste caso, o nome original do arquivo não é incluído no cabeçalho.

O argumento `mode' pode ser qualquer um dos seguintes: @code{'r'}, @code{'rb'}, @code{'a'}, @code{'ab'}, @code{'w'}, @code{'wb'}, @code{'x'} ou @code{'xb'}, dependendo se o arquivo será lido ou escrito. O padrão é o modo de `fileobj', se discernível; caso contrário, o padrão é @code{'rb'}. Em versões futuras do Python, o modo de `fileobj' não será usado. É melhor sempre especificar `mode' para escrita.

Observe que o arquivo é sempre aberto em modo binário. Para abrir um arquivo compactado em modo texto, use @ref{2b34,,open()} (ou envolva seu @ref{41a,,GzipFile} com um @ref{7bc,,io.TextIOWrapper}).

O argumento `compresslevel' é um inteiro de @code{0} a @code{9} que controla o nível de compressão; @code{1} é o mais rápido e produz a menor compressão, e @code{9} é o mais lento e produz a maior compressão. @code{0} significa sem compressão. O padrão é @code{9}.

O argumento opcional `mtime' é o registro de data e hora solicitado pelo gzip. O horário está no formato Unix, ou seja, segundos desde 00:00:00 UTC, 1º de janeiro de 1970. Se `mtime' for omitido ou definido como @code{None}, o horário atual será usado. Use `mtime' = 0 para gerar um fluxo compactado que não depende do horário de criação.

Veja abaixo o atributo @ref{2b35,,mtime} que é definido durante a descompactação.

Chamar o método @code{close()} de um objeto @ref{41a,,GzipFile} não fecha `fileobj', pois você pode querer adicionar mais material após os dados compactados. Isso também permite que você passe um objeto @ref{ed3,,io.BytesIO} aberto para escrita como `fileobj' e recupere o buffer de memória resultante usando o método @ref{2b36,,getvalue()} do objeto @ref{ed3,,io.BytesIO}.

@ref{41a,,GzipFile} suporta a interface @ref{694,,io.BufferedIOBase}, incluindo iteração e a instrução @ref{5d2,,with}. Apenas o método @ref{1355,,truncate()} não é implementado.

@ref{41a,,GzipFile} também disponibiliza os seguintes métodos e atributos:

@geindex peek() (método gzip.GzipFile)
@anchor{library/gzip gzip GzipFile peek}@anchor{124c}
@deffn {Método} peek (n)

Lê `n' bytes não compactados sem avançar a posição do arquivo. O número de bytes retornados pode ser maior ou menor que o solicitado.

@cartouche
@quotation Nota 
Embora chamar @ref{124c,,peek()} não altere a posição do arquivo @ref{41a,,GzipFile}, ele pode alterar a posição do objeto arquivo subjacente (por exemplo, se o @ref{41a,,GzipFile} foi construído com o parâmetro `fileobj').
@end quotation
@end cartouche


Adicionado na versão 3.2.

@end deffn

@geindex mode (atributo gzip.GzipFile)
@anchor{library/gzip gzip GzipFile mode}@anchor{2b37}
@deffn {Atributo} mode

@code{'rb'} para leitura e @code{'wb'} para escrita.


Alterado na versão 3.13: Em versões anteriores era um inteiro @code{1} ou @code{2}.

@end deffn

@geindex mtime (atributo gzip.GzipFile)
@anchor{library/gzip gzip GzipFile mtime}@anchor{2b35}
@deffn {Atributo} mtime

Ao descompactar, este atributo é definido como o último registro de data e hora no cabeçalho lido mais recentemente. É um inteiro que contém o número de segundos desde a era Unix (00:00:00 UTC, 1º de janeiro de 1970). O valor inicial antes da leitura de qualquer cabeçalho é @code{None}.
@end deffn

@geindex name (atributo gzip.GzipFile)
@anchor{library/gzip gzip GzipFile name}@anchor{50d}
@deffn {Atributo} name

O caminho para o arquivo gzip no disco, como @ref{44c,,str} ou @ref{1c2,,bytes}. Equivalente à saída de @ref{c6e,,os.fspath()} no caminho de entrada original, sem nenhuma outra normalização, resolução ou expansão.
@end deffn


Alterado na versão 3.1: Foi adicionado suporte para a instrução @ref{5d2,,with}, juntamente com o argumento do construtor `mtime' e o atributo @ref{2b35,,mtime}.



Alterado na versão 3.2: Foi adicionado suporte para arquivos preenchidos com zeros e não pesquisáveis.



Alterado na versão 3.3: O método @ref{2b38,,io.BufferedIOBase.read1()} agora está implementado.



Alterado na versão 3.4: Adicionado suporte para os modos @code{'x'} e @code{'xb'}.



Alterado na versão 3.5: Adicionado suporte para escrever @ref{d4f,,objetos bytes ou similares} arbitrários. O método @ref{136d,,read()} agora aceita o argumento @code{None}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Descontinuado desde a versão 3.9: Abrir @ref{41a,,GzipFile} para escrita sem especificar o argumento `mode' está descontinuado.



Alterado na versão 3.12: Remove o atributo @code{filename} e usa o atributo @ref{50d,,name}.

@end deffn

@geindex compress() (no módulo gzip)
@anchor{library/gzip gzip compress}@anchor{63e}
@deffn {Função} gzip.compress (data, compresslevel=9, *, mtime=None)

Compacta `data', retornando um objeto @ref{1c2,,bytes} contendo os dados compactados. `compresslevel' e `mtime' têm o mesmo significado que no construtor de @ref{41a,,GzipFile} acima.


Adicionado na versão 3.2.



Alterado na versão 3.8: Adicionado o parâmetro `mtime' para saída reproduzível.



Alterado na versão 3.11: A velocidade é melhorada pela compactação de todos os dados de uma só vez, em vez de em fluxo contínuo. Chamadas com `mtime' definido como @code{0} são delegadas a @ref{63f,,zlib.compress()} para maior velocidade. Nessa situação, a saída pode conter um valor de byte “OS” no cabeçalho gzip diferente de 255 “unknown”, conforme fornecido pela implementação subjacente do zlib.



Alterado na versão 3.13: O byte do cabeçalho gzip do sistema operacional tem a garantia de ser definido como 255 quando esta função é usada, como era o caso na versão 3.10 e anteriores.

@end deffn

@geindex decompress() (no módulo gzip)
@anchor{library/gzip gzip decompress}@anchor{124d}
@deffn {Função} gzip.decompress (data)

Descompacta `data', retornando um objeto @ref{1c2,,bytes} contendo os dados descompactados. Esta função é capaz de descompactar dados de gzip de vários membros (vários blocos gzip concatenados). Quando é certo que os dados contêm apenas um membro, a função @ref{d2f,,zlib.decompress()} com `wbits' definido como 31 é mais rápida.


Adicionado na versão 3.2.



Alterado na versão 3.11: A velocidade é melhorada ao descompactar os membros de uma só vez na memória, em vez de fazê-lo de forma contínua.

@end deffn

@menu
* Exemplos de uso:: 
* Interface de linha de comando: Interface de linha de comando<2>. 

@end menu

@node Exemplos de uso,Interface de linha de comando<2>,,gzip — Suporte para arquivos gzip
@anchor{library/gzip examples-of-usage}@anchor{2b39}@anchor{library/gzip gzip-usage-examples}@anchor{2b3a}
@subsubsection Exemplos de uso


Exemplo de como ler um arquivo comprimido:

@example
import gzip
with gzip.open('/home/joe/arquivo.txt.gz', 'rb') as f:
    file_content = f.read()
@end example

Exemplo de como criar um arquivo comprimido com GZIP:

@example
import gzip
content = b"Muito conteúdo aqui"
with gzip.open('/home/joe/arquivo.txt.gz', 'wb') as f:
    f.write(content)
@end example

Exemplo de como comprimir um arquivo existente com GZIP:

@example
import gzip
import shutil
with open('/home/joe/arquivo.txt', 'rb') as f_in:
    with gzip.open('/home/joe/arquivo.txt.gz', 'wb') as f_out:
        shutil.copyfileobj(f_in, f_out)
@end example

Exemplo de como comprimir uma string binária com compressão GZIP:

@example
import gzip
s_in = b"Muito conteúdo aqui"
s_out = gzip.compress(s_in)
@end example


@subsubheading Ver também



@table @asis

@item Módulo @ref{133,,zlib}

O módulo básico de compactação de dados necessário para dar suporte ao formato de arquivo do @code{gzip}.
@end table

Caso a (des)compactação do gzip seja um gargalo, o pacote python-isal@footnote{https://github.com/pycompression/python-isal} acelera a (des)compactação com uma API quase sempre compatível.


@node Interface de linha de comando<2>,,Exemplos de uso,gzip — Suporte para arquivos gzip
@anchor{library/gzip command-line-interface}@anchor{2b3b}@anchor{library/gzip gzip-cli}@anchor{2b3c}
@subsubsection Interface de linha de comando


O módulo @ref{67,,gzip} fornece uma interface de linha de comando simples para compactar ou descompactar arquivos.

Uma vez executado, o módulo @ref{67,,gzip} mantém o(s) arquivo(s) de entrada.


Alterado na versão 3.8: Adiciona uma nova interface de linha de comando com um mensagem de uso. Por padrão, ao executar a CLI, o nível de compactação padrão é 6.


@menu
* Opções de linha de comando:: 

@end menu

@node Opções de linha de comando,,,Interface de linha de comando<2>
@anchor{library/gzip command-line-options}@anchor{2b3d}
@subsubsection Opções de linha de comando


@geindex gzip opção de linha de comando; file
@anchor{library/gzip cmdoption-gzip-arg-file}@anchor{2b3e}
@deffn {Option} file

Se o `arquivo' não for especificado, ler de @ref{53d,,sys.stdin}
@end deffn

@geindex gzip opção de linha de comando; --fast
@anchor{library/gzip cmdoption-gzip-fast}@anchor{2b3f}
@deffn {Option} @w{-}@w{-}fast

Indica o método mais rápido de compressão (menor compressão)
@end deffn

@geindex gzip opção de linha de comando; --best
@anchor{library/gzip cmdoption-gzip-best}@anchor{2b40}
@deffn {Option} @w{-}@w{-}best

Indica o método mais lento de compressão (melhor compressão).
@end deffn

@geindex gzip opção de linha de comando; -d
@geindex gzip opção de linha de comando; --decompress
@anchor{library/gzip cmdoption-gzip-d}@anchor{2b41}@anchor{library/gzip cmdoption-gzip-decompress}@anchor{2b42}
@deffn {Option} @w{-}d, @w{-}@w{-}decompress

Descompacta o arquivo dado.
@end deffn

@geindex gzip opção de linha de comando; -h
@geindex gzip opção de linha de comando; --help
@anchor{library/gzip cmdoption-gzip-h}@anchor{2b43}@anchor{library/gzip cmdoption-gzip-help}@anchor{2b44}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Exibe a mensagem de ajuda.
@end deffn

@node bz2 — Suporte para compressão bzip2,lzma — Compressão usando o algoritmo LZMA,gzip — Suporte para arquivos gzip,Compressão de Dados e Arquivamento
@anchor{library/bz2 doc}@anchor{2b45}@anchor{library/bz2 bz2-support-for-bzip2-compression}@anchor{2b46}@anchor{library/bz2 module-bz2}@anchor{13}@anchor{library/bz2 translation-repo}@anchor{2b47}
@subsection @code{bz2} — Suporte para compressão @code{bzip2}


@geindex module; bz2

`Código-fonte:' Lib/bz2.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/bz2.py}


__________________________________________________________________


Este módulo fornece uma interface abrangente para compactar e descompactar dados usando o algoritmo de compactação bzip2.

O módulo @ref{13,,bz2} contém:


@itemize *

@item 
A função @ref{10cc,,open()} e a classe @ref{86a,,BZ2File} para leitura e escrita de arquivos compactados.

@item 
As classes @ref{1856,,BZ2Compressor} e @ref{1854,,BZ2Decompressor} para (des)compressão incremental.

@item 
As funções @ref{25ad,,compress()} e @ref{10cd,,decompress()} para (des)compactação de uma só vez.
@end itemize

@menu
* (Des)compressão de arquivos: Des compressão de arquivos. 
* (Des)compressão incremental: Des compressão incremental. 
* (De)compressão de uma só vez (one-shot): De compressão de uma só vez one-shot. 
* Exemplos de uso: Exemplos de uso<2>. 

@end menu

@node Des compressão de arquivos,Des compressão incremental,,bz2 — Suporte para compressão bzip2
@anchor{library/bz2 de-compression-of-files}@anchor{2b48}
@subsubsection (Des)compressão de arquivos


@geindex open() (no módulo bz2)
@anchor{library/bz2 bz2 open}@anchor{10cc}
@deffn {Função} bz2.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

Abre um arquivo compactado com bzip2 no modo binário ou texto, retornando um @ref{1203,,objeto arquivo}.

Assim como no construtor para @ref{86a,,BZ2File}, o argumento `filename' pode ser um nome de arquivo real (um objeto @ref{44c,,str} ou @ref{1c2,,bytes}), ou um objeto arquivo existente para ler ou gravar.

O argumento `mode' pode ser qualquer um de @code{'r'}, @code{'rb'}, @code{'w'}, @code{'wb'}, @code{'x'}, @code{'xb'}, @code{'a'} ou @code{'ab'} para modo binário, ou @code{'rt'}, @code{'wt'}, @code{'xt'} ou @code{'at'} para modo texto. O padrão é @code{'rb'}.

O argumento `compresslevel' é um inteiro de 1 a 9, como para o construtor @ref{86a,,BZ2File}.

Para o modo binário, esta função é equivalente ao construtor de @ref{86a,,BZ2File}: @code{BZ2File(filename, mode, compresslevel=compresslevel)}. Neste caso, os argumentos `encoding', `errors' e `newline' não devem ser fornecidos.

Para o modo texto, um objeto @ref{86a,,BZ2File} é criado e envolto em uma instância @ref{7bc,,io.TextIOWrapper} com a codificação especificada, comportamento de tratamento de erros e final(is) de linha.


Adicionado na versão 3.3.



Alterado na versão 3.4: O modo @code{'x'} (criação exclusiva) foi adicionado.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex BZ2File (classe em bz2)
@anchor{library/bz2 bz2 BZ2File}@anchor{86a}
@deffn {Classe} bz2.BZ2File (filename, mode='r', *, compresslevel=9)

Abre um arquivo compactado com bzip2 no modo binário.

Se `filename' for um objeto @ref{44c,,str} ou @ref{1c2,,bytes}, abra o arquivo nomeado diretamente. Caso contrário, `filename' deve ser um @ref{1203,,objeto arquivo}, que será usado para ler ou gravar os dados compactados.

O argumento `mode' pode ser @code{'r'} para leitura (padrão), @code{'w'} para substituição, @code{'x'} para criação exclusiva ou @code{'a'} para anexar. Estes podem ser equivalentemente dados como @code{'rb'}, @code{'wb'}, @code{'xb'} e @code{'ab'} respectivamente.

Se `filename' for um objeto arquivo (ao invés de um nome de arquivo real), um modo de @code{'w'} não truncará o arquivo e será equivalente a @code{'a'}.

Se `mode' for @code{'w'} ou @code{'a'}, `compresslevel' pode ser um inteiro entre @code{1} e @code{9} especificando o nível de compressão: @code{1} produz a menor compressão e @code{9} (padrão) produz a maior compactação.

Se `mode' for @code{'r'}, o arquivo de entrada pode ser a concatenação de vários fluxos compactados.

@ref{86a,,BZ2File} fornece todos os membros especificados pelo @ref{694,,io.BufferedIOBase}, exceto @ref{2b49,,detach()} e @ref{1355,,truncate()}. Iteração e a instrução @ref{5d2,,with} são suportadas.

@ref{86a,,BZ2File} também fornece os seguintes métodos e atributos:

@geindex peek() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File peek}@anchor{2b4a}
@deffn {Método} peek ([n])

Retorna dados armazenados em buffer sem avançar a posição do arquivo. Pelo menos um byte de dados será retornado (a menos que em EOF). O número exato de bytes retornados não é especificado.

@cartouche
@quotation Nota 
Enquanto chamar @ref{2b4a,,peek()} não altera a posição do arquivo de @ref{86a,,BZ2File}, pode alterar a posição do objeto arquivo subjacente (por exemplo, se o @ref{86a,,BZ2File} foi construído passando um objeto arquivo para `filename').
@end quotation
@end cartouche


Adicionado na versão 3.3.

@end deffn

@geindex fileno() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File fileno}@anchor{2b4b}
@deffn {Método} fileno ()

Retorna o endereço descritor de arquivo do arquivo subjacente.


Adicionado na versão 3.3.

@end deffn

@geindex readable() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File readable}@anchor{2b4c}
@deffn {Método} readable ()

Retorna se o arquivo foi aberto para leitura.


Adicionado na versão 3.3.

@end deffn

@geindex seekable() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File seekable}@anchor{2b4d}
@deffn {Método} seekable ()

Retorna se o arquivo suporta a busca.


Adicionado na versão 3.3.

@end deffn

@geindex writable() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File writable}@anchor{2b4e}
@deffn {Método} writable ()

Retorna se o arquivo foi aberto para gravação.


Adicionado na versão 3.3.

@end deffn

@geindex read1() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File read1}@anchor{2b4f}
@deffn {Método} read1 (size=-1)

Lê até o tamanho `size' de bytes não compactados, tentando evitar várias leituras do fluxo subjacente. Lê até um valor buffer de dados se o tamanho for negativo.

Retorna @code{b'@w{'}} se o arquivo tiver atingido EOF, ou seja, o fim do arquivo.


Adicionado na versão 3.3.

@end deffn

@geindex readinto() (método bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File readinto}@anchor{2b50}
@deffn {Método} readinto (b)

Lê bytes para `b'.

Retorna o número de bytes lidos (0 para EOF).


Adicionado na versão 3.3.

@end deffn

@geindex mode (atributo bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File mode}@anchor{2b51}
@deffn {Atributo} mode

@code{'rb'} para leitura e @code{'wb'} para escrita.


Adicionado na versão 3.13.

@end deffn

@geindex name (atributo bz2.BZ2File)
@anchor{library/bz2 bz2 BZ2File name}@anchor{2b52}
@deffn {Atributo} name

O nome do arquivo bzip2. Equivalente ao atributo @ref{2b53,,name} do @ref{1203,,objeto arquivo} subjacente.


Adicionado na versão 3.13.

@end deffn


Alterado na versão 3.1: Suporte para a instrução @ref{5d2,,with} foi adicionado.



Alterado na versão 3.3: Foi adicionado suporte para `filename' ser um @ref{1203,,objeto arquivo} em vez de um nome de arquivo real.

O modo @code{'a'} (anexar) foi adicionado, juntamente com suporte para leitura de arquivos multifluxo.



Alterado na versão 3.4: O modo @code{'x'} (criação exclusiva) foi adicionado.



Alterado na versão 3.5: O método @ref{136d,,read()} agora aceita um argumento de @code{None}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.9: O parâmetro `buffering' foi removido. Foi ignorado e descontinuado desde o Python 3.0. Passe um objeto arquivo aberto para controlar como o arquivo é aberto.

O parâmetro `compresslevel' tornou-se somente-nomeado.



Alterado na versão 3.10: Esta classe não é segura para threads diante de vários leitores ou escritores simultâneos, assim como suas classes equivalentes em @ref{67,,gzip} e @ref{8a,,lzma} sempre foram.

@end deffn

@node Des compressão incremental,De compressão de uma só vez one-shot,Des compressão de arquivos,bz2 — Suporte para compressão bzip2
@anchor{library/bz2 incremental-de-compression}@anchor{2b54}
@subsubsection (Des)compressão incremental


@geindex BZ2Compressor (classe em bz2)
@anchor{library/bz2 bz2 BZ2Compressor}@anchor{1856}
@deffn {Classe} bz2.BZ2Compressor (compresslevel=9)

Cria um novo objeto compressor. Este objeto pode ser usado para compactar dados de forma incremental. Para compactação única, use a função @ref{25ad,,compress()}.

`compresslevel', se fornecido, deve ser um inteiro entre @code{1} e @code{9}. O padrão é @code{9}.

@geindex compress() (método bz2.BZ2Compressor)
@anchor{library/bz2 bz2 BZ2Compressor compress}@anchor{2b55}
@deffn {Método} compress (data)

Fornece dados para o objeto compressor. Retorna um pedaço de dados compactados, se possível, ou uma string de bytes vazia, caso contrário.

Quando você terminar de fornecer dados ao compactador, chame o método @ref{2b56,,flush()} para finalizar o processo de compressão.
@end deffn

@geindex flush() (método bz2.BZ2Compressor)
@anchor{library/bz2 bz2 BZ2Compressor flush}@anchor{2b56}
@deffn {Método} flush ()

Finaliza o processo de compactação. Retorna os dados compactados deixados em buffers internos.

O objeto compactador não pode ser usado após a chamada deste método.
@end deffn
@end deffn

@geindex BZ2Decompressor (classe em bz2)
@anchor{library/bz2 bz2 BZ2Decompressor}@anchor{1854}
@deffn {Classe} bz2.BZ2Decompressor

Cria um novo objeto descompactador. Este objeto pode ser usado para descompactar dados de forma incremental. Para compactação única, use a função @ref{10cd,,decompress()}.

@cartouche
@quotation Nota 
Esta classe não trata de forma transparente entradas contendo múltiplos fluxos compactados, ao contrário de @ref{10cd,,decompress()} e @ref{86a,,BZ2File}. Se você precisar descompactar uma entrada multifluxo com @ref{1854,,BZ2Decompressor}, você deve usar um novo descompactador para cada fluxo.
@end quotation
@end cartouche

@geindex decompress() (método bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor decompress}@anchor{df4}
@deffn {Método} decompress (data, max_length=-1)

Descomprime dados `data' (um @ref{d4f,,objeto bytes ou similar}), retornando dados não comprimidos como bytes. Alguns dos `data' podem ser armazenados em buffer internamente, para uso em chamadas posteriores para @ref{10cd,,decompress()}. Os dados retornados devem ser concatenados com a saída de qualquer chamada anterior para @ref{10cd,,decompress()}.

Se `max_length' for não negativo, retornará no máximo `max_length' bytes de dados descomprimidos. Se este limite for atingido e mais saída puder ser produzida, o atributo @ref{2b57,,needs_input} será definido como @code{False}. Neste caso, a próxima chamada para @ref{df4,,decompress()} pode fornecer `data' como @code{b'@w{'}} para obter mais saída.

Se todos os dados de entrada foram descomprimidos e retornados (seja porque era menor que `max_length' bytes, ou porque `max_length' era negativo), o atributo @ref{2b57,,needs_input} será definido como @code{True} .

A tentativa de descomprimir os dados após o final do fluxo ser atingido gera um @ref{131c,,EOFError}. Quaisquer dados encontrados após o final do fluxo são ignorados e salvos no atributo @ref{2b58,,unused_data}.


Alterado na versão 3.5: Adicionado o parâmetro `max_length'.

@end deffn

@geindex eof (atributo bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor eof}@anchor{2b59}
@deffn {Atributo} eof

@code{True} se o marcador de fim de fluxo foi atingido.


Adicionado na versão 3.3.

@end deffn

@geindex unused_data (atributo bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor unused_data}@anchor{2b58}
@deffn {Atributo} unused_data

Dados encontrados após o término do fluxo comprimido.

Se este atributo for acessado antes do final do fluxo ser alcançado, seu valor será @code{b'@w{'}}.
@end deffn

@geindex needs_input (atributo bz2.BZ2Decompressor)
@anchor{library/bz2 bz2 BZ2Decompressor needs_input}@anchor{2b57}
@deffn {Atributo} needs_input

@code{False} se o método @ref{df4,,decompress()} puder fornecer mais dados descomprimidos antes de exigir uma nova entrada não comprimida.


Adicionado na versão 3.5.

@end deffn
@end deffn

@node De compressão de uma só vez one-shot,Exemplos de uso<2>,Des compressão incremental,bz2 — Suporte para compressão bzip2
@anchor{library/bz2 one-shot-de-compression}@anchor{2b5a}
@subsubsection (De)compressão de uma só vez (one-shot)


@geindex compress() (no módulo bz2)
@anchor{library/bz2 bz2 compress}@anchor{25ad}
@deffn {Função} bz2.compress (data, compresslevel=9)

Compacta `data', um @ref{d4f,,objeto bytes ou similar}.

`compresslevel', se fornecido, deve ser um inteiro entre @code{1} e @code{9}. O padrão é @code{9}.

Para compressão incremental, use um @ref{1856,,BZ2Compressor}.
@end deffn

@geindex decompress() (no módulo bz2)
@anchor{library/bz2 bz2 decompress}@anchor{10cd}
@deffn {Função} bz2.decompress (data)

Descompacta `data', um @ref{d4f,,objeto bytes ou similar}.

Se `data' for a concatenação de vários fluxos compactados, descompacta todos os fluxos.

Para descompressão incremental, use um @ref{1854,,BZ2Decompressor}.


Alterado na versão 3.3: Suporte para entradas multifluxo foi adicionado.

@end deffn

@node Exemplos de uso<2>,,De compressão de uma só vez one-shot,bz2 — Suporte para compressão bzip2
@anchor{library/bz2 bz2-usage-examples}@anchor{2b5b}@anchor{library/bz2 examples-of-usage}@anchor{2b5c}
@subsubsection Exemplos de uso


Abaixo estão alguns exemplos de uso típico do módulo @ref{13,,bz2}.

Usando @ref{25ad,,compress()} e @ref{10cd,,decompress()} para demonstrar a compactação de ida e volta:

@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{1856,,BZ2Compressor} para compressão 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

O exemplo acima usa um fluxo de dados muito “não aleatório” (um fluxo de partes @code{b"z"}). Dados aleatórios tendem a compactar mal, enquanto dados ordenados e repetitivos geralmente produzem uma alta taxa de compactação.

Escrevendo e lendo um arquivo compactado com bzip2 no modo binário:

@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 — Compressão usando o algoritmo LZMA,zipfile — Trabalha com arquivos ZIP,bz2 — Suporte para compressão bzip2,Compressão de Dados e Arquivamento
@anchor{library/lzma doc}@anchor{2b5d}@anchor{library/lzma lzma-compression-using-the-lzma-algorithm}@anchor{2b5e}@anchor{library/lzma module-lzma}@anchor{8a}@anchor{library/lzma translation-repo}@anchor{2b5f}
@subsection @code{lzma} — Compressão usando o algoritmo LZMA


@geindex module; lzma


Adicionado na versão 3.3.


`Código-fonte:' Lib/lzma.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/lzma.py}


__________________________________________________________________


Este módulo fornece classes e funções de conveniência para comprimir e descomprimir dados usando o algoritmo de compressão LZMA. Também está incluída uma interface de arquivo que oferece suporte aos formatos de arquivo @code{.xz} e legado @code{.lzma} usados pelo utilitário @code{xz}, bem como fluxos brutos comprimidos.

A interface fornecida por este módulo é muito semelhante à do módulo @ref{13,,bz2}. Observe que @ref{1042,,LZMAFile} e @ref{86a,,bz2.BZ2File} `não' são seguro para thread, portanto, se você precisar usar uma única instância @ref{1042,,LZMAFile} de vários threads, é necessário protegê-la com uma trava.

@geindex LZMAError
@anchor{library/lzma lzma LZMAError}@anchor{2b60}
@deffn {Exceção} lzma.LZMAError

Essa exceção é levantada quando ocorre um erro durante a compressão ou descompressão ou durante a inicialização do estado compressor/descompressor.
@end deffn

@menu
* Lendo e escrevendo arquivos comprimidos:: 
* Comprimindo e descomprimindo dados na memória:: 
* Diversos: Diversos<3>. 
* Especificando cadeias de filtros personalizadas:: 
* Exemplos: Exemplos<8>. 

@end menu

@node Lendo e escrevendo arquivos comprimidos,Comprimindo e descomprimindo dados na memória,,lzma — Compressão usando o algoritmo LZMA
@anchor{library/lzma reading-and-writing-compressed-files}@anchor{2b61}
@subsubsection Lendo e escrevendo arquivos comprimidos


@geindex open() (no módulo lzma)
@anchor{library/lzma lzma open}@anchor{2b62}
@deffn {Função} lzma.open (filename, mode='rb', *, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)

Abre um arquivo comprimido com LZMA no modo binário ou texto, retornando um @ref{1203,,objeto arquivo}.

O argumento `filename' pode ser um nome de arquivo real (dado como um objeto @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2a0,,caminho ou similar}), neste caso o arquivo nomeado é aberto , ou pode ser um objeto arquivo existente para leitura ou escrita.

O argumento `mode' pode ser qualquer um de @code{"r"}, @code{"rb"}, @code{"w"}, @code{"wb"}, @code{"x"}, @code{"xb"}, @code{"a"} ou @code{"ab"} para modo binário, ou @code{"rt"}, @code{"wt"}, @code{"xt"} , ou @code{"at"} para o modo de texto. O padrão é @code{"rb"}.

Ao abrir um arquivo para leitura, os argumentos `format' e `filters' têm os mesmos significados que em @ref{1853,,LZMADecompressor}. Neste caso, os argumentos `check' e `preset' não devem ser usados.

Ao abrir um arquivo para escrita, os argumentos `format', `check', `preset' e `filters' têm os mesmos significados que em @ref{1855,,LZMACompressor}.

Para o modo binário, esta função é equivalente ao construtor @ref{1042,,LZMAFile}: @code{LZMAFile(filename, mode, ...)}. Nesse caso, os argumentos `encoding', `errors' e `newline' não devem ser fornecidos.

Para o modo texto, um objeto @ref{1042,,LZMAFile} é criado e encapsulado em uma instância @ref{7bc,,io.TextIOWrapper} com a codificação especificada, comportamento de tratamento de erros e final(is) de linha.


Alterado na versão 3.4: Adicionado suporte para os modos @code{"x"}, @code{"xb"} e @code{"xt"}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex LZMAFile (classe em lzma)
@anchor{library/lzma lzma LZMAFile}@anchor{1042}
@deffn {Classe} lzma.LZMAFile (filename=None, mode='r', *, format=None, check=-1, preset=None, filters=None)

Abre um arquivo comprimido com LZMA no modo binário.

Um @ref{1042,,LZMAFile} pode envolver um @ref{1203,,objeto arquivo} já aberto, ou operar diretamente em um arquivo nomeado. O argumento `filename' especifica o objeto arquivo a ser encapsulado ou o nome do arquivo a ser aberto (como um objeto @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2a0,,objeto caminho ou similar}). Ao agrupar um objeto arquivo existente, o arquivo agrupado não será fechado quando o @ref{1042,,LZMAFile} for fechado.

O argumento `mode' pode ser @code{"r"} para leitura (padrão), @code{"w"} para substituição, @code{"x"} para criação exclusiva ou @code{"a"} para anexar. Estes podem ser equivalentemente dados como @code{"rb"}, @code{"wb"}, @code{"xb"} e @code{"ab"} respectivamente.

Se `filename' for um objeto arquivo (em vez de um nome de arquivo real), um modo de @code{"w"} não truncará o arquivo e será equivalente a @code{"a"}.

Ao abrir um arquivo para leitura, o arquivo de entrada pode ser a concatenação de vários fluxos comprimidos separados. Estes são decodificados de forma transparente como um único fluxo lógico.

Ao abrir um arquivo para leitura, os argumentos `format' e `filters' têm os mesmos significados que em @ref{1853,,LZMADecompressor}. Neste caso, os argumentos `check' e `preset' não devem ser usados.

Ao abrir um arquivo para escrita, os argumentos `format', `check', `preset' e `filters' têm os mesmos significados que em @ref{1855,,LZMACompressor}.

@ref{1042,,LZMAFile} suporta todos os membros especificados por @ref{694,,io.BufferedIOBase}, exceto @ref{2b49,,detach()} e @ref{1355,,truncate()}. Iteração e a instrução @ref{5d2,,with} são suportadas.

O método e os atributos a seguir também são fornecidos:

@geindex peek() (método lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile peek}@anchor{2b63}
@deffn {Método} peek (size=-1)

Retorna dados armazenados em buffer sem avançar a posição do arquivo. Pelo menos um byte de dados será retornado, a menos que o EOF tenha sido atingido. O número exato de bytes retornados não é especificado (o argumento `size' é ignorado).

@cartouche
@quotation Nota 
Enquanto chamar @ref{2b63,,peek()} não altera a posição do arquivo de @ref{1042,,LZMAFile}, pode alterar a posição do objeto arquivo subjacente (por exemplo, se o @ref{1042,,LZMAFile} foi construído passando um objeto arquivo para `nome do arquivo').
@end quotation
@end cartouche
@end deffn

@geindex mode (atributo lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile mode}@anchor{2b64}
@deffn {Atributo} mode

@code{'rb'} para leitura e @code{'wb'} para escrita.


Adicionado na versão 3.13.

@end deffn

@geindex name (atributo lzma.LZMAFile)
@anchor{library/lzma lzma LZMAFile name}@anchor{2b65}
@deffn {Atributo} name

O nome do arquivo lzma. Equivalente ao atributo @ref{2b53,,name} do @ref{1203,,objeto arquivo} subjacente.


Adicionado na versão 3.13.

@end deffn


Alterado na versão 3.4: Adicionado suporte para os modos @code{"x"} e @code{"xb"}.



Alterado na versão 3.5: O método @ref{136d,,read()} agora aceita um argumento de @code{None}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@node Comprimindo e descomprimindo dados na memória,Diversos<3>,Lendo e escrevendo arquivos comprimidos,lzma — Compressão usando o algoritmo LZMA
@anchor{library/lzma compressing-and-decompressing-data-in-memory}@anchor{2b66}
@subsubsection Comprimindo e descomprimindo dados na memória


@geindex LZMACompressor (classe em lzma)
@anchor{library/lzma lzma LZMACompressor}@anchor{1855}
@deffn {Classe} lzma.LZMACompressor (format=FORMAT_XZ, check=-1, preset=None, filters=None)

Cria um objeto compressão, que pode ser usado para comprimir dados de forma incremental.

Para uma maneira mais conveniente de comprimir um único bloco de dados, consulte @ref{2b67,,compress()}.

O argumento `format' especifica qual formato de contêiner deve ser usado. Os valores possíveis são:


@itemize *

@item 

@table @asis

@item @code{FORMAT_XZ}: O formato de contêiner @code{.xz}.

Este é o formato padrão.
@end table

@item 

@table @asis

@item @code{FORMAT_ALONE}: O formato de contêiner legado @code{.lzma}.

Este formato é mais limitado que @code{.xz} – ele não oferece suporte a verificações de integridade ou filtros múltiplos.
@end table

@item 

@table @asis

@item @code{FORMAT_RAW}: Um fluxo de dados brutos, que não usa nenhum formato de contêiner.

Esse especificador de formato não oferece suporte a verificações de integridade e exige que você sempre especifique uma cadeia de filtros personalizada (para compressão e descompressão). Além disso, dados comprimidos dessa maneira não podem ser descomprimidos usando @code{FORMAT_AUTO} (veja @ref{1853,,LZMADecompressor}).
@end table
@end itemize

O argumento `check' especifica o tipo de verificação de integridade a ser incluída nos dados comprimidos. Essa verificação é usada ao descomprimir, para garantir que os dados não foram corrompidos. Os valores possíveis são:


@itemize *

@item 
@code{CHECK_NONE}: Sem verificação de integridade. Este é o padrão (e o único valor aceitável) para @code{FORMAT_ALONE} e @code{FORMAT_RAW}.

@item 
@code{CHECK_CRC32}: Verificação de redundância cíclica de 32 bits.

@item 
@code{CHECK_CRC64}: Verificação de redundância cíclica de 64 bits. Este é o padrão para @code{FORMAT_XZ}.

@item 
@code{CHECK_SHA256}: Algoritmo de hash seguro de 256 bits.
@end itemize

Se a verificação especificada não for suportada, uma exceção @ref{2b60,,LZMAError} será levantada.

As configurações de compressão podem ser especificadas como um nível de compressão predefinido (com o argumento `preset') ou em detalhes como uma cadeia de filtros personalizada (com o argumento `filters').

O argumento `preset' (se fornecido) deve ser um inteiro entre @code{0} e @code{9} (inclusive), opcionalmente com OR com a constante @code{PRESET_EXTREME}. Se nem `preset' nem `filters' forem fornecidos, o comportamento padrão é usar @code{PRESET_DEFAULT} (nível predefinido @code{6}). Predefinições mais altas produzem uma saída menor, mas tornam o processo de compressão mais lento.

@cartouche
@quotation Nota 
Além de consumir mais CPU, a compressão com predefinições mais altas também requer muito mais memória (e produz uma saída que precisa de mais memória para descompressão). Com a predefinição @code{9} por exemplo, a sobrecarga para um objeto @ref{1855,,LZMACompressor} pode chegar a 800 MiB. Por esse motivo, geralmente é melhor ficar com a predefinição padrão.
@end quotation
@end cartouche

O argumento `filters' (se fornecido) deve ser um especificador de cadeia de filtros. Veja @ref{2b68,,Especificando cadeias de filtros personalizadas} para detalhes.

@geindex compress() (método lzma.LZMACompressor)
@anchor{library/lzma lzma LZMACompressor compress}@anchor{2b69}
@deffn {Método} compress (data)

Comprime `data' (um objeto @ref{1c2,,bytes}), retornando um objeto @ref{1c2,,bytes} contendo dados comprimidos para pelo menos parte da entrada. Alguns dos `data' podem ser armazenados internamente, para uso em chamadas posteriores para @ref{2b67,,compress()} e @ref{2b6a,,flush()}. Os dados retornados devem ser concatenados com a saída de quaisquer chamadas anteriores para @ref{2b67,,compress()}.
@end deffn

@geindex flush() (método lzma.LZMACompressor)
@anchor{library/lzma lzma LZMACompressor flush}@anchor{2b6a}
@deffn {Método} flush ()

Conclui o processo de compressão, retornando um objeto @ref{1c2,,bytes} contendo todos os dados armazenados nos buffers internos do compressor.

O compressor não pode ser usado após a chamada deste método.
@end deffn
@end deffn

@geindex LZMADecompressor (classe em lzma)
@anchor{library/lzma lzma LZMADecompressor}@anchor{1853}
@deffn {Classe} lzma.LZMADecompressor (format=FORMAT_AUTO, memlimit=None, filters=None)

Cria um objeto descompressor, que pode ser usado para descomprimir dados de forma incremental.

Para uma maneira mais conveniente de descomprimir um fluxo comprimido inteiro de uma só vez, consulte @ref{2b6b,,decompress()}.

O argumento `format' especifica o formato do contêiner que deve ser usado. O padrão é @code{FORMAT_AUTO}, que pode descomprimir os arquivos @code{.xz} e @code{.lzma}. Outros valores possíveis são @code{FORMAT_XZ}, @code{FORMAT_ALONE} e @code{FORMAT_RAW}.

O argumento `memlimit' especifica um limite (em bytes) na quantidade de memória que o descompressor pode usar. Quando esse argumento é usado, a descompressão falhará com um @ref{2b60,,LZMAError} se não for possível descomprimir a entrada dentro do limite de memória fornecido.

O argumento `filters' especifica a cadeia de filtros que foi usada para criar o fluxo que está sendo descomprimido. Este argumento é necessário se `format' for @code{FORMAT_RAW}, mas não deve ser usado para outros formatos. Veja @ref{2b68,,Especificando cadeias de filtros personalizadas} para mais informações sobre cadeias de filtros.

@cartouche
@quotation Nota 
Esta classe não manipula de forma transparente entradas contendo múltiplos fluxos comprimidos, diferentemente de @ref{2b6b,,decompress()} e @ref{1042,,LZMAFile}. Para descomprimir uma entrada multi-fluxo com @ref{1853,,LZMADecompressor}, você deve criar um novo descompactador para cada fluxo.
@end quotation
@end cartouche

@geindex decompress() (método lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor decompress}@anchor{e5b}
@deffn {Método} decompress (data, max_length=-1)

Descomprime dados `data' (um @ref{d4f,,objeto bytes ou similar}), retornando dados não comprimidos como bytes. Alguns dos `data' podem ser armazenados em buffer internamente, para uso em chamadas posteriores para @ref{2b6b,,decompress()}. Os dados retornados devem ser concatenados com a saída de qualquer chamada anterior para @ref{2b6b,,decompress()}.

Se `max_length' for não negativo, retornará no máximo `max_length' bytes de dados descomprimidos. Se este limite for atingido e mais saída puder ser produzida, o atributo @ref{2b6c,,needs_input} será definido como @code{False}. Neste caso, a próxima chamada para @ref{e5b,,decompress()} pode fornecer `data' como @code{b'@w{'}} para obter mais saída.

Se todos os dados de entrada foram descomprimidos e retornados (seja porque era menor que `max_length' bytes, ou porque `max_length' era negativo), o atributo @ref{2b6c,,needs_input} será definido como @code{True} .

A tentativa de descomprimir os dados após o final do fluxo ser atingido gera um @ref{131c,,EOFError}. Quaisquer dados encontrados após o final do fluxo são ignorados e salvos no atributo @ref{2b6d,,unused_data}.


Alterado na versão 3.5: Adicionado o parâmetro `max_length'.

@end deffn

@geindex check (atributo lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor check}@anchor{2b6e}
@deffn {Atributo} check

O ID da verificação de integridade usada pelo fluxo de entrada. Pode ser @code{CHECK_UNKNOWN} até que o suficiente da entrada tenha sido decodificado para determinar qual verificação de integridade ela usa.
@end deffn

@geindex eof (atributo lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor eof}@anchor{2b6f}
@deffn {Atributo} eof

@code{True} se o marcador de fim de fluxo foi atingido.
@end deffn

@geindex unused_data (atributo lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor unused_data}@anchor{2b6d}
@deffn {Atributo} unused_data

Dados encontrados após o término do fluxo comprimido.

Antes do final do fluxo ser alcançado, isso será @code{b""}.
@end deffn

@geindex needs_input (atributo lzma.LZMADecompressor)
@anchor{library/lzma lzma LZMADecompressor needs_input}@anchor{2b6c}
@deffn {Atributo} needs_input

@code{False} se o método @ref{e5b,,decompress()} puder fornecer mais dados descomprimidos antes de exigir uma nova entrada não comprimida.


Adicionado na versão 3.5.

@end deffn
@end deffn

@geindex compress() (no módulo lzma)
@anchor{library/lzma lzma compress}@anchor{2b67}
@deffn {Função} lzma.compress (data, format=FORMAT_XZ, check=-1, preset=None, filters=None)

Comprime `data' (um objeto @ref{1c2,,bytes}), retornando os dados comprimidos como um objeto @ref{1c2,,bytes}.

Veja @ref{1855,,LZMACompressor} acima para uma descrição dos argumentos `format', `check', `preset' e `filters'.
@end deffn

@geindex decompress() (no módulo lzma)
@anchor{library/lzma lzma decompress}@anchor{2b6b}
@deffn {Função} lzma.decompress (data, format=FORMAT_AUTO, memlimit=None, filters=None)

Descomprime `data' (um objeto @ref{1c2,,bytes}), retornando os dados não comprimidos como um objeto @ref{1c2,,bytes}.

Se `data' forem a concatenação de vários fluxos comprimidos distintos, descomprime todos esses fluxos e retorna a concatenação dos resultados.

Veja @ref{1853,,LZMADecompressor} acima para uma descrição dos argumentos `format', `memlimit' e `filters'.
@end deffn

@node Diversos<3>,Especificando cadeias de filtros personalizadas,Comprimindo e descomprimindo dados na memória,lzma — Compressão usando o algoritmo LZMA
@anchor{library/lzma miscellaneous}@anchor{2b70}
@subsubsection Diversos


@geindex is_check_supported() (no módulo lzma)
@anchor{library/lzma lzma is_check_supported}@anchor{2b71}
@deffn {Função} lzma.is_check_supported (check)

Retorna @code{True} se a verificação de integridade fornecida for suportada neste sistema.

@code{CHECK_NONE} e @code{CHECK_CRC32} são sempre suportados. @code{CHECK_CRC64} e @code{CHECK_SHA256} podem não estar disponíveis se você estiver usando uma versão do @code{liblzma} que foi compilada com um conjunto de recursos limitado.
@end deffn

@node Especificando cadeias de filtros personalizadas,Exemplos<8>,Diversos<3>,lzma — Compressão usando o algoritmo LZMA
@anchor{library/lzma filter-chain-specs}@anchor{2b68}@anchor{library/lzma specifying-custom-filter-chains}@anchor{2b72}
@subsubsection Especificando cadeias de filtros personalizadas


Um especificador de cadeia de filtros é uma sequência de dicionários, onde cada dicionário contém o ID e as opções para um único filtro. Cada dicionário deve conter a chave @code{"id"} e pode conter chaves adicionais para especificar opções dependentes do filtro. Os IDs de filtro válidos são os seguintes:


@itemize *

@item 
Filtro Compression:


@itemize *

@item 
@code{FILTER_LZMA1} (para ser usado com @code{FORMAT_ALONE})

@item 
@code{FILTER_LZMA2} (para ser utilizado com @code{FORMAT_XZ} and @code{FORMAT_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

Uma cadeia de filtros pode consistir em até 4 filtros e não pode estar vazia. O último filtro na cadeia deve ser um filtro de compressão e quaisquer outros filtros devem ser filtros delta ou BCJ.

Os filtros de compressão suportam as seguintes opções (especificadas como entradas adicionais no dicionário que representa o filtro):


@itemize *

@item 
@code{preset}: Uma predefinição de compressão para usar como fonte de valores padrão para opções que não são especificadas explicitamente.

@item 
@code{dict_size}: Tamanho do dicionário em bytes. Deve estar entre 4 KiB e 1,5 GiB (inclusive).

@item 
@code{lc}: Número de bits de contexto literal.

@item 
@code{lp}: Número de bits de posição literal. A soma @code{lc + lp} deve ser no máximo 4.

@item 
@code{pb}: Número de bits de posição; deve ser no máximo 4.

@item 
@code{mode}: @code{MODE_FAST} ou @code{MODE_NORMAL}.

@item 
@code{nice_len}: O que deve ser considerado um “tamanho agradável” para uma correspondência. Deve ser 273 ou menos.

@item 
@code{mf}: Qual localizador de correspondências usar – @code{MF_HC3}, @code{MF_HC4}, @code{MF_BT2}, @code{MF_BT3} ou @code{MF_BT4}.

@item 
@code{depth}: Profundidade máxima de pesquisa usada pelo localizador de correspondências. 0 (padrão) significa selecionar automaticamente com base em outras opções de filtro.
@end itemize

O filtro delta armazena as diferenças entre bytes, produzindo uma entrada mais repetitiva para o compressor em certas circunstâncias. Ele suporta uma opção, @code{dist}. Isso indica a distância entre bytes a ser subtraída. O padrão é 1, ou seja, pega as diferenças entre bytes adjacentes.

Os filtros BCJ são destinados a serem aplicados ao código de máquina. Eles convertem ramificações relativas, chamadas e saltos no código para usar endereçamento absoluto, com o objetivo de aumentar a redundância que pode ser explorada pelo compressor. Esses filtros suportam uma opção, @code{start_offset}. Isso especifica o endereço que deve ser mapeado para o início dos dados de entrada. O padrão é 0.

@node Exemplos<8>,,Especificando cadeias de filtros personalizadas,lzma — Compressão usando o algoritmo LZMA
@anchor{library/lzma examples}@anchor{2b73}
@subsubsection Exemplos


Lendo em um arquivo comprimido:

@example
import lzma
with lzma.open("file.xz") as f:
    file_content = f.read()
@end example

Criando um arquivo comprimido:

@example
import lzma
data = b"Insira dados aqui"
with lzma.open("file.xz", "w") as f:
    f.write(data)
@end example

Comprimindo dados na memória:

@example
import lzma
data_in = b"Insert Data Here"
data_out = lzma.compress(data_in)
@end example

Compressão incremental:

@example
import lzma
lzc = lzma.LZMACompressor()
out1 = lzc.compress(b"Alguns dados\n")
out2 = lzc.compress(b"Outro pedaço de dados\n")
out3 = lzc.compress(b"Ainda mais dados\n")
out4 = lzc.flush()
# Concatena todos os resultados parciais:
result = b"".join([out1, out2, out3, out4])
@end example

Escrevendo dados comprimidos em um arquivo já aberto:

@example
import lzma
with open("file.xz", "wb") as f:
    f.write(b"Este dados serão comprimidos\n")
    with lzma.open(f, "w") as lzf:
        lzf.write(b"Isso *vai* ser comprimidos\n")
    f.write(b"Não comprimidos\n")
@end example

Criando um arquivo comprimido usando uma cadeia de filtros 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"blá blá blá")
@end example

@node zipfile — Trabalha com arquivos ZIP,tarfile — Ler e gravar arquivos do tipo tar,lzma — Compressão usando o algoritmo LZMA,Compressão de Dados e Arquivamento
@anchor{library/zipfile doc}@anchor{2b74}@anchor{library/zipfile module-zipfile}@anchor{131}@anchor{library/zipfile translation-repo}@anchor{2b75}@anchor{library/zipfile zipfile-work-with-zip-archives}@anchor{2b76}
@subsection @code{zipfile} — Trabalha com arquivos ZIP


@geindex module; zipfile

`Código-fonte:' Lib/zipfile/@footnote{https://github.com/python/cpython/tree/3.13/Lib/zipfile/}


__________________________________________________________________


O formato de arquivo ZIP é um padrão de compactação e arquivamento. Este módulo fornece ferramentas para criar, ler, escrever, adicionar, e listar um arquivo ZIP. Qualquer uso avançado deste módulo vai exigir um entendimento do formato, como definido nas Notas de Aplicação do PKZIP@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}.

Esse módulo não trata arquivos ZIP multiparte. Ele pode manipular arquivos ZIP que usam as extensões ZIP64 (ou seja arquivos ZIP com tamanho maior do que 4 Gb). Ele suporta descriptografia de arquivos criptografados dentro do ZIP, mas atualmente não pode criar um arquivo criptografado. A descriptografia é extremamente lenta pois é implementada em Python nativo ao invés de C.

Este módulo define os seguintes itens:

@geindex BadZipFile
@anchor{library/zipfile zipfile BadZipFile}@anchor{18f3}
@deffn {Exceção} zipfile.BadZipFile

Este erro é levantado para arquivos ZIP corrompidos.


Adicionado na versão 3.2.

@end deffn

@geindex BadZipfile
@anchor{library/zipfile zipfile BadZipfile}@anchor{2b77}
@deffn {Exceção} zipfile.BadZipfile

Alias para @ref{18f3,,BadZipFile}, para compatibilidade com versões mais antigas de Python.


Descontinuado desde a versão 3.2.

@end deffn

@geindex LargeZipFile
@anchor{library/zipfile zipfile LargeZipFile}@anchor{2b78}
@deffn {Exceção} zipfile.LargeZipFile

Este erro é levantado quando um arquivo ZIP precisa da funcionalidade ZIP64 que não está habilitada.
@end deffn


@deffn {Classe} zipfile.ZipFile

A classe para ler e escrever arquivos ZIP. Veja a seção @ref{2b79,,Objetos ZipFile} para detalhes do construtor.
@end deffn


@deffn {Classe} zipfile.Path

Classe que implementa um subconjunto da interface fornecida por @ref{229,,pathlib.Path}, incluindo a interface completa @ref{1f3,,importlib.resources.abc.Traversable}.


Adicionado na versão 3.8.

@end deffn


@deffn {Classe} zipfile.PyZipFile

Classe para criar arquivos ZIP contendo bibliotecas Python.
@end deffn

@geindex ZipInfo (classe em zipfile)
@anchor{library/zipfile zipfile ZipInfo}@anchor{d2c}
@deffn {Classe} zipfile.ZipInfo (filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))

Classe usada para representar informação sobre um membro de um archive. Instâncias desta classe são retornadas pelos métodos @ref{2b7a,,getinfo()} e @ref{2b7b,,infolist()} de objetos da classe @ref{6c4,,ZipFile}. A maioria dos usuários do módulo @ref{131,,zipfile} não vai precisar criar, mas apenas usar objetos criados pelo módulo. `filename' deveria ser o caminho completo do membro do arquivo, e `date_time' deveria ser uma tupla contendo seis campos que descrevem o momento da última modificação no arquivo; os campos são descritos na seção @ref{2b7c,,Objetos ZipInfo}.


Alterado na versão 3.13: Um atributo público @code{compress_level} foi adicionado para expor o @code{_compresslevel} anteriormente protegido. O nome protegido mais antigo continua a funcionar como uma propriedade para compatibilidade com versões anteriores.

@end deffn

@geindex is_zipfile() (no módulo zipfile)
@anchor{library/zipfile zipfile is_zipfile}@anchor{136e}
@deffn {Função} zipfile.is_zipfile (filename)

Retorna @code{True} se `filename' é um arquivo ZIP válido baseado no seu “magic number”, caso contrário retorna @code{False}. `filename' pode ser um arquivo ou um objeto arquivo ou similar também.


Alterado na versão 3.1: Suporte para arquivo e objetos arquivo ou similares.

@end deffn

@geindex ZIP_STORED (no módulo zipfile)
@anchor{library/zipfile zipfile ZIP_STORED}@anchor{2b7d}
@deffn {Dado} zipfile.ZIP_STORED

Código numérico para um membro de um arquivo descompactado
@end deffn

@geindex ZIP_DEFLATED (no módulo zipfile)
@anchor{library/zipfile zipfile ZIP_DEFLATED}@anchor{2b7e}
@deffn {Dado} zipfile.ZIP_DEFLATED

Código numérico para o método de compactação usual. Requer o módulo @ref{133,,zlib} .
@end deffn

@geindex ZIP_BZIP2 (no módulo zipfile)
@anchor{library/zipfile zipfile ZIP_BZIP2}@anchor{2b7f}
@deffn {Dado} zipfile.ZIP_BZIP2

Código numérico para o método de compactação BZIP2. Requer o módulo @ref{13,,bz2}.


Adicionado na versão 3.3.

@end deffn

@geindex ZIP_LZMA (no módulo zipfile)
@anchor{library/zipfile zipfile ZIP_LZMA}@anchor{2b80}
@deffn {Dado} zipfile.ZIP_LZMA

Código numérico para o método de compactação LZMA. Requer o módulo @ref{8a,,lzma}.


Adicionado na versão 3.3.


@cartouche
@quotation Nota 
A especificação do formato ZIP incluiu suporte para compactação bzip2 desde 2001, e para compactação LZMA desde 2006. Porém, algumas ferramentas (incluindo versões mais antigas de Python) não suportam esses métodos de compactação, e podem recusar processar o arquivo ZIP como um todo, ou falhar em extrair arquivos individuais.
@end quotation
@end cartouche
@end deffn


@subsubheading Ver também



@table @asis

@item Notas da Aplicação do PKZIP@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

Documentação do formato de arquivo ZIP feita por Phil Katz, criador do formato e dos algoritmos usados.

@item Site do Info-ZIP@footnote{https://infozip.sourceforge.net/}

Informações sobre o programas de arquivamento e desenvolvimento de bibliotecas do projeto Info-ZIP.
@end table


@menu
* Objetos ZipFile:: 
* Objetos Path:: 
* Objetos PyZipFile:: 
* Objetos ZipInfo:: 
* Interface de linha de comando: Interface de linha de comando<3>. 
* Armadilhas de descompressão:: 

@end menu

@node Objetos ZipFile,Objetos Path,,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile id1}@anchor{2b81}@anchor{library/zipfile zipfile-objects}@anchor{2b79}
@subsubsection Objetos ZipFile


@geindex ZipFile (classe em zipfile)
@anchor{library/zipfile zipfile ZipFile}@anchor{6c4}
@deffn {Classe} zipfile.ZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True, metadata_encoding=None)

Abre um arquivo ZIP, onde `file' pode ser um caminho para um arquivo (uma string), um objeto arquivo ou similar, ou um @ref{2a0,,objeto caminho ou similar}.

O parâmetro `mode' deve ser @code{'r'} para ler um arquivo existente, @code{'w'} para truncar e gravar um novo arquivo, @code{'a'} para adicionar a um arquivo existente, ou @code{'x'} exclusivamente para criar e gravar um novo arquivo. Se o `mode' é @code{'x'} e `file' se refere a um arquivo existente, um @ref{1056,,FileExistsError} vai ser levantado. Se o `mode' é @code{'a'} e `file' se refere a um arquivo ZIP existente, então arquivos adicionais são adicionados ao mesmo. Se `file' não se refere a um arquivo ZIP, então um novo arquivo ZIP é adicionado ao arquivo. Isso diz respeito a adicionar um arquivo ZIP a um outro arquivo (como por exemplo @code{python.exe}). Se o `mode' é @code{'a'} e o arquivo não existe, ele será criado. Se o `mode' é @code{'r'} ou @code{'a'}, o arquivo deve ser percorrível.

`compression' é o método de compactação ZIP para usar ao escrever o arquivo, e deve ser @ref{2b7d,,ZIP_STORED}, @ref{2b7e,,ZIP_DEFLATED}, @ref{2b7f,,ZIP_BZIP2} ou @ref{2b80,,ZIP_LZMA}; valores desconhecidos devem causar o levantamento de @ref{228,,NotImplementedError}. Se @ref{2b7e,,ZIP_DEFLATED}, @ref{2b7f,,ZIP_BZIP2} ou @ref{2b80,,ZIP_LZMA} for especificado mas o módulo correspondente (@ref{133,,zlib}, @ref{13,,bz2} ou @ref{8a,,lzma}) não estiver disponível, é levado um @ref{195,,RuntimeError}. O valor padrão é @ref{2b7d,,ZIP_STORED}.

Se `allowZip64' é @code{True} (valor padrão), então zipfile vai criar arquivos ZIP que usem as extensões ZIP64 quando o arquivo ZIP é maior do que 4 GiB. Se é @code{false}, @ref{131,,zipfile} levanta uma exceção quando o arquivo ZIP precisaria das extensões ZIP64.

O parâmetro `compresslevel' controla o nível de compactação para usar ao gravar no arquivo ZIP. Quando usado @ref{2b7d,,ZIP_STORED} ou @ref{2b80,,ZIP_LZMA} não tem efeito. Quando usado @ref{2b7e,,ZIP_DEFLATED} inteiros de @code{0} a @code{9} são aceitos (veja @ref{2b16,,zlib} para mais informações). Quando usado @ref{2b7f,,ZIP_BZIP2} inteiros de @code{1} a @code{9} são aceitos (veja @ref{86a,,bz2} para mais informações).

O argumento `strict_timestamps', quando definido como @code{False}, permite compactar arquivos anteriores a 1980-01-01 com o custo de definir o carimbo de data/hora para 1980-01-01. Comportamento semelhante ocorre com arquivos mais recentes que 2107-12-31, o carimbo de data/hora também é definido como o limite.

Quando o modo é @code{'r'}, `metadata_encoding' pode ser definido como o nome de um codec, que será usado para decodificar metadados, como os nomes dos membros e comentários ZIP.

Se o arquivo é criado com modo @code{'w'}, @code{'x'} ou @code{'a'} e então @code{closed()} sem adicionar nada ao arquivo, a estrutura própria para um arquivo vazio será escrita no arquivo.

ZipFile também é um gerenciador de contexto e portanto suporta a instrução @ref{5d2,,with}. Neste exemplo, `myzip' é fechado ao final da execução da instrução @code{with} – mesmo que ocorra uma exceção:

@example
with ZipFile('spam.zip', 'w') as myzip:
    myzip.write('eggs.txt')
@end example

@cartouche
@quotation Nota 
`metadata_encoding' é uma configuração em toda a instância para o ZipFile. Não é possível definir isso em uma base por membro.

Este atributo é uma solução alternativa para implementações legadas que produzem arquivos com nomes na codificação da localidade atual ou página de código (principalmente no Windows). De acordo com o padrão .ZIP, a codificação dos metadados pode ser especificada como página de código IBM (padrão) ou UTF-8 por meio de um sinalizador no cabeçalho do arquivo. Esse sinalizador tem precedência sobre `metadata_encoding', que é uma extensão específica do Python.
@end quotation
@end cartouche


Alterado na versão 3.2: Adicionado o uso de @ref{6c4,,ZipFile} como um gerenciador de contexto.



Alterado na versão 3.3: Adicionado suporte para compactação @ref{13,,bzip2} e @ref{8a,,lzma}.



Alterado na versão 3.4: Extensões ZIP64 são habilitadas por padrão.



Alterado na versão 3.5: Adicionado suporte para escrever em streams não percorríveis. Adicionado suporte ao modo @code{'x'}.



Alterado na versão 3.6: Anteriormente, um simples @ref{195,,RuntimeError} era levantado para valores de compactação desconhecidos.



Alterado na versão 3.6.2: O parâmetro `file' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: Adicionado o parâmetro `compresslevel'.



Alterado na versão 3.8: O parâmetro somente-nomeado `strict_timestamps'.



Alterado na versão 3.11: Adicionado suporte para especificar a codificação do nome do membro ao ler metadados no diretório e cabeçalhos de arquivo do arquivo zip.

@end deffn

@geindex close() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile close}@anchor{2b82}
@deffn {Método} ZipFile.close ()

Fecha o arquivo. Você deve chamar @ref{2b82,,close()} antes de sair do seu programa ou registros essenciais não serão gravados.
@end deffn

@geindex getinfo() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile getinfo}@anchor{2b7a}
@deffn {Método} ZipFile.getinfo (name)

Retorna um objeto @ref{d2c,,ZipInfo} com informações sobre o `name' do membro do arquivo. Chamar @ref{2b7a,,getinfo()} para um nome não encontrado no arquivo levanta um @ref{344,,KeyError}.
@end deffn

@geindex infolist() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile infolist}@anchor{2b7b}
@deffn {Método} ZipFile.infolist ()

Retorna uma lista contendo um objeto @ref{d2c,,ZipInfo} para cada membro do arquivo. Os objetos estão na mesma ordem das entradas no arquivo ZIP em disco se um arquivo existente foi aberto.
@end deffn

@geindex namelist() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile namelist}@anchor{2b83}
@deffn {Método} ZipFile.namelist ()

Retorna uma lista de membros do arquivo por nome.
@end deffn

@geindex open() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile open}@anchor{41b}
@deffn {Método} ZipFile.open (name, mode='r', pwd=None, *, force_zip64=False)

Acessa um membro do arquivo como um objeto binário arquivo ou similar. `name' pode ser o nome de um arquivo membro ou um objeto @ref{d2c,,ZipInfo}. O parâmetro `mode', se informado, deve ser @code{'r'} (valor padrão) or @code{'w'}. `pwd' é a senha usada para descriptografar arquivos ZIP criptografados como um objeto @ref{1c2,,bytes}.

@ref{41b,,open()} também é um gerenciador de contexto e, portanto, suporta a instrução @ref{5d2,,with}:

@example
with ZipFile('spam.zip') as myzip:
    with myzip.open('eggs.txt') as myfile:
        print(myfile.read())
@end example

Com `mode' @code{'r'} o objeto arquivo ou similar (@code{ZipExtFile}) é somente leitura e fornece os seguintes métodos: @ref{136d,,read()}, @ref{241f,,readline()}, @ref{24c7,,readlines()}, @ref{12ce,,seek()}, @ref{13f3,,tell()}, @ref{1e4a,,__iter__()}, @ref{1310,,__next__()}. Esses objetos podem operar independentemente do ZipFile.

Com @code{mode='w'}, é retornado um manipulador de arquivo, que suporta o método @ref{cfc,,write()}. Quando um manipulador de arquivo modificável é aberto, tentativas de ler ou gravar outros arquivos no arquivo ZIP levanta um @ref{202,,ValueError}.

Em ambos os casos o objeto arquivo ou similar também possui atributos @code{name}, que é equivalente ao nome de um arquivo dentro do arquivo, e @code{mode}, que é @code{'rb'} ou @code{'wb'} dependendo do modo de entrada.

Ao gravar um arquivo, se o tamanho do arquivo não é conhecido mas pode exceder 2 GiB, passe @code{force_zip64=True} para assegurar que o formato do header é capaz de suportar arquivos grandes. Se o tamanho do arquivo é conhecido, construa um objeto @ref{d2c,,ZipInfo} com @ref{2b84,,file_size} informado, então use-o como parâmetro `name'.

@cartouche
@quotation Nota 
Os métodos @ref{41b,,open()}, @ref{2b85,,read()} e @ref{2b86,,extract()} podem receber um nome de arquivo ou um objeto @ref{d2c,,ZipInfo}. Você vai gostar disso quando tentar ler um arquivo ZIP que contém membros com nomes duplicados.
@end quotation
@end cartouche


Alterado na versão 3.6: Removido suporte ao @code{mode='U'}. Uso de @ref{7bc,,io.TextIOWrapper} para leitura de arquivos texto compactados em modo de @ref{d5c,,novas linhas universais}.



Alterado na versão 3.6: @ref{41b,,ZipFile.open()} agora pode ser usado para escrever arquivos no aquivo compactado com a opção @code{mode='w'}.



Alterado na versão 3.6: Chama @ref{41b,,open()} em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.



Alterado na versão 3.13: Adicionados atributos @code{name} e @code{mode} para o objeto arquivo ou similar gravável. O valor do atributo @code{mode} para o objeto arquivo ou similar legível foi alterado de @code{'r'} para @code{'rb'}.

@end deffn

@geindex extract() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile extract}@anchor{2b86}
@deffn {Método} ZipFile.extract (member, path=None, pwd=None)

Extrai um membro do arquivo para o diretório atual; `member' deve ser o nome completo ou um objeto @ref{d2c,,ZipInfo}. A informação do arquivo é extraída com maior precisão possível. `path' especifica um outro diretório em que deve ser gravado. `member' pode ser um nome de arquivo ou um objeto @ref{d2c,,ZipInfo}. `pwd' é a senha usada para criptografar arquivos como um objeto @ref{1c2,,bytes}.

Retorna o caminho normalizado criado (um diretório ou novo arquivo).

@cartouche
@quotation Nota 
Se um nome de arquivo membro é um caminho absoluto, o drive/UNC e (contra)barras no início serão removidos, por exemplo: @code{///foo/bar} se torna @code{foo/bar} no Unix, e @code{C:\foo\bar} vira @code{foo\bar} no Windows. E todos os componentes @code{".."} no nome de um arquivo membro serão removidos, por exemplo: @code{../../foo../../ba..r} vira @code{foo../ba..r}. No Windows caracteres ilegais (@code{:}, @code{<}, @code{>}, @code{|}, @code{"}, @code{?}, and @code{*}) são substituídos por underscore (@code{_}).
@end quotation
@end cartouche


Alterado na versão 3.6: Chama @ref{2b86,,extract()} em um ZipFile fechado levanto um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.



Alterado na versão 3.6.2: O parâmetro `path' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex extractall() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile extractall}@anchor{2b87}
@deffn {Método} ZipFile.extractall (path=None, members=None, pwd=None)

Extrai todos os membros de um arquivo para o diretório atual. `path' especifica um diretório diferente para gravar os arquivos extraídos. `members' é opcional e deve ser um sub-conjunto da lista retornada por @ref{2b83,,namelist()}. `pwd' é uma senha usada para criptografar arquivos como um objeto @ref{1c2,,bytes}.

@cartouche
@quotation Aviso 
Nunca extrai arquivos de fontes não confiáveis sem inspeção prévia. É possível que os arquivos sejam criados fora do `path', por exemplo membros que tem nomes absolutos de arquivos começando com @code{"/"} ou nomes com dois pontos @code{".."}. Este módulo tenta prevenir isto. Veja nota em @ref{2b86,,extract()}.
@end quotation
@end cartouche


Alterado na versão 3.6: Chama @ref{2b87,,extractall()} em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.



Alterado na versão 3.6.2: O parâmetro `path' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex printdir() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile printdir}@anchor{2b88}
@deffn {Método} ZipFile.printdir ()

Imprime a tabela de conteúdos de um arquivo para @code{sys.stdout}.
@end deffn

@geindex setpassword() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile setpassword}@anchor{2b89}
@deffn {Método} ZipFile.setpassword (pwd)

Define `pwd' (um objeto @ref{1c2,,bytes}) como senha padrão para extrair arquivos criptografados.
@end deffn

@geindex read() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile read}@anchor{2b85}
@deffn {Método} ZipFile.read (name, pwd=None)

Retorna os bytes do arquivo `name' no arquivo compactado. `name' é o nome do arquivo no arquivo compactado, ou um objeto @ref{d2c,,ZipInfo}. O arquivo compactado deve estar aberto para leitura ou acréscimo. `pwd' é a senha usada para arquivos criptografados como um objeto @ref{1c2,,bytes} e, se especificada, vai sobrepor a senha padrão configurada com @ref{2b89,,setpassword()}. Chamar @ref{2b85,,read()} em um ZipFile que use um método de compactação diferente de @ref{2b7d,,ZIP_STORED}, @ref{2b7e,,ZIP_DEFLATED}, @ref{2b7f,,ZIP_BZIP2} ou @ref{2b80,,ZIP_LZMA} levanta um @ref{228,,NotImplementedError}. Um erro também é levantado se o módulo de compactação correspondente não está disponível.


Alterado na versão 3.6: Chama @ref{2b85,,read()} em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.

@end deffn

@geindex testzip() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile testzip}@anchor{2b8a}
@deffn {Método} ZipFile.testzip ()

Lê todos os arquivos no arquivo compactado e verifica seus CRC’s e cabeçalhos de arquivo. Retorna o nome do primeiro arquivo corrompido, or então retorna @code{None}.


Alterado na versão 3.6: Chama @ref{2b8a,,testzip()} em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.

@end deffn

@geindex write() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile write}@anchor{d70}
@deffn {Método} ZipFile.write (filename, arcname=None, compress_type=None, compresslevel=None)

Grava o arquivo chamado `filename' no arquivo compactado, dando ao arquivo compactado o nome `arcname' (por padrão, este é o mesmo de `filename', mas sem a letra do drive e com separadores removidos do início do nome). Se informado, `compress_type' sobrescreve o valor dado ao parâmetro `compression' do construtor para a nova entrada. Da mesma forma, `compresslevel' vai sobrescrever o construtor se informado. O arquivo compactado deve ser aberto em modo @code{'w'}, @code{'x'} ou @code{'a'}.

@cartouche
@quotation Nota 
O padrão de arquivo ZIP historicamente não especificava uma codificação de metadados, mas recomendava fortemente o CP437 (a codificação original do PC da IBM) para interoperabilidade. Versões recentes permitem o uso de (somente) UTF-8. Neste módulo, o UTF-8 será automaticamente usado para escrever os nomes dos membros se eles contiverem caracteres não ASCII. Não é possível escrever nomes de membros em qualquer codificação que não seja ASCII ou UTF-8.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Nomes de arquivo compactado devem ser relativos a raiz do mesmo, isto é, não devem começar com um separador de caminho.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se @code{arcname} (ou @code{filename}, se @code{arcname} não for informado) contém um byte nulo, o nome do arquivo no arquivo compactado será truncado no byte nulo.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Uma barra inicial no nome do arquivo pode fazer com que o arquivo seja impossível de abrir em alguns programas zip em sistemas Windows.
@end quotation
@end cartouche


Alterado na versão 3.6: Chama @ref{d70,,write()} em um ZipFile criado com modo @code{'r'} ou em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado

@end deffn

@geindex writestr() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile writestr}@anchor{136f}
@deffn {Método} ZipFile.writestr (zinfo_or_arcname, data, compress_type=None, compresslevel=None)

Grava um arquivo no arquivo compactado. O conteúdo é `data', que pode ser uma instância de @ref{44c,,str} ou de @ref{1c2,,bytes}; Se é uma @ref{44c,,str}, ela é encodada como UTF-8 primeiro. `zinfo_or_arcname' é o nome que será dado ao arquivo no arquivo compactado, ou uma instância de @ref{d2c,,ZipInfo}. Se é uma instância, pelo menos o nome do arquivo, a data, e a hora devem ser informados. Se é um nome, a data e hora recebem a data e hora atual. O arquivo compactado deve ser aberto em modo @code{'w'}, @code{'x'} ou @code{'a'}.

Se informado, `compress_type' sobrescreve o valor do parâmetro `compression' do construtor para a nova entrada, ou no `zinfo_or_arcname' (se é uma instância de @ref{d2c,,ZipInfo}). Da mesma forma, `compresslevel' vai sobrescrever o construtor se informado.

@cartouche
@quotation Nota 
Quando é passada uma instância de @ref{d2c,,ZipInfo} ou o parâmetro `zinfo_or_arcname', o método de compactação usado será aquele especificado no `compress_type' da instância de @ref{d2c,,ZipInfo}. Por padrão, o construtor da classe @ref{d2c,,ZipInfo} seta este membro para @ref{2b7d,,ZIP_STORED}.
@end quotation
@end cartouche


Alterado na versão 3.2: O argumento `compress_type'.



Alterado na versão 3.6: Chama @ref{136f,,writestr()} em um ZipFile criado com modo @code{'r'} ou em um ZipFile fechado levanta um @ref{202,,ValueError}. Anteriormente, um @ref{195,,RuntimeError} era levantado.

@end deffn

@geindex mkdir() (método zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile mkdir}@anchor{6c5}
@deffn {Método} ZipFile.mkdir (zinfo_or_directory, mode=511)

Cria um diretório dentro do arquivo. Se `zinfo_or_directory' for uma string, um diretório é criado dentro do arquivo com o modo especificado no argumento `mode'. No entanto, se `zinfo_or_directory' for uma instância @ref{d2c,,ZipInfo}, o argumento `mode' é ignorado.

O arquivo deve ser aberto com o modo @code{'w'}, @code{'x'} ou @code{'a'}.


Adicionado na versão 3.11.

@end deffn

Os seguintes atributos de dados também estão disponíveis:

@geindex filename (atributo zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile filename}@anchor{2b8b}
@deffn {Atributo} ZipFile.filename

Nome do arquivo ZIP.
@end deffn

@geindex debug (atributo zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile debug}@anchor{2b8c}
@deffn {Atributo} ZipFile.debug

O nível de saída de debug para usar. Pode ser setado de @code{0} (valor padrão, sem nenhuma saída) a @code{3} (com mais saída). A informação de debug é escrita em @code{sys.stdout}.
@end deffn

@geindex comment (atributo zipfile.ZipFile)
@anchor{library/zipfile zipfile ZipFile comment}@anchor{2b8d}
@deffn {Atributo} ZipFile.comment

O comentário associado ao arquivo ZIP como um objeto @ref{1c2,,bytes}. Se atribuir um comentário a uma instância @ref{6c4,,ZipFile} criada com o modo @code{'w'}, @code{'x'} ou @code{'a'}, não deve ser maior que 65535 bytes. Comentários mais longos do que isso serão truncados.
@end deffn

@node Objetos Path,Objetos PyZipFile,Objetos ZipFile,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile id2}@anchor{2b8e}@anchor{library/zipfile path-objects}@anchor{2b8f}
@subsubsection Objetos Path


@geindex Path (classe em zipfile)
@anchor{library/zipfile zipfile Path}@anchor{6c9}
@deffn {Classe} zipfile.Path (root, at='@w{'})

Construir um objeto Path a partir de um arquivo zip @code{root} (que pode ser uma instância @ref{6c4,,ZipFile} ou @code{file} adequado para passar para o construtor @ref{6c4,,ZipFile}).

@code{at} especifica a localização deste caminho dentro do arquivo zip, por exemplo, “dir/arquivo.txt”, “dir/” ou “”. O padrão é a string vazia, indicando a raiz.

@cartouche
@quotation Nota 
A classe @ref{6c9,,Path} não sanitiza nomes de arquivos dentro do arquivo ZIP. Ao contrário dos métodos @ref{2b86,,ZipFile.extract()} e @ref{2b87,,ZipFile.extractall()}, é responsabilidade do chamador validar ou sanitizar nomes de arquivos para evitar vulnerabilidades de travessia de caminho (por exemplo, nomes de arquivos contendo “..” ou caminhos absolutos). Ao lidar com arquivos não confiáveis, considere resolver nomes de arquivos usando @ref{135f,,os.path.abspath()} e verificar o diretório de destino com @ref{e6a,,os.path.commonpath()}.
@end quotation
@end cartouche
@end deffn

Objetos Path expõem os seguintes recursos de objetos @ref{229,,pathlib.Path}:

Objetos Path podem ser percorridos usando o operador @code{/} ou @code{joinpath}.

@geindex name (atributo zipfile.Path)
@anchor{library/zipfile zipfile Path name}@anchor{2b90}
@deffn {Atributo} Path.name

O componente final do caminho.
@end deffn

@geindex open() (método zipfile.Path)
@anchor{library/zipfile zipfile Path open}@anchor{1680}
@deffn {Método} Path.open (mode='r', *, pwd, **)

Invoca @ref{41b,,ZipFile.open()} no caminho atual. Permite a abertura para leitura ou escrita, texto ou binário através dos modos suportados: “r”, “w”, “rb”, “wb”. Argumentos posicionais e argumentos nomeados são passados para @ref{7bc,,io.TextIOWrapper} quando abertos como texto e ignorados caso contrário. @code{pwd} é o parâmetro @code{pwd} para @ref{41b,,ZipFile.open()}.


Alterado na versão 3.9: Adicionado suporte para modos de texto e binários para aberto. O modo padrão agora é texto.



Alterado na versão 3.11.2: O parâmetro @code{encoding} pode ser fornecido como um argumento posicional sem causar um @ref{2c3,,TypeError}. Como poderia em 3.9. O código que precisa ser compatível com as versões 3.10 e 3.11 não corrigidas deve passar todos os argumentos de @ref{7bc,,io.TextIOWrapper}, incluindo @code{encoding}, como palavras reservadas.

@end deffn

@geindex iterdir() (método zipfile.Path)
@anchor{library/zipfile zipfile Path iterdir}@anchor{2b91}
@deffn {Método} Path.iterdir ()

Enumera os filhos do diretório atual.
@end deffn

@geindex is_dir() (método zipfile.Path)
@anchor{library/zipfile zipfile Path is_dir}@anchor{2b92}
@deffn {Método} Path.is_dir ()

Retorna @code{True} se o contexto atual fizer referência a um diretório.
@end deffn

@geindex is_file() (método zipfile.Path)
@anchor{library/zipfile zipfile Path is_file}@anchor{2b93}
@deffn {Método} Path.is_file ()

Retorna @code{True} se o contexto atual fizer referência a um arquivo.
@end deffn

@geindex is_symlink() (método zipfile.Path)
@anchor{library/zipfile zipfile Path is_symlink}@anchor{2b94}
@deffn {Método} Path.is_symlink ()

Retorna @code{True} se o contexto atual fizer referência a um link simbólico.


Adicionado na versão 3.12.



Alterado na versão 3.13: Anteriormente, @code{is_symlink} retornava @code{False} incondicionalmente.

@end deffn

@geindex exists() (método zipfile.Path)
@anchor{library/zipfile zipfile Path exists}@anchor{2b95}
@deffn {Método} Path.exists ()

Retorna @code{True} se o contexto atual fizer referência a um arquivo ou diretório no arquivo zip.
@end deffn

@geindex Path.suffix (no módulo zipfile)
@anchor{library/zipfile zipfile Path suffix}@anchor{6c7}
@deffn {Dado} Path.suffix

A última parte separada por pontos do componente final, se houver. Isso é comumente chamado de extensão de arquivo.


Adicionado na versão 3.11: Adicionada a propriedade @ref{6c7,,Path.suffix}.

@end deffn

@geindex Path.stem (no módulo zipfile)
@anchor{library/zipfile zipfile Path stem}@anchor{6c6}
@deffn {Dado} Path.stem

O componente final do caminho, sem seu sufixo.


Adicionado na versão 3.11: Adicionada a propriedade @ref{6c6,,Path.stem}.

@end deffn

@geindex Path.suffixes (no módulo zipfile)
@anchor{library/zipfile zipfile Path suffixes}@anchor{6c8}
@deffn {Dado} Path.suffixes

Uma lista dos sufixos do caminho, comumente chamados de extensões de arquivo.


Adicionado na versão 3.11: Adicionada a propriedade @ref{6c8,,Path.suffixes}.

@end deffn

@geindex read_text() (método zipfile.Path)
@anchor{library/zipfile zipfile Path read_text}@anchor{1866}
@deffn {Método} Path.read_text (*, **)

Leia o arquivo atual como texto Unicode. Argumentos posicionais e argumentos nomeados são passados para @ref{7bc,,io.TextIOWrapper} (exceto @code{buffer}, que está implícito no contexto).


Alterado na versão 3.11.2: O parâmetro @code{encoding} pode ser fornecido como um argumento posicional sem causar um @ref{2c3,,TypeError}. Como poderia em 3.9. O código que precisa ser compatível com as versões 3.10 e 3.11 não corrigidas deve passar todos os argumentos de @ref{7bc,,io.TextIOWrapper}, incluindo @code{encoding}, como palavras reservadas.

@end deffn

@geindex read_bytes() (método zipfile.Path)
@anchor{library/zipfile zipfile Path read_bytes}@anchor{2b96}
@deffn {Método} Path.read_bytes ()

Lê o arquivo atual como bytes.
@end deffn

@geindex joinpath() (método zipfile.Path)
@anchor{library/zipfile zipfile Path joinpath}@anchor{2b97}
@deffn {Método} Path.joinpath (*other)

Retorna um novo objeto Path com cada um dos `outros' argumentos unidos. Os seguintes são equivalentes:

@example
>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'
@end example


Alterado na versão 3.10: Antes de 3.10, @code{joinpath} não estava documentado e aceitava exatamente um parâmetro.

@end deffn

O projeto zipp@footnote{https://pypi.org/project/zipp/} fornece backports da funcionalidade mais recente de objeto caminho para versões mais antigas do Pythons. Use @code{zipp.Path} internamente de @code{zipfile.Path} para acesso antecipado às alterações.

@node Objetos PyZipFile,Objetos ZipInfo,Objetos Path,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile id3}@anchor{2b98}@anchor{library/zipfile pyzipfile-objects}@anchor{2b99}
@subsubsection Objetos PyZipFile


O construtor @ref{102f,,PyZipFile} usa os mesmos parâmetros que o construtor @ref{6c4,,ZipFile}, e um parâmetro adicional, `otimize'.

@geindex PyZipFile (classe em zipfile)
@anchor{library/zipfile zipfile PyZipFile}@anchor{102f}
@deffn {Classe} zipfile.PyZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)


Alterado na versão 3.2: Adicionado o parâmetro `optimize'.



Alterado na versão 3.4: Extensões ZIP64 são habilitadas por padrão.


As instâncias têm um método além daqueles dos objetos @ref{6c4,,ZipFile}:

@geindex writepy() (método zipfile.PyZipFile)
@anchor{library/zipfile zipfile PyZipFile writepy}@anchor{102e}
@deffn {Método} writepy (pathname, basename='@w{'}, filterfunc=None)

Pesquisa por arquivos @code{*.py} e adiciona o arquivo correspondente ao arquivo.

Se o parâmetro `optimize' para @ref{102f,,PyZipFile} não foi fornecido ou @code{-1}, o arquivo correspondente é um arquivo @code{*.pyc}, compilando se necessário.

Se o parâmetro `Optimize' para @ref{102f,,PyZipFile} era @code{0}, @code{1} ou @code{2}, apenas arquivos com esse nível de otimização (ver @ref{192,,compile()}) são adicionados ao o arquivo, compilando se necessário.

Se `pathname' for um arquivo, o nome do arquivo deverá terminar com @code{.py}, e apenas o arquivo (@code{*.pyc} correspondente) será adicionado no nível superior (sem informações do caminho). Se `pathname' for um arquivo que não termine com @code{.py}, um @ref{195,,RuntimeError} será levantado. Se for um diretório, e o diretório não for um diretório de pacotes, todos os arquivos @code{*.pyc} serão adicionados no nível superior. Se o diretório for um diretório de pacotes, todos @code{*.pyc} serão adicionados sob o nome do pacote como um caminho de arquivo e, se algum subdiretório for um diretório de pacotes, todos serão adicionados recursivamente na ordem de classificação.

`basename' destina-se apenas a uso interno.

`filterfunc', se fornecido, deve ser uma função que recebe um único argumento de string. Cada caminho será passado (incluindo cada caminho de arquivo completo individual) antes de ser adicionado ao arquivo. Se `filterfunc' retornar um valor falso, o caminho não será adicionado e, se for um diretório, seu conteúdo será ignorado. Por exemplo, se nossos arquivos de teste estão todos nos diretórios @code{test} ou começam com a string @code{test_}, podemos usar um `filterfunc' para excluí-los:

@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

O método @ref{102e,,writepy()} faz arquivos com nomes de arquivo como este:

@example
string.pyc                   # Nome de nível superior
test/__init__.pyc            # Diretório do pacote
test/testall.pyc             # Módulo test.testall
test/bogus/__init__.pyc      # Diretório do subpacote
test/bogus/myfile.pyc        # Submódulo test.bogus.myfile
@end example


Alterado na versão 3.4: Adicionado o parâmetro `filterfunc'.



Alterado na versão 3.6.2: O parâmetro `pathname' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: A recursão classifica as entradas de diretório.

@end deffn
@end deffn

@node Objetos ZipInfo,Interface de linha de comando<3>,Objetos PyZipFile,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile id4}@anchor{2b9a}@anchor{library/zipfile zipinfo-objects}@anchor{2b7c}
@subsubsection Objetos ZipInfo


Instâncias da classe @ref{d2c,,ZipInfo} são retornadas pelos métodos @ref{2b7a,,getinfo()} e @ref{2b7b,,infolist()} dos objetos @ref{6c4,,ZipFile}. Cada objeto armazena informações sobre um único membro do arquivo ZIP.

Existe um método de classe para fazer uma instância @ref{d2c,,ZipInfo} para um arquivo de sistema de arquivos:

@geindex from_file() (método de classe zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo from_file}@anchor{d2b}
@deffn {Método} classmethod ZipInfo.from_file (filename, arcname=None, *, strict_timestamps=True)

Constrói uma instância @ref{d2c,,ZipInfo} para um arquivo no sistema de arquivos, em preparação para adicioná-lo a um arquivo zip.

`filename' deve ser o caminho para um arquivo ou diretório no sistema de arquivos.

Se `arcname' for especificado, ele será usado como o nome dentro do arquivo. Se `arcname' não for especificado, o nome será igual a `filename', mas com qualquer letra de unidade e separadores de caminho removidos.

O argumento `strict_timestamps', quando definido como @code{False}, permite compactar arquivos anteriores a 1980-01-01 com o custo de definir o carimbo de data/hora para 1980-01-01. Comportamento semelhante ocorre com arquivos mais recentes que 2107-12-31, o carimbo de data/hora também é definido como o limite.


Adicionado na versão 3.6.



Alterado na versão 3.6.2: O parâmetro `filename' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.8: Adicionado o parâmetro somente-nomeado `strict_timestamps'.

@end deffn

As instâncias têm os seguintes métodos e atributos:

@geindex is_dir() (método zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo is_dir}@anchor{d2d}
@deffn {Método} ZipInfo.is_dir ()

Retorna @code{True} se este membro do arquivo for um diretório.

Isso usa o nome da entrada: os diretórios devem sempre terminar com @code{/}.


Adicionado na versão 3.6.

@end deffn

@geindex filename (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo filename}@anchor{2b9b}
@deffn {Atributo} ZipInfo.filename

Nome do arquivo no pacote.
@end deffn

@geindex date_time (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo date_time}@anchor{2b9c}
@deffn {Atributo} ZipInfo.date_time

A hora e a data da última modificação no membro do arquivo. Esta é uma tupla de seis valores que representam os campos “last [modified] file time” (última hora [de modificado] do arquivo) e “last [modified] file date” (última data [de modificação] do arquivo) do diretório central do arquivo ZIP.

A tupla contém:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Valor

@item

@code{0}

@tab

Ano (>= 1980)

@item

@code{1}

@tab

Mês (iniciado em 1)

@item

@code{2}

@tab

Dia do mês (iniciado em 1)

@item

@code{3}

@tab

Horas (iniciado em 0)

@item

@code{4}

@tab

Minutos (base zero)

@item

@code{5}

@tab

Segundos (iniciado em 0)

@end multitable


@cartouche
@quotation Nota 
O formato ZIP oferece suporte a vários campos de registro de data e hora em diferentes locais (diretório central, campos extras para sistemas NTFS/UNIX, etc.). Este atributo retorna especificamente o registro de data e hora do diretório central. O formato de registro de data e hora do diretório central em arquivos ZIP não oferece suporte a registros de data e hora anteriores a 1980. Embora alguns formatos de campos extras (como registros de data e hora do UNIX) possam representar datas anteriores, este atributo retorna apenas o registro de data e hora do diretório central.

O registro de data e hora do diretório central é interpretado como representando a hora local, em vez da hora UTC, para corresponder ao comportamento de outras ferramentas zip.
@end quotation
@end cartouche
@end deffn

@geindex compress_type (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo compress_type}@anchor{2b9d}
@deffn {Atributo} ZipInfo.compress_type

Tipo de compressão do membro do pacote.
@end deffn

@geindex comment (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo comment}@anchor{2b9e}
@deffn {Atributo} ZipInfo.comment

Comentário para o membro individual do pacote como um objeto @ref{1c2,,bytes}.
@end deffn

@geindex extra (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo extra}@anchor{2b9f}
@deffn {Atributo} ZipInfo.extra

Dados do campo de expansão. O PKZIP Application Note@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT} contém alguns comentários sobre a estrutura interna dos dados contidos neste objeto @ref{1c2,,bytes}.
@end deffn

@geindex create_system (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo create_system}@anchor{2ba0}
@deffn {Atributo} ZipInfo.create_system

O sistema que criou o pacote ZIP.
@end deffn

@geindex create_version (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo create_version}@anchor{2ba1}
@deffn {Atributo} ZipInfo.create_version

A versão do PKZIP que criou o pacote ZIP.
@end deffn

@geindex extract_version (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo extract_version}@anchor{2ba2}
@deffn {Atributo} ZipInfo.extract_version

A versão do PKZIP necessária para extrair o pacote.
@end deffn

@geindex reserved (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo reserved}@anchor{2ba3}
@deffn {Atributo} ZipInfo.reserved

Deve ser zero
@end deffn

@geindex flag_bits (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo flag_bits}@anchor{2ba4}
@deffn {Atributo} ZipInfo.flag_bits

Bits de sinalizador do ZIP.
@end deffn

@geindex volume (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo volume}@anchor{2ba5}
@deffn {Atributo} ZipInfo.volume

Número de volume do cabeçalho do arquivo.
@end deffn

@geindex internal_attr (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo internal_attr}@anchor{2ba6}
@deffn {Atributo} ZipInfo.internal_attr

Atributos internos.
@end deffn

@geindex external_attr (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo external_attr}@anchor{2ba7}
@deffn {Atributo} ZipInfo.external_attr

Atributos de arquivo externo.
@end deffn

@geindex header_offset (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo header_offset}@anchor{2ba8}
@deffn {Atributo} ZipInfo.header_offset

Deslocamento de byte para o cabeçalho do arquivo.
@end deffn

@geindex CRC (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo CRC}@anchor{2ba9}
@deffn {Atributo} ZipInfo.CRC

CRC-32 do arquivo não comprimido.
@end deffn

@geindex compress_size (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo compress_size}@anchor{2baa}
@deffn {Atributo} ZipInfo.compress_size

Tamanho dos dados comprimidos.
@end deffn

@geindex file_size (atributo zipfile.ZipInfo)
@anchor{library/zipfile zipfile ZipInfo file_size}@anchor{2b84}
@deffn {Atributo} ZipInfo.file_size

Tamanho do arquivo não comprimido.
@end deffn

@node Interface de linha de comando<3>,Armadilhas de descompressão,Objetos ZipInfo,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile command-line-interface}@anchor{2bab}@anchor{library/zipfile zipfile-commandline}@anchor{2bac}
@subsubsection Interface de linha de comando


O módulo @ref{131,,zipfile} fornece uma interface de linha de comando simples para interagir com arquivos ZIP.

Se você deseja criar um novo arquivo ZIP, especifique seu nome após a opção @ref{2bad,,-c} e, em seguida, liste os nomes dos arquivos que devem ser incluídos:

@example
$ python -m zipfile -c monty.zip spam.txt eggs.txt
@end example

Passar um diretório também é aceitável:

@example
$ python -m zipfile -c monty.zip life-of-brian_1979/
@end example

Se você deseja extrair um arquivo ZIP para o diretório especificado, use a opção @ref{2bae,,-e}:

@example
$ python -m zipfile -e monty.zip target-dir/
@end example

Para obter uma lista dos arquivos em um arquivo ZIP, use a opção @ref{2baf,,-l}:

@example
$ python -m zipfile -l monty.zip
@end example

@menu
* Opções de linha de comando: Opções de linha de comando<2>. 

@end menu

@node Opções de linha de comando<2>,,,Interface de linha de comando<3>
@anchor{library/zipfile command-line-options}@anchor{2bb0}
@subsubsection Opções de linha de comando


@geindex zipfile opção de linha de comando; -l
@geindex zipfile opção de linha de comando; --list
@anchor{library/zipfile cmdoption-zipfile-l}@anchor{2baf}
@deffn {Option} @w{-}l <zipfile>
@anchor{library/zipfile cmdoption-zipfile-list}@anchor{2bb1}
@deffnx {Option} @w{-}@w{-}list <zipfile>

Lista arquivos em um arquivo zip.
@end deffn

@geindex zipfile opção de linha de comando; -c
@geindex zipfile opção de linha de comando; --create
@anchor{library/zipfile cmdoption-zipfile-c}@anchor{2bad}
@deffn {Option} @w{-}c <zipfile> <source1> ... <sourceN>
@anchor{library/zipfile cmdoption-zipfile-create}@anchor{2bb2}
@deffnx {Option} @w{-}@w{-}create <zipfile> <source1> ... <sourceN>

Cria um arquivo zip a partir dos arquivos fonte.
@end deffn

@geindex zipfile opção de linha de comando; -e
@geindex zipfile opção de linha de comando; --extract
@anchor{library/zipfile cmdoption-zipfile-e}@anchor{2bae}
@deffn {Option} @w{-}e <zipfile> <output_dir>
@anchor{library/zipfile cmdoption-zipfile-extract}@anchor{2bb3}
@deffnx {Option} @w{-}@w{-}extract <zipfile> <output_dir>

Extrai um arquivo zip para um diretório de destino.
@end deffn

@geindex zipfile opção de linha de comando; -t
@geindex zipfile opção de linha de comando; --test
@anchor{library/zipfile cmdoption-zipfile-t}@anchor{2bb4}
@deffn {Option} @w{-}t <zipfile>
@anchor{library/zipfile cmdoption-zipfile-test}@anchor{2bb5}
@deffnx {Option} @w{-}@w{-}test <zipfile>

Testa se o arquivo zip é válido ou não.
@end deffn

@geindex zipfile opção de linha de comando; --metadata-encoding
@anchor{library/zipfile cmdoption-zipfile-metadata-encoding}@anchor{2bb6}
@deffn {Option} @w{-}@w{-}metadata@w{-}encoding <encoding>

Especifica a codificação dos nomes dos membros para @ref{2baf,,-l}, @ref{2bae,,-e} e @ref{2bb4,,-t}.


Adicionado na versão 3.11.

@end deffn

@node Armadilhas de descompressão,,Interface de linha de comando<3>,zipfile — Trabalha com arquivos ZIP
@anchor{library/zipfile decompression-pitfalls}@anchor{2bb7}
@subsubsection Armadilhas de descompressão


A extração no módulo zipfile pode falhar devido a algumas armadilhas listadas abaixo.

@menu
* Do próprio arquivo:: 
* Limitações do sistema de arquivos:: 
* Limitações de recursos:: 
* Interrupção:: 
* Comportamentos padrão da extração:: 

@end menu

@node Do próprio arquivo,Limitações do sistema de arquivos,,Armadilhas de descompressão
@anchor{library/zipfile from-file-itself}@anchor{2bb8}
@subsubsection Do próprio arquivo


A descompactação pode falhar devido a senha / soma de verificação CRC / formato ZIP incorretos ou método de compactação / descriptografia não compatível.

@node Limitações do sistema de arquivos,Limitações de recursos,Do próprio arquivo,Armadilhas de descompressão
@anchor{library/zipfile file-system-limitations}@anchor{2bb9}
@subsubsection Limitações do sistema de arquivos


Exceder as limitações em sistemas de arquivos diferentes pode causar falha na descompactação. Como caracteres permitidos nas entradas do diretório, comprimento do nome do arquivo, comprimento do caminho, tamanho de um único arquivo e número de arquivos, etc.

@node Limitações de recursos,Interrupção,Limitações do sistema de arquivos,Armadilhas de descompressão
@anchor{library/zipfile resources-limitations}@anchor{2bba}@anchor{library/zipfile zipfile-resources-limitations}@anchor{2bbb}
@subsubsection Limitações de recursos


A falta de memória ou volume de disco levaria a uma falha de descompactação. Por exemplo, bombas de descompressão (também conhecidas como ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}) aplicam-se à biblioteca de arquivos zip que podem causar o esgotamento do volume do disco.

@node Interrupção,Comportamentos padrão da extração,Limitações de recursos,Armadilhas de descompressão
@anchor{library/zipfile interruption}@anchor{2bbc}
@subsubsection Interrupção


A interrupção durante a descompressão, como pressionar Control-C ou interromper o processo de descompressão pode resultar na descompressão incompleta do arquivo.

@node Comportamentos padrão da extração,,Interrupção,Armadilhas de descompressão
@anchor{library/zipfile default-behaviors-of-extraction}@anchor{2bbd}
@subsubsection Comportamentos padrão da extração


Não saber os comportamentos de extração padrão pode causar resultados de descompressão inesperados. Por exemplo, ao extrair o mesmo arquivo duas vezes, ele sobrescreve os arquivos sem perguntar.

@node tarfile — Ler e gravar arquivos do tipo tar,,zipfile — Trabalha com arquivos ZIP,Compressão de Dados e Arquivamento
@anchor{library/tarfile doc}@anchor{2bbe}@anchor{library/tarfile module-tarfile}@anchor{de}@anchor{library/tarfile tarfile-read-and-write-tar-archive-files}@anchor{2bbf}@anchor{library/tarfile translation-repo}@anchor{2bc0}
@subsection @code{tarfile} — Ler e gravar arquivos do tipo tar


@geindex module; tarfile

`Código-fonte:' Lib/tarfile.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tarfile.py}


__________________________________________________________________


O módulo @ref{de,,tarfile} possibilita a leitura e gravação de arquivos tar, incluindo aqueles que utilizam compactação gzip, bz2 e lzma. Use o módulo @ref{131,,zipfile} para ler ou gravar arquivos @code{.zip} ou as funções de nível mais alto em @ref{1259,,shutil}.

Alguns fatos e números:


@itemize *

@item 
lê e grava arquivos compactados @ref{67,,gzip}, @ref{13,,bz2} e @ref{8a,,lzma} se os respectivos módulos estiverem disponíveis.

@item 
suporte de leitura/gravação para o formato POSIX.1-1988 (ustar).

@item 
suporte de leitura/gravação para o formato GNU tar, incluindo extensões `longname' e `longlink', suporte somente leitura para todas as variantes da extensão `sparse', incluindo restauração de arquivos esparsos.

@item 
suporte de leitura/gravação para o formato POSIX.1-2001 (pax).

@item 
manipula diretórios, arquivos regulares, links físicos, links simbólicos, fifos, dispositivos de caracteres e dispositivos de bloco e é capaz de adquirir e restaurar informações de arquivo, como registro de data e hora, permissões de acesso e proprietário.
@end itemize


Alterado na versão 3.3: Adicionado suporte para compactação @ref{8a,,lzma}.



Alterado na versão 3.12: Archives are extracted using a @ref{46c,,filter},
which makes it possible to either limit surprising/dangerous features,
or to acknowledge that they are expected and the archive is fully trusted.
By default, archives are fully trusted, but this default is deprecated
and slated to change in Python 3.14.


@geindex open() (no módulo tarfile)
@anchor{library/tarfile tarfile open}@anchor{ea6}
@deffn {Função} tarfile.open (name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

Retorna um objeto @ref{1250,,TarFile} para o caminho `name'. Para obter informações detalhadas sobre objetos @ref{1250,,TarFile} e os argumentos nomeados permitidos, consulte @ref{2bc1,,Objetos TarFile}.

`mode' deve ser uma string no formato @code{'filemode[:compression]'}, o padrão é @code{'r'}. Aqui está uma lista completa de combinações de modos:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

mode

@tab

ação

@item

@code{'r'} ou @code{'r:*'}

@tab

Abre para leitura com compactação transparente (recomendado).

@item

@code{'r:'}

@tab

Abre para leitura exclusivamente sem compactação.

@item

@code{'r:gz'}

@tab

Abre para leitura com compactação gzip.

@item

@code{'r:bz2'}

@tab

Abre para leitura com compactação bzip2.

@item

@code{'r:xz'}

@tab

Abre para leitura com compactação lzma.

@item

@code{'x'} ou @code{'x:'}

@tab

Cria um arquivo tar exclusivamente sem compactação. Levanta uma exceção @ref{1056,,FileExistsError} se ele já existir.

@item

@code{'x:gz'}

@tab

Cria um arquivo tar com compactação gzip. Levanta uma exceção @ref{1056,,FileExistsError} se ele já existir.

@item

@code{'x:bz2'}

@tab

Cria um arquivo tar com compactação bzip2. Levanta uma exceção @ref{1056,,FileExistsError} se ele já existir.

@item

@code{'x:xz'}

@tab

Cria um arquivo tar com compactação lzma. Levanta uma exceção @ref{1056,,FileExistsError} se ele já existir.

@item

@code{'a'} ou @code{'a:'}

@tab

Aberto para acrescentar conteúdo sem compactação. O arquivo é criado se não existir.

@item

@code{'w'} ou @code{'w:'}

@tab

Abre para gravação descompactada.

@item

@code{'w:gz'}

@tab

Abre para gravação compactada com gzip.

@item

@code{'w:bz2'}

@tab

Abre para gravação compactada com bzip2.

@item

@code{'w:xz'}

@tab

Abre para gravação compactada com lzma.

@end multitable


Observe que @code{'a:gz'}, @code{'a:bz2'} ou @code{'a:xz'} não são possíveis. Se o `mode' não for adequado para abrir um determinado arquivo (compactado) para leitura, @ref{19da,,ReadError} será levantada. Use o `mode' @code{'r'} para evitar isso. Se um método de compactação não for suportado, @ref{2bc2,,CompressionError} será levantada.

Se `fileobj' for especificado, ele será usado como alternativa a um @ref{1203,,objeto arquivo} aberto em modo binário para `name'. Ele deve estar na posição 0.

Para os modos @code{'w:gz'}, @code{'x:gz'}, @code{'w|gz'}, @code{'w:bz2'}, @code{'x:bz2'}, @code{'w|bz2'}, @ref{ea6,,tarfile.open()} aceita o argumento nomeado `compresslevel' (padrão @code{9}) para especificar o nível de compactação do arquivo.

For modes @code{'w:xz'} and @code{'x:xz'}, @ref{ea6,,tarfile.open()} accepts the
keyword argument `preset' to specify the compression level of the file.

Para fins especiais, existe um segundo formato para `mode': @code{'filemode|[compression]'}. @ref{ea6,,tarfile.open()} retornará um objeto @ref{1250,,TarFile} que processa seus dados como um fluxo de blocos. Nenhuma busca aleatória será realizada no arquivo. Se fornecido, `fileobj' pode ser qualquer objeto que tenha um método @ref{e48,,read()} ou @ref{13f2,,write()} (dependendo do `mode') que funcione com bytes. `bufsize' especifica o tamanho do bloco e o padrão é @code{20 * 512} bytes. Use esta variante em combinação com, por exemplo, @code{sys.stdin.buffer}, um @ref{1203,,objeto arquivo} de soquete ou um dispositivo de fita. No entanto, tal objeto @ref{1250,,TarFile} é limitado, pois não permite acesso aleatório; consulte @ref{2bc3,,Exemplos}. Os modos atualmente possíveis:


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modo

@tab

Ação

@item

@code{'r|*'}

@tab

Abre um `stream' de blocos tar para leitura com compactação transparente.

@item

@code{'r|'}

@tab

Abre um `stream' de blocos tar não compactados para leitura.

@item

@code{'r|gz'}

@tab

Abre um `stream' compactado com gzip para leitura.

@item

@code{'r|bz2'}

@tab

Abre um `stream' compactado com bzip2 para leitura.

@item

@code{'r|xz'}

@tab

Abre um `stream' compactado com lzma para leitura.

@item

@code{'w|'}

@tab

Abre um `stream' descompactado para gravação.

@item

@code{'w|gz'}

@tab

Abre um `stream' compactado com gzip para gravação.

@item

@code{'w|bz2'}

@tab

Abre um `stream' compactado com bzip2 para gravação.

@item

@code{'w|xz'}

@tab

Abre um `stream' compactado com lzma para gravação.

@end multitable



Alterado na versão 3.5: O modo @code{'x'} (criação exclusiva) foi adicionado.



Alterado na versão 3.6: O parâmetro `name' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.12: O argumento nomeado `compresslevel' também funciona para fluxos.

@end deffn


@deffn {Classe} tarfile.TarFile

Classe para ler e escrever arquivos tar. Não use esta classe diretamente: use @ref{ea6,,tarfile.open()} em vez disso. Veja @ref{2bc1,,Objetos TarFile}.
@end deffn

@geindex is_tarfile() (no módulo tarfile)
@anchor{library/tarfile tarfile is_tarfile}@anchor{1965}
@deffn {Função} tarfile.is_tarfile (name)

Retorna @ref{c27,,True} se `name' for um arquivo tar que o módulo @ref{de,,tarfile} possa ler. `name' pode ser uma @ref{44c,,str}, objeto arquivo ou similar.


Alterado na versão 3.9: Suporte para arquivo e objetos arquivo ou similares.

@end deffn

O módulo @ref{de,,tarfile} define as seguintes exceções:

@geindex TarError
@anchor{library/tarfile tarfile TarError}@anchor{2bc4}
@deffn {Exceção} tarfile.TarError

Classe base para todas as exceções de @ref{de,,tarfile}.
@end deffn

@geindex ReadError
@anchor{library/tarfile tarfile ReadError}@anchor{19da}
@deffn {Exceção} tarfile.ReadError

É levantada quando um arquivo tar é aberto e não pode ser manipulado pelo módulo @ref{de,,tarfile} ou é inválido de alguma forma.
@end deffn

@geindex CompressionError
@anchor{library/tarfile tarfile CompressionError}@anchor{2bc2}
@deffn {Exceção} tarfile.CompressionError

É levantada quando um método de compactação não é suportado ou quando os dados não podem ser decodificados corretamente.
@end deffn

@geindex StreamError
@anchor{library/tarfile tarfile StreamError}@anchor{2bc5}
@deffn {Exceção} tarfile.StreamError

É levantada para as limitações típicas de objetos @ref{1250,,TarFile} do tipo fluxo.
@end deffn

@geindex ExtractError
@anchor{library/tarfile tarfile ExtractError}@anchor{2bc6}
@deffn {Exceção} tarfile.ExtractError

É levantada para erros `não fatais' ao usar @ref{42f,,TarFile.extract()}, mas somente se @ref{431,,TarFile.errorlevel}@code{== 2}.
@end deffn

@geindex HeaderError
@anchor{library/tarfile tarfile HeaderError}@anchor{2bc7}
@deffn {Exceção} tarfile.HeaderError

É levantada por @ref{2bc8,,TarInfo.frombuf()} se o buffer obtido for inválido.
@end deffn

@geindex FilterError
@anchor{library/tarfile tarfile FilterError}@anchor{2bc9}
@deffn {Exceção} tarfile.FilterError

Classe base para membros @ref{2bca,,recusados} por filtros.

@geindex tarinfo (atributo tarfile.FilterError)
@anchor{library/tarfile tarfile FilterError tarinfo}@anchor{2bcb}
@deffn {Atributo} tarinfo

Informações sobre o membro que o filtro se recusou a extrair, como @ref{2bcc,,TarInfo}.
@end deffn
@end deffn

@geindex AbsolutePathError
@anchor{library/tarfile tarfile AbsolutePathError}@anchor{2bcd}
@deffn {Exceção} tarfile.AbsolutePathError

Levantada para recusar a extração de um membro com um caminho absoluto.
@end deffn

@geindex OutsideDestinationError
@anchor{library/tarfile tarfile OutsideDestinationError}@anchor{2bce}
@deffn {Exceção} tarfile.OutsideDestinationError

Levantada para recusar a extração de um membro fora do diretório de destino.
@end deffn

@geindex SpecialFileError
@anchor{library/tarfile tarfile SpecialFileError}@anchor{2bcf}
@deffn {Exceção} tarfile.SpecialFileError

Levantada para recusar a extração de um arquivo especial (por exemplo, um dispositivo ou encadeamento).
@end deffn

@geindex AbsoluteLinkError
@anchor{library/tarfile tarfile AbsoluteLinkError}@anchor{2bd0}
@deffn {Exceção} tarfile.AbsoluteLinkError

Levantada para recusar a extração de um link simbólico com um caminho absoluto.
@end deffn

@geindex LinkOutsideDestinationError
@anchor{library/tarfile tarfile LinkOutsideDestinationError}@anchor{2bd1}
@deffn {Exceção} tarfile.LinkOutsideDestinationError

Levantada para recusar a extração de um link simbólico apontando para fora do diretório de destino.
@end deffn

@geindex LinkFallbackError
@anchor{library/tarfile tarfile LinkFallbackError}@anchor{430}
@deffn {Exceção} tarfile.LinkFallbackError

Levantada para recusar a emulação de um link (físico ou simbólico) extraindo outro membro do arquivo, quando esse membro seria rejeitado pelo local do filtro. A exceção levantada para rejeitar o membro substituto está disponível como @code{BaseException.__context__}.


Adicionado na versão 3.13.4.

@end deffn

As seguintes constantes estão disponíveis a nível de módulo:

@geindex ENCODING (no módulo tarfile)
@anchor{library/tarfile tarfile ENCODING}@anchor{2bd2}
@deffn {Dado} tarfile.ENCODING

A codificação de caracteres padrão: @code{'utf-8'} no Windows, o valor retornado por @ref{c74,,sys.getfilesystemencoding()}, caso contrário.
@end deffn

@geindex REGTYPE (no módulo tarfile)
@geindex AREGTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile REGTYPE}@anchor{2bd3}
@deffn {Dado} tarfile.REGTYPE
@anchor{library/tarfile tarfile AREGTYPE}@anchor{2bd4}
@deffnx {Dado} tarfile.AREGTYPE

Um arquivo normal @ref{2bd5,,type}.
@end deffn

@geindex LNKTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile LNKTYPE}@anchor{2bd6}
@deffn {Dado} tarfile.LNKTYPE

Um link (dentro do arquivo tar) @ref{2bd5,,type}.
@end deffn

@geindex SYMTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile SYMTYPE}@anchor{2bd7}
@deffn {Dado} tarfile.SYMTYPE

Um link simbólico @ref{2bd5,,type}.
@end deffn

@geindex CHRTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile CHRTYPE}@anchor{2bd8}
@deffn {Dado} tarfile.CHRTYPE

Um dispositivo especial de caracteres @ref{2bd5,,type}.
@end deffn

@geindex BLKTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile BLKTYPE}@anchor{2bd9}
@deffn {Dado} tarfile.BLKTYPE

Um dispositivo especial de bloco @ref{2bd5,,type}.
@end deffn

@geindex DIRTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile DIRTYPE}@anchor{2bda}
@deffn {Dado} tarfile.DIRTYPE

Um diretório @ref{2bd5,,type}.
@end deffn

@geindex FIFOTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile FIFOTYPE}@anchor{2bdb}
@deffn {Dado} tarfile.FIFOTYPE

Um dispositivo especial de FIFO @ref{2bd5,,type}.
@end deffn

@geindex CONTTYPE (no módulo tarfile)
@anchor{library/tarfile tarfile CONTTYPE}@anchor{2bdc}
@deffn {Dado} tarfile.CONTTYPE

Um arquivo contíguo @ref{2bd5,,type}.
@end deffn

@geindex GNUTYPE_LONGNAME (no módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_LONGNAME}@anchor{2bdd}
@deffn {Dado} tarfile.GNUTYPE_LONGNAME

Um @ref{2bd5,,type} de longname de GNU tar.
@end deffn

@geindex GNUTYPE_LONGLINK (no módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_LONGLINK}@anchor{2bde}
@deffn {Dado} tarfile.GNUTYPE_LONGLINK

Um @ref{2bd5,,type} de longlink de GNU tar.
@end deffn

@geindex GNUTYPE_SPARSE (no módulo tarfile)
@anchor{library/tarfile tarfile GNUTYPE_SPARSE}@anchor{2bdf}
@deffn {Dado} tarfile.GNUTYPE_SPARSE

Um @ref{2bd5,,type} de arquivo esparso de GNU tar.
@end deffn

Cada uma das constantes a seguir define um formato de arquivo tar que o módulo @ref{de,,tarfile} é capaz de criar. Consulte a seção @ref{2be0,,Formatos tar suportados} para obter detalhes.

@geindex USTAR_FORMAT (no módulo tarfile)
@anchor{library/tarfile tarfile USTAR_FORMAT}@anchor{2be1}
@deffn {Dado} tarfile.USTAR_FORMAT

formato POSIX.1-1988 (ustar).
@end deffn

@geindex GNU_FORMAT (no módulo tarfile)
@anchor{library/tarfile tarfile GNU_FORMAT}@anchor{2be2}
@deffn {Dado} tarfile.GNU_FORMAT

Formato tar GNU
@end deffn

@geindex PAX_FORMAT (no módulo tarfile)
@anchor{library/tarfile tarfile PAX_FORMAT}@anchor{2be3}
@deffn {Dado} tarfile.PAX_FORMAT

formato POSIX.1-2001 (pax).
@end deffn

@geindex DEFAULT_FORMAT (no módulo tarfile)
@anchor{library/tarfile tarfile DEFAULT_FORMAT}@anchor{2be4}
@deffn {Dado} tarfile.DEFAULT_FORMAT

O formato padrão para criação de arquivos. Atualmente, é @ref{2be3,,PAX_FORMAT}.


Alterado na versão 3.8: O formato padrão para novos arquivos foi alterado de @ref{2be2,,GNU_FORMAT} para @ref{2be3,,PAX_FORMAT}.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{131,,zipfile}

Documentação do módulo padrão @ref{131,,zipfile}.

@item @ref{1259,,Operações de arquivamento}

Documentação das funcionalidades de arquivamento de nível mais alto fornecidas pelo módulo padrão @ref{c5,,shutil}.

@item Manual do GNU tar@comma{} Formato Básico do Tar@footnote{https://www.gnu.org/software/tar/manual/html_node/Standard.html}

Documentação para arquivos tar, incluindo extensões GNU tar.
@end table


@menu
* Objetos TarFile:: 
* Objetos TarInfo:: 
* Filtros de extração:: 
* Interface de linha de comando: Interface de linha de comando<4>. 
* Exemplos: Exemplos<9>. 
* Formatos tar suportados:: 
* Problemas de Unicode:: 

@end menu

@node Objetos TarFile,Objetos TarInfo,,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile id1}@anchor{2be5}@anchor{library/tarfile tarfile-objects}@anchor{2bc1}
@subsubsection Objetos TarFile


O objeto @ref{1250,,TarFile} fornece uma interface para um arquivo tar. Um arquivo tar é uma sequência de blocos. Um membro do arquivo (um arquivo armazenado) é composto por um bloco de cabeçalho seguido por blocos de dados. É possível armazenar um arquivo em um arquivo tar várias vezes. Cada membro do arquivo é representado por um objeto @ref{1251,,TarInfo}, veja @ref{2bcc,,Objetos TarInfo} para mais detalhes.

Um objeto @ref{1250,,TarFile} pode ser usado como gerenciador de contexto em uma instrução @ref{5d2,,with}. Ele será fechado automaticamente quando o bloco for concluído. Observe que, em caso de exceção, um arquivo aberto para gravação não será finalizado; apenas o objeto arquivo usado internamente será fechado. Consulte a seção @ref{2bc3,,Exemplos} para um exemplo de uso.


Adicionado na versão 3.2: Adicionado suporte para o protocolo de gerenciamento de contexto.


@geindex TarFile (classe em tarfile)
@anchor{library/tarfile tarfile TarFile}@anchor{1250}
@deffn {Classe} 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)

Todos os argumentos a seguir são opcionais e também podem ser acessados como atributos de instância.

`name' é o caminho do arquivo. `name' pode ser um @ref{2a0,,objeto caminho ou similar}. Pode ser omitido se `fileobj' for fornecido. Nesse caso, o atributo @code{name} do objeto arquivo será usado, se existir.

O parâmetro `mode' pode ser @code{'r'} para ler de um arquivo existente, @code{'a'} para adicionar dados a um arquivo existente, @code{'w'} para criar um novo arquivo sobrescrevendo um existente ou @code{'x'} para criar um novo arquivo somente se ele ainda não existir.

Se `fileobj' for fornecido, ele será usado para leitura ou gravação de dados. Se for possível determinar, `mode' será substituído pelo modo de `fileobj'. `fileobj' será usado a partir da posição 0.

@cartouche
@quotation Nota 
`fileobj' não é fechado quando @ref{1250,,TarFile} é fechado.
@end quotation
@end cartouche

`format' controla o formato de gravação do arquivo. Deve ser uma das constantes @ref{2be1,,USTAR_FORMAT}, @ref{2be2,,GNU_FORMAT} ou @ref{2be3,,PAX_FORMAT} definidas no nível do módulo. Durante a leitura, o formato será detectado automaticamente, mesmo que diferentes formatos estejam presentes em um único arquivo.

O argumento `tarinfo' pode ser usado para substituir a classe padrão @ref{1251,,TarInfo} por uma diferente.

Se `dereference' for @ref{b49,,False}, adiciona links físicos e simbólicos ao arquivo. Se for @ref{c27,,True}, adiciona o conteúdo dos arquivos de destino ao arquivo. Isso não tem efeito em sistemas que não oferecem suporte a links simbólicos.

Se `ignore_zeros' for @ref{b49,,False}, trata um bloco vazio como o fim do arquivo. Se for @ref{c27,,True}, ignora blocos vazios (e inválidos) e tenta obter o máximo de membros possível. Isso só é útil para ler arquivos concatenados ou corrompidos.

O parâmetro `debug' pode ser configurado de @code{0} (nenhuma mensagem de depuração) até @code{3} (todas as mensagens de depuração). As mensagens são gravadas em @code{sys.stderr}.

`errorlevel' controla como os erros de extração são tratados, veja @ref{431,,o atributo correspondente}.

Os argumentos `encoding' e `errors' definem a codificação de caracteres a ser usada para leitura ou gravação do arquivo e como os erros de conversão serão tratados. As configurações padrão funcionarão para a maioria dos usuários. Consulta a seção @ref{2be6,,Problemas de Unicode} para obter informações detalhadas.

O argumento `pax_headers' é um dicionário opcional de strings que será adicionado como um cabeçalho global pax se `format' for @ref{2be3,,PAX_FORMAT}.

Se `stream' estiver definido como @ref{c27,,True}, então, durante a leitura do arquivo, as informações sobre os arquivos no arquivo não serão armazenadas em cache, economizando memória.


Alterado na versão 3.2: Usa @code{'surrogateescape'} como padrão para o argumento `errors'.



Alterado na versão 3.5: O modo @code{'x'} (criação exclusiva) foi adicionado.



Alterado na versão 3.6: O parâmetro `name' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: Adiciona o parâmetro `stream'.

@end deffn

@geindex open() (método de classe tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile open}@anchor{1966}
@deffn {Método} classmethod TarFile.open (...)

Construtor alternativo. A função @ref{ea6,,tarfile.open()} é, na verdade, um atalho para este método de classe.
@end deffn

@geindex getmember() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getmember}@anchor{1979}
@deffn {Método} TarFile.getmember (name)

Retorna um objeto @ref{1251,,TarInfo} para o membro `name'. Se `name' não for encontrado no arquivo, uma exceção @ref{344,,KeyError} será levantada.

@cartouche
@quotation Nota 
Se um membro aparecer mais de uma vez no arquivo, presume-se que sua última ocorrência seja a versão mais atualizada.
@end quotation
@end cartouche
@end deffn

@geindex getmembers() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getmembers}@anchor{ea8}
@deffn {Método} TarFile.getmembers ()

Retorna os membros do arquivo como uma lista de objetos @ref{1251,,TarInfo}. A lista tem a mesma ordem que os membros no arquivo.
@end deffn

@geindex getnames() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile getnames}@anchor{2be7}
@deffn {Método} TarFile.getnames ()

Retorna os membros como uma lista com seus nomes. A lista está na mesma ordem que a lista retornada por @ref{ea8,,getmembers()}.
@end deffn

@geindex list() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile list}@anchor{ea7}
@deffn {Método} TarFile.list (verbose=True, *, members=None)

Envia um índice para @code{sys.stdout}. Se `verbose' for @ref{b49,,False}, apenas os nomes dos membros serão exibidos. Se for @ref{c27,,True}, a saída será semelhante à do comando @code{ls -l}. Se o parâmetro opcional `members' for fornecido, ele deverá ser um subconjunto da lista retornada pelo método @ref{ea8,,getmembers()}.


Alterado na versão 3.5: Adicionado o parâmetro `members'.

@end deffn

@geindex next() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile next}@anchor{2be8}
@deffn {Método} TarFile.next ()

Retorna o próximo membro do arquivo como um objeto @ref{1251,,TarInfo}, quando @ref{1250,,TarFile} é aberto para leitura. Retorna @ref{675,,None} se não houver mais nenhum disponível.
@end deffn

@geindex extractall() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extractall}@anchor{42e}
@deffn {Método} TarFile.extractall (path='.', members=None, *, numeric_owner=False, filter=None)

Extract all members from the archive to the current working directory or
directory `path'. If optional `members' is given, it must be a subset of the
list returned by @ref{ea8,,getmembers()}. Directory information like owner,
modification time and permissions are set after all members have been extracted.
This is done to work around two problems: A directory’s modification time is
reset each time a file is created in it. And, if a directory’s permissions do
not allow writing, extracting files to it will fail.

If `numeric_owner' is @ref{c27,,True}, the uid and gid numbers from the tarfile
are used to set the owner/group for the extracted files. Otherwise, the named
values from the tarfile are used.

The `filter' argument specifies how @code{members} are modified or rejected
before extraction.
See @ref{46c,,Filtros de extração} for details.
It is recommended to set this explicitly depending on which `tar' features
you need to support.

@cartouche
@quotation Aviso 
Never extract archives from untrusted sources without prior inspection.
It is possible that files are created outside of `path', e.g. members
that have absolute filenames starting with @code{"/"} or filenames with two
dots @code{".."}.

Set @code{filter='data'} to prevent the most dangerous security issues,
and read the @ref{46c,,Filtros de extração} section for details.
@end quotation
@end cartouche


Alterado na versão 3.5: Adicionado o parâmetro `numeric_owner'.



Alterado na versão 3.6: O parâmetro `path' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.12: Adicionado o parâmetro `filter'.

@end deffn

@geindex extract() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extract}@anchor{42f}
@deffn {Método} TarFile.extract (member, path='@w{'}, set_attrs=True, *, numeric_owner=False, filter=None)

Extract a member from the archive to the current working directory, using its
full name. Its file information is extracted as accurately as possible. `member'
may be a filename or a @ref{1251,,TarInfo} object. You can specify a different
directory using `path'. `path' may be a @ref{2a0,,path-like object}.
File attributes (owner, mtime, mode) are set unless `set_attrs' is false.

The `numeric_owner' and `filter' arguments are the same as
for @ref{42e,,extractall()}.

@cartouche
@quotation Nota 
The @ref{42f,,extract()} method does not take care of several extraction issues.
In most cases you should consider using the @ref{42e,,extractall()} method.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
See the warning for @ref{42e,,extractall()}.

Set @code{filter='data'} to prevent the most dangerous security issues,
and read the @ref{46c,,Filtros de extração} section for details.
@end quotation
@end cartouche


Alterado na versão 3.2: Added the `set_attrs' parameter.



Alterado na versão 3.5: Adicionado o parâmetro `numeric_owner'.



Alterado na versão 3.6: O parâmetro `path' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.12: Adicionado o parâmetro `filter'.

@end deffn

@geindex extractfile() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extractfile}@anchor{2be9}
@deffn {Método} TarFile.extractfile (member)

Extract a member from the archive as a file object. `member' may be
a filename or a @ref{1251,,TarInfo} object. If `member' is a regular file or
a link, an @ref{124e,,io.BufferedReader} object is returned. For all other
existing members, @ref{675,,None} is returned. If `member' does not appear
in the archive, @ref{344,,KeyError} is raised.


Alterado na versão 3.3: Return an @ref{124e,,io.BufferedReader} object.



Alterado na versão 3.13: The returned @ref{124e,,io.BufferedReader} object has the @code{mode}
attribute which is always equal to @code{'rb'}.

@end deffn

@geindex errorlevel (atributo tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile errorlevel}@anchor{431}
@deffn {Atributo} TarFile.errorlevel: @ref{257,,int}

Se `errorlevel' for @code{0}, os erros serão ignorados ao usar @ref{42f,,TarFile.extract()} e @ref{42e,,TarFile.extractall()}. No entanto, eles aparecem como mensagens de erro na saída de depuração quando `debug' for maior que 0. Se @code{1} (o padrão), todos os erros `fatais' serão levantados como exceções @ref{417,,OSError} ou @ref{2bc9,,FilterError}. Se @code{2}, todos os erros `não fatais' também serão levantados como exceções @ref{2bc4,,TarError}.

Some exceptions, e.g. ones caused by wrong argument types or data
corruption, are always raised.

Custom @ref{46c,,extraction filters}
should raise @ref{2bc9,,FilterError} for `fatal' errors
and @ref{2bc6,,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 tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile extraction_filter}@anchor{2bea}
@deffn {Atributo} TarFile.extraction_filter


Adicionado na versão 3.12.


O @ref{46c,,filtro de extração} usado como um padrão para o argumento `filter' de @ref{42f,,extract()} e @ref{42e,,extractall()}.

The attribute may be @code{None} or a callable.
String names are not allowed for this attribute, unlike the `filter'
argument to @ref{42f,,extract()}.

If @code{extraction_filter} is @code{None} (the default),
calling an extraction method without a `filter' argument will raise a
@code{DeprecationWarning},
and fall back to the @ref{2beb,,fully_trusted} filter,
whose dangerous behavior matches previous versions of Python.

In Python 3.14+, leaving @code{extraction_filter=None} will cause
extraction methods to use the @ref{42d,,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{416,,staticmethod()} to prevent injection of a @code{self} argument.
@end deffn

@geindex add() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile add}@anchor{c0e}
@deffn {Método} TarFile.add (name, arcname=None, recursive=True, *, filter=None)

Add the file `name' to the archive. `name' may be any type of file
(directory, fifo, symbolic link, etc.). If given, `arcname' specifies an
alternative name for the file in the archive. Directories are added
recursively by default. This can be avoided by setting `recursive' to
@ref{b49,,False}. Recursion adds entries in sorted order.
If `filter' is given, it
should be a function that takes a @ref{1251,,TarInfo} object argument and
returns the changed @ref{1251,,TarInfo} object. If it instead returns
@ref{675,,None} the @ref{1251,,TarInfo} object will be excluded from the
archive. See @ref{2bc3,,Exemplos} for an example.


Alterado na versão 3.2: Adicionado o parâmetro `filter'.



Alterado na versão 3.7: Recursion adds entries in sorted order.

@end deffn

@geindex addfile() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile addfile}@anchor{171c}
@deffn {Método} TarFile.addfile (tarinfo, fileobj=None)

Add the @ref{1251,,TarInfo} object `tarinfo' to the archive. If `tarinfo' represents
a non zero-size regular file, the `fileobj' argument should be a @ref{1e0e,,binary file},
and @code{tarinfo.size} bytes are read from it and added to the archive.  You can
create @ref{1251,,TarInfo} objects directly, or by using @ref{2bec,,gettarinfo()}.


Alterado na versão 3.13: `fileobj' must be given for non-zero-sized regular files.

@end deffn

@geindex gettarinfo() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile gettarinfo}@anchor{2bec}
@deffn {Método} TarFile.gettarinfo (name=None, arcname=None, fileobj=None)

Create a @ref{1251,,TarInfo} object from the result of @ref{4a0,,os.stat()} or
equivalent on an existing file.  The file is either named by `name', or
specified as a @ref{1203,,file object} `fileobj' with a file descriptor.
`name' may be a @ref{2a0,,path-like object}.  If
given, `arcname' specifies an alternative name for the file in the
archive, otherwise, the name is taken from `fileobj'’s
@ref{2b53,,name} attribute, or the `name' argument.  The name
should be a text string.

You can modify
some of the @ref{1251,,TarInfo}’s attributes before you add it using @ref{171c,,addfile()}.
If the file object is not an ordinary file object positioned at the
beginning of the file, attributes such as @ref{2bed,,size} may need
modifying.  This is the case for objects such as @ref{41a,,GzipFile}.
The @ref{2bee,,name} may also be modified, in which case `arcname'
could be a dummy string.


Alterado na versão 3.6: O parâmetro `name' aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex close() (método tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile close}@anchor{2bef}
@deffn {Método} TarFile.close ()

Close the @ref{1250,,TarFile}. In write mode, two finishing zero blocks are
appended to the archive.
@end deffn

@geindex pax_headers (atributo tarfile.TarFile)
@anchor{library/tarfile tarfile TarFile pax_headers}@anchor{2bf0}
@deffn {Atributo} TarFile.pax_headers: @ref{256,,dict}

Um dicionário contendo pares de chave-valor de cabeçalhos globais pax.
@end deffn

@node Objetos TarInfo,Filtros de extração,Objetos TarFile,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile id2}@anchor{2bf1}@anchor{library/tarfile tarinfo-objects}@anchor{2bcc}
@subsubsection Objetos TarInfo


A @ref{1251,,TarInfo} object represents one member in a @ref{1250,,TarFile}. Aside
from storing all required attributes of a file (like file type, size, time,
permissions, owner etc.), it provides some useful methods to determine its type.
It does `not' contain the file’s data itself.

@ref{1251,,TarInfo} objects are returned by @ref{1250,,TarFile}’s methods
@ref{1979,,getmember()}, @ref{ea8,,getmembers()} and
@ref{2bec,,gettarinfo()}.

Modifying the objects returned by @ref{1979,,getmember()} or
@ref{ea8,,getmembers()} will affect all subsequent
operations on the archive.
For cases where this is unwanted, you can use @ref{25,,copy.copy()} or
call the @ref{2bf2,,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{1251,,TarInfo} methods handle @code{None} differently:


@itemize -

@item 
The @ref{42f,,extract()} or @ref{42e,,extractall()} methods will
ignore the corresponding metadata, leaving it set to a default.

@item 
@ref{171c,,addfile()} falhará.

@item 
@ref{ea7,,list()} imprimirá uma string como um espaço reservado.
@end itemize

@geindex TarInfo (classe em tarfile)
@anchor{library/tarfile tarfile TarInfo}@anchor{1251}
@deffn {Classe} tarfile.TarInfo (name='@w{'})

Cria um objeto @ref{1251,,TarInfo}.
@end deffn

@geindex frombuf() (método de classe tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo frombuf}@anchor{2bc8}
@deffn {Método} classmethod TarInfo.frombuf (buf, encoding, errors)

Cria e retorna um objeto @ref{1251,,TarInfo} a partir do buffer de string do parâmetro `buf'.

Levanta @ref{2bc7,,HeaderError} se o buffer for inválido.
@end deffn

@geindex fromtarfile() (método de classe tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo fromtarfile}@anchor{2bf3}
@deffn {Método} classmethod TarInfo.fromtarfile (tarfile)

Read the next member from the @ref{1250,,TarFile} object `tarfile' and return it as
a @ref{1251,,TarInfo} object.
@end deffn

@geindex tobuf() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo tobuf}@anchor{2bf4}
@deffn {Método} TarInfo.tobuf (format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')

Create a string buffer from a @ref{1251,,TarInfo} object. For information on the
arguments see the constructor of the @ref{1250,,TarFile} class.


Alterado na versão 3.2: Usa @code{'surrogateescape'} como padrão para o argumento `errors'.

@end deffn

A @code{TarInfo} object has the following public data attributes:

@geindex name (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo name}@anchor{2bee}
@deffn {Atributo} TarInfo.name: @ref{44c,,str}

Nome do arquivo.
@end deffn

@geindex size (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo size}@anchor{2bed}
@deffn {Atributo} TarInfo.size: @ref{257,,int}

Tamanho em bytes.
@end deffn

@geindex mtime (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo mtime}@anchor{2bf5}
@deffn {Atributo} TarInfo.mtime: @ref{257,,int} | @ref{2f7,,float}

Time of last modification in seconds since the @ref{2bf6,,epoch},
as in @ref{2bf7,,os.stat_result.st_mtime}.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex mode (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo mode}@anchor{2bf8}
@deffn {Atributo} TarInfo.mode: @ref{257,,int}

Permission bits, as for @ref{21b,,os.chmod()}.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex type (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo type}@anchor{2bd5}
@deffn {Atributo} TarInfo.type

File type.  `type' is usually one of these constants: @ref{2bd3,,REGTYPE},
@ref{2bd4,,AREGTYPE}, @ref{2bd6,,LNKTYPE}, @ref{2bd7,,SYMTYPE}, @ref{2bda,,DIRTYPE},
@ref{2bdb,,FIFOTYPE}, @ref{2bdc,,CONTTYPE}, @ref{2bd8,,CHRTYPE}, @ref{2bd9,,BLKTYPE},
@ref{2bdf,,GNUTYPE_SPARSE}.  To determine the type of a @ref{1251,,TarInfo} object
more conveniently, use the @code{is*()} methods below.
@end deffn

@geindex linkname (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo linkname}@anchor{2bf9}
@deffn {Atributo} TarInfo.linkname: @ref{44c,,str}

Name of the target file name, which is only present in @ref{1251,,TarInfo} objects
of type @ref{2bd6,,LNKTYPE} and @ref{2bd7,,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 tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo uid}@anchor{2bfa}
@deffn {Atributo} TarInfo.uid: @ref{257,,int}

ID do usuário do usuário que originalmente armazenou este membro.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex gid (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo gid}@anchor{2bfb}
@deffn {Atributo} TarInfo.gid: @ref{257,,int}

ID do grupo do usuário que originalmente armazenou este membro.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex uname (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo uname}@anchor{2bfc}
@deffn {Atributo} TarInfo.uname: @ref{44c,,str}

Nome do usuário.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex gname (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo gname}@anchor{2bfd}
@deffn {Atributo} TarInfo.gname: @ref{44c,,str}

Nome do grupo.


Alterado na versão 3.12: Can be set to @code{None} for @ref{42f,,extract()} and
@ref{42e,,extractall()}, causing extraction to skip applying this
attribute.

@end deffn

@geindex chksum (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo chksum}@anchor{2bfe}
@deffn {Atributo} TarInfo.chksum: @ref{257,,int}

Cabeçalho de soma de verificação.
@end deffn

@geindex devmajor (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo devmajor}@anchor{2bff}
@deffn {Atributo} TarInfo.devmajor: @ref{257,,int}

Número principal do dispositivo.
@end deffn

@geindex devminor (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo devminor}@anchor{2c00}
@deffn {Atributo} TarInfo.devminor: @ref{257,,int}

Número menor do dispositivo.
@end deffn

@geindex offset (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo offset}@anchor{2c01}
@deffn {Atributo} TarInfo.offset: @ref{257,,int}

O cabeçalho do tar começa aqui.
@end deffn

@geindex offset_data (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo offset_data}@anchor{2c02}
@deffn {Atributo} TarInfo.offset_data: @ref{257,,int}

Os dados do arquivo começam aqui.
@end deffn

@geindex sparse (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo sparse}@anchor{2c03}
@deffn {Atributo} TarInfo.sparse

Sparse member information.
@end deffn

@geindex pax_headers (atributo tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo pax_headers}@anchor{2c04}
@deffn {Atributo} TarInfo.pax_headers: @ref{256,,dict}

A dictionary containing key-value pairs of an associated pax extended header.
@end deffn

@geindex replace() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo replace}@anchor{2bf2}
@deffn {Método} TarInfo.replace (name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)


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

A @ref{1251,,TarInfo} object also provides some convenient query methods:

@geindex isfile() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isfile}@anchor{2c05}
@deffn {Método} TarInfo.isfile ()

Return @ref{c27,,True} if the @ref{1251,,TarInfo} object is a regular file.
@end deffn

@geindex isreg() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isreg}@anchor{2c06}
@deffn {Método} TarInfo.isreg ()

Igual a @ref{2c05,,isfile()}.
@end deffn

@geindex isdir() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isdir}@anchor{2c07}
@deffn {Método} TarInfo.isdir ()

Retorna @ref{c27,,True} se for um diretório.
@end deffn

@geindex issym() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo issym}@anchor{2c08}
@deffn {Método} TarInfo.issym ()

Retorna @ref{c27,,True} se for um link simbólico.
@end deffn

@geindex islnk() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo islnk}@anchor{2c09}
@deffn {Método} TarInfo.islnk ()

Retorna @ref{c27,,True} se for um link físico.
@end deffn

@geindex ischr() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo ischr}@anchor{2c0a}
@deffn {Método} TarInfo.ischr ()

Retorna @ref{c27,,True} se for um caractere.
@end deffn

@geindex isblk() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isblk}@anchor{2c0b}
@deffn {Método} TarInfo.isblk ()

Return @ref{c27,,True} if it is a block device.
@end deffn

@geindex isfifo() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isfifo}@anchor{2c0c}
@deffn {Método} TarInfo.isfifo ()

Retorna @ref{c27,,True} se for um FIFO.
@end deffn

@geindex isdev() (método tarfile.TarInfo)
@anchor{library/tarfile tarfile TarInfo isdev}@anchor{2c0d}
@deffn {Método} TarInfo.isdev ()

Return @ref{c27,,True} if it is one of character device, block device or FIFO.
@end deffn

@node Filtros de extração,Interface de linha de comando<4>,Objetos TarInfo,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile extraction-filters}@anchor{2c0e}@anchor{library/tarfile tarfile-extraction-filter}@anchor{46c}
@subsubsection Filtros de extração



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


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 706

@item PEP 706@footnote{https://peps.python.org/pep-0706/}

Contém a motivação e lógica escolhida para este design.
@end table


The `filter' argument to @ref{42f,,TarFile.extract()} or @ref{42e,,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{2c0f,,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{42d,,data_filter()} for details.

@item 
@code{None} (default): Use @ref{2bea,,TarFile.extraction_filter}.

If that is also @code{None} (the default), raise a @code{DeprecationWarning},
and fall back to the @code{'fully_trusted'} filter, whose dangerous behavior
matches previous versions of Python.

In Python 3.14, the @code{'data'} filter will become the default instead.
It’s possible to switch earlier; see @ref{2bea,,TarFile.extraction_filter}.

@item 
A callable which will be called for each extracted member with a
@ref{2bcc,,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{1251,,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{431,,errorlevel}.
Note that when extraction is aborted, @ref{42e,,extractall()} may leave
the archive partially extracted. It does not attempt to clean up.
@end itemize
@end itemize

@menu
* Default named filters:: 
* Filter errors:: 
* Dicas para verificação adicional:: 
* Suporte a versões mais antigas do Python:: 
* Stateful extraction filter example:: 

@end menu

@node Default named filters,Filter errors,,Filtros de extração
@anchor{library/tarfile default-named-filters}@anchor{2c10}
@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() (no módulo tarfile)
@anchor{library/tarfile tarfile fully_trusted_filter}@anchor{2beb}
@deffn {Função} tarfile.fully_trusted_filter (member, path)

Retorna `member' inalterado.

This implements the @code{'fully_trusted'} filter.
@end deffn

@geindex tar_filter() (no módulo tarfile)
@anchor{library/tarfile tarfile tar_filter}@anchor{2c0f}
@deffn {Função} tarfile.tar_filter (member, path)

Implements the @code{'tar'} filter.


@itemize -

@item 
Strip leading slashes (@code{/} and @ref{66a,,os.sep}) from filenames.

@item 
@ref{2bca,,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{2bcd,,AbsolutePathError}.

@item 
@ref{2bca,,Refuse} to extract files whose absolute
path (after following symlinks) would end up outside the destination.
This raises @ref{2bce,,OutsideDestinationError}.

@item 
Clear high mode bits (setuid, setgid, sticky) and group/other write bits
(@ref{29b9,,S_IWGRP} | @ref{29bc,,S_IWOTH}).
@end itemize

Return the modified @code{TarInfo} member.
@end deffn

@geindex data_filter() (no módulo tarfile)
@anchor{library/tarfile tarfile data_filter}@anchor{42d}
@deffn {Função} tarfile.data_filter (member, path)

Implements the @code{'data'} filter.
In addition to what @code{tar_filter} does:


@itemize -

@item 
Normalize link targets (@ref{2bf9,,TarInfo.linkname}) using
@ref{135e,,os.path.normpath()}.
Note that this removes internal @code{..} components, which may change the
meaning of the link if the path in @code{TarInfo.linkname} traverses
symbolic links.

@item 
@ref{2bca,,Refuse} to extract links (hard or soft)
that link to absolute paths, or ones that link outside the destination.

This raises @ref{2bd0,,AbsoluteLinkError} or
@ref{2bd1,,LinkOutsideDestinationError}.

Note that such files are refused even on platforms that do not support
symbolic links.

@item 
@ref{2bca,,Refuse} to extract device files
(including pipes).
This raises @ref{2bcf,,SpecialFileError}.

@item 
Para arquivos comuns, incluindo links físicos:


@itemize -

@item 
Set the owner read and write permissions
(@ref{29b4,,S_IRUSR} | @ref{29b5,,S_IWUSR}).

@item 
Remove the group & other executable permission
(@ref{29b0,,S_IXGRP} | @ref{29bd,,S_IXOTH})
if the owner doesn’t have it (@ref{29b6,,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.


Alterado na versão 3.13.4: Link targets are now normalized.

@end deffn

@node Filter errors,Dicas para verificação adicional,Default named filters,Filtros de extração
@anchor{library/tarfile filter-errors}@anchor{2c11}@anchor{library/tarfile tarfile-extraction-refuse}@anchor{2bca}
@subsubsection Filter errors


When a filter refuses to extract a file, it will raise an appropriate exception,
a subclass of @ref{2bc9,,FilterError}.
This will abort the extraction if @ref{431,,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 Dicas para verificação adicional,Suporte a versões mais antigas do Python,Filter errors,Filtros de extração
@anchor{library/tarfile hints-for-further-verification}@anchor{2c12}
@subsubsection Dicas para verificação adicional


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.

Aqui está uma lista incompleta de itens a serem considerados:


@itemize *

@item 
Extract to a @ref{21f,,new temporary directory}
to prevent e.g. exploiting pre-existing links, and to make it easier to
clean up after a failed extraction.

@item 
Disallow symbolic links if you do not need the functionality.

@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,
etc.).

@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

Observe também que:


@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 Suporte a versões mais antigas do Python,Stateful extraction filter example,Dicas para verificação adicional,Filtros de extração
@anchor{library/tarfile supporting-older-python-versions}@anchor{2c13}
@subsubsection Suporte a versões mais antigas do Python


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 o filtro @code{'data'}; `fail' se ele não estiver disponível:

@example
my_tarfile.extractall(filter=tarfile.data_filter)
@end example

ou:

@example
my_tarfile.extraction_filter = tarfile.data_filter
my_tarfile.extractall()
@end example

@item 
Use o filtro @code{'data'}; `warn' se ele não estiver disponível:

@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,,Suporte a versões mais antigas do Python,Filtros de extração
@anchor{library/tarfile stateful-extraction-filter-example}@anchor{2c14}
@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 Interface de linha de comando<4>,Exemplos<9>,Filtros de extração,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile command-line-interface}@anchor{2c15}@anchor{library/tarfile tarfile-commandline}@anchor{1001}
@subsubsection Interface de linha de comando



Adicionado na versão 3.4.


The @ref{de,,tarfile} module provides a simple command-line interface to interact
with tar archives.

If you want to create a new tar archive, specify its name after the @ref{2c16,,-c}
option and then list the filename(s) that should be included:

@example
$ python -m tarfile -c monty.tar  spam.txt eggs.txt
@end example

Passar um diretório também é aceitável:

@example
$ python -m tarfile -c monty.tar life-of-brian_1979/
@end example

If you want to extract a tar archive into the current directory, use
the @ref{2c17,,-e} option:

@example
$ python -m tarfile -e monty.tar
@end example

You can also extract a tar archive into a different directory by passing the
directory’s name:

@example
$ python -m tarfile -e monty.tar  other-dir/
@end example

For a list of the files in a tar archive, use the @ref{2c18,,-l} option:

@example
$ python -m tarfile -l monty.tar
@end example

@menu
* Opções de linha de comando: Opções de linha de comando<3>. 

@end menu

@node Opções de linha de comando<3>,,,Interface de linha de comando<4>
@anchor{library/tarfile command-line-options}@anchor{2c19}
@subsubsection Opções de linha de comando


@geindex tarfile opção de linha de comando; -l
@geindex tarfile opção de linha de comando; --list
@anchor{library/tarfile cmdoption-tarfile-l}@anchor{2c18}
@deffn {Option} @w{-}l <tarfile>
@anchor{library/tarfile cmdoption-tarfile-list}@anchor{2c1a}
@deffnx {Option} @w{-}@w{-}list <tarfile>

Lista os arquivos em um arquivo tar.
@end deffn

@geindex tarfile opção de linha de comando; -c
@geindex tarfile opção de linha de comando; --create
@anchor{library/tarfile cmdoption-tarfile-c}@anchor{2c16}
@deffn {Option} @w{-}c <tarfile> <source1> ... <sourceN>
@anchor{library/tarfile cmdoption-tarfile-create}@anchor{2c1b}
@deffnx {Option} @w{-}@w{-}create <tarfile> <source1> ... <sourceN>

Cria um arquivo tar a partir dos arquivos de origem.
@end deffn

@geindex tarfile opção de linha de comando; -e
@geindex tarfile opção de linha de comando; --extract
@anchor{library/tarfile cmdoption-tarfile-e}@anchor{2c17}
@deffn {Option} @w{-}e <tarfile> [<output_dir>]
@anchor{library/tarfile cmdoption-tarfile-extract}@anchor{2c1c}
@deffnx {Option} @w{-}@w{-}extract <tarfile> [<output_dir>]

Extract tarfile into the current directory if `output_dir' is not specified.
@end deffn

@geindex tarfile opção de linha de comando; -t
@geindex tarfile opção de linha de comando; --test
@anchor{library/tarfile cmdoption-tarfile-t}@anchor{2c1d}
@deffn {Option} @w{-}t <tarfile>
@anchor{library/tarfile cmdoption-tarfile-test}@anchor{2c1e}
@deffnx {Option} @w{-}@w{-}test <tarfile>

Test whether the tarfile is valid or not.
@end deffn

@geindex tarfile opção de linha de comando; -v
@geindex tarfile opção de linha de comando; --verbose
@anchor{library/tarfile cmdoption-tarfile-v}@anchor{2c1f}@anchor{library/tarfile cmdoption-tarfile-verbose}@anchor{2c20}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

Saída detalhada.
@end deffn

@geindex tarfile opção de linha de comando; --filter
@anchor{library/tarfile cmdoption-tarfile-filter}@anchor{2c21}
@deffn {Option} @w{-}@w{-}filter <filtername>

Specifies the `filter' for @code{--extract}.
See @ref{46c,,Filtros de extração} for details.
Only string names are accepted (that is, @code{fully_trusted}, @code{tar},
and @code{data}).
@end deffn

@node Exemplos<9>,Formatos tar suportados,Interface de linha de comando<4>,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile examples}@anchor{2c22}@anchor{library/tarfile tar-examples}@anchor{2bc3}
@subsubsection Exemplos


@menu
* Reading examples:: 
* Writing examples:: 

@end menu

@node Reading examples,Writing examples,,Exemplos<9>
@anchor{library/tarfile reading-examples}@anchor{2c23}
@subsubsection Reading examples


How to extract an entire tar archive to the current working directory:

@example
import tarfile
tar = tarfile.open("sample.tar.gz")
tar.extractall(filter='data')
tar.close()
@end example

How to extract a subset of a tar archive with @ref{42e,,TarFile.extractall()} using
a generator function instead of a list:

@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

How to read a gzip compressed tar archive and display some member information:

@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

@node Writing examples,,Reading examples,Exemplos<9>
@anchor{library/tarfile writing-examples}@anchor{2c24}
@subsubsection Writing examples


How to create an uncompressed tar archive from a list of filenames:

@example
import tarfile
tar = tarfile.open("sample.tar", "w")
for name in ["foo", "bar", "quux"]:
    tar.add(name)
tar.close()
@end example

The same example using the @ref{5d2,,with} statement:

@example
import tarfile
with tarfile.open("sample.tar", "w") as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)
@end example

How to create and write an archive to stdout using
@ref{ae6,,sys.stdout.buffer} in the `fileobj' parameter
in @ref{c0e,,TarFile.add()}:

@example
import sys
import tarfile
with tarfile.open("sample.tar.gz", "w|gz", fileobj=sys.stdout.buffer) as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)
@end example

How to create an archive and reset the user information using the `filter'
parameter in @ref{c0e,,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 suportados,Problemas de Unicode,Exemplos<9>,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile supported-tar-formats}@anchor{2c25}@anchor{library/tarfile tar-formats}@anchor{2be0}
@subsubsection Formatos tar suportados


There are three tar formats that can be created with the @ref{de,,tarfile} module:


@itemize *

@item 
The POSIX.1-1988 ustar format (@ref{2be1,,USTAR_FORMAT}). It supports filenames
up to a length of at best 256 characters and linknames up to 100 characters.
The maximum file size is 8 GiB. This is an old and limited but widely
supported format.

@item 
The GNU tar format (@ref{2be2,,GNU_FORMAT}). It supports long filenames and
linknames, files bigger than 8 GiB and sparse files. It is the de facto
standard on GNU/Linux systems. @ref{de,,tarfile} fully supports the GNU tar
extensions for long names, sparse file support is read-only.

@item 
The POSIX.1-2001 pax format (@ref{2be3,,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.

It extends the existing `ustar' format with extra headers for information
that cannot be stored otherwise. There are two flavours of pax headers:
Extended headers only affect the subsequent file header, global
headers are valid for the complete archive and affect all following files.
All the data in a pax header is encoded in `UTF-8' for portability reasons.
@end itemize

There are some more variants of the tar format which can be read, but not
created:


@itemize *

@item 
The ancient V7 format. This is the first tar format from Unix Seventh Edition,
storing only regular files and directories. Names must not be longer than 100
characters, there is no user/group name information. Some archives have
miscalculated header checksums in case of fields with non-ASCII characters.

@item 
The SunOS tar extended format. This format is a variant of the POSIX.1-2001
pax format, but is not compatible.
@end itemize

@node Problemas de Unicode,,Formatos tar suportados,tarfile — Ler e gravar arquivos do tipo tar
@anchor{library/tarfile tar-unicode}@anchor{2be6}@anchor{library/tarfile unicode-issues}@anchor{2c26}
@subsubsection Problemas de Unicode


The tar format was originally conceived to make backups on tape drives with the
main focus on preserving file system information. Nowadays tar archives are
commonly used for file distribution and exchanging archives over networks. One
problem of the original format (which is the basis of all other formats) is
that there is no concept of supporting different character encodings. For
example, an ordinary tar archive created on a `UTF-8' system cannot be read
correctly on a `Latin-1' system if it contains non-`ASCII' characters. Textual
metadata (like filenames, linknames, user/group names) will appear damaged.
Unfortunately, there is no way to autodetect the encoding of an archive. The
pax format was designed to solve this problem. It stores non-ASCII metadata
using the universal character encoding `UTF-8'.

The details of character conversion in @ref{de,,tarfile} are controlled by the
`encoding' and `errors' keyword arguments of the @ref{1250,,TarFile} class.

`encoding' defines the character encoding to use for the metadata in the
archive. The default value is @ref{c74,,sys.getfilesystemencoding()} or @code{'ascii'}
as a fallback. Depending on whether the archive is read or written, the
metadata must be either decoded or encoded. If `encoding' is not set
appropriately, this conversion may fail.

The `errors' argument defines how characters are treated that cannot be
converted. Possible values are listed in section @ref{18fa,,Error Handlers}.
The default scheme is @code{'surrogateescape'} which Python also uses for its
file system calls, see @ref{2c27,,Nomes de arquivos@comma{} argumentos de linha de comando e variáveis de ambiente}.

For @ref{2be3,,PAX_FORMAT} archives (the default), `encoding' is generally not needed
because all the metadata is stored using `UTF-8'. `encoding' is only used in
the rare cases when binary pax headers are decoded or when strings with
surrogate characters are stored.

@node Formatos de Arquivo,Serviços Criptográficos,Compressão de Dados e Arquivamento,A Biblioteca Padrão do Python
@anchor{library/fileformats doc}@anchor{2c28}@anchor{library/fileformats file-formats}@anchor{2c29}@anchor{library/fileformats fileformats}@anchor{2c2a}@anchor{library/fileformats translation-repo}@anchor{2c2b}
@section Formatos de Arquivo


Os módulos descritos neste capítulo analisam vários formatos de arquivo diversos que não são linguagens de marcação e não estão relacionados ao e-mail.

@menu
* csv — Leitura e escrita de arquivos CSV:: 
* configparser — Analisador sintático de arquivo de configuração:: 
* tomllib — Analisa arquivos TOML:: 
* netrc — Arquivo de processamento netrc:: 
* plistlib — Gera e analisa arquivos Apple .plist: plistlib — Gera e analisa arquivos Apple plist. 

@end menu

@node csv — Leitura e escrita de arquivos CSV,configparser — Analisador sintático de arquivo de configuração,,Formatos de Arquivo
@anchor{library/csv doc}@anchor{2c2c}@anchor{library/csv csv-csv-file-reading-and-writing}@anchor{2c2d}@anchor{library/csv module-csv}@anchor{29}
@subsection @code{csv} — Leitura e escrita de arquivos CSV


@geindex module; csv

`Código-fonte:' Lib/csv.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/csv.py}

@geindex csv
@geindex dados;tabular


__________________________________________________________________


O chamado formato CSV (Comma Separated Values) é o formato mais comum de importação e exportação de planilhas e bancos de dados. O formato CSV foi usado por muitos anos antes das tentativas de descrever o formato de maneira padronizada em 
@geindex RFC; RFC 4180
RFC 4180@footnote{https://datatracker.ietf.org/doc/html/rfc4180.html}. A falta de um padrão bem definido significa que existem diferenças sutis nos dados produzidos e consumidos por diferentes aplicativos. Essas diferenças podem tornar irritante o processamento de arquivos CSV de várias fontes. Ainda assim, enquanto os delimitadores e os caracteres de citação variam, o formato geral é semelhante o suficiente para que seja possível escrever um único módulo que possa manipular eficientemente esses dados, ocultando os detalhes da leitura e gravação dos dados do programador.

O módulo @ref{29,,csv} implementa classes para ler e gravar dados tabulares no formato CSV. Ele permite que os programadores digam “escreva esses dados no formato preferido pelo Excel” ou “leia os dados desse arquivo gerado pelo Excel”, sem conhecer os detalhes precisos do formato CSV usado pelo Excel. Os programadores também podem descrever os formatos CSV entendidos por outros aplicativos ou definir seus próprios formatos CSV para fins especiais.

Os objetos de @ref{486,,reader} e @ref{487,,writer} do módulo @ref{29,,csv} leem e escrevem sequências. Os programadores também podem ler e gravar dados no formato de dicionário usando as classes @ref{9ed,,DictReader} e @ref{123e,,DictWriter}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - CSV File API

A proposta de melhoria do Python que propôs essa adição ao Python.
@end table


@menu
* Conteúdo do módulo: Conteúdo do módulo<3>. 
* Dialetos e parâmetros de formatação:: 
* Objetos Reader:: 
* Objetos Writer:: 
* Exemplos: Exemplos<10>. 

@end menu

@node Conteúdo do módulo<3>,Dialetos e parâmetros de formatação,,csv — Leitura e escrita de arquivos CSV
@anchor{library/csv csv-contents}@anchor{2c2e}@anchor{library/csv module-contents}@anchor{2c2f}
@subsubsection Conteúdo do módulo


O módulo @ref{29,,csv} define as seguintes funções:

@geindex novas linhas universais;função csv.reader

@geindex reader() (no módulo csv)
@anchor{library/csv csv reader}@anchor{486}
@deffn {Função} csv.reader (csvfile, /, dialect='excel', **fmtparams)

Retorna um @ref{2c30,,objeto leitor} que irá iterar sobre as linhas no `csvfile' fornecido. Um csvfile deve ser um iterável de strings, cada uma no formato csv definido pelo leitor. Um csvfile é muito comumente um objeto similar a arquivo ou uma lista. Se `csvfile' for um objeto arquivo, ele deverá ser aberto com @code{newline='@w{'}}. @footnote{
Se @code{newline='@w{'}} não for especificado, quebras de linha inseridas em campos entre aspas não serão interpretadas corretamente e, em plataformas que usam terminações de linha @code{\r\n} na gravação, um @code{\r} extra será adicionado. É sempre seguro especificar @code{newline='@w{'}}, já que o módulo csv faz seu próprio tratamento de quebra de linha (@ref{d5c,,universal}).
} Pode ser fornecido um parâmetro opcional `dialect', usado para definir um conjunto de parâmetros específicos para um dialeto CSV específico. Pode ser uma instância de uma subclasse da classe @ref{1771,,Dialect} ou uma das strings retornadas pela função @ref{191f,,list_dialects()}. Os outros argumentos nomeados opcionais `fmtparams' podem ser dados para substituir parâmetros de formatação individuais no dialeto atual. Para detalhes completos sobre os parâmetros de dialeto e formatação, consulte a seção @ref{2c31,,Dialetos e parâmetros de formatação}.

Cada linha lida no arquivo csv é retornada como uma lista de strings. Nenhuma conversão automática de tipo de dados é executada, a menos que a opção de formato @ref{16d7,,QUOTE_NONNUMERIC} seja especificada (nesse caso, os campos não citados são transformados em pontos flutuantes).

Um pequeno exemplo 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() (no módulo csv)
@anchor{library/csv csv writer}@anchor{487}
@deffn {Função} csv.writer (csvfile, /, dialect='excel', **fmtparams)

Retorna um objeto de escrita responsável por converter os dados de usuário em strings delimitadas no objeto arquivo ou similar. `csvfile' pode ser qualquer objeto com um método @ref{1dfb,,write()}. Se `csvfile' for um objeto arquivo, ele deverá ser aberto com @code{newline='@w{'}} @footnote{
Se @code{newline='@w{'}} não for especificado, quebras de linha inseridas em campos entre aspas não serão interpretadas corretamente e, em plataformas que usam terminações de linha @code{\r\n} na gravação, um @code{\r} extra será adicionado. É sempre seguro especificar @code{newline='@w{'}}, já que o módulo csv faz seu próprio tratamento de quebra de linha (@ref{d5c,,universal}).
}. Pode ser fornecido um parâmetro opcional `dialect', usado para definir um conjunto de parâmetros específicos para um dialeto CSV específico. Pode ser uma instância de uma subclasse da classe @ref{1771,,Dialect} ou uma das strings retornadas pela função @ref{191f,,list_dialects()}. Os outros argumentos nomeados opcionais `fmtparams' podem ser dados para substituir parâmetros de formatação individuais no dialeto atual. Para detalhes completos sobre os parâmetros de dialeto e formatação, consulte a seção @ref{2c31,,Dialetos e parâmetros de formatação}. Para tornar o mais fácil possível a interface com os módulos que implementam a API do DB, o valor @ref{675,,None} é escrito como uma string vazia. Embora isso não seja uma transformação reversível, torna mais fácil despejar valores de dados SQL NULL em arquivos CSV sem preprocessar os dados retornados de uma chamada @code{cursor.fetch*}. Todos os outros dados que não são de strings são codificados com @ref{44c,,str()} antes de serem escritos.

Um pequeno exemplo 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() (no módulo csv)
@anchor{library/csv csv register_dialect}@anchor{2c32}
@deffn {Função} csv.register_dialect (name, /, dialect='excel', **fmtparams)

Associa `dialect' a `name'. `name' deve ser uma string. O dialeto pode ser especificado passando uma subclasse de @ref{1771,,Dialect} ou por `fmtparams' argumentos nomeados, ou ambos, com argumentos nomeados substituindo os parâmetros do dialeto. Para detalhes completos sobre os parâmetros de dialeto e formatação, consulte a seção @ref{2c31,,Dialetos e parâmetros de formatação}.
@end deffn

@geindex unregister_dialect() (no módulo csv)
@anchor{library/csv csv unregister_dialect}@anchor{191e}
@deffn {Função} csv.unregister_dialect (name)

Exclui o dialeto associado ao `name' do registro do dialeto. Um @ref{2c33,,Error} é levantado se `name' não for um nome de dialeto registrado.
@end deffn

@geindex get_dialect() (no módulo csv)
@anchor{library/csv csv get_dialect}@anchor{191d}
@deffn {Função} csv.get_dialect (name)

Retorna o dialeto associado a `name'. Um @ref{2c33,,Error} é levantado se `name' não for um nome de dialeto registrado. Esta função retorna uma classe @ref{1771,,Dialect} imutável.
@end deffn

@geindex list_dialects() (no módulo csv)
@anchor{library/csv csv list_dialects}@anchor{191f}
@deffn {Função} csv.list_dialects ()

Retorna os nomes de todos os dialetos registrados
@end deffn

@geindex field_size_limit() (no módulo csv)
@anchor{library/csv csv field_size_limit}@anchor{191c}
@deffn {Função} csv.field_size_limit ()

@deffnx {Função} csv.field_size_limit (new_limit)

Retorna o tamanho máximo atual do campo permitido pelo analisador sintático. Se `new_limit' for fornecido, este se tornará o novo limite.
@end deffn

O módulo @ref{29,,csv} define as seguintes classes:

@geindex DictReader (classe em csv)
@anchor{library/csv csv DictReader}@anchor{9ed}
@deffn {Classe} csv.DictReader (f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)

Cria um objeto que funcione como um leitor comum, mas mapeia as informações em cada linha para @ref{256,,dict} cujas chaves são fornecidas pelo parâmetro opcional `fieldnames'.

O parâmetro `fieldnames' é uma @ref{4f1,,sequência}. Se `fieldnames' for omitido, os valores na primeira linha do arquivo `f' serão usados como nomes de campo e serão omitidos dos resultados. Se `fieldnames' for fornecido, eles serão usados e a primeira linha será incluída nos resultados. Independentemente de como os nomes de campo são determinados, o dicionário preserva sua ordem original.

Se uma linha tiver mais campos que nomes de campo, os dados restantes serão colocados em uma lista e armazenados com o nome do campo especificado por `restkey' (o padrão é @code{None}). Se uma linha que não estiver em branco tiver menos campos que nomes de campo, os valores ausentes serão preenchidos com o valor `restval' (o padrão é @code{None}).

Todos os outros argumentos nomeados ou opcionais são passados para a instância subjacente de @ref{486,,reader}.

Se o argumento passado para `fieldnames' for um iterador, ele será convertido para uma @ref{611,,list}.


Alterado na versão 3.6: Linhas retornadas agora são do tipo @code{OrderedDict}.



Alterado na versão 3.8: As linhas retornadas agora são do tipo @ref{256,,dict}.


Um pequeno exemplo 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 (classe em csv)
@anchor{library/csv csv DictWriter}@anchor{123e}
@deffn {Classe} csv.DictWriter (f, fieldnames, restval='@w{'}, extrasaction='raise', dialect='excel', *args, **kwds)

Cria um objeto que funcione como um de escrita comum, mas mapeia dicionários nas linhas de saída. O parâmetro `fieldnames' é uma @ref{1e,,sequência} de chaves que identificam a ordem na qual os valores no dicionário transmitidos para o método @ref{e14,,writerow()} são escritos no arquivo `f'. O parâmetro opcional `restval' especifica o valor a ser escrito se o dicionário estiver com falta de uma chave em `fieldnames'. Se o dicionário transmitido para o método @ref{e14,,writerow()} contiver uma chave não encontrada em `fieldnames', o parâmetro opcional `extrasaction' indica qual ação executar. Se estiver definido como @code{'raise'}, o valor padrão, a @ref{202,,ValueError} é levantada. Se estiver definido como @code{'ignore'}, valores extras no dicionário serão ignorados. Quaisquer outros argumentos nomeados ou opcionais são passados para a instância subjacente de @ref{487,,writer}.

Observe que, diferentemente da classe @ref{9ed,,DictReader}, o parâmetro `fieldnames' da classe @ref{123e,,DictWriter} não é opcional.

Se o argumento passado para `fieldnames' for um iterador, ele será convertido para uma @ref{611,,list}.

Um pequeno exemplo 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 (classe em csv)
@anchor{library/csv csv Dialect}@anchor{1771}
@deffn {Classe} csv.Dialect

A classe @ref{1771,,Dialect} é uma classe de contêiner cujos atributos contêm informações sobre como lidar com aspas duplas, espaços em branco, delimitadores, etc. Devido à falta de uma especificação CSV estrita, diferentes aplicativos produzem dados CSV sutilmente diferentes. As instâncias de @ref{1771,,Dialect} definem como as instâncias @ref{486,,reader} e @ref{487,,writer} se comportam.

Todos os nomes de @ref{1771,,Dialect} disponíveis são retornados por @ref{191f,,list_dialects()}, e eles podem ser registrados com classes @ref{486,,reader} e @ref{487,,writer} específicas através de suas funções inicializadoras (@code{__init__}) como esta:

@example
import csv

with open('students.csv', 'w', newline='@w{'}) as csvfile:
    writer = csv.writer(csvfile, dialect='unix')
@end example
@end deffn

@geindex excel (classe em csv)
@anchor{library/csv csv excel}@anchor{2c34}
@deffn {Classe} csv.excel

A classe @ref{2c34,,excel} define as propriedades usuais de um arquivo CSV gerado pelo Excel. Ele é registrado com o nome do dialeto @code{'excel'}.
@end deffn

@geindex excel_tab (classe em csv)
@anchor{library/csv csv excel_tab}@anchor{2c35}
@deffn {Classe} csv.excel_tab

A classe @ref{2c35,,excel_tab} define as propriedades usuais de um arquivo delimitado por TAB gerado pelo Excel. Ela é registrado com o nome do dialeto @code{'excel-tab'}.
@end deffn

@geindex unix_dialect (classe em csv)
@anchor{library/csv csv unix_dialect}@anchor{123d}
@deffn {Classe} csv.unix_dialect

A classe @ref{123d,,unix_dialect} define as propriedades usuais de um arquivo CSV gerado em sistemas UNIX, ou seja, usando @code{'\n'} como terminador de linha e citando todos os campos. É registrado com o nome do dialeto @code{'unix'}.


Adicionado na versão 3.2.

@end deffn

@geindex Sniffer (classe em csv)
@anchor{library/csv csv Sniffer}@anchor{2c36}
@deffn {Classe} csv.Sniffer

A classe @ref{2c36,,Sniffer} é usada para deduzir o formato de um arquivo CSV.

A classe @ref{2c36,,Sniffer} fornece dois métodos:

@geindex sniff() (método csv.Sniffer)
@anchor{library/csv csv Sniffer sniff}@anchor{2c37}
@deffn {Método} sniff (sample, delimiters=None)

Analisa a `sample' fornecida e retorna uma subclasse @ref{1771,,Dialect}, refletindo os parâmetros encontrados. Se o parâmetro opcional `delimiters' for fornecido, ele será interpretado como uma string contendo possíveis caracteres válidos de delimitador.
@end deffn

@geindex has_header() (método csv.Sniffer)
@anchor{library/csv csv Sniffer has_header}@anchor{19e2}
@deffn {Método} has_header (sample)

Analisa o texto de amostra (presume-se que esteja no formato CSV) e retorne @ref{c27,,True} se a primeira linha parecer uma série de cabeçalhos de coluna. Inspecionando cada coluna, um dos dois critérios principais será considerado para estimar se a amostra contém um cabeçalho:


@itemize -

@item 
da segunda até a enésima linha contém valores numéricos

@item 
da segunda até a enésima linha contém strings em que pelo menos o comprimento de um valor difere daquele do cabeçalho putativo dessa coluna.
@end itemize

Vinte e uma linhas após a linha de cabeçalho são amostradas; se mais da metade das colunas + linhas atenderem aos critérios, @ref{c27,,True} será retornado.
@end deffn

@cartouche
@quotation Nota 
Este método é uma heurística aproximada e pode produzir falsos positivos e negativos.
@end quotation
@end cartouche
@end deffn

Um exemplo para uso de @ref{2c36,,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)
    # ... processa conteúdo do arquivo CSV aqui ...
@end example
@anchor{library/csv csv-constants}@anchor{2c38}
O módulo @ref{29,,csv} define as seguintes constantes:

@geindex QUOTE_ALL (no módulo csv)
@anchor{library/csv csv QUOTE_ALL}@anchor{2c39}
@deffn {Dado} csv.QUOTE_ALL

Instrui objetos @ref{487,,writer} a colocar aspas em todos os campos.
@end deffn

@geindex QUOTE_MINIMAL (no módulo csv)
@anchor{library/csv csv QUOTE_MINIMAL}@anchor{2c3a}
@deffn {Dado} csv.QUOTE_MINIMAL

Instrui objetos @ref{487,,writer} a colocar aspas apenas nos campos que contêm caracteres especiais como `delimiters', `quotechar', @code{'\r'}, @code{'\n'} ou qualquer um dos caracteres em `lineterminator'.
@end deffn

@geindex QUOTE_NONNUMERIC (no módulo csv)
@anchor{library/csv csv QUOTE_NONNUMERIC}@anchor{16d7}
@deffn {Dado} csv.QUOTE_NONNUMERIC

Instrui objetos @ref{487,,writer} a colocar aspas em todos os campos não numéricos.

Instrui objetos @ref{486,,reader} a converter todos os campos não envoltos por aspas no tipo @ref{2f7,,float}.

@cartouche
@quotation Nota 
Alguns tipos numéricos, como @ref{468,,bool}, @ref{1e7,,Fraction} ou @ref{d00,,IntEnum}, têm uma representação de string que não pode ser convertida para @ref{2f7,,float}. Eles não podem ser lidos nos modos @ref{16d7,,QUOTE_NONNUMERIC} e @ref{485,,QUOTE_STRINGS}.
@end quotation
@end cartouche
@end deffn

@geindex QUOTE_NONE (no módulo csv)
@anchor{library/csv csv QUOTE_NONE}@anchor{2c3b}
@deffn {Dado} csv.QUOTE_NONE

Instrui objetos @ref{487,,writer} a nunca colocar aspas nos campos. Quando o `delimiter', `quotechar', `escapechar',  @code{'\r'}, @code{'\n'} ou qualquer um dos caracteres em `lineterminator' ocorre nos dados de saída, é precedido pelo caractere `escapechar' atual. Se `escapeechar' não estiver definido, o escritor levantará @ref{2c33,,Error} se algum caractere que exija escape for encontrado. Defina `quotechar' para @code{None} para evitar seu escape.

Instrui objetos @ref{486,,reader} a não executar nenhum processamento especial de caracteres de aspas.
@end deffn

@geindex QUOTE_NOTNULL (no módulo csv)
@anchor{library/csv csv QUOTE_NOTNULL}@anchor{484}
@deffn {Dado} csv.QUOTE_NOTNULL

Instrui objetos @ref{487,,writer} a coloca entre aspas os campos que não são @code{None}. Isso é semelhante a @ref{2c39,,QUOTE_ALL}, exceto que se o valor de um campo for @code{None}, uma string vazia (sem aspas) é escrita.

Instrui objetos @ref{486,,reader} a interpretar um campo vazio (sem aspas) como @code{None} e a se comportar de outra forma como @ref{2c39,,QUOTE_ALL}.


Adicionado na versão 3.12.

@end deffn

@geindex QUOTE_STRINGS (no módulo csv)
@anchor{library/csv csv QUOTE_STRINGS}@anchor{485}
@deffn {Dado} csv.QUOTE_STRINGS

Instrui objetos @ref{487,,writer} a sempre coloca aspas em volta dos campos que são strings. Isso é semelhante a @ref{16d7,,QUOTE_NONNUMERIC}, exceto que se o valor de um campo for @code{None}, uma string vazia (sem aspas) é escrita.

Instrui objetos @ref{486,,reader} a interpretar uma string vazia (sem aspas) como @code{None} e a se comportar de outra forma como @ref{16d7,,QUOTE_NONNUMERIC}.


Adicionado na versão 3.12.

@end deffn

O módulo @ref{29,,csv} define a seguinte exceção:

@geindex Error
@anchor{library/csv csv Error}@anchor{2c33}
@deffn {Exceção} csv.Error

Levantada por qualquer uma das funções quando um erro é detectado.
@end deffn

@node Dialetos e parâmetros de formatação,Objetos Reader,Conteúdo do módulo<3>,csv — Leitura e escrita de arquivos CSV
@anchor{library/csv csv-fmt-params}@anchor{2c31}@anchor{library/csv dialects-and-formatting-parameters}@anchor{2c3c}
@subsubsection Dialetos e parâmetros de formatação


Para facilitar a especificação do formato dos registros de entrada e saída, parâmetros específicos de formatação são agrupados em dialetos. Um dialeto é uma subclasse da classe @ref{1771,,Dialect} contendo vários atributos descrevendo o formato do arquivo CSV. Ao criar objetos @ref{486,,reader} ou @ref{487,,writer}, o programador pode especificar uma string ou uma subclasse da classe @ref{1771,,Dialect} como parâmetro de dialeto. Além do parâmetro `dialect', ou em vez do parâmetro `dialect', o programador também pode especificar parâmetros de formatação individuais, com os mesmos nomes dos atributos definidos abaixo para a classe @ref{1771,,Dialect}.

Os dialetos possuem suporte aos seguintes atributos:

@geindex delimiter (atributo csv.Dialect)
@anchor{library/csv csv Dialect delimiter}@anchor{2c3d}
@deffn {Atributo} Dialect.delimiter

Uma string de um caractere usada para separar campos. O padrão é @code{','}.
@end deffn

@geindex doublequote (atributo csv.Dialect)
@anchor{library/csv csv Dialect doublequote}@anchor{2c3e}
@deffn {Atributo} Dialect.doublequote

Controla como as instâncias de `quotechar' que aparecem dentro de um campo devem estar entre aspas. Quando @ref{c27,,True}, o caractere é dobrado. Quando @ref{b49,,False}, o `escapechar' é usado como um prefixo para o `quotechar'. O padrão é @ref{c27,,True}.

Na saída, se `doublequote' for @ref{b49,,False} e não `escapeechar' for definido, @ref{2c33,,Error} é levantada se um `quotechar' é encontrado em um campo.
@end deffn

@geindex escapechar (atributo csv.Dialect)
@anchor{library/csv csv Dialect escapechar}@anchor{2c3f}
@deffn {Atributo} Dialect.escapechar

Uma string de caracteres de um caractere usada pelo escritor para escapar caracteres que exigem escape:

@quotation


@itemize *

@item 
o `delimiter', o `quotechar', @code{'\r'}, @code{'\n'} e qualquer um dos caracteres em `lineterminator' são escapados se `quoting' estiver definido como @ref{2c3b,,QUOTE_NONE};

@item 
o `quotechar' é escapado se `doublequote' for @ref{b49,,False};

@item 
o `escapechar' em si.
@end itemize
@end quotation

Na leitura, o `escapechar' remove qualquer significado especial do caractere seguinte. O padrão é @ref{675,,None}, o que desabilita o escape.


Alterado na versão 3.11: Um `escapechar' vazio não é permitido.

@end deffn

@geindex lineterminator (atributo csv.Dialect)
@anchor{library/csv csv Dialect lineterminator}@anchor{2c40}
@deffn {Atributo} Dialect.lineterminator

A string usada para terminar as linhas produzidas pelo @ref{487,,writer}. O padrão é @code{'\r\n'}.

@cartouche
@quotation Nota 
A @ref{486,,reader} é codificada para reconhecer @code{'\r'} ou @code{'\n'} como fim de linha e ignora `lineterminator'. Esse comportamento pode mudar no futuro.
@end quotation
@end cartouche
@end deffn

@geindex quotechar (atributo csv.Dialect)
@anchor{library/csv csv Dialect quotechar}@anchor{2c41}
@deffn {Atributo} Dialect.quotechar

Uma string de um caractere usada para colocar entre aspas campos que contêm caracteres especiais, como o `delimiter' ou o `quotechar', ou que contêm caracteres de nova linha (@code{'\r'}, @code{'\n'} ou qualquer um dos caracteres em `lineterminator'). O padrão é @code{'"'}. Pode ser definido como @code{None} para evitar o escape de @code{'"'} se `aspas' estiver definido como @ref{2c3b,,QUOTE_NONE}.


Alterado na versão 3.11: Um `quotechar' vazio não é permitido.

@end deffn

@geindex quoting (atributo csv.Dialect)
@anchor{library/csv csv Dialect quoting}@anchor{2c42}
@deffn {Atributo} Dialect.quoting

Controla quando as aspas devem ser geradas pelo escritor e reconhecidas pelo leitor. Ele pode assumir qualquer uma das constantes @ref{2c38,,QUOTE_* constants} e o padrão é @ref{2c3a,,QUOTE_MINIMAL}. se `quotechar' não for @code{None} e, do contrário, @ref{2c3b,,QUOTE_NONE}.
@end deffn

@geindex skipinitialspace (atributo csv.Dialect)
@anchor{library/csv csv Dialect skipinitialspace}@anchor{2c43}
@deffn {Atributo} Dialect.skipinitialspace

Quando @ref{c27,,True}, os espaços imediatamente após o `delimitador' são ignorados. O padrão é @ref{b49,,False}. Ao combinar @code{delimiter=' '} com @code{skipinitialspace=True}, campos vazios sem aspas não são permitidos.
@end deffn

@geindex strict (atributo csv.Dialect)
@anchor{library/csv csv Dialect strict}@anchor{2c44}
@deffn {Atributo} Dialect.strict

Quando @code{True}, levanta a exceção @ref{2c33,,Error} em uma entrada CSV ruim. O padrão é @code{False}.
@end deffn

@node Objetos Reader,Objetos Writer,Dialetos e parâmetros de formatação,csv — Leitura e escrita de arquivos CSV
@anchor{library/csv id3}@anchor{2c45}@anchor{library/csv reader-objects}@anchor{2c30}
@subsubsection Objetos Reader


Os objetos Reader (instâncias @ref{9ed,,DictReader} e objetos retornados pela função @ref{486,,reader()}) têm os seguintes métodos públicos:

@geindex __next__() (método csv.csvreader)
@anchor{library/csv csv csvreader __next__}@anchor{2c46}
@deffn {Método} csvreader.__next__ ()

Retorna a próxima linha do objeto iterável do leitor como uma lista (se o objeto foi retornado de @code{leitor()}) ou um dict (se for uma instância de @ref{9ed,,DictReader}), analisado de acordo com a @ref{1771,,Dialect} atual. Normalmente, você deve chamar isso de @code{next(reader)}.
@end deffn

Os objetos Reader possuem os seguintes atributos públicos:

@geindex dialect (atributo csv.csvreader)
@anchor{library/csv csv csvreader dialect}@anchor{2c47}
@deffn {Atributo} csvreader.dialect

Uma descrição somente leitura do dialeto em uso pelo analisador sintático.
@end deffn

@geindex line_num (atributo csv.csvreader)
@anchor{library/csv csv csvreader line_num}@anchor{2c48}
@deffn {Atributo} csvreader.line_num

O número de linhas lidas no iterador de origem. Não é o mesmo que o número de registros retornados, pois os registros podem abranger várias linhas.
@end deffn

Os objetos DictReader têm o seguinte atributo público:

@geindex fieldnames (atributo csv.DictReader)
@anchor{library/csv csv DictReader fieldnames}@anchor{2c49}
@deffn {Atributo} DictReader.fieldnames

Se não for passado como parâmetro ao criar o objeto, esse atributo será inicializado no primeiro acesso ou quando o primeiro registro for lido no arquivo.
@end deffn

@node Objetos Writer,Exemplos<10>,Objetos Reader,csv — Leitura e escrita de arquivos CSV
@anchor{library/csv writer-objects}@anchor{2c4a}
@subsubsection Objetos Writer


Objetos @ref{487,,writer} (instâncias e objetos @ref{123e,,DictWriter} retornados pela função @ref{487,,writer()}) possuem os seguintes métodos públicos. Uma `row' deve ser iterável de strings ou números para objetos @ref{487,,writer} e um dicionário mapeando nomes de campos para strings ou números (passando-os por @ref{44c,,str()} primeiro) para @ref{123e,,DictWriter}. Observe que números complexos são escritos cercados por parênteses. Isso pode causar alguns problemas para outros programas que leem arquivos CSV (supondo que eles aceitem números complexos).

@geindex writerow() (método csv.csvwriter)
@anchor{library/csv csv csvwriter writerow}@anchor{e14}
@deffn {Método} csvwriter.writerow (row, /)

Escreve o parâmetro `row' no objeto arquivo do escritor, formatado de acordo com a @ref{1771,,Dialect} atual. Retorna o valor de retorno da chamada ao método `write' do objeto arquivo subjacente.


Alterado na versão 3.5: Adicionado suporte a iteráveis arbitrários.

@end deffn

@geindex writerows() (método csv.csvwriter)
@anchor{library/csv csv csvwriter writerows}@anchor{2c4b}
@deffn {Método} csvwriter.writerows (rows, /)

Escreve todos os elementos em `rows' (um iterável de objetos `row', conforme descrito acima) no objeto arquivo do escritor, formatado de acordo com o dialeto atual.
@end deffn

Os objetos Writer têm o seguinte atributo público:

@geindex dialect (atributo csv.csvwriter)
@anchor{library/csv csv csvwriter dialect}@anchor{2c4c}
@deffn {Atributo} csvwriter.dialect

Uma descrição somente leitura do dialeto em uso pelo escritor.
@end deffn

Os objetos DictWriter têm o seguinte método público:

@geindex writeheader() (método csv.DictWriter)
@anchor{library/csv csv DictWriter writeheader}@anchor{123f}
@deffn {Método} DictWriter.writeheader ()

Escreve uma linha com os nomes dos campos (conforme especificado no construtor) no objeto arquivo do escritor, formatado de acordo com o dialeto atual. Retorna o valor de retorno da chamada @ref{e14,,csvwriter.writerow()} usada internamente.


Adicionado na versão 3.2.



Alterado na versão 3.8: @ref{123f,,writeheader()} agora também retorna o valor retornado pelo método @ref{e14,,csvwriter.writerow()} que ele usa internamente.

@end deffn

@node Exemplos<10>,,Objetos Writer,csv — Leitura e escrita de arquivos CSV
@anchor{library/csv csv-examples}@anchor{2c4d}@anchor{library/csv examples}@anchor{2c4e}
@subsubsection Exemplos


O exemplo mais simples de leitura de um arquivo CSV:

@example
import csv
with open('some.csv', newline='@w{'}) as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)
@end example

Lendo um arquivo com um 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

O exemplo de escrita possível mais simples possível é:

@example
import csv
with open('some.csv', 'w', newline='@w{'}) as f:
    writer = csv.writer(f)
    writer.writerows(someiterable)
@end example

Como @ref{51c,,open()} é usado para abrir um arquivo CSV para leitura, o arquivo será decodificado por padrão em unicode usando a codificação padrão do sistema (consulte @ref{2dc,,locale.getencoding()}). Para decodificar um arquivo usando uma codificação diferente, use o argumento @code{encoding} do 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

O mesmo se aplica à escrita em algo diferente da codificação padrão do sistema: especifique o argumento de codificação ao abrir o arquivo de saída.

Registrando um novo dialeto:

@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

Um uso um pouco mais avançado do leitor — capturando e relatando erros:

@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(f'file @{filename@}, line @{reader.line_num@}: @{e@}')
@end example

E embora o módulo não tenha suporte diretamente à análise sintática de strings, isso pode ser feito facilmente:

@example
import csv
for row in csv.reader(['one,two,three']):
    print(row)
@end example

@node configparser — Analisador sintático de arquivo de configuração,tomllib — Analisa arquivos TOML,csv — Leitura e escrita de arquivos CSV,Formatos de Arquivo
@anchor{library/configparser doc}@anchor{2c4f}@anchor{library/configparser configparser-configuration-file-parser}@anchor{2c50}@anchor{library/configparser module-configparser}@anchor{22}@anchor{library/configparser translation-repo}@anchor{2c51}
@subsection @code{configparser} — Analisador sintático de arquivo de configuração


@geindex module; configparser

`Código-fonte:' Lib/configparser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/configparser.py}

@geindex .ini;arquivo
@geindex configuração;arquivo
@geindex arquivo ini
@geindex arquivo ini do Windows


__________________________________________________________________


Este módulo fornece a classe @ref{1c8,,ConfigParser}, que implementa uma linguagem de configuração básica, com uma estrutura semelhante à encontrada nos arquivos INI do Microsoft Windows. Você pode usar isso para escrever programas em Python que podem ser facilmente personalizados pelos usuários finais.

@cartouche
@quotation Nota 
Esta biblioteca `não' interpreta nem escreve os prefixos de tipo de valor usados na versão estendida da sintaxe INI do Registro do Windows.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item Módulo @ref{fc,,tomllib}

TOML é um formato bem especificado para arquivos de configuração de aplicações. Ele foi projetado especificamente para ser uma versão melhorada do INI.

@item Módulo @ref{c4,,shlex}

Suporte para criação de minilinguagens semelhantes a shell Unix que também podem ser usadas para arquivos de configuração de aplicações.

@item Módulo @ref{82,,json}

O módulo @code{json} implementa um subconjunto de sintaxe JavaScript que às vezes é usado para configuração, mas não suporta comentários.
@end table


@c import configparser

@c import os
@c os.remove("example.ini")
@c os.remove("override.ini")

@menu
* Início rápido:: 
* Tipos de dados suportados:: 
* Valores reservas:: 
* Estrutura dos arquivos INI:: 
* Seções não nomeadas:: 
* Interpolação de valores:: 
* Acesso através do protocolo de mapeamento:: 
* Personalizando o comportamento do analisador sintático:: 
* Exemplos de APIs legadas:: 
* Objetos ConfigParser:: 
* Objetos RawConfigParser:: 
* Exceções: Exceções<8>. 

@end menu

@node Início rápido,Tipos de dados suportados,,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser quick-start}@anchor{2c52}
@subsubsection Início rápido


Vamos pegar um arquivo de configuração bem básico parecido com este:

@example
[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes

[forge.example]
User = hg

[topsecret.server.example]
Port = 50022
ForwardX11 = no
@end example

A estrutura dos arquivos INI é descrita @ref{2c53,,na seção seguinte}. Essencialmente, o arquivo consiste em seções, cada uma contendo chaves com valores. As classes @ref{22,,configparser} podem ler e escrever tais arquivos. Vamos começar criando o arquivo de configuração acima programaticamente.

@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 você pode ver, podemos tratar um analisador sintático de configuração como um dicionário. Existem diferenças, @ref{2c54,,descritas posteriormente}, mas o comportamento é muito próximo do que você esperaria de um dicionário.

Agora que criamos e salvamos um arquivo de configuração, vamos lê-lo e explorar os dados que ele contém.

@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 ver acima, a API é bastante simples. A única mágica envolve a seção @code{DEFAULT} que fornece valores padrão para todas as outras seções @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}. Observe também que as chaves nas seções não diferenciam maiúsculas de minúsculas e são armazenadas em letras minúsculas @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}.

É possível ler diversas configurações para um único @ref{1c8,,ConfigParser}, onde a configuração adicionada mais recentemente terá a maior prioridade. Para quaisquer chaves repetidas serão usados os valores da configuração mais recente, enquanto os valores das chaves anteriores serão ignorados. O exemplo a seguir lê um arquivo chamado @code{override.ini}, que irá substituir chaves repetidas do arquivo @code{example.ini}.

@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 comportamento é equivalente a uma chamada @ref{14b0,,ConfigParser.read()} com vários arquivos passados para o parâmetro `filenames'.

@node Tipos de dados suportados,Valores reservas,Início rápido,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser supported-datatypes}@anchor{2c56}
@subsubsection Tipos de dados suportados


Os analisadores sintáticos de configuração não adivinham os tipos de dados dos valores nos arquivos de configuração, sempre os armazenando internamente como strings. Isso significa que se você precisar de outros tipos de dados, deverá converter por conta própria:

@example
>>> int(topsecret['Port'])
50022
>>> float(topsecret['CompressionLevel'])
9.0
@end example

Como essa tarefa é tão comum, os analisadores sintáticos de configuração fornecem uma variedade de métodos getter úteis para manipular com números inteiros, pontos flutuantes e booleanos. O último é o mais interessante porque simplesmente passar o valor para @code{bool()} não adiantaria nada já que @code{bool('False')} ainda é @code{True}. É por isso que os analisadores sintáticos de configuração também fornecem @ref{2c57,,getboolean()}. Este método não diferencia maiúsculas de minúsculas e reconhece valores booleanos de @code{'yes'}/@code{'no'}, @code{'on'}/@code{'off'}, @code{'true'} /@code{'false'} e @code{'1'}/@code{'0'} @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}. Por exemplo:

@example
>>> topsecret.getboolean('ForwardX11')
False
>>> config['forge.example'].getboolean('ForwardX11')
True
>>> config.getboolean('forge.example', 'Compression')
True
@end example

Além de @ref{2c57,,getboolean()}, os analisadores sintáticos de configuração também fornecem métodos @ref{2c58,,getint()} e @ref{2c59,,getfloat()} equivalentes. Você pode registrar seus próprios conversores e personalizar os fornecidos. @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}

@node Valores reservas,Estrutura dos arquivos INI,Tipos de dados suportados,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser fallback-values}@anchor{2c5a}
@subsubsection Valores reservas


Assim como acontece com um dicionário, você pode usar o método @ref{12ad,,get()} de uma seção para fornecer valores reservas (fallback):

@example
>>> topsecret.get('Port')
'50022'
>>> topsecret.get('CompressionLevel')
'9'
>>> topsecret.get('Cipher')
>>> topsecret.get('Cipher', '3des-cbc')
'3des-cbc'
@end example

Observe que os valores padrão têm precedência sobre os valores substitutos. Por exemplo, em nosso exemplo a chave @code{'CompressionLevel'} foi especificada apenas na seção @code{'DEFAULT'}. Se tentarmos obtê-lo na seção @code{'topsecret.server.example'}, sempre obteremos o padrão, mesmo se especificarmos um substituto:

@example
>>> topsecret.get('CompressionLevel', '3')
'9'
@end example

Mais uma coisa a ter em conta é que o método @ref{12ad,,get()} no nível do analisador fornece uma interface personalizada e mais complexa, mantida para compatibilidade com versões anteriores. Ao usar este método, um valor substituto pode ser fornecido através do argumento somente-nomeado @code{fallback}:

@example
>>> config.get('forge.example', 'monster',
...            fallback='No such things as monsters')
'No such things as monsters'
@end example

O mesmo argumento @code{fallback} pode ser usado com os métodos @ref{2c58,,getint()}, @ref{2c59,,getfloat()} e @ref{2c57,,getboolean()}, por exemplo:

@example
>>> 'BatchMode' in topsecret
False
>>> topsecret.getboolean('BatchMode', fallback=True)
True
>>> config['DEFAULT']['BatchMode'] = 'no'
>>> topsecret.getboolean('BatchMode', fallback=True)
False
@end example

@node Estrutura dos arquivos INI,Seções não nomeadas,Valores reservas,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser supported-ini-file-structure}@anchor{2c53}
@subsubsection Estrutura dos arquivos INI


Um arquivo de configuração consiste em seções, cada uma liderada por um cabeçalho @code{[section]}, seguido por entradas de chave/valor separadas por uma string específica (@code{=} ou @code{:} por padrão @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}) . Por padrão, os nomes das seções diferenciam maiúsculas de minúsculas, mas as chaves não @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}. Os espaços em branco à esquerda e à direita são removidos das chaves e dos valores. Os valores podem ser omitidos se o analisador sintático estiver configurado para permitir @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}, caso em que o delimitador chave/valor também pode ser omitido. Os valores também podem abranger várias linhas, desde que sejam indentados de forma mais profunda que a primeira linha do valor. Dependendo do modo do analisador sintático, as linhas em branco podem ser tratadas como partes de valores multilinhas ou ignoradas.

Por padrão, um nome de seção válido pode ser qualquer string que não contenha ‘\n’. Para alterar isso, consulte @ref{2c5b,,ConfigParser.SECTCRE}.

O nome da primeira seção pode ser omitido se o analisador sintático estiver configurado para permitir uma seção de nível superior sem nome com @code{allow_unnamed_section=True}. Neste caso, as chaves/valores podem ser recuperadas por @ref{2c5c,,UNNAMED_SECTION} como em @code{config[UNNAMED_SECTION]}.

Os arquivos de configuração podem incluir comentários, prefixados por caracteres específicos (@code{#} e @code{;} por padrão @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}). Os comentários podem aparecer sozinhos em uma linha vazia, possivelmente indentados. @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}

Por exemplo:

@example
[Valores Simples]
chave=valor
espaços nas chaves=permitidos
espaços nos valores=permitidos também
espaços em volta do delimitador = obviamente
você também pode usar : para delimitar chaves de valores

[Todos Valores São Strings]
valores como este: 1000000
ou este: 3.14159265359
são tratados como números? : não
inteiros, pontos flutuantes e booleanos são considerados: strings
pode usar a API para obter valores convertidos diretamente: verdadeiro

[Valores multilinha]
chorus: Eu sou um lenhador e estou bem
    Durmo a noite toda e trabalho o dia inteiro

[Sem valores]
chave_sem_valor
valor string vazia aqui =

[Você pode usar comentários]
# como este
; ou este

# Por padrão, apenas em uma linha vazia.
# Comentários em linha podem ser prejudiciais porque eles
# impedem os usuários de usar os caracteres delimitadores
# como partes dos valores.
# Isto posto, isso pode ser personalizado.

    [Seções Podem Ser Indentadas]
        podem_ser_valores_também = True
        isso_significa_algo_especial = False
        propósito = formatação para legibilidade
        valores_multilinha = são
            tratados sem problemas desde
            que eles estejam indentados
            mais profundamente do que a
            primeira linha de um valor
        # Mencionamos que também podemos indentar comentários?
@end example

@node Seções não nomeadas,Interpolação de valores,Estrutura dos arquivos INI,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser id10}@anchor{2c5d}@anchor{library/configparser unnamed-sections}@anchor{2c5e}
@subsubsection Seções não nomeadas


O nome da primeira seção (ou único) pode ser omitido e os valores recuperados pelo atributo @ref{2c5c,,UNNAMED_SECTION}.

@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 Interpolação de valores,Acesso através do protocolo de mapeamento,Seções não nomeadas,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser interpolation-of-values}@anchor{2c5f}
@subsubsection Interpolação de valores


Além da funcionalidade principal, @ref{1c8,,ConfigParser} oferece suporte a interpolação. Isso significa que os valores podem ser pré-processados antes de retorná-los das chamadas @code{get()}.

@geindex % (porcentagem);interpolação em arquivos de configuração

@geindex BasicInterpolation (classe em configparser)
@anchor{library/configparser configparser BasicInterpolation}@anchor{722}
@deffn {Classe} configparser.BasicInterpolation

A implementação padrão usada por @ref{1c8,,ConfigParser}. Ele permite que os valores contenham strings de formato que se referem a outros valores na mesma seção ou valores na seção padrão especial @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}. Valores padrão adicionais podem ser fornecidos na inicialização.

Por exemplo:

@example
[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack
my_pictures: %(my_dir)s/Pictures

[Escape]
# use um %% para escapar o sinal de % (% é o único caractere que precisa ser escapado):
gain: 80%%
@end example

No exemplo acima, @ref{1c8,,ConfigParser} com `interpolation' definido como @code{BasicInterpolation()} resolveria @code{%(home_dir)s} para o valor de @code{home_dir} (@code{/Users} neste caso). @code{%(my_dir)s} na verdade resolveria para @code{/Users/lumberjack}. Todas as interpolações são feitas sob demanda, portanto as chaves usadas na cadeia de referências não precisam ser especificadas em nenhuma ordem específica no arquivo de configuração.

Com @code{interpolation} definido como @code{None}, o analisador sintático simplesmente retornaria @code{%(my_dir)s/Pictures} como o valor de @code{my_pictures} e @code{%(home_dir)s/lumberjack} como o valor de @code{my_dir}.
@end deffn

@geindex $ (dólar);interpolação em arquivos de configuração

@geindex ExtendedInterpolation (classe em configparser)
@anchor{library/configparser configparser ExtendedInterpolation}@anchor{723}
@deffn {Classe} configparser.ExtendedInterpolation

Um manipulador alternativo para interpolação que implementa uma sintaxe mais avançada, usada, por exemplo, em @code{zc.buildout}. A interpolação estendida usa @code{$@{section:option@}} para denotar um valor de uma seção estrangeira. A interpolação pode abranger vários níveis. Por conveniência, se a parte @code{section:} for omitida, a interpolação será padronizada para a seção atual (e possivelmente para os valores padrão da seção especial).

Por exemplo, a configuração especificada acima com interpolação básica ficaria assim com interpolação estendida:

@example
[Paths]
home_dir: /Users
my_dir: $@{home_dir@}/lumberjack
my_pictures: $@{my_dir@}/Pictures

[Escape]
# use a $$ para escapar o sinal de $ ($ é o único caractere que precisa ser escapado):
cost: $$80
@end example

Valores de outras seções também podem ser obtidos:

@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 Acesso através do protocolo de mapeamento,Personalizando o comportamento do analisador sintático,Interpolação de valores,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser mapping-protocol-access}@anchor{2c54}
@subsubsection Acesso através do protocolo de mapeamento



Adicionado na versão 3.2.


Acesso através do protocolo de mapeamento é um nome genérico para funcionalidade que permite usar objetos personalizados como se fossem dicionários. No caso de @ref{22,,configparser}, a implementação da interface de mapeamento está usando a notação @code{parser['section']['option']}.

@code{parser['section']} em particular retorna um intermediário para os dados da seção no analisador sintático. Isso significa que os valores não são copiados, mas obtidos do analisador sintático original sob demanda. O que é ainda mais importante é que quando os valores são alterados em um intermediário de seção, eles são, na verdade, modificados no analisador sintático original.

Os objetos @ref{22,,configparser} se comportam o mais próximo possível dos dicionários reais. A interface de mapeamento é completa e segue a ABC @ref{10eb,,MutableMapping}. No entanto, existem algumas diferenças que devem ser levadas em consideração:


@itemize *

@item 
Por padrão, todas as chaves nas seções são acessíveis sem distinção entre maiúsculas e minúsculas @footnote{
Os analisadores sintáticos de configuração permitem muitas personalizações. Caso você tenha interesse em alterar o comportamento descrito na referência da nota de rodapé, consulte a seção @ref{2c55,,Personalizando o comportamento do analisador sintático}.
}. Por exemplo. @code{for option in parser["section"]} produz apenas nomes de chaves de opção @code{optionxform}ada. Isso significa chaves em letras minúsculas por padrão. Ao mesmo tempo, para uma seção que contém a chave @code{'a'}, ambas as expressões retornam @code{True}:

@example
"a" in parser["section"]
"A" in parser["section"]
@end example

@item 
Todas as seções também incluem valores @code{DEFAULTSECT}, o que significa que @code{.clear()} em uma seção não pode deixá-la visivelmente vazia. Isso ocorre porque os valores padrão não podem ser excluídos da seção (porque tecnicamente eles não estão lá). Se eles forem substituídos na seção, a exclusão fará com que o valor padrão fique visível novamente. Tentar excluir um valor padrão causa um @ref{344,,KeyError}.

@item 
@code{DEFAULTSECT} não pode ser removido do analisador sintático:


@itemize *

@item 
tentar excluí-lo levanta @ref{202,,ValueError},

@item 
@code{parser.clear()} deixa-o intacto,

@item 
@code{parser.popitem()} nunca o retorna.
@end itemize

@item 
@code{parser.get(section, option, **kwargs)} - o segundo argumento `não' é um valor substituto. Observe, entretanto, que os métodos @code{get()} em nível de seção são compatíveis tanto com o protocolo de mapeamento quanto com a API clássica do configparser.

@item 
@code{parser.items()} é compatível com o protocolo de mapeamento (retorna uma lista de pares `section_name', `section_proxy' incluindo o DEFAULTSECT). Entretanto, este método também pode ser invocado com argumentos: @code{parser.items(section, raw, vars)}. A última chamada retorna uma lista de pares `option', `value' para uma @code{section} especificada, com todas as interpolações expandidas (a menos que @code{raw=True} seja fornecido).
@end itemize

O protocolo de mapeamento é implementado sobre a API legada existente para que as subclasses que substituem a interface original ainda tenham mapeamentos funcionando conforme o esperado.

@node Personalizando o comportamento do analisador sintático,Exemplos de APIs legadas,Acesso através do protocolo de mapeamento,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser customizing-parser-behaviour}@anchor{2c55}
@subsubsection Personalizando o comportamento do analisador sintático


Existem quase tantas variantes de formato INI quanto aplicações que o utilizam. @ref{22,,configparser} percorre um longo caminho para fornecer suporte para o maior conjunto sensato de estilos INI disponíveis. A funcionalidade padrão é determinada principalmente pelo histórico e é muito provável que você queira personalizar alguns dos recursos.

A maneira mais comum de alterar a forma como um analisador sintático de configuração específico funciona é usar as opções @code{__init__()}:


@itemize *

@item 
`defaults', valor padrão: @code{None}

Esta opção aceita um dicionário de pares chave-valor que será inicialmente colocado na seção @code{DEFAULT}. Isso é uma maneira elegante de oferecer suporte a arquivos de configuração concisos que não especificam valores iguais ao padrão documentado.

Dica: se você deseja especificar valores padrão para uma seção específica, use @ref{2c60,,read_dict()} antes de ler o arquivo real.

@item 
`dict_type', valor padrão: @ref{256,,dict}

Esta opção tem um grande impacto no comportamento do protocolo de mapeamento e na aparência dos arquivos de configuração gravados. Com o dicionário padrão, cada seção é armazenada na ordem em que foram adicionadas ao analisador sintático. O mesmo vale para opções dentro das seções.

Um tipo de dicionário alternativo pode ser usado, por exemplo, para ordenar as seções e opções ao fazer `write-back'.

Observação: existem maneiras de adicionar um conjunto de pares de valores-chave em uma única operação. Quando você usa um dicionário regular nessas operações, a classificação das chaves será ordenada. Por exemplo:

@example
>>> parser = configparser.ConfigParser()
>>> parser.read_dict(@{'seção1': @{'chave1': 'valor1',
...                                'chave2': 'valor2',
...                                'chave3': 'valor3'@},
...                   'seção2': @{'chaveA': 'valorA',
...                                'chaveB': 'valorB',
...                                'chaveC': 'valorC'@},
...                   'seção3': @{'foo': 'x',
...                                'bar': 'y',
...                                'baz': 'z'@}
... @})
>>> parser.sections()
['seção1', 'seção2', 'seção3']
>>> [option for option in parser['seção3']]
['foo', 'bar', 'baz']
@end example

@item 
`allow_no_value', valor padrão: @code{False}

Alguns arquivos de configuração são conhecidos por incluir configurações sem valores, mas que de outra forma estão em conformidade com a sintaxe suportada por @ref{22,,configparser}. O parâmetro `allow_no_value' para o construtor pode ser usado para indicar que tais valores devem ser aceitos:

@example
>>> import configparser

>>> sample_config = """
... [mysqld]
...   user = mysql
...   pid-file = /var/run/mysqld/mysqld.pid
...   skip-external-locking
...   old_passwords = 1
...   skip-bdb
...   # não precisamos de ACID hoje
...   skip-innodb
... """
>>> config = configparser.ConfigParser(allow_no_value=True)
>>> config.read_string(sample_config)

>>> # Configurações com valores são tratados como antes:
>>> config["mysqld"]["user"]
'mysql'

>>> # Configurações sem valores fornecem None:
>>> config["mysqld"]["skip-bdb"]

>>> # Configurações que não são especificadas ainda levantam um erro:
>>> config["mysqld"]["não-existe"]
Traceback (most recent call last):
  ...
KeyError: 'não-existe'
@end example

@item 
`delimiters', valor padrão: @code{('=', ':')}

Delimitadores são substrings que delimitam chaves de valores dentro de uma seção. A primeira ocorrência de uma substring delimitadora em uma linha é considerada um delimitador. Isso significa que os valores (mas não as chaves) podem conter os delimitadores.

Veja também o argumento `space_around_delimiters' para @ref{2c61,,ConfigParser.write()}.

@item 
`comment_prefixes', valor padrão: @code{('#', ';')}

@item 
`inline_comment_prefixes', valor padrão: @code{None}

Prefixos de comentários são strings que indicam o início de um comentário válido em um arquivo de configuração. `comment_prefixes' são usados apenas em linhas vazias (opcionalmente indentadas), enquanto `inline_comment_prefixes' pode ser usado após cada valor válido (por exemplo, nomes de seções, opções e linhas vazias também). Por padrão, os comentários embutidos estão desabilitados e @code{'#'} e @code{';'} são usados como prefixos para comentários de linha inteira.


Alterado na versão 3.2: Nas versões anteriores do @ref{22,,configparser}, o comportamento correspondia a @code{comment_prefixes=('#',';')} e @code{inline_comment_prefixes=(';',)}.


Observe que os analisadores sintáticos de configuração não oferecem suporte a escape de prefixos de comentários, portanto, usar `inline_comment_prefixes' pode impedir que os usuários especifiquem valores de opção com caracteres usados como prefixos de comentários. Em caso de dúvida, evite definir `inline_comment_prefixes'. Em qualquer circunstância, a única maneira de armazenar caracteres de prefixo de comentário no início de uma linha em valores multilinha é interpolar o prefixo, por exemplo:

@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 padrão: @code{True}

Ao definir como @code{True}, o analisador sintático não permitirá nenhuma seção ou opção duplicada durante a leitura de uma única fonte (usando @ref{506,,read_file()}, @ref{2c62,,read_string()} ou @ref{2c60,,read_dict()}). Recomenda-se usar analisadores sintáticos estritos em novas aplicações.


Alterado na versão 3.2: Nas versões anteriores do @ref{22,,configparser}, o comportamento correspondia a @code{strict=False}.


@item 
`empty_lines_in_values', valor padrão: @code{True}

Em analisadores sintáticos de configuração, os valores podem abranger várias linhas, desde que sejam mais indentados do que a chave que os contém. Por padrão, os analisadores sintáticos também permitem que linhas vazias façam parte de valores. Ao mesmo tempo, as chaves podem ser indentados arbitrariamente para melhorar a legibilidade. Consequentemente, quando os arquivos de configuração ficam grandes e complexos, é fácil para o usuário perder o controle da estrutura do arquivo. Tomemos por exemplo:

@example
[Seção]
chave = multilinha
  valor com uma pegadinha

 esta = ainda é parte do valor multilinha de 'chave'
@end example

Isso pode ser especialmente problemático para o usuário ver se está usando uma fonte proporcional para editar o arquivo. É por isso que quando sua aplicação não precisa de valores com linhas vazias, você deve considerar proibi-los. Isso fará com que as linhas vazias dividam as chaves sempre. No exemplo acima, seriam produzidas duas chaves, @code{key} e @code{this}.

@item 
`default_section', valor padrão: @code{configparser.DEFAULTSECT} (isto é: @code{"DEFAULT"})

A convenção de permitir uma seção especial de valores padrão para outras seções ou fins de interpolação é um conceito poderoso desta biblioteca, permitindo aos usuários criar configurações declarativas complexas. Esta seção normalmente é chamada de @code{"DEFAULT"}, mas pode ser personalizada para apontar para qualquer outro nome de seção válido. Alguns valores típicos incluem: @code{"general"} ou @code{"common"}. O nome fornecido é usado para reconhecer seções padrão ao ler de qualquer fonte e é usado ao gravar a configuração em um arquivo. Seu valor atual pode ser recuperado usando o atributo @code{parser_instance.default_section} e pode ser modificado em tempo de execução (ou seja, para converter arquivos de um formato para outro).

@item 
`interpolation', valor padrão: @code{configparser.BasicInterpolation}

O comportamento de interpolação pode ser personalizado fornecendo um manipulador personalizado por meio do argumento `interpolation'. @code{None} pode ser usado para desligar completamente a interpolação, @code{ExtendedInterpolation()} fornece uma variante mais avançada inspirada em @code{zc.buildout}. Mais sobre o assunto na @ref{2c5f,,seção de documentação dedicada}. @ref{f98,,RawConfigParser} tem um valor padrão de @code{None}.

@item 
`converters', valor padrão: não definido

Os analisadores sintáticos de configuração fornecem getters de valor de opção que realizam conversão de tipo. Por padrão, @ref{2c58,,getint()}, @ref{2c59,,getfloat()} e @ref{2c57,,getboolean()} são implementados. Caso outros getters sejam desejáveis, os usuários podem defini-los em uma subclasse ou passar um dicionário onde cada chave é um nome do conversor e cada valor é um chamável que implementa a referida conversão. Por exemplo, passar @code{@{'decimal': decimal.Decimal@}} adicionaria @code{getdecimal()} no objeto analisador sintático e em todos os proxies de seção. Em outras palavras, será possível escrever @code{parser_instance.getdecimal('section', 'key', fallback=0)} e @code{parser_instance['section'].getdecimal('key', 0)}.

Se o conversor precisar acessar o estado do analisador sintático, ele poderá ser implementado como um método em uma subclasse do analisador sintático de configuração. Se o nome deste método começar com @code{get}, ele estará disponível em todos os intermediários de seção, na forma compatível com dict (veja o exemplo @code{getdecimal()} acima).
@end itemize

Uma personalização mais avançada pode ser obtida substituindo os valores padrão desses atributos do analisador sintático. Os padrões são definidos nas classes, portanto podem ser substituídos por subclasses ou por atribuição de atributos.

@geindex BOOLEAN_STATES (atributo configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser BOOLEAN_STATES}@anchor{2c63}
@deffn {Atributo} ConfigParser.BOOLEAN_STATES

Por padrão, ao usar @ref{2c57,,getboolean()}, os analisadores sintáticos de configuração consideram os seguintes valores @code{True}: @code{'1'}, @code{'yes'}, @code{'true'}, @code{'on'} e os seguintes valores @code{False}: @code{'0'}, @code{'no'}, @code{'false'}, @code{'off'}. Você pode substituir isso especificando um dicionário personalizado de strings e seus resultados booleanos. Por exemplo:

@example
>>> custom = configparser.ConfigParser()
>>> custom['seção1'] = @{'funky': 'nope'@}
>>> custom['seção1'].getboolean('funky')
Traceback (most recent call last):
...
ValueError: Not a boolean: nope
>>> custom.BOOLEAN_STATES = @{'sure': True, 'nope': False@}
>>> custom['seção1'].getboolean('funky')
False
@end example

Outros pares booleanos típicos incluem @code{accept}/@code{reject} ou @code{enabled}/@code{disabled}.
@end deffn


@deffn {Método} ConfigParser.optionxform (option)

Este método transforma nomes de opções em cada operação de leitura, obtenção ou definição. O padrão converte o nome em letras minúsculas. Isso também significa que quando um arquivo de configuração for gravado, todas as chaves estarão em letras minúsculas. Substitua esse método se for inadequado. Por exemplo:

@example
>>> config = """
... [Seção1]
... Chave = Valor
...
... [Seção2]
... OutraChave = Valor
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> list(typical['Seção1'].keys())
['chave']
>>> list(typical['Seção2'].keys())
['outrachave']
>>> custom = configparser.RawConfigParser()
>>> custom.optionxform = lambda option: option
>>> custom.read_string(config)
>>> list(custom['Seção1'].keys())
['Chave']
>>> list(custom['Seção2'].keys())
['OutraChave']
@end example

@cartouche
@quotation Nota 
A função optionxform transforma nomes de opções em um formato canônico. Esta deve ser uma função idempotente: se o nome já estiver na forma canônica, deverá ser retornado inalterado.
@end quotation
@end cartouche
@end deffn

@geindex SECTCRE (atributo configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser SECTCRE}@anchor{2c5b}
@deffn {Atributo} ConfigParser.SECTCRE

Uma expressão regular compilada usada para analisar cabeçalhos de seção. O padrão corresponde a @code{[section]} para o nome @code{"section"}. O espaço em branco é considerado parte do nome da seção, portanto @code{[  larch  ]} será lido como uma seção de nome @code{"  larch  "}. Substitua esse atributo se for inadequado. Por exemplo:

@example
>>> import re
>>> config = """
... [Seção 1]
... opção = valor
...
... [  Seção 2  ]
... outro = valor
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> typical.sections()
['Seção 1', '  Seção 2  ']
>>> custom = configparser.ConfigParser()
>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
>>> custom.read_string(config)
>>> custom.sections()
['Seção 1', 'Seção 2']
@end example

@cartouche
@quotation Nota 
Embora os objetos ConfigParser também usem um atributo @code{OPTCRE} para reconhecer linhas de opção, não é recomendado substituí-lo porque isso interferiria nas opções do construtor `allow_no_value' e `delimiters'.
@end quotation
@end cartouche
@end deffn

@node Exemplos de APIs legadas,Objetos ConfigParser,Personalizando o comportamento do analisador sintático,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser legacy-api-examples}@anchor{2c64}
@subsubsection Exemplos de APIs legadas


Principalmente por questões de compatibilidade com versões anteriores, @ref{22,,configparser} fornece também uma API legada com métodos @code{get}/@code{set} explícitos. Embora existam casos de uso válidos para os métodos descritos abaixo, o acesso ao protocolo de mapeamento é preferido para novos projetos. A API legada é às vezes mais avançada, de baixo nível e totalmente contraintuitiva.

Um exemplo de escrita em um arquivo de configuração:

@example
import configparser

config = configparser.RawConfigParser()

# Observe que usando as funções set do RawConfigParser, você pode atribuir
# valores não string a chaves internamente, mas receberá um erro ao tentar
# gravar em um arquivo ou quando obtê-lo em modo não bruta. Definir valores
# usando o protocolo de mapeamento ou set() do ConfigParser não permite que
# tais atribuições ocorram.
config.add_section('Seção1')
config.set('Seção1', 'an_int', '15')
config.set('Seção1', 'a_bool', 'true')
config.set('Seção1', 'a_float', '3.1415')
config.set('Seção1', 'baz', 'divertido')
config.set('Seção1', 'bar', 'Python')
config.set('Seção1', 'foo', '%(bar)s é %(baz)s!')

# Escrevendo nosso arquivo de configuração em 'example.cfg'
with open('example.cfg', 'w') as configfile:
    config.write(configfile)
@end example

Um exemplo de leitura do arquivo de configuração novamente:

@example
import configparser

config = configparser.RawConfigParser()
config.read('example.cfg')

# getfloat() levanta uma exceção se o valor não for um ponto flutuante
# getint() e getboolean() também fazem isso para seus respectivos tipos
a_float = config.getfloat('Seção1', 'a_float')
an_int = config.getint('Seção1', 'an_int')
print(a_float + an_int)

# Note que a próxima saída não interpola '%(bar)s' ou '%(baz)s'.
# Isso ocorre porque estamos usando RawConfigParser().
if config.getboolean('Seção1', 'a_bool'):
    print(config.get('Seção1', 'foo'))
@end example

Para obter interpolação, use @ref{1c8,,ConfigParser}:

@example
import configparser

cfg = configparser.ConfigParser()
cfg.read('example.cfg')

# Defina o argumento *raw* opcional de get() para True se você quiser desabilitar
# interpolação em uma única operação de get.
print(cfg.get('Seção1', 'foo', raw=False))  # -> "Python é divertido!"
print(cfg.get('Seção1', 'foo', raw=True))   # -> "%(bar)s é %(baz)s!"

# O argumento opcional *vars* é um dicionário com membros que vão aceitar
# precedência na interpolação.
print(cfg.get('Seção1', 'foo', vars=@{'bar': 'Documentação',
                                       'baz': 'maligna'@}))

# The optional *fallback* argument can be used to provide a fallback value
print(cfg.get('Seção1', 'foo'))
      # -> "Python é divertido!"

print(cfg.get('Seção1', 'foo', fallback='Monty não é.'))
      # -> "Python é divertido!"

print(cfg.get('Seção1', 'monstro', fallback='Não existem monstros.'))
      # -> "Não existem monstros."

# Um print(cfg.get('Seção1', 'monster')) levantaria NoOptionError,
# mas nós também podemos usar:

print(cfg.get('Seção1', 'mosntro', fallback=None))
      # -> None
@end example

Os valores padrão estão disponíveis em ambos os tipos de ConfigParsers. Eles são usados em interpolação se uma opção usada não estiver definida em outro lugar.

@example
import configparser

# Nova instância com 'bar' e 'baz' padrão para 'A vida' e 'difícil' cada
config = configparser.ConfigParser(@{'bar': 'A vida', 'baz': 'difícil'@})
config.read('example.cfg')

print(config.get('Seção1', 'foo'))     # -> "Python é divertido!"
config.remove_option('Seção1', 'bar')
config.remove_option('Seção1', 'baz')
print(config.get('Seção1', 'foo'))     # -> "A vida é difícil!"
@end example

@node Objetos ConfigParser,Objetos RawConfigParser,Exemplos de APIs legadas,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser configparser-objects}@anchor{2c65}@anchor{library/configparser id13}@anchor{2c66}
@subsubsection Objetos ConfigParser


@geindex ConfigParser (classe em configparser)
@anchor{library/configparser configparser ConfigParser}@anchor{1c8}
@deffn {Classe} 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)

O principal analisador sintático de configuração. Quando `defaults' é fornecido, ele é inicializado no dicionário de padrões intrínsecos. Quando `dict_type' for fornecido, ele será usado para criar os objetos dicionário para a lista de seções, para as opções dentro de uma seção e para os valores padrão.

Quando `delimiters' são fornecidos, eles são usados como o conjunto de substrings que dividem chaves de valores. Quando `comment_prefixes' for fornecido, ele será usado como o conjunto de substrings que prefixam comentários em linhas vazias. Os comentários podem ser indentados. Quando `inline_comment_prefixes' for fornecido, ele será usado como o conjunto de substrings que prefixam comentários em linhas não vazias.

Quando `strict' for @code{True} (o padrão), o analisador sintático não permitirá nenhuma seção ou opção duplicada durante a leitura de uma única fonte (arquivo, string ou dicionário), levantando @ref{12b0,,DuplicateSectionError} ou @ref{12b1,,DuplicateOptionError}. Quando `empty_lines_in_values' é @code{False} (padrão: @code{True}), cada linha vazia marca o fim de uma opção. Caso contrário, as linhas vazias internas de uma opção multilinha serão mantidas como parte do valor. Quando `allow_no_value' for @code{True} (padrão: @code{False}), opções sem valores serão aceitas; o valor mantido para estes é @code{None} e eles são serializados sem o delimitador final.

Quando `default_section' é fornecido, ele especifica o nome da seção especial que contém valores padrão para outras seções e propósitos de interpolação (normalmente chamada de @code{"DEFAULT"}). Este valor pode ser recuperado e alterado em tempo de execução usando o atributo de instância @code{default_section}. Isso não reavaliará um arquivo de configuração já analisado, mas será usado ao escrever configurações analisadas em um novo arquivo de configuração.

O comportamento de interpolação pode ser personalizado fornecendo um manipulador personalizado por meio do argumento `interpolation'. @code{None} pode ser usado para desligar completamente a interpolação, @code{ExtendedInterpolation()} fornece uma variante mais avançada inspirada em @code{zc.buildout}. Mais sobre o assunto na @ref{2c5f,,seção de documentação dedicada}.

Todos os nomes de opções usados na interpolação serão passados através do método @ref{2c67,,optionxform()} assim como qualquer outra referência de nome de opção. Por exemplo, usando a implementação padrão de @ref{2c67,,optionxform()} (que converte nomes de opções para letras minúsculas), os valores @code{foo %(bar)s} e @code{foo %(BAR)s} são equivalentes.

Quando `converters' é fornecido, deve ser um dicionário onde cada chave representa o nome de um conversor de tipo e cada valor é um chamável implementando a conversão de string para o tipo de dados desejado. Cada conversor obtém seu próprio método @code{get*()} correspondente no objeto analisador sintático e nos intermediários de seção.

Quando `allow_unnamed_section' é @code{True} (padrão: @code{False}), o primeiro nome da seção pode ser omitido. Veja a seção @ref{2c5e,,"Seções não nomeadas"}.

É possível ler diversas configurações para um único @ref{1c8,,ConfigParser}, onde a configuração adicionada mais recentemente terá a maior prioridade. Para quaisquer chaves repetidas serão usados os valores da configuração mais recente, enquanto os valores das chaves anteriores serão ignorados. O exemplo a seguir lê um arquivo chamado @code{override.ini}, que irá substituir chaves repetidas do arquivo @code{example.ini}.

@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


Alterado na versão 3.1: O padrão `dict_type' é @ref{5db,,collections.OrderedDict}.



Alterado na versão 3.2: `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' e `interpolation' foram adicionados.



Alterado na versão 3.5: O argumento `converters' foi adicionado.



Alterado na versão 3.7: O argumento `defaults' é lido com @ref{2c60,,read_dict()}, fornecendo um comportamento consistente em todo o analisador: chaves e valores que não são de string são convertidos implicitamente em strings.



Alterado na versão 3.8: O `dict_type' padrão é @ref{256,,dict}, pois agora preserva a ordem de inserção.



Alterado na versão 3.13: Levanta @ref{2c68,,MultilineContinuationError} quando `allow_no_value' for @code{True}, e uma chave sem valor continua com uma linha indentada.



Alterado na versão 3.13: O argumento `allow_unnamed_section' foi adicionado.


@geindex defaults() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser defaults}@anchor{2c69}
@deffn {Método} defaults ()

Retorna um dicionário contendo os padrões de toda a instância.
@end deffn

@geindex sections() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser sections}@anchor{2c6a}
@deffn {Método} sections ()

Retorna uma lista das seções disponíveis; a `seção padrão' não está incluída na lista.
@end deffn

@geindex add_section() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser add_section}@anchor{12af}
@deffn {Método} add_section (section)

Adiciona uma seção de nome `section' à instância. Se já existir uma seção com o nome fornecido, @ref{12b0,,DuplicateSectionError} será levantada. Se o nome da `seção padrão' for passado, @ref{202,,ValueError} será levantada. O nome da seção deve ser uma string; caso contrário, @ref{2c3,,TypeError} será levantada.


Alterado na versão 3.2: Nomes de seções sem string levantam @ref{2c3,,TypeError}.

@end deffn

@geindex has_section() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser has_section}@anchor{2c6b}
@deffn {Método} has_section (section)

Indica se a `section' nomeada está presente na configuração. A `seção padrão' não é reconhecida.
@end deffn

@geindex options() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser options}@anchor{2c6c}
@deffn {Método} options (section)

Retorna uma lista de opções disponíveis na `section' especificada.
@end deffn

@geindex has_option() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser has_option}@anchor{2c6d}
@deffn {Método} has_option (section, option)

Se a `section' fornecida existir e contiver a `option' fornecida, retorna @ref{c27,,True}; caso contrário, retorna @ref{b49,,False}. Se a `section' especificada for @ref{675,,None} ou uma string vazia, DEFAULT será presumido.
@end deffn

@geindex read() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read}@anchor{14b0}
@deffn {Método} read (filenames, encoding=None)

Tenta ler e analisar um iterável de nomes de arquivos, retornando uma lista de nomes de arquivos que foram analisados com sucesso.

Se `filenames' for uma string, um objeto @ref{1c2,,bytes} ou um @ref{2a0,,objeto caminho ou similar}, este parâmetro será tratado como um único nome de arquivo. Se um arquivo nomeado em `filenames' não puder ser aberto, esse arquivo será ignorado. Isso foi projetado para que você possa especificar um iterável de possíveis locais de arquivo de configuração (por exemplo, o diretório atual, o diretório inicial do usuário e algum diretório de todo o sistema) e todos os arquivos de configuração existentes no iterável serão lidos.

Se nenhum dos arquivos nomeados existir, a instância @ref{1c8,,ConfigParser} conterá um conjunto de dados vazio. Uma aplicação que requer que valores iniciais sejam carregados de um arquivo deve carregar o arquivo ou arquivos necessários usando @ref{506,,read_file()} antes de chamar @ref{14b0,,read()} para quaisquer arquivos opcionais:

@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


Alterado na versão 3.2: Adicionado o parâmetro `encoding'. Anteriormente, todos os arquivos eram lidos usando a codificação padrão para @ref{51c,,open()}.



Alterado na versão 3.6.1: O parâmetro `filenames' aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: O parâmetro `filenames' aceita um objeto @ref{1c2,,bytes}.

@end deffn

@geindex read_file() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_file}@anchor{506}
@deffn {Método} read_file (f, source=None)

Lê e analisa dados de configuração de `f' que devem ser iteráveis, produzindo strings Unicode (por exemplo, arquivos abertos em modo texto).

O argumento opcional `source' especifica o nome do arquivo que está sendo lido. Se não for fornecido e `f' tiver um atributo @code{name}, que é usado para `source'; o padrão é @code{'<???>'}.


Adicionado na versão 3.2: Substitui @code{readfp()}.

@end deffn

@geindex read_string() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_string}@anchor{2c62}
@deffn {Método} read_string (string, source='<string>')

Analisa dados de configuração de uma string.

O argumento opcional `source' especifica um nome específico do contexto da string passada. Se não for fornecido, @code{'<string>'} será usado. Geralmente deve ser um caminho do sistema de arquivos ou uma URL.


Adicionado na versão 3.2.

@end deffn

@geindex read_dict() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser read_dict}@anchor{2c60}
@deffn {Método} read_dict (dictionary, source='<dict>')

Carrega a configuração de qualquer objeto que forneça um método @code{items()} dict ou similar. Chaves são nomes de seções, valores são dicionários com chaves e valores que devem estar presentes na seção. Se o tipo de dicionário usado preservar a ordem, as seções e suas chaves serão adicionadas em ordem. Os valores são convertidos automaticamente em strings.

O argumento opcional `source' especifica um nome específico do contexto do dicionário passado. Se não for fornecido, @code{<dict>} será usado.

Este método pode ser usado para copiar o estado entre analisadores sintáticos.


Adicionado na versão 3.2.

@end deffn

@geindex get() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser get}@anchor{12ad}
@deffn {Método} get (section, option, *, raw=False, vars=None[, fallback])

Obtém um valor de `option' para a `section' nomeada. Se `vars' for fornecido, deverá ser um dicionário. A `option' é pesquisada em `vars' (se fornecido), `section' e em `DEFAULTSECT' nesta ordem. Se a chave não for encontrada e `fallback' for fornecido, ele será usado como um valor alternativo. @code{None} pode ser fornecido como um valor `fallback'.

Todas as interpolações @code{'%'} são expandidas nos valores de retorno, a menos que o argumento `raw' seja verdadeiro. Os valores das chaves de interpolação são consultados da mesma maneira que a opção.


Alterado na versão 3.2: Os argumentos `raw', `vars' e `fallback' são palavras somente-nomeadas para proteger os usuários de tentarem usar o terceiro argumento como substituto `fallback' (especialmente ao usar o protocolo de mapeamento).

@end deffn

@geindex getint() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getint}@anchor{2c58}
@deffn {Método} getint (section, option, *, raw=False, vars=None[, fallback])

Um método de conveniência que força a `option' na `section' especificada ser um número inteiro. Veja @ref{12ad,,get()} para explicação de `raw', `vars' e `fallback'.
@end deffn

@geindex getfloat() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getfloat}@anchor{2c59}
@deffn {Método} getfloat (section, option, *, raw=False, vars=None[, fallback])

Um método de conveniência que força a `option' na `section' especificada ser um número de ponto flutuante. Veja @ref{12ad,,get()} para explicação de `raw', `vars' e `fallback'.
@end deffn

@geindex getboolean() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser getboolean}@anchor{2c57}
@deffn {Método} getboolean (section, option, *, raw=False, vars=None[, fallback])

Um método de conveniência que força a `option' na `section' especificada a um valor booleano. Observe que os valores aceitos para a opção são @code{'1'}, @code{'yes'}, @code{'true'}, e @code{'on'}, o que fazem com que este método retorne @code{True}, e @code{'0'}, @code{'no'}, @code{'false'}, e @code{'off'}, o que fazem com que ele retorne @code{False}. Esses valores de string são verificados sem distinção entre maiúsculas e minúsculas. Qualquer outro valor fará com que ele levante @ref{202,,ValueError}. Veja @ref{12ad,,get()} para explicação de `raw', `vars' e `fallback'.
@end deffn

@geindex items() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser items}@anchor{2c6e}
@deffn {Método} items (raw=False, vars=None)

@deffnx {Método} items (section, raw=False, vars=None)

Quando `section' não é fornecido, retorna uma lista de pares `section_name', `section_proxy', incluindo DEFAULTSECT.

Caso contrário, retorna uma lista de pares `name', `value' para as opções na `section' fornecida. Argumentos opcionais têm o mesmo significado do método @ref{12ad,,get()}.


Alterado na versão 3.8: Os itens presentes em `vars' não aparecem mais no resultado. O comportamento anterior misturava opções reais do analisador sintático com variáveis fornecidas para interpolação.

@end deffn

@geindex set() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser set}@anchor{12ae}
@deffn {Método} set (section, option, value)

Se a seção fornecida existir, defina a opção fornecida com o valor especificado; caso contrário, levanta @ref{2c6f,,NoSectionError}. `option' e `value' devem ser strings; caso contrário, @ref{2c3,,TypeError} será levantada.
@end deffn

@geindex write() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser write}@anchor{2c61}
@deffn {Método} write (fileobject, space_around_delimiters=True)

Escreve uma representação da configuração no @ref{1203,,objeto arquivo} especificado, que deve ser aberto em modo texto (aceitando strings). Esta representação pode ser analisada por uma futura chamada @ref{14b0,,read()}. Se `space_around_delimiters' for verdadeiro, os delimitadores entre chaves e valores serão envoltos por espaços.
@end deffn

@cartouche
@quotation Nota 
Os comentários no arquivo de configuração original não são preservados ao escrever a configuração. O que é considerado um comentário depende dos valores fornecidos para `comment_prefix' e `inline_comment_prefix'.
@end quotation
@end cartouche

@geindex remove_option() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser remove_option}@anchor{2c70}
@deffn {Método} remove_option (section, option)

Remove a `option' especificada da `section' especificada. Se a seção não existir, levanta @ref{2c6f,,NoSectionError}. Se existisse a opção de ser removida, retorna @ref{c27,,True}; caso contrário, retorna @ref{b49,,False}.
@end deffn

@geindex remove_section() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser remove_section}@anchor{2c71}
@deffn {Método} remove_section (section)

Remove a `section' especificada da configuração. Se a seção de fato existiu, retorna @code{True}. Caso contrário, retorna @code{False}.
@end deffn

@geindex optionxform() (método configparser.ConfigParser)
@anchor{library/configparser configparser ConfigParser optionxform}@anchor{2c67}
@deffn {Método} optionxform (option)

Transforma o nome da opção `option' conforme encontrado em um arquivo de entrada ou conforme passado pelo código do cliente no formato que deve ser usado nas estruturas internas. A implementação padrão retorna uma versão em minúsculas de `option'; subclasses podem substituir isso ou o código do cliente pode definir um atributo com esse nome nas instâncias para afetar esse comportamento.

Você não precisa criar uma subclasse do analisador sintático para usar esse método; você também pode configurá-lo em uma instância, para uma função que recebe um argumento de string e retorna uma string. Definir como @code{str}, por exemplo, faria com que sejam diferenciadas as letras maiúsculas das minúsculas nos nomes das opções:

@example
cfgparser = ConfigParser()
cfgparser.optionxform = str
@end example

Observe que ao ler arquivos de configuração, os espaços em branco ao redor dos nomes das opções são removidos antes de @ref{2c67,,optionxform()} ser chamado.
@end deffn
@end deffn

@geindex UNNAMED_SECTION (no módulo configparser)
@anchor{library/configparser configparser UNNAMED_SECTION}@anchor{2c5c}
@deffn {Dado} configparser.UNNAMED_SECTION

Um objeto especial que representa um nome de seção usado para referenciar a seção sem nome (veja @ref{2c5e,,Seções não nomeadas}).
@end deffn

@geindex MAX_INTERPOLATION_DEPTH (no módulo configparser)
@anchor{library/configparser configparser MAX_INTERPOLATION_DEPTH}@anchor{2c72}
@deffn {Dado} configparser.MAX_INTERPOLATION_DEPTH

A profundidade máxima para interpolação recursiva para @ref{12ad,,get()} quando o parâmetro `raw' é falso. Isso é relevante apenas quando a `interpolation' padrão é usada.
@end deffn

@node Objetos RawConfigParser,Exceções<8>,Objetos ConfigParser,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser id15}@anchor{2c73}@anchor{library/configparser rawconfigparser-objects}@anchor{2c74}
@subsubsection Objetos RawConfigParser


@geindex RawConfigParser (classe em configparser)
@anchor{library/configparser configparser RawConfigParser}@anchor{f98}
@deffn {Classe} 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 legada do @ref{1c8,,ConfigParser}. Ela tem a interpolação desabilitada por padrão e permite nomes de seções não-string, nomes de opções e valores através de seus métodos inseguros @code{add_section} e @code{set}, bem como o tratamento de argumentos nomeados legados @code{defaults=} .


Alterado na versão 3.2: `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' e `interpolation' foram adicionados.



Alterado na versão 3.5: O argumento `converters' foi adicionado.



Alterado na versão 3.8: O `dict_type' padrão é @ref{256,,dict}, pois agora preserva a ordem de inserção.



Alterado na versão 3.13: O argumento `allow_unnamed_section' foi adicionado.


@cartouche
@quotation Nota 
Considere usar @ref{1c8,,ConfigParser}, que verifica os tipos de valores a serem armazenados internamente. Se você não quiser interpolação, você pode usar @code{ConfigParser(interpolation=None)}.
@end quotation
@end cartouche

@geindex add_section() (método configparser.RawConfigParser)
@anchor{library/configparser configparser RawConfigParser add_section}@anchor{2c75}
@deffn {Método} add_section (section)

Adiciona uma seção chamada `section' à instância. Se já existir uma seção com o nome fornecido, @ref{12b0,,DuplicateSectionError} será levantada. Se o nome da `seção padrão' for passado, @ref{202,,ValueError} será levantada.

O tipo da `section' não está marcado, o que permite aos usuários criar seções nomeadas sem string. Este comportamento não é compatível e pode causar erros internos.
@end deffn

@geindex set() (método configparser.RawConfigParser)
@anchor{library/configparser configparser RawConfigParser set}@anchor{2c76}
@deffn {Método} set (section, option, value)

Se a seção fornecida existir, defina a opção fornecida com o valor especificado; caso contrário, levanta @ref{2c6f,,NoSectionError}. Embora seja possível usar @ref{f98,,RawConfigParser} (ou @ref{1c8,,ConfigParser} com parâmetros `raw' definidos como verdadeiro) para armazenamento `interno' de valores não-string, funcionalidade completa (incluindo interpolação e saída para arquivos) só pode ser alcançado usando valores de string.

Este método permite que os usuários atribuam valores não-string às chaves internamente. Este comportamento não é suportado e causará erros ao tentar escrever em um arquivo ou obtê-lo no modo não bruto. `Use a API do protocolo de mapeamento' que não permite que tais atribuições ocorram.
@end deffn
@end deffn

@node Exceções<8>,,Objetos RawConfigParser,configparser — Analisador sintático de arquivo de configuração
@anchor{library/configparser exceptions}@anchor{2c77}
@subsubsection Exceções


@geindex Error
@anchor{library/configparser configparser Error}@anchor{2c78}
@deffn {Exceção} configparser.Error

Classe base para todas as outras exceções do @ref{22,,configparser}.
@end deffn

@geindex NoSectionError
@anchor{library/configparser configparser NoSectionError}@anchor{2c6f}
@deffn {Exceção} configparser.NoSectionError

Exceção levantada quando uma seção especificada não é encontrada.
@end deffn

@geindex DuplicateSectionError
@anchor{library/configparser configparser DuplicateSectionError}@anchor{12b0}
@deffn {Exceção} configparser.DuplicateSectionError

Exceção levantada se @ref{12af,,add_section()} for chamado com o nome de uma seção que já está presente ou em analisadores sintáticos estritos quando uma seção for encontrada mais de uma vez em um único arquivo de entrada, string ou dicionário.


Alterado na versão 3.2: Adicionados os atributos e parâmetros opcionais `source' e `lineno' a @code{__init__()}.

@end deffn

@geindex DuplicateOptionError
@anchor{library/configparser configparser DuplicateOptionError}@anchor{12b1}
@deffn {Exceção} configparser.DuplicateOptionError

Exceção levantada por analisadores sintáticos estritos se uma única opção aparecer duas vezes durante a leitura de um único arquivo, string ou dicionário. Isso detecta erros ortográficos e erros relacionados a diferenciação de letras maiúsculas e minúsculas como, p. ex., um dicionário pode ter duas chaves representando a mesma chave de configuração que não diferencia maiúsculas de minúsculas.
@end deffn

@geindex NoOptionError
@anchor{library/configparser configparser NoOptionError}@anchor{2c79}
@deffn {Exceção} configparser.NoOptionError

Exceção levantada quando uma opção especificada não é encontrada na seção especificada.
@end deffn

@geindex InterpolationError
@anchor{library/configparser configparser InterpolationError}@anchor{2c7a}
@deffn {Exceção} configparser.InterpolationError

Classe base para exceções levantadas quando ocorrem problemas ao executar a interpolação de strings.
@end deffn

@geindex InterpolationDepthError
@anchor{library/configparser configparser InterpolationDepthError}@anchor{2c7b}
@deffn {Exceção} configparser.InterpolationDepthError

Exceção levantada quando a interpolação de string não pode ser concluída porque o número de iterações excede @ref{2c72,,MAX_INTERPOLATION_DEPTH}. Subclasse de @ref{2c7a,,InterpolationError}.
@end deffn

@geindex InterpolationMissingOptionError
@anchor{library/configparser configparser InterpolationMissingOptionError}@anchor{2c7c}
@deffn {Exceção} configparser.InterpolationMissingOptionError

Exceção levantada quando uma opção referenciada a partir de um valor não existe. Subclasse de @ref{2c7a,,InterpolationError}.
@end deffn

@geindex InterpolationSyntaxError
@anchor{library/configparser configparser InterpolationSyntaxError}@anchor{2c7d}
@deffn {Exceção} configparser.InterpolationSyntaxError

Exceção levantada quando o texto fonte no qual são feitas as substituições não está em conformidade com a sintaxe exigida. Subclasse de @ref{2c7a,,InterpolationError}.
@end deffn

@geindex MissingSectionHeaderError
@anchor{library/configparser configparser MissingSectionHeaderError}@anchor{2c7e}
@deffn {Exceção} configparser.MissingSectionHeaderError

Exceção levantada ao tentar analisar um arquivo que não possui cabeçalhos de seção.
@end deffn

@geindex ParsingError
@anchor{library/configparser configparser ParsingError}@anchor{505}
@deffn {Exceção} configparser.ParsingError

Exceção levantada quando ocorrem erros ao tentar analisar um arquivo.


Alterado na versão 3.12: O atributo @code{filename} e o argumento do construtor @code{__init__()} foram removidos. Eles estiveram disponíveis usando o nome @code{source} desde 3.2.

@end deffn

@geindex MultilineContinuationError
@anchor{library/configparser configparser MultilineContinuationError}@anchor{2c68}
@deffn {Exceção} configparser.MultilineContinuationError

Exceção levantada quando uma chave sem valor correspondente continua com uma linha indentada.


Adicionado na versão 3.13.

@end deffn

@node tomllib — Analisa arquivos TOML,netrc — Arquivo de processamento netrc,configparser — Analisador sintático de arquivo de configuração,Formatos de Arquivo
@anchor{library/tomllib doc}@anchor{2c7f}@anchor{library/tomllib module-tomllib}@anchor{fc}@anchor{library/tomllib tomllib-parse-toml-files}@anchor{2c80}@anchor{library/tomllib translation-repo}@anchor{2c81}
@subsection @code{tomllib} — Analisa arquivos TOML


@geindex module; tomllib


Adicionado na versão 3.11.


`Código-fonte:' Lib/tomllib@footnote{https://github.com/python/cpython/tree/3.13/Lib/tomllib}


__________________________________________________________________


Este módulo fornece uma interface para analisar TOML 1.0.0 (Tom’s Obvious Minimal Language, https://toml.io@footnote{https://toml.io/pt/}). Este módulo não oferece suporte para escrever TOML.


@subsubheading Ver também


O pacote Tomli-W@footnote{https://pypi.org/project/tomli-w/} é um editor de TOML que pode ser usado em conjunto com este módulo, fornecendo uma API de escrita familiar aos usuários da biblioteca padrão: módulos @ref{8d,,marshal} e @ref{a6,,pickle}.



@subsubheading Ver também


O pacote TOML Kit@footnote{https://pypi.org/project/tomlkit/} é uma biblioteca TOML de preservação de estilo com capacidade de leitura e escrita. É uma substituição recomendada para este módulo para edição de arquivos TOML já existentes.


Este módulo define as seguintes funções:

@geindex load() (no módulo tomllib)
@anchor{library/tomllib tomllib load}@anchor{2c82}
@deffn {Função} tomllib.load (fp, /, *, parse_float=float)

Lê um arquivo TOML. O primeiro argumento deve ser um objeto arquivo binário e legível. Retorna um @ref{256,,dict}. Converte tipos TOML para Python usando esta @ref{2c83,,tabela de conversão}.

`parse_float' será chamado com a string de cada ponto flutuante (float) do TOML a ser decodificado. Por padrão, isso é equivalente a @code{float(num_str)}. Isso pode ser usado para usar outro tipo de dados ou analisador sintático para pontos flutuantes do TOML (por exemplo, @ref{29d,,decimal.Decimal}). O chamável não deve retornar um @ref{256,,dict} ou um @ref{611,,list}, senão uma exceção @ref{202,,ValueError} é levantada.

Uma exceção @ref{2c84,,TOMLDecodeError} será levantada no caso de um documento TOML inválido.
@end deffn

@geindex loads() (no módulo tomllib)
@anchor{library/tomllib tomllib loads}@anchor{2c85}
@deffn {Função} tomllib.loads (s, /, *, parse_float=float)

Carrega TOML de um objeto @ref{44c,,str}. Retorna um @ref{256,,dict}. Converte tipos TOML para Python usando esta @ref{2c83,,tabela de conversão}. O argumento `parse_float' tem o mesmo significado que em @ref{2c82,,load()}.

Uma exceção @ref{2c84,,TOMLDecodeError} será levantada no caso de um documento TOML inválido.
@end deffn

As seguintes exceções estão disponíveis:

@geindex TOMLDecodeError
@anchor{library/tomllib tomllib TOMLDecodeError}@anchor{2c84}
@deffn {Exceção} tomllib.TOMLDecodeError

Subclasse de @ref{202,,ValueError}.
@end deffn

@menu
* Exemplos: Exemplos<11>. 
* Tabela de conversão:: 

@end menu

@node Exemplos<11>,Tabela de conversão,,tomllib — Analisa arquivos TOML
@anchor{library/tomllib examples}@anchor{2c86}
@subsubsection Exemplos


Analisando um arquivo TOML:

@example
import tomllib

with open("pyproject.toml", "rb") as f:
    data = tomllib.load(f)
@end example

Analisando uma string TOML:

@example
import tomllib

toml_str = """
python-version = "3.11.0"
python-implementation = "CPython"
"""

data = tomllib.loads(toml_str)
@end example

@node Tabela de conversão,,Exemplos<11>,tomllib — Analisa arquivos TOML
@anchor{library/tomllib conversion-table}@anchor{2c87}
@subsubsection Tabela de conversão

@anchor{library/tomllib toml-to-py-table}@anchor{2c83}

@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

TOML

@tab

Python

@item

documento TOML

@tab

dict

@item

string

@tab

str

@item

inteiro

@tab

int

@item

ponto flutuante

@tab

ponto flutuante (configurável com `parse_float')

@item

booleano

@tab

bool

@item

deslocamento de data-hora

@tab

datetime.datetime (atributo de @code{tzinfo} definido com uma instância de @code{datetime.timezone})

@item

data-hora local

@tab

datetime.datetime (atributo de @code{tzinfo} definido com @code{None})

@item

data local

@tab

datetime.date

@item

hora local

@tab

datetime.time

@item

array

@tab

lista

@item

tabela

@tab

dict

@item

tabela inline

@tab

dict

@item

array de tabelas

@tab

lista de dicionários

@end multitable


@node netrc — Arquivo de processamento netrc,plistlib — Gera e analisa arquivos Apple plist,tomllib — Analisa arquivos TOML,Formatos de Arquivo
@anchor{library/netrc doc}@anchor{2c88}@anchor{library/netrc module-netrc}@anchor{9b}@anchor{library/netrc netrc-netrc-file-processing}@anchor{2c89}@anchor{library/netrc translation-repo}@anchor{2c8a}
@subsection @code{netrc} — Arquivo de processamento netrc


@geindex module; netrc

`Código-fonte:' Lib/netrc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/netrc.py}


__________________________________________________________________


A classe @ref{1a05,,netrc} analisa e encapsula o formato do arquivo netrc usado pelo programa Unix @code{ftp} e outros clientes FTP.

@geindex netrc (classe em netrc)
@anchor{library/netrc netrc netrc}@anchor{1a05}
@deffn {Classe} netrc.netrc ([file])

Uma instância ou instância de subclasse de @ref{1a05,,netrc} encapsula dados de um arquivo netrc. O argumento de inicialização, se presente, especifica o arquivo a ser analisado. Se nenhum argumento for fornecido, o arquivo @code{.netrc} no diretório inicial do usuário – conforme determinado por @ref{a1e,,os.path.expanduser()} – será lido. Caso contrário, uma exceção @ref{42b,,FileNotFoundError} será levantada. Os erros de análise levantam @ref{2c8b,,NetrcParseError} com informações de diagnóstico, incluindo o nome do arquivo, o número da linha e o token final.

Se nenhum argumento for especificado em um sistema POSIX, a presença de senhas no arquivo @code{.netrc} levantará um @ref{2c8b,,NetrcParseError} se a propriedade ou as permissões do arquivo forem inseguras (pertencentes a um usuário que não seja o usuário executando o processo ou acessível para leitura ou gravação por qualquer outro usuário). Isso implementa um comportamento de segurança equivalente ao do ftp e de outros programas que usam @code{.netrc}. Essas verificações de segurança não estão disponíveis em plataformas que não oferecem suporte a @ref{1612,,os.getuid()}.


Alterado na versão 3.4: Adicionada a verificação de permissão POSIX.



Alterado na versão 3.7: @ref{a1e,,os.path.expanduser()} é usado para encontrar a localização do arquivo @code{.netrc} quando `file' não é passado como argumento.



Alterado na versão 3.10: @ref{9b,,netrc} tenta a codificação UTF-8 antes de usar a codificação específica da localidade. A entrada no arquivo netrc não precisa mais conter todos os tokens. O valor padrão dos tokens ausentes é uma string vazia. Todos os tokens e seus valores agora podem conter caracteres arbitrários, como espaços em branco e caracteres não ASCII. Se o nome de login for anônimo, ele não acionará a verificação de segurança.

@end deffn

@geindex NetrcParseError
@anchor{library/netrc netrc NetrcParseError}@anchor{2c8b}
@deffn {Exceção} netrc.NetrcParseError

Exceção levantada pela classe @ref{1a05,,netrc} quando erros sintáticos são encontrados no texto fonte. As instâncias desta exceção fornecem três atributos interessantes:

@geindex msg (atributo netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError msg}@anchor{2c8c}
@deffn {Atributo} msg

Explicação textual do erro.
@end deffn

@geindex filename (atributo netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError filename}@anchor{2c8d}
@deffn {Atributo} filename

O nome do arquivo de origem.
@end deffn

@geindex lineno (atributo netrc.NetrcParseError)
@anchor{library/netrc netrc NetrcParseError lineno}@anchor{2c8e}
@deffn {Atributo} lineno

O número da linha em que o erro foi encontrado.
@end deffn
@end deffn

@menu
* Objetos netrc:: 

@end menu

@node Objetos netrc,,,netrc — Arquivo de processamento netrc
@anchor{library/netrc id1}@anchor{2c8f}@anchor{library/netrc netrc-objects}@anchor{2c90}
@subsubsection Objetos netrc


Uma instância da classe @ref{1a05,,netrc} tem os seguintes métodos:

@geindex authenticators() (método netrc.netrc)
@anchor{library/netrc netrc netrc authenticators}@anchor{2c91}
@deffn {Método} netrc.authenticators (host)

Retorna uma tupla de 3 elementos @code{(login, conta, senha)} dos autenticadores do `host'. Se o arquivo netrc não contém uma entrada para o host dado, retorna a tupla associada com a entrada padrão. Se não houver nenhum host correspondente nem uma entrada padrão estiver disponível, retorna @code{None}.
@end deffn

@geindex __repr__() (método netrc.netrc)
@anchor{library/netrc netrc netrc __repr__}@anchor{2c92}
@deffn {Método} netrc.__repr__ ()

Despeja os dados da classe como uma string no formato de um arquivo netrc. (Isso descarta os comentários e pode reordenar as entradas.)
@end deffn

Instâncias de @ref{1a05,,netrc} possuem variáveis de instância públicas:

@geindex hosts (atributo netrc.netrc)
@anchor{library/netrc netrc netrc hosts}@anchor{2c93}
@deffn {Atributo} netrc.hosts

Dicionário mapeando nomes de host para tuplas @code{(login, conta, senha)}. A entrada `default', se houver, é representada como um pseudo-host por esse nome.
@end deffn

@geindex macros (atributo netrc.netrc)
@anchor{library/netrc netrc netrc macros}@anchor{2c94}
@deffn {Atributo} netrc.macros

Dicionário mapeando nomes de macros para listas de strings.
@end deffn

@node plistlib — Gera e analisa arquivos Apple plist,,netrc — Arquivo de processamento netrc,Formatos de Arquivo
@anchor{library/plistlib doc}@anchor{2c95}@anchor{library/plistlib module-plistlib}@anchor{ab}@anchor{library/plistlib plistlib-generate-and-parse-apple-plist-files}@anchor{2c96}@anchor{library/plistlib translation-repo}@anchor{2c97}
@subsection @code{plistlib} — Gera e analisa arquivos Apple @code{.plist}


@geindex module; plistlib

@c (harvested from docstrings in the original file)

`Código-fonte:' Lib/plistlib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/plistlib.py}

@geindex plist;arquivo
@geindex lista de propriedades


__________________________________________________________________


Este módulo fornece uma interface para ler e escrever os arquivos “property listas (lista de propriedades) usados pela Apple, principalmente no macOS e iOS. Este módulo tem suporte a arquivos plist binários e XML.

O formato de arquivo de lista de propriedades (@code{.plist}) é uma serialização simples que oferece suporte a tipos básicos de objetos, como dicionários, listas, números e strings. Normalmente, o objeto de nível superior é um dicionário.

Para escrever e analisar um arquivo plist, use as funções @ref{958,,dump()} e @ref{956,,load()}.

Para trabalhar com dados plist em objetos bytes ou string, use @ref{959,,dumps()} e @ref{957,,loads()}.

Os valores podem ser strings, inteiros, floats, booleanos, tuplas, listas, dicionários (mas somente com chaves de string), objetos @ref{1c2,,bytes}, @ref{2ea,,bytearray} ou @ref{1cc,,datetime.datetime}.


Alterado na versão 3.4: Nova API, API antiga descontinuada. Suporte para plists de formato binário adicionado.



Alterado na versão 3.8: Adicionado suporte para leitura e escrita de tokens @ref{a2b,,UID} em plists binários, conforme usado por NSKeyedArchiver e NSKeyedUnarchiver.



Alterado na versão 3.9: API antiga removida.



@subsubheading Ver também



@table @asis

@item Pagina de manual de PList@footnote{https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/PropertyLists/}

Documentação da Apple sobre o formato de arquivo.
@end table


Este módulo define as seguintes funções:

@geindex load() (no módulo plistlib)
@anchor{library/plistlib plistlib load}@anchor{956}
@deffn {Função} plistlib.load (fp, *, fmt=None, dict_type=dict, aware_datetime=False)

Lê um arquivo plist. `fp' deve ser um objeto arquivo binário e legível. Retorna o objeto raiz desempacotado (que geralmente é um dicionário).

`fmt' é o formato do arquivo e os seguintes valores são válidos:


@itemize *

@item 
@ref{675,,None}: Detecta automaticamente o formato do arquivo

@item 
@ref{fad,,FMT_XML}: Formato de arquivo XML

@item 
@ref{fae,,FMT_BINARY}: Formato binário plist
@end itemize

O `dict_type' é o tipo usado para dicionários que são lidos do arquivo plist.

Quando `aware_datetime' for verdadeiro, campos com o tipo @code{datetime.datetime} serão criados como @ref{25c8,,objeto conscientes}, com @code{tzinfo} como @ref{4ee,,datetime.UTC}.

Dados XML para o formato @ref{fad,,FMT_XML} são analisados usando o analisador sintático Expat de @ref{126,,xml.parsers.expat} – veja sua documentação para possíveis exceções em XML malformado. Elementos desconhecidos serão simplesmente ignorados pelo analisador de plist.

O analisador sintático levanta @ref{1a87,,InvalidFileException} quando o arquivo não pode ser analisado.


Adicionado na versão 3.4.



Alterado na versão 3.13: O parâmetro somente-nomeado `aware_datetime' foi adicionado.

@end deffn

@geindex loads() (no módulo plistlib)
@anchor{library/plistlib plistlib loads}@anchor{957}
@deffn {Função} plistlib.loads (data, *, fmt=None, dict_type=dict, aware_datetime=False)

Carrega um plist de um objeto bytes ou string. Veja @ref{956,,load()} para uma explicação dos argumentos nomeados.


Adicionado na versão 3.4.



Alterado na versão 3.13: `data' pode ser uma string quando `fmt' é igual a @ref{fad,,FMT_XML}.

@end deffn

@geindex dump() (no módulo plistlib)
@anchor{library/plistlib plistlib dump}@anchor{958}
@deffn {Função} plistlib.dump (value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

Escreve `value' em um arquivo plist. `fp' deve ser um objeto arquivo binário gravável.

O argumento `fmt' especifica o formato do arquivo plist e pode ser um dos seguintes valores:


@itemize *

@item 
@ref{fad,,FMT_XML}: Arquivo plist formatado em XML

@item 
@ref{fae,,FMT_BINARY}: Arquivo plist formatado em binário
@end itemize

Quando `sort_keys' é verdadeiro (o padrão), as chaves dos dicionários serão escritas ordenadas no plist, caso contrário, elas serão escritas na ordem de iteração do dicionário.

Quando `skipkeys' é falso (o padrão), a função levanta @ref{2c3,,TypeError} quando uma chave de um dicionário não é uma string, caso contrário, tais chaves são ignoradas.

Quando `aware_datetime' é verdadeiro e qualquer campo com o tipo @code{datetime.datetime} é definido como um @ref{25c8,,objeto consciente}, ele será convertido para o fuso horário UTC antes de escrevê-lo.

Uma @ref{2c3,,TypeError} será levantada se o objeto for de um tipo não suportado ou um contêiner que contém objetos de tipos não suportados.

Uma @ref{885,,OverflowError} será levantada para valores inteiros que não podem ser representados em arquivos plist (binários).


Adicionado na versão 3.4.



Alterado na versão 3.13: O parâmetro somente-nomeado `aware_datetime' foi adicionado.

@end deffn

@geindex dumps() (no módulo plistlib)
@anchor{library/plistlib plistlib dumps}@anchor{959}
@deffn {Função} plistlib.dumps (value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

Retorna `value' como um objeto bytes formatado em plist. Veja a documentação para @ref{958,,dump()} para uma explicação dos argumentos nomeados desta função.


Adicionado na versão 3.4.

@end deffn

As seguintes classes estão disponíveis:

@geindex UID (classe em plistlib)
@anchor{library/plistlib plistlib UID}@anchor{a2b}
@deffn {Classe} plistlib.UID (data)

Envolve um @ref{257,,int}. Isso é usado ao ler ou escrever dados codificados NSKeyedArchiver, que contém UID (veja o manual de PList).

@geindex data (atributo plistlib.UID)
@anchor{library/plistlib plistlib UID data}@anchor{2c98}
@deffn {Atributo} data

Valor inteiro do UID. Deve estar no intervalo @code{0 <= data < 2**64}.
@end deffn


Adicionado na versão 3.8.

@end deffn

As seguintes constantes estão disponíveis:

@geindex FMT_XML (no módulo plistlib)
@anchor{library/plistlib plistlib FMT_XML}@anchor{fad}
@deffn {Dado} plistlib.FMT_XML

O formato XML para arquivos plist.


Adicionado na versão 3.4.

@end deffn

@geindex FMT_BINARY (no módulo plistlib)
@anchor{library/plistlib plistlib FMT_BINARY}@anchor{fae}
@deffn {Dado} plistlib.FMT_BINARY

O formato binário para arquivos plist


Adicionado na versão 3.4.

@end deffn

O módulo define as seguintes exceções:

@geindex InvalidFileException
@anchor{library/plistlib plistlib InvalidFileException}@anchor{1a87}
@deffn {Exceção} plistlib.InvalidFileException

Levantada quando um arquivo não puder ser analisado.


Adicionado na versão 3.4.

@end deffn

@menu
* Exemplos: Exemplos<12>. 

@end menu

@node Exemplos<12>,,,plistlib — Gera e analisa arquivos Apple plist
@anchor{library/plistlib examples}@anchor{2c99}
@subsubsection Exemplos


Gerando um 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

Analisando um 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 Serviços Criptográficos,Serviços Genéricos do Sistema Operacional,Formatos de Arquivo,A Biblioteca Padrão do Python
@anchor{library/crypto doc}@anchor{2c9a}@anchor{library/crypto crypto}@anchor{2c9b}@anchor{library/crypto cryptographic-services}@anchor{2c9c}@anchor{library/crypto translation-repo}@anchor{2c9d}
@section Serviços Criptográficos


@geindex criptografia

Os módulos descritos neste capítulo implementam vários algoritmos de uma natureza criptográfica. Eles estão disponíveis a critério da instalação. Aqui está uma visão geral:

@menu
* hashlib — Resumos de mensagens e hashes seguros:: 
* hmac — Código de autenticação de mensagem com chave hash:: 
* secrets — Gera números aleatórios seguros para gerenciar segredos:: 

@end menu

@node hashlib — Resumos de mensagens e hashes seguros,hmac — Código de autenticação de mensagem com chave hash,,Serviços Criptográficos
@anchor{library/hashlib doc}@anchor{2c9e}@anchor{library/hashlib hashlib-secure-hashes-and-message-digests}@anchor{2c9f}@anchor{library/hashlib module-hashlib}@anchor{68}
@subsection @code{hashlib} — Resumos de mensagens e hashes seguros


@geindex module; hashlib

`Código-fonte:' Lib/hashlib.py@footnote{https://github.com/python/cpython/tree/3.13/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


__________________________________________________________________


Este módulo implementa uma interface comum para diversos algoritmos de hash. Estão incluídos os algoritmos de hash seguros FIPS SHA224, SHA256, SHA384 e SHA512 (definidos no padrão FIPS 180-4@footnote{https://csrc.nist.gov/pubs/fips/180-4/upd1/final}), a série SHA-3 (definida no padrão FIPS 202@footnote{https://csrc.nist.gov/pubs/fips/202/final}), bem como os algoritmos legados SHA1 (anteriormente parte do FIPS@footnote{https://csrc.nist.gov/news/2023/decision-to-revise-fips-180-4}) e o algoritmo MD5 (definido em internet 
@geindex RFC; RFC 1321
RFC 1321@footnote{https://datatracker.ietf.org/doc/html/rfc1321.html}).

@cartouche
@quotation Nota 
Se você quiser as funções de hash adler32 ou crc32, elas estão disponíveis no módulo @ref{133,,zlib}.
@end quotation
@end cartouche

@menu
* Algoritmos de hash:: 
* Uso:: 
* Construtores:: 
* Atributos:: 
* Objetos hash:: 
* Resumos de comprimento variável de SHAKE:: 
* Hash de arquivo:: 
* Derivação de chave:: 
* BLAKE2:: 

@end menu

@node Algoritmos de hash,Uso,,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib hash-algorithms}@anchor{2ca0}@anchor{library/hashlib id1}@anchor{2ca1}
@subsubsection Algoritmos de hash


Há um método construtor nomeado para cada tipo de `hash'. Todos retornam um objeto hash com a mesma interface simples. Por exemplo: use @ref{164a,,sha256()} para criar um objeto hash SHA-256. Agora você pode alimentar este objeto com @ref{d4f,,objetos bytes ou similares} (normalmente @ref{1c2,,bytes}) usando o método @ref{2ca2,,update}. A qualquer momento, você pode solicitar o `digest' da concatenação dos dados alimentados até o momento usando os métodos @ref{2ca3,,digest()} ou @ref{2ca4,,hexdigest()}.

Para permitir multithreading, a @ref{159,,GIL} do Python é liberada ao calcular um hash fornecido com mais de 2047 bytes de dados de uma só vez em seu construtor ou método @ref{2ca2,,.update}.

@geindex OpenSSL;(use in module hashlib)

Os construtores para algoritmos de hash sempre presentes neste módulo são @ref{2ca5,,sha1()}, @ref{2ca6,,sha224()}, @ref{164a,,sha256()}, @ref{2ca7,,sha384()}, @ref{2ca8,,sha512()}, @ref{cc2,,sha3_224()}, @ref{cc3,,sha3_256()}, @ref{cc4,,sha3_384()}, @ref{cc5,,sha3_512()}, @ref{cc6,,shake_128()}, @ref{cc7,,shake_256()}, @ref{642,,blake2b()} e @ref{643,,blake2s()}. @ref{1626,,md5()} normalmente também está disponível, embora possa estar ausente ou bloqueado se você estiver usando uma construção rara do Python “compatível com FIPS”. Eles correspondem a @ref{13ba,,algorithms_guaranteed}.

Algoritmos adicionais também podem estar disponíveis se o @ref{68,,hashlib} da sua distribuição Python tiver sido vinculado a uma construção do OpenSSL que forneça outros algoritmos. Outros `não têm garantia de disponibilidade' em todas as instalações e só serão acessíveis pelo nome via @ref{1abb,,new()}. Consulte @ref{13bb,,algorithms_available}.

@cartouche
@quotation Aviso 
Alguns algoritmos apresentam vulnerabilidades conhecidas em colisões de hash (incluindo MD5 e SHA1). Consulte Ataques a algoritmos de hash criptográficos@footnote{https://en.wikipedia.org/wiki/Cryptographic_hash_function#Attacks_on_cryptographic_hash_algorithms} e a seção @ref{2ca9,,hashlib-seealso} no final deste documento.
@end quotation
@end cartouche


Adicionado na versão 3.6: Os construtores SHA3 (Keccak) e SHAKE @ref{cc2,,sha3_224()}, @ref{cc3,,sha3_256()}, @ref{cc4,,sha3_384()}, @ref{cc5,,sha3_512()}, @ref{cc6,,shake_128()}, @ref{cc7,,shake_256()} foram adicionados. @ref{642,,blake2b()} e @ref{643,,blake2s()} foram adicionados.

@anchor{library/hashlib hashlib-usedforsecurity}@anchor{2caa}

Alterado na versão 3.9: Todos os construtores de hashlib aceitam um argumento somente-nomeado `usedforsecurity' com o valor padrão @code{True}. Um valor falso permite o uso de algoritmos de hash inseguros e bloqueados em ambientes restritos. @code{False} indica que o algoritmo de hash não é usado em um contexto de segurança, por exemplo, como uma função de compressão unidirecional não criptográfica.



Alterado na versão 3.9: O hashlib agora usa SHA3 e SHAKE do OpenSSL, se ele os fornecer.



Alterado na versão 3.12: Para qualquer um dos algoritmos MD5, SHA1, SHA2 ou SHA3 que o OpenSSL vinculado não fornece, recorremos a uma implementação verificada do projeto HACL*@footnote{https://github.com/hacl-star/hacl-star}.


@node Uso,Construtores,Algoritmos de hash,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib usage}@anchor{2cab}
@subsubsection Uso


Para obter o resumo da string de bytes @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

Mais condensado:

@example
>>> hashlib.sha256(b"Nobody inspects the spammish repetition").hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@node Construtores,Atributos,Uso,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib constructors}@anchor{2cac}
@subsubsection Construtores


@geindex new() (no módulo hashlib)
@anchor{library/hashlib hashlib new}@anchor{1abb}
@deffn {Função} hashlib.new (name[, data], *, usedforsecurity=True)

É um construtor genérico que recebe a string `name' do algoritmo desejado como seu primeiro parâmetro. Ele também existe para permitir acesso aos hashes listados acima, bem como a quaisquer outros algoritmos que sua biblioteca OpenSSL possa oferecer.
@end deffn

Usando @ref{1abb,,new()} com um nome de algoritmo:

@example
>>> h = hashlib.new('sha256')
>>> h.update(b"Nobody inspects the spammish repetition")
>>> h.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@geindex md5() (no módulo hashlib)
@anchor{library/hashlib hashlib md5}@anchor{1626}
@deffn {Função} hashlib.md5 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha1() (no módulo hashlib)
@anchor{library/hashlib hashlib sha1}@anchor{2ca5}
@deffn {Função} hashlib.sha1 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha224() (no módulo hashlib)
@anchor{library/hashlib hashlib sha224}@anchor{2ca6}
@deffn {Função} hashlib.sha224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha256() (no módulo hashlib)
@anchor{library/hashlib hashlib sha256}@anchor{164a}
@deffn {Função} hashlib.sha256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha384() (no módulo hashlib)
@anchor{library/hashlib hashlib sha384}@anchor{2ca7}
@deffn {Função} hashlib.sha384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha512() (no módulo hashlib)
@anchor{library/hashlib hashlib sha512}@anchor{2ca8}
@deffn {Função} hashlib.sha512 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_224() (no módulo hashlib)
@anchor{library/hashlib hashlib sha3_224}@anchor{cc2}
@deffn {Função} hashlib.sha3_224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_256() (no módulo hashlib)
@anchor{library/hashlib hashlib sha3_256}@anchor{cc3}
@deffn {Função} hashlib.sha3_256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_384() (no módulo hashlib)
@anchor{library/hashlib hashlib sha3_384}@anchor{cc4}
@deffn {Função} hashlib.sha3_384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_512() (no módulo hashlib)
@anchor{library/hashlib hashlib sha3_512}@anchor{cc5}
@deffn {Função} hashlib.sha3_512 ([data], *, usedforsecurity=True)
@end deffn

Construtores nomeados como esses são mais rápidos do que passar um nome de algoritmo para @ref{1abb,,new()}.

@node Atributos,Objetos hash,Construtores,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib attributes}@anchor{2cad}
@subsubsection Atributos


O hashlib fornece os seguintes atributos de módulo constantes:

@geindex algorithms_guaranteed (no módulo hashlib)
@anchor{library/hashlib hashlib algorithms_guaranteed}@anchor{13ba}
@deffn {Dado} hashlib.algorithms_guaranteed

Um conjunto contendo os nomes dos algoritmos de hash com suporte garantido por este módulo em todas as plataformas. Observe que “md5” está nesta lista, apesar de alguns fornecedores originais oferecerem uma estranha construção Python “compatível com FIPS” que o exclui.


Adicionado na versão 3.2.

@end deffn

@geindex algorithms_available (no módulo hashlib)
@anchor{library/hashlib hashlib algorithms_available}@anchor{13bb}
@deffn {Dado} hashlib.algorithms_available

Um conjunto contendo os nomes dos algoritmos de hash disponíveis no interpretador Python em execução. Esses nomes serão reconhecidos quando passados para @ref{1abb,,new()}. @ref{13ba,,algorithms_guaranteed} sempre será um subconjunto. O mesmo algoritmo pode aparecer várias vezes neste conjunto com nomes diferentes (graças ao OpenSSL).


Adicionado na versão 3.2.

@end deffn

@node Objetos hash,Resumos de comprimento variável de SHAKE,Atributos,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib hash-objects}@anchor{2cae}
@subsubsection Objetos hash


Os seguintes valores são fornecidos como atributos constantes dos objetos hash retornados pelos construtores:

@geindex hash.digest_size (no módulo hashlib)
@anchor{library/hashlib hashlib hash digest_size}@anchor{2caf}
@deffn {Dado} hash.digest_size

O tamanho do hash resultante em bytes.
@end deffn

@geindex hash.block_size (no módulo hashlib)
@anchor{library/hashlib hashlib hash block_size}@anchor{2cb0}
@deffn {Dado} hash.block_size

O tamanho do bloco interna do algoritmo de hash em bytes.
@end deffn

Um objeto hash tem os seguintes atributos:

@geindex name (atributo hashlib.hash)
@anchor{library/hashlib hashlib hash name}@anchor{f7b}
@deffn {Atributo} hash.name

O nome canônico deste hash, sempre em minúsculas e sempre adequado como parâmetro para @ref{1abb,,new()} para criar outro hash deste tipo.


Alterado na versão 3.4: O atributo name está presente no CPython desde o seu início, mas até o Python 3.4 não era especificado formalmente, então pode não existir em algumas plataformas.

@end deffn

Um objeto hash tem os seguintes métodos:

@geindex update() (método hashlib.hash)
@anchor{library/hashlib hashlib hash update}@anchor{2ca2}
@deffn {Método} hash.update (data)

Atualiza o objeto hash com o @ref{d4f,,objeto bytes ou similar}. Chamadas repetidas são equivalentes a uma única chamada com a concatenação de todos os argumentos: @code{m.update(a); m.update(b)} é equivalente a @code{m.update(a+b)}.
@end deffn

@geindex digest() (método hashlib.hash)
@anchor{library/hashlib hashlib hash digest}@anchor{2ca3}
@deffn {Método} hash.digest ()

Retorna o resumo dos dados passados ao método @ref{2ca2,,update()} até o momento. Este é um objeto bytes de tamanho @ref{2caf,,digest_size} que pode conter bytes em todo o intervalo de 0 a 255.
@end deffn

@geindex hexdigest() (método hashlib.hash)
@anchor{library/hashlib hashlib hash hexdigest}@anchor{2ca4}
@deffn {Método} hash.hexdigest ()

Similar a @ref{2ca3,,digest()}, exceto que o resumo é retornado como um objeto string de comprimento duplo, contendo apenas dígitos hexadecimais. Isso pode ser usado para trocar o valor com segurança em e-mails ou outros ambientes não binários.
@end deffn

@geindex copy() (método hashlib.hash)
@anchor{library/hashlib hashlib hash copy}@anchor{2cb1}
@deffn {Método} hash.copy ()

Retorna uma cópia (“clone”) do objeto hash. Isso pode ser usado para calcular com eficiência os resumos de dados que compartilham uma substring inicial comum.
@end deffn

@node Resumos de comprimento variável de SHAKE,Hash de arquivo,Objetos hash,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib shake-variable-length-digests}@anchor{2cb2}
@subsubsection Resumos de comprimento variável de SHAKE


@geindex shake_128() (no módulo hashlib)
@anchor{library/hashlib hashlib shake_128}@anchor{cc6}
@deffn {Função} hashlib.shake_128 ([data], *, usedforsecurity=True)
@end deffn

@geindex shake_256() (no módulo hashlib)
@anchor{library/hashlib hashlib shake_256}@anchor{cc7}
@deffn {Função} hashlib.shake_256 ([data], *, usedforsecurity=True)
@end deffn

Os algoritmos @ref{cc6,,shake_128()} e @ref{cc7,,shake_256()} fornecem resumos de comprimento variável com length_in_bits//2 de até 128 ou 256 bits de segurança. Portanto, seus métodos de resumo exigem um comprimento. O comprimento máximo não é limitado pelo algoritmo SHAKE.

@geindex digest() (método hashlib.shake)
@anchor{library/hashlib hashlib shake digest}@anchor{1bb1}
@deffn {Método} shake.digest (length)

Retorna o resumo dos dados passados ao método @ref{2ca2,,update()} até o momento. Este é um objeto bytes de tamanho `length' que pode conter bytes em todo o intervalo de 0 a 255.
@end deffn

@geindex hexdigest() (método hashlib.shake)
@anchor{library/hashlib hashlib shake hexdigest}@anchor{1bb2}
@deffn {Método} shake.hexdigest (length)

Similar a @ref{1bb1,,digest()}, exceto que o resumo é retornado como um objeto string de comprimento duplo, contendo apenas dígitos hexadecimais. Isso pode ser usado para trocar o valor em e-mails ou outros ambientes não binários.
@end deffn

Exemplo de uso:

@example
>>> h = hashlib.shake_256(b'Nobody inspects the spammish repetition')
>>> h.hexdigest(20)
'44709d6fcb83d92a76dcb0b668c98e1b1d3dafe7'
@end example

@node Hash de arquivo,Derivação de chave,Resumos de comprimento variável de SHAKE,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib file-hashing}@anchor{2cb3}
@subsubsection Hash de arquivo


O módulo hashlib fornece uma função auxiliar para hash eficiente de um objeto arquivo ou similar.

@geindex file_digest() (no módulo hashlib)
@anchor{library/hashlib hashlib file_digest}@anchor{644}
@deffn {Função} hashlib.file_digest (fileobj, digest, /)

Retorna um objeto resumo que foi atualizado com o conteúdo do objeto arquivo.

`fileobj' deve ser um objeto arquivo ou similar aberto para leitura em modo binário. Ele aceita objetos arquivo da @ref{51c,,open()} embutida, instâncias de @ref{ed3,,BytesIO}, objetos SocketIO de @ref{11de,,socket.socket.makefile()} e similares. `fileobj' deve ser aberto em modo bloqueante, caso contrário, uma exceção @ref{1090,,BlockingIOError} pode ser levantada.

A função pode ignorar a E/S do Python e usar o descritor de arquivo de @ref{15d0,,fileno()} diretamente. `fileobj' deve ser presumido como sendo um estado desconhecido após o retorno ou o levantamento desta função. Cabe a quem a chamou fechar `fileobj'.

`digest' deve ser um nome de algoritmo de hash como `str', um construtor de hash ou um chamável que retorna um objeto de hash.

Exemplo:

@example
>>> import io, hashlib, hmac
>>> with open("library/hashlib.rst", "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


Adicionado na versão 3.11.



Alterado na versão 3.13.4: Agora levanta uma @ref{1090,,BlockingIOError} se o arquivo for aberto em modo não-bloqueante. Anteriormente, bytes nulos espúrios eram adicionados ao resumo.

@end deffn

@node Derivação de chave,BLAKE2,Hash de arquivo,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib key-derivation}@anchor{2cb4}
@subsubsection Derivação de chave


Algoritmos de alongamento de chave e derivação de chave são projetados para criar hashes de senhas seguros. Algoritmos ingênuos como @code{sha1(password)} não são resistentes a ataques de força bruta. Uma boa função de hashing de senhas deve ser ajustável, lenta e incluir um salt@footnote{https://pt.wikipedia.org/wiki/Sal_(criptografia)}.

@geindex pbkdf2_hmac() (no módulo hashlib)
@anchor{library/hashlib hashlib pbkdf2_hmac}@anchor{50f}
@deffn {Função} hashlib.pbkdf2_hmac (hash_name, password, salt, iterations, dklen=None)

A função fornece a função 2 de derivação de chave baseada em senha PKCS#5. Ela usa HMAC como função pseudoaleatória.

A string `hash_name' é o nome desejado do algoritmo de resumo de hash para HMAC, por exemplo, ‘sha1’ ou ‘sha256’. `password' e `salt' são interpretados como buffers de bytes. Aplicações e bibliotecas devem limitar `password' a um comprimento razoável (por exemplo, 1024). `salt' deve ter cerca de 16 bytes ou mais de uma fonte adequada, por exemplo, @ref{523,,os.urandom()}.

O número de `iterations' deve ser escolhido com base no algoritmo de hash e no poder computacional. A partir de 2022, centenas de milhares de iterações do SHA-256 são sugeridas. Para entender por que e como escolher o que é melhor para sua aplicação, leia o `Appendix A.2.2' do NIST-SP-800-132@footnote{https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf}. As respostas à pergunta sobre iterações de pbkdf2 no StackExchange@footnote{https://security.stackexchange.com/questions/3959/recommended-of-iterations-when-using-pbkdf2-sha256/} explicam em detalhes.

`dklen' é o comprimento da chave derivada em bytes. Se `dklen' for @code{None}, o tamanho do resumo do algoritmo de hash `hash_name' será usado, por exemplo, 64 para 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

Função disponível somente quando Python é compilado com OpenSSL.


Adicionado na versão 3.4.



Alterado na versão 3.12: Função agora disponível apenas quando o Python é criado com OpenSSL. A implementação lenta do Python puro foi removida.

@end deffn

@geindex scrypt() (no módulo hashlib)
@anchor{library/hashlib hashlib scrypt}@anchor{c59}
@deffn {Função} hashlib.scrypt (password, *, salt, n, r, p, maxmem=0, dklen=64)

A função fornece a função de derivação de chave baseada em senha scrypt, conforme definido em 
@geindex RFC; RFC 7914
RFC 7914@footnote{https://datatracker.ietf.org/doc/html/rfc7914.html}.

`password' e `salt' devem ser @ref{d4f,,objetos bytes ou similares}. Aplicações e bibliotecas devem limitar `password' a um tamanho razoável (por exemplo, 1024). `salt' deve ter cerca de 16 bytes ou mais de uma fonte adequada, por exemplo, @ref{523,,os.urandom()}.

`n' é o fator de custo de CPU/memória, `r' o tamanho do bloco, `p' o fator de paralelismo e `maxmem' limita a memória (o padrão do OpenSSL 1.1.0 é 32 MiB). `dklen' é o comprimento da chave derivada em bytes.


Adicionado na versão 3.6.

@end deffn

@node BLAKE2,,Derivação de chave,hashlib — Resumos de mensagens e hashes seguros
@anchor{library/hashlib blake2}@anchor{2cb5}@anchor{library/hashlib hashlib-blake2}@anchor{1f17}
@subsubsection BLAKE2


@geindex blake2b@comma{} blake2s

BLAKE2@footnote{https://www.blake2.net} é uma função hash criptográfica definida em 
@geindex RFC; RFC 7693
RFC 7693@footnote{https://datatracker.ietf.org/doc/html/rfc7693.html} que vem em dois sabores:


@itemize *

@item 
`BLAKE2b', otimizado para plataformas de 64 bits e produz resumos de qualquer tamanho entre 1 e 64 bytes,

@item 
`BLAKE2s', otimizado para plataformas de 8 a 32 bits e produz resumos de qualquer tamanho entre 1 e 32 bytes.
@end itemize

BLAKE2 supports `keyed mode' (a faster and simpler replacement for HMAC@footnote{https://en.wikipedia.org/wiki/Hash-based_message_authentication_code}),
`salted hashing', `personalization', and `tree hashing'.

Os objetos hash deste módulo seguem a API dos objetos @ref{68,,hashlib} da biblioteca padrão.

@menu
* Criando objetos hash:: 
* Constantes: Constantes<5>. 
* Exemplos: Exemplos<13>. 
* Credits:: 

@end menu

@node Criando objetos hash,Constantes<5>,,BLAKE2
@anchor{library/hashlib creating-hash-objects}@anchor{2cb6}
@subsubsection Criando objetos hash


Novos objetos hash são criados chamando funções construtoras:

@geindex blake2b() (no módulo hashlib)
@anchor{library/hashlib hashlib blake2b}@anchor{642}
@deffn {Função} 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() (no módulo hashlib)
@anchor{library/hashlib hashlib blake2s}@anchor{643}
@deffn {Função} 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

Essas funções retornam os objetos hash correspondentes para calcular BLAKE2b ou BLAKE2s. Opcionalmente, elas aceitam estes parâmetros gerais:


@itemize *

@item 
`data': pedaço inicial de dados para hash, que deve ser @ref{d4f,,objeto bytes ou similar}. Pode ser passado apenas como argumento posicional.

@item 
`digest_size': tamanho do resumo de saída em bytes.

@item 
`key': chave para hash com chave (até 64 bytes para BLAKE2b, até 32 bytes para BLAKE2s).

@item 
`salt': sal para hash aleatório (até 16 bytes para BLAKE2b, até 8 bytes para BLAKE2s).

@item 
`person': string de personalização (até 16 bytes para BLAKE2b, até 8 bytes para BLAKE2s).
@end itemize

A tabela a seguir mostra os limites para parâmetros gerais (em bytes):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Hash

@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 
BLAKE2 specification defines constant lengths for salt and personalization
parameters, however, for convenience, this implementation accepts byte
strings of any size up to the specified length. If the length of the
parameter is less than specified, it is padded with zeros, thus, for
example, @code{b'salt'} and @code{b'salt\x00'} is the same value. (This is not
the case for `key'.)
@end quotation
@end cartouche

These sizes are available as module @ref{2cb7,,constants} described below.

Constructor functions also accept the following tree hashing parameters:


@itemize *

@item 
`fanout': fanout (0 to 255, 0 if unlimited, 1 in sequential mode).

@item 
`depth': maximal depth of tree (1 to 255, 255 if unlimited, 1 in
sequential mode).

@item 
`leaf_size': maximal byte length of leaf (0 to @code{2**32-1}, 0 if unlimited or in
sequential mode).

@item 
`node_offset': node offset (0 to @code{2**64-1} for BLAKE2b, 0 to @code{2**48-1} for
BLAKE2s, 0 for the first, leftmost, leaf, or in sequential mode).

@item 
`node_depth': node depth (0 to 255, 0 for leaves, or in sequential mode).

@item 
`inner_size': inner digest size (0 to 64 for BLAKE2b, 0 to 32 for
BLAKE2s, 0 in sequential mode).

@item 
`last_node': boolean indicating whether the processed node is the last
one (@code{False} for sequential mode).
@end itemize


@float Figure

@image{python-figures/hashlib-blake2-tree,,,Explanation of tree mode parameters.,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>,Exemplos<13>,Criando objetos hash,BLAKE2
@anchor{library/hashlib constants}@anchor{2cb7}
@subsubsection Constantes


@geindex blake2b.SALT_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2b SALT_SIZE}@anchor{2cb8}
@deffn {Dado} blake2b.SALT_SIZE
@end deffn

@geindex blake2s.SALT_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2s SALT_SIZE}@anchor{2cb9}
@deffn {Dado} blake2s.SALT_SIZE
@end deffn

Salt length (maximum length accepted by constructors).

@geindex blake2b.PERSON_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2b PERSON_SIZE}@anchor{2cba}
@deffn {Dado} blake2b.PERSON_SIZE
@end deffn

@geindex blake2s.PERSON_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2s PERSON_SIZE}@anchor{2cbb}
@deffn {Dado} blake2s.PERSON_SIZE
@end deffn

Personalization string length (maximum length accepted by constructors).

@geindex blake2b.MAX_KEY_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2b MAX_KEY_SIZE}@anchor{2cbc}
@deffn {Dado} blake2b.MAX_KEY_SIZE
@end deffn

@geindex blake2s.MAX_KEY_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2s MAX_KEY_SIZE}@anchor{2cbd}
@deffn {Dado} blake2s.MAX_KEY_SIZE
@end deffn

Maximum key size.

@geindex blake2b.MAX_DIGEST_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2b MAX_DIGEST_SIZE}@anchor{2cbe}
@deffn {Dado} blake2b.MAX_DIGEST_SIZE
@end deffn

@geindex blake2s.MAX_DIGEST_SIZE (no módulo hashlib)
@anchor{library/hashlib hashlib blake2s MAX_DIGEST_SIZE}@anchor{2cbf}
@deffn {Dado} blake2s.MAX_DIGEST_SIZE
@end deffn

Maximum digest size that the hash function can output.

@node Exemplos<13>,Credits,Constantes<5>,BLAKE2
@anchor{library/hashlib examples}@anchor{2cc0}
@subsubsection Exemplos


@menu
* Simple hashing:: 
* Using different digest sizes:: 
* Keyed hashing:: 
* Randomized hashing:: 
* Personalization:: 
* Modo árvore:: 

@end menu

@node Simple hashing,Using different digest sizes,,Exemplos<13>
@anchor{library/hashlib simple-hashing}@anchor{2cc1}
@subsubsection Simple hashing


To calculate hash of some data, you should first construct a hash object by
calling the appropriate constructor function (@ref{642,,blake2b()} or
@ref{643,,blake2s()}), then update it with the data by calling @ref{2ca2,,update()} on the
object, and, finally, get the digest out of the object by calling
@ref{2ca3,,digest()} (or @ref{2ca4,,hexdigest()} for hex-encoded string).

@example
>>> from hashlib import blake2b
>>> h = blake2b()
>>> h.update(b'Hello world')
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

As a shortcut, you can pass the first chunk of data to update directly to the
constructor as the positional argument:

@example
>>> from hashlib import blake2b
>>> blake2b(b'Hello world').hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

You can call @ref{2ca2,,hash.update()} as many times as you need to iteratively
update the hash:

@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 Using different digest sizes,Keyed hashing,Simple hashing,Exemplos<13>
@anchor{library/hashlib using-different-digest-sizes}@anchor{2cc2}
@subsubsection Using different digest sizes


BLAKE2 has configurable size of digests up to 64 bytes for BLAKE2b and up to 32
bytes for BLAKE2s. For example, to replace SHA-1 with BLAKE2b without changing
the size of output, we can tell BLAKE2b to produce 20-byte digests:

@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

Hash objects with different digest sizes have completely different outputs
(shorter hashes are `not' prefixes of longer hashes); BLAKE2b and BLAKE2s
produce different outputs even if the output length is the same:

@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 Keyed hashing,Randomized hashing,Using different digest sizes,Exemplos<13>
@anchor{library/hashlib keyed-hashing}@anchor{2cc3}
@subsubsection Keyed hashing


Keyed hashing can be used for authentication as a faster and simpler
replacement for Hash-based message authentication code@footnote{https://en.wikipedia.org/wiki/HMAC} (HMAC).
BLAKE2 can be securely used in prefix-MAC mode thanks to the
indifferentiability property inherited from BLAKE.

This example shows how to get a (hex-encoded) 128-bit authentication code for
message @code{b'message data'} with key @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

As a practical example, a web application can symmetrically sign cookies sent
to users and later verify them to make sure they weren’t tampered with:

@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

Even though there’s a native keyed hashing mode, BLAKE2 can, of course, be used
in HMAC construction with @ref{6a,,hmac} module:

@example
>>> import hmac, hashlib
>>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
>>> m.update(b'message')
>>> m.hexdigest()
'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'
@end example

@node Randomized hashing,Personalization,Keyed hashing,Exemplos<13>
@anchor{library/hashlib randomized-hashing}@anchor{2cc4}
@subsubsection Randomized hashing


By setting `salt' parameter users can introduce randomization to the hash
function. Randomized hashing is useful for protecting against collision attacks
on the hash function used in digital signatures.

@quotation

Randomized hashing is designed for situations where one party, the message
preparer, generates all or part of a message to be signed by a second
party, the message signer. If the message preparer is able to find
cryptographic hash function collisions (i.e., two messages producing the
same hash value), then they might prepare meaningful versions of the message
that would produce the same hash value and digital signature, but with
different results (e.g., transferring $1,000,000 to an account, rather than
$10). Cryptographic hash functions have been designed with collision
resistance as a major goal, but the current concentration on attacking
cryptographic hash functions may result in a given cryptographic hash
function providing less collision resistance than expected. Randomized
hashing offers the signer additional protection by reducing the likelihood
that a preparer can generate two or more messages that ultimately yield the
same hash value during the digital signature generation process — even if
it is practical to find collisions for the hash function. However, the use
of randomized hashing may reduce the amount of security provided by a
digital signature when all portions of the message are prepared
by the signer.

(NIST SP-800-106 "Randomized Hashing for Digital Signatures"@footnote{https://csrc.nist.gov/pubs/sp/800/106/final})
@end quotation

In BLAKE2 the salt is processed as a one-time input to the hash function during
initialization, rather than as an input to each compression function.

@cartouche
@quotation Aviso 
`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 Personalization,Modo árvore,Randomized hashing,Exemplos<13>
@anchor{library/hashlib personalization}@anchor{2cc5}
@subsubsection Personalization


Sometimes it is useful to force hash function to produce different digests for
the same input for different purposes. Quoting the authors of the Skein hash
function:

@quotation

We recommend that all application designers seriously consider doing this;
we have seen many protocols where a hash that is computed in one part of
the protocol can be used in an entirely different part because two hash
computations were done on similar or related data, and the attacker can
force the application to make the hash inputs the same. Personalizing each
hash function used in the protocol summarily stops this type of attack.

(The Skein Hash Function Family@footnote{https://www.schneier.com/wp-content/uploads/2016/02/skein.pdf},
p. 21)
@end quotation

BLAKE2 can be personalized by passing bytes to the `person' argument:

@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

Personalization together with the keyed mode can also be used to derive different
keys from a single one.

@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 árvore,,Personalization,Exemplos<13>
@anchor{library/hashlib tree-mode}@anchor{2cc6}
@subsubsection Modo árvore


Here’s an example of hashing a minimal tree with two leaf nodes:

@example
  10
 /  \
00  01
@end example

This example uses 64-byte internal digests, and returns the 32-byte final
digest:

@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 Credits,,Exemplos<13>,BLAKE2
@anchor{library/hashlib credits}@anchor{2cc7}
@subsubsection Credits


BLAKE2@footnote{https://www.blake2.net} was designed by `Jean-Philippe Aumasson', `Samuel Neves', `Zooko
Wilcox-O’Hearn', and `Christian Winnerlein' based on SHA-3@footnote{https://en.wikipedia.org/wiki/Secure_Hash_Algorithms} finalist BLAKE@footnote{https://web.archive.org/web/20200918190133/https://131002.net/blake/}
created by `Jean-Philippe Aumasson', `Luca Henzen', `Willi Meier', and
`Raphael C.-W. Phan'.

It uses core algorithm from ChaCha@footnote{https://cr.yp.to/chacha.html} cipher designed by `Daniel J.  Bernstein'.

The stdlib implementation is based on pyblake2@footnote{https://pythonhosted.org/pyblake2/} module. It was written by
`Dmitry Chestnykh' based on C implementation written by `Samuel Neves'. The
documentation was copied from pyblake2@footnote{https://pythonhosted.org/pyblake2/} and written by `Dmitry Chestnykh'.

The C code was partly rewritten for Python by `Christian Heimes'.

The following public domain dedication applies for both C hash function
implementation, extension code, and this documentation:

@quotation

To the extent possible under law, the author(s) have dedicated all copyright
and related and neighboring rights to this software to the public domain
worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along
with this software. If not, see
@indicateurl{https://creativecommons.org/publicdomain/zero/1.0/}.
@end quotation

The following people have helped with development or contributed their changes
to the project and the public domain according to the Creative Commons Public
Domain Dedication 1.0 Universal:


@itemize *

@item 
`Alexandr Sokolovskiy'
@end itemize
@anchor{library/hashlib hashlib-seealso}@anchor{2ca9}

@subsubheading Ver também



@table @asis

@item Module @ref{6a,,hmac}

A module to generate message authentication codes using hashes.

@item Módulo @ref{e,,base64}

Another way to encode binary hashes for non-binary environments.

@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/}

Official BLAKE2 website.

@item @indicateurl{https://en.wikipedia.org/wiki/Cryptographic_hash_function}

Wikipedia article with information on which algorithms have known issues
and what that means regarding their use.

@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}

NIST Recommendation for Password-Based Key Derivation.
@end table


@node hmac — Código de autenticação de mensagem com chave hash,secrets — Gera números aleatórios seguros para gerenciar segredos,hashlib — Resumos de mensagens e hashes seguros,Serviços Criptográficos
@anchor{library/hmac doc}@anchor{2cc8}@anchor{library/hmac hmac-keyed-hashing-for-message-authentication}@anchor{2cc9}@anchor{library/hmac module-hmac}@anchor{6a}@anchor{library/hmac translation-repo}@anchor{2cca}
@subsection @code{hmac} — Código de autenticação de mensagem com chave hash


@geindex module; hmac

`Código-fonte:' Lib/hmac.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/hmac.py}


__________________________________________________________________


Este módulo implementa o algoritmo HMAC conforme descrito por 
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html}. A interface permite o uso de qualquer função hash com um tamanho de resumo `fixo'. Em particular, funções de saída extensíveis como SHAKE-128 ou SHAKE-256 não podem ser usadas com HMAC.

@geindex new() (no módulo hmac)
@anchor{library/hmac hmac new}@anchor{aae}
@deffn {Função} hmac.new (key, msg=None, digestmod)

Retorna um novo objeto hmac. `key' é um objeto bytes ou bytearray que fornece a chave secreta. Se `msg' estiver presente, a chamada de método @code{update(msg)} é feita. `digestmod' é o nome do resumo, construtor do resumo ou módulo para o objeto HMAC usar. Pode ser qualquer nome adequado para @ref{1abb,,hashlib.new()}. Apesar da posição do argumento, é obrigatório.


Alterado na versão 3.4: O parâmetro `key' pode ser um objeto bytes ou bytearray. O parâmetro `msg' pode ser de qualquer tipo suportado por @ref{68,,hashlib}. O parâmetro `digestmod' pode ser o nome de um algoritmo hash.



Alterado na versão 3.8: O argumento `digestmod' agora é obrigatório. Passe-o como um argumento nomeado para evitar constrangimentos quando você não tiver uma `msg' inicial.

@end deffn

@geindex digest() (no módulo hmac)
@anchor{library/hmac hmac digest}@anchor{b50}
@deffn {Função} hmac.digest (key, msg, digest)

Retorna o resumo de `msg' para o segredo `key' e `digest' fornecidos. A função equivale a @code{HMAC(key, msg, digest).digest()}, mas usa uma implementação C otimizada ou inline, que é mais rápida para mensagens que cabem na memória. Os parâmetros `key', `msg' e `digest' têm o mesmo significado que em @ref{aae,,new()}.

Detalhe da implementação do CPython: a implementação otimizada do C é usada somente quando `digest' é uma string e o nome de um algoritmo de resumo, que é suportado pelo OpenSSL.


Adicionado na versão 3.7.

@end deffn

@geindex HMAC (classe em hmac)
@anchor{library/hmac hmac HMAC}@anchor{b51}
@deffn {Classe} hmac.HMAC

Um objeto HMAC tem os seguintes métodos:
@end deffn

@geindex update() (método hmac.HMAC)
@anchor{library/hmac hmac HMAC update}@anchor{f7d}
@deffn {Método} HMAC.update (msg)

Atualiza o objeto hmac com `msg'. Chamadas repetidas são equivalentes a uma única chamada com a concatenação de todos os argumentos: @code{m.update(a); m.update(b)} equivale a @code{m.update(a + b)}.


Alterado na versão 3.4: O parâmetro `msg' pode ser de qualquer tipo suportado por @ref{68,,hashlib}.

@end deffn

@geindex digest() (método hmac.HMAC)
@anchor{library/hmac hmac HMAC digest}@anchor{2ccb}
@deffn {Método} HMAC.digest ()

Retorna o resumo dos bytes passados para o método @ref{f7d,,update()} até o momento. Este objeto bytes terá o mesmo comprimento que o `digest_size' do resumo dado ao construtor. Ele pode conter bytes não-ASCII, incluindo bytes NUL.

@cartouche
@quotation Aviso 
Ao comparar a saída de @ref{b50,,digest()} com um resumo fornecido externamente durante uma rotina de verificação, é recomendável usar a função @ref{1108,,compare_digest()} em vez do operador @code{==} para reduzir a vulnerabilidade a ataques de temporização.
@end quotation
@end cartouche
@end deffn

@geindex hexdigest() (método hmac.HMAC)
@anchor{library/hmac hmac HMAC hexdigest}@anchor{2ccc}
@deffn {Método} HMAC.hexdigest ()

Como @ref{b50,,digest()} exceto que o resumo é retornado como uma string com o dobro do comprimento contendo apenas dígitos hexadecimais. Isso pode ser usado para trocar o valor com segurança em e-mail ou outros ambientes não binários.

@cartouche
@quotation Aviso 
Ao comparar a saída de @ref{2ccc,,hexdigest()} com um resumo fornecido externamente durante uma rotina de verificação, é recomendável usar a função @ref{1108,,compare_digest()} em vez do operador @code{==} para reduzir a vulnerabilidade a ataques de temporização.
@end quotation
@end cartouche
@end deffn

@geindex copy() (método hmac.HMAC)
@anchor{library/hmac hmac HMAC copy}@anchor{15a9}
@deffn {Método} HMAC.copy ()

Retorna uma cópia (“clone”) do objeto hmac. Isso pode ser usado para calcular eficientemente os resumos de strings que compartilham uma substring inicial comum.
@end deffn

Um objeto hash tem os seguintes atributos:

@geindex digest_size (atributo hmac.HMAC)
@anchor{library/hmac hmac HMAC digest_size}@anchor{f80}
@deffn {Atributo} HMAC.digest_size

O tamanho do resumo HMAC resultante em bytes.
@end deffn

@geindex block_size (atributo hmac.HMAC)
@anchor{library/hmac hmac HMAC block_size}@anchor{f7e}
@deffn {Atributo} HMAC.block_size

O tamanho do bloco interna do algoritmo de hash em bytes.


Adicionado na versão 3.4.

@end deffn

@geindex name (atributo hmac.HMAC)
@anchor{library/hmac hmac HMAC name}@anchor{f7f}
@deffn {Atributo} HMAC.name

O nome canônico deste HMAC, sempre em letras minúsculas, por exemplo, @code{hmac-md5}.


Adicionado na versão 3.4.

@end deffn


Alterado na versão 3.10: Foram removidos os atributos não documentados @code{HMAC.digest_cons}, @code{HMAC.inner} e @code{HMAC.outer}.


Este módulo também fornece a seguinte função auxiliar:

@geindex compare_digest() (no módulo hmac)
@anchor{library/hmac hmac compare_digest}@anchor{1108}
@deffn {Função} hmac.compare_digest (a, b)

Retorna @code{a == b}. Esta função usa uma abordagem projetada para evitar análise de tempo evitando comportamento de curto-circuito baseado em conteúdo, tornando-a apropriada para criptografia. `a' e `b' devem ser ambos do mesmo tipo: @ref{44c,,str} (somente ASCII, como, por exemplo, retornado por @ref{2ccc,,HMAC.hexdigest()}), ou um @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
Se `a' e `b' tiverem comprimentos diferentes, ou se ocorrer um erro, um ataque de temporização poderia teoricamente revelar informações sobre os tipos e comprimentos de `a' e `b', mas não seus valores.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 3.10: A função usa @code{CRYPTO_memcmp()} do OpenSSL internamente quando disponível.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{68,,hashlib}

O módulo Python que fornece funções hash seguras.
@end table


@node secrets — Gera números aleatórios seguros para gerenciar segredos,,hmac — Código de autenticação de mensagem com chave hash,Serviços Criptográficos
@anchor{library/secrets doc}@anchor{2ccd}@anchor{library/secrets module-secrets}@anchor{c0}@anchor{library/secrets secrets-generate-secure-random-numbers-for-managing-secrets}@anchor{2cce}@anchor{library/secrets translation-repo}@anchor{2ccf}
@subsection @code{secrets} — Gera números aleatórios seguros para gerenciar segredos


@geindex module; secrets


Adicionado na versão 3.6.


@c from secrets import *
@c __name__ = '<doctest>'

`Código-fonte:' Lib/secrets.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/secrets.py}


__________________________________________________________________


O módulo @ref{c0,,secrets} é usado para gerar números aleatórios criptograficamente fortes, adequados para o gerenciamento de dados, como senhas, autenticação de conta, tokens de segurança e segredos relacionados.

Em particular, @ref{c0,,secrets} deve ser usado em preferência ao gerador de números pseudoaleatórios padrão no módulo @ref{b8,,random}, que é projetado para modelagem e simulação, não segurança ou criptografia.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 506
PEP 506@footnote{https://peps.python.org/pep-0506/}


@menu
* Números aleatórios:: 
* Gerando tokens:: 
* Outras funções:: 
* Receitas e melhores práticas:: 

@end menu

@node Números aleatórios,Gerando tokens,,secrets — Gera números aleatórios seguros para gerenciar segredos
@anchor{library/secrets random-numbers}@anchor{2cd0}
@subsubsection Números aleatórios


O módulo @ref{c0,,secrets} fornece acesso à fonte mais segura de aleatoriedade que seu sistema operacional fornece.

@geindex SystemRandom (classe em secrets)
@anchor{library/secrets secrets SystemRandom}@anchor{2cd1}
@deffn {Classe} secrets.SystemRandom

Uma classe para gerar números aleatórios usando as fontes da mais alta qualidade fornecidas pelo sistema operacional. Veja @ref{288b,,random.SystemRandom} para detalhes adicionais.
@end deffn

@geindex choice() (no módulo secrets)
@anchor{library/secrets secrets choice}@anchor{2cd2}
@deffn {Função} secrets.choice (seq)

Retorna um elemento escolhido aleatoriamente de uma sequência não vazia.
@end deffn

@geindex randbelow() (no módulo secrets)
@anchor{library/secrets secrets randbelow}@anchor{2cd3}
@deffn {Função} secrets.randbelow (exclusive_upper_bound)

Retorna um int aleatório no intervalo [0, `exclusive_upper_bound').
@end deffn

@geindex randbits() (no módulo secrets)
@anchor{library/secrets secrets randbits}@anchor{2cd4}
@deffn {Função} secrets.randbits (k)

Retorna um int não negativo com `k' bits aleatórios.
@end deffn

@node Gerando tokens,Outras funções,Números aleatórios,secrets — Gera números aleatórios seguros para gerenciar segredos
@anchor{library/secrets generating-tokens}@anchor{2cd5}
@subsubsection Gerando tokens


O módulo @ref{c0,,secrets} fornece funções para gerar tokens seguros, adequados para aplicativos como redefinições de senha, URLs difíceis de adivinhar e semelhantes.

@geindex token_bytes() (no módulo secrets)
@anchor{library/secrets secrets token_bytes}@anchor{2890}
@deffn {Função} secrets.token_bytes ([nbytes=None])

Retorna uma string de byte aleatória contendo `nbytes' número de bytes. Se `nbytes' for @code{None} ou não fornecido, um padrão razoável é usado.

@example
>>> token_bytes(16)
b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'
@end example
@end deffn

@geindex token_hex() (no módulo secrets)
@anchor{library/secrets secrets token_hex}@anchor{18ae}
@deffn {Função} secrets.token_hex ([nbytes=None])

Retorna uma string de texto aleatória, em hexadecimal. A string tem `nbytes' bytes aleatórios, cada byte convertido em dois dígitos hexadecimais. Se `nbytes' for @code{None} ou não fornecido, um padrão razoável é usado.

@example
>>> token_hex(16)
'f9bf78b9a18ce6d46a0cd2b0b86df9da'
@end example
@end deffn

@geindex token_urlsafe() (no módulo secrets)
@anchor{library/secrets secrets token_urlsafe}@anchor{2cd6}
@deffn {Função} secrets.token_urlsafe ([nbytes=None])

Retorna uma string de texto segura para URL aleatória, contendo `nbytes' bytes aleatórios. O texto é codificado em Base64, portanto, em média, cada byte resulta em aproximadamente 1,3 caracteres. Se `nbytes' for @code{None} ou não fornecido, um padrão razoável é usado.

@example
>>> token_urlsafe(16)
'Drmhze6EPcv0fN_81Bj-nA'
@end example
@end deffn

@menu
* Quantos bytes os tokens devem usar?:: 

@end menu

@node Quantos bytes os tokens devem usar?,,,Gerando tokens
@anchor{library/secrets how-many-bytes-should-tokens-use}@anchor{2cd7}
@subsubsection Quantos bytes os tokens devem usar?


Para estar seguro contra ataques de força bruta@footnote{https://pt.wikipedia.org/wiki/Ataque_de_força_bruta}, os tokens precisam ter aleatoriedade suficiente. Infelizmente, o que é considerado suficiente necessariamente aumentará à medida que os computadores ficarem mais poderosos e capazes de fazer mais suposições em um período mais curto. A partir de 2015, acredita-se que 32 bytes (256 bits) de aleatoriedade são suficientes para o caso de uso típico esperado para o módulo @ref{c0,,secrets}.

Para aqueles que desejam gerenciar seu próprio comprimento de token, você pode especificar explicitamente quanta aleatoriedade é usada para tokens, fornecendo um argumento @ref{257,,int} para as várias funções @code{token_*}. Esse argumento é considerado o número de bytes de aleatoriedade a serem usados.

Caso contrário, se nenhum argumento for fornecido, ou se o argumento for @code{None}, as funções @code{token_*} usarão um padrão razoável.

@cartouche
@quotation Nota 
Esse padrão está sujeito a alterações a qualquer momento, inclusive durante as versões de manutenção.
@end quotation
@end cartouche

@node Outras funções,Receitas e melhores práticas,Gerando tokens,secrets — Gera números aleatórios seguros para gerenciar segredos
@anchor{library/secrets other-functions}@anchor{2cd8}
@subsubsection Outras funções


@geindex compare_digest() (no módulo secrets)
@anchor{library/secrets secrets compare_digest}@anchor{2cd9}
@deffn {Função} secrets.compare_digest (a, b)

Retorna @code{True} se as strings ou @ref{d4f,,objetos tipo arquivo} `a' e `b' forem iguais, caso contrário, @code{False}, usando uma “comparação de tempo constante” para reduzir o risco de ataques de temporização@footnote{https://codahale.com/a-lesson-in-timing-attacks/}. Veja @ref{1108,,hmac.compare_digest()} para detalhes adicionais.
@end deffn

@node Receitas e melhores práticas,,Outras funções,secrets — Gera números aleatórios seguros para gerenciar segredos
@anchor{library/secrets recipes-and-best-practices}@anchor{2cda}
@subsubsection Receitas e melhores práticas


Esta seção mostra as receitas e melhores práticas para usar @ref{c0,,secrets} para gerenciar um nível básico de segurança.

Gerar uma senha alfanumérica de oito 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 
As aplicações não devem 
@geindex Common Weakness Enumeration; CWE 257
armazenar senhas em um formato recuperável@footnote{https://cwe.mitre.org/data/definitions/257.html}, seja em texto simples ou criptografado. Elas devem ser salgadas e transformadas em hash usando uma função hash de sentido único criptograficamente forte (irreversível).
@end quotation
@end cartouche

Gerar uma senha alfanumérica de dez caracteres com pelo menos um caractere minúsculo, pelo menos um caractere maiúsculo e pelo menos três 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

Gerar uma senha longa do estilo XKCD@footnote{https://xkcd.com/936/}:

@example
import secrets
# Em sistemas Linux padrão, use um arquivo de dicionário conveniente.
# Outras plataformas podem precisar fornecer sua própria lista de palavras.
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

Gerar uma URL temporária difícil de adivinhação contendo um token de segurança adequado para aplicativos de recuperação de senha:

@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 Serviços Genéricos do Sistema Operacional,Bibliotecas de interface de linha de comando,Serviços Criptográficos,A Biblioteca Padrão do Python
@anchor{library/allos doc}@anchor{2cdb}@anchor{library/allos allos}@anchor{2cdc}@anchor{library/allos generic-operating-system-services}@anchor{2cdd}@anchor{library/allos translation-repo}@anchor{2cde}
@section Serviços Genéricos do Sistema Operacional


Os módulos descritos neste capítulo fornecem interfaces aos recursos do sistema operacional e que estão disponíveis em (quase) todos os sistemas operacionais, como arquivos e um relógio. As interfaces geralmente são modeladas após as interfaces Unix ou C, mas elas também estão disponíveis na maioria dos outros sistemas. Aqui temos uma visão geral:

@menu
* os — Diversas interfaces de sistema operacional:: 
* io — Ferramentas essenciais para trabalhar com fluxos:: 
* time — Acesso ao horário e conversões:: 
* logging — Recursos de registro de eventos para Python:: 
* logging.config — Configuração do módulo logging: logging config — Configuração do módulo logging. 
* logging.handlers — Manipuladores de logging: logging handlers — Manipuladores de logging. 
* platform — Acesso aos dados de identificação da plataforma subjacente:: 
* errno — Símbolos padrão do sistema errno:: 
* ctypes — Uma biblioteca de funções externas para Python:: 

@end menu

@node os — Diversas interfaces de sistema operacional,io — Ferramentas essenciais para trabalhar com fluxos,,Serviços Genéricos do Sistema Operacional
@anchor{library/os doc}@anchor{2cdf}@anchor{library/os module-os}@anchor{a1}@anchor{library/os os-miscellaneous-operating-system-interfaces}@anchor{2ce0}
@subsection @code{os} — Diversas interfaces de sistema operacional


@geindex module; os

`Código-fonte:' Lib/os.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/os.py}


__________________________________________________________________


Este módulo fornece uma maneira simples de usar funcionalidades que são dependentes de sistema operacional. Se você quiser ler ou escrever um arquivo, veja @ref{51c,,open()}; se o que quer é manipular estruturas de diretórios, veja o módulo @ref{a2,,os.path}; e se quiser ler todas as linhas, de todos os arquivos na linha de comando, veja o módulo @ref{5b,,fileinput}. Para criar arquivos e diretórios temporários, veja o módulo @ref{e0,,tempfile}; e, para manipulação em alto nível de arquivos e diretórios, veja o módulo @ref{c5,,shutil}.

Notas sobre a disponibilidade dessas funções:


@itemize *

@item 
O modelo dos módulos embutidos dependentes do sistema operacional no Python é tal que, desde que a mesma funcionalidade esteja disponível, a mesma interface é usada; por exemplo, a função @code{os.stat(path)} retorna informações estatísticas sobre `path' no mesmo formato (que é originado com a interface POSIX).

@item 
Extensões específicas a um sistema operacional também estão disponíveis através do módulo @ref{a1,,os}, mas usá-las é, naturalmente, uma ameaça à portabilidade.

@item 
Todas as funções que aceitam nomes de caminhos ou arquivos, aceitam objetos bytes e string, e resultam em um objeto do mesmo tipo, se um caminho ou nome de arquivo for retornado.

@item 
Em VxWorks, os.popen, os.fork, os.execv e os.spawn*p* não são suportados.

@item 
Nas plataformas WebAssembly, Android e iOS, grandes partes do módulo @ref{a1,,os} não estão disponíveis ou se comportam de maneira diferente. APIs relacionadas a processos (por exemplo, @ref{197,,fork()}, @ref{1138,,execve()}) e recursos (por exemplo, @ref{1140,,nice()}) não estão disponíveis. Outros como @ref{1612,,getuid()} e @ref{2ce1,,getpid()} são emulados ou esboços. As plataformas WebAssembly também não possuem suporte para sinais (por exemplo, @ref{13ae,,kill()}, @ref{dc0,,wait()}).
@end itemize

@cartouche
@quotation Nota 
Todas as funções neste módulo levantam @ref{417,,OSError} (ou suas subclasses) no caso de nomes e caminhos de arquivos inválidos ou inacessíveis, ou outros argumentos que possuem o tipo correto, mas não são aceitos pelo sistema operacional.
@end quotation
@end cartouche

@geindex error
@anchor{library/os os error}@anchor{2ce2}
@deffn {Exceção} os.error

Um apelido para a exceção embutida @ref{417,,OSError}.
@end deffn

@geindex name (no módulo os)
@anchor{library/os os name}@anchor{2ce3}
@deffn {Dado} os.name

O nome do módulo importado, dependente do sistema operacional. Atualmente, os seguintes nomes foram registrados: @code{'posix'}, @code{'nt'}, @code{'java'}.


@subsubheading Ver também


@ref{a97,,sys.platform} tem uma granularidade mais fina. @ref{1155,,os.uname()} fornece informações de versão específicas do sistema.

O módulo @ref{aa,,platform} fornece verificações detalhadas sobre a identificação do sistema.

@end deffn
@anchor{library/os os-filenames}@anchor{2c27}
@menu
* Nomes de arquivos@comma{} argumentos de linha de comando e variáveis de ambiente: Nomes de arquivos argumentos de linha de comando e variáveis de ambiente. 
* Modo UTF-8 do Python:: 
* Parâmetros de processo:: 
* Criação de objetos arquivos:: 
* Operações dos descritores de arquivos:: 
* Arquivos e diretórios:: 
* Gerenciamento de processo:: 
* Interface do agendador:: 
* Diversas informações de sistema:: 
* Números aleatórios: Números aleatórios<2>. 

@end menu

@node Nomes de arquivos argumentos de linha de comando e variáveis de ambiente,Modo UTF-8 do Python,,os — Diversas interfaces de sistema operacional
@anchor{library/os file-names-command-line-arguments-and-environment-variables}@anchor{2ce4}@anchor{library/os filesystem-encoding}@anchor{2970}
@subsubsection Nomes de arquivos, argumentos de linha de comando e variáveis de ambiente


No Python, nomes de arquivos, argumentos da linha de comando, e variáveis de ambiente são representadas usando o tipo string. Em alguns sistemas, decodificar essas strings de e para bytes é necessário antes de passá-las para o sistema operacional. Python usa o @ref{53b,,tratador de erros e codificação do sistema de arquivos} para realizar essa conversão (veja @ref{c74,,sys.getfilesystemencoding()}).

O @ref{53b,,tratador de erros e codificação do sistema de arquivos} são configurados na inicialização do Python pela função @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} do @ref{3a6,,PyConfig}.


Alterado na versão 3.1: Em alguns sistemas a conversão, usando a codificação do sistema de arquivos, pode falhar. Neste caso, Python usa o @ref{2580,,manipulador de erro de codificação surrogateescape}, o que significa que bytes não decodificados são substituídos por um caractere Unicode U+DC`xx' na decodificação, e estes são novamente traduzidos para o byte original na codificação.


A @ref{53b,,codificação de sistema de arquivos} precisa garantir que todos os bytes abaixo de 128 serão decodificados com sucesso. Se a codificação do sistemas de arquivos falhar em garantir isso, funções de API podem levantar @ref{12e6,,UnicodeError}.

Veja também @ref{242,,codificação da localidade}.

@node Modo UTF-8 do Python,Parâmetros de processo,Nomes de arquivos argumentos de linha de comando e variáveis de ambiente,os — Diversas interfaces de sistema operacional
@anchor{library/os python-utf-8-mode}@anchor{2ce5}@anchor{library/os utf8-mode}@anchor{656}
@subsubsection Modo UTF-8 do Python



Adicionado na versão 3.7: Veja 
@geindex Propostas de Melhorias do Python; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} para mais detalhes.


O Modo UTF-8 do Python ignora a @ref{242,,codificação da localidade} e força o uso da codificação UTF-8:


@itemize *

@item 
Usa UTF-8 como a @ref{53b,,codificação do sistema de arquivos}.

@item 
@ref{c74,,sys.getfilesystemencoding()} retorna @code{'utf-8'}.

@item 
@ref{53a,,locale.getpreferredencoding()} retorna @code{'utf-8'} (o argumento `do_setlocale' não causa efeito).

@item 
@ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout} e @ref{940,,sys.stderr} usam UTF-8 como codificação de texto, com o @ref{18fa,,tratador de erros} @code{surrogateescape} sendo habilitado para @ref{53d,,sys.stdin} e @ref{ae6,,sys.stdout} (@ref{940,,sys.stderr} continua a usar @code{backslashreplace} como faz no modo padrão com reconhecimento de localidade)

@item 
No Unix, @ref{19c0,,os.device_encoding()} retorna @code{'utf-8'} invés da codificação do dispositivo.
@end itemize

Observe que as configurações de fluxo padrão no modo UTF-8 podem ser substituídas por 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} (assim como podem estar no modo com reconhecimento de localidade padrão).

Como consequência das mudanças nessas APIs de baixo  nível, outras APIs de alto nível também exibem comportamentos padrões diferentes:


@itemize *

@item 
Argumentos de linha de comando, variáveis de ambiente e nomes de arquivos são decodificados em texto usando a codificação UTF-8.

@item 
@ref{c6f,,os.fsdecode()} e @ref{c70,,os.fsencode()} usam a codificação UTF-8.

@item 
@ref{51c,,open()}, @ref{51d,,io.open()} e @ref{740,,codecs.open()} usam a codificação UTF-8 por padrão. No entanto, elas ainda usam o tratador de erros estrito por padrão, de modo que a tentativa de abrir um arquivo binário no modo de texto provavelmente levantará uma exceção em vez de produzir dados sem sentido.
@end itemize

O @ref{656,,Modo UTF-8 do Python} está habilitado se a localidade LC_CTYPE for @code{C} ou @code{POSIX} na inicialização do Python (veja a função @ref{790,,PyConfig_Read()}).

Ele pode ser habilitado ou desabilitado utilizando a opção @ref{176,,-X utf8} da linha de comando e a variável de ambiente 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8}.

Se a variável de ambiente 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8} não está com valor definido, então o interpretador usa por padrão a configuração de localidade atual, `a menos que' a localidade atual esteja identificada como uma localidade legada baseada em ASCII (como descrita para 
@geindex PYTHONCOERCECLOCALE
@geindex variável de ambiente; PYTHONCOERCECLOCALE
@ref{ae5,,PYTHONCOERCECLOCALE}), e a coerção de localidade estiver desabilitada ou falhar. Nessas localidades legadas, o interpretador irá habilitar por padrão o modo UTF-8 a menos que seja explicitamente instruído para não fazer isso.

O Modo UTF-8 do Python só pode ser ativado na inicialização do Python. Seu valor pode ser lido de @ref{68c,,sys.flags.utf8_mode}.

Veja também o @ref{1fa8,,modo UTF-8 no Windows} e o @ref{53b,,tratador de erros e codificação do sistema de arquivos}.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 utilizará @ref{656,,Modo UTF-8 do Python} por padrão.
@end table


@node Parâmetros de processo,Criação de objetos arquivos,Modo UTF-8 do Python,os — Diversas interfaces de sistema operacional
@anchor{library/os os-procinfo}@anchor{2ce6}@anchor{library/os process-parameters}@anchor{2ce7}
@subsubsection Parâmetros de processo


Essas funções e itens de dados fornecem informações e operam no processo e usuário atuais.

@geindex ctermid() (no módulo os)
@anchor{library/os os ctermid}@anchor{2ce8}
@deffn {Função} os.ctermid ()

Retorna o nome do arquivo correspondente ao terminal de controle do processo.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex environ (no módulo os)
@anchor{library/os os environ}@anchor{11f9}
@deffn {Dado} os.environ

Um objeto @ref{11fb,,mapeamento} onde as chaves e valores são strings que representam o ambiente do processo. Por exemplo, @code{environ['HOME']} é o nome do caminho do seu diretório pessoal (em algumas plataformas), e é equivalente a @code{getenv("HOME")} em C.

Este mapeamento é capturado na primeira vez que o módulo @ref{a1,,os} é importado, normalmente durante a inicialização do Python, como parte do processamento do arquivo @code{site.py}. Mudanças no ambiente feitas após esse momento não são refletidas em @ref{11f9,,os.environ}, exceto pelas mudanças feitas modificando @ref{11f9,,os.environ} diretamente.

Este mapeamento pode ser usado para modificar o ambiente, além de consultá-lo. @ref{922,,putenv()} será chamado automaticamente quando o mapeamento for modificado.

No Unix, chaves e valores usam @ref{c74,,sys.getfilesystemencoding()} e o tratador de erros @code{'surrogateescape'}. Use @ref{1257,,environb} se quiser usar uma codificação diferente.

No Windows, as chaves são convertidas em maiúsculas. Isso também se aplica ao obter, definir ou excluir um item. Por exemplo, @code{environ['monty'] = 'python'} mapeia a chave @code{'MONTY'} para o valor @code{'python'}.

@cartouche
@quotation Nota 
Chamar a função @ref{922,,putenv()} diretamente não muda @ref{11f9,,os.environ}, por isso é melhor modificar @ref{11f9,,os.environ}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Em algumas plataformas, incluindo FreeBSD e Mac OS X, a modificação de @code{environ} pode causar vazamentos de memória. Consulte a documentação do sistema para @code{putenv()}.
@end quotation
@end cartouche

Você pode excluir itens neste mapeamento para remover definição de variáveis de ambiente. @ref{921,,unsetenv()} será chamado automaticamente quando um item é excluído de @ref{11f9,,os.environ}, e quando um dos métodos @code{pop()} ou @code{clear()} é chamado.


Alterado na versão 3.9: Atualizado para ter suporte aos operadores de mesclagem (@code{|}) e de atualização (@code{|=}) da 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn

@geindex environb (no módulo os)
@anchor{library/os os environb}@anchor{1257}
@deffn {Dado} os.environb

Versão bytes de @ref{11f9,,environ}: um objeto de @ref{11fb,,mapeamento} onde as chaves e valores são objetos @ref{1c2,,bytes} representando o ambiente do processo. @ref{11f9,,environ} e @ref{1257,,environb} são sincronizados (modificar @ref{1257,,environb} atualiza @ref{11f9,,environ}, e vice versa).

@ref{1257,,environb} está disponível somente se @ref{1255,,supports_bytes_environ} for @code{True}.


Adicionado na versão 3.2.



Alterado na versão 3.9: Atualizado para ter suporte aos operadores de mesclagem (@code{|}) e de atualização (@code{|=}) da 
@geindex Propostas de Melhorias do Python; PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}.

@end deffn


@deffn {Função} os.chdir (path)

@deffnx {Função} os.fchdir (fd)

@deffnx {Função} os.getcwd ()

Essas funções são descritas em: @ref{2ce9,,Arquivos e diretórios}.
@end deffn

@geindex fsencode() (no módulo os)
@anchor{library/os os fsencode}@anchor{c70}
@deffn {Função} os.fsencode (filename)

Codifica o `filename' @ref{2a0,,caminho ou similar} para @ref{53b,,tratador de erros e codificação do sistema de arquivos}; retorna @ref{1c2,,bytes} inalterados.

@ref{c6f,,fsdecode()} é a função inversa.


Adicionado na versão 3.2.



Alterado na versão 3.6: Adicionado suporte para aceitar objetos que implementam a interface @ref{c6c,,os.PathLike}.

@end deffn

@geindex fsdecode() (no módulo os)
@anchor{library/os os fsdecode}@anchor{c6f}
@deffn {Função} os.fsdecode (filename)

Decodifica o @ref{2a0,,objeto caminho ou similar} `filename' do @ref{53b,,tratador de erros e codificação do sistema de arquivos}; retorna @ref{44c,,str} inalterada.

@ref{c70,,fsencode()} é a função inversa.


Adicionado na versão 3.2.



Alterado na versão 3.6: Adicionado suporte para aceitar objetos que implementam a interface @ref{c6c,,os.PathLike}.

@end deffn

@geindex fspath() (no módulo os)
@anchor{library/os os fspath}@anchor{c6e}
@deffn {Função} os.fspath (path)

Retorna a representação do sistema de arquivos do caminho (argumento `path').

Se um objeto @ref{44c,,str} ou @ref{1c2,,bytes} é passado, é retornado inalterado. Caso contrário, o método @ref{c6d,,__fspath__()} é chamado, e seu valor é retornado, desde que seja um objeto @ref{44c,,str} ou @ref{1c2,,bytes}. Em todos os outros casos, @ref{2c3,,TypeError} é levantada.


Adicionado na versão 3.6.

@end deffn

@geindex PathLike (classe em os)
@anchor{library/os os PathLike}@anchor{c6c}
@deffn {Classe} os.PathLike

Uma @ref{11f5,,classe base abstrata} para objetos representando um caminho do sistema de arquivos, como, por exemplo, @ref{4a6,,pathlib.PurePath}.


Adicionado na versão 3.6.


@geindex __fspath__() (método os.PathLike)
@anchor{library/os os PathLike __fspath__}@anchor{c6d}
@deffn {Método} abstractmethod __fspath__ ()

Retorna a representação do caminho do sistema de arquivos do objeto.

O método deverá retornar somente objetos @ref{44c,,str} ou @ref{1c2,,bytes}, preferencialmente @ref{44c,,str}.
@end deffn
@end deffn

@geindex getenv() (no módulo os)
@anchor{library/os os getenv}@anchor{2cea}
@deffn {Função} os.getenv (key, default=None)

Retorna o valor da variável de ambiente `key' como uma string se existir, ou `default' se não existir. `key' é uma string. Note que uma vez que @ref{2cea,,getenv()} utiliza @ref{11f9,,os.environ}, o mapeamento de @ref{2cea,,getenv()} é também similarmente  capturado na importação, e a função pode não refletir futuras mudanças no ambiente.

No Unix, chaves e valores são decodificados com a função @ref{c74,,sys.getfilesystemencoding()} e o o manipulador de erros @code{'surrogateescape'}. Use @ref{1256,,os.getenvb()} se quiser usar uma codificação diferente.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex getenvb() (no módulo os)
@anchor{library/os os getenvb}@anchor{1256}
@deffn {Função} os.getenvb (key, default=None)

Retorna o valor da variável de ambiente `key' como bytes se existir, ou `default' se não existir. `key' deve ser bytes. Note que uma vez que @ref{1256,,getenvb()} utiliza @ref{1257,,os.environb}, o mapeamento de @ref{1256,,getenvb()} é também similarmente capturado na importação, e a função pode não refletir futuras mudanças no ambiente.

@ref{1256,,getenvb()} está disponível somente se @ref{1255,,supports_bytes_environ} for @code{True}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.2.

@end deffn

@geindex get_exec_path() (no módulo os)
@anchor{library/os os get_exec_path}@anchor{2ceb}
@deffn {Função} os.get_exec_path (env=None)

Retorna a lista de diretórios que serão buscados por um executável nomeado, semelhante a um shell, ao iniciar um processo. `env', quando especificado, deve ser um dicionário de variáveis de ambiente para procurar o PATH. Por padrão, quando `env' é @code{None}, @ref{11f9,,environ} é usado.


Adicionado na versão 3.2.

@end deffn

@geindex getegid() (no módulo os)
@anchor{library/os os getegid}@anchor{2cec}
@deffn {Função} os.getegid ()

Retorna o ID do grupo efetivo do processo atual. Isso corresponde ao bit “set id” no arquivo que está sendo executado no processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex geteuid() (no módulo os)
@anchor{library/os os geteuid}@anchor{18fd}
@deffn {Função} os.geteuid ()

@geindex usuário;id efetivo

Retorna o ID de usuário efetivo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex getgid() (no módulo os)
@anchor{library/os os getgid}@anchor{2ced}
@deffn {Função} os.getgid ()

@geindex processo;grupo

Retorna o ID do grupo real do processo atual.

@ref{1ed8,,Disponibilidade}: Unix.

A função é uma simulação em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end deffn

@geindex getgrouplist() (no módulo os)
@anchor{library/os os getgrouplist}@anchor{1153}
@deffn {Função} os.getgrouplist (user, group, /)

Retorna a lista de IDs de grupo aos quais `user' pertence. Se `group' não estiver na lista, ele será incluído; normalmente, `group' é especificado como o campo de ID de grupo do registro de senha para `user', porque esse ID de grupo será potencialmente omitido.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex getgroups() (no módulo os)
@anchor{library/os os getgroups}@anchor{2cee}
@deffn {Função} os.getgroups ()

Retorna a lista de IDs de grupos suplementares associados ao processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

@cartouche
@quotation Nota 
No Mac OS, o comportamento da função @ref{2cee,,getgroups()} difere um pouco de outras plataformas Unix. Se o interpretador Python foi compilado para distribuição na versão @code{10.5}, ou anterior, @ref{2cee,,getgroups()} retorna a lista de IDs de grupos efetivos, associados ao processo do usuário atual; esta lista é limitada a um número de entradas definido pelo sistema, tipicamente 16, e pode ser modificada por chamadas para @ref{2cef,,setgroups()} se tiver o privilégio adequado. Se foi compilado para distribuição na versão maior que @code{10.5}, @ref{2cee,,getgroups()} retorna a lista de acesso de grupo atual para o usuário associado ao ID de usuário efetivo do processo; a lista de acesso de grupo pode mudar durante a vida útil do processo, e ela não é afetada por chamadas para @ref{2cef,,setgroups()}, e seu comprimento não é limitado a 16. O valor da constante @code{MACOSX_DEPLOYMENT_TARGET}, pode ser obtido com @ref{1063,,sysconfig.get_config_var()}.
@end quotation
@end cartouche
@end deffn

@geindex getlogin() (no módulo os)
@anchor{library/os os getlogin}@anchor{1613}
@deffn {Função} os.getlogin ()

Retorna o nome do usuário conectado no terminal de controle do processo. Para a maioria dos propósitos, é mais útil usar @ref{418,,getpass.getuser()}, já que esse último verifica as variáveis de ambiente 
@geindex LOGNAME
@geindex variável de ambiente; LOGNAME
@code{LOGNAME} ou 
@geindex USERNAME
@geindex variável de ambiente; USERNAME
@code{USERNAME} para descobrir quem é o usuário, e retorna para @code{pwd.getpwuid(os.getuid())[0]} para obter o nome de login do ID do usuário real atual.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI.
@end deffn

@geindex getpgid() (no módulo os)
@anchor{library/os os getpgid}@anchor{2cf0}
@deffn {Função} os.getpgid (pid)

Retorna o ID do grupo de processo com `pid'. Se `pid' for 0, o ID do grupo do processos do processo atual é retornado.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex getpgrp() (no módulo os)
@anchor{library/os os getpgrp}@anchor{2cf1}
@deffn {Função} os.getpgrp ()

@geindex processo;grupo

Retorna o ID do grupo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex getpid() (no módulo os)
@anchor{library/os os getpid}@anchor{2ce1}
@deffn {Função} os.getpid ()

@geindex processo;id

Retorna o ID do processo atual.

A função é uma simulação em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end deffn

@geindex getppid() (no módulo os)
@anchor{library/os os getppid}@anchor{1743}
@deffn {Função} os.getppid ()

@geindex processo;id do pai

Retorna o ID do processo pai. Quando o processo pai é encerrado, no Unix, o ID retornado é o do processo init (1); no Windows, ainda é o mesmo ID, que pode já estar sendo reutilizado por outro processo.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI.


Alterado na versão 3.2: Adicionado suporte para Windows.

@end deffn

@geindex getpriority() (no módulo os)
@anchor{library/os os getpriority}@anchor{113e}
@deffn {Função} os.getpriority (which, who)

@geindex processo;prioridade de agendamento

Obtém prioridade de agendamento de programa. O valor `which' é um entre @ref{2cf2,,PRIO_PROCESS}, @ref{2cf3,,PRIO_PGRP} ou @ref{2cf4,,PRIO_USER}, e `who' é interpretado em relação a `which' (um identificador de processo para @ref{2cf2,,PRIO_PROCESS}, identificador do grupo de processos para @ref{2cf3,,PRIO_PGRP} e um ID de usuário para @ref{2cf4,,PRIO_USER}). Um valor zero para `who' indica (respectivamente) o processo de chamada, o grupo de processos do processo de chamada ou o ID do usuário real do processo de chamada.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex PRIO_PROCESS (no módulo os)
@geindex PRIO_PGRP (no módulo os)
@geindex PRIO_USER (no módulo os)
@anchor{library/os os PRIO_PROCESS}@anchor{2cf2}
@deffn {Dado} os.PRIO_PROCESS
@anchor{library/os os PRIO_PGRP}@anchor{2cf3}
@deffnx {Dado} os.PRIO_PGRP
@anchor{library/os os PRIO_USER}@anchor{2cf4}
@deffnx {Dado} os.PRIO_USER

Parâmetros para as funções @ref{113e,,getpriority()} e @ref{113f,,setpriority()}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex PRIO_DARWIN_THREAD (no módulo os)
@geindex PRIO_DARWIN_PROCESS (no módulo os)
@geindex PRIO_DARWIN_BG (no módulo os)
@geindex PRIO_DARWIN_NONUI (no módulo os)
@anchor{library/os os PRIO_DARWIN_THREAD}@anchor{2cf5}
@deffn {Dado} os.PRIO_DARWIN_THREAD
@anchor{library/os os PRIO_DARWIN_PROCESS}@anchor{2cf6}
@deffnx {Dado} os.PRIO_DARWIN_PROCESS
@anchor{library/os os PRIO_DARWIN_BG}@anchor{2cf7}
@deffnx {Dado} os.PRIO_DARWIN_BG
@anchor{library/os os PRIO_DARWIN_NONUI}@anchor{2cf8}
@deffnx {Dado} os.PRIO_DARWIN_NONUI

Parâmetros para as funções @ref{113e,,getpriority()} e @ref{113f,,setpriority()}.

@ref{1ed8,,Disponibilidade}: macOS


Adicionado na versão 3.12.

@end deffn

@geindex getresuid() (no módulo os)
@anchor{library/os os getresuid}@anchor{135a}
@deffn {Função} os.getresuid ()

Retorna uma tupla (ruid, euid, suid) indicando os IDs de usuário real, efetivo e salvo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.2.

@end deffn

@geindex getresgid() (no módulo os)
@anchor{library/os os getresgid}@anchor{1359}
@deffn {Função} os.getresgid ()

Retorna uma tupla (rgid, egid, sgid) indicando os IDs de grupos real, efetivo e salvo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.2.

@end deffn

@geindex getuid() (no módulo os)
@anchor{library/os os getuid}@anchor{1612}
@deffn {Função} os.getuid ()

@geindex usuário;id

Retorna o ID de usuário real do processo atual.

@ref{1ed8,,Disponibilidade}: Unix.

A função é uma simulação em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end deffn

@geindex initgroups() (no módulo os)
@anchor{library/os os initgroups}@anchor{135d}
@deffn {Função} os.initgroups (username, gid, /)

Chama o @code{initgroups()} do sistema para inicializar a lista de acesso ao grupo com todos os grupos dos quais o nome de usuário especificado é membro, mais o ID do grupo especificado.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.


Adicionado na versão 3.2.

@end deffn

@geindex putenv() (no módulo os)
@anchor{library/os os putenv}@anchor{922}
@deffn {Função} os.putenv (key, value, /)

@geindex variáveis de ambiente;definição

Define a variável de ambiente denominada `key' como a string `value'. Tais mudanças no ambiente afetam os subprocessos iniciados com @ref{14a5,,os.system()}, @ref{a91,,popen()} ou @ref{197,,fork()} e @ref{2cf9,,execv()}.

Atribuições a itens em @ref{11f9,,os.environ} são automaticamente traduzidas em chamadas correspondentes para @ref{922,,putenv()}; entretanto, chamadas para @ref{922,,putenv()} não atualizam @ref{11f9,,os.environ}, então é preferível atribuir itens de @ref{11f9,,os.environ}. Isso também se aplica a @ref{2cea,,getenv()} e @ref{1256,,getenvb()}, que usam respectivamente @ref{11f9,,os.environ} e @ref{1257,,os.environb} em suas implementações.

@cartouche
@quotation Nota 
Em algumas plataformas, incluindo FreeBSD e Mac OS X, a modificação de @code{environ} pode causar vazamentos de memória. Consulte a documentação do sistema para @code{putenv()}.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{os.putenv} com os argumentos @code{key}, @code{value}.


Alterado na versão 3.9: A função está agora sempre disponível.

@end deffn

@geindex setegid() (no módulo os)
@anchor{library/os os setegid}@anchor{2cfa}
@deffn {Função} os.setegid (egid, /)

Define o ID do grupo efetivo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@geindex seteuid() (no módulo os)
@anchor{library/os os seteuid}@anchor{2cfb}
@deffn {Função} os.seteuid (euid, /)

Define o ID do usuário efetivo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@geindex setgid() (no módulo os)
@anchor{library/os os setgid}@anchor{2cfc}
@deffn {Função} os.setgid (gid, /)

Define o ID do grupo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@geindex setgroups() (no módulo os)
@anchor{library/os os setgroups}@anchor{2cef}
@deffn {Função} os.setgroups (groups, /)

Define a lista de IDs de grupo suplementares associados ao processo atual como `groups'. `groups' deve ser uma sequência e cada elemento deve ser um número inteiro identificando um grupo. Esta operação normalmente está disponível apenas para o superusuário.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

@cartouche
@quotation Nota 
No Mac OS X, o comprimento de `groups' não pode exceder o número máximo definido pelo sistema de IDs de grupo efetivos, normalmente 16. Consulte a documentação de @ref{2cee,,getgroups()} para casos em que ele pode não retornar o mesmo grupo de listas definido chamando setgroups().
@end quotation
@end cartouche
@end deffn

@geindex setns() (no módulo os)
@anchor{library/os os setns}@anchor{18ca}
@deffn {Função} os.setns (fd, nstype=0)

Reassocia a thread atual com um espaço de nomes do Linux. Veja as páginas man @code{setns(2)@footnote{https://manpages.debian.org/setns(2)}} e @code{namespaces(7)@footnote{https://manpages.debian.org/namespaces(7)}} para mais detalhes.

Se `fd' se refere a um link @code{/proc/`pid'/ns/}, @code{setns()} reassocia a thread de chamada com o espaço de nomes associado a esse link, e `nstype' pode ser definido como uma das @ref{2cfd,,constantes CLONE_NEW*} para impor restrições na operação (@code{0} significa sem restrições).

Desde o Linux 5.8, `fd' pode se referir a um descritor de arquivo PID obtido de @ref{47a,,pidfd_open()}. Neste caso, @code{setns()} reassocia a thread chamadora em um ou mais dos mesmos espaços de nomes que o thread referenciado por `fd'. Isso está sujeito a quaisquer restrições impostas por `nstype', que é uma máscara de bits que combina uma ou mais das @ref{2cfd,,constantes CLONE_NEW*}, por exemplo @code{setns(fd, os.CLONE_NEWUTS | os.CLONE_NEWPID)}. As associações do chamador em espaços de nomes não especificados permanecem inalteradas.

`fd' pode ser qualquer objeto com um método @ref{15d0,,fileno()} ou um descritor de arquivo bruto.

Este exemplo reassocia a thread com o espaço de nomes de rede do processo @code{init}:

@example
fd = os.open("/proc/1/ns/net", os.O_RDONLY)
os.setns(fd, os.CLONE_NEWNET)
os.close(fd)
@end example

@ref{1ed8,,Disponibilidade}: Linux >= 3.0 with glibc >= 2.14.


Adicionado na versão 3.12.



@subsubheading Ver também


A função @ref{18cb,,unshare()}.

@end deffn

@geindex setpgrp() (no módulo os)
@anchor{library/os os setpgrp}@anchor{2cfe}
@deffn {Função} os.setpgrp ()

Executa a chamada de sistema @code{setpgrp()} ou @code{setpgrp(0, 0)} dependendo da versão implementada (se houver). Veja o manual do Unix para a semântica.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex setpgid() (no módulo os)
@anchor{library/os os setpgid}@anchor{2cff}
@deffn {Função} os.setpgid (pid, pgrp, /)

Executa a chamada de sistema @code{setpgid()} para definir o ID do grupo do processo com `pid' para o grupo de processos com o id `pgrp'. Veja o manual do Unix para a semântica.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex setpriority() (no módulo os)
@anchor{library/os os setpriority}@anchor{113f}
@deffn {Função} os.setpriority (which, who, priority)

@geindex processo;prioridade de agendamento

Define a prioridade de agendamento de programa. O valor `which' é um entre @ref{2cf2,,PRIO_PROCESS}, @ref{2cf3,,PRIO_PGRP} ou @ref{2cf4,,PRIO_USER}, e `who' é interpretado em relação a `which' (um identificador de processo para @ref{2cf2,,PRIO_PROCESS}, identificador do grupo de processos para @ref{2cf3,,PRIO_PGRP} e um ID de usuário para @ref{2cf4,,PRIO_USER}). Um valor zero para `who' indica (respectivamente) o processo de chamada, o grupo de processos do processo de chamada ou o ID do usuário real do processo de chamada. `priority' é um valor na faixa de -20 a 19. A prioridade padrão é 0; prioridades menores resultam em um agendamento mais favorável.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex setregid() (no módulo os)
@anchor{library/os os setregid}@anchor{2d00}
@deffn {Função} os.setregid (rgid, egid, /)

Define os IDs de grupo real e efetivo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@geindex setresgid() (no módulo os)
@anchor{library/os os setresgid}@anchor{135b}
@deffn {Função} os.setresgid (rgid, egid, sgid, /)

Define os IDs de grupo real, efetivo e salvo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.


Adicionado na versão 3.2.

@end deffn

@geindex setresuid() (no módulo os)
@anchor{library/os os setresuid}@anchor{135c}
@deffn {Função} os.setresuid (ruid, euid, suid, /)

Define os IDs de usuário real, efetivo e salvo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.


Adicionado na versão 3.2.

@end deffn

@geindex setreuid() (no módulo os)
@anchor{library/os os setreuid}@anchor{2d01}
@deffn {Função} os.setreuid (ruid, euid, /)

Define os IDs de usuário real e efetivo do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@geindex getsid() (no módulo os)
@anchor{library/os os getsid}@anchor{2d02}
@deffn {Função} os.getsid (pid, /)

Executa a chamada de sistema @code{getsid()}. Veja o manual do Unix para semântica.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex setsid() (no módulo os)
@anchor{library/os os setsid}@anchor{1b4c}
@deffn {Função} os.setsid ()

Executa a chamada de sistema @code{setsid()}. Veja o manual do Unix para semântica.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex setuid() (no módulo os)
@anchor{library/os os setuid}@anchor{2d03}
@deffn {Função} os.setuid (uid, /)

@geindex usuário;definição de id

Define o ID de usuário do processo atual.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.
@end deffn

@c placed in this section since it relates to errno.... a little weak

@geindex strerror() (no módulo os)
@anchor{library/os os strerror}@anchor{2d04}
@deffn {Função} os.strerror (code, /)

Retorna a mensagem de erro correspondente ao código de erro em `code'. Nas plataformas em que @code{strerror()} retorna @code{NULL} quando recebe um número de erro desconhecido, @ref{202,,ValueError} é levantada.
@end deffn

@geindex supports_bytes_environ (no módulo os)
@anchor{library/os os supports_bytes_environ}@anchor{1255}
@deffn {Dado} os.supports_bytes_environ

@code{True} se o tipo de sistema operacional nativo do ambiente estiver em bytes (por exemplo, @code{False} no Windows).


Adicionado na versão 3.2.

@end deffn

@geindex umask() (no módulo os)
@anchor{library/os os umask}@anchor{2d05}
@deffn {Função} os.umask (mask, /)

Define o umask numérico atual e retorna o umask anterior.

A função é uma simulação em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end deffn

@geindex uname() (no módulo os)
@anchor{library/os os uname}@anchor{1155}
@deffn {Função} os.uname ()

@geindex gethostname() (no módulo socket)
@geindex gethostbyaddr() (no módulo socket)

Retorna informações identificando o sistema operacional atual. O valor retornado é um objeto com cinco atributos:


@itemize *

@item 
@code{sysname} - nome do sistema operacional

@item 
@code{nodename} - nome da máquina na rede (definido pela implementação)

@item 
@code{release} - lançamento do sistema operacional

@item 
@code{version} - versão do sistema operacional

@item 
@code{machine} - identificador de hardware
@end itemize

Para compatibilidade com versões anteriores, esse objeto também é iterável, comportando-se como uma tupla de 5 elementos contendo @code{sysname}, @code{nodename}, @code{release}, @code{version} e @code{machine} nessa ordem.

Alguns sistemas truncam @code{nodename} para 8 caracteres ou para o componente principal; uma maneira melhor de obter o nome do host é @ref{2d06,,socket.gethostname()} ou até mesmo @code{socket.gethostbyaddr(socket.gethostname())}.

No macOS, iOS e Android, retorna o nome e a versão do `kernel' (ou seja, @code{'Darwin'} no macOS e iOS; @code{'Linux'} no Android). @ref{1baa,,platform.uname()} pode ser usada para obter o nome e a versão do sistema operacional voltado para o usuário no iOS e Android.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.3: Tipo de retorno foi alterado de uma tupla para um objeto tupla ou similar com atributos nomeados.

@end deffn

@geindex unsetenv() (no módulo os)
@anchor{library/os os unsetenv}@anchor{921}
@deffn {Função} os.unsetenv (key, /)

@geindex variáveis de ambiente;exclusão

Cancela (exclui) a variável de ambiente denominada `key'. Tais mudanças no ambiente afetam subprocessos iniciados com @ref{14a5,,os.system()}, @ref{a91,,popen()} ou @ref{197,,fork()} e @ref{2cf9,,execv()}.

A exclusão de itens em @ref{11f9,,os.environ} é automaticamente traduzida para uma chamada correspondente a @ref{921,,unsetenv()}; no entanto, chamadas a @ref{921,,unsetenv()} não atualizam @ref{11f9,,os.environ}, por isso, na verdade é preferível excluir itens de @ref{11f9,,os.environ}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.unsetenv} com o argumento @code{key}.


Alterado na versão 3.9: A função está agora sempre disponível e também está disponível no Windows.

@end deffn

@geindex unshare() (no módulo os)
@anchor{library/os os unshare}@anchor{18cb}
@deffn {Função} os.unshare (flags)

Desassocia partes do contexto de execução do processo e move-as para um espaço de nomes recém-criado. Veja a página man @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}} para mais detalhes. O argumento `flags' é uma máscara de bits, combinando zero ou mais @ref{2cfd,,constantes CLONE_*}, que especifica quais partes do contexto de execução devem ser descompartilhadas de suas associações existentes e movidas para um novo espaço de nomes. Se o argumento `flags' for @code{0}, nenhuma alteração será feita no contexto de execução do processo de chamada.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.16.


Adicionado na versão 3.12.



@subsubheading Ver também


A função @ref{18ca,,setns()}.

@end deffn
@anchor{library/os os-unshare-clone-flags}@anchor{2cfd}
Sinalizações para a função @ref{18cb,,unshare()}, se a implementação oferecer suporte. Veja @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}} no manual do Linux para seu exato efeito e disponibilidade.

@geindex CLONE_FILES (no módulo os)
@geindex CLONE_FS (no módulo os)
@geindex CLONE_NEWCGROUP (no módulo os)
@geindex CLONE_NEWIPC (no módulo os)
@geindex CLONE_NEWNET (no módulo os)
@geindex CLONE_NEWNS (no módulo os)
@geindex CLONE_NEWPID (no módulo os)
@geindex CLONE_NEWTIME (no módulo os)
@geindex CLONE_NEWUSER (no módulo os)
@geindex CLONE_NEWUTS (no módulo os)
@geindex CLONE_SIGHAND (no módulo os)
@geindex CLONE_SYSVSEM (no módulo os)
@geindex CLONE_THREAD (no módulo os)
@geindex CLONE_VM (no módulo os)
@anchor{library/os os CLONE_FILES}@anchor{2d07}
@deffn {Dado} os.CLONE_FILES
@anchor{library/os os CLONE_FS}@anchor{2d08}
@deffnx {Dado} os.CLONE_FS
@anchor{library/os os CLONE_NEWCGROUP}@anchor{2d09}
@deffnx {Dado} os.CLONE_NEWCGROUP
@anchor{library/os os CLONE_NEWIPC}@anchor{2d0a}
@deffnx {Dado} os.CLONE_NEWIPC
@anchor{library/os os CLONE_NEWNET}@anchor{2d0b}
@deffnx {Dado} os.CLONE_NEWNET
@anchor{library/os os CLONE_NEWNS}@anchor{2d0c}
@deffnx {Dado} os.CLONE_NEWNS
@anchor{library/os os CLONE_NEWPID}@anchor{2d0d}
@deffnx {Dado} os.CLONE_NEWPID
@anchor{library/os os CLONE_NEWTIME}@anchor{2d0e}
@deffnx {Dado} os.CLONE_NEWTIME
@anchor{library/os os CLONE_NEWUSER}@anchor{2d0f}
@deffnx {Dado} os.CLONE_NEWUSER
@anchor{library/os os CLONE_NEWUTS}@anchor{2d10}
@deffnx {Dado} os.CLONE_NEWUTS
@anchor{library/os os CLONE_SIGHAND}@anchor{2d11}
@deffnx {Dado} os.CLONE_SIGHAND
@anchor{library/os os CLONE_SYSVSEM}@anchor{2d12}
@deffnx {Dado} os.CLONE_SYSVSEM
@anchor{library/os os CLONE_THREAD}@anchor{2d13}
@deffnx {Dado} os.CLONE_THREAD
@anchor{library/os os CLONE_VM}@anchor{2d14}
@deffnx {Dado} os.CLONE_VM
@end deffn

@node Criação de objetos arquivos,Operações dos descritores de arquivos,Parâmetros de processo,os — Diversas interfaces de sistema operacional
@anchor{library/os file-object-creation}@anchor{2d15}@anchor{library/os os-newstreams}@anchor{2d16}
@subsubsection Criação de objetos arquivos


Estas funções criam novos @ref{1203,,objetos arquivos}. (Veja também @ref{dba,,open()} para abrir os descritores de arquivos.)

@geindex fdopen() (no módulo os)
@anchor{library/os os fdopen}@anchor{20c4}
@deffn {Função} os.fdopen (fd, *args, **kwargs)

Retorna um objeto arquivo aberto conectado ao descritor de arquivo `fd'. Este é um apelido para a função embutida @ref{51c,,open()} e aceita os mesmos argumentos. A única diferença é que o primeiro argumento de @ref{20c4,,fdopen()} deve ser sempre um inteiro.
@end deffn

@node Operações dos descritores de arquivos,Arquivos e diretórios,Criação de objetos arquivos,os — Diversas interfaces de sistema operacional
@anchor{library/os file-descriptor-operations}@anchor{2d17}@anchor{library/os os-fd-ops}@anchor{2d18}
@subsubsection Operações dos descritores de arquivos


Estas funções operam em fluxos de E/S referenciados usando descritores de arquivos.

Descritores de arquivos são pequenos números inteiros correspondentes a um arquivo que foi aberto pelo processo atual. Por exemplo, a entrada padrão geralmente é o descritor de arquivo 0, a saída padrão 1 e erro padrão 2. Outros arquivos abertos por um processo serão então atribuídos 3, 4, 5, e assim por diante. O nome “descritor de arquivo” é um pouco enganoso; em plataformas UNIX, sockets e pipes também são referenciados como descritores de arquivos.

O método @ref{15d0,,fileno()} pode ser usado para obter o descritor de arquivo associado a um @ref{1203,,objeto arquivo} quando solicitado. Note-se que usar o descritor de arquivo diretamente ignorará os métodos do objeto arquivo, ignorando aspectos como buffer interno de dados.

@geindex close() (no módulo os)
@anchor{library/os os close}@anchor{b8a}
@deffn {Função} os.close (fd)

Fecha o descritor de arquivo `fd'.

@cartouche
@quotation Nota 
Esta função destina-se a E/S de baixo nível e deve ser aplicada a um descritor de arquivo retornado por @ref{dba,,os.open()} ou @ref{18ef,,pipe()}. Para fechar um “objeto arquivo” retornado pela função embutida @ref{51c,,open()} ou por @ref{a91,,popen()} ou @ref{20c4,,fdopen()}, use seu método @ref{1f6,,close()}.
@end quotation
@end cartouche
@end deffn

@geindex closerange() (no módulo os)
@anchor{library/os os closerange}@anchor{2d19}
@deffn {Função} os.closerange (fd_low, fd_high, /)

Fecha todos os descritores de arquivos de `fd_low' (inclusivo) a `fd_high' (exclusivo), ignorando erros. Equivalente a (mas muito mais rápido do 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() (no módulo os)
@anchor{library/os os copy_file_range}@anchor{2d1a}
@deffn {Função} os.copy_file_range (src, dst, count, offset_src=None, offset_dst=None)

Copia `count' bytes do descritor de arquivo `src', começando no deslocamento `offset_src', para o descritor de arquivo `dst', começando no deslocamento `offset_dst'. Se `offset_src' for @code{None}, `src' será lido a partir da posição atual; respectivamente para `offset_dst'.

No kernel Linux anterior a 5.3, os arquivos apontados por `src' e `dst' devem residir no mesmo sistema de arquivos, caso contrário, uma exceção @ref{417,,OSError} é levantada com @ref{15d5,,errno} definido como @ref{2d1b,,errno.EXDEV}.

Essa cópia é feita sem o custo adicional de transferência de dados do kernel para o espaço do usuário e depois de volta para o kernel. Além disso, alguns sistemas de arquivos podem implementar otimizações extras, como o uso de reflinks (ou seja, dois ou mais nós-i que compartilham ponteiros para os mesmos blocos de disco copy-on-write; os sistemas de arquivos suportados incluem btrfs e XFS) e cópia do lado do servidor (no caso de NFS).

A função copia bytes entre dois descritores de arquivo. As opções de texto, como a codificação e o final da linha, são ignoradas.

O valor de retorno é a quantidade de bytes copiados. Ele pode ser inferior à quantidade solicitada.

@cartouche
@quotation Nota 
No Linux, @ref{2d1a,,os.copy_file_range()} não deve ser usada para copiar um intervalo de um pseudo arquivo de um sistema de arquivos especial como procfs e sysfs. Ele nunca copiará byte algum e retornará 0 como se o arquivo estivesse vazio devido a um problema conhecido do kernel do Linux.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Linux >= 4.5 with glibc >= 2.27.


Adicionado na versão 3.8.

@end deffn

@geindex device_encoding() (no módulo os)
@anchor{library/os os device_encoding}@anchor{19c0}
@deffn {Função} os.device_encoding (fd)

Retorna uma string descrevendo a codificação do dispositivo associado a `fd' se estiver conectado a um terminal; senão retorna @ref{675,,None}.

No Unix, se o @ref{656,,Modo UTF-8 do Python} estiver habilitado, retorna @code{'UTF-8'} ao invés da codificação do dispositivo.


Alterado na versão 3.10: No Unix, a função agora implementa o Modo UTF-8 do Python.

@end deffn

@geindex dup() (no módulo os)
@anchor{library/os os dup}@anchor{1b54}
@deffn {Função} os.dup (fd, /)

Retorna uma cópia do descritor de arquivo `fd'. O novo descritor de arquivo é @ref{f2b,,não-herdável}.

No Windows, ao duplicar um fluxo padrão (0: stdin, 1: stdout, 2: stderr), o novo descritor de arquivo é @ref{f2b,,herdável}.

@ref{1ed8,,Disponibilidade}: not WASI.


Alterado na versão 3.4: O novo descritor de arquivo agora é não-hereditário.

@end deffn

@geindex dup2() (no módulo os)
@anchor{library/os os dup2}@anchor{b79}
@deffn {Função} os.dup2 (fd, fd2, inheritable=True)

Duplica o descritor de arquivo `fd' como `fd2', fechando o último antes disso, se necessário. Retorna `fd2'. O novo descritor de arquivo é @ref{f2b,,herdável} por padrão ou não-herdável se `inheritable' for @code{False}.

@ref{1ed8,,Disponibilidade}: not WASI.


Alterado na versão 3.4: Adicionado o parâmetro opcional `inheritable'.



Alterado na versão 3.7: Retorna `fd2' em caso de sucesso. Anteriormente, retornava sempre @code{None}.

@end deffn

@geindex fchmod() (no módulo os)
@anchor{library/os os fchmod}@anchor{21c}
@deffn {Função} os.fchmod (fd, mode)

Altera o modo do arquivo dado por `fd' ao `mode' numérico. Veja a documentação de @ref{21b,,chmod()} para valores possíveis de `mode'. A partir do Python 3.3, isto é equivalente a @code{os.chmod(fd, mode)}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chmod} com os argumentos @code{path}, @code{mode}, @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.


Alterado na versão 3.13: Adicionado suporte no Windows.

@end deffn

@geindex fchown() (no módulo os)
@anchor{library/os os fchown}@anchor{db2}
@deffn {Função} os.fchown (fd, uid, gid)

Altera o ID do proprietário e do grupo do arquivo dado por `fd' para o `uid' e `gid' numérico. Para deixar um dos IDs inalteradas, defina-o como -1. Veja @ref{112d,,chown()}. A partir do Python 3.3, isto é equivalente a @code{os.chown(fd, uid, gid)}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chown} com os argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end deffn

@geindex fdatasync() (no módulo os)
@anchor{library/os os fdatasync}@anchor{db3}
@deffn {Função} os.fdatasync (fd)

Força a gravação do arquivo com descritor de arquivo `fd' no disco. Não força a atualização de metadados.

@ref{1ed8,,Disponibilidade}: Unix.

@cartouche
@quotation Nota 
Esta função não está disponível no MacOS.
@end quotation
@end cartouche
@end deffn

@geindex fpathconf() (no módulo os)
@anchor{library/os os fpathconf}@anchor{2d1c}
@deffn {Função} os.fpathconf (fd, name, /)

Retorna informações de configuração de sistema relevantes para um arquivo aberto. `name' especifica o valor de configuração para recuperar; pode ser uma string que é o nome de um valor do sistema definido; estes nomes são especificados em uma série de padrões (POSIX.1, Unix 95, Unix 98 e outros). Algumas plataformas definem nomes adicionais também. Os nomes conhecidos do sistema operacional hospedeiro são dadas no dicionário @code{pathconf_names}. Para variáveis de configuração não incluídas neste mapeamento, também é aceito passar um número inteiro para `name'.

Se `name' for uma string e não for conhecida, uma exceção @ref{202,,ValueError} é levantada. Se um valor específico para `name' não for compatível com o sistema hospedeiro, mesmo que seja incluído no @code{pathconf_names}, uma exceção @ref{417,,OSError} é levantada com @ref{1b66,,errno.EINVAL} como número do erro.

A partir do Python 3.3, é equivalente a @code{os.pathconf(fd, name)}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex fstat() (no módulo os)
@anchor{library/os os fstat}@anchor{db4}
@deffn {Função} os.fstat (fd)

Captura o estado do descritor de arquivo `fd'. Retorna um objeto @ref{1509,,stat_result}.

A partir do Python 3.3, é equivalente a @code{os.stat(fd)}.


@subsubheading Ver também


A função @ref{4a0,,stat()}.

@end deffn

@geindex fstatvfs() (no módulo os)
@anchor{library/os os fstatvfs}@anchor{db5}
@deffn {Função} os.fstatvfs (fd, /)

Retorna informações sobre o sistema de arquivos que contém o arquivo associado com descritor de arquivo `fd', como @ref{113b,,statvfs()}. A partir do Python 3.3, isso equivale a @code{os.statvfs(fd)}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex fsync() (no módulo os)
@anchor{library/os os fsync}@anchor{db6}
@deffn {Função} os.fsync (fd)

Força a gravação no disco de arquivo com descritor de arquivo `fd'. No Unix, isto chama a função nativa @code{fsync()}; no Windows, a função de MS @code{_commit()}.

Se você estiver começando com um @ref{1203,,objeto arquivo} `f' em buffer do Python, primeiro use @code{f.flush()}, e depois use @code{os.fsync(f.fileno())}, para garantir que todos os buffers internos associados com `f' sejam gravados no disco.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex ftruncate() (no módulo os)
@anchor{library/os os ftruncate}@anchor{db7}
@deffn {Função} os.ftruncate (fd, length, /)

Trunca o arquivo correspondente ao descritor de arquivo `fd', de modo que tenha no máximo `length' bytes de tamanho. A partir do Python 3.3, isto é equivalente a @code{os.truncate(fd, length)}.

Levanta @ref{19fa,,evento de auditoria} @code{os.truncate} com os argumentos @code{fd}, @code{length}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.5: Adicionado suporte para o Windows.

@end deffn

@geindex get_blocking() (no módulo os)
@anchor{library/os os get_blocking}@anchor{e66}
@deffn {Função} os.get_blocking (fd, /)

Obtém o modo de bloqueio do descritor de arquivo: @code{False} se o sinalizador @ref{e68,,O_NONBLOCK} estiver marcado, @code{True} se o sinalizador estiver desmarcado.

Veja também @ref{e67,,set_blocking()} e @ref{2d1d,,socket.socket.setblocking()}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

No Windows, esta função é limitada a encadeamentos.


Adicionado na versão 3.5.



Alterado na versão 3.12: Adicionado suporte a encadeamentos no Windows.

@end deffn

@geindex grantpt() (no módulo os)
@anchor{library/os os grantpt}@anchor{1779}
@deffn {Função} os.grantpt (fd, /)

Concede acesso ao dispositivo pseudoterminal secundário associado ao dispositivo pseudoterminal principal ao qual o descritor de arquivo `fd' se refere. O descritor de arquivo `fd' não é fechado em caso de falha.

Chama a função @code{grantpt()} da biblioteca padrão C.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.13.

@end deffn

@geindex isatty() (no módulo os)
@anchor{library/os os isatty}@anchor{19bf}
@deffn {Função} os.isatty (fd, /)

Retorna @code{True} se o descritor de arquivo `fd' estiver aberto e conectado a um dispositivo do tipo tty, senão @code{False}.
@end deffn

@geindex lockf() (no módulo os)
@anchor{library/os os lockf}@anchor{1152}
@deffn {Função} os.lockf (fd, cmd, len, /)

Aplica, testa ou remove uma trava POSIX em um descritor de arquivo aberto. `fd' é um descritor de arquivo aberto. `cmd' especifica o comando a ser usado - um dentre @ref{2d1e,,F_LOCK}, @ref{2d1f,,F_TLOCK}, @ref{2d20,,F_ULOCK} ou @ref{2d21,,F_TEST}. `len' especifica a seção do arquivo para travar.

Levanta um @ref{19fa,,evento de auditoria} @code{os.lockf} com os argumentos @code{fd}, @code{cmd}, @code{len}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex F_LOCK (no módulo os)
@geindex F_TLOCK (no módulo os)
@geindex F_ULOCK (no módulo os)
@geindex F_TEST (no módulo os)
@anchor{library/os os F_LOCK}@anchor{2d1e}
@deffn {Dado} os.F_LOCK
@anchor{library/os os F_TLOCK}@anchor{2d1f}
@deffnx {Dado} os.F_TLOCK
@anchor{library/os os F_ULOCK}@anchor{2d20}
@deffnx {Dado} os.F_ULOCK
@anchor{library/os os F_TEST}@anchor{2d21}
@deffnx {Dado} os.F_TEST

Sinalizadores que especificam qual ação @ref{1152,,lockf()} vai executar.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex login_tty() (no módulo os)
@anchor{library/os os login_tty}@anchor{1852}
@deffn {Função} os.login_tty (fd, /)

Prepara o tty do qual fd é um descritor de arquivo para uma nova sessão de login. Faz do processo de chamada um líder de sessão; torna o tty o tty de controle, o stdin, o stdout e o stderr do processo de chamada; fecha o fd.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.11.

@end deffn

@geindex lseek() (no módulo os)
@anchor{library/os os lseek}@anchor{1156}
@deffn {Função} os.lseek (fd, pos, whence, /)

Define a posição atual do descritor de arquivo `fd' para a posição `pos', modificada por `whence', e retorna a nova posição em bytes relativa ao início do arquivo. Os valores válidos de `whence' são:


@itemize *

@item 
@ref{12cf,,SEEK_SET} ou @code{0} – define `pos' em relação ao início do arquivo

@item 
@ref{12d0,,SEEK_CUR} ou @code{1} – define `pos' em relação à posição atual do arquivo

@item 
@ref{12d1,,SEEK_END} ou @code{2} – define `pos' em relação ao final do arquivo

@item 
@ref{2d22,,SEEK_HOLE} – define `pos' para o próximo local de dados, em relação a `pos'

@item 
@ref{2d23,,SEEK_DATA} – define `pos' para o próximo buraco de dados, em relação a `pos'
@end itemize


Alterado na versão 3.3: Adicionado suporte para @code{SEEK_HOLE} e @code{SEEK_DATA}.

@end deffn

@geindex SEEK_SET (no módulo os)
@geindex SEEK_CUR (no módulo os)
@geindex SEEK_END (no módulo os)
@anchor{library/os os SEEK_SET}@anchor{12cf}
@deffn {Dado} os.SEEK_SET
@anchor{library/os os SEEK_CUR}@anchor{12d0}
@deffnx {Dado} os.SEEK_CUR
@anchor{library/os os SEEK_END}@anchor{12d1}
@deffnx {Dado} os.SEEK_END

Parâmetros para a função @ref{1156,,lseek()} e o método @ref{12ce,,seek()} em @ref{1203,,objetos arquivo ou similares}, para onde ajustar o indicador de posição do arquivo.


@table @asis

@item @ref{12cf,,SEEK_SET}

Ajusta a posição do arquivo em relação ao início do arquivo.

@item @ref{12d0,,SEEK_CUR}

Ajusta a posição do arquivo em relação a sua posição atual.

@item @ref{12d1,,SEEK_END}

Ajusta a posição do arquivo em relação ao fim do arquivo.
@end table

Seus valores são 0, 1 e 2, respectivamente.
@end deffn

@geindex SEEK_HOLE (no módulo os)
@geindex SEEK_DATA (no módulo os)
@anchor{library/os os SEEK_HOLE}@anchor{2d22}
@deffn {Dado} os.SEEK_HOLE
@anchor{library/os os SEEK_DATA}@anchor{2d23}
@deffnx {Dado} os.SEEK_DATA

Parâmetros para a função @ref{1156,,lseek()} e o método @ref{12ce,,seek()} em @ref{1203,,objetos arquivo ou similares}, para para buscar dados de arquivos e buracos em arquivos alocados de forma esparsa.


@table @asis

@item @code{SEEK_DATA}

Ajusta o deslocamento do arquivo para o próximo local contendo dados, em relação à posição de busca.

@item @code{SEEK_HOLE}

Ajusta o deslocamento do arquivo para o próximo local contendo um buraco, em relação à posição de busca. Um buraco é definido como uma sequência de zeros.
@end table

@cartouche
@quotation Nota 
Essas operações só fazem sentido para sistemas de arquivos que as suportam.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Linux >= 3.1, macOS, Unix


Adicionado na versão 3.3.

@end deffn

@geindex open() (no módulo os)
@anchor{library/os os open}@anchor{dba}
@deffn {Função} os.open (path, flags, mode=0o777, *, dir_fd=None)

Abre o arquivo `path' e define vários sinalizadores de acordo com `flags' e, possivelmente, seu modo, de acordo com `mode'. Ao computar `mode', o valor atual de umask é primeiro mascarado. Retorna o descritor de arquivo para o arquivo recém-aberto. O novo descritor de arquivo é @ref{f2b,,não-herdável}.

Para ler uma descrição dos valores de sinalizadores e modos, veja a documentação de C; constantes de sinalizador (como @ref{2d24,,O_RDONLY} e @ref{2d25,,O_WRONLY}) são definidas no módulo @ref{a1,,os}. Em particular, no Windows é necessário adicionar @ref{2d26,,O_BINARY} para abrir arquivos em modo binário.

Esta função oferece suporte para @ref{1129,,caminhos relativos aos descritores de diretório} com o parâmetro `dir_fd'.

Levanta um @ref{19fa,,evento de auditoria} @code{open} com os argumentos @code{path}, @code{mode}, @code{flags}.


Alterado na versão 3.4: O novo descritor de arquivo agora é não-hereditário.


@cartouche
@quotation Nota 
Esta função é destinada a E/S de baixo nível. Para uso normal, use a função embutida @ref{51c,,open()}, que retorna um @ref{1203,,objeto arquivo} com os métodos @code{read()} e @code{write()} (e muitos mais). Para envolver um descritor de arquivo em um objeto arquivo, use @ref{20c4,,fdopen()}.
@end quotation
@end cartouche


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.5: Se a chamada de sistema é interrompida e o tratador de sinal não levanta uma exceção, a função agora tenta novamente a chamada de sistema em vez de levantar uma exceção @ref{db0,,InterruptedError} (consulte 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para entender a justificativa).



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

As seguintes constantes são opções para o parâmetro `flags' da função @ref{dba,,open()}. Elas podem ser combinadas usando o operador bit a bit OU @code{|}. Algumas delas não estão disponíveis em todas as plataformas. Para obter descrições de sua disponibilidade e uso, consulte a página de manual @code{open(2)@footnote{https://manpages.debian.org/open(2)}} para Unix ou o MSDN@footnote{https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx} para Windows.

@geindex O_RDONLY (no módulo os)
@geindex O_WRONLY (no módulo os)
@geindex O_RDWR (no módulo os)
@geindex O_APPEND (no módulo os)
@geindex O_CREAT (no módulo os)
@geindex O_EXCL (no módulo os)
@geindex O_TRUNC (no módulo os)
@anchor{library/os os O_RDONLY}@anchor{2d24}
@deffn {Dado} os.O_RDONLY
@anchor{library/os os O_WRONLY}@anchor{2d25}
@deffnx {Dado} os.O_WRONLY
@anchor{library/os os O_RDWR}@anchor{2d27}
@deffnx {Dado} os.O_RDWR
@anchor{library/os os O_APPEND}@anchor{2d28}
@deffnx {Dado} os.O_APPEND
@anchor{library/os os O_CREAT}@anchor{2d29}
@deffnx {Dado} os.O_CREAT
@anchor{library/os os O_EXCL}@anchor{2a08}
@deffnx {Dado} os.O_EXCL
@anchor{library/os os O_TRUNC}@anchor{2d2a}
@deffnx {Dado} os.O_TRUNC

As constantes acima estão disponíveis no Unix e Windows.
@end deffn

@geindex O_DSYNC (no módulo os)
@geindex O_RSYNC (no módulo os)
@geindex O_SYNC (no módulo os)
@geindex O_NDELAY (no módulo os)
@geindex O_NONBLOCK (no módulo os)
@geindex O_NOCTTY (no módulo os)
@geindex O_CLOEXEC (no módulo os)
@anchor{library/os os O_DSYNC}@anchor{2d2b}
@deffn {Dado} os.O_DSYNC
@anchor{library/os os O_RSYNC}@anchor{2d2c}
@deffnx {Dado} os.O_RSYNC
@anchor{library/os os O_SYNC}@anchor{2d2d}
@deffnx {Dado} os.O_SYNC
@anchor{library/os os O_NDELAY}@anchor{2d2e}
@deffnx {Dado} os.O_NDELAY
@anchor{library/os os O_NONBLOCK}@anchor{e68}
@deffnx {Dado} os.O_NONBLOCK
@anchor{library/os os O_NOCTTY}@anchor{2d2f}
@deffnx {Dado} os.O_NOCTTY
@anchor{library/os os O_CLOEXEC}@anchor{10b5}
@deffnx {Dado} os.O_CLOEXEC

As constantes acima estão disponíveis apenas no Unix.


Alterado na versão 3.3: Adicionada a constante @ref{10b5,,O_CLOEXEC}.

@end deffn

@geindex O_BINARY (no módulo os)
@geindex O_NOINHERIT (no módulo os)
@geindex O_SHORT_LIVED (no módulo os)
@geindex O_TEMPORARY (no módulo os)
@geindex O_RANDOM (no módulo os)
@geindex O_SEQUENTIAL (no módulo os)
@geindex O_TEXT (no módulo os)
@anchor{library/os os O_BINARY}@anchor{2d26}
@deffn {Dado} os.O_BINARY
@anchor{library/os os O_NOINHERIT}@anchor{2d30}
@deffnx {Dado} os.O_NOINHERIT
@anchor{library/os os O_SHORT_LIVED}@anchor{2d31}
@deffnx {Dado} os.O_SHORT_LIVED
@anchor{library/os os O_TEMPORARY}@anchor{2d32}
@deffnx {Dado} os.O_TEMPORARY
@anchor{library/os os O_RANDOM}@anchor{2d33}
@deffnx {Dado} os.O_RANDOM
@anchor{library/os os O_SEQUENTIAL}@anchor{2d34}
@deffnx {Dado} os.O_SEQUENTIAL
@anchor{library/os os O_TEXT}@anchor{2d35}
@deffnx {Dado} os.O_TEXT

As constantes acima estão disponíveis apenas no Windows.
@end deffn

@geindex O_EVTONLY (no módulo os)
@geindex O_FSYNC (no módulo os)
@geindex O_SYMLINK (no módulo os)
@geindex O_NOFOLLOW_ANY (no módulo os)
@anchor{library/os os O_EVTONLY}@anchor{81d}
@deffn {Dado} os.O_EVTONLY
@anchor{library/os os O_FSYNC}@anchor{81e}
@deffnx {Dado} os.O_FSYNC
@anchor{library/os os O_SYMLINK}@anchor{81f}
@deffnx {Dado} os.O_SYMLINK
@anchor{library/os os O_NOFOLLOW_ANY}@anchor{820}
@deffnx {Dado} os.O_NOFOLLOW_ANY

As constantes acima estão disponíveis apenas no macOS.


Alterado na versão 3.10: Adicionadas as constantes @ref{81d,,O_EVTONLY}, @ref{81e,,O_FSYNC}, @ref{81f,,O_SYMLINK} e @ref{820,,O_NOFOLLOW_ANY}.

@end deffn

@geindex O_ASYNC (no módulo os)
@geindex O_DIRECT (no módulo os)
@geindex O_DIRECTORY (no módulo os)
@geindex O_NOFOLLOW (no módulo os)
@geindex O_NOATIME (no módulo os)
@geindex O_PATH (no módulo os)
@geindex O_TMPFILE (no módulo os)
@geindex O_SHLOCK (no módulo os)
@geindex O_EXLOCK (no módulo os)
@anchor{library/os os O_ASYNC}@anchor{2d36}
@deffn {Dado} os.O_ASYNC
@anchor{library/os os O_DIRECT}@anchor{2d37}
@deffnx {Dado} os.O_DIRECT
@anchor{library/os os O_DIRECTORY}@anchor{2d38}
@deffnx {Dado} os.O_DIRECTORY
@anchor{library/os os O_NOFOLLOW}@anchor{2d39}
@deffnx {Dado} os.O_NOFOLLOW
@anchor{library/os os O_NOATIME}@anchor{2d3a}
@deffnx {Dado} os.O_NOATIME
@anchor{library/os os O_PATH}@anchor{fa6}
@deffnx {Dado} os.O_PATH
@anchor{library/os os O_TMPFILE}@anchor{fa7}
@deffnx {Dado} os.O_TMPFILE
@anchor{library/os os O_SHLOCK}@anchor{1476}
@deffnx {Dado} os.O_SHLOCK
@anchor{library/os os O_EXLOCK}@anchor{1477}
@deffnx {Dado} os.O_EXLOCK

As constantes acima são extensões e não estarão presentes, se não forem definidos pela biblioteca C.


Alterado na versão 3.4: Adicionada @ref{fa6,,O_PATH} em sistemas que oferecem suporte. Adicionada @ref{fa7,,O_TMPFILE}, somente disponível no kernel Linux 3.11 ou mais recente.

@end deffn

@geindex openpty() (no módulo os)
@anchor{library/os os openpty}@anchor{2d3b}
@deffn {Função} os.openpty ()

@geindex módulo;pty

Abre um novo par de pseudo-terminal. Retorna um par de descritores de arquivos @code{(master, slave)} para o pty e o tty, respectivamente. Os novos descritores de arquivos são @ref{f2b,,não-herdáveis}. Para uma abordagem (ligeiramente) mais portável, use o módulo @ref{b1,,pty}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Alterado na versão 3.4: Os novos descritores de arquivos agora são não-herdáveis.

@end deffn

@geindex pipe() (no módulo os)
@anchor{library/os os pipe}@anchor{18ef}
@deffn {Função} os.pipe ()

Cria um encadeamento (pipe). Retorna um par de descritores de arquivos @code{(r, w)} usáveis para leitura e escrita, respectivamente. O novo descritor de arquivo é @ref{f2b,,não-herdável}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.4: Os novos descritores de arquivos agora são não-herdáveis.

@end deffn

@geindex pipe2() (no módulo os)
@anchor{library/os os pipe2}@anchor{1128}
@deffn {Função} os.pipe2 (flags, /)

Cria um encadeamento (pipe) com `flags' definidos atomicamente. `flags' podem ser construídos por aplicação de OU junto a um ou mais destes valores: @ref{e68,,O_NONBLOCK}, @ref{10b5,,O_CLOEXEC}. Retorna um par de descritores de arquivos @code{(r, w)} utilizáveis para leitura e gravação, respectivamente.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex posix_fallocate() (no módulo os)
@anchor{library/os os posix_fallocate}@anchor{dbc}
@deffn {Função} os.posix_fallocate (fd, offset, len, /)

Garante que um espaço em disco suficiente seja alocado para o arquivo especificado por `fd' iniciando em `offset' e continuando por `len' bytes.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex posix_fadvise() (no módulo os)
@anchor{library/os os posix_fadvise}@anchor{dbb}
@deffn {Função} os.posix_fadvise (fd, offset, len, advice, /)

Anuncia a intenção de acessar dados em um padrão específico, permitindo assim que o kernel faça otimizações. O conteúdo em `advice' se aplica à região do arquivo especificado por `fd', iniciando em `offset' e continuando por `len' bytes. `advice' é um entre @ref{2d3c,,POSIX_FADV_NORMAL}, @ref{2d3d,,POSIX_FADV_SEQUENTIAL}, @ref{2d3e,,POSIX_FADV_RANDOM}, @ref{2d3f,,POSIX_FADV_NOREUSE}, @ref{2d40,,POSIX_FADV_WILLNEED} ou @ref{2d41,,POSIX_FADV_DONTNEED}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex POSIX_FADV_NORMAL (no módulo os)
@geindex POSIX_FADV_SEQUENTIAL (no módulo os)
@geindex POSIX_FADV_RANDOM (no módulo os)
@geindex POSIX_FADV_NOREUSE (no módulo os)
@geindex POSIX_FADV_WILLNEED (no módulo os)
@geindex POSIX_FADV_DONTNEED (no módulo os)
@anchor{library/os os POSIX_FADV_NORMAL}@anchor{2d3c}
@deffn {Dado} os.POSIX_FADV_NORMAL
@anchor{library/os os POSIX_FADV_SEQUENTIAL}@anchor{2d3d}
@deffnx {Dado} os.POSIX_FADV_SEQUENTIAL
@anchor{library/os os POSIX_FADV_RANDOM}@anchor{2d3e}
@deffnx {Dado} os.POSIX_FADV_RANDOM
@anchor{library/os os POSIX_FADV_NOREUSE}@anchor{2d3f}
@deffnx {Dado} os.POSIX_FADV_NOREUSE
@anchor{library/os os POSIX_FADV_WILLNEED}@anchor{2d40}
@deffnx {Dado} os.POSIX_FADV_WILLNEED
@anchor{library/os os POSIX_FADV_DONTNEED}@anchor{2d41}
@deffnx {Dado} os.POSIX_FADV_DONTNEED

Sinalizadores que podem ser usados em `advice' em @ref{dbb,,posix_fadvise()} que especificam o padrão de acesso que provavelmente será usado.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex pread() (no módulo os)
@anchor{library/os os pread}@anchor{b75}
@deffn {Função} os.pread (fd, n, offset, /)

Lê no máximo `n' bytes do descritor de arquivo `fd' na posição `offset', mantendo o deslocamento do arquivo inalterado.

Retorna uma bytestring contendo os bytes lidos. Se o final do arquivo referido por `fd' for atingido, um objeto de bytes vazio será retornado.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex posix_openpt() (no módulo os)
@anchor{library/os os posix_openpt}@anchor{1778}
@deffn {Função} os.posix_openpt (oflag, /)

Abre e retorna um descritor de arquivo para um dispositivo pseudoterminal mestre.

Chama a função @code{posix_openpt()} da biblioteca padrão C. O argumento `oflag' é usado para definir sinalizadores de status de arquivo e modos de acesso a arquivos conforme especificado na página de manual da @code{posix_openpt()} do seu sistema.

O descritor de arquivo retornado é @ref{f2b,,não herdável}. Se o valor @ref{10b5,,O_CLOEXEC} estiver disponível no sistema, ele é adicionado a `oflag'.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.13.

@end deffn

@geindex preadv() (no módulo os)
@anchor{library/os os preadv}@anchor{b73}
@deffn {Função} os.preadv (fd, buffers, offset, flags=0, /)

Lê de um descritor de arquivo `fd' na posição de `offset' em `buffers' mutáveis de @ref{d4f,,objetos bytes ou similares}, deixando o deslocamento do arquivo inalterado. Transfere os dados para cada buffer até ficar cheio e depois passa para o próximo buffer na sequência para armazenar o restante dos dados.

O argumento `flags' contém um OR bit a bit de zero ou mais dos seguintes sinalizadores:


@itemize -

@item 
@ref{2d42,,RWF_HIPRI}

@item 
@ref{2d43,,RWF_NOWAIT}
@end itemize

Retorna o número total de bytes realmente lidos, que pode ser menor que a capacidade total de todos os objetos.

O sistema operacional pode definir um limite (@ref{1651,,sysconf()} valor @code{'SC_IOV_MAX'}) no número de buffers que podem ser usados.

Combina a funcionalidade de @ref{b74,,os.readv()} e @ref{b75,,os.pread()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

O uso de sinalizadores requer Linux >= 4.6.


Adicionado na versão 3.7.

@end deffn

@geindex RWF_NOWAIT (no módulo os)
@anchor{library/os os RWF_NOWAIT}@anchor{2d43}
@deffn {Dado} os.RWF_NOWAIT

Não aguarda por dados que não estão disponíveis imediatamente. Se esse sinalizador for especificado, a chamada do sistema retorna instantaneamente se for necessário ler dados do armazenamento de backup ou aguardar uma trava.

Se alguns dados foram lidos com sucesso, ele retorna o número de bytes lidos. Se nenhum bytes foi lido, ele retornará @code{-1} e definirá errno como @ref{2435,,errno.EAGAIN}.

@ref{1ed8,,Disponibilidade}: Linux >= 4.14.


Adicionado na versão 3.7.

@end deffn

@geindex RWF_HIPRI (no módulo os)
@anchor{library/os os RWF_HIPRI}@anchor{2d42}
@deffn {Dado} os.RWF_HIPRI

Alta prioridade de leitura/gravação. Permite sistemas de arquivos baseados em blocos para usar a consulta do dispositivo, que fornece latência inferior, mas pode usar recursos adicionais.

Atualmente, no Linux, esse recurso é usável apenas em um descritor de arquivo aberto usando o sinalizador @ref{2d37,,O_DIRECT}.

@ref{1ed8,,Disponibilidade}: Linux >= 4.6.


Adicionado na versão 3.7.

@end deffn

@geindex ptsname() (no módulo os)
@anchor{library/os os ptsname}@anchor{177b}
@deffn {Função} os.ptsname (fd, /)

Retorna o nome do dispositivo pseudoterminal secundário associado ao dispositivo pseudoterminal principal ao qual o descritor de arquivo `fd' se refere. O descritor de arquivo `fd' não é fechado em caso de falha.

Chama a função reentrante @code{ptsname_r()} da biblioteca padrão C se estiver disponível; caso contrário, a função @code{ptsname()} da biblioteca padrão C, que não é garantida como sendo segura para thread, é chamada.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.13.

@end deffn

@geindex pwrite() (no módulo os)
@anchor{library/os os pwrite}@anchor{b78}
@deffn {Função} os.pwrite (fd, str, offset, /)

Escreve a bytestring in `str' no descritor de arquivo `fd' na posição `offset', mantendo o deslocamento do arquivo inalterado.

Retorna o número de bytes realmente escritos.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex pwritev() (no módulo os)
@anchor{library/os os pwritev}@anchor{b76}
@deffn {Função} os.pwritev (fd, buffers, offset, flags=0, /)

Escreve o conteúdo de `buffers' no descritor de arquivo `fd' com um deslocamento `offset', deixando o deslocamento do arquivo inalterado. `buffers' deve ser uma sequência de @ref{d4f,,objetos bytes ou similares}. Os buffers são processados em ordem de vetor. Todo o conteúdo do primeiro buffer é gravado antes de prosseguir para o segundo, e assim por diante.

O argumento `flags' contém um OR bit a bit de zero ou mais dos seguintes sinalizadores:


@itemize -

@item 
@ref{2d44,,RWF_DSYNC}

@item 
@ref{2d45,,RWF_SYNC}

@item 
@ref{1aba,,RWF_APPEND}
@end itemize

Retorna o número total de bytes realmente escritos.

O sistema operacional pode definir um limite (@ref{1651,,sysconf()} valor @code{'SC_IOV_MAX'}) no número de buffers que podem ser usados.

Combina a funcionalidade de @ref{b77,,os.writev()} e @ref{b78,,os.pwrite()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

O uso de sinalizadores requer Linux >= 4.6.


Adicionado na versão 3.7.

@end deffn

@geindex RWF_DSYNC (no módulo os)
@anchor{library/os os RWF_DSYNC}@anchor{2d44}
@deffn {Dado} os.RWF_DSYNC

Fornece um equivalente para gravação do sinalizador @ref{2d2b,,O_DSYNC} da função @ref{dba,,os.open()}. Este efeito de sinalizador se aplica apenas ao intervalo de dados escrito pela chamada de sistema.

@ref{1ed8,,Disponibilidade}: Linux >= 4.7.


Adicionado na versão 3.7.

@end deffn

@geindex RWF_SYNC (no módulo os)
@anchor{library/os os RWF_SYNC}@anchor{2d45}
@deffn {Dado} os.RWF_SYNC

Fornece um equivalente para gravação do sinalizador @ref{2d2d,,O_SYNC} da função @ref{dba,,os.open()}. Este efeito de sinalizador se aplica apenas ao intervalo de dados escrito pela chamada de sistema.

@ref{1ed8,,Disponibilidade}: Linux >= 4.7.


Adicionado na versão 3.7.

@end deffn

@geindex RWF_APPEND (no módulo os)
@anchor{library/os os RWF_APPEND}@anchor{1aba}
@deffn {Dado} os.RWF_APPEND

Fornece um equivalente para gravação do sinalizador @ref{2d28,,O_APPEND} da função @ref{dba,,os.open()}. Esse sinalizador é significante apenas para @ref{b76,,os.pwritev()}, e seu efeito se aplica apenas ao intervalo de dados escrito pela chamada de sistema. O argumento `offset' não afeta a operação de escrita; o dado é sempre adicionado ao fim do arquivo. Contudo, se o argumento `offset' for @code{-1}, o `offset' do arquivo atual é atualizado.

@ref{1ed8,,Disponibilidade}: Linux >= 4.16.


Adicionado na versão 3.10.

@end deffn

@geindex read() (no módulo os)
@anchor{library/os os read}@anchor{dbd}
@deffn {Função} os.read (fd, n, /)

Lê no máximo `n' bytes do descritor de arquivos `fd'.

Retorna uma bytestring contendo os bytes lidos. Se o final do arquivo referido por `fd' for atingido, um objeto de bytes vazio será retornado.

@cartouche
@quotation Nota 
Esta função destina-se a E/S de baixo nível e deve ser aplicada a um descritor de arquivo retornado por @ref{dba,,os.open()} ou @ref{18ef,,pipe()}. Para ler um “objeto arquivo” retornado pela função embutida @ref{51c,,open()} ou por @ref{a91,,popen()} ou @ref{20c4,,fdopen()}, ou @ref{53d,,sys.stdin}, use seus métodos @code{read()} ou @code{readline()}.
@end quotation
@end cartouche


Alterado na versão 3.5: Se a chamada de sistema é interrompida e o tratador de sinal não levanta uma exceção, a função agora tenta novamente a chamada de sistema em vez de levantar uma exceção @ref{db0,,InterruptedError} (consulte 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para entender a justificativa).

@end deffn

@geindex sendfile() (no módulo os)
@anchor{library/os os sendfile}@anchor{b21}
@deffn {Função} os.sendfile (out_fd, in_fd, offset, count)

@deffnx {Função} os.sendfile (out_fd, in_fd, offset, count, headers=(), trailers=(), flags=0)

Copia `count' bytes do descritor de arquivo `in_fd' para o descritor de arquivo `out_fd' começando em `offset'. Retorna o número de bytes enviados. Quando o EOF é alcançado, retorna @code{0}.

A primeira notação da função está disponível por todas as plataformas que definem @ref{b21,,sendfile()}.

No Linux, se `offset' for fornecido como @code{None}, os bytes são lidos da posição atual de `in_fd' e a posição de `in_fd' é atualizada.

O segundo caso pode ser usado no macOS e FreeBSD onde `headers' e `trailers' são sequências arbitrárias de buffers que são escritos antes e depois dos dados de `in_fd' ser escrito. Retorna o mesmo que no primeiro caso.

No macOS e FreeBSD, um valor de @code{0} para `count' especifica enviar até o fim de `in_fd' ser alcançado.

Todas as plataformas tem suporte a soquetes como descritor de arquivo `out_fd', e algumas plataformas permitem outros tipos (por exemplo, arquivo regular, encadeamento) também.

Aplicativos de plataforma cruzada não devem usar os argumentos `headers', `trailers' e `flags'.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

@cartouche
@quotation Nota 
Para um invólucro de nível mais alto de @ref{b21,,sendfile()}, consulte @ref{e8c,,socket.socket.sendfile()}.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 3.9: Os parâmetros `out' e `in' foram renomeados para `out_fd' e `in_fd'.

@end deffn

@geindex SF_NODISKIO (no módulo os)
@geindex SF_MNOWAIT (no módulo os)
@geindex SF_SYNC (no módulo os)
@anchor{library/os os SF_NODISKIO}@anchor{2d46}
@deffn {Dado} os.SF_NODISKIO
@anchor{library/os os SF_MNOWAIT}@anchor{2d47}
@deffnx {Dado} os.SF_MNOWAIT
@anchor{library/os os SF_SYNC}@anchor{2d48}
@deffnx {Dado} os.SF_SYNC

Parâmetros para a função @ref{b21,,sendfile()}, se a implementação tiver suporte a eles.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.3.

@end deffn

@geindex SF_NOCACHE (no módulo os)
@anchor{library/os os SF_NOCACHE}@anchor{2d49}
@deffn {Dado} os.SF_NOCACHE

Parâmetro para a função @ref{b21,,sendfile()}, se a implementação tiver suporte a isso. Os dados não serão armazenados em cache na memória virtual e serão liberados posteriormente.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.11.

@end deffn

@geindex set_blocking() (no módulo os)
@anchor{library/os os set_blocking}@anchor{e67}
@deffn {Função} os.set_blocking (fd, blocking, /)

Define o modo de bloqueio do descritor de arquivo especificado. Define o sinalizador @ref{e68,,O_NONBLOCK} se blocking for @code{False}; do contrário, limpa o sinalizador.

Veja também @ref{e66,,get_blocking()} e @ref{2d1d,,socket.socket.setblocking()}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

No Windows, esta função é limitada a encadeamentos.


Adicionado na versão 3.5.



Alterado na versão 3.12: Adicionado suporte a encadeamentos no Windows.

@end deffn

@geindex splice() (no módulo os)
@anchor{library/os os splice}@anchor{81c}
@deffn {Função} os.splice (src, dst, count, offset_src=None, offset_dst=None)

Transfere `count' bytes do descritor de arquivo `src', começando do `offset_src', para o descritor de arquivo `dst', começando do `offset_dst'. Pelo menos um dos descritores de arquivo deve se referir a um encadeamento. Se `offset_src' é @code{None}, então `src' é lido a partir da posição atual; o mesmo para `offset_dst'. O deslocamento associado a um descritor de arquivo que se refere a um encadeamento deve ser @code{None}. Os arquivos apontados por `src' e `dst' devem residir no mesmo sistema de arquivos, de outra forma uma @ref{417,,OSError} é levantada com @ref{15d5,,errno} definido para @ref{2d1b,,errno.EXDEV}.

Essa cópia é feita sem o custo adicional de transferência de dados do kernel para o espaço do usuário e, em seguida, volta para o kernel. Além disso, alguns sistemas de arquivos poderiam implementar otimizações extras. A cópia é feita como se ambos os arquivos estivessem abertos como binários.

Após a conclusão bem-sucedida, retorna o número de bytes unidos ao encadeamento ou a partir dele. Um valor de retorno de 0 significa o fim da entrada. Se `src' se refere a um encadeamento, isso significa que não havia dados para transferir, e não faria sentido bloquear porque não há escritores conectados ao fim da escrita do encadeamento.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.17 with glibc >= 2.5


Adicionado na versão 3.10.

@end deffn

@geindex SPLICE_F_MOVE (no módulo os)
@geindex SPLICE_F_NONBLOCK (no módulo os)
@geindex SPLICE_F_MORE (no módulo os)
@anchor{library/os os SPLICE_F_MOVE}@anchor{2d4a}
@deffn {Dado} os.SPLICE_F_MOVE
@anchor{library/os os SPLICE_F_NONBLOCK}@anchor{2d4b}
@deffnx {Dado} os.SPLICE_F_NONBLOCK
@anchor{library/os os SPLICE_F_MORE}@anchor{2d4c}
@deffnx {Dado} os.SPLICE_F_MORE


Adicionado na versão 3.10.

@end deffn

@geindex readv() (no módulo os)
@anchor{library/os os readv}@anchor{b74}
@deffn {Função} os.readv (fd, buffers, /)

Lê de um descritor de arquivo `fd' em um número de `buffers' @ref{d4f,,objetos bytes ou similares} mutáveis. Transfere os dados para cada buffer até que esteja cheio e, a seguir, vai para o próximo buffer na sequência para armazenar o restante dos dados.

Retorna o número total de bytes realmente lidos, que pode ser menor que a capacidade total de todos os objetos.

O sistema operacional pode definir um limite (@ref{1651,,sysconf()} valor @code{'SC_IOV_MAX'}) no número de buffers que podem ser usados.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex tcgetpgrp() (no módulo os)
@anchor{library/os os tcgetpgrp}@anchor{2d4d}
@deffn {Função} os.tcgetpgrp (fd, /)

Retorna o grupo de processos associado ao terminal fornecido por `fd' (um descritor de arquivo aberto retornado por @ref{dba,,os.open()}).

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex tcsetpgrp() (no módulo os)
@anchor{library/os os tcsetpgrp}@anchor{2d4e}
@deffn {Função} os.tcsetpgrp (fd, pg, /)

Define o grupo de processos associado ao terminal fornecido por `fd' (um descritor de arquivo aberto retornado por @ref{dba,,os.open()}) para `pg'.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex ttyname() (no módulo os)
@anchor{library/os os ttyname}@anchor{2d4f}
@deffn {Função} os.ttyname (fd, /)

Retorna uma string que especifica o dispositivo de terminal associado ao descritor de arquivo `fd'. Se `fd' não estiver associado a um dispositivo de terminal, uma exceção é levantada.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex unlockpt() (no módulo os)
@anchor{library/os os unlockpt}@anchor{177a}
@deffn {Função} os.unlockpt (fd, /)

Destrava o dispositivo pseudoterminal secundário associado ao dispositivo pseudoterminal principal ao qual o descritor de arquivo `fd' se refere. O descritor de arquivo `fd' não é fechado em caso de falha.

Chama a função @code{unlockpt()} da biblioteca padrão C.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Adicionado na versão 3.13.

@end deffn

@geindex write() (no módulo os)
@anchor{library/os os write}@anchor{dc3}
@deffn {Função} os.write (fd, str, /)

Escreve a string de bytes em `str' no descritor de arquivo `fd'.

Retorna o número de bytes realmente escritos.

@cartouche
@quotation Nota 
Esta função destina-se a E/S de baixo nível e deve ser aplicada a um descritor de arquivo retornado por @ref{dba,,os.open()} ou @ref{18ef,,pipe()}. Para escrever um “objeto arquivo” retornado pela função embutida @ref{51c,,open()} ou por @ref{a91,,popen()} ou @ref{20c4,,fdopen()}, ou @ref{ae6,,sys.stdout} ou @ref{940,,sys.stderr}, use seu método @code{write()}.
@end quotation
@end cartouche


Alterado na versão 3.5: Se a chamada de sistema é interrompida e o tratador de sinal não levanta uma exceção, a função agora tenta novamente a chamada de sistema em vez de levantar uma exceção @ref{db0,,InterruptedError} (consulte 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para entender a justificativa).

@end deffn

@geindex writev() (no módulo os)
@anchor{library/os os writev}@anchor{b77}
@deffn {Função} os.writev (fd, buffers, /)

Escreve o conteúdo de `buffers' no descritor de arquivo `fd'. `buffers' deve ser uma sequência de @ref{d4f,,objetos bytes ou similares}. Os buffers são processados na ordem em que estão. Todo o conteúdo do primeiro buffer é gravado antes de prosseguir para o segundo, e assim por diante.

Retorna o número total de bytes realmente escritos.

O sistema operacional pode definir um limite (@ref{1651,,sysconf()} valor @code{'SC_IOV_MAX'}) no número de buffers que podem ser usados.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@menu
* Consultando o tamanho de um terminal:: 
* Herança de descritores de arquivos:: 

@end menu

@node Consultando o tamanho de um terminal,Herança de descritores de arquivos,,Operações dos descritores de arquivos
@anchor{library/os querying-the-size-of-a-terminal}@anchor{2d50}@anchor{library/os terminal-size}@anchor{2d51}
@subsubsection Consultando o tamanho de um terminal



Adicionado na versão 3.3.


@geindex get_terminal_size() (no módulo os)
@anchor{library/os os get_terminal_size}@anchor{1141}
@deffn {Função} os.get_terminal_size (fd=STDOUT_FILENO, /)

Retorna o tamanho da janela do terminal como @code{(columns, lines)}, tupla do tipo @ref{2a34,,terminal_size}.

O argumento opcional @code{fd} (padrão @code{STDOUT_FILENO}, ou saída padrão) especifica qual descritor de arquivo deve ser consultado.

Se o descritor de arquivo não estiver conectado a um terminal, uma exceção @ref{417,,OSError} é levantada.

@ref{1142,,shutil.get_terminal_size()} é a função de alto nível que normalmente deve ser usada, @code{os.get_terminal_size} é a implementação de baixo nível.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex terminal_size (classe em os)
@anchor{library/os os terminal_size}@anchor{2a34}
@deffn {Classe} os.terminal_size

Uma subclasse de tupla, contendo @code{(columns, lines)} do tamanho da janela do terminal.

@geindex columns (atributo os.terminal_size)
@anchor{library/os os terminal_size columns}@anchor{2d52}
@deffn {Atributo} columns

Largura da janela do terminal em caracteres.
@end deffn

@geindex lines (atributo os.terminal_size)
@anchor{library/os os terminal_size lines}@anchor{2d53}
@deffn {Atributo} lines

Altura da janela do terminal em caracteres.
@end deffn
@end deffn

@node Herança de descritores de arquivos,,Consultando o tamanho de um terminal,Operações dos descritores de arquivos
@anchor{library/os fd-inheritance}@anchor{f2b}@anchor{library/os inheritance-of-file-descriptors}@anchor{2d54}
@subsubsection Herança de descritores de arquivos



Adicionado na versão 3.4.


Um descritor de arquivo tem um sinalizador “herdável” que indica se o descritor de arquivo pode ser herdado por processos filho. A partir do Python 3.4, os descritores de arquivo criados pelo Python não são herdáveis por padrão.

On UNIX, non-inheritable file descriptors are closed in child processes at the
execution of a new program, other file descriptors are inherited. Note that
non-inheritable file descriptors are still `inherited' by child processes on @ref{197,,os.fork()}.

No Windows, identificadores não herdáveis e descritores de arquivo são fechados em processos filho, exceto para fluxos padrão (descritores de arquivo 0, 1 e 2: stdin, stdout e stderr), que são sempre herdados. Usando as funções @ref{1826,,spawn*}, todos os identificadores herdáveis e todos os descritores de arquivo herdáveis são herdados. Usando o módulo @ref{d6,,subprocess}, todos os descritores de arquivo, exceto fluxos padrão, são fechados, e os manipuladores herdáveis são herdados apenas se o parâmetro `close_fds' for @code{False}.

Nas plataformas WebAssembly, o descritor de arquivo não pode ser modificado.

@geindex get_inheritable() (no módulo os)
@anchor{library/os os get_inheritable}@anchor{f2c}
@deffn {Função} os.get_inheritable (fd, /)

Obtém o sinalizador “herdável” do descritor de arquivo especificado (um booleano).
@end deffn

@geindex set_inheritable() (no módulo os)
@anchor{library/os os set_inheritable}@anchor{f2d}
@deffn {Função} os.set_inheritable (fd, inheritable, /)

Define o sinalizador “herdável” do descritor de arquivo especificado.
@end deffn

@geindex get_handle_inheritable() (no módulo os)
@anchor{library/os os get_handle_inheritable}@anchor{f2e}
@deffn {Função} os.get_handle_inheritable (handle, /)

Obtém o sinalizador “herdável” do manipulador especificado (um booleano).

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex set_handle_inheritable() (no módulo os)
@anchor{library/os os set_handle_inheritable}@anchor{f2f}
@deffn {Função} os.set_handle_inheritable (handle, inheritable, /)

Define o sinalizador “herdável” do manipulador especificado.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@node Arquivos e diretórios,Gerenciamento de processo,Operações dos descritores de arquivos,os — Diversas interfaces de sistema operacional
@anchor{library/os files-and-directories}@anchor{2d55}@anchor{library/os os-file-dir}@anchor{2ce9}
@subsubsection Arquivos e diretórios


Em algumas plataformas Unix, muitas dessas funções oferecem suporte para um ou mais destes recursos:
@anchor{library/os path-fd}@anchor{b72}

@itemize *

@item 
`especificar um descritor de arquivo:' normalmente o argumento `path' fornecido para funções no módulo @ref{a1,,os} deve ser uma string especificando um caminho de arquivo. No entanto, algumas funções agora aceitam alternativamente um descritor de arquivo aberto para seu argumento `path'. A função então operará no arquivo referido pelo descritor. (Para sistemas POSIX, Python irá chamar a variante da função prefixada com @code{f} (por exemplo, chamar @code{fchdir} em vez de @code{chdir}).

Você pode verificar se `path' pode ser especificado ou não como um descritor de arquivo para uma função particular em sua plataforma usando @ref{113c,,os.supports_fd}. Se esta funcionalidade não estiver disponível, usá-la levantará uma @ref{228,,NotImplementedError}.

Se a função também oferecer suporte para os argumentos `dir_fd' ou `follow_symlinks', é um erro especificar um deles ao fornecer `path' como um descritor de arquivo.
@end itemize
@anchor{library/os dir-fd}@anchor{1129}

@itemize *

@item 
`caminhos relativos aos descritores de diretório:' se `dir_fd' não for @code{None}, deve ser um descritor de arquivo referindo-se a um diretório, e o caminho para operar deve ser relativo; o caminho será relativo a esse diretório. Se o caminho for absoluto, `dir_fd' será ignorado. Para sistemas POSIX, Python irá chamar a variante da função com um sufixo @code{at} e possivelmente prefixado com @code{f} (por exemplo, chamar @code{faccessat} ao invés de @code{access}).

Você pode verificar se há ou não suporte para `dir_fd'  em uma função particular em sua plataforma usando @ref{1136,,os.supports_dir_fd}. Se não estiver disponível, usá-lo levantará uma @ref{228,,NotImplementedError}.
@end itemize
@anchor{library/os follow-symlinks}@anchor{112a}

@itemize *

@item 
`não seguir links simbólicos:' se `follow_symlinks' for @code{False}, e o último elemento do caminho para operar for um link simbólico, a função irá operar no próprio link simbólico ao invés do arquivo apontado pelo link. Para sistemas POSIX, Python irá chamar a variante @code{l...} da função.

Você pode verificar se há ou não suporte para `follow_symlinks' em uma função particular em sua plataforma usando @ref{1137,,os.supports_follow_symlinks}. Se não estiver disponível, usá-lo levantará uma @ref{228,,NotImplementedError}.
@end itemize

@geindex access() (no módulo os)
@anchor{library/os os access}@anchor{112b}
@deffn {Função} os.access (path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

Usa o uid/gid real para testar o acesso ao `path'. Observe que a maioria das operações usará o uid/gid efetivo, portanto, essa rotina pode ser usada em um ambiente suid/sgid para testar se o usuário da chamada tem o acesso especificado ao `path'. `mode' deve ser @ref{2d56,,F_OK} para testar a existência de `path', ou pode ser o OU inclusivo de um ou mais dos @ref{2d57,,R_OK}, @ref{2d58,,W_OK}, e @ref{2d59,,X_OK} para testar as permissões. Retorna @ref{c27,,True} se o acesso for permitido, @ref{b49,,False} se não for. Veja a página man do Unix @code{access(2)@footnote{https://manpages.debian.org/access(2)}} para mais informações.

Esta função pode oferecer suporte a especificação de @ref{1129,,caminhos relativos aos descritores de diretório} e @ref{112a,,não seguir os links simbólicos}.

Se `effective_ids' for @code{True}, @ref{112b,,access()} irá realizar suas verificações de acesso usando o uid/gid efetivo ao invés do uid/gid real. `effective_ids' pode não ser compatível com sua plataforma; você pode verificar se está ou não disponível usando @ref{113d,,os.supports_effective_ids}. Se não estiver disponível, usá-lo levantará uma @ref{228,,NotImplementedError}.

@cartouche
@quotation Nota 
Usar @ref{112b,,access()} para verificar se um usuário está autorizado a, por exemplo, abrir um arquivo antes de realmente fazer isso usando @ref{51c,,open()} cria uma brecha de segurança, porque o usuário pode explorar o curto intervalo de tempo entre a verificação e a abertura do arquivo para manipulá-lo. É preferível usar as técnicas @ref{2d5a,,EAFP}. Por exemplo:

@example
if os.access("meuarquivo", os.R_OK):
    with open("meuarquivo") as fp:
        return fp.read()
return "algum dado padrão"
@end example

é melhor escrito como:

@example
try:
    fp = open("meuarquivo")
except PermissionError:
    return "algum dado padrão"
else:
    with fp:
        return fp.read()
@end example
@end quotation
@end cartouche

@cartouche
@quotation Nota 
As operações de E/S podem falhar mesmo quando @ref{112b,,access()} indica que elas teriam sucesso, particularmente para operações em sistemas de arquivos de rede que podem ter semântica de permissões além do modelo de bits de permissão POSIX usual.
@end quotation
@end cartouche


Alterado na versão 3.3: Adicionados os parâmetros `dir_fd', `effective_ids' e `follow_symlinks'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex F_OK (no módulo os)
@geindex R_OK (no módulo os)
@geindex W_OK (no módulo os)
@geindex X_OK (no módulo os)
@anchor{library/os os F_OK}@anchor{2d56}
@deffn {Dado} os.F_OK
@anchor{library/os os R_OK}@anchor{2d57}
@deffnx {Dado} os.R_OK
@anchor{library/os os W_OK}@anchor{2d58}
@deffnx {Dado} os.W_OK
@anchor{library/os os X_OK}@anchor{2d59}
@deffnx {Dado} os.X_OK

Valores a serem passados como o parâmetro `mode' de @ref{112b,,access()} para testar a existência, legibilidade, capacidade de escrita e executabilidade de `path', respectivamente.
@end deffn

@geindex chdir() (no módulo os)
@anchor{library/os os chdir}@anchor{60d}
@deffn {Função} os.chdir (path)

@geindex diretório;alteração

Altera o diretório de trabalho atual para `path'.

Esta função pode oferecer suporte a @ref{b72,,especificar um descritor de arquivo}. O descritor deve fazer referência a um diretório aberto, não a um arquivo aberto.

Esta função pode levantar @ref{417,,OSError} e subclasses como @ref{42b,,FileNotFoundError}, @ref{d65,,PermissionError} e @ref{1093,,NotADirectoryError}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chdir} com o argumento @code{path}.


Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo em algumas plataformas.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex chflags() (no módulo os)
@anchor{library/os os chflags}@anchor{112c}
@deffn {Função} os.chflags (path, flags, *, follow_symlinks=True)

Define os sinalizadores de `path' para os `flags' numéricos. `flags' podem assumir uma combinação (OU bit a bit) dos seguintes valores (conforme definido no módulo @ref{d1,,stat}):


@itemize *

@item 
@ref{29c2,,stat.UF_NODUMP}

@item 
@ref{29c3,,stat.UF_IMMUTABLE}

@item 
@ref{29c4,,stat.UF_APPEND}

@item 
@ref{29c5,,stat.UF_OPAQUE}

@item 
@ref{29c6,,stat.UF_NOUNLINK}

@item 
@ref{29c7,,stat.UF_COMPRESSED}

@item 
@ref{29ca,,stat.UF_HIDDEN}

@item 
@ref{29ce,,stat.SF_ARCHIVED}

@item 
@ref{29cf,,stat.SF_IMMUTABLE}

@item 
@ref{29d0,,stat.SF_APPEND}

@item 
@ref{29d2,,stat.SF_NOUNLINK}

@item 
@ref{29d3,,stat.SF_SNAPSHOT}
@end itemize

Esta função pode oferecer suporte a @ref{112a,,não seguir links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chflags} com os argumentos @code{path}, @code{flags}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Alterado na versão 3.3: Adicionado o parâmetro `follow_symlinks'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex chmod() (no módulo os)
@anchor{library/os os chmod}@anchor{21b}
@deffn {Função} os.chmod (path, mode, *, dir_fd=None, follow_symlinks=True)

Altera o modo de `path' para o `mode' numérico. `mode' pode assumir um dos seguintes valores (conforme definido no módulo @ref{d1,,stat}) ou combinações de OU bit a bit deles:


@itemize *

@item 
@ref{29ae,,stat.S_ISUID}

@item 
@ref{29af,,stat.S_ISGID}

@item 
@ref{29b1,,stat.S_ENFMT}

@item 
@ref{29b2,,stat.S_ISVTX}

@item 
@ref{29be,,stat.S_IREAD}

@item 
@ref{29bf,,stat.S_IWRITE}

@item 
@ref{29c0,,stat.S_IEXEC}

@item 
@ref{29b3,,stat.S_IRWXU}

@item 
@ref{29b4,,stat.S_IRUSR}

@item 
@ref{29b5,,stat.S_IWUSR}

@item 
@ref{29b6,,stat.S_IXUSR}

@item 
@ref{29b7,,stat.S_IRWXG}

@item 
@ref{29b8,,stat.S_IRGRP}

@item 
@ref{29b9,,stat.S_IWGRP}

@item 
@ref{29b0,,stat.S_IXGRP}

@item 
@ref{29ba,,stat.S_IRWXO}

@item 
@ref{29bb,,stat.S_IROTH}

@item 
@ref{29bc,,stat.S_IWOTH}

@item 
@ref{29bd,,stat.S_IXOTH}
@end itemize

Esta função pode oferecer suporte a @ref{b72,,especificar um descritor de arquivo}, @ref{1129,,caminhos relativos aos descritores de diretório} e @ref{112a,,não seguir os links simbólicos}.

@cartouche
@quotation Nota 
Embora o Windows ofereça suporte ao @ref{21b,,chmod()}, você só pode definir o sinalizador de somente leitura do arquivo (através das constantes @code{stat.S_IWRITE} e @code{stat.S_IREAD} ou um valor inteiro correspondente). Todos os outros bits são ignorados. O valor padrão de `follow_symlinks' é @code{False} no Windows.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{os.chmod} com os argumentos @code{path}, @code{mode}, @code{dir_fd}.


Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto e os argumentos `dir_fd' e `follow_symlinks'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: Adicionado suporte para um descritor de arquivo e o argumento `follow_symlinks' no Windows.

@end deffn

@geindex chown() (no módulo os)
@anchor{library/os os chown}@anchor{112d}
@deffn {Função} os.chown (path, uid, gid, *, dir_fd=None, follow_symlinks=True)

Altera o proprietário e o id de grupo de `path' para `uid' e `gid' numéricos. Para deixar um dos ids inalterado, defina-o como -1.

Esta função pode oferecer suporte a @ref{b72,,especificar um descritor de arquivo}, @ref{1129,,caminhos relativos aos descritores de diretório} e @ref{112a,,não seguir os links simbólicos}.

Consulte @ref{240,,shutil.chown()} para uma função de alto nível que aceita nomes além de ids numéricos.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chown} com os argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.


Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto e os argumentos `dir_fd' e `follow_symlinks'.



Alterado na versão 3.6: Oferece suporte para um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex chroot() (no módulo os)
@anchor{library/os os chroot}@anchor{1b0b}
@deffn {Função} os.chroot (path)

Altera o diretório raiz do processo atual para `path'

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex fchdir() (no módulo os)
@anchor{library/os os fchdir}@anchor{db1}
@deffn {Função} os.fchdir (fd)

Altera o diretório de trabalho atual para o diretório representado pelo descritor de arquivo `fd'. O descritor deve se referir a um diretório aberto, não a um arquivo aberto. No Python 3.3, isso é equivalente a @code{os.chdir(fd)}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chdir} com o argumento @code{path}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex getcwd() (no módulo os)
@anchor{library/os os getcwd}@anchor{1682}
@deffn {Função} os.getcwd ()

Retorna uma string representando o diretório de trabalho atual.
@end deffn

@geindex getcwdb() (no módulo os)
@anchor{library/os os getcwdb}@anchor{a9b}
@deffn {Função} os.getcwdb ()

Retorna uma bytestring representando o diretório de trabalho atual.


Alterado na versão 3.8: A função agora usa a codificação UTF-8 no Windows, em vez da página de código ANSI: consulte a 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para a justificativa. A função não está mais descontinuada no Windows.

@end deffn

@geindex lchflags() (no módulo os)
@anchor{library/os os lchflags}@anchor{2d5b}
@deffn {Função} os.lchflags (path, flags)

Define os sinalizadores de `path' para os `flags' numéricos, como @ref{112c,,chflags()}, mas não segue links simbólicos. No Python 3.3, isso é equivalente a @code{os.chflags(path, flags, follow_symlinks=False)}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chflags} com os argumentos @code{path}, @code{flags}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex lchmod() (no módulo os)
@anchor{library/os os lchmod}@anchor{21a}
@deffn {Função} os.lchmod (path, mode)

Altera o modo de `path' para o `mode' numérico. Se o caminho for um link simbólico, isso afetará o link simbólico em vez do destino. Veja a documentação de @ref{21b,,chmod()} para valores possíveis de `mode'. No Python 3.3, isso é equivalente a @code{os.chmod(path, mode, follow_symlinks=False)}.

@code{lchmod()} não faz parte do POSIX, mas as implementações Unix podem tê-lo se houver suporte para alterar o modo de links simbólicos.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chmod} com os argumentos @code{path}, @code{mode}, @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not Linux, FreeBSD >= 1.3, NetBSD >= 1.3, not OpenBSD


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: Adicionado suporte no Windows.

@end deffn

@geindex lchown() (no módulo os)
@anchor{library/os os lchown}@anchor{2d5c}
@deffn {Função} os.lchown (path, uid, gid)

Altera o proprietário e o id de grupo de `path' para `uid' e `gid' numéricos. Esta função não seguirá links simbólicos. No Python 3.3, isso é equivalente a @code{os.chown(path, uid, gid, follow_symlinks=False)}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.chown} com os argumentos @code{path}, @code{uid}, @code{gid}, @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex link() (no módulo os)
@anchor{library/os os link}@anchor{112e}
@deffn {Função} os.link (src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)

Cria um link físico apontando para `src' chamado `dst'.

Esta função pode permitir a especificação de `src_dir_fd' e/ou `dst_dir_fd' para fornecer @ref{1129,,caminhos relativos a descritores de diretório} e @ref{112a,,não seguir links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.link} com os argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.2: Adicionado suporte ao Windows.



Alterado na versão 3.3: Adicionados os parâmetros `src_dir_fd', `dst_dir_fd' e `follow_symlinks'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `src' e `dst'.

@end deffn

@geindex listdir() (no módulo os)
@anchor{library/os os listdir}@anchor{1139}
@deffn {Função} os.listdir (path='.')

Retorna uma lista contendo os nomes das entradas no diretório fornecido por `path'. A lista está em ordem arbitrária e não inclui as entradas especiais @code{'.'} e @code{'..'} mesmo se estiverem presentes no diretório. Se um arquivo for removido ou adicionado ao diretório durante a chamada desta função, não é especificado se um nome para esse arquivo deve ser incluído.

`path' pode ser um @ref{2a0,,objeto caminho ou similar}. Se `path' for do tipo @code{bytes} (direta ou indiretamente por meio da interface @ref{c6c,,PathLike}), os nomes de arquivo retornados também serão do tipo @code{bytes}; em todas as outras circunstâncias, eles serão do tipo @code{str}.

Esta função também pode ter suporte a @ref{b72,,especificar um descritor de arquivo}; o descritor de arquivo deve fazer referência a um diretório.

Levanta um @ref{19fa,,evento de auditoria} @code{os.listdir} com o argumento @code{path}.

@cartouche
@quotation Nota 
Para codificar nomes de arquivos @code{str} para @code{bytes}, use @ref{c70,,fsencode()}.
@end quotation
@end cartouche


@subsubheading Ver também


A função @ref{a68,,scandir()} retorna entradas de diretório junto com informações de atributo de arquivo, dando melhor desempenho para muitos casos de uso comuns.



Alterado na versão 3.2: O parâmetro `path' tornou-se opcional.



Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex listdrives() (no módulo os)
@anchor{library/os os listdrives}@anchor{49d}
@deffn {Função} os.listdrives ()

Retorna uma lista contendo os nomes das unidades em um sistema Windows.

Um nome de unidade geralmente se parece com @code{'C:\\'}. Nem todo nome de unidade estará associado a um volume e alguns podem estar inacessíveis por vários motivos, incluindo permissões, conectividade de rede ou mídia ausente. Esta função não testa o acesso.

Pode levantar @ref{417,,OSError} se ocorrer um erro ao coletar os nomes das unidades.

Levanta um @ref{19fa,,evento de auditoria} @code{os.listdrives} sem argumentos.

@ref{1ed8,,Disponibilidade}: Windows


Adicionado na versão 3.12.

@end deffn

@geindex listmounts() (no módulo os)
@anchor{library/os os listmounts}@anchor{49f}
@deffn {Função} os.listmounts (volume)

Retorna uma lista contendo os pontos de montagem para um volume em um sistema Windows.

`volume' deve ser representado como um caminho GUID, como aqueles retornados por @ref{49e,,os.listvolumes()}. Os volumes podem ser montados em vários locais ou não. No último caso, a lista estará vazia. Os pontos de montagem que não estão associados a um volume não serão retornados por esta função.

Os pontos de montagem retornados por esta função serão caminhos absolutos e podem ser mais longos que o nome da unidade.

Levanta @ref{417,,OSError} se o volume não for reconhecido ou se ocorrer um erro ao coletar os caminhos.

Levanta um @ref{19fa,,evento de auditoria} @code{os.listmounts} com o argumento @code{volume}.

@ref{1ed8,,Disponibilidade}: Windows


Adicionado na versão 3.12.

@end deffn

@geindex listvolumes() (no módulo os)
@anchor{library/os os listvolumes}@anchor{49e}
@deffn {Função} os.listvolumes ()

Retorna uma lista contendo os volumes no sistema.

Volumes são normalmente representados como um caminho GUID que se parece com @code{\\?\Volume@{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx@}\}. Os arquivos geralmente podem ser acessados por meio de um caminho GUID, permitindo permissões. No entanto, os usuários geralmente não estão familiarizados com eles e, portanto, o uso recomendado desta função é recuperar pontos de montagem usando @ref{49f,,os.listmounts()}.

Pode levantar @ref{417,,OSError} se ocorrer um erro ao coletar os volumes.

Levanta um @ref{19fa,,evento de auditoria} @code{os.listvolumes} sem argumentos.

@ref{1ed8,,Disponibilidade}: Windows


Adicionado na versão 3.12.

@end deffn

@geindex lstat() (no módulo os)
@anchor{library/os os lstat}@anchor{4a1}
@deffn {Função} os.lstat (path, *, dir_fd=None)

Executa o equivalente a uma chamada de sistema @code{lstat()} no caminho fornecido. Semelhante a @ref{4a0,,stat()}, mas não segue links simbólicos. Retorna um objeto @ref{1509,,stat_result}.

Em plataformas que não têm suporte a links simbólicos, este é um apelido para @ref{4a0,,stat()}.

No Python 3.3, isso é equivalente a @code{os.stat(path, dir_fd=dir_fd, follow_symlinks=False)}.

Esta função também pode ter suporte a @ref{1129,,caminhos relativos a descritores de diretório}.


@subsubheading Ver também


A função @ref{4a0,,stat()}.



Alterado na versão 3.2: Adicionado suporte para links simbólicos do Windows 6.0 (Vista).



Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.8: No Windows, agora abre pontos de nova análise que representam outro caminho (substitutos de nome), incluindo links simbólicos e junções de diretório. Outros tipos de pontos de nova análise são resolvidos pelo sistema operacional como para @ref{4a0,,stat()}.

@end deffn

@geindex mkdir() (no módulo os)
@anchor{library/os os mkdir}@anchor{21d}
@deffn {Função} os.mkdir (path, mode=0o777, *, dir_fd=None)

Cria um diretório chamado `path' com o modo numérico `mode'.

Se o diretório já existe, uma exceção @ref{1056,,FileExistsError} é levantada. Se um diretório pai no caminho não existir, uma exceção @ref{42b,,FileNotFoundError} será levantada.
@anchor{library/os mkdir-modebits}@anchor{2d5d}
Em alguns sistemas, `mode' é ignorado. Onde ele é usado, o valor atual do umask é primeiro mascarado. Se bits diferentes dos últimos 9 (ou seja, os últimos 3 dígitos da representação octal do `mode') são definidos, seu significado depende da plataforma. Em algumas plataformas, eles são ignorados e você deve chamar @ref{21b,,chmod()} explicitamente para defini-los.

No Windows, um modo `mode' de @code{0o700} é tratado especificamente para aplicar controle de acesso ao novo diretório de forma que apenas o usuário atual e os administradores tenham acesso. Outros valores de `mode' são ignorados.

Esta função também pode ter suporte a @ref{1129,,caminhos relativos a descritores de diretório}.

Também é possível criar diretórios temporários; veja a função @ref{21f,,tempfile.mkdtemp()} do módulo @ref{e0,,tempfile}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.mkdir} com os argumentos @code{path}, @code{mode}, @code{dir_fd}.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.13: O Windows agora lida com um `mode' de @code{0o700}.

@end deffn

@geindex makedirs() (no módulo os)
@anchor{library/os os makedirs}@anchor{21e}
@deffn {Função} os.makedirs (name, mode=0o777, exist_ok=False)

@geindex diretório;criação
@geindex caminhos UNC;e os.makedirs()

Função de criação recursiva de diretório. Como @ref{21d,,mkdir()}, mas cria todos os diretórios de nível intermediário necessários para conter o diretório folha.

O parâmetro `mode' é passado para @ref{21d,,mkdir()} para criar o diretório folha; veja @ref{2d5d,,a descrição do mkdir()} para como é interpretado. Para definir os bits de permissão de arquivo de qualquer diretório pai recém-criado, você pode definir o umask antes de invocar @ref{21e,,makedirs()}. Os bits de permissão de arquivo dos diretórios pais existentes não são alterados.

Se `exist_ok' for @code{False} (o padrão), uma @ref{1056,,FileExistsError} é levantada se o diretório alvo já existir.

@cartouche
@quotation Nota 
@ref{21e,,makedirs()} ficará confuso se os elementos do caminho a serem criados incluírem @ref{2d5e,,pardir} (por exemplo, “..” em sistemas UNIX).
@end quotation
@end cartouche

Esta função trata os caminhos UNC corretamente.

Levanta um @ref{19fa,,evento de auditoria} @code{os.mkdir} com os argumentos @code{path}, @code{mode}, @code{dir_fd}.


Alterado na versão 3.2: Adicionado o parâmetro `exist_ok'.



Alterado na versão 3.4.1: Antes do Python 3.4.1, se `exist_ok' fosse @code{True} e o diretório existisse, @ref{21e,,makedirs()} ainda levantaria um erro se `mode' não correspondesse ao modo do diretório existente. Como esse comportamento era impossível de implementar com segurança, ele foi removido no Python 3.4.1. Consulte bpo-21082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21082}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: O argumento `mode' não afeta mais os bits de permissão de arquivo de diretórios de nível intermediário recém-criados.

@end deffn

@geindex mkfifo() (no módulo os)
@anchor{library/os os mkfifo}@anchor{db8}
@deffn {Função} os.mkfifo (path, mode=0o666, *, dir_fd=None)

Cria um FIFO (um encadeamento nomeado) chamado `path' com o modo numérico `mode'. O valor atual de umask é primeiro mascarado do modo.

Esta função também pode ter suporte a @ref{1129,,caminhos relativos a descritores de diretório}.

FIFOs são canais que podem ser acessados como arquivos regulares. FIFOs existem até que sejam excluídos (por exemplo, com @ref{1134,,os.unlink()}). Geralmente, os FIFOs são usados como ponto de encontro entre os processos do tipo “cliente” e “servidor”: o servidor abre o FIFO para leitura e o cliente para escrita. Observe que @ref{db8,,mkfifo()} não abre o FIFO – apenas cria o ponto de encontro.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex mknod() (no módulo os)
@anchor{library/os os mknod}@anchor{db9}
@deffn {Função} os.mknod (path, mode=0o600, device=0, *, dir_fd=None)

Cria um nó de sistema de arquivos (arquivo, arquivo especial de dispositivo ou canal nomeado) chamado `path'. `mode' especifica as permissões de uso e o tipo de nó a ser criado, sendo combinado (OU bit a bit) com um de @code{stat.S_IFREG}, @code{stat.S_IFCHR}, @code{stat.S_IFBLK} , e @code{stat.S_IFIFO} (essas constantes estão disponíveis em @ref{d1,,stat}). Para @code{stat.S_IFCHR} e @code{stat.S_IFBLK}, `device' define o arquivo especial do dispositivo recém-criado (provavelmente usando @ref{1706,,os.makedev()}), caso contrário, ele será ignorado.

Esta função também pode ter suporte a @ref{1129,,caminhos relativos a descritores de diretório}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex major() (no módulo os)
@anchor{library/os os major}@anchor{1704}
@deffn {Função} os.major (device, /)

Extrai o número principal de dispositivo de um número bruto de dispositivo (normalmente o campo @code{st_dev} ou @code{st_rdev} de @code{stat}).
@end deffn

@geindex minor() (no módulo os)
@anchor{library/os os minor}@anchor{1705}
@deffn {Função} os.minor (device, /)

Extrai o número menor de dispositivo de um número bruto de dispositivo (normalmente o campo @code{st_dev} ou @code{st_rdev} de @code{stat}).
@end deffn

@geindex makedev() (no módulo os)
@anchor{library/os os makedev}@anchor{1706}
@deffn {Função} os.makedev (major, minor, /)

Compõe um número de dispositivo bruto a partir dos números de dispositivo principais e secundários.
@end deffn

@geindex pathconf() (no módulo os)
@anchor{library/os os pathconf}@anchor{113a}
@deffn {Função} os.pathconf (path, name)

Retorna informações de configuração do sistema relevantes para um arquivo nomeado. `name' especifica o valor de configuração a ser recuperado; pode ser uma string que é o nome de um valor de sistema definido; esses nomes são especificados em vários padrões (POSIX.1, Unix 95, Unix 98 e outros). Algumas plataformas também definem nomes adicionais. Os nomes conhecidos do sistema operacional do host são fornecidos no dicionário @code{pathconf_names}. Para variáveis de configuração não incluídas nesse mapeamento, passar um número inteiro para `name' também é aceito.

Se `name' for uma string e não for conhecida, uma exceção @ref{202,,ValueError} é levantada. Se um valor específico para `name' não for compatível com o sistema hospedeiro, mesmo que seja incluído no @code{pathconf_names}, uma exceção @ref{417,,OSError} é levantada com @ref{1b66,,errno.EINVAL} como número do erro.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo}.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex pathconf_names (no módulo os)
@anchor{library/os os pathconf_names}@anchor{2d5f}
@deffn {Dado} os.pathconf_names

Nomes de mapeamento de dicionário aceitos por @ref{113a,,pathconf()} e @ref{2d1c,,fpathconf()} para os valores inteiros definidos para esses nomes pelo sistema operacional do host. Isso pode ser usado para determinar o conjunto de nomes conhecidos pelo sistema.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex readlink() (no módulo os)
@anchor{library/os os readlink}@anchor{926}
@deffn {Função} os.readlink (path, *, dir_fd=None)

Retorna uma string representando o caminho para o qual o link simbólico aponta. O resultado pode ser um nome de caminho absoluto ou relativo; se for relativo, pode ser convertido para um caminho absoluto usando @code{os.path.join(os.path.dirname(path), result)}.

Se o `path' for um objeto string (direta ou indiretamente por meio de uma interface @ref{c6c,,PathLike}), o resultado também será um objeto string e a chamada pode levantar um UnicodeDecodeError. Se o `path' for um objeto de bytes (direto ou indireto), o resultado será um objeto de bytes.

Esta função também pode ter suporte a @ref{1129,,caminhos relativos a descritores de diretório}.

Ao tentar resolver um caminho que pode conter links, use @ref{225,,realpath()} para lidar corretamente com a recursão e as diferenças de plataforma.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.2: Adicionado suporte para links simbólicos do Windows 6.0 (Vista).



Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} no Unix.



Alterado na versão 3.8: Aceita um @ref{2a0,,objeto caminho ou similar} e um objeto bytes no Windows.

Adicionado suporte para junções de diretório e alterado para retornar o caminho de substituição (que normalmente inclui o prefixo @code{\\?\}) ao invés do campo opcional “print name” que era retornado anteriormente.

@end deffn

@geindex remove() (no módulo os)
@anchor{library/os os remove}@anchor{112f}
@deffn {Função} os.remove (path, *, dir_fd=None)

Remove (exclui) o arquivo `path'. Se `path' for um diretório, uma @ref{417,,OSError} é levantada. Use @ref{1132,,rmdir()} para remover diretórios. Se o arquivo não existir, uma @ref{42b,,FileNotFoundError} é levantada.

Esta função tem suporte a @ref{1129,,caminhos relativos para descritores de diretório}.

No Windows, a tentativa de remover um arquivo que está em uso causa o surgimento de uma exceção; no Unix, a entrada do diretório é removida, mas o armazenamento alocado para o arquivo não é disponibilizado até que o arquivo original não esteja mais em uso.

Esta função é semanticamente idêntica a @ref{1134,,unlink()}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.remove} com os argumentos @code{path}, @code{dir_fd}.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex removedirs() (no módulo os)
@anchor{library/os os removedirs}@anchor{2d60}
@deffn {Função} os.removedirs (name)

@geindex diretório;exclusão

Remove os diretórios recursivamente. Funciona como @ref{1132,,rmdir()}, exceto que, se o diretório folha for removido com sucesso, @ref{2d60,,removedirs()} tenta remover sucessivamente todos os diretórios pai mencionados em `path' até que um erro seja levantado (que é ignorado, porque geralmente significa que um diretório pai não está vazio). Por exemplo, @code{os.removedirs('foo/bar/baz')} primeiro removerá o diretório @code{'foo/bar/baz'}, e então removerá @code{'foo/bar'} e @code{'foo'} se estiverem vazios. Levanta @ref{417,,OSError} se o diretório folha não pôde ser removido com sucesso.

Levanta um @ref{19fa,,evento de auditoria} @code{os.remove} com os argumentos @code{path}, @code{dir_fd}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex rename() (no módulo os)
@anchor{library/os os rename}@anchor{1130}
@deffn {Função} os.rename (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

Renomeia o arquivo ou diretório `src' para `dst'. Se `dst' existir, a operação falhará com uma subclasse de @ref{417,,OSError} em vários casos:

No Windows, se `dst' existe então uma exceção @ref{1056,,FileExistsError} será levantada. A operação pode falar se `src' e `dst' são de sistemas de arquivos diferentes. Use @ref{e82,,shutil.move()} para mover arquivos entre sistemas de arquivos diferentes.

No Unix, se `src' é um arquivo e `dst' é um diretório ou vice-versa, uma @ref{1092,,IsADirectoryError} ou uma @ref{1093,,NotADirectoryError} será levantada respectivamente. Se ambos forem diretórios e `dst' estiver vazio, `dst' será substituído silenciosamente. Se `dst' for um diretório não vazio, uma @ref{417,,OSError} é levantada. Se ambos forem arquivos, `dst' será substituído silenciosamente se o usuário tiver permissão. A operação pode falhar em alguns tipos de Unix se `src' e `dst' estiverem em sistemas de arquivos diferentes. Se for bem-sucedido, a renomeação será uma operação atômica (este é um requisito POSIX).

Esta função permite especificar `src_dir_fd' e/ou `dst_dir_fd' para fornecer @ref{1129,,caminhos relativos a descritores de diretório}.

Se você quiser sobrescrita multiplataforma do destino, use @ref{1131,,replace()}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.rename} com os argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Alterado na versão 3.3: Adicionados os parâmetros `src_dir_fd' e `dst_dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `src' e `dst'.

@end deffn

@geindex renames() (no módulo os)
@anchor{library/os os renames}@anchor{2d61}
@deffn {Função} os.renames (old, new)

Função de renomeação de arquivo ou diretório recursiva. Funciona como @ref{1130,,rename()}, exceto que a criação de qualquer diretório intermediário necessário para tornar o novo nome de caminho possível é tentada primeiro. Após a renomeação, os diretórios correspondentes aos segmentos de caminho mais à direita do nome antigo serão removidos usando @ref{2d60,,removedirs()}.

@cartouche
@quotation Nota 
Esta função pode falhar com a nova estrutura de diretório criada se você não tiver as permissões necessárias para remover o arquivo ou diretório folha.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{os.rename} com os argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `old' e `new'.

@end deffn

@geindex replace() (no módulo os)
@anchor{library/os os replace}@anchor{1131}
@deffn {Função} os.replace (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

Renomeia o arquivo ou diretório `src' para `dst'. Se `dst' for um diretório não vazio, @ref{417,,OSError} será levantada. Se `dst' existir e for um arquivo, ele será substituído silenciosamente se o usuário tiver permissão. A operação pode falhar se `src' e `dst' estiverem em sistemas de arquivos diferentes. Se for bem-sucedido, a renomeação será uma operação atômica (este é um requisito POSIX).

Esta função permite especificar `src_dir_fd' e/ou `dst_dir_fd' para fornecer @ref{1129,,caminhos relativos a descritores de diretório}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.rename} com os argumentos @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}.


Adicionado na versão 3.3.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `src' e `dst'.

@end deffn

@geindex rmdir() (no módulo os)
@anchor{library/os os rmdir}@anchor{1132}
@deffn {Função} os.rmdir (path, *, dir_fd=None)

Remove (exclui) o diretório `path'. Se o diretório não existe ou não está vazio, uma @ref{42b,,FileNotFoundError} ou uma @ref{417,,OSError} é levantada respectivamente. Para remover árvores de diretório inteiras, pode ser usada @ref{301,,shutil.rmtree()}.

Esta função tem suporte a @ref{1129,,caminhos relativos para descritores de diretório}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.rmdir} com os argumentos @code{path}, @code{dir_fd}.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex scandir() (no módulo os)
@anchor{library/os os scandir}@anchor{a68}
@deffn {Função} os.scandir (path='.')

Retorna um iterador de objetos @ref{49b,,os.DirEntry} correspondentes às entradas no diretório fornecido por `path'. As entradas são produzidas em ordem arbitrária, e as entradas especiais @code{'.'} e @code{'..'} não são incluídas. Se um arquivo for removido ou adicionado ao diretório após a criação do iterador, não é especificado se uma entrada para esse arquivo deve ser incluída.

Usar @ref{a68,,scandir()} em vez de @ref{1139,,listdir()} pode aumentar significativamente o desempenho do código que também precisa de tipo de arquivo ou informações de atributo de arquivo, porque os objetos @ref{49b,,os.DirEntry} expõem essas informações se o sistema operacional fornecer ao percorrer um diretório. Todos os métodos de @ref{49b,,os.DirEntry} podem realizar uma chamada de sistema, mas @ref{2d62,,is_dir()} e @ref{dac,,is_file()} normalmente requerem apenas uma chamada de sistema para links simbólicos; @ref{17ed,,os.DirEntry.stat()} sempre requer uma chamada de sistema no Unix, mas requer uma apenas para links simbólicos no Windows.

`path' pode ser um @ref{2a0,,objeto caminho ou similar}. Se `path' for do tipo @code{bytes} (direta ou indiretamente por meio da interface @ref{c6c,,PathLike}), o tipo dos atributos @ref{2d63,,name} e @ref{1772,,path} de cada @ref{49b,,os.DirEntry} serão @code{bytes}; em todas as outras circunstâncias, eles serão do tipo @code{str}.

Esta função também pode ter suporte a @ref{b72,,especificar um descritor de arquivo}; o descritor de arquivo deve fazer referência a um diretório.

Levanta um @ref{19fa,,evento de auditoria} @code{os.scandir} com o argumento @code{path}.

O iterador @ref{a68,,scandir()} implementa o protocolo @ref{5d4,,gerenciador de contexto} e tem o seguinte método:

@geindex close() (método os.scandir)
@anchor{library/os os scandir close}@anchor{cdc}
@deffn {Método} scandir.close ()

Fecha o iterador e libera os recursos alocados.

Isso é chamado automaticamente quando o iterador se esgota ou é coletado como lixo, ou quando ocorre um erro durante a iteração. No entanto, é aconselhável chamá-lo explicitamente ou usar a instrução @ref{5d2,,with}.


Adicionado na versão 3.6.

@end deffn

O exemplo a seguir mostra um uso simples de @ref{a68,,scandir()} para exibir todos os arquivos (excluindo diretórios) no `path' fornecido que não começa com @code{'.'}. A chamada @code{entrada.is_file()} geralmente não fará uma chamada de sistema adicional:

@example
with os.scandir(caminho) as coisa:
    for entrada in coisa:
        if not entrada.name.startswith('.') and entrada.is_file():
            print(entrada.name)
@end example

@cartouche
@quotation Nota 
Em sistemas baseados no Unix, @ref{a68,,scandir()} usa o sistema opendir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/opendir.html} e as funções readdir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/readdir_r.html}. No Windows, ela usa os funções FindFirstFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364418(v=vs.85).aspx} e FindNextFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364428(v=vs.85).aspx} do Win32.
@end quotation
@end cartouche


Adicionado na versão 3.5.



Alterado na versão 3.6: Adicionado suporte para o protocolo de @ref{5d4,,gerenciador de contexto} e o método @ref{cdc,,close()}. Se um iterador @ref{a68,,scandir()} não estiver esgotado nem explicitamente fechado, uma @ref{244,,ResourceWarning} será emitida em seu destrutor.

A função aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: Adicionado suporte para @ref{b72,,descritores de arquivo} no Unix.

@end deffn

@geindex DirEntry (classe em os)
@anchor{library/os os DirEntry}@anchor{49b}
@deffn {Classe} os.DirEntry

Objeto produzido por @ref{a68,,scandir()} para expor o caminho do arquivo e outros atributos de arquivo de uma entrada de diretório.

@ref{a68,,scandir()} fornecerá o máximo possível dessas informações sem fazer chamadas de sistema adicionais. Quando uma chamada de sistema @code{stat()} ou @code{lstat()} é feita, o objeto @code{os.DirEntry} irá armazenar o resultado em cache.

As instâncias de @code{os.DirEntry} não devem ser armazenadas em estruturas de dados de longa duração; se você sabe que os metadados do arquivo foram alterados ou se passou muito tempo desde a chamada de @ref{a68,,scandir()}, chame @code{os.stat(entry.path)} para obter informações atualizadas.

Como os métodos @code{os.DirEntry} podem fazer chamadas ao sistema operacional, eles também podem levantar @ref{417,,OSError}. Se você precisa de um controle muito refinado sobre os erros, você pode pegar @ref{417,,OSError} ao chamar um dos métodos @code{os.DirEntry} e manipular conforme apropriado.

Para ser diretamente utilizável como um @ref{2a0,,objeto caminho ou similar}, @code{os.DirEntry} implementa a interface @ref{c6c,,PathLike}.

Atributos e métodos em uma instância de @code{os.DirEntry} são os seguintes:

@geindex name (atributo os.DirEntry)
@anchor{library/os os DirEntry name}@anchor{2d63}
@deffn {Atributo} name

O nome do arquivo base da entrada, relativo ao argumento `path' de @ref{a68,,scandir()}.

O atributo @ref{2ce3,,name} será @code{bytes} se o argumento `path' de @ref{a68,,scandir()} for do tipo @code{bytes} e, caso contrário, @code{str}. Usa @ref{c6f,,fsdecode()} para decodificar nomes de arquivos de bytes.
@end deffn

@geindex path (atributo os.DirEntry)
@anchor{library/os os DirEntry path}@anchor{1772}
@deffn {Atributo} path

O nome do caminho completo da entrada: equivalente a @code{os.path.join(scandir_path, entry.name)} onde `scandir_path' é o argumento `path' de @ref{a68,,scandir()}. O caminho só é absoluto se o argumento `path' de @ref{a68,,scandir()} for absoluto. Se o argumento `path' de @ref{a68,,scandir()} era um @ref{b72,,descritor de arquivo}, o atributo @ref{a2,,path} é o mesmo que o atributo @ref{2ce3,,name}.

O atributo @ref{a2,,path} será @code{bytes} se o argumento `path' de @ref{a68,,scandir()} for do tipo @code{bytes} e, caso contrário, @code{str}. Usa @ref{c6f,,fsdecode()} para decodificar nomes de arquivos de bytes.
@end deffn

@geindex inode() (método os.DirEntry)
@anchor{library/os os DirEntry inode}@anchor{17cc}
@deffn {Método} inode ()

Retorna o número de nó-i da entrada.

O resultado é armazenado em cache no objeto @code{os.DirEntry}. Use @code{os.stat(entry.path, follow_symlinks=False).st_ino} para obter informações atualizadas.

Na primeira chamada sem cache, uma chamada de sistema é necessária no Windows, mas não no Unix.
@end deffn

@geindex is_dir() (método os.DirEntry)
@anchor{library/os os DirEntry is_dir}@anchor{2d62}
@deffn {Método} is_dir (*, follow_symlinks=True)

Retorna @code{True} se esta entrada for um diretório ou um link simbólico apontando para um diretório; retorna @code{False} se a entrada é ou aponta para qualquer outro tipo de arquivo, ou se ele não existe mais.

Se `follow_symlinks' for @code{False}, retorna @code{True} apenas se esta entrada for um diretório (sem seguir os links simbólicos); retorna @code{False} se a entrada for qualquer outro tipo de arquivo ou se ele não existe mais.

O resultado é armazenado em cache no objeto @code{os.DirEntry}, com um cache separado para `follow_symlinks' @code{True} e @code{False}. Chama @ref{4a0,,os.stat()} junto com @ref{2995,,stat.S_ISDIR()} para buscar informações atualizadas.

Na primeira chamada sem cache, nenhuma chamada do sistema é necessária na maioria dos casos. Especificamente, para links não simbólicos, nem o Windows nem o Unix requerem uma chamada de sistema, exceto em certos sistemas de arquivos Unix, como sistemas de arquivos de rede, que retornam @code{dirent.d_type == DT_UNKNOWN}. Se a entrada for um link simbólico, uma chamada de sistema será necessária para seguir o link simbólico, a menos que `follow_symlinks' seja @code{False}.

Este método pode levantar @ref{417,,OSError}, tal como @ref{d65,,PermissionError}, mas @ref{42b,,FileNotFoundError} é capturada e não levantada.
@end deffn

@geindex is_file() (método os.DirEntry)
@anchor{library/os os DirEntry is_file}@anchor{dac}
@deffn {Método} is_file (*, follow_symlinks=True)

Retorna @code{True} se esta entrada for um arquivo ou um link simbólico apontando para um arquivo; retorna @code{False} se a entrada é ou aponta para um diretório ou outra entrada que não seja de arquivo, ou se ela não existe mais.

Se `follow_symlinks' for @code{False}, retorna @code{True} apenas se esta entrada for um arquivo (sem seguir os links simbólicos); retorna @code{False} se a entrada for um diretório ou outra entrada que não seja um arquivo, ou se ela não existir mais.

O resultado é armazenado em cache no objeto @code{os.DirEntry}. Chamadas de sistema em cache feitas e exceções levantadas são conforme @ref{2d62,,is_dir()}.
@end deffn

@geindex is_symlink() (método os.DirEntry)
@anchor{library/os os DirEntry is_symlink}@anchor{2d64}
@deffn {Método} is_symlink ()

Retorna @code{True} se esta entrada for um link simbólico (mesmo se quebrado); retorna @code{False} se a entrada apontar para um diretório ou qualquer tipo de arquivo, ou se ele não existir mais.

O resultado é armazenado em cache no objeto @code{os.DirEntry}. Chama @ref{a16,,os.path.islink()} para buscar informações atualizadas.

Na primeira chamada sem cache, nenhuma chamada do sistema é necessária na maioria dos casos. Especificamente, nem o Windows nem o Unix exigem uma chamada de sistema, exceto em certos sistemas de arquivos Unix, como sistemas de arquivos de rede, que retornam @code{dirent.d_type == DT_UNKNOWN}.

Este método pode levantar @ref{417,,OSError}, tal como @ref{d65,,PermissionError}, mas @ref{42b,,FileNotFoundError} é capturada e não levantada.
@end deffn

@geindex is_junction() (método os.DirEntry)
@anchor{library/os os DirEntry is_junction}@anchor{49c}
@deffn {Método} is_junction ()

Retorna @code{True} se esta entrada for uma junção (mesmo se quebrado); retorna @code{False} se a entrada apontar para um diretório regular, ou qualquer tipo de arquivo, um link simbólico ou se ele não existir mais.

O resultado é armazenado em cache no objeto @code{os.DirEntry}. Chama @ref{4a3,,os.path.isjunction()} para buscar informações atualizadas.


Adicionado na versão 3.12.

@end deffn

@geindex stat() (método os.DirEntry)
@anchor{library/os os DirEntry stat}@anchor{17ed}
@deffn {Método} stat (*, follow_symlinks=True)

Retorna um objeto @ref{1509,,stat_result} para esta entrada. Este método segue links simbólicos por padrão; para estabelecer um link simbólico, adicione o argumento @code{follow_symlinks=False}.

No Unix, esse método sempre requer uma chamada de sistema. No Windows, ele só requer uma chamada de sistema se `follow_symlinks' for @code{True} e a entrada for um ponto de nova análise (por exemplo, um link simbólico ou junção de diretório).

No Windows, os atributos @code{st_ino}, @code{st_dev} e @code{st_nlink} da @ref{1509,,stat_result} são sempre definidos como zero. Chame @ref{4a0,,os.stat()} para obter esses atributos.

O resultado é armazenado em cache no objeto @code{os.DirEntry}, com um cache separado para `follow_symlinks' @code{True} e @code{False}. Chame @ref{4a0,,os.stat()} para buscar informações atualizadas.
@end deffn

Note que há uma boa correspondência entre vários atributos e métodos de @code{os.DirEntry} e de @ref{229,,pathlib.Path}. Em particular, o atributo @code{name} tem o mesmo significado, assim como os métodos @code{is_dir()}, @code{is_file()}, @code{is_symlink()}, @code{is_junction()} e @code{stat()}.


Adicionado na versão 3.5.



Alterado na versão 3.6: Adicionado suporte para a interface @ref{c6c,,PathLike}. Adicionado suporte para caminhos @ref{1c2,,bytes} no Windows.



Alterado na versão 3.12: O atributo @code{st_ctime} do resultado de stat foi descontinuado no Windows. A hora de criação do arquivo está devidamente disponível como @code{st_birthtime}, e no futuro @code{st_ctime} pode ser alterada para retornar zero ou a hora de alteração dos metadados, se disponível.

@end deffn

@geindex stat() (no módulo os)
@anchor{library/os os stat}@anchor{4a0}
@deffn {Função} os.stat (path, *, dir_fd=None, follow_symlinks=True)

Obtém o status de um arquivo ou um descritor de arquivo. Executa o equivalente a uma chamada de sistema @code{stat()} no caminho fornecido. `path' pode ser especificado como uma string ou bytes – direta ou indiretamente através da interface @ref{c6c,,PathLike} – ou como um descritor de arquivo aberto. Retorna um objeto @ref{1509,,stat_result}.

Esta função normalmente segue links simbólicos; para obter o status do link simbólico, adicione o argumento @code{follow_symlinks=False}, ou use @ref{4a1,,lstat()}.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo} e @ref{112a,,não seguir links simbólicos}.

No Windows, ao definir @code{follow_symlinks=False}  é desativado o recurso de seguir todos os pontos de nova análise, que incluem links simbólicos e junções de diretório. Outros tipos de pontos de nova análise que não se parecem com links ou que o sistema operacional não pode seguir serão abertos diretamente. Ao seguir uma cadeia de vários links, isso pode resultar no retorno do link original em vez do não-link que impediu o percurso completo. Para obter resultados de `stat' para o caminho final neste caso, use a função @ref{225,,os.path.realpath()} para resolver o nome do caminho tanto quanto possível e chame @ref{4a1,,lstat()} no resultado. Isso não se aplica a links simbólicos pendentes ou pontos de junção, que levantam as exceções usuais.

@geindex módulo;stat

Exemplo:

@example
>>> import os
>>> statinfo = os.stat('algumarquivo.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 também


As funções @ref{db4,,fstat()} e @ref{4a1,,lstat()}.



Alterado na versão 3.3: Adicionados os parâmetros `dir_fd' e `follow_symlinks', especificando um descritor de arquivo em vez de um caminho.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.8: No Windows, todos os pontos de nova análise que podem ser resolvidos pelo sistema operacional agora são seguidos, e passar @code{follow_symlinks=False} desativa seguir todos os pontos de nova análise substitutos de nome. Se o sistema operacional atingir um ponto de nova análise que não é capaz de seguir, `stat' agora retorna as informações do caminho original como se @code{follow_symlinks=False} tivesse sido especificado em vez de levantar um erro.

@end deffn

@geindex stat_result (classe em os)
@anchor{library/os os stat_result}@anchor{1509}
@deffn {Classe} os.stat_result

Objeto cujos atributos correspondem aproximadamente aos membros da estrutura @code{stat}. É usado para o resultado de @ref{4a0,,os.stat()}, @ref{db4,,os.fstat()} e @ref{4a1,,os.lstat()}.

Atributos:

@geindex st_mode (atributo os.stat_result)
@anchor{library/os os stat_result st_mode}@anchor{a14}
@deffn {Atributo} st_mode

Modo de arquivo: tipo de arquivo e bits de modo de arquivo (permissões).
@end deffn

@geindex st_ino (atributo os.stat_result)
@anchor{library/os os stat_result st_ino}@anchor{2d65}
@deffn {Atributo} st_ino

Dependente da plataforma, mas se diferente de zero, identifica exclusivamente o arquivo para um determinado valor de @code{st_dev}. Tipicamente:


@itemize *

@item 
o número do nó-i no Unix,

@item 
o índice de arquivo@footnote{https://msdn.microsoft.com/en-us/library/aa363788} no Windows
@end itemize
@end deffn

@geindex st_dev (atributo os.stat_result)
@anchor{library/os os stat_result st_dev}@anchor{2d66}
@deffn {Atributo} st_dev

Identificador do dispositivo no qual este arquivo reside.
@end deffn

@geindex st_nlink (atributo os.stat_result)
@anchor{library/os os stat_result st_nlink}@anchor{2d67}
@deffn {Atributo} st_nlink

Número de links físicos.
@end deffn

@geindex st_uid (atributo os.stat_result)
@anchor{library/os os stat_result st_uid}@anchor{2d68}
@deffn {Atributo} st_uid

Identificador de usuário do proprietário do arquivo.
@end deffn

@geindex st_gid (atributo os.stat_result)
@anchor{library/os os stat_result st_gid}@anchor{2d69}
@deffn {Atributo} st_gid

Identificador de grupo do proprietário do arquivo.
@end deffn

@geindex st_size (atributo os.stat_result)
@anchor{library/os os stat_result st_size}@anchor{2d6a}
@deffn {Atributo} st_size

Tamanho do arquivo em bytes, se for um arquivo normal ou um link simbólico. O tamanho de um link simbólico é o comprimento do nome do caminho que ele contém, sem um byte nulo final.
@end deffn

Registros de data e hora:

@geindex st_atime (atributo os.stat_result)
@anchor{library/os os stat_result st_atime}@anchor{2d6b}
@deffn {Atributo} st_atime

Hora do acesso mais recente expressa em segundos.
@end deffn

@geindex st_mtime (atributo os.stat_result)
@anchor{library/os os stat_result st_mtime}@anchor{2bf7}
@deffn {Atributo} st_mtime

Hora da modificação de conteúdo mais recente expressa em segundos.
@end deffn

@geindex st_ctime (atributo os.stat_result)
@anchor{library/os os stat_result st_ctime}@anchor{2d6c}
@deffn {Atributo} st_ctime

Hora da alteração de metadados mais recente expressa em segundos.


Alterado na versão 3.12: @code{st_ctime} foi descontinuado no Windows. Use @code{st_birthtime} para o tempo de criação do arquivo. No futuro, @code{st_ctime} conterá a hora da alteração de metadados mais recente, como em outras plataformas.

@end deffn

@geindex st_atime_ns (atributo os.stat_result)
@anchor{library/os os stat_result st_atime_ns}@anchor{2d6d}
@deffn {Atributo} st_atime_ns

Hora do acesso mais recente expresso em nanossegundos como um número inteiro.


Adicionado na versão 3.3.

@end deffn

@geindex st_mtime_ns (atributo os.stat_result)
@anchor{library/os os stat_result st_mtime_ns}@anchor{2d6e}
@deffn {Atributo} st_mtime_ns

Hora da modificação de conteúdo mais recente expressa em nanossegundos como um número inteiro.


Adicionado na versão 3.3.

@end deffn

@geindex st_ctime_ns (atributo os.stat_result)
@anchor{library/os os stat_result st_ctime_ns}@anchor{2d6f}
@deffn {Atributo} st_ctime_ns

Hora do alteração de metadados mais recente expresso em nanossegundos como um número inteiro.


Adicionado na versão 3.3.



Alterado na versão 3.12: @code{st_ctime_ns} foi descontinuado no Windows. Use @code{st_birthtime_ns} para o tempo de criação do arquivo. No futuro, @code{st_ctime} conterá a hora da alteração de metadados mais recente, como em outras plataformas.

@end deffn

@geindex st_birthtime (atributo os.stat_result)
@anchor{library/os os stat_result st_birthtime}@anchor{2d70}
@deffn {Atributo} st_birthtime

Hora de criação do arquivo expressa em segundos. Este atributo nem sempre está disponível e pode levantar @ref{34b,,AttributeError}.


Alterado na versão 3.12: @code{st_birthtime} está agora disponível no Windows.

@end deffn

@geindex st_birthtime_ns (atributo os.stat_result)
@anchor{library/os os stat_result st_birthtime_ns}@anchor{2d71}
@deffn {Atributo} st_birthtime_ns

Hora de criação do arquivo expressa em nanossegundos em um inteiro. Este atributo nem sempre está disponível e pode levantar @ref{34b,,AttributeError}.


Adicionado na versão 3.12.

@end deffn

@cartouche
@quotation Nota 
O significado e resolução exatos dos atributos @ref{2d6b,,st_atime}, @ref{2bf7,,st_mtime}, @ref{2d6c,,st_ctime} e @ref{2d70,,st_birthtime} dependem do sistema operacional e do sistema de arquivos. Por exemplo, em sistemas Windows que usam os sistemas de arquivos FAT32, @ref{2bf7,,st_mtime} tem resolução de 2 segundos, e @ref{2d6b,,st_atime} tem resolução de apenas 1 dia. Consulte a documentação do sistema operacional para obter detalhes.

Da mesma forma, embora @ref{2d6d,,st_atime_ns}, @ref{2d6e,,st_mtime_ns}, @ref{2d6f,,st_ctime_ns} e @ref{2d71,,st_birthtime_ns} sejam sempre expressos em nanossegundos, muitos sistemas não fornecem precisão de nanossegundos. Em sistemas que fornecem precisão de nanossegundos, o objeto de ponto flutuante usado para armazenar @ref{2d6b,,st_atime}, @ref{2bf7,,st_mtime}, @ref{2d6c,,st_ctime} e @ref{2d70,,st_birthtime} não pode preservar tudo, e como tal será ligeiramente inexato. Se você precisa dos carimbos de data/hora exatos, sempre deve usar @ref{2d6d,,st_atime_ns}, @ref{2d6e,,st_mtime_ns}, @ref{2d6f,,st_ctime_ns} e @ref{2d71,,st_birthtime_ns}.
@end quotation
@end cartouche

Em alguns sistemas Unix (como Linux), os seguintes atributos também podem estar disponíveis:

@geindex st_blocks (atributo os.stat_result)
@anchor{library/os os stat_result st_blocks}@anchor{2d72}
@deffn {Atributo} st_blocks

Número de blocos de 512 bytes alocados para o arquivo. Isso pode ser menor que @ref{2d6a,,st_size}/512 quando o arquivo possuir lacunas.
@end deffn

@geindex st_blksize (atributo os.stat_result)
@anchor{library/os os stat_result st_blksize}@anchor{2d73}
@deffn {Atributo} st_blksize

Tamanho de bloco “preferido” para E/S eficiente do sistema de arquivos. Gravar em um arquivo em partes menores pode causar uma leitura-modificação-reescrita ineficiente.
@end deffn

@geindex st_rdev (atributo os.stat_result)
@anchor{library/os os stat_result st_rdev}@anchor{15f4}
@deffn {Atributo} st_rdev

Tipo de dispositivo, se for um dispositivo nó-i.
@end deffn

@geindex st_flags (atributo os.stat_result)
@anchor{library/os os stat_result st_flags}@anchor{2d74}
@deffn {Atributo} st_flags

Sinalizadores definidos pelo usuário para o arquivo.
@end deffn

Em outros sistemas Unix (como o FreeBSD), os seguintes atributos podem estar disponíveis (mas só podem ser preenchidos se o root tentar usá-los):

@geindex st_gen (atributo os.stat_result)
@anchor{library/os os stat_result st_gen}@anchor{2d75}
@deffn {Atributo} st_gen

Número de geração do arquivo.
@end deffn

No Solaris e derivados, os seguintes atributos também podem estar disponíveis:

@geindex st_fstype (atributo os.stat_result)
@anchor{library/os os stat_result st_fstype}@anchor{b7a}
@deffn {Atributo} st_fstype

String que identifica exclusivamente o tipo de sistema de arquivos que contém o arquivo.
@end deffn

Em sistemas macOS, os seguintes atributos também podem estar disponíveis:

@geindex st_rsize (atributo os.stat_result)
@anchor{library/os os stat_result st_rsize}@anchor{2d76}
@deffn {Atributo} st_rsize

Tamanho real do arquivo.
@end deffn

@geindex st_creator (atributo os.stat_result)
@anchor{library/os os stat_result st_creator}@anchor{2d77}
@deffn {Atributo} st_creator

Criador do arquivo.
@end deffn

@geindex st_type (atributo os.stat_result)
@anchor{library/os os stat_result st_type}@anchor{2d78}
@deffn {Atributo} st_type

Tipo de arquivo.
@end deffn

Em sistemas Windows, os seguintes atributos também estão disponíveis:

@geindex st_file_attributes (atributo os.stat_result)
@anchor{library/os os stat_result st_file_attributes}@anchor{e65}
@deffn {Atributo} st_file_attributes

Atributos de arquivos no Windows: membro @code{dwFileAttributes} da estrutura @code{BY_HANDLE_FILE_INFORMATION} retornada por @code{GetFileInformationByHandle()}. Veja as constantes @code{FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE>} no módulo @ref{d1,,stat}.


Adicionado na versão 3.5.

@end deffn

@geindex st_reparse_tag (atributo os.stat_result)
@anchor{library/os os stat_result st_reparse_tag}@anchor{a15}
@deffn {Atributo} st_reparse_tag

Quando @ref{e65,,st_file_attributes} tem @ref{29e2,,FILE_ATTRIBUTE_REPARSE_POINT} definido, este campo contém uma tag identificando o tipo do ponto de nova análise. Veja as constantes @ref{29e7,,IO_REPARSE_TAG_*} no módulo @ref{d1,,stat}.
@end deffn

O módulo padrão @ref{d1,,stat} define funções e constantes que são úteis para extrair informações de uma estrutura @code{stat}. (No Windows, alguns itens são preenchidos com valores fictícios.)

Para compatibilidade com versões anteriores, uma instância de @ref{1509,,stat_result} também é acessível como uma tupla de pelo menos 10 inteiros, fornecendo os membros mais importantes (e portáveis) da estrutura @code{stat}, na ordem @ref{a14,,st_mode}, @ref{2d65,,st_ino}, @ref{2d66,,st_dev}, @ref{2d67,,st_nlink}, @ref{2d68,,st_uid}, @ref{2d69,,st_gid}, @ref{2d6a,,st_size}, @ref{2d6b,,st_atime}, @ref{2bf7,,st_mtime}, @ref{2d6c,,st_ctime}. Mais itens podem ser adicionados no final por algumas implementações. Para compatibilidade com versões mais antigas do Python, acessar @ref{1509,,stat_result} como uma tupla sempre retorna inteiros.


Alterado na versão 3.5: Windows agora retorna o arquivo de índice como @ref{2d65,,st_ino} quando disponível.



Alterado na versão 3.7: Adicionado o membro @ref{b7a,,st_fstype} ao Solaris/derivados.



Alterado na versão 3.8: Adicionado o membro @ref{a15,,st_reparse_tag} no Windows.



Alterado na versão 3.8: No Windows, o membro @ref{a14,,st_mode} agora identifica arquivos especiais como @code{S_IFCHR}, @code{S_IFIFO} ou @code{S_IFBLK} conforme apropriado.



Alterado na versão 3.12: No Windows, @ref{2d6c,,st_ctime} foi descontinuado. Eventualmente, ele conterá a hora da última alteração de metadados, para fins de consistência com outras plataformas, mas por enquanto ainda contém a hora de criação. Use @ref{2d70,,st_birthtime} para a hora de criação.

No Windows, o @ref{2d65,,st_ino} agora pode ter até 128 bits, dependendo do sistema de arquivos. Anteriormente, não era possível ter mais de 64 bits, e identificadores de arquivo maiores seriam compactados arbitrariamente.

No Windows, @ref{15f4,,st_rdev} não retorna mais um valor. Anteriormente, ele continha o mesmo que @ref{2d66,,st_dev}, o que era incorreto.

Adicionado o membro @ref{2d70,,st_birthtime} no Windows.

@end deffn

@geindex statvfs() (no módulo os)
@anchor{library/os os statvfs}@anchor{113b}
@deffn {Função} os.statvfs (path)

Executa uma chamada de sistema @code{statvfs()} no caminho fornecido. O valor de retorno é um objeto cujos atributos descrevem o sistema de arquivos no caminho fornecido e correspondem aos membros da estrutura @code{statvfs}, a saber: @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}.

Duas constantes em nível de módulo são definidas para os sinalizadores de bit do atributo @code{f_flag}: se @code{ST_RDONLY} estiver definido, o sistema de arquivos é montado somente leitura, e se @code{ST_NOSUID} estiver definido, a semântica dos bits setuid/setgid é desabilitada ou não é implementada.

Constantes de nível de módulo adicionais são definidas para sistemas baseados em GNU/glibc. São elas @code{ST_NODEV} (impede o acesso aos arquivos especiais do dispositivo), @code{ST_NOEXEC} (não permite a execução do programa), @code{ST_SYNCHRONOUS} (as escritas são sincronizadas de uma vez), @code{ST_MANDLOCK} (permitir travas obrigatórias em um sistema de arquivos), @code{ST_WRITE} (escrever no arquivo/diretório/link simbólico), @code{ST_APPEND} (arquivo somente anexado), @code{ST_IMMUTABLE} (arquivo imutável), @code{ST_NOATIME} (não atualiza os tempos de acesso), @code{ST_NODIRATIME} (não atualiza os tempos de acesso ao diretório), @code{ST_RELATIME} (atualiza o atime relativo ao mtime/ctime).

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo}.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.2: As constantes @code{ST_RDONLY} e @code{ST_NOSUID} foram adicionadas.



Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto.



Alterado na versão 3.4: As constantes @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} e @code{ST_RELATIME} foram adicionadas.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: Adicionado o atributo @code{f_fsid}.

@end deffn

@geindex supports_dir_fd (no módulo os)
@anchor{library/os os supports_dir_fd}@anchor{1136}
@deffn {Dado} os.supports_dir_fd

Um objeto @ref{5d9,,set} indicando quais funções no módulo @ref{a1,,os} aceitam um descritor de arquivo aberto para seu parâmetro `dir_fd'. Plataformas diferentes fornecem recursos diferentes, e a funcionalidade subjacente que o Python usa para implementar o parâmetro `dir_fd' não está disponível em todas as plataformas que o Python provê suporte. Para fins de consistência, as funções que podem implementar `dir_fd' sempre permitem especificar o parâmetro, mas lançarão uma exceção se a funcionalidade for usada quando não estiver disponível localmente. (Especificar @code{None} para `dir_fd' é sempre válido em todas as plataformas.)

Para verificar se uma função particular aceita um descritor de arquivo aberto para seu parâmetro `dir_fd', use o operador @code{in} em @code{supports_dir_fd}. Como exemplo, esta expressão é avaliada como @code{True} se @ref{4a0,,os.stat()} aceita descritores de arquivo abertos para `dir_fd' na plataforma local:

@example
os.stat in os.supports_dir_fd
@end example

Atualmente os parâmetros `dir_fd' funcionam apenas em plataformas Unix; nenhum deles funciona no Windows.


Adicionado na versão 3.3.

@end deffn

@geindex supports_effective_ids (no módulo os)
@anchor{library/os os supports_effective_ids}@anchor{113d}
@deffn {Dado} os.supports_effective_ids

Um objeto @ref{5d9,,set} que indica se @ref{112b,,os.access()} permite especificar @code{True} para seu parâmetro `effective_ids' na plataforma local. (Especificar @code{False} para `effective_ids' é sempre válido em todas as plataformas.) Se a plataforma local oferecer suporte, a coleção conterá @ref{112b,,os.access()}; caso contrário, ficará vazio.

Esta expressão é avaliada como @code{True} se @ref{112b,,os.access()} oferecer suporte a @code{effective_ids=True} na plataforma local:

@example
os.access in os.supports_effective_ids
@end example

Atualmente, `effective_ids' funciona apenas em plataformas Unix; não funciona no Windows.


Adicionado na versão 3.3.

@end deffn

@geindex supports_fd (no módulo os)
@anchor{library/os os supports_fd}@anchor{113c}
@deffn {Dado} os.supports_fd

Um objeto @ref{5d9,,set} que indica quais funções no módulo @ref{a1,,os} permitem especificar seu parâmetro `path' como um descritor de arquivo aberto na plataforma local. Plataformas diferentes fornecem recursos diferentes, e a funcionalidade subjacente que o Python usa para aceitar descritores de arquivos abertos como argumentos `path' não está disponível em todas as plataformas que o Python provê suporte.

Para determinar se uma função particular permite especificar um descritor de arquivo aberto para seu parâmetro `path', use o operador @code{in} em @code{supports_fd}. Como exemplo, esta expressão é avaliada como @code{True} se @ref{60d,,os.chdir()} aceita descritores de arquivo abertos para `path' em sua plataforma local:

@example
os.chdir in os.supports_fd
@end example


Adicionado na versão 3.3.

@end deffn

@geindex supports_follow_symlinks (no módulo os)
@anchor{library/os os supports_follow_symlinks}@anchor{1137}
@deffn {Dado} os.supports_follow_symlinks

Um objeto @ref{5d9,,set} que indica quais funções no módulo @ref{a1,,os} aceitam @code{False} para seu parâmetro `follow_symlinks' na plataforma local. Plataformas diferentes fornecem recursos diferentes, e a funcionalidade subjacente que o Python usa para implementar `follow_symlinks' não está disponível em todas as plataformas às quais o Python tem suporte. Para fins de consistência, as funções que podem ter suporte a `follow_symlinks' sempre permitem especificar o parâmetro, mas irão lançar uma exceção se a funcionalidade for usada quando não estiver disponível localmente. (Especificar @code{True} para `follow_symlinks' é sempre aceito em todas as plataformas.)

Para verificar se uma função em particular aceita @code{False} para seu parâmetro `follow_symlinks', use o operador @code{in} em @code{supports_follow_symlinks}. Como exemplo, esta expressão é avaliada como @code{True} se você pode especificar @code{follow_symlinks=False} ao chamar @ref{4a0,,os.stat()} na plataforma local:

@example
os.stat in os.supports_follow_symlinks
@end example


Adicionado na versão 3.3.

@end deffn

@geindex symlink() (no módulo os)
@anchor{library/os os symlink}@anchor{1133}
@deffn {Função} os.symlink (src, dst, target_is_directory=False, *, dir_fd=None)

Cria um link simbólico apontando para `src' chamado `dst'.

O parâmetro `src' refere-se ao destino do link (o arquivo ou diretório para o qual o link está sendo criado), e `dst' é o nome do link que está sendo criado.

No Windows, um link simbólico representa um arquivo ou um diretório e não se transforma no destino dinamicamente. Se o alvo estiver presente, será criado um link simbólico de mesmo tipo. Caso contrário, o link simbólico será criado como um diretório se `target_is_directory' for @code{True} ou um link simbólico de arquivo (o padrão) caso contrário. Em plataformas não Windows, `target_is_directory' é ignorado.

Esta função tem suporte a @ref{1129,,caminhos relativos para descritores de diretório}.

@cartouche
@quotation Nota 
Em versões mais recentes do Windows 10, contas sem privilégios podem criar links simbólicos se o Modo de Desenvolvedor estiver habilitado. Quando o modo de desenvolvedor não está disponível/ativado, o privilégio `SeCreateSymbolicLinkPrivilege' é necessário ou o processo deve ser executado como um administrador.

A exceção @ref{417,,OSError} é levantada quando a função é chamada por um usuário sem privilégios.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{os.symlink} com os argumentos @code{src}, @code{dst} e @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.

A função é limitada em WASI, veja @ref{18f5,,Plataformas WebAssembly} para mais informações.


Alterado na versão 3.2: Adicionado suporte para links simbólicos do Windows 6.0 (Vista).



Alterado na versão 3.3: Adicionado o parâmetro `dir_fd', e agora permite `target_is_directory' em plataformas não Windows.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `src' e `dst'.



Alterado na versão 3.8: Adicionado suporte para links simbólicos não elevados no Windows com Modo de Desenvolvedor.

@end deffn

@geindex sync() (no módulo os)
@anchor{library/os os sync}@anchor{1151}
@deffn {Função} os.sync ()

Força a escrita de tudo para o disco.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex truncate() (no módulo os)
@anchor{library/os os truncate}@anchor{e69}
@deffn {Função} os.truncate (path, length)

Trunca o arquivo correspondente ao `path', de modo que tenha no máximo `length' bytes.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.truncate} com os argumentos @code{path} e @code{length}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Adicionado na versão 3.3.



Alterado na versão 3.5: Adicionado suporte para o Windows.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex unlink() (no módulo os)
@anchor{library/os os unlink}@anchor{1134}
@deffn {Função} os.unlink (path, *, dir_fd=None)

Remove (exclui) o arquivo `path'. Esta função é semanticamente idêntica à @ref{112f,,remove()}; o nome @code{unlink} é seu nome Unix tradicional. Por favor, veja a documentação de @ref{112f,,remove()} para mais informações.

Levanta um @ref{19fa,,evento de auditoria} @code{os.remove} com os argumentos @code{path}, @code{dir_fd}.


Alterado na versão 3.3: Adicionado o parâmetro `dir_fd'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex utime() (no módulo os)
@anchor{library/os os utime}@anchor{1135}
@deffn {Função} os.utime (path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)

Define os tempos de acesso e modificação do arquivo especificado por `path'.

@ref{1135,,utime()} aceita dois parâmetros opcionais, `times' e `ns'. Eles especificam os horários definidos no `path' e são usados da seguinte forma:


@itemize -

@item 
Se `ns' for especificado, deve ser uma tupla de 2 elementos na forma @code{(atime_ns, mtime_ns)} onde cada membro é um inteiro expressando nanossegundos.

@item 
Se `times' não for @code{None}, deve ser uma tupla de 2 elementos na forma @code{(atime, mtime)} onde cada membro é um inteiro ou ponto flutuante expressando segundos.

@item 
Se `times' for @code{None} e `ns' não for especificado, isso é equivalente a especificar @code{ns=(atime_ns, mtime_ns)} onde ambos os tempos são a hora atual.
@end itemize

É um erro especificar tuplas para ambos `times' e `ns'.

Observe que os tempos exatos que você definiu aqui podem não ser retornados por uma chamada subsequente de @ref{4a0,,stat()}, dependendo da resolução com a qual seu sistema operacional registra os tempos de acesso e modificação; veja @ref{4a0,,stat()}. A melhor maneira de preservar os tempos exatos é usar os campos `st_atime_ns' e `st_mtime_ns' do objeto de resultado @ref{4a0,,os.stat()} com o parâmetro `ns' para @ref{1135,,utime()}.

Esta função pode oferecer suporte a @ref{b72,,especificar um descritor de arquivo}, @ref{1129,,caminhos relativos aos descritores de diretório} e @ref{112a,,não seguir os links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.utime} com os argumentos @code{path}, @code{times}, @code{ns} e @code{dir_fd}.


Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto e os parâmetros `dir_fd', `follow_symlinks' e `ns'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex walk() (no módulo os)
@anchor{library/os os walk}@anchor{4a9}
@deffn {Função} os.walk (top, topdown=True, onerror=None, followlinks=False)

@geindex diretório;percorrer
@geindex diretório;traversal

Gera os nomes dos arquivos em uma árvore de diretório percorrendo a árvore de cima para baixo ou de baixo para cima. Para cada diretório na árvore com raiz no diretório `top' (incluindo o próprio `top'), ele produz uma tupla de 3 elementos @code{(dirpath, dirnames, filenames)}.

`dirpath' é uma string, o caminho para o diretório. `dirnames' é uma lista dos nomes dos subdiretórios em `dirpath' (incluindo links simbólicos para diretórios e excluindo @code{'.'} e @code{'..'}). `filenames' é uma lista dos nomes dos arquivos não pertencentes ao diretório em `dirpath'. Observe que os nomes nas listas não contêm componentes de caminho. Para obter um caminho completo (que começa com `top') para um arquivo ou diretório em `dirpath', execute @code{os.path.join(dirpath, name)}. Se as listas são ou não ordenadas depende do sistema de arquivos. Se um arquivo for removido ou adicionado ao diretório `dirpath' durante a geração das listas, não é especificado se um nome para esse arquivo deve ser incluído.

Se o argumento opcional `topdown' for @code{True} ou não especificado, o triplo para um diretório é gerado antes dos triplos para qualquer um de seus subdiretórios (os diretórios são gerados de cima para baixo). Se `topdown' for @code{False}, o triplo para um diretório é gerado após os triplos para todos os seus subdiretórios (os diretórios são gerados de baixo para cima). Não importa o valor de `topdown', a lista de subdiretórios é recuperada antes que as tuplas para o diretório e seus subdiretórios sejam geradas.

Quando `topdown' é @code{True}, o chamador pode modificar a lista de `dirnames' internamente (talvez usando @ref{18a7,,del} ou atribuição de fatia), e @ref{4a9,,walk()} só recursará nos subdiretórios cujos nomes permanecem em `dirnames'; isso pode ser usado para podar a busca, impor uma ordem específica de visita, ou mesmo informar à função @ref{4a9,,walk()} sobre os diretórios que o chamador cria ou renomeia antes de retomar @ref{4a9,,walk()} novamente. Modificar `dirnames' quando `topdown' for @code{False} não tem efeito no comportamento da caminhada, porque no modo de baixo para cima os diretórios em `dirnames' são gerados antes do próprio `dirpath' ser gerado.

Por padrão, os erros da chamada de @ref{a68,,scandir()} são ignorados. Se o argumento opcional `onerror' for especificado, deve ser uma função; ela será chamado com um argumento, uma instância da exceção @ref{417,,OSError}. Ele pode relatar o erro para continuar com a caminhada ou levantar a exceção para abortar a caminhada. Observe que o nome do arquivo está disponível como o atributo @code{filename} do objeto de exceção.

Por padrão, a função @ref{4a9,,walk()} não vai seguir links simbólicos que resolvem para diretórios. Defina `followlinks' como @code{True} para visitar diretórios apontados por links simbólicos, em sistemas que oferecem suporte a eles.

@cartouche
@quotation Nota 
Esteja ciente de que definir `followlinks' para @code{True} pode levar a recursão infinita se um link apontar para um diretório pai de si mesmo. @ref{4a9,,walk()} não mantém registro dos diretórios que já visitou.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se você passar um nome de caminho relativo, não mude o diretório de trabalho atual entre as continuações de @ref{4a9,,walk()}. @ref{4a9,,walk()} nunca muda o diretório atual, e presume que seu chamador também não.
@end quotation
@end cartouche

Este exemplo exibe o número total de bytes dos arquivos não-diretório em cada diretório no diretório inicial, exceto que ele não olha em nenhum subdiretório chamado @code{__pycache__}:

@example
import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/xml'):
    print(root, "consome", end=" ")
    print(sum(getsize(join(root, name)) for name in files), end=" ")
    print("bytes em", len(files), "arquivos que não são diretórios")
    if '__pycache__' in dirs:
        dirs.remove('__pycache__')  # não visita diretórios de __pycache__
@end example

No próximo exemplo (implementação simples de @ref{301,,shutil.rmtree()}), andar na árvore de baixo para cima é essencial, @ref{1132,,rmdir()} não permite excluir um diretório antes que o diretório esteja vazio:

@example
# Exclui tudo que for acessível do diretório nomeado em "top",
# presumindo que não há links simbólicos.
# CUIDADO: Isso é perigoso! Por exemplo, se top == '/',
# ele pode excluir todos os seus arquivos de disco.
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

Levanta um @ref{19fa,,evento de auditoria} @code{os.walk} com os argumentos @code{top}, @code{topdown}, @code{onerror} e @code{followlinks}.


Alterado na versão 3.5: Esta função agora chama @ref{a68,,os.scandir()} em vez de @ref{1139,,os.listdir()}, tornando-a mais rápida reduzindo o número de chamadas a @ref{4a0,,os.stat()}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex fwalk() (no módulo os)
@anchor{library/os os fwalk}@anchor{b71}
@deffn {Função} os.fwalk (top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

@geindex diretório;percorrer
@geindex diretório;traversal

Se comporta exatamente como @ref{4a9,,walk()}, exceto que produz um tupla de 4 elementos @code{(dirpath, dirnames, filenames, dirfd)}, e tem suporte a @code{dir_fd}.

`dirpath', `dirnames' e `filenames' são idênticos à saída de @ref{4a9,,walk()} e `dirfd' é um descritor de arquivo que faz referência ao diretório `dirpath'.

Esta função sempre tem suporte a @ref{1129,,caminhos relativos aos descritores de diretório} e @ref{112a,,não seguir links simbólicos}. Observe, entretanto, que, ao contrário de outras funções, o valor padrão @ref{b71,,fwalk()} para `follow_symlinks' é @code{False}.

@cartouche
@quotation Nota 
Uma vez que @ref{b71,,fwalk()} produz descritores de arquivo, eles só são válidos até a próxima etapa de iteração, então você deve duplicá-los (por exemplo, com @ref{1b54,,dup()}) se quiser mantê-los por mais tempo.
@end quotation
@end cartouche

Este exemplo exibe o número total de bytes dos arquivos não-diretório em cada diretório no diretório inicial, exceto que ele não olha em nenhum subdiretório chamado @code{__pycache__}:

@example
import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/xml'):
    print(root, "consome", end=" ")
    print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
          end=" ")
    print("bytes em", len(files), "arquivos que não são diretórios")
    if '__pycache__' in dirs:
        dirs.remove('__pycache__')  # não visita diretórios de __pycache__
@end example

No próximo exemplo, percorrer a árvore de baixo para cima é essencial: @ref{1132,,rmdir()} não permite excluir um diretório antes que o diretório esteja vazio:

@example
# Exclui tudo que for acessível do diretório nomeado em "top",
# presumindo que não há links simbólicos.
# CUIDADO: Isso é perigoso! Por exemplo, se top == '/',
# ele pode excluir todos os seus arquivos de disco.
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

Levanta um @ref{19fa,,evento de auditoria} @code{os.fwalk} com os argumentos @code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks} e @code{dir_fd}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: Adicionado suporte para caminhos em @ref{1c2,,bytes}.

@end deffn

@geindex memfd_create() (no módulo os)
@anchor{library/os os memfd_create}@anchor{a13}
@deffn {Função} os.memfd_create (name[, flags=os.MFD_CLOEXEC])

Cria um arquivo anônimo e retorna um descritor de arquivo que faça referência a ele. `flags' deve ser uma das constantes @code{os.MFD_*} disponíveis no sistema (ou uma combinação de OU bit a bit delas). Por padrão, o novo descritor de arquivo é @ref{f2b,,não herdável}.

O nome fornecido em `name' é usado como um nome de arquivo e será exibido como o destino do link simbólico correspondente no diretório @code{/proc/self/fd/}. O nome exibido é sempre prefixado com @code{memfd:} e serve apenas para fins de depuração. Os nomes não afetam o comportamento do descritor de arquivo e, como tal, vários arquivos podem ter o mesmo nome sem quaisquer efeitos colaterais.

@ref{1ed8,,Disponibilidade}: Linux >= 3.17 with glibc >= 2.27.


Adicionado na versão 3.8.

@end deffn

@geindex MFD_CLOEXEC (no módulo os)
@geindex MFD_ALLOW_SEALING (no módulo os)
@geindex MFD_HUGETLB (no módulo os)
@geindex MFD_HUGE_SHIFT (no módulo os)
@geindex MFD_HUGE_MASK (no módulo os)
@geindex MFD_HUGE_64KB (no módulo os)
@geindex MFD_HUGE_512KB (no módulo os)
@geindex MFD_HUGE_1MB (no módulo os)
@geindex MFD_HUGE_2MB (no módulo os)
@geindex MFD_HUGE_8MB (no módulo os)
@geindex MFD_HUGE_16MB (no módulo os)
@geindex MFD_HUGE_32MB (no módulo os)
@geindex MFD_HUGE_256MB (no módulo os)
@geindex MFD_HUGE_512MB (no módulo os)
@geindex MFD_HUGE_1GB (no módulo os)
@geindex MFD_HUGE_2GB (no módulo os)
@geindex MFD_HUGE_16GB (no módulo os)
@anchor{library/os os MFD_CLOEXEC}@anchor{2d79}
@deffn {Dado} os.MFD_CLOEXEC
@anchor{library/os os MFD_ALLOW_SEALING}@anchor{2d7a}
@deffnx {Dado} os.MFD_ALLOW_SEALING
@anchor{library/os os MFD_HUGETLB}@anchor{2d7b}
@deffnx {Dado} os.MFD_HUGETLB
@anchor{library/os os MFD_HUGE_SHIFT}@anchor{2d7c}
@deffnx {Dado} os.MFD_HUGE_SHIFT
@anchor{library/os os MFD_HUGE_MASK}@anchor{2d7d}
@deffnx {Dado} os.MFD_HUGE_MASK
@anchor{library/os os MFD_HUGE_64KB}@anchor{2d7e}
@deffnx {Dado} os.MFD_HUGE_64KB
@anchor{library/os os MFD_HUGE_512KB}@anchor{2d7f}
@deffnx {Dado} os.MFD_HUGE_512KB
@anchor{library/os os MFD_HUGE_1MB}@anchor{2d80}
@deffnx {Dado} os.MFD_HUGE_1MB
@anchor{library/os os MFD_HUGE_2MB}@anchor{2d81}
@deffnx {Dado} os.MFD_HUGE_2MB
@anchor{library/os os MFD_HUGE_8MB}@anchor{2d82}
@deffnx {Dado} os.MFD_HUGE_8MB
@anchor{library/os os MFD_HUGE_16MB}@anchor{2d83}
@deffnx {Dado} os.MFD_HUGE_16MB
@anchor{library/os os MFD_HUGE_32MB}@anchor{2d84}
@deffnx {Dado} os.MFD_HUGE_32MB
@anchor{library/os os MFD_HUGE_256MB}@anchor{2d85}
@deffnx {Dado} os.MFD_HUGE_256MB
@anchor{library/os os MFD_HUGE_512MB}@anchor{2d86}
@deffnx {Dado} os.MFD_HUGE_512MB
@anchor{library/os os MFD_HUGE_1GB}@anchor{2d87}
@deffnx {Dado} os.MFD_HUGE_1GB
@anchor{library/os os MFD_HUGE_2GB}@anchor{2d88}
@deffnx {Dado} os.MFD_HUGE_2GB
@anchor{library/os os MFD_HUGE_16GB}@anchor{2d89}
@deffnx {Dado} os.MFD_HUGE_16GB

Esses sinalizadores podem ser passados para @ref{a13,,memfd_create()}.

@ref{1ed8,,Disponibilidade}: Linux >= 3.17 with glibc >= 2.27

Os sinalizadores @code{MFD_HUGE*} estão disponíveis somente a partir do Linux 4.14.


Adicionado na versão 3.8.

@end deffn

@geindex eventfd() (no módulo os)
@anchor{library/os os eventfd}@anchor{81b}
@deffn {Função} os.eventfd (initval[, flags=os.EFD_CLOEXEC])

Cria e retorna um descritor de arquivo de evento. Os descritores de arquivo implementam  @ref{dbd,,read()} e @ref{dc3,,write()} brutos com um tamanho de buffer de 8, @ref{dc8,,select()}, @ref{2d8a,,poll()} e similares. Veja a página man @code{eventfd(2)@footnote{https://manpages.debian.org/eventfd(2)}} para mais informações.  Por padrão, o novo descritor de arquivo é @ref{f2b,,não herdável}.

`initval' é o valor inicial do contador de evento. O valor inicial deve ser um inteiro sem sinal de 32 bits. Observe que o valor inicial é limitado a um inteiro sem sinal de 32 bits ainda que o contador de evento seja um inteiro de 64 bits com um valor máximo de 2@w{^64}-2.

`flags' podem ser construídas a partir de @ref{18e3,,EFD_CLOEXEC}, @ref{18e4,,EFD_NONBLOCK} e @ref{18e5,,EFD_SEMAPHORE}.

Se @ref{18e5,,EFD_SEMAPHORE} for especificado e o contador de evento for diferente de zero, @ref{2d8b,,eventfd_read()} retorna 1 e decrementa o contador em um.

Se @ref{18e5,,EFD_SEMAPHORE} não for especificado e o contador de evento for diferente de zero, @ref{2d8b,,eventfd_read()} retorna o valor atual do contador de evento e zera o contador.

Se o contador de evento for zero e @ref{18e4,,EFD_NONBLOCK} não for especificado, @ref{2d8b,,eventfd_read()} bloqueia.

@ref{2d8c,,eventfd_write()} incrementa o contador de evento. A escrita bloqueia se a operação de escrita incrementar o contador para um valor maior que 2@w{^64}-2.

Exemplo:

@example
import os

# semaphore with start value '1'
fd = os.eventfd(1, os.EFD_SEMAPHORE | os.EFD_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{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.10.

@end deffn

@geindex eventfd_read() (no módulo os)
@anchor{library/os os eventfd_read}@anchor{2d8b}
@deffn {Função} os.eventfd_read (fd)

Lê um valor de um descritor de arquivo @ref{81b,,eventfd()} e retorna um inteiro sem sinal de 64 bits. A função não verifica se `fd' é um @ref{81b,,eventfd()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27


Adicionado na versão 3.10.

@end deffn

@geindex eventfd_write() (no módulo os)
@anchor{library/os os eventfd_write}@anchor{2d8c}
@deffn {Função} os.eventfd_write (fd, value)

Adiciona `value' a um descritor de arquivo @ref{81b,,eventfd()}. `value' deve ser um inteiro sem sinal de 64 bits. A função não verifica se `fd' é um @ref{81b,,eventfd()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27


Adicionado na versão 3.10.

@end deffn

@geindex EFD_CLOEXEC (no módulo os)
@anchor{library/os os EFD_CLOEXEC}@anchor{18e3}
@deffn {Dado} os.EFD_CLOEXEC

Define sinalizador close-on-exec para o novo descritor de arquivo @ref{81b,,eventfd()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27


Adicionado na versão 3.10.

@end deffn

@geindex EFD_NONBLOCK (no módulo os)
@anchor{library/os os EFD_NONBLOCK}@anchor{18e4}
@deffn {Dado} os.EFD_NONBLOCK

Define sinalizador de status @ref{e68,,O_NONBLOCK} para um novo descritor de arquivo @ref{81b,,eventfd()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27


Adicionado na versão 3.10.

@end deffn

@geindex EFD_SEMAPHORE (no módulo os)
@anchor{library/os os EFD_SEMAPHORE}@anchor{18e5}
@deffn {Dado} os.EFD_SEMAPHORE

Fornece semântica de semáforo ou similar para leitura de um descritor de arquivo @ref{81b,,eventfd()}. Na leitura o contador interno é decrementado em um.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.30


Adicionado na versão 3.10.

@end deffn

@menu
* Descritores de arquivo de temporizador:: 
* Atributos estendidos do Linux:: 

@end menu

@node Descritores de arquivo de temporizador,Atributos estendidos do Linux,,Arquivos e diretórios
@anchor{library/os os-timerfd}@anchor{153}@anchor{library/os timer-file-descriptors}@anchor{2d8d}
@subsubsection Descritores de arquivo de temporizador



Adicionado na versão 3.13.


Essas funções fornecem suporte para a API de `descritores de arquivo de temporizador'.

@geindex timerfd_create() (no módulo os)
@anchor{library/os os timerfd_create}@anchor{211}
@deffn {Função} os.timerfd_create (clockid, /, *, flags=0)

Cria e retorna um descritor de arquivo de temporizador (`timerfd').

O descritor de arquivo retornado por @ref{211,,timerfd_create()} implementa:


@itemize -

@item 
@ref{dbd,,read()}

@item 
@ref{dc8,,select()}

@item 
@ref{2d8a,,poll()}
@end itemize

O método @ref{dbd,,read()} do descritor de arquivo pode ser chamado com um buffer de tamanho 8. Se o temporizador já expirou uma ou mais vezes, @ref{dbd,,read()} retorna o número de vezes que o descritor expirou com a ordem dos bytes no formato do hospedeiro, que pode ser convertido para um @ref{257,,int} com @code{int.from_bytes(x, byteorder=sys.byteorder)}.

@ref{dc8,,select()} e @ref{2d8a,,poll()} pode ser usado para esperar até que o temporizador expire e o descritor de arquivo possa ser lido.

`clockid' deve ser um @ref{2d8e,,ID de relógio} válido, conforme definido no módulo @ref{ee,,time}:


@itemize -

@item 
@ref{69a,,time.CLOCK_REALTIME}

@item 
@ref{699,,time.CLOCK_MONOTONIC}

@item 
@ref{ba6,,time.CLOCK_BOOTTIME} (A partir de Linux 3.15 para timerfd_create)
@end itemize

Se `clockid' é @ref{69a,,time.CLOCK_REALTIME}, é usado um relógio em tempo real definido em todo o sistema. Se o relógio do sistema muda, a configuração do temporizador precisa ser atualizado. Para cancelar o temporizador quando o relógio do sistema é alterado, veja @ref{219,,TFD_TIMER_CANCEL_ON_SET}.

Se `clockid' é @ref{699,,time.CLOCK_MONOTONIC}, é usado um relógio monotonicamente não estável. Mesmo se o relógio do sistema é alterado, a configuração do temporizador não será afetada.

Se `clockid' é @ref{ba6,,time.CLOCK_BOOTTIME}, é idêntica a @ref{699,,time.CLOCK_MONOTONIC} exceto por incluir qualquer tempo que o sistema está suspenso.

O comportamento do descritor de arquivo pode ser modificado especificando um valor para  `flags'. Qualquer um dos seguintes valores pode ser usado, combinadas usando OU (OR) bit a bit (o operador @code{|}):


@itemize -

@item 
@ref{216,,TFD_NONBLOCK}

@item 
@ref{217,,TFD_CLOEXEC}
@end itemize

Se @ref{216,,TFD_NONBLOCK} não está definido como um sinalizador, @ref{dbd,,read()} bloqueia até o temporizador expirar. Se está definido como um sinalizador, @ref{dbd,,read()} não bloqueia, mas se não expirou desde a última chamada, @ref{dbd,,read()} levanta @ref{417,,OSError} com @code{errno} definido como @ref{2435,,errno.EAGAIN}.

@ref{217,,TFD_CLOEXEC} é sempre definido pelo Python automaticamente.

O descritor de arquivo deve ser fechado com @ref{b8a,,os.close()} quando não é mais necessário, caso contrário o descritor de arquivo será vazado.


@subsubheading Ver também


A página man @code{timerfd_create(2)@footnote{https://manpages.debian.org/timerfd_create(2)}}.


@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex timerfd_settime() (no módulo os)
@anchor{library/os os timerfd_settime}@anchor{212}
@deffn {Função} os.timerfd_settime (fd, /, *, flags=flags, initial=0.0, interval=0.0)

Altera um temporizador interno do descritor de arquivo de temporizador. Essa função opera no mesmo intervalo do temporizador definido com @ref{213,,timerfd_settime_ns()}.

`fd' deve ser um descritor de arquivo de temporizador válido.

O comportamento do temporizador pode ser modificado especificando um valor para  `flags'. Qualquer um dos seguintes valores pode ser usado, combinados usando OU (OR) bit a bit (o operador @code{|}):


@itemize -

@item 
@ref{218,,TFD_TIMER_ABSTIME}

@item 
@ref{219,,TFD_TIMER_CANCEL_ON_SET}
@end itemize

O temporizador é desabilitado definindo `initial' para zero (@code{0}). Se `initial' é igual ou maior que zero, o temporizador é habilitado. Se `initial' é menor que zero, uma exceção @ref{417,,OSError} é levantada com @code{errno} definido como @ref{1b66,,errno.EINVAL}.

Por padrão, o temporizador vai disparar quando passarem `initial' segundos. (Se `initial' é zero, o temporizador dispara imediatamente.)

Contudo, se o sinalizador @ref{218,,TFD_TIMER_ABSTIME} está definido, o temporizador dispara quando o relógio do temporizador (definido por `clockid' em @ref{211,,timerfd_create()}) atingir `initial' segundos.

O intervalor do temporizador é definido pelo @ref{2f7,,float} `interval'. Se `interval' é zero, o temporizador irá disparar apenas uma vez, no disparo inicial. Se `interval' é maior que zero, o temporizador vai disparar a cada `interval' segundos a partir do disparo anterior. Se `interval' é menor que zero, uma exceção @ref{417,,OSError} será levantada com @code{errno} definido como @ref{1b66,,errno.EINVAL}.

Se o sinalizador @ref{219,,TFD_TIMER_CANCEL_ON_SET} é definido com @ref{218,,TFD_TIMER_ABSTIME} e o relógio para o temporizador é @ref{69a,,time.CLOCK_REALTIME}, o temporizador é marcado como cancelável se o relógio em tempo real é alterado descontinuadamente. Leitura do descritor é abortada com o erro ECANCELED.

Linux gerencia relógio do sistema como UTC. A transição do horário de verão é feita apenas pela alteração da compensação de horário e não causa alteração descontínua do relógio do sistema.

A alteração descontínua do relógio do sistema será causada pelos seguintes eventos:


@itemize -

@item 
@code{settimeofday}

@item 
@code{clock_settime}

@item 
definir hora e data do sistema com o comando  @code{date}
@end itemize

Retorna uma tupla com dois elementos (@code{next_expiration}, @code{interval}) do estado anterior do temporizador, antes da execução dessa função.


@subsubheading Ver também


@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)}}, e @code{date(1)@footnote{https://manpages.debian.org/date(1)}}.


@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex timerfd_settime_ns() (no módulo os)
@anchor{library/os os timerfd_settime_ns}@anchor{213}
@deffn {Função} os.timerfd_settime_ns (fd, /, *, flags=0, initial=0, interval=0)

Similar a @ref{212,,timerfd_settime()}, mas usa nanossegundos. Essa função opera no mesmo intervalo do temporizador definido com @ref{212,,timerfd_settime()}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex timerfd_gettime() (no módulo os)
@anchor{library/os os timerfd_gettime}@anchor{214}
@deffn {Função} os.timerfd_gettime (fd, /)

Retorna uma tupla de ponto flutuante com dois elementos (@code{next_expiration}, @code{interval}).

@code{next_expiration} indica o tempo relativo até o próximo disparo do cronômetro, independentemente do sinalizador @ref{218,,TFD_TIMER_ABSTIME} estar definido.

@code{interval} indica o intervalo do cronômetro. Se for zero, o cronômetro será acionado apenas uma vez, após terem passados @code{next_expiration} segundos.


@subsubheading Ver também


@code{timerfd_gettime(2)@footnote{https://manpages.debian.org/timerfd_gettime(2)}}


@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex timerfd_gettime_ns() (no módulo os)
@anchor{library/os os timerfd_gettime_ns}@anchor{215}
@deffn {Função} os.timerfd_gettime_ns (fd, /)

Similar a @ref{214,,timerfd_gettime()}, mas retorna o tempo em nanossegundos.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex TFD_NONBLOCK (no módulo os)
@anchor{library/os os TFD_NONBLOCK}@anchor{216}
@deffn {Dado} os.TFD_NONBLOCK

Um sinalizador para a função @ref{211,,timerfd_create()}, que define o estado do sinalizador @ref{e68,,O_NONBLOCK} para o novo descritor de arquivo de temporizador. Se @ref{216,,TFD_NONBLOCK} não for definido como sinalizador, @ref{dbd,,read()} bloqueia.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex TFD_CLOEXEC (no módulo os)
@anchor{library/os os TFD_CLOEXEC}@anchor{217}
@deffn {Dado} os.TFD_CLOEXEC

Um sinalizador para a função @ref{211,,timerfd_create()}. Se @ref{217,,TFD_CLOEXEC} for definido como um sinalizador, define o sinalizador close-on-exec para o novo descritor de arquivo.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex TFD_TIMER_ABSTIME (no módulo os)
@anchor{library/os os TFD_TIMER_ABSTIME}@anchor{218}
@deffn {Dado} os.TFD_TIMER_ABSTIME

Um sinalizador para as funções @ref{212,,timerfd_settime()} e @ref{213,,timerfd_settime_ns()}. Se esse sinalizador for definido, `initial' será intepretador como um valor absoluto no relógio do temporizador (em segundos UTC ou nanossegundos da Era Unix).

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@geindex TFD_TIMER_CANCEL_ON_SET (no módulo os)
@anchor{library/os os TFD_TIMER_CANCEL_ON_SET}@anchor{219}
@deffn {Dado} os.TFD_TIMER_CANCEL_ON_SET

Um sinalizador para as funções @ref{212,,timerfd_settime()} e @ref{213,,timerfd_settime_ns()} juntamente com @ref{218,,TFD_TIMER_ABSTIME}. O cronômetro é cancelado quando a hora do relógio subjacente muda de forma descontínua.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27 with glibc >= 2.8


Adicionado na versão 3.13.

@end deffn

@node Atributos estendidos do Linux,,Descritores de arquivo de temporizador,Arquivos e diretórios
@anchor{library/os linux-extended-attributes}@anchor{2d8f}
@subsubsection Atributos estendidos do Linux



Adicionado na versão 3.3.


Estas funções estão todas disponíveis apenas no Linux.

@geindex getxattr() (no módulo os)
@anchor{library/os os getxattr}@anchor{1143}
@deffn {Função} os.getxattr (path, attribute, *, follow_symlinks=True)

Retorna o valor do atributo estendido do sistema de arquivos `attribute' para `path'. `attribute' pode ser bytes ou str (direta ou indiretamente por meio da interface @ref{c6c,,PathLike}). Se for str, ele é codificado com a codificação do sistema de arquivos.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo} e @ref{112a,,não seguir links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.getxattr} com os argumentos @code{path} e @code{attribute}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `path' e `attribute'.

@end deffn

@geindex listxattr() (no módulo os)
@anchor{library/os os listxattr}@anchor{1144}
@deffn {Função} os.listxattr (path=None, *, follow_symlinks=True)

Retorna uma lista dos atributos estendidos do sistema de arquivos em `path'. Os atributos na lista são representados como strings decodificadas com a codificação do sistema de arquivos. Se `path' for @code{None}, @ref{1144,,listxattr()} irá examinar o diretório atual.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo} e @ref{112a,,não seguir links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.listxattr} com o argumento @code{path}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex removexattr() (no módulo os)
@anchor{library/os os removexattr}@anchor{1145}
@deffn {Função} os.removexattr (path, attribute, *, follow_symlinks=True)

Remove o atributo `attribute' do sistema de arquivos estendido do `path'. `attribute' deve ser bytes ou str (direta ou indiretamente através da interface @ref{c6c,,PathLike}). Se for uma string, é codificada com o @ref{53b,,tratador de erros e codificação do sistema de arquivos}

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo} e @ref{112a,,não seguir links simbólicos}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.removexattr} com os argumentos @code{path} e @code{attribute}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `path' e `attribute'.

@end deffn

@geindex setxattr() (no módulo os)
@anchor{library/os os setxattr}@anchor{1146}
@deffn {Função} os.setxattr (path, attribute, value, flags=0, *, follow_symlinks=True)

Define o atributo de sistema de arquivos estendido `attribute' em `path' como `value'. `attribute' deve ser um bytes ou str sem NULs embutidos (direta ou indiretamente por meio da interface @ref{c6c,,PathLike}). Se for um str, ele é codificado com @ref{53b,,tratador de erros e codificação do sistema de arquivos}. `flags' podem ser @ref{2d90,,XATTR_REPLACE} ou @ref{2d91,,XATTR_CREATE}. Se @ref{2d90,,XATTR_REPLACE} for fornecido e o atributo não existe, @code{ENODATA} será levantada. Se @ref{2d91,,XATTR_CREATE} for fornecido e o atributo já existir, o atributo não será criado e @code{EEXISTS} será levantada.

Esta função tem suporte a @ref{b72,,especificar um descritor de arquivo} e @ref{112a,,não seguir links simbólicos}.

@cartouche
@quotation Nota 
Um bug nas versões do kernel Linux inferiores a 2.6.39 fez com que o argumento `flags' fosse ignorado em alguns sistemas de arquivos.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{os.setxattr} com os argumentos @code{path}, @code{attribute}, @code{value} e @code{flags}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar} para `path' e `attribute'.

@end deffn

@geindex XATTR_SIZE_MAX (no módulo os)
@anchor{library/os os XATTR_SIZE_MAX}@anchor{2d92}
@deffn {Dado} os.XATTR_SIZE_MAX

O tamanho máximo que o valor de um atributo estendido pode ter. Atualmente, são 64 KiB no Linux.
@end deffn

@geindex XATTR_CREATE (no módulo os)
@anchor{library/os os XATTR_CREATE}@anchor{2d91}
@deffn {Dado} os.XATTR_CREATE

Este é um valor possível para o argumento `flags' em @ref{1146,,setxattr()}. Indica que a operação deve criar um atributo.
@end deffn

@geindex XATTR_REPLACE (no módulo os)
@anchor{library/os os XATTR_REPLACE}@anchor{2d90}
@deffn {Dado} os.XATTR_REPLACE

Este é um valor possível para o argumento `flags' em @ref{1146,,setxattr()}. Indica que a operação deve substituir um atributo existente.
@end deffn

@node Gerenciamento de processo,Interface do agendador,Arquivos e diretórios,os — Diversas interfaces de sistema operacional
@anchor{library/os os-process}@anchor{2d93}@anchor{library/os process-management}@anchor{2d94}
@subsubsection Gerenciamento de processo


Estas funções podem ser usadas para criar e gerenciar processos.

As várias funções @ref{2d95,,exec*} recebem uma lista de argumentos para o novo programa carregado no processo. Em cada caso, o primeiro desses argumentos é passado para o novo programa como seu próprio nome, e não como um argumento que um usuário pode ter digitado em uma linha de comando. Para o programador C, este é o @code{argv[0]} passado para um programa @code{main()}. Por exemplo, @code{os.execv('/bin/echo', ['foo', 'bar'])} exibirá apenas @code{bar} na saída padrão; @code{foo} parecerá ser ignorado.

@geindex abort() (no módulo os)
@anchor{library/os os abort}@anchor{2d96}
@deffn {Função} os.abort ()

Gera um sinal @code{SIGABRT} para o processo atual. No Unix, o comportamento padrão é produzir um despejo de memória; no Windows, o processo retorna imediatamente um código de saída @code{3}. Esteja ciente de que chamar esta função não chamará o manipulador de sinal Python registrado para @code{SIGABRT} com @ref{1173,,signal.signal()}.
@end deffn

@geindex add_dll_directory() (no módulo os)
@anchor{library/os os add_dll_directory}@anchor{9f2}
@deffn {Função} os.add_dll_directory (path)

Adiciona um caminho ao caminho de pesquisa de DLL.

Este caminho de pesquisa é usado ao resolver dependências para módulos de extensão importados (o próprio módulo é resolvido por meio de @ref{3b4,,sys.path}), e também por @ref{2a,,ctypes}.

Remove o diretório chamando `close()' no objeto retornado ou usando-o em uma instrução @ref{5d2,,with}.

Consulte a documentação da Microsoft@footnote{https://msdn.microsoft.com/44228cf2-6306-466c-8f16-f513cd3ba8b5} para obter mais informações sobre como as DLLs são carregadas.

Levanta um @ref{19fa,,evento de auditoria} @code{os.add_dll_directory} com o argumento @code{path}.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.8: As versões anteriores do CPython resolveriam DLLs usando o comportamento padrão para o processo atual. Isso levou a inconsistências, como apenas às vezes pesquisar 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} ou o diretório de trabalho atual, e funções do sistema operacional como @code{AddDllDirectory} sem efeito.

No 3.8, as duas maneiras principais de carregar as DLLs agora substituem explicitamente o comportamento de todo o processo para garantir a consistência. Veja as @ref{aad,,notas de portabilidade} para informações sobre atualização de bibliotecas.

@end deffn

@geindex execl() (no módulo os)
@geindex execle() (no módulo os)
@geindex execlp() (no módulo os)
@geindex execlpe() (no módulo os)
@geindex execv() (no módulo os)
@geindex execve() (no módulo os)
@geindex execvp() (no módulo os)
@geindex execvpe() (no módulo os)
@anchor{library/os os execl}@anchor{2d95}
@deffn {Função} os.execl (path, arg0, arg1, ...)
@anchor{library/os os execle}@anchor{2d97}
@deffnx {Função} os.execle (path, arg0, arg1, ..., env)
@anchor{library/os os execlp}@anchor{2d98}
@deffnx {Função} os.execlp (file, arg0, arg1, ...)
@anchor{library/os os execlpe}@anchor{2d99}
@deffnx {Função} os.execlpe (file, arg0, arg1, ..., env)
@anchor{library/os os execv}@anchor{2cf9}
@deffnx {Função} os.execv (path, args)
@anchor{library/os os execve}@anchor{1138}
@deffnx {Função} os.execve (path, args, env)
@anchor{library/os os execvp}@anchor{2d9a}
@deffnx {Função} os.execvp (file, args)
@anchor{library/os os execvpe}@anchor{2d9b}
@deffnx {Função} os.execvpe (file, args, env)

Todas essas funções executam um novo programa, substituindo o processo atual; elas não retornam. No Unix, o novo executável é carregado no processo atual e terá a mesma identificação de processo do chamador. Os erros serão relatados como exceções de @ref{417,,OSError}.

O processo atual é substituído imediatamente. Objetos arquivo abertos e descritores não são descarregados, então se houver dados em buffer nesses arquivos abertos, você deve descarregá-los usando @code{sys.stdout.flush()} ou @ref{db6,,os.fsync()} antes de chamar uma função @ref{2d95,,exec*}.

As variantes “l” e “v” das funções @ref{2d95,,exec*} diferem em como os argumentos da linha de comando são passados. As variantes “l” são talvez as mais fáceis de trabalhar se o número de parâmetros for fixo quando o código for escrito; os parâmetros individuais simplesmente se tornam parâmetros adicionais para as funções @code{execl*()}. As variantes “v” são boas quando o número de parâmetros é variável, com os argumentos sendo passados em uma lista ou tupla como o parâmetro `args'. Em qualquer caso, os argumentos para o processo filho devem começar com o nome do comando que está sendo executado, mas isso não é obrigatório.

As variantes que incluem um “p” próximo ao final (@ref{2d98,,execlp()}, @ref{2d99,,execlpe()}, @ref{2d9a,,execvp()} e @ref{2d9b,,execvpe()}) usarão a variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para localizar o programa `file'. Quando o ambiente está sendo substituído (usando uma das variantes @ref{2d95,,exec*e}, discutidas no próximo parágrafo), o novo ambiente é usado como fonte da variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. As outras variantes, @ref{2d95,,execl()}, @ref{2d97,,execle()}, @ref{2cf9,,execv()} e @ref{1138,,execve()}, não usarão a variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para localizar o executável; `path' deve conter um caminho absoluto ou relativo apropriado. Caminhos relativos devem incluir pelo menos uma barra, mesmo no Windows, pois nomes simples não serão resolvidos.

Para @ref{2d97,,execle()}, @ref{2d99,,execlpe()}, @ref{1138,,execve()} e @ref{2d9b,,execvpe()} (observe que todos eles terminam em “e”), o parâmetro `env' deve ser um mapeamento que é usado para definir as variáveis de ambiente para o novo processo (elas são usadas no lugar do ambiente do processo atual); as funções @ref{2d95,,execl()}, @ref{2d98,,execlp()}, @ref{2cf9,,execv()} e @ref{2d9a,,execvp()} fazem com que o novo processo herde o ambiente do processo atual.

Para @ref{1138,,execve()} em algumas plataformas, `path' também pode ser especificado como um descritor de arquivo aberto. Esta funcionalidade pode não ser compatível com sua plataforma; você pode verificar se está ou não disponível usando @ref{113c,,os.supports_fd}. Se não estiver disponível, usá-lo vai levantar uma @ref{228,,NotImplementedError}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.exec} com os argumentos @code{path}, @code{args} e @code{env}.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not Android, not iOS.


Alterado na versão 3.3: Adicionado suporte para especificar `path' como um descritor de arquivo aberto para @ref{1138,,execve()}.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex _exit() (no módulo os)
@anchor{library/os os _exit}@anchor{242f}
@deffn {Função} os._exit (n)

Sai do processo com status `n', sem chamar manipuladores de limpeza, liberando buffers de entrada e saída padrões etc.

@cartouche
@quotation Nota 
A forma padrão de sair é @ref{138e,,sys.exit(n)}. @code{_exit()} normalmente só deve ser usado no processo filho após uma função @ref{197,,fork()}.
@end quotation
@end cartouche
@end deffn

Os seguintes códigos de saída são definidos e podem ser usados com @ref{242f,,_exit()}, embora não sejam obrigatórios. Eles são normalmente usados para programas de sistema escritos em Python, como um programa de entrega de comando externo de servidor de e-mail.

@cartouche
@quotation Nota 
Alguns deles podem não estar disponíveis em todas as plataformas Unix, pois há algumas variações. Essas constantes estão definidas onde elas são definidas pela plataforma subjacente.
@end quotation
@end cartouche

@geindex EX_OK (no módulo os)
@anchor{library/os os EX_OK}@anchor{2d9c}
@deffn {Dado} os.EX_OK

Código de saída que significa que não ocorreu nenhum erro. Pode ser obtido do valor definido de @code{EXIT_SUCCESS} em algumas plataformas. Geralmente tem um valor de zero.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex EX_USAGE (no módulo os)
@anchor{library/os os EX_USAGE}@anchor{2d9d}
@deffn {Dado} os.EX_USAGE

Código de saída que significa que o comando foi usado incorretamente, como quando o número errado de argumentos é fornecido.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_DATAERR (no módulo os)
@anchor{library/os os EX_DATAERR}@anchor{2d9e}
@deffn {Dado} os.EX_DATAERR

Código de saída que significa que os dados inseridos estavam incorretos.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_NOINPUT (no módulo os)
@anchor{library/os os EX_NOINPUT}@anchor{2d9f}
@deffn {Dado} os.EX_NOINPUT

Código de saída que significa que um arquivo de entrada não existe ou não pôde ser lido.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_NOUSER (no módulo os)
@anchor{library/os os EX_NOUSER}@anchor{2da0}
@deffn {Dado} os.EX_NOUSER

Código de saída que significa que um usuário especificado não existe.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_NOHOST (no módulo os)
@anchor{library/os os EX_NOHOST}@anchor{2da1}
@deffn {Dado} os.EX_NOHOST

Código de saída que significa que um host especificado não existe.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_UNAVAILABLE (no módulo os)
@anchor{library/os os EX_UNAVAILABLE}@anchor{2da2}
@deffn {Dado} os.EX_UNAVAILABLE

Código de saída que significa que um serviço necessário está indisponível.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_SOFTWARE (no módulo os)
@anchor{library/os os EX_SOFTWARE}@anchor{2da3}
@deffn {Dado} os.EX_SOFTWARE

Código de saída que significa que um erro interno do software foi detectado.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_OSERR (no módulo os)
@anchor{library/os os EX_OSERR}@anchor{2da4}
@deffn {Dado} os.EX_OSERR

Código de saída que significa que um erro do sistema operacional foi detectado, como a incapacidade de criar um fork ou um encadeamento.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_OSFILE (no módulo os)
@anchor{library/os os EX_OSFILE}@anchor{2da5}
@deffn {Dado} os.EX_OSFILE

Código de saída que significa que algum arquivo do sistema não existia, não pôde ser aberto ou teve algum outro tipo de erro.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_CANTCREAT (no módulo os)
@anchor{library/os os EX_CANTCREAT}@anchor{2da6}
@deffn {Dado} os.EX_CANTCREAT

Código de saída que significa que um arquivo de saída especificado pelo usuário não pôde ser criado.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_IOERR (no módulo os)
@anchor{library/os os EX_IOERR}@anchor{2da7}
@deffn {Dado} os.EX_IOERR

Código de saída que significa que ocorreu um erro ao fazer E/S em algum arquivo.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_TEMPFAIL (no módulo os)
@anchor{library/os os EX_TEMPFAIL}@anchor{2da8}
@deffn {Dado} os.EX_TEMPFAIL

Código de saída que significa que ocorreu uma falha temporária. Isso indica algo que pode não ser realmente um erro, como uma conexão de rede que não pôde ser feita durante uma operação de nova tentativa.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_PROTOCOL (no módulo os)
@anchor{library/os os EX_PROTOCOL}@anchor{2da9}
@deffn {Dado} os.EX_PROTOCOL

Código de saída que significa que uma troca de protocolo foi ilegal, inválida ou não compreendida.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_NOPERM (no módulo os)
@anchor{library/os os EX_NOPERM}@anchor{2daa}
@deffn {Dado} os.EX_NOPERM

Código de saída que significa que não havia permissões suficientes para executar a operação (mas sem intenção de causar problemas do sistema de arquivos).

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_CONFIG (no módulo os)
@anchor{library/os os EX_CONFIG}@anchor{2dab}
@deffn {Dado} os.EX_CONFIG

Código de saída que significa que ocorreu algum tipo de erro de configuração.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex EX_NOTFOUND (no módulo os)
@anchor{library/os os EX_NOTFOUND}@anchor{2dac}
@deffn {Dado} os.EX_NOTFOUND

Código de saída que significa algo como “uma entrada não foi encontrada”.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex fork() (no módulo os)
@anchor{library/os os fork}@anchor{197}
@deffn {Função} os.fork ()

Cria um processo filho. Retorna @code{0} no filho e o ID de processo do filho no pai. Se ocorrer um erro, uma exceção @ref{417,,OSError} é levantada.

Note que algumas plataformas incluindo FreeBSD <= 6.3 e Cygwin têm problemas conhecidos ao usar @code{fork()} a partir de um thread.

Levanta um @ref{19fa,,evento de auditoria} @code{os.fork} sem argumentos.

@cartouche
@quotation Aviso 
Se você usa soquetes TLS em um aplicação chamando @code{fork()}, consulte alerta na documentação do módulo @ref{d0,,ssl}.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
No macOS, o uso desta função é inseguro quando combinado com o uso de APIs de sistema de nível mais alto, e isso inclui o uso de @ref{10b,,urllib.request}.
@end quotation
@end cartouche


Alterado na versão 3.8: Chamar @code{fork()} em um subinterpretador não é mais possível (@ref{195,,RuntimeError} é levantada).



Alterado na versão 3.12: Se o Python for capaz de detectar que o seu processar tem várias threads, o @ref{197,,os.fork()} agora levanta uma exceção @ref{1a5,,DeprecationWarning}.

Optamos por apresentar isso como um alerta, quando detectável, para informar melhor aos desenvolvedores sobre um problema de design que a plataforma POSIX indica especificamente como sem suporte. Mesmo em códigos que `aparentem' funcionar, nunca foi seguro misturar threading com @ref{197,,os.fork()} em plataformas POSIX. O próprio ambiente de execução do CPython sempre fez chamadas à API que não são seguras para uso no processo filho quando existiam threads no pai (como @code{malloc} e @code{free}).

Os usuários do macOS ou usuários de implementações de libc ou malloc diferentes daquelas normalmente encontradas no glibc até o momento estão entre os que já têm maior probabilidade de sofrer com impasses (`deadlocks') ao executar esse código.

Consulte esta discussão sobre fork ser incompatível com threads@footnote{https://discuss.python.org/t/33555} para obter detalhes técnicos sobre o motivo pelo qual estamos revelando aos desenvolvedores esse problema de longa data de compatibilidade da plataforma.


@ref{1ed8,,Disponibilidade}: POSIX, not WASI, not Android, not iOS.
@end deffn

@geindex forkpty() (no módulo os)
@anchor{library/os os forkpty}@anchor{198}
@deffn {Função} os.forkpty ()

Cria um processo filho, usando um novo pseudoterminal como o terminal de controle do filho. Retorna um par de @code{(pid, fd)}, onde `pid' é @code{0} no filho, o novo ID de processo do filho no pai e `fd' é o descritor de arquivo do lado mestre do pseudoterminal. Para uma abordagem mais portátil, use o módulo @ref{b1,,pty}. Se ocorrer um erro, @ref{417,,OSError} é levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{os.forkpty} sem argumentos.

@cartouche
@quotation Aviso 
No macOS, o uso desta função é inseguro quando combinado com o uso de APIs de sistema de nível mais alto, e isso inclui o uso de @ref{10b,,urllib.request}.
@end quotation
@end cartouche


Alterado na versão 3.8: Chamar @code{forkpty()} em um subinterpretador não é mais permitido (@ref{195,,RuntimeError} é levantada).



Alterado na versão 3.12: Se o Python for capaz de detectar que o seu processo tem vários threads, isso agora levanta uma exceção @ref{1a5,,DeprecationWarning}. Veja a explicação mais longa em @ref{197,,os.fork()}.


@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex kill() (no módulo os)
@anchor{library/os os kill}@anchor{13ae}
@deffn {Função} os.kill (pid, sig, /)

@geindex processo;interrupção
@geindex processo;sinalização

Envia o sinal `sig' para o processo `pid'. Constantes dos sinais específicos disponíveis na plataforma host são definidas no módulo @ref{c6,,signal}.

Windows: os sinais @ref{13af,,signal.CTRL_C_EVENT} e @ref{13b0,,signal.CTRL_BREAK_EVENT} são sinais especiais que só podem ser enviados para processos de console que compartilham uma janela de console comum, por exemplo, alguns subprocessos. Qualquer outro valor para `sig' fará com que o processo seja encerrado incondicionalmente pela API TerminateProcess e o código de saída será definido como `sig'.

Veja também @ref{1170,,signal.pthread_kill()}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.kill} com os argumentos @code{pid} e @code{sig}.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not iOS.


Alterado na versão 3.2: Adicionado suporte ao Windows.

@end deffn

@geindex killpg() (no módulo os)
@anchor{library/os os killpg}@anchor{1b4d}
@deffn {Função} os.killpg (pgid, sig, /)

@geindex processo;interrupção
@geindex processo;sinalização

Envia o sinal `sig' para o grupo de processos `pgid'.

Levanta um @ref{19fa,,evento de auditoria} @code{os.killpg} com os argumentos @code{pgid} e @code{sig}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not iOS.
@end deffn

@geindex nice() (no módulo os)
@anchor{library/os os nice}@anchor{1140}
@deffn {Função} os.nice (increment, /)

Adiciona `increment' ao nível de “nice” do processo. Retorna um novo nível de “nice”.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.
@end deffn

@geindex pidfd_open() (no módulo os)
@anchor{library/os os pidfd_open}@anchor{47a}
@deffn {Função} os.pidfd_open (pid, flags=0)

Retorna um descritor de arquivo referente ao processo `pid' com as `flags' definidas. Este descritor pode ser usado para gerenciar o processo sem corridas e sinais.

Veja a página man @code{pidfd_open(2)@footnote{https://manpages.debian.org/pidfd_open(2)}} para mais detalhes.

@ref{1ed8,,Disponibilidade}: Linux >= 5.3, Android >= @ref{ba2,,build-time} API level 31


Adicionado na versão 3.9.


@geindex PIDFD_NONBLOCK (no módulo os)
@anchor{library/os os PIDFD_NONBLOCK}@anchor{49a}
@deffn {Dado} os.PIDFD_NONBLOCK

Este sinalizador indica que o descritor de arquivo será não-bloqueante. Se o processo referenciado pelo descritor de arquivo ainda não tiver terminado, então uma tentativa de aguardar no descritor de arquivo usando @code{waitid(2)@footnote{https://manpages.debian.org/waitid(2)}} retornará imediatamente o erro @ref{2435,,EAGAIN} em vez de bloquear.
@end deffn

@ref{1ed8,,Disponibilidade}: Linux >= 5.10


Adicionado na versão 3.12.

@end deffn

@geindex plock() (no módulo os)
@anchor{library/os os plock}@anchor{2dad}
@deffn {Função} os.plock (op, /)

Trava os segmentos do programa na memória. O valor de `op' (definido em @code{<sys/lock.h>}) determina quais segmentos são travados.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not iOS.
@end deffn

@geindex popen() (no módulo os)
@anchor{library/os os popen}@anchor{a91}
@deffn {Função} os.popen (cmd, mode='r', buffering=-1)

Abre um encadeamento, também conhecido como “pipe”, de ou para o comando `cmd'. O valor de retorno é um objeto arquivo aberto conectado ao encadeamento, que pode ser lido ou escrito dependendo se `mode' é @code{'r'} (padrão) ou @code{'w'}. O argumento `buffering' tem o mesmo significado que o argumento correspondente para a função embutida @ref{51c,,open()}. O objeto arquivo retornado lê ou escreve strings de texto em vez de bytes.

O método @code{close} retorna @ref{675,,None} se o subprocesso foi encerrado com sucesso, ou o código de retorno do subprocesso se houve um erro. Em sistemas POSIX, se o código de retorno for positivo, ele representa o valor de retorno do processo deslocado para a esquerda em um byte. Se o código de retorno for negativo, o processo foi encerrado pelo sinal dado pelo valor negado do código de retorno. (Por exemplo, o valor de retorno pode ser @code{- signal.SIGKILL} se o subprocesso foi eliminado.) Em sistemas Windows, o valor de retorno contém o código de retorno inteiro com sinal do processo filho.

No Unix, @ref{923,,waitstatus_to_exitcode()} pode ser usado para converter o resultado do método @code{close} (status de saída) em um código de saída se não for @code{None}. No Windows, o resultado do método @code{close} é diretamente o código de saída (ou @code{None}).

Isso é implementado usando @ref{199,,subprocess.Popen}; consulte a documentação desta classe para maneiras mais poderosas de gerenciar e se comunicar com subprocessos.

@ref{1ed8,,Disponibilidade}: not WASI, not Android, not iOS.

@cartouche
@quotation Nota 
O @ref{656,,Modo UTF-8 do Python} afeta as codificações usadas para `cmd' e conteúdo de encadeamento.

@ref{a91,,popen()} é um wrapper simples em torno de @ref{199,,subprocess.Popen}. Use @ref{199,,subprocess.Popen} ou @ref{b9e,,subprocess.run()} para controlar opções como codificações.
@end quotation
@end cartouche
@end deffn

@geindex posix_spawn() (no módulo os)
@anchor{library/os os posix_spawn}@anchor{220}
@deffn {Função} os.posix_spawn (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

Envolve a API da biblioteca C @code{posix_spawn()} para uso em Python.

A maioria dos usuários deveria usar @ref{b9e,,subprocess.run()} em vez de @ref{220,,posix_spawn()}.

Os argumentos somente-posicional `path', `args', e `env' são similares a @ref{1138,,execve()}. `env' pode ser @code{None}, caso em que o ambiente do processo atual é usado.

O parâmetro `path' é o caminho para o arquivo executável. O `path' deve conter um diretório. Use @ref{1ba7,,posix_spawnp()} para passar um arquivo executável sem diretório.

O argumento `file_actions' pode ser uma sequência de tuplas descrevendo ações a serem tomadas em descritores de arquivo específicos no processo filho entre as etapas @code{fork()} e @code{exec()} de implementação da biblioteca C. O primeiro item em cada tupla deve ser um dos três indicadores de tipo listados abaixo, descrevendo os elementos restantes da tupla:

@geindex POSIX_SPAWN_OPEN (no módulo os)
@anchor{library/os os POSIX_SPAWN_OPEN}@anchor{2dae}
@deffn {Dado} os.POSIX_SPAWN_OPEN

(@code{os.POSIX_SPAWN_OPEN}, `fd', `path', `flags', `mode')

Efetua @code{os.dup2(os.open(path, flags, mode), fd)}.
@end deffn

@geindex POSIX_SPAWN_CLOSE (no módulo os)
@anchor{library/os os POSIX_SPAWN_CLOSE}@anchor{2daf}
@deffn {Dado} os.POSIX_SPAWN_CLOSE

(@code{os.POSIX_SPAWN_CLOSE}, `fd')

Efetua @code{os.close(fd)}.
@end deffn

@geindex POSIX_SPAWN_DUP2 (no módulo os)
@anchor{library/os os POSIX_SPAWN_DUP2}@anchor{2db0}
@deffn {Dado} os.POSIX_SPAWN_DUP2

(@code{os.POSIX_SPAWN_DUP2}, `fd', `new_fd')

Efetua @code{os.dup2(fd, new_fd)}.
@end deffn

@geindex POSIX_SPAWN_CLOSEFROM (no módulo os)
@anchor{library/os os POSIX_SPAWN_CLOSEFROM}@anchor{221}
@deffn {Dado} os.POSIX_SPAWN_CLOSEFROM

(@code{os.POSIX_SPAWN_CLOSEFROM}, `fd')

Efetua @code{os.closerange(fd, INF)}.
@end deffn

Estas tuplas correspondem a chamadas de API da biblioteca C de @code{posix_spawn_file_actions_addopen()}, @code{posix_spawn_file_actions_addclose()}, @code{posix_spawn_file_actions_adddup2()} e @code{posix_spawn_file_actions_addclosefrom_np()} usadas para preparar para a chamada de @code{posix_spawn()} em si.

O argumento `setpgroup' definirá o grupo de processos do filho para o valor especificado. Se o valor especificado for 0, o ID do grupo de processo filho será igual ao ID do processo. Se o valor de `setpgroup' não for definido, o filho herdará o ID do grupo de processos do pai. Este argumento corresponde ao sinalizador @code{POSIX_SPAWN_SETPGROUP} da biblioteca C.

Se o argumento `resetids' for @code{True}, ele irá reconfigurar o UID e GID efetivos do filho para o UID e GID reais do processo pai. Se o argumento for @code{False}, então o filho retém o UID e GID efetivos do pai. Em ambos os casos, se os bits de permissão set-user-ID e set-group-ID estiverem habilitados no arquivo executável, seu efeito vai substituir a configuração do UID e GID efetivos. Este argumento corresponde ao sinalizador @code{POSIX_SPAWN_RESETIDS} da biblioteca C.

Se o argumento `setsid' for @code{True}, ele criará um novo ID de sessão para @code{posix_spawn}. `setsid' requer @code{POSIX_SPAWN_SETSID} ou @code{POSIX_SPAWN_SETSID_NP}. Caso contrário, @ref{228,,NotImplementedError} é levantada.

O argumento `setsigmask' definirá a máscara de sinal para o conjunto de sinais especificado. Se o parâmetro não for usado, o filho herda a máscara de sinal do pai. Este argumento corresponde ao sinalizador @code{POSIX_SPAWN_SETSIGMASK} da biblioteca C.

O argumento `sigdef' redefinirá a disposição de todos os sinais no conjunto especificado. Este argumento corresponde ao sinalizador @code{POSIX_SPAWN_SETSIGDEF} da biblioteca C.

O argumento `scheduler' deve ser uma tupla contendo a política do agendador (opcional) e uma instância de @ref{168a,,sched_param} com os parâmetros do agendador. Um valor @code{None} no lugar da política do agendador indica que a política não está sendo fornecido. Este argumento é uma combinação dos sinalizadores @code{POSIX_SPAWN_SETSCHEDPARAM} e @code{POSIX_SPAWN_SETSCHEDULER} da biblioteca C.

Levanta um @ref{19fa,,evento de auditoria} @code{os.posix_spawn} com os argumentos @code{path}, @code{argv} e @code{env}.


Adicionado na versão 3.8.



Alterado na versão 3.13: o parâmetro `env' pode ser @code{None}. @code{os.POSIX_SPAWN_CLOSEFROM} está disponível nas plataformas onde @code{posix_spawn_file_actions_addclosefrom_np()} existe.


@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex posix_spawnp() (no módulo os)
@anchor{library/os os posix_spawnp}@anchor{1ba7}
@deffn {Função} os.posix_spawnp (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

Envolve a API da biblioteca C @code{posix_spawnp()} para uso em Python.

Semelhante a @ref{220,,posix_spawn()} exceto que o sistema procura o arquivo `executable' na lista de diretórios especificados pela variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} (da mesma forma que para @code{execvp(3)}).

Levanta um @ref{19fa,,evento de auditoria} @code{os.posix_spawn} com os argumentos @code{path}, @code{argv} e @code{env}.


Adicionado na versão 3.8.


@ref{1ed8,,Disponibilidade}: POSIX, not WASI, not Android, not iOS.

Veja a documentação de @ref{220,,posix_spawn()}.
@end deffn

@geindex register_at_fork() (no módulo os)
@anchor{library/os os register_at_fork}@anchor{300}
@deffn {Função} os.register_at_fork (*, before=None, after_in_parent=None, after_in_child=None)

Registra chamáveis a serem executados quando um novo processo filho é criado usando @ref{197,,os.fork()} ou APIs de clonagem de processos semelhantes. Os parâmetros são opcionais e somente-nomeados. Cada um especifica um ponto de chamada diferente.


@itemize *

@item 
`before' é uma função chamada antes de criar um processo filho.

@item 
`after_in_parent' é uma função chamada a partir do processo pai após criar um processo filho.

@item 
`after_in_child' é uma função chamada a partir do processo filho.
@end itemize

Essas chamadas são feitas apenas se o controle deve retornar ao interpretador Python. Um lançamento típico de @ref{d6,,subprocess} não irá acioná-los, pois o filho não entrará novamente no interpretador.

As funções registradas para execução antes de criar um processo filho são chamadas na ordem de registro reversa. As funções registradas para execução após o processo filho ser criado (no pai ou no filho) são chamadas na ordem de registro.

Note que chamadas a @code{fork()} feitas por código C de terceiros podem não chamar estas funções, a menos que ele explicitamente chamem @ref{bd8,,PyOS_BeforeFork()}, @ref{bd9,,PyOS_AfterFork_Parent()} e @ref{3fb,,PyOS_AfterFork_Child()}.

Não há uma forma de desfazer o registro de uma função.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


Adicionado na versão 3.7.

@end deffn

@geindex spawnl() (no módulo os)
@geindex spawnle() (no módulo os)
@geindex spawnlp() (no módulo os)
@geindex spawnlpe() (no módulo os)
@geindex spawnv() (no módulo os)
@geindex spawnve() (no módulo os)
@geindex spawnvp() (no módulo os)
@geindex spawnvpe() (no módulo os)
@anchor{library/os os spawnl}@anchor{1826}
@deffn {Função} os.spawnl (mode, path, ...)
@anchor{library/os os spawnle}@anchor{2db1}
@deffnx {Função} os.spawnle (mode, path, ..., env)
@anchor{library/os os spawnlp}@anchor{2db2}
@deffnx {Função} os.spawnlp (mode, file, ...)
@anchor{library/os os spawnlpe}@anchor{2db3}
@deffnx {Função} os.spawnlpe (mode, file, ..., env)
@anchor{library/os os spawnv}@anchor{2db4}
@deffnx {Função} os.spawnv (mode, path, args)
@anchor{library/os os spawnve}@anchor{2db5}
@deffnx {Função} os.spawnve (mode, path, args, env)
@anchor{library/os os spawnvp}@anchor{2db6}
@deffnx {Função} os.spawnvp (mode, file, args)
@anchor{library/os os spawnvpe}@anchor{2db7}
@deffnx {Função} os.spawnvpe (mode, file, args, env)

Executa o programa `path' em um novo processo.

(Observe que o módulo @ref{d6,,subprocess} fornece recursos mais poderosos para gerar novos processos e recuperar seus resultados; usar esse módulo é preferível a usar essas funções. Verifique especialmente a seção @ref{11c7,,Replacing Older Functions with the subprocess Module}.)

Se `mode' for @ref{2db8,,P_NOWAIT}, esta função retorna o id do processo do novo processo; se `mode' for @ref{2db9,,P_WAIT}, retorna o código de saída do processo se ele sair normalmente, ou @code{-signal}, onde `signal' é o sinal que matou o processo. No Windows, o id do processo será na verdade o manipulador do processo, portanto, pode ser usado com a função @ref{dc2,,waitpid()}.

Nota sobre VxWorks: esta função não retorna @code{-signal} se o novo processo é interrompido. Em vez disso, ele levanta a exceção OSError.

As variantes “l” e “v” das funções @ref{1826,,spawn*} diferem em como os argumentos de linha de comando são passados. As variantes “l” são talvez as mais fáceis de trabalhar se o número de parâmetros for fixo quando o código for escrito; os parâmetros individuais simplesmente se tornam parâmetros adicionais para as funções @code{spawnl*()}. As variantes “v” são boas quando o número de parâmetros é variável, com os argumentos sendo passados em uma lista ou tupla como o parâmetro `args'. Em ambos os casos, os argumentos para o processo filho devem começar com o nome do comando que está sendo executado.

As variantes que incluem um segundo “p” próximo ao final (@ref{2db2,,spawnlp()}, @ref{2db3,,spawnlpe()}, @ref{2db6,,spawnvp()} e @ref{2db7,,spawnvpe()}) usarão a variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para localizar o programa `file'. Quando o ambiente está sendo substituído (usando uma das variantes @ref{1826,,spawn*e}, discutidas no próximo parágrafo), o novo ambiente é usado como fonte da variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. As outras variantes, @ref{1826,,spawnl()}, @ref{2db1,,spawnle()}, @ref{2db4,,spawnv()} e @ref{2db5,,spawnve()}, não usarão a variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para localizar o executável; `path' deve conter um caminho absoluto ou relativo apropriado.

Para @ref{2db1,,spawnle()}, @ref{2db3,,spawnlpe()}, @ref{2db5,,spawnve()} e @ref{2db7,,spawnvpe()} (observe que todos eles terminam em “e”), o parâmetro `env' deve ser um mapeamento que é usado para definir as variáveis de ambiente para o novo processo (elas são usadas no lugar do ambiente do processo atual); as funções @ref{1826,,spawnl()}, @ref{2db2,,spawnlp()}, @ref{2db4,,spawnv()} e @ref{2db6,,spawnvp()} fazem com que o novo processo herde o ambiente do processo atual. Note que as chaves e os valores no dicionário `env' devem ser strings; chaves ou valores inválidos farão com que a função falhe, com um valor de retorno de @code{127}.

Como exemplo, as seguintes chamadas a @ref{2db2,,spawnlp()} e @ref{2db7,,spawnvpe()} são 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

Levanta um @ref{19fa,,evento de auditoria} @code{os.spawn} com os argumentos @code{mode}, @code{path}, @code{args} e @code{env}.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not Android, not iOS.

@ref{2db2,,spawnlp()}, @ref{2db3,,spawnlpe()}, @ref{2db6,,spawnvp()} e @ref{2db7,,spawnvpe()} não estão disponíveis no Windows. @ref{2db1,,spawnle()} e @ref{2db5,,spawnve()} não são seguros para thread no Windows; recomendamos que você use o módulo @ref{d6,,subprocess}.


Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex P_NOWAIT (no módulo os)
@geindex P_NOWAITO (no módulo os)
@anchor{library/os os P_NOWAIT}@anchor{2db8}
@deffn {Dado} os.P_NOWAIT
@anchor{library/os os P_NOWAITO}@anchor{2dba}
@deffnx {Dado} os.P_NOWAITO

Valores possíveis para o parâmetro `mode' para a família de funções @ref{1826,,spawn*}. Se qualquer um desses valores for fornecido, as funções @ref{1826,,spawn*} retornarão assim que o novo processo for criado, com o id do processo como o valor de retorno.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex P_WAIT (no módulo os)
@anchor{library/os os P_WAIT}@anchor{2db9}
@deffn {Dado} os.P_WAIT

Valor possível para o parâmetro `mode' para a família de funções @ref{1826,,spawn*}. Se for fornecido como `mode', as funções @ref{1826,,spawn*} não retornarão até que o novo processo seja executado até a conclusão e retornará o código de saída do processo em que a execução foi bem-sucedida, ou @code{-signal} se um sinal interromper o processo.

@ref{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex P_DETACH (no módulo os)
@geindex P_OVERLAY (no módulo os)
@anchor{library/os os P_DETACH}@anchor{2dbb}
@deffn {Dado} os.P_DETACH
@anchor{library/os os P_OVERLAY}@anchor{2dbc}
@deffnx {Dado} os.P_OVERLAY

Valores possíveis para o parâmetro `mode' para a família de funções @ref{1826,,spawn*}. Eles são menos portáveis do que os listados acima. @ref{2dbb,,P_DETACH} é semelhante a @ref{2db8,,P_NOWAIT}, mas o novo processo é separado do console do processo de chamada. Se @ref{2dbc,,P_OVERLAY} for usado, o processo atual será substituído; a função @ref{1826,,spawn*} não retornará.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex startfile() (no módulo os)
@anchor{library/os os startfile}@anchor{1a0f}
@deffn {Função} os.startfile (path[, operation][, arguments][, cwd][, show_cmd])

Inicia um arquivo com sua aplicação associada.

Quando `operation' não é especificado, isso atua como um clique duplo no arquivo no Windows Explorer, ou como fornecer o nome do arquivo como um argumento para o comando @code{start} do console interativo de comandos: o arquivo é aberto com qualquer aplicação (se houver) com a extensão associada.

Quando outra `operation' é fornecida, ela deve ser um “verbo de comando” que especifica o que deve ser feito com o arquivo. Verbos comuns documentados pela Microsoft são @code{'open'}, @code{'print'} e @code{'edit'} (para serem usados em arquivos), bem como @code{'explore'} e @code{'find'} (para serem usados em diretórios).

Ao iniciar uma aplicação, especifique `arguments' a serem passados como uma única string. Este argumento pode não ter efeito quando esta função é usada para iniciar um documento.

O diretório de trabalho padrão é herdado, mas pode ser substituído pelo argumento `cwd'. Este deve ser um caminho absoluto. Um `path' relativo será resolvido levando em consideração este argumento.

Use `show_cmd' para substituir o estilo de janela padrão. Se isso terá algum efeito irá depender da aplicação sendo iniciada. Os valores são inteiros conforme implementado pela função Win32 @code{ShellExecute()}.

@ref{1a0f,,startfile()} retorna assim que a aplicação associada é iniciada. Não há opção de aguardar o fechamento da aplicação, e nenhuma maneira de recuperar o status de saída da aplicação. O parâmetro `path' é relativo ao diretório atual ou ao `cwd'. Se você quiser usar um caminho absoluto, certifique-se que o primeiro caractere não seja uma barra (@code{'/'}). Use @ref{a4,,pathlib} ou a função @ref{135e,,os.path.normpath()} para garantir que os caminhos sejam codificados corretamente para Win32.

Para reduzir a sobrecarga de inicialização do interpretador, a função Win32 @code{ShellExecute()} não é resolvida até que esta função seja chamada pela primeira vez. Se a função não puder ser resolvida, uma exceção @ref{228,,NotImplementedError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{os.startfile} com os argumentos @code{path} e @code{operation}.

Levanta um @ref{19fa,,evento de auditoria} @code{os.startfile/2} com os argumentos @code{path}, @code{operation}, @code{arguments}, @code{cwd} e @code{show_cmd}.

@ref{1ed8,,Disponibilidade}: Windows.


Alterado na versão 3.10: Adicionados os argumentos `arguments', `cwd' e `show_cmd', e o evento de auditoria @code{os.startfile/2}.

@end deffn

@geindex system() (no módulo os)
@anchor{library/os os system}@anchor{14a5}
@deffn {Função} os.system (command)

Executa o comando (uma string) em um subshell. Isso é implementado chamando a função C padrão @code{system()}, e tem as mesmas limitações. Alterações em @ref{53d,,sys.stdin} etc. não são refletidas no ambiente do comando executado. Se `command' gerar qualquer saída, ela será enviada ao fluxo de saída padrão do interpretador. O padrão C não especifica o significado do valor de retorno da função C, então o valor de retorno da função Python depende do sistema.

No Unix, o valor de retorno é o status de saída do processo codificado no formato especificado para @ref{dc0,,wait()}.

No Windows, o valor de retorno é aquele retornado pelo shell do sistema após a execução de `command'. O shell é fornecido pela variável de ambiente Windows 
@geindex COMSPEC
@geindex variável de ambiente; COMSPEC
@code{COMSPEC}: normalmente é @code{cmd.exe}, que retorna o status de saída da execução do comando; em sistemas que usam um shell não nativo, consulte a documentação do shell.

O módulo @ref{d6,,subprocess} fornece recursos mais poderosos para gerar novos processos e recuperar seus resultados; usar esse módulo é preferível a usar esta função. Veja a seção @ref{11c7,,Replacing Older Functions with the subprocess Module} na documentação do @ref{d6,,subprocess} para algumas receitas úteis.

No Unix, @ref{923,,waitstatus_to_exitcode()} pode ser usada para converter o resultado (status de saída) em um código de saída. No Windows, o resultado é diretamente o código de saída.

Levanta um @ref{19fa,,evento de auditoria} @code{os.system} com o argumento @code{command}.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not Android, not iOS.
@end deffn

@geindex times() (no módulo os)
@anchor{library/os os times}@anchor{1154}
@deffn {Função} os.times ()

Retorna os tempos do processo global atual. O valor de retorno é um objeto com cinco atributos:


@itemize *

@item 
@code{user} - tempo do usuário

@item 
@code{system} - tempo do sistema

@item 
@code{children_user} - tempo do usuário de todos os processos filhos

@item 
@code{children_system} - tempo do sistema de todos os processos filhos

@item 
@code{elapsed} - tempo real decorrido desde um ponto fixo no passado
@end itemize

Para compatibilidade com versões anteriores, esse objeto também se comporta como uma tupla de 5 elementos contendo @code{user}, @code{system}, @code{children_user}, @code{children_system} e @code{elapsed} nessa ordem.

Consulte as páginas de manual @code{times(2)@footnote{https://manpages.debian.org/times(2)}} e times(3)@footnote{https://man.freebsd.org/cgi/man.cgi?time(3)} no Unix ou o GetProcessTimes MSDN@footnote{https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes} no Windows. No Windows, apenas @code{user} e @code{system} são conhecidos; os outros atributos são zero.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.3: Tipo de retorno foi alterado de uma tupla para um objeto tupla ou similar com atributos nomeados.

@end deffn

@geindex wait() (no módulo os)
@anchor{library/os os wait}@anchor{dc0}
@deffn {Função} os.wait ()

Aguarda a conclusão de um processo filho e retorna uma tupla contendo seu pid e indicação de status de saída: um número de 16 bits, cujo byte baixo é o número do sinal que interrompeu o processo e cujo byte alto é o status de saída (se o número do sinal é zero); o bit alto do byte baixo é definido se um arquivo principal foi produzido.

Se não houver filhos que possam ser aguardados, uma exceção @ref{1091,,ChildProcessError} é levantada.

@ref{923,,waitstatus_to_exitcode()} pode ser usado para converter o status de saída em um código de saída.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


@subsubheading Ver também


As outras funções @code{wait*()} documentadas abaixo podem ser usadas para aguardar a conclusão de um processo filho específico e ter mais opções. @ref{dc2,,waitpid()} é o único também disponível no Windows.

@end deffn

@geindex waitid() (no módulo os)
@anchor{library/os os waitid}@anchor{dc1}
@deffn {Função} os.waitid (idtype, id, options, /)

Aguarda a conclusão de um processo filho.

`idtype' pode ser @ref{2dbd,,P_PID}, @ref{2dbe,,P_PGID}, @ref{2dbf,,P_ALL} ou (no Linux) @ref{920,,P_PIDFD}. A interpretação de `id' depende disso; veja suas descrições individuais.

`options' é uma combinação OU de sinalizadores. Pelo menos um entre @ref{2dc0,,WEXITED}, @ref{2dc1,,WSTOPPED} ou @ref{2dc2,,WCONTINUED} é obrigatório; @ref{2dc3,,WNOHANG} e @ref{2dc4,,WNOWAIT} são sinalizadores opcionais adicionais.

O valor de retorno é um objeto que representa os dados contidos na estrutura @code{siginfo_t} com os seguintes atributos:


@itemize *

@item 
@code{si_pid} (ID do processo)

@item 
@code{si_uid} (ID de usuário real do filho)

@item 
@code{si_signo} (sempre @ref{2dc5,,SIGCHLD})

@item 
@code{si_status} (o status de saída ou número do sinal, dependendo de @code{si_code})

@item 
@code{si_code} (veja @ref{2dc6,,CLD_EXITED} para possíveis valores)
@end itemize

Se @ref{2dc3,,WNOHANG} for especificado e não houver filhos correspondentes no estado solicitado, @code{None} será retornado. Caso contrário, se não houver filhos correspondentes que possam ser esperados, @ref{1091,,ChildProcessError} será levantada.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


Adicionado na versão 3.3.



Alterado na versão 3.13: Esta função agora também está disponível no MacOS.

@end deffn

@geindex waitpid() (no módulo os)
@anchor{library/os os waitpid}@anchor{dc2}
@deffn {Função} os.waitpid (pid, options, /)

Os detalhes desta função diferem no Unix e no Windows.

No Unix: aguarda a conclusão de um processo filho dado pelo id de processo `pid' e retorna uma tupla contendo seu id de processo e indicação de status de saída (codificado como para @ref{dc0,,wait()}). A semântica da chamada é afetada pelo valor do inteiro `options', que deve ser @code{0} para operação normal.

Se `pid'  for maior que @code{0}, @ref{dc2,,waitpid()} solicita informações de status para aquele processo específico. Se `pid' for @code{0}, a solicitação é para o status de qualquer filho no grupo de processos do processo atual. Se `pid' for @code{-1}, a solicitação pertence a qualquer filho do processo atual. Se `pid' for menor que @code{-1}, o status é solicitado para qualquer processo no grupo de processos @code{-pid} (o valor absoluto de `pid').

`options' é uma combinação OU de sinalizadores. Se contiver @ref{2dc3,,WNOHANG} e não houver filhos correspondentes no estado solicitado, @code{(0, 0)} será retornado. Caso contrário, se não houver filhos correspondentes que possam ser esperados, @ref{1091,,ChildProcessError} será levantada. Outras opções que podem ser usadas são @ref{2dc7,,WUNTRACED} e @ref{2dc2,,WCONTINUED}.

No Windows: aguarda a conclusão de um processo fornecido pelo identificador de processo `pid' e retorna uma tupla contendo `pid', e seu status de saída deslocado 8 bits para a esquerda (o deslocamento torna o uso da função em várias plataformas mais fácil). Um `pid' menor ou igual a @code{0} não tem nenhum significado especial no Windows e levanta uma exceção. O valor de inteiros `options' não tem efeito. `pid' pode se referir a qualquer processo cujo id é conhecido, não necessariamente um processo filho. As funções @ref{1826,,spawn*} chamadas com @ref{2db8,,P_NOWAIT} retornam manipuladores de processo adequados.

@ref{923,,waitstatus_to_exitcode()} pode ser usado para converter o status de saída em um código de saída.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not Android, not iOS.


Alterado na versão 3.5: Se a chamada de sistema é interrompida e o tratador de sinal não levanta uma exceção, a função agora tenta novamente a chamada de sistema em vez de levantar uma exceção @ref{db0,,InterruptedError} (consulte 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para entender a justificativa).

@end deffn

@geindex wait3() (no módulo os)
@anchor{library/os os wait3}@anchor{dbe}
@deffn {Função} os.wait3 (options)

Semelhante a @ref{dc2,,waitpid()}, exceto que nenhum argumento de id de processo é fornecido e uma tupla de 3 elementos contendo o id do processo filho, indicação de status de saída e informações de uso de recursos é retornada. Consulte @ref{1478,,resource.getrusage()} para obter detalhes sobre as informações de uso de recursos. O argumento `option' é o mesmo fornecido para @ref{dc2,,waitpid()} e @ref{dbf,,wait4()}.

@ref{923,,waitstatus_to_exitcode()} pode ser usado para converter o status de saída em um código de saída.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex wait4() (no módulo os)
@anchor{library/os os wait4}@anchor{dbf}
@deffn {Função} os.wait4 (pid, options)

Semelhante a @ref{dc2,,waitpid()}, exceto uma tupla de 3 elementos, contendo o id do processo filho, indicação de status de saída e informações de uso de recursos é retornada. Consulte @ref{1478,,resource.getrusage()} para obter detalhes sobre as informações de uso de recursos. Os argumentos para @ref{dbf,,wait4()} são os mesmos que aqueles fornecidos a @ref{dc2,,waitpid()}.

@ref{923,,waitstatus_to_exitcode()} pode ser usado para converter o status de saída em um código de saída.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex P_PID (no módulo os)
@geindex P_PGID (no módulo os)
@geindex P_ALL (no módulo os)
@geindex P_PIDFD (no módulo os)
@anchor{library/os os P_PID}@anchor{2dbd}
@deffn {Dado} os.P_PID
@anchor{library/os os P_PGID}@anchor{2dbe}
@deffnx {Dado} os.P_PGID
@anchor{library/os os P_ALL}@anchor{2dbf}
@deffnx {Dado} os.P_ALL
@anchor{library/os os P_PIDFD}@anchor{920}
@deffnx {Dado} os.P_PIDFD

Estes são os valores possíveis para `idtype' em @ref{dc1,,waitid()}. Eles afetam como `id' é interpretado:


@itemize *

@item 
@code{P_PID} - espera pelo filho cujo PID é `id'.

@item 
@code{P_PGID} - espera por qualquer filho cujo ID do grupo de progresso seja `id'.

@item 
@code{P_ALL} - espera por qualquer filho; `id' é ignorado.

@item 
@code{P_PIDFD} - espera pelo filho identificado pelo descritor de arquivo `id' (um descritor de arquivo de processo criado com @ref{47a,,pidfd_open()}).
@end itemize

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.

@cartouche
@quotation Nota 
@code{P_PIDFD} só está disponível no Linux >= 5.4.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Adicionado na versão 3.9: A constante @code{P_PIDFD}.

@end deffn

@geindex WCONTINUED (no módulo os)
@anchor{library/os os WCONTINUED}@anchor{2dc2}
@deffn {Dado} os.WCONTINUED

Este sinalizador `options' para @ref{dc2,,waitpid()}, @ref{dbe,,wait3()}, @ref{dbf,,wait4()} e @ref{dc1,,waitid()} faz com que os processos filhos sejam reportados se eles tiverem continuado de uma parada de controle de trabalho desde que foram reportados pela última vez.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITED (no módulo os)
@anchor{library/os os WEXITED}@anchor{2dc0}
@deffn {Dado} os.WEXITED

Este sinalizador `options' para @ref{dc1,,waitid()} faz com que os processos filhos que terminaram sejam reportados.

As outras funções @code{wait*} sempre reportam filhos que terminaram, então esta opção não está disponível para eles.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


Adicionado na versão 3.3.

@end deffn

@geindex WSTOPPED (no módulo os)
@anchor{library/os os WSTOPPED}@anchor{2dc1}
@deffn {Dado} os.WSTOPPED

Este sinalizador `options' para @ref{dc1,,waitid()} faz com que os processos filhos que foram parados pela entrega de um sinal sejam reportados.

Esta opção não está disponível para as outras funções @code{wait*}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


Adicionado na versão 3.3.

@end deffn

@geindex WUNTRACED (no módulo os)
@anchor{library/os os WUNTRACED}@anchor{2dc7}
@deffn {Dado} os.WUNTRACED

Este sinalizador de `options' para @ref{dc2,,waitpid()}, @ref{dbe,,wait3()} e @ref{dbf,,wait4()} faz com que os processos filho também sejam reportados se eles foram interrompidos, mas seu estado atual não foi reportado desde que foram parados.

Esta opção não está disponível para @ref{dc1,,waitid()}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOHANG (no módulo os)
@anchor{library/os os WNOHANG}@anchor{2dc3}
@deffn {Dado} os.WNOHANG

Este sinalizador `options' faz com que @ref{dc2,,waitpid()}, @ref{dbe,,wait3()}, @ref{dbf,,wait4()} e @ref{dc1,,waitid()} retornem imediatamente se nenhum status de processo filho estiver disponível imediatamente.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOWAIT (no módulo os)
@anchor{library/os os WNOWAIT}@anchor{2dc4}
@deffn {Dado} os.WNOWAIT

Este sinalizador `options' faz com que @ref{dc1,,waitid()} deixe o filho em um estado de espera, para que uma chamada @code{wait*()} posterior possa ser usada para recuperar as informações de status do filho novamente.

Esta opção não está disponível para as outras funções @code{wait*}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex CLD_EXITED (no módulo os)
@geindex CLD_KILLED (no módulo os)
@geindex CLD_DUMPED (no módulo os)
@geindex CLD_TRAPPED (no módulo os)
@geindex CLD_STOPPED (no módulo os)
@geindex CLD_CONTINUED (no módulo os)
@anchor{library/os os CLD_EXITED}@anchor{2dc6}
@deffn {Dado} os.CLD_EXITED
@anchor{library/os os CLD_KILLED}@anchor{91e}
@deffnx {Dado} os.CLD_KILLED
@anchor{library/os os CLD_DUMPED}@anchor{2dc8}
@deffnx {Dado} os.CLD_DUMPED
@anchor{library/os os CLD_TRAPPED}@anchor{2dc9}
@deffnx {Dado} os.CLD_TRAPPED
@anchor{library/os os CLD_STOPPED}@anchor{91f}
@deffnx {Dado} os.CLD_STOPPED
@anchor{library/os os CLD_CONTINUED}@anchor{2dca}
@deffnx {Dado} os.CLD_CONTINUED

Estes são os valores possíveis para @code{si_code} no resultado retornado por @ref{dc1,,waitid()}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.


Adicionado na versão 3.3.



Alterado na versão 3.9: Adicionados os valores @ref{91e,,CLD_KILLED} e @ref{91f,,CLD_STOPPED}.

@end deffn

@geindex waitstatus_to_exitcode() (no módulo os)
@anchor{library/os os waitstatus_to_exitcode}@anchor{923}
@deffn {Função} os.waitstatus_to_exitcode (status)

Converte um status de espera em um código de saída.

No Unix:


@itemize *

@item 
Se o processo saiu normalmente (se @code{WIFEXITED(status)} for verdadeiro), retorna o status de saída do processo (retorna @code{WEXITSTATUS(status)}): resultado maior ou igual a 0.

@item 
Se o processo foi encerrado por um sinal (se @code{WIFSIGNALED(status)} for verdadeiro), retorna @code{-signum} onde `signum' é o número do sinal que causou o encerramento do processo (retorna @code{-WTERMSIG(status)}): resultado menor que 0.

@item 
Do contrário, levanta uma exceção @ref{202,,ValueError}.
@end itemize

No Windows, retorna `status' deslocado para a direita em 8 bits.

No Unix, se o processo está sendo rastreado ou se @ref{dc2,,waitpid()} foi chamado com a opção @ref{2dc7,,WUNTRACED}, o chamador deve primeiro verificar se @code{WIFSTOPPED(status)} é verdadeiro. Esta função não deve ser chamada se @code{WIFSTOPPED(status)} for verdadeiro.


@subsubheading Ver também


As funções @ref{2dcb,,WIFEXITED()}, @ref{2dcc,,WEXITSTATUS()}, @ref{2dcd,,WIFSIGNALED()}, @ref{2dce,,WTERMSIG()}, @ref{2dcf,,WIFSTOPPED()}, @ref{2dd0,,WSTOPSIG()}.


@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI, not Android, not iOS.


Adicionado na versão 3.9.

@end deffn

As funções a seguir recebem um código de status do processo conforme retornado por @ref{14a5,,system()}, @ref{dc0,,wait()} ou @ref{dc2,,waitpid()} como parâmetro. Eles podem ser usados para determinar a disposição de um processo.

@geindex WCOREDUMP() (no módulo os)
@anchor{library/os os WCOREDUMP}@anchor{2dd1}
@deffn {Função} os.WCOREDUMP (status, /)

Retorna @code{True} se um despejo de memória `(core dump)' foi gerado para o processo; caso contrário, retorna @code{False}.

Esta função deve ser empregada apenas se @ref{2dcd,,WIFSIGNALED()} for verdadeira.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFCONTINUED() (no módulo os)
@anchor{library/os os WIFCONTINUED}@anchor{2dd2}
@deffn {Função} os.WIFCONTINUED (status)

Retorna @code{True} se um filho interrompido foi retomado pela entrega de @ref{2dd3,,SIGCONT} (se o processo foi continuado de uma parada de controle de trabalho); caso contrário, retorna @code{False}.

Veja a opção @ref{2dc2,,WCONTINUED}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSTOPPED() (no módulo os)
@anchor{library/os os WIFSTOPPED}@anchor{2dcf}
@deffn {Função} os.WIFSTOPPED (status)

Retorna @code{True} se o processo foi interrompido pela entrega de um sinal; caso contrário, retorna @code{False}.

@ref{2dcf,,WIFSTOPPED()} só retorna @code{True} se a chamada de @ref{dc2,,waitpid()} foi feita usando a opção @ref{2dc7,,WUNTRACED} ou quando o processo está sendo rastreado (veja @code{ptrace(2)@footnote{https://manpages.debian.org/ptrace(2)}}).

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSIGNALED() (no módulo os)
@anchor{library/os os WIFSIGNALED}@anchor{2dcd}
@deffn {Função} os.WIFSIGNALED (status)

Retorna @code{True} se o processo foi encerrado por um sinal; caso contrário, retorna @code{False}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFEXITED() (no módulo os)
@anchor{library/os os WIFEXITED}@anchor{2dcb}
@deffn {Função} os.WIFEXITED (status)

Retorna @code{True} se o processo foi encerrado normalmente, isto é, chamando @code{exit()} ou @code{_exit()}, ou retornando de @code{main()}; caso contrário, retorna @code{False}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITSTATUS() (no módulo os)
@anchor{library/os os WEXITSTATUS}@anchor{2dcc}
@deffn {Função} os.WEXITSTATUS (status)

Retorna o status de saída do processo.

Esta função deve ser empregada apenas se @ref{2dcb,,WIFEXITED()} for verdadeira.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WSTOPSIG() (no módulo os)
@anchor{library/os os WSTOPSIG}@anchor{2dd0}
@deffn {Função} os.WSTOPSIG (status)

Retorna o sinal que causou a interrupção do processo.

Esta função deve ser empregada apenas se @ref{2dcf,,WIFSTOPPED()} for verdadeira.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WTERMSIG() (no módulo os)
@anchor{library/os os WTERMSIG}@anchor{2dce}
@deffn {Função} os.WTERMSIG (status)

Retorna o número do sinal que causou o encerramento do processo.

Esta função deve ser empregada apenas se @ref{2dcd,,WIFSIGNALED()} for verdadeira.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.
@end deffn

@node Interface do agendador,Diversas informações de sistema,Gerenciamento de processo,os — Diversas interfaces de sistema operacional
@anchor{library/os interface-to-the-scheduler}@anchor{2dd4}
@subsubsection Interface do agendador


Essas funções controlam como o tempo de CPU de um processo é alocado pelo sistema operacional. Eles estão disponíveis apenas em algumas plataformas Unix. Para informações mais detalhadas, consulte suas páginas man do Unix.


Adicionado na versão 3.3.


As políticas de agendamento a seguir serão expostas se houver suporte pelo sistema operacional.

@geindex SCHED_OTHER (no módulo os)
@anchor{library/os os-scheduling-policy}@anchor{2dd5}@anchor{library/os os SCHED_OTHER}@anchor{2dd6}
@deffn {Dado} os.SCHED_OTHER

A política de agendamento padrão.
@end deffn

@geindex SCHED_BATCH (no módulo os)
@anchor{library/os os SCHED_BATCH}@anchor{2dd7}
@deffn {Dado} os.SCHED_BATCH

Política de agendamento para processos com uso intensivo de CPU que tenta preservar a interatividade no resto do computador.
@end deffn

@geindex SCHED_IDLE (no módulo os)
@anchor{library/os os SCHED_IDLE}@anchor{2dd8}
@deffn {Dado} os.SCHED_IDLE

Política de agendamento para tarefas em segundo plano de prioridade extremamente baixa.
@end deffn

@geindex SCHED_SPORADIC (no módulo os)
@anchor{library/os os SCHED_SPORADIC}@anchor{2dd9}
@deffn {Dado} os.SCHED_SPORADIC

Política de agendamento para programas de servidor esporádicos.
@end deffn

@geindex SCHED_FIFO (no módulo os)
@anchor{library/os os SCHED_FIFO}@anchor{2dda}
@deffn {Dado} os.SCHED_FIFO

Uma política de agendamento Primeiro a Entrar, Primeiro a Sair (First In First Out - FIFO).
@end deffn

@geindex SCHED_RR (no módulo os)
@anchor{library/os os SCHED_RR}@anchor{2ddb}
@deffn {Dado} os.SCHED_RR

Uma política de agendamento round-robin.
@end deffn

@geindex SCHED_RESET_ON_FORK (no módulo os)
@anchor{library/os os SCHED_RESET_ON_FORK}@anchor{2ddc}
@deffn {Dado} os.SCHED_RESET_ON_FORK

Este sinalizador pode ser operado em OU com qualquer outra política de agendamento. Quando um processo com este sinalizador definido bifurca, a política de agendamento e a prioridade de seu filho são redefinidas para o padrão.
@end deffn

@geindex sched_param (classe em os)
@anchor{library/os os sched_param}@anchor{168a}
@deffn {Classe} os.sched_param (sched_priority)

Esta classe representa parâmetros de agendamento ajustáveis usados em @ref{114e,,sched_setparam()}, @ref{114f,,sched_setscheduler()} e @ref{114a,,sched_getparam()}. É imutável.

Neste momento, há somente um único parâmetro possível:

@geindex sched_priority (atributo os.sched_param)
@anchor{library/os os sched_param sched_priority}@anchor{2ddd}
@deffn {Atributo} sched_priority

A prioridade de agendamento para uma política de agendamento.
@end deffn
@end deffn

@geindex sched_get_priority_min() (no módulo os)
@anchor{library/os os sched_get_priority_min}@anchor{1148}
@deffn {Função} os.sched_get_priority_min (policy)

Obtém o valor mínimo de prioridade para `policy'. `policy' é uma das constantes de política de agendamento acima.
@end deffn

@geindex sched_get_priority_max() (no módulo os)
@anchor{library/os os sched_get_priority_max}@anchor{1147}
@deffn {Função} os.sched_get_priority_max (policy)

Obtém o valor máximo de prioridade para `policy'. `policy' é uma das constantes de política de agendamento acima.
@end deffn

@geindex sched_setscheduler() (no módulo os)
@anchor{library/os os sched_setscheduler}@anchor{114f}
@deffn {Função} os.sched_setscheduler (pid, policy, param, /)

Define a política de agendamento para o processo com PID `pid'. Um `pid' de 0 significa o processo de chamada. `policy' é uma das constantes de política de agendamento acima. `param' é uma instância de @ref{168a,,sched_param}.
@end deffn

@geindex sched_getscheduler() (no módulo os)
@anchor{library/os os sched_getscheduler}@anchor{114b}
@deffn {Função} os.sched_getscheduler (pid, /)

Retorna a política de agendamento para o processo com PID `pid'. Um `pid' de 0 significa o processo de chamada. O resultado é uma das constantes de política de agendamento acima.
@end deffn

@geindex sched_setparam() (no módulo os)
@anchor{library/os os sched_setparam}@anchor{114e}
@deffn {Função} os.sched_setparam (pid, param, /)

Define os parâmetros de agendamento para o processo com PID `pid'. Um `pid' de 0 significa o processo de chamada. `param' é uma instância de @ref{168a,,sched_param}.
@end deffn

@geindex sched_getparam() (no módulo os)
@anchor{library/os os sched_getparam}@anchor{114a}
@deffn {Função} os.sched_getparam (pid, /)

Retorna os parâmetros de agendamento como uma instância de @ref{168a,,sched_param} para o processo com PID `pid'. Um `pid' de 0 significa o processo de chamada.
@end deffn

@geindex sched_rr_get_interval() (no módulo os)
@anchor{library/os os sched_rr_get_interval}@anchor{114c}
@deffn {Função} os.sched_rr_get_interval (pid, /)

Retorna o quantum round-robin em segundos para o processo com PID `pid'. Um `pid' de 0 significa o processo de chamada.
@end deffn

@geindex sched_yield() (no módulo os)
@anchor{library/os os sched_yield}@anchor{1150}
@deffn {Função} os.sched_yield ()

Abandona voluntariamente a CPU. Veja @code{sched_yield(2)@footnote{https://manpages.debian.org/sched_yield(2)}} para detalhes.
@end deffn

@geindex sched_setaffinity() (no módulo os)
@anchor{library/os os sched_setaffinity}@anchor{114d}
@deffn {Função} os.sched_setaffinity (pid, mask, /)

Restringe o processo com PID `pid' (ou o processo atual se zero) para um conjunto de CPUs. `mask' é um iterável de inteiros que representam o conjunto de CPUs às quais o processo deve ser restrito.
@end deffn

@geindex sched_getaffinity() (no módulo os)
@anchor{library/os os sched_getaffinity}@anchor{1149}
@deffn {Função} os.sched_getaffinity (pid, /)

Retorna o conjunto de CPUs ao qual o processo com PID `pid' está restrito.

Se `pid' for zero, retorna o conjunto de CPUs às quais a thread chamadora do processo atual está restrita.

Veja também a função @ref{1c4,,process_cpu_count()}.
@end deffn

@node Diversas informações de sistema,Números aleatórios<2>,Interface do agendador,os — Diversas interfaces de sistema operacional
@anchor{library/os miscellaneous-system-information}@anchor{2dde}@anchor{library/os os-path}@anchor{2ddf}
@subsubsection Diversas informações de sistema


@geindex confstr() (no módulo os)
@anchor{library/os os confstr}@anchor{1650}
@deffn {Função} os.confstr (name, /)

Retorna valores de configuração do sistema com valor de string. `name' especifica o valor de configuração a ser recuperado; pode ser uma string que é o nome de um valor de sistema definido; esses nomes são especificados em vários padrões (POSIX, Unix 95, Unix 98 e outros). Algumas plataformas também definem nomes adicionais. Os nomes conhecidos pelo sistema operacional são fornecidos como as chaves do dicionário @code{confstr_names}. Para variáveis de configuração não incluídas nesse mapeamento, passar um número inteiro para `name' também é aceito.

Se o valor de configuração especificado por `name' não for definido, retorna @code{None}.

Se `name' for uma string e não for conhecida, @ref{202,,ValueError} é levantada. Se um valor específico para `name' não for compatível com o sistema operacional do computador, mesmo que seja incluído em @code{confstr_names}, uma @ref{417,,OSError} é levantada com @ref{1b66,,errno.EINVAL} como número do erro.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex confstr_names (no módulo os)
@anchor{library/os os confstr_names}@anchor{2de0}
@deffn {Dado} os.confstr_names

Nomes de mapeamento de dicionário aceitos por @ref{1650,,confstr()} para os valores inteiros definidos para esses nomes pelo sistema operacional do computador. Isso pode ser usado para determinar o conjunto de nomes conhecidos pelo sistema.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex cpu_count() (no módulo os)
@anchor{library/os os cpu_count}@anchor{1c5}
@deffn {Função} os.cpu_count ()

Retorna o número de CPUs lógicas do `sistema'. Retorna @code{None} se não determinado.

A função @ref{1c4,,process_cpu_count()} pode ser usada para obter o número de CPUs lógicas utilizáveis pela thread de chamada do `processo atual'.


Adicionado na versão 3.4.



Alterado na versão 3.13: If @ref{176,,-X cpu_count} is given or 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT} is set,
@ref{1c5,,cpu_count()} returns the override value `n'.

@end deffn

@geindex getloadavg() (no módulo os)
@anchor{library/os os getloadavg}@anchor{16d1}
@deffn {Função} os.getloadavg ()

Retorna o número de processos na fila de execução do sistema em média nos últimos 1, 5 e 15 minutos ou levanta @ref{417,,OSError} se a média de carga não foi obtida.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex process_cpu_count() (no módulo os)
@anchor{library/os os process_cpu_count}@anchor{1c4}
@deffn {Função} os.process_cpu_count ()

Obtém o número de CPUs lógicas utilizáveis pelo thread de chamada do `processo atual'. Retorna @code{None} se indeterminado. Pode ser menor que @ref{1c5,,cpu_count()} dependendo da afinidade da CPU.

A função @ref{1c5,,cpu_count()} pode ser usada para obter o número de CPUs lógicas no `sistema'.

If @ref{176,,-X cpu_count} is given or 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT} is set,
@ref{1c4,,process_cpu_count()} returns the override value `n'.

Veja também a função @ref{1149,,sched_getaffinity()}.


Adicionado na versão 3.13.

@end deffn

@geindex sysconf() (no módulo os)
@anchor{library/os os sysconf}@anchor{1651}
@deffn {Função} os.sysconf (name, /)

Retorna valores de configuração do sistema com valor inteiro. Se o valor de configuração especificado por `name' não estiver definido, @code{-1} é retornado. Os comentários sobre o parâmetro `name' para @ref{1650,,confstr()} se aplicam aqui também; o dicionário que fornece informações sobre os nomes conhecidos é fornecido por @code{sysconf_names}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex sysconf_names (no módulo os)
@anchor{library/os os sysconf_names}@anchor{2de1}
@deffn {Dado} os.sysconf_names

Nomes de mapeamento de dicionário aceitos por @ref{1651,,sysconf()} para os valores inteiros definidos para esses nomes pelo sistema operacional. Isso pode ser usado para determinar o conjunto de nomes conhecidos pelo sistema.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.11: Adiciona o nome @code{'SC_MINSIGSTKSZ'}.

@end deffn

Os dados a seguir são usados para operações de manipulação de caminhos de arquivos e diretórios. Estão definidos e disponíveis para todas as plataformas.

Operações de nível mais alto em nomes de caminho são definidos no módulo @ref{a2,,os.path}.

@geindex . (ponto);em nomes de caminhos

@geindex curdir (no módulo os)
@anchor{library/os os curdir}@anchor{2990}
@deffn {Dado} os.curdir

A string constante usada pelo sistema operacional para se referir ao diretório atual. Isso é @code{'.'} para Windows e POSIX. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex ..;em nomes de caminhos

@geindex pardir (no módulo os)
@anchor{library/os os pardir}@anchor{2d5e}
@deffn {Dado} os.pardir

A string constante usada pelo sistema operacional para se referir ao diretório pai. Isso é @code{'..'} para Windows e POSIX. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex / (barra);em nomes de caminhos

@geindex \ (contrabarra);em nomes de caminhos (Windows)

@geindex sep (no módulo os)
@anchor{library/os os sep}@anchor{66a}
@deffn {Dado} os.sep

O caractere usado pelo sistema operacional para separar os componentes do nome do caminho. Este é @code{'/'} para POSIX e @code{'\\'} para Windows. Observe que saber disso não é suficiente para ser capaz de analisar ou concatenar nomes de caminho – use @ref{298a,,os.path.split()} e @ref{171f,,os.path.join()} – mas ocasionalmente é útil. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex / (barra);em nomes de caminhos

@geindex altsep (no módulo os)
@anchor{library/os os altsep}@anchor{66b}
@deffn {Dado} os.altsep

Um caractere alternativo usado pelo sistema operacional para separar os componentes do nome de caminho, ou @code{None} se apenas um caractere separador existir. Isso é definido como @code{'/'} em sistemas Windows onde @code{sep} é uma contrabarra. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex . (ponto);em nomes de caminhos

@geindex extsep (no módulo os)
@anchor{library/os os extsep}@anchor{2de2}
@deffn {Dado} os.extsep

O caractere que separa o nome do arquivo base da extensão; por exemplo, o @code{'.'} em @code{os.py}. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex ; (dois pontos);separador de caminho (POSIX)
@geindex ; (ponto e vírgula)

@geindex pathsep (no módulo os)
@anchor{library/os os pathsep}@anchor{1ecc}
@deffn {Dado} os.pathsep

O caractere convencionalmente usado pelo sistema operacional para separar os componentes do caminho de pesquisa (como em 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}), como @code{':'} para POSIX ou @code{';'} para Windows. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex defpath (no módulo os)
@anchor{library/os os defpath}@anchor{1b79}
@deffn {Dado} os.defpath

O caminho de pesquisa padrão usado por @ref{2d95,,exec*p*} e @ref{1826,,spawn*p*} se o ambiente não tiver uma chave @code{'PATH'}. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex linesep (no módulo os)
@anchor{library/os os linesep}@anchor{2311}
@deffn {Dado} os.linesep

A string usada para separar (ou melhor, encerrar) linhas na plataforma atual. Pode ser um único caractere, como @code{'\n'} para POSIX, ou múltiplos caracteres, por exemplo, @code{'\r\n'} para Windows. Não use `os.linesep' como terminador de linha ao escrever arquivos abertos em modo de texto (o padrão); use um único @code{'\n'} ao invés, em todas as plataformas.
@end deffn

@geindex devnull (no módulo os)
@anchor{library/os os devnull}@anchor{1bab}
@deffn {Dado} os.devnull

O caminho do arquivo do dispositivo nulo. Por exemplo: @code{'/dev/null'} para POSIX, @code{'nul'} para Windows. Também disponível via @ref{a2,,os.path}.
@end deffn

@geindex RTLD_LAZY (no módulo os)
@geindex RTLD_NOW (no módulo os)
@geindex RTLD_GLOBAL (no módulo os)
@geindex RTLD_LOCAL (no módulo os)
@geindex RTLD_NODELETE (no módulo os)
@geindex RTLD_NOLOAD (no módulo os)
@geindex RTLD_DEEPBIND (no módulo os)
@anchor{library/os os RTLD_LAZY}@anchor{1157}
@deffn {Dado} os.RTLD_LAZY
@anchor{library/os os RTLD_NOW}@anchor{1158}
@deffnx {Dado} os.RTLD_NOW
@anchor{library/os os RTLD_GLOBAL}@anchor{1159}
@deffnx {Dado} os.RTLD_GLOBAL
@anchor{library/os os RTLD_LOCAL}@anchor{115a}
@deffnx {Dado} os.RTLD_LOCAL
@anchor{library/os os RTLD_NODELETE}@anchor{115b}
@deffnx {Dado} os.RTLD_NODELETE
@anchor{library/os os RTLD_NOLOAD}@anchor{115c}
@deffnx {Dado} os.RTLD_NOLOAD
@anchor{library/os os RTLD_DEEPBIND}@anchor{115d}
@deffnx {Dado} os.RTLD_DEEPBIND

Sinalizadores para uso com as funções @ref{115e,,setdlopenflags()} e @ref{1557,,getdlopenflags()}. Veja a página man do Unix @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} para saber o que significam os diferentes sinalizadores.


Adicionado na versão 3.3.

@end deffn

@node Números aleatórios<2>,,Diversas informações de sistema,os — Diversas interfaces de sistema operacional
@anchor{library/os random-numbers}@anchor{2de3}
@subsubsection Números aleatórios


@geindex getrandom() (no módulo os)
@anchor{library/os os getrandom}@anchor{cdd}
@deffn {Função} os.getrandom (size, flags=0)

Obtém até `size' bytes aleatórios. Esta função pode retornar menos bytes que a quantia requisitada.

Esses bytes podem ser usados para propagar geradores de número aleatório no espaço do usuário ou para fins criptográficos.

@code{getrandom()} depende da entropia obtida de drivers de dispositivos e outras fontes de ruído ambiental. A leitura desnecessária de grandes quantidades de dados terá um impacto negativo sobre outros usuários dos dispositivos @code{/dev/random} e @code{/dev/urandom}.

O argumento `flags' é uma máscara de bits que pode conter zero ou mais dos seguintes valores operados com OU: @ref{2de4,,os.GRND_RANDOM} e @ref{2de5,,GRND_NONBLOCK}.

Veja também a página de manual do getrandom()@footnote{https://man7.org/linux/man-pages/man2/getrandom.2.html} do Linux.

@ref{1ed8,,Disponibilidade}: Linux >= 3.17.


Adicionado na versão 3.6.

@end deffn

@geindex urandom() (no módulo os)
@anchor{library/os os urandom}@anchor{523}
@deffn {Função} os.urandom (size, /)

Retorna uma sequência de bytes de tamanho `size' aleatórios próprios para uso criptográfico.

Esta função retorna bytes aleatórios de uma fonte de aleatoriedade específica do sistema operacional. Os dados retornados devem ser imprevisíveis o suficiente para aplicações criptográficos, embora sua qualidade exata dependa da implementação do sistema operacional.

No Linux, se a chamada de sistema @code{getrandom()} estiver disponível, ela é usada no modo bloqueante: bloqueia até que o pool de entropia urandom do sistema seja inicializado (128 bits de entropia são coletados pelo kernel). Veja a 
@geindex Propostas de Melhorias do Python; PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} para a justificativa. No Linux, a função @ref{cdd,,getrandom()} pode ser usada para obter bytes aleatórios no modo não bloqueante (usando a sinalização @ref{2de5,,GRND_NONBLOCK}) ou para pesquisar até que o pool de entropia urandom do sistema seja inicializado.

Em um sistema semelhante ao Unix, bytes aleatórios são lidos do dispositivo @code{/dev/urandom}. Se o dispositivo @code{/dev/urandom} não estiver disponível ou não for legível, a exceção @ref{228,,NotImplementedError} é levantada.

No Windows, ainda vai usar @code{BCryptGenRandom()}.


@subsubheading Ver também


O módulo @ref{c0,,secrets} fornece funções de nível mais alto. Para uma interface fácil de usar para o gerador de números aleatórios fornecido por sua plataforma, consulte @ref{288b,,random.SystemRandom}.



Alterado na versão 3.5: No Linux 3.17 e mais recente, a chamada de sistema @code{getrandom()} agora é usada quando disponível. No OpenBSD 5.6 e mais recentes, a função C @code{getentropy()} agora é usada. Essas funções evitam o uso de um descritor de arquivo interno.



Alterado na versão 3.5.2: No Linux, se a chamada de sistema @code{getrandom()} bloqueia (o pool de entropia urandom ainda não foi inicializado), recorre à leitura @code{/dev/urandom}.



Alterado na versão 3.6: No Linux, @code{getrandom()} é usado agora no modo de bloqueio para aumentar a segurança.



Alterado na versão 3.11: No Windows, @code{BCryptGenRandom()} é usado em vez de @code{CryptGenRandom()}, o qual foi descontinuado.

@end deffn

@geindex GRND_NONBLOCK (no módulo os)
@anchor{library/os os GRND_NONBLOCK}@anchor{2de5}
@deffn {Dado} os.GRND_NONBLOCK

Por padrão, ao ler de @code{/dev/random}, @ref{cdd,,getrandom()} bloqueia se nenhum byte aleatório estiver disponível, e ao ler de @code{/dev/urandom}, ele bloqueia se o pool de entropia ainda não foi inicializado.

Se o sinalizador @ref{2de5,,GRND_NONBLOCK} estiver definido, então @ref{cdd,,getrandom()} não bloqueia nesses casos, mas, em vez disso, levanta @ref{1090,,BlockingIOError} imediatamente.


Adicionado na versão 3.6.

@end deffn

@geindex GRND_RANDOM (no módulo os)
@anchor{library/os os GRND_RANDOM}@anchor{2de4}
@deffn {Dado} os.GRND_RANDOM

Se este bit é definido os bytes aleatórios são sorteados a partir de @code{/dev/random} ao invés de @code{/dev/urandom}.


Adicionado na versão 3.6.

@end deffn

@node io — Ferramentas essenciais para trabalhar com fluxos,time — Acesso ao horário e conversões,os — Diversas interfaces de sistema operacional,Serviços Genéricos do Sistema Operacional
@anchor{library/io doc}@anchor{2de6}@anchor{library/io io-core-tools-for-working-with-streams}@anchor{2de7}@anchor{library/io module-io}@anchor{7f}@anchor{library/io translation-repo}@anchor{2de8}
@subsection @code{io} — Ferramentas essenciais para trabalhar com fluxos


@geindex module; io

`Código-fonte:' Lib/io.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/io.py}


__________________________________________________________________


@menu
* Visão Geral: Visão Geral<2>. 
* Codificação do texto:: 
* Interface de alto nível do módulo:: 
* hierarquia de classe:: 
* Desempenho: Desempenho<3>. 

@end menu

@node Visão Geral<2>,Codificação do texto,,io — Ferramentas essenciais para trabalhar com fluxos
@anchor{library/io io-overview}@anchor{230f}@anchor{library/io overview}@anchor{2de9}
@subsubsection Visão Geral


@geindex objeto arquivo;io module

O módulo @ref{7f,,io} fornece os principais recursos do Python para lidar com vários tipos de E/S. Existem três tipos principais de E/S: `E/S de texto', `E/S binária' e `E/S bruta'. Essas são categorias genéricas, e vários repositórios de apoio podem ser usados para cada uma delas. Um objeto concreto pertencente a qualquer uma dessas categorias é chamado de @ref{1203,,objeto arquivo}. Outros termos comuns são `fluxo' e `objeto arquivo ou similar'.

Independentemente de sua categoria, cada objeto de fluxo concreto também terá vários recursos: pode ser somente leitura, somente escrita ou leitura e escrita. Também pode permitir acesso aleatório arbitrário (buscando para frente ou para trás em qualquer local) ou apenas acesso sequencial (por exemplo, no caso de um soquete ou encadeamento).

Todos os fluxos são cuidadosos com o tipo de dados que você fornece a eles. Por exemplo, atribuir um objeto @ref{44c,,str} ao método @code{write()} de um fluxo binário levantará uma @ref{2c3,,TypeError}. O mesmo ocorrerá com um objeto @ref{1c2,,bytes} ao método @code{write()} de um fluxo de texto.


Alterado na versão 3.3: Operações que costumavam levantar @ref{108b,,IOError} agora levantam @ref{417,,OSError}, já que @ref{108b,,IOError} agora é um apelido de @ref{417,,OSError}.


@menu
* E/S de texto:: 
* E/S binária:: 
* E/S bruta:: 

@end menu

@node E/S de texto,E/S binária,,Visão Geral<2>
@anchor{library/io text-i-o}@anchor{2dea}
@subsubsection E/S de texto


A E/S de texto espera e produz objetos @ref{44c,,str}. Isso significa que sempre que o armazenamento de apoio for composto nativamente por bytes (como no caso de um arquivo), a codificação e a decodificação dos dados são feitas de forma transparente, bem como a tradução opcional de caracteres de quebra de linha específicos da plataforma.

A maneira mais fácil de criar um fluxo de texto é com @ref{51c,,open()}, especificando opcionalmente uma codificação:

@example
f = open("myfile.txt", "r", encoding="utf-8")
@end example

Os fluxos de texto na memória também estão disponíveis como objetos @ref{f59,,StringIO}:

@example
f = io.StringIO("alguns dados em texto iniciais")
@end example

A API de fluxo de texto é descrita em detalhes na documentação de @ref{695,,TextIOBase}.

@node E/S binária,E/S bruta,E/S de texto,Visão Geral<2>
@anchor{library/io binary-i-o}@anchor{2deb}
@subsubsection E/S binária


E/S binária (também chamada de `E/S com buffer') espera @ref{d4f,,objeto bytes ou similar} e produz objetos @ref{1c2,,bytes}. Nenhuma codificação, decodificação ou tradução de quebra de linha é realizada. Esta categoria de fluxos pode ser usada para todos os tipos de dados não textuais e também quando se deseja controle manual sobre o tratamento de dados textuais.

A maneira mais fácil de criar um fluxo binário é com @ref{51c,,open()} com @code{'b'} na string de modo:

@example
f = open("meuarquivo.jpg", "rb")
@end example

Os fluxos binários na memória também estão disponíveis como objetos @ref{ed3,,BytesIO}:

@example
f = io.BytesIO(b"alguns dados bin\xe1rios iniciais: \x00\x01")
@end example

A API de fluxo binário é descrita em detalhes na documentação de @ref{694,,BufferedIOBase}.

Outros módulos de biblioteca podem fornecer maneiras adicionais de criar fluxos de texto ou binários. Veja @ref{11de,,socket.socket.makefile()} como exemplo.

@node E/S bruta,,E/S binária,Visão Geral<2>
@anchor{library/io raw-i-o}@anchor{2dec}
@subsubsection E/S bruta


A E/S bruta (também chamada de `E/S sem buffer') é geralmente usada como um bloco de construção de baixo nível para fluxos binários e de texto; raramente é útil manipular diretamente um fluxo bruto a partir do código do usuário. No entanto, você pode criar um fluxo bruto abrindo um arquivo em modo binário com o buffer desabilitado:

@example
f = open("meuarquivo.jpg", "rb", buffering=0)
@end example

A API de fluxo bruto é descrita em detalhes na documentação de @ref{110f,,RawIOBase}.

@node Codificação do texto,Interface de alto nível do módulo,Visão Geral<2>,io — Ferramentas essenciais para trabalhar com fluxos
@anchor{library/io io-text-encoding}@anchor{7be}@anchor{library/io text-encoding}@anchor{2ded}
@subsubsection Codificação do texto


A codificação padrão de @ref{7bc,,TextIOWrapper} e @ref{51c,,open()} é específica da localidade (@ref{2dc,,locale.getencoding()}).

No entanto, muitos desenvolvedores esquecem de especificar a codificação ao abrir arquivos de texto codificados em UTF-8 (por exemplo, JSON, TOML, Markdown, etc.), já que a maioria das plataformas Unix usa a localidade UTF-8 por padrão. Isso causa bugs porque a codificação de localidade não é UTF-8 para a maioria dos usuários do Windows. Por exemplo:

@example
# Pode não funcionar no Windows quando há caracteres não ASCII no arquivo.
with open("README.md") as f:
    long_description = f.read()
@end example

Portanto, é altamente recomendável que você especifique a codificação explicitamente ao abrir arquivos de texto. Se quiser usar UTF-8, passe @code{encoding="utf-8"}. Para usar a codificação da localidade atual, @code{encoding="locale"} é suportado desde o Python 3.10.


@subsubheading Ver também



@table @asis

@item @ref{656,,Modo UTF-8 do Python}

O modo Python UTF-8 pode ser usado para alterar a codificação padrão para UTF-8 a partir da codificação específica de localidade.

@geindex Propostas de Melhorias do Python; PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 utilizará @ref{656,,Modo UTF-8 do Python} por padrão.
@end table


@menu
* Ativar EncodingWarning:: 

@end menu

@node Ativar EncodingWarning,,,Codificação do texto
@anchor{library/io io-encoding-warning}@anchor{1ed9}@anchor{library/io opt-in-encodingwarning}@anchor{2dee}
@subsubsection Ativar EncodingWarning



Adicionado na versão 3.10: Veja a 
@geindex Propostas de Melhorias do Python; PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/} para mais detalhes.


Para descobrir onde a codificação da localidade padrão é usada, você pode habilitar a opção de linha de comando @ref{176,,-X warn_default_encoding} ou definir a variável de ambiente 
@geindex PYTHONWARNDEFAULTENCODING
@geindex variável de ambiente; PYTHONWARNDEFAULTENCODING
@ref{7bd,,PYTHONWARNDEFAULTENCODING}, que emitirá um @ref{1ec5,,EncodingWarning} quando a codificação padrão for usada.

Se você estiver fornecendo uma API que usa @ref{51c,,open()} ou @ref{7bc,,TextIOWrapper} e passa @code{encoding=None} como parâmetro, você pode usar @ref{17b9,,text_encoding()} para que os chamadores da API emitam um @ref{1ec5,,EncodingWarning} se não passarem um @code{encoding}. No entanto, considere usar UTF-8 por padrão (ou seja, @code{encoding="utf-8"}) para novas APIs.

@node Interface de alto nível do módulo,hierarquia de classe,Codificação do texto,io — Ferramentas essenciais para trabalhar com fluxos
@anchor{library/io high-level-module-interface}@anchor{2def}
@subsubsection Interface de alto nível do módulo


@geindex DEFAULT_BUFFER_SIZE (no módulo io)
@anchor{library/io io DEFAULT_BUFFER_SIZE}@anchor{17ba}
@deffn {Dado} io.DEFAULT_BUFFER_SIZE

Um inteiro contendo o tamanho padrão do buffer usado pelas classes de E/S com buffer do módulo. @ref{51c,,open()} usa o tamanho do bloco (blksize) do arquivo (obtido por @ref{4a0,,os.stat()}), se possível.
@end deffn

@geindex open() (no módulo io)
@anchor{library/io io open}@anchor{51d}
@deffn {Função} io.open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Este é um apelido para a função embutida @ref{51c,,open()}.

Esta função levanta um @ref{19fa,,evento de auditoria} @code{open} com os argumentos `path', `mode' e `flags'. Os argumentos `mode' e `flags' podem ter sido modificados ou inferidos da chamada original.
@end deffn

@geindex open_code() (no módulo io)
@anchor{library/io io open_code}@anchor{181c}
@deffn {Função} io.open_code (path)

Opens the provided file with mode @code{'rb'}. This function should be used
when the intent is to treat the contents as executable code.

`path' should be a @ref{44c,,str} and an absolute path.

The behavior of this function may be overridden by an earlier call to the
@ref{181e,,PyFile_SetOpenCodeHook()}. However, assuming that `path' is a
@ref{44c,,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.


Adicionado na versão 3.8.

@end deffn

@geindex text_encoding() (no módulo io)
@anchor{library/io io text_encoding}@anchor{17b9}
@deffn {Função} io.text_encoding (encoding, stacklevel=2, /)

This is a helper function for callables that use @ref{51c,,open()} or
@ref{7bc,,TextIOWrapper} and have an @code{encoding=None} parameter.

This function returns `encoding' if it is not @code{None}.
Otherwise, it returns @code{"locale"} or @code{"utf-8"} depending on
@ref{656,,UTF-8 Mode}.

This function emits an @ref{1ec5,,EncodingWarning} if
@ref{68c,,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

In this example, an @ref{1ec5,,EncodingWarning} is emitted for the caller of
@code{read_text()}.

Veja @ref{7be,,Codificação do texto} para mais informações.


Adicionado na versão 3.10.



Alterado na versão 3.11: @ref{17b9,,text_encoding()} returns “utf-8” when UTF-8 mode is enabled and
`encoding' is @code{None}.

@end deffn

@geindex BlockingIOError
@anchor{library/io io BlockingIOError}@anchor{2df0}
@deffn {Exceção} io.BlockingIOError

This is a compatibility alias for the builtin @ref{1090,,BlockingIOError}
exception.
@end deffn

@geindex UnsupportedOperation
@anchor{library/io io UnsupportedOperation}@anchor{1b0e}
@deffn {Exceção} io.UnsupportedOperation

An exception inheriting @ref{417,,OSError} and @ref{202,,ValueError} that is raised
when an unsupported operation is called on a stream.
@end deffn


@subsubheading Ver também



@table @asis

@item @ref{d9,,sys}

contains the standard IO streams: @ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout},
and @ref{940,,sys.stderr}.
@end table


@node hierarquia de classe,Desempenho<3>,Interface de alto nível do módulo,io — Ferramentas essenciais para trabalhar com fluxos
@anchor{library/io class-hierarchy}@anchor{2df1}
@subsubsection hierarquia de classe


The implementation of I/O streams is organized as a hierarchy of classes.  First
@ref{11f5,,abstract base classes} (ABCs), which are used to
specify the various categories of streams, then concrete classes providing the
standard stream implementations.

@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{694,,BufferedIOBase} provides unoptimized implementations of
@code{readinto()} and @code{readline()}.
@end quotation
@end cartouche

At the top of the I/O hierarchy is the abstract base class @ref{1f5,,IOBase}.  It
defines the basic interface to a stream.  Note, however, that there is no
separation between reading and writing to streams; implementations are allowed
to raise @ref{1b0e,,UnsupportedOperation} if they do not support a given operation.

The @ref{110f,,RawIOBase} ABC extends @ref{1f5,,IOBase}.  It deals with the reading
and writing of bytes to a stream.  @ref{1354,,FileIO} subclasses @ref{110f,,RawIOBase}
to provide an interface to files in the machine’s file system.

The @ref{694,,BufferedIOBase} ABC extends @ref{1f5,,IOBase}.  It deals with
buffering on a raw binary stream (@ref{110f,,RawIOBase}).  Its subclasses,
@ref{13f8,,BufferedWriter}, @ref{124e,,BufferedReader}, and @ref{13fa,,BufferedRWPair}
buffer raw binary streams that are writable, readable, and both readable and writable,
respectively. @ref{13f9,,BufferedRandom} provides a buffered interface to seekable streams.
Another @ref{694,,BufferedIOBase} subclass, @ref{ed3,,BytesIO}, is a stream of
in-memory bytes.

The @ref{695,,TextIOBase} ABC extends @ref{1f5,,IOBase}.  It deals with
streams whose bytes represent text, and handles encoding and decoding to and
from strings.  @ref{7bc,,TextIOWrapper}, which extends @ref{695,,TextIOBase}, is a buffered text
interface to a buffered raw stream (@ref{694,,BufferedIOBase}).  Finally,
@ref{f59,,StringIO} is an in-memory stream for text.

Argument names are not part of the specification, and only the arguments of
@ref{51c,,open()} are intended to be used as keyword arguments.

The following table summarizes the ABCs provided by the @ref{7f,,io} module:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ABC

@tab

Inherits

@tab

Stub Methods

@tab

Mixin Methods and Properties

@item

@ref{1f5,,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{110f,,RawIOBase}

@tab

@ref{1f5,,IOBase}

@tab

@code{readinto} and
@code{write}

@tab

Inherited @ref{1f5,,IOBase} methods, @code{read},
and @code{readall}

@item

@ref{694,,BufferedIOBase}

@tab

@ref{1f5,,IOBase}

@tab

@code{detach}, @code{read},
@code{read1}, and @code{write}

@tab

Inherited @ref{1f5,,IOBase} methods, @code{readinto},
and @code{readinto1}

@item

@ref{695,,TextIOBase}

@tab

@ref{1f5,,IOBase}

@tab

@code{detach}, @code{read},
@code{readline}, and
@code{write}

@tab

Inherited @ref{1f5,,IOBase} methods, @code{encoding},
@code{errors}, and @code{newlines}

@end multitable


@menu
* I/O Base Classes:: 
* Raw File I/O:: 
* Buffered Streams:: 
* E/S de texto: E/S de texto<2>. 

@end menu

@node I/O Base Classes,Raw File I/O,,hierarquia de classe
@anchor{library/io i-o-base-classes}@anchor{2df2}
@subsubsection I/O Base Classes


@geindex IOBase (classe em io)
@anchor{library/io io IOBase}@anchor{1f5}
@deffn {Classe} io.IOBase

The abstract base class for all I/O classes.

This class provides empty abstract implementations for many methods
that derived classes can override selectively; the default
implementations represent a file that cannot be read, written or
seeked.

Even though @ref{1f5,,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{202,,ValueError} (or @ref{1b0e,,UnsupportedOperation})
when operations they do not support are called.

The basic type used for binary data read from or written to a file is
@ref{1c2,,bytes}.  Other @ref{d4f,,bytes-like objects} are
accepted as method arguments too.  Text I/O classes work with @ref{44c,,str} data.

Note that calling any method (even inquiries) on a closed stream is
undefined.  Implementations may raise @ref{202,,ValueError} in this case.

@ref{1f5,,IOBase} (and its subclasses) supports the iterator protocol, meaning
that an @ref{1f5,,IOBase} object can be iterated over yielding the lines in a
stream.  Lines are defined slightly differently depending on whether the
stream is a binary stream (yielding bytes), or a text stream (yielding
character strings).  See @ref{241f,,readline()} below.

@ref{1f5,,IOBase} is also a context manager and therefore supports the
@ref{5d2,,with} statement.  In this example, `file' is closed after the
@code{with} statement’s suite is finished—even if an exception occurs:

@example
with open('spam.txt', 'w') as file:
    file.write('Spam and eggs!')
@end example

@ref{1f5,,IOBase} provides these data attributes and methods:

@geindex close() (método io.IOBase)
@anchor{library/io io IOBase close}@anchor{1f6}
@deffn {Método} close ()

Flush and close this stream. This method has no effect if the file is
already closed. Once the file is closed, any operation on the file
(e.g. reading or writing) will raise a @ref{202,,ValueError}.

As a convenience, it is allowed to call this method more than once;
only the first call, however, will have an effect.
@end deffn

@geindex closed (atributo io.IOBase)
@anchor{library/io io IOBase closed}@anchor{1ba4}
@deffn {Atributo} closed

@code{True} if the stream is closed.
@end deffn

@geindex fileno() (método io.IOBase)
@anchor{library/io io IOBase fileno}@anchor{15d0}
@deffn {Método} fileno ()

Return the underlying file descriptor (an integer) of the stream if it
exists.  An @ref{417,,OSError} is raised if the IO object does not use a file
descriptor.
@end deffn

@geindex flush() (método io.IOBase)
@anchor{library/io io IOBase flush}@anchor{2df3}
@deffn {Método} flush ()

Flush the write buffers of the stream if applicable.  This does nothing
for read-only and non-blocking streams.
@end deffn

@geindex isatty() (método io.IOBase)
@anchor{library/io io IOBase isatty}@anchor{1e09}
@deffn {Método} isatty ()

Return @code{True} if the stream is interactive (i.e., connected to
a terminal/tty device).
@end deffn

@geindex readable() (método io.IOBase)
@anchor{library/io io IOBase readable}@anchor{13f4}
@deffn {Método} readable ()

Return @code{True} if the stream can be read from.
If @code{False}, @code{read()} will raise @ref{417,,OSError}.
@end deffn

@geindex readline() (método io.IOBase)
@anchor{library/io io IOBase readline}@anchor{241f}
@deffn {Método} readline (size=-1, /)

Read and return one line from the stream.  If `size' is specified, at
most `size' bytes will be read.

The line terminator is always @code{b'\n'} for binary files; for text files,
the `newline' argument to @ref{51c,,open()} can be used to select the line
terminator(s) recognized.
@end deffn

@geindex readlines() (método io.IOBase)
@anchor{library/io io IOBase readlines}@anchor{24c7}
@deffn {Método} readlines (hint=-1, /)

Read and return a list of lines from the stream.  `hint' can be specified
to control the number of lines read: no more lines will be read if the
total size (in bytes/characters) of all lines so far exceeds `hint'.

`hint' values of @code{0} or less, as well as @code{None}, are treated as no
hint.

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 io.IOBase)
@anchor{library/io io IOBase seek}@anchor{12ce}
@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{12cf,,os.SEEK_SET} or @code{0} – start of the stream (the default);
`offset' should be zero or positive

@item 
@ref{12d0,,os.SEEK_CUR} or @code{1} – current stream position;
`offset' may be negative

@item 
@ref{12d1,,os.SEEK_END} or @code{2} – end of the stream;
`offset' is usually negative
@end itemize


Adicionado na versão 3.1: The @code{SEEK_*} constants.



Adicionado na versão 3.3: Some operating systems could support additional values, like
@ref{2d22,,os.SEEK_HOLE} or @ref{2d23,,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 io.IOBase)
@anchor{library/io io IOBase seekable}@anchor{13f6}
@deffn {Método} seekable ()

Return @code{True} if the stream supports random access.  If @code{False},
@ref{12ce,,seek()}, @ref{13f3,,tell()} and @ref{1355,,truncate()} will raise @ref{417,,OSError}.
@end deffn

@geindex tell() (método io.IOBase)
@anchor{library/io io IOBase tell}@anchor{13f3}
@deffn {Método} tell ()

Return the current stream position.
@end deffn

@geindex truncate() (método io.IOBase)
@anchor{library/io io IOBase truncate}@anchor{1355}
@deffn {Método} truncate (size=None, /)

Resize the stream to the given `size' in bytes (or the current position
if `size' is not specified).  The current stream position isn’t changed.
This resizing can extend or reduce the current file size.  In case of
extension, the contents of the new file area depend on the platform
(on most systems, additional bytes are zero-filled).  The new file size
is returned.


Alterado na versão 3.5: Windows will now zero-fill files when extending.

@end deffn

@geindex writable() (método io.IOBase)
@anchor{library/io io IOBase writable}@anchor{13f5}
@deffn {Método} writable ()

Return @code{True} if the stream supports writing.  If @code{False},
@code{write()} and @ref{1355,,truncate()} will raise @ref{417,,OSError}.
@end deffn

@geindex writelines() (método io.IOBase)
@anchor{library/io io IOBase writelines}@anchor{15a1}
@deffn {Método} writelines (lines, /)

Write a list of lines to the stream.  Line separators are not added, so it
is usual for each of the lines provided to have a line separator at the
end.
@end deffn

@geindex __del__() (método io.IOBase)
@anchor{library/io io IOBase __del__}@anchor{2df4}
@deffn {Método} __del__ ()

Prepare for object destruction. @ref{1f5,,IOBase} provides a default
implementation of this method that calls the instance’s
@ref{1f6,,close()} method.
@end deffn
@end deffn

@geindex RawIOBase (classe em io)
@anchor{library/io io RawIOBase}@anchor{110f}
@deffn {Classe} io.RawIOBase

Base class for raw binary streams.  It inherits from @ref{1f5,,IOBase}.

Raw binary streams typically provide low-level access to an underlying OS
device or API, and do not try to encapsulate it in high-level primitives
(this functionality is done at a higher-level in buffered binary streams and text streams, described later
in this page).

@ref{110f,,RawIOBase} provides these methods in addition to those from
@ref{1f5,,IOBase}:

@geindex read() (método io.RawIOBase)
@anchor{library/io io RawIOBase read}@anchor{e48}
@deffn {Método} read (size=-1, /)

Read up to `size' bytes from the object and return them.  As a convenience,
if `size' is unspecified or -1, all bytes until EOF are returned.
Otherwise, only one system call is ever made.  Fewer than `size' bytes may
be returned if the operating system call returns fewer than `size' bytes.

If 0 bytes are returned, and `size' was not 0, this indicates end of file.
If the object is in non-blocking mode and no bytes are available,
@code{None} is returned.

The default implementation defers to @ref{2df5,,readall()} and
@ref{e49,,readinto()}.
@end deffn

@geindex readall() (método io.RawIOBase)
@anchor{library/io io RawIOBase readall}@anchor{2df5}
@deffn {Método} readall ()

Read and return all the bytes from the stream until EOF, using multiple
calls to the stream if necessary.
@end deffn

@geindex readinto() (método io.RawIOBase)
@anchor{library/io io RawIOBase readinto}@anchor{e49}
@deffn {Método} readinto (b, /)

Read bytes into a pre-allocated, writable
@ref{d4f,,bytes-like object} `b', and return the
number of bytes read.  For example, `b' might be a @ref{2ea,,bytearray}.
If the object is in non-blocking mode and no bytes
are available, @code{None} is returned.
@end deffn

@geindex write() (método io.RawIOBase)
@anchor{library/io io RawIOBase write}@anchor{13f2}
@deffn {Método} write (b, /)

Write the given @ref{d4f,,bytes-like object}, `b', to the
underlying raw stream, and return the number of
bytes written.  This can be less than the length of `b' in
bytes, depending on specifics of the underlying raw
stream, and especially if it is in non-blocking mode.  @code{None} is
returned if the raw stream is set not to block and no single byte could
be readily written to it.  The caller may release or mutate `b' after
this method returns, so the implementation should only access `b'
during the method call.
@end deffn
@end deffn

@geindex BufferedIOBase (classe em io)
@anchor{library/io io BufferedIOBase}@anchor{694}
@deffn {Classe} io.BufferedIOBase

Base class for binary streams that support some kind of buffering.
It inherits from @ref{1f5,,IOBase}.

The main difference with @ref{110f,,RawIOBase} is that methods @ref{136d,,read()},
@ref{2df6,,readinto()} and @ref{cfc,,write()} will try (respectively) to read
as much input as requested or to emit all provided data.

In addition, if the underlying raw stream is in non-blocking mode, when the
system returns would block @ref{cfc,,write()} will raise @ref{1090,,BlockingIOError}
with @ref{2439,,BlockingIOError.characters_written} and @ref{136d,,read()} will return
data read so far or @code{None} if no data is available.

Besides, the @ref{136d,,read()} method does not have a default
implementation that defers to @ref{2df6,,readinto()}.

A typical @ref{694,,BufferedIOBase} implementation should not inherit from a
@ref{110f,,RawIOBase} implementation, but wrap one, like
@ref{13f8,,BufferedWriter} and @ref{124e,,BufferedReader} do.

@ref{694,,BufferedIOBase} provides or overrides these data attributes and
methods in addition to those from @ref{1f5,,IOBase}:

@geindex raw (atributo io.BufferedIOBase)
@anchor{library/io io BufferedIOBase raw}@anchor{13f7}
@deffn {Atributo} raw

The underlying raw stream (a @ref{110f,,RawIOBase} instance) that
@ref{694,,BufferedIOBase} deals with.  This is not part of the
@ref{694,,BufferedIOBase} API and may not exist on some implementations.
@end deffn

@geindex detach() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase detach}@anchor{2b49}
@deffn {Método} detach ()

Separate the underlying raw stream from the buffer and return it.

After the raw stream has been detached, the buffer is in an unusable
state.

Some buffers, like @ref{ed3,,BytesIO}, do not have the concept of a single
raw stream to return from this method.  They raise
@ref{1b0e,,UnsupportedOperation}.


Adicionado na versão 3.1.

@end deffn

@geindex read() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase read}@anchor{136d}
@deffn {Método} read (size=-1, /)

Read and return up to `size' bytes. If the argument is omitted, @code{None},
or negative read as much as possible.

Fewer bytes may be returned than requested. An empty @ref{1c2,,bytes} object
is returned if the stream is already at EOF. More than one read may be
made and calls may be retried if specific errors are encountered, see
@ref{dbd,,os.read()} and 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for more details. Less than size bytes
being returned does not imply that EOF is imminent.

When reading as much as possible the default implementation will use
@code{raw.readall} if available (which should implement
@ref{2df5,,RawIOBase.readall()}), otherwise will read in a loop until read
returns @code{None}, an empty @ref{1c2,,bytes}, or a non-retryable error. For
most streams this is to EOF, but for non-blocking streams more data may
become available.

@cartouche
@quotation Nota 
When the underlying raw stream is non-blocking, implementations may
either raise @ref{1090,,BlockingIOError} or return @code{None} if no data is
available. @ref{7f,,io} implementations return @code{None}.
@end quotation
@end cartouche
@end deffn

@geindex read1() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase read1}@anchor{2b38}
@deffn {Método} read1 (size=-1, /)

Read and return up to `size' bytes, calling @ref{e49,,readinto()}
which may retry if @ref{daf,,EINTR} is encountered per
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}. If `size' is @code{-1} or not provided, the implementation will
choose an arbitrary value for `size'.

@cartouche
@quotation Nota 
When the underlying raw stream is non-blocking, implementations may
either raise @ref{1090,,BlockingIOError} or return @code{None} if no data is
available. @ref{7f,,io} implementations return @code{None}.
@end quotation
@end cartouche
@end deffn

@geindex readinto() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase readinto}@anchor{2df6}
@deffn {Método} readinto (b, /)

Read bytes into a pre-allocated, writable
@ref{d4f,,bytes-like object} `b' and return the number of bytes read.
For example, `b' might be a @ref{2ea,,bytearray}.

Like @ref{136d,,read()}, multiple reads may be issued to the underlying raw
stream, unless the latter is interactive.

A @ref{1090,,BlockingIOError} is raised if the underlying raw stream is in non
blocking-mode, and has no data available at the moment.
@end deffn

@geindex readinto1() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase readinto1}@anchor{e47}
@deffn {Método} readinto1 (b, /)

Read bytes into a pre-allocated, writable
@ref{d4f,,bytes-like object} `b', using at most one call to
the underlying raw stream’s @ref{e48,,read()} (or
@ref{e49,,readinto()}) method. Return the number of bytes read.

A @ref{1090,,BlockingIOError} is raised if the underlying raw stream is in non
blocking-mode, and has no data available at the moment.


Adicionado na versão 3.5.

@end deffn

@geindex write() (método io.BufferedIOBase)
@anchor{library/io io BufferedIOBase write}@anchor{cfc}
@deffn {Método} write (b, /)

Write the given @ref{d4f,,bytes-like object}, `b', and return the number
of bytes written (always equal to the length of `b' in bytes, since if
the write fails an @ref{417,,OSError} will be raised).  Depending on the
actual implementation, these bytes may be readily written to the
underlying stream, or held in a buffer for performance and latency
reasons.

When in non-blocking mode, a @ref{1090,,BlockingIOError} is raised if the
data needed to be written to the raw stream but it couldn’t accept
all the data without blocking.

The caller may release or mutate `b' after this method returns,
so the implementation should only access `b' during the method call.
@end deffn
@end deffn

@node Raw File I/O,Buffered Streams,I/O Base Classes,hierarquia de classe
@anchor{library/io raw-file-i-o}@anchor{2df7}
@subsubsection Raw File I/O


@geindex FileIO (classe em io)
@anchor{library/io io FileIO}@anchor{1354}
@deffn {Classe} 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{110f,,RawIOBase}.

The `name' can be one of two things:


@itemize *

@item 
a character string or @ref{1c2,,bytes} object representing the path to the
file which will be opened. In this case closefd must be @code{True} (the default)
otherwise an error will be raised.

@item 
an integer representing the number of an existing OS-level file descriptor
to which the resulting @ref{1354,,FileIO} object will give access. When the
FileIO object is closed this fd will be closed as well, unless `closefd'
is set to @code{False}.
@end itemize

The `mode' can be @code{'r'}, @code{'w'}, @code{'x'} or @code{'a'} for reading
(default), writing, exclusive creation or appending. The file will be
created if it doesn’t exist when opened for writing or appending; it will be
truncated when opened for writing. @ref{1056,,FileExistsError} will be raised if
it already exists when opened for creating. Opening a file for creating
implies writing, so this mode behaves in a similar way to @code{'w'}. Add a
@code{'+'} to the mode to allow simultaneous reading and writing.

The @ref{e48,,read()} (when called with a positive argument),
@ref{e49,,readinto()} and @ref{13f2,,write()} methods on this
class will only make one system call.

A custom opener can be used by passing a callable as `opener'. The underlying
file descriptor for the file object is then obtained by calling `opener' with
(`name', `flags'). `opener' must return an open file descriptor (passing
@ref{dba,,os.open} as `opener' results in functionality similar to passing
@code{None}).

O arquivo recém-criado é @ref{f2b,,non-inheritable}.

See the @ref{51c,,open()} built-in function for examples on using the `opener'
parameter.


Alterado na versão 3.3: The `opener' parameter was added.
The @code{'x'} mode was added.



Alterado na versão 3.4: O arquivo agora é não herdável.


@ref{1354,,FileIO} provides these data attributes in addition to those from
@ref{110f,,RawIOBase} and @ref{1f5,,IOBase}:

@geindex mode (atributo io.FileIO)
@anchor{library/io io FileIO mode}@anchor{2df8}
@deffn {Atributo} mode

The mode as given in the constructor.
@end deffn

@geindex name (atributo io.FileIO)
@anchor{library/io io FileIO name}@anchor{2b53}
@deffn {Atributo} name

The file name.  This is the file descriptor of the file when no name is
given in the constructor.
@end deffn
@end deffn

@node Buffered Streams,E/S de texto<2>,Raw File I/O,hierarquia de classe
@anchor{library/io buffered-streams}@anchor{2df9}
@subsubsection Buffered Streams


Buffered I/O streams provide a higher-level interface to an I/O device
than raw I/O does.

@geindex BytesIO (classe em io)
@anchor{library/io io BytesIO}@anchor{ed3}
@deffn {Classe} io.BytesIO (initial_bytes=b'@w{'})

A binary stream using an in-memory bytes buffer.  It inherits from
@ref{694,,BufferedIOBase}.  The buffer is discarded when the
@ref{1f6,,close()} method is called.

The optional argument `initial_bytes' is a @ref{d4f,,bytes-like object} that
contains initial data.

@ref{ed3,,BytesIO} provides or overrides these methods in addition to those
from @ref{694,,BufferedIOBase} and @ref{1f5,,IOBase}:

@geindex getbuffer() (método io.BytesIO)
@anchor{library/io io BytesIO getbuffer}@anchor{1231}
@deffn {Método} getbuffer ()

Return a readable and writable view over the contents of the buffer
without copying them.  Also, mutating the view will transparently
update the contents of the buffer:

@example
>>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'
@end example

@cartouche
@quotation Nota 
As long as the view exists, the @ref{ed3,,BytesIO} object cannot be
resized or closed.
@end quotation
@end cartouche


Adicionado na versão 3.2.

@end deffn

@geindex getvalue() (método io.BytesIO)
@anchor{library/io io BytesIO getvalue}@anchor{2b36}
@deffn {Método} getvalue ()

Return @ref{1c2,,bytes} containing the entire contents of the buffer.
@end deffn

@geindex read1() (método io.BytesIO)
@anchor{library/io io BytesIO read1}@anchor{2dfa}
@deffn {Método} read1 (size=-1, /)

In @ref{ed3,,BytesIO}, this is the same as @ref{136d,,read()}.


Alterado na versão 3.7: The `size' argument is now optional.

@end deffn

@geindex readinto1() (método io.BytesIO)
@anchor{library/io io BytesIO readinto1}@anchor{2dfb}
@deffn {Método} readinto1 (b, /)

In @ref{ed3,,BytesIO}, this is the same as @ref{2df6,,readinto()}.


Adicionado na versão 3.5.

@end deffn
@end deffn

@geindex BufferedReader (classe em io)
@anchor{library/io io BufferedReader}@anchor{124e}
@deffn {Classe} io.BufferedReader (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a readable, non
seekable @ref{110f,,RawIOBase} raw binary stream.  It inherits from
@ref{694,,BufferedIOBase}.

When reading data from this object, a larger amount of data may be
requested from the underlying raw stream, and kept in an internal buffer.
The buffered data can then be returned directly on subsequent reads.

The constructor creates a @ref{124e,,BufferedReader} for the given readable
`raw' stream and `buffer_size'.  If `buffer_size' is omitted,
@ref{17ba,,DEFAULT_BUFFER_SIZE} is used.

@ref{124e,,BufferedReader} provides or overrides these methods in addition to
those from @ref{694,,BufferedIOBase} and @ref{1f5,,IOBase}:

@geindex peek() (método io.BufferedReader)
@anchor{library/io io BufferedReader peek}@anchor{2dfc}
@deffn {Método} peek (size=0, /)

Return bytes from the stream without advancing the position. The number of
bytes returned may be less or more than requested. If the underlying raw
stream is non-blocking and the operation would block, returns empty bytes.
@end deffn

@geindex read() (método io.BufferedReader)
@anchor{library/io io BufferedReader read}@anchor{2dfd}
@deffn {Método} read (size=-1, /)

In @ref{124e,,BufferedReader} this is the same as @ref{136d,,io.BufferedIOBase.read()}
@end deffn

@geindex read1() (método io.BufferedReader)
@anchor{library/io io BufferedReader read1}@anchor{2dfe}
@deffn {Método} read1 (size=-1, /)

In @ref{124e,,BufferedReader} this is the same as @ref{2b38,,io.BufferedIOBase.read1()}


Alterado na versão 3.7: The `size' argument is now optional.

@end deffn
@end deffn

@geindex BufferedWriter (classe em io)
@anchor{library/io io BufferedWriter}@anchor{13f8}
@deffn {Classe} io.BufferedWriter (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a writeable, non
seekable @ref{110f,,RawIOBase} raw binary stream.  It inherits from
@ref{694,,BufferedIOBase}.

When writing to this object, data is normally placed into an internal
buffer.  The buffer will be written out to the underlying @ref{110f,,RawIOBase}
object under various conditions, including:


@itemize *

@item 
when the buffer gets too small for all pending data;

@item 
when @ref{2dff,,flush()} is called;

@item 
when a @ref{12ce,,seek()} is requested (for @ref{13f9,,BufferedRandom} objects);

@item 
when the @ref{13f8,,BufferedWriter} object is closed or destroyed.
@end itemize

The constructor creates a @ref{13f8,,BufferedWriter} for the given writeable
`raw' stream.  If the `buffer_size' is not given, it defaults to
@ref{17ba,,DEFAULT_BUFFER_SIZE}.

@ref{13f8,,BufferedWriter} provides or overrides these methods in addition to
those from @ref{694,,BufferedIOBase} and @ref{1f5,,IOBase}:

@geindex flush() (método io.BufferedWriter)
@anchor{library/io io BufferedWriter flush}@anchor{2dff}
@deffn {Método} flush ()

Force bytes held in the buffer into the raw stream.  A
@ref{1090,,BlockingIOError} should be raised if the raw stream blocks.
@end deffn

@geindex write() (método io.BufferedWriter)
@anchor{library/io io BufferedWriter write}@anchor{2e00}
@deffn {Método} write (b, /)

Write the @ref{d4f,,bytes-like object}, `b', and return the
number of bytes written.  When in non-blocking mode, a
@ref{1090,,BlockingIOError} with @ref{2439,,BlockingIOError.characters_written} set
is raised if the buffer needs to be written out but the raw stream blocks.
@end deffn
@end deffn

@geindex BufferedRandom (classe em io)
@anchor{library/io io BufferedRandom}@anchor{13f9}
@deffn {Classe} io.BufferedRandom (raw, buffer_size=DEFAULT_BUFFER_SIZE)

A buffered binary stream providing higher-level access to a seekable
@ref{110f,,RawIOBase} raw binary stream.  It inherits from @ref{124e,,BufferedReader}
and @ref{13f8,,BufferedWriter}.

The constructor creates a reader and writer for a seekable raw stream, given
in the first argument.  If the `buffer_size' is omitted it defaults to
@ref{17ba,,DEFAULT_BUFFER_SIZE}.

@ref{13f9,,BufferedRandom} is capable of anything @ref{124e,,BufferedReader} or
@ref{13f8,,BufferedWriter} can do.  In addition, @ref{12ce,,seek()} and
@ref{13f3,,tell()} are guaranteed to be implemented.
@end deffn

@geindex BufferedRWPair (classe em io)
@anchor{library/io io BufferedRWPair}@anchor{13fa}
@deffn {Classe} io.BufferedRWPair (reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)

A buffered binary stream providing higher-level access to two non seekable
@ref{110f,,RawIOBase} raw binary streams—one readable, the other writeable.
It inherits from @ref{694,,BufferedIOBase}.

`reader' and `writer' are @ref{110f,,RawIOBase} objects that are readable and
writeable respectively.  If the `buffer_size' is omitted it defaults to
@ref{17ba,,DEFAULT_BUFFER_SIZE}.

@ref{13fa,,BufferedRWPair} implements all of @ref{694,,BufferedIOBase}'s methods
except for @ref{2b49,,detach()}, which raises
@ref{1b0e,,UnsupportedOperation}.

@cartouche
@quotation Aviso 
@ref{13fa,,BufferedRWPair} does not attempt to synchronize accesses to
its underlying raw streams.  You should not pass it the same object
as reader and writer; use @ref{13f9,,BufferedRandom} instead.
@end quotation
@end cartouche
@end deffn

@node E/S de texto<2>,,Buffered Streams,hierarquia de classe
@anchor{library/io id1}@anchor{2e01}
@subsubsection E/S de texto


@geindex TextIOBase (classe em io)
@anchor{library/io io TextIOBase}@anchor{695}
@deffn {Classe} io.TextIOBase

Base class for text streams.  This class provides a character and line based
interface to stream I/O.  It inherits from @ref{1f5,,IOBase}.

@ref{695,,TextIOBase} provides or overrides these data attributes and
methods in addition to those from @ref{1f5,,IOBase}:

@geindex encoding (atributo io.TextIOBase)
@anchor{library/io io TextIOBase encoding}@anchor{2e02}
@deffn {Atributo} encoding

The name of the encoding used to decode the stream’s bytes into
strings, and to encode strings into bytes.
@end deffn

@geindex errors (atributo io.TextIOBase)
@anchor{library/io io TextIOBase errors}@anchor{1353}
@deffn {Atributo} errors

The error setting of the decoder or encoder.
@end deffn

@geindex newlines (atributo io.TextIOBase)
@anchor{library/io io TextIOBase newlines}@anchor{2e03}
@deffn {Atributo} newlines

A string, a tuple of strings, or @code{None}, indicating the newlines
translated so far.  Depending on the implementation and the initial
constructor flags, this may not be available.
@end deffn

@geindex buffer (atributo io.TextIOBase)
@anchor{library/io io TextIOBase buffer}@anchor{12e5}
@deffn {Atributo} buffer

The underlying binary buffer (a @ref{694,,BufferedIOBase}
or @ref{110f,,RawIOBase} instance) that @ref{695,,TextIOBase} deals with.
This is not part of the @ref{695,,TextIOBase} API and may not exist
in some implementations.
@end deffn

@geindex detach() (método io.TextIOBase)
@anchor{library/io io TextIOBase detach}@anchor{15a8}
@deffn {Método} detach ()

Separate the underlying binary buffer from the @ref{695,,TextIOBase} and
return it.

After the underlying buffer has been detached, the @ref{695,,TextIOBase} is
in an unusable state.

Some @ref{695,,TextIOBase} implementations, like @ref{f59,,StringIO}, may not
have the concept of an underlying buffer and calling this method will
raise @ref{1b0e,,UnsupportedOperation}.


Adicionado na versão 3.1.

@end deffn

@geindex read() (método io.TextIOBase)
@anchor{library/io io TextIOBase read}@anchor{1e0c}
@deffn {Método} read (size=-1, /)

Read and return at most `size' characters from the stream as a single
@ref{44c,,str}.  If `size' is negative or @code{None}, reads until EOF.
@end deffn

@geindex readline() (método io.TextIOBase)
@anchor{library/io io TextIOBase readline}@anchor{1e46}
@deffn {Método} readline (size=-1, /)

Read until newline or EOF and return a single @ref{44c,,str}.  If the stream is
already at EOF, an empty string is returned.

If `size' is specified, at most `size' characters will be read.
@end deffn

@geindex seek() (método io.TextIOBase)
@anchor{library/io io TextIOBase seek}@anchor{2e04}
@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{2e05,,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

Return the new absolute position as an opaque number.


Adicionado na versão 3.1: The @code{SEEK_*} constants.

@end deffn

@geindex tell() (método io.TextIOBase)
@anchor{library/io io TextIOBase tell}@anchor{2e05}
@deffn {Método} tell ()

Return the current stream position as an opaque number.  The number
does not usually represent a number of bytes in the underlying
binary storage.
@end deffn

@geindex write() (método io.TextIOBase)
@anchor{library/io io TextIOBase write}@anchor{1dfb}
@deffn {Método} write (s, /)

Write the string `s' to the stream and return the number of characters
written.
@end deffn
@end deffn

@geindex TextIOWrapper (classe em io)
@anchor{library/io io TextIOWrapper}@anchor{7bc}
@deffn {Classe} 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{694,,BufferedIOBase} buffered binary stream.  It inherits from
@ref{695,,TextIOBase}.

`encoding' gives the name of the encoding that the stream will be decoded or
encoded with.  In @ref{656,,UTF-8 Mode}, this defaults to UTF-8.
Otherwise, it defaults to @ref{2dc,,locale.getencoding()}.
@code{encoding="locale"} can be used to specify the current locale’s encoding
explicitly. See @ref{7be,,Codificação do texto} for more information.

`errors' is an optional string that specifies how encoding and decoding
errors are to be handled.  Pass @code{'strict'} to raise a @ref{202,,ValueError}
exception if there is an encoding error (the default of @code{None} has the same
effect), or pass @code{'ignore'} to ignore errors.  (Note that ignoring encoding
errors can lead to data loss.)  @code{'replace'} causes a replacement marker
(such as @code{'?'}) to be inserted where there is malformed data.
@code{'backslashreplace'} causes malformed data to be replaced by a
backslashed escape sequence.  When writing, @code{'xmlcharrefreplace'}
(replace with the appropriate XML character reference)  or @code{'namereplace'}
(replace with @code{\N@{...@}} escape sequences) can be used.  Any other error
handling name that has been registered with
@ref{14e3,,codecs.register_error()} is also valid.

@geindex novas linhas universais;io.TextIOWrapper class

`newline' controls how line endings are handled.  It can be @code{None},
@code{'@w{'}}, @code{'\n'}, @code{'\r'}, and @code{'\r\n'}.  It works as follows:


@itemize *

@item 
When reading input from the stream, if `newline' is @code{None},
@ref{d5c,,universal newlines} mode is enabled.  Lines in the input can end in
@code{'\n'}, @code{'\r'}, or @code{'\r\n'}, and these are translated into @code{'\n'}
before being returned to the caller.  If `newline' is @code{'@w{'}}, universal
newlines mode is enabled, but line endings are returned to the caller
untranslated.  If `newline' has any of the other legal values, input lines
are only terminated by the given string, and the line ending is returned to
the caller untranslated.

@item 
Ao gravar a saída no fluxo, se `newline' for @code{None}, quaisquer caracteres @code{'\n'} gravados serão traduzidos para o separador de linhas padrão do sistema, @ref{2311,,os.linesep}. Se `newline' for @code{'@w{'}} ou @code{'\n'}, nenhuma tradução ocorrerá. Se `newline' for um dos outros valores legais, qualquer caractere @code{'\n'} escrito será traduzido para a string especificada.
@end itemize

If `line_buffering' is @code{True}, @ref{2df3,,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{cfc,,write()} are guaranteed
not to be buffered: any data written on the @ref{7bc,,TextIOWrapper}
object is immediately handled to its underlying binary `buffer'.


Alterado na versão 3.3: The `write_through' argument has been added.



Alterado na versão 3.3: The default `encoding' is now @code{locale.getpreferredencoding(False)}
instead of @code{locale.getpreferredencoding()}. Don’t change temporary the
locale encoding using @ref{2db,,locale.setlocale()}, use the current locale
encoding instead of the user preferred encoding.



Alterado na versão 3.10: The `encoding' argument now supports the @code{"locale"} dummy encoding name.


@ref{7bc,,TextIOWrapper} provides these data attributes and methods in
addition to those from @ref{695,,TextIOBase} and @ref{1f5,,IOBase}:

@geindex line_buffering (atributo io.TextIOWrapper)
@anchor{library/io io TextIOWrapper line_buffering}@anchor{2e06}
@deffn {Atributo} line_buffering

Whether line buffering is enabled.
@end deffn

@geindex write_through (atributo io.TextIOWrapper)
@anchor{library/io io TextIOWrapper write_through}@anchor{2e07}
@deffn {Atributo} write_through

Whether writes are passed immediately to the underlying binary
buffer.


Adicionado na versão 3.7.

@end deffn

@geindex reconfigure() (método io.TextIOWrapper)
@anchor{library/io io TextIOWrapper reconfigure}@anchor{b5e}
@deffn {Método} reconfigure (*, encoding=None, errors=None, newline=None, line_buffering=None, write_through=None)

Reconfigure this text stream using new settings for `encoding',
`errors', `newline', `line_buffering' and `write_through'.

Parameters not specified keep current settings, except
@code{errors='strict'} is used when `encoding' is specified but
`errors' is not specified.

It is not possible to change the encoding or newline if some data
has already been read from the stream. On the other hand, changing
encoding after write is possible.

This method does an implicit stream flush before setting the
new parameters.


Adicionado na versão 3.7.



Alterado na versão 3.11: The method supports @code{encoding="locale"} option.

@end deffn

@geindex seek() (método io.TextIOWrapper)
@anchor{library/io io TextIOWrapper seek}@anchor{2e08}
@deffn {Método} seek (cookie, whence=os.SEEK_SET, /)

Set the stream position.
Return the new stream position as an @ref{257,,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{15d4,,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 também


@ref{12cf,,os.SEEK_SET}, @ref{12d0,,os.SEEK_CUR}, and @ref{12d1,,os.SEEK_END}.

@end deffn

@geindex tell() (método io.TextIOWrapper)
@anchor{library/io io TextIOWrapper tell}@anchor{15d4}
@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{2e08,,seek()},
to restore a previous stream position.
@end deffn
@end deffn

@geindex StringIO (classe em io)
@anchor{library/io io StringIO}@anchor{f59}
@deffn {Classe} io.StringIO (initial_value='@w{'}, newline='\n')

A text stream using an in-memory text buffer.  It inherits from
@ref{695,,TextIOBase}.

The text buffer is discarded when the @ref{1f6,,close()} method is
called.

The initial value of the buffer can be set by providing `initial_value'.
If newline translation is enabled, newlines will be encoded as if by
@ref{1dfb,,write()}.  The stream is positioned at the start of the
buffer which emulates opening an existing file in a @code{w+} mode, making it
ready for an immediate write from the beginning or for a write that
would overwrite the initial value.  To emulate opening a file in an @code{a+}
mode ready for appending, use @code{f.seek(0, io.SEEK_END)} to reposition the
stream at the end of the buffer.

The `newline' argument works like that of @ref{7bc,,TextIOWrapper},
except that when writing output to the stream, if `newline' is @code{None},
newlines are written as @code{\n} on all platforms.

@ref{f59,,StringIO} provides this method in addition to those from
@ref{695,,TextIOBase} and @ref{1f5,,IOBase}:

@geindex getvalue() (método io.StringIO)
@anchor{library/io io StringIO getvalue}@anchor{2e09}
@deffn {Método} getvalue ()

Return a @ref{44c,,str} containing the entire contents of the buffer.
Newlines are decoded as if by @ref{1e0c,,read()}, although
the stream position is not changed.
@end deffn

Exemplo 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 novas linhas universais;io.IncrementalNewlineDecoder class

@geindex IncrementalNewlineDecoder (classe em io)
@anchor{library/io io IncrementalNewlineDecoder}@anchor{17bb}
@deffn {Classe} io.IncrementalNewlineDecoder

A helper codec that decodes newlines for @ref{d5c,,universal newlines} mode.
It inherits from @ref{2564,,codecs.IncrementalDecoder}.
@end deffn

@node Desempenho<3>,,hierarquia de classe,io — Ferramentas essenciais para trabalhar com fluxos
@anchor{library/io performance}@anchor{2e0a}
@subsubsection Desempenho


This section discusses the performance of the provided concrete I/O
implementations.

@menu
* E/S binária: E/S binária<2>. 
* E/S de texto: E/S de texto<3>. 
* Multi-threading: Multi-threading<3>. 
* Reentrancy:: 

@end menu

@node E/S binária<2>,E/S de texto<3>,,Desempenho<3>
@anchor{library/io id2}@anchor{2e0b}
@subsubsection E/S binária


By reading and writing only large chunks of data even when the user asks for a
single byte, buffered I/O hides any inefficiency in calling and executing the
operating system’s unbuffered I/O routines.  The gain depends on the OS and the
kind of I/O which is performed.  For example, on some modern OSes such as Linux,
unbuffered disk I/O can be as fast as buffered I/O.  The bottom line, however,
is that buffered I/O offers predictable performance regardless of the platform
and the backing device.  Therefore, it is almost always preferable to use
buffered I/O rather than unbuffered I/O for binary data.

@node E/S de texto<3>,Multi-threading<3>,E/S binária<2>,Desempenho<3>
@anchor{library/io id3}@anchor{2e0c}
@subsubsection E/S de 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{2e05,,tell()} and @ref{2e04,,seek()} are both quite slow
due to the reconstruction algorithm used.

@ref{f59,,StringIO}, however, is a native in-memory unicode container and will
exhibit similar speed to @ref{ed3,,BytesIO}.

@node Multi-threading<3>,Reentrancy,E/S de texto<3>,Desempenho<3>
@anchor{library/io multi-threading}@anchor{2e0d}
@subsubsection Multi-threading


@ref{1354,,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.

Binary buffered objects (instances of @ref{124e,,BufferedReader},
@ref{13f8,,BufferedWriter}, @ref{13f9,,BufferedRandom} and @ref{13fa,,BufferedRWPair})
protect their internal structures using a lock; it is therefore safe to call
them from multiple threads at once.

@ref{7bc,,TextIOWrapper} objects are not thread-safe.

@node Reentrancy,,Multi-threading<3>,Desempenho<3>
@anchor{library/io reentrancy}@anchor{2e0e}
@subsubsection Reentrancy


Binary buffered objects (instances of @ref{124e,,BufferedReader},
@ref{13f8,,BufferedWriter}, @ref{13f9,,BufferedRandom} and @ref{13fa,,BufferedRWPair})
are not reentrant.  While reentrant calls will not happen in normal situations,
they can arise from doing I/O in a @ref{c6,,signal} handler.  If a thread tries to
re-enter a buffered object which it is already accessing, a @ref{195,,RuntimeError}
is raised.  Note this doesn’t prohibit a different thread from entering the
buffered object.

The above implicitly extends to text files, since the @ref{51c,,open()} function
will wrap a buffered object inside a @ref{7bc,,TextIOWrapper}.  This includes
standard streams and therefore affects the built-in @ref{fa9,,print()} function as
well.

@node time — Acesso ao horário e conversões,logging — Recursos de registro de eventos para Python,io — Ferramentas essenciais para trabalhar com fluxos,Serviços Genéricos do Sistema Operacional
@anchor{library/time doc}@anchor{2e0f}@anchor{library/time module-time}@anchor{ee}@anchor{library/time time-time-access-and-conversions}@anchor{2e10}@anchor{library/time translation-repo}@anchor{2e11}
@subsection @code{time} — Acesso ao horário e conversões


@geindex module; time


__________________________________________________________________


Esse módulo provê várias funções relacionadas à tempo. Para funcionalidades relacionadas veja também os módulos @ref{30,,datetime} e @ref{14,,calendar}

Apesar desse módulo sempre estar disponível, nem todas as suas funções estão disponíveis em todas as plataformas. A maioria das funções definidas nesse módulo chamam funções da biblioteca da plataforma de C com mesmo nome.  Pode ser útil consultar a documentação da plataforma, pois da semântica dessas funções variam a depender da plataforma.

A seguir, uma explicação de algumas terminologias e convenções.

@geindex era
@anchor{library/time epoch}@anchor{2bf6}

@itemize *

@item 
O `era' (`epoch') é o ponto onde o tempo começa, o valor de retorno de @code{time.gmtime(0)}. É 1º de janeiro de 1970, 00:00:00 (UTC) em todas as plataformas.
@end itemize

@geindex segundos desde a era


@itemize *

@item 
O termo `segundos desde a era' refere-se ao número total de segundos decorrido desde a era, tipicamente excluindo-se os segundos bissextos@footnote{https://en.wikipedia.org/wiki/Leap_second}. Segundos bissextos são excluídos desse total em todas as plataformas compatíveis com POSIX.
@end itemize

@geindex Ano 2038


@itemize *

@item 
As funções desse módulo podem não conseguir tratar de datas e horários antes do @ref{2bf6,,epoch} ou muito distantes no futuro. O limite no futuro é determinado pela biblioteca C; para sistemas de 32 bit, geralmente é 2038.
@end itemize

@geindex Anos de 2 dígitos


@itemize *

@item 
A função @ref{1474,,strptime()} pode analisar anos de 2 dígitos quando é passado o código de formato @code{%y}. Quando anos de 2 dígitos são analisados, eles são convertidos de acordo com os padrões POSIX e ISO C: valores 69–99 são mapeados para 1969–1999, e valores 0–68 são mapeados para 2000–2068.
@end itemize

@geindex UTC
@geindex Tempo Universal Coordenado
@geindex Tempo Médio de Greenwich


@itemize *

@item 
UTC é Coordinated Universal Time@footnote{https://en.wikipedia.org/wiki/Coordinated_Universal_Time} (em português, Horário Universal Coordenado) e substituiu o GMT ou Greenwich Mean Time@footnote{https://en.wikipedia.org/wiki/Greenwich_Mean_Time} (em português, Horário Médio de Greenwich) como base da cronometragem internacional. A sigla UTC não é um erro, mas está em conformidade com um esquema de nomenclatura anterior, independente de idioma, para padrões de tempo como UT0, UT1 e UT2.
@end itemize

@geindex Horário de verão


@itemize *

@item 
DST é Daylight Saving Time (Horário de Verão), um ajuste de fuso horário por (normalmente) uma hora durante parte do ano. As regras de Horário de Verão são mágicas (determinadas por leis locais) e podem mudar de ano a ano. A biblioteca C possui uma tabela contendo as regras locais (normalmente lidas de um arquivo de sistema por flexibilidade) e nesse contexto é a única fonte de Conhecimento Verdadeiro.

@item 
A precisão de várias funções em tempo real podem ser menores do que o que pode estar sugerido pelas unidades nas quais seu valor ou argumento estão expressos. Por exemplo, na maioria dos sistemas Unix, o relógio “conta” apenas 50 ou 100 vezes por segundo.

@item 
Por outro lado, a precisão de @ref{254,,time()} e @ref{69d,,sleep()} é melhor do que suas equivalentes Unix: tempos são expressos como números em ponto flutuante, @ref{254,,time()} retorna o tempo mais preciso disponível (utilizando @code{gettimeofday()} do Unix, quando disponível) e @ref{69d,,sleep()} irá aceitar qualquer tempo como uma fração não zero (@code{select()} do Unix é utilizada para implementar isto, quando disponível).

@item 
O valor de tempo conforme retornado pelas @ref{1200,,gmtime()}, @ref{1541,,localtime()}, e @ref{1474,,strptime()}, e aceito pelas @ref{1227,,asctime()}, @ref{1228,,mktime()} e @ref{1229,,strftime()}, é uma sequência de 9 inteiros. Os valores retornados das @ref{1200,,gmtime()}, @ref{1541,,localtime()}, e @ref{1474,,strptime()} também oferecem nomes de atributo para campos individuais.

Veja @ref{d0b,,struct_time} para a descrição desses objetos.


Alterado na versão 3.3: O tipo @ref{d0b,,struct_time} foi estendido para prover os atributos @ref{2e12,,tm_gmtoff} e @ref{2e13,,tm_zone} quando a plataforma suporta os membros @code{struct tm} correspondentes



Alterado na versão 3.6: Os atributos @ref{2e12,,tm_gmtoff} e @ref{2e13,,tm_zone} da classe @ref{d0b,,struct_time} estão disponíveis em todas as plataformas agora.


@item 
Utilize as seguintes funções para converter entre representações de tempo:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

De

@tab

Para

@tab

Utilize

@item

segundos desde a era

@tab

@ref{d0b,,struct_time} em UTC

@tab

@ref{1200,,gmtime()}

@item

segundos desde a era

@tab

@ref{d0b,,struct_time} em tempo local

@tab

@ref{1541,,localtime()}

@item

@ref{d0b,,struct_time} em UTC

@tab

segundos desde a era

@tab

@ref{2678,,calendar.timegm()}

@item

@ref{d0b,,struct_time} em tempo local

@tab

segundos desde a era

@tab

@ref{1228,,mktime()}

@end multitable

@end itemize

@menu
* Funções: Funções<5>. 
* Constantes de ID de Relógio:: 
* Constantes de Fuso Horário:: 

@end menu

@node Funções<5>,Constantes de ID de Relógio,,time — Acesso ao horário e conversões
@anchor{library/time functions}@anchor{2e14}@anchor{library/time time-functions}@anchor{2e15}
@subsubsection Funções


@geindex asctime() (no módulo time)
@anchor{library/time time asctime}@anchor{1227}
@deffn {Função} time.asctime ([t])

Converte a tupla ou @ref{d0b,,struct_time} representando um tempo como retornado pela @ref{1200,,gmtime()} ou @ref{1541,,localtime()} para uma string com o seguinte formato: @code{'Sun Jun 20 23:21:05 1993'}. O campo dia contém dois caracteres e possui espaçamento se o dia é de apenas um dígito. Por exemplo, @code{'Wed Jun 9 04:26:40 1993'}.

Se `t' não é fornecido, o tempo atual como retornado por @ref{1541,,localtime()} é utilizado. Informação de localidade não é utilizada por @ref{1227,,asctime()}.

@cartouche
@quotation Nota 
Diferentemente da função em C de mesmo nome, @ref{1227,,asctime()} não adiciona uma nova linha em seguida.
@end quotation
@end cartouche
@end deffn

@geindex pthread_getcpuclockid() (no módulo time)
@anchor{library/time time pthread_getcpuclockid}@anchor{baa}
@deffn {Função} time.pthread_getcpuclockid (thread_id)

Retorna o `clk_id' do relógio de tempo de CPU específico da thread para a `thread_id' especificada.

Utilize a @ref{1199,,threading.get_ident()} ou o atributo @ref{2e16,,ident} dos objetos @ref{953,,threading.Thread} para obter um valor adequado para `thread_id'.

@cartouche
@quotation Aviso 
Passando um `thread_id' inválido ou expirado pode resultar em um comportamento indefinido, como, por exemplo, falha de segmentação.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Unix

Veja a página man para @code{pthread_getcpuclockid(3)@footnote{https://manpages.debian.org/pthread_getcpuclockid(3)}} para mais informações.


Adicionado na versão 3.7.

@end deffn

@geindex clock_getres() (no módulo time)
@anchor{library/time time clock_getres}@anchor{119c}
@deffn {Função} time.clock_getres (clk_id)

Retorna a resolução (precisão) do relógio `clk_id' especificado. Confira @ref{2d8e,,Constantes de ID de Relógio} para uma lista de valores aceitos para `clk_id'

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex clock_gettime() (no módulo time)
@anchor{library/time time clock_gettime}@anchor{119d}
@deffn {Função} time.clock_gettime (clk_id) -> float

Retorna o tempo to relógio `clk_id' especificado. Confira @ref{2d8e,,Constantes de ID de Relógio} para uma lista de valores aceitos para `clk_id'.

Use @ref{af4,,clock_gettime_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex clock_gettime_ns() (no módulo time)
@anchor{library/time time clock_gettime_ns}@anchor{af4}
@deffn {Função} time.clock_gettime_ns (clk_id) -> int

Semelhante à @ref{119d,,clock_gettime()}, mas retorna o tempo em nanossegundos.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.7.

@end deffn

@geindex clock_settime() (no módulo time)
@anchor{library/time time clock_settime}@anchor{119e}
@deffn {Função} time.clock_settime (clk_id, time: float)

Define o tempo do relógio `clk_id' especificado. Atualmente, @ref{69a,,CLOCK_REALTIME} é o único valor aceito para `clk_id'.

Use @ref{af5,,clock_settime_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.

@ref{1ed8,,Disponibilidade}: Unix, not Android, not iOS.


Adicionado na versão 3.3.

@end deffn

@geindex clock_settime_ns() (no módulo time)
@anchor{library/time time clock_settime_ns}@anchor{af5}
@deffn {Função} time.clock_settime_ns (clk_id, time: int)

Semelhante à @ref{119e,,clock_settime()}, mas define o tempo em nanossegundos.

@ref{1ed8,,Disponibilidade}: Unix, not Android, not iOS.


Adicionado na versão 3.7.

@end deffn

@geindex ctime() (no módulo time)
@anchor{library/time time ctime}@anchor{25f4}
@deffn {Função} time.ctime ([secs])

Converte um tempo expresso em segundos desde o @ref{2bf6,,epoch} para uma string de forma: @code{'Sun Jun 20 23:21:05 1993'} representando tempo local. O campo dia tem comprimento de dois caracteres e é deslocado por um espaço se o dia tem um único dígito. Por exemplo, @code{'Wed Jun 9 04:26:40 1993'}.

Se `secs' não é fornecido ou @ref{675,,None}, o tempo atual como retornado por @ref{254,,time()} é utilizado. @code{ctime(secs)} é equivalente a @code{asctime(localtime(secs))}. Informação de localidade não é utilizada por @ref{25f4,,ctime()}.
@end deffn

@geindex get_clock_info() (no módulo time)
@anchor{library/time time get_clock_info}@anchor{119b}
@deffn {Função} time.get_clock_info (name)

Obtém informação do relógio específico como um objeto espaço de nomes. Nomes de relógios suportados e as funções correspondentes para ler seus valores são:


@itemize *

@item 
@code{'monotonic'}: @ref{253,,time.monotonic()}

@item 
@code{'perf_counter'}: @ref{a92,,time.perf_counter()}

@item 
@code{'process_time'}: @ref{a93,,time.process_time()}

@item 
@code{'thread_time'}: @ref{93d,,time.thread_time()}

@item 
@code{'time'}: @ref{254,,time.time()}
@end itemize

O resultado tem os seguintes atributos:


@itemize -

@item 
`adjustable': @code{True} se o relógio puder ser configurado para avançar ou retroceder no tempo, @code{False} caso contrário. Não se refere a ajustes graduais da taxa NTP.

@item 
`implementation': O nome da função C subjacente utilizada para obter o valor do relógio. Confira @ref{2d8e,,Constantes de ID de Relógio} para valores possíveis.

@item 
`monotonic': @code{True} se o relógio não pode retornar a valores anteriores, backward, @code{False} contrário

@item 
`resolution': A resolução do relógio em segundos (@ref{2f7,,float})
@end itemize


Adicionado na versão 3.3.

@end deffn

@geindex gmtime() (no módulo time)
@anchor{library/time time gmtime}@anchor{1200}
@deffn {Função} time.gmtime ([secs])

Converte um tempo expresso em segundos desde o @ref{2bf6,,epoch} para uma @ref{d0b,,struct_time} em UTC onde o sinalizador de horário de verão é sempre zero. Se `secs' não é fornecido ou @ref{675,,None}, o tempo atual como retornado por @ref{254,,time()} é utilizado. Frações de segundo são ignoradas. Veja acima para uma descrição do objeto @ref{d0b,,struct_time}. Veja @ref{2678,,calendar.timegm()} para o inverso desta função.
@end deffn

@geindex localtime() (no módulo time)
@anchor{library/time time localtime}@anchor{1541}
@deffn {Função} time.localtime ([secs])

Como @ref{1200,,gmtime()}, mas converte para o tempo local. Se `secs' não é fornecido ou @ref{675,,None}, o  tempo atual como retornado por @ref{254,,time()} é utilizado.  O sinalizador de horário de verão é definido como @code{1} quando o Horário de verão for aplicável para o tempo fornecido.

@ref{1541,,localtime()} pode levantar @ref{885,,OverflowError}, se o registro de data e hora estiver fora de valores suportados pelas funções @code{localtime()} or @code{gmtime()} da plataforma C, e @ref{417,,OSError} no caso de @code{localtime()} ou @code{gmtime()} falharem. É comum É comum que isso seja restrito a anos de 1970 a 2038.
@end deffn

@geindex mktime() (no módulo time)
@anchor{library/time time mktime}@anchor{1228}
@deffn {Função} time.mktime (t)

Esta é a função inversa de @ref{1541,,localtime()}. Seu argumento é a @ref{d0b,,struct_time} ou uma tupla com 9 itens (sendo o sinalizador de horário de verão necessário; utilize @code{-1} como sinalizador de horário de verão quando este for desconhecido) que expressa o tempo em tempo `local', não UTC. Retorna um número em ponto flutuante, para ter compatibilidade com @ref{254,,time()}. Se o valor de entrada não puder ser representado como um tempo válido, ou @ref{885,,OverflowError} ou @ref{202,,ValueError} serão levantadas (o que irá depender se o valor inválido é capturado pelo Python ou por bibliotecas C subjacentes). A data mais recente para qual um tempo pode ser gerado é dependente da plataforma.
@end deffn

@geindex monotonic() (no módulo time)
@anchor{library/time time monotonic}@anchor{253}
@deffn {Função} time.monotonic () -> float

Retorna o valor (em frações de segundos) de um relógio monotônico, i.e. um relógio que não pode voltar a valores anteriores. O relógio não é afetado por atualizações do relógio do sistema. O ponto de referência do valor retornado é indefinido, portanto apenas a diferença entre os resultados de duas chamadas é válida.

Relógio:


@itemize *

@item 
No Windows, chama @code{QueryPerformanceCounter()} e @code{QueryPerformanceFrequency()}.

@item 
No macOS, chama @code{mach_absolute_time()} e @code{mach_timebase_info()}.

@item 
No HP-UX, chama @code{gethrtime()}.

@item 
Chama @code{clock_gettime(CLOCK_HIGHRES)} se disponível.

@item 
Do contrário, chama @code{clock_gettime(CLOCK_MONOTONIC)}.
@end itemize

Use @ref{af6,,monotonic_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.


Adicionado na versão 3.3.



Alterado na versão 3.5: A função agora está sempre disponível e o relógio agora é o mesmo para todos os processos.



Alterado na versão 3.10: No macOS, o relógio agora é o mesmo para todos os processos.

@end deffn

@geindex monotonic_ns() (no módulo time)
@anchor{library/time time monotonic_ns}@anchor{af6}
@deffn {Função} time.monotonic_ns () -> int

Semelhante à @ref{253,,monotonic()}, mas retorna tempo em nanossegundos.


Adicionado na versão 3.7.

@end deffn

@geindex perf_counter() (no módulo time)
@anchor{library/time time perf_counter}@anchor{a92}
@deffn {Função} time.perf_counter () -> float

@geindex benchmarking

Retorna o valor (em frações de segundo) de um contador de desempenho, i.e. um relógio com a maior resolução disponível para medir uma duração curta. Inclui o tempo decorrido durante a pausa. O relógio é o mesmo para todos os processos. O ponto de referência é do valor retornado é indefinido, portanto apenas a diferença entre resultados de duas chamadas é válida.

No CPython, use o mesmo relógio que @ref{253,,time.monotonic()} e é um relógio monotônico, ou seja, um relógio que não pode retroceder.

Use @ref{af7,,perf_counter_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.


Adicionado na versão 3.3.



Alterado na versão 3.10: No Windows, o relógio agora é o mesmo para todos os processos.



Alterado na versão 3.13: Usa o mesmo relógio que @ref{253,,time.monotonic()}.

@end deffn

@geindex perf_counter_ns() (no módulo time)
@anchor{library/time time perf_counter_ns}@anchor{af7}
@deffn {Função} time.perf_counter_ns () -> int

Semelhante à @ref{a92,,perf_counter()}, mas retorna o tempo em nanossegundos.


Adicionado na versão 3.7.

@end deffn

@geindex process_time() (no módulo time)
@anchor{library/time time process_time}@anchor{a93}
@deffn {Função} time.process_time () -> float

@geindex tempo da CPU
@geindex tempo do processador
@geindex benchmarking

Retorna o valor (em frações de segundo) da soma dos tempos do sistema e CPU de usuário do processo atual. Não inclui o tempo decorrido durante a pausa. É de todo o processo por definição. O ponto de referência do valor retornado é indefinido, então apenas a diferença dos resultados de duas chamadas é válida.

Use @ref{af8,,process_time_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.


Adicionado na versão 3.3.

@end deffn

@geindex process_time_ns() (no módulo time)
@anchor{library/time time process_time_ns}@anchor{af8}
@deffn {Função} time.process_time_ns () -> int

Semelhante à @ref{a93,,process_time()}, mas retorna o tempo em nanossegundos.


Adicionado na versão 3.7.

@end deffn

@geindex sleep() (no módulo time)
@anchor{library/time time sleep}@anchor{69d}
@deffn {Função} time.sleep (secs)

Suspende a execução da thread de chamada por um determinado número de segundos. O argumento pode ser um número de ponto flutuante para indicar um tempo de pausa mais preciso.

Se a pausa for interrompida por um sinal e nenhuma exceção for levantada pelo manipulador de sinal, a pausa será reiniciada com um tempo limite recalculado.

O tempo de suspensão pode ser maior do que o solicitado por um valor arbitrário, devido ao agendamento de outras atividades no sistema.

@subsubheading Implementação no Windows


No Windows, se `secs' é zero, a thread renuncia ao restante de sua fatia de tempo para qualquer outra thread que esteja pronto para executar. Se nenhuma outra thread estiver pronta pra ser executada, a função retorna imediatamente, e a thread continua a execução. No Windows 8.1 e mais novos a implementação usa um temporizador de alta resolução@footnote{https://learn.microsoft.com/windows/win32/api/synchapi/nf-synchapi-createwaitabletimerexw} que provê uma resolução de  100 nanossegundos. Se `secs' é zero, é usado @code{Sleep(0)}.

@subsubheading Implementação no Unix



@itemize *

@item 
Usa @code{clock_nanosleep()} se disponível (resolução: 1 nanossegundo);

@item 
Ou usa @code{nanosleep()} se disponível (resolução: 1 nanossegunda);

@item 
Ou usa @code{select()} (resolução: 1 microssegundo).
@end itemize

@cartouche
@quotation Nota 
Para emular um “no-op”, use @ref{1d99,,pass} em vez de @code{time.sleep(0)}.

Para abrir mão voluntariamente da CPU, especifique uma @ref{2dd5,,política de agendamento} em tempo real e use @ref{1150,,os.sched_yield()} em seu lugar.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{time.sleep} com o argumento @code{secs}.


Alterado na versão 3.5: A função agora pausa por pelo menos `secs' mesmo se a pausa é interrompido por um sinal, exceto se o tratador de sinal levanta uma exceção (veja 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para a explicação).



Alterado na versão 3.11: No Unix, as funções @code{clock_nanosleep()} e @code{nanosleep()} são agora usadas se estiverem disponíveis. No Windows, um temporizador aguardável é agora usado.



Alterado na versão 3.13: Levanta um evento de auditoria.

@end deffn

@geindex % (porcentagem);datetime@comma{} formato

@geindex strftime() (no módulo time)
@anchor{library/time time strftime}@anchor{1229}
@deffn {Função} time.strftime (format[, t])

Converte a tupla ou @ref{d0b,,struct_time} representando um tempo como retornado por @ref{1200,,gmtime()} ou @ref{1541,,localtime()} para uma string como especificado pelo argumento `format'. Se `t' não é fornecido, o tempo atual como retornado pela @ref{1541,,localtime()} é utilizado. `format' deve ser uma string. A exceção @ref{202,,ValueError} é levantada se qualquer campo em `t' está fora do intervalo permitido.

0 é um argumento legal para qualquer posição na tupla de tempo; se é normalmente ilegal, o valor é formado a um valor correto.

As diretivas a seguir podem ser incorporadas na string `format'. Elas estão mostradas sem os campos de comprimento e especificação de precisão opcionais, e estão substituídos pelos caracteres indicados no resultado da @ref{1229,,strftime()}:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Diretiva

@tab

Significado

@tab

Notas

@item

@code{%a}

@tab

Nome abreviado do dia da semana da localidade.

@tab

@item

@code{%A}

@tab

Nome completo do dia da semana da localidade.

@tab

@item

@code{%b}

@tab

Nome abreviado do mês da localidade.

@tab

@item

@code{%B}

@tab

Nome completo do mês da localidade.

@tab

@item

@code{%c}

@tab

Representação de data e hora apropriada da localidade.

@tab

@item

@code{%d}

@tab

Dia do mês como um número decimal [01,31].

@tab

@item

@code{%f}

@tab


@table @asis

@item Microssegundos como um número decimal

[000000,999999].
@end table

@tab

(1)

@item

@code{%H}

@tab

Hora (relógio 24 horas) como um número decimal [00,23].

@tab

@item

@code{%I}

@tab

Hora (relógio 12 horas) como um número decimal [01,12].

@tab

@item

@code{%j}

@tab

Dia do ano como um número decimal [001,366].

@tab

@item

@code{%m}

@tab

Mês como um número decimal [01,12].

@tab

@item

@code{%M}

@tab

Minuto como um número decimal [00,59].

@tab

@item

@code{%p}

@tab

Equivalente da localidade a AM ou PM.

@tab

(2)

@item

@code{%S}

@tab

Segundo como um número decimal [00,61].

@tab

(3)

@item

@code{%U}

@tab

Número da semana do ano (domingo como primeiro dia da semana) como um número decimal [00,53]. Todos os dias em um ano novo que precedem o primeiro domingo são considerados como estando na semana 0.

@tab

(4)

@item

@code{%u}

@tab

Dia da semana (segunda-feira é 1; domingo é 7) como um número decimal [1, 7].

@tab

@item

@code{%w}

@tab

Dia da semana como um número decimal [0(Domingo),6]

@tab

@item

@code{%W}

@tab

Número da semana do ano (segunda-feira como o primeiro dia da semana) como um número decimal [00,53]. Todos os dias do ano que precedem o primeiro domingo serão considerados como estando na semana 0.

@tab

(4)

@item

@code{%x}

@tab

Representação de data apropriada de localidade.

@tab

@item

@code{%X}

@tab

Representação de hora apropriada da localidade.

@tab

@item

@code{%y}

@tab

Ano sem século como um número decimal [00,99].

@tab

@item

@code{%Y}

@tab

Ano com século como um número decimal.

@tab

@item

@code{%z}

@tab

Deslocamento de fuso horário indicando uma diferença de tempo positiva ou negativa de UTC/GMT formatado como +HHMM ou -HHMM, onde H representa os dígitos decimais de hora e M representa os dígitos decimais de minuto [-23:59, +23:59]. @footnote{
A utilização de @code{%Z} está descontinuada, mas o escape @code{%z} que expande para um deslocamento hora/minuto preferido não é suportado por todas as bibliotecas ANSI C. Além disso, a leitura do padrão original 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} de 1982 mostra que este pede um ano com dois dígitos (@code{%y} em vez de @code{%Y}), mas a prática consolidou a utilização de anos com 4 dígitos mesmo antes dos anos 2000. Após isso, o 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} tornou-se obsoleto e o ano de 4 dígitos foi primeiro recomendado por 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} e depois obrigatório por 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}, com 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} continuando este requisito.
}

@tab

@item

@code{%Z}

@tab

Nome do fuso horário (nenhum caractere se nenhum fuso horário existe). Descontinuado. @footnote{
A utilização de @code{%Z} está descontinuada, mas o escape @code{%z} que expande para um deslocamento hora/minuto preferido não é suportado por todas as bibliotecas ANSI C. Além disso, a leitura do padrão original 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} de 1982 mostra que este pede um ano com dois dígitos (@code{%y} em vez de @code{%Y}), mas a prática consolidou a utilização de anos com 4 dígitos mesmo antes dos anos 2000. Após isso, o 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} tornou-se obsoleto e o ano de 4 dígitos foi primeiro recomendado por 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} e depois obrigatório por 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}, com 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} continuando este requisito.
}

@tab

@item

@code{%G}

@tab

Ano ISO 8601 (semelhante a @code{%Y}, mas segue as regras para o ano calendário ISO 8601). O ano começa com a semana que contém a primeira quinta-feira do ano calendário.

@tab

@item

@code{%V}

@tab

Número da semana ISO 8601 (como um número decimal [01,53]). A primeira semana do ano é aquela que contém a primeira quinta-feira do ano. As semanas começam na segunda-feira.

@tab

@item

@code{%%}

@tab

Um caractere literal @code{'%'}.

@tab

@end multitable


Notas:


@enumerate 

@item 
A diretiva de formatação @code{%f} é somente aplicada para @ref{1474,,strptime()}, não para @ref{1229,,strftime()}. Contudo, veja também @ref{16f6,,datetime.datetime.strptime()} e @ref{caf,,datetime.datetime.strftime()} onde a diretiva de formatação @code{%f}  @ref{25c6,,é aplicada para microssegundos}.

@item 
Quando utilizado com a função @ref{1474,,strptime()}, a diretiva @code{%p} apenas afeta a saída do campo se a diretiva @code{%I} é utilizada para analisar a hora.
@end enumerate
@anchor{library/time leap-second}@anchor{2e17}

@enumerate 3

@item 
O intervalo é realmente @code{0} até @code{61}; o valor @code{60} é válido em registros de data e hora  representando segundos bissextos@footnote{https://en.wikipedia.org/wiki/Leap_second} e o valor @code{61} é suportado por razões históricas.

@item 
Quando utilizado co a função @ref{1474,,strptime()}, @code{%U} e @code{%W} são utilizados em cálculos apenas quando o dia da semana e ano são especificados.
@end enumerate

Veja este exemplo, um formato para datas compatível com as especificações dos padrões de e-mail 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}. @footnote{
A utilização de @code{%Z} está descontinuada, mas o escape @code{%z} que expande para um deslocamento hora/minuto preferido não é suportado por todas as bibliotecas ANSI C. Além disso, a leitura do padrão original 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} de 1982 mostra que este pede um ano com dois dígitos (@code{%y} em vez de @code{%Y}), mas a prática consolidou a utilização de anos com 4 dígitos mesmo antes dos anos 2000. Após isso, o 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} tornou-se obsoleto e o ano de 4 dígitos foi primeiro recomendado por 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} e depois obrigatório por 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}, com 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} continuando este requisito.
}

@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

Diretivas adicionais podem ser suportadas por algumas plataformas, mas apenas as listadas aqui possuem significado padronizado por ANSI C. Para ver a lista completa de códigos de formato suportados na sua plataforma, consulte a documentação @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}}.

Em algumas plataformas, um campo adicional de comprimento e especificação de precisão podem seguir imediatamente após @code{'%'} como uma diretiva da seguinte ordem; isto também não é portátil. O campo comprimento normalmente é 2 exceto para @code{%j} quando é 3.
@end deffn

@geindex % (porcentagem);datetime@comma{} formato

@geindex strptime() (no módulo time)
@anchor{library/time time strptime}@anchor{1474}
@deffn {Função} time.strptime (string[, format])

Analisa a string representando um tempo de acordo com um formato. O valor retornado é um @ref{d0b,,struct_time} como retornado por @ref{1200,,gmtime()} ou @ref{1541,,localtime()}.

O parâmetro `format' utiliza as mesmas diretivas das utilizadas por @ref{1229,,strftime()}; é definido por padrão para @code{"%a %b %d %H:%M:%S %Y"} que corresponde com a formatação retornada por @ref{25f4,,ctime()}. Se `string' não puder ser analisada de acordo com `format', ou se possui excesso de dados após analisar, @ref{202,,ValueError} é levantado. Os valores padrão utilizados para preencher quaisquer dados faltantes quando valores mais precisos não puderem ser inferidos são @code{(1900, 1, 1, 0, 0, 0, 0, 1, -1)}. Ambos `string' e `format' devem ser strings.

Por exemplo:

@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

Suporte para a diretiva @code{%Z} é baseado nos valores contidos em @code{tzname} e se @code{daylight} é verdade.  Por causa disso, é específico de plataforma exceto por reconhecer UTC e GMT, que são sempre conhecidos (e considerados fuso horários sem horários de verão).

Apenas as diretivas especificadas na documentação são suportadas. Como @code{strftime()} é implementada por plataforma, esta pode apenas as vezes oferecer mais diretivas do que as listadas aqui. Mas @code{strptime()} é independente de quaisquer plataformas e portanto não necessariamente suporta todas as diretivas disponíveis que não estão documentadas como suportadas.
@end deffn

@geindex struct_time (classe em time)
@anchor{library/time time struct_time}@anchor{d0b}
@deffn {Classe} time.struct_time

O tipo da sequência de valor de tempo retornado por @ref{1200,,gmtime()}, @ref{1541,,localtime()}, e @ref{1474,,strptime()}. É um objeto com uma interface @ref{64e,,named tuple}: os valores podem ser acessados por um índice e por um nome de atributo. Os seguintes valores estão presentes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

Índice

@tab

Atributo

@tab

Valores

@item

0

@tab

@geindex tm_year (atributo time.struct_time)
@anchor{library/time time struct_time tm_year}@anchor{1540}
@deffn {Atributo} tm_year
@end deffn

@tab

(por exemplo, 1993)

@item

1

@tab

@geindex tm_mon (atributo time.struct_time)
@anchor{library/time time struct_time tm_mon}@anchor{2e18}
@deffn {Atributo} tm_mon
@end deffn

@tab

intervalo [1,12]

@item

2

@tab

@geindex tm_mday (atributo time.struct_time)
@anchor{library/time time struct_time tm_mday}@anchor{2e19}
@deffn {Atributo} tm_mday
@end deffn

@tab

intervalo [1,31]

@item

3

@tab

@geindex tm_hour (atributo time.struct_time)
@anchor{library/time time struct_time tm_hour}@anchor{2e1a}
@deffn {Atributo} tm_hour
@end deffn

@tab

intervalo [0,23]

@item

4

@tab

@geindex tm_min (atributo time.struct_time)
@anchor{library/time time struct_time tm_min}@anchor{2e1b}
@deffn {Atributo} tm_min
@end deffn

@tab

intervalo [0,59]

@item

5

@tab

@geindex tm_sec (atributo time.struct_time)
@anchor{library/time time struct_time tm_sec}@anchor{2e1c}
@deffn {Atributo} tm_sec
@end deffn

@tab

intervalo [0, 61]; veja @ref{2e17,,Nota (2)} em @ref{1229,,strftime()}

@item

6

@tab

@geindex tm_wday (atributo time.struct_time)
@anchor{library/time time struct_time tm_wday}@anchor{2e1d}
@deffn {Atributo} tm_wday
@end deffn

@tab

intervalo [0, 6]; segunda-feira é 0

@item

7

@tab

@geindex tm_yday (atributo time.struct_time)
@anchor{library/time time struct_time tm_yday}@anchor{2e1e}
@deffn {Atributo} tm_yday
@end deffn

@tab

intervalo [1, 366]

@item

8

@tab

@geindex tm_isdst (atributo time.struct_time)
@anchor{library/time time struct_time tm_isdst}@anchor{2605}
@deffn {Atributo} tm_isdst
@end deffn

@tab

0, 1 ou -1; veja abaixo

@item

N/D

@tab

@geindex tm_zone (atributo time.struct_time)
@anchor{library/time time struct_time tm_zone}@anchor{2e13}
@deffn {Atributo} tm_zone
@end deffn

@tab

abreviação do nome do fuso horário

@item

N/D

@tab

@geindex tm_gmtoff (atributo time.struct_time)
@anchor{library/time time struct_time tm_gmtoff}@anchor{2e12}
@deffn {Atributo} tm_gmtoff
@end deffn

@tab

deslocamento a leste de UTC em segundos

@end multitable


Note que diferentemente da estrutura C, o valor do mês é um intervalo [1,12] e não [0,11].

Em chamadas para @ref{1228,,mktime()}, @ref{2605,,tm_isdst} pode ser definido como 1 quando o horário de verão estiver em efeito, e 0 quando não. Um valor de -1 indica que esta informação não é conhecida, e geralmente resultará no preenchimento do estado correto.

Quando uma tupla com comprimento incorreto é passada para uma função que espera por um @ref{d0b,,struct_time}, ou por possuir elementos do tipo errado, um @ref{2c3,,TypeError} é levantado.
@end deffn

@geindex time() (no módulo time)
@anchor{library/time time time}@anchor{254}
@deffn {Função} time.time () -> float

Retorna o tempo em segundos desde o @ref{2bf6,,epoch} como um número em ponto flutuante. A manipulação de segundos bissextos@footnote{https://en.wikipedia.org/wiki/Leap_second} é dependente da plataforma. No Windows e na maioria dos sistemas Unix, o segundo bissexto não é contado para o tempo desde o @ref{2bf6,,epoch}. Isso é comumente referido como epoch ou era Unix@footnote{https://en.wikipedia.org/wiki/Unix_time}.

Note que mesmo o tempo sendo retornado sempre como um número em ponto flutuante, nem todos os sistemas fornecem o tempo com precisão melhor que 1 segundo. Enquanto esta função normalmente retorna valores não decrescentes, pode retornar valores menores do que os de uma chamada anterior se o relógio do sistema foi redefinido entre duas chamadas.

O número retornado por @ref{254,,time()} pode ser convertido a um formato de tempo mais comum (i.e. ano, mês, dia, hora etc…) em UTC por passá-lo para a função @ref{1200,,gmtime()} ou em tempo local por passar para a função @ref{1541,,localtime()}. Em ambos os casos, o objeto @ref{d0b,,struct_time} é retornado, por onde os componentes de data do calendário podem ser acessados ou atribuídos.

Relógio:


@itemize *

@item 
No Windows, chama @code{GetSystemTimePreciseAsFileTime()}.

@item 
Chama @code{clock_gettime(CLOCK_REALTIME)} se disponível.

@item 
Caso contrário, chama @code{gettimeofday()}.
@end itemize

Use @ref{af9,,time_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.
@end deffn


Alterado na versão 3.13: No Windows, chama @code{GetSystemTimePreciseAsFileTime()} em vez de @code{GetSystemTimeAsFileTime()}.


@geindex time_ns() (no módulo time)
@anchor{library/time time time_ns}@anchor{af9}
@deffn {Função} time.time_ns () -> int

Semelhante à @ref{254,,time()}, mas retorna o tempo como um número inteiro de nanossegundos desde o @ref{2bf6,,epoch}.


Adicionado na versão 3.7.

@end deffn

@geindex thread_time() (no módulo time)
@anchor{library/time time thread_time}@anchor{93d}
@deffn {Função} time.thread_time () -> float

@geindex tempo da CPU
@geindex tempo do processador
@geindex benchmarking

Retorna o valor (em fração de segundos) da soma dos tempos de sistema e CPU de usuário para a thread atual. Não inclui o tempo decorrido durante a pausa. É específico a thread por definição. O ponto de referência do valor retornado é indefinido, então apenas a diferença dos resultados de duas chamadas é válida.

Use @ref{ba9,,thread_time_ns()} para evitar perda de precisão causada pelo tipo @ref{2f7,,float}.

@ref{1ed8,,Disponibilidade}: Linux, Unix, Windows.

Sistemas Unix possuem suporte para @code{CLOCK_THREAD_CPUTIME_ID}.


Adicionado na versão 3.7.

@end deffn

@geindex thread_time_ns() (no módulo time)
@anchor{library/time time thread_time_ns}@anchor{ba9}
@deffn {Função} time.thread_time_ns () -> int

Semelhante à @ref{93d,,thread_time()}, mas retorna o tempo em nanossegundos.


Adicionado na versão 3.7.

@end deffn

@geindex tzset() (no módulo time)
@anchor{library/time time tzset}@anchor{2e1f}
@deffn {Função} time.tzset ()

Redefine as regras de conversão utilizadas pelas rotinas da biblioteca. A variável de ambiente 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ} especifica como isto é feito. Também irá redefinir as variáveis @code{tzname} (da variável de ambiente 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ}), @code{timezone} (segundos sem horário de verão a oeste de UTC), @code{altzone} (segundos com horário de verão a oeste de UTC) e @code{daylight} (para 0 se este fuso horário não possui nenhuma regra de horário de verão, ou diferente de zero se há um tempo, no presente, passado ou futuro quando o horário de verão se aplica).

@ref{1ed8,,Disponibilidade}: Unix.

@cartouche
@quotation Nota 
Embora em vários casos, alterar a variável de sistema 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ} pode afetar a saída de funções como @ref{1541,,localtime()} sem chamar @ref{2e1f,,tzset()}, este comportamento não deve ser confiado.

A variável de sistema 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ} não deve conter espaços em branco.
@end quotation
@end cartouche

O formato padrão da variável de sistema 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ} é (espaços foram adicionados por motivos de clareza):

@example
std offset [dst [offset [,start[/time], end[/time]]]]
@end example

Onde os componentes são:


@table @asis

@item @code{std} e @code{dst}

Três ou mais alfanuméricos fornecendo a abreviação do fuso horário. Estes serão propagados para time.tzname

@item @code{offset}

O deslocamento tem a forma: @code{± hh[:mm[:ss]]}. Isso indica que o valor adicionado adicionou o horário local para chegar a UTC. Se precedido por um ‘-’, o fuso horário está a leste do Meridiano Primário; do contrário, está a oeste. Se nenhum deslocamento segue o horário de verão, o tempo no verão é presumido como estando uma hora a frente do horário padrão.

@item @code{start[/time], end[/time]}

Indica quando mudar e voltar do Horário de Verão. O formato das datas de início e fim é um dos seguintes:


@table @asis

@item @code{J@var{n}}

I dia juliano `n' (1 <= `n' <= 365). Os dias bissextos não são contados, então, em todos os anos, 28 de fevereiro é o dia 59 e 1 de março é o dia 60.

@item @code{@var{n}}

O dia juliano baseado em zero (0 <= `n' <= 365). Dias bissextos são contados, e é possível fazer referência a 29 de fevereiro.

@item @code{M@var{m}.@var{n}.@var{d}}

O `d'-ésimo dia (0 <= `d' <= 6) da semana `n' do mês `m' do ano (1 <= `n' <= 5, 1 <= `m' <= 12, onde semana 5 significa “o último dia `d' no mês `m'” que pode ocorrer tanto na quarta como quinta semana). Semana 1 é a primeira semana na qual o `d'-ésimo dia ocorre. Dia zero é o domingo.
@end table

@code{time} tem o mesmo formato que @code{offset}, exceto que nenhum sinal no início é permitido (‘-’ ou ‘+’). O padrão, se o tempo não é dado, é 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

Em muitos sistemas Unix (incluindo *BSD, Linux, Solaris, e Darwin), é mais conveniente utilizar o banco de dados de informação de fuso do sistema (@code{tzfile(5)@footnote{https://manpages.debian.org/tzfile(5)}}) para especificar as regras de fuso horário. Para fazer isso, defina a variável de sistema 
@geindex TZ
@geindex variável de ambiente; TZ
@code{TZ} ao path do arquivo de dados requerido de fuso horários, relativo à raiz do banco de dados de fuso horário ‘zoneinfo’ do sistema, geralmente encontrado em @code{/usr/share/zoneinfo}. Por exemplo, @code{'US/Eastern'}, @code{'Australia/Melbourne'}, @code{'Egypt'} ou @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 Relógio,Constantes de Fuso Horário,Funções<5>,time — Acesso ao horário e conversões
@anchor{library/time clock-id-constants}@anchor{2e20}@anchor{library/time time-clock-id-constants}@anchor{2d8e}
@subsubsection Constantes de ID de Relógio


Essas constantes são utilizadas como parâmetros para @ref{119c,,clock_getres()} e @ref{119d,,clock_gettime()}.

@geindex CLOCK_BOOTTIME (no módulo time)
@anchor{library/time time CLOCK_BOOTTIME}@anchor{ba6}
@deffn {Dado} time.CLOCK_BOOTTIME

Idêntica a @ref{699,,CLOCK_MONOTONIC}, exceto por também incluir qualquer tempo que o sistema está suspenso.

Isto permite que aplicações recebam um relógio monotônico consciente suspenso sem precisar lidar com as complicações de @ref{69a,,CLOCK_REALTIME}, que pode conter descontinuidades se o tempo é alterado utilizando @code{settimeofday()} ou algo semelhante.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.39.


Adicionado na versão 3.7.

@end deffn

@geindex CLOCK_HIGHRES (no módulo time)
@anchor{library/time time CLOCK_HIGHRES}@anchor{2e21}
@deffn {Dado} time.CLOCK_HIGHRES

O Solaris OS possui um timer @code{CLOCK_HIGHRES} que tenta utilizar recursos otimizados do hardware, e pode fornecer resolução perto de nanossegundos. @code{CLOCK_HIGHRES} é o relógio nanoajustável de alta resolução.

@ref{1ed8,,Disponibilidade}: Solaris.


Adicionado na versão 3.3.

@end deffn

@geindex CLOCK_MONOTONIC (no módulo time)
@anchor{library/time time CLOCK_MONOTONIC}@anchor{699}
@deffn {Dado} time.CLOCK_MONOTONIC

Relógio que não pode ser definido e representa um tempo monotônico desde um ponto de início não especificado.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW (no módulo time)
@anchor{library/time time CLOCK_MONOTONIC_RAW}@anchor{2e22}
@deffn {Dado} time.CLOCK_MONOTONIC_RAW

Semelhante à @ref{699,,CLOCK_MONOTONIC}, mas fornece acesso a um tempo bruto baseado em hardware que não está sujeito a ajustes NTP.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.28, macOS >= 10.12.


Adicionado na versão 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW_APPROX (no módulo time)
@anchor{library/time time CLOCK_MONOTONIC_RAW_APPROX}@anchor{2e23}
@deffn {Dado} time.CLOCK_MONOTONIC_RAW_APPROX

Semelhante a @ref{2e22,,CLOCK_MONOTONIC_RAW}, mas lê um armazenado pelo sistema no gerenciador de contexto e, portanto, tem menor precisão.

@ref{1ed8,,Disponibilidade}: macOS >= 10.12.


Adicionado na versão 3.13.

@end deffn

@geindex CLOCK_PROCESS_CPUTIME_ID (no módulo time)
@anchor{library/time time CLOCK_PROCESS_CPUTIME_ID}@anchor{2e24}
@deffn {Dado} time.CLOCK_PROCESS_CPUTIME_ID

Timer de alta resolução por processo no CPU.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex CLOCK_PROF (no módulo time)
@anchor{library/time time CLOCK_PROF}@anchor{ba7}
@deffn {Dado} time.CLOCK_PROF

Timer de alta resolução por processo no CPU.

@ref{1ed8,,Disponibilidade}: FreeBSD, NetBSD >= 7, OpenBSD.


Adicionado na versão 3.7.

@end deffn

@geindex CLOCK_TAI (no módulo time)
@anchor{library/time time CLOCK_TAI}@anchor{1ae4}
@deffn {Dado} time.CLOCK_TAI

Tempo Atômico Internacional@footnote{https://www.nist.gov/pml/time-and-frequency-division/how-utcnist-related-coordinated-universal-time-utc-international}

O sistema deve ter uma tabela de segundos bissextos para que possa fornecer a resposta correta. Softwares PTP ou NTP podem manter uma tabela de segundos bissextos.

@ref{1ed8,,Disponibilidade}: Linux.


Adicionado na versão 3.9.

@end deffn

@geindex CLOCK_THREAD_CPUTIME_ID (no módulo time)
@anchor{library/time time CLOCK_THREAD_CPUTIME_ID}@anchor{2e25}
@deffn {Dado} time.CLOCK_THREAD_CPUTIME_ID

Relógio de tempo de CPU específico a thread.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@geindex CLOCK_UPTIME (no módulo time)
@anchor{library/time time CLOCK_UPTIME}@anchor{ba8}
@deffn {Dado} time.CLOCK_UPTIME

Tempo cujo valor absoluto é o tempo que o sistema está sendo executado e não suspenso, fornecendo medidas de tempo de atividade precisas, tanto em valor absoluto quanto intervalo.

@ref{1ed8,,Disponibilidade}: FreeBSD, OpenBSD >= 5.5.


Adicionado na versão 3.7.

@end deffn

@geindex CLOCK_UPTIME_RAW (no módulo time)
@anchor{library/time time CLOCK_UPTIME_RAW}@anchor{a4c}
@deffn {Dado} time.CLOCK_UPTIME_RAW

Relógio que incrementa de forma monotônica, contando o tempo desde um ponto arbitrário, não afetado pela frequência ou ajustes de tempo e não incrementado enquanto o sistema está dormindo.

@ref{1ed8,,Disponibilidade}: macOS >= 10.12.


Adicionado na versão 3.8.

@end deffn

@geindex CLOCK_UPTIME_RAW_APPROX (no módulo time)
@anchor{library/time time CLOCK_UPTIME_RAW_APPROX}@anchor{2e26}
@deffn {Dado} time.CLOCK_UPTIME_RAW_APPROX

Semelhante a @ref{a4c,,CLOCK_UPTIME_RAW}, mas o valor é armazenado pelo sistema no gerenciador de contexto e, portanto, tem menor precisão.

@ref{1ed8,,Disponibilidade}: macOS >= 10.12.


Adicionado na versão 3.13.

@end deffn

A constante a seguir é o único parâmetro que pode ser enviado para @ref{119e,,clock_settime()}.

@geindex CLOCK_REALTIME (no módulo time)
@anchor{library/time time CLOCK_REALTIME}@anchor{69a}
@deffn {Dado} time.CLOCK_REALTIME

Relógio em tempo real. Configurar este relógio requer privilégios apropriados. O relógio é o mesmo para todos os processos.

@ref{1ed8,,Disponibilidade}: Unix.


Adicionado na versão 3.3.

@end deffn

@node Constantes de Fuso Horário,,Constantes de ID de Relógio,time — Acesso ao horário e conversões
@anchor{library/time time-timezone-constants}@anchor{2e27}@anchor{library/time timezone-constants}@anchor{2e28}
@subsubsection Constantes de Fuso Horário


@geindex altzone (no módulo time)
@anchor{library/time time altzone}@anchor{2e29}
@deffn {Dado} time.altzone

O deslocamento do fuso horário DST local, em segundos a oeste de UTC, se algum for fornecido. É negativo se o fuso horário DST local está a leste de UTC (como na Europa Ocidental, incluindo o Reino Unido). Somente utilize se @code{daylight} for diferente de zero. Veja a nota abaixo.
@end deffn

@geindex daylight (no módulo time)
@anchor{library/time time daylight}@anchor{2e2a}
@deffn {Dado} time.daylight

Diferente de zero se um fuso horário DST é definido. Veja nota abaixo.
@end deffn

@geindex timezone (no módulo time)
@anchor{library/time time timezone}@anchor{2e2b}
@deffn {Dado} time.timezone

O deslocamento para o fuso horário local (não DST), em segundos a oeste de UTC (negativo na maior parte da Europa Ocidental, positivo nos Estados Unidos e Brasil, zero no Reino Unido). Ver nota abaixo.
@end deffn

@geindex tzname (no módulo time)
@anchor{library/time time tzname}@anchor{2e2c}
@deffn {Dado} time.tzname

A tupla de duas strings: A primeira é o nome do fuso horário local não DST, a segunda é o nome do fuso horário local DST. Se nenhum fuso horário DST for definido, a segunda string é usada. Veja nota abaixo.
@end deffn

@cartouche
@quotation Nota 
Para as constantes de Fuso Horário acima (@ref{2e29,,altzone}, @ref{2e2a,,daylight}, @ref{2e2b,,timezone}, e @ref{2e2c,,tzname}), o valor é determinado pelas regras de fuso horário em efeito no módulo de carregamento de tempo ou a última vez que @ref{2e1f,,tzset()} é chamada e pode estar incorreto para tempos no passado. É recomendado utilizar os resultados @ref{2e12,,tm_gmtoff} e @ref{2e13,,tm_zone} da @ref{1541,,localtime()} para obter informação de fuso horário.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item Módulo @ref{30,,datetime}

Mais interfaces orientada a objetos para datas e tempos.

@item Módulo @ref{86,,locale}

Serviços de internacionalização. A configuração de localidade afeta a interpretação de muitos especificadores de formato em @ref{1229,,strftime()} e @ref{1474,,strptime()}.

@item Módulo @ref{14,,calendar}

Funções gerais relacionadas a calendários. @ref{2678,,timegm()} é a função inversa de @ref{1200,,gmtime()} deste módulo.
@end table


@node logging — Recursos de registro de eventos para Python,logging config — Configuração do módulo logging,time — Acesso ao horário e conversões,Serviços Genéricos do Sistema Operacional
@anchor{library/logging doc}@anchor{2e2d}@anchor{library/logging logging-logging-facility-for-python}@anchor{2e2e}@anchor{library/logging module-logging}@anchor{87}@anchor{library/logging translation-repo}@anchor{2e2f}
@subsection @code{logging} — Recursos de registro de eventos para Python


@geindex module; logging

`Código-fonte:' Lib/logging/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/logging/__init__.py}

@geindex Erros;logging

@subsubheading Important



Esta página contêm informação de referência da API. Para tutorial e discussão de tópicos mais avançados, consulte


@itemize *

@item 
@ref{1235,,Tutorial básico}

@item 
@ref{1236,,Tutorial avançado}

@item 
@ref{1237,,Livro de receitas de logging}
@end itemize


__________________________________________________________________


Este módulo define funções e classes que implementam um registro flexível de eventos de sistema para aplicações e bibliotecas.

O principal benefício de ter a API de registro de eventos a partir de um módulo da biblioteca padrão é que todos os módulos Python podem participar no registro de eventos, de forma que sua aplicação pode incluir suas próprias mensagens, integradas com mensagens de módulos de terceiros.

Aqui está um exemplo simples de uso idiomático:

@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

Se você executar `myapp.py', deverá ver isso em `myapp.log':

@example
INFO:__main__:Started
INFO:mylib:Doing something
INFO:__main__:Finished
@end example

O ponto chave desse modo de uso idiomático é que a maior parte do código está simplesmente criando um registrador de nível de módulo com @code{getLogger(__name__)} e usando esse registrador para fazer qualquer registro necessário. Isso é conciso e, ao mesmo tempo, permite o controle refinado do código subjacente, se necessário. As mensagens registradas pelo registrador de nível de módulo são encaminhadas para tratadores de registradores em nível de módulo mais alto, até o registrador de nível mais alto conhecido como registrador raiz; essa abordagem é conhecida como registro hierárquico.

Para que o registro de eventos seja útil, ele precisa ser configurado: definir os níveis e os destinos de cada registrador, possivelmente alterando a forma como módulos específico fazem seus registros, geralmente com base em argumentos de linha de comando ou configuração da aplicação. Na maioria dos casos, como o descrito acima, somente o registrador raiz precisa ser configurado dessa forma, já que todos os registradores de nível inferior no nível módulo acabam encaminhando suas mensagens para seus tratadores. @ref{a08,,basicConfig()} oferece uma maneira rápida de configurar o registrador raiz que lida com muitos casos de uso.

O módulo provê várias funcionalidades e flexibilidade. Se você não está familiarizado com registro de eventos, a melhor maneira para se ter uma noção sobre é ver os tutoriais (`veja os links acima e à direita').

As classes básicas definidas pelo módulo, juntamente com seus atributos e métodos, estão listadas nas seções abaixo.


@itemize *

@item 
Loggers expõem a interface que o código da aplicação usa diretamente.

@item 
Handlers enviam os registros do evento (criados por loggers) aos destinos apropriados.

@item 
Filters fornecem uma facilidade granular para determinar quais registros de eventos enviar à saída.

@item 
Formatters especificam o layout dos registros de eventos na saída final.
@end itemize

@menu
* Objetos Logger:: 
* Níveis de Logging:: 
* Objetos Handler:: 
* Formatter Objects:: 
* Filter Objects:: 
* LogRecord Objects:: 
* Atributos LogRecord:: 
* LoggerAdapter Objects:: 
* Thread Safety:: 
* Funções de nível de módulo:: 
* Module-Level Attributes:: 
* Integration with the warnings module:: 

@end menu

@node Objetos Logger,Níveis de Logging,,logging — Recursos de registro de eventos para Python
@anchor{library/logging logger}@anchor{2e30}@anchor{library/logging logger-objects}@anchor{2e31}
@subsubsection Objetos Logger


Registradores têm os atributos e métodos a seguir. Observem que registradores `NUNCA' devem ser instanciados diretamente, mas sempre através da função @code{logging.getLogger(name)}. Múltiplas chamadas à função @ref{967,,getLogger()} com o mesmo nome sempre retornará uma referência para o mesmo 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 (classe em logging)
@anchor{library/logging logging Logger}@anchor{b64}
@deffn {Classe} logging.Logger

@geindex name (atributo logging.Logger)
@anchor{library/logging logging Logger name}@anchor{2e32}
@deffn {Atributo} name

This is the logger’s name, and is the value that was passed to @ref{967,,getLogger()}
to obtain the logger.

@cartouche
@quotation Nota 
Este atributo deve ser tratado como somente leitura.
@end quotation
@end cartouche
@end deffn

@geindex level (atributo logging.Logger)
@anchor{library/logging logging Logger level}@anchor{2e33}
@deffn {Atributo} level

The threshold of this logger, as set by the @ref{14db,,setLevel()} method.

@cartouche
@quotation Nota 
Do not set this attribute directly - always use @ref{14db,,setLevel()},
which has checks for the level passed to it.
@end quotation
@end cartouche
@end deffn

@geindex parent (atributo logging.Logger)
@anchor{library/logging logging Logger parent}@anchor{2e34}
@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 
Este valor deve ser tratado como somente leitura.
@end quotation
@end cartouche
@end deffn

@geindex propagate (atributo logging.Logger)
@anchor{library/logging logging Logger propagate}@anchor{14dd}
@deffn {Atributo} propagate

Se este atributo for verdadeiro, os eventos registrados nesse registrador serão transmitidos aos tratadores dos registradores de nível mais alto (ancestrais), além de quaisquer tratadores anexados a esse registrador. As mensagens são passadas diretamente para os tratadores dos registradores ancestrais - nem o nível nem os filtros dos registradores ancestrais em questão são considerados.

Se o valor for falso, as mensagens de registro não serão passadas para os tratadores de registradores ancestrais.

Explicando com um exemplo: se o atributo propagate do registrador chamado @code{A.B.C} for avaliado como verdadeiro, qualquer evento registrado em @code{A.B.C} pela chamada de métodos como @code{logging.getLogger('A.B.C').error(...)} será [sujeito à passagem das configurações de filtro e nível do registrador] passado por sua vez para qualquer tratador ligado aos registradores nomeados @code{A.B}, @code{A} e ao registrador raiz, após ser passado para qualquer tratador ligado ao @code{A.B.C}. Se qualquer registrador na cadeia @code{A.B.C}, @code{A.B}, @code{A} tem o atributo @code{propagate} definido como falso, então esse será o último registrador cujos tratadores terão os eventos oferecidos para serem tratados e a propagação terminará naquele ponto.

O construtor atribui este valor como @code{True}.

@cartouche
@quotation Nota 
Se você configurar um tratador para o registrador `e' um ou mais dos ancestrais, pode acontecer que a mesma mensagem seja registrada várias vezes. Em geral, você não precisa configurar saídas para mais que um registrador - se você configurar apenas para o registrador principal da hierarquia, então todos os eventos dos registradores descendentes serão visualizados ali, fornecido pela configuração de propagação, cujo padrão é @code{True}. Um cenário comum é configurar as saídas somente no registrador raiz, e deixar a propagação tomar conta do resto.
@end quotation
@end cartouche
@end deffn

@geindex handlers (atributo logging.Logger)
@anchor{library/logging logging Logger handlers}@anchor{2e35}
@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{2e36,,addHandler()} and @ref{2e37,,removeHandler()} methods, which use locks to ensure
thread-safe operation.
@end quotation
@end cartouche
@end deffn

@geindex disabled (atributo logging.Logger)
@anchor{library/logging logging Logger disabled}@anchor{2e38}
@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 
Este atributo deve ser tratado como somente leitura.
@end quotation
@end cartouche
@end deffn

@geindex setLevel() (método logging.Logger)
@anchor{library/logging logging Logger setLevel}@anchor{14db}
@deffn {Método} setLevel (level)

Ajuste o limite para este logger para `level'. Mensagens de registro de eventos que forem menos severas que este `level' serão ignoradas; mensagens que tenham nível de severidade igual ou maior que `level' serão emitidas para os destinos de saída configurados para o logger, a menos que o nível da saída tenha sido configurado para uma severidade ainda maior.

Quando um logger é criado, o nível é definido como @ref{2e39,,NOTSET} (que faz com que todas as mensagens sejam processadas quando o logger for o logger raiz, ou delegação para o pai quando o logger não for um logger raiz). Observe que o logger raiz é criado com nível @ref{2e3a,,WARNING}.

O termo “delegação ao pai” significa que o logger possui um nível de NOTSET, e a sua cadeia de loggers ancestrais será percorrida até que um ancestral com o nível diferente de NOTSET seja encontrado ou até a raiz ser alcançada.

Se um ancestral for achado com um nível diferente de NOTSET, então o nível daquele ancestral será tratado como o nível efetivo do logger que começou a busca por ancestrais, e é usado para determinar como um registro de evento será manipulado.

Se a raiz é alcançada e o seu nível é NOTSET, então todas as mensagens serão processadas. Caso contrário, o nível da raiz será usada como o nível efetivo.

Veja @ref{65a,,Níveis de Logging} para uma lista de níveis.


Alterado na versão 3.2: O parâmetro `level' agora é aceito como uma string representando o nível tal qual ‘INFO’, como uma alternativa as constantes inteiras tal qual @ref{2e3b,,INFO}. Note, entretanto, que os níveis são guardados internamente como inteiros e os métodos como, por exemplo, @ref{2e3c,,getEffectiveLevel()} e @ref{133a,,isEnabledFor()} retornarão/esperarão que sejam passados inteiros.

@end deffn

@geindex isEnabledFor() (método logging.Logger)
@anchor{library/logging logging Logger isEnabledFor}@anchor{133a}
@deffn {Método} isEnabledFor (level)

Indica se a mensagem com gravidade `level' seria processada por esse logger. Esse método checa primeiro o nível à nível de módulo definido por @code{logging.disable(level)} e então o nível efetivo do logger como determinado por @ref{2e3c,,getEffectiveLevel()}.
@end deffn

@geindex getEffectiveLevel() (método logging.Logger)
@anchor{library/logging logging Logger getEffectiveLevel}@anchor{2e3c}
@deffn {Método} getEffectiveLevel ()

Indica o nível efeito para esse logger. Se um valor diferente de @ref{2e39,,NOTSET} foi definido usando @ref{14db,,setLevel()}, ele é retornado. Caso contrário, a hierarquia é percorrida em direção a raiz até um valor diferente de @ref{2e39,,NOTSET} ser encontrado e então esse valor é retornado. O valor retornado é um inteiro, tipicamento um entre @ref{2e3d,,logging.DEBUG}, @ref{2e3b,,logging.INFO} etc
@end deffn

@geindex getChild() (método logging.Logger)
@anchor{library/logging logging Logger getChild}@anchor{1338}
@deffn {Método} getChild (suffix)

Retorna um logger que é descendente deste logger, como determinado pelo sufixo. Portanto, @code{logging.getLogger('abc').getChild('def.ghi')} retornaria o mesmo logger que seria retornado por @code{logging.getLogger('abc.def.ghi')}. Esse é um método de conveniência, útil quando o logger pai é nomeado usando, por exemplo @code{__name__} ao invés de uma string literal.


Adicionado na versão 3.2.

@end deffn

@geindex getChildren() (método logging.Logger)
@anchor{library/logging logging Logger getChildren}@anchor{18dc}
@deffn {Método} getChildren ()

Returns a set of loggers which are immediate children of this logger. So for
example @code{logging.getLogger().getChildren()} might return a set containing
loggers named @code{foo} and @code{bar}, but a logger named @code{foo.bar} wouldn’t be
included in the set. Likewise, @code{logging.getLogger('foo').getChildren()} might
return a set including a logger named @code{foo.bar}, but it wouldn’t include one
named @code{foo.bar.baz}.


Adicionado na versão 3.12.

@end deffn

@geindex debug() (método logging.Logger)
@anchor{library/logging logging Logger debug}@anchor{e57}
@deffn {Método} debug (msg, *args, **kwargs)

Logs a message with level @ref{2e3d,,DEBUG} on this logger. The `msg' is the
message format string, and the `args' are the arguments which are merged into
`msg' using the string formatting operator. (Note that this means that you can
use keywords in the format string, together with a single dictionary argument.)
No % formatting operation is performed on `msg' when no `args' are supplied.

Existem quatro argumentos nomeados em `kwargs' que serão inspecionados: `exc_info', `stack_info', `stacklevel' e `extra'.

If `exc_info' does not evaluate as false, it causes exception information to be
added to the logging message. If an exception tuple (in the format returned by
@ref{68a,,sys.exc_info()}) or an exception instance is provided, it is used;
otherwise, @ref{68a,,sys.exc_info()} is called to get the exception information.

The second optional keyword argument is `stack_info', which defaults to
@code{False}. If true, stack information is added to the logging
message, including the actual logging call. Note that this is not the same
stack information as that displayed through specifying `exc_info': The
former is stack frames from the bottom of the stack up to the logging call
in the current thread, whereas the latter is information about stack frames
which have been unwound, following an exception, while searching for
exception handlers.

You can specify `stack_info' independently of `exc_info', e.g. to just show
how you got to a certain point in your code, even when no exceptions were
raised. The stack frames are printed following a header line which says:

@example
Stack (most recent call last):
@end example

Isso imita o @code{Traceback (most recent call last):} que é usado ao exibir quadros de exceção.

The third optional keyword argument is `stacklevel', which defaults to @code{1}.
If greater than 1, the corresponding number of stack frames are skipped
when computing the line number and function name set in the @ref{101c,,LogRecord}
created for the logging event. This can be used in logging helpers so that
the function name, filename and line number recorded are not the information
for the helper function/method, but rather its caller. The name of this
parameter mirrors the equivalent one in the @ref{112,,warnings} module.

The fourth keyword argument is `extra' which can be used to pass a
dictionary which is used to populate the @ref{55b,,__dict__} of the
@ref{101c,,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

imprimiria algo como

@example
2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset
@end example

The keys in the dictionary passed in `extra' should not clash with the keys used
by the logging system. (See the section on @ref{2e3e,,Atributos LogRecord} for more
information on which keys are used by the logging system.)

If you choose to use these attributes in logged messages, you need to exercise
some care. In the above example, for instance, the @ref{14df,,Formatter} has been
set up with a format string which expects ‘clientip’ and ‘user’ in the attribute
dictionary of the @ref{101c,,LogRecord}. If these are missing, the message will
not be logged because a string formatting exception will occur. So in this case,
you always need to pass the `extra' dictionary with these keys.

While this might be annoying, this feature is intended for use in specialized
circumstances, such as multi-threaded servers where the same code executes in
many contexts, and interesting conditions which arise are dependent on this
context (such as remote client IP address and authenticated user name, in the
above example). In such circumstances, it is likely that specialized
@ref{14df,,Formatter}s would be used with particular @ref{14de,,Handler}s.

If no handler is attached to this logger (or any of its ancestors,
taking into account the relevant @ref{14dd,,Logger.propagate} attributes),
the message will be sent to the handler set on @ref{123a,,lastResort}.


Alterado na versão 3.2: O parâmetro `stack_info' foi adicionado.



Alterado na versão 3.5: The `exc_info' parameter can now accept exception instances.



Alterado na versão 3.8: O parâmetro `stacklevel' foi adicionado.

@end deffn

@geindex info() (método logging.Logger)
@anchor{library/logging logging Logger info}@anchor{2e3f}
@deffn {Método} info (msg, *args, **kwargs)

Logs a message with level @ref{2e3b,,INFO} on this logger. The arguments are
interpreted as for @ref{2e40,,debug()}.
@end deffn

@geindex warning() (método logging.Logger)
@anchor{library/logging logging Logger warning}@anchor{17f6}
@deffn {Método} warning (msg, *args, **kwargs)

Logs a message with level @ref{2e3a,,WARNING} on this logger. The arguments are
interpreted as for @ref{2e40,,debug()}.

@cartouche
@quotation Nota 
There is an obsolete method @code{warn} which is functionally
identical to @code{warning}. As @code{warn} is deprecated, please do not use
it - use @code{warning} instead.
@end quotation
@end cartouche
@end deffn

@geindex error() (método logging.Logger)
@anchor{library/logging logging Logger error}@anchor{2e41}
@deffn {Método} error (msg, *args, **kwargs)

Logs a message with level @ref{2e42,,ERROR} on this logger. The arguments are
interpreted as for @ref{2e40,,debug()}.
@end deffn

@geindex critical() (método logging.Logger)
@anchor{library/logging logging Logger critical}@anchor{e56}
@deffn {Método} critical (msg, *args, **kwargs)

Logs a message with level @ref{2e43,,CRITICAL} on this logger. The arguments are
interpreted as for @ref{2e40,,debug()}.
@end deffn

@geindex log() (método logging.Logger)
@anchor{library/logging logging Logger log}@anchor{e54}
@deffn {Método} log (level, msg, *args, **kwargs)

Logs a message with integer level `level' on this logger. The other arguments are
interpreted as for @ref{2e40,,debug()}.
@end deffn

@geindex exception() (método logging.Logger)
@anchor{library/logging logging Logger exception}@anchor{e55}
@deffn {Método} exception (msg, *args, **kwargs)

Logs a message with level @ref{2e42,,ERROR} on this logger. The arguments are
interpreted as for @ref{2e40,,debug()}. Exception info is added to the logging
message. This method should only be called from an exception handler.
@end deffn

@geindex addFilter() (método logging.Logger)
@anchor{library/logging logging Logger addFilter}@anchor{2e44}
@deffn {Método} addFilter (filter)

Adds the specified filter `filter' to this logger.
@end deffn

@geindex removeFilter() (método logging.Logger)
@anchor{library/logging logging Logger removeFilter}@anchor{2e45}
@deffn {Método} removeFilter (filter)

Removes the specified filter `filter' from this logger.
@end deffn

@geindex filter() (método logging.Logger)
@anchor{library/logging logging Logger filter}@anchor{2e46}
@deffn {Método} filter (record)

Apply this logger’s filters to the record and return @code{True} if the
record is to be processed. The filters are consulted in turn, until one of
them returns a false value. If none of them return a false value, the record
will be processed (passed to handlers). If one returns a false value, no
further processing of the record occurs.
@end deffn

@geindex addHandler() (método logging.Logger)
@anchor{library/logging logging Logger addHandler}@anchor{2e36}
@deffn {Método} addHandler (hdlr)

Adiciona o tratador especificado por `hdlr' deste logger.
@end deffn

@geindex removeHandler() (método logging.Logger)
@anchor{library/logging logging Logger removeHandler}@anchor{2e37}
@deffn {Método} removeHandler (hdlr)

Remove o tratador especificado por `hdlr' deste logger.
@end deffn

@geindex findCaller() (método logging.Logger)
@anchor{library/logging logging Logger findCaller}@anchor{2e47}
@deffn {Método} findCaller (stack_info=False, stacklevel=1)

Finds the caller’s source filename and line number. Returns the filename, line
number, function name and stack information as a 4-element tuple. The stack
information is returned as @code{None} unless `stack_info' is @code{True}.

The `stacklevel' parameter is passed from code calling the @ref{2e40,,debug()}
and other APIs. If greater than 1, the excess is used to skip stack frames
before determining the values to be returned. This will generally be useful
when calling logging APIs from helper/wrapper code, so that the information
in the event log refers not to the helper/wrapper code, but to the code that
calls it.
@end deffn

@geindex handle() (método logging.Logger)
@anchor{library/logging logging Logger handle}@anchor{2e48}
@deffn {Método} handle (record)

Handles a record by passing it to all handlers associated with this logger and
its ancestors (until a false value of `propagate' is found). This method is used
for unpickled records received from a socket, as well as those created locally.
Logger-level filtering is applied using @ref{2e46,,filter()}.
@end deffn

@geindex makeRecord() (método logging.Logger)
@anchor{library/logging logging Logger makeRecord}@anchor{2e49}
@deffn {Método} makeRecord (name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

This is a factory method which can be overridden in subclasses to create
specialized @ref{101c,,LogRecord} instances.
@end deffn

@geindex hasHandlers() (método logging.Logger)
@anchor{library/logging logging Logger hasHandlers}@anchor{2e4a}
@deffn {Método} hasHandlers ()

Checks to see if this logger has any handlers configured. This is done by
looking for handlers in this logger and its parents in the logger hierarchy.
Returns @code{True} if a handler was found, else @code{False}. The method stops searching
up the hierarchy whenever a logger with the ‘propagate’ attribute set to
false is found - that will be the last logger which is checked for the
existence of handlers.


Adicionado na versão 3.2.

@end deffn


Alterado na versão 3.7: Loggers can now be pickled and unpickled.

@end deffn

@node Níveis de Logging,Objetos Handler,Objetos Logger,logging — Recursos de registro de eventos para Python
@anchor{library/logging levels}@anchor{65a}@anchor{library/logging logging-levels}@anchor{2e4b}
@subsubsection Níveis de Logging


Os valores numéricos dos níveis de logging estão listados na tabela abaixo. Eles são principalmente de interesse se você quiser definir seus próprios níveis, e precisa deles para definir seus valores específicos relativos aos níveis predefinidos. Se você define um nível com o mesmo valor numérico, ele sobrescreve o valor predefinido; o nome predefinido é perdido.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nível

@tab

Valor numérico

@tab

What it means / When to use it

@item

@geindex NOTSET (no módulo logging)
@anchor{library/logging logging NOTSET}@anchor{2e39}
@deffn {Dado} logging.NOTSET
@end deffn

@tab

0

@tab

When set on a logger, indicates that
ancestor loggers are to be consulted
to determine the effective level.
If that still resolves to
@code{NOTSET}, then all events
are logged. When set on a handler,
all events are handled.

@item

@geindex DEBUG (no módulo logging)
@anchor{library/logging logging DEBUG}@anchor{2e3d}
@deffn {Dado} logging.DEBUG
@end deffn

@tab

10

@tab

Detailed information, typically only
of interest to a developer trying to
diagnose a problem.

@item

@geindex INFO (no módulo logging)
@anchor{library/logging logging INFO}@anchor{2e3b}
@deffn {Dado} logging.INFO
@end deffn

@tab

20

@tab

Confirmação de que as coisas estão funcionando como esperado.

@item

@geindex WARNING (no módulo logging)
@anchor{library/logging logging WARNING}@anchor{2e3a}
@deffn {Dado} logging.WARNING
@end deffn

@tab

30

@tab

An indication that something
unexpected happened, or that a
problem might occur in the near
future (e.g. ‘disk space low’). The
software is still working as
expected.

@item

@geindex ERROR (no módulo logging)
@anchor{library/logging logging ERROR}@anchor{2e42}
@deffn {Dado} logging.ERROR
@end deffn

@tab

40

@tab

Por conta de um problema mais grave, o software não conseguiu executar alguma função.

@item

@geindex CRITICAL (no módulo logging)
@anchor{library/logging logging CRITICAL}@anchor{2e43}
@deffn {Dado} logging.CRITICAL
@end deffn

@tab

50

@tab

Um erro grave, indicando que o programa pode não conseguir continuar rodando.

@end multitable


@node Objetos Handler,Formatter Objects,Níveis de Logging,logging — Recursos de registro de eventos para Python
@anchor{library/logging handler}@anchor{2e4c}@anchor{library/logging handler-objects}@anchor{2e4d}
@subsubsection Objetos Handler


Handlers have the following attributes and methods. Note that @ref{14de,,Handler}
is never instantiated directly; this class acts as a base for more useful
subclasses. However, the @code{__init__()} method in subclasses needs to call
@ref{2e4e,,Handler.__init__()}.

@geindex Handler (classe em logging)
@anchor{library/logging logging Handler}@anchor{14de}
@deffn {Classe} logging.Handler

@geindex __init__() (método logging.Handler)
@anchor{library/logging logging Handler __init__}@anchor{2e4e}
@deffn {Método} __init__ (level=NOTSET)

Initializes the @ref{14de,,Handler} instance by setting its level, setting the list
of filters to the empty list and creating a lock (using @ref{2e4f,,createLock()}) for
serializing access to an I/O mechanism.
@end deffn

@geindex createLock() (método logging.Handler)
@anchor{library/logging logging Handler createLock}@anchor{2e4f}
@deffn {Método} createLock ()

Initializes a thread lock which can be used to serialize access to underlying
I/O functionality which may not be threadsafe.
@end deffn

@geindex acquire() (método logging.Handler)
@anchor{library/logging logging Handler acquire}@anchor{2e50}
@deffn {Método} acquire ()

Acquires the thread lock created with @ref{2e4f,,createLock()}.
@end deffn

@geindex release() (método logging.Handler)
@anchor{library/logging logging Handler release}@anchor{2e51}
@deffn {Método} release ()

Releases the thread lock acquired with @ref{2e50,,acquire()}.
@end deffn

@geindex setLevel() (método logging.Handler)
@anchor{library/logging logging Handler setLevel}@anchor{2e52}
@deffn {Método} setLevel (level)

Sets the threshold for this handler to `level'. Logging messages which are
less severe than `level' will be ignored. When a handler is created, the
level is set to @ref{2e39,,NOTSET} (which causes all messages to be
processed).

Veja @ref{65a,,Níveis de Logging} para uma lista de níveis.


Alterado na versão 3.2: The `level' parameter now accepts a string representation of the
level such as ‘INFO’ as an alternative to the integer constants
such as @ref{2e3b,,INFO}.

@end deffn

@geindex setFormatter() (método logging.Handler)
@anchor{library/logging logging Handler setFormatter}@anchor{2e53}
@deffn {Método} setFormatter (fmt)

Sets the formatter for this handler to `fmt'.
The `fmt' argument must be a @ref{14df,,Formatter} instance or @code{None}.
@end deffn

@geindex addFilter() (método logging.Handler)
@anchor{library/logging logging Handler addFilter}@anchor{2e54}
@deffn {Método} addFilter (filter)

Adds the specified filter `filter' to this handler.
@end deffn

@geindex removeFilter() (método logging.Handler)
@anchor{library/logging logging Handler removeFilter}@anchor{2e55}
@deffn {Método} removeFilter (filter)

Removes the specified filter `filter' from this handler.
@end deffn

@geindex filter() (método logging.Handler)
@anchor{library/logging logging Handler filter}@anchor{2e56}
@deffn {Método} filter (record)

Apply this handler’s filters to the record and return @code{True} if the
record is to be processed. The filters are consulted in turn, until one of
them returns a false value. If none of them return a false value, the record
will be emitted. If one returns a false value, the handler will not emit the
record.
@end deffn

@geindex flush() (método logging.Handler)
@anchor{library/logging logging Handler flush}@anchor{2e57}
@deffn {Método} flush ()

Ensure all logging output has been flushed. This version does nothing and is
intended to be implemented by subclasses.
@end deffn

@geindex close() (método logging.Handler)
@anchor{library/logging logging Handler close}@anchor{2e58}
@deffn {Método} close ()

Tidy up any resources used by the handler. This version does no output
but removes the handler from an internal map of handlers, which is used
for handler lookup by name.

Subclasses should ensure that this gets called from overridden @ref{2e58,,close()}
methods.
@end deffn

@geindex handle() (método logging.Handler)
@anchor{library/logging logging Handler handle}@anchor{2e59}
@deffn {Método} handle (record)

Conditionally emits the specified logging record, depending on filters which may
have been added to the handler. Wraps the actual emission of the record with
acquisition/release of the I/O thread lock.
@end deffn

@geindex handleError() (método logging.Handler)
@anchor{library/logging logging Handler handleError}@anchor{2e5a}
@deffn {Método} handleError (record)

This method should be called from handlers when an exception is encountered
during an @ref{2e5b,,emit()} call. If the module-level attribute
@ref{1239,,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{1239,,raiseExceptions} is @code{True}, as that is
more useful during development).
@end deffn

@geindex format() (método logging.Handler)
@anchor{library/logging logging Handler format}@anchor{2e5c}
@deffn {Método} format (record)

Do formatting for a record - if a formatter is set, use it. Otherwise, use the
default formatter for the module.
@end deffn

@geindex emit() (método logging.Handler)
@anchor{library/logging logging Handler emit}@anchor{2e5b}
@deffn {Método} emit (record)

Do whatever it takes to actually log the specified logging record. This version
is intended to be implemented by subclasses and so raises a
@ref{228,,NotImplementedError}.

@cartouche
@quotation Aviso 
This method is called after a handler-level lock is acquired, which
is released after this method returns. When you override this method, note
that you should be careful when calling anything that invokes other parts of
the logging API which might do locking, because that might result in a
deadlock. Specifically:


@itemize *

@item 
Logging configuration APIs acquire the module-level lock, and then
individual handler-level locks as those handlers are configured.

@item 
Many logging APIs lock the module-level lock. If such an API is called
from this method, it could cause a deadlock if a configuration call is
made on another thread, because that thread will try to acquire the
module-level lock `before' the handler-level lock, whereas this thread
tries to acquire the module-level lock `after' the handler-level lock
(because in this method, the handler-level lock has already been acquired).
@end itemize
@end quotation
@end cartouche
@end deffn
@end deffn

For a list of handlers included as standard, see @ref{89,,logging.handlers}.

@node Formatter Objects,Filter Objects,Objetos Handler,logging — Recursos de registro de eventos para Python
@anchor{library/logging formatter-objects}@anchor{2e5d}@anchor{library/logging id1}@anchor{2e5e}
@subsubsection Formatter Objects


@geindex Formatter (classe em logging)
@anchor{library/logging logging Formatter}@anchor{14df}
@deffn {Classe} logging.Formatter (fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Responsible for converting a @ref{101c,,LogRecord} to an output string
to be interpreted by a human or external system.

@*Parâmetros: 

@itemize *

@item 
@code{fmt} (@ref{44c,,str}) – A format string in the given `style' for
the logged output as a whole.
The possible mapping keys are drawn from the @ref{101c,,LogRecord} object’s
@ref{2e3e,,Atributos LogRecord}.
If not specified, @code{'%(message)s'} is used,
which is just the logged message.

@item 
@code{datefmt} (@ref{44c,,str}) – A format string for the date/time portion of the logged output.
If not specified, the default described in @ref{2e5f,,formatTime()} is used.

@item 
@code{style} (@ref{44c,,str}) – Can be one of @code{'%'}, @code{'@{'} or @code{'$'} and determines
how the format string will be merged with its data: using one of
@ref{6cc,,Formatação de string no estilo printf} (@code{%}), @ref{621,,str.format()} (@code{@{})
or @ref{687,,string.Template} (@code{$}). This only applies to
`fmt' (e.g. @code{'%(message)s'} versus @code{'@{message@}'}),
not to the actual log messages passed to the logging methods.
However, there are @ref{2e60,,other ways}
to use @code{@{}- and @code{$}-formatting for log messages.

@item 
@code{validate} (@ref{468,,bool}) – If @code{True} (the default), incorrect or mismatched
`fmt' and `style' will raise a @ref{202,,ValueError}; for example,
@code{logging.Formatter('%(asctime)s - %(message)s', style='@{')}.

@item 
@code{defaults} (@ref{256,,dict}@code{[}@ref{44c,,str}@code{, }@code{Any}@code{]}) – A dictionary with default values to use in custom fields.
For example,
@code{logging.Formatter('%(ip)s %(message)s', defaults=@{"ip": None@})}
@end itemize



Alterado na versão 3.2: Adicionado o parâmetro `style'.



Alterado na versão 3.8: Adicionado o parâmetro `validate'.



Alterado na versão 3.10: Adicionado o parâmetro `defaults'.


@geindex format() (método logging.Formatter)
@anchor{library/logging logging Formatter format}@anchor{2e61}
@deffn {Método} format (record)

The record’s attribute dictionary is used as the operand to a string
formatting operation. Returns the resulting string. Before formatting the
dictionary, a couple of preparatory steps are carried out. The `message'
attribute of the record is computed using `msg' % `args'. If the
formatting string contains @code{'(asctime)'}, @ref{2e5f,,formatTime()} is called
to format the event time. If there is exception information, it is
formatted using @ref{2e62,,formatException()} and appended to the message. Note
that the formatted exception information is cached in attribute
`exc_text'. This is useful because the exception information can be
pickled and sent across the wire, but you should be careful if you have
more than one @ref{14df,,Formatter} subclass which customizes the formatting
of exception information. In this case, you will have to clear the cached
value (by setting the `exc_text' attribute to @code{None}) after a formatter
has done its formatting, so that the next formatter to handle the event
doesn’t use the cached value, but recalculates it afresh.

If stack information is available, it’s appended after the exception
information, using @ref{2e63,,formatStack()} to transform it if necessary.
@end deffn

@geindex formatTime() (método logging.Formatter)
@anchor{library/logging logging Formatter formatTime}@anchor{2e5f}
@deffn {Método} formatTime (record, datefmt=None)

This method should be called from @ref{61f,,format()} by a formatter which
wants to make use of a formatted time. This method can be overridden in
formatters to provide for any specific requirement, but the basic behavior
is as follows: if `datefmt' (a string) is specified, it is used with
@ref{1229,,time.strftime()} to format the creation time of the
record. Otherwise, the format ‘%Y-%m-%d %H:%M:%S,uuu’ is used, where the
uuu part is a millisecond value and the other letters are as per the
@ref{1229,,time.strftime()} documentation.  An example time in this format is
@code{2003-01-23 00:29:50,411}.  The resulting string is returned.

This function uses a user-configurable function to convert the creation
time to a tuple. By default, @ref{1541,,time.localtime()} is used; to change
this for a particular formatter instance, set the @code{converter} attribute
to a function with the same signature as @ref{1541,,time.localtime()} or
@ref{1200,,time.gmtime()}. To change it for all formatters, for example if you
want all logging times to be shown in GMT, set the @code{converter}
attribute in the @code{Formatter} class.


Alterado na versão 3.3: Previously, the default format was hard-coded as in this example:
@code{2010-09-06 22:38:15,292} where the part before the comma is
handled by a strptime format string (@code{'%Y-%m-%d %H:%M:%S'}), and the
part after the comma is a millisecond value. Because strptime does not
have a format placeholder for milliseconds, the millisecond value is
appended using another format string, @code{'%s,%03d'} — and both of these
format strings have been hardcoded into this method. With the change,
these strings are defined as class-level attributes which can be
overridden at the instance level when desired. The names of the
attributes are @code{default_time_format} (for the strptime format string)
and @code{default_msec_format} (for appending the millisecond value).



Alterado na versão 3.9: The @code{default_msec_format} can be @code{None}.

@end deffn

@geindex formatException() (método logging.Formatter)
@anchor{library/logging logging Formatter formatException}@anchor{2e62}
@deffn {Método} formatException (exc_info)

Formats the specified exception information (a standard exception tuple as
returned by @ref{68a,,sys.exc_info()}) as a string. This default implementation
just uses @ref{852,,traceback.print_exception()}. The resulting string is
returned.
@end deffn

@geindex formatStack() (método logging.Formatter)
@anchor{library/logging logging Formatter formatStack}@anchor{2e63}
@deffn {Método} formatStack (stack_info)

Formats the specified stack information (a string as returned by
@ref{eb5,,traceback.print_stack()}, but with the last newline removed) as a
string. This default implementation just returns the input value.
@end deffn
@end deffn

@geindex BufferingFormatter (classe em logging)
@anchor{library/logging logging BufferingFormatter}@anchor{2e64}
@deffn {Classe} logging.BufferingFormatter (linefmt=None)

A base formatter class suitable for subclassing when you want to format a
number of records. You can pass a @ref{14df,,Formatter} instance which you want
to use to format each line (that corresponds to a single record). If not
specified, the default formatter (which just outputs the event message) is
used as the line formatter.

@geindex formatHeader() (método logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter formatHeader}@anchor{2e65}
@deffn {Método} formatHeader (records)

Return a header for a list of `records'. The base implementation just
returns the empty string. You will need to override this method if you
want specific behaviour, e.g. to show the count of records, a title or a
separator line.
@end deffn

@geindex formatFooter() (método logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter formatFooter}@anchor{2e66}
@deffn {Método} formatFooter (records)

Return a footer for a list of `records'. The base implementation just
returns the empty string. You will need to override this method if you
want specific behaviour, e.g. to show the count of records or a separator
line.
@end deffn

@geindex format() (método logging.BufferingFormatter)
@anchor{library/logging logging BufferingFormatter format}@anchor{2e67}
@deffn {Método} format (records)

Return formatted text for a list of `records'. The base implementation
just returns the empty string if there are no records; otherwise, it
returns the concatenation of the header, each record formatted with the
line formatter, and the footer.
@end deffn
@end deffn

@node Filter Objects,LogRecord Objects,Formatter Objects,logging — Recursos de registro de eventos para Python
@anchor{library/logging filter}@anchor{2e68}@anchor{library/logging filter-objects}@anchor{2e69}
@subsubsection Filter Objects


@code{Filters} can be used by @code{Handlers} and @code{Loggers} for more sophisticated
filtering than is provided by levels. The base filter class only allows events
which are below a certain point in the logger hierarchy. For example, a filter
initialized with ‘A.B’ will allow events logged by loggers ‘A.B’, ‘A.B.C’,
‘A.B.C.D’, ‘A.B.D’ etc. but not ‘A.BB’, ‘B.A.B’ etc. If initialized with the
empty string, all events are passed.

@geindex Filter (classe em logging)
@anchor{library/logging logging Filter}@anchor{123b}
@deffn {Classe} logging.Filter (name='@w{'})

Returns an instance of the @ref{123b,,Filter} class. If `name' is specified, it
names a logger which, together with its children, will have its events allowed
through the filter. If `name' is the empty string, allows every event.

@geindex filter() (método logging.Filter)
@anchor{library/logging logging Filter filter}@anchor{2e6a}
@deffn {Método} filter (record)

Is the specified record to be logged? Returns false for no, true for
yes. Filters can either modify log records in-place or return a completely
different record instance which will replace the original
log record in any future processing of the event.
@end deffn
@end deffn

Note that filters attached to handlers are consulted before an event is
emitted by the handler, whereas filters attached to loggers are consulted
whenever an event is logged (using @ref{2e40,,debug()}, @ref{2e6b,,info()},
etc.), before sending an event to handlers. This means that events which have
been generated by descendant loggers will not be filtered by a logger’s filter
setting, unless the filter has also been applied to those descendant loggers.

You don’t actually need to subclass @code{Filter}: you can pass any instance
which has a @code{filter} method with the same semantics.


Alterado na versão 3.2: You don’t need to create specialized @code{Filter} classes, or use other
classes with a @code{filter} method: you can use a function (or other
callable) as a filter. The filtering logic will check to see if the filter
object has a @code{filter} attribute: if it does, it’s assumed to be a
@code{Filter} and its @ref{2e6a,,filter()} method is called. Otherwise, it’s
assumed to be a callable and called with the record as the single
parameter. The returned value should conform to that returned by
@ref{2e6a,,filter()}.



Alterado na versão 3.12: You can now return a @ref{101c,,LogRecord} instance from filters to replace
the log record rather than modifying it in place. This allows filters attached to
a @ref{14de,,Handler} to modify the log record before it is emitted, without
having side effects on other handlers.


Although filters are used primarily to filter records based on more
sophisticated criteria than levels, they get to see every record which is
processed by the handler or logger they’re attached to: this can be useful if
you want to do things like counting how many records were processed by a
particular logger or handler, or adding, changing or removing attributes in
the @ref{101c,,LogRecord} being processed. Obviously changing the LogRecord needs
to be done with some care, but it does allow the injection of contextual
information into logs (see @ref{2e6c,,Using Filters to impart contextual information}).

@node LogRecord Objects,Atributos LogRecord,Filter Objects,logging — Recursos de registro de eventos para Python
@anchor{library/logging log-record}@anchor{2e6d}@anchor{library/logging logrecord-objects}@anchor{2e6e}
@subsubsection LogRecord Objects


@ref{101c,,LogRecord} instances are created automatically by the @ref{b64,,Logger}
every time something is logged, and can be created manually via
@ref{2e6f,,makeLogRecord()} (for example, from a pickled event received over the
wire).

@geindex LogRecord (classe em logging)
@anchor{library/logging logging LogRecord}@anchor{101c}
@deffn {Classe} logging.LogRecord (name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)

Contains all the information pertinent to the event being logged.

The primary information is passed in `msg' and `args',
which are combined using @code{msg % args} to create
the @code{message} attribute of the record.

@*Parâmetros: 

@itemize *

@item 
@code{name} (@ref{44c,,str}) – The name of the logger used to log the event
represented by this @code{LogRecord}.
Note that the logger name in the @code{LogRecord}
will always have this value,
even though it may be emitted by a handler
attached to a different (ancestor) logger.

@item 
@code{level} (@ref{257,,int}) – The @ref{65a,,numeric level} of the logging event
(such as @code{10} for @code{DEBUG}, @code{20} for @code{INFO}, etc).
Note that this is converted to `two' attributes of the LogRecord:
@code{levelno} for the numeric value
and @code{levelname} for the corresponding level name.

@item 
@code{pathname} (@ref{44c,,str}) – The full string path of the source file
where the logging call was made.

@item 
@code{lineno} (@ref{257,,int}) – The line number in the source file
where the logging call was made.

@item 
@code{msg} (@ref{6ac,,Any}) – The event description message,
which can be a %-format string with placeholders for variable data,
or an arbitrary object (see @ref{2e70,,Usando objetos arbitrários como mensagens}).

@item 
@code{args} (@ref{370,,tuple}@code{ | }@ref{256,,dict}@code{[}@ref{44c,,str}@code{, }@ref{6ac,,Any}@code{]}) – Variable data to merge into the `msg' argument
to obtain the event description.

@item 
@code{exc_info} (@ref{370,,tuple}@code{[}@ref{d6b,,type}@code{[}@ref{5bb,,BaseException}@code{]}@code{, }@ref{5bb,,BaseException}@code{, }@ref{b05,,types.TracebackType}@code{] }@code{| }@code{None}) – An exception tuple with the current exception information,
as returned by @ref{68a,,sys.exc_info()},
or @code{None} if no exception information is available.

@item 
@code{func} (@ref{44c,,str}@code{ | }@code{None}) – The name of the function or method
from which the logging call was invoked.

@item 
@code{sinfo} (@ref{44c,,str}@code{ | }@code{None}) – A text string representing stack information
from the base of the stack in the current thread,
up to the logging call.
@end itemize


@geindex getMessage() (método logging.LogRecord)
@anchor{library/logging logging LogRecord getMessage}@anchor{2e71}
@deffn {Método} getMessage ()

Returns the message for this @ref{101c,,LogRecord} instance after merging any
user-supplied arguments with the message. If the user-supplied message
argument to the logging call is not a string, @ref{44c,,str()} is called on it to
convert it to a string. This allows use of user-defined classes as
messages, whose @code{__str__} method can return the actual format string to
be used.
@end deffn


Alterado na versão 3.2: The creation of a @ref{101c,,LogRecord} has been made more configurable by
providing a factory which is used to create the record. The factory can be
set using @ref{2e72,,getLogRecordFactory()} and @ref{2e73,,setLogRecordFactory()}
(see this for the factory’s signature).


This functionality can be used to inject your own values into a
@ref{101c,,LogRecord} at creation time. You can use the following pattern:

@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

With this pattern, multiple factories could be chained, and as long
as they don’t overwrite each other’s attributes or unintentionally
overwrite the standard attributes listed above, there should be no
surprises.
@end deffn

@node Atributos LogRecord,LoggerAdapter Objects,LogRecord Objects,logging — Recursos de registro de eventos para Python
@anchor{library/logging id2}@anchor{2e74}@anchor{library/logging logrecord-attributes}@anchor{2e3e}
@subsubsection Atributos LogRecord


The LogRecord has a number of attributes, most of which are derived from the
parameters to the constructor. (Note that the names do not always correspond
exactly between the LogRecord constructor parameters and the LogRecord
attributes.) These attributes can be used to merge data from the record into
the format string. The following table lists (in alphabetical order) the
attribute names, their meanings and the corresponding placeholder in a %-style
format string.

If you are using @{@}-formatting (@ref{621,,str.format()}), you can use
@code{@{attrname@}} as the placeholder in the format string. If you are using
$-formatting (@ref{687,,string.Template}), use the form @code{$@{attrname@}}. In
both cases, of course, replace @code{attrname} with the actual attribute name
you want to use.

In the case of @{@}-formatting, you can specify formatting flags by placing them
after the attribute name, separated from it with a colon. For example: a
placeholder of @code{@{msecs:03.0f@}} would format a millisecond value of @code{4} as
@code{004}. Refer to the @ref{621,,str.format()} documentation for full details on
the options available to you.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Attribute name

@tab

Formatação

@tab

Descrição

@item

args

@tab

You shouldn’t need to
format this yourself.

@tab

The tuple of arguments merged into @code{msg} to
produce @code{message}, or a dict whose values
are used for the merge (when there is only one
argument, and it is a dictionary).

@item

asctime

@tab

@code{%(asctime)s}

@tab

Human-readable time when the
@ref{101c,,LogRecord} was created.  By default
this is of the form ‘2003-07-08 16:49:45,896’
(the numbers after the comma are millisecond
portion of the time).

@item

created

@tab

@code{%(created)f}

@tab

Time when the @ref{101c,,LogRecord} was created
(as returned by @ref{af9,,time.time_ns()} / 1e9).

@item

exc_info

@tab

You shouldn’t need to
format this yourself.

@tab

Exception tuple (à la @code{sys.exc_info}) or,
if no exception has occurred, @code{None}.

@item

exc_text

@tab

You shouldn’t need to
format this yourself.

@tab

Exception information formatted as a string.
This is set when @ref{2e61,,Formatter.format()} is
invoked, or @code{None} if no exception has
occurred.

@item

filename

@tab

@code{%(filename)s}

@tab

Filename portion of @code{pathname}.

@item

funcName

@tab

@code{%(funcName)s}

@tab

Name of function containing the logging call.

@item

levelname

@tab

@code{%(levelname)s}

@tab

Text logging level for the message
(@code{'DEBUG'}, @code{'INFO'}, @code{'WARNING'},
@code{'ERROR'}, @code{'CRITICAL'}).

@item

levelno

@tab

@code{%(levelno)s}

@tab

Numeric logging level for the message
(@ref{2e3d,,DEBUG}, @ref{2e3b,,INFO},
@ref{2e3a,,WARNING}, @ref{2e42,,ERROR},
@ref{2e43,,CRITICAL}).

@item

lineno

@tab

@code{%(lineno)d}

@tab

Source line number where the logging call was
issued (if available).

@item

message

@tab

@code{%(message)s}

@tab

The logged message, computed as @code{msg %
args}. This is set when
@ref{2e61,,Formatter.format()} is invoked.

@item

módulo

@tab

@code{%(module)s}

@tab

Module (name portion of @code{filename}).

@item

msecs

@tab

@code{%(msecs)d}

@tab

Millisecond portion of the time when the
@ref{101c,,LogRecord} was created.

@item

msg

@tab

You shouldn’t need to
format this yourself.

@tab

The format string passed in the original
logging call. Merged with @code{args} to
produce @code{message}, or an arbitrary object
(see @ref{2e70,,Usando objetos arbitrários como mensagens}).

@item

nome

@tab

@code{%(name)s}

@tab

Name of the logger used to log the call.

@item

pathname

@tab

@code{%(pathname)s}

@tab

Full pathname of the source file where the
logging call was issued (if available).

@item

processo

@tab

@code{%(process)d}

@tab

Process ID (if available).

@item

processName

@tab

@code{%(processName)s}

@tab

Process name (if available).

@item

relativeCreated

@tab

@code{%(relativeCreated)d}

@tab

Time in milliseconds when the LogRecord was
created, relative to the time the logging
module was loaded.

@item

stack_info

@tab

You shouldn’t need to
format this yourself.

@tab

Stack frame information (where available)
from the bottom of the stack in the current
thread, up to and including the stack frame
of the logging call which resulted in the
creation of this record.

@item

thread

@tab

@code{%(thread)d}

@tab

Thread ID (if available).

@item

threadName

@tab

@code{%(threadName)s}

@tab

Thread name (if available).

@item

taskName

@tab

@code{%(taskName)s}

@tab

@ref{1be,,asyncio.Task} name (if available).

@end multitable



Alterado na versão 3.1: `processName' was added.



Alterado na versão 3.12: `taskName' was added.


@node LoggerAdapter Objects,Thread Safety,Atributos LogRecord,logging — Recursos de registro de eventos para Python
@anchor{library/logging logger-adapter}@anchor{2e75}@anchor{library/logging loggeradapter-objects}@anchor{2e76}
@subsubsection LoggerAdapter Objects


@ref{1339,,LoggerAdapter} instances are used to conveniently pass contextual
information into logging calls. For a usage example, see the section on
@ref{2e77,,adding contextual information to your logging output}.

@geindex LoggerAdapter (classe em logging)
@anchor{library/logging logging LoggerAdapter}@anchor{1339}
@deffn {Classe} logging.LoggerAdapter (logger, extra=None, merge_extra=False)

Returns an instance of @ref{1339,,LoggerAdapter} initialized with an
underlying @ref{b64,,Logger} instance, an optional dict-like object (`extra'),
and an optional boolean (`merge_extra') indicating whether or not
the `extra' argument of individual log calls should be merged with
the @ref{1339,,LoggerAdapter} extra.
The default behavior is to ignore the `extra' argument of individual log
calls and only use the one of the @ref{1339,,LoggerAdapter} instance

@geindex process() (método logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter process}@anchor{2e78}
@deffn {Método} process (msg, kwargs)

Modifies the message and/or keyword arguments passed to a logging call in
order to insert contextual information. This implementation takes the object
passed as `extra' to the constructor and adds it to `kwargs' using key
‘extra’. The return value is a (`msg', `kwargs') tuple which has the
(possibly modified) versions of the arguments passed in.
@end deffn

@geindex manager (atributo logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter manager}@anchor{2e79}
@deffn {Atributo} manager

Delegates to the underlying @code{manager} on `logger'.
@end deffn

@geindex _log (atributo logging.LoggerAdapter)
@anchor{library/logging logging LoggerAdapter _log}@anchor{2e7a}
@deffn {Atributo} _log

Delegates to the underlying @code{_log()} method on `logger'.
@end deffn

In addition to the above, @ref{1339,,LoggerAdapter} supports the following
methods of @ref{b64,,Logger}: @ref{e57,,debug()}, @ref{2e3f,,info()},
@ref{17f6,,warning()}, @ref{2e41,,error()}, @ref{e55,,exception()},
@ref{e56,,critical()}, @ref{e54,,log()}, @ref{133a,,isEnabledFor()},
@ref{2e3c,,getEffectiveLevel()}, @ref{14db,,setLevel()} and
@ref{2e4a,,hasHandlers()}. These methods have the same signatures as their
counterparts in @ref{b64,,Logger}, so you can use the two types of instances
interchangeably.


Alterado na versão 3.2: The @ref{133a,,isEnabledFor()}, @ref{2e3c,,getEffectiveLevel()},
@ref{14db,,setLevel()} and @ref{2e4a,,hasHandlers()} methods were added
to @ref{1339,,LoggerAdapter}.  These methods delegate to the underlying logger.



Alterado na versão 3.6: Attribute @code{manager} and method @code{_log()} were added, which
delegate to the underlying logger and allow adapters to be nested.



Alterado na versão 3.10: The `extra' argument is now optional.



Alterado na versão 3.13: The `merge_extra' parameter was added.

@end deffn

@node Thread Safety,Funções de nível de módulo,LoggerAdapter Objects,logging — Recursos de registro de eventos para Python
@anchor{library/logging thread-safety}@anchor{2e7b}
@subsubsection Thread Safety


The logging module is intended to be thread-safe without any special work
needing to be done by its clients. It achieves this through using threading
locks; there is one lock to serialize access to the module’s shared data, and
each handler also creates a lock to serialize access to its underlying I/O.

If you are implementing asynchronous signal handlers using the @ref{c6,,signal}
module, you may not be able to use logging from within such handlers. This is
because lock implementations in the @ref{ed,,threading} module are not always
re-entrant, and so cannot be invoked from such signal handlers.

@node Funções de nível de módulo,Module-Level Attributes,Thread Safety,logging — Recursos de registro de eventos para Python
@anchor{library/logging module-level-functions}@anchor{2e7c}
@subsubsection Funções de nível de módulo


In addition to the classes described above, there are a number of module-level
functions.

@geindex getLogger() (no módulo logging)
@anchor{library/logging logging getLogger}@anchor{967}
@deffn {Função} 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{2e30,,Objetos Logger}.

All calls to this function with a given name return the same logger instance.
This means that logger instances never need to be passed between different parts
of an application.
@end deffn

@geindex getLoggerClass() (no módulo logging)
@anchor{library/logging logging getLoggerClass}@anchor{2e7d}
@deffn {Função} logging.getLoggerClass ()

Return either the standard @ref{b64,,Logger} class, or the last class passed to
@ref{2e7e,,setLoggerClass()}. This function may be called from within a new class
definition, to ensure that installing a customized @ref{b64,,Logger} class will
not undo customizations already applied by other code. For example:

@example
class MyLogger(logging.getLoggerClass()):
    # ... override behaviour here
@end example
@end deffn

@geindex getLogRecordFactory() (no módulo logging)
@anchor{library/logging logging getLogRecordFactory}@anchor{2e72}
@deffn {Função} logging.getLogRecordFactory ()

Return a callable which is used to create a @ref{101c,,LogRecord}.


Adicionado na versão 3.2: This function has been provided, along with @ref{2e73,,setLogRecordFactory()},
to allow developers more control over how the @ref{101c,,LogRecord}
representing a logging event is constructed.


See @ref{2e73,,setLogRecordFactory()} for more information about the how the
factory is called.
@end deffn

@geindex debug() (no módulo logging)
@anchor{library/logging logging debug}@anchor{2e40}
@deffn {Função} logging.debug (msg, *args, **kwargs)

This is a convenience function that calls @ref{e57,,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{a08,,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{e57,,Logger.debug()} (or other level-specific methods) on it, as
described at the beginnning of this documentation.
@end deffn

@geindex info() (no módulo logging)
@anchor{library/logging logging info}@anchor{2e6b}
@deffn {Função} logging.info (msg, *args, **kwargs)

Logs a message with level @ref{2e3b,,INFO} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2e40,,debug()}.
@end deffn

@geindex warning() (no módulo logging)
@anchor{library/logging logging warning}@anchor{2ff}
@deffn {Função} logging.warning (msg, *args, **kwargs)

Logs a message with level @ref{2e3a,,WARNING} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2e40,,debug()}.

@cartouche
@quotation Nota 
There is an obsolete function @code{warn} which is functionally
identical to @code{warning}. As @code{warn} is deprecated, please do not use
it - use @code{warning} instead.
@end quotation
@end cartouche
@end deffn

@geindex error() (no módulo logging)
@anchor{library/logging logging error}@anchor{2e7f}
@deffn {Função} logging.error (msg, *args, **kwargs)

Logs a message with level @ref{2e42,,ERROR} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2e40,,debug()}.
@end deffn

@geindex critical() (no módulo logging)
@anchor{library/logging logging critical}@anchor{2e80}
@deffn {Função} logging.critical (msg, *args, **kwargs)

Logs a message with level @ref{2e43,,CRITICAL} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2e40,,debug()}.
@end deffn

@geindex exception() (no módulo logging)
@anchor{library/logging logging exception}@anchor{14dc}
@deffn {Função} logging.exception (msg, *args, **kwargs)

Logs a message with level @ref{2e42,,ERROR} on the root logger. The arguments and behavior
are otherwise the same as for @ref{2e40,,debug()}. Exception info is added to the logging
message. This function should only be called from an exception handler.
@end deffn

@geindex log() (no módulo logging)
@anchor{library/logging logging log}@anchor{2e81}
@deffn {Função} 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{2e40,,debug()}.
@end deffn

@geindex disable() (no módulo logging)
@anchor{library/logging logging disable}@anchor{2e82}
@deffn {Função} logging.disable (level=CRITICAL)

Provides an overriding level `level' for all loggers which takes precedence over
the logger’s own level. When the need arises to temporarily throttle logging
output down across the whole application, this function can be useful. Its
effect is to disable all logging calls of severity `level' and below, so that
if you call it with a value of INFO, then all INFO and DEBUG events would be
discarded, whereas those of severity WARNING and above would be processed
according to the logger’s effective level. If
@code{logging.disable(logging.NOTSET)} is called, it effectively removes this
overriding level, so that logging output again depends on the effective
levels of individual loggers.

Note that if you have defined any custom logging level higher than
@code{CRITICAL} (this is not recommended), you won’t be able to rely on the
default value for the `level' parameter, but will have to explicitly supply a
suitable value.


Alterado na versão 3.7: The `level' parameter was defaulted to level @code{CRITICAL}. See
bpo-28524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28524} for more information about this change.

@end deffn

@geindex addLevelName() (no módulo logging)
@anchor{library/logging logging addLevelName}@anchor{2e83}
@deffn {Função} logging.addLevelName (level, levelName)

Associates level `level' with text `levelName' in an internal dictionary, which is
used to map numeric levels to a textual representation, for example when a
@ref{14df,,Formatter} formats a message. This function can also be used to define
your own levels. The only constraints are that all levels used must be
registered using this function, levels should be positive integers and they
should increase in increasing order of severity.

@cartouche
@quotation Nota 
If you are thinking of defining your own levels, please see the
section on @ref{2e84,,Níveis personalizados}.
@end quotation
@end cartouche
@end deffn

@geindex getLevelNamesMapping() (no módulo logging)
@anchor{library/logging logging getLevelNamesMapping}@anchor{659}
@deffn {Função} logging.getLevelNamesMapping ()

Returns a mapping from level names to their corresponding logging levels. For example, the
string “CRITICAL” maps to @ref{2e43,,CRITICAL}. The returned mapping is copied from an internal
mapping on each call to this function.


Adicionado na versão 3.11.

@end deffn

@geindex getLevelName() (no módulo logging)
@anchor{library/logging logging getLevelName}@anchor{2e85}
@deffn {Função} logging.getLevelName (level)

Returns the textual or numeric representation of logging level `level'.

If `level' is one of the predefined levels @ref{2e43,,CRITICAL}, @ref{2e42,,ERROR},
@ref{2e3a,,WARNING}, @ref{2e3b,,INFO} or @ref{2e3d,,DEBUG} then you get the
corresponding string. If you have associated levels with names using
@ref{2e83,,addLevelName()} then the name you have associated with `level' is
returned. If a numeric value corresponding to one of the defined levels is
passed in, the corresponding string representation is returned.

The `level' parameter also accepts a string representation of the level such
as ‘INFO’. In such cases, this functions returns the corresponding numeric
value of the level.

If no matching numeric or string value is passed in, the string
‘Level %s’ % level is returned.

@cartouche
@quotation Nota 
Levels are internally integers (as they need to be compared in the
logging logic). This function is used to convert between an integer level
and the level name displayed in the formatted log output by means of the
@code{%(levelname)s} format specifier (see @ref{2e3e,,Atributos LogRecord}), and
vice versa.
@end quotation
@end cartouche


Alterado na versão 3.4: In Python versions earlier than 3.4, this function could also be passed a
text level, and would return the corresponding numeric value of the level.
This undocumented behaviour was considered a mistake, and was removed in
Python 3.4, but reinstated in 3.4.2 due to retain backward compatibility.

@end deffn

@geindex getHandlerByName() (no módulo logging)
@anchor{library/logging logging getHandlerByName}@anchor{18ed}
@deffn {Função} logging.getHandlerByName (name)

Returns a handler with the specified `name', or @code{None} if there is no handler
with that name.


Adicionado na versão 3.12.

@end deffn

@geindex getHandlerNames() (no módulo logging)
@anchor{library/logging logging getHandlerNames}@anchor{17f0}
@deffn {Função} logging.getHandlerNames ()

Returns an immutable set of all known handler names.


Adicionado na versão 3.12.

@end deffn

@geindex makeLogRecord() (no módulo logging)
@anchor{library/logging logging makeLogRecord}@anchor{2e6f}
@deffn {Função} logging.makeLogRecord (attrdict)

Creates and returns a new @ref{101c,,LogRecord} instance whose attributes are
defined by `attrdict'. This function is useful for taking a pickled
@ref{101c,,LogRecord} attribute dictionary, sent over a socket, and reconstituting
it as a @ref{101c,,LogRecord} instance at the receiving end.
@end deffn

@geindex basicConfig() (no módulo logging)
@anchor{library/logging logging basicConfig}@anchor{a08}
@deffn {Função} logging.basicConfig (**kwargs)

Does basic configuration for the logging system by creating a
@ref{1238,,StreamHandler} with a default @ref{14df,,Formatter} and adding it to the
root logger. The functions @ref{2e40,,debug()}, @ref{2e6b,,info()}, @ref{2ff,,warning()},
@ref{2e7f,,error()} and @ref{2e80,,critical()} will call @ref{a08,,basicConfig()} automatically
if no handlers are defined for the root logger.

This function does nothing if the root logger already has handlers
configured, unless the keyword argument `force' is set to @code{True}.

@cartouche
@quotation Nota 
This function should be called from the main thread
before other threads are started. In versions of Python prior to
2.7.1 and 3.2, if this function is called from multiple threads,
it is possible (in rare circumstances) that a handler will be added
to the root logger more than once, leading to unexpected results
such as messages being duplicated in the log.
@end quotation
@end cartouche

The following keyword arguments are supported.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Formatação

@tab

Descrição

@item

`filename'

@tab

Specifies that a @ref{19de,,FileHandler} be
created, using the specified filename,
rather than a @ref{1238,,StreamHandler}.

@item

`filemode'

@tab

If `filename' is specified, open the file
in this @ref{230e,,mode}. Defaults
to @code{'a'}.

@item

`format'

@tab

Use the specified format string for the
handler. Defaults to attributes
@code{levelname}, @code{name} and @code{message}
separated by colons.

@item

`datefmt'

@tab

Use the specified date/time format, as
accepted by @ref{1229,,time.strftime()}.

@item

`style'

@tab

If `format' is specified, use this style
for the format string. One of @code{'%'},
@code{'@{'} or @code{'$'} for @ref{6cc,,printf-style},
@ref{621,,str.format()} or
@ref{687,,string.Template} respectively.
Defaults to @code{'%'}.

@item

`level'

@tab

Set the root logger level to the specified
@ref{65a,,level}.

@item

`stream'

@tab

Use the specified stream to initialize the
@ref{1238,,StreamHandler}. Note that this
argument is incompatible with `filename' -
if both are present, a @code{ValueError} is
raised.

@item

`handlers'

@tab

If specified, this should be an iterable of
already created handlers to add to the root
logger. Any handlers which don’t already
have a formatter set will be assigned the
default formatter created in this function.
Note that this argument is incompatible
with `filename' or `stream' - if both
are present, a @code{ValueError} is raised.

@item

`force'

@tab

If this keyword argument is specified as
true, any existing handlers attached to the
root logger are removed and closed, before
carrying out the configuration as specified
by the other arguments.

@item

`encoding'

@tab

If this keyword argument is specified along
with `filename', its value is used when the
@ref{19de,,FileHandler} is created, and thus
used when opening the output file.

@item

`errors'

@tab

If this keyword argument is specified along
with `filename', its value is used when the
@ref{19de,,FileHandler} is created, and thus
used when opening the output file. If not
specified, the value ‘backslashreplace’ is
used. Note that if @code{None} is specified,
it will be passed as such to @ref{51c,,open()},
which means that it will be treated the
same as passing ‘errors’.

@end multitable



Alterado na versão 3.2: O argumento `style' foi adicionado.



Alterado na versão 3.3: The `handlers' argument was added. Additional checks were added to
catch situations where incompatible arguments are specified (e.g.
`handlers' together with `stream' or `filename', or `stream'
together with `filename').



Alterado na versão 3.8: O argumento `force' foi adicionado.



Alterado na versão 3.9: Os argumentos `encoding' e `errors' foram adicionados.

@end deffn

@geindex shutdown() (no módulo logging)
@anchor{library/logging logging shutdown}@anchor{2e86}
@deffn {Função} logging.shutdown ()

Informs the logging system to perform an orderly shutdown by flushing and
closing all handlers. This should be called at application exit and no
further use of the logging system should be made after this call.

When the logging module is imported, it registers this function as an exit
handler (see @ref{c,,atexit}), so normally there’s no need to do that
manually.
@end deffn

@geindex setLoggerClass() (no módulo logging)
@anchor{library/logging logging setLoggerClass}@anchor{2e7e}
@deffn {Função} logging.setLoggerClass (klass)

Tells the logging system to use the class `klass' when instantiating a logger.
The class should define @code{__init__()} such that only a name argument is
required, and the @code{__init__()} should call @code{Logger.__init__()}. This
function is typically called before any loggers are instantiated by applications
which need to use custom logger behavior. After this call, as at any other
time, do not instantiate loggers directly using the subclass: continue to use
the @ref{967,,logging.getLogger()} API to get your loggers.
@end deffn

@geindex setLogRecordFactory() (no módulo logging)
@anchor{library/logging logging setLogRecordFactory}@anchor{2e73}
@deffn {Função} logging.setLogRecordFactory (factory)

Set a callable which is used to create a @ref{101c,,LogRecord}.

@*Parâmetros: 
@code{factory} – The factory callable to be used to instantiate a log record.



Adicionado na versão 3.2: This function has been provided, along with @ref{2e72,,getLogRecordFactory()}, to
allow developers more control over how the @ref{101c,,LogRecord} representing
a logging event is constructed.


The factory has the following signature:

@code{factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)}

@quotation

@*nome: 
The logger name.


@*level: 
The logging level (numeric).


@*fn: 
The full pathname of the file where the logging call was made.


@*lno: 
The line number in the file where the logging call was made.


@*msg: 
The logging message.


@*args: 
The arguments for the logging message.


@*exc_info: 
An exception tuple, or @code{None}.


@*func: 
The name of the function or method which invoked the logging
call.


@*sinfo: 
A stack traceback such as is provided by
@ref{eb5,,traceback.print_stack()}, showing the call hierarchy.


@*kwargs: 
Additional keyword arguments.

@end quotation
@end deffn

@node Module-Level Attributes,Integration with the warnings module,Funções de nível de módulo,logging — Recursos de registro de eventos para Python
@anchor{library/logging module-level-attributes}@anchor{2e87}
@subsubsection Module-Level Attributes


@geindex lastResort (no módulo logging)
@anchor{library/logging logging lastResort}@anchor{123a}
@deffn {Dado} logging.lastResort

A “handler of last resort” is available through this attribute. This
is a @ref{1238,,StreamHandler} writing to @code{sys.stderr} with a level of
@code{WARNING}, and is used to handle logging events in the absence of any
logging configuration. The end result is to just print the message to
@code{sys.stderr}. This replaces the earlier error message saying that
“no handlers could be found for logger XYZ”. If you need the earlier
behaviour for some reason, @code{lastResort} can be set to @code{None}.


Adicionado na versão 3.2.

@end deffn

@geindex raiseExceptions (no módulo logging)
@anchor{library/logging logging raiseExceptions}@anchor{1239}
@deffn {Dado} logging.raiseExceptions

Used to see if exceptions during handling should be propagated.

Padrão: @code{True}.

If @ref{1239,,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 Integration with the warnings module,,Module-Level Attributes,logging — Recursos de registro de eventos para Python
@anchor{library/logging integration-with-the-warnings-module}@anchor{2e88}
@subsubsection Integration with the warnings module


The @ref{2e89,,captureWarnings()} function can be used to integrate @ref{87,,logging}
with the @ref{112,,warnings} module.

@geindex captureWarnings() (no módulo logging)
@anchor{library/logging logging captureWarnings}@anchor{2e89}
@deffn {Função} logging.captureWarnings (capture)

This function is used to turn the capture of warnings by logging on and
off.

If `capture' is @code{True}, warnings issued by the @ref{112,,warnings} module will
be redirected to the logging system. Specifically, a warning will be
formatted using @ref{1b8d,,warnings.formatwarning()} and the resulting string
logged to a logger named @code{'py.warnings'} with a severity of @ref{2e3a,,WARNING}.

If `capture' is @code{False}, the redirection of warnings to the logging system
will stop, and warnings will be redirected to their original destinations
(i.e. those in effect before @code{captureWarnings(True)} was called).
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{88,,logging.config}

API de configuração para o módulo logging.

@item Módulo @ref{89,,logging.handlers}

Tratadores úteis incluídos no módulo logging.

@geindex Propostas de Melhorias do Python; PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - A Logging System

The proposal which described this feature for inclusion in the Python standard
library.

@item Original Python logging package@footnote{https://old.red-dove.com/python_logging.html}

This is the original source for the @ref{87,,logging} package.  The version of the
package available from this site is suitable for use with Python 1.5.2, 2.1.x
and 2.2.x, which do not include the @ref{87,,logging} package in the standard
library.
@end table


@node logging config — Configuração do módulo logging,logging handlers — Manipuladores de logging,logging — Recursos de registro de eventos para Python,Serviços Genéricos do Sistema Operacional
@anchor{library/logging config doc}@anchor{2e8a}@anchor{library/logging config logging-config-logging-configuration}@anchor{2e8b}@anchor{library/logging config module-logging config}@anchor{88}@anchor{library/logging config translation-repo}@anchor{2e8c}
@subsection @code{logging.config} — Configuração do módulo logging


@geindex module; logging.config

`Código-fonte:' Lib/logging/config.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/logging/config.py}

@subsubheading Important



Esta página contém apenas informações de referência. Para tutoriais, por favor consulte


@itemize *

@item 
@ref{1235,,Tutorial básico}

@item 
@ref{1236,,Tutorial avançado}

@item 
@ref{1237,,Livro de receitas de logging}
@end itemize


__________________________________________________________________


Esta seção descreve a API para configuração do módulo logging.

@menu
* Funções de configuração:: 
* Considerações de segurança:: 
* Esquema do Dicionário de Configuração:: 
* Formato do arquivo de configuração:: 

@end menu

@node Funções de configuração,Considerações de segurança,,logging config — Configuração do módulo logging
@anchor{library/logging config configuration-functions}@anchor{2e8d}@anchor{library/logging config logging-config-api}@anchor{1335}
@subsubsection Funções de configuração


As funções a seguir configuram o módulo logging. Elas estão localizadas no módulo @ref{88,,logging.config}. Seu uso é opcional — você pode configurar o módulo logging usando essas funções ou fazendo chamadas para a API principal (definido no próprio @ref{87,,logging}) e definindo manipuladores que são declarados em @ref{87,,logging} ou em @ref{89,,logging.handlers}.

@geindex dictConfig() (no módulo logging.config)
@anchor{library/logging config logging config dictConfig}@anchor{11ef}
@deffn {Função} logging.config.dictConfig (config)

Obtém a configuração de logging de um dicionário. Os conteúdos desse dicionário estão descritos abaixo em @ref{2e8e,,Esquema do Dicionário de Configuração}.

Se um erro for encontrado durante a configuração, esta função levantará uma exceção @ref{202,,ValueError}, @ref{2c3,,TypeError}, @ref{34b,,AttributeError} ou @ref{419,,ImportError} com uma mensagem adequadamente descritiva.  A seguir está uma lista (possivelmente incompleta) de condições que levantarão um erro:


@itemize *

@item 
Um @code{level} que não seja uma string ou que seja uma string que não corresponda a um nível de logging atual

@item 
Um valor @code{propagate} que não seja um booleano.

@item 
Um id que não tenha um destino correspondente.

@item 
Um id de manipulador inexistente encontrado durante uma chamada incremental.

@item 
Um nome de logger inválido.

@item 
Incapacidade de resolver para um objeto interno ou externo.
@end itemize

A análise é realizada pela classe @code{DictConfigurator}, cujo construtor recebe o dicionário usado para a configuração e possui um método @code{configure()}. O módulo @ref{88,,logging.config} tem um atributo chamável @code{dictConfigClass} que é inicialmente definido como @code{DictConfigurator}. Você pode substituir o valor de @code{dictConfigClass} por uma implementação adequada de sua autoria.

A função @ref{11ef,,dictConfig()} chama @code{dictConfigClass} passando o dicionário especificado e, em seguida, chama o método @code{configure()} no objeto devolvido para colocar a configuração em efeito:

@example
def dictConfig(config):
    dictConfigClass(config).configure()
@end example

Por exemplo, uma subclasse de @code{DictConfigurator} poderia chamar @code{DictConfigurator.__init__()} no seu próprio @code{__init__()}, em seguida, configurar prefixos personalizados que seriam utilizáveis na chamada @code{configure()} subsequente.  @code{dictConfigClass} seria ligado a esta nova subclasse, e então @ref{11ef,,dictConfig()} poderia ser chamado exatamente como no estado padrão, sem personalização.


Adicionado na versão 3.2.

@end deffn

@geindex fileConfig() (no módulo logging.config)
@anchor{library/logging config logging config fileConfig}@anchor{b66}
@deffn {Função} logging.config.fileConfig (fname, defaults=None, disable_existing_loggers=True, encoding=None)

Lê a configuração de logging de um arquivo no formato @ref{22,,configparser}. O formato do arquivo deve ser como descrito em @ref{2e8f,,Formato do arquivo de configuração}. Esta função pode ser chamada várias vezes a partir de uma aplicação, permitindo que um usuário final selecione entre várias configurações pré-prontas (se o desenvolvedor fornecer um mecanismo para apresentar as escolhas e carregar a configuração escolhida).

A função levantará uma exceção @ref{42b,,FileNotFoundError} se o arquivo não existir e @ref{195,,RuntimeError} se o arquivo for inválido ou vazio.

@*Parâmetros: 

@itemize *

@item 
@code{fname} – Um nome de arquivo, ou um objeto arquivo, ou uma instância derivada de @ref{f98,,RawConfigParser}. Se uma instância derivada de @code{RawConfigParser} for passada, ela é usada como está. Caso contrário, uma instância de @ref{1c8,,ConfigParser} é criada, e a configuração é lida por ela a partir do objeto passado em @code{fname}. Se esse objeto tiver um método @ref{ba,,readline()}, ele é presumido como um objeto arquivo ou similar e lido usando @ref{506,,read_file()}; caso contrário, é presumido como um nome de arquivo e passado para @ref{14b0,,read()}.

@item 
@code{defaults} – Os defaults a serem passados para o @code{ConfigParser} podem ser especificados nesse argumento.

@item 
@code{disable_existing_loggers} – Se especificado como @code{False}, os loggers que existem quando esta chamada é feita são deixados habilitados. O padrão é @code{True} porque isso habilita o comportamento antigo de forma retrocompatível. Este comportamento é para desabilitar quaisquer loggers não-raiz existentes, a menos que eles ou seus ancestrais sejam explicitamente nomeados na configuração de logging.

@item 
@code{encoding} – A codificação usada para abrir o arquivo quando fname é um nome de arquivo.
@end itemize



Alterado na versão 3.4: Uma instância de uma subclasse de @ref{f98,,RawConfigParser} agora é aceita como um valor para @code{fname}. Isso facilita:

@quotation


@itemize *

@item 
Uso de um arquivo de configuração onde a configuração de logging é apenas parte da configuração geral da aplicação.

@item 
Uso de uma configuração lida de um arquivo, e então modificada pela aplicação que a usa (por exemplo, baseada em parâmetros de linha de comando ou outros aspectos do ambiente de tempo de execução) antes de ser passada para @code{fileConfig}.
@end itemize
@end quotation


Alterado na versão 3.10: Adicionado o parâmetro encoding.



Alterado na versão 3.12: Uma exceção será levantada se o arquivo fornecido não existir ou for inválido ou for vazio.


@end deffn

@geindex listen() (no módulo logging.config)
@anchor{library/logging config logging config listen}@anchor{f99}
@deffn {Função} logging.config.listen (port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)

Inicia um servidor soquete na porta especificada e escuta por novas configurações. Se nenhuma porta for especificada, o padrão do módulo @code{DEFAULT_LOGGING_CONFIG_PORT} é usado. As configurações de logging serão enviadas como um arquivo adequado para processamento por @ref{11ef,,dictConfig()} ou por @ref{b66,,fileConfig()}. Retorna uma instância de @ref{953,,Thread} na qual você pode chamar @ref{2e90,,start()} para iniciar o servidor, e à qual você pode @ref{1224,,join()} quando apropriado. Para interromper o servidor, chame @ref{2e91,,stopListening()}.

O argumento @code{verify}, se especificado, deve ser um chamável que verifique se os bytes recebidos através do soquete são válidos e devem ser processados. Isso pode ser feito criptografando e/ou assinando o que é enviado através do soquete, de modo que o chamável @code{verify} possa realizar a verificação de assinatura e/ou a descriptografia. O chamável @code{verify} é chamado com um único argumento – os bytes recebidos através do soquete – e deve retornar os bytes a serem processados, ou @code{None} para indicar que os bytes devem ser descartados. Os bytes devolvidos podem ser os mesmos que os bytes passados (por exemplo, quando apenas a verificação é feita), ou podem ser completamente diferentes (talvez se a descriptografia for realizada).

Para enviar uma configuração para o soquete, leia o arquivo de configuração e o envie para o soquete como uma sequência de bytes precedida por uma string de comprimento de quatro bytes empacotada em binário usando @code{struct.pack('>L', n)}.
@anchor{library/logging config logging-eval-security}@anchor{2e92}
@cartouche
@quotation Nota 
Como partes da configuração são passadas por @ref{180,,eval()}, o uso dessa função pode expor seus usuários a um risco de segurança. Embora a função apenas se vincule a um soquete em @code{localhost} e, portanto, não aceite conexões de máquinas remotas, existem cenários em que código não confiável pode ser executado sob a conta do processo que chama @ref{f99,,listen()}. Especificamente, se o processo que chama @ref{f99,,listen()} estiver sendo executado em uma máquina multiusuário onde os usuários não confiam uns nos outros, um usuário malicioso pode conseguir executar essencialmente código arbitrário no processo de um usuário vítima, simplesmente conectando-se ao soquete @ref{f99,,listen()} da vítima e enviando uma configuração que execute qualquer código que o atacante queira que seja executado no processo da vítima. Isso é especialmente fácil de fazer se a porta padrão for usada, mas não é difícil mesmo se uma porta diferente for utilizada. Para evitar o risco de isso acontecer, use o argumento @code{verify} de @ref{f99,,listen()} para prevenir que configurações não reconhecidas sejam aplicadas.
@end quotation
@end cartouche


Alterado na versão 3.4: O argumento @code{verify} foi adicionado.


@cartouche
@quotation Nota 
Se você deseja enviar configurações para o listener que não desabilitem os loggers existentes, você precisará usar um formato JSON para a configuração, que usará @ref{11ef,,dictConfig()} para configuração. Este método permite que você especifique @code{disable_existing_loggers} como @code{False} na configuração que você envia.
@end quotation
@end cartouche
@end deffn

@geindex stopListening() (no módulo logging.config)
@anchor{library/logging config logging config stopListening}@anchor{2e91}
@deffn {Função} logging.config.stopListening ()

Interrompe o servidor de escuta que foi criado com uma chamada para @ref{f99,,listen()}. Essa função é tipicamente chamada antes de chamar @code{join()} no valor de retorno de @ref{f99,,listen()}.
@end deffn

@node Considerações de segurança,Esquema do Dicionário de Configuração,Funções de configuração,logging config — Configuração do módulo logging
@anchor{library/logging config security-considerations}@anchor{2e93}
@subsubsection Considerações de segurança


A funcionalidade de configuração de logging tenta oferecer conveniência, e em parte isso é feito ao oferecer a capacidade de converter texto presente em arquivos de configuração em objetos Python usados na configuração de logging — por exemplo, conforme descrito em @ref{2e94,,Objetos definidos pelo usuário}. No entanto, esses mesmos mecanismos (importar chamáveis de módulos definidos pelo usuário e chamá-los com parâmetros da configuração) poderiam ser usados para invocar qualquer código que você desejar, e por essa razão você deve tratar arquivos de configuração de fontes não confiáveis com extrema cautela e certificar-se de que nada de ruim pode acontecer se você carregá-los, antes de realmente carregá-los.

@node Esquema do Dicionário de Configuração,Formato do arquivo de configuração,Considerações de segurança,logging config — Configuração do módulo logging
@anchor{library/logging config configuration-dictionary-schema}@anchor{2e95}@anchor{library/logging config logging-config-dictschema}@anchor{2e8e}
@subsubsection Esquema do Dicionário de Configuração


Descrever uma configuração de logging requer listar os vários objetos a serem criados e as conexões entre eles; por exemplo, você pode criar um manipulador nomeado ‘console’ e, em seguida, dizer que o logger nomeado ‘startup’ enviará suas mensagens para o manipulador ‘console’. Estes objetos não se limitam àqueles fornecidos pelo módulo @ref{87,,logging}, pois você pode escrever sua própria classe de formatador ou de manipulador. Os parâmetros para essas classes também podem precisar incluir objetos externos, como @code{sys.stderr}.  A sintaxe para descrever esses objetos e conexões é definida abaixo em @ref{2e96,,Conexões de objeto}.

@menu
* Detalhes do Esquema de Dicionário:: 
* Configuração Incremental:: 
* Conexões de objeto:: 
* Objetos definidos pelo usuário:: 
* Ordem de configuração de manipuladores:: 
* Acesso a objetos externos:: 
* Acesso a objetos internos:: 
* Resolução de importações e importadores personalizados:: 
* Configurando QueueHandler e QueueListener:: 

@end menu

@node Detalhes do Esquema de Dicionário,Configuração Incremental,,Esquema do Dicionário de Configuração
@anchor{library/logging config dictionary-schema-details}@anchor{2e97}
@subsubsection Detalhes do Esquema de Dicionário


O dicionário passado para @ref{11ef,,dictConfig()} deve conter as chaves a seguir:


@itemize *

@item 
version - deve ser definido como um valor inteiro representando a versão do esquema. O único valor válido atualmente é 1, mas ter esta chave permite que o esquema evolua, preservando ainda a retrocompatibilidade.
@end itemize

Todas as outras chaves são opcionais, mas se estiverem presentes, serão interpretadas conforme descrito abaixo. Em todos os casos abaixo onde um ‘dicionário de configuração’ é mencionado, ele será verificado quanto à chave especial @code{'()'} para consultar se uma instanciação personalizada é necessária. Se for o caso, o mecanismo descrito em @ref{2e94,,Objetos definidos pelo usuário} abaixo é usado para criar uma instância; caso contrário, o contexto é usado para determinar o que instanciar.
@anchor{library/logging config logging-config-dictschema-formatters}@anchor{2e98}

@itemize *

@item 
formatters - o valor correspondente será um dicionário em que cada chave é um id de formatador e cada valor é um dicionário que descreve como configurar a instância correspondente de @ref{14df,,Formatter}.

O dicionário de configuração é buscado pelas chaves opcionais a seguir que correspondem aos argumentos passados para criar um objeto @ref{14df,,Formatter}:


@itemize *

@item 
@code{format}

@item 
@code{datefmt}

@item 
@code{style}

@item 
@code{validate} (desde a versão >=3.8)

@item 
@code{defaults} (desde versão >=3.12)
@end itemize

Uma chave opcional @code{class} indica o nome da classe do formatador (como um módulo pontilhado e nome da classe).  Os argumentos de instanciação são os mesmos que para @ref{14df,,Formatter} portanto, esta chave é mais útil para instanciar uma subclasse personalizada de :@ref{14df,,Formatter}.  Por exemplo, a classe alternativa pode apresentar tracebacks de exceção em um formato expandido ou condensado. Se o seu formatter exigir chaves de configuração diferentes ou extras, você deve usar @ref{2e94,,Objetos definidos pelo usuário}.

@item 
filters - o valor correspondente será um dicionário no qual cada chave é um id de filter e cada valor é um dicionário que descreve como configurar a instância Filter correspondente.

O dicionário de configuração é pesquisado pela chave @code{name} (que assume como padrão a string vazia) e esta é usada para construir uma instância de @ref{123b,,logging.Filter}.

@item 
handlers - o valor correspondente será um dicionário no qual cada chave é um id de manipulador e cada valor é um dicionário que descreve como configurar a instância de Manipulador correspondente.

O dicionário de configuração é pesquisado para as chaves a seguir:


@itemize *

@item 
@code{class} (obrigatório). Esse é o nome qualificado completo da classe do handler.

@item 
@code{level} (opcional).  O nível do manipulador.

@item 
@code{formatter} (opcional).  O id do formatador para esse manipulador.

@item 
@code{filters} (opcional).  Uma lista de ids dos filtros para esse manipulador.


Alterado na versão 3.11: @code{filters} podem receber instâncias de filtro além de ids.

@end itemize

Todas as `outras' chaves são transmitidas como argumento nomeado para o construtor do manipulador.  Por exemplo, dado o trecho:

@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

o manipulador com o id @code{console} é instanciado como um @ref{1238,,logging.StreamHandler}, usando @code{sys.stdout} como o fluxo subjacente. O manipulador com o id @code{file} é instanciado como um @ref{16c2,,logging.handlers.RotatingFileHandler} com os argumentos nomeados @code{filename='logconfig.log', maxBytes=1024, backupCount=3}.

@item 
`loggers'  -  o valor correspondente será um dicionário no qual cada chave é o nome de um registradores e cada valor é um dicionário que descreve como configurar a instância de Registrador correspondente.

O dicionário de configuração é pesquisado para as chaves a seguir:


@itemize *

@item 
@code{level} (opcional).  O nível do logger.

@item 
@code{propagate} (opcional).  A configuração de propagação do logger.

@item 
@code{filters} (opcional).  Uma lista de ids dos filtros para esse logger.


Alterado na versão 3.11: @code{filters} podem receber instâncias de filtro além de ids.


@item 
@code{handlers} (opcional).  Uma lista de ids dos manipuladores para esse logger.
@end itemize

Os loggers especificados serão configurados de acordo com o nível, a propagação, os filtros e os manipuladores especificados.

@item 
`root' - essa será a configuração para o logger raiz. O processamento da configuração será igual ao de qualquer logger, exceto pelo fato de que a configuração @code{propagate} não será aplicável.

@item 
`incremental' - se a configuração deve ser interpretada como incremental à configuração existente.  O padrão deste valor é @code{False}, o que significa que a configuração especificada substitui a configuração existente com a mesma semântica usada pela configuração da API existente @ref{b66,,fileConfig()}.

Se o valor especificado for @code{True}, a configuração será processada conforme descrito na seção @ref{2e99,,Configuração Incremental}.

@item 
`disable_existing_loggers' - se quaisquer loggers não raiz existentes devem ser desabilitados. Essa configuração reflete o parâmetro de mesmo nome em @ref{b66,,fileConfig()}. Se ausente, o padrão deste parâmetro é @code{True}. Este valor é ignorado se `incremental' for @code{True}.
@end itemize

@node Configuração Incremental,Conexões de objeto,Detalhes do Esquema de Dicionário,Esquema do Dicionário de Configuração
@anchor{library/logging config incremental-configuration}@anchor{2e9a}@anchor{library/logging config logging-config-dict-incremental}@anchor{2e99}
@subsubsection Configuração Incremental


É difícil oferecer total flexibilidade para a configuração incremental.  Por exemplo, como objetos, assim como filtros e formatadores, são anônimos, depois que uma configuração é definida, não é possível fazer referência a esse objeto anônimo ao ampliar uma configuração.

Além disso, não há um argumento convincente para alterar arbitrariamente o grafo de objetos de loggers, manipuladores, filtros e formatadores em tempo de execução, depois que uma configuração é definida; a verbosidade de loggers e manipuladores pode ser controlada simplesmente ajustando os níveis (e, no caso de loggers, os sinalizadores de propagação). Alterar o grafo de objetos arbitrariamente de forma segura é problemático em um ambiente multithread; embora não seja impossível, os benefícios não compensam a complexidade que isso acrescentaria à implementação.

Assim, quando a chave @code{incremental} de um dicionário de configuração estiver presente e for @code{True}, o sistema ignorará completamente quaisquer entradas @code{formatters} e @code{filters}, e processará apenas as configurações de @code{level} nas entradas @code{handlers}, e as configurações de @code{level} e @code{propagate} nas entradas @code{loggers} e @code{root}.

Usar um valor no dicionário de configuração permite que configurações sejam enviadas pela rede como dicionários pickled para um listener soquete. Assim, a verbosidade de logging de uma aplicação de longa execução pode ser alterada ao longo do tempo sem a necessidade de parar e reiniciar a aplicação.

@node Conexões de objeto,Objetos definidos pelo usuário,Configuração Incremental,Esquema do Dicionário de Configuração
@anchor{library/logging config logging-config-dict-connections}@anchor{2e96}@anchor{library/logging config object-connections}@anchor{2e9b}
@subsubsection Conexões de objeto


O esquema descreve um conjunto de objetos de logging — loggers, manipuladores, formatadores, filtros — que são conectados uns aos outros em um grafo de objetos. Assim, o esquema precisa representar conexões entre os objetos. Por exemplo, suponha que, após configurado, um determinado logger tenha anexado a si um determinado manipulador. Para os propósitos desta discussão, podemos dizer que o logger representa a origem e o manipulador representa o destino de uma conexão entre os dois. É claro que, nos objetos configurados, isso é representado pelo logger mantendo uma referência ao manipulador. No dicionário de configuração, isso é feito atribuindo a cada objeto de destino um id que o identifica de forma inequívoca e, em seguida, usando esse id na configuração do objeto de origem para indicar que existe uma conexão entre o objeto de origem e o objeto de destino com aquele id.

Então, por exemplo, considere o seguinte trecho 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

(Observação: o YAML é usado aqui porque é um pouco mais legível do que o formulário de origem Python equivalente para o dicionário.)

Os ids para loggers são os nomes dos loggers que seriam usados programaticamente para obter uma referência a esses loggers, por exemplo, @code{foo.bar.baz}. Os ids para Formatadores e Filtros podem ser qualquer valor de string (como @code{brief}, @code{precise} acima) e são transitórios, no sentido de que só têm significado durante o processamento do dicionário de configuração e são usados para determinar conexões entre objetos, não sendo persistidos em nenhum lugar após a conclusão da chamada de configuração.

O trecho acima indica que o logger nomeado @code{foo.bar.baz} deve ter dois manipuladores anexados a ele, que são descritos pelos IDs de manipulador @code{h1} e @code{h2}. O formatador para @code{h1} é o descrito pelo id @code{brief}, e o formatador para @code{h2} é o descrito pelo id @code{precise}.

@node Objetos definidos pelo usuário,Ordem de configuração de manipuladores,Conexões de objeto,Esquema do Dicionário de Configuração
@anchor{library/logging config logging-config-dict-userdef}@anchor{2e94}@anchor{library/logging config user-defined-objects}@anchor{2e9c}
@subsubsection Objetos definidos pelo usuário


O esquema oferece suporte a objetos definidos pelo usuário para manipuladores, filtros e formatadores.  (Os loggers não precisam ter tipos diferentes para instâncias diferentes, portanto este esquema de configuração não provê suporte às classes de loggers definidas pelo usuário.)

Objetos a serem configurados são descritos por dicionários que detalham sua configuração. Em alguns casos, o sistema de logging consegue inferir pelo contexto como um objeto deve ser instanciado, mas, quando se trata de um objeto definido pelo usuário, o sistema não saberá como fazer isso. Para oferecer total flexibilidade na instanciação desses objetos definidos pelo usuário, é necessário fornecer uma factory — um chamável que recebe um dicionário de configuração e retorna o objeto instanciado. Isso é sinalizado por um caminho de importação absoluto para a factory, disponibilizado sob a chave especial @code{'()'}. Aqui está um exemplo 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

O trecho YAML acima define três formatadores. O primeiro, com id @code{brief}, é uma instância padrão de @ref{14df,,logging.Formatter} com a string de formato especificado. O segundo, com id @code{default}, tem um formato mais longo e também define explicitamente o formato de tempo, e resultará em um @ref{14df,,logging.Formatter} inicializado com essas duas strings de formatação. Em código-fonte Python, os formatadores @code{brief} e @code{default} têm subdicionários de configuração:

@example
@{
  'format' : '%(message)s'
@}
@end example

e:

@example
@{
  'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',
  'datefmt' : '%Y-%m-%d %H:%M:%S'
@}
@end example

respectivamente; e como esses dicionários não contêm a chave especial @code{'()'}, a instanciação é inferida pelo contexto. Como resultado, são criadas instâncias padrão de @ref{14df,,logging.Formatter}. O subdicionário de configuração do terceiro formatador, com o id @code{custom}, é:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42
@}
@end example

e isso contém a chave especial @code{'()'}, o que significa que se deseja uma instanciação definida pelo usuário. Nesse caso, a função factory especificada será usada. Se for um chamável real, ele será usado diretamente — caso contrário, se você especificar uma string (como no exemplo), o chamável real será localizado usando os mecanismos normais de importação. O callable será chamado com os itens restantes no subdicionário de configuração como argumentos nomeados. No exemplo acima, assume-se que o formatter com id @code{custom} seja retornado pela chamada:

@example
my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
@end example

@cartouche
@quotation Aviso 
Os valores de chaves como @code{bar}, @code{spam} e @code{answer} no exemplo acima não devem ser dicionários de configuração nem referências como @code{cfg://foo}, ou @code{ext://bar} porque eles não serão processados pelo maquinário de configuração — serão simplesmente passados para a função callable como estão.
@end quotation
@end cartouche

A chave @code{'()'} foi usada como chave especial porque não é um nome válido de parâmetro nomeado e, portanto, não conflita com os nomes dos argumentos nomeados usados na chamada. O @code{'()'} também serve como um mnemônico de que o valor correspondente é um chamável.


Alterado na versão 3.11: O membro @code{filters} de @code{handlers} e @code{loggers} pode receber instâncias de filtro, além de ids.


Você também pode especificar uma chave especial @code{'.'} cujo valor é um mapeamento de nomes de atributos para valores. Se essa chave for encontrada, os atributos especificados serão definidos no objeto definido pelo usuário antes que ele seja retornado. Assim, com a seguinte configuração:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42,
  '.' @{
    'foo': 'bar',
    'baz': 'bozz'
  @}
@}
@end example

o formatador retornado terá o atributo @code{foo} definido como @code{'bar'} e o atributo @code{baz} definido como @code{'bozz'}.

@cartouche
@quotation Aviso 
Os valores de atributos como @code{foo} e @code{baz} no exemplo acima não devem ser dicionários de configuração nem referências como @code{cfg://foo} ou @code{ext://bar} porque eles não serão processados pelo maquinário de configuração, mas definidos como valores de atributo exatamente como foram fornecidos.
@end quotation
@end cartouche

@node Ordem de configuração de manipuladores,Acesso a objetos externos,Objetos definidos pelo usuário,Esquema do Dicionário de Configuração
@anchor{library/logging config handler-config-dict-order}@anchor{2e9d}@anchor{library/logging config handler-configuration-order}@anchor{2e9e}
@subsubsection Ordem de configuração de manipuladores


Os manipuladores são configurados em ordem alfabética de suas chaves, e um manipulador configurado substitui o dicionário de configuração no (cópia de trabalho do) dicionário @code{handlers} no esquema. Se você usar uma construção como @code{cfg://handlers.foo}, então inicialmente @code{handlers['foo']} aponta para o dicionário de configuração do manipulador nomeado @code{foo} e, posteriormente (quando esse manipulador tiver sido configurado), passa a apontar para a instância configurada do manipulador. Assim, @code{cfg://handlers.foo} pode ser resolvido tanto como um dicionário quanto como uma instância de manipulador. Em geral, é prudente nomear os manipuladores de modo que os manipuladores dependentes sejam configurados depois de quaisquer manipuladores dos quais dependam; isso permite que algo como @code{cfg://handlers.foo} seja usado na configuração de um manipulador que depende do handler @code{foo}. Se esse manipulador dependente fosse nomeado @code{bar}, surgiriam problemas, pois a configuração de @code{bar} seria tentada antes da de @code{foo}, e @code{foo} ainda não teria sido configurado. No entanto, se o manipulador dependente fosse nomeado @code{foobar}, ele seria configurado após @code{foo}, com o resultado de que @code{cfg://handlers.foo} seria resolvido para o manipulador @code{foo} configurado, e não para o seu dicionário de configuração.

@node Acesso a objetos externos,Acesso a objetos internos,Ordem de configuração de manipuladores,Esquema do Dicionário de Configuração
@anchor{library/logging config access-to-external-objects}@anchor{2e9f}@anchor{library/logging config logging-config-dict-externalobj}@anchor{2ea0}
@subsubsection Acesso a objetos externos


Há momentos em que uma configuração precisa se referir a objetos externos à configuração, por exemplo @code{sys.stderr}. Se o dicionário de configuração for construído usando código Python, isso é simples, mas surge um problema quando a configuração é fornecida por meio de um arquivo texto (por exemplo, JSON, YAML). Em um arquivo texto, não há uma forma padrão de distinguir @code{sys.stderr} da string literal @code{'sys.stderr'}.  Para facilitar essa distinção, o sistema de configuração procura por determinados prefixos especiais em valores de string e os trata de forma especial. Por exemplo, se a string literal @code{'ext://sys.stderr'} for fornecida como um valor na configuração, então o prefixo @code{ext://} será removido e o restante do valor será processado usando os mecanismos normais de importação.

O tratamento desses prefixos é feito de forma análoga ao tratamento de protocolos: existe um mecanismo genérico para procurar prefixos que correspondam à expressão regular ^(?P<prefix>[a-z]+)://(?P<suffix>.*), de modo que, se o @code{prefix} for reconhecido, o @code{suffix} é processado de uma forma dependente do prefixo e o resultado desse processamento substitui o valor da string. Se o prefixo não for reconhecido, então o valor da string é mantido como está.

@node Acesso a objetos internos,Resolução de importações e importadores personalizados,Acesso a objetos externos,Esquema do Dicionário de Configuração
@anchor{library/logging config access-to-internal-objects}@anchor{2ea1}@anchor{library/logging config logging-config-dict-internalobj}@anchor{2ea2}
@subsubsection Acesso a objetos internos


Além de objetos externos, às vezes também é necessário fazer referência a objetos na configuração. Isso será feito de forma implícita pelo sistema de configuração para coisas que ele conhece. Por exemplo, o valor em forma de string @code{'DEBUG'} para um @code{level} em um logger ou manipulador será automaticamente convertido para o valor @code{logging.DEBUG}, e as entradas @code{handlers}, @code{filters} e @code{formatter} receberão um identificador de objeto e o resolverão para o objeto de destino apropriado.

No entanto, é necessário um mecanismo mais genérico para objetos definidos pelo usuário que não são conhecidos pelo módulo @ref{87,,logging}. Por exemplo, considere @ref{2ea3,,logging.handlers.MemoryHandler}, que recebe um argumento @code{target} que é outro manipulador para o qual delegar. Como o sistema já conhece essa classe, então, na configuração, o @code{target} fornecido só precisa ser o id do objeto do manipulador de destino relevante, e o sistema resolverá esse id para o manipulador correspondente. Se, porém, um usuário definir um @code{my.package.MyHandler} que tenha um manipulador @code{alternate}, o sistema de configuração não saberia que @code{alternate} se refere a um manipulador. Para atender a esse caso, um sistema genérico de resolução permite que o usuário especifique:

@example
handlers:
  file:
    # configuration of file handler goes here

  custom:
    (): my.package.MyHandler
    alternate: cfg://handlers.file
@end example

A cadeia literal @code{'cfg://handlers.file'} será resolvida de maneira análoga às strings com o prefixo @code{ext://} mas procurando na própria configuração em vez do espaço de nomes de importação. O mecanismo permite acesso por ponto ou por índice, de forma semelhante ao que é fornecido por @code{str.format}. Assim, dado o seguinte trecho:

@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 uma string @code{cfg://handlers.myhandler.mykey.123}, ela será resolvida como @code{config_dict['handlers']['myhandler']['mykey']['123']}. Se a string for especificada como @code{cfg://handlers.myhandler.mykey[123]}, o sistema tentará obter o valor de @code{config_dict['handlers']['myhandler']['mykey'][123]} e, caso isso falhe, recorrerá a @code{config_dict['handlers']['myhandler']['mykey']['123']}.

@node Resolução de importações e importadores personalizados,Configurando QueueHandler e QueueListener,Acesso a objetos internos,Esquema do Dicionário de Configuração
@anchor{library/logging config import-resolution-and-custom-importers}@anchor{2ea4}@anchor{library/logging config logging-import-resolution}@anchor{2ea5}
@subsubsection Resolução de importações e importadores personalizados


Import resolution, by default, uses the builtin @ref{8da,,__import__()} function
to do its importing. You may want to replace this with your own importing
mechanism: if so, you can replace the @code{importer} attribute of the
@code{DictConfigurator} or its superclass, the
@code{BaseConfigurator} class. However, you need to be
careful because of the way functions are accessed from classes via
descriptors. If you are using a Python callable to do your imports, and you
want to define it at class level rather than instance level, you need to wrap
it with @ref{416,,staticmethod()}. For example:

@example
from importlib import import_module
from logging.config import BaseConfigurator

BaseConfigurator.importer = staticmethod(import_module)
@end example

Você não precisa envolver com @ref{416,,staticmethod()} se estiver definindo o chamável de importação em uma `instância' do configurador.

@node Configurando QueueHandler e QueueListener,,Resolução de importações e importadores personalizados,Esquema do Dicionário de Configuração
@anchor{library/logging config configure-queue}@anchor{16c5}@anchor{library/logging config configuring-queuehandler-and-queuelistener}@anchor{2ea6}
@subsubsection Configurando QueueHandler e QueueListener


If you want to configure a @ref{18ec,,QueueHandler}, noting that this
is normally used in conjunction with a @ref{e59,,QueueListener}, you
can configure both together. After the configuration, the @code{QueueListener} instance
will be available as the @ref{2ea7,,listener} attribute of
the created handler, and that in turn will be available to you using
@ref{18ed,,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

As chaves @code{queue} e @code{listener} são opcionais.

Se a chave @code{queue} estiver presente, o valor correspondente pode ser um dos seguintes:


@itemize *

@item 
An object implementing the @ref{2ea8,,Queue.put_nowait}
and @ref{2ea9,,Queue.get} public API. For instance, this may be
an actual instance of @ref{13db,,queue.Queue} or a subclass thereof, or a proxy
obtained by @ref{2eaa,,multiprocessing.managers.SyncManager.Queue()}.

É claro que isso só é possível se você estiver construindo ou modificando o dicionário de configuração no código.

@item 
Uma string que é resolvida para um chamável que, quando chamado sem argumentos, retorna a instância de fila a ser usada. Esse chamável pode ser uma subclasse de @ref{13db,,queue.Queue} ou uma função que retorna uma instância de fila adequada, como @code{my.module.queue_factory()}.

@item 
Um dicionário com a chave @code{'()'} que é construído da forma usual discutida em @ref{2e94,,Objetos definidos pelo usuário} O resultado dessa construção deve ser uma instância de @ref{13db,,queue.Queue}.
@end itemize

Se a chave @code{queue} estiver ausente, uma instância padrão e não limitada de @ref{13db,,queue.Queue} será criada e usada.

Se a chave @code{listener} estiver presente, o valor correspondente pode ser um dos seguintes:


@itemize *

@item 
Uma subclasse de @ref{e59,,logging.handlers.QueueListener}. Isso, naturalmente, só é possível se você estiver construindo ou modificando o dicionário de configuração em código.

@item 
Uma string que é resolvida para uma classe que seja uma subclasse de @code{QueueListener} como @code{'my.package.CustomListener'}.

@item 
Um dicionário com a chave @code{'()'}, construído da maneira usual conforme discutido em @ref{2e94,,Objetos definidos pelo usuário} O resultado dessa construção deve ser um chamável com a mesma assinatura do inicializador de @code{QueueListener}.
@end itemize

Se a chave @code{listener} estiver ausente, será usada @ref{e59,,logging.handlers.QueueListener}.

Os valores sob a chave @code{handlers} são os nomes de outros manipuladores na configuração (não mostrados no trecho acima) que serão passados ao queue listener.

Quaisquer classes personalizadas de manipulador de filas e de listener precisarão ser definidas com as mesmas assinaturas de inicialização que @ref{18ec,,QueueHandler} e @ref{e59,,QueueListener}.


Adicionado na versão 3.12.


@node Formato do arquivo de configuração,,Esquema do Dicionário de Configuração,logging config — Configuração do módulo logging
@anchor{library/logging config configuration-file-format}@anchor{2eab}@anchor{library/logging config logging-config-fileformat}@anchor{2e8f}
@subsubsection Formato do arquivo de configuração


The configuration file format understood by @ref{b66,,fileConfig()} is based on
@ref{22,,configparser} functionality. The file must contain sections called
@code{[loggers]}, @code{[handlers]} and @code{[formatters]} which identify by name the
entities of each type which are defined in the file. For each such entity, there
is a separate section which identifies how that entity is configured.  Thus, for
a logger named @code{log01} in the @code{[loggers]} section, the relevant
configuration details are held in a section @code{[logger_log01]}. Similarly, a
handler called @code{hand01} in the @code{[handlers]} section will have its
configuration held in a section called @code{[handler_hand01]}, while a formatter
called @code{form01} in the @code{[formatters]} section will have its configuration
specified in a section called @code{[formatter_form01]}. The root logger
configuration must be specified in a section called @code{[logger_root]}.

@cartouche
@quotation Nota 
The @ref{b66,,fileConfig()} API is older than the @ref{11ef,,dictConfig()} API and does
not provide functionality to cover certain aspects of logging. For example,
you cannot configure @ref{123b,,Filter} objects, which provide for
filtering of messages beyond simple integer levels, using @ref{b66,,fileConfig()}.
If you need to have instances of @ref{123b,,Filter} in your logging
configuration, you will need to use @ref{11ef,,dictConfig()}. Note that future
enhancements to configuration functionality will be added to
@ref{11ef,,dictConfig()}, so it’s worth considering transitioning to this newer
API when it’s convenient to do so.
@end quotation
@end cartouche

Exemplos dessas seções no arquivo são fornecidos abaixo.

@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

O logger raiz deve especificar um nível e uma lista de manipuladores. Um exemplo de seção de logger raiz é dado abaixo.

@example
[logger_root]
level=NOTSET
handlers=hand01
@end example

The @code{level} entry can be one of @code{DEBUG, INFO, WARNING, ERROR, CRITICAL} or
@code{NOTSET}. For the root logger only, @code{NOTSET} means that all messages will be
logged. Level values are @ref{2302,,evaluated} in the context of the @code{logging}
package’s namespace.

A entrada @code{handlers} é uma lista separada por vírgulas com os nomes dos manipuladores, que devem aparecer na seção @code{[handlers]}. Esses nomes precisam aparecer na seção @code{[handlers]} e ter seções correspondentes no arquivo de configuração.

Para loggers que não sejam o logger raiz, são necessárias algumas informações adicionais. Isso é ilustrado pelo exemplo a seguir.

@example
[logger_parser]
level=DEBUG
handlers=hand01
propagate=1
qualname=compiler.parser
@end example

As entradas @code{level} e @code{handlers} são interpretadas da mesma forma que o logger raiz, exceto que, se o nível de um logger não raiz for especificado como @code{NOTSET}, o sistema consulta os loggers situados acima na hierarquia para determinar o nível efetivo do logger. O item @code{propagate} é definido como 1 para indicar que as mensagens devem ser propagadas para os manipuladores acima na hierarquia de loggers a partir deste logger, ou 0 para indicar que as mensagens não são propagadas para manipuladores acima na hierarquia. O item @code{qualname} é o nome de canal hierárquico do logger, ou seja, o nome usado pela aplicação para obter o logger.

As seções que especificam a configuração de manipuladores são exemplificadas pelo seguinte.

@example
[handler_hand01]
class=StreamHandler
level=NOTSET
formatter=form01
args=(sys.stdout,)
@end example

A entrada @code{class} indica a classe do manipulador (conforme determinada por @ref{180,,eval()} no espaço de nomes do pacote @code{logging}). O @code{level} é interpretado da mesma forma que para loggers, e @code{NOTSET} é entendido como “registrar tudo”.

A entrada @code{formatter} indica o nome da chave do formatador para esse manipulador. Se estiver em branco, um formatador padrão (@code{logging._defaultFormatter}) será usado. Se um nome for especificado, ele deve aparecer na seção @code{[formatters]} e ter uma seção correspondente no arquivo de configuração.

The @code{args} entry, when @ref{2302,,evaluated} in the context of the @code{logging}
package’s namespace, is the list of arguments to the constructor for the handler
class. Refer to the constructors for the relevant handlers, or to the examples
below, to see how typical entries are constructed. If not provided, it defaults
to @code{()}.

The optional @code{kwargs} entry, when @ref{2302,,evaluated} in the context of the
@code{logging} package’s namespace, is the keyword argument dict to the constructor
for the handler class. If not provided, it defaults to @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

As seções que especificam a configuração do formatador são caracterizadas pelo seguinte.

@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

The arguments for the formatter configuration are the same as the keys
in the dictionary schema @ref{2e98,,formatters section}.

The @code{defaults} entry, when @ref{2302,,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 
Devido ao uso de @ref{180,,eval()} conforme descrito acima, há riscos de segurança potenciais decorrentes do uso de @ref{f99,,listen()} para enviar e receber configurações por meio de soquetes. Os riscos se limitam a situações em que vários usuários sem confiança mútua executam código na mesma máquina; consulte a documentação de @ref{f99,,listen()} para mais informações.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item Módulo @ref{87,,logging}

Referência da API para o módulo de logging.

@item Módulo @ref{89,,logging.handlers}

Tratadores úteis incluídos no módulo logging.
@end table


@node logging handlers — Manipuladores de logging,platform — Acesso aos dados de identificação da plataforma subjacente,logging config — Configuração do módulo logging,Serviços Genéricos do Sistema Operacional
@anchor{library/logging handlers doc}@anchor{2eac}@anchor{library/logging handlers logging-handlers-logging-handlers}@anchor{2ead}@anchor{library/logging handlers module-logging handlers}@anchor{89}@anchor{library/logging handlers translation-repo}@anchor{2eae}
@subsection @code{logging.handlers} — Manipuladores de logging


@geindex module; logging.handlers

`Código-fonte:' Lib/logging/handlers.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/logging/handlers.py}

@subsubheading Important



Esta página contém apenas informações de referência. Para tutoriais, por favor consulte


@itemize *

@item 
@ref{1235,,Tutorial básico}

@item 
@ref{1236,,Tutorial avançado}

@item 
@ref{1237,,Livro de receitas de logging}
@end itemize


__________________________________________________________________


Os seguintes tratadores úteis são fornecidos neste pacote. Observe que três dos tratadores (@ref{1238,,StreamHandler}, @ref{19de,,FileHandler} e @ref{12c6,,NullHandler}) são, na verdade, definidos no próprio módulo @ref{87,,logging}, mas foram documentados aqui junto com os outros tratadores.

@menu
* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* SysLogHandler:: 
* NTEventLogHandler:: 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

@end menu

@node StreamHandler,FileHandler,,logging handlers — Manipuladores de logging
@anchor{library/logging handlers stream-handler}@anchor{2eaf}@anchor{library/logging handlers streamhandler}@anchor{2eb0}
@subsubsection StreamHandler


A classe @ref{1238,,StreamHandler} localizada no pacote principal @ref{87,,logging}, envia a saída de log para fluxos como `sys.stdout', `sys.stderr' ou qualquer objeto arquivo ou similar (ou, mais precisamente, qualquer objeto que provê os métodos @code{write()} e @code{flush()}).

@geindex StreamHandler (classe em logging)
@anchor{library/logging handlers logging StreamHandler}@anchor{1238}
@deffn {Classe} logging.StreamHandler (stream=None)

Retorna uma nova instância da classe @ref{1238,,StreamHandler} Se `stream' for especificado, a instância irá utilizá-lo para a saída de log; caso contrário, `sys.stderr' será usado.

@geindex emit() (método logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler emit}@anchor{2eb1}
@deffn {Método} emit (record)

Se um formatador for especificado, ele será usado para formatar o registro. Em seguida, o registro é escrito no fluxo, seguido por @ref{2eb2,,terminator} Se houver informações de exceção, elas são formatadas usando @ref{852,,traceback.print_exception()} e anexadas ao fluxo.
@end deffn

@geindex flush() (método logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler flush}@anchor{2eb3}
@deffn {Método} flush ()

Esvazia o fluxo chamando seu método @ref{2eb3,,flush()}. Observe que o método @code{close()} é herdado de @ref{14de,,Handler} e, portanto, não produz nenhuma saída, de modo que uma chamada explícita a @ref{2eb3,,flush()} pode ser necessária em alguns casos.
@end deffn

@geindex setStream() (método logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler setStream}@anchor{b65}
@deffn {Método} setStream (stream)

Define o fluxo da instância para o valor especificado, caso seja diferente. O fluxo antigo é esvaziado antes que o novo fluxo seja definido.

@*Parâmetros: 
@code{stream} – O fluxo que o manipulador deve usar.


@*Retorna: 
o fluxo antigo, se o fluxo tiver sido alterado, ou @code{None}, se não tiver sido.



Adicionado na versão 3.7.

@end deffn

@geindex terminator (atributo logging.StreamHandler)
@anchor{library/logging handlers logging StreamHandler terminator}@anchor{2eb2}
@deffn {Atributo} terminator

String usada como terminador ao gravar um registro formatado em um fluxo. O valor padrão é @code{'\n'}.

Se você não quiser uma terminação com nova linha, pode definir o atributo @code{terminator} da instância do manipulador como uma string vazia.

Nas versões anteriores, o terminador era codificado diretamente como @code{'\n'}.


Adicionado na versão 3.2.

@end deffn
@end deffn

@node FileHandler,NullHandler,StreamHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers file-handler}@anchor{2eb4}@anchor{library/logging handlers filehandler}@anchor{2eb5}
@subsubsection FileHandler


A classe @ref{19de,,FileHandler}, localizada no pacote principal @ref{87,,logging}, envia a saída de logging para um arquivo em disco. Ela herda a funcionalidade de saída da classe @ref{1238,,StreamHandler}.

@geindex FileHandler (classe em logging)
@anchor{library/logging handlers logging FileHandler}@anchor{19de}
@deffn {Classe} logging.FileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

Retorna uma nova instância da classe @ref{19de,,FileHandler}. O arquivo especificado é aberto e usado como o fluxo para logging. Se `mode' não for especificado, @code{'a'} é usado. Se `encoding' não for @code{None}, ele é usado para abrir o arquivo com essa codificação. Se `delay' for verdadeiro, então a abertura do arquivo é adiada até a primeira chamada de @ref{2eb6,,emit()} Por padrão, o arquivo cresce indefinidamente. Se `errors' for especificado, ele é usado para determinar como os erros de codificação serão tratados.


Alterado na versão 3.6: Além de valores do tipo string, objetos @ref{229,,Path} também são aceitos para o argumento `filename'.



Alterado na versão 3.9: O parâmetro `errors' foi adicionado.


@geindex close() (método logging.FileHandler)
@anchor{library/logging handlers logging FileHandler close}@anchor{2eb7}
@deffn {Método} close ()

Fecha o arquivo.
@end deffn

@geindex emit() (método logging.FileHandler)
@anchor{library/logging handlers logging FileHandler emit}@anchor{2eb6}
@deffn {Método} emit (record)

Envia o registro para o arquivo.

Observe que, se o arquivo tiver sido fechado devido ao encerramento do sistema de logging na saída e o modo do arquivo for ‘w’, o registro não será emitido (veja bpo-42378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42378}).
@end deffn
@end deffn

@node NullHandler,WatchedFileHandler,FileHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers null-handler}@anchor{2eb8}@anchor{library/logging handlers nullhandler}@anchor{2eb9}
@subsubsection NullHandler



Adicionado na versão 3.1.


A classe @ref{12c6,,NullHandler}, localizada no pacote principal @ref{87,,logging}, não realiza qualquer formatação ou saída. Ela é essencialmente um manipulador ‘no-op’, destinado ao uso por desenvolvedores de bibliotecas.

@geindex NullHandler (classe em logging)
@anchor{library/logging handlers logging NullHandler}@anchor{12c6}
@deffn {Classe} logging.NullHandler

Retorna uma nova instância da classe @ref{12c6,,NullHandler}.

@geindex emit() (método logging.NullHandler)
@anchor{library/logging handlers logging NullHandler emit}@anchor{2eba}
@deffn {Método} emit (record)

Esse método não faz nada.
@end deffn

@geindex handle() (método logging.NullHandler)
@anchor{library/logging handlers logging NullHandler handle}@anchor{2ebb}
@deffn {Método} handle (record)

Esse método não faz nada.
@end deffn

@geindex createLock() (método logging.NullHandler)
@anchor{library/logging handlers logging NullHandler createLock}@anchor{2ebc}
@deffn {Método} createLock ()

Este método retorna @code{None} para a trava, pois não há E/S subjacente cujo acesso precise ser serializado.
@end deffn
@end deffn

Consulte @ref{2ebd,,Configurando logging para uma biblioteca} para obter mais informações sobre como usar @ref{12c6,,NullHandler}.

@node WatchedFileHandler,BaseRotatingHandler,NullHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers watched-file-handler}@anchor{2ebe}@anchor{library/logging handlers watchedfilehandler}@anchor{2ebf}
@subsubsection WatchedFileHandler


A classe @ref{2ec0,,WatchedFileHandler}, localizada no módulo @ref{89,,logging.handlers}, é um @code{FileHandler} que monitora o arquivo no qual está registrando logs. Se o arquivo for alterado, ele é fechado e reaberto usando o nome do arquivo.

Uma alteração no arquivo pode ocorrer devido ao modo de usar de programas como `newsyslog' e `logrotate', que realizam a rotação de arquivos de log. Este manipulador, destinado ao uso em Unix/Linux, monitora o arquivo para verificar se ele foi alterado desde a última chamada a emit. (Considera-se que um arquivo foi alterado se o seu dispositivo ou nó-i tiverem mudado.) Se o arquivo tiver sido alterado, o fluxo do arquivo antigo é fechado, e o arquivo é aberto novamente para obter um novo fluxo.

Este manipulador não é apropriado para uso no Windows, porque, nesse sistema, arquivos de log abertos não podem ser movidos ou renomeados — o logging abre os arquivos com travas exclusivas — e, portanto, não há necessidade desse tipo de manipulador. Além disso, `ST_INO' não é suportado no Windows; @ref{4a0,,stat()} sempre retorna zero para esse valor.

@geindex WatchedFileHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers WatchedFileHandler}@anchor{2ec0}
@deffn {Classe} logging.handlers.WatchedFileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

Retorna uma nova instância da classe @ref{2ec0,,WatchedFileHandler}. O arquivo especificado é aberto e usado como o fluxo para registro de logs. Se `mode' não for especificado, @code{'a'} será usado. Se encoding não for @code{None}, ele será usado para abrir o arquivo com essa codificação. Se `delay' for verdadeiro, a abertura do arquivo é adiada até a primeira chamada a @ref{2ec1,,emit()}. Por padrão, o arquivo cresce indefinidamente. Se `errors' for fornecido, ele determina como erros de codificação são tratados.


Alterado na versão 3.6: Além de valores do tipo string, objetos @ref{229,,Path} também são aceitos para o argumento `filename'.



Alterado na versão 3.9: O parâmetro `errors' foi adicionado.


@geindex reopenIfNeeded() (método logging.handlers.WatchedFileHandler)
@anchor{library/logging handlers logging handlers WatchedFileHandler reopenIfNeeded}@anchor{cd6}
@deffn {Método} reopenIfNeeded ()

Verifica se o arquivo foi alterado. Se tiver sido, o fluxo existente é descarregado e fechado, e o arquivo é aberto novamente, normalmente como um passo preliminar antes de enviar o registro para o arquivo.


Adicionado na versão 3.6.

@end deffn

@geindex emit() (método logging.handlers.WatchedFileHandler)
@anchor{library/logging handlers logging handlers WatchedFileHandler emit}@anchor{2ec1}
@deffn {Método} emit (record)

Emite o registro para o arquivo, mas antes chama @ref{cd6,,reopenIfNeeded()} para reabrir o arquivo caso ele tenha sido alterado.
@end deffn
@end deffn

@node BaseRotatingHandler,RotatingFileHandler,WatchedFileHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers base-rotating-handler}@anchor{2ec2}@anchor{library/logging handlers baserotatinghandler}@anchor{2ec3}
@subsubsection BaseRotatingHandler


A classe @ref{2ec4,,BaseRotatingHandler}, localizada no módulo @ref{89,,logging.handlers}, é a classe base para os tratadores de arquivos com rotação, @ref{16c2,,RotatingFileHandler} e @ref{f95,,TimedRotatingFileHandler} Em geral, não é necessário instanciar essa classe, mas ela possui atributos e métodos que podem precisar ser substituídos.

@geindex BaseRotatingHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers BaseRotatingHandler}@anchor{2ec4}
@deffn {Classe} logging.handlers.BaseRotatingHandler (filename, mode, encoding=None, delay=False, errors=None)

Os parâmetros são os mesmos de @code{FileHandler}. Os atributos são:

@geindex namer (atributo logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler namer}@anchor{2ec5}
@deffn {Atributo} namer

Se esse atributo for definido como um chamável, o método @ref{2ec6,,rotation_filename()} delega a ele. Os parâmetros passados ao chamável são os mesmos passados para @ref{2ec6,,rotation_filename()}.

@cartouche
@quotation Nota 
A função namer é chamada muitas vezes durante a rotação, portanto deve ser a mais simples e rápida possível. Ela também deve retornar sempre o mesmo resultado para uma dada entrada; caso contrário, o comportamento da rotação pode não funcionar como esperado.

Também vale observar que é preciso ter cuidado ao usar um namer para preservar certos atributo no nome do arquivo que são usados durante a rotação. Por exemplo, @ref{16c2,,RotatingFileHandler} espera ter um conjunto de arquivos de log cujos nomes contenham inteiros sucessivos, para que a rotação funcione como esperado, e @ref{f95,,TimedRotatingFileHandler} remova arquivos de log antigos (com base no parâmetro @code{backupCount} passado ao inicializador do manipulador) determinando quais são os arquivos mais antigos a serem excluídos. Para que isso funcione, os nomes dos arquivos devem ser ordenáveis usando a porção de data/hora do nome, e um namer precisa respeitar isso. (Se for desejado um namer que não respeite esse esquema, ele deverá ser usado em uma subclasse de @ref{f95,,TimedRotatingFileHandler} que substitua o método @ref{2ec7,,getFilesToDelete()} para se adequar ao esquema de nomeação personalizado.)
@end quotation
@end cartouche


Adicionado na versão 3.3.

@end deffn

@geindex rotator (atributo logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotator}@anchor{2ec8}
@deffn {Atributo} rotator

Se este atributo estiver definido como um chamável, o método @ref{2ec9,,rotate()} delega a esse chamável. Os parâmetros passados ao chamável são os mesmos passados para @ref{2ec9,,rotate()}.


Adicionado na versão 3.3.

@end deffn

@geindex rotation_filename() (método logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotation_filename}@anchor{2ec6}
@deffn {Método} rotation_filename (default_name)

Modifica o nome do arquivo de log durante a rotação.

Isso é fornecido para que um nome de arquivo personalizado possa ser providenciado.

A implementação padrão chama o atributo namer do manipulador, se ele for chamável, passando o nome padrão para ele. Se o atributo não for chamável (o padrão é @code{None}), o nome é devolvido sem alterações.

@*Parâmetros: 
@code{default_name} – O nome padrão para o arquivo de log.



Adicionado na versão 3.3.

@end deffn

@geindex rotate() (método logging.handlers.BaseRotatingHandler)
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotate}@anchor{2ec9}
@deffn {Método} rotate (source, dest)

Quando ocorre a rotação, rotaciona o log atual.

A implementação padrão chama o atributo rotator do manipulador, se ele for chamável, passando os argumentos source e dest para ele. Se o atributo não for chamável (o padrão é @code{None}), o arquivo de origem é simplesmente renomeado para o destino.

@*Parâmetros: 

@itemize *

@item 
@code{source} – O nome do arquivo de origem. Normalmente, este é o nome base do arquivo, por exemplo, ‘test.log’.

@item 
@code{dest} – O nome do arquivo de destino. Normalmente, é para onde o arquivo de origem é rotacionado, por exemplo, ‘test.log.1’.
@end itemize



Adicionado na versão 3.3.

@end deffn
@end deffn

O motivo da existência desses atributos é evitar que você precise criar subclasses — é possível usar os mesmos chamáveis para instâncias de @ref{16c2,,RotatingFileHandler} e @ref{f95,,TimedRotatingFileHandler}. Se o chamável namer ou rotator levantar uma exceção, ela será tratada da mesma forma que qualquer outra exceção durante uma chamada a @code{emit()}, isto é, por meio do método @code{handleError()} do manipulador.

Se precisar fazer alterações mais significativas no processamento de rotação, você pode substituir os métodos.

Para um exemplo, consulte @ref{2eca,,Using a rotator and namer to customize log rotation processing}.

@node RotatingFileHandler,TimedRotatingFileHandler,BaseRotatingHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers rotating-file-handler}@anchor{2ecb}@anchor{library/logging handlers rotatingfilehandler}@anchor{2ecc}
@subsubsection RotatingFileHandler


A classe @ref{16c2,,RotatingFileHandler}, localizada no módulo @ref{89,,logging.handlers}, oferece suporte à rotação de arquivos de log em disco.

@geindex RotatingFileHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers RotatingFileHandler}@anchor{16c2}
@deffn {Classe} logging.handlers.RotatingFileHandler (filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False, errors=None)

Retorna uma nova instância da classe @ref{16c2,,RotatingFileHandler}. O arquivo especificado é aberto e usado como o stream para logging. Se `mode' não for especificado, @code{'a'} é usado. Se `encoding' não for @code{None}, ele é usado para abrir o arquivo com essa codificação. Se `delay' for verdadeiro, a abertura do arquivo é adiada até a primeira chamada a @ref{2ecd,,emit()}.  Por padrão, o arquivo cresce indefinidamente. Se `errors' for fornecido, ele é usado para determinar como erros de codificação são tratados.

Você pode usar os valores `maxBytes' e `backupCount' para permitir que o arquivo faça `rollover' em um tamanho predeterminado. Quando o tamanho está prestes a ser excedido, o arquivo é fechado e um novo arquivo é aberto silenciosamente para saída. A rotação ocorre sempre que o arquivo de log atual está próximo de `maxBytes' em comprimento; mas, se `maxBytes' ou `backupCount' for zero, a rotação nunca ocorre, portanto, em geral, você deve definir `backupCount' como pelo menos 1 e usar um `maxBytes' diferente de zero. Quando `backupCount' é diferente de zero, o sistema salva arquivos de log antigos acrescentando as extensões ‘.1’, ‘.2’ etc. ao nome do arquivo. Por exemplo, com um `backupCount' de 5 e um nome de arquivo base @code{app.log}, você terá @code{app.log}, @code{app.log.1}, @code{app.log.2}, até @code{app.log.5}. O arquivo no qual se escreve é sempre @code{app.log}. Quando esse arquivo é preenchido, ele é fechado e renomeado para @code{app.log.1} e, se existirem os arquivos @code{app.log.1}, @code{app.log.2} etc., eles são renomeados para @code{app.log.2}, @code{app.log.3} etc., respectivamente.


Alterado na versão 3.6: Além de valores do tipo string, objetos @ref{229,,Path} também são aceitos para o argumento `filename'.



Alterado na versão 3.9: O parâmetro `errors' foi adicionado.


@geindex doRollover() (método logging.handlers.RotatingFileHandler)
@anchor{library/logging handlers logging handlers RotatingFileHandler doRollover}@anchor{2ece}
@deffn {Método} doRollover ()

Realiza uma rotação, conforme descrito acima.
@end deffn

@geindex emit() (método logging.handlers.RotatingFileHandler)
@anchor{library/logging handlers logging handlers RotatingFileHandler emit}@anchor{2ecd}
@deffn {Método} emit (record)

Grava o registro no arquivo, tratando a rotação conforme descrito anteriormente.
@end deffn

@geindex shouldRollover() (método logging.handlers.RotatingFileHandler)
@anchor{library/logging handlers logging handlers RotatingFileHandler shouldRollover}@anchor{2ecf}
@deffn {Método} shouldRollover (record)

Verifica se o registro fornecido faria o arquivo exceder o limite de tamanho configurado.
@end deffn
@end deffn

@node TimedRotatingFileHandler,SocketHandler,RotatingFileHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers timed-rotating-file-handler}@anchor{2ed0}@anchor{library/logging handlers timedrotatingfilehandler}@anchor{2ed1}
@subsubsection TimedRotatingFileHandler


A classe @ref{f95,,TimedRotatingFileHandler}, localizada no módulo @ref{89,,logging.handlers}, oferece suporte à rotação de arquivos de log em disco em intervalos de tempo determinados.

@geindex TimedRotatingFileHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler}@anchor{f95}
@deffn {Classe} logging.handlers.TimedRotatingFileHandler (filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None, errors=None)

Retorna uma nova instância da classe @ref{f95,,TimedRotatingFileHandler}. O arquivo especificado é aberto e usado como fluxo para o logging. Durante a rotação, o sufixo do nome do arquivo também é definido. A rotação ocorre com base no produto de `when' e `interval'.

Você pode usar o `when' para especificar o tipo de `intervalo'. A lista de possíveis valores está abaixo.  Observe que eles não diferenciam maiúsculas de minúsculas.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Tipo de intervalo

@tab

Se/como `atTime' é 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

Dias

@tab

Ignorado

@item

@code{'W0'-'W6'}

@tab

Dia da semana (0=Segunda)

@tab

Usado para calcular o tempo inicial de rotação

@item

@code{'midnight'}

@tab

Faz a rotação à meia-noite, se `atTime' não for especificado; caso contrário, no horário `atTime'.

@tab

Usado para calcular o tempo inicial de rotação

@end multitable


Ao usar rotação baseada em dia da semana, especifique ‘W0’ para segunda-feira, ‘W1’ para terça-feira, e assim por diante até ‘W6’ para domingo. Nesse caso, o valor passado para `interval' não é utilizado.

O sistema salvará arquivos de log antigos acrescentando extensões ao nome do arquivo. As extensões são baseadas em data e hora, usando o formato strftime @code{%Y-%m-%d_%H-%M-%S} ou uma porção inicial dele, dependendo do intervalo de rollover.

Quando a próximo rotação é calculada pela primeira vez (no momento em que o manipulador é criado), o tempo da última modificação de um arquivo de log existente — ou, caso contrário, o tempo atual — é usado para determinar quando a próxima rotação ocorrerá.

Se o argumento `utc' for verdadeiro, serão usados horários em Horário Universal Coordenado (UTC); caso contrário, será usado o horário local.

Se `backupCount' for diferente de zero, no máximo `backupCount' arquivos serão mantidos, e, se mais arquivos fossem criados quando ocorrer a rotação, o mais antigo será excluído. A lógica de exclusão usa o interval para determinar quais arquivos devem ser removidos; assim, alterar o intervalo pode deixar arquivos antigos remanescentes.

Se `delay' for verdadeiro, a abertura do arquivo será adiada até a primeira chamada para @ref{2ed2,,emit()}.

Se `atTime' não for @code{None}, ele deve ser uma instância de @code{datetime.time} que especifica a hora do dia em que ocorre a rotação, nos casos em que a rotação está configurada para acontecer “à meia-noite” ou “em um determinado dia da semana”. Observe que, nesses casos, o valor de `atTime' é efetivamente usado para calcular a rotação inicial, e as rotações subsequentes são calculadas por meio do cálculo normal do intervalo.

Se `erros' for especificado, ele será usado para determinar como erros de codificação são tratados.

@cartouche
@quotation Nota 
O cálculo do tempo da rotação inicial é feito quando o manipulador é inicializado. O cálculo dos tempos de rotações subsequentes é feito apenas quando ocorre uma rotação, e a rotação ocorre somente quando há emissão de saída. Se isso não for levado em consideração, pode causar alguma confusão. Por exemplo, se for definido um intervalo de “a cada minuto”, isso não significa que você sempre verá arquivos de log com horários (no nome do arquivo) separados por um minuto; se, durante a execução da aplicação, a saída de log for gerada com maior frequência do que uma vez por minuto, então você pode esperar observar arquivos de log com horários separados por um minuto. Se, por outro lado, as mensagens de log forem emitidas apenas uma vez a cada cinco minutos (por exemplo), então haverá lacunas nos horários dos arquivos correspondentes aos minutos em que não houve saída (e, portanto, nenhuma rotação).
@end quotation
@end cartouche


Alterado na versão 3.4: parâmetro `atTime' foi adicionado.



Alterado na versão 3.6: Além de valores do tipo string, objetos @ref{229,,Path} também são aceitos para o argumento `filename'.



Alterado na versão 3.9: O parâmetro `errors' foi adicionado.


@geindex doRollover() (método logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler doRollover}@anchor{2ed3}
@deffn {Método} doRollover ()

Realiza uma rotação, conforme descrito acima.
@end deffn

@geindex emit() (método logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler emit}@anchor{2ed2}
@deffn {Método} emit (record)

Emite o registro para o arquivo, com a preparação para a rotação, conforme descrito acima.
@end deffn

@geindex getFilesToDelete() (método logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler getFilesToDelete}@anchor{2ec7}
@deffn {Método} getFilesToDelete ()

Retorna uma lista de nomes de arquivos que devem ser excluídos como parte da rotação. Esses são os caminhos absolutos dos arquivos de log de backup mais antigos gravados pelo manipulador.
@end deffn

@geindex shouldRollover() (método logging.handlers.TimedRotatingFileHandler)
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler shouldRollover}@anchor{2ed4}
@deffn {Método} shouldRollover (record)

Verifica se passou tempo suficiente para que a rotação ocorra e, se for o caso, calcula o próximo horário da rotação.
@end deffn
@end deffn

@node SocketHandler,DatagramHandler,TimedRotatingFileHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers socket-handler}@anchor{2ed5}@anchor{library/logging handlers sockethandler}@anchor{2ed6}
@subsubsection SocketHandler


A classe @ref{f96,,SocketHandler}, localizada no módulo @ref{89,,logging.handlers}, envia a saída de logging para um soquete de rede. A classe base utiliza um soquete TCP.

@geindex SocketHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers SocketHandler}@anchor{f96}
@deffn {Classe} logging.handlers.SocketHandler (host, port)

Retorna uma nova instância da classe @ref{f96,,SocketHandler}, destinada a se comunicar com uma máquina remota cujo endereço é fornecido por `host' e `port'.


Alterado na versão 3.4: Se @code{port} for especificado como @code{None}, um Soquete de domínio Unix será criado usando o valor em @code{host} - caso contrário, um soquete TCP será criado.


@geindex close() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler close}@anchor{2ed7}
@deffn {Método} close ()

Fecha o soquete.
@end deffn

@geindex emit() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler emit}@anchor{2ed8}
@deffn {Método} emit ()

Serializa com pickle o dicionário de atributos do registro e o grava no soquete em formato binário. Se houver um erro com o soquete, o pacote é descartado silenciosamente. Se a conexão tiver sido perdida anteriormente, ela é restabelecida. Para desserializar com pickle o registro no lado receptor em um @ref{101c,,LogRecord}, use a função @ref{2e6f,,makeLogRecord()}.
@end deffn

@geindex handleError() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler handleError}@anchor{2ed9}
@deffn {Método} handleError ()

Trata um erro ocorrido durante @ref{2ed8,,emit()}. A causa mais provável é a perda da conexão. Fecha o soquete para que seja possível tentar novamente no próximo evento.
@end deffn

@geindex makeSocket() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler makeSocket}@anchor{2eda}
@deffn {Método} makeSocket ()

Este é um método de fábrica que permite que subclasses definam o tipo exato de soquete que desejam. A implementação padrão cria um soquete TCP (@ref{1337,,socket.SOCK_STREAM}).
@end deffn

@geindex makePickle() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler makePickle}@anchor{2edb}
@deffn {Método} makePickle (record)

Serializa com pickle o dicionário de atributos do registro em formato binário com um prefixo de comprimento e o retorna pronto para transmissão através do socket. Os detalhes dessa operação são equivalentes a:

@example
data = pickle.dumps(record_attr_dict, 1)
datalen = struct.pack('>L', len(data))
return datalen + data
@end example

Observe que os pickles não são completamente seguros. Se você estiver preocupado com a segurança, pode ser necessário substituir este método para implementar um mecanismo mais seguro. Por exemplo, você pode assinar os pickles usando HMAC e depois verificá-los no lado receptor, ou alternativamente pode desativar a desserialização com pickle de objetos globais no lado receptor.
@end deffn

@geindex send() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler send}@anchor{2edc}
@deffn {Método} send (packet)

Envia para o soquete uma string de bytes serializada com pickle denominada `packet'. O formato da string de bytes enviada é o descrito na documentação de @ref{2edb,,makePickle()}.

Este função permite envios parciais, que podem ocorrer quando a rede está ocupada.
@end deffn

@geindex createSocket() (método logging.handlers.SocketHandler)
@anchor{library/logging handlers logging handlers SocketHandler createSocket}@anchor{65d}
@deffn {Método} createSocket ()

Tenta criar um soquete; em caso de falha, utiliza um algoritmo de back-off exponencial. Na falha inicial, o manipulador descarta a mensagem que estava tentando enviar. Quando mensagens subsequentes são tratadas pela mesma instância, ela não tentará se reconectar até que algum tempo tenha passado. Os parâmetros padrão são tais que o atraso inicial é de um segundo e, se após esse atraso a conexão ainda não puder ser estabelecida, o manipulador dobrará o atraso a cada tentativa, até um máximo de 30 segundos.

Este comportamento é controlado pelo seguintes atributos do manipulador:


@itemize *

@item 
@code{retryStart} (atraso inicial, padrão de 1,0 segundo).

@item 
@code{retryFactor} (multiplicador, com padrão de 2,0).

@item 
@code{retryMax} (atraso máximo, padrão de 30,0 segundos).
@end itemize

Isso significa que, se o ouvinte remoto iniciar após o manipulador já ter sido utilizado, mensagens podem ser perdidas (pois o manipulador nem sequer tentará estabelecer uma conexão até que o atraso tenha decorrido, apenas descartando silenciosamente as mensagens durante esse período de atraso).
@end deffn
@end deffn

@node DatagramHandler,SysLogHandler,SocketHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers datagram-handler}@anchor{2edd}@anchor{library/logging handlers datagramhandler}@anchor{2ede}
@subsubsection DatagramHandler


A classe @ref{f97,,DatagramHandler}, localizada no módulo @ref{89,,logging.handlers}, herda de @ref{f96,,SocketHandler} para oferecer suporte ao envio de mensagens de log por meio de soquetes UDP.

@geindex DatagramHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers DatagramHandler}@anchor{f97}
@deffn {Classe} logging.handlers.DatagramHandler (host, port)

Retorna uma nova instância da classe @ref{f97,,DatagramHandler}, destinada a se comunicar com uma máquina remota cujo endereço é fornecido por `host' e `port'.

@cartouche
@quotation Nota 
Como o UDP não é um protocolo de fluxo contínuo, não há uma conexão persistente entre uma instância deste manipulador e host. Por esse motivo, ao usar um soquete de rede, pode ser necessário realizar uma consulta DNS a cada vez que um evento é registrado, o que pode introduzir alguma latência no sistema. Se isso for um problema para você, pode realizar a consulta manualmente e inicializar este manipulador usando o endereço IP obtido, em vez do nome do host.
@end quotation
@end cartouche


Alterado na versão 3.4: Se @code{port} for especificado como @code{None}, um soquete de domínio Unix é criado usando o valor de @code{host}; caso contrário, é criado um soquete UDP.


@geindex emit() (método logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler emit}@anchor{2edf}
@deffn {Método} emit ()

Serializa com pickle o dicionário de atributos do registro e o grava no soquete em formato binário. Se houver um erro com o soquete, o pacote é descartado silenciosamente. Para desserializar com pickle o registro no lado receptor em um @ref{101c,,LogRecord}, use a função @ref{2e6f,,makeLogRecord()}.
@end deffn

@geindex makeSocket() (método logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler makeSocket}@anchor{2ee0}
@deffn {Método} makeSocket ()

A método de fábrica de @ref{f96,,SocketHandler} aqui é substituído para criar um soquete UDP (@ref{1336,,socket.SOCK_DGRAM}).
@end deffn

@geindex send() (método logging.handlers.DatagramHandler)
@anchor{library/logging handlers logging handlers DatagramHandler send}@anchor{2ee1}
@deffn {Método} send (s)

Envia uma sequência de bytes serializada com pickle para um soquete. O formato da sequência de bytes enviada é conforme descrito na documentação de @ref{2edb,,SocketHandler.makePickle()}.
@end deffn
@end deffn

@node SysLogHandler,NTEventLogHandler,DatagramHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers syslog-handler}@anchor{2ee2}@anchor{library/logging handlers sysloghandler}@anchor{2ee3}
@subsubsection SysLogHandler


A classe @ref{65c,,SysLogHandler}, localizada no módulo @ref{89,,logging.handlers}, oferece suporte ao envio de mensagens de log para um syslog Unix remoto ou local.

@geindex SysLogHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers SysLogHandler}@anchor{65c}
@deffn {Classe} logging.handlers.SysLogHandler (address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)

Returns a new instance of the @ref{65c,,SysLogHandler} class intended to
communicate with a remote Unix machine whose address is given by `address' in
the form of a @code{(host, port)} tuple.  If `address' is not specified,
@code{('localhost', 514)} is used.  The address is used to open a socket.  An
alternative to providing a @code{(host, port)} tuple is providing an address as a
string, for example ‘/dev/log’. In this case, a Unix domain socket is used to
send the message to the syslog. If `facility' is not specified,
@code{LOG_USER} is used. The type of socket opened depends on the
`socktype' argument, which defaults to @ref{1336,,socket.SOCK_DGRAM} and thus
opens a UDP socket. To open a TCP socket (for use with the newer syslog
daemons such as rsyslog), specify a value of @ref{1337,,socket.SOCK_STREAM}.

Observe que, se o seu servidor não estiver escutando na porta UDP 514, o @ref{65c,,SysLogHandler} pode parecer não funcionar. Nesse caso, verifique qual endereço deve ser usado para um soquete de domínio — isso depende do sistema. Por exemplo, no Linux geralmente é ‘/dev/log’, enquanto no OS/X é ‘/var/run/syslog’. Será necessário verificar a sua plataforma e usar o endereço apropriado (talvez seja preciso fazer essa verificação em tempo de execução se a aplicação precisar rodar em várias plataformas). No Windows, praticamente é necessário usar a opção UDP.

@cartouche
@quotation Nota 
No macOS 12.x (Monterey), a Apple alterou o comportamento do daemon syslog — ele não escuta mais em um soquete de domínio. Portanto, não é possível esperar que @ref{65c,,SysLogHandler} funcione nesse sistema.

Consulte gh-91070@footnote{https://github.com/python/cpython/issues/91070} para obter mais informações.
@end quotation
@end cartouche


Alterado na versão 3.2: `socktype' foi adicionado.


@geindex close() (método logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler close}@anchor{2ee4}
@deffn {Método} close ()

Fecha o soquete para o host remoto.
@end deffn

@geindex createSocket() (método logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler createSocket}@anchor{65b}
@deffn {Método} createSocket ()

Tenta criar um soquete e, se ele não for um soquete de datagrama, conectá-lo à outra extremidade. Este método é chamado durante a inicialização do manipulador, mas não é considerado um erro se a outra extremidade não estiver escutando nesse momento — o método será chamado novamente ao emitir um evento, caso não haja um soquete nesse ponto.


Adicionado na versão 3.11.

@end deffn

@geindex emit() (método logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler emit}@anchor{2ee5}
@deffn {Método} emit (record)

O registro é formatado e, em seguida, enviado ao servidor syslog. Se houver informações de exceção, elas `não' são enviadas ao servidor.


Alterado na versão 3.2.1: (Veja: bpo-12168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12168}.) Em versões anteriores, a mensagem enviada aos daemons syslog era sempre terminada com um byte NUL, porque versões antigas desses daemons esperavam uma mensagem terminada em NUL — embora isso não conste na especificação relevante (
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html}). Versões mais recentes desses daemons não esperam o byte NUL, mas o removem caso esteja presente, e daemons ainda mais recentes (que aderem mais de perto à RFC 5424) repassam o byte NUL como parte da mensagem.

Para facilitar o tratamento de mensagens do syslog diante de todos esses comportamentos distintos dos daemons, a adição do byte NUL tornou-se configurável por meio de um atributo em nível de classe, @code{append_nul} O valor padrão é @code{True} (preservando o comportamento existente), mas pode ser definido como @code{False} em uma instância de @code{SysLogHandler} para que essa instância não acrescente o terminador NUL.



Alterado na versão 3.3: (Consulte: bpo-12419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12419}) Em versões anteriores, não havia uma instalação para um prefixo “ident” ou “tag” para identificar a origem da mensagem. Isso agora pode ser especificado usando um atributo de nível de classe, que por padrão é @code{""} para preservar o comportamento existente, mas pode ser substituído em uma instância de @code{SysLogHandler} para que essa instância adicione o ident a cada mensagem manipulada. Observe que o ident fornecido deve ser texto, não bytes, e é adicionado à mensagem exatamente como está.

@end deffn

@geindex encodePriority() (método logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler encodePriority}@anchor{2ee6}
@deffn {Método} encodePriority (facility, priority)

Codifica a instalação e a prioridade em um inteiro. Você pode passar strings ou inteiros — se strings forem passadas, dicionários de mapeamento internos são usados para convertê-las em inteiros.

Os valores simbólicos @code{LOG_} são definidos em @ref{65c,,SysLogHandler} e espelham os valores definidos no arquivo de cabeçalho @code{sys/syslog.h}.

`Prioridades'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nome (string)

@tab

Valor simbólico

@item

@code{alert}

@tab

LOG_ALERT

@item

@code{crit} ou @code{critical}

@tab

LOG_CRIT

@item

@code{debug}

@tab

LOG_DEBUG

@item

@code{emerg} or @code{panic}

@tab

LOG_EMERG

@item

@code{err} ou @code{error}

@tab

LOG_ERR

@item

@code{info}

@tab

LOG_INFO

@item

@code{notice}

@tab

LOG_NOTICE

@item

@code{warn} or @code{warning}

@tab

LOG_WARNING

@end multitable


`Facilities'


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nome (string)

@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 logging.handlers.SysLogHandler)
@anchor{library/logging handlers logging handlers SysLogHandler mapPriority}@anchor{2ee7}
@deffn {Método} mapPriority (levelname)

Maps a logging level name to a syslog priority name.
You may need to override this if you are using custom levels, or
if the default algorithm is not suitable for your needs. The
default algorithm maps @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} and
@code{CRITICAL} to the equivalent syslog names, and all other level
names to ‘warning’.
@end deffn
@end deffn

@node NTEventLogHandler,SMTPHandler,SysLogHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers nt-eventlog-handler}@anchor{2ee8}@anchor{library/logging handlers nteventloghandler}@anchor{2ee9}
@subsubsection NTEventLogHandler


The @ref{2eea,,NTEventLogHandler} class, located in the @ref{89,,logging.handlers}
module, supports sending logging messages to a local Windows NT, Windows 2000 or
Windows XP event log. Before you can use it, you need Mark Hammond’s Win32
extensions for Python installed.

@geindex NTEventLogHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers NTEventLogHandler}@anchor{2eea}
@deffn {Classe} logging.handlers.NTEventLogHandler (appname, dllname=None, logtype='Application')

Returns a new instance of the @ref{2eea,,NTEventLogHandler} class. The `appname' is
used to define the application name as it appears in the event log. An
appropriate registry entry is created using this name. The `dllname' should give
the fully qualified pathname of a .dll or .exe which contains message
definitions to hold in the log (if not specified, @code{'win32service.pyd'} is used
- this is installed with the Win32 extensions and contains some basic
placeholder message definitions. Note that use of these placeholders will make
your event logs big, as the entire message source is held in the log. If you
want slimmer logs, you have to pass in the name of your own .dll or .exe which
contains the message definitions you want to use in the event log). The
`logtype' is one of @code{'Application'}, @code{'System'} or @code{'Security'}, and
defaults to @code{'Application'}.

@geindex close() (método logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler close}@anchor{2eeb}
@deffn {Método} close ()

At this point, you can remove the application name from the registry as a
source of event log entries. However, if you do this, you will not be able
to see the events as you intended in the Event Log Viewer - it needs to be
able to access the registry to get the .dll name. The current version does
not do this.
@end deffn

@geindex emit() (método logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler emit}@anchor{2eec}
@deffn {Método} emit (record)

Determines the message ID, event category and event type, and then logs
the message in the NT event log.
@end deffn

@geindex getEventCategory() (método logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventCategory}@anchor{2eed}
@deffn {Método} getEventCategory (record)

Returns the event category for the record. Override this if you want to
specify your own categories. This version returns 0.
@end deffn

@geindex getEventType() (método logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventType}@anchor{2eee}
@deffn {Método} getEventType (record)

Returns the event type for the record. Override this if you want to
specify your own types. This version does a mapping using the handler’s
typemap attribute, which is set up in @code{__init__()} to a dictionary
which contains mappings for @code{DEBUG}, @code{INFO},
@code{WARNING}, @code{ERROR} and @code{CRITICAL}. If you are using
your own levels, you will either need to override this method or place a
suitable dictionary in the handler’s `typemap' attribute.
@end deffn

@geindex getMessageID() (método logging.handlers.NTEventLogHandler)
@anchor{library/logging handlers logging handlers NTEventLogHandler getMessageID}@anchor{2eef}
@deffn {Método} getMessageID (record)

Returns the message ID for the record. If you are using your own messages,
you could do this by having the `msg' passed to the logger being an ID
rather than a format string. Then, in here, you could use a dictionary
lookup to get the message ID. This version returns 1, which is the base
message ID in @code{win32service.pyd}.
@end deffn
@end deffn

@node SMTPHandler,MemoryHandler,NTEventLogHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers smtp-handler}@anchor{2ef0}@anchor{library/logging handlers smtphandler}@anchor{2ef1}
@subsubsection SMTPHandler


The @ref{164e,,SMTPHandler} class, located in the @ref{89,,logging.handlers} module,
supports sending logging messages to an email address via SMTP.

@geindex SMTPHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers SMTPHandler}@anchor{164e}
@deffn {Classe} logging.handlers.SMTPHandler (mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)

Returns a new instance of the @ref{164e,,SMTPHandler} class. The instance is
initialized with the from and to addresses and subject line of the email. The
`toaddrs' should be a list of strings. To specify a non-standard SMTP port, use
the (host, port) tuple format for the `mailhost' argument. If you use a string,
the standard SMTP port is used. If your SMTP server requires authentication, you
can specify a (username, password) tuple for the `credentials' argument.

To specify the use of a secure protocol (TLS), pass in a tuple to the
`secure' argument. This will only be used when authentication credentials are
supplied. The tuple should be either an empty tuple, or a single-value tuple
with the name of a keyfile, or a 2-value tuple with the names of the keyfile
and certificate file. (This tuple is passed to the
@ref{1177,,smtplib.SMTP.starttls()} method.)

A timeout can be specified for communication with the SMTP server using the
`timeout' argument.


Alterado na versão 3.3: Added the `timeout' parameter.


@geindex emit() (método logging.handlers.SMTPHandler)
@anchor{library/logging handlers logging handlers SMTPHandler emit}@anchor{2ef2}
@deffn {Método} emit (record)

Formats the record and sends it to the specified addressees.
@end deffn

@geindex getSubject() (método logging.handlers.SMTPHandler)
@anchor{library/logging handlers logging handlers SMTPHandler getSubject}@anchor{2ef3}
@deffn {Método} getSubject (record)

If you want to specify a subject line which is record-dependent, override
this method.
@end deffn
@end deffn

@node MemoryHandler,HTTPHandler,SMTPHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers memory-handler}@anchor{2ef4}@anchor{library/logging handlers memoryhandler}@anchor{2ef5}
@subsubsection MemoryHandler


The @ref{2ea3,,MemoryHandler} class, located in the @ref{89,,logging.handlers} module,
supports buffering of logging records in memory, periodically flushing them to a
`target' handler. Flushing occurs whenever the buffer is full, or when an
event of a certain severity or greater is seen.

@ref{2ea3,,MemoryHandler} is a subclass of the more general
@ref{2ef6,,BufferingHandler}, which is an abstract class. This buffers logging
records in memory. Whenever each record is added to the buffer, a check is made
by calling @code{shouldFlush()} to see if the buffer should be flushed.  If it
should, then @code{flush()} is expected to do the flushing.

@geindex BufferingHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers BufferingHandler}@anchor{2ef6}
@deffn {Classe} logging.handlers.BufferingHandler (capacity)

Initializes the handler with a buffer of the specified capacity. Here,
`capacity' means the number of logging records buffered.

@geindex emit() (método logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler emit}@anchor{2ef7}
@deffn {Método} emit (record)

Append the record to the buffer. If @ref{2ef8,,shouldFlush()} returns true,
call @ref{2ef9,,flush()} to process the buffer.
@end deffn

@geindex flush() (método logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler flush}@anchor{2ef9}
@deffn {Método} flush ()

For a @ref{2ef6,,BufferingHandler} instance, flushing means that it sets the
buffer to an empty list. This method can be overwritten to implement more useful
flushing behavior.
@end deffn

@geindex shouldFlush() (método logging.handlers.BufferingHandler)
@anchor{library/logging handlers logging handlers BufferingHandler shouldFlush}@anchor{2ef8}
@deffn {Método} shouldFlush (record)

Return @code{True} if the buffer is up to capacity. This method can be
overridden to implement custom flushing strategies.
@end deffn
@end deffn

@geindex MemoryHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers MemoryHandler}@anchor{2ea3}
@deffn {Classe} logging.handlers.MemoryHandler (capacity, flushLevel=ERROR, target=None, flushOnClose=True)

Returns a new instance of the @ref{2ea3,,MemoryHandler} class. The instance is
initialized with a buffer size of `capacity' (number of records buffered).
If `flushLevel' is not specified, @code{ERROR} is used. If no `target' is
specified, the target will need to be set using @ref{2efa,,setTarget()} before this
handler does anything useful. If `flushOnClose' is specified as @code{False},
then the buffer is `not' flushed when the handler is closed. If not specified
or specified as @code{True}, the previous behaviour of flushing the buffer will
occur when the handler is closed.


Alterado na versão 3.6: The `flushOnClose' parameter was added.


@geindex close() (método logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler close}@anchor{2efb}
@deffn {Método} close ()

Calls @ref{2efc,,flush()}, sets the target to @code{None} and clears the
buffer.
@end deffn

@geindex flush() (método logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler flush}@anchor{2efc}
@deffn {Método} flush ()

For a @ref{2ea3,,MemoryHandler} instance, flushing means just sending the buffered
records to the target, if there is one. The buffer is also cleared when
buffered records are sent to the target. Override if you want different behavior.
@end deffn

@geindex setTarget() (método logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler setTarget}@anchor{2efa}
@deffn {Método} setTarget (target)

Sets the target handler for this handler.
@end deffn

@geindex shouldFlush() (método logging.handlers.MemoryHandler)
@anchor{library/logging handlers logging handlers MemoryHandler shouldFlush}@anchor{2efd}
@deffn {Método} shouldFlush (record)

Checks for buffer full or a record at the `flushLevel' or higher.
@end deffn
@end deffn

@node HTTPHandler,QueueHandler,MemoryHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers http-handler}@anchor{2efe}@anchor{library/logging handlers httphandler}@anchor{2eff}
@subsubsection HTTPHandler


The @ref{e58,,HTTPHandler} class, located in the @ref{89,,logging.handlers} module,
supports sending logging messages to a web server, using either @code{GET} or
@code{POST} semantics.

@geindex HTTPHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers HTTPHandler}@anchor{e58}
@deffn {Classe} logging.handlers.HTTPHandler (host, url, method='GET', secure=False, credentials=None, context=None)

Returns a new instance of the @ref{e58,,HTTPHandler} class. The `host' can be
of the form @code{host:port}, should you need to use a specific port number.  If
no `method' is specified, @code{GET} is used. If `secure' is true, a HTTPS
connection will be used. The `context' parameter may be set to a
@ref{294,,ssl.SSLContext} instance to configure the SSL settings used for the
HTTPS connection. If `credentials' is specified, it should be a 2-tuple
consisting of userid and password, which will be placed in a HTTP
‘Authorization’ header using Basic authentication. If you specify
credentials, you should also specify secure=True so that your userid and
password are not passed in cleartext across the wire.


Alterado na versão 3.5: The `context' parameter was added.


@geindex mapLogRecord() (método logging.handlers.HTTPHandler)
@anchor{library/logging handlers logging handlers HTTPHandler mapLogRecord}@anchor{2f00}
@deffn {Método} mapLogRecord (record)

Provides a dictionary, based on @code{record}, which is to be URL-encoded
and sent to the web server. The default implementation just returns
@code{record.__dict__}. This method can be overridden if e.g. only a
subset of @ref{101c,,LogRecord} is to be sent to the web server, or
if more specific customization of what’s sent to the server is required.
@end deffn

@geindex emit() (método logging.handlers.HTTPHandler)
@anchor{library/logging handlers logging handlers HTTPHandler emit}@anchor{2f01}
@deffn {Método} emit (record)

Sends the record to the web server as a URL-encoded dictionary. The
@ref{2f00,,mapLogRecord()} method is used to convert the record to the
dictionary to be sent.
@end deffn

@cartouche
@quotation Nota 
Since preparing a record for sending it to a web server is not
the same as a generic formatting operation, using
@ref{2e53,,setFormatter()} to specify a
@ref{14df,,Formatter} for a @ref{e58,,HTTPHandler} has no effect.
Instead of calling @ref{2e5c,,format()}, this handler calls
@ref{2f00,,mapLogRecord()} and then @ref{ec4,,urllib.parse.urlencode()} to encode the
dictionary in a form suitable for sending to a web server.
@end quotation
@end cartouche
@end deffn

@node QueueHandler,QueueListener,HTTPHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers queue-handler}@anchor{2f02}@anchor{library/logging handlers queuehandler}@anchor{2f03}
@subsubsection QueueHandler



Adicionado na versão 3.2.


The @ref{18ec,,QueueHandler} class, located in the @ref{89,,logging.handlers} module,
supports sending logging messages to a queue, such as those implemented in the
@ref{b6,,queue} or @ref{94,,multiprocessing} modules.

Along with the @ref{e59,,QueueListener} class, @ref{18ec,,QueueHandler} can be used
to let handlers do their work on a separate thread from the one which does the
logging. This is important in web applications and also other service
applications where threads servicing clients need to respond as quickly as
possible, while any potentially slow operations (such as sending an email via
@ref{164e,,SMTPHandler}) are done on a separate thread.

@geindex QueueHandler (classe em logging.handlers)
@anchor{library/logging handlers logging handlers QueueHandler}@anchor{18ec}
@deffn {Classe} logging.handlers.QueueHandler (queue)

Returns a new instance of the @ref{18ec,,QueueHandler} class. The instance is
initialized with the queue to send messages to. The `queue' can be any
queue-like object; it’s used as-is by the @ref{2f04,,enqueue()} method, which
needs to know how to send messages to it. The queue is not `required' to
have the task tracking API, which means that you can use
@ref{b80,,SimpleQueue} instances for `queue'.

@cartouche
@quotation Nota 
If you are using @ref{94,,multiprocessing}, you should avoid using
@ref{b80,,SimpleQueue} and instead use @ref{1914,,multiprocessing.Queue}.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
The @ref{94,,multiprocessing} module uses an internal logger created and
accessed via @ref{2f05,,get_logger()}.
@ref{1914,,multiprocessing.Queue} will log @code{DEBUG} level messages upon
items being queued. If those log messages are processed by a
@ref{18ec,,QueueHandler} using the same @ref{1914,,multiprocessing.Queue} instance,
it will cause a deadlock or infinite recursion.
@end quotation
@end cartouche

@geindex emit() (método logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler emit}@anchor{2f06}
@deffn {Método} emit (record)

Enqueues the result of preparing the LogRecord. Should an exception
occur (e.g. because a bounded queue has filled up), the
@ref{2e5a,,handleError()} method is called to handle the
error. This can result in the record silently being dropped (if
@ref{1239,,logging.raiseExceptions} is @code{False}) or a message printed to
@code{sys.stderr} (if @ref{1239,,logging.raiseExceptions} is @code{True}).
@end deffn

@geindex prepare() (método logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler prepare}@anchor{2f07}
@deffn {Método} prepare (record)

Prepares a record for queuing. The object returned by this
method is enqueued.

The base implementation formats the record to merge the message,
arguments, exception and stack information, if present.  It also removes
unpickleable items from the record in-place. Specifically, it overwrites
the record’s @code{msg} and @code{message} attributes with the merged
message (obtained by calling the handler’s @ref{61f,,format()} method), and
sets the @code{args}, @code{exc_info} and @code{exc_text} attributes
to @code{None}.

You might want to override this method if you want to convert
the record to a dict or JSON string, or send a modified copy
of the record while leaving the original intact.

@cartouche
@quotation Nota 
The base implementation formats the message with arguments, sets
the @code{message} and @code{msg} attributes to the formatted message and
sets the @code{args} and @code{exc_text} attributes to @code{None} to allow
pickling and to prevent further attempts at formatting. This means
that a handler on the @ref{e59,,QueueListener} side won’t have the
information to do custom formatting, e.g. of exceptions. You may wish
to subclass @code{QueueHandler} and override this method to e.g. avoid
setting @code{exc_text} to @code{None}. Note that the @code{message} / @code{msg}
/ @code{args} changes are related to ensuring the record is pickleable,
and you might or might not be able to avoid doing that depending on
whether your @code{args} are pickleable. (Note that you may have to
consider not only your own code but also code in any libraries that
you use.)
@end quotation
@end cartouche
@end deffn

@geindex enqueue() (método logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler enqueue}@anchor{2f04}
@deffn {Método} enqueue (record)

Enqueues the record on the queue using @code{put_nowait()}; you may
want to override this if you want to use blocking behaviour, or a
timeout, or a customized queue implementation.
@end deffn

@geindex listener (atributo logging.handlers.QueueHandler)
@anchor{library/logging handlers logging handlers QueueHandler listener}@anchor{2ea7}
@deffn {Atributo} listener

When created via configuration using @ref{11ef,,dictConfig()}, this
attribute will contain a @ref{e59,,QueueListener} instance for use with this
handler. Otherwise, it will be @code{None}.


Adicionado na versão 3.12.

@end deffn
@end deffn

@node QueueListener,,QueueHandler,logging handlers — Manipuladores de logging
@anchor{library/logging handlers queue-listener}@anchor{2f08}@anchor{library/logging handlers queuelistener}@anchor{2f09}
@subsubsection QueueListener



Adicionado na versão 3.2.


The @ref{e59,,QueueListener} class, located in the @ref{89,,logging.handlers}
module, supports receiving logging messages from a queue, such as those
implemented in the @ref{b6,,queue} or @ref{94,,multiprocessing} modules. The
messages are received from a queue in an internal thread and passed, on
the same thread, to one or more handlers for processing. While
@ref{e59,,QueueListener} is not itself a handler, it is documented here
because it works hand-in-hand with @ref{18ec,,QueueHandler}.

Along with the @ref{18ec,,QueueHandler} class, @ref{e59,,QueueListener} can be used
to let handlers do their work on a separate thread from the one which does the
logging. This is important in web applications and also other service
applications where threads servicing clients need to respond as quickly as
possible, while any potentially slow operations (such as sending an email via
@ref{164e,,SMTPHandler}) are done on a separate thread.

@geindex QueueListener (classe em logging.handlers)
@anchor{library/logging handlers logging handlers QueueListener}@anchor{e59}
@deffn {Classe} logging.handlers.QueueListener (queue, *handlers, respect_handler_level=False)

Returns a new instance of the @ref{e59,,QueueListener} class. The instance is
initialized with the queue to send messages to and a list of handlers which
will handle entries placed on the queue. The queue can be any queue-like
object; it’s passed as-is to the @ref{2f0a,,dequeue()} method, which needs
to know how to get messages from it. The queue is not `required' to have the
task tracking API (though it’s used if available), which means that you can
use @ref{b80,,SimpleQueue} instances for `queue'.

@cartouche
@quotation Nota 
If you are using @ref{94,,multiprocessing}, you should avoid using
@ref{b80,,SimpleQueue} and instead use @ref{1914,,multiprocessing.Queue}.
@end quotation
@end cartouche

If @code{respect_handler_level} is @code{True}, a handler’s level is respected
(compared with the level for the message) when deciding whether to pass
messages to that handler; otherwise, the behaviour is as in previous Python
versions - to always pass each message to each handler.


Alterado na versão 3.5: The @code{respect_handler_level} argument was added.


@geindex dequeue() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener dequeue}@anchor{2f0a}
@deffn {Método} dequeue (block)

Dequeues a record and return it, optionally blocking.

The base implementation uses @code{get()}. You may want to override this
method if you want to use timeouts or work with custom queue
implementations.
@end deffn

@geindex prepare() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener prepare}@anchor{2f0b}
@deffn {Método} prepare (record)

Prepare a record for handling.

This implementation just returns the passed-in record. You may want to
override this method if you need to do any custom marshalling or
manipulation of the record before passing it to the handlers.
@end deffn

@geindex handle() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener handle}@anchor{2f0c}
@deffn {Método} handle (record)

Handle a record.

This just loops through the handlers offering them the record
to handle. The actual object passed to the handlers is that which
is returned from @ref{2f0b,,prepare()}.
@end deffn

@geindex start() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener start}@anchor{162c}
@deffn {Método} start ()

Starts the listener.

This starts up a background thread to monitor the queue for
LogRecords to process.


Alterado na versão 3.13.4: Raises @ref{195,,RuntimeError} if called and the listener is already
running.

@end deffn

@geindex stop() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener stop}@anchor{2f0d}
@deffn {Método} stop ()

Stops the listener.

This asks the thread to terminate, and then waits for it to do so.
Note that if you don’t call this before your application exits, there
may be some records still left on the queue, which won’t be processed.
@end deffn

@geindex enqueue_sentinel() (método logging.handlers.QueueListener)
@anchor{library/logging handlers logging handlers QueueListener enqueue_sentinel}@anchor{2f0e}
@deffn {Método} enqueue_sentinel ()

Writes a sentinel to the queue to tell the listener to quit. This
implementation uses @code{put_nowait()}.  You may want to override this
method if you want to use timeouts or work with custom queue
implementations.


Adicionado na versão 3.3.

@end deffn
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{87,,logging}

Referência da API para o módulo de logging.

@item Módulo @ref{88,,logging.config}

API de configuração para o módulo logging.
@end table


@node platform — Acesso aos dados de identificação da plataforma subjacente,errno — Símbolos padrão do sistema errno,logging handlers — Manipuladores de logging,Serviços Genéricos do Sistema Operacional
@anchor{library/platform doc}@anchor{2f0f}@anchor{library/platform module-platform}@anchor{aa}@anchor{library/platform platform-access-to-underlying-platform-s-identifying-data}@anchor{2f10}@anchor{library/platform translation-repo}@anchor{2f11}
@subsection @code{platform} —  Acesso aos dados de identificação da plataforma subjacente


@geindex module; platform

`Código-fonte:' Lib/platform.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/platform.py}


__________________________________________________________________


@cartouche
@quotation Nota 
Plataformas específicas listadas em ordem alfabética, com Linux incluído na seção Unix.
@end quotation
@end cartouche

@menu
* Multiplataforma:: 
* Plataforma Java:: 
* Plataforma Windows:: 
* Plataforma macOS:: 
* Plataforma iOS:: 
* Plataformas Unix:: 
* Plataformas Linux:: 
* Plataforma Android:: 
* Uso na linha de comando: Uso na linha de comando<3>. 

@end menu

@node Multiplataforma,Plataforma Java,,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform cross-platform}@anchor{2f12}
@subsubsection Multiplataforma


@geindex architecture() (no módulo platform)
@anchor{library/platform platform architecture}@anchor{1781}
@deffn {Função} platform.architecture (executable=sys.executable, bits='@w{'}, linkage='@w{'})

Consulta o executável fornecido (o padrão é o binário do interpretador Python) para obter várias informações de arquitetura.

Retorna uma tupla @code{(bits, linkage)} que contém informações sobre a arquitetura de bits e o formato de linkage usado para o executável. Ambos os valores são retornados como strings.

Valores que não podem ser determinados são retornados como fornecidos pelas predefinições de parâmetros. Se bits for fornecido como @code{'@w{'}}, o @code{sizeof(pointer)} (ou @code{sizeof(long)} na versão Python < 1.5.2) é usado como indicador para o tamanho de ponteiro suportado.

A função depende do comando @code{file} do sistema para fazer o trabalho real. Isso está disponível na maioria, se não em todas as plataformas Unix e algumas plataformas não Unix e somente se o executável apontar para o interpretador Python. Padrões razoáveis são usados quando as necessidades acima não são atendidas.

@cartouche
@quotation Nota 
No macOS (e talvez em outras plataformas), arquivos executáveis podem ser arquivos universais contendo diversas arquiteturas.

Para obter a “característica de 64 bits” do interpretador atual, é mais confiável consultar o atributo @ref{1205,,sys.maxsize}:

@example
is_64bits = sys.maxsize > 2**32
@end example
@end quotation
@end cartouche
@end deffn

@geindex machine() (no módulo platform)
@anchor{library/platform platform machine}@anchor{2f13}
@deffn {Função} platform.machine ()

Retorna o tipo de máquina, por exemplo, @code{'AMD64'}. Uma string vazia é retornada se o valor não puder ser determinado.

A saída depende da plataforma e pode diferir nas convenções de nomenclatura e uso de maiúsculas e minúsculas.
@end deffn

@geindex node() (no módulo platform)
@anchor{library/platform platform node}@anchor{2f14}
@deffn {Função} platform.node ()

Retorna o nome de rede do computador (pode não ser totalmente qualificado!). Uma string vazia é retornada se o valor não puder ser determinado.
@end deffn

@geindex platform() (no módulo platform)
@anchor{library/platform platform platform}@anchor{184e}
@deffn {Função} platform.platform (aliased=False, terse=False)

Retorna uma única string identificando a plataforma subjacente com o máximo de informações úteis possível.

A saída é pretendida para ser `legível por humanos' em vez de analisável por máquinas. Pode parecer diferente em diferentes plataformas e isso é intencional.

Se `aliased' for true, a função usará apelidos para várias plataformas que relatam nomes de sistemas que diferem de seus nomes comuns, por exemplo, SunOS será relatado como Solaris. A função @ref{2f15,,system_alias()} é usada para implementar isso.

Definir `terse' como true faz com que a função retorne apenas o mínimo absoluto de informações necessárias para identificar a plataforma.


Alterado na versão 3.8: No macOS, a função agora usa @ref{1bac,,mac_ver()}, se retornar uma string de versão não vazia, para obter a versão do macOS em vez da versão do darwin.

@end deffn

@geindex processor() (no módulo platform)
@anchor{library/platform platform processor}@anchor{2f16}
@deffn {Função} platform.processor ()

Retorna o nome (real) do processador, por exemplo @code{'amdk6'}.

Uma string vazia é retornada se o valor não puder ser determinado. Note que muitas plataformas não fornecem essas informações ou simplesmente retornam o mesmo valor que para @ref{2f13,,machine()}. O NetBSD faz isso.
@end deffn

@geindex python_build() (no módulo platform)
@anchor{library/platform platform python_build}@anchor{2f17}
@deffn {Função} platform.python_build ()

Retorna uma tupla @code{(buildno, builddate)} informando o número e a data da construção do Python como strings.
@end deffn

@geindex python_compiler() (no módulo platform)
@anchor{library/platform platform python_compiler}@anchor{2f18}
@deffn {Função} platform.python_compiler ()

Retorna uma string identificando o compilador usado para compilar Python.
@end deffn

@geindex python_branch() (no módulo platform)
@anchor{library/platform platform python_branch}@anchor{2f19}
@deffn {Função} platform.python_branch ()

Retorna uma string identificando a branch SCM da implementação do Python.
@end deffn

@geindex python_implementation() (no módulo platform)
@anchor{library/platform platform python_implementation}@anchor{2f1a}
@deffn {Função} platform.python_implementation ()

Retorna uma string identificando a implementação do Python. Os valores de retorno possíveis são: ‘CPython’, ‘IronPython’, ‘Jython’, ‘PyPy’.
@end deffn

@geindex python_revision() (no módulo platform)
@anchor{library/platform platform python_revision}@anchor{2f1b}
@deffn {Função} platform.python_revision ()

Retorna uma string que identifica a revisão do SCM da implementação Python.
@end deffn

@geindex python_version() (no módulo platform)
@anchor{library/platform platform python_version}@anchor{2f1c}
@deffn {Função} platform.python_version ()

Retorna a versão do Python como string @code{'major.minor.patchlevel'}.

Observe que, diferentemente do @code{sys.version} do Python, o valor retornado sempre incluirá o patchlevel (o padrão é 0).
@end deffn

@geindex python_version_tuple() (no módulo platform)
@anchor{library/platform platform python_version_tuple}@anchor{2f1d}
@deffn {Função} platform.python_version_tuple ()

Retorna a versão do Python como tupla @code{(major, minor, patchlevel)} de strings.

Observe que, diferentemente do @code{sys.version} do Python, o valor retornado sempre incluirá o patchlevel (o padrão é @code{'0'}).
@end deffn

@geindex release() (no módulo platform)
@anchor{library/platform platform release}@anchor{2f1e}
@deffn {Função} platform.release ()

Retorna a versão do sistema, por exemplo, @code{'2.2.0'} ou @code{'NT'}. Uma string vazia é retornada se o valor não puder ser determinado.
@end deffn

@geindex system() (no módulo platform)
@anchor{library/platform platform system}@anchor{1fe9}
@deffn {Função} platform.system ()

Retorna o nome do sistema/SO, como @code{'Linux'}, @code{'Darwin'}, @code{'Java'}, @code{'Windows'}. Uma string vazia é retornada se o valor não puder ser determinado.

No iOS e Android, isso retorna o nome do SO voltado para o usuário (por exemplo, @code{'iOS}, @code{'iPadOS'} ou @code{'Android'}). Para obter o nome do kernel (@code{'Darwin'} ou @code{'Linux'}), use @ref{1155,,os.uname()}.
@end deffn

@geindex system_alias() (no módulo platform)
@anchor{library/platform platform system_alias}@anchor{2f15}
@deffn {Função} platform.system_alias (system, release, version)

Retorna @code{(sistema, release, versão)} com apelido para nomes comuns de marketing usados para alguns sistemas. Ele também faz alguma reordenação das informações em alguns casos em que, de outra forma, causaria confusão.
@end deffn

@geindex version() (no módulo platform)
@anchor{library/platform platform version}@anchor{2f1f}
@deffn {Função} platform.version ()

Retorna a versão de lançamento do sistema, por exemplo, @code{'#3 on degas'}. Uma string vazia é retornada se o valor não puder ser determinado.

No iOS e Android, esta é a versão do SO voltada para o usuário. Para obter a versão do kernel Darwin ou Linux, use @ref{1155,,os.uname()}.
@end deffn

@geindex uname() (no módulo platform)
@anchor{library/platform platform uname}@anchor{1baa}
@deffn {Função} platform.uname ()

Interface para uname razoavelmente portátil. Retorna um @ref{1ca,,namedtuple()} contendo seis atributos: @ref{1fe9,,system}, @ref{2f14,,node}, @ref{2f1e,,release}, @ref{2f1f,,version}, @ref{2f13,,machine} e @ref{2f16,,processor}.

@ref{2f16,,processor} é resolvido tardiamente, sob demanda.

Nota: os dois primeiros nomes de atributos diferem dos nomes apresentados por @ref{1155,,os.uname()}, onde são chamados @code{sysname} e @code{nodename}.

As entradas que não podem ser determinadas são definidas como @code{'@w{'}}.


Alterado na versão 3.3: O resultado mudou de uma tupla para @ref{1ca,,namedtuple()}.



Alterado na versão 3.9: @ref{2f16,,processor} é resolvido tarde em vez de imediatamente.

@end deffn

@node Plataforma Java,Plataforma Windows,Multiplataforma,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform java-platform}@anchor{2f20}
@subsubsection Plataforma Java


@geindex java_ver() (no módulo platform)
@anchor{library/platform platform java_ver}@anchor{2a7}
@deffn {Função} platform.java_ver (release='@w{'}, vendor='@w{'}, vminfo=('@w{'}, '@w{'}, '@w{'}), osinfo=('@w{'}, '@w{'}, '@w{'}))

Interface de versão para Jython.

Retorna uma tupla @code{(release, vendor, vminfo, osinfo)} com `vminfo' sendo uma tupla @code{(vm_name, vm_release, vm_vendor)} e `osinfo' sendo uma tupla @code{(os_name, os_version, os_arch)}. Valores que não podem ser determinados são definidos para os padrões fornecidos como parâmetros (que são todos padrão para @code{'@w{'}}).


Descontinuado desde a versão 3.13, será removido na versão 3.15: Ele não foi testado em grande parte, tinha uma API confusa e só era útil para suporte ao Jython.

@end deffn

@node Plataforma Windows,Plataforma macOS,Plataforma Java,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform windows-platform}@anchor{2f21}
@subsubsection Plataforma Windows


@geindex win32_ver() (no módulo platform)
@anchor{library/platform platform win32_ver}@anchor{1ad7}
@deffn {Função} platform.win32_ver (release='@w{'}, version='@w{'}, csd='@w{'}, ptype='@w{'})

Obtém informações adicionais sobre a versão do Registro do Windows e retorna uma tupla @code{(release, version, csd, ptype)} referente à versão do SO, número da versão, nível do CSD (service pack) e tipo de sistema operacional (processador múltiplo/único). Os valores que não podem ser determinados são definidos para os padrões fornecidos como parâmetros (que são todos padrão para uma string vazia).

Como dica: `ptype' é @code{'Uniprocessor Free'} em máquinas NT de processador único e @code{'Multiprocessor Free'} em máquinas de multiprocessador. O @code{'Free'} se refere à versão do sistema operacional que está livre de código de depuração. Ele também pode declarar @code{'Checked'}, o que significa que a versão do sistema operacional usa código de depuração, ou seja, código que verifica argumentos, intervalos, etc.
@end deffn

@geindex win32_edition() (no módulo platform)
@anchor{library/platform platform win32_edition}@anchor{2f22}
@deffn {Função} platform.win32_edition ()

Retorna uma string representando a edição atual do Windows, ou @code{None} se o valor não puder ser determinado. Os valores possíveis incluem, mas não estão limitados a @code{'Enterprise'}, @code{'IoTUAP'}, @code{'ServerStandard'} e @code{'nanoserver'}.


Adicionado na versão 3.8.

@end deffn

@geindex win32_is_iot() (no módulo platform)
@anchor{library/platform platform win32_is_iot}@anchor{2f23}
@deffn {Função} platform.win32_is_iot ()

Retorna @code{True} se a edição do Windows retornada por @ref{2f22,,win32_edition()} for reconhecida como uma edição IoT.


Adicionado na versão 3.8.

@end deffn

@node Plataforma macOS,Plataforma iOS,Plataforma Windows,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform macos-platform}@anchor{2f24}
@subsubsection Plataforma macOS


@geindex mac_ver() (no módulo platform)
@anchor{library/platform platform mac_ver}@anchor{1bac}
@deffn {Função} platform.mac_ver (release='@w{'}, versioninfo=('@w{'}, '@w{'}, '@w{'}), machine='@w{'})

Obtém informações sobre a versão do macOS e retorna-as como tupla @code{(release, versioninfo, machine)}, sendo `versioninfo' uma tupla @code{(version, dev_stage, non_release_version)}.

Entradas que não podem ser determinadas são definidas como @code{'@w{'}}. Todas as entradas de tupla são strings.
@end deffn

@node Plataforma iOS,Plataformas Unix,Plataforma macOS,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform ios-platform}@anchor{2f25}
@subsubsection Plataforma iOS


@geindex ios_ver() (no módulo platform)
@anchor{library/platform platform ios_ver}@anchor{1fe8}
@deffn {Função} platform.ios_ver (system='@w{'}, release='@w{'}, model='@w{'}, is_simulator=False)

Obtém informações sobre a versão do iOS e retorna-as como @ref{1ca,,namedtuple()} com os seguintes atributos:


@itemize *

@item 
@code{system} é o nome do sistema operacional; @code{'iOS'} ou @code{'iPadOS'}.

@item 
@code{release} é o número da versão do iOS como uma string (por exemplo, @code{'17.2'}).

@item 
@code{model} é o identificador do modelo do dispositivo; será uma string como @code{'iPhone13,2'} para um dispositivo físico ou @code{'iPhone'} em um simulador.

@item 
@code{is_simulator} é um booleano que descreve se o aplicativo está sendo executado em um simulador ou em um dispositivo físico.
@end itemize

As entradas que não podem ser determinadas são definidas para os padrões fornecidos como parâmetros.
@end deffn

@node Plataformas Unix,Plataformas Linux,Plataforma iOS,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform unix-platforms}@anchor{2f26}
@subsubsection Plataformas Unix


@geindex libc_ver() (no módulo platform)
@anchor{library/platform platform libc_ver}@anchor{1ba9}
@deffn {Função} platform.libc_ver (executable=sys.executable, lib='@w{'}, version='@w{'}, chunksize=16384)

Tenta determinar a versão libc contra a qual o executável do arquivo (padrão para o interpretador Python) está vinculado. Retorna uma tupla de strings @code{(lib, version)} que tem como padrão os parâmetros fornecidos caso a pesquisa falhe.

Observe que esta função tem conhecimento profundo de como diferentes versões da libc adicionam símbolos ao executável e provavelmente só pode ser usada para executáveis compilados usando @code{gcc}.

O arquivo é lido e escaneado em blocos de `chunksize' bytes.
@end deffn

@node Plataformas Linux,Plataforma Android,Plataformas Unix,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform linux-platforms}@anchor{2f27}
@subsubsection Plataformas Linux


@geindex freedesktop_os_release() (no módulo platform)
@anchor{library/platform platform freedesktop_os_release}@anchor{829}
@deffn {Função} platform.freedesktop_os_release ()

Obtém a identificação do sistema operacional do arquivo @code{os-release} e retorna-a como um dict. O arquivo @code{os-release} é um padrão freedesktop.org@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html} e está disponível na maioria das distribuições Linux. Uma exceção notável é o Android e as distribuições baseadas em Android.

Levanta @ref{417,,OSError} ou subclasse quando nem @code{/etc/os-release} nem @code{/usr/lib/os-release} podem ser lidos.

Em caso de sucesso, a função retorna um dicionário onde chaves e valores são strings. Valores têm seus caracteres especiais como @code{"} e @code{$} sem aspas. Os campos @code{NAME}, @code{ID} e @code{PRETTY_NAME} são sempre definidos de acordo com o padrão. Todos os outros campos são opcionais. Os fornecedores podem incluir campos adicionais.

Note que campos como @code{NAME}, @code{VERSION} e @code{VARIANT} são strings adequadas para apresentação aos usuários. Os programas devem usar campos como @code{ID}, @code{ID_LIKE}, @code{VERSION_ID} ou @code{VARIANT_ID} para identificar distribuições Linux.

Exemplo:

@example
def get_like_distro():
    info = platform.freedesktop_os_release()
    ids = [info["ID"]]
    if "ID_LIKE" in info:
        # ids são separados por espaço e ordenado por precedência
        ids.extend(info["ID_LIKE"].split())
    return ids
@end example


Adicionado na versão 3.10.

@end deffn

@node Plataforma Android,Uso na linha de comando<3>,Plataformas Linux,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform android-platform}@anchor{2f28}
@subsubsection Plataforma Android


@geindex android_ver() (no módulo platform)
@anchor{library/platform platform android_ver}@anchor{173d}
@deffn {Função} platform.android_ver (release='@w{'}, api_level=0, manufacturer='@w{'}, model='@w{'}, device='@w{'}, is_emulator=False)

Obtém informações do dispositivo Android. Retorna um @ref{1ca,,namedtuple()} com os seguintes atributos. Valores que não podem ser determinados são definidos para os padrões fornecidos como parâmetros.


@itemize *

@item 
@code{release} - Versão do Android, como uma string (por exemplo, @code{"14"}).

@item 
@code{api_level} - Nível de API do dispositivo em execução, como um inteiro (por exemplo, @code{34} para Android 14). Para obter o nível de API contra o qual o Python foi criado, consulte @ref{ba2,,sys.getandroidapilevel()}.

@item 
@code{manufacturer} - Nome do fabricante@footnote{https://developer.android.com/reference/android/os/Build#MANUFACTURER}.

@item 
@code{model} - Nome do modelo@footnote{https://developer.android.com/reference/android/os/Build#MODEL} – normalmente o nome de marketing ou o número do modelo.

@item 
@code{device} - Nome do dispositivo@footnote{https://developer.android.com/reference/android/os/Build#DEVICE} – normalmente o número do modelo ou um codinome.

@item 
@code{is_emulator} - @code{True} se o dispositivo for um emulador; @code{False} se for um dispositivo físico.
@end itemize

O Google mantém uma lista de nomes de modelos e dispositivos conhecidos@footnote{https://storage.googleapis.com/play_public/supported_devices.html}.


Adicionado na versão 3.13.

@end deffn

@node Uso na linha de comando<3>,,Plataforma Android,platform — Acesso aos dados de identificação da plataforma subjacente
@anchor{library/platform command-line-usage}@anchor{2f29}@anchor{library/platform platform-cli}@anchor{2f2a}
@subsubsection Uso na linha de comando


@ref{aa,,platform} também pode ser invocado diretamente usando a opção @ref{5e1,,-m} do interpretador:

@example
python -m platform [--terse] [--nonaliased] [@{nonaliased,terse@} ...]
@end example

As seguintes opções são aceitas:

@geindex platform opção de linha de comando; --terse
@anchor{library/platform cmdoption-platform-terse}@anchor{2f2b}
@deffn {Option} @w{-}@w{-}terse

Exibe informações concisas sobre a plataforma. Isso equivale a chamar @ref{184e,,platform.platform()} com o argumento `terse' definido como @code{True}.
@end deffn

@geindex platform opção de linha de comando; --nonaliased
@anchor{library/platform cmdoption-platform-nonaliased}@anchor{2f2c}
@deffn {Option} @w{-}@w{-}nonaliased

Exibe informações da plataforma sem alias de nome do sistema/SO. Isso equivale a chamar @ref{184e,,platform.platform()} com o argumento `aliased' definido como @code{True}.
@end deffn

Você também pode passar um ou mais argumentos posicionais (@code{terse}, @code{nonaliased}) para controlar explicitamente o formato de saída. Eles se comportam de forma semelhante às suas opções correspondentes.

@node errno — Símbolos padrão do sistema errno,ctypes — Uma biblioteca de funções externas para Python,platform — Acesso aos dados de identificação da plataforma subjacente,Serviços Genéricos do Sistema Operacional
@anchor{library/errno doc}@anchor{2f2d}@anchor{library/errno errno-standard-errno-system-symbols}@anchor{2f2e}@anchor{library/errno module-errno}@anchor{57}@anchor{library/errno translation-repo}@anchor{2f2f}
@subsection @code{errno} — Símbolos padrão do sistema errno


@geindex module; errno


__________________________________________________________________


Este módulo disponibiliza símbolos de sistema padrão @code{errno}. O valor de cada símbolo é o valor inteiro correspondente. Os nomes e descrições são emprestados de @code{linux/include/errno.h}, que deve ser tudo inclusivo.

@geindex errorcode (no módulo errno)
@anchor{library/errno errno errorcode}@anchor{2f30}
@deffn {Dado} errno.errorcode

Dicionário que fornece um mapeamento do valor errno para o nome da string no sistema subjacente. Por exemplo, @code{errno.errorcode[errno.EPERM]} mapeia para @code{'EPERM'}.
@end deffn

Para traduzir um código de erro numérico em uma mensagem de erro, use @ref{2d04,,os.strerror()}.

Da lista a seguir, símbolos que não são usados na plataforma atual não são definidos pelo módulo. A lista específica de símbolos definidos está disponível como @code{errno.errorcode.keys()}. Os símbolos disponíveis podem incluir:

@geindex EPERM (no módulo errno)
@anchor{library/errno errno EPERM}@anchor{18e1}
@deffn {Dado} errno.EPERM

Operação não permitida. Este erro é mapeado para a exceção @ref{d65,,PermissionError}.
@end deffn

@geindex ENOENT (no módulo errno)
@anchor{library/errno errno ENOENT}@anchor{2441}
@deffn {Dado} errno.ENOENT

Arquivo ou diretório inexistente. Este erro é mapeado para a exceção @ref{42b,,FileNotFoundError}.
@end deffn

@geindex ESRCH (no módulo errno)
@anchor{library/errno errno ESRCH}@anchor{2445}
@deffn {Dado} errno.ESRCH

Processo inexistente. Este erro é mapeado para a exceção @ref{1094,,ProcessLookupError}.
@end deffn

@geindex EINTR (no módulo errno)
@anchor{library/errno errno EINTR}@anchor{daf}
@deffn {Dado} errno.EINTR

Chamada de sistema interrompida. Este erro é mapeado para a exceção @ref{db0,,InterruptedError}.
@end deffn

@geindex EIO (no módulo errno)
@anchor{library/errno errno EIO}@anchor{2f31}
@deffn {Dado} errno.EIO

Erro de E/S
@end deffn

@geindex ENXIO (no módulo errno)
@anchor{library/errno errno ENXIO}@anchor{2f32}
@deffn {Dado} errno.ENXIO

Endereço ou dispositivo inexistente
@end deffn

@geindex E2BIG (no módulo errno)
@anchor{library/errno errno E2BIG}@anchor{2f33}
@deffn {Dado} errno.E2BIG

Lista de argumentos muito longa
@end deffn

@geindex ENOEXEC (no módulo errno)
@anchor{library/errno errno ENOEXEC}@anchor{2f34}
@deffn {Dado} errno.ENOEXEC

Erro no formato exec
@end deffn

@geindex EBADF (no módulo errno)
@anchor{library/errno errno EBADF}@anchor{962}
@deffn {Dado} errno.EBADF

Descritor de arquivo inválido
@end deffn

@geindex ECHILD (no módulo errno)
@anchor{library/errno errno ECHILD}@anchor{243a}
@deffn {Dado} errno.ECHILD

Não há processos filhos. Este erro é mapeado para a exceção @ref{1091,,ChildProcessError}.
@end deffn

@geindex EAGAIN (no módulo errno)
@anchor{library/errno errno EAGAIN}@anchor{2435}
@deffn {Dado} errno.EAGAIN

Tente novamente. Este erro é mapeado para a exceção @ref{1090,,BlockingIOError}.
@end deffn

@geindex ENOMEM (no módulo errno)
@anchor{library/errno errno ENOMEM}@anchor{2f35}
@deffn {Dado} errno.ENOMEM

Memória insuficiente
@end deffn

@geindex EACCES (no módulo errno)
@anchor{library/errno errno EACCES}@anchor{2444}
@deffn {Dado} errno.EACCES

Permissão negada. Este erro é mapeado para a exceção @ref{d65,,PermissionError}.
@end deffn

@geindex EFAULT (no módulo errno)
@anchor{library/errno errno EFAULT}@anchor{2f36}
@deffn {Dado} errno.EFAULT

Endereço inválido
@end deffn

@geindex ENOTBLK (no módulo errno)
@anchor{library/errno errno ENOTBLK}@anchor{2f37}
@deffn {Dado} errno.ENOTBLK

Dispositivo de bloco requerido
@end deffn

@geindex EBUSY (no módulo errno)
@anchor{library/errno errno EBUSY}@anchor{2f38}
@deffn {Dado} errno.EBUSY

Dispositivo ou recurso ocupado
@end deffn

@geindex EEXIST (no módulo errno)
@anchor{library/errno errno EEXIST}@anchor{2440}
@deffn {Dado} errno.EEXIST

Arquivo existe. Este erro é mapeado para a exceção @ref{1056,,FileExistsError}.
@end deffn

@geindex EXDEV (no módulo errno)
@anchor{library/errno errno EXDEV}@anchor{2d1b}
@deffn {Dado} errno.EXDEV

Link entre dispositivos inválido
@end deffn

@geindex ENODEV (no módulo errno)
@anchor{library/errno errno ENODEV}@anchor{2f39}
@deffn {Dado} errno.ENODEV

Dispositivo inexistente
@end deffn

@geindex ENOTDIR (no módulo errno)
@anchor{library/errno errno ENOTDIR}@anchor{2443}
@deffn {Dado} errno.ENOTDIR

Não é um diretório. Este erro é mapeado para a exceção @ref{1093,,NotADirectoryError}.
@end deffn

@geindex EISDIR (no módulo errno)
@anchor{library/errno errno EISDIR}@anchor{2442}
@deffn {Dado} errno.EISDIR

É um diretório. Este erro é mapeado para a exceção @ref{1092,,IsADirectoryError}.
@end deffn

@geindex EINVAL (no módulo errno)
@anchor{library/errno errno EINVAL}@anchor{1b66}
@deffn {Dado} errno.EINVAL

Argumento inválido
@end deffn

@geindex ENFILE (no módulo errno)
@anchor{library/errno errno ENFILE}@anchor{2f3a}
@deffn {Dado} errno.ENFILE

Estouro de tabela de arquivos
@end deffn

@geindex EMFILE (no módulo errno)
@anchor{library/errno errno EMFILE}@anchor{2f3b}
@deffn {Dado} errno.EMFILE

Muitos arquivos abertos
@end deffn

@geindex ENOTTY (no módulo errno)
@anchor{library/errno errno ENOTTY}@anchor{2f3c}
@deffn {Dado} errno.ENOTTY

Not a typewriter
@end deffn

@geindex ETXTBSY (no módulo errno)
@anchor{library/errno errno ETXTBSY}@anchor{2f3d}
@deffn {Dado} errno.ETXTBSY

Arquivo texto ocupado
@end deffn

@geindex EFBIG (no módulo errno)
@anchor{library/errno errno EFBIG}@anchor{2f3e}
@deffn {Dado} errno.EFBIG

Arquivo muito grande
@end deffn

@geindex ENOSPC (no módulo errno)
@anchor{library/errno errno ENOSPC}@anchor{2f3f}
@deffn {Dado} errno.ENOSPC

Não há espaço disponível no dispositivo
@end deffn

@geindex ESPIPE (no módulo errno)
@anchor{library/errno errno ESPIPE}@anchor{2f40}
@deffn {Dado} errno.ESPIPE

Procura ilegal
@end deffn

@geindex EROFS (no módulo errno)
@anchor{library/errno errno EROFS}@anchor{2f41}
@deffn {Dado} errno.EROFS

Sistema de arquivos de somente leitura
@end deffn

@geindex EMLINK (no módulo errno)
@anchor{library/errno errno EMLINK}@anchor{2f42}
@deffn {Dado} errno.EMLINK

Muitos links
@end deffn

@geindex EPIPE (no módulo errno)
@anchor{library/errno errno EPIPE}@anchor{243b}
@deffn {Dado} errno.EPIPE

Pipe quebrado. Este erro é mapeado para a exceção @ref{1095,,BrokenPipeError}.
@end deffn

@geindex EDOM (no módulo errno)
@anchor{library/errno errno EDOM}@anchor{2f43}
@deffn {Dado} errno.EDOM

Argumento matemático fora do domínio da função
@end deffn

@geindex ERANGE (no módulo errno)
@anchor{library/errno errno ERANGE}@anchor{2f44}
@deffn {Dado} errno.ERANGE

Resultado matemático não representável
@end deffn

@geindex EDEADLK (no módulo errno)
@anchor{library/errno errno EDEADLK}@anchor{2f45}
@deffn {Dado} errno.EDEADLK

Ocorreria um impasse (deadlock) de recursos
@end deffn

@geindex ENAMETOOLONG (no módulo errno)
@anchor{library/errno errno ENAMETOOLONG}@anchor{2f46}
@deffn {Dado} errno.ENAMETOOLONG

Nome de arquivo muito longo
@end deffn

@geindex ENOLCK (no módulo errno)
@anchor{library/errno errno ENOLCK}@anchor{2f47}
@deffn {Dado} errno.ENOLCK

Nenhuma trava de registro disponível
@end deffn

@geindex ENOSYS (no módulo errno)
@anchor{library/errno errno ENOSYS}@anchor{18e2}
@deffn {Dado} errno.ENOSYS

Função não implementada
@end deffn

@geindex ENOTEMPTY (no módulo errno)
@anchor{library/errno errno ENOTEMPTY}@anchor{2f48}
@deffn {Dado} errno.ENOTEMPTY

Diretório não vazio
@end deffn

@geindex ELOOP (no módulo errno)
@anchor{library/errno errno ELOOP}@anchor{2f49}
@deffn {Dado} errno.ELOOP

Foram encontrados muitos links simbólicos
@end deffn

@geindex EWOULDBLOCK (no módulo errno)
@anchor{library/errno errno EWOULDBLOCK}@anchor{2437}
@deffn {Dado} errno.EWOULDBLOCK

Operation causaria bloqueio. Este erro é mapeado para a exceção @ref{1090,,BlockingIOError}.
@end deffn

@geindex ENOMSG (no módulo errno)
@anchor{library/errno errno ENOMSG}@anchor{2f4a}
@deffn {Dado} errno.ENOMSG

Nenhuma mensagem do tipo desejado
@end deffn

@geindex EIDRM (no módulo errno)
@anchor{library/errno errno EIDRM}@anchor{2f4b}
@deffn {Dado} errno.EIDRM

Identificador removido
@end deffn

@geindex ECHRNG (no módulo errno)
@anchor{library/errno errno ECHRNG}@anchor{2f4c}
@deffn {Dado} errno.ECHRNG

Número do canal fora do intervalo
@end deffn

@geindex EL2NSYNC (no módulo errno)
@anchor{library/errno errno EL2NSYNC}@anchor{2f4d}
@deffn {Dado} errno.EL2NSYNC

Não sincronizado nível 2
@end deffn

@geindex EL3HLT (no módulo errno)
@anchor{library/errno errno EL3HLT}@anchor{2f4e}
@deffn {Dado} errno.EL3HLT

Parada de sistema nível 3
@end deffn

@geindex EL3RST (no módulo errno)
@anchor{library/errno errno EL3RST}@anchor{2f4f}
@deffn {Dado} errno.EL3RST

Reinicialização nível 3
@end deffn

@geindex ELNRNG (no módulo errno)
@anchor{library/errno errno ELNRNG}@anchor{2f50}
@deffn {Dado} errno.ELNRNG

Número de link fora da faixa
@end deffn

@geindex EUNATCH (no módulo errno)
@anchor{library/errno errno EUNATCH}@anchor{2f51}
@deffn {Dado} errno.EUNATCH

Driver de protocolo não anexado
@end deffn

@geindex ENOCSI (no módulo errno)
@anchor{library/errno errno ENOCSI}@anchor{2f52}
@deffn {Dado} errno.ENOCSI

Não há estrutura CSI disponível
@end deffn

@geindex EL2HLT (no módulo errno)
@anchor{library/errno errno EL2HLT}@anchor{2f53}
@deffn {Dado} errno.EL2HLT

Parada de sistema nível 2
@end deffn

@geindex EBADE (no módulo errno)
@anchor{library/errno errno EBADE}@anchor{2f54}
@deffn {Dado} errno.EBADE

Troca inválida
@end deffn

@geindex EBADR (no módulo errno)
@anchor{library/errno errno EBADR}@anchor{2f55}
@deffn {Dado} errno.EBADR

Descritor de requisição inválido
@end deffn

@geindex EXFULL (no módulo errno)
@anchor{library/errno errno EXFULL}@anchor{2f56}
@deffn {Dado} errno.EXFULL

Troca completa
@end deffn

@geindex ENOANO (no módulo errno)
@anchor{library/errno errno ENOANO}@anchor{2f57}
@deffn {Dado} errno.ENOANO

Sem anode
@end deffn

@geindex EBADRQC (no módulo errno)
@anchor{library/errno errno EBADRQC}@anchor{2f58}
@deffn {Dado} errno.EBADRQC

Código de requisição inválido
@end deffn

@geindex EBADSLT (no módulo errno)
@anchor{library/errno errno EBADSLT}@anchor{2f59}
@deffn {Dado} errno.EBADSLT

Slot inválido
@end deffn

@geindex EDEADLOCK (no módulo errno)
@anchor{library/errno errno EDEADLOCK}@anchor{2f5a}
@deffn {Dado} errno.EDEADLOCK

Erro de impasse em travamento de arquivo
@end deffn

@geindex EBFONT (no módulo errno)
@anchor{library/errno errno EBFONT}@anchor{2f5b}
@deffn {Dado} errno.EBFONT

Formato inválido do arquivo de fonte
@end deffn

@geindex ENOSTR (no módulo errno)
@anchor{library/errno errno ENOSTR}@anchor{2f5c}
@deffn {Dado} errno.ENOSTR

Dispositivo não é um stream
@end deffn

@geindex ENODATA (no módulo errno)
@anchor{library/errno errno ENODATA}@anchor{2f5d}
@deffn {Dado} errno.ENODATA

Não há dados disponíveis
@end deffn

@geindex ETIME (no módulo errno)
@anchor{library/errno errno ETIME}@anchor{2f5e}
@deffn {Dado} errno.ETIME

Temporizador expirado
@end deffn

@geindex ENOSR (no módulo errno)
@anchor{library/errno errno ENOSR}@anchor{2f5f}
@deffn {Dado} errno.ENOSR

Sem recursos de streams
@end deffn

@geindex ENONET (no módulo errno)
@anchor{library/errno errno ENONET}@anchor{2f60}
@deffn {Dado} errno.ENONET

A máquina não está na rede
@end deffn

@geindex ENOPKG (no módulo errno)
@anchor{library/errno errno ENOPKG}@anchor{2f61}
@deffn {Dado} errno.ENOPKG

Pacote não instalado
@end deffn

@geindex EREMOTE (no módulo errno)
@anchor{library/errno errno EREMOTE}@anchor{2f62}
@deffn {Dado} errno.EREMOTE

O objeto é remoto
@end deffn

@geindex ENOLINK (no módulo errno)
@anchor{library/errno errno ENOLINK}@anchor{2f63}
@deffn {Dado} errno.ENOLINK

A conexão foi rompida
@end deffn

@geindex EADV (no módulo errno)
@anchor{library/errno errno EADV}@anchor{2f64}
@deffn {Dado} errno.EADV

Erro de anúncio
@end deffn

@geindex ESRMNT (no módulo errno)
@anchor{library/errno errno ESRMNT}@anchor{2f65}
@deffn {Dado} errno.ESRMNT

Erro Srmount
@end deffn

@geindex ECOMM (no módulo errno)
@anchor{library/errno errno ECOMM}@anchor{2f66}
@deffn {Dado} errno.ECOMM

Erro de comunicação ao enviar
@end deffn

@geindex EPROTO (no módulo errno)
@anchor{library/errno errno EPROTO}@anchor{2f67}
@deffn {Dado} errno.EPROTO

Erro de Protocolo
@end deffn

@geindex EMULTIHOP (no módulo errno)
@anchor{library/errno errno EMULTIHOP}@anchor{2f68}
@deffn {Dado} errno.EMULTIHOP

Tentativa de hops múltiplos
@end deffn

@geindex EDOTDOT (no módulo errno)
@anchor{library/errno errno EDOTDOT}@anchor{2f69}
@deffn {Dado} errno.EDOTDOT

Erro específico de RFS
@end deffn

@geindex EBADMSG (no módulo errno)
@anchor{library/errno errno EBADMSG}@anchor{2f6a}
@deffn {Dado} errno.EBADMSG

Não é uma mensagem de dados
@end deffn

@geindex EOVERFLOW (no módulo errno)
@anchor{library/errno errno EOVERFLOW}@anchor{2f6b}
@deffn {Dado} errno.EOVERFLOW

Valor muito grande para o tipo de dados definido
@end deffn

@geindex ENOTUNIQ (no módulo errno)
@anchor{library/errno errno ENOTUNIQ}@anchor{2f6c}
@deffn {Dado} errno.ENOTUNIQ

O nome não é único na rede
@end deffn

@geindex EBADFD (no módulo errno)
@anchor{library/errno errno EBADFD}@anchor{2f6d}
@deffn {Dado} errno.EBADFD

Descritor de arquivo em mal estado
@end deffn

@geindex EREMCHG (no módulo errno)
@anchor{library/errno errno EREMCHG}@anchor{2f6e}
@deffn {Dado} errno.EREMCHG

Endereço remoto mudou
@end deffn

@geindex ELIBACC (no módulo errno)
@anchor{library/errno errno ELIBACC}@anchor{2f6f}
@deffn {Dado} errno.ELIBACC

Não é possível acessar uma biblioteca compartilhada necessária
@end deffn

@geindex ELIBBAD (no módulo errno)
@anchor{library/errno errno ELIBBAD}@anchor{2f70}
@deffn {Dado} errno.ELIBBAD

Acessando uma biblioteca compartilhado corrompida
@end deffn

@geindex ELIBSCN (no módulo errno)
@anchor{library/errno errno ELIBSCN}@anchor{2f71}
@deffn {Dado} errno.ELIBSCN

Seção .lib corrompida em a.out
@end deffn

@geindex ELIBMAX (no módulo errno)
@anchor{library/errno errno ELIBMAX}@anchor{2f72}
@deffn {Dado} errno.ELIBMAX

Tentando ligar em muitas bibliotecas compartilhadas
@end deffn

@geindex ELIBEXEC (no módulo errno)
@anchor{library/errno errno ELIBEXEC}@anchor{2f73}
@deffn {Dado} errno.ELIBEXEC

Não é possível executar uma biblioteca compartilhada diretamente
@end deffn

@geindex EILSEQ (no módulo errno)
@anchor{library/errno errno EILSEQ}@anchor{2f74}
@deffn {Dado} errno.EILSEQ

Sequência de bytes ilegal
@end deffn

@geindex ERESTART (no módulo errno)
@anchor{library/errno errno ERESTART}@anchor{2f75}
@deffn {Dado} errno.ERESTART

Chamada de sistema interrompida deve ser reiniciada
@end deffn

@geindex ESTRPIPE (no módulo errno)
@anchor{library/errno errno ESTRPIPE}@anchor{2f76}
@deffn {Dado} errno.ESTRPIPE

Erro de fluxos de pipe
@end deffn

@geindex EUSERS (no módulo errno)
@anchor{library/errno errno EUSERS}@anchor{2f77}
@deffn {Dado} errno.EUSERS

Muitos usuários
@end deffn

@geindex ENOTSOCK (no módulo errno)
@anchor{library/errno errno ENOTSOCK}@anchor{2f78}
@deffn {Dado} errno.ENOTSOCK

Operação socket em um arquivo não-socket
@end deffn

@geindex EDESTADDRREQ (no módulo errno)
@anchor{library/errno errno EDESTADDRREQ}@anchor{2f79}
@deffn {Dado} errno.EDESTADDRREQ

Endereço de destino necessário
@end deffn

@geindex EMSGSIZE (no módulo errno)
@anchor{library/errno errno EMSGSIZE}@anchor{2f7a}
@deffn {Dado} errno.EMSGSIZE

Mensagem muito longa
@end deffn

@geindex EPROTOTYPE (no módulo errno)
@anchor{library/errno errno EPROTOTYPE}@anchor{2f7b}
@deffn {Dado} errno.EPROTOTYPE

Tipo errado de protocolo para socket
@end deffn

@geindex ENOPROTOOPT (no módulo errno)
@anchor{library/errno errno ENOPROTOOPT}@anchor{2f7c}
@deffn {Dado} errno.ENOPROTOOPT

Protocolo não disponível
@end deffn

@geindex EPROTONOSUPPORT (no módulo errno)
@anchor{library/errno errno EPROTONOSUPPORT}@anchor{2f7d}
@deffn {Dado} errno.EPROTONOSUPPORT

Protocolo sem suporte
@end deffn

@geindex ESOCKTNOSUPPORT (no módulo errno)
@anchor{library/errno errno ESOCKTNOSUPPORT}@anchor{2f7e}
@deffn {Dado} errno.ESOCKTNOSUPPORT

Tipo socket sem suporte
@end deffn

@geindex EOPNOTSUPP (no módulo errno)
@anchor{library/errno errno EOPNOTSUPP}@anchor{2f7f}
@deffn {Dado} errno.EOPNOTSUPP

Operação sem suporte na extremidade do transporte
@end deffn

@geindex ENOTSUP (no módulo errno)
@anchor{library/errno errno ENOTSUP}@anchor{2f80}
@deffn {Dado} errno.ENOTSUP

Operação sem suporte


Adicionado na versão 3.2.

@end deffn

@geindex EPFNOSUPPORT (no módulo errno)
@anchor{library/errno errno EPFNOSUPPORT}@anchor{2f81}
@deffn {Dado} errno.EPFNOSUPPORT

Família de protocolo sem suporte
@end deffn

@geindex EAFNOSUPPORT (no módulo errno)
@anchor{library/errno errno EAFNOSUPPORT}@anchor{2f82}
@deffn {Dado} errno.EAFNOSUPPORT

Família de endereços sem suporte pelo protocolo
@end deffn

@geindex EADDRINUSE (no módulo errno)
@anchor{library/errno errno EADDRINUSE}@anchor{2f83}
@deffn {Dado} errno.EADDRINUSE

Endereço já em uso
@end deffn

@geindex EADDRNOTAVAIL (no módulo errno)
@anchor{library/errno errno EADDRNOTAVAIL}@anchor{2f84}
@deffn {Dado} errno.EADDRNOTAVAIL

Não é possível acessar o endereço requisitado
@end deffn

@geindex ENETDOWN (no módulo errno)
@anchor{library/errno errno ENETDOWN}@anchor{2f85}
@deffn {Dado} errno.ENETDOWN

A rede não responde
@end deffn

@geindex ENETUNREACH (no módulo errno)
@anchor{library/errno errno ENETUNREACH}@anchor{1b7e}
@deffn {Dado} errno.ENETUNREACH

A rede está fora de alcance
@end deffn

@geindex ENETRESET (no módulo errno)
@anchor{library/errno errno ENETRESET}@anchor{2f86}
@deffn {Dado} errno.ENETRESET

A rede desconectou-se ao reiniciar
@end deffn

@geindex ECONNABORTED (no módulo errno)
@anchor{library/errno errno ECONNABORTED}@anchor{243d}
@deffn {Dado} errno.ECONNABORTED

O software causou a interrupção da conexão. Este erro é mapeado para a exceção @ref{1096,,ConnectionAbortedError}.
@end deffn

@geindex ECONNRESET (no módulo errno)
@anchor{library/errno errno ECONNRESET}@anchor{243f}
@deffn {Dado} errno.ECONNRESET

Conexão fechada pela outra ponta. Este erro é mapeado para a exceção @ref{1098,,ConnectionResetError}.
@end deffn

@geindex ENOBUFS (no módulo errno)
@anchor{library/errno errno ENOBUFS}@anchor{18fc}
@deffn {Dado} errno.ENOBUFS

Não há espaço de buffer disponível
@end deffn

@geindex EISCONN (no módulo errno)
@anchor{library/errno errno EISCONN}@anchor{2f87}
@deffn {Dado} errno.EISCONN

A extremidade do transporte já está conectada
@end deffn

@geindex ENOTCONN (no módulo errno)
@anchor{library/errno errno ENOTCONN}@anchor{2f88}
@deffn {Dado} errno.ENOTCONN

A extremidade do transporte não está conectada
@end deffn

@geindex ESHUTDOWN (no módulo errno)
@anchor{library/errno errno ESHUTDOWN}@anchor{243c}
@deffn {Dado} errno.ESHUTDOWN

Cannot send after transport endpoint shutdown. This error is mapped
to the exception @ref{1095,,BrokenPipeError}.
@end deffn

@geindex ETOOMANYREFS (no módulo errno)
@anchor{library/errno errno ETOOMANYREFS}@anchor{2f89}
@deffn {Dado} errno.ETOOMANYREFS

Too many references: cannot splice
@end deffn

@geindex ETIMEDOUT (no módulo errno)
@anchor{library/errno errno ETIMEDOUT}@anchor{2446}
@deffn {Dado} errno.ETIMEDOUT

Connection timed out. This error is mapped to the exception
@ref{838,,TimeoutError}.
@end deffn

@geindex ECONNREFUSED (no módulo errno)
@anchor{library/errno errno ECONNREFUSED}@anchor{243e}
@deffn {Dado} errno.ECONNREFUSED

Connection refused. This error is mapped to the exception
@ref{1097,,ConnectionRefusedError}.
@end deffn

@geindex EHOSTDOWN (no módulo errno)
@anchor{library/errno errno EHOSTDOWN}@anchor{2f8a}
@deffn {Dado} errno.EHOSTDOWN

Host is down
@end deffn

@geindex EHOSTUNREACH (no módulo errno)
@anchor{library/errno errno EHOSTUNREACH}@anchor{2f8b}
@deffn {Dado} errno.EHOSTUNREACH

No route to host
@end deffn

@geindex EALREADY (no módulo errno)
@anchor{library/errno errno EALREADY}@anchor{2436}
@deffn {Dado} errno.EALREADY

Operation already in progress. This error is mapped to the
exception @ref{1090,,BlockingIOError}.
@end deffn

@geindex EINPROGRESS (no módulo errno)
@anchor{library/errno errno EINPROGRESS}@anchor{2438}
@deffn {Dado} errno.EINPROGRESS

Operation now in progress. This error is mapped to the exception
@ref{1090,,BlockingIOError}.
@end deffn

@geindex ESTALE (no módulo errno)
@anchor{library/errno errno ESTALE}@anchor{2f8c}
@deffn {Dado} errno.ESTALE

Stale NFS file handle
@end deffn

@geindex EUCLEAN (no módulo errno)
@anchor{library/errno errno EUCLEAN}@anchor{2f8d}
@deffn {Dado} errno.EUCLEAN

Structure needs cleaning
@end deffn

@geindex ENOTNAM (no módulo errno)
@anchor{library/errno errno ENOTNAM}@anchor{2f8e}
@deffn {Dado} errno.ENOTNAM

Not a XENIX named type file
@end deffn

@geindex ENAVAIL (no módulo errno)
@anchor{library/errno errno ENAVAIL}@anchor{2f8f}
@deffn {Dado} errno.ENAVAIL

No XENIX semaphores available
@end deffn

@geindex EISNAM (no módulo errno)
@anchor{library/errno errno EISNAM}@anchor{2f90}
@deffn {Dado} errno.EISNAM

É um arquivo de tipo nomeado
@end deffn

@geindex EREMOTEIO (no módulo errno)
@anchor{library/errno errno EREMOTEIO}@anchor{2f91}
@deffn {Dado} errno.EREMOTEIO

Erro de E/S remoto
@end deffn

@geindex EDQUOT (no módulo errno)
@anchor{library/errno errno EDQUOT}@anchor{2f92}
@deffn {Dado} errno.EDQUOT

Quota exceeded
@end deffn

@geindex EQFULL (no módulo errno)
@anchor{library/errno errno EQFULL}@anchor{2f93}
@deffn {Dado} errno.EQFULL

Interface output queue is full


Adicionado na versão 3.11.

@end deffn

@geindex ENOMEDIUM (no módulo errno)
@anchor{library/errno errno ENOMEDIUM}@anchor{2f94}
@deffn {Dado} errno.ENOMEDIUM

No medium found
@end deffn

@geindex EMEDIUMTYPE (no módulo errno)
@anchor{library/errno errno EMEDIUMTYPE}@anchor{2f95}
@deffn {Dado} errno.EMEDIUMTYPE

Wrong medium type
@end deffn

@geindex ENOKEY (no módulo errno)
@anchor{library/errno errno ENOKEY}@anchor{2f96}
@deffn {Dado} errno.ENOKEY

Required key not available
@end deffn

@geindex EKEYEXPIRED (no módulo errno)
@anchor{library/errno errno EKEYEXPIRED}@anchor{2f97}
@deffn {Dado} errno.EKEYEXPIRED

Key has expired
@end deffn

@geindex EKEYREVOKED (no módulo errno)
@anchor{library/errno errno EKEYREVOKED}@anchor{2f98}
@deffn {Dado} errno.EKEYREVOKED

Key has been revoked
@end deffn

@geindex EKEYREJECTED (no módulo errno)
@anchor{library/errno errno EKEYREJECTED}@anchor{2f99}
@deffn {Dado} errno.EKEYREJECTED

Key was rejected by service
@end deffn

@geindex ERFKILL (no módulo errno)
@anchor{library/errno errno ERFKILL}@anchor{2f9a}
@deffn {Dado} errno.ERFKILL

Operation not possible due to RF-kill
@end deffn

@geindex ELOCKUNMAPPED (no módulo errno)
@anchor{library/errno errno ELOCKUNMAPPED}@anchor{2f9b}
@deffn {Dado} errno.ELOCKUNMAPPED

Locked lock was unmapped
@end deffn

@geindex ENOTACTIVE (no módulo errno)
@anchor{library/errno errno ENOTACTIVE}@anchor{2f9c}
@deffn {Dado} errno.ENOTACTIVE

Facility is not active
@end deffn

@geindex EAUTH (no módulo errno)
@anchor{library/errno errno EAUTH}@anchor{2f9d}
@deffn {Dado} errno.EAUTH

Authentication error


Adicionado na versão 3.2.

@end deffn

@geindex EBADARCH (no módulo errno)
@anchor{library/errno errno EBADARCH}@anchor{2f9e}
@deffn {Dado} errno.EBADARCH

Bad CPU type in executable


Adicionado na versão 3.2.

@end deffn

@geindex EBADEXEC (no módulo errno)
@anchor{library/errno errno EBADEXEC}@anchor{2f9f}
@deffn {Dado} errno.EBADEXEC

Bad executable (or shared library)


Adicionado na versão 3.2.

@end deffn

@geindex EBADMACHO (no módulo errno)
@anchor{library/errno errno EBADMACHO}@anchor{2fa0}
@deffn {Dado} errno.EBADMACHO

Malformed Mach-o file


Adicionado na versão 3.2.

@end deffn

@geindex EDEVERR (no módulo errno)
@anchor{library/errno errno EDEVERR}@anchor{2fa1}
@deffn {Dado} errno.EDEVERR

Device error


Adicionado na versão 3.2.

@end deffn

@geindex EFTYPE (no módulo errno)
@anchor{library/errno errno EFTYPE}@anchor{2fa2}
@deffn {Dado} errno.EFTYPE

Inappropriate file type or format


Adicionado na versão 3.2.

@end deffn

@geindex ENEEDAUTH (no módulo errno)
@anchor{library/errno errno ENEEDAUTH}@anchor{2fa3}
@deffn {Dado} errno.ENEEDAUTH

Need authenticator


Adicionado na versão 3.2.

@end deffn

@geindex ENOATTR (no módulo errno)
@anchor{library/errno errno ENOATTR}@anchor{2fa4}
@deffn {Dado} errno.ENOATTR

Attribute not found


Adicionado na versão 3.2.

@end deffn

@geindex ENOPOLICY (no módulo errno)
@anchor{library/errno errno ENOPOLICY}@anchor{2fa5}
@deffn {Dado} errno.ENOPOLICY

Policy not found


Adicionado na versão 3.2.

@end deffn

@geindex EPROCLIM (no módulo errno)
@anchor{library/errno errno EPROCLIM}@anchor{2fa6}
@deffn {Dado} errno.EPROCLIM

Too many processes


Adicionado na versão 3.2.

@end deffn

@geindex EPROCUNAVAIL (no módulo errno)
@anchor{library/errno errno EPROCUNAVAIL}@anchor{2fa7}
@deffn {Dado} errno.EPROCUNAVAIL

Bad procedure for program


Adicionado na versão 3.2.

@end deffn

@geindex EPROGMISMATCH (no módulo errno)
@anchor{library/errno errno EPROGMISMATCH}@anchor{2fa8}
@deffn {Dado} errno.EPROGMISMATCH

Program version wrong


Adicionado na versão 3.2.

@end deffn

@geindex EPROGUNAVAIL (no módulo errno)
@anchor{library/errno errno EPROGUNAVAIL}@anchor{2fa9}
@deffn {Dado} errno.EPROGUNAVAIL

RPC prog. not avail


Adicionado na versão 3.2.

@end deffn

@geindex EPWROFF (no módulo errno)
@anchor{library/errno errno EPWROFF}@anchor{2faa}
@deffn {Dado} errno.EPWROFF

Device power is off


Adicionado na versão 3.2.

@end deffn

@geindex EBADRPC (no módulo errno)
@anchor{library/errno errno EBADRPC}@anchor{2fab}
@deffn {Dado} errno.EBADRPC

RPC struct is bad


Adicionado na versão 3.2.

@end deffn

@geindex ERPCMISMATCH (no módulo errno)
@anchor{library/errno errno ERPCMISMATCH}@anchor{2fac}
@deffn {Dado} errno.ERPCMISMATCH

RPC version wrong


Adicionado na versão 3.2.

@end deffn

@geindex ESHLIBVERS (no módulo errno)
@anchor{library/errno errno ESHLIBVERS}@anchor{2fad}
@deffn {Dado} errno.ESHLIBVERS

Shared library version mismatch


Adicionado na versão 3.2.

@end deffn

@geindex ENOTCAPABLE (no módulo errno)
@anchor{library/errno errno ENOTCAPABLE}@anchor{18c8}
@deffn {Dado} errno.ENOTCAPABLE

Capabilities insufficient. This error is mapped to the exception
@ref{d65,,PermissionError}.

@ref{1ed8,,Disponibilidade}: WASI, FreeBSD


Adicionado na versão 3.11.1.

@end deffn

@geindex ECANCELED (no módulo errno)
@anchor{library/errno errno ECANCELED}@anchor{15f7}
@deffn {Dado} errno.ECANCELED

Operation canceled


Adicionado na versão 3.2.

@end deffn

@geindex EOWNERDEAD (no módulo errno)
@anchor{library/errno errno EOWNERDEAD}@anchor{2fae}
@deffn {Dado} errno.EOWNERDEAD

Owner died


Adicionado na versão 3.2.

@end deffn

@geindex ENOTRECOVERABLE (no módulo errno)
@anchor{library/errno errno ENOTRECOVERABLE}@anchor{2faf}
@deffn {Dado} errno.ENOTRECOVERABLE

State not recoverable


Adicionado na versão 3.2.

@end deffn

@node ctypes — Uma biblioteca de funções externas para Python,,errno — Símbolos padrão do sistema errno,Serviços Genéricos do Sistema Operacional
@anchor{library/ctypes doc}@anchor{2fb0}@anchor{library/ctypes ctypes-a-foreign-function-library-for-python}@anchor{2fb1}@anchor{library/ctypes module-ctypes}@anchor{2a}@anchor{library/ctypes translation-repo}@anchor{2fb2}
@subsection @code{ctypes} — Uma biblioteca de funções externas para Python


@geindex module; ctypes

`Código-fonte:' Lib/ctypes@footnote{https://github.com/python/cpython/tree/3.13/Lib/ctypes}


__________________________________________________________________


@ref{2a,,ctypes} é uma biblioteca de funções externas para Python. Ela fornece tipos de dados compatíveis com C e permite funções de chamada em DLLs ou bibliotecas compartilhadas. Ela pode ser usada para agrupar essas bibliotecas em Python puro.

@menu
* Tutorial ctypes:: 
* Referência ctypes:: 

@end menu

@node Tutorial ctypes,Referência ctypes,,ctypes — Uma biblioteca de funções externas para Python
@anchor{library/ctypes ctypes-ctypes-tutorial}@anchor{2fb3}@anchor{library/ctypes ctypes-tutorial}@anchor{2fb4}
@subsubsection Tutorial ctypes


Nota: Os exemplos de código neste tutorial usam @ref{3a,,doctest} para garantir que eles realmente funcionem. Como algumas amostras de código se comportam de maneira diferente no Linux, Windows ou macOS, elas contêm diretrizes de doctest nos comentários.

Nota: Alguns exemplos de código fazem referência ao tipo ctypes @ref{2fb5,,c_int}. Em plataformas onde @code{sizeof(long) == sizeof(int)} é um apelido para @ref{2fb6,,c_long}. Então, você não deve ficar confuso se @ref{2fb6,,c_long} for impresso se você esperaria @ref{2fb5,,c_int} — eles são, na verdade, o mesmo tipo.

@menu
* Carregando bibliotecas de links dinâmicos:: 
* Acessando funções de dlls carregadas:: 
* Chamando funções:: 
* Tipos de dados fundamentais:: 
* Chamando funções@comma{} continuação: Chamando funções continuação. 
* Chamando funções variadas:: 
* Chamando funções com seus próprios tipos de dados personalizados:: 
* Especificando os tipos de argumentos necessários (protótipos de função): Especificando os tipos de argumentos necessários protótipos de função. 
* Tipos de Retorno:: 
* Passando ponteiros (ou; passando parâmetros por referência): Passando ponteiros ou passando parâmetros por referência. 
* Estruturas e uniões:: 
* Structure/union alignment and byte order:: 
* Campos de bit em estruturas e uniões:: 
* Vetores:: 
* Ponteiros:: 
* Conversão de Tipos:: 
* Tipos Incompletos:: 
* Funções Callbacks:: 
* Acessando valores exportados de dlls:: 
* Surpresas:: 
* Tipos de dados de tamanho variável:: 

@end menu

@node Carregando bibliotecas de links dinâmicos,Acessando funções de dlls carregadas,,Tutorial ctypes
@anchor{library/ctypes ctypes-loading-dynamic-link-libraries}@anchor{2fb7}@anchor{library/ctypes loading-dynamic-link-libraries}@anchor{2fb8}
@subsubsection Carregando bibliotecas de links dinâmicos


@ref{2a,,ctypes} exporta o `cdll' e, no Windows, os objetos `windll' e `oledll' para carregar bibliotecas de vínculo dinâmico.

Você carrega bibliotecas acessando-as como atributos desses objetos. `cdll' carrega bibliotecas que exportam funções usando a convenção de chamada padrão @code{cdecl}, enquanto bibliotecas `windll' chamam funções usando a convenção de chamada @code{stdcall}. `oledll' também usa a convenção de chamada @code{stdcall} e assume que as funções retornam um código de erro do Windows @code{HRESULT}. O código de erro é usado para levantar automaticamente uma exceção @ref{417,,OSError} quando a chamada da função falha.


Alterado na versão 3.3: Erros do Windows costumavam levantar @ref{108d,,WindowsError}, que agora é um apelido de @ref{417,,OSError}.


Veja alguns exemplos para Windows. Note que @code{msvcrt} é a biblioteca C padrão da MS que contém a maioria das funções C padrão e usa a convenção de chamada @code{cdecl}:

@example
>>> from ctypes import *
>>> print(windll.kernel32)
<WinDLL 'kernel32', handle ... at ...>
>>> print(cdll.msvcrt)
<CDLL 'msvcrt', handle ... at ...>
>>> libc = cdll.msvcrt
>>>
@end example

O Windows acrescenta automaticamente o sufixo de arquivo @code{.dll} usual.

@cartouche
@quotation Nota 
Acessar a biblioteca padrão C por meio de @code{cdll.msvcrt} usará uma versão desatualizada da biblioteca que pode ser incompatível com a que está sendo usada pelo Python. Onde possível, use a funcionalidade nativa do Python ou então importe e use o módulo @code{msvcrt}.
@end quotation
@end cartouche

No Linux, é necessário especificar o nome do arquivo `incluindo' a extensão para carregar uma biblioteca, então o acesso de atributo não pode ser usado para carregar bibliotecas. O método @ref{2fb9,,LoadLibrary()} dos carregadores de dll deve ser usado, ou você deve carregar a biblioteca criando uma instância de CDLL chamando o construtor:

@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 Acessando funções de dlls carregadas,Chamando funções,Carregando bibliotecas de links dinâmicos,Tutorial ctypes
@anchor{library/ctypes accessing-functions-from-loaded-dlls}@anchor{2fba}@anchor{library/ctypes ctypes-accessing-functions-from-loaded-dlls}@anchor{2fbb}
@subsubsection Acessando funções de dlls carregadas


Funções são acessadas como atributos de 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

Observe que DLLs de sistema do Win32, como @code{kernel32} e @code{user32}, frequentemente exportam versões ANSI e UNICODE de uma função. A versão UNICODE é exportada com um @code{W} anexado ao nome, enquanto a versão ANSI é exportada com um @code{A} anexado ao nome. A função @code{GetModuleHandle} do Win32, que retorna um `identificador de módulo' para um determinado nome de módulo, tem o seguinte protótipo em C, e uma macro é usada para expor um deles como @code{GetModuleHandle}, dependendo se UNICODE está definido ou não:

@example
/* versão ANSI */
HMODULE GetModuleHandleA(LPCSTR lpModuleName);
/* versão UNICODE */
HMODULE GetModuleHandleW(LPCWSTR lpModuleName);
@end example

`windll' não tenta selecionar um deles magicamente, você deve acessar a versão necessária especificando @code{GetModuleHandleA} ou @code{GetModuleHandleW} explicitamente e então chamá-lo com objetos bytes ou string, respectivamente.

Às vezes, DLLs exportam funções com nomes que não são identificadores Python válidos, como @code{"??2@@YAPAXI@@Z"}. Nesse caso, você precisa usar @ref{bea,,getattr()} para recuperar a função:

@example
>>> getattr(cdll.msvcrt, "??2@@YAPAXI@@Z")
<_FuncPtr object at 0x...>
>>>
@end example

No Windows, algumas dlls exportam funções não por nome, mas por ordinal. Essas funções podem ser acessadas indexando o objeto dll com o 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 Chamando funções,Tipos de dados fundamentais,Acessando funções de dlls carregadas,Tutorial ctypes
@anchor{library/ctypes calling-functions}@anchor{2fbc}@anchor{library/ctypes ctypes-calling-functions}@anchor{2fbd}
@subsubsection Chamando funções


Você pode chamar essas funções como qualquer outro chamável do Python. Este exemplo usa a função @code{rand()}, que não aceita argumentos e retorna um inteiro pseudoaleatório:

@example
>>> print(libc.rand())
1804289383
@end example

No Windows, você pode chamar a função @code{GetModuleHandleA()}, que retorna um identificador de módulo win32 (passando @code{None} como único argumento para chamá-lo com um ponteiro @code{NULL}):

@example
>>> print(hex(windll.kernel32.GetModuleHandleA(None)))
0x1d000000
>>>
@end example

@ref{202,,ValueError} é gerado quando você chama uma função @code{stdcall} com a convenção de chamada @code{cdecl}, ou vice-versa:

@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 descobrir a convenção de chamada correta, você precisa consultar o arquivo de cabeçalho C ou a documentação da função que deseja chamar.

No Windows, @ref{2a,,ctypes} usa o tratamento de exceções estruturado do win32 para evitar travamentos devido a falhas gerais de proteção quando funções são chamadas com valores de argumentos 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

No entanto, existem maneiras suficientes de travar o Python com @ref{2a,,ctypes}, então você deve ter cuidado de qualquer maneira. O módulo @ref{58,,faulthandler} pode ser útil na depuração de travamentos (por exemplo, de falhas de segmentação produzidas por chamadas errôneas da biblioteca C).

@code{None}, inteiros, objetos bytes e strings (unicode) são os únicos objetos nativos do Python que podem ser usados diretamente como parâmetros nessas chamadas de função. @code{None} é passado como um ponteiro @code{NULL} em C, objetos bytes e strings são passados como ponteiros para o bloco de memória que contém seus dados (char* ou wchar_t*). Inteiros em Python são passados como o tipo padrão da plataforma em C int, e seu valor é mascarado para se encaixar no tipo em C.

Antes de prosseguirmos com a chamada de funções com outros tipos de parâmetros, precisamos aprender mais sobre os tipos de dados @ref{2a,,ctypes}.

@node Tipos de dados fundamentais,Chamando funções continuação,Chamando funções,Tutorial ctypes
@anchor{library/ctypes ctypes-fundamental-data-types}@anchor{2fbe}@anchor{library/ctypes fundamental-data-types}@anchor{2fbf}
@subsubsection Tipos de dados fundamentais


@ref{2a,,ctypes} define uma série de tipos de dados primitivos compatíveis com C:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo ctypes

@tab

Tipo em C

@tab

Tipo em Python

@item

@ref{2fc0,,c_bool}

@tab

_Bool

@tab

bool (1)

@item

@ref{2fc1,,c_char}

@tab

char

@tab

objeto bytes de 1 caractere

@item

@ref{2fc2,,c_wchar}

@tab

@code{wchar_t}

@tab

string de 1 caractere

@item

@ref{1868,,c_byte}

@tab

char

@tab

int

@item

@ref{1869,,c_ubyte}

@tab

unsigned char

@tab

int

@item

@ref{2fc3,,c_short}

@tab

short

@tab

int

@item

@ref{2fc4,,c_ushort}

@tab

unsigned short

@tab

int

@item

@ref{2fb5,,c_int}

@tab

int

@tab

int

@item

@ref{2fc5,,c_int8}

@tab

@code{int8_t}

@tab

int

@item

@ref{2fc6,,c_int16}

@tab

@code{int16_t}

@tab

int

@item

@ref{2fc7,,c_int32}

@tab

@code{int32_t}

@tab

int

@item

@ref{2fc8,,c_int64}

@tab

@code{int64_t}

@tab

int

@item

@ref{2fc9,,c_uint}

@tab

unsigned int

@tab

int

@item

@ref{2fca,,c_uint8}

@tab

@code{uint8_t}

@tab

int

@item

@ref{2fcb,,c_uint16}

@tab

@code{uint16_t}

@tab

int

@item

@ref{2fcc,,c_uint32}

@tab

@code{uint32_t}

@tab

int

@item

@ref{2fcd,,c_uint64}

@tab

@code{uint64_t}

@tab

int

@item

@ref{2fb6,,c_long}

@tab

long

@tab

int

@item

@ref{2fce,,c_ulong}

@tab

unsigned long

@tab

int

@item

@ref{2fcf,,c_longlong}

@tab

__int64 ou long long

@tab

int

@item

@ref{2fd0,,c_ulonglong}

@tab

unsigned __int64 ou unsigned long long

@tab

int

@item

@ref{2fd1,,c_size_t}

@tab

@code{size_t}

@tab

int

@item

@ref{127d,,c_ssize_t}

@tab

@code{ssize_t} ou @ref{a69,,Py_ssize_t}

@tab

int

@item

@ref{18ee,,c_time_t}

@tab

@code{time_t}

@tab

int

@item

@ref{2fd2,,c_float}

@tab

float

@tab

ponto flutuante

@item

@ref{1a44,,c_double}

@tab

double

@tab

ponto flutuante

@item

@ref{1a45,,c_longdouble}

@tab

long double

@tab

ponto flutuante

@item

@ref{17d9,,c_char_p}

@tab

char* (finalizado com NUL)

@tab

objeto bytes ou @code{None}

@item

@ref{17da,,c_wchar_p}

@tab

wchar_t* (finalizado com NUL)

@tab

String ou @code{None}

@item

@ref{17db,,c_void_p}

@tab

void*

@tab

int ou @code{None}

@end multitable



@enumerate 

@item 
O construtor aceita qualquer objeto com um valor verdade.
@end enumerate

Todos esses tipos podem ser criados chamando-os com um inicializador opcional do tipo e valor corretos:

@example
>>> c_int()
c_long(0)
>>> c_wchar_p("Olá, mundo")
c_wchar_p(139878537078816)
>>> c_ushort(-3)
c_ushort(65533)
>>>
@end example

Como esses tipos são mutáveis, seus valores também podem ser alterados posteriormente:

@example
>>> i = c_int(42)
>>> print(i)
c_long(42)
>>> print(i.value)
42
>>> i.value = -99
>>> print(i.value)
-99
>>>
@end example

Atribuir um novo valor a instâncias dos tipos de ponteiro @ref{17d9,,c_char_p}, @ref{17da,,c_wchar_p} e @ref{17db,,c_void_p} altera o `local de memória' para o qual eles apontam, `não o conteúdo' do bloco de memória (claro que não, porque objetos string do Python são imutáveis):

@example
>>> s = "Olá, mundo"
>>> c_s = c_wchar_p(s)
>>> print(c_s)
c_wchar_p(139878542513936)
>>> print(c_s.value)
Olá, mundo
>>> c_s.value = "Opa, beleza?"
>>> print(c_s)              # o local da memória foi alterado
c_wchar_p(139878536944240)
>>> print(c_s.value)
Opa, beleza?
>>> print(s)                # primeiro objeto está inalterado
Olá, mundo
>>>
@end example

No entanto, tome cuidado para não passá-los para funções que esperam ponteiros para memória mutável. Se precisar de blocos de memória mutáveis, o ctypes possui uma função @ref{2fd3,,create_string_buffer()} que os cria de várias maneiras. O conteúdo do bloco de memória atual pode ser acessado (ou alterado) com a propriedade @code{raw}; se quiser acessá-lo como uma string terminada em NUL, use a propriedade @code{value}:

@example
>>> from ctypes import *
>>> p = create_string_buffer(3)            # cria um buffer de 3 bytes, inicializado para NUL bytes
>>> print(sizeof(p), repr(p.raw))
3 b'\x00\x00\x00'
>>> p = create_string_buffer(b"Opa")       # cria um buffer contendo uma string terminando com NUL
>>> print(sizeof(p), repr(p.raw))
4 b'Opa\x00'
>>> print(repr(p.value))
b'Opa'
>>> p = create_string_buffer(b"Oi", 10)    # cria um buffer de 10 bytes
>>> print(sizeof(p), repr(p.raw))
10 b'Oi\x00\x00\x00\x00\x00\x00\x00\x00'
>>> p.value = b"Oi"
>>> print(sizeof(p), repr(p.raw))
10 b'Oi\x00\x00\x00\x00\x00\x00\x00\x00'
>>>
@end example

A função @ref{2fd3,,create_string_buffer()} substitui a antiga função @code{c_buffer()} (que ainda está disponível como um apelido). Para criar um bloco de memória mutável contendo caracteres Unicode do tipo C @code{wchar_t}, use a função @ref{1b46,,create_unicode_buffer()}.

@node Chamando funções continuação,Chamando funções variadas,Tipos de dados fundamentais,Tutorial ctypes
@anchor{library/ctypes calling-functions-continued}@anchor{2fd4}@anchor{library/ctypes ctypes-calling-functions-continued}@anchor{2fd5}
@subsubsection Chamando funções, continuação


Observe que printf imprime no canal de saída padrão real, `não' em @ref{ae6,,sys.stdout}, então esses exemplos só funcionarão no prompt do console, não de dentro do `IDLE' ou `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 mencionado anteriormente, todos os tipos do Python, exceto inteiros, strings e objetos bytes, precisam ser encapsulados em seu tipo correspondente de @ref{2a,,ctypes}, para que possam ser convertidos para o tipo de dado C necessário:

@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 Chamando funções variadas,Chamando funções com seus próprios tipos de dados personalizados,Chamando funções continuação,Tutorial ctypes
@anchor{library/ctypes calling-variadic-functions}@anchor{2fd6}@anchor{library/ctypes ctypes-calling-variadic-functions}@anchor{2fd7}
@subsubsection Chamando funções variadas


Em muitas plataformas chamar funções variádicas por meio do ctypes é exatamente o mesmo que chamar funções com um número fixo de parâmetros. Em algumas plataformas, em particular no ARM64 para plataformas Apple, a convenção de chamada para funções variádicas é diferente daquela usada para funções regulares.

Nessas plataformas é necessário especificar o atributo @ref{15f6,,argtypes} para os argumentos de função regulares (não variádicos):

@example
libc.printf.argtypes = [ctypes.c_char_p]
@end example

Já que especificar o atributo não impede a portabilidade, recomenda-se sempre especificar o @ref{15f6,,argtypes} para todas as funções variádicas.

@node Chamando funções com seus próprios tipos de dados personalizados,Especificando os tipos de argumentos necessários protótipos de função,Chamando funções variadas,Tutorial ctypes
@anchor{library/ctypes calling-functions-with-your-own-custom-data-types}@anchor{2fd8}@anchor{library/ctypes ctypes-calling-functions-with-own-custom-data-types}@anchor{2fd9}
@subsubsection Chamando funções com seus próprios tipos de dados personalizados


Você também pode personalizar a conversão de argumentos do @ref{2a,,ctypes} para permitir que instâncias das suas próprias classes sejam usadas como argumento de função. O @ref{2a,,ctypes} procura um atributo @code{_as_parameter_} e o utiliza como o argumento da função. O atributo deve ser um inteiro, string, bytes, uma instância de @ref{2a,,ctypes}, ou um objeto com um atributo @code{_as_parameter_}:

@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

Se você não quiser armazenar os dados da instância na variável de instância @code{_as_parameter_}, você pode definir  uma @ref{194,,property} que disponibilize o atributo mediante solicitação.

@node Especificando os tipos de argumentos necessários protótipos de função,Tipos de Retorno,Chamando funções com seus próprios tipos de dados personalizados,Tutorial ctypes
@anchor{library/ctypes ctypes-specifying-required-argument-types}@anchor{2fda}@anchor{library/ctypes specifying-the-required-argument-types-function-prototypes}@anchor{2fdb}
@subsubsection Especificando os tipos de argumentos necessários (protótipos de função)


É possível especificar os tipos de argumentos necessários de funções exportadas de DLLs definindo o atributo @ref{15f6,,argtypes}.

@ref{15f6,,argtypes} deve ser uma sequência de tipos de dados C (a função @code{printf()} provavelmente não é um bom exemplo nesse caso, pois ela aceita um número variável e diferentes tipos de parâmetros dependendo da string de formato; por outro lado, ela é bastante útil para experimentar esse recurso):

@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

Especificar um formato protege contra tipos de argumentos incompatíveis (assim como um protótipo para uma função em C), e tenta converter os argumentos para 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

Se você definiu suas próprias classes que serão passadas em chamadas de função, é necessário implementar um método de classe @ref{2fdc,,from_param()} para que elas possam ser usadas na sequência @ref{15f6,,argtypes}. O método de classe @ref{2fdc,,from_param()} recebe o objeto Python passado para a chamada de função; ele deve realizar um typecheck ou o que for necessário para garantir que esse objeto seja aceitável, e então retornar o próprio objeto, seu atributo @code{_as_parameter_} ou qualquer valor que você queira passar como argumento da função C nesse caso. Novamente, o resultado deve ser um inteiro, string, bytes, uma instância de @ref{2a,,ctypes} ou um objeto com um atributo @code{_as_parameter_}.

@node Tipos de Retorno,Passando ponteiros ou passando parâmetros por referência,Especificando os tipos de argumentos necessários protótipos de função,Tutorial ctypes
@anchor{library/ctypes ctypes-return-types}@anchor{2fdd}@anchor{library/ctypes return-types}@anchor{2fde}
@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

Por padrão, as funções são presumidas como retornando o tipo C int. Outros retornos podem ser especificados definindo o atributo @ref{2fdf,,restype} do objeto função.

O protótipo C de @code{time()} é @code{time_t time(time_t *)}. Porque @code{time_t} pode ser de um tipo diferente do tipo de retorno padrão int, você deve especificar o atributo @code{restype}.

@example
>>> libc.time.restype = c_time_t
@end example

Os tipos de argumentos podem ser especificados usando @ref{15f6,,argtypes}:

@example
>>> libc.time.argtypes = (POINTER(c_time_t),)
@end example

Para chamar uma função com um ponteiro @code{NULL} como primeiro argumento, use @code{None}:

@example
>>> print(libc.time(None))
1150640792
@end example

Aqui está um exemplo mais avançado, ele usa a função @code{strchr()}, que espera um ponteiro de string e um char, e retorna um ponteiro para uma 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{2080,,ord("x")} calls above, you can set the
@ref{15f6,,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

Você também pode usar um objeto Python chamável (uma função ou uma classe, por exemplo) como o atributo @ref{2fdf,,restype}, se a função externa retornar um inteiro. O objeto chamável será chamado com o `inteiro' que a função C retorna, e o resultado desta chamada será usado como o resultado da sua chamada de função. Isso é útil para verificar valores de retorno de erro e levantar uma exceção automaticamente:

@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} é uma função que chamará a API @code{FormatMessage()} do Windows para obter a representação em string de um código de erro, e `retorna' uma exceção.  @code{WinError} aceita um parâmetro de código de erro opcional, se nenhum for usado, ela chama @ref{2fe0,,GetLastError()} para recuperá-lo.

Por favor, repare que um mecanismo de checagem de erro muito mais poderoso está disponível através do atributo @ref{2fe1,,errcheck}; consulte o manual de referência para mais detalhes.

@node Passando ponteiros ou passando parâmetros por referência,Estruturas e uniões,Tipos de Retorno,Tutorial ctypes
@anchor{library/ctypes ctypes-passing-pointers}@anchor{2fe2}@anchor{library/ctypes passing-pointers-or-passing-parameters-by-reference}@anchor{2fe3}
@subsubsection Passando ponteiros (ou: passando parâmetros por referência)


Às vezes, uma função da API C espera um `ponteiro' para um tipo de dado como parâmetro, provavelmente para escrever no local correspondente, ou se os dados forem muito grandes para serem passados por valor. Isso também é conhecido como `passar parâmetros por referência'.

O @ref{2a,,ctypes} exporta a função @ref{2fe4,,byref()} que é usada para passar parâmetros por referência. O mesmo efeito pode ser alcançado com a função @ref{17d7,,pointer()}, embora @ref{17d7,,pointer()} faça muito mais trabalho, já que ela constrói um objeto ponteiro real, então é mais rápido usar @ref{2fe4,,byref()} se você não precisar do objeto ponteiro no próprio 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 Estruturas e uniões,Structure/union alignment and byte order,Passando ponteiros ou passando parâmetros por referência,Tutorial ctypes
@anchor{library/ctypes ctypes-structures-unions}@anchor{2fe5}@anchor{library/ctypes structures-and-unions}@anchor{2fe6}
@subsubsection Estruturas e uniões


Estruturas e uniões devem derivar das classes base @ref{1d4,,Structure} e @ref{1777,,Union} que são definidas no módulo @ref{2a,,ctypes}. Cada subclasse deve definir um atributo @ref{2fe7,,_fields_}. @code{_fields_} deve ser uma lista de `tuplas de 2 itens', contendo um `nome de campo' e um `tipo de campo'.

O tipo do campo deve ser um tipo @ref{2a,,ctypes} como @ref{2fb5,,c_int}, ou qualquer outro tipo @ref{2a,,ctypes} derivado: estrutura, união, vetor, ponteiro.

Aqui está um exemplo simples de uma estrutura POINT, que contém dois inteiros nomeados `x' e `y', e também mostra como inicializar uma estrutura no construtor:

@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

Você pode, no entanto, construir estruturas muito mais complicadas. Uma estrutura pode conter outras estruturas, usando uma estrutura como um tipo de campo.

Aqui está uma estrutura RECT que contém dois POINTs nomeados `upperleft' e `lowerright':

@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

Estruturas aninhadas também podem ser inicializadas no construtor de várias maneiras:

@example
>>> r = RECT(POINT(1, 2), POINT(3, 4))
>>> r = RECT((1, 2), (3, 4))
@end example

Field @ref{1658,,descriptor}s can be retrieved from the `class', they are useful
for debugging because they can provide useful information:

@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{2fe8}
@cartouche
@quotation Aviso 
O @ref{2a,,ctypes} não permite passar uniões ou estruturas com campos de bits para funções por valor. Embora isso possa funcionar em x86 de 32 bits, a biblioteca não garante que funcione em geral. Uniões e estruturas com campos de bits devem sempre ser passadas para funções por ponteiro.
@end quotation
@end cartouche

@node Structure/union alignment and byte order,Campos de bit em estruturas e uniões,Estruturas e uniões,Tutorial ctypes
@anchor{library/ctypes structure-union-alignment-and-byte-order}@anchor{2fe9}
@subsubsection Structure/union alignment and byte order


By default, Structure and Union fields are aligned in the same way the C
compiler does it. It is possible to override this behavior by specifying a
@ref{2fea,,_pack_} class attribute in the subclass definition.
This must be set to a positive integer and specifies the maximum alignment for the fields.
This is what @code{#pragma pack(n)} also 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{1d5,,_align_} class attribute
in the subclass definition.

@ref{2a,,ctypes} usa a ordem de bytes nativa para estruturas e uniões. Para construir estruturas com ordem de bytes não nativa, você pode usar classes base @ref{2feb,,BigEndianStructure}, @ref{2fec,,LittleEndianStructure}, @ref{1941,,BigEndianUnion} e @ref{1942,,LittleEndianUnion}. Essas classes não podem conter campos de ponteiros.

@node Campos de bit em estruturas e uniões,Vetores,Structure/union alignment and byte order,Tutorial ctypes
@anchor{library/ctypes bit-fields-in-structures-and-unions}@anchor{2fed}@anchor{library/ctypes ctypes-bit-fields-in-structures-unions}@anchor{2fee}
@subsubsection Campos de bit em estruturas e uniões


É possível criar estruturas e uniões contendo campos de bits. Campos de bits só são possíveis para campos de inteiros, a largura do bit é especificada como o terceiro item nas tuplas @ref{2fe7,,_fields_}:

@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 Vetores,Ponteiros,Campos de bit em estruturas e uniões,Tutorial ctypes
@anchor{library/ctypes arrays}@anchor{2fef}@anchor{library/ctypes ctypes-arrays}@anchor{2ff0}
@subsubsection Vetores


Vetores são sequências que contêm um número fixo de instâncias do mesmo tipo.

A maneira recomendada de criar tipos vetor é multiplicando um tipo de dado por um inteiro positivo:

@example
TenPointsArrayType = POINT * 10
@end example

Aqui está um exemplo de um tipo de dado um tanto artificial, uma estrutura contendo 4 POINTs entre outras coisas:

@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

Instâncias são criadas da maneira usual, chamando a classe:

@example
arr = TenPointsArrayType()
for pt in arr:
    print(pt.x, pt.y)
@end example

O código acima exibe uma série de linhas @code{0 0}, pois o conteúdo do vetor é inicializado com zeros.

Inicializadores do tipo correto também podem ser especificados:

@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 Ponteiros,Conversão de Tipos,Vetores,Tutorial ctypes
@anchor{library/ctypes ctypes-pointers}@anchor{2ff1}@anchor{library/ctypes pointers}@anchor{2ff2}
@subsubsection Ponteiros


Instâncias de ponteiro são criadas chamando a função @ref{17d7,,pointer()} em um tipo @ref{2a,,ctypes}:

@example
>>> from ctypes import *
>>> i = c_int(42)
>>> pi = pointer(i)
>>>
@end example

Instâncias de ponteiros têm um atributo @ref{2ff3,,contents} que retorna o objeto para qual o ponteiro aponta, o objeto @code{i} acima:

@example
>>> pi.contents
c_long(42)
>>>
@end example

Note que o @ref{2a,,ctypes} não possui OOR (retorno de objeto original), ele constrói um objeto novo e equivalente cada vez que você recupera um atributo:

@example
>>> pi.contents is i
False
>>> pi.contents is pi.contents
False
>>>
@end example

Atribuir outra instância @ref{2fb5,,c_int} ao atributo do conteúdo do ponteiro faria com que o ponteiro apontasse para o local de memória onde ela está armazenada:

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

Instâncias de ponteiro também podem ser indexadas com inteiros:

@example
>>> pi[0]
99
>>>
@end example

Atribuir a um índice inteiro altera o valor apontado:

@example
>>> print(i)
c_long(99)
>>> pi[0] = 22
>>> print(i)
c_long(22)
>>>
@end example

Também é possível usar índices diferentes de 0, mas você deve saber o que está fazendo, assim como em C: Você pode acessar ou alterar locais arbitrários da memória. Geralmente, você só usa este recurso se receber um ponteiro de uma função C, e você `sabe' que o ponteiro na verdade aponta para um vetor em vez de um único item.

Nos bastidores, a função @ref{17d7,,pointer()} faz mais do que simplesmente criar instâncias de ponteiro, ela precisa criar `tipos' de ponteiro primeiro. Isso é feito com a função @ref{17d8,,POINTER()}, que aceita qualquer tipo @ref{2a,,ctypes}, e retorna um novo 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

Chamar o tipo ponteiro sem um argumento cria um ponteiro @code{NULL}. Ponteiros @code{NULL} possuem o valor booleano @code{False}:

@example
>>> null_ptr = POINTER(c_int)()
>>> print(bool(null_ptr))
False
>>>
@end example

O @ref{2a,,ctypes} verifica por @code{NULL} ao desreferenciar ponteiros (mas desreferenciar ponteiros inválidos que não sejam @code{NULL} travaria o 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 Conversão de Tipos,Tipos Incompletos,Ponteiros,Tutorial ctypes
@anchor{library/ctypes ctypes-type-conversions}@anchor{2ff4}@anchor{library/ctypes type-conversions}@anchor{2ff5}
@subsubsection Conversão de Tipos


Normalmente, o ctypes faz uma verificação de tipos estrita. Isso significa que, se você tiver @code{POINTER(c_int)} na lista @ref{15f6,,argtypes} de uma função ou como o tipo de um campo membro em uma definição de estrutura, apenas instâncias de exatamente o mesmo tipo são aceitas. Existem algumas exceções a esta regra, onde o ctypes aceita outros objetos. Por exemplo, você pode passar instâncias de vetor compatíveis em vez de tipos de ponteiro. Assim, para @code{POINTER(c_int)}, o ctypes aceita um vetor de 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

Além disso, se um argumento de função for explicitamente declarado como um tipo ponteiro (como @code{POINTER(c_int)}) em @ref{15f6,,argtypes}, um objeto do tipo apontado (@code{c_int} neste caso) pode ser passado para a função. O ctypes aplicará a conversão @ref{2fe4,,byref()} necessária neste caso automaticamente.

Para definir um campo do tipo PONTEIRO como @code{NULL}, você pode atribuir @code{None}:

@example
>>> bar.values = None
>>>
@end example

@c XXX list other conversions...

Às vezes, você tem instâncias de tipos incompatíveis. Em C, você pode converter um tipo em outro tipo. O @ref{2a,,ctypes} fornece uma função @ref{2ff6,,cast()} que pode ser usada da mesma maneira. A estrutura @code{Bar} definida acima aceita ponteiros @code{POINTER(c_int)} ou vetores @ref{2fb5,,c_int} para seu campo @code{values}, mas não instâncias de outros 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 esses casos, a função @ref{2ff6,,cast()} é útil.

A função @ref{2ff6,,cast()} pode ser usada para converter uma instância ctypes em um ponteiro para um diferente tipo de dado ctypes. @ref{2ff6,,cast()} recebe dois parâmetros, um objeto ctypes que é ou pode ser convertido para um ponteiro de algum tipo, e um tipo ponteiro ctypes. Ela retorna uma instância do segundo argumento, que referencia o mesmo bloco de memória que o primeiro argumento:

@example
>>> a = (c_byte * 4)()
>>> cast(a, POINTER(c_int))
<ctypes.LP_c_long object at ...>
>>>
@end example

Então, @ref{2ff6,,cast()} pode ser usada para atribuir ao campo @code{values} da estrutura @code{Bar}:

@example
>>> bar = Bar()
>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
>>> print(bar.values[0])
0
>>>
@end example

@node Tipos Incompletos,Funções Callbacks,Conversão de Tipos,Tutorial ctypes
@anchor{library/ctypes ctypes-incomplete-types}@anchor{2ff7}@anchor{library/ctypes incomplete-types}@anchor{2ff8}
@subsubsection Tipos Incompletos


`Tipos Incompletos' são estruturas, uniões ou vetores, cujos membros ainda não foram especificados. Em C, eles são especificados por declarações antecipadas, que são definidas posteriormente:

@example
struct cell; /* forward declaration */

struct cell @{
    char *name;
    struct cell *next;
@};
@end example

A tradução direta para código ctypes seria esta, mas não 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

por que a nova @code{class cell} não está disponível na própria declaração da classe. Em @ref{2a,,ctypes}, podemos definir a classe @code{cell} e definir o atributo @ref{2fe7,,_fields_} posteriormente, após a declaração da classe:

@example
>>> from ctypes import *
>>> class cell(Structure):
...     pass
...
>>> cell._fields_ = [("name", c_char_p),
...                  ("next", POINTER(cell))]
>>>
@end example

Vamos tentar. Criamos duas instâncias de @code{cell}, e deixamos que elas apontem uma para a outra, e finalmente seguimos a cadeia de ponteiros algumas vezes:

@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 Funções Callbacks,Acessando valores exportados de dlls,Tipos Incompletos,Tutorial ctypes
@anchor{library/ctypes callback-functions}@anchor{2ff9}@anchor{library/ctypes ctypes-callback-functions}@anchor{2ffa}
@subsubsection Funções Callbacks


@ref{2a,,ctypes} permite criar ponteiros de função C chamáveis a partir de chamáveis Python. Estas são às vezes chamadas de `funções de retorno'.

Primeiro, você deve criar uma classe para função de retorno. A classe sabe a convenção de chamada , o tipo de retorno, e o número e tipos de argumentos que essa função irá receber.

A função de fábrica @ref{2ffb,,CFUNCTYPE()} cria tipos para funções de retorno usando a convenção de chamada @code{cdecl}. No Windows, a função de fábrica @ref{2ffc,,WINFUNCTYPE()} cria tipos para funções de retorno usando a convenção de chamada @code{stdcall}.

Ambas estas funções de fábrica são chamadas com o tipo de resultado como primeiro argumento, e os tipos de argumento esperados da função de retorno como os 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

A @code{qsort()} deve ser chamada com um ponteiro para os dados a serem ordenados, o número de itens no vetor de dados, o tamanho de um item, e um ponteiro para a função de comparação, a função de retorno (callback). A função de retorno será então chamada com dois ponteiros para itens, e ela deve retornar um inteiro negativo se o primeiro item for menor que o segundo, um zero se eles forem iguais, e um inteiro positivo caso contrário.

Então, nossa função de retorno (callback function) recebe ponteiros para inteiros, e deve retornar um inteiro. Primeiro criamos o @code{type} para a função de retorno:

@example
>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
>>>
@end example

Para começar, aqui está uma função de retorno (callback) simples que mostra os valores que lhe são passados:

@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

O 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

Agora podemos realmente comparar os dois itens e retornar um 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 verificar facilmente, nosso vetor está ordenado agora:

@example
>>> for i in ia: print(i, end=" ")
...
1 5 7 33 99
>>>
@end example

As fábricas de funções podem ser usadas como fábricas de decoradores, então também podemos escrever:

@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 
Certifique-se de manter referências aos objetos @ref{2ffb,,CFUNCTYPE()} enquanto eles forem usados a partir do código C. O @ref{2a,,ctypes} não faz isso, e se você não o fizer, eles podem ser coletados pelo coletor de lixo, travando seu programa quando uma função de retorno é chamada.

Além disso, note que se a função de retorno for chamada em uma thread criada fora do controle do Python (por exemplo, pelo código externo que chama a função de retorno), o ctypes cria uma nova thread Python “dummy” (fictícia) em cada invocação. Este comportamento é correto para a maioria dos propósitos, mas significa que os valores armazenados com @ref{1631,,threading.local} `não' sobreviverão entre diferentes funções de retorno, mesmo quando essas chamadas são feitas a partir da mesma thread C.
@end quotation
@end cartouche

@node Acessando valores exportados de dlls,Surpresas,Funções Callbacks,Tutorial ctypes
@anchor{library/ctypes accessing-values-exported-from-dlls}@anchor{2ffd}@anchor{library/ctypes ctypes-accessing-values-exported-from-dlls}@anchor{2ffe}
@subsubsection Acessando valores exportados de dlls


Algumas bibliotecas compartilhadas não exportam apenas funções, elas também exportam variáveis. Um exemplo na própria biblioteca Python é a @ref{756,,Py_Version}, o número da versão de tempo de execução do Python codificado em um único inteiro constante.

@ref{2a,,ctypes} pode acessar valores como este com os métodos de classe @ref{2fff,,in_dll()} do tipo. `pythonapi' é um símbolo predefinido que dá acesso à API C do Python:

@example
>>> version = ctypes.c_int.in_dll(ctypes.pythonapi, "Py_Version")
>>> print(hex(version.value))
0x30c00a0
@end example

Um exemplo estendido que também demonstra o uso de ponteiros acessa o ponteiro @ref{3000,,PyImport_FrozenModules} exportado pelo Python.

Citando a documentação para esse valor:

@quotation

Este ponteiro é inicializado para apontar para um vetor de registros de @ref{775,,_frozen}, terminado por um cujos membros são todos @code{NULL} ou zero. Quando um módulo congelado é importado, ele é pesquisado nesta tabela. O código de terceiros pode fazer truques com isso para fornecer uma coleção criada dinamicamente de módulos congelados.
@end quotation

Então, manipular este ponteiro pode até ser útil. Para restringir o tamanho do exemplo, mostramos apenas como esta tabela pode ser lida com @ref{2a,,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

Nós definimos tipo de dado @ref{775,,_frozen}, para que possamos obter o ponteiro para a tabela:

@example
>>> FrozenTable = POINTER(struct_frozen)
>>> table = FrozenTable.in_dll(pythonapi, "_PyImport_FrozenBootstrap")
>>>
@end example

Como @code{table} é um @code{pointer} para o vetor de registros @code{struct_frozen}, nós podemos iterar sobre ele, mas só temos que nos certificar de que nosso loop termine, porque ponteiros não têm tamanho. Cedo ou tarde, ele provavelmente travaria com uma violação de acesso ou algo assim, então é melhor sair do loop quando atingirmos a 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

O fato de que o Python padrão tem um módulo congelado e um pacote congelado (indicado pelo membro @code{size} negativo) não é bem conhecido, é usado apenas para testes. Experimente com @code{import __hello__} por exemplo.

@node Surpresas,Tipos de dados de tamanho variável,Acessando valores exportados de dlls,Tutorial ctypes
@anchor{library/ctypes ctypes-surprises}@anchor{3001}@anchor{library/ctypes surprises}@anchor{3002}
@subsubsection Surpresas


Existem algumas pontos limites no @ref{2a,,ctypes} onde você pode esperar algo diferente do que realmente ocorre.

Considere o exemplo a seguir:

@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. Nós com certeza esperávamos que a última instrução exibisse @code{3 4 1 2}. O que aconteceu? Aqui estão os passos da linha @code{rc.a, rc.b = rc.b, rc.a} acima:

@example
>>> temp0, temp1 = rc.b, rc.a
>>> rc.a = temp0
>>> rc.b = temp1
>>>
@end example

Observe que @code{temp0} e @code{temp1} ainda são objetos que utilizam o buffer interno do objeto @code{rc} acima. Portanto, executar @code{rc.a = temp0} copia o conteúdo do buffer de @code{temp0} para o buffer de @code{rc}. Isso, por sua vez, altera o conteúdo de @code{temp1}. Assim, a última atribuição @code{rc.b = temp1} não produz o efeito esperado.

Tenha em mente que obter sub-objetos de estruturas, uniões e vetores não copia o sub-objeto; em vez disso, recupera um objeto de encapsulamento (wrapper) que acessa o buffer subjacente do objeto raiz.

Outro exemplo que pode se comportar de maneira diferente do que alguém poderia esperar é o seguinte:

@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 
Objetos instanciados a partir de @ref{17d9,,c_char_p} só podem ter seu valor definido para bytes ou inteiros.
@end quotation
@end cartouche

Por que está imprimindo @code{False}? Instâncias de ctypes são objetos que contêm um bloco de memória, além de alguns @ref{1658,,descriptor}s que acessam o conteúdo dessa memória. Armazenar um objeto Python no bloco de memória não armazena o próprio objeto; em vez disso, armazena-se o seu atributo @code{contents}. Acessar o contents novamente constrói um novo objeto Python a cada vez!

@node Tipos de dados de tamanho variável,,Surpresas,Tutorial ctypes
@anchor{library/ctypes ctypes-variable-sized-data-types}@anchor{3003}@anchor{library/ctypes variable-sized-data-types}@anchor{3004}
@subsubsection Tipos de dados de tamanho variável


O @ref{2a,,ctypes} fornece algum suporte para vetores e estruturas de tamanhos variável.

A função @ref{3005,,resize()} pode ser usada para redimensionar o buffer de memória de um objeto ctypes existente. A função recebe o objeto como primeiro argumento, e o tamanho solicitado em bytes como o segundo argumento. O bloco de memória não pode ser tornado menor do que o bloco de memória natural especificado pelo tipo do objeto, um @ref{202,,ValueError} é levantado se isso for tentado:

@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

Isso é bom e funcional, mas como alguém acessaria os elementos contidos neste vetor? Já que o tipo ainda sabe apenas sobre 4 elementos, obtemos erros ao acessar outros elementos:

@example
>>> short_array[:]
[0, 0, 0, 0]
>>> short_array[7]
Traceback (most recent call last):
    ...
IndexError: invalid index
>>>
@end example

Outra maneira de usar tipos de dados de tamanho variável com o @ref{2a,,ctypes} é usar a natureza dinâmica do Python, e (re)definir o tipo de dados  depois que o tamanho necessário já for conhecido, caso a caso.

@node Referência ctypes,,Tutorial ctypes,ctypes — Uma biblioteca de funções externas para Python
@anchor{library/ctypes ctypes-ctypes-reference}@anchor{3006}@anchor{library/ctypes ctypes-reference}@anchor{3007}
@subsubsection Referência ctypes


@menu
* Encontrando bibliotecas compartilhadas:: 
* Loading shared libraries:: 
* Foreign functions:: 
* Function prototypes:: 
* Funções utilitárias:: 
* Data types:: 
* Tipos de dados fundamentais: Tipos de dados fundamentais<2>. 
* Tipos de dados estruturados:: 
* Arrays and pointers:: 

@end menu

@node Encontrando bibliotecas compartilhadas,Loading shared libraries,,Referência ctypes
@anchor{library/ctypes ctypes-finding-shared-libraries}@anchor{3008}@anchor{library/ctypes finding-shared-libraries}@anchor{3009}
@subsubsection Encontrando bibliotecas compartilhadas


Ao programar em uma linguagem compilada, bibliotecas compartilhadas são acessadas ao compilar/linkar (compiling/linking) um programa, e quando o programa é executado.

O propósito da função @ref{d6c,,find_library()} é localizar uma biblioteca de forma semelhante ao que o compilador ou o carregador de tempo de execução (runtime loader) faz (em plataformas com várias versões de uma biblioteca compartilhada, a mais recente deve ser carregada), enquanto os carregadores de biblioteca do ctypes agem como quando um programa é executado, e chamam o carregador de tempo de execução diretamente.

O módulo @code{ctypes.util} fornece uma função que pode ajudar a determinar a biblioteca a ser carregada.


@deffn {Dado} ctypes.util.find_library (name)

Try to find a library and return a pathname.  `name' is the library name without
any prefix like `lib', suffix like @code{.so}, @code{.dylib} or version number (this
is the form used for the posix linker option @code{-l}).  If no library can
be found, returns @code{None}.
@end deffn

The exact functionality is system dependent.

On Linux, @ref{d6c,,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.

Note that if the output of these programs does not correspond to the dynamic
linker used by Python, the result of this function may be misleading.


Alterado na versão 3.6: On Linux, the value of the environment variable @code{LD_LIBRARY_PATH} is used
when searching for libraries, if a library cannot be found by any other means.


Veja alguns exemplos:

@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{d6c,,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{d6c,,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{2a,,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{d6c,,find_library()} to locate the library at runtime.

@node Loading shared libraries,Foreign functions,Encontrando bibliotecas compartilhadas,Referência ctypes
@anchor{library/ctypes ctypes-loading-shared-libraries}@anchor{300a}@anchor{library/ctypes loading-shared-libraries}@anchor{300b}
@subsubsection Loading shared libraries


There are several ways to load shared libraries into the Python process.  One
way is to instantiate one of the following classes:

@geindex CDLL (classe em ctypes)
@anchor{library/ctypes ctypes CDLL}@anchor{9f1}
@deffn {Classe} ctypes.CDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Instances of this class represent loaded shared libraries. Functions in these
libraries use the standard C calling convention, and are assumed to return
int.

On Windows creating a @ref{9f1,,CDLL} instance may fail even if the DLL name
exists. When a dependent DLL of the loaded DLL is not found, a
@ref{417,,OSError} error is raised with the message `“[WinError 126] The
specified module could not be found”.' This error message does not contain
the name of the missing DLL because the Windows API does not return this
information making this error hard to diagnose. To resolve this error and
determine which DLL is not found, you need to find the list of dependent
DLLs and determine which one is not found using Windows debugging and
tracing tools.


Alterado na versão 3.12: The `name' parameter can now be a @ref{2a0,,path-like object}.

@end deffn


@subsubheading Ver também


Microsoft DUMPBIN tool@footnote{https://docs.microsoft.com/cpp/build/reference/dependents}
– A tool to find DLL dependents.


@geindex OleDLL (classe em ctypes)
@anchor{library/ctypes ctypes OleDLL}@anchor{186a}
@deffn {Classe} ctypes.OleDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Instâncias desta classe representam bibliotecas compartilhadas carregadas, funções nessas bibliotecas usam a convenção de chamada @code{stdcall} e é presumido que retornam o código @ref{300c,,HRESULT} específico do Windows. Valores @ref{300c,,HRESULT} contêm informações especificando se a chamada da função falhou ou foi bem-sucedida, juntamente com um código de erro adicional. Se o valor de retorno sinalizar uma falha, um @ref{417,,OSError} é automaticamente levantado.

@ref{1ed8,,Disponibilidade}: Windows


Alterado na versão 3.3: Costumava-se levantar @ref{108d,,WindowsError}, que agora é um apelido de @ref{417,,OSError}.



Alterado na versão 3.12: The `name' parameter can now be a @ref{2a0,,path-like object}.

@end deffn

@geindex WinDLL (classe em ctypes)
@anchor{library/ctypes ctypes WinDLL}@anchor{186b}
@deffn {Classe} ctypes.WinDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Instâncias desta classe representam bibliotecas compartilhadas carregadas, as funções nessa biblioteca usam a convenção de chamada @code{stdcall} e, por padrão, é presumido que retornam int.

@ref{1ed8,,Disponibilidade}: Windows


Alterado na versão 3.12: The `name' parameter can now be a @ref{2a0,,path-like object}.

@end deffn

The Python @ref{148,,global interpreter lock} is released before calling any
function exported by these libraries, and reacquired afterwards.

@geindex PyDLL (classe em ctypes)
@anchor{library/ctypes ctypes PyDLL}@anchor{186c}
@deffn {Classe} ctypes.PyDLL (name, mode=DEFAULT_MODE, handle=None)

Instâncias desta classe se comportam como instâncias @ref{9f1,,CDLL}, exceto que o GIL do Python `não' é liberado durante a chamada da função e, após a execução da função, o sinalizador de erro do Python é verificado. Se o sinalizador de erro estiver definido, uma exceção Python é levantada.

Portanto, isso só é útil para chamar funções da api C do Python diretamente.


Alterado na versão 3.12: The `name' parameter can now be a @ref{2a0,,path-like object}.

@end deffn

Todas essas classes podem ser instanciadas chamando-as com pelo menos um argumento, o nome do caminho da biblioteca compartilhada. Se você tiver um identificador existente para uma biblioteca compartilhada já carregada, ele pode ser passado como o parâmetro nomeado @code{handle}. Caso contrário, a função @code{dlopen()} ou @code{LoadLibrary()} da plataforma subjacente é usada para carregar a biblioteca no processo e para obter um identificador para ela.

O parâmetro `mode' pode ser utilizado para especificar como a biblioteca é carregada. Para detalhes, consulte a página de manual @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}}. No Windows, `mode' é ignorado. Em sistemas posix, RTLD_NOW é sempre adicionado e, não é configurável.

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{2a,,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.

The function @ref{300d,,ctypes.get_errno()} returns the value of the ctypes private
copy, and the function @ref{300e,,ctypes.set_errno()} changes the ctypes private copy
to a new value and returns the former value.

The `use_last_error' parameter, when set to true, enables the same mechanism for
the Windows error code which is managed by the @ref{2fe0,,GetLastError()} and
@code{SetLastError()} Windows API functions; @ref{300f,,ctypes.get_last_error()} and
@ref{3010,,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.


Alterado na versão 3.8: Added `winmode' parameter.



@deffn {Dado} ctypes.RTLD_GLOBAL

Flag to use as `mode' parameter.  On platforms where this flag is not available,
it is defined as the integer zero.
@end deffn


@deffn {Dado} ctypes.RTLD_LOCAL

Flag to use as `mode' parameter.  On platforms where this is not available, it
is the same as `RTLD_GLOBAL'.
@end deffn


@deffn {Dado} ctypes.DEFAULT_MODE

The default mode which is used to load shared libraries.  On OSX 10.3, this is
`RTLD_GLOBAL', otherwise it is the same as `RTLD_LOCAL'.
@end deffn

Instances of these classes have no public methods.  Functions exported by the
shared library can be accessed as attributes or by index.  Please note that
accessing the function through an attribute caches the result and therefore
accessing it repeatedly returns the same object each time.  On the other hand,
accessing it through an index returns a new object each time:

@example
>>> from ctypes import CDLL
>>> libc = CDLL("libc.so.6")  # On Linux
>>> libc.time == libc.time
True
>>> libc['time'] == libc['time']
False
@end example

The following public attributes are available, their name starts with an
underscore to not clash with exported function names:

@geindex _handle (atributo ctypes.PyDLL)
@anchor{library/ctypes ctypes PyDLL _handle}@anchor{3011}
@deffn {Atributo} PyDLL._handle

The system handle used to access the library.
@end deffn

@geindex _name (atributo ctypes.PyDLL)
@anchor{library/ctypes ctypes PyDLL _name}@anchor{3012}
@deffn {Atributo} PyDLL._name

The name of the library passed in the constructor.
@end deffn

Shared libraries can also be loaded by using one of the prefabricated objects,
which are instances of the @ref{3013,,LibraryLoader} class, either by calling the
@ref{2fb9,,LoadLibrary()} method, or by retrieving the library as
attribute of the loader instance.

@geindex LibraryLoader (classe em ctypes)
@anchor{library/ctypes ctypes LibraryLoader}@anchor{3013}
@deffn {Classe} ctypes.LibraryLoader (dlltype)

Class which loads shared libraries.  `dlltype' should be one of the
@ref{9f1,,CDLL}, @ref{186c,,PyDLL}, @ref{186b,,WinDLL}, or @ref{186a,,OleDLL} types.

@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 ctypes.LibraryLoader)
@anchor{library/ctypes ctypes LibraryLoader LoadLibrary}@anchor{2fb9}
@deffn {Método} LoadLibrary (name)

Load a shared library into the process and return it.  This method always
returns a new instance of the library.
@end deffn
@end deffn

These prefabricated library loaders are available:


@deffn {Dado} ctypes.cdll

Creates @ref{9f1,,CDLL} instances.
@end deffn


@deffn {Dado} ctypes.windll

Creates @ref{186b,,WinDLL} instances.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn


@deffn {Dado} ctypes.oledll

Creates @ref{186a,,OleDLL} instances.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn


@deffn {Dado} ctypes.pydll

Creates @ref{186c,,PyDLL} instances.
@end deffn

For accessing the C Python api directly, a ready-to-use Python shared library
object is available:


@deffn {Dado} ctypes.pythonapi

An instance of @ref{186c,,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

Carregar uma biblioteca através de qualquer um desses objetos levanta um @ref{19fa,,evento de auditoria} @code{ctypes.dlopen} com o argumento string @code{name}, o nome usado para carregar a biblioteca.


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



In cases when only the library handle is available rather than the object,
accessing a function raises an auditing event @code{ctypes.dlsym/handle} with
arguments @code{handle} (the raw library handle) and @code{name}.


@node Foreign functions,Function prototypes,Loading shared libraries,Referência ctypes
@anchor{library/ctypes ctypes-foreign-functions}@anchor{3014}@anchor{library/ctypes foreign-functions}@anchor{3015}
@subsubsection Foreign functions


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{3016,,_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 (classe em ctypes)
@anchor{library/ctypes ctypes _CFuncPtr}@anchor{3016}
@deffn {Classe} ctypes._CFuncPtr

Base class for C callable foreign functions.

Instances of foreign functions are also C compatible data types; they
represent C function pointers.

This behavior can be customized by assigning to special attributes of the
foreign function object.

@geindex restype (atributo ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr restype}@anchor{2fdf}
@deffn {Atributo} restype

Assign a ctypes type to specify the result type of the foreign function.
Use @code{None} for void, a function not returning anything.

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{2fe1,,errcheck} attribute.
@end deffn

@geindex argtypes (atributo ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr argtypes}@anchor{15f6}
@deffn {Atributo} argtypes

Assign a tuple of ctypes types to specify the argument types that the
function accepts.  Functions using the @code{stdcall} calling convention can
only be called with the same number of arguments as the length of this
tuple; functions using the C calling convention accept additional,
unspecified arguments as well.

When a foreign function is called, each actual argument is passed to the
@ref{2fdc,,from_param()} class method of the items in the @ref{15f6,,argtypes}
tuple, this method allows adapting the actual argument to an object that
the foreign function accepts.  For example, a @ref{17d9,,c_char_p} item in
the @ref{15f6,,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{2fdc,,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 ctypes._CFuncPtr)
@anchor{library/ctypes ctypes _CFuncPtr errcheck}@anchor{2fe1}
@deffn {Atributo} errcheck

Assign a Python function or another callable to this attribute. The
callable will be called with three or more arguments:


@deffn {Função} callable (result, func, arguments)

`result' is what the foreign function returns, as specified by the
@code{restype} attribute.

`func' is the foreign function object itself, this allows reusing the
same callable object to check or post process the results of several
functions.

`arguments' is a tuple containing the parameters originally passed to
the function call, this allows specializing the behavior on the
arguments used.
@end deffn

The object that this function returns will be returned from the
foreign function call, but it can also check the result value
and raise an exception if the foreign function call failed.
@end deffn
@end deffn

@geindex ArgumentError
@anchor{library/ctypes ctypes ArgumentError}@anchor{3017}
@deffn {Exceção} ctypes.ArgumentError

This exception is raised when a foreign function call cannot convert one of the
passed arguments.
@end deffn


On Windows, when a foreign function call raises a system exception (for
example, due to an access violation), it will be captured and replaced with
a suitable Python exception. Further, an auditing event
@code{ctypes.set_exception} with argument @code{code} will be raised, allowing an
audit hook to replace the exception with its own.



Some ways to invoke foreign function calls may raise an auditing event
@code{ctypes.call_function} with arguments @code{function pointer} and @code{arguments}.


@node Function prototypes,Funções utilitárias,Foreign functions,Referência ctypes
@anchor{library/ctypes ctypes-function-prototypes}@anchor{3018}@anchor{library/ctypes function-prototypes}@anchor{3019}
@subsubsection Function prototypes


Foreign functions can also be created by instantiating function prototypes.
Function prototypes are similar to function prototypes in C; they describe a
function (return type, argument types, calling convention) without defining an
implementation.  The factory functions must be called with the desired result
type and the argument types of the function, and can be used as decorator
factories, and as such, be applied to functions through the @code{@@wrapper} syntax.
See @ref{2ffa,,Funções Callbacks} for examples.

@geindex CFUNCTYPE() (no módulo ctypes)
@anchor{library/ctypes ctypes CFUNCTYPE}@anchor{2ffb}
@deffn {Função} ctypes.CFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

The returned function prototype creates functions that use the standard C
calling convention.  The function will release the GIL during the call.  If
`use_errno' is set to true, the ctypes private copy of the system
@ref{57,,errno} variable is exchanged with the real @ref{57,,errno} value before
and after the call; `use_last_error' does the same for the Windows error
code.
@end deffn

@geindex WINFUNCTYPE() (no módulo ctypes)
@anchor{library/ctypes ctypes WINFUNCTYPE}@anchor{2ffc}
@deffn {Função} ctypes.WINFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

The returned function prototype creates functions that use the
@code{stdcall} calling convention.  The function will
release the GIL during the call.  `use_errno' and `use_last_error' have the
same meaning as above.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex PYFUNCTYPE() (no módulo ctypes)
@anchor{library/ctypes ctypes PYFUNCTYPE}@anchor{301a}
@deffn {Função} ctypes.PYFUNCTYPE (restype, *argtypes)

The returned function prototype creates functions that use the Python calling
convention.  The function will `not' release the GIL during the call.
@end deffn

Function prototypes created by these factory functions can be instantiated in
different ways, depending on the type and number of the parameters in the call:


@deffn {Função} prototype (address)

Returns a foreign function at the specified address which must be an integer.
@end deffn


@deffn {Função} prototype (callable)

Create a C callable function (a callback function) from a Python `callable'.
@end deffn


@deffn {Função} prototype (func_spec[, paramflags])

Returns a foreign function exported by a shared library. `func_spec' must
be a 2-tuple @code{(name_or_ordinal, library)}. The first item is the name of
the exported function as string, or the ordinal of the exported function
as small integer.  The second item is the shared library instance.
@end deffn


@deffn {Função} prototype (vtbl_index, name[, paramflags[, iid]])

Returns a foreign function that will call a COM method. `vtbl_index' is
the index into the virtual function table, a small non-negative
integer. `name' is name of the COM method. `iid' is an optional pointer to
the interface identifier which is used in extended error reporting.

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

The optional `paramflags' parameter creates foreign function wrappers with much
more functionality than the features described above.

`paramflags' must be a tuple of the same length as @ref{15f6,,argtypes}.

Each item in this tuple contains further information about a parameter, it must
be a tuple containing one, two, or three items.

The first item is an integer containing a combination of direction
flags for the parameter:

@quotation


@table @asis

@item 1

Specifies an input parameter to the function.

@item 2

Output parameter.  The foreign function fills in a value.

@item 4

Input parameter which defaults to the integer zero.
@end table
@end quotation

The optional second item is the parameter name as string.  If this is specified,
the foreign function can be called with named parameters.

The optional third item is the default value for this parameter.

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

Here is the wrapping with @ref{2a,,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

The @code{MessageBox} foreign function can now be called in these ways:

@example
>>> MessageBox()
>>> MessageBox(text="Spam, spam, spam")
>>> MessageBox(flags=2, text="foo bar")
@end example

A second example demonstrates output parameters.  The win32 @code{GetWindowRect}
function retrieves the dimensions of a specified window by copying them into
@code{RECT} structure that the caller has to supply.  Here is the C declaration:

@example
WINUSERAPI BOOL WINAPI
GetWindowRect(
     HWND hWnd,
     LPRECT lpRect);
@end example

Here is the wrapping with @ref{2a,,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

Functions with output parameters will automatically return the output parameter
value if there is a single one, or a tuple containing the output parameter
values when there are more than one, so the GetWindowRect function now returns a
RECT instance, when called.

Output parameters can be combined with the @ref{2fe1,,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{2fe1,,errcheck} function returns the argument tuple it receives
unchanged, @ref{2a,,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 Funções utilitárias,Data types,Function prototypes,Referência ctypes
@anchor{library/ctypes ctypes-utility-functions}@anchor{301b}@anchor{library/ctypes utility-functions}@anchor{301c}
@subsubsection Funções utilitárias


@geindex addressof() (no módulo ctypes)
@anchor{library/ctypes ctypes addressof}@anchor{301d}
@deffn {Função} ctypes.addressof (obj)

Returns the address of the memory buffer as integer.  `obj' must be an
instance of a ctypes type.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.addressof} com o argumento @code{obj}.
@end deffn

@geindex alignment() (no módulo ctypes)
@anchor{library/ctypes ctypes alignment}@anchor{301e}
@deffn {Função} ctypes.alignment (obj_or_type)

Returns the alignment requirements of a ctypes type. `obj_or_type' must be a
ctypes type or instance.
@end deffn

@geindex byref() (no módulo ctypes)
@anchor{library/ctypes ctypes byref}@anchor{2fe4}
@deffn {Função} ctypes.byref (obj[, offset])

Returns a light-weight pointer to `obj', which must be an instance of a
ctypes type.  `offset' defaults to zero, and must be an integer that will be
added to the internal pointer value.

@code{byref(obj, offset)} corresponds to this C code:

@example
(((char *)&obj) + offset)
@end example

The returned object can only be used as a foreign function call parameter.
It behaves similar to @code{pointer(obj)}, but the construction is a lot faster.
@end deffn

@geindex cast() (no módulo ctypes)
@anchor{library/ctypes ctypes cast}@anchor{2ff6}
@deffn {Função} ctypes.cast (obj, type)

This function is similar to the cast operator in C. It returns a new instance
of `type' which points to the same memory block as `obj'.  `type' must be a
pointer type, and `obj' must be an object that can be interpreted as a
pointer.
@end deffn

@geindex create_string_buffer() (no módulo ctypes)
@anchor{library/ctypes ctypes create_string_buffer}@anchor{2fd3}
@deffn {Função} ctypes.create_string_buffer (init, size=None)

@deffnx {Função} ctypes.create_string_buffer (size)

This function creates a mutable character buffer. The returned object is a
ctypes array of @ref{2fc1,,c_char}.

If `size' is given (and not @code{None}), it must be an @ref{257,,int}.
It specifies the size of the returned array.

If the `init' argument is given, it must be @ref{1c2,,bytes}. It is used
to initialize the array items. Bytes not initialized this way are
set to zero (NUL).

If `size' is not given (or if it is @code{None}), the buffer is made one element
larger than `init', effectively adding a NUL terminator.

If both arguments are given, `size' must not be less than @code{len(init)}.

@cartouche
@quotation Aviso 
If `size' is equal to @code{len(init)}, a NUL terminator is
not added. Do not treat such a buffer as a C string.
@end quotation
@end cartouche

Por exemplo:

@example
>>> bytes(create_string_buffer(2))
b'\x00\x00'
>>> bytes(create_string_buffer(b'ab'))
b'ab\x00'
>>> bytes(create_string_buffer(b'ab', 2))
b'ab'
>>> bytes(create_string_buffer(b'ab', 4))
b'ab\x00\x00'
>>> bytes(create_string_buffer(b'abcdef', 2))
Traceback (most recent call last):
   ...
ValueError: byte string too long
@end example

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.create_string_buffer} com os argumentos @code{init}, @code{size}.
@end deffn

@geindex create_unicode_buffer() (no módulo ctypes)
@anchor{library/ctypes ctypes create_unicode_buffer}@anchor{1b46}
@deffn {Função} ctypes.create_unicode_buffer (init, size=None)

@deffnx {Função} ctypes.create_unicode_buffer (size)

This function creates a mutable unicode character buffer. The returned object is
a ctypes array of @ref{2fc2,,c_wchar}.

The function takes the same arguments as @ref{2fd3,,create_string_buffer()} except
`init' must be a string and `size' counts @ref{2fc2,,c_wchar}.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.create_unicode_buffer} com os argumentos @code{init}, @code{size}.
@end deffn

@geindex DllCanUnloadNow() (no módulo ctypes)
@anchor{library/ctypes ctypes DllCanUnloadNow}@anchor{301f}
@deffn {Função} ctypes.DllCanUnloadNow ()

This function is a hook which allows implementing in-process
COM servers with ctypes.  It is called from the DllCanUnloadNow function that
the _ctypes extension dll exports.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex DllGetClassObject() (no módulo ctypes)
@anchor{library/ctypes ctypes DllGetClassObject}@anchor{3020}
@deffn {Função} ctypes.DllGetClassObject ()

This function is a hook which allows implementing in-process
COM servers with ctypes.  It is called from the DllGetClassObject function
that the @code{_ctypes} extension dll exports.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex find_library() (no módulo ctypes.util)
@anchor{library/ctypes ctypes util find_library}@anchor{d6c}
@deffn {Função} ctypes.util.find_library (name)

Try to find a library and return a pathname.  `name' is the library name
without any prefix like @code{lib}, suffix like @code{.so}, @code{.dylib} or version
number (this is the form used for the posix linker option @code{-l}).  If
no library can be found, returns @code{None}.

The exact functionality is system dependent.

See @ref{3008,,Encontrando bibliotecas compartilhadas} for complete documentation.
@end deffn

@geindex find_msvcrt() (no módulo ctypes.util)
@anchor{library/ctypes ctypes util find_msvcrt}@anchor{3021}
@deffn {Função} ctypes.util.find_msvcrt ()

Returns the filename of the VC runtime library used by Python,
and by the extension modules.  If the name of the library cannot be
determined, @code{None} is returned.

If you need to free memory, for example, allocated by an extension module
with a call to the @code{free(void *)}, it is important that you use the
function in the same library that allocated the memory.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex FormatError() (no módulo ctypes)
@anchor{library/ctypes ctypes FormatError}@anchor{3022}
@deffn {Função} ctypes.FormatError ([code])

Returns a textual description of the error code `code'.  If no
error code is specified, the last error code is used by calling the Windows
api function GetLastError.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex GetLastError() (no módulo ctypes)
@anchor{library/ctypes ctypes GetLastError}@anchor{2fe0}
@deffn {Função} ctypes.GetLastError ()

Returns the last error code set by Windows in the calling thread.
This function calls the Windows @code{GetLastError()} function directly,
it does not return the ctypes-private copy of the error code.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex get_errno() (no módulo ctypes)
@anchor{library/ctypes ctypes get_errno}@anchor{300d}
@deffn {Função} ctypes.get_errno ()

Returns the current value of the ctypes-private copy of the system
@ref{57,,errno} variable in the calling thread.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.get_errno} sem argumentos.
@end deffn

@geindex get_last_error() (no módulo ctypes)
@anchor{library/ctypes ctypes get_last_error}@anchor{300f}
@deffn {Função} ctypes.get_last_error ()

Returns the current value of the ctypes-private copy of the system
@code{LastError} variable in the calling thread.

@ref{1ed8,,Disponibilidade}: Windows

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.get_last_error} sem argumentos.
@end deffn

@geindex memmove() (no módulo ctypes)
@anchor{library/ctypes ctypes memmove}@anchor{3023}
@deffn {Função} ctypes.memmove (dst, src, count)

Same as the standard C memmove library function: copies `count' bytes from
`src' to `dst'. `dst' and `src' must be integers or ctypes instances that can
be converted to pointers.
@end deffn

@geindex memset() (no módulo ctypes)
@anchor{library/ctypes ctypes memset}@anchor{3024}
@deffn {Função} ctypes.memset (dst, c, count)

Same as the standard C memset library function: fills the memory block at
address `dst' with `count' bytes of value `c'. `dst' must be an integer
specifying an address, or a ctypes instance.
@end deffn

@geindex POINTER() (no módulo ctypes)
@anchor{library/ctypes ctypes POINTER}@anchor{17d8}
@deffn {Função} 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() (no módulo ctypes)
@anchor{library/ctypes ctypes pointer}@anchor{17d7}
@deffn {Função} ctypes.pointer (obj, /)

Create a new pointer instance, pointing to `obj'.
The returned object is of the type @code{POINTER(type(obj))}.

Note: If you just want to pass a pointer to an object to a foreign function
call, you should use @code{byref(obj)} which is much faster.
@end deffn

@geindex resize() (no módulo ctypes)
@anchor{library/ctypes ctypes resize}@anchor{3005}
@deffn {Função} ctypes.resize (obj, size)

This function resizes the internal memory buffer of `obj', which must be an
instance of a ctypes type.  It is not possible to make the buffer smaller
than the native size of the objects type, as given by @code{sizeof(type(obj))},
but it is possible to enlarge the buffer.
@end deffn

@geindex set_errno() (no módulo ctypes)
@anchor{library/ctypes ctypes set_errno}@anchor{300e}
@deffn {Função} ctypes.set_errno (value)

Set the current value of the ctypes-private copy of the system @ref{57,,errno}
variable in the calling thread to `value' and return the previous value.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.set_errno} com o argumento @code{errno}.
@end deffn

@geindex set_last_error() (no módulo ctypes)
@anchor{library/ctypes ctypes set_last_error}@anchor{3010}
@deffn {Função} ctypes.set_last_error (value)

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

@ref{1ed8,,Disponibilidade}: Windows

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.set_last_error} com o argumento @code{error}.
@end deffn

@geindex sizeof() (no módulo ctypes)
@anchor{library/ctypes ctypes sizeof}@anchor{3025}
@deffn {Função} ctypes.sizeof (obj_or_type)

Returns the size in bytes of a ctypes type or instance memory buffer.
Does the same as the C @code{sizeof} operator.
@end deffn

@geindex string_at() (no módulo ctypes)
@anchor{library/ctypes ctypes string_at}@anchor{3026}
@deffn {Função} 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.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.string_at} com os argumentos @code{ptr}, @code{size}.
@end deffn

@geindex WinError() (no módulo ctypes)
@anchor{library/ctypes ctypes WinError}@anchor{3027}
@deffn {Função} ctypes.WinError (code=None, descr=None)

This function is probably the worst-named thing in ctypes. It
creates an instance of @ref{417,,OSError}.  If `code' is not specified,
@code{GetLastError} is called to determine the error code. If `descr' is not
specified, @ref{3022,,FormatError()} is called to get a textual description of the
error.

@ref{1ed8,,Disponibilidade}: Windows


Alterado na versão 3.3: An instance of @ref{108d,,WindowsError} used to be created, which is now an
alias of @ref{417,,OSError}.

@end deffn

@geindex wstring_at() (no módulo ctypes)
@anchor{library/ctypes ctypes wstring_at}@anchor{3028}
@deffn {Função} 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.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.wstring_at} com os argumentos @code{ptr}, @code{size}.
@end deffn

@node Data types,Tipos de dados fundamentais<2>,Funções utilitárias,Referência ctypes
@anchor{library/ctypes ctypes-data-types}@anchor{3029}@anchor{library/ctypes data-types}@anchor{302a}
@subsubsection Data types


@geindex _CData (classe em ctypes)
@anchor{library/ctypes ctypes _CData}@anchor{302b}
@deffn {Classe} ctypes._CData

This non-public class is the common base class of all ctypes data types.
Among other things, all ctypes type instances contain a memory block that
hold C compatible data; the address of the memory block is returned by the
@ref{301d,,addressof()} helper function. Another instance variable is exposed as
@ref{302c,,_objects}; this contains other Python objects that need to be kept
alive in case the memory block contains pointers.

Common methods of ctypes data types, these are all class methods (to be
exact, they are methods of the @ref{2112,,metaclass}):

@geindex from_buffer() (método ctypes._CData)
@anchor{library/ctypes ctypes _CData from_buffer}@anchor{302d}
@deffn {Método} from_buffer (source[, offset])

This method returns a ctypes instance that shares the buffer of the
`source' object.  The `source' object must support the writeable buffer
interface.  The optional `offset' parameter specifies an offset into the
source buffer in bytes; the default is zero.  If the source buffer is not
large enough a @ref{202,,ValueError} is raised.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.cdata/buffer} com os argumentos @code{pointer}, @code{size}, @code{offset}.
@end deffn

@geindex from_buffer_copy() (método ctypes._CData)
@anchor{library/ctypes ctypes _CData from_buffer_copy}@anchor{302e}
@deffn {Método} from_buffer_copy (source[, offset])

This method creates a ctypes instance, copying the buffer from the
`source' object buffer which must be readable.  The optional `offset'
parameter specifies an offset into the source buffer in bytes; the default
is zero.  If the source buffer is not large enough a @ref{202,,ValueError} is
raised.

Levanta um @ref{19fa,,evento de auditoria} @code{ctypes.cdata/buffer} com os argumentos @code{pointer}, @code{size}, @code{offset}.
@end deffn

@geindex from_address() (método ctypes._CData)
@anchor{library/ctypes ctypes _CData from_address}@anchor{302f}
@deffn {Método} from_address (address)

This method returns a ctypes type instance using the memory specified by
`address' which must be an integer.

Este método, e outros que indiretamente chamam este método, levantam um @ref{19fa,,evento de auditoria} @code{ctypes.cdata} com o argumento @code{address}.
@end deffn

@geindex from_param() (método ctypes._CData)
@anchor{library/ctypes ctypes _CData from_param}@anchor{2fdc}
@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{15f6,,argtypes} tuple;
it must return an object that can be used as a function call parameter.

All ctypes data types have a default implementation of this classmethod
that normally returns `obj' if that is an instance of the type.  Some
types accept other objects as well.
@end deffn

@geindex in_dll() (método ctypes._CData)
@anchor{library/ctypes ctypes _CData in_dll}@anchor{2fff}
@deffn {Método} in_dll (library, name)

This method returns a ctypes type instance exported by a shared
library. `name' is the name of the symbol that exports the data, `library'
is the loaded shared library.
@end deffn

Common instance variables of ctypes data types:

@geindex _b_base_ (atributo ctypes._CData)
@anchor{library/ctypes ctypes _CData _b_base_}@anchor{3030}
@deffn {Atributo} _b_base_

Sometimes ctypes data instances do not own the memory block they contain,
instead they share part of the memory block of a base object.  The
@ref{3030,,_b_base_} read-only member is the root ctypes object that owns the
memory block.
@end deffn

@geindex _b_needsfree_ (atributo ctypes._CData)
@anchor{library/ctypes ctypes _CData _b_needsfree_}@anchor{3031}
@deffn {Atributo} _b_needsfree_

This read-only variable is true when the ctypes data instance has
allocated the memory block itself, false otherwise.
@end deffn

@geindex _objects (atributo ctypes._CData)
@anchor{library/ctypes ctypes _CData _objects}@anchor{302c}
@deffn {Atributo} _objects

This member is either @code{None} or a dictionary containing Python objects
that need to be kept alive so that the memory block contents is kept
valid.  This object is only exposed for debugging; never modify the
contents of this dictionary.
@end deffn
@end deffn

@node Tipos de dados fundamentais<2>,Tipos de dados estruturados,Data types,Referência ctypes
@anchor{library/ctypes ctypes-fundamental-data-types-2}@anchor{3032}@anchor{library/ctypes id1}@anchor{3033}
@subsubsection Tipos de dados fundamentais


@geindex _SimpleCData (classe em ctypes)
@anchor{library/ctypes ctypes _SimpleCData}@anchor{3034}
@deffn {Classe} ctypes._SimpleCData

This non-public class is the base class of all fundamental ctypes data
types. It is mentioned here because it contains the common attributes of the
fundamental ctypes data types.  @ref{3034,,_SimpleCData} is a subclass of
@ref{302b,,_CData}, so it inherits their methods and attributes. ctypes data
types that are not and do not contain pointers can now be pickled.

Instances have a single attribute:

@geindex value (atributo ctypes._SimpleCData)
@anchor{library/ctypes ctypes _SimpleCData value}@anchor{3035}
@deffn {Atributo} value

This attribute contains the actual value of the instance. For integer and
pointer types, it is an integer, for character types, it is a single
character bytes object or string, for character pointer types it is a
Python bytes object or string.

When the @code{value} attribute is retrieved from a ctypes instance, usually
a new object is returned each time.  @ref{2a,,ctypes} does `not' implement
original object return, always a new object is constructed.  The same is
true for all other ctypes object instances.
@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{2fdf,,restype} of @ref{17d9,,c_char_p}, you will always receive a Python bytes
object, `not' a @ref{17d9,,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{17db,,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.

These are the fundamental ctypes data types:

@geindex c_byte (classe em ctypes)
@anchor{library/ctypes ctypes c_byte}@anchor{1868}
@deffn {Classe} ctypes.c_byte

Represents the C signed char datatype, and interprets the value as
small integer.  The constructor accepts an optional integer initializer; no
overflow checking is done.
@end deffn

@geindex c_char (classe em ctypes)
@anchor{library/ctypes ctypes c_char}@anchor{2fc1}
@deffn {Classe} ctypes.c_char

Represents the C char datatype, and interprets the value as a single
character.  The constructor accepts an optional string initializer, the
length of the string must be exactly one character.
@end deffn

@geindex c_char_p (classe em ctypes)
@anchor{library/ctypes ctypes c_char_p}@anchor{17d9}
@deffn {Classe} ctypes.c_char_p

Represents the C char* datatype when it points to a zero-terminated
string.  For a general character pointer that may also point to binary data,
@code{POINTER(c_char)} must be used.  The constructor accepts an integer
address, or a bytes object.
@end deffn

@geindex c_double (classe em ctypes)
@anchor{library/ctypes ctypes c_double}@anchor{1a44}
@deffn {Classe} ctypes.c_double

Represents the C double datatype.  The constructor accepts an
optional float initializer.
@end deffn

@geindex c_longdouble (classe em ctypes)
@anchor{library/ctypes ctypes c_longdouble}@anchor{1a45}
@deffn {Classe} ctypes.c_longdouble

Represents the C long double datatype.  The constructor accepts an
optional float initializer.  On platforms where @code{sizeof(long double) ==
sizeof(double)} it is an alias to @ref{1a44,,c_double}.
@end deffn

@geindex c_float (classe em ctypes)
@anchor{library/ctypes ctypes c_float}@anchor{2fd2}
@deffn {Classe} ctypes.c_float

Represents the C float datatype.  The constructor accepts an
optional float initializer.
@end deffn

@geindex c_int (classe em ctypes)
@anchor{library/ctypes ctypes c_int}@anchor{2fb5}
@deffn {Classe} ctypes.c_int

Represents the C signed int datatype.  The constructor accepts an
optional integer initializer; no overflow checking is done.  On platforms
where @code{sizeof(int) == sizeof(long)} it is an alias to @ref{2fb6,,c_long}.
@end deffn

@geindex c_int8 (classe em ctypes)
@anchor{library/ctypes ctypes c_int8}@anchor{2fc5}
@deffn {Classe} ctypes.c_int8

Represents the C 8-bit signed int datatype.  It is an alias for
@ref{1868,,c_byte}.
@end deffn

@geindex c_int16 (classe em ctypes)
@anchor{library/ctypes ctypes c_int16}@anchor{2fc6}
@deffn {Classe} ctypes.c_int16

Represents the C 16-bit signed int datatype.  Usually an alias for
@ref{2fc3,,c_short}.
@end deffn

@geindex c_int32 (classe em ctypes)
@anchor{library/ctypes ctypes c_int32}@anchor{2fc7}
@deffn {Classe} ctypes.c_int32

Represents the C 32-bit signed int datatype.  Usually an alias for
@ref{2fb5,,c_int}.
@end deffn

@geindex c_int64 (classe em ctypes)
@anchor{library/ctypes ctypes c_int64}@anchor{2fc8}
@deffn {Classe} ctypes.c_int64

Represents the C 64-bit signed int datatype.  Usually an alias for
@ref{2fcf,,c_longlong}.
@end deffn

@geindex c_long (classe em ctypes)
@anchor{library/ctypes ctypes c_long}@anchor{2fb6}
@deffn {Classe} ctypes.c_long

Represents the C signed long datatype.  The constructor accepts an
optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_longlong (classe em ctypes)
@anchor{library/ctypes ctypes c_longlong}@anchor{2fcf}
@deffn {Classe} ctypes.c_longlong

Represents the C signed long long datatype.  The constructor accepts
an optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_short (classe em ctypes)
@anchor{library/ctypes ctypes c_short}@anchor{2fc3}
@deffn {Classe} ctypes.c_short

Represents the C signed short datatype.  The constructor accepts an
optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_size_t (classe em ctypes)
@anchor{library/ctypes ctypes c_size_t}@anchor{2fd1}
@deffn {Classe} ctypes.c_size_t

Represents the C @code{size_t} datatype.
@end deffn

@geindex c_ssize_t (classe em ctypes)
@anchor{library/ctypes ctypes c_ssize_t}@anchor{127d}
@deffn {Classe} ctypes.c_ssize_t

Represents the C @code{ssize_t} datatype.


Adicionado na versão 3.2.

@end deffn

@geindex c_time_t (classe em ctypes)
@anchor{library/ctypes ctypes c_time_t}@anchor{18ee}
@deffn {Classe} ctypes.c_time_t

Represents the C @code{time_t} datatype.


Adicionado na versão 3.12.

@end deffn

@geindex c_ubyte (classe em ctypes)
@anchor{library/ctypes ctypes c_ubyte}@anchor{1869}
@deffn {Classe} ctypes.c_ubyte

Represents the C unsigned char datatype, it interprets the value as
small integer.  The constructor accepts an optional integer initializer; no
overflow checking is done.
@end deffn

@geindex c_uint (classe em ctypes)
@anchor{library/ctypes ctypes c_uint}@anchor{2fc9}
@deffn {Classe} ctypes.c_uint

Represents the C unsigned int datatype.  The constructor accepts an
optional integer initializer; no overflow checking is done.  On platforms
where @code{sizeof(int) == sizeof(long)} it is an alias for @ref{2fce,,c_ulong}.
@end deffn

@geindex c_uint8 (classe em ctypes)
@anchor{library/ctypes ctypes c_uint8}@anchor{2fca}
@deffn {Classe} ctypes.c_uint8

Represents the C 8-bit unsigned int datatype.  It is an alias for
@ref{1869,,c_ubyte}.
@end deffn

@geindex c_uint16 (classe em ctypes)
@anchor{library/ctypes ctypes c_uint16}@anchor{2fcb}
@deffn {Classe} ctypes.c_uint16

Represents the C 16-bit unsigned int datatype.  Usually an alias for
@ref{2fc4,,c_ushort}.
@end deffn

@geindex c_uint32 (classe em ctypes)
@anchor{library/ctypes ctypes c_uint32}@anchor{2fcc}
@deffn {Classe} ctypes.c_uint32

Represents the C 32-bit unsigned int datatype.  Usually an alias for
@ref{2fc9,,c_uint}.
@end deffn

@geindex c_uint64 (classe em ctypes)
@anchor{library/ctypes ctypes c_uint64}@anchor{2fcd}
@deffn {Classe} ctypes.c_uint64

Represents the C 64-bit unsigned int datatype.  Usually an alias for
@ref{2fd0,,c_ulonglong}.
@end deffn

@geindex c_ulong (classe em ctypes)
@anchor{library/ctypes ctypes c_ulong}@anchor{2fce}
@deffn {Classe} ctypes.c_ulong

Represents the C unsigned long datatype.  The constructor accepts an
optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_ulonglong (classe em ctypes)
@anchor{library/ctypes ctypes c_ulonglong}@anchor{2fd0}
@deffn {Classe} ctypes.c_ulonglong

Represents the C unsigned long long datatype.  The constructor
accepts an optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_ushort (classe em ctypes)
@anchor{library/ctypes ctypes c_ushort}@anchor{2fc4}
@deffn {Classe} ctypes.c_ushort

Represents the C unsigned short datatype.  The constructor accepts
an optional integer initializer; no overflow checking is done.
@end deffn

@geindex c_void_p (classe em ctypes)
@anchor{library/ctypes ctypes c_void_p}@anchor{17db}
@deffn {Classe} ctypes.c_void_p

Represents the C void* type.  The value is represented as integer.
The constructor accepts an optional integer initializer.
@end deffn

@geindex c_wchar (classe em ctypes)
@anchor{library/ctypes ctypes c_wchar}@anchor{2fc2}
@deffn {Classe} 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 (classe em ctypes)
@anchor{library/ctypes ctypes c_wchar_p}@anchor{17da}
@deffn {Classe} ctypes.c_wchar_p

Represents the C wchar_t* datatype, which must be a pointer to a
zero-terminated wide character string.  The constructor accepts an integer
address, or a string.
@end deffn

@geindex c_bool (classe em ctypes)
@anchor{library/ctypes ctypes c_bool}@anchor{2fc0}
@deffn {Classe} ctypes.c_bool

Represent the C bool datatype (more accurately, _Bool from
C99).  Its value can be @code{True} or @code{False}, and the constructor accepts any object
that has a truth value.
@end deffn

@geindex HRESULT (classe em ctypes)
@anchor{library/ctypes ctypes HRESULT}@anchor{300c}
@deffn {Classe} ctypes.HRESULT

Represents a @code{HRESULT} value, which contains success or
error information for a function or method call.

@ref{1ed8,,Disponibilidade}: Windows
@end deffn

@geindex py_object (classe em ctypes)
@anchor{library/ctypes ctypes py_object}@anchor{147f}
@deffn {Classe} ctypes.py_object

Represents the C @ref{339,,PyObject}* datatype.  Calling this without an
argument creates a @code{NULL} @ref{339,,PyObject}* pointer.
@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 dados estruturados,Arrays and pointers,Tipos de dados fundamentais<2>,Referência ctypes
@anchor{library/ctypes ctypes-structured-data-types}@anchor{3036}@anchor{library/ctypes structured-data-types}@anchor{3037}
@subsubsection Tipos de dados estruturados


@geindex Union (classe em ctypes)
@anchor{library/ctypes ctypes Union}@anchor{1777}
@deffn {Classe} ctypes.Union (*args, **kw)

Classe base abstrata para uniões em ordem de bytes nativa.
@end deffn

@geindex BigEndianUnion (classe em ctypes)
@anchor{library/ctypes ctypes BigEndianUnion}@anchor{1941}
@deffn {Classe} ctypes.BigEndianUnion (*args, **kw)

Abstract base class for unions in `big endian' byte order.


Adicionado na versão 3.11.

@end deffn

@geindex LittleEndianUnion (classe em ctypes)
@anchor{library/ctypes ctypes LittleEndianUnion}@anchor{1942}
@deffn {Classe} ctypes.LittleEndianUnion (*args, **kw)

Abstract base class for unions in `little endian' byte order.


Adicionado na versão 3.11.

@end deffn

@geindex BigEndianStructure (classe em ctypes)
@anchor{library/ctypes ctypes BigEndianStructure}@anchor{2feb}
@deffn {Classe} ctypes.BigEndianStructure (*args, **kw)

Abstract base class for structures in `big endian' byte order.
@end deffn

@geindex LittleEndianStructure (classe em ctypes)
@anchor{library/ctypes ctypes LittleEndianStructure}@anchor{2fec}
@deffn {Classe} ctypes.LittleEndianStructure (*args, **kw)

Abstract base class for structures in `little endian' byte order.
@end deffn

Structures and unions with non-native byte order cannot contain pointer type
fields, or any other data types containing pointer type fields.

@geindex Structure (classe em ctypes)
@anchor{library/ctypes ctypes Structure}@anchor{1d4}
@deffn {Classe} ctypes.Structure (*args, **kw)

Abstract base class for structures in `native' byte order.

Concrete structure and union types must be created by subclassing one of these
types, and at least define a @ref{2fe7,,_fields_} class variable. @ref{2a,,ctypes} will
create @ref{1658,,descriptor}s which allow reading and writing the fields by direct
attribute accesses.  These are the

@geindex _fields_ (atributo ctypes.Structure)
@anchor{library/ctypes ctypes Structure _fields_}@anchor{2fe7}
@deffn {Atributo} _fields_

A sequence defining the structure fields.  The items must be 2-tuples or
3-tuples.  The first item is the name of the field, the second item
specifies the type of the field; it can be any ctypes data type.

For integer type fields like @ref{2fb5,,c_int}, a third optional item can be
given.  It must be a small positive integer defining the bit width of the
field.

Field names must be unique within one structure or union.  This is not
checked, only one field can be accessed when names are repeated.

It is possible to define the @ref{2fe7,,_fields_} class variable `after' the
class statement that defines the Structure subclass, this allows creating
data types that directly or indirectly reference themselves:

@example
class List(Structure):
    pass
List._fields_ = [("pnext", POINTER(List)),
                 ...
                ]
@end example

The @ref{2fe7,,_fields_} class variable must, however, be defined before the
type is first used (an instance is created, @ref{3025,,sizeof()} is called on it,
and so on).  Later assignments to the @ref{2fe7,,_fields_} class variable will
raise an AttributeError.

It is possible to define sub-subclasses of structure types, they inherit
the fields of the base class plus the @ref{2fe7,,_fields_} defined in the
sub-subclass, if any.
@end deffn

@geindex _pack_ (atributo ctypes.Structure)
@anchor{library/ctypes ctypes Structure _pack_}@anchor{2fea}
@deffn {Atributo} _pack_

An optional small integer that allows overriding the alignment of
structure fields in the instance.  @ref{2fea,,_pack_} must already be defined
when @ref{2fe7,,_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 ctypes.Structure)
@anchor{library/ctypes ctypes Structure _align_}@anchor{1d5}
@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.


Adicionado na versão 3.13.

@end deffn

@geindex _anonymous_ (atributo ctypes.Structure)
@anchor{library/ctypes ctypes Structure _anonymous_}@anchor{3038}
@deffn {Atributo} _anonymous_

An optional sequence that lists the names of unnamed (anonymous) fields.
@ref{3038,,_anonymous_} must be already defined when @ref{2fe7,,_fields_} is
assigned, otherwise it will have no effect.

The fields listed in this variable must be structure or union type fields.
@ref{2a,,ctypes} will create descriptors in the structure type that allows
accessing the nested fields directly, without the need to create the
structure or union field.

Here is an example type (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

The @code{TYPEDESC} structure describes a COM data type, the @code{vt} field
specifies which one of the union fields is valid.  Since the @code{u} field
is defined as anonymous field, it is now possible to access the members
directly off the TYPEDESC instance. @code{td.lptdesc} and @code{td.u.lptdesc}
are equivalent, but the former is faster since it does not need to create
a temporary union instance:

@example
td = TYPEDESC()
td.vt = VT_PTR
td.lptdesc = POINTER(some_type)
td.u.lptdesc = POINTER(some_type)
@end example
@end deffn

It is possible to define sub-subclasses of structures, they inherit the
fields of the base class.  If the subclass definition has a separate
@ref{2fe7,,_fields_} variable, the fields specified in this are appended to the
fields of the base class.

Structure and union constructors accept both positional and keyword
arguments.  Positional arguments are used to initialize member fields in the
same order as they are appear in @ref{2fe7,,_fields_}.  Keyword arguments in the
constructor are interpreted as attribute assignments, so they will initialize
@ref{2fe7,,_fields_} with the same name, or create new attributes for names not
present in @ref{2fe7,,_fields_}.
@end deffn

@node Arrays and pointers,,Tipos de dados estruturados,Referência ctypes
@anchor{library/ctypes arrays-and-pointers}@anchor{3039}@anchor{library/ctypes ctypes-arrays-pointers}@anchor{303a}
@subsubsection Arrays and pointers


@geindex Array (classe em ctypes)
@anchor{library/ctypes ctypes Array}@anchor{1ba2}
@deffn {Classe} ctypes.Array (*args)

Abstract base class for arrays.

The recommended way to create concrete array types is by multiplying any
@ref{2a,,ctypes} data type with a non-negative integer.  Alternatively, you can subclass
this type and define @ref{303b,,_length_} and @ref{303c,,_type_} class variables.
Array elements can be read and written using standard
subscript and slice accesses; for slice reads, the resulting object is
`not' itself an @ref{1ba2,,Array}.

@geindex _length_ (atributo ctypes.Array)
@anchor{library/ctypes ctypes Array _length_}@anchor{303b}
@deffn {Atributo} _length_

A positive integer specifying the number of elements in the array.
Out-of-range subscripts result in an @ref{157e,,IndexError}. Will be
returned by @ref{62e,,len()}.
@end deffn

@geindex _type_ (atributo ctypes.Array)
@anchor{library/ctypes ctypes Array _type_}@anchor{303c}
@deffn {Atributo} _type_

Specifies the type of each element in the array.
@end deffn

Array subclass constructors accept positional arguments, used to
initialize the elements in order.
@end deffn

@geindex ARRAY() (no módulo ctypes)
@anchor{library/ctypes ctypes ARRAY}@anchor{29c}
@deffn {Função} ctypes.ARRAY (type, length)

Create an array.
Equivalent to @code{type * length}, where `type' is a
@ref{2a,,ctypes} data type and `length' an integer.

This function is @ref{209,,soft deprecated} in favor of multiplication.
There are no plans to remove it.
@end deffn

@geindex _Pointer (classe em ctypes)
@anchor{library/ctypes ctypes _Pointer}@anchor{303d}
@deffn {Classe} ctypes._Pointer

Private, abstract base class for pointers.

Concrete pointer types are created by calling @ref{17d8,,POINTER()} with the
type that will be pointed to; this is done automatically by
@ref{17d7,,pointer()}.

If a pointer points to an array, its elements can be read and
written using standard subscript and slice accesses.  Pointer objects
have no size, so @ref{62e,,len()} will raise @ref{2c3,,TypeError}.  Negative
subscripts will read from the memory `before' the pointer (as in C), and
out-of-range subscripts will probably crash with an access violation (if
you’re lucky).

@geindex _type_ (atributo ctypes._Pointer)
@anchor{library/ctypes ctypes _Pointer _type_}@anchor{162a}
@deffn {Atributo} _type_

Specifies the type pointed to.
@end deffn

@geindex contents (atributo ctypes._Pointer)
@anchor{library/ctypes ctypes _Pointer contents}@anchor{2ff3}
@deffn {Atributo} contents

Returns the object to which to pointer points.  Assigning to this
attribute changes the pointer to point to the assigned object.
@end deffn
@end deffn

@node Bibliotecas de interface de linha de comando,Execução Concorrente,Serviços Genéricos do Sistema Operacional,A Biblioteca Padrão do Python
@anchor{library/cmdlinelibs doc}@anchor{303e}@anchor{library/cmdlinelibs cmdlinelibs}@anchor{303f}@anchor{library/cmdlinelibs command-line-interface-libraries}@anchor{3040}@anchor{library/cmdlinelibs translation-repo}@anchor{3041}
@section Bibliotecas de interface de linha de comando


Os módulos descritos neste capítulo ajudam a implementar as interfaces de linha de comando e de terminal para aplicações.

Veja aqui uma visão geral:

@menu
* argparse — Analisador sintático para opções de linha de comando@comma{} argumentos e subcomandos: argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos. 
* optparse — Analisador sintático para opções de linha de comando:: 
* getpass — Entrada de senha portátil:: 
* fileinput — Itera sobre linhas de múltiplos fluxos de entrada:: 
* curses — Gerenciador de terminal para visualizadores de células de caracteres.: curses — Gerenciador de terminal para visualizadores de células de caracteres. 
* curses.textpad — Text input widget for curses programs: curses textpad — Text input widget for curses programs. 
* curses.ascii — Utilitários para caracteres ASCII: curses ascii — Utilitários para caracteres ASCII. 
* curses.panel — Uma extensão de pilha de painéis para o curses: curses panel — Uma extensão de pilha de painéis para o curses. 
* cmd — Suporte para interpretadores de comando orientado a linhas:: 

@end menu

@node argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos,optparse — Analisador sintático para opções de linha de comando,,Bibliotecas de interface de linha de comando
@anchor{library/argparse doc}@anchor{3042}@anchor{library/argparse argparse-parser-for-command-line-options-arguments-and-subcommands}@anchor{3043}@anchor{library/argparse module-argparse}@anchor{6}
@subsection @code{argparse} — Analisador sintático para opções de linha de comando, argumentos e subcomandos


@geindex module; argparse


Adicionado na versão 3.2.


`Código-fonte:' Lib/argparse.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/argparse.py}

@cartouche
@quotation Nota 
Embora o @ref{6,,argparse} seja o módulo de biblioteca padrão recomendado para implementar aplicações básicas de linha de comando, autores com requisitos mais rigorosos sobre como exatamente suas aplicações de linha de comando se comportam podem descobrir que ele não fornece o nível de controle necessário. Consulte @ref{3044,,Escolhendo uma biblioteca de análise de linha de comando} para alternativas a serem consideradas quando @code{argparse} não suporta comportamentos que a aplicação requer (como desabilitar completamente o suporte para opções intercaladas e argumentos posicionais, ou aceitar valores de parâmetros de opção que começam com @code{-} mesmo quando correspondem a outra opção definida).
@end quotation
@end cartouche


__________________________________________________________________


@subsubheading Tutorial



Esta página contém informações da API de Referência. Para uma introdução mais prática para o parser de linha de comando Python, acesse o @ref{3045,,tutorial do argparse}.

O módulo @code{argparse} torna fácil a escrita de interfaces de linha de comando amigáveis. O programa define quais argumentos são necessários e @code{argparse} descobrirá como analisá-lo e interpretá-los a partir do @ref{12a6,,sys.argv}. O módulo @code{argparse} também gera automaticamente o texto ajuda e mensagens de uso. O módulo também vai emitir erros quando o usuário prover argumentos inválidos para o programa.

O suporte do módulo @code{argparse} para interfaces de linha de comando é construído em torno de uma instância de @ref{539,,argparse.ArgumentParser}. É um contêiner para especificações de argumentos e possui opções que se aplicam ao analisador sintático como um todo:

@example
parser = argparse.ArgumentParser(
                    prog='NomePrograma',
                    description='O que o programa faz',
                    epilog='Texto na parte inferior da memsagem de ajuda')
@end example

O método @ref{19e,,ArgumentParser.add_argument()} anexa especificações de argumentos individuais ao analisador. Ele oferece suporte a argumentos posicionais, opções que aceitam valores e sinalizadores de ligar/desligar:

@example
parser.add_argument('filename')           # argumento posicional
parser.add_argument('-c', '--count')      # a opção recebe um valor
parser.add_argument('-v', '--verbose',
                    action='store_true')  # sinalizador de ligar/desligar
@end example

O método @ref{3046,,ArgumentParser.parse_args()} executa o analisador e coloca os dados extraídos em um objeto @ref{3047,,argparse.Namespace}:

@example
args = parser.parse_args()
print(args.filename, args.count, args.verbose)
@end example

@cartouche
@quotation Nota 
Se você estiver procurando um guia sobre como atualizar um código @ref{a0,,optparse} para @code{argparse}, veja @ref{11ed,,Atualizando código optparse}.
@end quotation
@end cartouche

@menu
* Objetos ArgumentParser:: 
* O método add_argument(): O método add_argument. 
* O método parse_args(): O método parse_args. 
* Outros utilitários:: 
* Exceções: Exceções<9>. 

@end menu

@node Objetos ArgumentParser,O método add_argument,,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos
@anchor{library/argparse argumentparser-objects}@anchor{3048}
@subsubsection Objetos ArgumentParser


@geindex ArgumentParser (classe em argparse)
@anchor{library/argparse argparse ArgumentParser}@anchor{539}
@deffn {Classe} 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)

Cria um novo objeto @ref{539,,ArgumentParser}. Todos os parâmetros devem ser passados como argumentos nomeados. Cada parâmetro tem sua própria descrição mais detalhada abaixo, mas em resumo eles são:


@itemize *

@item 
@ref{3049,,prog} - O nome do programa (padrão: @code{os.path.basename(sys.argv[0])})

@item 
@ref{304a,,usage} - A string que descreve o uso do programa (padrão: gerado a partir de argumentos adicionados ao analisador sintático)

@item 
@ref{304b,,description} - Texto para exibir antes da ajuda dos argumentos (por padrão, nenhum texto)

@item 
@ref{304c,,epilog} - Texto para exibir após da ajuda dos argumentos (por padrão, nenhum texto)

@item 
@ref{304d,,parents} - Uma lista de objetos @ref{539,,ArgumentParser} cujos argumentos também devem ser incluídos

@item 
@ref{304e,,formatter_class} - Uma classe para personalizar a saída de ajuda

@item 
@ref{304f,,prefix_chars} - O conjunto de caracteres que prefixam argumentos opcionais (padrão: “-“)

@item 
@ref{3050,,fromfile_prefix_chars} - O conjunto de caracteres que prefixam os arquivos dos quais os argumentos adicionais devem ser lidos (padrão: @code{None})

@item 
@ref{3051,,argument_default} - O valor padrão global para argumentos (padrão: @code{None})

@item 
@ref{3052,,conflict_handler} - A estratégia para resolver opcionais conflitantes (geralmente desnecessário)

@item 
@ref{3053,,add_help} - Adiciona uma opção @code{-h/--help} para o analisador sintático (padrão: @code{True})

@item 
@ref{de8,,allow_abbrev} - Permite que opções longas sejam abreviadas se a abreviação não for ambígua. (padrão: @code{True})

@item 
@ref{3054,,exit_on_error} - Determina se @code{ArgumentParser} sai ou não com informações de erro quando ocorre um erro. (padrão: @code{True})
@end itemize


Alterado na versão 3.5: O parâmetro `allow_abbrev' foi adicionado.



Alterado na versão 3.8: Em versões anteriores, `allow_abbrev' também desabilitava o agrupamento de sinalizadores curtos, como @code{-vv} para significar @code{-v -v}.



Alterado na versão 3.9: O parâmetro `exit_on_error' foi adicionado.

@end deffn

As seções a seguir descrevem como cada um deles é usado.

@menu
* prog:: 
* usage:: 
* description:: 
* epilog:: 
* parents:: 
* formatter_class:: 
* prefix_chars:: 
* fromfile_prefix_chars:: 
* argument_default:: 
* allow_abbrev:: 
* conflict_handler:: 
* add_help:: 
* exit_on_error:: 

@end menu

@node prog,usage,,Objetos ArgumentParser
@anchor{library/argparse id1}@anchor{3055}@anchor{library/argparse prog}@anchor{3049}
@subsubsection prog


Por padrão, @ref{539,,ArgumentParser} calcula o nome do programa a ser exibido nas mensagens de ajuda dependendo da maneira como o interpretador Python foi executado:


@itemize *

@item 
O @ref{2985,,nome base} de @code{sys.argv[0]} se um arquivo foi passado como argumento.

@item 
O nome do interpretador Python seguido por @code{sys.argv[0]} se um diretório ou um arquivo zip foi passado como argumento.

@item 
O nome do interpretador Python seguido por @code{-m} seguido pelo nome do módulo ou pacote se a opção @ref{5e1,,-m} foi usada.
@end itemize

Este padrão é quase sempre desejável porque fará com que as mensagens de ajuda correspondam à string que foi usada para invocar o programa na linha de comando. No entanto, para alterar esse comportamento padrão, outro valor pode ser fornecido usando o argumento @code{prog=} para @ref{539,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='meuprograma')
>>> parser.print_help()
usage: meuprograma [-h]

options:
 -h, --help  show this help message and exit
@end example

Observe que o nome do programa, seja determinado a partir de @code{sys.argv[0]} ou do argumento @code{prog=}, está disponível para mensagens de ajuda usando o especificador de formato @code{%(prog)s}.

@example
>>> parser = argparse.ArgumentParser(prog='meuprograma')>>> parser.add_argument('--foo', help='foo do programa %(prog)s')>>> parser.print_help()usage: meuprograma [-h] [--foo FOO]options: -h, --help  show this help message and exit --foo FOO   foo do programa meuprograma
@end example

@node usage,description,prog,Objetos ArgumentParser
@anchor{library/argparse usage}@anchor{304a}
@subsubsection usage


Por padrão, @ref{539,,ArgumentParser} calcula a mensagem de uso a partir dos argumentos que contém. A mensagem padrão pode ser substituída pelo argumento nomeado @code{usage=}:

@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

O especificador de formato @code{%(prog)s} está disponível para preencher o nome do programa em suas mensagens de uso.

@node description,epilog,usage,Objetos ArgumentParser
@anchor{library/argparse description}@anchor{304b}@anchor{library/argparse id2}@anchor{3056}
@subsubsection description


A maioria das chamadas para o construtor @ref{539,,ArgumentParser} usará o argumento nomeado  @code{description=}. Este argumento fornece uma breve descrição do que o programa faz e como funciona. Nas mensagens de ajuda, a descrição é exibida entre a string de uso da linha de comando e as mensagens de ajuda para os vários argumentos.

Por padrão, a descrição terá sua linha quebrada para que se encaixe no espaço fornecido. Para alterar esse comportamento, consulte o argumento @ref{304e,,formatter_class}.

@node epilog,parents,description,Objetos ArgumentParser
@anchor{library/argparse epilog}@anchor{304c}
@subsubsection epilog


Alguns programas gostam de exibir uma descrição adicional do programa após a descrição dos argumentos. Esse texto pode ser especificado usando o argumento @code{epilog=} para @ref{539,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(
...     description='Um foo que faz bars',
...     epilog="E é assim que você faria foo de bar")
>>> parser.print_help()
usage: argparse.py [-h]

Um foo que faz bars

options:
 -h, --help  show this help message and exit

E é assim que você faria foo de bar
@end example

Tal como acontece com o argumento @ref{304b,,description}, o texto de @code{epilog=} tem sua quebra de linha habilitada por padrão, mas este comportamento pode ser ajustado com o argumento @ref{304e,,formatter_class} para @ref{539,,ArgumentParser}.

@node parents,formatter_class,epilog,Objetos ArgumentParser
@anchor{library/argparse parents}@anchor{304d}
@subsubsection parents


Às vezes, vários analisadores sintáticos compartilham um conjunto comum de argumentos. Ao invés de repetir as definições desses argumentos, um único analisador com todos os argumentos compartilhados e passado para o argumento @code{parents=} para @ref{539,,ArgumentParser} pode ser usado. O argumento @code{parents=} pega uma lista de objetos @ref{539,,ArgumentParser}, coleta todas as ações posicionais e opcionais deles, e adiciona essas ações ao objeto @ref{539,,ArgumentParser} sendo construído:

@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

Observe que a maioria dos analisadores sintáticos pais especificará @code{add_help=False}. Caso contrário, o @ref{539,,ArgumentParser} verá duas opções @code{-h/--help} (uma no pai e outra no filho) e levantará um erro.

@cartouche
@quotation Nota 
Você deve inicializar totalmente os analisadores sintáticos antes de passá-los via @code{parents=}. Se você alterar os analisadores pais após o analisador filho, essas mudanças não serão refletidas no filho.
@end quotation
@end cartouche

@node formatter_class,prefix_chars,parents,Objetos ArgumentParser
@anchor{library/argparse formatter-class}@anchor{304e}@anchor{library/argparse id3}@anchor{3057}
@subsubsection formatter_class


Objetos @ref{539,,ArgumentParser} permitem que a  formação do texto de ajuda seja personalizada por meio da especificação de uma classe de formatação alternativa. Atualmente, há quatro dessas classes:

@geindex RawDescriptionHelpFormatter (classe em argparse)
@geindex RawTextHelpFormatter (classe em argparse)
@geindex ArgumentDefaultsHelpFormatter (classe em argparse)
@geindex MetavarTypeHelpFormatter (classe em argparse)
@anchor{library/argparse argparse RawDescriptionHelpFormatter}@anchor{3058}
@deffn {Classe} argparse.RawDescriptionHelpFormatter
@anchor{library/argparse argparse RawTextHelpFormatter}@anchor{3059}
@deffnx {Classe} argparse.RawTextHelpFormatter
@anchor{library/argparse argparse ArgumentDefaultsHelpFormatter}@anchor{19db}
@deffnx {Classe} argparse.ArgumentDefaultsHelpFormatter
@anchor{library/argparse argparse MetavarTypeHelpFormatter}@anchor{305a}
@deffnx {Classe} argparse.MetavarTypeHelpFormatter
@end deffn

@ref{3058,,RawDescriptionHelpFormatter} e @ref{3059,,RawTextHelpFormatter} dão mais controle sobre como as descrições textuais são exibidas. Por padrão, objetos @ref{539,,ArgumentParser} quebram em linha os textos @ref{304b,,description} e @ref{304c,,epilog} nas mensagens de ajuda da linha de comando:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     description='@w{'}'esta descrição
...         foi indentada de forma estranha,
...             mas está tudo bem'@w{'}',
...     epilog='@w{'}'
...             da mesma forma para este epílogo, cujos espaços vão
...         ser apagados e cujas palavras serão quebradas
...         em algumas linhas'@w{'}')
>>> parser.print_help()
usage: PROG [-h]

esta descrição foi indentada de forma estranha, mas está tudo bem

options:
 -h, --help  show this help message and exit

da mesma forma para este epílogo, cujos espaços vão ser apagados e
cujas palavras serão quebradas em algumas linhas
@end example

Passar @ref{3058,,RawDescriptionHelpFormatter} como @code{formatter_class=} indica que @ref{304b,,description} e @ref{304c,,epilog} já estão formatados corretamente e não devem ter suas linhas quebradas:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.RawDescriptionHelpFormatter,
...     description=textwrap.dedent('@w{'}'\
...         Por favor, não bagunce este texto!
...         --------------------------------
...             Eu indentei o texto
...             exatamente na forma
...             que quero que fique
...         '@w{'}'))
>>> parser.print_help()
usage: PROG [-h]

Por favor, não bagunce este texto!
--------------------------------
   Eu indentei o texto
   exatamente na forma
   que quero que fique

options:
 -h, --help  show this help message and exit
@end example

@ref{3059,,RawTextHelpFormatter} mantém espaços em branco para todos os tipos de texto de ajuda, incluindo descrições de argumentos. No entanto, várias novas linhas são substituídas por uma. Se você deseja preservar várias linhas em branco, adicione espaços entre as novas linhas.

@ref{19db,,ArgumentDefaultsHelpFormatter} adiciona automaticamente informações sobre os valores padrão para cada uma das mensagens de ajuda do argumento:

@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{305a,,MetavarTypeHelpFormatter} usa o nome de argumento @ref{305b,,type} para cada argumento como o nome de exibição para seus valores (em vez de usar o @ref{305c,,dest} como o formatador regular faz):

@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{304f}
@subsubsection prefix_chars


A maioria das opções de linha de comando usará @code{-} como prefixo, por exemplo, @code{-f/--foo}. Analisadores sintáticos que precisam ter suporte a caracteres de prefixo diferentes ou adicionais, por exemplo, para opções como @code{+f} ou @code{/foo}, podem especificá-las usando o argumento @code{prefix_chars=} para o construtor @ref{539,,ArgumentParser}:

@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

O argumento @code{prefix_chars=} é padronizado como @code{'-'}. Fornecer um conjunto de caracteres que não inclua @code{-} fará com que as opções @code{-f/--foo} não sejam permitidas.

@node fromfile_prefix_chars,argument_default,prefix_chars,Objetos ArgumentParser
@anchor{library/argparse fromfile-prefix-chars}@anchor{3050}
@subsubsection fromfile_prefix_chars


Às vezes ao lidar com uma lista de argumentos particularmente longa, pode fazer sentido manter a lista de argumentos em um arquivo em vez de digitá-la na linha de comando. Se o argumento @code{fromfile_prefix_chars=} for dado ao construtor @ref{539,,ArgumentParser}, então os argumentos que começam com qualquer um dos caracteres especificados serão tratados como arquivos e serão substituídos pelos argumentos que eles contêm. Por exemplo:

@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

Por padrão, os argumentos lidos de um arquivo devem ser um por linha (mas veja também @ref{305d,,convert_arg_line_to_args()}) e são tratados como se estivessem no mesmo lugar que o argumento original que faz referência ao arquivo na linha de comando. Portanto, no exemplo acima, a expressão @code{['-f', 'foo', '@@args.txt']} é considerada equivalente à expressão @code{['-f', 'foo', '-f', 'bar']}.

@cartouche
@quotation Nota 
Linhas vazias são tratadas como strings vazias (@code{'@w{'}}), que são permitidas como valores, mas não como argumentos. Linhas vazias lidas como argumentos resultarão em um erro de “unrecognized arguments” (“argumentos não reconhecidos”).
@end quotation
@end cartouche

@ref{539,,ArgumentParser} usa @ref{53b,,tratador de erros e codificação do sistema de arquivos} para ler o arquivo que contém argumentos.

O argumento @code{fromfile_prefix_chars=} é padronizado como @code{None}, significando que os argumentos nunca serão tratados como referências de arquivo.


Alterado na versão 3.12: @ref{539,,ArgumentParser} alterou a codificação e os erros para ler arquivos de argumentos do padrão (por exemplo, @ref{53a,,locale.getpreferredencoding(False)} e @code{"strict"}) para @ref{53b,,tratador de erros e codificação do sistema de arquivos}. O arquivo de argumentos deve ser codificado em UTF-8 em vez de página de código ANSI no Windows.


@node argument_default,allow_abbrev,fromfile_prefix_chars,Objetos ArgumentParser
@anchor{library/argparse argument-default}@anchor{3051}
@subsubsection argument_default


Geralmente, os padrões dos argumentos são especificados passando um padrão para @ref{19e,,add_argument()} ou chamando os métodos @ref{305e,,set_defaults()} com um conjunto específico de pares nome-valor. Às vezes, no entanto, pode ser útil especificar um único padrão para argumentos, válido em todo o analisador. Isso pode ser feito passando o argumento nomeado @code{argument_default=} para @ref{539,,ArgumentParser}. Por exemplo, para suprimir globalmente a criação de atributos em chamadas @ref{3046,,parse_args()}, fornecemos @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{de8}@anchor{library/argparse id4}@anchor{305f}
@subsubsection allow_abbrev


Normalmente, quando você passa uma lista de argumentos para o método @ref{3046,,parse_args()} de um @ref{539,,ArgumentParser}, ele @ref{de7,,reconhece as abreviações} de opções longas.

Este recurso pode ser desabilitado configurando @code{allow_abbrev} para @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


Adicionado na versão 3.5.


@node conflict_handler,add_help,allow_abbrev,Objetos ArgumentParser
@anchor{library/argparse conflict-handler}@anchor{3052}
@subsubsection conflict_handler


Objetos @ref{539,,ArgumentParser} não permitem duas ações com a mesma string de opções. Por padrão, objetos @ref{539,,ArgumentParser} levantam uma exceção se for feita uma tentativa de criar um argumento com uma string de opção que já esteja em uso:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')>>> parser.add_argument('-f', '--foo', help='ajuda antiga de foo')>>> parser.add_argument('--foo', help='nova ajuda de foo')Traceback (most recent call last): ..ArgumentError: argument --foo: conflicting option string(s): --foo
@end example

Às vezes (por exemplo, ao usar os @ref{304d,,parents}) pode ser útil simplesmente substituir quaisquer argumentos mais antigos com a mesma string de opções. Para obter este comportamento, o valor @code{'resolve'} pode ser fornecido ao argumento @code{conflict_handler=} de @ref{539,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')>>> parser.add_argument('-f', '--foo', help='ajuda antiga de foo')>>> parser.add_argument('--foo', help='nova ajuda de foo')>>> parser.print_help()usage: PROG [-h] [-f FOO] [--foo FOO]options: -h, --help  show this help message and exit -f FOO      ajuda antiga de foo --foo FOO   nova ajuda de foo
@end example

Observe que os objetos @ref{539,,ArgumentParser} só removem uma ação se todas as suas strings de opção forem substituídas. Assim, no exemplo acima, a antiga ação @code{-f/--foo} é mantida como @code{-f}, pois apenas a string de opção @code{--foo} foi substituída.

@node add_help,exit_on_error,conflict_handler,Objetos ArgumentParser
@anchor{library/argparse add-help}@anchor{3053}
@subsubsection add_help


Por padrão, os objetos @ref{539,,ArgumentParser} adicionam uma opção que simplesmente exibe a mensagem de ajuda do analisador sintático. Se @code{-h} ou @code{--help} for fornecido na linha de comando, a ajuda do @code{ArgumentParser} será exibida.

Às vezes, pode ser útil desabilitar o acréscimo desta opção de ajuda. Isto pode ser feito passando @code{False} como o argumento @code{add_help=} para a classe @ref{539,,ArgumentParser}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> parser.add_argument('--foo', help='ajuda de foo')
>>> parser.print_help()
usage: PROG [--foo FOO]

options:
 --foo FOO  ajuda de foo
@end example

A opção de ajuda é normalmente @code{-h/--help}. A exceção a isso é se o @code{prefix_chars=} for especificado e não incluir @code{-}, neste caso @code{-h} e @code{--help} não são opções válidas. Neste caso, o primeiro caractere em @code{prefix_chars} é usado para prefixar as opções de ajuda:

@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,,add_help,Objetos ArgumentParser
@anchor{library/argparse exit-on-error}@anchor{3054}
@subsubsection exit_on_error


Normalmente, quando você passa uma lista de argumentos inválidos para o método @ref{3046,,parse_args()} de uma instância de @ref{539,,ArgumentParser}, ele vai exibir uma `message' para @ref{940,,sys.stderr} e vai sair com o código de status de 2.

Se o usuário quiser detectar erros manualmente, o recurso pode ser habilitado configurando @code{exit_on_error} para @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('Capturando um argumentError')
...
Capturando um argumentError
@end example


Adicionado na versão 3.9.


@node O método add_argument,O método parse_args,Objetos ArgumentParser,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos
@anchor{library/argparse the-add-argument-method}@anchor{3060}
@subsubsection O método add_argument()


@geindex add_argument() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_argument}@anchor{19e}
@deffn {Método} ArgumentParser.add_argument (name or flags..., *[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest][, deprecated])

Define como um único argumento de linha de comando deve ser analisado. Cada parâmetro tem sua própria descrição mais detalhada abaixo, mas resumidamente são eles:


@itemize *

@item 
@ref{3061,,name ou flags} - Um nome ou uma lista de strings de opções, por exemplo. @code{'foo'} ou @code{'-f', '--foo'}.

@item 
@ref{3062,,action} - O tipo básico de ação a ser executada quando esse argumento é encontrado na linha de comando.

@item 
@ref{1692,,nargs} - O número de argumentos de linha de comando que devem ser consumidos.

@item 
@ref{3063,,const} - Um valor constante exigido por algumas seleções @ref{3062,,action} e @ref{1692,,nargs}.

@item 
@ref{3064,,default} - O valor produzido se o argumento estiver ausente da linha de comando e se estiver ausente do objeto espaço de nomes.

@item 
@ref{305b,,type} - O tipo para o qual o argumento de linha de comando deve ser convertido.

@item 
@ref{168f,,choices} - Uma sequência dos valores permitidos para o argumento.

@item 
@ref{3065,,required} - Se a opção de linha de comando pode ou não ser omitida (somente opcionais).

@item 
@ref{3066,,help} - Uma breve descrição do que o argumento faz.

@item 
@ref{3067,,metavar} - Um nome para o argumento nas mensagens de uso.

@item 
@ref{305c,,dest} - O nome do atributo a ser adicionado ao objeto retornado por @ref{3046,,parse_args()}.

@item 
@ref{3068,,deprecated} - Se o uso do argumento foi descontinuado ou não.
@end itemize
@end deffn

As seções a seguir descrevem como cada um deles é usado.

@menu
* name ou flags:: 
* ação:: 
* nargs:: 
* const:: 
* default:: 
* tipo:: 
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Classes de ação:: 

@end menu

@node name ou flags,ação,,O método add_argument
@anchor{library/argparse id5}@anchor{3061}@anchor{library/argparse name-or-flags}@anchor{3069}
@subsubsection name ou flags


O método @ref{19e,,add_argument()} deve saber se um argumento opcional, como @code{-f} ou @code{--foo}, ou um argumento posicional, como uma lista de nomes de arquivos, é esperado. Os primeiros argumentos passados para @ref{19e,,add_argument()} devem, portanto, ser uma série de sinalizadores ou um simples nome de argumento.

Por exemplo, um argumento opcional poderia ser criado como:

@example
>>> parser.add_argument('-f', '--foo')
@end example

enquanto um argumento posicional pode ser criado como:

@example
>>> parser.add_argument('bar')
@end example

Quando @ref{3046,,parse_args()} é chamado, argumentos opcionais serão identificados pelo prefixo @code{-}, e os argumentos restantes serão considerados posicionais:

@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

@node ação,nargs,name ou flags,O método add_argument
@anchor{library/argparse action}@anchor{3062}@anchor{library/argparse id6}@anchor{306a}
@subsubsection ação


Objetos @ref{539,,ArgumentParser} associam argumentos de linha de comando com ações. Essas ações podem fazer praticamente qualquer coisa com os argumentos de linha de comando associados a elas, embora a maioria das ações simplesmente adicione um atributo ao objeto retornado por @ref{3046,,parse_args()}. O argumento nomeado @code{action} especifica como os argumentos da linha de comando devem ser tratados. As ações fornecidas são:


@itemize *

@item 
@code{'store'} - Isso apenas armazena o valor do argumento. Esta é a ação padrão.

@item 
@code{'store_const'} - Isso armazena o valor especificado pelo argumento nomeado @ref{3063,,const}; observe que o argumento nomeado @ref{3063,,const} tem como padrão @code{None}. A ação @code{'store_const'} é mais comumente usada com argumentos opcionais que especificam algum tipo de sinalizador. Por exemplo:

@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'} e @code{'store_false'} - Estes são casos especiais de @code{'store_const'} que armazenam respectivamente os valores @code{True} e @code{False} e com valores padrão de @code{False} e @code{True}:

@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'} - Isso anexa cada valor de argumento a uma lista. É útil permitir para permitir que uma opção seja especificada várias vezes. Se o valor padrão for uma lista não-vazia, o valor analisado vai iniciar com os elementos padrão da lista e quaisquer valores da linha de comando serão anexados após os valores padrão. Exemplo de uso:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='append', default=['0'])
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['0', '1', '2'])
@end example

@item 
@code{'append_const'} - Isso anexa o valor especificado pelo argumento nomeado @ref{3063,,const} a uma lista; observe que o argumento nomeado @ref{3063,,const} tem como padrão @code{None}. A ação @code{'append_const'} é normalmente útil quando vários argumentos precisam armazenar constantes na mesma lista. Por exemplo:

@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'} - Isso anexa cada item de um argumento multivalorado a uma lista. A ação @code{'extend'} é normalmente usada com o valor do argumento nomeado @ref{1692,,nargs} @code{'+'} ou @code{'*'}. Observe que quando @ref{1692,,nargs} é @code{None} (o padrão) ou @code{'?'}, cada caractere da string do argumento será anexado à lista. Exemplo de uso:

@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


Adicionado na versão 3.8.


@item 
@code{'count'} - Isso conta o número de vezes que um argumento ocorre. Por exemplo, isso é útil para aumentar os níveis de verbosidade:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--verbose', '-v', action='count', default=0)
>>> parser.parse_args(['-vvv'])
Namespace(verbose=3)
@end example

Observe que o `padrão' será @code{None}, a menos que seja explicitamente definido como `0'.

@item 
@code{'help'} - Isso imprime uma mensagem de ajuda completa para todas as opções no analisador sintático atual e sai. Por padrão, uma ação de ajuda é adicionada automaticamente ao analisador sintático. Veja @ref{539,,ArgumentParser} para detalhes de como a saída é criada.

@item 
@code{'version'} - Isso espera um argumento nomeado @code{version=} na chamada @ref{19e,,add_argument()} e imprime informações de versão e sai quando invocado:

@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

Você também pode especificar uma ação arbitrária passando uma subclasse @ref{1917,,Action} (por exemplo, @ref{197b,,BooleanOptionalAction}) ou outro objeto que implemente a mesma interface. Somente ações que consomem argumentos de linha de comando (por exemplo, @code{'store'}, @code{'append'}, @code{'extend'} ou ações personalizadas com @code{nargs} diferentes de zero) podem ser usadas com argumentos posicionais.

A maneira recomendada de criar uma ação personalizada é estender @ref{1917,,Action}, substituindo o método @code{__call__()} e opcionalmente os métodos @code{__init__()} e @code{format_usage()}. Você também pode registrar ações personalizadas usando o método @ref{306b,,register()} e referenciá-las pelo nome registrado.

Um exemplo de uma ação 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 mais detalhes, veja @ref{1917,,Action}.

@node nargs,const,ação,O método add_argument
@anchor{library/argparse id7}@anchor{306c}@anchor{library/argparse nargs}@anchor{1692}
@subsubsection nargs


Os objetos @ref{539,,ArgumentParser} geralmente associam um único argumento de linha de comando a uma única ação a ser executada. O argumento nomeado @code{nargs} associa um número diferente de argumentos de linha de comando com uma única ação. Veja também @ref{306d,,Especificando argumentos ambíguos}. Os valores suportados são:


@itemize *

@item 
@code{N} (um inteiro). Os argumentos @code{N} da linha de comando serão reunidos em uma lista. Por exemplo:

@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

Observe que @code{nargs=1} produz uma lista de um item. Isso é diferente do padrão, em que o item é produzido sozinho.
@end itemize

@geindex ? (interrogação);no módulo argparse


@itemize *

@item 
@code{'?'}. Um argumento será consumido da linha de comando, se possível, e produzido como um único item. Se nenhum argumento de linha de comando estiver presente, o valor de @ref{3064,,default} será produzido. Observe que, para argumentos opcionais, há um caso adicional - a string de opções está presente, mas não é seguida por um argumento de linha de comando. Neste caso o valor de @ref{3063,,const} será produzido. Alguns exemplos para ilustrar isso:

@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

Um dos usos mais comuns de @code{nargs='?'} é permitir arquivos de entrada e saída opcionais:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', nargs='?', type=argparse.FileType('r'),
...                     default=sys.stdin)
>>> parser.add_argument('outfile', nargs='?', type=argparse.FileType('w'),
...                     default=sys.stdout)
>>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile=<_io.TextIOWrapper name='input.txt' encoding='UTF-8'>,
          outfile=<_io.TextIOWrapper name='output.txt' encoding='UTF-8'>)
>>> parser.parse_args([])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>,
          outfile=<_io.TextIOWrapper name='<stdout>' encoding='UTF-8'>)
@end example
@end itemize

@geindex * (asterisco);no módulo argparse


@itemize *

@item 
@code{'*'}. Todos os argumentos de linha de comando presentes são reunidos em uma lista. Note que geralmente não faz muito sentido ter mais de um argumento posicional com @code{nargs='*'}, mas vários argumentos opcionais com @code{nargs='*'} são possíveis. Por exemplo:

@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 + (mais);no módulo argparse


@itemize *

@item 
@code{'+'}. Assim como @code{'*'}, todos os argumentos de linha de comando presentes são reunidos em uma lista. Além disso, uma mensagem de erro será gerada se não houver pelo menos um argumento de linha de comando presente. Por exemplo:

@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

Se o argumento nomeado @code{nargs} não for fornecido, o número de argumentos consumidos é determinado por @ref{3062,,action}. Geralmente, isso significa que um único argumento de linha de comando será usado e um único item (não uma lista) será produzido. Ações que não fazem uso de argumentos da linha de comando (por exemplo, @code{'store_const'}) definem @code{nargs=0}.

@node const,default,nargs,O método add_argument
@anchor{library/argparse const}@anchor{3063}@anchor{library/argparse id8}@anchor{306e}
@subsubsection const


O argumento @code{const} de @ref{19e,,add_argument()} é usado para manter valores constantes que não são lidos da linha de comando, mas são necessários para as várias ações @ref{539,,ArgumentParser}. Os dois usos mais comuns são:


@itemize *

@item 
Quando @ref{19e,,add_argument()} é chamado com @code{action='store_const'} ou @code{action='append_const'}. Essas ações adicionam o valor @code{const} a um dos atributos do objeto retornado por @ref{3046,,parse_args()}. Consulte a descrição da @ref{3062,,action} para obter exemplos. Se @code{const} não for fornecido @ref{19e,,add_argument()}, será recebido um valor padrão de @code{None}.

@item 
Quando @ref{19e,,add_argument()} é chamado com strings de opções (como @code{-f} ou @code{--foo}) e @code{nargs='?'}. Isso cria um argumento opcional que pode ser seguido por zero ou um argumento de linha de comando. Ao analisar a linha de comando, se a string de opções for encontrada sem nenhum argumento de linha de comando seguindo, o valor de @code{const} será usado. Veja a descrição de @ref{1692,,nargs} para exemplos.
@end itemize


Alterado na versão 3.11: @code{const=None} por padrão, incluindo quando @code{action='append_const'} ou @code{action='store_const'}.


@node default,tipo,const,O método add_argument
@anchor{library/argparse default}@anchor{3064}@anchor{library/argparse id9}@anchor{306f}
@subsubsection default


Todos os argumentos opcionais e alguns argumentos posicionais podem ser omitidos na linha de comando. O argumento nomeado @code{default} de @ref{19e,,add_argument()}, cujo valor padrão é @code{None}, especifica qual valor deve ser usado se o argumento de linha de comando não estiver presente. Para argumentos opcionais, o valor @code{default} é usado quando a string de opção não estava presente na linha de comando:

@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

Se o espaço de nomes de destino já tiver um atributo definido, a ação `default' não o substituirá:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
Namespace(foo=101)
@end example

Se o valor @code{default} for uma string, o analisador analisa o valor como se fosse um argumento de linha de comando. Em particular, o analisador aplica qualquer argumento de conversão @ref{305b,,type}, se fornecido, antes de definir o atributo no valor de retorno @ref{3047,,Namespace}. Caso contrário, o analisador usa o valor como está:

@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 posicionais com @ref{1692,,nargs} igual a @code{?} ou @code{*}, o valor @code{default} é usado quando nenhum argumento de linha de comando estava 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

Para argumentos obrigatórios, isto é, marcados com @ref{3065,,required}, o valor @code{default} é ignorado. Por exemplo, isso se aplica a argumentos posicionais com valores de @ref{1692,,nargs} diferentes de @code{?} ou @code{*}, ou argumentos opcionais marcados como @code{required=True}.

Fornecer @code{default=argparse.SUPPRESS} faz com que nenhum atributo seja adicionado se o argumento da linha de comando não estiver 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 tipo,choices,default,O método add_argument
@anchor{library/argparse argparse-type}@anchor{3070}@anchor{library/argparse type}@anchor{305b}
@subsubsection tipo


Por padrão, o analisador sintático lê argumentos de linha de comando como strings simples. No entanto, muitas vezes a string da linha de comando deve ser interpretada como outro tipo, como @ref{2f7,,float} ou @ref{257,,int}. O argumento nomeado @code{type} para @ref{19e,,add_argument()} permite que qualquer verificação de tipo e conversões de tipo necessárias sejam realizadas.

Se o argumento nomeado @ref{305b,,type} for usado com @ref{3064,,default}, o conversor de tipo só será aplicado se o padrão for uma string.

O argumento para @code{type} pode ser um chamável que aceite uma única string ou o nome de um tipo registrado (veja @ref{306b,,register()}). Se a função levantar @ref{3071,,ArgumentTypeError}, @ref{2c3,,TypeError} ou @ref{202,,ValueError}, a exceção será capturada e uma mensagem de erro bem formatada será exibida. Nenhum outro tipo de exceção é tratado.

Tipos e funções embutidas comuns podem ser usados como conversores de tipo:

@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('dest_file', type=argparse.FileType('w', encoding='latin-1'))
parser.add_argument('datapath', type=pathlib.Path)
@end example

Funções definidas pelo usuário também podem ser usadas:

@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(['"Um conto de duas cidades"'])
Namespace(short_title='"um-cont-de-duas-cida')
@end example

A função @ref{468,,bool()} não é recomendada como conversor de tipo. Tudo o que ele faz é converter strings vazias em @code{False} e strings não vazias em @code{True}. Geralmente não é isso que se deseja.

Em geral, o argumento nomeado @code{type} é uma conveniência que só deve ser usada para conversões simples que só podem gerar uma das três exceções suportadas. Qualquer coisa com tratamento de erros ou gerenciamento de recursos mais interessante deve ser feita posteriormente, após a análise dos argumentos.

Por exemplo, conversões JSON ou YAML têm casos de erros complexos que exigem relatórios melhores do que os fornecidos pelo argumento nomeado @code{type}. Um @ref{e4d,,JSONDecodeError} não seria bem formatado e uma exceção @ref{42b,,FileNotFoundError} não seria tratada.

Mesmo @ref{f4d,,FileType} tem suas limitações para uso com o argumento nomeado @code{type}. Se um argumento usar @ref{f4d,,FileType} e um argumento subsequente falhar, um erro será relatado, mas o arquivo não será fechado automaticamente. Neste caso, seria melhor esperar até que o analisador tenha sido executado e então usar a instrução @ref{5d2,,with} para gerenciar os arquivos.

Para verificadores de tipo que simplesmente verificam um conjunto fixo de valores, considere usar o argumento nomeado @ref{168f,,choices}.

@node choices,required,tipo,O método add_argument
@anchor{library/argparse choices}@anchor{168f}@anchor{library/argparse id10}@anchor{3072}
@subsubsection choices


Alguns argumentos de linha de comando devem ser selecionados em um conjunto restrito de valores. Eles podem ser tratados passando um objeto sequência como o argumento nomeado `choices' para @ref{19e,,add_argument()}. Quando a linha de comando for analisada, os valores dos argumentos serão verificados e uma mensagem de erro será exibida se o argumento não for um dos valores aceitáveis:

@example
>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['pedra', 'papel', 'tesoura'])
>>> parser.parse_args(['padra'])
Namespace(move='padr')
>>> parser.parse_args(['fogo'])
usage: game.py [-h] @{pedra,papel,tesoura@}
game.py: error: argument move: invalid choice: 'fogo' (choose from 'pedra',
'papel', 'tesoura')
@end example

Qualquer sequência pode ser passada como o valor `choices', portanto objetos @ref{611,,list}, objetos @ref{370,,tuple} e sequências personalizadas são todos suportados.

O uso de @ref{630,,enum.Enum} não é recomendado porque é difícil controlar sua aparência no uso, na ajuda e nas mensagens de erro.

Observe que `choices' são verificadas após a realização de quaisquer conversões de @ref{305b,,type}, portanto, os objetos em `choices' devem corresponder ao @ref{305b,,type} especificado. Isso pode fazer com que `choices' pareçam estranhos no uso, na ajuda ou em mensagens de erro.

Para manter `choices' fácel de usar, considere um invólucro de tipo personalizado que converta e formate valores, ou omita @ref{305b,,type} e lide com a conversão no código da sua aplicação.

As opções formatadas substituem o `metavar' padrão que normalmente é derivado de `dest'. Geralmente é isso que você deseja porque o usuário nunca vê o parâmetro `dest'. Se esta exibição não for desejável (talvez porque haja muitas opções), basta especificar um @ref{3067,,metavar} explícito.

@node required,help,choices,O método add_argument
@anchor{library/argparse id11}@anchor{3073}@anchor{library/argparse required}@anchor{3065}
@subsubsection required


Em geral, o módulo @code{argparse} presume que sinalizadores como @code{-f} e @code{--bar} indicam argumentos `opcionais', que sempre podem ser omitidos na linha de comando. Para tornar uma opção obrigatória, @code{True} pode ser especificado para o argumento nomeado @code{required=} para @ref{19e,,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 mostra o exemplo, se uma opção estiver marcada como @code{required}, @ref{3046,,parse_args()} reportará um erro se essa opção não estiver presente na linha de comando.

@cartouche
@quotation Nota 
As opções obrigatórias são geralmente consideradas inadequadas porque os usuários esperam que as `opções' sejam `opcionais' e, portanto, devem ser evitadas quando possível.
@end quotation
@end cartouche

@node help,metavar,required,O método add_argument
@anchor{library/argparse help}@anchor{3066}@anchor{library/argparse id12}@anchor{3074}
@subsubsection help


O valor @code{help} é uma string contendo uma breve descrição do argumento. Quando um usuário solicita ajuda (geralmente usando @code{-h} ou @code{--help} na linha de comando), estas descrições de @code{help} serão exibidas com cada argumento.

As strings @code{help} podem incluir vários especificadores de formato para evitar a repetição de coisas como o nome do programa ou o argumento @ref{3064,,default}. Os especificadores disponíveis incluem o nome do programa, @code{%(prog)s} e a maioria dos argumentos nomeados para @ref{19e,,add_argument()}, por exemplo. @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 a string de ajuda oferece suporte à formatação com %, se você quiser que um literal @code{%} apareça na string de ajuda, você deve escapá-lo como @code{%%}.

@code{argparse} oferece suporte a silenciar a entrada de ajuda para certas opções, definindo o valor @code{help} como @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,O método add_argument
@anchor{library/argparse id13}@anchor{3075}@anchor{library/argparse metavar}@anchor{3067}
@subsubsection metavar


Quando @ref{539,,ArgumentParser} gera mensagens de ajuda, ele precisa de alguma forma de se referir a cada argumento esperado. Por padrão, os objetos @code{ArgumentParser} usam o valor @ref{305c,,dest} como o “nome” de cada objeto. Por padrão, para ações de argumentos posicionais, o valor @ref{305c,,dest} é usado diretamente, e para ações de argumentos opcionais, o valor @ref{305c,,dest} é maiúsculo. Portanto, um único argumento posicional com @code{dest='bar'} será referido como @code{bar}. Um único argumento opcional @code{--foo} que deve ser seguido por um único argumento de linha de comando será referido como @code{FOO}. Um exemplo:

@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

Um nome alternativo pode ser especificado com @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

Observe que @code{metavar} apenas altera o nome `exibido' - o nome do atributo no objeto @ref{3046,,parse_args()} ainda é determinado pelo valor @ref{305c,,dest}.

Valores diferentes de @code{nargs} podem fazer com que o metavar seja usado múltiplas vezes. Fornecer uma tupla para @code{metavar} especifica uma exibição diferente para cada um dos 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,O método add_argument
@anchor{library/argparse dest}@anchor{305c}@anchor{library/argparse id14}@anchor{3076}
@subsubsection dest


A maioria das ações @ref{539,,ArgumentParser} adiciona algum valor como um atributo do objeto retornado por @ref{3046,,parse_args()}. O nome deste atributo é determinado pelo argumento nomeado @code{dest} de @ref{19e,,add_argument()}. Para ações de argumento posicional, @code{dest} é normalmente fornecido como o primeiro argumento para @ref{19e,,add_argument()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar')
>>> parser.parse_args(['XXX'])
Namespace(bar='XXX')
@end example

Para ações de argumentos opcionais, o valor de @code{dest} é normalmente inferido das strings de opções. @ref{539,,ArgumentParser} gera o valor de @code{dest} pegando a primeira string de opção longa e removendo a string inicial @code{--}. Se nenhuma string de opção longa for fornecida, @code{dest} será derivado da primeira string de opção curta removendo o caractere @code{-} inicial.  Quaisquer caracteres @code{-} internos serão convertidos em caracteres @code{_} para garantir que a string seja um nome de atributo válido. Os exemplos abaixo ilustram esse comportamento:

@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 um nome de atributo personalizado seja fornecido:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')
@end example

@node deprecated,Classes de ação,dest,O método add_argument
@anchor{library/argparse deprecated}@anchor{3068}@anchor{library/argparse id15}@anchor{3077}
@subsubsection deprecated


Durante a vida de um projeto, alguns argumentos podem precisar ser removidos da linha de comando. Antes de removê-los, você deve informar aos seus usuários que os argumentos estão descontinuados e serão removidos. O argumento nomeado @code{deprecated} de @ref{19e,,add_argument()}, cujo padrão é @code{False}, especifica se o argumento está descontinuado e será removido no futuro. Para argumentos, se @code{deprecated} for @code{True}, então um aviso será enviado para @ref{940,,sys.stderr} (saída de erro) quando o argumento for usado:

@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


Adicionado na versão 3.13.


@node Classes de ação,,deprecated,O método add_argument
@anchor{library/argparse action-classes}@anchor{3078}
@subsubsection Classes de ação


As classes @code{Action} implementam a API de Action, um chamável que retorna um chamável que processa argumentos da linha de comando. Qualquer objeto que siga esta API pode ser passado como parâmetro @code{action} para @ref{19e,,add_argument()}.

@geindex Action (classe em argparse)
@anchor{library/argparse argparse Action}@anchor{1917}
@deffn {Classe} argparse.Action (option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Objetos @code{Action} são usados por um @ref{539,,ArgumentParser} para representar as informações necessárias para analisar um único argumento de uma ou mais strings da linha de comando. A classe @code{Action} deve aceitar os dois argumentos posicionais mais quaisquer argumentos nomeados passados para @ref{19e,,ArgumentParser.add_argument()}, exceto o próprio @code{action}.

Instâncias de @code{Action} (ou valor de retorno de qualquer chamável para o parâmetro @code{action}) devem ter atributos @code{dest}, @code{option_strings}, @code{default}, @code{type}, @code{required}, @code{help}, etc. definidos. A maneira mais fácil de garantir que esses atributos sejam definidos é chamar @code{Action.__init__()}.

@geindex __call__() (método argparse.Action)
@anchor{library/argparse argparse Action __call__}@anchor{3079}
@deffn {Método} __call__ (parser, namespace, values, option_string=None)

As instâncias de @code{Action} devem ser chamáveis, portanto, as subclasses devem substituir o método @code{__call__()}, que deve aceitar quatro parâmetros:


@itemize *

@item 
`parser' - O objeto @ref{539,,ArgumentParser} que contém esta ação.

@item 
`namespace' - O objeto @ref{3047,,Namespace} que será retornado por @ref{3046,,parse_args()}. A maioria das ações adicionam um atributo a este objeto usando @ref{22f3,,setattr()}.

@item 
`values' - Os argumentos de linha de comando associados, com qualquer conversões de tipo aplicadas. Conversões de tipo são especificadas com o argumento nomeado @ref{305b,,type} para @ref{19e,,add_argument()}.

@item 
`option_string' - A string da opção que foi usada para invocar esta ação. O argumento @code{option_string} é opcional e estará ausente se a ação estiver associada a um argumento posicional.
@end itemize

O método @code{__call__()} pode executar ações arbitrárias, mas normalmente definirá atributos em @code{namespace} com base em @code{dest} e @code{values}.
@end deffn

@geindex format_usage() (método argparse.Action)
@anchor{library/argparse argparse Action format_usage}@anchor{307a}
@deffn {Método} format_usage ()

As subclasses de @code{Action} podem definir um método @code{format_usage()} que não recebe argumento e retorna uma string que será usada ao exibir a mensagem de uso do programa. Se tal método não for fornecido, um padrão sensato será usado.
@end deffn
@end deffn

@geindex BooleanOptionalAction (classe em argparse)
@anchor{library/argparse argparse BooleanOptionalAction}@anchor{197b}
@deffn {Classe} argparse.BooleanOptionalAction

Uma subclasse de @ref{1917,,Action} para manipular sinalizadores booleanos com opções positivas e negativas. Adicionar um único argumento, como @code{--foo}, cria automaticamente as opções @code{--foo} e @code{--no-foo}, armazenando @code{True} e @code{False} respectivamente:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
>>> parser.parse_args(['--no-foo'])
Namespace(foo=False)
@end example


Adicionado na versão 3.9.

@end deffn

@node O método parse_args,Outros utilitários,O método add_argument,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos
@anchor{library/argparse the-parse-args-method}@anchor{307b}
@subsubsection O método parse_args()


@geindex parse_args() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_args}@anchor{3046}
@deffn {Método} ArgumentParser.parse_args (args=None, namespace=None)

Converte strings de argumento em objetos e os atribui como atributos do espaço de nomes. Retorna o espaço de nomes preenchido.

Chamadas anteriores para @ref{19e,,add_argument()} determinam exatamente quais objetos são criados e como eles são atribuídos. Veja a documentação de @code{add_argument()} para detalhes.


@itemize *

@item 
@ref{307c,,args} - Lista de strings para analisar. O padrão é obtido de @ref{12a6,,sys.argv}.

@item 
@ref{307d,,namespace} - Um objeto para receber os atributos. O padrão é um novo objeto @ref{3047,,Namespace} vazio.
@end itemize
@end deffn

@menu
* Sintaxe de valores da opção:: 
* Argumentos inválidos:: 
* Argumentos contendo -:: 
* Abreviações de argumento (correspondência de prefixo): Abreviações de argumento correspondência de prefixo. 
* Além do sys.argv: Além do sys argv. 
* O objeto Namespace:: 

@end menu

@node Sintaxe de valores da opção,Argumentos inválidos,,O método parse_args
@anchor{library/argparse option-value-syntax}@anchor{307e}
@subsubsection Sintaxe de valores da opção


O método @ref{3046,,parse_args()} provê várias maneiras de especificar o valor de uma opção (se ele pegar uma). No caso mais simples, a opção e seu valor são passados como dois 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

Para opções longas (opções com nomes maiores que um único caractere), a opção e o valor também podem ser passados como um único argumento de linha de comando, usando @code{=} para separá-los:

@example
>>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)
@end example

Para opções curtas (opções com apenas um caractere), a opção e seu valor podem ser concatenados:

@example
>>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')
@end example

Várias opções curtas podem ser unidas, usando apenas um único prefixo @code{-}, desde que apenas a última opção (ou nenhuma delas) exija um 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 inválidos,Argumentos contendo -,Sintaxe de valores da opção,O método parse_args
@anchor{library/argparse invalid-arguments}@anchor{307f}
@subsubsection Argumentos inválidos


Ao analisar a linha de comando, @ref{3046,,parse_args()} verifica uma variedade de erros, incluindo opções ambíguas, tipos inválidos, opções inválidas, número incorreto de argumentos posicionais, etc. Quando encontra tal erro, ele sai e imprime o erro junto com uma mensagem de uso:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', type=int)
>>> parser.add_argument('bar', nargs='?')

>>> # tipo inválido
>>> parser.parse_args(['--foo', 'spam'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: argument --foo: invalid int value: 'spam'

>>> # opção inválida
>>> parser.parse_args(['--bar'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: no such option: --bar

>>> # número errado de argumentos
>>> parser.parse_args(['spam', 'badger'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: extra arguments found: badger
@end example

@node Argumentos contendo -,Abreviações de argumento correspondência de prefixo,Argumentos inválidos,O método parse_args
@anchor{library/argparse arguments-containing}@anchor{3080}
@subsubsection Argumentos contendo @code{-}


O método @ref{3046,,parse_args()} tenta mostrar erros sempre que o usuário claramente cometeu um erro, mas algumas situações são inerentemente ambíguas. Por exemplo, o argumento de linha de comando @code{-1} pode ser uma tentativa de especificar uma opção ou uma tentativa de fornecer um argumento posicional. O método @ref{3046,,parse_args()} é cauteloso aqui: argumentos posicionais só podem começar com @code{-} se eles se parecerem com números negativos e não houver opções no analisador sintático que se pareçam com números negativos:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('foo', nargs='?')

>>> # nenhuma opção de número negativo, então -1 é um argumento posicional
>>> parser.parse_args(['-x', '-1'])
Namespace(foo=None, x='-1')

>>> # nenhuma opção de número negativo, então -1 e -5 são argumentos posicionais
>>> 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='?')

>>> # opção de número negativo presente, então -1 é uma opção
>>> parser.parse_args(['-1', 'X'])
Namespace(foo=None, one='X')

>>> # opção de número negativo presente, então -2 é uma opção
>>> parser.parse_args(['-2'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: no such option: -2

>>> # opções de número negativo presentes, então ambos -1s são opções
>>> parser.parse_args(['-1', '-1'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: argument -1: expected one argument
@end example

Se você tiver argumentos posicionais que devem começar com @code{-} e não se parecem com números negativos, você pode inserir o pseudoargumento @code{'--'} que informa @ref{3046,,parse_args()} que tudo depois disso é um argumento posicional:

@example
>>> parser.parse_args(['--', '-f'])
Namespace(foo='-f', one=None)
@end example

Veja também @ref{306d,,o tutorial do argparse sobre argumentos ambíguos} para mais detalhes.

@node Abreviações de argumento correspondência de prefixo,Além do sys argv,Argumentos contendo -,O método parse_args
@anchor{library/argparse argument-abbreviations-prefix-matching}@anchor{3081}@anchor{library/argparse prefix-matching}@anchor{de7}
@subsubsection Abreviações de argumento (correspondência de prefixo)


O método @ref{3046,,parse_args()} @ref{de8,,por padrão} permite que opções longas sejam abreviadas para um prefixo, se a abreviação não for ambígua (o prefixo corresponde a uma opção ú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

Um erro é produzido para argumentos que podem produzir mais de uma opção. Este recurso pode ser desabilitado definindo @ref{de8,,allow_abbrev} como @code{False}.

@node Além do sys argv,O objeto Namespace,Abreviações de argumento correspondência de prefixo,O método parse_args
@anchor{library/argparse args}@anchor{307c}@anchor{library/argparse beyond-sys-argv}@anchor{3082}
@subsubsection Além do @code{sys.argv}


Às vezes, pode ser útil ter uma instância de @ref{539,,ArgumentParser} analisando argumentos diferentes daqueles de @ref{12a6,,sys.argv}. Isso pode ser feito passando uma lista de strings para @ref{3046,,parse_args()}. Isso é útil para testar no prompt interativo:

@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 O objeto Namespace,,Além do sys argv,O método parse_args
@anchor{library/argparse namespace}@anchor{307d}@anchor{library/argparse the-namespace-object}@anchor{3083}
@subsubsection O objeto Namespace


@geindex Namespace (classe em argparse)
@anchor{library/argparse argparse Namespace}@anchor{3047}
@deffn {Classe} argparse.Namespace

Classe simples usada por padrão por @ref{3046,,parse_args()} para criar um objeto contendo atributos e retorná-lo.

Esta classe é deliberadamente simples, apenas uma subclasse @ref{a96,,object} com uma representação de string legível. Se você preferir ter uma visão dos atributos do tipo dict, você pode usar o idioma padrão do Python, @ref{1bba,,vars()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
@{'foo': 'BAR'@}
@end example

Também pode ser útil ter um @ref{539,,ArgumentParser} atribuindo atributos a um objeto já existente, em vez de um novo objeto @ref{3047,,Namespace}. Isso pode ser obtido especificando o argumento nomeado @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 Outros utilitários,Exceções<9>,O método parse_args,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos
@anchor{library/argparse other-utilities}@anchor{3084}
@subsubsection Outros utilitários


@menu
* Subcomandos:: 
* Objetos FileType:: 
* Grupos de argumentos:: 
* Exclusão mútua:: 
* Padrões do analisador sintático:: 
* Imprimindo a ajuda:: 
* Análise parcial:: 
* Personalizando a análise de arquivos:: 
* Métodos de saída:: 
* Análise misturada:: 
* Registrando ações e tipos personalizados:: 

@end menu

@node Subcomandos,Objetos FileType,,Outros utilitários
@anchor{library/argparse subcommands}@anchor{3085}
@subsubsection Subcomandos


@geindex add_subparsers() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_subparsers}@anchor{c31}
@deffn {Método} ArgumentParser.add_subparsers (*[, title][, description][, prog][, parser_class][, action][, dest][, required][, help][, metavar])

Muitos programas dividem sua funcionalidade em vários subcomandos, por exemplo, o programa @code{svn} pode invocar subcomandos como @code{svn checkout}, @code{svn update} e @code{svn commit}. Dividir a funcionalidade dessa forma pode ser uma ideia particularmente boa quando um programa executa várias funções diferentes que exigem diferentes tipos de argumentos de linha de comando. @ref{539,,ArgumentParser} oferece suporte à criação de tais subcomandos por meio do método @code{add_subparsers()}. O método @code{add_subparsers()} é normalmente chamado sem argumentos e retorna um objeto de ação especial. Este objeto tem um único método, @code{add_parser()}, que recebe um nome de comando e quaisquer argumentos do construtor @code{ArgumentParser} e retorna um objeto @code{ArgumentParser} que pode ser modificado normalmente.

Descrição de parâmetros:


@itemize *

@item 
`title' - título para o grupo de subanalisadores na saída de ajuda; por padrão “subcomandos” se a descrição for fornecida, caso contrário, usa o título para argumentos posicionais

@item 
`description' - descrição para o grupo de subanalisadores na saída de ajuda, por padrão @code{None}

@item 
`prog' - informações de uso que serão exibidas com a ajuda do subcomando, por padrão o nome do programa e quaisquer argumentos posicionais antes do argumento do subanalisador

@item 
`parser_class' - classe que será usada para criar instâncias de subanalisadores, por padrão a classe do analisador atual (por exemplo, @ref{539,,ArgumentParser})

@item 
@ref{3062,,action} - o tipo básico de ação a ser executada quando esse argumento é encontrado na linha de comando

@item 
@ref{305c,,dest} - nome do atributo sob o qual o nome do subcomando será armazenado; por padrão @code{None} e nenhum valor é armazenado

@item 
@ref{3065,,required} - Se um subcomando deve ou não ser fornecido, por padrão @code{False} (adicionado em 3.7)

@item 
@ref{3066,,help} - ajuda para o grupo de subanalisadores na saída de ajuda, por padrão @code{None}

@item 
@ref{3067,,metavar} - string que apresenta os subcomandos disponíveis na ajuda; por padrão é @code{None} e apresenta os subcomandos no formato @{cmd1, cmd2, ..@}
@end itemize

Alguns exemplos de uso:

@example
>>> # cria o analisador de nível superior>>> parser = argparse.ArgumentParser(prog='PROG')>>> parser.add_argument('--foo', action='store_true', help='foo help')>>> subparsers = parser.add_subparsers(help='subcommand help')>>>>>> # cria o analisador para o comando "a">>> parser_a = subparsers.add_parser('a', help='a help')>>> parser_a.add_argument('bar', type=int, help='bar help')>>>>>> # cria o analisador para o comando "b">>> parser_b = subparsers.add_parser('b', help='b help')>>> parser_b.add_argument('--baz', choices=('X', 'Y', 'Z'), help='baz help')>>>>>> # analisa algumas listas de argumentos>>> parser.parse_args(['a', '12'])Namespace(bar=12, foo=False)>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])Namespace(baz='Z', foo=True)
@end example

Note que o objeto retornado por @ref{3046,,parse_args()} conterá apenas atributos para o analisador principal e para o subanalisador selecionado pela linha de comando (e não para quaisquer outros subanalisadores). Então, no exemplo acima, quando o comando @code{a} é especificado, apenas os atributos @code{foo} e @code{bar} estão presentes, e quando o comando @code{b} é especificado, apenas os atributos @code{foo} e @code{baz} estão presentes.

Similarmente, quando uma mensagem de ajuda é solicitada de um subanalisador, apenas a ajuda para aquele parser em particular será exibida. A mensagem de ajuda não incluirá mensagens do analisador sintático pai nem do analisador sintático irmão. (Uma mensagem de ajuda para cada comando do subanalisador pode, entretanto, ser fornecida passando o argumento @code{help=} para @code{add_parser()}, como acima.)

@example
>>> parser.parse_args(['--help'])usage: PROG [-h] [--foo] @{a,b@} ...positional arguments:  @{a,b@}   subcommand help    a     a help    b     b helpoptions:  -h, --help  show this help message and exit  --foo   foo help>>> parser.parse_args(['a', '--help'])usage: PROG a [-h] barpositional arguments:  bar     bar helpoptions:  -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

O método @ref{c31,,add_subparsers()} também aceita os argumentos nomeados @code{title} e @code{description}. Quando qualquer um deles estiver presente, os comandos do subanalisador aparecerão em seu próprio grupo na saída de ajuda. Por exemplo:

@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 exitsubcommands:  valid subcommands  @{foo,bar@}   additional help
@end example

Além disso, @code{add_parser()} oferece suporte a um argumento `aliases' adicional, que permite que múltiplas strings se refiram ao mesmo subanalisador. Este exemplo, como @code{svn}, alias @code{co} como uma abreviação para @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()} também aceita um argumento adicional `deprecated', que permite descontinuar o subanalisador.

@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


Adicionado na versão 3.13.


Uma maneira particularmente eficaz de lidar com subcomandos é combinar o uso do método @ref{c31,,add_subparsers()} com chamadas ao método @ref{305e,,set_defaults()}, para que cada subanalisador saiba qual função Python deve executar. Por exemplo:

@example
>>> # funções do subanalisador functions>>> def foo(args):...     print(args.x * args.y)...>>> def bar(args):...     print('((%s))' % args.z)...>>> # cria o analisador de nível superior>>> parser = argparse.ArgumentParser()>>> subparsers = parser.add_subparsers(required=True)>>>>>> # cria o analisador do comando "foo">>> 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)>>>>>> # cria o analisador do comando "foo">>> parser_bar = subparsers.add_parser('bar')>>> parser_bar.add_argument('z')>>> parser_bar.set_defaults(func=bar)>>>>>> # analisa os argumentos e chama a função que for selecionada>>> args = parser.parse_args('foo 1 -x 2'.split())>>> args.func(args)2.0>>>>>> # analisa os argumentos e chama a função que foi selecionada>>> args = parser.parse_args('bar XYZYX'.split())>>> args.func(args)((XYZYX))
@end example

Dessa forma, você pode deixar @ref{3046,,parse_args()} fazer o trabalho de chamar a função apropriada após a análise sintática do argumento ser concluída. Associar funções a ações como essa é, normalmente, a maneira mais fácil de lidar com as diferentes ações de cada um dos seus subanalisadores. No entanto, se for necessário verificar o nome do subanalisador que foi invocado, o argumento nomeado @code{dest} para a chamada @ref{c31,,add_subparsers()} funcionará:

@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


Alterado na versão 3.7: Novo parâmetro somente-nomeado `required'.

@end deffn

@node Objetos FileType,Grupos de argumentos,Subcomandos,Outros utilitários
@anchor{library/argparse filetype-objects}@anchor{3086}
@subsubsection Objetos FileType


@geindex FileType (classe em argparse)
@anchor{library/argparse argparse FileType}@anchor{f4d}
@deffn {Classe} argparse.FileType (mode='r', bufsize=-1, encoding=None, errors=None)

A fábrica @ref{f4d,,FileType} cria objetos que podem ser passados para o argumento de tipo de @ref{19e,,ArgumentParser.add_argument()}. Argumentos que têm objetos @ref{f4d,,FileType} como seu tipo abrirão argumentos de linha de comando como arquivos com os modos solicitados, tamanhos de buffer, codificações e tratamento de erros (veja a função @ref{51c,,open()} para mais detalhes):

@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

Objetos FileType entendem o pseudoargumento @code{'-'} e o convertem automaticamente em @ref{53d,,sys.stdin} para objetos @ref{f4d,,FileType} legíveis e @ref{ae6,,sys.stdout} para objetos @ref{f4d,,FileType} graváveis:

@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


Alterado na versão 3.4: Adicionados os parâmetros `encodings' e `errors'.

@end deffn

@node Grupos de argumentos,Exclusão mútua,Objetos FileType,Outros utilitários
@anchor{library/argparse argument-groups}@anchor{3087}
@subsubsection Grupos de argumentos


@geindex add_argument_group() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_argument_group}@anchor{3088}
@deffn {Método} ArgumentParser.add_argument_group (title=None, description=None, *[, argument_default][, conflict_handler])

Por padrão, @ref{539,,ArgumentParser} agrupa argumentos de linha de comando em “argumentos posicionais” e “opções” ao exibir mensagens de ajuda. Quando há um melhor agrupamento conceitual de argumentos do que este padrão, grupos apropriados podem ser criados usando o método @code{add_argument_group()}:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group = parser.add_argument_group('grupo')
>>> group.add_argument('--foo', help='ajuda de foo')
>>> group.add_argument('bar', help='ajuda de bar')
>>> parser.print_help()
usage: PROG [--foo FOO] bar

grupo:
  bar    ajuda de bar
  --foo FOO  ajuda de foo
@end example

O método @ref{3088,,add_argument_group()} retorna um objeto de grupo de argumentos que tem um método @ref{19e,,add_argument()} como um @ref{539,,ArgumentParser} regular. Quando um argumento é adicionado ao grupo, o analisador o trata como um argumento normal, mas exibe o argumento em um grupo separado para mensagens de ajuda. O método @code{add_argument_group()} aceita argumentos `title' e `description' que podem ser usados para personalizar esta exibição:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group1 = parser.add_argument_group('grupo1', 'descrição do grupo1')
>>> group1.add_argument('foo', help='ajuda de foo')
>>> group2 = parser.add_argument_group('grupo2', 'descrição do grupo2')
>>> group2.add_argument('--bar', help='ajuda de bar')
>>> parser.print_help()
usage: PROG [--bar BAR] foo

grupo1:
  descrição de grupo1

  foo    ajuda de foo

grupo2:
  descrição de grupo2

  --bar BAR  ajuda de bar
@end example

Os parâmetros opcionais somente-nomeados @ref{3051,,argument_default} e @ref{3052,,conflict_handler} permitem um controle mais refinado do comportamento do grupo de argumentos. Esses parâmetros têm o mesmo significado que no construtor @ref{539,,ArgumentParser}, mas se aplicam especificamente ao grupo de argumentos em vez de ao analisador sintático inteiro.

Observe que quaisquer argumentos que não estejam nos grupos definidos pelo usuário retornarão às seções usuais de “argumentos posicionais” e “argumentos opcionais”.


Alterado na versão 3.11: Chamar @ref{3088,,add_argument_group()} em um grupo de argumentos está descontinuado. Esse recurso nunca foi suportado e nem sempre funciona corretamente. A função existe na API por acidente por herança e será removida no futuro.

@end deffn

@node Exclusão mútua,Padrões do analisador sintático,Grupos de argumentos,Outros utilitários
@anchor{library/argparse mutual-exclusion}@anchor{3089}
@subsubsection Exclusão mútua


@geindex add_mutually_exclusive_group() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser add_mutually_exclusive_group}@anchor{308a}
@deffn {Método} ArgumentParser.add_mutually_exclusive_group (required=False)

Cria um grupo mutuamente exclusivo. @code{argparse} garantirá que apenas um dos argumentos no grupo mutuamente exclusivo esteja presente na linha de comando:

@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

O método @ref{308a,,add_mutually_exclusive_group()} também aceita um argumento `obrigatório', para indicar que pelo menos um dos argumentos mutuamente exclusivos é necessário:

@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

Observe que atualmente grupos de argumentos mutuamente exclusivos não oferecem suporte aos argumentos `title' e `description' de @ref{3088,,add_argument_group()}. No entanto, um grupo mutuamente exclusivo pode ser adicionado a um grupo de argumentos que tenha um título e uma descrição. Por exemplo:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_argument_group('Título do grupo', 'Descrição do grupo')
>>> exclusive_group = group.add_mutually_exclusive_group(required=True)
>>> exclusive_group.add_argument('--foo', help='ajuda de foo')
>>> exclusive_group.add_argument('--bar', help='ajuda de bar')
>>> parser.print_help()
usage: PROG [-h] (--foo FOO | --bar BAR)

options:
  -h, --help  show this help message and exit

Título do grupo:
  Descrição do grupo

  --foo FOO   foo help
  --bar BAR   bar help
@end example


Alterado na versão 3.11: Chamar @ref{3088,,add_argument_group()} ou @ref{308a,,add_mutually_exclusive_group()} em um grupo mutuamente exclusivo está descontinuado. Esses recursos nunca foram suportados e nem sempre funcionam corretamente. As funções existem na API por acidente por herança e serão removidas no futuro.

@end deffn

@node Padrões do analisador sintático,Imprimindo a ajuda,Exclusão mútua,Outros utilitários
@anchor{library/argparse parser-defaults}@anchor{308b}
@subsubsection Padrões do analisador sintático


@geindex set_defaults() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser set_defaults}@anchor{305e}
@deffn {Método} ArgumentParser.set_defaults (**kwargs)

Na maioria das vezes, os atributos do objeto retornado por @ref{3046,,parse_args()} serão totalmente determinados pela inspeção dos argumentos da linha de comando e das ações dos argumentos. @ref{305e,,set_defaults()} permite que alguns atributos adicionais que são determinados sem qualquer inspeção da linha de comando sejam adicionados:

@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

Observe que os valores padrão podem ser definidos tanto no nível do analisador sintático usando @ref{305e,,set_defaults()} quanto no nível do argumento usando @ref{19e,,add_argument()}. Se ambos forem chamados para o mesmo argumento, o último valor padrão definido para o argumento será usado.

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='bar')
>>> parser.set_defaults(foo='spam')
>>> parser.parse_args([])
Namespace(foo='spam')
@end example

Padrões de nível de analisador podem ser particularmente úteis ao trabalhar com vários analisadores. Veja o método @ref{c31,,add_subparsers()} para um exemplo desse tipo.
@end deffn

@geindex get_default() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser get_default}@anchor{308c}
@deffn {Método} ArgumentParser.get_default (dest)

Obtém o valor padrão para um atributo de espaço de nomes, conforme definido por @ref{19e,,add_argument()} ou por @ref{305e,,set_defaults()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='badger')
>>> parser.get_default('foo')
'badger'
@end example
@end deffn

@node Imprimindo a ajuda,Análise parcial,Padrões do analisador sintático,Outros utilitários
@anchor{library/argparse printing-help}@anchor{308d}
@subsubsection Imprimindo a ajuda


Na maioria das aplicações típicas, @ref{3046,,parse_args()} cuidará da formatação e da impressão de quaisquer mensagens de uso ou erro. No entanto, vários métodos de formatação estão disponíveis:

@geindex print_usage() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser print_usage}@anchor{308e}
@deffn {Método} ArgumentParser.print_usage (file=None)

Imprime uma breve descrição de como o @ref{539,,ArgumentParser} deve ser invocado na linha de comando. Se `file' for @code{None}, @ref{ae6,,sys.stdout} será presumido.
@end deffn

@geindex print_help() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser print_help}@anchor{308f}
@deffn {Método} ArgumentParser.print_help (file=None)

Imprime uma mensagem de ajuda, incluindo o uso do programa e informações sobre os argumentos registrados com o @ref{539,,ArgumentParser}. Se `file' for @code{None}, @ref{ae6,,sys.stdout} será presumido.
@end deffn

Também há variantes desses métodos que simplesmente retornam uma string em vez de imprimi-la:

@geindex format_usage() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser format_usage}@anchor{1b42}
@deffn {Método} ArgumentParser.format_usage ()

Retorna uma string contendo uma breve descrição de como o @ref{539,,ArgumentParser} deve ser invocado na linha de comando.
@end deffn

@geindex format_help() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser format_help}@anchor{3090}
@deffn {Método} ArgumentParser.format_help ()

Retorna uma string contendo uma mensagem de ajuda, incluindo o uso do programa e informações sobre os argumentos registrados com o @ref{539,,ArgumentParser}.
@end deffn

@node Análise parcial,Personalizando a análise de arquivos,Imprimindo a ajuda,Outros utilitários
@anchor{library/argparse partial-parsing}@anchor{3091}
@subsubsection Análise parcial


@geindex parse_known_args() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_known_args}@anchor{3092}
@deffn {Método} ArgumentParser.parse_known_args (args=None, namespace=None)

Às vezes, um script precisa manipular apenas um conjunto específico de argumentos de linha de comando, deixando quaisquer argumentos não reconhecidos para outro script ou programa. Nesses casos, o método @ref{3092,,parse_known_args()} pode ser útil.

Este método funciona de forma semelhante a @ref{3046,,parse_args()}, mas não levanta erro para argumentos extras não reconhecidos. Em vez disso, ele analisa os argumentos conhecidos e retorna uma tupla de dois itens que contém o espaço de nomes preenchido e a lista de quaisquer argumentos não reconhecidos.

@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 Aviso 
As regras de @ref{de7,,correspondência de prefixo} se aplicam a @ref{3092,,parse_known_args()}. O analisador pode usar uma opção mesmo que seja apenas um prefixo de uma de suas opções conhecidas, em vez de deixá-la na lista de argumentos restantes.
@end quotation
@end cartouche

@node Personalizando a análise de arquivos,Métodos de saída,Análise parcial,Outros utilitários
@anchor{library/argparse customizing-file-parsing}@anchor{3093}
@subsubsection Personalizando a análise de arquivos


@geindex convert_arg_line_to_args() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser convert_arg_line_to_args}@anchor{305d}
@deffn {Método} ArgumentParser.convert_arg_line_to_args (arg_line)

Argumentos lidos de um arquivo (veja o argumento nomeado `fromfile_prefix_chars' para o construtor @ref{539,,ArgumentParser}) são lidos com um argumento por linha. @ref{305d,,convert_arg_line_to_args()} pode ser substituído para uma leitura mais sofisticada.

Este método recebe um único argumento `arg_line' que é uma string lida do arquivo de argumentos. Ele retorna uma lista de argumentos analisados dessa string. O método é chamado uma vez por linha lida do arquivo de argumentos, em ordem.

Uma substituição útil desse método é aquela que trata cada palavra separada por espaços como um argumento. O exemplo a seguir demonstra como fazer isso:

@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 saída,Análise misturada,Personalizando a análise de arquivos,Outros utilitários
@anchor{library/argparse exiting-methods}@anchor{3094}
@subsubsection Métodos de saída


@geindex exit() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser exit}@anchor{3095}
@deffn {Método} ArgumentParser.exit (status=0, message=None)

Este método encerra o programa, saindo com o `status' especificado e, se fornecido, imprime uma `message' para @ref{940,,sys.stderr} antes disso. O usuário pode sobrescrever este método para lidar com essas etapas de forma diferente:

@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 argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser error}@anchor{3096}
@deffn {Método} ArgumentParser.error (message)

Este método imprime uma mensagem de uso, incluindo a `message', em @ref{940,,sys.stderr} e encerra o programa com um código de status 2.
@end deffn

@node Análise misturada,Registrando ações e tipos personalizados,Métodos de saída,Outros utilitários
@anchor{library/argparse intermixed-parsing}@anchor{3097}
@subsubsection Análise misturada


@geindex parse_intermixed_args() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_intermixed_args}@anchor{b13}
@deffn {Método} ArgumentParser.parse_intermixed_args (args=None, namespace=None)
@end deffn

@geindex parse_known_intermixed_args() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser parse_known_intermixed_args}@anchor{3098}
@deffn {Método} ArgumentParser.parse_known_intermixed_args (args=None, namespace=None)

Vários comandos Unix permitem que o usuário misture argumentos opcionais com argumentos posicionais. Os métodos @ref{b13,,parse_intermixed_args()} e @ref{3098,,parse_known_intermixed_args()} oferecem suporte a esse estilo de análise.

Esses analisadores não oferecem suporte a todos os recursos do @code{argparse} e vão levantar exceções se recursos não suportados forem usados. Em particular, subanalisadores e grupos mutuamente exclusivos que incluem tanto opcionais quanto posicionais não são suportados.

O exemplo a seguir mostra a diferença entre @ref{3092,,parse_known_args()} e @ref{b13,,parse_intermixed_args()}: o primeiro retorna @code{['2', '3']} como argumentos não analisados, enquanto o último coleta todos os posicionais em @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{3098,,parse_known_intermixed_args()} retorna uma tupla de dois itens contendo o espaço de nomes preenchido e a lista de strings de argumentos restantes. @ref{b13,,parse_intermixed_args()} levanta um erro se houver strings de argumentos não analisadas restantes.


Adicionado na versão 3.7.

@end deffn

@node Registrando ações e tipos personalizados,,Análise misturada,Outros utilitários
@anchor{library/argparse registering-custom-types-or-actions}@anchor{3099}
@subsubsection Registrando ações e tipos personalizados


@geindex register() (método argparse.ArgumentParser)
@anchor{library/argparse argparse ArgumentParser register}@anchor{306b}
@deffn {Método} ArgumentParser.register (registry_name, value, object)

Às vezes, é desejável usar uma string personalizada em mensagens de erro para fornecer uma saída mais amigável ao usuário. Nesses casos, @code{register()} pode ser usado para registrar ações ou tipos personalizados com um analisador sintático e permitir que você faça referência ao tipo pelo nome registrado em vez do nome do chamável.

O método @code{register()} aceita três argumentos - um `registry_name', especificando o registro interno onde o objeto será armazenado (por exemplo, @code{action}, @code{type}), `value', que é a chave sob a qual o objeto será registrado, e object, o chamável a ser registrado.

O exemplo a seguir mostra como registrar um tipo personalizado com um analisador:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.register('type', 'hexadecimal integer', lambda s: int(s, 16))
>>> parser.add_argument('--foo', type='hexadecimal integer')
_StoreAction(option_strings=['--foo'], dest='foo', nargs=None, const=None, default=None, type='hexadecimal integer', choices=None, required=False, help=None, metavar=None, deprecated=False)
>>> parser.parse_args(['--foo', '0xFA'])
Namespace(foo=250)
>>> parser.parse_args(['--foo', '1.2'])
usage: PROG [-h] [--foo FOO]
PROG: error: argument --foo: invalid 'hexadecimal integer' value: '1.2'
@end example
@end deffn

@node Exceções<9>,,Outros utilitários,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos
@anchor{library/argparse exceptions}@anchor{309a}
@subsubsection Exceções


@geindex ArgumentError
@anchor{library/argparse argparse ArgumentError}@anchor{309b}
@deffn {Exceção} argparse.ArgumentError

Um erro ao criar ou usar um argumento (opcional ou posicional).

O valor da string dessa exceção é a mensagem, complementada com informações sobre o argumento que a causou.
@end deffn

@geindex ArgumentTypeError
@anchor{library/argparse argparse ArgumentTypeError}@anchor{3071}
@deffn {Exceção} argparse.ArgumentTypeError

Levantada quando algo dá errado ao converter uma string de linha de comando em um tipo.
@end deffn

@subsubheading Guias e tutoriais


@menu
* Tutorial de Argparse:: 
* Migrando código optparse para argparse:: 

@end menu

@node Tutorial de Argparse,Migrando código optparse para argparse,,Exceções<9>
@anchor{howto/argparse doc}@anchor{309c}@anchor{howto/argparse argparse-tutorial}@anchor{3045}@anchor{howto/argparse id1}@anchor{309d}
@subsubsection Tutorial de Argparse


@*autor: 
Tshepang Mbambo


Este tutorial pretende ser uma introdução gentil ao @ref{6,,argparse} — o módulo recomendado na biblioteca padrão do Python para fazer a análise de linha de comando.

@cartouche
@quotation Nota 
A biblioteca padrão inclui duas outras bibliotecas diretamente relacionadas ao processamento de parâmetros de linha de comando: o módulo de nível inferior @ref{a0,,optparse} (que pode exigir mais código para configurar uma determinada aplicação, mas também permite que uma aplicação solicite comportamentos que @code{argparse} não suporta), e o nível muito baixo @ref{61,,getopt} (que serve especificamente como um equivalente à família de funções @code{getopt()} disponível para programadores C). Embora nenhum desses módulos seja abordado diretamente neste guia, muitos dos conceitos principais em @code{argparse} se originaram primeiro em @code{optparse}, então alguns aspectos deste tutorial também serão relevantes para usuários de @code{optparse}.
@end quotation
@end cartouche

@menu
* Conceitos:: 
* O básico:: 
* Apresentando os argumentos posicionais:: 
* Apresentando os argumentos opcionais:: 
* Combinando argumentos posicionais e opcionais:: 
* Avançando um pouco mais:: 
* Como traduzir a saída do argparse:: 
* Conversores de tipo personalizados:: 
* Conclusão:: 

@end menu

@node Conceitos,O básico,,Tutorial de Argparse
@anchor{howto/argparse concepts}@anchor{309e}
@subsubsection Conceitos


Demonstraremos o tipo de funcionalidade que vamos explorar neste tutorial introdutório fazendo uso do 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
Uso: ls [OPÇÃO]... [ARQUIVO]...
Lista informações sobre os ARQUIVOs (no diretório atual por padrão).
Lista as entradas em ordem alfabética se não for usada nenhuma opção -cftuvSUX
nem --sort..
...
@end example

Alguns conceitos que podemos aprender a partir destes quatro comandos:


@itemize *

@item 
O comando @code{ls} é útil quando usado sem nenhuma opção. Por padrão, ele mostra o conteúdo do diretório atual.

@item 
Se quisermos além do que ele fornece por padrão, contamos um pouco mais. Neste caso, queremos que ele exiba um diretório diferente, @code{pypy}. O que fizemos foi especificar o que é conhecido como argumento posicional. Ele é chamado assim porque o programa deve saber o que fazer com o valor, apenas com base em onde ele aparece na linha de comando. Este conceito é mais relevante para um comando como @code{cp}, cujo uso mais básico é @code{cp SRC DEST}. A primeira posição é `o que você deseja copiar' e a segunda posição é `para onde você deseja copiar'.

@item 
Agora, digamos que queremos mudar o comportamento do programa. Em nosso exemplo, exibimos mais informações para cada arquivo em vez de apenas mostrar os nomes dos arquivos. O @code{-l} nesse caso é conhecido como um argumento opcional.

@item 
Esse é um trecho do texto de ajuda. É muito útil que possas encontrar um programa que nunca usastes antes e poder descobrir como o mesmo funciona simplesmente lendo o seu texto de ajuda.
@end itemize

@node O básico,Apresentando os argumentos posicionais,Conceitos,Tutorial de Argparse
@anchor{howto/argparse the-basics}@anchor{309f}
@subsubsection O básico


Comecemos com um exemplo muito simples que irá fazer (quase) nada:

@example
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
@end example

A seguir, temos o resultado da execução do 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

Eis aqui o que está acontecendo:


@itemize *

@item 
Executar o script sem qualquer opção resultará que nada será exibido em stdout. Isso não é útil.

@item 
O segundo começa a exibir as utilidades do módulo @ref{6,,argparse}. Não fizemos quase nada, mas já recebemos uma boa mensagem de ajuda.

@item 
A opção @code{--help}, que também pode ser encurtada para @code{-h}, é a única opção que obtemos livremente (ou seja, não é necessário determiná-la). Determinar qualquer outra coisa resulta num erro. Mas mesmo assim, recebemos uma mensagem de uso bastante útil, também de graça.
@end itemize

@node Apresentando os argumentos posicionais,Apresentando os argumentos opcionais,O básico,Tutorial de Argparse
@anchor{howto/argparse introducing-positional-arguments}@anchor{30a0}
@subsubsection Apresentando os argumentos posicionais


Um exemplo:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)
@end example

E executando o 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

Aqui está o que acontecerá:


@itemize *

@item 
Nós adicionamos o método @ref{19e,,add_argument()}, cujo o mesmo usamos para especificar quais opções de linha de comando o programa está disposto a aceitar. Neste caso, eu o nomeei @code{echo} para que ele esteja de acordo com sua função.

@item 
Chamar o nosso programa neste momento, requer a especificação de uma opção.

@item 
O método @ref{3046,,parse_args()} realmente retorna alguns dados das opções especificadas, neste caso, @code{echo}.

@item 
A variável é uma forma de “mágica” que @ref{6,,argparse} executa de brinde (ou seja, não é necessário especificar em qual variável esse valor é armazenado). Você também notará que seu nome corresponde ao argumento string dado ao método, @code{echo}.
@end itemize

Observe, no entanto, que, embora a tela de ajuda pareça boa e tudo, atualmente não é tão útil quanto poderia ser. Por exemplo, vemos que temos @code{echo} como um argumento posicional, mas não sabemos o que ele faz, além de adivinhar ou ler o código-fonte. Então, vamos torná-lo um pouco mais ú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

E, iremos obter:

@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

Agora, que tal fazer algo ainda mais ú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

A seguir, temos o resultado da execução do 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

Isso não correu tão bem. Isso porque @ref{6,,argparse} trata as opções que damos a ele como strings, a menos que digamos o contrário. Então, vamos dizer ao @ref{6,,argparse} para tratar essa entrada como um inteiro:

@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

A seguir, temos o resultado da execução do 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

Correu bem. O programa agora até fecha com ajuda de entrada ilegal ruim antes de prosseguir.

@node Apresentando os argumentos opcionais,Combinando argumentos posicionais e opcionais,Apresentando os argumentos posicionais,Tutorial de Argparse
@anchor{howto/argparse introducing-optional-arguments}@anchor{30a1}
@subsubsection Apresentando os argumentos opcionais


Até agora, jogamos com argumentos posicionais. Vamos dar uma olhada em como adicionar opcionais:

@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

E a saída:

@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

Eis aqui o que está acontecendo:


@itemize *

@item 
O programa é escrito de forma a exibir algo quando @code{--verbosity} é especificado e não exibir nada quando não for.

@item 
Para mostrar que a opção é realmente opcional, não há erro ao executar o programa sem ela. Observe que, por padrão, se um argumento opcional não for usado, a variável relevante, neste caso @code{args.verbosity}, recebe @code{None} como valor, razão pela qual falha no teste de verdade da instrução @ref{2f3,,if}.

@item 
A mensagem de ajuda é um pouco diferente.

@item 
Ao usar a opção @code{--verbosity}, deve-se também especificar algum valor, qualquer valor.
@end itemize

O exemplo acima aceita valores inteiros arbitrários para @code{--verbosity}, mas para nosso programa simples, apenas dois valores são realmente úteis, @code{True} ou @code{False}. Vamos modificar o código de acordo:

@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

E a saída:

@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

Eis aqui o que está acontecendo:


@itemize *

@item 
A opção agora é mais um sinalizador do que algo que requer um valor. Até mudamos o nome da opção para corresponder a essa ideia. Observe que agora especificamos uma nova palavra reservada, @code{action}, e damos a ela o valor @code{"store_true"}. Isso significa que, se a opção for especificada, atribui o valor @code{True} para @code{args.verbose}. Não especificá-la implica em @code{False}.

@item 
Ele reclama quando você especifica um valor, no verdadeiro espírito do que os sinalizadores realmente são.

@item 
Observe o texto de ajuda diferente.
@end itemize

@menu
* Opções curtas:: 

@end menu

@node Opções curtas,,,Apresentando os argumentos opcionais
@anchor{howto/argparse short-options}@anchor{30a2}
@subsubsection Opções curtas


Se você estiver familiarizado com o uso da linha de comando, notará que ainda não toquei no tópico das versões curtas das opções. É bem simples:

@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

E aqui vai:

@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

Observe que a nova habilidade também é refletida no texto de ajuda.

@node Combinando argumentos posicionais e opcionais,Avançando um pouco mais,Apresentando os argumentos opcionais,Tutorial de Argparse
@anchor{howto/argparse combining-positional-and-optional-arguments}@anchor{30a3}
@subsubsection Combinando argumentos posicionais e opcionais


Nosso programa continua crescendo em complexidade:

@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

E agora a saída:

@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 
Trouxemos de volta um argumento posicional, daí a reclamação.

@item 
Observe que a ordem não importa.
@end itemize

Que tal devolvermos a este nosso programa a capacidade de ter vários valores de verbosidade e realmente usá-los:

@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

E a saída:

@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 eles parecem bons, exceto o último, que expõe um bug em nosso programa. Vamos corrigi-lo restringindo os valores que a opção @code{--verbosity} pode aceitar:

@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

E a saída:

@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

Observe que a alteração também reflete tanto na mensagem de erro quanto na string de ajuda.

Agora, vamos usar uma abordagem diferente de brincar com a verbosidade, que é bastante comum. Ele também corresponde à maneira como o executável do CPython trata seu próprio argumento de verbosidade (verifique a saída 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

Introduzimos outra ação, “contar”, para contar o número de ocorrências de opções 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 
Sim, agora é mais um sinalizador (semelhante a @code{action="store_true"}) na versão anterior do nosso script. Isso deve explicar a reclamação.

@item 
Ele também se comporta de maneira semelhante à ação “store_true”.

@item 
Agora aqui está uma demonstração do que a ação “contar” oferece. Você provavelmente já viu esse tipo de uso antes.

@item 
E se você não especificar o sinalizador @code{-v}, esse sinalizador será considerado como tendo valor @code{None}.

@item 
Como deve ser esperado, especificando a forma longa do sinalizador, devemos obter a mesma saída.

@item 
Infelizmente, nossa saída de ajuda não é muito informativa sobre a nova habilidade que nosso script adquiriu, mas isso sempre pode ser corrigido melhorando a documentação de nosso script (por exemplo, através do argumento nomeado @code{help}).

@item 
Essa última saída expõe um bug em nosso programa.
@end itemize

Vamos corrigir:

@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

E isso aqui é o mesmo retorna:

@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 
A primeira saída correu bem e corrige o bug que tínhamos antes. Ou seja, queremos que qualquer valor >= 2 seja o mais detalhado possível.

@item 
A terceira saída não está tão boa.
@end itemize

Vamos corrigir esse bug:

@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 introduzir outra palavra reservada, @code{default}. Nós o configuramos como @code{0} para torná-lo comparável aos outros valores int. Lembre-se que por padrão, se um argumento opcional não for especificado, ele obtém o valor @code{None}, e isso não pode ser comparado a um valor int (daí a exceção @ref{2c3,,TypeError}).

E:

@example
$ python prog.py 4
16
@end example

Você pode ir muito longe apenas com o que aprendemos até agora, e nós apenas arranhamos a superfície. O módulo @ref{6,,argparse} é muito poderoso, e vamos explorar um pouco mais antes de terminar este tutorial.

@node Avançando um pouco mais,Como traduzir a saída do argparse,Combinando argumentos posicionais e opcionais,Tutorial de Argparse
@anchor{howto/argparse getting-a-little-more-advanced}@anchor{30a4}
@subsubsection Avançando um pouco mais


E se quiséssemos expandir nosso pequeno programa, ampliando seu potencial:

@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

Saída:

@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

Observe que até agora estamos usando o nível de verbosidade para `alterar' o texto que é exibido. O exemplo a seguir usa o nível de verbosidade para exibir `mais' texto:

@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

Saída:

@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 ambíguos:: 
* Opções conflitantes:: 

@end menu

@node Especificando argumentos ambíguos,Opções conflitantes,,Avançando um pouco mais
@anchor{howto/argparse id2}@anchor{30a5}@anchor{howto/argparse specifying-ambiguous-arguments}@anchor{306d}
@subsubsection Especificando argumentos ambíguos


Quando há ambiguidade em decidir se um argumento é posicional ou para um argumento, @code{--} pode ser usado para dizer @ref{3046,,parse_args()} que tudo depois disso é um 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 Opções conflitantes,,Especificando argumentos ambíguos,Avançando um pouco mais
@anchor{howto/argparse conflicting-options}@anchor{30a6}
@subsubsection Opções conflitantes


Até agora, trabalhamos com dois métodos de uma instância @ref{539,,argparse.ArgumentParser}. Vamos apresentar um terceiro, @ref{308a,,add_mutually_exclusive_group()}. Ele nos permite especificar opções que entram em conflito umas com as outras. Vamos também alterar o resto do programa para que a nova funcionalidade faça mais sentido: vamos introduzir a opção @code{--quiet}, que será o oposto da opção @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

Nosso programa agora está mais simples e perdemos algumas funcionalidades para demonstração. De qualquer forma, aqui está a saída:

@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

Isso deve ser fácil de seguir. Eu adicionei essa última saída para que você possa ver o tipo de flexibilidade que obtém, ou seja, misturar opções de formato longo com formatos curtos.

Antes de concluirmos, você provavelmente quer dizer aos seus usuários o propósito principal do seu programa, caso eles não saibam:

@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

Observe essa pequena diferença no texto de uso. Observe o @code{[-v | -q]}, que nos diz que podemos usar @code{-v} ou @code{-q}, mas não ambos ao mesmo tempo:

@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 Como traduzir a saída do argparse,Conversores de tipo personalizados,Avançando um pouco mais,Tutorial de Argparse
@anchor{howto/argparse how-to-translate-the-argparse-output}@anchor{30a7}
@subsubsection Como traduzir a saída do argparse


A saída do módulo @ref{6,,argparse}, como seu texto de ajuda e mensagens de erro, são todos traduzidos usando o módulo @ref{63,,gettext}. Isso permite que os aplicativos localizem facilmente as mensagens produzidas por @ref{6,,argparse}. Veja também @ref{30a8,,Internacionalizando seus programas e módulos}.

Por exemplo, nesta saída @ref{6,,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

As strings @code{usage:}, @code{positional arguments:}, @code{options:} e @code{show this help message and exit} são todos traduzíveis.

Para traduzir essas strings, elas devem primeiro ser extraídas em um arquivo @code{.po}. Por exemplo, usando Babel@footnote{https://babel.pocoo.org/}, execute este comando:

@example
$ pybabel extract -o messages.po /usr/lib/python3.12/argparse.py
@end example

Este comando extrairá todas as strings traduzíveis do módulo @ref{6,,argparse} e as enviará para um arquivo chamado @code{messages.po}. Este comando presume que sua instalação do Python está em @code{/usr/lib}.

Você pode descobrir a localização do módulo @ref{6,,argparse} em seu sistema usando este script:

@example
import argparse
print(argparse.__file__)
@end example

Uma vez que as mensagens no arquivo @code{.po} sejam traduzidas e as traduções instaladas usando @ref{63,,gettext}, @ref{6,,argparse} será capaz de exibir as mensagens traduzidas.

Para traduzir suas próprias strings na saída @ref{6,,argparse}, use @ref{63,,gettext}.

@node Conversores de tipo personalizados,Conclusão,Como traduzir a saída do argparse,Tutorial de Argparse
@anchor{howto/argparse custom-type-converters}@anchor{30a9}
@subsubsection Conversores de tipo personalizados


O módulo @ref{6,,argparse} permite que você especifique conversores de tipo personalizados para seus argumentos de linha de comando. Isso permite modificar a entrada de usuário antes de armazená-la na @ref{3047,,argparse.Namespace}. Isso pode ser útil quando você precisa pré-processar a entrada antes dela ser usada em seu programa.

Ao usar um conversor de tipo personalizado, você pode usar qualquer chamável que recebe uma única string como argumento (o valor do argumento) e retorna o valor convertido. Porém, se você precisa tratar de cenários mais complexos, você pode usar uma classe de ação personalizada com o parâmetro `action'.

Por exemplo, digamos que vcoê deseja tratar de argumentos com diferentes prefixos e processá-los adequadamente:

@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

Saída:

@example
$ python prog.py -a valor1 +a valor2
Namespace(a=[('-', 'valor1'), ('+', 'valor2')])
@end example

Neste exemplos, nós:


@itemize *

@item 
Criamos um analisador sintático com caracteres de prefixo personalizado usando parâmetro @code{prefix_chars}.

@item 
Definimos dois argumentos, @code{-a} e @code{+a}, que usaram o parâmetro @code{type} para criar conversores de tipo personalizados para armazenar o valor em uma tupla com o prefixo.
@end itemize

Sem os conversores de tipo personalizados, os argumentos tratariam @code{-a} e @code{+a} como o mesmo argumento, o que não era o desejado. Ao usar conversores de tipo personalizados, conseguimos diferenciar entre dois argumentos.

@node Conclusão,,Conversores de tipo personalizados,Tutorial de Argparse
@anchor{howto/argparse conclusion}@anchor{30aa}
@subsubsection Conclusão


O módulo @ref{6,,argparse} oferece muito mais do que o mostrado aqui. Sua documentação é bastante detalhada e completo, e cheia de exemplos. Tendo passado por este tutorial, você deve digeri-la facilmente sem se sentir sobrecarregado.
@anchor{howto/argparse-optparse upgrading-optparse-code}@anchor{11ed}
@node Migrando código optparse para argparse,,Tutorial de Argparse,Exceções<9>
@anchor{howto/argparse-optparse doc}@anchor{30ab}@anchor{howto/argparse-optparse migrating-optparse-code}@anchor{30ac}@anchor{howto/argparse-optparse migrating-optparse-code-to-argparse}@anchor{30ad}@anchor{howto/argparse-optparse translation-repo}@anchor{30ae}
@subsubsection Migrando código @code{optparse} para @code{argparse}


O módulo @ref{6,,argparse} oferece vários recursos de nível mais alto não fornecidos nativamente pelo módulo @ref{a0,,optparse}, incluindo:


@itemize *

@item 
Tratando argumentos posicionais.

@item 
Prover suporte a subcomandos.

@item 
Permitir prefixos alternativos de opções como @code{+} e @code{/}.

@item 
Manipular argumentos de estilo “zero ou mais” e “um ou mais”.

@item 
Produzir mensagens de uso mais informativas.

@item 
Fornecer uma interface muito mais simples para @code{type} e @code{action} personalizados.
@end itemize

Originalmente, o módulo @ref{6,,argparse} tentou manter a compatibilidade com @ref{a0,,optparse}. No entanto, as diferenças fundamentais de design entre suportar o processamento de opções de linha de comando declarativas (enquanto deixa o processamento de argumentos posicionais para o código da aplicação) e suportar opções nomeadas e argumentos posicionais na interface declarativa significam que a API divergiu daquela de @code{optparse} ao longo do tempo.

Conforme descrito em @ref{3044,,Escolhendo uma biblioteca de análise de linha de comando}, as aplicações que atualmente usam @ref{a0,,optparse} e estão satisfeitos com a forma como ele funciona podem continuar usando @code{optparse}.

Os desenvolvedores de aplicações que estão pensando em migrar também devem revisar a lista de diferenças comportamentais intrínsecas descritas nessa seção antes de decidir se a migração é desejável ou não.

Para aplicações que optam por migrar de @ref{a0,,optparse} para @ref{6,,argparse}, as seguintes sugestões devem ser úteis:


@itemize *

@item 
Substituir todas as chamadas de @ref{30af,,optparse.OptionParser.add_option()} por chamadas de @ref{19e,,ArgumentParser.add_argument()}.

@item 
Substituir @code{(options, args) = parser.parse_args()} por @code{args = parser.parse_args()} e adicionar chamadas adicionais a @ref{19e,,ArgumentParser.add_argument()} para os argumentos posicionais. Tenha em mente que o que anteriormente era chamado de @code{options}, agora no contexto do @ref{6,,argparse} é chamado de @code{args}.

@item 
Substituir @ref{30b0,,optparse.OptionParser.disable_interspersed_args()} usando @ref{b13,,parse_intermixed_args()} em vez de @ref{3046,,parse_args()}.

@item 
Substituir ações de função de retorno e argumentos nomeados @code{callback_*} por argumentos @code{type} ou @code{action}.

@item 
Substituir nomes de strings para argumentos nomeados @code{type} pelos objetos de tipo correspondentes (por exemplo, int, float, complex, etc).

@item 
Substituir @ref{30b1,,optparse.Values} por @ref{3047,,Namespace} e @ref{30b2,,optparse.OptionError} e @ref{30b3,,optparse.OptionValueError} por @ref{309b,,ArgumentError}.

@item 
Substituir strings com argumentos implícitos tal como @code{%default} ou @code{%prog} pela sintaxe padrão do Python para usar dicionários para formatar strings, ou seja, @code{%(default)s} e @code{%(prog)s}.

@item 
Substituir o argumento @code{version} do construtor do OptionParser por uma chamada a @code{parser.add_argument('--version', action='version', version='<the version>')}.
@end itemize

@node optparse — Analisador sintático para opções de linha de comando,getpass — Entrada de senha portátil,argparse — Analisador sintático para opções de linha de comando argumentos e subcomandos,Bibliotecas de interface de linha de comando
@anchor{library/optparse doc}@anchor{30b4}@anchor{library/optparse module-optparse}@anchor{a0}@anchor{library/optparse optparse-parser-for-command-line-options}@anchor{30b5}@anchor{library/optparse translation-repo}@anchor{30b6}
@subsection @code{optparse} — Analisador sintático para opções de linha de comando


@geindex module; optparse

`Código-fonte:' Lib/optparse.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/optparse.py}


__________________________________________________________________


@menu
* Escolhendo uma biblioteca de análise de linha de comando:: 
* Introdução: Introdução<7>. 
* Contexto:: 
* Tutorial: Tutorial<2>. 
* Guia de referência:: 
* Funções de retorno de opção:: 
* Estendendo optparse:: 
* Exceções: Exceções<10>. 

@end menu

@node Escolhendo uma biblioteca de análise de linha de comando,Introdução<7>,,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse choosing-an-argument-parser}@anchor{3044}@anchor{library/optparse choosing-an-argument-parsing-library}@anchor{30b7}
@subsubsection Escolhendo uma biblioteca de análise de linha de comando


A biblioteca padrão inclui três bibliotecas de análise de argumentos:


@itemize *

@item 
@ref{61,,getopt}: um módulo que espelha de perto a API procedural C @code{getopt}. Incluído na biblioteca padrão desde antes do lançamento inicial do Python 1.0.

@item 
@ref{a0,,optparse}: uma substituição declarativa para @code{getopt} que fornece funcionalidade equivalente sem exigir que cada aplicação implemente sua própria lógica de análise de opções procedural. Incluído na biblioteca padrão desde o lançamento do Python 2.3.

@item 
@ref{6,,argparse}: uma alternativa mais opinativa a @code{optparse} que fornece mais funcionalidade por padrão, às custas de flexibilidade reduzida da aplicação em controlar exatamente como os argumentos são processados. Incluído na biblioteca padrão desde as versões Python 2.7 e Python 3.2.
@end itemize

Na ausência de restrições de design de análise de argumentos mais específicas, @ref{6,,argparse} é a escolha recomendada para implementar aplicações de linha de comando, pois oferece o mais alto nível de funcionalidade básica com o mínimo de código em nível de aplicação.

@ref{61,,getopt} é mantido quase inteiramente por razões de retrocompatibilidade. No entanto, ele também serve como um caso de uso de nicho como uma ferramenta para prototipagem e teste de manipulação de argumentos de linha de comando em aplicações C baseadas em @code{getopt}.

@ref{a0,,optparse} deve ser considerado como uma alternativa ao @ref{6,,argparse} nos seguintes casos:


@itemize *

@item 
uma aplicação já está usando @ref{a0,,optparse} e não quer arriscar as sutis mudanças comportamentais que podem surgir ao migrar para @ref{6,,argparse}

@item 
a aplicação requer controle adicional sobre a maneira como as opções e os parâmetros posicionais são intercalados na linha de comando (incluindo a capacidade de desabilitar completamente o recurso de intercalação)

@item 
a aplicação requer controle adicional sobre a análise incremental de elementos de linha de comando (embora @code{argparse} suporte isso, a maneira exata como ele funciona na prática é indesejável para alguns casos de uso)

@item 
a aplicação requer controle adicional sobre o tratamento de opções que aceitam valores de parâmetros que podem começar com @code{-} (como opções delegadas a serem passadas para subprocessos invocados)

@item 
a aplicação requer algum outro comportamento de processamento de parâmetros de linha de comando que @code{argparse} não suporta, mas que pode ser implementado em termos da interface de nível inferior oferecida por @code{optparse}
@end itemize

Essas considerações também significam que @ref{a0,,optparse} provavelmente fornecerá uma base melhor para autores de bibliotecas que escrevem bibliotecas de processamento de argumentos de linha de comando de terceiros.

Como exemplo concreto, considere as duas configurações de análise de argumentos de linha de comando a seguir, a primeira usando @code{optparse} e a segunda usando @code{argparse}:

@example
import optparse

if __name__ == '__main__':
    parser = optparse.OptionParser()
    parser.add_option('-o', '--output')
    parser.add_option('-v', dest='verbose', action='store_true')
    opts, args = parser.parse_args()
    process(args, output=opts.output, verbose=opts.verbose)
@end example

@example
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    parser.add_argument('rest', nargs='*')
    args = parser.parse_args()
    process(args.rest, output=args.output, verbose=args.verbose)
@end example

A diferença mais óbvia é que na versão @code{optparse}, os argumentos não opcionais são processados separadamente pelo aplicativo após o processamento da opção ser concluído. Na versão @code{argparse}, os argumentos posicionais são declarados e processados da mesma forma que as opções nomeadas.

No entanto, a versão @code{argparse} também manipulará algumas combinações de parâmetros de forma diferente da forma como a versão @code{optparse} as manipularia. Por exemplo (entre outras diferenças):


@itemize *

@item 
fornecer @code{-o -v} retorna @code{output="-v"} e @code{verbose=False} ao usar @code{optparse}, mas um erro de uso com @code{argparse} (reclamando que nenhum valor foi fornecido para @code{-o/--output}, já que @code{-v} é interpretado como significando o sinalizador de verbosidade)

@item 
da mesma forma, fornecer @code{-o --} retorna @code{output="--"} e @code{args=()} ao usar @code{optparse}, mas um erro de uso com @code{argparse} (também reclamando que nenhum valor foi fornecido para @code{-o/--output}, já que @code{--} é interpretado como o término do processamento da opção e o tratamento de todos os valores restantes como argumentos posicionais)

@item 
fornecer @code{-o=foo} retorna @code{output="=foo"} ao usar @code{optparse}, mas retorna @code{output="foo"} com @code{argparse} (já que @code{=} é um caso especial como um separador alternativo para valores de parâmetros de opção)
@end itemize

Se esses comportamentos diferentes na versão @code{argparse} são considerados desejáveis ou um problema dependerá do caso de uso específico da aplicação de linha de comando.


@subsubheading Ver também


click@footnote{https://pypi.org/project/click/} é uma biblioteca de processamento de argumentos de terceiros (originalmente baseada em @code{optparse}), que permite que aplicações de linha de comando sejam desenvolvidas como um conjunto de funções de implementação de comando decoradas.

Outras bibliotecas de terceiros, como typer@footnote{https://pypi.org/project/typer/} ou msgspec-click@footnote{https://pypi.org/project/msgspec-click/}, permitem que interfaces de linha de comando sejam especificadas de maneiras que se integrem de forma mais eficaz com a verificação estática de anotações de tipo Python.


@node Introdução<7>,Contexto,Escolhendo uma biblioteca de análise de linha de comando,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse introduction}@anchor{30b8}
@subsubsection Introdução


@ref{a0,,optparse} é uma biblioteca mais conveniente, flexível e poderosa para analisar opções de linha de comando do que o minimalista módulo @ref{61,,getopt}. @ref{a0,,optparse} usa um estilo mais declarativo de análise de linha de comando: você cria uma instância de @ref{1515,,OptionParser}, preenche-a com opções e analisa a linha de comando. @ref{a0,,optparse} permite que os usuários especifiquem opções na sintaxe convencional GNU/POSIX e, adicionalmente, gera mensagens de uso e ajuda para você.

Aqui está um exemplo de uso de @ref{a0,,optparse} em um script simples:

@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

Com essas poucas linhas de código, os usuários do seu script agora podem fazer “coisas comuns” na linha de comando, por exemplo:

@example
<seuscript> --file=outfile -q
@end example

Ao analisar a linha de comando, @ref{a0,,optparse} define atributos do objeto @code{options} retornado por @ref{1516,,parse_args()} com base nos valores de linha de comando fornecidos pelo usuário. Quando @ref{1516,,parse_args()} retorna da análise desta linha de comando, @code{options.filename} será @code{"outfile"} e @code{options.verbose} será @code{False}. @ref{a0,,optparse} provê as opções longas e curtas, permite que opções curtas sejam mescladas e permite que opções sejam associadas a seus argumentos de várias maneiras. Portanto, as seguintes linhas de comando são todas equivalentes ao exemplo acima:

@example
<seuscript> -f outfile --quiet
<seuscript> --quiet --file outfile
<seuscript> -q -foutfile
<seuscript> -qfoutfile
@end example

Além disso, os usuários podem executar um dos seguintes:

@example
<seuscript> -h
<seuscript> --help
@end example

e @ref{a0,,optparse} vai exibir um breve resumo das opções do seu script:

@example
Usage: <seuscript> [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

onde o valor de `seuscript' é determinado em tempo de execução (normalmente de @code{sys.argv[0]}).

@node Contexto,Tutorial<2>,Introdução<7>,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse background}@anchor{30b9}@anchor{library/optparse optparse-background}@anchor{30ba}
@subsubsection Contexto


@ref{a0,,optparse} foi explicitamente projetado para encorajar a criação de programas com interfaces de linha de comando diretas que seguem as convenções estabelecidas pela família @code{getopt()} de funções disponíveis para os desenvolvedores C. Para esse fim, ele provê apenas a sintaxe e a semântica de linha de comando mais comuns convencionalmente usadas no Unix. Se você não estiver familiarizado com essas convenções, ler esta seção vai permitir que você se familiarize com elas.

@menu
* Terminologia:: 
* Para que servem as opções?:: 
* Para que servem os argumentos posicionais?:: 

@end menu

@node Terminologia,Para que servem as opções?,,Contexto
@anchor{library/optparse optparse-terminology}@anchor{30bb}@anchor{library/optparse terminology}@anchor{30bc}
@subsubsection Terminologia



@table @asis

@item argumento

uma string inserida na linha de comando e passada pelo shell para @code{execl()} ou @code{execv()}. Em Python, argumentos são elementos de @code{sys.argv[1:]} (@code{sys.argv[0]} é o nome do programa que está sendo executado). Shells Unix também usam o termo “word”.

Ocasionalmente, é desejável substituir uma lista de argumentos diferente de @code{sys.argv[1:]}, então você deve ler “argumento” como “um elemento de @code{sys.argv[1:]}, ou de alguma outra lista fornecida como um substituto para @code{sys.argv[1:]}”.

@item opção

um argumento usado para fornecer informações extras para guiar ou personalizar a execução de um programa. Existem muitas sintaxes diferentes para opções; a sintaxe tradicional do Unix é um hífen (“-”) seguido por uma única letra, por exemplo, @code{-x} ou @code{-F}. Além disso, a sintaxe tradicional do Unix permite que várias opções sejam mescladas em um único argumento, por exemplo, @code{-x -F} é equivalente a @code{-xF}. O projeto GNU introduziu @code{--} seguido por uma série de palavras separadas por hífen, por exemplo, @code{--file} ou @code{--dry-run}. Essas são as únicas duas sintaxes de opção fornecidas por @ref{a0,,optparse}.

Algumas outras sintaxes de opções que o mundo viu incluem:


@itemize *

@item 
um hífen seguido por algumas letras, por exemplo @code{-pf} (isso `não' é o mesmo que várias opções mescladas em um único argumento)

@item 
um hífen seguido por uma palavra completa, por exemplo @code{-file} (isso é tecnicamente equivalente à sintaxe anterior, mas eles geralmente não são vistos no mesmo programa)

@item 
um sinal de mais seguido por uma única letra, ou algumas letras, ou uma palavra, por exemplo @code{+f}, @code{+rgb}

@item 
uma barra seguida de uma letra, ou algumas letras, ou uma palavra, por exemplo @code{/f}, @code{/file}
@end itemize

Essas sintaxes de opção não são suportadas por @ref{a0,,optparse}, e nunca serão. Isso é proposital: as três primeiras não são padrão em nenhum ambiente, e a última só faz sentido se você estiver mirando exclusivamente no Windows ou em certas plataformas legadas (por exemplo, VMS, MS-DOS).

@item argumento de opção

um argumento que segue uma opção, está intimamente associado a essa opção e é consumido da lista de argumentos quando essa opção é. Com @ref{a0,,optparse}, os argumentos de opção podem estar em um argumento separado de sua opção:

@example
-f foo
--file foo
@end example

ou incluídos no mesmo argumento:

@example
-ffoo
--file=foo
@end example

Normalmente, uma opção dada ou aceita um argumento ou não. Muitas pessoas querem um recurso de “argumentos opcionais de opção”, o que significa que algumas opções aceitarão um argumento se o virem, e não aceitarão se não o virem. Isso é um tanto controverso, porque torna a análise ambígua: se @code{-a} aceita um argumento opcional e @code{-b} é outra opção inteiramente diferente, como interpretamos @code{-ab}? Por causa dessa ambiguidade, @ref{a0,,optparse} não provê esse recurso.

@item argumento posicional

algo que sobrou na lista de argumentos depois que as opções foram analisadas, ou seja, depois que as opções e seus argumentos foram analisados e removidos da lista de argumentos.

@item opção obrigatória

uma opção que deve ser fornecida na linha de comando; observe que a frase “opção obrigatória” é autocontraditória em inglês. @ref{a0,,optparse} não impede que você implemente opções obrigatórias, mas também não ajuda muito nisso.
@end table

Por exemplo, considere esta linha de comando hipotética:

@example
prog -v --report report.txt foo bar
@end example

@code{-v} e @code{--report} são ambas opções. Supondo que @code{--report} receba um argumento, @code{report.txt} é um argumento de opção. @code{foo} e @code{bar} são argumentos posicionais.

@node Para que servem as opções?,Para que servem os argumentos posicionais?,Terminologia,Contexto
@anchor{library/optparse optparse-what-options-for}@anchor{30bd}@anchor{library/optparse what-are-options-for}@anchor{30be}
@subsubsection Para que servem as opções?


As opções são usadas para fornecer informações extras para ajustar ou personalizar a execução de um programa. Caso não tenha ficado claro, as opções geralmente são `opcionais'. Um programa deve ser capaz de executar muito bem sem nenhuma opção. (Escolha um programa aleatório dos conjuntos de ferramentas Unix ou GNU. Ele pode ser executado sem nenhuma opção e ainda fazer sentido? As principais exceções são @code{find}, @code{tar} e @code{dd} — todos eles são mutantes excêntricos que foram corretamente criticados por sua sintaxe não padrão e interfaces confusas.)

Muitas pessoas querem que seus programas tenham “opções obrigatórias”. Pense nisso. Se é obrigatório, então `não é opcional'! Se há uma informação que seu programa absolutamente requer para ser executado com sucesso, é para isso que servem os argumentos posicionais.

Como um exemplo de bom design de interface de linha de comando, considere o humilde utilitário @code{cp}, para copiar arquivos. Não faz muito sentido tentar copiar arquivos sem fornecer um destino e pelo menos uma fonte. Portanto, @code{cp} falha se você executá-lo sem argumentos. No entanto, ele tem uma sintaxe flexível e útil que não requer nenhuma opção:

@example
cp ORIGEM DESTINO
cp ORIGEM ... DIRETÓRIO
@end example

Você pode ir bem longe só com isso. A maioria das implementações de @code{cp} fornece um monte de opções para ajustar exatamente como os arquivos são copiados: você pode preservar o modo e o tempo de modificação, evitar seguir links simbólicos, perguntar antes de destruir arquivos existentes, etc. Mas nada disso distrai da missão principal de @code{cp}, que é copiar um arquivo para outro, ou vários arquivos para outro diretório.

@node Para que servem os argumentos posicionais?,,Para que servem as opções?,Contexto
@anchor{library/optparse optparse-what-positional-arguments-for}@anchor{30bf}@anchor{library/optparse what-are-positional-arguments-for}@anchor{30c0}
@subsubsection Para que servem os argumentos posicionais?


Argumentos posicionais são para aquelas informações que seu programa absolutamente e positivamente requer para ser executado.

Uma boa interface de usuário deve ter o mínimo de requisitos absolutos possível. Se seu programa requer 17 informações distintas para ser executado com sucesso, não importa muito `como' você obtém essas informações do usuário — a maioria das pessoas desistirá e irá embora antes de executar o programa com sucesso. Isso se aplica se a interface de usuário for uma linha de comando, um arquivo de configuração ou uma GUI: se você fizer tantas exigências aos seus usuários, a maioria deles simplesmente desistirá.

Em resumo, tente minimizar a quantidade de informações que os usuários são absolutamente obrigados a fornecer — use padrões sensatos sempre que possível. Claro, você também quer tornar seus programas razoavelmente flexíveis. É para isso que servem as opções. Novamente, não importa se são entradas em um arquivo de configuração, widgets no diálogo “Preferências” de uma GUI ou opções de linha de comando — quanto mais opções você implementar, mais flexível será seu programa e mais complicada se tornará sua implementação. Muita flexibilidade também tem desvantagens, é claro; muitas opções podem sobrecarregar os usuários e tornar seu código muito mais difícil de manter.

@node Tutorial<2>,Guia de referência,Contexto,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse optparse-tutorial}@anchor{30c1}@anchor{library/optparse tutorial}@anchor{30c2}
@subsubsection Tutorial


Embora @ref{a0,,optparse} seja bastante flexível e poderoso, ele também é simples de usar na maioria dos casos. Esta seção abrange os padrões de código que são comuns a qualquer programa baseado em @ref{a0,,optparse}.

Primeiro, você precisa importar a classe OptionParser; então, no início do programa principal, crie uma instância de OptionParser:

@example
from optparse import OptionParser
...
parser = OptionParser()
@end example

Então você pode começar a definir opções. A sintaxe básica é:

@example
parser.add_option(opt_str, ...,
                  attr=value, ...)
@end example

Cada opção tem uma ou mais strings de opção, como @code{-f} ou @code{--file}, e vários atributos de opção que informam ao @ref{a0,,optparse} o que esperar e o que fazer quando encontrar essa opção na linha de comando.

Normalmente, cada opção terá uma sequência de opções curta e uma sequência de opções longa, por exemplo:

@example
parser.add_option("-f", "--file", ...)
@end example

Você tem a liberdade de definir quantas strings de opções curtas e longas quiser (incluindo zero), desde que haja pelo menos uma string de opção no geral.

As strings de opção passadas para @ref{30af,,OptionParser.add_option()} são efetivamente rótulos para a opção definida por essa chamada. Para resumir, frequentemente nos referiremos a `encontrar uma opção' na linha de comando; na realidade, @ref{a0,,optparse} encontra `strings de opção' e procura opções a partir delas.

Depois que todas as suas opções estiverem definidas, instrua @ref{a0,,optparse} para analisar a linha de comando do seu programa:

@example
(options, args) = parser.parse_args()
@end example

(Se desejar, você pode passar uma lista de argumentos personalizada para @ref{1516,,parse_args()}, mas isso raramente é necessário: por padrão, ele usa @code{sys.argv[1:]}.)

@ref{1516,,parse_args()} retorna dois valores:


@itemize *

@item 
@code{options}, um objeto que contém valores para todas as suas opções — por exemplo, se @code{--file} receber um único argumento de string, então @code{options.file} será o nome do arquivo fornecido pelo usuário, ou @code{None} se o usuário não forneceu essa opção

@item 
@code{args}, a lista de argumentos posicionais restantes após a análise de opções
@end itemize

Esta seção do tutorial abrange apenas os quatro atributos de opção mais importantes: @ref{30c3,,action}, @ref{30c4,,type}, @ref{30c5,,dest} (destino) e @ref{30c6,,help}. Destes, @ref{30c3,,action} é o mais fundamental.

@menu
* Compreendendo as ações de opções:: 
* A ação store:: 
* Manipulando opções (sinalizadores) booleanas: Manipulando opções sinalizadores booleanas. 
* Outras ações:: 
* Valores padrão:: 
* Gerando texto de ajuda:: 
* Exibindo uma string de versão:: 
* Como optparse trata erros:: 
* Juntando tudo:: 

@end menu

@node Compreendendo as ações de opções,A ação store,,Tutorial<2>
@anchor{library/optparse optparse-understanding-option-actions}@anchor{30c7}@anchor{library/optparse understanding-option-actions}@anchor{30c8}
@subsubsection Compreendendo as ações de opções


Ações dizem ao @ref{a0,,optparse} o que fazer quando ele encontra uma opção na linha de comando. Há um conjunto fixo de ações codificadas em @ref{a0,,optparse}; adicionar novas ações é um tópico avançado abordado na seção @ref{30c9,,Estendendo optparse}. A maioria das ações diz ao @ref{a0,,optparse} para armazenar um valor em alguma variável — por exemplo, pegue uma string da linha de comando e armazene-a em um atributo de @code{options}.

Se você não especificar uma ação de opção, @ref{a0,,optparse} assumirá como padrão @code{store}.

@node A ação store,Manipulando opções sinalizadores booleanas,Compreendendo as ações de opções,Tutorial<2>
@anchor{library/optparse optparse-store-action}@anchor{30ca}@anchor{library/optparse the-store-action}@anchor{30cb}
@subsubsection A ação store


A ação de opção mais comum é @code{store}, que diz ao @ref{a0,,optparse} para pegar o próximo argumento (ou o restante do argumento atual), garantir que seja do tipo correto e armazená-lo no destino escolhido.

Por exemplo:

@example
parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")
@end example

Agora vamos criar uma linha de comando falsa e pedir ao @ref{a0,,optparse} para analisá-la:

@example
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
@end example

Quando @ref{a0,,optparse} vê a string de opção @code{-f}, ele consome o próximo argumento, @code{foo.txt}, e o armazena em @code{options.filename}. Então, após essa chamada para @ref{1516,,parse_args()}, @code{options.filename} é @code{"foo.txt"}.

Alguns outros tipos de opção suportados por @ref{a0,,optparse} são @code{int} e @code{float}. Aqui está uma opção que espera um argumento inteiro:

@example
parser.add_option("-n", type="int", dest="num")
@end example

Note que esta opção não tem uma string de opção longa, o que é perfeitamente aceitável. Além disso, não há nenhuma ação explícita, já que o padrão é @code{store}.

Vamos analisar outra linha de comando falsa. Desta vez, vamos colocar o argumento de opção bem perto da opção: já que @code{-n42} (um argumento) equivale a @code{-n 42} (dois argumentos), o código

@example
(options, args) = parser.parse_args(["-n42"])
print(options.num)
@end example

vai exibir @code{42}.

Se você não especificar um tipo, @ref{a0,,optparse} presume @code{string}. Combinado com o fato de que a ação padrão é @code{store}, isso significa que nosso primeiro exemplo pode ser muito mais curto:

@example
parser.add_option("-f", "--file", dest="filename")
@end example

Se você não fornecer um destino, @ref{a0,,optparse} descobre um padrão sensato a partir das strings de opção: se a primeira string de opção longa for @code{--foo-bar}, então o destino padrão é @code{foo_bar}. Se não houver strings de opção longas, @ref{a0,,optparse} olha para a primeira string de opção curta: o destino padrão para @code{-f} é @code{f}.

@ref{a0,,optparse} também inclui o tipo @code{complex} embutido. Adicionar tipos é abordado na seção @ref{30c9,,Estendendo optparse}.

@node Manipulando opções sinalizadores booleanas,Outras ações,A ação store,Tutorial<2>
@anchor{library/optparse handling-boolean-flag-options}@anchor{30cc}@anchor{library/optparse optparse-handling-boolean-options}@anchor{30cd}
@subsubsection Manipulando opções (sinalizadores) booleanas


Opções de sinalizador — define uma variável como true ou false quando uma opção específica é vista — são bem comuns. @ref{a0,,optparse} suporta-as com duas ações separadas, @code{store_true} e @code{store_false}. Por exemplo, você pode ter um sinalizador @code{verbose} que é ativado com @code{-v} e desativado com @code{-q}:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")
@end example

Aqui temos duas opções diferentes com o mesmo destino, o que é perfeitamente OK. (Isso significa apenas que você tem que ter um pouco de cuidado ao definir valores padrão — veja abaixo.)

Quando @ref{a0,,optparse} encontra @code{-v} na linha de comando, ele define @code{options.verbose} como @code{True}; quando encontra @code{-q}, @code{options.verbose} é definido como @code{False}.

@node Outras ações,Valores padrão,Manipulando opções sinalizadores booleanas,Tutorial<2>
@anchor{library/optparse optparse-other-actions}@anchor{30ce}@anchor{library/optparse other-actions}@anchor{30cf}
@subsubsection Outras ações


Algumas outras ações suportadas por @ref{a0,,optparse} são:


@table @asis

@item @code{"store_const"}

armazena um valor constante, predefinido via @ref{30d0,,Option.const}

@item @code{"append"}

anexa o argumento desta opção a uma lista

@item @code{"count"}

incrementa um contador em um

@item @code{"callback"}

chama uma função especificada
@end table

Elas são abordadas na seção @ref{30d1,,Guia de referência} e na seção @ref{30d2,,Funções de retorno de opção}.

@node Valores padrão,Gerando texto de ajuda,Outras ações,Tutorial<2>
@anchor{library/optparse default-values}@anchor{30d3}@anchor{library/optparse optparse-default-values}@anchor{30d4}
@subsubsection Valores padrão


Todos os exemplos acima envolvem a configuração de alguma variável (o “destino”) quando certas opções de linha de comando são vistas. O que acontece se essas opções nunca forem vistas? Como não fornecemos nenhum padrão, todas elas são definidas como @code{None}. Isso geralmente é bom, mas às vezes você quer mais controle. @ref{a0,,optparse} permite que você forneça um valor padrão para cada destino, que é atribuído antes da análise da linha de comando.

Primeiro, considere o exemplo de verbose/quiet. Se quisermos que @ref{a0,,optparse} defina @code{verbose} como @code{True} a menos que @code{-q} seja visto, então podemos fazer isso:

@example
parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")
@end example

Como os valores padrão se aplicam ao `destino' e não a qualquer opção específica, e essas duas opções têm o mesmo destino, isso é exatamente equivalente:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)
@end example

Considere isso:

@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

Novamente, o valor padrão para @code{verbose} será @code{True}: o último valor padrão fornecido para qualquer destino específico é o que conta.

Uma maneira mais clara de especificar valores padrão é o método @code{set_defaults()} do OptionParser, que você pode chamar a qualquer momento antes de chamar @ref{1516,,parse_args()}:

@example
parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()
@end example

Como antes, o último valor especificado para um destino de opção dado é o que conta. Para maior clareza, tente usar um método ou outro de configuração de valores padrão, não ambos.

@node Gerando texto de ajuda,Exibindo uma string de versão,Valores padrão,Tutorial<2>
@anchor{library/optparse generating-help}@anchor{30d5}@anchor{library/optparse optparse-generating-help}@anchor{30d6}
@subsubsection Gerando texto de ajuda


A capacidade do @ref{a0,,optparse} de gerar texto de ajuda e uso automaticamente é útil para criar interfaces de linha de comando amigáveis ao usuário. Tudo o que você precisa fazer é fornecer um valor @ref{30c6,,help} para cada opção e, opcionalmente, uma curta mensagem de uso para todo o seu programa. Aqui está um OptionParser preenchido com opções amigáveis (documentadas) ao usuário:

@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

Se @ref{a0,,optparse} encontrar @code{-h} ou @code{--help} na linha de comando, ou se você apenas chamar @code{parser.print_help()}, ele exibe o seguinte na saída padrão:

@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

(Se a saída de ajuda for acionada por uma opção de ajuda, @ref{a0,,optparse} sai após imprimir o texto de ajuda.)

Há muita coisa acontecendo aqui para ajudar @ref{a0,,optparse} a gerar a melhor mensagem de ajuda possível:


@itemize *

@item 
o script define sua própria mensagem de uso:

@example
usage = "usage: %prog [options] arg1 arg2"
@end example

@ref{a0,,optparse} expande @code{%prog} na string de uso para o nome do programa atual, ou seja, @code{os.path.basename(sys.argv[0])}. A string expandida é então exibida antes da ajuda detalhada da opção.

Se você não fornecer uma string de uso, @ref{a0,,optparse} usa um padrão simples, mas sensato: @code{"Usage: %prog [options]"}, o que é bom se seu script não aceita nenhum argumento posicional.

@item 
cada opção define uma string de ajuda e não se preocupa com quebra de linha — @ref{a0,,optparse} cuida da quebra de linhas e faz com que a saída de ajuda tenha uma boa aparência.

@item 
opções que assumem um valor indicam esse fato em sua mensagem de ajuda gerada automaticamente, por exemplo, para a opção “mode”:

@example
-m MODE, --mode=MODE
@end example

Aqui, “MODE” é chamado de metavariável: ele representa o argumento que o usuário deve fornecer para @code{-m}/@code{--mode}. Por padrão, @ref{a0,,optparse} converte o nome da variável de destino para maiúsculas e usa isso para a metavariável. Às vezes, não é isso que você quer — por exemplo, a opção @code{--filename} define explicitamente @code{metavar="FILE"}, resultando nesta descrição de opção gerada automaticamente:

@example
-f FILE, --filename=FILE
@end example

Isso é importante para mais do que apenas economizar espaço: o texto de ajuda escrito manualmente usa a metavariável @code{FILE} para dar uma pista ao usuário de que há uma conexão entre a sintaxe semiformal @code{-f FILE} e a descrição semântica informal como, por exemplo, “write output to FILE”. Essa é uma maneira simples, mas eficaz, de tornar seu texto de ajuda muito mais claro e útil para usuários finais.

@item 
opções que têm um valor padrão podem incluir @code{%default} na string de ajuda — @ref{a0,,optparse} vai substituí-lo por @ref{44c,,str()} do valor padrão da opção. Se uma opção não tiver um valor padrão (ou o valor padrão for @code{None}), @code{%default} expande para @code{none}.
@end itemize

@menu
* Agrupando opções:: 

@end menu

@node Agrupando opções,,,Gerando texto de ajuda
@anchor{library/optparse grouping-options}@anchor{30d7}
@subsubsection Agrupando opções


Ao lidar com muitas opções, é conveniente agrupar essas opções para melhor saída de ajuda. Um @ref{1515,,OptionParser} pode conter vários grupos de opções, cada um dos quais pode conter várias opções.

Um grupo de opções é obtido usando a classe @ref{30d8,,OptionGroup}:

@geindex OptionGroup (classe em optparse)
@anchor{library/optparse optparse OptionGroup}@anchor{30d8}
@deffn {Classe} optparse.OptionGroup (parser, title, description=None)

onde


@itemize *

@item 
`parser' é a instância @ref{1515,,OptionParser} na qual o grupo será inserido

@item 
`title' é o título do grupo

@item 
`description', opcional, é uma descrição longa do grupo
@end itemize
@end deffn

@ref{30d8,,OptionGroup} herda de @code{OptionContainer} (como @ref{1515,,OptionParser}) e, portanto, o método @code{add_option()} pode ser usado para adicionar uma opção ao grupo.

Depois que todas as opções são declaradas, usando o método @ref{1515,,OptionParser} @code{add_option_group()} o grupo é adicionado ao analisador definido anteriormente.

Continuando com o analisador definido na seção anterior, adicionar um @ref{30d8,,OptionGroup} a um analisador é fácil:

@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

Isso resultaria na seguinte saída de texto de ajuda:

@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

Um exemplo um pouco mais completo pode envolver o uso de mais de um grupo: ainda estendendo o exemplo 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

que resulta na seguinte saída:

@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

Outro método interessante, especialmente ao trabalhar programaticamente com grupos de opções, é:

@geindex get_option_group() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_option_group}@anchor{30d9}
@deffn {Método} OptionParser.get_option_group (opt_str)

Retorna o objeto @ref{30d8,,OptionGroup} ao qual a string de opção curta ou longa `opt_str' (por exemplo, @code{'-o'} ou @code{'--option'}) pertence. Se não houver tal @ref{30d8,,OptionGroup}, retorna @code{None}.
@end deffn

@node Exibindo uma string de versão,Como optparse trata erros,Gerando texto de ajuda,Tutorial<2>
@anchor{library/optparse optparse-printing-version-string}@anchor{30da}@anchor{library/optparse printing-a-version-string}@anchor{30db}
@subsubsection Exibindo uma string de versão


Similar à string breve de uso, @ref{a0,,optparse} também pode exibir uma string de versão para seu programa. Você tem que fornecer a string como o argumento @code{version} para OptionParser:

@example
parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
@end example

@code{%prog} é expandido assim como em @code{usage}. Além disso, @code{version} pode conter qualquer coisa que você quiser. Quando você o fornece, @ref{a0,,optparse} adiciona automaticamente uma opção @code{--version} ao seu analisador. Se ele encontrar essa opção na linha de comando, ele expande sua string @code{version} (substituindo @code{%prog}), exibindo-a no stdout e sai.

Por exemplo, se o seu script for chamado @code{/usr/bin/foo}:

@example
$ /usr/bin/foo --version
foo 1.0
@end example

Os dois métodos a seguir podem ser usados para exibir e obter a string @code{version}:

@geindex print_version() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser print_version}@anchor{30dc}
@deffn {Método} OptionParser.print_version (file=None)

Exibe a mensagem de versão para o programa atual (@code{self.version}) em `file' (stdout padrão). Assim como em @ref{30dd,,print_usage()}, qualquer ocorrência de @code{%prog} em @code{self.version} é substituída pelo nome do programa atual. Não faz nada se @code{self.version} estiver vazio ou indefinido.
@end deffn

@geindex get_version() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_version}@anchor{30de}
@deffn {Método} OptionParser.get_version ()

O mesmo que @ref{30dc,,print_version()}, mas retorna a string da versão em vez de exibi-la.
@end deffn

@node Como optparse trata erros,Juntando tudo,Exibindo uma string de versão,Tutorial<2>
@anchor{library/optparse how-optparse-handles-errors}@anchor{30df}@anchor{library/optparse optparse-how-optparse-handles-errors}@anchor{30e0}
@subsubsection Como @code{optparse} trata erros


Existem duas classes amplas de erros com os quais @ref{a0,,optparse} precisa se preocupar: erros do programador e erros do usuário. Erros do programador geralmente são chamadas errôneas para @ref{30af,,OptionParser.add_option()}, por exemplo, strings de opção inválidas, atributos de opção desconhecidos, atributos de opção ausentes, etc. Eles são tratados da maneira usual: levanta uma exceção (seja @ref{30b2,,optparse.OptionError} ou @ref{2c3,,TypeError}) e deixe o programa travar.

Lidar com erros do usuário é muito mais importante, pois eles certamente acontecerão não importa quão estável seu código seja. @ref{a0,,optparse} pode detectar automaticamente alguns erros do usuário, como argumentos de opção ruins (passando @code{-n 4x} onde @code{-n} recebe um argumento inteiro), argumentos ausentes (@code{-n} no final da linha de comando, onde @code{-n} recebe um argumento de qualquer tipo). Além disso, você pode chamar @code{OptionParser.error()} para sinalizar uma condição de erro definida pelo aplicativo:

@example
(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")
@end example

Em ambos os casos, @ref{a0,,optparse} lida com o erro da mesma maneira: ele imprime a mensagem de uso do programa e uma mensagem de erro no erro padrão e sai com o status de erro 2.

Considere o primeiro exemplo acima, onde o usuário passa @code{4x} para uma opção que aceita um inteiro:

@example
$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'
@end example

Ou, quando o usuário não passa nenhum valor:

@example
$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument
@end example

As mensagens de erro geradas pelo @ref{a0,,optparse} tomam o cuidado de sempre mencionar a opção envolvida no erro; certifique-se de fazer o mesmo ao chamar @code{OptionParser.error()} do código do sua aplicação.

Se o comportamento padrão de tratamento de erros do @ref{a0,,optparse} não atender às suas necessidades, você precisará criar uma subclasse de OptionParser e substituir seus métodos @code{exit()} e/ou @code{error()}.

@node Juntando tudo,,Como optparse trata erros,Tutorial<2>
@anchor{library/optparse optparse-putting-it-all-together}@anchor{30e1}@anchor{library/optparse putting-it-all-together}@anchor{30e2}
@subsubsection Juntando tudo


Veja como os scripts baseados no @ref{a0,,optparse} geralmente se parecem:

@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 Guia de referência,Funções de retorno de opção,Tutorial<2>,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse optparse-reference-guide}@anchor{30d1}@anchor{library/optparse reference-guide}@anchor{30e3}
@subsubsection Guia de referência


@menu
* Criando o analisador sintático:: 
* Preenchendo o analisador sintático:: 
* Definindo as opções:: 
* Atributos da classe Option:: 
* Ações de opção padrão:: 
* Tipos de opção padrão:: 
* Análise de argumentos:: 
* Consultando e manipulando seu analisador sintático de opções:: 
* Conflitos entre opções:: 
* Limpeza:: 
* Outros métodos:: 

@end menu

@node Criando o analisador sintático,Preenchendo o analisador sintático,,Guia de referência
@anchor{library/optparse creating-the-parser}@anchor{30e4}@anchor{library/optparse optparse-creating-parser}@anchor{30e5}
@subsubsection Criando o analisador sintático


O primeiro passo para usar o @ref{a0,,optparse} é criar uma instância de OptionParser.

@geindex OptionParser (classe em optparse)
@anchor{library/optparse optparse OptionParser}@anchor{1515}
@deffn {Classe} optparse.OptionParser (...)

O construtor do OptionParser não tem argumentos obrigatórios, mas vários argumentos nomeados opcionais. Você deve sempre passá-los como argumentos nomeados, ou seja, não confie na ordem em que os argumentos são declarados.


@table @asis

@item @code{usage} (padrão: @code{"%prog [options]"})

O resumo de uso para exibir quando seu programa é executado incorretamente ou com uma opção de ajuda. Quando @ref{a0,,optparse} exibe a string de uso, ele expande @code{%prog} para @code{os.path.basename(sys.argv[0])} (ou para @code{prog} se você passou esse argumento nomeado). Para suprimir uma mensagem de uso, passe o valor especial @code{optparse.SUPPRESS_USAGE}.

@item @code{option_list} (padrão: @code{[]})

Uma lista de objetos Option para preencher o analisador sintático. As opções em @code{option_list} são adicionadas após quaisquer opções em @code{standard_option_list} (um atributo de classe que pode ser definido por subclasses de OptionParser), mas antes de quaisquer opções de versão ou ajuda. Descontinuado; use @ref{30af,,add_option()} após criar o analisador sintático.

@item @code{option_class} (padrão: optparse.Option)

Classe para usar ao adicionar opções ao analisador sintático em @ref{30af,,add_option()}.

@item @code{version} (padrão: @code{None})

Uma string de versão para exibir quando o usuário fornece uma opção de versão. Se você fornecer um valor true para @code{version}, @ref{a0,,optparse} adiciona automaticamente uma opção de versão com a string de opção única @code{--version}. A substring @code{%prog} é expandida da mesma forma que para @code{usage}.

@item @code{conflict_handler} (padrão: @code{"error"})

Especifica o que fazer quando opções com strings de opções conflitantes são adicionadas ao analisador sintático; consulte a seção @ref{30e6,,Conflitos entre opções}.

@item @code{description} (padrão: @code{None})

Um parágrafo de texto que fornece uma breve visão geral do seu programa. @ref{a0,,optparse} reformata este parágrafo para ajustá-lo à largura atual do terminal e o exibe quando o usuário solicita ajuda (depois de @code{usage}, mas antes da lista de opções).

@item @code{formatter} (padrão: um novo @code{IndentedHelpFormatter})

Uma instância de optparse.HelpFormatter que será usada para exibir um texto de ajuda. @ref{a0,,optparse} fornece duas classes concretas para essa finalidade: IndentedHelpFormatter e TitledHelpFormatter.

@item @code{add_help_option} (padrão: @code{True})

Se verdadeiro, @ref{a0,,optparse} adicionará uma opção de ajuda (com strings de opção @code{-h} e @code{--help}) ao analisador sintático.

@item @code{prog}

A string a ser usada ao expandir @code{%prog} em @code{usage} e @code{version} em vez de @code{os.path.basename(sys.argv[0])}.

@item @code{epilog} (padrão: @code{None})

Um parágrafo de texto de ajuda para exibir após a ajuda da opção.
@end table
@end deffn

@node Preenchendo o analisador sintático,Definindo as opções,Criando o analisador sintático,Guia de referência
@anchor{library/optparse optparse-populating-parser}@anchor{30e7}@anchor{library/optparse populating-the-parser}@anchor{30e8}
@subsubsection Preenchendo o analisador sintático


Há várias maneiras de preencher o analisador sintático com opções. A maneira preferida é usando @ref{30af,,OptionParser.add_option()}, como mostrado na seção @ref{30c1,,Tutorial}. @code{add_option()} pode ser chamado de uma das duas maneiras:


@itemize *

@item 
passar uma instância de Option (conforme retornado por @code{make_option()})

@item 
passar qualquer combinação de argumentos nomeados e posicionais que sejam aceitáveis para @code{make_option()} (ou seja, para o construtor de Option), e ela criará a instância de Option para você
@end itemize

A outra alternativa é passar uma lista de instâncias de Option pré-construídas para o construtor de OptionParser, como em:

@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()} é uma função de fábrica para criar instâncias de Option; atualmente é um apelido para o construtor de Option. Uma versão futura de @ref{a0,,optparse} pode dividir Option em várias classes, e @code{make_option()} escolherá a classe certa para instanciar. Não instancie Option diretamente.)

@node Definindo as opções,Atributos da classe Option,Preenchendo o analisador sintático,Guia de referência
@anchor{library/optparse defining-options}@anchor{30e9}@anchor{library/optparse optparse-defining-options}@anchor{30ea}
@subsubsection Definindo as opções


Cada instância de Option representa um conjunto de strings de opções de linha de comando sinônimas, por exemplo, @code{-f} e @code{--file}. Você pode especificar qualquer número de strings de opções curtas ou longas, mas deve especificar pelo menos uma string de opção geral.

A maneira canônica de criar uma instância de @ref{30eb,,Option} é com o método @code{add_option()} de @ref{1515,,OptionParser}.

@geindex add_option() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser add_option}@anchor{30af}
@deffn {Método} OptionParser.add_option (option)

@deffnx {Método} OptionParser.add_option (*opt_str, attr=value, ...)

Para definir uma opção com apenas uma sequência de opções curta:

@example
parser.add_option("-f", attr=value, ...)
@end example

E para definir uma opção com apenas uma longa sequência de opções:

@example
parser.add_option("--foo", attr=value, ...)
@end example

Os argumentos nomeados definem atributos do novo objeto Option. O atributo option mais importante é @ref{30c3,,action}, e ele determina amplamente quais outros atributos são relevantes ou obrigatórios. Se você passar atributos option irrelevantes, ou deixar de passar os obrigatórios, @ref{a0,,optparse} levanta uma exceção @ref{30b2,,OptionError} explicando seu erro.

A `action' de uma opção determina o que @ref{a0,,optparse} faz quando encontra essa opção na linha de comando. As ações de opção padrão codificadas no @ref{a0,,optparse} são:


@table @asis

@item @code{"store"}

armazena o argumento desta opção (padrão)

@item @code{"store_const"}

armazena um valor constante, predefinido via @ref{30d0,,Option.const}

@item @code{"store_true"}

armazena @code{True}

@item @code{"store_false"}

armazena @code{False}

@item @code{"append"}

anexa o argumento desta opção a uma lista

@item @code{"append_const"}

anexar um valor constante a uma lista, predefinido via @ref{30d0,,Option.const}

@item @code{"count"}

incrementa um contador em um

@item @code{"callback"}

chama uma função especificada

@item @code{"help"}

exibe uma mensagem de uso incluindo todas as opções e a documentação para elas
@end table

(Se você não fornecer uma ação, o padrão é @code{"store"}. Para esta ação, você também pode fornecer os atributos de opção @ref{30c4,,type} e @ref{30c5,,dest}; consulte @ref{30ec,,Ações de opção padrão}.)
@end deffn

Como você pode ver, a maioria das ações envolve armazenar ou atualizar um valor em algum lugar. @ref{a0,,optparse} sempre cria um objeto especial para isso, convencionalmente chamado de @code{options}, que é uma instância de @ref{30b1,,optparse.Values}.

@geindex Values (classe em optparse)
@anchor{library/optparse optparse Values}@anchor{30b1}
@deffn {Classe} optparse.Values

Um objeto que contém nomes e valores de argumentos analisados como atributos. Normalmente criado chamando ao chamar @ref{1516,,OptionParser.parse_args()}, e pode ser substituído por uma subclasse personalizada passada para o argumento `values' de @ref{1516,,OptionParser.parse_args()} (conforme descrito em @ref{30ed,,Análise de argumentos}).
@end deffn

Argumentos de opção (e vários outros valores) são armazenados como atributos deste objeto, de acordo com o atributo de opção @ref{30c5,,dest} (destino).

Por exemplo, quando você chama

@example
parser.parse_args()
@end example

uma das primeiras coisas que @ref{a0,,optparse} faz é criar o objeto @code{options}:

@example
options = Values()
@end example

Se uma das opções neste analisador sintático for definida com

@example
parser.add_option("-f", "--file", action="store", type="string", dest="filename")
@end example

e a linha de comando que está sendo analisada inclui qualquer um dos seguintes:

@example
-ffoo
-f foo
--file=foo
--file foo
@end example

então @ref{a0,,optparse}, ao ver esta opção, fará o equivalente a

@example
options.filename = "foo"
@end example

Os atributos de opção @ref{30c4,,type} e @ref{30c5,,dest} são quase tão importantes quanto @ref{30c3,,action}, mas @ref{30c3,,action} é o único que faz sentido para `todas' as opções.

@node Atributos da classe Option,Ações de opção padrão,Definindo as opções,Guia de referência
@anchor{library/optparse option-attributes}@anchor{30ee}@anchor{library/optparse optparse-option-attributes}@anchor{30ef}
@subsubsection Atributos da classe Option


@geindex Option (classe em optparse)
@anchor{library/optparse optparse Option}@anchor{30eb}
@deffn {Classe} optparse.Option

Um único argumento de linha de comando, com vários atributos passados como nomeados para o construtor. Normalmente criado com @ref{30af,,OptionParser.add_option()} em vez de diretamente, e pode ser substituído por uma classe personalizada por meio do argumento `option_class' para @ref{1515,,OptionParser}.
@end deffn

Os seguintes atributos de opção podem ser passados como argumentos nomeados para @ref{30af,,OptionParser.add_option()}. Se você passar um atributo de opção que não seja relevante para uma opção específica, ou deixar de passar um atributo de opção obrigatório, @ref{a0,,optparse} levanta @ref{30b2,,OptionError}.

@geindex action (atributo optparse.Option)
@anchor{library/optparse optparse Option action}@anchor{30c3}
@deffn {Atributo} Option.action

(padrão: @code{"store"})

Determina o comportamento de @ref{a0,,optparse} quando esta opção é vista na linha de comando; as opções disponíveis estão documentadas @ref{30ec,,aqui}.
@end deffn

@geindex type (atributo optparse.Option)
@anchor{library/optparse optparse Option type}@anchor{30c4}
@deffn {Atributo} Option.type

(padrão: @code{"string"})

O tipo de argumento esperado por esta opção (por exemplo, @code{"string"} ou @code{"int"}); os tipos de opções disponíveis estão documentados @ref{30f0,,aqui}.
@end deffn

@geindex dest (atributo optparse.Option)
@anchor{library/optparse optparse Option dest}@anchor{30c5}
@deffn {Atributo} Option.dest

(padrão: derivado de strings de opção)

Se a ação da opção implicar escrever ou modificar um valor em algum lugar, isso informa ao @ref{a0,,optparse} onde escrevê-lo: @ref{30c5,,dest} nomeia um atributo do objeto @code{options} que o @ref{a0,,optparse} constrói ao analisar a linha de comando.
@end deffn

@geindex default (atributo optparse.Option)
@anchor{library/optparse optparse Option default}@anchor{30f1}
@deffn {Atributo} Option.default

O valor para usar para o destino desta opção se a opção não for vista na linha de comando. Veja também @ref{30f2,,OptionParser.set_defaults()}.
@end deffn

@geindex nargs (atributo optparse.Option)
@anchor{library/optparse optparse Option nargs}@anchor{30f3}
@deffn {Atributo} Option.nargs

(padrão: 1)

Quantos argumentos do tipo @ref{30c4,,type} devem ser consumidos quando esta opção for vista. Se > 1, @ref{a0,,optparse} armazenará uma tupla de valores em @ref{30c5,,dest}.
@end deffn

@geindex const (atributo optparse.Option)
@anchor{library/optparse optparse Option const}@anchor{30d0}
@deffn {Atributo} Option.const

Para ações que armazenam um valor constante, o valor constante a ser armazenado.
@end deffn

@geindex choices (atributo optparse.Option)
@anchor{library/optparse optparse Option choices}@anchor{30f4}
@deffn {Atributo} Option.choices

Para opções do tipo @code{"choice"}, a lista de strings que o usuário pode escolher.
@end deffn

@geindex callback (atributo optparse.Option)
@anchor{library/optparse optparse Option callback}@anchor{30f5}
@deffn {Atributo} Option.callback

Para opções com ação @code{"callback"}, o chamável para chamar quando esta opção for vista. Veja a seção @ref{30d2,,Funções de retorno de opção} para detalhes sobre os argumentos passados para o chamável.
@end deffn

@geindex callback_args (atributo optparse.Option)
@geindex callback_kwargs (atributo optparse.Option)
@anchor{library/optparse optparse Option callback_args}@anchor{30f6}
@deffn {Atributo} Option.callback_args
@anchor{library/optparse optparse Option callback_kwargs}@anchor{30f7}
@deffnx {Atributo} Option.callback_kwargs

Argumentos nomeados e posicionais adicionais para passar para @code{callback} após os quatro argumentos de retorno de chamada padrão.
@end deffn

@geindex help (atributo optparse.Option)
@anchor{library/optparse optparse Option help}@anchor{30c6}
@deffn {Atributo} Option.help

Texto de ajuda para exibir para esta opção ao listar todas as opções disponíveis após o usuário fornecer uma opção @ref{30c6,,help} (como @code{--help}). Se nenhum texto de ajuda for fornecido, a opção será listada sem texto de ajuda. Para ocultar esta opção, use o valor especial @code{optparse.SUPPRESS_HELP}.
@end deffn

@geindex metavar (atributo optparse.Option)
@anchor{library/optparse optparse Option metavar}@anchor{30f8}
@deffn {Atributo} Option.metavar

(padrão: derivado de strings de opção)

Substituto para o(s) argumento(s) de opção a ser(em) usado(s) ao exibir texto de ajuda. Veja a seção @ref{30c1,,Tutorial} para um exemplo.
@end deffn

@node Ações de opção padrão,Tipos de opção padrão,Atributos da classe Option,Guia de referência
@anchor{library/optparse optparse-standard-option-actions}@anchor{30ec}@anchor{library/optparse standard-option-actions}@anchor{30f9}
@subsubsection Ações de opção padrão


As várias ações de opção têm requisitos e efeitos ligeiramente diferentes. A maioria das ações tem vários atributos de opção relevantes que você pode especificar para guiar o comportamento de @ref{a0,,optparse}; algumas têm atributos obrigatórios, que você deve especificar para qualquer opção que use essa ação.


@itemize *

@item 
@code{"store"} [relevante: @ref{30c4,,type}, @ref{30c5,,dest}, @ref{30f3,,nargs}, @ref{30f4,,choices}]

A opção deve ser seguida por um argumento, que é convertido em um valor de acordo com @ref{30c4,,type} e armazenado em @ref{30c5,,dest}. Se @ref{30f3,,nargs} > 1, vários argumentos serão consumidos da linha de comando; todos serão convertidos de acordo com @ref{30c4,,type} e armazenados em @ref{30c5,,dest} como uma tupla. Veja a seção @ref{30f0,,Tipos de opção padrão}.

Se @ref{30f4,,choices} for fornecido (uma lista ou tupla de strings), o tipo padrão será @code{"choice"}.

Se @ref{30c4,,type} não for fornecido, o padrão será @code{"string"}.

Se @ref{30c5,,dest} não for fornecido, @ref{a0,,optparse} deriva um destino da primeira string de opção longa (por exemplo, @code{--foo-bar} implica @code{foo_bar}). Se não houver strings de opção longas, @ref{a0,,optparse} deriva um destino da primeira string de opção curta (por exemplo, @code{-f} implica @code{f}).

Exemplo:

@example
parser.add_option("-f")
parser.add_option("-p", type="float", nargs=3, dest="point")
@end example

Como ele analisa a linha de comando

@example
-f foo.txt -p 1 -3.5 4 -fbar.txt
@end example

@ref{a0,,optparse} vai definir

@example
options.f = "foo.txt"
options.point = (1.0, -3.5, 4.0)
options.f = "bar.txt"
@end example

@item 
@code{"store_const"} [obrigatório: @ref{30d0,,const}; relevante: @ref{30c5,,dest}]

O valor de @ref{30d0,,const} é armazenado em @ref{30c5,,dest}.

Exemplo:

@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

Se @code{--noisy} é encontrado, @ref{a0,,optparse} vai definir

@example
options.verbose = 2
@end example

@item 
@code{"store_true"} [relevante: @ref{30c5,,dest}]

Um caso especial de @code{"store_const"} que armazena @code{True} em @ref{30c5,,dest}.

@item 
@code{"store_false"} [relevante: @ref{30c5,,dest}]

Como @code{"store_true"}, mas armazenad @code{False}.

Exemplo:

@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"} [relevante: @ref{30c4,,type}, @ref{30c5,,dest}, @ref{30f3,,nargs}, @ref{30f4,,choices}]

A opção deve ser seguida por um argumento, que é anexado à lista em @ref{30c5,,dest}. Se nenhum valor padrão para @ref{30c5,,dest} for fornecido, uma lista vazia será criada automaticamente quando @ref{a0,,optparse} encontrar esta opção pela primeira vez na linha de comando. Se @ref{30f3,,nargs} > 1, vários argumentos serão consumidos e uma tupla de comprimento @ref{30f3,,nargs} será anexada a @ref{30c5,,dest}.

Os padrões para @ref{30c4,,type} e @ref{30c5,,dest} são os mesmos da ação @code{"store"}.

Exemplo:

@example
parser.add_option("-t", "--tracks", action="append", type="int")
@end example

Se @code{-t3} for encontrado na linha de comando, @ref{a0,,optparse} faz o equivalente a:

@example
options.tracks = []
options.tracks.append(int("3"))
@end example

Se, um pouco mais tarde, @code{--tracks=4} for encontrado, ele faz:

@example
options.tracks.append(int("4"))
@end example

A ação @code{append} chama o método @code{append} no valor atual da opção. Isso significa que qualquer valor padrão especificado deve ter um método @code{append}. Isso também significa que se o valor padrão não for vazio, os elementos padrão estarão presentes no valor analisado para a opção, com quaisquer valores da linha de comando anexados após esses valores padrão:

@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"} [obrigatório: @ref{30d0,,const}; relevante: @ref{30c5,,dest}]

Como @code{"store_const"}, mas o valor de @ref{30d0,,const} é anexado a @ref{30c5,,dest}; assim como em @code{"append"}, @ref{30c5,,dest} assume como padrão @code{None}, e uma lista vazia é criada automaticamente na primeira vez que a opção é encontrada.

@item 
@code{"count"} [relevante: @ref{30c5,,dest}]

Incrementa o inteiro armazenado em @ref{30c5,,dest}. Se nenhum valor padrão for fornecido, @ref{30c5,,dest} é definido como zero antes de ser incrementado pela primeira vez.

Exemplo:

@example
parser.add_option("-v", action="count", dest="verbosity")
@end example

A primeira vez que @code{-v} é encontrado na linha de comando, @ref{a0,,optparse} faz o equivalente a:

@example
options.verbosity = 0
options.verbosity += 1
@end example

Cada ocorrência subsequente de @code{-v} resulta em

@example
options.verbosity += 1
@end example

@item 
@code{"callback"} [obrigatório: @ref{30f5,,callback}; relevante: @ref{30c4,,type}, @ref{30f3,,nargs}, @ref{30f6,,callback_args}, @ref{30f7,,callback_kwargs}]

Chama a função especificada por @ref{30f5,,callback}, que é chamada como

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

Veja a seção @ref{30d2,,Funções de retorno de opção} para mais detalhes.

@item 
@code{"help"}

Exibe uma mensagem de ajuda completa para todas as opções no analisador sintático de opções atual. A mensagem de ajuda é construída a partir da string @code{usage} passada para o construtor do OptionParser e da string @ref{30c6,,help} passada para cada opção.

Se nenhuma string de @ref{30c6,,help} for fornecida para uma opção, ela ainda será listada na mensagem de ajuda. Para omitir uma opção completamente, use o valor especial @code{optparse.SUPPRESS_HELP}.

@ref{a0,,optparse} adiciona automaticamente uma opção @ref{30c6,,help} a todos as instâncias de OptionParsers, então normalmente você não precisa criar uma.

Exemplo:

@example
from optparse import OptionParser, SUPPRESS_HELP

# geralmente, uma opção de ajuda é adicionada
# automaticamente, mas que podem ser suprimida
# usando o argumento add_help_option
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

Se @ref{a0,,optparse} encontrar @code{-h} ou @code{--help} na linha de comando, ele vai exibir algo como a seguinte mensagem de ajuda no stdout (presumindo que @code{sys.argv[0]} é @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

Após exibir a mensagem de ajuda, @ref{a0,,optparse} encerra seu processo com @code{sys.exit(0)}.

@item 
@code{"version"}

Exibe o número da versão fornecido à instância de OptionParser para stdout e sai. O número da versão é realmente formatado e exibido pelo método @code{print_version()} do OptionParser. Geralmente, é relevante somente se o argumento @code{version} for fornecido ao construtor de OptionParser. Assim como com as opções de @ref{30c6,,help}, você raramente criará opções @code{version}, já que @ref{a0,,optparse} as adiciona automaticamente quando necessário.
@end itemize

@node Tipos de opção padrão,Análise de argumentos,Ações de opção padrão,Guia de referência
@anchor{library/optparse optparse-standard-option-types}@anchor{30f0}@anchor{library/optparse standard-option-types}@anchor{30fa}
@subsubsection Tipos de opção padrão


@ref{a0,,optparse} tem cinco tipos de opções embutidos: @code{"string"}, @code{"int"}, @code{"choice"}, @code{"float"} e @code{"complex"}. Se você precisar adicionar novos tipos de opções, veja a seção @ref{30c9,,Estendendo optparse}.

Os argumentos para opções de string não são verificados ou convertidos de forma alguma: o texto na linha de comando é armazenado no destino (ou passado para a função de retorno) como está.

Argumentos inteiros (tipo @code{"int"}) são analisados da seguinte forma:


@itemize *

@item 
se o número começar com @code{0x}, ele será analisado como um número hexadecimal

@item 
se o número começar com @code{0}, ele será analisado como um número octal

@item 
se o número começar com @code{0b}, ele será analisado como um número binário

@item 
caso contrário, o número é analisado como um número decimal
@end itemize

A conversão é feita chamando @ref{257,,int()} com a base apropriada (2, 8, 10 ou 16). Se isso falhar, @ref{a0,,optparse} também falhará, embora com uma mensagem de erro mais útil.

Os argumentos de opção @code{"float"} e @code{"complex"} são convertidos diretamente com @ref{2f7,,float()} e @ref{2f8,,complex()}, com tratamento de erros semelhante.

As opções @code{"choice"} são um subtipo das opções @code{"string"}. O atributo da opção @ref{30f4,,choices} (uma sequência de strings) define o conjunto de argumentos de opção permitidos. @code{optparse.check_choice()} compara os argumentos de opção fornecidos pelo usuário com esta lista mestre e levanta @ref{30b3,,OptionValueError} se uma string inválida for fornecida.

@node Análise de argumentos,Consultando e manipulando seu analisador sintático de opções,Tipos de opção padrão,Guia de referência
@anchor{library/optparse optparse-parsing-arguments}@anchor{30ed}@anchor{library/optparse parsing-arguments}@anchor{30fb}
@subsubsection Análise de argumentos


O objetivo de criar e preencher uma instância de OptionParser é chamar seu método @ref{1516,,parse_args()}.

@geindex parse_args() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser parse_args}@anchor{1516}
@deffn {Método} OptionParser.parse_args (args=None, values=None)

Analisa as opções de linha de comando encontradas em `args'.

Os parâmetros de entrada são


@table @asis

@item @code{args}

a lista de argumentos para processar (padrão: @code{sys.argv[1:]})

@item @code{values}

um objeto @ref{30b1,,Values} para armazenar argumentos de opção (padrão: uma nova instância de @ref{30b1,,Values}) – se você fornecer um objeto existente, os padrões de opção não serão inicializados nele
@end table

e o valor de retorno é um par @code{(options, args)} sendo


@table @asis

@item @code{options}

o mesmo objeto que foi passado como `values', ou a instância @code{optparse.Values} criada por @ref{a0,,optparse}

@item @code{args}

os argumentos posicionais restantes depois que todas as opções foram processadas
@end table
@end deffn

O uso mais comum é não fornecer nenhum argumento nomeado. Se você fornecer @code{values}, ele será modificado com chamadas repetidas de @ref{22f3,,setattr()} (aproximadamente uma para cada argumento de opção armazenado em um destino de opção) e retornado por @ref{1516,,parse_args()}.

Se @ref{1516,,parse_args()} encontrar algum erro na lista de argumentos, ele chama o método @code{error()} da instância de OptionParser com uma mensagem de erro apropriada para o usuário final. Isso, em última análise, encerra seu processo com um status de saída 2 (o status de saída tradicional do Unix para erros de linha de comando).

@node Consultando e manipulando seu analisador sintático de opções,Conflitos entre opções,Análise de argumentos,Guia de referência
@anchor{library/optparse optparse-querying-manipulating-option-parser}@anchor{30fc}@anchor{library/optparse querying-and-manipulating-your-option-parser}@anchor{30fd}
@subsubsection Consultando e manipulando seu analisador sintático de opções


O comportamento padrão do analisador sintático de opções pode ser ligeiramente personalizado, e você também pode dar uma olhada no seu analisador de opções e ver o que há lá. A classe OptionParser fornece vários métodos para ajudar você:

@geindex disable_interspersed_args() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser disable_interspersed_args}@anchor{30b0}
@deffn {Método} OptionParser.disable_interspersed_args ()

Define a análise para parar na primeira não opção. Por exemplo, se @code{-a} e @code{-b} forem ambas opções simples que não aceitam argumentos, @ref{a0,,optparse} normalmente aceita esta sintaxe:

@example
prog -a arg1 -b arg2
@end example

e trata-a como equivalente a

@example
prog -a -b arg1 arg2
@end example

Para desabilitar esse recurso, chame @ref{30b0,,disable_interspersed_args()}. Isso restaura a sintaxe Unix tradicional, onde a análise de opções para com o primeiro argumento não-opcional.

Use isto se você tiver um processador de comando que executa outro comando que tem opções próprias e você quer ter certeza de que essas opções não fiquem confusas. Por exemplo, cada comando pode ter um conjunto diferente de opções.
@end deffn

@geindex enable_interspersed_args() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser enable_interspersed_args}@anchor{30fe}
@deffn {Método} OptionParser.enable_interspersed_args ()

Define a análise para não parar na primeira não opção, permitindo intercalar alternadores com argumentos de comando. Esse é o comportamento padrão.
@end deffn

@geindex get_option() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_option}@anchor{30ff}
@deffn {Método} OptionParser.get_option (opt_str)

Retorna a instância de Option com a string de opção `opt_str', ou @code{None} se nenhuma opção tiver essa string de opção.
@end deffn

@geindex has_option() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser has_option}@anchor{3100}
@deffn {Método} OptionParser.has_option (opt_str)

Retorna @code{True} se o objeto OptionParser tiver uma opção com string de opção `opt_str' (por exemplo, @code{-q} ou @code{--verbose}).
@end deffn

@geindex remove_option() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser remove_option}@anchor{3101}
@deffn {Método} OptionParser.remove_option (opt_str)

Se o @ref{1515,,OptionParser} tiver uma opção correspondente a `opt_str', essa opção será removida. Se essa opção fornecer quaisquer outras strings de opção, todas essas strings de opção se tornarão inválidas. Se `opt_str' não ocorrer em nenhuma opção pertencente a este @ref{1515,,OptionParser}, levanta @ref{202,,ValueError}.
@end deffn

@node Conflitos entre opções,Limpeza,Consultando e manipulando seu analisador sintático de opções,Guia de referência
@anchor{library/optparse conflicts-between-options}@anchor{3102}@anchor{library/optparse optparse-conflicts-between-options}@anchor{30e6}
@subsubsection Conflitos entre opções


Se você não tomar cuidado, é fácil definir opções com strings de opções conflitantes:

@example
parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)
@end example

(Isto é particularmente verdadeiro se você definiu sua própria subclasse de OptionParser com algumas opções padrão.)

Toda vez que você adiciona uma opção, @ref{a0,,optparse} verifica se há conflitos com opções existentes. Se encontrar algum, ele invoca o mecanismo de tratamento de conflitos atual. Você pode definir o mecanismo de tratamento de conflitos no construtor:

@example
parser = OptionParser(..., conflict_handler=handler)
@end example

ou com uma chamada separada:

@example
parser.set_conflict_handler(handler)
@end example

Os manipuladores de conflitos disponíveis são:

@quotation


@table @asis

@item @code{"error"} (padrão)

presume que os conflitos de opções são um erro de programação e levanta @ref{3103,,OptionConflictError}

@item @code{"resolve"}

resolve conflitos de opções de forma inteligente (veja abaixo)
@end table
@end quotation

Como exemplo, vamos definir um @ref{1515,,OptionParser} que resolve conflitos de forma inteligente e adiciona opções conflitantes a ele:

@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

Neste ponto, @ref{a0,,optparse} detecta que uma opção adicionada anteriormente já está usando a string de opção @code{-n}. Como @code{conflict_handler} é @code{"resolve"}, ele resolve a situação removendo @code{-n} da lista de strings de opção da opção anterior. Agora @code{--dry-run} é a única maneira do usuário ativar essa opção. Se o usuário pedir ajuda, a mensagem de ajuda refletirá isso:

@example
Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy
@end example

É possível reduzir as strings de opção para uma opção adicionada anteriormente até que não haja mais nenhuma, e o usuário não tenha como invocar essa opção da linha de comando. Nesse caso, @ref{a0,,optparse} remove essa opção completamente, então ela não aparece no texto de ajuda ou em nenhum outro lugar. Continuando com nosso objeto OptionParser existente:

@example
parser.add_option("--dry-run", ..., help="new dry-run option")
@end example

Neste ponto, a opção original @code{-n}/@code{--dry-run} não está mais acessível, então @ref{a0,,optparse} a remove, deixando este texto de ajuda:

@example
Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option
@end example

@node Limpeza,Outros métodos,Conflitos entre opções,Guia de referência
@anchor{library/optparse cleanup}@anchor{3104}@anchor{library/optparse optparse-cleanup}@anchor{3105}
@subsubsection Limpeza


As instâncias de OptionParser têm várias referências cíclicas. Isso não deve ser um problema para o coletor de lixo do Python, mas você pode desejar quebrar as referências cíclicas explicitamente chamando @code{destroy()} no seu OptionParser quando terminar de usá-lo. Isso é particularmente útil em aplicações de longa execução, onde gráficos de objetos grandes podem ser acessados do seu OptionParser.

@node Outros métodos,,Limpeza,Guia de referência
@anchor{library/optparse optparse-other-methods}@anchor{3106}@anchor{library/optparse other-methods}@anchor{3107}
@subsubsection Outros métodos


OptionParser provê vários outros métodos públicos:

@geindex set_usage() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser set_usage}@anchor{3108}
@deffn {Método} OptionParser.set_usage (usage)

Defina a string de uso de acordo com as regras descritas acima para o argumento nomeado do construtor @code{usage}. Passar @code{None} define a string de uso padrão; use @code{optparse.SUPPRESS_USAGE} para suprimir uma mensagem de uso.
@end deffn

@geindex print_usage() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser print_usage}@anchor{30dd}
@deffn {Método} OptionParser.print_usage (file=None)

Exibe a mensagem de uso para o programa atual (@code{self.usage}) em `file' (stdout padrão). Qualquer ocorrência da string @code{%prog} em @code{self.usage} é substituída pelo nome do programa atual. Não faz nada se @code{self.usage} estiver vazio ou não definido.
@end deffn

@geindex get_usage() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser get_usage}@anchor{3109}
@deffn {Método} OptionParser.get_usage ()

O mesmo que @ref{30dd,,print_usage()}, mas retorna a string de uso em vez de exibi-la.
@end deffn

@geindex set_defaults() (método optparse.OptionParser)
@anchor{library/optparse optparse OptionParser set_defaults}@anchor{30f2}
@deffn {Método} OptionParser.set_defaults (dest=value, ...)

Define valores padrão para vários destinos de opção de uma vez. Usar @ref{30f2,,set_defaults()} é a maneira preferida de definir valores padrão para opções, já que várias opções podem compartilhar o mesmo destino. Por exemplo, se várias opções de “modo” definirem o mesmo destino, qualquer uma delas pode definir o padrão, e a última vence:

@example
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # substituída abaixo
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # substitui a configuração acima
@end example

Para evitar essa confusão, use @ref{30f2,,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 Funções de retorno de opção,Estendendo optparse,Guia de referência,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse option-callbacks}@anchor{310a}@anchor{library/optparse optparse-option-callbacks}@anchor{30d2}
@subsubsection Funções de retorno de opção


Quando as ações e tipos embutidos de @ref{a0,,optparse} não são o bastante para suas necessidades, você tem duas escolhas: estender @ref{a0,,optparse} ou definir uma opção de retorno de chamada. Estender @ref{a0,,optparse} é mais geral, mas exagero para muitos casos simples. Muitas vezes, um retorno de chamada simples é tudo o que você precisa.

Há duas etapas para definir uma opção de retorno de chamada:


@itemize *

@item 
definir a opção em si usando a ação @code{"callback"}

@item 
escrever o função de retorno; esta é uma função (ou método) que recebe pelo menos quatro argumentos, conforme descrito abaixo
@end itemize

@menu
* Definindo uma opção de retorno de chamada:: 
* Como os retornos de chamada são chamados:: 
* Levantando erros em uma função de retorno:: 
* Exemplo de função de retorno 1; retorno de chamada trivial: Exemplo de função de retorno 1 retorno de chamada trivial. 
* Exemplo de função de retorno 2; verificar a ordem das opções: Exemplo de função de retorno 2 verificar a ordem das opções. 
* Exemplo 3 de função de retorno; verificar a ordem das opções (generalizada): Exemplo 3 de função de retorno verificar a ordem das opções generalizada. 
* Exemplo de função de retorno 4; verificar uma condição arbitrária: Exemplo de função de retorno 4 verificar uma condição arbitrária. 
* Exemplo de função de retorno 5; argumentos fixos: Exemplo de função de retorno 5 argumentos fixos. 
* Exemplo de função de retorno 6; argumentos variáveis: Exemplo de função de retorno 6 argumentos variáveis. 

@end menu

@node Definindo uma opção de retorno de chamada,Como os retornos de chamada são chamados,,Funções de retorno de opção
@anchor{library/optparse defining-a-callback-option}@anchor{310b}@anchor{library/optparse optparse-defining-callback-option}@anchor{310c}
@subsubsection Definindo uma opção de retorno de chamada


Como sempre, a maneira mais fácil de definir uma opção de retorno de chamada é usando o método @ref{30af,,OptionParser.add_option()}. Além de @ref{30c3,,action}, o único atributo de opção que você deve especificar é @code{callback}, a função a ser chamada:

@example
parser.add_option("-c", action="callback", callback=my_callback)
@end example

@code{callback} é uma função (ou outro objeto chamável), então você já deve ter definido @code{my_callback()} quando criar esta opção de retorno de chamada. Neste caso simples, @ref{a0,,optparse} nem sabe se @code{-c} aceita argumentos, o que geralmente significa que a opção não aceita argumentos — a mera presença de @code{-c} na linha de comando é tudo o que ela precisa saber. Em algumas circunstâncias, no entanto, você pode querer que seu retorno de chamada consuma um número arbitrário de argumentos de linha de comando. É aqui que escrever retornos de chamada fica complicado; isso é abordado mais adiante nesta seção.

@ref{a0,,optparse} sempre passa quatro argumentos particulares para seu retorno de chamada, e ele só passará argumentos adicionais se você especificá-los via @ref{30f6,,callback_args} e @ref{30f7,,callback_kwargs}. Assim, a assinatura mínima da função de retorno de chamada é:

@example
def my_callback(option, opt, value, parser):
@end example

Os quatro argumentos para um retorno de chamada são descritos abaixo.

Há vários outros atributos de opção que você pode fornecer ao definir uma opção de retorno de chamada:


@table @asis

@item @ref{30c4,,type}

tem seu significado usual: como com as ações @code{"store"} ou @code{"append"}, ele instrui @ref{a0,,optparse} a consumir um argumento e convertê-lo para @ref{30c4,,type}. Em vez de armazenar o(s) valor(es) convertido(s) em qualquer lugar, no entanto, @ref{a0,,optparse} os passa para sua função de retorno de chamada.

@item @ref{30f3,,nargs}

também tem seu significado usual: se for fornecido e > 1, @ref{a0,,optparse} consumirá argumentos @ref{30f3,,nargs}, cada um dos quais deve ser conversível para @ref{30c4,,type}. Em seguida, ele passa uma tupla de valores convertidos para seu retorno de chamada.

@item @ref{30f6,,callback_args}

uma tupla de argumentos posicionais extras para passar para a função de retorno

@item @ref{30f7,,callback_kwargs}

um dicionário de argumentos nomeados extras para passar para a função de retorno
@end table

@node Como os retornos de chamada são chamados,Levantando erros em uma função de retorno,Definindo uma opção de retorno de chamada,Funções de retorno de opção
@anchor{library/optparse how-callbacks-are-called}@anchor{310d}@anchor{library/optparse optparse-how-callbacks-called}@anchor{310e}
@subsubsection Como os retornos de chamada são chamados


Todos os retornos de chamada são chamados da seguinte forma:

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

onde


@table @asis

@item @code{option}

é a instância de Option que está chamando o retorno de chamada

@item @code{opt_str}

é a string de opção vista na linha de comando que está acionando o retorno de chamada. (Se uma opção longa abreviada foi usada, @code{opt_str} será a string de opção canônica completa — por exemplo, se o usuário colocar @code{--foo} na linha de comando como uma abreviação para @code{--foobar}, então @code{opt_str} será @code{"--foobar"}.)

@item @code{value}

é o argumento para esta opção visto na linha de comando. @ref{a0,,optparse} só esperará um argumento se @ref{30c4,,type} estiver definido; o tipo de @code{value} será o tipo implícito pelo tipo da opção. Se @ref{30c4,,type} para esta opção for @code{None} (nenhum argumento esperado), então @code{value} será @code{None}. Se @ref{30f3,,nargs} > 1, @code{value} será uma tupla de valores do tipo apropriado.

@item @code{parser}

é a instância OptionParser que controla tudo, útil principalmente porque você pode acessar alguns outros dados interessantes por meio de seus atributos de instância:


@table @asis

@item @code{parser.largs}

a lista atual de argumentos restantes, ou seja, argumentos que foram consumidos, mas não são opções nem argumentos de opção. Sinta-se à vontade para modificar @code{parser.largs}, por exemplo, adicionando mais argumentos a ele. (Esta lista se tornará @code{args}, o segundo valor de retorno de @ref{1516,,parse_args()}.)

@item @code{parser.rargs}

a lista atual de argumentos restantes, ou seja, com @code{opt_str} e @code{value} (se aplicável) removidos, e apenas os argumentos que os seguem ainda lá. Sinta-se à vontade para modificar @code{parser.rargs}, por exemplo, consumindo mais argumentos.

@item @code{parser.values}

o objeto onde os valores de opção são armazenados por padrão (uma instância de optparse.OptionValues). Isso permite que as função de retorno usem o mesmo mecanismo que o resto de @ref{a0,,optparse} para armazenar valores de opção; você não precisa mexer com globais ou closures. Você também pode acessar ou modificar o(s) valor(es) de quaisquer opções já encontradas na linha de comando.
@end table

@item @code{args}

é uma tupla de argumentos posicionais arbitrários fornecidos por meio do atributo de opção @ref{30f6,,callback_args}.

@item @code{kwargs}

é um dicionário de argumentos nomeados arbitrários fornecidos via @ref{30f7,,callback_kwargs}.
@end table

@node Levantando erros em uma função de retorno,Exemplo de função de retorno 1 retorno de chamada trivial,Como os retornos de chamada são chamados,Funções de retorno de opção
@anchor{library/optparse optparse-raising-errors-in-callback}@anchor{310f}@anchor{library/optparse raising-errors-in-a-callback}@anchor{3110}
@subsubsection Levantando erros em uma função de retorno


A função de retorno de chamada deve levantar @ref{30b3,,OptionValueError} se houver algum problema com a opção ou seu(s) argumento(s). @ref{a0,,optparse} captura isso e encerra o programa, exibindo a mensagem de erro que você fornece para stderr. Sua mensagem deve ser clara, concisa, precisa e mencionar a opção com defeito. Caso contrário, o usuário terá dificuldade em descobrir o que fez de errado.

@node Exemplo de função de retorno 1 retorno de chamada trivial,Exemplo de função de retorno 2 verificar a ordem das opções,Levantando erros em uma função de retorno,Funções de retorno de opção
@anchor{library/optparse callback-example-1-trivial-callback}@anchor{3111}@anchor{library/optparse optparse-callback-example-1}@anchor{3112}
@subsubsection Exemplo de função de retorno 1: retorno de chamada trivial


Aqui está um exemplo de uma opção de retorno de chamada que não aceita argumentos e simplesmente registra que a opção foi vista:

@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

Claro, você pode fazer isso com a ação @code{"store_true"}.

@node Exemplo de função de retorno 2 verificar a ordem das opções,Exemplo 3 de função de retorno verificar a ordem das opções generalizada,Exemplo de função de retorno 1 retorno de chamada trivial,Funções de retorno de opção
@anchor{library/optparse callback-example-2-check-option-order}@anchor{3113}@anchor{library/optparse optparse-callback-example-2}@anchor{3114}
@subsubsection Exemplo de função de retorno 2: verificar a ordem das opções


Aqui está um exemplo um pouco mais interessante: registra o fato de que @code{-a} é visto, mas explode se ele vier depois de @code{-b} na linha de comando.

@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 Exemplo 3 de função de retorno verificar a ordem das opções generalizada,Exemplo de função de retorno 4 verificar uma condição arbitrária,Exemplo de função de retorno 2 verificar a ordem das opções,Funções de retorno de opção
@anchor{library/optparse callback-example-3-check-option-order-generalized}@anchor{3115}@anchor{library/optparse optparse-callback-example-3}@anchor{3116}
@subsubsection Exemplo 3 de função de retorno: verificar a ordem das opções (generalizada)


Se você quiser reutilizar essa função de retorno para várias opções semelhantes (definir um sinalizador, mas explodir se @code{-b} já tiver sido visto), será preciso um pouco de trabalho: a mensagem de erro e o sinalizador que ele define devem ser generalizados.

@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 Exemplo de função de retorno 4 verificar uma condição arbitrária,Exemplo de função de retorno 5 argumentos fixos,Exemplo 3 de função de retorno verificar a ordem das opções generalizada,Funções de retorno de opção
@anchor{library/optparse callback-example-4-check-arbitrary-condition}@anchor{3117}@anchor{library/optparse optparse-callback-example-4}@anchor{3118}
@subsubsection Exemplo de função de retorno 4: verificar uma condição arbitrária


Claro, você pode colocar qualquer condição ali—você não está limitado a verificar os valores de opções já definidas. Por exemplo, se você tem opções que não devem ser chamadas quando a lua está cheia, tudo o que você tem a fazer é isto:

@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

(A definição de @code{is_moon_full()} é deixada como um exercício para o leitor.)

@node Exemplo de função de retorno 5 argumentos fixos,Exemplo de função de retorno 6 argumentos variáveis,Exemplo de função de retorno 4 verificar uma condição arbitrária,Funções de retorno de opção
@anchor{library/optparse callback-example-5-fixed-arguments}@anchor{3119}@anchor{library/optparse optparse-callback-example-5}@anchor{311a}
@subsubsection Exemplo de função de retorno 5: argumentos fixos


As coisas ficam um pouco mais interessantes quando você define opções de retorno de chamada que aceitam um número fixo de argumentos. Especificar que uma opção de retorno de chamada aceita argumentos é semelhante a definir uma opção @code{"store"} ou @code{"append"}: se você definir @ref{30c4,,type}, então a opção aceita um argumento que deve ser conversível para esse tipo; se você definir ainda @ref{30f3,,nargs}, então a opção aceita argumentos @ref{30f3,,nargs}.

Aqui está um exemplo que apenas emula a ação padrão @code{"store"}:

@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

Note que @ref{a0,,optparse} cuida de consumir 3 argumentos e convertê-los em números inteiros para você; tudo o que você precisa fazer é armazená-los. (Ou o que for; obviamente você não precisa de uma função de retorno de chamada para este exemplo.)

@node Exemplo de função de retorno 6 argumentos variáveis,,Exemplo de função de retorno 5 argumentos fixos,Funções de retorno de opção
@anchor{library/optparse callback-example-6-variable-arguments}@anchor{311b}@anchor{library/optparse optparse-callback-example-6}@anchor{311c}
@subsubsection Exemplo de função de retorno 6: argumentos variáveis


As coisas ficam complicadas quando você quer que uma opção receba um número variável de argumentos. Para esse caso, você deve escrever uma função de retorno, pois @ref{a0,,optparse} não fornece nenhuma capacidade embutida para ele. E você tem que lidar com certas complexidades da análise sintática de linha de comando Unix convencional que @ref{a0,,optparse} normalmente lida para você. Em particular, as funções de retorno devem implementar as regras convencionais para argumentos @code{--} e @code{-} simples:


@itemize *

@item 
@code{--} ou @code{-} podem ser argumentos de opção

@item 
@code{--} apenas (se não for o argumento para alguma opção): interrompe o processamento da linha de comando e descarta o @code{--}

@item 
@code{-} apenas (se não for o argumento para alguma opção): interrompe o processamento da linha de comando, mas mantém o @code{-} (anexa-o a @code{parser.largs})
@end itemize

Se você quiser uma opção que aceite um número variável de argumentos, há várias questões sutis e complicadas com as quais se preocupar. A implementação exata que você escolher será baseada em quais compensações você está disposto a fazer para sua aplicação (é por isso que @ref{a0,,optparse} não oferece suporte a esse tipo de coisa diretamente).

No entanto, aqui vai uma tentativa de função de retorno para uma opção com argumentos variáveis:

@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:
        # para em --foo como opções
        if arg[:2] == "--" and len(arg) > 2:
            break
        # para em -a, mas não em -3 ou -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 Estendendo optparse,Exceções<10>,Funções de retorno de opção,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse extending-optparse}@anchor{311d}@anchor{library/optparse optparse-extending-optparse}@anchor{30c9}
@subsubsection Estendendo @code{optparse}


Como os dois principais fatores de controle sobre como @ref{a0,,optparse} interpreta as opções de linha de comando são a ação e o tipo de cada opção, a direção mais provável de extensão é adicionar novas ações e novos tipos.

@menu
* Adicionando novos tipos:: 
* Adicionando novas ações:: 

@end menu

@node Adicionando novos tipos,Adicionando novas ações,,Estendendo optparse
@anchor{library/optparse adding-new-types}@anchor{311e}@anchor{library/optparse optparse-adding-new-types}@anchor{311f}
@subsubsection Adicionando novos tipos


Para adicionar novos tipos, você precisa definir sua própria subclasse da classe @ref{30eb,,Option} de @ref{a0,,optparse}. Esta classe tem alguns atributos que definem os tipos de @ref{a0,,optparse}: @ref{3120,,TYPES} e @ref{3121,,TYPE_CHECKER}.

@geindex TYPES (atributo optparse.Option)
@anchor{library/optparse optparse Option TYPES}@anchor{3120}
@deffn {Atributo} Option.TYPES

Uma tupla de nomes de tipos; na sua subclasse, basta definir uma nova tupla @ref{3120,,TYPES} que se baseia na tupla padrão.
@end deffn

@geindex TYPE_CHECKER (atributo optparse.Option)
@anchor{library/optparse optparse Option TYPE_CHECKER}@anchor{3121}
@deffn {Atributo} Option.TYPE_CHECKER

Um dicionário que mapeia nomes de tipos para funções de verificação de tipos. Uma função de verificação de tipos tem a seguinte assinatura:

@example
def check_mytype(option, opt, value)
@end example

sendo @code{option} uma instância @ref{30eb,,Option}, @code{opt} é uma string de opção (por exemplo, @code{-f}), e @code{value} é a string da linha de comando que deve ser verificada e convertida para o tipo desejado. @code{check_mytype()} deve retornar um objeto do tipo hipotético @code{mytype}. O valor retornado por uma função de verificação de tipo acabará na instância OptionValues retornada por @ref{1516,,OptionParser.parse_args()}, ou será passado para uma função de retorno como o parâmetro @code{value}.

Sua função de verificação de tipo deve levantar @ref{30b3,,OptionValueError} se encontrar algum problema. @ref{30b3,,OptionValueError} recebe um único argumento de string, que é passado como está para o método @code{error()} do @ref{1515,,OptionParser}, que por sua vez adiciona o nome do programa e a string @code{"error:"} e exibe tudo no stderr antes de encerrar o processo.
@end deffn

Aqui está um exemplo bobo que demonstra a adição de um tipo de opção @code{"complex"} para analisar números complexos no estilo Python na linha de comando. (Isso é ainda mais bobo do que costumava ser, porque @ref{a0,,optparse} 1.3 adicionou suporte embutido para números complexos, mas não importa.)

Primeiro, as importações necessárias:

@example
from copy import copy
from optparse import Option, OptionValueError
@end example

Você precisa definir seu verificador de tipo primeiro, pois ele será referenciado mais tarde (no atributo de classe @ref{3121,,TYPE_CHECKER} da sua subclasse 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, a subclasse de Option:

@example
class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex
@end example

(Se não fizéssemos uma @ref{25,,copy()} de @ref{3121,,Option.TYPE_CHECKER}, acabaríamos modificando o atributo @ref{3121,,TYPE_CHECKER} da classe Option de @ref{a0,,optparse}. Sendo Python, nada impede você de fazer isso, exceto boas maneiras e bom senso.)

Pronto! Agora você pode escrever um script que usa o novo tipo de opção como qualquer outro script baseado em @ref{a0,,optparse}, exceto que você tem que instruir seu OptionParser a usar MyOption em vez de Option:

@example
parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")
@end example

Como alternativa, você pode criar sua própria lista de opções e passá-la para o OptionParser; se você não usar @code{add_option()} da maneira acima, não precisa informar ao OptionParser qual classe de opção usar:

@example
option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)
@end example

@node Adicionando novas ações,,Adicionando novos tipos,Estendendo optparse
@anchor{library/optparse adding-new-actions}@anchor{3122}@anchor{library/optparse optparse-adding-new-actions}@anchor{3123}
@subsubsection Adicionando novas ações


A adição de novas ações é um pouco mais complicado, porque você precisa entender que @ref{a0,,optparse} tem algumas classificações para ações:


@table @asis

@item Ações “store”

ações que resultam em @ref{a0,,optparse} armazenando um valor em um atributo da instância OptionValues atual; essas opções exigem que um atributo @ref{30c5,,dest} seja fornecido ao construtor Option.

@item Ações “typed”

Ações que pegam um valor da linha de comando e esperam que ele seja de um certo tipo; ou melhor, uma string que pode ser convertida para um certo tipo. Essas opções requerem um atributo @ref{30c4,,type} para o construtor Option.
@end table

Esses são conjuntos sobrepostos: algumas ações “store” padrão são @code{"store"}, @code{"store_const"}, @code{"append"} e @code{"count"}, enquanto as ações “typed” padrão são @code{"store"}, @code{"append"} e @code{"callback"}.

Ao adicionar uma ação, você precisa categorizá-la listando-a em pelo menos um dos seguintes atributos de classe de Option (todos são listas de strings):

@geindex ACTIONS (atributo optparse.Option)
@anchor{library/optparse optparse Option ACTIONS}@anchor{3124}
@deffn {Atributo} Option.ACTIONS

Todas as ações devem ser listadas em ACTIONS.
@end deffn

@geindex STORE_ACTIONS (atributo optparse.Option)
@anchor{library/optparse optparse Option STORE_ACTIONS}@anchor{3125}
@deffn {Atributo} Option.STORE_ACTIONS

As ações “store” também são listadas aqui.
@end deffn

@geindex TYPED_ACTIONS (atributo optparse.Option)
@anchor{library/optparse optparse Option TYPED_ACTIONS}@anchor{3126}
@deffn {Atributo} Option.TYPED_ACTIONS

As ações “typed” também são listadas aqui.
@end deffn

@geindex ALWAYS_TYPED_ACTIONS (atributo optparse.Option)
@anchor{library/optparse optparse Option ALWAYS_TYPED_ACTIONS}@anchor{3127}
@deffn {Atributo} Option.ALWAYS_TYPED_ACTIONS

Ações que sempre assumem um tipo (ou seja, cujas opções sempre assumem um valor) são listadas aqui adicionalmente. O único efeito disso é que @ref{a0,,optparse} atribui o tipo padrão, @code{"string"}, a opções sem tipo explícito cuja ação é listada em @ref{3127,,ALWAYS_TYPED_ACTIONS}.
@end deffn

Para realmente implementar sua nova ação, você deve substituir o método @code{take_action()} de Option e adicionar um caso que reconheça sua ação.

Por exemplo, vamos adicionar uma ação @code{"extend"}. Isso é semelhante à ação padrão @code{"append"}, mas em vez de pegar um único valor da linha de comando e anexá-lo a uma lista existente, @code{"extend"} pegará vários valores em uma única string delimitada por vírgulas e estenderá uma lista existente com eles. Ou seja, se @code{--names} for uma opção @code{"extend"} do tipo @code{"string"}, a linha de comando

@example
--names=foo,bar --names blah --names ding,dong
@end example

resultaria em uma lista

@example
["foo", "bar", "blah", "ding", "dong"]
@end example

Novamente, nós definimos uma subclasse 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

Características de nota:


@itemize *

@item 
@code{"extend"} espera um valor na linha de comando e armazena esse valor em algum lugar, então ele vai em @ref{3125,,STORE_ACTIONS} e @ref{3126,,TYPED_ACTIONS}.

@item 
para garantir que @ref{a0,,optparse} atribua o tipo padrão de @code{"string"} às ações @code{"extend"}, colocamos a ação @code{"extend"} em @ref{3127,,ALWAYS_TYPED_ACTIONS} também.

@item 
@code{MyOption.take_action()} implementa apenas esta nova ação e passa o controle de volta para @code{Option.take_action()} para as ações padrão @ref{a0,,optparse}.

@item 
@code{values} é uma instância da classe optparse_parser.Values, que fornece o método muito útil @code{ensure_value()}. @code{ensure_value()} é essencialmente @ref{bea,,getattr()} com uma válvula de segurança; é chamado como

@example
values.ensure_value(attr, value)
@end example

Se o atributo @code{attr} de @code{values} não existir ou for @code{None}, então ensure_value() primeiro o define como @code{value} e então retorna @code{value}. Isso é muito útil para ações como @code{"extend"}, @code{"append"} e @code{"count"}, todas as quais acumulam dados em uma variável e esperam que essa variável seja de um certo tipo (uma lista para as duas primeiras, um inteiro para a última). Usar @code{ensure_value()} significa que os scripts que usam sua ação não precisam se preocupar em definir um valor padrão para os destinos de opção em questão; eles podem simplesmente deixar o padrão como @code{None} e @code{ensure_value()} cuidará de acertar quando for necessário.
@end itemize

@node Exceções<10>,,Estendendo optparse,optparse — Analisador sintático para opções de linha de comando
@anchor{library/optparse exceptions}@anchor{3128}
@subsubsection Exceções


@geindex OptionError
@anchor{library/optparse optparse OptionError}@anchor{30b2}
@deffn {Exceção} optparse.OptionError

Levantada se uma instância de @ref{30eb,,Option} for criada com argumentos inválidos ou inconsistentes.
@end deffn

@geindex OptionConflictError
@anchor{library/optparse optparse OptionConflictError}@anchor{3103}
@deffn {Exceção} optparse.OptionConflictError

Levantada se opções conflitantes forem adicionadas a um instância de @ref{1515,,OptionParser}.
@end deffn

@geindex OptionValueError
@anchor{library/optparse optparse OptionValueError}@anchor{30b3}
@deffn {Exceção} optparse.OptionValueError

Levantada se um valor de opção inválido for encontrado na linha de comando.
@end deffn

@geindex BadOptionError
@anchor{library/optparse optparse BadOptionError}@anchor{3129}
@deffn {Exceção} optparse.BadOptionError

Levantada se uma opção inválida for passada na linha de comando.
@end deffn

@geindex AmbiguousOptionError
@anchor{library/optparse optparse AmbiguousOptionError}@anchor{312a}
@deffn {Exceção} optparse.AmbiguousOptionError

Levantada se uma opção ambígua for passada na linha de comando.
@end deffn

@node getpass — Entrada de senha portátil,fileinput — Itera sobre linhas de múltiplos fluxos de entrada,optparse — Analisador sintático para opções de linha de comando,Bibliotecas de interface de linha de comando
@anchor{library/getpass doc}@anchor{312b}@anchor{library/getpass getpass-portable-password-input}@anchor{312c}@anchor{library/getpass module-getpass}@anchor{62}@anchor{library/getpass translation-repo}@anchor{312d}
@subsection @code{getpass} — Entrada de senha portátil


@geindex module; getpass

@c Windows (& Mac?) support by Guido van Rossum.

`Código-fonte:' Lib/getpass.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/getpass.py}


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

O módulo @ref{62,,getpass} fornece duas funções:

@geindex getpass() (no módulo getpass)
@anchor{library/getpass getpass getpass}@anchor{312e}
@deffn {Função} getpass.getpass (prompt='Password: ', stream=None)

Solicita uma senha do usuário sem emiti-la. O usuário é solicitado usando a string `prompt', cujo padrão é @code{'Password: '}. No Unix, o prompt é escrito no objeto arquivo ou similar `stream' usando o tratador de erros de substituição, se necessário. O `stream' padrão para o terminal de controle (@code{/dev/tty}) ou se não estiver disponível para @code{sys.stderr} (este argumento é ignorado no Windows).

Se uma entrada sem exibição em tela não estiver disponível, getpass() recorre a exibir uma mensagem de aviso para `stream' e lê de @code{sys.stdin} e levantar de um @ref{312f,,GetPassWarning}.

@cartouche
@quotation Nota 
Se você chamar getpass de dentro do IDLE, a entrada pode ser feita no terminal de onde você iniciou o IDLE, e não na própria janela ociosa.
@end quotation
@end cartouche
@end deffn

@geindex GetPassWarning
@anchor{library/getpass getpass GetPassWarning}@anchor{312f}
@deffn {Exceção} getpass.GetPassWarning

A subclasse @ref{244b,,UserWarning} é levantada quando a entrada de senha pode acabar sendo exibida na tela.
@end deffn

@geindex getuser() (no módulo getpass)
@anchor{library/getpass getpass getuser}@anchor{418}
@deffn {Função} getpass.getuser ()

Retorna o “nome de login” do usuário.

Esta função verifica as variáveis de ambiente 
@geindex LOGNAME
@geindex variável de ambiente; LOGNAME
@code{LOGNAME}, 
@geindex USER
@geindex variável de ambiente; USER
@code{USER}, @code{LNAME} e 
@geindex USERNAME
@geindex variável de ambiente; USERNAME
@code{USERNAME}, nesta ordem, e retorna o valor da primeiro que estiver definida como uma string não vazia. Se nenhuma estiver definida, o nome de login do banco de dados de senhas é retornado em sistemas que oferecem suporte ao módulo @ref{b2,,pwd}, caso contrário, uma exceção @ref{417,,OSError} é levantada.

Em geral, esta função deve ter preferência sobre @ref{1613,,os.getlogin()}.


Alterado na versão 3.13: Anteriormente, várias exceções além de apenas @ref{417,,OSError} eram levantadas.

@end deffn

@node fileinput — Itera sobre linhas de múltiplos fluxos de entrada,curses — Gerenciador de terminal para visualizadores de células de caracteres,getpass — Entrada de senha portátil,Bibliotecas de interface de linha de comando
@anchor{library/fileinput doc}@anchor{3130}@anchor{library/fileinput fileinput-iterate-over-lines-from-multiple-input-streams}@anchor{3131}@anchor{library/fileinput module-fileinput}@anchor{5b}@anchor{library/fileinput translation-repo}@anchor{3132}
@subsection @code{fileinput} — Itera sobre linhas de múltiplos fluxos de entrada


@geindex module; fileinput

`Código-fonte:' Lib/fileinput.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/fileinput.py}


__________________________________________________________________


Este módulo implementa uma classe auxiliar e funções para escrever rapidamente um laço sobre uma entrada padrão ou uma lista de arquivos. Se você quiser apenas ler ou escrever um arquivo veja @ref{51c,,open()}.

O uso típico é:

@example
import fileinput
for line in fileinput.input(encoding="utf-8"):
    process(line)
@end example

Isto itera sobre as linhas de todos os arquivos listados em @code{sys.argv[1:]}, padronizando @code{sys.stdin} se a lista estiver vazia. Se o nome de um arquivo for @code{'-'}, ele também será substituído por @code{sys.stdin} e os argumentos opcionais `mode' e `openhook' serão ignorados. Para especificar uma lista alternativa de nomes de arquivos, passe-a como primeiro argumento para @ref{802,,input()}. Um único nome de arquivo também é permitido.

Todos os arquivos são abertos em modo texto por padrão, mas você pode substituir isso especificando o parâmetro `mode' na chamada para @ref{802,,input()} ou @ref{737,,FileInput}. Se ocorrer um erro de E/S durante a abertura ou leitura de um arquivo, @ref{417,,OSError} será levantada.


Alterado na versão 3.3: @ref{108b,,IOError} costumava ser levantada; agora é um apelido de @ref{417,,OSError}.


Se @code{sys.stdin} for usado mais de uma vez, o segundo e posterior uso não retornará nenhuma linha, exceto talvez para uso interativo, ou se tiver sido explicitamente redefinido (por exemplo, usando @code{sys.stdin.seek(0)}).

Arquivos vazios são abertos e fechados imediatamente; a única vez que sua presença na lista de nomes de arquivos é perceptível é quando o último arquivo aberto está vazio.

As linhas são retornadas com novas linhas intactas, o que significa que a última linha de um arquivo pode não ter nenhuma.

Você pode controlar como os arquivos são abertos fornecendo um gancho de abertura através do parâmetro `openhook' para @ref{802,,fileinput.input()} ou @ref{737,,FileInput()}. O gancho deve ser uma função que recebe dois argumentos, `filename' e `mode', e retorna um objeto arquivo ou similar aberto de acordo. Se `encoding' e/ou `errors' forem especificados, eles serão passados para o gancho como argumentos nomeados adicionais. Este módulo fornece um @ref{803,,hook_compressed()} para oferece suporte a arquivos compactados.

A seguinte função é a interface principal deste módulo:

@geindex input() (no módulo fileinput)
@anchor{library/fileinput fileinput input}@anchor{802}
@deffn {Função} fileinput.input (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

Cria uma instância da classe @ref{737,,FileInput}. A instância será usada como estado global para as funções deste módulo e também será retornada para uso durante a iteração. Os parâmetros desta função serão passados para o construtor da classe @ref{737,,FileInput}.

A instância @ref{737,,FileInput} pode ser usada como um gerenciador de contexto na instrução @ref{5d2,,with}. Neste exemplo, `input' é fechado após a saída da instrução @code{with}, mesmo se ocorrer uma exceção:

@example
with fileinput.input(files=('spam.txt', 'eggs.txt'), encoding="utf-8") as f:
    for line in f:
        process(line)
@end example


Alterado na versão 3.2: Pode ser usado como gerenciador de contexto.



Alterado na versão 3.8: Os parâmetros nomeados `mode' e `openhook' agora são somente-nomeados.



Alterado na versão 3.10: Os parâmetros somente-nomeados `encoding' e `errors' foram adicionados.

@end deffn

As funções a seguir usam o estado global criado por @ref{802,,fileinput.input()}; se não houver estado ativo, @ref{195,,RuntimeError} será levantada.

@geindex filename() (no módulo fileinput)
@anchor{library/fileinput fileinput filename}@anchor{3133}
@deffn {Função} fileinput.filename ()

Retorna o nome do arquivo que está sendo lido no momento. Antes da primeira linha ser lida, retorna @code{None}.
@end deffn

@geindex fileno() (no módulo fileinput)
@anchor{library/fileinput fileinput fileno}@anchor{1475}
@deffn {Função} fileinput.fileno ()

Retorna o número inteiro de “descritor de arquivo” para o arquivo atual. Quando nenhum arquivo é aberto (antes da primeira linha e entre arquivos), retorna @code{-1}.
@end deffn

@geindex lineno() (no módulo fileinput)
@anchor{library/fileinput fileinput lineno}@anchor{3134}
@deffn {Função} fileinput.lineno ()

Retorna o número cumulativo da linha que acabou de ser lida. Antes da primeira linha ser lida, retorna @code{0}. Após a leitura da última linha do último arquivo, retorna o número da linha dessa linha.
@end deffn

@geindex filelineno() (no módulo fileinput)
@anchor{library/fileinput fileinput filelineno}@anchor{3135}
@deffn {Função} fileinput.filelineno ()

Retorna o número da linha no arquivo atual. Antes da primeira linha ser lida, retorna @code{0}. Após a leitura da última linha do último arquivo, retorna o número da linha dessa linha no arquivo.
@end deffn

@geindex isfirstline() (no módulo fileinput)
@anchor{library/fileinput fileinput isfirstline}@anchor{3136}
@deffn {Função} fileinput.isfirstline ()

Retorna @code{True} se a linha que acabou de ler for a primeira linha do seu arquivo, caso contrário retorna @code{False}.
@end deffn

@geindex isstdin() (no módulo fileinput)
@anchor{library/fileinput fileinput isstdin}@anchor{3137}
@deffn {Função} fileinput.isstdin ()

Retorna @code{True} se a última linha foi lida em @code{sys.stdin}, caso contrário retorna @code{False}.
@end deffn

@geindex nextfile() (no módulo fileinput)
@anchor{library/fileinput fileinput nextfile}@anchor{3138}
@deffn {Função} fileinput.nextfile ()

Fecha o arquivo atual para que a próxima iteração leia a primeira linha do próximo arquivo (se houver); as linhas não lidas do arquivo não contarão para a contagem cumulativa de linhas. O nome do arquivo não é alterado até que a primeira linha do próximo arquivo seja lida. Antes da leitura da primeira linha, esta função não tem efeito; ele não pode ser usado para pular o primeiro arquivo. Após a leitura da última linha do último arquivo, esta função não terá efeito.
@end deffn

@geindex close() (no módulo fileinput)
@anchor{library/fileinput fileinput close}@anchor{3139}
@deffn {Função} fileinput.close ()

Fecha a sequência.
@end deffn

A classe que implementa o comportamento de sequência fornecido pelo módulo também está disponível para subclasses:

@geindex FileInput (classe em fileinput)
@anchor{library/fileinput fileinput FileInput}@anchor{737}
@deffn {Classe} fileinput.FileInput (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

A classe @ref{737,,FileInput} é a implementação; seus métodos @ref{3133,,filename()}, @ref{1475,,fileno()}, @ref{3134,,lineno()}, @ref{3135,,filelineno()}, @ref{3136,,isfirstline()}, @ref{3137,,isstdin()}, @ref{3138,,nextfile()} e @ref{3139,,close()} correspondem às funções de mesmo nome no módulo. Além disso, é @ref{1268,,iterável} e possui um método @ref{1e46,,readline()} que retorna a próxima linha de entrada. A sequência deve ser acessada em ordem estritamente sequencial; acesso aleatório e @ref{1e46,,readline()} não podem ser misturados.

Com `mode' você pode especificar qual modo de arquivo será passado para @ref{51c,,open()}. Deve ser um entre @code{'r'} e @code{'rb'}.

O `openhook', quando fornecido, deve ser uma função que recebe dois argumentos, `filename' e `mode', e retorna um objeto arquivo ou similar aberto de acordo. Você não pode usar `inplace' e `openhook' juntos.

Você pode especificar `encoding' e `errors' que são passados para @ref{51c,,open()} ou `openhook'.

Uma instância @ref{737,,FileInput} pode ser usada como um gerenciador de contexto na instrução @ref{5d2,,with}. Neste exemplo, `input' é fechado após a saída da instrução @code{with}, mesmo se ocorrer uma exceção:

@example
with FileInput(files=('spam.txt', 'eggs.txt')) as input:
    process(input)
@end example


Alterado na versão 3.2: Pode ser usado como gerenciador de contexto.



Alterado na versão 3.8: Os parâmetros nomeados `mode' e `openhook' agora são somente-nomeados.



Alterado na versão 3.10: Os parâmetros somente-nomeados `encoding' e `errors' foram adicionados.



Alterado na versão 3.11: Os modos @code{'rU'} e @code{'U'} e o método @code{__getitem__()} foram removidos.

@end deffn

`Filtragem local opcional:' se o argumento nomeado @code{inplace=True} for passado para @ref{802,,fileinput.input()} ou para o construtor @ref{737,,FileInput}, o arquivo é movido para um arquivo de backup e a saída padrão é direcionada para o arquivo de entrada (se já existir um arquivo com o mesmo nome do arquivo de backup, ele será substituído silenciosamente). Isso torna possível escrever um filtro que reescreva seu arquivo de entrada internamente. Se o parâmetro `backup' for fornecido (normalmente como @code{backup='.<some extension>'}), ele especifica a extensão do arquivo de backup, e o arquivo de backup permanece disponível; por padrão, a extensão é @code{'.bak'} e é excluída quando o arquivo de saída é fechado. A filtragem local é desativada quando a entrada padrão é lida.

Os dois ganchos de abertura a seguir são fornecidos por este módulo:

@geindex hook_compressed() (no módulo fileinput)
@anchor{library/fileinput fileinput hook_compressed}@anchor{803}
@deffn {Função} fileinput.hook_compressed (filename, mode, *, encoding=None, errors=None)

Abre de forma transparente arquivos compactados com gzip e bzip2 (reconhecidos pelas extensões @code{'.gz'} e @code{'.bz2'}) usando os módulos @ref{67,,gzip} e @ref{13,,bz2}. Se a extensão do nome do arquivo não for @code{'.gz'} ou @code{'.bz2'}, o arquivo é aberto normalmente (ou seja, usando @ref{51c,,open()} sem qualquer descompactação).

Os valores `encoding' e `errors' são passados para @ref{7bc,,io.TextIOWrapper} para arquivos compactados e abertos para arquivos normais.

Exemplo de uso: @code{fi = fileinput.FileInput(openhook=fileinput.hook_compressed, encoding="utf-8")}


Alterado na versão 3.10: Os parâmetros somente-nomeados `encoding' e `errors' foram adicionados.

@end deffn

@geindex hook_encoded() (no módulo fileinput)
@anchor{library/fileinput fileinput hook_encoded}@anchor{cc0}
@deffn {Função} fileinput.hook_encoded (encoding, errors=None)

Retorna um gancho que abre cada arquivo com @ref{51c,,open()}, usando a `encoding' e `errors' fornecidas para ler o arquivo.

Exemplo de uso: @code{fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))}


Alterado na versão 3.6: Adicionado o parâmetro opcional `errors'.



Descontinuado desde a versão 3.10: Esta função foi descontinuado já que @ref{802,,fileinput.input()} e @ref{737,,FileInput} agora possuem parâmetros `encoding' e `errors'.

@end deffn

@node curses — Gerenciador de terminal para visualizadores de células de caracteres,curses textpad — Text input widget for curses programs,fileinput — Itera sobre linhas de múltiplos fluxos de entrada,Bibliotecas de interface de linha de comando
@anchor{library/curses doc}@anchor{313a}@anchor{library/curses curses-terminal-handling-for-character-cell-displays}@anchor{313b}@anchor{library/curses module-curses}@anchor{2b}@anchor{library/curses translation-repo}@anchor{313c}
@subsection @code{curses} — Gerenciador de terminal para visualizadores de células de caracteres.


@geindex module; curses

`Código-fonte:' Lib/curses@footnote{https://github.com/python/cpython/tree/3.13/Lib/curses}


__________________________________________________________________


O módulo @ref{2b,,curses} provê uma interface para a livraria curses, o padrão de-facto para manuseio avançado de terminal portável.

While curses is most widely used in the Unix environment, versions are available
for Windows, DOS, and possibly other systems as well.  This extension module is
designed to match the API of ncurses, an open-source curses library hosted on
Linux and the BSD variants of Unix.

@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@cartouche
@quotation Nota 
Whenever the documentation mentions a `character' it can be specified
as an integer, a one-character Unicode string or a one-byte byte string.

Whenever the documentation mentions a `character string' it can be specified
as a Unicode string or a byte string.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item Módulo @ref{2c,,curses.ascii}

Utilidades para trabalhar com caracteres ASCII, independentemente de suas configurações locais.

@item Módulo @ref{2d,,curses.panel}

Uma extensão de painel stackeada que adiciona profundidade às janelas do curses.

@item Módulo @ref{2e,,curses.textpad}

Widget de texto editável para suporte ao curses @code{Emacs}-like bindings.

@item @ref{313d,,Programação em Curses com Python}

Tutorial material on using curses with Python, by Andrew Kuchling and Eric
Raymond.
@end table


@menu
* Funções: Funções<6>. 
* Window Objects:: 
* Constantes: Constantes<6>. 

@end menu

@node Funções<6>,Window Objects,,curses — Gerenciador de terminal para visualizadores de células de caracteres
@anchor{library/curses curses-functions}@anchor{313e}@anchor{library/curses functions}@anchor{313f}
@subsubsection Funções


The module @ref{2b,,curses} defines the following exception:

@geindex error
@anchor{library/curses curses error}@anchor{3140}
@deffn {Exceção} curses.error

Exception raised when a curses library function returns an error.
@end deffn

@cartouche
@quotation Nota 
Whenever `x' or `y' arguments to a function or a method are optional, they
default to the current cursor location. Whenever `attr' is optional, it defaults
to @ref{3141,,A_NORMAL}.
@end quotation
@end cartouche

The module @ref{2b,,curses} defines the following functions:

@geindex baudrate() (no módulo curses)
@anchor{library/curses curses baudrate}@anchor{3142}
@deffn {Função} curses.baudrate ()

Return the output speed of the terminal in bits per second.  On software
terminal emulators it will have a fixed high value. Included for historical
reasons; in former times, it was used to  write output loops for time delays and
occasionally to change interfaces depending on the line speed.
@end deffn

@geindex beep() (no módulo curses)
@anchor{library/curses curses beep}@anchor{3143}
@deffn {Função} curses.beep ()

Emit a short attention sound.
@end deffn

@geindex can_change_color() (no módulo curses)
@anchor{library/curses curses can_change_color}@anchor{3144}
@deffn {Função} curses.can_change_color ()

Return @code{True} or @code{False}, depending on whether the programmer can change the colors
displayed by the terminal.
@end deffn

@geindex cbreak() (no módulo curses)
@anchor{library/curses curses cbreak}@anchor{3145}
@deffn {Função} curses.cbreak ()

Enter cbreak mode.  In cbreak mode (sometimes called “rare” mode) normal tty
line buffering is turned off and characters are available to be read one by one.
However, unlike raw mode, special characters (interrupt, quit, suspend, and flow
control) retain their effects on the tty driver and calling program.  Calling
first @ref{3146,,raw()} then @ref{3145,,cbreak()} leaves the terminal in cbreak mode.
@end deffn

@geindex color_content() (no módulo curses)
@anchor{library/curses curses color_content}@anchor{7f3}
@deffn {Função} curses.color_content (color_number)

Return the intensity of the red, green, and blue (RGB) components in the color
`color_number', which must be between @code{0} and @code{COLORS - 1}.  Return a 3-tuple,
containing the R,G,B values for the given color, which will be between
@code{0} (no component) and @code{1000} (maximum amount of component).
@end deffn

@geindex color_pair() (no módulo curses)
@anchor{library/curses curses color_pair}@anchor{3147}
@deffn {Função} 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{3148,,A_STANDOUT}, @ref{3149,,A_REVERSE},
and the other @code{A_*} attributes.  @ref{314a,,pair_number()} is the counterpart
to this function.
@end deffn

@geindex curs_set() (no módulo curses)
@anchor{library/curses curses curs_set}@anchor{314b}
@deffn {Função} curses.curs_set (visibility)

Set the cursor state.  `visibility' can be set to @code{0}, @code{1}, or @code{2}, for invisible,
normal, or very visible.  If the terminal supports the visibility requested, return the
previous cursor state; otherwise raise an exception.  On many
terminals, the “visible” mode is an underline cursor and the “very visible” mode
is a block cursor.
@end deffn

@geindex def_prog_mode() (no módulo curses)
@anchor{library/curses curses def_prog_mode}@anchor{314c}
@deffn {Função} curses.def_prog_mode ()

Save the current terminal mode as the “program” mode, the mode when the running
program is using curses.  (Its counterpart is the “shell” mode, for when the
program is not in curses.)  Subsequent calls to @ref{314d,,reset_prog_mode()} will
restore this mode.
@end deffn

@geindex def_shell_mode() (no módulo curses)
@anchor{library/curses curses def_shell_mode}@anchor{314e}
@deffn {Função} curses.def_shell_mode ()

Save the current terminal mode as the “shell” mode, the mode when the running
program is not using curses.  (Its counterpart is the “program” mode, when the
program is using curses capabilities.) Subsequent calls to
@ref{314f,,reset_shell_mode()} will restore this mode.
@end deffn

@geindex delay_output() (no módulo curses)
@anchor{library/curses curses delay_output}@anchor{3150}
@deffn {Função} curses.delay_output (ms)

Insert an `ms' millisecond pause in output.
@end deffn

@geindex doupdate() (no módulo curses)
@anchor{library/curses curses doupdate}@anchor{3151}
@deffn {Função} curses.doupdate ()

Atualiza a tela física. A biblioteca do curses mantém duas estruturas de dados, uma representando o conteúdo da tela física atual e uma tela virtual representando o próximo estado desejado. O @ref{3151,,doupdate()} atualiza a tela física para corresponder à tela virtual.

The virtual screen may be updated by a @ref{3152,,noutrefresh()} call after write
operations such as @ref{3153,,addstr()} have been performed on a window.  The normal
@ref{3154,,refresh()} call is simply @code{noutrefresh()} followed by @code{doupdate()};
if you have to update multiple windows, you can speed performance and perhaps
reduce screen flicker by issuing @code{noutrefresh()} calls on all windows,
followed by a single @code{doupdate()}.
@end deffn

@geindex echo() (no módulo curses)
@anchor{library/curses curses echo}@anchor{3155}
@deffn {Função} curses.echo ()

Enter echo mode.  In echo mode, each character input is echoed to the screen as
it is entered.
@end deffn

@geindex endwin() (no módulo curses)
@anchor{library/curses curses endwin}@anchor{3156}
@deffn {Função} curses.endwin ()

De-initialize the library, and return terminal to normal status.
@end deffn

@geindex erasechar() (no módulo curses)
@anchor{library/curses curses erasechar}@anchor{3157}
@deffn {Função} curses.erasechar ()

Return the user’s current erase character as a one-byte bytes object.  Under Unix operating systems this
is a property of the controlling tty of the curses program, and is not set by
the curses library itself.
@end deffn

@geindex filter() (no módulo curses)
@anchor{library/curses curses filter}@anchor{3158}
@deffn {Função} curses.filter ()

The @ref{3158,,filter()} routine, if used, must be called before @ref{1689,,initscr()} is
called.  The effect is that, during those calls, 
@geindex LINES
@geindex variável de ambiente; LINES
@code{LINES} is set to @code{1}; the
capabilities @code{clear}, @code{cup}, @code{cud}, @code{cud1}, @code{cuu1}, @code{cuu}, @code{vpa} are disabled; and the @code{home}
string is set to the value of @code{cr}. The effect is that the cursor is confined to
the current line, and so are screen updates.  This may be used for enabling
character-at-a-time  line editing without touching the rest of the screen.
@end deffn

@geindex flash() (no módulo curses)
@anchor{library/curses curses flash}@anchor{3159}
@deffn {Função} curses.flash ()

Flash the screen.  That is, change it to reverse-video and then change it back
in a short interval.  Some people prefer such as ‘visible bell’ to the audible
attention signal produced by @ref{3143,,beep()}.
@end deffn

@geindex flushinp() (no módulo curses)
@anchor{library/curses curses flushinp}@anchor{315a}
@deffn {Função} curses.flushinp ()

Flush all input buffers.  This throws away any  typeahead  that  has been typed
by the user and has not yet been processed by the program.
@end deffn

@geindex getmouse() (no módulo curses)
@anchor{library/curses curses getmouse}@anchor{315b}
@deffn {Função} curses.getmouse ()

After @ref{1627,,getch()} returns @ref{315c,,KEY_MOUSE} to signal a mouse event, this
method should be called to retrieve the queued mouse event, represented as a
5-tuple @code{(id, x, y, z, bstate)}. `id' is an ID value used to distinguish
multiple devices, and `x', `y', `z' are the event’s coordinates.  (`z' is
currently unused.)  `bstate' is an integer value whose bits will be set to
indicate the type of event, and will be the bitwise OR of one or more of the
following constants, where `n' is the button number from 1 to 5:
@ref{315d,,BUTTONn_PRESSED}, @ref{315e,,BUTTONn_RELEASED}, @ref{315f,,BUTTONn_CLICKED},
@ref{3160,,BUTTONn_DOUBLE_CLICKED}, @ref{3161,,BUTTONn_TRIPLE_CLICKED},
@ref{3162,,BUTTON_SHIFT}, @ref{3163,,BUTTON_CTRL}, @ref{3164,,BUTTON_ALT}.


Alterado na versão 3.10: The @code{BUTTON5_*} constants are now exposed if they are provided by the
underlying curses library.

@end deffn

@geindex getsyx() (no módulo curses)
@anchor{library/curses curses getsyx}@anchor{3165}
@deffn {Função} curses.getsyx ()

Return the current coordinates of the virtual screen cursor as a tuple
@code{(y, x)}.  If @ref{3166,,leaveok} is currently @code{True}, then return @code{(-1, -1)}.
@end deffn

@geindex getwin() (no módulo curses)
@anchor{library/curses curses getwin}@anchor{3167}
@deffn {Função} curses.getwin (file)

Read window related data stored in the file by an earlier @ref{3168,,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() (no módulo curses)
@anchor{library/curses curses has_colors}@anchor{3169}
@deffn {Função} curses.has_colors ()

Return @code{True} if the terminal can display colors; otherwise, return @code{False}.
@end deffn

@geindex has_extended_color_support() (no módulo curses)
@anchor{library/curses curses has_extended_color_support}@anchor{7f7}
@deffn {Função} curses.has_extended_color_support ()

Return @code{True} if the module supports extended colors; otherwise, return
@code{False}. Extended color support allows more than 256 color pairs for
terminals that support more than 16 colors (e.g. xterm-256color).

Extended color support requires ncurses version 6.1 or later.


Adicionado na versão 3.10.

@end deffn

@geindex has_ic() (no módulo curses)
@anchor{library/curses curses has_ic}@anchor{316a}
@deffn {Função} curses.has_ic ()

Return @code{True} if the terminal has insert- and delete-character capabilities.
This function is included for historical reasons only, as all modern software
terminal emulators have such capabilities.
@end deffn

@geindex has_il() (no módulo curses)
@anchor{library/curses curses has_il}@anchor{316b}
@deffn {Função} curses.has_il ()

Return @code{True} if the terminal has insert- and delete-line capabilities, or can
simulate  them  using scrolling regions. This function is included for
historical reasons only, as all modern software terminal emulators have such
capabilities.
@end deffn

@geindex has_key() (no módulo curses)
@anchor{library/curses curses has_key}@anchor{316c}
@deffn {Função} curses.has_key (ch)

Take a key value `ch', and return @code{True} if the current terminal type recognizes
a key with that value.
@end deffn

@geindex halfdelay() (no módulo curses)
@anchor{library/curses curses halfdelay}@anchor{316d}
@deffn {Função} curses.halfdelay (tenths)

Used for half-delay mode, which is similar to cbreak mode in that characters
typed by the user are immediately available to the program. However, after
blocking for `tenths' tenths of seconds, raise an exception if nothing has
been typed.  The value of `tenths' must be a number between @code{1} and @code{255}.  Use
@ref{316e,,nocbreak()} to leave half-delay mode.
@end deffn

@geindex init_color() (no módulo curses)
@anchor{library/curses curses init_color}@anchor{7f4}
@deffn {Função} 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{7f4,,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{3144,,can_change_color()} returns @code{True}.
@end deffn

@geindex init_pair() (no módulo curses)
@anchor{library/curses curses init_pair}@anchor{7f5}
@deffn {Função} curses.init_pair (pair_number, fg, bg)

Change the definition of a color-pair.  It takes three arguments: the number of
the color-pair to be changed, the foreground color number, and the background
color number.  The value of `pair_number' must be between @code{1} and
@code{COLOR_PAIRS - 1} (the @code{0} color pair is wired to white on black and cannot
be changed).  The value of `fg' and `bg' arguments must be between @code{0} and
@code{COLORS - 1}, or, after calling @ref{316f,,use_default_colors()}, @code{-1}.
If the color-pair was previously initialized, the screen is
refreshed and all occurrences of that color-pair are changed to the new
definition.
@end deffn

@geindex initscr() (no módulo curses)
@anchor{library/curses curses initscr}@anchor{1689}
@deffn {Função} curses.initscr ()

Initialize the library. Return a @ref{3170,,window} object
which represents the whole screen.

@cartouche
@quotation Nota 
If there is an error opening the terminal, the underlying curses library may
cause the interpreter to exit.
@end quotation
@end cartouche
@end deffn

@geindex is_term_resized() (no módulo curses)
@anchor{library/curses curses is_term_resized}@anchor{3171}
@deffn {Função} curses.is_term_resized (nlines, ncols)

Return @code{True} if @ref{1691,,resize_term()} would modify the window structure,
@code{False} otherwise.
@end deffn

@geindex isendwin() (no módulo curses)
@anchor{library/curses curses isendwin}@anchor{3172}
@deffn {Função} curses.isendwin ()

Return @code{True} if @ref{3156,,endwin()} has been called (that is, the  curses library has
been deinitialized).
@end deffn

@geindex keyname() (no módulo curses)
@anchor{library/curses curses keyname}@anchor{3173}
@deffn {Função} curses.keyname (k)

Return the name of the key numbered `k' as a bytes object.  The name of a key generating printable
ASCII character is the key’s character.  The name of a control-key combination
is a two-byte bytes object consisting of a caret (@code{b'^'}) followed by the corresponding
printable ASCII character.  The name of an alt-key combination (128–255) is a
bytes object consisting of the prefix @code{b'M-'} followed by the name of the corresponding
ASCII character.
@end deffn

@geindex killchar() (no módulo curses)
@anchor{library/curses curses killchar}@anchor{3174}
@deffn {Função} curses.killchar ()

Return the user’s current line kill character as a one-byte bytes object. Under Unix operating systems
this is a property of the controlling tty of the curses program, and is not set
by the curses library itself.
@end deffn

@geindex longname() (no módulo curses)
@anchor{library/curses curses longname}@anchor{3175}
@deffn {Função} curses.longname ()

Return a bytes object containing the terminfo long name field describing the current
terminal.  The maximum length of a verbose description is 128 characters.  It is
defined only after the call to @ref{1689,,initscr()}.
@end deffn

@geindex meta() (no módulo curses)
@anchor{library/curses curses meta}@anchor{3176}
@deffn {Função} curses.meta (flag)

If `flag' is @code{True}, allow 8-bit characters to be input.  If
`flag' is @code{False},  allow only 7-bit chars.
@end deffn

@geindex mouseinterval() (no módulo curses)
@anchor{library/curses curses mouseinterval}@anchor{3177}
@deffn {Função} 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() (no módulo curses)
@anchor{library/curses curses mousemask}@anchor{3178}
@deffn {Função} curses.mousemask (mousemask)

Set the mouse events to be reported, and return a tuple @code{(availmask,
oldmask)}.   `availmask' indicates which of the specified mouse events can be
reported; on complete failure it returns @code{0}.  `oldmask' is the previous value of
the given window’s mouse event mask.  If this function is never called, no mouse
events are ever reported.
@end deffn

@geindex napms() (no módulo curses)
@anchor{library/curses curses napms}@anchor{1688}
@deffn {Função} curses.napms (ms)

Sleep for `ms' milliseconds.
@end deffn

@geindex newpad() (no módulo curses)
@anchor{library/curses curses newpad}@anchor{3179}
@deffn {Função} curses.newpad (nlines, ncols)

Create and return a pointer to a new pad data structure with the given number
of lines and columns.  Return a pad as a window object.

A pad is like a window, except that it is not restricted by the screen size, and
is not necessarily associated with a particular part of the screen.  Pads can be
used when a large window is needed, and only a part of the window will be on the
screen at one time.  Automatic refreshes of pads (such as from scrolling or
echoing of input) do not occur.  The @ref{3154,,refresh()} and @ref{3152,,noutrefresh()}
methods of a pad require 6 arguments to specify the part of the pad to be
displayed and the location on the screen to be used for the display. The
arguments are `pminrow', `pmincol', `sminrow', `smincol', `smaxrow', `smaxcol'; the `p'
arguments refer to the upper left corner of the pad region to be displayed and
the `s' arguments define a clipping box on the screen within which the pad region
is to be displayed.
@end deffn

@geindex newwin() (no módulo curses)
@anchor{library/curses curses newwin}@anchor{317a}
@deffn {Função} curses.newwin (nlines, ncols)

@deffnx {Função} curses.newwin (nlines, ncols, begin_y, begin_x)

Return a new @ref{3170,,window}, whose left-upper corner
is at  @code{(begin_y, begin_x)}, and whose height/width is  `nlines'/`ncols'.

By default, the window will extend from the  specified position to the lower
right corner of the screen.
@end deffn

@geindex nl() (no módulo curses)
@anchor{library/curses curses nl}@anchor{317b}
@deffn {Função} curses.nl ()

Enter newline mode.  This mode translates the return key into newline on input,
and translates newline into return and line-feed on output. Newline mode is
initially on.
@end deffn

@geindex nocbreak() (no módulo curses)
@anchor{library/curses curses nocbreak}@anchor{316e}
@deffn {Função} curses.nocbreak ()

Leave cbreak mode.  Return to normal “cooked” mode with line buffering.
@end deffn

@geindex noecho() (no módulo curses)
@anchor{library/curses curses noecho}@anchor{317c}
@deffn {Função} curses.noecho ()

Leave echo mode.  Echoing of input characters is turned off.
@end deffn

@geindex nonl() (no módulo curses)
@anchor{library/curses curses nonl}@anchor{317d}
@deffn {Função} curses.nonl ()

Leave newline mode.  Disable translation of return into newline on input, and
disable low-level translation of newline into newline/return on output (but this
does not change the behavior of @code{addch('\n')}, which always does the
equivalent of return and line feed on the virtual screen).  With translation
off, curses can sometimes speed up vertical motion a little; also, it will be
able to detect the return key on input.
@end deffn

@geindex noqiflush() (no módulo curses)
@anchor{library/curses curses noqiflush}@anchor{317e}
@deffn {Função} curses.noqiflush ()

When the @code{noqiflush()} routine is used, normal flush of input and output queues
associated with the @code{INTR}, @code{QUIT} and @code{SUSP} characters will not be done.  You may
want to call @code{noqiflush()} in a signal handler if you want output to
continue as though the interrupt had not occurred, after the handler exits.
@end deffn

@geindex noraw() (no módulo curses)
@anchor{library/curses curses noraw}@anchor{317f}
@deffn {Função} curses.noraw ()

Leave raw mode. Return to normal “cooked” mode with line buffering.
@end deffn

@geindex pair_content() (no módulo curses)
@anchor{library/curses curses pair_content}@anchor{7f6}
@deffn {Função} curses.pair_content (pair_number)

Return a tuple @code{(fg, bg)} containing the colors for the requested color pair.
The value of `pair_number' must be between @code{0} and @code{COLOR_PAIRS - 1}.
@end deffn

@geindex pair_number() (no módulo curses)
@anchor{library/curses curses pair_number}@anchor{314a}
@deffn {Função} curses.pair_number (attr)

Return the number of the color-pair set by the attribute value `attr'.
@ref{3147,,color_pair()} is the counterpart to this function.
@end deffn

@geindex putp() (no módulo curses)
@anchor{library/curses curses putp}@anchor{3180}
@deffn {Função} curses.putp (str)

Equivalent to @code{tputs(str, 1, putchar)}; emit the value of a specified
terminfo capability for the current terminal.  Note that the output of @ref{3180,,putp()}
always goes to standard output.
@end deffn

@geindex qiflush() (no módulo curses)
@anchor{library/curses curses qiflush}@anchor{3181}
@deffn {Função} curses.qiflush ([flag])

If `flag' is @code{False}, the effect is the same as calling @ref{317e,,noqiflush()}. If
`flag' is @code{True}, or no argument is provided, the queues will be flushed when
these control characters are read.
@end deffn

@geindex raw() (no módulo curses)
@anchor{library/curses curses raw}@anchor{3146}
@deffn {Função} curses.raw ()

Enter raw mode.  In raw mode, normal line buffering and  processing of
interrupt, quit, suspend, and flow control keys are turned off; characters are
presented to curses input functions one by one.
@end deffn

@geindex reset_prog_mode() (no módulo curses)
@anchor{library/curses curses reset_prog_mode}@anchor{314d}
@deffn {Função} curses.reset_prog_mode ()

Restore the  terminal  to “program” mode, as previously saved  by
@ref{314c,,def_prog_mode()}.
@end deffn

@geindex reset_shell_mode() (no módulo curses)
@anchor{library/curses curses reset_shell_mode}@anchor{314f}
@deffn {Função} curses.reset_shell_mode ()

Restore the  terminal  to “shell” mode, as previously saved  by
@ref{314e,,def_shell_mode()}.
@end deffn

@geindex resetty() (no módulo curses)
@anchor{library/curses curses resetty}@anchor{3182}
@deffn {Função} curses.resetty ()

Restore the state of the terminal modes to what it was at the last call to
@ref{3183,,savetty()}.
@end deffn

@geindex resize_term() (no módulo curses)
@anchor{library/curses curses resize_term}@anchor{1691}
@deffn {Função} curses.resize_term (nlines, ncols)

Backend function used by @ref{1690,,resizeterm()}, performing most of the work;
when resizing the windows, @ref{1691,,resize_term()} blank-fills the areas that are
extended.  The calling application should fill in these areas with
appropriate data.  The @code{resize_term()} function attempts to resize all
windows.  However, due to the calling convention of pads, it is not possible
to resize these without additional interaction with the application.
@end deffn

@geindex resizeterm() (no módulo curses)
@anchor{library/curses curses resizeterm}@anchor{1690}
@deffn {Função} curses.resizeterm (nlines, ncols)

Resize the standard and current windows to the specified dimensions, and
adjusts other bookkeeping data used by the curses library that record the
window dimensions (in particular the SIGWINCH handler).
@end deffn

@geindex savetty() (no módulo curses)
@anchor{library/curses curses savetty}@anchor{3183}
@deffn {Função} curses.savetty ()

Save the current state of the terminal modes in a buffer, usable by
@ref{3182,,resetty()}.
@end deffn

@geindex get_escdelay() (no módulo curses)
@anchor{library/curses curses get_escdelay}@anchor{8f6}
@deffn {Função} curses.get_escdelay ()

Retrieves the value set by @ref{8f7,,set_escdelay()}.


Adicionado na versão 3.9.

@end deffn

@geindex set_escdelay() (no módulo curses)
@anchor{library/curses curses set_escdelay}@anchor{8f7}
@deffn {Função} curses.set_escdelay (ms)

Sets the number of milliseconds to wait after reading an escape character,
to distinguish between an individual escape character entered on the
keyboard from escape sequences sent by cursor and function keys.


Adicionado na versão 3.9.

@end deffn

@geindex get_tabsize() (no módulo curses)
@anchor{library/curses curses get_tabsize}@anchor{8f8}
@deffn {Função} curses.get_tabsize ()

Retrieves the value set by @ref{8f9,,set_tabsize()}.


Adicionado na versão 3.9.

@end deffn

@geindex set_tabsize() (no módulo curses)
@anchor{library/curses curses set_tabsize}@anchor{8f9}
@deffn {Função} curses.set_tabsize (size)

Sets the number of columns used by the curses library when converting a tab
character to spaces as it adds the tab to a window.


Adicionado na versão 3.9.

@end deffn

@geindex setsyx() (no módulo curses)
@anchor{library/curses curses setsyx}@anchor{3184}
@deffn {Função} curses.setsyx (y, x)

Set the virtual screen cursor to `y', `x'. If `y' and `x' are both @code{-1}, then
@ref{3166,,leaveok} is set @code{True}.
@end deffn

@geindex setupterm() (no módulo curses)
@anchor{library/curses curses setupterm}@anchor{3185}
@deffn {Função} curses.setupterm (term=None, fd=-1)

Initialize the terminal.  `term' is a string giving
the terminal name, or @code{None}; if omitted or @code{None}, the value of the
@geindex TERM
@geindex variável de ambiente; TERM
@code{TERM} environment variable will be used.  `fd' is the
file descriptor to which any initialization sequences will be sent; if not
supplied or @code{-1}, the file descriptor for @code{sys.stdout} will be used.
@end deffn

@geindex start_color() (no módulo curses)
@anchor{library/curses curses start_color}@anchor{3186}
@deffn {Função} curses.start_color ()

Must be called if the programmer wants to use colors, and before any other color
manipulation routine is called.  It is good practice to call this routine right
after @ref{1689,,initscr()}.

@ref{3186,,start_color()} initializes eight basic colors (black, red,  green, yellow,
blue, magenta, cyan, and white), and two global variables in the @ref{2b,,curses}
module, @ref{3187,,COLORS} and @ref{3188,,COLOR_PAIRS}, containing the maximum number
of colors and color-pairs the terminal can support.  It also restores the colors
on the terminal to the values they had when the terminal was just turned on.
@end deffn

@geindex termattrs() (no módulo curses)
@anchor{library/curses curses termattrs}@anchor{3189}
@deffn {Função} curses.termattrs ()

Return a logical OR of all video attributes supported by the terminal.  This
information is useful when a curses program needs complete control over the
appearance of the screen.
@end deffn

@geindex termname() (no módulo curses)
@anchor{library/curses curses termname}@anchor{318a}
@deffn {Função} curses.termname ()

Return the value of the environment variable 
@geindex TERM
@geindex variável de ambiente; TERM
@code{TERM}, as a bytes object,
truncated to 14 characters.
@end deffn

@geindex tigetflag() (no módulo curses)
@anchor{library/curses curses tigetflag}@anchor{318b}
@deffn {Função} curses.tigetflag (capname)

Return the value of the Boolean capability corresponding to the terminfo
capability name `capname' as an integer.  Return the value @code{-1} if `capname' is not a
Boolean capability, or @code{0} if it is canceled or absent from the terminal
description.
@end deffn

@geindex tigetnum() (no módulo curses)
@anchor{library/curses curses tigetnum}@anchor{318c}
@deffn {Função} curses.tigetnum (capname)

Return the value of the numeric capability corresponding to the terminfo
capability name `capname' as an integer.  Return the value @code{-2} if `capname' is not a
numeric capability, or @code{-1} if it is canceled or absent from the terminal
description.
@end deffn

@geindex tigetstr() (no módulo curses)
@anchor{library/curses curses tigetstr}@anchor{318d}
@deffn {Função} curses.tigetstr (capname)

Return the value of the string capability corresponding to the terminfo
capability name `capname' as a bytes object.  Return @code{None} if `capname'
is not a terminfo “string capability”, or is canceled or absent from the
terminal description.
@end deffn

@geindex tparm() (no módulo curses)
@anchor{library/curses curses tparm}@anchor{318e}
@deffn {Função} curses.tparm (str[, ...])

Instantiate the bytes object `str' with the supplied parameters, where `str' should
be a parameterized string obtained from the terminfo database.  E.g.
@code{tparm(tigetstr("cup"), 5, 3)} could result in @code{b'\033[6;4H'}, the exact
result depending on terminal type.
@end deffn

@geindex typeahead() (no módulo curses)
@anchor{library/curses curses typeahead}@anchor{318f}
@deffn {Função} curses.typeahead (fd)

Specify that the file descriptor `fd' be used for typeahead checking.  If `fd'
is @code{-1}, then no typeahead checking is done.

The curses library does “line-breakout optimization” by looking for typeahead
periodically while updating the screen.  If input is found, and it is coming
from a tty, the current update is postponed until refresh or doupdate is called
again, allowing faster response to commands typed in advance. This function
allows specifying a different file descriptor for typeahead checking.
@end deffn

@geindex unctrl() (no módulo curses)
@anchor{library/curses curses unctrl}@anchor{3190}
@deffn {Função} curses.unctrl (ch)

Return a bytes object which is a printable representation of the character `ch'.
Control characters are represented as a caret followed by the character, for
example as @code{b'^C'}. Printing characters are left as they are.
@end deffn

@geindex ungetch() (no módulo curses)
@anchor{library/curses curses ungetch}@anchor{3191}
@deffn {Função} curses.ungetch (ch)

Push `ch' so the next @ref{1627,,getch()} will return it.

@cartouche
@quotation Nota 
Only one `ch' can be pushed before @code{getch()} is called.
@end quotation
@end cartouche
@end deffn

@geindex update_lines_cols() (no módulo curses)
@anchor{library/curses curses update_lines_cols}@anchor{e16}
@deffn {Função} curses.update_lines_cols ()

Update the @ref{e17,,LINES} and @ref{e18,,COLS} module variables.
Useful for detecting manual screen resize.


Adicionado na versão 3.5.

@end deffn

@geindex unget_wch() (no módulo curses)
@anchor{library/curses curses unget_wch}@anchor{10d7}
@deffn {Função} curses.unget_wch (ch)

Push `ch' so the next @ref{10d6,,get_wch()} will return it.

@cartouche
@quotation Nota 
Only one `ch' can be pushed before @code{get_wch()} is called.
@end quotation
@end cartouche


Adicionado na versão 3.3.

@end deffn

@geindex ungetmouse() (no módulo curses)
@anchor{library/curses curses ungetmouse}@anchor{3192}
@deffn {Função} curses.ungetmouse (id, x, y, z, bstate)

Push a @ref{315c,,KEY_MOUSE} event onto the input queue, associating the given
state data with it.
@end deffn

@geindex use_env() (no módulo curses)
@anchor{library/curses curses use_env}@anchor{3193}
@deffn {Função} curses.use_env (flag)

If used, this function should be called before @ref{1689,,initscr()} or newterm are
called.  When `flag' is @code{False}, the values of lines and columns specified in the
terminfo database will be used, even if environment variables 
@geindex LINES
@geindex variável de ambiente; LINES
@code{LINES}
and 
@geindex COLUMNS
@geindex variável de ambiente; COLUMNS
@code{COLUMNS} (used by default) are set, or if curses is running in a
window (in which case default behavior would be to use the window size if
@geindex LINES
@geindex variável de ambiente; LINES
@code{LINES} and 
@geindex COLUMNS
@geindex variável de ambiente; COLUMNS
@code{COLUMNS} are not set).
@end deffn

@geindex use_default_colors() (no módulo curses)
@anchor{library/curses curses use_default_colors}@anchor{316f}
@deffn {Função} curses.use_default_colors ()

Allow use of default values for colors on terminals supporting this feature. Use
this to support transparency in your application.  The default color is assigned
to the color number @code{-1}. After calling this function,  @code{init_pair(x,
curses.COLOR_RED, -1)} initializes, for instance, color pair `x' to a red
foreground color on the default background.
@end deffn

@geindex wrapper() (no módulo curses)
@anchor{library/curses curses wrapper}@anchor{a8a}
@deffn {Função} curses.wrapper (func, /, *args, **kwargs)

Initialize curses and call another callable object, `func', which should be the
rest of your curses-using application.  If the application raises an exception,
this function will restore the terminal to a sane state before re-raising the
exception and generating a traceback.  The callable object `func' is then passed
the main window ‘stdscr’ as its first argument, followed by any other arguments
passed to @code{wrapper()}.  Before calling `func', @code{wrapper()} turns on
cbreak mode, turns off echo, enables the terminal keypad, and initializes colors
if the terminal has color support.  On exit (whether normally or by exception)
it restores cooked mode, turns on echo, and disables the terminal keypad.
@end deffn

@node Window Objects,Constantes<6>,Funções<6>,curses — Gerenciador de terminal para visualizadores de células de caracteres
@anchor{library/curses curses-window-objects}@anchor{3170}@anchor{library/curses window-objects}@anchor{3194}
@subsubsection Window Objects


@geindex window (classe em curses)
@anchor{library/curses curses window}@anchor{10d4}
@deffn {Classe} curses.window

Window objects, as returned by @ref{1689,,initscr()} and @ref{317a,,newwin()} above, have
the following methods and attributes:
@end deffn

@geindex addch() (método curses.window)
@anchor{library/curses curses window addch}@anchor{3195}
@deffn {Método} window.addch (ch[, attr])

@deffnx {Método} window.addch (y, x, ch[, attr])

Paint character `ch' at @code{(y, x)} with attributes `attr', overwriting any
character previously painted at that location.  By default, the character
position and attributes are the current settings for the window object.

@cartouche
@quotation Nota 
Writing outside the window, subwindow, or pad raises a @ref{3140,,curses.error}.
Attempting to write to the lower right corner of a window, subwindow,
or pad will cause an exception to be raised after the character is printed.
@end quotation
@end cartouche
@end deffn

@geindex addnstr() (método curses.window)
@anchor{library/curses curses window addnstr}@anchor{3196}
@deffn {Método} window.addnstr (str, n[, attr])

@deffnx {Método} window.addnstr (y, x, str, n[, attr])

Paint at most `n' characters of the character string `str' at
@code{(y, x)} with attributes
`attr', overwriting anything previously on the display.
@end deffn

@geindex addstr() (método curses.window)
@anchor{library/curses curses window addstr}@anchor{3153}
@deffn {Método} window.addstr (str[, attr])

@deffnx {Método} window.addstr (y, x, str[, attr])

Paint the character string `str' at @code{(y, x)} with attributes
`attr', overwriting anything previously on the display.

@cartouche
@quotation Nota 

@itemize *

@item 
Writing outside the window, subwindow, or pad raises @ref{3140,,curses.error}.
Attempting to write to the lower right corner of a window, subwindow,
or pad will cause an exception to be raised after the string is printed.

@item 
A bug in ncurses@footnote{https://bugs.python.org/issue35924}, the backend
for this Python module, can cause SegFaults when resizing windows. This
is fixed in ncurses-6.1-20190511.  If you are stuck with an earlier
ncurses, you can avoid triggering this if you do not call @ref{3153,,addstr()}
with a `str' that has embedded newlines.  Instead, call @ref{3153,,addstr()}
separately for each line.
@end itemize
@end quotation
@end cartouche
@end deffn

@geindex attroff() (método curses.window)
@anchor{library/curses curses window attroff}@anchor{3197}
@deffn {Método} window.attroff (attr)

Remove attribute `attr' from the “background” set applied to all writes to the
current window.
@end deffn

@geindex attron() (método curses.window)
@anchor{library/curses curses window attron}@anchor{3198}
@deffn {Método} window.attron (attr)

Add attribute `attr' to the “background” set applied to all writes to the
current window.
@end deffn

@geindex attrset() (método curses.window)
@anchor{library/curses curses window attrset}@anchor{3199}
@deffn {Método} window.attrset (attr)

Set the “background” set of attributes to `attr'.  This set is initially
@code{0} (no attributes).
@end deffn

@geindex bkgd() (método curses.window)
@anchor{library/curses curses window bkgd}@anchor{319a}
@deffn {Método} window.bkgd (ch[, attr])

Set the background property of the window to the character `ch', with
attributes `attr'.  The change is then applied to every character position in
that window:


@itemize *

@item 
The attribute of every character in the window  is changed to the new
background attribute.

@item 
Wherever  the  former background character appears, it is changed to the new
background character.
@end itemize
@end deffn

@geindex bkgdset() (método curses.window)
@anchor{library/curses curses window bkgdset}@anchor{319b}
@deffn {Método} window.bkgdset (ch[, attr])

Set the window’s background.  A window’s background consists of a character and
any combination of attributes.  The attribute part of the background is combined
(OR’ed) with all non-blank characters that are written into the window.  Both
the character and attribute parts of the background are combined with the blank
characters.  The background becomes a property of the character and moves with
the character through any scrolling and insert/delete line/character operations.
@end deffn

@geindex border() (método curses.window)
@anchor{library/curses curses window border}@anchor{319c}
@deffn {Método} window.border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

Draw a border around the edges of the window. Each parameter specifies  the
character to use for a specific part of the border; see the table below for more
details.

@cartouche
@quotation Nota 
A @code{0} value for any parameter will cause the default character to be used for
that parameter.  Keyword parameters can `not' be used.  The defaults are listed
in this table:
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Parameter

@tab

Descrição

@tab

Valor padrão

@item

`ls'

@tab

Left side

@tab

@ref{319d,,ACS_VLINE}

@item

`rs'

@tab

Right side

@tab

@ref{319d,,ACS_VLINE}

@item

`ts'

@tab

Top

@tab

@ref{319e,,ACS_HLINE}

@item

`bs'

@tab

Bottom

@tab

@ref{319e,,ACS_HLINE}

@item

`tl'

@tab

Upper-left corner

@tab

@ref{319f,,ACS_ULCORNER}

@item

`tr'

@tab

Upper-right corner

@tab

@ref{31a0,,ACS_URCORNER}

@item

`bl'

@tab

Bottom-left corner

@tab

@ref{31a1,,ACS_LLCORNER}

@item

`br'

@tab

Bottom-right corner

@tab

@ref{31a2,,ACS_LRCORNER}

@end multitable

@end deffn

@geindex box() (método curses.window)
@anchor{library/curses curses window box}@anchor{31a3}
@deffn {Método} window.box ([vertch, horch])

Similar to @ref{319c,,border()}, but both `ls' and `rs' are `vertch' and both `ts' and
`bs' are `horch'.  The default corner characters are always used by this function.
@end deffn

@geindex chgat() (método curses.window)
@anchor{library/curses curses window chgat}@anchor{31a4}
@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)

Set the attributes of `num' characters at the current cursor position, or at
position @code{(y, x)} if supplied. If `num' is not given or is @code{-1},
the attribute will be set on all the characters to the end of the line.  This
function moves cursor to position @code{(y, x)} if supplied. The changed line
will be touched using the @ref{31a5,,touchline()} method so that the contents will
be redisplayed by the next window refresh.
@end deffn

@geindex clear() (método curses.window)
@anchor{library/curses curses window clear}@anchor{31a6}
@deffn {Método} window.clear ()

Like @ref{31a7,,erase()}, but also cause the whole window to be repainted upon next
call to @ref{3154,,refresh()}.
@end deffn

@geindex clearok() (método curses.window)
@anchor{library/curses curses window clearok}@anchor{31a8}
@deffn {Método} window.clearok (flag)

If `flag' is @code{True}, the next call to @ref{3154,,refresh()} will clear the window
completely.
@end deffn

@geindex clrtobot() (método curses.window)
@anchor{library/curses curses window clrtobot}@anchor{31a9}
@deffn {Método} window.clrtobot ()

Erase from cursor to the end of the window: all lines below the cursor are
deleted, and then the equivalent of @ref{31aa,,clrtoeol()} is performed.
@end deffn

@geindex clrtoeol() (método curses.window)
@anchor{library/curses curses window clrtoeol}@anchor{31aa}
@deffn {Método} window.clrtoeol ()

Erase from cursor to the end of the line.
@end deffn

@geindex cursyncup() (método curses.window)
@anchor{library/curses curses window cursyncup}@anchor{31ab}
@deffn {Método} window.cursyncup ()

Update the current cursor position of all the ancestors of the window to
reflect the current cursor position of the window.
@end deffn

@geindex delch() (método curses.window)
@anchor{library/curses curses window delch}@anchor{31ac}
@deffn {Método} window.delch ([y, x])

Delete any character at @code{(y, x)}.
@end deffn

@geindex deleteln() (método curses.window)
@anchor{library/curses curses window deleteln}@anchor{31ad}
@deffn {Método} window.deleteln ()

Delete the line under the cursor. All following lines are moved up by one line.
@end deffn

@geindex derwin() (método curses.window)
@anchor{library/curses curses window derwin}@anchor{31ae}
@deffn {Método} window.derwin (begin_y, begin_x)

@deffnx {Método} window.derwin (nlines, ncols, begin_y, begin_x)

An abbreviation for “derive window”, @ref{31ae,,derwin()} is the same as calling
@ref{31af,,subwin()}, except that `begin_y' and `begin_x' are relative to the origin
of the window, rather than relative to the entire screen.  Return a window
object for the derived window.
@end deffn

@geindex echochar() (método curses.window)
@anchor{library/curses curses window echochar}@anchor{31b0}
@deffn {Método} window.echochar (ch[, attr])

Add character `ch' with attribute `attr', and immediately  call @ref{3154,,refresh()}
on the window.
@end deffn

@geindex enclose() (método curses.window)
@anchor{library/curses curses window enclose}@anchor{1a1d}
@deffn {Método} window.enclose (y, x)

Test whether the given pair of screen-relative character-cell coordinates are
enclosed by the given window, returning @code{True} or @code{False}.  It is useful for
determining what subset of the screen windows enclose the location of a mouse
event.


Alterado na versão 3.10: Previously it returned @code{1} or @code{0} instead of @code{True} or @code{False}.

@end deffn

@geindex encoding (atributo curses.window)
@anchor{library/curses curses window encoding}@anchor{10d5}
@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{31af,,window.subwin()}.
By default, current locale encoding is used (see @ref{2dc,,locale.getencoding()}).


Adicionado na versão 3.3.

@end deffn

@geindex erase() (método curses.window)
@anchor{library/curses curses window erase}@anchor{31a7}
@deffn {Método} window.erase ()

Clear the window.
@end deffn

@geindex getbegyx() (método curses.window)
@anchor{library/curses curses window getbegyx}@anchor{31b1}
@deffn {Método} window.getbegyx ()

Return a tuple @code{(y, x)} of coordinates of upper-left corner.
@end deffn

@geindex getbkgd() (método curses.window)
@anchor{library/curses curses window getbkgd}@anchor{31b2}
@deffn {Método} window.getbkgd ()

Return the given window’s current background character/attribute pair.
@end deffn

@geindex getch() (método curses.window)
@anchor{library/curses curses window getch}@anchor{1627}
@deffn {Método} window.getch ([y, x])

Get a character. Note that the integer returned does `not' have to be in ASCII
range: function keys, keypad keys and so on are represented by numbers higher
than 255.  In no-delay mode, return @code{-1} if there is no input, otherwise
wait until a key is pressed.
@end deffn

@geindex get_wch() (método curses.window)
@anchor{library/curses curses window get_wch}@anchor{10d6}
@deffn {Método} window.get_wch ([y, x])

Get a wide character. Return a character for most keys, or an integer for
function keys, keypad keys, and other special keys.
In no-delay mode, raise an exception if there is no input.


Adicionado na versão 3.3.

@end deffn

@geindex getkey() (método curses.window)
@anchor{library/curses curses window getkey}@anchor{31b3}
@deffn {Método} window.getkey ([y, x])

Get a character, returning a string instead of an integer, as @ref{1627,,getch()}
does. Function keys, keypad keys and other special keys return a multibyte
string containing the key name.  In no-delay mode, raise an exception if
there is no input.
@end deffn

@geindex getmaxyx() (método curses.window)
@anchor{library/curses curses window getmaxyx}@anchor{31b4}
@deffn {Método} window.getmaxyx ()

Return a tuple @code{(y, x)} of the height and width of the window.
@end deffn

@geindex getparyx() (método curses.window)
@anchor{library/curses curses window getparyx}@anchor{31b5}
@deffn {Método} window.getparyx ()

Return the beginning coordinates of this window relative to its parent window
as a tuple @code{(y, x)}.  Return @code{(-1, -1)} if this window has no
parent.
@end deffn

@geindex getstr() (método curses.window)
@anchor{library/curses curses window getstr}@anchor{31b6}
@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)

Read a bytes object from the user, with primitive line editing capacity.
@end deffn

@geindex getyx() (método curses.window)
@anchor{library/curses curses window getyx}@anchor{31b7}
@deffn {Método} window.getyx ()

Return a tuple @code{(y, x)} of current cursor position  relative to the window’s
upper-left corner.
@end deffn

@geindex hline() (método curses.window)
@anchor{library/curses curses window hline}@anchor{31b8}
@deffn {Método} window.hline (ch, n)

@deffnx {Método} window.hline (y, x, ch, n)

Display a horizontal line starting at @code{(y, x)} with length `n' consisting of
the character `ch'.
@end deffn

@geindex idcok() (método curses.window)
@anchor{library/curses curses window idcok}@anchor{31b9}
@deffn {Método} window.idcok (flag)

If `flag' is @code{False}, curses no longer considers using the hardware insert/delete
character feature of the terminal; if `flag' is @code{True}, use of character insertion
and deletion is enabled.  When curses is first initialized, use of character
insert/delete is enabled by default.
@end deffn

@geindex idlok() (método curses.window)
@anchor{library/curses curses window idlok}@anchor{31ba}
@deffn {Método} window.idlok (flag)

If `flag' is @code{True}, @ref{2b,,curses} will try and use hardware line
editing facilities. Otherwise, line insertion/deletion are disabled.
@end deffn

@geindex immedok() (método curses.window)
@anchor{library/curses curses window immedok}@anchor{31bb}
@deffn {Método} window.immedok (flag)

If `flag' is @code{True}, any change in the window image automatically causes the
window to be refreshed; you no longer have to call @ref{3154,,refresh()} yourself.
However, it may degrade performance considerably, due to repeated calls to
wrefresh.  This option is disabled by default.
@end deffn

@geindex inch() (método curses.window)
@anchor{library/curses curses window inch}@anchor{31bc}
@deffn {Método} window.inch ([y, x])

Return the character at the given position in the window. The bottom 8 bits are
the character proper, and upper bits are the attributes.
@end deffn

@geindex insch() (método curses.window)
@anchor{library/curses curses window insch}@anchor{31bd}
@deffn {Método} window.insch (ch[, attr])

@deffnx {Método} window.insch (y, x, ch[, attr])

Paint character `ch' at @code{(y, x)} with attributes `attr', moving the line from
position `x' right by one character.
@end deffn

@geindex insdelln() (método curses.window)
@anchor{library/curses curses window insdelln}@anchor{31be}
@deffn {Método} window.insdelln (nlines)

Insert `nlines' lines into the specified window above the current line.  The
`nlines' bottom lines are lost.  For negative `nlines', delete `nlines' lines
starting with the one under the cursor, and move the remaining lines up.  The
bottom `nlines' lines are cleared.  The current cursor position remains the
same.
@end deffn

@geindex insertln() (método curses.window)
@anchor{library/curses curses window insertln}@anchor{31bf}
@deffn {Método} window.insertln ()

Insert a blank line under the cursor. All following lines are moved down by one
line.
@end deffn

@geindex insnstr() (método curses.window)
@anchor{library/curses curses window insnstr}@anchor{31c0}
@deffn {Método} window.insnstr (str, n[, attr])

@deffnx {Método} window.insnstr (y, x, str, n[, attr])

Insert a character string (as many characters as will fit on the line) before
the character under the cursor, up to `n' characters.   If `n' is zero or
negative, the entire string is inserted. All characters to the right of the
cursor are shifted right, with the rightmost characters on the line being lost.
The cursor position does not change (after moving to `y', `x', if specified).
@end deffn

@geindex insstr() (método curses.window)
@anchor{library/curses curses window insstr}@anchor{31c1}
@deffn {Método} window.insstr (str[, attr])

@deffnx {Método} window.insstr (y, x, str[, attr])

Insert a character string (as many characters as will fit on the line) before
the character under the cursor.  All characters to the right of the cursor are
shifted right, with the rightmost characters on the line being lost.  The cursor
position does not change (after moving to `y', `x', if specified).
@end deffn

@geindex instr() (método curses.window)
@anchor{library/curses curses window instr}@anchor{31c2}
@deffn {Método} window.instr ([n])

@deffnx {Método} window.instr (y, x[, n])

Return a bytes object of characters, extracted from the window starting at the
current cursor position, or at `y', `x' if specified. Attributes are stripped
from the characters.  If `n' is specified, @ref{31c2,,instr()} returns a string
at most `n' characters long (exclusive of the trailing NUL).
@end deffn

@geindex is_linetouched() (método curses.window)
@anchor{library/curses curses window is_linetouched}@anchor{31c3}
@deffn {Método} window.is_linetouched (line)

Return @code{True} if the specified line was modified since the last call to
@ref{3154,,refresh()}; otherwise return @code{False}.  Raise a @ref{3140,,curses.error}
exception if `line' is not valid for the given window.
@end deffn

@geindex is_wintouched() (método curses.window)
@anchor{library/curses curses window is_wintouched}@anchor{31c4}
@deffn {Método} window.is_wintouched ()

Return @code{True} if the specified window was modified since the last call to
@ref{3154,,refresh()}; otherwise return @code{False}.
@end deffn

@geindex keypad() (método curses.window)
@anchor{library/curses curses window keypad}@anchor{31c5}
@deffn {Método} window.keypad (flag)

If `flag' is @code{True}, escape sequences generated by some keys (keypad,  function keys)
will be interpreted by @ref{2b,,curses}. If `flag' is @code{False}, escape sequences will be
left as is in the input stream.
@end deffn

@geindex leaveok() (método curses.window)
@anchor{library/curses curses window leaveok}@anchor{3166}
@deffn {Método} window.leaveok (flag)

If `flag' is @code{True}, cursor is left where it is on update, instead of being at “cursor
position.”  This reduces cursor movement where possible. If possible the cursor
will be made invisible.

If `flag' is @code{False}, cursor will always be at “cursor position” after an update.
@end deffn

@geindex move() (método curses.window)
@anchor{library/curses curses window move}@anchor{31c6}
@deffn {Método} window.move (new_y, new_x)

Move cursor to @code{(new_y, new_x)}.
@end deffn

@geindex mvderwin() (método curses.window)
@anchor{library/curses curses window mvderwin}@anchor{31c7}
@deffn {Método} window.mvderwin (y, x)

Move the window inside its parent window.  The screen-relative parameters of
the window are not changed.  This routine is used to display different parts of
the parent window at the same physical position on the screen.
@end deffn

@geindex mvwin() (método curses.window)
@anchor{library/curses curses window mvwin}@anchor{31c8}
@deffn {Método} window.mvwin (new_y, new_x)

Move the window so its upper-left corner is at @code{(new_y, new_x)}.
@end deffn

@geindex nodelay() (método curses.window)
@anchor{library/curses curses window nodelay}@anchor{31c9}
@deffn {Método} window.nodelay (flag)

If `flag' is @code{True}, @ref{1627,,getch()} will be non-blocking.
@end deffn

@geindex notimeout() (método curses.window)
@anchor{library/curses curses window notimeout}@anchor{31ca}
@deffn {Método} window.notimeout (flag)

If `flag' is @code{True}, escape sequences will not be timed out.

If `flag' is @code{False}, after a few milliseconds, an escape sequence will not be
interpreted, and will be left in the input stream as is.
@end deffn

@geindex noutrefresh() (método curses.window)
@anchor{library/curses curses window noutrefresh}@anchor{3152}
@deffn {Método} window.noutrefresh ()

Mark for refresh but wait.  This function updates the data structure
representing the desired state of the window, but does not force an update of
the physical screen.  To accomplish that, call  @ref{3151,,doupdate()}.
@end deffn

@geindex overlay() (método curses.window)
@anchor{library/curses curses window overlay}@anchor{31cb}
@deffn {Método} window.overlay (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Overlay the window on top of `destwin'. The windows need not be the same size,
only the overlapping region is copied. This copy is non-destructive, which means
that the current background character does not overwrite the old contents of
`destwin'.

To get fine-grained control over the copied region, the second form of
@ref{31cb,,overlay()} can be used. `sminrow' and `smincol' are the upper-left
coordinates of the source window, and the other variables mark a rectangle in
the destination window.
@end deffn

@geindex overwrite() (método curses.window)
@anchor{library/curses curses window overwrite}@anchor{31cc}
@deffn {Método} window.overwrite (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

Overwrite the window on top of `destwin'. The windows need not be the same size,
in which case only the overlapping region is copied. This copy is destructive,
which means that the current background character overwrites the old contents of
`destwin'.

To get fine-grained control over the copied region, the second form of
@ref{31cc,,overwrite()} can be used. `sminrow' and `smincol' are the upper-left
coordinates of the source window, the other variables mark a rectangle in the
destination window.
@end deffn

@geindex putwin() (método curses.window)
@anchor{library/curses curses window putwin}@anchor{3168}
@deffn {Método} window.putwin (file)

Write all data associated with the window into the provided file object.  This
information can be later retrieved using the @ref{3167,,getwin()} function.
@end deffn

@geindex redrawln() (método curses.window)
@anchor{library/curses curses window redrawln}@anchor{31cd}
@deffn {Método} window.redrawln (beg, num)

Indicate that the `num' screen lines, starting at line `beg', are corrupted and
should be completely redrawn on the next @ref{3154,,refresh()} call.
@end deffn

@geindex redrawwin() (método curses.window)
@anchor{library/curses curses window redrawwin}@anchor{31ce}
@deffn {Método} window.redrawwin ()

Touch the entire window, causing it to be completely redrawn on the next
@ref{3154,,refresh()} call.
@end deffn

@geindex refresh() (método curses.window)
@anchor{library/curses curses window refresh}@anchor{3154}
@deffn {Método} window.refresh ([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

Update the display immediately (sync actual screen with previous
drawing/deleting methods).

The 6 optional arguments can only be specified when the window is a pad created
with @ref{3179,,newpad()}.  The additional parameters are needed to indicate what part
of the pad and screen are involved. `pminrow' and `pmincol' specify the upper
left-hand corner of the rectangle to be displayed in the pad.  `sminrow',
`smincol', `smaxrow', and `smaxcol' specify the edges of the rectangle to be
displayed on the screen.  The lower right-hand corner of the rectangle to be
displayed in the pad is calculated from the screen coordinates, since the
rectangles must be the same size.  Both rectangles must be entirely contained
within their respective structures.  Negative values of `pminrow', `pmincol',
`sminrow', or `smincol' are treated as if they were zero.
@end deffn

@geindex resize() (método curses.window)
@anchor{library/curses curses window resize}@anchor{31cf}
@deffn {Método} window.resize (nlines, ncols)

Reallocate storage for a curses window to adjust its dimensions to the
specified values.  If either dimension is larger than the current values, the
window’s data is filled with blanks that have the current background
rendition (as set by @ref{319b,,bkgdset()}) merged into them.
@end deffn

@geindex scroll() (método curses.window)
@anchor{library/curses curses window scroll}@anchor{31d0}
@deffn {Método} window.scroll ([lines=1])

Scroll the screen or scrolling region upward by `lines' lines.
@end deffn

@geindex scrollok() (método curses.window)
@anchor{library/curses curses window scrollok}@anchor{31d1}
@deffn {Método} window.scrollok (flag)

Control what happens when the cursor of a window is moved off the edge of the
window or scrolling region, either as a result of a newline action on the bottom
line, or typing the last character of the last line.  If `flag' is @code{False}, the
cursor is left on the bottom line.  If `flag' is @code{True}, the window is scrolled up
one line.  Note that in order to get the physical scrolling effect on the
terminal, it is also necessary to call @ref{31ba,,idlok()}.
@end deffn

@geindex setscrreg() (método curses.window)
@anchor{library/curses curses window setscrreg}@anchor{31d2}
@deffn {Método} window.setscrreg (top, bottom)

Set the scrolling region from line `top' to line `bottom'. All scrolling actions
will take place in this region.
@end deffn

@geindex standend() (método curses.window)
@anchor{library/curses curses window standend}@anchor{31d3}
@deffn {Método} window.standend ()

Turn off the standout attribute.  On some terminals this has the side effect of
turning off all attributes.
@end deffn

@geindex standout() (método curses.window)
@anchor{library/curses curses window standout}@anchor{31d4}
@deffn {Método} window.standout ()

Turn on attribute `A_STANDOUT'.
@end deffn

@geindex subpad() (método curses.window)
@anchor{library/curses curses window subpad}@anchor{31d5}
@deffn {Método} window.subpad (begin_y, begin_x)

@deffnx {Método} window.subpad (nlines, ncols, begin_y, begin_x)

Return a sub-window, whose upper-left corner is at @code{(begin_y, begin_x)}, and
whose width/height is `ncols'/`nlines'.
@end deffn

@geindex subwin() (método curses.window)
@anchor{library/curses curses window subwin}@anchor{31af}
@deffn {Método} window.subwin (begin_y, begin_x)

@deffnx {Método} window.subwin (nlines, ncols, begin_y, begin_x)

Return a sub-window, whose upper-left corner is at @code{(begin_y, begin_x)}, and
whose width/height is `ncols'/`nlines'.

By default, the sub-window will extend from the specified position to the lower
right corner of the window.
@end deffn

@geindex syncdown() (método curses.window)
@anchor{library/curses curses window syncdown}@anchor{31d6}
@deffn {Método} window.syncdown ()

Touch each location in the window that has been touched in any of its ancestor
windows.  This routine is called by @ref{3154,,refresh()}, so it should almost never
be necessary to call it manually.
@end deffn

@geindex syncok() (método curses.window)
@anchor{library/curses curses window syncok}@anchor{31d7}
@deffn {Método} window.syncok (flag)

If `flag' is @code{True}, then @ref{31d8,,syncup()} is called automatically
whenever there is a change in the window.
@end deffn

@geindex syncup() (método curses.window)
@anchor{library/curses curses window syncup}@anchor{31d8}
@deffn {Método} window.syncup ()

Touch all locations in ancestors of the window that have been changed in  the
window.
@end deffn

@geindex timeout() (método curses.window)
@anchor{library/curses curses window timeout}@anchor{31d9}
@deffn {Método} window.timeout (delay)

Set blocking or non-blocking read behavior for the window.  If `delay' is
negative, blocking read is used (which will wait indefinitely for input).  If
`delay' is zero, then non-blocking read is used, and @ref{1627,,getch()} will
return @code{-1} if no input is waiting.  If `delay' is positive, then
@ref{1627,,getch()} will block for `delay' milliseconds, and return @code{-1} if there is
still no input at the end of that time.
@end deffn

@geindex touchline() (método curses.window)
@anchor{library/curses curses window touchline}@anchor{31a5}
@deffn {Método} window.touchline (start, count[, changed])

Pretend `count' lines have been changed, starting with line `start'.  If
`changed' is supplied, it specifies whether the affected lines are marked as
having been changed (`changed'@code{=True}) or unchanged (`changed'@code{=False}).
@end deffn

@geindex touchwin() (método curses.window)
@anchor{library/curses curses window touchwin}@anchor{31da}
@deffn {Método} window.touchwin ()

Pretend the whole window has been changed, for purposes of drawing
optimizations.
@end deffn

@geindex untouchwin() (método curses.window)
@anchor{library/curses curses window untouchwin}@anchor{31db}
@deffn {Método} window.untouchwin ()

Mark all lines in  the  window  as unchanged since the last call to
@ref{3154,,refresh()}.
@end deffn

@geindex vline() (método curses.window)
@anchor{library/curses curses window vline}@anchor{1886}
@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>,,Window Objects,curses — Gerenciador de terminal para visualizadores de células de caracteres
@anchor{library/curses constants}@anchor{31dc}
@subsubsection Constantes


The @ref{2b,,curses} module defines the following data members:

@geindex ERR (no módulo curses)
@anchor{library/curses curses ERR}@anchor{31dd}
@deffn {Dado} curses.ERR

Some curses routines  that  return  an integer, such as @ref{1627,,getch()}, return
@ref{31dd,,ERR} upon failure.
@end deffn

@geindex OK (no módulo curses)
@anchor{library/curses curses OK}@anchor{31de}
@deffn {Dado} curses.OK

Some curses routines  that  return  an integer, such as  @ref{1688,,napms()}, return
@ref{31de,,OK} upon success.
@end deffn

@geindex version (no módulo curses)
@anchor{library/curses curses version}@anchor{31df}
@deffn {Dado} curses.version

A bytes object representing the current version of the module.
@end deffn

@geindex ncurses_version (no módulo curses)
@anchor{library/curses curses ncurses_version}@anchor{9ef}
@deffn {Dado} curses.ncurses_version

A named tuple containing the three components of the ncurses library
version: `major', `minor', and `patch'.  All values are integers.  The
components can also be accessed by name,  so @code{curses.ncurses_version[0]}
is equivalent to @code{curses.ncurses_version.major} and so on.

Availability: if the ncurses library is used.


Adicionado na versão 3.8.

@end deffn

@geindex COLORS (no módulo curses)
@anchor{library/curses curses COLORS}@anchor{3187}
@deffn {Dado} curses.COLORS

The maximum number of colors the terminal can support.
It is defined only after the call to @ref{3186,,start_color()}.
@end deffn

@geindex COLOR_PAIRS (no módulo curses)
@anchor{library/curses curses COLOR_PAIRS}@anchor{3188}
@deffn {Dado} curses.COLOR_PAIRS

The maximum number of color pairs the terminal can support.
It is defined only after the call to @ref{3186,,start_color()}.
@end deffn

@geindex COLS (no módulo curses)
@anchor{library/curses curses COLS}@anchor{e18}
@deffn {Dado} curses.COLS

The width of the screen, i.e., the number of columns.
It is defined only after the call to @ref{1689,,initscr()}.
Updated by @ref{e16,,update_lines_cols()}, @ref{1690,,resizeterm()} and
@ref{1691,,resize_term()}.
@end deffn

@geindex LINES (no módulo curses)
@anchor{library/curses curses LINES}@anchor{e17}
@deffn {Dado} curses.LINES

The height of the screen, i.e., the number of lines.
It is defined only after the call to @ref{1689,,initscr()}.
Updated by @ref{e16,,update_lines_cols()}, @ref{1690,,resizeterm()} and
@ref{1691,,resize_term()}.
@end deffn

Some constants are available to specify character cell attributes.
The exact constants available are system dependent.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Significado

@item

@geindex A_ALTCHARSET (no módulo curses)
@anchor{library/curses curses A_ALTCHARSET}@anchor{31e0}
@deffn {Dado} curses.A_ALTCHARSET
@end deffn

@tab

Alternate character set mode

@item

@geindex A_BLINK (no módulo curses)
@anchor{library/curses curses A_BLINK}@anchor{31e1}
@deffn {Dado} curses.A_BLINK
@end deffn

@tab

Blink mode

@item

@geindex A_BOLD (no módulo curses)
@anchor{library/curses curses A_BOLD}@anchor{31e2}
@deffn {Dado} curses.A_BOLD
@end deffn

@tab

Bold mode

@item

@geindex A_DIM (no módulo curses)
@anchor{library/curses curses A_DIM}@anchor{31e3}
@deffn {Dado} curses.A_DIM
@end deffn

@tab

Dim mode

@item

@geindex A_INVIS (no módulo curses)
@anchor{library/curses curses A_INVIS}@anchor{31e4}
@deffn {Dado} curses.A_INVIS
@end deffn

@tab

Invisible or blank mode

@item

@geindex A_ITALIC (no módulo curses)
@anchor{library/curses curses A_ITALIC}@anchor{31e5}
@deffn {Dado} curses.A_ITALIC
@end deffn

@tab

Italic mode

@item

@geindex A_NORMAL (no módulo curses)
@anchor{library/curses curses A_NORMAL}@anchor{3141}
@deffn {Dado} curses.A_NORMAL
@end deffn

@tab

Normal attribute

@item

@geindex A_PROTECT (no módulo curses)
@anchor{library/curses curses A_PROTECT}@anchor{31e6}
@deffn {Dado} curses.A_PROTECT
@end deffn

@tab

Protected mode

@item

@geindex A_REVERSE (no módulo curses)
@anchor{library/curses curses A_REVERSE}@anchor{3149}
@deffn {Dado} curses.A_REVERSE
@end deffn

@tab

Reverse background and
foreground colors

@item

@geindex A_STANDOUT (no módulo curses)
@anchor{library/curses curses A_STANDOUT}@anchor{3148}
@deffn {Dado} curses.A_STANDOUT
@end deffn

@tab

Standout mode

@item

@geindex A_UNDERLINE (no módulo curses)
@anchor{library/curses curses A_UNDERLINE}@anchor{31e7}
@deffn {Dado} curses.A_UNDERLINE
@end deffn

@tab

Underline mode

@item

@geindex A_HORIZONTAL (no módulo curses)
@anchor{library/curses curses A_HORIZONTAL}@anchor{31e8}
@deffn {Dado} curses.A_HORIZONTAL
@end deffn

@tab

Horizontal highlight

@item

@geindex A_LEFT (no módulo curses)
@anchor{library/curses curses A_LEFT}@anchor{31e9}
@deffn {Dado} curses.A_LEFT
@end deffn

@tab

Left highlight

@item

@geindex A_LOW (no módulo curses)
@anchor{library/curses curses A_LOW}@anchor{31ea}
@deffn {Dado} curses.A_LOW
@end deffn

@tab

Low highlight

@item

@geindex A_RIGHT (no módulo curses)
@anchor{library/curses curses A_RIGHT}@anchor{31eb}
@deffn {Dado} curses.A_RIGHT
@end deffn

@tab

Right highlight

@item

@geindex A_TOP (no módulo curses)
@anchor{library/curses curses A_TOP}@anchor{31ec}
@deffn {Dado} curses.A_TOP
@end deffn

@tab

Top highlight

@item

@geindex A_VERTICAL (no módulo curses)
@anchor{library/curses curses A_VERTICAL}@anchor{31ed}
@deffn {Dado} curses.A_VERTICAL
@end deffn

@tab

Vertical highlight

@end multitable



Adicionado na versão 3.7: @code{A_ITALIC} was added.


Several constants are available to extract corresponding attributes returned
by some methods.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Bit-mask

@tab

Significado

@item

@geindex A_ATTRIBUTES (no módulo curses)
@anchor{library/curses curses A_ATTRIBUTES}@anchor{31ee}
@deffn {Dado} curses.A_ATTRIBUTES
@end deffn

@tab

Bit-mask to extract
attributes

@item

@geindex A_CHARTEXT (no módulo curses)
@anchor{library/curses curses A_CHARTEXT}@anchor{31ef}
@deffn {Dado} curses.A_CHARTEXT
@end deffn

@tab

Bit-mask to extract a
character

@item

@geindex A_COLOR (no módulo curses)
@anchor{library/curses curses A_COLOR}@anchor{31f0}
@deffn {Dado} curses.A_COLOR
@end deffn

@tab

Bit-mask to extract
color-pair field information

@end multitable


Keys are referred to by integer constants with names starting with  @code{KEY_}.
The exact keycaps available are system dependent.

@c XXX this table is far too large! should it be alphabetized?


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Key constant

@tab

Chave

@item

@geindex KEY_MIN (no módulo curses)
@anchor{library/curses curses KEY_MIN}@anchor{31f1}
@deffn {Dado} curses.KEY_MIN
@end deffn

@tab

Minimum key value

@item

@geindex KEY_BREAK (no módulo curses)
@anchor{library/curses curses KEY_BREAK}@anchor{31f2}
@deffn {Dado} curses.KEY_BREAK
@end deffn

@tab

Break key (unreliable)

@item

@geindex KEY_DOWN (no módulo curses)
@anchor{library/curses curses KEY_DOWN}@anchor{31f3}
@deffn {Dado} curses.KEY_DOWN
@end deffn

@tab

Down-arrow

@item

@geindex KEY_UP (no módulo curses)
@anchor{library/curses curses KEY_UP}@anchor{31f4}
@deffn {Dado} curses.KEY_UP
@end deffn

@tab

Up-arrow

@item

@geindex KEY_LEFT (no módulo curses)
@anchor{library/curses curses KEY_LEFT}@anchor{31f5}
@deffn {Dado} curses.KEY_LEFT
@end deffn

@tab

Left-arrow

@item

@geindex KEY_RIGHT (no módulo curses)
@anchor{library/curses curses KEY_RIGHT}@anchor{31f6}
@deffn {Dado} curses.KEY_RIGHT
@end deffn

@tab

Right-arrow

@item

@geindex KEY_HOME (no módulo curses)
@anchor{library/curses curses KEY_HOME}@anchor{31f7}
@deffn {Dado} curses.KEY_HOME
@end deffn

@tab

Home key (upward+left arrow)

@item

@geindex KEY_BACKSPACE (no módulo curses)
@anchor{library/curses curses KEY_BACKSPACE}@anchor{31f8}
@deffn {Dado} curses.KEY_BACKSPACE
@end deffn

@tab

Backspace (unreliable)

@item

@geindex KEY_F0 (no módulo curses)
@anchor{library/curses curses KEY_F0}@anchor{31f9}
@deffn {Dado} curses.KEY_F0
@end deffn

@tab

Function keys.  Up to 64 function keys are
supported.

@item

@geindex KEY_Fn (no módulo curses)
@anchor{library/curses curses KEY_Fn}@anchor{31fa}
@deffn {Dado} curses.KEY_Fn
@end deffn

@tab

Value of function key `n'

@item

@geindex KEY_DL (no módulo curses)
@anchor{library/curses curses KEY_DL}@anchor{31fb}
@deffn {Dado} curses.KEY_DL
@end deffn

@tab

Delete line

@item

@geindex KEY_IL (no módulo curses)
@anchor{library/curses curses KEY_IL}@anchor{31fc}
@deffn {Dado} curses.KEY_IL
@end deffn

@tab

Insert line

@item

@geindex KEY_DC (no módulo curses)
@anchor{library/curses curses KEY_DC}@anchor{31fd}
@deffn {Dado} curses.KEY_DC
@end deffn

@tab

Delete character

@item

@geindex KEY_IC (no módulo curses)
@anchor{library/curses curses KEY_IC}@anchor{31fe}
@deffn {Dado} curses.KEY_IC
@end deffn

@tab

Insert char or enter insert mode

@item

@geindex KEY_EIC (no módulo curses)
@anchor{library/curses curses KEY_EIC}@anchor{31ff}
@deffn {Dado} curses.KEY_EIC
@end deffn

@tab

Exit insert char mode

@item

@geindex KEY_CLEAR (no módulo curses)
@anchor{library/curses curses KEY_CLEAR}@anchor{3200}
@deffn {Dado} curses.KEY_CLEAR
@end deffn

@tab

Clear screen

@item

@geindex KEY_EOS (no módulo curses)
@anchor{library/curses curses KEY_EOS}@anchor{3201}
@deffn {Dado} curses.KEY_EOS
@end deffn

@tab

Clear to end of screen

@item

@geindex KEY_EOL (no módulo curses)
@anchor{library/curses curses KEY_EOL}@anchor{3202}
@deffn {Dado} curses.KEY_EOL
@end deffn

@tab

Clear to end of line

@item

@geindex KEY_SF (no módulo curses)
@anchor{library/curses curses KEY_SF}@anchor{3203}
@deffn {Dado} curses.KEY_SF
@end deffn

@tab

Scroll 1 line forward

@item

@geindex KEY_SR (no módulo curses)
@anchor{library/curses curses KEY_SR}@anchor{3204}
@deffn {Dado} curses.KEY_SR
@end deffn

@tab

Scroll 1 line backward (reverse)

@item

@geindex KEY_NPAGE (no módulo curses)
@anchor{library/curses curses KEY_NPAGE}@anchor{3205}
@deffn {Dado} curses.KEY_NPAGE
@end deffn

@tab

Next page

@item

@geindex KEY_PPAGE (no módulo curses)
@anchor{library/curses curses KEY_PPAGE}@anchor{3206}
@deffn {Dado} curses.KEY_PPAGE
@end deffn

@tab

Previous page

@item

@geindex KEY_STAB (no módulo curses)
@anchor{library/curses curses KEY_STAB}@anchor{3207}
@deffn {Dado} curses.KEY_STAB
@end deffn

@tab

Set tab

@item

@geindex KEY_CTAB (no módulo curses)
@anchor{library/curses curses KEY_CTAB}@anchor{3208}
@deffn {Dado} curses.KEY_CTAB
@end deffn

@tab

Clear tab

@item

@geindex KEY_CATAB (no módulo curses)
@anchor{library/curses curses KEY_CATAB}@anchor{3209}
@deffn {Dado} curses.KEY_CATAB
@end deffn

@tab

Clear all tabs

@item

@geindex KEY_ENTER (no módulo curses)
@anchor{library/curses curses KEY_ENTER}@anchor{320a}
@deffn {Dado} curses.KEY_ENTER
@end deffn

@tab

Enter or send (unreliable)

@item

@geindex KEY_SRESET (no módulo curses)
@anchor{library/curses curses KEY_SRESET}@anchor{320b}
@deffn {Dado} curses.KEY_SRESET
@end deffn

@tab

Soft (partial) reset (unreliable)

@item

@geindex KEY_RESET (no módulo curses)
@anchor{library/curses curses KEY_RESET}@anchor{320c}
@deffn {Dado} curses.KEY_RESET
@end deffn

@tab

Reset or hard reset (unreliable)

@item

@geindex KEY_PRINT (no módulo curses)
@anchor{library/curses curses KEY_PRINT}@anchor{320d}
@deffn {Dado} curses.KEY_PRINT
@end deffn

@tab

Print

@item

@geindex KEY_LL (no módulo curses)
@anchor{library/curses curses KEY_LL}@anchor{320e}
@deffn {Dado} curses.KEY_LL
@end deffn

@tab

Home down or bottom (lower left)

@item

@geindex KEY_A1 (no módulo curses)
@anchor{library/curses curses KEY_A1}@anchor{320f}
@deffn {Dado} curses.KEY_A1
@end deffn

@tab

Upper left of keypad

@item

@geindex KEY_A3 (no módulo curses)
@anchor{library/curses curses KEY_A3}@anchor{3210}
@deffn {Dado} curses.KEY_A3
@end deffn

@tab

Upper right of keypad

@item

@geindex KEY_B2 (no módulo curses)
@anchor{library/curses curses KEY_B2}@anchor{3211}
@deffn {Dado} curses.KEY_B2
@end deffn

@tab

Center of keypad

@item

@geindex KEY_C1 (no módulo curses)
@anchor{library/curses curses KEY_C1}@anchor{3212}
@deffn {Dado} curses.KEY_C1
@end deffn

@tab

Lower left of keypad

@item

@geindex KEY_C3 (no módulo curses)
@anchor{library/curses curses KEY_C3}@anchor{3213}
@deffn {Dado} curses.KEY_C3
@end deffn

@tab

Lower right of keypad

@item

@geindex KEY_BTAB (no módulo curses)
@anchor{library/curses curses KEY_BTAB}@anchor{3214}
@deffn {Dado} curses.KEY_BTAB
@end deffn

@tab

Back tab

@item

@geindex KEY_BEG (no módulo curses)
@anchor{library/curses curses KEY_BEG}@anchor{3215}
@deffn {Dado} curses.KEY_BEG
@end deffn

@tab

Beg (beginning)

@item

@geindex KEY_CANCEL (no módulo curses)
@anchor{library/curses curses KEY_CANCEL}@anchor{3216}
@deffn {Dado} curses.KEY_CANCEL
@end deffn

@tab

Cancelar

@item

@geindex KEY_CLOSE (no módulo curses)
@anchor{library/curses curses KEY_CLOSE}@anchor{3217}
@deffn {Dado} curses.KEY_CLOSE
@end deffn

@tab

Close

@item

@geindex KEY_COMMAND (no módulo curses)
@anchor{library/curses curses KEY_COMMAND}@anchor{3218}
@deffn {Dado} curses.KEY_COMMAND
@end deffn

@tab

Cmd (command)

@item

@geindex KEY_COPY (no módulo curses)
@anchor{library/curses curses KEY_COPY}@anchor{3219}
@deffn {Dado} curses.KEY_COPY
@end deffn

@tab

Copy

@item

@geindex KEY_CREATE (no módulo curses)
@anchor{library/curses curses KEY_CREATE}@anchor{321a}
@deffn {Dado} curses.KEY_CREATE
@end deffn

@tab

Create

@item

@geindex KEY_END (no módulo curses)
@anchor{library/curses curses KEY_END}@anchor{321b}
@deffn {Dado} curses.KEY_END
@end deffn

@tab

End

@item

@geindex KEY_EXIT (no módulo curses)
@anchor{library/curses curses KEY_EXIT}@anchor{321c}
@deffn {Dado} curses.KEY_EXIT
@end deffn

@tab

Exit

@item

@geindex KEY_FIND (no módulo curses)
@anchor{library/curses curses KEY_FIND}@anchor{321d}
@deffn {Dado} curses.KEY_FIND
@end deffn

@tab

Find

@item

@geindex KEY_HELP (no módulo curses)
@anchor{library/curses curses KEY_HELP}@anchor{321e}
@deffn {Dado} curses.KEY_HELP
@end deffn

@tab

Help

@item

@geindex KEY_MARK (no módulo curses)
@anchor{library/curses curses KEY_MARK}@anchor{321f}
@deffn {Dado} curses.KEY_MARK
@end deffn

@tab

Mark

@item

@geindex KEY_MESSAGE (no módulo curses)
@anchor{library/curses curses KEY_MESSAGE}@anchor{3220}
@deffn {Dado} curses.KEY_MESSAGE
@end deffn

@tab

Message

@item

@geindex KEY_MOVE (no módulo curses)
@anchor{library/curses curses KEY_MOVE}@anchor{3221}
@deffn {Dado} curses.KEY_MOVE
@end deffn

@tab

Move

@item

@geindex KEY_NEXT (no módulo curses)
@anchor{library/curses curses KEY_NEXT}@anchor{3222}
@deffn {Dado} curses.KEY_NEXT
@end deffn

@tab

Next

@item

@geindex KEY_OPEN (no módulo curses)
@anchor{library/curses curses KEY_OPEN}@anchor{3223}
@deffn {Dado} curses.KEY_OPEN
@end deffn

@tab

Open

@item

@geindex KEY_OPTIONS (no módulo curses)
@anchor{library/curses curses KEY_OPTIONS}@anchor{3224}
@deffn {Dado} curses.KEY_OPTIONS
@end deffn

@tab

Opções

@item

@geindex KEY_PREVIOUS (no módulo curses)
@anchor{library/curses curses KEY_PREVIOUS}@anchor{3225}
@deffn {Dado} curses.KEY_PREVIOUS
@end deffn

@tab

Prev (previous)

@item

@geindex KEY_REDO (no módulo curses)
@anchor{library/curses curses KEY_REDO}@anchor{3226}
@deffn {Dado} curses.KEY_REDO
@end deffn

@tab

Redo

@item

@geindex KEY_REFERENCE (no módulo curses)
@anchor{library/curses curses KEY_REFERENCE}@anchor{3227}
@deffn {Dado} curses.KEY_REFERENCE
@end deffn

@tab

Ref (reference)

@item

@geindex KEY_REFRESH (no módulo curses)
@anchor{library/curses curses KEY_REFRESH}@anchor{3228}
@deffn {Dado} curses.KEY_REFRESH
@end deffn

@tab

Refresh

@item

@geindex KEY_REPLACE (no módulo curses)
@anchor{library/curses curses KEY_REPLACE}@anchor{3229}
@deffn {Dado} curses.KEY_REPLACE
@end deffn

@tab

Replace

@item

@geindex KEY_RESTART (no módulo curses)
@anchor{library/curses curses KEY_RESTART}@anchor{322a}
@deffn {Dado} curses.KEY_RESTART
@end deffn

@tab

Restart

@item

@geindex KEY_RESUME (no módulo curses)
@anchor{library/curses curses KEY_RESUME}@anchor{322b}
@deffn {Dado} curses.KEY_RESUME
@end deffn

@tab

Resume

@item

@geindex KEY_SAVE (no módulo curses)
@anchor{library/curses curses KEY_SAVE}@anchor{322c}
@deffn {Dado} curses.KEY_SAVE
@end deffn

@tab

Save

@item

@geindex KEY_SBEG (no módulo curses)
@anchor{library/curses curses KEY_SBEG}@anchor{322d}
@deffn {Dado} curses.KEY_SBEG
@end deffn

@tab

Shifted Beg (beginning)

@item

@geindex KEY_SCANCEL (no módulo curses)
@anchor{library/curses curses KEY_SCANCEL}@anchor{322e}
@deffn {Dado} curses.KEY_SCANCEL
@end deffn

@tab

Shifted Cancel

@item

@geindex KEY_SCOMMAND (no módulo curses)
@anchor{library/curses curses KEY_SCOMMAND}@anchor{322f}
@deffn {Dado} curses.KEY_SCOMMAND
@end deffn

@tab

Shifted Command

@item

@geindex KEY_SCOPY (no módulo curses)
@anchor{library/curses curses KEY_SCOPY}@anchor{3230}
@deffn {Dado} curses.KEY_SCOPY
@end deffn

@tab

Shifted Copy

@item

@geindex KEY_SCREATE (no módulo curses)
@anchor{library/curses curses KEY_SCREATE}@anchor{3231}
@deffn {Dado} curses.KEY_SCREATE
@end deffn

@tab

Shifted Create

@item

@geindex KEY_SDC (no módulo curses)
@anchor{library/curses curses KEY_SDC}@anchor{3232}
@deffn {Dado} curses.KEY_SDC
@end deffn

@tab

Shifted Delete char

@item

@geindex KEY_SDL (no módulo curses)
@anchor{library/curses curses KEY_SDL}@anchor{3233}
@deffn {Dado} curses.KEY_SDL
@end deffn

@tab

Shifted Delete line

@item

@geindex KEY_SELECT (no módulo curses)
@anchor{library/curses curses KEY_SELECT}@anchor{3234}
@deffn {Dado} curses.KEY_SELECT
@end deffn

@tab

Select

@item

@geindex KEY_SEND (no módulo curses)
@anchor{library/curses curses KEY_SEND}@anchor{3235}
@deffn {Dado} curses.KEY_SEND
@end deffn

@tab

Shifted End

@item

@geindex KEY_SEOL (no módulo curses)
@anchor{library/curses curses KEY_SEOL}@anchor{3236}
@deffn {Dado} curses.KEY_SEOL
@end deffn

@tab

Shifted Clear line

@item

@geindex KEY_SEXIT (no módulo curses)
@anchor{library/curses curses KEY_SEXIT}@anchor{3237}
@deffn {Dado} curses.KEY_SEXIT
@end deffn

@tab

Shifted Exit

@item

@geindex KEY_SFIND (no módulo curses)
@anchor{library/curses curses KEY_SFIND}@anchor{3238}
@deffn {Dado} curses.KEY_SFIND
@end deffn

@tab

Shifted Find

@item

@geindex KEY_SHELP (no módulo curses)
@anchor{library/curses curses KEY_SHELP}@anchor{3239}
@deffn {Dado} curses.KEY_SHELP
@end deffn

@tab

Shifted Help

@item

@geindex KEY_SHOME (no módulo curses)
@anchor{library/curses curses KEY_SHOME}@anchor{323a}
@deffn {Dado} curses.KEY_SHOME
@end deffn

@tab

Shifted Home

@item

@geindex KEY_SIC (no módulo curses)
@anchor{library/curses curses KEY_SIC}@anchor{323b}
@deffn {Dado} curses.KEY_SIC
@end deffn

@tab

Shifted Input

@item

@geindex KEY_SLEFT (no módulo curses)
@anchor{library/curses curses KEY_SLEFT}@anchor{323c}
@deffn {Dado} curses.KEY_SLEFT
@end deffn

@tab

Shifted Left arrow

@item

@geindex KEY_SMESSAGE (no módulo curses)
@anchor{library/curses curses KEY_SMESSAGE}@anchor{323d}
@deffn {Dado} curses.KEY_SMESSAGE
@end deffn

@tab

Shifted Message

@item

@geindex KEY_SMOVE (no módulo curses)
@anchor{library/curses curses KEY_SMOVE}@anchor{323e}
@deffn {Dado} curses.KEY_SMOVE
@end deffn

@tab

Shifted Move

@item

@geindex KEY_SNEXT (no módulo curses)
@anchor{library/curses curses KEY_SNEXT}@anchor{323f}
@deffn {Dado} curses.KEY_SNEXT
@end deffn

@tab

Shifted Next

@item

@geindex KEY_SOPTIONS (no módulo curses)
@anchor{library/curses curses KEY_SOPTIONS}@anchor{3240}
@deffn {Dado} curses.KEY_SOPTIONS
@end deffn

@tab

Shifted Options

@item

@geindex KEY_SPREVIOUS (no módulo curses)
@anchor{library/curses curses KEY_SPREVIOUS}@anchor{3241}
@deffn {Dado} curses.KEY_SPREVIOUS
@end deffn

@tab

Shifted Prev

@item

@geindex KEY_SPRINT (no módulo curses)
@anchor{library/curses curses KEY_SPRINT}@anchor{3242}
@deffn {Dado} curses.KEY_SPRINT
@end deffn

@tab

Shifted Print

@item

@geindex KEY_SREDO (no módulo curses)
@anchor{library/curses curses KEY_SREDO}@anchor{3243}
@deffn {Dado} curses.KEY_SREDO
@end deffn

@tab

Shifted Redo

@item

@geindex KEY_SREPLACE (no módulo curses)
@anchor{library/curses curses KEY_SREPLACE}@anchor{3244}
@deffn {Dado} curses.KEY_SREPLACE
@end deffn

@tab

Shifted Replace

@item

@geindex KEY_SRIGHT (no módulo curses)
@anchor{library/curses curses KEY_SRIGHT}@anchor{3245}
@deffn {Dado} curses.KEY_SRIGHT
@end deffn

@tab

Shifted Right arrow

@item

@geindex KEY_SRSUME (no módulo curses)
@anchor{library/curses curses KEY_SRSUME}@anchor{3246}
@deffn {Dado} curses.KEY_SRSUME
@end deffn

@tab

Resumo alterado

@item

@geindex KEY_SSAVE (no módulo curses)
@anchor{library/curses curses KEY_SSAVE}@anchor{3247}
@deffn {Dado} curses.KEY_SSAVE
@end deffn

@tab

Shifted Save

@item

@geindex KEY_SSUSPEND (no módulo curses)
@anchor{library/curses curses KEY_SSUSPEND}@anchor{3248}
@deffn {Dado} curses.KEY_SSUSPEND
@end deffn

@tab

Shifted Suspend

@item

@geindex KEY_SUNDO (no módulo curses)
@anchor{library/curses curses KEY_SUNDO}@anchor{3249}
@deffn {Dado} curses.KEY_SUNDO
@end deffn

@tab

Shifted Undo

@item

@geindex KEY_SUSPEND (no módulo curses)
@anchor{library/curses curses KEY_SUSPEND}@anchor{324a}
@deffn {Dado} curses.KEY_SUSPEND
@end deffn

@tab

Suspend

@item

@geindex KEY_UNDO (no módulo curses)
@anchor{library/curses curses KEY_UNDO}@anchor{324b}
@deffn {Dado} curses.KEY_UNDO
@end deffn

@tab

Undo

@item

@geindex KEY_MOUSE (no módulo curses)
@anchor{library/curses curses KEY_MOUSE}@anchor{315c}
@deffn {Dado} curses.KEY_MOUSE
@end deffn

@tab

Mouse event has occurred

@item

@geindex KEY_RESIZE (no módulo curses)
@anchor{library/curses curses KEY_RESIZE}@anchor{324c}
@deffn {Dado} curses.KEY_RESIZE
@end deffn

@tab

Terminal resize event

@item

@geindex KEY_MAX (no módulo curses)
@anchor{library/curses curses KEY_MAX}@anchor{324d}
@deffn {Dado} curses.KEY_MAX
@end deffn

@tab

Maximum key value

@end multitable


On VT100s and their software emulations, such as X terminal emulators, there are
normally at least four function keys (@ref{31fa,,KEY_F1}, @ref{31fa,,KEY_F2},
@ref{31fa,,KEY_F3}, @ref{31fa,,KEY_F4}) available, and the arrow keys mapped to
@ref{31f4,,KEY_UP}, @ref{31f3,,KEY_DOWN}, @ref{31f5,,KEY_LEFT} and @ref{31f6,,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

Keycap

@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{324e}
The following table lists characters from the alternate character set. These are
inherited from the VT100 terminal, and will generally be  available on software
emulations such as X terminals.  When there is no graphic available, curses
falls back on a crude printable ASCII approximation.

@cartouche
@quotation Nota 
These are available only after @ref{1689,,initscr()} has  been called.
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código ACS

@tab

Significado

@item

@geindex ACS_BBSS (no módulo curses)
@anchor{library/curses curses ACS_BBSS}@anchor{324f}
@deffn {Dado} curses.ACS_BBSS
@end deffn

@tab

alternate name for upper right corner

@item

@geindex ACS_BLOCK (no módulo curses)
@anchor{library/curses curses ACS_BLOCK}@anchor{3250}
@deffn {Dado} curses.ACS_BLOCK
@end deffn

@tab

solid square block

@item

@geindex ACS_BOARD (no módulo curses)
@anchor{library/curses curses ACS_BOARD}@anchor{3251}
@deffn {Dado} curses.ACS_BOARD
@end deffn

@tab

board of squares

@item

@geindex ACS_BSBS (no módulo curses)
@anchor{library/curses curses ACS_BSBS}@anchor{3252}
@deffn {Dado} curses.ACS_BSBS
@end deffn

@tab

alternate name for horizontal line

@item

@geindex ACS_BSSB (no módulo curses)
@anchor{library/curses curses ACS_BSSB}@anchor{3253}
@deffn {Dado} curses.ACS_BSSB
@end deffn

@tab

alternate name for upper left corner

@item

@geindex ACS_BSSS (no módulo curses)
@anchor{library/curses curses ACS_BSSS}@anchor{3254}
@deffn {Dado} curses.ACS_BSSS
@end deffn

@tab

alternate name for top tee

@item

@geindex ACS_BTEE (no módulo curses)
@anchor{library/curses curses ACS_BTEE}@anchor{3255}
@deffn {Dado} curses.ACS_BTEE
@end deffn

@tab

bottom tee

@item

@geindex ACS_BULLET (no módulo curses)
@anchor{library/curses curses ACS_BULLET}@anchor{3256}
@deffn {Dado} curses.ACS_BULLET
@end deffn

@tab

bullet

@item

@geindex ACS_CKBOARD (no módulo curses)
@anchor{library/curses curses ACS_CKBOARD}@anchor{3257}
@deffn {Dado} curses.ACS_CKBOARD
@end deffn

@tab

checker board (stipple)

@item

@geindex ACS_DARROW (no módulo curses)
@anchor{library/curses curses ACS_DARROW}@anchor{3258}
@deffn {Dado} curses.ACS_DARROW
@end deffn

@tab

arrow pointing down

@item

@geindex ACS_DEGREE (no módulo curses)
@anchor{library/curses curses ACS_DEGREE}@anchor{3259}
@deffn {Dado} curses.ACS_DEGREE
@end deffn

@tab

degree symbol

@item

@geindex ACS_DIAMOND (no módulo curses)
@anchor{library/curses curses ACS_DIAMOND}@anchor{325a}
@deffn {Dado} curses.ACS_DIAMOND
@end deffn

@tab

diamond

@item

@geindex ACS_GEQUAL (no módulo curses)
@anchor{library/curses curses ACS_GEQUAL}@anchor{325b}
@deffn {Dado} curses.ACS_GEQUAL
@end deffn

@tab

greater-than-or-equal-to

@item

@geindex ACS_HLINE (no módulo curses)
@anchor{library/curses curses ACS_HLINE}@anchor{319e}
@deffn {Dado} curses.ACS_HLINE
@end deffn

@tab

horizontal line

@item

@geindex ACS_LANTERN (no módulo curses)
@anchor{library/curses curses ACS_LANTERN}@anchor{325c}
@deffn {Dado} curses.ACS_LANTERN
@end deffn

@tab

lantern symbol

@item

@geindex ACS_LARROW (no módulo curses)
@anchor{library/curses curses ACS_LARROW}@anchor{325d}
@deffn {Dado} curses.ACS_LARROW
@end deffn

@tab

left arrow

@item

@geindex ACS_LEQUAL (no módulo curses)
@anchor{library/curses curses ACS_LEQUAL}@anchor{325e}
@deffn {Dado} curses.ACS_LEQUAL
@end deffn

@tab

less-than-or-equal-to

@item

@geindex ACS_LLCORNER (no módulo curses)
@anchor{library/curses curses ACS_LLCORNER}@anchor{31a1}
@deffn {Dado} curses.ACS_LLCORNER
@end deffn

@tab

lower left-hand corner

@item

@geindex ACS_LRCORNER (no módulo curses)
@anchor{library/curses curses ACS_LRCORNER}@anchor{31a2}
@deffn {Dado} curses.ACS_LRCORNER
@end deffn

@tab

lower right-hand corner

@item

@geindex ACS_LTEE (no módulo curses)
@anchor{library/curses curses ACS_LTEE}@anchor{325f}
@deffn {Dado} curses.ACS_LTEE
@end deffn

@tab

left tee

@item

@geindex ACS_NEQUAL (no módulo curses)
@anchor{library/curses curses ACS_NEQUAL}@anchor{3260}
@deffn {Dado} curses.ACS_NEQUAL
@end deffn

@tab

not-equal sign

@item

@geindex ACS_PI (no módulo curses)
@anchor{library/curses curses ACS_PI}@anchor{3261}
@deffn {Dado} curses.ACS_PI
@end deffn

@tab

letter pi

@item

@geindex ACS_PLMINUS (no módulo curses)
@anchor{library/curses curses ACS_PLMINUS}@anchor{3262}
@deffn {Dado} curses.ACS_PLMINUS
@end deffn

@tab

plus-or-minus sign

@item

@geindex ACS_PLUS (no módulo curses)
@anchor{library/curses curses ACS_PLUS}@anchor{3263}
@deffn {Dado} curses.ACS_PLUS
@end deffn

@tab

big plus sign

@item

@geindex ACS_RARROW (no módulo curses)
@anchor{library/curses curses ACS_RARROW}@anchor{3264}
@deffn {Dado} curses.ACS_RARROW
@end deffn

@tab

right arrow

@item

@geindex ACS_RTEE (no módulo curses)
@anchor{library/curses curses ACS_RTEE}@anchor{3265}
@deffn {Dado} curses.ACS_RTEE
@end deffn

@tab

right tee

@item

@geindex ACS_S1 (no módulo curses)
@anchor{library/curses curses ACS_S1}@anchor{3266}
@deffn {Dado} curses.ACS_S1
@end deffn

@tab

scan line 1

@item

@geindex ACS_S3 (no módulo curses)
@anchor{library/curses curses ACS_S3}@anchor{3267}
@deffn {Dado} curses.ACS_S3
@end deffn

@tab

scan line 3

@item

@geindex ACS_S7 (no módulo curses)
@anchor{library/curses curses ACS_S7}@anchor{3268}
@deffn {Dado} curses.ACS_S7
@end deffn

@tab

scan line 7

@item

@geindex ACS_S9 (no módulo curses)
@anchor{library/curses curses ACS_S9}@anchor{3269}
@deffn {Dado} curses.ACS_S9
@end deffn

@tab

scan line 9

@item

@geindex ACS_SBBS (no módulo curses)
@anchor{library/curses curses ACS_SBBS}@anchor{326a}
@deffn {Dado} curses.ACS_SBBS
@end deffn

@tab

alternate name for lower right corner

@item

@geindex ACS_SBSB (no módulo curses)
@anchor{library/curses curses ACS_SBSB}@anchor{326b}
@deffn {Dado} curses.ACS_SBSB
@end deffn

@tab

alternate name for vertical line

@item

@geindex ACS_SBSS (no módulo curses)
@anchor{library/curses curses ACS_SBSS}@anchor{326c}
@deffn {Dado} curses.ACS_SBSS
@end deffn

@tab

alternate name for right tee

@item

@geindex ACS_SSBB (no módulo curses)
@anchor{library/curses curses ACS_SSBB}@anchor{326d}
@deffn {Dado} curses.ACS_SSBB
@end deffn

@tab

alternate name for lower left corner

@item

@geindex ACS_SSBS (no módulo curses)
@anchor{library/curses curses ACS_SSBS}@anchor{326e}
@deffn {Dado} curses.ACS_SSBS
@end deffn

@tab

alternate name for bottom tee

@item

@geindex ACS_SSSB (no módulo curses)
@anchor{library/curses curses ACS_SSSB}@anchor{326f}
@deffn {Dado} curses.ACS_SSSB
@end deffn

@tab

alternate name for left tee

@item

@geindex ACS_SSSS (no módulo curses)
@anchor{library/curses curses ACS_SSSS}@anchor{3270}
@deffn {Dado} curses.ACS_SSSS
@end deffn

@tab

alternate name for crossover or big plus

@item

@geindex ACS_STERLING (no módulo curses)
@anchor{library/curses curses ACS_STERLING}@anchor{3271}
@deffn {Dado} curses.ACS_STERLING
@end deffn

@tab

pound sterling

@item

@geindex ACS_TTEE (no módulo curses)
@anchor{library/curses curses ACS_TTEE}@anchor{3272}
@deffn {Dado} curses.ACS_TTEE
@end deffn

@tab

top tee

@item

@geindex ACS_UARROW (no módulo curses)
@anchor{library/curses curses ACS_UARROW}@anchor{3273}
@deffn {Dado} curses.ACS_UARROW
@end deffn

@tab

up arrow

@item

@geindex ACS_ULCORNER (no módulo curses)
@anchor{library/curses curses ACS_ULCORNER}@anchor{319f}
@deffn {Dado} curses.ACS_ULCORNER
@end deffn

@tab

upper left corner

@item

@geindex ACS_URCORNER (no módulo curses)
@anchor{library/curses curses ACS_URCORNER}@anchor{31a0}
@deffn {Dado} curses.ACS_URCORNER
@end deffn

@tab

upper right corner

@item

@geindex ACS_VLINE (no módulo curses)
@anchor{library/curses curses ACS_VLINE}@anchor{319d}
@deffn {Dado} curses.ACS_VLINE
@end deffn

@tab

vertical line

@end multitable


The following table lists mouse button constants used by @ref{315b,,getmouse()}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Mouse button constant

@tab

Significado

@item

@geindex BUTTONn_PRESSED (no módulo curses)
@anchor{library/curses curses BUTTONn_PRESSED}@anchor{315d}
@deffn {Dado} curses.BUTTONn_PRESSED
@end deffn

@tab

Mouse button `n' pressed

@item

@geindex BUTTONn_RELEASED (no módulo curses)
@anchor{library/curses curses BUTTONn_RELEASED}@anchor{315e}
@deffn {Dado} curses.BUTTONn_RELEASED
@end deffn

@tab

Mouse button `n' released

@item

@geindex BUTTONn_CLICKED (no módulo curses)
@anchor{library/curses curses BUTTONn_CLICKED}@anchor{315f}
@deffn {Dado} curses.BUTTONn_CLICKED
@end deffn

@tab

Mouse button `n' clicked

@item

@geindex BUTTONn_DOUBLE_CLICKED (no módulo curses)
@anchor{library/curses curses BUTTONn_DOUBLE_CLICKED}@anchor{3160}
@deffn {Dado} curses.BUTTONn_DOUBLE_CLICKED
@end deffn

@tab

Mouse button `n' double clicked

@item

@geindex BUTTONn_TRIPLE_CLICKED (no módulo curses)
@anchor{library/curses curses BUTTONn_TRIPLE_CLICKED}@anchor{3161}
@deffn {Dado} curses.BUTTONn_TRIPLE_CLICKED
@end deffn

@tab

Mouse button `n' triple clicked

@item

@geindex BUTTON_SHIFT (no módulo curses)
@anchor{library/curses curses BUTTON_SHIFT}@anchor{3162}
@deffn {Dado} curses.BUTTON_SHIFT
@end deffn

@tab

Shift was down during button state change

@item

@geindex BUTTON_CTRL (no módulo curses)
@anchor{library/curses curses BUTTON_CTRL}@anchor{3163}
@deffn {Dado} curses.BUTTON_CTRL
@end deffn

@tab

Control was down during button state change

@item

@geindex BUTTON_ALT (no módulo curses)
@anchor{library/curses curses BUTTON_ALT}@anchor{3164}
@deffn {Dado} curses.BUTTON_ALT
@end deffn

@tab

Control was down during button state change

@end multitable



Alterado na versão 3.10: The @code{BUTTON5_*} constants are now exposed if they are provided by the
underlying curses library.


The following table lists the predefined colors:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Color

@item

@geindex COLOR_BLACK (no módulo curses)
@anchor{library/curses curses COLOR_BLACK}@anchor{3274}
@deffn {Dado} curses.COLOR_BLACK
@end deffn

@tab

Black

@item

@geindex COLOR_BLUE (no módulo curses)
@anchor{library/curses curses COLOR_BLUE}@anchor{3275}
@deffn {Dado} curses.COLOR_BLUE
@end deffn

@tab

Blue

@item

@geindex COLOR_CYAN (no módulo curses)
@anchor{library/curses curses COLOR_CYAN}@anchor{3276}
@deffn {Dado} curses.COLOR_CYAN
@end deffn

@tab

Cyan (light greenish blue)

@item

@geindex COLOR_GREEN (no módulo curses)
@anchor{library/curses curses COLOR_GREEN}@anchor{3277}
@deffn {Dado} curses.COLOR_GREEN
@end deffn

@tab

Green

@item

@geindex COLOR_MAGENTA (no módulo curses)
@anchor{library/curses curses COLOR_MAGENTA}@anchor{3278}
@deffn {Dado} curses.COLOR_MAGENTA
@end deffn

@tab

Magenta (purplish red)

@item

@geindex COLOR_RED (no módulo curses)
@anchor{library/curses curses COLOR_RED}@anchor{3279}
@deffn {Dado} curses.COLOR_RED
@end deffn

@tab

Red

@item

@geindex COLOR_WHITE (no módulo curses)
@anchor{library/curses curses COLOR_WHITE}@anchor{327a}
@deffn {Dado} curses.COLOR_WHITE
@end deffn

@tab

White

@item

@geindex COLOR_YELLOW (no módulo curses)
@anchor{library/curses curses COLOR_YELLOW}@anchor{327b}
@deffn {Dado} curses.COLOR_YELLOW
@end deffn

@tab

Yellow

@end multitable


@node curses textpad — Text input widget for curses programs,curses ascii — Utilitários para caracteres ASCII,curses — Gerenciador de terminal para visualizadores de células de caracteres,Bibliotecas de interface de linha de comando
@anchor{library/curses curses-textpad-text-input-widget-for-curses-programs}@anchor{327c}@anchor{library/curses module-curses textpad}@anchor{2e}
@subsection @code{curses.textpad} — Text input widget for curses programs


@geindex module; curses.textpad

The @ref{2e,,curses.textpad} module provides a @ref{327d,,Textbox} class that handles
elementary text editing in a curses window, supporting a set of keybindings
resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
FrameMaker, and many other programs).  The module also provides a
rectangle-drawing function useful for framing text boxes or for other purposes.

The module @ref{2e,,curses.textpad} defines the following function:

@geindex rectangle() (no módulo curses.textpad)
@anchor{library/curses curses textpad rectangle}@anchor{327e}
@deffn {Função} curses.textpad.rectangle (win, uly, ulx, lry, lrx)

Draw a rectangle.  The first argument must be a window object; the remaining
arguments are coordinates relative to that window.  The second and third
arguments are the y and x coordinates of the upper left hand corner of the
rectangle to be drawn; the fourth and fifth arguments are the y and x
coordinates of the lower right hand corner. The rectangle will be drawn using
VT100/IBM PC forms characters on terminals that make this possible (including
xterm and most other software terminal emulators).  Otherwise it will be drawn
with ASCII  dashes, vertical bars, and plus signs.
@end deffn

@menu
* Textbox objects:: 

@end menu

@node Textbox objects,,,curses textpad — Text input widget for curses programs
@anchor{library/curses curses-textpad-objects}@anchor{327f}@anchor{library/curses textbox-objects}@anchor{3280}
@subsubsection Textbox objects


You can instantiate a @ref{327d,,Textbox} object as follows:

@geindex Textbox (classe em curses.textpad)
@anchor{library/curses curses textpad Textbox}@anchor{327d}
@deffn {Classe} curses.textpad.Textbox (win)

Return a textbox widget object.  The `win' argument should be a curses
@ref{3170,,window} object in which the textbox is to
be contained. The edit cursor of the textbox is initially located at the
upper left hand corner of the containing window, with coordinates @code{(0, 0)}.
The instance’s @ref{3281,,stripspaces} flag is initially on.

@ref{327d,,Textbox} objects have the following methods:

@geindex edit() (método curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox edit}@anchor{3282}
@deffn {Método} edit ([validator])

This is the entry point you will normally use.  It accepts editing
keystrokes until one of the termination keystrokes is entered.  If
`validator' is supplied, it must be a function.  It will be called for
each keystroke entered with the keystroke as a parameter; command dispatch
is done on the result. This method returns the window contents as a
string; whether blanks in the window are included is affected by the
@ref{3281,,stripspaces} attribute.
@end deffn

@geindex do_command() (método curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox do_command}@anchor{3283}
@deffn {Método} do_command (ch)

Process a single command keystroke.  Here are the supported special
keystrokes:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Keystroke

@tab

Ação

@item

@code{Control}-@code{A}

@tab

Go to left edge of window.

@item

@code{Control}-@code{B}

@tab

Cursor left, wrapping to previous line if
appropriate.

@item

@code{Control}-@code{D}

@tab

Delete character under cursor.

@item

@code{Control}-@code{E}

@tab

Go to right edge (stripspaces off) or end
of line (stripspaces on).

@item

@code{Control}-@code{F}

@tab

Cursor right, wrapping to next line when
appropriate.

@item

@code{Control}-@code{G}

@tab

Terminate, returning the window contents.

@item

@code{Control}-@code{H}

@tab

Delete character backward.

@item

@code{Control}-@code{J}

@tab

Terminate if the window is 1 line,
otherwise insert newline.

@item

@code{Control}-@code{K}

@tab

If line is blank, delete it, otherwise
clear to end of line.

@item

@code{Control}-@code{L}

@tab

Refresh screen.

@item

@code{Control}-@code{N}

@tab

Cursor down; move down one line.

@item

@code{Control}-@code{O}

@tab

Insert a blank line at cursor location.

@item

@code{Control}-@code{P}

@tab

Cursor up; move up one line.

@end multitable


Move operations do nothing if the cursor is at an edge where the movement
is not possible.  The following synonyms are supported where possible:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Keystroke

@item

@ref{31f5,,KEY_LEFT}

@tab

@code{Control}-@code{B}

@item

@ref{31f6,,KEY_RIGHT}

@tab

@code{Control}-@code{F}

@item

@ref{31f4,,KEY_UP}

@tab

@code{Control}-@code{P}

@item

@ref{31f3,,KEY_DOWN}

@tab

@code{Control}-@code{N}

@item

@ref{31f8,,KEY_BACKSPACE}

@tab

@code{Control}-@code{h}

@end multitable


All other keystrokes are treated as a command to insert the given
character and move right (with line wrapping).
@end deffn

@geindex gather() (método curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox gather}@anchor{3284}
@deffn {Método} gather ()

Return the window contents as a string; whether blanks in the
window are included is affected by the @ref{3281,,stripspaces} member.
@end deffn

@geindex stripspaces (atributo curses.textpad.Textbox)
@anchor{library/curses curses textpad Textbox stripspaces}@anchor{3281}
@deffn {Atributo} stripspaces

This attribute is a flag which controls the interpretation of blanks in
the window.  When it is on, trailing blanks on each line are ignored; any
cursor motion that would land the cursor on a trailing blank goes to the
end of that line instead, and trailing blanks are stripped when the window
contents are gathered.
@end deffn
@end deffn

@node curses ascii — Utilitários para caracteres ASCII,curses panel — Uma extensão de pilha de painéis para o curses,curses textpad — Text input widget for curses programs,Bibliotecas de interface de linha de comando
@anchor{library/curses ascii doc}@anchor{3285}@anchor{library/curses ascii curses-ascii-utilities-for-ascii-characters}@anchor{3286}@anchor{library/curses ascii module-curses ascii}@anchor{2c}@anchor{library/curses ascii translation-repo}@anchor{3287}
@subsection @code{curses.ascii} — Utilitários para caracteres ASCII


@geindex module; curses.ascii

`Código-fonte:' Lib/curses/ascii.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/curses/ascii.py}


__________________________________________________________________


O módulo @ref{2c,,curses.ascii} fornece constantes de nome para caracteres ASCII e funções para testar associação em várias classes de caracteres ASCII. As constantes fornecidas são nomes para caracteres de controle, como detalhado a seguir:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Significado

@item

@geindex NUL (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii NUL}@anchor{3288}
@deffn {Dado} curses.ascii.NUL
@end deffn

@tab

@item

@geindex SOH (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SOH}@anchor{3289}
@deffn {Dado} curses.ascii.SOH
@end deffn

@tab

Início do cabeçalho, interrupção do console

@item

@geindex STX (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii STX}@anchor{328a}
@deffn {Dado} curses.ascii.STX
@end deffn

@tab

Início de texto

@item

@geindex ETX (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ETX}@anchor{328b}
@deffn {Dado} curses.ascii.ETX
@end deffn

@tab

Fim de texto

@item

@geindex EOT (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii EOT}@anchor{328c}
@deffn {Dado} curses.ascii.EOT
@end deffn

@tab

Fim de transmissão

@item

@geindex ENQ (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ENQ}@anchor{328d}
@deffn {Dado} curses.ascii.ENQ
@end deffn

@tab

Consulta, segue com controle de fluxo @ref{328e,,ACK}

@item

@geindex ACK (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ACK}@anchor{328e}
@deffn {Dado} curses.ascii.ACK
@end deffn

@tab

Confirmação

@item

@geindex BEL (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii BEL}@anchor{328f}
@deffn {Dado} curses.ascii.BEL
@end deffn

@tab

Campainha

@item

@geindex BS (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii BS}@anchor{3290}
@deffn {Dado} curses.ascii.BS
@end deffn

@tab

Backspace

@item

@geindex TAB (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii TAB}@anchor{3291}
@deffn {Dado} curses.ascii.TAB
@end deffn

@tab

Tabulação

@item

@geindex HT (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii HT}@anchor{3292}
@deffn {Dado} curses.ascii.HT
@end deffn

@tab

Apelido para @ref{3291,,TAB}: “Tabulação horizontal”

@item

@geindex LF (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii LF}@anchor{3293}
@deffn {Dado} curses.ascii.LF
@end deffn

@tab

Alimentação de linha ou `line feed'

@item

@geindex NL (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii NL}@anchor{3294}
@deffn {Dado} curses.ascii.NL
@end deffn

@tab

Apelido para @ref{3293,,LF}: “Nova linha”

@item

@geindex VT (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii VT}@anchor{3295}
@deffn {Dado} curses.ascii.VT
@end deffn

@tab

Tabulação vertical

@item

@geindex FF (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii FF}@anchor{3296}
@deffn {Dado} curses.ascii.FF
@end deffn

@tab

Alimentação de formulário ou `form feed'

@item

@geindex CR (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii CR}@anchor{3297}
@deffn {Dado} curses.ascii.CR
@end deffn

@tab

Retorno de carro ou `carriage return'

@item

@geindex SO (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SO}@anchor{3298}
@deffn {Dado} curses.ascii.SO
@end deffn

@tab

Deslocamento para fora ou `shift-out', inicia um conjunto de caracteres alternativo

@item

@geindex SI (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SI}@anchor{3299}
@deffn {Dado} curses.ascii.SI
@end deffn

@tab

Deslocamento para dentro ou `shift-in', retoma o conjunto de caracteres padrão

@item

@geindex DLE (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DLE}@anchor{329a}
@deffn {Dado} curses.ascii.DLE
@end deffn

@tab

Escape de conexão ou `data-link escape'

@item

@geindex DC1 (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC1}@anchor{329b}
@deffn {Dado} curses.ascii.DC1
@end deffn

@tab

XON, para controle de fluxo

@item

@geindex DC2 (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC2}@anchor{329c}
@deffn {Dado} curses.ascii.DC2
@end deffn

@tab

Controle de dispositivo 2, control de fluxo em modo bloco

@item

@geindex DC3 (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC3}@anchor{329d}
@deffn {Dado} curses.ascii.DC3
@end deffn

@tab

XOFF, para controle de fluxo

@item

@geindex DC4 (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DC4}@anchor{329e}
@deffn {Dado} curses.ascii.DC4
@end deffn

@tab

Controle de dispositivo 4

@item

@geindex NAK (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii NAK}@anchor{329f}
@deffn {Dado} curses.ascii.NAK
@end deffn

@tab

Confirmação negativa

@item

@geindex SYN (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SYN}@anchor{32a0}
@deffn {Dado} curses.ascii.SYN
@end deffn

@tab

Estado ocioso síncrono

@item

@geindex ETB (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ETB}@anchor{32a1}
@deffn {Dado} curses.ascii.ETB
@end deffn

@tab

Bloco de fim de transmissão

@item

@geindex CAN (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii CAN}@anchor{32a2}
@deffn {Dado} curses.ascii.CAN
@end deffn

@tab

Cancelar

@item

@geindex EM (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii EM}@anchor{32a3}
@deffn {Dado} curses.ascii.EM
@end deffn

@tab

Fim de mídia

@item

@geindex SUB (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SUB}@anchor{32a4}
@deffn {Dado} curses.ascii.SUB
@end deffn

@tab

Substituir

@item

@geindex ESC (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ESC}@anchor{32a5}
@deffn {Dado} curses.ascii.ESC
@end deffn

@tab

Escapar

@item

@geindex FS (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii FS}@anchor{32a6}
@deffn {Dado} curses.ascii.FS
@end deffn

@tab

Separador de arquivos

@item

@geindex GS (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii GS}@anchor{32a7}
@deffn {Dado} curses.ascii.GS
@end deffn

@tab

Separador de grupos

@item

@geindex RS (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii RS}@anchor{32a8}
@deffn {Dado} curses.ascii.RS
@end deffn

@tab

Separador de registros, terminador de modo bloco

@item

@geindex US (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii US}@anchor{32a9}
@deffn {Dado} curses.ascii.US
@end deffn

@tab

Separador de unidades

@item

@geindex SP (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii SP}@anchor{32aa}
@deffn {Dado} curses.ascii.SP
@end deffn

@tab

Espaço

@item

@geindex DEL (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii DEL}@anchor{32ab}
@deffn {Dado} curses.ascii.DEL
@end deffn

@tab

Excluir

@end multitable


Note que muitos deles têm pouca significância prática no uso moderno. Os mnemônicos derivam de convenções de teleimpressoras que antecedem os computadores digitais.

O módulo fornece as seguintes funções, baseadas nas da biblioteca C padrão:

@geindex isalnum() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isalnum}@anchor{32ac}
@deffn {Função} curses.ascii.isalnum (c)

Verifica se há um caractere alfanumérico ASCII; equivale a @code{isalpha(c) or isdigit(c)}.
@end deffn

@geindex isalpha() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isalpha}@anchor{32ad}
@deffn {Função} curses.ascii.isalpha (c)

Verifica se há um caractere alfabético ASCII; equivale a @code{isupper(c) or islower(c)}.
@end deffn

@geindex isascii() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isascii}@anchor{32ae}
@deffn {Função} curses.ascii.isascii (c)

Verifica se há um valor de caractere que se encaixa no conjunto ASCII de 7 bits.
@end deffn

@geindex isblank() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isblank}@anchor{32af}
@deffn {Função} curses.ascii.isblank (c)

Verifica se há um caractere de espaço em branco ASCII; espaço ou tabulação horizontal.
@end deffn

@geindex iscntrl() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii iscntrl}@anchor{32b0}
@deffn {Função} curses.ascii.iscntrl (c)

Verifica se há um caractere de controle ASCII (no intervalo de 0x00 a 0x1f ou 0x7f).
@end deffn

@geindex isdigit() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isdigit}@anchor{32b1}
@deffn {Função} curses.ascii.isdigit (c)

Verifica se há um dígito decimal ASCII, @code{'0'} a @code{'9'}. Isso equivale a @code{c in string.digits}.
@end deffn

@geindex isgraph() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isgraph}@anchor{32b2}
@deffn {Função} curses.ascii.isgraph (c)

Verifica se há algum caractere ASCII imprimível, exceto espaço.
@end deffn

@geindex islower() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii islower}@anchor{32b3}
@deffn {Função} curses.ascii.islower (c)

Verifica se há um caractere ASCII minúsculo.
@end deffn

@geindex isprint() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isprint}@anchor{32b4}
@deffn {Função} curses.ascii.isprint (c)

Verifica se há algum caractere ASCII imprimível, incluindo espaço.
@end deffn

@geindex ispunct() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ispunct}@anchor{32b5}
@deffn {Função} curses.ascii.ispunct (c)

Verifica se há algum caractere ASCII imprimível que não seja um espaço ou um caractere alfanumérico.
@end deffn

@geindex isspace() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isspace}@anchor{32b6}
@deffn {Função} curses.ascii.isspace (c)

Verifica caracteres de espaço em branco ASCII; espaço, quebra de linha, retorno de carro, quebra de página, tabulação horizontal, tabulação vertical.
@end deffn

@geindex isupper() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isupper}@anchor{32b7}
@deffn {Função} curses.ascii.isupper (c)

Verifica se há uma letra maiúscula ASCII.
@end deffn

@geindex isxdigit() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isxdigit}@anchor{32b8}
@deffn {Função} curses.ascii.isxdigit (c)

Verifica se há um dígito hexadecimal ASCII. Isso equivale a @code{c in string.hexdigits}.
@end deffn

@geindex isctrl() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii isctrl}@anchor{32b9}
@deffn {Função} curses.ascii.isctrl (c)

Verifica se há um caractere de controle ASCII (valores ordinais de 0 a 31).
@end deffn

@geindex ismeta() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ismeta}@anchor{32ba}
@deffn {Função} curses.ascii.ismeta (c)

Verifica se há um caractere não ASCII (valores ordinais 0x80 e acima).
@end deffn

Essas funções aceitam números inteiros ou strings de caracteres únicos; quando o argumento é uma string, ele é primeiro convertido usando a função embutida @ref{2080,,ord()}.

Observe que todas essas funções verificam valores de bits ordinais derivados do caractere da string que você passa; elas não sabem nada sobre a codificação de caracteres da máquina host.

As duas funções a seguir aceitam uma string de caractere único ou um valor de byte inteiro; elas retornam um valor do mesmo tipo.

@geindex ascii() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ascii}@anchor{32bb}
@deffn {Função} curses.ascii.ascii (c)

Retorna o valor ASCII correspondente aos 7 bits mais baixos de `c'.
@end deffn

@geindex ctrl() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii ctrl}@anchor{32bc}
@deffn {Função} curses.ascii.ctrl (c)

Retorna o caractere de controle correspondente ao caractere fornecido (é feito um E bit a bit com 0x1f sobre o valor do bit do caractere).
@end deffn

@geindex alt() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii alt}@anchor{32bd}
@deffn {Função} curses.ascii.alt (c)

Retorna o caractere de 8 vits correspondente ao caractere ASCII fornecido (é feito um OU bit a bit com 0x80 sobre o valor do bit do caractere).
@end deffn

A função a seguir aceita uma string de um único caractere ou um valor inteiro; ela retorna uma string.

@geindex ^ (circunflexo);no módulo curses
@geindex ! (exclamação);no módulo curses

@geindex unctrl() (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii unctrl}@anchor{32be}
@deffn {Função} curses.ascii.unctrl (c)

Retorna uma representação de string do caractere ASCII `c'. Se `c' for imprimível, essa string é o próprio caractere. Se o caractere for um caractere de controle (0x00–0x1f), a string consiste em um acento circunflexo (@code{'^'}) seguido pela letra maiúscula correspondente. Se o caractere for de exclusão ASCII (0x7f), a string é @code{'^?'}. Se o caractere tiver seu metabit (0x80) definido, o metabit é removido, as regras precedentes são aplicadas e @code{'!'} é adicionado ao resultado.
@end deffn

@geindex controlnames (no módulo curses.ascii)
@anchor{library/curses ascii curses ascii controlnames}@anchor{32bf}
@deffn {Dado} curses.ascii.controlnames

Um vetor de strings de 33 elementos que contém os mnemônicos ASCII para os trinta e dois caracteres de controle ASCII de 0 (NUL) a 0x1f (US), em ordem, mais o mnemônico @code{SP} para o caractere de espaço.
@end deffn

@node curses panel — Uma extensão de pilha de painéis para o curses,cmd — Suporte para interpretadores de comando orientado a linhas,curses ascii — Utilitários para caracteres ASCII,Bibliotecas de interface de linha de comando
@anchor{library/curses panel doc}@anchor{32c0}@anchor{library/curses panel curses-panel-a-panel-stack-extension-for-curses}@anchor{32c1}@anchor{library/curses panel module-curses panel}@anchor{2d}@anchor{library/curses panel translation-repo}@anchor{32c2}
@subsection @code{curses.panel} — Uma extensão de pilha de painéis para o curses


@geindex module; curses.panel


__________________________________________________________________


Painéis são janelas com o recurso adicional de profundidade, então eles podem ser empilhados uns sobre os outros, e somente as partes visíveis de cada janela serão exibidas. Painéis podem ser adicionados, movidos para cima ou para baixo na pilha, e removidos.

@menu
* Funções: Funções<7>. 
* Objetos painel:: 

@end menu

@node Funções<7>,Objetos painel,,curses panel — Uma extensão de pilha de painéis para o curses
@anchor{library/curses panel cursespanel-functions}@anchor{32c3}@anchor{library/curses panel functions}@anchor{32c4}
@subsubsection Funções


O módulo @ref{2d,,curses.panel} define as seguintes funções:

@geindex bottom_panel() (no módulo curses.panel)
@anchor{library/curses panel curses panel bottom_panel}@anchor{32c5}
@deffn {Função} curses.panel.bottom_panel ()

Retorna o painel inferior da pilha de painéis.
@end deffn

@geindex new_panel() (no módulo curses.panel)
@anchor{library/curses panel curses panel new_panel}@anchor{32c6}
@deffn {Função} curses.panel.new_panel (win)

Retorna um objeto painel, associando-o à janela fornecida `win'. Esteja ciente de que você precisa manter o objeto painel retornado referenciado explicitamente. Se não fizer isso, o objeto painel será coletado como lixo e removido da pilha de painéis.
@end deffn

@geindex top_panel() (no módulo curses.panel)
@anchor{library/curses panel curses panel top_panel}@anchor{32c7}
@deffn {Função} curses.panel.top_panel ()

Retorna o painel superior da pilha de painéis.
@end deffn

@geindex update_panels() (no módulo curses.panel)
@anchor{library/curses panel curses panel update_panels}@anchor{32c8}
@deffn {Função} curses.panel.update_panels ()

Atualiza a tela virtual após alterações na pilha de painéis. Isso não chama @ref{3151,,curses.doupdate()}, então você terá que fazer isso sozinho.
@end deffn

@node Objetos painel,,Funções<7>,curses panel — Uma extensão de pilha de painéis para o curses
@anchor{library/curses panel curses-panel-objects}@anchor{32c9}@anchor{library/curses panel panel-objects}@anchor{32ca}
@subsubsection Objetos painel


Objetos painel, como retornados por @ref{32c6,,new_panel()} acima, são janelas com uma ordem de empilhamento. Há sempre uma janela associada a um painel que determina o conteúdo, enquanto os métodos de painel são responsáveis pela profundidade da janela na pilha de painéis.

Objetos painel possuem os seguintes métodos:

@geindex above() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel above}@anchor{32cb}
@deffn {Método} Panel.above ()

Retorna o painel acima do painel atual.
@end deffn

@geindex below() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel below}@anchor{32cc}
@deffn {Método} Panel.below ()

Retorna o painel abaixo do painel atual.
@end deffn

@geindex bottom() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel bottom}@anchor{32cd}
@deffn {Método} Panel.bottom ()

Insere o painel para o fundo da pilha.
@end deffn

@geindex hidden() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel hidden}@anchor{32ce}
@deffn {Método} Panel.hidden ()

Retorna @code{True} se o painel estiver oculto (não visível), @code{False} caso contrário.
@end deffn

@geindex hide() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel hide}@anchor{32cf}
@deffn {Método} Panel.hide ()

Oculta o painel. Isso não exclui o objeto, apenas torna a janela invisível na tela.
@end deffn

@geindex move() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel move}@anchor{32d0}
@deffn {Método} Panel.move (y, x)

Move o painel para as coordenadas @code{(y, x)} da tela.
@end deffn

@geindex replace() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel replace}@anchor{32d1}
@deffn {Método} Panel.replace (win)

Altera a janela associada ao painel para a janela `win'.
@end deffn

@geindex set_userptr() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel set_userptr}@anchor{32d2}
@deffn {Método} Panel.set_userptr (obj)

Define o ponteiro do usuário do painel para `obj'. Isso é usado para associar um pedaço arbitrário de dados ao painel, e pode ser qualquer objeto Python.
@end deffn

@geindex show() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel show}@anchor{32d3}
@deffn {Método} Panel.show ()

Exibe o painel (que pode estar oculto).
@end deffn

@geindex top() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel top}@anchor{32d4}
@deffn {Método} Panel.top ()

Insere o painel para o topo da pilha.
@end deffn

@geindex userptr() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel userptr}@anchor{32d5}
@deffn {Método} Panel.userptr ()

Retorna o ponteiro do usuário para o painel. Pode ser qualquer objeto Python.
@end deffn

@geindex window() (método curses.panel.Panel)
@anchor{library/curses panel curses panel Panel window}@anchor{32d6}
@deffn {Método} Panel.window ()

Retorna o objeto de janela associado ao painel.
@end deffn

@node cmd — Suporte para interpretadores de comando orientado a linhas,,curses panel — Uma extensão de pilha de painéis para o curses,Bibliotecas de interface de linha de comando
@anchor{library/cmd doc}@anchor{32d7}@anchor{library/cmd cmd-support-for-line-oriented-command-interpreters}@anchor{32d8}@anchor{library/cmd module-cmd}@anchor{19}@anchor{library/cmd translation-repo}@anchor{32d9}
@subsection @code{cmd} — Suporte para interpretadores de comando orientado a linhas


@geindex module; cmd

`Código-fonte:' Lib/cmd.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/cmd.py}


__________________________________________________________________


A classe @ref{17b8,,Cmd} fornece um framework simples para escrever interpretadores de comando orientados a linhas. Eles são frequentemente úteis para melhorar testes, ferramentas administrativas e protótipos que mais tarde serão encapsulados em uma interface mais sofisticada.

@geindex Cmd (classe em cmd)
@anchor{library/cmd cmd Cmd}@anchor{17b8}
@deffn {Classe} cmd.Cmd (completekey='tab', stdin=None, stdout=None)

Uma instância de @ref{17b8,,Cmd} ou instância de sua subclasse é um framework de interpretador orientado a linhas. Não há um bom motivo para instanciar @ref{17b8,,Cmd} em si; em vez disso, ele é útil como uma superclasse de uma classe de interpretador que você mesmo define para herdar os métodos de @ref{17b8,,Cmd} e encapsular métodos de ação.

O argumento opcional `completekey' é o nome @ref{ba,,readline} de uma chave de conclusão; o padrão é @code{Tab}. Se `completekey' não for @ref{675,,None} e @ref{ba,,readline} estiver disponível, a conclusão do comando será feita automaticamente.

O padrão, @code{'tab'}, é tratado especialmente, de modo que se refere à tecla @code{Tab} em cada @ref{17a3,,readline.backend}. Especificamente, se @ref{17a3,,readline.backend} for @code{editline}, @code{Cmd} usará @code{'^I'} em vez de @code{'tab'}. Observe que outros valores não são tratados dessa forma e podem funcionar apenas com um backend específico.

Os argumentos opcionais `stdin' e `stdout' especificam os objetos arquivo de entrada e saída que a instância Cmd ou instância de sua subclasse usará para entrada e saída. Se não forem especificados, eles serão padronizados para @ref{53d,,sys.stdin} e @ref{ae6,,sys.stdout}.

Se você quiser que um determinado `stdin' seja usado, certifique-se de definir o atributo @ref{32da,,use_rawinput} da instância como @code{False}, caso contrário, `stdin' será ignorado.


Alterado na versão 3.13: @code{completekey='tab'} é substituído por @code{'^I'} para @code{editline}.

@end deffn

@menu
* Objetos Cmd:: 
* Exemplo do Cmd:: 

@end menu

@node Objetos Cmd,Exemplo do Cmd,,cmd — Suporte para interpretadores de comando orientado a linhas
@anchor{library/cmd cmd-objects}@anchor{32db}@anchor{library/cmd id1}@anchor{32dc}
@subsubsection Objetos Cmd


Uma instância @ref{17b8,,Cmd} tem os seguintes métodos:

@geindex cmdloop() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd cmdloop}@anchor{32dd}
@deffn {Método} Cmd.cmdloop (intro=None)

Emite um prompt repetidamente, aceite a entrada, analise um prefixo inicial da entrada recebida e despache para métodos de ação, passando a eles o restante da linha como argumento.

O argumento opcional é um banner ou uma string de introdução a ser emitida antes do primeiro prompt (isso substitui o atributo de classe @ref{32de,,intro}).

Se o módulo @ref{ba,,readline} for carregado, a entrada vai herdar automaticamente a edição de lista de histórico semelhante a @code{bash} (por exemplo, @code{Control}-@code{P} retorna ao último comando, @code{Control}-@code{N} avança para o próximo, @code{Control}-@code{F} move o cursor para a direita de forma não destrutiva, @code{Control}-@code{B} move o cursor para a esquerda de forma não destrutiva, etc.).

Um fim de arquivo na entrada é retornado como a string @code{'EOF'}.

@geindex ? (interrogação);em um interpretador de comandos
@geindex ! (exclamação);em um interpretador de comandos

Uma instância de interpretador reconhecerá um comando chamado @code{foo} se e somente se ele tiver um método @code{do_foo()}. Como um caso especial, uma linha começando com o caractere @code{'?'} é despachada para o método @ref{17a7,,do_help()}. Como outro caso especial, uma linha começando com o caractere @code{'!'} é despachada para o método @code{do_shell()} (se tal método for definido).

Este método retornará quando o método @ref{32df,,postcmd()} retornar um valor true. O argumento `stop' para @ref{32df,,postcmd()} é o valor de retorno do método @code{do_*()} correspondente do comando.

Se o autocompletamento estiver habilitado, os comandos serão completados automaticamente, e o autocompletamento dos argumentos dos comandos será feito chamando @code{complete_foo()} com os argumentos `text', `line', `begidx' e `endidx'. `text' é o prefixo da string que estamos tentando corresponder: todas as correspondências retornadas devem começar com ele. `line' é a linha de entrada atual com os espaços em branco iniciais removidos, `begidx' e `endidx' são os índices inicial e final do texto de prefixo, que podem ser usados para fornecer diferentes autocompletamentos dependendo da posição em que o argumento está.
@end deffn

@geindex do_help() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd do_help}@anchor{17a7}
@deffn {Método} Cmd.do_help (arg)

Todas as subclasses de @ref{17b8,,Cmd} herdam um @code{do_help()} predefinido. Este método, chamado com um argumento @code{'bar'}, invoca o método correspondente @code{help_bar()}, e se este não estiver presente, imprime a docstring de @code{do_bar()}, se disponível. Sem argumento, @code{do_help()} lista todos os tópicos de ajuda disponíveis (isto é, todos os comandos com métodos @code{help_*()} correspondentes ou comandos que têm docstrings), e também lista quaisquer comandos não documentados.
@end deffn

@geindex onecmd() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd onecmd}@anchor{32e0}
@deffn {Método} Cmd.onecmd (str)

Interpreta o argumento como se tivesse sido digitado em resposta ao prompt. Isso pode ser substituído, mas normalmente não precisa ser; veja os métodos @ref{32e1,,precmd()} e @ref{32df,,postcmd()} para ganchos de execução úteis. O valor de retorno é um sinalizador que indica se a interpretação de comandos pelo interpretador deve parar. Se houver um método @code{do_*()} para o comando `str', o valor de retorno desse método é retornado, caso contrário, o valor de retorno do método @ref{32e2,,default()} é retornado.
@end deffn

@geindex emptyline() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd emptyline}@anchor{32e3}
@deffn {Método} Cmd.emptyline ()

Método chamado quando uma linha vazia é inserida em resposta ao prompt. Se esse método não for substituído, ele repete o último comando não vazio inserido.
@end deffn

@geindex default() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd default}@anchor{32e2}
@deffn {Método} Cmd.default (line)

Método chamado em uma linha de entrada quando o prefixo do comando não é reconhecido. Se esse método não for substituído, ele imprime uma mensagem de erro e retorna.
@end deffn

@geindex completedefault() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd completedefault}@anchor{32e4}
@deffn {Método} Cmd.completedefault (text, line, begidx, endidx)

Método chamado para completar uma linha de entrada quando nenhum método @code{complete_*()} especificado pelo comando está disponível. Por padrão, ele retorna uma lista vazia.
@end deffn

@geindex columnize() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd columnize}@anchor{1992}
@deffn {Método} Cmd.columnize (list, displaywidth=80)

Método chamado para exibir uma lista de strings como um conjunto compacto de colunas. Cada coluna tem apenas a largura necessária. As colunas são separadas por dois espaços para legibilidade.
@end deffn

@geindex precmd() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd precmd}@anchor{32e1}
@deffn {Método} Cmd.precmd (line)

Método gancho executado logo antes da linha de comando `line' ser interpretada, mas depois que o prompt de entrada é gerado e emitido. Este método é um stub em @ref{17b8,,Cmd}; ele existe para ser substituído por subclasses. O valor de retorno é usado como o comando que será executado pelo método @ref{32e0,,onecmd()}; a implementação @ref{32e1,,precmd()} pode reescrever o comando ou simplesmente retornar `line' inalterado.
@end deffn

@geindex postcmd() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd postcmd}@anchor{32df}
@deffn {Método} Cmd.postcmd (stop, line)

Método gancho executado logo após o término do despacho de um comando. Este método é um stub em @ref{17b8,,Cmd}; ele existe para ser substituído por subclasses. `line' é a linha de comando que foi executada, e `stop' é um sinalizador que indica se a execução será encerrada após a chamada para @ref{32df,,postcmd()}; este será o valor de retorno do método @ref{32e0,,onecmd()}. O valor de retorno deste método será usado como o novo valor para o sinalizador interno que corresponde a `stop'; retornar false fará com que a interpretação continue.
@end deffn

@geindex preloop() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd preloop}@anchor{32e5}
@deffn {Método} Cmd.preloop ()

Método gancho executado uma vez quando @ref{32dd,,cmdloop()} é chamado. Este método é um stub em @ref{17b8,,Cmd}; ele existe para ser substituído por subclasses.
@end deffn

@geindex postloop() (método cmd.Cmd)
@anchor{library/cmd cmd Cmd postloop}@anchor{32e6}
@deffn {Método} Cmd.postloop ()

Método gancho executado uma vez quando @ref{32dd,,cmdloop()} está para ser retornado. Este método é um stub em @ref{17b8,,Cmd}; ele existe para ser substituído por subclasses.
@end deffn

Instâncias das subclasses @ref{17b8,,Cmd} têm algumas variáveis de instância públicas:

@geindex prompt (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd prompt}@anchor{32e7}
@deffn {Atributo} Cmd.prompt

O prompt emitido para solicitar informações.
@end deffn

@geindex identchars (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd identchars}@anchor{32e8}
@deffn {Atributo} Cmd.identchars

A sequência de caracteres aceita para o prefixo do comando.
@end deffn

@geindex lastcmd (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd lastcmd}@anchor{32e9}
@deffn {Atributo} Cmd.lastcmd

O último prefixo de comando não vazio visto.
@end deffn

@geindex cmdqueue (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd cmdqueue}@anchor{32ea}
@deffn {Atributo} Cmd.cmdqueue

Uma lista de linhas de entrada enfileiradas. A lista cmdqueue é verificada em @ref{32dd,,cmdloop()} quando uma nova entrada é necessária; se não estiver vazia, seus elementos serão processados em ordem, como se tivessem sido inseridos no prompt.
@end deffn

@geindex intro (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd intro}@anchor{32de}
@deffn {Atributo} Cmd.intro

Uma string para emitir como uma introdução ou banner. Pode ser substituída dando ao método @ref{32dd,,cmdloop()} um argumento.
@end deffn

@geindex doc_header (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd doc_header}@anchor{32eb}
@deffn {Atributo} Cmd.doc_header

O cabeçalho a ser emitido se a saída de ajuda tiver uma seção para comandos documentados.
@end deffn

@geindex misc_header (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd misc_header}@anchor{32ec}
@deffn {Atributo} Cmd.misc_header

O cabeçalho a ser emitido se a saída de ajuda tiver uma seção para tópicos de ajuda diversos (ou seja, há métodos @code{help_*()} sem métodos @code{do_*()} correspondentes).
@end deffn

@geindex undoc_header (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd undoc_header}@anchor{32ed}
@deffn {Atributo} Cmd.undoc_header

O cabeçalho a ser emitido se a saída de ajuda tiver uma seção para comandos não documentados (ou seja, houver métodos @code{do_*()} sem métodos @code{help_*()} correspondentes).
@end deffn

@geindex ruler (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd ruler}@anchor{32ee}
@deffn {Atributo} Cmd.ruler

O caractere usado para desenhar linhas separadoras sob os cabeçalhos de mensagem de ajuda. Se estiver vazio, nenhuma linha de régua será desenhada. O padrão é @code{'='}.
@end deffn

@geindex use_rawinput (atributo cmd.Cmd)
@anchor{library/cmd cmd Cmd use_rawinput}@anchor{32da}
@deffn {Atributo} Cmd.use_rawinput

Um sinalizador, com padrão true. Se true, @ref{32dd,,cmdloop()} usa @ref{131b,,input()} para exibir um prompt e ler o próximo comando; se false, @ref{ae6,,sys.stdout.write()} e @ref{53d,,sys.stdin.readline()} são usados. (Isso significa que ao importar @ref{ba,,readline}, em sistemas que o suportam, o interpretador suportará automaticamente edição de linha no estilo @code{Emacs} e pressionamentos de teclas de histórico de comando.)
@end deffn

@node Exemplo do Cmd,,Objetos Cmd,cmd — Suporte para interpretadores de comando orientado a linhas
@anchor{library/cmd cmd-example}@anchor{32ef}@anchor{library/cmd id2}@anchor{32f0}
@subsubsection Exemplo do Cmd


O módulo @ref{19,,cmd} é útil principalmente para criar shells personalizados que permitem ao usuário trabalhar com um programa interativamente.

Esta seção apresenta um exemplo simples de como construir um shell em torno de alguns dos comandos do módulo @ref{101,,turtle}.

Comandos básicos do turtle, como @ref{32f1,,forward()}, são adicionados a uma subclasse de @ref{17b8,,Cmd} com o método chamado @code{do_forward()}. O argumento é convertido em um número e despachado para o módulo turtle. A docstring é usada no utilitário de ajuda fornecido pelo shell.

O exemplo também inclui um recurso básico de gravação e reprodução implementado com o método @ref{32e1,,precmd()} que é responsável por converter a entrada para minúsculas e gravar os comandos em um arquivo. O método @code{do_playback()} lê o arquivo e adiciona os comandos gravados ao @ref{32ea,,cmdqueue} para reprodução imediata:

@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

    # ----- comandos básicos do turtle -----
    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

    # ----- registra e reproduz -----
    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

Aqui está uma sessão de exemplo com o shell do turtle mostrando as funções de ajuda, usando linhas em branco para repetir comandos e o recurso simples de gravação e reprodução:

@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 Execução Concorrente,Comunicação em Rede e Interprocesso,Bibliotecas de interface de linha de comando,A Biblioteca Padrão do Python
@anchor{library/concurrency doc}@anchor{32f2}@anchor{library/concurrency concurrency}@anchor{32f3}@anchor{library/concurrency concurrent-execution}@anchor{32f4}@anchor{library/concurrency translation-repo}@anchor{32f5}
@section Execução Concorrente


Os módulos descritos neste capítulo fornecem suporte a execução simultânea de código. A escolha apropriada da ferramenta dependerá da tarefa a ser executada (CPU bound ou IO bound) e do estilo de desenvolvimento preferencial (multitarefa cooperativa orientada a eventos versus multitarefa preemptiva). Eis uma visão geral:

@menu
* threading — Paralelismo baseado em threads:: 
* multiprocessing — Paralelismo baseado em processo:: 
* multiprocessing.shared_memory — Memória compartilhada para acesso direto entre processos: multiprocessing shared_memory — Memória compartilhada para acesso direto entre processos. 
* O pacote concurrent:: 
* concurrent.futures — Launching parallel tasks: concurrent futures — Launching parallel tasks. 
* subprocess — Gerenciamento de subprocessos:: 
* sched — Agendador de eventos:: 
* queue — A synchronized queue class:: 
* contextvars — Variáveis de contexto:: 
* _thread— API de segmentação de baixo nível:: 

@end menu

@node threading — Paralelismo baseado em threads,multiprocessing — Paralelismo baseado em processo,,Execução Concorrente
@anchor{library/threading doc}@anchor{32f6}@anchor{library/threading module-threading}@anchor{ed}@anchor{library/threading threading-thread-based-parallelism}@anchor{32f7}
@subsection @code{threading} — Paralelismo baseado em threads


@geindex module; threading

`Código-fonte:' Lib/threading.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/threading.py}


__________________________________________________________________


Este módulo constrói interfaces de alto nível para threading usando o módulo @ref{2,,_thread}, de mais baixo nível.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@menu
* Introdução: Introdução<8>. 
* GIL and performance considerations:: 
* Referência: Referência<2>. 
* Using locks@comma{} conditions@comma{} and semaphores in the with statement: Using locks conditions and semaphores in the with statement. 

@end menu

@node Introdução<8>,GIL and performance considerations,,threading — Paralelismo baseado em threads
@anchor{library/threading introduction}@anchor{32f8}
@subsubsection Introdução


O módulo @code{threading} fornece uma maneira de executar múltiplas threads@footnote{https://en.wikipedia.org/wiki/Thread_(computing)} (unidades menores de um processo) simultaneamente dentro de um único processo. Ele permite a criação e o gerenciamento de threads, possibilitando a execução de tarefas em paralelo, compartilhando espaço de memória. Threads são particularmente úteis quando tarefas são limitadas por E/S, como operações de arquivo ou solicitações de rede, onde grande parte do tempo é gasto aguardando recursos externos.

Um caso de uso típico para @code{threading} inclui o gerenciamento de um conjunto de threads de trabalho que podem processar múltiplas tarefas simultaneamente. Aqui está um exemplo básico de criação e inicialização de threads usando @ref{953,,Thread}:

@example
import threading
import time

def crawl(link, delay=3):
    print(f"crawl started for @{link@}")
    time.sleep(delay)  # Blocking I/O (simulating a network request)
    print(f"crawl ended for @{link@}")

links = [
    "https://python.org",
    "https://docs.python.org",
    "https://peps.python.org",
]

# Start threads for each link
threads = []
for link in links:
    # Using `args` to pass positional arguments and `kwargs` for keyword arguments
    t = threading.Thread(target=crawl, args=(link,), kwargs=@{"delay": 2@})
    threads.append(t)

# Start each thread
for t in threads:
    t.start()

# Wait for all threads to finish
for t in threads:
    t.join()
@end example


Alterado na versão 3.7: Este módulo costumava ser opcional, agora está sempre disponível.



@subsubheading Ver também


@ref{742,,concurrent.futures.ThreadPoolExecutor} offers a higher level interface
to push tasks to a background thread without blocking execution of the
calling thread, while still being able to retrieve their results when needed.

@ref{b6,,queue} provides a thread-safe interface for exchanging data between
running threads.

@ref{a,,asyncio} offers an alternative approach to achieving task level
concurrency without requiring the use of multiple operating system threads.


@cartouche
@quotation Nota 
In the Python 2.x series, this module contained @code{camelCase} names
for some methods and functions. These are deprecated as of Python 3.10,
but they are still supported for compatibility with Python 2.5 and lower.
@end quotation
@end cartouche

`Detalhes da implementação do CPython:' In CPython, due to the @ref{148,,Global Interpreter Lock}, only one thread
can execute Python code at once (even though certain performance-oriented
libraries might overcome this limitation).
If you want your application to make better use of the computational
resources of multi-core machines, you are advised to use
@ref{94,,multiprocessing} or @ref{8f4,,concurrent.futures.ProcessPoolExecutor}.
However, threading is still an appropriate model if you want to run
multiple I/O-bound tasks simultaneously.

@node GIL and performance considerations,Referência<2>,Introdução<8>,threading — Paralelismo baseado em threads
@anchor{library/threading gil-and-performance-considerations}@anchor{32f9}
@subsubsection GIL and performance considerations


Unlike the @ref{94,,multiprocessing} module, which uses separate processes to
bypass the @ref{148,,global interpreter lock} (GIL), the threading module operates
within a single process, meaning that all threads share the same memory space.
However, the GIL limits the performance gains of threading when it comes to
CPU-bound tasks, as only one thread can execute Python bytecode at a time.
Despite this, threads remain a useful tool for achieving concurrency in many
scenarios.

As of Python 3.13, experimental @ref{15e4,,free-threaded} builds
can disable the GIL, enabling true parallel execution of threads, but this
feature is not available by default (see 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}).

@c TODO: At some point this feature will become available by default.

@node Referência<2>,Using locks conditions and semaphores in the with statement,GIL and performance considerations,threading — Paralelismo baseado em threads
@anchor{library/threading reference}@anchor{32fa}
@subsubsection Referência


Este módulo define as seguintes funções:

@geindex active_count() (no módulo threading)
@anchor{library/threading threading active_count}@anchor{30a}
@deffn {Função} threading.active_count ()

Retorna o número de objetos @ref{953,,Thread} atualmente ativos. A quantidade retornada é igual ao tamanho da lista retornada por @ref{19e5,,enumerate()}.

The function @code{activeCount} is a deprecated alias for this function.
@end deffn

@geindex current_thread() (no módulo threading)
@anchor{library/threading threading current_thread}@anchor{309}
@deffn {Função} threading.current_thread ()

Return the current @ref{953,,Thread} object, corresponding to the caller’s thread
of control.  If the caller’s thread of control was not created through the
@code{threading} module, a dummy thread object with limited functionality is
returned.

The function @code{currentThread} is a deprecated alias for this function.
@end deffn

@geindex excepthook() (no módulo threading)
@anchor{library/threading threading excepthook}@anchor{84e}
@deffn {Função} threading.excepthook (args, /)

Handle uncaught exception raised by @ref{a46,,Thread.run()}.

O argumento `args' tem os seguintes atributos:


@itemize *

@item 
`exc_type': Tipo de exceção..

@item 
`exc_value': Valor da exceção, pode ser @code{None}.

@item 
`exc_traceback': Pilha de execução da exceção, pode ser @code{None}.

@item 
`thread': Thread que levantou a exceção, pode ser @code{None}.
@end itemize

Se `exc_type' é @ref{d63,,SystemExit}, a exceção é silenciosamente ignorada. Caso contrário, a exceção é exibida em @ref{940,,sys.stderr}.

Se esta função levantar uma exceção, @ref{80e,,sys.excepthook()} é chamada para tratá-la.

@ref{84e,,threading.excepthook()} pode ser substituída para controlar como exceções não capturadas levantadas por @ref{a46,,Thread.run()} são tratadas.

Storing `exc_value' using a custom hook can create a reference cycle. It
should be cleared explicitly to break the reference cycle when the
exception is no longer needed.

Storing `thread' using a custom hook can resurrect it if it is set to an
object which is being finalized. Avoid storing `thread' after the custom
hook completes to avoid resurrecting objects.


@subsubheading Ver também


@ref{80e,,sys.excepthook()} trata exceções não capturadas.



Adicionado na versão 3.8.

@end deffn

@geindex __excepthook__ (no módulo threading)
@anchor{library/threading threading __excepthook__}@anchor{84d}
@deffn {Dado} threading.__excepthook__

Holds the original value of @ref{84e,,threading.excepthook()}. It is saved so that the
original value can be restored in case they happen to get replaced with
broken or alternative objects.


Adicionado na versão 3.10.

@end deffn

@geindex get_ident() (no módulo threading)
@anchor{library/threading threading get_ident}@anchor{1199}
@deffn {Função} threading.get_ident ()

Retorna o ‘identificador de thread’ do thread atual. Este é um número inteiro diferente de zero. Seu valor não tem significado direto; pretende-se que seja um cookie mágico para ser usado, por exemplo, para indexar um dicionário de dados específicos do thread. identificadores de thread podem ser reciclados quando um thread sai e outro é criado.


Adicionado na versão 3.3.

@end deffn

@geindex get_native_id() (no módulo threading)
@anchor{library/threading threading get_native_id}@anchor{a47}
@deffn {Função} threading.get_native_id ()

Retorna a ID de thread integral nativa da thread atual atribuída pelo kernel. Este é um número inteiro não negativo. Seu valor pode ser usado para identificar exclusivamente essa thread específica em todo o sistema (até que a thread termine, após o que o valor poderá ser reciclado pelo sistema operacional).

@ref{1ed8,,Disponibilidade}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Adicionado na versão 3.8.



Alterado na versão 3.13: Adicionado suporte a GNU/kFreeBSD.

@end deffn

@geindex enumerate() (no módulo threading)
@anchor{library/threading threading enumerate}@anchor{19e5}
@deffn {Função} threading.enumerate ()

Return a list of all @ref{953,,Thread} objects currently active.  The list
includes daemonic threads and dummy thread objects created by
@ref{309,,current_thread()}.  It excludes terminated threads and threads
that have not yet been started.  However, the main thread is always part
of the result, even when terminated.
@end deffn

@geindex main_thread() (no módulo threading)
@anchor{library/threading threading main_thread}@anchor{1008}
@deffn {Função} threading.main_thread ()

Return the main @ref{953,,Thread} object.  In normal conditions, the
main thread is the thread from which the Python interpreter was
started.


Adicionado na versão 3.4.

@end deffn

@geindex settrace() (no módulo threading)
@anchor{library/threading threading settrace}@anchor{84b}
@deffn {Função} threading.settrace (func)

@geindex função de rastreamento

Set a trace function for all threads started from the @code{threading} module.
The `func' will be passed to  @ref{1547,,sys.settrace()} for each thread, before its
@ref{a46,,run()} method is called.
@end deffn

@geindex settrace_all_threads() (no módulo threading)
@anchor{library/threading threading settrace_all_threads}@anchor{4c8}
@deffn {Função} threading.settrace_all_threads (func)

Set a trace function for all threads started from the @code{threading} module
and all Python threads that are currently executing.

The `func' will be passed to  @ref{1547,,sys.settrace()} for each thread, before its
@ref{a46,,run()} method is called.


Adicionado na versão 3.12.

@end deffn

@geindex gettrace() (no módulo threading)
@anchor{library/threading threading gettrace}@anchor{849}
@deffn {Função} threading.gettrace ()

@geindex função de rastreamento
@geindex depurador

Obtém a função trace conforme definido por @ref{84b,,settrace()}.


Adicionado na versão 3.10.

@end deffn

@geindex setprofile() (no módulo threading)
@anchor{library/threading threading setprofile}@anchor{84c}
@deffn {Função} threading.setprofile (func)

@geindex função de perfilação

Set a profile function for all threads started from the @code{threading} module.
The `func' will be passed to  @ref{1546,,sys.setprofile()} for each thread, before its
@ref{a46,,run()} method is called.
@end deffn

@geindex setprofile_all_threads() (no módulo threading)
@anchor{library/threading threading setprofile_all_threads}@anchor{4c9}
@deffn {Função} threading.setprofile_all_threads (func)

Set a profile function for all threads started from the @code{threading} module
and all Python threads that are currently executing.

The `func' will be passed to  @ref{1546,,sys.setprofile()} for each thread, before its
@ref{a46,,run()} method is called.


Adicionado na versão 3.12.

@end deffn

@geindex getprofile() (no módulo threading)
@anchor{library/threading threading getprofile}@anchor{84a}
@deffn {Função} threading.getprofile ()

@geindex função de perfilação

Obtém a função do criador de perfil conforme definido por @ref{84c,,setprofile()}.


Adicionado na versão 3.10.

@end deffn

@geindex stack_size() (no módulo threading)
@anchor{library/threading threading stack_size}@anchor{32fb}
@deffn {Função} threading.stack_size ([size])

Retorna o tamanho da pilha de threads usado ao criar novos threads. O argumento opcional `size' especifica o tamanho da pilha a ser usado para threads criados posteriormente e deve ser 0 (usar plataforma ou padrão configurado) ou um valor inteiro positivo de pelo menos 32.768 (32 KiB). Se `size' não for especificado, 0 será usado. Se a alteração do tamanho da pilha de threads não for suportada, uma @ref{195,,RuntimeError} será levantada. Se o tamanho da pilha especificado for inválido, uma @ref{202,,ValueError} será levantada e o tamanho da pilha não será modificado. Atualmente, 0 KiB é o valor mínimo de tamanho de pilha suportado para garantir espaço suficiente para o próprio interpretador. Observe que algumas plataformas podem ter restrições específicas sobre valores para o tamanho da pilha, como exigir um tamanho mínimo de pilha > 32 KiB ou exigir alocação em múltiplos do tamanho da página de memória do sistema – a documentação da plataforma deve ser consultada para obter mais informações (4 páginas KiB são comuns; usar múltiplos de 4096 para o tamanho da pilha é a abordagem sugerida na ausência de informações mais específicas).

@ref{1ed8,,Disponibilidade}: Windows, pthreads.

Plataformas Unix com suporte a threads POSIX.
@end deffn

This module also defines the following constant:

@geindex TIMEOUT_MAX (no módulo threading)
@anchor{library/threading threading TIMEOUT_MAX}@anchor{32fc}
@deffn {Dado} threading.TIMEOUT_MAX

The maximum value allowed for the `timeout' parameter of blocking functions
(@ref{698,,Lock.acquire()}, @ref{eaa,,RLock.acquire()}, @ref{19f1,,Condition.wait()}, etc.).
Specifying a timeout greater than this value will raise an
@ref{885,,OverflowError}.


Adicionado na versão 3.2.

@end deffn

This module defines a number of classes, which are detailed in the sections
below.

The design of this module is loosely based on Java’s threading model. However,
where Java makes locks and condition variables basic behavior of every object,
they are separate objects in Python.  Python’s @ref{953,,Thread} class supports a
subset of the behavior of Java’s Thread class; currently, there are no
priorities, no thread groups, and threads cannot be destroyed, stopped,
suspended, resumed, or interrupted.  The static methods of Java’s Thread class,
when implemented, are mapped to module-level functions.

All of the methods described below are executed atomically.

@menu
* Thread-local data:: 
* Thread objects:: 
* Lock objects:: 
* RLock objects:: 
* Condition objects:: 
* Semaphore objects:: 
* Semaphore example:: 
* Event objects:: 
* Timer objects:: 
* Barrier objects:: 

@end menu

@node Thread-local data,Thread objects,,Referência<2>
@anchor{library/threading thread-local-data}@anchor{32fd}
@subsubsection Thread-local data


Thread-local data is data whose values are thread specific. If you
have data that you want to be local to a thread, create a
@ref{1631,,local} object and use its attributes:

@example
>>> mydata = local()
>>> mydata.number = 42
>>> mydata.number
42
@end example

You can also access the @ref{1631,,local}-object’s dictionary:

@example
>>> mydata.__dict__
@{'number': 42@}
>>> mydata.__dict__.setdefault('widgets', [])
[]
>>> mydata.widgets
[]
@end example

If we access the data in a different thread:

@example
>>> log = []
>>> def f():
...     items = sorted(mydata.__dict__.items())
...     log.append(items)
...     mydata.number = 11
...     log.append(mydata.number)

>>> import threading
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[], 11]
@end example

we get different data.  Furthermore, changes made in the other thread
don’t affect data seen in this thread:

@example
>>> mydata.number
42
@end example

Of course, values you get from a @ref{1631,,local} object, including their
@ref{55b,,__dict__} attribute, are for whatever thread was current
at the time the attribute was read.  For that reason, you generally
don’t want to save these values across threads, as they apply only to
the thread they came from.

You can create custom @ref{1631,,local} objects by subclassing the
@ref{1631,,local} class:

@example
>>> class MyLocal(local):
...     number = 2
...     def __init__(self, /, **kw):
...         self.__dict__.update(kw)
...     def squared(self):
...         return self.number ** 2
@end example

This can be useful to support default values, methods and
initialization.  Note that if you define an @ref{6b0,,__init__()}
method, it will be called each time the @ref{1631,,local} object is used
in a separate thread.  This is necessary to initialize each thread’s
dictionary.

Now if we create a @ref{1631,,local} object:

@example
>>> mydata = MyLocal(color='red')
@end example

we have a default number:

@example
>>> mydata.number
2
@end example

an initial color:

@example
>>> mydata.color
'red'
>>> del mydata.color
@end example

And a method that operates on the data:

@example
>>> mydata.squared()
4
@end example

As before, we can access the data in a separate thread:

@example
>>> log = []
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[('color', 'red')], 11]
@end example

without affecting this thread’s data:

@example
>>> mydata.number
2
>>> mydata.color
Traceback (most recent call last):
...
AttributeError: 'MyLocal' object has no attribute 'color'
@end example

Note that subclasses can define @ref{5df,,__slots__}, but they are not
thread local. They are shared across threads:

@example
>>> class MyLocal(local):
...     __slots__ = 'number'

>>> mydata = MyLocal()
>>> mydata.number = 42
>>> mydata.color = 'red'
@end example

So, the separate thread:

@example
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
@end example

affects what we see:

@example
>>> mydata.number
11
@end example

@geindex local (classe em threading)
@anchor{library/threading threading local}@anchor{1631}
@deffn {Classe} threading.local

A class that represents thread-local data.
@end deffn

@node Thread objects,Lock objects,Thread-local data,Referência<2>
@anchor{library/threading id1}@anchor{32fe}@anchor{library/threading thread-objects}@anchor{32ff}
@subsubsection Thread objects


The @ref{953,,Thread} class represents an activity that is run in a separate
thread of control.  There are two ways to specify the activity: by passing a
callable object to the constructor, or by overriding the @ref{a46,,run()}
method in a subclass.  No other methods (except for the constructor) should be
overridden in a subclass.  In other words, `only'  override the
@code{__init__()} and @ref{a46,,run()} methods of this class.

Once a thread object is created, its activity must be started by calling the
thread’s @ref{2e90,,start()} method.  This invokes the @ref{a46,,run()}
method in a separate thread of control.

Once the thread’s activity is started, the thread is considered ‘alive’. It
stops being alive when its @ref{a46,,run()} method terminates – either
normally, or by raising an unhandled exception.  The @ref{954,,is_alive()}
method tests whether the thread is alive.

Other threads can call a thread’s @ref{1224,,join()} method.  This blocks
the calling thread until the thread whose @ref{1224,,join()} method is
called is terminated.

A thread has a name.  The name can be passed to the constructor, and read or
changed through the @ref{308,,name} attribute.

If the @ref{a46,,run()} method raises an exception,
@ref{84e,,threading.excepthook()} is called to handle it. By default,
@ref{84e,,threading.excepthook()} ignores silently @ref{d63,,SystemExit}.

A thread can be flagged as a “daemon thread”.  The significance of this flag is
that the entire Python program exits when only daemon threads are left.  The
initial value is inherited from the creating thread.  The flag can be set
through the @ref{306,,daemon} property or the `daemon' constructor
argument.

@cartouche
@quotation Nota 
Daemon threads are abruptly stopped at shutdown.  Their resources (such
as open files, database transactions, etc.) may not be released properly.
If you want your threads to stop gracefully, make them non-daemonic and
use a suitable signalling mechanism such as an @ref{1197,,Event}.
@end quotation
@end cartouche

There is a “main thread” object; this corresponds to the initial thread of
control in the Python program.  It is not a daemon thread.

There is the possibility that “dummy thread objects” are created. These are
thread objects corresponding to “alien threads”, which are threads of control
started outside the threading module, such as directly from C code.  Dummy
thread objects have limited functionality; they are always considered alive and
daemonic, and cannot be @ref{3300,,joined}.  They are never deleted,
since it is impossible to detect the termination of alien threads.

@geindex Thread (classe em threading)
@anchor{library/threading threading Thread}@anchor{953}
@deffn {Classe} threading.Thread (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None)

This constructor should always be called with keyword arguments.  Arguments
are:

`group' should be @code{None}; reserved for future extension when a
@code{ThreadGroup} class is implemented.

`target' is the callable object to be invoked by the @ref{a46,,run()} method.
Defaults to @code{None}, meaning nothing is called.

`name' is the thread name. By default, a unique name is constructed
of the form “Thread-`N'” where `N' is a small decimal number,
or “Thread-`N' (target)” where “target” is @code{target.__name__} if the
`target' argument is specified.

`args' is a list or tuple of arguments for the target invocation.  Defaults to @code{()}.

`kwargs' is a dictionary of keyword arguments for the target invocation.
Defaults to @code{@{@}}.

If not @code{None}, `daemon' explicitly sets whether the thread is daemonic.
If @code{None} (the default), the daemonic property is inherited from the
current thread.

If the subclass overrides the constructor, it must make sure to invoke the
base class constructor (@code{Thread.__init__()}) before doing anything else to
the thread.


Alterado na versão 3.3: Adicionado o parâmetro `daemon'.



Alterado na versão 3.10: Use the `target' name if `name' argument is omitted.


@geindex start() (método threading.Thread)
@anchor{library/threading threading Thread start}@anchor{2e90}
@deffn {Método} start ()

Start the thread’s activity.

It must be called at most once per thread object.  It arranges for the
object’s @ref{a46,,run()} method to be invoked in a separate thread
of control.

This method will raise a @ref{195,,RuntimeError} if called more than once
on the same thread object.
@end deffn

@geindex run() (método threading.Thread)
@anchor{library/threading threading Thread run}@anchor{a46}
@deffn {Método} run ()

Method representing the thread’s activity.

You may override this method in a subclass.  The standard @ref{a46,,run()}
method invokes the callable object passed to the object’s constructor as
the `target' argument, if any, with positional and keyword arguments taken
from the `args' and `kwargs' arguments, respectively.

Using list or tuple as the `args' argument which passed to the @ref{953,,Thread}
could achieve the same effect.

Exemplo:

@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 threading.Thread)
@anchor{library/threading meth-thread-join}@anchor{3300}@anchor{library/threading threading Thread join}@anchor{1224}
@deffn {Método} join (timeout=None)

Wait until the thread terminates. This blocks the calling thread until
the thread whose @ref{1224,,join()} method is called terminates – either
normally or through an unhandled exception – or until the optional
timeout occurs.

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{1224,,join()} always returns @code{None},
you must call @ref{954,,is_alive()} after @ref{1224,,join()} to
decide whether a timeout happened – if the thread is still alive, the
@ref{1224,,join()} call timed out.

When the `timeout' argument is not present or @code{None}, the operation will
block until the thread terminates.

A thread can be joined many times.

@ref{1224,,join()} raises a @ref{195,,RuntimeError} if an attempt is made
to join the current thread as that would cause a deadlock. It is also
an error to @ref{1224,,join()} a thread before it has been started
and attempts to do so raise the same exception.
@end deffn

@geindex name (atributo threading.Thread)
@anchor{library/threading threading Thread name}@anchor{308}
@deffn {Atributo} name

A string used for identification purposes only. It has no semantics.
Multiple threads may be given the same name.  The initial name is set by
the constructor.
@end deffn

@geindex getName() (método threading.Thread)
@geindex setName() (método threading.Thread)
@anchor{library/threading threading Thread getName}@anchor{3301}
@deffn {Método} getName ()
@anchor{library/threading threading Thread setName}@anchor{307}
@deffnx {Método} setName ()

Deprecated getter/setter API for @ref{308,,name}; use it directly as a
property instead.


Descontinuado desde a versão 3.10.

@end deffn

@geindex ident (atributo threading.Thread)
@anchor{library/threading threading Thread ident}@anchor{2e16}
@deffn {Atributo} ident

The ‘thread identifier’ of this thread or @code{None} if the thread has not
been started.  This is a nonzero integer.  See the @ref{1199,,get_ident()}
function.  Thread identifiers may be recycled when a thread exits and
another thread is created.  The identifier is available even after the
thread has exited.
@end deffn

@geindex native_id (atributo threading.Thread)
@anchor{library/threading threading Thread native_id}@anchor{a48}
@deffn {Atributo} native_id

The Thread ID (@code{TID}) of this thread, as assigned by the OS (kernel).
This is a non-negative integer, or @code{None} if the thread has not
been started. See the @ref{a47,,get_native_id()} function.
This value may be used to uniquely identify this particular thread
system-wide (until the thread terminates, after which the value
may be recycled by the OS).

@cartouche
@quotation Nota 
Similar to Process IDs, Thread IDs are only valid (guaranteed unique
system-wide) from the time the thread is created until the thread
has been terminated.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD.


Adicionado na versão 3.8.

@end deffn

@geindex is_alive() (método threading.Thread)
@anchor{library/threading threading Thread is_alive}@anchor{954}
@deffn {Método} is_alive ()

Return whether the thread is alive.

This method returns @code{True} just before the @ref{a46,,run()} method
starts until just after the @ref{a46,,run()} method terminates.  The
module function @ref{19e5,,enumerate()} returns a list of all alive threads.
@end deffn

@geindex daemon (atributo threading.Thread)
@anchor{library/threading threading Thread daemon}@anchor{306}
@deffn {Atributo} daemon

A boolean value indicating whether this thread is a daemon thread (@code{True})
or not (@code{False}).  This must be set before @ref{2e90,,start()} is called,
otherwise @ref{195,,RuntimeError} is raised.  Its initial value is inherited
from the creating thread; the main thread is not a daemon thread and
therefore all threads created in the main thread default to
@ref{306,,daemon} = @code{False}.

The entire Python program exits when no alive non-daemon threads are left.
@end deffn

@geindex isDaemon() (método threading.Thread)
@geindex setDaemon() (método threading.Thread)
@anchor{library/threading threading Thread isDaemon}@anchor{3302}
@deffn {Método} isDaemon ()
@anchor{library/threading threading Thread setDaemon}@anchor{305}
@deffnx {Método} setDaemon ()

Deprecated getter/setter API for @ref{306,,daemon}; use it directly as a
property instead.


Descontinuado desde a versão 3.10.

@end deffn
@end deffn

@node Lock objects,RLock objects,Thread objects,Referência<2>
@anchor{library/threading id2}@anchor{3303}@anchor{library/threading lock-objects}@anchor{3304}
@subsubsection Lock objects


A primitive lock is a synchronization primitive that is not owned by a
particular thread when locked.  In Python, it is currently the lowest level
synchronization primitive available, implemented directly by the @ref{2,,_thread}
extension module.

A primitive lock is in one of two states, “locked” or “unlocked”. It is created
in the unlocked state.  It has two basic methods, @ref{698,,acquire()} and
@ref{1305,,release()}.  When the state is unlocked, @ref{698,,acquire()}
changes the state to locked and returns immediately.  When the state is locked,
@ref{698,,acquire()} blocks until a call to @ref{1305,,release()} in another
thread changes it to unlocked, then the @ref{698,,acquire()} call resets it
to locked and returns.  The @ref{1305,,release()} method should only be
called in the locked state; it changes the state to unlocked and returns
immediately. If an attempt is made to release an unlocked lock, a
@ref{195,,RuntimeError} will be raised.

Locks also support the @ref{3305,,context management protocol}.

When more than one thread is blocked in @ref{698,,acquire()} waiting for the
state to turn to unlocked, only one thread proceeds when a @ref{1305,,release()}
call resets the state to unlocked; which one of the waiting threads proceeds
is not defined, and may vary across implementations.

All methods are executed atomically.

@geindex Lock (classe em threading)
@anchor{library/threading threading Lock}@anchor{176d}
@deffn {Classe} threading.Lock

The class implementing primitive lock objects.  Once a thread has acquired a
lock, subsequent attempts to acquire it block, until it is released; any
thread may release it.


Alterado na versão 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 threading.Lock)
@anchor{library/threading threading Lock acquire}@anchor{698}
@deffn {Método} acquire (blocking=True, timeout=-1)

Adquire uma trava, bloqueante ou não.

When invoked with the `blocking' argument set to @code{True} (the default),
block until the lock is unlocked, then set it to locked and return @code{True}.

When invoked with the `blocking' argument set to @code{False}, do not block.
If a call with `blocking' set to @code{True} would block, return @code{False}
immediately; otherwise, set the lock to locked and return @code{True}.

When invoked with the floating-point `timeout' argument set to a positive
value, block for at most the number of seconds specified by `timeout'
and as long as the lock cannot be acquired.  A `timeout' argument of @code{-1}
specifies an unbounded wait.  It is forbidden to specify a `timeout'
when `blocking' is @code{False}.

The return value is @code{True} if the lock is acquired successfully,
@code{False} if not (for example if the `timeout' expired).


Alterado na versão 3.2: O parâmetro `timeout' é novo.



Alterado na versão 3.2: Lock acquisition can now be interrupted by signals on POSIX if the
underlying threading implementation supports it.

@end deffn

@geindex release() (método threading.Lock)
@anchor{library/threading threading Lock release}@anchor{1305}
@deffn {Método} release ()

Release a lock.  This can be called from any thread, not only the thread
which has acquired the lock.

When the lock is locked, reset it to unlocked, and return.  If any other threads
are blocked waiting for the lock to become unlocked, allow exactly one of them
to proceed.

When invoked on an unlocked lock, a @ref{195,,RuntimeError} is raised.

There is no return value.
@end deffn

@geindex locked() (método threading.Lock)
@anchor{library/threading threading Lock locked}@anchor{3306}
@deffn {Método} locked ()

Return @code{True} if the lock is acquired.
@end deffn
@end deffn

@node RLock objects,Condition objects,Lock objects,Referência<2>
@anchor{library/threading id3}@anchor{3307}@anchor{library/threading rlock-objects}@anchor{3308}
@subsubsection RLock objects


A reentrant lock is a synchronization primitive that may be acquired multiple
times by the same thread.  Internally, it uses the concepts of “owning thread”
and “recursion level” in addition to the locked/unlocked state used by primitive
locks.  In the locked state, some thread owns the lock; in the unlocked state,
no thread owns it.

Threads call a lock’s @ref{eaa,,acquire()} method to lock it,
and its @ref{1305,,release()} method to unlock it.

@cartouche
@quotation Nota 
Reentrant locks support the @ref{3305,,context management protocol},
so it is recommended to use @ref{5d2,,with} instead of manually calling
@ref{eaa,,acquire()} and @ref{3309,,release()}
to handle acquiring and releasing the lock for a block of code.
@end quotation
@end cartouche

RLock’s @ref{eaa,,acquire()}/@ref{3309,,release()} call pairs may be nested,
unlike Lock’s @ref{698,,acquire()}/@ref{1305,,release()}. Only the final
@ref{3309,,release()} (the @ref{1305,,release()} of the outermost pair) resets
the lock to an unlocked state and allows another thread blocked in
@ref{eaa,,acquire()} to proceed.

@ref{eaa,,acquire()}/@ref{3309,,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 (classe em threading)
@anchor{library/threading threading RLock}@anchor{2de}
@deffn {Classe} threading.RLock

This class implements reentrant lock objects.  A reentrant lock must be
released by the thread that acquired it.  Once a thread has acquired a
reentrant lock, the same thread may acquire it again without blocking; the
thread must release it once for each time it has acquired it.

Note that @code{RLock} is actually a factory function which returns an instance
of the most efficient version of the concrete RLock class that is supported
by the platform.

@geindex acquire() (método threading.RLock)
@anchor{library/threading threading RLock acquire}@anchor{eaa}
@deffn {Método} acquire (blocking=True, timeout=-1)

Adquire uma trava, bloqueante ou não.


@subsubheading Ver também



@table @asis

@item @ref{3305,,Using RLock as a context manager}

Recommended over manual @code{acquire()} and @ref{3309,,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{176d,,Lock} and
@code{RLock}; @ref{176d,,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{3309,,release()} as many times
may lead to deadlock. Consider using @code{RLock} as a context manager rather than
calling acquire/release directly.


Alterado na versão 3.2: O parâmetro `timeout' é novo.

@end deffn

@geindex release() (método threading.RLock)
@anchor{library/threading threading RLock release}@anchor{3309}
@deffn {Método} release ()

Release a lock, decrementing the recursion level.  If after the decrement it is
zero, reset the lock to unlocked (not owned by any thread), and if any other
threads are blocked waiting for the lock to become unlocked, allow exactly one
of them to proceed.  If after the decrement the recursion level is still
nonzero, the lock remains locked and owned by the calling thread.

Only call this method when the calling thread owns the lock. A
@ref{195,,RuntimeError} is raised if this method is called when the lock is
not acquired.

There is no return value.
@end deffn
@end deffn

@node Condition objects,Semaphore objects,RLock objects,Referência<2>
@anchor{library/threading condition-objects}@anchor{330a}@anchor{library/threading id4}@anchor{330b}
@subsubsection Condition objects


A condition variable is always associated with some kind of lock; this can be
passed in or one will be created by default.  Passing one in is useful when
several condition variables must share the same lock.  The lock is part of
the condition object: you don’t have to track it separately.

A condition variable obeys the @ref{3305,,context management protocol}:
using the @code{with} statement acquires the associated lock for the duration of
the enclosed block.  The @ref{330c,,acquire()} and
@ref{330d,,release()} methods also call the corresponding methods of
the associated lock.

Other methods must be called with the associated lock held.  The
@ref{19f1,,wait()} method releases the lock, and then blocks until
another thread awakens it by calling @ref{18f1,,notify()} or
@ref{303,,notify_all()}.  Once awakened, @ref{19f1,,wait()}
re-acquires the lock and returns.  It is also possible to specify a timeout.

The @ref{18f1,,notify()} method wakes up one of the threads waiting for
the condition variable, if any are waiting.  The @ref{303,,notify_all()}
method wakes up all threads waiting for the condition variable.

Note: the @ref{18f1,,notify()} and @ref{303,,notify_all()} methods
don’t release the lock; this means that the thread or threads awakened will
not return from their @ref{19f1,,wait()} call immediately, but only when
the thread that called @ref{18f1,,notify()} or @ref{303,,notify_all()}
finally relinquishes ownership of the lock.

The typical programming style using condition variables uses the lock to
synchronize access to some shared state; threads that are interested in a
particular change of state call @ref{19f1,,wait()} repeatedly until they
see the desired state, while threads that modify the state call
@ref{18f1,,notify()} or @ref{303,,notify_all()} when they change
the state in such a way that it could possibly be a desired state for one
of the waiters.  For example, the following code is a generic
producer-consumer situation with unlimited buffer capacity:

@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

The @code{while} loop checking for the application’s condition is necessary
because @ref{19f1,,wait()} can return after an arbitrary long time,
and the condition which prompted the @ref{18f1,,notify()} call may
no longer hold true.  This is inherent to multi-threaded programming.  The
@ref{330e,,wait_for()} method can be used to automate the condition
checking, and eases the computation of timeouts:

@example
# Consume an item
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()
@end example

To choose between @ref{18f1,,notify()} and @ref{303,,notify_all()},
consider whether one state change can be interesting for only one or several
waiting threads.  E.g. in a typical producer-consumer situation, adding one
item to the buffer only needs to wake up one consumer thread.

@geindex Condition (classe em threading)
@anchor{library/threading threading Condition}@anchor{1194}
@deffn {Classe} threading.Condition (lock=None)

This class implements condition variable objects.  A condition variable
allows one or more threads to wait until they are notified by another thread.

If the `lock' argument is given and not @code{None}, it must be a @ref{176d,,Lock}
or @ref{2de,,RLock} object, and it is used as the underlying lock.  Otherwise,
a new @ref{2de,,RLock} object is created and used as the underlying lock.


Alterado na versão 3.3: changed from a factory function to a class.


@geindex acquire() (método threading.Condition)
@anchor{library/threading threading Condition acquire}@anchor{330c}
@deffn {Método} acquire (*args)

Acquire the underlying lock. This method calls the corresponding method on
the underlying lock; the return value is whatever that method returns.
@end deffn

@geindex release() (método threading.Condition)
@anchor{library/threading threading Condition release}@anchor{330d}
@deffn {Método} release ()

Release the underlying lock. This method calls the corresponding method on
the underlying lock; there is no return value.
@end deffn

@geindex wait() (método threading.Condition)
@anchor{library/threading threading Condition wait}@anchor{19f1}
@deffn {Método} wait (timeout=None)

Wait until notified or until a timeout occurs. If the calling thread has
not acquired the lock when this method is called, a @ref{195,,RuntimeError} is
raised.

This method releases the underlying lock, and then blocks until it is
awakened by a @ref{18f1,,notify()} or @ref{303,,notify_all()} call for the same
condition variable in another thread, or until the optional timeout
occurs.  Once awakened or timed out, it re-acquires the lock and returns.

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

When the underlying lock is an @ref{2de,,RLock}, it is not released using
its @ref{330d,,release()} method, since this may not actually unlock the lock
when it was acquired multiple times recursively.  Instead, an internal
interface of the @ref{2de,,RLock} class is used, which really unlocks it
even when it has been recursively acquired several times. Another internal
interface is then used to restore the recursion level when the lock is
reacquired.

O valor de retorno é @code{True} exceto se um dado `timout' expire, no caso em que é @code{False}.


Alterado na versão 3.2: Previously, the method always returned @code{None}.

@end deffn

@geindex wait_for() (método threading.Condition)
@anchor{library/threading threading Condition wait_for}@anchor{330e}
@deffn {Método} wait_for (predicate, timeout=None)

Wait until a condition evaluates to true.  `predicate' should be a
callable which result will be interpreted as a boolean value.
A `timeout' may be provided giving the maximum time to wait.

This utility method may call @ref{19f1,,wait()} repeatedly until the predicate
is satisfied, or until a timeout occurs. The return value is
the last return value of the predicate and will evaluate to
@code{False} if the method timed out.

Ignoring the timeout feature, calling this method is roughly equivalent to
writing:

@example
while not predicate():
    cv.wait()
@end example

Therefore, the same rules apply as with @ref{19f1,,wait()}: The lock must be
held when called and is re-acquired on return.  The predicate is evaluated
with the lock held.


Adicionado na versão 3.2.

@end deffn

@geindex notify() (método threading.Condition)
@anchor{library/threading threading Condition notify}@anchor{18f1}
@deffn {Método} notify (n=1)

By default, wake up one thread waiting on this condition, if any.  If the
calling thread has not acquired the lock when this method is called, a
@ref{195,,RuntimeError} is raised.

This method wakes up at most `n' of the threads waiting for the condition
variable; it is a no-op if no threads are waiting.

The current implementation wakes up exactly `n' threads, if at least `n'
threads are waiting.  However, it’s not safe to rely on this behavior.
A future, optimized implementation may occasionally wake up more than
`n' threads.

Note: an awakened thread does not actually return from its @ref{19f1,,wait()}
call until it can reacquire the lock.  Since @ref{18f1,,notify()} does not
release the lock, its caller should.
@end deffn

@geindex notify_all() (método threading.Condition)
@anchor{library/threading threading Condition notify_all}@anchor{303}
@deffn {Método} notify_all ()

Wake up all threads waiting on this condition.  This method acts like
@ref{18f1,,notify()}, but wakes up all waiting threads instead of one. If the
calling thread has not acquired the lock when this method is called, a
@ref{195,,RuntimeError} is raised.

The method @code{notifyAll} is a deprecated alias for this method.
@end deffn
@end deffn

@node Semaphore objects,Semaphore example,Condition objects,Referência<2>
@anchor{library/threading id5}@anchor{330f}@anchor{library/threading semaphore-objects}@anchor{3310}
@subsubsection Semaphore objects


This is one of the oldest synchronization primitives in the history of computer
science, invented by the early Dutch computer scientist Edsger W. Dijkstra (he
used the names @code{P()} and @code{V()} instead of @ref{1295,,acquire()} and
@ref{3311,,release()}).

A semaphore manages an internal counter which is decremented by each
@ref{1295,,acquire()} call and incremented by each @ref{3311,,release()}
call.  The counter can never go below zero; when @ref{1295,,acquire()}
finds that it is zero, it blocks, waiting until some other thread calls
@ref{3311,,release()}.

Semaphores also support the @ref{3305,,context management protocol}.

@geindex Semaphore (classe em threading)
@anchor{library/threading threading Semaphore}@anchor{1195}
@deffn {Classe} threading.Semaphore (value=1)

This class implements semaphore objects.  A semaphore manages an atomic
counter representing the number of @ref{3311,,release()} calls minus the number of
@ref{1295,,acquire()} calls, plus an initial value.  The @ref{1295,,acquire()} method
blocks if necessary until it can return without making the counter negative.
If not given, `value' defaults to 1.

The optional argument gives the initial `value' for the internal counter; it
defaults to @code{1}. If the `value' given is less than 0, @ref{202,,ValueError} is
raised.


Alterado na versão 3.3: changed from a factory function to a class.


@geindex acquire() (método threading.Semaphore)
@anchor{library/threading threading Semaphore acquire}@anchor{1295}
@deffn {Método} acquire (blocking=True, timeout=None)

Acquire a semaphore.

When invoked without arguments:


@itemize *

@item 
If the internal counter is larger than zero on entry, decrement it by
one and return @code{True} immediately.

@item 
If the internal counter is zero on entry, block until awoken by a call to
@ref{3311,,release()}.  Once awoken (and the counter is greater
than 0), decrement the counter by 1 and return @code{True}.  Exactly one
thread will be awoken by each call to @ref{3311,,release()}.  The
order in which threads are awoken should not be relied on.
@end itemize

When invoked with `blocking' set to @code{False}, do not block.  If a call
without an argument would block, return @code{False} immediately; otherwise, do
the same thing as when called without arguments, and return @code{True}.

When invoked with a `timeout' other than @code{None}, it will block for at
most `timeout' seconds.  If acquire does not complete successfully in
that interval, return @code{False}.  Return @code{True} otherwise.


Alterado na versão 3.2: O parâmetro `timeout' é novo.

@end deffn

@geindex release() (método threading.Semaphore)
@anchor{library/threading threading Semaphore release}@anchor{3311}
@deffn {Método} release (n=1)

Release a semaphore, incrementing the internal counter by `n'.  When it
was zero on entry and other threads are waiting for it to become larger
than zero again, wake up `n' of those threads.


Alterado na versão 3.9: Added the `n' parameter to release multiple waiting threads at once.

@end deffn
@end deffn

@geindex BoundedSemaphore (classe em threading)
@anchor{library/threading threading BoundedSemaphore}@anchor{1196}
@deffn {Classe} threading.BoundedSemaphore (value=1)

Class implementing bounded semaphore objects.  A bounded semaphore checks to
make sure its current value doesn’t exceed its initial value.  If it does,
@ref{202,,ValueError} is raised. In most situations semaphores are used to guard
resources with limited capacity.  If the semaphore is released too many times
it’s a sign of a bug.  If not given, `value' defaults to 1.


Alterado na versão 3.3: changed from a factory function to a class.

@end deffn

@node Semaphore example,Event objects,Semaphore objects,Referência<2>
@anchor{library/threading semaphore-example}@anchor{3312}@anchor{library/threading semaphore-examples}@anchor{3313}
@subsubsection @code{Semaphore} example


Semaphores are often used to guard resources with limited capacity, for example,
a database server.  In any situation where the size of the resource is fixed,
you should use a bounded semaphore.  Before spawning any worker threads, your
main thread would initialize the semaphore:

@example
maxconnections = 5
# ...
pool_sema = BoundedSemaphore(value=maxconnections)
@end example

Once spawned, worker threads call the semaphore’s acquire and release methods
when they need to connect to the server:

@example
with pool_sema:
    conn = connectdb()
    try:
        # ... use connection ...
    finally:
        conn.close()
@end example

The use of a bounded semaphore reduces the chance that a programming error which
causes the semaphore to be released more than it’s acquired will go undetected.

@node Event objects,Timer objects,Semaphore example,Referência<2>
@anchor{library/threading event-objects}@anchor{3314}@anchor{library/threading id6}@anchor{3315}
@subsubsection Event objects


This is one of the simplest mechanisms for communication between threads: one
thread signals an event and other threads wait for it.

An event object manages an internal flag that can be set to true with the
@ref{3316,,set()} method and reset to false with the @ref{3317,,clear()}
method.  The @ref{136b,,wait()} method blocks until the flag is true.

@geindex Event (classe em threading)
@anchor{library/threading threading Event}@anchor{1197}
@deffn {Classe} threading.Event

Class implementing event objects.  An event manages a flag that can be set to
true with the @ref{3316,,set()} method and reset to false with the
@ref{3317,,clear()} method.  The @ref{136b,,wait()} method blocks until the flag is true.
The flag is initially false.


Alterado na versão 3.3: changed from a factory function to a class.


@geindex is_set() (método threading.Event)
@anchor{library/threading threading Event is_set}@anchor{304}
@deffn {Método} is_set ()

Return @code{True} if and only if the internal flag is true.

The method @code{isSet} is a deprecated alias for this method.
@end deffn

@geindex set() (método threading.Event)
@anchor{library/threading threading Event set}@anchor{3316}
@deffn {Método} set ()

Set the internal flag to true. All threads waiting for it to become true
are awakened. Threads that call @ref{136b,,wait()} once the flag is true will
not block at all.
@end deffn

@geindex clear() (método threading.Event)
@anchor{library/threading threading Event clear}@anchor{3317}
@deffn {Método} clear ()

Reset the internal flag to false. Subsequently, threads calling
@ref{136b,,wait()} will block until @ref{3316,,set()} is called to set the internal
flag to true again.
@end deffn

@geindex wait() (método threading.Event)
@anchor{library/threading threading Event wait}@anchor{136b}
@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.


Alterado na versão 3.1: Previously, the method always returned @code{None}.

@end deffn
@end deffn

@node Timer objects,Barrier objects,Event objects,Referência<2>
@anchor{library/threading id7}@anchor{3318}@anchor{library/threading timer-objects}@anchor{3319}
@subsubsection Timer objects


This class represents an action that should be run only after a certain amount
of time has passed — a timer.  @ref{1198,,Timer} is a subclass of @ref{953,,Thread}
and as such also functions as an example of creating custom threads.

Timers are started, as with threads, by calling their @ref{2e90,,Timer.start}
method.  The timer can be stopped (before its action has begun) by calling the
@ref{331a,,cancel()} method.  The interval the timer will wait before
executing its action may not be exactly the same as the interval specified by
the user.

Por exemplo:

@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 (classe em threading)
@anchor{library/threading threading Timer}@anchor{1198}
@deffn {Classe} threading.Timer (interval, function, args=None, kwargs=None)

Create a timer that will run `function' with arguments `args' and  keyword
arguments `kwargs', after `interval' seconds have passed.
If `args' is @code{None} (the default) then an empty list will be used.
If `kwargs' is @code{None} (the default) then an empty dict will be used.


Alterado na versão 3.3: changed from a factory function to a class.


@geindex cancel() (método threading.Timer)
@anchor{library/threading threading Timer cancel}@anchor{331a}
@deffn {Método} cancel ()

Stop the timer, and cancel the execution of the timer’s action.  This will
only work if the timer is still in its waiting stage.
@end deffn
@end deffn

@node Barrier objects,,Timer objects,Referência<2>
@anchor{library/threading barrier-objects}@anchor{331b}
@subsubsection Barrier objects



Adicionado na versão 3.2.


This class provides a simple synchronization primitive for use by a fixed number
of threads that need to wait for each other.  Each of the threads tries to pass
the barrier by calling the @ref{331c,,wait()} method and will block until
all of the threads have made their @ref{331c,,wait()} calls. At this point,
the threads are released simultaneously.

The barrier can be reused any number of times for the same number of threads.

As an example, here is a simple way to synchronize a client and server thread:

@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 (classe em threading)
@anchor{library/threading threading Barrier}@anchor{1223}
@deffn {Classe} threading.Barrier (parties, action=None, timeout=None)

Create a barrier object for `parties' number of threads.  An `action', when
provided, is a callable to be called by one of the threads when they are
released.  `timeout' is the default timeout value if none is specified for
the @ref{331c,,wait()} method.

@geindex wait() (método threading.Barrier)
@anchor{library/threading threading Barrier wait}@anchor{331c}
@deffn {Método} wait (timeout=None)

Pass the barrier.  When all the threads party to the barrier have called
this function, they are all released simultaneously.  If a `timeout' is
provided, it is used in preference to any that was supplied to the class
constructor.

The return value is an integer in the range 0 to `parties' – 1, different
for each thread.  This can be used to select a thread to do some special
housekeeping, e.g.:

@example
i = barrier.wait()
if i == 0:
    # Only one thread needs to print this
    print("passed the barrier")
@end example

If an `action' was provided to the constructor, one of the threads will
have called it prior to being released.  Should this call raise an error,
the barrier is put into the broken state.

If the call times out, the barrier is put into the broken state.

This method may raise a @ref{1225,,BrokenBarrierError} exception if the
barrier is broken or reset while a thread is waiting.
@end deffn

@geindex reset() (método threading.Barrier)
@anchor{library/threading threading Barrier reset}@anchor{331d}
@deffn {Método} reset ()

Return the barrier to the default, empty state.  Any threads waiting on it
will receive the @ref{1225,,BrokenBarrierError} exception.

Note that using this function may require some external
synchronization if there are other threads whose state is unknown.  If a
barrier is broken it may be better to just leave it and create a new one.
@end deffn

@geindex abort() (método threading.Barrier)
@anchor{library/threading threading Barrier abort}@anchor{331e}
@deffn {Método} abort ()

Put the barrier into a broken state.  This causes any active or future
calls to @ref{331c,,wait()} to fail with the @ref{1225,,BrokenBarrierError}.  Use
this for example if one of the threads needs to abort, to avoid deadlocking the
application.

It may be preferable to simply create the barrier with a sensible
`timeout' value to automatically guard against one of the threads going
awry.
@end deffn

@geindex parties (atributo threading.Barrier)
@anchor{library/threading threading Barrier parties}@anchor{331f}
@deffn {Atributo} parties

The number of threads required to pass the barrier.
@end deffn

@geindex n_waiting (atributo threading.Barrier)
@anchor{library/threading threading Barrier n_waiting}@anchor{3320}
@deffn {Atributo} n_waiting

The number of threads currently waiting in the barrier.
@end deffn

@geindex broken (atributo threading.Barrier)
@anchor{library/threading threading Barrier broken}@anchor{3321}
@deffn {Atributo} broken

A boolean that is @code{True} if the barrier is in the broken state.
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/threading threading BrokenBarrierError}@anchor{1225}
@deffn {Exceção} threading.BrokenBarrierError

This exception, a subclass of @ref{195,,RuntimeError}, is raised when the
@ref{1223,,Barrier} object is reset or broken.
@end deffn

@node Using locks conditions and semaphores in the with statement,,Referência<2>,threading — Paralelismo baseado em threads
@anchor{library/threading using-locks-conditions-and-semaphores-in-the-with-statement}@anchor{3322}@anchor{library/threading with-locks}@anchor{3305}
@subsubsection Using locks, conditions, and semaphores in the @code{with} statement


All of the objects provided by this module that have @code{acquire} and
@code{release} methods can be used as context managers for a @ref{5d2,,with}
statement.  The @code{acquire} method will be called when the block is
entered, and @code{release} will be called when the block is exited.  Hence,
the following snippet:

@example
with some_lock:
    # do something...
@end example

é equivalente a:

@example
some_lock.acquire()
try:
    # do something...
finally:
    some_lock.release()
@end example

Currently, @ref{176d,,Lock}, @ref{2de,,RLock}, @ref{1194,,Condition},
@ref{1195,,Semaphore}, and @ref{1196,,BoundedSemaphore} objects may be used as
@ref{5d2,,with} statement context managers.

@node multiprocessing — Paralelismo baseado em processo,multiprocessing shared_memory — Memória compartilhada para acesso direto entre processos,threading — Paralelismo baseado em threads,Execução Concorrente
@anchor{library/multiprocessing doc}@anchor{3323}@anchor{library/multiprocessing module-multiprocessing}@anchor{94}@anchor{library/multiprocessing multiprocessing-process-based-parallelism}@anchor{3324}@anchor{library/multiprocessing translation-repo}@anchor{3325}
@subsection @code{multiprocessing} — Paralelismo baseado em processo


@geindex module; multiprocessing

`Código-fonte:' Lib/multiprocessing/@footnote{https://github.com/python/cpython/tree/3.13/Lib/multiprocessing/}


__________________________________________________________________


@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@menu
* Introdução: Introdução<9>. 
* Referência: Referência<3>. 
* Programming guidelines:: 
* Exemplos: Exemplos<14>. 

@end menu

@node Introdução<9>,Referência<3>,,multiprocessing — Paralelismo baseado em processo
@anchor{library/multiprocessing introduction}@anchor{3326}
@subsubsection Introdução


@ref{94,,multiprocessing} é um pacote que oferece suporte à invocação de processos utilizando uma API semelhante ao módulo @ref{ed,,threading}. O pacote @ref{94,,multiprocessing} oferece simultaneamente concorrência local e remota, efetivamente contornando a @ref{148,,trava global do interpretador}, ao utilizar subprocessos ao invés de threads. Devido a isso, o módulo @ref{94,,multiprocessing} permite ao programador aproveitar totalmente os múltiplos processadores de uma máquina. Ele funciona tanto em POSIX como em Windows.

The @ref{94,,multiprocessing} module also introduces the
@ref{f9f,,Pool} object which offers a convenient means of
parallelizing the execution of a function across multiple input values,
distributing the input data across processes (data parallelism).  The following
example demonstrates the common practice of defining such functions in a module
so that child processes can successfully import that module.  This basic example
of data parallelism using @ref{f9f,,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

vai exibir na saída padrão

@example
[1, 4, 9]
@end example

The @ref{94,,multiprocessing} module also introduces APIs which do not have
analogs in the @ref{ed,,threading} module, like the ability to @ref{3327,,terminate}, @code{interrupt} or @ref{b6d,,kill} a running process.


@subsubheading Ver também


@ref{8f4,,concurrent.futures.ProcessPoolExecutor} oferece uma interface de nível mais alto para enviar tarefas para um processo em segundo plano sem bloquear a execução do processo de chamada. Comparado ao uso direto da interface @ref{f9f,,Pool}, a API @ref{21,,concurrent.futures} permite mais prontamente que o envio de trabalho para o pool de processos subjacente seja separado da espera pelos resultados.


@menu
* A classe Process:: 
* Contextos e métodos de inicialização:: 
* Trocando objetos entre processos:: 
* Sincronização entre processos:: 
* Compartilhando estado entre processos:: 
* Usando um pool de workers:: 

@end menu

@node A classe Process,Contextos e métodos de inicialização,,Introdução<9>
@anchor{library/multiprocessing the-process-class}@anchor{3328}
@subsubsection A classe @code{Process}


Em @ref{94,,multiprocessing}, os processos são gerados criando um objeto @ref{b6f,,Process} e então chamando seu método @ref{13d8,,start()}. @ref{b6f,,Process} segue a API de @ref{953,,threading.Thread}. Um exemplo trivial de um programa multiprocesso é

@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 os IDs de processo individuais envolvidos, aqui está um exemplo expandido:

@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 uma explicação do porquê a parte @code{if __name__ == '__main__'} é necessária, veja @ref{3329,,Programming guidelines}.

The arguments to @ref{b6f,,Process} usually need to be unpickleable from within
the child process. If you tried typing the above example directly into a REPL it
could lead to an @ref{34b,,AttributeError} in the child process trying to locate the
`f' function in the @code{__main__} module.

@node Contextos e métodos de inicialização,Trocando objetos entre processos,A classe Process,Introdução<9>
@anchor{library/multiprocessing contexts-and-start-methods}@anchor{332a}@anchor{library/multiprocessing multiprocessing-start-methods}@anchor{2c8}
@subsubsection Contextos e métodos de inicialização


Dependendo da plataforma, @ref{94,,multiprocessing} provê três maneiras de iniciar um processo. Estes `métodos de inicialização' são

@quotation
@anchor{library/multiprocessing multiprocessing-start-method-spawn}@anchor{332b}

@table @asis

@item `spawn'

O processo pai inicia um novo processo do interpretador Python. O processo filho herdará apenas os recursos necessários para executar o método @ref{332c,,run()} do objeto do processo. Em particular, descritores de arquivo e identificadores desnecessários do processo pai não serão herdados. Iniciar um processo usando esse método é bem lento comparado a usar `fork' ou `forkserver'.

Disponível em plataformas POSIX e Windows. O padrão no Windows e macOS.
@end table
@anchor{library/multiprocessing multiprocessing-start-method-fork}@anchor{332d}

@table @asis

@item `fork'

O processo pai usa @ref{197,,os.fork()} para criar um fork do interpretador Python. O processo filho, quando começa, é efetivamente idêntico ao processo pai. Todos os recursos do pai são herdados pelo processo filho. Observe que criar um fork com segurança de um processo multithread é problemático.

Disponível em sistemas POSIX. Atualmente o padrão em POSIX, exceto macOS.

@cartouche
@quotation Nota 
O método de início padrão deixará de ser `fork' no Python 3.14. O código que requer `fork' deve especificar explicitamente isso via @ref{2c6,,get_context()} ou @ref{2c7,,set_start_method()}.
@end quotation
@end cartouche


Alterado na versão 3.12: Se o Python for capaz de detectar que seu processo tem várias threads, a função @ref{197,,os.fork()} que esse método de inicialização chama internamente levantará @ref{1a5,,DeprecationWarning}. Use um método de inicialização diferente. Veja a documentação de @ref{197,,os.fork()} para mais explicações.

@end table
@anchor{library/multiprocessing multiprocessing-start-method-forkserver}@anchor{332e}

@table @asis

@item `forkserver'

Quando o programa é inicializado e seleciona o método `forkserver', um processo de servidor é gerado. A partir disso, sempre que um novo processo é necessário, o processo pai conecta-se ao servidor e solicita que um novo processo seja feito um fork. O processo fork do servidor é de thread única, a menos que bibliotecas do sistema ou importações pré-carregadas gerem threads como um efeito colateral; neste sentido, geralmente é seguro usar @ref{197,,os.fork()}. Nenhum recurso desnecessário é herdado.

Disponível em plataformas POSIX que suportam a passagem de descritores de arquivo em Unix pipes, como o Linux.
@end table
@end quotation


Alterado na versão 3.4: `spawn' adicionado em todas as plataformas POSIX, e `forkserver' adicionado para algumas plataformas POSIX. Processos filhos não herdam mais todos os identificadores herdáveis dos pais no Windows.



Alterado na versão 3.8: No macOS, o método de inicialização `spawn' agora é o padrão. O método `fork' deve ser considerado inseguro, pois pode levar a travamentos do subprocesso, uma vez que as bibliotecas do sistema macOS podem iniciar threads. Consulte bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.


No POSIX, usar os métodos de inicialização `spawn' ou `forkserver' também iniciará um processo `rastreador de recursos' que rastreia os recursos de sistema nomeados não vinculados (como semáforos nomeados ou objetos @ref{174f,,SharedMemory}) criados por processos do programa. Quando todos os processos tiverem saído, o rastreador de recursos desvincula qualquer objeto rastreado restante. Normalmente, não deve haver nenhum, mas se um processo foi morto por um sinal, pode haver alguns recursos “vazados”. (Nem os semáforos vazados nem os segmentos de memória compartilhada serão desvinculados automaticamente até a próxima reinicialização do sistema. Isso é problemático para ambos os objetos porque o sistema permite apenas um número limitado de semáforos nomeados, e os segmentos de memória compartilhada ocupam algum espaço na memória principal.)

Para selecionar um método de inicialização, você usa @ref{2c7,,set_start_method()} na cláusula @code{if __name__ == '__main__'} do módulo principal. Por exemplo:

@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{2c7,,set_start_method()} não deve ser usada mais de uma vez no programa.

Alternativamente, você pode usar @ref{2c6,,get_context()} para obter um objeto de contexto. Objetos de contexto têm a mesma API que o módulo multiprocessing e permitem que se usem vários métodos de inicialização no mesmo 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

Note que objetos relacionados a um contexto podem não ser compatíveis com processos para um contexto diferente. Em particular, travas criadas usando o contexto `fork' não podem ser passados para processos iniciados usando os métodos de inicialização `spawn' ou `forkserver'.

Libraries using @ref{94,,multiprocessing} or
@ref{8f4,,ProcessPoolExecutor} should be designed to allow
their users to provide their own multiprocessing context.  Using a specific
context of your own within a library can lead to incompatibilities with the
rest of the library user’s application.  Always document if your library
requires a specific start method.

@cartouche
@quotation Aviso 
Os métodos de inicialização @code{'spawn'} e @code{'forkserver'} geralmente não podem ser usadas com executáveis “congelados” (por exemplo, binários produzidos por pacotes como `PyInstaller' e `cx_Freeze') em sistemas POSIX. O método de inicialização @code{'fork'} pode funcionar se o código não usar threads.
@end quotation
@end cartouche

@node Trocando objetos entre processos,Sincronização entre processos,Contextos e métodos de inicialização,Introdução<9>
@anchor{library/multiprocessing exchanging-objects-between-processes}@anchor{332f}
@subsubsection Trocando objetos entre processos


@ref{94,,multiprocessing} tem suporte a dois tipos de canal de comunicação entre processos:

`Filas'

@quotation

A classe @ref{1914,,Queue} é quase um clone de @ref{13db,,queue.Queue}. Por exemplo:

@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

As filas são seguras para threads e processos. Qualquer objeto colocado em uma fila @ref{94,,multiprocessing} será serializado.
@end quotation

`Encadeamentos'

@quotation

A função @ref{3330,,Pipe()} retorna um par de objetos de conexão conectados por um encadeamento que por padrão é duplex (bidirecional). Por exemplo:

@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())   # exibe "[42, None, 'hello']"
    p.join()
@end example

Os dois objetos de conexão retornados por @ref{3330,,Pipe()} representam as duas extremidades do encadeamento. Cada objeto de conexão tem os métodos @code{send()} e @code{recv()} (entre outros). Observe que os dados em um encadeamento podem ser corrompidos se dois processos (ou threads) tentarem ler ou gravar na `mesma' extremidade do encadeamento ao mesmo tempo. Claro que não há risco de corrupção de processos usando extremidades diferentes do encadeamento ao mesmo tempo.

O método @code{send()} serializa o objeto e @code{recv()} recria o objeto.
@end quotation

@node Sincronização entre processos,Compartilhando estado entre processos,Trocando objetos entre processos,Introdução<9>
@anchor{library/multiprocessing synchronization-between-processes}@anchor{3331}
@subsubsection Sincronização entre processos


@ref{94,,multiprocessing} contém equivalentes de todas as primitivas de sincronização de @ref{ed,,threading}. Por exemplo, pode-se usar uma trava para garantir que apenas um processo exiba na saída padrão por 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

Sem utilizar a saída da trava dos diferentes processos, é possível que tudo fique confuso.

@node Compartilhando estado entre processos,Usando um pool de workers,Sincronização entre processos,Introdução<9>
@anchor{library/multiprocessing sharing-state-between-processes}@anchor{3332}
@subsubsection Compartilhando estado entre processos


Conforme mencionado acima, ao fazer programação concorrente, geralmente é melhor evitar o uso de estado compartilhado, tanto quanto possível. Isso é particularmente verdadeiro ao utilizar múltiplos processos.

No entanto, se você realmente precisa utilizar algum compartilhamento de dados, então @ref{94,,multiprocessing} fornece algumas maneiras de se fazer isso.

`Memória compartilhada'

@quotation

Os dados podem ser armazenados em um mapa de memória compartilhado utilizando @ref{3333,,Value} ou @ref{3334,,Array}. Por exemplo, o código a seguir

@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

vai exibir

@example
3.1415927
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
@end example

Os argumentos @code{'d'} e @code{'i'} usados ao criar @code{num} e @code{arr} são typecodes do tipo usado pelo módulo @ref{7,,array}: @code{'d'} indica um ponto flutuante de precisão dupla e @code{'i'} indica um inteiro com sinal. Esses objetos compartilhados serão seguros para thread e processo.

Para mais flexibilidade no uso de memória compartilhada, pode-se utilizar o módulo @ref{9a,,multiprocessing.sharedctypes}, que suporta a criação de objetos ctypes arbitrários alocados da memória compartilhada.
@end quotation

`Processo de servidor'

@quotation

Um objeto gerenciador retornado por @ref{cda,,Manager()} controla um processo de servidor que contém objetos Python e permite que outros processos os manipulem usando proxies.

Um gerenciador retornado por @ref{cda,,Manager()} vai oferecer suporte aos tipos @ref{611,,list}, @ref{256,,dict}, @ref{3335,,Namespace}, @ref{1683,,Lock}, @ref{1684,,RLock}, @ref{3336,,Semaphore}, @ref{3337,,BoundedSemaphore}, @ref{3338,,Condition}, @ref{198f,,Event}, @ref{3339,,Barrier}, @ref{1914,,Queue}, @ref{3333,,Value} e @ref{3334,,Array}. Por exemplo,

@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

vai exibir

@example
@{0.25: None, 1: '1', '2': 2@}
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@end example

Os gerenciadores de processos de servidor são mais flexíveis do que usar objetos de memória compartilhada porque podem ser feitos para oferecer suporte a tipos de objetos arbitrários. Além disso, um único gerenciador pode ser compartilhado por processos em diferentes computadores em uma rede. Eles são, no entanto, mais lentos do que usar memória compartilhada.
@end quotation

@node Usando um pool de workers,,Compartilhando estado entre processos,Introdução<9>
@anchor{library/multiprocessing using-a-pool-of-workers}@anchor{333a}
@subsubsection Usando um pool de workers


A classe @ref{f9f,,Pool} representa um pool de processos de worker. Ela tem métodos que permitem que tarefas sejam descarregadas para os processos de worker de algumas maneiras diferentes.

Por exemplo:

@example
from multiprocessing import Pool, TimeoutError
import time
import os

def f(x):
    return x*x

if __name__ == '__main__':
    # inicia 4 processos de trabalhador
    with Pool(processes=4) as pool:

        # exibe "[0, 1, 4,..., 81]"
        print(pool.map(f, range(10)))

        # exibe mesmo números em ordem arbitrária
        for i in pool.imap_unordered(f, range(10)):
            print(i)

        # calcula "f(20)" assincronamente
        res = pool.apply_async(f, (20,))      # executa em *apenas* um processo
        print(res.get(timeout=1))             # exibe "400"

        # calcula "os.getpid()" assincronamente
        res = pool.apply_async(os.getpid, ()) # executa em *apenas* um procsso
        print(res.get(timeout=1))             # exibe o PID daquele processo

        # iniciando vários cálculos de forma assíncrona *pod* usar mais procssos
        multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
        print([res.get(timeout=1) for res in multiple_results])

        # faz um único worker dormir por 10 segundos
        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")

    # saindo o bloco 'with' parou o pool
    print("Now the pool is closed and no longer available")
@end example

Observe que os métodos de um pool só devem ser usados pelo processo que o criou.

@cartouche
@quotation Nota 
A funcionalidade dentro deste pacote requer que o módulo @code{__main__} seja importável pelos filhos. Isso é abordado em @ref{3329,,Programming guidelines}, mas vale a pena apontar aqui. Isso significa que alguns exemplos, como os exemplos @ref{f9f,,multiprocessing.pool.Pool} não funcionarão no interpretador interativo. Por exemplo:

@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

(Se você tentar isso, na verdade, serão gerados três tracebacks completos intercalados de forma semi-aleatória, e então você pode ter que interromper o processo pai de alguma forma.)
@end quotation
@end cartouche

@node Referência<3>,Programming guidelines,Introdução<9>,multiprocessing — Paralelismo baseado em processo
@anchor{library/multiprocessing reference}@anchor{333b}
@subsubsection Referência


O pacote @ref{94,,multiprocessing} replica principalmente a API do módulo @ref{ed,,threading}.

@menu
* Global start method:: 
* Process e exceções:: 
* Encadeamentos e filas:: 
* Diversos: Diversos<4>. 
* Objetos de conexão:: 
* Primitivas de sincronização:: 
* Objetos ctypes compartilhados:: 
* Gerenciadores:: 
* Objetos proxies:: 
* Process Pools:: 
* Listeners and Clients:: 
* Authentication keys:: 
* Gerando logs: Gerando logs<2>. 
* The multiprocessing.dummy module: The multiprocessing dummy module. 

@end menu

@node Global start method,Process e exceções,,Referência<3>
@anchor{library/multiprocessing global-start-method}@anchor{333c}@anchor{library/multiprocessing id1}@anchor{333d}
@subsubsection Global start method


Python supports several ways to create and initialize a process.
The global start method sets the default mechanism for creating a process.

Several multiprocessing functions and methods that may also instantiate
certain objects will implicitly set the global start method to the system’s default,
if it hasn’t been set already. The global start method can only be set once.
If you need to change the start method from the system default, you must
proactively set the global start method before calling functions or methods,
or creating these objects.

@node Process e exceções,Encadeamentos e filas,Global start method,Referência<3>
@anchor{library/multiprocessing process-and-exceptions}@anchor{333e}
@subsubsection @code{Process} e exceções


@geindex Process (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Process}@anchor{b6f}
@deffn {Classe} multiprocessing.Process (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None)

Objetos processo representam atividades que são executadas em um processo separado. A classe @ref{b6f,,Process} possui equivalentes de todos os métodos de @ref{953,,threading.Thread}.

O construtor deve sempre ser chamado com argumentos nomeados. `group' deve sempre ser @code{None}; ele existe somente para compatibilidade com @ref{953,,threading.Thread}. `target' é o objeto chamável a ser invocado pelo método @ref{332c,,run()}. O padrão é @code{None}, o que significa que nada é chamado. `name' é o nome do processo (veja @ref{333f,,name} para mais detalhes). `args' é a tupla de argumento para a invocação de destino. `kwargs' é um dicionário de argumentos nomeados para a invocação de destino. Se fornecido, o argumento somente-nomeados `daemon' define o sinalizador do processo @ref{3340,,daemon} como @code{True} ou @code{False}. Se @code{None} (o padrão), este sinalizador será herdado do processo de criação.

Por padrão, nenhum argumento é passado para `target'. O argumento `args', que tem como padrão @code{()}, pode ser usado para especificar uma lista ou tupla de argumentos a serem passados para `target'.

If a subclass overrides the constructor, it must make sure it invokes the
base class constructor (@code{super().__init__()}) before doing anything else
to the process.

@cartouche
@quotation Nota 
In general, all arguments to @ref{b6f,,Process} must be picklable.  This is
frequently observed when trying to create a @ref{b6f,,Process} or use a
@ref{8f4,,concurrent.futures.ProcessPoolExecutor} from a REPL with a
locally defined `target' function.

Passing a callable object defined in the current REPL session causes the
child process to die via an uncaught @ref{34b,,AttributeError} exception when
starting as `target' must have been defined within an importable module
in order to be loaded during unpickling.

Example of this uncatchable error from the child:

@example
>>> import multiprocessing as mp
>>> def knigit():
...     print("Ni!")
...
>>> process = mp.Process(target=knigit)
>>> process.start()
>>> Traceback (most recent call last):
  File ".../multiprocessing/spawn.py", line ..., in spawn_main
  File ".../multiprocessing/spawn.py", line ..., in _main
AttributeError: module '__main__' has no attribute 'knigit'
>>> process
<SpawnProcess name='SpawnProcess-1' pid=379473 parent=378707 stopped exitcode=1>
@end example

See @ref{3341,,The spawn and forkserver start methods}.  While this restriction is
not true if using the @code{"fork"} start method, as of Python @code{3.14} that
is no longer the default on any platform.  See
@ref{2c8,,Contextos e métodos de inicialização}.
See also gh-132898@footnote{https://github.com/python/cpython/issues/132898}.
@end quotation
@end cartouche


Alterado na versão 3.3: Adicionado o parâmetro `daemon'.


@geindex run() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process run}@anchor{332c}
@deffn {Método} run ()

Método que representa a atividade do processo.

Você pode substituir esse método em uma subclasse. O método padrão @ref{332c,,run()} invoca o objeto chamável passado ao construtor do objeto como o argumento alvo, se houver, com argumentos nomeados e sequenciais retirados dos argumentos `args' e `kwargs', respectivamente.

Usar uma lista ou tupla como argumento `args' passado para @ref{b6f,,Process} obtém o mesmo efeito.

Exemplo:

@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 multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process start}@anchor{13d8}
@deffn {Método} start ()

Inicia a atividade do processo.

Isso deve ser chamado no máximo uma vez por objeto processo. Ele organiza para que o método @ref{332c,,run()} do objeto seja invocado em um processo separado.
@end deffn

@geindex join() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process join}@anchor{13da}
@deffn {Método} join ([timeout])

Se o argumento opcional `timeout' for @code{None} (o padrão), o método bloqueia até que o processo cujo método @ref{13da,,join()} é chamado termine. Se `timeout' for um número positivo, ele bloqueia no máximo `timeout' segundos. Observe que o método retorna @code{None} se seu processo terminar ou se o método tiver tempo limite. Verifique o @ref{3342,,exitcode} do processo para determinar se ele terminou.

Um processo pode ser usar “join” muitas vezes.

Um processo não pode se unir porque isso causaria um impasse. É um erro tentar se unir a um processo antes que ele tenha sido iniciado.
@end deffn

@geindex name (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process name}@anchor{333f}
@deffn {Atributo} name

O nome do processo. O nome é uma string usada apenas para fins de identificação. Não tem semântica. Vários processos podem receber o mesmo nome.

O nome inicial é definido pelo construtor. Se nenhum nome explícito for fornecido ao construtor, um nome do formato ‘Processo-N@w{[1]}:N@w{[2]}:…:N@w{[k]}’ é construído, onde cada N@w{[k]} é o N-ésimo filho de seu pai.
@end deffn

@geindex is_alive() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process is_alive}@anchor{13d9}
@deffn {Método} is_alive ()

Retorna se o processo está ativo.

Em termos gerais, um objeto processo está ativo desde o momento em que o método @ref{13d8,,start()} retorna até o término do processo filho.
@end deffn

@geindex daemon (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process daemon}@anchor{3340}
@deffn {Atributo} daemon

O sinalizador daemon do processo, um valor Booleano. Isso deve ser definido antes de @ref{13d8,,start()} ser chamado.

O valor inicial é herdado do processo de criação.

Quando um processo sai, ele tenta encerrar todos os seus processos filhos daemônicos.

Note que um processo daemônico não tem permissão para criar processos filhos. Caso contrário, um processo daemônico deixaria seus filhos órfãos se ele fosse encerrado quando seu processo pai saísse. Além disso, esses `não' são daemons ou serviços Unix, eles são processos normais que serão encerrados (e em vez de usar “join”) se processos não daemônicos tiverem saído.
@end deffn

Além da API @ref{953,,threading.Thread}, os objetos @ref{b6f,,Process} também oferecem suporte aos seguintes atributos e métodos:

@geindex pid (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process pid}@anchor{3343}
@deffn {Atributo} pid

Retorna o ID do processo. Antes do processo ser gerado, este será @code{None}.
@end deffn

@geindex exitcode (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process exitcode}@anchor{3342}
@deffn {Atributo} exitcode

O código de saída da criança. Este será @code{None} se o processo ainda não tiver terminado.

Se o método @ref{332c,,run()} da criança retornar normalmente, o código de saída será 0. Se ele terminar via @ref{138e,,sys.exit()} com um argumento inteiro `N', o código de saída será `N'.

Se a criança for encerrada devido a uma exceção não capturada em @ref{332c,,run()}, o código de saída será 1. Se ela for encerrada pelo sinal `N', o código de saída será o valor negativo `-N'.
@end deffn

@geindex authkey (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process authkey}@anchor{3344}
@deffn {Atributo} authkey

A chave de autenticação do processo (uma string de bytes).

Quando @ref{94,,multiprocessing} é inicializado, o processo principal recebe uma string aleatória usando @ref{523,,os.urandom()}.

Quando um objeto @ref{b6f,,Process} é criado, ele herda a chave de autenticação do seu processo pai, embora isso possa ser alterado definindo @ref{3344,,authkey} para outra sequência de bytes.

Veja @ref{3345,,Authentication keys}.
@end deffn

@geindex sentinel (atributo multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process sentinel}@anchor{1120}
@deffn {Atributo} sentinel

Um identificador numérico de um objeto do sistema que ficará “pronto” quando o processo terminar.

Você pode usar esse valor se quiser esperar por vários eventos ao mesmo tempo usando @ref{111e,,multiprocessing.connection.wait()}. Caso contrário, chamar @ref{13da,,join()} é mais simples.

No Windows, este é um identificador de sistema operacional utilizável com a família de chamadas de API @code{WaitForSingleObject} e @code{WaitForMultipleObjects}. No POSIX, este é um descritor de arquivo utilizável com primitivos do módulo @ref{c1,,select}.


Adicionado na versão 3.3.

@end deffn

@geindex terminate() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process terminate}@anchor{3327}
@deffn {Método} terminate ()

Encerra o processo. No POSIX isso é feito usando o sinal @ref{1426,,SIGTERM}; no Windows é usado @code{TerminateProcess()}. Note que os manipuladores de saída e cláusulas finally, etc., não serão executados.

Observe que os processos descendentes do processo `não' serão encerrados — eles simplesmente ficarão órfãos.

@cartouche
@quotation Aviso 
Se esse método for usado quando o processo associado estiver usando um encadeamento ou fila, então o encadeamento ou fila é passível de ser corrompido e pode se tornar inutilizável por outro processo. Similarmente, se o processo adquiriu um trava ou semáforo etc., então encerrá-lo é passível de causar impasse em outros processos.
@end quotation
@end cartouche
@end deffn

@geindex kill() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process kill}@anchor{b6d}
@deffn {Método} kill ()

O mesmo que @ref{3327,,terminate()}, mas usando o sinal @code{SIGKILL} no POSIX.


Adicionado na versão 3.7.

@end deffn

@geindex close() (método multiprocessing.Process)
@anchor{library/multiprocessing multiprocessing Process close}@anchor{b6c}
@deffn {Método} close ()

Fecha o objeto @ref{b6f,,Process}, liberando todos os recursos associados a ele. @ref{202,,ValueError} é levantado se o processo subjacente ainda estiver em execução. Uma vez que @ref{b6c,,close()} retorne com sucesso, a maioria dos outros métodos e atributos do objeto @ref{b6f,,Process} levantará @ref{202,,ValueError}.


Adicionado na versão 3.7.

@end deffn

Observe que os métodos @ref{13d8,,start()}, @ref{13da,,join()}, @ref{13d9,,is_alive()}, @ref{3327,,terminate()} e @ref{3342,,exitcode} devem ser chamados somente pelo processo que criou o objeto processo.

Exemplo de uso de alguns dos métodos de @ref{b6f,,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{3346}
@deffn {Exceção} multiprocessing.ProcessError

A classe base de todas as exceções de @ref{94,,multiprocessing}.
@end deffn

@geindex BufferTooShort
@anchor{library/multiprocessing multiprocessing BufferTooShort}@anchor{3347}
@deffn {Exceção} multiprocessing.BufferTooShort

Exceção levantada por @code{Connection.recv_bytes_into()} quando o objeto buffer fornecido é muito pequeno para a mensagem lida.

Se @code{e} for uma instância de @ref{3347,,BufferTooShort}, então @code{e.args[0]} retornará a mensagem como uma string de bytes.
@end deffn

@geindex AuthenticationError
@anchor{library/multiprocessing multiprocessing AuthenticationError}@anchor{3348}
@deffn {Exceção} multiprocessing.AuthenticationError

Levantada quando há um erro de autenticação.
@end deffn

@geindex TimeoutError
@anchor{library/multiprocessing multiprocessing TimeoutError}@anchor{3349}
@deffn {Exceção} multiprocessing.TimeoutError

Levantada por métodos com um tempo limite quando o tempo limite expira.
@end deffn

@node Encadeamentos e filas,Diversos<4>,Process e exceções,Referência<3>
@anchor{library/multiprocessing pipes-and-queues}@anchor{334a}
@subsubsection Encadeamentos e filas


Ao usar vários processos, geralmente é usada a passagem de mensagens para comunicação entre processos e evita-se ter que usar quaisquer primitivas de sincronização, como travas.

Para passar mensagens, pode-se usar @ref{3330,,Pipe()} (para uma conexão entre dois processos) ou uma fila (que permite múltiplos produtores e consumidores).

Os tipos @ref{1914,,Queue}, @ref{91a,,SimpleQueue} e @ref{334b,,JoinableQueue} são filas @abbr{FIFO} multiprodutoras e multiconsumidoras modeladas na classe @ref{13db,,queue.Queue} da biblioteca padrão. Elas diferem porque @ref{1914,,Queue} não tem os métodos @ref{334c,,task_done()} e @ref{334d,,join()} introduzidos na classe @ref{13db,,queue.Queue} do Python 2.5.

Se você usar @ref{334b,,JoinableQueue}, então você `deve' chamar @ref{334e,,JoinableQueue.task_done()} para cada tarefa removida da fila, caso contrário, o semáforo usado para contar o número de tarefas não concluídas pode eventualmente transbordar, levantando uma exceção.

Uma diferença de outras implementações de filas no Python é que as filas do @ref{94,,multiprocessing} serializam todos os objetos que são colocados nelas usando @ref{a6,,pickle}. O objeto retornado pelo método get é um objeto recriado que não compartilha memória com o objeto original.

Observe que também é possível criar uma fila compartilhada usando um objeto gerenciador — veja @ref{334f,,Gerenciadores}.

@cartouche
@quotation Nota 
@ref{94,,multiprocessing} usa as exceções usuais @ref{3350,,queue.Empty} e @ref{3351,,queue.Full} para sinalizar um tempo limite. Elas não estão disponíveis no espaço de nomes do @ref{94,,multiprocessing}, então você precisa importá-las de @ref{b6,,queue}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Quando um objeto é colocado em uma fila, o objeto é serializado com pickle e uma thread em segundo plano depois descarrega os dados serializados com pickle para um encadeamento subjacente. Isso tem algumas consequências que são um pouco surpreendentes, mas não devem causar nenhuma dificuldade prática – se elas realmente o incomodam, então você pode usar uma fila criada com um @ref{334f,,gerenciador}.


@enumerate 

@item 
Depois de colocar um objeto em uma fila vazia, pode haver um atraso infinitesimal antes que o método @ref{16e6,,empty()} da fila retorne @ref{b49,,False} e @ref{3352,,get_nowait()} possa retornar sem levantar @ref{3350,,queue.Empty}.

@item 
Se vários processos estiverem enfileirando objetos, é possível que os objetos sejam recebidos na outra extremidade fora de ordem. No entanto, objetos enfileirados pelo mesmo processo sempre estarão na ordem esperada em relação uns aos outros.
@end enumerate
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Se um processo for morto usando @ref{3327,,Process.terminate()} ou @ref{13ae,,os.kill()} enquanto estiver tentando usar uma @ref{1914,,Queue}, os dados na fila provavelmente serão corrompidos. Isso pode fazer com que qualquer outro processo obtenha uma exceção quando tentar usar a fila mais tarde.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Conforme mencionado acima, se um processo filho tiver colocado itens em uma fila (e não tiver usado @ref{3353,,JoinableQueue.cancel_join_thread}), esse processo não será encerrado até que todos os itens armazenados em buffer tenham sido liberados para o encadeamento.

Isso significa que se você tentar juntar esse processo, poderá obter um impasse, a menos que tenha certeza de que todos os itens que foram colocados na fila foram consumidos. Da mesma forma, se o processo filho não for daemônico, o processo pai pode travar na saída quando tentar juntar todos os seus filhos não daemônicos.

Note que uma fila criada usando um gerenciador não tem esse problema. Veja @ref{3329,,Programming guidelines}.
@end quotation
@end cartouche

Para um exemplo do uso de filas para comunicação entre processos, veja @ref{3354,,Exemplos}.

@geindex Pipe() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Pipe}@anchor{3330}
@deffn {Função} multiprocessing.Pipe ([duplex])

Retorna um par @code{(conn1, conn2)} de objetos @ref{111f,,Connection} representando as extremidades de um encadeamento.

Se `duplex' for @code{True} (o padrão), então o encadeamento é bidirecional. Se `duplex' for @code{False}, então o encadeamento é unidirecional: @code{conn1} pode ser usado somente para receber mensagens e @code{conn2} pode ser usado somente para enviar mensagens.

O método @code{send()} serializa o objeto usando @ref{a6,,pickle} e @code{recv()} recria o objeto.
@end deffn

@geindex Queue (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Queue}@anchor{1914}
@deffn {Classe} multiprocessing.Queue ([maxsize])

Retorna uma fila compartilhada de processo implementada usando um encadeamento e algumas travas/semáforos. Quando um processo coloca um item na fila pela primeira vez, uma thread alimentadora é iniciada, a qual transfere objetos de um buffer para o encadeamento.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

As exceções usuais @ref{3350,,queue.Empty} e @ref{3351,,queue.Full} do módulo @ref{b6,,queue} da biblioteca padrão são levantadas para sinalizar tempos limite.

@ref{1914,,Queue} implementa todos os métodos de @ref{13db,,queue.Queue}, exceto @ref{334c,,task_done()} e @ref{334d,,join()}.

@geindex qsize() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue qsize}@anchor{3355}
@deffn {Método} qsize ()

Retorna o tamanho aproximado da fila. Devido à semântica de multithreading/multiprocessamento, esse número não é confiável.

Observe que isso pode levantar @ref{228,,NotImplementedError} em plataformas como macOS, onde @code{sem_getvalue()} não está implementado.
@end deffn

@geindex empty() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue empty}@anchor{16e6}
@deffn {Método} empty ()

Retorna @code{True} se a fila estiver vazia, @code{False} caso contrário. Devido à semântica de multithreading/multiprocessamento, isso não é confiável.

Pode levantar uma exceção @ref{417,,OSError} em filas fechadas. (não garantido)
@end deffn

@geindex full() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue full}@anchor{3356}
@deffn {Método} full ()

Retorna @code{True} se a fila estiver cheia, @code{False} caso contrário. Devido à semântica de multithreading/multiprocessamento, isso não é confiável.
@end deffn

@geindex put() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue put}@anchor{1bb4}
@deffn {Método} put (obj[, block[, timeout]])

Coloca `obj' na fila. Se o argumento opcional `block' for @code{True} (o padrão) e `timeout' for @code{None} (o padrão), bloqueia se necessário até que um slot livre esteja disponível. Se `timeout' for um número positivo, ele bloqueia no máximo `timeout' segundos e levanta a exceção @ref{3351,,queue.Full} se nenhum slot livre estiver disponível dentro desse tempo. Caso contrário (`block' é @code{False}), coloca um item na fila se um slot livre estiver imediatamente disponível, senão levanta a exceção @ref{3351,,queue.Full} (`timeout' é ignorado nesse caso).


Alterado na versão 3.8: Se a fila for fechada, @ref{202,,ValueError} será levantada em vez de @ref{6a9,,AssertionError}.

@end deffn

@geindex put_nowait() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue put_nowait}@anchor{3357}
@deffn {Método} put_nowait (obj)

Equivalente  a @code{put(obj, False)}.
@end deffn

@geindex get() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue get}@anchor{1bb5}
@deffn {Método} get ([block[, timeout]])

Remove e retorna um item da fila. Se os argumentos opcionais `block' forem @code{True} (o padrão) e `timeout' forem @code{None} (o padrão), bloqueia se necessário até que um item esteja disponível. Se `timeout' for um número positivo, ele bloqueia no máximo `timeout' segundos e levantada a exceção @ref{3350,,queue.Empty} se nenhum item estiver disponível dentro desse tempo. Caso contrário (block for @code{False}), retorna um item se um estiver imediatamente disponível, senão levantada a exceção @ref{3350,,queue.Empty} (`timeout' é ignorado nesse caso).


Alterado na versão 3.8: Se a fila for fechada, @ref{202,,ValueError} será levantada em vez de @ref{417,,OSError}.

@end deffn

@geindex get_nowait() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue get_nowait}@anchor{3352}
@deffn {Método} get_nowait ()

Equivalente a @code{get(False)}.
@end deffn

@ref{1914,,multiprocessing.Queue} tem alguns métodos adicionais não encontrados em @ref{13db,,queue.Queue}. Esses métodos geralmente são desnecessários para a maioria dos códigos:

@geindex close() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue close}@anchor{1915}
@deffn {Método} close ()

Fecha a fila: libera recursos internos.

A queue must not be used anymore after it is closed. For example,
@ref{1bb5,,get()}, @ref{1bb4,,put()} and @ref{16e6,,empty()}
methods must no longer be called.

The background thread will quit once it has flushed all buffered
data to the pipe.  This is called automatically when the queue is garbage
collected.
@end deffn

@geindex join_thread() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue join_thread}@anchor{3358}
@deffn {Método} join_thread ()

Junta a thread de segundo plano. Isso só pode ser usado depois que @ref{1915,,close()} for chamado. Isso bloqueia até que a thread de segundo plano saia, garantindo que todos os dados no buffer tenham sido liberados para o encadeamento.

Por padrão, se um processo não for o criador da fila, ao sair, ele tentará se juntar ao thread de segundo plano da fila. O processo pode chamar @ref{3353,,cancel_join_thread()} para fazer @ref{3358,,join_thread()} não fazer nada.
@end deffn

@geindex cancel_join_thread() (método multiprocessing.Queue)
@anchor{library/multiprocessing multiprocessing Queue cancel_join_thread}@anchor{3353}
@deffn {Método} cancel_join_thread ()

Impede que @ref{3358,,join_thread()} bloqueie. Em particular, isso impede que o thread de segundo plano seja unido automaticamente quando o processo sai – veja @ref{3358,,join_thread()}.

Um nome melhor para esse método pode ser @code{allow_exit_without_flush()}. É provável que ele faça com que dados enfileirados sejam perdidos, e você quase certamente não precisará usá-lo. Ele está realmente lá somente se você precisar que o processo atual saia imediatamente sem esperar para liberar dados enfileirados para o encadeamento subjacente, e você não se importa com dados perdidos.
@end deffn

@cartouche
@quotation Nota 
A funcionalidade desta classe requer uma implementação de semáforo compartilhado funcional no sistema operacional host. Sem uma, a funcionalidade nesta classe será desabilitada, e as tentativas de instanciar uma @ref{1914,,Queue} resultarão em um @ref{419,,ImportError}. Veja bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} para informações adicionais. O mesmo vale para qualquer um dos tipos de fila especializados listados abaixo.
@end quotation
@end cartouche
@end deffn

@geindex SimpleQueue (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing SimpleQueue}@anchor{91a}
@deffn {Classe} multiprocessing.SimpleQueue

É um tipo @ref{1914,,Queue} simplificado, muito próximo de um @ref{3330,,Pipe} travado.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

@geindex close() (método multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue close}@anchor{91b}
@deffn {Método} close ()

Fecha a fila: libera recursos internos.

Uma fila não deve mais ser usada depois de fechada. Por exemplo, os métodos @ref{3359,,get()}, @ref{335a,,put()} e @ref{16e7,,empty()} não devem mais ser chamados.


Adicionado na versão 3.9.

@end deffn

@geindex empty() (método multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue empty}@anchor{16e7}
@deffn {Método} empty ()

Retorna @code{True} se a fila estiver vazia, @code{False} caso contrário.

Sempre levanta @ref{417,,OSError} se a SimpleQueue estiver fechada.
@end deffn

@geindex get() (método multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue get}@anchor{3359}
@deffn {Método} get ()

Remove e retorna um item da fila.
@end deffn

@geindex put() (método multiprocessing.SimpleQueue)
@anchor{library/multiprocessing multiprocessing SimpleQueue put}@anchor{335a}
@deffn {Método} put (item)

Coloca `item' na fila.
@end deffn
@end deffn

@geindex JoinableQueue (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing JoinableQueue}@anchor{334b}
@deffn {Classe} multiprocessing.JoinableQueue ([maxsize])

@ref{334b,,JoinableQueue}, uma subclasse de @ref{1914,,Queue}, é uma fila que também possui os métodos @ref{334e,,task_done()} e @ref{335b,,join()}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

@geindex task_done() (método multiprocessing.JoinableQueue)
@anchor{library/multiprocessing multiprocessing JoinableQueue task_done}@anchor{334e}
@deffn {Método} task_done ()

Indica que a tarefa anteriormente enfileirado está concluída. Para cada @ref{1bb5,,get()} usado para buscar uma tarefa, uma chamada subsequente para @ref{334e,,task_done()} avisa à fila, que o processamento na tarefa está concluído.

Se um @ref{334d,,join()} estiver causando bloqueio no momento, ele irá continuar quando todos os itens tiverem sido processados (significando que uma chamada @ref{334e,,task_done()} foi recebida para cada item que foi chamado o método @ref{1bb4,,put()} para colocar na fila).

Levanta @ref{202,,ValueError} se for chamado mais vezes do que o número de itens colocados na fila.
@end deffn

@geindex join() (método multiprocessing.JoinableQueue)
@anchor{library/multiprocessing multiprocessing JoinableQueue join}@anchor{335b}
@deffn {Método} join ()

Bloqueia até que todos os itens na fila tenham sido obtidos e processados.

A contagem de tarefas inacabadas aumenta sempre que um item é adicionado à fila. A contagem diminui sempre que uma consumidora chama @ref{334e,,task_done()} para indicar que o item foi recuperado e todo o trabalho nele foi concluído. Quando a contagem de tarefas inacabadas chega a zero, @ref{334d,,join()} desbloqueia.
@end deffn
@end deffn

@node Diversos<4>,Objetos de conexão,Encadeamentos e filas,Referência<3>
@anchor{library/multiprocessing miscellaneous}@anchor{335c}
@subsubsection Diversos


@geindex active_children() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing active_children}@anchor{335d}
@deffn {Função} multiprocessing.active_children ()

Retorna a lista de todos os filhos ativos do processo atual.

Chamar isso tem o efeito colateral de “juntar” quaisquer processos que já tenham sido concluídos.
@end deffn

@geindex cpu_count() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing cpu_count}@anchor{fa3}
@deffn {Função} multiprocessing.cpu_count ()

Retorna o número de CPUs no sistema.

Este número não equivale ao número de CPUs que o processo atual pode usar. O número de CPUs utilizáveis pode ser obtido com @ref{1c4,,os.process_cpu_count()} (ou @code{len(os.sched_getaffinity(0))}).

Quando o número de CPUs não pode ser determinado, uma @ref{228,,NotImplementedError} é levantada.


@subsubheading Ver também


@ref{1c5,,os.cpu_count()}
@ref{1c4,,os.process_cpu_count()}



Alterado na versão 3.13: O valor de retorno também pode ser substituído usando o sinalizador @ref{176,,-X cpu_count} ou 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT}, pois este é apenas um invólucro em torno das APIs de contagem de CPU do @ref{a1,,os}.

@end deffn

@geindex current_process() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing current_process}@anchor{335e}
@deffn {Função} multiprocessing.current_process ()

Retorna o objeto @ref{b6f,,Process} correspondente ao processo atual.

Um análogo de @ref{309,,threading.current_thread()}.
@end deffn

@geindex parent_process() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing parent_process}@anchor{335f}
@deffn {Função} multiprocessing.parent_process ()

Retorna o objeto @ref{b6f,,Process} correspondente ao processo pai do @ref{335e,,current_process()}. Para o processo principal, @code{parent_process} será @code{None}.


Adicionado na versão 3.8.

@end deffn

@geindex freeze_support() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing freeze_support}@anchor{1628}
@deffn {Função} multiprocessing.freeze_support ()

Add support for when a program which uses @ref{94,,multiprocessing} has been
frozen to produce an executable.  (Has been tested with `py2exe',
`PyInstaller' and `cx_Freeze'.)

É preciso chamar esta função logo após a linha @code{if __name__ == '__main__'} do módulo principal. Por exemplo:

@example
from multiprocessing import Process, freeze_support

def f():
    print('hello world!')

if __name__ == '__main__':
    freeze_support()
    Process(target=f).start()
@end example

Se a linha @code{freeze_support()} for omitida, tentar executar o executável congelado levantará @ref{195,,RuntimeError}.

Calling @code{freeze_support()} has no effect when the start method is not
`spawn'. In addition, if the module is being run normally by the Python
interpreter (the program has not been frozen), then @code{freeze_support()}
has no effect.
@end deffn

@geindex get_all_start_methods() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_all_start_methods}@anchor{f9d}
@deffn {Função} multiprocessing.get_all_start_methods ()

Retorna uma lista dos métodos de inicialização suportados, o primeiro dos quais é o padrão. Os métodos possíveis são @code{'fork'}, @code{'spawn'} e @code{'forkserver'}. Nem todas as plataformas suportam todos os métodos. Consulte @ref{2c8,,Contextos e métodos de inicialização}.


Adicionado na versão 3.4.

@end deffn

@geindex get_context() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_context}@anchor{2c6}
@deffn {Função} multiprocessing.get_context (method=None)

Retorna um objeto de contexto que possui os mesmos atributos do módulo @ref{94,,multiprocessing}.

If `method' is @code{None} then the default context is returned. Note that if
the global start method has not been set, this will set it to the system default
See @ref{333c,,Global start method} for more details.
Otherwise `method' should be @code{'fork'}, @code{'spawn'},
@code{'forkserver'}.  @ref{202,,ValueError} is raised if the specified
start method is not available.  See @ref{2c8,,Contextos e métodos de inicialização}.


Adicionado na versão 3.4.

@end deffn

@geindex get_start_method() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_start_method}@anchor{f9e}
@deffn {Função} multiprocessing.get_start_method (allow_none=False)

Retorna o nome do método de inicialização usado para iniciar processos.

If the global start method is not set and `allow_none' is @code{False}, the global start
method is set to the default, and its name is returned. See
@ref{333c,,Global start method} for more details.

O valor de retorno pode ser @code{'fork'}, @code{'spawn'}, @code{'forkserver'} ou @code{None}. Veja @ref{2c8,,Contextos e métodos de inicialização}.


Adicionado na versão 3.4.



Alterado na versão 3.8: No macOS, o método de inicialização `spawn' agora é o padrão. O método de inicialização `fork' deve ser considerado inseguro, pois pode levar a travamentos do subprocesso. Consulte bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}.

@end deffn

@geindex set_executable() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_executable}@anchor{191b}
@deffn {Função} multiprocessing.set_executable (executable)

Define o caminho do interpretador Python a ser usado ao iniciar um processo filho. (Por padrão, @ref{3b8,,sys.executable} é usado). Os incorporadores provavelmente precisarão fazer algo como

@example
set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))
@end example

antes que eles possam criar processos filho.


Alterado na versão 3.4: Agora com suporte no POSIX quando o método de inicialização @code{'spawn'} é usado.



Alterado na versão 3.11: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex set_forkserver_preload() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_forkserver_preload}@anchor{1681}
@deffn {Função} multiprocessing.set_forkserver_preload (module_names)

Define uma lista de nomes de módulos para o processo principal do forkserver tentar importar, de modo que seu estado já importado seja herdado por processos forks. Qualquer @ref{419,,ImportError} ao fazer isso é ignorado silenciosamente. Isso pode ser usado como um aprimoramento de desempenho para evitar trabalho repetido em cada processo.

Para que isso aconteça, trabalho deve ser chamado antes que o forkserver processar tenha sido iniciado (antes de criar um @code{Pool} ou iniciar um @ref{b6f,,Process}).

Só é significativo ao usar o método de inicialização @code{'forkserver'}. Consulte @ref{2c8,,Contextos e métodos de inicialização}.


Adicionado na versão 3.4.

@end deffn

@geindex set_start_method() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing set_start_method}@anchor{2c7}
@deffn {Função} multiprocessing.set_start_method (method, force=False)

Define o método que deve ser usado para iniciar processos filhos. O argumento `method' pode ser @code{'fork'}, @code{'spawn'} ou @code{'forkserver'}. Levanta @ref{195,,RuntimeError} se o método de inicialização já tiver sido definido e `force' não for @code{True}. Se `method' for @code{None} e `force' for @code{True}, o método de inicialização será definido como @code{None}. Se `method' for @code{None} e `force' for @code{False}, o contexto será definido como o contexto padrão.

Observe que isso deve ser chamado no máximo uma vez e deve ser protegido dentro da cláusula @code{if __name__ == '__main__'} do módulo principal.

Veja @ref{2c8,,Contextos e métodos de inicialização}.


Adicionado na versão 3.4.

@end deffn

@cartouche
@quotation Nota 
@ref{94,,multiprocessing} não contém equivalentes a @ref{30a,,threading.active_count()}, @ref{19e5,,threading.enumerate()}, @ref{84b,,threading.settrace()}, @ref{84c,,threading.setprofile()}, @ref{1198,,threading.Timer} ou @ref{1631,,threading.local}.
@end quotation
@end cartouche

@node Objetos de conexão,Primitivas de sincronização,Diversos<4>,Referência<3>
@anchor{library/multiprocessing connection-objects}@anchor{3360}
@subsubsection Objetos de conexão


Objetos de conexão permitem o envio e recebimento de strings e objetos que podem ser serializados com pickle. Eles podem ser pensados como sockets conectados orientados a mensagens.

Objetos de conexão geralmente são criados usando @ref{3330,,Pipe} – veja também @ref{3361,,Listeners and Clients}.

@geindex Connection (classe em multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Connection}@anchor{111f}
@deffn {Classe} multiprocessing.connection.Connection

@geindex send() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection send}@anchor{3362}
@deffn {Método} send (obj)

Envia um objeto para a outra extremidade da conexão que deve ser lido usando @ref{3363,,recv()}.

O objeto deve poder ser serializado com pickle. Serializações muito grandes com pickles (aproximadamente 32 MiB+, embora isso dependa do sistema operacional) podem levantar uma exceção @ref{202,,ValueError}.
@end deffn

@geindex recv() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv}@anchor{3363}
@deffn {Método} recv ()

Retorna um objeto enviado a partir da outra extremidade da conexão usando @ref{3362,,send()}. Bloqueia até que haja algo para receber. Levanta @ref{131c,,EOFError} se não houver mais nada para receber e a outra extremidade tenha sido fechada.
@end deffn

@geindex fileno() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection fileno}@anchor{3364}
@deffn {Método} fileno ()

Retorna o descritor de arquivo ou identificador usado pela conexão.
@end deffn

@geindex close() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection close}@anchor{3365}
@deffn {Método} close ()

Fecha a conexão.

Isso é chamado automaticamente quando a conexão é coletada como lixo.
@end deffn

@geindex poll() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection poll}@anchor{3366}
@deffn {Método} poll ([timeout])

Retorna se há algum dado disponível para leitura.

Se `timeout' não for especificado, ele retornará imediatamente. Se `timeout' for um número, isso especificará o tempo máximo em segundos para bloquear. Se `timeout' for @code{None}, um tempo limite infinito será usado.

Observe que vários objetos de conexão podem ser pesquisados ao mesmo tempo usando @ref{111e,,multiprocessing.connection.wait()}.
@end deffn

@geindex send_bytes() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection send_bytes}@anchor{3367}
@deffn {Método} send_bytes (buffer[, offset[, size]])

Enviar dados de bytes de um @ref{d4f,,objeto bytes ou similar} como uma mensagem completa.

Se `offset' for fornecido, os dados serão lidos daquela posição em `buffer'. Se `size' for fornecido, essa quantidade de bytes será lida do buffer. Buffers muito grandes (aproximadamente 32 MiB+, embora isso dependa do sistema operacional) podem levantar uma exceção @ref{202,,ValueError}
@end deffn

@geindex recv_bytes() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes}@anchor{3368}
@deffn {Método} recv_bytes ([maxlength])

Retorna uma mensagem completa de dados como bytes enviados a partir da outra extremidade da conexão como uma string. Bloqueia até que haja algo para receber. Levanta @ref{131c,,EOFError} se não houver mais nada para receber e a outra extremidade tenha sido fechada.

Se `maxlength' for especificado e a mensagem for maior que `maxlength', @ref{417,,OSError} será levantada e a conexão não será mais legível.


Alterado na versão 3.3: Esta função costumava levantada @ref{108b,,IOError}, que agora é um apelido de @ref{417,,OSError}.

@end deffn

@geindex recv_bytes_into() (método multiprocessing.connection.Connection)
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes_into}@anchor{3369}
@deffn {Método} recv_bytes_into (buffer[, offset])

Lê para `buffer' uma mensagem completa de dados como bytes enviados a partir da outra extremidade da conexão e retorna o número de bytes na mensagem. Bloqueia até que haja algo para receber. Levanta @ref{131c,,EOFError} se não houver mais nada para receber e a outra extremidade tenha sido fechada.

`buffer' deve ser um @ref{d4f,,objeto bytes ou similar} gravável. Se `offset' for fornecido, a mensagem será escrita no buffer a partir dessa posição. A posição deve ser um inteiro não negativo menor que o comprimento de `buffer' (em bytes).

Se o buffer for muito curto, uma exceção @code{BufferTooShort} será levantada e a mensagem completa estará disponível como @code{e.args[0]}, onde @code{e} é a instância da exceção.
@end deffn


Alterado na versão 3.3: Os próprios objetos de conexão agora podem ser transferidos entre processos usando @ref{3362,,Connection.send()} e @ref{3363,,Connection.recv()}.

Objetos de conexão agora também oferecem suporte ao protocolo de gerenciamento de contexto — veja @ref{214e,,Tipos de Gerenciador de Contexto}. @ref{23dc,,__enter__()} retorna o objeto de conexão, e @ref{23dd,,__exit__()} chama @ref{3365,,close()}.

@end deffn

Por exemplo:

@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{336a}
@cartouche
@quotation Aviso 
O método @ref{3363,,Connection.recv()} deserializa com picke automaticamente os dados recebidos, o que pode ser um risco à segurança, a menos que você possa confiar no processo que enviou a mensagem.

Portanto, a menos que o objeto de conexão tenha sido produzido usando @code{Pipe()}, você deve usar apenas os métodos @ref{3363,,recv()} e @ref{3362,,send()} após executar algum tipo de autenticação. Veja @ref{3345,,Authentication keys}.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Se um processo for encerrado enquanto estiver tentando ler ou escrever em um encadeamento, os dados no encadeamento provavelmente serão corrompidos, porque pode se tornar impossível ter certeza de onde estão os limites do encadeamento da mensagem.
@end quotation
@end cartouche

@node Primitivas de sincronização,Objetos ctypes compartilhados,Objetos de conexão,Referência<3>
@anchor{library/multiprocessing synchronization-primitives}@anchor{336b}
@subsubsection Primitivas de sincronização


Geralmente, primitivas de sincronização não são tão necessárias em um programa multiprocesso quanto em um programa multithread. Veja a documentação do módulo @ref{ed,,threading}.

Observe que também é possível criar primitivas de sincronização usando um objeto gerenciador — veja @ref{334f,,Gerenciadores}.

@geindex Barrier (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Barrier}@anchor{3339}
@deffn {Classe} multiprocessing.Barrier (parties[, action[, timeout]])

Um objeto de barreira: um clone de @ref{1223,,threading.Barrier}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.


Adicionado na versão 3.3.

@end deffn

@geindex BoundedSemaphore (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing BoundedSemaphore}@anchor{3337}
@deffn {Classe} multiprocessing.BoundedSemaphore ([value])

Um objeto semáforo delimitado: um análogo próximo de @ref{1196,,threading.BoundedSemaphore}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

Existe uma única diferença em relação ao seu análogo próximo: o primeiro argumento do método @code{acquire} é chamado `block', como é consistente com @ref{336c,,Lock.acquire()}.

@cartouche
@quotation Nota 
No macOS, isso é indistinguível de @ref{3336,,Semaphore} porque @code{sem_getvalue()} não está implementado nessa plataforma.
@end quotation
@end cartouche
@end deffn

@geindex Condition (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Condition}@anchor{3338}
@deffn {Classe} multiprocessing.Condition ([lock])

Uma variável de condição: um apelido para @ref{1194,,threading.Condition}.

Se `lock' for especificado, ele deverá ser um objeto @ref{1683,,Lock} ou @ref{1684,,RLock} de @ref{94,,multiprocessing}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.


Alterado na versão 3.3: O método @ref{330e,,wait_for()} foi adicionado.

@end deffn

@geindex Event (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Event}@anchor{198f}
@deffn {Classe} multiprocessing.Event

Um clone de @ref{1197,,threading.Event}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.
@end deffn

@geindex Lock (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Lock}@anchor{1683}
@deffn {Classe} multiprocessing.Lock

Um objeto de trava não recursivo: um análogo próximo de @ref{176d,,threading.Lock}. Uma vez que um processo ou thread tenha adquirido um trava, tentativas subsequentes de adquiri-la de qualquer processo ou thread bloquearão até que ele seja liberada; qualquer processo ou thread pode liberá-la. Os conceitos e comportamentos de @ref{176d,,threading.Lock} conforme se aplica a threads são replicados aqui em @ref{1683,,multiprocessing.Lock} conforme se aplica a processos ou threads, exceto conforme observado.

Observe que @ref{1683,,Lock} é na verdade uma função de fábrica que retorna uma instância de @code{multiprocessing.synchronize.Lock} inicializada com um contexto padrão.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

@ref{1683,,Lock} oferece suporte ao protocolo @ref{5d4,,gerenciador de contexto} e, portanto, pode ser usado em instruções @ref{5d2,,with}.

@geindex acquire() (método multiprocessing.Lock)
@anchor{library/multiprocessing multiprocessing Lock acquire}@anchor{336c}
@deffn {Método} acquire (block=True, timeout=None)

Adquire uma trava, bloqueante ou não.

Com o argumento `block' definido como @code{True} (o padrão), a chamada do método bloqueará até que a trava esteja em um estado destravado, então o definirá como travada e retornará @code{True}. Observe que o nome deste primeiro argumento difere daquele em @ref{698,,threading.Lock.acquire()}.

Com o argumento `block' definido como @code{False}, a chamada do método não bloqueia. Se a trava estiver atualmente em um estado travado, retorna @code{False}; caso contrário, defina a trava para um estado travado e retorna @code{True}.

Quando invocado com um valor positivo de ponto flutuante para `timeout', bloqueie por no máximo o número de segundos especificado por `timeout' enquanto a trava não puder ser adquirida. Invocações com um valor negativo para `timeout' são equivalentes a um `timeout' de zero. Invocações com um valor `timeout' de @code{None} (o padrão) definem o período de tempo limite como infinito. Observe que o tratamento de valores negativos ou @code{None} para `timeout' difere do comportamento implementado em @ref{698,,threading.Lock.acquire()}. O argumento `timeout' não tem implicações práticas se o argumento `block' for definido como @code{False} e, portanto, for ignorado. Retorna @code{True} se a trava tiver sido adquirida ou @code{False} se o período de tempo limite tiver decorrido.
@end deffn

@geindex release() (método multiprocessing.Lock)
@anchor{library/multiprocessing multiprocessing Lock release}@anchor{336d}
@deffn {Método} release ()

Libera uma trava. Isso pode ser chamado de qualquer processo ou thread, não apenas do processo ou thread que originalmente adquiriu a trava.

O comportamento é o mesmo de @ref{1305,,threading.Lock.release()}, exceto que quando invocado em uma trava desatravada, uma @ref{202,,ValueError} é levantada.
@end deffn
@end deffn

@geindex RLock (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing RLock}@anchor{1684}
@deffn {Classe} multiprocessing.RLock

Um objeto de trava recursiva: um análogo próximo de @ref{2de,,threading.RLock}. Uma trava recursiva deve ser liberada pelo processo ou thread que o adquiriu. Uma vez que um processo ou thread tenha adquirido uma trava recursiva, o mesmo processo ou thread pode adquiri-la novamente sem trava; esse processo ou thread deve liberá-la uma vez para cada vez que ela foi adquirida.

Observe que @ref{1684,,RLock} é na verdade uma função de fábrica que retorna uma instância de @code{multiprocessing.synchronize.RLock} inicializada com um contexto padrão.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

@ref{1684,,RLock} oferece suporte ao protocolo @ref{5d4,,gerenciador de contexto} e, portanto, pode ser usado em instruções @ref{5d2,,with}.

@geindex acquire() (método multiprocessing.RLock)
@anchor{library/multiprocessing multiprocessing RLock acquire}@anchor{336e}
@deffn {Método} acquire (block=True, timeout=None)

Adquire uma trava, bloqueante ou não.

Quando invocado com o argumento `block' definido como @code{True}, bloqueia até que a trava esteja em um estado destravado (não pertencente a nenhum processo ou thread), a menos que a trava já seja de propriedade do processo ou thread atual. O processo ou thread atual então assume a propriedade da trava (se ainda não tiver propriedade) e o nível de recursão dentro de incrementos por um da trava, resultando em um valor de retorno de @code{True}. Observe que há várias diferenças no comportamento deste primeiro argumento em comparação com a implementação de @ref{eaa,,threading.RLock.acquire()}, começando pelo nome do argumento em si.

Quando invocado com o argumento `block' definido como @code{False}, não bloqueie. Se a trava já tiver sido adquirida (e, portanto, for de propriedade) por outro processo ou thread, o processo ou thread atual não assume a propriedade e o nível de recursão dentro da trava não é alterada, resultando em um valor de retorno de @code{False}. Se a trava estiver em um estado destravado, o processo ou thread atual assume a propriedade e o nível de recursão é incrementado, resultando em um valor de retorno de @code{True}.

O uso e os comportamentos do argumento `timeout' são os mesmos que em @ref{336c,,Lock.acquire()}. Observe que alguns desses comportamentos de `timeout' diferem dos comportamentos implementados em @ref{eaa,,threading.RLock.acquire()}.
@end deffn

@geindex release() (método multiprocessing.RLock)
@anchor{library/multiprocessing multiprocessing RLock release}@anchor{336f}
@deffn {Método} release ()

Libera uma trava, decrementando o nível de recursão. Se após o decremento o nível de recursão for zero, redefine a trava para destravada (não pertencente a nenhum processo ou thread) e se quaisquer outros processos ou threads estiverem bloqueados esperando a trava ser destravada, permita que exatamente um deles prossiga. Se após o decremento o nível de recursão ainda for diferente de zero, o trava permanece travada e pertencente ao processo ou thread de chamada.

Somente chame esse método quando o processo ou thread de chamada for proprietária da trava. Uma @ref{6a9,,AssertionError} é levantada se esse método for chamado por um processo ou thread diferente do proprietário ou se a trava estiver em um estado destravado (sem proprietário). Observe que o tipo de exceção levantada nessa situação difere do comportamento implementado em @ref{3309,,threading.RLock.release()}.
@end deffn
@end deffn

@geindex Semaphore (classe em multiprocessing)
@anchor{library/multiprocessing multiprocessing Semaphore}@anchor{3336}
@deffn {Classe} multiprocessing.Semaphore ([value])

Um objeto semáforo: um análogo próximo de @ref{1195,,threading.Semaphore}.

Instantiating this class may set the global start method. See
@ref{333c,,Global start method} for more details.

Existe uma única diferença em relação ao seu análogo próximo: o primeiro argumento do método @code{acquire} é chamado `block', como é consistente com @ref{336c,,Lock.acquire()}.
@end deffn

@cartouche
@quotation Nota 
No macOS, não há suporte a @code{sem_timedwait}, então chamar @code{acquire()} com um tempo limite emulará o comportamento dessa função usando um laço de suspensão.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Algumas das funcionalidades deste pacote exibem uma implementação de semáforo compartilhado funcional no sistema operacional host. Sem uma, o módulo @code{multiprocessing.synchronize} será desabilitado e as tentativas de importação dele resultarão em um @ref{419,,ImportError}. Veja bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} para informações adicionais.
@end quotation
@end cartouche

@node Objetos ctypes compartilhados,Gerenciadores,Primitivas de sincronização,Referência<3>
@anchor{library/multiprocessing shared-ctypes-objects}@anchor{3370}
@subsubsection Objetos @code{ctypes} compartilhados


É possível criar objetos compartilhados usando memória compartilhada que pode ser herdada por processos filhos.

@geindex Value() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Value}@anchor{3333}
@deffn {Função} multiprocessing.Value (typecode_or_type, *args, lock=True)

Retorna um objeto @ref{2a,,ctypes} alocado da memória compartilhada. Por padrão, o valor de retorno é, na verdade, um invólucro sincronizado para o objeto. O objeto em si pode ser acessado por meio do atributo `value' de um @ref{3333,,Value}.

`typecode_or_type' determina o tipo do objeto retornado: é um tipo ctypes ou um typecode de um caractere do tipo usado pelo módulo @ref{7,,array}. `*args' é passado para o construtor para o tipo.

Se `lock' for @code{True} (o padrão), então um novo objeto de trava recursiva é criado para sincronizar o acesso ao valor. Se `lock' for um objeto @ref{1683,,Lock} ou @ref{1684,,RLock}, então ele será usado para sincronizar o acesso ao valor. Se `lock' for @code{False}, então o acesso ao objeto retornado não será protegido automaticamente por uma trava, então ele não será necessariamente “seguro para processo”.

Operações como @code{+=} que envolvem uma leitura e escrita não são atômicas. Então se, por exemplo, você quiser incrementar atomicamente um valor compartilhado, não é suficiente apenas fazer

@example
counter.value += 1
@end example

Supondo que a trava associada seja recursiva (o que é por padrão), você pode fazer

@example
with counter.get_lock():
    counter.value += 1
@end example

Observe que `lock' é um argumento somente-nomeado.
@end deffn

@geindex Array() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing Array}@anchor{3334}
@deffn {Função} multiprocessing.Array (typecode_or_type, size_or_initializer, *, lock=True)

Retorna um vetor de ctypes alocado da memória compartilhada. Por padrão, o valor de retorno é, na verdade, um invólucro sincronizado para o vetor.

`typecode_or_type' determines the type of the elements of the returned array:
it is either a @ref{2fbe,,ctypes type} or a one
character typecode of the kind used by the @ref{7,,array} module with the
exception of @code{'w'}, which is not supported.  In addition, the @code{'c'}
typecode is an alias for @ref{2fc1,,ctypes.c_char}.  If `size_or_initializer'
is an integer, then it determines the length of the array, and the array
will be initially zeroed. Otherwise, `size_or_initializer' is a sequence
which is used to initialize the array and whose length determines the length
of the array.

Se `lock' for @code{True} (o padrão), então um novo objeto de trava é criado para sincronizar o acesso ao valor. Se `lock' for um objeto @ref{1683,,Lock} ou @ref{1684,,RLock}, então ele será usado para sincronizar o acesso ao valor. Se `lock' for @code{False}, então o acesso ao objeto retornado não será protegido automaticamente por uma trava, então ele não será necessariamente “seguro para processo”.

Observe que `lock' é um argumento somente-nomeado.

Observe que um vetor de @ref{2fc1,,ctypes.c_char} tem atributos `value' e `raw' que permitem usá-lo para armazenar e recuperar strings.
@end deffn

@menu
* O módulo multiprocessing.sharedctypes: O módulo multiprocessing sharedctypes. 

@end menu

@node O módulo multiprocessing sharedctypes,,,Objetos ctypes compartilhados
@anchor{library/multiprocessing module-multiprocessing sharedctypes}@anchor{9a}@anchor{library/multiprocessing the-multiprocessing-sharedctypes-module}@anchor{3371}
@subsubsection O módulo @code{multiprocessing.sharedctypes}


@geindex module; multiprocessing.sharedctypes

O módulo @ref{9a,,multiprocessing.sharedctypes} fornece funções para alocar objetos @ref{2a,,ctypes} da memória compartilhada que podem ser herdados por processos filhos.

@cartouche
@quotation Nota 
Embora seja possível armazenar um ponteiro na memória compartilhada, lembre-se de que isso se referirá a um local no espaço de endereço de um processo específico. No entanto, é bem provável que o ponteiro seja inválido no contexto de um segundo processo e tentar desreferenciar o ponteiro do segundo processo pode causar um travamento.
@end quotation
@end cartouche

@geindex RawArray() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes RawArray}@anchor{3372}
@deffn {Função} multiprocessing.sharedctypes.RawArray (typecode_or_type, size_or_initializer)

Retorna um vetor de ctypes alocado da memória compartilhada.

`typecode_or_type' determina o tipo dos elementos do vetor retornado: é um tipo ctypes ou um typecode de um caractere do tipo usado pelo módulo @ref{7,,array}. Se `size_or_initializer' for um inteiro, então ele determina o comprimento do vetor, e o vetor será inicialmente zerado. Caso contrário, `size_or_initializer' é uma sequência que é usada para inicializar o vetor e cujo comprimento determina o comprimento do vetor.

Observe que definir e obter um elemento é potencialmente não atômico – use @ref{3373,,Array()} para garantir que o acesso seja sincronizado automaticamente usando uma trava.
@end deffn

@geindex RawValue() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes RawValue}@anchor{3374}
@deffn {Função} multiprocessing.sharedctypes.RawValue (typecode_or_type, *args)

Retorna um objeto ctypes alocado da memória compartilhada.

`typecode_or_type' determina o tipo do objeto retornado: é um tipo ctypes ou um typecode de um caractere do tipo usado pelo módulo @ref{7,,array}. `*args' é passado para o construtor para o tipo.

Observe que definir e obter o valor é potencialmente não atômico – use @ref{3375,,Value()} para garantir que o acesso seja sincronizado automaticamente usando uma trava.

Observe que um vetor de @ref{2fc1,,ctypes.c_char} tem atributos @code{value} e @code{raw} que permitem usá-la para armazenar e recuperar strings – veja a documentação de @ref{2a,,ctypes}.
@end deffn

@geindex Array() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes Array}@anchor{3373}
@deffn {Função} multiprocessing.sharedctypes.Array (typecode_or_type, size_or_initializer, *, lock=True, ctx=None)

O mesmo que @ref{3372,,RawArray()}, exceto que dependendo do valor de `lock', um invólucro de sincronização seguro para processo pode ser retornado em vez de um vetor de ctypes brutos.

Se `lock' for @code{True} (o padrão), então um novo objeto de trava é criado para sincronizar o acesso ao valor. Se `lock' for um objeto @ref{1683,,Lock} ou @ref{1684,,RLock}, então ele será usado para sincronizar o acesso ao valor. Se `lock' for @code{False}, então o acesso ao objeto retornado não será protegido automaticamente por uma trava, então ele não será necessariamente “seguro para processo”.

`ctx' is a context object, or @code{None} (use the current context). If @code{None},
calling this may set the global start method. See
@ref{333c,,Global start method} for more details.

Note that `lock' and `ctx' are keyword-only parameters.
@end deffn

@geindex Value() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes Value}@anchor{3375}
@deffn {Função} multiprocessing.sharedctypes.Value (typecode_or_type, *args, lock=True, ctx=None)

O mesmo que @ref{3374,,RawValue()}, exceto que dependendo do valor de `lock', um invólucro de sincronização seguro para processo pode ser retornado em vez de um objeto ctypes brutos.

Se `lock' for @code{True} (o padrão), então um novo objeto de trava é criado para sincronizar o acesso ao valor. Se `lock' for um objeto @ref{1683,,Lock} ou @ref{1684,,RLock}, então ele será usado para sincronizar o acesso ao valor. Se `lock' for @code{False}, então o acesso ao objeto retornado não será protegido automaticamente por uma trava, então ele não será necessariamente “seguro para processo”.

`ctx' is a context object, or @code{None} (use the current context). If @code{None},
calling this may set the global start method. See
@ref{333c,,Global start method} for more details.

Note that `lock' and `ctx' are keyword-only parameters.
@end deffn

@geindex copy() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes copy}@anchor{3376}
@deffn {Função} multiprocessing.sharedctypes.copy (obj)

Retorna um objeto ctypes alocado da memória compartilhada que é uma cópia do objeto ctypes `obj'.
@end deffn

@geindex synchronized() (no módulo multiprocessing.sharedctypes)
@anchor{library/multiprocessing multiprocessing sharedctypes synchronized}@anchor{e5e}
@deffn {Função} multiprocessing.sharedctypes.synchronized (obj, lock=None, ctx=None)

Retorna um objeto invólucro seguro para o processo para um objeto ctypes que usa `lock' para sincronizar o acesso. Se `lock' for @code{None} (o padrão), então um objeto @ref{1684,,multiprocessing.RLock} é criado automaticamente.

`ctx' is a context object, or @code{None} (use the current context). If @code{None},
calling this may set the global start method. See
@ref{333c,,Global start method} for more details.

A synchronized wrapper will have two methods in addition to those of the
object it wraps: @code{get_obj()} returns the wrapped object and
@code{get_lock()} returns the lock object used for synchronization.

Note that accessing the ctypes object through the wrapper can be a lot slower
than accessing the raw ctypes object.


Alterado na versão 3.5: Synchronized objects support the @ref{5d4,,context manager} protocol.

@end deffn

The table below compares the syntax for creating shared ctypes objects from
shared memory with the normal ctypes syntax.  (In the table @code{MyStruct} is some
subclass of @ref{1d4,,ctypes.Structure}.)


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ctypes

@tab

sharedctypes using type

@tab

sharedctypes using 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


Below is an example where a number of ctypes objects are modified by a child
process:

@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

The results printed are

@example
49
0.1111111111111111
HELLO WORLD
[(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]
@end example

@node Gerenciadores,Objetos proxies,Objetos ctypes compartilhados,Referência<3>
@anchor{library/multiprocessing managers}@anchor{3377}@anchor{library/multiprocessing multiprocessing-managers}@anchor{334f}
@subsubsection Gerenciadores


Managers provide a way to create data which can be shared between different
processes, including sharing over a network between processes running on
different machines. A manager object controls a server process which manages
`shared objects'.  Other processes can access the shared objects by using
proxies.

@geindex built-in function; multiprocessing.Manager()
@anchor{library/multiprocessing multiprocessing Manager}@anchor{cda}
@deffn {Função} multiprocessing.Manager ()

Retorna um objeto @ref{3378,,SyncManager} inicializado que pode ser usado para compartilhar objetos entre processos. O objeto gerenciador retornado corresponde a um processo filho gerado e tem métodos que criarão objetos compartilhados e retornarão proxies correspondentes.
@end deffn

@geindex module; multiprocessing.managers
@anchor{library/multiprocessing module-multiprocessing managers}@anchor{97}
Manager processes will be shutdown as soon as they are garbage collected or
their parent process exits.  The manager classes are defined in the
@ref{97,,multiprocessing.managers} module:

@geindex BaseManager (classe em multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers BaseManager}@anchor{3379}
@deffn {Classe} multiprocessing.managers.BaseManager (address=None, authkey=None, serializer='pickle', ctx=None, *, shutdown_timeout=1.0)

Criando um objeto BaseManager.

Once created one should call @ref{337a,,start()} or @code{get_server().serve_forever()} to ensure
that the manager object refers to a started manager process.

`address' is the address on which the manager process listens for new
connections.  If `address' is @code{None} then an arbitrary one is chosen.

`authkey' is the authentication key which will be used to check the
validity of incoming connections to the server process.  If
`authkey' is @code{None} then @code{current_process().authkey} is used.
Otherwise `authkey' is used and it must be a byte string.

`serializer' must be @code{'pickle'} (use @ref{a6,,pickle} serialization) or
@code{'xmlrpclib'} (use @ref{12e,,xmlrpc.client} serialization).

`ctx' is a context object, or @code{None} (use the current context). If @code{None},
calling this may set the global start method. See
@ref{333c,,Global start method} for more details.

`shutdown_timeout' is a timeout in seconds used to wait until the process
used by the manager completes in the @ref{337b,,shutdown()} method. If the
shutdown times out, the process is terminated. If terminating the process
also times out, the process is killed.


Alterado na versão 3.11: Added the `shutdown_timeout' parameter.


@geindex start() (método multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager start}@anchor{337a}
@deffn {Método} start ([initializer[, initargs]])

Start a subprocess to start the manager.  If `initializer' is not @code{None}
then the subprocess will call @code{initializer(*initargs)} when it starts.
@end deffn

@geindex get_server() (método multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager get_server}@anchor{337c}
@deffn {Método} get_server ()

Returns a @code{Server} object which represents the actual server under
the control of the Manager. The @code{Server} object supports the
@code{serve_forever()} method:

@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} additionally has an @ref{337d,,address} attribute.
@end deffn

@geindex connect() (método multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager connect}@anchor{337e}
@deffn {Método} connect ()

Connect a local manager object to a remote manager process:

@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 multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager shutdown}@anchor{337b}
@deffn {Método} shutdown ()

Stop the process used by the manager.  This is only available if
@ref{337a,,start()} has been used to start the server process.

This can be called multiple times.
@end deffn

@geindex register() (método multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager register}@anchor{337f}
@deffn {Método} register (typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])

A classmethod which can be used for registering a type or callable with
the manager class.

`typeid' is a “type identifier” which is used to identify a particular
type of shared object.  This must be a string.

`callable' is a callable used for creating objects for this type
identifier.  If a manager instance will be connected to the
server using the @ref{337e,,connect()} method, or if the
`create_method' argument is @code{False} then this can be left as
@code{None}.

`proxytype' is a subclass of @ref{3380,,BaseProxy} which is used to create
proxies for shared objects with this `typeid'.  If @code{None} then a proxy
class is created automatically.

`exposed' is used to specify a sequence of method names which proxies for
this typeid should be allowed to access using
@ref{3381,,BaseProxy._callmethod()}.  (If `exposed' is @code{None} then
@code{proxytype._exposed_} is used instead if it exists.)  In the case
where no exposed list is specified, all “public methods” of the shared
object will be accessible.  (Here a “public method” means any attribute
which has a @ref{558,,__call__()} method and whose name does not begin
with @code{'_'}.)

`method_to_typeid' is a mapping used to specify the return type of those
exposed methods which should return a proxy.  It maps method names to
typeid strings.  (If `method_to_typeid' is @code{None} then
@code{proxytype._method_to_typeid_} is used instead if it exists.)  If a
method’s name is not a key of this mapping or if the mapping is @code{None}
then the object returned by the method will be copied by value.

`create_method' determines whether a method should be created with name
`typeid' which can be used to tell the server process to create a new
shared object and return a proxy for it.  By default it is @code{True}.
@end deffn

@ref{3379,,BaseManager} instances also have one read-only property:

@geindex address (atributo multiprocessing.managers.BaseManager)
@anchor{library/multiprocessing multiprocessing managers BaseManager address}@anchor{337d}
@deffn {Atributo} address

The address used by the manager.
@end deffn


Alterado na versão 3.3: Manager objects support the context management protocol – see
@ref{214e,,Tipos de Gerenciador de Contexto}.  @ref{23dc,,__enter__()} starts the
server process (if it has not already started) and then returns the
manager object.  @ref{23dd,,__exit__()} calls @ref{337b,,shutdown()}.

In previous versions @ref{23dc,,__enter__()} did not start the
manager’s server process if it was not already started.

@end deffn

@geindex SyncManager (classe em multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers SyncManager}@anchor{3378}
@deffn {Classe} multiprocessing.managers.SyncManager

A subclass of @ref{3379,,BaseManager} which can be used for the synchronization
of processes.  Objects of this type are returned by
@ref{cda,,multiprocessing.Manager()}.

Its methods create and return @ref{cd9,,Objetos proxies} for a
number of commonly used data types to be synchronized across processes.
This notably includes shared lists and dictionaries.

@geindex Barrier() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Barrier}@anchor{3382}
@deffn {Método} Barrier (parties[, action[, timeout]])

Create a shared @ref{1223,,threading.Barrier} object and return a
proxy for it.


Adicionado na versão 3.3.

@end deffn

@geindex BoundedSemaphore() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager BoundedSemaphore}@anchor{3383}
@deffn {Método} BoundedSemaphore ([value])

Create a shared @ref{1196,,threading.BoundedSemaphore} object and return a
proxy for it.
@end deffn

@geindex Condition() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Condition}@anchor{3384}
@deffn {Método} Condition ([lock])

Create a shared @ref{1194,,threading.Condition} object and return a proxy for
it.

If `lock' is supplied then it should be a proxy for a
@ref{176d,,threading.Lock} or @ref{2de,,threading.RLock} object.


Alterado na versão 3.3: O método @ref{330e,,wait_for()} foi adicionado.

@end deffn

@geindex Event() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Event}@anchor{3385}
@deffn {Método} Event ()

Create a shared @ref{1197,,threading.Event} object and return a proxy for it.
@end deffn

@geindex Lock() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Lock}@anchor{13de}
@deffn {Método} Lock ()

Create a shared @ref{176d,,threading.Lock} object and return a proxy for it.
@end deffn

@geindex Namespace() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Namespace}@anchor{3386}
@deffn {Método} Namespace ()

Create a shared @ref{3335,,Namespace} object and return a proxy for it.
@end deffn

@geindex Queue() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Queue}@anchor{2eaa}
@deffn {Método} Queue ([maxsize])

Create a shared @ref{13db,,queue.Queue} object and return a proxy for it.
@end deffn

@geindex RLock() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager RLock}@anchor{13df}
@deffn {Método} RLock ()

Create a shared @ref{2de,,threading.RLock} object and return a proxy for it.
@end deffn

@geindex Semaphore() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Semaphore}@anchor{13e0}
@deffn {Método} Semaphore ([value])

Create a shared @ref{1195,,threading.Semaphore} object and return a proxy for
it.
@end deffn

@geindex Array() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Array}@anchor{3387}
@deffn {Método} Array (typecode, sequence)

Create an array and return a proxy for it.
@end deffn

@geindex Value() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager Value}@anchor{3388}
@deffn {Método} Value (typecode, value)

Create an object with a writable @code{value} attribute and return a proxy
for it.
@end deffn

@geindex dict() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager dict}@anchor{3389}
@deffn {Método} dict ()

@deffnx {Método} dict (mapping)

@deffnx {Método} dict (sequence)

Create a shared @ref{256,,dict} object and return a proxy for it.
@end deffn

@geindex list() (método multiprocessing.managers.SyncManager)
@anchor{library/multiprocessing multiprocessing managers SyncManager list}@anchor{338a}
@deffn {Método} list ()

@deffnx {Método} list (sequence)

Create a shared @ref{611,,list} object and return a proxy for it.
@end deffn


Alterado na versão 3.6: Objetos compartilhados podem ser aninhados. Por exemplo, em um objeto contêiner compartilhado, como uma lista compartilhada, é possível conter outros objeto compartilhados que serão gerenciados e sincronizados pelo @ref{3378,,SyncManager}.

@end deffn

@geindex Namespace (classe em multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers Namespace}@anchor{3335}
@deffn {Classe} multiprocessing.managers.Namespace

A type that can register with @ref{3378,,SyncManager}.

A namespace object has no public methods, but does have writable attributes.
Its representation shows the values of its attributes.

However, when using a proxy for a namespace object, an attribute beginning
with @code{'_'} will be an attribute of the proxy and not an attribute of the
referent:

@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
* Customized managers:: 
* Using a remote manager:: 

@end menu

@node Customized managers,Using a remote manager,,Gerenciadores
@anchor{library/multiprocessing customized-managers}@anchor{338b}
@subsubsection Customized managers


To create one’s own manager, one creates a subclass of @ref{3379,,BaseManager} and
uses the @ref{337f,,register()} classmethod to register new types or
callables with the manager class.  For example:

@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 Using a remote manager,,Customized managers,Gerenciadores
@anchor{library/multiprocessing using-a-remote-manager}@anchor{338c}
@subsubsection Using a remote manager


It is possible to run a manager server on one machine and have clients use it
from other machines (assuming that the firewalls involved allow it).

Running the following commands creates a server for a single shared queue which
remote clients can access:

@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

One client can access the server as follows:

@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

Another client can also use it:

@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

Local processes can also access that queue, using the code from above on the
client to access it remotely:

@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 proxies,Process Pools,Gerenciadores,Referência<3>
@anchor{library/multiprocessing multiprocessing-proxy-objects}@anchor{cd9}@anchor{library/multiprocessing proxy-objects}@anchor{338d}
@subsubsection Objetos proxies


Um proxy é um objeto que `refere-se' a um objeto compartilhado que reside (presumivelmente) em um processo diferente.  Dizemos que o objeto compartilhado é o `referente' do proxy.  Vários objetos proxies podem ter o mesmo referente.

Um proxy objeto tem métodos que invocam métodos correspondes de seu referente (embora nem todo método do referente esteja necessariamente disponível por meio do proxy).  Dessa forma, um proxy pode ser usado da mesma forma que seu 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

Observe que, ao aplicar @ref{44c,,str()} a um proxy, o retorno representará o referente, enquanto que ao aplicar o @ref{800,,repr()}, o retorno representará o proxy.

Um aspecto importante dos objetos proxies é o fato de que eles podem ser serializados com pickle, portanto podem ser transferidos entre processos.  Dessa forma, um referente pode conter @ref{cd9,,Objetos proxies}.  Isso permite o aninhamento dessas listas e dicionários gerenciados e outros @ref{cd9,,Objetos proxies}:

@example
>>> a = manager.list()
>>> b = manager.list()
>>> a.append(b)         # referente de a agora contém referente de b
>>> print(a, b)
[<ListProxy object, typeid 'list' at ...>] []
>>> b.append('hello')
>>> print(a[0], b)
['hello'] ['hello']
@end example

Da mesma forma, os proxies de dicionários e listas podem ser aninhados um dentro do outro:

@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

Se objetos padrões (não-proxy) de @ref{611,,list} ou @ref{256,,dict} estiverem contidos em um referente, as modificações nesses mutáveis não serão propagadas pelo gerente porque o proxy não tem como saber quando os valores contidos nele são modificados.  No entanto, o armazenamento de um valor em um proxy contêiner (que aciona um @code{__setitem__} no objeto proxy) se propaga pelo gerenciador e, portanto, para modificar efetivamente esse item, é possível reatribuir o valor modificado ao proxy contêiner:

@example
# cria um proxy para uma lista e adicionar um objeto mutável (um dicionário)
lproxy = manager.list()
lproxy.append(@{@})
# agora modifica o dicionário
d = lproxy[0]
d['a'] = 1
d['b'] = 2
# neste ponto, as mudanças em d não estão ainda sincronizadas, mas
# atualizando o dicionário, o proxy é notificado da mudança
lproxy[0] = d
@end example

Essa abordagem talvez seja menos conveniente do que usar @ref{cd9,,Objetos proxies} aninhados para a maioria dos casos de uso, mas também demonstra um nível de controle sobre a sincronização.

@cartouche
@quotation Nota 
Os tipos de proxies em @ref{94,,multiprocessing} não fazem nada com as comparações de valor.  Portanto, por exemplo, temos:

@example
>>> manager.list([1,2,3]) == [1,2,3]
False
@end example

Em vez disso, deve-se usar uma cópia do referente ao fazer comparações.
@end quotation
@end cartouche

@geindex BaseProxy (classe em multiprocessing.managers)
@anchor{library/multiprocessing multiprocessing managers BaseProxy}@anchor{3380}
@deffn {Classe} multiprocessing.managers.BaseProxy

Proxy objects are instances of subclasses of @ref{3380,,BaseProxy}.

@geindex _callmethod() (método multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy _callmethod}@anchor{3381}
@deffn {Método} _callmethod (methodname[, args[, kwds]])

Call and return the result of a method of the proxy’s referent.

If @code{proxy} is a proxy whose referent is @code{obj} then the expression

@example
proxy._callmethod(methodname, args, kwds)
@end example

will evaluate the expression

@example
getattr(obj, methodname)(*args, **kwds)
@end example

in the manager’s process.

The returned value will be a copy of the result of the call or a proxy to
a new shared object – see documentation for the `method_to_typeid'
argument of @ref{337f,,BaseManager.register()}.

If an exception is raised by the call, then is re-raised by
@ref{3381,,_callmethod()}.  If some other exception is raised in the manager’s
process then this is converted into a @code{RemoteError} exception and is
raised by @ref{3381,,_callmethod()}.

Note in particular that an exception will be raised if `methodname' has
not been `exposed'.

An example of the usage of @ref{3381,,_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 multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy _getvalue}@anchor{338e}
@deffn {Método} _getvalue ()

Return a copy of the referent.

If the referent is unpicklable then this will raise an exception.
@end deffn

@geindex __repr__() (método multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy __repr__}@anchor{338f}
@deffn {Método} __repr__ ()

Return a representation of the proxy object.
@end deffn

@geindex __str__() (método multiprocessing.managers.BaseProxy)
@anchor{library/multiprocessing multiprocessing managers BaseProxy __str__}@anchor{3390}
@deffn {Método} __str__ ()

Return the representation of the referent.
@end deffn
@end deffn

@menu
* Limpeza: Limpeza<2>. 

@end menu

@node Limpeza<2>,,,Objetos proxies
@anchor{library/multiprocessing cleanup}@anchor{3391}
@subsubsection Limpeza


A proxy object uses a weakref callback so that when it gets garbage collected it
deregisters itself from the manager which owns its referent.

A shared object gets deleted from the manager process when there are no longer
any proxies referring to it.

@node Process Pools,Listeners and Clients,Objetos proxies,Referência<3>
@anchor{library/multiprocessing module-multiprocessing pool}@anchor{98}@anchor{library/multiprocessing process-pools}@anchor{3392}
@subsubsection Process Pools


@geindex module; multiprocessing.pool

One can create a pool of processes which will carry out tasks submitted to it
with the @ref{f9f,,Pool} class.

@geindex Pool (classe em multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool Pool}@anchor{f9f}
@deffn {Classe} multiprocessing.pool.Pool ([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])

A process pool object which controls a pool of worker processes to which jobs
can be submitted.  It supports asynchronous results with timeouts and
callbacks and has a parallel map implementation.

`processes' is the number of worker processes to use.  If `processes' is
@code{None} then the number returned by @ref{1c4,,os.process_cpu_count()} is used.

If `initializer' is not @code{None} then each worker process will call
@code{initializer(*initargs)} when it starts.

`maxtasksperchild' is the number of tasks a worker process can complete
before it will exit and be replaced with a fresh worker process, to enable
unused resources to be freed. The default `maxtasksperchild' is @code{None}, which
means worker processes will live as long as the pool.

`context' can be used to specify the context used for starting
the worker processes.  Usually a pool is created using the
function @code{multiprocessing.Pool()} or the @ref{f9f,,Pool()} method
of a context object.  In both cases `context' is set
appropriately. If @code{None}, calling this function will have the side effect
of setting the current global start method if it has not been set already.
See the @code{get_context()} function.

Note that the methods of the pool object should only be called by
the process which created the pool.

@cartouche
@quotation Aviso 
@ref{98,,multiprocessing.pool} objects have internal resources that need to be
properly managed (like any other resource) by using the pool as a context manager
or by calling @ref{3393,,close()} and @ref{3394,,terminate()} manually. Failure to do this
can lead to the process hanging on finalization.

Note that it is `not correct' to rely on the garbage collector to destroy the pool
as CPython does not assure that the finalizer of the pool will be called
(see @ref{1033,,object.__del__()} for more information).
@end quotation
@end cartouche


Alterado na versão 3.2: Added the `maxtasksperchild' parameter.



Alterado na versão 3.4: Adicionado o parâmetro `context'.



Alterado na versão 3.13: `processes' uses @ref{1c4,,os.process_cpu_count()} by default, instead of
@ref{1c5,,os.cpu_count()}.


@cartouche
@quotation Nota 
Worker processes within a @ref{f9f,,Pool} typically live for the complete
duration of the Pool’s work queue. A frequent pattern found in other
systems (such as Apache, mod_wsgi, etc) to free resources held by
workers is to allow a worker within a pool to complete only a set
amount of work before being exiting, being cleaned up and a new
process spawned to replace the old one. The `maxtasksperchild'
argument to the @ref{f9f,,Pool} exposes this ability to the end user.
@end quotation
@end cartouche

@geindex apply() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool apply}@anchor{13dc}
@deffn {Método} apply (func[, args[, kwds]])

Call `func' with arguments `args' and keyword arguments `kwds'.  It blocks
until the result is ready. Given this blocks, @ref{13dd,,apply_async()} is
better suited for performing work in parallel. Additionally, `func'
is only executed in one of the workers of the pool.
@end deffn

@geindex apply_async() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool apply_async}@anchor{13dd}
@deffn {Método} apply_async (func[, args[, kwds[, callback[, error_callback]]]])

A variant of the @ref{13dc,,apply()} method which returns a
@ref{3395,,AsyncResult} object.

If `callback' is specified then it should be a callable which accepts a
single argument.  When the result becomes ready `callback' is applied to
it, that is unless the call failed, in which case the `error_callback'
is applied instead.

If `error_callback' is specified then it should be a callable which
accepts a single argument.  If the target function fails, then
the `error_callback' is called with the exception instance.

Callbacks should complete immediately since otherwise the thread which
handles the results will get blocked.
@end deffn

@geindex map() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool map}@anchor{1124}
@deffn {Método} map (func, iterable[, chunksize])

A parallel equivalent of the @ref{867,,map()} built-in function (it supports only
one `iterable' argument though, for multiple iterables see @ref{1121,,starmap()}).
It blocks until the result is ready.

This method chops the iterable into a number of chunks which it submits to
the process pool as separate tasks.  The (approximate) size of these
chunks can be specified by setting `chunksize' to a positive integer.

Note that it may cause high memory usage for very long iterables. Consider
using @ref{3396,,imap()} or @ref{3397,,imap_unordered()} with explicit `chunksize'
option for better efficiency.
@end deffn

@geindex map_async() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool map_async}@anchor{1125}
@deffn {Método} map_async (func, iterable[, chunksize[, callback[, error_callback]]])

A variant of the @ref{1124,,map()} method which returns a
@ref{3395,,AsyncResult} object.

If `callback' is specified then it should be a callable which accepts a
single argument.  When the result becomes ready `callback' is applied to
it, that is unless the call failed, in which case the `error_callback'
is applied instead.

If `error_callback' is specified then it should be a callable which
accepts a single argument.  If the target function fails, then
the `error_callback' is called with the exception instance.

Callbacks should complete immediately since otherwise the thread which
handles the results will get blocked.
@end deffn

@geindex imap() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool imap}@anchor{3396}
@deffn {Método} imap (func, iterable[, chunksize])

A lazier version of @ref{1124,,map()}.

The `chunksize' argument is the same as the one used by the @ref{1124,,map()}
method.  For very long iterables using a large value for `chunksize' can
make the job complete `much' faster than using the default value of
@code{1}.

Also if `chunksize' is @code{1} then the @code{next()} method of the iterator
returned by the @ref{3396,,imap()} method has an optional `timeout' parameter:
@code{next(timeout)} will raise @ref{3349,,multiprocessing.TimeoutError} if the
result cannot be returned within `timeout' seconds.
@end deffn

@geindex imap_unordered() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool imap_unordered}@anchor{3397}
@deffn {Método} imap_unordered (func, iterable[, chunksize])

The same as @ref{3396,,imap()} except that the ordering of the results from the
returned iterator should be considered arbitrary.  (Only when there is
only one worker process is the order guaranteed to be “correct”.)
@end deffn

@geindex starmap() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool starmap}@anchor{1121}
@deffn {Método} starmap (func, iterable[, chunksize])

Like @ref{1124,,map()} except that the
elements of the `iterable' are expected to be iterables that are
unpacked as arguments.

Hence an `iterable' of @code{[(1,2), (3, 4)]} results in @code{[func(1,2),
func(3,4)]}.


Adicionado na versão 3.3.

@end deffn

@geindex starmap_async() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool starmap_async}@anchor{1122}
@deffn {Método} starmap_async (func, iterable[, chunksize[, callback[, error_callback]]])

A combination of @ref{1121,,starmap()} and @ref{1125,,map_async()} that iterates over
`iterable' of iterables and calls `func' with the iterables unpacked.
Returns a result object.


Adicionado na versão 3.3.

@end deffn

@geindex close() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool close}@anchor{3393}
@deffn {Método} close ()

Prevents any more tasks from being submitted to the pool.  Once all the
tasks have been completed the worker processes will exit.
@end deffn

@geindex terminate() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool terminate}@anchor{3394}
@deffn {Método} terminate ()

Stops the worker processes immediately without completing outstanding
work.  When the pool object is garbage collected @ref{3394,,terminate()} will be
called immediately.
@end deffn

@geindex join() (método multiprocessing.pool.Pool)
@anchor{library/multiprocessing multiprocessing pool Pool join}@anchor{3398}
@deffn {Método} join ()

Wait for the worker processes to exit.  One must call @ref{3393,,close()} or
@ref{3394,,terminate()} before using @ref{3398,,join()}.
@end deffn


Alterado na versão 3.3: Pool objects now support the context management protocol – see
@ref{214e,,Tipos de Gerenciador de Contexto}.  @ref{23dc,,__enter__()} returns the
pool object, and @ref{23dd,,__exit__()} calls @ref{3394,,terminate()}.

@end deffn

@geindex AsyncResult (classe em multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool AsyncResult}@anchor{3395}
@deffn {Classe} multiprocessing.pool.AsyncResult

The class of the result returned by @ref{13dd,,Pool.apply_async()} and
@ref{1125,,Pool.map_async()}.

@geindex get() (método multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult get}@anchor{3399}
@deffn {Método} get ([timeout])

Return the result when it arrives.  If `timeout' is not @code{None} and the
result does not arrive within `timeout' seconds then
@ref{3349,,multiprocessing.TimeoutError} is raised.  If the remote call raised
an exception then that exception will be reraised by @ref{3399,,get()}.
@end deffn

@geindex wait() (método multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult wait}@anchor{339a}
@deffn {Método} wait ([timeout])

Wait until the result is available or until `timeout' seconds pass.
@end deffn

@geindex ready() (método multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult ready}@anchor{339b}
@deffn {Método} ready ()

Return whether the call has completed.
@end deffn

@geindex successful() (método multiprocessing.pool.AsyncResult)
@anchor{library/multiprocessing multiprocessing pool AsyncResult successful}@anchor{339c}
@deffn {Método} successful ()

Return whether the call completed without raising an exception.  Will
raise @ref{202,,ValueError} if the result is not ready.


Alterado na versão 3.7: If the result is not ready, @ref{202,,ValueError} is raised instead of
@ref{6a9,,AssertionError}.

@end deffn
@end deffn

The following example demonstrates the use of a 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 Listeners and Clients,Authentication keys,Process Pools,Referência<3>
@anchor{library/multiprocessing listeners-and-clients}@anchor{339d}@anchor{library/multiprocessing module-multiprocessing connection}@anchor{95}@anchor{library/multiprocessing multiprocessing-listeners-clients}@anchor{3361}
@subsubsection Listeners and Clients


@geindex module; multiprocessing.connection

Usually message passing between processes is done using queues or by using
@ref{111f,,Connection} objects returned by
@ref{3330,,Pipe()}.

However, the @ref{95,,multiprocessing.connection} module allows some extra
flexibility.  It basically gives a high level message oriented API for dealing
with sockets or Windows named pipes.  It also has support for `digest
authentication' using the @ref{6a,,hmac} module, and for polling
multiple connections at the same time.

@geindex deliver_challenge() (no módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection deliver_challenge}@anchor{339e}
@deffn {Função} multiprocessing.connection.deliver_challenge (connection, authkey)

Send a randomly generated message to the other end of the connection and wait
for a reply.

If the reply matches the digest of the message using `authkey' as the key
then a welcome message is sent to the other end of the connection.  Otherwise
@ref{3348,,AuthenticationError} is raised.
@end deffn

@geindex answer_challenge() (no módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection answer_challenge}@anchor{339f}
@deffn {Função} multiprocessing.connection.answer_challenge (connection, authkey)

Receive a message, calculate the digest of the message using `authkey' as the
key, and then send the digest back.

If a welcome message is not received, then
@ref{3348,,AuthenticationError} is raised.
@end deffn

@geindex Client() (no módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Client}@anchor{33a0}
@deffn {Função} multiprocessing.connection.Client (address[, family[, authkey]])

Attempt to set up a connection to the listener which is using address
`address', returning a @ref{111f,,Connection}.

The type of the connection is determined by `family' argument, but this can
generally be omitted since it can usually be inferred from the format of
`address'. (See @ref{33a1,,Formatos de Endereços})

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{3348,,AuthenticationError} is raised if authentication fails.
See @ref{3345,,Authentication keys}.
@end deffn

@geindex Listener (classe em multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection Listener}@anchor{179e}
@deffn {Classe} multiprocessing.connection.Listener ([address[, family[, backlog[, authkey]]]])

A wrapper for a bound socket or Windows named pipe which is ‘listening’ for
connections.

`address' is the address to be used by the bound socket or named pipe of the
listener object.

@cartouche
@quotation Nota 
If an address of ‘0.0.0.0’ is used, the address will not be a connectable
end point on Windows. If you require a connectable end-point,
you should use ‘127.0.0.1’.
@end quotation
@end cartouche

`family' is the type of socket (or named pipe) to use.  This can be one of
the strings @code{'AF_INET'} (for a TCP socket), @code{'AF_UNIX'} (for a Unix
domain socket) or @code{'AF_PIPE'} (for a Windows named pipe).  Of these only
the first is guaranteed to be available.  If `family' is @code{None} then the
family is inferred from the format of `address'.  If `address' is also
@code{None} then a default is chosen.  This default is the family which is
assumed to be the fastest available.  See
@ref{33a1,,Formatos de Endereços}.  Note that if `family' is
@code{'AF_UNIX'} and address is @code{None} then the socket will be created in a
private temporary directory created using @ref{2a03,,tempfile.mkstemp()}.

If the listener object uses a socket then `backlog' (1 by default) is passed
to the @ref{e8d,,listen()} method of the socket once it has been
bound.

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{3348,,AuthenticationError} is raised if authentication fails.
See @ref{3345,,Authentication keys}.

@geindex accept() (método multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener accept}@anchor{1756}
@deffn {Método} accept ()

Accept a connection on the bound socket or named pipe of the listener
object and return a @ref{111f,,Connection} object.
If authentication is attempted and fails, then
@ref{3348,,AuthenticationError} is raised.
@end deffn

@geindex close() (método multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener close}@anchor{33a2}
@deffn {Método} close ()

Close the bound socket or named pipe of the listener object.  This is
called automatically when the listener is garbage collected.  However it
is advisable to call it explicitly.
@end deffn

Listener objects have the following read-only properties:

@geindex address (atributo multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener address}@anchor{33a3}
@deffn {Atributo} address

The address which is being used by the Listener object.
@end deffn

@geindex last_accepted (atributo multiprocessing.connection.Listener)
@anchor{library/multiprocessing multiprocessing connection Listener last_accepted}@anchor{33a4}
@deffn {Atributo} last_accepted

The address from which the last accepted connection came.  If this is
unavailable then it is @code{None}.
@end deffn


Alterado na versão 3.3: Listener objects now support the context management protocol – see
@ref{214e,,Tipos de Gerenciador de Contexto}.  @ref{23dc,,__enter__()} returns the
listener object, and @ref{23dd,,__exit__()} calls @ref{33a2,,close()}.

@end deffn

@geindex wait() (no módulo multiprocessing.connection)
@anchor{library/multiprocessing multiprocessing connection wait}@anchor{111e}
@deffn {Função} multiprocessing.connection.wait (object_list, timeout=None)

Wait till an object in `object_list' is ready.  Returns the list of
those objects in `object_list' which are ready.  If `timeout' is a
float then the call blocks for at most that many seconds.  If
`timeout' is @code{None} then it will block for an unlimited period.
A negative timeout is equivalent to a zero timeout.

For both POSIX and Windows, an object can appear in `object_list' if
it is


@itemize *

@item 
a readable @ref{111f,,Connection} object;

@item 
a connected and readable @ref{dc9,,socket.socket} object; or

@item 
the @ref{1120,,sentinel} attribute of a
@ref{b6f,,Process} object.
@end itemize

A connection or socket object is ready when there is data available
to be read from it, or the other end has been closed.

`POSIX': @code{wait(object_list, timeout)} almost equivalent
@code{select.select(object_list, [], [], timeout)}.  The difference is
that, if @ref{dc8,,select.select()} is interrupted by a signal, it can
raise @ref{417,,OSError} with an error number of @code{EINTR}, whereas
@ref{111e,,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{15d0,,fileno()} method which returns a
socket handle or pipe handle.  (Note that pipe handles and socket
handles are `not' waitable handles.)


Adicionado na versão 3.3.

@end deffn

`Examples'

The following server code creates a listener which uses @code{'secret password'} as
an authentication key.  It then waits for a connection and sends some data to
the client:

@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

The following code connects to the server and receives some data from the
server:

@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

The following code uses @ref{111e,,wait()} to
wait for messages from multiple processes at once:

@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 Endereços:: 

@end menu

@node Formatos de Endereços,,,Listeners and Clients
@anchor{library/multiprocessing address-formats}@anchor{33a5}@anchor{library/multiprocessing multiprocessing-address-formats}@anchor{33a1}
@subsubsection Formatos de Endereços



@itemize *

@item 
Um endereço @code{'AF_INET'} é uma tupla na forma de @code{(hostname, port)} sendo `hostname' uma string e `port' um inteiro.

@item 
An @code{'AF_UNIX'} address is a string representing a filename on the
filesystem.

@item 
An @code{'AF_PIPE'} address is a string of the form
@code{r'\\.\pipe\@var{PipeName}'}.  To use @ref{33a0,,Client()} to connect to a named
pipe on a remote computer called `ServerName' one should use an address of the
form @code{r'\\@var{ServerName}\pipe\@var{PipeName}'} instead.
@end itemize

Note that any string beginning with two backslashes is assumed by default to be
an @code{'AF_PIPE'} address rather than an @code{'AF_UNIX'} address.

@node Authentication keys,Gerando logs<2>,Listeners and Clients,Referência<3>
@anchor{library/multiprocessing authentication-keys}@anchor{33a6}@anchor{library/multiprocessing multiprocessing-auth-keys}@anchor{3345}
@subsubsection Authentication keys


When one uses @ref{3363,,Connection.recv}, the
data received is automatically
unpickled. Unfortunately unpickling data from an untrusted source is a security
risk. Therefore @ref{179e,,Listener} and @ref{33a0,,Client()} use the @ref{6a,,hmac} module
to provide digest authentication.

An authentication key is a byte string which can be thought of as a
password: once a connection is established both ends will demand proof
that the other knows the authentication key.  (Demonstrating that both
ends are using the same key does `not' involve sending the key over
the connection.)

If authentication is requested but no authentication key is specified then the
return value of @code{current_process().authkey} is used (see
@ref{b6f,,Process}).  This value will be automatically inherited by
any @ref{b6f,,Process} object that the current process creates.
This means that (by default) all processes of a multi-process program will share
a single authentication key which can be used when setting up connections
between themselves.

Suitable authentication keys can also be generated by using @ref{523,,os.urandom()}.

@node Gerando logs<2>,The multiprocessing dummy module,Authentication keys,Referência<3>
@anchor{library/multiprocessing logging}@anchor{33a7}
@subsubsection Gerando logs


Some support for logging is available.  Note, however, that the @ref{87,,logging}
package does not use process shared locks so it is possible (depending on the
handler type) for messages from different processes to get mixed up.

@geindex get_logger() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing get_logger}@anchor{2f05}
@deffn {Função} multiprocessing.get_logger ()

Returns the logger used by @ref{94,,multiprocessing}.  If necessary, a new one
will be created.

When first created the logger has level @ref{2e39,,logging.NOTSET} and no
default handler. Messages sent to this logger will not by default propagate
to the root logger.

Note that on Windows child processes will only inherit the level of the
parent process’s logger – any other customization of the logger will not be
inherited.
@end deffn

@geindex log_to_stderr() (no módulo multiprocessing)
@anchor{library/multiprocessing multiprocessing log_to_stderr}@anchor{33a8}
@deffn {Função} multiprocessing.log_to_stderr (level=None)

This function performs a call to @ref{2f05,,get_logger()} but in addition to
returning the logger created by get_logger, it adds a handler which sends
output to @ref{940,,sys.stderr} using format
@code{'[%(levelname)s/%(processName)s] %(message)s'}.
You can modify @code{levelname} of the logger by passing a @code{level} argument.
@end deffn

Below is an example session with logging turned on:

@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

For a full table of logging levels, see the @ref{87,,logging} module.

@node The multiprocessing dummy module,,Gerando logs<2>,Referência<3>
@anchor{library/multiprocessing module-multiprocessing dummy}@anchor{96}@anchor{library/multiprocessing the-multiprocessing-dummy-module}@anchor{33a9}
@subsubsection The @code{multiprocessing.dummy} module


@geindex module; multiprocessing.dummy

@ref{96,,multiprocessing.dummy} replicates the API of @ref{94,,multiprocessing} but is
no more than a wrapper around the @ref{ed,,threading} module.

In particular, the @code{Pool} function provided by @ref{96,,multiprocessing.dummy}
returns an instance of @ref{1a60,,ThreadPool}, which is a subclass of
@ref{f9f,,Pool} that supports all the same method calls but uses a pool of
worker threads rather than worker processes.

@geindex ThreadPool (classe em multiprocessing.pool)
@anchor{library/multiprocessing multiprocessing pool ThreadPool}@anchor{1a60}
@deffn {Classe} multiprocessing.pool.ThreadPool ([processes[, initializer[, initargs]]])

A thread pool object which controls a pool of worker threads to which jobs
can be submitted.  @ref{1a60,,ThreadPool} instances are fully interface
compatible with @ref{f9f,,Pool} instances, and their resources must also be
properly managed, either by using the pool as a context manager or by
calling @ref{3393,,close()} and
@ref{3394,,terminate()} manually.

`processes' is the number of worker threads to use.  If `processes' is
@code{None} then the number returned by @ref{1c4,,os.process_cpu_count()} is used.

If `initializer' is not @code{None} then each worker process will call
@code{initializer(*initargs)} when it starts.

Unlike @ref{f9f,,Pool}, `maxtasksperchild' and `context' cannot be provided.

@cartouche
@quotation Nota 
A @ref{1a60,,ThreadPool} shares the same interface as @ref{f9f,,Pool}, which
is designed around a pool of processes and predates the introduction of
the @ref{21,,concurrent.futures} module.  As such, it inherits some
operations that don’t make sense for a pool backed by threads, and it
has its own type for representing the status of asynchronous jobs,
@ref{3395,,AsyncResult}, that is not understood by any other libraries.

Users should generally prefer to use
@ref{742,,concurrent.futures.ThreadPoolExecutor}, which has a simpler
interface that was designed around threads from the start, and which
returns @ref{11f1,,concurrent.futures.Future} instances that are
compatible with many other libraries, including @ref{a,,asyncio}.
@end quotation
@end cartouche
@end deffn

@node Programming guidelines,Exemplos<14>,Referência<3>,multiprocessing — Paralelismo baseado em processo
@anchor{library/multiprocessing multiprocessing-programming}@anchor{3329}@anchor{library/multiprocessing programming-guidelines}@anchor{33aa}
@subsubsection Programming guidelines


There are certain guidelines and idioms which should be adhered to when using
@ref{94,,multiprocessing}.

@menu
* All start methods:: 
* The spawn and forkserver start methods:: 

@end menu

@node All start methods,The spawn and forkserver start methods,,Programming guidelines
@anchor{library/multiprocessing all-start-methods}@anchor{33ab}
@subsubsection All start methods


The following applies to all start methods.

Avoid shared state

@quotation

As far as possible one should try to avoid shifting large amounts of data
between processes.

It is probably best to stick to using queues or pipes for communication
between processes rather than using the lower level synchronization
primitives.
@end quotation

Picklability

@quotation

Ensure that the arguments to the methods of proxies are picklable.
@end quotation

Thread safety of proxies

@quotation

Do not use a proxy object from more than one thread unless you protect it
with a lock.

(There is never a problem with different processes using the `same' proxy.)
@end quotation

Joining zombie processes

@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{335d,,active_children()} is called) all completed processes
which have not yet been joined will be joined.  Also calling a finished
process’s @ref{13d9,,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

Better to inherit than pickle/unpickle

@quotation

When using the `spawn' or `forkserver' start methods many types
from @ref{94,,multiprocessing} need to be picklable so that child
processes can use them.  However, one should generally avoid
sending shared objects to other processes using pipes or queues.
Instead you should arrange the program so that a process which
needs access to a shared resource created elsewhere can inherit it
from an ancestor process.
@end quotation

Avoid terminating processes

@quotation

Using the @ref{3327,,Process.terminate}
method to stop a process is liable to
cause any shared resources (such as locks, semaphores, pipes and queues)
currently being used by the process to become broken or unavailable to other
processes.

Therefore it is probably best to only consider using
@ref{3327,,Process.terminate} on processes
which never use any shared resources.
@end quotation

Joining processes that use queues

@quotation

Bear in mind that a process that has put items in a queue will wait before
terminating until all the buffered items are fed by the “feeder” thread to
the underlying pipe.  (The child process can call the
@ref{3353,,Queue.cancel_join_thread}
method of the queue to avoid this behaviour.)

This means that whenever you use a queue you need to make sure that all
items which have been put on the queue will eventually be removed before the
process is joined.  Otherwise you cannot be sure that processes which have
put items on the queue will terminate.  Remember also that non-daemonic
processes will be joined automatically.

An example which will deadlock is the following:

@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

A fix here would be to swap the last two lines (or simply remove the
@code{p.join()} line).
@end quotation

Explicitly pass resources to child processes

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

Apart from making the code (potentially) compatible with Windows
and the other start methods this also ensures that as long as the
child process is still alive the object will not be garbage
collected in the parent process.  This might be important if some
resource is freed when the object is garbage collected in the
parent process.

So for instance

@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

should be rewritten as

@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

Beware of replacing @ref{53d,,sys.stdin} with a “file like object”

@quotation

@ref{94,,multiprocessing} originally unconditionally called:

@example
os.close(sys.stdin.fileno())
@end example

in the @code{multiprocessing.Process._bootstrap()} method — this resulted
in issues with processes-in-processes. This has been changed to:

@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{53d,,sys.stdin()} with a “file-like object”
with output buffering.  This danger is that if multiple processes call
@ref{1f6,,close()} on this file-like object, it could result in the same
data being flushed to the object multiple times, resulting in corruption.

If you write a file-like object and implement your own caching, you can
make it fork-safe by storing the pid whenever you append to the cache,
and discarding the cache when the pid changes. For example:

@example
@@property
def cache(self):
    pid = os.getpid()
    if pid != self._pid:
        self._pid = pid
        self._cache = []
    return self._cache
@end example

For more information, see bpo-5155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5155}, bpo-5313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5313} and bpo-5331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5331}
@end quotation
@anchor{library/multiprocessing multiprocessing-programming-spawn}@anchor{3341}
@node The spawn and forkserver start methods,,All start methods,Programming guidelines
@anchor{library/multiprocessing multiprocessing-programming-forkserver}@anchor{33ac}@anchor{library/multiprocessing the-spawn-and-forkserver-start-methods}@anchor{33ad}
@subsubsection The `spawn' and `forkserver' start methods


There are a few extra restrictions which don’t apply to the `fork'
start method.

More picklability

@quotation

Ensure that all arguments to @ref{b6f,,Process} are
picklable.  Also, if you subclass @code{Process.__init__}, you must make sure
that instances will be picklable when the
@ref{13d8,,Process.start} method is called.
@end quotation

Global variables

@quotation

Bear in mind that if code run in a child process tries to access a global
variable, then the value it sees (if any) may not be the same as the value
in the parent process at the time that @ref{13d8,,Process.start} was called.

However, global variables which are just module level constants cause no
problems.
@end quotation
@anchor{library/multiprocessing multiprocessing-safe-main-import}@anchor{33ae}
Safe importing of main module

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

For example, using the `spawn' or `forkserver' start method
running the following module would fail with a
@ref{195,,RuntimeError}:

@example
from multiprocessing import Process

def foo():
    print('hello')

p = Process(target=foo)
p.start()
@end example

Instead one should protect the “entry point” of the program by using @code{if
__name__ == '__main__':} as follows:

@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

(The @code{freeze_support()} line can be omitted if the program will be run
normally instead of frozen.)

This allows the newly spawned Python interpreter to safely import the module
and then run the module’s @code{foo()} function.

Similar restrictions apply if a pool or manager is created in the main
module.
@end quotation

@node Exemplos<14>,,Programming guidelines,multiprocessing — Paralelismo baseado em processo
@anchor{library/multiprocessing examples}@anchor{33af}@anchor{library/multiprocessing multiprocessing-examples}@anchor{3354}
@subsubsection Exemplos


Demonstration of how to create and use customized managers and proxies:

@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

Using @ref{f9f,,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

An example showing how to use queues to feed tasks to a collection of worker
processes and collect the results:

@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 — Memória compartilhada para acesso direto entre processos,O pacote concurrent,multiprocessing — Paralelismo baseado em processo,Execução Concorrente
@anchor{library/multiprocessing shared_memory doc}@anchor{33b0}@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{33b1}@anchor{library/multiprocessing shared_memory translation-repo}@anchor{33b2}
@subsection @code{multiprocessing.shared_memory} — Memória compartilhada para acesso direto entre processos


@geindex module; multiprocessing.shared_memory

`Código-fonte:' Lib/multiprocessing/shared_memory.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/multiprocessing/shared_memory.py}


Adicionado na versão 3.8.


@geindex Memória compartilhada
@geindex POSIX@comma{} memória compartilhada
@geindex Nomeada@comma{} memória compartilhada


__________________________________________________________________


Este módulo fornece uma classe, @ref{174f,,SharedMemory}, para a alocação e gerenciamento da memória compartilhada a ser acessada por um ou mais processos em uma máquina multicore ou de multiprocessamento simétrico (SMP). Para ajudar com o gerenciamento do ciclo de vida da memória compartilhada especialmente entre processos distintos, uma subclasse de @ref{3379,,BaseManager}, @ref{33b3,,SharedMemoryManager}, também é fornecida no módulo @ref{97,,multiprocessing.managers}.

Neste módulo, memória compartilhada refere-se a blocos de memória compartilhada no “estilo POSIX” (embora não seja necessariamente implementado explicitamente como tal) e não se refere a “memória compartilhada distribuída”. Este estilo de memória compartilhada permite que processos distintos potencialmente leiam e escrevam em uma região comum (ou compartilhada) de memória volátil. Os processos são convencionalmente limitados a ter acesso somente ao próprio espaço de memória de processo mas a memória compartilhada permite o compartilhamento de dados entre processos, evitando a necessidade de enviar mensagens entre processos contendo estes dados. Compartilhar dados diretamente via memória pode fornecer ganhos de desempenho significativos comparado ao compartilhamento de dados via disco ou soquete ou outras comunicações que requerem a serialização/desserialização e cópia dos dados.

@geindex SharedMemory (classe em multiprocessing.shared_memory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory}@anchor{174f}
@deffn {Classe} multiprocessing.shared_memory.SharedMemory (name=None, create=False, size=0, *, track=True)

Cria uma instância da classe @code{SharedMemory} para criar um novo bloco de memória compartilhada ou anexar a um bloco de memória compartilhada existente. A cada bloco de memória compartilhada é atribuído um nome único. Desta forma, um processo pode criar um bloco de memória compartilhada com um nome particular e um processo diferente pode ser anexado a esse mesmo bloco de memória compartilhada usando este mesmo nome.

Como um recurso para compartilhar dados entre processos, os blocos de memória compartilhada podem sobreviver ao processo original que os criou. Quando um processo não precisa mais acessar um bloco de memória compartilhada que ainda pode ser necessário para outros processos, o método @ref{33b4,,close()} deve ser chamado. Quando um bloco de memória compartilhada não é mais necessário para nenhum processo, o método @ref{33b5,,unlink()} deve ser chamado para garantir a limpeza apropriada.

@*Parâmetros: 

@itemize *

@item 
@code{name} (@ref{44c,,str}@code{ | }@code{None}) – O nome único para a memória compartilhada requisitada, especificado como uma string. Ao criar um novo bloco de memória compartilhada, se @code{None} (o padrão) é fornecido para o nome, um novo nome será gerado.

@item 
@code{create} (@ref{468,,bool}) – Controla quando um novo bloco de memória compartilhada é criado (@code{True}) ou um bloco de memória compartilhada existente é anexado (@code{False}).

@item 
@code{size} (@ref{257,,int}) – O número de bytes requeridos ao criar um novo bloco de memória compartilhada. Como algumas plataformas optam por alocar pedaços de memória com base no tamanho da página de memória da própria plataforma, o tamanho exato do bloco de memória compartilhada pode ser maior ou igual ao tamanho requerido. Ao anexar a um bloco de memória compartilhada existente, o parâmetro `size' é ignorado.

@item 
@code{track} (@ref{468,,bool}) – Quando @code{True}, registra o bloco de memória compartilhada com um processo de rastreador de recursos em plataformas onde o sistema operacional não faz isso automaticamente. O rastreador de recursos garante a limpeza adequada da memória compartilhada, mesmo se todos os outros processos com acesso à memória saírem sem fazer isso. Os processos Python criados a partir de um ancestral comum usando os recursos de @ref{94,,multiprocessing} compartilham um único processo de rastreador de recursos, e o tempo de vida dos segmentos de memória compartilhada é manipulado automaticamente entre esses processos. Os processos Python criados de qualquer outra forma receberão seu próprio rastreador de recursos ao acessar a memória compartilhada com `track' habilitado. Isso fará com que a memória compartilhada seja excluída pelo rastreador de recursos do primeiro processo que terminar. Para evitar esse problema, os usuários de @ref{d6,,subprocess} ou processos Python autônomos devem definir `track' como @code{False} quando já houver outro processo em vigor que faça a contabilidade. `track' é ignorado no Windows, que tem seu próprio rastreamento e exclui automaticamente a memória compartilhada quando todos os identificadores para ele foram fechados.
@end itemize



Alterado na versão 3.13: Adicionado o parâmetro `track'.


@geindex close() (método multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory close}@anchor{33b4}
@deffn {Método} close ()

Fecha o identificador/descritor de arquivo para a memória compartilhada desta instância. @ref{33b4,,close()} deve ser chamado quando o acesso ao bloco de memória compartilhada desta instância não for mais necessário. Dependendo do sistema operacional, a memória subjacente pode ou não ser liberada, mesmo que todos os identificadores para ela tenham sido fechados. Para garantir uma limpeza adequada, use o método @ref{33b5,,unlink()}.
@end deffn

@geindex unlink() (método multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory unlink}@anchor{33b5}
@deffn {Método} unlink ()

Exclui o bloco de memória compartilhada subjacente. Isso deve ser chamado apenas uma vez por bloco de memória compartilhada, independentemente do número de handles para ele, mesmo em outros processos. @ref{33b5,,unlink()} e @ref{33b4,,close()} podem ser chamados em qualquer ordem, mas tentar acessar dados dentro de um bloco de memória compartilhada após @ref{33b5,,unlink()} pode resultar em erros de acesso à memória, dependendo da plataforma.

Este método não tem efeito no Windows, onde a única maneira de excluir um bloco de memória compartilhada é fechar todos os identificadores.
@end deffn

@geindex buf (atributo multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory buf}@anchor{33b6}
@deffn {Atributo} buf

Uma visualização de memória do conteúdo do bloco de memória compartilhada.
@end deffn

@geindex name (atributo multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory name}@anchor{33b7}
@deffn {Atributo} name

Acesso somente leitura ao nome único do bloco de memória compartilhada.
@end deffn

@geindex size (atributo multiprocessing.shared_memory.SharedMemory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory size}@anchor{33b8}
@deffn {Atributo} size

Acesso somente leitura ao tamanho em bytes do bloco de memória compartilhada.
@end deffn
@end deffn

O exemplo a seguir demonstra um uso baixo nível de instâncias de @ref{174f,,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])  # Modifica vários de uma só vez
>>> buffer[4] = 100                           # Modifica um único byte de cada vez
>>> # Anexa a um bloco de memória compartilhada existente
>>> shm_b = shared_memory.SharedMemory(shm_a.name)
>>> import array
>>> array.array('b', shm_b.buf[:5])  # Copia os dados para um novo array.array
array('b', [22, 33, 44, 55, 100])
>>> shm_b.buf[:5] = b'howdy'  # Modifica via shm_b usando bytes
>>> bytes(shm_a.buf[:5])      # Acessa via shm_a
b'howdy'
>>> shm_b.close()   # Fecha cada instância de SharedMemory
>>> shm_a.close()
>>> shm_a.unlink()  # Chama unlink uma vez para liberar a memória Compartilhada
@end example

O exemplo a seguir demonstra um uso prático da classe @ref{174f,,SharedMemory} com arrays do NumPy@footnote{https://numpy.org/}, acessando o mesmo @code{numpy.ndarray} de dois consoles Python distintos.

@example
>>> # No primeiro console interativo do Python
>>> import numpy as np
>>> a = np.array([1, 1, 2, 3, 5, 8])  # Inicia com um array de NumPy existente
>>> from multiprocessing import shared_memory
>>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes)
>>> # Agora cria um array de NumPy suportado por memória compartilhada
>>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf)
>>> b[:] = a[:]  # Copia os dados originais para memória compartilhada
>>> b
array([1, 1, 2, 3, 5, 8])
>>> type(b)
<class 'numpy.ndarray'>
>>> type(a)
<class 'numpy.ndarray'>
>>> shm.name  # Não especificamos um nome, então um foi escolhido por nós
'psm_21467_46075'

>>> # No mesmo shell ou em um novo console do Python na mesma máquina
>>> import numpy as np
>>> from multiprocessing import shared_memory
>>> # Anexa ao bloco de memória compartilhada existente
>>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075')
>>> # Observe que a.shape é (6,) e a.dtype é np.int64 neste exemplo
>>> 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])

>>> # De volta ao primeiro console interativo do Python, b reflete essa mudança
>>> b
array([  1,   1,   2,   3,   5, 888])

>>> # Limpeza de dentro do segundo console Python
>>> del c  # Desnecessário; apenas enfatizar a array não é mais usado
>>> existing_shm.close()

>>> # Limpeza de dentro do primeiro console Python
>>> del b  # Desnecessário; apenas enfatizar a array não é mais usado
>>> shm.close()
>>> shm.unlink()  # Libera o bloco de memória compartilhada no final
@end example

@geindex SharedMemoryManager (classe em multiprocessing.managers)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager}@anchor{33b3}
@deffn {Classe} multiprocessing.managers.SharedMemoryManager ([address[, authkey]])

Uma subclasse de @ref{3379,,multiprocessing.managers.BaseManager} que pode ser usada para o gerenciamento dos blocos de memória compartilhada entre processos.

Uma chamada ao método @ref{337a,,start()} em uma instância de @code{SharedMemoryManager} faz com que um novo processo seja iniciado. A única finalidade desse novo processo é gerenciar o ciclo de vida de todos os blocos de memória criados através dele. Para acionar a liberação de todos os blocos de memória gerenciados por este processo, invoque o método @ref{337b,,shutdown()} na instância. Isso aciona uma chamada de @ref{33b5,,unlink()} em todos os objetos @ref{33b9,,SharedMemory} gerenciados por esse processo e então para o processo em si. Ao criar instâncias de @code{SharedMemory} através de um @code{SharedMemoryManager}, evitamos a necessidade de rastrear e acionar manualmente a liberação dos recursos de memória compartilhada.

Esta classe fornece métodos para criar e retornar instâncias de @ref{33b9,,SharedMemory} e para criar um objeto lista ou similar (@ref{33ba,,ShareableList}) apoiado por memória compartilhada.

Consulte @ref{3379,,BaseManager} para obter uma descrição dos argumentos de entrada opcionais herdados `address' e `authkey' e como eles podem ser usados para conectar-se a um serviço @code{SharedMemoryManager} existente de outros processos.

@geindex SharedMemory() (método multiprocessing.managers.SharedMemoryManager)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager SharedMemory}@anchor{33b9}
@deffn {Método} SharedMemory (size)

Cria e retorna um novo objeto @ref{33b9,,SharedMemory} com o `size' especificado em bytes.
@end deffn

@geindex ShareableList() (método multiprocessing.managers.SharedMemoryManager)
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager ShareableList}@anchor{33ba}
@deffn {Método} ShareableList (sequence)

Cria e retorna um novo objeto @ref{33ba,,ShareableList}, inicializado pelos valores da entrada `sequence'.
@end deffn
@end deffn

O exemplo a seguir demonstra os mecanismos básicos de um @ref{33b3,,SharedMemoryManager}:

@example
>>> from multiprocessing.managers import SharedMemoryManager
>>> smm = SharedMemoryManager()
>>> smm.start()  # Inicia o procsso que gerencia os blocos de memória compartilhada
>>> 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()  # Chama unlink() em sl, raw_shm, e another_sl
@end example

O exemplo a seguir retrata um padrão potencialmente mais conveniente para usar objetos @ref{33b3,,SharedMemoryManager} através da instrução @ref{5d2,,with} para garantir que todos os blocos de memória compartilhada são liberados depois que não são mais necessários.

@example
>>> with SharedMemoryManager() as smm:
...     sl = smm.ShareableList(range(2000))
...     # Divide o trabalho entre dois processos, armazenando resultados parciais em sl
...     p1 = Process(target=do_work, args=(sl, 0, 1000))
...     p2 = Process(target=do_work, args=(sl, 1000, 2000))
...     p1.start()
...     p2.start()  # Um multiprocessing.Pool pode ser mais eficiente
...     p1.join()
...     p2.join()   # Espera todo trabalho ser concluído nos dois procssos
...     total_result = sum(sl)  # Consolida os resutlados parciais agora em sl
@end example

Ao usar um @ref{33b3,,SharedMemoryManager} em uma instrução @ref{5d2,,with}, os blocos de memória compartilhada criados utilizando este gerenciador são todos liberados quando o bloco de código com a instrução @code{with} termina sua execução.

@geindex ShareableList (classe em multiprocessing.shared_memory)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList}@anchor{1ae7}
@deffn {Classe} multiprocessing.shared_memory.ShareableList (sequence=None, *, name=None)

Fornece um objeto mutável do tipo lista onde todos os valores armazenados dentro são armazenados em um bloco de memória compartilhada. Isso restringe valores armazenáveis aos seguintes tipos de dados embutidos:


@itemize *

@item 
@ref{257,,int} (com sinal, 64-bit)

@item 
@ref{2f7,,float}

@item 
@ref{468,,bool}

@item 
@ref{44c,,str} (menos de 10M bytes cada quando codificado como UTF-8)

@item 
@ref{1c2,,bytes} (menos de 10M bytes cada)

@item 
@code{None}
@end itemize

Ele também difere notavelmente do tipo embutido @ref{611,,list}, pois essas listas não podem alterar seu comprimento geral (ou seja, sem @code{append()}, @code{insert()}, etc.) e não oferecem suporte à criação dinâmica de novas instâncias @code{ShareableList} por meio de fatiamento.

`sequence' é usado para preencher um @code{ShareableList} com valores. Defina como @code{None} para anexar a uma @code{ShareableList} já existente pelo seu nome único de memória compartilhada.

`name' é um nome único para a memória compartilhada requerida, como descrito na definição de @ref{174f,,SharedMemory}. Ao anexar a uma @code{ShareableList} já existente, deve-se especificar o nome único do bloco de memória compartilhada e definir `sequence' como @code{None}.

@cartouche
@quotation Nota 
Existe um problema conhecido para os valores @ref{1c2,,bytes} e @ref{44c,,str}. Se eles terminarem com bytes ou caracteres nulos @code{\x00}, eles podem ser `silenciosamente removidos' ao buscá-los pelo índice da @code{ShareableList}. Esse comportamento @code{.rstrip(b'\x00')} é considerado um bug e pode desaparecer no futuro. Veja gh-106939@footnote{https://github.com/python/cpython/issues/106939}.
@end quotation
@end cartouche

Para aplicações onde a remoção de nulos finais é um problema, contorne-o sempre anexando incondicionalmente um byte extra diferente de 0 ao final de tais valores ao armazená-los e removendo-os incondicionalmente ao buscá-los:

@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 multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList count}@anchor{33bb}
@deffn {Método} count (value)

Retorna o número de ocorrências de `value'.
@end deffn

@geindex index() (método multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList index}@anchor{33bc}
@deffn {Método} index (value)

Retorna a primeira posição do índice de `value'. Levanta @ref{202,,ValueError} se `value' não estiver presente.
@end deffn

@geindex format (atributo multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList format}@anchor{33bd}
@deffn {Atributo} format

Atributo somente leitura contendo o formato de empacotamento @ref{d5,,struct} usado por todos os valores armazenados atualmente.
@end deffn

@geindex shm (atributo multiprocessing.shared_memory.ShareableList)
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList shm}@anchor{33be}
@deffn {Atributo} shm

A instância de @ref{174f,,SharedMemory} onde os valores são armazenados.
@end deffn
@end deffn

O exemplo a seguir demonstra o uso básico de uma instância de @ref{1ae7,,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

O exemplo a seguir retrata como um, dois ou mais processos podem acessar a mesma @ref{1ae7,,ShareableList} fornecendo o nome do bloco de memória compartilhada por trás dela:

@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

Os exemplos a seguir demonstram que os objetos  @ref{1ae7,,ShareableList} (e o subjacente @ref{174f,,SharedMemory}) podem ser serializados e desserializados com pickle, se preciso. Note, ainda será o mesmo objeto compartilhado. Isto acontece pois o objeto desserializado tem o mesmo nome único e é somente anexado ao objeto existente com o mesmo nome (se o objeto ainda existe):

@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 O pacote concurrent,concurrent futures — Launching parallel tasks,multiprocessing shared_memory — Memória compartilhada para acesso direto entre processos,Execução Concorrente
@anchor{library/concurrent doc}@anchor{33bf}@anchor{library/concurrent the-concurrent-package}@anchor{33c0}@anchor{library/concurrent translation-repo}@anchor{33c1}
@subsection O pacote @code{concurrent}


Atualmente, há apenas um módulo neste pacote:


@itemize *

@item 
@ref{21,,concurrent.futures} – Iniciando tarefas em paralelo
@end itemize

@node concurrent futures — Launching parallel tasks,subprocess — Gerenciamento de subprocessos,O pacote concurrent,Execução Concorrente
@anchor{library/concurrent futures doc}@anchor{33c2}@anchor{library/concurrent futures concurrent-futures-launching-parallel-tasks}@anchor{33c3}@anchor{library/concurrent futures module-concurrent futures}@anchor{21}@anchor{library/concurrent futures translation-repo}@anchor{33c4}
@subsection @code{concurrent.futures} — Launching parallel tasks


@geindex module; concurrent.futures


Adicionado na versão 3.2.


`Código-fonte:' Lib/concurrent/futures/thread.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/concurrent/futures/thread.py} e Lib/concurrent/futures/process.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/concurrent/futures/process.py}


__________________________________________________________________


The @ref{21,,concurrent.futures} module provides a high-level interface for
asynchronously executing callables.

The asynchronous execution can be performed with threads, using
@ref{742,,ThreadPoolExecutor}, or separate processes, using
@ref{8f4,,ProcessPoolExecutor}.  Both implement the same interface, which is
defined by the abstract @ref{33c5,,Executor} class.

@ref{11f1,,concurrent.futures.Future} must not be confused with
@ref{be6,,asyncio.Future}, which is designed for use with @ref{a,,asyncio}
tasks and coroutines. See the @ref{33c6,,asyncio’s Future}
documentation for a detailed comparison of the two.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@menu
* Executor Objects:: 
* ThreadPoolExecutor:: 
* ProcessPoolExecutor:: 
* Future Objects:: 
* Module Functions:: 
* Exception classes:: 

@end menu

@node Executor Objects,ThreadPoolExecutor,,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures executor-objects}@anchor{33c7}
@subsubsection Executor Objects


@geindex Executor (classe em concurrent.futures)
@anchor{library/concurrent futures concurrent futures Executor}@anchor{33c5}
@deffn {Classe} concurrent.futures.Executor

An abstract class that provides methods to execute calls asynchronously.  It
should not be used directly, but through its concrete subclasses.

@geindex submit() (método concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor submit}@anchor{a8c}
@deffn {Método} submit (fn, /, *args, **kwargs)

Schedules the callable, `fn', to be executed as @code{fn(*args, **kwargs)}
and returns a @ref{11f1,,Future} object representing the execution of the
callable.

@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 concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor map}@anchor{e0e}
@deffn {Método} map (fn, *iterables, timeout=None, chunksize=1)

Similar to @ref{867,,map(fn@comma{} *iterables)} except:


@itemize *

@item 
the `iterables' are collected immediately rather than lazily;

@item 
`fn' is executed asynchronously and several calls to
`fn' may be made concurrently.
@end itemize

The returned iterator raises a @ref{838,,TimeoutError}
if @ref{1310,,__next__()} is called and the result isn’t available
after `timeout' seconds from the original call to @ref{e0e,,Executor.map()}.
`timeout' can be an int or a float.  If `timeout' is not specified or
@code{None}, there is no limit to the wait time.

If a `fn' call raises an exception, then that exception will be
raised when its value is retrieved from the iterator.

When using @ref{8f4,,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{742,,ThreadPoolExecutor}, `chunksize' has no effect.


Alterado na versão 3.5: Adicionado o argumento `chunksize'.

@end deffn

@geindex shutdown() (método concurrent.futures.Executor)
@anchor{library/concurrent futures concurrent futures Executor shutdown}@anchor{8f3}
@deffn {Método} shutdown (wait=True, *, cancel_futures=False)

Signal the executor that it should free any resources that it is using
when the currently pending futures are done executing.  Calls to
@ref{a8c,,Executor.submit()} and @ref{e0e,,Executor.map()} made after shutdown will
raise @ref{195,,RuntimeError}.

If `wait' is @code{True} then this method will not return until all the
pending futures are done executing and the resources associated with the
executor have been freed.  If `wait' is @code{False} then this method will
return immediately and the resources associated with the executor will be
freed when all pending futures are done executing.  Regardless of the
value of `wait', the entire Python program will not exit until all
pending futures are done executing.

If `cancel_futures' is @code{True}, this method will cancel all pending
futures that the executor has not started running. Any futures that
are completed or running won’t be cancelled, regardless of the value
of `cancel_futures'.

If both `cancel_futures' and `wait' are @code{True}, all futures that the
executor has started running will be completed prior to this method
returning. The remaining futures are cancelled.

You can avoid having to call this method explicitly if you use the executor
as a @ref{5d4,,context manager} via the  @ref{5d2,,with} statement, which
will shutdown the @ref{33c5,,Executor} (waiting as if @ref{8f3,,Executor.shutdown()}
were called with `wait' set to @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


Alterado na versão 3.9: Adicionado `cancel_futures'.

@end deffn
@end deffn

@node ThreadPoolExecutor,ProcessPoolExecutor,Executor Objects,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures threadpoolexecutor}@anchor{33c8}
@subsubsection ThreadPoolExecutor


@ref{742,,ThreadPoolExecutor} is an @ref{33c5,,Executor} subclass that uses a pool of
threads to execute calls asynchronously.

Deadlocks can occur when the callable associated with a @ref{11f1,,Future} waits on
the results of another @ref{11f1,,Future}.  For example:

@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

And:

@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 (classe em concurrent.futures)
@anchor{library/concurrent futures concurrent futures ThreadPoolExecutor}@anchor{742}
@deffn {Classe} concurrent.futures.ThreadPoolExecutor (max_workers=None, thread_name_prefix='@w{'}, initializer=None, initargs=())

An @ref{33c5,,Executor} subclass that uses a pool of at most `max_workers'
threads to execute calls asynchronously.

All threads enqueued to @code{ThreadPoolExecutor} will be joined before the
interpreter can exit. Note that the exit handler which does this is
executed `before' any exit handlers added using @code{atexit}. This means
exceptions in the main thread must be caught and handled in order to
signal threads to exit gracefully. For this reason, it is recommended
that @code{ThreadPoolExecutor} not be used for long-running tasks.

`initializer' is an optional callable that is called at the start of
each worker thread; `initargs' is a tuple of arguments passed to the
initializer.  Should `initializer' raise an exception, all currently
pending jobs will raise a @ref{33c9,,BrokenThreadPool},
as well as any attempt to submit more jobs to the pool.


Alterado na versão 3.5: If `max_workers' is @code{None} or
not given, it will default to the number of processors on the machine,
multiplied by @code{5}, assuming that @ref{742,,ThreadPoolExecutor} is often
used to overlap I/O instead of CPU work and the number of workers
should be higher than the number of workers
for @ref{8f4,,ProcessPoolExecutor}.



Alterado na versão 3.6: Added the `thread_name_prefix' parameter to allow users to
control the @ref{953,,threading.Thread} names for worker threads created by
the pool for easier debugging.



Alterado na versão 3.7: Added the `initializer' and `initargs' arguments.



Alterado na versão 3.8: Default value of `max_workers' is changed to @code{min(32, os.cpu_count() + 4)}.
This default value preserves at least 5 workers for I/O bound tasks.
It utilizes at most 32 CPU cores for CPU bound tasks which release the GIL.
And it avoids using very large resources implicitly on many-core machines.

ThreadPoolExecutor now reuses idle worker threads before starting
`max_workers' worker threads too.



Alterado na versão 3.13: Default value of `max_workers' is changed to
@code{min(32, (os.process_cpu_count() or 1) + 4)}.

@end deffn

@menu
* Exemplo de ThreadPoolExecutor:: 

@end menu

@node Exemplo de ThreadPoolExecutor,,,ThreadPoolExecutor
@anchor{library/concurrent futures id1}@anchor{33ca}@anchor{library/concurrent futures threadpoolexecutor-example}@anchor{11f2}
@subsubsection Exemplo 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 ProcessPoolExecutor,Future Objects,ThreadPoolExecutor,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures processpoolexecutor}@anchor{33cb}
@subsubsection ProcessPoolExecutor


The @ref{8f4,,ProcessPoolExecutor} class is an @ref{33c5,,Executor} subclass that
uses a pool of processes to execute calls asynchronously.
@ref{8f4,,ProcessPoolExecutor} uses the @ref{94,,multiprocessing} module, which
allows it to side-step the @ref{148,,Global Interpreter Lock} but also means that
only picklable objects can be executed and returned.

The @code{__main__} module must be importable by worker subprocesses. This means
that @ref{8f4,,ProcessPoolExecutor} will not work in the interactive interpreter.

Calling @ref{33c5,,Executor} or @ref{11f1,,Future} methods from a callable submitted
to a @ref{8f4,,ProcessPoolExecutor} will result in deadlock.

Note that the restrictions on functions and arguments needing to picklable as
per @ref{b6f,,multiprocessing.Process} apply when using @ref{a8c,,submit()}
and @ref{e0e,,map()} on a @ref{8f4,,ProcessPoolExecutor}. A function defined
in a REPL or a lambda should not be expected to work.

@geindex ProcessPoolExecutor (classe em concurrent.futures)
@anchor{library/concurrent futures concurrent futures ProcessPoolExecutor}@anchor{8f4}
@deffn {Classe} concurrent.futures.ProcessPoolExecutor (max_workers=None, mp_context=None, initializer=None, initargs=(), max_tasks_per_child=None)

An @ref{33c5,,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{1c4,,os.process_cpu_count()}.
If `max_workers' is less than or equal to @code{0}, then a @ref{202,,ValueError}
will be raised.
On Windows, `max_workers' must be less than or equal to @code{61}. If it is not
then @ref{202,,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{2c8,,Contextos e métodos de inicialização}.

`initializer' is an optional callable that is called at the start of
each worker process; `initargs' is a tuple of arguments passed to the
initializer.  Should `initializer' raise an exception, all currently
pending jobs will raise a @ref{33cc,,BrokenProcessPool},
as well as any attempt to submit more jobs to the pool.

`max_tasks_per_child' is an optional argument that specifies the maximum
number of tasks a single process can execute before it will exit and be
replaced with a fresh worker process. By default `max_tasks_per_child' is
@code{None} which means worker processes will live as long as the pool. When
a max is specified, the “spawn” multiprocessing start method will be used by
default in absence of a `mp_context' parameter. This feature is incompatible
with the “fork” start method.

@cartouche
@quotation Nota 
Bugs have been reported when using the `max_tasks_per_child' feature that
can result in the @ref{8f4,,ProcessPoolExecutor} hanging in some
circumstances. Follow its eventual resolution in gh-115634@footnote{https://github.com/python/cpython/issues/115634}.
@end quotation
@end cartouche


Alterado na versão 3.3: When one of the worker processes terminates abruptly, a
@ref{33cc,,BrokenProcessPool} error is now raised.
Previously, behaviour
was undefined but operations on the executor or its futures would often
freeze or deadlock.



Alterado na versão 3.7: The `mp_context' argument was added to allow users to control the
start_method for worker processes created by the pool.

Added the `initializer' and `initargs' arguments.

@cartouche
@quotation Nota 
The default @ref{94,,multiprocessing} start method
(see @ref{2c8,,Contextos e métodos de inicialização}) will change away from
`fork' in Python 3.14.  Code that requires `fork' be used for their
@ref{8f4,,ProcessPoolExecutor} should explicitly specify that by
passing a @code{mp_context=multiprocessing.get_context("fork")}
parameter.
@end quotation
@end cartouche



Alterado na versão 3.11: The `max_tasks_per_child' argument was added to allow users to
control the lifetime of workers in the pool.



Alterado na versão 3.12: On POSIX systems, if your application has multiple threads and the
@ref{94,,multiprocessing} context uses the @code{"fork"} start method:
The @ref{197,,os.fork()} function called internally to spawn workers may raise a
@ref{1a5,,DeprecationWarning}. Pass a `mp_context' configured to use a
different start method. See the @ref{197,,os.fork()} documentation for
further explanation.



Alterado na versão 3.13: `max_workers' uses @ref{1c4,,os.process_cpu_count()} by default, instead of
@ref{1c5,,os.cpu_count()}.

@end deffn

@menu
* ProcessPoolExecutor Example:: 

@end menu

@node ProcessPoolExecutor Example,,,ProcessPoolExecutor
@anchor{library/concurrent futures id2}@anchor{33cd}@anchor{library/concurrent futures processpoolexecutor-example}@anchor{11f3}
@subsubsection ProcessPoolExecutor Example


@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 Future Objects,Module Functions,ProcessPoolExecutor,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures future-objects}@anchor{33ce}
@subsubsection Future Objects


The @ref{11f1,,Future} class encapsulates the asynchronous execution of a callable.
@ref{11f1,,Future} instances are created by @ref{a8c,,Executor.submit()}.

@geindex Future (classe em concurrent.futures)
@anchor{library/concurrent futures concurrent futures Future}@anchor{11f1}
@deffn {Classe} concurrent.futures.Future

Encapsulates the asynchronous execution of a callable.  @ref{11f1,,Future}
instances are created by @ref{a8c,,Executor.submit()} and should not be created
directly except for testing.

@geindex cancel() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future cancel}@anchor{33cf}
@deffn {Método} cancel ()

Attempt to cancel the call.  If the call is currently being executed or
finished running and cannot be cancelled then the method will return
@code{False}, otherwise the call will be cancelled and the method will
return @code{True}.
@end deffn

@geindex cancelled() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future cancelled}@anchor{33d0}
@deffn {Método} cancelled ()

Return @code{True} if the call was successfully cancelled.
@end deffn

@geindex running() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future running}@anchor{33d1}
@deffn {Método} running ()

Return @code{True} if the call is currently being executed and cannot be
cancelled.
@end deffn

@geindex done() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future done}@anchor{33d2}
@deffn {Método} done ()

Return @code{True} if the call was successfully cancelled or finished
running.
@end deffn

@geindex result() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future result}@anchor{33d3}
@deffn {Método} result (timeout=None)

Return the value returned by the call. If the call hasn’t yet completed
then this method will wait up to `timeout' seconds.  If the call hasn’t
completed in `timeout' seconds, then a
@ref{838,,TimeoutError} will be raised. `timeout' can be
an int or float.  If `timeout' is not specified or @code{None}, there is no
limit to the wait time.

If the future is cancelled before completing then @ref{9e3,,CancelledError}
will be raised.

If the call raised an exception, this method will raise the same exception.
@end deffn

@geindex exception() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future exception}@anchor{33d4}
@deffn {Método} exception (timeout=None)

Return the exception raised by the call.  If the call hasn’t yet
completed then this method will wait up to `timeout' seconds.  If the
call hasn’t completed in `timeout' seconds, then a
@ref{838,,TimeoutError} will be raised.  `timeout' can be
an int or float.  If `timeout' is not specified or @code{None}, there is no
limit to the wait time.

If the future is cancelled before completing then @ref{9e3,,CancelledError}
will be raised.

If the call completed without raising, @code{None} is returned.
@end deffn

@geindex add_done_callback() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future add_done_callback}@anchor{33d5}
@deffn {Método} add_done_callback (fn)

Attaches the callable `fn' to the future.  `fn' will be called, with the
future as its only argument, when the future is cancelled or finishes
running.

Added callables are called in the order that they were added and are
always called in a thread belonging to the process that added them.  If
the callable raises an @ref{9e2,,Exception} subclass, it will be logged and
ignored.  If the callable raises a @ref{5bb,,BaseException} subclass, the
behavior is undefined.

If the future has already completed or been cancelled, `fn' will be
called immediately.
@end deffn

The following @ref{11f1,,Future} methods are meant for use in unit tests and
@ref{33c5,,Executor} implementations.

@geindex set_running_or_notify_cancel() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_running_or_notify_cancel}@anchor{33d6}
@deffn {Método} set_running_or_notify_cancel ()

This method should only be called by @ref{33c5,,Executor} implementations
before executing the work associated with the @ref{11f1,,Future} and by unit
tests.

If the method returns @code{False} then the @ref{11f1,,Future} was cancelled,
i.e. @ref{33cf,,Future.cancel()} was called and returned @code{True}.  Any threads
waiting on the @ref{11f1,,Future} completing (i.e. through
@ref{173e,,as_completed()} or @ref{198e,,wait()}) will be woken up.

If the method returns @code{True} then the @ref{11f1,,Future} was not cancelled
and has been put in the running state, i.e. calls to
@ref{33d1,,Future.running()} will return @code{True}.

This method can only be called once and cannot be called after
@ref{33d7,,Future.set_result()} or @ref{33d8,,Future.set_exception()} have been
called.
@end deffn

@geindex set_result() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_result}@anchor{33d7}
@deffn {Método} set_result (result)

Sets the result of the work associated with the @ref{11f1,,Future} to
`result'.

This method should only be used by @ref{33c5,,Executor} implementations and
unit tests.


Alterado na versão 3.8: This method raises
@ref{16f7,,concurrent.futures.InvalidStateError} if the @ref{11f1,,Future} is
already done.

@end deffn

@geindex set_exception() (método concurrent.futures.Future)
@anchor{library/concurrent futures concurrent futures Future set_exception}@anchor{33d8}
@deffn {Método} set_exception (exception)

Sets the result of the work associated with the @ref{11f1,,Future} to the
@ref{9e2,,Exception} `exception'.

This method should only be used by @ref{33c5,,Executor} implementations and
unit tests.


Alterado na versão 3.8: This method raises
@ref{16f7,,concurrent.futures.InvalidStateError} if the @ref{11f1,,Future} is
already done.

@end deffn
@end deffn

@node Module Functions,Exception classes,Future Objects,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures module-functions}@anchor{33d9}
@subsubsection Module Functions


@geindex wait() (no módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures wait}@anchor{198e}
@deffn {Função} concurrent.futures.wait (fs, timeout=None, return_when=ALL_COMPLETED)

Wait for the @ref{11f1,,Future} instances (possibly created by different
@ref{33c5,,Executor} instances) given by `fs' to complete. Duplicate futures
given to `fs' are removed and will be returned only once. Returns a named
2-tuple of sets.  The first set, named @code{done}, contains the futures that
completed (finished or cancelled futures) before the wait completed.  The
second set, named @code{not_done}, contains the futures that did not complete
(pending or running futures).

`timeout' can be used to control the maximum number of seconds to wait before
returning.  `timeout' can be an int or float.  If `timeout' is not specified
or @code{None}, there is no limit to the wait time.

`return_when' indica quando esta função deve retornar. Ele deve ser uma das seguintes constantes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Descrição

@item

@geindex FIRST_COMPLETED (no módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures FIRST_COMPLETED}@anchor{33da}
@deffn {Dado} concurrent.futures.FIRST_COMPLETED
@end deffn

@tab

A função irá retornar quando qualquer futuro terminar ou for cancelado.

@item

@geindex FIRST_EXCEPTION (no módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures FIRST_EXCEPTION}@anchor{33db}
@deffn {Dado} 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{33dc,,ALL_COMPLETED}.

@item

@geindex ALL_COMPLETED (no módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures ALL_COMPLETED}@anchor{33dc}
@deffn {Dado} concurrent.futures.ALL_COMPLETED
@end deffn

@tab

A função irá retornar quando todos os futuros encerrarem ou forem cancelados.

@end multitable

@end deffn

@geindex as_completed() (no módulo concurrent.futures)
@anchor{library/concurrent futures concurrent futures as_completed}@anchor{173e}
@deffn {Função} concurrent.futures.as_completed (fs, timeout=None)

Returns an iterator over the @ref{11f1,,Future} instances (possibly created by
different @ref{33c5,,Executor} instances) given by `fs' that yields futures as
they complete (finished or cancelled futures). Any futures given by `fs' that
are duplicated will be returned once. Any futures that completed before
@ref{173e,,as_completed()} is called will be yielded first.  The returned iterator
raises a @ref{838,,TimeoutError} if @ref{1310,,__next__()}
is called and the result isn’t available after `timeout' seconds from the
original call to @ref{173e,,as_completed()}.  `timeout' can be an int or float. If
`timeout' is not specified or @code{None}, there is no limit to the wait time.
@end deffn


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} – futures - execute computations asynchronously

The proposal which described this feature for inclusion in the Python
standard library.
@end table


@node Exception classes,,Module Functions,concurrent futures — Launching parallel tasks
@anchor{library/concurrent futures exception-classes}@anchor{33dd}
@subsubsection Exception classes


@geindex CancelledError
@anchor{library/concurrent futures concurrent futures CancelledError}@anchor{9e3}
@deffn {Exceção} concurrent.futures.CancelledError

Raised when a future is cancelled.
@end deffn

@geindex TimeoutError
@anchor{library/concurrent futures concurrent futures TimeoutError}@anchor{33de}
@deffn {Exceção} concurrent.futures.TimeoutError

A deprecated alias of @ref{838,,TimeoutError},
raised when a future operation exceeds the given timeout.


Alterado na versão 3.11: Esta classe foi feita como um apelido de @ref{838,,TimeoutError}.

@end deffn

@geindex BrokenExecutor
@anchor{library/concurrent futures concurrent futures BrokenExecutor}@anchor{33df}
@deffn {Exceção} concurrent.futures.BrokenExecutor

Derived from @ref{195,,RuntimeError}, this exception class is raised
when an executor is broken for some reason, and cannot be used
to submit or execute new tasks.


Adicionado na versão 3.7.

@end deffn

@geindex InvalidStateError
@anchor{library/concurrent futures concurrent futures InvalidStateError}@anchor{16f7}
@deffn {Exceção} concurrent.futures.InvalidStateError

Raised when an operation is performed on a future that is not allowed
in the current state.


Adicionado na versão 3.8.

@end deffn

@geindex BrokenThreadPool
@anchor{library/concurrent futures concurrent futures thread BrokenThreadPool}@anchor{33c9}
@deffn {Exceção} concurrent.futures.thread.BrokenThreadPool

Derived from @ref{33df,,BrokenExecutor}, this exception
class is raised when one of the workers
of a @ref{742,,ThreadPoolExecutor}
has failed initializing.


Adicionado na versão 3.7.

@end deffn

@geindex BrokenProcessPool
@anchor{library/concurrent futures concurrent futures process BrokenProcessPool}@anchor{33cc}
@deffn {Exceção} concurrent.futures.process.BrokenProcessPool

Derived from @ref{33df,,BrokenExecutor} (formerly
@ref{195,,RuntimeError}), this exception class is raised when one of the
workers of a @ref{8f4,,ProcessPoolExecutor}
has terminated in a non-clean
fashion (for example, if it was killed from the outside).


Adicionado na versão 3.3.

@end deffn

@node subprocess — Gerenciamento de subprocessos,sched — Agendador de eventos,concurrent futures — Launching parallel tasks,Execução Concorrente
@anchor{library/subprocess doc}@anchor{33e0}@anchor{library/subprocess module-subprocess}@anchor{d6}@anchor{library/subprocess subprocess-subprocess-management}@anchor{33e1}@anchor{library/subprocess translation-repo}@anchor{33e2}
@subsection @code{subprocess} — Gerenciamento de subprocessos


@geindex module; subprocess

`Código-fonte:' Lib/subprocess.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/subprocess.py}


__________________________________________________________________


O módulo @ref{d6,,subprocess} permite que você crie novos processos, conecte-se aos seus canais de entrada/saída/erro e obtenha seus códigos de retorno. Este módulo pretende substituir vários módulos e funções mais antigos:

@example
os.system
os.spawn*
@end example

Informações sobre como o módulo @ref{d6,,subprocess} pode ser usado para substituir esses módulos e funções podem ser encontradas nas seções a seguir.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 324
PEP 324@footnote{https://peps.python.org/pep-0324/} – PEP propondo o módulo subprocess


@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@menu
* Usando o módulo subprocess:: 
* Considerações de Segurança:: 
* Objetos Popen:: 
* Windows Popen Helpers:: 
* API de alto nível mais antiga:: 
* Replacing Older Functions with the subprocess Module:: 
* Legacy Shell Invocation Functions:: 
* Notas: Notas<2>. 

@end menu

@node Usando o módulo subprocess,Considerações de Segurança,,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess using-the-subprocess-module}@anchor{33e3}
@subsubsection Usando o módulo @code{subprocess}


A abordagem recomendada para invocar subprocessos é usar a função @ref{b9e,,run()} para todos os casos de uso que ela pode manipular. Para casos de uso mais avançados, a interface subjacente @ref{199,,Popen} pode ser usada diretamente.

@geindex run() (no módulo subprocess)
@anchor{library/subprocess subprocess run}@anchor{b9e}
@deffn {Função} 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)

Executa o comando descrito por `args'. Aguarda a conclusão do comando e retorna uma instância de @ref{ea2,,CompletedProcess}.

Os argumentos mostrados acima são meramente os mais comuns, descritos abaixo em @ref{33e4,,Argumentos usados frequentemente} (daí o uso de notação somente-nomeado na assinatura abreviada). A assinatura da função completa é basicamente a mesma do construtor @ref{199,,Popen} - a maioria dos argumentos para esta função são passados para aquela interface. (`timeout', `input', `check' e `capture_output' não são.)

Se `capture_output' for verdadeiro, `stdout' e `stderr' serão capturados. Quando usado, o objeto interno @ref{199,,Popen} é automaticamente criado com `stdout' and `stderr' definidos como @ref{b9f,,PIPE}. Os argumentos `stdout * e *stderr' não podem ser fornecidos ao mesmo tempo que `capture_output'. Se você deseja capturar e combinar ambos os fluxos em um, defina `stdout' para @ref{b9f,,PIPE} e `stderr' para @ref{33e5,,STDOUT}, ao invés de usar `capture_output'.

Um `timeout' pode ser especificado em segundos, ele é passado internamente para @ref{15cd,,Popen.communicate()}. Se o tempo limite expirar, o processo filho será eliminado e aguardado. A exceção @ref{15ce,,TimeoutExpired} será levantada novamente após o término do processo filho. A criação inicial do processo em si não pode ser interrompida em muitas APIs de plataforma, portanto, não há garantia de que você verá uma exceção de tempo limite até, pelo menos, o tempo que a criação do processo demorar.

O argumento `input' é passado para @ref{15cd,,Popen.communicate()} e, portanto, para o stdin do subprocesso. Se usado, deve ser uma sequência de bytes ou uma string se `encoding' ou `errors' forem especificados ou `text' for verdadeiro. Quando usado, o objeto internal @ref{199,,Popen} é automaticamente criado com @ref{b9f,,PIPE}, e o argumento `stdin' também não pode ser usado.

Se `check' for verdadeiro, e o processo sair com um código de saída diferente de zero, uma exceção @ref{1369,,CalledProcessError} será levantada. Os atributos dessa exceção contêm os argumentos, o código de saída e stdout e stderr se eles foram capturados.

Se `encoding' ou `errors' forem especificados, ou `text' for verdadeiro, os objetos arquivo para stdin, stdout e stderr são abertos em modo de texto usando a `encoding' e `errors' especificados ou o @ref{7bc,,io.TextIOWrapper} padrão. O argumento `universal_newlines' é equivalente a `text' e é fornecido para compatibilidade com versões anteriores. Por padrão, os objetos arquivo são abertos no modo binário.

Se `env' não for @code{None}, deve ser um mapeamento que defina as variáveis de ambiente para o novo processo; elas são usadas em vez do comportamento padrão de herdar o ambiente do processo atual. É passado diretamente para @ref{199,,Popen}. Este mapeamento pode ser str para str em qualquer plataforma ou bytes para bytes em plataformas POSIX como @ref{11f9,,os.environ} ou @ref{1257,,os.environb}.

Exemplos:

@example
>>> subprocess.run(["ls", "-l"])  # não captura a saída
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


Adicionado na versão 3.5.



Alterado na versão 3.6: Adicionados os parâmetros `encoding' e `errors'.



Alterado na versão 3.7: Adicionado o parâmetro `text', como um apelido mais compreensível que `universal_newlines'. Adicionado o parâmetro `capture_output'.



Alterado na versão 3.12: Ordem de pesquisa do shell do Windows alterada para @code{shell=True}. O diretório atual e @code{%PATH%} são substituídos por @code{%COMSPEC%} e @code{%SystemRoot%\System32\cmd.exe}. Como resultado, colocar um programa malicioso chamado @code{cmd.exe} em um diretório atual não funciona mais.

@end deffn

@geindex CompletedProcess (classe em subprocess)
@anchor{library/subprocess subprocess CompletedProcess}@anchor{ea2}
@deffn {Classe} subprocess.CompletedProcess

O valor de retorno de @ref{b9e,,run()}, representando um processo que foi concluído.

@geindex args (atributo subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess args}@anchor{33e6}
@deffn {Atributo} args

Os argumentos usados para iniciar o processo. Pode ser uma lista ou uma string.
@end deffn

@geindex returncode (atributo subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess returncode}@anchor{33e7}
@deffn {Atributo} returncode

Status de saída do processo filho. Normalmente, um status de saída 0 indica que foi executado com êxito.

Um valor negativo @code{-N} indica que o filho foi terminado pelo sinal @code{N} (POSIX apenas).
@end deffn

@geindex stdout (atributo subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess stdout}@anchor{33e8}
@deffn {Atributo} stdout

Stdout capturado do processo filho. Uma sequência de bytes ou uma string se @ref{b9e,,run()} foi chamada com uma codificação, erros ou text=True. @code{None} se stdout não foi capturado.

Se você executou o processo com @code{stderr=subprocess.STDOUT}, stdout e stderr serão combinados neste atributo, e @ref{33e9,,stderr} será @code{None}.
@end deffn

@geindex stderr (atributo subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess stderr}@anchor{33e9}
@deffn {Atributo} stderr

Stderr capturado do processo filho. Uma sequência de bytes ou uma string se @ref{b9e,,run()} foi chamada com uma codificação, erros ou text=True. @code{None} se stderr não foi capturado.
@end deffn

@geindex check_returncode() (método subprocess.CompletedProcess)
@anchor{library/subprocess subprocess CompletedProcess check_returncode}@anchor{33ea}
@deffn {Método} check_returncode ()

Se @ref{33e7,,returncode} é diferente de zero, levantar um @ref{1369,,CalledProcessError}.
@end deffn


Adicionado na versão 3.5.

@end deffn

@geindex DEVNULL (no módulo subprocess)
@anchor{library/subprocess subprocess DEVNULL}@anchor{118d}
@deffn {Dado} subprocess.DEVNULL

Valor especial que pode ser usado como o argumento `stdin', `stdout' ou `stderr' para @ref{199,,Popen} e indica que o arquivo especial @ref{1bab,,os.devnull} será usado.


Adicionado na versão 3.3.

@end deffn

@geindex PIPE (no módulo subprocess)
@anchor{library/subprocess subprocess PIPE}@anchor{b9f}
@deffn {Dado} subprocess.PIPE

Valor especial que pode ser usado como o argumento `stdin', `stdout' ou `stderr' para @ref{199,,Popen} e indica que um encadeamento para o fluxo padrão deve ser aberto. Mais útil com @ref{15cd,,Popen.communicate()}.
@end deffn

@geindex STDOUT (no módulo subprocess)
@anchor{library/subprocess subprocess STDOUT}@anchor{33e5}
@deffn {Dado} subprocess.STDOUT

Valor especial que pode ser usado como o argumento `stderr' para @ref{199,,Popen} e indica que o erro padrão deve ir para o mesmo manipulador que a saída padrão.
@end deffn

@geindex SubprocessError
@anchor{library/subprocess subprocess SubprocessError}@anchor{33eb}
@deffn {Exceção} subprocess.SubprocessError

Classe base para todas as outras exceções deste módulo.


Adicionado na versão 3.3.

@end deffn

@geindex TimeoutExpired
@anchor{library/subprocess subprocess TimeoutExpired}@anchor{15ce}
@deffn {Exceção} subprocess.TimeoutExpired

Subclasse de @ref{33eb,,SubprocessError}, levantada quando um tempo limite expira enquanto espera por um processo filho.

@geindex cmd (atributo subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired cmd}@anchor{33ec}
@deffn {Atributo} cmd

Comando que foi usado para gerar o processo filho.
@end deffn

@geindex timeout (atributo subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired timeout}@anchor{33ed}
@deffn {Atributo} timeout

Tempo limite em segundos.
@end deffn

@geindex output (atributo subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired output}@anchor{33ee}
@deffn {Atributo} output

Saída do processo filho se ele foi capturado por @ref{b9e,,run()} ou @ref{ff6,,check_output()}. Caso contrário, @code{None}. Isto é sempre @ref{1c2,,bytes} quando qualquer saída foi capturada independente da configuração @code{text=True}. Pode permanecer @code{None} em vez de @code{b'@w{'}} quando nenhuma saída foi observada.
@end deffn

@geindex stdout (atributo subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired stdout}@anchor{33ef}
@deffn {Atributo} stdout

Apelido para a saída, para simetria com @ref{33f0,,stderr}.
@end deffn

@geindex stderr (atributo subprocess.TimeoutExpired)
@anchor{library/subprocess subprocess TimeoutExpired stderr}@anchor{33f0}
@deffn {Atributo} stderr

Saída de stderr do processo filho se ele foi capturado por @ref{b9e,,run()}. Caso contrário, @code{None}. Isto é sempre @ref{1c2,,bytes} quando a saída de stderr foi capturada independente da configuração @code{text=True}. Pode permanecer @code{None} em vez de @code{b'@w{'}} quando nenhuma saída de stderr foi observada.
@end deffn


Adicionado na versão 3.3.



Alterado na versão 3.5: Adicionados os atributos `stdout' e `stderr'

@end deffn

@geindex CalledProcessError
@anchor{library/subprocess subprocess CalledProcessError}@anchor{1369}
@deffn {Exceção} subprocess.CalledProcessError

Subclasse de @ref{33eb,,SubprocessError}, levantada quando um processo executado por @ref{33f1,,check_call()}, @ref{ff6,,check_output()} ou @ref{b9e,,run()} (com @code{check=True}) retorna um status de saída diferente de zero.

@geindex returncode (atributo subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError returncode}@anchor{33f2}
@deffn {Atributo} returncode

Status de saída do processo filho. Se o processo foi encerrado devido a um sinal, este será o número do sinal negativo.
@end deffn

@geindex cmd (atributo subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError cmd}@anchor{33f3}
@deffn {Atributo} cmd

Comando que foi usado para gerar o processo filho.
@end deffn

@geindex output (atributo subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError output}@anchor{33f4}
@deffn {Atributo} output

Saída do processo filho se ele foi capturado por @ref{b9e,,run()} ou @ref{ff6,,check_output()}. Caso contrário, @code{None}.
@end deffn

@geindex stdout (atributo subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError stdout}@anchor{33f5}
@deffn {Atributo} stdout

Apelido para a saída, para simetria com @ref{33f6,,stderr}.
@end deffn

@geindex stderr (atributo subprocess.CalledProcessError)
@anchor{library/subprocess subprocess CalledProcessError stderr}@anchor{33f6}
@deffn {Atributo} stderr

Saída stderr do processo filho se ele foi capturado por @ref{b9e,,run()}. Caso contrário, @code{None}.
@end deffn


Alterado na versão 3.5: Adicionados os atributos `stdout' e `stderr'

@end deffn

@menu
* Argumentos usados frequentemente:: 
* Construtor Popen:: 
* Exceções: Exceções<11>. 

@end menu

@node Argumentos usados frequentemente,Construtor Popen,,Usando o módulo subprocess
@anchor{library/subprocess frequently-used-arguments}@anchor{33e4}@anchor{library/subprocess id1}@anchor{33f7}
@subsubsection Argumentos usados frequentemente


Para suportar uma ampla variedade de casos de uso, o construtor @ref{199,,Popen} (e as funções de conveniência) aceita muitos argumentos opcionais. Para a maioria dos casos de uso típicos, muitos desses argumentos podem ser seguramente deixados em seus valores padrão. Os argumentos mais comumente necessários são:

@quotation

`args' é necessário para todas as chamadas e deve ser uma string ou uma sequência de argumentos do programa. Fornecer uma sequência de argumentos geralmente é preferível, pois permite que o módulo cuide de qualquer escape e aspas em argumentos que forem necessários (por exemplo, para permitir espaços em nomes de arquivo). Se for passada uma única string, `shell' deve ser @ref{c27,,True} (veja abaixo) ou então a string deve apenas nomear o programa a ser executado sem especificar nenhum argumento.

`stdin', `stdout' e `stderr' especificam a entrada padrão, a saída padrão e a saída de erro do programa executado, respectivamente. Os valores válidos são @code{None}, @ref{b9f,,PIPE}, @ref{118d,,DEVNULL}, um descritor de arquivo existente (um número inteiro positivo) e um @ref{1203,,objeto arquivo} existente com um descritor de arquivo válido. Com as configurações padrão de @code{None}, nenhum redirecionamento ocorrerá. @ref{b9f,,PIPE} indica que um novo canal para o filho deve ser criado. @ref{118d,,DEVNULL} indica que o arquivo especial @ref{1bab,,os.devnull} será usado. Além disso, `stderr' pode ser @ref{33e5,,STDOUT}, o que indica que os dados de stderr do processo filho devem ser capturados no mesmo identificador de arquivo que para `stdout'.

@geindex novas linhas universais;subprocess module

Se `encoding' ou `errors' forem especificados, ou `text' (também conhecido como `universal_newlines') for verdadeiro, os objetos arquivo `stdin', `stdout' e `stderr' serão abertos em modo de texto usando a `encoding' e `errors' especificados na chamada ou os valores padrão para @ref{7bc,,io.TextIOWrapper}.

Para `stdin', os caracteres de fim de linha @code{'\n'} na entrada serão convertidos para o separador de linha padrão @ref{2311,,os.linesep}. Para `stdout' e `stderr', todas as terminações de linha na saída serão convertidas para @code{'\n'}. Para obter mais informações, consulte a documentação da classe @ref{7bc,,io.TextIOWrapper} quando o argumento `newline' para seu construtor é @code{None}.

Se o modo de texto não for usado, `stdin', `stdout' e `stderr' serão abertos como fluxos binários. Nenhuma codificação ou conversão de final de linha é executada.


Alterado na versão 3.6: Adicionados os parâmetros `encoding' e `errors'.



Alterado na versão 3.7: Adicionado o parâmetro `text' como um apelido para `universal_newlines'.


@cartouche
@quotation Nota 
O atributo newlines dos objetos arquivo @ref{33f8,,Popen.stdin}, @ref{33f9,,Popen.stdout} e @ref{33fa,,Popen.stderr} não são atualizados pelo método @ref{15cd,,Popen.communicate()}.
@end quotation
@end cartouche

Se `shell' for @code{True}, o comando especificado será executado através do shell. Isso pode ser útil se você estiver usando Python principalmente para o fluxo de controle aprimorado que ele oferece sobre a maioria dos shells do sistema e ainda deseja acesso conveniente a outros recursos do shell, como canais de shell, caracteres curinga de nome de arquivo, expansão de variável de ambiente e expansão de @code{~} para o diretório inicial de um usuário. No entanto, observe que o próprio Python oferece implementações de muitos recursos semelhantes a shell (em particular, @ref{64,,glob}, @ref{5c,,fnmatch}, @ref{4a9,,os.walk()}, @ref{1420,,os.path.expandvars()}, @ref{a1e,,os.path.expanduser()} e @ref{c5,,shutil}).


Alterado na versão 3.3: Quando `universal_newlines' é @code{True}, a classe usa a codificação @ref{53a,,locale.getpreferredencoding(False)} em vez de @code{locale.getpreferredencoding()}.  Veja a classe @ref{7bc,,io.TextIOWrapper} para mais informações sobre esta alteração.


@cartouche
@quotation Nota 
Leia a seção @ref{33fb,,Security Considerations} antes de usar @code{shell=True}.
@end quotation
@end cartouche
@end quotation

Essas opções, junto com todas as outras opções, são descritas em mais detalhes na documentação do construtor @ref{199,,Popen}.

@node Construtor Popen,Exceções<11>,Argumentos usados frequentemente,Usando o módulo subprocess
@anchor{library/subprocess popen-constructor}@anchor{33fc}
@subsubsection Construtor Popen


A criação e gerenciamento do processo subjacente neste módulo é manipulado pela classe @ref{199,,Popen}. Ela oferece muita flexibilidade para que os desenvolvedores sejam capazes de lidar com os casos menos comuns não cobertos pelas funções de conveniência.

@geindex Popen (classe em subprocess)
@anchor{library/subprocess subprocess Popen}@anchor{199}
@deffn {Classe} 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)

Executa um programa filho em um novo processo. No POSIX, a classe usa o comportamento de @ref{2d9b,,os.execvpe()} para executar o programa filho. No Windows, a classe usa a função Windows @code{CreateProcess()}. Os argumentos para @ref{199,,Popen} são os seguintes.

`args' deve ser uma sequência de argumentos do programa ou então uma única string ou @ref{2a0,,objeto caminho ou similar}. Por padrão, o programa a ser executado é o primeiro item em `args' se `args' for uma sequência. Se `args' for uma string, a interpretação depende da plataforma e é descrita abaixo. Consulte os argumentos `shell' e `executable' para obter diferenças adicionais em relação ao comportamento padrão. Salvo indicação em contrário, é recomendado passar `args' como uma sequência.

@cartouche
@quotation Aviso 
Para confiabilidade máxima, use um caminho totalmente qualificado para o executável. Para procurar um nome não qualificado no 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}, use @ref{4b4,,shutil.which()}. Em todas as plataformas, passar @ref{3b8,,sys.executable} é a maneira recomendada de relançar o interpretador Python atual, e usar o formato de linha de comando @code{-m} para iniciar um módulo instalado.

Resolver o caminho do executável (ou o primeiro item de `args') depende da plataforma. Para POSIX, veja @ref{2d9b,,os.execvpe()}, e note que ao resolver ou procurar o caminho do executável, `cwd' substitui o diretório de trabalho atual e `env' pode substituir a variável de ambiente @code{PATH}. Para Windows, veja a documentação dos parâmetros @code{lpApplicationName} e @code{lpCommandLine} do WinAPI @code{CreateProcess}, e note que ao resolver ou procurar o caminho do executável com @code{shell=False}, `cwd' não substitui o diretório de trabalho atual e `env' não pode substituir a variável de ambiente @code{PATH}. Usar um caminho completo evita todas essas variações.
@end quotation
@end cartouche

Um exemplo de passagem de alguns argumentos para um programa externo como uma sequência é:

@example
Popen(["/usr/bin/git", "commit", "-m", "Fixes a bug."])
@end example

No POSIX, se `args' for uma string, a string é interpretada como o nome ou caminho do programa a ser executado. No entanto, isso só pode ser feito se não forem passados argumentos para o programa.

@cartouche
@quotation Nota 
Pode não ser óbvio como quebrar um comando shell em uma sequência de argumentos, especialmente em casos complexos. @ref{53c,,shlex.split()} pode ilustrar como determinar a tokenização correta para `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) # Successo!
@end example

Observe em particular que as opções (como `-input') e argumentos (como `eggs.txt') que são separados por espaços em branco no shell vão em elementos de lista separados, enquanto os argumentos que precisam de aspas ou escape de contrabarra quando usados no shell (como nomes de arquivos contendo espaços ou o comando `echo' mostrado acima) são um único elemento de lista.
@end quotation
@end cartouche

No Windows, se `args' for uma sequência, será convertido em uma string da maneira descrita em @ref{33fd,,Converter uma sequência de argumentos em uma string no Windows}. Isso ocorre porque o @code{CreateProcess()} subjacente opera em strings.


Alterado na versão 3.6: O parâmetro `args' aceita um @ref{2a0,,objeto caminho ou similar} se `shell' é @code{False} e uma sequência contendo objetos caminho ou similares no POSIX.



Alterado na versão 3.8: O parâmetro `args' aceita um @ref{2a0,,objeto caminho ou similar} se `shell' for @code{False} e uma sequência contendo bytes e objetos caminho ou similares no Windows.


O argumento `shell' (que por padrão é @code{False}) especifica se deve usar o `shell' como o programa a ser executado. Se `shell' for @code{True}, é recomendado passar `args' como uma string em vez de uma sequência.

Em POSIX com @code{shell=True}, o `shell' padrão é @code{/bin/sh}. Se `args' for uma string, a `string' especifica o comando a ser executado através do `shell'. Isso significa que a `string' deve ser formatada exatamente como seria ao ser digitada no prompt do `shell'. Isso inclui, por exemplo, citar ou escapar com contrabarra nomes de arquivos que contenham espaços. Se `args' for uma sequência, o primeiro item especifica a `string' do comando, e quaisquer itens adicionais serão tratados como argumentos adicionais para o próprio `shell'. Ou seja, @ref{199,,Popen} faz o equivalente a:

@example
Popen(['/bin/sh', '-c', args[0], args[1], ...])
@end example

No Windows com @code{shell=True}, a variável de ambiente 
@geindex COMSPEC
@geindex variável de ambiente; COMSPEC
@code{COMSPEC} especifica o shell padrão. A única vez que você precisa especificar @code{shell=True} no Windows é quando o comando que você deseja executar é construído no shell (por exemplo, @code{dir} ou @code{copy}). Você não precisa de @code{shell=True} para executar um arquivo em lote ou executável baseado em console.

@cartouche
@quotation Nota 
Leia a seção @ref{33fb,,Security Considerations} antes de usar @code{shell=True}.
@end quotation
@end cartouche

`bufsize' será fornecido como o argumento correspondente à função @ref{51c,,open()} ao criar os objetos arquivo de encadeamento stdin/stdout/stderr:


@itemize -

@item 
@code{0} significa sem buffer (leitura e gravação são uma chamada de sistema e podem retornar curto)

@item 
@code{1} significa buffer de linha (utilizável somente se @code{text=True} ou @code{universal_newlines=True})

@item 
qualquer outro valor positivo significa usar um buffer de aproximadamente esse tamanho

@item 
bufsize negativo (o padrão) significa que o padrão do sistema io.DEFAULT_BUFFER_SIZE será usado.
@end itemize


Alterado na versão 3.3.1: `bufsize' agora assume o padrão -1 para habilitar o buffer por padrão para corresponder ao comportamento que a maioria dos códigos espera. Em versões anteriores ao Python 3.2.4 e 3.3.1, ele assumia incorretamente o padrão @code{0}, que não tinha buffer e permitia leituras curtas. Isso não foi intencional e não correspondeu ao comportamento do Python 2, como a maioria dos códigos esperava.


O argumento `executable' especifica um programa de substituição para executar. Ele é muito raramente necessário. Quando @code{shell=False}, `executable' substitui o programa a ser executado especificado por `args'. No entanto, o `args' original ainda é passado para o programa. A maioria dos programas trata o programa especificado por `args' como o nome do comando, que pode então ser diferente do programa realmente executado. No POSIX, o nome `args' se torna o nome de exibição para o executável em utilitários como @code{ps}. Se @code{shell=True}, no POSIX o argumento `executable' especifica um shell de substituição para o padrão @code{/bin/sh}.


Alterado na versão 3.6: O parâmetro `executable' aceita um @ref{2a0,,objeto caminho ou similar} no POSIX.



Alterado na versão 3.8: O parâmetro `executable' aceita um @ref{2a0,,objeto caminho ou similar} bytes no Windows.



Alterado na versão 3.12: Ordem de pesquisa do shell do Windows alterada para @code{shell=True}. O diretório atual e @code{%PATH%} são substituídos por @code{%COMSPEC%} e @code{%SystemRoot%\System32\cmd.exe}. Como resultado, colocar um programa malicioso chamado @code{cmd.exe} em um diretório atual não funciona mais.


`stdin', `stdout' e `stderr' especificam a entrada padrão, a saída padrão e a saída de erro do programa executado, respectivamente. Os valores válidos são @code{None}, @ref{b9f,,PIPE}, @ref{118d,,DEVNULL}, um descritor de arquivo existente (um número inteiro positivo) e um @ref{1203,,objeto arquivo} existente com um descritor de arquivo válido. Com as configurações padrão de @code{None}, nenhum redirecionamento ocorrerá. @ref{b9f,,PIPE} indica que um novo canal para o filho deve ser criado. @ref{118d,,DEVNULL} indica que o arquivo especial @ref{1bab,,os.devnull} será usado. Além disso, `stderr' pode ser @ref{33e5,,STDOUT}, o que indica que os dados de stderr da aplicação devem ser capturados no mesmo identificador de arquivo que para `stdout'.

Se `preexec_fn' for definido como um objeto chamável, esse objeto será chamado no processo filho pouco antes de o filho ser executado. (Somente POSIX)

@cartouche
@quotation Aviso 
O parâmetro `preexec_fn' NÃO É SEGURO para uso na presença de threads em sua aplicação. O processo filho pode travar antes de exec ser chamado.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se você precisar modificar o ambiente para o filho, use o parâmetro `env' em vez de fazer isso em um `preexec_fn'. Os parâmetros `start_new_session' e `process_group' devem tomar o lugar do código usando `preexec_fn' para chamar @ref{1b4c,,os.setsid()} ou @ref{2cff,,os.setpgid()} no filho.
@end quotation
@end cartouche


Alterado na versão 3.8: O parâmetro `preexec_fn' não é mais suportado em subinterpretadores. O uso do parâmetro em um subinterpretador levanta @ref{195,,RuntimeError}. A nova restrição pode afetar aplicações que são implantadas em mod_wsgi, uWSGI e outros ambientes incorporados.


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{f2b,,Herança de descritores de arquivos}.

On Windows, if `close_fds' is true then no handles will be inherited by the
child process unless explicitly passed in the @code{handle_list} element of
@ref{c28,,STARTUPINFO.lpAttributeList}, or by standard handle redirection.


Alterado na versão 3.2: The default for `close_fds' was changed from @ref{b49,,False} to
what is described above.



Alterado na versão 3.7: On Windows the default for `close_fds' was changed from @ref{b49,,False} to
@ref{c27,,True} when redirecting the standard handles. It’s now possible to
set `close_fds' to @ref{c27,,True} when redirecting the standard handles.


`pass_fds' is an optional sequence of file descriptors to keep open
between the parent and child.  Providing any `pass_fds' forces
`close_fds' to be @ref{c27,,True}.  (POSIX only)


Alterado na versão 3.2: O parâmetro `pass_fds' foi adicionado.


If `cwd' is not @code{None}, the function changes the working directory to
`cwd' before executing the child.  `cwd' can be a string, bytes or
@ref{2a0,,path-like} object.  On POSIX, the function
looks for `executable' (or for the first item in `args') relative to `cwd'
if the executable path is a relative path.


Alterado na versão 3.6: `cwd' parameter accepts a @ref{2a0,,path-like object} on POSIX.



Alterado na versão 3.7: `cwd' parameter accepts a @ref{2a0,,path-like object} on Windows.



Alterado na versão 3.8: `cwd' parameter accepts a bytes object on Windows.


If `restore_signals' is true (the default) all signals that Python has set to
SIG_IGN are restored to SIG_DFL in the child process before the exec.
Currently this includes the SIGPIPE, SIGXFZ and SIGXFSZ signals.
(POSIX only)


Alterado na versão 3.2: `restore_signals' foi adicionado.


If `start_new_session' is true the @code{setsid()} system call will be made in the
child process prior to the execution of the subprocess.

@ref{1ed8,,Disponibilidade}: POSIX


Alterado na versão 3.2: `start_new_session' foi adicionado.


If `process_group' is a non-negative integer, the @code{setpgid(0, value)} system call will
be made in the child process prior to the execution of the subprocess.

@ref{1ed8,,Disponibilidade}: POSIX


Alterado na versão 3.11: `process_group' was added.


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{33fe,,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{1ed8,,Disponibilidade}: POSIX


Adicionado na versão 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{33fe,,grp.getgrnam()} and the values in @code{gr_gid} will be used.
Integer values will be passed verbatim. (POSIX only)

@ref{1ed8,,Disponibilidade}: POSIX


Adicionado na versão 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{33ff,,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{1ed8,,Disponibilidade}: POSIX


Adicionado na versão 3.9.


If `umask' is not negative, the umask() system call will be made in the
child process prior to the execution of the subprocess.

@ref{1ed8,,Disponibilidade}: POSIX


Adicionado na versão 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{11f9,,os.environ} or @ref{1257,,os.environb}.

@cartouche
@quotation Nota 
If specified, `env' must provide any variables required for the program to
execute.  On Windows, in order to run a side-by-side assembly@footnote{https://en.wikipedia.org/wiki/Side-by-Side_Assembly} the
specified `env' `must' include a valid @code{%SystemRoot%}.
@end quotation
@end cartouche

If `encoding' or `errors' are specified, or `text' is true, the file objects
`stdin', `stdout' and `stderr' are opened in text mode with the specified
`encoding' and `errors', as described above in @ref{33e4,,Argumentos usados frequentemente}.
The `universal_newlines' argument is equivalent  to `text' and is provided
for backwards compatibility. By default, file objects are opened in binary mode.


Adicionado na versão 3.6: `encoding' e `errors' foram adicionados.



Adicionado na versão 3.7: `text' foi adicionado como um atalho mais legível para `universal_newlines'.


If given, `startupinfo' will be a @ref{3400,,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{3401,,CREATE_NEW_CONSOLE}

@item 
@ref{3402,,CREATE_NEW_PROCESS_GROUP}

@item 
@ref{3403,,ABOVE_NORMAL_PRIORITY_CLASS}

@item 
@ref{3404,,BELOW_NORMAL_PRIORITY_CLASS}

@item 
@ref{3405,,HIGH_PRIORITY_CLASS}

@item 
@ref{3406,,IDLE_PRIORITY_CLASS}

@item 
@ref{3407,,NORMAL_PRIORITY_CLASS}

@item 
@ref{3408,,REALTIME_PRIORITY_CLASS}

@item 
@ref{3409,,CREATE_NO_WINDOW}

@item 
@ref{340a,,DETACHED_PROCESS}

@item 
@ref{340b,,CREATE_DEFAULT_ERROR_MODE}

@item 
@ref{340c,,CREATE_BREAKAWAY_FROM_JOB}
@end itemize

`pipesize' can be used to change the size of the pipe when
@ref{b9f,,PIPE} is used for `stdin', `stdout' or `stderr'. The size of the pipe
is only changed on platforms that support this (only Linux at this time of
writing). Other platforms will ignore this parameter.


Alterado na versão 3.10: Added the `pipesize' parameter.


Popen objects are supported as context managers via the @ref{5d2,,with} statement:
on exit, standard file descriptors are closed, and the process is waited for.

@example
with Popen(["ifconfig"], stdout=PIPE) as proc:
    log.write(proc.stdout.read())
@end example


Popen and the other functions in this module that use it raise an
@ref{19fa,,auditing event} @code{subprocess.Popen} with arguments
@code{executable}, @code{args}, @code{cwd}, and @code{env}. The value for @code{args}
may be a single string or a list of strings, depending on platform.



Alterado na versão 3.2: Adicionado suporte a gerenciador de contexto.



Alterado na versão 3.6: O destruidor Popen agora emite um aviso @ref{244,,ResourceWarning} se o processo filho ainda estiver em execução.



Alterado na versão 3.8: Popen can use @ref{220,,os.posix_spawn()} in some cases for better
performance. On Windows Subsystem for Linux and QEMU User Emulation,
Popen constructor using @ref{220,,os.posix_spawn()} no longer raise an
exception on errors like missing program, but the child process fails
with a non-zero @ref{a9c,,returncode}.

@end deffn

@node Exceções<11>,,Construtor Popen,Usando o módulo subprocess
@anchor{library/subprocess exceptions}@anchor{340d}
@subsubsection Exceções


Exceções levantadas no processo filho, antes que o novo programa comece a ser executado, serão levantadas novamente no pai.

The most common exception raised is @ref{417,,OSError}.  This occurs, for example,
when trying to execute a non-existent file.  Applications should prepare for
@ref{417,,OSError} exceptions. Note that, when @code{shell=True}, @ref{417,,OSError}
will be raised by the child only if the selected shell itself was not found.
To determine if the shell failed to find the requested application, it is
necessary to check the return code or output from the subprocess.

A exceção @ref{202,,ValueError} será levantada se @ref{199,,Popen} for chamado com argumentos inválidos.

@ref{33f1,,check_call()} e @ref{ff6,,check_output()} levantarão @ref{1369,,CalledProcessError} se o processo chamado retornar um código de retorno diferente de zero.

All of the functions and methods that accept a `timeout' parameter, such as
@ref{b9e,,run()} and @ref{15cd,,Popen.communicate()} will raise @ref{15ce,,TimeoutExpired} if
the timeout expires before the process exits.

Todas as exceções definidas neste módulo herdam de @ref{33eb,,SubprocessError}.


Adicionado na versão 3.3: A classe base @ref{33eb,,SubprocessError} foi adicionada.


@node Considerações de Segurança,Objetos Popen,Usando o módulo subprocess,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess security-considerations}@anchor{33fb}@anchor{library/subprocess subprocess-security}@anchor{340e}
@subsubsection Considerações de Segurança


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{340f,,some platforms}, it is possible
to use @ref{27d,,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,Windows Popen Helpers,Considerações de Segurança,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess popen-objects}@anchor{3410}
@subsubsection Objetos Popen


Instâncias da classe @ref{199,,Popen} têm os seguintes métodos:

@geindex poll() (método subprocess.Popen)
@anchor{library/subprocess subprocess Popen poll}@anchor{3411}
@deffn {Método} Popen.poll ()

Check if child process has terminated.  Set and return
@ref{a9c,,returncode} attribute. Otherwise, returns @code{None}.
@end deffn

@geindex wait() (método subprocess.Popen)
@anchor{library/subprocess subprocess Popen wait}@anchor{d05}
@deffn {Método} Popen.wait (timeout=None)

Wait for child process to terminate.  Set and return
@ref{a9c,,returncode} attribute.

If the process does not terminate after `timeout' seconds, raise a
@ref{15ce,,TimeoutExpired} exception.  It is safe to catch this exception and
retry the wait.

@cartouche
@quotation Nota 
This will deadlock when using @code{stdout=PIPE} or @code{stderr=PIPE}
and the child process generates enough output to a pipe such that
it blocks waiting for the OS pipe buffer to accept more data.
Use @ref{15cd,,Popen.communicate()} when using pipes to avoid that.
@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{a,,asyncio} module for an asynchronous wait: see
@ref{a81,,asyncio.create_subprocess_exec}.
@end quotation
@end cartouche


Alterado na versão 3.3: `timeout' foi adicionado.

@end deffn

@geindex communicate() (método subprocess.Popen)
@anchor{library/subprocess subprocess Popen communicate}@anchor{15cd}
@deffn {Método} Popen.communicate (input=None, timeout=None)

Interact with process: Send data to stdin.  Read data from stdout and stderr,
until end-of-file is reached.  Wait for process to terminate and set the
@ref{a9c,,returncode} attribute.  The optional `input' argument should be
data to be sent to the child process, or @code{None}, if no data should be sent
to the child.  If streams were opened in text mode, `input' must be a string.
Otherwise, it must be bytes.

@ref{15cd,,communicate()} returns a tuple @code{(stdout_data, stderr_data)}.
The data will be strings if streams were opened in text mode; otherwise,
bytes.

Note that if you want to send data to the process’s stdin, you need to create
the Popen object with @code{stdin=PIPE}.  Similarly, to get anything other than
@code{None} in the result tuple, you need to give @code{stdout=PIPE} and/or
@code{stderr=PIPE} too.

If the process does not terminate after `timeout' seconds, a
@ref{15ce,,TimeoutExpired} exception will be raised.  Catching this exception and
retrying communication will not lose any output.  Supplying `input' to a
subsequent post-timeout @ref{15cd,,communicate()} call is in undefined behavior
and may become an error in the future.

The child process is not killed if the timeout expires, so in order to
cleanup properly a well-behaved application should kill the child process and
finish communication:

@example
proc = subprocess.Popen(...)
try:
    outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
    proc.kill()
    outs, errs = proc.communicate()
@end example

After a call to @ref{15cd,,communicate()} raises @ref{15ce,,TimeoutExpired}, do
not call @ref{d05,,wait()}. Use an additional @ref{15cd,,communicate()}
call to finish handling pipes and populate the @ref{a9c,,returncode}
attribute.

@cartouche
@quotation Nota 
The data read is buffered in memory, so do not use this method if the data
size is large or unlimited.
@end quotation
@end cartouche


Alterado na versão 3.3: `timeout' foi adicionado.

@end deffn

@geindex send_signal() (método subprocess.Popen)
@anchor{library/subprocess subprocess Popen send_signal}@anchor{1425}
@deffn {Método} Popen.send_signal (signal)

Envia o sinal `signal' para o filho.

Não faz nada se o processo for concluído.

@cartouche
@quotation Nota 
On Windows, SIGTERM is an alias for @ref{1423,,terminate()}. CTRL_C_EVENT and
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 subprocess.Popen)
@anchor{library/subprocess subprocess Popen terminate}@anchor{1423}
@deffn {Método} Popen.terminate ()

Stop the child. On POSIX OSs the method sends @ref{1426,,SIGTERM} to the
child. On Windows the Win32 API function @code{TerminateProcess()} is called
to stop the child.
@end deffn

@geindex kill() (método subprocess.Popen)
@anchor{library/subprocess subprocess Popen kill}@anchor{1424}
@deffn {Método} Popen.kill ()

Kills the child. On POSIX OSs the function sends SIGKILL to the child.
On Windows @ref{1424,,kill()} is an alias for @ref{1423,,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 subprocess.Popen)
@anchor{library/subprocess subprocess Popen args}@anchor{3412}
@deffn {Atributo} Popen.args

O argumento `args' conforme foi passado para @ref{199,,Popen} - uma sequência de argumentos do programa ou então uma única string.


Adicionado na versão 3.3.

@end deffn

@geindex stdin (atributo subprocess.Popen)
@anchor{library/subprocess subprocess Popen stdin}@anchor{33f8}
@deffn {Atributo} Popen.stdin

If the `stdin' argument was @ref{b9f,,PIPE}, this attribute is a writeable
stream object as returned by @ref{51c,,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{b9f,,PIPE}, this attribute is @code{None}.
@end deffn

@geindex stdout (atributo subprocess.Popen)
@anchor{library/subprocess subprocess Popen stdout}@anchor{33f9}
@deffn {Atributo} Popen.stdout

If the `stdout' argument was @ref{b9f,,PIPE}, this attribute is a readable
stream object as returned by @ref{51c,,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{b9f,,PIPE}, this attribute is @code{None}.
@end deffn

@geindex stderr (atributo subprocess.Popen)
@anchor{library/subprocess subprocess Popen stderr}@anchor{33fa}
@deffn {Atributo} Popen.stderr

If the `stderr' argument was @ref{b9f,,PIPE}, this attribute is a readable
stream object as returned by @ref{51c,,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{b9f,,PIPE}, this attribute is @code{None}.
@end deffn

@cartouche
@quotation Aviso 
Use @ref{15cd,,communicate()} rather than @ref{33f8,,.stdin.write},
@ref{33f9,,.stdout.read} or @ref{33fa,,.stderr.read} to avoid
deadlocks due to any of the other OS pipe buffers filling up and blocking the
child process.
@end quotation
@end cartouche

@geindex pid (atributo subprocess.Popen)
@anchor{library/subprocess subprocess Popen pid}@anchor{3413}
@deffn {Atributo} Popen.pid

O ID de processo do processo filho.

Observe que se você definir o argumento `shell' como @code{True}, este é o ID do processo do shell gerado.
@end deffn

@geindex returncode (atributo subprocess.Popen)
@anchor{library/subprocess subprocess Popen returncode}@anchor{a9c}
@deffn {Atributo} Popen.returncode

The child return code. Initially @code{None}, @ref{a9c,,returncode} is set by
a call to the @ref{3411,,poll()}, @ref{d05,,wait()}, or @ref{15cd,,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.

Um valor negativo @code{-N} indica que o filho foi terminado pelo sinal @code{N} (POSIX apenas).
@end deffn

@node Windows Popen Helpers,API de alto nível mais antiga,Objetos Popen,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess windows-popen-helpers}@anchor{3414}
@subsubsection Windows Popen Helpers


The @ref{3400,,STARTUPINFO} class and following constants are only available
on Windows.

@geindex STARTUPINFO (classe em subprocess)
@anchor{library/subprocess subprocess STARTUPINFO}@anchor{3400}
@deffn {Classe} subprocess.STARTUPINFO (*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)

Partial support of the Windows
STARTUPINFO@footnote{https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx}
structure is used for @ref{199,,Popen} creation.  The following attributes can
be set by passing them as keyword-only arguments.


Alterado na versão 3.7: Keyword-only argument support was added.


@geindex dwFlags (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO dwFlags}@anchor{3415}
@deffn {Atributo} dwFlags

A bit field that determines whether certain @ref{3400,,STARTUPINFO}
attributes are used when the process creates a window.

@example
si = subprocess.STARTUPINFO()
si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW
@end example
@end deffn

@geindex hStdInput (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdInput}@anchor{3416}
@deffn {Atributo} hStdInput

If @ref{3415,,dwFlags} specifies @ref{3417,,STARTF_USESTDHANDLES}, this attribute
is the standard input handle for the process. If
@ref{3417,,STARTF_USESTDHANDLES} is not specified, the default for standard
input is the keyboard buffer.
@end deffn

@geindex hStdOutput (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdOutput}@anchor{3418}
@deffn {Atributo} hStdOutput

If @ref{3415,,dwFlags} specifies @ref{3417,,STARTF_USESTDHANDLES}, this attribute
is the standard output handle for the process. Otherwise, this attribute
is ignored and the default for standard output is the console window’s
buffer.
@end deffn

@geindex hStdError (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO hStdError}@anchor{3419}
@deffn {Atributo} hStdError

If @ref{3415,,dwFlags} specifies @ref{3417,,STARTF_USESTDHANDLES}, this attribute
is the standard error handle for the process. Otherwise, this attribute is
ignored and the default for standard error is the console window’s buffer.
@end deffn

@geindex wShowWindow (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO wShowWindow}@anchor{341a}
@deffn {Atributo} wShowWindow

If @ref{3415,,dwFlags} specifies @ref{341b,,STARTF_USESHOWWINDOW}, this attribute
can be any of the values that can be specified in the @code{nCmdShow}
parameter for the
ShowWindow@footnote{https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx}
function, except for @code{SW_SHOWDEFAULT}. Otherwise, this attribute is
ignored.

@ref{341c,,SW_HIDE} is provided for this attribute. It is used when
@ref{199,,Popen} is called with @code{shell=True}.
@end deffn

@geindex lpAttributeList (atributo subprocess.STARTUPINFO)
@anchor{library/subprocess subprocess STARTUPINFO lpAttributeList}@anchor{c28}
@deffn {Atributo} lpAttributeList

A dictionary of additional attributes for process creation as given in
@code{STARTUPINFOEX}, see
UpdateProcThreadAttribute@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx}.

Atributos suportados:


@table @asis

@item `handle_list'

Sequence of handles that will be inherited. `close_fds' must be true if
non-empty.

The handles must be temporarily made inheritable by
@ref{f2f,,os.set_handle_inheritable()} when passed to the @ref{199,,Popen}
constructor, else @ref{417,,OSError} will be raised with Windows error
@code{ERROR_INVALID_PARAMETER} (87).

@cartouche
@quotation Aviso 
In a multithreaded process, use caution to avoid leaking handles
that are marked inheritable when combining this feature with
concurrent calls to other process creation functions that inherit
all handles such as @ref{14a5,,os.system()}.  This also applies to
standard handle redirection, which temporarily creates inheritable
handles.
@end quotation
@end cartouche
@end table


Adicionado na versão 3.7.

@end deffn
@end deffn

@menu
* Constantes do Windows:: 

@end menu

@node Constantes do Windows,,,Windows Popen Helpers
@anchor{library/subprocess windows-constants}@anchor{341d}
@subsubsection Constantes do Windows


The @ref{d6,,subprocess} module exposes the following constants.

@geindex STD_INPUT_HANDLE (no módulo subprocess)
@anchor{library/subprocess subprocess STD_INPUT_HANDLE}@anchor{341e}
@deffn {Dado} subprocess.STD_INPUT_HANDLE

The standard input device. Initially, this is the console input buffer,
@code{CONIN$}.
@end deffn

@geindex STD_OUTPUT_HANDLE (no módulo subprocess)
@anchor{library/subprocess subprocess STD_OUTPUT_HANDLE}@anchor{341f}
@deffn {Dado} subprocess.STD_OUTPUT_HANDLE

The standard output device. Initially, this is the active console screen
buffer, @code{CONOUT$}.
@end deffn

@geindex STD_ERROR_HANDLE (no módulo subprocess)
@anchor{library/subprocess subprocess STD_ERROR_HANDLE}@anchor{3420}
@deffn {Dado} subprocess.STD_ERROR_HANDLE

The standard error device. Initially, this is the active console screen
buffer, @code{CONOUT$}.
@end deffn

@geindex SW_HIDE (no módulo subprocess)
@anchor{library/subprocess subprocess SW_HIDE}@anchor{341c}
@deffn {Dado} subprocess.SW_HIDE

Oculta a janela. Outra janela será ativada.
@end deffn

@geindex STARTF_USESTDHANDLES (no módulo subprocess)
@anchor{library/subprocess subprocess STARTF_USESTDHANDLES}@anchor{3417}
@deffn {Dado} subprocess.STARTF_USESTDHANDLES

Specifies that the @ref{3416,,STARTUPINFO.hStdInput},
@ref{3418,,STARTUPINFO.hStdOutput}, and @ref{3419,,STARTUPINFO.hStdError} attributes
contain additional information.
@end deffn

@geindex STARTF_USESHOWWINDOW (no módulo subprocess)
@anchor{library/subprocess subprocess STARTF_USESHOWWINDOW}@anchor{341b}
@deffn {Dado} subprocess.STARTF_USESHOWWINDOW

Specifies that the @ref{341a,,STARTUPINFO.wShowWindow} attribute contains
additional information.
@end deffn

@geindex STARTF_FORCEONFEEDBACK (no módulo subprocess)
@anchor{library/subprocess subprocess STARTF_FORCEONFEEDBACK}@anchor{3421}
@deffn {Dado} subprocess.STARTF_FORCEONFEEDBACK

A @ref{3415,,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.


Adicionado na versão 3.13.

@end deffn

@geindex STARTF_FORCEOFFFEEDBACK (no módulo subprocess)
@anchor{library/subprocess subprocess STARTF_FORCEOFFFEEDBACK}@anchor{3422}
@deffn {Dado} subprocess.STARTF_FORCEOFFFEEDBACK

A @ref{3415,,STARTUPINFO.dwFlags} parameter to specify that the mouse
cursor will not be changed when launching a process.


Adicionado na versão 3.13.

@end deffn

@geindex CREATE_NEW_CONSOLE (no módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NEW_CONSOLE}@anchor{3401}
@deffn {Dado} subprocess.CREATE_NEW_CONSOLE

The new process has a new console, instead of inheriting its parent’s
console (the default).
@end deffn

@geindex CREATE_NEW_PROCESS_GROUP (no módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NEW_PROCESS_GROUP}@anchor{3402}
@deffn {Dado} subprocess.CREATE_NEW_PROCESS_GROUP

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
group will be created. This flag is necessary for using @ref{13ae,,os.kill()}
on the subprocess.

This flag is ignored if @ref{3401,,CREATE_NEW_CONSOLE} is specified.
@end deffn

@geindex ABOVE_NORMAL_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess ABOVE_NORMAL_PRIORITY_CLASS}@anchor{3403}
@deffn {Dado} subprocess.ABOVE_NORMAL_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have an above average priority.


Adicionado na versão 3.7.

@end deffn

@geindex BELOW_NORMAL_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess BELOW_NORMAL_PRIORITY_CLASS}@anchor{3404}
@deffn {Dado} subprocess.BELOW_NORMAL_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have a below average priority.


Adicionado na versão 3.7.

@end deffn

@geindex HIGH_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess HIGH_PRIORITY_CLASS}@anchor{3405}
@deffn {Dado} subprocess.HIGH_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have a high priority.


Adicionado na versão 3.7.

@end deffn

@geindex IDLE_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess IDLE_PRIORITY_CLASS}@anchor{3406}
@deffn {Dado} subprocess.IDLE_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have an idle (lowest) priority.


Adicionado na versão 3.7.

@end deffn

@geindex NORMAL_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess NORMAL_PRIORITY_CLASS}@anchor{3407}
@deffn {Dado} subprocess.NORMAL_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have a normal priority. (default)


Adicionado na versão 3.7.

@end deffn

@geindex REALTIME_PRIORITY_CLASS (no módulo subprocess)
@anchor{library/subprocess subprocess REALTIME_PRIORITY_CLASS}@anchor{3408}
@deffn {Dado} subprocess.REALTIME_PRIORITY_CLASS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will have realtime priority.
You should almost never use REALTIME_PRIORITY_CLASS, because this interrupts
system threads that manage mouse input, keyboard input, and background disk
flushing. This class can be appropriate for applications that “talk” directly
to hardware or that perform brief tasks that should have limited interruptions.


Adicionado na versão 3.7.

@end deffn

@geindex CREATE_NO_WINDOW (no módulo subprocess)
@anchor{library/subprocess subprocess CREATE_NO_WINDOW}@anchor{3409}
@deffn {Dado} subprocess.CREATE_NO_WINDOW

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will not create a window.


Adicionado na versão 3.7.

@end deffn

@geindex DETACHED_PROCESS (no módulo subprocess)
@anchor{library/subprocess subprocess DETACHED_PROCESS}@anchor{340a}
@deffn {Dado} subprocess.DETACHED_PROCESS

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
will not inherit its parent’s console.
This value cannot be used with CREATE_NEW_CONSOLE.


Adicionado na versão 3.7.

@end deffn

@geindex CREATE_DEFAULT_ERROR_MODE (no módulo subprocess)
@anchor{library/subprocess subprocess CREATE_DEFAULT_ERROR_MODE}@anchor{340b}
@deffn {Dado} subprocess.CREATE_DEFAULT_ERROR_MODE

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
does not inherit the error mode of the calling process. Instead, the new
process gets the default error mode.
This feature is particularly useful for multithreaded shell applications
that run with hard errors disabled.


Adicionado na versão 3.7.

@end deffn

@geindex CREATE_BREAKAWAY_FROM_JOB (no módulo subprocess)
@anchor{library/subprocess subprocess CREATE_BREAKAWAY_FROM_JOB}@anchor{340c}
@deffn {Dado} subprocess.CREATE_BREAKAWAY_FROM_JOB

A @ref{199,,Popen} @code{creationflags} parameter to specify that a new process
is not associated with the job.


Adicionado na versão 3.7.

@end deffn

@node API de alto nível mais antiga,Replacing Older Functions with the subprocess Module,Windows Popen Helpers,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess call-function-trio}@anchor{3423}@anchor{library/subprocess older-high-level-api}@anchor{3424}
@subsubsection API de alto nível mais antiga


Antes do Python 3.5, essas três funções constituíam a API de alto nível para subprocesso. Agora você pode usar @ref{b9e,,run()} em muitos casos, mas muitos códigos existentes chamam essas funções.

@geindex call() (no módulo subprocess)
@anchor{library/subprocess subprocess call}@anchor{ba0}
@deffn {Função} subprocess.call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

Run the command described by `args'.  Wait for command to complete, then
return the @ref{a9c,,returncode} attribute.

Code needing to capture stdout or stderr should use @ref{b9e,,run()} instead:

@example
run(...).returncode
@end example

To suppress stdout or stderr, supply a value of @ref{118d,,DEVNULL}.

The arguments shown above are merely some common ones.
The full function signature is the
same as that of the @ref{199,,Popen} constructor - this function passes all
supplied arguments other than `timeout' directly through to that interface.

@cartouche
@quotation Nota 
Do not use @code{stdout=PIPE} or @code{stderr=PIPE} with this
function.  The child process will block if it generates enough
output to a pipe to fill up the OS pipe buffer as the pipes are
not being read from.
@end quotation
@end cartouche


Alterado na versão 3.3: `timeout' foi adicionado.



Alterado na versão 3.12: Ordem de pesquisa do shell do Windows alterada para @code{shell=True}. O diretório atual e @code{%PATH%} são substituídos por @code{%COMSPEC%} e @code{%SystemRoot%\System32\cmd.exe}. Como resultado, colocar um programa malicioso chamado @code{cmd.exe} em um diretório atual não funciona mais.

@end deffn

@geindex check_call() (no módulo subprocess)
@anchor{library/subprocess subprocess check_call}@anchor{33f1}
@deffn {Função} subprocess.check_call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

Run command with arguments.  Wait for command to complete. If the return
code was zero then return, otherwise raise @ref{1369,,CalledProcessError}. The
@ref{1369,,CalledProcessError} object will have the return code in the
@ref{33f2,,returncode} attribute.
If @ref{33f1,,check_call()} was unable to start the process it will propagate the exception
that was raised.

Code needing to capture stdout or stderr should use @ref{b9e,,run()} instead:

@example
run(..., check=True)
@end example

To suppress stdout or stderr, supply a value of @ref{118d,,DEVNULL}.

The arguments shown above are merely some common ones.
The full function signature is the
same as that of the @ref{199,,Popen} constructor - this function passes all
supplied arguments other than `timeout' directly through to that interface.

@cartouche
@quotation Nota 
Do not use @code{stdout=PIPE} or @code{stderr=PIPE} with this
function.  The child process will block if it generates enough
output to a pipe to fill up the OS pipe buffer as the pipes are
not being read from.
@end quotation
@end cartouche


Alterado na versão 3.3: `timeout' foi adicionado.



Alterado na versão 3.12: Ordem de pesquisa do shell do Windows alterada para @code{shell=True}. O diretório atual e @code{%PATH%} são substituídos por @code{%COMSPEC%} e @code{%SystemRoot%\System32\cmd.exe}. Como resultado, colocar um programa malicioso chamado @code{cmd.exe} em um diretório atual não funciona mais.

@end deffn

@geindex check_output() (no módulo subprocess)
@anchor{library/subprocess subprocess check_output}@anchor{ff6}
@deffn {Função} 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)

Executa o comando com argumentos e retorna sua saída.

If the return code was non-zero it raises a @ref{1369,,CalledProcessError}. The
@ref{1369,,CalledProcessError} object will have the return code in the
@ref{33f2,,returncode} attribute and any output in the
@ref{33f4,,output} attribute.

Isso equivale a:

@example
run(..., check=True, stdout=PIPE).stdout
@end example

The arguments shown above are merely some common ones.
The full function signature is largely the same as that of @ref{b9e,,run()} -
most arguments are passed directly through to that interface.
One API deviation from @ref{b9e,,run()} behavior exists: passing @code{input=None}
will behave the same as @code{input=b'@w{'}} (or @code{input='@w{'}}, depending on other
arguments) rather than using the parent’s standard input file handle.

By default, this function will return the data as encoded bytes. The actual
encoding of the output data may depend on the command being invoked, so the
decoding to text will often need to be handled at the application level.

This behaviour may be overridden by setting `text', `encoding', `errors',
or `universal_newlines' to @code{True} as described in
@ref{33e4,,Argumentos usados frequentemente} and @ref{b9e,,run()}.

To also capture standard error in the result, use
@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


Adicionado na versão 3.1.



Alterado na versão 3.3: `timeout' foi adicionado.



Alterado na versão 3.4: Support for the `input' keyword argument was added.



Alterado na versão 3.6: `encoding' and `errors' were added.  See @ref{b9e,,run()} for details.



Adicionado na versão 3.7: `text' foi adicionado como um atalho mais legível para `universal_newlines'.



Alterado na versão 3.12: Ordem de pesquisa do shell do Windows alterada para @code{shell=True}. O diretório atual e @code{%PATH%} são substituídos por @code{%COMSPEC%} e @code{%SystemRoot%\System32\cmd.exe}. Como resultado, colocar um programa malicioso chamado @code{cmd.exe} em um diretório atual não funciona mais.

@end deffn

@node Replacing Older Functions with the subprocess Module,Legacy Shell Invocation Functions,API de alto nível mais antiga,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess replacing-older-functions-with-the-subprocess-module}@anchor{3425}@anchor{library/subprocess subprocess-replacements}@anchor{11c7}
@subsubsection Replacing Older Functions with the @code{subprocess} Module


In this section, “a becomes b” means that b can be used as a replacement for a.

@cartouche
@quotation Nota 
All “a” functions in this section fail (more or less) silently if the
executed program cannot be found; the “b” replacements raise @ref{417,,OSError}
instead.

In addition, the replacements using @ref{ff6,,check_output()} will fail with a
@ref{1369,,CalledProcessError} if the requested operation produces a non-zero
return code. The output is still available as the
@ref{33f4,,output} attribute of the raised exception.
@end quotation
@end cartouche

In the following examples, we assume that the relevant functions have already
been imported from the @ref{d6,,subprocess} module.

@menu
* Replacing /bin/sh shell command substitution:: 
* Replacing shell pipeline:: 
* Substituindo os.system(): Substituindo os system. 
* Replacing the os.spawn family: Replacing the os spawn family. 
* Replacing os.popen()@comma{} os.popen2()@comma{} os.popen3(): Replacing os popen os popen2 os popen3. 
* Replacing functions from the popen2 module:: 

@end menu

@node Replacing /bin/sh shell command substitution,Replacing shell pipeline,,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-bin-sh-shell-command-substitution}@anchor{3426}
@subsubsection Replacing @code{/bin/sh} shell command substitution


@example
output=$(mycmd myarg)
@end example

torna-se:

@example
output = check_output(["mycmd", "myarg"])
@end example

@node Replacing shell pipeline,Substituindo os system,Replacing /bin/sh shell command substitution,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-shell-pipeline}@anchor{3427}
@subsubsection Replacing shell pipeline


@example
output=$(dmesg | grep hda)
@end example

torna-se:

@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

The @code{p1.stdout.close()} call after starting the p2 is important in order for
p1 to receive a SIGPIPE if p2 exits before p1.

Alternatively, for trusted input, the shell’s own pipeline support may still
be used directly:

@example
output=$(dmesg | grep hda)
@end example

torna-se:

@example
output = check_output("dmesg | grep hda", shell=True)
@end example

@node Substituindo os system,Replacing the os spawn family,Replacing shell pipeline,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-os-system}@anchor{3428}
@subsubsection Substituindo @code{os.system()}


@example
sts = os.system("mycmd" + " myarg")
# becomes
retcode = call("mycmd" + " myarg", shell=True)
@end example

Notas:


@itemize *

@item 
Calling the program through the shell is usually not required.

@item 
The @ref{ba0,,call()} return value is encoded differently to that of
@ref{14a5,,os.system()}.

@item 
The @ref{14a5,,os.system()} function ignores SIGINT and SIGQUIT signals while
the command is running, but the caller must do this separately when
using the @ref{d6,,subprocess} module.
@end itemize

Um exemplo mais realista ficaria assim:

@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 Replacing the os spawn family,Replacing os popen os popen2 os popen3,Substituindo os system,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-the-os-spawn-family}@anchor{3429}
@subsubsection Replacing the @code{os.spawn} family


Exemplo P_NOWAIT:

@example
pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
==>
pid = Popen(["/bin/mycmd", "myarg"]).pid
@end example

Exemplo P_WAIT:

@example
retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
==>
retcode = call(["/bin/mycmd", "myarg"])
@end example

Exemplo de vetor:

@example
os.spawnvp(os.P_NOWAIT, path, args)
==>
Popen([path] + args[1:])
@end example

Exemplo de ambiente:

@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 os popen2 os popen3,Replacing functions from the popen2 module,Replacing the os spawn family,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-os-popen-os-popen2-os-popen3}@anchor{342a}
@subsubsection Replacing @code{os.popen()}, @code{os.popen2()}, @code{os.popen3()}


@example
(child_stdin, child_stdout) = os.popen2(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdin, child_stdout) = (p.stdin, p.stdout)
@end example

@example
(child_stdin,
 child_stdout,
 child_stderr) = os.popen3(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
(child_stdin,
 child_stdout,
 child_stderr) = (p.stdin, p.stdout, p.stderr)
@end example

@example
(child_stdin, child_stdout_and_stderr) = os.popen4(cmd, mode, bufsize)
==>
p = Popen(cmd, shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, stderr=STDOUT, close_fds=True)
(child_stdin, child_stdout_and_stderr) = (p.stdin, p.stdout)
@end example

Return code handling translates as follows:

@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 Replacing functions from the popen2 module,,Replacing os popen os popen2 os popen3,Replacing Older Functions with the subprocess Module
@anchor{library/subprocess replacing-functions-from-the-popen2-module}@anchor{342b}
@subsubsection Replacing functions from the @code{popen2} module


@cartouche
@quotation Nota 
If the cmd argument to popen2 functions is a string, the command is executed
through /bin/sh.  If it is a list, the command is directly executed.
@end quotation
@end cartouche

@example
(child_stdout, child_stdin) = popen2.popen2("somestring", bufsize, mode)
==>
p = Popen("somestring", shell=True, bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdout, child_stdin) = (p.stdout, p.stdin)
@end example

@example
(child_stdout, child_stdin) = popen2.popen2(["mycmd", "myarg"], bufsize, mode)
==>
p = Popen(["mycmd", "myarg"], bufsize=bufsize,
          stdin=PIPE, stdout=PIPE, close_fds=True)
(child_stdout, child_stdin) = (p.stdout, p.stdin)
@end example

@code{popen2.Popen3} and @code{popen2.Popen4} basically work as
@ref{199,,subprocess.Popen}, except that:


@itemize *

@item 
@ref{199,,Popen} raises an exception if the execution fails.

@item 
The `capturestderr' argument is replaced with the `stderr' argument.

@item 
@code{stdin=PIPE} and @code{stdout=PIPE} must be specified.

@item 
popen2 closes all file descriptors by default, but you have to specify
@code{close_fds=True} with @ref{199,,Popen} to guarantee this behavior on
all platforms or past Python versions.
@end itemize

@node Legacy Shell Invocation Functions,Notas<2>,Replacing Older Functions with the subprocess Module,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess legacy-shell-invocation-functions}@anchor{342c}
@subsubsection Legacy Shell Invocation Functions


This module also provides the following legacy functions from the 2.x
@code{commands} module. These operations implicitly invoke the system shell and
none of the guarantees described above regarding security and exception
handling consistency are valid for these functions.

@geindex getstatusoutput() (no módulo subprocess)
@anchor{library/subprocess subprocess getstatusoutput}@anchor{ff8}
@deffn {Função} subprocess.getstatusoutput (cmd, *, encoding=None, errors=None)

Return @code{(exitcode, output)} of executing `cmd' in a shell.

Execute the string `cmd' in a shell with @ref{ff6,,check_output()} and
return a 2-tuple @code{(exitcode, output)}.
`encoding' and `errors' are used to decode output;
see the notes on @ref{33e4,,Argumentos usados frequentemente} for more details.

A trailing newline is stripped from the output.
The exit code for the command can be interpreted as the return code
of subprocess.  Example:

@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{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.3.4: Suporte ao Windows foi adicionado.

The function now returns (exitcode, output) instead of (status, output)
as it did in Python 3.3.3 and earlier.  exitcode has the same value as
@ref{a9c,,returncode}.



Alterado na versão 3.11: Adicionados os parâmetros `encoding' e `errors'.

@end deffn

@geindex getoutput() (no módulo subprocess)
@anchor{library/subprocess subprocess getoutput}@anchor{ff7}
@deffn {Função} subprocess.getoutput (cmd, *, encoding=None, errors=None)

Return output (stdout and stderr) of executing `cmd' in a shell.

Like @ref{ff8,,getstatusoutput()}, except the exit code is ignored and the return
value is a string containing the command’s output.  Example:

@example
>>> subprocess.getoutput('ls /bin/ls')
'/bin/ls'
@end example

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.3.4: Suporte para Windows adicionado.



Alterado na versão 3.11: Adicionados os parâmetros `encoding' e `errors'.

@end deffn

@node Notas<2>,,Legacy Shell Invocation Functions,subprocess — Gerenciamento de subprocessos
@anchor{library/subprocess notes}@anchor{342d}
@subsubsection Notas


@menu
* Timeout Behavior:: 
* Converter uma sequência de argumentos em uma string no Windows:: 
* Disabling use of vfork() or posix_spawn(): Disabling use of vfork or posix_spawn. 

@end menu

@node Timeout Behavior,Converter uma sequência de argumentos em uma string no Windows,,Notas<2>
@anchor{library/subprocess subprocess-timeout-behavior}@anchor{342e}@anchor{library/subprocess timeout-behavior}@anchor{342f}
@subsubsection Timeout Behavior


When using the @code{timeout} parameter in functions like @ref{b9e,,run()},
@ref{d05,,Popen.wait()}, or @ref{15cd,,Popen.communicate()},
users should be aware of the following behaviors:


@enumerate 

@item 
`Process Creation Delay': The initial process creation itself cannot be interrupted
on many platform APIs. This means that even when specifying a timeout, you are not
guaranteed to see a timeout exception until at least after however long process
creation takes.

@item 
`Extremely Small Timeout Values': Setting very small timeout values (such as a few
milliseconds) may result in almost immediate @ref{15ce,,TimeoutExpired} exceptions because
process creation and system scheduling inherently require time.
@end enumerate

@node Converter uma sequência de argumentos em uma string no Windows,Disabling use of vfork or posix_spawn,Timeout Behavior,Notas<2>
@anchor{library/subprocess converting-an-argument-sequence-to-a-string-on-windows}@anchor{3430}@anchor{library/subprocess converting-argument-sequence}@anchor{33fd}
@subsubsection Converter uma sequência de argumentos em uma string no Windows


On Windows, an `args' sequence is converted to a string that can be parsed
using the following rules (which correspond to the rules used by the MS C
runtime):


@enumerate 

@item 
Arguments are delimited by white space, which is either a
space or a tab.

@item 
A string surrounded by double quotation marks is
interpreted as a single argument, regardless of white space
contained within.  A quoted string can be embedded in an
argument.

@item 
A double quotation mark preceded by a backslash is
interpreted as a literal double quotation mark.

@item 
Backslashes are interpreted literally, unless they
immediately precede a double quotation mark.

@item 
If backslashes immediately precede a double quotation mark,
every pair of backslashes is interpreted as a literal
backslash.  If the number of backslashes is odd, the last
backslash escapes the next double quotation mark as
described in rule 3.
@end enumerate


@subsubheading Ver também



@table @asis

@item @ref{c4,,shlex}

Module which provides function to parse and escape command lines.
@end table

@anchor{library/subprocess disable-vfork}@anchor{3431}
@node Disabling use of vfork or posix_spawn,,Converter uma sequência de argumentos em uma string no Windows,Notas<2>
@anchor{library/subprocess disable-posix-spawn}@anchor{3432}@anchor{library/subprocess disabling-use-of-vfork-or-posix-spawn}@anchor{3433}
@subsubsection Disabling use of @code{vfork()} or @code{posix_spawn()}


On Linux, @ref{d6,,subprocess} defaults to using the @code{vfork()} system call
internally when it is safe to do so rather than @code{fork()}. This greatly
improves performance.

If you ever encounter a presumed highly unusual situation where you need to
prevent @code{vfork()} from being used by Python, you can set the
@code{subprocess._USE_VFORK} attribute to a false value.

@example
subprocess._USE_VFORK = False  # See CPython issue gh-NNNNNN.
@end example

Setting this has no impact on use of @code{posix_spawn()} which could use
@code{vfork()} internally within its libc implementation.  There is a similar
@code{subprocess._USE_POSIX_SPAWN} attribute if you need to prevent use of
that.

@example
subprocess._USE_POSIX_SPAWN = False  # See CPython issue gh-NNNNNN.
@end example

It is safe to set these to false on any Python version. They will have no
effect on older versions when unsupported. Do not assume the attributes are
available to read. Despite their names, a true value does not indicate that the
corresponding function will be used, only that it may be.

Please file issues any time you have to use these private knobs with a way to
reproduce the issue you were seeing. Link to that issue from a comment in your
code.


Adicionado na versão 3.8: @code{_USE_POSIX_SPAWN}



Adicionado na versão 3.11: @code{_USE_VFORK}


@node sched — Agendador de eventos,queue — A synchronized queue class,subprocess — Gerenciamento de subprocessos,Execução Concorrente
@anchor{library/sched doc}@anchor{3434}@anchor{library/sched module-sched}@anchor{bf}@anchor{library/sched sched-event-scheduler}@anchor{3435}@anchor{library/sched translation-repo}@anchor{3436}
@subsection @code{sched} — Agendador de eventos


@geindex module; sched

`Código-fonte:' Lib/sched.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/sched.py}

@geindex agendamento de eventos


__________________________________________________________________


O módulo @ref{bf,,sched} define uma classe que implementa um agendador de eventos de uso geral:

@geindex scheduler (classe em sched)
@anchor{library/sched sched scheduler}@anchor{1166}
@deffn {Classe} sched.scheduler (timefunc=time.monotonic, delayfunc=time.sleep)

A classe @ref{1166,,scheduler} define uma interface genérica para agendar eventos. Ela precisa de duas funções para lidar com o “mundo externo” — `timefunc' deve ser chamável sem argumentos e retornar um número (o “tempo”, em quaisquer unidades). A função `delayfunc' deve ser chamável com um argumento, compatível com a saída de `timefunc', e deve atrasar a mesma quantidade de unidades de tempo. `delayfunc' também será chamada com o argumento @code{0} após a execução de cada evento para permitir que outras threads executem em aplicações multithread.


Alterado na versão 3.3: Os parâmetros `timefunc' e `delayfunc' são opcionais.



Alterado na versão 3.3: A classe @ref{1166,,scheduler} pode ser usada com segurança em ambientes multithread.

@end deffn

Exemplo:

@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',))
...     # apesar de ter prioridade mais alta, 'keyword' é executado depois de 'positional', pois enter() é relativo
...     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 Scheduler:: 

@end menu

@node Objetos Scheduler,,,sched — Agendador de eventos
@anchor{library/sched id1}@anchor{3437}@anchor{library/sched scheduler-objects}@anchor{3438}
@subsubsection Objetos Scheduler


As instâncias @ref{1166,,scheduler} têm os seguintes métodos e atributos:

@geindex enterabs() (método sched.scheduler)
@anchor{library/sched sched scheduler enterabs}@anchor{1168}
@deffn {Método} scheduler.enterabs (time, priority, action, argument=(), kwargs=@{@})

Agenda um novo evento. O argumento `time' deve ser um tipo numérico compatível com o valor de retorno da função `timefunc' passada ao construtor. Eventos agendados para o mesmo `time' serão executados na ordem de sua prioridade `priority'. Um número menor representa uma prioridade maior.

Executa o evento significa executar @code{action(*argument, **kwargs)}. `argument' é uma sequência que contém os argumentos posicionais para `action'. `kwargs' é um dicionário que contém os argumentos nomeados para `action'.

O valor de retorno é um evento que pode ser usado para cancelamento posterior do evento (veja @ref{1a88,,cancel()}).


Alterado na versão 3.3: o parâmetro `argument' é opcional.



Alterado na versão 3.3: o parâmetro `kwargs' foi adicionado.

@end deffn

@geindex enter() (método sched.scheduler)
@anchor{library/sched sched scheduler enter}@anchor{1167}
@deffn {Método} scheduler.enter (delay, priority, action, argument=(), kwargs=@{@})

Agenda um evento para atrasar `delay' mais unidades de tempo. Além do tempo relativo, os outros argumentos, o efeito e o valor de retorno são os mesmos de @ref{1168,,enterabs()}.


Alterado na versão 3.3: o parâmetro `argument' é opcional.



Alterado na versão 3.3: o parâmetro `kwargs' foi adicionado.

@end deffn

@geindex cancel() (método sched.scheduler)
@anchor{library/sched sched scheduler cancel}@anchor{1a88}
@deffn {Método} scheduler.cancel (event)

Remove o evento da fila. Se `event' não for um evento atualmente na fila, este método levantará uma @ref{202,,ValueError}.
@end deffn

@geindex empty() (método sched.scheduler)
@anchor{library/sched sched scheduler empty}@anchor{3439}
@deffn {Método} scheduler.empty ()

Retorna @code{True} se a fila de eventos estiver vazia.
@end deffn

@geindex run() (método sched.scheduler)
@anchor{library/sched sched scheduler run}@anchor{1165}
@deffn {Método} scheduler.run (blocking=True)

Executa todos os eventos agendados. Este método aguardará (usando a função `delayfunc' passada ao construtor) o próximo evento, depois o executará e assim por diante até que não haja mais eventos agendados.

Se `blocking' for falso, executa os eventos agendados que expirarão mais cedo (se houver) e então retorna o prazo da próxima chamada agendada no agendador (se houver).

Tanto `action' quanto `delayfunc' podem levantar uma exceção. Em ambos os casos, o agendador manterá um estado consistente e propagará a exceção. Se uma exceção for gerada por `action', o evento não será tentado em chamadas futuras para @ref{1165,,run()}.

Se uma sequência de eventos demorar mais para ser executada do que o tempo disponível antes do próximo evento, o agendador simplesmente ficará para trás. Nenhum evento será descartado; o código de chamada é responsável por cancelar eventos que não são mais pertinentes.


Alterado na versão 3.3: O argumento `blocking' foi adicionado.

@end deffn

@geindex queue (atributo sched.scheduler)
@anchor{library/sched sched scheduler queue}@anchor{343a}
@deffn {Atributo} scheduler.queue

Atributo somente leitura que retorna uma lista de eventos futuros na ordem em que serão executados. Cada evento é exibido como uma @ref{64e,,tupla nomeada} com os seguintes campos: time, priority, action, argument, kwargs.
@end deffn

@node queue — A synchronized queue class,contextvars — Variáveis de contexto,sched — Agendador de eventos,Execução Concorrente
@anchor{library/queue doc}@anchor{343b}@anchor{library/queue module-queue}@anchor{b6}@anchor{library/queue queue-a-synchronized-queue-class}@anchor{343c}@anchor{library/queue translation-repo}@anchor{343d}
@subsection @code{queue} — A synchronized queue class


@geindex module; queue

`Código-fonte:' Lib/queue.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/queue.py}


__________________________________________________________________


The @ref{b6,,queue} module implements multi-producer, multi-consumer queues.
It is especially useful in threaded programming when information must be
exchanged safely between multiple threads.  The @ref{13db,,Queue} class in this
module implements all the required locking semantics.

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.

Internally, those three types of queues use locks to temporarily block
competing threads; however, they are not designed to handle reentrancy
within a thread.

In addition, the module implements a “simple”
@abbr{FIFO} queue type, @ref{b80,,SimpleQueue}, whose
specific implementation provides additional guarantees
in exchange for the smaller functionality.

The @ref{b6,,queue} module defines the following classes and exceptions:

@geindex Queue (classe em queue)
@anchor{library/queue queue Queue}@anchor{13db}
@deffn {Classe} queue.Queue (maxsize=0)

Constructor for a @abbr{FIFO} queue.  `maxsize' is
an integer that sets the upperbound
limit on the number of items that can be placed in the queue.  Insertion will
block once this size has been reached, until queue items are consumed.  If
`maxsize' is less than or equal to zero, the queue size is infinite.
@end deffn

@geindex LifoQueue (classe em queue)
@anchor{library/queue queue LifoQueue}@anchor{23eb}
@deffn {Classe} queue.LifoQueue (maxsize=0)

Constructor for a @abbr{LIFO} queue.  `maxsize' is
an integer that sets the upperbound
limit on the number of items that can be placed in the queue.  Insertion will
block once this size has been reached, until queue items are consumed.  If
`maxsize' is less than or equal to zero, the queue size is infinite.
@end deffn

@geindex PriorityQueue (classe em queue)
@anchor{library/queue queue PriorityQueue}@anchor{23ec}
@deffn {Classe} queue.PriorityQueue (maxsize=0)

Constructor for a priority queue.  `maxsize' is an integer that sets the upperbound
limit on the number of items that can be placed in the queue.  Insertion will
block once this size has been reached, until queue items are consumed.  If
`maxsize' is less than or equal to zero, the queue size is infinite.

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

If the `data' elements are not comparable, the data can be wrapped in a class
that ignores the data item and only compares the priority number:

@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 (classe em queue)
@anchor{library/queue queue SimpleQueue}@anchor{b80}
@deffn {Classe} queue.SimpleQueue

Constructor for an unbounded @abbr{FIFO} queue.
Simple queues lack advanced functionality such as task tracking.


Adicionado na versão 3.7.

@end deffn

@geindex Empty
@anchor{library/queue queue Empty}@anchor{3350}
@deffn {Exceção} queue.Empty

Exception raised when non-blocking @ref{2ea9,,get()} (or
@ref{343e,,get_nowait()}) is called
on a @ref{13db,,Queue} object which is empty.
@end deffn

@geindex Full
@anchor{library/queue queue Full}@anchor{3351}
@deffn {Exceção} queue.Full

Exception raised when non-blocking @ref{343f,,put()} (or
@ref{2ea8,,put_nowait()}) is called
on a @ref{13db,,Queue} object which is full.
@end deffn

@geindex ShutDown
@anchor{library/queue queue ShutDown}@anchor{23b}
@deffn {Exceção} queue.ShutDown

Exception raised when @ref{343f,,put()} or @ref{2ea9,,get()} is called on
a @ref{13db,,Queue} object which has been shut down.


Adicionado na versão 3.13.

@end deffn

@menu
* Objetos Queue:: 
* Objetos SimpleQueue:: 

@end menu

@node Objetos Queue,Objetos SimpleQueue,,queue — A synchronized queue class
@anchor{library/queue queue-objects}@anchor{3440}@anchor{library/queue queueobjects}@anchor{3441}
@subsubsection Objetos Queue


Queue objects (@ref{13db,,Queue}, @ref{23eb,,LifoQueue}, or @ref{23ec,,PriorityQueue})
provide the public methods described below.

@geindex qsize() (método queue.Queue)
@anchor{library/queue queue Queue qsize}@anchor{3442}
@deffn {Método} Queue.qsize ()

Return the approximate size of the queue.  Note, qsize() > 0 doesn’t
guarantee that a subsequent get() will not block, nor will qsize() < maxsize
guarantee that put() will not block.
@end deffn

@geindex empty() (método queue.Queue)
@anchor{library/queue queue Queue empty}@anchor{3443}
@deffn {Método} Queue.empty ()

Return @code{True} if the queue is empty, @code{False} otherwise.  If empty()
returns @code{True} it doesn’t guarantee that a subsequent call to put()
will not block.  Similarly, if empty() returns @code{False} it doesn’t
guarantee that a subsequent call to get() will not block.
@end deffn

@geindex full() (método queue.Queue)
@anchor{library/queue queue Queue full}@anchor{3444}
@deffn {Método} Queue.full ()

Return @code{True} if the queue is full, @code{False} otherwise.  If full()
returns @code{True} it doesn’t guarantee that a subsequent call to get()
will not block.  Similarly, if full() returns @code{False} it doesn’t
guarantee that a subsequent call to put() will not block.
@end deffn

@geindex put() (método queue.Queue)
@anchor{library/queue queue Queue put}@anchor{343f}
@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{3351,,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{3351,,Full} exception (`timeout' is
ignored in that case).

Raises @ref{23b,,ShutDown} if the queue has been shut down.
@end deffn

@geindex put_nowait() (método queue.Queue)
@anchor{library/queue queue Queue put_nowait}@anchor{2ea8}
@deffn {Método} Queue.put_nowait (item)

Equivalent to @code{put(item, block=False)}.
@end deffn

@geindex get() (método queue.Queue)
@anchor{library/queue queue Queue get}@anchor{2ea9}
@deffn {Método} Queue.get (block=True, timeout=None)

Remove and return an item from the queue.  If optional args `block' is true and
`timeout' is @code{None} (the default), block if necessary until an item is available.
If `timeout' is a positive number, it blocks at most `timeout' seconds and
raises the @ref{3350,,Empty} exception if no item was available within that time.
Otherwise (`block' is false), return an item if one is immediately available,
else raise the @ref{3350,,Empty} exception (`timeout' is ignored in that case).

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{9d9,,KeyboardInterrupt}.

Raises @ref{23b,,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 queue.Queue)
@anchor{library/queue queue Queue get_nowait}@anchor{343e}
@deffn {Método} Queue.get_nowait ()

Equivalente a @code{get(False)}.
@end deffn

Two methods are offered to support tracking whether enqueued tasks have been
fully processed by daemon consumer threads.

@geindex task_done() (método queue.Queue)
@anchor{library/queue queue Queue task_done}@anchor{334c}
@deffn {Método} Queue.task_done ()

Indicate that a formerly enqueued task is complete.  Used by queue consumer
threads.  For each @ref{2ea9,,get()} used to fetch a task, a subsequent call to
@ref{334c,,task_done()} tells the queue that the processing on the task is complete.

If a @ref{334d,,join()} is currently blocking, it will resume when all items have been
processed (meaning that a @ref{334c,,task_done()} call was received for every item
that had been @ref{343f,,put()} into the queue).

Levanta @ref{202,,ValueError} se for chamado mais vezes do que o número de itens colocados na fila.
@end deffn

@geindex join() (método queue.Queue)
@anchor{library/queue queue Queue join}@anchor{334d}
@deffn {Método} Queue.join ()

Blocks until all items in the queue have been gotten and processed.

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{334c,,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{334d,,join()} unblocks.
@end deffn

@menu
* Waiting for task completion:: 
* Terminating queues:: 

@end menu

@node Waiting for task completion,Terminating queues,,Objetos Queue
@anchor{library/queue waiting-for-task-completion}@anchor{3445}
@subsubsection Waiting for task completion


Example of how to wait for enqueued tasks to be completed:

@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

@node Terminating queues,,Waiting for task completion,Objetos Queue
@anchor{library/queue terminating-queues}@anchor{3446}
@subsubsection Terminating queues


When no longer needed, @ref{13db,,Queue} objects can be wound down
until empty or terminated immediately with a hard shutdown.

@geindex shutdown() (método queue.Queue)
@anchor{library/queue queue Queue shutdown}@anchor{23a}
@deffn {Método} Queue.shutdown (immediate=False)

Coloca uma instância de @ref{13db,,Queue} em modo de desligamento.

The queue can no longer grow.
Future calls to @ref{343f,,put()} raise @ref{23b,,ShutDown}.
Currently blocked callers of @ref{343f,,put()} will be unblocked
and will raise @ref{23b,,ShutDown} in the formerly blocked thread.

Se `immediate' for falso (o padrão), a fila pode ser encerrada normalmente com chamadas @ref{2ea9,,get()} para extrair tarefas que já foram carregadas.

E se @ref{334c,,task_done()} for chamado para cada tarefa restante, um @ref{334d,,join()} pendente será desbloqueado normalmente.

Once the queue is empty, future calls to @ref{2ea9,,get()} will
raise @ref{23b,,ShutDown}.

If `immediate' is true, the queue is terminated immediately.
The queue is drained to be completely empty and the count
of unfinished tasks is reduced by the number of tasks drained.
If unfinished tasks is zero, callers of @ref{334d,,join()}
are unblocked.  Also, blocked callers of @ref{2ea9,,get()}
are unblocked and will raise @ref{23b,,ShutDown} because the
queue is empty.

Tenha cuidado ao usar @ref{334d,,join()} com a opção `immediate' definida como verdadeiro. Isso desbloqueia a junção mesmo quando nenhuma tarefa foi executada, violando a invariante usual para a junção de uma fila.


Adicionado na versão 3.13.

@end deffn

@node Objetos SimpleQueue,,Objetos Queue,queue — A synchronized queue class
@anchor{library/queue simplequeue-objects}@anchor{3447}
@subsubsection Objetos SimpleQueue


@ref{b80,,SimpleQueue} objects provide the public methods described below.

@geindex qsize() (método queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue qsize}@anchor{3448}
@deffn {Método} SimpleQueue.qsize ()

Return the approximate size of the queue.  Note, qsize() > 0 doesn’t
guarantee that a subsequent get() will not block.
@end deffn

@geindex empty() (método queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue empty}@anchor{3449}
@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 queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue put}@anchor{344a}
@deffn {Método} SimpleQueue.put (item, block=True, timeout=None)

Put `item' into the queue.  The method never blocks and always succeeds
(except for potential low-level errors such as failure to allocate memory).
The optional args `block' and `timeout' are ignored and only provided
for compatibility with @ref{343f,,Queue.put()}.

`Detalhes da implementação do CPython:' This method has a C implementation which is reentrant.  That is, a
@code{put()} or @code{get()} call can be interrupted by another @code{put()}
call in the same thread without deadlocking or corrupting internal
state inside the queue.  This makes it appropriate for use in
destructors such as @code{__del__} methods or @ref{114,,weakref} callbacks.
@end deffn

@geindex put_nowait() (método queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue put_nowait}@anchor{344b}
@deffn {Método} SimpleQueue.put_nowait (item)

Equivalent to @code{put(item, block=False)}, provided for compatibility with
@ref{2ea8,,Queue.put_nowait()}.
@end deffn

@geindex get() (método queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue get}@anchor{344c}
@deffn {Método} SimpleQueue.get (block=True, timeout=None)

Remove and return an item from the queue.  If optional args `block' is true and
`timeout' is @code{None} (the default), block if necessary until an item is available.
If `timeout' is a positive number, it blocks at most `timeout' seconds and
raises the @ref{3350,,Empty} exception if no item was available within that time.
Otherwise (`block' is false), return an item if one is immediately available,
else raise the @ref{3350,,Empty} exception (`timeout' is ignored in that case).
@end deffn

@geindex get_nowait() (método queue.SimpleQueue)
@anchor{library/queue queue SimpleQueue get_nowait}@anchor{344d}
@deffn {Método} SimpleQueue.get_nowait ()

Equivalente a @code{get(False)}.
@end deffn


@subsubheading Ver também



@table @asis

@item Class @ref{1914,,multiprocessing.Queue}

A queue class for use in a multi-processing (rather than multi-threading)
context.
@end table

@ref{5dc,,collections.deque} is an alternative implementation of unbounded
queues with fast atomic @ref{26ad,,append()} and
@ref{26b3,,popleft()} operations that do not require locking
and also support indexing.


@node contextvars — Variáveis de contexto,_thread— API de segmentação de baixo nível,queue — A synchronized queue class,Execução Concorrente
@anchor{library/contextvars doc}@anchor{344e}@anchor{library/contextvars contextvars-context-variables}@anchor{344f}@anchor{library/contextvars module-contextvars}@anchor{24}@anchor{library/contextvars translation-repo}@anchor{3450}
@subsection @code{contextvars} — Variáveis de contexto


@geindex module; contextvars


__________________________________________________________________


Este módulo fornece APIs para gerenciar, armazenar e acessar o estado local do contexto. A classe @ref{1643,,ContextVar} é usada para declarar e trabalhar com `Variáveis de Contexto'. A função @ref{3451,,copy_context()} e a classe @ref{15b7,,Context} devem ser usadas para gerenciar o contexto atual em frameworks assíncronos.

Os gerenciadores de contexto que possuem estado devem usar Variáveis de Contexto ao invés de @ref{1631,,threading.local()} para evitar que seu estado vaze para outro código inesperadamente, quando usado em código concorrente.

Veja também a 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para detalhes adicionais.


Adicionado na versão 3.7.


@menu
* Variáveis de contexto:: 
* Gerenciamento de contexto manual:: 
* Suporte a asyncio:: 

@end menu

@node Variáveis de contexto,Gerenciamento de contexto manual,,contextvars — Variáveis de contexto
@anchor{library/contextvars context-variables}@anchor{3452}
@subsubsection Variáveis de contexto


@geindex ContextVar (classe em contextvars)
@anchor{library/contextvars contextvars ContextVar}@anchor{1643}
@deffn {Classe} contextvars.ContextVar (name[, *, default])

Esta classe é usada para declarar uma nova variável de contexto, como, por exemplo:

@example
var: ContextVar[int] = ContextVar('var', default=42)
@end example

O parâmetro obrigatório `name' é usado para fins de introspecção e depuração.

O parâmetro somente-nomeado opcional `default' é retornado por @ref{3453,,ContextVar.get()} quando nenhum valor para a variável é encontrado no contexto atual.

`Importante:' Variáveis de Contexto devem ser criadas no nível do módulo superior e nunca em fechamentos. Os objetos @ref{15b7,,Context} contêm referências fortes a variáveis de contexto que evitam que as variáveis de contexto sejam coletadas como lixo corretamente.

@geindex name (atributo contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar name}@anchor{3454}
@deffn {Atributo} name

O nome da variável. Esta é uma propriedade somente leitura.


Adicionado na versão 3.7.1.

@end deffn

@geindex get() (método contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar get}@anchor{3453}
@deffn {Método} get ([default])

Retorna um valor para a variável de contexto para o contexto atual.

Se não houver valor para a variável no contexto atual, o método vai:


@itemize *

@item 
retornar o valor do argumento `default' do método, se fornecido; ou

@item 
retornar o valor padrão para a variável de contexto, se ela foi criada com uma; ou

@item 
levantar uma @ref{2367,,LookupError}.
@end itemize
@end deffn

@geindex set() (método contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar set}@anchor{15b8}
@deffn {Método} set (value)

Chame para definir um novo valor para a variável de contexto no contexto atual.

O argumento `value' obrigatório é o novo valor para a variável de contexto.

Retorna um objeto @ref{3455,,Token} que pode ser usado para restaurar a variável ao seu valor anterior através do método @ref{3456,,ContextVar.reset()}.
@end deffn

@geindex reset() (método contextvars.ContextVar)
@anchor{library/contextvars contextvars ContextVar reset}@anchor{3456}
@deffn {Método} reset (token)

Redefine a variável de contexto para o valor que tinha antes de @ref{15b8,,ContextVar.set()}. que criou o `token', ser usado.

Por exemplo:

@example
var = ContextVar('var')

token = var.set('novo valor')
# código que usa 'var'; var.get() retorna 'novo valor'.
var.reset(token)

# Após uma chamada de redefinição, var não tem mais valor,
# então var.get() levantaria uma exceção LookupError.
@end example

The same `token' cannot be used twice.
@end deffn
@end deffn

@geindex Token (classe em contextvars)
@anchor{library/contextvars contextvars Token}@anchor{3455}
@deffn {Classe} contextvars.Token

`Token' objects are returned by the @ref{15b8,,ContextVar.set()} method.
They can be passed to the @ref{3456,,ContextVar.reset()} method to revert
the value of the variable to what it was before the corresponding
`set'. A single token cannot reset a context variable more than once.

@geindex var (atributo contextvars.Token)
@anchor{library/contextvars contextvars Token var}@anchor{3457}
@deffn {Atributo} var

Uma propriedade somente leitura. Aponta para o objeto @ref{1643,,ContextVar} que criou o token.
@end deffn

@geindex old_value (atributo contextvars.Token)
@anchor{library/contextvars contextvars Token old_value}@anchor{3458}
@deffn {Atributo} old_value

Uma propriedade somente leitura. Definida com o valor que a variável tinha antes da chamada do método @ref{15b8,,ContextVar.set()} que criou o token. Aponta para @ref{3459,,Token.MISSING} se a variável não foi definida antes da chamada.
@end deffn

@geindex MISSING (atributo contextvars.Token)
@anchor{library/contextvars contextvars Token MISSING}@anchor{3459}
@deffn {Atributo} MISSING

Um objeto marcador usado por @ref{3458,,Token.old_value}.
@end deffn
@end deffn

@node Gerenciamento de contexto manual,Suporte a asyncio,Variáveis de contexto,contextvars — Variáveis de contexto
@anchor{library/contextvars manual-context-management}@anchor{345a}
@subsubsection Gerenciamento de contexto manual


@geindex copy_context() (no módulo contextvars)
@anchor{library/contextvars contextvars copy_context}@anchor{3451}
@deffn {Função} contextvars.copy_context ()

Retorna uma cópia do objeto @ref{15b7,,Context} atual.

O trecho a seguir obtém uma cópia do contexto atual e imprime todas as variáveis e seus valores que estão definidos nele:

@example
ctx: Context = copy_context()
print(list(ctx.items()))
@end example

A função tem uma complexidade `O'(1), ou seja, funciona igualmente rápida para contextos com algumas variáveis de contexto e para contextos que têm muitas delas.
@end deffn

@geindex Context (classe em contextvars)
@anchor{library/contextvars contextvars Context}@anchor{15b7}
@deffn {Classe} contextvars.Context

Um mapeamento de @ref{1643,,ContextVars} para seus valores.

@code{Context()} cria um contexto vazio sem valores nele. Para obter uma cópia do contexto atual, use a função @ref{3451,,copy_context()}.

Cada thread tem sua própria pilha efetiva de objetos @code{Context}. O @ref{1697,,contexto atual} é o objeto @code{Context} no topo da pilha da thread atual. Todos os objetos @code{Context} nas pilhas são considerados como `inseridos'.

`Inserir' um contexto, o que pode ser feito chamando seu método @ref{16f3,,run()}, torna o contexto o contexto atual, colocando-o no topo da pilha de contexto da thread atual.

`Sair' do contexto atual, o que pode ser feito retornando do retorno de chamada passado para o método @ref{16f3,,run()}, restaura o contexto atual para o que era antes de o contexto ser inserido, retirando o contexto do topo da pilha de contextos.

Como cada thread tem sua própria pilha de contexto, os objetos @ref{1643,,ContextVar} se comportam de maneira semelhante a @ref{1631,,threading.local()} quando valores são atribuídos em threads diferentes.

Tentar entrar em um contexto já inserido, incluindo contextos inseridos em outras threads, levanta uma exceção @ref{195,,RuntimeError}.

Após sair de um contexto, ele pode ser acessado novamente (de qualquer thread).

Quaisquer alterações nos valores de @ref{1643,,ContextVar} por meio do método @ref{15b8,,ContextVar.set()} são registradas no contexto atual. O método @ref{3453,,ContextVar.get()} retorna o valor associado ao contexto atual. Sair de um contexto efetivamente reverte quaisquer alterações feitas nas variáveis de contexto enquanto o contexto foi inserido (se necessário, os valores podem ser restaurados ao inserir novamente o contexto).

Context implementa a interface @ref{8d0,,collections.abc.Mapping}.

@geindex run() (método contextvars.Context)
@anchor{library/contextvars contextvars Context run}@anchor{16f3}
@deffn {Método} run (callable, *args, **kwargs)

Entra no Context, executa @code{callable(*args, **kwargs)} e sai do Context. Retorna o valor de retorno de `callable' ou propaga uma exceção, se ocorrer uma.

Exemplo:

@example
import contextvars

var = contextvars.ContextVar('var')
var.set('spam')
print(var.get())  # 'spam'

ctx = contextvars.copy_context()

def main():
    # 'var' foi definida para 'spam' antes de
    # chamar 'copy_context()' e 'ctx.run(main)', então:
    print(var.get())  # 'spam'
    print(ctx[var])  # 'spam'

    var.set('ham')

    # Agora, após definir 'var' para 'ham':
    print(var.get())  # 'ham'
    print(ctx[var])  # 'ham'

# Qualquer alteração que a função 'main' feitas a 'var'
# serão contidos em 'ctx'.
ctx.run(main)

# A função 'main()' era executada no contexto 'ctx',
# então alterações a 'var' são contidas nele:
print(ctx[var])  # 'ham'

# No entanto, fora de 'ctx', 'var' ainda está definida para '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 contextvars.Context)
@anchor{library/contextvars contextvars Context copy}@anchor{345b}
@deffn {Método} copy ()

Retorna uma cópia rasa do objeto contexto.
@end deffn


@deffn {Describe} var in context

Retorna @code{True} se `context' tem uma variável para `var' definida; do contrário, retorna @code{False}.
@end deffn


@deffn {Describe} context[var]

Retorna o valor da variável @ref{1643,,ContextVar} `var'. Se a variável não for definida no objeto contexto, uma @ref{344,,KeyError} é levantada.
@end deffn

@geindex get() (método contextvars.Context)
@anchor{library/contextvars contextvars Context get}@anchor{345c}
@deffn {Método} get (var[, default])

Retorna o valor para `var' se `var' tiver o valor no objeto contexto. Caso contrário, retorna `default'. Se `default' não for fornecido, retorna @code{None}.
@end deffn


@deffn {Describe} iter(context)

Retorna um iterador sobre as variáveis armazenadas no objeto contexto.
@end deffn


@deffn {Describe} len(proxy)

Retorna o número das variáveis definidas no objeto contexto.
@end deffn

@geindex keys() (método contextvars.Context)
@anchor{library/contextvars contextvars Context keys}@anchor{345d}
@deffn {Método} keys ()

Retorna uma lista de todas as variáveis no objeto contexto.
@end deffn

@geindex values() (método contextvars.Context)
@anchor{library/contextvars contextvars Context values}@anchor{345e}
@deffn {Método} values ()

Retorna uma lista dos valores de todas as variáveis no objeto contexto.
@end deffn

@geindex items() (método contextvars.Context)
@anchor{library/contextvars contextvars Context items}@anchor{345f}
@deffn {Método} items ()

Retorna uma lista de tuplas de 2 elementos contendo todas as variáveis e seus valores no objeto contexto.
@end deffn
@end deffn

@node Suporte a asyncio,,Gerenciamento de contexto manual,contextvars — Variáveis de contexto
@anchor{library/contextvars asyncio-support}@anchor{3460}
@subsubsection Suporte a asyncio


Variáveis de contexto encontram suporte nativo em @ref{a,,asyncio} e estão prontas para serem usadas sem qualquer configuração extra. Por exemplo, aqui está um servidor simples de eco, que usa uma variável de contexto para disponibilizar o endereço de um cliente remoto na Task que lida com esse cliente:

@example
import asyncio
import contextvars

client_addr_var = contextvars.ContextVar('client_addr')

def render_goodbye():
    # O endereço do cliente atualmente manipulado pode ser acessado
    # sem passá-lo explicitamente para esta função.

    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)

    # Em qualquer código que chamamos agora é possível obter
    # o endereço do cliente chamando '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')  # linha de status
    writer.write(b'\r\n')  # cabeçalhos
    writer.write(render_goodbye())  # corpo
    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())

# Para testá-lo, você pode usar telnet ou curl:
#     telnet 127.0.0.1 8081
#     curl 127.0.0.1:8081
@end example

A seguir, os módulos de suporte para alguns dos serviços acima:

@node _thread— API de segmentação de baixo nível,,contextvars — Variáveis de contexto,Execução Concorrente
@anchor{library/_thread doc}@anchor{3461}@anchor{library/_thread module-_thread}@anchor{2}@anchor{library/_thread thread-low-level-threading-api}@anchor{3462}@anchor{library/_thread translation-repo}@anchor{3463}
@subsection @code{_thread}— API de segmentação de baixo nível


@geindex module; _thread

@geindex processos leves
@geindex leves@comma{} processos
@geindex semáforos binários
@geindex binários@comma{} semáforos


__________________________________________________________________


Este módulo fornece primitivos de baixo nível para trabalhar com vários threads (também chamados `processos leves' ou `tarefas') — vários threads de controle compartilhando seu espaço de dados global. Para sincronização, travas simples (também chamadas de `mutexes', `exclusão mútua' ou `semáforos binários') são fornecidas. O módulo @ref{ed,,threading} fornece uma API de segmentação mais fácil de usar e de nível mais alto, construída sobre este módulo.

@geindex pthreads
@geindex threads;POSIX


Alterado na versão 3.7: Este módulo costumava ser opcional, agora está sempre disponível.


Este módulo define as seguintes constantes e funções:

@geindex error
@anchor{library/_thread thread error}@anchor{3464}
@deffn {Exceção} _thread.error

Gerado em erros específicos de segmento.


Alterado na versão 3.3: Agora este é um sinônimo da exceção embutida @ref{195,,RuntimeError}.

@end deffn

@geindex LockType (no módulo _thread)
@anchor{library/_thread thread LockType}@anchor{3465}
@deffn {Dado} _thread.LockType

Este é o tipo de objetos de trava.
@end deffn

@geindex start_new_thread() (no módulo _thread)
@anchor{library/_thread thread start_new_thread}@anchor{196}
@deffn {Função} _thread.start_new_thread (function, args[, kwargs])

Começa uma nova thread e retorna seu identificador. A thread executa a função `function' com a lista de argumentos `args' (que deve ser uma tupla). O argumento opcional `kwargs' especifica um dicionário de argumentos nomeados.

Quando a função retorna, a thread termina silenciosamente.

Quando a função termina com uma exceção não processada, @ref{1f7,,sys.unraisablehook()} é chamada para lidar com a exceção. O atributo `object' do argumento do hook é `function'. Por padrão, um stack trace (situação da pilha de execução) é exibido e, em seguida, a thread termina (mas outras threads continuam a ser executadas).

Quando a função gera uma exceção @ref{d63,,SystemExit}, ela é ignorada.

Levanta um @ref{19fa,,evento de auditoria} @code{_thread.start_new_thread} com os argumentos @code{function}, @code{args}, @code{kwargs}.


Alterado na versão 3.8: @ref{1f7,,sys.unraisablehook()} agora é usada para tratar exceções não tratadas.

@end deffn

@geindex interrupt_main() (no módulo _thread)
@anchor{library/_thread thread interrupt_main}@anchor{846}
@deffn {Função} _thread.interrupt_main (signum=signal.SIGINT, /)

Simula o efeito de um sinal chegando na thread principal. Uma thread pode usar esta função para interromper a thread principal, embora não haja garantia de que a interrupção ocorrerá imediatamente.

Se fornecido, `signum' é o número do sinal a ser simulado. Se `signum' não for fornecido, @ref{847,,signal.SIGINT} será simulado.

Se o sinal fornecido não for tratado pelo Python (o sinal foi definido como @ref{193c,,signal.SIG_DFL} ou @ref{193b,,signal.SIG_IGN}), esta função faz nada.


Alterado na versão 3.10: O argumento `signum' é adicionado para personalizar o sinal de número.


@cartouche
@quotation Nota 
Isso não emite o sinal correspondente, mas agenda uma chamada para o tratador associado (se existir). Se você quer realmente emitir o sinal, use @ref{191a,,signal.raise_signal()}.
@end quotation
@end cartouche
@end deffn

@geindex exit() (no módulo _thread)
@anchor{library/_thread thread exit}@anchor{3466}
@deffn {Função} _thread.exit ()

Levanta a exceção @ref{d63,,SystemExit}. Quando não for detectada, a thread terminará 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() (no módulo _thread)
@anchor{library/_thread thread allocate_lock}@anchor{3467}
@deffn {Função} _thread.allocate_lock ()

Retorna um novo objeto de trava. Métodos de trava são descritos abaixo. A trava é desativada inicialmente.
@end deffn

@geindex get_ident() (no módulo _thread)
@anchor{library/_thread thread get_ident}@anchor{3468}
@deffn {Função} _thread.get_ident ()

Retorna o ‘identificador de thread’ do thread atual. Este é um número inteiro diferente de zero. Seu valor não tem significado direto; pretende-se que seja um cookie mágico para ser usado, por exemplo, para indexar um dicionário de dados específicos do thread. identificadores de thread podem ser reciclados quando um thread sai e outro é criado.
@end deffn

@geindex get_native_id() (no módulo _thread)
@anchor{library/_thread thread get_native_id}@anchor{3469}
@deffn {Função} _thread.get_native_id ()

Retorna a ID de thread integral nativa da thread atual atribuída pelo kernel. Este é um número inteiro não negativo. Seu valor pode ser usado para identificar exclusivamente essa thread específica em todo o sistema (até que a thread termine, após o que o valor poderá ser reciclado pelo sistema operacional).

@ref{1ed8,,Disponibilidade}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Adicionado na versão 3.8.



Alterado na versão 3.13: Adicionado suporte a GNU/kFreeBSD.

@end deffn

@geindex stack_size() (no módulo _thread)
@anchor{library/_thread thread stack_size}@anchor{346a}
@deffn {Função} _thread.stack_size ([size])

Retorna o tamanho da pilha de threads usado ao criar novos threads. O argumento opcional `size' especifica o tamanho da pilha a ser usado para threads criados posteriormente e deve ser 0 (usar plataforma ou padrão configurado) ou um valor inteiro positivo de pelo menos 32.768 (32 KiB). Se `size' não for especificado, 0 será usado. Se a alteração do tamanho da pilha de threads não for suportada, uma @ref{195,,RuntimeError} será levantada. Se o tamanho da pilha especificado for inválido, uma @ref{202,,ValueError} será levantada e o tamanho da pilha não será modificado. Atualmente, 0 KiB é o valor mínimo de tamanho de pilha suportado para garantir espaço suficiente para o próprio interpretador. Observe que algumas plataformas podem ter restrições específicas sobre valores para o tamanho da pilha, como exigir um tamanho mínimo de pilha > 32 KiB ou exigir alocação em múltiplos do tamanho da página de memória do sistema – a documentação da plataforma deve ser consultada para obter mais informações (4 páginas KiB são comuns; usar múltiplos de 4096 para o tamanho da pilha é a abordagem sugerida na ausência de informações mais específicas).

@ref{1ed8,,Disponibilidade}: Windows, pthreads.

Plataformas Unix com suporte a threads POSIX.
@end deffn

@geindex TIMEOUT_MAX (no módulo _thread)
@anchor{library/_thread thread TIMEOUT_MAX}@anchor{346b}
@deffn {Dado} _thread.TIMEOUT_MAX

O valor máximo permitido para o parâmetro `timeout' de @ref{698,,Lock.acquire}. A especificação de um tempo limite maior que esse valor vai levantar um @ref{885,,OverflowError}.


Adicionado na versão 3.2.

@end deffn

Os objetos de trava têm os seguintes métodos:

@geindex acquire() (método _thread.lock)
@anchor{library/_thread thread lock acquire}@anchor{346c}
@deffn {Método} lock.acquire (blocking=True, timeout=-1)

Sem nenhum argumento opcional, esse método adquire a trava incondicionalmente, se necessário, aguardando até que seja liberada por outra thread (apenas uma thread por vez pode adquirir uma trava — esse é o motivo da sua existência).

Se o argumento inteiro `blocking' estiver presente, a ação dependerá do seu valor: se for falso, a trava será adquirida apenas se puder ser adquirida imediatamente sem aguardar, enquanto se for verdadeiro, a trava será adquirida incondicionalmente, conforme acima.

Se o argumento de ponto flutuante `timeout' estiver presente e positivo, ele especificará o tempo máximo de espera em segundos antes de retornar. Um argumento negativo `timeout' especifica uma espera ilimitada. Você não pode especificar um `timeout' se `blocking' for falso.

O valor de retorno é @code{True} se a trava for adquirida com sucesso, se não @code{False}.


Alterado na versão 3.2: O parâmetro `timeout' é novo.



Alterado na versão 3.2: As aquisições de trava agora podem ser interrompidas por sinais no POSIX.

@end deffn

@geindex release() (método _thread.lock)
@anchor{library/_thread thread lock release}@anchor{346d}
@deffn {Método} lock.release ()

Libera a trava. A trava deve ter sido adquirido anteriormente, mas não necessariamente pela mesma thread.
@end deffn

@geindex locked() (método _thread.lock)
@anchor{library/_thread thread lock locked}@anchor{346e}
@deffn {Método} lock.locked ()

Retorna o status da trava: @code{True} se tiver sido adquirida por alguma thread, @code{False} se não for o caso.
@end deffn

Além desses métodos, os objetos de trava também podem ser usados através da instrução @ref{5d2,,with}, por exemplo:

@example
import _thread

uma_trava = _thread.allocate_lock()

with uma_trava:
    print("uma_trava está travada enquanto isto executa")
@end example

`Ressalvas:'

@geindex módulo;signal


@itemize *

@item 
Interrupções sempre vão para a thread principal (a exceção @ref{9d9,,KeyboardInterrupt} será recebida por essa thread).

@item 
Chamar @ref{138e,,sys.exit()} ou levantar a exceção @ref{d63,,SystemExit} é o equivalente a chamar @ref{3466,,_thread.exit()}.

@item 
O método @ref{698,,acquire()} de uma trava ser interrompido depende da plataforma (de modo que a exceção @ref{9d9,,KeyboardInterrupt} acontecerá imediatamente, em vez de quando a trava for travada, ou quando a operação ultrapassar o tempo limite). O método pode ser interrompido em POSIX, mas não em Windows.

@item 
Quando a thread principal se encerra, o fato de outras threads sobreviverem depende do sistema. Na maioria dos sistemas, elas são eliminadas sem executar cláusulas @ref{6e9,,try} … @ref{9d2,,finally} ou destruidores de objetos.
@end itemize

@node Comunicação em Rede e Interprocesso,Manuseio de Dados na Internet,Execução Concorrente,A Biblioteca Padrão do Python
@anchor{library/ipc doc}@anchor{346f}@anchor{library/ipc ipc}@anchor{3470}@anchor{library/ipc networking-and-interprocess-communication}@anchor{3471}@anchor{library/ipc translation-repo}@anchor{3472}
@section Comunicação em Rede e Interprocesso


Os módulos descritos neste capítulo fornecem mecanismos para a comunicação em rede e entre processos.

Alguns módulos funcionam apenas para dois processos que estão na mesma máquina como, por exemplo, @ref{c6,,signal} e @ref{90,,mmap}. Outros módulos possuem suporte a protocolos de rede que dois ou mais processos podem usar para se comunicar entre máquinas.

A lista de módulos descritos neste capítulo é:

@menu
* asyncio — E/S assíncrona:: 
* socket — Interface de rede de baixo nível:: 
* ssl — Invólucro de TLS/SSL para objetos socket:: 
* select — Waiting for I/O completion:: 
* selectors — High-level I/O multiplexing:: 
* signal — Define manipuladores para eventos assíncronos:: 
* mmap — Suporte a arquivos mapeados na memória:: 

@end menu

@node asyncio — E/S assíncrona,socket — Interface de rede de baixo nível,,Comunicação em Rede e Interprocesso
@anchor{library/asyncio doc}@anchor{3473}@anchor{library/asyncio asyncio-asynchronous-i-o}@anchor{3474}@anchor{library/asyncio module-asyncio}@anchor{a}
@subsection @code{asyncio} — E/S assíncrona


@geindex module; asyncio


__________________________________________________________________


@subsubheading Olá Mundo!



@example
import asyncio

async def main():
    print('Olá ...')
    await asyncio.sleep(1)
    print('... Mundo!')

asyncio.run(main())
@end example

asyncio é uma biblioteca para escrever código `simultâneo' usando a sintaxe `async/await'.

O asyncio é usado como uma base para várias estruturas assíncronas do Python que fornecem rede e servidores web de alto desempenho, bibliotecas de conexão de banco de dados, filas de tarefas distribuídas etc.

asyncio geralmente serve perfeitamente para código de rede `estruturado' de alto nível e vinculado a E/S.


@subsubheading Ver também



@table @asis

@item @ref{3475,,Uma visão geral conceitual de asyncio}

Explicação dos fundamentos do asyncio.
@end table


asyncio fornece um conjunto de APIs de `alto nível' para:


@itemize *

@item 
@ref{3476,,executar corrotinas do Python} simultaneamente e ter controle total sobre sua execução;

@item 
realizar @ref{3477,,IPC e E/S de rede};

@item 
controlar @ref{3478,,subprocessos};

@item 
distribuir tarefas por meio de @ref{3479,,filas};

@item 
@ref{347a,,sincronizar} código simultâneo;
@end itemize

Além disso, há APIs de `baixo nível' para `desenvolvedores de biblioteca e framework' para:


@itemize *

@item 
criar e gerenciar @ref{d9e,,laços de eventos}, que fornecem APIs assíncronas para @ref{347b,,rede}, execução de @ref{347c,,subprocessos}, tratamento de @ref{347d,,sinais de sistemas operacionais} etc;

@item 
implementar protocolos eficientes usando @ref{347e,,transportes};

@item 
@ref{347f,,fazer uma ponte} sobre bibliotecas baseadas em chamadas e codificar com a sintaxe de async/await.
@end itemize

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.
@anchor{library/asyncio asyncio-cli}@anchor{3480}
@subsubheading REPL de asyncio


Você pode experimentar um contexto atual @code{asyncio} no @ref{16a,,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

Este REPL oferece compatibilidade limitada com a variável de ambiente 
@geindex PYTHON_BASIC_REPL
@geindex variável de ambiente; PYTHON_BASIC_REPL
@ref{16e,,PYTHON_BASIC_REPL}. Recomenda-se o uso do REPL padrão para obter todas as funcionalidades e os recursos mais recentes.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_stdin} sem argumentos.


Alterado na versão 3.12.5: (também 3.11.10, 3.10.15, 3.9.20 e 3.8.20) Emite eventos de auditoria.



Alterado na versão 3.13: Usa PyrePL, se possível, nesse caso 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} também é executado. Emite eventos de auditoria.


@c We use the "rubric" directive here to avoid creating
@c the "Reference" subsection in the TOC.

@subsubheading Referência


@menu
* Runners:: 
* Corrotinas e tarefas:: 
* Streams:: 
* Synchronization Primitives:: 
* Subprocessos:: 
* Filas:: 
* Exceções: Exceções<13>. 
* Laço de eventos:: 
* Futuros:: 
* Transports e Protocols:: 
* Políticas:: 
* Suporte a plataformas:: 
* Extensão:: 
* Índice da API de alto nível:: 
* Índice de APIs de baixo nível:: 
* Desenvolvendo com asyncio:: 

@end menu

@node Runners,Corrotinas e tarefas,,asyncio — E/S assíncrona
@anchor{library/asyncio-runner doc}@anchor{3481}@anchor{library/asyncio-runner runners}@anchor{3482}
@subsubsection Runners


`Source code:' Lib/asyncio/runners.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/runners.py}

This section outlines high-level asyncio primitives to run asyncio code.

They are built on top of an @ref{d9e,,event loop} with the aim
to simplify async code usage for common wide-spread scenarios.

@menu
* Executando um programa asyncio:: 
* Runner context manager:: 
* Handling Keyboard Interruption:: 

@end menu

@node Executando um programa asyncio,Runner context manager,,Runners
@anchor{library/asyncio-runner running-an-asyncio-program}@anchor{3483}
@subsubsection Executando um programa asyncio


@geindex run() (no módulo asyncio)
@anchor{library/asyncio-runner asyncio run}@anchor{47c}
@deffn {Função} asyncio.run (coro, *, debug=None, loop_factory=None)

Executa a @ref{491,,corrotina} `coro' e retorna o resultado.

This function runs the passed coroutine, taking care of
managing the asyncio event loop, `finalizing asynchronous
generators', and closing the executor.

Esta função não pode ser chamada quando outro laço de eventos asyncio está executando na mesma thread.

If `debug' is @code{True}, the event loop will be run in debug mode. @code{False} disables
debug mode explicitly. @code{None} is used to respect the global
@ref{1ed3,,Modo de Depuração} settings.

If `loop_factory' is not @code{None}, it is used to create a new event loop;
otherwise @ref{3484,,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{17e9,,asyncio.EventLoop} allows running asyncio without the
policy system.

The executor is given a timeout duration of 5 minutes to shutdown.
If the executor hasn’t finished within that duration, a warning is
emitted and the executor is closed.

Exemplo:

@example
async def main():
    await asyncio.sleep(1)
    print('hello')

asyncio.run(main())
@end example


Adicionado na versão 3.7.



Alterado na versão 3.9: Atualizado para usar @ref{8ed,,loop.shutdown_default_executor()}.



Alterado na versão 3.10: `debug' is @code{None} by default to respect the global debug mode settings.



Alterado na versão 3.12: Added `loop_factory' parameter.

@end deffn

@node Runner context manager,Handling Keyboard Interruption,Executando um programa asyncio,Runners
@anchor{library/asyncio-runner runner-context-manager}@anchor{3485}
@subsubsection Runner context manager


@geindex Runner (classe em asyncio)
@anchor{library/asyncio-runner asyncio Runner}@anchor{600}
@deffn {Classe} asyncio.Runner (*, debug=None, loop_factory=None)

A context manager that simplifies `multiple' async function calls in the same
context.

Sometimes several top-level async functions should be called in the same @ref{d9e,,event loop} and @ref{15b7,,contextvars.Context}.

If `debug' is @code{True}, the event loop will be run in debug mode. @code{False} disables
debug mode explicitly. @code{None} is used to respect the global
@ref{1ed3,,Modo de Depuração} settings.

`loop_factory' could be used for overriding the loop creation.
It is the responsibility of the `loop_factory' to set the created loop as the
current one. By default @ref{3484,,asyncio.new_event_loop()} is used and set as
current event loop with @ref{18df,,asyncio.set_event_loop()} if `loop_factory' is @code{None}.

Basically, @ref{47c,,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


Adicionado na versão 3.11.


@geindex run() (método asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner run}@anchor{17a1}
@deffn {Método} run (coro, *, context=None)

Run a @ref{491,,coroutine} `coro' in the embedded loop.

Return the coroutine’s result or raise its exception.

An optional keyword-only `context' argument allows specifying a
custom @ref{15b7,,contextvars.Context} for the `coro' to run in.
The runner’s default context is used if @code{None}.

Esta função não pode ser chamada quando outro laço de eventos asyncio está executando na mesma thread.
@end deffn

@geindex close() (método asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner close}@anchor{3486}
@deffn {Método} close ()

Close the runner.

Finalize asynchronous generators, shutdown default executor, close the event loop
and release embedded @ref{15b7,,contextvars.Context}.
@end deffn

@geindex get_loop() (método asyncio.Runner)
@anchor{library/asyncio-runner asyncio Runner get_loop}@anchor{3487}
@deffn {Método} get_loop ()

Return the event loop associated with the runner instance.
@end deffn

@cartouche
@quotation Nota 
@ref{600,,Runner} uses the lazy initialization strategy, its constructor doesn’t
initialize underlying low-level structures.

Embedded `loop' and `context' are created at the @ref{5d2,,with} body entering
or the first call of @ref{47c,,run()} or @ref{3487,,get_loop()}.
@end quotation
@end cartouche
@end deffn

@node Handling Keyboard Interruption,,Runner context manager,Runners
@anchor{library/asyncio-runner handling-keyboard-interruption}@anchor{3488}
@subsubsection Handling Keyboard Interruption



Adicionado na versão 3.11.


When @ref{847,,signal.SIGINT} is raised by @code{Ctrl}-@code{C}, @ref{9d9,,KeyboardInterrupt}
exception is raised in the main thread by default. However this doesn’t work with
@ref{a,,asyncio} because it can interrupt asyncio internals and can hang the program from
exiting.

To mitigate this issue, @ref{a,,asyncio} handles @ref{847,,signal.SIGINT} as follows:


@enumerate 

@item 
@ref{17a1,,asyncio.Runner.run()} installs a custom @ref{847,,signal.SIGINT} handler before
any user code is executed and removes it when exiting from the function.

@item 
The @ref{600,,Runner} creates the main task for the passed coroutine for its
execution.

@item 
When @ref{847,,signal.SIGINT} is raised by @code{Ctrl}-@code{C}, the custom signal handler
cancels the main task by calling @ref{1b7,,asyncio.Task.cancel()} which raises
@ref{1b8,,asyncio.CancelledError} inside the main task.  This causes the Python stack
to unwind, @code{try/except} and @code{try/finally} blocks can be used for resource
cleanup.  After the main task is cancelled, @ref{17a1,,asyncio.Runner.run()} raises
@ref{9d9,,KeyboardInterrupt}.

@item 
A user could write a tight loop which cannot be interrupted by
@ref{1b7,,asyncio.Task.cancel()}, in which case the second following @code{Ctrl}-@code{C}
immediately raises the @ref{9d9,,KeyboardInterrupt} without cancelling the main task.
@end enumerate

@node Corrotinas e tarefas,Streams,Runners,asyncio — E/S assíncrona
@anchor{library/asyncio-task doc}@anchor{3489}@anchor{library/asyncio-task coroutines-and-tasks}@anchor{348a}@anchor{library/asyncio-task translation-repo}@anchor{348b}
@subsubsection Corrotinas e tarefas


Esta seção descreve APIs assíncronas de alto nível para trabalhar com corrotinas e tarefas.

@menu
* Corrotinas: Corrotinas<3>. 
* Aguardáveis:: 
* Criando tarefas:: 
* Cancelamento de tarefas:: 
* Grupos de tarefas:: 
* Dormindo:: 
* Executando tarefas concorrentemente:: 
* Fábrica de tarefas ansiosas:: 
* Protegendo contra cancelamento:: 
* Tempo limite:: 
* Primitivas de espera:: 
* Executando em threads:: 
* Agendando a partir de outras threads:: 
* Introspecção:: 
* Objeto Task:: 

@end menu

@node Corrotinas<3>,Aguardáveis,,Corrotinas e tarefas
@anchor{library/asyncio-task coroutine}@anchor{3476}@anchor{library/asyncio-task coroutines}@anchor{348c}
@subsubsection Corrotinas


`Código-fonte:' Lib/asyncio/coroutines.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/coroutines.py}


__________________________________________________________________


@ref{491,,Corrotinas} declaradas com a sintaxe async/await é a forma preferida de escrever aplicações assíncronas. Por exemplo, o seguinte trecho de código imprime “hello”, espera 1 segundo, e então imprime “world”:

@example
>>> import asyncio

>>> async def main():
...     print('hello')
...     await asyncio.sleep(1)
...     print('world')

>>> asyncio.run(main())
hello
world
@end example

Perceba que simplesmente chamar uma corrotina não irá agendá-la para ser executada:

@example
>>> main()
<coroutine object main at 0x1053bb7c8>
@end example

To actually run a coroutine, asyncio provides the following mechanisms:


@itemize *

@item 
A função @ref{47c,,asyncio.run()} para executar a função “main()” do ponto de entrada no nível mais alto (veja o exemplo acima.)

@item 
Aguardando uma corrotina. O seguinte trecho de código exibirá “hello” após esperar por 1 segundo e, em seguida, exibirá “world” após esperar por `outros' 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

Resultado esperado:

@example
started at 17:13:52
hello
world
finished at 17:13:55
@end example

@item 
A função @ref{1bf,,asyncio.create_task()} para executar corrotinas concorrentemente como @ref{1be,,Tasks} asyncio.

Vamos modificar o exemplo acima e executar duas corrotinas @code{say_after} `concorrentemente':

@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

Perceba que a saída esperada agora mostra que o trecho de código é executado 1 segundo mais rápido do que antes:

@example
started at 17:14:32
hello
world
finished at 17:14:34
@end example

@item 
The @ref{1b5,,asyncio.TaskGroup} class provides a more modern
alternative to @ref{1bf,,create_task()}.
Using this API, the last example becomes:

@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

The timing and output should be the same as for the previous version.


Adicionado na versão 3.11: @ref{1b5,,asyncio.TaskGroup}.

@end itemize

@node Aguardáveis,Criando tarefas,Corrotinas<3>,Corrotinas e tarefas
@anchor{library/asyncio-task asyncio-awaitables}@anchor{348d}@anchor{library/asyncio-task awaitables}@anchor{348e}
@subsubsection Aguardáveis


Dizemos que um objeto é um objeto `aguardável' se ele pode ser usado em uma expressão @ref{1b9,,await}. Muitas APIs asyncio são projetadas para aceitar aguardáveis.

Existem três tipos principais de objetos `aguardáveis': `corrotinas', `Tarefas', e `Futuros'.

@subsubheading Corrotinas


Corrotinas Python são `aguardáveis' e portanto podem ser aguardadas a partir de outras corrotinas:

@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 
Nesta documentação, o termo “corrotina” pode ser usado para dois conceitos intimamente relacionados:


@itemize *

@item 
uma `função de corrotina': uma função @ref{5d1,,async def};

@item 
um `objeto de corrotina': um objeto retornado ao chamar uma `função de corrotina'.
@end itemize
@end quotation
@end cartouche

@subsubheading Tarefas


`Tarefas' são usadas para agendar corrotinas `concorrentemente'.

Quando uma corrotina é envolta em uma `tarefa' com funções como @ref{1bf,,asyncio.create_task()}, a corrotina é automaticamente agendada para executar em breve:

@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 Futuros


Um @ref{be6,,Future} é um objeto aguardável especial de `baixo nível' que representa um `resultado eventual' de uma operação assíncrona.

Quando um objeto Future é `aguardado' isso significa que a corrotina irá esperar até que o Future seja resolvido em algum outro local.

Objetos Future em asyncio são necessários para permitir que código baseado em função de retorno seja utilizado com async/await.

Normalmente `não existe necessidade' em criar objetos Future no nível de código da aplicação.

Objetos Future, algumas vezes expostos por bibliotecas e algumas APIs asyncio, podem ser aguardados:

@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

Um bom exemplo de uma função de baixo nível que retorna um objeto Future é @ref{8ef,,loop.run_in_executor()}.

@node Criando tarefas,Cancelamento de tarefas,Aguardáveis,Corrotinas e tarefas
@anchor{library/asyncio-task creating-tasks}@anchor{348f}
@subsubsection Criando tarefas


`Source code:' Lib/asyncio/tasks.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/tasks.py}


__________________________________________________________________


@geindex create_task() (no módulo asyncio)
@anchor{library/asyncio-task asyncio create_task}@anchor{1bf}
@deffn {Função} asyncio.create_task (coro, *, name=None, context=None)

Envolve a @ref{3476,,corrotina} `coro' em uma @ref{1be,,Task} e agenda sua execução. Retorna o objeto Task.

Se `name' não for @code{None}, ele é setado como o nome da tarefa usando @ref{9e5,,Task.set_name()}.

Um argumento opcional somente-nomeado `context' permite especificar um @ref{15b7,,contextvars.Context} personalizado para a `coro' ser executada. Uma cópia do contexto atual é criada quando nenhum `context' for fornecido.

A tarefa é executada no laço e retornada por @ref{b1d,,get_running_loop()}, @ref{195,,RuntimeError} é levantado se não existir um laço em execução na thread atual.

@cartouche
@quotation Nota 
@ref{1bc,,asyncio.TaskGroup.create_task()} é uma nova alternativa que aproveita a concorrência estruturada e permite aguardar um grupo de tarefas relacionadas, com fortes garantias de segurança.
@end quotation
@end cartouche

@cartouche
@quotation Importante 
Mantenha uma referência para o resultado dessa função, evitando que uma tarefa desapareça durante a execução. O laço de eventos mantém apenas referências fracas para as tarefas. Uma tarefa que não é referenciada por nada mais pode ser removida pelo coletor de lixo a qualquer momento, antes mesmo da função ser finalizada. Para tarefas de segundo plano “atire-e-esqueça”, junte-as em uma coleção:

@example
background_tasks = set()for i in range(10):    task = asyncio.create_task(some_coro(param=i))    # Adiciona tarefa ao conjunto. Isto cria uma referência forte.    background_tasks.add(task)    # Para evitar manter referências a tarefas concluídas para sempre,    # fazer com que cada tarefa remova a sua própria referência do conjunto após    # a conclusão:    task.add_done_callback(background_tasks.discard)
@end example
@end quotation
@end cartouche


Adicionado na versão 3.7.



Alterado na versão 3.8: Adicionado o parâmetro `name'.



Alterado na versão 3.11: Adicionado o parâmetro `context'.

@end deffn

@node Cancelamento de tarefas,Grupos de tarefas,Criando tarefas,Corrotinas e tarefas
@anchor{library/asyncio-task task-cancellation}@anchor{3490}
@subsubsection Cancelamento de tarefas


Tasks can easily and safely be cancelled.
When a task is cancelled, @ref{1b8,,asyncio.CancelledError} will be raised
in the task at the next opportunity.

It is recommended that coroutines use @code{try/finally} blocks to robustly
perform clean-up logic. In case @ref{1b8,,asyncio.CancelledError}
is explicitly caught, it should generally be propagated when
clean-up is complete. @ref{1b8,,asyncio.CancelledError} directly subclasses
@ref{5bb,,BaseException} so most code will not need to be aware of it.

The asyncio components that enable structured concurrency, like
@ref{1b5,,asyncio.TaskGroup} and @ref{5fe,,asyncio.timeout()},
are implemented using cancellation internally and might misbehave if
a coroutine swallows @ref{1b8,,asyncio.CancelledError}. Similarly, user code
should not generally call @ref{1bb,,uncancel}.
However, in cases when suppressing @ref{1b8,,asyncio.CancelledError} is
truly desired, it is necessary to also call @code{uncancel()} to completely
remove the cancellation state.

@node Grupos de tarefas,Dormindo,Cancelamento de tarefas,Corrotinas e tarefas
@anchor{library/asyncio-task task-groups}@anchor{3491}@anchor{library/asyncio-task taskgroups}@anchor{3492}
@subsubsection Grupos de tarefas


Grupos de tarefas combinam uma API de criação de tarefas com uma forma conveniente e confiável de aguardar que todas as tarefas do grupo terminem.

@geindex TaskGroup (classe em asyncio)
@anchor{library/asyncio-task asyncio TaskGroup}@anchor{1b5}
@deffn {Classe} asyncio.TaskGroup

Um @ref{5fc,,gerenciador de contexto assíncrono} que contém um grupo de tarefas. As tarefas podem ser adicionadas ao grupo usando @ref{1bf,,create_task()}. Todas as tarefas são aguardadas quando o gerenciador de contexto sai.


Adicionado na versão 3.11.


@geindex create_task() (método asyncio.TaskGroup)
@anchor{library/asyncio-task asyncio TaskGroup create_task}@anchor{1bc}
@deffn {Método} create_task (coro, *, name=None, context=None)

Cria uma tarefa neste grupo de tarefas. A assinatura corresponde à de @ref{1bf,,asyncio.create_task()}. Se o grupo de tarefas estiver inativo (por exemplo, ainda não iniciado, já terminado ou em processo de encerramento), fecharemos a @code{coro} dada.


Alterado na versão 3.13: Fecha a corrotina dada se o grupo de tarefas não estiver ativo.

@end deffn
@end deffn

Exemplo:

@example
async def main():    async with asyncio.TaskGroup() as tg:        task1 = tg.create_task(some_coro(...))        task2 = tg.create_task(another_coro(...))    print(f"Ambas as tarefas estão agora concluídas: @{task1.result()@}, @{task2.result()@}")
@end example

A instrução @code{async with} aguardará que todas as tarefas do grupo terminem. Enquanto aguarda, novas tarefas ainda podem ser adicionadas ao grupo (por exemplo, passando @code{tg} para uma das corrotinas e chamando @code{tg.create_task()} nessa corrotina). Uma vez que a última tarefa tenha terminado e o bloco @code{async with} tenha sido finalizados, não podem ser adicionadas novas tarefas ao grupo.

Na primeira vez que qualquer uma das tarefas do grupo falha com uma exceção diferente de @ref{1b8,,asyncio.CancelledError}, as tarefas restantes do grupo são canceladas. Não podem ser adicionadas mais tarefas ao grupo. Neste ponto, se o corpo da instrução @code{async with} ainda estiver ativo (ou seja, @ref{1716,,__aexit__()} ainda não foi chamado), a tarefa que contém diretamente a instrução @code{async with} também é cancelada. A @ref{1b8,,asyncio.CancelledError} resultante irá interromper um @code{await}, mas não se propagará para fora da instrução @code{async with}.

Uma vez que todas as tarefas tenham terminado, se alguma tarefa falhou com uma exceção diferente de @ref{1b8,,asyncio.CancelledError}, essas exceções são combinadas em uma @ref{1b6,,ExceptionGroup} ou @ref{25f,,BaseExceptionGroup} (conforme apropriado; veja a sua documentação), que é então levantada.

Duas exceções base são tratadas de forma especial: se alguma tarefa falhar com @ref{9d9,,KeyboardInterrupt} ou @ref{d63,,SystemExit}, o grupo de tarefas ainda cancela as tarefas restantes e aguarda por elas, mas depois a @ref{9d9,,KeyboardInterrupt} ou @ref{d63,,SystemExit} inicial é levantada novamente em vez de @ref{1b6,,ExceptionGroup} ou @ref{25f,,BaseExceptionGroup}.

Se o corpo da instrução @code{async with} sair com uma exceção (portanto, @ref{1716,,__aexit__()} é chamado com uma exceção definida), isso é tratado da mesma forma que se uma das tarefas falhasse: as tarefas restantes são canceladas e depois aguardadas, e as exceções de não-cancelamento são agrupadas em um grupo de exceções e levantadas. A exceção passada para @ref{1716,,__aexit__()}, a menos que seja @ref{1b8,,asyncio.CancelledError}, também é incluída no grupo de exceções. O mesmo caso especial é aplicado a @ref{9d9,,KeyboardInterrupt} e @ref{d63,,SystemExit}, como no parágrafo anterior.

Os grupos de tarefas tomam cuidado para não confundir o cancelamento interno, usado para “acordar” o seu @ref{1716,,__aexit__()}, com pedidos de cancelamento para a tarefa na qual estão a ser executados, feitos por outras partes. Em particular, quando um grupo de tarefas está sintaticamente aninhado noutro, e ambos experimentam uma exceção numa das suas tarefas filhas simultaneamente, o grupo de tarefas interno processará as suas exceções, e depois o grupo de tarefas externo receberá outro cancelamento e processará as suas próprias exceções.

No caso de um grupo de tarefas ser cancelado externamente e também precisar levantar uma @ref{1b6,,ExceptionGroup}, chamará o método @ref{1b7,,cancel()} da tarefa pai. Isto garante que um @ref{1b8,,asyncio.CancelledError} será levantada no próximo @ref{1b9,,await}, para que o cancelamento não se perca.

Os grupos de tarefas preservam a contagem de cancelamentos reportada por @ref{1ba,,asyncio.Task.cancelling()}.


Alterado na versão 3.13: Melhoria no tratamento de cancelamentos internos e externos simultâneos e na preservação correta das contagens de cancelamentos.


@menu
* Encerrando um grupo de tarefas:: 

@end menu

@node Encerrando um grupo de tarefas,,,Grupos de tarefas
@anchor{library/asyncio-task terminating-a-task-group}@anchor{3493}
@subsubsection Encerrando um grupo de tarefas


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 Dormindo,Executando tarefas concorrentemente,Grupos de tarefas,Corrotinas e tarefas
@anchor{library/asyncio-task sleeping}@anchor{3494}
@subsubsection Dormindo


@geindex sleep() (no módulo asyncio)
@anchor{library/asyncio-task asyncio sleep}@anchor{a79}
@deffn {Função} async asyncio.sleep (delay, result=None)

Bloqueia por `delay' segundos.

Se `result' é fornecido, é retornado para o autor da chamada quando a corrotina termina.

@code{sleep()} sempre suspende a tarefa atual, permitindo que outras tarefas sejam executadas.

Configurando o delay para 0 fornece um caminho otimizado para permitir que outras tarefas executem. Isto pode ser usado por funções de longa execução para evitar que bloqueiem o laço de eventos por toda a duração da chamada da função.
@anchor{library/asyncio-task asyncio-example-sleep}@anchor{3495}
Exemplo de uma corrotina exibindo a data atual a 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


Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.13: Raises @ref{202,,ValueError} if `delay' is @ref{663,,nan}.

@end deffn

@node Executando tarefas concorrentemente,Fábrica de tarefas ansiosas,Dormindo,Corrotinas e tarefas
@anchor{library/asyncio-task running-tasks-concurrently}@anchor{3496}
@subsubsection Executando tarefas concorrentemente


@geindex gather() (no módulo asyncio)
@anchor{library/asyncio-task asyncio gather}@anchor{5fd}
@deffn {Função} awaitable asyncio.gather (*aws, return_exceptions=False)

Executa @ref{348d,,objetos aguardáveis} na sequência `aws' de forma `concorrente'.

Se qualquer aguardável em `aws' é uma corrotina, ele é automaticamente agendado como uma Tarefa.

Se todos os aguardáveis forem concluídos com sucesso, o resultado é uma lista agregada de valores retornados. A ordem dos valores resultantes corresponde a ordem dos aguardáveis em `aws'.

Se `return_exceptions' for @code{False} (valor padrão), a primeira exceção levantada é imediatamente propagada para a tarefa que espera em @code{gather()}. Outros aguardáveis na sequência `aws' `não serão cancelados' e irão continuar a executar.

Se `return_exceptions' for @code{True}, exceções são tratadas da mesma forma que resultados com sucesso, e agregadas na lista de resultados.

Se @code{gather()} for `cancelado', todos os aguardáveis que foram submetidos (que não foram concluídos ainda) também são `cancelados'.

Se qualquer Tarefa ou Futuro da sequência `aws' for `cancelado', ele é tratado como se tivesse levantado @ref{1b8,,CancelledError} – a chamada para @code{gather()} `não' é cancelada neste caso. Isso existe para prevenir que o cancelamento de uma Tarefa/Futuro submetida ocasione outras Tarefas/Futuros a serem cancelados.

@cartouche
@quotation Nota 
A new alternative to create and run tasks concurrently and
wait for their completion is @ref{1b5,,asyncio.TaskGroup}. `TaskGroup'
provides stronger safety guarantees than `gather' for scheduling a nesting of subtasks:
if a task (or a subtask, a task scheduled by a task)
raises an exception, `TaskGroup' will, while `gather' will not,
cancel the remaining scheduled tasks).
@end quotation
@end cartouche
@anchor{library/asyncio-task asyncio-example-gather}@anchor{3497}
Exemplo:

@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


Alterado na versão 3.7: Se `gather' por si mesmo for cancelado, o cancelamento é propagado independente de `return_exceptions'.



Alterado na versão 3.10: Removido o parâmetro `loop'.



Descontinuado desde a versão 3.10: Aviso de descontinuidade é emitido se nenhum argumento posicional for fornecido, ou nem todos os argumentos posicionais são objetos similar a Futuro, e não existe nenhum laço de eventos em execução.

@end deffn

@node Fábrica de tarefas ansiosas,Protegendo contra cancelamento,Executando tarefas concorrentemente,Corrotinas e tarefas
@anchor{library/asyncio-task eager-task-factory}@anchor{3498}@anchor{library/asyncio-task id1}@anchor{3499}
@subsubsection Fábrica de tarefas ansiosas


@geindex eager_task_factory() (no módulo asyncio)
@anchor{library/asyncio-task asyncio eager_task_factory}@anchor{477}
@deffn {Função} asyncio.eager_task_factory (loop, coro, *, name=None, context=None)

A task factory for eager task execution.

When using this factory (via @ref{dee,,loop.set_task_factory(asyncio.eager_task_factory)}),
coroutines begin execution synchronously during @ref{1be,,Task} construction.
Tasks are only scheduled on the event loop if they block.
This can be a performance improvement as the overhead of loop scheduling
is avoided for coroutines that complete synchronously.

A common example where this is beneficial is coroutines which employ
caching or memoization to avoid actual I/O when possible.

@cartouche
@quotation Nota 
Immediate execution of the coroutine is a semantic change.
If the coroutine returns or raises, the task is never scheduled
to the event loop. If the coroutine execution blocks, the task is
scheduled to the event loop. This change may introduce behavior
changes to existing applications. For example,
the application’s task execution order is likely to change.
@end quotation
@end cartouche


Adicionado na versão 3.12.

@end deffn

@geindex create_eager_task_factory() (no módulo asyncio)
@anchor{library/asyncio-task asyncio create_eager_task_factory}@anchor{478}
@deffn {Função} asyncio.create_eager_task_factory (custom_task_constructor)

Create an eager task factory, similar to @ref{477,,eager_task_factory()},
using the provided `custom_task_constructor' when creating a new task instead
of the default @ref{1be,,Task}.

`custom_task_constructor' must be a `callable' with the signature matching
the signature of @ref{1be,,Task.__init__}.
The callable must return a @ref{1be,,asyncio.Task}-compatible object.

This function returns a `callable' intended to be used as a task factory of an
event loop via @ref{dee,,loop.set_task_factory(factory)}).


Adicionado na versão 3.12.

@end deffn

@node Protegendo contra cancelamento,Tempo limite,Fábrica de tarefas ansiosas,Corrotinas e tarefas
@anchor{library/asyncio-task shielding-from-cancellation}@anchor{349a}
@subsubsection Protegendo contra cancelamento


@geindex shield() (no módulo asyncio)
@anchor{library/asyncio-task asyncio shield}@anchor{a7a}
@deffn {Função} awaitable asyncio.shield (aw)

Protege um @ref{348d,,objeto aguardável} de ser @ref{1b7,,cancelado}.

Se `aw' é uma corrotina, ela é automaticamente agendada como uma Tarefa.

A instrução:

@example
task = asyncio.create_task(something())
res = await shield(task)
@end example

é equivalente a:

@example
res = await something()
@end example

`exceto' que se a corrotina contendo-a for cancelada, a Tarefa executando em @code{something()} não é cancelada. Do ponto de vista de @code{something()}, o cancelamento não aconteceu. Apesar do autor da chamada ainda estar cancelado, então a expressão “await” ainda levanta um @ref{1b8,,CancelledError}.

Se @code{something()} é cancelada por outros meios (isto é, dentro ou a partir de si mesma) isso também iria cancelar @code{shield()}.

Se for desejado ignorar completamente os cancelamentos (não recomendado) a função @code{shield()} deve ser combinada com uma cláusula try/except, conforme abaixo:

@example
task = asyncio.create_task(something())
try:
    res = await shield(task)
except CancelledError:
    res = None
@end example

@cartouche
@quotation Importante 
Mantenha uma referência para as tarefas passadas para essa função função, evitando assim que uma tarefa desapareça durante a execução. O laço de eventos mantém apenas referências fracas para as tarefas. Uma tarefa que não é referenciada por nada mais pode ser removida pelo coletor de lixo a qualquer momento, antes mesmo da função ser finalizada.
@end quotation
@end cartouche


Alterado na versão 3.10: Removido o parâmetro `loop'.



Descontinuado desde a versão 3.10: Aviso de descontinuidade é emitido se `aw' não é um objeto similar a Futuro, e não existe nenhum laço de eventos em execução.

@end deffn

@node Tempo limite,Primitivas de espera,Protegendo contra cancelamento,Corrotinas e tarefas
@anchor{library/asyncio-task timeouts}@anchor{349b}
@subsubsection Tempo limite


@geindex timeout() (no módulo asyncio)
@anchor{library/asyncio-task asyncio timeout}@anchor{5fe}
@deffn {Função} asyncio.timeout (delay)

Return an @ref{5fc,,asynchronous context manager}
that can be used to limit the amount of time spent waiting on
something.

`delay' can either be @code{None}, or a float/int number of
seconds to wait. If `delay' is @code{None}, no time limit will
be applied; this can be useful if the delay is unknown when
the context manager is created.

In either case, the context manager can be rescheduled after
creation using @ref{349c,,Timeout.reschedule()}.

Exemplo:

@example
async def main():
    async with asyncio.timeout(10):
        await long_running_task()
@end example

If @code{long_running_task} takes more than 10 seconds to complete,
the context manager will cancel the current task and handle
the resulting @ref{1b8,,asyncio.CancelledError} internally, transforming it
into a @ref{838,,TimeoutError} which can be caught and handled.

@cartouche
@quotation Nota 
The @ref{5fe,,asyncio.timeout()} context manager is what transforms
the @ref{1b8,,asyncio.CancelledError} into a @ref{838,,TimeoutError},
which means the @ref{838,,TimeoutError} can only be caught
`outside' of the context manager.
@end quotation
@end cartouche

Example of catching @ref{838,,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

The context manager produced by @ref{5fe,,asyncio.timeout()} can be
rescheduled to a different deadline and inspected.

@geindex Timeout (classe em asyncio)
@anchor{library/asyncio-task asyncio Timeout}@anchor{17bd}
@deffn {Classe} asyncio.Timeout (when)

An @ref{5fc,,asynchronous context manager}
for cancelling overdue coroutines.

@code{when} should be an absolute time at which the context should time out,
as measured by the event loop’s clock:


@itemize -

@item 
If @code{when} is @code{None}, the timeout will never trigger.

@item 
If @code{when < loop.time()}, the timeout will trigger on the next
iteration of the event loop.
@end itemize

@quotation

@geindex when() (método asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout when}@anchor{349d}
@deffn {Método} when () -> float | None

Return the current deadline, or @code{None} if the current
deadline is not set.
@end deffn

@geindex reschedule() (método asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout reschedule}@anchor{349c}
@deffn {Método} reschedule (when: float | None)

Reschedule the timeout.
@end deffn

@geindex expired() (método asyncio.Timeout)
@anchor{library/asyncio-task asyncio Timeout expired}@anchor{349e}
@deffn {Método} expired () -> bool

Return whether the context manager has exceeded its deadline
(expired).
@end deffn
@end quotation
@end deffn

Exemplo:

@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

Timeout context managers can be safely nested.


Adicionado na versão 3.11.

@end deffn

@geindex timeout_at() (no módulo asyncio)
@anchor{library/asyncio-task asyncio timeout_at}@anchor{193d}
@deffn {Função} asyncio.timeout_at (when)

Similar to @ref{5fe,,asyncio.timeout()}, except `when' is the absolute time
to stop waiting, or @code{None}.

Exemplo:

@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


Adicionado na versão 3.11.

@end deffn

@geindex wait_for() (no módulo asyncio)
@anchor{library/asyncio-task asyncio wait_for}@anchor{5ff}
@deffn {Função} async asyncio.wait_for (aw, timeout)

Espera o @ref{348d,,aguardável} `aw' concluir sem ultrapassar o tempo limite “timeout”.

Se `aw' é uma corrotina, ela é automaticamente agendada como uma Tarefa.

`timeout' pode ser @code{None}, ou um ponto flutuante, ou um número inteiro de segundos para aguardar. Se `timeout' é @code{None}, aguarda até o future encerrar.

If a timeout occurs, it cancels the task and raises
@ref{838,,TimeoutError}.

Para evitar o @ref{1b7,,cancelamento} da tarefa, envolva-a com @ref{a7a,,shield()}.

A função irá aguardar até o future ser realmente cancelado, então o tempo total de espera pode exceder o tempo limite `timeout'. Se uma exceção ocorrer durante o cancelamento, ela será propagada.

Se ele for cancelado, o future `aw' também é cancelado.
@anchor{library/asyncio-task asyncio-example-waitfor}@anchor{349f}
Exemplo:

@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


Alterado na versão 3.7: When `aw' is cancelled due to a timeout, @code{wait_for} waits
for `aw' to be cancelled.  Previously, it raised
@ref{838,,TimeoutError} immediately.



Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Raises @ref{838,,TimeoutError} instead of @ref{183c,,asyncio.TimeoutError}.

@end deffn

@node Primitivas de espera,Executando em threads,Tempo limite,Corrotinas e tarefas
@anchor{library/asyncio-task waiting-primitives}@anchor{34a0}
@subsubsection Primitivas de espera


@geindex wait() (no módulo asyncio)
@anchor{library/asyncio-task asyncio wait}@anchor{47f}
@deffn {Função} async asyncio.wait (aws, *, timeout=None, return_when=ALL_COMPLETED)

Run @ref{be6,,Future} and @ref{1be,,Task} instances in the `aws'
iterable concurrently and block until the condition specified
by `return_when'.

O iterável `aws' não deve ser vazio.

Retorna dois conjuntos de Tarefas/Futuros: @code{(done, pending)}.

Uso:

@example
done, pending = await asyncio.wait(aws)
@end example

`timeout' (um ponto flutuante ou inteiro), se especificado, pode ser usado para controlar o número máximo de segundos para aguardar antes de retornar.

Note that this function does not raise @ref{838,,TimeoutError}.
Futures or Tasks that aren’t done when the timeout occurs are simply
returned in the second set.

`return_when' indica quando esta função deve retornar. Ele deve ser uma das seguintes constantes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Descrição

@item

@geindex FIRST_COMPLETED (no módulo asyncio)
@anchor{library/asyncio-task asyncio FIRST_COMPLETED}@anchor{34a1}
@deffn {Dado} asyncio.FIRST_COMPLETED
@end deffn

@tab

A função irá retornar quando qualquer futuro terminar ou for cancelado.

@item

@geindex FIRST_EXCEPTION (no módulo asyncio)
@anchor{library/asyncio-task asyncio FIRST_EXCEPTION}@anchor{34a2}
@deffn {Dado} 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{34a3,,ALL_COMPLETED}.

@item

@geindex ALL_COMPLETED (no módulo asyncio)
@anchor{library/asyncio-task asyncio ALL_COMPLETED}@anchor{34a3}
@deffn {Dado} asyncio.ALL_COMPLETED
@end deffn

@tab

A função irá retornar quando todos os futuros encerrarem ou forem cancelados.

@end multitable


Diferente de @ref{5ff,,wait_for()}, @code{wait()} não cancela os futuros quando um tempo limite é atingido.


Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Passing coroutine objects to @code{wait()} directly is forbidden.



Alterado na versão 3.12: Added support for generators yielding tasks.

@end deffn

@geindex as_completed() (no módulo asyncio)
@anchor{library/asyncio-task asyncio as_completed}@anchor{1aa}
@deffn {Função} asyncio.as_completed (aws, *, timeout=None)

Run @ref{348d,,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{1ab,,asynchronous iterator} or a plain @ref{1ac,,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{838,,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.


Alterado na versão 3.10: Removido o parâmetro `loop'.



Descontinuado desde a versão 3.10: Aviso de descontinuidade é emitido se nem todos os objetos aguardáveis no iterável `aws' forem objetos similar a Futuro, e não existe nenhum laço de eventos em execução.



Alterado na versão 3.12: Added support for generators yielding tasks.



Alterado na versão 3.13: The result can now be used as either an @ref{1ab,,asynchronous iterator}
or as a plain @ref{1ac,,iterator} (previously it was only a plain iterator).

@end deffn

@node Executando em threads,Agendando a partir de outras threads,Primitivas de espera,Corrotinas e tarefas
@anchor{library/asyncio-task running-in-threads}@anchor{34a4}
@subsubsection Executando em threads


@geindex to_thread() (no módulo asyncio)
@anchor{library/asyncio-task asyncio to_thread}@anchor{8ee}
@deffn {Função} async asyncio.to_thread (func, /, *args, **kwargs)

Executa a função `func' assincronamente em uma thread separada.

Quaisquer *args e **kwargs fornecidos para esta função são diretamente passados para `func'. Além disso, o @ref{15b7,,contextvars.Context} atual é propagado, permitindo que variáveis de contexto da thread do laço de eventos sejam acessadas na thread separada.

Retorna uma corrotina que pode ser aguardada para obter o resultado eventual de `func'.

This coroutine function is primarily intended to be used for executing
IO-bound functions/methods that would otherwise block the event loop if
they were run in the main thread. For example:

@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

Chamar diretamente @code{blocking_io()} em qualquer corrotina iria bloquear o laço de eventos durante a sua duração, resultando em 1 segundo adicional no tempo de execução. Ao invés disso, ao utilizar @code{asyncio.to_thread()}, nós podemos executá-la em uma thread separada sem bloquear o laço de eventos.

@cartouche
@quotation Nota 
Devido à @ref{159,,GIL}, @code{asyncio.to_thread()} pode tipicamente ser usado apenas para fazer funções vinculadas a IO não-bloqueantes. Entretanto, para módulos de extensão que liberam o GIL ou implementações alternativas do Python que não tem um, @code{asyncio.to_thread()} também pode ser usado para funções vinculadas à CPU.
@end quotation
@end cartouche


Adicionado na versão 3.9.

@end deffn

@node Agendando a partir de outras threads,Introspecção,Executando em threads,Corrotinas e tarefas
@anchor{library/asyncio-task scheduling-from-other-threads}@anchor{34a5}
@subsubsection Agendando a partir de outras threads


@geindex run_coroutine_threadsafe() (no módulo asyncio)
@anchor{library/asyncio-task asyncio run_coroutine_threadsafe}@anchor{886}
@deffn {Função} asyncio.run_coroutine_threadsafe (coro, loop)

Envia uma corrotina para o laço de eventos fornecido. Seguro para thread.

Retorna um @ref{11f1,,concurrent.futures.Future} para aguardar pelo resultado de outra thread do sistema operacional.

Esta função destina-se a ser chamada partir de uma thread diferente do sistema operacional, da qual o laço de eventos está executando. Exemplo:

@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

Se uma exceção for levantada na corrotina, o Futuro retornado será notificado. Isso também pode ser usado para cancelar a tarefa no laço 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

Veja a seção @ref{34a6,,concorrência e multithreading} da documentação.

Ao contrário de outras funções asyncio, esta função requer que o argumento `loop' seja passado explicitamente.


Adicionado na versão 3.5.1.

@end deffn

@node Introspecção,Objeto Task,Agendando a partir de outras threads,Corrotinas e tarefas
@anchor{library/asyncio-task introspection}@anchor{34a7}
@subsubsection Introspecção


@geindex current_task() (no módulo asyncio)
@anchor{library/asyncio-task asyncio current_task}@anchor{47d}
@deffn {Função} asyncio.current_task (loop=None)

Retorna a instância @ref{1be,,Task} atualmente em execução, ou @code{None} se nenhuma tarefa estiver executando.

Se `loop' for @code{None}, então @ref{b1d,,get_running_loop()} é usado para obter o laço atual.


Adicionado na versão 3.7.

@end deffn

@geindex all_tasks() (no módulo asyncio)
@anchor{library/asyncio-task asyncio all_tasks}@anchor{95d}
@deffn {Função} asyncio.all_tasks (loop=None)

Retorna um conjunto de objetos @ref{1be,,Task} ainda não concluídos a serem executados pelo laço.

Se `loop' for @code{None}, então @ref{b1d,,get_running_loop()} é usado para obter o laço atual.


Adicionado na versão 3.7.

@end deffn

@geindex iscoroutine() (no módulo asyncio)
@anchor{library/asyncio-task asyncio iscoroutine}@anchor{47e}
@deffn {Função} asyncio.iscoroutine (obj)

Return @code{True} if `obj' is a coroutine object.


Adicionado na versão 3.4.

@end deffn

@node Objeto Task,,Introspecção,Corrotinas e tarefas
@anchor{library/asyncio-task asyncio-task-obj}@anchor{34a8}@anchor{library/asyncio-task task-object}@anchor{34a9}
@subsubsection Objeto Task


@geindex Task (classe em asyncio)
@anchor{library/asyncio-task asyncio Task}@anchor{1be}
@deffn {Classe} asyncio.Task (coro, *, loop=None, name=None, context=None, eager_start=False)

Um objeto @ref{be6,,similar a Futuro} que executa uma @ref{3476,,corrotina} Python. Não é seguro para thread.

Tarefas são usadas para executar corrotinas em laços de eventos. Se uma corrotina espera por um Futuro, a Tarefa suspende a execução da corrotina e aguarda a conclusão do Futuro. Quando o Futuro é `concluído', a execução da corrotina contida é retomada.

Laços de eventos usam agendamento cooperativo: um ciclo de evento executa uma Task de cada vez. Enquanto uma Task aguarda a conclusão de um Future, o laço de eventos executa outras Tasks, funções de retorno, ou executa operações de IO.

Use a função de alto nível @ref{1bf,,asyncio.create_task()} para criar Tasks, ou as funções de baixo nível @ref{1c0,,loop.create_task()} ou @ref{c92,,ensure_future()}. Instanciação manual de Tasks é desencorajada.

Para cancelar uma Task em execução, use o método @ref{1b7,,cancel()}. Chamar ele fará com que a Task levante uma exceção @ref{1b8,,CancelledError} dentro da corrotina envolvente. Se a corrotina estiver esperando por um objeto Future durante o cancelamento, o objeto Future será cancelado.

@ref{34aa,,cancelled()} pode ser usado para verificar se a Task foi cancelada. O método retorna @code{True} se a corrotina envolvente não suprimiu a exceção @ref{1b8,,CancelledError} e, na verdade, foi cancelada.

@ref{1be,,asyncio.Task} herda de @ref{be6,,Future} todas as suas APIs exceto @ref{34ab,,Future.set_result()} e @ref{c99,,Future.set_exception()}.

An optional keyword-only `context' argument allows specifying a
custom @ref{15b7,,contextvars.Context} for the `coro' to run in.
If no `context' is provided, the Task copies the current context
and later runs its coroutine in the copied context.

Um argumento opcional somente-nomeado `eager_start' permite iniciar imediatamente a execução da @ref{1be,,asyncio.Task} no momento da criação da tarefa. Se definido como @code{True} e o laço de eventos estiver em execução, a tarefa começará a executar a corrotina imediatamente, até à primeira vez que a corrotina bloquear. Se a corrotina devolver ou levantar uma exceção sem bloquear, a tarefa será concluída imediatamente e não será agendada para o laço de eventos.


Alterado na versão 3.7: Adicionado suporte ao módulo @ref{24,,contextvars}.



Alterado na versão 3.8: Adicionado o parâmetro `name'.



Descontinuado desde a versão 3.10: Aviso de descontinuidade é emitido se `loop' não for especificado e não existir nenhum laço de eventos em execução.



Alterado na versão 3.11: Adicionado o parâmetro `context'.



Alterado na versão 3.12: Adicionado o parâmetro `eager_start'.


@geindex done() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task done}@anchor{34ac}
@deffn {Método} done ()

Retorna @code{True} se a Tarefa estiver `concluída'.

Uma Tarefa está `concluída' quando a corrotina contida retornou um valor, ou levantou uma exceção, ou a Tarefa foi cancelada.
@end deffn

@geindex result() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task result}@anchor{34ad}
@deffn {Método} result ()

Retorna o resultado da Tarefa.

Se a Tarefa estiver `concluída', o resultado da corrotina contida é retornado (ou se a corrotina levantou uma exceção, essa exceção é re-levantada.)

Se a Tarefa foi `cancelada', este método levanta uma exceção @ref{1b8,,CancelledError}.

If the Task’s result isn’t yet available, this method raises
an @ref{34ae,,InvalidStateError} exception.
@end deffn

@geindex exception() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task exception}@anchor{34af}
@deffn {Método} exception ()

Retorna a exceção de uma Tarefa.

Se a corrotina contida levantou uma exceção, essa exceção é retornada. Se a corrotina contida retornou normalmente, este método retorna @code{None}.

Se a Tarefa foi `cancelada', este método levanta uma exceção @ref{1b8,,CancelledError}.

Se a Tarefa não estiver `concluída' ainda, este método levanta uma exceção @ref{34ae,,InvalidStateError}.
@end deffn

@geindex add_done_callback() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task add_done_callback}@anchor{34b0}
@deffn {Método} add_done_callback (callback, *, context=None)

Adiciona uma função de retorno para ser executada quando a Tarefa estiver `concluída'.

Este método deve ser usado apenas em código de baixo nível baseado em funções de retorno.

Veja a documentação para @ref{b1a,,Future.add_done_callback()} para mais detalhes.
@end deffn

@geindex remove_done_callback() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task remove_done_callback}@anchor{34b1}
@deffn {Método} remove_done_callback (callback)

Remove `callback' da lista de funções de retorno.

Este método deve ser usado apenas em código de baixo nível baseado em funções de retorno.

Veja a documentação do método @ref{168b,,Future.remove_done_callback()} para mais detalhes.
@end deffn

@geindex get_stack() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_stack}@anchor{34b2}
@deffn {Método} get_stack (*, limit=None)

Retorna a lista de frames da pilha para esta Tarefa.

Se a corrotina contida não estiver concluída, isto retorna a pilha onde ela foi suspensa. Se a corrotina foi concluída com sucesso ou cancelada, isto retorna uma lista vazia. Se a corrotina foi interrompida por uma exceção, isso retorna a lista de frames do traceback (situação da pilha de execução).

Os quadros são sempre ordenados dos mais antigos para os mais recentes.

Apenas um frame da pilha é retornado para uma corrotina suspensa.

O argumento opcional `limit' define o número máximo de frames a serem retornados; por padrão, todos os frames disponíveis são retornados. O ordenamento da lista retornada é diferente dependendo se uma pilha ou um traceback (situação da pilha de execução) é retornado: os frames mais recentes de uma pilha são retornados, mas os frames mais antigos de um traceback são retornados. (Isso combina com o comportamento do módulo traceback.)
@end deffn

@geindex print_stack() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task print_stack}@anchor{1858}
@deffn {Método} print_stack (*, limit=None, file=None)

Exibe a pilha ou a situação da pilha de execução desta Task.

Isto produz uma saída similar à do módulo traceback para frames recuperados por @ref{34b2,,get_stack()}.

O argumento `limit' é passado diretamente para @ref{34b2,,get_stack()}.

O argumento `file' é um fluxo de I/O para o qual a saída é escrita; por padrão, a saída é escrita para @ref{ae6,,sys.stdout}.
@end deffn

@geindex get_coro() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_coro}@anchor{9e4}
@deffn {Método} get_coro ()

Retorna o objeto corrotina contido pela @ref{1be,,Task}.

@cartouche
@quotation Nota 
Isto retornará @code{None} para Tasks que já tenham sido concluídas ansiosamente. Consulte @ref{3498,,fábrica de tarefas ansiosas}.
@end quotation
@end cartouche


Adicionado na versão 3.8.



Alterado na versão 3.12: A execução de tarefas recentemente adicionadas, ansiosas, pode resultar em @code{None}.

@end deffn

@geindex get_context() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_context}@anchor{34b3}
@deffn {Método} get_context ()

Retorna o objeto @ref{15b7,,contextvars.Context} associado à tarefa.


Adicionado na versão 3.12.

@end deffn

@geindex get_name() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task get_name}@anchor{9e6}
@deffn {Método} get_name ()

Retorna o nome da Tarefa.

Se nenhum nome foi explicitamente designado para a Tarefa, a implementação padrão asyncio da classe Task gera um nome padrão durante a instanciação.


Adicionado na versão 3.8.

@end deffn

@geindex set_name() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task set_name}@anchor{9e5}
@deffn {Método} set_name (value)

Define o nome da Tarefa.

O argumento `value' pode ser qualquer objeto, que é então convertido em uma string.

Na implementação padrão da Tarefa, o nome será visível na @ref{800,,repr()} de saída de um objeto task.


Adicionado na versão 3.8.

@end deffn

@geindex cancel() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancel}@anchor{1b7}
@deffn {Método} cancel (msg=None)

Solicita o cancelamento da Tarefa.

If the Task is already `done' or `cancelled', return @code{False},
otherwise, return @code{True}.

O método prepara para que uma exceção @ref{1b8,,CancelledError} seja lançada na corrotina contida no próximo ciclo do laço de eventos.

The coroutine then has a chance to clean up or even deny the
request by suppressing the exception with a @ref{6e9,,try} …
… @code{except CancelledError} … @ref{9d2,,finally} block.
Therefore, unlike @ref{1934,,Future.cancel()}, @ref{1b7,,Task.cancel()} does
not guarantee that the Task will be cancelled, although
suppressing cancellation completely is not common and is actively
discouraged.  Should the coroutine nevertheless decide to suppress
the cancellation, it needs to call @ref{1bb,,Task.uncancel()} in addition
to catching the exception.


Alterado na versão 3.9: Adicionado o  parâmetro `msg'.



Alterado na versão 3.11: O parâmetro @code{msg} é propagado da tarefa cancelada para o seu aguardador.

@anchor{library/asyncio-task asyncio-example-task-cancel}@anchor{34b4}
O seguinte exemplo ilustra como corrotinas podem interceptar o cancelamento de requisições:

@example
async def cancel_me():    print('cancel_me(): antes de dormir')    try:        # Aguardar 1 hora        await asyncio.sleep(3600)    except asyncio.CancelledError:        print('cancel_me(): cancelar sono')        raise    finally:        print('cancel_me(): depois de dormir')async def main():    # Criar uma Tarefa "cancel_me"    task = asyncio.create_task(cancel_me())    # Aguardar 1 segundo    await asyncio.sleep(1)    task.cancel()    try:        await task    except asyncio.CancelledError:        print("main(): cancel_me foi cancelado agora")asyncio.run(main())# Saída esperada:##     cancel_me(): antes de dormir#     cancel_me(): cancelar sono#     cancel_me(): depois de dormir#     main(): cancel_me foi cancelado agora
@end example
@end deffn

@geindex cancelled() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancelled}@anchor{34aa}
@deffn {Método} cancelled ()

Retorna @code{True} se a Tarefa for `cancelada'.

A Tarefa é `cancelada' quando o cancelamento foi requisitado com @ref{1b7,,cancel()} e a corrotina contida propagou a exceção @ref{1b8,,CancelledError} gerada nela.
@end deffn

@geindex uncancel() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task uncancel}@anchor{1bb}
@deffn {Método} uncancel ()

Decrement the count of cancellation requests to this Task.

Retorna o número restante de pedidos de cancelamento.

Note que, uma vez concluída a execução de uma tarefa cancelada, chamadas adicionais para @ref{1bb,,uncancel()} são ineficazes.


Adicionado na versão 3.11.


This method is used by asyncio’s internals and isn’t expected to be
used by end-user code.  In particular, if a Task gets successfully
uncancelled, this allows for elements of structured concurrency like
@ref{3492,,Grupos de tarefas} and @ref{5fe,,asyncio.timeout()} to continue running,
isolating cancellation to the respective structured block.
For example:

@example
async def make_request_with_timeout():    try:        async with asyncio.timeout(1):            # Bloco estruturado afetado pelo timeout:            await make_request()            await make_another_request()    except TimeoutError:        log("Ocorreu um timeout")    # Código externo não afetado pelo timeout:    await unrelated_code()
@end example

Enquanto o bloco com @code{make_request()} e @code{make_another_request()} possa ser cancelado devido ao timeout, @code{unrelated_code()} deve continuar a executar mesmo em caso de timeout. Isto é implementado com @ref{1bb,,uncancel()}. Os gerenciadores de contexto @ref{1b5,,TaskGroup} usam @ref{1bb,,uncancel()} de forma semelhante.

Se o código do usuário final, por alguma razão, estiver suprimindo o cancelamento ao capturar @ref{1b8,,CancelledError}, precisa chamar este método para remover o estado de cancelamento.

Quando este método decrementa a contagem de cancelamentos para zero, verifica se uma chamada anterior a @ref{1b7,,cancel()} tinha preparado para que @ref{1b8,,CancelledError} fosse lançado na tarefa. Se ainda não tiver sido lançado, esse preparo será revogado (redefinindo o sinalizador interna @code{_must_cancel}).
@end deffn


Alterado na versão 3.13: Alterado para revogar os pedidos de cancelamento pendentes ao atingir zero.


@geindex cancelling() (método asyncio.Task)
@anchor{library/asyncio-task asyncio Task cancelling}@anchor{1ba}
@deffn {Método} cancelling ()

Return the number of pending cancellation requests to this Task, i.e.,
the number of calls to @ref{1b7,,cancel()} less the number of
@ref{1bb,,uncancel()} calls.

Note that if this number is greater than zero but the Task is
still executing, @ref{34aa,,cancelled()} will still return @code{False}.
This is because this number can be lowered by calling @ref{1bb,,uncancel()},
which can lead to the task not being cancelled after all if the
cancellation requests go down to zero.

Este método é usado pelos internos do asyncio e não é esperado que seja usado por código do usuário final. Consulte @ref{1bb,,uncancel()} para mais detalhes.


Adicionado na versão 3.11.

@end deffn
@end deffn

@node Streams,Synchronization Primitives,Corrotinas e tarefas,asyncio — E/S assíncrona
@anchor{library/asyncio-stream doc}@anchor{34b5}@anchor{library/asyncio-stream asyncio-streams}@anchor{3477}@anchor{library/asyncio-stream streams}@anchor{34b6}@anchor{library/asyncio-stream translation-repo}@anchor{34b7}
@subsubsection Streams


`Código-fonte:' Lib/asyncio/streams.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/streams.py}


__________________________________________________________________


Streams são conexões de rede de alto-nível assincronias/espera-pronta. Streams permitem envios e recebimentos de dados sem usar retornos de chamadas ou protocolos de baixo nível.
@anchor{library/asyncio-stream asyncio-example-stream}@anchor{34b8}
Aqui está um exemplo de um cliente TCP realizando eco, escrito usando 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

Veja também a seção @ref{34b9,,Exemplos} abaixo.

@subsubheading Funções Stream


As seguintes funções asyncio de alto nível podem ser usadas para criar e trabalhar com streams:

@geindex open_connection() (no módulo asyncio)
@anchor{library/asyncio-stream asyncio open_connection}@anchor{b2b}
@deffn {Função} async 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)

Estabelece uma conexão de rede e retorna um par de objetos @code{(reader, writer)}.

Os objetos `reader' e `writer' retornados são instâncias das classes @ref{1a09,,StreamReader} e @ref{17f2,,StreamWriter}.

`limit' determina o tamanho limite do buffer usado pela instância @ref{1a09,,StreamReader} retornada. Por padrão, `limit' é definido em 64 KiB.

O resto dos argumentos é passado diretamente para @ref{603,,loop.create_connection()}.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
@ref{17f2,,StreamWriter} created. To close the socket, call its
@ref{34ba,,close()} method.
@end quotation
@end cartouche


Alterado na versão 3.7: Adicionado o parâmetro `ssl_handshake_timeout'.



Alterado na versão 3.8: Adicionados os parâmetros `happy_eyeballs_delay' e `interleave'.



Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex start_server() (no módulo asyncio)
@anchor{library/asyncio-stream asyncio start_server}@anchor{b2c}
@deffn {Função} async 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, keep_alive=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

Inicia um soquete no servidor.

A função de retorno `client_connected_cb' é chamada sempre que uma nova conexão de um cliente é estabelecida. Ela recebe um par @code{(reader, writer)} como dois argumentos, instâncias das classes @ref{1a09,,StreamReader} e @ref{17f2,,StreamWriter}.

`client_connected_cb' pode ser simplesmente algo chamável ou uma @ref{3476,,função de corrotina}; se ele for uma função de corrotina, ele será automaticamente agendado como uma @ref{1be,,Task}.

`limit' determina o tamanho limite do buffer usado pela instância @ref{1a09,,StreamReader} retornada. Por padrão, `limit' é definido em 64 KiB.

O resto dos argumentos são passados diretamente para @ref{b25,,loop.create_server()}.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
server created. To close the socket, call the server’s
@ref{34bb,,close()} method.
@end quotation
@end cartouche


Alterado na versão 3.7: Added the `ssl_handshake_timeout' and `start_serving' parameters.



Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.



Alterado na versão 3.13: Added the `keep_alive' parameter.

@end deffn

@subsubheading Soquetes Unix


@geindex open_unix_connection() (no módulo asyncio)
@anchor{library/asyncio-stream asyncio open_unix_connection}@anchor{34bc}
@deffn {Função} async asyncio.open_unix_connection (path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Estabelece uma conexão de soquete Unix e retorna um par com @code{(reader, writer)}.

Similar a @ref{b2b,,open_connection()}, mas opera em soquetes Unix.

Veja também a documentação do método @ref{34bd,,loop.create_unix_connection()}.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
@ref{17f2,,StreamWriter} created. To close the socket, call its
@ref{34ba,,close()} method.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.7: Added the `ssl_handshake_timeout' parameter.
The `path' parameter can now be a @ref{2a0,,path-like object}



Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex start_unix_server() (no módulo asyncio)
@anchor{library/asyncio-stream asyncio start_unix_server}@anchor{34be}
@deffn {Função} async 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, cleanup_socket=True)

Inicia um servidor com soquete Unix.

Similar a @ref{b2c,,start_server()}, mas funciona com soquetes Unix.

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.

Veja também a documentação do método @ref{1ae,,loop.create_unix_server()}.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
server created. To close the socket, call the server’s
@ref{34bb,,close()} method.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.7: Added the `ssl_handshake_timeout' and `start_serving' parameters.
The `path' parameter can now be a @ref{2a0,,path-like object}.



Alterado na versão 3.10: Removido o parâmetro `loop'.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.



Alterado na versão 3.13: Added the `cleanup_socket' parameter.

@end deffn

@menu
* StreamReader:: 
* StreamWriter:: 
* Exemplos: Exemplos<15>. 

@end menu

@node StreamReader,StreamWriter,,Streams
@anchor{library/asyncio-stream streamreader}@anchor{34bf}
@subsubsection StreamReader


@geindex StreamReader (classe em asyncio)
@anchor{library/asyncio-stream asyncio StreamReader}@anchor{1a09}
@deffn {Classe} asyncio.StreamReader

Represents a reader object that provides APIs to read data
from the IO stream. As an @ref{d9c,,asynchronous iterable}, the
object supports the @ref{aba,,async for} statement.

Não é recomendado instanciar objetos `StreamReader' diretamente; use @ref{b2b,,open_connection()} e @ref{b2c,,start_server()} ao invés disso.

@geindex feed_eof() (método asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader feed_eof}@anchor{34c0}
@deffn {Método} feed_eof ()

Acknowledge the EOF.
@end deffn

@geindex read() (método asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader read}@anchor{34c1}
@deffn {Método} async 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{1c2,,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 asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readline}@anchor{34c2}
@deffn {Método} async readline ()

Lê uma linha, onde “line” é uma sequência de bytes encerrando com @code{\n}.

Se EOF é recebido e @code{\n} não foi encontrado, o método retorna os dados parcialmente lidos.

Se EOF for recebido e o buffer interno estiver vazio, retorna um objeto @code{bytes} vazio.
@end deffn

@geindex readexactly() (método asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readexactly}@anchor{c97}
@deffn {Método} async readexactly (n)

Lê exatamente `n' bytes.

Levanta um @ref{1a75,,IncompleteReadError} se EOF é atingido antes que `n' sejam lidos. Use o atributo @ref{34c3,,IncompleteReadError.partial} para obter os dados parcialmente lidos.
@end deffn

@geindex readuntil() (método asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader readuntil}@anchor{1b4}
@deffn {Método} async readuntil (separator=b'\n')

Lê dados a partir do stream até que `separator' seja encontrado.

Ao ter sucesso, os dados e o separador serão removidos do buffer interno (consumido). Dados retornados irão incluir o separador no final.

Se a quantidade de dados lidos excede o limite configurado para o stream, uma exceção @ref{34c4,,LimitOverrunError} é levantada, e os dados são deixados no buffer interno e podem ser lidos novamente.

Se EOF for atingido antes que o separador completo seja encontrado, uma exceção @ref{1a75,,IncompleteReadError} é levantada, e o buffer interno é redefinido. O atributo @ref{34c3,,IncompleteReadError.partial} pode conter uma parte do 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{34c4,,LimitOverrunError},
the shortest possible separator is considered to be the one that
matched.


Adicionado na versão 3.5.2.



Alterado na versão 3.13: The `separator' parameter may now be a @ref{370,,tuple} of
separators.

@end deffn

@geindex at_eof() (método asyncio.StreamReader)
@anchor{library/asyncio-stream asyncio StreamReader at_eof}@anchor{34c5}
@deffn {Método} at_eof ()

Retorna @code{True} se o buffer estiver vazio e @ref{34c0,,feed_eof()} foi chamado.
@end deffn
@end deffn

@node StreamWriter,Exemplos<15>,StreamReader,Streams
@anchor{library/asyncio-stream streamwriter}@anchor{34c6}
@subsubsection StreamWriter


@geindex StreamWriter (classe em asyncio)
@anchor{library/asyncio-stream asyncio StreamWriter}@anchor{17f2}
@deffn {Classe} asyncio.StreamWriter

Representa um objeto de escrita que fornece APIs para escrever dados para o stream de IO.

Não é recomendado instanciar objetos `StreamWriter' diretamente; use @ref{b2b,,open_connection()} e @ref{b2c,,start_server()} ao invés.

@geindex write() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter write}@anchor{34c7}
@deffn {Método} write (data)

O método tenta escrever `data' para o soquete subjacente imediatamente. Se isso falhar, data é enfileirado em um buffer interno de escrita, até que possa ser enviado.

The `data' buffer should be a bytes, bytearray, or C-contiguous one-dimensional
memoryview object.

O método deve ser usado juntamente com o método @code{drain()}:

@example
stream.write(data)
await stream.drain()
@end example
@end deffn

@geindex writelines() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter writelines}@anchor{34c8}
@deffn {Método} writelines (data)

O método escreve imediatamente a lista (ou qualquer iterável) de bytes para o soquete subjacente. Se isso falhar, os dados são enfileirados em um buffer de escrita interno até que possam ser enviados.

O método deve ser usado juntamente com o método @code{drain()}:

@example
stream.writelines(lines)
await stream.drain()
@end example
@end deffn

@geindex close() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter close}@anchor{34ba}
@deffn {Método} close ()

O método fecha o stream e o soquete subjacente.

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 asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter can_write_eof}@anchor{34c9}
@deffn {Método} can_write_eof ()

Retorna @code{True} se o transporte subjacente suporta o método @ref{34ca,,write_eof()}, @code{False} caso contrário.
@end deffn

@geindex write_eof() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter write_eof}@anchor{34ca}
@deffn {Método} write_eof ()

Fecha o extremo de escrita do stream após os dados no buffer de escrita terem sido descarregados.
@end deffn

@geindex transport (atributo asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter transport}@anchor{34cb}
@deffn {Atributo} transport

Retorna o transporte asyncio subjacente.
@end deffn

@geindex get_extra_info() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter get_extra_info}@anchor{34cc}
@deffn {Método} get_extra_info (name, default=None)

Acessa informações de transporte opcionais; veja @ref{aab,,BaseTransport.get_extra_info()} para detalhes.
@end deffn

@geindex drain() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter drain}@anchor{18b1}
@deffn {Método} async drain ()

Aguarda até que seja apropriado continuar escrevendo no stream. Exemplo:

@example
writer.write(data)
await writer.drain()
@end example

Este é um método de controle de fluxo que interage com o buffer de entrada e saída de escrita subjacente. Quando o tamanho do buffer atinge a marca d’água alta, `drain()' bloqueia até que o tamanho do buffer seja drenado para a marca d’água baixa, e a escrita possa continuar. Quando não existe nada que cause uma espera, o método @ref{18b1,,drain()} retorna imediatamente.
@end deffn

@geindex start_tls() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter start_tls}@anchor{604}
@deffn {Método} async start_tls (sslcontext, *, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Upgrade an existing stream-based connection to TLS.

Parâmetros:


@itemize *

@item 
`sslcontext': uma instância configurada de @ref{294,,SSLContext}.

@item 
`server_hostname': define ou substitui o nome do host no qual o servidor alvo do certificado será comparado.

@item 
`ssl_handshake_timeout' is the time in seconds to wait for the TLS
handshake to complete before aborting the connection.  @code{60.0} seconds
if @code{None} (default).

@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


Adicionado na versão 3.11.



Alterado na versão 3.12: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@geindex is_closing() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter is_closing}@anchor{b1f}
@deffn {Método} is_closing ()

Retorna @code{True} se o stream estiver fechado ou em processo de ser fechado.


Adicionado na versão 3.7.

@end deffn

@geindex wait_closed() (método asyncio.StreamWriter)
@anchor{library/asyncio-stream asyncio StreamWriter wait_closed}@anchor{b1e}
@deffn {Método} async wait_closed ()

Aguarda até que o stream seja fechado.

Should be called after @ref{34ba,,close()} to wait until the underlying
connection is closed, ensuring that all data has been flushed
before e.g. exiting the program.


Adicionado na versão 3.7.

@end deffn
@end deffn

@node Exemplos<15>,,StreamWriter,Streams
@anchor{library/asyncio-stream examples}@anchor{34b9}
@subsubsection Exemplos


@menu
* Cliente para eco TCP usando streams:: 
* Servidor eco TCP usando streams:: 
* Obtém headers HTTP:: 
* Registra um soquete aberto para aguardar por dados usando streams:: 

@end menu

@node Cliente para eco TCP usando streams,Servidor eco TCP usando streams,,Exemplos<15>
@anchor{library/asyncio-stream asyncio-tcp-echo-client-streams}@anchor{34cd}@anchor{library/asyncio-stream tcp-echo-client-using-streams}@anchor{34ce}
@subsubsection Cliente para eco TCP usando streams


Cliente de eco TCP usando a função @ref{b2b,,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 também


O exemplo de @ref{34cf,,protocolo do cliente para eco TCP} usa o método de baixo nível @ref{603,,loop.create_connection()}.


@node Servidor eco TCP usando streams,Obtém headers HTTP,Cliente para eco TCP usando streams,Exemplos<15>
@anchor{library/asyncio-stream asyncio-tcp-echo-server-streams}@anchor{34d0}@anchor{library/asyncio-stream tcp-echo-server-using-streams}@anchor{34d1}
@subsubsection Servidor eco TCP usando streams


Servidor eco TCP usando a função @ref{b2c,,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 também


O exemplo de @ref{34d2,,protocolo eco de servidor TCP} utiliza o método @ref{b25,,loop.create_server()}.


@node Obtém headers HTTP,Registra um soquete aberto para aguardar por dados usando streams,Servidor eco TCP usando streams,Exemplos<15>
@anchor{library/asyncio-stream get-http-headers}@anchor{34d3}
@subsubsection Obtém headers HTTP


Exemplo simples consultando cabeçalhos HTTP da URL passada na linha 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

ou com HTTPS:

@example
python example.py https://example.com/path/page.html
@end example

@node Registra um soquete aberto para aguardar por dados usando streams,,Obtém headers HTTP,Exemplos<15>
@anchor{library/asyncio-stream asyncio-example-create-connection-streams}@anchor{34d4}@anchor{library/asyncio-stream register-an-open-socket-to-wait-for-data-using-streams}@anchor{34d5}
@subsubsection Registra um soquete aberto para aguardar por dados usando streams


Corrotina aguardando até que um soquete receba dados usando a função @ref{b2b,,open_connection()}:

@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 também


O exemplo de @ref{34d6,,registro de um soquete aberto para aguardar por dados usando um protocolo} utiliza um protocolo de baixo nível e o método @ref{603,,loop.create_connection()}.

O exemplo para @ref{34d7,,monitorar um descritor de arquivo para leitura de eventos} utiliza o método de baixo nível @ref{34d8,,loop.add_reader()} para monitorar um descritor de arquivo.


@node Synchronization Primitives,Subprocessos,Streams,asyncio — E/S assíncrona
@anchor{library/asyncio-sync doc}@anchor{34d9}@anchor{library/asyncio-sync asyncio-sync}@anchor{347a}@anchor{library/asyncio-sync synchronization-primitives}@anchor{34da}@anchor{library/asyncio-sync translation-repo}@anchor{34db}
@subsubsection Synchronization Primitives


`Código-fonte:' Lib/asyncio/locks.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/locks.py}


__________________________________________________________________


asyncio synchronization primitives are designed to be similar to
those of the @ref{ed,,threading} module with two important caveats:


@itemize *

@item 
asyncio primitives are not thread-safe, therefore they should not
be used for OS thread synchronization (use @ref{ed,,threading} for
that);

@item 
methods of these synchronization primitives do not accept the `timeout'
argument; use the @ref{5ff,,asyncio.wait_for()} function to perform
operations with timeouts.
@end itemize

asyncio has the following basic synchronization primitives:


@itemize *

@item 
@ref{a7b,,Lock}

@item 
@ref{a7c,,Event}

@item 
@ref{a7d,,Condition}

@item 
@ref{a7e,,Semaphore}

@item 
@ref{a7f,,BoundedSemaphore}

@item 
@ref{601,,Barrier}
@end itemize


__________________________________________________________________


@menu
* Lock:: 
* Evento:: 
* Condição:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrier:: 

@end menu

@node Lock,Evento,,Synchronization Primitives
@anchor{library/asyncio-sync lock}@anchor{34dc}
@subsubsection Lock


@geindex Lock (classe em asyncio)
@anchor{library/asyncio-sync asyncio Lock}@anchor{a7b}
@deffn {Classe} asyncio.Lock

Implements a mutex lock for asyncio tasks.  Not thread-safe.

An asyncio lock can be used to guarantee exclusive access to a
shared resource.

The preferred way to use a Lock is an @ref{5d5,,async with}
statement:

@example
lock = asyncio.Lock()

# ... later
async with lock:
    # access shared state
@end example

which is equivalent to:

@example
lock = asyncio.Lock()

# ... later
await lock.acquire()
try:
    # access shared state
finally:
    lock.release()
@end example


Alterado na versão 3.10: Removido o parâmetro `loop'.


@geindex acquire() (método asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock acquire}@anchor{34dd}
@deffn {Método} async acquire ()

Acquire the lock.

This method waits until the lock is `unlocked', sets it to
`locked' and returns @code{True}.

When more than one coroutine is blocked in @ref{34dd,,acquire()}
waiting for the lock to be unlocked, only one coroutine
eventually proceeds.

Acquiring a lock is `fair': the coroutine that proceeds will be
the first coroutine that started waiting on the lock.
@end deffn

@geindex release() (método asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock release}@anchor{34de}
@deffn {Método} release ()

Release the lock.

When the lock is `locked', reset it to `unlocked' and return.

If the lock is `unlocked', a @ref{195,,RuntimeError} is raised.
@end deffn

@geindex locked() (método asyncio.Lock)
@anchor{library/asyncio-sync asyncio Lock locked}@anchor{34df}
@deffn {Método} locked ()

Return @code{True} if the lock is `locked'.
@end deffn
@end deffn

@node Evento,Condição,Lock,Synchronization Primitives
@anchor{library/asyncio-sync event}@anchor{34e0}
@subsubsection Evento


@geindex Event (classe em asyncio)
@anchor{library/asyncio-sync asyncio Event}@anchor{a7c}
@deffn {Classe} asyncio.Event

An event object.  Not thread-safe.

An asyncio event can be used to notify multiple asyncio tasks
that some event has happened.

An Event object manages an internal flag that can be set to `true'
with the @ref{34e1,,set()} method and reset to `false' with the
@ref{34e2,,clear()} method.  The @ref{34e3,,wait()} method blocks until the
flag is set to `true'.  The flag is set to `false' initially.


Alterado na versão 3.10: Removido o parâmetro `loop'.

@anchor{library/asyncio-sync asyncio-example-sync-event}@anchor{34e4}
Exemplo:

@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 asyncio.Event)
@anchor{library/asyncio-sync asyncio Event wait}@anchor{34e3}
@deffn {Método} async wait ()

Wait until the event is set.

If the event is set, return @code{True} immediately.
Otherwise block until another task calls @ref{34e1,,set()}.
@end deffn

@geindex set() (método asyncio.Event)
@anchor{library/asyncio-sync asyncio Event set}@anchor{34e1}
@deffn {Método} set ()

Set the event.

All tasks waiting for event to be set will be immediately
awakened.
@end deffn

@geindex clear() (método asyncio.Event)
@anchor{library/asyncio-sync asyncio Event clear}@anchor{34e2}
@deffn {Método} clear ()

Clear (unset) the event.

Subsequent tasks awaiting on @ref{34e3,,wait()} will now block until the
@ref{34e1,,set()} method is called again.
@end deffn

@geindex is_set() (método asyncio.Event)
@anchor{library/asyncio-sync asyncio Event is_set}@anchor{34e5}
@deffn {Método} is_set ()

Return @code{True} if the event is set.
@end deffn
@end deffn

@node Condição,Semaphore,Evento,Synchronization Primitives
@anchor{library/asyncio-sync condition}@anchor{34e6}
@subsubsection Condição


@geindex Condition (classe em asyncio)
@anchor{library/asyncio-sync asyncio Condition}@anchor{a7d}
@deffn {Classe} asyncio.Condition (lock=None)

A Condition object.  Not thread-safe.

An asyncio condition primitive can be used by a task to wait for
some event to happen and then get exclusive access to a shared
resource.

In essence, a Condition object combines the functionality
of an @ref{a7c,,Event} and a @ref{a7b,,Lock}.  It is possible to have
multiple Condition objects share one Lock, which allows coordinating
exclusive access to a shared resource between different tasks
interested in particular states of that shared resource.

The optional `lock' argument must be a @ref{a7b,,Lock} object or
@code{None}.  In the latter case a new Lock object is created
automatically.


Alterado na versão 3.10: Removido o parâmetro `loop'.


The preferred way to use a Condition is an @ref{5d5,,async with}
statement:

@example
cond = asyncio.Condition()

# ... later
async with cond:
    await cond.wait()
@end example

which is equivalent to:

@example
cond = asyncio.Condition()

# ... later
await cond.acquire()
try:
    await cond.wait()
finally:
    cond.release()
@end example

@geindex acquire() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition acquire}@anchor{34e7}
@deffn {Método} async acquire ()

Acquire the underlying lock.

This method waits until the underlying lock is `unlocked',
sets it to `locked' and returns @code{True}.
@end deffn

@geindex notify() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition notify}@anchor{1770}
@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.

The lock must be acquired before this method is called and
released shortly after.  If called with an `unlocked' lock
a @ref{195,,RuntimeError} error is raised.
@end deffn

@geindex locked() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition locked}@anchor{34e8}
@deffn {Método} locked ()

Return @code{True} if the underlying lock is acquired.
@end deffn

@geindex notify_all() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition notify_all}@anchor{34e9}
@deffn {Método} notify_all ()

Wake up all tasks waiting on this condition.

This method acts like @ref{1770,,notify()}, but wakes up all waiting
tasks.

The lock must be acquired before this method is called and
released shortly after.  If called with an `unlocked' lock
a @ref{195,,RuntimeError} error is raised.
@end deffn

@geindex release() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition release}@anchor{34ea}
@deffn {Método} release ()

Release the underlying lock.

When invoked on an unlocked lock, a @ref{195,,RuntimeError} is
raised.
@end deffn

@geindex wait() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition wait}@anchor{179b}
@deffn {Método} async wait ()

Wait until notified.

If the calling task has not acquired the lock when this method is
called, a @ref{195,,RuntimeError} is raised.

This method releases the underlying lock, and then blocks until
it is awakened by a @ref{1770,,notify()} or @ref{34e9,,notify_all()} call.
Once awakened, the Condition re-acquires its lock and this method
returns @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{179b,,wait()} again. For this reason, you may
prefer to use @ref{34eb,,wait_for()} instead.
@end deffn

@geindex wait_for() (método asyncio.Condition)
@anchor{library/asyncio-sync asyncio Condition wait_for}@anchor{34eb}
@deffn {Método} async wait_for (predicate)

Wait until a predicate becomes `true'.

The predicate must be a callable which result will be
interpreted as a boolean value.  The method will repeatedly
@ref{179b,,wait()} until the predicate evaluates to `true'. The final value is the
return value.
@end deffn
@end deffn

@node Semaphore,BoundedSemaphore,Condição,Synchronization Primitives
@anchor{library/asyncio-sync semaphore}@anchor{34ec}
@subsubsection Semaphore


@geindex Semaphore (classe em asyncio)
@anchor{library/asyncio-sync asyncio Semaphore}@anchor{a7e}
@deffn {Classe} asyncio.Semaphore (value=1)

A Semaphore object.  Not thread-safe.

A semaphore manages an internal counter which is decremented by each
@ref{179c,,acquire()} call and incremented by each @ref{34ed,,release()} call.
The counter can never go below zero; when @ref{179c,,acquire()} finds
that it is zero, it blocks, waiting until some task calls
@ref{34ed,,release()}.

The optional `value' argument gives the initial value for the
internal counter (@code{1} by default). If the given value is
less than @code{0} a @ref{202,,ValueError} is raised.


Alterado na versão 3.10: Removido o parâmetro `loop'.


The preferred way to use a Semaphore is an @ref{5d5,,async with}
statement:

@example
sem = asyncio.Semaphore(10)

# ... later
async with sem:
    # work with shared resource
@end example

which is equivalent to:

@example
sem = asyncio.Semaphore(10)

# ... later
await sem.acquire()
try:
    # work with shared resource
finally:
    sem.release()
@end example

@geindex acquire() (método asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore acquire}@anchor{179c}
@deffn {Método} async acquire ()

Acquire a semaphore.

If the internal counter is greater than zero, decrement
it by one and return @code{True} immediately.  If it is zero, wait
until a @ref{34ed,,release()} is called and return @code{True}.
@end deffn

@geindex locked() (método asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore locked}@anchor{34ee}
@deffn {Método} locked ()

Returns @code{True} if semaphore can not be acquired immediately.
@end deffn

@geindex release() (método asyncio.Semaphore)
@anchor{library/asyncio-sync asyncio Semaphore release}@anchor{34ed}
@deffn {Método} release ()

Release a semaphore, incrementing the internal counter by one.
Can wake up a task waiting to acquire the semaphore.

Unlike @ref{a7f,,BoundedSemaphore}, @ref{a7e,,Semaphore} allows
making more @code{release()} calls than @code{acquire()} calls.
@end deffn
@end deffn

@node BoundedSemaphore,Barrier,Semaphore,Synchronization Primitives
@anchor{library/asyncio-sync boundedsemaphore}@anchor{34ef}
@subsubsection BoundedSemaphore


@geindex BoundedSemaphore (classe em asyncio)
@anchor{library/asyncio-sync asyncio BoundedSemaphore}@anchor{a7f}
@deffn {Classe} asyncio.BoundedSemaphore (value=1)

A bounded semaphore object.  Not thread-safe.

Bounded Semaphore is a version of @ref{a7e,,Semaphore} that raises
a @ref{202,,ValueError} in @ref{34ed,,release()} if it
increases the internal counter above the initial `value'.


Alterado na versão 3.10: Removido o parâmetro `loop'.

@end deffn

@node Barrier,,BoundedSemaphore,Synchronization Primitives
@anchor{library/asyncio-sync barrier}@anchor{34f0}
@subsubsection Barrier


@geindex Barrier (classe em asyncio)
@anchor{library/asyncio-sync asyncio Barrier}@anchor{601}
@deffn {Classe} asyncio.Barrier (parties)

A barrier object.  Not thread-safe.

A barrier is a simple synchronization primitive that allows to block until
`parties' number of tasks are waiting on it.
Tasks can wait on the @ref{34f1,,wait()} method and would be blocked until
the specified number of tasks end up waiting on @ref{34f1,,wait()}.
At that point all of the waiting tasks would unblock simultaneously.

@ref{5d5,,async with} can be used as an alternative to awaiting on
@ref{34f1,,wait()}.

The barrier can be reused any number of times.
@anchor{library/asyncio-sync asyncio-example-barrier}@anchor{34f2}
Exemplo:

@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

Result of this example is:

@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


Adicionado na versão 3.11.


@geindex wait() (método asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier wait}@anchor{34f1}
@deffn {Método} async wait ()

Pass the barrier. When all the tasks party to the barrier have called
this function, they are all unblocked simultaneously.

When a waiting or blocked task in the barrier is cancelled,
this task exits the barrier which stays in the same state.
If the state of the barrier is “filling”, the number of waiting task
decreases by 1.

The return value is an integer in the range of 0 to @code{parties-1}, different
for each task. This can be used to select a task to do some special
housekeeping, e.g.:

@example
...
async with barrier as position:
   if position == 0:
      # Only one task prints this
      print('End of *draining phase*')
@end example

This method may raise a @ref{602,,BrokenBarrierError} exception if the
barrier is broken or reset while a task is waiting.
It could raise a @ref{1b8,,CancelledError} if a task is cancelled.
@end deffn

@geindex reset() (método asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier reset}@anchor{34f3}
@deffn {Método} async reset ()

Return the barrier to the default, empty state.  Any tasks waiting on it
will receive the @ref{602,,BrokenBarrierError} exception.

If a barrier is broken it may be better to just leave it and create a new one.
@end deffn

@geindex abort() (método asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier abort}@anchor{34f4}
@deffn {Método} async abort ()

Put the barrier into a broken state.  This causes any active or future
calls to @ref{34f1,,wait()} to fail with the @ref{602,,BrokenBarrierError}.
Use this for example if one of the tasks needs to abort, to avoid infinite
waiting tasks.
@end deffn

@geindex parties (atributo asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier parties}@anchor{34f5}
@deffn {Atributo} parties

The number of tasks required to pass the barrier.
@end deffn

@geindex n_waiting (atributo asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier n_waiting}@anchor{34f6}
@deffn {Atributo} n_waiting

The number of tasks currently waiting in the barrier while filling.
@end deffn

@geindex broken (atributo asyncio.Barrier)
@anchor{library/asyncio-sync asyncio Barrier broken}@anchor{34f7}
@deffn {Atributo} broken

A boolean that is @code{True} if the barrier is in the broken state.
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/asyncio-sync asyncio BrokenBarrierError}@anchor{602}
@deffn {Exceção} asyncio.BrokenBarrierError

This exception, a subclass of @ref{195,,RuntimeError}, is raised when the
@ref{601,,Barrier} object is reset or broken.
@end deffn


__________________________________________________________________



Alterado na versão 3.9: Acquiring a lock using @code{await lock} or @code{yield from lock} and/or
@ref{5d2,,with} statement (@code{with await lock}, @code{with (yield from
lock)}) was removed.  Use @code{async with lock} instead.


@node Subprocessos,Filas,Synchronization Primitives,asyncio — E/S assíncrona
@anchor{library/asyncio-subprocess doc}@anchor{34f8}@anchor{library/asyncio-subprocess asyncio-subprocess}@anchor{3478}@anchor{library/asyncio-subprocess subprocesses}@anchor{34f9}@anchor{library/asyncio-subprocess translation-repo}@anchor{34fa}
@subsubsection Subprocessos


`Código-fonte:' Lib/asyncio/subprocess.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/subprocess.py}, Lib/asyncio/base_subprocess.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/base_subprocess.py}


__________________________________________________________________


Esta seção descreve APIs async/await asyncio de alto nível para criar e gerenciar subprocessos.
@anchor{library/asyncio-subprocess asyncio-example-subprocess-shell}@anchor{34fb}
Aqui está um exemplo de como asyncio pode executar um comando shell e obter o seu 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

irá exibir:

@example
['ls /zzz' exited with 1]
[stderr]
ls: /zzz: No such file or directory
@end example

Devido ao fato que todas as funções de subprocessos asyncio são assíncronas e asyncio fornece muitas ferramentas para trabalhar com tais funções, é fácil executar e monitorar múltiplos subprocessos em paralelo. É na verdade trivial modificar o exemplo acima para executar diversos comandos simultaneamente:

@example
async def main():
    await asyncio.gather(
        run('ls /zzz'),
        run('sleep 1; echo "hello"'))

asyncio.run(main())
@end example

Veja também a subseção @ref{34fc,,Exemplos}.

@menu
* Criando subprocessos:: 
* Constantes: Constantes<7>. 
* Interagindo com subprocessos:: 

@end menu

@node Criando subprocessos,Constantes<7>,,Subprocessos
@anchor{library/asyncio-subprocess creating-subprocesses}@anchor{34fd}
@subsubsection Criando subprocessos


@geindex create_subprocess_exec() (no módulo asyncio)
@anchor{library/asyncio-subprocess asyncio create_subprocess_exec}@anchor{a81}
@deffn {Função} async asyncio.create_subprocess_exec (program, *args, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

Cria um subprocesso.

O argumento `limit' define o limite do buffer para os invólucros @ref{1a09,,StreamReader} para @ref{34fe,,stdout} e @ref{34ff,,stderr} (se @ref{b9f,,subprocess.PIPE} for passado para os argumentos `stdout' e `stderr').

Retorna uma instância de @ref{3500,,Process}.

Veja a documentação de @ref{3501,,loop.subprocess_exec()} para outros parâmetros.

Se o objeto do processo for coletado pelo coletor de lixo enquanto o processo ainda estiver em execução, o processo filho será finalizado.


Alterado na versão 3.10: Removido o parâmetro `loop'.

@end deffn

@geindex create_subprocess_shell() (no módulo asyncio)
@anchor{library/asyncio-subprocess asyncio create_subprocess_shell}@anchor{a82}
@deffn {Função} async asyncio.create_subprocess_shell (cmd, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

Executa o comando `cmd' no shell.

O argumento `limit' define o limite do buffer para os invólucros @ref{1a09,,StreamReader} para @ref{34fe,,stdout} e @ref{34ff,,stderr} (se @ref{b9f,,subprocess.PIPE} for passado para os argumentos `stdout' e `stderr').

Retorna uma instância de @ref{3500,,Process}.

Veja a documentação de @ref{3502,,loop.subprocess_shell()} para outros parâmetros.

Se o objeto do processo for coletado pelo coletor de lixo enquanto o processo ainda estiver em execução, o processo filho será finalizado.

@cartouche
@quotation Importante 
É responsabilidade da aplicação garantir que todos os espaços em branco e caracteres especiais tenham aspas apropriadamente para evitar vulnerabilidades de injeção de shell@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection}. A função @ref{27d,,shlex.quote()} pode ser usada para escapar espaços em branco e caracteres especiais de shell apropriadamente em strings que serão usadas para construir comandos shell.
@end quotation
@end cartouche


Alterado na versão 3.10: Removido o parâmetro `loop'.

@end deffn

@cartouche
@quotation Nota 
Subprocessos estão disponíveis para Windows se uma @ref{609,,ProactorEventLoop} for usada. Veja @ref{3503,,Suporte para subprocesso para Windows} para detalhes.
@end quotation
@end cartouche


@subsubheading Ver também


asyncio também tem as seguintes APIs `de baixo nível' para trabalhar com subprocessos: @ref{3501,,loop.subprocess_exec()}, @ref{3502,,loop.subprocess_shell()}, @ref{3504,,loop.connect_read_pipe()}, @ref{3505,,loop.connect_write_pipe()}, assim como os @ref{3506,,Transportes de Subprocesso} e @ref{3507,,Protocolos de Subprocesso}.


@node Constantes<7>,Interagindo com subprocessos,Criando subprocessos,Subprocessos
@anchor{library/asyncio-subprocess constants}@anchor{3508}
@subsubsection Constantes


@geindex asyncio.subprocess.PIPE (variável interna)
@anchor{library/asyncio-subprocess asyncio subprocess PIPE}@anchor{3509}
@deffn {Dado} asyncio.subprocess.PIPE

Pode ser passado para os parâmetros `stdin', `stdout' ou `stderr'.

Se `PIPE' for passado para o argumento `stdin', o atributo @ref{350a,,Process.stdin} irá apontar para uma instância @ref{17f2,,StreamWriter}.

Se `PIPE' for passado para os argumentos `stdout' ou `stderr', os atributos @ref{34fe,,Process.stdout} e @ref{34ff,,Process.stderr} irão apontar para instâncias @ref{1a09,,StreamReader}.
@end deffn

@geindex asyncio.subprocess.STDOUT (variável interna)
@anchor{library/asyncio-subprocess asyncio subprocess STDOUT}@anchor{350b}
@deffn {Dado} asyncio.subprocess.STDOUT

Valor especial que pode ser usado como o argumento `stderr' e indica que a saída de erro padrão deve ser redirecionada para a saída padrão.
@end deffn

@geindex asyncio.subprocess.DEVNULL (variável interna)
@anchor{library/asyncio-subprocess asyncio subprocess DEVNULL}@anchor{350c}
@deffn {Dado} asyncio.subprocess.DEVNULL

Valor especial que pode ser usado como argumento `stdin', `stdout' ou `stderr' para funções de criação de processos. Ele indica que o arquivo especial @ref{1bab,,os.devnull} será usado para o fluxo de subprocesso correspondente.
@end deffn

@node Interagindo com subprocessos,,Constantes<7>,Subprocessos
@anchor{library/asyncio-subprocess interacting-with-subprocesses}@anchor{350d}
@subsubsection Interagindo com subprocessos


Ambas as funções @ref{a81,,create_subprocess_exec()} e @ref{a82,,create_subprocess_shell()} retornam instâncias da classe `Process'. `Process' é um invólucro de alto nível que permite a comunicação com subprocessos e observar eles serem completados.

@geindex asyncio.subprocess.Process (classe interna)
@anchor{library/asyncio-subprocess asyncio subprocess Process}@anchor{3500}
@deffn {Classe} asyncio.subprocess.Process

Um objeto que envolve processos do sistema operacional criados pelas funções @ref{a81,,create_subprocess_exec()} e @ref{a82,,create_subprocess_shell()}.

Esta classe é projetada para ter uma API similar a classe @ref{199,,subprocess.Popen}, mas existem algumas diferenças notáveis:


@itemize *

@item 
ao contrário de Popen, instâncias de Process não têm um equivalente ao método @ref{3411,,poll()};

@item 
os métodos @ref{1823,,communicate()} e @ref{350e,,wait()} não têm um parâmetro `timeout': utilize a função @code{wait_for()};

@item 
o método @ref{350e,,Process.wait()} é assíncrono, enquanto que o método @ref{d05,,subprocess.Popen.wait()} é implementado como um laço bloqueante para indicar que está ocupado;

@item 
o parâmetro `universal_newlines' não é suportado.
@end itemize

Esta classe @ref{34a6,,não é segura para thread}.

Veja também a seção @ref{350f,,Subprocesso e Threads}.

@geindex wait() (método asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process wait}@anchor{350e}
@deffn {Método} async wait ()

Aguarda o processo filho encerrar.

Define e retorna o atributo @ref{3510,,returncode}.

@cartouche
@quotation Nota 
Este método pode entrar em deadlock ao usar @code{stdout=PIPE} ou @code{stderr=PIPE} e o processo filho gera tantas saídas que ele bloqueia a espera pelo encadeamento de buffer do sistema operacional para aceitar mais dados. Use o método @ref{1823,,communicate()} ao usar encadeamentos para evitar essa condição.
@end quotation
@end cartouche
@end deffn

@geindex communicate() (método asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process communicate}@anchor{1823}
@deffn {Método} async communicate (input=None)

Interage com processo:


@enumerate 

@item 
envia dados para `stdin' (se `input' for diferente de @code{None});

@item 
fecha `stdin';

@item 
lê dados a partir de `stdout' e `stderr', até que EOF (fim do arquivo) seja atingido;

@item 
aguarda o processo encerrar.
@end enumerate

O argumento opcional `input' é a informação (objeto @ref{1c2,,bytes}) que será enviada para o processo filho.

Retorna uma tupla @code{(stdout_data, stderr_data)}.

Se qualquer exceção @ref{1095,,BrokenPipeError} ou @ref{1098,,ConnectionResetError} for levantada ao escrever `input' em `stdin', a exceção é ignorada. Esta condição ocorre quando o processo encerra antes de todos os dados serem escritos em `stdin'.

Se for desejado enviar dados para o `stdin' do processo, o mesmo precisa ser criado com @code{stdin=PIPE}. De forma similar, para obter qualquer coisa além de @code{None} na tupla resultante, o processo precisa ser criado com os argumentos @code{stdout=PIPE} e/ou @code{stderr=PIPE}.

Perceba que, os dados lidos são armazenados em um buffer na memória, então não use este método se o tamanho dos dados é grande ou ilimitado.


Alterado na versão 3.12: `stdin' é fechado quando @code{input=None} é também.

@end deffn

@geindex send_signal() (método asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process send_signal}@anchor{16e3}
@deffn {Método} send_signal (signal)

Envia o sinal `signal' para o processo filho.

@cartouche
@quotation Nota 
No Windows, @ref{1426,,SIGTERM} é um apelido para @ref{3511,,terminate()}. @code{CTRL_C_EVENT} e @code{CTRL_BREAK_EVENT} podem ser enviados para processos iniciados com um parâmetro `creationflags', o qual inclui @code{CREATE_NEW_PROCESS_GROUP}.
@end quotation
@end cartouche
@end deffn

@geindex terminate() (método asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process terminate}@anchor{3511}
@deffn {Método} terminate ()

Interrompe o processo filho.

Em sistemas POSIX este método envia @ref{1426,,SIGTERM} para o processo filho.

No Windows a função @code{TerminateProcess()} da API Win32 é chamada para interromper o processo filho.
@end deffn

@geindex kill() (método asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process kill}@anchor{3512}
@deffn {Método} kill ()

Mata o processo filho.

Em sistemas POSIX este método envia @ref{b6e,,SIGKILL} para o processo filho.

No Windows, este método é um atalho para @ref{3511,,terminate()}.
@end deffn

@geindex stdin (atributo asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stdin}@anchor{350a}
@deffn {Atributo} stdin

Fluxo de entrada padrão (@ref{17f2,,StreamWriter}) ou @code{None} se o processo foi criado com @code{stdin=None}.
@end deffn

@geindex stdout (atributo asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stdout}@anchor{34fe}
@deffn {Atributo} stdout

Fluxo de saída padrão (@ref{1a09,,StreamReader}) ou @code{None} se o processo foi criado com @code{stdout=None}.
@end deffn

@geindex stderr (atributo asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process stderr}@anchor{34ff}
@deffn {Atributo} stderr

Erro de fluxo padrão (@ref{1a09,,StreamReader}) ou @code{None} se o processo foi criado com @code{stderr=None}.
@end deffn

@cartouche
@quotation Aviso 
Use o método @ref{1823,,communicate()} ao invés de @ref{350a,,process.stdin.write()}, @ref{34fe,,await process.stdout.read()} ou @ref{34ff,,await process.stderr.read()}. Isso evita deadlocks devido a fluxos pausando a leitura ou escrita, e bloqueando o processo filho.
@end quotation
@end cartouche

@geindex pid (atributo asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process pid}@anchor{3513}
@deffn {Atributo} pid

Número de identificação do processo (PID).

Perceba que para processos criados pela função @ref{a82,,create_subprocess_shell()}, este atributo é o PID do console gerado.
@end deffn

@geindex returncode (atributo asyncio.subprocess.Process)
@anchor{library/asyncio-subprocess asyncio subprocess Process returncode}@anchor{3510}
@deffn {Atributo} returncode

Retorna o código do processo quando o mesmo terminar.

Um valor @code{None} indica que o processo ainda não terminou.

Um valor negativo @code{-N} indica que o filho foi terminado pelo sinal @code{N} (POSIX apenas).
@end deffn
@end deffn

@menu
* Subprocesso e Threads:: 
* Exemplos: Exemplos<16>. 

@end menu

@node Subprocesso e Threads,Exemplos<16>,,Interagindo com subprocessos
@anchor{library/asyncio-subprocess asyncio-subprocess-threads}@anchor{350f}@anchor{library/asyncio-subprocess subprocess-and-threads}@anchor{3514}
@subsubsection Subprocesso e Threads


Laço de eventos padrão do asyncio suporta a execução de subprocessos a partir de diferentes threads por padrão.

No Windows, subprocessos são fornecidos pela classe @ref{609,,ProactorEventLoop} apenas (por padrão), a classe @ref{608,,SelectorEventLoop} não tem suporte a subprocesso.

Em sistemas UNIX, `monitores de filhos' são usados para aguardar o encerramento de subprocesso, veja @ref{3515,,Monitores de processos} para mais informações.


Alterado na versão 3.8: UNIX mudou para usar @ref{47b,,ThreadedChildWatcher} para gerar subprocessos a partir de diferentes threads sem qualquer limitação.

Gerar um subprocesso com um monitor `inativo' para o filho atual, levanta @ref{195,,RuntimeError}.


Perceba que implementações alternativas do laço de eventos podem ter limitações próprias; por favor, verifique a sua documentação.


@subsubheading Ver também


A seção @ref{34a6,,Concorrência e multithreading em asyncio}.


@node Exemplos<16>,,Subprocesso e Threads,Interagindo com subprocessos
@anchor{library/asyncio-subprocess examples}@anchor{34fc}
@subsubsection Exemplos


Um exemplo de uso da classe @ref{3500,,Process} para controlar um subprocesso e a classe @ref{1a09,,StreamReader} para ler a partir da sua saída padrão.
@anchor{library/asyncio-subprocess asyncio-example-create-subprocess-exec}@anchor{3516}
O subprocesso é criado pela função @ref{a81,,create_subprocess_exec()}:

@example
import asyncio
import sys

async def get_date():
    code = 'import datetime; print(datetime.datetime.now())'

    # Cria um subprocesso; redireciona a saída padrão
    # para o encadeamento.
    proc = await asyncio.create_subprocess_exec(
        sys.executable, '-c', code,
        stdout=asyncio.subprocess.PIPE)

    # Lê uma linha da saída.
    data = await proc.stdout.readline()
    line = data.decode('ascii').rstrip()

    # Espera o subprocesso sair.
    await proc.wait()
    return line

date = asyncio.run(get_date())
print(f"Current date: @{date@}")
@end example

Veja também o @ref{3517,,mesmo exemplo} escrito usando APIs de baixo nível.

@node Filas,Exceções<13>,Subprocessos,asyncio — E/S assíncrona
@anchor{library/asyncio-queue doc}@anchor{3518}@anchor{library/asyncio-queue asyncio-queues}@anchor{3479}@anchor{library/asyncio-queue queues}@anchor{3519}@anchor{library/asyncio-queue translation-repo}@anchor{351a}
@subsubsection Filas


`Código-fonte:' Lib/asyncio/queues.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/queues.py}


__________________________________________________________________


Filas asyncio são projetadas para serem similar a classes do módulo @ref{b6,,queue}. Apesar de filas asyncio não serem seguras para thread, elas são projetadas para serem usadas especificamente em código async/await.

Perceba que métodos de filas asyncio não possuem um parâmetro `timeout'; use a função @ref{5ff,,asyncio.wait_for()} para realizar operações de fila com um tempo limite timeout.

Veja também a seção @ref{351b,,Exemplos} abaixo.

@menu
* Queue:: 
* Fila de prioridade:: 
* Filas LIFO (último a entrar@comma{} primeiro a sair): Filas LIFO último a entrar primeiro a sair. 
* Exceções: Exceções<12>. 
* Exemplos: Exemplos<17>. 

@end menu

@node Queue,Fila de prioridade,,Filas
@anchor{library/asyncio-queue queue}@anchor{351c}
@subsubsection Queue


@geindex Queue (classe em asyncio)
@anchor{library/asyncio-queue asyncio Queue}@anchor{a80}
@deffn {Classe} asyncio.Queue (maxsize=0)

Uma fila onde o primeiro a entrar, é o primeiro a sair (FIFO - First In First Out).

Se `maxsize' for menor que ou igual a zero, o tamanho da fila é infinito. Se ele for um inteiro maior que @code{0}, então @code{await put()} bloqueia quando a fila atingir `maxsize' até que um item seja removido por @ref{351d,,get()}.

Ao contrário da biblioteca padrão de threading @ref{b6,,queue}, o tamanho da fila é sempre conhecido e pode ser obtido através da chamada do método @ref{351e,,qsize()}.


Alterado na versão 3.10: Removido o parâmetro `loop'.


Esta classe @ref{34a6,,não é segura para thread}.

@geindex maxsize (atributo asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue maxsize}@anchor{351f}
@deffn {Atributo} maxsize

Número de itens permitidos na fila.
@end deffn

@geindex empty() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue empty}@anchor{3520}
@deffn {Método} empty ()

Retorna @code{True} se a fila estiver vazia, @code{False} caso contrário.
@end deffn

@geindex full() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue full}@anchor{3521}
@deffn {Método} full ()

Retorna @code{True} se existem @ref{351f,,maxsize} itens na fila.

Se a fila foi inicializada com @code{maxsize=0} (o padrão), então @ref{3521,,full()} nunca retorna @code{True}.
@end deffn

@geindex get() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue get}@anchor{351d}
@deffn {Método} async get ()

Remove e retorna um item da fila. Se a fila estiver vazia, aguarda até que um item esteja disponível.

Levanta @ref{1b1,,QueueShutDown} se a fila foi encerrada e está vazia, ou se a fila foi encerrada imediatamente.
@end deffn

@geindex get_nowait() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue get_nowait}@anchor{3522}
@deffn {Método} get_nowait ()

Retorna um item se houver um imediatamente disponível, caso contrário levanta @ref{3523,,QueueEmpty}.
@end deffn

@geindex join() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue join}@anchor{df0}
@deffn {Método} async join ()

Bloqueia até que todos os itens na fila tenham sido recebidos e processados.

A contagem de tarefas inacabadas aumenta sempre que um item é adicionado à fila. A contagem diminui sempre que uma corrotina consumidora chama @ref{df1,,task_done()} para indicar que o item foi recuperado e todo o trabalho nele foi concluído. Quando a contagem de tarefas inacabadas chega a zero, @ref{df0,,join()} desbloqueia.
@end deffn

@geindex put() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue put}@anchor{3524}
@deffn {Método} async put (item)

Coloca um item na fila. Se a fila estiver cheia, aguarda até que uma posição livre esteja disponível antes de adicionar o item.

Levanta @ref{1b1,,QueueShutDown} se a fila foi encerrada.
@end deffn

@geindex put_nowait() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue put_nowait}@anchor{3525}
@deffn {Método} put_nowait (item)

Coloca um item na fila sem bloqueá-la.

Se nenhuma posição livre estiver imediatamente disponível, levanta @ref{3526,,QueueFull}.
@end deffn

@geindex qsize() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue qsize}@anchor{351e}
@deffn {Método} qsize ()

Retorna o número de itens na fila.
@end deffn

@geindex shutdown() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue shutdown}@anchor{1b0}
@deffn {Método} shutdown (immediate=False)

Coloca uma instância de @ref{a80,,Queue} em modo de desligamento.

The queue can no longer grow.
Future calls to @ref{3524,,put()} raise @ref{1b1,,QueueShutDown}.
Currently blocked callers of @ref{3524,,put()} will be unblocked
and will raise @ref{1b1,,QueueShutDown} in the formerly awaiting task.

Se `immediate' for falso (o padrão), a fila pode ser encerrada normalmente com chamadas @ref{351d,,get()} para extrair tarefas que já foram carregadas.

E se @ref{df1,,task_done()} for chamado para cada tarefa restante, um @ref{df0,,join()} pendente será desbloqueado normalmente.

Assim que a fila estiver vazia, chamadas futuras para @ref{351d,,get()} vão levantar @ref{1b1,,QueueShutDown}.

Se `immediate' for verdadeiro, a fila é encerrada imediatamente. A fila é esvaziada completamente e a contagem de tarefas não concluídas é reduzida pelo número de tarefas concluídas. Se o número de tarefas não concluídas for zero, as chamadas de @ref{df0,,join()} são desbloqueadas. Além disso, as chamadas bloqueadas de @ref{351d,,get()} são desbloqueadas e levantarão uma exceção @ref{1b1,,QueueShutDown} porque a fila está vazia.

Tenha cuidado ao usar @ref{df0,,join()} com a opção `immediate' definida como verdadeiro. Isso desbloqueia a junção mesmo quando nenhuma tarefa foi executada, violando a invariante usual para a junção de uma fila.


Adicionado na versão 3.13.

@end deffn

@geindex task_done() (método asyncio.Queue)
@anchor{library/asyncio-queue asyncio Queue task_done}@anchor{df1}
@deffn {Método} task_done ()

Indica que o item de trabalho anteriormente enfileirado está concluído.

Usada por consumidores de fila. Para cada @ref{351d,,get()} usado para buscar um item de trabalho, uma chamada subsequente para @ref{df1,,task_done()} avisa à fila, que o processamento no item de trabalho está concluído.

Se um @ref{df0,,join()} estiver sendo bloqueado no momento, ele irá continuar quando todos os itens tiverem sido processados (significando que uma chamada @ref{df1,,task_done()} foi recebida para cada item que foi chamado o método @ref{3524,,put()} para colocar na fila).

Levanta @ref{202,,ValueError} se chamada mais vezes do que a quantidade de itens existentes na fila.
@end deffn
@end deffn

@node Fila de prioridade,Filas LIFO último a entrar primeiro a sair,Queue,Filas
@anchor{library/asyncio-queue priority-queue}@anchor{3527}
@subsubsection Fila de prioridade


@geindex PriorityQueue (classe em asyncio)
@anchor{library/asyncio-queue asyncio PriorityQueue}@anchor{3528}
@deffn {Classe} asyncio.PriorityQueue

Uma variante de @ref{a80,,Queue}; recupera entradas em ordem de prioridade (mais baixas primeiro).

Entradas são tipicamente tuplas no formato @code{(priority_number, data)}.
@end deffn

@node Filas LIFO último a entrar primeiro a sair,Exceções<12>,Fila de prioridade,Filas
@anchor{library/asyncio-queue lifo-queue}@anchor{3529}
@subsubsection Filas LIFO (último a entrar, primeiro a sair)


@geindex LifoQueue (classe em asyncio)
@anchor{library/asyncio-queue asyncio LifoQueue}@anchor{352a}
@deffn {Classe} asyncio.LifoQueue

Uma variante de @ref{a80,,Queue} que recupera as entradas adicionadas mais recentemente primeiro (último a entrar, primeiro a sair).
@end deffn

@node Exceções<12>,Exemplos<17>,Filas LIFO último a entrar primeiro a sair,Filas
@anchor{library/asyncio-queue exceptions}@anchor{352b}
@subsubsection Exceções


@geindex QueueEmpty
@anchor{library/asyncio-queue asyncio QueueEmpty}@anchor{3523}
@deffn {Exceção} asyncio.QueueEmpty

Esta exceção é levantada quando o método @ref{3522,,get_nowait()} é chamado em uma fila vazia.
@end deffn

@geindex QueueFull
@anchor{library/asyncio-queue asyncio QueueFull}@anchor{3526}
@deffn {Exceção} asyncio.QueueFull

Exceção levantada quando o método @ref{3525,,put_nowait()} é chamado em uma fila que atingiu seu `maxsize'.
@end deffn

@geindex QueueShutDown
@anchor{library/asyncio-queue asyncio QueueShutDown}@anchor{1b1}
@deffn {Exceção} asyncio.QueueShutDown

Exceção levantada quando @ref{3524,,put()} ou @ref{351d,,get()} é chamado em uma fila que foi desligada.


Adicionado na versão 3.13.

@end deffn

@node Exemplos<17>,,Exceções<12>,Filas
@anchor{library/asyncio-queue examples}@anchor{351b}
@subsubsection Exemplos

@anchor{library/asyncio-queue asyncio-example-queue-dist}@anchor{352c}
Filas podem ser usadas para distribuir cargas de trabalho entre diversas tarefas concorrentes:

@example
import asyncio
import random
import time


async def worker(nome, fila):
    while True:
        # Retira um "item de trabalho" da fila.
        dormir_por = await queue.get()

        # Dorme por "dormir_por" segundos.
        await asyncio.sleep(dormir_por)

        # Notifica a fila de que o "item de trabalho" foi processado.
        fila.task_done()

        print(f'@{nome@} dormiu por @{dormir_por:.2f@} segundos')


async def main():
    # Cria uma fila para armazenar nossa "carga de trabalho".
    fila = asyncio.Queue()

    # Gera tempos aleatórios e os insere na fila.
    tempo_total_de_sono = 0
    for _ in range(20):
        dormir_por = random.uniform(0.05, 1.0)
        tempo_total_de_sono += dormir_por
        fila.put_nowait(dormir_por)

    # Cria três tarefas "worker" para processarem a fila concorrentemente.
    tarefas = []
    for i in range(3):
        tarefa = asyncio.create_task(worker(f'worker-@{i@}', fila))
        tarefas.append(tarefa)

    # Espera até a fila ser completamente processada.
    comecou_em = time.monotonic()
    await fila.join()
    tempo_dormido = time.monotonic() - comecou_em

    # Cancela nossas tarefas.
    for tarefa in tarefas:
        tarefa.cancel()
    # Espera até todas as tarefas serem canceladas.
    await asyncio.gather(*tarefas, return_exceptions=True)

    print('====')
    print(f'3 trabalhadoras dormiram em paralelo por @{tempo_dormido:.2f@} segundos')
    print(f'Tempo total de sono esperado: @{tempo_total_de_sono:.2f@} segundos')


asyncio.run(main())
@end example

@node Exceções<13>,Laço de eventos,Filas,asyncio — E/S assíncrona
@anchor{library/asyncio-exceptions doc}@anchor{352d}@anchor{library/asyncio-exceptions asyncio-exceptions}@anchor{352e}@anchor{library/asyncio-exceptions exceptions}@anchor{352f}@anchor{library/asyncio-exceptions translation-repo}@anchor{3530}
@subsubsection Exceções


`Código-fonte:' Lib/asyncio/exceptions.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/exceptions.py}


__________________________________________________________________


@geindex TimeoutError
@anchor{library/asyncio-exceptions asyncio TimeoutError}@anchor{183c}
@deffn {Exceção} asyncio.TimeoutError

Um apelido descontinuado de @ref{838,,TimeoutError}, levantado quando a operação excedeu o prazo determinado.


Alterado na versão 3.11: Esta classe foi feita como um apelido de @ref{838,,TimeoutError}.

@end deffn

@geindex CancelledError
@anchor{library/asyncio-exceptions asyncio CancelledError}@anchor{1b8}
@deffn {Exceção} asyncio.CancelledError

A operação foi cancelada.

Esta exceção pode ser capturada para executar operações personalizadas quando as tarefas assíncronas são canceladas. Em quase todas as situações, a exceção deve ser levantada novamente.


Alterado na versão 3.8: @ref{1b8,,CancelledError} é agora uma subclasse de @ref{5bb,,BaseException} em vez de @ref{9e2,,Exception}.

@end deffn

@geindex InvalidStateError
@anchor{library/asyncio-exceptions asyncio InvalidStateError}@anchor{34ae}
@deffn {Exceção} asyncio.InvalidStateError

Estado interno inválido de @ref{1be,,Task} ou @ref{be6,,Future}.

Pode ser levantada em situações como definir um valor de resultado para um objeto `Future' que já tem um valor de resultado definido.
@end deffn

@geindex SendfileNotAvailableError
@anchor{library/asyncio-exceptions asyncio SendfileNotAvailableError}@anchor{3531}
@deffn {Exceção} asyncio.SendfileNotAvailableError

A `syscall' “sendfile” não está disponível para o soquete ou tipo de arquivo fornecido.

Uma subclasse de @ref{195,,RuntimeError}.
@end deffn

@geindex IncompleteReadError
@anchor{library/asyncio-exceptions asyncio IncompleteReadError}@anchor{1a75}
@deffn {Exceção} asyncio.IncompleteReadError

A operação de leitura solicitada não foi totalmente concluída.

Levantada pelas @ref{3477,,APIs de fluxo de asyncio}.

Esta exceção é uma subclasse de @ref{131c,,EOFError}.

@geindex expected (atributo asyncio.IncompleteReadError)
@anchor{library/asyncio-exceptions asyncio IncompleteReadError expected}@anchor{3532}
@deffn {Atributo} expected

O número total (@ref{257,,int}) de bytes esperados.
@end deffn

@geindex partial (atributo asyncio.IncompleteReadError)
@anchor{library/asyncio-exceptions asyncio IncompleteReadError partial}@anchor{34c3}
@deffn {Atributo} partial

Uma string de @ref{1c2,,bytes} lida antes do final do fluxo ser alcançado.
@end deffn
@end deffn

@geindex LimitOverrunError
@anchor{library/asyncio-exceptions asyncio LimitOverrunError}@anchor{34c4}
@deffn {Exceção} asyncio.LimitOverrunError

Atingiu o limite de tamanho do buffer ao procurar um separador.

Levantada pelas @ref{3477,,APIs de fluxo de asyncio}.

@geindex consumed (atributo asyncio.LimitOverrunError)
@anchor{library/asyncio-exceptions asyncio LimitOverrunError consumed}@anchor{3533}
@deffn {Atributo} consumed

O número total de bytes a serem consumidos.
@end deffn
@end deffn

@node Laço de eventos,Futuros,Exceções<13>,asyncio — E/S assíncrona
@anchor{library/asyncio-eventloop doc}@anchor{3534}@anchor{library/asyncio-eventloop asyncio-event-loop}@anchor{d9e}@anchor{library/asyncio-eventloop event-loop}@anchor{3535}@anchor{library/asyncio-eventloop translation-repo}@anchor{3536}
@subsubsection Laço de eventos


`Código-fonte:' Lib/asyncio/events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/events.py}, Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/base_events.py}


__________________________________________________________________


@subsubheading Prefácio


O laço de eventos é o núcleo de toda aplicação asyncio. Laços de eventos executam tarefas e funções de retorno assíncronas, realizam operações de entrada e saída e executam subprocessos.

Os desenvolvedores de aplicação normalmente devem usar as funções asyncio de alto nível, como @ref{47c,,asyncio.run()}, e devem raramente precisar fazer referência ao objeto de loop ou chamar seus métodos. Esta seção destina-se principalmente a autores de código de baixo nível, bibliotecas e frameworks, que precisam de um controle mais preciso sobre o comportamento do laço de evento.

@subsubheading Obtendo o laço de eventos


As seguintes funções baixo nível podem ser usadas para obter, definir, ou criar um laço de eventos:

@geindex get_running_loop() (no módulo asyncio)
@anchor{library/asyncio-eventloop asyncio get_running_loop}@anchor{b1d}
@deffn {Função} asyncio.get_running_loop ()

Retorna o laço de eventos em execução na thread atual do sistema operacional.

Levanta uma @ref{195,,RuntimeError} se não houver nenhum laço de eventos em execução.

Esta função só pode ser chamada a partir de uma corrotina ou de um retorno de chamada.


Adicionado na versão 3.7.

@end deffn

@geindex get_event_loop() (no módulo asyncio)
@anchor{library/asyncio-eventloop asyncio get_event_loop}@anchor{2c2}
@deffn {Função} asyncio.get_event_loop ()

Obtém o laço de eventos atual.

Quando chamada de uma corrotina ou função de retorno (por exemplo, agendada com call_soon ou API semelhante), esta função sempre retornará o laço de eventos em execução.

Se não houver nenhum laço de eventos em execução definido, a função retornará o resultado da chamada @code{get_event_loop_policy().get_event_loop()}.

Devido ao fato desta função ter um comportamento particularmente complexo (especialmente quando políticas de laço de eventos customizadas estão sendo usadas), usar a função @ref{b1d,,get_running_loop()} é preferido ao invés de @ref{2c2,,get_event_loop()} em corrotinas e funções de retorno.

Como observado acima, considere usar também a função de alto nível @ref{47c,,asyncio.run()} ao invés de usar funções de baixo nível para manualmente criar e fechar um laço de eventos.


Descontinuado desde a versão 3.12: Um aviso de descontinuação é emitido se não houver nenhum laço de eventos atual. Em alguma versão futura do Python, isso se tornará um erro.

@end deffn

@geindex set_event_loop() (no módulo asyncio)
@anchor{library/asyncio-eventloop asyncio set_event_loop}@anchor{18df}
@deffn {Função} asyncio.set_event_loop (loop)

Define `loop' como o laço de eventos atual para a thread atual do sistema operacional.
@end deffn

@geindex new_event_loop() (no módulo asyncio)
@anchor{library/asyncio-eventloop asyncio new_event_loop}@anchor{3484}
@deffn {Função} asyncio.new_event_loop ()

Cria e retorna um novo objeto de laço de eventos.
@end deffn

Perceba que o comportamento das funções @ref{2c2,,get_event_loop()}, @ref{18df,,set_event_loop()}, e @ref{3484,,new_event_loop()} podem ser alteradas @ref{3537,,definindo uma política de laço de eventos customizada}.

@subsubheading Conteúdo


Esta página de documentação contém as seguintes seções:


@itemize *

@item 
A seção @ref{3538,,Métodos do laço de eventos} é a documentação de referência das APIs de laço de eventos;

@item 
A seção @ref{3539,,Tratadores de função de retorno} documenta as instâncias das classes @ref{1c1d,,Handle} e @ref{1865,,TimerHandle}, que são retornadas por métodos de agendamento tais como @ref{b17,,loop.call_soon()} e @ref{b29,,loop.call_later()};

@item 
A seção @ref{353a,,Objetos Server} documenta tipos retornados a partir de métodos de laço de eventos, como @ref{b25,,loop.create_server()};

@item 
A seção @ref{353b,,Implementações do Laço de Eventos} documenta as classes @ref{608,,SelectorEventLoop} e @ref{609,,ProactorEventLoop};

@item 
A seção @ref{353c,,Exemplos} demonstra como trabalhar com algumas APIs do laço de eventos APIs.
@end itemize

@menu
* Métodos do laço de eventos:: 
* Tratadores de função de retorno:: 
* Objetos Server:: 
* Implementações do laço de eventos:: 
* Exemplos: Exemplos<18>. 

@end menu

@node Métodos do laço de eventos,Tratadores de função de retorno,,Laço de eventos
@anchor{library/asyncio-eventloop asyncio-event-loop-methods}@anchor{353d}@anchor{library/asyncio-eventloop event-loop-methods}@anchor{3538}
@subsubsection Métodos do laço de eventos


Laços de eventos possuem APIs de `baixo nível' para as seguintes situações:

@menu
* Executar e interromper o laço:: 
* Agendando funções de retorno:: 
* Agendando funções de retorno atrasadas:: 
* Criando Futures e Tasks:: 
* Abrindo conexões de rede:: 
* Criando servidores de rede:: 
* Transferindo arquivos:: 
* Atualizando TLS:: 
* Observando descritores de arquivo:: 
* Trabalhando com objetos soquete diretamente:: 
* DNS:: 
* Trabalhando com encadeamentos:: 
* Sinais Unix:: 
* Executando código em conjuntos de threads ou processos:: 
* Tratando erros da API:: 
* Habilitando o modo de debug:: 
* Executando subprocessos:: 

@end menu

@node Executar e interromper o laço,Agendando funções de retorno,,Métodos do laço de eventos
@anchor{library/asyncio-eventloop running-and-stopping-the-loop}@anchor{353e}
@subsubsection Executar e interromper o laço


@geindex run_until_complete() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_until_complete}@anchor{c93}
@deffn {Método} loop.run_until_complete (future)

Executar até que o `future' (uma instância da classe @ref{be6,,Future}) seja completada.

Se o argumento é um @ref{3476,,objeto corrotina}, ele é implicitamente agendado para executar como uma @ref{1be,,asyncio.Task}.

Retorna o resultado do Future ou levanta sua exceção.
@end deffn

@geindex run_forever() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_forever}@anchor{353f}
@deffn {Método} loop.run_forever ()

Executa o laço de eventos até que @ref{c98,,stop()} seja chamado.

If @ref{c98,,stop()} is called before @ref{353f,,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.

Se @ref{c98,,stop()} for chamado enquanto @ref{353f,,run_forever()} estiver executando, o laço irá executar o lote atual de funções de retorno e então sair. Perceba que novas funções de retorno agendadas por funções de retorno não serão executadas neste caso; ao invés disso, elas serão executadas na próxima vez que @ref{353f,,run_forever()} ou @ref{c93,,run_until_complete()} forem chamadas.
@end deffn

@geindex stop() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop stop}@anchor{c98}
@deffn {Método} loop.stop ()

Para o laço de eventos.
@end deffn

@geindex is_running() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop is_running}@anchor{3540}
@deffn {Método} loop.is_running ()

Retorna @code{True} se o laço de eventos estiver em execução.
@end deffn

@geindex is_closed() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop is_closed}@anchor{dec}
@deffn {Método} loop.is_closed ()

Retorna @code{True} se o laço de eventos foi fechado.
@end deffn

@geindex close() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop close}@anchor{3541}
@deffn {Método} loop.close ()

Fecha o laço de eventos.

O laço não deve estar em execução quando esta função for chamada. Qualquer função de retorno pendente será descartada.

Este método limpa todas as filas e desliga o executor, mas não aguarda pelo encerramento do executor.

Este método é idempotente e irreversível. Nenhum outro método deve ser chamado depois que o laço de eventos esteja fechado.
@end deffn

@geindex shutdown_asyncgens() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop shutdown_asyncgens}@anchor{c9a}
@deffn {Método} async loop.shutdown_asyncgens ()

Schedule all currently open @ref{21cf,,asynchronous generator} objects to
close with an @ref{8de,,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.

Perceba que não é necessário chamar esta função quando @ref{47c,,asyncio.run()} for usado.

Exemplo:

@example
try:
    loop.run_forever()
finally:
    loop.run_until_complete(loop.shutdown_asyncgens())
    loop.close()
@end example


Adicionado na versão 3.6.

@end deffn

@geindex shutdown_default_executor() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop shutdown_default_executor}@anchor{8ed}
@deffn {Método} async loop.shutdown_default_executor (timeout=None)

Agenda o encerramento do executor padrão e aguarda ele se juntar a todas as threads no @ref{742,,ThreadPoolExecutor}. Uma vez que este método tenha sido chamado, usar o executor padrão com @ref{8ef,,loop.run_in_executor()} levantará um @ref{195,,RuntimeError}.

O parâmetro `timeout' especifica a quantidade de tempo (em @ref{2f7,,float} segundos) que o executor terá para terminar a junção. Com o padrão @code{None}, o executor tem permissão para um período de tempo ilimitado.

Se o `timeout' for atingido, uma exceção @ref{1bd,,RuntimeWarning} será emitida e o executor padrão será finalizado sem esperar que suas threads terminem a junção.

@cartouche
@quotation Nota 
Do not call this method when using @ref{47c,,asyncio.run()},
as the latter handles default executor shutdown automatically.
@end quotation
@end cartouche


Adicionado na versão 3.9.



Alterado na versão 3.12: Added the `timeout' parameter.

@end deffn

@node Agendando funções de retorno,Agendando funções de retorno atrasadas,Executar e interromper o laço,Métodos do laço de eventos
@anchor{library/asyncio-eventloop scheduling-callbacks}@anchor{3542}
@subsubsection Agendando funções de retorno


@geindex call_soon() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_soon}@anchor{b17}
@deffn {Método} loop.call_soon (callback, *args, context=None)

Agenda a `função de retorno' @ref{2ad2,,callback} para ser chamada com argumentos `args' na próxima iteração do laço de eventos.

Return an instance of @ref{1c1d,,asyncio.Handle},
which can be used later to cancel the callback.

Funções de retorno são chamadas na ordem em que elas foram registradas. Cada função de retorno será chamada exatamente uma vez.

The optional keyword-only `context' argument specifies a
custom @ref{15b7,,contextvars.Context} for the `callback' to run in.
Callbacks use the current context when no `context' is provided.

Unlike @ref{b18,,call_soon_threadsafe()}, this method is not thread-safe.
@end deffn

@geindex call_soon_threadsafe() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_soon_threadsafe}@anchor{b18}
@deffn {Método} loop.call_soon_threadsafe (callback, *args, context=None)

A thread-safe variant of @ref{b17,,call_soon()}. When scheduling callbacks from
another thread, this function `must' be used, since @ref{b17,,call_soon()} is not
thread-safe.

This function is safe to be called from a reentrant context or signal handler,
however, it is not safe or fruitful to use the returned handle in such contexts.

Levanta @ref{195,,RuntimeError} se chamado em um laço que já foi fechado. Isto pode acontecer em uma thread secundária quando a aplicação principal estiver desligando.

Veja a seção @ref{34a6,,concorrência e multithreading} da documentação.


Alterado na versão 3.7: O parâmetro somente-nomeado `context' foi adicionado. Veja 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mais detalhes.

@end deffn
@anchor{library/asyncio-eventloop asyncio-pass-keywords}@anchor{3543}
@cartouche
@quotation Nota 
Maior parte das funções de agendamento @ref{a,,asyncio} não permite passar argumentos nomeados. Para fazer isso, use @ref{414,,functools.partial()}:

@example
# will schedule "print("Hello", flush=True)"
loop.call_soon(
    functools.partial(print, "Hello", flush=True))
@end example

Usar objetos parciais é usualmente mais conveniente que usar lambdas, pois asyncio pode renderizar objetos parciais melhor durante debug e mensagens de erro.
@end quotation
@end cartouche

@node Agendando funções de retorno atrasadas,Criando Futures e Tasks,Agendando funções de retorno,Métodos do laço de eventos
@anchor{library/asyncio-eventloop asyncio-delayed-calls}@anchor{3544}@anchor{library/asyncio-eventloop scheduling-delayed-callbacks}@anchor{3545}
@subsubsection Agendando funções de retorno atrasadas


Laço de eventos fornece mecanismos para agendar funções de retorno para serem chamadas em algum ponto no futuro. Laço de eventos usa relógios monotônico para acompanhar o tempo.

@geindex call_later() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_later}@anchor{b29}
@deffn {Método} loop.call_later (delay, callback, *args, context=None)

Agenda `callback' para ser chamada após o `delay' número de segundos fornecido (pode ser um inteiro ou um ponto flutuante).

Uma instância de @ref{1865,,asyncio.TimerHandle} é retornada, a qual pode ser usada para cancelar a função de retorno.

`callback' será chamada exatamente uma vez. Se duas funções de retorno são agendadas para exatamente o mesmo tempo, a ordem na qual elas são chamadas é indefinida.

O `args' posicional opcional será passado para a função de retorno quando ela for chamada. Se você quiser que a função de retorno seja chamada com argumentos nomeados, use @ref{414,,functools.partial()}.

Um argumento opcional somente-nomeado `context' permite especificar um @ref{15b7,,contextvars.Context} customizado para executar na `função de retorno'. O contexto atual é usado quando nenhum `context' é fornecido.

@cartouche
@quotation Nota 
For performance, callbacks scheduled with @ref{b29,,loop.call_later()}
may run up to one clock-resolution early (see
@code{time.get_clock_info('monotonic').resolution}).
@end quotation
@end cartouche


Alterado na versão 3.7: O parâmetro somente-nomeado `context' foi adicionado. Veja 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mais detalhes.



Alterado na versão 3.8: No Python 3.7 e anterior, com a implementação padrão do laço de eventos, o `delay' não poderia exceder um dia. Isto foi ajustado no Python 3.8.

@end deffn

@geindex call_at() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_at}@anchor{b19}
@deffn {Método} loop.call_at (when, callback, *args, context=None)

Agenda `callback' para ser chamada no timestamp absoluto fornecido `when' (um inteiro ou um ponto flutuante), usando o mesmo horário de referência que @ref{3546,,loop.time()}.

O comportamento deste método é o mesmo que @ref{b29,,call_later()}.

Uma instância de @ref{1865,,asyncio.TimerHandle} é retornada, a qual pode ser usada para cancelar a função de retorno.

@cartouche
@quotation Nota 
For performance, callbacks scheduled with @ref{b19,,loop.call_at()}
may run up to one clock-resolution early (see
@code{time.get_clock_info('monotonic').resolution}).
@end quotation
@end cartouche


Alterado na versão 3.7: O parâmetro somente-nomeado `context' foi adicionado. Veja 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mais detalhes.



Alterado na versão 3.8: No Python 3.7 e anterior, com a implementação padrão do laço de eventos, a diferença entre `when' e o horário atual não poderia exceder um dia. Isto foi ajustado no Python 3.8.

@end deffn

@geindex time() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop time}@anchor{3546}
@deffn {Método} loop.time ()

Retorna o horário atual, como um valor @ref{2f7,,float}, de acordo com o relógio monotônico interno do laço de eventos.
@end deffn

@cartouche
@quotation Nota 

Alterado na versão 3.8: No Python 3.7 e anterior, tempos limites (`delay' relativo ou `when' absoluto) não poderiam exceder um dia. Isto foi ajustado no Python 3.8.

@end quotation
@end cartouche


@subsubheading Ver também


A função @ref{a79,,asyncio.sleep()}.


@node Criando Futures e Tasks,Abrindo conexões de rede,Agendando funções de retorno atrasadas,Métodos do laço de eventos
@anchor{library/asyncio-eventloop creating-futures-and-tasks}@anchor{3547}
@subsubsection Criando Futures e Tasks


@geindex create_future() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_future}@anchor{c95}
@deffn {Método} loop.create_future ()

Cria um objeto @ref{be6,,asyncio.Future} anexado ao laço de eventos.

Este é o modo preferido para criar Futures em asyncio. Isto permite que laços de eventos de terceiros forneçam implementações alternativas do objeto Future (com melhor desempenho ou instrumentação).


Adicionado na versão 3.5.2.

@end deffn

@geindex create_task() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_task}@anchor{1c0}
@deffn {Método} loop.create_task (coro, *, name=None, context=None, **kwargs)

Agenda a execução da @ref{3476,,corrotina} `coro'. Retorna um objeto @ref{1be,,Task}.

Laços de eventos de terceiros podem usar suas próprias subclasses de @ref{1be,,Task} para interoperabilidade. Neste caso, o tipo do resultado é uma subclasse de @ref{1be,,Task}.

The full function signature is largely the same as that of the
@ref{1be,,Task} constructor (or factory) - all of the keyword arguments to
this function are passed through to that interface, except `name',
or `context' if it is @code{None}.

Se o argumento `name' for fornecido e não for @code{None}, ele é definido como o nome da tarefa, usando @ref{9e5,,Task.set_name()}.

Um argumento opcional somente-nomeado `context' permite especificar um @ref{15b7,,contextvars.Context} personalizado para a `coro' ser executada. Uma cópia do contexto atual é criada quando nenhum `context' for fornecido.


Alterado na versão 3.8: Adicionado o parâmetro `name'.



Alterado na versão 3.11: Adicionado o parâmetro `context'.



Alterado na versão 3.13.3: Adicionado @code{kwargs}, que passa parâmetros extra arbitrários, incluindo @code{name} e @code{context}.



Alterado na versão 3.13.4: Reverteu a alteração que passava `name' e `context' (se for None), enquanto ainda passa outros argumentos somente-nomeados arbitrários (para evitar quebrar a compatibilidade retroativa com a versão 3.13.3).

@end deffn

@geindex set_task_factory() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_task_factory}@anchor{dee}
@deffn {Método} loop.set_task_factory (factory)

Define a fábrica da tarefa que será usada por @ref{1c0,,loop.create_task()}.

Se `factory' for @code{None}, será usada a fábrica de tarefas padrão. Caso contrário, `factory' deve ser um `chamável' com a assinatura @code{(loop, coro, **kwargs)}, em que `loop' é uma referência ao ciclo de eventos ativo e `coro' é um objeto corrotina. O chamável deve passar todos os `kwargs' e devolver um objeto compatível com @ref{1be,,asyncio.Task}.


Alterado na versão 3.13.3: Exigido que todos os `kwargs' sejam passados para @ref{1be,,asyncio.Task}.



Alterado na versão 3.13.4: `name' não é mais passado para fábricas de tarefas. `context' não é mais passado para fábricas de tarefas se for @code{None}.

@end deffn

@geindex get_task_factory() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_task_factory}@anchor{def}
@deffn {Método} loop.get_task_factory ()

Retorna uma fábrica de tarefa ou @code{None} se a fábrica padrão estiver em uso.
@end deffn

@node Abrindo conexões de rede,Criando servidores de rede,Criando Futures e Tasks,Métodos do laço de eventos
@anchor{library/asyncio-eventloop opening-network-connections}@anchor{3548}
@subsubsection Abrindo conexões de rede


@geindex create_connection() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_connection}@anchor{603}
@deffn {Método} async 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 uma conexão de transporte para streaming, para um endereço fornecido, especificado por `host' e `port'.

A família de sockets pode ser @ref{1938,,AF_INET} ou @ref{1939,,AF_INET6} dependendo do `host' (ou do argumento `family', se fornecido).

The socket type will be @ref{1337,,SOCK_STREAM}.

`protocol_factory' deve ser um chamável que retorne uma implementação do @ref{3549,,protocolo asyncio}.

Este método tentará estabelecer a conexão em segundo plano. Quando tiver sucesso, ele retorna um par @code{(transport, protocol)}.

A sinopse cronológica da operação subjacente é conforme abaixo:


@enumerate 

@item 
A conexão é estabelecida e um @ref{354a,,transporte} é criado para ela.

@item 
`protocol_factory' é chamada sem argumentos e é esperada que retorne uma instância de @ref{3549,,protocolo}.

@item 
A instância de protocolo é acoplada com o transporte, através da chamada do seu método @ref{354b,,connection_made()}.

@item 
Uma tupla @code{(transport, protocol)} é retornada ao ter sucesso.
@end enumerate

O transporte criado é um stream bi-direcional dependente de implementação.

Outros argumentos:


@itemize *

@item 
`ssl': se fornecido e não for falso, um transporte SSL/TLS é criado (por padrão um transporte TCP simples é criado). Se `ssl' for um objeto @ref{294,,ssl.SSLContext}, este contexto é usado para criar o transporte; se `ssl' for @ref{c27,,True}, um contexto padrão retornado de @ref{155,,ssl.create_default_context()} é usado.


@subsubheading Ver também


@ref{354c,,Considerações de segurança sobre SSL/TLS}


@item 
`server_hostname' define ou substitui o hostname que o certificado do servidor de destino será pareado contra. Deve ser passado apenas se `ssl' não for @code{None}. Por padrão o valor do argumento `host' é usado. Se `host' for vazio, não existe valor padrão e você deve passar um valor para `server_hostname'. Se `server_hostname' for uma string vazia, o pareamento de hostname é desabilitado (o que é um risco de segurança sério, permitindo ataques potenciais man-in-the-middle).

@item 
`family', `proto', `flags' são os endereços familiares, protocolos e sinalizadores opcionais a serem passados por getaddrinfo() para resolução do `host'. Se fornecidos, eles devem ser todos inteiros e constantes correspondentes do módulo @ref{cc,,socket}.

@item 
`happy_eyeballs_delay', se fornecido, habilita Happy Eyeballs para esta conexão. Ele deve ser um número de ponto flutuante representando o tempo em segundos para aguardar uma tentativa de conexão encerrar, antes de começar a próxima tentativa em paralelo. Este é o “Atraso na tentativa de conexão” conforme definido na 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html}. Um valor padrão sensível recomendado pela RFC é @code{0.25} (250 millissegundos).

@item 
`interleave' controla o reordenamento de endereços quando um nome de servidor resolve para múltiplos endereços IP. Se @code{0} ou não especificado, nenhum reordenamento é feito, e endereços são tentados na ordem retornada por @ref{c2e,,getaddrinfo()}. Se um inteiro positivo for especificado, os endereços são intercalados por um endereço familiar, e o inteiro fornecido é interpretado como “Contagem da família do primeiro endereço” conforme definido na 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html}. O padrão é @code{0} se `happy_eyeballs_delay' não for especificado, e @code{1} se ele for.

@item 
`sock', se fornecido, deve ser um objeto @ref{dc9,,socket.socket} já existente, já conectado, para ser usado por transporte. Se `sock' é fornecido, `host', `port', `family', `proto', `flags', `happy_eyeballs_delay', `interleave' e `local_addr' não devem ser especificados.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
transport created. To close the socket, call the transport’s
@ref{354d,,close()} method.
@end quotation
@end cartouche

@item 
`local_addr', se fornecido, é uma tupla de @code{(local_host, local_port)} usada para se ligar ao soquete localmente. O `local_host' e a `local_port' são procurados usando @code{getaddrinfo()}, de forma similar para `host' e `port'.

@item 
`ssl_handshake_timeout' é (para uma conexão TLS) o tempo em segundos para aguardar pelo encerramento do aperto de mão TLS, antes de abortar a conexão. @code{60.0} segundos se for @code{None} (valor padrão).

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

@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


Alterado na versão 3.5: Adicionado suporte para SSL/TLS na @ref{609,,ProactorEventLoop}.



Alterado na versão 3.6: The socket option @ref{b8b,,socket.TCP_NODELAY} is set by default
for all TCP connections.



Alterado na versão 3.7: Adicionado o parâmetro `ssl_handshake_timeout'.



Alterado na versão 3.8: Adicionados os parâmetros `happy_eyeballs_delay' e `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}



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.



Alterado na versão 3.12: `all_errors' was added.



@subsubheading Ver também


A função @ref{b2b,,open_connection()} é uma API alternativa de alto nível. Ela retorna um par de (@ref{1a09,,StreamReader}, @ref{17f2,,StreamWriter}) que pode ser usado diretamente em código async/await.

@end deffn

@geindex create_datagram_endpoint() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_datagram_endpoint}@anchor{733}
@deffn {Método} async 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)

Cria uma conexão de datagrama.

The socket family can be either @ref{1938,,AF_INET},
@ref{1939,,AF_INET6}, or @ref{193a,,AF_UNIX},
depending on `host' (or the `family' argument, if provided).

The socket type will be @ref{1336,,SOCK_DGRAM}.

`protocol_factory' deve ser algo chamável, retornando uma implementação de @ref{3549,,protocolo}.

Uma tupla de @code{(transport, protocol)} é retornada em caso de sucesso.

Outros argumentos:


@itemize *

@item 
`local_addr', se fornecido, é uma tupla de @code{(local_host, local_port)} usada para ligar o soquete localmente. O `local_host' e a `local_port' são procurados usando @ref{c2e,,getaddrinfo()}.

@cartouche
@quotation Nota 
On Windows, when using the proactor event loop with @code{local_addr=None},
an @ref{417,,OSError} with @code{errno.WSAEINVAL} will be raised
when running it.
@end quotation
@end cartouche

@item 
`remote_addr', se fornecido, é uma tupla de @code{(remote_host, remote_port)} usada para conectar o soquete a um endereço remoto. O `remote_host' e a `remote_port' são procurados usando @ref{c2e,,getaddrinfo()}.

@item 
`family', `proto', `flags' são os endereços familiares, protocolo e flags opcionais a serem passados para @ref{c2e,,getaddrinfo()} para resolução do `host'. Se fornecido, esses devem ser todos inteiros do módulo de constantes @ref{cc,,socket} correspondente.

@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{b8b,,socket.SO_REUSEPORT} constant is not
defined then this capability is unsupported.

@item 
`allow_broadcast' avisa o kernel para permitir que este endpoint envie mensagens para o endereço de broadcast.

@item 
`sock' pode opcionalmente ser especificado em ordem para usar um objeto @ref{dc9,,socket.socket} pre-existente, já conectado, para ser usado pelo transporte. Se especificado, `local_addr' e `remote_addr' devem ser omitidos (devem ser @ref{675,,None}).

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
transport created. To close the socket, call the transport’s
@ref{354d,,close()} method.
@end quotation
@end cartouche
@end itemize

Veja @ref{354e,,protocolo UDP eco cliente} e @ref{354f,,protocolo UDP eco servidor} para exemplos.


Alterado na versão 3.4.4: The `family', `proto', `flags', `reuse_address', `reuse_port',
`allow_broadcast', and `sock' parameters were added.



Alterado na versão 3.8: Adicionado suporte para Windows.



Alterado na versão 3.8.1: The `reuse_address' parameter is no longer supported, as using
@ref{b8b,,socket.SO_REUSEADDR}
poses a significant security concern for
UDP. Explicitly passing @code{reuse_address=True} will raise an exception.

Quando múltiplos processos com diferentes UIDs atribuem soquetes para um endereço de soquete UDP idêntico com @code{SO_REUSEADDR}, pacotes recebidos podem ser distribuídos aleatoriamente entre os soquetes.

For supported platforms, `reuse_port' can be used as a replacement for
similar functionality. With `reuse_port',
@ref{b8b,,socket.SO_REUSEPORT}
is used instead, which specifically
prevents processes with differing UIDs from assigning sockets to the same
socket address.



Alterado na versão 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 asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_unix_connection}@anchor{34bd}
@deffn {Método} async loop.create_unix_connection (protocol_factory, path=None, *, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Cria uma conexão Unix.

The socket family will be @ref{193a,,AF_UNIX}; socket
type will be @ref{1337,,SOCK_STREAM}.

Uma tupla de @code{(transport, protocol)} é retornada em caso de sucesso.

`path' é o nome de um soquete de domínio Unix e é obrigatório, a não ser que um parâmetro `sock' seja especificado. Soquetes Unix abstratos, @ref{44c,,str}, @ref{1c2,,bytes}, e caminhos @ref{229,,Path} são suportados.

Veja a documentação do método @ref{603,,loop.create_connection()} para informações a respeito de argumentos para este método.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.7: Adicionado o parâmetro `ssl_handshake_timeout'. O parâmetro `path' agora pode ser um @ref{2a0,,path-like object}.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@node Criando servidores de rede,Transferindo arquivos,Abrindo conexões de rede,Métodos do laço de eventos
@anchor{library/asyncio-eventloop creating-network-servers}@anchor{3550}
@subsubsection Criando servidores de rede


@geindex create_server() (método asyncio.loop)
@anchor{library/asyncio-eventloop loop-create-server}@anchor{347b}@anchor{library/asyncio-eventloop asyncio loop create_server}@anchor{b25}
@deffn {Método} async 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{1337,,SOCK_STREAM}) listening
on `port' of the `host' address.

Retorna um objeto @ref{b24,,Server}.

Argumentos:


@itemize *

@item 
`protocol_factory' deve ser algo chamável, retornando uma implementação de @ref{3549,,protocolo}.

@item 
O parâmetro `host' pode ser definido para diversos tipos, o qual determina onde o servidor deve escutar:


@itemize -

@item 
Se `host' for uma string, o servidor TCP está vinculado a apenas uma interface de rede, especificada por `host'.

@item 
Se `host' é uma sequência de strings, o servidor TCP está vinculado a todas as interfaces de rede especificadas pela sequência.

@item 
Se `host' é uma string vazia ou @code{None}, todas as interfaces são presumidas e uma lista de múltiplos soquetes será retornada (muito provavelmente um para IPv4 e outro para IPv6).
@end itemize

@item 
O parâmetro `port' pode ser definido para especificar qual porta o servidor deve escutar. Se @code{0} ou @code{None} (o padrão), uma porta aleatória disponível será selecionada (note que se `host' resolve para múltiplas interfaces de rede, uma porta aleatória diferente será selecionada para cada interface).

@item 
`family' can be set to either @ref{1938,,socket.AF_INET} or
@ref{1939,,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{3551,,AF_UNSPEC}).

@item 
`flags' é uma máscara de bits para @ref{c2e,,getaddrinfo()}.

@item 
`sock' pode opcionalmente ser especificado para usar um objeto soquete pré-existente. Se especificado, `host' e `port' não devem ser especificados.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
server created. To close the socket, call the server’s
@ref{34bb,,close()} method.
@end quotation
@end cartouche

@item 
`backlog' é o número máximo de conexões enfileiradas passadas para @ref{e8d,,listen()} (padrão é 100).

@item 
`ssl' pode ser definido para uma instância de @ref{294,,SSLContext} para habilitar TLS sobre as conexões aceitas.

@item 
`reuse_address' diz ao kernel para reusar um soquete local em estado @code{TIME_WAIT}, sem aguardar pela expiração natural do seu tempo limite. Se não especificado, será automaticamente definida como @code{True} no Unix.

@item 
`reuse_port' diz ao kernel para permitir que este endpoint seja vinculado a mesma porta que outros endpoints existentes estão vinculados, contanto que todos eles definam este sinalizador quando forem criados. Esta opção não é suportada no Windows.

@item 
`keep_alive' set to @code{True} keeps connections active by enabling the
periodic transmission of messages.
@end itemize


Alterado na versão 3.13: Added the `keep_alive' parameter.



@itemize *

@item 
`ssl_handshake_timeout' é (para um servidor TLS) o tempo em segundos para aguardar pelo aperto de mão TLS ser concluído, antes de abortar a conexão. @code{60.0} segundos se @code{None} (valor padrão).

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

@item 
Definir `start_serving' para @code{True} (o valor padrão) faz o servidor criado começar a aceitar conexões imediatamente. Quando definido para @code{False}, o usuário deve aguardar com @ref{b26,,Server.start_serving()} ou @ref{b27,,Server.serve_forever()} para fazer o servidor começar a aceitar conexões.
@end itemize


Alterado na versão 3.5: Adicionado suporte para SSL/TLS na @ref{609,,ProactorEventLoop}.



Alterado na versão 3.5.1: O parâmetro `host' pode ser uma sequência de strings.



Alterado na versão 3.6: Added `ssl_handshake_timeout' and `start_serving' parameters.
The socket option @ref{b8b,,socket.TCP_NODELAY} is set by default
for all TCP connections.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.



@subsubheading Ver também


A função @ref{b2c,,start_server()} é uma API alternativa de alto nível que retorna um par de @ref{1a09,,StreamReader} e @ref{17f2,,StreamWriter} que pode ser usado em um código async/await.

@end deffn

@geindex create_unix_server() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop create_unix_server}@anchor{1ae}
@deffn {Método} async 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{b25,,loop.create_server()} but works with the
@ref{193a,,AF_UNIX} socket family.

`path' é o nome de um soquete de domínio Unix, e é obrigatório, a não ser que um argumento `sock' seja fornecido. Soquetes Unix abstratos, @ref{44c,,str}, @ref{1c2,,bytes}, e caminhos @ref{229,,Path} são suportados.

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.

Veja a documentação do método @ref{b25,,loop.create_server()} para informações sobre argumentos para este método.

@ref{1ed8,,Disponibilidade}: Unix.


Alterado na versão 3.7: Adicionados os parâmetros `ssl_handshake_timeout' e `start_serving'. O parâmetros `path' agora pode ser um objeto da classe @ref{229,,Path}.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.



Alterado na versão 3.13: Added the `cleanup_socket' parameter.

@end deffn

@geindex connect_accepted_socket() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_accepted_socket}@anchor{7df}
@deffn {Método} async loop.connect_accepted_socket (protocol_factory, sock, *, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Envolve uma conexão já aceita em um par transporte/protocolo.

Este método pode ser usado por servidores que aceitam conexões fora do asyncio, mas que usam asyncio para manipulá-las.

Parâmetros:


@itemize *

@item 
`protocol_factory' deve ser algo chamável, retornando uma implementação de @ref{3549,,protocolo}.

@item 
`sock' é um objeto soquete pré-existente retornado a partir de @ref{dca,,socket.accept}.

@cartouche
@quotation Nota 
The `sock' argument transfers ownership of the socket to the
transport created. To close the socket, call the transport’s
@ref{354d,,close()} method.
@end quotation
@end cartouche

@item 
`ssl' pode ser definido para um @ref{294,,SSLContext} para habilitar SSL sobre as conexões aceitas.

@item 
`ssl_handshake_timeout' é (para uma conexão SSL) o tempo em segundos para aguardar pelo aperto de mão SSL ser concluído, antes de abortar a conexão. @code{60.0} segundos se @code{None} (valor padrão).

@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

Retorna um par @code{(transport, protocol)}.


Adicionado na versão 3.5.3.



Alterado na versão 3.7: Adicionado o parâmetro `ssl_handshake_timeout'.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@node Transferindo arquivos,Atualizando TLS,Criando servidores de rede,Métodos do laço de eventos
@anchor{library/asyncio-eventloop transferring-files}@anchor{3552}
@subsubsection Transferindo arquivos


@geindex sendfile() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sendfile}@anchor{3553}
@deffn {Método} async loop.sendfile (transport, file, offset=0, count=None, *, fallback=True)

Envia um `file' sobre um `transport'. Retorna o número total de bytes enviados.

O método usa @ref{b21,,os.sendfile()} de alto desempenho, se disponível.

`file' deve ser um objeto arquivo regular aberto em modo binário.

`offset' indica a partir de onde deve iniciar a leitura do arquivo. Se especificado, `count' é o número total de bytes para transmitir, ao contrário de transmitir o arquivo até que EOF seja atingido. A posição do arquivo é sempre atualizada, mesmo quando este método levanta um erro, e @ref{13f3,,file.tell()} pode ser usado para obter o número atual de bytes enviados.

`fallback' definido para @code{True} faz o asyncio manualmente ler e enviar o arquivo quando a plataforma não suporta a chamada de sistema sendfile (por exemplo Windows ou soquete SSL no Unix).

Levanta @ref{3531,,SendfileNotAvailableError} se o sistema não suporta a chamada de sistema `sendfile' e `fallback' é @code{False}.


Adicionado na versão 3.7.

@end deffn

@node Atualizando TLS,Observando descritores de arquivo,Transferindo arquivos,Métodos do laço de eventos
@anchor{library/asyncio-eventloop tls-upgrade}@anchor{3554}
@subsubsection Atualizando TLS


@geindex start_tls() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop start_tls}@anchor{b1b}
@deffn {Método} async loop.start_tls (transport, protocol, sslcontext, *, server_side=False, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

Atualiza um conexão baseada em transporte existente para 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 
instâncias de `transport' e `protocol', que métodos como @ref{b25,,create_server()} e @ref{603,,create_connection()} retornam.

@item 
`sslcontext': uma instância configurada de @ref{294,,SSLContext}.

@item 
`server_side' informe @code{True} quando uma conexão no lado do servidor estiver sendo atualizada (como a que é criada por @ref{b25,,create_server()}).

@item 
`server_hostname': define ou substitui o nome do host no qual o servidor alvo do certificado será comparado.

@item 
`ssl_handshake_timeout' é (para uma conexão TLS) o tempo em segundos para aguardar pelo encerramento do aperto de mão TLS, antes de abortar a conexão. @code{60.0} segundos se for @code{None} (valor padrão).

@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


Adicionado na versão 3.7.



Alterado na versão 3.11: Added the `ssl_shutdown_timeout' parameter.

@end deffn

@node Observando descritores de arquivo,Trabalhando com objetos soquete diretamente,Atualizando TLS,Métodos do laço de eventos
@anchor{library/asyncio-eventloop watching-file-descriptors}@anchor{3555}
@subsubsection Observando descritores de arquivo


@geindex add_reader() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop add_reader}@anchor{34d8}
@deffn {Método} loop.add_reader (fd, callback, *args)

Começa a monitorar o descritor de arquivo `fd' para disponibilidade de leitura e invoca a `callback' com os argumentos especificados assim que `fd' esteja disponível para leitura.

Any preexisting callback registered for `fd' is cancelled and replaced by
`callback'.
@end deffn

@geindex remove_reader() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_reader}@anchor{3556}
@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 asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop add_writer}@anchor{3557}
@deffn {Método} loop.add_writer (fd, callback, *args)

Começa a monitorar o descritor de arquivo `fd' para disponibilidade de escrita e invoca a `callback' com os argumentos especificados assim que `fd' esteja disponível para escrita.

Any preexisting callback registered for `fd' is cancelled and replaced by
`callback'.

Use @ref{414,,functools.partial()} @ref{3543,,para passar argumentos nomeados} para a `callback'.
@end deffn

@geindex remove_writer() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_writer}@anchor{3558}
@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

Veja também a seção de @ref{3559,,Suporte a Plataformas} para algumas limitações desses métodos.

@node Trabalhando com objetos soquete diretamente,DNS,Observando descritores de arquivo,Métodos do laço de eventos
@anchor{library/asyncio-eventloop working-with-socket-objects-directly}@anchor{355a}
@subsubsection Trabalhando com objetos soquete diretamente


Em geral, implementações de protocolo que usam APIs baseadas em transporte, tais como @ref{603,,loop.create_connection()} e @ref{b25,,loop.create_server()} são mais rápidas que implementações que trabalham com soquetes diretamente. Entretanto, existem alguns casos de uso quando o desempenho não é crítica, e trabalhar com objetos @ref{dc9,,socket} diretamente é mais conveniente.

@geindex sock_recv() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recv}@anchor{c2b}
@deffn {Método} async loop.sock_recv (sock, nbytes)

Recebe até `nbytes' do `sock'. Versão assíncrona de @ref{dcc,,socket.recv()}.

Retorna os dados recebidos como um objeto de bytes.

`sock' deve ser um soquete não bloqueante.


Alterado na versão 3.7: Apesar deste método sempre ter sido documentado como um método de corrotina, versões anteriores ao Python 3.7 retornavam um @ref{be6,,Future}. Desde o Python 3.7 este é um método @code{async def}.

@end deffn

@geindex sock_recv_into() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recv_into}@anchor{b1c}
@deffn {Método} async loop.sock_recv_into (sock, buf)

Dados recebidos do `sock' no buffer `buf'. Modelado baseado no método bloqueante @ref{1362,,socket.recv_into()}.

Retorna o número de bytes escritos no buffer.

`sock' deve ser um soquete não bloqueante.


Adicionado na versão 3.7.

@end deffn

@geindex sock_recvfrom() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom}@anchor{606}
@deffn {Método} async loop.sock_recvfrom (sock, bufsize)

Receive a datagram of up to `bufsize' from `sock'.  Asynchronous version of
@ref{dcd,,socket.recvfrom()}.

Return a tuple of (received data, remote address).

`sock' deve ser um soquete não bloqueante.


Adicionado na versão 3.11.

@end deffn

@geindex sock_recvfrom_into() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom_into}@anchor{607}
@deffn {Método} async loop.sock_recvfrom_into (sock, buf, nbytes=0)

Receive a datagram of up to `nbytes' from `sock' into `buf'.
Asynchronous version of
@ref{1363,,socket.recvfrom_into()}.

Return a tuple of (number of bytes received, remote address).

`sock' deve ser um soquete não bloqueante.


Adicionado na versão 3.11.

@end deffn

@geindex sock_sendall() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendall}@anchor{c2c}
@deffn {Método} async loop.sock_sendall (sock, data)

Envia `data' para o soquete `sock'. Versão assíncrona de @ref{dd0,,socket.sendall()}.

Este método continua a enviar para o soquete até que todos os dados em `data' tenham sido enviados ou um erro ocorra. @code{None} é retornado em caso de sucesso. Ao ocorrer um erro, uma exceção é levantada. Adicionalmente, não existe nenhuma forma de determinar quantos dados, se algum, foram processados com sucesso pelo destinatário na conexão.

`sock' deve ser um soquete não bloqueante.


Alterado na versão 3.7: Apesar deste método sempre ter sido documentado como um método de corrotina, antes do Python 3.7 ele retornava um @ref{be6,,Future}. Desde o Python 3.7, este é um método @code{async def}.

@end deffn

@geindex sock_sendto() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendto}@anchor{605}
@deffn {Método} async loop.sock_sendto (sock, data, address)

Send a datagram from `sock' to `address'.
Asynchronous version of
@ref{dd1,,socket.sendto()}.

Return the number of bytes sent.

`sock' deve ser um soquete não bloqueante.


Adicionado na versão 3.11.

@end deffn

@geindex sock_connect() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_connect}@anchor{df2}
@deffn {Método} async loop.sock_connect (sock, address)

Conecta o `sock' em um endereço `address' remoto.

Versão assíncrona de @ref{dcb,,socket.connect()}.

`sock' deve ser um soquete não bloqueante.


Alterado na versão 3.5.2: @code{address} não precisa mais ser resolvido. @code{sock_connect} irá tentar verificar se `address' já está resolvido chamando @ref{969,,socket.inet_pton()}. Se não estiver, @ref{c2e,,loop.getaddrinfo()} será usado para resolver `address'.



@subsubheading Ver também


@ref{603,,loop.create_connection()} e  @ref{b2b,,asyncio.open_connection()}.

@end deffn

@geindex sock_accept() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_accept}@anchor{c2d}
@deffn {Método} async loop.sock_accept (sock)

Aceita uma conexão. Modelado baseado no método bloqueante @ref{dca,,socket.accept()}.

O soquete deve estar vinculado a um endereço e escutando por conexões. O valor de retorno é um par @code{(conn, address)} onde `conn' é um `novo' objeto de soquete usável para enviar e receber dados na conexão, e `address' é o endereço vinculado ao soquete no outro extremo da conexão.

`sock' deve ser um soquete não bloqueante.


Alterado na versão 3.7: Apesar deste método sempre ter sido documentado como um método de corrotina, antes do Python 3.7 ele retornava um @ref{be6,,Future}. Desde o Python 3.7, este é um método @code{async def}.



@subsubheading Ver também


@ref{b25,,loop.create_server()} e @ref{b2c,,start_server()}.

@end deffn

@geindex sock_sendfile() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop sock_sendfile}@anchor{b20}
@deffn {Método} async loop.sock_sendfile (sock, file, offset=0, count=None, *, fallback=True)

Envia um arquivo usando @ref{b21,,os.sendfile} de alto desempenho se possível. Retorna o número total de bytes enviados.

Versão assíncrona de @ref{e8c,,socket.sendfile()}.

`sock' deve ser um @ref{dc9,,socket} @ref{1337,,socket.SOCK_STREAM} não bloqueante.

`file' deve ser um objeto arquivo regular aberto em modo binário.

`offset' indica a partir de onde deve iniciar a leitura do arquivo. Se especificado, `count' é o número total de bytes para transmitir, ao contrário de transmitir o arquivo até que EOF seja atingido. A posição do arquivo é sempre atualizada, mesmo quando este método levanta um erro, e @ref{13f3,,file.tell()} pode ser usado para obter o número atual de bytes enviados.

`fallback', quando definido para @code{True}, faz asyncio ler e enviar manualmente o arquivo, quando a plataforma não suporta a chamada de sistema sendfile (por exemplo Windows ou soquete SSL no Unix).

Levanta @ref{3531,,SendfileNotAvailableError} se o sistema não suporta chamadas de sistema `sendfile' e `fallback' é @code{False}.

`sock' deve ser um soquete não bloqueante.


Adicionado na versão 3.7.

@end deffn

@node DNS,Trabalhando com encadeamentos,Trabalhando com objetos soquete diretamente,Métodos do laço de eventos
@anchor{library/asyncio-eventloop dns}@anchor{355b}
@subsubsection DNS


@geindex getaddrinfo() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop getaddrinfo}@anchor{c2e}
@deffn {Método} async loop.getaddrinfo (host, port, *, family=0, type=0, proto=0, flags=0)

Versão assíncrona de @ref{184b,,socket.getaddrinfo()}.
@end deffn

@geindex getnameinfo() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop getnameinfo}@anchor{c2f}
@deffn {Método} async loop.getnameinfo (sockaddr, flags=0)

Versão assíncrona de @ref{17b6,,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


Alterado na versão 3.7: Ambos os métodos `getaddrinfo' e `getnameinfo' sempre foram documentados para retornar uma corrotina, mas antes do Python 3.7 eles estavam, na verdade, retornando objetos @ref{be6,,asyncio.Future}. A partir do Python 3.7, ambos os métodos são corrotinas.


@node Trabalhando com encadeamentos,Sinais Unix,DNS,Métodos do laço de eventos
@anchor{library/asyncio-eventloop working-with-pipes}@anchor{355c}
@subsubsection Trabalhando com encadeamentos


@geindex connect_read_pipe() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_read_pipe}@anchor{3504}
@deffn {Método} async loop.connect_read_pipe (protocol_factory, pipe)

Registra o extremo da leitura de um `pipe' no laço de eventos.

`protocol_factory' deve ser um chamável que retorne uma implementação do @ref{3549,,protocolo asyncio}.

`pipe' é um @ref{1203,,objeto arquivo ou similar}.

Retorna um par @code{(transport, protocol)}, onde `transport' suporta a interface @ref{355d,,ReadTransport} e `protocol' é um objeto instanciado pelo `protocol_factory'.

Com o @ref{608,,SelectorEventLoop} do laço de eventos, o `pipe' é definido para modo não bloqueante.
@end deffn

@geindex connect_write_pipe() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop connect_write_pipe}@anchor{3505}
@deffn {Método} async loop.connect_write_pipe (protocol_factory, pipe)

Registra o extremo de escrita do `pipe' no laço de eventos.

`protocol_factory' deve ser um chamável que retorne uma implementação do @ref{3549,,protocolo asyncio}.

`pipe' é um @ref{1203,,objeto arquivo ou similar}.

Retorna um part @code{(transport, protocol)}, onde `transport' suporta a interface @ref{355e,,WriteTransport} e `protocol' é um objeto instanciado pelo `protocol_factory'.

Com o @ref{608,,SelectorEventLoop} do laço de eventos, o `pipe' é definido para modo não bloqueante.
@end deffn

@cartouche
@quotation Nota 
@ref{608,,SelectorEventLoop} não suporta os métodos acima no Windows. Use @ref{609,,ProactorEventLoop} ao invés para Windows.
@end quotation
@end cartouche


@subsubheading Ver também


Os métodos @ref{3501,,loop.subprocess_exec()} e @ref{3502,,loop.subprocess_shell()}.


@node Sinais Unix,Executando código em conjuntos de threads ou processos,Trabalhando com encadeamentos,Métodos do laço de eventos
@anchor{library/asyncio-eventloop unix-signals}@anchor{355f}
@subsubsection Sinais Unix


@geindex add_signal_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop loop-add-signal-handler}@anchor{347d}@anchor{library/asyncio-eventloop asyncio loop add_signal_handler}@anchor{3560}
@deffn {Método} loop.add_signal_handler (signum, callback, *args)

Define `callback' como o tratador para o sinal `signum'.

A função de retorno será invocada pelo `loop', juntamente com outras funções de retorno enfileiradas e corrotinas executáveis daquele laço de eventos. Ao contrário de tratadores de sinal registrados usando @ref{1173,,signal.signal()}, uma função de retorno registrada com esta função tem autorização para interagir com o laço de eventos.

Levanta @ref{202,,ValueError} se o número do sinal é inválido ou impossível de capturar. Levanta @ref{195,,RuntimeError} se existe um problema definindo o tratador.

Use @ref{414,,functools.partial()} @ref{3543,,para passar argumentos nomeados} para a `callback'.

Assim como @ref{1173,,signal.signal()}, esta função deve ser invocada na thread principal.
@end deffn

@geindex remove_signal_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop remove_signal_handler}@anchor{3561}
@deffn {Método} loop.remove_signal_handler (sig)

Remove o tratador para o sinal `sig'.

Retorna @code{True} se o tratador de sinal foi removido, ou @code{False} se nenhum tratador foi definido para o sinal fornecido.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn


@subsubheading Ver também


O módulo @ref{c6,,signal}.


@node Executando código em conjuntos de threads ou processos,Tratando erros da API,Sinais Unix,Métodos do laço de eventos
@anchor{library/asyncio-eventloop executing-code-in-thread-or-process-pools}@anchor{3562}
@subsubsection Executando código em conjuntos de threads ou processos


@geindex run_in_executor() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop run_in_executor}@anchor{8ef}
@deffn {Método} awaitable loop.run_in_executor (executor, func, *args)

Providencia para a `func' ser chamada no executor especificado.

The `executor' argument should be an @ref{33c5,,concurrent.futures.Executor}
instance. The default executor is used if `executor' is @code{None}.
The default executor can be set by @ref{743,,loop.set_default_executor()},
otherwise, a @ref{742,,concurrent.futures.ThreadPoolExecutor} will be
lazy-initialized and used by @ref{8ef,,run_in_executor()} if needed.

Exemplo:

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

if __name__ == '__main__':
    asyncio.run(main())
@end example

Note that the entry point guard (@code{if __name__ == '__main__'})
is required for option 3 due to the peculiarities of @ref{94,,multiprocessing},
which is used by @ref{8f4,,ProcessPoolExecutor}.
See @ref{33ae,,Safe importing of main module}.

Este método retorna um objeto @ref{be6,,asyncio.Future}.

Use @ref{414,,functools.partial()} @ref{3543,,para passar argumentos nomeados} para `func'.


Alterado na versão 3.5.3: @ref{8ef,,loop.run_in_executor()} não configura mais o atributo @code{max_workers} do executor do conjunto de thread que ele cria, ao invés disso ele deixa para o executor do conjunto de thread (@ref{742,,ThreadPoolExecutor}) para setar o valor padrão.

@end deffn

@geindex set_default_executor() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_default_executor}@anchor{743}
@deffn {Método} loop.set_default_executor (executor)

Set `executor' as the default executor used by @ref{8ef,,run_in_executor()}.
`executor' must be an instance of
@ref{742,,ThreadPoolExecutor}.


Alterado na versão 3.11: `executor' must be an instance of
@ref{742,,ThreadPoolExecutor}.

@end deffn

@node Tratando erros da API,Habilitando o modo de debug,Executando código em conjuntos de threads ou processos,Métodos do laço de eventos
@anchor{library/asyncio-eventloop error-handling-api}@anchor{3563}
@subsubsection Tratando erros da API


Permite customizar como exceções são tratadas no laço de eventos.

@geindex set_exception_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_exception_handler}@anchor{3564}
@deffn {Método} loop.set_exception_handler (handler)

Define `handler' como o novo tratador de exceções do laço de eventos.

Se `handler' for @code{None}, o tratador de exceções padrão será definido. Caso contrário, `handler' deve ser um chamável com a assinatura combinando @code{(loop, context)}, onde @code{loop} é a referência para o laço de eventos ativo, e @code{context} é um objeto @code{dict} contendo os detalhes da exceção (veja a documentação @ref{3565,,call_exception_handler()} para detalhes a respeito do contexto).

If the handler is called on behalf of a @ref{1be,,Task} or
@ref{1c1d,,Handle}, it is run in the
@ref{15b7,,contextvars.Context} of that task or callback handle.


Alterado na versão 3.12: The handler may be called in the @ref{15b7,,Context}
of the task or handle where the exception originated.

@end deffn

@geindex get_exception_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_exception_handler}@anchor{c96}
@deffn {Método} loop.get_exception_handler ()

Retorna o tratador de exceção atual, ou @code{None} se nenhum tratador de exceção customizado foi definido.


Adicionado na versão 3.5.2.

@end deffn

@geindex default_exception_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop default_exception_handler}@anchor{3566}
@deffn {Método} loop.default_exception_handler (context)

Tratador de exceção padrão.

Isso é chamado quando uma exceção ocorre e nenhum tratador de exceção foi definido. Isso pode ser chamado por um tratador de exceção customizado que quer passar adiante para o comportamento do tratador padrão.

parâmetro `context' tem o mesmo significado que em @ref{3565,,call_exception_handler()}.
@end deffn

@geindex call_exception_handler() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop call_exception_handler}@anchor{3565}
@deffn {Método} loop.call_exception_handler (context)

Chama o tratador de exceção do laço de eventos atual.

`context' é um objeto @code{dict} contendo as seguintes chaves (novas chaves podem ser introduzidas em versões futuras do Python):


@itemize *

@item 
‘message’: Mensagem de erro;

@item 
‘exception’ (opcional): Objeto Exception;

@item 
‘future’ (opcional): instância de @ref{be6,,asyncio.Future};

@item 
‘task’ (opcional): instância de @ref{1be,,asyncio.Task};

@item 
‘handle’ (opcional): instância de @ref{1c1d,,asyncio.Handle};

@item 
‘protocol’ (opcional): instância de @ref{3549,,Protocol};

@item 
‘transport’ (opcional): instância de @ref{354a,,Transport};

@item 
‘socket’ (opcional): instância de @ref{dc9,,socket.socket};

@item 
‘source_traceback’ (optional): Traceback of the source;

@item 
‘handle_traceback’ (optional): Traceback of the handle;

@item 

@table @asis

@item ‘asyncgen’ (opcional): Gerador assíncrono que causou

a exceção.
@end table
@end itemize

@cartouche
@quotation Nota 
This method should not be overloaded in subclassed
event loops.  For custom exception handling, use
the @ref{3564,,set_exception_handler()} method.
@end quotation
@end cartouche
@end deffn

@node Habilitando o modo de debug,Executando subprocessos,Tratando erros da API,Métodos do laço de eventos
@anchor{library/asyncio-eventloop enabling-debug-mode}@anchor{3567}
@subsubsection Habilitando o modo de debug


@geindex get_debug() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop get_debug}@anchor{deb}
@deffn {Método} loop.get_debug ()

Obtém o modo de debug (@ref{468,,bool}) do laço de eventos.

O valor padrão é @code{True} se a variável de ambiente 
@geindex PYTHONASYNCIODEBUG
@geindex variável de ambiente; PYTHONASYNCIODEBUG
@ref{1ed2,,PYTHONASYNCIODEBUG} estiver definida para uma string não vazia, @code{False} caso contrário.
@end deffn

@geindex set_debug() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop set_debug}@anchor{dea}
@deffn {Método} loop.set_debug (enabled: bool)

Define o modo de debug do laço de eventos.


Alterado na versão 3.7: O novo @ref{1f8,,Modo de Desenvolvimento do Python} agora também pode ser usado para habilitar o modo de debug.

@end deffn

@geindex slow_callback_duration (atributo asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop slow_callback_duration}@anchor{3568}
@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 também


O @ref{1ed3,,modo de debug de asyncio}.


@node Executando subprocessos,,Habilitando o modo de debug,Métodos do laço de eventos
@anchor{library/asyncio-eventloop running-subprocesses}@anchor{3569}
@subsubsection Executando subprocessos


Métodos descritos nestas sub-seções são de baixo nível. Em código async/await regular, considere usar as funções convenientes de alto nível @ref{a82,,asyncio.create_subprocess_shell()} e @ref{a81,,asyncio.create_subprocess_exec()} ao invés.

@cartouche
@quotation Nota 
No Windows, o laço de eventos padrão @ref{609,,ProactorEventLoop} oferece suporte pra subprocessos, enquanto @ref{608,,SelectorEventLoop}, não. Veja @ref{3503,,Suporte para subprocessos no Windows} para detalhes.
@end quotation
@end cartouche

@geindex subprocess_exec() (método asyncio.loop)
@anchor{library/asyncio-eventloop loop-subprocess-exec}@anchor{347c}@anchor{library/asyncio-eventloop asyncio loop subprocess_exec}@anchor{3501}
@deffn {Método} async loop.subprocess_exec (protocol_factory, *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

Cria um subprocesso a partir de um ou mais argumentos de string especificados por `args'.

`args' deve ser uma lista de strings representada por:


@itemize *

@item 
@ref{44c,,str};

@item 
ou @ref{1c2,,bytes}, encodados na @ref{2970,,codificação do sistema de arquivos}.
@end itemize

A primeira string especifica o programa executável, e as strings remanescentes especificam os argumentos. Juntas, argumentos em string formam o @code{argv} do programa.

Isto é similar a classe @ref{199,,subprocess.Popen} da biblioteca padrão ser chamada com @code{shell=False} e a lista de strings ser passada como o primeiro argumento; entretanto, onde @ref{199,,Popen} recebe apenas um argumento no qual é uma lista de strings, `subprocess_exec' recebe múltiplos argumentos string.

O `protocol_factory' deve ser um chamável que retorne uma subclasse da classe @ref{356a,,asyncio.SubprocessProtocol}.

Outros parâmetros:


@itemize *

@item 
`stdin' pode ser qualquer um destes:


@itemize *

@item 
a file-like object

@item 
an existing file descriptor (a positive integer), for example those created with @ref{18ef,,os.pipe()}

@item 
a constante @ref{b9f,,subprocess.PIPE} (padrão), a qual criará um novo encadeamento e conectar a ele,

@item 
o valor @code{None}, o qual fará o subprocesso herdar o descritor de arquivo deste processo

@item 
a constante @ref{118d,,subprocess.DEVNULL}, a qual indica que o arquivo especial @ref{1bab,,os.devnull} será usado
@end itemize

@item 
`stdout' pode ser qualquer um destes:


@itemize *

@item 
a file-like object

@item 
a constante @ref{b9f,,subprocess.PIPE} (padrão), a qual criará um novo encadeamento e conectar a ele,

@item 
o valor @code{None}, o qual fará o subprocesso herdar o descritor de arquivo deste processo

@item 
a constante @ref{118d,,subprocess.DEVNULL}, a qual indica que o arquivo especial @ref{1bab,,os.devnull} será usado
@end itemize

@item 
`stderr' pode ser qualquer um destes:


@itemize *

@item 
a file-like object

@item 
a constante @ref{b9f,,subprocess.PIPE} (padrão), a qual criará um novo encadeamento e conectar a ele,

@item 
o valor @code{None}, o qual fará o subprocesso herdar o descritor de arquivo deste processo

@item 
a constante @ref{118d,,subprocess.DEVNULL}, a qual indica que o arquivo especial @ref{1bab,,os.devnull} será usado

@item 
a constante @ref{33e5,,subprocess.STDOUT}, a qual irá conectar o stream de erro padrão ao stream de saída padrão do processo
@end itemize

@item 
Todos os outros argumentos nomeados são passados para @ref{199,,subprocess.Popen} sem interpretação, exceto `bufsize', `universal_newlines', `shell', `text', `encoding' e `errors', os quais não devem ser especificados de forma alguma.

A API de subprocesso @code{asyncio} não suporta decodificar os streams como texto. @ref{8dc,,bytes.decode()} pode ser usado para converter os bytes retornados do stream para texto.
@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{3505,,connect_write_pipe()} or @ref{3504,,connect_read_pipe()} for use
with the event loop.

Veja o construtor da classe @ref{199,,subprocess.Popen} para documentação sobre outros argumentos.

Retorna um par @code{(transport, protocol)}, onde `transport' conforma com a classe base @ref{356b,,asyncio.SubprocessTransport} e `protocol' é um objeto instanciado pelo `protocol_factory'.

If the transport is closed or is garbage collected, the child process
is killed if it is still running.
@end deffn

@geindex subprocess_shell() (método asyncio.loop)
@anchor{library/asyncio-eventloop asyncio loop subprocess_shell}@anchor{3502}
@deffn {Método} async loop.subprocess_shell (protocol_factory, cmd, *, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

Cria um subprocesso a partir do `cmd', o qual pode ser um @ref{44c,,str} ou uma string de @ref{1c2,,bytes} codificada na @ref{2970,,codificação do sistema de arquivos}, usando a sintaxe “shell” da plataforma.

Isto é similar a classe @ref{199,,subprocess.Popen} da biblioteca padrão sendo chamada com @code{shell=True}.

O argumento `protocol_factory' deve ser um chamável que retorna uma subclasse da classe @ref{356a,,SubprocessProtocol}.

Veja @ref{3501,,subprocess_exec()} para mais detalhes sobre os argumentos remanescentes.

Retorna um par @code{(transport, protocol)}, onde `transport' conforma com a classe base @ref{356b,,SubprocessTransport} e `protocol' é um objeto instanciado pelo `protocol_factory'.

If the transport is closed or is garbage collected, the child process
is killed if it is still running.
@end deffn

@cartouche
@quotation Nota 
É responsabilidade da aplicação garantir que todos os espaços em branco e caracteres especiais sejam tratados apropriadamente para evitar vulnerabilidades de injeção shell@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection} . A função @ref{27d,,shlex.quote()} pode ser usada para escapar espaços em branco e caracteres especiais apropriadamente em strings que serão usadas para construir comandos shell.
@end quotation
@end cartouche

@node Tratadores de função de retorno,Objetos Server,Métodos do laço de eventos,Laço de eventos
@anchor{library/asyncio-eventloop callback-handles}@anchor{3539}
@subsubsection Tratadores de função de retorno


@geindex Handle (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio Handle}@anchor{1c1d}
@deffn {Classe} asyncio.Handle

Um objeto invólucro de função de retorno retornado por @ref{b17,,loop.call_soon()}, @ref{b18,,loop.call_soon_threadsafe()}.

@geindex get_context() (método asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle get_context}@anchor{356c}
@deffn {Método} get_context ()

Return the @ref{15b7,,contextvars.Context} object
associated with the handle.


Adicionado na versão 3.12.

@end deffn

@geindex cancel() (método asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle cancel}@anchor{356d}
@deffn {Método} cancel ()

Cancela a função de retorno. Se a função de retorno já tiver sido cancelada ou executada, este método não tem efeito.
@end deffn

@geindex cancelled() (método asyncio.Handle)
@anchor{library/asyncio-eventloop asyncio Handle cancelled}@anchor{b2d}
@deffn {Método} cancelled ()

Retorna @code{True} se a função de retorno foi cancelada.


Adicionado na versão 3.7.

@end deffn
@end deffn

@geindex TimerHandle (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio TimerHandle}@anchor{1865}
@deffn {Classe} asyncio.TimerHandle

Um objeto invólucro de função de retorno retornado por @ref{b29,,loop.call_later()}, e @ref{b19,,loop.call_at()}.

Esta classe é uma subclasse de @ref{1c1d,,Handle}.

@geindex when() (método asyncio.TimerHandle)
@anchor{library/asyncio-eventloop asyncio TimerHandle when}@anchor{b2a}
@deffn {Método} when ()

Retorna o tempo de uma função de retorno agendada como @ref{2f7,,float} segundos.

O tempo é um timestamp absoluto, usando a mesma referência de tempo que @ref{3546,,loop.time()}.


Adicionado na versão 3.7.

@end deffn
@end deffn

@node Objetos Server,Implementações do laço de eventos,Tratadores de função de retorno,Laço de eventos
@anchor{library/asyncio-eventloop server-objects}@anchor{353a}
@subsubsection Objetos Server


Objetos Server são criados pelas funções @ref{b25,,loop.create_server()}, @ref{1ae,,loop.create_unix_server()}, @ref{b2c,,start_server()}, e @ref{34be,,start_unix_server()}.

Do not instantiate the @ref{b24,,Server} class directly.

@geindex Server (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio Server}@anchor{b24}
@deffn {Classe} asyncio.Server

Objetos `Server' são gerenciadores de contexto assíncronos. Quando usados em uma instrução @code{async with}, é garantido que o objeto Server está fechado e não está aceitando novas conexões quando a instrução @code{async with} estiver completa:

@example
srv = await loop.create_server(...)

async with srv:
    # algum código

# Neste ponto, srv é fechado e não mais aceita novas conexões.
@end example


Alterado na versão 3.7: Objeto Server é um gerenciador de contexto assíncrono desde o Python 3.7.



Alterado na versão 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 asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server close}@anchor{34bb}
@deffn {Método} close ()

Para de servir: fecha soquetes que estavam ouvindo e define o atributo @ref{c30,,sockets} para @code{None}.

Os soquetes que representam conexões de clientes existentes que estão chegando são deixados em aberto.

The server is closed asynchronously; use the @ref{17bc,,wait_closed()}
coroutine to wait until the server is closed (and no more
connections are active).
@end deffn

@geindex close_clients() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server close_clients}@anchor{1b2}
@deffn {Método} close_clients ()

Close all existing incoming client connections.

Calls @ref{354d,,close()} on all associated
transports.

@ref{34bb,,close()} should be called before @ref{1b2,,close_clients()} when
closing the server to avoid races with new clients connecting.


Adicionado na versão 3.13.

@end deffn

@geindex abort_clients() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server abort_clients}@anchor{1b3}
@deffn {Método} abort_clients ()

Close all existing incoming client connections immediately,
without waiting for pending operations to complete.

Calls @ref{356e,,abort()} on all associated
transports.

@ref{34bb,,close()} should be called before @ref{1b3,,abort_clients()} when
closing the server to avoid races with new clients connecting.


Adicionado na versão 3.13.

@end deffn

@geindex get_loop() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server get_loop}@anchor{b23}
@deffn {Método} get_loop ()

Retorna o laço de eventos associado com o objeto server.


Adicionado na versão 3.7.

@end deffn

@geindex start_serving() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server start_serving}@anchor{b26}
@deffn {Método} async start_serving ()

Começa a aceitar conexões.

This method is idempotent, so it can be called when
the server is already serving.

O parâmetro somente-nomeado `start_serving' para @ref{b25,,loop.create_server()} e @ref{b2c,,asyncio.start_server()} permite criar um objeto Server que não está aceitando conexões inicialmente. Neste caso @code{Server.start_serving()}, ou @ref{b27,,Server.serve_forever()} podem ser usados para fazer o Server começar a aceitar conexões.


Adicionado na versão 3.7.

@end deffn

@geindex serve_forever() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server serve_forever}@anchor{b27}
@deffn {Método} async serve_forever ()

Começa a aceitar conexões até que a corrotina seja cancelada. Cancelamento da task @code{serve_forever} causa o fechamento do servidor.

Este método pode ser chamado se o servidor já estiver aceitando conexões. Apenas uma task @code{serve_forever} pode existir para cada objeto `Server'.

Exemplo:

@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


Adicionado na versão 3.7.

@end deffn

@geindex is_serving() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server is_serving}@anchor{b28}
@deffn {Método} is_serving ()

Retorna @code{True} se o servidor estiver aceitando novas conexões.


Adicionado na versão 3.7.

@end deffn

@geindex wait_closed() (método asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server wait_closed}@anchor{17bc}
@deffn {Método} async wait_closed ()

Wait until the @ref{34bb,,close()} method completes and all active
connections have finished.
@end deffn

@geindex sockets (atributo asyncio.Server)
@anchor{library/asyncio-eventloop asyncio Server sockets}@anchor{c30}
@deffn {Atributo} sockets

List of socket-like objects, @code{asyncio.trsock.TransportSocket}, which
the server is listening on.


Alterado na versão 3.7: Antes do Python 3.7 @code{Server.sockets} era usado para retornar uma lista interna de soquetes do server diretamente. No uma cópia dessa lista é retornada.

@end deffn
@end deffn
@anchor{library/asyncio-eventloop asyncio-event-loops}@anchor{356f}
@node Implementações do laço de eventos,Exemplos<18>,Objetos Server,Laço de eventos
@anchor{library/asyncio-eventloop asyncio-event-loop-implementations}@anchor{3570}@anchor{library/asyncio-eventloop event-loop-implementations}@anchor{353b}
@subsubsection Implementações do laço de eventos


asyncio vem com duas implementações de laço de eventos diferente: @ref{608,,SelectorEventLoop} e @ref{609,,ProactorEventLoop}.

By default asyncio is configured to use @ref{17e9,,EventLoop}.

@geindex SelectorEventLoop (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio SelectorEventLoop}@anchor{608}
@deffn {Classe} asyncio.SelectorEventLoop

A subclass of @ref{966,,AbstractEventLoop} based on the
@ref{c2,,selectors} module.

Usa o `seletor' mais eficiente disponível para a plataforma fornecida. Também é possível configurar manualmente a implementação exata do seletor a ser utilizada:

@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{1ed8,,Disponibilidade}: Unix, Windows.
@end deffn

@geindex ProactorEventLoop (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio ProactorEventLoop}@anchor{609}
@deffn {Classe} asyncio.ProactorEventLoop

A subclass of @ref{966,,AbstractEventLoop} for Windows that uses “I/O Completion Ports” (IOCP).

@ref{1ed8,,Disponibilidade}: Windows.


@subsubheading Ver também


MSDN documentation on I/O Completion Ports@footnote{https://learn.microsoft.com/windows/win32/fileio/i-o-completion-ports}.

@end deffn

@geindex EventLoop (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio EventLoop}@anchor{17e9}
@deffn {Classe} asyncio.EventLoop

@quotation

An alias to the most efficient available subclass of @ref{966,,AbstractEventLoop} for the given
platform.

It is an alias to @ref{608,,SelectorEventLoop} on Unix and @ref{609,,ProactorEventLoop} on Windows.
@end quotation


Adicionado na versão 3.13.

@end deffn

@geindex AbstractEventLoop (classe em asyncio)
@anchor{library/asyncio-eventloop asyncio AbstractEventLoop}@anchor{966}
@deffn {Classe} asyncio.AbstractEventLoop

Classe base abstrata para laços de eventos compatíveis com asyncio.

The @ref{353d,,Métodos do laço de eventos} section lists all
methods that an alternative implementation of @code{AbstractEventLoop}
should have defined.
@end deffn

@node Exemplos<18>,,Implementações do laço de eventos,Laço de eventos
@anchor{library/asyncio-eventloop examples}@anchor{353c}
@subsubsection Exemplos


Perceba que todos os exemplos nesta seção `propositalmente' mostram como usar as APIs de baixo nível do laço de eventos, tais como @ref{353f,,loop.run_forever()} e @ref{b17,,loop.call_soon()}. Aplicações asyncio modernas raramente precisam ser escritas desta forma; considere usar as funções de alto nível como @ref{47c,,asyncio.run()}.

@menu
* Hello World com call_soon(): Hello World com call_soon. 
* Exibe a data atual com call_later(): Exibe a data atual com call_later. 
* Observa um descritor de arquivo por eventos de leitura:: 
* Define tratadores de sinais para SIGINT e SIGTERM:: 

@end menu

@node Hello World com call_soon,Exibe a data atual com call_later,,Exemplos<18>
@anchor{library/asyncio-eventloop asyncio-example-lowlevel-helloworld}@anchor{3571}@anchor{library/asyncio-eventloop hello-world-with-call-soon}@anchor{3572}
@subsubsection Hello World com call_soon()


Um exemplo usando o método @ref{b17,,loop.call_soon()} para agendar uma função de retorno. A função de retorno exibe @code{"Hello World"} e então para o laço 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 também


Um exemplo similar a @ref{3476,,Hello World} criado com uma corrotina e a função @ref{47c,,run()}.


@node Exibe a data atual com call_later,Observa um descritor de arquivo por eventos de leitura,Hello World com call_soon,Exemplos<18>
@anchor{library/asyncio-eventloop asyncio-example-call-later}@anchor{3573}@anchor{library/asyncio-eventloop display-the-current-date-with-call-later}@anchor{3574}
@subsubsection Exibe a data atual com call_later()


Um exemplo de uma função de retorno mostrando a data atual a cada segundo. A função de retorno usa o método @ref{b29,,loop.call_later()} para reagendar a si mesma depois de 5 segundos, e então para o laço 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 também


Um exemplo similar a @ref{3495,,data atual} criado com uma corrotina e a função @ref{47c,,run()}.


@node Observa um descritor de arquivo por eventos de leitura,Define tratadores de sinais para SIGINT e SIGTERM,Exibe a data atual com call_later,Exemplos<18>
@anchor{library/asyncio-eventloop asyncio-example-watch-fd}@anchor{34d7}@anchor{library/asyncio-eventloop watch-a-file-descriptor-for-read-events}@anchor{3575}
@subsubsection Observa um descritor de arquivo por eventos de leitura


Aguarda até que um descritor de arquivo tenha recebido alguns dados usando o método @ref{34d8,,loop.add_reader()} e então fecha o laço 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 também



@itemize *

@item 
Um @ref{34d6,,exemplo} similar usando transportes, protocolos, e o método @ref{603,,loop.create_connection()}.

@item 
Outro @ref{34d4,,exemplo} similar usando a função de alto nível @ref{b2b,,asyncio.open_connection()} e streams.
@end itemize


@node Define tratadores de sinais para SIGINT e SIGTERM,,Observa um descritor de arquivo por eventos de leitura,Exemplos<18>
@anchor{library/asyncio-eventloop asyncio-example-unix-signals}@anchor{3576}@anchor{library/asyncio-eventloop set-signal-handlers-for-sigint-and-sigterm}@anchor{3577}
@subsubsection Define tratadores de sinais para SIGINT e SIGTERM


(Este exemplo de @code{signals} apenas funciona no Unix.)

Register handlers for signals @ref{847,,SIGINT} and @ref{1426,,SIGTERM}
using the @ref{3560,,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 Futuros,Transports e Protocols,Laço de eventos,asyncio — E/S assíncrona
@anchor{library/asyncio-future doc}@anchor{33c6}@anchor{library/asyncio-future asyncio-futures}@anchor{347f}@anchor{library/asyncio-future futures}@anchor{3578}@anchor{library/asyncio-future translation-repo}@anchor{3579}
@subsubsection Futuros


`Código-fonte:' Lib/asyncio/futures.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/futures.py}, Lib/asyncio/base_futures.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/base_futures.py}


__________________________________________________________________


Objetos `Future' são usados para fazer a ponte entre `código baseado em funções de retorno (callback) de baixo nível' e  código async/await de alto nível.

@menu
* Funções Future:: 
* Objeto Future:: 

@end menu

@node Funções Future,Objeto Future,,Futuros
@anchor{library/asyncio-future future-functions}@anchor{357a}
@subsubsection Funções Future


@geindex isfuture() (no módulo asyncio)
@anchor{library/asyncio-future asyncio isfuture}@anchor{357b}
@deffn {Função} asyncio.isfuture (obj)

Return @code{True} if `obj' is either of:


@itemize *

@item 
an instance of @ref{be6,,asyncio.Future},

@item 
an instance of @ref{1be,,asyncio.Task},

@item 
a Future-like object with a @code{_asyncio_future_blocking}
attribute.
@end itemize


Adicionado na versão 3.5.

@end deffn

@geindex ensure_future() (no módulo asyncio)
@anchor{library/asyncio-future asyncio ensure_future}@anchor{c92}
@deffn {Função} asyncio.ensure_future (obj, *, loop=None)

Retorna:


@itemize *

@item 
`obj' argument as is, if `obj' is a @ref{be6,,Future},
a @ref{1be,,Task}, or a Future-like object (@ref{357b,,isfuture()}
is used for the test.)

@item 
a @ref{1be,,Task} object wrapping `obj', if `obj' is a
coroutine (@ref{47e,,iscoroutine()} is used for the test);
in this case the coroutine will be scheduled by
@code{ensure_future()}.

@item 
a @ref{1be,,Task} object that would await on `obj', if `obj' is an
awaitable (@ref{e43,,inspect.isawaitable()} is used for the test.)
@end itemize

If `obj' is neither of the above a @ref{2c3,,TypeError} is raised.

@cartouche
@quotation Importante 
See also the @ref{1bf,,create_task()} function which is the
preferred way for creating new Tasks.

Save a reference to the result of this function, to avoid
a task disappearing mid-execution.
@end quotation
@end cartouche


Alterado na versão 3.5.1: The function accepts any @ref{1ad,,awaitable} object.



Descontinuado desde a versão 3.10: Deprecation warning is emitted if `obj' is not a Future-like object
and `loop' is not specified and there is no running event loop.

@end deffn

@geindex wrap_future() (no módulo asyncio)
@anchor{library/asyncio-future asyncio wrap_future}@anchor{1a08}
@deffn {Função} asyncio.wrap_future (future, *, loop=None)

Wrap a @ref{11f1,,concurrent.futures.Future} object in a
@ref{be6,,asyncio.Future} object.


Descontinuado desde a versão 3.10: Deprecation warning is emitted if `future' is not a Future-like object
and `loop' is not specified and there is no running event loop.

@end deffn

@node Objeto Future,,Funções Future,Futuros
@anchor{library/asyncio-future asyncio-future-obj}@anchor{357c}@anchor{library/asyncio-future future-object}@anchor{357d}
@subsubsection Objeto Future


@geindex Future (classe em asyncio)
@anchor{library/asyncio-future asyncio Future}@anchor{be6}
@deffn {Classe} asyncio.Future (*, loop=None)

Um Future representa um resultado eventual de uma operação assíncrona.  Não é seguro para thread.

Future é um objeto @ref{1ad,,aguardável}. Corrotinas podem aguardar o objeto Future até que ele tenha um resultado ou um conjunto de exceções, ou até que seja cancelado. Um Future pode ser aguardado várias vezes e o resultado é sempre o mesmo.

Normalmente, objetos Future são usados para permitir que o código baseado em funções de retorno de baixo nível (por exemplo, em protocolos implementados usando @ref{347e,,transportes} asyncio) interopere com o código async/await de alto nível.

A regra geral é nunca expor o objeto Future em API voltada para o usuário, e a maneira recomendada de criar um objeto Future objeto chamar @ref{c95,,loop.create_future()}.  Dessa forma, as implementações de laços de eventos alternativos podem injetar suas próprias versões otimizadas de um objeto Future.


Alterado na versão 3.7: Adicionado suporte ao módulo @ref{24,,contextvars}.



Descontinuado desde a versão 3.10: Aviso de descontinuidade é emitido se `loop' não for especificado e não existir nenhum laço de eventos em execução.


@geindex result() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future result}@anchor{357e}
@deffn {Método} result ()

Return the result of the Future.

If the Future is `done' and has a result set by the
@ref{34ab,,set_result()} method, the result value is returned.

If the Future is `done' and has an exception set by the
@ref{c99,,set_exception()} method, this method raises the exception.

Se o futuro foi `cancelled', este método levanta uma exceção @ref{1b8,,CancelledError}.

If the Future’s result isn’t yet available, this method raises
an @ref{34ae,,InvalidStateError} exception.
@end deffn

@geindex set_result() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future set_result}@anchor{34ab}
@deffn {Método} set_result (result)

Mark the Future as `done' and set its result.

Raises an @ref{34ae,,InvalidStateError} error if the Future is
already `done'.
@end deffn

@geindex set_exception() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future set_exception}@anchor{c99}
@deffn {Método} set_exception (exception)

Mark the Future as `done' and set an exception.

Raises an @ref{34ae,,InvalidStateError} error if the Future is
already `done'.
@end deffn

@geindex done() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future done}@anchor{357f}
@deffn {Método} done ()

Return @code{True} if the Future is `done'.

A Future is `done' if it was `cancelled' or if it has a result
or an exception set with @ref{34ab,,set_result()} or
@ref{c99,,set_exception()} calls.
@end deffn

@geindex cancelled() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future cancelled}@anchor{3580}
@deffn {Método} cancelled ()

Return @code{True} if the Future was `cancelled'.

The method is usually used to check if a Future is not
`cancelled' before setting a result or an exception for it:

@example
if not fut.cancelled():
    fut.set_result(42)
@end example
@end deffn

@geindex add_done_callback() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future add_done_callback}@anchor{b1a}
@deffn {Método} add_done_callback (callback, *, context=None)

Add a callback to be run when the Future is `done'.

The `callback' is called with the Future object as its only
argument.

If the Future is already `done' when this method is called,
the callback is scheduled with @ref{b17,,loop.call_soon()}.

Um argumento opcional somente-nomeado `context' permite especificar um @ref{15b7,,contextvars.Context} customizado para executar na `função de retorno'. O contexto atual é usado quando nenhum `context' é fornecido.

@ref{414,,functools.partial()} can be used to pass parameters
to the callback, e.g.:

@example
# Call 'print("Future:", fut)' when "fut" is done.
fut.add_done_callback(
    functools.partial(print, "Future:"))
@end example


Alterado na versão 3.7: O parâmetro somente-nomeado `context' foi adicionado. Veja 
@geindex Propostas de Melhorias do Python; PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} para mais detalhes.

@end deffn

@geindex remove_done_callback() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future remove_done_callback}@anchor{168b}
@deffn {Método} remove_done_callback (callback)

Remove `callback' da lista de funções de retorno.

Returns the number of callbacks removed, which is typically 1,
unless a callback was added more than once.
@end deffn

@geindex cancel() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future cancel}@anchor{1934}
@deffn {Método} cancel (msg=None)

Cancel the Future and schedule callbacks.

If the Future is already `done' or `cancelled', return @code{False}.
Otherwise, change the Future’s state to `cancelled',
schedule the callbacks, and return @code{True}.


Alterado na versão 3.9: Adicionado o  parâmetro `msg'.

@end deffn

@geindex exception() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future exception}@anchor{3581}
@deffn {Método} exception ()

Return the exception that was set on this Future.

The exception (or @code{None} if no exception was set) is
returned only if the Future is `done'.

Se o futuro foi `cancelled', este método levanta uma exceção @ref{1b8,,CancelledError}.

If the Future isn’t `done' yet, this method raises an
@ref{34ae,,InvalidStateError} exception.
@end deffn

@geindex get_loop() (método asyncio.Future)
@anchor{library/asyncio-future asyncio Future get_loop}@anchor{b22}
@deffn {Método} get_loop ()

Return the event loop the Future object is bound to.


Adicionado na versão 3.7.

@end deffn
@end deffn
@anchor{library/asyncio-future asyncio-example-future}@anchor{3582}
This example creates a Future object, creates and schedules an
asynchronous Task to set result for the Future, and waits until
the Future has a result:

@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 
The Future object was designed to mimic
@ref{11f1,,concurrent.futures.Future}.  Key differences include:


@itemize -

@item 
unlike asyncio Futures, @ref{11f1,,concurrent.futures.Future}
instances cannot be awaited.

@item 
@ref{357e,,asyncio.Future.result()} and @ref{3581,,asyncio.Future.exception()}
do not accept the `timeout' argument.

@item 
@ref{357e,,asyncio.Future.result()} and @ref{3581,,asyncio.Future.exception()}
raise an @ref{34ae,,InvalidStateError} exception when the Future is not
`done'.

@item 
Callbacks registered with @ref{b1a,,asyncio.Future.add_done_callback()}
are not called immediately.  They are scheduled with
@ref{b17,,loop.call_soon()} instead.

@item 
asyncio Future is not compatible with the
@ref{198e,,concurrent.futures.wait()} and
@ref{173e,,concurrent.futures.as_completed()} functions.

@item 
@ref{1934,,asyncio.Future.cancel()} accepts an optional @code{msg} argument,
but @ref{33cf,,concurrent.futures.Future.cancel()} does not.
@end itemize
@end quotation
@end cartouche

@node Transports e Protocols,Políticas,Futuros,asyncio — E/S assíncrona
@anchor{library/asyncio-protocol doc}@anchor{3583}@anchor{library/asyncio-protocol asyncio-transports-protocols}@anchor{347e}@anchor{library/asyncio-protocol translation-repo}@anchor{3584}@anchor{library/asyncio-protocol transports-and-protocols}@anchor{3585}
@subsubsection Transports e Protocols


@subsubheading Prefácio


Transports and Protocols are used by the `low-level' event loop
APIs such as @ref{603,,loop.create_connection()}.  They use
callback-based programming style and enable high-performance
implementations of network or IPC protocols (e.g. HTTP).

Essentially, transports and protocols should only be used in
libraries and frameworks and never in high-level asyncio
applications.

This documentation page covers both @ref{3586,,Transports} and @ref{3587,,Protocols}.

@subsubheading Introdução


At the highest level, the transport is concerned with `how' bytes
are transmitted, while the protocol determines `which' bytes to
transmit (and to some extent when).

A different way of saying the same thing: a transport is an
abstraction for a socket (or similar I/O endpoint) while a protocol
is an abstraction for an application, from the transport’s point
of view.

Yet another view is the transport and protocol interfaces
together define an abstract interface for using network I/O and
interprocess I/O.

There is always a 1:1 relationship between transport and protocol
objects: the protocol calls transport methods to send data,
while the transport calls protocol methods to pass it data that
has been received.

Most of connection oriented event loop methods
(such as @ref{603,,loop.create_connection()}) usually accept a
`protocol_factory' argument used to create a `Protocol' object
for an accepted connection, represented by a `Transport' object.
Such methods usually return a tuple of @code{(transport, protocol)}.

@subsubheading Conteúdo


Esta página de documentação contém as seguintes seções:


@itemize *

@item 
The @ref{3586,,Transports} section documents asyncio @ref{3588,,BaseTransport},
@ref{355d,,ReadTransport}, @ref{355e,,WriteTransport}, @ref{3589,,Transport},
@ref{18af,,DatagramTransport}, and @ref{356b,,SubprocessTransport}
classes.

@item 
The @ref{3587,,Protocols} section documents asyncio @ref{358a,,BaseProtocol},
@ref{358b,,Protocol}, @ref{aac,,BufferedProtocol},
@ref{6cf,,DatagramProtocol}, and @ref{356a,,SubprocessProtocol} classes.

@item 
The @ref{358c,,Examples} section showcases how to work with transports,
protocols, and low-level event loop APIs.
@end itemize

@menu
* Transportes:: 
* Protocolos:: 
* Exemplos: Exemplos<19>. 

@end menu

@node Transportes,Protocolos,,Transports e Protocols
@anchor{library/asyncio-protocol asyncio-transport}@anchor{354a}@anchor{library/asyncio-protocol transports}@anchor{3586}
@subsubsection Transportes


`Source code:' Lib/asyncio/transports.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/transports.py}


__________________________________________________________________


Transports are classes provided by @ref{a,,asyncio} in order to abstract
various kinds of communication channels.

Transport objects are always instantiated by an
@ref{d9e,,asyncio event loop}.

asyncio implements transports for TCP, UDP, SSL, and subprocess pipes.
The methods available on a transport depend on the transport’s kind.

The transport classes are @ref{34a6,,not thread safe}.

@menu
* Transports Hierarchy:: 
* Base Transport:: 
* Read-only Transports:: 
* Write-only Transports:: 
* Transportes de datagrama:: 
* Transportes de Subprocesso:: 

@end menu

@node Transports Hierarchy,Base Transport,,Transportes
@anchor{library/asyncio-protocol transports-hierarchy}@anchor{358d}
@subsubsection Transports Hierarchy


@geindex BaseTransport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio BaseTransport}@anchor{3588}
@deffn {Classe} asyncio.BaseTransport

Base class for all transports.  Contains methods that all
asyncio transports share.
@end deffn

@geindex WriteTransport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio WriteTransport}@anchor{355e}
@deffn {Classe} asyncio.WriteTransport (BaseTransport)

A base transport for write-only connections.

Instances of the `WriteTransport' class are returned from
the @ref{3505,,loop.connect_write_pipe()} event loop method and
are also used by subprocess-related methods like
@ref{3501,,loop.subprocess_exec()}.
@end deffn

@geindex ReadTransport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio ReadTransport}@anchor{355d}
@deffn {Classe} asyncio.ReadTransport (BaseTransport)

A base transport for read-only connections.

Instances of the `ReadTransport' class are returned from
the @ref{3504,,loop.connect_read_pipe()} event loop method and
are also used by subprocess-related methods like
@ref{3501,,loop.subprocess_exec()}.
@end deffn

@geindex Transport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio Transport}@anchor{3589}
@deffn {Classe} asyncio.Transport (WriteTransport, ReadTransport)

Interface representing a bidirectional transport, such as a
TCP connection.

The user does not instantiate a transport directly; they call a
utility function, passing it a protocol factory and other
information necessary to create the transport and protocol.

Instances of the `Transport' class are returned from or used by
event loop methods like @ref{603,,loop.create_connection()},
@ref{34bd,,loop.create_unix_connection()},
@ref{b25,,loop.create_server()}, @ref{3553,,loop.sendfile()}, etc.
@end deffn

@geindex DatagramTransport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio DatagramTransport}@anchor{18af}
@deffn {Classe} asyncio.DatagramTransport (BaseTransport)

A transport for datagram (UDP) connections.

Instances of the `DatagramTransport' class are returned from
the @ref{733,,loop.create_datagram_endpoint()} event loop method.
@end deffn

@geindex SubprocessTransport (classe em asyncio)
@anchor{library/asyncio-protocol asyncio SubprocessTransport}@anchor{356b}
@deffn {Classe} asyncio.SubprocessTransport (BaseTransport)

An abstraction to represent a connection between a parent and its
child OS process.

Instances of the `SubprocessTransport' class are returned from
event loop methods @ref{3502,,loop.subprocess_shell()} and
@ref{3501,,loop.subprocess_exec()}.
@end deffn

@node Base Transport,Read-only Transports,Transports Hierarchy,Transportes
@anchor{library/asyncio-protocol base-transport}@anchor{358e}
@subsubsection Base Transport


@geindex close() (método asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport close}@anchor{354d}
@deffn {Método} BaseTransport.close ()

Fecha o transporte.

If the transport has a buffer for outgoing
data, buffered data will be flushed asynchronously.  No more data
will be received.  After all buffered data is flushed, the
protocol’s @ref{358f,,protocol.connection_lost()} method will be called with
@ref{675,,None} as its argument. The transport should not be
used once it is closed.
@end deffn

@geindex is_closing() (método asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport is_closing}@anchor{c94}
@deffn {Método} BaseTransport.is_closing ()

Retorna @code{True} se o transporte estiver fechando ou estiver fechado.
@end deffn

@geindex get_extra_info() (método asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport get_extra_info}@anchor{aab}
@deffn {Método} BaseTransport.get_extra_info (name, default=None)

Return information about the transport or underlying resources
it uses.

`name' is a string representing the piece of transport-specific
information to get.

`default' is the value to return if the information is not
available, or if the transport does not support querying it
with the given third-party event loop implementation or on the
current platform.

For example, the following code attempts to get the underlying
socket object of the transport:

@example
sock = transport.get_extra_info('socket')
if sock is not None:
    print(sock.getsockopt(...))
@end example

Categories of information that can be queried on some transports:


@itemize *

@item 
socket:


@itemize -

@item 
@code{'peername'}: the remote address to which the socket is
connected, result of @ref{3590,,socket.socket.getpeername()}
(@code{None} on error)

@item 
@code{'socket'}: @ref{dc9,,socket.socket} instance

@item 
@code{'sockname'}: the socket’s own address,
result of @ref{3591,,socket.socket.getsockname()}
@end itemize

@item 
SSL socket:


@itemize -

@item 
@code{'compression'}: the compression algorithm being used as a
string, or @code{None} if the connection isn’t compressed; result
of @ref{1184,,ssl.SSLSocket.compression()}

@item 
@code{'cipher'}: a three-value tuple containing the name of the
cipher being used, the version of the SSL protocol that defines
its use, and the number of secret bits being used; result of
@ref{3592,,ssl.SSLSocket.cipher()}

@item 
@code{'peercert'}: peer certificate; result of
@ref{fec,,ssl.SSLSocket.getpeercert()}

@item 
@code{'sslcontext'}: @ref{294,,ssl.SSLContext} instance

@item 
@code{'ssl_object'}: @ref{b99,,ssl.SSLObject} or
@ref{8f0,,ssl.SSLSocket} instance
@end itemize

@item 
pipe:


@itemize -

@item 
@code{'pipe'}: pipe object
@end itemize

@item 
subprocess:


@itemize -

@item 
@code{'subprocess'}: @ref{199,,subprocess.Popen} instance
@end itemize
@end itemize
@end deffn

@geindex set_protocol() (método asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport set_protocol}@anchor{3593}
@deffn {Método} BaseTransport.set_protocol (protocol)

Define um novo protocolo.

Switching protocol should only be done when both
protocols are documented to support the switch.
@end deffn

@geindex get_protocol() (método asyncio.BaseTransport)
@anchor{library/asyncio-protocol asyncio BaseTransport get_protocol}@anchor{3594}
@deffn {Método} BaseTransport.get_protocol ()

Retorna o protocolo atual.
@end deffn

@node Read-only Transports,Write-only Transports,Base Transport,Transportes
@anchor{library/asyncio-protocol read-only-transports}@anchor{3595}
@subsubsection Read-only Transports


@geindex is_reading() (método asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport is_reading}@anchor{b2e}
@deffn {Método} ReadTransport.is_reading ()

Return @code{True} if the transport is receiving new data.


Adicionado na versão 3.7.

@end deffn

@geindex pause_reading() (método asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport pause_reading}@anchor{b30}
@deffn {Método} ReadTransport.pause_reading ()

Pause the receiving end of the transport.  No data will be passed to
the protocol’s @ref{188a,,protocol.data_received()}
method until @ref{b2f,,resume_reading()} is called.


Alterado na versão 3.7: The method is idempotent, i.e. it can be called when the
transport is already paused or closed.

@end deffn

@geindex resume_reading() (método asyncio.ReadTransport)
@anchor{library/asyncio-protocol asyncio ReadTransport resume_reading}@anchor{b2f}
@deffn {Método} ReadTransport.resume_reading ()

Resume the receiving end.  The protocol’s
@ref{188a,,protocol.data_received()} method
will be called once again if some data is available for reading.


Alterado na versão 3.7: The method is idempotent, i.e. it can be called when the
transport is already reading.

@end deffn

@node Write-only Transports,Transportes de datagrama,Read-only Transports,Transportes
@anchor{library/asyncio-protocol write-only-transports}@anchor{3596}
@subsubsection Write-only Transports


@geindex abort() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport abort}@anchor{356e}
@deffn {Método} WriteTransport.abort ()

Close the transport immediately, without waiting for pending operations
to complete.  Buffered data will be lost.  No more data will be received.
The protocol’s @ref{358f,,protocol.connection_lost()} method will eventually be
called with @ref{675,,None} as its argument.
@end deffn

@geindex can_write_eof() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport can_write_eof}@anchor{3597}
@deffn {Método} WriteTransport.can_write_eof ()

Return @ref{c27,,True} if the transport supports
@ref{3598,,write_eof()}, @ref{b49,,False} if not.
@end deffn

@geindex get_write_buffer_size() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_size}@anchor{3599}
@deffn {Método} WriteTransport.get_write_buffer_size ()

Return the current size of the output buffer used by the transport.
@end deffn

@geindex get_write_buffer_limits() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_limits}@anchor{ded}
@deffn {Método} WriteTransport.get_write_buffer_limits ()

Get the `high' and `low' watermarks for write flow control. Return a
tuple @code{(low, high)} where `low' and `high' are positive number of
bytes.

Use @ref{359a,,set_write_buffer_limits()} to set the limits.


Adicionado na versão 3.4.2.

@end deffn

@geindex set_write_buffer_limits() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport set_write_buffer_limits}@anchor{359a}
@deffn {Método} WriteTransport.set_write_buffer_limits (high=None, low=None)

Set the `high' and `low' watermarks for write flow control.

These two values (measured in number of
bytes) control when the protocol’s
@ref{359b,,protocol.pause_writing()}
and @ref{359c,,protocol.resume_writing()}
methods are called. If specified, the low watermark must be less
than or equal to the high watermark.  Neither `high' nor `low'
can be negative.

@ref{359b,,pause_writing()} is called when the buffer size
becomes greater than or equal to the `high' value. If writing has
been paused, @ref{359c,,resume_writing()} is called when
the buffer size becomes less than or equal to the `low' value.

The defaults are implementation-specific.  If only the
high watermark is given, the low watermark defaults to an
implementation-specific value less than or equal to the
high watermark.  Setting `high' to zero forces `low' to zero as
well, and causes @ref{359b,,pause_writing()} to be called
whenever the buffer becomes non-empty.  Setting `low' to zero causes
@ref{359c,,resume_writing()} to be called only once the
buffer is empty. Use of zero for either limit is generally
sub-optimal as it reduces opportunities for doing I/O and
computation concurrently.

Use @ref{ded,,get_write_buffer_limits()}
to get the limits.
@end deffn

@geindex write() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport write}@anchor{15dd}
@deffn {Método} WriteTransport.write (data)

Write some `data' bytes to the transport.

This method does not block; it buffers the data and arranges for it
to be sent out asynchronously.
@end deffn

@geindex writelines() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport writelines}@anchor{15dc}
@deffn {Método} WriteTransport.writelines (list_of_data)

Write a list (or any iterable) of data bytes to the transport.
This is functionally equivalent to calling @ref{15dd,,write()} on each
element yielded by the iterable, but may be implemented more
efficiently.
@end deffn

@geindex write_eof() (método asyncio.WriteTransport)
@anchor{library/asyncio-protocol asyncio WriteTransport write_eof}@anchor{3598}
@deffn {Método} WriteTransport.write_eof ()

Close the write end of the transport after flushing all buffered data.
Data may still be received.

This method can raise @ref{228,,NotImplementedError} if the transport
(e.g. SSL) doesn’t support half-closed connections.
@end deffn

@node Transportes de datagrama,Transportes de Subprocesso,Write-only Transports,Transportes
@anchor{library/asyncio-protocol datagram-transports}@anchor{359d}
@subsubsection Transportes de datagrama


@geindex sendto() (método asyncio.DatagramTransport)
@anchor{library/asyncio-protocol asyncio DatagramTransport sendto}@anchor{1af}
@deffn {Método} DatagramTransport.sendto (data, addr=None)

Send the `data' bytes to the remote peer given by `addr' (a
transport-dependent target address).  If `addr' is @ref{675,,None},
the data is sent to the target address given on transport
creation.

This method does not block; it buffers the data and arranges
for it to be sent out asynchronously.


Alterado na versão 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 asyncio.DatagramTransport)
@anchor{library/asyncio-protocol asyncio DatagramTransport abort}@anchor{359e}
@deffn {Método} DatagramTransport.abort ()

Close the transport immediately, without waiting for pending
operations to complete.  Buffered data will be lost.
No more data will be received.  The protocol’s
@ref{358f,,protocol.connection_lost()}
method will eventually be called with @ref{675,,None} as its argument.
@end deffn

@node Transportes de Subprocesso,,Transportes de datagrama,Transportes
@anchor{library/asyncio-protocol asyncio-subprocess-transports}@anchor{3506}@anchor{library/asyncio-protocol subprocess-transports}@anchor{359f}
@subsubsection Transportes de Subprocesso


@geindex get_pid() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pid}@anchor{35a0}
@deffn {Método} SubprocessTransport.get_pid ()

Return the subprocess process id as an integer.
@end deffn

@geindex get_pipe_transport() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pipe_transport}@anchor{35a1}
@deffn {Método} SubprocessTransport.get_pipe_transport (fd)

Return the transport for the communication pipe corresponding to the
integer file descriptor `fd':


@itemize *

@item 
@code{0}: writable streaming transport of the standard input (`stdin'),
or @ref{675,,None} if the subprocess was not created with @code{stdin=PIPE}

@item 
@code{1}: readable streaming transport of the standard output (`stdout'),
or @ref{675,,None} if the subprocess was not created with @code{stdout=PIPE}

@item 
@code{2}: readable streaming transport of the standard error (`stderr'),
or @ref{675,,None} if the subprocess was not created with @code{stderr=PIPE}

@item 
other `fd': @ref{675,,None}
@end itemize
@end deffn

@geindex get_returncode() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_returncode}@anchor{35a2}
@deffn {Método} SubprocessTransport.get_returncode ()

Return the subprocess return code as an integer or @ref{675,,None}
if it hasn’t returned, which is similar to the
@ref{a9c,,subprocess.Popen.returncode} attribute.
@end deffn

@geindex kill() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport kill}@anchor{35a3}
@deffn {Método} SubprocessTransport.kill ()

Mata o subprocesso.

On POSIX systems, the function sends SIGKILL to the subprocess.
On Windows, this method is an alias for @ref{35a4,,terminate()}.

See also @ref{1424,,subprocess.Popen.kill()}.
@end deffn

@geindex send_signal() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport send_signal}@anchor{35a5}
@deffn {Método} SubprocessTransport.send_signal (signal)

Send the `signal' number to the subprocess, as in
@ref{1425,,subprocess.Popen.send_signal()}.
@end deffn

@geindex terminate() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport terminate}@anchor{35a4}
@deffn {Método} SubprocessTransport.terminate ()

Interrompe o  subprocesso.

On POSIX systems, this method sends @ref{1426,,SIGTERM} to the subprocess.
On Windows, the Windows API function @code{TerminateProcess()} is called to
stop the subprocess.

See also @ref{1423,,subprocess.Popen.terminate()}.
@end deffn

@geindex close() (método asyncio.SubprocessTransport)
@anchor{library/asyncio-protocol asyncio SubprocessTransport close}@anchor{35a6}
@deffn {Método} SubprocessTransport.close ()

Kill the subprocess by calling the @ref{35a3,,kill()} method.

If the subprocess hasn’t returned yet, and close transports of
`stdin', `stdout', and `stderr' pipes.
@end deffn

@node Protocolos,Exemplos<19>,Transportes,Transports e Protocols
@anchor{library/asyncio-protocol asyncio-protocol}@anchor{3549}@anchor{library/asyncio-protocol protocols}@anchor{3587}
@subsubsection Protocolos


`Source code:' Lib/asyncio/protocols.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/protocols.py}


__________________________________________________________________


asyncio provides a set of abstract base classes that should be used
to implement network protocols.  Those classes are meant to be used
together with @ref{354a,,transports}.

Subclasses of abstract base protocol classes may implement some or
all methods.  All these methods are callbacks: they are called by
transports on certain events, for example when some data is received.
A base protocol method should be called by the corresponding transport.

@menu
* Protocolos de Base:: 
* Base Protocol:: 
* Streaming Protocols:: 
* Protocolos de Streaming Bufferizados:: 
* Protocolos de Datagramas:: 
* Protocolos de Subprocesso:: 

@end menu

@node Protocolos de Base,Base Protocol,,Protocolos
@anchor{library/asyncio-protocol base-protocols}@anchor{35a7}
@subsubsection Protocolos de Base


@geindex BaseProtocol (classe em asyncio)
@anchor{library/asyncio-protocol asyncio BaseProtocol}@anchor{358a}
@deffn {Classe} asyncio.BaseProtocol

Base protocol with methods that all protocols share.
@end deffn

@geindex Protocol (classe em asyncio)
@anchor{library/asyncio-protocol asyncio Protocol}@anchor{358b}
@deffn {Classe} asyncio.Protocol (BaseProtocol)

The base class for implementing streaming protocols
(TCP, Unix sockets, etc).
@end deffn

@geindex BufferedProtocol (classe em asyncio)
@anchor{library/asyncio-protocol asyncio BufferedProtocol}@anchor{aac}
@deffn {Classe} asyncio.BufferedProtocol (BaseProtocol)

A base class for implementing streaming protocols with manual
control of the receive buffer.
@end deffn

@geindex DatagramProtocol (classe em asyncio)
@anchor{library/asyncio-protocol asyncio DatagramProtocol}@anchor{6cf}
@deffn {Classe} asyncio.DatagramProtocol (BaseProtocol)

The base class for implementing datagram (UDP) protocols.
@end deffn

@geindex SubprocessProtocol (classe em asyncio)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol}@anchor{356a}
@deffn {Classe} asyncio.SubprocessProtocol (BaseProtocol)

The base class for implementing protocols communicating with child
processes (unidirectional pipes).
@end deffn

@node Base Protocol,Streaming Protocols,Protocolos de Base,Protocolos
@anchor{library/asyncio-protocol base-protocol}@anchor{35a8}
@subsubsection Base Protocol


All asyncio protocols can implement Base Protocol callbacks.

@subsubheading Connection Callbacks


Connection callbacks are called on all protocols, exactly once per
a successful connection.  All other protocol callbacks can only be
called between those two methods.

@geindex connection_made() (método asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_made}@anchor{354b}
@deffn {Método} BaseProtocol.connection_made (transport)

Chamado quando uma conexão é estabelecida.

The `transport' argument is the transport representing the
connection.  The protocol is responsible for storing the reference
to its transport.
@end deffn

@geindex connection_lost() (método asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_lost}@anchor{358f}
@deffn {Método} BaseProtocol.connection_lost (exc)

Chamado quanto a conexão é perdida ou fechada.

The argument is either an exception object or @ref{675,,None}.
The latter means a regular EOF is received, or the connection was
aborted or closed by this side of the connection.
@end deffn

@subsubheading Flow Control Callbacks


Flow control callbacks can be called by transports to pause or
resume writing performed by the protocol.

See the documentation of the @ref{359a,,set_write_buffer_limits()}
method for more details.

@geindex pause_writing() (método asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol pause_writing}@anchor{359b}
@deffn {Método} BaseProtocol.pause_writing ()

Called when the transport’s buffer goes over the high watermark.
@end deffn

@geindex resume_writing() (método asyncio.BaseProtocol)
@anchor{library/asyncio-protocol asyncio BaseProtocol resume_writing}@anchor{359c}
@deffn {Método} BaseProtocol.resume_writing ()

Called when the transport’s buffer drains below the low watermark.
@end deffn

If the buffer size equals the high watermark,
@ref{359b,,pause_writing()} is not called: the buffer size must
go strictly over.

Conversely, @ref{359c,,resume_writing()} is called when the
buffer size is equal or lower than the low watermark.  These end
conditions are important to ensure that things go as expected when
either mark is zero.

@node Streaming Protocols,Protocolos de Streaming Bufferizados,Base Protocol,Protocolos
@anchor{library/asyncio-protocol streaming-protocols}@anchor{35a9}
@subsubsection Streaming Protocols


Event methods, such as @ref{b25,,loop.create_server()},
@ref{1ae,,loop.create_unix_server()}, @ref{603,,loop.create_connection()},
@ref{34bd,,loop.create_unix_connection()}, @ref{7df,,loop.connect_accepted_socket()},
@ref{3504,,loop.connect_read_pipe()}, and @ref{3505,,loop.connect_write_pipe()}
accept factories that return streaming protocols.

@geindex data_received() (método asyncio.Protocol)
@anchor{library/asyncio-protocol asyncio Protocol data_received}@anchor{188a}
@deffn {Método} Protocol.data_received (data)

Called when some data is received.  `data' is a non-empty bytes
object containing the incoming data.

Whether the data is buffered, chunked or reassembled depends on
the transport.  In general, you shouldn’t rely on specific semantics
and instead make your parsing generic and flexible. However,
data is always received in the correct order.

The method can be called an arbitrary number of times while
a connection is open.

However, @ref{35aa,,protocol.eof_received()}
is called at most once.  Once @code{eof_received()} is called,
@code{data_received()} is not called anymore.
@end deffn

@geindex eof_received() (método asyncio.Protocol)
@anchor{library/asyncio-protocol asyncio Protocol eof_received}@anchor{35aa}
@deffn {Método} Protocol.eof_received ()

Called when the other end signals it won’t send any more data
(for example by calling @ref{3598,,transport.write_eof()}, if the other end also uses
asyncio).

This method may return a false value (including @code{None}), in which case
the transport will close itself.  Conversely, if this method returns a
true value, the protocol used determines whether to close the transport.
Since the default implementation returns @code{None}, it implicitly closes the
connection.

Some transports, including SSL, don’t support half-closed connections,
in which case returning true from this method will result in the connection
being closed.
@end deffn

State machine:

@example
start -> connection_made
    [-> data_received]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node Protocolos de Streaming Bufferizados,Protocolos de Datagramas,Streaming Protocols,Protocolos
@anchor{library/asyncio-protocol buffered-streaming-protocols}@anchor{35ab}
@subsubsection Protocolos de Streaming Bufferizados



Adicionado na versão 3.7.


Buffered Protocols can be used with any event loop method
that supports @ref{35a9,,Streaming Protocols}.

@code{BufferedProtocol} implementations allow explicit manual allocation
and control of the receive buffer.  Event loops can then use the buffer
provided by the protocol to avoid unnecessary data copies.  This
can result in noticeable performance improvement for protocols that
receive big amounts of data.  Sophisticated protocol implementations
can significantly reduce the number of buffer allocations.

The following callbacks are called on @ref{aac,,BufferedProtocol}
instances:

@geindex get_buffer() (método asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol get_buffer}@anchor{35ac}
@deffn {Método} BufferedProtocol.get_buffer (sizehint)

Chamada para alocar um novo buffer para recebimento.

`sizehint' is the recommended minimum size for the returned
buffer.  It is acceptable to return smaller or larger buffers
than what `sizehint' suggests.  When set to -1, the buffer size
can be arbitrary. It is an error to return a buffer with a zero size.

@code{get_buffer()} must return an object implementing the
@ref{2e8,,buffer protocol}.
@end deffn

@geindex buffer_updated() (método asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol buffer_updated}@anchor{35ad}
@deffn {Método} BufferedProtocol.buffer_updated (nbytes)

Chamado quando o buffer foi atualizado com os dados recebidos.

`nbytes' is the total number of bytes that were written to the buffer.
@end deffn

@geindex eof_received() (método asyncio.BufferedProtocol)
@anchor{library/asyncio-protocol asyncio BufferedProtocol eof_received}@anchor{35ae}
@deffn {Método} BufferedProtocol.eof_received ()

See the documentation of the @ref{35aa,,protocol.eof_received()} method.
@end deffn

@ref{35ac,,get_buffer()} can be called an arbitrary number
of times during a connection.  However, @ref{35aa,,protocol.eof_received()} is called at most once
and, if called, @ref{35ac,,get_buffer()} and
@ref{35ad,,buffer_updated()} won’t be called after it.

State machine:

@example
start -> connection_made
    [-> get_buffer
        [-> buffer_updated]?
    ]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node Protocolos de Datagramas,Protocolos de Subprocesso,Protocolos de Streaming Bufferizados,Protocolos
@anchor{library/asyncio-protocol datagram-protocols}@anchor{35af}
@subsubsection Protocolos de Datagramas


Datagram Protocol instances should be constructed by protocol
factories passed to the @ref{733,,loop.create_datagram_endpoint()} method.

@geindex datagram_received() (método asyncio.DatagramProtocol)
@anchor{library/asyncio-protocol asyncio DatagramProtocol datagram_received}@anchor{35b0}
@deffn {Método} DatagramProtocol.datagram_received (data, addr)

Called when a datagram is received.  `data' is a bytes object containing
the incoming data.  `addr' is the address of the peer sending the data;
the exact format depends on the transport.
@end deffn

@geindex error_received() (método asyncio.DatagramProtocol)
@anchor{library/asyncio-protocol asyncio DatagramProtocol error_received}@anchor{35b1}
@deffn {Método} DatagramProtocol.error_received (exc)

Called when a previous send or receive operation raises an
@ref{417,,OSError}.  `exc' is the @ref{417,,OSError} instance.

This method is called in rare conditions, when the transport (e.g. UDP)
detects that a datagram could not be delivered to its recipient.
In many conditions though, undeliverable datagrams will be silently
dropped.
@end deffn

@cartouche
@quotation Nota 
On BSD systems (macOS, FreeBSD, etc.) flow control is not supported
for datagram protocols, because there is no reliable way to detect send
failures caused by writing too many packets.

The socket always appears ‘ready’ and excess packets are dropped. An
@ref{417,,OSError} with @code{errno} set to @ref{18fc,,errno.ENOBUFS} may
or may not be raised; if it is raised, it will be reported to
@ref{35b1,,DatagramProtocol.error_received()} but otherwise ignored.
@end quotation
@end cartouche

@node Protocolos de Subprocesso,,Protocolos de Datagramas,Protocolos
@anchor{library/asyncio-protocol asyncio-subprocess-protocols}@anchor{3507}@anchor{library/asyncio-protocol subprocess-protocols}@anchor{35b2}
@subsubsection Protocolos de Subprocesso


Subprocess Protocol instances should be constructed by protocol
factories passed to the @ref{3501,,loop.subprocess_exec()} and
@ref{3502,,loop.subprocess_shell()} methods.

@geindex pipe_data_received() (método asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_data_received}@anchor{18d9}
@deffn {Método} SubprocessProtocol.pipe_data_received (fd, data)

Called when the child process writes data into its stdout or stderr
pipe.

`fd' is the integer file descriptor of the pipe.

`data' is a non-empty bytes object containing the received data.
@end deffn

@geindex pipe_connection_lost() (método asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_connection_lost}@anchor{35b3}
@deffn {Método} SubprocessProtocol.pipe_connection_lost (fd, exc)

Chamado quando um dos encadeamentos comunicando com o processo filho é fechado.

`fd' is the integer file descriptor that was closed.
@end deffn

@geindex process_exited() (método asyncio.SubprocessProtocol)
@anchor{library/asyncio-protocol asyncio SubprocessProtocol process_exited}@anchor{18d8}
@deffn {Método} SubprocessProtocol.process_exited ()

Chamado quando o processo filho encerrou.

It can be called before @ref{18d9,,pipe_data_received()} and
@ref{35b3,,pipe_connection_lost()} methods.
@end deffn

@node Exemplos<19>,,Protocolos,Transports e Protocols
@anchor{library/asyncio-protocol examples}@anchor{358c}
@subsubsection Exemplos


@menu
* TCP Echo Server:: 
* TCP Echo Client:: 
* UDP Echo Server:: 
* UDP Echo Client:: 
* Connecting Existing Sockets:: 
* loop.subprocess_exec() and SubprocessProtocol: loop subprocess_exec and SubprocessProtocol. 

@end menu

@node TCP Echo Server,TCP Echo Client,,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-server-protocol}@anchor{34d2}@anchor{library/asyncio-protocol tcp-echo-server}@anchor{35b4}
@subsubsection TCP Echo Server


Create a TCP echo server using the @ref{b25,,loop.create_server()} method, send back
received data, and close the connection:

@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 também


The @ref{34d0,,TCP echo server using streams}
example uses the high-level @ref{b2c,,asyncio.start_server()} function.


@node TCP Echo Client,UDP Echo Server,TCP Echo Server,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-client-protocol}@anchor{34cf}@anchor{library/asyncio-protocol tcp-echo-client}@anchor{35b5}
@subsubsection TCP Echo Client


A TCP echo client using the @ref{603,,loop.create_connection()} method, sends
data, and waits until the connection is closed:

@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 também


The @ref{34cd,,TCP echo client using streams}
example uses the high-level @ref{b2b,,asyncio.open_connection()} function.


@node UDP Echo Server,UDP Echo Client,TCP Echo Client,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-udp-echo-server-protocol}@anchor{354f}@anchor{library/asyncio-protocol udp-echo-server}@anchor{35b6}
@subsubsection UDP Echo Server


A UDP echo server, using the @ref{733,,loop.create_datagram_endpoint()}
method, sends back received data:

@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 UDP Echo Client,Connecting Existing Sockets,UDP Echo Server,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-udp-echo-client-protocol}@anchor{354e}@anchor{library/asyncio-protocol udp-echo-client}@anchor{35b7}
@subsubsection UDP Echo Client


A UDP echo client, using the @ref{733,,loop.create_datagram_endpoint()}
method, sends data and closes the transport when it receives the answer:

@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 Connecting Existing Sockets,loop subprocess_exec and SubprocessProtocol,UDP Echo Client,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-example-create-connection}@anchor{34d6}@anchor{library/asyncio-protocol connecting-existing-sockets}@anchor{35b8}
@subsubsection Connecting Existing Sockets


Wait until a socket receives data using the
@ref{603,,loop.create_connection()} method with a protocol:

@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 também


The @ref{34d7,,watch a file descriptor for read events} example uses the low-level
@ref{34d8,,loop.add_reader()} method to register an FD.

The @ref{34d4,,register an open socket to wait for data using streams} example uses high-level streams
created by the @ref{b2b,,open_connection()} function in a coroutine.


@node loop subprocess_exec and SubprocessProtocol,,Connecting Existing Sockets,Exemplos<19>
@anchor{library/asyncio-protocol asyncio-example-subprocess-proto}@anchor{3517}@anchor{library/asyncio-protocol loop-subprocess-exec-and-subprocessprotocol}@anchor{35b9}
@subsubsection loop.subprocess_exec() and SubprocessProtocol


An example of a subprocess protocol used to get the output of a
subprocess and to wait for the subprocess exit.

The subprocess is created by the @ref{3501,,loop.subprocess_exec()} method:

@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

See also the @ref{3516,,same example}
written using high-level APIs.

@node Políticas,Suporte a plataformas,Transports e Protocols,asyncio — E/S assíncrona
@anchor{library/asyncio-policy doc}@anchor{35ba}@anchor{library/asyncio-policy asyncio-policies}@anchor{3537}@anchor{library/asyncio-policy policies}@anchor{35bb}@anchor{library/asyncio-policy translation-repo}@anchor{35bc}
@subsubsection Políticas


An event loop policy is a global object
used to get and set the current @ref{d9e,,event loop},
as well as create new event loops.
The default policy can be @ref{35bd,,replaced} with
@ref{35be,,built-in alternatives}
to use different event loop implementations,
or substituted by a @ref{35bf,,custom policy}
that can override these behaviors.

The @ref{35c0,,policy object}
gets and sets a separate event loop per `context'.
This is per-thread by default,
though custom policies could define `context' differently.

Custom event loop policies can control the behavior of
@ref{2c2,,get_event_loop()}, @ref{18df,,set_event_loop()}, and @ref{3484,,new_event_loop()}.

Policy objects should implement the APIs defined
in the @ref{35c1,,AbstractEventLoopPolicy} abstract base class.

@menu
* Getting and Setting the Policy:: 
* Policy Objects:: 
* Monitores de processos:: 
* Custom Policies:: 

@end menu

@node Getting and Setting the Policy,Policy Objects,,Políticas
@anchor{library/asyncio-policy asyncio-policy-get-set}@anchor{35bd}@anchor{library/asyncio-policy getting-and-setting-the-policy}@anchor{35c2}
@subsubsection Getting and Setting the Policy


The following functions can be used to get and set the policy
for the current process:

@geindex get_event_loop_policy() (no módulo asyncio)
@anchor{library/asyncio-policy asyncio get_event_loop_policy}@anchor{35c3}
@deffn {Função} asyncio.get_event_loop_policy ()

Retorna a política de todo o processo atual.
@end deffn

@geindex set_event_loop_policy() (no módulo asyncio)
@anchor{library/asyncio-policy asyncio set_event_loop_policy}@anchor{35c4}
@deffn {Função} asyncio.set_event_loop_policy (policy)

Set the current process-wide policy to `policy'.

If `policy' is set to @code{None}, the default policy is restored.
@end deffn

@node Policy Objects,Monitores de processos,Getting and Setting the Policy,Políticas
@anchor{library/asyncio-policy asyncio-policy-objects}@anchor{35c0}@anchor{library/asyncio-policy policy-objects}@anchor{35c5}
@subsubsection Policy Objects


The abstract event loop policy base class is defined as follows:

@geindex AbstractEventLoopPolicy (classe em asyncio)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy}@anchor{35c1}
@deffn {Classe} asyncio.AbstractEventLoopPolicy

An abstract base class for asyncio policies.

@geindex get_event_loop() (método asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy get_event_loop}@anchor{35c6}
@deffn {Método} get_event_loop ()

Obtém o laço de eventos para o contexto atual.

Return an event loop object implementing the
@ref{966,,AbstractEventLoop} interface.

This method should never return @code{None}.


Alterado na versão 3.6.

@end deffn

@geindex set_event_loop() (método asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy set_event_loop}@anchor{35c7}
@deffn {Método} set_event_loop (loop)

Define o laço de eventos do contexto atual como `loop'.
@end deffn

@geindex new_event_loop() (método asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy new_event_loop}@anchor{35c8}
@deffn {Método} new_event_loop ()

Cria e retorna um novo objeto de laço de eventos.

This method should never return @code{None}.
@end deffn

@geindex get_child_watcher() (método asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy get_child_watcher}@anchor{2c1}
@deffn {Método} get_child_watcher ()

Get a child process watcher object.

Return a watcher object implementing the
@ref{2bc,,AbstractChildWatcher} interface.

This function is Unix specific.


Descontinuado desde a versão 3.12.

@end deffn

@geindex set_child_watcher() (método asyncio.AbstractEventLoopPolicy)
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy set_child_watcher}@anchor{2c0}
@deffn {Método} set_child_watcher (watcher)

Set the current child process watcher to `watcher'.

This function is Unix specific.


Descontinuado desde a versão 3.12.

@end deffn
@end deffn
@anchor{library/asyncio-policy asyncio-policy-builtin}@anchor{35be}
asyncio ships with the following built-in policies:

@geindex DefaultEventLoopPolicy (classe em asyncio)
@anchor{library/asyncio-policy asyncio DefaultEventLoopPolicy}@anchor{35c9}
@deffn {Classe} asyncio.DefaultEventLoopPolicy

The default asyncio policy.  Uses @ref{608,,SelectorEventLoop}
on Unix and @ref{609,,ProactorEventLoop} on Windows.

There is no need to install the default policy manually. asyncio
is configured to use the default policy automatically.


Alterado na versão 3.8: On Windows, @ref{609,,ProactorEventLoop} is now used by default.



Descontinuado desde a versão 3.12: The @ref{2c2,,get_event_loop()} method of the default asyncio policy now emits
a @ref{1a5,,DeprecationWarning} if there is no current event loop set and it
decides to create one.
In some future Python release this will become an error.

@end deffn

@geindex WindowsSelectorEventLoopPolicy (classe em asyncio)
@anchor{library/asyncio-policy asyncio WindowsSelectorEventLoopPolicy}@anchor{35ca}
@deffn {Classe} asyncio.WindowsSelectorEventLoopPolicy

An alternative event loop policy that uses the
@ref{608,,SelectorEventLoop} event loop implementation.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex WindowsProactorEventLoopPolicy (classe em asyncio)
@anchor{library/asyncio-policy asyncio WindowsProactorEventLoopPolicy}@anchor{35cb}
@deffn {Classe} asyncio.WindowsProactorEventLoopPolicy

An alternative event loop policy that uses the
@ref{609,,ProactorEventLoop} event loop implementation.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@node Monitores de processos,Custom Policies,Policy Objects,Políticas
@anchor{library/asyncio-policy asyncio-watchers}@anchor{3515}@anchor{library/asyncio-policy process-watchers}@anchor{35cc}
@subsubsection Monitores de processos


A process watcher allows customization of how an event loop monitors
child processes on Unix. Specifically, the event loop needs to know
when a child process has exited.

In asyncio, child processes are created with
@ref{a81,,create_subprocess_exec()} and @ref{3501,,loop.subprocess_exec()}
functions.

asyncio defines the @ref{2bc,,AbstractChildWatcher} abstract base class, which child
watchers should implement, and has four different implementations:
@ref{47b,,ThreadedChildWatcher} (configured to be used by default),
@ref{2ba,,MultiLoopChildWatcher}, @ref{2bd,,SafeChildWatcher}, and
@ref{2bb,,FastChildWatcher}.

Veja também a seção @ref{350f,,Subprocesso e Threads}.

The following two functions can be used to customize the child process watcher
implementation used by the asyncio event loop:

@geindex get_child_watcher() (no módulo asyncio)
@anchor{library/asyncio-policy asyncio get_child_watcher}@anchor{2bf}
@deffn {Função} asyncio.get_child_watcher ()

Return the current child watcher for the current policy.


Descontinuado desde a versão 3.12.

@end deffn

@geindex set_child_watcher() (no módulo asyncio)
@anchor{library/asyncio-policy asyncio set_child_watcher}@anchor{2be}
@deffn {Função} asyncio.set_child_watcher (watcher)

Set the current child watcher to `watcher' for the current
policy.  `watcher' must implement methods defined in the
@ref{2bc,,AbstractChildWatcher} base class.


Descontinuado desde a versão 3.12.

@end deffn

@cartouche
@quotation Nota 
Third-party event loops implementations might not support
custom child watchers.  For such event loops, using
@ref{2be,,set_child_watcher()} might be prohibited or have no effect.
@end quotation
@end cartouche

@geindex AbstractChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher}@anchor{2bc}
@deffn {Classe} asyncio.AbstractChildWatcher

@geindex add_child_handler() (método asyncio.AbstractChildWatcher)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher add_child_handler}@anchor{35cd}
@deffn {Método} add_child_handler (pid, callback, *args)

Register a new child handler.

Arrange for @code{callback(pid, returncode, *args)} to be called
when a process with PID equal to `pid' terminates.  Specifying
another callback for the same process replaces the previous
handler.

The `callback' callable must be thread-safe.
@end deffn

@geindex remove_child_handler() (método asyncio.AbstractChildWatcher)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher remove_child_handler}@anchor{35ce}
@deffn {Método} remove_child_handler (pid)

Remove o manipulador para processo com PID igual a `pid'.

The function returns @code{True} if the handler was successfully
removed, @code{False} if there was nothing to remove.
@end deffn

@geindex attach_loop() (método asyncio.AbstractChildWatcher)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher attach_loop}@anchor{18e0}
@deffn {Método} attach_loop (loop)

Attach the watcher to an event loop.

If the watcher was previously attached to an event loop, then
it is first detached before attaching to the new loop.

Note: loop may be @code{None}.
@end deffn

@geindex is_active() (método asyncio.AbstractChildWatcher)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher is_active}@anchor{35cf}
@deffn {Método} is_active ()

Return @code{True} if the watcher is ready to use.

Gerar um subprocesso com um monitor `inativo' para o filho atual, levanta @ref{195,,RuntimeError}.


Adicionado na versão 3.8.

@end deffn

@geindex close() (método asyncio.AbstractChildWatcher)
@anchor{library/asyncio-policy asyncio AbstractChildWatcher close}@anchor{35d0}
@deffn {Método} close ()

Close the watcher.

This method has to be called to ensure that underlying
resources are cleaned-up.
@end deffn


Descontinuado desde a versão 3.12.

@end deffn

@geindex ThreadedChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio ThreadedChildWatcher}@anchor{47b}
@deffn {Classe} asyncio.ThreadedChildWatcher

This implementation starts a new waiting thread for every subprocess spawn.

It works reliably even when the asyncio event loop is run in a non-main OS thread.

There is no noticeable overhead when handling a big number of children (`O'(1) each
time a child terminates), but starting a thread per process requires extra memory.

This watcher is used by default.


Adicionado na versão 3.8.

@end deffn

@geindex MultiLoopChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio MultiLoopChildWatcher}@anchor{2ba}
@deffn {Classe} asyncio.MultiLoopChildWatcher

This implementation registers a @code{SIGCHLD} signal handler on
instantiation. That can break third-party code that installs a custom handler for
@code{SIGCHLD} signal.

The watcher avoids disrupting other code spawning processes
by polling every process explicitly on a @code{SIGCHLD} signal.

There is no limitation for running subprocesses from different threads once the
watcher is installed.

The solution is safe but it has a significant overhead when
handling a big number of processes (`O'(`n') each time a
@code{SIGCHLD} is received).


Adicionado na versão 3.8.



Descontinuado desde a versão 3.12.

@end deffn

@geindex SafeChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio SafeChildWatcher}@anchor{2bd}
@deffn {Classe} asyncio.SafeChildWatcher

This implementation uses active event loop from the main thread to handle
@code{SIGCHLD} signal. If the main thread has no running event loop another
thread cannot spawn a subprocess (@ref{195,,RuntimeError} is raised).

The watcher avoids disrupting other code spawning processes
by polling every process explicitly on a @code{SIGCHLD} signal.

This solution is as safe as @ref{2ba,,MultiLoopChildWatcher} and has the same `O'(`n')
complexity but requires a running event loop in the main thread to work.


Descontinuado desde a versão 3.12.

@end deffn

@geindex FastChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio FastChildWatcher}@anchor{2bb}
@deffn {Classe} asyncio.FastChildWatcher

This implementation reaps every terminated processes by calling
@code{os.waitpid(-1)} directly, possibly breaking other code spawning
processes and waiting for their termination.

There is no noticeable overhead when handling a big number of
children (`O'(1) each time a child terminates).

This solution requires a running event loop in the main thread to work, as
@ref{2bd,,SafeChildWatcher}.


Descontinuado desde a versão 3.12.

@end deffn

@geindex PidfdChildWatcher (classe em asyncio)
@anchor{library/asyncio-policy asyncio PidfdChildWatcher}@anchor{479}
@deffn {Classe} asyncio.PidfdChildWatcher

This implementation polls process file descriptors (pidfds) to await child
process termination. In some respects, @ref{479,,PidfdChildWatcher} is a
“Goldilocks” child watcher implementation. It doesn’t require signals or
threads, doesn’t interfere with any processes launched outside the event
loop, and scales linearly with the number of subprocesses launched by the
event loop. The main disadvantage is that pidfds are specific to Linux, and
only work on recent (5.3+) kernels.


Adicionado na versão 3.9.

@end deffn

@node Custom Policies,,Monitores de processos,Políticas
@anchor{library/asyncio-policy asyncio-custom-policies}@anchor{35bf}@anchor{library/asyncio-policy custom-policies}@anchor{35d1}
@subsubsection Custom Policies


To implement a new event loop policy, it is recommended to subclass
@ref{35c9,,DefaultEventLoopPolicy} and override the methods for which
custom behavior is wanted, e.g.:

@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 Suporte a plataformas,Extensão,Políticas,asyncio — E/S assíncrona
@anchor{library/asyncio-platforms doc}@anchor{35d2}@anchor{library/asyncio-platforms asyncio-platform-support}@anchor{3559}@anchor{library/asyncio-platforms platform-support}@anchor{35d3}@anchor{library/asyncio-platforms translation-repo}@anchor{35d4}
@subsubsection Suporte a plataformas


The @ref{a,,asyncio} module is designed to be portable,
but some platforms have subtle differences and limitations
due to the platforms’ underlying architecture and capabilities.

@menu
* Todas as plataformas:: 
* Windows: Windows<81>. 
* macOS: macOS<51>. 

@end menu

@node Todas as plataformas,Windows<81>,,Suporte a plataformas
@anchor{library/asyncio-platforms all-platforms}@anchor{35d5}
@subsubsection Todas as plataformas



@itemize *

@item 
@ref{34d8,,loop.add_reader()} and @ref{3557,,loop.add_writer()}
cannot be used to monitor file I/O.
@end itemize

@node Windows<81>,macOS<51>,Todas as plataformas,Suporte a plataformas
@anchor{library/asyncio-platforms windows}@anchor{35d6}
@subsubsection Windows


`Source code:' Lib/asyncio/proactor_events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/proactor_events.py},
Lib/asyncio/windows_events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/windows_events.py},
Lib/asyncio/windows_utils.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/windows_utils.py}


__________________________________________________________________



Alterado na versão 3.8: On Windows, @ref{609,,ProactorEventLoop} is now the default event loop.


All event loops on Windows do not support the following methods:


@itemize *

@item 
@ref{34bd,,loop.create_unix_connection()} and
@ref{1ae,,loop.create_unix_server()} are not supported.
The @ref{193a,,socket.AF_UNIX} socket family is specific to Unix.

@item 
@ref{3560,,loop.add_signal_handler()} and
@ref{3561,,loop.remove_signal_handler()} are not supported.
@end itemize

@ref{608,,SelectorEventLoop} has the following limitations:


@itemize *

@item 
@ref{35d7,,SelectSelector} is used to wait on socket events:
it supports sockets and is limited to 512 sockets.

@item 
@ref{34d8,,loop.add_reader()} and @ref{3557,,loop.add_writer()} only accept
socket handles (e.g. pipe file descriptors are not supported).

@item 
Pipes are not supported, so the @ref{3504,,loop.connect_read_pipe()}
and @ref{3505,,loop.connect_write_pipe()} methods are not implemented.

@item 
@ref{3478,,Subprocesses} are not supported, i.e.
@ref{3501,,loop.subprocess_exec()} and @ref{3502,,loop.subprocess_shell()}
methods are not implemented.
@end itemize

@ref{609,,ProactorEventLoop} has the following limitations:


@itemize *

@item 
The @ref{34d8,,loop.add_reader()} and @ref{3557,,loop.add_writer()}
methods are not supported.
@end itemize

The resolution of the monotonic clock on Windows is usually around 15.6
milliseconds.  The best resolution is 0.5 milliseconds. The resolution depends on the
hardware (availability of HPET@footnote{https://en.wikipedia.org/wiki/High_Precision_Event_Timer}) and on the
Windows configuration.

@menu
* Suporte para subprocesso no Windows:: 

@end menu

@node Suporte para subprocesso no Windows,,,Windows<81>
@anchor{library/asyncio-platforms asyncio-windows-subprocess}@anchor{3503}@anchor{library/asyncio-platforms subprocess-support-on-windows}@anchor{35d8}
@subsubsection Suporte para subprocesso no Windows


On Windows, the default event loop @ref{609,,ProactorEventLoop} supports
subprocesses, whereas @ref{608,,SelectorEventLoop} does not.

The @ref{2c0,,policy.set_child_watcher()} function is also
not supported, as @ref{609,,ProactorEventLoop} has a different mechanism
to watch child processes.

@node macOS<51>,,Windows<81>,Suporte a plataformas
@anchor{library/asyncio-platforms macos}@anchor{35d9}
@subsubsection macOS


Modern macOS versions are fully supported.

@subsubheading macOS <= 10.8


On macOS 10.6, 10.7 and 10.8, the default event loop
uses @ref{35da,,selectors.KqueueSelector}, which does not support
character devices on these versions.  The @ref{608,,SelectorEventLoop}
can be manually configured to use @ref{35d7,,SelectSelector}
or @ref{bf1,,PollSelector} to support character devices on
these older versions of macOS.  Example:

@example
import asyncio
import selectors

selector = selectors.SelectSelector()
loop = asyncio.SelectorEventLoop(selector)
asyncio.set_event_loop(loop)
@end example

@node Extensão,Índice da API de alto nível,Suporte a plataformas,asyncio — E/S assíncrona
@anchor{library/asyncio-extending doc}@anchor{35db}@anchor{library/asyncio-extending extending}@anchor{35dc}@anchor{library/asyncio-extending translation-repo}@anchor{35dd}
@subsubsection Extensão


A direção principal para estender o módulo @ref{a,,asyncio} é escrever classes de `laços de eventos' personalizados. O Asyncio tem funções auxiliares que podem ser usadas para simplificar essa tarefa.

@cartouche
@quotation Nota 
Terceiros devem reutilizar o código assíncrono existente com cuidado. Uma versão nova de Python pode quebrar a compatibilidade com versões anteriores da parte `interna' da API.
@end quotation
@end cartouche

@menu
* Escrevendo um laço de eventos personalizado:: 
* Construtores privados de Future e Task:: 
* Suporte ao ciclo de vida de tarefas:: 

@end menu

@node Escrevendo um laço de eventos personalizado,Construtores privados de Future e Task,,Extensão
@anchor{library/asyncio-extending writing-a-custom-event-loop}@anchor{35de}
@subsubsection Escrevendo um laço de eventos personalizado


@ref{966,,asyncio.AbstractEventLoop} declara muitos métodos. Implementar todos eles do zero é um trabalho tedioso.

Um laço de eventos pode herdar várias implementações de métodos da classe @code{asyncio.BaseEventLoop}.

Por sua vez, o sucessor deve implementar um conjunto de métodos `privados' declarados, porém não implementados, em @code{asyncio.BaseEventLoop}.

Por exemplo, @code{loop.create_connection()`@w{`}verifica os argumentos, resolve endereços DNS, e chama a função `@w{`}loop._make_socket_transport()}, que deve ser implementada pela classe herdada. O método`@w{`}_make_socket_transport()`@w{`} não está documentado, e é considerado parte de uma API `interna'.

@node Construtores privados de Future e Task,Suporte ao ciclo de vida de tarefas,Escrevendo um laço de eventos personalizado,Extensão
@anchor{library/asyncio-extending future-and-task-private-constructors}@anchor{35df}
@subsubsection Construtores privados de Future e Task


As classes @ref{be6,,asyncio.Future} e @ref{1be,,asyncio.Task} nunca deverão ser criadas diretamente. Por favor, as substitua pelas `factories' correspondentes: @ref{c95,,loop.create_future()} e @ref{1c0,,loop.create_task()} ou @ref{1bf,,asyncio.create_task()}.

Porém, `laços de eventos' de terceiros podem `reutilizar' as implementações embutidas de Future e Task, obtendo um código complexo e altamente otimizado.

Por isso, segue a listagem de construtores `privados':

@geindex __init__() (método asyncio.Future)
@anchor{library/asyncio-extending asyncio Future __init__}@anchor{35e0}
@deffn {Método} Future.__init__ (*, loop=None)

Cria uma instância de Future embutida.

`loop' é uma instância opcional do laço de eventos.
@end deffn

@geindex __init__() (método asyncio.Task)
@anchor{library/asyncio-extending asyncio Task __init__}@anchor{35e1}
@deffn {Método} Task.__init__ (coro, *, loop=None, name=None, context=None)

Cria uma instância embutida de Task.

`loop' é uma instância opcional do laço de eventos. Os outros argumentos estão descritos em @ref{1c0,,loop.create_task()}.


Alterado na versão 3.11: o argumento `context' foi adicionado

@end deffn

@node Suporte ao ciclo de vida de tarefas,,Construtores privados de Future e Task,Extensão
@anchor{library/asyncio-extending task-lifetime-support}@anchor{35e2}
@subsubsection Suporte ao ciclo de vida de tarefas


Implementações de Task de terceiros devem chamar as seguintes funções para manter uma tarefa visível para @ref{95d,,asyncio.all_tasks()} e @ref{47d,,asyncio.current_task()}:

@geindex _register_task() (no módulo asyncio)
@anchor{library/asyncio-extending asyncio _register_task}@anchor{35e3}
@deffn {Função} asyncio._register_task (task)

Registra uma nova `task' como gerenciada pelo `asyncio'.

Chame esta função no construtor de uma tarefa.
@end deffn

@geindex _unregister_task() (no módulo asyncio)
@anchor{library/asyncio-extending asyncio _unregister_task}@anchor{35e4}
@deffn {Função} asyncio._unregister_task (task)

Cancela o registro de `task' nas estruturas internas do `asyncio'.

Chame esta função quando a tarefa estiver terminando.
@end deffn

@geindex _enter_task() (no módulo asyncio)
@anchor{library/asyncio-extending asyncio _enter_task}@anchor{35e5}
@deffn {Função} asyncio._enter_task (loop, task)

Troca a tarefa atual para o argumento `task'.

Chame esta função logo antes de executar uma porção da `corrotina' embutida (@ref{2159,,coroutine.send()} ou @ref{4f7,,coroutine.throw()}).
@end deffn

@geindex _leave_task() (no módulo asyncio)
@anchor{library/asyncio-extending asyncio _leave_task}@anchor{35e6}
@deffn {Função} asyncio._leave_task (loop, task)

Troca a tarefa atual de `task' para @code{None}.

Chame esta função logo após executar @ref{2159,,coroutine.send()} ou @ref{4f7,,coroutine.throw()}.
@end deffn

@node Índice da API de alto nível,Índice de APIs de baixo nível,Extensão,asyncio — E/S assíncrona
@anchor{library/asyncio-api-index doc}@anchor{87d}@anchor{library/asyncio-api-index high-level-api-index}@anchor{35e7}@anchor{library/asyncio-api-index translation-repo}@anchor{35e8}
@subsubsection Índice da API de alto nível


Esta página lista todas as APIs asyncio de alto nível habilitadas por async/await.

@menu
* Tarefas:: 
* Filas: Filas<2>. 
* Subprocessos: Subprocessos<2>. 
* Streams: Streams<2>. 
* Sincronização:: 
* Exceções: Exceções<14>. 

@end menu

@node Tarefas,Filas<2>,,Índice da API de alto nível
@anchor{library/asyncio-api-index tasks}@anchor{35e9}
@subsubsection Tarefas


Utilitários para executar programas asyncio, criar Tarefas, e esperar por múltiplas coisas com tempos limites.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{47c,,run()}

@tab

Cria um laço de eventos, roda uma corrotina, fecha o laço.

@item

@ref{600,,Runner}

@tab

Um gerenciador de contexto que simplifica várias chamadas assíncronas de funções.

@item

@ref{1be,,Task}

@tab

Objeto Task.

@item

@ref{1b5,,TaskGroup}

@tab

Um gerenciador de contexto que mantém um grupo de tarefas. Oferece uma maneira conveniente e confiável de aguardar a conclusão de todas as tarefas do grupo.

@item

@ref{1bf,,create_task()}

@tab

Inicia uma Task asyncio e a retorna.

@item

@ref{47d,,current_task()}

@tab

Retorna para a Tarefa atual.

@item

@ref{95d,,all_tasks()}

@tab

Retorna todas as tarefas que ainda não foram concluídas em um laço de eventos.

@item

@code{await} @ref{a79,,sleep()}

@tab

Dorme for um número de segundos.

@item

@code{await} @ref{5fd,,gather()}

@tab

Agenda e espera por coisas concorrentemente.

@item

@code{await} @ref{5ff,,wait_for()}

@tab

Executa com um tempo limite.

@item

@code{await} @ref{a7a,,shield()}

@tab

Protege contra cancelamento.

@item

@code{await} @ref{47f,,wait()}

@tab

Monitora para conclusão.

@item

@ref{5fe,,timeout()}

@tab

Executa com um tempo limite. Útil nos casos em que o @code{wait_for} não é adequado.

@item

@ref{8ee,,to_thread()}

@tab

Executa uma função assincronamente em uma thread separada.

@item

@ref{886,,run_coroutine_threadsafe()}

@tab

Agenda uma corrotina a partir de outra thread do sistema operacional.

@item

@code{for in} @ref{1aa,,as_completed()}

@tab

Monitora a conclusão com um loop @code{for}.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{3497,,Usando asyncio.gather() para executar coisas em paralelo}.

@item 
@ref{349f,,Usando asyncio.wait_for() para forçar um tempo limite de execução}.

@item 
@ref{34b4,,Cancelamento}.

@item 
@ref{3495,,Usando asyncio.sleep()}.

@item 
Veja também a @ref{3476,,página principal de documentação sobre Tarefas}.
@end itemize

@node Filas<2>,Subprocessos<2>,Tarefas,Índice da API de alto nível
@anchor{library/asyncio-api-index queues}@anchor{35ea}
@subsubsection Filas


Filas devem ser usadas para distribuir trabalho entre múltiplas Tarefas asyncio, implementar pools de conexão, e padrões pub/sub.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{a80,,Queue}

@tab

Uma fila FIFO - Primeiro que entra, é o primeiro que sai.

@item

@ref{3528,,PriorityQueue}

@tab

Uma fila de prioridade.

@item

@ref{352a,,LifoQueue}

@tab

Uma fila LIFO - Último que entra, é o primeiro que sai.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{352c,,Usando asyncio.Queue para distribuir cargas de trabalho entre diversas Tasks}.

@item 
Veja também a @ref{3479,,Página de documentação da classe Queue}.
@end itemize

@node Subprocessos<2>,Streams<2>,Filas<2>,Índice da API de alto nível
@anchor{library/asyncio-api-index subprocesses}@anchor{35eb}
@subsubsection Subprocessos


Utilitários para iniciar subprocessos e executar comandos no console.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{a81,,create_subprocess_exec()}

@tab

Cria um subprocesso.

@item

@code{await} @ref{a82,,create_subprocess_shell()}

@tab

Executa um comando no console.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{34fb,,Executando um comando no console}.

@item 
Veja também a @ref{3478,,documentação de subprocessos de APIs}.
@end itemize

@node Streams<2>,Sincronização,Subprocessos<2>,Índice da API de alto nível
@anchor{library/asyncio-api-index streams}@anchor{35ec}
@subsubsection Streams


APIs de alto nível para trabalhar com entrada e saída de rede.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{b2b,,open_connection()}

@tab

Estabelece uma conexão TCP.

@item

@code{await} @ref{34bc,,open_unix_connection()}

@tab

Estabelece uma conexão com soquete Unix.

@item

@code{await} @ref{b2c,,start_server()}

@tab

Inicia um servidor TCP.

@item

@code{await} @ref{34be,,start_unix_server()}

@tab

Inicia um servidor com soquete Unix.

@item

@ref{1a09,,StreamReader}

@tab

Objeto async/await de alto nível para receber dados de rede.

@item

@ref{17f2,,StreamWriter}

@tab

Objeto async/await de alto nível para enviar dados pela rede.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{34b8,,Exemplo de cliente TCP}.

@item 
Veja também a documentação das @ref{3477,,APIs de streams}.
@end itemize

@node Sincronização,Exceções<14>,Streams<2>,Índice da API de alto nível
@anchor{library/asyncio-api-index synchronization}@anchor{35ed}
@subsubsection Sincronização


Primitivas de sincronização similares a threads, que podem ser usadas em tarefas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{a7b,,Lock}

@tab

Uma trava mutex.

@item

@ref{a7c,,Event}

@tab

Um objeto de evento.

@item

@ref{a7d,,Condition}

@tab

Um objeto de condição.

@item

@ref{a7e,,Semaphore}

@tab

Um semáforo.

@item

@ref{a7f,,BoundedSemaphore}

@tab

Um semáforo limitado.

@item

@ref{601,,Barrier}

@tab

Um objeto barreira.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{34e4,,Usando asyncio.Event}.

@item 
@ref{34f2,,Usando asyncio.Barrier}.

@item 
Veja também a documentação das @ref{347a,,primitivas de sincronização de asyncio}.
@end itemize

@node Exceções<14>,,Sincronização,Índice da API de alto nível
@anchor{library/asyncio-api-index exceptions}@anchor{35ee}
@subsubsection Exceções



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{1b8,,asyncio.CancelledError}

@tab

Levantado quanto a Tarefa é cancelada. Veja também @ref{1b7,,Task.cancel()}.

@item

@ref{602,,asyncio.BrokenBarrierError}

@tab

Levantado quando um Barreira é quebrada. veja também @ref{34f1,,Barrier.wait()} .

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{34b4,,Manipulando CancelledError para executar código no cancelamento de uma requisição}.

@item 
Veja também a lista completa de @ref{352e,,exceções específicas de asyncio}.
@end itemize

@node Índice de APIs de baixo nível,Desenvolvendo com asyncio,Índice da API de alto nível,asyncio — E/S assíncrona
@anchor{library/asyncio-llapi-index doc}@anchor{35ef}@anchor{library/asyncio-llapi-index low-level-api-index}@anchor{35f0}@anchor{library/asyncio-llapi-index translation-repo}@anchor{35f1}
@subsubsection Índice de APIs de baixo nível


Esta página lista todas as APIs de baixo nível do asyncio.

@menu
* Obtendo o laço de eventos:: 
* Métodos do laço de eventos: Métodos do laço de eventos<2>. 
* Transportes: Transportes<2>. 
* Protocolos: Protocolos<2>. 
* Políticas de laço de eventos:: 

@end menu

@node Obtendo o laço de eventos,Métodos do laço de eventos<2>,,Índice de APIs de baixo nível
@anchor{library/asyncio-llapi-index obtaining-the-event-loop}@anchor{35f2}
@subsubsection Obtendo o laço de eventos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b1d,,asyncio.get_running_loop()}

@tab

A função `preferida' para obter o laço de eventos em execução.

@item

@ref{2c2,,asyncio.get_event_loop()}

@tab

Obtém uma instância do laço de eventos (em execução ou atual por meio da política atual).

@item

@ref{18df,,asyncio.set_event_loop()}

@tab

Define o laço de eventos como atual através da política atual.

@item

@ref{3484,,asyncio.new_event_loop()}

@tab

Cria um novo laço de eventos.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{3582,,Usando asyncio.get_running_loop()}.
@end itemize

@node Métodos do laço de eventos<2>,Transportes<2>,Obtendo o laço de eventos,Índice de APIs de baixo nível
@anchor{library/asyncio-llapi-index event-loop-methods}@anchor{35f3}
@subsubsection Métodos do laço de eventos


Veja também a seção principal da documentação sobre os @ref{353d,,Métodos do laço de eventos}.

@subsubheading Ciclo de vida



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{c93,,loop.run_until_complete()}

@tab

Executa um Future/Task/aguardável até que esteja completo.

@item

@ref{353f,,loop.run_forever()}

@tab

Executa o laço de eventos para sempre.

@item

@ref{c98,,loop.stop()}

@tab

Para o laço de eventos.

@item

@ref{3541,,loop.close()}

@tab

Fecha o laço de eventos.

@item

@ref{3540,,loop.is_running()}

@tab

Retorna @code{True} se o laço de eventos estiver rodando.

@item

@ref{dec,,loop.is_closed()}

@tab

Retorna @code{True} se o laço de eventos estiver fechado.

@item

@code{await} @ref{c9a,,loop.shutdown_asyncgens()}

@tab

Fecha geradores assíncronos.

@end multitable


@subsubheading Depuração



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{dea,,loop.set_debug()}

@tab

Habilita ou desabilita o modo de debug.

@item

@ref{deb,,loop.get_debug()}

@tab

Obtém o modo de debug atual.

@end multitable


@subsubheading Agendando funções de retorno (callbacks)



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b17,,loop.call_soon()}

@tab

Invoca uma função de retorno brevemente.

@item

@ref{b18,,loop.call_soon_threadsafe()}

@tab

Uma variante segura para thread de @ref{b17,,loop.call_soon()}.

@item

@ref{b29,,loop.call_later()}

@tab

Invoca uma função de retorno `após' o tempo especificado.

@item

@ref{b19,,loop.call_at()}

@tab

Invoca uma função de retorno `no' instante especificado.

@end multitable


@subsubheading Grupo de Thread/Processo



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{8ef,,loop.run_in_executor()}

@tab

Executa uma função vinculada à CPU ou outra que seja bloqueante em um executor @ref{21,,concurrent.futures}.

@item

@ref{743,,loop.set_default_executor()}

@tab

Define o executor padrão para @ref{8ef,,loop.run_in_executor()}.

@end multitable


@subsubheading Tasks e Futures



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{c95,,loop.create_future()}

@tab

Cria um objeto @ref{be6,,Future}.

@item

@ref{1c0,,loop.create_task()}

@tab

Agenda corrotina como uma @ref{1be,,Task}.

@item

@ref{dee,,loop.set_task_factory()}

@tab

Define uma factory usada por @ref{1c0,,loop.create_task()} para criar @ref{1be,,Tasks}.

@item

@ref{def,,loop.get_task_factory()}

@tab

Obtém o factory @ref{1c0,,loop.create_task()} usado para criar @ref{1be,,Tasks}.

@end multitable


@subsubheading DNS



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{c2e,,loop.getaddrinfo()}

@tab

Versão assíncrona de @ref{184b,,socket.getaddrinfo()}.

@item

@code{await} @ref{c2f,,loop.getnameinfo()}

@tab

Versão assíncrona de @ref{17b6,,socket.getnameinfo()}.

@end multitable


@subsubheading Rede e IPC



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{603,,loop.create_connection()}

@tab

Abre uma conexão TCP.

@item

@code{await} @ref{b25,,loop.create_server()}

@tab

Cria um servidor TCP.

@item

@code{await} @ref{34bd,,loop.create_unix_connection()}

@tab

Abre uma conexão soquete Unix.

@item

@code{await} @ref{1ae,,loop.create_unix_server()}

@tab

Cria um servidor soquete Unix.

@item

@code{await} @ref{7df,,loop.connect_accepted_socket()}

@tab

Envolve um @ref{dc9,,socket} em um par @code{(transport, protocol)}.

@item

@code{await} @ref{733,,loop.create_datagram_endpoint()}

@tab

Abre uma conexão por datagrama (UDP).

@item

@code{await} @ref{3553,,loop.sendfile()}

@tab

Envia um arquivo por meio de um transporte.

@item

@code{await} @ref{b1b,,loop.start_tls()}

@tab

Atualiza uma conexão existente para TLS.

@item

@code{await} @ref{3504,,loop.connect_read_pipe()}

@tab

Envolve a leitura final de um encadeamento em um par @code{(transport, protocol)}.

@item

@code{await} @ref{3505,,loop.connect_write_pipe()}

@tab

Envolve a escrita final de um encadeamento em um par @code{(transport, protocol)}.

@end multitable


@subsubheading Soquetes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{c2b,,loop.sock_recv()}

@tab

Recebe dados do @ref{dc9,,socket}.

@item

@code{await} @ref{b1c,,loop.sock_recv_into()}

@tab

Recebe dados do @ref{dc9,,socket} em um buffer.

@item

@code{await} @ref{606,,loop.sock_recvfrom()}

@tab

Recebe um datagrama do @ref{dc9,,socket}.

@item

@code{await} @ref{607,,loop.sock_recvfrom_into()}

@tab

Recebe um datagrama do @ref{dc9,,socket} em um buffer.

@item

@code{await} @ref{c2c,,loop.sock_sendall()}

@tab

Envia dados para o @ref{dc9,,socket}.

@item

@code{await} @ref{605,,loop.sock_sendto()}

@tab

Envia um datagrama por meio de @ref{dc9,,socket} para o endereço dado.

@item

@code{await} @ref{df2,,loop.sock_connect()}

@tab

Conecta ao @ref{dc9,,socket}.

@item

@code{await} @ref{c2d,,loop.sock_accept()}

@tab

Aceita uma conexão do @ref{dc9,,socket}.

@item

@code{await} @ref{b20,,loop.sock_sendfile()}

@tab

Envia um arquivo usando o @ref{dc9,,socket}.

@item

@ref{34d8,,loop.add_reader()}

@tab

Começa a observar um descritor de arquivo, aguardando por disponibilidade de leitura.

@item

@ref{3556,,loop.remove_reader()}

@tab

Interrompe o monitoramento de um descritor de arquivo, que aguarda disponibilidade de leitura.

@item

@ref{3557,,loop.add_writer()}

@tab

Começa a observar um descritor de arquivo, aguardando por disponibilidade para escrita.

@item

@ref{3558,,loop.remove_writer()}

@tab

Interrompe o monitoramento de um descritor de arquivo, que aguarda disponibilidade para escrita.

@end multitable


@subsubheading Sinais Unix



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3560,,loop.add_signal_handler()}

@tab

Adiciona um tratador para um @ref{c6,,signal}.

@item

@ref{3561,,loop.remove_signal_handler()}

@tab

Remove um tratador para um @ref{c6,,signal}.

@end multitable


@subsubheading Subprocessos



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3501,,loop.subprocess_exec()}

@tab

Inicia um subprocesso.

@item

@ref{3502,,loop.subprocess_shell()}

@tab

Inicia um subprocesso a partir de um comando shell.

@end multitable


@subsubheading Tratamento de erros



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3565,,loop.call_exception_handler()}

@tab

Chama o tratamento de exceção.

@item

@ref{3564,,loop.set_exception_handler()}

@tab

Define um novo tratador de exceção.

@item

@ref{c96,,loop.get_exception_handler()}

@tab

Obtém o tratador de exceção atual.

@item

@ref{3566,,loop.default_exception_handler()}

@tab

A implementação padrão do tratador de exceção.

@end multitable


@subsubheading Exemplos



@itemize *

@item 
@ref{3571,,Usando asyncio.new_event_loop() e loop.run_forever()}.

@item 
@ref{3573,,Usando loop.call_later()}.

@item 
Usando @code{loop.create_connection()} para implementar @ref{34cf,,um cliente-eco}.

@item 
Usando @code{loop.create_connection()} para @ref{34d6,,conectar a um soquete}.

@item 
@ref{34d7,,Usando add_reader() para monitorar um descritor de arquivo para eventos de leitura}.

@item 
@ref{3576,,Usando loop.add_signal_handler()}.

@item 
@ref{3517,,Usando loop.subprocess_exec()}.
@end itemize

@node Transportes<2>,Protocolos<2>,Métodos do laço de eventos<2>,Índice de APIs de baixo nível
@anchor{library/asyncio-llapi-index transports}@anchor{35f4}
@subsubsection Transportes


Todos os transportes implementam os seguintes métodos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{354d,,transport.close()}

@tab

Fecha o transporte.

@item

@ref{c94,,transport.is_closing()}

@tab

Retorna @code{True} se o transporte estiver fechando ou estiver fechado.

@item

@ref{aab,,transport.get_extra_info()}

@tab

Solicita informação a respeito do transporte.

@item

@ref{3593,,transport.set_protocol()}

@tab

Define um novo protocolo.

@item

@ref{3594,,transport.get_protocol()}

@tab

Retorna o protocolo atual.

@end multitable


Transportes que podem receber dados (TCP e conexões Unix, encadeamentos, etc). Retornado a partir de métodos como @ref{603,,loop.create_connection()}, @ref{34bd,,loop.create_unix_connection()}, @ref{3504,,loop.connect_read_pipe()}, etc:

@subsubheading Realiza leitura de Transportes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{b2e,,transport.is_reading()}

@tab

Retorna @code{True} se o transporte estiver recebendo.

@item

@ref{b30,,transport.pause_reading()}

@tab

Pausa o recebimento.

@item

@ref{b2f,,transport.resume_reading()}

@tab

Continua o recebimento.

@end multitable


Transportes que podem enviar dados (TCP e conexões Unix, encadeamentos, etc). Retornado a partir de métodos como @ref{603,,loop.create_connection()}, @ref{34bd,,loop.create_unix_connection()}, @ref{3505,,loop.connect_write_pipe()}, etc:

@subsubheading Realiza escrita de Transportes



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{15dd,,transport.write()}

@tab

Escreve dados para o transporte.

@item

@ref{15dc,,transport.writelines()}

@tab

Escreve buffers para o transporte.

@item

@ref{3597,,transport.can_write_eof()}

@tab

Retorna @ref{c27,,True} se o transporte suporta o envio de EOF.

@item

@ref{3598,,transport.write_eof()}

@tab

Fecha e envia EOF após descarregar dados que estavam no buffer.

@item

@ref{356e,,transport.abort()}

@tab

Fecha o transporte imediatamente.

@item

@ref{3599,,transport.get_write_buffer_size()}

@tab

Retorna o tamanho atual do buffer de saída.

@item

@ref{ded,,transport.get_write_buffer_limits()}

@tab

Retorna marcas d’água alta e baixa para controle do fluxo de escrita.

@item

@ref{359a,,transport.set_write_buffer_limits()}

@tab

Define novas marcas d’água alta e baixa para controle do fluxo de escrita.

@end multitable


Transporte retornado por @ref{733,,loop.create_datagram_endpoint()}:

@subsubheading Transportes de datagrama



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{1af,,transport.sendto()}

@tab

Envia dados para o par remoto.

@item

@ref{359e,,transport.abort()}

@tab

Fecha o transporte imediatamente.

@end multitable


Abstração de transporte de baixo nível sobre subprocessos. Retornado por @ref{3501,,loop.subprocess_exec()} e @ref{3502,,loop.subprocess_shell()}:

@subsubheading Transportes de Subprocesso



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{35a0,,transport.get_pid()}

@tab

Retorna o process id do subprocesso.

@item

@ref{35a1,,transport.get_pipe_transport()}

@tab

Retorna o transporte para o encadeamento de comunicação requisitada (`stdin', `stdout', ou `stderr').

@item

@ref{35a2,,transport.get_returncode()}

@tab

Retorna o código de retorno do subprocesso.

@item

@ref{35a3,,transport.kill()}

@tab

Mata o subprocesso.

@item

@ref{35a5,,transport.send_signal()}

@tab

Envia um sinal para o subprocesso.

@item

@ref{35a4,,transport.terminate()}

@tab

Interrompe o  subprocesso.

@item

@ref{35a6,,transport.close()}

@tab

Mata o subprocesso e fecha todos os encadeamentos.

@end multitable


@node Protocolos<2>,Políticas de laço de eventos,Transportes<2>,Índice de APIs de baixo nível
@anchor{library/asyncio-llapi-index protocols}@anchor{35f5}
@subsubsection Protocolos


Classes de protocolos podem implementar os seguintes `métodos de função de retorno':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{354b,,connection_made()}

@tab

Chamado quando uma conexão é estabelecida.

@item

@code{callback} @ref{358f,,connection_lost()}

@tab

Chamado quanto a conexão é perdida ou fechada.

@item

@code{callback} @ref{359b,,pause_writing()}

@tab

Chamado quando o buffer de transporte ultrapassa a marca de nível alto d’água.

@item

@code{callback} @ref{359c,,resume_writing()}

@tab

Chamado quando o buffer de transporte drena abaixo da marca de nível baixo d’agua.

@end multitable


@subsubheading Protocolos de Streaming (TCP, Soquetes Unix, Encadeamentos)



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{188a,,data_received()}

@tab

Chamado quando algum dado é recebido.

@item

@code{callback} @ref{35aa,,eof_received()}

@tab

Chamado quando um EOF é recebido.

@end multitable


@subsubheading Protocolos de Streaming Bufferizados



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{35ac,,get_buffer()}

@tab

Chamada para alocar um novo buffer para recebimento.

@item

@code{callback} @ref{35ad,,buffer_updated()}

@tab

Chamado quando o buffer foi atualizado com os dados recebidos.

@item

@code{callback} @ref{35ae,,eof_received()}

@tab

Chamado quando um EOF é recebido.

@end multitable


@subsubheading Protocolos de Datagramas



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{35b0,,datagram_received()}

@tab

Chamado quando um datagrama é recebido.

@item

@code{callback} @ref{35b1,,error_received()}

@tab

Chamado quando uma operação de envio ou recebimento anterior levanta um @ref{417,,OSError}.

@end multitable


@subsubheading Protocolos de Subprocesso



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{18d9,,pipe_data_received()}

@tab

Chamado quando o processo filho escreve dados no seu encadeamento `stdout' ou `stderr'.

@item

@code{callback} @ref{35b3,,pipe_connection_lost()}

@tab

Chamado quando um dos encadeamentos comunicando com o processo filho é fechado.

@item

@code{callback} @ref{18d8,,process_exited()}

@tab

Chamado quando o processo filho sai. Isso pode ser chamado antes dos métodos @ref{18d9,,pipe_data_received()} e @ref{35b3,,pipe_connection_lost()}.

@end multitable


@node Políticas de laço de eventos,,Protocolos<2>,Índice de APIs de baixo nível
@anchor{library/asyncio-llapi-index event-loop-policies}@anchor{35f6}
@subsubsection Políticas de laço de eventos


Política é um mecanismo de baixo nível para alterar o comportamento de funções, similar a @ref{2c2,,asyncio.get_event_loop()}. Veja também a @ref{3537,,seção principal de políticas} para mais detalhes.

@subsubheading Acessando Políticas



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{35c3,,asyncio.get_event_loop_policy()}

@tab

Retorna a política de todo o processo atual.

@item

@ref{35c4,,asyncio.set_event_loop_policy()}

@tab

Define uma nova política para todo o processo.

@item

@ref{35c1,,AbstractEventLoopPolicy}

@tab

Classe base para objetos de política.

@end multitable


@node Desenvolvendo com asyncio,,Índice de APIs de baixo nível,asyncio — E/S assíncrona
@anchor{library/asyncio-dev doc}@anchor{35f7}@anchor{library/asyncio-dev asyncio-dev}@anchor{35f8}@anchor{library/asyncio-dev developing-with-asyncio}@anchor{35f9}@anchor{library/asyncio-dev translation-repo}@anchor{35fa}
@subsubsection Desenvolvendo com asyncio


A programação assíncrona é diferente da programação “sequencial” clássica.

Esta página lista erros e armadilhas comuns e explica como evitá-los.

@menu
* Modo de Depuração:: 
* Concorrência e Múltiplas Threads:: 
* Executando código bloqueante:: 
* Gerando logs: Gerando logs<3>. 
* Detectar corrotinas nunca aguardadas:: 
* Detectar exceções nunca recuperadas:: 

@end menu

@node Modo de Depuração,Concorrência e Múltiplas Threads,,Desenvolvendo com asyncio
@anchor{library/asyncio-dev asyncio-debug-mode}@anchor{1ed3}@anchor{library/asyncio-dev debug-mode}@anchor{35fb}
@subsubsection Modo de Depuração


Por padrão, o asyncio é executado em modo de produção. Para facilitar o desenvolvimento, o asyncio fornece um modo de depuração.

Há várias maneiras de habilitar o modo de depuração do asyncio:


@itemize *

@item 
Definindo a variável de ambiente 
@geindex PYTHONASYNCIODEBUG
@geindex variável de ambiente; PYTHONASYNCIODEBUG
@ref{1ed2,,PYTHONASYNCIODEBUG} como @code{1}.

@item 
Usando o @ref{1f8,,Modo de Desenvolvimento do Python}.

@item 
Passando @code{debug=True} para @ref{47c,,asyncio.run()}.

@item 
Chamando @ref{dea,,loop.set_debug()}.
@end itemize

Além de habilitar o modo de depuração, considere também:


@itemize *

@item 
setting the log level of the @ref{35fc,,asyncio logger} to
@ref{2e3d,,logging.DEBUG}, for example the following snippet of code
can be run at startup of the application:

@example
logging.basicConfig(level=logging.DEBUG)
@end example

@item 
configurando o módulo @ref{112,,warnings} para exibir avisos @ref{244,,ResourceWarning}. Uma forma de fazer isso é usando a opção de linha de comando: @ref{8cd,,-W} @code{default}.
@end itemize

Quando o modo de depuração está habilitado:


@itemize *

@item 
Muitas APIs do asyncio que não são thread-safe (como os métodos @ref{b17,,loop.call_soon()} e @ref{b19,,loop.call_at()}) levantam uma exceção se forem chamadas a partir de uma thread incorreta.

@item 
O tempo de execução de um seletor de E/S é registrado se demorar muito para executar a operação E/S.

@item 
Funções de retorno demorando mais do que 100 milissegundos são registradas. O atributo @ref{3568,,loop.slow_callback_duration} pode ser usado para definir a duração de execução mínima em segundos para se considerada “devagar”.
@end itemize

@node Concorrência e Múltiplas Threads,Executando código bloqueante,Modo de Depuração,Desenvolvendo com asyncio
@anchor{library/asyncio-dev asyncio-multithreading}@anchor{34a6}@anchor{library/asyncio-dev concurrency-and-multithreading}@anchor{35fd}
@subsubsection Concorrência e Múltiplas Threads


Um laço de eventos é executado em uma thread (geralmente a thread principal) e executa todos as funções de retorno e Tasks nessa mesma thread. Enquanto uma Task está em execução no laço de eventos, nenhuma outra Task pode ser executada na mesma thread. Quando uma Task executa uma expressão @code{await}, a Task em execução é suspensa, e o laço de eventos passa a executar a próxima Task.

Para agendar uma @ref{2ad2,,callback} de outra thread do SO, o método @ref{b18,,loop.call_soon_threadsafe()} deve ser usado. Exemplo:

@example
loop.call_soon_threadsafe(callback, *args)
@end example

Quase todos os objetos do asyncio não são seguros para threads, o que normalmente não é um problema, a menos que exista código que funcione com eles fora de uma Task ou de um callback. Se houver a necessidade de esse tipo de código chamar uma API de baixo nível do asyncio, o método @ref{b18,,loop.call_soon_threadsafe()} deve ser usado, por exemplo:

@example
loop.call_soon_threadsafe(fut.cancel)
@end example

Para agendar um objeto corrotina a partir de uma thread diferente do sistema operacional, a função @ref{886,,run_coroutine_threadsafe()} deve ser usada. Ela retorna um @ref{11f1,,concurrent.futures.Future}. para acessar o 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 manipular sinais, o laço de eventos deve ser executado na thread principal.

The @ref{8ef,,loop.run_in_executor()} method can be used with a
@ref{742,,concurrent.futures.ThreadPoolExecutor} to execute
blocking code in a different OS thread without blocking the OS thread
that the event loop runs in.

There is currently no way to schedule coroutines or callbacks directly
from a different process (such as one started with
@ref{94,,multiprocessing}). The @ref{353d,,Métodos do laço de eventos}
section lists APIs that can read from pipes and watch file descriptors
without blocking the event loop. In addition, asyncio’s
@ref{3478,,Subprocess} APIs provide a way to start a
process and communicate with it from the event loop. Lastly, the
aforementioned @ref{8ef,,loop.run_in_executor()} method can also be used
with a @ref{8f4,,concurrent.futures.ProcessPoolExecutor} to execute
code in a different process.

@node Executando código bloqueante,Gerando logs<3>,Concorrência e Múltiplas Threads,Desenvolvendo com asyncio
@anchor{library/asyncio-dev asyncio-handle-blocking}@anchor{35fe}@anchor{library/asyncio-dev running-blocking-code}@anchor{35ff}
@subsubsection Executando código bloqueante


O código bloqueante (vinculada à CPU) não deve ser chamado diretamente. Por exemplo, se uma função executa um cálculo pesado de CPU durante 1 segundo, todas as Tasks concorrentes do asyncio e as operações de E/S serão atrasadas por 1 segundo.

An executor can be used to run a task in a different thread or even in
a different process to avoid blocking the OS thread with the
event loop.  See the @ref{8ef,,loop.run_in_executor()} method for more
details.

@node Gerando logs<3>,Detectar corrotinas nunca aguardadas,Executando código bloqueante,Desenvolvendo com asyncio
@anchor{library/asyncio-dev asyncio-logger}@anchor{35fc}@anchor{library/asyncio-dev logging}@anchor{3600}
@subsubsection Gerando logs


asyncio usa o módulo @ref{87,,logging} e todo registro é feito via o registrador @code{"asyncio"}.

O nível padrão de log é @ref{2e3b,,logging.INFO}, que pode ser facilmente ajustado:

@example
logging.getLogger("asyncio").setLevel(logging.WARNING)
@end example

Logging de rede pode bloquear o laço de eventos. Recomenda-se usar uma thread separada para lidar com os logs ou usar E/S não bloqueante. Por exemplo, veja @ref{3601,,Dealing with handlers that block}.

@node Detectar corrotinas nunca aguardadas,Detectar exceções nunca recuperadas,Gerando logs<3>,Desenvolvendo com asyncio
@anchor{library/asyncio-dev asyncio-coroutine-not-scheduled}@anchor{3602}@anchor{library/asyncio-dev detect-never-awaited-coroutines}@anchor{3603}
@subsubsection Detectar corrotinas nunca aguardadas


Quando uma função de corrotina é chamada, mas não é aguardada (por exemplo, @code{coro()} em vez de @code{await coro()}) ou a corrotina não é agendada com @ref{1bf,,asyncio.create_task()}, o asyncio emitirá um @ref{1bd,,RuntimeWarning}:

@example
import asyncio

async def test():
    print("never scheduled")

async def main():
    test()

asyncio.run(main())
@end example

Saída:

@example
test.py:7: RuntimeWarning: coroutine 'test' was never awaited
  test()
@end example

Saída no modo de depuração:

@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

A correção usual é aguardar a corrotina ou chamar a função @ref{1bf,,asyncio.create_task()}:

@example
async def main():
    await test()
@end example

@node Detectar exceções nunca recuperadas,,Detectar corrotinas nunca aguardadas,Desenvolvendo com asyncio
@anchor{library/asyncio-dev detect-never-retrieved-exceptions}@anchor{3604}
@subsubsection Detectar exceções nunca recuperadas


Se um @ref{c99,,Future.set_exception()} é chamado, mas o objeto Future nunca é aguardado, a exceção nunca será propagada para o código do usuário. Nesse caso, o asyncio emitirá uma mensagem de log quando o objeto Future for coletado pela coleta de lixo.

Exemplo de uma exceção não tratada:

@example
import asyncio

async def bug():
    raise Exception("not consumed")

async def main():
    asyncio.create_task(bug())

asyncio.run(main())
@end example

Saída:

@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{1ed3,,Enable the debug mode} to get the
traceback where the task was created:

@example
asyncio.run(main(), debug=True)
@end example

Saída no modo de depuração:

@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 
O código-fonte para o asyncio pode ser encontrado em Lib/asyncio/@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/}.
@end quotation
@end cartouche

@node socket — Interface de rede de baixo nível,ssl — Invólucro de TLS/SSL para objetos socket,asyncio — E/S assíncrona,Comunicação em Rede e Interprocesso
@anchor{library/socket doc}@anchor{3605}@anchor{library/socket module-socket}@anchor{cc}@anchor{library/socket socket-low-level-networking-interface}@anchor{3606}@anchor{library/socket translation-repo}@anchor{3607}
@subsection @code{socket} — Interface de rede de baixo nível


@geindex module; socket

`Código-fonte:' Lib/socket.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/socket.py}


__________________________________________________________________


Este módulo provê acesso à interface de `soquete' do BSD. Está disponível em todos os sistemas modernos Unix, Windows, MacOS e provavelmente outras plataformas.

@cartouche
@quotation Nota 
Algum comportamento pode depender da plataforma, pois as chamadas são feitas para as APIs de soquete do sistema operacional.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@geindex objeto;socket

A interface Python é uma transliteração direta da chamada de sistema e interface de biblioteca de soquetes do Unix para o estilo orientado a objetos do Python: a função @ref{dc9,,socket()} retorna um `objeto socket' cujos métodos implementam as diversas chamadas de sistema de soquetes. Os tipos de parâmetro são consideravelmente de nível mais alto que os da interface em C: assim como as operações @code{read()} e @code{write()}  em arquivos Python, a alocação de buffer em operações de recebimento é automática, e o comprimento do buffer é implícito em operações de envio.


@subsubheading Ver também



@table @asis

@item Módulo @ref{cd,,socketserver}

Classes que simplificam a escrita de servidores de rede.

@item Módulo @ref{d0,,ssl}

Um invólucro de TLS/SSL para objetos socket.
@end table


@menu
* Famílias de soquete:: 
* Conteúdo do módulo: Conteúdo do módulo<4>. 
* Socket Objects:: 
* Notas sobre tempo limite de soquete:: 
* Exemplo: Exemplo<7>. 

@end menu

@node Famílias de soquete,Conteúdo do módulo<4>,,socket — Interface de rede de baixo nível
@anchor{library/socket socket-families}@anchor{3608}
@subsubsection Famílias de soquete


Dependendo do sistema e das opções de construção, várias famílias de soquetes são suportadas por este módulo.

O formato de endereço requerido por um objeto socket em particular é selecionado automaticamente com base na família de endereços especificada quando o objeto socket foi criado. Endereços de socket são representados da seguinte forma:


@itemize -

@item 
O endereço de um socket @ref{193a,,AF_UNIX} vinculado a um nó do sistema de arquivos é representado como uma string, usando a codificação do sistema de arquivos e o tratador de erros @code{'surrogateescape'} (veja 
@geindex Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). Um endereço no espaço de nomes abstrato do Linux é retornado como um @ref{d4f,,objeto bytes ou similar} com um byte nulo inicial; observe que os sockets neste espaço de nomes podem se comunicar com sockets normais do sistema de arquivos, então programas destinados a rodar no Linux podem precisar lidar com ambos os tipos de endereço. Uma string ou um objeto bytes ou similar pode ser usado para qualquer tipo de endereço ao passá-lo como um argumento.


Alterado na versão 3.3: Previously, @ref{193a,,AF_UNIX} socket paths were assumed to use UTF-8
encoding.



Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@end itemize
@anchor{library/socket host-port}@anchor{3609}

@itemize -

@item 
A pair @code{(host, port)} is used for the @ref{1938,,AF_INET} address family,
where `host' is a string representing either a hostname in internet domain
notation like @code{'daring.cwi.nl'} or an IPv4 address like @code{'100.50.200.5'},
and `port' is an integer.


@itemize -

@item 
For IPv4 addresses, two special forms are accepted instead of a host
address: @code{'@w{'}} represents @code{INADDR_ANY}, which is used to bind to all
interfaces, and the string @code{'<broadcast>'} represents
@code{INADDR_BROADCAST}.  This behavior is not compatible with IPv6,
therefore, you may want to avoid these if you intend to support IPv6 with your
Python programs.
@end itemize

@item 
For @ref{1939,,AF_INET6} address family, a four-tuple @code{(host, port, flowinfo,
scope_id)} is used, where `flowinfo' and `scope_id' represent the @code{sin6_flowinfo}
and @code{sin6_scope_id} members in @code{struct sockaddr_in6} in C.  For
@ref{cc,,socket} module methods, `flowinfo' and `scope_id' can be omitted just for
backward compatibility.  Note, however, omission of `scope_id' can cause problems
in manipulating scoped IPv6 addresses.


Alterado na versão 3.7: For multicast addresses (with `scope_id' meaningful) `address' may not contain
@code{%scope_id} (or @code{zone id}) part. This information is superfluous and may
be safely omitted (recommended).


@item 
@code{AF_NETLINK} sockets are represented as pairs @code{(pid, groups)}.

@item 
Linux-only support for TIPC is available using the @code{AF_TIPC}
address family.  TIPC is an open, non-IP based networked protocol designed
for use in clustered computer environments.  Addresses are represented by a
tuple, and the fields depend on the address type. The general tuple form is
@code{(addr_type, v1, v2, v3 [, scope])}, where:


@itemize -

@item 
`addr_type' is one of @code{TIPC_ADDR_NAMESEQ}, @code{TIPC_ADDR_NAME},
or @code{TIPC_ADDR_ID}.

@item 
`scope' is one of @code{TIPC_ZONE_SCOPE}, @code{TIPC_CLUSTER_SCOPE}, and
@code{TIPC_NODE_SCOPE}.

@item 
If `addr_type' is @code{TIPC_ADDR_NAME}, then `v1' is the server type, `v2' is
the port identifier, and `v3' should be 0.

If `addr_type' is @code{TIPC_ADDR_NAMESEQ}, then `v1' is the server type, `v2'
is the lower port number, and `v3' is the upper port number.

If `addr_type' is @code{TIPC_ADDR_ID}, then `v1' is the node, `v2' is the
reference, and `v3' should be set to 0.
@end itemize

@item 
A tuple @code{(interface, )} is used for the @ref{360a,,AF_CAN} address family,
where `interface' is a string representing a network interface name like
@code{'can0'}. The network interface name @code{'@w{'}} can be used to receive packets
from all network interfaces of this family.


@itemize -

@item 
@ref{360b,,CAN_ISOTP} protocol require a tuple @code{(interface, rx_addr, tx_addr)}
where both additional parameters are unsigned long integer that represent a
CAN identifier (standard or extended).

@item 
@ref{939,,CAN_J1939} protocol require a tuple @code{(interface, name, pgn, addr)}
where additional parameters are 64-bit unsigned integer representing the
ECU name, a 32-bit unsigned integer representing the Parameter Group Number
(PGN), and an 8-bit integer representing the address.
@end itemize

@item 
A string or a tuple @code{(id, unit)} is used for the @code{SYSPROTO_CONTROL}
protocol of the @code{PF_SYSTEM} family. The string is the name of a
kernel control using a dynamically assigned ID. The tuple can be used if ID
and unit number of the kernel control are known or if a registered ID is
used.


Adicionado na versão 3.3.


@item 
@code{AF_BLUETOOTH} supports the following protocols and address
formats:


@itemize -

@item 
@code{BTPROTO_L2CAP} accepts @code{(bdaddr, psm)} where @code{bdaddr} is
the Bluetooth address as a string and @code{psm} is an integer.

@item 
@code{BTPROTO_RFCOMM} accepts @code{(bdaddr, channel)} where @code{bdaddr}
is the Bluetooth address as a string and @code{channel} is an integer.

@item 
@code{BTPROTO_HCI} accepts a format that depends on your OS.


@itemize -

@item 
On Linux it accepts a tuple @code{(device_id,)} where @code{device_id}
is an integer specifying the number of the Bluetooth device.

@item 
On FreeBSD, NetBSD and DragonFly BSD it accepts @code{bdaddr}
where @code{bdaddr} is the Bluetooth address as a string.
@end itemize


Alterado na versão 3.2: NetBSD and DragonFlyBSD support added.



Alterado na versão 3.13.3: FreeBSD support added.


@item 
@code{BTPROTO_SCO} accepts @code{bdaddr} where @code{bdaddr} is
the Bluetooth address as a string or a @ref{1c2,,bytes} object.
(ex. @code{'12:23:34:45:56:67'} or @code{b'12:23:34:45:56:67'})
This protocol is not supported under FreeBSD.
@end itemize

@item 
@ref{cf7,,AF_ALG} is a Linux-only socket based interface to Kernel
cryptography. An algorithm socket is configured with a tuple of two to four
elements @code{(type, name [, feat [, mask]])}, where:


@itemize -

@item 
`type' is the algorithm type as string, e.g. @code{aead}, @code{hash},
@code{skcipher} or @code{rng}.

@item 
`name' is the algorithm name and operation mode as string, e.g.
@code{sha256}, @code{hmac(sha256)}, @code{cbc(aes)} or @code{drbg_nopr_ctr_aes256}.

@item 
`feat' and `mask' are unsigned 32bit integers.
@end itemize

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.38.

Some algorithm types require more recent Kernels.


Adicionado na versão 3.6.


@item 
@ref{b8c,,AF_VSOCK} allows communication between virtual machines and
their hosts. The sockets are represented as a @code{(CID, port)} tuple
where the context ID or CID and port are integers.

@ref{1ed8,,Disponibilidade}: Linux >= 3.9

See @code{vsock(7)@footnote{https://manpages.debian.org/vsock(7)}}


Adicionado na versão 3.7.


@item 
@ref{360c,,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' - String specifying the device name.

@item 
`proto' - The Ethernet protocol number.
May be @ref{18ab,,ETH_P_ALL} to capture all protocols,
one of the @ref{18ac,,ETHERTYPE_* constants}
or any other Ethernet protocol number.

@item 
`pkttype' - Optional integer specifying the packet type:


@itemize -

@item 
@code{PACKET_HOST} (the default) - Packet addressed to the local host.

@item 
@code{PACKET_BROADCAST} - Physical-layer broadcast packet.

@item 
@code{PACKET_MULTICAST} - Packet sent to a physical-layer multicast address.

@item 
@code{PACKET_OTHERHOST} - Packet to some other host that has been caught by
a device driver in promiscuous mode.

@item 
@code{PACKET_OUTGOING} - Packet originating from the local host that is
looped back to a packet socket.
@end itemize

@item 
`hatype' - Optional integer specifying the ARP hardware address type.

@item 
`addr' - Optional bytes-like object specifying the hardware physical
address, whose interpretation depends on the device.
@end itemize

@ref{1ed8,,Disponibilidade}: Linux >= 2.2.

@item 
@ref{360d,,AF_QIPCRTR} is a Linux-only socket based interface for communicating
with services running on co-processors in Qualcomm platforms. The address
family is represented as a @code{(node, port)} tuple where the `node' and `port'
are non-negative integers.

@ref{1ed8,,Disponibilidade}: Linux >= 4.7.


Adicionado na versão 3.8.


@item 
@code{IPPROTO_UDPLITE} is a variant of UDP which allows you to specify
what portion of a packet is covered with the checksum. It adds two socket
options that you can change.
@code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length)} will
change what portion of outgoing packets are covered by the checksum and
@code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length)} will
filter out packets which cover too little of their data. In both cases
@code{length} should be in @code{range(8, 2**16, 8)}.

Such a socket should be constructed with
@code{socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE)} for IPv4 or
@code{socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE)} for IPv6.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.20, FreeBSD >= 10.1


Adicionado na versão 3.9.


@item 
@ref{360e,,AF_HYPERV} is a Windows-only socket based interface for communicating
with Hyper-V hosts and guests. The address family is represented as a
@code{(vm_id, service_id)} tuple where the @code{vm_id} and @code{service_id} are
UUID strings.

The @code{vm_id} is the virtual machine identifier or a set of known VMID values
if the target is not a specific virtual machine. Known VMID constants
defined on @code{socket} are:


@itemize -

@item 
@code{HV_GUID_ZERO}

@item 
@code{HV_GUID_BROADCAST}

@item 
@code{HV_GUID_WILDCARD} - Used to bind on itself and accept connections from
all partitions.

@item 
@code{HV_GUID_CHILDREN} - Used to bind on itself and accept connection from
child partitions.

@item 
@code{HV_GUID_LOOPBACK} - Used as a target to itself.

@item 
@code{HV_GUID_PARENT} - When used as a bind accepts connection from the parent
partition. When used as an address target it will connect to the parent partition.
@end itemize

The @code{service_id} is the service identifier of the registered service.


Adicionado na versão 3.12.

@end itemize

If you use a hostname in the `host' portion of IPv4/v6 socket address, the
program may show a nondeterministic behavior, as Python uses the first address
returned from the DNS resolution.  The socket address will be resolved
differently into an actual IPv4/v6 address, depending on the results from DNS
resolution and/or the host configuration.  For deterministic behavior use a
numeric address in `host' portion.

All errors raise exceptions.  The normal exceptions for invalid argument types
and out-of-memory conditions can be raised. Errors
related to socket or address semantics raise @ref{417,,OSError} or one of its
subclasses.

Non-blocking mode is supported through @ref{2d1d,,setblocking()}.  A
generalization of this based on timeouts is supported through
@ref{360f,,settimeout()}.

@node Conteúdo do módulo<4>,Socket Objects,Famílias de soquete,socket — Interface de rede de baixo nível
@anchor{library/socket module-contents}@anchor{3610}
@subsubsection Conteúdo do módulo


The module @ref{cc,,socket} exports the following elements.

@menu
* Exceções: Exceções<15>. 
* Constantes: Constantes<8>. 
* Funções: Funções<8>. 

@end menu

@node Exceções<15>,Constantes<8>,,Conteúdo do módulo<4>
@anchor{library/socket exceptions}@anchor{3611}
@subsubsection Exceções


@geindex error
@anchor{library/socket socket error}@anchor{108e}
@deffn {Exceção} socket.error

Um apelido descontinuado de @ref{417,,OSError}.


Alterado na versão 3.3: Seguindo a 
@geindex Propostas de Melhorias do Python; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}, esta classe foi transformada em um apelido de @ref{417,,OSError}.

@end deffn

@geindex herror
@anchor{library/socket socket herror}@anchor{3612}
@deffn {Exceção} socket.herror

A subclass of @ref{417,,OSError}, this exception is raised for
address-related errors, i.e. for functions that use `h_errno' in the POSIX
C API, including @ref{1a11,,gethostbyname_ex()} and @ref{1a10,,gethostbyaddr()}.
The accompanying value is a pair @code{(h_errno, string)} representing an
error returned by a library call.  `h_errno' is a numeric value, while
`string' represents the description of `h_errno', as returned by the
@code{hstrerror()} C function.


Alterado na versão 3.3: This class was made a subclass of @ref{417,,OSError}.

@end deffn

@geindex gaierror
@anchor{library/socket socket gaierror}@anchor{184c}
@deffn {Exceção} socket.gaierror

A subclass of @ref{417,,OSError}, this exception is raised for
address-related errors by @ref{184b,,getaddrinfo()} and @ref{17b6,,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.


Alterado na versão 3.3: This class was made a subclass of @ref{417,,OSError}.

@end deffn

@geindex timeout
@anchor{library/socket socket timeout}@anchor{837}
@deffn {Exceção} socket.timeout

A deprecated alias of @ref{838,,TimeoutError}.

A subclass of @ref{417,,OSError}, this exception is raised when a timeout
occurs on a socket which has had timeouts enabled via a prior call to
@ref{360f,,settimeout()} (or implicitly through
@ref{3613,,setdefaulttimeout()}).  The accompanying value is a string
whose value is currently always “timed out”.


Alterado na versão 3.3: This class was made a subclass of @ref{417,,OSError}.



Alterado na versão 3.10: Esta classe foi feita como um apelido de @ref{838,,TimeoutError}.

@end deffn

@node Constantes<8>,Funções<8>,Exceções<15>,Conteúdo do módulo<4>
@anchor{library/socket constants}@anchor{3614}
@subsubsection Constantes


The AF_* and SOCK_* constants are now @code{AddressFamily} and
@code{SocketKind} @ref{d00,,IntEnum} collections.


Adicionado na versão 3.4.


@geindex AF_UNIX (no módulo socket)
@geindex AF_INET (no módulo socket)
@geindex AF_INET6 (no módulo socket)
@anchor{library/socket socket AF_UNIX}@anchor{193a}
@deffn {Dado} socket.AF_UNIX
@anchor{library/socket socket AF_INET}@anchor{1938}
@deffnx {Dado} socket.AF_INET
@anchor{library/socket socket AF_INET6}@anchor{1939}
@deffnx {Dado} socket.AF_INET6

These constants represent the address (and protocol) families, used for the
first argument to @ref{dc9,,socket()}.  If the @ref{193a,,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 (no módulo socket)
@anchor{library/socket socket AF_UNSPEC}@anchor{3551}
@deffn {Dado} socket.AF_UNSPEC

@ref{3551,,AF_UNSPEC} means that
@ref{184b,,getaddrinfo()} should return socket addresses for any
address family (either IPv4, IPv6, or any other) that can be used.
@end deffn

@geindex SOCK_STREAM (no módulo socket)
@geindex SOCK_DGRAM (no módulo socket)
@geindex SOCK_RAW (no módulo socket)
@geindex SOCK_RDM (no módulo socket)
@geindex SOCK_SEQPACKET (no módulo socket)
@anchor{library/socket socket SOCK_STREAM}@anchor{1337}
@deffn {Dado} socket.SOCK_STREAM
@anchor{library/socket socket SOCK_DGRAM}@anchor{1336}
@deffnx {Dado} socket.SOCK_DGRAM
@anchor{library/socket socket SOCK_RAW}@anchor{3615}
@deffnx {Dado} socket.SOCK_RAW
@anchor{library/socket socket SOCK_RDM}@anchor{3616}
@deffnx {Dado} socket.SOCK_RDM
@anchor{library/socket socket SOCK_SEQPACKET}@anchor{3617}
@deffnx {Dado} socket.SOCK_SEQPACKET

These constants represent the socket types, used for the second argument to
@ref{dc9,,socket()}.  More constants may be available depending on the system.
(Only @ref{1337,,SOCK_STREAM} and @ref{1336,,SOCK_DGRAM} appear to be generally
useful.)
@end deffn

@geindex SOCK_CLOEXEC (no módulo socket)
@geindex SOCK_NONBLOCK (no módulo socket)
@anchor{library/socket socket SOCK_CLOEXEC}@anchor{c25}
@deffn {Dado} socket.SOCK_CLOEXEC
@anchor{library/socket socket SOCK_NONBLOCK}@anchor{c24}
@deffnx {Dado} socket.SOCK_NONBLOCK

These two constants, if defined, can be combined with the socket types and
allow you to set some flags atomically (thus avoiding possible race
conditions and the need for separate calls).


@subsubheading Ver também


Secure File Descriptor Handling@footnote{https://udrepper.livejournal.com/20407.html}
for a more thorough explanation.


@ref{1ed8,,Disponibilidade}: Linux >= 2.6.27.


Adicionado na versão 3.2.

@end deffn

@geindex SOMAXCONN (no módulo socket)
@anchor{library/socket socket-unix-constants}@anchor{b8b}
@deffn {Dado} SO_*
@anchor{library/socket socket SOMAXCONN}@anchor{e8e}
@deffnx {Dado} socket.SOMAXCONN

@deffnx {Dado} MSG_*

@deffnx {Dado} SOL_*

@deffnx {Dado} SCM_*

@deffnx {Dado} IPPROTO_*

@deffnx {Dado} IPPORT_*

@deffnx {Dado} INADDR_*

@deffnx {Dado} IP_*

@deffnx {Dado} IPV6_*

@deffnx {Dado} EAI_*

@deffnx {Dado} AI_*

@deffnx {Dado} NI_*

@deffnx {Dado} 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{cf6,,setsockopt()} and @ref{cf5,,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.


Alterado na versão 3.6: @code{SO_DOMAIN}, @code{SO_PROTOCOL}, @code{SO_PEERSEC}, @code{SO_PASSSEC},
@code{TCP_USER_TIMEOUT}, @code{TCP_CONGESTION} were added.



Alterado na versão 3.6.5: On Windows, @code{TCP_FASTOPEN}, @code{TCP_KEEPCNT} appear if run-time Windows
supports.



Alterado na versão 3.7: @code{TCP_NOTSENT_LOWAT} was added.

On Windows, @code{TCP_KEEPIDLE}, @code{TCP_KEEPINTVL} appear if run-time Windows
supports.



Alterado na versão 3.10: @code{IP_RECVTOS} was added.
 Added @code{TCP_KEEPALIVE}. On MacOS this constant can be used in the same
 way that @code{TCP_KEEPIDLE} is used on Linux.



Alterado na versão 3.11: Added @code{TCP_CONNECTION_INFO}. On MacOS this constant can be used in the
same way that @code{TCP_INFO} is used on Linux and BSD.



Alterado na versão 3.12: Added @code{SO_RTABLE} and @code{SO_USER_COOKIE}. On OpenBSD
and FreeBSD respectively those constants can be used in the same way that
@code{SO_MARK} is used on Linux. Also added 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}.
Added @code{IP_PKTINFO}, @code{IP_UNBLOCK_SOURCE}, @code{IP_BLOCK_SOURCE},
@code{IP_ADD_SOURCE_MEMBERSHIP}, @code{IP_DROP_SOURCE_MEMBERSHIP}.



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

@end deffn

@geindex AF_CAN (no módulo socket)
@geindex PF_CAN (no módulo socket)
@anchor{library/socket socket AF_CAN}@anchor{360a}
@deffn {Dado} socket.AF_CAN
@anchor{library/socket socket PF_CAN}@anchor{3618}
@deffnx {Dado} socket.PF_CAN

@deffnx {Dado} SOL_CAN_*

@deffnx {Dado} CAN_*

Many constants of these forms, documented in the Linux documentation, are
also defined in the socket module.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.25, NetBSD >= 8.


Adicionado na versão 3.3.



Alterado na versão 3.11: NetBSD support was added.



Alterado na versão 3.13.4: Restored missing @code{CAN_RAW_ERR_FILTER} on Linux.

@end deffn

@geindex CAN_BCM (no módulo socket)
@anchor{library/socket socket CAN_BCM}@anchor{fd7}
@deffn {Dado} socket.CAN_BCM

@deffnx {Dado} CAN_BCM_*

CAN_BCM, in the CAN protocol family, is the broadcast manager (BCM) protocol.
Broadcast manager constants, documented in the Linux documentation, are also
defined in the socket module.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.25.

@cartouche
@quotation Nota 
The @code{CAN_BCM_CAN_FD_FRAME} flag is only available on Linux >= 4.8.
@end quotation
@end cartouche


Adicionado na versão 3.4.

@end deffn

@geindex CAN_RAW_FD_FRAMES (no módulo socket)
@anchor{library/socket socket CAN_RAW_FD_FRAMES}@anchor{ef9}
@deffn {Dado} socket.CAN_RAW_FD_FRAMES

Enables CAN FD support in a CAN_RAW socket. This is disabled by default.
This allows your application to send both CAN and CAN FD frames; however,
you must accept both CAN and CAN FD frames when reading from the socket.

This constant is documented in the Linux documentation.

@ref{1ed8,,Disponibilidade}: Linux >= 3.6.


Adicionado na versão 3.5.

@end deffn

@geindex CAN_RAW_JOIN_FILTERS (no módulo socket)
@anchor{library/socket socket CAN_RAW_JOIN_FILTERS}@anchor{938}
@deffn {Dado} socket.CAN_RAW_JOIN_FILTERS

Joins the applied CAN filters such that only CAN frames that match all
given CAN filters are passed to user space.

This constant is documented in the Linux documentation.

@ref{1ed8,,Disponibilidade}: Linux >= 4.1.


Adicionado na versão 3.9.

@end deffn

@geindex CAN_ISOTP (no módulo socket)
@anchor{library/socket socket CAN_ISOTP}@anchor{360b}
@deffn {Dado} socket.CAN_ISOTP

CAN_ISOTP, in the CAN protocol family, is the ISO-TP (ISO 15765-2) protocol.
ISO-TP constants, documented in the Linux documentation.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.25.


Adicionado na versão 3.7.

@end deffn

@geindex CAN_J1939 (no módulo socket)
@anchor{library/socket socket CAN_J1939}@anchor{939}
@deffn {Dado} socket.CAN_J1939

CAN_J1939, in the CAN protocol family, is the SAE J1939 protocol.
J1939 constants, documented in the Linux documentation.

@ref{1ed8,,Disponibilidade}: Linux >= 5.4.


Adicionado na versão 3.9.

@end deffn

@geindex AF_DIVERT (no módulo socket)
@geindex PF_DIVERT (no módulo socket)
@anchor{library/socket socket AF_DIVERT}@anchor{3619}
@deffn {Dado} socket.AF_DIVERT
@anchor{library/socket socket PF_DIVERT}@anchor{361a}
@deffnx {Dado} socket.PF_DIVERT

These two constants, documented in the FreeBSD divert(4) manual page, are
also defined in the socket module.

@ref{1ed8,,Disponibilidade}: FreeBSD >= 14.0.


Adicionado na versão 3.12.

@end deffn

@geindex AF_PACKET (no módulo socket)
@geindex PF_PACKET (no módulo socket)
@anchor{library/socket socket AF_PACKET}@anchor{360c}
@deffn {Dado} socket.AF_PACKET
@anchor{library/socket socket PF_PACKET}@anchor{361b}
@deffnx {Dado} socket.PF_PACKET

@deffnx {Dado} PACKET_*

Many constants of these forms, documented in the Linux documentation, are
also defined in the socket module.

@ref{1ed8,,Disponibilidade}: Linux >= 2.2.
@end deffn

@geindex ETH_P_ALL (no módulo socket)
@anchor{library/socket socket ETH_P_ALL}@anchor{18ab}
@deffn {Dado} socket.ETH_P_ALL

@code{ETH_P_ALL} can be used in the @ref{dc9,,socket}
constructor as `proto' for the @ref{360c,,AF_PACKET} family in order to
capture every packet, regardless of protocol.

For more information, see the @code{packet(7)@footnote{https://manpages.debian.org/packet(7)}} manpage.

@ref{1ed8,,Disponibilidade}: Linux.


Adicionado na versão 3.12.

@end deffn

@geindex AF_RDS (no módulo socket)
@geindex PF_RDS (no módulo socket)
@geindex SOL_RDS (no módulo socket)
@anchor{library/socket socket AF_RDS}@anchor{361c}
@deffn {Dado} socket.AF_RDS
@anchor{library/socket socket PF_RDS}@anchor{361d}
@deffnx {Dado} socket.PF_RDS
@anchor{library/socket socket SOL_RDS}@anchor{361e}
@deffnx {Dado} socket.SOL_RDS

@deffnx {Dado} RDS_*

Many constants of these forms, documented in the Linux documentation, are
also defined in the socket module.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.30.


Adicionado na versão 3.3.

@end deffn

@geindex SIO_RCVALL (no módulo socket)
@geindex SIO_KEEPALIVE_VALS (no módulo socket)
@geindex SIO_LOOPBACK_FAST_PATH (no módulo socket)
@anchor{library/socket socket SIO_RCVALL}@anchor{361f}
@deffn {Dado} socket.SIO_RCVALL
@anchor{library/socket socket SIO_KEEPALIVE_VALS}@anchor{3620}
@deffnx {Dado} socket.SIO_KEEPALIVE_VALS
@anchor{library/socket socket SIO_LOOPBACK_FAST_PATH}@anchor{cf4}
@deffnx {Dado} socket.SIO_LOOPBACK_FAST_PATH

@deffnx {Dado} RCVALL_*

Constants for Windows’ WSAIoctl(). The constants are used as arguments to the
@ref{cf3,,ioctl()} method of socket objects.


Alterado na versão 3.6: @code{SIO_LOOPBACK_FAST_PATH} was added.

@end deffn


@deffn {Dado} TIPC_*

TIPC related constants, matching the ones exported by the C socket API. See
the TIPC documentation for more information.
@end deffn

@geindex AF_ALG (no módulo socket)
@geindex SOL_ALG (no módulo socket)
@anchor{library/socket socket AF_ALG}@anchor{cf7}
@deffn {Dado} socket.AF_ALG
@anchor{library/socket socket SOL_ALG}@anchor{3621}
@deffnx {Dado} socket.SOL_ALG

@deffnx {Dado} ALG_*

Constants for Linux Kernel cryptography.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.38.


Adicionado na versão 3.6.

@end deffn

@geindex AF_VSOCK (no módulo socket)
@geindex IOCTL_VM_SOCKETS_GET_LOCAL_CID (no módulo socket)
@anchor{library/socket socket AF_VSOCK}@anchor{b8c}
@deffn {Dado} socket.AF_VSOCK
@anchor{library/socket socket IOCTL_VM_SOCKETS_GET_LOCAL_CID}@anchor{3622}
@deffnx {Dado} socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID

@deffnx {Dado} VMADDR*

@deffnx {Dado} SO_VM*

Constants for Linux host/guest communication.

@ref{1ed8,,Disponibilidade}: Linux >= 4.8.


Adicionado na versão 3.7.

@end deffn

@geindex AF_LINK (no módulo socket)
@anchor{library/socket socket AF_LINK}@anchor{fd8}
@deffn {Dado} socket.AF_LINK

@ref{1ed8,,Disponibilidade}: BSD, macOS.


Adicionado na versão 3.4.

@end deffn

@geindex has_ipv6 (no módulo socket)
@anchor{library/socket socket has_ipv6}@anchor{3623}
@deffn {Dado} socket.has_ipv6

This constant contains a boolean value which indicates if IPv6 is supported on
this platform.
@end deffn

@geindex BDADDR_ANY (no módulo socket)
@geindex BDADDR_LOCAL (no módulo socket)
@anchor{library/socket socket BDADDR_ANY}@anchor{3624}
@deffn {Dado} socket.BDADDR_ANY
@anchor{library/socket socket BDADDR_LOCAL}@anchor{3625}
@deffnx {Dado} socket.BDADDR_LOCAL

These are string constants containing Bluetooth addresses with special
meanings. For example, @ref{3624,,BDADDR_ANY} can be used to indicate
any address when specifying the binding socket with
@code{BTPROTO_RFCOMM}.
@end deffn

@geindex HCI_FILTER (no módulo socket)
@geindex HCI_TIME_STAMP (no módulo socket)
@geindex HCI_DATA_DIR (no módulo socket)
@anchor{library/socket socket HCI_FILTER}@anchor{3626}
@deffn {Dado} socket.HCI_FILTER
@anchor{library/socket socket HCI_TIME_STAMP}@anchor{3627}
@deffnx {Dado} socket.HCI_TIME_STAMP
@anchor{library/socket socket HCI_DATA_DIR}@anchor{3628}
@deffnx {Dado} socket.HCI_DATA_DIR

For use with @code{BTPROTO_HCI}. @code{HCI_FILTER} is only
available on Linux and FreeBSD. @code{HCI_TIME_STAMP} and
@code{HCI_DATA_DIR} are only available on Linux.
@end deffn

@geindex AF_QIPCRTR (no módulo socket)
@anchor{library/socket socket AF_QIPCRTR}@anchor{360d}
@deffn {Dado} socket.AF_QIPCRTR

Constant for Qualcomm’s IPC router protocol, used to communicate with
service providing remote processors.

@ref{1ed8,,Disponibilidade}: Linux >= 4.7.
@end deffn

@geindex SCM_CREDS2 (no módulo socket)
@geindex LOCAL_CREDS (no módulo socket)
@geindex LOCAL_CREDS_PERSISTENT (no módulo socket)
@anchor{library/socket socket SCM_CREDS2}@anchor{3629}
@deffn {Dado} socket.SCM_CREDS2
@anchor{library/socket socket LOCAL_CREDS}@anchor{362a}
@deffnx {Dado} socket.LOCAL_CREDS
@anchor{library/socket socket LOCAL_CREDS_PERSISTENT}@anchor{362b}
@deffnx {Dado} socket.LOCAL_CREDS_PERSISTENT

LOCAL_CREDS and LOCAL_CREDS_PERSISTENT can be used
with SOCK_DGRAM, SOCK_STREAM sockets, equivalent to
Linux/DragonFlyBSD SO_PASSCRED, while LOCAL_CREDS
sends the credentials at first read, LOCAL_CREDS_PERSISTENT
sends for each read, SCM_CREDS2 must be then used for
the latter for the message type.


Adicionado na versão 3.11.


@ref{1ed8,,Disponibilidade}: FreeBSD.
@end deffn

@geindex SO_INCOMING_CPU (no módulo socket)
@anchor{library/socket socket SO_INCOMING_CPU}@anchor{362c}
@deffn {Dado} socket.SO_INCOMING_CPU

Constant to optimize CPU locality, to be used in conjunction with
@code{SO_REUSEPORT}.


Adicionado na versão 3.11.


@ref{1ed8,,Disponibilidade}: Linux >= 3.9
@end deffn

@geindex AF_HYPERV (no módulo socket)
@geindex HV_PROTOCOL_RAW (no módulo socket)
@geindex HVSOCKET_CONNECT_TIMEOUT (no módulo socket)
@geindex HVSOCKET_CONNECT_TIMEOUT_MAX (no módulo socket)
@geindex HVSOCKET_CONNECTED_SUSPEND (no módulo socket)
@geindex HVSOCKET_ADDRESS_FLAG_PASSTHRU (no módulo socket)
@geindex HV_GUID_ZERO (no módulo socket)
@geindex HV_GUID_WILDCARD (no módulo socket)
@geindex HV_GUID_BROADCAST (no módulo socket)
@geindex HV_GUID_CHILDREN (no módulo socket)
@geindex HV_GUID_LOOPBACK (no módulo socket)
@geindex HV_GUID_PARENT (no módulo socket)
@anchor{library/socket socket AF_HYPERV}@anchor{360e}
@deffn {Dado} socket.AF_HYPERV
@anchor{library/socket socket HV_PROTOCOL_RAW}@anchor{362d}
@deffnx {Dado} socket.HV_PROTOCOL_RAW
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT}@anchor{362e}
@deffnx {Dado} socket.HVSOCKET_CONNECT_TIMEOUT
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT_MAX}@anchor{362f}
@deffnx {Dado} socket.HVSOCKET_CONNECT_TIMEOUT_MAX
@anchor{library/socket socket HVSOCKET_CONNECTED_SUSPEND}@anchor{3630}
@deffnx {Dado} socket.HVSOCKET_CONNECTED_SUSPEND
@anchor{library/socket socket HVSOCKET_ADDRESS_FLAG_PASSTHRU}@anchor{3631}
@deffnx {Dado} socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU
@anchor{library/socket socket HV_GUID_ZERO}@anchor{3632}
@deffnx {Dado} socket.HV_GUID_ZERO
@anchor{library/socket socket HV_GUID_WILDCARD}@anchor{3633}
@deffnx {Dado} socket.HV_GUID_WILDCARD
@anchor{library/socket socket HV_GUID_BROADCAST}@anchor{3634}
@deffnx {Dado} socket.HV_GUID_BROADCAST
@anchor{library/socket socket HV_GUID_CHILDREN}@anchor{3635}
@deffnx {Dado} socket.HV_GUID_CHILDREN
@anchor{library/socket socket HV_GUID_LOOPBACK}@anchor{3636}
@deffnx {Dado} socket.HV_GUID_LOOPBACK
@anchor{library/socket socket HV_GUID_PARENT}@anchor{3637}
@deffnx {Dado} socket.HV_GUID_PARENT

Constants for Windows Hyper-V sockets for host/guest communications.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.12.

@end deffn

@geindex ETHERTYPE_ARP (no módulo socket)
@geindex ETHERTYPE_IP (no módulo socket)
@geindex ETHERTYPE_IPV6 (no módulo socket)
@geindex ETHERTYPE_VLAN (no módulo socket)
@anchor{library/socket socket-ethernet-types}@anchor{18ac}@anchor{library/socket socket ETHERTYPE_ARP}@anchor{3638}
@deffn {Dado} socket.ETHERTYPE_ARP
@anchor{library/socket socket ETHERTYPE_IP}@anchor{3639}
@deffnx {Dado} socket.ETHERTYPE_IP
@anchor{library/socket socket ETHERTYPE_IPV6}@anchor{363a}
@deffnx {Dado} socket.ETHERTYPE_IPV6
@anchor{library/socket socket ETHERTYPE_VLAN}@anchor{363b}
@deffnx {Dado} socket.ETHERTYPE_VLAN

IEEE 802.3 protocol number@footnote{https://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.txt}.
constants.

@ref{1ed8,,Disponibilidade}: Linux, FreeBSD, macOS.


Adicionado na versão 3.12.

@end deffn

@geindex SHUT_RD (no módulo socket)
@geindex SHUT_WR (no módulo socket)
@geindex SHUT_RDWR (no módulo socket)
@anchor{library/socket socket SHUT_RD}@anchor{363c}
@deffn {Dado} socket.SHUT_RD
@anchor{library/socket socket SHUT_WR}@anchor{363d}
@deffnx {Dado} socket.SHUT_WR
@anchor{library/socket socket SHUT_RDWR}@anchor{363e}
@deffnx {Dado} socket.SHUT_RDWR

These constants are used by the @ref{363f,,shutdown()} method of socket objects.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@node Funções<8>,,Constantes<8>,Conteúdo do módulo<4>
@anchor{library/socket functions}@anchor{3640}
@subsubsection Funções


@menu
* Criação de sockets:: 
* Outras funções: Outras funções<2>. 

@end menu

@node Criação de sockets,Outras funções<2>,,Funções<8>
@anchor{library/socket creating-sockets}@anchor{3641}
@subsubsection Criação de sockets


The following functions all create @ref{3642,,socket objects}.

@geindex socket (classe em socket)
@anchor{library/socket socket socket}@anchor{dc9}
@deffn {Classe} socket.socket (family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)

Create a new socket using the given address family, socket type and protocol
number.  The address family should be @ref{1938,,AF_INET} (the default),
@ref{1939,,AF_INET6}, @ref{193a,,AF_UNIX}, @ref{360a,,AF_CAN}, @ref{360c,,AF_PACKET},
or @ref{361c,,AF_RDS}. The socket type should be @ref{1337,,SOCK_STREAM} (the
default), @ref{1336,,SOCK_DGRAM}, @ref{3615,,SOCK_RAW} or perhaps one of the other
@code{SOCK_} constants. The protocol number is usually zero and may be omitted
or in the case where the address family is @ref{360a,,AF_CAN} the protocol
should be one of @code{CAN_RAW}, @ref{fd7,,CAN_BCM}, @ref{360b,,CAN_ISOTP} or
@ref{939,,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{3590,,socket.getpeername()} but not the actual OS resource.  Unlike
@ref{3643,,socket.fromfd()}, `fileno' will return the same socket and not a
duplicate. This may help close a detached socket using
@ref{b89,,socket.close()}.

The newly created socket is @ref{f2b,,non-inheritable}.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.__new__} com os argumentos @code{self}, @code{family}, @code{type}, @code{protocol}.


Alterado na versão 3.3: The AF_CAN family was added.
The AF_RDS family was added.



Alterado na versão 3.4: The CAN_BCM protocol was added.



Alterado na versão 3.4: The returned socket is now non-inheritable.



Alterado na versão 3.7: The CAN_ISOTP protocol was added.



Alterado na versão 3.7: When @ref{c24,,SOCK_NONBLOCK} or @ref{c25,,SOCK_CLOEXEC}
bit flags are applied to `type' they are cleared, and
@ref{c26,,socket.type} will not reflect them.  They are still passed
to the underlying system @code{socket()} call.  Therefore,

@example
sock = socket.socket(
    socket.AF_INET,
    socket.SOCK_STREAM | socket.SOCK_NONBLOCK)
@end example

will still create a non-blocking socket on OSes that support
@code{SOCK_NONBLOCK}, but @code{sock.type} will be set to
@code{socket.SOCK_STREAM}.



Alterado na versão 3.9: The CAN_J1939 protocol was added.



Alterado na versão 3.10: The IPPROTO_MPTCP protocol was added.

@end deffn

@geindex socketpair() (no módulo socket)
@anchor{library/socket socket socketpair}@anchor{c10}
@deffn {Função} 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{dc9,,socket()} function above. The default family is @ref{193a,,AF_UNIX}
if defined on the platform; otherwise, the default is @ref{1938,,AF_INET}.

The newly created sockets are @ref{f2b,,non-inheritable}.


Alterado na versão 3.2: The returned socket objects now support the whole socket API, rather
than a subset.



Alterado na versão 3.4: The returned sockets are now non-inheritable.



Alterado na versão 3.5: Windows support added.

@end deffn

@geindex create_connection() (no módulo socket)
@anchor{library/socket socket create_connection}@anchor{672}
@deffn {Função} socket.create_connection (address, timeout=GLOBAL_DEFAULT, source_address=None, *, all_errors=False)

Connect to a TCP service listening on the internet `address' (a 2-tuple
@code{(host, port)}), and return the socket object.  This is a higher-level
function than @ref{dcb,,socket.connect()}: if `host' is a non-numeric hostname,
it will try to resolve it for both @ref{1938,,AF_INET} and @ref{1939,,AF_INET6},
and then try to connect to all possible addresses in turn until a
connection succeeds.  This makes it easy to write clients that are
compatible to both IPv4 and IPv6.

Passing the optional `timeout' parameter will set the timeout on the
socket instance before attempting to connect.  If no `timeout' is
supplied, the global default timeout setting returned by
@ref{3644,,getdefaulttimeout()} is used.

If supplied, `source_address' must be a 2-tuple @code{(host, port)} for the
socket to bind to as its source address before connecting.  If host or port
are ‘’ or 0 respectively the OS default behavior will be used.

When a connection cannot be created, an exception is raised. By default,
it is the exception from the last address in the list. If `all_errors'
is @code{True}, it is an @ref{1b6,,ExceptionGroup} containing the errors of all
attempts.


Alterado na versão 3.2: `source_address' foi adicionado.



Alterado na versão 3.11: `all_errors' was added.

@end deffn

@geindex create_server() (no módulo socket)
@anchor{library/socket socket create_server}@anchor{a35}
@deffn {Função} socket.create_server (address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)

Convenience function which creates a TCP socket bound to `address' (a 2-tuple
@code{(host, port)}) and returns the socket object.

`family' should be either @ref{1938,,AF_INET} or @ref{1939,,AF_INET6}.
`backlog' is the queue size passed to @ref{e8d,,socket.listen()}; if not specified
, a default reasonable value is chosen.
`reuse_port' dictates whether to set the @code{SO_REUSEPORT} socket option.

If `dualstack_ipv6' is true, `family' is @ref{1939,,AF_INET6} and the platform
supports it the socket will be able to accept both IPv4 and IPv6 connections,
else it will raise @ref{202,,ValueError}. Most POSIX platforms and Windows are
supposed to support this functionality.
When this functionality is enabled the address returned by
@ref{3590,,socket.getpeername()} when an IPv4 connection occurs will be an IPv6
address represented as an IPv4-mapped IPv6 address.
If `dualstack_ipv6' is false it will explicitly disable this functionality
on platforms that enable it by default (e.g. Linux).
This parameter can be used in conjunction with @ref{a36,,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 
On POSIX platforms the @code{SO_REUSEADDR} socket option is set in order to
immediately reuse previous sockets which were bound on the same `address'
and remained in TIME_WAIT state.
@end quotation
@end cartouche


Adicionado na versão 3.8.

@end deffn

@geindex has_dualstack_ipv6() (no módulo socket)
@anchor{library/socket socket has_dualstack_ipv6}@anchor{a36}
@deffn {Função} socket.has_dualstack_ipv6 ()

Return @code{True} if the platform supports creating a TCP socket which can
handle both IPv4 and IPv6 connections.


Adicionado na versão 3.8.

@end deffn

@geindex fromfd() (no módulo socket)
@anchor{library/socket socket fromfd}@anchor{3643}
@deffn {Função} socket.fromfd (fd, family, type, proto=0)

Duplicate the file descriptor `fd' (an integer as returned by a file object’s
@ref{15d0,,fileno()} method) and build a socket object from the result.  Address
family, socket type and protocol number are as for the @ref{dc9,,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.

The newly created socket is @ref{f2b,,non-inheritable}.


Alterado na versão 3.4: The returned socket is now non-inheritable.

@end deffn

@geindex fromshare() (no módulo socket)
@anchor{library/socket socket fromshare}@anchor{c21}
@deffn {Função} socket.fromshare (data)

Instantiate a socket from data obtained from the @ref{c22,,socket.share()}
method.  The socket is assumed to be in blocking mode.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.3.

@end deffn

@geindex SocketType (no módulo socket)
@anchor{library/socket socket SocketType}@anchor{3645}
@deffn {Dado} socket.SocketType

This is a Python type object that represents the socket object type. It is the
same as @code{type(socket(...))}.
@end deffn

@node Outras funções<2>,,Criação de sockets,Funções<8>
@anchor{library/socket other-functions}@anchor{3646}
@subsubsection Outras funções


The @ref{cc,,socket} module also offers various network-related services:

@geindex close() (no módulo socket)
@anchor{library/socket socket close}@anchor{b89}
@deffn {Função} socket.close (fd)

Close a socket file descriptor. This is like @ref{b8a,,os.close()}, but for
sockets. On some platforms (most noticeable Windows) @ref{b8a,,os.close()}
does not work for socket file descriptors.


Adicionado na versão 3.7.

@end deffn

@geindex getaddrinfo() (no módulo socket)
@anchor{library/socket socket getaddrinfo}@anchor{184b}
@deffn {Função} 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.

Translate the `host'/`port' argument into a sequence of 5-tuples that contain
all the necessary arguments for creating a socket connected to that service.
`host' is a domain name, a string representation of an IPv4/v6 address
or @code{None}. `port' is a string service name such as @code{'http'}, a numeric
port number or @code{None}.  By passing @code{None} as the value of `host'
and `port', you can pass @code{NULL} to the underlying C API.

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{3551,,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.

The function returns a list of 5-tuples with the following structure:

@code{(family, type, proto, canonname, sockaddr)}

In these tuples, `family', `type', `proto' are all integers and are
meant to be passed to the @ref{dc9,,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{1938,,AF_INET}, a @code{(address, port, flowinfo, scope_id)} 4-tuple for
@ref{1939,,AF_INET6}), and is meant to be passed to the @ref{dcb,,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{1337,,SOCK_STREAM} or
@ref{1336,,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 connection 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

Levanta um @ref{19fa,,evento de auditoria} @code{socket.getaddrinfo} com os argumentos @code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}.

The following example fetches address information for a hypothetical TCP
connection to @code{example.org} on port 80 (results may differ on your
system if IPv6 isn’t enabled):

@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


Alterado na versão 3.2: parameters can now be passed using keyword arguments.



Alterado na versão 3.7: for IPv6 multicast addresses, string representing an address will not
contain @code{%scope_id} part.

@end deffn

@geindex getfqdn() (no módulo socket)
@anchor{library/socket socket getfqdn}@anchor{1875}
@deffn {Função} socket.getfqdn ([name])

Return a fully qualified domain name for `name'. If `name' is omitted or empty,
it is interpreted as the local host.  To find the fully qualified name, the
hostname returned by @ref{1a10,,gethostbyaddr()} is checked, followed by aliases for the
host, if available.  The first name which includes a period is selected.  In
case no fully qualified domain name is available and `name' was provided,
it is returned unchanged.  If `name' was empty or equal to @code{'0.0.0.0'},
the hostname from @ref{2d06,,gethostname()} is returned.
@end deffn

@geindex gethostbyname() (no módulo socket)
@anchor{library/socket socket gethostbyname}@anchor{3647}
@deffn {Função} socket.gethostbyname (hostname)

Translate a host name to IPv4 address format.  The IPv4 address is returned as a
string, such as  @code{'100.50.200.5'}.  If the host name is an IPv4 address itself
it is returned unchanged.  See @ref{1a11,,gethostbyname_ex()} for a more complete
interface. @ref{3647,,gethostbyname()} does not support IPv6 name resolution, and
@ref{184b,,getaddrinfo()} should be used instead for IPv4/v6 dual stack support.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.gethostbyname} com o argumento @code{hostname}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex gethostbyname_ex() (no módulo socket)
@anchor{library/socket socket gethostbyname_ex}@anchor{1a11}
@deffn {Função} socket.gethostbyname_ex (hostname)

Translate a host name to IPv4 address format, extended interface. Return a
3-tuple @code{(hostname, aliaslist, ipaddrlist)} where `hostname' is the host’s
primary host name, `aliaslist' is a (possibly
empty) list of alternative host names for the same address, and `ipaddrlist' is
a list of IPv4 addresses for the same interface on the same host (often but not
always a single address). @ref{1a11,,gethostbyname_ex()} does not support IPv6 name
resolution, and @ref{184b,,getaddrinfo()} should be used instead for IPv4/v6 dual
stack support.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.gethostbyname} com o argumento @code{hostname}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex gethostname() (no módulo socket)
@anchor{library/socket socket gethostname}@anchor{2d06}
@deffn {Função} socket.gethostname ()

Return a string containing the hostname of the machine where  the Python
interpreter is currently executing.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.gethostname} sem argumentos.

Note: @ref{2d06,,gethostname()} doesn’t always return the fully qualified domain
name; use @ref{1875,,getfqdn()} for that.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex gethostbyaddr() (no módulo socket)
@anchor{library/socket socket gethostbyaddr}@anchor{1a10}
@deffn {Função} socket.gethostbyaddr (ip_address)

Return a 3-tuple @code{(hostname, aliaslist, ipaddrlist)} where `hostname' is the
primary host name responding to the given `ip_address', `aliaslist' is a
(possibly empty) list of alternative host names for the same address, and
`ipaddrlist' is a list of IPv4/v6 addresses for the same interface on the same
host (most likely containing only a single address). To find the fully qualified
domain name, use the function @ref{1875,,getfqdn()}. @ref{1a10,,gethostbyaddr()} supports
both IPv4 and IPv6.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.gethostbyaddr} com o argumento @code{ip_address}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex getnameinfo() (no módulo socket)
@anchor{library/socket socket getnameinfo}@anchor{17b6}
@deffn {Função} socket.getnameinfo (sockaddr, flags)

Translate a socket address `sockaddr' into a 2-tuple @code{(host, port)}. Depending
on the settings of `flags', the result can contain a fully qualified domain name
or numeric address representation in `host'.  Similarly, `port' can contain a
string port name or a numeric port number.

For IPv6 addresses, @code{%scope_id} is appended to the host part if `sockaddr'
contains meaningful `scope_id'. Usually this happens for multicast addresses.

For more information about `flags' you can consult @code{getnameinfo(3)@footnote{https://manpages.debian.org/getnameinfo(3)}}.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.getnameinfo} com o argumento @code{sockaddr}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex getprotobyname() (no módulo socket)
@anchor{library/socket socket getprotobyname}@anchor{3648}
@deffn {Função} 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{dc9,,socket()}
function.  This is usually only needed for sockets opened in “raw” mode
(@ref{3615,,SOCK_RAW}); for the normal socket modes, the correct protocol is chosen
automatically if the protocol is omitted or zero.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex getservbyname() (no módulo socket)
@anchor{library/socket socket getservbyname}@anchor{3649}
@deffn {Função} socket.getservbyname (servicename[, protocolname])

Translate an internet service name and protocol name to a port number for that
service.  The optional protocol name, if given, should be @code{'tcp'} or
@code{'udp'}, otherwise any protocol will match.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.getservbyname} com os argumentos @code{servicename}, @code{protocolname}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex getservbyport() (no módulo socket)
@anchor{library/socket socket getservbyport}@anchor{364a}
@deffn {Função} socket.getservbyport (port[, protocolname])

Translate an internet port number and protocol name to a service name for that
service.  The optional protocol name, if given, should be @code{'tcp'} or
@code{'udp'}, otherwise any protocol will match.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.getservbyport} com os argumentos @code{port} e @code{protocolname}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex ntohl() (no módulo socket)
@anchor{library/socket socket ntohl}@anchor{364b}
@deffn {Função} socket.ntohl (x)

Convert 32-bit positive integers from network to host byte order.  On machines
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 4-byte swap operation.
@end deffn

@geindex ntohs() (no módulo socket)
@anchor{library/socket socket ntohs}@anchor{884}
@deffn {Função} socket.ntohs (x)

Convert 16-bit positive integers from network to host byte order.  On machines
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 2-byte swap operation.


Alterado na versão 3.10: Raises @ref{885,,OverflowError} if `x' does not fit in a 16-bit unsigned
integer.

@end deffn

@geindex htonl() (no módulo socket)
@anchor{library/socket socket htonl}@anchor{364c}
@deffn {Função} socket.htonl (x)

Convert 32-bit positive integers from host to network byte order.  On machines
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 4-byte swap operation.
@end deffn

@geindex htons() (no módulo socket)
@anchor{library/socket socket htons}@anchor{883}
@deffn {Função} socket.htons (x)

Convert 16-bit positive integers from host to network byte order.  On machines
where the host byte order is the same as network byte order, this is a no-op;
otherwise, it performs a 2-byte swap operation.


Alterado na versão 3.10: Raises @ref{885,,OverflowError} if `x' does not fit in a 16-bit unsigned
integer.

@end deffn

@geindex inet_aton() (no módulo socket)
@anchor{library/socket socket inet_aton}@anchor{968}
@deffn {Função} socket.inet_aton (ip_string)

Convert an IPv4 address from dotted-quad string format (for example,
‘123.45.67.89’) to 32-bit packed binary format, as a bytes object four characters in
length.  This is useful when conversing with a program that uses the standard C
library and needs objects of type @code{in_addr}, which is the C type
for the 32-bit packed binary this function returns.

@ref{968,,inet_aton()} also accepts strings with less than three dots; see the
Unix manual page @code{inet(3)@footnote{https://manpages.debian.org/inet(3)}} for details.

If the IPv4 address string passed to this function is invalid,
@ref{417,,OSError} will be raised. Note that exactly what is valid depends on
the underlying C implementation of @code{inet_aton()}.

@ref{968,,inet_aton()} does not support IPv6, and @ref{969,,inet_pton()} should be used
instead for IPv4/v6 dual stack support.
@end deffn

@geindex inet_ntoa() (no módulo socket)
@anchor{library/socket socket inet_ntoa}@anchor{364d}
@deffn {Função} socket.inet_ntoa (packed_ip)

Convert a 32-bit packed IPv4 address (a @ref{d4f,,bytes-like object} four
bytes in length) to its standard dotted-quad string representation (for example,
‘123.45.67.89’).  This is useful when conversing with a program that uses the
standard C library and needs objects of type @code{in_addr}, which
is the C type for the 32-bit packed binary data this function takes as an
argument.

If the byte sequence passed to this function is not exactly 4 bytes in
length, @ref{417,,OSError} will be raised. @ref{364d,,inet_ntoa()} does not
support IPv6, and @ref{fd9,,inet_ntop()} should be used instead for IPv4/v6 dual
stack support.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@end deffn

@geindex inet_pton() (no módulo socket)
@anchor{library/socket socket inet_pton}@anchor{969}
@deffn {Função} socket.inet_pton (address_family, ip_string)

Convert an IP address from its family-specific string format to a packed,
binary format. @ref{969,,inet_pton()} is useful when a library or network protocol
calls for an object of type @code{in_addr} (similar to
@ref{968,,inet_aton()}) or @code{in6_addr}.

Supported values for `address_family' are currently @ref{1938,,AF_INET} and
@ref{1939,,AF_INET6}. If the IP address string `ip_string' is invalid,
@ref{417,,OSError} will be raised. Note that exactly what is valid depends on
both the value of `address_family' and the underlying implementation of
@code{inet_pton()}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.4: Suporte para Windows adicionado.

@end deffn

@geindex inet_ntop() (no módulo socket)
@anchor{library/socket socket inet_ntop}@anchor{fd9}
@deffn {Função} socket.inet_ntop (address_family, packed_ip)

Convert a packed IP address (a @ref{d4f,,bytes-like object} of some number of
bytes) to its standard, family-specific string representation (for
example, @code{'7.10.0.5'} or @code{'5aef:2b::8'}).
@ref{fd9,,inet_ntop()} is useful when a library or network protocol returns an
object of type @code{in_addr} (similar to @ref{364d,,inet_ntoa()}) or
@code{in6_addr}.

Supported values for `address_family' are currently @ref{1938,,AF_INET} and
@ref{1939,,AF_INET6}. If the bytes object `packed_ip' is not the correct
length for the specified address family, @ref{202,,ValueError} will be raised.
@ref{417,,OSError} is raised for errors from the call to @ref{fd9,,inet_ntop()}.

@ref{1ed8,,Disponibilidade}: Unix, Windows.


Alterado na versão 3.4: Suporte para Windows adicionado.



Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@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() (no módulo socket)
@anchor{library/socket socket CMSG_LEN}@anchor{1baf}
@deffn {Função} socket.CMSG_LEN (length)

Return the total length, without trailing padding, of an ancillary
data item with associated data of the given `length'.  This value
can often be used as the buffer size for @ref{dce,,recvmsg()} to
receive a single item of ancillary data, but 
@geindex RFC; RFC 3542
RFC 3542@footnote{https://datatracker.ietf.org/doc/html/rfc3542.html} requires
portable applications to use @ref{1bae,,CMSG_SPACE()} and thus include
space for padding, even when the item will be the last in the
buffer.  Raises @ref{885,,OverflowError} if `length' is outside the
permissible range of values.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

Most Unix platforms.


Adicionado na versão 3.3.

@end deffn

@geindex CMSG_SPACE() (no módulo socket)
@anchor{library/socket socket CMSG_SPACE}@anchor{1bae}
@deffn {Função} socket.CMSG_SPACE (length)

Return the buffer size needed for @ref{dce,,recvmsg()} to
receive an ancillary data item with associated data of the given
`length', along with any trailing padding.  The buffer space needed
to receive multiple items is the sum of the @ref{1bae,,CMSG_SPACE()}
values for their associated data lengths.  Raises
@ref{885,,OverflowError} if `length' is outside the permissible range
of values.

Note that some systems might support ancillary data without
providing this function.  Also note that setting the buffer size
using the results of this function may not precisely limit the
amount of ancillary data that can be received, since additional
data may be able to fit into the padding area.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

most Unix platforms.


Adicionado na versão 3.3.

@end deffn

@geindex getdefaulttimeout() (no módulo socket)
@anchor{library/socket socket getdefaulttimeout}@anchor{3644}
@deffn {Função} socket.getdefaulttimeout ()

Return the default timeout in seconds (float) for new socket objects. A value
of @code{None} indicates that new socket objects have no timeout. When the socket
module is first imported, the default is @code{None}.
@end deffn

@geindex setdefaulttimeout() (no módulo socket)
@anchor{library/socket socket setdefaulttimeout}@anchor{3613}
@deffn {Função} socket.setdefaulttimeout (timeout)

Set the default timeout in seconds (float) for new socket objects.  When
the socket module is first imported, the default is @code{None}.  See
@ref{360f,,settimeout()} for possible values and their respective
meanings.
@end deffn

@geindex sethostname() (no módulo socket)
@anchor{library/socket socket sethostname}@anchor{117a}
@deffn {Função} socket.sethostname (name)

Set the machine’s hostname to `name'.  This will raise an
@ref{417,,OSError} if you don’t have enough rights.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.sethostname} com o argumento @code{name}.

@ref{1ed8,,Disponibilidade}: Unix, not Android.


Adicionado na versão 3.3.

@end deffn

@geindex if_nameindex() (no módulo socket)
@anchor{library/socket socket if_nameindex}@anchor{a37}
@deffn {Função} socket.if_nameindex ()

Return a list of network interface information
(index int, name string) tuples.
@ref{417,,OSError} if the system call fails.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI.


Adicionado na versão 3.3.



Alterado na versão 3.8: Suporte ao Windows foi adicionado.


@cartouche
@quotation Nota 
On Windows network interfaces have different names in different contexts
(all names are examples):


@itemize *

@item 
UUID: @code{@{FB605B73-AAC2-49A6-9A2F-25416AEA0573@}}

@item 
name: @code{ethernet_32770}

@item 
friendly name: @code{vEthernet (nat)}

@item 
description: @code{Hyper-V Virtual Ethernet Adapter}
@end itemize

This function returns names of the second form from the list, @code{ethernet_32770}
in this example case.
@end quotation
@end cartouche
@end deffn

@geindex if_nametoindex() (no módulo socket)
@anchor{library/socket socket if_nametoindex}@anchor{a38}
@deffn {Função} socket.if_nametoindex (if_name)

Return a network interface index number corresponding to an
interface name.
@ref{417,,OSError} if no interface with the given name exists.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI.


Adicionado na versão 3.3.



Alterado na versão 3.8: Suporte ao Windows foi adicionado.



@subsubheading Ver também


“Interface name” is a name as documented in @ref{a37,,if_nameindex()}.

@end deffn

@geindex if_indextoname() (no módulo socket)
@anchor{library/socket socket if_indextoname}@anchor{a39}
@deffn {Função} socket.if_indextoname (if_index)

Return a network interface name corresponding to an
interface index number.
@ref{417,,OSError} if no interface with the given index exists.

@ref{1ed8,,Disponibilidade}: Unix, Windows, not WASI.


Adicionado na versão 3.3.



Alterado na versão 3.8: Suporte ao Windows foi adicionado.



@subsubheading Ver também


“Interface name” is a name as documented in @ref{a37,,if_nameindex()}.

@end deffn

@geindex send_fds() (no módulo socket)
@anchor{library/socket socket send_fds}@anchor{93a}
@deffn {Função} socket.send_fds (sock, buffers, fds[, flags[, address]])

Send the list of file descriptors `fds' over an @ref{193a,,AF_UNIX} socket `sock'.
The `fds' parameter is a sequence of file descriptors.
Consult @ref{476,,sendmsg()} for the documentation of these parameters.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

Unix platforms supporting @ref{476,,sendmsg()}
and @code{SCM_RIGHTS} mechanism.


Adicionado na versão 3.9.

@end deffn

@geindex recv_fds() (no módulo socket)
@anchor{library/socket socket recv_fds}@anchor{93b}
@deffn {Função} socket.recv_fds (sock, bufsize, maxfds[, flags])

Receive up to `maxfds' file descriptors from an @ref{193a,,AF_UNIX} socket `sock'.
Return @code{(msg, list(fds), flags, addr)}.
Consult @ref{dce,,recvmsg()} for the documentation of these parameters.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

Unix platforms supporting @ref{dce,,recvmsg()}
and @code{SCM_RIGHTS} mechanism.


Adicionado na versão 3.9.


@cartouche
@quotation Nota 
Any truncated integers at the end of the list of file descriptors.
@end quotation
@end cartouche
@end deffn

@node Socket Objects,Notas sobre tempo limite de soquete,Conteúdo do módulo<4>,socket — Interface de rede de baixo nível
@anchor{library/socket id1}@anchor{364e}@anchor{library/socket socket-objects}@anchor{3642}
@subsubsection Socket Objects


Socket objects have the following methods.  Except for
@ref{11de,,makefile()}, these correspond to Unix system calls applicable
to sockets.


Alterado na versão 3.2: Support for the @ref{5d4,,context manager} protocol was added.  Exiting the
context manager is equivalent to calling @ref{b89,,close()}.


@geindex accept() (método socket.socket)
@anchor{library/socket socket socket accept}@anchor{dca}
@deffn {Método} socket.accept ()

Accept a connection. 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.

The newly created socket is @ref{f2b,,non-inheritable}.


Alterado na versão 3.4: The socket is now non-inheritable.



Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex bind() (método socket.socket)
@anchor{library/socket socket socket bind}@anchor{1583}
@deffn {Método} socket.bind (address)

Bind the socket to `address'.  The socket must not already be bound. (The format
of `address' depends on the address family — see above.)

Levanta um @ref{19fa,,evento de auditoria} @code{socket.bind} com os argumentos @code{self}, @code{address}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex close() (método socket.socket)
@anchor{library/socket socket socket close}@anchor{d66}
@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{11de,,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).

Sockets are automatically closed when they are garbage-collected, but
it is recommended to @ref{b89,,close()} them explicitly, or to use a
@ref{5d2,,with} statement around them.


Alterado na versão 3.6: @ref{417,,OSError} is now raised if an error occurs when the underlying
@code{close()} call is made.


@cartouche
@quotation Nota 
@ref{b89,,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{363f,,shutdown()}
before @ref{b89,,close()}.
@end quotation
@end cartouche
@end deffn

@geindex connect() (método socket.socket)
@anchor{library/socket socket socket connect}@anchor{dcb}
@deffn {Método} socket.connect (address)

Connect to a remote socket at `address'. (The format of `address' depends on the
address family — see above.)

If the connection is interrupted by a signal, the method waits until the
connection completes, or raise a @ref{838,,TimeoutError} on timeout, if the
signal handler doesn’t raise an exception and the socket is blocking or has
a timeout. For non-blocking sockets, the method raises an
@ref{db0,,InterruptedError} exception if the connection is interrupted by a
signal (or the exception raised by the signal handler).

Levanta um @ref{19fa,,evento de auditoria} @code{socket.connect} com os argumentos @code{self}, @code{address}.


Alterado na versão 3.5: The method now waits until the connection completes instead of raising an
@ref{db0,,InterruptedError} exception if the connection is interrupted by a
signal, the signal handler doesn’t raise an exception and the socket is
blocking or has a timeout (see the 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).


@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex connect_ex() (método socket.socket)
@anchor{library/socket socket socket connect_ex}@anchor{1582}
@deffn {Método} socket.connect_ex (address)

Like @code{connect(address)}, but return an error indicator instead of raising an
exception for errors returned by the C-level @code{connect()} call (other
problems, such as “host not found,” can still raise exceptions).  The error
indicator is @code{0} if the operation succeeded, otherwise the value of the
@code{errno} variable.  This is useful to support, for example, asynchronous
connects.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.connect} com os argumentos @code{self}, @code{address}.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex detach() (método socket.socket)
@anchor{library/socket socket socket detach}@anchor{125d}
@deffn {Método} socket.detach ()

Put the socket object into closed state without actually closing the
underlying file descriptor.  The file descriptor is returned, and can
be reused for other purposes.


Adicionado na versão 3.2.

@end deffn

@geindex dup() (método socket.socket)
@anchor{library/socket socket socket dup}@anchor{364f}
@deffn {Método} socket.dup ()

Duplicate the socket.

The newly created socket is @ref{f2b,,non-inheritable}.


Alterado na versão 3.4: The socket is now non-inheritable.


@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex fileno() (método socket.socket)
@anchor{library/socket socket socket fileno}@anchor{3650}
@deffn {Método} socket.fileno ()

Return the socket’s file descriptor (a small integer), or -1 on failure. This
is useful with @ref{dc8,,select.select()}.

Under Windows the small integer returned by this method cannot be used where a
file descriptor can be used (such as @ref{20c4,,os.fdopen()}).  Unix does not have
this limitation.
@end deffn

@geindex get_inheritable() (método socket.socket)
@anchor{library/socket socket socket get_inheritable}@anchor{f30}
@deffn {Método} socket.get_inheritable ()

Get the @ref{f2b,,inheritable flag} of the socket’s file
descriptor or socket’s handle: @code{True} if the socket can be inherited in
child processes, @code{False} if it cannot.


Adicionado na versão 3.4.

@end deffn

@geindex getpeername() (método socket.socket)
@anchor{library/socket socket socket getpeername}@anchor{3590}
@deffn {Método} socket.getpeername ()

Return the remote address to which the socket is connected.  This is useful to
find out the port number of a remote IPv4/v6 socket, for instance. (The format
of the address returned depends on the address family — see above.)  On some
systems this function is not supported.
@end deffn

@geindex getsockname() (método socket.socket)
@anchor{library/socket socket socket getsockname}@anchor{3591}
@deffn {Método} socket.getsockname ()

Return the socket’s own address.  This is useful to find out the port number of
an IPv4/v6 socket, for instance. (The format of the address returned depends on
the address family — see above.)
@end deffn

@geindex getsockopt() (método socket.socket)
@anchor{library/socket socket socket getsockopt}@anchor{cf5}
@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{b8b,,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{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex getblocking() (método socket.socket)
@anchor{library/socket socket socket getblocking}@anchor{b88}
@deffn {Método} socket.getblocking ()

Return @code{True} if socket is in blocking mode, @code{False} if in
non-blocking.

This is equivalent to checking @code{socket.gettimeout() != 0}.


Adicionado na versão 3.7.

@end deffn

@geindex gettimeout() (método socket.socket)
@anchor{library/socket socket socket gettimeout}@anchor{3651}
@deffn {Método} socket.gettimeout ()

Return the timeout in seconds (float) associated with socket operations,
or @code{None} if no timeout is set.  This reflects the last call to
@ref{2d1d,,setblocking()} or @ref{360f,,settimeout()}.
@end deffn

@geindex ioctl() (método socket.socket)
@anchor{library/socket socket socket ioctl}@anchor{cf3}
@deffn {Método} socket.ioctl (control, option)

@*Platform: 
Windows


The @ref{cf3,,ioctl()} method is a limited interface to the WSAIoctl system
interface.  Please refer to the Win32 documentation@footnote{https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx} for more
information.

On other platforms, the generic @ref{3652,,fcntl.fcntl()} and @ref{14c3,,fcntl.ioctl()}
functions may be used; they accept a socket object as their first argument.

Currently only the following control codes are supported:
@code{SIO_RCVALL}, @code{SIO_KEEPALIVE_VALS}, and @code{SIO_LOOPBACK_FAST_PATH}.


Alterado na versão 3.6: @code{SIO_LOOPBACK_FAST_PATH} was added.

@end deffn

@geindex listen() (método socket.socket)
@anchor{library/socket socket socket listen}@anchor{e8d}
@deffn {Método} socket.listen ([backlog])

Enable a server to accept connections.  If `backlog' is specified, it must
be at least 0 (if it is lower, it is set to 0); it specifies the number of
unaccepted connections that the system will allow before refusing new
connections. If not specified, a default reasonable value is chosen.

@ref{1ed8,,Disponibilidade}: not WASI.


Alterado na versão 3.5: The `backlog' parameter is now optional.

@end deffn

@geindex makefile() (método socket.socket)
@anchor{library/socket socket socket makefile}@anchor{11de}
@deffn {Método} socket.makefile (mode='r', buffering=None, *, encoding=None, errors=None, newline=None)

@geindex controle de E/S;buffering

Return a @ref{1203,,file object} associated with the socket.  The exact returned
type depends on the arguments given to @ref{11de,,makefile()}.  These arguments are
interpreted the same way as by the built-in @ref{51c,,open()} function, except
the only supported `mode' values are @code{'r'} (default), @code{'w'}, @code{'b'}, or
a combination of those.

The socket must be in blocking mode; it can have a timeout, but the file
object’s internal buffer may end up in an inconsistent state if a timeout
occurs.

Closing the file object returned by @ref{11de,,makefile()} won’t close the
original socket unless all other file objects have been closed and
@ref{b89,,socket.close()} has been called on the socket object.

@cartouche
@quotation Nota 
On Windows, the file-like object created by @ref{11de,,makefile()} cannot be
used where a file object with a file descriptor is expected, such as the
stream arguments of @ref{199,,subprocess.Popen()}.
@end quotation
@end cartouche
@end deffn

@geindex recv() (método socket.socket)
@anchor{library/socket socket socket recv}@anchor{dcc}
@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.


Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex recvfrom() (método socket.socket)
@anchor{library/socket socket socket recvfrom}@anchor{dcd}
@deffn {Método} socket.recvfrom (bufsize[, flags])

Receive data from the socket.  The return value is a pair @code{(bytes, address)}
where `bytes' is a bytes object representing the data received and `address' is the
address of the socket sending the data.  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. (The format of `address' depends on the address family — see above.)


Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).



Alterado na versão 3.7: For multicast IPv6 address, first item of `address' does not contain
@code{%scope_id} part anymore. In order to get full IPv6 address use
@ref{17b6,,getnameinfo()}.

@end deffn

@geindex recvmsg() (método socket.socket)
@anchor{library/socket socket socket recvmsg}@anchor{dce}
@deffn {Método} socket.recvmsg (bufsize[, ancbufsize[, flags]])

Receive normal data (up to `bufsize' bytes) and ancillary data from
the socket.  The `ancbufsize' argument sets the size in bytes of
the internal buffer used to receive the ancillary data; it defaults
to 0, meaning that no ancillary data will be received.  Appropriate
buffer sizes for ancillary data can be calculated using
@ref{1bae,,CMSG_SPACE()} or @ref{1baf,,CMSG_LEN()}, and items which do not fit
into the buffer might be truncated or discarded.  The `flags'
argument defaults to 0 and has the same meaning as for
@ref{dcc,,recv()}.

The return value is a 4-tuple: @code{(data, ancdata, msg_flags,
address)}.  The `data' item is a @ref{1c2,,bytes} object holding the
non-ancillary data received.  The `ancdata' item is a list of zero
or more tuples @code{(cmsg_level, cmsg_type, cmsg_data)} representing
the ancillary data (control messages) received: `cmsg_level' and
`cmsg_type' are integers specifying the protocol level and
protocol-specific type respectively, and `cmsg_data' is a
@ref{1c2,,bytes} object holding the associated data.  The `msg_flags'
item is the bitwise OR of various flags indicating conditions on
the received message; see your system documentation for details.
If the receiving socket is unconnected, `address' is the address of
the sending socket, if available; otherwise, its value is
unspecified.

On some systems, @ref{476,,sendmsg()} and @ref{dce,,recvmsg()} can be used to
pass file descriptors between processes over an @ref{193a,,AF_UNIX}
socket.  When this facility is used (it is often restricted to
@ref{1337,,SOCK_STREAM} sockets), @ref{dce,,recvmsg()} will return, in its
ancillary data, items of the form @code{(socket.SOL_SOCKET,
socket.SCM_RIGHTS, fds)}, where `fds' is a @ref{1c2,,bytes} object
representing the new file descriptors as a binary array of the
native C int type.  If @ref{dce,,recvmsg()} raises an
exception after the system call returns, it will first attempt to
close any file descriptors received via this mechanism.

Some systems do not indicate the truncated length of ancillary data
items which have been only partially received.  If an item appears
to extend beyond the end of the buffer, @ref{dce,,recvmsg()} will issue
a @ref{1bd,,RuntimeWarning}, and will return the part of it which is
inside the buffer provided it has not been truncated before the
start of its associated data.

On systems which support the @code{SCM_RIGHTS} mechanism, the
following function will receive up to `maxfds' file descriptors,
returning the message data and a list containing the descriptors
(while ignoring unexpected conditions such as unrelated control
messages being received).  See also @ref{476,,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{1ed8,,Disponibilidade}: Unix.

Most Unix platforms.


Adicionado na versão 3.3.



Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex recvmsg_into() (método socket.socket)
@anchor{library/socket socket socket recvmsg_into}@anchor{1179}
@deffn {Método} socket.recvmsg_into (buffers[, ancbufsize[, flags]])

Receive normal data and ancillary data from the socket, behaving as
@ref{dce,,recvmsg()} would, but scatter the non-ancillary data into a
series of buffers instead of returning a new bytes object.  The
`buffers' argument must be an iterable of objects that export
writable buffers (e.g. @ref{2ea,,bytearray} objects); these will be
filled with successive chunks of the non-ancillary data until it
has all been written or there are no more buffers.  The operating
system may set a limit (@ref{1651,,sysconf()} value @code{SC_IOV_MAX})
on the number of buffers that can be used.  The `ancbufsize' and
`flags' arguments have the same meaning as for @ref{dce,,recvmsg()}.

The return value is a 4-tuple: @code{(nbytes, ancdata, msg_flags,
address)}, where `nbytes' is the total number of bytes of
non-ancillary data written into the buffers, and `ancdata',
`msg_flags' and `address' are the same as for @ref{dce,,recvmsg()}.

Exemplo:

@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{1ed8,,Disponibilidade}: Unix.

Most Unix platforms.


Adicionado na versão 3.3.

@end deffn

@geindex recvfrom_into() (método socket.socket)
@anchor{library/socket socket socket recvfrom_into}@anchor{1363}
@deffn {Método} socket.recvfrom_into (buffer[, nbytes[, flags]])

Receive data from the socket, writing it into `buffer' instead of creating a
new bytestring.  The return value is a pair @code{(nbytes, address)} where `nbytes' is
the number of bytes received and `address' is the address of the socket sending
the data.  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.  (The format of `address'
depends on the address family — see above.)
@end deffn

@geindex recv_into() (método socket.socket)
@anchor{library/socket socket socket recv_into}@anchor{1362}
@deffn {Método} socket.recv_into (buffer[, nbytes[, flags]])

Receive up to `nbytes' bytes from the socket, storing the data into a buffer
rather than creating a new bytestring.  If `nbytes' is not specified (or 0),
receive up to the size available in the given buffer.  Returns the number of
bytes received.  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.
@end deffn

@geindex send() (método socket.socket)
@anchor{library/socket socket socket send}@anchor{dcf}
@deffn {Método} socket.send (bytes[, flags])

Send data to the socket.  The socket must be connected to a remote socket.  The
optional `flags' argument has the same meaning as for @ref{dcc,,recv()} above.
Returns the number of bytes sent. Applications are responsible for checking that
all data has been sent; if only some of the data was transmitted, the
application needs to attempt delivery of the remaining data. For further
information on this topic, consult the @ref{3653,,Programação de Soquetes}.


Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex sendall() (método socket.socket)
@anchor{library/socket socket socket sendall}@anchor{dd0}
@deffn {Método} socket.sendall (bytes[, flags])

Send data to the socket.  The socket must be connected to a remote socket.  The
optional `flags' argument has the same meaning as for @ref{dcc,,recv()} above.
Unlike @ref{dcf,,send()}, this method continues to send data from `bytes' until
either all data has been sent or an error occurs.  @code{None} is returned on
success.  On error, an exception is raised, and there is no way to determine how
much data, if any, was successfully sent.


Alterado na versão 3.5: The socket timeout is no longer reset each time data is sent successfully.
The socket timeout is now the maximum total duration to send all data.



Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex sendto() (método socket.socket)
@anchor{library/socket socket socket sendto}@anchor{dd1}
@deffn {Método} socket.sendto (bytes, address)

@deffnx {Método} socket.sendto (bytes, flags, address)

Send data to the socket.  The socket should not be connected to a remote socket,
since the destination socket is specified by `address'.  The optional `flags'
argument has the same meaning as for @ref{dcc,,recv()} above.  Return the number of
bytes sent. (The format of `address' depends on the address family — see
above.)

Levanta um @ref{19fa,,evento de auditoria} @code{socket.sendto} com os argumentos @code{self}, @code{address}.


Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex sendmsg() (método socket.socket)
@anchor{library/socket socket socket sendmsg}@anchor{476}
@deffn {Método} socket.sendmsg (buffers[, ancdata[, flags[, address]]])

Send normal and ancillary data to the socket, gathering the
non-ancillary data from a series of buffers and concatenating it
into a single message.  The `buffers' argument specifies the
non-ancillary data as an iterable of
@ref{d4f,,bytes-like objects}
(e.g. @ref{1c2,,bytes} objects); the operating system may set a limit
(@ref{1651,,sysconf()} value @code{SC_IOV_MAX}) on the number of buffers
that can be used.  The `ancdata' argument specifies the ancillary
data (control messages) as an iterable of zero or more tuples
@code{(cmsg_level, cmsg_type, cmsg_data)}, where `cmsg_level' and
`cmsg_type' are integers specifying the protocol level and
protocol-specific type respectively, and `cmsg_data' is a
bytes-like object holding the associated data.  Note that
some systems (in particular, systems without @ref{1bae,,CMSG_SPACE()})
might support sending only one control message per call.  The
`flags' argument defaults to 0 and has the same meaning as for
@ref{dcf,,send()}.  If `address' is supplied and not @code{None}, it sets a
destination address for the message.  The return value is the
number of bytes of non-ancillary data sent.

The following function sends the list of file descriptors `fds'
over an @ref{193a,,AF_UNIX} socket, on systems which support the
@code{SCM_RIGHTS} mechanism.  See also @ref{dce,,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{1ed8,,Disponibilidade}: Unix, not WASI.

Most Unix platforms.

Levanta um @ref{19fa,,evento de auditoria} @code{socket.sendmsg} com os argumentos @code{self}, @code{address}.


Adicionado na versão 3.3.



Alterado na versão 3.5: If the system call is interrupted and the signal handler does not raise
an exception, the method now retries the system call instead of raising
an @ref{db0,,InterruptedError} exception (see 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale).

@end deffn

@geindex sendmsg_afalg() (método socket.socket)
@anchor{library/socket socket socket sendmsg_afalg}@anchor{cf8}
@deffn {Método} socket.sendmsg_afalg ([msg], *, op[, iv[, assoclen[, flags]]])

Specialized version of @ref{476,,sendmsg()} for @ref{cf7,,AF_ALG} socket.
Set mode, IV, AEAD associated data length and flags for @ref{cf7,,AF_ALG} socket.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.38.


Adicionado na versão 3.6.

@end deffn

@geindex sendfile() (método socket.socket)
@anchor{library/socket socket socket sendfile}@anchor{e8c}
@deffn {Método} socket.sendfile (file, offset=0, count=None)

Send a file until EOF is reached by using high-performance
@ref{b21,,os.sendfile} and return the total number of bytes which were sent.
`file' must be a regular file object opened in binary mode. If
@ref{b21,,os.sendfile} is not available (e.g. Windows) or `file' is not a
regular file @ref{dcf,,send()} will be used instead. `offset' tells from where to
start reading the file. If specified, `count' is the total number of bytes
to transmit as opposed to sending the file until EOF is reached. File
position is updated on return or also in case of error in which case
@ref{13f3,,file.tell()} can be used to figure out the number of
bytes which were sent. The socket must be of @ref{1337,,SOCK_STREAM} type.
Non-blocking sockets are not supported.


Adicionado na versão 3.5.

@end deffn

@geindex set_inheritable() (método socket.socket)
@anchor{library/socket socket socket set_inheritable}@anchor{f31}
@deffn {Método} socket.set_inheritable (inheritable)

Set the @ref{f2b,,inheritable flag} of the socket’s file
descriptor or socket’s handle.


Adicionado na versão 3.4.

@end deffn

@geindex setblocking() (método socket.socket)
@anchor{library/socket socket socket setblocking}@anchor{2d1d}
@deffn {Método} socket.setblocking (flag)

Set blocking or non-blocking mode of the socket: if `flag' is false, the
socket is set to non-blocking, else to blocking mode.

This method is a shorthand for certain @ref{360f,,settimeout()} calls:


@itemize *

@item 
@code{sock.setblocking(True)} is equivalent to @code{sock.settimeout(None)}

@item 
@code{sock.setblocking(False)} is equivalent to @code{sock.settimeout(0.0)}
@end itemize


Alterado na versão 3.7: The method no longer applies @ref{c24,,SOCK_NONBLOCK} flag on
@ref{c26,,socket.type}.

@end deffn

@geindex settimeout() (método socket.socket)
@anchor{library/socket socket socket settimeout}@anchor{360f}
@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{837,,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.

For further information, please consult the @ref{3654,,notes on socket timeouts}.


Alterado na versão 3.7: The method no longer toggles @ref{c24,,SOCK_NONBLOCK} flag on
@ref{c26,,socket.type}.

@end deffn

@geindex setsockopt() (método socket.socket)
@anchor{library/socket socket socket setsockopt}@anchor{cf6}
@deffn {Método} socket.setsockopt (level, optname, value: int | Buffer)

@deffnx {Método} socket.setsockopt (level, optname, None, optlen: int)

@geindex módulo;struct

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{d4f,,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}.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.



Alterado na versão 3.6: setsockopt(level, optname, None, optlen: int) form added.


@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex shutdown() (método socket.socket)
@anchor{library/socket socket socket shutdown}@anchor{363f}
@deffn {Método} socket.shutdown (how)

Shut down one or both halves of the connection.  If `how' is @ref{363c,,SHUT_RD},
further receives are disallowed.  If `how' is @ref{363d,,SHUT_WR}, further sends
are disallowed.  If `how' is @ref{363e,,SHUT_RDWR}, further sends and receives are
disallowed.

@ref{1ed8,,Disponibilidade}: not WASI.
@end deffn

@geindex share() (método socket.socket)
@anchor{library/socket socket socket share}@anchor{c22}
@deffn {Método} socket.share (process_id)

Duplicate a socket and prepare it for sharing with a target process.  The
target process must be provided with `process_id'.  The resulting bytes object
can then be passed to the target process using some form of interprocess
communication and the socket can be recreated there using @ref{c21,,fromshare()}.
Once this method has been called, it is safe to close the socket since
the operating system has already duplicated it for the target process.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.3.

@end deffn

Note that there are no methods @code{read()} or @code{write()}; use
@ref{dcc,,recv()} and @ref{dcf,,send()} without `flags' argument instead.

Socket objects also have these (read-only) attributes that correspond to the
values given to the @ref{dc9,,socket} constructor.

@geindex family (atributo socket.socket)
@anchor{library/socket socket socket family}@anchor{3655}
@deffn {Atributo} socket.family

The socket family.
@end deffn

@geindex type (atributo socket.socket)
@anchor{library/socket socket socket type}@anchor{c26}
@deffn {Atributo} socket.type

The socket type.
@end deffn

@geindex proto (atributo socket.socket)
@anchor{library/socket socket socket proto}@anchor{3656}
@deffn {Atributo} socket.proto

The socket protocol.
@end deffn

@node Notas sobre tempo limite de soquete,Exemplo<7>,Socket Objects,socket — Interface de rede de baixo nível
@anchor{library/socket notes-on-socket-timeouts}@anchor{3657}@anchor{library/socket socket-timeouts}@anchor{3654}
@subsubsection Notas sobre tempo limite de soquete


Um objeto soquete pode estar em um dos três modos: bloqueio, não-bloqueio ou tempo limite. Por padrão, os soquetes sempre são criados no modo de bloqueio, mas isso pode ser alterado chamando @ref{3613,,setdefaulttimeout()}.


@itemize *

@item 
In `blocking mode', operations block until complete or the system returns
an error (such as connection timed out).

@item 
In `non-blocking mode', operations fail (with an error that is unfortunately
system-dependent) if they cannot be completed immediately: functions from the
@ref{c1,,select} module can be used to know when and whether a socket is available
for reading or writing.

@item 
In `timeout mode', operations fail if they cannot be completed within the
timeout specified for the socket (they raise a @ref{837,,timeout} exception)
or if the system returns an 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{3650,,fileno()} of a socket.
@end quotation
@end cartouche

@menu
* Timeouts and the connect method:: 
* Timeouts and the accept method:: 

@end menu

@node Timeouts and the connect method,Timeouts and the accept method,,Notas sobre tempo limite de soquete
@anchor{library/socket timeouts-and-the-connect-method}@anchor{3658}
@subsubsection Timeouts and the @code{connect} method


The @ref{dcb,,connect()} operation is also subject to the timeout
setting, and in general it is recommended to call @ref{360f,,settimeout()}
before calling @ref{dcb,,connect()} or pass a timeout parameter to
@ref{672,,create_connection()}.  However, the system network stack may also
return a connection timeout error of its own regardless of any Python socket
timeout setting.

@node Timeouts and the accept method,,Timeouts and the connect method,Notas sobre tempo limite de soquete
@anchor{library/socket timeouts-and-the-accept-method}@anchor{3659}
@subsubsection Timeouts and the @code{accept} method


If @ref{3644,,getdefaulttimeout()} is not @ref{675,,None}, sockets returned by
the @ref{dca,,accept()} method inherit that timeout.  Otherwise, the
behaviour depends on settings of the listening socket:


@itemize *

@item 
if the listening socket is in `blocking mode' or in `timeout mode',
the socket returned by @ref{dca,,accept()} is in `blocking mode';

@item 
if the listening socket is in `non-blocking mode', whether the socket
returned by @ref{dca,,accept()} is in blocking or non-blocking mode
is operating system-dependent.  If you want to ensure cross-platform
behaviour, it is recommended you manually override this setting.
@end itemize

@node Exemplo<7>,,Notas sobre tempo limite de soquete,socket — Interface de rede de baixo nível
@anchor{library/socket example}@anchor{365a}@anchor{library/socket socket-example}@anchor{365b}
@subsubsection Exemplo


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{dc9,,socket()},
@ref{1583,,bind()}, @ref{e8d,,listen()}, @ref{dca,,accept()} (possibly
repeating the @ref{dca,,accept()} to service more than one client), while a
client only needs the sequence @ref{dc9,,socket()}, @ref{dcb,,connect()}.  Also
note that the server does not @ref{dd0,,sendall()}/@ref{dcc,,recv()} on
the socket it is listening on but on the new socket returned by
@ref{dca,,accept()}.

The first two examples support IPv4 only.

@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

The next example shows how to write a very simple network sniffer with raw
sockets on Windows. The example requires administrator privileges to modify
the interface:

@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

The next example shows how to use the socket interface to communicate to a CAN
network using the raw socket protocol. To use CAN with the broadcast
manager protocol instead, open a socket with:

@example
socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
@end example

After binding (@code{CAN_RAW}) or connecting (@ref{fd7,,CAN_BCM}) the socket, you
can use the @ref{dcf,,socket.send()} and @ref{dcc,,socket.recv()} operations (and
their counterparts) on the socket object as usual.

This last example might require special privileges:

@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

Running an example several times with too small delay between executions, could
lead to this error:

@example
OSError: [Errno 98] Address already in use
@end example

This is because the previous execution has left the socket in a @code{TIME_WAIT}
state, and can’t be immediately reused.

There is a @ref{cc,,socket} flag to set, in order to prevent this,
@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

the @code{SO_REUSEADDR} flag tells the kernel to reuse a local socket in
@code{TIME_WAIT} state, without waiting for its natural timeout to expire.


@subsubheading Ver também


Para uma introdução à programação de socket (em C), veja os seguintes artigos:


@itemize -

@item 
`An Introductory 4.3BSD Interprocess Communication Tutorial', by Stuart Sechrest

@item 
`An Advanced 4.3BSD Interprocess Communication Tutorial', by Samuel J.  Leffler et
al,
@end itemize

both in the UNIX Programmer’s Manual, Supplementary Documents 1 (sections
PS1:7 and PS1:8).  The platform-specific reference material for the various
socket-related system calls are also a valuable source of information on the
details of socket semantics.  For Unix, refer to the manual pages; for Windows,
see the WinSock (or Winsock 2) specification.  For IPv6-ready APIs, readers may
want to refer to 
@geindex RFC; RFC 3493
RFC 3493@footnote{https://datatracker.ietf.org/doc/html/rfc3493.html} titled Basic Socket Interface Extensions for IPv6.


@node ssl — Invólucro de TLS/SSL para objetos socket,select — Waiting for I/O completion,socket — Interface de rede de baixo nível,Comunicação em Rede e Interprocesso
@anchor{library/ssl doc}@anchor{365c}@anchor{library/ssl module-ssl}@anchor{d0}@anchor{library/ssl ssl-tls-ssl-wrapper-for-socket-objects}@anchor{365d}@anchor{library/ssl translation-repo}@anchor{365e}
@subsection @code{ssl} — Invólucro de TLS/SSL para objetos socket


@geindex module; ssl

`Código-fonte:' Lib/ssl.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/ssl.py}

@geindex OpenSSL;(use in module ssl)

@geindex TLS
@geindex SSL
@geindex Transport Layer Security
@geindex Secure Sockets Layer


__________________________________________________________________


Este módulo fornece acesso à criptografia Transport Layer Security (frequentemente conhecida como “Secure Sockets Layer”) e aos recursos de autenticação de pares para sockets de rede, tanto do lado do cliente quanto do lado do servidor. Este módulo usa a biblioteca OpenSSL. Ela está disponível em todos os sistemas Unix modernos, Windows, macOS e provavelmente plataformas adicionais, desde que o OpenSSL esteja instalado nessa plataforma.

@cartouche
@quotation Nota 
Alguns comportamentos podem depender da plataforma, já que chamadas são feitas para as APIs de socket do sistema operacional. A versão instalada do OpenSSL também pode causar variações no comportamento. Por exemplo, o TLSv1.3 vem com a versão 1.1.1 do OpenSSL.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Não use este módulo sem ler o @ref{354c,,Considerações de segurança}. Fazer isso pode levar a uma falsa sensação de segurança, pois as configurações padrão do módulo ssl não são necessariamente apropriadas para sua aplicação.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

Esta seção documenta os objetos e funções no módulo @code{ssl}; para obter mais informações gerais sobre TLS, SSL e certificados, o leitor pode consultar os documentos na seção “Consulte também” na parte inferior.

Este módulo fornece uma classe, @ref{8f0,,ssl.SSLSocket}, que é derivada do tipo @ref{dc9,,socket.socket}, e fornece um wrapper semelhante a um socket que também criptografa e descriptografa os dados que passam pelo socket com SSL. Ele suporta métodos adicionais como @code{getpeercert()}, que recupera o certificado do outro lado da conexão, @code{cipher()}, que recupera a cifra sendo usada para a conexão segura ou @code{get_verified_chain()}, @code{get_unverified_chain()} que recupera a cadeia de certificados.

Para aplicações mais sofisticadas, a classe @ref{294,,ssl.SSLContext} ajuda a gerenciar configurações e certificados, que podem ser herdados por soquetes SSL criados por meio do método @ref{525,,SSLContext.wrap_socket()}.


Alterado na versão 3.5.3: Atualizado para oferecer suporte à vinculação com OpenSSL 1.1.0



Alterado na versão 3.6: OpenSSL 0.9.8, 1.0.0 e 1.0.1 estão descontinuado e não são mais suportados. No futuro, o módulo ssl exigirá pelo menos OpenSSL 1.0.2 ou 1.1.0.



Alterado na versão 3.10: 
@geindex Propostas de Melhorias do Python; PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} foi implementado. O módulo ssl requer OpenSSL 1.1.1 ou mais recente.

O uso de constantes e funções descontinuados resulta em avisos de descontinuação.


@menu
* Funções@comma{} constantes e exceções.: Funções constantes e exceções. 
* SSL Sockets:: 
* SSL Contexts:: 
* Certificados:: 
* Exemplos: Exemplos<20>. 
* Notes on non-blocking sockets:: 
* Підтримка BIO пам’яті: Підтримка BIO пам’яті<2>. 
* SSL session:: 
* Considerações de segurança: Considerações de segurança<2>. 
* TLS 1.3: TLS 1 3. 

@end menu

@node Funções constantes e exceções,SSL Sockets,,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl functions-constants-and-exceptions}@anchor{365f}
@subsubsection Funções, constantes e exceções.


@menu
* Criação de socket:: 
* Criação de contexto:: 
* Exceções: Exceções<16>. 
* Random generation:: 
* Manipulação de certificados:: 
* Constantes: Constantes<9>. 

@end menu

@node Criação de socket,Criação de contexto,,Funções constantes e exceções
@anchor{library/ssl socket-creation}@anchor{3660}
@subsubsection Criação de socket


Instâncias de @ref{8f0,,SSLSocket} devem ser criadas usando o método @ref{525,,SSLContext.wrap_socket()}. A função auxiliar @ref{155,,create_default_context()} retorna um novo contexto com configurações padrão seguras.

Exemplo de soquete de cliente com contexto padrão e pilha dupla 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

Exemplo de soquete de cliente com contexto personalizado e IPv4:

@example
hostname = 'www.python.org'
# PROTOCOL_TLS_CLIENT requer hostname e cadeia de certificados
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

Exemplo de soquete de servidor escutando no localhost IPv4:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.load_cert_chain('/caminho/para/cadeia-certicado.pem', '/caminho/para/privado.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 Criação de contexto,Exceções<16>,Criação de socket,Funções constantes e exceções
@anchor{library/ssl context-creation}@anchor{3661}
@subsubsection Criação de contexto


A convenience function helps create @ref{294,,SSLContext} objects for common
purposes.

@geindex create_default_context() (no módulo ssl)
@anchor{library/ssl ssl create_default_context}@anchor{155}
@deffn {Função} ssl.create_default_context (purpose=Purpose.SERVER_AUTH, *, cafile=None, capath=None, cadata=None)

Return a new @ref{294,,SSLContext} object with default settings for
the given `purpose'.  The settings are chosen by the @ref{d0,,ssl} module,
and usually represent a higher security level than when calling the
@ref{294,,SSLContext} constructor directly.

`cafile', `capath', `cadata' represent optional CA certificates to
trust for certificate verification, as in
@ref{f1d,,SSLContext.load_verify_locations()}.  If all three are
@ref{675,,None}, this function can choose to trust the system’s default
CA certificates instead.

The settings are: @ref{876,,PROTOCOL_TLS_CLIENT} or
@ref{877,,PROTOCOL_TLS_SERVER}, @ref{83c,,OP_NO_SSLv2}, and @ref{83d,,OP_NO_SSLv3}
with high encryption cipher suites without RC4 and
without unauthenticated cipher suites. Passing @ref{fe7,,SERVER_AUTH}
as `purpose' sets @ref{3662,,verify_mode} to @ref{3663,,CERT_REQUIRED}
and either loads CA certificates (when at least one of `cafile', `capath' or
`cadata' is given) or uses @ref{fe6,,SSLContext.load_default_certs()} to load
default CA certificates.

When @ref{3664,,keylog_filename} is supported and the environment
variable 
@geindex SSLKEYLOGFILE
@geindex variável de ambiente; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} is set, @ref{155,,create_default_context()}
enables key logging.

The default settings for this context include
@ref{156,,VERIFY_X509_PARTIAL_CHAIN} and @ref{157,,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 
The protocol, options, cipher and other settings may change to more
restrictive values anytime without prior deprecation.  The values
represent a fair balance between compatibility and security.

If your application needs specific settings, you should create a
@ref{294,,SSLContext} and apply the settings yourself.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
If you find that when certain older clients or servers attempt to connect
with a @ref{294,,SSLContext} created by this function that they get an error
stating “Protocol or cipher suite mismatch”, it may be that they only
support SSL3.0 which this function excludes using the
@ref{83d,,OP_NO_SSLv3}. SSL3.0 is widely considered to be completely broken@footnote{https://en.wikipedia.org/wiki/POODLE}. If you still wish to continue to
use this function but still allow SSL 3.0 connections you can re-enable
them using:

@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{157,,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


Adicionado na versão 3.4.



Alterado na versão 3.4.4: RC4 was dropped from the default cipher string.



Alterado na versão 3.6: ChaCha20/Poly1305 was added to the default cipher string.

3DES was dropped from the default cipher string.



Alterado na versão 3.8: Support for key logging to 
@geindex SSLKEYLOGFILE
@geindex variável de ambiente; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} was added.



Alterado na versão 3.10: The context now uses @ref{876,,PROTOCOL_TLS_CLIENT} or
@ref{877,,PROTOCOL_TLS_SERVER} protocol instead of generic
@ref{3665,,PROTOCOL_TLS}.



Alterado na versão 3.13: The context now uses @ref{156,,VERIFY_X509_PARTIAL_CHAIN} and
@ref{157,,VERIFY_X509_STRICT} in its default verify flags.

@end deffn

@node Exceções<16>,Random generation,Criação de contexto,Funções constantes e exceções
@anchor{library/ssl exceptions}@anchor{3666}
@subsubsection Exceções


@geindex SSLError
@anchor{library/ssl ssl SSLError}@anchor{12bb}
@deffn {Exceção} ssl.SSLError

Raised to signal an error from the underlying SSL implementation
(currently provided by the OpenSSL library).  This signifies some
problem in the higher-level encryption and authentication layer that’s
superimposed on the underlying network connection.  This error
is a subtype of @ref{417,,OSError}.  The error code and message of
@ref{12bb,,SSLError} instances are provided by the OpenSSL library.


Alterado na versão 3.3: @ref{12bb,,SSLError} used to be a subtype of @ref{108e,,socket.error}.


@geindex library (atributo ssl.SSLError)
@anchor{library/ssl ssl SSLError library}@anchor{1186}
@deffn {Atributo} library

A string mnemonic designating the OpenSSL submodule in which the error
occurred, such as @code{SSL}, @code{PEM} or @code{X509}.  The range of possible
values depends on the OpenSSL version.


Adicionado na versão 3.3.

@end deffn

@geindex reason (atributo ssl.SSLError)
@anchor{library/ssl ssl SSLError reason}@anchor{1187}
@deffn {Atributo} reason

A string mnemonic designating the reason this error occurred, for
example @code{CERTIFICATE_VERIFY_FAILED}.  The range of possible
values depends on the OpenSSL version.


Adicionado na versão 3.3.

@end deffn
@end deffn

@geindex SSLZeroReturnError
@anchor{library/ssl ssl SSLZeroReturnError}@anchor{3667}
@deffn {Exceção} ssl.SSLZeroReturnError

A subclass of @ref{12bb,,SSLError} raised when trying to read or write and
the SSL connection has been closed cleanly.  Note that this doesn’t
mean that the underlying transport (read TCP) has been closed.


Adicionado na versão 3.3.

@end deffn

@geindex SSLWantReadError
@anchor{library/ssl ssl SSLWantReadError}@anchor{e98}
@deffn {Exceção} ssl.SSLWantReadError

A subclass of @ref{12bb,,SSLError} raised by a @ref{3668,,non-blocking SSL socket} when trying to read or write data, but more data needs
to be received on the underlying TCP transport before the request can be
fulfilled.


Adicionado na versão 3.3.

@end deffn

@geindex SSLWantWriteError
@anchor{library/ssl ssl SSLWantWriteError}@anchor{e99}
@deffn {Exceção} ssl.SSLWantWriteError

A subclass of @ref{12bb,,SSLError} raised by a @ref{3668,,non-blocking SSL socket} when trying to read or write data, but more data needs
to be sent on the underlying TCP transport before the request can be
fulfilled.


Adicionado na versão 3.3.

@end deffn

@geindex SSLSyscallError
@anchor{library/ssl ssl SSLSyscallError}@anchor{3669}
@deffn {Exceção} ssl.SSLSyscallError

A subclass of @ref{12bb,,SSLError} raised when a system error was encountered
while trying to fulfill an operation on a SSL socket.  Unfortunately,
there is no easy way to inspect the original errno number.


Adicionado na versão 3.3.

@end deffn

@geindex SSLEOFError
@anchor{library/ssl ssl SSLEOFError}@anchor{1840}
@deffn {Exceção} ssl.SSLEOFError

A subclass of @ref{12bb,,SSLError} raised when the SSL connection has been
terminated abruptly.  Generally, you shouldn’t try to reuse the underlying
transport when this error is encountered.


Adicionado na versão 3.3.

@end deffn

@geindex SSLCertVerificationError
@anchor{library/ssl ssl SSLCertVerificationError}@anchor{b94}
@deffn {Exceção} ssl.SSLCertVerificationError

A subclass of @ref{12bb,,SSLError} raised when certificate validation has
failed.


Adicionado na versão 3.7.


@geindex verify_code (atributo ssl.SSLCertVerificationError)
@anchor{library/ssl ssl SSLCertVerificationError verify_code}@anchor{366a}
@deffn {Atributo} verify_code

A numeric error number that denotes the verification error.
@end deffn

@geindex verify_message (atributo ssl.SSLCertVerificationError)
@anchor{library/ssl ssl SSLCertVerificationError verify_message}@anchor{366b}
@deffn {Atributo} verify_message

A human readable string of the verification error.
@end deffn
@end deffn

@geindex CertificateError
@anchor{library/ssl ssl CertificateError}@anchor{366c}
@deffn {Exceção} ssl.CertificateError

An alias for @ref{b94,,SSLCertVerificationError}.


Alterado na versão 3.7: The exception is now an alias for @ref{b94,,SSLCertVerificationError}.

@end deffn

@node Random generation,Manipulação de certificados,Exceções<16>,Funções constantes e exceções
@anchor{library/ssl random-generation}@anchor{366d}
@subsubsection Random generation


@geindex RAND_bytes() (no módulo ssl)
@anchor{library/ssl ssl RAND_bytes}@anchor{524}
@deffn {Função} ssl.RAND_bytes (num, /)

Return `num' cryptographically strong pseudo-random bytes. Raises an
@ref{12bb,,SSLError} if the PRNG has not been seeded with enough data or if the
operation is not supported by the current RAND method. @ref{1a0a,,RAND_status()}
can be used to check the status of the PRNG and @ref{366e,,RAND_add()} can be used
to seed the PRNG.

For almost all applications @ref{523,,os.urandom()} is preferable.

Read the Wikipedia article, Cryptographically secure pseudorandom number generator (CSPRNG)@footnote{https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator},
to get the requirements of a cryptographically strong generator.


Adicionado na versão 3.3.

@end deffn

@geindex RAND_status() (no módulo ssl)
@anchor{library/ssl ssl RAND_status}@anchor{1a0a}
@deffn {Função} ssl.RAND_status ()

Return @code{True} if the SSL pseudo-random number generator has been seeded
with ‘enough’ randomness, and @code{False} otherwise.  You can use
@code{ssl.RAND_egd()} and @ref{366e,,ssl.RAND_add()} to increase the randomness of
the pseudo-random number generator.
@end deffn

@geindex RAND_add() (no módulo ssl)
@anchor{library/ssl ssl RAND_add}@anchor{366e}
@deffn {Função} 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.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@end deffn

@node Manipulação de certificados,Constantes<9>,Random generation,Funções constantes e exceções
@anchor{library/ssl certificate-handling}@anchor{366f}
@subsubsection Manipulação de certificados


@c import ssl

@geindex cert_time_to_seconds() (no módulo ssl)
@anchor{library/ssl ssl cert_time_to_seconds}@anchor{e9a}
@deffn {Função} ssl.cert_time_to_seconds (cert_time)

Return the time in seconds since the Epoch, given the @code{cert_time}
string representing the “notBefore” or “notAfter” date from a
certificate in @code{"%b %d %H:%M:%S %Y %Z"} strptime format (C
locale).

Here’s an example:

@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

“notBefore” or “notAfter” dates must use GMT (
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}).


Alterado na versão 3.5: Interpret the input time as a time in UTC as specified by ‘GMT’
timezone in the input string. Local timezone was used
previously. Return an integer (no fractions of a second in the
input format)

@end deffn

@geindex get_server_certificate() (no módulo ssl)
@anchor{library/ssl ssl get_server_certificate}@anchor{83f}
@deffn {Função} 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{f1d,,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.


Alterado na versão 3.3: This function is now IPv6-compatible.



Alterado na versão 3.5: The default `ssl_version' is changed from @ref{3670,,PROTOCOL_SSLv3} to
@ref{3665,,PROTOCOL_TLS} for maximum compatibility with modern servers.



Alterado na versão 3.10: The `timeout' parameter was added.

@end deffn

@geindex DER_cert_to_PEM_cert() (no módulo ssl)
@anchor{library/ssl ssl DER_cert_to_PEM_cert}@anchor{3671}
@deffn {Função} ssl.DER_cert_to_PEM_cert (der_cert_bytes)

Given a certificate as a DER-encoded blob of bytes, returns a PEM-encoded
string version of the same certificate.
@end deffn

@geindex PEM_cert_to_DER_cert() (no módulo ssl)
@anchor{library/ssl ssl PEM_cert_to_DER_cert}@anchor{3672}
@deffn {Função} ssl.PEM_cert_to_DER_cert (pem_cert_string)

Given a certificate as an ASCII PEM string, returns a DER-encoded sequence of
bytes for that same certificate.
@end deffn

@geindex get_default_verify_paths() (no módulo ssl)
@anchor{library/ssl ssl get_default_verify_paths}@anchor{fde}
@deffn {Função} ssl.get_default_verify_paths ()

Returns a named tuple with paths to OpenSSL’s default cafile and capath.
The paths are the same as used by
@ref{fdf,,SSLContext.set_default_verify_paths()}. The return value is a
@ref{64e,,named tuple} @code{DefaultVerifyPaths}:


@itemize *

@item 
@code{cafile} - resolved path to cafile or @code{None} if the file doesn’t exist,

@item 
@code{capath} - resolved path to capath or @code{None} if the directory doesn’t exist,

@item 
@code{openssl_cafile_env} - OpenSSL’s environment key that points to a cafile,

@item 
@code{openssl_cafile} - hard coded path to a cafile,

@item 
@code{openssl_capath_env} - OpenSSL’s environment key that points to a capath,

@item 
@code{openssl_capath} - hard coded path to a capath directory
@end itemize


Adicionado na versão 3.4.

@end deffn

@geindex enum_certificates() (no módulo ssl)
@anchor{library/ssl ssl enum_certificates}@anchor{fe9}
@deffn {Função} ssl.enum_certificates (store_name)

Retrieve certificates from Windows’ system cert store. `store_name' may be
one of @code{CA}, @code{ROOT} or @code{MY}. Windows may provide additional cert
stores, too.

The function returns a list of (cert_bytes, encoding_type, trust) tuples.
The encoding_type specifies the encoding of cert_bytes. It is either
@code{x509_asn} for X.509 ASN.1 data or @code{pkcs_7_asn} for
PKCS#7 ASN.1 data. Trust specifies the purpose of the certificate as a set
of OIDS or exactly @code{True} if the certificate is trustworthy for all
purposes.

Exemplo:

@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{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.4.

@end deffn

@geindex enum_crls() (no módulo ssl)
@anchor{library/ssl ssl enum_crls}@anchor{fea}
@deffn {Função} ssl.enum_crls (store_name)

Retrieve CRLs from Windows’ system cert store. `store_name' may be
one of @code{CA}, @code{ROOT} or @code{MY}. Windows may provide additional cert
stores, too.

The function returns a list of (cert_bytes, encoding_type, trust) tuples.
The encoding_type specifies the encoding of cert_bytes. It is either
@code{x509_asn} for X.509 ASN.1 data or @code{pkcs_7_asn} for
PKCS#7 ASN.1 data.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.4.

@end deffn

@node Constantes<9>,,Manipulação de certificados,Funções constantes e exceções
@anchor{library/ssl constants}@anchor{3673}
@subsubsection Constantes


@quotation

All constants are now @ref{d00,,enum.IntEnum} or @ref{cbb,,enum.IntFlag} collections.


Adicionado na versão 3.6.

@end quotation

@geindex CERT_NONE (no módulo ssl)
@anchor{library/ssl ssl CERT_NONE}@anchor{3674}
@deffn {Dado} ssl.CERT_NONE

Possible value for @ref{3662,,SSLContext.verify_mode}.
Except for @ref{876,,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.

In server mode, no certificate is requested from the client, so the client
does not send any for client cert authentication.

See the discussion of @ref{354c,,Considerações de segurança} below.
@end deffn

@geindex CERT_OPTIONAL (no módulo ssl)
@anchor{library/ssl ssl CERT_OPTIONAL}@anchor{3675}
@deffn {Dado} ssl.CERT_OPTIONAL

Possible value for @ref{3662,,SSLContext.verify_mode}.
In client mode, @ref{3675,,CERT_OPTIONAL}
has the same meaning as @ref{3663,,CERT_REQUIRED}. It is recommended to
use @ref{3663,,CERT_REQUIRED} for client-side sockets instead.

In server mode, a client certificate request is sent to the client.  The
client may either ignore the request or send a certificate in order
perform TLS client cert authentication.  If the client chooses to send
a certificate, it is verified.  Any verification error immediately aborts
the TLS handshake.

Use of this setting requires a valid set of CA certificates to
be passed to @ref{f1d,,SSLContext.load_verify_locations()}.
@end deffn

@geindex CERT_REQUIRED (no módulo ssl)
@anchor{library/ssl ssl CERT_REQUIRED}@anchor{3663}
@deffn {Dado} ssl.CERT_REQUIRED

Possible value for @ref{3662,,SSLContext.verify_mode}.
In this mode, certificates are
required from the other side of the socket connection; an @ref{12bb,,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{3676,,check_hostname} must be
enabled as well to verify the authenticity of a cert.
@ref{876,,PROTOCOL_TLS_CLIENT} uses @ref{3663,,CERT_REQUIRED} and
enables @ref{3676,,check_hostname} by default.

With server socket, this mode provides mandatory TLS client cert
authentication.  A client certificate request is sent to the client and
the client must provide a valid and trusted certificate.

Use of this setting requires a valid set of CA certificates to
be passed to @ref{f1d,,SSLContext.load_verify_locations()}.
@end deffn

@geindex VerifyMode (classe em ssl)
@anchor{library/ssl ssl VerifyMode}@anchor{3677}
@deffn {Classe} ssl.VerifyMode

@ref{d00,,enum.IntEnum} collection of CERT_* constants.


Adicionado na versão 3.6.

@end deffn

@geindex VERIFY_DEFAULT (no módulo ssl)
@anchor{library/ssl ssl VERIFY_DEFAULT}@anchor{fe3}
@deffn {Dado} ssl.VERIFY_DEFAULT

Possible value for @ref{fe2,,SSLContext.verify_flags}. In this mode, certificate
revocation lists (CRLs) are not checked. By default OpenSSL does neither
require nor verify CRLs.


Adicionado na versão 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_LEAF (no módulo ssl)
@anchor{library/ssl ssl VERIFY_CRL_CHECK_LEAF}@anchor{fe4}
@deffn {Dado} ssl.VERIFY_CRL_CHECK_LEAF

Possible value for @ref{fe2,,SSLContext.verify_flags}. In this mode, only the
peer cert is checked but none of the intermediate CA certificates. The mode
requires a valid CRL that is signed by the peer cert’s issuer (its direct
ancestor CA). If no proper CRL has been loaded with
@ref{f1d,,SSLContext.load_verify_locations}, validation will fail.


Adicionado na versão 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_CHAIN (no módulo ssl)
@anchor{library/ssl ssl VERIFY_CRL_CHECK_CHAIN}@anchor{fe5}
@deffn {Dado} ssl.VERIFY_CRL_CHECK_CHAIN

Possible value for @ref{fe2,,SSLContext.verify_flags}. In this mode, CRLs of
all certificates in the peer cert chain are checked.


Adicionado na versão 3.4.

@end deffn

@geindex VERIFY_X509_STRICT (no módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_STRICT}@anchor{157}
@deffn {Dado} ssl.VERIFY_X509_STRICT

Possible value for @ref{fe2,,SSLContext.verify_flags} to disable workarounds
for broken X.509 certificates.


Adicionado na versão 3.4.

@end deffn

@geindex VERIFY_ALLOW_PROXY_CERTS (no módulo ssl)
@anchor{library/ssl ssl VERIFY_ALLOW_PROXY_CERTS}@anchor{1a21}
@deffn {Dado} ssl.VERIFY_ALLOW_PROXY_CERTS

Possible value for @ref{fe2,,SSLContext.verify_flags} to enables proxy
certificate verification.


Adicionado na versão 3.10.

@end deffn

@geindex VERIFY_X509_TRUSTED_FIRST (no módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_TRUSTED_FIRST}@anchor{3678}
@deffn {Dado} ssl.VERIFY_X509_TRUSTED_FIRST

Possible value for @ref{fe2,,SSLContext.verify_flags}. It instructs OpenSSL to
prefer trusted certificates when building the trust chain to validate a
certificate. This flag is enabled by default.


Adicionado na versão 3.4.4.

@end deffn

@geindex VERIFY_X509_PARTIAL_CHAIN (no módulo ssl)
@anchor{library/ssl ssl VERIFY_X509_PARTIAL_CHAIN}@anchor{156}
@deffn {Dado} ssl.VERIFY_X509_PARTIAL_CHAIN

Possible value for @ref{fe2,,SSLContext.verify_flags}. It instructs OpenSSL to
accept intermediate CAs in the trust store to be treated as trust-anchors,
in the same way as the self-signed root CA certificates. This makes it
possible to trust certificates issued by an intermediate CA without having
to trust its ancestor root CA.


Adicionado na versão 3.10.

@end deffn

@geindex VerifyFlags (classe em ssl)
@anchor{library/ssl ssl VerifyFlags}@anchor{3679}
@deffn {Classe} ssl.VerifyFlags

@ref{cbb,,enum.IntFlag} collection of VERIFY_* constants.


Adicionado na versão 3.6.

@end deffn

@geindex PROTOCOL_TLS (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS}@anchor{3665}
@deffn {Dado} ssl.PROTOCOL_TLS

Selects the highest protocol version that both the client and server support.
Despite the name, this option can select both “SSL” and “TLS” protocols.


Adicionado na versão 3.6.



Descontinuado desde a versão 3.10: TLS clients and servers require different default settings for secure
communication. The generic TLS protocol constant is deprecated in
favor of @ref{876,,PROTOCOL_TLS_CLIENT} and @ref{877,,PROTOCOL_TLS_SERVER}.

@end deffn

@geindex PROTOCOL_TLS_CLIENT (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS_CLIENT}@anchor{876}
@deffn {Dado} ssl.PROTOCOL_TLS_CLIENT

Auto-negotiate the highest protocol version that both the client and
server support, and configure the context client-side connections. The
protocol enables @ref{3663,,CERT_REQUIRED} and
@ref{3676,,check_hostname} by default.


Adicionado na versão 3.6.

@end deffn

@geindex PROTOCOL_TLS_SERVER (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLS_SERVER}@anchor{877}
@deffn {Dado} ssl.PROTOCOL_TLS_SERVER

Auto-negotiate the highest protocol version that both the client and
server support, and configure the context server-side connections.


Adicionado na versão 3.6.

@end deffn

@geindex PROTOCOL_SSLv23 (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_SSLv23}@anchor{367a}
@deffn {Dado} ssl.PROTOCOL_SSLv23

Alias for @ref{3665,,PROTOCOL_TLS}.


Descontinuado desde a versão 3.6: Use @ref{3665,,PROTOCOL_TLS} instead.

@end deffn

@geindex PROTOCOL_SSLv3 (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_SSLv3}@anchor{3670}
@deffn {Dado} ssl.PROTOCOL_SSLv3

Selects SSL version 3 as the channel encryption protocol.

This protocol is not available if OpenSSL is compiled with the
@code{no-ssl3} option.

@cartouche
@quotation Aviso 
SSL version 3 is insecure.  Its use is highly discouraged.
@end quotation
@end cartouche


Descontinuado desde a versão 3.6: OpenSSL has deprecated all version specific protocols. Use the default
protocol @ref{877,,PROTOCOL_TLS_SERVER} or @ref{876,,PROTOCOL_TLS_CLIENT}
with @ref{874,,SSLContext.minimum_version} and
@ref{875,,SSLContext.maximum_version} instead.

@end deffn

@geindex PROTOCOL_TLSv1 (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1}@anchor{367b}
@deffn {Dado} ssl.PROTOCOL_TLSv1

Selects TLS version 1.0 as the channel encryption protocol.


Descontinuado desde a versão 3.6: OpenSSL has deprecated all version specific protocols.

@end deffn

@geindex PROTOCOL_TLSv1_1 (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1_1}@anchor{fdc}
@deffn {Dado} ssl.PROTOCOL_TLSv1_1

Selects TLS version 1.1 as the channel encryption protocol.
Available only with openssl version 1.0.1+.


Adicionado na versão 3.4.



Descontinuado desde a versão 3.6: OpenSSL has deprecated all version specific protocols.

@end deffn

@geindex PROTOCOL_TLSv1_2 (no módulo ssl)
@anchor{library/ssl ssl PROTOCOL_TLSv1_2}@anchor{fdd}
@deffn {Dado} ssl.PROTOCOL_TLSv1_2

Selects TLS version 1.2 as the channel encryption protocol.
Available only with openssl version 1.0.1+.


Adicionado na versão 3.4.



Descontinuado desde a versão 3.6: OpenSSL has deprecated all version specific protocols.

@end deffn

@geindex OP_ALL (no módulo ssl)
@anchor{library/ssl ssl OP_ALL}@anchor{367c}
@deffn {Dado} ssl.OP_ALL

Enables workarounds for various bugs present in other SSL implementations.
This option is set by default.  It does not necessarily set the same
flags as OpenSSL’s @code{SSL_OP_ALL} constant.


Adicionado na versão 3.2.

@end deffn

@geindex OP_NO_SSLv2 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_SSLv2}@anchor{83c}
@deffn {Dado} ssl.OP_NO_SSLv2

Prevents an SSLv2 connection.  This option is only applicable in
conjunction with @ref{3665,,PROTOCOL_TLS}.  It prevents the peers from
choosing SSLv2 as the protocol version.


Adicionado na versão 3.2.



Descontinuado desde a versão 3.6: SSLv2 is deprecated

@end deffn

@geindex OP_NO_SSLv3 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_SSLv3}@anchor{83d}
@deffn {Dado} ssl.OP_NO_SSLv3

Prevents an SSLv3 connection.  This option is only applicable in
conjunction with @ref{3665,,PROTOCOL_TLS}.  It prevents the peers from
choosing SSLv3 as the protocol version.


Adicionado na versão 3.2.



Descontinuado desde a versão 3.6: SSLv3 is deprecated

@end deffn

@geindex OP_NO_TLSv1 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1}@anchor{367d}
@deffn {Dado} ssl.OP_NO_TLSv1

Prevents a TLSv1 connection.  This option is only applicable in
conjunction with @ref{3665,,PROTOCOL_TLS}.  It prevents the peers from
choosing TLSv1 as the protocol version.


Adicionado na versão 3.2.



Descontinuado desde a versão 3.7: The option is deprecated since OpenSSL 1.1.0, use the new
@ref{874,,SSLContext.minimum_version} and
@ref{875,,SSLContext.maximum_version} instead.

@end deffn

@geindex OP_NO_TLSv1_1 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_1}@anchor{367e}
@deffn {Dado} ssl.OP_NO_TLSv1_1

Prevents a TLSv1.1 connection. This option is only applicable in conjunction
with @ref{3665,,PROTOCOL_TLS}. It prevents the peers from choosing TLSv1.1 as
the protocol version. Available only with openssl version 1.0.1+.


Adicionado na versão 3.4.



Descontinuado desde a versão 3.7: The option is deprecated since OpenSSL 1.1.0.

@end deffn

@geindex OP_NO_TLSv1_2 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_2}@anchor{367f}
@deffn {Dado} ssl.OP_NO_TLSv1_2

Prevents a TLSv1.2 connection. This option is only applicable in conjunction
with @ref{3665,,PROTOCOL_TLS}. It prevents the peers from choosing TLSv1.2 as
the protocol version. Available only with openssl version 1.0.1+.


Adicionado na versão 3.4.



Descontinuado desde a versão 3.7: The option is deprecated since OpenSSL 1.1.0.

@end deffn

@geindex OP_NO_TLSv1_3 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_TLSv1_3}@anchor{19e6}
@deffn {Dado} ssl.OP_NO_TLSv1_3

Prevents a TLSv1.3 connection. This option is only applicable in conjunction
with @ref{3665,,PROTOCOL_TLS}. It prevents the peers from choosing TLSv1.3 as
the protocol version. TLS 1.3 is available with OpenSSL 1.1.1 or later.
When Python has been compiled against an older version of OpenSSL, the
flag defaults to `0'.


Adicionado na versão 3.6.3.



Descontinuado desde a versão 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 (no módulo ssl)
@anchor{library/ssl ssl OP_NO_RENEGOTIATION}@anchor{3680}
@deffn {Dado} ssl.OP_NO_RENEGOTIATION

Disable all renegotiation in TLSv1.2 and earlier. Do not send
HelloRequest messages, and ignore renegotiation requests via ClientHello.

This option is only available with OpenSSL 1.1.0h and later.


Adicionado na versão 3.7.

@end deffn

@geindex OP_CIPHER_SERVER_PREFERENCE (no módulo ssl)
@anchor{library/ssl ssl OP_CIPHER_SERVER_PREFERENCE}@anchor{1188}
@deffn {Dado} ssl.OP_CIPHER_SERVER_PREFERENCE

Use the server’s cipher ordering preference, rather than the client’s.
This option has no effect on client sockets and SSLv2 server sockets.


Adicionado na versão 3.3.

@end deffn

@geindex OP_SINGLE_DH_USE (no módulo ssl)
@anchor{library/ssl ssl OP_SINGLE_DH_USE}@anchor{3681}
@deffn {Dado} 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.


Adicionado na versão 3.3.

@end deffn

@geindex OP_SINGLE_ECDH_USE (no módulo ssl)
@anchor{library/ssl ssl OP_SINGLE_ECDH_USE}@anchor{3682}
@deffn {Dado} 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.


Adicionado na versão 3.3.

@end deffn

@geindex OP_ENABLE_MIDDLEBOX_COMPAT (no módulo ssl)
@anchor{library/ssl ssl OP_ENABLE_MIDDLEBOX_COMPAT}@anchor{3683}
@deffn {Dado} ssl.OP_ENABLE_MIDDLEBOX_COMPAT

Send dummy Change Cipher Spec (CCS) messages in TLS 1.3 handshake to make
a TLS 1.3 connection look more like a TLS 1.2 connection.

This option is only available with OpenSSL 1.1.1 and later.


Adicionado na versão 3.8.

@end deffn

@geindex OP_NO_COMPRESSION (no módulo ssl)
@anchor{library/ssl ssl OP_NO_COMPRESSION}@anchor{1185}
@deffn {Dado} ssl.OP_NO_COMPRESSION

Disable compression on the SSL channel.  This is useful if the application
protocol supports its own compression scheme.


Adicionado na versão 3.3.

@end deffn

@geindex Options (classe em ssl)
@anchor{library/ssl ssl Options}@anchor{3684}
@deffn {Classe} ssl.Options

@ref{cbb,,enum.IntFlag} collection of OP_* constants.
@end deffn

@geindex OP_NO_TICKET (no módulo ssl)
@anchor{library/ssl ssl OP_NO_TICKET}@anchor{3685}
@deffn {Dado} ssl.OP_NO_TICKET

Prevent client side from requesting a session ticket.


Adicionado na versão 3.6.

@end deffn

@geindex OP_IGNORE_UNEXPECTED_EOF (no módulo ssl)
@anchor{library/ssl ssl OP_IGNORE_UNEXPECTED_EOF}@anchor{83a}
@deffn {Dado} ssl.OP_IGNORE_UNEXPECTED_EOF

Ignore unexpected shutdown of TLS connections.

This option is only available with OpenSSL 3.0.0 and later.


Adicionado na versão 3.10.

@end deffn

@geindex OP_ENABLE_KTLS (no módulo ssl)
@anchor{library/ssl ssl OP_ENABLE_KTLS}@anchor{1897}
@deffn {Dado} 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.

This option is only available with OpenSSL 3.0.0 and later.


Adicionado na versão 3.12.

@end deffn

@geindex OP_LEGACY_SERVER_CONNECT (no módulo ssl)
@anchor{library/ssl ssl OP_LEGACY_SERVER_CONNECT}@anchor{1879}
@deffn {Dado} ssl.OP_LEGACY_SERVER_CONNECT

Allow legacy insecure renegotiation between OpenSSL and unpatched servers
only.


Adicionado na versão 3.12.

@end deffn

@geindex HAS_ALPN (no módulo ssl)
@anchor{library/ssl ssl HAS_ALPN}@anchor{e95}
@deffn {Dado} ssl.HAS_ALPN

Whether the OpenSSL library has built-in support for the `Application-Layer
Protocol Negotiation' TLS extension as described in 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}.


Adicionado na versão 3.5.

@end deffn

@geindex HAS_NEVER_CHECK_COMMON_NAME (no módulo ssl)
@anchor{library/ssl ssl HAS_NEVER_CHECK_COMMON_NAME}@anchor{3686}
@deffn {Dado} ssl.HAS_NEVER_CHECK_COMMON_NAME

Whether the OpenSSL library has built-in support not checking subject
common name and @ref{b95,,SSLContext.hostname_checks_common_name} is
writeable.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_ECDH (no módulo ssl)
@anchor{library/ssl ssl HAS_ECDH}@anchor{3687}
@deffn {Dado} ssl.HAS_ECDH

Whether the OpenSSL library has built-in support for the Elliptic Curve-based
Diffie-Hellman key exchange.  This should be true unless the feature was
explicitly disabled by the distributor.


Adicionado na versão 3.3.

@end deffn

@geindex HAS_SNI (no módulo ssl)
@anchor{library/ssl ssl HAS_SNI}@anchor{3688}
@deffn {Dado} ssl.HAS_SNI

Whether the OpenSSL library has built-in support for the `Server Name
Indication' extension (as defined in 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html}).


Adicionado na versão 3.2.

@end deffn

@geindex HAS_NPN (no módulo ssl)
@anchor{library/ssl ssl HAS_NPN}@anchor{3689}
@deffn {Dado} ssl.HAS_NPN

Whether the OpenSSL library has built-in support for the `Next Protocol
Negotiation' as described in the Application Layer Protocol Negotiation@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation}.
When true, you can use the @ref{302,,SSLContext.set_npn_protocols()} method to advertise
which protocols you want to support.


Adicionado na versão 3.3.

@end deffn

@geindex HAS_SSLv2 (no módulo ssl)
@anchor{library/ssl ssl HAS_SSLv2}@anchor{368a}
@deffn {Dado} ssl.HAS_SSLv2

Whether the OpenSSL library has built-in support for the SSL 2.0 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_SSLv3 (no módulo ssl)
@anchor{library/ssl ssl HAS_SSLv3}@anchor{368b}
@deffn {Dado} ssl.HAS_SSLv3

Whether the OpenSSL library has built-in support for the SSL 3.0 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_TLSv1 (no módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1}@anchor{368c}
@deffn {Dado} ssl.HAS_TLSv1

Whether the OpenSSL library has built-in support for the TLS 1.0 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_TLSv1_1 (no módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_1}@anchor{b9b}
@deffn {Dado} ssl.HAS_TLSv1_1

Whether the OpenSSL library has built-in support for the TLS 1.1 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_TLSv1_2 (no módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_2}@anchor{368d}
@deffn {Dado} ssl.HAS_TLSv1_2

Whether the OpenSSL library has built-in support for the TLS 1.2 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_TLSv1_3 (no módulo ssl)
@anchor{library/ssl ssl HAS_TLSv1_3}@anchor{368e}
@deffn {Dado} ssl.HAS_TLSv1_3

Whether the OpenSSL library has built-in support for the TLS 1.3 protocol.


Adicionado na versão 3.7.

@end deffn

@geindex HAS_PSK (no módulo ssl)
@anchor{library/ssl ssl HAS_PSK}@anchor{368f}
@deffn {Dado} ssl.HAS_PSK

Whether the OpenSSL library has built-in support for TLS-PSK.


Adicionado na versão 3.13.

@end deffn

@geindex CHANNEL_BINDING_TYPES (no módulo ssl)
@anchor{library/ssl ssl CHANNEL_BINDING_TYPES}@anchor{3690}
@deffn {Dado} ssl.CHANNEL_BINDING_TYPES

List of supported TLS channel binding types.  Strings in this list
can be used as arguments to @ref{1183,,SSLSocket.get_channel_binding()}.


Adicionado na versão 3.3.

@end deffn

@geindex OPENSSL_VERSION (no módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION}@anchor{125f}
@deffn {Dado} ssl.OPENSSL_VERSION

The version string of the OpenSSL library loaded by the interpreter:

@example
>>> ssl.OPENSSL_VERSION
'OpenSSL 1.0.2k  26 Jan 2017'
@end example


Adicionado na versão 3.2.

@end deffn

@geindex OPENSSL_VERSION_INFO (no módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION_INFO}@anchor{1260}
@deffn {Dado} ssl.OPENSSL_VERSION_INFO

A tuple of five integers representing version information about the
OpenSSL library:

@example
>>> ssl.OPENSSL_VERSION_INFO
(1, 0, 2, 11, 15)
@end example


Adicionado na versão 3.2.

@end deffn

@geindex OPENSSL_VERSION_NUMBER (no módulo ssl)
@anchor{library/ssl ssl OPENSSL_VERSION_NUMBER}@anchor{1261}
@deffn {Dado} ssl.OPENSSL_VERSION_NUMBER

The raw version number of the OpenSSL library, as a single integer:

@example
>>> ssl.OPENSSL_VERSION_NUMBER
268443839
>>> hex(ssl.OPENSSL_VERSION_NUMBER)
'0x100020bf'
@end example


Adicionado na versão 3.2.

@end deffn

@geindex ALERT_DESCRIPTION_HANDSHAKE_FAILURE (no módulo ssl)
@geindex ALERT_DESCRIPTION_INTERNAL_ERROR (no módulo ssl)
@anchor{library/ssl ssl ALERT_DESCRIPTION_HANDSHAKE_FAILURE}@anchor{3691}
@deffn {Dado} ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE
@anchor{library/ssl ssl ALERT_DESCRIPTION_INTERNAL_ERROR}@anchor{3692}
@deffnx {Dado} ssl.ALERT_DESCRIPTION_INTERNAL_ERROR

@deffnx {Dado} ALERT_DESCRIPTION_*

Alert Descriptions from 
@geindex RFC; RFC 5246
RFC 5246@footnote{https://datatracker.ietf.org/doc/html/rfc5246.html} and others. The IANA TLS Alert Registry@footnote{https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6}
contains this list and references to the RFCs where their meaning is defined.

Used as the return value of the callback function in
@ref{feb,,SSLContext.set_servername_callback()}.


Adicionado na versão 3.4.

@end deffn

@geindex AlertDescription (classe em ssl)
@anchor{library/ssl ssl AlertDescription}@anchor{3693}
@deffn {Classe} ssl.AlertDescription

@ref{d00,,enum.IntEnum} collection of ALERT_DESCRIPTION_* constants.


Adicionado na versão 3.6.

@end deffn

@geindex Purpose.SERVER_AUTH (no módulo ssl)
@anchor{library/ssl ssl Purpose SERVER_AUTH}@anchor{fe7}
@deffn {Dado} Purpose.SERVER_AUTH

Option for @ref{155,,create_default_context()} and
@ref{fe6,,SSLContext.load_default_certs()}.  This value indicates that the
context may be used to authenticate web servers (therefore, it will
be used to create client-side sockets).


Adicionado na versão 3.4.

@end deffn

@geindex Purpose.CLIENT_AUTH (no módulo ssl)
@anchor{library/ssl ssl Purpose CLIENT_AUTH}@anchor{fe8}
@deffn {Dado} Purpose.CLIENT_AUTH

Option for @ref{155,,create_default_context()} and
@ref{fe6,,SSLContext.load_default_certs()}.  This value indicates that the
context may be used to authenticate web clients (therefore, it will
be used to create server-side sockets).


Adicionado na versão 3.4.

@end deffn

@geindex SSLErrorNumber (classe em ssl)
@anchor{library/ssl ssl SSLErrorNumber}@anchor{3694}
@deffn {Classe} ssl.SSLErrorNumber

@ref{d00,,enum.IntEnum} collection of SSL_ERROR_* constants.


Adicionado na versão 3.6.

@end deffn

@geindex TLSVersion (classe em ssl)
@anchor{library/ssl ssl TLSVersion}@anchor{3695}
@deffn {Classe} ssl.TLSVersion

@ref{d00,,enum.IntEnum} collection of SSL and TLS versions for
@ref{875,,SSLContext.maximum_version} and @ref{874,,SSLContext.minimum_version}.


Adicionado na versão 3.7.

@end deffn

@geindex MINIMUM_SUPPORTED (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion MINIMUM_SUPPORTED}@anchor{3696}
@deffn {Atributo} TLSVersion.MINIMUM_SUPPORTED
@end deffn

@geindex MAXIMUM_SUPPORTED (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion MAXIMUM_SUPPORTED}@anchor{3697}
@deffn {Atributo} TLSVersion.MAXIMUM_SUPPORTED

The minimum or maximum supported SSL or TLS version. These are magic
constants. Their values don’t reflect the lowest and highest available
TLS/SSL versions.
@end deffn

@geindex SSLv3 (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion SSLv3}@anchor{3698}
@deffn {Atributo} TLSVersion.SSLv3
@end deffn

@geindex TLSv1 (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1}@anchor{3699}
@deffn {Atributo} TLSVersion.TLSv1
@end deffn

@geindex TLSv1_1 (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_1}@anchor{369a}
@deffn {Atributo} TLSVersion.TLSv1_1
@end deffn

@geindex TLSv1_2 (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_2}@anchor{369b}
@deffn {Atributo} TLSVersion.TLSv1_2
@end deffn

@geindex TLSv1_3 (atributo ssl.TLSVersion)
@anchor{library/ssl ssl TLSVersion TLSv1_3}@anchor{369c}
@deffn {Atributo} TLSVersion.TLSv1_3

SSL 3.0 to TLS 1.3.


Descontinuado desde a versão 3.10: All @ref{3695,,TLSVersion} members except @ref{369b,,TLSVersion.TLSv1_2} and
@ref{369c,,TLSVersion.TLSv1_3} are deprecated.

@end deffn

@node SSL Sockets,SSL Contexts,Funções constantes e exceções,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl ssl-sockets}@anchor{369d}
@subsubsection SSL Sockets


@geindex SSLSocket (classe em ssl)
@anchor{library/ssl ssl SSLSocket}@anchor{8f0}
@deffn {Classe} ssl.SSLSocket (socket.socket)

SSL sockets provide the following methods of @ref{3642,,Socket Objects}:


@itemize -

@item 
@ref{dca,,accept()}

@item 
@ref{1583,,bind()}

@item 
@ref{d66,,close()}

@item 
@ref{dcb,,connect()}

@item 
@ref{125d,,detach()}

@item 
@ref{3650,,fileno()}

@item 
@ref{3590,,getpeername()}, @ref{3591,,getsockname()}

@item 
@ref{cf5,,getsockopt()}, @ref{cf6,,setsockopt()}

@item 
@ref{3651,,gettimeout()}, @ref{360f,,settimeout()},
@ref{2d1d,,setblocking()}

@item 
@ref{e8d,,listen()}

@item 
@ref{11de,,makefile()}

@item 
@ref{dcc,,recv()}, @ref{1362,,recv_into()}
(but passing a non-zero @code{flags} argument is not allowed)

@item 
@ref{dcf,,send()}, @ref{dd0,,sendall()} (with
the same limitation)

@item 
@ref{e8c,,sendfile()} (but @ref{b21,,os.sendfile} will be used
for plain-text sockets only, else @ref{dcf,,send()} will be used)

@item 
@ref{363f,,shutdown()}
@end itemize

However, since the SSL (and TLS) protocol has its own framing atop
of TCP, the SSL sockets abstraction can, in certain respects, diverge from
the specification of normal, OS-level sockets.  See especially the
@ref{3668,,notes on non-blocking sockets}.

Instances of @ref{8f0,,SSLSocket} must be created using the
@ref{525,,SSLContext.wrap_socket()} method.


Alterado na versão 3.5: The @code{sendfile()} method was added.



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



Descontinuado desde a versão 3.6: It is deprecated to create a @ref{8f0,,SSLSocket} instance directly, use
@ref{525,,SSLContext.wrap_socket()} to wrap a socket.



Alterado na versão 3.7: @ref{8f0,,SSLSocket} instances must to created with
@ref{525,,wrap_socket()}. In earlier versions, it was possible
to create instances directly. This was never documented or officially
supported.



Alterado na versão 3.10: Python 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.

@end deffn

SSL sockets also have the following additional methods and attributes:

@geindex read() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket read}@anchor{e9d}
@deffn {Método} SSLSocket.read (len=1024, buffer=None)

Read up to `len' bytes of data from the SSL socket and return the result as
a @code{bytes} instance. If `buffer' is specified, then read into the buffer
instead, and return the number of bytes read.

Raise @ref{e98,,SSLWantReadError} or @ref{e99,,SSLWantWriteError} if the socket is
@ref{3668,,non-blocking} and the read would block.

As at any time a re-negotiation is possible, a call to @ref{e9d,,read()} can also
cause write operations.


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



Descontinuado desde a versão 3.6: Use @code{recv()} instead of @ref{e9d,,read()}.

@end deffn

@geindex write() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket write}@anchor{e9e}
@deffn {Método} SSLSocket.write (data)

Write `data' to the SSL socket and return the number of bytes written. The
`data' argument must be an object supporting the buffer interface.

Raise @ref{e98,,SSLWantReadError} or @ref{e99,,SSLWantWriteError} if the socket is
@ref{3668,,non-blocking} and the write would block.

As at any time a re-negotiation is possible, a call to @ref{e9e,,write()} can
also cause read operations.


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



Descontinuado desde a versão 3.6: Use @code{send()} instead of @ref{e9e,,write()}.

@end deffn

@cartouche
@quotation Nota 
The @ref{e9d,,read()} and @ref{e9e,,write()} methods are the
low-level methods that read and write unencrypted, application-level data
and decrypt/encrypt it to encrypted, wire-level data. These methods
require an active SSL connection, i.e. the handshake was completed and
@ref{369e,,SSLSocket.unwrap()} was not called.

Normally you should use the socket API methods like
@ref{dcc,,recv()} and @ref{dcf,,send()} instead of these
methods.
@end quotation
@end cartouche

@geindex do_handshake() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket do_handshake}@anchor{e9c}
@deffn {Método} SSLSocket.do_handshake (block=False)

Perform the SSL setup handshake.

If `block' is true and the timeout obtained by @ref{3651,,gettimeout()}
is zero, the socket is set in blocking mode until the handshake is performed.


Alterado na versão 3.4: The handshake method also performs @code{match_hostname()} when the
@ref{3676,,check_hostname} attribute of the socket’s
@ref{369f,,context} is true.



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



Alterado na versão 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 ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket getpeercert}@anchor{fec}
@deffn {Método} SSLSocket.getpeercert (binary_form=False)

If there is no certificate for the peer on the other end of the connection,
return @code{None}.  If the SSL handshake hasn’t been done yet, raise
@ref{202,,ValueError}.

If the @code{binary_form} parameter is @ref{b49,,False}, and a certificate was
received from the peer, this method returns a @ref{256,,dict} instance.  If the
certificate was not validated, the dict is empty.  If the certificate was
validated, it returns a dict with several keys, amongst them @code{subject}
(the principal for which the certificate was issued) and @code{issuer}
(the principal issuing the certificate).  If a certificate contains an
instance of the `Subject Alternative Name' extension (see 
@geindex RFC; RFC 3280
RFC 3280@footnote{https://datatracker.ietf.org/doc/html/rfc3280.html}),
there will also be a @code{subjectAltName} key in the dictionary.

The @code{subject} and @code{issuer} fields are tuples containing the sequence
of relative distinguished names (RDNs) given in the certificate’s data
structure for the respective fields, and each RDN is a sequence of
name-value pairs.  Here is a real-world example:

@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

If the @code{binary_form} parameter is @ref{c27,,True}, and a certificate was
provided, this method returns the DER-encoded form of the entire certificate
as a sequence of bytes, or @ref{675,,None} if the peer did not provide a
certificate.  Whether the peer provides a certificate depends on the SSL
socket’s role:


@itemize *

@item 
for a client SSL socket, the server will always provide a certificate,
regardless of whether validation was required;

@item 
for a server SSL socket, the client will only provide a certificate
when requested by the server; therefore @ref{fec,,getpeercert()} will return
@ref{675,,None} if you used @ref{3674,,CERT_NONE} (rather than
@ref{3675,,CERT_OPTIONAL} or @ref{3663,,CERT_REQUIRED}).
@end itemize

See also @ref{3676,,SSLContext.check_hostname}.


Alterado na versão 3.2: The returned dictionary includes additional items such as @code{issuer}
and @code{notBefore}.



Alterado na versão 3.4: @ref{202,,ValueError} is raised when the handshake isn’t done.
The returned dictionary includes additional X509v3 extension items
  such as @code{crlDistributionPoints}, @code{caIssuers} and @code{OCSP} URIs.



Alterado na versão 3.9: IPv6 address strings no longer have a trailing new line.

@end deffn

@geindex get_verified_chain() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_verified_chain}@anchor{16c6}
@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{16c7,,get_unverified_chain()}.


Adicionado na versão 3.13.

@end deffn

@geindex get_unverified_chain() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_unverified_chain}@anchor{16c7}
@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.


Adicionado na versão 3.13.

@end deffn

@geindex cipher() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket cipher}@anchor{3592}
@deffn {Método} SSLSocket.cipher ()

Returns a three-value tuple containing the name of the cipher being used, the
version of the SSL protocol that defines its use, and the number of secret
bits being used.  If no connection has been established, returns @code{None}.
@end deffn

@geindex shared_ciphers() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket shared_ciphers}@anchor{e9b}
@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{e9b,,shared_ciphers()} returns
@code{None} if no connection has been established or the socket is a client
socket.


Adicionado na versão 3.5.

@end deffn

@geindex compression() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket compression}@anchor{1184}
@deffn {Método} SSLSocket.compression ()

Return the compression algorithm being used as a string, or @code{None}
if the connection isn’t compressed.

If the higher-level protocol supports its own compression mechanism,
you can use @ref{1185,,OP_NO_COMPRESSION} to disable SSL-level compression.


Adicionado na versão 3.3.

@end deffn

@geindex get_channel_binding() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket get_channel_binding}@anchor{1183}
@deffn {Método} SSLSocket.get_channel_binding (cb_type='tls-unique')

Get channel binding data for current connection, as a bytes object.  Returns
@code{None} if not connected or the handshake has not been completed.

The `cb_type' parameter allow selection of the desired channel binding
type. Valid channel binding types are listed in the
@ref{3690,,CHANNEL_BINDING_TYPES} list.  Currently only the ‘tls-unique’ channel
binding, defined by 
@geindex RFC; RFC 5929
RFC 5929@footnote{https://datatracker.ietf.org/doc/html/rfc5929.html}, is supported.  @ref{202,,ValueError} will be
raised if an unsupported channel binding type is requested.


Adicionado na versão 3.3.

@end deffn

@geindex selected_alpn_protocol() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket selected_alpn_protocol}@anchor{e94}
@deffn {Método} SSLSocket.selected_alpn_protocol ()

Return the protocol that was selected during the TLS handshake.  If
@ref{e93,,SSLContext.set_alpn_protocols()} was not called, if the other party does
not support ALPN, if this socket does not support any of the client’s
proposed protocols, or if the handshake has not happened yet, @code{None} is
returned.


Adicionado na versão 3.5.

@end deffn

@geindex selected_npn_protocol() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket selected_npn_protocol}@anchor{878}
@deffn {Método} SSLSocket.selected_npn_protocol ()

Return the higher-level protocol that was selected during the TLS/SSL
handshake. If @ref{302,,SSLContext.set_npn_protocols()} was not called, or
if the other party does not support NPN, or if the handshake has not yet
happened, this will return @code{None}.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.10: NPN has been superseded by ALPN

@end deffn

@geindex unwrap() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket unwrap}@anchor{369e}
@deffn {Método} SSLSocket.unwrap ()

Performs the SSL shutdown handshake, which removes the TLS layer from the
underlying socket, and returns the underlying socket object.  This can be
used to go from encrypted operation over a connection to unencrypted.  The
returned socket should always be used for further communication with the
other side of the connection, rather than the original socket.
@end deffn

@geindex verify_client_post_handshake() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket verify_client_post_handshake}@anchor{a3c}
@deffn {Método} SSLSocket.verify_client_post_handshake ()

Requests post-handshake authentication (PHA) from a TLS 1.3 client. PHA
can only be initiated for a TLS 1.3 connection from a server-side socket,
after the initial TLS handshake and with PHA enabled on both sides, see
@ref{a3b,,SSLContext.post_handshake_auth}.

The method does not perform a cert exchange immediately. The server-side
sends a CertificateRequest during the next write event and expects the
client to respond with a certificate on the next read event.

If any precondition isn’t met (e.g. not TLS 1.3, PHA not enabled), an
@ref{12bb,,SSLError} is raised.

@cartouche
@quotation Nota 
Only available with OpenSSL 1.1.1 and TLS 1.3 enabled. Without TLS 1.3
support, the method raises @ref{228,,NotImplementedError}.
@end quotation
@end cartouche


Adicionado na versão 3.8.

@end deffn

@geindex version() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket version}@anchor{e97}
@deffn {Método} SSLSocket.version ()

Return the actual SSL protocol version negotiated by the connection
as a string, or @code{None} if no secure connection is established.
As of this writing, possible return values include @code{"SSLv2"},
@code{"SSLv3"}, @code{"TLSv1"}, @code{"TLSv1.1"} and @code{"TLSv1.2"}.
Recent OpenSSL versions may define more return values.


Adicionado na versão 3.5.

@end deffn

@geindex pending() (método ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket pending}@anchor{36a0}
@deffn {Método} SSLSocket.pending ()

Returns the number of already decrypted bytes available for read, pending on
the connection.
@end deffn

@geindex context (atributo ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket context}@anchor{369f}
@deffn {Atributo} SSLSocket.context

The @ref{294,,SSLContext} object this SSL socket is tied to.


Adicionado na versão 3.2.

@end deffn

@geindex server_side (atributo ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket server_side}@anchor{36a1}
@deffn {Atributo} SSLSocket.server_side

A boolean which is @code{True} for server-side sockets and @code{False} for
client-side sockets.


Adicionado na versão 3.2.

@end deffn

@geindex server_hostname (atributo ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket server_hostname}@anchor{b97}
@deffn {Atributo} SSLSocket.server_hostname

Hostname of the server: @ref{44c,,str} type, or @code{None} for server-side
socket or if the hostname was not specified in the constructor.


Adicionado na versão 3.2.



Alterado na versão 3.7: The attribute is now always ASCII text. When @code{server_hostname} is
an internationalized domain name (IDN), this attribute now stores the
A-label form (@code{"xn--pythn-mua.org"}), rather than the U-label form
(@code{"pythön.org"}).

@end deffn

@geindex session (atributo ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket session}@anchor{1693}
@deffn {Atributo} SSLSocket.session

The @ref{cfe,,SSLSession} for this SSL connection. The session is available
for client and server side sockets after the TLS handshake has been
performed. For client sockets the session can be set before
@ref{e9c,,do_handshake()} has been called to reuse a session.


Adicionado na versão 3.6.

@end deffn

@geindex session_reused (atributo ssl.SSLSocket)
@anchor{library/ssl ssl SSLSocket session_reused}@anchor{36a2}
@deffn {Atributo} SSLSocket.session_reused


Adicionado na versão 3.6.

@end deffn

@node SSL Contexts,Certificados,SSL Sockets,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl ssl-contexts}@anchor{36a3}
@subsubsection SSL Contexts



Adicionado na versão 3.2.


An SSL context holds various data longer-lived than single SSL connections,
such as SSL configuration options, certificate(s) and private key(s).
It also manages a cache of SSL sessions for server-side sockets, in order
to speed up repeated connections from the same clients.

@geindex SSLContext (classe em ssl)
@anchor{library/ssl ssl SSLContext}@anchor{294}
@deffn {Classe} ssl.SSLContext (protocol=None)

Create a new SSL context.  You may pass `protocol' which must be one
of the @code{PROTOCOL_*} constants defined in this module.  The parameter
specifies which version of the SSL protocol to use.  Typically, the
server chooses a particular protocol version, and the client must adapt
to the server’s choice.  Most of the versions are not interoperable
with the other versions.  If not specified, the default is
@ref{3665,,PROTOCOL_TLS}; it provides the most compatibility with other
versions.

Here’s a table showing which versions in a client (down the side) can connect
to which versions in a server (along the top):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@item

`client' / `server'

@tab

`SSLv2'

@tab

`SSLv3'

@tab

`TLS' @footnote{
TLS 1.3 protocol will be available with @ref{3665,,PROTOCOL_TLS} in
OpenSSL >= 1.1.1. There is no dedicated PROTOCOL constant for just
TLS 1.3.
}

@tab

`TLSv1'

@tab

`TLSv1.1'

@tab

`TLSv1.2'

@item

`SSLv2'

@tab

sim

@tab

não

@tab

no @footnote{
@ref{294,,SSLContext} disables SSLv2 with @ref{83c,,OP_NO_SSLv2} by default.
}

@tab

não

@tab

não

@tab

não

@item

`SSLv3'

@tab

não

@tab

sim

@tab

no @footnote{
@ref{294,,SSLContext} disables SSLv3 with @ref{83d,,OP_NO_SSLv3} by default.
}

@tab

não

@tab

não

@tab

não

@item

`TLS' (`SSLv23') @footnote{
TLS 1.3 protocol will be available with @ref{3665,,PROTOCOL_TLS} in
OpenSSL >= 1.1.1. There is no dedicated PROTOCOL constant for just
TLS 1.3.
}

@tab

no @footnote{
@ref{294,,SSLContext} disables SSLv2 with @ref{83c,,OP_NO_SSLv2} by default.
}

@tab

no @footnote{
@ref{294,,SSLContext} disables SSLv3 with @ref{83d,,OP_NO_SSLv3} by default.
}

@tab

sim

@tab

sim

@tab

sim

@tab

sim

@item

`TLSv1'

@tab

não

@tab

não

@tab

sim

@tab

sim

@tab

não

@tab

não

@item

`TLSv1.1'

@tab

não

@tab

não

@tab

sim

@tab

não

@tab

sim

@tab

não

@item

`TLSv1.2'

@tab

não

@tab

não

@tab

sim

@tab

não

@tab

não

@tab

sim

@end multitable



@subsubheading Ver também


@ref{155,,create_default_context()} lets the @ref{d0,,ssl} module choose
security settings for a given purpose.



Alterado na versão 3.6: The context is created with secure default values. The options
@ref{1185,,OP_NO_COMPRESSION}, @ref{1188,,OP_CIPHER_SERVER_PREFERENCE},
@ref{3681,,OP_SINGLE_DH_USE}, @ref{3682,,OP_SINGLE_ECDH_USE},
@ref{83c,,OP_NO_SSLv2},
and @ref{83d,,OP_NO_SSLv3} (except for @ref{3670,,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.



Descontinuado desde a versão 3.10: @ref{294,,SSLContext} without protocol argument is deprecated. The
context class will either require @ref{876,,PROTOCOL_TLS_CLIENT} or
@ref{877,,PROTOCOL_TLS_SERVER} protocol in the future.



Alterado na versão 3.10: The default cipher suites now include only secure AES and ChaCha20
ciphers with forward secrecy and security level 2. RSA and DH keys with
less than 2048 bits and ECC keys with less than 224 bits are prohibited.
@ref{3665,,PROTOCOL_TLS}, @ref{876,,PROTOCOL_TLS_CLIENT}, and
@ref{877,,PROTOCOL_TLS_SERVER} use TLS 1.2 as minimum TLS version.


@cartouche
@quotation Nota 
@ref{294,,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{294,,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

@ref{294,,SSLContext} objects have the following methods and attributes:

@geindex cert_store_stats() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext cert_store_stats}@anchor{fe0}
@deffn {Método} SSLContext.cert_store_stats ()

Get statistics about quantities of loaded X.509 certificates, count of
X.509 certificates flagged as CA certificates and certificate revocation
lists as dictionary.

Example for a context with one CA cert and one other cert:

@example
>>> context.cert_store_stats()
@{'crl': 0, 'x509_ca': 1, 'x509': 2@}
@end example


Adicionado na versão 3.4.

@end deffn

@geindex load_cert_chain() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_cert_chain}@anchor{295}
@deffn {Método} SSLContext.load_cert_chain (certfile, keyfile=None, password=None)

Load a private key and the corresponding certificate.  The `certfile'
string must be the path to a single file in PEM format containing the
certificate as well as any number of CA certificates needed to establish
the certificate’s authenticity.  The `keyfile' string, if present, must
point to a file containing the private key.  Otherwise the private
key will be taken from `certfile' as well.  See the discussion of
@ref{36a4,,Certificados} for more information on how the certificate
is stored in the `certfile'.

The `password' argument may be a function to call to get the password for
decrypting the private key.  It will only be called if the private key is
encrypted and a password is necessary.  It will be called with no arguments,
and it should return a string, bytes, or bytearray.  If the return value is
a string it will be encoded as UTF-8 before using it to decrypt the key.
Alternatively a string, bytes, or bytearray value may be supplied directly
as the `password' argument.  It will be ignored if the private key is not
encrypted and no password is needed.

If the `password' argument is not specified and a password is required,
OpenSSL’s built-in password prompting mechanism will be used to
interactively prompt the user for a password.

An @ref{12bb,,SSLError} is raised if the private key doesn’t
match with the certificate.


Alterado na versão 3.3: New optional argument `password'.

@end deffn

@geindex load_default_certs() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_default_certs}@anchor{fe6}
@deffn {Método} SSLContext.load_default_certs (purpose=Purpose.SERVER_AUTH)

Load a set of default “certification authority” (CA) certificates from
default locations. On Windows it loads CA certs from the @code{CA} and
@code{ROOT} system stores. On all systems it calls
@ref{fdf,,SSLContext.set_default_verify_paths()}. In the future the method may
load CA certificates from other locations, too.

The `purpose' flag specifies what kind of CA certificates are loaded. The
default settings @ref{fe7,,Purpose.SERVER_AUTH} loads certificates, that are
flagged and trusted for TLS web server authentication (client side
sockets). @ref{fe8,,Purpose.CLIENT_AUTH} loads CA certificates for client
certificate verification on the server side.


Adicionado na versão 3.4.

@end deffn

@geindex load_verify_locations() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_verify_locations}@anchor{f1d}
@deffn {Método} SSLContext.load_verify_locations (cafile=None, capath=None, cadata=None)

Load a set of “certification authority” (CA) certificates used to validate
other peers’ certificates when @ref{3662,,verify_mode} is other than
@ref{3674,,CERT_NONE}.  At least one of `cafile' or `capath' must be specified.

This method can also load certification revocation lists (CRLs) in PEM or
DER format. In order to make use of CRLs, @ref{fe2,,SSLContext.verify_flags}
must be configured properly.

The `cafile' string, if present, is the path to a file of concatenated
CA certificates in PEM format. See the discussion of
@ref{36a4,,Certificados} for more information about how to arrange the
certificates in this file.

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/}.

The `cadata' object, if present, is either an ASCII string of one or more
PEM-encoded certificates or a @ref{d4f,,bytes-like object} of DER-encoded
certificates. Like with `capath' extra lines around PEM-encoded
certificates are ignored but at least one certificate must be present.


Alterado na versão 3.4: New optional argument `cadata'

@end deffn

@geindex get_ca_certs() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext get_ca_certs}@anchor{fe1}
@deffn {Método} SSLContext.get_ca_certs (binary_form=False)

Get a list of loaded “certification authority” (CA) certificates. If the
@code{binary_form} parameter is @ref{b49,,False} each list
entry is a dict like the output of @ref{fec,,SSLSocket.getpeercert()}. Otherwise
the method returns a list of DER-encoded certificates. The returned list
does not contain certificates from `capath' unless a certificate was
requested and loaded by a SSL connection.

@cartouche
@quotation Nota 
Certificates in a capath directory aren’t loaded unless they have
been used at least once.
@end quotation
@end cartouche


Adicionado na versão 3.4.

@end deffn

@geindex get_ciphers() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext get_ciphers}@anchor{cff}
@deffn {Método} SSLContext.get_ciphers ()

Get a list of enabled ciphers. The list is in order of cipher priority.
See @ref{36a5,,SSLContext.set_ciphers()}.

Exemplo:

@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


Adicionado na versão 3.6.

@end deffn

@geindex set_default_verify_paths() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_default_verify_paths}@anchor{fdf}
@deffn {Método} SSLContext.set_default_verify_paths ()

Load a set of default “certification authority” (CA) certificates from
a filesystem path defined when building the OpenSSL library.  Unfortunately,
there’s no easy way to know whether this method succeeds: no error is
returned if no certificates are to be found.  When the OpenSSL library is
provided as part of the operating system, though, it is likely to be
configured properly.
@end deffn

@geindex set_ciphers() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_ciphers}@anchor{36a5}
@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{12bb,,SSLError} will be raised.

@cartouche
@quotation Nota 
when connected, the @ref{3592,,SSLSocket.cipher()} method of SSL sockets will
give the currently selected cipher.

TLS 1.3 cipher suites cannot be disabled with
@ref{36a5,,set_ciphers()}.
@end quotation
@end cartouche
@end deffn

@geindex set_alpn_protocols() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_alpn_protocols}@anchor{e93}
@deffn {Método} SSLContext.set_alpn_protocols (alpn_protocols)

Specify which protocols the socket should advertise during the SSL/TLS
handshake. It should be a list of ASCII strings, like @code{['http/1.1',
'spdy/2']}, ordered by preference. The selection of a protocol will happen
during the handshake, and will play out according to 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html}. After a
successful handshake, the @ref{e94,,SSLSocket.selected_alpn_protocol()} method will
return the agreed-upon protocol.

This method will raise @ref{228,,NotImplementedError} if @ref{e95,,HAS_ALPN} is
@code{False}.


Adicionado na versão 3.5.

@end deffn

@geindex set_npn_protocols() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_npn_protocols}@anchor{302}
@deffn {Método} SSLContext.set_npn_protocols (npn_protocols)

Specify which protocols the socket should advertise during the SSL/TLS
handshake. It should be a list of strings, like @code{['http/1.1', 'spdy/2']},
ordered by preference. The selection of a protocol will happen during the
handshake, and will play out according to the Application Layer Protocol Negotiation@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation}. After a
successful handshake, the @ref{878,,SSLSocket.selected_npn_protocol()} method will
return the agreed-upon protocol.

This method will raise @ref{228,,NotImplementedError} if @ref{3689,,HAS_NPN} is
@code{False}.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.10: NPN has been superseded by ALPN

@end deffn

@geindex sni_callback (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sni_callback}@anchor{1a1b}
@deffn {Atributo} SSLContext.sni_callback

Register a callback function that will be called after the TLS Client Hello
handshake message has been received by the SSL/TLS server when the TLS client
specifies a server name indication. The server name indication mechanism
is specified in 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html} section 3 - Server Name Indication.

Only one callback can be set per @code{SSLContext}.  If `sni_callback'
is set to @code{None} then the callback is disabled. Calling this function a
subsequent time will disable the previously registered callback.

The callback function will be called with three
arguments; the first being the @ref{8f0,,ssl.SSLSocket}, the second is a string
that represents the server name that the client is intending to communicate
(or @ref{675,,None} if the TLS Client Hello does not contain a server name)
and the third argument is the original @ref{294,,SSLContext}. The server name
argument is text. For internationalized domain name, the server
name is an IDN A-label (@code{"xn--pythn-mua.org"}).

A typical use of this callback is to change the @ref{8f0,,ssl.SSLSocket}’s
@ref{369f,,SSLSocket.context} attribute to a new object of type
@ref{294,,SSLContext} representing a certificate chain that matches the server
name.

Due to the early negotiation phase of the TLS connection, only limited
methods and attributes are usable like
@ref{e94,,SSLSocket.selected_alpn_protocol()} and @ref{369f,,SSLSocket.context}.
The @ref{fec,,SSLSocket.getpeercert()}, @ref{16c6,,SSLSocket.get_verified_chain()},
@ref{16c7,,SSLSocket.get_unverified_chain()} @ref{3592,,SSLSocket.cipher()}
and @ref{1184,,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.

The `sni_callback' function must return @code{None} to allow the
TLS negotiation to continue.  If a TLS failure is required, a constant
@ref{3692,,ALERT_DESCRIPTION_*} can be
returned.  Other return values will result in a TLS fatal error with
@ref{3692,,ALERT_DESCRIPTION_INTERNAL_ERROR}.

If an exception is raised from the `sni_callback' function the TLS
connection will terminate with a fatal TLS alert message
@ref{3691,,ALERT_DESCRIPTION_HANDSHAKE_FAILURE}.

This method will raise @ref{228,,NotImplementedError} if the OpenSSL library
had OPENSSL_NO_TLSEXT defined when it was built.


Adicionado na versão 3.7.

@end deffn

@geindex set_servername_callback() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_servername_callback}@anchor{feb}
@deffn {Método} SSLContext.set_servername_callback (server_name_callback)

This is a legacy API retained for backwards compatibility. When possible,
you should use @ref{1a1b,,sni_callback} instead. The given `server_name_callback'
is similar to `sni_callback', except that when the server hostname is an
IDN-encoded internationalized domain name, the `server_name_callback'
receives a decoded U-label (@code{"pythön.org"}).

If there is a decoding error on the server name, the TLS connection will
terminate with an @ref{3692,,ALERT_DESCRIPTION_INTERNAL_ERROR} fatal TLS
alert message to the client.


Adicionado na versão 3.4.

@end deffn

@geindex load_dh_params() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext load_dh_params}@anchor{1181}
@deffn {Método} SSLContext.load_dh_params (dhfile, /)

Load the key generation parameters for Diffie-Hellman (DH) key exchange.
Using DH key exchange improves forward secrecy at the expense of
computational resources (both on the server and on the client).
The `dhfile' parameter should be the path to a file containing DH
parameters in PEM format.

This setting doesn’t apply to client sockets.  You can also use the
@ref{3681,,OP_SINGLE_DH_USE} option to further improve security.


Adicionado na versão 3.3.

@end deffn

@geindex set_ecdh_curve() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_ecdh_curve}@anchor{1182}
@deffn {Método} SSLContext.set_ecdh_curve (curve_name, /)

Set the curve name for Elliptic Curve-based Diffie-Hellman (ECDH) key
exchange.  ECDH is significantly faster than regular DH while arguably
as secure.  The `curve_name' parameter should be a string describing
a well-known elliptic curve, for example @code{prime256v1} for a widely
supported curve.

This setting doesn’t apply to client sockets.  You can also use the
@ref{3682,,OP_SINGLE_ECDH_USE} option to further improve security.

This method is not available if @ref{3687,,HAS_ECDH} is @code{False}.


Adicionado na versão 3.3.



@subsubheading Ver também



@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 ssl.SSLContext)
@anchor{library/ssl ssl SSLContext wrap_socket}@anchor{525}
@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{36a6,,SSLContext.sslsocket_class} (default @ref{8f0,,SSLSocket}). The
returned SSL socket is tied to the context, its settings and certificates.
`sock' must be a @ref{1337,,SOCK_STREAM} socket; other
socket types are unsupported.

The parameter @code{server_side} is a boolean which identifies whether
server-side or client-side behavior is desired from this socket.

For client-side sockets, the context construction is lazy; if the
underlying socket isn’t connected yet, the context construction will be
performed after @code{connect()} is called on the socket.  For
server-side sockets, if the socket has no remote peer, it is assumed
to be a listening socket, and the server-side SSL wrapping is
automatically performed on client connections accepted via the
@code{accept()} method. The method may raise @ref{12bb,,SSLError}.

On client connections, the optional parameter `server_hostname' specifies
the hostname of the service which we are connecting to.  This allows a
single server to host multiple SSL-based services with distinct certificates,
quite similarly to HTTP virtual hosts. Specifying `server_hostname' will
raise a @ref{202,,ValueError} if `server_side' is true.

The parameter @code{do_handshake_on_connect} specifies whether to do the SSL
handshake automatically after doing a @code{socket.connect()}, or whether the
application program will call it explicitly, by invoking the
@ref{e9c,,SSLSocket.do_handshake()} method.  Calling
@ref{e9c,,SSLSocket.do_handshake()} explicitly gives the program control over the
blocking behavior of the socket I/O involved in the handshake.

The parameter @code{suppress_ragged_eofs} specifies how the
@code{SSLSocket.recv()} method should signal unexpected EOF from the other end
of the connection.  If specified as @ref{c27,,True} (the default), it returns a
normal EOF (an empty bytes object) in response to unexpected EOF errors
raised from the underlying socket; if @ref{b49,,False}, it will raise the
exceptions back to the caller.

`session', see @ref{1693,,session}.

To wrap an @ref{8f0,,SSLSocket} in another @ref{8f0,,SSLSocket}, use
@ref{b9a,,SSLContext.wrap_bio()}.


Alterado na versão 3.5: Always allow a server_hostname to be passed, even if OpenSSL does not
have SNI.



Alterado na versão 3.6: o argumento `session' foi adicionado.



Alterado na versão 3.7: The method returns an instance of @ref{36a6,,SSLContext.sslsocket_class}
instead of hard-coded @ref{8f0,,SSLSocket}.

@end deffn

@geindex sslsocket_class (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sslsocket_class}@anchor{36a6}
@deffn {Atributo} SSLContext.sslsocket_class

The return type of @ref{525,,SSLContext.wrap_socket()}, defaults to
@ref{8f0,,SSLSocket}. The attribute can be assigned to on instances of
@ref{294,,SSLContext} in order to return a custom subclass of
@ref{8f0,,SSLSocket}.


Adicionado na versão 3.7.

@end deffn

@geindex wrap_bio() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext wrap_bio}@anchor{b9a}
@deffn {Método} SSLContext.wrap_bio (incoming, outgoing, server_side=False, server_hostname=None, session=None)

Wrap the BIO objects `incoming' and `outgoing' and return an instance of
@ref{36a7,,SSLContext.sslobject_class} (default @ref{b99,,SSLObject}). The SSL
routines will read input data from the incoming BIO and write data to the
outgoing BIO.

The `server_side', `server_hostname' and `session' parameters have the
same meaning as in @ref{525,,SSLContext.wrap_socket()}.


Alterado na versão 3.6: o argumento `session' foi adicionado.



Alterado na versão 3.7: The method returns an instance of @ref{36a7,,SSLContext.sslobject_class}
instead of hard-coded @ref{b99,,SSLObject}.

@end deffn

@geindex sslobject_class (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext sslobject_class}@anchor{36a7}
@deffn {Atributo} SSLContext.sslobject_class

The return type of @ref{b9a,,SSLContext.wrap_bio()}, defaults to
@ref{b99,,SSLObject}. The attribute can be overridden on instance of class
in order to return a custom subclass of @ref{b99,,SSLObject}.


Adicionado na versão 3.7.

@end deffn

@geindex session_stats() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext session_stats}@anchor{36a8}
@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 ssl.SSLContext)
@anchor{library/ssl ssl SSLContext check_hostname}@anchor{3676}
@deffn {Atributo} SSLContext.check_hostname

Whether to match the peer cert’s hostname in
@ref{e9c,,SSLSocket.do_handshake()}. The context’s
@ref{3662,,verify_mode} must be set to @ref{3675,,CERT_OPTIONAL} or
@ref{3663,,CERT_REQUIRED}, and you must pass `server_hostname' to
@ref{525,,wrap_socket()} in order to match the hostname.  Enabling
hostname checking automatically sets @ref{3662,,verify_mode} from
@ref{3674,,CERT_NONE} to @ref{3663,,CERT_REQUIRED}.  It cannot be set back to
@ref{3674,,CERT_NONE} as long as hostname checking is enabled. The
@ref{876,,PROTOCOL_TLS_CLIENT} protocol enables hostname checking by default.
With other protocols, hostname checking must be enabled explicitly.

Exemplo:

@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


Adicionado na versão 3.4.



Alterado na versão 3.7: @ref{3662,,verify_mode} is now automatically changed
to @ref{3663,,CERT_REQUIRED}  when hostname checking is enabled and
@ref{3662,,verify_mode} is @ref{3674,,CERT_NONE}. Previously
the same operation would have failed with a @ref{202,,ValueError}.

@end deffn

@geindex keylog_filename (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext keylog_filename}@anchor{3664}
@deffn {Atributo} SSLContext.keylog_filename

Write TLS keys to a keylog file, whenever key material is generated or
received. The keylog file is designed for debugging purposes only. The
file format is specified by NSS and used by many traffic analyzers such
as Wireshark. The log file is opened in append-only mode. Writes are
synchronized between threads, but not between processes.


Adicionado na versão 3.8.

@end deffn

@geindex maximum_version (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext maximum_version}@anchor{875}
@deffn {Atributo} SSLContext.maximum_version

A @ref{3695,,TLSVersion} enum member representing the highest supported
TLS version. The value defaults to @ref{3697,,TLSVersion.MAXIMUM_SUPPORTED}.
The attribute is read-only for protocols other than @ref{3665,,PROTOCOL_TLS},
@ref{876,,PROTOCOL_TLS_CLIENT}, and @ref{877,,PROTOCOL_TLS_SERVER}.

The attributes @ref{875,,maximum_version},
@ref{874,,minimum_version} and
@ref{83b,,SSLContext.options} all affect the supported SSL
and TLS versions of the context. The implementation does not prevent
invalid combination. For example a context with
@ref{367f,,OP_NO_TLSv1_2} in @ref{83b,,options} and
@ref{875,,maximum_version} set to @ref{369b,,TLSVersion.TLSv1_2}
will not be able to establish a TLS 1.2 connection.


Adicionado na versão 3.7.

@end deffn

@geindex minimum_version (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext minimum_version}@anchor{874}
@deffn {Atributo} SSLContext.minimum_version

Like @ref{875,,SSLContext.maximum_version} except it is the lowest
supported version or @ref{3696,,TLSVersion.MINIMUM_SUPPORTED}.


Adicionado na versão 3.7.

@end deffn

@geindex num_tickets (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext num_tickets}@anchor{36a9}
@deffn {Atributo} SSLContext.num_tickets

Control the number of TLS 1.3 session tickets of a
@ref{877,,PROTOCOL_TLS_SERVER} context. The setting has no impact on TLS
1.0 to 1.2 connections.


Adicionado na versão 3.8.

@end deffn

@geindex options (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext options}@anchor{83b}
@deffn {Atributo} SSLContext.options

An integer representing the set of SSL options enabled on this context.
The default value is @ref{367c,,OP_ALL}, but you can specify other options
such as @ref{83c,,OP_NO_SSLv2} by ORing them together.


Alterado na versão 3.6: @ref{83b,,SSLContext.options} returns @ref{3684,,Options} flags:

@example
>>> ssl.create_default_context().options
<Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>
@end example



Descontinuado desde a versão 3.7: All @code{OP_NO_SSL*} and @code{OP_NO_TLS*} options have been deprecated since
Python 3.7. Use @ref{874,,SSLContext.minimum_version} and
@ref{875,,SSLContext.maximum_version} instead.

@end deffn

@geindex post_handshake_auth (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext post_handshake_auth}@anchor{a3b}
@deffn {Atributo} SSLContext.post_handshake_auth

Enable TLS 1.3 post-handshake client authentication. Post-handshake auth
is disabled by default and a server can only request a TLS client
certificate during the initial handshake. When enabled, a server may
request a TLS client certificate at any time after the handshake.

When enabled on client-side sockets, the client signals the server that
it supports post-handshake authentication.

When enabled on server-side sockets, @ref{3662,,SSLContext.verify_mode} must
be set to @ref{3675,,CERT_OPTIONAL} or @ref{3663,,CERT_REQUIRED}, too. The
actual client cert exchange is delayed until
@ref{a3c,,SSLSocket.verify_client_post_handshake()} is called and some I/O is
performed.


Adicionado na versão 3.8.

@end deffn

@geindex protocol (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext protocol}@anchor{36aa}
@deffn {Atributo} SSLContext.protocol

The protocol version chosen when constructing the context.  This attribute
is read-only.
@end deffn

@geindex hostname_checks_common_name (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext hostname_checks_common_name}@anchor{b95}
@deffn {Atributo} SSLContext.hostname_checks_common_name

Whether @ref{3676,,check_hostname} falls back to verify the cert’s
subject common name in the absence of a subject alternative name
extension (default: true).


Adicionado na versão 3.7.



Alterado na versão 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 ssl.SSLContext)
@anchor{library/ssl ssl SSLContext security_level}@anchor{36ab}
@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.


Adicionado na versão 3.10.

@end deffn

@geindex verify_flags (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext verify_flags}@anchor{fe2}
@deffn {Atributo} SSLContext.verify_flags

The flags for certificate verification operations. You can set flags like
@ref{fe4,,VERIFY_CRL_CHECK_LEAF} by ORing them together. By default OpenSSL
does neither require nor verify certificate revocation lists (CRLs).


Adicionado na versão 3.4.



Alterado na versão 3.6: @ref{fe2,,SSLContext.verify_flags} returns @ref{3679,,VerifyFlags} flags:

@example
>>> ssl.create_default_context().verify_flags
<VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>
@end example

@end deffn

@geindex verify_mode (atributo ssl.SSLContext)
@anchor{library/ssl ssl SSLContext verify_mode}@anchor{3662}
@deffn {Atributo} SSLContext.verify_mode

Whether to try to verify other peers’ certificates and how to behave
if verification fails.  This attribute must be one of
@ref{3674,,CERT_NONE}, @ref{3675,,CERT_OPTIONAL} or @ref{3663,,CERT_REQUIRED}.


Alterado na versão 3.6: @ref{3662,,SSLContext.verify_mode} returns @ref{3677,,VerifyMode} enum:

@example
>>> ssl.create_default_context().verify_mode
<VerifyMode.CERT_REQUIRED: 2>
@end example

@end deffn

@geindex set_psk_client_callback() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_psk_client_callback}@anchor{36ac}
@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{d4f,,bytes-like object} representing the pre-shared key. Return a zero
length PSK to reject the connection.

Setting @code{callback} to @ref{675,,None} removes any existing callback.

@cartouche
@quotation Nota 
When using TLS 1.3:


@itemize -

@item 
the @code{hint} parameter is always @ref{675,,None}.

@item 
client-identity must be a non-empty string.
@end itemize
@end quotation
@end cartouche

Exemplo de uso:

@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{228,,NotImplementedError} if @ref{368f,,HAS_PSK} is
@code{False}.


Adicionado na versão 3.13.

@end deffn

@geindex set_psk_server_callback() (método ssl.SSLContext)
@anchor{library/ssl ssl SSLContext set_psk_server_callback}@anchor{36ad}
@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{d4f,,bytes-like object} representing the pre-shared key.
Return a zero length PSK to reject the connection.

Setting @code{callback} to @ref{675,,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

Exemplo de uso:

@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{228,,NotImplementedError} if @ref{368f,,HAS_PSK} is
@code{False}.


Adicionado na versão 3.13.

@end deffn

@geindex сертифікати

@geindex X509 certificate

@node Certificados,Exemplos<20>,SSL Contexts,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl certificates}@anchor{36ae}@anchor{library/ssl ssl-certificates}@anchor{36a4}
@subsubsection Certificados


Certificates in general are part of a public-key / private-key system.  In this
system, each `principal', (which may be a machine, or a person, or an
organization) is assigned a unique two-part encryption key.  One part of the key
is public, and is called the `public key'; the other part is kept secret, and is
called the `private key'.  The two parts are related, in that if you encrypt a
message with one of the parts, you can decrypt it with the other part, and
`only' with the other part.

A certificate contains information about two principals.  It contains the name
of a `subject', and the subject’s public key.  It also contains a statement by a
second principal, the `issuer', that the subject is who they claim to be, and
that this is indeed the subject’s public key.  The issuer’s statement is signed
with the issuer’s private key, which only the issuer knows.  However, anyone can
verify the issuer’s statement by finding the issuer’s public key, decrypting the
statement with it, and comparing it to the other information in the certificate.
The certificate also contains information about the time period over which it is
valid.  This is expressed as two fields, called “notBefore” and “notAfter”.

In the Python use of certificates, a client or server can use a certificate to
prove who they are.  The other side of a network connection can also be required
to produce a certificate, and that certificate can be validated to the
satisfaction of the client or server that requires such validation.  The
connection attempt can be set to raise an exception if the validation fails.
Validation is done automatically, by the underlying OpenSSL framework; the
application need not concern itself with its mechanics.  But the application
does usually need to provide sets of certificates to allow this process to take
place.

Python uses files to contain certificates.  They should be formatted as “PEM”
(see 
@geindex RFC; RFC 1422
RFC 1422@footnote{https://datatracker.ietf.org/doc/html/rfc1422.html}), which is a base-64 encoded form wrapped with a header line
and a footer line:

@example
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
@end example

@menu
* Certificate chains:: 
* CA certificates:: 
* Combined key and certificate:: 
* Self-signed certificates:: 

@end menu

@node Certificate chains,CA certificates,,Certificados
@anchor{library/ssl certificate-chains}@anchor{36af}
@subsubsection Certificate chains


The Python files which contain certificates can contain a sequence of
certificates, sometimes called a `certificate chain'.  This chain should start
with the specific certificate for the principal who “is” the client or server,
and then the certificate for the issuer of that certificate, and then the
certificate for the issuer of `that' certificate, and so on up the chain till
you get to a certificate which is `self-signed', that is, a certificate which
has the same subject and issuer, sometimes called a `root certificate'.  The
certificates should just be concatenated together in the certificate file.  For
example, suppose we had a three certificate chain, from our server certificate
to the certificate of the certification authority that signed our server
certificate, to the root certificate of the agency which issued the
certification authority’s certificate:

@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 CA certificates,Combined key and certificate,Certificate chains,Certificados
@anchor{library/ssl ca-certificates}@anchor{36b0}
@subsubsection CA certificates


If you are going to require validation of the other side of the connection’s
certificate, you need to provide a “CA certs” file, filled with the certificate
chains for each issuer you are willing to trust.  Again, this file just contains
these chains concatenated together.  For validation, Python will use the first
chain it finds in the file which matches.  The platform’s certificates file can
be used by calling @ref{fe6,,SSLContext.load_default_certs()}, this is done
automatically with @ref{155,,create_default_context()}.

@node Combined key and certificate,Self-signed certificates,CA certificates,Certificados
@anchor{library/ssl combined-key-and-certificate}@anchor{36b1}
@subsubsection Combined key and certificate


Often the private key is stored in the same file as the certificate; in this
case, only the @code{certfile} parameter to @ref{295,,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 Self-signed certificates,,Combined key and certificate,Certificados
@anchor{library/ssl self-signed-certificates}@anchor{36b2}
@subsubsection Self-signed certificates


If you are going to create a server that provides SSL-encrypted connection
services, you will need to acquire a certificate for that service.  There are
many ways of acquiring appropriate certificates, such as buying one from a
certification authority.  Another common practice is to generate a self-signed
certificate.  The simplest way to do this is with the OpenSSL package, using
something like the following:

@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

The disadvantage of a self-signed certificate is that it is its own root
certificate, and no one else will have it in their cache of known (and trusted)
root certificates.

@node Exemplos<20>,Notes on non-blocking sockets,Certificados,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl examples}@anchor{36b3}
@subsubsection Exemplos


@menu
* Testing for SSL support:: 
* Client-side operation:: 
* Server-side operation:: 

@end menu

@node Testing for SSL support,Client-side operation,,Exemplos<20>
@anchor{library/ssl testing-for-ssl-support}@anchor{36b4}
@subsubsection Testing for SSL support


To test for the presence of SSL support in a Python installation, user code
should use the following idiom:

@example
try:
    import ssl
except ImportError:
    pass
else:
    ...  # do something that requires SSL support
@end example

@node Client-side operation,Server-side operation,Testing for SSL support,Exemplos<20>
@anchor{library/ssl client-side-operation}@anchor{36b5}
@subsubsection Client-side operation


This example creates a SSL context with the recommended security settings
for client sockets, including automatic certificate verification:

@example
>>> context = ssl.create_default_context()
@end example

If you prefer to tune security settings yourself, you might create
a context from scratch (but beware that you might not get the settings
right):

@example
>>> context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")
@end example

(this snippet assumes your operating system places a bundle of all CA
certificates in @code{/etc/ssl/certs/ca-bundle.crt}; if not, you’ll get an
error and have to adjust the location)

The @ref{876,,PROTOCOL_TLS_CLIENT} protocol configures the context for cert
validation and hostname verification. @ref{3662,,verify_mode} is
set to @ref{3663,,CERT_REQUIRED} and @ref{3676,,check_hostname} is set
to @code{True}. All other protocols create SSL contexts with insecure defaults.

When you use the context to connect to a server, @ref{3663,,CERT_REQUIRED}
and @ref{3676,,check_hostname} validate the server certificate: it
ensures that the server certificate was signed with one of the CA
certificates, checks the signature for correctness, and verifies other
properties like validity and identity of the hostname:

@example
>>> conn = context.wrap_socket(socket.socket(socket.AF_INET),
...                            server_hostname="www.python.org")
>>> conn.connect(("www.python.org", 443))
@end example

You may then fetch the certificate:

@example
>>> cert = conn.getpeercert()
@end example

Visual inspection shows that the certificate does identify the desired service
(that is, the HTTPS host @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

Now the SSL channel is established and the certificate verified, you can
proceed to talk with the server:

@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

See the discussion of @ref{354c,,Considerações de segurança} below.

@node Server-side operation,,Client-side operation,Exemplos<20>
@anchor{library/ssl server-side-operation}@anchor{36b6}
@subsubsection Server-side operation


For server operation, typically you’ll need to have a server certificate, and
private key, each in a file.  You’ll first create a context holding the key
and the certificate, so that clients can check your authenticity.  Then
you’ll open a socket, bind it to a port, call @code{listen()} on it, and start
waiting for clients to connect:

@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

When a client connects, you’ll call @code{accept()} on the socket to get the
new socket from the other end, and use the context’s @ref{525,,SSLContext.wrap_socket()}
method to create a server-side SSL socket for the connection:

@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

Then you’ll read data from the @code{connstream} and do something with it till you
are finished with the client (or the client is finished with you):

@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

And go back to listening for new client connections (of course, a real server
would probably handle each client connection in a separate thread, or put
the sockets in @ref{3668,,non-blocking mode} and use an event loop).

@node Notes on non-blocking sockets,Підтримка BIO пам’яті<2>,Exemplos<20>,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl notes-on-non-blocking-sockets}@anchor{36b7}@anchor{library/ssl ssl-nonblocking}@anchor{3668}
@subsubsection Notes on non-blocking sockets


SSL sockets behave slightly different than regular sockets in
non-blocking mode. When working with non-blocking sockets, there are
thus several things you need to be aware of:


@itemize -

@item 
Most @ref{8f0,,SSLSocket} methods will raise either
@ref{e99,,SSLWantWriteError} or @ref{e98,,SSLWantReadError} instead of
@ref{1090,,BlockingIOError} if an I/O operation would
block. @ref{e98,,SSLWantReadError} will be raised if a read operation on
the underlying socket is necessary, and @ref{e99,,SSLWantWriteError} for
a write operation on the underlying socket. Note that attempts to
`write' to an SSL socket may require `reading' from the underlying
socket first, and attempts to `read' from the SSL socket may require
a prior `write' to the underlying socket.


Alterado na versão 3.5: In earlier Python versions, the @code{SSLSocket.send()} method
returned zero instead of raising @ref{e99,,SSLWantWriteError} or
@ref{e98,,SSLWantReadError}.


@item 
Calling @ref{dc8,,select()} tells you that the OS-level socket can be
read from (or written to), but it does not imply that there is sufficient
data at the upper SSL layer.  For example, only part of an SSL frame might
have arrived.  Therefore, you must be ready to handle @code{SSLSocket.recv()}
and @code{SSLSocket.send()} failures, and retry after another call to
@ref{dc8,,select()}.

@item 
Conversely, since the SSL layer has its own framing, a SSL socket may
still have data available for reading without @ref{dc8,,select()}
being aware of it.  Therefore, you should first call
@code{SSLSocket.recv()} to drain any potentially available data, and then
only block on a @ref{dc8,,select()} call if still necessary.

(of course, similar provisions apply when using other primitives such as
@ref{2d8a,,poll()}, or those in the @ref{c2,,selectors} module)

@item 
The SSL handshake itself will be non-blocking: the
@ref{e9c,,SSLSocket.do_handshake()} method has to be retried until it returns
successfully.  Here is a synopsis using @ref{dc8,,select()} to wait for
the socket’s readiness:

@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 também


The @ref{a,,asyncio} module supports @ref{3668,,non-blocking SSL sockets} and provides a higher level @ref{3477,,Streams API}.
It polls for events using the @ref{c2,,selectors} module and
handles @ref{e99,,SSLWantWriteError}, @ref{e98,,SSLWantReadError} and
@ref{1090,,BlockingIOError} exceptions. It runs the SSL handshake asynchronously
as well.


@node Підтримка BIO пам’яті<2>,SSL session,Notes on non-blocking sockets,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl memory-bio-support}@anchor{36b8}
@subsubsection Підтримка BIO пам’яті



Adicionado na versão 3.5.


Ever since the SSL module was introduced in Python 2.6, the @ref{8f0,,SSLSocket}
class has provided two related but distinct areas of functionality:


@itemize -

@item 
SSL protocol handling

@item 
Network IO
@end itemize

The network IO API is identical to that provided by @ref{dc9,,socket.socket},
from which @ref{8f0,,SSLSocket} also inherits. This allows an SSL socket to be
used as a drop-in replacement for a regular socket, making it very easy to add
SSL support to an existing application.

Combining SSL protocol handling and network IO usually works well, but there
are some cases where it doesn’t. An example is async IO frameworks that want to
use a different IO multiplexing model than the “select/poll on a file
descriptor” (readiness based) model that is assumed by @ref{dc9,,socket.socket}
and by the internal OpenSSL socket IO routines. This is mostly relevant for
platforms like Windows where this model is not efficient. For this purpose, a
reduced scope variant of @ref{8f0,,SSLSocket} called @ref{b99,,SSLObject} is
provided.

@geindex SSLObject (classe em ssl)
@anchor{library/ssl ssl SSLObject}@anchor{b99}
@deffn {Classe} ssl.SSLObject

A reduced-scope variant of @ref{8f0,,SSLSocket} representing an SSL protocol
instance that does not contain any network IO methods. This class is
typically used by framework authors that want to implement asynchronous IO
for SSL through memory buffers.

This class implements an interface on top of a low-level SSL object as
implemented by OpenSSL. This object captures the state of an SSL connection
but does not provide any network IO itself. IO needs to be performed through
separate “BIO” objects which are OpenSSL’s IO abstraction layer.

This class has no public constructor.  An @ref{b99,,SSLObject} instance
must be created using the @ref{b9a,,wrap_bio()} method. This
method will create the @ref{b99,,SSLObject} instance and bind it to a
pair of BIOs. The `incoming' BIO is used to pass data from Python to the
SSL protocol instance, while the `outgoing' BIO is used to pass data the
other way around.

The following methods are available:


@itemize -

@item 
@ref{369f,,context}

@item 
@ref{36a1,,server_side}

@item 
@ref{b97,,server_hostname}

@item 
@ref{1693,,session}

@item 
@ref{36a2,,session_reused}

@item 
@ref{e9d,,read()}

@item 
@ref{e9e,,write()}

@item 
@ref{fec,,getpeercert()}

@item 
@ref{16c6,,get_verified_chain()}

@item 
@ref{16c7,,get_unverified_chain()}

@item 
@ref{e94,,selected_alpn_protocol()}

@item 
@ref{878,,selected_npn_protocol()}

@item 
@ref{3592,,cipher()}

@item 
@ref{e9b,,shared_ciphers()}

@item 
@ref{1184,,compression()}

@item 
@ref{36a0,,pending()}

@item 
@ref{e9c,,do_handshake()}

@item 
@ref{a3c,,verify_client_post_handshake()}

@item 
@ref{369e,,unwrap()}

@item 
@ref{1183,,get_channel_binding()}

@item 
@ref{e97,,version()}
@end itemize

When compared to @ref{8f0,,SSLSocket}, this object lacks the following
features:


@itemize -

@item 
Any form of network IO; @code{recv()} and @code{send()} read and write only to
the underlying @ref{e91,,MemoryBIO} buffers.

@item 
There is no `do_handshake_on_connect' machinery. You must always manually
call @ref{e9c,,do_handshake()} to start the handshake.

@item 
There is no handling of `suppress_ragged_eofs'. All end-of-file conditions
that are in violation of the protocol are reported via the
@ref{1840,,SSLEOFError} exception.

@item 
The method @ref{369e,,unwrap()} call does not return anything,
unlike for an SSL socket where it returns the underlying socket.

@item 
The `server_name_callback' callback passed to
@ref{feb,,SSLContext.set_servername_callback()} will get an @ref{b99,,SSLObject}
instance instead of a @ref{8f0,,SSLSocket} instance as its first parameter.
@end itemize

Some notes related to the use of @ref{b99,,SSLObject}:


@itemize -

@item 
All IO on an @ref{b99,,SSLObject} is @ref{3668,,non-blocking}.
This means that for example @ref{e9d,,read()} will raise an
@ref{e98,,SSLWantReadError} if it needs more data than the incoming BIO has
available.
@end itemize


Alterado na versão 3.7: @ref{b99,,SSLObject} instances must be created with
@ref{b9a,,wrap_bio()}. In earlier versions, it was possible to
create instances directly. This was never documented or officially
supported.

@end deffn

An SSLObject communicates with the outside world using memory buffers. The
class @ref{e91,,MemoryBIO} provides a memory buffer that can be used for this
purpose.  It wraps an OpenSSL memory BIO (Basic IO) object:

@geindex MemoryBIO (classe em ssl)
@anchor{library/ssl ssl MemoryBIO}@anchor{e91}
@deffn {Classe} ssl.MemoryBIO

A memory buffer that can be used to pass data between Python and an SSL
protocol instance.

@geindex pending (atributo ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO pending}@anchor{36b9}
@deffn {Atributo} pending

Return the number of bytes currently in the memory buffer.
@end deffn

@geindex eof (atributo ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO eof}@anchor{36ba}
@deffn {Atributo} eof

A boolean indicating whether the memory BIO is current at the end-of-file
position.
@end deffn

@geindex read() (método ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO read}@anchor{36bb}
@deffn {Método} read (n=-1, /)

Read up to `n' bytes from the memory buffer. If `n' is not specified or
negative, all bytes are returned.
@end deffn

@geindex write() (método ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO write}@anchor{36bc}
@deffn {Método} write (buf, /)

Write the bytes from `buf' to the memory BIO. The `buf' argument must be an
object supporting the buffer protocol.

The return value is the number of bytes written, which is always equal to
the length of `buf'.
@end deffn

@geindex write_eof() (método ssl.MemoryBIO)
@anchor{library/ssl ssl MemoryBIO write_eof}@anchor{36bd}
@deffn {Método} write_eof ()

Write an EOF marker to the memory BIO. After this method has been called, it
is illegal to call @ref{36bc,,write()}. The attribute @ref{36ba,,eof} will
become true after all data currently in the buffer has been read.
@end deffn
@end deffn

@node SSL session,Considerações de segurança<2>,Підтримка BIO пам’яті<2>,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl ssl-session}@anchor{36be}
@subsubsection SSL session



Adicionado na versão 3.6.


@geindex SSLSession (classe em ssl)
@anchor{library/ssl ssl SSLSession}@anchor{cfe}
@deffn {Classe} ssl.SSLSession

Session object used by @ref{1693,,session}.

@geindex id (atributo ssl.SSLSession)
@anchor{library/ssl ssl SSLSession id}@anchor{36bf}
@deffn {Atributo} id
@end deffn

@geindex time (atributo ssl.SSLSession)
@anchor{library/ssl ssl SSLSession time}@anchor{36c0}
@deffn {Atributo} time
@end deffn

@geindex timeout (atributo ssl.SSLSession)
@anchor{library/ssl ssl SSLSession timeout}@anchor{36c1}
@deffn {Atributo} timeout
@end deffn

@geindex ticket_lifetime_hint (atributo ssl.SSLSession)
@anchor{library/ssl ssl SSLSession ticket_lifetime_hint}@anchor{36c2}
@deffn {Atributo} ticket_lifetime_hint
@end deffn

@geindex has_ticket (atributo ssl.SSLSession)
@anchor{library/ssl ssl SSLSession has_ticket}@anchor{36c3}
@deffn {Atributo} has_ticket
@end deffn
@end deffn

@node Considerações de segurança<2>,TLS 1 3,SSL session,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl security-considerations}@anchor{36c4}@anchor{library/ssl ssl-security}@anchor{354c}
@subsubsection Considerações de segurança


@menu
* Best defaults:: 
* Manual settings:: 
* Multi-processing:: 

@end menu

@node Best defaults,Manual settings,,Considerações de segurança<2>
@anchor{library/ssl best-defaults}@anchor{36c5}
@subsubsection Best defaults


For `client use', if you don’t have any special requirements for your
security policy, it is highly recommended that you use the
@ref{155,,create_default_context()} function to create your SSL context.
It will load the system’s trusted CA certificates, enable certificate
validation and hostname checking, and try to choose reasonably secure
protocol and cipher settings.

For example, here is how you would use the @ref{934,,smtplib.SMTP} class to
create a trusted, secure connection to a SMTP server:

@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

If a client certificate is needed for the connection, it can be added with
@ref{295,,SSLContext.load_cert_chain()}.

By contrast, if you create the SSL context by calling the @ref{294,,SSLContext}
constructor yourself, it will not have certificate validation nor hostname
checking enabled by default.  If you do so, please read the paragraphs below
to achieve a good security level.

@node Manual settings,Multi-processing,Best defaults,Considerações de segurança<2>
@anchor{library/ssl manual-settings}@anchor{36c6}
@subsubsection Manual settings


@menu
* Verifying certificates:: 
* Protocol versions:: 
* Cipher selection:: 

@end menu

@node Verifying certificates,Protocol versions,,Manual settings
@anchor{library/ssl verifying-certificates}@anchor{36c7}
@subsubsection Verifying certificates


When calling the @ref{294,,SSLContext} constructor directly,
@ref{3674,,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{3663,,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{fec,,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{3676,,SSLContext.check_hostname} is enabled.


Alterado na versão 3.7: Hostname matchings is now performed by OpenSSL. Python no longer uses
@code{match_hostname()}.


In server mode, if you want to authenticate your clients using the SSL layer
(rather than using a higher-level authentication mechanism), you’ll also have
to specify @ref{3663,,CERT_REQUIRED} and similarly check the client certificate.

@node Protocol versions,Cipher selection,Verifying certificates,Manual settings
@anchor{library/ssl protocol-versions}@anchor{36c8}
@subsubsection Protocol versions


SSL versions 2 and 3 are considered insecure and are therefore dangerous to
use.  If you want maximum compatibility between clients and servers, it is
recommended to use @ref{876,,PROTOCOL_TLS_CLIENT} or
@ref{877,,PROTOCOL_TLS_SERVER} as the protocol version. SSLv2 and SSLv3 are
disabled by default.

@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{876,,PROTOCOL_TLS_CLIENT}
implies certificate validation and hostname checks by default. You have to
load certificates into the context.

@node Cipher selection,,Protocol versions,Manual settings
@anchor{library/ssl cipher-selection}@anchor{36c9}
@subsubsection Cipher selection


If you have advanced security requirements, fine-tuning of the ciphers
enabled when negotiating a SSL session is possible through the
@ref{36a5,,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{cff,,SSLContext.get_ciphers()} or the @code{openssl ciphers} command on your
system.

@node Multi-processing,,Manual settings,Considerações de segurança<2>
@anchor{library/ssl multi-processing}@anchor{36ca}
@subsubsection Multi-processing


If using this module as part of a multi-processed application (using,
for example the @ref{94,,multiprocessing} or @ref{21,,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{197,,os.fork()}.  Any
successful call of @ref{366e,,RAND_add()} or @ref{524,,RAND_bytes()} is
sufficient.

@node TLS 1 3,,Considerações de segurança<2>,ssl — Invólucro de TLS/SSL para objetos socket
@anchor{library/ssl ssl-tlsv1-3}@anchor{b98}@anchor{library/ssl tls-1-3}@anchor{36cb}
@subsubsection TLS 1.3



Adicionado na versão 3.7.


The TLS 1.3 protocol behaves slightly differently than previous version
of TLS/SSL. Some new TLS 1.3 features are not yet available.


@itemize -

@item 
TLS 1.3 uses a disjunct set of cipher suites. All AES-GCM and
ChaCha20 cipher suites are enabled by default.  The method
@ref{36a5,,SSLContext.set_ciphers()} cannot enable or disable any TLS 1.3
ciphers yet, but @ref{cff,,SSLContext.get_ciphers()} returns them.

@item 
Session tickets are no longer sent as part of the initial handshake and
are handled differently.  @ref{1693,,SSLSocket.session} and @ref{cfe,,SSLSession}
are not compatible with TLS 1.3.

@item 
Client-side certificates are also no longer verified during the initial
handshake.  A server can request a certificate at any time.  Clients
process certificate requests while they send or receive application data
from the server.

@item 
TLS 1.3 features like early data, deferred TLS client cert request,
signature algorithm configuration, and rekeying are not supported yet.
@end itemize


@subsubheading Ver também



@table @asis

@item Class @ref{dc9,,socket.socket}

Documentation of underlying @ref{cc,,socket} class

@item SSL/TLS Strong Encryption: An Introduction@footnote{https://httpd.apache.org/docs/trunk/en/ssl/ssl_intro.html}

Intro from the Apache HTTP Server documentation

@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. Eastlake, Jeffrey I. Schiller, Steve Crocker

@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}

David Cooper et al.

@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}

Tim Dierks and Eric Rescorla.

@geindex RFC; RFC 6066

@item RFC 6066: Transport Layer Security (TLS) Extensions@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html}

Donald E. 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 — Invólucro de TLS/SSL para objetos socket,Comunicação em Rede e Interprocesso
@anchor{library/select doc}@anchor{36cc}@anchor{library/select module-select}@anchor{c1}@anchor{library/select select-waiting-for-i-o-completion}@anchor{36cd}@anchor{library/select translation-repo}@anchor{36ce}
@subsection @code{select} — Waiting for I/O completion


@geindex module; select


__________________________________________________________________


Este módulo fornece acesso às funções @code{select()} e @code{poll()} disponíveis na maioria dos sistemas operacionais, @code{devpoll()} disponível no Solaris e derivados, @code{epoll()} disponível no Linux 2.5+ e @code{kqueue()} disponível na maioria dos BSD. Observe que no Windows, ele funciona apenas para sockets; em outros sistemas operacionais, ele também funciona para outros tipos de arquivo (em particular, no Unix, ele funciona em pipes). Ele não pode ser usado em arquivos regulares para determinar se um arquivo cresceu desde a última leitura.

@cartouche
@quotation Nota 
O módulo @ref{c2,,selectors} permite multiplexação de E/S de alto nível e eficiente, construída sobre as primitivas do módulo @ref{c1,,select}. Os usuários são encorajados a usar o módulo @ref{c2,,selectors} em vez disso, a menos que queiram controle preciso sobre as primitivas de nível de SO usadas.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

O módulo define o seguinte:

@geindex error
@anchor{library/select select error}@anchor{108f}
@deffn {Exceção} select.error

Um apelido descontinuado de @ref{417,,OSError}.


Alterado na versão 3.3: Seguindo a 
@geindex Propostas de Melhorias do Python; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}, esta classe foi transformada em um apelido de @ref{417,,OSError}.

@end deffn

@geindex devpoll() (no módulo select)
@anchor{library/select select devpoll}@anchor{fca}
@deffn {Função} select.devpoll ()

(Suportado somente no Solaris e derivados.) Retorna um objeto de pesquisa @code{/dev/poll}; consulte a seção @ref{36cf,,/dev/poll Polling Objects} abaixo para os métodos suportados pelos objetos devpoll.

Objetos @code{devpoll()} são vinculados ao número de descritores de arquivo permitidos no momento da instanciação. Se seu programa reduzir esse valor, @code{devpoll()} falhará. Se seu programa aumentar esse valor, @code{devpoll()} pode retornar uma lista incompleta de descritores de arquivo ativos.

O novo descritor de arquivo é @ref{f2b,,não herdável}.


Adicionado na versão 3.3.



Alterado na versão 3.4: O novo descritor de arquivo agora é não-hereditário.

@end deffn

@geindex epoll() (no módulo select)
@anchor{library/select select epoll}@anchor{fc8}
@deffn {Função} select.epoll (sizehint=-1, flags=0)

(Only supported on Linux 2.5.44 and newer.) Return an edge polling object,
which can be used as Edge or Level Triggered interface for I/O
events.

`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' is deprecated and completely ignored.  However, when supplied, its
value must be @code{0} or @code{select.EPOLL_CLOEXEC}, otherwise @code{OSError} is
raised.

See the @ref{36d0,,Edge and Level Trigger Polling (epoll) Objects} section below for the methods supported by
epolling objects.

@code{epoll} objects support the context management protocol: when used in a
@ref{5d2,,with} statement, the new file descriptor is automatically closed
at the end of the block.

O novo descritor de arquivo é @ref{f2b,,não herdável}.


Alterado na versão 3.3: Added the `flags' parameter.



Alterado na versão 3.4: Support for the @ref{5d2,,with} statement was added.
The new file descriptor is now non-inheritable.



Descontinuado desde a versão 3.4: The `flags' parameter.  @code{select.EPOLL_CLOEXEC} is used by default now.
Use @ref{f2d,,os.set_inheritable()} to make the file descriptor inheritable.

@end deffn

@geindex poll() (no módulo select)
@anchor{library/select select poll}@anchor{2d8a}
@deffn {Função} select.poll ()

(Not supported by all operating systems.)  Returns a polling object, which
supports registering and unregistering file descriptors, and then polling them
for I/O events; see section @ref{36d1,,Polling Objects} below for the methods supported
by polling objects.
@end deffn

@geindex kqueue() (no módulo select)
@anchor{library/select select kqueue}@anchor{17c0}
@deffn {Função} select.kqueue ()

(Only supported on BSD.)  Returns a kernel queue object; see section
@ref{36d2,,Kqueue Objects} below for the methods supported by kqueue objects.

O novo descritor de arquivo é @ref{f2b,,não herdável}.


Alterado na versão 3.4: O novo descritor de arquivo agora é não-hereditário.

@end deffn

@geindex kevent() (no módulo select)
@anchor{library/select select kevent}@anchor{36d3}
@deffn {Função} select.kevent (ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

(Only supported on BSD.)  Returns a kernel event object; see section
@ref{36d4,,Kevent Objects} below for the methods supported by kevent objects.
@end deffn

@geindex select() (no módulo select)
@anchor{library/select select select}@anchor{dc8}
@deffn {Função} select.select (rlist, wlist, xlist, timeout=None)

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{15d0,,fileno()} returning such an integer:


@itemize *

@item 
`rlist': wait until ready for reading

@item 
`wlist': wait until ready for writing

@item 
`xlist': wait for an “exceptional condition” (see the manual page for what
your system considers such a condition)
@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 or @code{None}, the function blocks until
at least one file descriptor is ready.  A time-out value of zero specifies a
poll and never blocks.

The return value is a triple of lists of objects that are ready: subsets of the
first three arguments.  When the time-out is reached without a file descriptor
becoming ready, three empty lists are returned.

@geindex socket() (in module socket)
@geindex popen() (no módulo os)

Among the acceptable object types in the iterables are Python @ref{1203,,file objects} (e.g. @code{sys.stdin}, or objects returned by
@ref{51c,,open()} or @ref{a91,,os.popen()}), socket objects returned by
@ref{dc9,,socket.socket()}.  You may also define a `wrapper' class yourself,
as long as it has an appropriate @ref{15d0,,fileno()} method (that
really returns a file descriptor, not just a random integer).

@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


Alterado na versão 3.5: The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of raising
@ref{db0,,InterruptedError}.

@end deffn

@geindex PIPE_BUF (no módulo select)
@anchor{library/select select PIPE_BUF}@anchor{124a}
@deffn {Dado} 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{dc8,,select()},
@code{poll()} or another interface in this module.  This doesn’t apply
to other kind of file-like objects such as sockets.

This value is guaranteed by POSIX to be at least 512.

@ref{1ed8,,Disponibilidade}: Unix


Adicionado na versão 3.2.

@end deffn

@menu
* /dev/poll Polling Objects:: 
* Edge and Level Trigger Polling (epoll) Objects: Edge and Level Trigger Polling epoll Objects. 
* Polling Objects:: 
* Kqueue Objects:: 
* Kevent Objects:: 

@end menu

@node /dev/poll Polling Objects,Edge and Level Trigger Polling epoll Objects,,select — Waiting for I/O completion
@anchor{library/select dev-poll-polling-objects}@anchor{36d5}@anchor{library/select devpoll-objects}@anchor{36cf}
@subsubsection @code{/dev/poll} Polling Objects


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 select.devpoll)
@anchor{library/select select devpoll close}@anchor{fcc}
@deffn {Método} devpoll.close ()

Close the file descriptor of the polling object.


Adicionado na versão 3.4.

@end deffn

@geindex closed (atributo select.devpoll)
@anchor{library/select select devpoll closed}@anchor{fcd}
@deffn {Atributo} devpoll.closed

@code{True} if the polling object is closed.


Adicionado na versão 3.4.

@end deffn

@geindex fileno() (método select.devpoll)
@anchor{library/select select devpoll fileno}@anchor{fcb}
@deffn {Método} devpoll.fileno ()

Return the file descriptor number of the polling object.


Adicionado na versão 3.4.

@end deffn

@geindex register() (método select.devpoll)
@anchor{library/select select devpoll register}@anchor{36d6}
@deffn {Método} devpoll.register (fd[, eventmask])

Register a file descriptor with the polling object.  Future calls to the
@ref{2d8a,,poll()} method will then check whether the file descriptor has any
pending I/O events.  `fd' can be either an integer, or an object with a
@ref{15d0,,fileno()} method that returns an integer.  File objects
implement @code{fileno()}, so they can also be used as the argument.

`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 Aviso 
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 select.devpoll)
@anchor{library/select select devpoll modify}@anchor{36d7}
@deffn {Método} devpoll.modify (fd[, eventmask])

This method does an @ref{36d8,,unregister()} followed by a
@ref{36d6,,register()}. It is (a bit) more efficient that doing the same
explicitly.
@end deffn

@geindex unregister() (método select.devpoll)
@anchor{library/select select devpoll unregister}@anchor{36d8}
@deffn {Método} devpoll.unregister (fd)

Remove a file descriptor being tracked by a polling object.  Just like the
@ref{36d6,,register()} method, `fd' can be an integer or an object with a
@ref{15d0,,fileno()} method that returns an integer.

Attempting to remove a file descriptor that was never registered is
safely ignored.
@end deffn

@geindex poll() (método select.devpoll)
@anchor{library/select select devpoll poll}@anchor{dc4}
@deffn {Método} devpoll.poll ([timeout])

Polls the set of registered file descriptors, and returns a possibly empty list
containing @code{(fd, event)} 2-tuples for the descriptors that have events or
errors to report. `fd' is the file descriptor, and `event' is a bitmask with
bits set for the reported events for that descriptor — @code{POLLIN} for
waiting input, @code{POLLOUT} to indicate that the descriptor can be written
to, and so forth. An empty list indicates that the call timed out and no file
descriptors had any events to report. If `timeout' is given, it specifies the
length of time in milliseconds which the system will wait for events before
returning. If `timeout' is omitted, -1, or @ref{675,,None}, the call will
block until there is an event for this poll object.


Alterado na versão 3.5: The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of raising
@ref{db0,,InterruptedError}.

@end deffn

@node Edge and Level Trigger Polling epoll Objects,Polling Objects,/dev/poll Polling Objects,select — Waiting for I/O completion
@anchor{library/select edge-and-level-trigger-polling-epoll-objects}@anchor{36d9}@anchor{library/select epoll-objects}@anchor{36d0}
@subsubsection Edge and Level Trigger Polling (epoll) Objects


@quotation

@indicateurl{https://linux.die.net/man/4/epoll}

`eventmask'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{EPOLLIN}

@tab

Disponível para leitura

@item

@code{EPOLLOUT}

@tab

Disponível para escrita

@item

@code{EPOLLPRI}

@tab

Urgent data for read

@item

@code{EPOLLERR}

@tab

Error condition happened on the assoc. fd

@item

@code{EPOLLHUP}

@tab

Hang up happened on the assoc. fd

@item

@code{EPOLLET}

@tab

Set Edge Trigger behavior, the default is
Level Trigger behavior

@item

@code{EPOLLONESHOT}

@tab

Set one-shot behavior. After one event is
pulled out, the fd is internally disabled

@item

@code{EPOLLEXCLUSIVE}

@tab

Wake only one epoll object when the
associated fd has an event. The default (if
this flag is not set) is to wake all epoll
objects polling on a fd.

@item

@code{EPOLLRDHUP}

@tab

Stream socket peer closed connection or shut
down writing half of connection.

@item

@code{EPOLLRDNORM}

@tab

Equivalent to @code{EPOLLIN}

@item

@code{EPOLLRDBAND}

@tab

Priority data band can be read.

@item

@code{EPOLLWRNORM}

@tab

Equivalente a @code{EPOLLOUT}

@item

@code{EPOLLWRBAND}

@tab

Priority data may be written.

@item

@code{EPOLLMSG}

@tab

Ignorado.

@end multitable



Adicionado na versão 3.6: @code{EPOLLEXCLUSIVE} was added.  It’s only supported by Linux Kernel 4.5
or later.

@end quotation

@geindex close() (método select.epoll)
@anchor{library/select select epoll close}@anchor{fc9}
@deffn {Método} epoll.close ()

Close the control file descriptor of the epoll object.
@end deffn

@geindex closed (atributo select.epoll)
@anchor{library/select select epoll closed}@anchor{36da}
@deffn {Atributo} epoll.closed

@code{True} if the epoll object is closed.
@end deffn

@geindex fileno() (método select.epoll)
@anchor{library/select select epoll fileno}@anchor{36db}
@deffn {Método} epoll.fileno ()

Return the file descriptor number of the control fd.
@end deffn

@geindex fromfd() (método select.epoll)
@anchor{library/select select epoll fromfd}@anchor{36dc}
@deffn {Método} epoll.fromfd (fd)

Create an epoll object from a given file descriptor.
@end deffn

@geindex register() (método select.epoll)
@anchor{library/select select epoll register}@anchor{36dd}
@deffn {Método} epoll.register (fd[, eventmask])

Register a fd descriptor with the epoll object.
@end deffn

@geindex modify() (método select.epoll)
@anchor{library/select select epoll modify}@anchor{36de}
@deffn {Método} epoll.modify (fd, eventmask)

Modify a registered file descriptor.
@end deffn

@geindex unregister() (método select.epoll)
@anchor{library/select select epoll unregister}@anchor{961}
@deffn {Método} epoll.unregister (fd)

Remove a registered file descriptor from the epoll object.


Alterado na versão 3.9: The method no longer ignores the @ref{962,,EBADF} error.

@end deffn

@geindex poll() (método select.epoll)
@anchor{library/select select epoll poll}@anchor{dc5}
@deffn {Método} epoll.poll (timeout=None, maxevents=-1)

Wait for events. timeout in seconds (float)


Alterado na versão 3.5: The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of raising
@ref{db0,,InterruptedError}.

@end deffn

@node Polling Objects,Kqueue Objects,Edge and Level Trigger Polling epoll Objects,select — Waiting for I/O completion
@anchor{library/select poll-objects}@anchor{36d1}@anchor{library/select polling-objects}@anchor{36df}
@subsubsection Polling Objects


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 select.poll)
@anchor{library/select select poll register}@anchor{36e0}
@deffn {Método} poll.register (fd[, eventmask])

Register a file descriptor with the polling object.  Future calls to the
@ref{2d8a,,poll()} method will then check whether the file descriptor has any
pending I/O events.  `fd' can be either an integer, or an object with a
@ref{15d0,,fileno()} method that returns an integer.  File objects
implement @code{fileno()}, so they can also be used as the argument.

`eventmask' is an optional bitmask describing the type of events you want to
check for, and can be a combination of the constants @code{POLLIN},
@code{POLLPRI}, and @code{POLLOUT}, described in the table below.  If not
specified, the default value used will check for all 3 types of events.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{POLLIN}

@tab

There is data to read

@item

@code{POLLPRI}

@tab

There is urgent data to read

@item

@code{POLLOUT}

@tab

Ready for output: writing will not block

@item

@code{POLLERR}

@tab

Error condition of some sort

@item

@code{POLLHUP}

@tab

Hung up

@item

@code{POLLRDHUP}

@tab

Stream socket peer closed connection, or
shut down writing half of connection

@item

@code{POLLNVAL}

@tab

Invalid request: descriptor not open

@end multitable


Registering a file descriptor that’s already registered is not an error, and has
the same effect as registering the descriptor exactly once.
@end deffn

@geindex modify() (método select.poll)
@anchor{library/select select poll modify}@anchor{36e1}
@deffn {Método} poll.modify (fd, eventmask)

Modifies an already registered fd. This has the same effect as
@code{register(fd, eventmask)}.  Attempting to modify a file descriptor
that was never registered causes an @ref{417,,OSError} exception with errno
@code{ENOENT} to be raised.
@end deffn

@geindex unregister() (método select.poll)
@anchor{library/select select poll unregister}@anchor{36e2}
@deffn {Método} poll.unregister (fd)

Remove a file descriptor being tracked by a polling object.  Just like the
@ref{36e0,,register()} method, `fd' can be an integer or an object with a
@ref{15d0,,fileno()} method that returns an integer.

Attempting to remove a file descriptor that was never registered causes a
@ref{344,,KeyError} exception to be raised.
@end deffn

@geindex poll() (método select.poll)
@anchor{library/select select poll poll}@anchor{dc7}
@deffn {Método} poll.poll ([timeout])

Polls the set of registered file descriptors, and returns a possibly empty list
containing @code{(fd, event)} 2-tuples for the descriptors that have events or
errors to report. `fd' is the file descriptor, and `event' is a bitmask with
bits set for the reported events for that descriptor — @code{POLLIN} for
waiting input, @code{POLLOUT} to indicate that the descriptor can be written
to, and so forth. An empty list indicates that the call timed out and no file
descriptors had any events to report. If `timeout' is given, it specifies the
length of time in milliseconds which the system will wait for events before
returning. If `timeout' is omitted, negative, or @ref{675,,None}, the call will
block until there is an event for this poll object.


Alterado na versão 3.5: The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of raising
@ref{db0,,InterruptedError}.

@end deffn

@node Kqueue Objects,Kevent Objects,Polling Objects,select — Waiting for I/O completion
@anchor{library/select id1}@anchor{36e3}@anchor{library/select kqueue-objects}@anchor{36d2}
@subsubsection Kqueue Objects


@geindex close() (método select.kqueue)
@anchor{library/select select kqueue close}@anchor{36e4}
@deffn {Método} kqueue.close ()

Close the control file descriptor of the kqueue object.
@end deffn

@geindex closed (atributo select.kqueue)
@anchor{library/select select kqueue closed}@anchor{36e5}
@deffn {Atributo} kqueue.closed

@code{True} if the kqueue object is closed.
@end deffn

@geindex fileno() (método select.kqueue)
@anchor{library/select select kqueue fileno}@anchor{36e6}
@deffn {Método} kqueue.fileno ()

Return the file descriptor number of the control fd.
@end deffn

@geindex fromfd() (método select.kqueue)
@anchor{library/select select kqueue fromfd}@anchor{36e7}
@deffn {Método} kqueue.fromfd (fd)

Create a kqueue object from a given file descriptor.
@end deffn

@geindex control() (método select.kqueue)
@anchor{library/select select kqueue control}@anchor{dc6}
@deffn {Método} kqueue.control (changelist, max_events[, timeout]) -> eventlist

Low level interface to kevent


@itemize -

@item 
changelist must be an iterable of kevent objects or @code{None}

@item 
max_events must be 0 or a positive integer

@item 
timeout in seconds (floats possible); the default is @code{None},
to wait forever
@end itemize


Alterado na versão 3.5: The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of raising
@ref{db0,,InterruptedError}.

@end deffn

@node Kevent Objects,,Kqueue Objects,select — Waiting for I/O completion
@anchor{library/select id2}@anchor{36e8}@anchor{library/select kevent-objects}@anchor{36d4}
@subsubsection Kevent Objects


@indicateurl{https://man.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2}

@geindex ident (atributo select.kevent)
@anchor{library/select select kevent ident}@anchor{36e9}
@deffn {Atributo} kevent.ident

Value used to identify the event. The interpretation depends on the filter
but it’s usually the file descriptor. In the constructor ident can either
be an int or an object with a @ref{15d0,,fileno()} method. kevent
stores the integer internally.
@end deffn

@geindex filter (atributo select.kevent)
@anchor{library/select select kevent filter}@anchor{36ea}
@deffn {Atributo} kevent.filter

Name of the kernel filter.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_FILTER_READ}

@tab

Takes a descriptor and returns whenever
there is data available to read

@item

@code{KQ_FILTER_WRITE}

@tab

Takes a descriptor and returns whenever
there is data available to write

@item

@code{KQ_FILTER_AIO}

@tab

AIO requests

@item

@code{KQ_FILTER_VNODE}

@tab

Returns when one or more of the requested
events watched in `fflag' occurs

@item

@code{KQ_FILTER_PROC}

@tab

Watch for events on a process id

@item

@code{KQ_FILTER_NETDEV}

@tab

Watch for events on a network device
[not available on macOS]

@item

@code{KQ_FILTER_SIGNAL}

@tab

Returns whenever the watched signal is
delivered to the process

@item

@code{KQ_FILTER_TIMER}

@tab

Establishes an arbitrary timer

@end multitable

@end deffn

@geindex flags (atributo select.kevent)
@anchor{library/select select kevent flags}@anchor{36eb}
@deffn {Atributo} kevent.flags

Filter action.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_EV_ADD}

@tab

Adds or modifies an event

@item

@code{KQ_EV_DELETE}

@tab

Removes an event from the queue

@item

@code{KQ_EV_ENABLE}

@tab

Permitscontrol() to returns the event

@item

@code{KQ_EV_DISABLE}

@tab

Disablesevent

@item

@code{KQ_EV_ONESHOT}

@tab

Removes event after first occurrence

@item

@code{KQ_EV_CLEAR}

@tab

Reset the state after an event is retrieved

@item

@code{KQ_EV_SYSFLAGS}

@tab

internal event

@item

@code{KQ_EV_FLAG1}

@tab

internal event

@item

@code{KQ_EV_EOF}

@tab

Filter specific EOF condition

@item

@code{KQ_EV_ERROR}

@tab

See return values

@end multitable

@end deffn

@geindex fflags (atributo select.kevent)
@anchor{library/select select kevent fflags}@anchor{36ec}
@deffn {Atributo} kevent.fflags

Filter specific flags.

@code{KQ_FILTER_READ} and  @code{KQ_FILTER_WRITE} filter flags:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_LOWAT}

@tab

low water mark of a socket buffer

@end multitable


@code{KQ_FILTER_VNODE} filter flags:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_DELETE}

@tab

`unlink()' was called

@item

@code{KQ_NOTE_WRITE}

@tab

a write occurred

@item

@code{KQ_NOTE_EXTEND}

@tab

the file was extended

@item

@code{KQ_NOTE_ATTRIB}

@tab

an attribute was changed

@item

@code{KQ_NOTE_LINK}

@tab

the link count has changed

@item

@code{KQ_NOTE_RENAME}

@tab

the file was renamed

@item

@code{KQ_NOTE_REVOKE}

@tab

access to the file was revoked

@end multitable


@code{KQ_FILTER_PROC} filter flags:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_EXIT}

@tab

the process has exited

@item

@code{KQ_NOTE_FORK}

@tab

the process has called `fork()'

@item

@code{KQ_NOTE_EXEC}

@tab

the process has executed a new process

@item

@code{KQ_NOTE_PCTRLMASK}

@tab

internal filter flag

@item

@code{KQ_NOTE_PDATAMASK}

@tab

internal filter flag

@item

@code{KQ_NOTE_TRACK}

@tab

follow a process across `fork()'

@item

@code{KQ_NOTE_CHILD}

@tab

returned on the child process for
`NOTE_TRACK'

@item

@code{KQ_NOTE_TRACKERR}

@tab

unable to attach to a child

@end multitable


@code{KQ_FILTER_NETDEV} filter flags (not available on macOS):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{KQ_NOTE_LINKUP}

@tab

link is up

@item

@code{KQ_NOTE_LINKDOWN}

@tab

link is down

@item

@code{KQ_NOTE_LINKINV}

@tab

estado do link é inválido

@end multitable

@end deffn

@geindex data (atributo select.kevent)
@anchor{library/select select kevent data}@anchor{36ed}
@deffn {Atributo} kevent.data

Filter specific data.
@end deffn

@geindex udata (atributo select.kevent)
@anchor{library/select select kevent udata}@anchor{36ee}
@deffn {Atributo} kevent.udata

User defined value.
@end deffn

@node selectors — High-level I/O multiplexing,signal — Define manipuladores para eventos assíncronos,select — Waiting for I/O completion,Comunicação em Rede e Interprocesso
@anchor{library/selectors doc}@anchor{36ef}@anchor{library/selectors module-selectors}@anchor{c2}@anchor{library/selectors selectors-high-level-i-o-multiplexing}@anchor{36f0}@anchor{library/selectors translation-repo}@anchor{36f1}
@subsection @code{selectors} — High-level I/O multiplexing


@geindex module; selectors


Adicionado na versão 3.4.


`Código-fonte:' Lib/selectors.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/selectors.py}


__________________________________________________________________


@menu
* Introdução: Introdução<10>. 
* Classes: Classes<4>. 
* Exemplos: Exemplos<21>. 

@end menu

@node Introdução<10>,Classes<4>,,selectors — High-level I/O multiplexing
@anchor{library/selectors introduction}@anchor{36f2}
@subsubsection Introdução


This module allows high-level and efficient I/O multiplexing, built upon the
@ref{c1,,select} module primitives. Users are encouraged to use this module
instead, unless they want precise control over the OS-level primitives used.

It defines a @ref{36f3,,BaseSelector} abstract base class, along with several
concrete implementations (@ref{35da,,KqueueSelector}, @ref{bf0,,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{15d0,,fileno()} method, or a raw file descriptor. See @ref{1203,,file object}.

@ref{36f4,,DefaultSelector} is an alias to the most efficient implementation
available on the current platform: this should be the default choice for most
users.

@cartouche
@quotation Nota 
The type of file objects supported depends on the platform: on Windows,
sockets are supported, but not pipes, whereas on Unix, both are supported
(some other types may be supported as well, such as fifos or special file
devices).
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item @ref{c1,,select}

Low-level I/O multiplexing module.
@end table


@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@node Classes<4>,Exemplos<21>,Introdução<10>,selectors — High-level I/O multiplexing
@anchor{library/selectors classes}@anchor{36f5}
@subsubsection Classes


Classes hierarchy:

@example
BaseSelector
+-- SelectSelector
+-- PollSelector
+-- EpollSelector
+-- DevpollSelector
+-- KqueueSelector
@end example

In the following, `events' is a bitwise mask indicating which I/O events should
be waited for on a given file object. It can be a combination of the modules
constants below:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@geindex EVENT_READ (no módulo selectors)
@anchor{library/selectors selectors EVENT_READ}@anchor{36f6}
@deffn {Dado} selectors.EVENT_READ
@end deffn

@tab

Disponível para leitura

@item

@geindex EVENT_WRITE (no módulo selectors)
@anchor{library/selectors selectors EVENT_WRITE}@anchor{36f7}
@deffn {Dado} selectors.EVENT_WRITE
@end deffn

@tab

Disponível para escrita

@end multitable

@end quotation

@geindex SelectorKey (classe em selectors)
@anchor{library/selectors selectors SelectorKey}@anchor{36f8}
@deffn {Classe} selectors.SelectorKey

A @ref{36f8,,SelectorKey} is a @ref{1ca,,namedtuple} used to
associate a file object to its underlying file descriptor, selected event
mask and attached data. It is returned by several @ref{36f3,,BaseSelector}
methods.

@geindex fileobj (atributo selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey fileobj}@anchor{36f9}
@deffn {Atributo} fileobj

File object registered.
@end deffn

@geindex fd (atributo selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey fd}@anchor{36fa}
@deffn {Atributo} fd

O descritor de arquivo subjacente.
@end deffn

@geindex events (atributo selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey events}@anchor{36fb}
@deffn {Atributo} events

Events that must be waited for on this file object.
@end deffn

@geindex data (atributo selectors.SelectorKey)
@anchor{library/selectors selectors SelectorKey data}@anchor{36fc}
@deffn {Atributo} data

Optional opaque data associated to this file object: for example, this
could be used to store a per-client session ID.
@end deffn
@end deffn

@geindex BaseSelector (classe em selectors)
@anchor{library/selectors selectors BaseSelector}@anchor{36f3}
@deffn {Classe} selectors.BaseSelector

A @ref{36f3,,BaseSelector} is used to wait for I/O event readiness on multiple
file objects. It supports file stream registration, unregistration, and a
method to wait for I/O events on those streams, with an optional timeout.
It’s an abstract base class, so cannot be instantiated. Use
@ref{36f4,,DefaultSelector} instead, or one of @ref{35d7,,SelectSelector},
@ref{35da,,KqueueSelector} etc. if you want to specifically use an
implementation, and your platform supports it.
@ref{36f3,,BaseSelector} and its concrete implementations support the
@ref{5d4,,context manager} protocol.

@geindex register() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector register}@anchor{36fd}
@deffn {Método} abstractmethod register (fileobj, events, data=None)

Registra um objeto arquivo para seleção, monitorando-o para eventos de I/O

`fileobj' is the file object to monitor.  It may either be an integer
file descriptor or an object with a @code{fileno()} method.
`events' is a bitwise mask of events to monitor.
`data' is an opaque object.

This returns a new @ref{36f8,,SelectorKey} instance, or raises a
@ref{202,,ValueError} in case of invalid event mask or file descriptor, or
@ref{344,,KeyError} if the file object is already registered.
@end deffn

@geindex unregister() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector unregister}@anchor{36fe}
@deffn {Método} abstractmethod unregister (fileobj)

Unregister a file object from selection, removing it from monitoring. A
file object shall be unregistered prior to being closed.

`fileobj' must be a file object previously registered.

This returns the associated @ref{36f8,,SelectorKey} instance, or raises a
@ref{344,,KeyError} if `fileobj' is not registered.  It will raise
@ref{202,,ValueError} if `fileobj' is invalid (e.g. it has no @code{fileno()}
method or its @code{fileno()} method has an invalid return value).
@end deffn

@geindex modify() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector modify}@anchor{bef}
@deffn {Método} modify (fileobj, events, data=None)

Change a registered file object’s monitored events or attached data.

This is equivalent to @code{BaseSelector.unregister(fileobj)} followed
by @code{BaseSelector.register(fileobj, events, data)}, except that it
can be implemented more efficiently.

This returns a new @ref{36f8,,SelectorKey} instance, or raises a
@ref{202,,ValueError} in case of invalid event mask or file descriptor, or
@ref{344,,KeyError} if the file object is not registered.
@end deffn

@geindex select() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector select}@anchor{36ff}
@deffn {Método} abstractmethod select (timeout=None)

Wait until some registered file objects become ready, or the timeout
expires.

If @code{timeout > 0}, this specifies the maximum wait time, in seconds.
If @code{timeout <= 0}, the call won’t block, and will report the currently
ready file objects.
If `timeout' is @code{None}, the call will block until a monitored file object
becomes ready.

This returns a list of @code{(key, events)} tuples, one for each ready file
object.

`key' is the @ref{36f8,,SelectorKey} instance corresponding to a ready file
object.
`events' is a bitmask of events ready on this file object.

@cartouche
@quotation Nota 
This method can return before any file object becomes ready or the
timeout has elapsed if the current process receives a signal: in this
case, an empty list will be returned.
@end quotation
@end cartouche


Alterado na versão 3.5: The selector is now retried with a recomputed timeout when interrupted
by a signal if the signal handler did not raise an exception (see
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} for the rationale), instead of returning an empty list
of events before the timeout.

@end deffn

@geindex close() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector close}@anchor{3700}
@deffn {Método} close ()

Close the selector.

This must be called to make sure that any underlying resource is freed.
The selector shall not be used once it has been closed.
@end deffn

@geindex get_key() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector get_key}@anchor{3701}
@deffn {Método} get_key (fileobj)

Return the key associated with a registered file object.

This returns the @ref{36f8,,SelectorKey} instance associated to this file
object, or raises @ref{344,,KeyError} if the file object is not registered.
@end deffn

@geindex get_map() (método selectors.BaseSelector)
@anchor{library/selectors selectors BaseSelector get_map}@anchor{3702}
@deffn {Método} abstractmethod get_map ()

Return a mapping of file objects to selector keys.

This returns a @ref{8d0,,Mapping} instance mapping
registered file objects to their associated @ref{36f8,,SelectorKey}
instance.
@end deffn
@end deffn

@geindex DefaultSelector (classe em selectors)
@anchor{library/selectors selectors DefaultSelector}@anchor{36f4}
@deffn {Classe} selectors.DefaultSelector

The default selector class, using the most efficient implementation
available on the current platform. This should be the default choice for
most users.
@end deffn

@geindex SelectSelector (classe em selectors)
@anchor{library/selectors selectors SelectSelector}@anchor{35d7}
@deffn {Classe} selectors.SelectSelector

@ref{dc8,,select.select()}-based selector.
@end deffn

@geindex PollSelector (classe em selectors)
@anchor{library/selectors selectors PollSelector}@anchor{bf1}
@deffn {Classe} selectors.PollSelector

@ref{2d8a,,select.poll()}-based selector.
@end deffn

@geindex EpollSelector (classe em selectors)
@anchor{library/selectors selectors EpollSelector}@anchor{bf0}
@deffn {Classe} selectors.EpollSelector

@ref{fc8,,select.epoll()}-based selector.

@geindex fileno() (método selectors.EpollSelector)
@anchor{library/selectors selectors EpollSelector fileno}@anchor{3703}
@deffn {Método} fileno ()

This returns the file descriptor used by the underlying
@ref{fc8,,select.epoll()} object.
@end deffn
@end deffn

@geindex DevpollSelector (classe em selectors)
@anchor{library/selectors selectors DevpollSelector}@anchor{bf2}
@deffn {Classe} selectors.DevpollSelector

@ref{fca,,select.devpoll()}-based selector.

@geindex fileno() (método selectors.DevpollSelector)
@anchor{library/selectors selectors DevpollSelector fileno}@anchor{3704}
@deffn {Método} fileno ()

This returns the file descriptor used by the underlying
@ref{fca,,select.devpoll()} object.
@end deffn


Adicionado na versão 3.5.

@end deffn

@geindex KqueueSelector (classe em selectors)
@anchor{library/selectors selectors KqueueSelector}@anchor{35da}
@deffn {Classe} selectors.KqueueSelector

@ref{17c0,,select.kqueue()}-based selector.

@geindex fileno() (método selectors.KqueueSelector)
@anchor{library/selectors selectors KqueueSelector fileno}@anchor{3705}
@deffn {Método} fileno ()

This returns the file descriptor used by the underlying
@ref{17c0,,select.kqueue()} object.
@end deffn
@end deffn

@node Exemplos<21>,,Classes<4>,selectors — High-level I/O multiplexing
@anchor{library/selectors examples}@anchor{3706}
@subsubsection Exemplos


Here is a simple echo server implementation:

@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 — Define manipuladores para eventos assíncronos,mmap — Suporte a arquivos mapeados na memória,selectors — High-level I/O multiplexing,Comunicação em Rede e Interprocesso
@anchor{library/signal doc}@anchor{3707}@anchor{library/signal module-signal}@anchor{c6}@anchor{library/signal signal-set-handlers-for-asynchronous-events}@anchor{3708}@anchor{library/signal translation-repo}@anchor{3709}
@subsection @code{signal} — Define manipuladores para eventos assíncronos


@geindex module; signal

`Código-fonte:' Lib/signal.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/signal.py}


__________________________________________________________________


Este módulo fornece mecanismos para usar manipuladores de sinal em Python.

@menu
* Regras gerais:: 
* Conteúdo do módulo: Conteúdo do módulo<5>. 
* Exemplos: Exemplos<22>. 
* Nota sobre SIGPIPE:: 
* Nota sobre manipuladores de sinais e exceções:: 

@end menu

@node Regras gerais,Conteúdo do módulo<5>,,signal — Define manipuladores para eventos assíncronos
@anchor{library/signal general-rules}@anchor{370a}
@subsubsection Regras gerais


A função @ref{1173,,signal.signal()} permite definir manipuladores personalizados a serem executados quando um sinal é recebido. Um pequeno número de manipuladores padrão são instalados: @ref{370b,,SIGPIPE} é ignorado (então erros de gravação em encadeamentos e sockets podem ser relatados como exceções comuns do Python) e @ref{847,,SIGINT} é traduzido em uma exceção @ref{9d9,,KeyboardInterrupt} se o processo pai não a tiver alterado.

Um manipulador para um sinal específico, uma vez definido, permanece instalado até ser explicitamente redefinido (o Python emula a interface de estilo BSD independentemente da implementação subjacente), com exceção do manipulador para @ref{2dc5,,SIGCHLD}, que segue a implementação subjacente.

Em plataformas WebAssembly, os sinais são emulados e, portanto, se comportam de forma diferente. Várias funções e sinais não estão disponíveis nessas plataformas.

@menu
* Execução de manipuladores de sinais Python:: 
* Sinais e threads:: 

@end menu

@node Execução de manipuladores de sinais Python,Sinais e threads,,Regras gerais
@anchor{library/signal execution-of-python-signal-handlers}@anchor{370c}
@subsubsection Execução de manipuladores de sinais Python


Um manipulador de sinal Python não é executado dentro do manipulador de sinal de baixo nível (C). Em vez disso, o manipulador de sinal de baixo nível define um sinalizador que diz à @ref{370d,,máquina virtual} para executar o manipulador de sinal Python correspondente em um ponto posterior (por exemplo, na próxima instrução @ref{187,,bytecode}). Isso tem consequências:


@itemize *

@item 
Faz pouco sentido capturar erros síncronos como @ref{10ba,,SIGFPE} ou @ref{10b9,,SIGSEGV} que são causados por uma operação inválida no código C. O Python retornará do manipulador de sinais para o código C, o que provavelmente levantará o mesmo sinal novamente, fazendo com que o Python aparentemente trave. Do Python 3.3 em diante, você pode usar o módulo @ref{58,,faulthandler} para relatar erros síncronos.

@item 
Um cálculo de longa duração implementado puramente em C (como correspondência de expressão regular em um grande corpo de texto) pode ser executado ininterruptamente por um período de tempo arbitrário, independentemente de quaisquer sinais recebidos. Os manipuladores de sinal do Python serão chamados quando o cálculo terminar.

@item 
Se o manipulador levantar uma exceção, ela será levantada “do nada” na thread principal. Veja a @ref{2422,,nota abaixo} para uma discussão.
@end itemize

@node Sinais e threads,,Execução de manipuladores de sinais Python,Regras gerais
@anchor{library/signal id1}@anchor{370e}@anchor{library/signal signals-and-threads}@anchor{370f}
@subsubsection Sinais e threads


Os manipuladores de sinais Python são sempre executados na thread principal do Python do interpretador principal, mesmo se o sinal foi recebido em outra thread. Isso significa que os sinais não podem ser usados como um meio de comunicação entre threads. Você pode usar as primitivas de sincronização do módulo @ref{ed,,threading} em vez disso.

Além disso, somente a thread principal do interpretador principal tem permissão para definir um novo manipulador de sinal.

@node Conteúdo do módulo<5>,Exemplos<22>,Regras gerais,signal — Define manipuladores para eventos assíncronos
@anchor{library/signal module-contents}@anchor{3710}
@subsubsection Conteúdo do módulo



Alterado na versão 3.5: As constantes relacionadas a sinal (SIG*), manipulador (@ref{193c,,SIG_DFL}, @ref{193b,,SIG_IGN}) e sigmask (@ref{3711,,SIG_BLOCK}, @ref{3712,,SIG_UNBLOCK}, @ref{3713,,SIG_SETMASK}) listadas abaixo foram transformadas em @ref{d00,,enums} (@ref{3714,,Signals}, @ref{3715,,Handlers} e @ref{3716,,Sigmasks} respectivamente). As funções @ref{17a0,,getsignal()}, @ref{116f,,pthread_sigmask()}, @ref{1171,,sigpending()} e @ref{1172,,sigwait()} retornam @ref{d00,,enums} legíveis por humanos como objetos @ref{3714,,Signals}.


O módulo de sinal define três enumerações:

@geindex Signals (classe em signal)
@anchor{library/signal signal Signals}@anchor{3714}
@deffn {Classe} signal.Signals

Coleção de @ref{d00,,enum.IntEnum} de constantes SIG* e constantes CTRL_*.


Adicionado na versão 3.5.

@end deffn

@geindex Handlers (classe em signal)
@anchor{library/signal signal Handlers}@anchor{3715}
@deffn {Classe} signal.Handlers

Coleção de @ref{d00,,enum.IntEnum} das constantes @ref{193c,,SIG_DFL} e @ref{193b,,SIG_IGN}.


Adicionado na versão 3.5.

@end deffn

@geindex Sigmasks (classe em signal)
@anchor{library/signal signal Sigmasks}@anchor{3716}
@deffn {Classe} signal.Sigmasks

Coleção de @ref{d00,,enum.IntEnum} das constantes @ref{3711,,SIG_BLOCK}, @ref{3712,,SIG_UNBLOCK} e @ref{3713,,SIG_SETMASK}.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} e @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} para mais informações.


Adicionado na versão 3.5.

@end deffn

As variáveis definidas no módulo @ref{c6,,signal} são:

@geindex SIG_DFL (no módulo signal)
@anchor{library/signal signal SIG_DFL}@anchor{193c}
@deffn {Dado} signal.SIG_DFL

Esta é uma das duas opções de manipulação de sinal padrão; ela simplesmente executará a função padrão para o sinal. Por exemplo, na maioria dos sistemas, a ação padrão para @ref{3717,,SIGQUIT} é despejar o núcleo e sair, enquanto a ação padrão para @ref{2dc5,,SIGCHLD} é simplesmente ignorá-lo.
@end deffn

@geindex SIG_IGN (no módulo signal)
@anchor{library/signal signal SIG_IGN}@anchor{193b}
@deffn {Dado} signal.SIG_IGN

Este é outro manipulador de sinal padrão, que simplesmente ignorará o sinal fornecido.
@end deffn

@geindex SIGABRT (no módulo signal)
@anchor{library/signal signal SIGABRT}@anchor{10bb}
@deffn {Dado} signal.SIGABRT

Sinal de abortar de @code{abort(3)@footnote{https://manpages.debian.org/abort(3)}}.
@end deffn

@geindex SIGALRM (no módulo signal)
@anchor{library/signal signal SIGALRM}@anchor{3718}
@deffn {Dado} signal.SIGALRM

Sinal do temporizador de @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGBREAK (no módulo signal)
@anchor{library/signal signal SIGBREAK}@anchor{3719}
@deffn {Dado} signal.SIGBREAK

Interrupção do teclado (CTRL + BREAK).

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex SIGBUS (no módulo signal)
@anchor{library/signal signal SIGBUS}@anchor{10bc}
@deffn {Dado} signal.SIGBUS

Erro de barramento (acesso incorreto à memória).

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGCHLD (no módulo signal)
@anchor{library/signal signal SIGCHLD}@anchor{2dc5}
@deffn {Dado} signal.SIGCHLD

Processo filho interrompido ou encerrado.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGCLD (no módulo signal)
@anchor{library/signal signal SIGCLD}@anchor{371a}
@deffn {Dado} signal.SIGCLD

Apelido para @ref{2dc5,,SIGCHLD}.

@ref{1ed8,,Disponibilidade}: not macOS.
@end deffn

@geindex SIGCONT (no módulo signal)
@anchor{library/signal signal SIGCONT}@anchor{2dd3}
@deffn {Dado} signal.SIGCONT

Continua o processo se ele estiver parado no momento

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGFPE (no módulo signal)
@anchor{library/signal signal SIGFPE}@anchor{10ba}
@deffn {Dado} signal.SIGFPE

Exceção de ponto flutuante. Por exemplo, divisão por zero.


@subsubheading Ver também


@ref{94c,,ZeroDivisionError} é levatanda quando o segundo argumento de uma operação de divisão ou módulo é zero.

@end deffn

@geindex SIGHUP (no módulo signal)
@anchor{library/signal signal SIGHUP}@anchor{371b}
@deffn {Dado} signal.SIGHUP

Travamento detectado no terminal de controle ou morte do processo de controle.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGILL (no módulo signal)
@anchor{library/signal signal SIGILL}@anchor{10bd}
@deffn {Dado} signal.SIGILL

Instrução ilegal.
@end deffn

@geindex SIGINT (no módulo signal)
@anchor{library/signal signal SIGINT}@anchor{847}
@deffn {Dado} signal.SIGINT

Interrupção do teclado (CTRL + C).

A ação padrão é levantar @ref{9d9,,KeyboardInterrupt}.
@end deffn

@geindex SIGKILL (no módulo signal)
@anchor{library/signal signal SIGKILL}@anchor{b6e}
@deffn {Dado} signal.SIGKILL

Sinal para encerrar forçadamente.

Ele não pode ser capturado, bloqueado ou ignorado.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGPIPE (no módulo signal)
@anchor{library/signal signal SIGPIPE}@anchor{370b}
@deffn {Dado} signal.SIGPIPE

Encadeamento quebrado: escreve no encadeamento sem leitores.

A ação padrão é ignorar o sinal.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGPROF (no módulo signal)
@anchor{library/signal signal SIGPROF}@anchor{371c}
@deffn {Dado} signal.SIGPROF

Temporizador de perfilamento expirado.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGQUIT (no módulo signal)
@anchor{library/signal signal SIGQUIT}@anchor{3717}
@deffn {Dado} signal.SIGQUIT

Sinal de saída do terminal.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGSEGV (no módulo signal)
@anchor{library/signal signal SIGSEGV}@anchor{10b9}
@deffn {Dado} signal.SIGSEGV

Falha de segmentação: referência de memória inválida.
@end deffn

@geindex SIGSTOP (no módulo signal)
@anchor{library/signal signal SIGSTOP}@anchor{371d}
@deffn {Dado} signal.SIGSTOP

Para a execução (não pode ser capturado ou ignorado).
@end deffn

@geindex SIGSTKFLT (no módulo signal)
@anchor{library/signal signal SIGSTKFLT}@anchor{1990}
@deffn {Dado} signal.SIGSTKFLT

Falha de pilha no coprocessador. O kernel Linux não levanta esse sinal: ele só pode ser emitido no espaço do usuário.

@ref{1ed8,,Disponibilidade}: Linux.

Em arquiteturas onde o sinal está disponível. Veja a página man @code{signal(7)@footnote{https://manpages.debian.org/signal(7)}} para mais informações.


Adicionado na versão 3.11.

@end deffn

@geindex SIGTERM (no módulo signal)
@anchor{library/signal signal SIGTERM}@anchor{1426}
@deffn {Dado} signal.SIGTERM

Sinal de encerramento.
@end deffn

@geindex SIGUSR1 (no módulo signal)
@anchor{library/signal signal SIGUSR1}@anchor{371e}
@deffn {Dado} signal.SIGUSR1

Sinal definido pelo usuário 1.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGUSR2 (no módulo signal)
@anchor{library/signal signal SIGUSR2}@anchor{371f}
@deffn {Dado} signal.SIGUSR2

Sinal definido pelo usuário 2.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGVTALRM (no módulo signal)
@anchor{library/signal signal SIGVTALRM}@anchor{3720}
@deffn {Dado} signal.SIGVTALRM

Temporizador virtual expirou.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGWINCH (no módulo signal)
@anchor{library/signal signal SIGWINCH}@anchor{3721}
@deffn {Dado} signal.SIGWINCH

Sinal de redimensionamento do Windows.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex SIGXCPU (no módulo signal)
@anchor{library/signal signal SIGXCPU}@anchor{3722}
@deffn {Dado} signal.SIGXCPU

Limite de tempo da CPU excedido.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn


@deffn {Dado} SIG*

Todos os números de sinal são definidos simbolicamente. Por exemplo, o sinal de desligamento é definido como @ref{371b,,signal.SIGHUP}; os nomes das variáveis são idênticos aos usados em programas C, como encontrados em @code{<signal.h>}. A página man do Unix para ‘@code{signal}’ lista os sinais existentes (em alguns sistemas, é @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}}, em outros, a lista está em @code{signal(7)@footnote{https://manpages.debian.org/signal(7)}}). Observe que nem todos os sistemas definem o mesmo conjunto de nomes de sinais; apenas os nomes definidos pelo sistema são definidos por este módulo.
@end deffn

@geindex CTRL_C_EVENT (no módulo signal)
@anchor{library/signal signal CTRL_C_EVENT}@anchor{13af}
@deffn {Dado} signal.CTRL_C_EVENT

O sinal correspondente ao evento de pressionamento de tecla @code{Ctrl}+@code{C}. Este sinal só pode ser usado com @ref{13ae,,os.kill()}.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.2.

@end deffn

@geindex CTRL_BREAK_EVENT (no módulo signal)
@anchor{library/signal signal CTRL_BREAK_EVENT}@anchor{13b0}
@deffn {Dado} signal.CTRL_BREAK_EVENT

O sinal correspondente ao evento de pressionamento de tecla @code{Ctrl}+@code{Break}. Este sinal só pode ser usado com @ref{13ae,,os.kill()}.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.2.

@end deffn

@geindex NSIG (no módulo signal)
@anchor{library/signal signal NSIG}@anchor{1916}
@deffn {Dado} signal.NSIG

Um a mais que o número do sinal mais alto. Use @ref{3723,,valid_signals()} para obter números de sinais válidos.
@end deffn

@geindex ITIMER_REAL (no módulo signal)
@anchor{library/signal signal ITIMER_REAL}@anchor{3724}
@deffn {Dado} signal.ITIMER_REAL

Diminui o intervalo do temporizador em tempo real e entrega @ref{3718,,SIGALRM} ao expirar.
@end deffn

@geindex ITIMER_VIRTUAL (no módulo signal)
@anchor{library/signal signal ITIMER_VIRTUAL}@anchor{3725}
@deffn {Dado} signal.ITIMER_VIRTUAL

Diminui o intervalo do temporizador somente quando o processo está em execução e entrega SIGVTALRM após a expiração.
@end deffn

@geindex ITIMER_PROF (no módulo signal)
@anchor{library/signal signal ITIMER_PROF}@anchor{3726}
@deffn {Dado} signal.ITIMER_PROF

Diminui o temporizador de intervalo tanto quando o processo é executado quanto quando o sistema está executando em nome do processo. Juntamente com o ITIMER_VIRTUAL, este temporizador é geralmente usado para criar um perfil do tempo gasto pelo aplicativo nos espaços do usuário e do kernel. O SIGPROF é fornecido após a expiração.
@end deffn

@geindex SIG_BLOCK (no módulo signal)
@anchor{library/signal signal SIG_BLOCK}@anchor{3711}
@deffn {Dado} signal.SIG_BLOCK

Um possível valor para o parâmetro `how' para @ref{116f,,pthread_sigmask()} indicando que os sinais devem ser bloqueados.


Adicionado na versão 3.3.

@end deffn

@geindex SIG_UNBLOCK (no módulo signal)
@anchor{library/signal signal SIG_UNBLOCK}@anchor{3712}
@deffn {Dado} signal.SIG_UNBLOCK

Um possível valor para o parâmetro `how' para @ref{116f,,pthread_sigmask()} indicando que os sinais devem ser desbloqueados.


Adicionado na versão 3.3.

@end deffn

@geindex SIG_SETMASK (no módulo signal)
@anchor{library/signal signal SIG_SETMASK}@anchor{3713}
@deffn {Dado} signal.SIG_SETMASK

Um possível valor para o parâmetro `how' para @ref{116f,,pthread_sigmask()} indicando que a máscara de sinal deve ser substituída.


Adicionado na versão 3.3.

@end deffn

O módulo @ref{c6,,signal} define uma exceção:

@geindex ItimerError
@anchor{library/signal signal ItimerError}@anchor{3727}
@deffn {Exceção} signal.ItimerError

Levantada para sinalizar um erro da implementação subjacente de @ref{3728,,setitimer()} ou @ref{3729,,getitimer()}. Espere este erro se um temporizador de intervalo inválido ou um tempo negativo for passado para @ref{3728,,setitimer()}. Este erro é um subtipo de @ref{417,,OSError}.


Adicionado na versão 3.3: Este erro costumava ser um subtipo de @ref{108b,,IOError}, que agora é um apelido de @ref{417,,OSError}.

@end deffn

O módulo @ref{c6,,signal} define as seguintes funções:

@geindex alarm() (no módulo signal)
@anchor{library/signal signal alarm}@anchor{372a}
@deffn {Função} signal.alarm (time)

Se `time' for diferente de zero, esta função solicita que um sinal @ref{3718,,SIGALRM} seja enviado ao processo em `time' segundos. Qualquer alarme previamente agendado será cancelado (apenas um alarme pode ser agendado por vez). O valor retornado será o número de segundos antes de qualquer alarme previamente configurado ter sido emitido. Se `time' for zero, nenhum alarme será agendado e qualquer alarme agendado será cancelado. Se o valor retornado for zero, nenhum alarme será agendado no momento.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}} para mais informações.
@end deffn

@geindex getsignal() (no módulo signal)
@anchor{library/signal signal getsignal}@anchor{17a0}
@deffn {Função} signal.getsignal (signalnum)

Retorna o manipulador de sinal atual para o sinal `signalnum'. O valor retornado pode ser um objeto Python invocável ou um dos valores especiais @ref{193b,,signal.SIG_IGN}, @ref{193c,,signal.SIG_DFL} ou @ref{675,,None}. Aqui, @ref{193b,,signal.SIG_IGN} significa que o sinal foi ignorado anteriormente, @ref{193c,,signal.SIG_DFL} significa que a maneira padrão de manipular o sinal estava em uso anteriormente e @code{None} significa que o manipulador de sinal anterior não foi instalado a partir do Python.
@end deffn

@geindex strsignal() (no módulo signal)
@anchor{library/signal signal strsignal}@anchor{1bb6}
@deffn {Função} signal.strsignal (signalnum)

Retorna a descrição do sinal `signalnum', como “Interrupt” para @ref{847,,SIGINT}. Retorna @ref{675,,None} se `signalnum' não tiver descrição. Levanta @ref{202,,ValueError} se `signalnum' for inválido.


Adicionado na versão 3.8.

@end deffn

@geindex valid_signals() (no módulo signal)
@anchor{library/signal signal valid_signals}@anchor{3723}
@deffn {Função} signal.valid_signals ()

Retorna o conjunto de números de sinais válidos nesta plataforma. Pode ser menor que @code{range(1, NSIG)} se alguns sinais forem reservados pelo sistema para uso interno.


Adicionado na versão 3.8.

@end deffn

@geindex pause() (no módulo signal)
@anchor{library/signal signal pause}@anchor{372b}
@deffn {Função} signal.pause ()

Faz o processo hibernar até que um sinal seja recebido; o manipulador apropriado será então chamado. Não retorna nada.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}} para mais informações.

veja também @ref{1172,,sigwait()}, @ref{dd3,,sigwaitinfo()}, @ref{dd2,,sigtimedwait()} e @ref{1171,,sigpending()}.
@end deffn

@geindex raise_signal() (no módulo signal)
@anchor{library/signal signal raise_signal}@anchor{191a}
@deffn {Função} signal.raise_signal (signum)

Envia um sinal para o processo de chamada. Não retorna nada.


Adicionado na versão 3.8.

@end deffn

@geindex pidfd_send_signal() (no módulo signal)
@anchor{library/signal signal pidfd_send_signal}@anchor{932}
@deffn {Função} signal.pidfd_send_signal (pidfd, sig, siginfo=None, flags=0)

Envia o sinal `sig' para o processo referenciado pelo descritor de arquivo `pidfd'. Atualmente, o Python não suporta o parâmetro `siginfo'; ele deve ser @code{None}. O argumento `flags' é fornecido para futuras extensões; nenhum valor de sinalizador está definido no momento.

Veja a página man @code{pidfd_send_signal(2)@footnote{https://manpages.debian.org/pidfd_send_signal(2)}} para mais informações.

@ref{1ed8,,Disponibilidade}: Linux >= 5.1, Android >= @ref{ba2,,build-time} API level 31


Adicionado na versão 3.9.

@end deffn

@geindex pthread_kill() (no módulo signal)
@anchor{library/signal signal pthread_kill}@anchor{1170}
@deffn {Função} signal.pthread_kill (thread_id, signalnum)

Envia o sinal `signalnum' para a thread `thread_id', outra thread no mesmo processo que a chamadora. A thread alvo pode estar executando qualquer código (Python ou não). No entanto, se a thread alvo estiver executando o interpretador Python, os manipuladores de sinal Python serão @ref{370f,,executados pela thread principal do interpretador principal}. Portanto, o único objetivo de enviar um sinal para uma thread Python específica seria forçar uma chamada de sistema em execução a falhar com @ref{db0,,InterruptedError}.

Utilize a @ref{1199,,threading.get_ident()} ou o atributo @ref{2e16,,ident} dos objetos @ref{953,,threading.Thread} para obter um valor adequado para `thread_id'.

Se `signalnum' for 0, nenhum sinal será enviado, mas a verificação de erros ainda será realizada; isso pode ser usado para verificar se a thread de destino ainda está em execução.

Levanta um @ref{19fa,,evento de auditoria} @code{signal.pthread_kill} com os argumentos @code{thread_id}, @code{signalnum}.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{pthread_kill(3)@footnote{https://manpages.debian.org/pthread_kill(3)}} para mais informações.

Veja também @ref{13ae,,os.kill()}.


Adicionado na versão 3.3.

@end deffn

@geindex pthread_sigmask() (no módulo signal)
@anchor{library/signal signal pthread_sigmask}@anchor{116f}
@deffn {Função} signal.pthread_sigmask (how, mask)

Busca e/ou altera a máscara de sinal da thread chamadora. A máscara de sinal é o conjunto de sinais cuja entrega está atualmente bloqueada para o chamador. Retorna a máscara de sinal antiga como um conjunto de sinais.

O comportamento da chamada depende do valor de `how', como segue.


@itemize *

@item 
@ref{3711,,SIG_BLOCK}: O conjunto de sinais bloqueados é a união do conjunto atual e do argumento `mask'.

@item 
@ref{3712,,SIG_UNBLOCK}: Os sinais em `mask' são removidos do conjunto atual de sinais bloqueados. É permitido tentar desbloquear um sinal que não esteja bloqueado.

@item 
@ref{3713,,SIG_SETMASK}: O conjunto de sinais bloqueados é definido como o argumento `mask'.
@end itemize

`mask' é um conjunto de números de sinais (ex.: @{@ref{847,,signal.SIGINT}, @ref{1426,,signal.SIGTERM}@}). Use @ref{3723,,valid_signals()} para uma máscara completa, incluindo todos os sinais.

Por exemplo, @code{signal.pthread_sigmask(signal.SIG_BLOCK, [])} lê a máscara de sinal da thread de chamada.

@ref{b6e,,SIGKILL} e @ref{371d,,SIGSTOP} não podem ser bloqueados.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} e @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} para mais informações.

Veja também @ref{372b,,pause()}, @ref{1171,,sigpending()} e @ref{1172,,sigwait()}.


Adicionado na versão 3.3.

@end deffn

@geindex setitimer() (no módulo signal)
@anchor{library/signal signal setitimer}@anchor{3728}
@deffn {Função} signal.setitimer (which, seconds, interval=0.0)

Define o temporizador de intervalo fornecido (um dos seguintes: @ref{3724,,signal.ITIMER_REAL}, @ref{3725,,signal.ITIMER_VIRTUAL} ou @ref{3726,,signal.ITIMER_PROF}) especificado por `which' para disparar após `seconds' (float é aceito, diferente de @ref{372a,,alarm()}) e, depois disso, a cada `interval' segundos (se `interval' for diferente de zero). O temporizador de intervalo especificado por `which' pode ser zerado definindo `seconds' como zero.

Quando um temporizador de intervalo dispara, um sinal é enviado ao processo. O sinal enviado depende do temporizador utilizado; @ref{3724,,signal.ITIMER_REAL} enviará @ref{3718,,SIGALRM}, @ref{3725,,signal.ITIMER_VIRTUAL} enviará @ref{3720,,SIGVTALRM} e @ref{3726,,signal.ITIMER_PROF} enviará @ref{371c,,SIGPROF}.

Os valores antigos são retornados como uma tupla: (atraso, intervalo).

Tentar passar um intervalo de tempo inválido causará uma @ref{3727,,ItimerError}.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex getitimer() (no módulo signal)
@anchor{library/signal signal getitimer}@anchor{3729}
@deffn {Função} signal.getitimer (which)

Retorna o valor atual de um intervalo de tempo especificado por `which'.

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex set_wakeup_fd() (no módulo signal)
@anchor{library/signal signal set_wakeup_fd}@anchor{b86}
@deffn {Função} signal.set_wakeup_fd (fd, *, warn_on_full_buffer=True)

Define o descritor de arquivo de ativação como `fd'. Quando um sinal para o qual seu programa registrou um manipulador de sinais é recebido, o número do sinal é escrito como um único byte no fd. Se você não registrou um manipulador de sinais para os sinais de seu interesse, nada será escrito no fd de ativação. Isso pode ser usado por uma biblioteca para ativar uma chamada de poll ou seleção, permitindo que o sinal seja totalmente processado.

O antigo fd de ativação é retornado (ou -1 se a ativação do descritor de arquivo não estava habilitada). Se `fd' for -1, a ativação do descritor de arquivo está desabilitada. Se não for -1, `fd' deve ser não bloqueante. Cabe à biblioteca remover quaisquer bytes de `fd' antes de chamar poll ou select novamente.

Quando threads estão habilitadas, esta função só pode ser chamada da @ref{370f,,thread principal do interpretador principal}; tentar chamá-la de outras threads levantará uma exceção @ref{202,,ValueError}.

Há duas maneiras comuns de usar esta função. Em ambas as abordagens, você usa o fd para despertar quando um sinal chega, mas elas diferem na forma como determinam `which' sinal ou sinais chegaram.

Na primeira abordagem, lemos os dados do buffer do fd, e os valores dos bytes fornecem os números dos sinais. Isso é simples, mas em casos raros pode apresentar um problema: geralmente, o fd terá um espaço de buffer limitado e, se muitos sinais chegarem muito rápido, o buffer pode ficar cheio e alguns sinais podem ser perdidos. Se você usar essa abordagem, defina @code{warn_on_full_buffer=True}, o que pelo menos fará com que um aviso seja impresso no stderr quando os sinais forem perdidos.

Na segunda abordagem, usamos o fd de ativação `apenas' para ativações e ignoramos os valores de bytes reais. Nesse caso, tudo o que importa é se o buffer do fd está vazio ou não; um buffer cheio não indica nenhum problema. Se você usar essa abordagem, defina @code{warn_on_full_buffer=False} para que seus usuários não sejam confundidos por mensagens de aviso falsas.


Alterado na versão 3.5: No Windows, a função agora também suporta manipuladores de socket.



Alterado na versão 3.7: Adiciona o parâmetro @code{warn_on_full_buffer}.

@end deffn

@geindex siginterrupt() (no módulo signal)
@anchor{library/signal signal siginterrupt}@anchor{1174}
@deffn {Função} signal.siginterrupt (signalnum, flag)

Altera o comportamento de reinicialização de chamadas de sistema: se `flag' for @ref{b49,,False}, as chamadas de sistema serão reiniciadas quando interrompidas pelo sinal `signalnum'; caso contrário, as chamadas de sistema serão interrompidas. Não retorna nada.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{siginterrupt(3)@footnote{https://manpages.debian.org/siginterrupt(3)}} para mais informações.

Observe que a instalação de um manipulador de sinal com @ref{c6,,signal()} redefinirá o comportamento de reinicialização para interrompível ao chamar implicitamente @code{siginterrupt()} com `flag' contendo valor verdadeiro para o sinal fornecido.
@end deffn

@geindex signal() (no módulo signal)
@anchor{library/signal signal signal}@anchor{1173}
@deffn {Função} signal.signal (signalnum, handler)

Define o manipulador do sinal `signalnum' para a função `handler'. `handler' pode ser um objeto Python invocável que recebe dois argumentos (veja abaixo), ou um dos valores especiais @ref{193b,,signal.SIG_IGN} ou @ref{193c,,signal.SIG_DFL}. O manipulador de sinal anterior será retornado (veja a descrição de @ref{17a0,,getsignal()} acima). (Consulte a página man do Unix @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}} para mais informações.)

Quando threads estão habilitadas, esta função só pode ser chamada da @ref{370f,,thread principal do interpretador principal}; tentar chamá-la de outras threads levantará uma exceção @ref{202,,ValueError}.

O `handler' é chamado com dois argumentos: o número do sinal e o quadro de pilha atual (@code{None} ou um objeto quadro; para uma descrição dos objetos quadro, consulte a @ref{6e0,,descrição na hierarquia de tipo} ou consulte as descrições de atributo no módulo @ref{7e,,inspect}).

No Windows, @ref{c6,,signal()} só pode ser chamado com @ref{10bb,,SIGABRT}, @ref{10ba,,SIGFPE}, @ref{10bd,,SIGILL}, @ref{847,,SIGINT}, @ref{10b9,,SIGSEGV}, @ref{1426,,SIGTERM} ou @ref{3719,,SIGBREAK}. Uma exceção @ref{202,,ValueError} será levantada em qualquer outro caso. Observe que nem todos os sistemas definem o mesmo conjunto de nomes de sinais; uma exceção @ref{34b,,AttributeError} será levantada se um nome de sinal não for definido como constante de nível de módulo @code{SIG*}.
@end deffn

@geindex sigpending() (no módulo signal)
@anchor{library/signal signal sigpending}@anchor{1171}
@deffn {Função} signal.sigpending ()

Examine o conjunto de sinais pendentes para entrega ao thread de chamada (ou seja, os sinais que foram gerados enquanto bloqueados). Retorne o conjunto de sinais pendentes.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigpending(2)@footnote{https://manpages.debian.org/sigpending(2)}} para mais informações.

Veja também @ref{372b,,pause()}, @ref{116f,,pthread_sigmask()} e @ref{1172,,sigwait()}.


Adicionado na versão 3.3.

@end deffn

@geindex sigwait() (no módulo signal)
@anchor{library/signal signal sigwait}@anchor{1172}
@deffn {Função} signal.sigwait (sigset)

Suspende a execução do thread de chamada até a entrega de um dos sinais especificados no conjunto de sinais `sigset'. A função aceita o sinal (remove-o da lista de sinais pendentes) e retorna o número do sinal.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigwait(3)@footnote{https://manpages.debian.org/sigwait(3)}} para mais informações.

Veja também @ref{372b,,pause()}, @ref{116f,,pthread_sigmask()}, @ref{1171,,sigpending()}, @ref{dd3,,sigwaitinfo()} e @ref{dd2,,sigtimedwait()}.


Adicionado na versão 3.3.

@end deffn

@geindex sigwaitinfo() (no módulo signal)
@anchor{library/signal signal sigwaitinfo}@anchor{dd3}
@deffn {Função} signal.sigwaitinfo (sigset)

Suspende a execução da thread chamadora até a entrega de um dos sinais especificados no conjunto de sinais `sigset'. A função aceita o sinal e o remove da lista de sinais pendentes. Se um dos sinais em `sigset' já estiver pendente para a thread chamadora, a função retornará imediatamente com informações sobre esse sinal. O manipulador de sinais não é chamado para o sinal entregue. A função levanta @ref{db0,,InterruptedError} se for interrompida por um sinal que não esteja em `sigset'.

O valor de retorno é um objeto que representa os dados contidos na estrutura de @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{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigwaitinfo(2)@footnote{https://manpages.debian.org/sigwaitinfo(2)}} para mais informações.

Veja também @ref{372b,,pause()}, @ref{1172,,sigwait()} e @ref{dd2,,sigtimedwait()}.


Adicionado na versão 3.3.



Alterado na versão 3.5: A função agora é tentada novamente se interrompida por um sinal que não esteja em `sigset' e o manipulador de sinal não levanta uma exceção (veja 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para a justificativa).

@end deffn

@geindex sigtimedwait() (no módulo signal)
@anchor{library/signal signal sigtimedwait}@anchor{dd2}
@deffn {Função} signal.sigtimedwait (sigset, timeout)

Semelhante a @ref{dd3,,sigwaitinfo()}, mas recebe um argumento `timeout' adicional que especifica um tempo limite. Se `timeout' for especificado como @code{0}, uma consulta será realizada. Retorna @ref{675,,None} se ocorrer um tempo limite.

@ref{1ed8,,Disponibilidade}: Unix.

Veja a página man @code{sigtimedwait(2)@footnote{https://manpages.debian.org/sigtimedwait(2)}} para mais informações.

Veja também @ref{372b,,pause()}, @ref{1172,,sigwait()} e @ref{dd3,,sigwaitinfo()}.


Adicionado na versão 3.3.



Alterado na versão 3.5: A função agora é tentada novamente com o `timeout' recalculado se interrompida por um sinal que não esteja em `sigset' e o manipulador de sinal não levanta uma exceção (veja 
@geindex Propostas de Melhorias do Python; PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} para a justificativa).

@end deffn

@node Exemplos<22>,Nota sobre SIGPIPE,Conteúdo do módulo<5>,signal — Define manipuladores para eventos assíncronos
@anchor{library/signal examples}@anchor{372c}@anchor{library/signal signal-example}@anchor{372d}
@subsubsection Exemplos


Aqui está um programa de exemplo mínimo. Ele usa a função @ref{372a,,alarm()} para limitar o tempo gasto esperando para abrir um arquivo; isso é útil se o arquivo for para um dispositivo serial que pode não estar ligado, o que normalmente faria com que o @ref{dba,,os.open()} travasse indefinidamente. A solução é definir um alarme de 5 segundos antes de abrir o arquivo; se a operação demorar muito, o sinal de alarme será enviado e o manipulador levantará uma exceção.

@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!")

# Define o manipulador de sinal e um alarme de 5 segundos
signal.signal(signal.SIGALRM, handler)
signal.alarm(5)

# Este open() pode travar indefinidamente
fd = os.open('/dev/ttyS0', os.O_RDWR)

signal.alarm(0)          # Desabilita o alarme
@end example

@node Nota sobre SIGPIPE,Nota sobre manipuladores de sinais e exceções,Exemplos<22>,signal — Define manipuladores para eventos assíncronos
@anchor{library/signal note-on-sigpipe}@anchor{372e}
@subsubsection Nota sobre SIGPIPE


Canalizar a saída do seu programa para ferramentas como @code{head(1)@footnote{https://manpages.debian.org/head(1)}} fará com que um sinal @ref{370b,,SIGPIPE} seja enviado ao seu processo quando o receptor da saída padrão fechar antes do tempo. Isso resulta em uma exceção como @code{BrokenPipeError: [Errno 32] Broken pipe}. Para lidar com esse caso, envolva seu ponto de entrada para capturar essa exceção da seguinte maneira:

@example
import os
import sys

def main():
    try:
        # simula uma saída grande (seu código substitui este loop)
        for x in range(10000):
            print("y")
        # limpa a saída aqui para forçar o acionamento do SIGPIPE
        # enquanto estiver dentro deste bloco try.
        sys.stdout.flush()
    except BrokenPipeError:
        # Python libera fluxos padrão na saída; redireciona a saída restante
        # para devnull para evitar outro BrokenPipeError no desligamento
        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

Não defina a disposição de @ref{370b,,SIGPIPE} como @ref{193c,,SIG_DFL} para evitar @ref{1095,,BrokenPipeError}. Isso faria com que seu programa encerrasse inesperadamente sempre que qualquer conexão de soquete fosse interrompida enquanto o programa ainda estivesse escrevendo nele.

@node Nota sobre manipuladores de sinais e exceções,,Nota sobre SIGPIPE,signal — Define manipuladores para eventos assíncronos
@anchor{library/signal handlers-and-exceptions}@anchor{2422}@anchor{library/signal note-on-signal-handlers-and-exceptions}@anchor{372f}
@subsubsection Nota sobre manipuladores de sinais e exceções


Se um manipulador de sinais levantar uma exceção, a exceção será propagada para a thread principal e poderá ser levantada após qualquer instrução @ref{187,,bytecode}. Mais notavelmente, uma @ref{9d9,,KeyboardInterrupt} pode aparecer a qualquer momento durante a execução. A maioria dos códigos Python, incluindo a biblioteca padrão, não pode ser robusta contra isso, e, portanto, uma @ref{9d9,,KeyboardInterrupt} (ou qualquer outra exceção resultante de um manipulador de sinais) pode, em raras ocasiões, colocar o programa em um estado inesperado.

Para ilustrar esse problema, considere o seguinte código:

@example
class SpamContext:
    def __init__(self):
        self.lock = threading.Lock()

    def __enter__(self):
        # Se ocorrer KeyboardInterrupt aqui, está tudo bem
        self.lock.acquire()
        # Se KeyboardInterrupt ocorrer aqui, __exit__ não será chamado
        ...
        # KeyboardInterrupt pode ocorrer logo antes do retorno da função

    def __exit__(self, exc_type, exc_val, exc_tb):
        ...
        self.lock.release()
@end example

Para muitos programas, especialmente aqueles que simplesmente desejam encerrar em @ref{9d9,,KeyboardInterrupt}, isso não é um problema, mas aplicações complexos ou que exigem alta confiabilidade devem evitar levantar exceções de manipuladores de sinal. Eles também devem evitar capturar @ref{9d9,,KeyboardInterrupt} como forma de encerrar o programa sem problemas. Em vez disso, devem instalar seu próprio manipulador @ref{847,,SIGINT}. Abaixo está um exemplo de um servidor HTTP que evita @ref{9d9,,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 — Suporte a arquivos mapeados na memória,,signal — Define manipuladores para eventos assíncronos,Comunicação em Rede e Interprocesso
@anchor{library/mmap doc}@anchor{3730}@anchor{library/mmap mmap-memory-mapped-file-support}@anchor{3731}@anchor{library/mmap module-mmap}@anchor{90}@anchor{library/mmap translation-repo}@anchor{3732}
@subsection @code{mmap} — Suporte a arquivos mapeados na memória


@geindex module; mmap


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

Objetos arquivo mapeados na memória se comportam como @ref{2ea,,bytearray} e como @ref{1203,,objetos arquivo}. Você pode usar objetos mmap na maioria dos lugares onde @ref{2ea,,bytearray} é esperado; por exemplo, você pode usar o módulo @ref{b9,,re} para pesquisar um arquivo mapeado na memória. Você também pode alterar um único byte executando @code{obj[index] = 97} ou alterar uma subsequência atribuindo a uma fatia: @code{obj[i1:i2] = b'...'}. Você também pode ler e gravar dados começando na posição atual do arquivo e @code{seek()} através do arquivo para diferentes posições.

Um arquivo mapeado na memória é criado pelo construtor @ref{20b,,mmap}, que é diferente no Unix e no Windows. Nos dois casos, você deve fornecer um descritor de arquivo para um arquivo aberto para atualização. Se você deseja mapear um objeto arquivo Python existente, use o método @ref{15d0,,fileno()} para obter o valor correto para o parâmetro `fileno'. Caso contrário, você pode abrir o arquivo usando a função @ref{dba,,os.open()}, que retorna um descritor de arquivo diretamente (o arquivo ainda precisa ser fechado quando terminar).

@cartouche
@quotation Nota 
Se você deseja criar um mapeamento de memória para um arquivo gravável e armazenado em buffer, deve usar @ref{2df3,,flush()} no arquivo primeiro. Isso é necessário para garantir que as modificações locais nos buffers estejam realmente disponíveis para o mapeamento.
@end quotation
@end cartouche

Para as versões Unix e Windows do construtor, `access' pode ser especificado como um parâmetro opcional de palavra-chave. `access' aceita um dos quatro valores: @code{ACCESS_READ}, @code{ACCESS_WRITE} ou @code{ACCESS_COPY} para especificar memória somente leitura, gravação ou cópia na gravação, respectivamente @code{ACCESS_DEFAULT} para adiar para `prot'. `access' pode ser usado no Unix e no Windows. Se `access' não for especificado, o mmap do Windows retornará um mapeamento de gravação. Os valores iniciais da memória para todos os três tipos de acesso são obtidos do arquivo especificado. A atribuição a um mapa de memória @code{ACCESS_READ} gera uma exceção @ref{2c3,,TypeError}. A atribuição a um mapa de memória @code{ACCESS_WRITE} afeta a memória e o arquivo subjacente. A atribuição a um mapa de memória @code{ACCESS_COPY} afeta a memória, mas não atualiza o arquivo subjacente.


Alterado na versão 3.7: Adicionada a constante @code{ACCESS_DEFAULT}.


Para mapear a memória anônima, -1 deve ser passado como o fileno junto com o comprimento.

@geindex mmap (classe em mmap)
@anchor{library/mmap mmap mmap}@anchor{20b}
@deffn {Classe} mmap.mmap (fileno, length, tagname=None, access=ACCESS_DEFAULT, offset=0)

`(Versão Windows)' Mapeia `length' bytes do arquivo especificado pelo identificador de arquivo `fileno' e cria um objeto mmap. Se `length' for maior que o tamanho atual do arquivo, o arquivo será estendido para conter `length' bytes. Se `length' for @code{0}, o tamanho máximo do mapa será o tamanho atual do arquivo, exceto que, se o arquivo estiver vazio, o Windows levantará uma exceção (você não poderá criar um mapeamento vazio no Windows).

`tagname', se especificado e não @code{None}, é uma string que fornece um nome de tag para o mapeamento. O Windows permite que você tenha muitos mapeamentos diferentes no mesmo arquivo. Se você especificar o nome de uma marca existente, essa marca será aberta; caso contrário, uma nova marca com esse nome será criada. Se este parâmetro for omitido ou @code{None}, o mapeamento será criado sem um nome. Evitar o uso do parâmetro `tagname' ajudará a manter seu código portátil entre o Unix e o Windows.

`offset' pode ser especificado como um deslocamento inteiro não negativo. As referências mmap serão relativas ao deslocamento do início do arquivo. `offset' tem como padrão 0. `offset' deve ser um múltiplo de @code{ALLOCATIONGRANULARITY}.

Levanta um @ref{19fa,,evento de auditoria} @code{mmap.__new__} com os argumentos @code{fileno}, @code{length}, @code{access}, @code{offset}.
@end deffn


@deffn {Classe} mmap.mmap (fileno, length, flags=MAP_SHARED, prot=PROT_WRITE | PROT_READ, access=ACCESS_DEFAULT, offset=0, *, trackfd=True)

`(Versão Unix)' Mapeia `length' bytes do arquivo especificado pelo descritor de arquivo `fileno' e retorna um objeto mmap. Se `length' for @code{0}, o comprimento máximo do mapa será o tamanho atual do arquivo quando @ref{20b,,mmap} for chamado.

`flags' especifica a natureza do mapeamento. @ref{3733,,MAP_PRIVATE} cria um mapeamento privado de cópia na gravação, de modo que alterações no conteúdo do objeto mmap serão privadas para este processo, e @ref{3734,,MAP_SHARED} cria um mapeamento compartilhado com todos os outros processos que mapeiam as mesmas áreas do arquivo. O valor padrão é @ref{3734,,MAP_SHARED}. Alguns sistemas têm sinalizadores adicionais possíveis, com a lista completa especificada em @ref{3735,,constantes MAP_*}.

`prot', se especificado, fornece a proteção de memória desejada; os dois valores mais úteis são @code{PROT_READ} e @code{PROT_WRITE}, para especificar que as páginas podem ser lidas ou gravadas. `prot' tem como padrão @code{PROT_READ | PROT_WRITE}.

`access' pode ser especificado em vez de `flags' e `prot' como um parâmetro nomeado opcional. É um erro especificar `flags', `prot' e `access'. Consulte a descrição de `access' acima para obter informações sobre como usar este parâmetro.

`offset' pode ser especificado como um deslocamento inteiro não negativo. As referências mmap serão relativas ao deslocamento do início do arquivo. `offset' tem como padrão 0. `offset' deve ser um múltiplo de @code{ALLOCATIONGRANULARITY}, que é igual a @code{PAGESIZE} em sistemas Unix.

Se `trackfd' for @code{False}, o descritor de arquivo especificado por `fileno' não será duplicado e o objeto @code{mmap} resultante não será associado ao arquivo subjacente do mapa. Isso significa que os métodos @ref{3736,,size()} e @ref{3737,,resize()} falharão. Este modo é útil para limitar o número de descritores de arquivo abertos.

Para garantir a validade do mapeamento de memória criado, o arquivo especificado pelo descritor `fileno' é sincronizado internamente de forma automática com o armazenamento de suporte físico no macOS.


Alterado na versão 3.13: The `trackfd' parameter was added.


This example shows a simple way of using @ref{20b,,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{20b,,mmap} can also be used as a context manager in a @ref{5d2,,with}
statement:

@example
import mmap

with mmap.mmap(-1, 13) as mm:
    mm.write(b"Hello world!")
@end example


Adicionado na versão 3.2: Suporte a gerenciador de contexto.


The next example demonstrates how to create an anonymous map and exchange
data between the parent and child processes:

@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

Levanta um @ref{19fa,,evento de auditoria} @code{mmap.__new__} com os argumentos @code{fileno}, @code{length}, @code{access}, @code{offset}.

Memory-mapped file objects support the following methods:

@geindex close() (método mmap.mmap)
@anchor{library/mmap mmap mmap close}@anchor{3738}
@deffn {Método} close ()

Closes the mmap. Subsequent calls to other methods of the object will
result in a ValueError exception being raised. This will not close
the open file.
@end deffn

@geindex closed (atributo mmap.mmap)
@anchor{library/mmap mmap mmap closed}@anchor{3739}
@deffn {Atributo} closed

@code{True} if the file is closed.


Adicionado na versão 3.2.

@end deffn

@geindex find() (método mmap.mmap)
@anchor{library/mmap mmap mmap find}@anchor{373a}
@deffn {Método} find (sub[, start[, end]])

Returns the lowest index in the object where the subsequence `sub' is
found, such that `sub' is contained in the range [`start', `end'].
Optional arguments `start' and `end' are interpreted as in slice notation.
Returns @code{-1} on failure.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@end deffn

@geindex flush() (método mmap.mmap)
@anchor{library/mmap mmap mmap flush}@anchor{aa7}
@deffn {Método} flush ()

@deffnx {Método} flush (offset, size, /)

Flushes changes made to the in-memory copy of a file back to disk. Without
use of this call there is no guarantee that changes are written back before
the object is destroyed.  If `offset' and `size' are specified, only
changes to the given range of bytes will be flushed to disk; otherwise, the
whole extent of the mapping is flushed.  `offset' must be a multiple of the
@code{PAGESIZE} or @code{ALLOCATIONGRANULARITY}.

@code{None} is returned to indicate success.  An exception is raised when the
call failed.


Alterado na versão 3.8: Previously, a nonzero value was returned on success; zero was returned
on error under Windows.  A zero value was returned on success; an
exception was raised on error under Unix.

@end deffn

@geindex madvise() (método mmap.mmap)
@anchor{library/mmap mmap mmap madvise}@anchor{a10}
@deffn {Método} madvise (option[, start[, length]])

Send advice `option' to the kernel about the memory region beginning at
`start' and extending `length' bytes.  `option' must be one of the
@ref{373b,,MADV_* constants} available on the system.  If
`start' and `length' are omitted, the entire mapping is spanned.  On
some systems (including Linux), `start' must be a multiple of the
@code{PAGESIZE}.

Availability: Systems with the @code{madvise()} system call.


Adicionado na versão 3.8.

@end deffn

@geindex move() (método mmap.mmap)
@anchor{library/mmap mmap mmap move}@anchor{373c}
@deffn {Método} move (dest, src, count)

Copy the `count' bytes starting at offset `src' to the destination index
`dest'.  If the mmap was created with @code{ACCESS_READ}, then calls to
move will raise a @ref{2c3,,TypeError} exception.
@end deffn

@geindex read() (método mmap.mmap)
@anchor{library/mmap mmap mmap read}@anchor{111c}
@deffn {Método} read ([n])

Return a @ref{1c2,,bytes} containing up to `n' bytes starting from the
current file position. If the argument is omitted, @code{None} or negative,
return all bytes from the current file position to the end of the
mapping. The file position is updated to point after the bytes that were
returned.


Alterado na versão 3.3: Argument can be omitted or @code{None}.

@end deffn

@geindex read_byte() (método mmap.mmap)
@anchor{library/mmap mmap mmap read_byte}@anchor{373d}
@deffn {Método} read_byte ()

Returns a byte at the current file position as an integer, and advances
the file position by 1.
@end deffn

@geindex readline() (método mmap.mmap)
@anchor{library/mmap mmap mmap readline}@anchor{373e}
@deffn {Método} readline ()

Returns a single line, starting at the current file position and up to the
next newline. The file position is updated to point after the bytes that were
returned.
@end deffn

@geindex resize() (método mmap.mmap)
@anchor{library/mmap mmap mmap resize}@anchor{3737}
@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{2c3,,TypeError} exception.
Resizing a map created with `trackfd' set to @code{False},
will raise a @ref{202,,ValueError} exception.

`On Windows': Resizing the map will raise an @ref{417,,OSError} if there are other
maps against the same named file. Resizing an anonymous map (ie against the
pagefile) will silently create a new map with the original data copied over
up to the length of the new size.


Alterado na versão 3.11: Correctly fails if attempting to resize when another map is held
Allows resize against an anonymous map on Windows

@end deffn

@geindex rfind() (método mmap.mmap)
@anchor{library/mmap mmap mmap rfind}@anchor{373f}
@deffn {Método} rfind (sub[, start[, end]])

Returns the highest index in the object where the subsequence `sub' is
found, such that `sub' is contained in the range [`start', `end'].
Optional arguments `start' and `end' are interpreted as in slice notation.
Returns @code{-1} on failure.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.

@end deffn

@geindex seek() (método mmap.mmap)
@anchor{library/mmap mmap mmap seek}@anchor{20d}
@deffn {Método} seek (pos[, whence])

Set the file’s current position.  `whence' argument is optional and
defaults to @code{os.SEEK_SET} or @code{0} (absolute file positioning); other
values are @code{os.SEEK_CUR} or @code{1} (seek relative to the current
position) and @code{os.SEEK_END} or @code{2} (seek relative to the file’s end).


Alterado na versão 3.13: Return the new absolute position instead of @code{None}.

@end deffn

@geindex seekable() (método mmap.mmap)
@anchor{library/mmap mmap mmap seekable}@anchor{20c}
@deffn {Método} seekable ()

Return whether the file supports seeking, and the return value is always @code{True}.


Adicionado na versão 3.13.

@end deffn

@geindex size() (método mmap.mmap)
@anchor{library/mmap mmap mmap size}@anchor{3736}
@deffn {Método} size ()

Return the length of the file, which can be larger than the size of the
memory-mapped area.
@end deffn

@geindex tell() (método mmap.mmap)
@anchor{library/mmap mmap mmap tell}@anchor{3740}
@deffn {Método} tell ()

Returns the current position of the file pointer.
@end deffn

@geindex write() (método mmap.mmap)
@anchor{library/mmap mmap mmap write}@anchor{d6d}
@deffn {Método} write (bytes)

Write the bytes in `bytes' into memory at the current position of the
file pointer and return the number of bytes written (never less than
@code{len(bytes)}, since if the write fails, a @ref{202,,ValueError} will be
raised).  The file position is updated to point after the bytes that
were written.  If the mmap was created with @code{ACCESS_READ}, then
writing to it will raise a @ref{2c3,,TypeError} exception.


Alterado na versão 3.5: Writable @ref{d4f,,bytes-like object} is now accepted.



Alterado na versão 3.6: The number of bytes written is now returned.

@end deffn

@geindex write_byte() (método mmap.mmap)
@anchor{library/mmap mmap mmap write_byte}@anchor{3741}
@deffn {Método} write_byte (byte)

Write the integer `byte' into memory at the current
position of the file pointer; the file position is advanced by @code{1}. If
the mmap was created with @code{ACCESS_READ}, then writing to it will
raise a @ref{2c3,,TypeError} exception.
@end deffn
@end deffn

@menu
* Constantes MADV_*:: 
* Constantes MAP_*:: 

@end menu

@node Constantes MADV_*,Constantes MAP_*,,mmap — Suporte a arquivos mapeados na memória
@anchor{library/mmap madv-constants}@anchor{3742}@anchor{library/mmap madvise-constants}@anchor{373b}
@subsubsection Constantes MADV_*


@geindex MADV_NORMAL (no módulo mmap)
@geindex MADV_RANDOM (no módulo mmap)
@geindex MADV_SEQUENTIAL (no módulo mmap)
@geindex MADV_WILLNEED (no módulo mmap)
@geindex MADV_DONTNEED (no módulo mmap)
@geindex MADV_REMOVE (no módulo mmap)
@geindex MADV_DONTFORK (no módulo mmap)
@geindex MADV_DOFORK (no módulo mmap)
@geindex MADV_HWPOISON (no módulo mmap)
@geindex MADV_MERGEABLE (no módulo mmap)
@geindex MADV_UNMERGEABLE (no módulo mmap)
@geindex MADV_SOFT_OFFLINE (no módulo mmap)
@geindex MADV_HUGEPAGE (no módulo mmap)
@geindex MADV_NOHUGEPAGE (no módulo mmap)
@geindex MADV_DONTDUMP (no módulo mmap)
@geindex MADV_DODUMP (no módulo mmap)
@geindex MADV_FREE (no módulo mmap)
@geindex MADV_NOSYNC (no módulo mmap)
@geindex MADV_AUTOSYNC (no módulo mmap)
@geindex MADV_NOCORE (no módulo mmap)
@geindex MADV_CORE (no módulo mmap)
@geindex MADV_PROTECT (no módulo mmap)
@geindex MADV_FREE_REUSABLE (no módulo mmap)
@geindex MADV_FREE_REUSE (no módulo mmap)
@anchor{library/mmap mmap MADV_NORMAL}@anchor{3743}
@deffn {Dado} mmap.MADV_NORMAL
@anchor{library/mmap mmap MADV_RANDOM}@anchor{3744}
@deffnx {Dado} mmap.MADV_RANDOM
@anchor{library/mmap mmap MADV_SEQUENTIAL}@anchor{3745}
@deffnx {Dado} mmap.MADV_SEQUENTIAL
@anchor{library/mmap mmap MADV_WILLNEED}@anchor{3746}
@deffnx {Dado} mmap.MADV_WILLNEED
@anchor{library/mmap mmap MADV_DONTNEED}@anchor{3747}
@deffnx {Dado} mmap.MADV_DONTNEED
@anchor{library/mmap mmap MADV_REMOVE}@anchor{3748}
@deffnx {Dado} mmap.MADV_REMOVE
@anchor{library/mmap mmap MADV_DONTFORK}@anchor{3749}
@deffnx {Dado} mmap.MADV_DONTFORK
@anchor{library/mmap mmap MADV_DOFORK}@anchor{374a}
@deffnx {Dado} mmap.MADV_DOFORK
@anchor{library/mmap mmap MADV_HWPOISON}@anchor{374b}
@deffnx {Dado} mmap.MADV_HWPOISON
@anchor{library/mmap mmap MADV_MERGEABLE}@anchor{374c}
@deffnx {Dado} mmap.MADV_MERGEABLE
@anchor{library/mmap mmap MADV_UNMERGEABLE}@anchor{374d}
@deffnx {Dado} mmap.MADV_UNMERGEABLE
@anchor{library/mmap mmap MADV_SOFT_OFFLINE}@anchor{374e}
@deffnx {Dado} mmap.MADV_SOFT_OFFLINE
@anchor{library/mmap mmap MADV_HUGEPAGE}@anchor{374f}
@deffnx {Dado} mmap.MADV_HUGEPAGE
@anchor{library/mmap mmap MADV_NOHUGEPAGE}@anchor{3750}
@deffnx {Dado} mmap.MADV_NOHUGEPAGE
@anchor{library/mmap mmap MADV_DONTDUMP}@anchor{3751}
@deffnx {Dado} mmap.MADV_DONTDUMP
@anchor{library/mmap mmap MADV_DODUMP}@anchor{3752}
@deffnx {Dado} mmap.MADV_DODUMP
@anchor{library/mmap mmap MADV_FREE}@anchor{3753}
@deffnx {Dado} mmap.MADV_FREE
@anchor{library/mmap mmap MADV_NOSYNC}@anchor{3754}
@deffnx {Dado} mmap.MADV_NOSYNC
@anchor{library/mmap mmap MADV_AUTOSYNC}@anchor{3755}
@deffnx {Dado} mmap.MADV_AUTOSYNC
@anchor{library/mmap mmap MADV_NOCORE}@anchor{3756}
@deffnx {Dado} mmap.MADV_NOCORE
@anchor{library/mmap mmap MADV_CORE}@anchor{3757}
@deffnx {Dado} mmap.MADV_CORE
@anchor{library/mmap mmap MADV_PROTECT}@anchor{3758}
@deffnx {Dado} mmap.MADV_PROTECT
@anchor{library/mmap mmap MADV_FREE_REUSABLE}@anchor{3759}
@deffnx {Dado} mmap.MADV_FREE_REUSABLE
@anchor{library/mmap mmap MADV_FREE_REUSE}@anchor{375a}
@deffnx {Dado} mmap.MADV_FREE_REUSE

These options can be passed to @ref{a10,,mmap.madvise()}.  Not every option will
be present on every system.

Availability: Systems with the madvise() system call.


Adicionado na versão 3.8.

@end deffn

@node Constantes MAP_*,,Constantes MADV_*,mmap — Suporte a arquivos mapeados na memória
@anchor{library/mmap id1}@anchor{375b}@anchor{library/mmap map-constants}@anchor{3735}
@subsubsection Constantes MAP_*


@geindex MAP_SHARED (no módulo mmap)
@geindex MAP_PRIVATE (no módulo mmap)
@geindex MAP_32BIT (no módulo mmap)
@geindex MAP_ALIGNED_SUPER (no módulo mmap)
@geindex MAP_ANON (no módulo mmap)
@geindex MAP_ANONYMOUS (no módulo mmap)
@geindex MAP_CONCEAL (no módulo mmap)
@geindex MAP_DENYWRITE (no módulo mmap)
@geindex MAP_EXECUTABLE (no módulo mmap)
@geindex MAP_HASSEMAPHORE (no módulo mmap)
@geindex MAP_JIT (no módulo mmap)
@geindex MAP_NOCACHE (no módulo mmap)
@geindex MAP_NOEXTEND (no módulo mmap)
@geindex MAP_NORESERVE (no módulo mmap)
@geindex MAP_POPULATE (no módulo mmap)
@geindex MAP_RESILIENT_CODESIGN (no módulo mmap)
@geindex MAP_RESILIENT_MEDIA (no módulo mmap)
@geindex MAP_STACK (no módulo mmap)
@geindex MAP_TPRO (no módulo mmap)
@geindex MAP_TRANSLATED_ALLOW_EXECUTE (no módulo mmap)
@geindex MAP_UNIX03 (no módulo mmap)
@anchor{library/mmap mmap MAP_SHARED}@anchor{3734}
@deffn {Dado} mmap.MAP_SHARED
@anchor{library/mmap mmap MAP_PRIVATE}@anchor{3733}
@deffnx {Dado} mmap.MAP_PRIVATE
@anchor{library/mmap mmap MAP_32BIT}@anchor{1797}
@deffnx {Dado} mmap.MAP_32BIT
@anchor{library/mmap mmap MAP_ALIGNED_SUPER}@anchor{184f}
@deffnx {Dado} mmap.MAP_ALIGNED_SUPER
@anchor{library/mmap mmap MAP_ANON}@anchor{375c}
@deffnx {Dado} mmap.MAP_ANON
@anchor{library/mmap mmap MAP_ANONYMOUS}@anchor{375d}
@deffnx {Dado} mmap.MAP_ANONYMOUS
@anchor{library/mmap mmap MAP_CONCEAL}@anchor{1850}
@deffnx {Dado} mmap.MAP_CONCEAL
@anchor{library/mmap mmap MAP_DENYWRITE}@anchor{375e}
@deffnx {Dado} mmap.MAP_DENYWRITE
@anchor{library/mmap mmap MAP_EXECUTABLE}@anchor{375f}
@deffnx {Dado} mmap.MAP_EXECUTABLE
@anchor{library/mmap mmap MAP_HASSEMAPHORE}@anchor{1792}
@deffnx {Dado} mmap.MAP_HASSEMAPHORE
@anchor{library/mmap mmap MAP_JIT}@anchor{1794}
@deffnx {Dado} mmap.MAP_JIT
@anchor{library/mmap mmap MAP_NOCACHE}@anchor{1793}
@deffnx {Dado} mmap.MAP_NOCACHE
@anchor{library/mmap mmap MAP_NOEXTEND}@anchor{1791}
@deffnx {Dado} mmap.MAP_NOEXTEND
@anchor{library/mmap mmap MAP_NORESERVE}@anchor{1790}
@deffnx {Dado} mmap.MAP_NORESERVE
@anchor{library/mmap mmap MAP_POPULATE}@anchor{1abc}
@deffnx {Dado} mmap.MAP_POPULATE
@anchor{library/mmap mmap MAP_RESILIENT_CODESIGN}@anchor{1795}
@deffnx {Dado} mmap.MAP_RESILIENT_CODESIGN
@anchor{library/mmap mmap MAP_RESILIENT_MEDIA}@anchor{1796}
@deffnx {Dado} mmap.MAP_RESILIENT_MEDIA
@anchor{library/mmap mmap MAP_STACK}@anchor{3760}
@deffnx {Dado} mmap.MAP_STACK
@anchor{library/mmap mmap MAP_TPRO}@anchor{179a}
@deffnx {Dado} mmap.MAP_TPRO
@anchor{library/mmap mmap MAP_TRANSLATED_ALLOW_EXECUTE}@anchor{1798}
@deffnx {Dado} mmap.MAP_TRANSLATED_ALLOW_EXECUTE
@anchor{library/mmap mmap MAP_UNIX03}@anchor{1799}
@deffnx {Dado} mmap.MAP_UNIX03

These are the various flags that can be passed to @ref{20b,,mmap.mmap()}.  @ref{184f,,MAP_ALIGNED_SUPER}
is only available at FreeBSD and @ref{1850,,MAP_CONCEAL} is only available at OpenBSD.  Note
that some options might not be present on some systems.


Alterado na versão 3.10: Added @ref{1abc,,MAP_POPULATE} constant.



Adicionado na versão 3.11: Added @ref{3760,,MAP_STACK} constant.



Adicionado na versão 3.12: Added @ref{184f,,MAP_ALIGNED_SUPER} and @ref{1850,,MAP_CONCEAL} constants.



Adicionado na versão 3.13: Added @ref{1797,,MAP_32BIT}, @ref{1792,,MAP_HASSEMAPHORE}, @ref{1794,,MAP_JIT},
@ref{1793,,MAP_NOCACHE}, @ref{1791,,MAP_NOEXTEND}, @ref{1790,,MAP_NORESERVE},
@ref{1795,,MAP_RESILIENT_CODESIGN}, @ref{1796,,MAP_RESILIENT_MEDIA},
@ref{179a,,MAP_TPRO}, @ref{1798,,MAP_TRANSLATED_ALLOW_EXECUTE}, and
@ref{1799,,MAP_UNIX03} constants.

@end deffn

@node Manuseio de Dados na Internet,Ferramentas de Processamento de Markup Estruturado,Comunicação em Rede e Interprocesso,A Biblioteca Padrão do Python
@anchor{library/netdata doc}@anchor{3761}@anchor{library/netdata internet-data-handling}@anchor{3762}@anchor{library/netdata netdata}@anchor{3763}@anchor{library/netdata translation-repo}@anchor{3764}
@section Manuseio de Dados na Internet


Este capítulo descreve módulos que suportam a manipulação de formatos de dados comumente usados na Internet.

@menu
* email — Um e-mail e um pacote MIME manipulável:: 
* json — Codificador e decodificador JSON:: 
* mailbox — Manipule caixas de entradas em vários formatos:: 
* mimetypes — Mapeia nomes de arquivos para tipos MIME:: 
* base64 — Base16@comma{} Base32@comma{} Base64@comma{} Base85 Data Encodings: base64 — Base16 Base32 Base64 Base85 Data Encodings. 
* binascii — Converte entre binário e ASCII:: 
* quopri — Codifica e decodifica dados MIME imprimidos entre aspas:: 

@end menu

@node email — Um e-mail e um pacote MIME manipulável,json — Codificador e decodificador JSON,,Manuseio de Dados na Internet
@anchor{library/email doc}@anchor{3765}@anchor{library/email email-an-email-and-mime-handling-package}@anchor{3766}@anchor{library/email module-email}@anchor{3b}
@subsection @code{email} — Um e-mail e um pacote MIME manipulável


@geindex module; email

`Código-fonte:' Lib/email/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/__init__.py}


__________________________________________________________________


O pacote @ref{3b,,email} é uma biblioteca para gerenciar mensagens de e-mail. Ela foi especificamente `não' projetada para enviar mensagens de e-mail para SMTP (
@geindex RFC; RFC 2821
RFC 2821@footnote{https://datatracker.ietf.org/doc/html/rfc2821.html}), NNTP ou outros servidores; essas são funções de módulos como @ref{ca,,smtplib}. O pacote @ref{3b,,email} tenta ser o mais compatível possível com RFC, suportando 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} e 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html}, bem como os RFCs relacionados ao MIME como 
@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} e 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.

No geral a estrutura do pacote de e-mail pode ser dividida em três componentes principais, mais um quarto componente que controla o comportamento dos outros componentes.

O componente central do pacote é um “modelo de objeto” que representa mensagens de e-mail. Uma aplicação interage com o pacote principalmente através da interface do modelo de objeto definida no submódulo @ref{44,,message}. A aplicação pode usar essa API para fazer perguntas sobre um e-mail existente, construir um novo e-mail ou adicionar ou remover subcomponentes de e-mail que usam a mesma interface de modelo de objeto. Ou seja, seguindo a natureza das mensagens de e-mail e seus subcomponentes MIME, o modelo de objeto de e-mail é uma estrutura em árvore de objetos que fornecem a API @ref{27b,,EmailMessage}.

Os outros dois componentes principais do pacote são @ref{4e,,parser} e @ref{40,,generator}. O analisador sintático pega a versão serializada de uma mensagem de e-mail (um fluxo de bytes) e a converte em uma árvore de objetos @ref{27b,,EmailMessage}. O gerador pega um @ref{27b,,EmailMessage} e o transforma novamente em um fluxo de bytes serializado. (O analisador sintático e o gerador também lidam com fluxos de caracteres de texto, mas esse uso é desencorajado, pois é muito fácil terminar com mensagens que não são válidas de uma maneira ou de outra.)

O componente de controle é o módulo @ref{4f,,policy}. Cada @ref{27b,,EmailMessage}, cada @ref{40,,generator} e cada @ref{4e,,parser} tem um objeto associado @ref{4f,,policy} que controla seu comportamento. Normalmente, uma aplicação precisa especificar a política apenas quando uma @ref{27b,,EmailMessage} é criada, instanciando diretamente uma @ref{27b,,EmailMessage} para criar um novo e-mail ou analisando um fluxo de entrada usando um @ref{4e,,parser}. Mas a política pode ser alterada quando a mensagem é serializada usando um @ref{40,,generator}. Isso permite, por exemplo, analisar uma mensagem de e-mail genérica do disco, mas serializá-la usando as configurações SMTP padrão ao enviá-la para um servidor de e-mail.

O pacote de e-mail faz o possível para ocultar os detalhes das várias RFCs em vigor da aplicação. Conceitualmente, a aplicação deve tratar a mensagem de e-mail como uma árvore estruturada de texto unicode e anexos binários, sem ter que se preocupar com a forma como eles são representados quando serializados. Na prática, no entanto, muitas vezes é necessário estar ciente de pelo menos algumas das regras que regem as mensagens MIME e sua estrutura, especificamente os nomes e a natureza dos “tipos de conteúdo” MIME e como eles identificam documentos com várias partes. Na maioria das vezes, esse conhecimento só deve ser necessário para aplicações mais complexos e, mesmo assim, deve ser apenas a estrutura de alto nível em questão, e não os detalhes de como essas estruturas são representadas. Como os tipos de conteúdo MIME são amplamente utilizados no software moderno da Internet (não apenas no e-mail), este será um conceito familiar para muitos programadores.

As seções a seguir descrevem a funcionalidade do pacote @ref{3b,,email}. Começamos com o modelo de objeto @ref{44,,message}, que é a interface principal que uma aplicação usará, e seguimos com os componentes de @ref{4e,,parser} e @ref{40,,generator}. Em seguida, abordamos os controles @ref{4f,,policy}, que concluem o tratamento dos principais componentes da biblioteca.

As próximas três seções cobrem as exceções que o pacote pode apresentar e os defeitos (não conformidade com as RFCs) que o @ref{4e,,parser} pode detectar. A seguir, abordamos os subcomponentes @ref{42,,headerregistry} e os subcomponentes @ref{3d,,contentmanager}, que fornecem ferramentas para manipulação mais detalhada de cabeçalhos e cargas úteis, respectivamente. Ambos os componentes contêm recursos relevantes para consumir e produzir mensagens não triviais, mas também documentam suas APIs de extensibilidade, que serão de interesse para aplicações avançadas.

A seguir, é apresentado um conjunto de exemplos de uso das partes fundamentais das APIs abordadas nas seções anteriores.

O exposto acima representa a API moderna (compatível com unicode) do pacote de e-mail. As seções restantes, começando com a classe @ref{27c,,Message}, cobrem a API legada @ref{cb8,,compat32} que lida muito mais diretamente com os detalhes de como as mensagens de e-mail são representadas. A API @ref{cb8,,compat32} `não' oculta os detalhes dos RFCs da aplicação, mas para aplicações que precisam operar nesse nível, eles podem ser ferramentas úteis. Esta documentação também é relevante para aplicações que ainda estão usando a API @ref{cb8,,compat32} por motivos de compatibilidade com versões anteriores.


Alterado na versão 3.6: Documentos reorganizados e reescritos para promover a nova API @ref{27b,,EmailMessage}/@ref{10f6,,EmailPolicy}.


Conteúdos da documentação do pacote @ref{3b,,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; Geração de documentos MIME: email generator Geração de documentos MIME. 
* email.policy; Policy Objects: email policy Policy Objects. 
* email.errors; Classes de Exceção e Defeito.: email errors Classes de Exceção e Defeito. 
* email.headerregistry; Custom Header Objects: email headerregistry Custom Header Objects. 
* email.contentmanager; Gerenciando conteúdo MIME: email contentmanager Gerenciando conteúdo MIME. 
* email; Exemplos: email Exemplos. 
* email.message.Message; Representing an email message using the compat32 API: email message Message Representing an email message using the compat32 API. 
* email.mimeemail.mime; Criando e-mail e objetos MIME do zero: email mimeemail mime Criando e-mail e objetos MIME do zero. 
* email.header; Internationalized headers: email header Internationalized headers. 
* email.charset; Representando conjuntos de caracteres: email charset Representando conjuntos de caracteres. 
* email.encoders; Codificadores: email encoders Codificadores. 
* email.utils; Utilitários diversos: email utils Utilitários diversos. 
* email.iterators; Iteradores: email iterators Iteradores. 

@end menu

@node email message Representing an email message,email parser Parsing email messages,,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email message doc}@anchor{3767}@anchor{library/email message email-message-representing-an-email-message}@anchor{3768}@anchor{library/email message module-email message}@anchor{44}
@subsubsection @code{email.message}: Representing an email message


@geindex module; email.message

`Código-fonte:' Lib/email/message.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/message.py}


__________________________________________________________________



Adicionado na versão 3.6: @footnote{
Originally added in 3.4 as a @ref{107a,,provisional module}.  Docs for legacy message class moved to
@ref{3769,,email.message.Message; Representing an email message using the compat32 API}.
}


The central class in the @ref{3b,,email} package is the @ref{27b,,EmailMessage}
class, imported from the @ref{44,,email.message} module.  It is the base class for
the @ref{3b,,email} object model.  @ref{27b,,EmailMessage} provides the core
functionality for setting and querying header fields, for accessing message
bodies, and for creating or modifying structured messages.

An email message consists of `headers' and a `payload' (which is also referred
to as the `content').  Headers are 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} or 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} style field names
and values, where the field name and value are separated by a colon.  The colon
is not part of either the field name or the field value.  The payload may be a
simple text message, or a binary object, or a structured sequence of
sub-messages each with their own set of headers and their own payload.  The
latter type of payload is indicated by the message having a MIME type such as
@code{multipart/*} or @code{message/rfc822}.

The conceptual model provided by an @ref{27b,,EmailMessage} object is that of an
ordered dictionary of headers coupled with a `payload' that represents the
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} body of the message, which might be a list of sub-@code{EmailMessage}
objects.  In addition to the normal dictionary methods for accessing the header
names and values, there are methods for accessing specialized information from
the headers (for example the MIME content type), for operating on the payload,
for generating a serialized version of the message, and for recursively walking
over the object tree.

The @ref{27b,,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.

The `payload' is either a string or bytes object, in the case of simple message
objects, or a list of @ref{27b,,EmailMessage} objects, for MIME container
documents such as @code{multipart/*} and @code{message/rfc822}
message objects.

@geindex EmailMessage (classe em email.message)
@anchor{library/email message email message EmailMessage}@anchor{27b}
@deffn {Classe} email.message.EmailMessage (policy=default)

If `policy' is specified use the rules it specifies to update and serialize
the representation of the message.  If `policy' is not set, use the
@ref{15ad,,default} policy, which follows the rules of the email
RFCs except for line endings (instead of the RFC mandated @code{\r\n}, it uses
the Python standard @code{\n} line endings).  For more information see the
@ref{4f,,policy} documentation. @footnote{
The @ref{27b,,EmailMessage} class requires a policy that provides a
@code{content_manager} attribute for content management methods like
@code{set_content()} and @code{get_content()} to work. The legacy
@ref{cb8,,compat32} policy does not support these methods
and should not be used with @ref{27b,,EmailMessage}.
}

@geindex as_string() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage as_string}@anchor{376a}
@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{27c,,Message} class `maxheaderlen' is
accepted, but defaults to @code{None}, which means that by default the line
length is controlled by the
@ref{376b,,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{120e,,Generator}.

Flattening the message may trigger changes to the @ref{27b,,EmailMessage}
if defaults need to be filled in to complete the transformation to a
string (for example, MIME boundaries may be generated or modified).

Note that this method is provided as a convenience and may not be the
most useful way to serialize messages in your application, especially if
you are dealing with multiple messages.  See
@ref{120e,,email.generator.Generator} for a more flexible API for
serializing messages.  Note also that this method is restricted to
producing messages serialized as “7 bit clean” when
@ref{e24,,utf8} is @code{False}, which is the default.


Alterado na versão 3.6: the default behavior when `maxheaderlen'
is not specified was changed from defaulting to 0 to defaulting
to the value of `max_line_length' from the policy.

@end deffn

@geindex __str__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __str__}@anchor{376c}
@deffn {Método} __str__ ()

Equivalent to @code{as_string(policy=self.policy.clone(utf8=True))}.  Allows
@code{str(msg)} to produce a string containing the serialized message in a
readable format.


Alterado na versão 3.4: the method was changed to use @code{utf8=True},
thus producing an 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}-like message representation, instead of
being a direct alias for @ref{376a,,as_string()}.

@end deffn

@geindex as_bytes() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage as_bytes}@anchor{376d}
@deffn {Método} as_bytes (unixfrom=False, policy=None)

Return the entire message flattened as a bytes object.  When optional
`unixfrom' is true, the envelope header is included in the returned
string.  `unixfrom' defaults to @code{False}.  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{120f,,BytesGenerator}.

Flattening the message may trigger changes to the @ref{27b,,EmailMessage}
if defaults need to be filled in to complete the transformation to a
string (for example, MIME boundaries may be generated or modified).

Note that this method is provided as a convenience and may not be the
most useful way to serialize messages in your application, especially if
you are dealing with multiple messages.  See
@ref{120f,,email.generator.BytesGenerator} for a more flexible API for
serializing messages.
@end deffn

@geindex __bytes__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __bytes__}@anchor{376e}
@deffn {Método} __bytes__ ()

Equivalent to @ref{376d,,as_bytes()}.  Allows @code{bytes(msg)} to produce a
bytes object containing the serialized message.
@end deffn

@geindex is_multipart() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage is_multipart}@anchor{376f}
@deffn {Método} is_multipart ()

Return @code{True} if the message’s payload is a list of
sub-@ref{27b,,EmailMessage} objects, otherwise return @code{False}.  When
@ref{376f,,is_multipart()} returns @code{False}, the payload should be a string
object (which might be a CTE encoded binary payload).  Note that
@ref{376f,,is_multipart()} returning @code{True} does not necessarily mean that
“msg.get_content_maintype() == ‘multipart’” will return the @code{True}.
For example, @code{is_multipart} will return @code{True} when the
@ref{27b,,EmailMessage} is of type @code{message/rfc822}.
@end deffn

@geindex set_unixfrom() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_unixfrom}@anchor{3770}
@deffn {Método} set_unixfrom (unixfrom)

Set the message’s envelope header to `unixfrom', which should be a
string.  (See @ref{3771,,mboxMessage} for a brief description of
this header.)
@end deffn

@geindex get_unixfrom() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_unixfrom}@anchor{3772}
@deffn {Método} get_unixfrom ()

Return the message’s envelope header.  Defaults to @code{None} if the
envelope header was never set.
@end deffn

The following methods implement the mapping-like interface for accessing the
message’s headers.  Note that there are some semantic differences
between these methods and a normal mapping (i.e. dictionary) interface.  For
example, in a dictionary there are no duplicate keys, but here there may be
duplicate message headers.  Also, in dictionaries there is no guaranteed
order to the keys returned by @ref{3773,,keys()}, but in an @ref{27b,,EmailMessage}
object, headers are always returned in the order they appeared in the
original message, or in which they were added to the message later.  Any
header deleted and then re-added is always appended to the end of the
header list.

These semantic differences are intentional and are biased toward
convenience in the most common use cases.

Note that in all cases, any envelope header present in the message is not
included in the mapping interface.

@geindex __len__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __len__}@anchor{3774}
@deffn {Método} __len__ ()

Return the total number of headers, including duplicates.
@end deffn

@geindex __contains__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __contains__}@anchor{3775}
@deffn {Método} __contains__ (name)

Return @code{True} if the message object has a field named `name'. Matching is
done without regard to case and `name' does not include the trailing
colon.  Used for the @code{in} operator.  For example:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __getitem__}@anchor{3776}
@deffn {Método} __getitem__ (name)

Return the value of the named header field.  `name' does not include the
colon field separator.  If the header is missing, @code{None} is returned; a
@ref{344,,KeyError} is never raised.

Note that if the named field appears more than once in the message’s
headers, exactly which of those field values will be returned is
undefined.  Use the @ref{3777,,get_all()} method to get the values of all the
extant headers named `name'.

Using the standard (non-@code{compat32}) policies, the returned value is an
instance of a subclass of @ref{3778,,email.headerregistry.BaseHeader}.
@end deffn

@geindex __setitem__() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __setitem__}@anchor{3779}
@deffn {Método} __setitem__ (name, val)

Add a header to the message with field name `name' and value `val'.  The
field is appended to the end of the message’s existing headers.

Note that this does `not' overwrite or delete any existing header with the same
name.  If you want to ensure that the new header is the only one present in the
message with field name `name', delete the field first, e.g.:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example

If the @ref{4f,,policy} defines certain headers to be unique (as the standard
policies do), this method may raise a @ref{202,,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 email.message.EmailMessage)
@anchor{library/email message email message EmailMessage __delitem__}@anchor{377a}
@deffn {Método} __delitem__ (name)

Delete all occurrences of the field with name `name' from the message’s
headers.  No exception is raised if the named field isn’t present in the
headers.
@end deffn

@geindex keys() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage keys}@anchor{3773}
@deffn {Método} keys ()

Return a list of all the message’s header field names.
@end deffn

@geindex values() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage values}@anchor{377b}
@deffn {Método} values ()

Return a list of all the message’s field values.
@end deffn

@geindex items() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage items}@anchor{377c}
@deffn {Método} items ()

Return a list of 2-tuples containing all the message’s field headers and
values.
@end deffn

@geindex get() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get}@anchor{377d}
@deffn {Método} get (name, failobj=None)

Return the value of the named header field.  This is identical to
@ref{283,,__getitem__()} except that optional `failobj' is returned if the
named header is missing (`failobj' defaults to @code{None}).
@end deffn

Here are some additional useful header related methods:

@geindex get_all() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_all}@anchor{3777}
@deffn {Método} get_all (name, failobj=None)

Return a list of all the values for the field named `name'. If there are
no such named headers in the message, `failobj' is returned (defaults to
@code{None}).
@end deffn

@geindex add_header() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_header}@anchor{377e}
@deffn {Método} add_header (_name, _value, **_params)

Extended header setting.  This method is similar to @ref{3779,,__setitem__()}
except that additional header parameters can be provided as keyword
arguments.  `_name' is the header field to add and `_value' is the
`primary' value for the header.

For each item in the keyword argument dictionary `_params', the key is
taken as the parameter name, with underscores converted to dashes (since
dashes are illegal in Python identifiers).  Normally, the parameter will
be added as @code{key="value"} unless the value is @code{None}, in which case
only the key will be added.

If the value contains non-ASCII characters, the charset and language may
be explicitly controlled by specifying the value as a three tuple in the
format @code{(CHARSET, LANGUAGE, VALUE)}, where @code{CHARSET} is a string
naming the charset to be used to encode the value, @code{LANGUAGE} can
usually be set to @code{None} or the empty string (see 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} for other
possibilities), and @code{VALUE} is the string value containing non-ASCII
code points.  If a three tuple is not passed and the value contains
non-ASCII characters, it is automatically encoded in 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} format
using a @code{CHARSET} of @code{utf-8} and a @code{LANGUAGE} of @code{None}.

Aqui está um exemplo:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

This will add a header that looks like

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

An example of the extended interface with non-ASCII characters:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example
@end deffn

@geindex replace_header() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage replace_header}@anchor{377f}
@deffn {Método} replace_header (_name, _value)

Replace a header.  Replace the first header found in the message that
matches `_name', retaining header order and field name case of the
original header.  If no matching header is found, raise a
@ref{344,,KeyError}.
@end deffn

@geindex get_content_type() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_type}@anchor{3780}
@deffn {Método} get_content_type ()

Return the message’s content type, coerced to lower case of the form
@code{maintype/subtype}.  If there is no @code{Content-Type}
header in the message return the value returned by
@ref{3781,,get_default_type()}.  If the @code{Content-Type} header is
invalid, return @code{text/plain}.

(According to 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, messages always have a default type,
@ref{3780,,get_content_type()} will always return a value.  
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} defines
a message’s default type to be @code{text/plain} unless it appears
inside a @code{multipart/digest} container, in which case it would
be @code{message/rfc822}.  If the @code{Content-Type} header
has an invalid type specification, 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} mandates that the default
type be @code{text/plain}.)
@end deffn

@geindex get_content_maintype() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_maintype}@anchor{3782}
@deffn {Método} get_content_maintype ()

Return the message’s main content type.  This is the @code{maintype}
part of the string returned by @ref{3780,,get_content_type()}.
@end deffn

@geindex get_content_subtype() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_subtype}@anchor{3783}
@deffn {Método} get_content_subtype ()

Return the message’s sub-content type.  This is the @code{subtype}
part of the string returned by @ref{3780,,get_content_type()}.
@end deffn

@geindex get_default_type() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_default_type}@anchor{3781}
@deffn {Método} get_default_type ()

Return the default content type.  Most messages have a default content
type of @code{text/plain}, except for messages that are subparts of
@code{multipart/digest} containers.  Such subparts have a default
content type of @code{message/rfc822}.
@end deffn

@geindex set_default_type() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_default_type}@anchor{3784}
@deffn {Método} set_default_type (ctype)

Set the default content type.  `ctype' should either be
@code{text/plain} or @code{message/rfc822}, although this is
not enforced.  The default content type is not stored in the
@code{Content-Type} header, so it only affects the return value of
the @code{get_content_type} methods when no @code{Content-Type}
header is present in the message.
@end deffn

@geindex set_param() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_param}@anchor{3785}
@deffn {Método} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

Set a parameter in the @code{Content-Type} header.  If the
parameter already exists in the header, replace its value with `value'.
When `header' is @code{Content-Type} (the default) and the header does not
yet exist in the message, add it, set its value to
@code{text/plain}, and append the new parameter value.  Optional
`header' specifies an alternative header to @code{Content-Type}.

If the value contains non-ASCII characters, the charset and language may
be explicitly specified using the optional `charset' and `language'
parameters.  Optional `language' specifies the 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} language,
defaulting to the empty string.  Both `charset' and `language' should be
strings.  The default is to use the @code{utf8} `charset' and @code{None} for
the `language'.

If `replace' is @code{False} (the default) the header is moved to the
end of the list of headers.  If `replace' is @code{True}, the header
will be updated in place.

Uso do parâmetro `requote' com objetos @ref{27b,,EmailMessage}  está descontinuado.

Note that existing parameter values of headers may be accessed through
the @ref{3786,,params} attribute of the
header value (for example, @code{msg['Content-Type'].params['charset']}).


Alterado na versão 3.4: Palavra-chave @code{replace} foi adicionada.

@end deffn

@geindex del_param() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage del_param}@anchor{3787}
@deffn {Método} del_param (param, header='content-type', requote=True)

Remove the given parameter completely from the @code{Content-Type}
header.  The header will be re-written in place without the parameter or
its value.  Optional `header' specifies an alternative to
@code{Content-Type}.

Uso do parâmetro `requote' com objetos @ref{27b,,EmailMessage}  está descontinuado.
@end deffn

@geindex get_filename() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_filename}@anchor{3788}
@deffn {Método} get_filename (failobj=None)

Return the value of the @code{filename} parameter of the
@code{Content-Disposition} header of the message.  If the header
does not have a @code{filename} parameter, this method falls back to looking
for the @code{name} parameter on the @code{Content-Type} header.  If
neither is found, or the header is missing, then `failobj' is returned.
The returned string will always be unquoted as per
@ref{3789,,email.utils.unquote()}.
@end deffn

@geindex get_boundary() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_boundary}@anchor{378a}
@deffn {Método} get_boundary (failobj=None)

Return the value of the @code{boundary} parameter of the
@code{Content-Type} header of the message, or `failobj' if either
the header is missing, or has no @code{boundary} parameter.  The returned
string will always be unquoted as per @ref{3789,,email.utils.unquote()}.
@end deffn

@geindex set_boundary() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_boundary}@anchor{378b}
@deffn {Método} set_boundary (boundary)

Set the @code{boundary} parameter of the @code{Content-Type} header to
`boundary'.  @ref{378b,,set_boundary()} will always quote `boundary' if
necessary.  A @ref{378c,,HeaderParseError} is raised if the
message object has no @code{Content-Type} header.

Note that using this method is subtly different from deleting the old
@code{Content-Type} header and adding a new one with the new
boundary via @ref{377e,,add_header()}, because @ref{378b,,set_boundary()} preserves
the order of the @code{Content-Type} header in the list of
headers.
@end deffn

@geindex get_content_charset() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_charset}@anchor{378d}
@deffn {Método} get_content_charset (failobj=None)

Return the @code{charset} parameter of the @code{Content-Type} header,
coerced to lower case.  If there is no @code{Content-Type} header, or if
that header has no @code{charset} parameter, `failobj' is returned.
@end deffn

@geindex get_charsets() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_charsets}@anchor{378e}
@deffn {Método} get_charsets (failobj=None)

Return a list containing the character set names in the message.  If the
message is a @code{multipart}, then the list will contain one element
for each subpart in the payload, otherwise, it will be a list of length 1.

Each item in the list will be a string which is the value of the
@code{charset} parameter in the @code{Content-Type} header for the
represented subpart.  If the subpart has no @code{Content-Type}
header, no @code{charset} parameter, or is not of the @code{text} main
MIME type, then that item in the returned list will be `failobj'.
@end deffn

@geindex is_attachment() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage is_attachment}@anchor{378f}
@deffn {Método} is_attachment ()

Return @code{True} if there is a @code{Content-Disposition} header
and its (case insensitive) value is @code{attachment}, @code{False} otherwise.


Alterado na versão 3.4.2: is_attachment is now a method instead of a property, for consistency
with @ref{3790,,is_multipart()}.

@end deffn

@geindex get_content_disposition() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content_disposition}@anchor{3791}
@deffn {Método} get_content_disposition ()

Return the lowercased value (without parameters) of the message’s
@code{Content-Disposition} header if it has one, or @code{None}.  The
possible values for this method are `inline', `attachment' or @code{None}
if the message follows 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html}.


Adicionado na versão 3.5.

@end deffn

The following methods relate to interrogating and manipulating the content
(payload) of the message.

@geindex walk() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage walk}@anchor{3792}
@deffn {Método} walk ()

The @ref{3792,,walk()} method is an all-purpose generator which can be used to
iterate over all the parts and subparts of a message object tree, in
depth-first traversal order.  You will typically use @ref{3792,,walk()} as the
iterator in a @code{for} loop; each iteration returns the next subpart.

Here’s an example that prints the MIME type of every part of a multipart
message structure:

@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} iterates over the subparts of any part where
@ref{376f,,is_multipart()} returns @code{True}, even though
@code{msg.get_content_maintype() == 'multipart'} may return @code{False}.  We
can see this in our example by making use of the @code{_structure} debug
helper function:

@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

Here the @code{message} parts are not @code{multiparts}, but they do contain
subparts. @code{is_multipart()} returns @code{True} and @code{walk} descends
into the subparts.
@end deffn

@geindex get_body() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_body}@anchor{3793}
@deffn {Método} get_body (preferencelist=('related', 'html', 'plain'))

Return the MIME part that is the best candidate to be the “body” of the
message.

`preferencelist' must be a sequence of strings from the set @code{related},
@code{html}, and @code{plain}, and indicates the order of preference for the
content type of the part returned.

Start looking for candidate matches with the object on which the
@code{get_body} method is called.

If @code{related} is not included in `preferencelist', consider the root
part (or subpart of the root part) of any related encountered as a
candidate if the (sub-)part matches a preference.

When encountering a @code{multipart/related}, check the @code{start} parameter
and if a part with a matching @code{Content-ID} is found, consider
only it when looking for candidate matches.  Otherwise consider only the
first (default root) part of the @code{multipart/related}.

If a part has a @code{Content-Disposition} header, only consider
the part a candidate match if the value of the header is @code{inline}.

If none of the candidates matches any of the preferences in
`preferencelist', return @code{None}.

Notes: (1) For most applications the only `preferencelist' combinations
that really make sense are @code{('plain',)}, @code{('html', 'plain')}, and the
default @code{('related', 'html', 'plain')}.  (2) Because matching starts
with the object on which @code{get_body} is called, calling @code{get_body} on
a @code{multipart/related} will return the object itself unless
`preferencelist' has a non-default value. (3) Messages (or message parts)
that do not specify a @code{Content-Type} or whose
@code{Content-Type} header is invalid will be treated as if they
are of type @code{text/plain}, which may occasionally cause @code{get_body} to
return unexpected results.
@end deffn

@geindex iter_attachments() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage iter_attachments}@anchor{3794}
@deffn {Método} iter_attachments ()

Return an iterator over all of the immediate sub-parts of the message
that are not candidate “body” parts.  That is, skip the first occurrence
of each of @code{text/plain}, @code{text/html}, @code{multipart/related}, or
@code{multipart/alternative} (unless they are explicitly marked as
attachments via @code{Content-Disposition: attachment}), and
return all remaining parts.  When applied directly to a
@code{multipart/related}, return an iterator over the all the related parts
except the root part (ie: the part pointed to by the @code{start} parameter,
or the first part if there is no @code{start} parameter or the @code{start}
parameter doesn’t match the @code{Content-ID} of any of the
parts).  When applied directly to a @code{multipart/alternative} or a
non-@code{multipart}, return an empty iterator.
@end deffn

@geindex iter_parts() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage iter_parts}@anchor{3795}
@deffn {Método} iter_parts ()

Return an iterator over all of the immediate sub-parts of the message,
which will be empty for a non-@code{multipart}.  (See also
@ref{3792,,walk()}.)
@end deffn

@geindex get_content() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage get_content}@anchor{3796}
@deffn {Método} get_content (*args, content_manager=None, **kw)

Call the @ref{3797,,get_content()} method
of the `content_manager', passing self as the message object, and passing
along any other arguments or keywords as additional arguments.  If
`content_manager' is not specified, use the @code{content_manager} specified
by the current @ref{4f,,policy}.
@end deffn

@geindex set_content() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage set_content}@anchor{19e8}
@deffn {Método} set_content (*args, content_manager=None, **kw)

Call the @ref{3798,,set_content()} method
of the `content_manager', passing self as the message object, and passing
along any other arguments or keywords as additional arguments.  If
`content_manager' is not specified, use the @code{content_manager} specified
by the current @ref{4f,,policy}.
@end deffn

@geindex make_related() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_related}@anchor{3799}
@deffn {Método} make_related (boundary=None)

Convert a non-@code{multipart} message into a @code{multipart/related} message,
moving any existing @code{Content-} headers and payload into a
(new) first part of the @code{multipart}.  If `boundary' is specified, use
it as the boundary string in the multipart, otherwise leave the boundary
to be automatically created when it is needed (for example, when the
message is serialized).
@end deffn

@geindex make_alternative() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_alternative}@anchor{379a}
@deffn {Método} make_alternative (boundary=None)

Convert a non-@code{multipart} or a @code{multipart/related} into a
@code{multipart/alternative}, moving any existing @code{Content-}
headers and payload into a (new) first part of the @code{multipart}.  If
`boundary' is specified, use it as the boundary string in the multipart,
otherwise leave the boundary to be automatically created when it is
needed (for example, when the message is serialized).
@end deffn

@geindex make_mixed() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage make_mixed}@anchor{379b}
@deffn {Método} make_mixed (boundary=None)

Convert a non-@code{multipart}, a @code{multipart/related}, or a
@code{multipart-alternative} into a @code{multipart/mixed}, moving any existing
@code{Content-} headers and payload into a (new) first part of the
@code{multipart}.  If `boundary' is specified, use it as the boundary string
in the multipart, otherwise leave the boundary to be automatically
created when it is needed (for example, when the message is serialized).
@end deffn

@geindex add_related() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_related}@anchor{379c}
@deffn {Método} add_related (*args, content_manager=None, **kw)

If the message is a @code{multipart/related}, create a new message
object, pass all of the arguments to its @ref{19e8,,set_content()} method,
and @ref{379d,,attach()} it to the @code{multipart}.  If
the message is a non-@code{multipart}, call @ref{3799,,make_related()} and then
proceed as above.  If the message is any other type of @code{multipart},
raise a @ref{2c3,,TypeError}. If `content_manager' is not specified, use
the @code{content_manager} specified by the current @ref{4f,,policy}.
If the added part has no @code{Content-Disposition} header,
add one with the value @code{inline}.
@end deffn

@geindex add_alternative() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_alternative}@anchor{379e}
@deffn {Método} add_alternative (*args, content_manager=None, **kw)

If the message is a @code{multipart/alternative}, create a new message
object, pass all of the arguments to its @ref{19e8,,set_content()} method, and
@ref{379d,,attach()} it to the @code{multipart}.  If the
message is a non-@code{multipart} or @code{multipart/related}, call
@ref{379a,,make_alternative()} and then proceed as above.  If the message is
any other type of @code{multipart}, raise a @ref{2c3,,TypeError}. If
`content_manager' is not specified, use the @code{content_manager} specified
by the current @ref{4f,,policy}.
@end deffn

@geindex add_attachment() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage add_attachment}@anchor{379f}
@deffn {Método} add_attachment (*args, content_manager=None, **kw)

If the message is a @code{multipart/mixed}, create a new message object,
pass all of the arguments to its @ref{19e8,,set_content()} method, and
@ref{379d,,attach()} it to the @code{multipart}.  If the
message is a non-@code{multipart}, @code{multipart/related}, or
@code{multipart/alternative}, call @ref{379b,,make_mixed()} and then proceed as
above. If `content_manager' is not specified, use the @code{content_manager}
specified by the current @ref{4f,,policy}.  If the added part
has no @code{Content-Disposition} header, add one with the value
@code{attachment}.  This method can be used both for explicit attachments
(@code{Content-Disposition: attachment}) and @code{inline} attachments
(@code{Content-Disposition: inline}), by passing appropriate
options to the @code{content_manager}.
@end deffn

@geindex clear() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage clear}@anchor{37a0}
@deffn {Método} clear ()

Remove the payload and all of the headers.
@end deffn

@geindex clear_content() (método email.message.EmailMessage)
@anchor{library/email message email message EmailMessage clear_content}@anchor{37a1}
@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

@ref{27b,,EmailMessage} objects have the following instance attributes:

@geindex preamble (atributo email.message.EmailMessage)
@anchor{library/email message email message EmailMessage preamble}@anchor{37a2}
@deffn {Atributo} preamble

The format of a MIME document allows for some text between the blank line
following the headers, and the first multipart boundary string. Normally,
this text is never visible in a MIME-aware mail reader because it falls
outside the standard MIME armor.  However, when viewing the raw text of
the message, or when viewing the message in a non-MIME aware reader, this
text can become visible.

The `preamble' attribute contains this leading extra-armor text for MIME
documents.  When the @ref{11dc,,Parser} discovers some text
after the headers but before the first boundary string, it assigns this
text to the message’s `preamble' attribute.  When the
@ref{120e,,Generator} is writing out the plain text
representation of a MIME message, and it finds the
message has a `preamble' attribute, it will write this text in the area
between the headers and the first boundary.  See @ref{4e,,email.parser} and
@ref{40,,email.generator} for details.

Note that if the message object has no preamble, the `preamble' attribute
will be @code{None}.
@end deffn

@geindex epilogue (atributo email.message.EmailMessage)
@anchor{library/email message email message EmailMessage epilogue}@anchor{37a3}
@deffn {Atributo} epilogue

The `epilogue' attribute acts the same way as the `preamble' attribute,
except that it contains text that appears between the last boundary and
the end of the message.  As with the @ref{37a2,,preamble},
if there is no epilog text this attribute will be @code{None}.
@end deffn

@geindex defects (atributo email.message.EmailMessage)
@anchor{library/email message email message EmailMessage defects}@anchor{37a4}
@deffn {Atributo} defects

The `defects' attribute contains a list of all the problems found when
parsing this message.  See @ref{3f,,email.errors} for a detailed description
of the possible parsing defects.
@end deffn
@end deffn

@geindex MIMEPart (classe em email.message)
@anchor{library/email message email message MIMEPart}@anchor{f6d}
@deffn {Classe} email.message.MIMEPart (policy=default)

This class represents a subpart of a MIME message.  It is identical to
@ref{27b,,EmailMessage}, except that no @code{MIME-Version} headers are
added when @ref{19e8,,set_content()} is called, since sub-parts do
not need their own @code{MIME-Version} headers.
@end deffn

@node email parser Parsing email messages,email generator Geração de documentos MIME,email message Representing an email message,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email parser doc}@anchor{37a5}@anchor{library/email parser email-parser-parsing-email-messages}@anchor{37a6}@anchor{library/email parser module-email parser}@anchor{4e}@anchor{library/email parser translation-repo}@anchor{37a7}
@subsubsection @code{email.parser}: Parsing email messages


@geindex module; email.parser

`Código-fonte:' Lib/email/parser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/parser.py}


__________________________________________________________________


Message object structures can be created in one of two ways: they can be
created from whole cloth by creating an @ref{27b,,EmailMessage}
object, adding headers using the dictionary interface, and adding payload(s)
using @ref{19e8,,set_content()} and related methods, or
they can be created by parsing a serialized representation of the email
message.

The @ref{3b,,email} package provides a standard parser that understands most email
document structures, including MIME documents.  You can pass the parser a
bytes, string or file object, and the parser will return to you the root
@ref{27b,,EmailMessage} instance of the object structure.  For
simple, non-MIME messages the payload of this root object will likely be a
string containing the text of the message.  For MIME messages, the root object
will return @code{True} from its @ref{376f,,is_multipart()}
method, and the subparts can be accessed via the payload manipulation methods,
such as @ref{3793,,get_body()},
@ref{3795,,iter_parts()}, and
@ref{3792,,walk()}.

There are actually two parser interfaces available for use, the @ref{11dc,,Parser}
API and the incremental @ref{15ac,,FeedParser} API.  The @ref{11dc,,Parser} API is
most useful if you have the entire text of the message in memory, or if the
entire message lives in a file on the file system.  @ref{15ac,,FeedParser} is more
appropriate when you are reading the message from a stream which might block
waiting for more input (such as reading an email message from a socket).  The
@ref{15ac,,FeedParser} can consume and parse the message incrementally, and only
returns the root object when you close the parser.

Note that the parser can be extended in limited ways, and of course you can
implement your own parser completely from scratch.  All of the logic that
connects the @ref{3b,,email} package’s bundled parser and the
@ref{27b,,EmailMessage} class is embodied in the @ref{10f2,,Policy}
class, so a custom parser can create message object trees any way it finds
necessary by implementing custom versions of the appropriate @code{Policy}
methods.

@menu
* API do FeedParser:: 
* Parser API:: 
* Additional notes:: 

@end menu

@node API do FeedParser,Parser API,,email parser Parsing email messages
@anchor{library/email parser feedparser-api}@anchor{37a8}
@subsubsection API do FeedParser


The @ref{120b,,BytesFeedParser}, imported from the @code{email.feedparser} module,
provides an API that is conducive to incremental parsing of email messages,
such as would be necessary when reading the text of an email message from a
source that can block (such as a socket).  The @ref{120b,,BytesFeedParser} can of
course be used to parse an email message fully contained in a @ref{d4f,,bytes-like object}, string, or file, but the @ref{120c,,BytesParser} API may be more
convenient for such use cases.  The semantics and results of the two parser
APIs are identical.

The @ref{120b,,BytesFeedParser}’s API is simple; you create an instance, feed it a
bunch of bytes until there’s no more to feed it, then close the parser to
retrieve the root message object.  The @ref{120b,,BytesFeedParser} is extremely
accurate when parsing standards-compliant messages, and it does a very good job
of parsing non-compliant messages, providing information about how a message
was deemed broken.  It will populate a message object’s
@ref{37a4,,defects} attribute with a list of any
problems it found in a message.  See the @ref{3f,,email.errors} module for the
list of defects that it can find.

Here is the API for the @ref{120b,,BytesFeedParser}:

@geindex BytesFeedParser (classe em email.parser)
@anchor{library/email parser email parser BytesFeedParser}@anchor{120b}
@deffn {Classe} email.parser.BytesFeedParser (_factory=None, *, policy=policy.compat32)

Create a @ref{120b,,BytesFeedParser} instance.  Optional `_factory' is a
no-argument callable; if not specified use the
@ref{cb7,,message_factory} from the `policy'.  Call
`_factory' whenever a new message object is needed.

If `policy' is specified use the rules it specifies to update the
representation of the message.  If `policy' is not set, use the
@ref{10f3,,compat32} policy, which maintains backward
compatibility with the Python 3.2 version of the email package and provides
@ref{27c,,Message} as the default factory.  All other policies
provide @ref{27b,,EmailMessage} as the default `_factory'. For
more information on what else `policy' controls, see the
@ref{4f,,policy} documentation.

Note: `The policy keyword should always be specified'; The default will
change to @ref{15ad,,email.policy.default} in a future version of Python.


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionada o argumento nomeado `policy'.



Alterado na versão 3.6: `_factory' defaults to the policy @code{message_factory}.


@geindex feed() (método email.parser.BytesFeedParser)
@anchor{library/email parser email parser BytesFeedParser feed}@anchor{37a9}
@deffn {Método} feed (data)

Feed the parser some more data.  `data' should be a @ref{d4f,,bytes-like object} containing one or more lines.  The lines can be partial and the
parser will stitch such partial lines together properly.  The lines can
have any of the three common line endings: carriage return, newline, or
carriage return and newline (they can even be mixed).
@end deffn

@geindex close() (método email.parser.BytesFeedParser)
@anchor{library/email parser email parser BytesFeedParser close}@anchor{37aa}
@deffn {Método} close ()

Complete the parsing of all previously fed data and return the root
message object.  It is undefined what happens if @ref{37a9,,feed()} is called
after this method has been called.
@end deffn
@end deffn

@geindex FeedParser (classe em email.parser)
@anchor{library/email parser email parser FeedParser}@anchor{15ac}
@deffn {Classe} email.parser.FeedParser (_factory=None, *, policy=policy.compat32)

Works like @ref{120b,,BytesFeedParser} except that the input to the
@ref{37a9,,feed()} method must be a string.  This is of limited
utility, since the only way for such a message to be valid is for it to
contain only ASCII text or, if @ref{e24,,utf8} is
@code{True}, no binary attachments.


Alterado na versão 3.3: Adicionada o argumento nomeado `policy'.

@end deffn

@node Parser API,Additional notes,API do FeedParser,email parser Parsing email messages
@anchor{library/email parser parser-api}@anchor{37ab}
@subsubsection Parser API


The @ref{120c,,BytesParser} class, imported from the @ref{4e,,email.parser} module,
provides an API that can be used to parse a message when the complete contents
of the message are available in a @ref{d4f,,bytes-like object} or file.  The
@ref{4e,,email.parser} module also provides @ref{11dc,,Parser} for parsing strings,
and header-only parsers, @ref{10fa,,BytesHeaderParser} and
@ref{10fb,,HeaderParser}, which can be used if you’re only interested in the
headers of the message.  @ref{10fa,,BytesHeaderParser} and @ref{10fb,,HeaderParser}
can be much faster in these situations, since they do not attempt to parse the
message body, instead setting the payload to the raw body.

@geindex BytesParser (classe em email.parser)
@anchor{library/email parser email parser BytesParser}@anchor{120c}
@deffn {Classe} email.parser.BytesParser (_class=None, *, policy=policy.compat32)

Create a @ref{120c,,BytesParser} instance.  The `_class' and `policy'
arguments have the same meaning and semantics as the `_factory'
and `policy' arguments of @ref{120b,,BytesFeedParser}.

Note: `The policy keyword should always be specified'; The default will
change to @ref{15ad,,email.policy.default} in a future version of Python.


Alterado na versão 3.3: Removed the `strict' argument that was deprecated in 2.4.  Added the
`policy' keyword.



Alterado na versão 3.6: `_class' defaults to the policy @code{message_factory}.


@geindex parse() (método email.parser.BytesParser)
@anchor{library/email parser email parser BytesParser parse}@anchor{37ac}
@deffn {Método} parse (fp, headersonly=False)

Read all the data from the binary file-like object `fp', parse the
resulting bytes, and return the message object.  `fp' must support
both the @ref{241f,,readline()} and the @code{read()}
methods.

The bytes contained in `fp' must be formatted as a block of 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}
(or, if @ref{e24,,utf8} is @code{True}, 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html})
style headers and header continuation lines, optionally preceded by an
envelope header.  The header block is terminated either by the end of the
data or by a blank line.  Following the header block is the body of the
message (which may contain MIME-encoded subparts, including subparts
with a @code{Content-Transfer-Encoding} of @code{8bit}).

Optional `headersonly' is a flag specifying whether to stop parsing after
reading the headers or not.  The default is @code{False}, meaning it parses
the entire contents of the file.
@end deffn

@geindex parsebytes() (método email.parser.BytesParser)
@anchor{library/email parser email parser BytesParser parsebytes}@anchor{37ad}
@deffn {Método} parsebytes (bytes, headersonly=False)

Similar to the @ref{37ac,,parse()} method, except it takes a @ref{d4f,,bytes-like object} instead of a file-like object.  Calling this method on a
@ref{d4f,,bytes-like object} is equivalent to wrapping `bytes' in a
@ref{ed3,,BytesIO} instance first and calling @ref{37ac,,parse()}.

Optional `headersonly' is as with the @ref{37ac,,parse()} method.
@end deffn


Adicionado na versão 3.2.

@end deffn

@geindex BytesHeaderParser (classe em email.parser)
@anchor{library/email parser email parser BytesHeaderParser}@anchor{10fa}
@deffn {Classe} email.parser.BytesHeaderParser (_class=None, *, policy=policy.compat32)

Exactly like @ref{120c,,BytesParser}, except that `headersonly'
defaults to @code{True}.


Adicionado na versão 3.3.

@end deffn

@geindex Parser (classe em email.parser)
@anchor{library/email parser email parser Parser}@anchor{11dc}
@deffn {Classe} email.parser.Parser (_class=None, *, policy=policy.compat32)

This class is parallel to @ref{120c,,BytesParser}, but handles string input.


Alterado na versão 3.3: Removed the `strict' argument.  Added the `policy' keyword.



Alterado na versão 3.6: `_class' defaults to the policy @code{message_factory}.


@geindex parse() (método email.parser.Parser)
@anchor{library/email parser email parser Parser parse}@anchor{37ae}
@deffn {Método} parse (fp, headersonly=False)

Read all the data from the text-mode file-like object `fp', parse the
resulting text, and return the root message object.  `fp' must support
both the @ref{1e46,,readline()} and the
@ref{1e0c,,read()} methods on file-like objects.

Other than the text mode requirement, this method operates like
@ref{37ac,,BytesParser.parse()}.
@end deffn

@geindex parsestr() (método email.parser.Parser)
@anchor{library/email parser email parser Parser parsestr}@anchor{37af}
@deffn {Método} parsestr (text, headersonly=False)

Similar to the @ref{37ae,,parse()} method, except it takes a string object
instead of a file-like object.  Calling this method on a string is
equivalent to wrapping `text' in a @ref{f59,,StringIO} instance first
and calling @ref{37ae,,parse()}.

Optional `headersonly' is as with the @ref{37ae,,parse()} method.
@end deffn
@end deffn

@geindex HeaderParser (classe em email.parser)
@anchor{library/email parser email parser HeaderParser}@anchor{10fb}
@deffn {Classe} email.parser.HeaderParser (_class=None, *, policy=policy.compat32)

Exactly like @ref{11dc,,Parser}, except that `headersonly'
defaults to @code{True}.
@end deffn

Since creating a message object structure from a string or a file object is such
a common task, four functions are provided as a convenience.  They are available
in the top-level @ref{3b,,email} package namespace.

@geindex message_from_bytes() (no módulo email)
@anchor{library/email parser email message_from_bytes}@anchor{1209}
@deffn {Função} email.message_from_bytes (s, _class=None, *, policy=policy.compat32)

Return a message object structure from a @ref{d4f,,bytes-like object}.  This is
equivalent to @code{BytesParser().parsebytes(s)}.  Optional `_class' and
`policy' are interpreted as with the @ref{120c,,BytesParser} class
constructor.


Adicionado na versão 3.2.



Alterado na versão 3.3: Removed the `strict' argument.  Added the `policy' keyword.

@end deffn

@geindex message_from_binary_file() (no módulo email)
@anchor{library/email parser email message_from_binary_file}@anchor{120a}
@deffn {Função} email.message_from_binary_file (fp, _class=None, *, policy=policy.compat32)

Return a message object structure tree from an open binary @ref{1203,,file object}.  This is equivalent to @code{BytesParser().parse(fp)}.  `_class' and
`policy' are interpreted as with the @ref{120c,,BytesParser} class
constructor.


Adicionado na versão 3.2.



Alterado na versão 3.3: Removed the `strict' argument.  Added the `policy' keyword.

@end deffn

@geindex message_from_string() (no módulo email)
@anchor{library/email parser email message_from_string}@anchor{37b0}
@deffn {Função} email.message_from_string (s, _class=None, *, policy=policy.compat32)

Return a message object structure from a string.  This is equivalent to
@code{Parser().parsestr(s)}.  `_class' and `policy' are interpreted as
with the @ref{11dc,,Parser} class constructor.


Alterado na versão 3.3: Removed the `strict' argument.  Added the `policy' keyword.

@end deffn

@geindex message_from_file() (no módulo email)
@anchor{library/email parser email message_from_file}@anchor{37b1}
@deffn {Função} email.message_from_file (fp, _class=None, *, policy=policy.compat32)

Return a message object structure tree from an open @ref{1203,,file object}.
This is equivalent to @code{Parser().parse(fp)}.  `_class' and `policy' are
interpreted as with the @ref{11dc,,Parser} class constructor.


Alterado na versão 3.3: Removed the `strict' argument.  Added the `policy' keyword.



Alterado na versão 3.6: `_class' defaults to the policy @code{message_factory}.

@end deffn

Here’s an example of how you might use @ref{1209,,message_from_bytes()} at an
interactive Python prompt:

@example
>>> import email
>>> msg = email.message_from_bytes(myBytes)
@end example

@node Additional notes,,Parser API,email parser Parsing email messages
@anchor{library/email parser additional-notes}@anchor{37b2}
@subsubsection Additional notes


Here are some notes on the parsing semantics:


@itemize *

@item 
Most non-@code{multipart} type messages are parsed as a single message
object with a string payload.  These objects will return @code{False} for
@ref{376f,,is_multipart()}, and
@ref{3795,,iter_parts()} will yield an empty list.

@item 
All @code{multipart} type messages will be parsed as a container message
object with a list of sub-message objects for their payload.  The outer
container message will return @code{True} for
@ref{376f,,is_multipart()}, and
@ref{3795,,iter_parts()} will yield a list of subparts.

@item 
Most messages with a content type of @code{message/*} (such as
@code{message/delivery-status} and @code{message/rfc822}) will also
be parsed as container object containing a list payload of length 1.  Their
@ref{376f,,is_multipart()} method will return @code{True}.
The single element yielded by @ref{3795,,iter_parts()}
will be a sub-message object.

@item 
Some non-standards-compliant messages may not be internally consistent about
their @code{multipart}-edness.  Such messages may have a
@code{Content-Type} header of type @code{multipart}, but their
@ref{376f,,is_multipart()} method may return @code{False}.
If such messages were parsed with the @ref{15ac,,FeedParser},
they will have an instance of the
@ref{37b3,,MultipartInvariantViolationDefect} class in their
`defects' attribute list.  See @ref{3f,,email.errors} for details.
@end itemize

@node email generator Geração de documentos MIME,email policy Policy Objects,email parser Parsing email messages,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email generator doc}@anchor{37b4}@anchor{library/email generator email-generator-generating-mime-documents}@anchor{37b5}@anchor{library/email generator module-email generator}@anchor{40}@anchor{library/email generator translation-repo}@anchor{37b6}
@subsubsection @code{email.generator}: Geração de documentos MIME


@geindex module; email.generator

`Código-fonte:' Lib/email/generator.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/generator.py}


__________________________________________________________________


Uma das tarefas mais comuns é gerar a versão plana (serializada) da mensagem de e-mail representada por uma estrutura de objeto de mensagem. Você precisará fazer isso se quiser enviar sua mensagem via @ref{e88,,smtplib.SMTP.sendmail()} ou exibir a mensagem no console. A tarefa das classes geradoras é pegar uma estrutura de objeto de mensagem e produzir uma representação serializada.

Assim como no módulo @ref{4e,,email.parser}, você não está limitado à funcionalidade do gerador integrado; você mesmo pode criar um do zero. No entanto, o gerador integrado sabe como gerar a maioria dos e-mails em conformidade com os padrões, deve lidar perfeitamente com mensagens de e-mail MIME e não MIME e foi projetado para que as operações de análise e geração orientadas a bytes sejam inversas, presumindo que a mesma @ref{4f,,policy} não transformadora seja usada para ambas. Ou seja, analisar o fluxo de bytes serializado por meio da classe @ref{120c,,BytesParser} e, em seguida, regenerar o fluxo de bytes serializado usando @ref{120f,,BytesGenerator} deve produzir uma saída idêntica à entrada @footnote{
Esta instrução presume que você usa a configuração apropriada para @code{unixfrom} e que não haja configurações @ref{4f,,email.policy} que exijam ajustes automáticos (por exemplo, @ref{37b7,,refold_source} deve ser @code{none}, que `não' é o padrão). Também não é 100% verdadeiro, pois, se a mensagem não estiver em conformidade com os padrões RFC, ocasionalmente informações sobre o texto original exato são perdidas durante a recuperação de erros de análise. O objetivo é corrigir esses últimos casos extremos sempre que possível.
}. (Por outro lado, usar o gerador em um @ref{27b,,EmailMessage} construído pelo programa pode resultar em alterações no objeto @ref{27b,,EmailMessage} à medida que os padrões são preenchidos.)

A classe @ref{120e,,Generator} pode ser usada para simplificar uma mensagem em uma representação serializada de texto (em oposição a binária), mas como o Unicode não pode representar dados binários diretamente, a mensagem é necessariamente transformada em algo que contém apenas caracteres ASCII, usando as técnicas de codificação de transferência de conteúdo RFC de e-mail padrão para codificar mensagens de e-mail para transporte em canais que não são “limpos de 8 bits”.

Para acomodar o processamento reproduzível de mensagens assinadas por SMIME, @ref{120e,,Generator} desabilita a dobragem de cabeçalho para partes de mensagens do tipo @code{multipart/signed} e todas as subpartes.

@geindex BytesGenerator (classe em email.generator)
@anchor{library/email generator email generator BytesGenerator}@anchor{120f}
@deffn {Classe} email.generator.BytesGenerator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

Retorna um objeto @ref{120f,,BytesGenerator} que gravará qualquer mensagem fornecida ao método @ref{37b8,,flatten()}, ou qualquer texto codificado surrogateescape fornecido ao método @ref{37b9,,write()}, no @ref{15cf,,objeto arquivo ou similar} `outfp'. `outfp' deve oferecer suporte a um método @code{write} que aceite dados binários.

Se o `mangle_from_' opcional for @code{True}, coloca um caractere @code{>} na frente de qualquer linha no corpo que comece com a string exata @code{"From "}, ou seja, @code{From} seguido por um espaço no início de uma linha. `mangle_from_' assume por padrão o valor da configuração @ref{e22,,mangle_from_} da `policy' (que é @code{True} para a política @ref{cb8,,compat32} e @code{False} para todas as outras). `mangle_from_' deve ser usado quando as mensagens são armazenadas no formato mbox do Unix (consulte @ref{8b,,mailbox} e WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

Se `maxheaderlen' não for @code{None}, redobra quaisquer linhas de cabeçalho maiores que `maxheaderlen' ou, se for @code{0}, não redobra nenhum cabeçalho. Se `manheaderlen' for @code{None} (o padrão), redobra os cabeçalhos e outras linhas de mensagem de acordo com as configurações da `policy'.

Se `policy' for especificado, usa essa política para controlar a geração de mensagens. Se `policy' for @code{None} (o padrão), usa a política associada ao objeto @ref{27c,,Message} ou @ref{27b,,EmailMessage} passado para @code{flatten} para controlar a geração de mensagens. Consulte @ref{4f,,email.policy} para obter detalhes sobre o que `policy' controla.


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionada o argumento nomeado `policy'.



Alterado na versão 3.6: O comportamento padrão dos parâmetros `mangle_from_' e `maxheaderlen' é seguir a política.


@geindex flatten() (método email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator flatten}@anchor{37b8}
@deffn {Método} flatten (msg, unixfrom=False, linesep=None)

Exibe a representação textual da estrutura do objeto de mensagem com raiz em `msg' no arquivo de saída especificado quando a instância @ref{120f,,BytesGenerator} foi criada.

Se a opção @ref{4f,,policy} @ref{37ba,,cte_type} for @code{8bit} (o padrão), copia todos os cabeçalhos da mensagem original analisada que não tenham sido modificados para a saída, com todos os bytes com o bit mais alto definido reproduzidos como no original, e preserva a @code{Content-Transfer-Encoding} não ASCII de quaisquer partes do corpo que os contenham. Se @code{cte_type} for @code{7bit}, converte os bytes com o bit mais alto definido, conforme necessário, usando uma @code{Content-Transfer-Encoding} compatível com ASCII. Ou seja, transforma partes com @code{Content-Transfer-Encoding} não ASCII (@code{Content-Transfer-Encoding: 8bit}) em um @code{Content-Transfer-Encoding} compatível com ASCII e codifica bytes não ASCII inválidos para RFC em cabeçalhos usando o conjunto de caracteres MIME @code{unknown-8bit}, tornando-os compatíveis com RFC.

@c XXX: There should be an option that just does the RFC
@c compliance transformation on headers but leaves CTE 8bit parts alone.

Se `unixfrom' for @code{True}, exibe o delimitador de cabeçalho de envelope usado pelo formato de caixa de correio Unix (consulte @ref{8b,,mailbox}) antes do primeiro dos cabeçalhos 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} do objeto de mensagem raiz. Se o objeto raiz não tiver cabeçalho de envelope, crie um padrão. O padrão é @code{False}. Observe que, para subpartes, nenhum cabeçalho de envelope é exibido.

Se `linesep' não for @code{None}, usa-o como caractere separador entre todas as linhas da mensagem simplificada. Se `linesep' for @code{None} (o padrão), usa o valor especificado na `policy'.

@c XXX: flatten should take a *policy* keyword.
@end deffn

@geindex clone() (método email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator clone}@anchor{37bb}
@deffn {Método} clone (fp)

Retorna um clone independente desta instância @ref{120f,,BytesGenerator} com exatamente as mesmas configurações de opção e `fp' como o novo `outfp'.
@end deffn

@geindex write() (método email.generator.BytesGenerator)
@anchor{library/email generator email generator BytesGenerator write}@anchor{37b9}
@deffn {Método} write (s)

Codifica `s' usando o codec @code{ASCII} e o tratador de erros @code{surrogateescape} e passa-o para o método `write' do `outfp' passado ao construtor @ref{120f,,BytesGenerator}.
@end deffn
@end deffn

Para facilitar, @ref{27b,,EmailMessage} fornece os métodos @ref{376d,,as_bytes()} e @code{bytes(aMessage)} (também conhecidos como @ref{376e,,__bytes__()}), que simplificam a geração de uma representação binária serializada de um objeto de mensagem. Para mais detalhes, consulte @ref{44,,email.message}.

Como strings não podem representar dados binários, a classe @ref{120e,,Generator} deve converter quaisquer dados binários em qualquer mensagem que ela nivele para um formato compatível com ASCII, convertendo-os para um @code{Content-Transfer_Encoding} compatível com ASCII. Usando a terminologia dos RFCs de e-mail, você pode pensar nisso como @ref{120e,,Generator} serializando para um fluxo de E/S que não é “limpo em 8 bits”. Em outras palavras, a maioria das aplicações usará @ref{120f,,BytesGenerator}, e não @ref{120e,,Generator}.

@geindex Generator (classe em email.generator)
@anchor{library/email generator email generator Generator}@anchor{120e}
@deffn {Classe} email.generator.Generator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

Retorna um objeto @ref{120e,,Generator} que gravará qualquer mensagem fornecida ao método @ref{37bc,,flatten()}, ou qualquer texto fornecido ao método @ref{37bd,,write()}, no @ref{15cf,,objeto arquivo ou similar} `outfp'. `outfp' deve oferecer suporte a um método @code{write} que aceite dados string.

Se o `mangle_from_' opcional for @code{True}, coloca um caractere @code{>} na frente de qualquer linha no corpo que comece com a string exata @code{"From "}, ou seja, @code{From} seguido por um espaço no início de uma linha. `mangle_from_' assume por padrão o valor da configuração @ref{e22,,mangle_from_} da `policy' (que é @code{True} para a política @ref{cb8,,compat32} e @code{False} para todas as outras). `mangle_from_' deve ser usado quando as mensagens são armazenadas no formato mbox do Unix (consulte @ref{8b,,mailbox} e WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

Se `maxheaderlen' não for @code{None}, redobra quaisquer linhas de cabeçalho maiores que `maxheaderlen' ou, se for @code{0}, não redobra nenhum cabeçalho. Se `manheaderlen' for @code{None} (o padrão), redobra os cabeçalhos e outras linhas de mensagem de acordo com as configurações da `policy'.

Se `policy' for especificado, usa essa política para controlar a geração de mensagens. Se `policy' for @code{None} (o padrão), usa a política associada ao objeto @ref{27c,,Message} ou @ref{27b,,EmailMessage} passado para @code{flatten} para controlar a geração de mensagens. Consulte @ref{4f,,email.policy} para obter detalhes sobre o que `policy' controla.


Alterado na versão 3.3: Adicionada o argumento nomeado `policy'.



Alterado na versão 3.6: O comportamento padrão dos parâmetros `mangle_from_' e `maxheaderlen' é seguir a política.


@geindex flatten() (método email.generator.Generator)
@anchor{library/email generator email generator Generator flatten}@anchor{37bc}
@deffn {Método} flatten (msg, unixfrom=False, linesep=None)

Exibe a representação textual da estrutura do objeto de mensagem com raiz em `msg' no arquivo de saída especificado quando a instância @ref{120e,,Generator} foi criada.

Se a opção @ref{4f,,policy} @ref{37ba,,cte_type} for @code{8bit}, gera a mensagem como se a opção estivesse definida como @code{7bit}. (Isso é necessário porque strings não podem representar bytes não ASCII.) Converte quaisquer bytes com o bit mais alto definido, conforme necessário, usando uma @code{Content-Transfer-Encoding} compatível com ASCII. Ou seja, transforma partes com @code{Content-Transfer-Encoding} não ASCII (@code{Content-Transfer-Encoding: 8bit}) em um @code{Content-Transfer-Encoding} compatível com ASCII e codifica bytes não ASCII inválidos para RFC em cabeçalhos usando o conjunto de caracteres MIME @code{unknown-8bit}, tornando-os compatíveis com RFC.

Se `unixfrom' for @code{True}, exibe o delimitador de cabeçalho de envelope usado pelo formato de caixa de correio Unix (consulte @ref{8b,,mailbox}) antes do primeiro dos cabeçalhos 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} do objeto de mensagem raiz. Se o objeto raiz não tiver cabeçalho de envelope, crie um padrão. O padrão é @code{False}. Observe que, para subpartes, nenhum cabeçalho de envelope é exibido.

Se `linesep' não for @code{None}, usa-o como caractere separador entre todas as linhas da mensagem simplificada. Se `linesep' for @code{None} (o padrão), usa o valor especificado na `policy'.

@c XXX: flatten should take a *policy* keyword.


Alterado na versão 3.2: Adicionado suporte para recodificação de corpos de mensagens @code{8bit} e o argumento `linesep'.

@end deffn

@geindex clone() (método email.generator.Generator)
@anchor{library/email generator email generator Generator clone}@anchor{37be}
@deffn {Método} clone (fp)

Retorna um clone independente desta instância @ref{120e,,Generator} com exatamente as mesmas opções e `fp' como o novo `outfp'.
@end deffn

@geindex write() (método email.generator.Generator)
@anchor{library/email generator email generator Generator write}@anchor{37bd}
@deffn {Método} write (s)

Escreve `s' no método `write' do `outfp' passado ao construtor de @ref{120e,,Generator}. Isso fornece API arquivo ou similar suficiente para que instâncias de @ref{120e,,Generator} sejam usadas na função @ref{fa9,,print()}.
@end deffn
@end deffn

Para facilitar, @ref{27b,,EmailMessage} fornece os métodos @ref{376a,,as_string()} e @code{str(aMessage)} (também conhecidos como @ref{376c,,__str__()}), que simplificam a geração de uma representação de string formatada de um objeto de mensagem. Para mais detalhes, consulte @ref{44,,email.message}.

O módulo @ref{40,,email.generator} também fornece uma classe derivada, @ref{cb6,,DecodedGenerator}, que é como a classe base @ref{120e,,Generator}, exceto que as partes não-@code{text} não são serializadas, mas são representadas no fluxo de saída por uma string derivada de um modelo preenchido com informações sobre a parte.

@geindex DecodedGenerator (classe em email.generator)
@anchor{library/email generator email generator DecodedGenerator}@anchor{cb6}
@deffn {Classe} email.generator.DecodedGenerator (outfp, mangle_from_=None, maxheaderlen=None, fmt=None, *, policy=None)

Age como @ref{120e,,Generator}, exceto que para qualquer subparte da mensagem passada para @ref{37bc,,Generator.flatten()}, se a subparte for do tipo principal @code{text}, exibe a carga decodificada da subparte e, se o tipo principal não for @code{text}, em vez de exibi-la, preenche a string `fmt' usando informações da parte e exibe a string preenchida resultante.

Para preencher `fmt', executa @code{fmt % part_info}, onde @code{part_info} é um dicionário composto pelas seguintes chaves e valores:


@itemize *

@item 
@code{type} – Tipo MIME completo da parte não-@code{text}

@item 
@code{maintype} – Tipo MIME principal da parte não-@code{text}

@item 
@code{subtype} – Tipo sub-MIME da parte não-@code{text}

@item 
@code{filename} – Nome de arquivo da parte não-@code{text}

@item 
@code{description} – Descrição associada à parte não-@code{text}

@item 
@code{encoding} – Codificação de transferência de conteúdo da parte não-@code{text}
@end itemize

Se `fmt' for @code{None}, usa o seguinte `fmt' padrão:

@quotation

“[Non-text (%(type)s) part of message omitted, filename %(filename)s]”
@end quotation

Os opcionais `_mangle_from_' e `maxheaderlen' são como os da classe base @ref{120e,,Generator}.
@end deffn

@node email policy Policy Objects,email errors Classes de Exceção e Defeito,email generator Geração de documentos MIME,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email policy doc}@anchor{37bf}@anchor{library/email policy email-policy-policy-objects}@anchor{37c0}@anchor{library/email policy module-email policy}@anchor{4f}@anchor{library/email policy translation-repo}@anchor{37c1}
@subsubsection @code{email.policy}: Policy Objects


@geindex module; email.policy


Adicionado na versão 3.3.


`Código-fonte:' Lib/email/policy.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/policy.py}


__________________________________________________________________


The @ref{3b,,email} package’s prime focus is the handling of email messages as
described by the various email and MIME RFCs.  However, the general format of
email messages (a block of header fields each consisting of a name followed by
a colon followed by a value, the whole block followed by a blank line and an
arbitrary ‘body’), is a format that has found utility outside of the realm of
email.  Some of these uses conform fairly closely to the main email RFCs, some
do not.  Even when working with email, there are times when it is desirable to
break strict compliance with the RFCs, such as generating emails that
interoperate with email servers that do not themselves follow the standards, or
that implement extensions you want to use in ways that violate the
standards.

Policy objects give the email package the flexibility to handle all these
disparate use cases.

A @ref{10f2,,Policy} object encapsulates a set of attributes and methods that
control the behavior of various components of the email package during use.
@ref{10f2,,Policy} instances can be passed to various classes and methods in the
email package to alter the default behavior.  The settable values and their
defaults are described below.

There is a default policy used by all classes in the email package.  For all of
the @ref{4e,,parser} classes and the related convenience functions, and for
the @ref{27c,,Message} class, this is the @ref{10f3,,Compat32}
policy, via its corresponding pre-defined instance @ref{cb8,,compat32}.  This
policy provides for complete backward compatibility (in some cases, including
bug compatibility) with the pre-Python3.3 version of the email package.

This default value for the `policy' keyword to
@ref{27b,,EmailMessage} is the @ref{10f6,,EmailPolicy} policy, via
its pre-defined instance @ref{15ad,,default}.

When a @ref{27c,,Message} or @ref{27b,,EmailMessage}
object is created, it acquires a policy.  If the message is created by a
@ref{4e,,parser}, a policy passed to the parser will be the policy used by
the message it creates.  If the message is created by the program, then the
policy can be specified when it is created.  When a message is passed to a
@ref{40,,generator}, the generator uses the policy from the message by
default, but you can also pass a specific policy to the generator that will
override the one stored on the message object.

The default value for the `policy' keyword for the @ref{4e,,email.parser} classes
and the parser convenience functions `will be changing' in a future version of
Python.  Therefore you should `always specify explicitly which policy you want
to use' when calling any of the classes and functions described in the
@ref{4e,,parser} module.

The first part of this documentation covers the features of @ref{10f2,,Policy}, an
@ref{11f5,,abstract base class} that defines the features that are common to all
policy objects, including @ref{cb8,,compat32}.  This includes certain hook
methods that are called internally by the email package, which a custom policy
could override to obtain different behavior.  The second part describes the
concrete classes @ref{10f6,,EmailPolicy} and @ref{10f3,,Compat32}, which implement
the hooks that provide the standard behavior and the backward compatible
behavior and features, respectively.

@ref{10f2,,Policy} instances are immutable, but they can be cloned, accepting the
same keyword arguments as the class constructor and returning a new
@ref{10f2,,Policy} instance that is a copy of the original but with the specified
attributes values changed.

As an example, the following code could be used to read an email message from a
file on disk and pass it to the system @code{sendmail} program on a Unix system:

@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')

Here we are telling @ref{120f,,BytesGenerator} to use the RFC
correct line separator characters when creating the binary string to feed into
@code{sendmail's} @code{stdin}, where the default policy would use @code{\n} line
separators.

Some email package methods accept a `policy' keyword argument, allowing the
policy to be overridden for that method.  For example, the following code uses
the @ref{f6a,,as_bytes()} method of the `msg' object from
the previous example and writes the message to a file using the native line
separators for the platform on which it is running:

@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

Policy objects can also be combined using the addition operator, producing a
policy object whose settings are a combination of the non-default values of the
summed objects:

@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

This operation is not commutative; that is, the order in which the objects are
added matters.  To illustrate:

@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 (classe em email.policy)
@anchor{library/email policy email policy Policy}@anchor{10f2}
@deffn {Classe} email.policy.Policy (**kw)

This is the @ref{11f5,,abstract base class} for all policy classes.  It provides
default implementations for a couple of trivial methods, as well as the
implementation of the immutability property, the @ref{10f4,,clone()} method, and
the constructor semantics.

The constructor of a policy class can be passed various keyword arguments.
The arguments that may be specified are any non-method properties on this
class, plus any additional non-method properties on the concrete class.  A
value specified in the constructor will override the default value for the
corresponding attribute.

This class defines the following properties, and thus values for the
following may be passed in the constructor of any policy class:

@geindex max_line_length (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy max_line_length}@anchor{376b}
@deffn {Atributo} max_line_length

The maximum length of any line in the serialized output, not counting the
end of line character(s).  Default is 78, per 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.  A value of
@code{0} or @ref{675,,None} indicates that no line wrapping should be
done at all.
@end deffn

@geindex linesep (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy linesep}@anchor{37c2}
@deffn {Atributo} linesep

The string to be used to terminate lines in serialized output.  The
default is @code{\n} because that’s the internal end-of-line discipline used
by Python, though @code{\r\n} is required by the RFCs.
@end deffn

@geindex cte_type (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy cte_type}@anchor{37ba}
@deffn {Atributo} cte_type

Controls the type of Content Transfer Encodings that may be or are
required to be used.  The possible values are:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{7bit}

@tab

all data must be “7 bit clean” (ASCII-only).  This means that
where necessary data will be encoded using either
quoted-printable or base64 encoding.

@item

@code{8bit}

@tab

data is not constrained to be 7 bit clean.  Data in headers is
still required to be ASCII-only and so will be encoded (see
@ref{37c3,,fold_binary()} and @ref{e24,,utf8} below for
exceptions), but body parts may use the @code{8bit} CTE.

@end multitable


A @code{cte_type} value of @code{8bit} only works with @code{BytesGenerator}, not
@code{Generator}, because strings cannot contain binary data.  If a
@code{Generator} is operating under a policy that specifies
@code{cte_type=8bit}, it will act as if @code{cte_type} is @code{7bit}.
@end deffn

@geindex raise_on_defect (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy raise_on_defect}@anchor{37c4}
@deffn {Atributo} raise_on_defect

If @ref{c27,,True}, any defects encountered will be raised as errors.  If
@ref{b49,,False} (the default), defects will be passed to the
@ref{37c5,,register_defect()} method.
@end deffn

@geindex mangle_from_ (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy mangle_from_}@anchor{e22}
@deffn {Atributo} mangle_from_

If @ref{c27,,True}, lines starting with `“From “' in the body are
escaped by putting a @code{>} in front of them. This parameter is used when
the message is being serialized by a generator.
Default: @ref{b49,,False}.


Adicionado na versão 3.5.

@end deffn

@geindex message_factory (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy message_factory}@anchor{cb7}
@deffn {Atributo} message_factory

A factory function for constructing a new empty message object.  Used
by the parser when building messages.  Defaults to @code{None}, in
which case @ref{27c,,Message} is used.


Adicionado na versão 3.6.

@end deffn

@geindex verify_generated_headers (atributo email.policy.Policy)
@anchor{library/email policy email policy Policy verify_generated_headers}@anchor{1e0}
@deffn {Atributo} verify_generated_headers

If @code{True} (the default), the generator will raise
@ref{37c6,,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{10f3,,Compat32} policy.
For backwards compatible, but unsafe, behavior, it must be set to
@code{False} explicitly.


Adicionado na versão 3.13.

@end deffn

The following @ref{10f2,,Policy} method is intended to be called by code using
the email library to create policy instances with custom settings:

@geindex clone() (método email.policy.Policy)
@anchor{library/email policy email policy Policy clone}@anchor{10f4}
@deffn {Método} clone (**kw)

Return a new @ref{10f2,,Policy} instance whose attributes have the same
values as the current instance, except where those attributes are
given new values by the keyword arguments.
@end deffn

The remaining @ref{10f2,,Policy} methods are called by the email package code,
and are not intended to be called by an application using the email package.
A custom policy must implement all of these methods.

@geindex handle_defect() (método email.policy.Policy)
@anchor{library/email policy email policy Policy handle_defect}@anchor{37c7}
@deffn {Método} handle_defect (obj, defect)

Handle a `defect' found on `obj'.  When the email package calls this
method, `defect' will always be a subclass of
@ref{37c8,,MessageDefect}.

The default implementation checks the @ref{37c4,,raise_on_defect} flag.  If
it is @code{True}, `defect' is raised as an exception.  If it is @code{False}
(the default), `obj' and `defect' are passed to @ref{37c5,,register_defect()}.
@end deffn

@geindex register_defect() (método email.policy.Policy)
@anchor{library/email policy email policy Policy register_defect}@anchor{37c5}
@deffn {Método} register_defect (obj, defect)

Register a `defect' on `obj'.  In the email package, `defect' will always
be a subclass of @ref{37c8,,MessageDefect}.

The default implementation calls the @code{append} method of the @code{defects}
attribute of `obj'.  When the email package calls @ref{37c7,,handle_defect},
`obj' will normally have a @code{defects} attribute that has an @code{append}
method.  Custom object types used with the email package (for example,
custom @code{Message} objects) should also provide such an attribute,
otherwise defects in parsed messages will raise unexpected errors.
@end deffn

@geindex header_max_count() (método email.policy.Policy)
@anchor{library/email policy email policy Policy header_max_count}@anchor{37c9}
@deffn {Método} header_max_count (name)

Return the maximum allowed number of headers named `name'.

Called when a header is added to an @ref{27b,,EmailMessage}
or @ref{27c,,Message} object.  If the returned value is not
@code{0} or @code{None}, and there are already a number of headers with the
name `name' greater than or equal to the value returned, a
@ref{202,,ValueError} is raised.

Because the default behavior of @code{Message.__setitem__} is to append the
value to the list of headers, it is easy to create duplicate headers
without realizing it.  This method allows certain headers to be limited
in the number of instances of that header that may be added to a
@code{Message} programmatically.  (The limit is not observed by the parser,
which will faithfully produce as many headers as exist in the message
being parsed.)

The default implementation returns @code{None} for all header names.
@end deffn

@geindex header_source_parse() (método email.policy.Policy)
@anchor{library/email policy email policy Policy header_source_parse}@anchor{37ca}
@deffn {Método} header_source_parse (sourcelines)

The email package calls this method with a list of strings, each string
ending with the line separation characters found in the source being
parsed.  The first line includes the field header name and separator.
All whitespace in the source is preserved.  The method should return the
@code{(name, value)} tuple that is to be stored in the @code{Message} to
represent the parsed header.

If an implementation wishes to retain compatibility with the existing
email package policies, `name' should be the case preserved name (all
characters up to the ‘@code{:}’ separator), while `value' should be the
unfolded value (all line separator characters removed, but whitespace
kept intact), stripped of leading whitespace.

`sourcelines' may contain surrogateescaped binary data.

There is no default implementation
@end deffn

@geindex header_store_parse() (método email.policy.Policy)
@anchor{library/email policy email policy Policy header_store_parse}@anchor{37cb}
@deffn {Método} header_store_parse (name, value)

The email package calls this method with the name and value provided by
the application program when the application program is modifying a
@code{Message} programmatically (as opposed to a @code{Message} created by a
parser).  The method should return the @code{(name, value)} tuple that is to
be stored in the @code{Message} to represent the header.

If an implementation wishes to retain compatibility with the existing
email package policies, the `name' and `value' should be strings or
string subclasses that do not change the content of the passed in
arguments.

There is no default implementation
@end deffn

@geindex header_fetch_parse() (método email.policy.Policy)
@anchor{library/email policy email policy Policy header_fetch_parse}@anchor{37cc}
@deffn {Método} header_fetch_parse (name, value)

The email package calls this method with the `name' and `value' currently
stored in the @code{Message} when that header is requested by the
application program, and whatever the method returns is what is passed
back to the application as the value of the header being retrieved.
Note that there may be more than one header with the same name stored in
the @code{Message}; the method is passed the specific name and value of the
header destined to be returned to the application.

`value' may contain surrogateescaped binary data.  There should be no
surrogateescaped binary data in the value returned by the method.

There is no default implementation
@end deffn

@geindex fold() (método email.policy.Policy)
@anchor{library/email policy email policy Policy fold}@anchor{37cd}
@deffn {Método} fold (name, value)

The email package calls this method with the `name' and `value' currently
stored in the @code{Message} for a given header.  The method should return a
string that represents that header “folded” correctly (according to the
policy settings) by composing the `name' with the `value' and inserting
@ref{37c2,,linesep} characters at the appropriate places.  See 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}
for a discussion of the rules for folding email headers.

`value' may contain surrogateescaped binary data.  There should be no
surrogateescaped binary data in the string returned by the method.
@end deffn

@geindex fold_binary() (método email.policy.Policy)
@anchor{library/email policy email policy Policy fold_binary}@anchor{37c3}
@deffn {Método} fold_binary (name, value)

The same as @ref{37cd,,fold()}, except that the returned value should be a
bytes object rather than a string.

`value' may contain surrogateescaped binary data.  These could be
converted back into binary data in the returned bytes object.
@end deffn
@end deffn

@geindex EmailPolicy (classe em email.policy)
@anchor{library/email policy email policy EmailPolicy}@anchor{10f6}
@deffn {Classe} email.policy.EmailPolicy (**kw)

This concrete @ref{10f2,,Policy} provides behavior that is intended to be fully
compliant with the current email RFCs.  These include (but are not limited
to) 
@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}, and the current MIME RFCs.

This policy adds new header parsing and folding algorithms.  Instead of
simple strings, headers are @code{str} subclasses with attributes that depend
on the type of the field.  The parsing and folding algorithm fully implement
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} and 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.

The default value for the @ref{cb7,,message_factory}
attribute is @ref{27b,,EmailMessage}.

In addition to the settable attributes listed above that apply to all
policies, this policy adds the following additional attributes:


Adicionado na versão 3.6: @footnote{
Originally added in 3.3 as a @ref{107a,,provisional feature}.
}


@geindex utf8 (atributo email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy utf8}@anchor{e24}
@deffn {Atributo} utf8

If @code{False}, follow 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, supporting non-ASCII characters in
headers by encoding them as “encoded words”.  If @code{True}, follow
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} and use @code{utf-8} encoding for headers.  Messages
formatted in this way may be passed to SMTP servers that support
the @code{SMTPUTF8} extension (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}).
@end deffn

@geindex refold_source (atributo email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy refold_source}@anchor{37b7}
@deffn {Atributo} refold_source

If the value for a header in the @code{Message} object originated from a
@ref{4e,,parser} (as opposed to being set by a program), this
attribute indicates whether or not a generator should refold that value
when transforming the message back into serialized form.  The possible
values are:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{none}

@tab

all source values use original folding

@item

@code{long}

@tab

source values that have any line that is longer than
@code{max_line_length} will be refolded

@item

@code{all}

@tab

todos os valores são redobrados.

@end multitable


O padrão é @code{long}.
@end deffn

@geindex header_factory (atributo email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_factory}@anchor{37ce}
@deffn {Atributo} header_factory

A callable that takes two arguments, @code{name} and @code{value}, where
@code{name} is a header field name and @code{value} is an unfolded header field
value, and returns a string subclass that represents that header.  A
default @code{header_factory} (see @ref{42,,headerregistry}) is provided
that supports custom parsing for the various address and date 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}
header field types, and the major MIME header field stypes.  Support for
additional custom parsing will be added in the future.
@end deffn

@geindex content_manager (atributo email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy content_manager}@anchor{f6e}
@deffn {Atributo} content_manager

An object with at least two methods: get_content and set_content.  When
the @ref{3796,,get_content()} or
@ref{19e8,,set_content()} method of an
@ref{27b,,EmailMessage} object is called, it calls the
corresponding method of this object, passing it the message object as its
first argument, and any arguments or keywords that were passed to it as
additional arguments.  By default @code{content_manager} is set to
@ref{37cf,,raw_data_manager}.


Adicionado na versão 3.4.

@end deffn

The class provides the following concrete implementations of the abstract
methods of @ref{10f2,,Policy}:

@geindex header_max_count() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_max_count}@anchor{37d0}
@deffn {Método} header_max_count (name)

Returns the value of the
@ref{37d1,,max_count} attribute of the
specialized class used to represent the header with the given name.
@end deffn

@geindex header_source_parse() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_source_parse}@anchor{168c}
@deffn {Método} header_source_parse (sourcelines)

The name is parsed as everything up to the ‘@code{:}’ and returned
unmodified.  The value is determined by stripping leading whitespace off
the remainder of the first line, joining all subsequent lines together,
and stripping any trailing carriage return or linefeed characters.
@end deffn

@geindex header_store_parse() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_store_parse}@anchor{37d2}
@deffn {Método} header_store_parse (name, value)

The name is returned unchanged.  If the input value has a @code{name}
attribute and it matches `name' ignoring case, the value is returned
unchanged.  Otherwise the `name' and `value' are passed to
@code{header_factory}, and the resulting header object is returned as
the value.  In this case a @code{ValueError} is raised if the input value
contains CR or LF characters.
@end deffn

@geindex header_fetch_parse() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy header_fetch_parse}@anchor{37d3}
@deffn {Método} header_fetch_parse (name, value)

If the value has a @code{name} attribute, it is returned to unmodified.
Otherwise the `name', and the `value' with any CR or LF characters
removed, are passed to the @code{header_factory}, and the resulting
header object is returned.  Any surrogateescaped bytes get turned into
the unicode unknown-character glyph.
@end deffn

@geindex fold() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy fold}@anchor{176b}
@deffn {Método} fold (name, value)

Header folding is controlled by the @ref{37b7,,refold_source} policy setting.
A value is considered to be a ‘source value’ if and only if it does not
have a @code{name} attribute (having a @code{name} attribute means it is a
header object of some sort).  If a source value needs to be refolded
according to the policy, it is converted into a header object by
passing the `name' and the `value' with any CR and LF characters removed
to the @code{header_factory}.  Folding of a header object is done by
calling its @code{fold} method with the current policy.

Source values are split into lines using @ref{1298,,splitlines()}.  If
the value is not to be refolded, the lines are rejoined using the
@code{linesep} from the policy and returned.  The exception is lines
containing non-ascii binary data.  In that case the value is refolded
regardless of the @code{refold_source} setting, which causes the binary data
to be CTE encoded using the @code{unknown-8bit} charset.
@end deffn

@geindex fold_binary() (método email.policy.EmailPolicy)
@anchor{library/email policy email policy EmailPolicy fold_binary}@anchor{37d4}
@deffn {Método} fold_binary (name, value)

The same as @ref{176b,,fold()} if @ref{37ba,,cte_type} is @code{7bit}, except
that the returned value is bytes.

If @ref{37ba,,cte_type} is @code{8bit}, non-ASCII binary data is
converted back
into bytes.  Headers with binary data are not refolded, regardless of the
@code{refold_header} setting, since there is no way to know whether the
binary data consists of single byte characters or multibyte characters.
@end deffn
@end deffn

The following instances of @ref{10f6,,EmailPolicy} provide defaults suitable for
specific application domains.  Note that in the future the behavior of these
instances (in particular the @code{HTTP} instance) may be adjusted to conform even
more closely to the RFCs relevant to their domains.

@geindex default (no módulo email.policy)
@anchor{library/email policy email policy default}@anchor{15ad}
@deffn {Dado} email.policy.default

An instance of @code{EmailPolicy} with all defaults unchanged.  This policy
uses the standard Python @code{\n} line endings rather than the RFC-correct
@code{\r\n}.
@end deffn

@geindex SMTP (no módulo email.policy)
@anchor{library/email policy email policy SMTP}@anchor{37d5}
@deffn {Dado} email.policy.SMTP

Suitable for serializing messages in conformance with the email RFCs.
Like @code{default}, but with @code{linesep} set to @code{\r\n}, which is RFC
compliant.
@end deffn

@geindex SMTPUTF8 (no módulo email.policy)
@anchor{library/email policy email policy SMTPUTF8}@anchor{37d6}
@deffn {Dado} email.policy.SMTPUTF8

The same as @code{SMTP} except that @ref{e24,,utf8} is @code{True}.
Useful for serializing messages to a message store without using encoded
words in the headers.  Should only be used for SMTP transmission if the
sender or recipient addresses have non-ASCII characters (the
@ref{e89,,smtplib.SMTP.send_message()} method handles this automatically).
@end deffn

@geindex HTTP (no módulo email.policy)
@anchor{library/email policy email policy HTTP}@anchor{37d7}
@deffn {Dado} email.policy.HTTP

Suitable for serializing headers with for use in HTTP traffic.  Like
@code{SMTP} except that @code{max_line_length} is set to @code{None} (unlimited).
@end deffn

@geindex strict (no módulo email.policy)
@anchor{library/email policy email policy strict}@anchor{37d8}
@deffn {Dado} email.policy.strict

Convenience instance.  The same as @code{default} except that
@code{raise_on_defect} is set to @code{True}.  This allows any policy to be made
strict by writing:

@example
somepolicy + policy.strict
@end example
@end deffn

With all of these @ref{10f6,,EmailPolicies}, the effective API of
the email package is changed from the Python 3.2 API in the following ways:


@itemize *

@item 
Setting a header on a @ref{27c,,Message} results in that
header being parsed and a header object created.

@item 
Fetching a header value from a @ref{27c,,Message} results
in that header being parsed and a header object created and
returned.

@item 
Any header object, or any header that is refolded due to the
policy settings, is folded using an algorithm that fully implements the
RFC folding algorithms, including knowing where encoded words are required
and allowed.
@end itemize

From the application view, this means that any header obtained through the
@ref{27b,,EmailMessage} is a header object with extra
attributes, whose string value is the fully decoded unicode value of the
header.  Likewise, a header may be assigned a new value, or a new header
created, using a unicode string, and the policy will take care of converting
the unicode string into the correct RFC encoded form.

The header objects and their attributes are described in
@ref{42,,headerregistry}.

@geindex Compat32 (classe em email.policy)
@anchor{library/email policy email policy Compat32}@anchor{10f3}
@deffn {Classe} email.policy.Compat32 (**kw)

This concrete @ref{10f2,,Policy} is the backward compatibility policy.  It
replicates the behavior of the email package in Python 3.2.  The
@ref{4f,,policy} module also defines an instance of this class,
@ref{cb8,,compat32}, that is used as the default policy.  Thus the default
behavior of the email package is to maintain compatibility with Python 3.2.

The following attributes have values that are different from the
@ref{10f2,,Policy} default:

@geindex mangle_from_ (atributo email.policy.Compat32)
@anchor{library/email policy email policy Compat32 mangle_from_}@anchor{37d9}
@deffn {Atributo} mangle_from_

O padrão é @code{True}.
@end deffn

The class provides the following concrete implementations of the
abstract methods of @ref{10f2,,Policy}:

@geindex header_source_parse() (método email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_source_parse}@anchor{168d}
@deffn {Método} header_source_parse (sourcelines)

The name is parsed as everything up to the ‘@code{:}’ and returned
unmodified.  The value is determined by stripping leading whitespace off
the remainder of the first line, joining all subsequent lines together,
and stripping any trailing carriage return or linefeed characters.
@end deffn

@geindex header_store_parse() (método email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_store_parse}@anchor{37da}
@deffn {Método} header_store_parse (name, value)

The name and value are returned unmodified.
@end deffn

@geindex header_fetch_parse() (método email.policy.Compat32)
@anchor{library/email policy email policy Compat32 header_fetch_parse}@anchor{37db}
@deffn {Método} header_fetch_parse (name, value)

If the value contains binary data, it is converted into a
@ref{19e9,,Header} object using the @code{unknown-8bit} charset.
Otherwise it is returned unmodified.
@end deffn

@geindex fold() (método email.policy.Compat32)
@anchor{library/email policy email policy Compat32 fold}@anchor{37dc}
@deffn {Método} fold (name, value)

Headers are folded using the @ref{19e9,,Header} folding
algorithm, which preserves existing line breaks in the value, and wraps
each resulting line to the @code{max_line_length}.  Non-ASCII binary data are
CTE encoded using the @code{unknown-8bit} charset.
@end deffn

@geindex fold_binary() (método email.policy.Compat32)
@anchor{library/email policy email policy Compat32 fold_binary}@anchor{37dd}
@deffn {Método} fold_binary (name, value)

Headers are folded using the @ref{19e9,,Header} folding
algorithm, which preserves existing line breaks in the value, and wraps
each resulting line to the @code{max_line_length}.  If @code{cte_type} is
@code{7bit}, non-ascii binary data is CTE encoded using the @code{unknown-8bit}
charset.  Otherwise the original source header is used, with its existing
line breaks and any (RFC invalid) binary data it may contain.
@end deffn
@end deffn

@geindex compat32 (no módulo email.policy)
@anchor{library/email policy email policy compat32}@anchor{cb8}
@deffn {Dado} email.policy.compat32

An instance of @ref{10f3,,Compat32}, providing  backward compatibility with the
behavior of the email package in Python 3.2.

@cartouche
@quotation Nota 
The @ref{cb8,,compat32} policy should not be used as a policy for
@ref{27b,,EmailMessage} objects, and should only be used
to serialize messages that were created using the @ref{cb8,,compat32}
policy.
@end quotation
@end cartouche
@end deffn

@node email errors Classes de Exceção e Defeito,email headerregistry Custom Header Objects,email policy Policy Objects,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email errors doc}@anchor{37de}@anchor{library/email errors email-errors-exception-and-defect-classes}@anchor{37df}@anchor{library/email errors module-email errors}@anchor{3f}@anchor{library/email errors translation-repo}@anchor{37e0}
@subsubsection @code{email.errors}: Classes de Exceção e Defeito.


@geindex module; email.errors

`Código-fonte:' Lib/email/errors.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/errors.py}


__________________________________________________________________


A seguinte classe de exceção é definida no modulo @ref{3f,,email.errors}.

@geindex MessageError
@anchor{library/email errors email errors MessageError}@anchor{37e1}
@deffn {Exceção} email.errors.MessageError

Essa é a classe base para todas as exceções que o pacote @ref{3b,,email} pode levantar. Ela é derivada da classe padrão @ref{9e2,,Exception} e não define métodos adicionais.
@end deffn

@geindex MessageParseError
@anchor{library/email errors email errors MessageParseError}@anchor{37e2}
@deffn {Exceção} email.errors.MessageParseError

Essa é a classe base para exceções levantadas pela classe @ref{11dc,,Parser}. Ela é derivada do @ref{37e1,,MessageError}. Essa classe pode ser usada internamente pelo analisador sintático usado pelo @ref{42,,headerregistry}.
@end deffn

@geindex HeaderParseError
@anchor{library/email errors email errors HeaderParseError}@anchor{378c}
@deffn {Exceção} email.errors.HeaderParseError

Raised under some error conditions when parsing the 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} headers of a
message, this class is derived from @ref{37e2,,MessageParseError}.  The
@ref{378b,,set_boundary()} method will raise this
error if the content type is unknown when the method is called.
@ref{19e9,,Header} may raise this error for certain base64
decoding errors, and when an attempt is made to create a header that appears
to contain an embedded header (that is, there is what is supposed to be a
continuation line that has no leading whitespace and looks like a header).
@end deffn

@geindex BoundaryError
@anchor{library/email errors email errors BoundaryError}@anchor{37e3}
@deffn {Exceção} email.errors.BoundaryError

Descontinuado e não mais usado.
@end deffn

@geindex MultipartConversionError
@anchor{library/email errors email errors MultipartConversionError}@anchor{37e4}
@deffn {Exceção} email.errors.MultipartConversionError

Raised if the @ref{379d,,attach()} method is called
on an instance of a class derived from
@ref{37e5,,MIMENonMultipart} (e.g.
@ref{37e6,,MIMEImage}).
@ref{37e4,,MultipartConversionError} multiply
inherits from @ref{37e1,,MessageError} and the built-in @ref{2c3,,TypeError}.
@end deffn

@geindex HeaderWriteError
@anchor{library/email errors email errors HeaderWriteError}@anchor{37c6}
@deffn {Exceção} email.errors.HeaderWriteError

Raised when an error occurs when the @ref{40,,generator} outputs
headers.
@end deffn

@geindex MessageDefect
@anchor{library/email errors email errors MessageDefect}@anchor{37c8}
@deffn {Exceção} email.errors.MessageDefect

This is the base class for all defects found when parsing email messages.
It is derived from @ref{202,,ValueError}.
@end deffn

@geindex HeaderDefect
@anchor{library/email errors email errors HeaderDefect}@anchor{37e7}
@deffn {Exceção} email.errors.HeaderDefect

This is the base class for all defects found when parsing email headers.
It is derived from @ref{37c8,,MessageDefect}.
@end deffn

Here is the list of the defects that the @ref{15ac,,FeedParser}
can find while parsing messages.  Note that the defects are added to the message
where the problem was found, so for example, if a message nested inside a
@code{multipart/alternative} had a malformed header, that nested message
object would have a defect, but the containing messages would not.

All defect classes are subclassed from @ref{37c8,,email.errors.MessageDefect}.

@geindex NoBoundaryInMultipartDefect
@anchor{library/email errors email errors NoBoundaryInMultipartDefect}@anchor{37e8}
@deffn {Exceção} email.errors.NoBoundaryInMultipartDefect

A message claimed to be a multipart, but had no @code{boundary}
parameter.
@end deffn

@geindex StartBoundaryNotFoundDefect
@anchor{library/email errors email errors StartBoundaryNotFoundDefect}@anchor{37e9}
@deffn {Exceção} email.errors.StartBoundaryNotFoundDefect

The start boundary claimed in the @code{Content-Type} header was
never found.
@end deffn

@geindex CloseBoundaryNotFoundDefect
@anchor{library/email errors email errors CloseBoundaryNotFoundDefect}@anchor{37ea}
@deffn {Exceção} email.errors.CloseBoundaryNotFoundDefect

A start boundary was found, but no corresponding close boundary was ever
found.


Adicionado na versão 3.3.

@end deffn

@geindex FirstHeaderLineIsContinuationDefect
@anchor{library/email errors email errors FirstHeaderLineIsContinuationDefect}@anchor{37eb}
@deffn {Exceção} email.errors.FirstHeaderLineIsContinuationDefect

The message had a continuation line as its first header line.
@end deffn

@geindex MisplacedEnvelopeHeaderDefect
@anchor{library/email errors email errors MisplacedEnvelopeHeaderDefect}@anchor{37ec}
@deffn {Exceção} email.errors.MisplacedEnvelopeHeaderDefect

A “Unix From” header was found in the middle of a header block.
@end deffn

@geindex MissingHeaderBodySeparatorDefect
@anchor{library/email errors email errors MissingHeaderBodySeparatorDefect}@anchor{37ed}
@deffn {Exceção} email.errors.MissingHeaderBodySeparatorDefect

A line was found while parsing headers that had no leading white space but
contained no ‘:’.  Parsing continues assuming that the line represents the
first line of the body.


Adicionado na versão 3.3.

@end deffn

@geindex MalformedHeaderDefect
@anchor{library/email errors email errors MalformedHeaderDefect}@anchor{37ee}
@deffn {Exceção} email.errors.MalformedHeaderDefect

A header was found that was missing a colon, or was otherwise malformed.


Descontinuado desde a versão 3.3: This defect has not been used for several Python versions.

@end deffn

@geindex MultipartInvariantViolationDefect
@anchor{library/email errors email errors MultipartInvariantViolationDefect}@anchor{37b3}
@deffn {Exceção} email.errors.MultipartInvariantViolationDefect

A message claimed to be a @code{multipart}, but no subparts were found.
Note that when a message has this defect, its
@ref{3790,,is_multipart()} method may return @code{False}
even though its content type claims to be @code{multipart}.
@end deffn

@geindex InvalidBase64PaddingDefect
@anchor{library/email errors email errors InvalidBase64PaddingDefect}@anchor{37ef}
@deffn {Exceção} email.errors.InvalidBase64PaddingDefect

When decoding a block of base64 encoded bytes, the padding was not correct.
Enough padding is added to perform the decode, but the resulting decoded
bytes may be invalid.
@end deffn

@geindex InvalidBase64CharactersDefect
@anchor{library/email errors email errors InvalidBase64CharactersDefect}@anchor{37f0}
@deffn {Exceção} email.errors.InvalidBase64CharactersDefect

When decoding a block of base64 encoded bytes, characters outside the base64
alphabet were encountered.  The characters are ignored, but the resulting
decoded bytes may be invalid.
@end deffn

@geindex InvalidBase64LengthDefect
@anchor{library/email errors email errors InvalidBase64LengthDefect}@anchor{37f1}
@deffn {Exceção} email.errors.InvalidBase64LengthDefect

When decoding a block of base64 encoded bytes, the number of non-padding
base64 characters was invalid (1 more than a multiple of 4).  The encoded
block was kept as-is.
@end deffn

@geindex InvalidDateDefect
@anchor{library/email errors email errors InvalidDateDefect}@anchor{37f2}
@deffn {Exceção} email.errors.InvalidDateDefect

When decoding an invalid or unparsable date field.  The original value is
kept as-is.
@end deffn

@node email headerregistry Custom Header Objects,email contentmanager Gerenciando conteúdo MIME,email errors Classes de Exceção e Defeito,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email headerregistry doc}@anchor{37f3}@anchor{library/email headerregistry email-headerregistry-custom-header-objects}@anchor{37f4}@anchor{library/email headerregistry module-email headerregistry}@anchor{42}@anchor{library/email headerregistry translation-repo}@anchor{37f5}
@subsubsection @code{email.headerregistry}: Custom Header Objects


@geindex module; email.headerregistry

`Código-fonte:' Lib/email/headerregistry.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/headerregistry.py}


__________________________________________________________________



Adicionado na versão 3.6: @footnote{
Originally added in 3.3 as a @ref{107a,,provisional module}
}


Headers are represented by customized subclasses of @ref{44c,,str}.  The
particular class used to represent a given header is determined by the
@ref{37ce,,header_factory} of the @ref{4f,,policy} in
effect when the headers are created.  This section documents the particular
@code{header_factory} implemented by the email package for handling 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}
compliant email messages, which not only provides customized header objects for
various header types, but also provides an extension mechanism for applications
to add their own custom header types.

When using any of the policy objects derived from
@ref{10f6,,EmailPolicy}, all headers are produced by
@ref{37f6,,HeaderRegistry} and have @ref{3778,,BaseHeader} as their last base
class.  Each header class has an additional base class that is determined by
the type of the header.  For example, many headers have the class
@ref{37f7,,UnstructuredHeader} as their other base class.  The specialized second
class for a header is determined by the name of the header, using a lookup
table stored in the @ref{37f6,,HeaderRegistry}.  All of this is managed
transparently for the typical application program, but interfaces are provided
for modifying the default behavior for use by more complex applications.

The sections below first document the header base classes and their attributes,
followed by the API for modifying the behavior of @ref{37f6,,HeaderRegistry}, and
finally the support classes used to represent the data parsed from structured
headers.

@geindex BaseHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry BaseHeader}@anchor{3778}
@deffn {Classe} email.headerregistry.BaseHeader (name, value)

`name' and `value' are passed to @code{BaseHeader} from the
@ref{37ce,,header_factory} call.  The string value of
any header object is the `value' fully decoded to unicode.

This base class defines the following read-only properties:

@geindex name (atributo email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader name}@anchor{37f8}
@deffn {Atributo} name

The name of the header (the portion of the field before the ‘:’).  This
is exactly the value passed in the
@ref{37ce,,header_factory} call for `name'; that
is, case is preserved.
@end deffn

@geindex defects (atributo email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader defects}@anchor{37f9}
@deffn {Atributo} defects

A tuple of @ref{37e7,,HeaderDefect} instances reporting any
RFC compliance problems found during parsing.  The email package tries to
be complete about detecting compliance issues.  See the @ref{3f,,errors}
module for a discussion of the types of defects that may be reported.
@end deffn

@geindex max_count (atributo email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader max_count}@anchor{37d1}
@deffn {Atributo} max_count

The maximum number of headers of this type that can have the same
@code{name}.  A value of @code{None} means unlimited.  The @code{BaseHeader} value
for this attribute is @code{None}; it is expected that specialized header
classes will override this value as needed.
@end deffn

@code{BaseHeader} also provides the following method, which is called by the
email library code and should not in general be called by application
programs:

@geindex fold() (método email.headerregistry.BaseHeader)
@anchor{library/email headerregistry email headerregistry BaseHeader fold}@anchor{37fa}
@deffn {Método} fold (*, policy)

Return a string containing @ref{37c2,,linesep}
characters as required to correctly fold the header according to
`policy'.  A @ref{37ba,,cte_type} of @code{8bit} will be
treated as if it were @code{7bit}, since headers may not contain arbitrary
binary data.  If @ref{e24,,utf8} is @code{False},
non-ASCII data will be 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} encoded.
@end deffn

@code{BaseHeader} by itself cannot be used to create a header object.  It
defines a protocol that each specialized header cooperates with in order to
produce the header object.  Specifically, @code{BaseHeader} requires that
the specialized class provide a @ref{166,,classmethod()} named @code{parse}.  This
method is called as follows:

@example
parse(string, kwds)
@end example

@code{kwds} is a dictionary containing one pre-initialized key, @code{defects}.
@code{defects} is an empty list.  The parse method should append any detected
defects to this list.  On return, the @code{kwds} dictionary `must' contain
values for at least the keys @code{decoded} and @code{defects}.  @code{decoded}
should be the string value for the header (that is, the header value fully
decoded to unicode).  The parse method should assume that `string' may
contain content-transfer-encoded parts, but should correctly handle all valid
unicode characters as well so that it can parse un-encoded header values.

@code{BaseHeader}’s @code{__new__} then creates the header instance, and calls its
@code{init} method.  The specialized class only needs to provide an @code{init}
method if it wishes to set additional attributes beyond those provided by
@code{BaseHeader} itself.  Such an @code{init} method should look like this:

@example
def init(self, /, *args, **kw):
    self._myattr = kw.pop('myattr')
    super().init(*args, **kw)
@end example

That is, anything extra that the specialized class puts in to the @code{kwds}
dictionary should be removed and handled, and the remaining contents of
@code{kw} (and @code{args}) passed to the @code{BaseHeader} @code{init} method.
@end deffn

@geindex UnstructuredHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry UnstructuredHeader}@anchor{37f7}
@deffn {Classe} email.headerregistry.UnstructuredHeader

An “unstructured” header is the default type of header in 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.
Any header that does not have a specified syntax is treated as
unstructured.  The classic example of an unstructured header is the
@code{Subject} header.

In 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}, an unstructured header is a run of arbitrary text in the
ASCII character set.  
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, however, has an 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} compatible
mechanism for encoding non-ASCII text as ASCII characters within a header
value.  When a `value' containing encoded words is passed to the
constructor, the @code{UnstructuredHeader} parser converts such encoded words
into unicode, following the 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} rules for unstructured text.  The
parser uses heuristics to attempt to decode certain non-compliant encoded
words.  Defects are registered in such cases, as well as defects for issues
such as invalid characters within the encoded words or the non-encoded text.

This header type provides no additional attributes.
@end deffn

@geindex DateHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry DateHeader}@anchor{37fb}
@deffn {Classe} email.headerregistry.DateHeader

@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} specifies a very specific format for dates within email headers.
The @code{DateHeader} parser recognizes that date format, as well as
recognizing a number of variant forms that are sometimes found “in the
wild”.

This header type provides the following additional attributes:

@geindex datetime (atributo email.headerregistry.DateHeader)
@anchor{library/email headerregistry email headerregistry DateHeader datetime}@anchor{37fc}
@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{1cc,,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{37fc,,datetime} will be a
naive @ref{1cc,,datetime}.  If a specific timezone offset is
found (including @code{+0000}), then @ref{37fc,,datetime} will contain an aware
@code{datetime} that uses @ref{10fe,,datetime.timezone} to record the timezone
offset.
@end deffn

The @code{decoded} value of the header is determined by formatting the
@code{datetime} according to the 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} rules; that is, it is set to:

@example
email.utils.format_datetime(self.datetime)
@end example

When creating a @code{DateHeader}, `value' may be
@ref{1cc,,datetime} instance.  This means, for example, that
the following code is valid and does what one would expect:

@example
msg['Date'] = datetime(2011, 7, 15, 21)
@end example

Because this is a naive @code{datetime} it will be interpreted as a UTC
timestamp, and the resulting value will have a timezone of @code{-0000}.  Much
more useful is to use the @ref{2c4,,localtime()} function from the
@ref{50,,utils} module:

@example
msg['Date'] = utils.localtime()
@end example

This example sets the date header to the current time and date using
the current timezone offset.
@end deffn

@geindex AddressHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry AddressHeader}@anchor{37fd}
@deffn {Classe} email.headerregistry.AddressHeader

Address headers are one of the most complex structured header types.
The @code{AddressHeader} class provides a generic interface to any address
header.

This header type provides the following additional attributes:

@geindex groups (atributo email.headerregistry.AddressHeader)
@anchor{library/email headerregistry email headerregistry AddressHeader groups}@anchor{37fe}
@deffn {Atributo} groups

A tuple of @ref{37ff,,Group} objects encoding the
addresses and groups found in the header value.  Addresses that are
not part of a group are represented in this list as single-address
@code{Groups} whose @ref{3800,,display_name} is @code{None}.
@end deffn

@geindex addresses (atributo email.headerregistry.AddressHeader)
@anchor{library/email headerregistry email headerregistry AddressHeader addresses}@anchor{3801}
@deffn {Atributo} addresses

A tuple of @ref{3802,,Address} objects encoding all
of the individual addresses from the header value.  If the header value
contains any groups, the individual addresses from the group are included
in the list at the point where the group occurs in the value (that is,
the list of addresses is “flattened” into a one dimensional list).
@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{2363,,joining} the
@ref{44c,,str} value of the elements of the @code{groups} attribute with @code{',
'}.

A list of @ref{3802,,Address} and @ref{37ff,,Group} objects in any combination
may be used to set the value of an address header.  @code{Group} objects whose
@code{display_name} is @code{None} will be interpreted as single addresses, which
allows an address list to be copied with groups intact by using the list
obtained from the @code{groups} attribute of the source header.
@end deffn

@geindex SingleAddressHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry SingleAddressHeader}@anchor{3803}
@deffn {Classe} email.headerregistry.SingleAddressHeader

Uma subclasse de @ref{37fd,,AddressHeader} que adiciona um atributo adicional:

@geindex address (atributo email.headerregistry.SingleAddressHeader)
@anchor{library/email headerregistry email headerregistry SingleAddressHeader address}@anchor{3804}
@deffn {Atributo} address

The single address encoded by the header value.  If the header value
actually contains more than one address (which would be a violation of
the RFC under the default @ref{4f,,policy}), accessing this attribute
will result in a @ref{202,,ValueError}.
@end deffn
@end deffn

Many of the above classes also have a @code{Unique} variant (for example,
@code{UniqueUnstructuredHeader}).  The only difference is that in the @code{Unique}
variant, @ref{37d1,,max_count} is set to 1.

@geindex MIMEVersionHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader}@anchor{3805}
@deffn {Classe} email.headerregistry.MIMEVersionHeader

There is really only one valid value for the @code{MIME-Version}
header, and that is @code{1.0}.  For future proofing, this header class
supports other valid version numbers.  If a version number has a valid value
per 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, then the header object will have non-@code{None} values for
the following attributes:

@geindex version (atributo email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader version}@anchor{3806}
@deffn {Atributo} version

The version number as a string, with any whitespace and/or comments
removed.
@end deffn

@geindex major (atributo email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader major}@anchor{3807}
@deffn {Atributo} major

The major version number as an integer
@end deffn

@geindex minor (atributo email.headerregistry.MIMEVersionHeader)
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader minor}@anchor{3808}
@deffn {Atributo} minor

The minor version number as an integer
@end deffn
@end deffn

@geindex ParameterizedMIMEHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader}@anchor{3809}
@deffn {Classe} email.headerregistry.ParameterizedMIMEHeader

MIME headers all start with the prefix ‘Content-’.  Each specific header has
a certain value, described under the class for that header.  Some can
also take a list of supplemental parameters, which have a common format.
This class serves as a base for all the MIME headers that take parameters.

@geindex params (atributo email.headerregistry.ParameterizedMIMEHeader)
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader params}@anchor{3786}
@deffn {Atributo} params

A dictionary mapping parameter names to parameter values.
@end deffn
@end deffn

@geindex ContentTypeHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader}@anchor{380a}
@deffn {Classe} email.headerregistry.ContentTypeHeader

A @ref{3809,,ParameterizedMIMEHeader} class that handles the
@code{Content-Type} header.

@geindex content_type (atributo email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader content_type}@anchor{380b}
@deffn {Atributo} content_type

The content type string, in the form @code{maintype/subtype}.
@end deffn

@geindex maintype (atributo email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader maintype}@anchor{380c}
@deffn {Atributo} maintype
@end deffn

@geindex subtype (atributo email.headerregistry.ContentTypeHeader)
@anchor{library/email headerregistry email headerregistry ContentTypeHeader subtype}@anchor{380d}
@deffn {Atributo} subtype
@end deffn
@end deffn

@geindex ContentDispositionHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader}@anchor{380e}
@deffn {Classe} email.headerregistry.ContentDispositionHeader

Uma classe @ref{3809,,ParameterizedMIMEHeader} que lida com o cabeçalho @code{Content-Disposition}.

@geindex content_disposition (atributo email.headerregistry.ContentDispositionHeader)
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader content_disposition}@anchor{380f}
@deffn {Atributo} content_disposition

@code{inline} and @code{attachment} are the only valid values in common use.
@end deffn
@end deffn

@geindex ContentTransferEncodingHeader (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry ContentTransferEncodingHeader}@anchor{3810}
@deffn {Classe} email.headerregistry.ContentTransferEncodingHeader

Handles the @code{Content-Transfer-Encoding} header.

@geindex cte (atributo email.headerregistry.ContentTransferEncodingHeader)
@anchor{library/email headerregistry email headerregistry ContentTransferEncodingHeader cte}@anchor{3811}
@deffn {Atributo} cte

Valid values are @code{7bit}, @code{8bit}, @code{base64}, and
@code{quoted-printable}.  See 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} for more information.
@end deffn
@end deffn

@geindex HeaderRegistry (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry}@anchor{37f6}
@deffn {Classe} email.headerregistry.HeaderRegistry (base_class=BaseHeader, default_class=UnstructuredHeader, use_default_map=True)

This is the factory used by @ref{10f6,,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{14f4,,__bases__} list.

The default mappings are:

@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} has the following methods:

@geindex map_to_type() (método email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry map_to_type}@anchor{3812}
@deffn {Método} map_to_type (self, name, cls)

`name' is the name of the header to be mapped.  It will be converted to
lower case in the registry.  `cls' is the specialized class to be used,
along with `base_class', to create the class used to instantiate headers
that match `name'.
@end deffn

@geindex __getitem__() (método email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry __getitem__}@anchor{3813}
@deffn {Método} __getitem__ (name)

Construct and return a class to handle creating a `name' header.
@end deffn

@geindex __call__() (método email.headerregistry.HeaderRegistry)
@anchor{library/email headerregistry email headerregistry HeaderRegistry __call__}@anchor{3814}
@deffn {Método} __call__ (name, value)

Retrieves the specialized header associated with `name' from the
registry (using `default_class' if `name' does not appear in the
registry) and composes it with `base_class' to produce a class,
calls the constructed class’s constructor, passing it the same
argument list, and finally returns the class instance created thereby.
@end deffn
@end deffn

The following classes are the classes used to represent data parsed from
structured headers and can, in general, be used by an application program to
construct structured values to assign to specific headers.

@geindex Address (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry Address}@anchor{3802}
@deffn {Classe} email.headerregistry.Address (display_name='@w{'}, username='@w{'}, domain='@w{'}, addr_spec=None)

The class used to represent an email address.  The general form of an
address is:

@example
[display_name] <username@@domain>
@end example

ou:

@example
username@@domain
@end example

where each part must conform to specific syntax rules spelled out in
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.

As a convenience `addr_spec' can be specified instead of `username' and
`domain', in which case `username' and `domain' will be parsed from the
`addr_spec'.  An `addr_spec' must be a properly RFC quoted string; if it is
not @code{Address} will raise an error.  Unicode characters are allowed and
will be property encoded when serialized.  However, per the RFCs, unicode is
`not' allowed in the username portion of the address.

@geindex display_name (atributo email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address display_name}@anchor{3815}
@deffn {Atributo} display_name

The display name portion of the address, if any, with all quoting
removed.  If the address does not have a display name, this attribute
will be an empty string.
@end deffn

@geindex username (atributo email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address username}@anchor{3816}
@deffn {Atributo} username

The @code{username} portion of the address, with all quoting removed.
@end deffn

@geindex domain (atributo email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address domain}@anchor{3817}
@deffn {Atributo} domain

The @code{domain} portion of the address.
@end deffn

@geindex addr_spec (atributo email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address addr_spec}@anchor{3818}
@deffn {Atributo} addr_spec

The @code{username@@domain} portion of the address, correctly quoted
for use as a bare address (the second form shown above).  This
attribute is not mutable.
@end deffn

@geindex __str__() (método email.headerregistry.Address)
@anchor{library/email headerregistry email headerregistry Address __str__}@anchor{3819}
@deffn {Método} __str__ ()

The @code{str} value of the object is the address quoted according to
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} rules, but with no Content Transfer Encoding of any non-ASCII
characters.
@end deffn

To support SMTP (
@geindex RFC; RFC 5321
RFC 5321@footnote{https://datatracker.ietf.org/doc/html/rfc5321.html}), @code{Address} handles one special case: if
@code{username} and @code{domain} are both the empty string (or @code{None}), then
the string value of the @code{Address} is @code{<>}.
@end deffn

@geindex Group (classe em email.headerregistry)
@anchor{library/email headerregistry email headerregistry Group}@anchor{37ff}
@deffn {Classe} email.headerregistry.Group (display_name=None, addresses=None)

The class used to represent an address group.  The general form of an
address group is:

@example
display_name: [address-list];
@end example

As a convenience for processing lists of addresses that consist of a mixture
of groups and single addresses, a @code{Group} may also be used to represent
single addresses that are not part of a group by setting `display_name' to
@code{None} and providing a list of the single address as `addresses'.

@geindex display_name (atributo email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group display_name}@anchor{3800}
@deffn {Atributo} display_name

The @code{display_name} of the group.  If it is @code{None} and there is
exactly one @code{Address} in @code{addresses}, then the @code{Group} represents a
single address that is not in a group.
@end deffn

@geindex addresses (atributo email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group addresses}@anchor{381a}
@deffn {Atributo} addresses

A possibly empty tuple of @ref{3802,,Address} objects representing the
addresses in the group.
@end deffn

@geindex __str__() (método email.headerregistry.Group)
@anchor{library/email headerregistry email headerregistry Group __str__}@anchor{381b}
@deffn {Método} __str__ ()

The @code{str} value of a @code{Group} is formatted according to 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html},
but with no Content Transfer Encoding of any non-ASCII characters.  If
@code{display_name} is none and there is a single @code{Address} in the
@code{addresses} list, the @code{str} value will be the same as the @code{str} of
that single @code{Address}.
@end deffn
@end deffn

@node email contentmanager Gerenciando conteúdo MIME,email Exemplos,email headerregistry Custom Header Objects,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email contentmanager doc}@anchor{381c}@anchor{library/email contentmanager email-contentmanager-managing-mime-content}@anchor{381d}@anchor{library/email contentmanager module-email contentmanager}@anchor{3d}@anchor{library/email contentmanager translation-repo}@anchor{381e}
@subsubsection @code{email.contentmanager}: Gerenciando conteúdo MIME


@geindex module; email.contentmanager

`Código-fonte:' Lib/email/contentmanager.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/contentmanager.py}


__________________________________________________________________



Adicionado na versão 3.6: @footnote{
Originally added in 3.4 as a @ref{107a,,provisional module}
}


@geindex ContentManager (classe em email.contentmanager)
@anchor{library/email contentmanager email contentmanager ContentManager}@anchor{381f}
@deffn {Classe} email.contentmanager.ContentManager

Classe base para gerenciadores de conteúdo. Fornece os mecanismos de registro padrão para registrar conversores entre conteúdo MIME e outras representações, bem como os métodos de despacho @code{get_content} e @code{set_content}.

@geindex get_content() (método email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager get_content}@anchor{3797}
@deffn {Método} get_content (msg, *args, **kw)

Procura uma função manipuladora baseada no @code{mimetype} de `msg' (veja o próximo parágrafo), chama-a, passando por todos os argumentos, e retorna o resultado da chamada. A expectativa é que a função manipuladora extraia o payload de `msg' e retorne um objeto que codifique informações sobre os dados extraídos.

Para encontrar o manipulador, procura as seguintes chaves no registro, parando na primeira encontrada:


@itemize *

@item 
a string que representa o tipo MIME completo (@code{maintype/subtype})

@item 
the string representing the @code{maintype}

@item 
the empty string
@end itemize

If none of these keys produce a handler, raise a @ref{344,,KeyError} for the
full MIME type.
@end deffn

@geindex set_content() (método email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager set_content}@anchor{3798}
@deffn {Método} set_content (msg, obj, *args, **kw)

If the @code{maintype} is @code{multipart}, raise a @ref{2c3,,TypeError}; otherwise
look up a handler function based on the type of `obj' (see next
paragraph), call @ref{37a1,,clear_content()} on the
`msg', and call the handler function, passing through all arguments.  The
expectation is that the handler will transform and store `obj' into
`msg', possibly making other changes to `msg' as well, such as adding
various MIME headers to encode information needed to interpret the stored
data.

To find the handler, obtain the type of `obj' (@code{typ = type(obj)}), and
look for the following keys in the registry, stopping with the first one
found:


@itemize *

@item 
the type itself (@code{typ})

@item 
the type’s fully qualified name (@code{typ.__module__ + '.' +
typ.__qualname__}).

@item 
the type’s @ref{20b6,,qualname} (@code{typ.__qualname__})

@item 
the type’s @ref{14f3,,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{15c0,,MRO} (@ref{20bb,,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{344,,KeyError} for the fully
qualified name of the type.

Also add a @code{MIME-Version} header if one is not present (see
also @ref{f6d,,MIMEPart}).
@end deffn

@geindex add_get_handler() (método email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager add_get_handler}@anchor{3820}
@deffn {Método} add_get_handler (key, handler)

Record the function `handler' as the handler for `key'.  For the possible
values of `key', see @ref{3821,,get_content()}.
@end deffn

@geindex add_set_handler() (método email.contentmanager.ContentManager)
@anchor{library/email contentmanager email contentmanager ContentManager add_set_handler}@anchor{3822}
@deffn {Método} add_set_handler (typekey, handler)

Record `handler' as the function to call when an object of a type
matching `typekey' is passed to @ref{3823,,set_content()}.  For the possible
values of `typekey', see @ref{3823,,set_content()}.
@end deffn
@end deffn

@menu
* Content Manager Instances:: 

@end menu

@node Content Manager Instances,,,email contentmanager Gerenciando conteúdo MIME
@anchor{library/email contentmanager content-manager-instances}@anchor{3824}
@subsubsection Content Manager Instances


Currently the email package provides only one concrete content manager,
@ref{37cf,,raw_data_manager}, although more may be added in the future.
@ref{37cf,,raw_data_manager} is the
@ref{f6e,,content_manager} provided by
@ref{10f6,,EmailPolicy} and its derivatives.

@geindex raw_data_manager (no módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager raw_data_manager}@anchor{37cf}
@deffn {Dado} email.contentmanager.raw_data_manager

This content manager provides only a minimum interface beyond that provided
by @ref{27c,,Message} itself:  it deals only with text, raw
byte strings, and @ref{27c,,Message} objects.  Nevertheless, it
provides significant advantages compared to the base API: @code{get_content} on
a text part will return a unicode string without the application needing to
manually decode it, @code{set_content} provides a rich set of options for
controlling the headers added to a part and controlling the content transfer
encoding, and it enables the use of the various @code{add_} methods, thereby
simplifying the creation of multipart messages.

@geindex get_content() (no módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager get_content}@anchor{3821}
@deffn {Método} email.contentmanager.get_content (msg, errors='replace')

Return the payload of the part as either a string (for @code{text} parts), an
@ref{27b,,EmailMessage} object (for @code{message/rfc822}
parts), or a @code{bytes} object (for all other non-multipart types).  Raise
a @ref{344,,KeyError} if called on a @code{multipart}.  If the part is a
@code{text} part and `errors' is specified, use it as the error handler when
decoding the payload to unicode.  The default error handler is
@code{replace}.
@end deffn

@geindex set_content() (no módulo email.contentmanager)
@anchor{library/email contentmanager email contentmanager set_content}@anchor{3823}
@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)

Adicione headers e payload à `msg':

Add a @code{Content-Type} header with a @code{maintype/subtype}
value.


@itemize *

@item 
For @code{str}, set the MIME @code{maintype} to @code{text}, and set the
subtype to `subtype' if it is specified, or @code{plain} if it is not.

@item 
For @code{bytes}, use the specified `maintype' and `subtype', or
raise a @ref{2c3,,TypeError} if they are not specified.

@item 
For @ref{27b,,EmailMessage} objects, set the maintype
to @code{message}, and set the subtype to `subtype' if it is
specified or @code{rfc822} if it is not.  If `subtype' is
@code{partial}, raise an error (@code{bytes} objects must be used to
construct @code{message/partial} parts).
@end itemize

If `charset' is provided (which is valid only for @code{str}), encode the
string to bytes using the specified character set.  The default is
@code{utf-8}.  If the specified `charset' is a known alias for a standard
MIME charset name, use the standard charset instead.

If `cte' is set, encode the payload using the specified content transfer
encoding, and set the @code{Content-Transfer-Encoding} header to
that value.  Possible values for `cte' are @code{quoted-printable},
@code{base64}, @code{7bit}, @code{8bit}, and @code{binary}.  If the input cannot be
encoded in the specified encoding (for example, specifying a `cte' of
@code{7bit} for an input that contains non-ASCII values), raise a
@ref{202,,ValueError}.


@itemize *

@item 
For @code{str} objects, if `cte' is not set use heuristics to
determine the most compact encoding.  Prior to encoding,
@ref{1298,,str.splitlines()} is used to normalize all line boundaries,
ensuring that each line of the payload is terminated by the
current policy’s @ref{37c2,,linesep} property
(even if the original string did not end with one).

@item 
For @code{bytes} objects, `cte' is taken to be base64 if not set,
and the aforementioned newline translation is not performed.

@item 
For @ref{27b,,EmailMessage}, per 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}, raise
an error if a `cte' of @code{quoted-printable} or @code{base64} is
requested for `subtype' @code{rfc822}, and for any `cte' other than
@code{7bit} for `subtype' @code{external-body}.  For
@code{message/rfc822}, use @code{8bit} if `cte' is not specified.  For
all other values of `subtype', use @code{7bit}.
@end itemize

@cartouche
@quotation Nota 
A `cte' of @code{binary} does not actually work correctly yet.
The @code{EmailMessage} object as modified by @code{set_content} is
correct, but @ref{120f,,BytesGenerator} does not
serialize it correctly.
@end quotation
@end cartouche

If `disposition' is set, use it as the value of the
@code{Content-Disposition} header.  If not specified, and
`filename' is specified, add the header with the value @code{attachment}.
If `disposition' is not specified and `filename' is also not specified,
do not add the header.  The only valid values for `disposition' are
@code{attachment} and @code{inline}.

If `filename' is specified, use it as the value of the @code{filename}
parameter of the @code{Content-Disposition} header.

If `cid' is specified, add a @code{Content-ID} header with
`cid' as its value.

If `params' is specified, iterate its @code{items} method and use the
resulting @code{(key, value)} pairs to set additional parameters on the
@code{Content-Type} header.

If `headers' is specified and is a list of strings of the form
@code{headername: headervalue} or a list of @code{header} objects
(distinguished from strings by having a @code{name} attribute), add the
headers to `msg'.
@end deffn
@end deffn

@node email Exemplos,email message Message Representing an email message using the compat32 API,email contentmanager Gerenciando conteúdo MIME,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email examples doc}@anchor{3825}@anchor{library/email examples email-examples}@anchor{f6f}@anchor{library/email examples id1}@anchor{3826}@anchor{library/email examples translation-repo}@anchor{3827}
@subsubsection @code{email}: Exemplos


Aqui estão alguns exemplos de como usar o pacote @ref{3b,,email} para ler, escrever e enviar mensagens de e-mail simples, bem como mensagens MIME mais complexas.

Primeiro, vamos ver como criar e enviar uma mensagem de texto simples (tanto o conteúdo do texto quanto os endereços podem conter caracteres Unicode):

@example
# Importa smtplib para a função de envio
import smtplib

# Importa os módulos de email que precisamos
from email.message import EmailMessage

# Abre o arquivo de texto simples cujo nome está em arquivo texto para leitura.
with open(textfile) as fp:
    # Create a text/plain message
    msg = EmailMessage()
    msg.set_content(fp.read())

# me == o endereço de e-mail do remetente
# you == o endereço de e-mail do destinatário
msg['Subject'] = f'The contents of @{textfile@}'
msg['From'] = me
msg['To'] = you

# Envia a mensagem via nosso próprio servidor SMTP.
s = smtplib.SMTP('localhost')
s.send_message(msg)
s.quit()
@end example

A análise dos cabeçalhos 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} pode ser feita facilmente usando as classes do módulo @ref{4e,,parser}:

@example
# Importa os módulos de email que precisamos
#from email.parser import BytesParser
from email.parser import Parser
from email.policy import default

# Se os cabeçalhos de e-mal estão em um arquivo, descomente essas duas linhas:
# with open(messagefile, 'rb') as fp:
#     headers = BytesParser(policy=default).parse(fp)

#  Ou para análise de cabeçalhos em uma string (essa é uma operação comum), 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')

#  Agora os itens de cabeçalho podem ser acessadas como um dicionário:
print('To: @{@}'.format(headers['to']))
print('From: @{@}'.format(headers['from']))
print('Subject: @{@}'.format(headers['subject']))

# Você também pode acessar as partes dos endereços:
print('Recipient username: @{@}'.format(headers['to'].addresses[0].username))
print('Sender name: @{@}'.format(headers['from'].addresses[0].display_name))
@end example

Aqui está um exemplo de como enviar uma mensagem MIME contendo várias fotos de família que podem estar em um diretório:

@example
# Importa smtplib para a função de envio.
import smtplib

# Aqui estão os módulos de pacotes de e-mail que precisamos.
from email.message import EmailMessage

# Cria a contêiner da mensagem de e-mail.
msg = EmailMessage()
msg['Subject'] = 'Our family reunion'
# me == o endereço de e-mail do remetente
# family = a lista dos endereços de e-mail de todos os destinatários
msg['From'] = me
msg['To'] = ', '.join(family)
msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

# Abre os arquivos no modo binário. Você também pode omitir
# o subtipo se você quiser que MIMEImage adivinhe.
for file in pngfiles:
    with open(file, 'rb') as fp:
        img_data = fp.read()
    msg.add_attachment(img_data, maintype='image',
                                 subtype='png')

# Envia o e-mail por meio de nosso próprio servidor SMTP.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

Aqui está um exemplo de como enviar todo o conteúdo de um diretório como uma mensagem de e-mail: @footnote{
Obrigado a Matthew Dixon Cowles pela inspiração original e pelos exemplos.
}

@example
#!/usr/bin/env python3

"""Envia o conteúdo de um diretório como uma mensagem MIME."""

import os
import smtplib
# Para adivinhar o tipo MIME com base na extensão do nome do arquivo
import mimetypes

from argparse import ArgumentParser

from email.message import EmailMessage
from email.policy import SMTP


def main():
    parser = ArgumentParser(description="""\
Envia o conteúdo de um diretório como uma mensagem MIME.
A menos que a opção -o seja informada, o e-mail será enviado por
meio de encaminhamento para o seu servidor SMTP local, que então
realiza o processo de entrega normal. Sua máquina local deve estar
executando um servidor SMTP.
""")
    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 = '.'
    # Cria a mensagem
    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
        # Adivinhe o tipo de conteúdo com base na extensão do arquivo.
        # A codificação será ignorada, embora devamos verificar coisas
        # simples como arquivos compactados ou compactados com gzip.
        ctype, encoding = mimetypes.guess_file_type(path)
        if ctype is None or encoding is not None:
            # Não foi possível fazer nenhuma suposição, ou o arquivo está
            # codificado (compactado), então use um tipo genérico de
            # conjunto de bits.
            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)
    # Agora envia ou armazena a mensagem
    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

Aqui está um exemplo de como desempacotar uma mensagem MIME, como a acima, para um diretório de arquivos:

@example
#!/usr/bin/env python3

"""Desempacota uma mensagem MIME em um diretório de arquivos."""

import os
import email
import mimetypes

from email.policy import default

from argparse import ArgumentParser


def main():
    parser = ArgumentParser(description="""\
Desempacota uma mensagem MIME em um diretório de arquivos.
""")
    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/* são apenas contêineres
        if part.get_content_maintype() == 'multipart':
            continue
        # Os aplicativos realmente devem higienizar o nome de arquivo
        # fornecido para que uma mensagem de e-mail não possa ser
        # usada para substituir arquivos importantes
        filename = part.get_filename()
        if not filename:
            ext = mimetypes.guess_extension(part.get_content_type())
            if not ext:
                # Usa uma extensão genérica de conjunto de bits
                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

Aqui está um exemplo de como criar uma mensagem HTML com uma versão alternativa em texto simples. Para tornar as coisas um pouco mais interessantes, incluímos uma imagem relacionada na parte html e salvamos uma cópia do que vamos enviar para o disco, assim como enviamos.

@example
#!/usr/bin/env python3

import smtplib

from email.message import EmailMessage
from email.headerregistry import Address
from email.utils import make_msgid

# Cria a mensagem texto base.
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é
""")

# Adiciona a versão HTML. Isso converte a mensagem em um contêiner
# multiparte/alternativo, com a mensagem de texto original como a primeira
# parte e a nova mensagem HTML como a segunda parte.
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')
# observe que precisamos remover o <> do msgid para usar no html.

# Agora adiciona a imagem relacionada à parte html.
with open("roasted-asparagus.jpg", 'rb') as img:
    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
                                     cid=asparagus_cid)

# Agora adiciona a imagem relacionada à parte html.
with open('outgoing.msg', 'wb') as f:
    f.write(bytes(msg))

# Envia a mensagem via servidor SMTP local.
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

Se nos fosse enviada a mensagem do último exemplo, aqui está uma maneira de processá-la:

@example
import os
import sys
import tempfile
import mimetypes
import webbrowser

# Importa os módulos de e-mail que precisaremos
from email import policy
from email.parser import BytesParser


def magic_html_parser(html_text, partfiles):
    """Retorna HTML com segurança e link para partfiles.

    Reescreve os atributos href="cid:...." para apontar aos arquivos em partfiles.
    Embora não seja trivial, isso deve ser possível usando html.parser.
    """
    raise NotImplementedError("Add the magic needed")


# Em um programa real, você pegaria o nome de arquivo a partir dos argumentos.
with open('outgoing.msg', 'rb') as fp:
    msg = BytesParser(policy=policy.default).parse(fp)

# Agora os itens de cabeçalho podem ser acessados como um dicionário e
# qualquer caractere não-ASCII será convertido para unicode:
print('To:', msg['to'])
print('From:', msg['from'])
print('Subject:', msg['subject'])

# Se quisermos imprimir uma prévia do conteúdo da mensagem, podemos
# extrair o conteúdo menos formatado e imprimir as três primeiras linhas.
# É claro que, se a mensagem não tiver uma parte de texto simples,
# imprimir as três primeiras linhas de HTML provavelmente será inútil,
# mas este é apenas um exemplo conceitual.
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()

# Podemos extrair a alternativa richest para exibi-la:
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())
            # remove novamente o <> para ir da forma email de cid para html.
            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)

# É claro que há muitas mensagens de e-mail que podem quebrar
# esse simples programa, mas ele lidará com as mais comuns.
@end example

Até o prompt, a saída do comando acima é:

@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

API legada

@node email message Message Representing an email message using the compat32 API,email mimeemail mime Criando e-mail e objetos MIME do zero,email Exemplos,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email compat32-message doc}@anchor{3828}@anchor{library/email compat32-message compat32-message}@anchor{3769}@anchor{library/email compat32-message email-message-message-representing-an-email-message-using-the-compat32-api}@anchor{3829}@anchor{library/email compat32-message translation-repo}@anchor{382a}
@subsubsection @code{email.message.Message}: Representing an email message using the @code{compat32} API


The @ref{27c,,Message} class is very similar to the
@ref{27b,,EmailMessage} class, without the methods added by that
class, and with the default behavior of certain other methods being slightly
different.  We also document here some methods that, while supported by the
@ref{27b,,EmailMessage} class, are not recommended unless you are
dealing with legacy code.

The philosophy and structure of the two classes is otherwise the same.

This document describes the behavior under the default (for @ref{27c,,Message})
policy @ref{10f3,,Compat32}.  If you are going to use another policy,
you should be using the @ref{27b,,EmailMessage} class instead.

An email message consists of `headers' and a `payload'.  Headers must be
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} style names and values, where the field name and value are
separated by a colon.  The colon is not part of either the field name or the
field value.  The payload may be a simple text message, or a binary object, or
a structured sequence of sub-messages each with their own set of headers and
their own payload.  The latter type of payload is indicated by the message
having a MIME type such as @code{multipart/*} or
@code{message/rfc822}.

The conceptual model provided by a @ref{27c,,Message} object is that of an
ordered dictionary of headers with additional methods for accessing both
specialized information from the headers, for accessing the payload, for
generating a serialized version of the message, and for recursively walking
over the object tree.  Note that duplicate headers are supported but special
methods must be used to access them.

The @ref{27c,,Message} pseudo-dictionary is indexed by the header names, which
must be ASCII values.  The values of the dictionary are strings that are
supposed to contain only ASCII characters; there is some special handling for
non-ASCII input, but it doesn’t always produce the correct results.  Headers
are stored and returned in case-preserving form, but field names are matched
case-insensitively.  There may also be a single envelope header, also known as
the `Unix-From' header or the @code{From_} header.  The `payload' is either a
string or bytes, in the case of simple message objects, or a list of
@ref{27c,,Message} objects, for MIME container documents (e.g.
@code{multipart/*} and @code{message/rfc822}).

Here are the methods of the @ref{27c,,Message} class:

@geindex Message (classe em email.message)
@anchor{library/email compat32-message email message Message}@anchor{27c}
@deffn {Classe} email.message.Message (policy=compat32)

If `policy' is specified (it must be an instance of a @ref{4f,,policy}
class) use the rules it specifies to update and serialize the representation
of the message.  If `policy' is not set, use the @ref{10f3,,compat32} policy, which maintains backward compatibility with
the Python 3.2 version of the email package.  For more information see the
@ref{4f,,policy} documentation.


Alterado na versão 3.3: The `policy' keyword argument was added.


@geindex as_string() (método email.message.Message)
@anchor{library/email compat32-message email message Message as_string}@anchor{f69}
@deffn {Método} as_string (unixfrom=False, maxheaderlen=0, 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 reasons,
`maxheaderlen' defaults to @code{0}, so if you want a different value you
must override it explicitly (the value specified for `max_line_length' in
the policy will be ignored by this method).  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 @code{Generator}.

Flattening the message may trigger changes to the @ref{27c,,Message} if
defaults need to be filled in to complete the transformation to a string
(for example, MIME boundaries may be generated or modified).

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{120e,,Generator} instance and use its
@ref{37bc,,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

If the message object contains binary data that is not encoded according
to RFC standards, the non-compliant data will be replaced by unicode
“unknown character” code points.  (See also @ref{f6a,,as_bytes()} and
@ref{120f,,BytesGenerator}.)


Alterado na versão 3.4: the `policy' keyword argument was added.

@end deffn

@geindex __str__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __str__}@anchor{382b}
@deffn {Método} __str__ ()

Equivalent to @ref{f69,,as_string()}.  Allows @code{str(msg)} to produce a
string containing the formatted message.
@end deffn

@geindex as_bytes() (método email.message.Message)
@anchor{library/email compat32-message email message Message as_bytes}@anchor{f6a}
@deffn {Método} as_bytes (unixfrom=False, policy=None)

Return the entire message flattened as a bytes object.  When optional
`unixfrom' is true, the envelope header is included in the returned
string.  `unixfrom' defaults to @code{False}.  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
@code{BytesGenerator}.

Flattening the message may trigger changes to the @ref{27c,,Message} if
defaults need to be filled in to complete the transformation to a string
(for example, MIME boundaries may be generated or modified).

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{120f,,BytesGenerator} instance and use its
@ref{37b8,,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


Adicionado na versão 3.4.

@end deffn

@geindex __bytes__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __bytes__}@anchor{f6b}
@deffn {Método} __bytes__ ()

Equivalent to @ref{f6a,,as_bytes()}.  Allows @code{bytes(msg)} to produce a
bytes object containing the formatted message.


Adicionado na versão 3.4.

@end deffn

@geindex is_multipart() (método email.message.Message)
@anchor{library/email compat32-message email message Message is_multipart}@anchor{3790}
@deffn {Método} is_multipart ()

Return @code{True} if the message’s payload is a list of
sub-@ref{27c,,Message} objects, otherwise return @code{False}.  When
@ref{3790,,is_multipart()} returns @code{False}, the payload should be a string
object (which might be a CTE encoded binary payload).  (Note that
@ref{3790,,is_multipart()} returning @code{True} does not necessarily mean that
“msg.get_content_maintype() == ‘multipart’” will return the @code{True}.
For example, @code{is_multipart} will return @code{True} when the
@ref{27c,,Message} is of type @code{message/rfc822}.)
@end deffn

@geindex set_unixfrom() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_unixfrom}@anchor{382c}
@deffn {Método} set_unixfrom (unixfrom)

Set the message’s envelope header to `unixfrom', which should be a string.
@end deffn

@geindex get_unixfrom() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_unixfrom}@anchor{382d}
@deffn {Método} get_unixfrom ()

Return the message’s envelope header.  Defaults to @code{None} if the
envelope header was never set.
@end deffn

@geindex attach() (método email.message.Message)
@anchor{library/email compat32-message email message Message attach}@anchor{379d}
@deffn {Método} attach (payload)

Add the given `payload' to the current payload, which must be @code{None} or
a list of @ref{27c,,Message} objects before the call. After the call, the
payload will always be a list of @ref{27c,,Message} objects.  If you want to
set the payload to a scalar object (e.g. a string), use
@ref{382e,,set_payload()} instead.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by @ref{19e8,,set_content()} and the
related @code{make} and @code{add} methods.
@end deffn

@geindex get_payload() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_payload}@anchor{120d}
@deffn {Método} get_payload (i=None, decode=False)

Return the current payload, which will be a list of
@ref{27c,,Message} objects when @ref{3790,,is_multipart()} is @code{True}, or a
string when @ref{3790,,is_multipart()} is @code{False}.  If the payload is a list
and you mutate the list object, you modify the message’s payload in place.

With optional argument `i', @ref{120d,,get_payload()} will return the `i'-th
element of the payload, counting from zero, if @ref{3790,,is_multipart()} is
@code{True}.  An @ref{157e,,IndexError} will be raised if `i' is less than 0 or
greater than or equal to the number of items in the payload.  If the
payload is a string (i.e.  @ref{3790,,is_multipart()} is @code{False}) and `i' is
given, a @ref{2c3,,TypeError} is raised.

Optional `decode' is a flag indicating whether the payload should be
decoded or not, according to the @code{Content-Transfer-Encoding}
header. When @code{True} and the message is not a multipart, the payload will
be decoded if this header’s value is @code{quoted-printable} or @code{base64}.
If some other encoding is used, or @code{Content-Transfer-Encoding}
header is missing, the payload is
returned as-is (undecoded).  In all cases the returned value is binary
data.  If the message is a multipart and the `decode' flag is @code{True},
then @code{None} is returned.  If the payload is base64 and it was not
perfectly formed (missing padding, characters outside the base64
alphabet), then an appropriate defect will be added to the message’s
defect property (@ref{37ef,,InvalidBase64PaddingDefect} or
@ref{37f0,,InvalidBase64CharactersDefect}, respectively).

When `decode' is @code{False} (the default) the body is returned as a string
without decoding the @code{Content-Transfer-Encoding}.  However,
for a @code{Content-Transfer-Encoding} of 8bit, an attempt is made
to decode the original bytes using the @code{charset} specified by the
@code{Content-Type} header, using the @code{replace} error handler.
If no @code{charset} is specified, or if the @code{charset} given is not
recognized by the email package, the body is decoded using the default
ASCII charset.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by @ref{3796,,get_content()} and
@ref{3795,,iter_parts()}.
@end deffn

@geindex set_payload() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_payload}@anchor{382e}
@deffn {Método} set_payload (payload, charset=None)

Set the entire message object’s payload to `payload'.  It is the client’s
responsibility to ensure the payload invariants.  Optional `charset' sets
the message’s default character set; see @ref{382f,,set_charset()} for details.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by @ref{19e8,,set_content()}.
@end deffn

@geindex set_charset() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_charset}@anchor{382f}
@deffn {Método} set_charset (charset)

Set the character set of the payload to `charset', which can either be a
@ref{e26,,Charset} instance (see @ref{3c,,email.charset}), a
string naming a character set, or @code{None}.  If it is a string, it will
be converted to a @ref{e26,,Charset} instance.  If `charset'
is @code{None}, the @code{charset} parameter will be removed from the
@code{Content-Type} header (the message will not be otherwise
modified).  Anything else will generate a @ref{2c3,,TypeError}.

If there is no existing @code{MIME-Version} header one will be
added.  If there is no existing @code{Content-Type} header, one
will be added with a value of @code{text/plain}.  Whether the
@code{Content-Type} header already exists or not, its @code{charset}
parameter will be set to `charset.output_charset'.   If
`charset.input_charset' and `charset.output_charset' differ, the payload
will be re-encoded to the `output_charset'.  If there is no existing
@code{Content-Transfer-Encoding} header, then the payload will be
transfer-encoded, if needed, using the specified
@ref{e26,,Charset}, and a header with the appropriate value
will be added.  If a @code{Content-Transfer-Encoding} header
already exists, the payload is assumed to already be correctly encoded
using that @code{Content-Transfer-Encoding} and is not modified.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by the `charset' parameter of the
@ref{19e8,,email.message.EmailMessage.set_content()} method.
@end deffn

@geindex get_charset() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_charset}@anchor{3830}
@deffn {Método} get_charset ()

Return the @ref{e26,,Charset} instance associated with the
message’s payload.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class it always returns
@code{None}.
@end deffn

The following methods implement a mapping-like interface for accessing the
message’s 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} headers.  Note that there are some semantic differences
between these methods and a normal mapping (i.e. dictionary) interface.  For
example, in a dictionary there are no duplicate keys, but here there may be
duplicate message headers.  Also, in dictionaries there is no guaranteed
order to the keys returned by @ref{3831,,keys()}, but in a @ref{27c,,Message} object,
headers are always returned in the order they appeared in the original
message, or were added to the message later.  Any header deleted and then
re-added are always appended to the end of the header list.

These semantic differences are intentional and are biased toward maximal
convenience.

Note that in all cases, any envelope header present in the message is not
included in the mapping interface.

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{19e9,,Header} objects with
a charset of @code{unknown-8bit}.

@geindex __len__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __len__}@anchor{3832}
@deffn {Método} __len__ ()

Return the total number of headers, including duplicates.
@end deffn

@geindex __contains__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __contains__}@anchor{187c}
@deffn {Método} __contains__ (name)

Return @code{True} if the message object has a field named `name'. Matching is
done case-insensitively and `name' should not include the trailing colon.
Used for the @code{in} operator, e.g.:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __getitem__}@anchor{3833}
@deffn {Método} __getitem__ (name)

Return the value of the named header field.  `name' should not include the
colon field separator.  If the header is missing, @code{None} is returned; a
@ref{344,,KeyError} is never raised.

Note that if the named field appears more than once in the message’s
headers, exactly which of those field values will be returned is
undefined.  Use the @ref{3834,,get_all()} method to get the values of all the
extant named headers.
@end deffn

@geindex __setitem__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __setitem__}@anchor{3835}
@deffn {Método} __setitem__ (name, val)

Add a header to the message with field name `name' and value `val'.  The
field is appended to the end of the message’s existing fields.

Note that this does `not' overwrite or delete any existing header with the same
name.  If you want to ensure that the new header is the only one present in the
message with field name `name', delete the field first, e.g.:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example
@end deffn

@geindex __delitem__() (método email.message.Message)
@anchor{library/email compat32-message email message Message __delitem__}@anchor{3836}
@deffn {Método} __delitem__ (name)

Delete all occurrences of the field with name `name' from the message’s
headers.  No exception is raised if the named field isn’t present in the
headers.
@end deffn

@geindex keys() (método email.message.Message)
@anchor{library/email compat32-message email message Message keys}@anchor{3831}
@deffn {Método} keys ()

Return a list of all the message’s header field names.
@end deffn

@geindex values() (método email.message.Message)
@anchor{library/email compat32-message email message Message values}@anchor{3837}
@deffn {Método} values ()

Return a list of all the message’s field values.
@end deffn

@geindex items() (método email.message.Message)
@anchor{library/email compat32-message email message Message items}@anchor{3838}
@deffn {Método} items ()

Return a list of 2-tuples containing all the message’s field headers and
values.
@end deffn

@geindex get() (método email.message.Message)
@anchor{library/email compat32-message email message Message get}@anchor{3839}
@deffn {Método} get (name, failobj=None)

Return the value of the named header field.  This is identical to
@ref{283,,__getitem__()} except that optional `failobj' is returned if the
named header is missing (defaults to @code{None}).
@end deffn

Here are some additional useful methods:

@geindex get_all() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_all}@anchor{3834}
@deffn {Método} get_all (name, failobj=None)

Return a list of all the values for the field named `name'. If there are
no such named headers in the message, `failobj' is returned (defaults to
@code{None}).
@end deffn

@geindex add_header() (método email.message.Message)
@anchor{library/email compat32-message email message Message add_header}@anchor{383a}
@deffn {Método} add_header (_name, _value, **_params)

Extended header setting.  This method is similar to @ref{3835,,__setitem__()}
except that additional header parameters can be provided as keyword
arguments.  `_name' is the header field to add and `_value' is the
`primary' value for the header.

For each item in the keyword argument dictionary `_params', the key is
taken as the parameter name, with underscores converted to dashes (since
dashes are illegal in Python identifiers).  Normally, the parameter will
be added as @code{key="value"} unless the value is @code{None}, in which case
only the key will be added.  If the value contains non-ASCII characters,
it can be specified as a three tuple in the format
@code{(CHARSET, LANGUAGE, VALUE)}, where @code{CHARSET} is a string naming the
charset to be used to encode the value, @code{LANGUAGE} can usually be set
to @code{None} or the empty string (see 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} for other possibilities),
and @code{VALUE} is the string value containing non-ASCII code points.  If
a three tuple is not passed and the value contains non-ASCII characters,
it is automatically encoded in 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} format using a @code{CHARSET}
of @code{utf-8} and a @code{LANGUAGE} of @code{None}.

Aqui está um exemplo:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

This will add a header that looks like

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

Um exemplo com caracteres não-ASCII:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example

Que produz

@example
Content-Disposition: attachment; filename*="iso-8859-1'@w{'}Fu%DFballer.ppt"
@end example
@end deffn

@geindex replace_header() (método email.message.Message)
@anchor{library/email compat32-message email message Message replace_header}@anchor{383b}
@deffn {Método} replace_header (_name, _value)

Replace a header.  Replace the first header found in the message that
matches `_name', retaining header order and field name case.  If no
matching header was found, a @ref{344,,KeyError} is raised.
@end deffn

@geindex get_content_type() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_content_type}@anchor{383c}
@deffn {Método} get_content_type ()

Return the message’s content type.  The returned string is coerced to
lower case of the form @code{maintype/subtype}.  If there was no
@code{Content-Type} header in the message the default type as given
by @ref{383d,,get_default_type()} will be returned.  Since according to
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, messages always have a default type, @ref{383c,,get_content_type()}
will always return a value.

@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} defines a message’s default type to be @code{text/plain}
unless it appears inside a @code{multipart/digest} container, in
which case it would be @code{message/rfc822}.  If the
@code{Content-Type} header has an invalid type specification,
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} mandates that the default type be @code{text/plain}.
@end deffn

@geindex get_content_maintype() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_content_maintype}@anchor{383e}
@deffn {Método} get_content_maintype ()

Return the message’s main content type.  This is the @code{maintype}
part of the string returned by @ref{383c,,get_content_type()}.
@end deffn

@geindex get_content_subtype() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_content_subtype}@anchor{383f}
@deffn {Método} get_content_subtype ()

Return the message’s sub-content type.  This is the @code{subtype}
part of the string returned by @ref{383c,,get_content_type()}.
@end deffn

@geindex get_default_type() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_default_type}@anchor{383d}
@deffn {Método} get_default_type ()

Return the default content type.  Most messages have a default content
type of @code{text/plain}, except for messages that are subparts of
@code{multipart/digest} containers.  Such subparts have a default
content type of @code{message/rfc822}.
@end deffn

@geindex set_default_type() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_default_type}@anchor{3840}
@deffn {Método} set_default_type (ctype)

Set the default content type.  `ctype' should either be
@code{text/plain} or @code{message/rfc822}, although this is not
enforced.  The default content type is not stored in the
@code{Content-Type} header.
@end deffn

@geindex get_params() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_params}@anchor{3841}
@deffn {Método} get_params (failobj=None, header='content-type', unquote=True)

Return the message’s @code{Content-Type} parameters, as a list.
The elements of the returned list are 2-tuples of key/value pairs, as
split on the @code{'='} sign.  The left hand side of the @code{'='} is the key,
while the right hand side is the value.  If there is no @code{'='} sign in
the parameter the value is the empty string, otherwise the value is as
described in @ref{3842,,get_param()} and is unquoted if optional `unquote' is
@code{True} (the default).

Optional `failobj' is the object to return if there is no
@code{Content-Type} header.  Optional `header' is the header to
search instead of @code{Content-Type}.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by the `params' property of the individual header objects
returned by the header access methods.
@end deffn

@geindex get_param() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_param}@anchor{3842}
@deffn {Método} get_param (param, failobj=None, header='content-type', unquote=True)

Return the value of the @code{Content-Type} header’s parameter
`param' as a string.  If the message has no @code{Content-Type}
header or if there is no such parameter, then `failobj' is returned
(defaults to @code{None}).

Optional `header' if given, specifies the message header to use instead of
@code{Content-Type}.

Parameter keys are always compared case insensitively.  The return value
can either be a string, or a 3-tuple if the parameter was 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}
encoded.  When it’s a 3-tuple, the elements of the value are of the form
@code{(CHARSET, LANGUAGE, VALUE)}.  Note that both @code{CHARSET} and
@code{LANGUAGE} can be @code{None}, in which case you should consider @code{VALUE}
to be encoded in the @code{us-ascii} charset.  You can usually ignore
@code{LANGUAGE}.

If your application doesn’t care whether the parameter was encoded as in
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, you can collapse the parameter value by calling
@ref{3843,,email.utils.collapse_rfc2231_value()}, passing in the return value
from @ref{3842,,get_param()}.  This will return a suitably decoded Unicode
string when the value is a tuple, or the original string unquoted if it
isn’t.  For example:

@example
rawparam = msg.get_param('foo')
param = email.utils.collapse_rfc2231_value(rawparam)
@end example

In any case, the parameter value (either the returned string, or the
@code{VALUE} item in the 3-tuple) is always unquoted, unless `unquote' is set
to @code{False}.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by the `params' property of the individual header objects
returned by the header access methods.
@end deffn

@geindex set_param() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_param}@anchor{f6c}
@deffn {Método} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

Set a parameter in the @code{Content-Type} header.  If the
parameter already exists in the header, its value will be replaced with
`value'.  If the @code{Content-Type} header as not yet been defined
for this message, it will be set to @code{text/plain} and the new
parameter value will be appended as per 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}.

Optional `header' specifies an alternative header to
@code{Content-Type}, and all parameters will be quoted as necessary
unless optional `requote' is @code{False} (the default is @code{True}).

If optional `charset' is specified, the parameter will be encoded
according to 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. Optional `language' specifies the RFC 2231
language, defaulting to the empty string.  Both `charset' and `language'
should be strings.

If `replace' is @code{False} (the default) the header is moved to the
end of the list of headers.  If `replace' is @code{True}, the header
will be updated in place.


Alterado na versão 3.4: Palavra-chave @code{replace} foi adicionada.

@end deffn

@geindex del_param() (método email.message.Message)
@anchor{library/email compat32-message email message Message del_param}@anchor{3844}
@deffn {Método} del_param (param, header='content-type', requote=True)

Remove the given parameter completely from the @code{Content-Type}
header.  The header will be re-written in place without the parameter or
its value.  All values will be quoted as necessary unless `requote' is
@code{False} (the default is @code{True}).  Optional `header' specifies an
alternative to @code{Content-Type}.
@end deffn

@geindex set_type() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_type}@anchor{3845}
@deffn {Método} set_type (type, header='Content-Type', requote=True)

Set the main type and subtype for the @code{Content-Type}
header. `type' must be a string in the form @code{maintype/subtype},
otherwise a @ref{202,,ValueError} is raised.

This method replaces the @code{Content-Type} header, keeping all
the parameters in place.  If `requote' is @code{False}, this leaves the
existing header’s quoting as is, otherwise the parameters will be quoted
(the default).

An alternative header can be specified in the `header' argument. When the
@code{Content-Type} header is set a @code{MIME-Version}
header is also added.

This is a legacy method.  On the
@ref{27b,,EmailMessage} class its functionality is
replaced by the @code{make_} and @code{add_} methods.
@end deffn

@geindex get_filename() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_filename}@anchor{3846}
@deffn {Método} get_filename (failobj=None)

Return the value of the @code{filename} parameter of the
@code{Content-Disposition} header of the message.  If the header
does not have a @code{filename} parameter, this method falls back to looking
for the @code{name} parameter on the @code{Content-Type} header.  If
neither is found, or the header is missing, then `failobj' is returned.
The returned string will always be unquoted as per
@ref{3789,,email.utils.unquote()}.
@end deffn

@geindex get_boundary() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_boundary}@anchor{3847}
@deffn {Método} get_boundary (failobj=None)

Return the value of the @code{boundary} parameter of the
@code{Content-Type} header of the message, or `failobj' if either
the header is missing, or has no @code{boundary} parameter.  The returned
string will always be unquoted as per @ref{3789,,email.utils.unquote()}.
@end deffn

@geindex set_boundary() (método email.message.Message)
@anchor{library/email compat32-message email message Message set_boundary}@anchor{3848}
@deffn {Método} set_boundary (boundary)

Set the @code{boundary} parameter of the @code{Content-Type} header to
`boundary'.  @ref{3848,,set_boundary()} will always quote `boundary' if
necessary.  A @ref{378c,,HeaderParseError} is raised if the
message object has no @code{Content-Type} header.

Note that using this method is subtly different than deleting the old
@code{Content-Type} header and adding a new one with the new
boundary via @ref{383a,,add_header()}, because @ref{3848,,set_boundary()} preserves
the order of the @code{Content-Type} header in the list of
headers. However, it does `not' preserve any continuation lines which may
have been present in the original @code{Content-Type} header.
@end deffn

@geindex get_content_charset() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_content_charset}@anchor{3849}
@deffn {Método} get_content_charset (failobj=None)

Return the @code{charset} parameter of the @code{Content-Type} header,
coerced to lower case.  If there is no @code{Content-Type} header, or if
that header has no @code{charset} parameter, `failobj' is returned.

Note that this method differs from @ref{3830,,get_charset()} which returns the
@ref{e26,,Charset} instance for the default encoding of the message body.
@end deffn

@geindex get_charsets() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_charsets}@anchor{384a}
@deffn {Método} get_charsets (failobj=None)

Return a list containing the character set names in the message.  If the
message is a @code{multipart}, then the list will contain one element
for each subpart in the payload, otherwise, it will be a list of length 1.

Each item in the list will be a string which is the value of the
@code{charset} parameter in the @code{Content-Type} header for the
represented subpart.  However, if the subpart has no
@code{Content-Type} header, no @code{charset} parameter, or is not of
the @code{text} main MIME type, then that item in the returned list
will be `failobj'.
@end deffn

@geindex get_content_disposition() (método email.message.Message)
@anchor{library/email compat32-message email message Message get_content_disposition}@anchor{e23}
@deffn {Método} get_content_disposition ()

Return the lowercased value (without parameters) of the message’s
@code{Content-Disposition} header if it has one, or @code{None}.  The
possible values for this method are `inline', `attachment' or @code{None}
if the message follows 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html}.


Adicionado na versão 3.5.

@end deffn

@geindex walk() (método email.message.Message)
@anchor{library/email compat32-message email message Message walk}@anchor{384b}
@deffn {Método} walk ()

The @ref{384b,,walk()} method is an all-purpose generator which can be used to
iterate over all the parts and subparts of a message object tree, in
depth-first traversal order.  You will typically use @ref{384b,,walk()} as the
iterator in a @code{for} loop; each iteration returns the next subpart.

Here’s an example that prints the MIME type of every part of a multipart
message structure:

@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} iterates over the subparts of any part where
@ref{3790,,is_multipart()} returns @code{True}, even though
@code{msg.get_content_maintype() == 'multipart'} may return @code{False}.  We
can see this in our example by making use of the @code{_structure} debug
helper function:

@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

Here the @code{message} parts are not @code{multiparts}, but they do contain
subparts. @code{is_multipart()} returns @code{True} and @code{walk} descends
into the subparts.
@end deffn

@ref{27c,,Message} objects can also optionally contain two instance attributes,
which can be used when generating the plain text of a MIME message.

@geindex preamble (atributo email.message.Message)
@anchor{library/email compat32-message email message Message preamble}@anchor{384c}
@deffn {Atributo} preamble

The format of a MIME document allows for some text between the blank line
following the headers, and the first multipart boundary string. Normally,
this text is never visible in a MIME-aware mail reader because it falls
outside the standard MIME armor.  However, when viewing the raw text of
the message, or when viewing the message in a non-MIME aware reader, this
text can become visible.

The `preamble' attribute contains this leading extra-armor text for MIME
documents.  When the @ref{11dc,,Parser} discovers some text
after the headers but before the first boundary string, it assigns this
text to the message’s `preamble' attribute.  When the
@ref{120e,,Generator} is writing out the plain text
representation of a MIME message, and it finds the
message has a `preamble' attribute, it will write this text in the area
between the headers and the first boundary.  See @ref{4e,,email.parser} and
@ref{40,,email.generator} for details.

Note that if the message object has no preamble, the `preamble' attribute
will be @code{None}.
@end deffn

@geindex epilogue (atributo email.message.Message)
@anchor{library/email compat32-message email message Message epilogue}@anchor{384d}
@deffn {Atributo} epilogue

The `epilogue' attribute acts the same way as the `preamble' attribute,
except that it contains text that appears between the last boundary and
the end of the message.

You do not need to set the epilogue to the empty string in order for the
@ref{120e,,Generator} to print a newline at the end of the
file.
@end deffn

@geindex defects (atributo email.message.Message)
@anchor{library/email compat32-message email message Message defects}@anchor{384e}
@deffn {Atributo} defects

The `defects' attribute contains a list of all the problems found when
parsing this message.  See @ref{3f,,email.errors} for a detailed description
of the possible parsing defects.
@end deffn
@end deffn

@node email mimeemail mime Criando e-mail e objetos MIME do zero,email header Internationalized headers,email message Message Representing an email message using the compat32 API,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email mime doc}@anchor{384f}@anchor{library/email mime email-mime-creating-email-and-mime-objects-from-scratch}@anchor{3850}@anchor{library/email mime module-email mime}@anchor{45}@anchor{library/email mime translation-repo}@anchor{3851}
@subsubsection @code{email.mime}@code{email.mime}: Criando e-mail e objetos MIME do zero


@geindex module; email.mime

`Código-fonte:' Lib/email/mime/@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/mime/}


__________________________________________________________________


Este módulo faz parte da API de e-mail legada (@code{Compat32}). Sua funcionalidade é parcialmente substituída por @ref{3d,,contentmanager} na nova API, mas em certos aplicativos essas classes ainda podem ser úteis, mesmo em código não legado.

Normalmente, você obtém uma estrutura de objeto de mensagem passando um arquivo ou algum texto para um analisador sintático, que analisa o texto e retorna o objeto de mensagem raiz. No entanto, você também pode criar uma estrutura de mensagem completa do zero, ou até objetos individuais de @ref{27c,,Message} manualmente. De fato, você também pode pegar uma estrutura existente e adicionar novos objetos @ref{27c,,Message}, movê-los, etc. Isso cria uma interface muito conveniente para fatiar e cortar dados de mensagens MIME.

Você pode criar uma nova estrutura de objeto criando instâncias de @ref{27c,,Message}, adicionando anexos e todos os cabeçalhos apropriados manualmente. Porém, para mensagens MIME, o pacote @ref{3b,,email} fornece algumas subclasses convenientes para facilitar as coisas.

Arquivo estão as classes:

@geindex module; email.mime.base

@geindex MIMEBase (classe em email.mime.base)
@anchor{library/email mime module-email mime base}@anchor{48}@anchor{library/email mime email mime base MIMEBase}@anchor{3852}
@deffn {Classe} email.mime.base.MIMEBase (_maintype, _subtype, *, policy=compat32, **_params)

Módulo: @ref{48,,email.mime.base}

Esta é a classe base para todas as subclasses específicas de MIME de @ref{27c,,Message}. Normalmente você não criará instâncias especificamente de @ref{3852,,MIMEBase}, embora possa. A @ref{3852,,MIMEBase} é fornecida principalmente como uma classe base conveniente para subclasses mais específicas para MIME.

`_maintype' é o tipo principal de @code{Content-Type} (ex., @code{text} ou @code{image}) e `_subtype' é o tipo principal de @code{Content-Type} (ex., @code{plain} ou @code{gif}). `_params' é um dicionário de parâmetros chave/valor e é passado diretamente para @ref{383a,,Message.add_header}.

Se `policy' for especificado, (o padrão é a política @ref{10f3,,compat32}) será passado para @ref{27c,,Message}.

A classe @ref{3852,,MIMEBase} sempre adiciona um cabeçalho @code{Content-Type} (com base em `_maintype', `_subtype' e `_params') e um cabeçalho @code{MIME-Version} (sempre definido como @code{1.0}).


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.nonmultipart

@geindex MIMENonMultipart (classe em email.mime.nonmultipart)
@anchor{library/email mime module-email mime nonmultipart}@anchor{4c}@anchor{library/email mime email mime nonmultipart MIMENonMultipart}@anchor{37e5}
@deffn {Classe} email.mime.nonmultipart.MIMENonMultipart

Módulo: @ref{4c,,email.mime.nonmultipart}

Uma subclasse de @ref{3852,,MIMEBase}, esta é uma classe base intermediária para mensagens MIME que não são @code{multipart}. O principal objetivo desta classe é impedir o uso do método @ref{379d,,attach()}, que só faz sentido para mensagens @code{multipart}. Se @ref{379d,,attach()} for chamado, uma exceção @ref{37e4,,MultipartConversionError} será levantada.
@end deffn

@geindex module; email.mime.multipart

@geindex MIMEMultipart (classe em email.mime.multipart)
@anchor{library/email mime module-email mime multipart}@anchor{4b}@anchor{library/email mime email mime multipart MIMEMultipart}@anchor{3853}
@deffn {Classe} email.mime.multipart.MIMEMultipart (_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)

Módulo: @ref{4b,,email.mime.multipart}

Uma subclasse de @ref{3852,,MIMEBase}, esta é uma classe base intermediária para mensagens MIME que são @code{multipart}. O `_subtype' opcional é padronizado como @code{mixed}, mas pode ser usado para especificar o subtipo da mensagem. Um cabeçalho @code{Content-Type} de @code{multipart/_subtype} será adicionado ao objeto da mensagem. Um cabeçalho @code{MIME-Version} também será adicionado.

O `boundary' opcional é a string de limites de várias partes. Quando @code{None} (o padrão), o limite é calculado quando necessário (por exemplo, quando a mensagem é serializada).

`_subparts' é uma sequência de subpartes iniciais para a carga. Deve ser possível converter essa sequência em uma lista. Você sempre pode anexar novas subpartes à mensagem usando o método @ref{379d,,Message.attach}.

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.

Parâmetros adicionais para o cabeçalho @code{Content-Type} são retirados dos argumentos nomeados ou passados para o argumento `_params', que é um dicionário.


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.application

@geindex MIMEApplication (classe em email.mime.application)
@anchor{library/email mime module-email mime application}@anchor{46}@anchor{library/email mime email mime application MIMEApplication}@anchor{3854}
@deffn {Classe} email.mime.application.MIMEApplication (_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{46,,email.mime.application}

Uma subclasse de @ref{37e5,,MIMENonMultipart}, a classe @ref{3854,,MIMEApplication} é usada para representar objetos de mensagem MIME do tipo principal @code{application}. `_data' contém os bytes para os dados brutos da aplicação. O `_subtype' opcional especifica o subtipo MIME e o padrão é @code{octet-stream}.

O `_encoder' opcional é um chamável (isto é, função) que executará a codificação real dos dados para transporte. Esse chamável requer um argumento, que é a instância @ref{3854,,MIMEApplication}. Ele deve usar @ref{120d,,get_payload()} e @ref{382e,,set_payload()} para alterar a carga útil para o formulário codificado. Também deve adicionar @code{Content-Transfer-Encoding} ou outros cabeçalhos ao objeto de mensagem, conforme necessário. A codificação padrão é base64. Veja o módulo @ref{3e,,email.encoders} para obter uma lista dos codificadores embutidos.

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.

`_params' são passados diretamente para o construtor da classe base.


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.audio

@geindex MIMEAudio (classe em email.mime.audio)
@anchor{library/email mime module-email mime audio}@anchor{47}@anchor{library/email mime email mime audio MIMEAudio}@anchor{3855}
@deffn {Classe} email.mime.audio.MIMEAudio (_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{47,,email.mime.audio}

Uma subclasse de @ref{37e5,,MIMENonMultipart}, a classe @ref{3855,,MIMEAudio} é usada para criar objetos de mensagem MIME do tipo principal @code{audio}. `_audiodata' contém os bytes para os dados brutos de áudio. Se esses dados puderem ser decodificados como au, wav, aiff ou aifc, então o subtipo será automaticamente incluído no cabeçalho @code{Content-Type}. Caso contrário, você pode especificar explicitamente o subtipo de áudio por meio do argumento `_subtype'. Se o tipo menor não pôde ser adivinhado e `_subtype' não foi fornecido, então um exceção @ref{2c3,,TypeError} é levantada.

O `_encoder' opcional é um chamável (ou seja, função) que executará a codificação real dos dados de áudio para transporte. Esse chamável requer um argumento, que é a instância @ref{3855,,MIMEAudio}. Ele deve usar @ref{120d,,get_payload()} e @ref{382e,,set_payload()} para alterar a carga útil para a forma codificada. Também deve adicionar @code{Content-Transfer-Encoding} ou outros cabeçalhos ao objeto de mensagem, conforme necessário. A codificação padrão é base64. Veja o módulo @ref{3e,,email.encoders} para obter uma lista dos codificadores embutidos.

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.

`_params' são passados diretamente para o construtor da classe base.


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.image

@geindex MIMEImage (classe em email.mime.image)
@anchor{library/email mime module-email mime image}@anchor{49}@anchor{library/email mime email mime image MIMEImage}@anchor{37e6}
@deffn {Classe} email.mime.image.MIMEImage (_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

Módulo: @ref{49,,email.mime.image}

Uma subclasse de @ref{37e5,,MIMENonMultipart}, a classe @ref{37e6,,MIMEImage} é usada para criar objetos de mensagem MIME do tipo principal @code{image}. `_imagedata' contém os bytes para os dados de imagem bruta. Se esse tipo de dados puder ser detectado (jpeg, png, gif, tiff, rgb, pbm, pgm, ppm, rast, xbm, bmp, webp e exr tentados), então o subtipo será automaticamente incluído no cabeçalho @code{Content-Type}. Caso contrário, você pode especificar explicitamente o subtipo de imagem por meio do argumento `_subtype'. Se o tipo secundário não puder ser adivinhado e `_subtype' não for fornecido, então @ref{2c3,,TypeError} será levantada.

O `_encoder' opcional é um chamável (ou seja, função) que executará a codificação real dos dados de imagem para transporte. Esse chamável requer um argumento, que é a instância @ref{37e6,,MIMEImage}. Ele deve usar @ref{120d,,get_payload()} e @ref{382e,,set_payload()} para alterar a carga útil para a forma codificada. Também deve adicionar @code{Content-Transfer-Encoding} ou outros cabeçalhos ao objeto de mensagem, conforme necessário. A codificação padrão é base64. Veja o módulo @ref{3e,,email.encoders} para obter uma lista dos codificadores embutidos.

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.

`_params' são passados diretamente para o construtor @ref{3852,,MIMEBase}.


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.message

@geindex MIMEMessage (classe em email.mime.message)
@anchor{library/email mime module-email mime message}@anchor{4a}@anchor{library/email mime email mime message MIMEMessage}@anchor{3856}
@deffn {Classe} email.mime.message.MIMEMessage (_msg, _subtype='rfc822', *, policy=compat32)

Módulo: @ref{4a,,email.mime.message}

Uma subclasse de @ref{37e5,,MIMENonMultipart}, a classe @ref{3856,,MIMEMessage} é usada para criar objetos MIME do tipo principal @code{message}. `_msg' é usado como carga útil e deve ser uma instância da classe @ref{27c,,Message} (ou uma subclasse dela), caso contrário, uma @ref{2c3,,TypeError} é levantada.

O opcional `_subtype' define o subtipo da mensagem; o padrão é @code{rfc822}.

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.


Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@geindex module; email.mime.text

@geindex MIMEText (classe em email.mime.text)
@anchor{library/email mime module-email mime text}@anchor{4d}@anchor{library/email mime email mime text MIMEText}@anchor{e25}
@deffn {Classe} email.mime.text.MIMEText (_text, _subtype='plain', _charset=None, *, policy=compat32)

Módulo: @ref{4d,,email.mime.text}

Uma subclasse de @ref{37e5,,MIMENonMultipart}, a classe @ref{e25,,MIMEText} é usada para criar objetos MIME do tipo principal @code{text}. `_text' é a string para a carga útil. `_subtype' é o tipo secundário e o padrão é @code{plain}. `_charset' é o conjunto de caracteres do texto e é passado como um argumento para o construtor @ref{37e5,,MIMENonMultipart}; o padrão é @code{us-ascii} se a string contiver apenas pontos de código @code{ascii} e @code{utf-8} caso contrário. O parâmetro `_charset' aceita uma string ou uma instância @ref{e26,,Charset}.

A menos que o argumento `_charset' seja explicitamente definido como @code{None}, o objeto MIMEText criado terá um cabeçalho @code{Content-Type} com um parâmetro @code{charset} e um cabeçalho @code{Content-Transfer-Encoding}. Isso significa que uma chamada @code{set_payload} subsequente não resultará em uma carga útil codificada, mesmo se um charset for passado no comando @code{set_payload}. Você pode “redefinir” esse comportamento excluindo o cabeçalho @code{Content-Transfer-Encoding}, após o qual uma chamada @code{set_payload} codificará automaticamente a nova carga útil (e adicionará um novo cabeçalho @code{Content-Transfer-Encoding}).

O argumento opcional `policy' tem como padrão @ref{10f3,,compat32}.


Alterado na versão 3.5: `_charset' também aceita instâncias de @ref{e26,,Charset}.



Alterado na versão 3.6: Adicionado o parâmetro somente-nomeado `policy'.

@end deffn

@node email header Internationalized headers,email charset Representando conjuntos de caracteres,email mimeemail mime Criando e-mail e objetos MIME do zero,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email header doc}@anchor{3857}@anchor{library/email header email-header-internationalized-headers}@anchor{3858}@anchor{library/email header module-email header}@anchor{41}@anchor{library/email header translation-repo}@anchor{3859}
@subsubsection @code{email.header}: Internationalized headers


@geindex module; email.header

`Código-fonte:' Lib/email/header.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/header.py}


__________________________________________________________________


This module is part of the legacy (@code{Compat32}) email API.  In the current API
encoding and decoding of headers is handled transparently by the
dictionary-like API of the @ref{27b,,EmailMessage} class.  In
addition to uses in legacy code, this module can be useful in applications that
need to completely control the character sets used when encoding headers.

O texto restante nesta seção é a documentação original do módulo.

@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} is the base standard that describes the format of email messages.
It derives from the older 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} standard which came into widespread use at
a time when most email was composed of ASCII characters only.  
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} is a
specification written assuming email contains only 7-bit ASCII characters.

Of course, as email has been deployed worldwide, it has become
internationalized, such that language specific character sets can now be used in
email messages.  The base standard still requires email messages to be
transferred using only 7-bit ASCII characters, so a slew of RFCs have been
written describing how to encode email containing non-ASCII characters into
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}-compliant format. These RFCs include 
@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}, and 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. The @ref{3b,,email} package supports these standards
in its @ref{41,,email.header} and @ref{3c,,email.charset} modules.

If you want to include non-ASCII characters in your email headers, say in the
@code{Subject} or @code{To} fields, you should use the
@ref{19e9,,Header} class and assign the field in the @ref{27c,,Message}
object to an instance of @ref{19e9,,Header} instead of using a string for the header
value.  Import the @ref{19e9,,Header} class from the @ref{41,,email.header} module.
For example:

@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

Notice here how we wanted the @code{Subject} field to contain a non-ASCII
character?  We did this by creating a @ref{19e9,,Header} instance and passing in
the character set that the byte string was encoded in.  When the subsequent
@ref{27c,,Message} instance was flattened, the @code{Subject}
field was properly 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} encoded.  MIME-aware mail readers would show this
header using the embedded ISO-8859-1 character.

Here is the @ref{19e9,,Header} class description:

@geindex Header (classe em email.header)
@anchor{library/email header email header Header}@anchor{19e9}
@deffn {Classe} email.header.Header (s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict')

Create a MIME-compliant header that can contain strings in different character
sets.

Optional `s' is the initial header value.  If @code{None} (the default), the
initial header value is not set.  You can later append to the header with
@ref{385a,,append()} method calls.  `s' may be an instance of @ref{1c2,,bytes} or
@ref{44c,,str}, but see the @ref{385a,,append()} documentation for semantics.

Optional `charset' serves two purposes: it has the same meaning as the `charset'
argument to the @ref{385a,,append()} method.  It also sets the default character set
for all subsequent @ref{385a,,append()} calls that omit the `charset' argument.  If
`charset' is not provided in the constructor (the default), the @code{us-ascii}
character set is used both as `s'’s initial charset and as the default for
subsequent @ref{385a,,append()} calls.

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.

Optional `continuation_ws' must be 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}-compliant folding
whitespace, and is usually either a space or a hard tab character.  This
character will be prepended to continuation lines.  `continuation_ws'
defaults to a single space character.

Optional `errors' is passed straight through to the @ref{385a,,append()} method.

@geindex append() (método email.header.Header)
@anchor{library/email header email header Header append}@anchor{385a}
@deffn {Método} append (s, charset=None, errors='strict')

Append the string `s' to the MIME header.

Optional `charset', if given, should be a @ref{e26,,Charset}
instance (see @ref{3c,,email.charset}) or the name of a character set, which
will be converted to a @ref{e26,,Charset} instance.  A value
of @code{None} (the default) means that the `charset' given in the constructor
is used.

`s' may be an instance of @ref{1c2,,bytes} or @ref{44c,,str}.  If it is an
instance of @ref{1c2,,bytes}, then `charset' is the encoding of that byte
string, and a @ref{12e6,,UnicodeError} will be raised if the string cannot be
decoded with that character set.

If `s' is an instance of @ref{44c,,str}, then `charset' is a hint specifying
the character set of the characters in the string.

In either case, when producing an 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}-compliant header using
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} rules, the string will be encoded using the output codec of
the charset.  If the string cannot be encoded using the output codec, a
UnicodeError will be raised.

Optional `errors' is passed as the errors argument to the decode call
if `s' is a byte string.
@end deffn

@geindex encode() (método email.header.Header)
@anchor{library/email header email header Header encode}@anchor{385b}
@deffn {Método} encode (splitchars=';, \t', maxlinelen=None, linesep='\n')

Encode a message header into an RFC-compliant format, possibly wrapping
long lines and encapsulating non-ASCII parts in base64 or quoted-printable
encodings.

Optional `splitchars' is a string containing characters which should be
given extra weight by the splitting algorithm during normal header
wrapping.  This is in very rough support of 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}'s ‘higher level
syntactic breaks’:  split points preceded by a splitchar are preferred
during line splitting, with the characters preferred in the order in
which they appear in the string.  Space and tab may be included in the
string to indicate whether preference should be given to one over the
other as a split point when other split chars do not appear in the line
being split.  Splitchars does not affect 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} encoded lines.

`maxlinelen', if given, overrides the instance’s value for the maximum
line length.

`linesep' specifies the characters used to separate the lines of the
folded header.  It defaults to the most useful value for Python
application code (@code{\n}), but @code{\r\n} can be specified in order
to produce headers with RFC-compliant line separators.


Alterado na versão 3.2: Adicionado o argumento `linesep'.

@end deffn

The @ref{19e9,,Header} class also provides a number of methods to support
standard operators and built-in functions.

@geindex __str__() (método email.header.Header)
@anchor{library/email header email header Header __str__}@anchor{385c}
@deffn {Método} __str__ ()

Returns an approximation of the @ref{19e9,,Header} as a string, using an
unlimited line length.  All pieces are converted to unicode using the
specified encoding and joined together appropriately.  Any pieces with a
charset of @code{'unknown-8bit'} are decoded as ASCII using the @code{'replace'}
error handler.


Alterado na versão 3.2: Added handling for the @code{'unknown-8bit'} charset.

@end deffn

@geindex __eq__() (método email.header.Header)
@anchor{library/email header email header Header __eq__}@anchor{385d}
@deffn {Método} __eq__ (other)

This method allows you to compare two @ref{19e9,,Header} instances for
equality.
@end deffn

@geindex __ne__() (método email.header.Header)
@anchor{library/email header email header Header __ne__}@anchor{385e}
@deffn {Método} __ne__ (other)

This method allows you to compare two @ref{19e9,,Header} instances for
inequality.
@end deffn
@end deffn

The @ref{41,,email.header} module also provides the following convenient functions.

@geindex decode_header() (no módulo email.header)
@anchor{library/email header email header decode_header}@anchor{10f7}
@deffn {Função} email.header.decode_header (header)

Decode a message header value without converting the character set. The header
value is in `header'.

For historical reasons, this function may return either:


@enumerate 

@item 
A list of pairs containing each of the decoded parts of the header,
@code{(decoded_bytes, charset)}, where `decoded_bytes' is always an instance of
@ref{1c2,,bytes}, and `charset' is either:

@quotation


@itemize -

@item 
A lower case string containing the name of the character set specified.

@item 
@code{None} for non-encoded parts of the header.
@end itemize
@end quotation

@item 
A list of length 1 containing a pair @code{(string, None)}, where
`string' is always an instance of @ref{44c,,str}.
@end enumerate

An @ref{378c,,email.errors.HeaderParseError} may be raised when certain decoding
errors occur (e.g. a base64 decoding exception).

Here are examples:

@example
>>> from email.header import decode_header
>>> decode_header('=?iso-8859-1?q?p=F6stal?=')
[(b'p\xf6stal', 'iso-8859-1')]
>>> decode_header('unencoded_string')
[('unencoded_string', None)]
>>> decode_header('bar =?utf-8?B?ZsOzbw==?=')
[(b'bar ', None), (b'f\xc3\xb3o', 'utf-8')]
@end example

@cartouche
@quotation Nota 
This function exists for backwards compatibility only. For
new code, we recommend using @ref{37f6,,email.headerregistry.HeaderRegistry}.
@end quotation
@end cartouche
@end deffn

@geindex make_header() (no módulo email.header)
@anchor{library/email header email header make_header}@anchor{10f8}
@deffn {Função} email.header.make_header (decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ')

Create a @ref{19e9,,Header} instance from a sequence of pairs as returned by
@ref{10f7,,decode_header()}.

@ref{10f7,,decode_header()} takes a header value string and returns a sequence of
pairs of the format @code{(decoded_string, charset)} where `charset' is the name of
the character set.

This function takes one of those sequence of pairs and returns a
@ref{19e9,,Header} instance.  Optional `maxlinelen', `header_name', and
`continuation_ws' are as in the @ref{19e9,,Header} constructor.

@cartouche
@quotation Nota 
This function exists for backwards compatibility only, and is
not recommended for use in new code.
@end quotation
@end cartouche
@end deffn

@node email charset Representando conjuntos de caracteres,email encoders Codificadores,email header Internationalized headers,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email charset doc}@anchor{385f}@anchor{library/email charset email-charset-representing-character-sets}@anchor{3860}@anchor{library/email charset module-email charset}@anchor{3c}@anchor{library/email charset translation-repo}@anchor{3861}
@subsubsection @code{email.charset}: Representando conjuntos de caracteres


@geindex module; email.charset

`Código-fonte:' Lib/email/charset.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/charset.py}


__________________________________________________________________


Este módulo faz parte da API de e-mail legada (@code{Compat32}). Na nova API, apenas a tabela de apelidos é usada.

O texto restante nesta seção é a documentação original do módulo.

Este módulo fornece uma classe @ref{e26,,Charset} para representar conjuntos de caracteres e conversões de conjuntos de caracteres em mensagens de e-mail, bem como um registro de conjuntos de caracteres e vários métodos práticos para manipular esse registro. Instâncias de @ref{e26,,Charset} são usadas em vários outros módulos do pacote @ref{3b,,email}.

Importa esta classe do módulo @ref{3c,,email.charset}.

@geindex Charset (classe em email.charset)
@anchor{library/email charset email charset Charset}@anchor{e26}
@deffn {Classe} email.charset.Charset (input_charset=DEFAULT_CHARSET)

Mapeia conjuntos de caracteres para suas propriedades de e-mail.

Esta classe fornece informações sobre os requisitos impostos ao e-mail para um conjunto de caracteres específico. Também fornece rotinas práticas para conversão entre conjuntos de caracteres, considerando a disponibilidade dos codecs aplicáveis. Dado um conjunto de caracteres, ela fará o possível para fornecer informações sobre como usá-lo em uma mensagem de e-mail de forma compatível com RFC.

Certos conjuntos de caracteres devem ser codificados com quoted-printable ou base64 quando usados em cabeçalhos ou corpos de e-mail. Certos conjuntos de caracteres devem ser convertidos diretamente e não são permitidos em e-mails.

O `input_charset' opcional é descrito abaixo; ele é sempre convertido para letras minúsculas. Após ser normalizado por apelido, ele também é usado como uma consulta no registro de conjuntos de caracteres para descobrir a codificação do cabeçalho, a codificação do corpo e o codec de conversão de saída a serem usados para o conjunto de caracteres. Por exemplo, se `input_charset' for @code{iso-8859-1}, os cabeçalhos e corpos serão codificados usando quoted-printable e nenhum codec de conversão de saída será necessário. Se `input_charset' for @code{euc-jp}, os cabeçalhos serão codificados em base64, os corpos não serão codificados, mas o texto de saída será convertido do conjunto de caracteres @code{euc-jp} para o conjunto de caracteres @code{iso-2022-jp}.

Instâncias @ref{e26,,Charset} têm os seguintes atributos de dados:

@geindex input_charset (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset input_charset}@anchor{3862}
@deffn {Atributo} input_charset

O conjunto de caracteres inicial especificado. Apelidos comuns são convertidos em seus nomes de e-mail `oficiais' (por exemplo, @code{latin_1} é convertido para @code{iso-8859-1}). O padrão é @code{us-ascii} de 7 bits.
@end deffn

@geindex header_encoding (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset header_encoding}@anchor{3863}
@deffn {Atributo} header_encoding

Se o conjunto de caracteres precisar ser codificado antes de ser usado em um cabeçalho de e-mail, este atributo será definido como @code{charset.QP} (para quoted-printable), @code{charset.BASE64} (para codificação base64) ou @code{charset.SHORTEST} para a codificação mais curta entre QP ou BASE64. Caso contrário, será @code{None}.
@end deffn

@geindex body_encoding (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset body_encoding}@anchor{3864}
@deffn {Atributo} body_encoding

O mesmo que `header_encoding', mas descreve a codificação do corpo da mensagem de e-mail, que pode ser diferente da codificação do cabeçalho. @code{charset.SHORTEST} não é permitido para `body_encoding'.
@end deffn

@geindex output_charset (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset output_charset}@anchor{3865}
@deffn {Atributo} output_charset

Alguns conjuntos de caracteres precisam ser convertidos antes de serem usados em cabeçalhos ou corpos de e-mail. Se `input_charset' for um deles, este atributo conterá o nome do conjunto de caracteres para o qual a saída será convertida. Caso contrário, será @code{None}.
@end deffn

@geindex input_codec (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset input_codec}@anchor{3866}
@deffn {Atributo} input_codec

O nome do codec Python usado para converter o `input_charset' para Unicode. Se nenhum codec de conversão for necessário, este atributo será @code{None}.
@end deffn

@geindex output_codec (atributo email.charset.Charset)
@anchor{library/email charset email charset Charset output_codec}@anchor{3867}
@deffn {Atributo} output_codec

O nome do codec Python usado para converter Unicode para o `output_charset'. Se nenhum codec de conversão for necessário, este atributo terá o mesmo valor que o `input_codec'.
@end deffn

Instâncias @ref{e26,,Charset} também têm os seguintes métodos:

@geindex get_body_encoding() (método email.charset.Charset)
@anchor{library/email charset email charset Charset get_body_encoding}@anchor{3868}
@deffn {Método} get_body_encoding ()

Retorna a codificação de transferência de conteúdo usada para codificação do corpo.

Esta é a string @code{quoted-printable} ou @code{base64}, dependendo da codificação usada, ou é uma função, caso em que você deve chamar a função com um único argumento, sendo o objeto Message codificado. A função deve então definir o próprio cabeçalho @code{Content-Transfer-Encoding} com o valor apropriado.

Retorna a string @code{quoted-printable} se `body_encoding' for @code{QP}, retorna a string @code{base64} se `body_encoding' for @code{BASE64} e retorna a string @code{7bit} caso contrário.
@end deffn

@geindex get_output_charset() (método email.charset.Charset)
@anchor{library/email charset email charset Charset get_output_charset}@anchor{3869}
@deffn {Método} get_output_charset ()

Retorna o conjunto de caracteres de saída.

Este é o atributo `output_charset' se não for @code{None}, caso contrário, é `input_charset'.
@end deffn

@geindex header_encode() (método email.charset.Charset)
@anchor{library/email charset email charset Charset header_encode}@anchor{386a}
@deffn {Método} header_encode (string)

Codifica o cabeçalho com a string `string'.

O tipo de codificação (base64 ou quoted-printable) será baseado no atributo `header_encoding'.
@end deffn

@geindex header_encode_lines() (método email.charset.Charset)
@anchor{library/email charset email charset Charset header_encode_lines}@anchor{386b}
@deffn {Método} header_encode_lines (string, maxlengths)

Codifica um cabeçalho de uma `string' convertendo-a primeiro em bytes.

Isso é semelhante a @ref{386a,,header_encode()}, exceto que a string é ajustada aos comprimentos máximos de linha, conforme fornecido pelo argumento `maxlengths', que deve ser um iterador: cada elemento retornado deste iterador fornecerá o próximo comprimento máximo de linha.
@end deffn

@geindex body_encode() (método email.charset.Charset)
@anchor{library/email charset email charset Charset body_encode}@anchor{386c}
@deffn {Método} body_encode (string)

Codifica o corpo com a string `string'.

O tipo de codificação (base64 ou quoted-printable) será baseado no atributo `body_encoding'.
@end deffn

A classe @ref{e26,,Charset} também fornece vários métodos para dar suporte a operações padrão e funções embutidas.

@geindex __str__() (método email.charset.Charset)
@anchor{library/email charset email charset Charset __str__}@anchor{386d}
@deffn {Método} __str__ ()

Retorna `input_charset' como uma string convertida para minúsculas. @code{__repr__()} é um apelido para @code{__str__()}.
@end deffn

@geindex __eq__() (método email.charset.Charset)
@anchor{library/email charset email charset Charset __eq__}@anchor{386e}
@deffn {Método} __eq__ (other)

Este método permite que você compare duas instâncias @ref{e26,,Charset} para verificar a igualdade.
@end deffn

@geindex __ne__() (método email.charset.Charset)
@anchor{library/email charset email charset Charset __ne__}@anchor{386f}
@deffn {Método} __ne__ (other)

Este método permite que você compare duas instâncias @ref{e26,,Charset} para verificar a desigualdade.
@end deffn
@end deffn

O módulo @ref{3c,,email.charset} também fornece as seguintes funções para adicionar novas entradas ao conjunto global de caracteres, apelidos e registros de codec:

@geindex add_charset() (no módulo email.charset)
@anchor{library/email charset email charset add_charset}@anchor{3870}
@deffn {Função} email.charset.add_charset (charset, header_enc=None, body_enc=None, output_charset=None)

Adiciona propriedades de caracteres ao registro global.

`charset' é o conjunto de caracteres de entrada e deve ser o nome canônico de um conjunto de caracteres.

`header_enc' e `body_enc' opcionais são @code{charset.QP} para quoted-printable, @code{charset.BASE64} para codificação base64, @code{charset.SHORTEST} para a codificação mais curta entre quoted-printable ou base64, ou @code{None} para nenhuma codificação. @code{SHORTEST} é válido apenas para `header_enc'. O padrão é @code{None} para nenhuma codificação.

`output_charset' opcional é o conjunto de caracteres que a saída deve conter. As conversões prosseguirão do conjunto de caracteres de entrada para Unicode e para o conjunto de caracteres de saída quando o método @code{Charset.convert()} for chamado. O padrão é gerar a saída no mesmo conjunto de caracteres da entrada.

Tanto `input_charset' quanto `output_charset' devem ter entradas de codec Unicode no mapeamento de conjunto de caracteres para codec do módulo; use @ref{3871,,add_codec()} para adicionar codecs que o módulo não conhece. Consulte a documentação do módulo @ref{1b,,codecs} para obter mais informações.

O registro do conjunto de caracteres global é mantido no dicionário global do módulo @code{CHARSETS}.
@end deffn

@geindex add_alias() (no módulo email.charset)
@anchor{library/email charset email charset add_alias}@anchor{3872}
@deffn {Função} email.charset.add_alias (alias, canonical)

Adicione um apelido para o conjunto de caracteres. `alias' é o nome do alias, por exemplo, @code{latin-1}. `canonical' é o nome canônico do conjunto de caracteres, por exemplo, @code{iso-8859-1}.

O registro global de apelido de conjunto de caracteres é mantido no dicionário global do módulo @code{ALIASES}.
@end deffn

@geindex add_codec() (no módulo email.charset)
@anchor{library/email charset email charset add_codec}@anchor{3871}
@deffn {Função} email.charset.add_codec (charset, codecname)

Adiciona um codec que mapeia caracteres no conjunto de caracteres fornecido para e a partir do Unicode.

`charset' é o nome canônico de um conjunto de caracteres. `codecname' é o nome de um codec Python, conforme apropriado para o segundo argumento do método @ref{8db,,encode()} do @ref{44c,,str}.
@end deffn

@node email encoders Codificadores,email utils Utilitários diversos,email charset Representando conjuntos de caracteres,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email encoders doc}@anchor{3873}@anchor{library/email encoders email-encoders-encoders}@anchor{3874}@anchor{library/email encoders module-email encoders}@anchor{3e}@anchor{library/email encoders translation-repo}@anchor{3875}
@subsubsection @code{email.encoders}: Codificadores


@geindex module; email.encoders

`Código-fonte:' Lib/email/encoders.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/encoders.py}


__________________________________________________________________


Este módulo faz parte da API legada de e-mail (@code{Compat32}). Na nova API, a funcionalidade é fornecida pelo parâmetro `cte' do método @ref{19e8,,set_content()}.

Este módulo está descontinuado no Python 3. As funções fornecidas aqui não devem ser chamadas explicitamente, pois a classe @ref{e25,,MIMEText} define o tipo de conteúdo e o cabeçalho CTE usando os valores `_subtype' e `_charset' passados durante a instanciação dessa classe.

O texto restante nesta seção é a documentação original do módulo.

Ao criar objetos @ref{27c,,Message} do zero, você frequentemente precisa codificar as cargas úteis para transporte por meio de servidores de e-mail compatíveis. Isso é especialmente verdadeiro para mensagens do tipo @code{image/*} e @code{text/*} contendo dados binários.

O pacote @ref{3b,,email} fornece alguns codificadores convenientes em seu módulo @ref{3e,,encoders}. Esses codificadores são realmente usados pelos construtores de classe @ref{3855,,MIMEAudio} e @ref{37e6,,MIMEImage} para fornecer codificações padrão. Todas as funções de codificador recebem exatamente um argumento, o objeto de mensagem a ser codificado. Eles geralmente extraem a carga útil, codificam-na e redefinem a carga útil para esse valor recém-codificado. Eles também devem definir o cabeçalho @code{Content-Transfer-Encoding} conforme apropriado.

Observe que essas funções não são significativas para uma mensagem multiparte. Elas devem ser aplicadas a subpartes individuais, e levantarão um @ref{2c3,,TypeError} se for passada uma mensagem cujo tipo seja multiparte.

Aqui estão as funções de codificação fornecidas:

@geindex encode_quopri() (no módulo email.encoders)
@anchor{library/email encoders email encoders encode_quopri}@anchor{3876}
@deffn {Função} email.encoders.encode_quopri (msg)

Codifica a carga útil em formato quoted-printable e define o cabeçalho @code{Content-Transfer-Encoding} como @code{quoted-printable} @footnote{
Observe que a codificação com @ref{3876,,encode_quopri()} também codifica todos os caracteres de tabulação e espaço nos dados.
}. Esta é uma boa codificação para usar quando a maior parte da sua carga útil é de dados imprimíveis normais, mas contém alguns caracteres não imprimíveis.
@end deffn

@geindex encode_base64() (no módulo email.encoders)
@anchor{library/email encoders email encoders encode_base64}@anchor{3877}
@deffn {Função} email.encoders.encode_base64 (msg)

Codifica a carga útil em formato base64 e define o cabeçalho @code{Content-Transfer-Encoding} para @code{base64}. Esta é uma boa codificação para usar quando a maior parte da sua carga útil é de dados não imprimíveis, pois é um formato mais compacto do que quoted-printable. A desvantagem da codificação base64 é que ela torna o texto não legível por humanos.
@end deffn

@geindex encode_7or8bit() (no módulo email.encoders)
@anchor{library/email encoders email encoders encode_7or8bit}@anchor{3878}
@deffn {Função} email.encoders.encode_7or8bit (msg)

Na verdade, isso não modifica a carga útil da mensagem, mas define o cabeçalho @code{Content-Transfer-Encoding} para @code{7bit} ou @code{8bit}, conforme apropriado, com base nos dados da carga útil.
@end deffn

@geindex encode_noop() (no módulo email.encoders)
@anchor{library/email encoders email encoders encode_noop}@anchor{3879}
@deffn {Função} email.encoders.encode_noop (msg)

Isso não faz nada; nem mesmo define o cabeçalho @code{Content-Transfer-Encoding}.
@end deffn

@node email utils Utilitários diversos,email iterators Iteradores,email encoders Codificadores,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email utils doc}@anchor{387a}@anchor{library/email utils email-utils-miscellaneous-utilities}@anchor{387b}@anchor{library/email utils module-email utils}@anchor{50}@anchor{library/email utils translation-repo}@anchor{387c}
@subsubsection @code{email.utils}: Utilitários diversos


@geindex module; email.utils

`Código-fonte:' Lib/email/utils.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/utils.py}


__________________________________________________________________


Existem alguns utilitários úteis fornecidos no @ref{50,,email.utils} module:

@geindex localtime() (no módulo email.utils)
@anchor{library/email utils email utils localtime}@anchor{2c4}
@deffn {Função} email.utils.localtime (dt=None)

Retorna a hora local como um objeto datetime consciente. Se chamado sem argumentos, retorna a hora atual. Caso contrário, o argumento `dt' deve ser uma instância @ref{1cc,,datetime} e é convertido para o fuso horário local de acordo com o banco de dados de fuso horário do sistema. Se `dt' for ingênuo (ou seja, @code{dt.tzinfo} for @code{None}), será presumido como estando no horário local. O parâmetro `isdst' é ignorado.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.12, será removido na versão 3.14: O parâmetro `isdst'.

@end deffn

@geindex make_msgid() (no módulo email.utils)
@anchor{library/email utils email utils make_msgid}@anchor{387d}
@deffn {Função} email.utils.make_msgid (idstring=None, domain=None)

Retorna uma string adequada para um cabeçalho @code{Message-ID} compatível com 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. O `idstring' opcional, se fornecido, é uma string usada para fortalecer a exclusividade do ID da mensagem. O `domain' Opcional, se dado, fornece a porção do msgid após o ‘@@’. O padrão é o nome do host local. Normalmente, não é necessário substituir esse padrão, mas pode ser útil em alguns casos, como um sistema distribuído de construção que usa um nome de domínio consistente em vários hosts.


Alterado na versão 3.2: Adicionada a palavra-chave `domain'.

@end deffn

As funções restantes fazem parte da API de e-mail herdada (@code{Compat32}). Não há necessidade de usá-las diretamente com a nova API, pois a análise e a formatação fornecidas são feitas automaticamente pelo mecanismo de análise de cabeçalhos da nova API.

@geindex quote() (no módulo email.utils)
@anchor{library/email utils email utils quote}@anchor{387e}
@deffn {Função} email.utils.quote (str)

Devolve uma nova string com barras invertidas em `str' substituídas por duas barras invertidas e aspas duplas substituídas por aspas duplas invertidas.
@end deffn

@geindex unquote() (no módulo email.utils)
@anchor{library/email utils email utils unquote}@anchor{3789}
@deffn {Função} email.utils.unquote (str)

Retorna uma nova string que é uma versão sem aspas de `str'. Se `str' terminar e começar com aspas duplas, elas serão removidas. Da mesma forma, se `str' termina e começa com colchetes angulares, eles são removidos.
@end deffn

@geindex parseaddr() (no módulo email.utils)
@anchor{library/email utils email utils parseaddr}@anchor{1e2}
@deffn {Função} email.utils.parseaddr (address, *, strict=True)

Analisa o endereço – que deve ser o valor de algum campo contendo endereço, como @code{To} ou @code{Cc} – em suas partes constituinte `realname' e `email address'. Retorna uma tupla daquela informação, a menos que a análise falhe, caso em que uma tupla de 2 de @code{('@w{'}, '@w{'})} é retornada.

Se `strict' for verdadeiro, usa um analisador sintático estrito que rejeite entradas malformadas.


Alterado na versão 3.13: Adiciona o parâmetro opcional `strict' e rejeita entradas malformadas por padrão.

@end deffn

@geindex formataddr() (no módulo email.utils)
@anchor{library/email utils email utils formataddr}@anchor{11d9}
@deffn {Função} email.utils.formataddr (pair, charset='utf-8')

O inverso de @ref{1e2,,parseaddr()}, isto leva uma tupla de 2 do forma @code{(realname, email_address)} e retorna o valor de string adequado para um cabeçalho @code{To} ou @code{Cc} . Se o primeiro elemento de `pair' for falso, o segundo elemento será retornado sem modificações.

O `charset' opcional é o conjunto de caracteres que será usado na codificação 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} do @code{realname} se o @code{realname} contiver caracteres não-ASCII. Pode ser uma instância de @ref{44c,,str} ou a @ref{e26,,Charset}. O padrão é @code{utf-8}.


Alterado na versão 3.3: Adicionada a opção `charset'.

@end deffn

@geindex getaddresses() (no módulo email.utils)
@anchor{library/email utils email utils getaddresses}@anchor{1e1}
@deffn {Função} email.utils.getaddresses (fieldvalues, *, strict=True)

Este método retorna uma lista de tuplas 2 do formulário retornado por @code{parseaddr()}. `fieldvalues' é uma sequência de valores do campo de cabeçalho que pode ser retornada por @ref{3834,,Message.get_all}.

Se `strict' for verdadeiro, usa um analisador sintático estrito que rejeite entradas malformadas.

Aqui está um exemplo simples que recebe todos os destinatários de uma mensagem:

@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


Alterado na versão 3.13: Adiciona o parâmetro opcional `strict' e rejeita entradas malformadas por padrão.

@end deffn

@geindex parsedate() (no módulo email.utils)
@anchor{library/email utils email utils parsedate}@anchor{387f}
@deffn {Função} email.utils.parsedate (date)

Tenta analisar uma data de acordo com as regras em 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. no entanto, alguns mailers não seguem esse formato conforme especificado, portanto @ref{387f,,parsedate()} tenta adivinhar corretamente em tais casos. `date' é uma string contendo uma data 
@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"}. Se conseguir analisar a data, @ref{387f,,parsedate()} retorna uma 9-tupla que pode ser passada diretamente para @ref{1228,,time.mktime()}; caso contrário, @code{None} será retornado. Observe que os índices 6, 7 e 8 da tupla de resultados não são utilizáveis.
@end deffn

@geindex parsedate_tz() (no módulo email.utils)
@anchor{library/email utils email utils parsedate_tz}@anchor{19ac}
@deffn {Função} email.utils.parsedate_tz (date)

Executa a mesma função que @ref{387f,,parsedate()}, mas retorna @code{None} ou uma tupla de 10; os primeiros 9 elementos formam uma tupla que pode ser passada diretamente para @ref{1228,,time.mktime()}, e o décimo é o deslocamento do fuso horário da data do UTC (que é o termo oficial para o horário de Greenwich) @footnote{
Observa que o sinal do deslocamento de fuso horário é o oposto do sinal da variável @code{time.timezone} para o mesmo fuso horário; a última variável segue o padrão POSIX enquanto este módulo segue 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}.
}. Se a string de entrada não tem fuso horário, o último elemento da tupla retornado é @code{0}, que representa UTC. Observe que os índices 6, 7 e 8 da tupla de resultado não podem ser usados.
@end deffn

@geindex parsedate_to_datetime() (no módulo email.utils)
@anchor{library/email utils email utils parsedate_to_datetime}@anchor{10fd}
@deffn {Função} email.utils.parsedate_to_datetime (date)

O inverso de @ref{10fc,,format_datetime()}. Desempenha a mesma função que @ref{387f,,parsedate()}, mas em caso de sucesso retorna um @ref{1cc,,datetime}; caso contrário, @code{ValueError} é levantada se `date' contiver um valor inválido, como uma hora maior que 23 ou uma diferença de fuso horário não entre -24 e 24 horas. Se a data de entrada tem um fuso horário de @code{-0000}, o @code{datetime} será um @code{datetime} ingênuo, e se a data estiver em conformidade com os RFCs representará um horário em UTC, mas sem indicação do fuso horário de origem real da mensagem de onde vem a data. Se a data de entrada tiver qualquer outro deslocamento de fuso horário válido, o @code{datetime} será um @code{datetime} consciente com o correspondente a @ref{10fe,,timezone} @ref{5de,,tzinfo}.


Adicionado na versão 3.3.

@end deffn

@geindex mktime_tz() (no módulo email.utils)
@anchor{library/email utils email utils mktime_tz}@anchor{3880}
@deffn {Função} email.utils.mktime_tz (tuple)

Transforma uma tupla de 10 conforme retornado por @ref{19ac,,parsedate_tz()} em um timestamp UTC (segundos desde a Era Unix). Se o item de fuso horário na tupla for @code{None}, considera a hora local.
@end deffn

@geindex formatdate() (no módulo email.utils)
@anchor{library/email utils email utils formatdate}@anchor{14b2}
@deffn {Função} email.utils.formatdate (timeval=None, localtime=False, usegmt=False)

Retorna uma string de data conforme 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}. Por exemplo:

@example
Fri, 09 Nov 2001 01:08:47 -0000
@end example

O `timeval' opcional, se fornecido, é um valor de tempo de ponto flutuante, conforme aceito por @ref{1200,,time.gmtime()} e @ref{1541,,time.localtime()}, caso contrário, o tempo atual é usado.

Há um sinalizador opcional `localtime', que, quando é @code{True}, interpreta `timeval' e retorna uma data relativa ao fuso horário local em vez do UTC, levando em consideração o horário de verão. O padrão é @code{False}, o que significa que o UTC é usado.

O `usegmt' opcional é um sinalizador que quando @code{True}, produz uma string de data com o fuso horário como uma string ascii @code{GMT}, ao invés de um numérico @code{-0000}. Isso é necessário para alguns protocolos (como HTTP). Isso se aplica apenas quando `localtime' for @code{False}. O padrão é @code{False}.
@end deffn

@geindex format_datetime() (no módulo email.utils)
@anchor{library/email utils email utils format_datetime}@anchor{10fc}
@deffn {Função} email.utils.format_datetime (dt, usegmt=False)

Como @code{formatdate}, mas a entrada é uma instância de @ref{30,,datetime}. Se for uma data e hora ingênua, será considerado “UTC sem informações sobre o fuso horário de origem” e o convencional @code{-0000} será usado para o fuso horário. Se for um @code{datetime} ciente, então o deslocamento de fuso horário numérico é usado. Se for um fuso horário ciente com deslocamento zero, então `usegmt' pode ser definido como @code{True}, caso em que a string @code{GMT} é usada em vez do deslocamento numérico do fuso horário. Isso fornece uma maneira de gerar cabeçalhos de data HTTP em conformidade com os padrões.


Adicionado na versão 3.3.

@end deffn

@geindex decode_rfc2231() (no módulo email.utils)
@anchor{library/email utils email utils decode_rfc2231}@anchor{3881}
@deffn {Função} email.utils.decode_rfc2231 (s)

Decodifica a string `s' de acordo com 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.
@end deffn

@geindex encode_rfc2231() (no módulo email.utils)
@anchor{library/email utils email utils encode_rfc2231}@anchor{3882}
@deffn {Função} email.utils.encode_rfc2231 (s, charset=None, language=None)

Codifica a string `s' de acordo com 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. `charset' e `language' opcionais, se fornecido, são o nome do conjunto de caracteres e o nome do idioma a ser usado. Se nenhum deles for fornecido, `s' é retornado como está. Se `charset' for fornecido, mas `language' não, a string será codificada usando a string vazia para `language'.
@end deffn

@geindex collapse_rfc2231_value() (no módulo email.utils)
@anchor{library/email utils email utils collapse_rfc2231_value}@anchor{3843}
@deffn {Função} email.utils.collapse_rfc2231_value (value, errors='replace', fallback_charset='us-ascii')

Quando um parâmetro de cabeçalho é codificado no formato 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}, @ref{3842,,Message.get_param} pode retornar uma tupla de 3 contendo o conjunto de caracteres, idioma e valor. @ref{3843,,collapse_rfc2231_value()} transforma isso em uma string Unicode. `errors' opcionais são passados para o argumento `errors' do método @ref{8db,,encode()} de @ref{44c,,str}; o padrão é @code{'replace'}. `fallback_charset' opcional especifica o conjunto de caracteres a ser usado se aquele no cabeçalho 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} não for conhecido pelo Python; o padrão é @code{'us-ascii'}.

Por conveniência, se `value' passado para @ref{3843,,collapse_rfc2231_value()} não for uma tupla, deve ser uma string e é retornado sem aspas.
@end deffn

@geindex decode_params() (no módulo email.utils)
@anchor{library/email utils email utils decode_params}@anchor{161c}
@deffn {Função} email.utils.decode_params (params)

Decodifica a lista de parâmetros de acordo com 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. `params' é uma sequência de 2 tuplas contendo elementos do formulário @code{(content-type, string-value)}.
@end deffn

@node email iterators Iteradores,,email utils Utilitários diversos,email — Um e-mail e um pacote MIME manipulável
@anchor{library/email iterators doc}@anchor{3883}@anchor{library/email iterators email-iterators-iterators}@anchor{3884}@anchor{library/email iterators module-email iterators}@anchor{43}@anchor{library/email iterators translation-repo}@anchor{3885}
@subsubsection @code{email.iterators}: Iteradores


@geindex module; email.iterators

`Código-fonte:' Lib/email/iterators.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/email/iterators.py}


__________________________________________________________________


A iteração sobre uma árvore de objetos de mensagem é bastante fácil com o método @ref{384b,,Message.walk}. O módulo @ref{43,,email.iterators} fornece algumas iterações úteis de nível mais alto sobre as árvores de objetos de mensagens.

@geindex body_line_iterator() (no módulo email.iterators)
@anchor{library/email iterators email iterators body_line_iterator}@anchor{3886}
@deffn {Função} email.iterators.body_line_iterator (msg, decode=False)

Isso itera sobre todas as cargas úteis em todas as subpartes de `msg', retornando as cargas úteis das strings de linhas por linha. Ele pula todos os cabeçalhos da subparte e pula qualquer subparte com uma carga útil que não seja uma string Python. Isso é um pouco equivalente à leitura da representação de texto simples da mensagem de um arquivo usando @ref{1e46,,readline()}, pulando todos os cabeçalhos intermediários.

`decode' opcional é passado por meio do @ref{120d,,Message.get_payload}.
@end deffn

@geindex typed_subpart_iterator() (no módulo email.iterators)
@anchor{library/email iterators email iterators typed_subpart_iterator}@anchor{3887}
@deffn {Função} email.iterators.typed_subpart_iterator (msg, maintype='text', subtype=None)

Isso itera sobre todas as subpartes de `msg', retornando apenas as subpartes que correspondem ao tipo MIME especificado por `maintype' e `subtype'.

Observe que `subtipo' é opcional; se omitido, a correspondência de tipo MIME da subparte é feita apenas com o tipo principal. `maintype' também é opcional; o padrão é @code{text}.

Assim, por padrão @ref{3887,,typed_subpart_iterator()} retorna cada subparte que possui um tipo MIME de @code{text/*}.
@end deffn

A seguinte função foi adicionada como uma ferramenta de depuração útil. `Não' deve ser considerado parte da interface pública suportada para o pacote.

@geindex _structure() (no módulo email.iterators)
@anchor{library/email iterators email iterators _structure}@anchor{3888}
@deffn {Função} email.iterators._structure (msg, fp=None, level=0, include_default=False)

Imprime uma representação recuada dos tipos de conteúdo da estrutura do objeto de mensagem. Por exemplo:

@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(algum_arquivo)
>>> _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()

O `fp' opcional é um objeto arquivo ou similar para o qual deve-se imprimir a saída. Deve ser adequado para a função Python @ref{fa9,,print()}. `level' usado internamente. `include_default', se verdadeiro, também imprime o tipo padrão.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{ca,,smtplib}

Cliente SMTP (Protocolo Simples de Envio de E-mail)

@item Módulo @ref{ac,,poplib}

Cliente POP (Post Office Protocol)

@item Módulo @ref{74,,imaplib}

Cliente IMAP (Internet Message Access Protocol)

@item Módulo @ref{8b,,mailbox}

Ferramentas para criar, ler, e gerenciar coleções de mensagem em disco usando vários formatos padrão.
@end table


@node json — Codificador e decodificador JSON,mailbox — Manipule caixas de entradas em vários formatos,email — Um e-mail e um pacote MIME manipulável,Manuseio de Dados na Internet
@anchor{library/json doc}@anchor{3889}@anchor{library/json json-json-encoder-and-decoder}@anchor{388a}@anchor{library/json module-json}@anchor{82}@anchor{library/json translation-repo}@anchor{388b}
@subsection @code{json} — Codificador e decodificador JSON


@geindex module; json

`Código-fonte:' Lib/json/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/json/__init__.py}


__________________________________________________________________


JSON (JavaScript Object Notation)@footnote{https://json.org}, especificado pelo 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} (que tornou o 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html} obsoleta) e pelo ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/}, é um formato leve de troca de dados inspirado pela sintaxe de objeto JavaScript@footnote{https://en.wikipedia.org/wiki/JavaScript} (embora não seja um subconjunto estrito de JavaScript @footnote{
Como apresentado @uref{https://www.rfc-editor.org/errata_search.php?rfc=7159,na errata para RFC 7159}, JSON permite os caracteres literais U+2028 (SEPARADOR DE LINHA) e U+2029 (SEPARADOR DE PARÁGRAFO) em strings, enquanto que JavaScript (ECMAScript Edition 5.1) não.
}).

@cartouche
@quotation Nota 
O termo “objeto” no contexto do processamento JSON em Python pode ser ambíguo. Todos os valores em Python são objetos. Em JSON, um objeto se refere a qualquer dado entre chaves, semelhante a um dicionário Python.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Tenha cuidado quando estiver analisando dados JSON de fontes não-confiáveis. Uma string JSON maliciosa pode fazer o decodificador consumir recursos consideráveis de CPU e memória. É recomendado limitar o tamanho do dado a ser analisado.
@end quotation
@end cartouche

Este módulo expõe uma API familiar para pessoas usuárias dos módulos @ref{8d,,marshal} e @ref{a6,,pickle} da biblioteca padrão.

Codificação de hierarquias básicas de objetos 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

Codificação compacta:

@example
>>> import json
>>> json.dumps([1, 2, 3, @{'4': 5, '6': 7@}], separators=(',', ':'))
'[1,2,3,@{"4":5,"6":7@}]'
@end example

Saída bonita:

@example
>>> import json
>>> print(json.dumps(@{'6': 7, '4': 5@}, sort_keys=True, indent=4))
@{
    "4": 5,
    "6": 7
@}
@end example

Personalizando em codificação de objeto JSON:

@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

Decodificando 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

Personalizando em decodificação de objeto 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

Estendendo @ref{d69,,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

Usando @ref{83,,json.tool} para validar a partir do console e exibir formatado:

@example
$ echo '@{"json":"obj"@}' | python -m json.tool
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json.tool
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example

Veja @ref{388c,,Interface de linha de comando} para a documentação detalhada.

@cartouche
@quotation Nota 
JSON é um subconjunto do YAML@footnote{https://yaml.org/} 1.2. O JSON gerado pelas definições padrões desse módulo (particularmente, o valor padrão dos `separadores') é também um subconjunto do YAML 1.0 e 1.1. Esse módulo pode, portanto, também ser usado como serializador YAML.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
O codificador e o decodificador do módulo preservam a ordem de entrada e saída por padrão. A ordem só é perdida se os contêineres subjacentes estão desordenados.
@end quotation
@end cartouche

@menu
* Uso básico: Uso básico<2>. 
* Codificadores e decodificadores:: 
* Exceções: Exceções<17>. 
* Conformidade e interoperabilidade entre padrões:: 
* Interface de linha de comando: Interface de linha de comando<5>. 

@end menu

@node Uso básico<2>,Codificadores e decodificadores,,json — Codificador e decodificador JSON
@anchor{library/json basic-usage}@anchor{388d}
@subsubsection Uso básico


@geindex dump() (no módulo json)
@anchor{library/json json dump}@anchor{d67}
@deffn {Função} 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 um `obj' como um stream JSON formatado para `fp' (um @ref{15cf,,objeto arquivo ou similar} com suporte a @code{.write()}) usando essa @ref{388e,,tabela de conversão de Python para JSON}.

@cartouche
@quotation Nota 
Diferente de @ref{a6,,pickle} e @ref{8d,,marshal}, JSON não é um protocolo com datagrama, assim tentar serializar múltiplos objetos com chamadas repetidas para @ref{d67,,dump()} usando o mesmo `fp' resultará em um arquivo JSON inválido.
@end quotation
@end cartouche

@*Parâmetros: 

@itemize *

@item 
@code{obj} (@ref{a96,,object}) – O objeto Python a ser serializado.

@item 
@code{fp} (@ref{15cf,,file-like object}) – O objeto arquivo ou similar `obj' para o qual será serializado. O módulo @code{json} sempre produz objetos @ref{44c,,str}, e não objetos @ref{1c2,,bytes}. Dessa forma, @code{fp.write()} precisa ter suporte para entradas @ref{44c,,str}.

@item 
@code{skipkeys} (@ref{468,,bool}) – Se @code{True}, as chaves que não forem de um tipo básico (@ref{44c,,str}, @ref{257,,int}, @ref{2f7,,float}, @ref{468,,bool}, @code{None}) serão ignoradas ao invés de levantar uma exceção @ref{2c3,,TypeError}. Padrão @code{False}.

@item 
@code{ensure_ascii} (@ref{468,,bool}) – Se definido como @code{True} (o padrão), a saída terá todos os caracteres não ASCII e não imprimíveis recebidos escapados. Se definido como @code{False}, todos os caracteres serão exibidos como estão, exceto os caracteres que devem ser escapados: aspas, barra invertida e os caracteres de controle U+0000 a U+001F.

@item 
@code{check_circular} (@ref{468,,bool}) – Se @code{False}, a verificação de referência circular for de tipos contêineres é ignorada e uma referência circular resultará em uma exceção @ref{d90,,RecursionError} (ou pior). Padrão @code{True}.

@item 
@code{allow_nan} (@ref{468,,bool}) – Se @code{False}, serialização de valores @ref{2f7,,float} fora de intervalo (@code{nan}, @code{inf}, @code{-inf}) vai resultar em um @ref{202,,ValueError} em estrita conformidade com a especificação. Se @code{True} (o padrão), seus equivalentes JavaScript (@code{NaN}, @code{Infinity}, @code{-Infinity}) serão usados.

@item 
@code{cls} (a @ref{d69,,JSONEncoder} subclass) – Se definido, um codificador JSON personalizado com o método @ref{388f,,default()} substituído, para serializar em tipos de dados personalizados. Se @code{None} (o padrão), @code{JSONEncoder} é usado.

@item 
@code{indent} (@ref{257,,int}@code{ | }@ref{44c,,str}@code{ | }@code{None}) – Se for um inteiro positivo ou uma string, os elementos da vetores JSON e os membros do objeto serão impressos de forma bonita com esse nível de indentação. Um inteiro positivo recua essa quantidade de espaços por nível; uma string (como @code{"\t"}) é usada para indentar cada nível. Se for zero, negativo ou @code{""} (a string vazia), somente novas linhas serão inseridas. Se for @code{None} (o padrão), a representação mais compacta será usada.

@item 
@code{separators} (@ref{370,,tuple}@code{ | }@code{None}) – Uma tupla dupla: @code{(item_separator, key_separator)}. Se @code{None} (o padrão), `separators' assume como padrão @code{(', ', ': ')} se `indent' for @code{None}, e @code{(',', ': ')} caso contrário. Para o JSON mais compacto, especifique @code{(',', ':')} para eliminar espaços em branco.

@item 
@code{default} (@ref{2aaf,,callable} | None) – Uma função que é chamada para objetos que não podem ser serializados de outra forma. Ela deve retornar uma versão JSON codificável do objeto ou gerar um @ref{2c3,,TypeError}. Se @code{None} (o padrão), @code{TypeError} é levantada.

@item 
@code{sort_keys} (@ref{468,,bool}) – Se @code{True}, os dicionários serão emitidos classificados por chave. Padrão @code{False}.
@end itemize



Alterado na versão 3.2: Permite strings para `indent', além de inteiros.



Alterado na versão 3.4: Usa @code{(',', ': ')} como padrão se `indent' não for @code{None}.



Alterado na versão 3.6: Todos os parâmetros opcionais agora são @ref{2a5,,somente-nomeados}.

@end deffn

@geindex dumps() (no módulo json)
@anchor{library/json json dumps}@anchor{d68}
@deffn {Função} 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' para uma @ref{44c,,str} com formato JSON usando essa @ref{388e,,tabela de conversão}. Os argumentos têm o mesmo significado que na função @ref{d67,,dump()}.

@cartouche
@quotation Nota 
Chaves nos pares chave/valor de JSON são sempre do tipo @ref{44c,,str}. Quando um dicionário é convertido para JSON, todas as chaves são convertidas para strings. Como resultado disso, se um dicionário é convertido para JSON e depois de volta para um dicionário, o dicionário pode não ser igual ao original. Isto é, @code{loads(dumps(x)) != x} se x tem chaves não strings.
@end quotation
@end cartouche
@end deffn

@geindex load() (no módulo json)
@anchor{library/json json load}@anchor{cd4}
@deffn {Função} json.load (fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

Desserializa `fp' para um objeto Python usando a @ref{3890,,tabela de conversão JSON para Python}.

@*Parâmetros: 

@itemize *

@item 
@code{fp} (@ref{15cf,,file-like object}) – Um @ref{1e0d,,arquivo texto} ou @ref{1e0e,,arquivo binário} com suporte a @code{.read()} contendo o documento JSON a ser desserializado.

@item 
@code{cls} (a @ref{d6a,,JSONDecoder} subclass) – Se definido, um decodificador JSON personalizado. Argumentos nomeados adicionais para @code{load()} serão passados para o construtor de `cls'. Se @code{None} (o padrão), @code{JSONDecoder} é usado.

@item 
@code{object_hook} (@ref{2aaf,,callable} | None) – Se definido, uma função que é chamada com o resultado de qualquer literal de objeto JSON decodificado (um @ref{256,,dict}). O valor de retorno desta função será usado em vez do @ref{256,,dict}. Este recurso pode ser usado para implementar decodificadores personalizados, por exemplo dica de classes JSON-RPC@footnote{https://www.jsonrpc.org}. O padrão é @code{None}.

@item 
@code{object_pairs_hook} (@ref{2aaf,,callable} | None) – Se definido, uma função que é chamada com o resultado de qualquer literal de objeto JSON decodificado com uma lista ordenada de pares. O valor de retorno desta função será usado em vez de @ref{256,,dict}. Este recurso pode ser usado para implementar decodificadores personalizados. Se `object_hook' também for definido, `object_pairs_hook' terá prioridade. O padrão é @code{None}.

@item 
@code{parse_float} (@ref{2aaf,,callable} | None) – Se definido, uma função que é chamada com a string de cada ponto flutuante JSON a ser decodificada. Se @code{None} (o padrão), é equivalente a @code{float(num_str)}. Isso pode ser usado para analisar pontos flutuantes JSON em tipos de dados personalizados, por exemplo @ref{29d,,decimal.Decimal}.

@item 
@code{parse_int} (@ref{2aaf,,callable} | None) – Se definido, uma função que é chamada com a string de cada int JSON a ser decodificado. Se @code{None} (o padrão), é equivalente a @code{int(num_str)}. Isso pode ser usado para analisar inteiros JSON em tipos de dados personalizados, por exemplo @ref{2f7,,float}.

@item 
@code{parse_constant} (@ref{2aaf,,callable} | None) – Se definido, uma função que é chamada com uma das seguintes strings: @code{'-Infinity'}, @code{'Infinity'} ou @code{'NaN'}. Isso pode ser usado para levantar uma exceção se números JSON inválidos forem encontrados. Padrão @code{None}.
@end itemize


@*Levanta: 

@itemize *

@item 
@ref{e4d,,JSONDecodeError} – Quando os dados a serem desserializados não forem um documento JSON válido.

@item 
@ref{a1d,,UnicodeDecodeError} – Quando os dados que estão sendo desserializados não contêm dados codificados em UTF-8, UTF-16 ou UTF-32.
@end itemize



Alterado na versão 3.1: 


@itemize *

@item 
Adicionado o parâmetro opcional `object_pairs_hook'.

@item 
`parse_constant' não é mais chamada para ‘null’, ‘true’, ‘false’.
@end itemize



Alterado na versão 3.6: 


@itemize *

@item 
Todos os parâmetros opcionais agora são @ref{2a5,,somente-nomeados}.

@item 
`fp' agora pode ser um @ref{1e0e,,arquivo binário}. A entrada deve estar codificada como UTF-8, UTF-16 ou UTF-32.
@end itemize



Alterado na versão 3.11: O `parse_int' padrão para  @ref{257,,int()} agora limita o tamanho máximo da string de inteiro via @ref{5f5,,limitação de comprimento de string na conversão para inteiro} do interpretador para ajudar a evitar ataques por negação de serviço.

@end deffn

@geindex loads() (no módulo json)
@anchor{library/json json loads}@anchor{95c}
@deffn {Função} json.loads (s, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

Idêntico a @ref{cd4,,load()}, mas em vez de um objeto arquivo ou similar, desserializa `s' (uma instância de @ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray} contendo um documento JSON) para um objeto Python usando essa @ref{3890,,tabela de conversão}.


Alterado na versão 3.6: `s' agora pode ser um do tipo @ref{1c2,,bytes} ou @ref{2ea,,bytearray}. A entrada deve estar codificado como UTF-8, UTF-16 ou UTF-32.



Alterado na versão 3.9: O argumento nomeado `encoding' foi removido.

@end deffn

@node Codificadores e decodificadores,Exceções<17>,Uso básico<2>,json — Codificador e decodificador JSON
@anchor{library/json encoders-and-decoders}@anchor{3891}
@subsubsection Codificadores e decodificadores


@geindex JSONDecoder (classe em json)
@anchor{library/json json JSONDecoder}@anchor{d6a}
@deffn {Classe} json.JSONDecoder (*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)

Decodificador JSON simples.

Executa as seguintes traduções na decodificação por padrão:
@anchor{library/json json-to-py-table}@anchor{3890}

@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

JSON

@tab

Python

@item

objeto

@tab

dict

@item

array

@tab

lista

@item

string

@tab

str

@item

número (inteiro)

@tab

int

@item

número (real)

@tab

ponto flutuante

@item

true

@tab

True

@item

false

@tab

False

@item

null

@tab

None

@end multitable


Ele também entende @code{NaN}, @code{Infinity} e @code{-Infinity} como seus valores @code{float} correspondentes, que estão fora da especificação JSON.

`object_hook' é uma função opcional que será chamada com o resultado de cada objeto JSON decodificado e seu valor de retorno será usado no lugar do dado @ref{256,,dict}. Isso pode ser usado para fornecer desserializações personalizadas (por exemplo, para oferecer suporte a dicas de classe JSON-RPC@footnote{https://www.jsonrpc.org})

`object_pairs_hook' é uma função opcional que será chamada com o resultado de todo objeto JSON decodificado com uma lista ordenada de pares. O valor de retorno de `object_pairs_hook' será usado no lugar do @ref{256,,dict}. Este recurso pode ser usado para implementar decodificadores personalizados. Se `object_pairs_hook' também for definido, o `object_pairs_hook' terá prioridade.


Alterado na versão 3.1: Adicionado suporte para `object_pairs_hook'.


`parse_float' é uma função opcional que será chamada com a string de cada ponto flutuante JSON para ser decodificado. Por padrão, equivale a @code{float(num_str)}. Pode ser usado para qualquer outro tipo de dado ou analisador de pontos flutuante JSON (por exemplo, @ref{29d,,decimal.Decimal}).

`parse_int' é uma função opcional que será chamada com a string de cada inteiro JSON para ser decodificado. Por padrão, equivale a @code{int(num_str)}. Pode ser usado para qualquer outro tipo de dado ou analisador de inteiros JSON (por exemplo, @ref{2f7,,float}).

`parse_constant' é uma função opcional que será chamada para cada um das seguintes strings: @code{'-Infinity'}, @code{'Infinity'}, @code{'NaN'}. Isso pode ser usado para levantar uma exceção se forem encontrados números JSON inválidos.

Se `strict' for falso (@code{True} é o padrão), os caracteres de controle serão permitidos dentro das strings. Os caracteres de controle neste contexto são aqueles com códigos de caracteres no intervalo 0–31, incluindo @code{'\t'} (tab), @code{'\n'}, @code{'\r'} e @code{'\0'}.

Se os dados a serem desserializados não forem um documento JSON válido, será levantada uma exceção @ref{e4d,,JSONDecodeError}.


Alterado na versão 3.6: Todos os parâmetros agora são @ref{2a5,,somente-nomeado}.


@geindex decode() (método json.JSONDecoder)
@anchor{library/json json JSONDecoder decode}@anchor{3892}
@deffn {Método} decode (s)

Retorna a representação Python de `s' (uma instância @ref{44c,,str} contendo um documento JSON).

Uma exceção @ref{e4d,,JSONDecodeError} será levantada se o documento JSON fornecido não for válido.
@end deffn

@geindex raw_decode() (método json.JSONDecoder)
@anchor{library/json json JSONDecoder raw_decode}@anchor{3893}
@deffn {Método} raw_decode (s)

Decodifica um documento JSON a partir de `s' (uma @ref{44c,,str} iniciando com um documento JSON) e retornando uma tupla de 2 elementos, a representação Python e o índice em `s' onde o documento finaliza.

Isso pode ser usado para decodificar um documento JSON a partir de uma string que possa ter dados extras ao final.
@end deffn
@end deffn

@geindex JSONEncoder (classe em json)
@anchor{library/json json JSONEncoder}@anchor{d69}
@deffn {Classe} json.JSONEncoder (*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Codificador JSON extensível para estruturas de dados Python.

Por padrão, possui suporte para os seguintes objetos e tipos:
@anchor{library/json py-to-json-table}@anchor{388e}

@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Python

@tab

JSON

@item

dict

@tab

objeto

@item

list, tuple

@tab

array

@item

str

@tab

string

@item

int, float e Enums derivados de int e float

@tab

número

@item

True

@tab

true

@item

False

@tab

false

@item

None

@tab

null

@end multitable



Alterado na versão 3.4: Adicionado suporte para classes Enum derivadas de int e float.


Para estender isso para reconhecer outros objetos, crie uma subclasse e implemente o método @ref{388f,,default()} com outro método que retorne um objeto serializável para @code{o} se possível, caso contrário deveria chamar a implementação da superclasse (para levantar @ref{2c3,,TypeError}).

Se `skipkeys' é falso (o padrão), então sluma @ref{2c3,,TypeError} será levantada ao tentar codificar as chaves que não são @ref{44c,,str}, @ref{257,,int}, @ref{2f7,,float}, @ref{468,,bool} ou @code{None}.  Se `skipkeys' é verdadeiro, esses itens são simplesmente pulados.

Se `ensure_ascii' for verdadeiro (o padrão), a saída terá todos os caracteres não ASCII e não imprimíveis recebidos escapados. Se `ensure_ascii' for falso, todos os caracteres serão exibidos como estão, exceto os caracteres que devem ser escapados: aspas, barra invertida e os caracteres de controle U+0000 a U+001F.

Se `check_circular' é verdadeiro (o padrão), então listas, dicionários e objetos codificados personalizados serão verificados por referências circulares durante a codificação para prevenir uma recursão infinita (que iria causar uma @ref{d90,,RecursionError}). Caso contrário, nenhuma verificação será feita.

Se `allow_nan' for verdadeiro (o padrão), então @code{NaN}, @code{Infinity}, e @code{-Infinity} serão codificados como tal. Esse comportamento não é compatível com a especificação do JSON, mas é consistente com a maioria dos codificadores e decodificadores baseados em JavaScript. Caso contrário, será levantada uma @ref{202,,ValueError} para tais pontos flutuantes.

Se `sort_keys' for verdadeiro (padrão: @code{False}), então a saída dos dicionários serão ordenados pela chave; isto é útil para testes de regressão para certificar-se que as serializações de JSON possam ser comparadas com uma base no dia a dia.

Se `indent' for um inteiro não negativo ou uma string, então elementos de um vetor JSON e membros de objetos terão uma saída formatada com este nível de indentação. Um nível de indentação 0, negativo ou @code{""} apenas colocará novas linhas. @code{None} (o padrão) seleciona a representação mais compacta. Usando um inteiro positivo a indentação terá alguns espaços por nível. Se `indent' for uma string (como @code{"\t"}), essa string será usada para indentar cada nível.


Alterado na versão 3.2: Permite strings para `indent', além de inteiros.


Se especificado, `separators' deve ser uma tupla @code{(item_separator, key_separator)}. O padrão é @code{(', ', ': ')} se `indent' for @code{None} e @code{(',', ': ')} caso contrário. Para pegar representação JSON mais compacta, você deve especificar @code{(',', ':')} para eliminar espaços em branco.


Alterado na versão 3.4: Usa @code{(',', ': ')} como padrão se `indent' não for @code{None}.


Se especificado, `default' deve ser uma função para ser chamada para objetos que não podem ser serializados de outra forma. Deve retornar uma versão codificável JSON do objeto ou levantar uma exceção @ref{2c3,,TypeError}. Se não for especificada, @ref{2c3,,TypeError} é levantada.


Alterado na versão 3.6: Todos os parâmetros agora são @ref{2a5,,somente-nomeado}.


@geindex default() (método json.JSONEncoder)
@anchor{library/json json JSONEncoder default}@anchor{388f}
@deffn {Método} default (o)

Implemente este método em uma subclasse que retorna um objeto serializável para `o' ou que chame a implementação base (para levantar uma @ref{2c3,,TypeError}).

Por exemplo, para suporte a iteradores arbitrários, você poderia implementar @ref{388f,,default()} dessa forma:

@example
def default(self, o):
   try:
       iterable = iter(o)
   except TypeError:
       pass
   else:
       return list(iterable)
   # Faz o método padrão de classe base levantar a TypeError
   return super().default(o)
@end example
@end deffn

@geindex encode() (método json.JSONEncoder)
@anchor{library/json json JSONEncoder encode}@anchor{3894}
@deffn {Método} encode (o)

Retorna uma string representando um JSON a partir da estrutura de dados Python, `o'. Por exemplo:

@example
>>> json.JSONEncoder().encode(@{"foo": ["bar", "baz"]@})
'@{"foo": ["bar", "baz"]@}'
@end example
@end deffn

@geindex iterencode() (método json.JSONEncoder)
@anchor{library/json json JSONEncoder iterencode}@anchor{3895}
@deffn {Método} iterencode (o)

Codifica o objeto dado, `o', e produz cada representação em string assim que disponível.  Por exemplo:

@example
for chunk in json.JSONEncoder().iterencode(bigobject):
    mysocket.write(chunk)
@end example
@end deffn
@end deffn

@node Exceções<17>,Conformidade e interoperabilidade entre padrões,Codificadores e decodificadores,json — Codificador e decodificador JSON
@anchor{library/json exceptions}@anchor{3896}
@subsubsection Exceções


@geindex JSONDecodeError
@anchor{library/json json JSONDecodeError}@anchor{e4d}
@deffn {Exceção} json.JSONDecodeError (msg, doc, pos)

Subclasse de @ref{202,,ValueError} com os seguintes atributos adicionais:

@geindex msg (atributo json.JSONDecodeError)
@anchor{library/json json JSONDecodeError msg}@anchor{3897}
@deffn {Atributo} msg

A mensagem de erro não formatada.
@end deffn

@geindex doc (atributo json.JSONDecodeError)
@anchor{library/json json JSONDecodeError doc}@anchor{3898}
@deffn {Atributo} doc

O documento JSON sendo analisado.
@end deffn

@geindex pos (atributo json.JSONDecodeError)
@anchor{library/json json JSONDecodeError pos}@anchor{3899}
@deffn {Atributo} pos

O índice inicial de `doc' em que a análise falhou.
@end deffn

@geindex lineno (atributo json.JSONDecodeError)
@anchor{library/json json JSONDecodeError lineno}@anchor{389a}
@deffn {Atributo} lineno

A linha correspondente a `pos'.
@end deffn

@geindex colno (atributo json.JSONDecodeError)
@anchor{library/json json JSONDecodeError colno}@anchor{389b}
@deffn {Atributo} colno

A coluna correspondente a `pos'.
@end deffn


Adicionado na versão 3.5.

@end deffn

@node Conformidade e interoperabilidade entre padrões,Interface de linha de comando<5>,Exceções<17>,json — Codificador e decodificador JSON
@anchor{library/json standard-compliance-and-interoperability}@anchor{389c}
@subsubsection Conformidade e interoperabilidade entre padrões


O formato JSON é especificado pela 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} e por ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/}. Esta seção detalha o nível de conformidade deste módulo com a RFC. Para simplificar, as subclasses @ref{d69,,JSONEncoder} e @ref{d6a,,JSONDecoder}, e outros parâmetros além daqueles explicitamente mencionados, não são considerados.

Este módulo não está em conformidade com a RFC de forma estrita, implementando algumas extensões que são JavaScript válidas, mas não JSON válido. Em particular:


@itemize -

@item 
Os valores de números infinitos e NaN são aceitos e produzidos;

@item 
Nomes repetidos em um objeto são aceitos e apenas o valor do último par nome-valor é usado.
@end itemize

Uma vez que a RFC permite que os analisadores compatíveis com a RFC aceitem textos de entrada que não sejam compatíveis com a RFC, o desserializador deste módulo é tecnicamente compatível com a RFC nas configurações padrão.

@menu
* Codificações de caracteres:: 
* Valores numéricos infinitos e NaN:: 
* Nomes repetidos dentro de um objeto:: 
* Valores não objeto e não vetor de nível superior:: 
* Limitações de implementação:: 

@end menu

@node Codificações de caracteres,Valores numéricos infinitos e NaN,,Conformidade e interoperabilidade entre padrões
@anchor{library/json character-encodings}@anchor{389d}
@subsubsection Codificações de caracteres


A RFC requer que JSON seja representado usando UTF-8, UTF-16 ou UTF-32, com UTF-8 sendo o padrão recomendado para interoperabilidade máxima.

Conforme permitido, embora não exigido, pela RFC, o serializador deste módulo define `ensure_ascii=True' por padrão, escapando a saída para que as strings resultantes contenham apenas caracteres ASCII imprimíveis.

Além do parâmetro `ensure_ascii', este módulo é definido estritamente em termos de conversão entre objetos Python e @ref{44c,,strings Unicode} e, portanto, não aborda diretamente o problema de codificação de caracteres.

A RFC proíbe adicionar uma marca de ordem de byte (do inglês `byte order mark' - BOM) ao início de um texto JSON, e o serializador deste módulo não adiciona um BOM à sua saída. A RFC permite, mas não exige, que os desserializadores JSON ignorem um BOM inicial em sua entrada. O desserializador deste módulo levanta uma @ref{202,,ValueError} quando um BOM inicial está presente.

A RFC não proíbe explicitamente as strings JSON que contêm sequências de bytes que não correspondem a caracteres Unicode válidos (por exemplo, substitutos UTF-16 não emparelhados), mas observa que podem causar problemas de interoperabilidade. Por padrão, este módulo aceita e produz (quando presente no original @ref{44c,,str}) pontos de código para tais sequências.

@node Valores numéricos infinitos e NaN,Nomes repetidos dentro de um objeto,Codificações de caracteres,Conformidade e interoperabilidade entre padrões
@anchor{library/json infinite-and-nan-number-values}@anchor{389e}
@subsubsection Valores numéricos infinitos e NaN


A RFC não permite a representação de valores infinitos ou numéricos NaN. Apesar disso, por padrão, este módulo aceita e produz @code{Infinity}, @code{-Infinity} e @code{NaN} como se fossem valores literais de número JSON válidos:

@example
>>> # Nenhuma dessas chamadas levanta uma exceção, mas os resultados não são JSON válidos
>>> json.dumps(float('-inf'))
'-Infinity'
>>> json.dumps(float('nan'))
'NaN'
>>> # Same when deserializing
>>> json.loads('-Infinity')
-inf
>>> json.loads('NaN')
nan
@end example

No serializador, o parâmetro `allow_nan' pode ser usado para alterar esse comportamento. No desserializador, o parâmetro `parse_constant' pode ser usado para alterar esse comportamento.

@node Nomes repetidos dentro de um objeto,Valores não objeto e não vetor de nível superior,Valores numéricos infinitos e NaN,Conformidade e interoperabilidade entre padrões
@anchor{library/json repeated-names-within-an-object}@anchor{389f}
@subsubsection Nomes repetidos dentro de um objeto


A RFC especifica que os nomes em um objeto JSON devem ser exclusivos, mas não determina como os nomes repetidos em objetos JSON devem ser tratados. Por padrão, este módulo não levanta uma exceção; em vez disso, ele ignora tudo, exceto o último par nome-valor para um determinado nome:

@example
>>> weird_json = '@{"x": 1, "x": 2, "x": 3@}'
>>> json.loads(weird_json)
@{'x': 3@}
@end example

O parâmetro `object_pairs_hook' pode ser usado para alterar este comportamento.

@node Valores não objeto e não vetor de nível superior,Limitações de implementação,Nomes repetidos dentro de um objeto,Conformidade e interoperabilidade entre padrões
@anchor{library/json top-level-non-object-non-array-values}@anchor{38a0}
@subsubsection Valores não objeto e não vetor de nível superior


A versão antiga de JSON especificada pela obsoleta 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html} exige que o valor de nível superior do texto JSON deve ser do tipo object ou array (@ref{256,,dict} ou @ref{611,,list} Python), e não poderia ser dos tipos null, boolean, number ou string. 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} removeu essa restrição, e esse módulo não tem nenhuma implementação que faça essa restrição, seja em seus serializadores, sejam nos desserializadores.

Independentemente, para máxima interoperabilidade, você pode querer aderir voluntariamente à restrição.

@node Limitações de implementação,,Valores não objeto e não vetor de nível superior,Conformidade e interoperabilidade entre padrões
@anchor{library/json implementation-limitations}@anchor{38a1}
@subsubsection Limitações de implementação


Algumas implementações de desserializadores JSON podem definir limites em:


@itemize *

@item 
o tamanho de textos JSON aceitos

@item 
o nível máximo de aninhamento de objetos e vetores JSON

@item 
o intervalo e a precisão de números JSON

@item 
o conteúdo e o tamanho máximo de strings JSON
@end itemize

Esse módulo não impõe nenhum limite além daqueles já colocados pelas estruturas de dados Python ou pelo interpretador Python em si.

Quando serializando para JSON, tenha cuidado com qualquer limitação nas aplicações que irão consumir seu JSON. Em particular, é comum para números JSON serem desserializados com números de precisão dupla definida em IEEE 754 e, portanto, sujeito a limitações de precisão e de intervalo da representação. Isso é especialmente relevante quando serializando valores Python @ref{257,,int} de magnitude extremamente grande, ou quando  serializando instâncias de tipos numéricos “exóticos” como @ref{29d,,decimal.Decimal}.

@node Interface de linha de comando<5>,,Conformidade e interoperabilidade entre padrões,json — Codificador e decodificador JSON
@anchor{library/json command-line-interface}@anchor{38a2}@anchor{library/json json-commandline}@anchor{388c}@anchor{library/json module-json tool}@anchor{83}
@subsubsection Interface de linha de comando


@geindex module; json.tool

`Código-fonte:' Lib/json/tool.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/json/tool.py}


__________________________________________________________________


O módulo @ref{83,,json.tool} fornece uma interface de linha de comando simples para validação e embelezamento de saída para objetos JSON.

Se os argumentos opcionais @code{infile} e @code{outfile} não forem especificados, @ref{53d,,sys.stdin} e @ref{ae6,,sys.stdout} serão usados respectivamente:

@example
$ echo '@{"json": "obj"@}' | python -m json.tool
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json.tool
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example


Alterado na versão 3.5: A saída agora está na mesma ordem da entrada. Use a opção @ref{38a3,,--sort-keys} para ordenar a saída de dicionários alfabeticamente pela chave.


@menu
* Opções da linha de comando:: 

@end menu

@node Opções da linha de comando,,,Interface de linha de comando<5>
@anchor{library/json command-line-options}@anchor{38a4}
@subsubsection Opções da linha de comando


@geindex json.tool opção de linha de comando; infile
@anchor{library/json cmdoption-json tool-arg-infile}@anchor{38a5}
@deffn {Option} infile

O arquivo JSON para ser validado ou saída embelezada:

@example
$ python -m json.tool mp_films.json
[
    @{
        "title": "And Now for Something Completely Different",
        "year": 1971
    @},
    @{
        "title": "Monty Python and the Holy Grail",
        "year": 1975
    @}
]
@end example

Se `infile' não é especificado, lê de @ref{53d,,sys.stdin}.
@end deffn

@geindex json.tool opção de linha de comando; outfile
@anchor{library/json cmdoption-json tool-arg-outfile}@anchor{38a6}
@deffn {Option} outfile

Escreve a saída de `infile' para o `outfile' dado. Caso contrário, escreve em @ref{ae6,,sys.stdout}.
@end deffn

@geindex json.tool opção de linha de comando; --sort-keys
@anchor{library/json cmdoption-json tool-sort-keys}@anchor{38a3}
@deffn {Option} @w{-}@w{-}sort@w{-}keys

Ordena a saída de dicionários alfabeticamente pela chave.


Adicionado na versão 3.5.

@end deffn

@geindex json.tool opção de linha de comando; --no-ensure-ascii
@anchor{library/json cmdoption-json tool-no-ensure-ascii}@anchor{38a7}
@deffn {Option} @w{-}@w{-}no@w{-}ensure@w{-}ascii

Desabilita escape de caracteres não-ascii, veja @ref{d68,,json.dumps()} para mais informações.


Adicionado na versão 3.9.

@end deffn

@geindex json.tool opção de linha de comando; --json-lines
@anchor{library/json cmdoption-json tool-json-lines}@anchor{38a8}
@deffn {Option} @w{-}@w{-}json@w{-}lines

Analisa cada linha da entrada como um objeto JSON separado.


Adicionado na versão 3.8.

@end deffn

@geindex json.tool opção de linha de comando; --indent
@geindex json.tool opção de linha de comando; --tab
@geindex json.tool opção de linha de comando; --no-indent
@geindex json.tool opção de linha de comando; --compact
@anchor{library/json cmdoption-json tool-indent}@anchor{38a9}@anchor{library/json cmdoption-json tool-tab}@anchor{38aa}@anchor{library/json cmdoption-json tool-no-indent}@anchor{38ab}@anchor{library/json cmdoption-json tool-compact}@anchor{38ac}
@deffn {Option} @w{-}@w{-}indent, @w{-}@w{-}tab, @w{-}@w{-}no@w{-}indent, @w{-}@w{-}compact

Opções mutualmente exclusivas para controle de espaços em branco.


Adicionado na versão 3.9.

@end deffn

@geindex json.tool opção de linha de comando; -h
@geindex json.tool opção de linha de comando; --help
@anchor{library/json cmdoption-json tool-h}@anchor{38ad}@anchor{library/json cmdoption-json tool-help}@anchor{38ae}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Exibe a mensagem de ajuda.
@end deffn

@node mailbox — Manipule caixas de entradas em vários formatos,mimetypes — Mapeia nomes de arquivos para tipos MIME,json — Codificador e decodificador JSON,Manuseio de Dados na Internet
@anchor{library/mailbox doc}@anchor{38af}@anchor{library/mailbox mailbox-manipulate-mailboxes-in-various-formats}@anchor{38b0}@anchor{library/mailbox module-mailbox}@anchor{8b}@anchor{library/mailbox translation-repo}@anchor{38b1}
@subsection @code{mailbox} — Manipule caixas de entradas em vários formatos


@geindex module; mailbox

`Código-fonte:' Lib/mailbox.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/mailbox.py}


__________________________________________________________________


Este módulo define duas classes, @ref{128e,,Mailbox} e @ref{1292,,Message}, para acessar e manipular caixas de correio em disco e as mensagens que elas contêm. @code{Mailbox} oferece um mapeamento semelhante a um dicionário de chaves para mensagens. @code{Message} estende a classe @ref{27c,,Message} do módulo @ref{44,,email.message} com estado e comportamento específicos para cada formato. Os formatos de caixa de correio suportados são Maildir, mbox, MH, Babyl e MMDF.


@subsubheading Ver também



@table @asis

@item Módulo @ref{3b,,email}

Representa e manipula mensagens.
@end table


@menu
* Objetos Mailbox:: 
* Message objects:: 
* Exceções: Exceções<18>. 
* Exemplos: Exemplos<23>. 

@end menu

@node Objetos Mailbox,Message objects,,mailbox — Manipule caixas de entradas em vários formatos
@anchor{library/mailbox id1}@anchor{38b2}@anchor{library/mailbox mailbox-objects}@anchor{38b3}
@subsubsection Objetos @code{Mailbox}


@geindex Mailbox (classe em mailbox)
@anchor{library/mailbox mailbox Mailbox}@anchor{128e}
@deffn {Classe} mailbox.Mailbox

Uma caixa de correio, que pode ser inspecionada e modificada.

A classe @code{Mailbox} define uma interface e não deve ser instanciada. Em vez disso, subclasses específicas de cada formato devem herdar de @code{Mailbox} e seu código deve instanciar uma subclasse específica.

A interface @code{Mailbox} é semelhante a um dicionário, com pequenas chaves correspondentes às mensagens. As chaves são emitidas pela instância de @code{Mailbox} com a qual serão usadas e só têm significado para essa instância de @code{Mailbox}. Uma chave continua a identificar uma mensagem mesmo que a mensagem correspondente seja modificada, por exemplo, ao ser substituída por outra mensagem.

As mensagens podem ser adicionadas a uma instância de @code{Mailbox} usando o método semelhante a um conjunto @ref{128d,,add()} e removidas usando uma instrução @code{del} ou os métodos semelhantes a conjuntos @ref{38b4,,remove()} e @ref{38b5,,discard()}.

A semântica da interface @code{Mailbox} difere da semântica de dicionário em alguns aspectos importantes. Cada vez que uma mensagem é solicitada, uma nova representação (normalmente uma instância de @ref{1292,,Message}) é gerada com base no estado atual da caixa de correio. Da mesma forma, quando uma mensagem é adicionada a uma instância de @code{Mailbox}, o conteúdo da representação da mensagem fornecida é copiado. Em nenhum dos casos a instância de @code{Mailbox} mantém uma referência à representação da mensagem.

O @ref{1ac,,iterador} padrão de @code{Mailbox} itera sobre representações de mensagens, e não sobre chaves como o iterador padrão de @ref{256,,dicionário}. Além disso, a modificação de uma caixa de correio durante a iteração é segura e bem definida. Mensagens adicionadas à caixa de correio após a criação de um iterador não serão vistas pelo iterador. Mensagens removidas da caixa de correio antes que o iterador as produza serão ignoradas silenciosamente, embora o uso de uma chave de um iterador possa resultar em uma exceção @ref{344,,KeyError} se a mensagem correspondente for posteriormente removida.

@cartouche
@quotation Aviso 
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{41c,,Maildir}; try to avoid using single-file formats such as
@ref{1775,,mbox} for
concurrent writing.  If you’re modifying a mailbox, you `must' lock it by
calling the @ref{38b6,,lock()} and @ref{38b7,,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 mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox add}@anchor{128d}
@deffn {Método} add (message)

Add `message' to the mailbox and return the key that has been assigned to
it.

Parameter `message' may be a @ref{1292,,Message} instance, an
@ref{27c,,email.message.Message} instance, a string, a byte string, or a
file-like object (which should be open in binary mode). If `message' is
an instance of the
appropriate format-specific @ref{1292,,Message} subclass (e.g., if it’s an
@ref{3771,,mboxMessage} instance and this is an @ref{1775,,mbox} instance), its
format-specific information is used. Otherwise, reasonable defaults for
format-specific information are used.


Alterado na versão 3.2: Support for binary input was added.

@end deffn

@geindex remove() (método mailbox.Mailbox)
@geindex __delitem__() (método mailbox.Mailbox)
@geindex discard() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox remove}@anchor{38b4}
@deffn {Método} remove (key)
@anchor{library/mailbox mailbox Mailbox __delitem__}@anchor{38b8}
@deffnx {Método} __delitem__ (key)
@anchor{library/mailbox mailbox Mailbox discard}@anchor{38b5}
@deffnx {Método} discard (key)

Delete the message corresponding to `key' from the mailbox.

If no such message exists, a @ref{344,,KeyError} exception is raised if the
method was called as @ref{38b4,,remove()} or @ref{38b8,,__delitem__()} but no
exception is raised if the method was called as @ref{38b5,,discard()}. The
behavior of @ref{38b5,,discard()} may be preferred if the underlying mailbox
format supports concurrent modification by other processes.
@end deffn

@geindex __setitem__() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __setitem__}@anchor{38b9}
@deffn {Método} __setitem__ (key, message)

Replace the message corresponding to `key' with `message'. Raise a
@ref{344,,KeyError} exception if no message already corresponds to `key'.

As with @ref{128d,,add()}, parameter `message' may be a @ref{1292,,Message}
instance, an @ref{27c,,email.message.Message} instance, a string, a byte
string, or a file-like object (which should be open in binary mode). If
`message' is an
instance of the appropriate format-specific @ref{1292,,Message} subclass
(e.g., if it’s an @ref{3771,,mboxMessage} instance and this is an
@ref{1775,,mbox} instance), its format-specific information is
used. Otherwise, the format-specific information of the message that
currently corresponds to `key' is left unchanged.
@end deffn

@geindex iterkeys() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox iterkeys}@anchor{38ba}
@deffn {Método} iterkeys ()

Return an @ref{1ac,,iterator} over all keys
@end deffn

@geindex keys() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox keys}@anchor{38bb}
@deffn {Método} keys ()

The same as @ref{38ba,,iterkeys()}, except that a @ref{611,,list} is returned
rather than an @ref{1ac,,iterator}
@end deffn

@geindex itervalues() (método mailbox.Mailbox)
@geindex __iter__() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox itervalues}@anchor{38bc}
@deffn {Método} itervalues ()
@anchor{library/mailbox mailbox Mailbox __iter__}@anchor{38bd}
@deffnx {Método} __iter__ ()

Return an @ref{1ac,,iterator} over representations of all messages.
The messages are represented
as instances of the appropriate format-specific @ref{1292,,Message} subclass
unless a custom message factory was specified when the @code{Mailbox}
instance was initialized.

@cartouche
@quotation Nota 
The behavior of @ref{38bd,,__iter__()} is unlike that of dictionaries, which
iterate over keys.
@end quotation
@end cartouche
@end deffn

@geindex values() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox values}@anchor{38be}
@deffn {Método} values ()

The same as @ref{38bc,,itervalues()}, except that a @ref{611,,list} is returned
rather than an @ref{1ac,,iterator}
@end deffn

@geindex iteritems() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox iteritems}@anchor{38bf}
@deffn {Método} iteritems ()

Return an @ref{1ac,,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{1292,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex items() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox items}@anchor{38c0}
@deffn {Método} items ()

The same as @ref{38bf,,iteritems()}, except that a @ref{611,,list} of pairs is
returned rather than an @ref{1ac,,iterator} of pairs.
@end deffn

@geindex get() (método mailbox.Mailbox)
@geindex __getitem__() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get}@anchor{38c1}
@deffn {Método} get (key, default=None)
@anchor{library/mailbox mailbox Mailbox __getitem__}@anchor{38c2}
@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{38c1,,get()} and a @ref{344,,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{1292,,Message} subclass unless a
custom message factory was specified when the @code{Mailbox} instance
was initialized.
@end deffn

@geindex get_message() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_message}@anchor{38c3}
@deffn {Método} get_message (key)

Return a representation of the message corresponding to `key' as an
instance of the appropriate format-specific @ref{1292,,Message} subclass, or
raise a @ref{344,,KeyError} exception if no such message exists.
@end deffn

@geindex get_bytes() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_bytes}@anchor{1290}
@deffn {Método} get_bytes (key)

Return a byte representation of the message corresponding to `key', or
raise a @ref{344,,KeyError} exception if no such message exists.


Adicionado na versão 3.2.

@end deffn

@geindex get_string() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_string}@anchor{1291}
@deffn {Método} get_string (key)

Return a string representation of the message corresponding to `key', or
raise a @ref{344,,KeyError} exception if no such message exists.  The
message is processed through @ref{27c,,email.message.Message} to
convert it to a 7bit clean representation.
@end deffn

@geindex get_file() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox get_file}@anchor{128f}
@deffn {Método} get_file (key)

Return a @ref{15cf,,file-like} representation of the
message corresponding to `key',
or raise a @ref{344,,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.


Alterado na versão 3.2: The file object really is a @ref{1e0e,,binary file}; previously it was
incorrectly returned in text mode.  Also, the @ref{15cf,,file-like object}
now supports the @ref{5d4,,context manager} protocol: you can use a
@ref{5d2,,with} statement to automatically close it.


@cartouche
@quotation Nota 
Unlike other representations of messages,
@ref{15cf,,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 mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __contains__}@anchor{38c4}
@deffn {Método} __contains__ (key)

Return @code{True} if `key' corresponds to a message, @code{False} otherwise.
@end deffn

@geindex __len__() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox __len__}@anchor{38c5}
@deffn {Método} __len__ ()

Return a count of messages in the mailbox.
@end deffn

@geindex clear() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox clear}@anchor{38c6}
@deffn {Método} clear ()

Delete all messages from the mailbox.
@end deffn

@geindex pop() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox pop}@anchor{38c7}
@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{1292,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex popitem() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox popitem}@anchor{38c8}
@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{344,,KeyError} exception. The
message is represented as an instance of the appropriate format-specific
@ref{1292,,Message} subclass unless a custom message factory was specified
when the @code{Mailbox} instance was initialized.
@end deffn

@geindex update() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox update}@anchor{38c9}
@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{38b9,,__setitem__()}. As with @ref{38b9,,__setitem__()},
each `key' must already correspond to a message in the mailbox or else a
@ref{344,,KeyError} exception will be raised, so in general it is incorrect
for `arg' to be a @code{Mailbox} instance.

@cartouche
@quotation Nota 
Unlike with dictionaries, keyword arguments are not supported.
@end quotation
@end cartouche
@end deffn

@geindex flush() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox flush}@anchor{1738}
@deffn {Método} flush ()

Write any pending changes to the filesystem. For some @ref{128e,,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 mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox lock}@anchor{38b6}
@deffn {Método} lock ()

Acquire an exclusive advisory lock on the mailbox so that other processes
know not to modify it. An @ref{38ca,,ExternalClashError} is raised if the lock
is not available. The particular locking mechanisms used depend upon the
mailbox format.  You should `always' lock the mailbox before making any
modifications to its contents.
@end deffn

@geindex unlock() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox unlock}@anchor{38b7}
@deffn {Método} unlock ()

Release the lock on the mailbox, if any.
@end deffn

@geindex close() (método mailbox.Mailbox)
@anchor{library/mailbox mailbox Mailbox close}@anchor{38cb}
@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,,Objetos Mailbox
@anchor{library/mailbox mailbox-maildir}@anchor{38cc}@anchor{library/mailbox maildir-objects}@anchor{38cd}
@subsubsection @code{Maildir} objects


@geindex Maildir (classe em mailbox)
@anchor{library/mailbox mailbox Maildir}@anchor{41c}
@deffn {Classe} mailbox.Maildir (dirname, factory=None, create=True)

A subclass of @ref{128e,,Mailbox} for mailboxes in Maildir format. Parameter
`factory' is a callable object that accepts a file-like message representation
(which behaves as if opened in binary mode) and returns a custom representation.
If `factory' is @code{None}, @ref{38ce,,MaildirMessage} is used as the default message
representation. If `create' is @code{True}, the mailbox is created if it does not
exist.

If `create' is @code{True} and the `dirname' path exists, it will be treated as
an existing maildir without attempting to verify its directory layout.

It is for historical reasons that `dirname' is named as such rather than `path'.

Maildir is a directory-based mailbox format invented for the qmail mail
transfer agent and now widely supported by other programs. Messages in a
Maildir mailbox are stored in separate files within a common directory
structure. This design allows Maildir mailboxes to be accessed and modified
by multiple unrelated programs without data corruption, so file locking is
unnecessary.

Maildir mailboxes contain three subdirectories, namely: @code{tmp},
@code{new}, and @code{cur}. Messages are created momentarily in the
@code{tmp} subdirectory and then moved to the @code{new} subdirectory to
finalize delivery. A mail user agent may subsequently move the message to the
@code{cur} subdirectory and store information about the state of the message
in a special “info” section appended to its file name.

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 mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir colon}@anchor{38cf}
@deffn {Atributo} colon

The Maildir specification requires the use of a colon (@code{':'}) in certain
message file names. However, some operating systems do not permit this
character in file names, If you wish to use a Maildir-like format on such
an operating system, you should specify another character to use
instead. The exclamation point (@code{'!'}) is a popular choice. For
example:

@example
import mailbox
mailbox.Maildir.colon = '!'
@end example

The @code{colon} attribute may also be set on a per-instance basis.
@end deffn


Alterado na versão 3.13: @ref{41c,,Maildir} now ignores files with a leading dot.


@code{Maildir} instances have all of the methods of @ref{128e,,Mailbox} in
addition to the following:

@geindex list_folders() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir list_folders}@anchor{38d0}
@deffn {Método} list_folders ()

Return a list of the names of all folders.
@end deffn

@geindex get_folder() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_folder}@anchor{38d1}
@deffn {Método} get_folder (folder)

Return a @code{Maildir} instance representing the folder whose name is
`folder'. A @ref{38d2,,NoSuchMailboxError} exception is raised if the folder
does not exist.
@end deffn

@geindex add_folder() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add_folder}@anchor{38d3}
@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 mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir remove_folder}@anchor{38d4}
@deffn {Método} remove_folder (folder)

Delete the folder whose name is `folder'. If the folder contains any
messages, a @ref{38d5,,NotEmptyError} exception will be raised and the folder
will not be deleted.
@end deffn

@geindex clean() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir clean}@anchor{38d6}
@deffn {Método} clean ()

Delete temporary files from the mailbox that have not been accessed in the
last 36 hours. The Maildir specification says that mail-reading programs
should do this occasionally.
@end deffn

@geindex get_flags() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_flags}@anchor{17c4}
@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{38ce,,MaildirMessage} object, use
its @ref{38d7,,get_flags()} method instead, because
changes made by the message’s @ref{38d8,,set_flags()},
@ref{38d9,,add_flag()} and @ref{38da,,remove_flag()}
methods are not reflected here until the mailbox’s
@ref{38db,,__setitem__()} method is called.


Adicionado na versão 3.13.

@end deffn

@geindex set_flags() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir set_flags}@anchor{17c5}
@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{38ce,,MaildirMessage} object, use
its @ref{38d8,,set_flags()} method instead, because
changes made with this mailbox method will not be visible to the
message object’s method, @ref{38d7,,get_flags()}.


Adicionado na versão 3.13.

@end deffn

@geindex add_flag() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add_flag}@anchor{17c6}
@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{38d9,,add_flag()} method are similar to
those for @ref{17c5,,set_flags()}; see the discussion there.


Adicionado na versão 3.13.

@end deffn

@geindex remove_flag() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir remove_flag}@anchor{17c7}
@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{38da,,remove_flag()} method are similar to
those for @ref{17c5,,set_flags()}; see the discussion there.


Adicionado na versão 3.13.

@end deffn

@geindex get_info() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_info}@anchor{17c2}
@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{38ce,,MaildirMessage} object, use
its @ref{38dc,,get_info()} method instead, because
changes made by the message’s @ref{38dd,,set_info()} method
are not reflected here until the mailbox’s @ref{38db,,__setitem__()} method
is called.


Adicionado na versão 3.13.

@end deffn

@geindex set_info() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir set_info}@anchor{17c3}
@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{38ce,,MaildirMessage} object, use
its @ref{38dd,,set_info()} method instead, because
changes made with this mailbox method will not be visible to the
message object’s method, @ref{38dc,,get_info()}.


Adicionado na versão 3.13.

@end deffn

Some @ref{128e,,Mailbox} methods implemented by @code{Maildir} deserve special
remarks:

@geindex add() (método mailbox.Maildir)
@geindex __setitem__() (método mailbox.Maildir)
@geindex update() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir add}@anchor{38de}
@deffn {Método} add (message)
@anchor{library/mailbox mailbox Maildir __setitem__}@anchor{38db}
@deffnx {Método} __setitem__ (key, message)
@anchor{library/mailbox mailbox Maildir update}@anchor{38df}
@deffnx {Método} update (arg)

@cartouche
@quotation Aviso 
These methods generate unique file names based upon the current process
ID. When using multiple threads, undetected name clashes may occur and
cause corruption of the mailbox unless threads are coordinated to avoid
using these methods to manipulate the same mailbox simultaneously.
@end quotation
@end cartouche
@end deffn

@geindex flush() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir flush}@anchor{38e0}
@deffn {Método} flush ()

All changes to Maildir mailboxes are immediately applied, so this method
does nothing.
@end deffn

@geindex lock() (método mailbox.Maildir)
@geindex unlock() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir lock}@anchor{38e1}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox Maildir unlock}@anchor{38e2}
@deffnx {Método} unlock ()

Maildir mailboxes do not support (or require) locking, so these methods do
nothing.
@end deffn

@geindex close() (método mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir close}@anchor{38e3}
@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 mailbox.Maildir)
@anchor{library/mailbox mailbox Maildir get_file}@anchor{38e4}
@deffn {Método} get_file (key)

Depending upon the host platform, it may not be possible to modify or
remove the underlying message while the returned file remains open.
@end deffn
@end deffn


@subsubheading Ver também



@table @asis

@item maildir man page from Courier@footnote{https://www.courier-mta.org/maildir.html}

A specification of the format. Describes a common extension for
supporting folders.

@item Using maildir format@footnote{https://cr.yp.to/proto/maildir.html}

Notes on Maildir by its inventor. Includes an updated name-creation scheme and
details on “info” semantics.
@end table


@node mbox objects,MH objects,Maildir objects,Objetos Mailbox
@anchor{library/mailbox mailbox-mbox}@anchor{38e5}@anchor{library/mailbox mbox-objects}@anchor{38e6}
@subsubsection @code{mbox} objects


@geindex mbox (classe em mailbox)
@anchor{library/mailbox mailbox mbox}@anchor{1775}
@deffn {Classe} mailbox.mbox (path, factory=None, create=True)

A subclass of @ref{128e,,Mailbox} for mailboxes in mbox format. Parameter `factory'
is a callable object that accepts a file-like message representation (which
behaves as if opened in binary mode) and returns a custom representation. If
`factory' is @code{None}, @ref{3771,,mboxMessage} is used as the default message
representation. If `create' is @code{True}, the mailbox is created if it does not
exist.

The mbox format is the classic format for storing mail on Unix systems. All
messages in an mbox mailbox are stored in a single file with the beginning of
each message indicated by a line whose first five characters are “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{128e,,Mailbox} methods implemented by @code{mbox} deserve special
remarks:

@geindex get_bytes() (método mailbox.mbox)
@anchor{library/mailbox mailbox mbox get_bytes}@anchor{38e7}
@deffn {Método} get_bytes (key, from_=False)

Note: This method has an extra parameter (`from_') compared with other classes.
The first line of an mbox file entry is the Unix “From “ line.
If `from_' is False, the first line of the file is dropped.
@end deffn

@geindex get_file() (método mailbox.mbox)
@anchor{library/mailbox mailbox mbox get_file}@anchor{38e8}
@deffn {Método} get_file (key, from_=False)

Using the file after calling @ref{1738,,flush()} or
@ref{38cb,,close()} on the @code{mbox} instance may yield
unpredictable results or raise an exception.

Note: This method has an extra parameter (`from_') compared with other classes.
The first line of an mbox file entry is the Unix “From “ line.
If `from_' is False, the first line of the file is dropped.
@end deffn

@geindex get_string() (método mailbox.mbox)
@anchor{library/mailbox mailbox mbox get_string}@anchor{38e9}
@deffn {Método} get_string (key, from_=False)

Note: This method has an extra parameter (`from_') compared with other classes.
The first line of an mbox file entry is the Unix “From “ line.
If `from_' is False, the first line of the file is dropped.
@end deffn

@geindex lock() (método mailbox.mbox)
@geindex unlock() (método mailbox.mbox)
@anchor{library/mailbox mailbox mbox lock}@anchor{38ea}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox mbox unlock}@anchor{38eb}
@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 também



@table @asis

@item mbox man page from tin@footnote{http://www.tin.org/bin/man.cgi?section=5&topic=mbox}

A specification of the format, with details on locking.

@item Configuring Netscape Mail on Unix: Why The Content-Length Format is Bad@footnote{https://www.jwz.org/doc/content-length.html}

An argument for using the original mbox format rather than a variation.

@item "mbox" is a family of several mutually incompatible mailbox formats@footnote{https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml}

A history of mbox variations.
@end table


@node MH objects,Babyl objects,mbox objects,Objetos Mailbox
@anchor{library/mailbox mailbox-mh}@anchor{38ec}@anchor{library/mailbox mh-objects}@anchor{38ed}
@subsubsection @code{MH} objects


@geindex MH (classe em mailbox)
@anchor{library/mailbox mailbox MH}@anchor{17a9}
@deffn {Classe} mailbox.MH (path, factory=None, create=True)

A subclass of @ref{128e,,Mailbox} for mailboxes in MH format. Parameter `factory'
is a callable object that accepts a file-like message representation (which
behaves as if opened in binary mode) and returns a custom representation. If
`factory' is @code{None}, @ref{38ee,,MHMessage} is used as the default message
representation. If `create' is @code{True}, the mailbox is created if it does not
exist.

MH is a directory-based mailbox format invented for the MH Message Handling
System, a mail user agent. Each message in an MH mailbox resides in its own
file. An MH mailbox may contain other MH mailboxes (called `folders') in
addition to messages. Folders may be nested indefinitely. MH mailboxes also
support `sequences', which are named lists used to logically group
messages without moving them to sub-folders. Sequences are defined in a file
called @code{.mh_sequences} in each folder.

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{128e,,Mailbox} in addition
to the following:


Alterado na versão 3.13: Supported folders that don’t contain a @code{.mh_sequences} file.


@geindex list_folders() (método mailbox.MH)
@anchor{library/mailbox mailbox MH list_folders}@anchor{38ef}
@deffn {Método} list_folders ()

Return a list of the names of all folders.
@end deffn

@geindex get_folder() (método mailbox.MH)
@anchor{library/mailbox mailbox MH get_folder}@anchor{38f0}
@deffn {Método} get_folder (folder)

Return an @code{MH} instance representing the folder whose name is
`folder'. A @ref{38d2,,NoSuchMailboxError} exception is raised if the folder
does not exist.
@end deffn

@geindex add_folder() (método mailbox.MH)
@anchor{library/mailbox mailbox MH add_folder}@anchor{38f1}
@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 mailbox.MH)
@anchor{library/mailbox mailbox MH remove_folder}@anchor{38f2}
@deffn {Método} remove_folder (folder)

Delete the folder whose name is `folder'. If the folder contains any
messages, a @ref{38d5,,NotEmptyError} exception will be raised and the folder
will not be deleted.
@end deffn

@geindex get_sequences() (método mailbox.MH)
@anchor{library/mailbox mailbox MH get_sequences}@anchor{38f3}
@deffn {Método} get_sequences ()

Return a dictionary of sequence names mapped to key lists. If there are no
sequences, the empty dictionary is returned.
@end deffn

@geindex set_sequences() (método mailbox.MH)
@anchor{library/mailbox mailbox MH set_sequences}@anchor{38f4}
@deffn {Método} set_sequences (sequences)

Re-define the sequences that exist in the mailbox based upon `sequences',
a dictionary of names mapped to key lists, like returned by
@ref{38f3,,get_sequences()}.
@end deffn

@geindex pack() (método mailbox.MH)
@anchor{library/mailbox mailbox MH pack}@anchor{38f5}
@deffn {Método} pack ()

Rename messages in the mailbox as necessary to eliminate gaps in
numbering.  Entries in the sequences list are updated correspondingly.

@cartouche
@quotation Nota 
Already-issued keys are invalidated by this operation and should not be
subsequently used.
@end quotation
@end cartouche
@end deffn

Some @ref{128e,,Mailbox} methods implemented by @code{MH} deserve special
remarks:

@geindex remove() (método mailbox.MH)
@geindex __delitem__() (método mailbox.MH)
@geindex discard() (método mailbox.MH)
@anchor{library/mailbox mailbox MH remove}@anchor{38f6}
@deffn {Método} remove (key)
@anchor{library/mailbox mailbox MH __delitem__}@anchor{38f7}
@deffnx {Método} __delitem__ (key)
@anchor{library/mailbox mailbox MH discard}@anchor{38f8}
@deffnx {Método} discard (key)

These methods immediately delete the message. The MH convention of marking
a message for deletion by prepending a comma to its name is not used.
@end deffn

@geindex lock() (método mailbox.MH)
@geindex unlock() (método mailbox.MH)
@anchor{library/mailbox mailbox MH lock}@anchor{38f9}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox MH unlock}@anchor{38fa}
@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 mailbox.MH)
@anchor{library/mailbox mailbox MH get_file}@anchor{38fb}
@deffn {Método} get_file (key)

Depending upon the host platform, it may not be possible to remove the
underlying message while the returned file remains open.
@end deffn

@geindex flush() (método mailbox.MH)
@anchor{library/mailbox mailbox MH flush}@anchor{38fc}
@deffn {Método} flush ()

All changes to MH mailboxes are immediately applied, so this method does
nothing.
@end deffn

@geindex close() (método mailbox.MH)
@anchor{library/mailbox mailbox MH close}@anchor{38fd}
@deffn {Método} close ()

@code{MH} instances do not keep any open files, so this method is
equivalent to @ref{38fa,,unlock()}.
@end deffn
@end deffn


@subsubheading Ver também



@table @asis

@item nmh - Message Handling System@footnote{https://www.nongnu.org/nmh/}

Home page of @code{nmh}, an updated version of the original @code{mh}.

@item MH & nmh: Email for Users & Programmers@footnote{https://rand-mh.sourceforge.io/book/}

A GPL-licensed book on @code{mh} and @code{nmh}, with some information
on the mailbox format.
@end table


@node Babyl objects,MMDF objects,MH objects,Objetos Mailbox
@anchor{library/mailbox babyl-objects}@anchor{38fe}@anchor{library/mailbox mailbox-babyl}@anchor{38ff}
@subsubsection @code{Babyl} objects


@geindex Babyl (classe em mailbox)
@anchor{library/mailbox mailbox Babyl}@anchor{3900}
@deffn {Classe} mailbox.Babyl (path, factory=None, create=True)

A subclass of @ref{128e,,Mailbox} for mailboxes in Babyl format. Parameter
`factory' is a callable object that accepts a file-like message representation
(which behaves as if opened in binary mode) and returns a custom representation.
If `factory' is @code{None}, @ref{3901,,BabylMessage} is used as the default message
representation. If `create' is @code{True}, the mailbox is created if it does not
exist.

Babyl is a single-file mailbox format used by the Rmail mail user agent
included with Emacs. The beginning of a message is indicated by a line
containing the two characters Control-Underscore (@code{'\037'}) and Control-L
(@code{'\014'}). The end of a message is indicated by the start of the next
message or, in the case of the last message, a line containing a
Control-Underscore (@code{'\037'}) character.

Messages in a Babyl mailbox have two sets of headers, original headers and
so-called visible headers. Visible headers are typically a subset of the
original headers that have been reformatted or abridged to be more
attractive. Each message in a Babyl mailbox also has an accompanying list of
`labels', or short strings that record extra information about the
message, and a list of all user-defined labels found in the mailbox is kept
in the Babyl options section.

@code{Babyl} instances have all of the methods of @ref{128e,,Mailbox} in
addition to the following:

@geindex get_labels() (método mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl get_labels}@anchor{3902}
@deffn {Método} get_labels ()

Return a list of the names of all user-defined labels used in the mailbox.

@cartouche
@quotation Nota 
The actual messages are inspected to determine which labels exist in
the mailbox rather than consulting the list of labels in the Babyl
options section, but the Babyl section is updated whenever the mailbox
is modified.
@end quotation
@end cartouche
@end deffn

Some @ref{128e,,Mailbox} methods implemented by @code{Babyl} deserve special
remarks:

@geindex get_file() (método mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl get_file}@anchor{3903}
@deffn {Método} get_file (key)

In Babyl mailboxes, the headers of a message are not stored contiguously
with the body of the message. To generate a file-like representation, the
headers and body are copied together into an @ref{ed3,,io.BytesIO} instance,
which has an API identical to that of a
file. As a result, the file-like object is truly independent of the
underlying mailbox but does not save memory compared to a string
representation.
@end deffn

@geindex lock() (método mailbox.Babyl)
@geindex unlock() (método mailbox.Babyl)
@anchor{library/mailbox mailbox Babyl lock}@anchor{3904}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox Babyl unlock}@anchor{3905}
@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 também



@table @asis

@item Format of Version 5 Babyl Files@footnote{https://quimby.gnus.org/notes/BABYL}

A specification of the Babyl format.

@item Reading Mail with Rmail@footnote{https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html}

The Rmail manual, with some information on Babyl semantics.
@end table


@node MMDF objects,,Babyl objects,Objetos Mailbox
@anchor{library/mailbox mailbox-mmdf}@anchor{3906}@anchor{library/mailbox mmdf-objects}@anchor{3907}
@subsubsection @code{MMDF} objects


@geindex MMDF (classe em mailbox)
@anchor{library/mailbox mailbox MMDF}@anchor{1776}
@deffn {Classe} mailbox.MMDF (path, factory=None, create=True)

A subclass of @ref{128e,,Mailbox} for mailboxes in MMDF format. Parameter `factory'
is a callable object that accepts a file-like message representation (which
behaves as if opened in binary mode) and returns a custom representation. If
`factory' is @code{None}, @ref{3908,,MMDFMessage} is used as the default message
representation. If `create' is @code{True}, the mailbox is created if it does not
exist.

MMDF is a single-file mailbox format invented for the Multichannel Memorandum
Distribution Facility, a mail transfer agent. Each message is in the same
form as an mbox message but is bracketed before and after by lines containing
four Control-A (@code{'\001'}) characters. As with the mbox format, the
beginning of each message is indicated by a line whose first five characters
are “From “, but additional occurrences of “From “ are not transformed to
“>From “ when storing messages because the extra message separator lines
prevent mistaking such occurrences for the starts of subsequent messages.

Some @ref{128e,,Mailbox} methods implemented by @code{MMDF} deserve special
remarks:

@geindex get_bytes() (método mailbox.MMDF)
@anchor{library/mailbox mailbox MMDF get_bytes}@anchor{3909}
@deffn {Método} get_bytes (key, from_=False)

Note: This method has an extra parameter (`from_') compared with other classes.
The first line of an mbox file entry is the Unix “From “ line.
If `from_' is False, the first line of the file is dropped.
@end deffn

@geindex get_file() (método mailbox.MMDF)
@anchor{library/mailbox mailbox MMDF get_file}@anchor{390a}
@deffn {Método} get_file (key, from_=False)

Using the file after calling @ref{1738,,flush()} or
@ref{38cb,,close()} on the @code{MMDF} instance may yield
unpredictable results or raise an exception.

Note: This method has an extra parameter (`from_') compared with other classes.
The first line of an mbox file entry is the Unix “From “ line.
If `from_' is False, the first line of the file is dropped.
@end deffn

@geindex lock() (método mailbox.MMDF)
@geindex unlock() (método mailbox.MMDF)
@anchor{library/mailbox mailbox MMDF lock}@anchor{390b}
@deffn {Método} lock ()
@anchor{library/mailbox mailbox MMDF unlock}@anchor{390c}
@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 também



@table @asis

@item mmdf man page from tin@footnote{http://www.tin.org/bin/man.cgi?section=5&topic=mmdf}

A specification of MMDF format from the documentation of tin, a newsreader.

@item MMDF@footnote{https://en.wikipedia.org/wiki/MMDF}

A Wikipedia article describing the Multichannel Memorandum Distribution
Facility.
@end table


@node Message objects,Exceções<18>,Objetos Mailbox,mailbox — Manipule caixas de entradas em vários formatos
@anchor{library/mailbox mailbox-message-objects}@anchor{390d}@anchor{library/mailbox message-objects}@anchor{390e}
@subsubsection @code{Message} objects


@geindex Message (classe em mailbox)
@anchor{library/mailbox mailbox Message}@anchor{1292}
@deffn {Classe} mailbox.Message (message=None)

A subclass of the @ref{44,,email.message} module’s
@ref{27c,,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{27c,,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 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}-compliant message, which is read
and parsed.  Files should be open in binary mode, but text mode files
are accepted for backward compatibility.

The format-specific state and behaviors offered by subclasses vary, but in
general it is only the properties that are not specific to a particular
mailbox that are supported (although presumably the properties are specific
to a particular mailbox format). For example, file offsets for single-file
mailbox formats and file names for directory-based mailbox formats are not
retained, because they are only applicable to the original mailbox. But state
such as whether a message has been read by the user or marked as important is
retained, because it applies to the message itself.

There is no requirement that @code{Message} instances be used to represent
messages retrieved using @ref{128e,,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{390f}@anchor{library/mailbox maildirmessage-objects}@anchor{3910}
@subsubsection @code{MaildirMessage} objects


@geindex MaildirMessage (classe em mailbox)
@anchor{library/mailbox mailbox MaildirMessage}@anchor{38ce}
@deffn {Classe} mailbox.MaildirMessage (message=None)

A message with Maildir-specific behaviors. Parameter `message' has the same
meaning as with the @ref{1292,,Message} constructor.

Typically, a mail user agent application moves all of the messages in the
@code{new} subdirectory to the @code{cur} subdirectory after the first time
the user opens and closes the mailbox, recording that the messages are old
whether or not they’ve actually been read. Each message in @code{cur} has an
“info” section added to its file name to store information about its state.
(Some mail readers may also add an “info” section to messages in
@code{new}.)  The “info” section may take one of two forms: it may contain
“2,” followed by a list of standardized flags (e.g., “2,FR”) or it may
contain “1,” followed by so-called experimental information. Standard flags
for Maildir messages are as follows:


@multitable {xxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@tab

Explicação

@item

D

@tab

Draft

@tab

Under composition

@item

F

@tab

Flagged

@tab

Marked as important

@item

P

@tab

Passed

@tab

Forwarded, resent, or bounced

@item

R

@tab

Replied

@tab

Replied to

@item

S

@tab

Seen

@tab

Read

@item

T

@tab

Trashed

@tab

Marked for subsequent deletion

@end multitable


@code{MaildirMessage} instances offer the following methods:

@geindex get_subdir() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_subdir}@anchor{3911}
@deffn {Método} get_subdir ()

Return either “new” (if the message should be stored in the @code{new}
subdirectory) or “cur” (if the message should be stored in the @code{cur}
subdirectory).

@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 mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_subdir}@anchor{3912}
@deffn {Método} set_subdir (subdir)

Set the subdirectory the message should be stored in. Parameter `subdir'
must be either “new” or “cur”.
@end deffn

@geindex get_flags() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_flags}@anchor{38d7}
@deffn {Método} get_flags ()

Return a string specifying the flags that are currently set. If the
message complies with the standard Maildir format, the result is the
concatenation in alphabetical order of zero or one occurrence of each of
@code{'D'}, @code{'F'}, @code{'P'}, @code{'R'}, @code{'S'}, and @code{'T'}. The empty string
is returned if no flags are set or if “info” contains experimental
semantics.
@end deffn

@geindex set_flags() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_flags}@anchor{38d8}
@deffn {Método} set_flags (flags)

Set the flags specified by `flags' and unset all others.
@end deffn

@geindex add_flag() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage add_flag}@anchor{38d9}
@deffn {Método} add_flag (flag)

Set the flag(s) 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. The current “info” is overwritten whether or not it contains
experimental information rather than flags.
@end deffn

@geindex remove_flag() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage remove_flag}@anchor{38da}
@deffn {Método} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' maybe a string of more than
one character.  If “info” contains experimental information rather than
flags, the current “info” is not modified.
@end deffn

@geindex get_date() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_date}@anchor{3913}
@deffn {Método} get_date ()

Return the delivery date of the message as a floating-point number
representing seconds since the epoch.
@end deffn

@geindex set_date() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_date}@anchor{3914}
@deffn {Método} set_date (date)

Set the delivery date of the message to `date', a floating-point number
representing seconds since the epoch.
@end deffn

@geindex get_info() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage get_info}@anchor{38dc}
@deffn {Método} get_info ()

Return a string containing the “info” for a message. This is useful for
accessing and modifying “info” that is experimental (i.e., not a list of
flags).
@end deffn

@geindex set_info() (método mailbox.MaildirMessage)
@anchor{library/mailbox mailbox MaildirMessage set_info}@anchor{38dd}
@deffn {Método} set_info (info)

Set “info” to `info', which should be a string.
@end deffn
@end deffn

When a @code{MaildirMessage} instance is created based upon an
@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage}
state

@item

“cur” subdirectory

@tab

O flag

@item

F flag

@tab

F flag

@item

R flag

@tab

A flag

@item

S flag

@tab

R flag

@item

T flag

@tab

D flag

@end multitable


When a @code{MaildirMessage} instance is created based upon an
@ref{38ee,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ee,,MHMessage} state

@item

“cur” subdirectory

@tab

“unseen” sequence

@item

“cur” subdirectory and S flag

@tab

no “unseen” sequence

@item

F flag

@tab

“flagged” sequence

@item

R flag

@tab

“replied” sequence

@end multitable


When a @code{MaildirMessage} instance is created based upon a
@ref{3901,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3901,,BabylMessage} state

@item

“cur” subdirectory

@tab

“unseen” label

@item

“cur” subdirectory and S flag

@tab

no “unseen” label

@item

P flag

@tab

“forwarded” or “resent” label

@item

R flag

@tab

“answered” label

@item

T flag

@tab

“deleted” label

@end multitable


@node mboxMessage objects,MHMessage objects,MaildirMessage objects,Message objects
@anchor{library/mailbox mailbox-mboxmessage}@anchor{3915}@anchor{library/mailbox mboxmessage-objects}@anchor{3916}
@subsubsection @code{mboxMessage} objects


@geindex mboxMessage (classe em mailbox)
@anchor{library/mailbox mailbox mboxMessage}@anchor{3771}
@deffn {Classe} mailbox.mboxMessage (message=None)

A message with mbox-specific behaviors. Parameter `message' has the same meaning
as with the @ref{1292,,Message} constructor.

Messages in an mbox mailbox are stored together in a single file. The
sender’s envelope address and the time of delivery are typically stored in a
line beginning with “From “ that is used to indicate the start of a message,
though there is considerable variation in the exact format of this data among
mbox implementations. Flags that indicate the state of the message, such as
whether it has been read or marked as important, are typically stored in
@code{Status} and @code{X-Status} headers.

Conventional flags for mbox messages are as follows:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@tab

Explicação

@item

R

@tab

Read

@tab

Read

@item

O

@tab

Old

@tab

Previously detected by MUA

@item

D

@tab

Deleted

@tab

Marked for subsequent deletion

@item

F

@tab

Flagged

@tab

Marked as important

@item

A

@tab

Answered

@tab

Replied to

@end multitable


The “R” and “O” flags are stored in the @code{Status} header, and the
“D”, “F”, and “A” flags are stored in the @code{X-Status} header. The
flags and headers typically appear in the order mentioned.

@code{mboxMessage} instances offer the following methods:

@geindex get_from() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage get_from}@anchor{3917}
@deffn {Método} get_from ()

Return a string representing the “From “ line that marks the start of the
message in an mbox mailbox. The leading “From “ and the trailing newline
are excluded.
@end deffn

@geindex set_from() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage set_from}@anchor{3918}
@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{d0b,,time.struct_time} instance, a
tuple suitable for passing to @ref{1229,,time.strftime()}, or @code{True} (to use
@ref{1200,,time.gmtime()}).
@end deffn

@geindex get_flags() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage get_flags}@anchor{3919}
@deffn {Método} get_flags ()

Return a string specifying the flags that are currently set. If the
message complies with the conventional format, the result is the
concatenation in the following order of zero or one occurrence of each of
@code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex set_flags() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage set_flags}@anchor{391a}
@deffn {Método} set_flags (flags)

Set the flags specified by `flags' and unset all others. Parameter `flags'
should be the concatenation in any order of zero or more occurrences of
each of @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex add_flag() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage add_flag}@anchor{391b}
@deffn {Método} add_flag (flag)

Set the flag(s) 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.
@end deffn

@geindex remove_flag() (método mailbox.mboxMessage)
@anchor{library/mailbox mailbox mboxMessage remove_flag}@anchor{391c}
@deffn {Método} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' maybe a string of more than
one character.
@end deffn
@end deffn

When an @code{mboxMessage} instance is created based upon a
@ref{38ce,,MaildirMessage} instance, a “From “ line is generated based upon the
@ref{38ce,,MaildirMessage} instance’s delivery date, and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ce,,MaildirMessage} state

@item

R flag

@tab

S flag

@item

O flag

@tab

“cur” subdirectory

@item

D flag

@tab

T flag

@item

F flag

@tab

F flag

@item

A flag

@tab

R flag

@end multitable


When an @code{mboxMessage} instance is created based upon an
@ref{38ee,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ee,,MHMessage} state

@item

R flag and O flag

@tab

no “unseen” sequence

@item

O flag

@tab

“unseen” sequence

@item

F flag

@tab

“flagged” sequence

@item

A flag

@tab

“replied” sequence

@end multitable


When an @code{mboxMessage} instance is created based upon a
@ref{3901,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3901,,BabylMessage} state

@item

R flag and O flag

@tab

no “unseen” label

@item

O flag

@tab

“unseen” label

@item

D flag

@tab

“deleted” label

@item

A flag

@tab

“answered” label

@end multitable


When a @code{mboxMessage} instance is created based upon an
@ref{3908,,MMDFMessage}
instance, the “From “ line is copied and all flags directly correspond:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3908,,MMDFMessage} state

@item

R flag

@tab

R flag

@item

O flag

@tab

O flag

@item

D flag

@tab

D flag

@item

F flag

@tab

F flag

@item

A flag

@tab

A flag

@end multitable


@node MHMessage objects,BabylMessage objects,mboxMessage objects,Message objects
@anchor{library/mailbox mailbox-mhmessage}@anchor{391d}@anchor{library/mailbox mhmessage-objects}@anchor{391e}
@subsubsection @code{MHMessage} objects


@geindex MHMessage (classe em mailbox)
@anchor{library/mailbox mailbox MHMessage}@anchor{38ee}
@deffn {Classe} mailbox.MHMessage (message=None)

A message with MH-specific behaviors. Parameter `message' has the same meaning
as with the @ref{1292,,Message} constructor.

MH messages do not support marks or flags in the traditional sense, but they
do support sequences, which are logical groupings of arbitrary messages. Some
mail reading programs (although not the standard @code{mh} and
@code{nmh}) use sequences in much the same way flags are used with other
formats, as follows:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sequence

@tab

Explicação

@item

unseen

@tab

Not read, but previously detected by MUA

@item

replied

@tab

Replied to

@item

flagged

@tab

Marked as important

@end multitable


@code{MHMessage} instances offer the following methods:

@geindex get_sequences() (método mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage get_sequences}@anchor{391f}
@deffn {Método} get_sequences ()

Return a list of the names of sequences that include this message.
@end deffn

@geindex set_sequences() (método mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage set_sequences}@anchor{3920}
@deffn {Método} set_sequences (sequences)

Set the list of sequences that include this message.
@end deffn

@geindex add_sequence() (método mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage add_sequence}@anchor{3921}
@deffn {Método} add_sequence (sequence)

Add `sequence' to the list of sequences that include this message.
@end deffn

@geindex remove_sequence() (método mailbox.MHMessage)
@anchor{library/mailbox mailbox MHMessage remove_sequence}@anchor{3922}
@deffn {Método} remove_sequence (sequence)

Remove `sequence' from the list of sequences that include this message.
@end deffn
@end deffn

When an @code{MHMessage} instance is created based upon a
@ref{38ce,,MaildirMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ce,,MaildirMessage} state

@item

“unseen” sequence

@tab

no S flag

@item

“replied” sequence

@tab

R flag

@item

“flagged” sequence

@tab

F flag

@end multitable


When an @code{MHMessage} instance is created based upon an
@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage}
state

@item

“unseen” sequence

@tab

no R flag

@item

“replied” sequence

@tab

A flag

@item

“flagged” sequence

@tab

F flag

@end multitable


When an @code{MHMessage} instance is created based upon a
@ref{3901,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3901,,BabylMessage} state

@item

“unseen” sequence

@tab

“unseen” label

@item

“replied” sequence

@tab

“answered” label

@end multitable


@node BabylMessage objects,MMDFMessage objects,MHMessage objects,Message objects
@anchor{library/mailbox babylmessage-objects}@anchor{3923}@anchor{library/mailbox mailbox-babylmessage}@anchor{3924}
@subsubsection @code{BabylMessage} objects


@geindex BabylMessage (classe em mailbox)
@anchor{library/mailbox mailbox BabylMessage}@anchor{3901}
@deffn {Classe} mailbox.BabylMessage (message=None)

A message with Babyl-specific behaviors. Parameter `message' has the same
meaning as with the @ref{1292,,Message} constructor.

Certain message labels, called `attributes', are defined by convention
to have special meanings. The attributes are as follows:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Label

@tab

Explicação

@item

unseen

@tab

Not read, but previously detected by MUA

@item

deleted

@tab

Marked for subsequent deletion

@item

filed

@tab

Copied to another file or mailbox

@item

answered

@tab

Replied to

@item

forwarded

@tab

Forwarded

@item

edited

@tab

Modified by the user

@item

resent

@tab

Resent

@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 mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage get_labels}@anchor{3925}
@deffn {Método} get_labels ()

Return a list of labels on the message.
@end deffn

@geindex set_labels() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage set_labels}@anchor{3926}
@deffn {Método} set_labels (labels)

Set the list of labels on the message to `labels'.
@end deffn

@geindex add_label() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage add_label}@anchor{3927}
@deffn {Método} add_label (label)

Add `label' to the list of labels on the message.
@end deffn

@geindex remove_label() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage remove_label}@anchor{3928}
@deffn {Método} remove_label (label)

Remove `label' from the list of labels on the message.
@end deffn

@geindex get_visible() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage get_visible}@anchor{3929}
@deffn {Método} get_visible ()

Return a @ref{1292,,Message} instance whose headers are the message’s
visible headers and whose body is empty.
@end deffn

@geindex set_visible() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage set_visible}@anchor{392a}
@deffn {Método} set_visible (visible)

Set the message’s visible headers to be the same as the headers in
`message'.  Parameter `visible' should be a @ref{1292,,Message} instance, an
@ref{27c,,email.message.Message} instance, a string, or a file-like object
(which should be open in text mode).
@end deffn

@geindex update_visible() (método mailbox.BabylMessage)
@anchor{library/mailbox mailbox BabylMessage update_visible}@anchor{392b}
@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{38ce,,MaildirMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ce,,MaildirMessage} state

@item

“unseen” label

@tab

no S flag

@item

“deleted” label

@tab

T flag

@item

“answered” label

@tab

R flag

@item

“forwarded” label

@tab

P flag

@end multitable


When a @code{BabylMessage} instance is created based upon an
@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage} instance, the @code{Status}
and @code{X-Status} headers are omitted and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3771,,mboxMessage} or @ref{3908,,MMDFMessage}
state

@item

“unseen” label

@tab

no R flag

@item

“deleted” label

@tab

D flag

@item

“answered” label

@tab

A flag

@end multitable


When a @code{BabylMessage} instance is created based upon an
@ref{38ee,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ee,,MHMessage} state

@item

“unseen” label

@tab

“unseen” sequence

@item

“answered” label

@tab

“replied” sequence

@end multitable


@node MMDFMessage objects,,BabylMessage objects,Message objects
@anchor{library/mailbox mailbox-mmdfmessage}@anchor{392c}@anchor{library/mailbox mmdfmessage-objects}@anchor{392d}
@subsubsection @code{MMDFMessage} objects


@geindex MMDFMessage (classe em mailbox)
@anchor{library/mailbox mailbox MMDFMessage}@anchor{3908}
@deffn {Classe} mailbox.MMDFMessage (message=None)

A message with MMDF-specific behaviors. Parameter `message' has the same meaning
as with the @ref{1292,,Message} constructor.

As with message in an mbox mailbox, MMDF messages are stored with the
sender’s address and the delivery date in an initial line beginning with
“From “.  Likewise, flags that indicate the state of the message are
typically stored in @code{Status} and @code{X-Status} headers.

Conventional flags for MMDF messages are identical to those of mbox message
and are as follows:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@tab

Explicação

@item

R

@tab

Read

@tab

Read

@item

O

@tab

Old

@tab

Previously detected by MUA

@item

D

@tab

Deleted

@tab

Marked for subsequent deletion

@item

F

@tab

Flagged

@tab

Marked as important

@item

A

@tab

Answered

@tab

Replied to

@end multitable


The “R” and “O” flags are stored in the @code{Status} header, and the
“D”, “F”, and “A” flags are stored in the @code{X-Status} header. The
flags and headers typically appear in the order mentioned.

@code{MMDFMessage} instances offer the following methods, which are
identical to those offered by @ref{3771,,mboxMessage}:

@geindex get_from() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage get_from}@anchor{392e}
@deffn {Método} get_from ()

Return a string representing the “From “ line that marks the start of the
message in an mbox mailbox. The leading “From “ and the trailing newline
are excluded.
@end deffn

@geindex set_from() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage set_from}@anchor{392f}
@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{d0b,,time.struct_time} instance, a
tuple suitable for passing to @ref{1229,,time.strftime()}, or @code{True} (to use
@ref{1200,,time.gmtime()}).
@end deffn

@geindex get_flags() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage get_flags}@anchor{3930}
@deffn {Método} get_flags ()

Return a string specifying the flags that are currently set. If the
message complies with the conventional format, the result is the
concatenation in the following order of zero or one occurrence of each of
@code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex set_flags() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage set_flags}@anchor{3931}
@deffn {Método} set_flags (flags)

Set the flags specified by `flags' and unset all others. Parameter `flags'
should be the concatenation in any order of zero or more occurrences of
each of @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'}, and @code{'A'}.
@end deffn

@geindex add_flag() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage add_flag}@anchor{3932}
@deffn {Método} add_flag (flag)

Set the flag(s) 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.
@end deffn

@geindex remove_flag() (método mailbox.MMDFMessage)
@anchor{library/mailbox mailbox MMDFMessage remove_flag}@anchor{3933}
@deffn {Método} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' maybe a string of more than
one character.
@end deffn
@end deffn

When an @code{MMDFMessage} instance is created based upon a
@ref{38ce,,MaildirMessage} instance, a “From “ line is generated based upon the
@ref{38ce,,MaildirMessage} instance’s delivery date, and the following conversions
take place:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ce,,MaildirMessage} state

@item

R flag

@tab

S flag

@item

O flag

@tab

“cur” subdirectory

@item

D flag

@tab

T flag

@item

F flag

@tab

F flag

@item

A flag

@tab

R flag

@end multitable


When an @code{MMDFMessage} instance is created based upon an
@ref{38ee,,MHMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{38ee,,MHMessage} state

@item

R flag and O flag

@tab

no “unseen” sequence

@item

O flag

@tab

“unseen” sequence

@item

F flag

@tab

“flagged” sequence

@item

A flag

@tab

“replied” sequence

@end multitable


When an @code{MMDFMessage} instance is created based upon a
@ref{3901,,BabylMessage} instance, the following conversions take place:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3901,,BabylMessage} state

@item

R flag and O flag

@tab

no “unseen” label

@item

O flag

@tab

“unseen” label

@item

D flag

@tab

“deleted” label

@item

A flag

@tab

“answered” label

@end multitable


When an @code{MMDFMessage} instance is created based upon an
@ref{3771,,mboxMessage} instance, the “From “ line is copied and all flags directly
correspond:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Resulting state

@tab

@ref{3771,,mboxMessage} state

@item

R flag

@tab

R flag

@item

O flag

@tab

O flag

@item

D flag

@tab

D flag

@item

F flag

@tab

F flag

@item

A flag

@tab

A flag

@end multitable


@node Exceções<18>,Exemplos<23>,Message objects,mailbox — Manipule caixas de entradas em vários formatos
@anchor{library/mailbox exceptions}@anchor{3934}
@subsubsection Exceções


The following exception classes are defined in the @code{mailbox} module:

@geindex Error
@anchor{library/mailbox mailbox Error}@anchor{3935}
@deffn {Exceção} mailbox.Error

The based class for all other module-specific exceptions.
@end deffn

@geindex NoSuchMailboxError
@anchor{library/mailbox mailbox NoSuchMailboxError}@anchor{38d2}
@deffn {Exceção} mailbox.NoSuchMailboxError

Raised when a mailbox is expected but is not found, such as when instantiating a
@ref{128e,,Mailbox} subclass with a path that does not exist (and with the `create'
parameter set to @code{False}), or when opening a folder that does not exist.
@end deffn

@geindex NotEmptyError
@anchor{library/mailbox mailbox NotEmptyError}@anchor{38d5}
@deffn {Exceção} mailbox.NotEmptyError

Raised when a mailbox is not empty but is expected to be, such as when deleting
a folder that contains messages.
@end deffn

@geindex ExternalClashError
@anchor{library/mailbox mailbox ExternalClashError}@anchor{38ca}
@deffn {Exceção} 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{3936}
@deffn {Exceção} mailbox.FormatError

Raised when the data in a file cannot be parsed, such as when an @ref{17a9,,MH}
instance attempts to read a corrupted @code{.mh_sequences} file.
@end deffn

@node Exemplos<23>,,Exceções<18>,mailbox — Manipule caixas de entradas em vários formatos
@anchor{library/mailbox examples}@anchor{3937}@anchor{library/mailbox mailbox-examples}@anchor{3938}
@subsubsection Exemplos


A simple example of printing the subjects of all messages in a mailbox that seem
interesting:

@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

To copy all mail from a Babyl mailbox to an MH mailbox, converting all of the
format-specific information that can be converted:

@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

This example sorts mail from several mailing lists into different mailboxes,
being careful to avoid mail corruption due to concurrent modification by other
programs, mail loss due to interruption of the program, or premature termination
due to malformed messages in the mailbox:

@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 — Mapeia nomes de arquivos para tipos MIME,base64 — Base16 Base32 Base64 Base85 Data Encodings,mailbox — Manipule caixas de entradas em vários formatos,Manuseio de Dados na Internet
@anchor{library/mimetypes doc}@anchor{3939}@anchor{library/mimetypes mimetypes-map-filenames-to-mime-types}@anchor{393a}@anchor{library/mimetypes module-mimetypes}@anchor{8f}@anchor{library/mimetypes translation-repo}@anchor{393b}
@subsection @code{mimetypes} — Mapeia nomes de arquivos para tipos MIME


@geindex module; mimetypes

`Código-fonte:' Lib/mimetypes.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/mimetypes.py}

@geindex MIME;tipo de conteúdo


__________________________________________________________________


O módulo @ref{8f,,mimetypes} converte entre um nome de arquivo ou URL e o tipo MIME associado à extensão do arquivo. As conversões são fornecidas do nome do arquivo para o tipo MIME e da extensão do tipo MIME para o nome do arquivo; codificações não são suportadas para a última conversão.

O módulo fornece uma classe e várias funções convenientes. As funções são a interface normal para este módulo, mas algumas aplicações também podem estar interessadas na classe.

As funções descritas abaixo fornecem a interface principal para este módulo. Se o módulo não foi inicializado, eles chamarão @ref{393c,,init()} se confiarem nas informações configuradas por @ref{393c,,init()}.

@geindex guess_type() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_type}@anchor{208}
@deffn {Função} mimetypes.guess_type (url, strict=True)

@geindex MIME;cabeçalhos

Adivinha o tipo de arquivo com base em seu nome de arquivo, caminho ou URL, fornecido por `url'. A URL pode ser uma string ou um @ref{2a0,,objeto caminho ou similar}.

O valor de retorno é uma tupla @code{(type, encoding)} onde o `tipo' é @code{None} se o tipo não puder ser ser adivinhado (sufixo ausente ou desconhecido) ou uma string no formato @code{'type/subtype'}, utilizável para um cabeçalho MIME @code{content-type}.

`encoding' é @code{None} para nenhuma codificação ou o nome do programa usado para codificar (por exemplo @code{compress} ou @code{gzip}). A codificação é adequada para uso como cabeçalho @code{Content-Encoding} , `não' como cabeçalho @code{Content-Transfer-Encoding}. Os mapeamentos são orientados por tabela. Os sufixos de codificação diferenciam maiúsculas de minúsculas; os sufixos de tipo são testados primeiro considerando maiúsculas e minúsculas e depois sem considerar.

O argumento opcional `strict' é um sinalizador que especifica se a lista de tipos MIME conhecidos é limitada apenas aos tipos oficiais registrados na IANA@footnote{https://www.iana.org/assignments/media-types/media-types.xhtml}. Quando `strict' é @code{True} (o padrão), apenas os tipos IANA são suportados; quando `strict' é @code{False}, alguns tipos MIME adicionais não padronizados, mas geralmente usados, também são reconhecidos.


Alterado na versão 3.8: Adicionado suporte para que a `url' seja um @ref{2a0,,objeto caminho ou similar}.



Descontinuado desde a versão 3.13: Passar um caminho de arquivo em vez de URL está @ref{209,,suavemente descontinuado}. Use @ref{207,,guess_file_type()} para isso.

@end deffn

@geindex guess_file_type() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_file_type}@anchor{207}
@deffn {Função} mimetypes.guess_file_type (path, *, strict=True)

@geindex MIME;cabeçalhos

Adivinha o tipo de um arquivo com base em seu caminho, dado por `path'. Semelhante à função @ref{208,,guess_type()}, mas aceita um caminho em vez de URL. O caminho pode ser uma string, um objeto bytes ou um @ref{2a0,,objeto caminho ou similar}.


Adicionado na versão 3.13.

@end deffn

@geindex guess_all_extensions() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_all_extensions}@anchor{19d5}
@deffn {Função} mimetypes.guess_all_extensions (type, strict=True)

Adivinha as extensões para um arquivo com base em seu tipo MIME, fornecido por `type'. O valor de retorno é uma lista de strings que fornecem todas as extensões possíveis de nome de arquivo, incluindo o ponto (@code{'.'}). Não é garantido que as extensões tenham sido associadas a qualquer fluxo de dados específico, mas seriam mapeadas para o tipo MIME `type' por @ref{208,,guess_type()} e @ref{207,,guess_file_type()}.

O argumento opcional `strict' tem o mesmo significado que usado com a função @ref{208,,guess_type()}.
@end deffn

@geindex guess_extension() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes guess_extension}@anchor{393d}
@deffn {Função} mimetypes.guess_extension (type, strict=True)

Adivinha a extensão para um arquivo com base em seu tipo MIME, fornecido por `type'. O valor de retorno é uma string que fornece uma extensão de nome de arquivo, incluindo o ponto (@code{'.'}). Não é garantido que a extensão tenha sido associada a qualquer fluxo de dados específico, mas seria mapeada para o tipo MIME `type' por @ref{208,,guess_type()} e @ref{207,,guess_file_type()}. Se nenhuma extensão puder ser adivinhada para `type', @code{None} é retornado.

O argumento opcional `strict' tem o mesmo significado que usado com a função @ref{208,,guess_type()}.
@end deffn

Algumas funções e dados adicionais estão disponíveis para controlar o comportamento do módulo.

@geindex init() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes init}@anchor{393c}
@deffn {Função} mimetypes.init (files=None)

Inicializa as estruturas de dados internas.  Se fornecido, `files' deverá ser uma sequência de nomes de arquivos que devem ser usados para aumentar o mapa de tipos padrão.  Se for omitido, os nomes de arquivos a serem usados serão retirados de @ref{393e,,knownfiles}; no Windows, as configurações atuais do registro são carregadas.  Cada arquivo nomeado em `files' ou @ref{393e,,knownfiles} tem precedência sobre os definidos anteriormente.  É permitido chamar @ref{393c,,init()} repetidamente.

Especificar uma lista vazia para `files' impedirá que os padrões do sistema sejam carregados: apenas os valores bem conhecidos estarão presentes em uma lista interna.

Se `files' for @code{None}, a estrutura de dados interna será completamente reconstruída com seu valor inicial padrão. Essa é uma operação estável e produzirá os mesmos resultados quando chamada várias vezes.


Alterado na versão 3.2: Anteriormente, as configurações do registro do Windows eram ignoradas.

@end deffn

@geindex read_mime_types() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes read_mime_types}@anchor{1ab7}
@deffn {Função} mimetypes.read_mime_types (filename)

Carrega o mapa de tipos fornecido no arquivo `filename', se existir. O mapa de tipos é retornado como um dicionário que faz o mapeamento de extensões de nome de arquivo, incluindo o ponto inicial (@code{'.'}), para strings no formato @code{'tipo/subtipo'}. Se o arquivo `filename' não existir ou não puder ser lido, @code{None} é retornado.
@end deffn

@geindex add_type() (no módulo mimetypes)
@anchor{library/mimetypes mimetypes add_type}@anchor{393f}
@deffn {Função} mimetypes.add_type (type, ext, strict=True)

Adiciona um mapeamento do tipo MIME `type' para a extensão `ext'. Quando a extensão já for conhecida, o novo tipo substituirá o antigo. Quando o tipo já for conhecido, a extensão será adicionada à lista de extensões conhecidas.

Quando `strict' for @code{True} (o padrão), o mapeamento será adicionado aos tipos MIME oficiais, caso contrário, aos não-padrão.
@end deffn

@geindex inited (no módulo mimetypes)
@anchor{library/mimetypes mimetypes inited}@anchor{3940}
@deffn {Dado} mimetypes.inited

Sinalizador indicando se as estruturas de dados globais foram inicializadas ou não. Isso é definido para @code{True} por @ref{393c,,init()}.
@end deffn

@geindex knownfiles (no módulo mimetypes)
@anchor{library/mimetypes mimetypes knownfiles}@anchor{393e}
@deffn {Dado} mimetypes.knownfiles

@geindex arquivo;mime.types

Lista de nomes de arquivos de mapas de tipos comumente instalados.  Esses arquivos são normalmente nomeado como @code{mime.types} e são instalados em diferentes locais por diferentes pacote.
@end deffn

@geindex suffix_map (no módulo mimetypes)
@anchor{library/mimetypes mimetypes suffix_map}@anchor{3941}
@deffn {Dado} mimetypes.suffix_map

Dicionário mapeando sufixos para sufixos.  Isso é usado para permitir o reconhecimento de arquivos codificados para os quais a codificação e o tipo são indicados pela mesma extensão. Por exemplo, em um arquivo codificado, a extensão @code{.tgz} é mapeada para @code{.tar.gz} para permitir que a codificação e o tipo sejam reconhecidos separadamente.
@end deffn

@geindex encodings_map (no módulo mimetypes)
@anchor{library/mimetypes mimetypes encodings_map}@anchor{3942}
@deffn {Dado} mimetypes.encodings_map

Dicionário mapeando extensões de nome de arquivo para os tipos de codificação.
@end deffn

@geindex types_map (no módulo mimetypes)
@anchor{library/mimetypes mimetypes types_map}@anchor{3943}
@deffn {Dado} mimetypes.types_map

Dicionário mapeando extensões de nome do arquivo para tipos MIME.
@end deffn

@geindex common_types (no módulo mimetypes)
@anchor{library/mimetypes mimetypes common_types}@anchor{3944}
@deffn {Dado} mimetypes.common_types

Dicionário mapeando extensões de nome de arquivo para tipos MIME não padronizados, mas comumente encontrados.
@end deffn

Um exemplo de uso do 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 — Mapeia nomes de arquivos para tipos MIME
@anchor{library/mimetypes id1}@anchor{3945}@anchor{library/mimetypes mimetypes-objects}@anchor{3946}
@subsubsection Objetos MimeTypes


A classe @ref{1543,,MimeTypes} pode ser útil para aplicações que possam querer mais de um banco de dados de tipos MIME; ela fornece uma interface semelhante à do módulo @ref{8f,,mimetypes}.

@geindex MimeTypes (classe em mimetypes)
@anchor{library/mimetypes mimetypes MimeTypes}@anchor{1543}
@deffn {Classe} mimetypes.MimeTypes (filenames=(), strict=True)

Esta classe representa um banco de dados de tipos MIME. Por padrão, ela fornece acesso ao mesmo banco de dados do restante deste módulo. O banco de dados inicial é uma cópia daquele fornecido pelo módulo e pode ser estendido ao carregar arquivos adicionais no formato @code{mime.types} no banco de dados, usando os métodos @ref{3947,,read()} ou @ref{3948,,readfp()}. Os dicionários de mapeamento também podem ser limpos antes de carregar dados adicionais, caso os dados padrões não sejam desejados.

O parâmetro opcional `filenames' pode ser usado para carregar arquivos adicionais “em cima” do banco de dados padrão.

@geindex suffix_map (atributo mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes suffix_map}@anchor{3949}
@deffn {Atributo} suffix_map

Dicionário mapeando sufixo para sufixo. Isso é usado para permitir o reconhecimento de arquivos codificados para os quais a codificação e o tipo são indicados pela mesma extensão. Por exemplo, a extensão @code{.tgz} é mapeada para @code{.tar.gz} para permitir que a codificação e o tipo sejam reconhecidos separadamente.  Inicialmente, isso é uma cópia do @ref{3941,,suffix_map} global definido no módulo.
@end deffn

@geindex encodings_map (atributo mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes encodings_map}@anchor{394a}
@deffn {Atributo} encodings_map

Dicionário que mapeia extensões de nomes de arquivo para tipos de codificação. Inicialmente, é uma cópia do @ref{3942,,encodings_map} global definido no módulo.
@end deffn

@geindex types_map (atributo mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes types_map}@anchor{394b}
@deffn {Atributo} types_map

Tupla contendo dois dicionários, mapeando extensões de nomes de arquivo para tipos MIME: o primeiro dicionário é para tipos não padrão e o segundo, para tipos padrão. Eles são inicializados por @ref{3944,,common_types} e @ref{3943,,types_map}.
@end deffn

@geindex types_map_inv (atributo mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes types_map_inv}@anchor{394c}
@deffn {Atributo} types_map_inv

Tupla contendo dois dicionários, mapeando tipos MIME para uma lista de extensões de nomes de arquivo: o primeiro dicionário é para os tipos não padrão e o segundo para os tipos padrão. Eles são inicializados por @ref{3944,,common_types} e @ref{3943,,types_map}.
@end deffn

@geindex guess_extension() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_extension}@anchor{394d}
@deffn {Método} guess_extension (type, strict=True)

Similar à função @ref{393d,,guess_extension()}, usando as tabelas armazenadas como parte do objeto.
@end deffn

@geindex guess_type() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_type}@anchor{1bb0}
@deffn {Método} guess_type (url, strict=True)

Similar à função @ref{208,,guess_type()}, usando as tabelas armazenadas como parte do objeto.
@end deffn

@geindex guess_file_type() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_file_type}@anchor{394e}
@deffn {Método} guess_file_type (path, *, strict=True)

Similar à função @ref{207,,guess_file_type()}, usando as tabelas armazenadas como parte do objeto.


Adicionado na versão 3.13.

@end deffn

@geindex guess_all_extensions() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes guess_all_extensions}@anchor{394f}
@deffn {Método} guess_all_extensions (type, strict=True)

Similar à função @ref{19d5,,guess_all_extensions()}, usando as tabelas armazenadas como parte do objeto.
@end deffn

@geindex read() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes read}@anchor{3947}
@deffn {Método} read (filename, strict=True)

Carrega as informações do tipo MIME de um arquivo chamado `filename'.  Usa @ref{3948,,readfp()} para analisar o arquivo.

Se `strict' for @code{True}, as informações serão adicionadas à lista de tipos padrão, caso contrário, à lista de tipos não padrão.
@end deffn

@geindex readfp() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes readfp}@anchor{3948}
@deffn {Método} readfp (fp, strict=True)

Carrega as informações do tipo MIME de um arquivo aberto `fp'. O arquivo precisa estar no formato padrão dos arquivos @code{mime.types}.

Se `strict' for @code{True}, as informações serão adicionadas à lista de tipos padrão, caso contrário, à lista de tipos não padrão.
@end deffn

@geindex read_windows_registry() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes read_windows_registry}@anchor{3950}
@deffn {Método} read_windows_registry (strict=True)

Carrega as informações do tipo MIME a partir do registro do Windows.

@ref{1ed8,,Disponibilidade}: Windows.

Se `strict' for @code{True}, as informações serão adicionadas à lista de tipos padrão, caso contrário, à lista de tipos não padrão.


Adicionado na versão 3.2.

@end deffn

@geindex add_type() (método mimetypes.MimeTypes)
@anchor{library/mimetypes mimetypes MimeTypes add_type}@anchor{3951}
@deffn {Método} add_type (type, ext, strict=True)

Adiciona um mapeamento do tipo MIME `type' para a extensão `ext'. Quando a extensão já for conhecida, o novo tipo substituirá o antigo. Quando o tipo já for conhecido, a extensão será adicionada à lista de extensões conhecidas.

Quando `strict' for @code{True} (o padrão), o mapeamento será adicionado aos tipos MIME oficiais, caso contrário, aos não-padrão.
@end deffn
@end deffn

@node base64 — Base16 Base32 Base64 Base85 Data Encodings,binascii — Converte entre binário e ASCII,mimetypes — Mapeia nomes de arquivos para tipos MIME,Manuseio de Dados na Internet
@anchor{library/base64 doc}@anchor{3952}@anchor{library/base64 base64-base16-base32-base64-base85-data-encodings}@anchor{3953}@anchor{library/base64 module-base64}@anchor{e}@anchor{library/base64 translation-repo}@anchor{3954}
@subsection @code{base64} — Base16, Base32, Base64, Base85 Data Encodings


@geindex module; base64

`Código-fonte:' Lib/base64.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/base64.py}

@geindex base64;codificação
@geindex MIME;base64 encoding


__________________________________________________________________


This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data.
This includes the @ref{3955,,encodings specified in}
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} (Base64, Base32 and Base16)
and the non-standard @ref{3956,,Base85 encodings}.

Existem duas interfaces fornecidas por este módulo. A interface moderna oferece suporte a codificar @ref{d4f,,objetos bytes ou similares} para @ref{1c2,,bytes} ASCII, e decodificar @ref{d4f,,objetos bytes ou similares} ou strings contendo ASCII para @ref{1c2,,bytes}. Ambos os alfabetos de base 64 definidos em 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} (normal e seguro para URL e sistema de arquivos) são suportados.

The @ref{3957,,legacy interface} does not support decoding from strings, but it does
provide functions for encoding and decoding to and from @ref{1203,,file objects}.  It only supports the Base64 standard alphabet, and it adds
newlines every 76 characters as per 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}.  Note that if you are looking
for 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} support you probably want to be looking at the @ref{3b,,email}
package instead.


Alterado na versão 3.3: Strings Unicode exclusivamente ASCII agora são aceitas pelas funções de decodificação da interface moderna.



Alterado na versão 3.4: Quaisquer @ref{d4f,,objetos bytes ou similares} agora são aceitos por todas as funções de codificação e decodificação neste módulo. Adicionado suporte a ASCII85/Base85.


@menu
* RFC 4648 Encodings:: 
* Base85 Encodings:: 
* Legacy Interface:: 
* Considerações de Segurança: Considerações de Segurança<2>. 

@end menu

@node RFC 4648 Encodings,Base85 Encodings,,base64 — Base16 Base32 Base64 Base85 Data Encodings
@anchor{library/base64 base64-rfc-4648}@anchor{3955}@anchor{library/base64 rfc-4648-encodings}@anchor{3958}
@subsubsection RFC 4648 Encodings


The 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} encodings are suitable for encoding binary data so that it can be
safely sent by email, used as parts of URLs, or included as part of an HTTP
POST request.

@geindex b64encode() (no módulo base64)
@anchor{library/base64 base64 b64encode}@anchor{3959}
@deffn {Função} base64.b64encode (s, altchars=None)

Codifica o @ref{d4f,,objeto bytes ou similar} `s' usando Base64 e retorna o @ref{1c2,,bytes} codificado.

Optional `altchars' must be a @ref{d4f,,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{202,,ValueError} if the length of `altchars' is not 2.  Raises a
@ref{2c3,,TypeError} if `altchars' is not a @ref{d4f,,bytes-like object}.
@end deffn

@geindex b64decode() (no módulo base64)
@anchor{library/base64 base64 b64decode}@anchor{1b1f}
@deffn {Função} base64.b64decode (s, altchars=None, validate=False)

Decodifica o @ref{d4f,,objeto bytes ou similar} ou string ASCII `s' codificada em Base64 e retorna o @ref{1c2,,bytes} decodificado.

Optional `altchars' must be a @ref{d4f,,bytes-like object} or ASCII string
of length 2 which specifies the alternative alphabet used instead of the
@code{+} and @code{/} characters.

A @ref{105c,,binascii.Error} exception is raised
if `s' is incorrectly padded.

If `validate' is @code{False} (the default), characters that are neither
in the normal base-64 alphabet nor the alternative alphabet are
discarded prior to the padding check.  If `validate' is @code{True},
these non-alphabet characters in the input result in a
@ref{105c,,binascii.Error}.

For more information about the strict base64 check, see @ref{1719,,binascii.a2b_base64()}

May assert or raise a @ref{202,,ValueError} if the length of `altchars' is not 2.
@end deffn

@geindex standard_b64encode() (no módulo base64)
@anchor{library/base64 base64 standard_b64encode}@anchor{395a}
@deffn {Função} base64.standard_b64encode (s)

Encode @ref{d4f,,bytes-like object} `s' using the standard Base64 alphabet
and return the encoded @ref{1c2,,bytes}.
@end deffn

@geindex standard_b64decode() (no módulo base64)
@anchor{library/base64 base64 standard_b64decode}@anchor{395b}
@deffn {Função} base64.standard_b64decode (s)

Decode @ref{d4f,,bytes-like object} or ASCII string `s' using the standard
Base64 alphabet and return the decoded @ref{1c2,,bytes}.
@end deffn

@geindex urlsafe_b64encode() (no módulo base64)
@anchor{library/base64 base64 urlsafe_b64encode}@anchor{395c}
@deffn {Função} base64.urlsafe_b64encode (s)

Encode @ref{d4f,,bytes-like object} `s' using the
URL- and filesystem-safe alphabet, which
substitutes @code{-} instead of @code{+} and @code{_} instead of @code{/} in the
standard Base64 alphabet, and return the encoded @ref{1c2,,bytes}.  The result
can still contain @code{=}.
@end deffn

@geindex urlsafe_b64decode() (no módulo base64)
@anchor{library/base64 base64 urlsafe_b64decode}@anchor{395d}
@deffn {Função} base64.urlsafe_b64decode (s)

Decode @ref{d4f,,bytes-like object} or ASCII string `s'
using the URL- and filesystem-safe
alphabet, which substitutes @code{-} instead of @code{+} and @code{_} instead of
@code{/} in the standard Base64 alphabet, and return the decoded
@ref{1c2,,bytes}.
@end deffn

@geindex b32encode() (no módulo base64)
@anchor{library/base64 base64 b32encode}@anchor{395e}
@deffn {Função} base64.b32encode (s)

Encode the @ref{d4f,,bytes-like object} `s' using Base32 and return the
encoded @ref{1c2,,bytes}.
@end deffn

@geindex b32decode() (no módulo base64)
@anchor{library/base64 base64 b32decode}@anchor{105b}
@deffn {Função} base64.b32decode (s, casefold=False, map01=None)

Decode the Base32 encoded @ref{d4f,,bytes-like object} or ASCII string `s' and
return the decoded @ref{1c2,,bytes}.

`casefold' opcional é uma flag especificando se um alfabeto minúsculo é aceitável como entrada. Por razões de segurança, o padrão é @code{False}.

@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} allows for optional mapping of the digit 0 (zero) to the letter O
(oh), and for optional mapping of the digit 1 (one) to either the letter I (eye)
or letter L (el).  The optional argument `map01' when not @code{None}, specifies
which letter the digit 1 should be mapped to (when `map01' is not @code{None}, the
digit 0 is always mapped to the letter O).  For security purposes the default is
@code{None}, so that 0 and 1 are not allowed in the input.

A @ref{105c,,binascii.Error} is raised if `s' is
incorrectly padded or if there are non-alphabet characters present in the
input.
@end deffn

@geindex b32hexencode() (no módulo base64)
@anchor{library/base64 base64 b32hexencode}@anchor{7e5}
@deffn {Função} base64.b32hexencode (s)

Similar to @ref{395e,,b32encode()} but uses the Extended Hex Alphabet, as defined in
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}.


Adicionado na versão 3.10.

@end deffn

@geindex b32hexdecode() (no módulo base64)
@anchor{library/base64 base64 b32hexdecode}@anchor{7e6}
@deffn {Função} base64.b32hexdecode (s, casefold=False)

Similar to @ref{105b,,b32decode()} but uses the Extended Hex Alphabet, as defined in
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}.

This version does not allow the digit 0 (zero) to the letter O (oh) and digit
1 (one) to either the letter I (eye) or letter L (el) mappings, all these
characters are included in the Extended Hex Alphabet and are not
interchangeable.


Adicionado na versão 3.10.

@end deffn

@geindex b16encode() (no módulo base64)
@anchor{library/base64 base64 b16encode}@anchor{395f}
@deffn {Função} base64.b16encode (s)

Encode the @ref{d4f,,bytes-like object} `s' using Base16 and return the
encoded @ref{1c2,,bytes}.
@end deffn

@geindex b16decode() (no módulo base64)
@anchor{library/base64 base64 b16decode}@anchor{3960}
@deffn {Função} base64.b16decode (s, casefold=False)

Decode the Base16 encoded @ref{d4f,,bytes-like object} or ASCII string `s' and
return the decoded @ref{1c2,,bytes}.

`casefold' opcional é uma flag especificando se um alfabeto minúsculo é aceitável como entrada. Por razões de segurança, o padrão é @code{False}.

A @ref{105c,,binascii.Error} is raised if `s' is
incorrectly padded or if there are non-alphabet characters present in the
input.
@end deffn

@node Base85 Encodings,Legacy Interface,RFC 4648 Encodings,base64 — Base16 Base32 Base64 Base85 Data Encodings
@anchor{library/base64 base64-base-85}@anchor{3956}@anchor{library/base64 base85-encodings}@anchor{3961}
@subsubsection Base85 Encodings


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

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

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


@itemize *

@item 
Whether to include enclosing @code{<~} and @code{~>} markers

@item 
Whether to include newline characters

@item 
The set of ASCII characters used for encoding

@item 
Handling of null bytes
@end itemize

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

@geindex a85encode() (no módulo base64)
@anchor{library/base64 base64 a85encode}@anchor{f50}
@deffn {Função} base64.a85encode (b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

Encode the @ref{d4f,,bytes-like object} `b' using Ascii85 and return the
encoded @ref{1c2,,bytes}.

`foldspaces' is an optional flag that uses the special short sequence ‘y’
instead of 4 consecutive spaces (ASCII 0x20) as supported by ‘btoa’. This
feature is not supported by the “standard” Ascii85 encoding.

`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' controls whether the input is padded to a multiple of 4
before encoding. Note that the @code{btoa} implementation always pads.

`adobe' controls whether the encoded byte sequence is framed with @code{<~}
and @code{~>}, which is used by the Adobe implementation.


Adicionado na versão 3.4.

@end deffn

@geindex a85decode() (no módulo base64)
@anchor{library/base64 base64 a85decode}@anchor{f51}
@deffn {Função} base64.a85decode (b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

Decode the Ascii85 encoded @ref{d4f,,bytes-like object} or ASCII string `b' and
return the decoded @ref{1c2,,bytes}.

`foldspaces' is a flag that specifies whether the ‘y’ short sequence
should be accepted as shorthand for 4 consecutive spaces (ASCII 0x20).
This feature is not supported by the “standard” Ascii85 encoding.

`adobe' controla se a entrada está no formato Adobe Ascii85 (ou seja, cercada por <~ e ~>).

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


Adicionado na versão 3.4.

@end deffn

@geindex b85encode() (no módulo base64)
@anchor{library/base64 base64 b85encode}@anchor{f52}
@deffn {Função} base64.b85encode (b, pad=False)

Encode the @ref{d4f,,bytes-like object} `b' using base85 (as used in e.g.
git-style binary diffs) and return the encoded @ref{1c2,,bytes}.

If `pad' is true, the input is padded with @code{b'\0'} so its length is a
multiple of 4 bytes before encoding.


Adicionado na versão 3.4.

@end deffn

@geindex b85decode() (no módulo base64)
@anchor{library/base64 base64 b85decode}@anchor{f53}
@deffn {Função} base64.b85decode (b)

Decode the base85-encoded @ref{d4f,,bytes-like object} or ASCII string `b' and
return the decoded @ref{1c2,,bytes}.  Padding is implicitly removed, if
necessary.


Adicionado na versão 3.4.

@end deffn

@geindex z85encode() (no módulo base64)
@anchor{library/base64 base64 z85encode}@anchor{14f}
@deffn {Função} base64.z85encode (s)

Encode the @ref{d4f,,bytes-like object} `s' using Z85 (as used in ZeroMQ)
and return the encoded @ref{1c2,,bytes}.  See Z85 specification@footnote{https://rfc.zeromq.org/spec/32/} for more information.


Adicionado na versão 3.13.

@end deffn

@geindex z85decode() (no módulo base64)
@anchor{library/base64 base64 z85decode}@anchor{150}
@deffn {Função} base64.z85decode (s)

Decode the Z85-encoded @ref{d4f,,bytes-like object} or ASCII string `s' and
return the decoded @ref{1c2,,bytes}.  See Z85 specification@footnote{https://rfc.zeromq.org/spec/32/} for more information.


Adicionado na versão 3.13.

@end deffn

@node Legacy Interface,Considerações de Segurança<2>,Base85 Encodings,base64 — Base16 Base32 Base64 Base85 Data Encodings
@anchor{library/base64 base64-legacy}@anchor{3957}@anchor{library/base64 legacy-interface}@anchor{3962}
@subsubsection Legacy Interface


@geindex decode() (no módulo base64)
@anchor{library/base64 base64 decode}@anchor{3963}
@deffn {Função} base64.decode (input, output)

Decode the contents of the binary `input' file and write the resulting binary
data to the `output' file. `input' and `output' must be @ref{1203,,file objects}. `input' will be read until @code{input.readline()} returns an
empty bytes object.
@end deffn

@geindex decodebytes() (no módulo base64)
@anchor{library/base64 base64 decodebytes}@anchor{95b}
@deffn {Função} base64.decodebytes (s)

Decode the @ref{d4f,,bytes-like object} `s', which must contain one or more
lines of base64 encoded data, and return the decoded @ref{1c2,,bytes}.


Adicionado na versão 3.1.

@end deffn

@geindex encode() (no módulo base64)
@anchor{library/base64 base64 encode}@anchor{3964}
@deffn {Função} base64.encode (input, output)

Encode the contents of the binary `input' file and write the resulting base64
encoded data to the `output' file. `input' and `output' must be @ref{1203,,file objects}. `input' will be read until @code{input.read()} returns
an empty bytes object. @ref{3964,,encode()} inserts a newline character (@code{b'\n'})
after every 76 bytes of the output, as well as ensuring that the output
always ends with a newline, as per 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME).
@end deffn

@geindex encodebytes() (no módulo base64)
@anchor{library/base64 base64 encodebytes}@anchor{95a}
@deffn {Função} base64.encodebytes (s)

Encode the @ref{d4f,,bytes-like object} `s', which can contain arbitrary binary
data, and return @ref{1c2,,bytes} containing the base64-encoded data, with newlines
(@code{b'\n'}) inserted after every 76 bytes of output, and ensuring that
there is a trailing newline, as per 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME).


Adicionado na versão 3.1.

@end deffn

Um exemplo de uso do 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

@node Considerações de Segurança<2>,,Legacy Interface,base64 — Base16 Base32 Base64 Base85 Data Encodings
@anchor{library/base64 base64-security}@anchor{3965}@anchor{library/base64 security-considerations}@anchor{3966}
@subsubsection Considerações de Segurança


A new security considerations section was added to 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} (section 12); it’s
recommended to review the security section for any code deployed to production.


@subsubheading Ver também



@table @asis

@item Módulo @ref{10,,binascii}

Módulo de suporte contendo conversões ASCII para binário e binário para ASCII.

@geindex RFC; RFC 1521

@item RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html} - MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

Section 5.2, “Base64 Content-Transfer-Encoding,” provides the definition of the
base64 encoding.
@end table


@node binascii — Converte entre binário e ASCII,quopri — Codifica e decodifica dados MIME imprimidos entre aspas,base64 — Base16 Base32 Base64 Base85 Data Encodings,Manuseio de Dados na Internet
@anchor{library/binascii doc}@anchor{3967}@anchor{library/binascii binascii-convert-between-binary-and-ascii}@anchor{3968}@anchor{library/binascii module-binascii}@anchor{10}@anchor{library/binascii translation-repo}@anchor{3969}
@subsection @code{binascii} — Converte entre binário e ASCII


@geindex module; binascii

@geindex módulo;base64


__________________________________________________________________


O módulo @ref{10,,binascii} contém vários métodos para converter entre binário e várias representações binárias codificadas em ASCII. Normalmente, você não usará essas funções diretamente, mas usará módulos invólucros como @ref{e,,base64} em vez disso. O módulo @ref{10,,binascii} contém funções de baixo nível escritas em C para maior velocidade que são usadas pelos módulos de nível mais alto.

@cartouche
@quotation Nota 
Funções @code{a2b_*} aceitam strings Unicode contendo apenas caracteres ASCII. Outras funções aceitam apenas @ref{d4f,,objetos bytes ou similares} (como @ref{1c2,,bytes}, @ref{2ea,,bytearray} e outros objetos que suportam o protocolo buffer).


Alterado na versão 3.3: Strings unicode exclusivamente ASCII agora são aceitas pelas funções @code{a2b_*}.

@end quotation
@end cartouche

O módulo @ref{10,,binascii} define as seguintes funções:

@geindex a2b_uu() (no módulo binascii)
@anchor{library/binascii binascii a2b_uu}@anchor{396a}
@deffn {Função} binascii.a2b_uu (string)

Converte uma única linha de dados uuencoded de volta para binário e retorna os dados binários. As linhas normalmente contêm 45 bytes (binários), exceto a última linha. Os dados da linha podem ser seguidos por espaços em branco.
@end deffn

@geindex b2a_uu() (no módulo binascii)
@anchor{library/binascii binascii b2a_uu}@anchor{b33}
@deffn {Função} binascii.b2a_uu (data, *, backtick=False)

Converte dados binários para uma linha de caracteres ASCII, o valor de retorno é a linha convertida, incluindo um caractere de nova linha. O comprimento de `data' deve ser no máximo 45. Se `backtick' for true, zeros são representados por @code{'`'} em vez de espaços.


Alterado na versão 3.7: Adicionado o parâmetro `backtick'.

@end deffn

@geindex a2b_base64() (no módulo binascii)
@anchor{library/binascii binascii a2b_base64}@anchor{1719}
@deffn {Função} binascii.a2b_base64 (string, /, *, strict_mode=False)

Converte um bloco de dados base64 de volta para binário e retorna os dados binários. Mais de uma linha pode ser passada por vez.

Se `strict_mode' for true, somente dados base64 válidos serão convertidos. Dados base64 inválidos levantarão @ref{105c,,binascii.Error}.

base64 válido:


@itemize *

@item 
Em conformidade com 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}.

@item 
Contém apenas caracteres do alfabeto base64.

@item 
Não contém dados excedentes após o preenchimento (incluindo excesso de preenchimento, novas linhas, etc.).

@item 
Não começa com um preenchimento.
@end itemize


Alterado na versão 3.11: Adicionado o parâmetro `strict_mode'.

@end deffn

@geindex b2a_base64() (no módulo binascii)
@anchor{library/binascii binascii b2a_base64}@anchor{c9c}
@deffn {Função} binascii.b2a_base64 (data, *, newline=True)

Converte dados binários para uma linha de caracteres ASCII em codificação base64. O valor de retorno é a linha convertida, incluindo um caractere de nova linha se `newline' for verdadeiro. A saída desta função está em conformidade com 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}.


Alterado na versão 3.6: Adicionado o parâmetro `newline'.

@end deffn

@geindex a2b_qp() (no módulo binascii)
@anchor{library/binascii binascii a2b_qp}@anchor{396b}
@deffn {Função} binascii.a2b_qp (data, header=False)

Convert a block of quoted-printable data back to binary and return the binary
data. More than one line may be passed at a time. If the optional argument
`header' is present and true, underscores will be decoded as spaces.
@end deffn

@geindex b2a_qp() (no módulo binascii)
@anchor{library/binascii binascii b2a_qp}@anchor{396c}
@deffn {Função} binascii.b2a_qp (data, quotetabs=False, istext=True, header=False)

Convert binary data to a line(s) of ASCII characters in quoted-printable
encoding.  The return value is the converted line(s). If the optional argument
`quotetabs' is present and true, all tabs and spaces will be encoded.   If the
optional argument `istext' is present and true, newlines are not encoded but
trailing whitespace will be encoded. If the optional argument `header' is
present and true, spaces will be encoded as underscores per 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}. If the
optional argument `header' is present and false, newline characters will be
encoded as well; otherwise linefeed conversion might corrupt the binary data
stream.
@end deffn

@geindex crc_hqx() (no módulo binascii)
@anchor{library/binascii binascii crc_hqx}@anchor{734}
@deffn {Função} binascii.crc_hqx (data, value)

Compute a 16-bit CRC value of `data', starting with `value' as the
initial CRC, and return the result.  This uses the CRC-CCITT polynomial
`x'@w{^16} + `x'@w{^12} + `x'@w{^5} + 1, often represented as
0x1021.  This CRC is used in the binhex4 format.
@end deffn

@geindex crc32() (no módulo binascii)
@anchor{library/binascii binascii crc32}@anchor{178c}
@deffn {Função} binascii.crc32 (data[, value])

Compute CRC-32, the unsigned 32-bit checksum of `data', starting with an
initial CRC of `value'.  The default initial CRC is zero.  The algorithm
is consistent with the ZIP file checksum.  Since the algorithm is designed for
use as a checksum algorithm, it is not suitable for use as a general hash
algorithm.  Use as follows:

@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


Alterado na versão 3.0: O resultado é sempre sem sinal.

@end deffn

@geindex b2a_hex() (no módulo binascii)
@geindex hexlify() (no módulo binascii)
@anchor{library/binascii binascii b2a_hex}@anchor{25ae}
@deffn {Função} binascii.b2a_hex (data[, sep[, bytes_per_sep=1]])
@anchor{library/binascii binascii hexlify}@anchor{396d}
@deffnx {Função} binascii.hexlify (data[, sep[, bytes_per_sep=1]])

Return the hexadecimal representation of the binary `data'.  Every byte of
`data' is converted into the corresponding 2-digit hex representation.  The
returned bytes object is therefore twice as long as the length of `data'.

Similar functionality (but returning a text string) is also conveniently
accessible using the @ref{d8d,,bytes.hex()} method.

If `sep' is specified, it must be a single character str or bytes object.
It will be inserted in the output after every `bytes_per_sep' input bytes.
Separator placement is counted from the right end of the output by default,
if you wish to count from the left, supply a negative `bytes_per_sep' value.

@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


Alterado na versão 3.8: The `sep' and `bytes_per_sep' parameters were added.

@end deffn

@geindex a2b_hex() (no módulo binascii)
@geindex unhexlify() (no módulo binascii)
@anchor{library/binascii binascii a2b_hex}@anchor{25af}
@deffn {Função} binascii.a2b_hex (hexstr)
@anchor{library/binascii binascii unhexlify}@anchor{1bbf}
@deffnx {Função} binascii.unhexlify (hexstr)

Return the binary data represented by the hexadecimal string `hexstr'.  This
function is the inverse of @ref{25ae,,b2a_hex()}. `hexstr' must contain an even number
of hexadecimal digits (which can be upper or lower case), otherwise an
@ref{105c,,Error} exception is raised.

Similar functionality (accepting only text string arguments, but more
liberal towards whitespace) is also accessible using the
@ref{b02,,bytes.fromhex()} class method.
@end deffn

@geindex Error
@anchor{library/binascii binascii Error}@anchor{105c}
@deffn {Exceção} binascii.Error

Exception raised on errors. These are usually programming errors.
@end deffn

@geindex Incomplete
@anchor{library/binascii binascii Incomplete}@anchor{396e}
@deffn {Exceção} binascii.Incomplete

Exception raised on incomplete data. These are usually not programming errors,
but may be handled by reading a little more data and trying again.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{e,,base64}

Support for RFC compliant base64-style encoding in base 16, 32, 64,
and 85.

@item Módulo @ref{b7,,quopri}

Support for quoted-printable encoding used in MIME email messages.
@end table


@node quopri — Codifica e decodifica dados MIME imprimidos entre aspas,,binascii — Converte entre binário e ASCII,Manuseio de Dados na Internet
@anchor{library/quopri doc}@anchor{396f}@anchor{library/quopri module-quopri}@anchor{b7}@anchor{library/quopri quopri-encode-and-decode-mime-quoted-printable-data}@anchor{3970}@anchor{library/quopri translation-repo}@anchor{3971}
@subsection @code{quopri} — Codifica e decodifica dados MIME imprimidos entre aspas


@geindex module; quopri

`Código-fonte:' Lib/quopri.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/quopri.py}

@geindex imprimíveis entre aspas;codificação
@geindex MIME;codificação de imprimíveis entre aspas


__________________________________________________________________


Este módulo realiza codificação e decodificação de transporte imprimida entre aspas, como definido em 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}: “MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies”. A codificação imprimida entre aspas é projetada para dados em que há relativamente poucos caracteres não imprimíveis; o esquema de codificação base64 disponível através do módulo @ref{e,,base64} é mais compacto se existirem muitos desses caracteres, como no envio de um arquivo gráfico.

@geindex decode() (no módulo quopri)
@anchor{library/quopri quopri decode}@anchor{25b1}
@deffn {Função} quopri.decode (input, output, header=False)

Decodifica o conteúdo do arquivo `input' e escreve os dados binários decodificados resultantes no arquivo `output'. `input' e `output' devem ser @ref{1203,,objetos arquivos binários}. Se o argumento opcional `header' estiver presente e for true, o sublinhado será decodificado como espaço. Isso é usado para decodificar cabeçalhos codificados em “Q”, conforme descrito em 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}: “MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text”.
@end deffn

@geindex encode() (no módulo quopri)
@anchor{library/quopri quopri encode}@anchor{25b0}
@deffn {Função} quopri.encode (input, output, quotetabs, header=False)

Codifica o conteúdo do arquivo `input' e grava os dados imprimíveis entre aspas resultantes no arquivo `output'. `input' e `output' devem ser @ref{1203,,objetos arquivos binários}. `quotetabs', um sinalizador não opcional que controla a codificação de espaços e tabulações incorporados; quando true, codifica esses espaços em branco incorporados e, quando false, os deixa sem codificação. Observe que os espaços e tabulações que aparecem no final das linhas são sempre codificados, conforme 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}. `header' é um sinalizador que controla se os espaços são codificados como sublinhados, conforme 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}.
@end deffn

@geindex decodestring() (no módulo quopri)
@anchor{library/quopri quopri decodestring}@anchor{3972}
@deffn {Função} quopri.decodestring (s, header=False)

Como @ref{25b1,,decode()}, exceto pelo fato de aceitar uma fonte @ref{1c2,,bytes} e retornar o correspondente decodificado @ref{1c2,,bytes}.
@end deffn

@geindex encodestring() (no módulo quopri)
@anchor{library/quopri quopri encodestring}@anchor{3973}
@deffn {Função} quopri.encodestring (s, quotetabs=False, header=False)

Como @ref{25b0,,encode()}, exceto pelo fato de aceitar uma fonte @ref{1c2,,bytes} e retornar o @ref{1c2,,bytes} codificado correspondente. Por padrão, envia um valor @code{False} para o parâmetro `quotetabs' da função @ref{25b0,,encode()}.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{e,,base64}

Codifica e decodifica dados de base64 MIME
@end table


@node Ferramentas de Processamento de Markup Estruturado,Protocolos de Internet e Suporte,Manuseio de Dados na Internet,A Biblioteca Padrão do Python
@anchor{library/markup doc}@anchor{3974}@anchor{library/markup markup}@anchor{3975}@anchor{library/markup structured-markup-processing-tools}@anchor{3976}@anchor{library/markup translation-repo}@anchor{3977}
@section Ferramentas de Processamento de Markup Estruturado


O Python suporta uma variedade de módulos para trabalhar com vários formatos de marcação de dados estruturados. Isso inclui módulos para trabalhar com o Standard Generalized Markup Language (SGML) e o Hypertext Markup Language (HTML) e várias interfaces para trabalhar com o XML (Extensible Markup Language).

@menu
* html — Suporte HTML (HyperText Markup Language): html — Suporte HTML HyperText Markup Language. 
* html.parser — Analisador simples de HTML e XHTML: html parser — Analisador simples de HTML e XHTML. 
* html.entities — Definições de entidades gerais de HTML: html entities — Definições de entidades gerais de HTML. 
* Módulos de Processamento de XML:: 
* xml.etree.ElementTree — A API XML ElementTree: xml etree ElementTree — A API XML ElementTree. 
* 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 — Suporte para construir árvores parciais de DOM: xml dom pulldom — Suporte para construir árvores parciais de DOM. 
* xml.sax — Support for SAX2 parsers: xml sax — Support for SAX2 parsers. 
* xml.sax.handler — Classes base para manipuladores de SAX: xml sax handler — Classes base para manipuladores de SAX. 
* xml.sax.saxutils — Utilitários de SAX: xml sax saxutils — Utilitários de SAX. 
* 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 — Suporte HTML HyperText Markup Language,html parser — Analisador simples de HTML e XHTML,,Ferramentas de Processamento de Markup Estruturado
@anchor{library/html doc}@anchor{3978}@anchor{library/html html-hypertext-markup-language-support}@anchor{3979}@anchor{library/html module-html}@anchor{6b}
@subsection @code{html} — Suporte HTML (HyperText Markup Language)


@geindex module; html

`Código-fonte:' Lib/html/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/html/__init__.py}


__________________________________________________________________


Este módulo define utilitários para manipular HTML.

@geindex escape() (no módulo html)
@anchor{library/html html escape}@anchor{1044}
@deffn {Função} html.escape (s, quote=True)

Converte os caracteres @code{&}, @code{<} e @code{>} na string `s' para sequências seguras em HTML. Use se necessitar exibir texto que possa conter estes caracteres no HTML. Se o flag opcional `quote' é verdadeiro (padrão), os caracteres (@code{"}) e (@code{'}) também são convertidos; isso auxilia na inclusão de valores delimitados por aspas num atributo HTML, como em @code{<a href="...">}. Se `quote' for definido para falso, os caracteres (@code{"}) e (@code{'}) não são traduzidos.


Adicionado na versão 3.2.

@end deffn

@geindex unescape() (no módulo html)
@anchor{library/html html unescape}@anchor{95e}
@deffn {Função} html.unescape (s)

Converte todas as referências de caracteres numéricos e nomeados (ex. @code{&gt;}, @code{&#62;}, @code{&#x3e;}) na string `s' para caracteres Unicode correspondentes. Essa função usa as regras definidas pelo padrão HTML 5 para referências de caracteres, sejam válidas ou inválidas, e a @ref{1111,,lista de referência de caracteres nomeados do HTML 5}.


Adicionado na versão 3.4.

@end deffn


__________________________________________________________________


Sub módulos no pacote @code{html} são:


@itemize *

@item 
@ref{6d,,html.parser} – analisador HTML/XHTML com modo de análise branda

@item 
@ref{6c,,html.entities} – definições das entidade HTML
@end itemize

@node html parser — Analisador simples de HTML e XHTML,html entities — Definições de entidades gerais de HTML,html — Suporte HTML HyperText Markup Language,Ferramentas de Processamento de Markup Estruturado
@anchor{library/html parser doc}@anchor{397a}@anchor{library/html parser html-parser-simple-html-and-xhtml-parser}@anchor{397b}@anchor{library/html parser module-html parser}@anchor{6d}@anchor{library/html parser translation-repo}@anchor{397c}
@subsection @code{html.parser} — Analisador simples de HTML e XHTML


@geindex module; html.parser

`Código-fonte:' Lib/html/parser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/html/parser.py}

@geindex HTML
@geindex XHTML


__________________________________________________________________


Este módulo define uma classe @ref{87b,,HTMLParser} que serve como base para analisar arquivos de texto formatados em HTML (HyperText Markup Language) e XHTML.

@geindex HTMLParser (classe em html.parser)
@anchor{library/html parser html parser HTMLParser}@anchor{87b}
@deffn {Classe} html.parser.HTMLParser (*, convert_charrefs=True, scripting=False)

Cria uma instância de analisador sintático capaz de analisar marcação inválida.

Se `convert_charrefs' for verdadeiro (o padrão), todas as referências de caracteres (exceto as de elementos como @code{script} e @code{style}) serão convertidas automaticamente para os caracteres Unicode correspondentes.

Se `scripting' for falso (o padrão), o conteúdo do elemento @code{noscript} será analisado normalmente; se for verdadeiro, será retornado como está, sem ser analisado.

Uma instância de @ref{87b,,HTMLParser} recebe dados HTML e chama métodos de tratamento quando encontra tags de abertura, tags de fechamento, texto, comentários e outros elementos de marcação. O usuário deve criar uma subclasse de @ref{87b,,HTMLParser} e substituir seus métodos para implementar o comportamento desejado.

Este analisador sintático não verifica se as tags de fechamento correspondem às tags de abertura nem chama o manipulador de tags de fechamento para elementos que são fechados implicitamente pelo fechamento de um elemento externo.


Alterado na versão 3.4: Adicionado o argumento nomeado `convert_charrefs'.



Alterado na versão 3.5: O valor padrão para o argumento `convert_charrefs' agora é @code{True}.



Alterado na versão 3.13.10: Adicionado o parâmetro `scripting'.

@end deffn

@menu
* Exemplo de aplicação para análise de HTML:: 
* Métodos HTMLParser:: 
* Exemplos: Exemplos<24>. 

@end menu

@node Exemplo de aplicação para análise de HTML,Métodos HTMLParser,,html parser — Analisador simples de HTML e XHTML
@anchor{library/html parser example-html-parser-application}@anchor{397d}
@subsubsection Exemplo de aplicação para análise de HTML


Como exemplo básico, abaixo está um analisador HTML simples que usa a classe @ref{87b,,HTMLParser} para exibir as tags de abertura, tags de fechamento e dados à medida que são encontrados:

@example
from html.parser import HTMLParser

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Encontrada a tag de abertura  :", tag)

    def handle_endtag(self, tag):
        print("Encontrada a tag de fechamento:", tag)

    def handle_data(self, data):
        print("Encontrados alguns dados      :", data)

parser = MyHTMLParser()
parser.feed('<html><head><title>Teste</title></head>'
            '<body><h1>Me analise!</h1></body></html>')
@end example

A saída então será:

@example
Encontrada a tag de abertura  : html
Encontrada a tag de abertura  : head
Encontrada a tag de abertura  : title
Encontrados alguns dados      : Teste
Encontrada a tag de fechamento: title
Encontrada a tag de fechamento: head
Encontrada a tag de abertura  : body
Encontrada a tag de abertura  : h1
Encontrados alguns dados      : Me analise!
Encontrada a tag de fechamento: h1
Encontrada a tag de fechamento: body
Encontrada a tag de fechamento: html
@end example

@node Métodos HTMLParser,Exemplos<24>,Exemplo de aplicação para análise de HTML,html parser — Analisador simples de HTML e XHTML
@anchor{library/html parser htmlparser-methods}@anchor{397e}
@subsubsection Métodos @code{HTMLParser}


Instâncias de @ref{87b,,HTMLParser} têm os seguintes métodos:

@geindex feed() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser feed}@anchor{397f}
@deffn {Método} HTMLParser.feed (data)

Fornece algum texto ao analisador. Ele será processado na medida em que consistir em elementos completos; dados incompletos serão armazenados em buffer até que mais dados sejam fornecidos ou que o método @ref{162e,,close()} seja chamado. Os dados devem ser do tipo @ref{44c,,str}.
@end deffn

@geindex close() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser close}@anchor{162e}
@deffn {Método} HTMLParser.close ()

Força o processamento de todos os dados em buffer como se fossem seguidos por uma marca de fim de arquivo. Este método pode ser redefinido por uma classe derivada para definir processamento adicional no final da entrada, mas a versão redefinida deve sempre chamar o método @ref{162e,,close()} da classe base @ref{87b,,HTMLParser}.
@end deffn

@geindex reset() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser reset}@anchor{3980}
@deffn {Método} HTMLParser.reset ()

Reinicializa a instância. Perde todos os dados não processados. Este método é chamado implicitamente no momento da instanciação.
@end deffn

@geindex getpos() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser getpos}@anchor{3981}
@deffn {Método} HTMLParser.getpos ()

Retorna o número da linha atual e o deslocamento.
@end deffn

@geindex get_starttag_text() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser get_starttag_text}@anchor{3982}
@deffn {Método} HTMLParser.get_starttag_text ()

Retorna o texto da tag de abertura aberta mais recentemente. Normalmente, isso não é necessário para processamento estruturado, mas pode ser útil ao lidar com HTML “como implantado” ou para regenerar a entrada com alterações mínimas (o espaço em branco entre os atributos pode ser preservado, etc.).
@end deffn

Os seguintes métodos são chamados quando elementos de dados ou de marcação são encontrados e devem ser sobrescritos em uma subclasse. As implementações da classe base não fazem nada (exceto por @ref{3983,,handle_startendtag()}):

@geindex handle_starttag() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_starttag}@anchor{3984}
@deffn {Método} HTMLParser.handle_starttag (tag, attrs)

Este método é chamado para manipular a tag de abertura de um elemento (por exemplo, @code{<div id="main">}).

O argumento `tag' é o nome da tag convertido para minúsculas. O argumento `attrs' é uma lista de pares @code{(nome, valor)} contendo os atributos encontrados dentro dos colchetes @code{<>} da tag. O `nome' será traduzido para minúsculas, as aspas no `valor' foram removidas e as referências a caracteres e entidades foram substituídas.

Por exemplo, para a tag @code{<A HREF="https://www.cwi.nl/">}, este método seria chamado como @code{handle_starttag('a', [('href', 'https://www.cwi.nl/')])}.

Todas as referências de entidade de @ref{6c,,html.entities} são substituídas nos valores dos atributos.
@end deffn

@geindex handle_endtag() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_endtag}@anchor{3985}
@deffn {Método} HTMLParser.handle_endtag (tag)

Este método é chamado para manipular a tag de fechamento de um elemento (por exemplo, @code{</div>}).

O argumento `tag' é o nome da etiqueta convertido para letras minúsculas.
@end deffn

@geindex handle_startendtag() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_startendtag}@anchor{3983}
@deffn {Método} HTMLParser.handle_startendtag (tag, attrs)

Similar a @ref{3984,,handle_starttag()}, mas chamado quando o analisador sintático encontra uma tag vazia no estilo XHTML (@code{<img ... />}). Este método pode ser substituído por subclasses que requerem essa informação lexical específica; a implementação padrão simplesmente chama @ref{3984,,handle_starttag()} e @ref{3985,,handle_endtag()}.
@end deffn

@geindex handle_data() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_data}@anchor{3986}
@deffn {Método} HTMLParser.handle_data (data)

Este método é chamado para processar dados arbitrários (por exemplo, nós de texto e o conteúdo de elementos como @code{script} e @code{style}).
@end deffn

@geindex handle_entityref() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_entityref}@anchor{3987}
@deffn {Método} HTMLParser.handle_entityref (name)

Este método é chamado para processar uma referência de caractere nomeada no formato @code{&name;} (por exemplo, @code{&gt;}), onde `name' é uma referência de entidade genérica (por exemplo, @code{'gt'}). Este método só é chamado se `convert_charrefs' for falso.
@end deffn

@geindex handle_charref() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_charref}@anchor{3988}
@deffn {Método} HTMLParser.handle_charref (name)

Este método é chamado para processar referências de caracteres numéricos decimais e hexadecimais no formato @code{&#@var{NNN};} e @code{&#x@var{NNN};}. Por exemplo, o equivalente decimal para @code{&gt;} é @code{&#62;}, enquanto o hexadecimal é @code{&#x3E;}; neste caso, o método receberá @code{'62'} ou @code{'x3E'}. Este método só é chamado se `convert_charrefs' for falso.
@end deffn

@geindex handle_comment() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_comment}@anchor{3989}
@deffn {Método} HTMLParser.handle_comment (data)

Este método é chamado quando um comentário é encontrado (por exemplo, @code{<!--comentário-->}).

Por exemplo, o comentário @code{<!-- comentário -->} fará com que este método seja chamado com o argumento @code{' comentário '}.

O conteúdo dos comentários condicionais do Internet Explorer (condcoms) também será enviado para este método, portanto, para @code{<!--[if IE 9]>conteúdo específico do IE9<![endif]-->}, este método receberá @code{'[if IE 9]>conteúdo específico do IE9<![endif]'}.
@end deffn

@geindex handle_decl() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_decl}@anchor{398a}
@deffn {Método} HTMLParser.handle_decl (decl)

Este método é chamado para lidar com uma declaração de doctype HTML (por exemplo, @code{<!DOCTYPE html>}).

O parâmetro `decl' será todo o conteúdo da declaração dentro da marcação @code{<!...>} (por exemplo, @code{'DOCTYPE html'}).
@end deffn

@geindex handle_pi() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser handle_pi}@anchor{398b}
@deffn {Método} HTMLParser.handle_pi (data)

Método chamado quando uma instrução de processamento é encontrada. O parâmetro `data' conterá a instrução de processamento completa. Por exemplo, para a instrução de processamento @code{<?proc color='red'>}, este método seria chamado como @code{handle_pi("proc color='red'")}. Ele foi projetado para ser substituído por uma classe derivada; a implementação da classe base não faz nada.

@cartouche
@quotation Nota 
A classe @ref{87b,,HTMLParser} usa as regras sintáticas SGML para processar instruções. Uma instrução de processamento XHTML que usa o caractere @code{'?'} no final fará com que o @code{'?'} seja incluído em `data'.
@end quotation
@end cartouche
@end deffn

@geindex unknown_decl() (método html.parser.HTMLParser)
@anchor{library/html parser html parser HTMLParser unknown_decl}@anchor{398c}
@deffn {Método} HTMLParser.unknown_decl (data)

Este método é chamado quando uma declaração não reconhecida é lida pelo analisador sintático.

O parâmetro `data' será todo o conteúdo da declaração dentro da marcação @code{<![...]>}. Às vezes, é útil que ele seja sobrescrito por uma classe derivada. A implementação da classe base não faz nada.
@end deffn

@node Exemplos<24>,,Métodos HTMLParser,html parser — Analisador simples de HTML e XHTML
@anchor{library/html parser examples}@anchor{398d}@anchor{library/html parser htmlparser-examples}@anchor{398e}
@subsubsection Exemplos


A classe a seguir implementa um analisador sintático que será usado para ilustrar mais exemplos:

@example
from html.parser import HTMLParser
from html.entities import name2codepoint

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Tag inicial:", tag)
        for attr in attrs:
            print("     attr:", attr)

    def handle_endtag(self, tag):
        print("Tag final  :", tag)

    def handle_data(self, data):
        print("Dados      :", data)

    def handle_comment(self, data):
        print("Comentário :", data)

    def handle_entityref(self, name):
        c = chr(name2codepoint[name])
        print("Ent nomeada:", 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

Analisando um 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

Analisando um elemento com alguns atributos e um título:

@example
>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
Tag inicial: img
     attr: ('src', 'python-logo.png')
     attr: ('alt', 'The Python logo')
>>>
>>> parser.feed('<h1>Python</h1>')
Tag inicial: h1
Dados      : Python
Tag final  : h1
@end example

O conteúdo de elementos como @code{script} e @code{style} é retornado como está, sem mais análises:

@example
>>> parser.feed('<style type="text/css">#python @{ color: green @}</style>')
Tag inicial: style
     attr: ('type', 'text/css')
Dados      : #python @{ color: green @}
Tag final  : style

>>> parser.feed('<script type="text/javascript">'
...             'alert("<strong>hello! &#9786;</strong>");</script>')
Tag inicial: script
     attr: ('type', 'text/javascript')
Dados      : alert("<strong>hello! &#9786;</strong>");
Tag final  : script
@end example

Analisando comentários:

@example
>>> parser.feed('<!-- a comment -->'
...             '<!--[if IE 9]>IE-specific content<![endif]-->')
Comentário : a comment
Comentário : [if IE 9]>IE-specific content<![endif]
@end example

Analisando referências de caracteres nomeadas e numéricas e convertendo-as para o caractere correto (nota: essas 3 referências são todas equivalentes a @code{'>'}):

@example
>>> parser = MyHTMLParser()
>>> parser.feed('&gt;&#62;&#x3E;')
Data     : >>>

>>> parser = MyHTMLParser(convert_charrefs=False)
>>> parser.feed('&gt;&#62;&#x3E;')
Named ent: >
Num ent  : >
Num ent  : >
@end example

Alimentar o @ref{397f,,feed()} com blocos incompletos funciona, mas @ref{3986,,handle_data()} pode ser chamado mais de uma vez se `convert_charrefs' for falso:

@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

Analisando HTML inválido (por exemplo, atributos sem aspas) também funciona:

@example
>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
Tag inicial: p
Tag inicial: a
     attr: ('class', 'link')
     attr: ('href', '#main')
Dados      : tag soup
Tag final  : p
Tag final  : a
@end example

@node html entities — Definições de entidades gerais de HTML,Módulos de Processamento de XML,html parser — Analisador simples de HTML e XHTML,Ferramentas de Processamento de Markup Estruturado
@anchor{library/html entities doc}@anchor{398f}@anchor{library/html entities html-entities-definitions-of-html-general-entities}@anchor{3990}@anchor{library/html entities module-html entities}@anchor{6c}@anchor{library/html entities translation-repo}@anchor{3991}
@subsection @code{html.entities} — Definições de entidades gerais de HTML


@geindex module; html.entities

`Código-fonte:' Lib/html/entities.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/html/entities.py}


__________________________________________________________________


Esse módulo define quatro dicionários, @ref{1111,,html5}, @ref{3992,,name2codepoint}, @ref{3993,,codepoint2name} e @ref{3994,,entitydefs}.

@geindex html5 (no módulo html.entities)
@anchor{library/html entities html entities html5}@anchor{1111}
@deffn {Dado} html.entities.html5

Um dicionário que mapeia referências de caracteres nomeados em HTML5 @footnote{
Veja @indicateurl{https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references}
} para os caracteres Unicode equivalentes, por exemplo, @code{html5['gt;'] == '>'}. Note que o caractere de ponto e vírgula final está incluído no nome (por exemplo, @code{'gt;'}), entretanto alguns dos nomes são aceitos pelo padrão mesmo sem o ponto e vírgula: neste caso o nome está presente com e sem o @code{';'}. Veja também @ref{95e,,html.unescape()}.


Adicionado na versão 3.3.

@end deffn

@geindex entitydefs (no módulo html.entities)
@anchor{library/html entities html entities entitydefs}@anchor{3994}
@deffn {Dado} html.entities.entitydefs

Um dicionário que mapeia as definições de entidade XHTML 1.0 para seu texto substituto em ISO Latin-1.
@end deffn

@geindex name2codepoint (no módulo html.entities)
@anchor{library/html entities html entities name2codepoint}@anchor{3992}
@deffn {Dado} html.entities.name2codepoint

Um dicionário que mapeia nomes de entidades HTML4 para os pontos de código Unicode.
@end deffn

@geindex codepoint2name (no módulo html.entities)
@anchor{library/html entities html entities codepoint2name}@anchor{3993}
@deffn {Dado} html.entities.codepoint2name

Um dicionário que mapeia pontos de código Unicode para nomes de entidades HTML4.
@end deffn

@node Módulos de Processamento de XML,xml etree ElementTree — A API XML ElementTree,html entities — Definições de entidades gerais de HTML,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml doc}@anchor{3995}@anchor{library/xml module-xml}@anchor{120}@anchor{library/xml translation-repo}@anchor{3996}@anchor{library/xml xml}@anchor{3997}@anchor{library/xml xml-processing-modules}@anchor{3998}
@subsection Módulos de Processamento de XML


@geindex module; xml

`Código-fonte:' Lib/xml/@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/}


__________________________________________________________________


As interfaces do Python para processar XML estão agrupadas no pacote @code{xml}.

@cartouche
@quotation Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche

É importante observar que os módulos no pacote @ref{120,,xml} exigem que está disponível pelo menos um analisador sintático XML compatível com SAX. O analisador sintático Expat está incluído no Python, então o módulo @ref{126,,xml.parsers.expat} estará sempre disponível.

A documentação para os pacotes @ref{121,,xml.dom} e @ref{129,,xml.sax} são a definição das ligações Python para as interfaces DOM e SAX.

Os submódulos de manipulação XML são:


@itemize *

@item 
@ref{125,,xml.etree.ElementTree}: a API de ElementTree, um processador XML simples e leve
@end itemize



@itemize *

@item 
@ref{121,,xml.dom}: a definição da API de DOM

@item 
@ref{122,,xml.dom.minidom}: uma implementação mínima do DOM

@item 
suporte para construir árvores parciais de DOM no @ref{123,,xml.dom.pulldom}
@end itemize



@itemize *

@item 
@ref{129,,xml.sax}: Classe base SAX2 e funções de conveniência

@item 
@ref{126,,xml.parsers.expat}: a ligação do analisador sintático Expat
@end itemize
@anchor{library/xml xml-security}@anchor{3999}
@menu
* Segurança no XML:: 

@end menu

@node Segurança no XML,,,Módulos de Processamento de XML
@anchor{library/xml id1}@anchor{399a}@anchor{library/xml xml-vulnerabilities}@anchor{399b}
@subsubsection Segurança no XML


Um atacante pode abusar dos recursos XML para realizar ataques de negação de serviço, acessar arquivos locais, gerar conexões de rede com outras máquinas ou contornar firewalls. quando XML controlado pelo atacante está sendo analisado, no Python ou de qualquer outra forma.

Os analisadores XML embutidos do Python dependem da biblioteca libexpat@footnote{https://github.com/libexpat/libexpat}, comumente chamada Expat, para análise de XML.

Por padrão, Expat não acessa arquivos locais nem cria conexões de rede.

Versões do Expat anteriores à 2.7.2 podem ser vulneráveis às vulnerabilidades “billion laughs”, “quadratic blowup” e “large tokens”, ou ao uso desproporcional de memória dinâmica. O Python inclui uma cópia do Expat, e o uso da versão incluída ou de uma versão do sistema depende de como o interpretador Python @ref{18b5,,foi configurado} no seu ambiente. O Python pode ser vulnerável se usar versões antigas do Expat. Verifique @code{pyexpat.EXPAT_VERSION}.

@ref{12d,,xmlrpc} é `vulnerável' ao ataque “decompression bomb”.


@table @asis

@item billion laughs / exponential entity expansion

O ataque Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs} (bilhões de risadas, em uma tradução livre) - também conhecido como “exponential entity expansion” (expansão exponencial de entidades, em uma tradução livre) - usa vários níveis de entidades aninhadas. Cada entidade se refere a outra entidade várias vezes, e a definição final da entidade contém uma pequena string. A expansão exponencial resulta em vários gigabytes de texto e consome muita memória e tempo de CPU.

@item quadratic blowup entity expansion

Um ataque “quadratic blowup” (explosão quadrática, em uma tradução livre) português) é semelhante a um ataque Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs}; ele abusa da expansão de entidades também. Em vez de entidades aninhadas, ele repete uma grande entidade com alguns milhares de caracteres repetidamente. O ataque não é tão eficiente quanto o caso exponencial, mas evita acionar contramedidas do analisador sintático que proíbem entidades profundamente aninhadas.

@item decompression bomb

“Bombas de descompressão” em uma tradução livre. Também conhecidas como ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}, se aplicam a todas as bibliotecas XML que podem analisar fluxos XML comprimidos, como fluxos de HTTP compactados com gzip ou arquivos comprimidos com LZMA. Para um atacante, isso pode reduzir a quantidade de dados transmitidos em três magnitudes ou mais.

@item large tokens

Expat precisa analisar novamente os símbolos não finalizados; sem a proteção introduzida no Expat 2.6.0, isso pode levar a um tempo de execução quadrático que pode ser usado para causar negação de serviço na aplicação ao analisar XML. O problema é conhecido como 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}.
@end table

@node xml etree ElementTree — A API XML ElementTree,xml dom — The Document Object Model API,Módulos de Processamento de XML,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml etree elementtree doc}@anchor{399c}@anchor{library/xml etree elementtree module-xml etree ElementTree}@anchor{125}@anchor{library/xml etree elementtree translation-repo}@anchor{399d}@anchor{library/xml etree elementtree xml-etree-elementtree-the-elementtree-xml-api}@anchor{399e}
@subsection @code{xml.etree.ElementTree} — A API XML ElementTree


@geindex module; xml.etree.ElementTree

`Código-fonte:' Lib/xml/etree/ElementTree.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/etree/ElementTree.py}


__________________________________________________________________


O módulo @ref{125,,xml.etree.ElementTree} implementa uma API simples e eficiente para análise e criação de dados XML.


Alterado na versão 3.3: Este módulo usará uma implementação rápida sempre que disponível.



Descontinuado desde a versão 3.3: O módulo @code{xml.etree.cElementTree} foi descontinuado.


@cartouche
@quotation Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche

@menu
* Tutorial: Tutorial<3>. 
* Suporte a XPath:: 
* Referência: Referência<4>. 
* Suporte a XInclude:: 
* Referência: Referência<5>. 

@end menu

@node Tutorial<3>,Suporte a XPath,,xml etree ElementTree — A API XML ElementTree
@anchor{library/xml etree elementtree tutorial}@anchor{399f}
@subsubsection Tutorial


Esse é um tutorial curto para usar @ref{125,,xml.etree.ElementTree} (@code{ET} na versão resumida). O objetivo é demonstrar alguns conceitos básicos e trechos de códigos do módulo.

@menu
* Árvore e elementos XML:: 
* Analisando XML:: 
* A API de pull para análise sem bloqueio:: 
* Encontrando elementos interessantes:: 
* Modificando um arquivo XML:: 
* Construindo documentos XML:: 
* Analisando XML com espaços de nomes:: 

@end menu

@node Árvore e elementos XML,Analisando XML,,Tutorial<3>
@anchor{library/xml etree elementtree xml-tree-and-elements}@anchor{39a0}
@subsubsection Árvore e elementos XML


XML é um formato de dados estritamente hierárquico, e a maneira mais natural de representá-lo é como uma árvore. @code{ET} possui duas classes para esse propósito - @ref{955,,ElementTree} representa todo o documento XML como uma árvore e @ref{310,,Element} representa um único nó desta árvore. Interações com o documento inteiro (ler e escrever de/para arquivos) são frequentemente feitos em nível de @ref{955,,ElementTree}. Interações com um único elemento XML e seus subelementos são feitos a nível de @ref{310,,Element} .

@node Analisando XML,A API de pull para análise sem bloqueio,Árvore e elementos XML,Tutorial<3>
@anchor{library/xml etree elementtree elementtree-parsing-xml}@anchor{39a1}@anchor{library/xml etree elementtree parsing-xml}@anchor{39a2}
@subsubsection Analisando XML


Usaremos o documento XML fictício @code{country_data.xml} como dados de amostra para esta seção:

@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

Nós podemos importar esses dados lendo de um arquivo:

@example
import xml.etree.ElementTree as ET
tree = ET.parse('country_data.xml')
root = tree.getroot()
@end example

Ou diretamente de uma string:

@example
root = ET.fromstring(country_data_as_string)
@end example

@ref{39a3,,fromstring()} obtém o XML de uma string e armazena em um @ref{310,,Element}, que será o elemento raiz dessa árvore. Outras funções de análise sintática podem criar um @ref{955,,ElementTree}. Cheque a documentação para se certificar sobre qual dado será retornado.

Assim como um @ref{310,,Element}, @code{root} tem uma tag e um dicionário de atributos:

@example
>>> root.tag
'data'
>>> root.attrib
@{@}
@end example

Ele também tem nós filhos sobre os quais nós podemos iterar:

@example
>>> for child in root:
...     print(child.tag, child.attrib)
...
country @{'name': 'Liechtenstein'@}
country @{'name': 'Singapore'@}
country @{'name': 'Panama'@}
@end example

Nós filhos são os mais próximos, e nós podemos acessar nós específicos por índices:

@example
>>> root[0][1].text
'2008'
@end example

@cartouche
@quotation Nota 
Nem todos os elementos da entrada XML acabarão como elementos da árvore analisada. Atualmente, este módulo ignora quaisquer comentários XML, instruções de processamento e declarações de tipo de documento na entrada. No entanto, árvores construídas usando a API deste módulo, em vez de serem analisadas a partir de texto XML, podem conter comentários e instruções de processamento; eles serão incluídos ao gerar a saída XML. Uma declaração de tipo de documento pode ser acessada passando uma instância personalizada @ref{a5f,,TreeBuilder} para o construtor @ref{a5e,,XMLParser}.
@end quotation
@end cartouche

@node A API de pull para análise sem bloqueio,Encontrando elementos interessantes,Analisando XML,Tutorial<3>
@anchor{library/xml etree elementtree elementtree-pull-parsing}@anchor{102a}@anchor{library/xml etree elementtree pull-api-for-non-blocking-parsing}@anchor{39a4}
@subsubsection A API de pull para análise sem bloqueio


A maioria das funções de análise fornecidas por este módulo exigem que todo o documento seja lido de uma só vez antes de retornar qualquer resultado. É possível usar um @ref{a5e,,XMLParser} e alimentar dados nele de forma incremental, mas é uma API de push que chama métodos em um destino da função de retorno, o que é de muito baixo nível e inconveniente para a maioria das necessidades. Às vezes, o que o usuário realmente deseja é ser capaz de analisar XML de forma incremental, sem operações bloqueantes, enquanto desfruta da conveniência de objetos @ref{310,,Element} totalmente construídos.

A ferramenta mais poderosa para fazer isso é @ref{1029,,XMLPullParser}. Ela não requer uma leitura bloqueante para obter os dados XML e, em vez disso, é alimentada com dados de forma incremental com chamadas de @ref{39a5,,XMLPullParser.feed()}. Para obter os elementos XML analisados, chame @ref{39a6,,XMLPullParser.read_events()}. Aqui está um exemplo:

@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

O caso de uso óbvio são aplicações que operam sem bloqueio, onde os dados XML são recebidos de um soquete ou lidos de forma incremental de algum dispositivo de armazenamento. Nesses casos, leituras bloqueantes são inaceitáveis.

Por ser tão flexível, @ref{1029,,XMLPullParser} pode ser inconveniente de usar em casos de uso mais simples. Se você não se importa que sua aplicação bloqueie a leitura de dados XML, mas ainda assim gostaria de ter recursos de análise incremental, dê uma olhada em @ref{273,,iterparse()}. Pode ser útil quando você está lendo um documento XML grande e não deseja mantê-lo totalmente na memória.

Onde o feedback `imediato' através de eventos é desejado, chamar o método @ref{270,,XMLPullParser.flush()} pode ajudar a reduzir o atraso; certifique-se de estudar as notas de segurança relacionadas.

@node Encontrando elementos interessantes,Modificando um arquivo XML,A API de pull para análise sem bloqueio,Tutorial<3>
@anchor{library/xml etree elementtree finding-interesting-elements}@anchor{39a7}
@subsubsection Encontrando elementos interessantes


@ref{310,,Element} possui alguns métodos úteis que ajudam a iterar recursivamente sobre toda a subárvore abaixo dele (seus filhos, seus filhos e assim por diante). Por exemplo, @ref{1394,,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{164d,,Element.findall()} encontra apenas elementos com uma tag que são filhos diretos do elemento atual. @ref{164b,,Element.find()} encontra o `primeiro' filho com uma tag específica, e @ref{39a8,,Element.text} acessa o conteúdo de texto do elemento. @ref{39a9,,Element.get()} acessa os atributos do 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

Uma especificação mais sofisticada de quais elementos procurar é possível usando @ref{bc5,,XPath}.

@node Modificando um arquivo XML,Construindo documentos XML,Encontrando elementos interessantes,Tutorial<3>
@anchor{library/xml etree elementtree modifying-an-xml-file}@anchor{39aa}
@subsubsection Modificando um arquivo XML


@ref{955,,ElementTree} fornece uma maneira simples de construir documentos XML e escrevê-los em arquivos. O método @ref{aa4,,ElementTree.write()} serve para esse propósito.

Uma vez criado, um objeto @ref{310,,Element} pode ser manipulado alterando diretamente seus campos (como @ref{39a8,,Element.text}), adicionando e modificando atributos (método @ref{39ab,,Element.set()}), bem como como adicionar novos filhos (por exemplo, com @ref{39ac,,Element.append()}).

Digamos que queremos adicionar um à classificação de cada país e adicionar um atributo @code{updated} ao elemento de classificação:

@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

Nosso XML agora se parece com isto:

@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 remover elementos usando @ref{164f,,Element.remove()}. Digamos que queremos remover todos os países com classificação 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

Observe que a modificação simultânea durante a iteração pode levar a problemas, assim como ao iterar e modificar listas ou dicionários do Python. Portanto, o exemplo primeiro coleta todos os elementos correspondentes com @code{root.findall()}, e só então itera sobre a lista de correspondências.

Nosso XML agora se parece com isto:

@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 Construindo documentos XML,Analisando XML com espaços de nomes,Modificando um arquivo XML,Tutorial<3>
@anchor{library/xml etree elementtree building-xml-documents}@anchor{39ad}
@subsubsection Construindo documentos XML


A função @ref{39ae,,SubElement()} também fornece uma maneira conveniente de criar novos subelementos para um determinado elemento:

@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 Analisando XML com espaços de nomes,,Construindo documentos XML,Tutorial<3>
@anchor{library/xml etree elementtree parsing-xml-with-namespaces}@anchor{39af}
@subsubsection Analisando XML com espaços de nomes


Se a entrada XML tiver espaços de nomes@footnote{https://en.wikipedia.org/wiki/XML_namespace}, tags e atributos com prefixos no formato @code{prefixo:algumatag} serão expandidos para @code{@{uri@}algumatag} onde `prefixo' é substituído pelo `URI' completo. Além disso, se houver um espaço de nomes padrão@footnote{https://www.w3.org/TR/xml-names/#defaulting}, esse URI completo será anexado a todas as tags não prefixadas.

Aqui está um exemplo XML que incorpora dois espaços de nomes, um com o prefixo “fictional” e outro servindo como espaço de nomes padrão:

@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

Uma maneira de pesquisar e explorar este exemplo XML é adicionar manualmente o URI a cada tag ou atributo no xpath de um @ref{164b,,find()} ou @ref{164d,,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

A melhor maneira de pesquisar o exemplo XML com espaço de nomes é criar um dicionário com seus próprios prefixos e usá-los nas funções de pesquisa:

@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

Essas duas abordagens resultam no seguinte:

@example
John Cleese
 |--> Lancelot
 |--> Archie Leach
Eric Idle
 |--> Sir Robin
 |--> Gunther
 |--> Commander Clement
@end example

@node Suporte a XPath,Referência<4>,Tutorial<3>,xml etree ElementTree — A API XML ElementTree
@anchor{library/xml etree elementtree elementtree-xpath}@anchor{bc5}@anchor{library/xml etree elementtree xpath-support}@anchor{39b0}
@subsubsection Suporte a XPath


Este módulo fornece suporte limitado para expressões XPath@footnote{https://www.w3.org/TR/xpath} para localizar elementos em uma árvore. O objetivo é oferecer suporte a um pequeno subconjunto da sintaxe abreviada; um mecanismo XPath completo está fora do escopo do módulo.

@menu
* Exemplo: Exemplo<8>. 
* Supported XPath syntax:: 

@end menu

@node Exemplo<8>,Supported XPath syntax,,Suporte a XPath
@anchor{library/xml etree elementtree example}@anchor{39b1}
@subsubsection Exemplo


Aqui está um exemplo que demonstra alguns dos recursos XPath do módulo. Estaremos usando o documento XML @code{countrydata} da seção @ref{39a1,,Analisando 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 com espaços de nomes, use a notação qualificada usual @code{@{espaço-de-nomes@}tag}:

@example
# All dublin-core "title" tags in the document
root.findall(".//@{http://purl.org/dc/elements/1.1/@}title")
@end example

@node Supported XPath syntax,,Exemplo<8>,Suporte a XPath
@anchor{library/xml etree elementtree supported-xpath-syntax}@anchor{39b2}
@subsubsection Supported XPath syntax



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sintaxe

@tab

Significado

@item

@code{tag}

@tab

Selects all child elements with the given tag.
For example, @code{spam} selects all child elements
named @code{spam}, and @code{spam/egg} selects all
grandchildren named @code{egg} in all children named
@code{spam}.  @code{@{namespace@}*} selects all tags in the
given namespace, @code{@{*@}spam} selects tags named
@code{spam} in any (or no) namespace, and @code{@{@}*}
only selects tags that are not in a namespace.


Alterado na versão 3.8: Support for star-wildcards was added.


@item

@code{*}

@tab

Selects all child elements, including comments and
processing instructions.  For example, @code{*/egg}
selects all grandchildren named @code{egg}.

@item

@code{.}

@tab

Selects the current node.  This is mostly useful
at the beginning of the path, to indicate that it’s
a relative path.

@item

@code{//}

@tab

Selects all subelements, on all levels beneath the
current  element.  For example, @code{.//egg} selects
all @code{egg} elements in the entire tree.

@item

@code{..}

@tab

Selects the parent element.  Returns @code{None} if the
path attempts to reach the ancestors of the start
element (the element @code{find} was called on).

@item

@code{[@@attrib]}

@tab

Selects all elements that have the given attribute.

@item

@code{[@@attrib='value']}

@tab

Selects all elements for which the given attribute
has the given value.  The value cannot contain
quotes.

@item

@code{[@@attrib!='value']}

@tab

Selects all elements for which the given attribute
does not have the given value. The value cannot
contain quotes.


Adicionado na versão 3.10.


@item

@code{[tag]}

@tab

Selects all elements that have a child named
@code{tag}.  Only immediate children are supported.

@item

@code{[.='text']}

@tab

Selects all elements whose complete text content,
including descendants, equals the given @code{text}.


Adicionado na versão 3.7.


@item

@code{[.!='text']}

@tab

Selects all elements whose complete text content,
including descendants, does not equal the given
@code{text}.


Adicionado na versão 3.10.


@item

@code{[tag='text']}

@tab

Selects all elements that have a child named
@code{tag} whose complete text content, including
descendants, equals the given @code{text}.

@item

@code{[tag!='text']}

@tab

Selects all elements that have a child named
@code{tag} whose complete text content, including
descendants, does not equal the given @code{text}.


Adicionado na versão 3.10.


@item

@code{[position]}

@tab

Selects all elements that are located at the given
position.  The position can be either an integer
(1 is the first position), the expression @code{last()}
(for the last position), or a position relative to
the last position (e.g. @code{last()-1}).

@end multitable


Predicates (expressions within square brackets) must be preceded by a tag
name, an asterisk, or another predicate.  @code{position} predicates must be
preceded by a tag name.

@node Referência<4>,Suporte a XInclude,Suporte a XPath,xml etree ElementTree — A API XML ElementTree
@anchor{library/xml etree elementtree reference}@anchor{39b3}
@subsubsection Referência


@menu
* Funções: Funções<9>. 

@end menu

@node Funções<9>,,,Referência<4>
@anchor{library/xml etree elementtree elementtree-functions}@anchor{39b4}@anchor{library/xml etree elementtree functions}@anchor{39b5}
@subsubsection Funções


@geindex canonicalize() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree canonicalize}@anchor{a5d}
@deffn {Função} xml.etree.ElementTree.canonicalize (xml_data=None, *, out=None, from_file=None, **options)

C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/} transformation function.

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.

This function takes an XML data string (`xml_data') or a file path or
file-like object (`from_file') as input, converts it to the canonical
form, and writes it out using the `out' file(-like) object, if provided,
or returns it as a text string if not.  The output file receives text,
not bytes.  It should therefore be opened in text mode with @code{utf-8}
encoding.

Typical uses:

@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

As `options' de configuração são as seguintes:


@itemize -

@item 
`with_comments': set to true to include comments (default: false)

@item 

@table @asis

@item `strip_text': set to true to strip whitespace before and after text content

(default: false)
@end table

@item 

@table @asis

@item `rewrite_prefixes': set to true to replace namespace prefixes by “n@{number@}”

(default: false)
@end table

@item 

@table @asis

@item `qname_aware_tags': a set of qname aware tag names in which prefixes

should be replaced in text content (default: empty)
@end table

@item 

@table @asis

@item `qname_aware_attrs': a set of qname aware attribute names in which prefixes

should be replaced in text content (default: empty)
@end table

@item 
`exclude_attrs': a set of attribute names that should not be serialised

@item 
`exclude_tags': a set of tag names that should not be serialised
@end itemize

In the option list above, “a set” refers to any collection or iterable of
strings, no ordering is expected.


Adicionado na versão 3.8.

@end deffn

@geindex Comment() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree Comment}@anchor{39b6}
@deffn {Função} xml.etree.ElementTree.Comment (text=None)

Comment element factory.  This factory function creates a special element
that will be serialized as an XML comment by the standard serializer.  The
comment string can be either a bytestring or a Unicode string.  `text' is a
string containing the comment string.  Returns an element instance
representing a comment.

Note that @ref{a5e,,XMLParser} skips over comments in the input
instead of creating comment objects for them. An @ref{955,,ElementTree} will
only contain comment nodes if they have been inserted into to
the tree using one of the @ref{310,,Element} methods.
@end deffn

@geindex dump() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree dump}@anchor{39b7}
@deffn {Função} xml.etree.ElementTree.dump (elem)

Writes an element tree or element structure to sys.stdout.  This function
should be used for debugging only.

The exact output format is implementation dependent.  In this version, it’s
written as an ordinary XML file.

`elem' is an element tree or an individual element.


Alterado na versão 3.8: The @ref{39b7,,dump()} function now preserves the attribute order specified
by the user.

@end deffn

@geindex fromstring() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree fromstring}@anchor{39a3}
@deffn {Função} xml.etree.ElementTree.fromstring (text, parser=None)

Parses an XML section from a string constant.  Same as @ref{39b8,,XML()}.  `text'
is a string containing XML data.  `parser' is an optional parser instance.
If not given, the standard @ref{a5e,,XMLParser} parser is used.
Returns an @ref{310,,Element} instance.
@end deffn

@geindex fromstringlist() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree fromstringlist}@anchor{1211}
@deffn {Função} xml.etree.ElementTree.fromstringlist (sequence, parser=None)

Parses an XML document from a sequence of string fragments.  `sequence' is a
list or other sequence containing XML data fragments.  `parser' is an
optional parser instance.  If not given, the standard @ref{a5e,,XMLParser}
parser is used.  Returns an @ref{310,,Element} instance.


Adicionado na versão 3.2.

@end deffn

@geindex indent() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree indent}@anchor{39b9}
@deffn {Função} xml.etree.ElementTree.indent (tree, space='  ', level=0)

Appends whitespace to the subtree to indent the tree visually.
This can be used to generate pretty-printed XML output.
`tree' can be an Element or ElementTree.  `space' is the whitespace
string that will be inserted for each indentation level, two space
characters by default.  For indenting partial subtrees inside of an
already indented tree, pass the initial indentation level as `level'.


Adicionado na versão 3.9.

@end deffn

@geindex iselement() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree iselement}@anchor{39ba}
@deffn {Função} xml.etree.ElementTree.iselement (element)

Check if an object appears to be a valid element object.  `element' is an
element instance.  Return @code{True} if this is an element object.
@end deffn

@geindex iterparse() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree iterparse}@anchor{273}
@deffn {Função} 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{1203,,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{a5e,,XMLParser} parser is used.  `parser' must be a subclass of
@ref{a5e,,XMLParser} and can only use the default @ref{a5f,,TreeBuilder} as a
target. Returns an @ref{1ac,,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.

Note that while @ref{273,,iterparse()} builds the tree incrementally, it issues
blocking reads on `source' (or the file it names).  As such, it’s unsuitable
for applications where blocking reads can’t be made.  For fully non-blocking
parsing, see @ref{1029,,XMLPullParser}.

@cartouche
@quotation Nota 
@ref{273,,iterparse()} only guarantees that it has seen the “>” character of a
starting tag when it emits a “start” event, so the attributes are defined,
but the contents of the text and tail attributes are undefined at that
point.  The same applies to the element children; they may or may not be
present.

If you need a fully populated element, look for “end” events instead.
@end quotation
@end cartouche


Descontinuado desde a versão 3.4: O argumento `parser'.



Alterado na versão 3.8: Os eventos @code{comment} e @code{pi} foram adicionados.



Alterado na versão 3.13: Added the @code{close()} method.

@end deffn

@geindex parse() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree parse}@anchor{39bb}
@deffn {Função} xml.etree.ElementTree.parse (source, parser=None)

Parses an XML section into an element tree.  `source' is a filename or file
object containing XML data.  `parser' is an optional parser instance.  If
not given, the standard @ref{a5e,,XMLParser} parser is used.  Returns an
@ref{955,,ElementTree} instance.
@end deffn

@geindex ProcessingInstruction() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ProcessingInstruction}@anchor{39bc}
@deffn {Função} xml.etree.ElementTree.ProcessingInstruction (target, text=None)

PI element factory.  This factory function creates a special element that
will be serialized as an XML processing instruction.  `target' is a string
containing the PI target.  `text' is a string containing the PI contents, if
given.  Returns an element instance, representing a processing instruction.

Note that @ref{a5e,,XMLParser} skips over processing instructions
in the input instead of creating PI objects for them. An
@ref{955,,ElementTree} will only contain processing instruction nodes if
they have been inserted into to the tree using one of the
@ref{310,,Element} methods.
@end deffn

@geindex register_namespace() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree register_namespace}@anchor{1212}
@deffn {Função} xml.etree.ElementTree.register_namespace (prefix, uri)

Registers a namespace prefix.  The registry is global, and any existing
mapping for either the given prefix or the namespace URI will be removed.
`prefix' is a namespace prefix.  `uri' is a namespace uri.  Tags and
attributes in this namespace will be serialized with the given prefix, if at
all possible.


Adicionado na versão 3.2.

@end deffn

@geindex SubElement() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree SubElement}@anchor{39ae}
@deffn {Função} xml.etree.ElementTree.SubElement (parent, tag, attrib=@{@}, **extra)

Subelement factory.  This function creates an element instance, and appends
it to an existing element.

The element name, attribute names, and attribute values can be either
bytestrings or Unicode strings.  `parent' is the parent element.  `tag' is
the subelement name.  `attrib' is an optional dictionary, containing element
attributes.  `extra' contains additional attributes, given as keyword
arguments.  Returns an element instance.
@end deffn

@geindex tostring() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree tostring}@anchor{102b}
@deffn {Função} xml.etree.ElementTree.tostring (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

Generates a string representation of an XML element, including all
subelements.  `element' is an @ref{310,,Element} instance.  `encoding' @footnote{
The encoding string included in XML output should conform to the
appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} is
the output encoding (default is US-ASCII).  Use @code{encoding="unicode"} to
generate a Unicode string (otherwise, a bytestring is generated).  `method'
is either @code{"xml"}, @code{"html"} or @code{"text"} (default is @code{"xml"}).
`xml_declaration', `default_namespace' and `short_empty_elements' has the same
meaning as in @ref{aa4,,ElementTree.write()}. Returns an (optionally) encoded string
containing the XML data.


Alterado na versão 3.4: Foi adicionado o parâmetro `short_empty_elements'.



Alterado na versão 3.8: Added the `xml_declaration' and `default_namespace' parameters.



Alterado na versão 3.8: The @ref{102b,,tostring()} function now preserves the attribute order
specified by the user.

@end deffn

@geindex tostringlist() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree tostringlist}@anchor{102c}
@deffn {Função} xml.etree.ElementTree.tostringlist (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

Generates a string representation of an XML element, including all
subelements.  `element' is an @ref{310,,Element} instance.  `encoding' @footnote{
The encoding string included in XML output should conform to the
appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} is
the output encoding (default is US-ASCII).  Use @code{encoding="unicode"} to
generate a Unicode string (otherwise, a bytestring is generated).  `method'
is either @code{"xml"}, @code{"html"} or @code{"text"} (default is @code{"xml"}).
`xml_declaration', `default_namespace' and `short_empty_elements' has the same
meaning as in @ref{aa4,,ElementTree.write()}. Returns a list of (optionally) encoded
strings containing the XML data. It does not guarantee any specific sequence,
except that @code{b"".join(tostringlist(element)) == tostring(element)}.


Adicionado na versão 3.2.



Alterado na versão 3.4: Foi adicionado o parâmetro `short_empty_elements'.



Alterado na versão 3.8: Added the `xml_declaration' and `default_namespace' parameters.



Alterado na versão 3.8: The @ref{102c,,tostringlist()} function now preserves the attribute order
specified by the user.

@end deffn

@geindex XML() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XML}@anchor{39b8}
@deffn {Função} xml.etree.ElementTree.XML (text, parser=None)

Parses an XML section from a string constant.  This function can be used to
embed “XML literals” in Python code.  `text' is a string containing XML
data.  `parser' is an optional parser instance.  If not given, the standard
@ref{a5e,,XMLParser} parser is used.  Returns an @ref{310,,Element} instance.
@end deffn

@geindex XMLID() (no módulo xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLID}@anchor{39bd}
@deffn {Função} xml.etree.ElementTree.XMLID (text, parser=None)

Parses an XML section from a string constant, and also returns a dictionary
which maps from element id:s to elements.  `text' is a string containing XML
data.  `parser' is an optional parser instance.  If not given, the standard
@ref{a5e,,XMLParser} parser is used.  Returns a tuple containing an
@ref{310,,Element} instance and a dictionary.
@end deffn

@node Suporte a XInclude,Referência<5>,Referência<4>,xml etree ElementTree — A API XML ElementTree
@anchor{library/xml etree elementtree elementtree-xinclude}@anchor{39be}@anchor{library/xml etree elementtree xinclude-support}@anchor{39bf}
@subsubsection Suporte a XInclude


This module provides limited support for
XInclude directives@footnote{https://www.w3.org/TR/xinclude/}, via the @ref{124,,xml.etree.ElementInclude} helper module.  This module can be used to insert subtrees and text strings into element trees, based on information in the tree.

@menu
* Exemplo: Exemplo<9>. 

@end menu

@node Exemplo<9>,,,Suporte a XInclude
@anchor{library/xml etree elementtree id3}@anchor{39c0}
@subsubsection Exemplo


Here’s an example that demonstrates use of the XInclude module. To include an XML document in the current document, use the @code{@{http://www.w3.org/2001/XInclude@}include} element and set the `parse' attribute to @code{"xml"}, and use the `href' attribute to specify the document to include.

@example
<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <xi:include href="source.xml" parse="xml" />
</document>
@end example

By default, the `href' attribute is treated as a file name. You can use custom loaders to override this behaviour. Also note that the standard helper does not support XPointer syntax.

To process this file, load it as usual, and pass the root element to the @ref{125,,xml.etree.ElementTree} module:

@example
from xml.etree import ElementTree, ElementInclude

tree = ElementTree.parse("document.xml")
root = tree.getroot()

ElementInclude.include(root)
@end example

The ElementInclude module replaces the @code{@{http://www.w3.org/2001/XInclude@}include} element with the root element from the `source.xml' document. The result might look something like this:

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <para>This is a paragraph.</para>
</document>
@end example

If the `parse' attribute is omitted, it defaults to “xml”. The href attribute is required.

To include a text document, use the @code{@{http://www.w3.org/2001/XInclude@}include} element, and set the `parse' attribute to “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

The result might look something like:

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) 2003.
</document>
@end example

@node Referência<5>,,Suporte a XInclude,xml etree ElementTree — A API XML ElementTree
@anchor{library/xml etree elementtree id4}@anchor{39c1}
@subsubsection Referência


@menu
* Funções: Funções<10>. 
* Element Objects:: 
* ElementTree Objects:: 
* QName Objects:: 
* TreeBuilder Objects:: 
* Objetos XMLParser:: 
* XMLPullParser Objects:: 
* Exceções: Exceções<19>. 

@end menu

@node Funções<10>,Element Objects,,Referência<5>
@anchor{library/xml etree elementtree elementinclude-functions}@anchor{39c2}@anchor{library/xml etree elementtree id5}@anchor{39c3}
@subsubsection Funções


@geindex module; xml.etree.ElementInclude

@geindex default_loader() (no 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{39c4}
@deffn {Função} 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{310,,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() (no módulo xml.etree.ElementInclude)
@anchor{library/xml etree elementtree xml etree ElementInclude include}@anchor{39c5}
@deffn {Função} 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{310,,Element} or an
@ref{955,,ElementTree} instance to find such element.
`loader' is an optional resource loader.  If omitted, it defaults to @ref{39c4,,default_loader()}.
If given, it should be a callable that implements the same interface as
@ref{39c4,,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.


Alterado na versão 3.9: Added the `base_url' and `max_depth' parameters.

@end deffn

@node Element Objects,ElementTree Objects,Funções<10>,Referência<5>
@anchor{library/xml etree elementtree element-objects}@anchor{39c6}@anchor{library/xml etree elementtree elementtree-element-objects}@anchor{39c7}
@subsubsection Element Objects


@geindex Element (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree Element}@anchor{310}
@deffn {Classe} xml.etree.ElementTree.Element (tag, attrib=@{@}, **extra)

Element class.  This class defines the Element interface, and provides a
reference implementation of this interface.

The element name, attribute names, and attribute values can be either
bytestrings or Unicode strings.  `tag' is the element name.  `attrib' is
an optional dictionary, containing element attributes.  `extra' contains
additional attributes, given as keyword arguments.

@geindex tag (atributo xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element tag}@anchor{1393}
@deffn {Atributo} tag

A string identifying what kind of data this element represents (the
element type, in other words).
@end deffn

@geindex text (atributo xml.etree.ElementTree.Element)
@geindex tail (atributo xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element text}@anchor{39a8}
@deffn {Atributo} text
@anchor{library/xml etree elementtree xml etree ElementTree Element tail}@anchor{39c8}
@deffnx {Atributo} tail

These attributes can be used to hold additional data associated with
the element.  Their values are usually strings but may be any
application-specific object.  If the element is created from
an XML file, the `text' attribute holds either the text between
the element’s start tag and its first child or end tag, or @code{None}, and
the `tail' attribute holds either the text between the element’s
end tag and the next tag, or @code{None}.  For the XML data

@example
<a><b>1<c>2<d/>3</c></b>4</a>
@end example

the `a' element has @code{None} for both `text' and `tail' attributes,
the `b' element has `text' @code{"1"} and `tail' @code{"4"},
the `c' element has `text' @code{"2"} and `tail' @code{None},
and the `d' element has `text' @code{None} and `tail' @code{"3"}.

To collect the inner text of an element, see @ref{1215,,itertext()}, for
example @code{"".join(element.itertext())}.

Applications may store arbitrary objects in these attributes.
@end deffn

@geindex attrib (atributo xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element attrib}@anchor{39c9}
@deffn {Atributo} attrib

A dictionary containing the element’s attributes.  Note that while the
`attrib' value is always a real mutable Python dictionary, an ElementTree
implementation may choose to use another internal representation, and
create the dictionary only if someone asks for it.  To take advantage of
such implementations, use the dictionary methods below whenever possible.
@end deffn

The following dictionary-like methods work on the element attributes.

@geindex clear() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element clear}@anchor{39ca}
@deffn {Método} clear ()

Resets an element.  This function removes all subelements, clears all
attributes, and sets the text and tail attributes to @code{None}.
@end deffn

@geindex get() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element get}@anchor{39a9}
@deffn {Método} get (key, default=None)

Gets the element attribute named `key'.

Returns the attribute value, or `default' if the attribute was not found.
@end deffn

@geindex items() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element items}@anchor{39cb}
@deffn {Método} items ()

Returns the element attributes as a sequence of (name, value) pairs.  The
attributes are returned in an arbitrary order.
@end deffn

@geindex keys() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element keys}@anchor{39cc}
@deffn {Método} keys ()

Returns the elements attribute names as a list.  The names are returned
in an arbitrary order.
@end deffn

@geindex set() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element set}@anchor{39ab}
@deffn {Método} set (key, value)

Set the attribute `key' on the element to `value'.
@end deffn

Os métodos a seguir funcionam nos filhos do elemento (subelementos).

@geindex append() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element append}@anchor{39ac}
@deffn {Método} append (subelement)

Adds the element `subelement' to the end of this element’s internal list
of subelements.  Raises @ref{2c3,,TypeError} if `subelement' is not an
@ref{310,,Element}.
@end deffn

@geindex extend() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element extend}@anchor{1213}
@deffn {Método} extend (subelements)

Appends `subelements' from an iterable of elements.
Raises @ref{2c3,,TypeError} if a subelement is not an @ref{310,,Element}.


Adicionado na versão 3.2.

@end deffn

@geindex find() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element find}@anchor{164b}
@deffn {Método} find (match, namespaces=None)

Finds the first subelement matching `match'.  `match' may be a tag name
or a @ref{bc5,,path}.  Returns an element instance
or @code{None}.  `namespaces' is an optional mapping from namespace prefix
to full name.  Pass @code{'@w{'}} as prefix to move all unprefixed tag names
in the expression into the given namespace.
@end deffn

@geindex findall() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element findall}@anchor{164d}
@deffn {Método} findall (match, namespaces=None)

Finds all matching subelements, by tag name or
@ref{bc5,,path}.  Returns a list containing all matching
elements in document order.  `namespaces' is an optional mapping from
namespace prefix to full name.  Pass @code{'@w{'}} as prefix to move all
unprefixed tag names in the expression into the given namespace.
@end deffn

@geindex findtext() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element findtext}@anchor{164c}
@deffn {Método} findtext (match, default=None, namespaces=None)

Finds text for the first subelement matching `match'.  `match' may be
a tag name or a @ref{bc5,,path}.  Returns the text content
of the first matching element, or `default' if no element was found.
Note that if the matching element has no text content an empty string
is returned. `namespaces' is an optional mapping from namespace prefix
to full name.  Pass @code{'@w{'}} as prefix to move all unprefixed tag names
in the expression into the given namespace.
@end deffn

@geindex insert() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element insert}@anchor{39cd}
@deffn {Método} insert (index, subelement)

Inserts `subelement' at the given position in this element.  Raises
@ref{2c3,,TypeError} if `subelement' is not an @ref{310,,Element}.
@end deffn

@geindex iter() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element iter}@anchor{1394}
@deffn {Método} iter (tag=None)

Creates a tree @ref{1ac,,iterator} with the current element as the root.
The iterator iterates over this element and all elements below it, in
document (depth first) order.  If `tag' is not @code{None} or @code{'*'}, only
elements whose tag equals `tag' are returned from the iterator.  If the
tree structure is modified during iteration, the result is undefined.


Adicionado na versão 3.2.

@end deffn

@geindex iterfind() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element iterfind}@anchor{1214}
@deffn {Método} iterfind (match, namespaces=None)

Finds all matching subelements, by tag name or
@ref{bc5,,path}.  Returns an iterable yielding all
matching elements in document order. `namespaces' is an optional mapping
from namespace prefix to full name.


Adicionado na versão 3.2.

@end deffn

@geindex itertext() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element itertext}@anchor{1215}
@deffn {Método} itertext ()

Creates a text iterator.  The iterator loops over this element and all
subelements, in document order, and returns all inner text.


Adicionado na versão 3.2.

@end deffn

@geindex makeelement() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element makeelement}@anchor{39ce}
@deffn {Método} makeelement (tag, attrib)

Creates a new element object of the same type as this element.  Do not
call this method, use the @ref{39ae,,SubElement()} factory function instead.
@end deffn

@geindex remove() (método xml.etree.ElementTree.Element)
@anchor{library/xml etree elementtree xml etree ElementTree Element remove}@anchor{164f}
@deffn {Método} remove (subelement)

Removes `subelement' from the element.  Unlike the find* methods this
method compares elements based on the instance identity, not on tag value
or contents.
@end deffn

@ref{310,,Element} objects also support the following sequence type methods
for working with subelements: @ref{130f,,__delitem__()},
@ref{283,,__getitem__()}, @ref{130e,,__setitem__()},
@ref{15b4,,__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


Alterado na versão 3.12: Testing the truth value of an Element emits @ref{1a5,,DeprecationWarning}.


Prior to Python 3.8, the serialisation order of the XML attributes of
elements was artificially made predictable by sorting the attributes by
their name. Based on the now guaranteed ordering of dicts, this arbitrary
reordering was removed in Python 3.8 to preserve the order in which
attributes were originally parsed or created by user code.

In general, user code should try not to depend on a specific ordering of
attributes, given that the XML Information Set@footnote{https://www.w3.org/TR/xml-infoset/} explicitly excludes the attribute
order from conveying information. Code should be prepared to deal with
any ordering on input. In cases where deterministic XML output is required,
e.g. for cryptographic signing or test data sets, canonical serialisation
is available with the @ref{a5d,,canonicalize()} function.

In cases where canonical output is not applicable but a specific attribute
order is still desirable on output, code should aim for creating the
attributes directly in the desired order, to avoid perceptual mismatches
for readers of the code. In cases where this is difficult to achieve, a
recipe like the following can be applied prior to serialisation to enforce
an order independently from the Element creation:

@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 ElementTree Objects,QName Objects,Element Objects,Referência<5>
@anchor{library/xml etree elementtree elementtree-elementtree-objects}@anchor{39cf}@anchor{library/xml etree elementtree elementtree-objects}@anchor{39d0}
@subsubsection ElementTree Objects


@geindex ElementTree (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree}@anchor{955}
@deffn {Classe} xml.etree.ElementTree.ElementTree (element=None, file=None)

ElementTree wrapper class.  This class represents an entire element
hierarchy, and adds some extra support for serialization to and from
standard XML.

`element' is the root element.  The tree is initialized with the contents
of the XML `file' if given.

@geindex _setroot() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree _setroot}@anchor{39d1}
@deffn {Método} _setroot (element)

Replaces the root element for this tree.  This discards the current
contents of the tree, and replaces it with the given element.  Use with
care.  `element' is an element instance.
@end deffn

@geindex find() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree find}@anchor{39d2}
@deffn {Método} find (match, namespaces=None)

Same as @ref{164b,,Element.find()}, starting at the root of the tree.
@end deffn

@geindex findall() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findall}@anchor{39d3}
@deffn {Método} findall (match, namespaces=None)

Same as @ref{164d,,Element.findall()}, starting at the root of the tree.
@end deffn

@geindex findtext() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findtext}@anchor{39d4}
@deffn {Método} findtext (match, default=None, namespaces=None)

Same as @ref{164c,,Element.findtext()}, starting at the root of the tree.
@end deffn

@geindex getroot() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree getroot}@anchor{39d5}
@deffn {Método} getroot ()

Returns the root element for this tree.
@end deffn

@geindex iter() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iter}@anchor{39d6}
@deffn {Método} iter (tag=None)

Creates and returns a tree iterator for the root element.  The iterator
loops over all elements in this tree, in section order.  `tag' is the tag
to look for (default is to return all elements).
@end deffn

@geindex iterfind() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iterfind}@anchor{39d7}
@deffn {Método} iterfind (match, namespaces=None)

Same as @ref{1214,,Element.iterfind()}, starting at the root of the tree.


Adicionado na versão 3.2.

@end deffn

@geindex parse() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree parse}@anchor{39d8}
@deffn {Método} parse (source, parser=None)

Loads an external XML section into this element tree.  `source' is a file
name or @ref{1203,,file object}.  `parser' is an optional parser instance.
If not given, the standard @ref{a5e,,XMLParser} parser is used.  Returns the
section root element.
@end deffn

@geindex write() (método xml.etree.ElementTree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree write}@anchor{aa4}
@deffn {Método} write (file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml', *, short_empty_elements=True)

Writes the element tree to a file, as XML.  `file' is a file name, or a
@ref{1203,,file object} opened for writing.  `encoding' @footnote{
The encoding string included in XML output should conform to the
appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} is the output
encoding (default is US-ASCII).
`xml_declaration' controls if an XML declaration should be added to the
file.  Use @code{False} for never, @code{True} for always, @code{None}
for only if not US-ASCII or UTF-8 or Unicode (default is @code{None}).
`default_namespace' sets the default XML namespace (for “xmlns”).
`method' is either @code{"xml"}, @code{"html"} or @code{"text"} (default is
@code{"xml"}).
The keyword-only `short_empty_elements' parameter controls the formatting
of elements that contain no content.  If @code{True} (the default), they are
emitted as a single self-closed tag, otherwise they are emitted as a pair
of start/end tags.

The output is either a string (@ref{44c,,str}) or binary (@ref{1c2,,bytes}).
This is controlled by the `encoding' argument.  If `encoding' is
@code{"unicode"}, the output is a string; otherwise, it’s binary.  Note that
this may conflict with the type of `file' if it’s an open
@ref{1203,,file object}; make sure you do not try to write a string to a
binary stream and vice versa.


Alterado na versão 3.4: Foi adicionado o parâmetro `short_empty_elements'.



Alterado na versão 3.8: The @ref{aa4,,write()} method now preserves the attribute order specified
by the user.

@end deffn
@end deffn

This is the XML file that is going to be manipulated:

@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

Example of changing the attribute “target” of every link in first paragraph:

@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 QName Objects,TreeBuilder Objects,ElementTree Objects,Referência<5>
@anchor{library/xml etree elementtree elementtree-qname-objects}@anchor{39d9}@anchor{library/xml etree elementtree qname-objects}@anchor{39da}
@subsubsection QName Objects


@geindex QName (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree QName}@anchor{39db}
@deffn {Classe} xml.etree.ElementTree.QName (text_or_uri, tag=None)

QName wrapper.  This can be used to wrap a QName attribute value, in order
to get proper namespace handling on output.  `text_or_uri' is a string
containing the QName value, in the form @{uri@}local, or, if the tag argument
is given, the URI part of a QName.  If `tag' is given, the first argument is
interpreted as a URI, and this argument is interpreted as a local name.
@ref{39db,,QName} instances are opaque.
@end deffn

@node TreeBuilder Objects,Objetos XMLParser,QName Objects,Referência<5>
@anchor{library/xml etree elementtree elementtree-treebuilder-objects}@anchor{39dc}@anchor{library/xml etree elementtree treebuilder-objects}@anchor{39dd}
@subsubsection TreeBuilder Objects


@geindex TreeBuilder (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder}@anchor{a5f}
@deffn {Classe} xml.etree.ElementTree.TreeBuilder (element_factory=None, *, comment_factory=None, pi_factory=None, insert_comments=False, insert_pis=False)

Generic element structure builder.  This builder converts a sequence of
start, data, end, comment and pi method calls to a well-formed element
structure.  You can use this class to build an element structure using
a custom XML parser, or a parser for some other XML-like format.

`element_factory', when given, must be a callable accepting two positional
arguments: a tag and a dict of attributes.  It is expected to return a new
element instance.

The `comment_factory' and `pi_factory' functions, when given, should behave
like the @ref{39b6,,Comment()} and @ref{39bc,,ProcessingInstruction()} functions to
create comments and processing instructions.  When not given, the default
factories will be used.  When `insert_comments' and/or `insert_pis' is true,
comments/pis will be inserted into the tree if they appear within the root
element (but not outside of it).

@geindex close() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder close}@anchor{39de}
@deffn {Método} close ()

Flushes the builder buffers, and returns the toplevel document
element.  Returns an @ref{310,,Element} instance.
@end deffn

@geindex data() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder data}@anchor{39df}
@deffn {Método} data (data)

Adds text to the current element.  `data' is a string.  This should be
either a bytestring, or a Unicode string.
@end deffn

@geindex end() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end}@anchor{1216}
@deffn {Método} end (tag)

Closes the current element.  `tag' is the element name.  Returns the
closed element.
@end deffn

@geindex start() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start}@anchor{1afb}
@deffn {Método} start (tag, attrs)

Opens a new element.  `tag' is the element name.  `attrs' is a dictionary
containing element attributes.  Returns the opened element.
@end deffn

@geindex comment() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder comment}@anchor{39e0}
@deffn {Método} comment (text)

Creates a comment with the given `text'.  If @code{insert_comments} is true,
this will also add it to the tree.


Adicionado na versão 3.8.

@end deffn

@geindex pi() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder pi}@anchor{39e1}
@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.


Adicionado na versão 3.8.

@end deffn

In addition, a custom @ref{a5f,,TreeBuilder} object can provide the
following methods:

@geindex doctype() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder doctype}@anchor{aa6}
@deffn {Método} doctype (name, pubid, system)

Handles a doctype declaration.  `name' is the doctype name.  `pubid' is
the public identifier.  `system' is the system identifier.  This method
does not exist on the default @ref{a5f,,TreeBuilder} class.


Adicionado na versão 3.2.

@end deffn

@geindex start_ns() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start_ns}@anchor{39e2}
@deffn {Método} start_ns (prefix, uri)

Is called whenever the parser encounters a new namespace declaration,
before the @code{start()} callback for the opening element that defines it.
`prefix' is @code{'@w{'}} for the default namespace and the declared
namespace prefix name otherwise.  `uri' is the namespace URI.


Adicionado na versão 3.8.

@end deffn

@geindex end_ns() (método xml.etree.ElementTree.TreeBuilder)
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end_ns}@anchor{39e3}
@deffn {Método} end_ns (prefix)

Is called after the @code{end()} callback of an element that declared
a namespace prefix mapping, with the name of the `prefix' that went
out of scope.


Adicionado na versão 3.8.

@end deffn
@end deffn

@geindex C14NWriterTarget (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree C14NWriterTarget}@anchor{39e4}
@deffn {Classe} 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)

A C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/} writer.  Arguments are the
same as for the @ref{a5d,,canonicalize()} function.  This class does not build a
tree but translates the callback events directly into a serialised form
using the `write' function.


Adicionado na versão 3.8.

@end deffn

@node Objetos XMLParser,XMLPullParser Objects,TreeBuilder Objects,Referência<5>
@anchor{library/xml etree elementtree elementtree-xmlparser-objects}@anchor{39e5}@anchor{library/xml etree elementtree xmlparser-objects}@anchor{39e6}
@subsubsection Objetos XMLParser


@geindex XMLParser (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser}@anchor{a5e}
@deffn {Classe} xml.etree.ElementTree.XMLParser (*, target=None, encoding=None)

This class is the low-level building block of the module.  It uses
@ref{126,,xml.parsers.expat} for efficient, event-based parsing of XML.  It can
be fed XML data incrementally with the @ref{39e7,,feed()} method, and parsing
events are translated to a push API - by invoking callbacks on the `target'
object.  If `target' is omitted, the standard @ref{a5f,,TreeBuilder} is used.
If `encoding' @footnote{
The encoding string included in XML output should conform to the
appropriate standards.  For example, “UTF-8” is valid, but “UTF8” is
not.  See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} is given, the value overrides the
encoding specified in the XML file.


Alterado na versão 3.8: Parameters are now @ref{2a5,,keyword-only}.
The `html' argument is no longer supported.


@geindex close() (método xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser close}@anchor{39e8}
@deffn {Método} close ()

Finishes feeding data to the parser.  Returns the result of calling the
@code{close()} method of the `target' passed during construction; by default,
this is the toplevel document element.
@end deffn

@geindex feed() (método xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser feed}@anchor{39e7}
@deffn {Método} feed (data)

Feeds data to the parser.  `data' is encoded data.
@end deffn

@geindex flush() (método xml.etree.ElementTree.XMLParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser flush}@anchor{26f}
@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{26f,,flush()} temporarily disables reparse deferral
with Expat (if currently enabled) and triggers a reparse.
Disabling reparse deferral has security consequences; please see
@ref{272,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} for details.

Note that @ref{26f,,flush()} has been backported to some prior releases of
CPython as a security fix.  Check for availability of @ref{26f,,flush()}
using @ref{4d2,,hasattr()} if used in code running across a variety of Python
versions.


Adicionado na versão 3.13.

@end deffn

@ref{39e7,,XMLParser.feed()} calls `target''s @code{start(tag, attrs_dict)} method
for each opening tag, its @code{end(tag)} method for each closing tag, and data
is processed by method @code{data(data)}.  For further supported callback
methods, see the @ref{a5f,,TreeBuilder} class.  @ref{39e8,,XMLParser.close()} calls
`target''s method @code{close()}. @ref{a5e,,XMLParser} can be used not only for
building a tree structure. This is an example of counting the maximum depth
of an XML file:

@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 XMLPullParser Objects,Exceções<19>,Objetos XMLParser,Referência<5>
@anchor{library/xml etree elementtree elementtree-xmlpullparser-objects}@anchor{39e9}@anchor{library/xml etree elementtree xmlpullparser-objects}@anchor{39ea}
@subsubsection XMLPullParser Objects


@geindex XMLPullParser (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser}@anchor{1029}
@deffn {Classe} xml.etree.ElementTree.XMLPullParser (events=None)

A pull parser suitable for non-blocking applications.  Its input-side API is
similar to that of @ref{a5e,,XMLParser}, but instead of pushing calls to a
callback target, @ref{1029,,XMLPullParser} collects an internal list of parsing
events and lets the user read from it. `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.

@geindex feed() (método xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser feed}@anchor{39a5}
@deffn {Método} feed (data)

Feed the given bytes data to the parser.
@end deffn

@geindex flush() (método xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser flush}@anchor{270}
@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{270,,flush()} temporarily disables reparse deferral
with Expat (if currently enabled) and triggers a reparse.
Disabling reparse deferral has security consequences; please see
@ref{272,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} for details.

Note that @ref{270,,flush()} has been backported to some prior releases of
CPython as a security fix.  Check for availability of @ref{270,,flush()}
using @ref{4d2,,hasattr()} if used in code running across a variety of Python
versions.


Adicionado na versão 3.13.

@end deffn

@geindex close() (método xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser close}@anchor{39eb}
@deffn {Método} close ()

Signal the parser that the data stream is terminated. Unlike
@ref{39e8,,XMLParser.close()}, this method always returns @ref{675,,None}.
Any events not yet retrieved when the parser is closed can still be
read with @ref{39a6,,read_events()}.
@end deffn

@geindex read_events() (método xml.etree.ElementTree.XMLPullParser)
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser read_events}@anchor{39a6}
@deffn {Método} read_events ()

Return an iterator over the events which have been encountered in the
data fed to the
parser.  The iterator yields @code{(event, elem)} pairs, where `event' is a
string representing the type of event (e.g. @code{"end"}) and `elem' is the
encountered @ref{310,,Element} object, or other context value as follows.


@itemize *

@item 
@code{start}, @code{end}: O Element atual.

@item 
@code{comment}, @code{pi}: the current comment / processing instruction

@item 
@code{start-ns}: a tuple @code{(prefix, uri)} naming the declared namespace
mapping.

@item 
@code{end-ns}: @ref{675,,None} (this may change in a future version)
@end itemize

Events provided in a previous call to @ref{39a6,,read_events()} will not be
yielded again.  Events are consumed from the internal queue only when
they are retrieved from the iterator, so multiple readers iterating in
parallel over iterators obtained from @ref{39a6,,read_events()} will have
unpredictable results.
@end deffn

@cartouche
@quotation Nota 
@ref{1029,,XMLPullParser} only guarantees that it has seen the “>”
character of a starting tag when it emits a “start” event, so the
attributes are defined, but the contents of the text and tail attributes
are undefined at that point.  The same applies to the element children;
they may or may not be present.

If you need a fully populated element, look for “end” events instead.
@end quotation
@end cartouche


Adicionado na versão 3.4.



Alterado na versão 3.8: Os eventos @code{comment} e @code{pi} foram adicionados.

@end deffn

@node Exceções<19>,,XMLPullParser Objects,Referência<5>
@anchor{library/xml etree elementtree exceptions}@anchor{39ec}
@subsubsection Exceções


@geindex ParseError (classe em xml.etree.ElementTree)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError}@anchor{12b9}
@deffn {Classe} xml.etree.ElementTree.ParseError

XML parse error, raised by the various parsing methods in this module when
parsing fails.  The string representation of an instance of this exception
will contain a user-friendly error message.  In addition, it will have
the following attributes available:

@geindex code (atributo xml.etree.ElementTree.ParseError)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError code}@anchor{39ed}
@deffn {Atributo} code

A numeric error code from the expat parser. See the documentation of
@ref{126,,xml.parsers.expat} for the list of error codes and their meanings.
@end deffn

@geindex position (atributo xml.etree.ElementTree.ParseError)
@anchor{library/xml etree elementtree xml etree ElementTree ParseError position}@anchor{39ee}
@deffn {Atributo} position

A tuple of `line', `column' numbers, specifying where the error occurred.
@end deffn
@end deffn

@node xml dom — The Document Object Model API,xml dom minidom — Minimal DOM implementation,xml etree ElementTree — A API XML ElementTree,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml dom doc}@anchor{39ef}@anchor{library/xml dom module-xml dom}@anchor{121}@anchor{library/xml dom translation-repo}@anchor{39f0}@anchor{library/xml dom xml-dom-the-document-object-model-api}@anchor{39f1}
@subsection @code{xml.dom} — The Document Object Model API


@geindex module; xml.dom

`Código-fonte:' Lib/xml/dom/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/dom/__init__.py}


__________________________________________________________________


The Document Object Model, or “DOM,” is a cross-language API from the World Wide
Web Consortium (W3C) for accessing and modifying XML documents.  A DOM
implementation presents an XML document as a tree structure, or allows client
code to build such a structure from scratch.  It then gives access to the
structure through a set of objects which provided well-known interfaces.

The DOM is extremely useful for random-access applications.  SAX only allows you
a view of one bit of the document at a time.  If you are looking at one SAX
element, you have no access to another.  If you are looking at a text node, you
have no access to a containing element. When you write a SAX application, you
need to keep track of your program’s position in the document somewhere in your
own code.  SAX does not do it for you.  Also, if you need to look ahead in the
XML document, you are just out of luck.

Some applications are simply impossible in an event driven model with no access
to a tree.  Of course you could build some sort of tree yourself in SAX events,
but the DOM allows you to avoid writing that code.  The DOM is a standard tree
representation for XML data.

The Document Object Model is being defined by the W3C in stages, or “levels” in
their terminology.  The Python mapping of the API is substantially based on the
DOM Level 2 recommendation.

@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

DOM applications typically start by parsing some XML into a DOM.  How this is
accomplished is not covered at all by DOM Level 1, and Level 2 provides only
limited improvements: There is a @code{DOMImplementation} object class which
provides access to @code{Document} creation methods, but no way to access an
XML reader/parser/Document builder in an implementation-independent way. There
is also no well-defined way to access these methods without an existing
@code{Document} object.  In Python, each DOM implementation will provide a
function @ref{39f2,,getDOMImplementation()}. DOM Level 3 adds a Load/Store
specification, which defines an interface to the reader, but this is not yet
available in the Python standard library.

Once you have a DOM document object, you can access the parts of your XML
document through its properties and methods.  These properties are defined in
the DOM specification; this portion of the reference manual describes the
interpretation of the specification in Python.

The specification provided by the W3C defines the DOM API for Java, ECMAScript,
and OMG IDL.  The Python mapping defined here is based in large part on the IDL
version of the specification, but strict compliance is not required (though
implementations are free to support the strict mapping from IDL).  See section
@ref{39f3,,Conformance} for a detailed discussion of mapping requirements.


@subsubheading Ver também



@table @asis

@item Document Object Model (DOM) Level 2 Specification@footnote{https://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/}

The W3C recommendation upon which the Python DOM API is based.

@item Document Object Model (DOM) Level 1 Specification@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

The W3C recommendation for the DOM supported by @ref{122,,xml.dom.minidom}.

@item Python Language Mapping Specification@footnote{https://www.omg.org/spec/PYTH/1.2/PDF}

This specifies the mapping from OMG IDL to Python.
@end table


@menu
* Conteúdo do módulo: Conteúdo do módulo<6>. 
* Objects in the DOM:: 
* Conformance:: 

@end menu

@node Conteúdo do módulo<6>,Objects in the DOM,,xml dom — The Document Object Model API
@anchor{library/xml dom module-contents}@anchor{39f4}
@subsubsection Conteúdo do módulo


The @ref{121,,xml.dom} contains the following functions:

@geindex registerDOMImplementation() (no módulo xml.dom)
@anchor{library/xml dom xml dom registerDOMImplementation}@anchor{39f5}
@deffn {Função} xml.dom.registerDOMImplementation (name, factory)

Register the `factory' function with the name `name'.  The factory function
should return an object which implements the @code{DOMImplementation}
interface.  The factory function can return the same object every time, or a new
one for each call, as appropriate for the specific implementation (e.g. if that
implementation supports some customization).
@end deffn

@geindex getDOMImplementation() (no módulo xml.dom)
@anchor{library/xml dom xml dom getDOMImplementation}@anchor{39f2}
@deffn {Função} xml.dom.getDOMImplementation (name=None, features=())

Return a suitable DOM implementation. The `name' is either well-known, the
module name of a DOM implementation, or @code{None}. If it is not @code{None}, imports
the corresponding module and returns a @code{DOMImplementation} object if the
import succeeds.  If no name is given, and if the environment variable
@geindex PYTHON_DOM
@geindex variável de ambiente; PYTHON_DOM
@code{PYTHON_DOM} is set, this variable is used to find the implementation.

If name is not given, this examines the available implementations to find one
with the required feature set.  If no implementation can be found, raise an
@ref{419,,ImportError}.  The features list must be a sequence of @code{(feature,
version)} pairs which are passed to the @code{hasFeature()} method on available
@code{DOMImplementation} objects.
@end deffn

Some convenience constants are also provided:

@geindex EMPTY_NAMESPACE (no módulo xml.dom)
@anchor{library/xml dom xml dom EMPTY_NAMESPACE}@anchor{39f6}
@deffn {Dado} xml.dom.EMPTY_NAMESPACE

The value used to indicate that no namespace is associated with a node in the
DOM.  This is typically found as the @code{namespaceURI} of a node, or used as
the `namespaceURI' parameter to a namespaces-specific method.
@end deffn

@geindex XML_NAMESPACE (no módulo xml.dom)
@anchor{library/xml dom xml dom XML_NAMESPACE}@anchor{39f7}
@deffn {Dado} xml.dom.XML_NAMESPACE

The namespace URI associated with the reserved prefix @code{xml}, as defined by
Namespaces in XML@footnote{https://www.w3.org/TR/REC-xml-names/} (section 4).
@end deffn

@geindex XMLNS_NAMESPACE (no módulo xml.dom)
@anchor{library/xml dom xml dom XMLNS_NAMESPACE}@anchor{39f8}
@deffn {Dado} xml.dom.XMLNS_NAMESPACE

The namespace URI for namespace declarations, as defined by Document Object Model (DOM) Level 2 Core Specification@footnote{https://www.w3.org/TR/DOM-Level-2-Core/core.html} (section 1.1.8).
@end deffn

@geindex XHTML_NAMESPACE (no módulo xml.dom)
@anchor{library/xml dom xml dom XHTML_NAMESPACE}@anchor{39f9}
@deffn {Dado} xml.dom.XHTML_NAMESPACE

The URI of the XHTML namespace as defined by XHTML 1.0: The Extensible HyperText Markup Language@footnote{https://www.w3.org/TR/xhtml1/} (section 3.1.1).
@end deffn

In addition, @ref{121,,xml.dom} contains a base @code{Node} class and the DOM
exception classes.  The @code{Node} class provided by this module does not
implement any of the methods or attributes defined by the DOM specification;
concrete DOM implementations must provide those.  The @code{Node} class
provided as part of this module does provide the constants used for the
@code{nodeType} attribute on concrete @code{Node} objects; they are located
within the class rather than at the module level to conform with the DOM
specifications.

@c Should the Node documentation go here?

@node Objects in the DOM,Conformance,Conteúdo do módulo<6>,xml dom — The Document Object Model API
@anchor{library/xml dom dom-objects}@anchor{39fa}@anchor{library/xml dom objects-in-the-dom}@anchor{39fb}
@subsubsection Objects in the DOM


The definitive documentation for the DOM is the DOM specification from the W3C.

Note that DOM attributes may also be manipulated as nodes instead of as simple
strings.  It is fairly rare that you must do this, however, so this usage is not
yet documented.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Interface

@tab

Seção

@tab

Propósito

@item

@code{DOMImplementation}

@tab

@ref{39fc,,DOMImplementation Objects}

@tab

Interface to the underlying
implementation.

@item

@code{Node}

@tab

@ref{39fd,,Objetos Node}

@tab

Base interface for most objects
in a document.

@item

@code{NodeList}

@tab

@ref{39fe,,Objetos NodeList}

@tab

Interface for a sequence of
nodes.

@item

@code{DocumentType}

@tab

@ref{39ff,,DocumentType Objects}

@tab

Information about the
declarations needed to process
a document.

@item

@code{Document}

@tab

@ref{3a00,,Document Objects}

@tab

Object which represents an
entire document.

@item

@code{Element}

@tab

@ref{3a01,,Element Objects}

@tab

Element nodes in the document
hierarchy.

@item

@code{Attr}

@tab

@ref{3a02,,Attr Objects}

@tab

Attribute value nodes on
element nodes.

@item

@code{Comment}

@tab

@ref{3a03,,Comment Objects}

@tab

Representation of comments in
the source document.

@item

@code{Text}

@tab

@ref{3a04,,Text and CDATASection Objects}

@tab

Nodes containing textual
content from the document.

@item

@code{ProcessingInstruction}

@tab

@ref{3a05,,Objetos ProcessingInstruction}

@tab

Processing instruction
representation.

@end multitable


An additional section describes the exceptions defined for working with the DOM
in Python.

@menu
* DOMImplementation Objects:: 
* Objetos Node:: 
* Objetos NodeList:: 
* DocumentType Objects:: 
* Document Objects:: 
* Element Objects: Element Objects<2>. 
* Attr Objects:: 
* NamedNodeMap Objects:: 
* Comment Objects:: 
* Text and CDATASection Objects:: 
* Objetos ProcessingInstruction:: 
* Exceções: Exceções<20>. 

@end menu

@node DOMImplementation Objects,Objetos Node,,Objects in the DOM
@anchor{library/xml dom dom-implementation-objects}@anchor{39fc}@anchor{library/xml dom domimplementation-objects}@anchor{3a06}
@subsubsection DOMImplementation Objects


The @code{DOMImplementation} interface provides a way for applications to
determine the availability of particular features in the DOM they are using.
DOM Level 2 added the ability to create new @code{Document} and
@code{DocumentType} objects using the @code{DOMImplementation} as well.

@geindex hasFeature() (método xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation hasFeature}@anchor{3a07}
@deffn {Método} DOMImplementation.hasFeature (feature, version)

Return @code{True} if the feature identified by the pair of strings `feature' and
`version' is implemented.
@end deffn

@geindex createDocument() (método xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation createDocument}@anchor{3a08}
@deffn {Método} DOMImplementation.createDocument (namespaceUri, qualifiedName, doctype)

Return a new @code{Document} object (the root of the DOM), with a child
@code{Element} object having the given `namespaceUri' and `qualifiedName'. The
`doctype' must be a @code{DocumentType} object created by
@ref{3a09,,createDocumentType()}, or @code{None}. In the Python DOM API, the first two
arguments can also be @code{None} in order to indicate that no @code{Element}
child is to be created.
@end deffn

@geindex createDocumentType() (método xml.dom.DOMImplementation)
@anchor{library/xml dom xml dom DOMImplementation createDocumentType}@anchor{3a09}
@deffn {Método} DOMImplementation.createDocumentType (qualifiedName, publicId, systemId)

Return a new @code{DocumentType} object that encapsulates the given
`qualifiedName', `publicId', and `systemId' strings, representing the
information contained in an XML document type declaration.
@end deffn

@node Objetos Node,Objetos NodeList,DOMImplementation Objects,Objects in the DOM
@anchor{library/xml dom dom-node-objects}@anchor{39fd}@anchor{library/xml dom node-objects}@anchor{3a0a}
@subsubsection Objetos Node


All of the components of an XML document are subclasses of @code{Node}.

@geindex nodeType (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeType}@anchor{3a0b}
@deffn {Atributo} Node.nodeType

An integer representing the node type.  Symbolic constants for the types are on
the @code{Node} object: @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}.
This is a read-only attribute.
@end deffn

@geindex parentNode (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node parentNode}@anchor{3a0c}
@deffn {Atributo} Node.parentNode

The parent of the current node, or @code{None} for the document node. The value is
always a @code{Node} object or @code{None}.  For @code{Element} nodes, this
will be the parent element, except for the root element, in which case it will
be the @code{Document} object. For @code{Attr} nodes, this is always
@code{None}. This is a read-only attribute.
@end deffn

@geindex attributes (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node attributes}@anchor{3a0d}
@deffn {Atributo} Node.attributes

A @code{NamedNodeMap} of attribute objects.  Only elements have actual values
for this; others provide @code{None} for this attribute. This is a read-only
attribute.
@end deffn

@geindex previousSibling (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node previousSibling}@anchor{3a0e}
@deffn {Atributo} Node.previousSibling

The node that immediately precedes this one with the same parent.  For
instance the element with an end-tag that comes just before the `self'
element’s start-tag.  Of course, XML documents are made up of more than just
elements so the previous sibling could be text, a comment, or something else.
If this node is the first child of the parent, this attribute will be
@code{None}. This is a read-only attribute.
@end deffn

@geindex nextSibling (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node nextSibling}@anchor{3a0f}
@deffn {Atributo} Node.nextSibling

The node that immediately follows this one with the same parent.  See also
@ref{3a0e,,previousSibling}.  If this is the last child of the parent, this
attribute will be @code{None}. This is a read-only attribute.
@end deffn

@geindex childNodes (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node childNodes}@anchor{3a10}
@deffn {Atributo} Node.childNodes

A list of nodes contained within this node. This is a read-only attribute.
@end deffn

@geindex firstChild (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node firstChild}@anchor{3a11}
@deffn {Atributo} Node.firstChild

The first child of the node, if there are any, or @code{None}. This is a read-only
attribute.
@end deffn

@geindex lastChild (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node lastChild}@anchor{3a12}
@deffn {Atributo} Node.lastChild

The last child of the node, if there are any, or @code{None}. This is a read-only
attribute.
@end deffn

@geindex localName (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node localName}@anchor{3a13}
@deffn {Atributo} Node.localName

The part of the @code{tagName} following the colon if there is one, else the
entire @code{tagName}.  The value is a string.
@end deffn

@geindex prefix (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node prefix}@anchor{3a14}
@deffn {Atributo} Node.prefix

The part of the @code{tagName} preceding the colon if there is one, else the
empty string.  The value is a string, or @code{None}.
@end deffn

@geindex namespaceURI (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node namespaceURI}@anchor{3a15}
@deffn {Atributo} Node.namespaceURI

The namespace associated with the element name.  This will be a string or
@code{None}.  This is a read-only attribute.
@end deffn

@geindex nodeName (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeName}@anchor{3a16}
@deffn {Atributo} Node.nodeName

This has a different meaning for each node type; see the DOM specification for
details.  You can always get the information you would get here from another
property such as the @code{tagName} property for elements or the @code{name}
property for attributes. For all node types, the value of this attribute will be
either a string or @code{None}.  This is a read-only attribute.
@end deffn

@geindex nodeValue (atributo xml.dom.Node)
@anchor{library/xml dom xml dom Node nodeValue}@anchor{3a17}
@deffn {Atributo} Node.nodeValue

This has a different meaning for each node type; see the DOM specification for
details.  The situation is similar to that with @ref{3a16,,nodeName}.  The value is
a string or @code{None}.
@end deffn

@geindex hasAttributes() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node hasAttributes}@anchor{3a18}
@deffn {Método} Node.hasAttributes ()

Return @code{True} if the node has any attributes.
@end deffn

@geindex hasChildNodes() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node hasChildNodes}@anchor{3a19}
@deffn {Método} Node.hasChildNodes ()

Return @code{True} if the node has any child nodes.
@end deffn

@geindex isSameNode() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node isSameNode}@anchor{3a1a}
@deffn {Método} Node.isSameNode (other)

Return @code{True} if `other' refers to the same node as this node. This is especially
useful for DOM implementations which use any sort of proxy architecture (because
more than one object can refer to the same node).

@cartouche
@quotation Nota 
This is based on a proposed DOM Level 3 API which is still in the “working
draft” stage, but this particular interface appears uncontroversial.  Changes
from the W3C will not necessarily affect this method in the Python DOM interface
(though any new W3C API for this would also be supported).
@end quotation
@end cartouche
@end deffn

@geindex appendChild() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node appendChild}@anchor{3a1b}
@deffn {Método} Node.appendChild (newChild)

Add a new child node to this node at the end of the list of
children, returning `newChild'. If the node was already in
the tree, it is removed first.
@end deffn

@geindex insertBefore() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node insertBefore}@anchor{3a1c}
@deffn {Método} Node.insertBefore (newChild, refChild)

Insert a new child node before an existing child.  It must be the case that
`refChild' is a child of this node; if not, @ref{202,,ValueError} is raised.
`newChild' is returned. If `refChild' is @code{None}, it inserts `newChild' at the
end of the children’s list.
@end deffn

@geindex removeChild() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node removeChild}@anchor{3a1d}
@deffn {Método} Node.removeChild (oldChild)

Remove a child node.  `oldChild' must be a child of this node; if not,
@ref{202,,ValueError} is raised.  `oldChild' is returned on success.  If `oldChild'
will not be used further, its @code{unlink()} method should be called.
@end deffn

@geindex replaceChild() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node replaceChild}@anchor{3a1e}
@deffn {Método} Node.replaceChild (newChild, oldChild)

Replace an existing node with a new node. It must be the case that  `oldChild'
is a child of this node; if not, @ref{202,,ValueError} is raised.
@end deffn

@geindex normalize() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node normalize}@anchor{3a1f}
@deffn {Método} Node.normalize ()

Join adjacent text nodes so that all stretches of text are stored as single
@code{Text} instances.  This simplifies processing text from a DOM tree for
many applications.
@end deffn

@geindex cloneNode() (método xml.dom.Node)
@anchor{library/xml dom xml dom Node cloneNode}@anchor{3a20}
@deffn {Método} Node.cloneNode (deep)

Clone this node.  Setting `deep' means to clone all child nodes as well.  This
returns the clone.
@end deffn

@node Objetos NodeList,DocumentType Objects,Objetos Node,Objects in the DOM
@anchor{library/xml dom dom-nodelist-objects}@anchor{39fe}@anchor{library/xml dom nodelist-objects}@anchor{3a21}
@subsubsection Objetos NodeList


A @code{NodeList} represents a sequence of nodes.  These objects are used in
two ways in the DOM Core recommendation:  an @code{Element} object provides
one as its list of child nodes, and the @code{getElementsByTagName()} and
@code{getElementsByTagNameNS()} methods of @code{Node} return objects with this
interface to represent query results.

The DOM Level 2 recommendation defines one method and one attribute for these
objects:

@geindex item() (método xml.dom.NodeList)
@anchor{library/xml dom xml dom NodeList item}@anchor{3a22}
@deffn {Método} NodeList.item (i)

Return the `i'’th item from the sequence, if there is one, or @code{None}.  The
index `i' is not allowed to be less than zero or greater than or equal to the
length of the sequence.
@end deffn

@geindex length (atributo xml.dom.NodeList)
@anchor{library/xml dom xml dom NodeList length}@anchor{3a23}
@deffn {Atributo} NodeList.length

The number of nodes in the sequence.
@end deffn

In addition, the Python DOM interface requires that some additional support is
provided to allow @code{NodeList} objects to be used as Python sequences.  All
@code{NodeList} implementations must include support for
@ref{15b4,,__len__()} and
@ref{283,,__getitem__()}; this allows iteration over the @code{NodeList} in
@ref{2f2,,for} statements and proper support for the @ref{62e,,len()} built-in
function.

If a DOM implementation supports modification of the document, the
@code{NodeList} implementation must also support the
@ref{130e,,__setitem__()} and @ref{130f,,__delitem__()} methods.

@node DocumentType Objects,Document Objects,Objetos NodeList,Objects in the DOM
@anchor{library/xml dom documenttype-objects}@anchor{3a24}@anchor{library/xml dom dom-documenttype-objects}@anchor{39ff}
@subsubsection DocumentType Objects


Information about the notations and entities declared by a document (including
the external subset if the parser uses it and can provide the information) is
available from a @code{DocumentType} object.  The @code{DocumentType} for a
document is available from the @code{Document} object’s @code{doctype}
attribute; if there is no @code{DOCTYPE} declaration for the document, the
document’s @code{doctype} attribute will be set to @code{None} instead of an
instance of this interface.

@code{DocumentType} is a specialization of @code{Node}, and adds the
following attributes:

@geindex publicId (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType publicId}@anchor{3a25}
@deffn {Atributo} DocumentType.publicId

The public identifier for the external subset of the document type definition.
This will be a string or @code{None}.
@end deffn

@geindex systemId (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType systemId}@anchor{3a26}
@deffn {Atributo} DocumentType.systemId

The system identifier for the external subset of the document type definition.
This will be a URI as a string, or @code{None}.
@end deffn

@geindex internalSubset (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType internalSubset}@anchor{3a27}
@deffn {Atributo} DocumentType.internalSubset

A string giving the complete internal subset from the document. This does not
include the brackets which enclose the subset.  If the document has no internal
subset, this should be @code{None}.
@end deffn

@geindex name (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType name}@anchor{3a28}
@deffn {Atributo} DocumentType.name

The name of the root element as given in the @code{DOCTYPE} declaration, if
present.
@end deffn

@geindex entities (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType entities}@anchor{3a29}
@deffn {Atributo} DocumentType.entities

This is a @code{NamedNodeMap} giving the definitions of external entities.
For entity names defined more than once, only the first definition is provided
(others are ignored as required by the XML recommendation).  This may be
@code{None} if the information is not provided by the parser, or if no entities are
defined.
@end deffn

@geindex notations (atributo xml.dom.DocumentType)
@anchor{library/xml dom xml dom DocumentType notations}@anchor{3a2a}
@deffn {Atributo} DocumentType.notations

This is a @code{NamedNodeMap} giving the definitions of notations. For
notation names defined more than once, only the first definition is provided
(others are ignored as required by the XML recommendation).  This may be
@code{None} if the information is not provided by the parser, or if no notations
are defined.
@end deffn

@node Document Objects,Element Objects<2>,DocumentType Objects,Objects in the DOM
@anchor{library/xml dom document-objects}@anchor{3a2b}@anchor{library/xml dom dom-document-objects}@anchor{3a00}
@subsubsection Document Objects


A @code{Document} represents an entire XML document, including its constituent
elements, attributes, processing instructions, comments etc.  Remember that it
inherits properties from @code{Node}.

@geindex documentElement (atributo xml.dom.Document)
@anchor{library/xml dom xml dom Document documentElement}@anchor{15a7}
@deffn {Atributo} Document.documentElement

The one and only root element of the document.
@end deffn

@geindex createElement() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createElement}@anchor{3a2c}
@deffn {Método} Document.createElement (tagName)

Create and return a new element node.  The element is not inserted into the
document when it is created.  You need to explicitly insert it with one of the
other methods such as @code{insertBefore()} or @code{appendChild()}.
@end deffn

@geindex createElementNS() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createElementNS}@anchor{3a2d}
@deffn {Método} Document.createElementNS (namespaceURI, tagName)

Create and return a new element with a namespace.  The `tagName' may have a
prefix.  The element is not inserted into the document when it is created.  You
need to explicitly insert it with one of the other methods such as
@code{insertBefore()} or @code{appendChild()}.
@end deffn

@geindex createTextNode() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createTextNode}@anchor{3a2e}
@deffn {Método} Document.createTextNode (data)

Create and return a text node containing the data passed as a parameter.  As
with the other creation methods, this one does not insert the node into the
tree.
@end deffn

@geindex createComment() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createComment}@anchor{3a2f}
@deffn {Método} Document.createComment (data)

Create and return a comment node containing the data passed as a parameter.  As
with the other creation methods, this one does not insert the node into the
tree.
@end deffn

@geindex createProcessingInstruction() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createProcessingInstruction}@anchor{3a30}
@deffn {Método} Document.createProcessingInstruction (target, data)

Create and return a processing instruction node containing the `target' and
`data' passed as parameters.  As with the other creation methods, this one does
not insert the node into the tree.
@end deffn

@geindex createAttribute() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createAttribute}@anchor{3a31}
@deffn {Método} Document.createAttribute (name)

Create and return an attribute node.  This method does not associate the
attribute node with any particular element.  You must use
@code{setAttributeNode()} on the appropriate @code{Element} object to use the
newly created attribute instance.
@end deffn

@geindex createAttributeNS() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document createAttributeNS}@anchor{3a32}
@deffn {Método} Document.createAttributeNS (namespaceURI, qualifiedName)

Create and return an attribute node with a namespace.  The `tagName' may have a
prefix.  This method does not associate the attribute node with any particular
element.  You must use @code{setAttributeNode()} on the appropriate
@code{Element} object to use the newly created attribute instance.
@end deffn

@geindex getElementsByTagName() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document getElementsByTagName}@anchor{3a33}
@deffn {Método} Document.getElementsByTagName (tagName)

Search for all descendants (direct children, children’s children, etc.) with a
particular element type name.
@end deffn

@geindex getElementsByTagNameNS() (método xml.dom.Document)
@anchor{library/xml dom xml dom Document getElementsByTagNameNS}@anchor{3a34}
@deffn {Método} Document.getElementsByTagNameNS (namespaceURI, localName)

Search for all descendants (direct children, children’s children, etc.) with a
particular namespace URI and localname.  The localname is the part of the
namespace after the prefix.
@end deffn

@node Element Objects<2>,Attr Objects,Document Objects,Objects in the DOM
@anchor{library/xml dom dom-element-objects}@anchor{3a01}@anchor{library/xml dom element-objects}@anchor{3a35}
@subsubsection Element Objects


@code{Element} is a subclass of @code{Node}, so inherits all the attributes
of that class.

@geindex tagName (atributo xml.dom.Element)
@anchor{library/xml dom xml dom Element tagName}@anchor{3a36}
@deffn {Atributo} Element.tagName

The element type name.  In a namespace-using document it may have colons in it.
The value is a string.
@end deffn

@geindex getElementsByTagName() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getElementsByTagName}@anchor{3a37}
@deffn {Método} Element.getElementsByTagName (tagName)

Same as equivalent method in the @code{Document} class.
@end deffn

@geindex getElementsByTagNameNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getElementsByTagNameNS}@anchor{3a38}
@deffn {Método} Element.getElementsByTagNameNS (namespaceURI, localName)

Same as equivalent method in the @code{Document} class.
@end deffn

@geindex hasAttribute() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element hasAttribute}@anchor{3a39}
@deffn {Método} Element.hasAttribute (name)

Return @code{True} if the element has an attribute named by `name'.
@end deffn

@geindex hasAttributeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element hasAttributeNS}@anchor{3a3a}
@deffn {Método} Element.hasAttributeNS (namespaceURI, localName)

Return @code{True} if the element has an attribute named by `namespaceURI' and
`localName'.
@end deffn

@geindex getAttribute() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttribute}@anchor{3a3b}
@deffn {Método} Element.getAttribute (name)

Return the value of the attribute named by `name' as a string. If no such
attribute exists, an empty string is returned, as if the attribute had no value.
@end deffn

@geindex getAttributeNode() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNode}@anchor{3a3c}
@deffn {Método} Element.getAttributeNode (attrname)

Return the @code{Attr} node for the attribute named by `attrname'.
@end deffn

@geindex getAttributeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNS}@anchor{3a3d}
@deffn {Método} Element.getAttributeNS (namespaceURI, localName)

Return the value of the attribute named by `namespaceURI' and `localName' as a
string. If no such attribute exists, an empty string is returned, as if the
attribute had no value.
@end deffn

@geindex getAttributeNodeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element getAttributeNodeNS}@anchor{3a3e}
@deffn {Método} Element.getAttributeNodeNS (namespaceURI, localName)

Return an attribute value as a node, given a `namespaceURI' and `localName'.
@end deffn

@geindex removeAttribute() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttribute}@anchor{3a3f}
@deffn {Método} Element.removeAttribute (name)

Remove an attribute by name.  If there is no matching attribute, a
@ref{3a40,,NotFoundErr} is raised.
@end deffn

@geindex removeAttributeNode() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttributeNode}@anchor{3a41}
@deffn {Método} Element.removeAttributeNode (oldAttr)

Remove and return `oldAttr' from the attribute list, if present. If `oldAttr' is
not present, @ref{3a40,,NotFoundErr} is raised.
@end deffn

@geindex removeAttributeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element removeAttributeNS}@anchor{3a42}
@deffn {Método} Element.removeAttributeNS (namespaceURI, localName)

Remove an attribute by name.  Note that it uses a localName, not a qname.  No
exception is raised if there is no matching attribute.
@end deffn

@geindex setAttribute() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttribute}@anchor{3a43}
@deffn {Método} Element.setAttribute (name, value)

Set an attribute value from a string.
@end deffn

@geindex setAttributeNode() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNode}@anchor{3a44}
@deffn {Método} Element.setAttributeNode (newAttr)

Add a new attribute node to the element, replacing an existing attribute if
necessary if the @code{name} attribute matches.  If a replacement occurs, the
old attribute node will be returned.  If `newAttr' is already in use,
@ref{3a45,,InuseAttributeErr} will be raised.
@end deffn

@geindex setAttributeNodeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNodeNS}@anchor{3a46}
@deffn {Método} Element.setAttributeNodeNS (newAttr)

Add a new attribute node to the element, replacing an existing attribute if
necessary if the @code{namespaceURI} and @code{localName} attributes match.
If a replacement occurs, the old attribute node will be returned.  If `newAttr'
is already in use, @ref{3a45,,InuseAttributeErr} will be raised.
@end deffn

@geindex setAttributeNS() (método xml.dom.Element)
@anchor{library/xml dom xml dom Element setAttributeNS}@anchor{3a47}
@deffn {Método} Element.setAttributeNS (namespaceURI, qname, value)

Set an attribute value from a string, given a `namespaceURI' and a `qname'.
Note that a qname is the whole attribute name.  This is different than above.
@end deffn

@node Attr Objects,NamedNodeMap Objects,Element Objects<2>,Objects in the DOM
@anchor{library/xml dom attr-objects}@anchor{3a48}@anchor{library/xml dom dom-attr-objects}@anchor{3a02}
@subsubsection Attr Objects


@code{Attr} inherits from @code{Node}, so inherits all its attributes.

@geindex name (atributo xml.dom.Attr)
@anchor{library/xml dom xml dom Attr name}@anchor{3a49}
@deffn {Atributo} Attr.name

The attribute name.
In a namespace-using document it may include a colon.
@end deffn

@geindex localName (atributo xml.dom.Attr)
@anchor{library/xml dom xml dom Attr localName}@anchor{3a4a}
@deffn {Atributo} Attr.localName

The part of the name following the colon if there is one, else the
entire name.
This is a read-only attribute.
@end deffn

@geindex prefix (atributo xml.dom.Attr)
@anchor{library/xml dom xml dom Attr prefix}@anchor{3a4b}
@deffn {Atributo} Attr.prefix

The part of the name preceding the colon if there is one, else the
empty string.
@end deffn

@geindex value (atributo xml.dom.Attr)
@anchor{library/xml dom xml dom Attr value}@anchor{3a4c}
@deffn {Atributo} Attr.value

The text value of the attribute.  This is a synonym for the
@code{nodeValue} attribute.
@end deffn

@node NamedNodeMap Objects,Comment Objects,Attr Objects,Objects in the DOM
@anchor{library/xml dom dom-attributelist-objects}@anchor{3a4d}@anchor{library/xml dom namednodemap-objects}@anchor{3a4e}
@subsubsection NamedNodeMap Objects


@code{NamedNodeMap} does `not' inherit from @code{Node}.

@geindex length (atributo xml.dom.NamedNodeMap)
@anchor{library/xml dom xml dom NamedNodeMap length}@anchor{3a4f}
@deffn {Atributo} NamedNodeMap.length

The length of the attribute list.
@end deffn

@geindex item() (método xml.dom.NamedNodeMap)
@anchor{library/xml dom xml dom NamedNodeMap item}@anchor{3a50}
@deffn {Método} NamedNodeMap.item (index)

Return an attribute with a particular index.  The order you get the attributes
in is arbitrary but will be consistent for the life of a DOM.  Each item is an
attribute node.  Get its value with the @code{value} attribute.
@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 Comment Objects,Text and CDATASection Objects,NamedNodeMap Objects,Objects in the DOM
@anchor{library/xml dom comment-objects}@anchor{3a51}@anchor{library/xml dom dom-comment-objects}@anchor{3a03}
@subsubsection Comment Objects


@code{Comment} represents a comment in the XML document.  It is a subclass of
@code{Node}, but cannot have child nodes.

@geindex data (atributo xml.dom.Comment)
@anchor{library/xml dom xml dom Comment data}@anchor{3a52}
@deffn {Atributo} Comment.data

The content of the comment as a string.  The attribute contains all characters
between the leading @code{<!-}@code{-} and trailing @code{-}@code{->}, but does not
include them.
@end deffn

@node Text and CDATASection Objects,Objetos ProcessingInstruction,Comment Objects,Objects in the DOM
@anchor{library/xml dom dom-text-objects}@anchor{3a04}@anchor{library/xml dom text-and-cdatasection-objects}@anchor{3a53}
@subsubsection Text and CDATASection Objects


The @code{Text} interface represents text in the XML document.  If the parser
and DOM implementation support the DOM’s XML extension, portions of the text
enclosed in CDATA marked sections are stored in @code{CDATASection} objects.
These two interfaces are identical, but provide different values for the
@code{nodeType} attribute.

These interfaces extend the @code{Node} interface.  They cannot have child
nodes.

@geindex data (atributo xml.dom.Text)
@anchor{library/xml dom xml dom Text data}@anchor{3a54}
@deffn {Atributo} Text.data

The content of the text node as a string.
@end deffn

@cartouche
@quotation Nota 
The use of a @code{CDATASection} node does not indicate that the node
represents a complete CDATA marked section, only that the content of the node
was part of a CDATA section.  A single CDATA section may be represented by more
than one node in the document tree.  There is no way to determine whether two
adjacent @code{CDATASection} nodes represent different CDATA marked sections.
@end quotation
@end cartouche

@node Objetos ProcessingInstruction,Exceções<20>,Text and CDATASection Objects,Objects in the DOM
@anchor{library/xml dom dom-pi-objects}@anchor{3a05}@anchor{library/xml dom processinginstruction-objects}@anchor{3a55}
@subsubsection Objetos ProcessingInstruction


Represents a processing instruction in the XML document; this inherits from the
@code{Node} interface and cannot have child nodes.

@geindex target (atributo xml.dom.ProcessingInstruction)
@anchor{library/xml dom xml dom ProcessingInstruction target}@anchor{3a56}
@deffn {Atributo} ProcessingInstruction.target

The content of the processing instruction up to the first whitespace character.
This is a read-only attribute.
@end deffn

@geindex data (atributo xml.dom.ProcessingInstruction)
@anchor{library/xml dom xml dom ProcessingInstruction data}@anchor{3a57}
@deffn {Atributo} ProcessingInstruction.data

The content of the processing instruction following the first whitespace
character.
@end deffn

@node Exceções<20>,,Objetos ProcessingInstruction,Objects in the DOM
@anchor{library/xml dom dom-exceptions}@anchor{3a58}@anchor{library/xml dom exceptions}@anchor{3a59}
@subsubsection Exceções


The DOM Level 2 recommendation defines a single exception, @ref{3a5a,,DOMException},
and a number of constants that allow applications to determine what sort of
error occurred. @ref{3a5a,,DOMException} instances carry a @ref{1a,,code} attribute
that provides the appropriate value for the specific exception.

The Python DOM interface provides the constants, but also expands the set of
exceptions so that a specific exception exists for each of the exception codes
defined by the DOM.  The implementations must raise the appropriate specific
exception, each of which carries the appropriate value for the @ref{1a,,code}
attribute.

@geindex DOMException
@anchor{library/xml dom xml dom DOMException}@anchor{3a5a}
@deffn {Exceção} xml.dom.DOMException

Base exception class used for all specific DOM exceptions.  This exception class
cannot be directly instantiated.
@end deffn

@geindex DomstringSizeErr
@anchor{library/xml dom xml dom DomstringSizeErr}@anchor{3a5b}
@deffn {Exceção} xml.dom.DomstringSizeErr

Raised when a specified range of text does not fit into a string. This is not
known to be used in the Python DOM implementations, but may be received from DOM
implementations not written in Python.
@end deffn

@geindex HierarchyRequestErr
@anchor{library/xml dom xml dom HierarchyRequestErr}@anchor{3a5c}
@deffn {Exceção} xml.dom.HierarchyRequestErr

Raised when an attempt is made to insert a node where the node type is not
allowed.
@end deffn

@geindex IndexSizeErr
@anchor{library/xml dom xml dom IndexSizeErr}@anchor{3a5d}
@deffn {Exceção} xml.dom.IndexSizeErr

Raised when an index or size parameter to a method is negative or exceeds the
allowed values.
@end deffn

@geindex InuseAttributeErr
@anchor{library/xml dom xml dom InuseAttributeErr}@anchor{3a45}
@deffn {Exceção} xml.dom.InuseAttributeErr

Raised when an attempt is made to insert an @code{Attr} node that is already
present elsewhere in the document.
@end deffn

@geindex InvalidAccessErr
@anchor{library/xml dom xml dom InvalidAccessErr}@anchor{3a5e}
@deffn {Exceção} xml.dom.InvalidAccessErr

Raised if a parameter or an operation is not supported on the underlying object.
@end deffn

@geindex InvalidCharacterErr
@anchor{library/xml dom xml dom InvalidCharacterErr}@anchor{3a5f}
@deffn {Exceção} xml.dom.InvalidCharacterErr

This exception is raised when a string parameter contains a character that is
not permitted in the context it’s being used in by the XML 1.0 recommendation.
For example, attempting to create an @code{Element} node with a space in the
element type name will cause this error to be raised.
@end deffn

@geindex InvalidModificationErr
@anchor{library/xml dom xml dom InvalidModificationErr}@anchor{3a60}
@deffn {Exceção} xml.dom.InvalidModificationErr

Raised when an attempt is made to modify the type of a node.
@end deffn

@geindex InvalidStateErr
@anchor{library/xml dom xml dom InvalidStateErr}@anchor{3a61}
@deffn {Exceção} xml.dom.InvalidStateErr

Raised when an attempt is made to use an object that is not defined or is no
longer usable.
@end deffn

@geindex NamespaceErr
@anchor{library/xml dom xml dom NamespaceErr}@anchor{3a62}
@deffn {Exceção} xml.dom.NamespaceErr

If an attempt is made to change any object in a way that is not permitted with
regard to the Namespaces in XML@footnote{https://www.w3.org/TR/REC-xml-names/}
recommendation, this exception is raised.
@end deffn

@geindex NotFoundErr
@anchor{library/xml dom xml dom NotFoundErr}@anchor{3a40}
@deffn {Exceção} xml.dom.NotFoundErr

Exception when a node does not exist in the referenced context.  For example,
@code{NamedNodeMap.removeNamedItem()} will raise this if the node passed in does
not exist in the map.
@end deffn

@geindex NotSupportedErr
@anchor{library/xml dom xml dom NotSupportedErr}@anchor{3a63}
@deffn {Exceção} xml.dom.NotSupportedErr

Raised when the implementation does not support the requested type of object or
operation.
@end deffn

@geindex NoDataAllowedErr
@anchor{library/xml dom xml dom NoDataAllowedErr}@anchor{3a64}
@deffn {Exceção} xml.dom.NoDataAllowedErr

This is raised if data is specified for a node which does not support data.

@c XXX  a better explanation is needed!
@end deffn

@geindex NoModificationAllowedErr
@anchor{library/xml dom xml dom NoModificationAllowedErr}@anchor{3a65}
@deffn {Exceção} xml.dom.NoModificationAllowedErr

Raised on attempts to modify an object where modifications are not allowed (such
as for read-only nodes).
@end deffn

@geindex SyntaxErr
@anchor{library/xml dom xml dom SyntaxErr}@anchor{3a66}
@deffn {Exceção} xml.dom.SyntaxErr

Raised when an invalid or illegal string is specified.

@c XXX  how is this different from InvalidCharacterErr?
@end deffn

@geindex WrongDocumentErr
@anchor{library/xml dom xml dom WrongDocumentErr}@anchor{3a67}
@deffn {Exceção} xml.dom.WrongDocumentErr

Raised when a node is inserted in a different document than it currently belongs
to, and the implementation does not support migrating the node from one document
to the other.
@end deffn

The exception codes defined in the DOM recommendation map to the exceptions
described above according to this table:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Exception

@item

@code{DOMSTRING_SIZE_ERR}

@tab

@ref{3a5b,,DomstringSizeErr}

@item

@code{HIERARCHY_REQUEST_ERR}

@tab

@ref{3a5c,,HierarchyRequestErr}

@item

@code{INDEX_SIZE_ERR}

@tab

@ref{3a5d,,IndexSizeErr}

@item

@code{INUSE_ATTRIBUTE_ERR}

@tab

@ref{3a45,,InuseAttributeErr}

@item

@code{INVALID_ACCESS_ERR}

@tab

@ref{3a5e,,InvalidAccessErr}

@item

@code{INVALID_CHARACTER_ERR}

@tab

@ref{3a5f,,InvalidCharacterErr}

@item

@code{INVALID_MODIFICATION_ERR}

@tab

@ref{3a60,,InvalidModificationErr}

@item

@code{INVALID_STATE_ERR}

@tab

@ref{3a61,,InvalidStateErr}

@item

@code{NAMESPACE_ERR}

@tab

@ref{3a62,,NamespaceErr}

@item

@code{NOT_FOUND_ERR}

@tab

@ref{3a40,,NotFoundErr}

@item

@code{NOT_SUPPORTED_ERR}

@tab

@ref{3a63,,NotSupportedErr}

@item

@code{NO_DATA_ALLOWED_ERR}

@tab

@ref{3a64,,NoDataAllowedErr}

@item

@code{NO_MODIFICATION_ALLOWED_ERR}

@tab

@ref{3a65,,NoModificationAllowedErr}

@item

@code{SYNTAX_ERR}

@tab

@ref{3a66,,SyntaxErr}

@item

@code{WRONG_DOCUMENT_ERR}

@tab

@ref{3a67,,WrongDocumentErr}

@end multitable


@node Conformance,,Objects in the DOM,xml dom — The Document Object Model API
@anchor{library/xml dom conformance}@anchor{3a68}@anchor{library/xml dom dom-conformance}@anchor{39f3}
@subsubsection Conformance


This section describes the conformance requirements and relationships between
the Python DOM API, the W3C DOM recommendations, and the OMG IDL mapping for
Python.

@menu
* Type Mapping:: 
* Accessor Methods:: 

@end menu

@node Type Mapping,Accessor Methods,,Conformance
@anchor{library/xml dom dom-type-mapping}@anchor{3a69}@anchor{library/xml dom type-mapping}@anchor{3a6a}
@subsubsection Type Mapping


The IDL types used in the DOM specification are mapped to Python types
according to the following table.


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo IDL

@tab

Tipo em Python

@item

@code{boolean}

@tab

@code{bool} or @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} or @code{bytes}

@item

@code{null}

@tab

@code{None}

@end multitable


@node Accessor Methods,,Type Mapping,Conformance
@anchor{library/xml dom accessor-methods}@anchor{3a6b}@anchor{library/xml dom dom-accessor-methods}@anchor{3a6c}
@subsubsection Accessor Methods


The mapping from OMG IDL to Python defines accessor functions for IDL
@code{attribute} declarations in much the way the Java mapping does.
Mapping the IDL declarations

@example
readonly attribute string someValue;
         attribute string anotherValue;
@end example

yields three accessor functions:  a “get” method for @code{someValue}
(@code{_get_someValue()}), and “get” and “set” methods for @code{anotherValue}
(@code{_get_anotherValue()} and @code{_set_anotherValue()}).  The mapping, in
particular, does not require that the IDL attributes are accessible as normal
Python attributes:  @code{object.someValue} is `not' required to work, and may
raise an @ref{34b,,AttributeError}.

The Python DOM API, however, `does' require that normal attribute access work.
This means that the typical surrogates generated by Python IDL compilers are not
likely to work, and wrapper objects may be needed on the client if the DOM
objects are accessed via CORBA. While this does require some additional
consideration for CORBA DOM clients, the implementers with experience using DOM
over CORBA from Python do not consider this a problem.  Attributes that are
declared @code{readonly} may not restrict write access in all DOM
implementations.

In the Python DOM API, accessor functions are not required.  If provided, they
should take the form defined by the Python IDL mapping, but these methods are
considered unnecessary since the attributes are accessible directly from Python.
“Set” accessors should never be provided for @code{readonly} attributes.

The IDL definitions do not fully embody the requirements of the W3C DOM API,
such as the notion of certain objects, such as the return value of
@code{getElementsByTagName()}, being “live”.  The Python DOM API does not require
implementations to enforce such requirements.

@node xml dom minidom — Minimal DOM implementation,xml dom pulldom — Suporte para construir árvores parciais de DOM,xml dom — The Document Object Model API,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml dom minidom doc}@anchor{3a6d}@anchor{library/xml dom minidom module-xml dom minidom}@anchor{122}@anchor{library/xml dom minidom translation-repo}@anchor{3a6e}@anchor{library/xml dom minidom xml-dom-minidom-minimal-dom-implementation}@anchor{3a6f}
@subsection @code{xml.dom.minidom} — Minimal DOM implementation


@geindex module; xml.dom.minidom

`Código-fonte:' Lib/xml/dom/minidom.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/dom/minidom.py}


__________________________________________________________________


@ref{122,,xml.dom.minidom} is a minimal implementation of the Document Object
Model interface, with an API similar to that in other languages.  It is intended
to be simpler than the full DOM and also significantly smaller.  Users who are
not already proficient with the DOM should consider using the
@ref{125,,xml.etree.ElementTree} module for their XML processing instead.

@cartouche
@quotation Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche

DOM applications typically start by parsing some XML into a DOM.  With
@ref{122,,xml.dom.minidom}, this is done through the parse functions:

@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

The @ref{3a70,,parse()} function can take either a filename or an open file object.

@geindex parse() (no módulo xml.dom.minidom)
@anchor{library/xml dom minidom xml dom minidom parse}@anchor{3a70}
@deffn {Função} xml.dom.minidom.parse (filename_or_file, parser=None, bufsize=None)

Return a @code{Document} from the given input. `filename_or_file' may be
either a file name, or a file-like object. `parser', if given, must be a SAX2
parser object. This function will change the document handler of the parser and
activate namespace support; other parser configuration (like setting an entity
resolver) must have been done in advance.
@end deffn

Se você tiver XML em uma string, poderá usar a função @ref{3a71,,parseString()}:

@geindex parseString() (no módulo xml.dom.minidom)
@anchor{library/xml dom minidom xml dom minidom parseString}@anchor{3a71}
@deffn {Função} xml.dom.minidom.parseString (string, parser=None)

Return a @code{Document} that represents the `string'. This method creates an
@ref{f59,,io.StringIO} object for the string and passes that on to @ref{3a70,,parse()}.
@end deffn

Both functions return a @code{Document} object representing the content of the
document.

What the @ref{3a70,,parse()} and @ref{3a71,,parseString()} functions do is connect an XML
parser with a “DOM builder” that can accept parse events from any SAX parser and
convert them into a DOM tree.  The name of the functions are perhaps misleading,
but are easy to grasp when learning the interfaces.  The parsing of the document
will be completed before these functions return; it’s simply that these
functions do not provide a parser implementation themselves.

You can also create a @code{Document} by calling a method on a “DOM
Implementation” object.  You can get this object either by calling the
@code{getDOMImplementation()} function in the @ref{121,,xml.dom} package or the
@ref{122,,xml.dom.minidom} module.  Once you have a @code{Document}, you
can add child nodes to it to populate the 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

Once you have a DOM document object, you can access the parts of your XML
document through its properties and methods.  These properties are defined in
the DOM specification.  The main property of the document object is the
@code{documentElement} property.  It gives you the main element in the XML
document: the one that holds all others.  Here is an example program:

@example
dom3 = parseString("<myxml>Some data</myxml>")
assert dom3.documentElement.tagName == "myxml"
@end example

When you are finished with a DOM tree, you may optionally call the
@code{unlink()} method to encourage early cleanup of the now-unneeded
objects.  @code{unlink()} is an @ref{122,,xml.dom.minidom}-specific
extension to the DOM API that renders the node and its descendants
essentially useless.  Otherwise, Python’s garbage collector will
eventually take care of the objects in the tree.


@subsubheading Ver também



@table @asis

@item Document Object Model (DOM) Level 1 Specification@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

The W3C recommendation for the DOM supported by @ref{122,,xml.dom.minidom}.
@end table


@menu
* Objetos DOM:: 
* DOM Example:: 
* minidom e o padrão DOM:: 

@end menu

@node Objetos DOM,DOM Example,,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom dom-objects}@anchor{3a72}@anchor{library/xml dom minidom minidom-objects}@anchor{3a73}
@subsubsection Objetos DOM


The definition of the DOM API for Python is given as part of the @ref{121,,xml.dom}
module documentation.  This section lists the differences between the API and
@ref{122,,xml.dom.minidom}.

@geindex unlink() (método xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node unlink}@anchor{3a74}
@deffn {Método} Node.unlink ()

Break internal references within the DOM so that it will be garbage collected on
versions of Python without cyclic GC.  Even when cyclic GC is available, using
this can make large amounts of memory available sooner, so calling this on DOM
objects as soon as they are no longer needed is good practice.  This only needs
to be called on the @code{Document} object, but may be called on child nodes
to discard children of that node.

You can avoid calling this method explicitly by using the @ref{5d2,,with}
statement. The following code will automatically unlink `dom' when the
@code{with} block is exited:

@example
with xml.dom.minidom.parse(datasource) as dom:
    ... # Work with dom.
@end example
@end deffn

@geindex writexml() (método xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node writexml}@anchor{aa1}
@deffn {Método} Node.writexml (writer, indent='@w{'}, addindent='@w{'}, newl='@w{'}, encoding=None, standalone=None)

Write XML to the writer object.  The writer receives texts but not bytes as input,
it should have a @code{write()} method which matches that of the file object
interface.  The `indent' parameter is the indentation of the current node.
The `addindent' parameter is the incremental indentation to use for subnodes
of the current one.  The `newl' parameter specifies the string to use to
terminate newlines.

For the @code{Document} node, an additional keyword argument `encoding' can
be used to specify the encoding field of the XML header.

Similarly, explicitly stating the `standalone' argument causes the
standalone document declarations to be added to the prologue of the XML
document.
If the value is set to @code{True}, @code{standalone="yes"} is added,
otherwise it is set to @code{"no"}.
Not stating the argument will omit the declaration from the document.


Alterado na versão 3.8: The @ref{aa1,,writexml()} method now preserves the attribute order specified
by the user.



Alterado na versão 3.9: The `standalone' parameter was added.

@end deffn

@geindex toxml() (método xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node toxml}@anchor{aa2}
@deffn {Método} Node.toxml (encoding=None, standalone=None)

Return a string or byte string containing the XML represented by
the DOM node.

With an explicit `encoding' @footnote{
The encoding name included in the XML output should conform to
the appropriate standards. For example, “UTF-8” is valid, but
“UTF8” is not valid in an XML document’s declaration, even though
Python accepts it as an encoding name.
See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} argument, the result is a byte
string in the specified encoding.
With no `encoding' argument, the result is a Unicode string, and the
XML declaration in the resulting string does not specify an
encoding. Encoding this string in an encoding other than UTF-8 is
likely incorrect, since UTF-8 is the default encoding of XML.

The `standalone' argument behaves exactly as in @ref{aa1,,writexml()}.


Alterado na versão 3.8: The @ref{aa2,,toxml()} method now preserves the attribute order specified
by the user.



Alterado na versão 3.9: The `standalone' parameter was added.

@end deffn

@geindex toprettyxml() (método xml.dom.minidom.Node)
@anchor{library/xml dom minidom xml dom minidom Node toprettyxml}@anchor{aa3}
@deffn {Método} Node.toprettyxml (indent='\t', newl='\n', encoding=None, standalone=None)

Return a pretty-printed version of the document. `indent' specifies the
indentation string and defaults to a tabulator; `newl' specifies the string
emitted at the end of each line and defaults to @code{\n}.

The `encoding' argument behaves like the corresponding argument of
@ref{aa2,,toxml()}.

The `standalone' argument behaves exactly as in @ref{aa1,,writexml()}.


Alterado na versão 3.8: The @ref{aa3,,toprettyxml()} method now preserves the attribute order specified
by the user.



Alterado na versão 3.9: The `standalone' parameter was added.

@end deffn

@node DOM Example,minidom e o padrão DOM,Objetos DOM,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom dom-example}@anchor{3a75}@anchor{library/xml dom minidom id2}@anchor{3a76}
@subsubsection DOM Example


This example program is a fairly realistic example of a simple program. In this
particular case, we do not take much advantage of the flexibility of the 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 e o padrão DOM,,DOM Example,xml dom minidom — Minimal DOM implementation
@anchor{library/xml dom minidom minidom-and-dom}@anchor{3a77}@anchor{library/xml dom minidom minidom-and-the-dom-standard}@anchor{3a78}
@subsubsection minidom e o padrão DOM


The @ref{122,,xml.dom.minidom} module is essentially a DOM 1.0-compatible DOM with
some DOM 2 features (primarily namespace features).

Usage of the DOM interface in Python is straight-forward.  The following mapping
rules apply:


@itemize *

@item 
Interfaces are accessed through instance objects. Applications should not
instantiate the classes themselves; they should use the creator functions
available on the @code{Document} object. Derived interfaces support all
operations (and attributes) from the base interfaces, plus any new operations.

@item 
Operations are used as methods. Since the DOM uses only @ref{2f4,,in}
parameters, the arguments are passed in normal order (from left to right).
There are no optional arguments. @code{void} operations return @code{None}.

@item 
IDL attributes map to instance attributes. For compatibility with the OMG IDL
language mapping for Python, an attribute @code{foo} can also be accessed through
accessor methods @code{_get_foo()} and @code{_set_foo()}.  @code{readonly}
attributes must not be changed; this is not enforced at runtime.

@item 
The types @code{short int}, @code{unsigned int}, @code{unsigned long long}, and
@code{boolean} all map to Python integer objects.

@item 
The type @code{DOMString} maps to Python strings. @ref{122,,xml.dom.minidom} supports
either bytes or strings, but will normally produce strings.
Values of type @code{DOMString} may also be @code{None} where allowed to have the IDL
@code{null} value by the DOM specification from the W3C.

@item 
@code{const} declarations map to variables in their respective scope (e.g.
@code{xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE}); they must not be changed.

@item 
@code{DOMException} is currently not supported in @ref{122,,xml.dom.minidom}.
Instead, @ref{122,,xml.dom.minidom} uses standard Python exceptions such as
@ref{2c3,,TypeError} and @ref{34b,,AttributeError}.

@item 
@code{NodeList} objects are implemented using Python’s built-in list type.
These objects provide the interface defined in the DOM specification, but with
earlier versions of Python they do not support the official API.  They are,
however, much more “Pythonic” than the interface defined in the W3C
recommendations.
@end itemize

The following interfaces have no implementation in @ref{122,,xml.dom.minidom}:


@itemize *

@item 
@code{DOMTimeStamp}

@item 
@code{EntityReference}
@end itemize

Most of these reflect information in the XML document that is not of general
utility to most DOM users.

@node xml dom pulldom — Suporte para construir árvores parciais de DOM,xml sax — Support for SAX2 parsers,xml dom minidom — Minimal DOM implementation,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml dom pulldom doc}@anchor{3a79}@anchor{library/xml dom pulldom module-xml dom pulldom}@anchor{123}@anchor{library/xml dom pulldom translation-repo}@anchor{3a7a}@anchor{library/xml dom pulldom xml-dom-pulldom-support-for-building-partial-dom-trees}@anchor{3a7b}
@subsection @code{xml.dom.pulldom} — Suporte para construir árvores parciais de DOM


@geindex module; xml.dom.pulldom

`Código-fonte:' Lib/xml/dom/pulldom.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/dom/pulldom.py}


__________________________________________________________________


O módulo @ref{123,,xml.dom.pulldom} fornece um “analisador sintático de pull” que também pode ser solicitado a produzir fragmentos do documento acessíveis via DOM, quando necessário. O conceito básico envolve extrair “eventos” de um fluxo de XML recebido e processá-los. Ao contrário do SAX, que também emprega um modelo de processamento orientado a eventos juntamente com retornos de chamada, o usuário de um analisador sintático pull é responsável por extrair explicitamente os eventos do fluxo, repetindo esses eventos até que o processamento seja concluído ou ocorra uma condição de erro.

@cartouche
@quotation Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche


Alterado na versão 3.7.1: O analisador sintático de SAX não processa mais entidades externas gerais por padrão para aumentar a segurança. Para habilitar o processamento de entidades externas, passe uma instância personalizada do analisador sintático em:

@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


Exemplo:

@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} é uma constante e pode ser um de:


@itemize *

@item 
@code{START_ELEMENT}

@item 
@code{END_ELEMENT}

@item 
@code{COMMENT}

@item 
@code{START_DOCUMENT}

@item 
@code{END_DOCUMENT}

@item 
@code{CHARACTERS}

@item 
@code{PROCESSING_INSTRUCTION}

@item 
@code{IGNORABLE_WHITESPACE}
@end itemize

@code{node} é um objeto do tipo @code{xml.dom.minidom.Document}, @code{xml.dom.minidom.Element} ou @code{xml.dom.minidom.Text}.

Como o documento é tratado como um fluxo “plano” de eventos, a “árvore” do documento é implicitamente percorrida e os elementos desejados são encontrados independentemente de sua profundidade na árvore. Em outras palavras, não é necessário considerar questões hierárquicas, como a busca recursiva dos nós do documento, embora, se o contexto dos elementos fosse importante, seria necessário manter algum estado relacionado ao contexto (ou seja, lembrar onde se está no documento em um determinado ponto) ou utilizar o método @ref{3a7c,,DOMEventStream.expandNode()} e alternar para o processamento relacionado ao DOM.

@geindex PullDOM (classe em xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom PullDOM}@anchor{3a7d}
@deffn {Classe} xml.dom.pulldom.PullDOM (documentFactory=None)

Subclasse de @ref{3a7e,,xml.sax.handler.ContentHandler}.
@end deffn

@geindex SAX2DOM (classe em xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom SAX2DOM}@anchor{3a7f}
@deffn {Classe} xml.dom.pulldom.SAX2DOM (documentFactory=None)

Subclasse de @ref{3a7e,,xml.sax.handler.ContentHandler}.
@end deffn

@geindex parse() (no módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom parse}@anchor{3a80}
@deffn {Função} xml.dom.pulldom.parse (stream_or_string, parser=None, bufsize=None)

Retorna um @ref{735,,DOMEventStream} da entrada fornecida. `stream_or_string' pode ser um nome de arquivo ou um objeto arquivo ou similar. `parser', se fornecido, deve ser um objeto @ref{3a81,,XMLReader}. Esta função alterará o manipulador de documentos do analisador e ativará o suporte a espaços de nomes; outras configurações do analisador sintático (como a definição de um resolvedor de entidades) devem ter sido feitas previamente.
@end deffn

Se você tiver XML em uma string, poderá usar a função @ref{3a82,,parseString()}:

@geindex parseString() (no módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom parseString}@anchor{3a82}
@deffn {Função} xml.dom.pulldom.parseString (string, parser=None)

Retorna um @ref{735,,DOMEventStream} que representa a `string' (Unicode).
@end deffn

@geindex default_bufsize (no módulo xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom default_bufsize}@anchor{3a83}
@deffn {Dado} xml.dom.pulldom.default_bufsize

Valor padrão para o parâmetro `bufsize' para @ref{3a80,,parse()}.

O valor desta variável pode ser alterado antes de chamar @ref{3a80,,parse()} e o novo valor entrará em vigor.
@end deffn

@menu
* Objetos DOMEventStream:: 

@end menu

@node Objetos DOMEventStream,,,xml dom pulldom — Suporte para construir árvores parciais de DOM
@anchor{library/xml dom pulldom domeventstream-objects}@anchor{3a84}@anchor{library/xml dom pulldom id1}@anchor{3a85}
@subsubsection Objetos DOMEventStream


@geindex DOMEventStream (classe em xml.dom.pulldom)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream}@anchor{735}
@deffn {Classe} xml.dom.pulldom.DOMEventStream (stream, parser, bufsize)


Alterado na versão 3.11: O suporte para o método @ref{283,,__getitem__()} foi removido


@geindex getEvent() (método xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream getEvent}@anchor{3a86}
@deffn {Método} getEvent ()

Retorna uma tupla contendo evento `event' e o nó `node' atual como @code{xml.dom.minidom.Document} se o evento for igual a @code{START_DOCUMENT}, @code{xml.dom.minidom.Element} se o evento for igual a @code{START_ELEMENT} ou @code{END_ELEMENT} ou @code{xml.dom.minidom.Text} se o evento for igual a @code{CHARACTERS}. O nó atual não contém informações sobre seus filhos, a menos que @ref{3a7c,,expandNode()} seja chamado.
@end deffn

@geindex expandNode() (método xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream expandNode}@anchor{3a7c}
@deffn {Método} expandNode (node)

Expande todos os filhos de `node' para `node'. Exemplo:

@example
from xml.dom import pulldom

xml = '<html><title>Foo</title> <p>Algum texto <div>e mais</div></p> </html>'
doc = pulldom.parseString(xml)
for event, node in doc:
    if event == pulldom.START_ELEMENT and node.tagName == 'p':
        # A seguinte instrução só exibe '<p/>'
        print(node.toxml())
        doc.expandNode(node)
        # A seguinte instrução exibe o nó com todos os seus filhos '<p>Algum texto <div>e mais</div></p>'
        print(node.toxml())
@end example
@end deffn

@geindex reset() (método xml.dom.pulldom.DOMEventStream)
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream reset}@anchor{3a87}
@deffn {Método} reset ()
@end deffn
@end deffn

@node xml sax — Support for SAX2 parsers,xml sax handler — Classes base para manipuladores de SAX,xml dom pulldom — Suporte para construir árvores parciais de DOM,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml sax doc}@anchor{3a88}@anchor{library/xml sax module-xml sax}@anchor{129}@anchor{library/xml sax translation-repo}@anchor{3a89}@anchor{library/xml sax xml-sax-support-for-sax2-parsers}@anchor{3a8a}
@subsection @code{xml.sax} — Support for SAX2 parsers


@geindex module; xml.sax

`Código-fonte:' Lib/xml/sax/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/sax/__init__.py}


__________________________________________________________________


The @ref{129,,xml.sax} package provides a number of modules which implement the
Simple API for XML (SAX) interface for Python.  The package itself provides the
SAX exceptions and the convenience functions which will be most used by users of
the SAX API.

@cartouche
@quotation Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche


Alterado na versão 3.7.1: The SAX parser no longer processes general external entities by default
to increase security. Before, the parser created network connections
to fetch remote files or loaded local files from the file
system for DTD and entities. The feature can be enabled again with method
@ref{3a8b,,setFeature()} on the parser object
and argument @ref{15e0,,feature_external_ges}.


As funções de conveniência são:

@geindex make_parser() (no módulo xml.sax)
@anchor{library/xml sax xml sax make_parser}@anchor{1bb3}
@deffn {Função} xml.sax.make_parser (parser_list=[])

Create and return a SAX @ref{3a81,,XMLReader} object.  The
first parser found will
be used.  If `parser_list' is provided, it must be an iterable of strings which
name modules that have a function named @code{create_parser()}.  Modules listed
in `parser_list' will be used before modules in the default list of parsers.


Alterado na versão 3.8: The `parser_list' argument can be any iterable, not just a list.

@end deffn

@geindex parse() (no módulo xml.sax)
@anchor{library/xml sax xml sax parse}@anchor{1b7b}
@deffn {Função} xml.sax.parse (filename_or_stream, handler, error_handler=handler.ErrorHandler())

Create a SAX parser and use it to parse a document.  The document, passed in as
`filename_or_stream', can be a filename or a file object.  The `handler'
parameter needs to be a SAX @ref{3a7e,,ContentHandler} instance.  If
`error_handler' is given, it must be a SAX @ref{3a8c,,ErrorHandler}
instance; if
omitted,  @ref{3a8d,,SAXParseException} will be raised on all errors.  There is no
return value; all work must be done by the `handler' passed in.
@end deffn

@geindex parseString() (no módulo xml.sax)
@anchor{library/xml sax xml sax parseString}@anchor{ecb}
@deffn {Função} xml.sax.parseString (string, handler, error_handler=handler.ErrorHandler())

Similar to @ref{1b7b,,parse()}, but parses from a buffer `string' received as a
parameter.  `string' must be a @ref{44c,,str} instance or a
@ref{d4f,,bytes-like object}.


Alterado na versão 3.5: Added support of @ref{44c,,str} instances.

@end deffn

A typical SAX application uses three kinds of objects: readers, handlers and
input sources.  “Reader” in this context is another term for parser, i.e. some
piece of code that reads the bytes or characters from the input source, and
produces a sequence of events. The events then get distributed to the handler
objects, i.e. the reader invokes a method on the handler.  A SAX application
must therefore obtain a reader object, create or open the input sources, create
the handlers, and connect these objects all together.  As the final step of
preparation, the reader is called to parse the input. During parsing, methods on
the handler objects are called based on structural and syntactic events from the
input data.

For these objects, only the interfaces are relevant; they are normally not
instantiated by the application itself.  Since Python does not have an explicit
notion of interface, they are formally introduced as classes, but applications
may use implementations which do not inherit from the provided classes.  The
@ref{eca,,InputSource}, @ref{3a8e,,Locator},
@code{Attributes}, @code{AttributesNS},
and @ref{3a81,,XMLReader} interfaces are defined in the
module @ref{12c,,xml.sax.xmlreader}.  The handler interfaces are defined in
@ref{12a,,xml.sax.handler}.  For convenience,
@ref{eca,,InputSource} (which is often
instantiated directly) and the handler classes are also available from
@ref{129,,xml.sax}.  These interfaces are described below.

In addition to these classes, @ref{129,,xml.sax} provides the following exception
classes.

@geindex SAXException
@anchor{library/xml sax xml sax SAXException}@anchor{3a8f}
@deffn {Exceção} xml.sax.SAXException (msg, exception=None)

Encapsulate an XML error or warning.  This class can contain basic error or
warning information from either the XML parser or the application: it can be
subclassed to provide additional functionality or to add localization.  Note
that although the handlers defined in the
@ref{3a8c,,ErrorHandler} interface
receive instances of this exception, it is not required to actually raise the
exception — it is also useful as a container for information.

When instantiated, `msg' should be a human-readable description of the error.
The optional `exception' parameter, if given, should be @code{None} or an exception
that was caught by the parsing code and is being passed along as information.

This is the base class for the other SAX exception classes.
@end deffn

@geindex SAXParseException
@anchor{library/xml sax xml sax SAXParseException}@anchor{3a8d}
@deffn {Exceção} xml.sax.SAXParseException (msg, exception, locator)

Subclass of @ref{3a8f,,SAXException} raised on parse errors. Instances of this
class are passed to the methods of the SAX
@ref{3a8c,,ErrorHandler} interface to provide information
about the parse error.  This class supports the SAX
@ref{3a8e,,Locator} interface as well as the
@ref{3a8f,,SAXException} interface.
@end deffn

@geindex SAXNotRecognizedException
@anchor{library/xml sax xml sax SAXNotRecognizedException}@anchor{3a90}
@deffn {Exceção} xml.sax.SAXNotRecognizedException (msg, exception=None)

Subclass of @ref{3a8f,,SAXException} raised when a SAX
@ref{3a81,,XMLReader} is
confronted with an unrecognized feature or property.  SAX applications and
extensions may use this class for similar purposes.
@end deffn

@geindex SAXNotSupportedException
@anchor{library/xml sax xml sax SAXNotSupportedException}@anchor{3a91}
@deffn {Exceção} xml.sax.SAXNotSupportedException (msg, exception=None)

Subclass of @ref{3a8f,,SAXException} raised when a SAX
@ref{3a81,,XMLReader} is asked to
enable a feature that is not supported, or to set a property to a value that the
implementation does not support.  SAX applications and extensions may use this
class for similar purposes.
@end deffn


@subsubheading Ver também



@table @asis

@item SAX: The Simple API for XML@footnote{http://www.saxproject.org/}

This site is the focal point for the definition of the SAX API.  It provides a
Java implementation and online documentation.  Links to implementations and
historical information are also available.

@item Module @ref{12a,,xml.sax.handler}

Definitions of the interfaces for application-provided objects.

@item Module @ref{12b,,xml.sax.saxutils}

Convenience functions for use in SAX applications.

@item Module @ref{12c,,xml.sax.xmlreader}

Definitions of the interfaces for parser-provided objects.
@end table


@menu
* SAXException Objects:: 

@end menu

@node SAXException Objects,,,xml sax — Support for SAX2 parsers
@anchor{library/xml sax sax-exception-objects}@anchor{3a92}@anchor{library/xml sax saxexception-objects}@anchor{3a93}
@subsubsection SAXException Objects


The @ref{3a8f,,SAXException} exception class supports the following methods:

@geindex getMessage() (método xml.sax.SAXException)
@anchor{library/xml sax xml sax SAXException getMessage}@anchor{3a94}
@deffn {Método} SAXException.getMessage ()

Return a human-readable message describing the error condition.
@end deffn

@geindex getException() (método xml.sax.SAXException)
@anchor{library/xml sax xml sax SAXException getException}@anchor{3a95}
@deffn {Método} SAXException.getException ()

Return an encapsulated exception object, or @code{None}.
@end deffn

@node xml sax handler — Classes base para manipuladores de SAX,xml sax saxutils — Utilitários de SAX,xml sax — Support for SAX2 parsers,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml sax handler doc}@anchor{3a96}@anchor{library/xml sax handler module-xml sax handler}@anchor{12a}@anchor{library/xml sax handler translation-repo}@anchor{3a97}@anchor{library/xml sax handler xml-sax-handler-base-classes-for-sax-handlers}@anchor{3a98}
@subsection @code{xml.sax.handler} — Classes base para manipuladores de SAX


@geindex module; xml.sax.handler

`Código-fonte:' Lib/xml/sax/handler.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/sax/handler.py}


__________________________________________________________________


The SAX API defines five kinds of handlers: content handlers, DTD handlers,
error handlers, entity resolvers and lexical handlers. Applications normally
only need to implement those interfaces whose events they are interested in;
they can implement the interfaces in a single object or in multiple objects.
Handler implementations should inherit from the base classes provided in the
module @ref{12a,,xml.sax.handler}, so that all methods get default implementations.

@geindex ContentHandler (classe em xml.sax.handler)
@anchor{library/xml sax handler xml sax handler ContentHandler}@anchor{3a7e}
@deffn {Classe} xml.sax.handler.ContentHandler

This is the main callback interface in SAX, and the one most important to
applications. The order of events in this interface mirrors the order of the
information in the document.
@end deffn

@geindex DTDHandler (classe em xml.sax.handler)
@anchor{library/xml sax handler xml sax handler DTDHandler}@anchor{3a99}
@deffn {Classe} xml.sax.handler.DTDHandler

Manipular eventos DTD.

This interface specifies only those DTD events required for basic parsing
(unparsed entities and attributes).
@end deffn

@geindex EntityResolver (classe em xml.sax.handler)
@anchor{library/xml sax handler xml sax handler EntityResolver}@anchor{3a9a}
@deffn {Classe} xml.sax.handler.EntityResolver

Basic interface for resolving entities. If you create an object implementing
this interface, then register the object with your Parser, the parser will call
the method in your object to resolve all external entities.
@end deffn

@geindex ErrorHandler (classe em xml.sax.handler)
@anchor{library/xml sax handler xml sax handler ErrorHandler}@anchor{3a8c}
@deffn {Classe} xml.sax.handler.ErrorHandler

Interface used by the parser to present error and warning messages to the
application.  The methods of this object control whether errors are immediately
converted to exceptions or are handled in some other way.
@end deffn

@geindex LexicalHandler (classe em xml.sax.handler)
@anchor{library/xml sax handler xml sax handler LexicalHandler}@anchor{85f}
@deffn {Classe} xml.sax.handler.LexicalHandler

Interface used by the parser to represent low frequency events which may not
be of interest to many applications.
@end deffn

In addition to these classes, @ref{12a,,xml.sax.handler} provides symbolic constants
for the feature and property names.

@geindex feature_namespaces (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_namespaces}@anchor{3a9b}
@deffn {Dado} xml.sax.handler.feature_namespaces


@display
valor: @code{"http://xml.org/sax/features/namespaces"}@w{ }
true: Executa o processamento do espaço de nomes.@w{ }
false: Optionally do not perform Namespace processing (implies namespace-prefixes; default).@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex feature_namespace_prefixes (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_namespace_prefixes}@anchor{3a9c}
@deffn {Dado} xml.sax.handler.feature_namespace_prefixes


@display
valor: @code{"http://xml.org/sax/features/namespace-prefixes"}@w{ }
true: Report the original prefixed names and attributes used for Namespace declarations.@w{ }
false: Do not report attributes used for Namespace declarations, and optionally do not report original prefixed names (default).@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex feature_string_interning (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_string_interning}@anchor{3a9d}
@deffn {Dado} xml.sax.handler.feature_string_interning


@display
valor: @code{"http://xml.org/sax/features/string-interning"}@w{ }
true: All element names, prefixes, attribute names, Namespace URIs, and local names are interned using the built-in intern function.@w{ }
false: Names are not necessarily interned, although they may be (default).@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex feature_validation (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_validation}@anchor{3a9e}
@deffn {Dado} xml.sax.handler.feature_validation


@display
valor: @code{"http://xml.org/sax/features/validation"}@w{ }
true: Report all validation errors (implies external-general-entities and external-parameter-entities).@w{ }
false: Do not report validation errors.@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex feature_external_ges (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_external_ges}@anchor{15e0}
@deffn {Dado} xml.sax.handler.feature_external_ges

@cartouche
@quotation Aviso 
Enabling opens a vulnerability to
external entity attacks@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack}
if the parser is used with user-provided XML content.
Please reflect on your threat model@footnote{https://en.wikipedia.org/wiki/Threat_model}
before enabling this feature.
@end quotation
@end cartouche


@display
valor: @code{"http://xml.org/sax/features/external-general-entities"}@w{ }
true: Include all external general (text) entities.@w{ }
false: Do not include external general entities.@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex feature_external_pes (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler feature_external_pes}@anchor{3a9f}
@deffn {Dado} xml.sax.handler.feature_external_pes


@display
valor: @code{"http://xml.org/sax/features/external-parameter-entities"}@w{ }
true: Include all external parameter entities, including the external DTD subset.@w{ }
false: Do not include any external parameter entities, even the external DTD subset.@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex all_features (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler all_features}@anchor{3aa0}
@deffn {Dado} xml.sax.handler.all_features

Lista de todos os recursos.
@end deffn

@geindex property_lexical_handler (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_lexical_handler}@anchor{3aa1}
@deffn {Dado} xml.sax.handler.property_lexical_handler


@display
valor: @code{"http://xml.org/sax/properties/lexical-handler"}@w{ }
data type: xml.sax.handler.LexicalHandler (not supported in Python 2)@w{ }
descrição: Um tratador de extensão opcional para eventos lexicais como comentários.@w{ }
acesso: leitura/gravação@w{ }
@end display


@end deffn

@geindex property_declaration_handler (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_declaration_handler}@anchor{3aa2}
@deffn {Dado} xml.sax.handler.property_declaration_handler


@display
valor: @code{"http://xml.org/sax/properties/declaration-handler"}@w{ }
data type: xml.sax.sax2lib.DeclHandler (not supported in Python 2)@w{ }
description: An optional extension handler for DTD-related events other than notations and unparsed entities.@w{ }
acesso: leitura/gravação@w{ }
@end display


@end deffn

@geindex property_dom_node (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_dom_node}@anchor{3aa3}
@deffn {Dado} xml.sax.handler.property_dom_node


@display
valor: @code{"http://xml.org/sax/properties/dom-node"}@w{ }
data type: org.w3c.dom.Node (not supported in Python 2)@w{ }
description: When parsing, the current DOM node being visited if this is a DOM iterator; when not parsing, the root DOM node for iteration.@w{ }
access: (parsing) read-only; (not parsing) read/write@w{ }
@end display


@end deffn

@geindex property_xml_string (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler property_xml_string}@anchor{3aa4}
@deffn {Dado} xml.sax.handler.property_xml_string


@display
valor: @code{"http://xml.org/sax/properties/xml-string"}@w{ }
data type: Bytes@w{ }
description: The literal string of characters that was the source for the current event.@w{ }
acesso: somente leitura@w{ }
@end display


@end deffn

@geindex all_properties (no módulo xml.sax.handler)
@anchor{library/xml sax handler xml sax handler all_properties}@anchor{3aa5}
@deffn {Dado} xml.sax.handler.all_properties

List of all known property names.
@end deffn

@menu
* ContentHandler Objects:: 
* DTDHandler Objects:: 
* EntityResolver Objects:: 
* ErrorHandler Objects:: 
* LexicalHandler Objects:: 

@end menu

@node ContentHandler Objects,DTDHandler Objects,,xml sax handler — Classes base para manipuladores de SAX
@anchor{library/xml sax handler content-handler-objects}@anchor{3aa6}@anchor{library/xml sax handler contenthandler-objects}@anchor{3aa7}
@subsubsection ContentHandler Objects


Users are expected to subclass @ref{3a7e,,ContentHandler} to support their
application.  The following methods are called by the parser on the appropriate
events in the input document:

@geindex setDocumentLocator() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler setDocumentLocator}@anchor{3aa8}
@deffn {Método} ContentHandler.setDocumentLocator (locator)

Called by the parser to give the application a locator for locating the origin
of document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a
locator: if it does so, it must supply the locator to the application by
invoking this method before invoking any of the other methods in the
DocumentHandler interface.

The locator allows the application to determine the end position of any
document-related event, even if the parser is not reporting an error. Typically,
the application will use this information for reporting its own errors (such as
character content that does not match an application’s business rules). The
information returned by the locator is probably not sufficient for use with a
search engine.

Note that the locator will return correct information only during the invocation
of the events in this interface. The application should not attempt to use it at
any other time.
@end deffn

@geindex startDocument() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startDocument}@anchor{3aa9}
@deffn {Método} ContentHandler.startDocument ()

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in
this interface or in DTDHandler (except for @ref{3aa8,,setDocumentLocator()}).
@end deffn

@geindex endDocument() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endDocument}@anchor{3aaa}
@deffn {Método} ContentHandler.endDocument ()

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method
invoked during the parse. The parser shall not invoke this method until it has
either abandoned parsing (because of an unrecoverable error) or reached the end
of input.
@end deffn

@geindex startPrefixMapping() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startPrefixMapping}@anchor{3aab}
@deffn {Método} ContentHandler.startPrefixMapping (prefix, uri)

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace
processing: the SAX XML reader will automatically replace prefixes for element
and attribute names when the @code{feature_namespaces} feature is enabled (the
default).

There are cases, however, when applications need to use prefixes in character
data or in attribute values, where they cannot safely be expanded automatically;
the @ref{3aab,,startPrefixMapping()} and @ref{3aac,,endPrefixMapping()} events supply the
information to the application to expand prefixes in those contexts itself, if
necessary.

@c XXX This is not really the default, is it? MvL

Note that @ref{3aab,,startPrefixMapping()} and @ref{3aac,,endPrefixMapping()} events are not
guaranteed to be properly nested relative to each-other: all
@ref{3aab,,startPrefixMapping()} events will occur before the corresponding
@ref{158c,,startElement()} event, and all @ref{3aac,,endPrefixMapping()} events will occur
after the corresponding @ref{158d,,endElement()} event, but their order is not
guaranteed.
@end deffn

@geindex endPrefixMapping() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endPrefixMapping}@anchor{3aac}
@deffn {Método} ContentHandler.endPrefixMapping (prefix)

End the scope of a prefix-URI mapping.

See @ref{3aab,,startPrefixMapping()} for details. This event will always occur after
the corresponding @ref{158d,,endElement()} event, but the order of
@ref{3aac,,endPrefixMapping()} events is not otherwise guaranteed.
@end deffn

@geindex startElement() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startElement}@anchor{158c}
@deffn {Método} ContentHandler.startElement (name, attrs)

Signals the start of an element in non-namespace mode.

The `name' parameter contains the raw XML 1.0 name of the element type as a
string and the `attrs' parameter holds an object of the
@ref{3aad,,Attributes} interface containing the attributes of
the element.  The object passed as `attrs' may be re-used by the parser; holding
on to a reference to it is not a reliable way to keep a copy of the attributes.
To keep a copy of the attributes, use the @ref{25,,copy()} method of the `attrs'
object.
@end deffn

@geindex endElement() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endElement}@anchor{158d}
@deffn {Método} ContentHandler.endElement (name)

Signals the end of an element in non-namespace mode.

The `name' parameter contains the name of the element type, just as with the
@ref{158c,,startElement()} event.
@end deffn

@geindex startElementNS() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler startElementNS}@anchor{3aae}
@deffn {Método} ContentHandler.startElementNS (name, qname, attrs)

Signals the start of an element in namespace mode.

The `name' parameter contains the name of the element type as a @code{(uri,
localname)} tuple, the `qname' parameter contains the raw XML 1.0 name used in
the source document, and the `attrs' parameter holds an instance of the
@ref{3aaf,,AttributesNS} interface
containing the attributes of the element.  If no namespace is associated with
the element, the `uri' component of `name' will be @code{None}.  The object passed
as `attrs' may be re-used by the parser; holding on to a reference to it is not
a reliable way to keep a copy of the attributes.  To keep a copy of the
attributes, use the @ref{25,,copy()} method of the `attrs' object.

Parsers may set the `qname' parameter to @code{None}, unless the
@code{feature_namespace_prefixes} feature is activated.
@end deffn

@geindex endElementNS() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler endElementNS}@anchor{3ab0}
@deffn {Método} ContentHandler.endElementNS (name, qname)

Signals the end of an element in namespace mode.

O parâmetro `name' contém o nome do tipo de elemento, assim como no método @ref{3aae,,startElementNS()}, da mesma forma o parâmetro `qname'.
@end deffn

@geindex characters() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler characters}@anchor{158e}
@deffn {Método} ContentHandler.characters (content)

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX
parsers may return all contiguous character data in a single chunk, or they may
split it into several chunks; however, all of the characters in any single event
must come from the same external entity so that the Locator provides useful
information.

`content' may be a string or bytes instance; the @code{expat} reader module
always produces strings.

@cartouche
@quotation Nota 
The earlier SAX 1 interface provided by the Python XML Special Interest Group
used a more Java-like interface for this method.  Since most parsers used from
Python did not take advantage of the older interface, the simpler signature was
chosen to replace it.  To convert old code to the new interface, use `content'
instead of slicing content with the old `offset' and `length' parameters.
@end quotation
@end cartouche
@end deffn

@geindex ignorableWhitespace() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler ignorableWhitespace}@anchor{3ab1}
@deffn {Método} ContentHandler.ignorableWhitespace (whitespace)

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable
whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating
parsers may also use this method if they are capable of parsing and using
content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may
split it into several chunks; however, all of the characters in any single event
must come from the same external entity, so that the Locator provides useful
information.
@end deffn

@geindex processingInstruction() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler processingInstruction}@anchor{3ab2}
@deffn {Método} ContentHandler.processingInstruction (target, data)

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found:
note that processing instructions may occur before or after the main document
element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a
text declaration (XML 1.0, section 4.3.1) using this method.
@end deffn

@geindex skippedEntity() (método xml.sax.handler.ContentHandler)
@anchor{library/xml sax handler xml sax handler ContentHandler skippedEntity}@anchor{3ab3}
@deffn {Método} ContentHandler.skippedEntity (name)

Receive notification of a skipped entity.

The Parser will invoke this method once for each entity skipped. Non-validating
processors may skip entities if they have not seen the declarations (because,
for example, the entity was declared in an external DTD subset). All processors
may skip external entities, depending on the values of the
@code{feature_external_ges} and the @code{feature_external_pes} properties.
@end deffn

@node DTDHandler Objects,EntityResolver Objects,ContentHandler Objects,xml sax handler — Classes base para manipuladores de SAX
@anchor{library/xml sax handler dtd-handler-objects}@anchor{3ab4}@anchor{library/xml sax handler dtdhandler-objects}@anchor{3ab5}
@subsubsection DTDHandler Objects


As instâncias @ref{3a99,,DTDHandler} fornecem os seguintes métodos:

@geindex notationDecl() (método xml.sax.handler.DTDHandler)
@anchor{library/xml sax handler xml sax handler DTDHandler notationDecl}@anchor{3ab6}
@deffn {Método} DTDHandler.notationDecl (name, publicId, systemId)

Handle a notation declaration event.
@end deffn

@geindex unparsedEntityDecl() (método xml.sax.handler.DTDHandler)
@anchor{library/xml sax handler xml sax handler DTDHandler unparsedEntityDecl}@anchor{3ab7}
@deffn {Método} DTDHandler.unparsedEntityDecl (name, publicId, systemId, ndata)

Handle an unparsed entity declaration event.
@end deffn

@node EntityResolver Objects,ErrorHandler Objects,DTDHandler Objects,xml sax handler — Classes base para manipuladores de SAX
@anchor{library/xml sax handler entity-resolver-objects}@anchor{3ab8}@anchor{library/xml sax handler entityresolver-objects}@anchor{3ab9}
@subsubsection EntityResolver Objects


@geindex resolveEntity() (método xml.sax.handler.EntityResolver)
@anchor{library/xml sax handler xml sax handler EntityResolver resolveEntity}@anchor{3aba}
@deffn {Método} EntityResolver.resolveEntity (publicId, systemId)

Resolve the system identifier of an entity and return either the system
identifier to read from as a string, or an InputSource to read from. The default
implementation returns `systemId'.
@end deffn

@node ErrorHandler Objects,LexicalHandler Objects,EntityResolver Objects,xml sax handler — Classes base para manipuladores de SAX
@anchor{library/xml sax handler errorhandler-objects}@anchor{3abb}@anchor{library/xml sax handler sax-error-handler}@anchor{3abc}
@subsubsection ErrorHandler Objects


Objects with this interface are used to receive error and warning information
from the @ref{3a81,,XMLReader}.  If you create an object that
implements this interface, then register the object with your
@ref{3a81,,XMLReader}, the parser
will call the methods in your object to report all warnings and errors. There
are three levels of errors available: warnings, (possibly) recoverable errors,
and unrecoverable errors.  All methods take a @ref{3a8d,,SAXParseException} as the
only parameter.  Errors and warnings may be converted to an exception by raising
the passed-in exception object.

@geindex error() (método xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler error}@anchor{3abd}
@deffn {Método} ErrorHandler.error (exception)

Called when the parser encounters a recoverable error.  If this method does not
raise an exception, parsing may continue, but further document information
should not be expected by the application.  Allowing the parser to continue may
allow additional errors to be discovered in the input document.
@end deffn

@geindex fatalError() (método xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler fatalError}@anchor{3abe}
@deffn {Método} ErrorHandler.fatalError (exception)

Called when the parser encounters an error it cannot recover from; parsing is
expected to terminate when this method returns.
@end deffn

@geindex warning() (método xml.sax.handler.ErrorHandler)
@anchor{library/xml sax handler xml sax handler ErrorHandler warning}@anchor{3abf}
@deffn {Método} ErrorHandler.warning (exception)

Called when the parser presents minor warning information to the application.
Parsing is expected to continue when this method returns, and document
information will continue to be passed to the application. Raising an exception
in this method will cause parsing to end.
@end deffn

@node LexicalHandler Objects,,ErrorHandler Objects,xml sax handler — Classes base para manipuladores de SAX
@anchor{library/xml sax handler lexical-handler-objects}@anchor{3ac0}@anchor{library/xml sax handler lexicalhandler-objects}@anchor{3ac1}
@subsubsection LexicalHandler Objects


Optional SAX2 handler for lexical events.

This handler is used to obtain lexical information about an XML
document. Lexical information includes information describing the
document encoding used and XML comments embedded in the document, as
well as section boundaries for the DTD and for any CDATA sections.
The lexical handlers are used in the same manner as content handlers.

Set the LexicalHandler of an XMLReader by using the setProperty method
with the property identifier
@code{'http://xml.org/sax/properties/lexical-handler'}.

@geindex comment() (método xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler comment}@anchor{3ac2}
@deffn {Método} LexicalHandler.comment (content)

Reports a comment anywhere in the document (including the DTD and
outside the document element).
@end deffn

@geindex startDTD() (método xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler startDTD}@anchor{3ac3}
@deffn {Método} LexicalHandler.startDTD (name, public_id, system_id)

Reports the start of the DTD declarations if the document has an
associated DTD.
@end deffn

@geindex endDTD() (método xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler endDTD}@anchor{3ac4}
@deffn {Método} LexicalHandler.endDTD ()

Reports the end of DTD declaration.
@end deffn

@geindex startCDATA() (método xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler startCDATA}@anchor{3ac5}
@deffn {Método} LexicalHandler.startCDATA ()

Reports the start of a CDATA marked section.

The contents of the CDATA marked section will be reported through
the characters handler.
@end deffn

@geindex endCDATA() (método xml.sax.handler.LexicalHandler)
@anchor{library/xml sax handler xml sax handler LexicalHandler endCDATA}@anchor{3ac6}
@deffn {Método} LexicalHandler.endCDATA ()

Reports the end of a CDATA marked section.
@end deffn

@node xml sax saxutils — Utilitários de SAX,xml sax xmlreader — Interface for XML parsers,xml sax handler — Classes base para manipuladores de SAX,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml sax utils doc}@anchor{3ac7}@anchor{library/xml sax utils module-xml sax saxutils}@anchor{12b}@anchor{library/xml sax utils translation-repo}@anchor{3ac8}@anchor{library/xml sax utils xml-sax-saxutils-sax-utilities}@anchor{3ac9}
@subsection @code{xml.sax.saxutils} — Utilitários de SAX


@geindex module; xml.sax.saxutils

`Código-fonte:' Lib/xml/sax/saxutils.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/sax/saxutils.py}


__________________________________________________________________


O módulo @ref{12b,,xml.sax.saxutils} contém uma série de classes e funções que são comumente úteis ao criar aplicações SAX, seja em uso direto ou como classes base.

@geindex escape() (no módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils escape}@anchor{3aca}
@deffn {Função} xml.sax.saxutils.escape (data, entities=@{@})

Escapa @code{'&'}, @code{'<'} e @code{'>'} em uma string de dados.

Você pode escapar outras strings de dados passando um dicionário como o parâmetro opcional `entities'. As chaves e os valores devem ser strings; cada chave será substituída pelo seu valor correspondente. Os caracteres @code{'&'}, @code{'<'} e @code{'>'} são sempre escapados, mesmo que `entities' seja fornecido.

@cartouche
@quotation Nota 
Esta função deve ser usada apenas para escapar caracteres que não podem ser usados diretamente em XML. Não a utilize como uma função geral de tradução de strings.
@end quotation
@end cartouche
@end deffn

@geindex unescape() (no módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils unescape}@anchor{3acb}
@deffn {Função} xml.sax.saxutils.unescape (data, entities=@{@})

Remove escape de @code{'&amp;'}, @code{'&lt;'} e @code{'&gt;'} em uma string de dados.

Você pode remover escape de outras strings de dados passando um dicionário como o parâmetro opcional `entities'. As chaves e os valores devem ser strings; cada chave será substituída pelo seu valor correspondente. @code{'&amp;'}, @code{'&lt;'} e @code{'&gt;'} têm sempre o escape removido, mesmo que `entities' seja fornecido.
@end deffn

@geindex quoteattr() (no módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils quoteattr}@anchor{3acc}
@deffn {Função} xml.sax.saxutils.quoteattr (data, entities=@{@})

Semelhante a @ref{3aca,,escape()}, mas também prepara `data' para ser usado como um valor de atributo. O valor de retorno é uma versão entre aspas de `data' com quaisquer substituições adicionais necessárias. @ref{3acc,,quoteattr()} selecionará um caractere de aspas com base no conteúdo de `data', tentando evitar a codificação de quaisquer caracteres de aspas na string. Se já houver caracteres de aspas simples e duplas em `data', os caracteres de aspas duplas serão codificados e `data' será colocado entre aspas duplas. A string resultante pode ser usada diretamente como um valor de atributo:

@example
>>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
<element attr="ab ' cd &quot; ef">
@end example

Esta função é útil ao gerar valores de atributos para HTML ou qualquer SGML usando a sintaxe concreta de referência.
@end deffn

@geindex XMLGenerator (classe em xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils XMLGenerator}@anchor{3acd}
@deffn {Classe} xml.sax.saxutils.XMLGenerator (out=None, encoding='iso-8859-1', short_empty_elements=False)

Esta classe implementa a interface @ref{3a7e,,ContentHandler} escrevendo eventos SAX de volta em um documento XML. Em outras palavras, usar um @ref{3acd,,XMLGenerator} como manipulador de conteúdo reproduzirá o documento original que está sendo analisado. `out' deve ser um objeto arquivo ou similar, cujo padrão é `sys.stdout'. `encoding' é a codificação do fluxo de saída, cujo padrão é @code{'iso-8859-1'}. `short_empty_elements' controla a formatação de elementos sem conteúdo: se @code{False} (o padrão), eles são emitidos como um par de tags de início/fim; se definido como @code{True}, eles são emitidos como uma única tag autofechada.


Alterado na versão 3.2: Foi adicionado o parâmetro `short_empty_elements'.

@end deffn

@geindex XMLFilterBase (classe em xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils XMLFilterBase}@anchor{3ace}
@deffn {Classe} xml.sax.saxutils.XMLFilterBase (base)

Esta classe foi projetada para ficar entre um @ref{3a81,,XMLReader} e os manipuladores de eventos da aplicação cliente. Por padrão, ela não faz nada além de passar requisições para o leitor e eventos para os manipuladores sem modificações, mas subclasses podem substituir métodos específicos para modificar o fluxo de eventos ou as requisições de configuração à medida que passam.
@end deffn

@geindex prepare_input_source() (no módulo xml.sax.saxutils)
@anchor{library/xml sax utils xml sax saxutils prepare_input_source}@anchor{3acf}
@deffn {Função} xml.sax.saxutils.prepare_input_source (source, base='@w{'})

Esta função recebe uma fonte de entrada e uma URL base opcional e retorna um objeto @ref{eca,,InputSource} totalmente resolvido, pronto para leitura. A fonte de entrada pode ser fornecida como uma string, um objeto arquivo ou similar ou um objeto @ref{eca,,InputSource}; os analisadores usarão esta função para implementar o argumento polimórfico `source' em seu método @ref{3ad0,,parse()}.
@end deffn

@node xml sax xmlreader — Interface for XML parsers,xml parsers expat — Fast XML parsing using Expat,xml sax saxutils — Utilitários de SAX,Ferramentas de Processamento de Markup Estruturado
@anchor{library/xml sax reader doc}@anchor{3ad1}@anchor{library/xml sax reader module-xml sax xmlreader}@anchor{12c}@anchor{library/xml sax reader translation-repo}@anchor{3ad2}@anchor{library/xml sax reader xml-sax-xmlreader-interface-for-xml-parsers}@anchor{3ad3}
@subsection @code{xml.sax.xmlreader} — Interface for XML parsers


@geindex module; xml.sax.xmlreader

`Código-fonte:' Lib/xml/sax/xmlreader.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xml/sax/xmlreader.py}


__________________________________________________________________


SAX parsers implement the @ref{3a81,,XMLReader} interface. They are implemented in
a Python module, which must provide a function @code{create_parser()}. This
function is invoked by  @ref{1bb3,,xml.sax.make_parser()} with no arguments to create
a new  parser object.

@geindex XMLReader (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader}@anchor{3a81}
@deffn {Classe} xml.sax.xmlreader.XMLReader

Base class which can be inherited by SAX parsers.
@end deffn

@geindex IncrementalParser (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser}@anchor{3ad4}
@deffn {Classe} xml.sax.xmlreader.IncrementalParser

In some cases, it is desirable not to parse an input source at once, but to feed
chunks of the document as they get available. Note that the reader will normally
not read the entire file, but read it in chunks as well; still @code{parse()}
won’t return until the entire document is processed. So these interfaces should
be used if the blocking behaviour of @code{parse()} is not desirable.

When the parser is instantiated it is ready to begin accepting data from the
feed method immediately. After parsing has been finished with a call to close
the reset method must be called to make the parser ready to accept new data,
either from feed or using the parse method.

Note that these methods must `not' be called during parsing, that is, after
parse has been called and before it returns.

By default, the class also implements the parse method of the XMLReader
interface using the feed, close and reset methods of the IncrementalParser
interface as a convenience to SAX 2.0 driver writers.
@end deffn

@geindex Locator (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader Locator}@anchor{3a8e}
@deffn {Classe} xml.sax.xmlreader.Locator

Interface for associating a SAX event with a document location. A locator object
will return valid results only during calls to DocumentHandler methods; at any
other time, the results are unpredictable. If information is not available,
methods may return @code{None}.
@end deffn

@geindex InputSource (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader InputSource}@anchor{eca}
@deffn {Classe} xml.sax.xmlreader.InputSource (system_id=None)

Encapsulation of the information needed by the @ref{3a81,,XMLReader} to read
entities.

This class may include information about the public identifier, system
identifier, byte stream (possibly with character encoding information) and/or
the character stream of an entity.

Applications will create objects of this class for use in the
@ref{3ad0,,XMLReader.parse()} method and for returning from
EntityResolver.resolveEntity.

An @ref{eca,,InputSource} belongs to the application, the @ref{3a81,,XMLReader} is
not allowed to modify @ref{eca,,InputSource} objects passed to it from the
application, although it may make copies and modify those.
@end deffn

@geindex AttributesImpl (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader AttributesImpl}@anchor{3ad5}
@deffn {Classe} xml.sax.xmlreader.AttributesImpl (attrs)

This is an implementation of the @code{Attributes} interface (see section
@ref{3aad,,The Attributes Interface}).  This is a dictionary-like object which
represents the element attributes in a @code{startElement()} call. In addition
to the most useful dictionary operations, it supports a number of other
methods as described by the interface. Objects of this class should be
instantiated by readers; `attrs' must be a dictionary-like object containing
a mapping from attribute names to attribute values.
@end deffn

@geindex AttributesNSImpl (classe em xml.sax.xmlreader)
@anchor{library/xml sax reader xml sax xmlreader AttributesNSImpl}@anchor{3ad6}
@deffn {Classe} xml.sax.xmlreader.AttributesNSImpl (attrs, qnames)

Namespace-aware variant of @ref{3ad5,,AttributesImpl}, which will be passed to
@code{startElementNS()}. It is derived from @ref{3ad5,,AttributesImpl}, but
understands attribute names as two-tuples of `namespaceURI' and
`localname'. In addition, it provides a number of methods expecting qualified
names as they appear in the original document.  This class implements the
@code{AttributesNS} interface (see section @ref{3aaf,,The AttributesNS Interface}).
@end deffn

@menu
* XMLReader Objects:: 
* IncrementalParser Objects:: 
* Locator Objects:: 
* InputSource Objects:: 
* The Attributes Interface:: 
* The AttributesNS Interface:: 

@end menu

@node XMLReader Objects,IncrementalParser Objects,,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader id1}@anchor{3ad7}@anchor{library/xml sax reader xmlreader-objects}@anchor{3ad8}
@subsubsection XMLReader Objects


The @ref{3a81,,XMLReader} interface supports the following methods:

@geindex parse() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader parse}@anchor{3ad0}
@deffn {Método} XMLReader.parse (source)

Process an input source, producing SAX events. The `source' object can be a
system identifier (a string identifying the input source – typically a file
name or a URL), a @ref{229,,pathlib.Path} or @ref{2a0,,path-like}
object, or an @ref{eca,,InputSource} object. When
@ref{3ad0,,parse()} returns, the input is completely processed, and the parser object
can be discarded or reset.


Alterado na versão 3.5: Added support of character streams.



Alterado na versão 3.8: Added support of path-like objects.

@end deffn

@geindex getContentHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getContentHandler}@anchor{3ad9}
@deffn {Método} XMLReader.getContentHandler ()

Return the current @ref{3a7e,,ContentHandler}.
@end deffn

@geindex setContentHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setContentHandler}@anchor{3ada}
@deffn {Método} XMLReader.setContentHandler (handler)

Set the current @ref{3a7e,,ContentHandler}.  If no
@ref{3a7e,,ContentHandler} is set, content events will be
discarded.
@end deffn

@geindex getDTDHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getDTDHandler}@anchor{3adb}
@deffn {Método} XMLReader.getDTDHandler ()

Return the current @ref{3a99,,DTDHandler}.
@end deffn

@geindex setDTDHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setDTDHandler}@anchor{3adc}
@deffn {Método} XMLReader.setDTDHandler (handler)

Set the current @ref{3a99,,DTDHandler}.  If no
@ref{3a99,,DTDHandler} is set, DTD
events will be discarded.
@end deffn

@geindex getEntityResolver() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getEntityResolver}@anchor{3add}
@deffn {Método} XMLReader.getEntityResolver ()

Return the current @ref{3a9a,,EntityResolver}.
@end deffn

@geindex setEntityResolver() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setEntityResolver}@anchor{3ade}
@deffn {Método} XMLReader.setEntityResolver (handler)

Set the current @ref{3a9a,,EntityResolver}.  If no
@ref{3a9a,,EntityResolver} is set,
attempts to resolve an external entity will result in opening the system
identifier for the entity, and fail if it is not available.
@end deffn

@geindex getErrorHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getErrorHandler}@anchor{3adf}
@deffn {Método} XMLReader.getErrorHandler ()

Return the current @ref{3a8c,,ErrorHandler}.
@end deffn

@geindex setErrorHandler() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setErrorHandler}@anchor{3ae0}
@deffn {Método} XMLReader.setErrorHandler (handler)

Set the current error handler.  If no @ref{3a8c,,ErrorHandler}
is set, errors will be raised as exceptions, and warnings will be printed.
@end deffn

@geindex setLocale() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setLocale}@anchor{3ae1}
@deffn {Método} XMLReader.setLocale (locale)

Allow an application to set the locale for errors and warnings.

SAX parsers are not required to provide localization for errors and warnings; if
they cannot support the requested locale, however, they must raise a SAX
exception.  Applications may request a locale change in the middle of a parse.
@end deffn

@geindex getFeature() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getFeature}@anchor{3ae2}
@deffn {Método} XMLReader.getFeature (featurename)

Return the current setting for feature `featurename'.  If the feature is not
recognized, @code{SAXNotRecognizedException} is raised. The well-known
featurenames are listed in the module @ref{12a,,xml.sax.handler}.
@end deffn

@geindex setFeature() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setFeature}@anchor{3a8b}
@deffn {Método} XMLReader.setFeature (featurename, value)

Set the `featurename' to `value'. If the feature is not recognized,
@code{SAXNotRecognizedException} is raised. If the feature or its setting is not
supported by the parser, `SAXNotSupportedException' is raised.
@end deffn

@geindex getProperty() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader getProperty}@anchor{3ae3}
@deffn {Método} XMLReader.getProperty (propertyname)

Return the current setting for property `propertyname'. If the property is not
recognized, a @code{SAXNotRecognizedException} is raised. The well-known
propertynames are listed in the module @ref{12a,,xml.sax.handler}.
@end deffn

@geindex setProperty() (método xml.sax.xmlreader.XMLReader)
@anchor{library/xml sax reader xml sax xmlreader XMLReader setProperty}@anchor{3ae4}
@deffn {Método} XMLReader.setProperty (propertyname, value)

Set the `propertyname' to `value'. If the property is not recognized,
@code{SAXNotRecognizedException} is raised. If the property or its setting is
not supported by the parser, `SAXNotSupportedException' is raised.
@end deffn

@node IncrementalParser Objects,Locator Objects,XMLReader Objects,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader incremental-parser-objects}@anchor{3ae5}@anchor{library/xml sax reader incrementalparser-objects}@anchor{3ae6}
@subsubsection IncrementalParser Objects


Instances of @ref{3ad4,,IncrementalParser} offer the following additional methods:

@geindex feed() (método xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser feed}@anchor{3ae7}
@deffn {Método} IncrementalParser.feed (data)

Process a chunk of `data'.
@end deffn

@geindex close() (método xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser close}@anchor{3ae8}
@deffn {Método} IncrementalParser.close ()

Assume the end of the document. That will check well-formedness conditions that
can be checked only at the end, invoke handlers, and may clean up resources
allocated during parsing.
@end deffn

@geindex reset() (método xml.sax.xmlreader.IncrementalParser)
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser reset}@anchor{3ae9}
@deffn {Método} IncrementalParser.reset ()

This method is called after close has been called to reset the parser so that it
is ready to parse new documents. The results of calling parse or feed after
close without calling reset are undefined.
@end deffn

@node Locator Objects,InputSource Objects,IncrementalParser Objects,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader id2}@anchor{3aea}@anchor{library/xml sax reader locator-objects}@anchor{3aeb}
@subsubsection Locator Objects


Instances of @ref{3a8e,,Locator} provide these methods:

@geindex getColumnNumber() (método xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getColumnNumber}@anchor{3aec}
@deffn {Método} Locator.getColumnNumber ()

Return the column number where the current event begins.
@end deffn

@geindex getLineNumber() (método xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getLineNumber}@anchor{3aed}
@deffn {Método} Locator.getLineNumber ()

Return the line number where the current event begins.
@end deffn

@geindex getPublicId() (método xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getPublicId}@anchor{3aee}
@deffn {Método} Locator.getPublicId ()

Return the public identifier for the current event.
@end deffn

@geindex getSystemId() (método xml.sax.xmlreader.Locator)
@anchor{library/xml sax reader xml sax xmlreader Locator getSystemId}@anchor{3aef}
@deffn {Método} Locator.getSystemId ()

Return the system identifier for the current event.
@end deffn

@node InputSource Objects,The Attributes Interface,Locator Objects,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader input-source-objects}@anchor{3af0}@anchor{library/xml sax reader inputsource-objects}@anchor{3af1}
@subsubsection InputSource Objects


@geindex setPublicId() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setPublicId}@anchor{3af2}
@deffn {Método} InputSource.setPublicId (id)

Sets the public identifier of this @ref{eca,,InputSource}.
@end deffn

@geindex getPublicId() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getPublicId}@anchor{3af3}
@deffn {Método} InputSource.getPublicId ()

Returns the public identifier of this @ref{eca,,InputSource}.
@end deffn

@geindex setSystemId() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setSystemId}@anchor{3af4}
@deffn {Método} InputSource.setSystemId (id)

Sets the system identifier of this @ref{eca,,InputSource}.
@end deffn

@geindex getSystemId() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getSystemId}@anchor{3af5}
@deffn {Método} InputSource.getSystemId ()

Returns the system identifier of this @ref{eca,,InputSource}.
@end deffn

@geindex setEncoding() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setEncoding}@anchor{3af6}
@deffn {Método} InputSource.setEncoding (encoding)

Sets the character encoding of this @ref{eca,,InputSource}.

The encoding must be a string acceptable for an XML encoding declaration (see
section 4.3.3 of the XML recommendation).

The encoding attribute of the @ref{eca,,InputSource} is ignored if the
@ref{eca,,InputSource} also contains a character stream.
@end deffn

@geindex getEncoding() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getEncoding}@anchor{3af7}
@deffn {Método} InputSource.getEncoding ()

Obtém a codificação de caracteres deste InputSource.
@end deffn

@geindex setByteStream() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setByteStream}@anchor{3af8}
@deffn {Método} InputSource.setByteStream (bytefile)

Set the byte stream (a @ref{1e0e,,binary file}) for this input source.

The SAX parser will ignore this if there is also a character stream specified,
but it will use a byte stream in preference to opening a URI connection itself.

If the application knows the character encoding of the byte stream, it should
set it with the setEncoding method.
@end deffn

@geindex getByteStream() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getByteStream}@anchor{3af9}
@deffn {Método} InputSource.getByteStream ()

Get the byte stream for this input source.

The getEncoding method will return the character encoding for this byte stream,
or @code{None} if unknown.
@end deffn

@geindex setCharacterStream() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource setCharacterStream}@anchor{3afa}
@deffn {Método} InputSource.setCharacterStream (charfile)

Set the character stream (a @ref{1e0d,,text file}) for this input source.

If there is a character stream specified, the SAX parser will ignore any byte
stream and will not attempt to open a URI connection to the system identifier.
@end deffn

@geindex getCharacterStream() (método xml.sax.xmlreader.InputSource)
@anchor{library/xml sax reader xml sax xmlreader InputSource getCharacterStream}@anchor{3afb}
@deffn {Método} InputSource.getCharacterStream ()

Get the character stream for this input source.
@end deffn

@node The Attributes Interface,The AttributesNS Interface,InputSource Objects,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader attributes-objects}@anchor{3aad}@anchor{library/xml sax reader the-attributes-interface}@anchor{3afc}
@subsubsection The @code{Attributes} Interface


@code{Attributes} objects implement a portion of the @ref{11fb,,mapping protocol}, including the methods @code{copy()},
@code{get()}, @ref{1400,,__contains__()},
@code{items()}, @code{keys()},
and @code{values()}.  The following methods
are also provided:

@geindex getLength() (método xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getLength}@anchor{3afd}
@deffn {Método} Attributes.getLength ()

Return the number of attributes.
@end deffn

@geindex getNames() (método xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getNames}@anchor{3afe}
@deffn {Método} Attributes.getNames ()

Return the names of the attributes.
@end deffn

@geindex getType() (método xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getType}@anchor{3aff}
@deffn {Método} Attributes.getType (name)

Returns the type of the attribute `name', which is normally @code{'CDATA'}.
@end deffn

@geindex getValue() (método xml.sax.xmlreader.Attributes)
@anchor{library/xml sax reader xml sax xmlreader Attributes getValue}@anchor{3b00}
@deffn {Método} Attributes.getValue (name)

Return the value of attribute `name'.
@end deffn

@c getValueByQName, getNameByQName, getQNameByName, getQNames available

@c here already, but documented only for derived class.

@node The AttributesNS Interface,,The Attributes Interface,xml sax xmlreader — Interface for XML parsers
@anchor{library/xml sax reader attributes-ns-objects}@anchor{3aaf}@anchor{library/xml sax reader the-attributesns-interface}@anchor{3b01}
@subsubsection The @code{AttributesNS} Interface


This interface is a subtype of the @code{Attributes} interface (see section
@ref{3aad,,The Attributes Interface}).  All methods supported by that interface are also
available on @code{AttributesNS} objects.

The following methods are also available:

@geindex getValueByQName() (método xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getValueByQName}@anchor{3b02}
@deffn {Método} AttributesNS.getValueByQName (name)

Return the value for a qualified name.
@end deffn

@geindex getNameByQName() (método xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getNameByQName}@anchor{3b03}
@deffn {Método} AttributesNS.getNameByQName (name)

Return the @code{(namespace, localname)} pair for a qualified `name'.
@end deffn

@geindex getQNameByName() (método xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNameByName}@anchor{3b04}
@deffn {Método} AttributesNS.getQNameByName (name)

Return the qualified name for a @code{(namespace, localname)} pair.
@end deffn

@geindex getQNames() (método xml.sax.xmlreader.AttributesNS)
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNames}@anchor{3b05}
@deffn {Método} AttributesNS.getQNames ()

Return the qualified names of all attributes.
@end deffn

@node xml parsers expat — Fast XML parsing using Expat,,xml sax xmlreader — Interface for XML parsers,Ferramentas de Processamento de Markup Estruturado
@anchor{library/pyexpat doc}@anchor{3b06}@anchor{library/pyexpat module-xml parsers expat}@anchor{126}@anchor{library/pyexpat translation-repo}@anchor{3b07}@anchor{library/pyexpat xml-parsers-expat-fast-xml-parsing-using-expat}@anchor{3b08}
@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 Nota 
Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche

@geindex Expat

O módulo @ref{126,,xml.parsers.expat} é uma interface Python para o analisador XML sem validação do Expat. O módulo fornece um único tipo de extensão, @code{xmlparser}, que representa o estado atual de um analisador XML. Após um objeto @code{xmlparser} ter sido criado, vários atributos do objeto podem ser configurados para funções manipuladoras. Quando um documento XML é alimentado no analisador, as funções de tratamento são chamadas para os dados de caracteres e marcação no documento XML.

@geindex módulo;pyexpat

Este módulo usa o módulo @code{pyexpat} para fornecer acesso ao analisador sintático Expat. O uso direto do módulo @code{pyexpat} foi descontinuado.

Este módulo fornece uma exceção e um objeto de tipo:

@geindex ExpatError
@anchor{library/pyexpat xml parsers expat ExpatError}@anchor{12ba}
@deffn {Exceção} xml.parsers.expat.ExpatError

A exceção levantada quando o Expat relata um erro. Veja a seção @ref{3b09,,Exceções ExpatError} para mais informações sobre como interpretar erros do Expat.
@end deffn

@geindex error
@anchor{library/pyexpat xml parsers expat error}@anchor{3b0a}
@deffn {Exceção} xml.parsers.expat.error

Apelido para @ref{12ba,,ExpatError}.
@end deffn

@geindex XMLParserType (no módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat XMLParserType}@anchor{3b0b}
@deffn {Dado} xml.parsers.expat.XMLParserType

O tipo dos valores de retorno da função @ref{3b0c,,ParserCreate()}.
@end deffn

O módulo @ref{126,,xml.parsers.expat} contém duas funções:

@geindex ErrorString() (no módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat ErrorString}@anchor{3b0d}
@deffn {Função} xml.parsers.expat.ErrorString (errno)

Retorna uma string explicativa para um determinado número de erro `errno'.
@end deffn

@geindex ParserCreate() (no módulo xml.parsers.expat)
@anchor{library/pyexpat xml parsers expat ParserCreate}@anchor{3b0c}
@deffn {Função} xml.parsers.expat.ParserCreate (encoding=None, namespace_separator=None)

Cria e retorna um novo objeto @code{xmlparser}. `encoding', se especificado, deve ser uma string que nomeia a codificação usada pelos dados XML. Expat não provê tantas codificações quanto Python e seu repertório de codificações não pode ser estendido; provê UTF-8, UTF-16, ISO-8859-1 (Latin1) e ASCII. Se `encoding' @footnote{
The encoding string included in XML output should conform to the
appropriate standards. For example, “UTF-8” is valid, but “UTF8” is
not. See @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl}
and @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} for fornecido, ele substituirá a codificação implícita ou explícita do documento.
@anchor{library/pyexpat xmlparser-non-root}@anchor{3b0e}
Parsers created through @code{ParserCreate()} are called “root” parsers,
in the sense that they do not have any parent parser attached. Non-root
parsers are created by @ref{15ef,,parser.ExternalEntityParserCreate}.

Opcionalmente, o Expat pode fazer o processamento de espaço de nomes XML para você, habilitado ao fornecer um valor para `namespace_separator'. O valor deve ser uma string de um caractere; uma exceção @ref{202,,ValueError} será levantada se a string tiver um comprimento ilegal (@code{None} é considerado o mesmo que omissão). Quando o processamento de espaço de nomes estiver ativado, os nomes de tipos de elementos e nomes de atributos que pertencem a um espaço de nomes serão expandidos. O nome do elemento passado para os manipuladores de elemento @code{StartElementHandler} e @code{EndElementHandler} será a concatenação do URI do espaço de nomes, o caractere separador do espaço de nomes e a parte local do nome. Se o separador do espaço de nomes for um byte zero (@code{chr(0)}), então o URI do espaço de nomes e a parte local serão concatenados sem qualquer separador.

Por exemplo, se `namespace_separator' for definido como um caractere de espaço (@code{' '}) e o seguinte documento for analisado:

@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} receberá as seguintes strings para cada elemento:

@example
http://default-namespace.org/ root
http://www.python.org/ns/ elem1
elem2
@end example

Devido a limitações na biblioteca @code{Expat} usada por @code{pyexpat}, a instância @code{xmlparser} retornada só pode ser usada para analisar um único documento XML. Chame @code{ParserCreate} para cada documento para fornecer instâncias exclusivas do analisador sintático.
@end deffn


@subsubheading Ver também



@table @asis

@item Expat@comma{} analisador sintático de XML@footnote{http://www.libexpat.org/}

Site do projeto Expat
@end table


@menu
* Objetos XMLParser: Objetos XMLParser<2>. 
* Exceções ExpatError:: 
* Exemplo: Exemplo<10>. 
* Content Model Descriptions:: 
* Constantes de erro de expatriados:: 

@end menu

@node Objetos XMLParser<2>,Exceções ExpatError,,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat id2}@anchor{3b0f}@anchor{library/pyexpat xmlparser-objects}@anchor{15db}
@subsubsection Objetos XMLParser


@code{xmlparser} objects have the following methods:

@geindex Parse() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser Parse}@anchor{3b10}
@deffn {Método} xmlparser.Parse (data[, isfinal])

Parses the contents of the string `data', calling the appropriate handler
functions to process the parsed data.  `isfinal' must be true on the final call
to this method; it allows the parsing of a single file in fragments,
not the submission of multiple files.
`data' can be the empty string at any time.
@end deffn

@geindex ParseFile() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ParseFile}@anchor{3b11}
@deffn {Método} xmlparser.ParseFile (file)

Parse XML data reading from the object `file'.  `file' only needs to provide
the @code{read(nbytes)} method, returning the empty string when there’s no more
data.
@end deffn

@geindex SetBase() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetBase}@anchor{3b12}
@deffn {Método} xmlparser.SetBase (base)

Sets the base to be used for resolving relative URIs in system identifiers in
declarations.  Resolving relative identifiers is left to the application: this
value will be passed through as the `base' argument to the
@ref{3b13,,ExternalEntityRefHandler()}, @ref{3b14,,NotationDeclHandler()}, and
@ref{3b15,,UnparsedEntityDeclHandler()} functions.
@end deffn

@geindex GetBase() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetBase}@anchor{3b16}
@deffn {Método} xmlparser.GetBase ()

Returns a string containing the base set by a previous call to @ref{3b12,,SetBase()},
or @code{None} if  @ref{3b12,,SetBase()} hasn’t been called.
@end deffn

@geindex GetInputContext() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetInputContext}@anchor{3b17}
@deffn {Método} xmlparser.GetInputContext ()

Returns the input data that generated the current event as a string. The data is
in the encoding of the entity which contains the text. When called while an
event handler is not active, the return value is @code{None}.
@end deffn

@geindex ExternalEntityParserCreate() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityParserCreate}@anchor{15ef}
@deffn {Método} xmlparser.ExternalEntityParserCreate (context[, encoding])

Create a “child” parser which can be used to parse an external parsed entity
referred to by content parsed by the parent parser.  The `context' parameter
should be the string passed to the @ref{3b13,,ExternalEntityRefHandler()} handler
function, described below. The child parser is created with the
@ref{3b18,,ordered_attributes} and @ref{3b19,,specified_attributes} set to the values of
this parser.
@end deffn

@geindex SetParamEntityParsing() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetParamEntityParsing}@anchor{3b1a}
@deffn {Método} xmlparser.SetParamEntityParsing (flag)

Control parsing of parameter entities (including the external DTD subset).
Possible `flag' values are @code{XML_PARAM_ENTITY_PARSING_NEVER},
@code{XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE} and
@code{XML_PARAM_ENTITY_PARSING_ALWAYS}.  Return true if setting the flag
was successful.
@end deffn

@geindex UseForeignDTD() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser UseForeignDTD}@anchor{3b1b}
@deffn {Método} xmlparser.UseForeignDTD ([flag])

Calling this with a true value for `flag' (the default) will cause Expat to call
the @ref{3b13,,ExternalEntityRefHandler} with @ref{675,,None} for all arguments to
allow an alternate DTD to be loaded.  If the document does not contain a
document type declaration, the @ref{3b13,,ExternalEntityRefHandler} will still be
called, but the @ref{3b1c,,StartDoctypeDeclHandler} and
@ref{3b1d,,EndDoctypeDeclHandler} will not be called.

Passing a false value for `flag' will cancel a previous call that passed a true
value, but otherwise has no effect.

This method can only be called before the @ref{3b10,,Parse()} or @ref{3b11,,ParseFile()}
methods are called; calling it after either of those have been called causes
@ref{12ba,,ExpatError} to be raised with the @ref{1a,,code} attribute set to
@code{errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]}.
@end deffn

@geindex SetReparseDeferralEnabled() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetReparseDeferralEnabled}@anchor{272}
@deffn {Método} xmlparser.SetReparseDeferralEnabled (enabled)

@cartouche
@quotation Aviso 
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{272,,SetReparseDeferralEnabled()} has been backported to some
prior releases of CPython as a security fix.  Check for availability of
@ref{272,,SetReparseDeferralEnabled()} using @ref{4d2,,hasattr()} if used in code
running across a variety of Python versions.


Adicionado na versão 3.13.

@end deffn

@geindex GetReparseDeferralEnabled() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser GetReparseDeferralEnabled}@anchor{271}
@deffn {Método} xmlparser.GetReparseDeferralEnabled ()

Returns whether reparse deferral is currently enabled for the given
Expat parser instance.


Adicionado na versão 3.13.

@end deffn

@code{xmlparser} objects have the following methods to mitigate some
common XML vulnerabilities.

@geindex SetAllocTrackerActivationThreshold() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetAllocTrackerActivationThreshold}@anchor{15d9}
@deffn {Método} xmlparser.SetAllocTrackerActivationThreshold (threshold, /)

Sets the number of allocated bytes of dynamic memory needed to activate
protection against disproportionate use of RAM.

By default, parser objects have an allocation activation threshold of 64 MiB,
or equivalently 67,108,864 bytes.

An @ref{12ba,,ExpatError} is raised if this method is called on a
@ref{3b0e,,non-root} parser.
The corresponding @ref{3b1e,,lineno} and @ref{3b1f,,offset}
should not be used as they may have no special meaning.


Adicionado na versão 3.13.10.

@end deffn

@geindex SetAllocTrackerMaximumAmplification() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser SetAllocTrackerMaximumAmplification}@anchor{15da}
@deffn {Método} xmlparser.SetAllocTrackerMaximumAmplification (max_factor, /)

Sets the maximum amplification factor between direct input and bytes
of dynamic memory allocated.

The amplification factor is calculated as @code{allocated / direct}
while parsing, where @code{direct} is the number of bytes read from
the primary document in parsing and @code{allocated} is the number
of bytes of dynamic memory allocated in the parser hierarchy.

The `max_factor' value must be a non-NaN @ref{2f7,,float} value greater than
or equal to 1.0. Amplification factors greater than 100.0 can be observed
near the start of parsing even with benign files in practice. In particular,
the activation threshold should be carefully chosen to avoid false positives.

By default, parser objects have a maximum amplification factor of 100.0.

An @ref{12ba,,ExpatError} is raised if this method is called on a
@ref{3b0e,,non-root} parser or if `max_factor' is outside the valid range.
The corresponding @ref{3b1e,,lineno} and @ref{3b1f,,offset}
should not be used as they may have no special meaning.

@cartouche
@quotation Nota 
The maximum amplification factor is only considered if the threshold
that can be adjusted by @ref{15d9,,SetAllocTrackerActivationThreshold()}
is exceeded.
@end quotation
@end cartouche


Adicionado na versão 3.13.10.

@end deffn

@code{xmlparser} objects have the following attributes:

@geindex buffer_size (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_size}@anchor{3b20}
@deffn {Atributo} xmlparser.buffer_size

The size of the buffer used when @ref{150a,,buffer_text} is true.
A new buffer size can be set by assigning a new integer value
to this attribute.
When the size is changed, the buffer will be flushed.
@end deffn

@geindex buffer_text (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_text}@anchor{150a}
@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{3b21,,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 xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser buffer_used}@anchor{3b22}
@deffn {Atributo} xmlparser.buffer_used

If @ref{150a,,buffer_text} is enabled, the number of bytes stored in the buffer.
These bytes represent UTF-8 encoded text.  This attribute has no meaningful
interpretation when @ref{150a,,buffer_text} is false.
@end deffn

@geindex ordered_attributes (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ordered_attributes}@anchor{3b18}
@deffn {Atributo} xmlparser.ordered_attributes

Setting this attribute to a non-zero integer causes the attributes to be
reported as a list rather than a dictionary.  The attributes are presented in
the order found in the document text.  For each attribute, two list entries are
presented: the attribute name and the attribute value.  (Older versions of this
module also used this format.)  By default, this attribute is false; it may be
changed at any time.
@end deffn

@geindex specified_attributes (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser specified_attributes}@anchor{3b19}
@deffn {Atributo} xmlparser.specified_attributes

If set to a non-zero integer, the parser will report only those attributes which
were specified in the document instance and not those which were derived from
attribute declarations.  Applications which set this need to be especially
careful to use what additional information is available from the declarations as
needed to comply with the standards for the behavior of XML processors.  By
default, this attribute is false; it may be changed at any time.
@end deffn

The following attributes contain values relating to the most recent error
encountered by an @code{xmlparser} object, and will only have correct values
once a call to @code{Parse()} or @code{ParseFile()} has raised an
@ref{12ba,,xml.parsers.expat.ExpatError} exception.

@geindex ErrorByteIndex (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorByteIndex}@anchor{3b23}
@deffn {Atributo} xmlparser.ErrorByteIndex

Byte index at which an error occurred.
@end deffn

@geindex ErrorCode (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorCode}@anchor{3b24}
@deffn {Atributo} xmlparser.ErrorCode

Numeric code specifying the problem.  This value can be passed to the
@ref{3b0d,,ErrorString()} function, or compared to one of the constants defined in the
@code{errors} object.
@end deffn

@geindex ErrorColumnNumber (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorColumnNumber}@anchor{3b25}
@deffn {Atributo} xmlparser.ErrorColumnNumber

Column number at which an error occurred.
@end deffn

@geindex ErrorLineNumber (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ErrorLineNumber}@anchor{3b26}
@deffn {Atributo} xmlparser.ErrorLineNumber

Line number at which an error occurred.
@end deffn

The following attributes contain values relating to the current parse location
in an @code{xmlparser} object.  During a callback reporting a parse event they
indicate the location of the first of the sequence of characters that generated
the event.  When called outside of a callback, the position indicated will be
just past the last parse event (regardless of whether there was an associated
callback).

@geindex CurrentByteIndex (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentByteIndex}@anchor{3b27}
@deffn {Atributo} xmlparser.CurrentByteIndex

Current byte index in the parser input.
@end deffn

@geindex CurrentColumnNumber (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentColumnNumber}@anchor{3b28}
@deffn {Atributo} xmlparser.CurrentColumnNumber

Current column number in the parser input.
@end deffn

@geindex CurrentLineNumber (atributo xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CurrentLineNumber}@anchor{3b29}
@deffn {Atributo} xmlparser.CurrentLineNumber

Current line number in the parser input.
@end deffn

Here is the list of handlers that can be set.  To set a handler on an
@code{xmlparser} object `o', use @code{o.handlername = func}.  `handlername' must
be taken from the following list, and `func' must be a callable object accepting
the correct number of arguments.  The arguments are all strings, unless
otherwise stated.

@geindex XmlDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser XmlDeclHandler}@anchor{3b2a}
@deffn {Método} xmlparser.XmlDeclHandler (version, encoding, standalone)

Called when the XML declaration is parsed.  The XML declaration is the
(optional) declaration of the applicable version of the XML recommendation, the
encoding of the document text, and an optional “standalone” declaration.
`version' and `encoding' will be strings, and `standalone' will be @code{1} if the
document is declared standalone, @code{0} if it is declared not to be standalone,
or @code{-1} if the standalone clause was omitted. This is only available with
Expat version 1.95.0 or newer.
@end deffn

@geindex StartDoctypeDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartDoctypeDeclHandler}@anchor{3b1c}
@deffn {Método} xmlparser.StartDoctypeDeclHandler (doctypeName, systemId, publicId, has_internal_subset)

Called when Expat begins parsing the document type declaration (@code{<!DOCTYPE
...}).  The `doctypeName' is provided exactly as presented.  The `systemId' and
`publicId' parameters give the system and public identifiers if specified, or
@code{None} if omitted.  `has_internal_subset' will be true if the document
contains and internal document declaration subset. This requires Expat version
1.2 or newer.
@end deffn

@geindex EndDoctypeDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndDoctypeDeclHandler}@anchor{3b1d}
@deffn {Método} xmlparser.EndDoctypeDeclHandler ()

Called when Expat is done parsing the document type declaration. This requires
Expat version 1.2 or newer.
@end deffn

@geindex ElementDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ElementDeclHandler}@anchor{15d6}
@deffn {Método} xmlparser.ElementDeclHandler (name, model)

Called once for each element type declaration.  `name' is the name of the
element type, and `model' is a representation of the content model.
@end deffn

@geindex AttlistDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser AttlistDeclHandler}@anchor{3b2b}
@deffn {Método} xmlparser.AttlistDeclHandler (elname, attname, type, default, required)

Called for each declared attribute for an element type.  If an attribute list
declaration declares three attributes, this handler is called three times, once
for each attribute.  `elname' is the name of the element to which the
declaration applies and `attname' is the name of the attribute declared.  The
attribute type is a string passed as `type'; the possible values are
@code{'CDATA'}, @code{'ID'}, @code{'IDREF'}, … `default' gives the default value for
the attribute used when the attribute is not specified by the document instance,
or @code{None} if there is no default value (@code{#IMPLIED} values).  If the
attribute is required to be given in the document instance, `required' will be
true. This requires Expat version 1.95.0 or newer.
@end deffn

@geindex StartElementHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartElementHandler}@anchor{3b2c}
@deffn {Método} xmlparser.StartElementHandler (name, attributes)

Called for the start of every element.  `name' is a string containing the
element name, and `attributes' is the element attributes. If
@ref{3b18,,ordered_attributes} is true, this is a list (see
@ref{3b18,,ordered_attributes} for a full description). Otherwise it’s a
dictionary mapping names to values.
@end deffn

@geindex EndElementHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndElementHandler}@anchor{3b2d}
@deffn {Método} xmlparser.EndElementHandler (name)

Called for the end of every element.
@end deffn

@geindex ProcessingInstructionHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ProcessingInstructionHandler}@anchor{3b2e}
@deffn {Método} xmlparser.ProcessingInstructionHandler (target, data)

Called for every processing instruction.
@end deffn

@geindex CharacterDataHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CharacterDataHandler}@anchor{3b21}
@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{3b2f,,StartCdataSectionHandler},
@ref{3b30,,EndCdataSectionHandler}, and @ref{15d6,,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{3b21,,CharacterDataHandler()}. Set the @ref{150a,,buffer_text} instance attribute
to @code{True} to avoid that.
@end deffn

@geindex UnparsedEntityDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser UnparsedEntityDeclHandler}@anchor{3b15}
@deffn {Método} xmlparser.UnparsedEntityDeclHandler (entityName, base, systemId, publicId, notationName)

Called for unparsed (NDATA) entity declarations.  This is only present for
version 1.2 of the Expat library; for more recent versions, use
@ref{3b31,,EntityDeclHandler} instead.  (The underlying function in the Expat
library has been declared obsolete.)
@end deffn

@geindex EntityDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EntityDeclHandler}@anchor{3b31}
@deffn {Método} xmlparser.EntityDeclHandler (entityName, is_parameter_entity, value, base, systemId, publicId, notationName)

Called for all entity declarations.  For parameter and internal entities,
`value' will be a string giving the declared contents of the entity; this will
be @code{None} for external entities.  The `notationName' parameter will be
@code{None} for parsed entities, and the name of the notation for unparsed
entities. `is_parameter_entity' will be true if the entity is a parameter entity
or false for general entities (most applications only need to be concerned with
general entities). This is only available starting with version 1.95.0 of the
Expat library.
@end deffn

@geindex NotationDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser NotationDeclHandler}@anchor{3b14}
@deffn {Método} xmlparser.NotationDeclHandler (notationName, base, systemId, publicId)

Called for notation declarations.  `notationName', `base', and `systemId', and
`publicId' are strings if given.  If the public identifier is omitted,
`publicId' will be @code{None}.
@end deffn

@geindex StartNamespaceDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartNamespaceDeclHandler}@anchor{3b32}
@deffn {Método} xmlparser.StartNamespaceDeclHandler (prefix, uri)

Called when an element contains a namespace declaration.  Namespace declarations
are processed before the @ref{3b2c,,StartElementHandler} is called for the element
on which declarations are placed.
@end deffn

@geindex EndNamespaceDeclHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndNamespaceDeclHandler}@anchor{3b33}
@deffn {Método} xmlparser.EndNamespaceDeclHandler (prefix)

Called when the closing tag is reached for an element  that contained a
namespace declaration.  This is called once for each namespace declaration on
the element in the reverse of the order for which the
@ref{3b32,,StartNamespaceDeclHandler} was called to indicate the start of each
namespace declaration’s scope.  Calls to this handler are made after the
corresponding @ref{3b2d,,EndElementHandler} for the end of the element.
@end deffn

@geindex CommentHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser CommentHandler}@anchor{3b34}
@deffn {Método} xmlparser.CommentHandler (data)

Called for comments.  `data' is the text of the comment, excluding the leading
@code{'<!-}@code{-'} and trailing @code{'-}@code{->'}.
@end deffn

@geindex StartCdataSectionHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser StartCdataSectionHandler}@anchor{3b2f}
@deffn {Método} xmlparser.StartCdataSectionHandler ()

Called at the start of a CDATA section.  This and @ref{3b30,,EndCdataSectionHandler}
are needed to be able to identify the syntactical start and end for CDATA
sections.
@end deffn

@geindex EndCdataSectionHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser EndCdataSectionHandler}@anchor{3b30}
@deffn {Método} xmlparser.EndCdataSectionHandler ()

Called at the end of a CDATA section.
@end deffn

@geindex DefaultHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandler}@anchor{3b35}
@deffn {Método} xmlparser.DefaultHandler (data)

Called for any characters in the XML document for which no applicable handler
has been specified.  This means characters that are part of a construct which
could be reported, but for which no handler has been supplied.
@end deffn

@geindex DefaultHandlerExpand() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandlerExpand}@anchor{3b36}
@deffn {Método} xmlparser.DefaultHandlerExpand (data)

This is the same as the @ref{3b35,,DefaultHandler()},  but doesn’t inhibit expansion
of internal entities. The entity reference will not be passed to the default
handler.
@end deffn

@geindex NotStandaloneHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser NotStandaloneHandler}@anchor{3b37}
@deffn {Método} xmlparser.NotStandaloneHandler ()

Called if the XML document hasn’t been declared as being a standalone document.
This happens when there is an external subset or a reference to a parameter
entity, but the XML declaration does not set standalone to @code{yes} in an XML
declaration.  If this handler returns @code{0}, then the parser will raise an
@code{XML_ERROR_NOT_STANDALONE} error.  If this handler is not set, no
exception is raised by the parser for this condition.
@end deffn

@geindex ExternalEntityRefHandler() (método xml.parsers.expat.xmlparser)
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityRefHandler}@anchor{3b13}
@deffn {Método} xmlparser.ExternalEntityRefHandler (context, base, systemId, publicId)

@cartouche
@quotation Aviso 
Implementing a handler that accesses local files and/or the network
may create a vulnerability to
external entity attacks@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack}
if @code{xmlparser} is used with user-provided XML content.
Please reflect on your threat model@footnote{https://en.wikipedia.org/wiki/Threat_model}
before implementing this handler.
@end quotation
@end cartouche

Called for references to external entities.  `base' is the current base, as set
by a previous call to @ref{3b12,,SetBase()}.  The public and system identifiers,
`systemId' and `publicId', are strings if given; if the public identifier is not
given, `publicId' will be @code{None}.  The `context' value is opaque and should
only be used as described below.

For external entities to be parsed, this handler must be implemented. It is
responsible for creating the sub-parser using
@code{ExternalEntityParserCreate(context)}, initializing it with the appropriate
callbacks, and parsing the entity.  This handler should return an integer; if it
returns @code{0}, the parser will raise an
@code{XML_ERROR_EXTERNAL_ENTITY_HANDLING} error, otherwise parsing will
continue.

If this handler is not provided, external entities are reported by the
@ref{3b35,,DefaultHandler} callback, if provided.
@end deffn

@node Exceções ExpatError,Exemplo<10>,Objetos XMLParser<2>,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat expaterror-exceptions}@anchor{3b38}@anchor{library/pyexpat expaterror-objects}@anchor{3b09}
@subsubsection Exceções ExpatError


@ref{12ba,,ExpatError} exceptions have a number of interesting attributes:

@geindex code (atributo xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError code}@anchor{3b39}
@deffn {Atributo} ExpatError.code

Expat’s internal error number for the specific error.  The
@ref{3b3a,,errors.messages} dictionary maps
these error numbers to Expat’s error messages.  For example:

@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

The @ref{127,,errors} module also provides error message
constants and a dictionary @ref{3b3b,,codes} mapping
these messages back to the error codes, see below.
@end deffn

@geindex lineno (atributo xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError lineno}@anchor{3b1e}
@deffn {Atributo} ExpatError.lineno

Line number on which the error was detected.  The first line is numbered @code{1}.
@end deffn

@geindex offset (atributo xml.parsers.expat.ExpatError)
@anchor{library/pyexpat xml parsers expat ExpatError offset}@anchor{3b1f}
@deffn {Atributo} ExpatError.offset

Character offset into the line where the error occurred.  The first column is
numbered @code{0}.
@end deffn

@node Exemplo<10>,Content Model Descriptions,Exceções ExpatError,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat example}@anchor{3b3c}@anchor{library/pyexpat expat-example}@anchor{3b3d}
@subsubsection Exemplo


The following program defines three handlers that just print out their
arguments.

@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

The output from this program is:

@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 Content Model Descriptions,Constantes de erro de expatriados,Exemplo<10>,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat content-model-descriptions}@anchor{3b3e}@anchor{library/pyexpat expat-content-models}@anchor{3b3f}@anchor{library/pyexpat module-xml parsers expat model}@anchor{128}
@subsubsection Content Model Descriptions


@geindex module; xml.parsers.expat.model

Content models are described using nested tuples.  Each tuple contains four
values: the type, the quantifier, the name, and a tuple of children.  Children
are simply additional content model descriptions.

The values of the first two fields are constants defined in the
@ref{128,,xml.parsers.expat.model} module.  These constants can be collected in two
groups: the model type group and the quantifier group.

The constants in the model type group are:


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_ANY

The element named by the model name was declared to have a content model of
@code{ANY}.
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_CHOICE

The named element allows a choice from a number of options; this is used for
content models such as @code{(A | B | C)}.
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_EMPTY

Elementos declarados como @code{EMPTY} têm este tipo de modelo.
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_MIXED
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_NAME
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CTYPE_SEQ

Models which represent a series of models which follow one after the other are
indicated with this model type.  This is used for models such as @code{(A, B, C)}.
@end deffn

The constants in the quantifier group are:


@deffn {Dado} xml.parsers.expat.model.XML_CQUANT_NONE

No modifier is given, so it can appear exactly once, as for @code{A}.
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CQUANT_OPT

The model is optional: it can appear once or not at all, as for @code{A?}.
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CQUANT_PLUS

The model must occur one or more times (like @code{A+}).
@end deffn


@deffn {Dado} xml.parsers.expat.model.XML_CQUANT_REP

The model must occur zero or more times, as for @code{A*}.
@end deffn

@node Constantes de erro de expatriados,,Content Model Descriptions,xml parsers expat — Fast XML parsing using Expat
@anchor{library/pyexpat expat-error-constants}@anchor{3b40}@anchor{library/pyexpat expat-errors}@anchor{3b41}@anchor{library/pyexpat module-xml parsers expat errors}@anchor{127}
@subsubsection Constantes de erro de expatriados


@geindex module; xml.parsers.expat.errors

The following constants are provided in the @ref{127,,xml.parsers.expat.errors}
module.  These constants are useful in interpreting some of the attributes of
the @code{ExpatError} exception objects raised when an error has occurred.
Since for backwards compatibility reasons, the constants’ value is the error
`message' and not the numeric error `code', you do this by comparing its
@ref{1a,,code} attribute with
@code{errors.codes[errors.XML_ERROR_@var{CONSTANT_NAME}]}.

The @code{errors} module has the following attributes:

@geindex codes (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors codes}@anchor{3b3b}
@deffn {Dado} xml.parsers.expat.errors.codes

A dictionary mapping string descriptions to their error codes.


Adicionado na versão 3.2.

@end deffn

@geindex messages (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors messages}@anchor{3b3a}
@deffn {Dado} xml.parsers.expat.errors.messages

A dictionary mapping numeric error codes to their string descriptions.


Adicionado na versão 3.2.

@end deffn

@geindex XML_ERROR_ASYNC_ENTITY (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ASYNC_ENTITY}@anchor{3b42}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY
@end deffn

@geindex XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF}@anchor{3b43}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

An entity reference in an attribute value referred to an external entity instead
of an internal entity.
@end deffn

@geindex XML_ERROR_BAD_CHAR_REF (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BAD_CHAR_REF}@anchor{3b44}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

A character reference referred to a character which is illegal in XML (for
example, character @code{0}, or ‘@code{&#0;}’).
@end deffn

@geindex XML_ERROR_BINARY_ENTITY_REF (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BINARY_ENTITY_REF}@anchor{3b45}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

An entity reference referred to an entity which was declared with a notation, so
cannot be parsed.
@end deffn

@geindex XML_ERROR_DUPLICATE_ATTRIBUTE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_DUPLICATE_ATTRIBUTE}@anchor{3b46}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

An attribute was used more than once in a start tag.
@end deffn

@geindex XML_ERROR_INCORRECT_ENCODING (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCORRECT_ENCODING}@anchor{3b47}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING
@end deffn

@geindex XML_ERROR_INVALID_TOKEN (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_TOKEN}@anchor{3b48}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

Raised when an input byte could not properly be assigned to a character; for
example, a NUL byte (value @code{0}) in a UTF-8 input stream.
@end deffn

@geindex XML_ERROR_JUNK_AFTER_DOC_ELEMENT (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_JUNK_AFTER_DOC_ELEMENT}@anchor{3b49}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

Something other than whitespace occurred after the document element.
@end deffn

@geindex XML_ERROR_MISPLACED_XML_PI (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_MISPLACED_XML_PI}@anchor{3b4a}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

An XML declaration was found somewhere other than the start of the input data.
@end deffn

@geindex XML_ERROR_NO_ELEMENTS (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_ELEMENTS}@anchor{3b4b}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

The document contains no elements (XML requires all documents to contain exactly
one top-level element)..
@end deffn

@geindex XML_ERROR_NO_MEMORY (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_MEMORY}@anchor{3b4c}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

Expat was not able to allocate memory internally.
@end deffn

@geindex XML_ERROR_PARAM_ENTITY_REF (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARAM_ENTITY_REF}@anchor{3b4d}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

A parameter entity reference was found where it was not allowed.
@end deffn

@geindex XML_ERROR_PARTIAL_CHAR (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARTIAL_CHAR}@anchor{3b4e}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

An incomplete character was found in the input.
@end deffn

@geindex XML_ERROR_RECURSIVE_ENTITY_REF (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RECURSIVE_ENTITY_REF}@anchor{3b4f}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

An entity reference contained another reference to the same entity; possibly via
a different name, and possibly indirectly.
@end deffn

@geindex XML_ERROR_SYNTAX (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SYNTAX}@anchor{3b50}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_SYNTAX

Some unspecified syntax error was encountered.
@end deffn

@geindex XML_ERROR_TAG_MISMATCH (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TAG_MISMATCH}@anchor{3b51}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

An end tag did not match the innermost open start tag.
@end deffn

@geindex XML_ERROR_UNCLOSED_TOKEN (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_TOKEN}@anchor{3b52}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

Some token (such as a start tag) was not closed before the end of the stream or
the next token was encountered.
@end deffn

@geindex XML_ERROR_UNDEFINED_ENTITY (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDEFINED_ENTITY}@anchor{3b53}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

A reference was made to an entity which was not defined.
@end deffn

@geindex XML_ERROR_UNKNOWN_ENCODING (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNKNOWN_ENCODING}@anchor{3b54}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

The document encoding is not supported by Expat.
@end deffn

@geindex XML_ERROR_UNCLOSED_CDATA_SECTION (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_CDATA_SECTION}@anchor{3b55}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

A CDATA marked section was not closed.
@end deffn

@geindex XML_ERROR_EXTERNAL_ENTITY_HANDLING (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_EXTERNAL_ENTITY_HANDLING}@anchor{3b56}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING
@end deffn

@geindex XML_ERROR_NOT_STANDALONE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_STANDALONE}@anchor{3b57}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

The parser determined that the document was not “standalone” though it declared
itself to be in the XML declaration, and the @code{NotStandaloneHandler} was
set and returned @code{0}.
@end deffn

@geindex XML_ERROR_UNEXPECTED_STATE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNEXPECTED_STATE}@anchor{3b58}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE
@end deffn

@geindex XML_ERROR_ENTITY_DECLARED_IN_PE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ENTITY_DECLARED_IN_PE}@anchor{3b59}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE
@end deffn

@geindex XML_ERROR_FEATURE_REQUIRES_XML_DTD (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FEATURE_REQUIRES_XML_DTD}@anchor{3b5a}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

An operation was requested that requires DTD support to be compiled in, but
Expat was configured without DTD support.  This should never be reported by a
standard build of the @ref{126,,xml.parsers.expat} module.
@end deffn

@geindex XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING}@anchor{3b5b}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

A behavioral change was requested after parsing started that can only be changed
before parsing has started.  This is (currently) only raised by
@code{UseForeignDTD()}.
@end deffn

@geindex XML_ERROR_UNBOUND_PREFIX (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNBOUND_PREFIX}@anchor{3b5c}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

An undeclared prefix was found when namespace processing was enabled.
@end deffn

@geindex XML_ERROR_UNDECLARING_PREFIX (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDECLARING_PREFIX}@anchor{3b5d}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

The document attempted to remove the namespace declaration associated with a
prefix.
@end deffn

@geindex XML_ERROR_INCOMPLETE_PE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCOMPLETE_PE}@anchor{3b5e}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

A parameter entity contained incomplete markup.
@end deffn

@geindex XML_ERROR_XML_DECL (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_XML_DECL}@anchor{3b5f}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_XML_DECL

The document contained no document element at all.
@end deffn

@geindex XML_ERROR_TEXT_DECL (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TEXT_DECL}@anchor{3b60}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

There was an error parsing a text declaration in an external entity.
@end deffn

@geindex XML_ERROR_PUBLICID (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PUBLICID}@anchor{3b61}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_PUBLICID

Characters were found in the public id that are not allowed.
@end deffn

@geindex XML_ERROR_SUSPENDED (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPENDED}@anchor{3b62}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_SUSPENDED

The requested operation was made on a suspended parser, but isn’t allowed.  This
includes attempts to provide additional input or to stop the parser.
@end deffn

@geindex XML_ERROR_NOT_SUSPENDED (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_SUSPENDED}@anchor{3b63}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

An attempt to resume the parser was made when the parser had not been suspended.
@end deffn

@geindex XML_ERROR_ABORTED (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ABORTED}@anchor{3b64}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_ABORTED

This should not be reported to Python applications.
@end deffn

@geindex XML_ERROR_FINISHED (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FINISHED}@anchor{3b65}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_FINISHED

The requested operation was made on a parser which was finished parsing input,
but isn’t allowed.  This includes attempts to provide additional input or to
stop the parser.
@end deffn

@geindex XML_ERROR_SUSPEND_PE (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPEND_PE}@anchor{3b66}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XML (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XML}@anchor{3b67}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML

An attempt was made to
undeclare reserved namespace prefix @code{xml}
or to bind it to another namespace URI.
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XMLNS (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XMLNS}@anchor{3b68}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS

An attempt was made to declare or undeclare reserved namespace prefix @code{xmlns}.
@end deffn

@geindex XML_ERROR_RESERVED_NAMESPACE_URI (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_NAMESPACE_URI}@anchor{3b69}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI

An attempt was made to bind the URI of one the reserved namespace
prefixes @code{xml} and @code{xmlns} to another namespace prefix.
@end deffn

@geindex XML_ERROR_INVALID_ARGUMENT (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_ARGUMENT}@anchor{3b6a}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT

This should not be reported to Python applications.
@end deffn

@geindex XML_ERROR_NO_BUFFER (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_BUFFER}@anchor{3b6b}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_NO_BUFFER

This should not be reported to Python applications.
@end deffn

@geindex XML_ERROR_AMPLIFICATION_LIMIT_BREACH (no módulo xml.parsers.expat.errors)
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_AMPLIFICATION_LIMIT_BREACH}@anchor{3b6c}
@deffn {Dado} xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH

The limit on input amplification factor (from DTD and entities)
has been breached.
@end deffn

@node Protocolos de Internet e Suporte,Serviços Multimídia,Ferramentas de Processamento de Markup Estruturado,A Biblioteca Padrão do Python
@anchor{library/internet doc}@anchor{3b6d}@anchor{library/internet internet}@anchor{3b6e}@anchor{library/internet internet-protocols-and-support}@anchor{3b6f}@anchor{library/internet translation-repo}@anchor{3b70}
@section Protocolos de Internet e Suporte


@geindex WWW
@geindex Internet
@geindex World Wide Web

@geindex módulo;socket

Os módulos descritos neste capítulo implementam protocolos de internet e suporte para tecnologia relacionada. Todos eles são implementados em Python. A maioria desses módulos requer a presença do módulo dependente do sistema @ref{cc,,socket}, que atualmente é suportado na maioria das plataformas populares. Segue uma visão geral:

@menu
* webbrowser — Controlador de navegador web conveniente:: 
* wsgiref — Implementação de referência e utilitários WSGI:: 
* urllib — Módulos de manipulação de URL:: 
* urllib.request — Biblioteca extensível para abrir URLs: urllib request — Biblioteca extensível para abrir URLs. 
* urllib.response — Response classes used by urllib: urllib response — Response classes used by urllib. 
* urllib.parse — Analisa URLs para componentes: urllib parse — Analisa URLs para componentes. 
* urllib.error — Classes de exceção levantadas por urllib.request: urllib error — Classes de exceção levantadas por urllib request. 
* urllib.robotparser — Analisador sintático de robots.txt: urllib robotparser — Analisador sintático de robots txt. 
* http — módulos HTTP:: 
* http.client — HTTP protocol client: http client — HTTP protocol client. 
* ftplib — FTP protocol client:: 
* poplib — Cliente de protocolo POP3:: 
* imaplib — IMAP4 protocol client:: 
* smtplib — Cliente de protocolo SMTP:: 
* uuid — Objetos UUID conforme RFC 4122:: 
* socketserver — Um framework para servidores de rede:: 
* 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 de servidor e cliente XMLRPC:: 
* xmlrpc.client — Cliente XML-RPC: xmlrpc client — Cliente XML-RPC. 
* xmlrpc.server — Servidores XML-RPC básicos: xmlrpc server — Servidores XML-RPC básicos. 
* ipaddress — Biblioteca de manipulação de IPv4/IPv6:: 

@end menu

@node webbrowser — Controlador de navegador web conveniente,wsgiref — Implementação de referência e utilitários WSGI,,Protocolos de Internet e Suporte
@anchor{library/webbrowser doc}@anchor{3b71}@anchor{library/webbrowser module-webbrowser}@anchor{115}@anchor{library/webbrowser webbrowser-convenient-web-browser-controller}@anchor{3b72}
@subsection @code{webbrowser} — Controlador de navegador web conveniente


@geindex module; webbrowser

`Código-fonte:' Lib/webbrowser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/webbrowser.py}


__________________________________________________________________


O módulo @ref{115,,webbrowser} fornece uma interface de alto nível para permitir a exibição de documentos baseados na web para os usuários. Na maioria das circunstâncias, simplesmente chamar a função @ref{3b73,,open()} deste módulo fará a coisa certa.

No Unix, navegadores gráficos são preferidos no X11, mas navegadores em modo texto serão usados se navegadores gráficos não estiverem disponíveis ou um display X11 não estiver disponível. Se navegadores em modo texto forem usados, o processo de chamada será bloqueado até que o usuário saia do navegador.

Se a variável de ambiente 
@geindex BROWSER
@geindex variável de ambiente; BROWSER
@code{BROWSER} existir, ela será interpretada como a lista separada por @ref{1ecc,,os.pathsep} de navegadores a serem tentados antes dos padrões da plataforma. Quando o valor de uma parte da lista contém a string @code{%s}, então ela é interpretada como uma linha de comando literal do navegador a ser usada com o argumento URL substituído por @code{%s}; se a parte não contiver @code{%s}, ela será simplesmente interpretada como o nome do navegador a ser iniciado. @footnote{
Executáveis nomeados aqui sem um caminho completo serão pesquisados nos diretórios fornecidos na variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.
}

Para plataformas não-Unix, ou quando um navegador remoto estiver disponível no Unix, o processo de controle não esperará que o usuário termine de usar o navegador, mas permitirá que o navegador remoto mantenha suas próprias janelas na tela. Se os navegadores remotos não estiverem disponíveis no Unix, o processo de controle iniciará um novo navegador e aguardará.

No iOS, a variável de ambiente 
@geindex BROWSER
@geindex variável de ambiente; BROWSER
@code{BROWSER}, bem como quaisquer argumentos que controlem direitos autorais, preferência do navegador e criação de nova aba/janela serão ignorados. As páginas web `sempre' serão abertas no navegador preferido do usuário, em uma nova aba, com o navegador sendo trazido para o primeiro plano. O uso do módulo @ref{115,,webbrowser} no iOS requer o módulo @ref{2a,,ctypes}. Se @ref{2a,,ctypes} não estiver disponível, as chamadas para @ref{3b73,,open()} falharão.

@menu
* Interface de linha de comando: Interface de linha de comando<6>. 
* Objetos controladores de navegador:: 

@end menu

@node Interface de linha de comando<6>,Objetos controladores de navegador,,webbrowser — Controlador de navegador web conveniente
@anchor{library/webbrowser command-line-interface}@anchor{3b74}@anchor{library/webbrowser webbrowser-cli}@anchor{3b75}
@subsubsection Interface de linha de comando


O script @code{webbrowser} pode ser usado como uma interface de linha de comando para o módulo. Ele aceita uma URL como argumento. Ele aceita os seguintes parâmetros opcionais:

@geindex webbrowser opção de linha de comando; -n
@geindex webbrowser opção de linha de comando; --new-window
@anchor{library/webbrowser cmdoption-webbrowser-n}@anchor{3b76}@anchor{library/webbrowser cmdoption-webbrowser-new-window}@anchor{3b77}
@deffn {Option} @w{-}n, @w{-}@w{-}new@w{-}window

Abre a URL em uma nova janela do navegador, se possível.
@end deffn

@geindex webbrowser opção de linha de comando; -t
@geindex webbrowser opção de linha de comando; --new-tab
@anchor{library/webbrowser cmdoption-webbrowser-t}@anchor{3b78}@anchor{library/webbrowser cmdoption-webbrowser-new-tab}@anchor{3b79}
@deffn {Option} @w{-}t, @w{-}@w{-}new@w{-}tab

Abre a URL em uma nova aba do navegador.
@end deffn

As opções são, naturalmente, mutuamente exclusivas. Exemplo de uso:

@example
python -m webbrowser -t "https://www.python.org"
@end example

@ref{1ed8,,Disponibilidade}: not WASI, not Android.

A seguinte exceção é definida:

@geindex Error
@anchor{library/webbrowser webbrowser Error}@anchor{3b7a}
@deffn {Exceção} webbrowser.Error

Exceção levantada quando ocorre um erro de controle do navegador.
@end deffn

As seguintes funções estão definidas:

@geindex open() (no módulo webbrowser)
@anchor{library/webbrowser webbrowser open}@anchor{3b73}
@deffn {Função} webbrowser.open (url, new=0, autoraise=True)

Exibe `url' usando o navegador padrão. Se `new' for 0, o `url' será aberto na mesma janela do navegador, se possível. Se `new' for 1, uma nova janela do navegador será aberta, se possível. Se `new' for 2, uma nova página do navegador (“aba” ou “guia”) será aberta, se possível. Se `autoraise' for @code{True}, a janela será levantada, se possível (observe que, em muitos gerenciadores de janelas, isso ocorrerá independentemente da configuração dessa variável).

Retorna @code{True} se um navegador foi iniciado com sucesso, @code{False} caso contrário.

Note que em algumas plataformas, tentar abrir um nome de arquivo usando esta função pode funcionar e iniciar o programa associado do sistema operacional. No entanto, isso não é suportado nem portátil.

Levanta um @ref{19fa,,evento de auditoria} @code{webbrowser.open} com o argumento @code{url}.
@end deffn

@geindex open_new() (no módulo webbrowser)
@anchor{library/webbrowser webbrowser open_new}@anchor{3b7b}
@deffn {Função} webbrowser.open_new (url)

Abre `url' em uma nova janela do navegador padrão, se possível; caso contrário, abre `url' na única janela do navegador.

Retorna @code{True} se um navegador foi iniciado com sucesso, @code{False} caso contrário.
@end deffn

@geindex open_new_tab() (no módulo webbrowser)
@anchor{library/webbrowser webbrowser open_new_tab}@anchor{3b7c}
@deffn {Função} webbrowser.open_new_tab (url)

Abre  `url' em uma nova página (“aba” ou “guia”) do navegador padrão, se possível, caso contrário, equivalente a @ref{3b7b,,open_new()}.

Retorna @code{True} se um navegador foi iniciado com sucesso, @code{False} caso contrário.
@end deffn

@geindex get() (no módulo webbrowser)
@anchor{library/webbrowser webbrowser get}@anchor{3b7d}
@deffn {Função} webbrowser.get (using=None)

Retorna um objeto controlador para o tipo de navegador `using'. Se `using' for @code{None}, retorna um controlador para um navegador padrão apropriado para o ambiente do chamador.
@end deffn

@geindex register() (no módulo webbrowser)
@anchor{library/webbrowser webbrowser register}@anchor{3b7e}
@deffn {Função} webbrowser.register (name, constructor, instance=None, *, preferred=False)

Registra o tipo de navegador `name'. Uma vez que um tipo de navegador é registrado, a função @ref{3b7d,,get()} pode retornar um controlador para esse tipo de navegador. Se `instance' não for fornecido, ou for @code{None}, `constructor' será chamado sem parâmetros para criar uma instância quando necessário. Se `instance' for fornecido, `constructor' nunca será chamado, e pode ser @code{None}.

Definir `preferred' como @code{True} torna este navegador um resultado preferencial para uma chamada @ref{3b7d,,get()} sem argumento. Caso contrário, este ponto de entrada só é útil se você planeja definir a variável 
@geindex BROWSER
@geindex variável de ambiente; BROWSER
@code{BROWSER} ou chamar @ref{3b7d,,get()} com um argumento não vazio que corresponda ao nome de um manipulador que você declarar.


Alterado na versão 3.7: Parâmetro somente-nomeado `preferred' foi adicionado.

@end deffn

Vários tipos de navegadores são predefinidos. Esta tabela fornece os nomes de tipos que podem ser passados para a função @ref{3b7d,,get()} e as instanciações correspondentes para as classes do controlador, todas definidas neste módulo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

Nome do tipo

@tab

Nome da classe

@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” é o gerenciador de arquivos para o ambiente de desktop KDE para Unix, e só faz sentido usar se estiver no KDE. Alguma maneira de detectar o KDE de forma confiável seria legal; a variável @code{KDEDIR} não é suficiente. Note também que o nome “kfm” é usado mesmo ao usar o comando @code{konqueror} com o KDE 2 — a implementação seleciona a melhor estratégia para executar o Konqueror.

@item 
Somente em plataformas Windows.

@item 
Somente no macOS.

@item 
Somente no iOS.
@end enumerate


Adicionado na versão 3.2: Uma nova classe @code{MacOSXOSAScript} foi adicionada e é usada no Mac em vez da classe anterior @code{MacOSX}. Isso adiciona suporte para abrir navegadores que não estão definidos como padrão do sistema operacional no momento.



Adicionado na versão 3.3: Foi adicionado suporte para Chrome/Chromium.



Alterado na versão 3.12: O suporte para vários navegadores obsoletos foi removido. Os navegadores removidos incluem Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape e Firefox versões 35 e abaixo.



Alterado na versão 3.13: Foi adicionado suporte para iOS.


Aqui estão alguns exemplos simples:

@example
url = 'https://docs.python.org/'

# Abre a URL em uma nova aba, se uma janela do navegador já estiver aberta.
webbrowser.open_new_tab(url)

# Abre a URL em uma nova janela, aumentando a janela se possível.
webbrowser.open_new(url)
@end example

@node Objetos controladores de navegador,,Interface de linha de comando<6>,webbrowser — Controlador de navegador web conveniente
@anchor{library/webbrowser browser-controller-objects}@anchor{3b7f}@anchor{library/webbrowser browser-controllers}@anchor{3b80}
@subsubsection Objetos controladores de navegador


Os controladores de navegador fornecem o atributo @ref{297,,name} e os três métodos a seguir que são paralelos às funções de conveniência em nível de módulo:

@geindex name (atributo webbrowser.controller)
@anchor{library/webbrowser webbrowser controller name}@anchor{297}
@deffn {Atributo} controller.name

Nome dependente do sistema para o navegador.
@end deffn

@geindex open() (método webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open}@anchor{3b81}
@deffn {Método} controller.open (url, new=0, autoraise=True)

Exibe `url' usando o navegador manipulado por este controlador. Se `new' for 1, uma nova janela do navegador será aberta, se possível. Se `new' for 2, uma nova página do navegador (“aba” ou “guia”) será aberta, se possível.
@end deffn

@geindex open_new() (método webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open_new}@anchor{3b82}
@deffn {Método} controller.open_new (url)

Abre `url' em uma nova janela do navegador manipulado por este controlador, se possível, caso contrário, abra `url' na única janela do navegador. Apelido para @ref{3b7b,,open_new()}.
@end deffn

@geindex open_new_tab() (método webbrowser.controller)
@anchor{library/webbrowser webbrowser controller open_new_tab}@anchor{3b83}
@deffn {Método} controller.open_new_tab (url)

Abre `url' em uma nova página (“aba” ou “guia”) do navegador manipulado por este controlador, se possível, caso contrário, equivalente a @ref{3b7b,,open_new()}.
@end deffn

@node wsgiref — Implementação de referência e utilitários WSGI,urllib — Módulos de manipulação de URL,webbrowser — Controlador de navegador web conveniente,Protocolos de Internet e Suporte
@anchor{library/wsgiref doc}@anchor{3b84}@anchor{library/wsgiref module-wsgiref}@anchor{118}@anchor{library/wsgiref translation-repo}@anchor{3b85}@anchor{library/wsgiref wsgiref-wsgi-utilities-and-reference-implementation}@anchor{3b86}
@subsection @code{wsgiref} — Implementação de referência e utilitários WSGI


@geindex module; wsgiref

`Código-fonte:' Lib/wsgiref@footnote{https://github.com/python/cpython/tree/3.13/Lib/wsgiref}


__________________________________________________________________


A Interface de Gateway para Servidor Web (em inglês, Web Server Gateway Interface - WSGI) é uma interface padrão localizada entre software de servidores web e aplicações web escritas em Python. Ter um interface padrão torna mais fácil a utilização de uma aplicação que suporta WSGI com inúmeros diferentes servidores web.

Apenas autores de servidores web e frameworks de programação necessitam saber todos os detalhes e especificidades do design WSGI. Você não precisa entender todos os detalhes do WSGI para apenas instalar uma aplicação WSGI ou para escrever uma aplicação web usando um framework existente.

@ref{118,,wsgiref} é uma implementação de referência da especificação WSGI que pode ser utilizada para adicionar suporte WSGI em um servidor web ou framework. Ele provê utilidades para manipulação de variáveis de ambiente WSGI e cabeçalhos de respostas, classes base para implementação de servidores WSGI, uma demo de um servidor HTTP que serve aplicações WSGI, tipos para verificação de tipos estáticos e uma ferramenta de validação que confere se servidores WSGI e aplicações estão de acordo com a especificação WSGI (
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}).

Veja wsgi.readthedocs.io@footnote{https://wsgi.readthedocs.io/} para mais informações sobre WSGI, além de links para tutoriais e outros recursos.

@c XXX If you're just trying to write a web application...

@menu
* wsgiref.util – Utilidades do ambiente WSGI: wsgiref util – Utilidades do ambiente WSGI. 
* wsgiref.headers – Ferramentas de cabeçalho de resposta WSGI: wsgiref headers – Ferramentas de cabeçalho de resposta WSGI. 
* wsgiref.simple_server – um servidor HTTP WSGI simples: wsgiref simple_server – um servidor HTTP WSGI simples. 
* wsgiref.validate — Verificador de conformidade WSGI: wsgiref validate — Verificador de conformidade WSGI. 
* wsgiref.handlers – classes base de servidor/gateway: wsgiref handlers – classes base de servidor/gateway. 
* wsgiref.types – WSGI types for static type checking: wsgiref types – WSGI types for static type checking. 
* Exemplos: Exemplos<25>. 

@end menu

@node wsgiref util – Utilidades do ambiente WSGI,wsgiref headers – Ferramentas de cabeçalho de resposta WSGI,,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref util}@anchor{11d}@anchor{library/wsgiref wsgiref-util-wsgi-environment-utilities}@anchor{3b87}
@subsubsection @code{wsgiref.util} – Utilidades do ambiente WSGI


@geindex module; wsgiref.util

Este módulo fornece uma variedade de funções de utilidade para trabalhar com ambientes WSGI. Um ambiente WSGI é um dicionário contendo variáveis de solicitação HTTP, conforme descrito na 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Todas as funções que recebem um parâmetro `environ' esperam que um dicionário compatível com WSGI seja fornecido; consulte a 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} para uma especificação detalhada e @ref{3b88,,WSGIEnvironment} para um apelido de tipo que pode ser usado em anotações de tipos.

@geindex guess_scheme() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util guess_scheme}@anchor{3b89}
@deffn {Função} wsgiref.util.guess_scheme (environ)

Retorna uma sugestão sobre @code{wsgi.url_scheme} ser “http” ou “https” buscando por uma variável de ambiente @code{HTTPS} dentro do dicionário `environ'. O valor de retorno é uma string.

Esta função é útil ao criar um gateway que encapsula CGI ou um protocolo semelhante a CGI, como FastCGI. Normalmente, servidores que fornecem tais protocolos incluirão uma variável @code{HTTPS} com um valor de “1”, “yes” ou “on” quando uma solicitação é recebida via SSL. Então, esta função retorna “https” se tal valor for encontrado, e “http” caso contrário.
@end deffn

@geindex request_uri() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util request_uri}@anchor{3b8a}
@deffn {Função} wsgiref.util.request_uri (environ, include_query=True)

Retorna o URI de solicitação completo, opcionalmente incluindo a string de consulta, usando o algoritmo encontrado na seção “URL Reconstruction” da 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Se `include_query' for falso, a string de consulta não será incluída no URI resultante.
@end deffn

@geindex application_uri() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util application_uri}@anchor{3b8b}
@deffn {Função} wsgiref.util.application_uri (environ)

Semelhante a @ref{3b8a,,request_uri()}, exceto que as variáveis @code{PATH_INFO} e @code{QUERY_STRING} são ignoradas. O resultado é o URI base do objeto da aplicação endereçado pela solicitação.
@end deffn

@geindex shift_path_info() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util shift_path_info}@anchor{3b8c}
@deffn {Função} wsgiref.util.shift_path_info (environ)

Desloca um único nome de @code{PATH_INFO} para @code{SCRIPT_NAME} e retorna o nome. O dicionário `environ' é `modificado' no local; use uma cópia se precisar manter o @code{PATH_INFO} ou @code{SCRIPT_NAME} original intacto.

Se não houver segmentos de caminho restantes em @code{PATH_INFO}, @code{None} será retornado.

Normalmente, essa rotina é usada para processar cada porção de um caminho de URI de solicitação, por exemplo, para tratar o caminho como uma série de chaves de dicionário. Essa rotina modifica o ambiente passado para torná-lo adequado para invocar outra aplicação WSGI localizada no URI de destino. Por exemplo, se houver uma aplicação WSGI em @code{/foo}, e o caminho de URI de solicitação for @code{/foo/bar/baz}, e a aplicação WSGI em @code{/foo} chamar @ref{3b8c,,shift_path_info()}, ele receberá a string “bar”, e o ambiente será atualizado para ser adequado para passar para uma aplicação WSGI em @code{/foo/bar}. Ou seja, @code{SCRIPT_NAME} mudará de @code{/foo} para @code{/foo/bar}, e @code{PATH_INFO} mudará de @code{/bar/baz} para @code{/baz}.

Quando @code{PATH_INFO} é apenas um “/”, esta rotina retorna uma string vazia e acrescenta uma barra final a @code{SCRIPT_NAME}, embora segmentos de caminho vazios sejam normalmente ignorados, e @code{SCRIPT_NAME} normalmente não termine em uma barra. Este é um comportamento intencional, para garantir que uma aplicação possa diferenciar URIs terminando em @code{/x} daqueles terminando em @code{/x/} ao usar esta rotina para fazer travessia de objetos.
@end deffn

@geindex setup_testing_defaults() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util setup_testing_defaults}@anchor{3b8d}
@deffn {Função} wsgiref.util.setup_testing_defaults (environ)

Atualiza `environ' com padrões triviais para fins de teste.

Esta rotina adiciona vários parâmetros necessários para WSGI, incluindo @code{HTTP_HOST}, @code{SERVER_NAME}, @code{SERVER_PORT}, @code{REQUEST_METHOD}, @code{SCRIPT_NAME}, @code{PATH_INFO} e todas as variáveis @code{wsgi.*} definidas pela 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. Ela fornece apenas valores padrão e não substitui nenhuma configuração existente para essas variáveis.

Esta rotina tem como objetivo facilitar que testes unitários de servidores e aplicações WSGI configurem ambientes fictícios. Ela NÃO deve ser usada por servidores ou aplicações WSGI reais, pois os dados são falsos!

Exemplo de uso (veja também @ref{3b8e,,demo_app()} para outro exemplo):

@example
from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server

# Uma aplicação WSGI relativamente simples. Vai exibir o dicionário
# do ambiente após ser atualizada por 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

Além das funções de ambiente acima, o módulo @ref{11d,,wsgiref.util} também fornece estes utilitários diversos:

@geindex is_hop_by_hop() (no módulo wsgiref.util)
@anchor{library/wsgiref wsgiref util is_hop_by_hop}@anchor{17b7}
@deffn {Função} wsgiref.util.is_hop_by_hop (header_name)

Retorna @code{True} se ‘header_name’ for um cabeçalho HTTP/1.1 “Hop-by-Hop”, conforme definido por 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}.
@end deffn

@geindex FileWrapper (classe em wsgiref.util)
@anchor{library/wsgiref wsgiref util FileWrapper}@anchor{736}
@deffn {Classe} wsgiref.util.FileWrapper (filelike, blksize=8192)

Uma implementação concreta do protocolo @ref{3b8f,,wsgiref.types.FileWrapper} usado para converter um objeto arquivo ou similar em um @ref{1ac,,iterador}. Os objetos resultantes são @ref{1268,,iteráveis}. Conforme o objeto é iterado, o parâmetro opcional `blksize' será repetidamente passado para o método @code{read()} do objeto `filelike' para obter bytestrings para produzir. Quando @code{read()} retorna uma string de bytes vazia, a iteração é encerrada e não pode ser retomada.

Se `filelike' tiver um método @code{close()}, o objeto retornado também terá um método @code{close()} e invocará o método @code{close()} do objeto `filelike' quando chamado.

Exemplo de uso:

@example
from io import StringIO
from wsgiref.util import FileWrapper

# Estamos usando um StringIO-buffer como objeto arquivo ou similar
filelike = StringIO("This is an example file-like object"*10)
wrapper = FileWrapper(filelike, blksize=5)

for chunk in wrapper:
    print(chunk)
@end example


Alterado na versão 3.11: O suporte para o método @ref{283,,__getitem__()} foi removido

@end deffn

@node wsgiref headers – Ferramentas de cabeçalho de resposta WSGI,wsgiref simple_server – um servidor HTTP WSGI simples,wsgiref util – Utilidades do ambiente WSGI,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref headers}@anchor{11a}@anchor{library/wsgiref wsgiref-headers-wsgi-response-header-tools}@anchor{3b90}
@subsubsection @code{wsgiref.headers} – Ferramentas de cabeçalho de resposta WSGI


@geindex module; wsgiref.headers

Este módulo fornece uma única classe, @ref{ec7,,Headers}, para manipulação conveniente de cabeçalhos de resposta WSGI usando uma interface semelhante a mapeamento.

@geindex Headers (classe em wsgiref.headers)
@anchor{library/wsgiref wsgiref headers Headers}@anchor{ec7}
@deffn {Classe} wsgiref.headers.Headers ([headers])

Cria um objeto mapeamento envolvendo `headers', que deve ser uma lista de tuplas de nome/valor de cabeçalho, conforme descrito na 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. O valor padrão de `headers' é uma lista vazia.

Os objetos @ref{ec7,,Headers} oferecem suporte a operações de mapeamento típicas, incluindo @ref{283,,__getitem__()}, @ref{1dd2,,get()}, @ref{130e,,__setitem__()}, @ref{10b2,,setdefault()}, @ref{130f,,__delitem__()} e @ref{1400,,__contains__()}. Para cada um desses métodos, a chave é o nome do cabeçalho (tratado sem distinção entre maiúsculas e minúsculas) e o valor é o primeiro valor associado a esse nome de cabeçalho. Definir um cabeçalho exclui quaisquer valores existentes para esse cabeçalho e, em seguida, adiciona um novo valor ao final da lista de cabeçalhos encapsulados. A ordem existente dos cabeçalhos geralmente é mantida, com novos cabeçalhos adicionados ao final da lista encapsulada.

Diferentemente de um dicionário, objetos @ref{ec7,,Headers} não levantam um erro quando você tenta obter ou excluir uma chave que não está na lista de cabeçalhos encapsulados. Obter um cabeçalho inexistente retorna apenas @code{None}, e excluir um cabeçalho inexistente não faz nada.

Os objetos @ref{ec7,,Headers} também oferecem suporte aos métodos @code{keys()}, @code{values()} e @code{items()}. As listas retornadas por @code{keys()} e @code{items()} podem incluir a mesma chave mais de uma vez se houver um cabeçalho multivalorado. O @code{len()} de um objeto @ref{ec7,,Headers} é o mesmo que o comprimento de seus @code{items()}, que é o mesmo que o comprimento da lista de cabeçalhos encapsulados. Na verdade, o método @code{items()} apenas retorna uma cópia da lista de cabeçalhos encapsulados.

Chamar @code{bytes()} em um objeto @ref{ec7,,Headers} retorna uma bytestring formatada adequada para transmissão como cabeçalhos de resposta HTTP. Cada cabeçalho é colocado em uma linha com seu valor, separado por dois pontos e um espaço. Cada linha é terminada por um retorno de carro e uma quebra de linha, e a bytestring é terminada com uma linha em branco.

Além de sua interface de mapeamento e recursos de formatação, os objetos @ref{ec7,,Headers} também têm os seguintes métodos para consultar e adicionar cabeçalhos multivalorados e para adicionar cabeçalhos com parâmetros MIME:

@geindex get_all() (método wsgiref.headers.Headers)
@anchor{library/wsgiref wsgiref headers Headers get_all}@anchor{3b91}
@deffn {Método} get_all (name)

Retorna uma lista de todos os valores para o cabeçalho nomeado.

A lista retornada será classificada na ordem em que apareceu na lista de cabeçalho original ou foi adicionada a esta instância, e pode conter duplicatas. Quaisquer campos excluídos e reinseridos são sempre anexados à lista de cabeçalho. Se não houver campos com o nome fornecido, retorna uma lista vazia.
@end deffn

@geindex add_header() (método wsgiref.headers.Headers)
@anchor{library/wsgiref wsgiref headers Headers add_header}@anchor{3b92}
@deffn {Método} add_header (name, value, **_params)

Adiciona um cabeçalho (possivelmente multivalorado), com parâmetros MIME opcionais especificados por meio de argumentos nomeados.

`name' é o campo de cabeçalho a ser adicionado. Argumentos nomeados podem ser usados para definir parâmetros MIME para o campo de cabeçalho. Cada parâmetro deve ser uma string ou @code{None}. Sublinhados em nomes de parâmetros são convertidos em traços, já que traços são ilegais em identificadores Python, mas muitos nomes de parâmetros MIME incluem traços. Se o valor do parâmetro for uma string, ele será adicionado aos parâmetros de valor do cabeçalho no formato @code{name="value"}. Se for @code{None}, somente o nome do parâmetro será adicionado. (Isso é usado para parâmetros MIME sem um valor.) Exemplo de uso:

@example
h.add_header('content-disposition', 'attachment', filename='bud.gif')
@end example

O exemplo acima adicionará um cabeçalho parecido com este:

@example
Content-Disposition: attachment; filename="bud.gif"
@end example
@end deffn


Alterado na versão 3.5: o parâmetro `headers' é opcional.

@end deffn

@node wsgiref simple_server – um servidor HTTP WSGI simples,wsgiref validate — Verificador de conformidade WSGI,wsgiref headers – Ferramentas de cabeçalho de resposta WSGI,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref simple_server}@anchor{11b}@anchor{library/wsgiref wsgiref-simple-server-a-simple-wsgi-http-server}@anchor{3b93}
@subsubsection @code{wsgiref.simple_server} – um servidor HTTP WSGI simples


@geindex module; wsgiref.simple_server

Este módulo implementa um servidor HTTP simples (com base em @ref{72,,http.server}) que serve aplicações WSGI. Cada instância de servidor serve uma única aplicação WSGI em um host e porta fornecidos. Se você quiser servir várias aplicações em um único host e porta, você deve criar uma aplicação WSGI que analise @code{PATH_INFO} para selecionar qual aplicação invocar para cada solicitação. (Por exemplo, usando a função @code{shift_path_info()} de @ref{11d,,wsgiref.util}.)

@geindex make_server() (no módulo wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server make_server}@anchor{3b94}
@deffn {Função} wsgiref.simple_server.make_server (host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)

Cria um novo servidor WSGI escutando em `host' e `port', aceitando conexões para `app'. O valor de retorno é uma instância da `server_class' fornecida e processará solicitações usando a `handler_class' especificada. `app' deve ser um objeto de aplicação WSGI, conforme definido pela 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.

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

    # Responde a solicitações até o processo ser encerrado
    httpd.serve_forever()

    # Alternativa: serve uma solicitação e então sai
    httpd.handle_request()
@end example
@end deffn

@geindex demo_app() (no módulo wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server demo_app}@anchor{3b8e}
@deffn {Função} wsgiref.simple_server.demo_app (environ, start_response)

Esta função é uma aplicação WSGI pequeno, mas completo, que retorna uma página de texto contendo a mensagem “Hello world!” e uma lista dos pares chave/valor fornecidos no parâmetro `environ'. É útil para verificar se um servidor WSGI (como @ref{11b,,wsgiref.simple_server}) é capaz de executar uma aplicação WSGI simples corretamente.

O chamável `start_response' deve seguir o protocolo @ref{3b95,,StartResponse}.
@end deffn

@geindex WSGIServer (classe em wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server WSGIServer}@anchor{3b96}
@deffn {Classe} wsgiref.simple_server.WSGIServer (server_address, RequestHandlerClass)

Cria uma instância @ref{3b96,,WSGIServer}. `server_address' deve ser uma tupla @code{(host,port)} e `RequestHandlerClass' deve ser a subclasse de @ref{110a,,http.server.BaseHTTPRequestHandler} que será usada para processar solicitações.

Normalmente você não precisa chamar esse construtor, pois a função @ref{3b94,,make_server()} pode cuidar de todos os detalhes para você.

@ref{3b96,,WSGIServer} é uma subclasse de @ref{3b97,,http.server.HTTPServer}, então todos os seus métodos (como @code{serve_forever()} e @code{handle_request()}) estão disponíveis. @ref{3b96,,WSGIServer} também fornece estes métodos específicos do WSGI:

@geindex set_app() (método wsgiref.simple_server.WSGIServer)
@anchor{library/wsgiref wsgiref simple_server WSGIServer set_app}@anchor{3b98}
@deffn {Método} set_app (application)

Define o chamável `application' como a aplicação WSGI que receberá solicitações.
@end deffn

@geindex get_app() (método wsgiref.simple_server.WSGIServer)
@anchor{library/wsgiref wsgiref simple_server WSGIServer get_app}@anchor{3b99}
@deffn {Método} get_app ()

Retorna o chamável da aplicação definido atualmente.
@end deffn

Normalmente, no entanto, você não precisa usar esses métodos adicionais, pois @ref{3b98,,set_app()} é normalmente chamado por @ref{3b94,,make_server()}, e @ref{3b99,,get_app()} existe principalmente para o benefício de instâncias do manipulador de solicitações.
@end deffn

@geindex WSGIRequestHandler (classe em wsgiref.simple_server)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler}@anchor{3b9a}
@deffn {Classe} wsgiref.simple_server.WSGIRequestHandler (request, client_address, server)

Cria um manipulador HTTP para `request' fornecido (isto é, um soquete), `client_address' (uma tupla @code{(host,port)}) e `server' (instância @ref{3b96,,WSGIServer}).

Você não precisa criar instâncias desta classe diretamente; elas são criadas automaticamente conforme necessário pelos objetos @ref{3b96,,WSGIServer}. Você pode, no entanto, estender esta classe e fornecê-la como uma `handler_class' para a função @ref{3b94,,make_server()}. Alguns métodos possivelmente relevantes para substituir em subclasses:

@geindex get_environ() (método wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_environ}@anchor{3b9b}
@deffn {Método} get_environ ()

Retorna um dicionário @ref{3b88,,WSGIEnvironment} para uma solicitação. A implementação padrão copia o conteúdo do atributo de dicionário @code{base_environ} do objeto @ref{3b96,,WSGIServer} e então adiciona vários cabeçalhos derivados da solicitação HTTP. Cada chamada para esse método deve retornar um novo dicionário contendo todas as variáveis de ambiente CGI relevantes conforme especificado na 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.
@end deffn

@geindex get_stderr() (método wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_stderr}@anchor{3b9c}
@deffn {Método} get_stderr ()

Retorna o objeto que deve ser usado como o fluxo @code{wsgi.errors}. A implementação padrão retorna apenas @code{sys.stderr}.
@end deffn

@geindex handle() (método wsgiref.simple_server.WSGIRequestHandler)
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler handle}@anchor{3b9d}
@deffn {Método} handle ()

Processa a solicitação HTTP. A implementação padrão cria uma instância manipuladora usando uma classe @ref{119,,wsgiref.handlers} para implementar a interface da aplicação WSGI.
@end deffn
@end deffn

@node wsgiref validate — Verificador de conformidade WSGI,wsgiref handlers – classes base de servidor/gateway,wsgiref simple_server – um servidor HTTP WSGI simples,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref validate}@anchor{11e}@anchor{library/wsgiref wsgiref-validate-wsgi-conformance-checker}@anchor{3b9e}
@subsubsection @code{wsgiref.validate} — Verificador de conformidade WSGI


@geindex module; wsgiref.validate

Ao criar novos objetos de aplicação WSGI, frameworks, servidores ou middleware, pode ser útil validar a conformidade do novo código usando @ref{11e,,wsgiref.validate}. Este módulo fornece uma função que cria objetos de aplicação WSGI que validam comunicações entre um servidor ou gateway WSGI e um objeto de aplicação WSGI, para verificar ambos os lados quanto à conformidade do protocolo.

Note que este utilitário não garante a conformidade completa com 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}; uma ausência de erros deste módulo não significa necessariamente que os erros não existam. No entanto, se este módulo produzir um erro, então é virtualmente certo que o servidor ou a aplicação não está 100% em conformidade.

Este módulo é baseado no módulo @code{paste.lint} da biblioteca “Python Paste” de Ian Bicking.

@geindex validator() (no módulo wsgiref.validate)
@anchor{library/wsgiref wsgiref validate validator}@anchor{3b9f}
@deffn {Função} wsgiref.validate.validator (application)

Encapsula `application' e retorna um novo objeto de aplicação WSGI. A aplicação retornada encaminhará todas as solicitações para a `application' original e verificará se tanto a `application' quanto o servidor que o invoca estão em conformidade com a especificação WSGI e com 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}.

Qualquer falta de conformidade detectada resulta em uma @ref{6a9,,AssertionError} sendo levantado; note, entretanto, que a forma como esses erros são manipulados depende do servidor. Por exemplo, @ref{11b,,wsgiref.simple_server} e outros servidores baseados em @ref{119,,wsgiref.handlers} (que não substituem os métodos de manipulação de erros para fazer outra coisa) simplesmente emitirão uma mensagem de que ocorreu um erro e despejarão o traceback para @code{sys.stderr} ou algum outro fluxo de erro.

Este invólucro também pode gerar saída usando o módulo @ref{112,,warnings} para indicar comportamentos que são questionáveis, mas que podem não ser realmente proibidos por 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}. A menos que sejam suprimidos usando opções de linha de comando do Python ou a API @ref{112,,warnings}, quaisquer avisos serão gravados em @code{sys.stderr} (`não' @code{wsgi.errors}, a menos que sejam o mesmo objeto).

Exemplo de uso:

@example
from wsgiref.validate import validator
from wsgiref.simple_server import make_server

# Nosso objeto chamável que intencionalmente não está em
# conformidade com o padrão, então o validador irá quebrar
def simple_app(environ, start_response):
    status = '200 OK'  # HTTP Status
    headers = [('Content-type', 'text/plain')]  # HTTP Headers
    start_response(status, headers)

    # Isso vai quebrar porque precisamos retornar uma lista,
    # e o validador vai nos informar
    return b"Hello World"

# Este é a aplicação encapsulada em um validador
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 – classes base de servidor/gateway,wsgiref types – WSGI types for static type checking,wsgiref validate — Verificador de conformidade WSGI,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref handlers}@anchor{119}@anchor{library/wsgiref wsgiref-handlers-server-gateway-base-classes}@anchor{3ba0}
@subsubsection @code{wsgiref.handlers} – classes base de servidor/gateway


@geindex module; wsgiref.handlers

Este módulo fornece classes de manipulador base para implementar servidores e gateways WSGI. Essas classes base lidam com a maior parte do trabalho de comunicação com uma aplicação WSGI, desde que recebam um ambiente semelhante ao CGI, junto com fluxos de entrada, saída e erro.

@geindex CGIHandler (classe em wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers CGIHandler}@anchor{3ba1}
@deffn {Classe} wsgiref.handlers.CGIHandler

Invocação baseada em CGI via @code{sys.stdin}, @code{sys.stdout}, @code{sys.stderr} e @code{os.environ}. Isso é útil quando você tem uma aplicação WSGI e quer executá-lo como um script CGI. Basta invocar @code{CGIHandler().run(app)}, onde @code{app} é o objeto da aplicação WSGI que você deseja invocar.

Esta classe é uma subclasse de @ref{3ba2,,BaseCGIHandler} que define @code{wsgi.run_once} como true, @code{wsgi.multithread} como false e @code{wsgi.multiprocess} como true, e sempre usa @ref{d9,,sys} e @ref{a1,,os} para obter os fluxos CGI e o ambiente necessários.
@end deffn

@geindex IISCGIHandler (classe em wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers IISCGIHandler}@anchor{3ba3}
@deffn {Classe} wsgiref.handlers.IISCGIHandler

Uma alternativa especializada para @ref{3ba1,,CGIHandler}, para uso ao implantar no servidor web IIS da Microsoft, sem ter definido a opção de configuração allowPathInfo (IIS>=7) ou metabase allowPathInfoForScriptMappings (IIS<7).

Por padrão, o IIS fornece um @code{PATH_INFO} que duplica o @code{SCRIPT_NAME} na frente, causando problemas para aplicações WSGI que desejam implementar roteamento. Este manipulador remove qualquer caminho duplicado.

O IIS pode ser configurado para passar o @code{PATH_INFO} correto, mas isso causa outro bug onde @code{PATH_TRANSLATED} está errado. Felizmente, essa variável raramente é usada e não é garantida pelo WSGI. No IIS<7, no entanto, a configuração só pode ser feita em um nível de vhost, afetando todos os outros mapeamentos de script, muitos dos quais quebram quando expostos ao bug @code{PATH_TRANSLATED}. Por esse motivo, o IIS<7 quase nunca é implantado com a correção (mesmo o IIS7 raramente a usa porque ainda não há uma UI para ela).

Não há como o código CGI dizer se a opção foi definida, então uma classe de manipulador separada é fornecida. Ela é usada da mesma forma que @ref{3ba1,,CGIHandler}, ou seja, chamando @code{IISCGIHandler().run(app)}, onde @code{app} é o objeto de aplicação WSGI que você deseja invocar.


Adicionado na versão 3.2.

@end deffn

@geindex BaseCGIHandler (classe em wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers BaseCGIHandler}@anchor{3ba2}
@deffn {Classe} wsgiref.handlers.BaseCGIHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

Similar to @ref{3ba1,,CGIHandler}, but instead of using the @ref{d9,,sys} and
@ref{a1,,os} modules, the CGI environment and I/O streams are specified explicitly.
The `multithread' and `multiprocess' values are used to set the
@code{wsgi.multithread} and @code{wsgi.multiprocess} flags for any applications run by
the handler instance.

This class is a subclass of @ref{3ba4,,SimpleHandler} intended for use with
software other than HTTP “origin servers”.  If you are writing a gateway
protocol implementation (such as CGI, FastCGI, SCGI, etc.) that uses a
@code{Status:} header to send an HTTP status, you probably want to subclass this
instead of @ref{3ba4,,SimpleHandler}.
@end deffn

@geindex SimpleHandler (classe em wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers SimpleHandler}@anchor{3ba4}
@deffn {Classe} wsgiref.handlers.SimpleHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

Similar to @ref{3ba2,,BaseCGIHandler}, but designed for use with HTTP origin
servers.  If you are writing an HTTP server implementation, you will probably
want to subclass this instead of @ref{3ba2,,BaseCGIHandler}.

This class is a subclass of @ref{1b67,,BaseHandler}.  It overrides the
@code{__init__()}, @ref{3ba5,,get_stdin()},
@ref{3ba6,,get_stderr()}, @ref{3ba7,,add_cgi_vars()},
@ref{3ba8,,_write()}, and @ref{3ba9,,_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.

The @ref{cfc,,write()} method of `stdout' should write
each chunk in full, like @ref{694,,io.BufferedIOBase}.
@end deffn

@geindex BaseHandler (classe em wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers BaseHandler}@anchor{1b67}
@deffn {Classe} wsgiref.handlers.BaseHandler

This is an abstract base class for running WSGI applications.  Each instance
will handle a single HTTP request, although in principle you could create a
subclass that was reusable for multiple requests.

@ref{1b67,,BaseHandler} instances have only one method intended for external use:

@geindex run() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler run}@anchor{3baa}
@deffn {Método} run (app)

Run the specified WSGI application, `app'.
@end deffn

All of the other @ref{1b67,,BaseHandler} methods are invoked by this method in the
process of running the application, and thus exist primarily to allow
customizing the process.

The following methods MUST be overridden in a subclass:

@geindex _write() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler _write}@anchor{3ba8}
@deffn {Método} _write (data)

Buffer the bytes `data' for transmission to the client.  It’s okay if this
method actually transmits the data; @ref{1b67,,BaseHandler} just separates write
and flush operations for greater efficiency when the underlying system actually
has such a distinction.
@end deffn

@geindex _flush() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler _flush}@anchor{3ba9}
@deffn {Método} _flush ()

Force buffered data to be transmitted to the client.  It’s okay if this method
is a no-op (i.e., if @ref{3ba8,,_write()} actually sends the data).
@end deffn

@geindex get_stdin() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stdin}@anchor{3ba5}
@deffn {Método} get_stdin ()

Return an object compatible with @ref{3bab,,InputStream}
suitable for use as the @code{wsgi.input} of the
request currently being processed.
@end deffn

@geindex get_stderr() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stderr}@anchor{3ba6}
@deffn {Método} get_stderr ()

Return an object compatible with @ref{3bac,,ErrorStream}
suitable for use as the @code{wsgi.errors} of the
request currently being processed.
@end deffn

@geindex add_cgi_vars() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler add_cgi_vars}@anchor{3ba7}
@deffn {Método} add_cgi_vars ()

Insert CGI variables for the current request into the @code{environ} attribute.
@end deffn

Here are some other methods and attributes you may wish to override. This list
is only a summary, however, and does not include every method that can be
overridden.  You should consult the docstrings and source code for additional
information before attempting to create a customized @ref{1b67,,BaseHandler}
subclass.

Attributes and methods for customizing the WSGI environment:

@geindex wsgi_multithread (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multithread}@anchor{3bad}
@deffn {Atributo} wsgi_multithread

The value to be used for the @code{wsgi.multithread} environment variable.  It
defaults to true in @ref{1b67,,BaseHandler}, but may have a different default (or
be set by the constructor) in the other subclasses.
@end deffn

@geindex wsgi_multiprocess (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multiprocess}@anchor{3bae}
@deffn {Atributo} wsgi_multiprocess

The value to be used for the @code{wsgi.multiprocess} environment variable.  It
defaults to true in @ref{1b67,,BaseHandler}, but may have a different default (or
be set by the constructor) in the other subclasses.
@end deffn

@geindex wsgi_run_once (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_run_once}@anchor{3baf}
@deffn {Atributo} wsgi_run_once

The value to be used for the @code{wsgi.run_once} environment variable.  It
defaults to false in @ref{1b67,,BaseHandler}, but @ref{3ba1,,CGIHandler} sets it to
true by default.
@end deffn

@geindex os_environ (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler os_environ}@anchor{3bb0}
@deffn {Atributo} os_environ

The default environment variables to be included in every request’s WSGI
environment.  By default, this is a copy of @code{os.environ} at the time that
@ref{119,,wsgiref.handlers} was imported, but subclasses can either create their own
at the class or instance level.  Note that the dictionary should be considered
read-only, since the default value is shared between multiple classes and
instances.
@end deffn

@geindex server_software (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler server_software}@anchor{3bb1}
@deffn {Atributo} server_software

If the @ref{3bb2,,origin_server} attribute is set, this attribute’s value is used to
set the default @code{SERVER_SOFTWARE} WSGI environment variable, and also to set a
default @code{Server:} header in HTTP responses.  It is ignored for handlers (such
as @ref{3ba2,,BaseCGIHandler} and @ref{3ba1,,CGIHandler}) that are not HTTP origin
servers.


Alterado na versão 3.3: O termo “Python” é substituído por termos específicos de implementação, como “CPython”, “Jython” etc.

@end deffn

@geindex get_scheme() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler get_scheme}@anchor{3bb3}
@deffn {Método} get_scheme ()

Return the URL scheme being used for the current request.  The default
implementation uses the @code{guess_scheme()} function from @ref{11d,,wsgiref.util}
to guess whether the scheme should be “http” or “https”, based on the current
request’s @code{environ} variables.
@end deffn

@geindex setup_environ() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler setup_environ}@anchor{3bb4}
@deffn {Método} setup_environ ()

Set the @code{environ} attribute to a fully populated WSGI environment.  The
default implementation uses all of the above methods and attributes, plus the
@ref{3ba5,,get_stdin()}, @ref{3ba6,,get_stderr()}, and @ref{3ba7,,add_cgi_vars()} methods and the
@ref{3bb5,,wsgi_file_wrapper} attribute.  It also inserts a @code{SERVER_SOFTWARE} key
if not present, as long as the @ref{3bb2,,origin_server} attribute is a true value
and the @ref{3bb1,,server_software} attribute is set.
@end deffn

Methods and attributes for customizing exception handling:

@geindex log_exception() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler log_exception}@anchor{3bb6}
@deffn {Método} log_exception (exc_info)

Log the `exc_info' tuple in the server log.  `exc_info' is a @code{(type, value,
traceback)} tuple.  The default implementation simply writes the traceback to
the request’s @code{wsgi.errors} stream and flushes it.  Subclasses can override
this method to change the format or retarget the output, mail the traceback to
an administrator, or whatever other action may be deemed suitable.
@end deffn

@geindex traceback_limit (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler traceback_limit}@anchor{3bb7}
@deffn {Atributo} traceback_limit

The maximum number of frames to include in tracebacks output by the default
@ref{3bb6,,log_exception()} method.  If @code{None}, all frames are included.
@end deffn

@geindex error_output() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_output}@anchor{3bb8}
@deffn {Método} error_output (environ, start_response)

This method is a WSGI application to generate an error page for the user.  It is
only invoked if an error occurs before headers are sent to the client.

This method can access the current error using @code{sys.exception()},
and should pass that information to `start_response' when calling it (as
described in the “Error Handling” section of 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}). In particular,
the `start_response' callable should follow the @ref{3b95,,StartResponse}
protocol.

The default implementation just uses the @ref{3bb9,,error_status},
@ref{3bba,,error_headers}, and @ref{3bbb,,error_body} attributes to generate an output
page.  Subclasses can override this to produce more dynamic error output.

Note, however, that it’s not recommended from a security perspective to spit out
diagnostics to any old user; ideally, you should have to do something special to
enable diagnostic output, which is why the default implementation doesn’t
include any.
@end deffn

@geindex error_status (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_status}@anchor{3bb9}
@deffn {Atributo} error_status

The HTTP status used for error responses.  This should be a status string as
defined in 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}; it defaults to a 500 code and message.
@end deffn

@geindex error_headers (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_headers}@anchor{3bba}
@deffn {Atributo} error_headers

The HTTP headers used for error responses.  This should be a list of WSGI
response headers (@code{(name, value)} tuples), as described in 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.  The
default list just sets the content type to @code{text/plain}.
@end deffn

@geindex error_body (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler error_body}@anchor{3bbb}
@deffn {Atributo} error_body

The error response body.  This should be an HTTP response body bytestring. It
defaults to the plain text, “A server error occurred.  Please contact the
administrator.”
@end deffn

Methods and attributes for 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}’s “Optional Platform-Specific File
Handling” feature:

@geindex wsgi_file_wrapper (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_file_wrapper}@anchor{3bb5}
@deffn {Atributo} wsgi_file_wrapper

A @code{wsgi.file_wrapper} factory, compatible with
@ref{3b8f,,wsgiref.types.FileWrapper}, or @code{None}.  The default value
of this attribute is the @ref{736,,wsgiref.util.FileWrapper} class.
@end deffn

@geindex sendfile() (método wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler sendfile}@anchor{3bbc}
@deffn {Método} sendfile ()

Override to implement platform-specific file transmission.  This method is
called only if the application’s return value is an instance of the class
specified by the @ref{3bb5,,wsgi_file_wrapper} attribute.  It should return a true
value if it was able to successfully transmit the file, so that the default
transmission code will not be executed. The default implementation of this
method just returns a false value.
@end deffn

Miscellaneous methods and attributes:

@geindex origin_server (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler origin_server}@anchor{3bb2}
@deffn {Atributo} origin_server

This attribute should be set to a true value if the handler’s @ref{3ba8,,_write()} and
@ref{3ba9,,_flush()} are being used to communicate directly to the client, rather than
via a CGI-like gateway protocol that wants the HTTP status in a special
@code{Status:} header.

This attribute’s default value is true in @ref{1b67,,BaseHandler}, but false in
@ref{3ba2,,BaseCGIHandler} and @ref{3ba1,,CGIHandler}.
@end deffn

@geindex http_version (atributo wsgiref.handlers.BaseHandler)
@anchor{library/wsgiref wsgiref handlers BaseHandler http_version}@anchor{3bbd}
@deffn {Atributo} http_version

If @ref{3bb2,,origin_server} is true, this string attribute is used to set the HTTP
version of the response set to the client.  It defaults to @code{"1.0"}.
@end deffn
@end deffn

@geindex read_environ() (no módulo wsgiref.handlers)
@anchor{library/wsgiref wsgiref handlers read_environ}@anchor{11f8}
@deffn {Função} wsgiref.handlers.read_environ ()

Transcode CGI variables from @code{os.environ} to 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} “bytes in unicode”
strings, returning a new dictionary.  This function is used by
@ref{3ba1,,CGIHandler} and @ref{3ba3,,IISCGIHandler} in place of directly using
@code{os.environ}, which is not necessarily WSGI-compliant on all platforms
and web servers using Python 3 – specifically, ones where the OS’s
actual environment is Unicode (i.e. Windows), or ones where the environment
is bytes, but the system encoding used by Python to decode it is anything
other than ISO-8859-1 (e.g. Unix systems using UTF-8).

If you are implementing a CGI-based handler of your own, you probably want
to use this routine instead of just copying values out of @code{os.environ}
directly.


Adicionado na versão 3.2.

@end deffn

@node wsgiref types – WSGI types for static type checking,Exemplos<25>,wsgiref handlers – classes base de servidor/gateway,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref module-wsgiref types}@anchor{11c}@anchor{library/wsgiref wsgiref-types-wsgi-types-for-static-type-checking}@anchor{3bbe}
@subsubsection @code{wsgiref.types} – WSGI types for static type checking


@geindex module; wsgiref.types

This module provides various types for static type checking as described
in 
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}.


Adicionado na versão 3.11.


@geindex StartResponse (classe em wsgiref.types)
@anchor{library/wsgiref wsgiref types StartResponse}@anchor{3b95}
@deffn {Classe} wsgiref.types.StartResponse

A @ref{264,,typing.Protocol} describing 
@geindex Propostas de Melhorias do Python; PEP 3333#the-start-response-callable
start_response()@footnote{https://peps.python.org/pep-3333/#the-start-response-callable}
callables (
@geindex Propostas de Melhorias do Python; PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}).
@end deffn

@geindex WSGIEnvironment (no módulo wsgiref.types)
@anchor{library/wsgiref wsgiref types WSGIEnvironment}@anchor{3b88}
@deffn {Dado} wsgiref.types.WSGIEnvironment

A type alias describing a WSGI environment dictionary.
@end deffn

@geindex WSGIApplication (no módulo wsgiref.types)
@anchor{library/wsgiref wsgiref types WSGIApplication}@anchor{3bbf}
@deffn {Dado} wsgiref.types.WSGIApplication

A type alias describing a WSGI application callable.
@end deffn

@geindex InputStream (classe em wsgiref.types)
@anchor{library/wsgiref wsgiref types InputStream}@anchor{3bab}
@deffn {Classe} wsgiref.types.InputStream

A @ref{264,,typing.Protocol} describing a 
@geindex Propostas de Melhorias do Python; PEP 3333#input-and-error-streams
WSGI Input Stream@footnote{https://peps.python.org/pep-3333/#input-and-error-streams}.
@end deffn

@geindex ErrorStream (classe em wsgiref.types)
@anchor{library/wsgiref wsgiref types ErrorStream}@anchor{3bac}
@deffn {Classe} wsgiref.types.ErrorStream

A @ref{264,,typing.Protocol} describing a 
@geindex Propostas de Melhorias do Python; PEP 3333#input-and-error-streams
WSGI Error Stream@footnote{https://peps.python.org/pep-3333/#input-and-error-streams}.
@end deffn

@geindex FileWrapper (classe em wsgiref.types)
@anchor{library/wsgiref wsgiref types FileWrapper}@anchor{3b8f}
@deffn {Classe} wsgiref.types.FileWrapper

A @ref{264,,typing.Protocol} describing a 
@geindex Propostas de Melhorias do Python; PEP 3333#optional-platform-specific-file-handling
file wrapper@footnote{https://peps.python.org/pep-3333/#optional-platform-specific-file-handling}.
See @ref{736,,wsgiref.util.FileWrapper} for a concrete implementation of this
protocol.
@end deffn

@node Exemplos<25>,,wsgiref types – WSGI types for static type checking,wsgiref — Implementação de referência e utilitários WSGI
@anchor{library/wsgiref examples}@anchor{3bc0}
@subsubsection Exemplos


This is a working “Hello World” WSGI application, where the `start_response'
callable should follow the @ref{3b95,,StartResponse} protocol:

@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

Example of a WSGI application serving the current directory, accept optional
directory and port number (default: 8000) on the command line:

@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 — Módulos de manipulação de URL,urllib request — Biblioteca extensível para abrir URLs,wsgiref — Implementação de referência e utilitários WSGI,Protocolos de Internet e Suporte
@anchor{library/urllib doc}@anchor{3bc1}@anchor{library/urllib module-urllib}@anchor{108}@anchor{library/urllib translation-repo}@anchor{3bc2}@anchor{library/urllib urllib-url-handling-modules}@anchor{3bc3}
@subsection @code{urllib} — Módulos de manipulação de URL


@geindex module; urllib

`Código-fonte:' Lib/urllib/@footnote{https://github.com/python/cpython/tree/3.13/Lib/urllib/}


__________________________________________________________________


@code{urllib} é um pacote que coleciona vários módulos para trabalhar com URLs:


@itemize *

@item 
@ref{10b,,urllib.request} para abrir e ler URLs

@item 
@ref{109,,urllib.error} contendo as exceções levantadas por @ref{10b,,urllib.request}

@item 
@ref{10a,,urllib.parse} para analisar URLs

@item 
@ref{10d,,urllib.robotparser} para analisar arquivos @code{robots.txt}
@end itemize

@node urllib request — Biblioteca extensível para abrir URLs,urllib response — Response classes used by urllib,urllib — Módulos de manipulação de URL,Protocolos de Internet e Suporte
@anchor{library/urllib request doc}@anchor{3bc4}@anchor{library/urllib request module-urllib request}@anchor{10b}@anchor{library/urllib request translation-repo}@anchor{3bc5}@anchor{library/urllib request urllib-request-extensible-library-for-opening-urls}@anchor{3bc6}
@subsection @code{urllib.request} — Biblioteca extensível para abrir URLs


@geindex module; urllib.request

`Código-fonte:' Lib/urllib/request.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/urllib/request.py}


__________________________________________________________________


O módulo @ref{10b,,urllib.request} define funções e classes que ajudam a abrir URLs (principalmente HTTP) em um mundo complexo — autenticação básica ou por digest, redirecionamentos, cookies e muito mais.


@subsubheading Ver também


O pacote Requests@footnote{https://requests.readthedocs.io/en/master/} é recomendado para uma interface alto nível de cliente HTTP.


@cartouche
@quotation Aviso 
No macOS, não é seguro usar este módulo em programas que utilizam @ref{197,,os.fork()} porque a implementação @ref{3bc7,,getproxies()} para macOS utiliza uma API de sistema de nível mais alto. Defina a variável de ambiente @code{no_proxy} como @code{*} para evitar esse problema (por exemplo, @code{os.environ["no_proxy"] = "*"}).
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

O módulo @ref{10b,,urllib.request} define as seguintes funções:

@geindex urlopen() (no módulo urllib.request)
@anchor{library/urllib request urllib request urlopen}@anchor{293}
@deffn {Função} urllib.request.urlopen (url, data=None[, timeout], *, context=None)

Abre `url', que pode ser uma string contendo uma URL válida e devidamente codificada, ou um objeto @ref{100e,,Request}.

`data' deve ser um objeto que especifique dados adicionais a serem enviados ao servidor ou @code{None}, se nenhum dado for necessário. Veja @ref{100e,,Request} para detalhes.

O módulo urllib.request usa HTTP/1.1 e inclui o cabeçalho @code{Connection:close} em suas solicitações HTTP.

O parâmetro opcional `timeout' especifica um tempo limite em segundos para bloquear operações como a tentativa de conexão (se não for especificado, a configuração de tempo limite padrão global será usada). Na verdade, isso só funciona para conexões HTTP, HTTPS e FTP.

Se `context' for especificado, deve ser uma instância de @ref{294,,ssl.SSLContext} descrevendo as várias opções SSL. Veja  @ref{b54,,HTTPSConnection} para mais detalhes.

Esta função sempre retorna um objeto que pode funcionar como um @ref{5d4,,gerenciador de contexto} e tem as propriedades `url', `headers' e `status'. Veja @ref{3bc8,,urllib.response.addinfourl} para mais detalhes sobre essas propriedades.

Para URLs HTTP e HTTPS, esta função retorna um objeto @ref{110d,,http.client.HTTPResponse} ligeiramente modificado. Além dos três novos métodos acima, o atributo msg contém as mesmas informações que o atributo @ref{3bc9,,reason} — a frase de razão retornada pelo servidor — em vez dos cabeçalhos de resposta como é especificado na documentação para @ref{110d,,HTTPResponse}.

Para FTP, arquivo e URLs de dados e solicitações explicitamente tratadas pelas classes legadas @ref{30e,,URLopener} e @ref{30f,,FancyURLopener}, esta função retorna um objeto @ref{3bc8,,urllib.response.addinfourl}.

Levanta @ref{3bca,,URLError} quando ocorrer erros de protocolo.

Observe que @code{None} pode ser retornado se nenhum manipulador lidar com a solicitação (embora a @ref{3bcb,,OpenerDirector} global instalada padrão use @ref{3bcc,,UnknownHandler} para garantir que isso nunca aconteça).

Além disso, se as configurações de proxy forem detectadas (por exemplo, quando uma variável de ambiente @code{*_proxy} como @code{http_proxy} é definida), @ref{1b47,,ProxyHandler} é instalado por padrão e garante que as solicitações sejam manipuladas pelo proxy.

A função legada @code{urllib.urlopen} do Python 2.6 e anteriores foi descontinuada; @ref{293,,urllib.request.urlopen()} corresponde à antiga @code{urllib2.urlopen}. O tratamento de proxy, que foi feito passando um parâmetro de dicionário para @code{urllib.urlopen}, pode ser obtido usando objetos @ref{1b47,,ProxyHandler}.

O abridor padrão levanta um @ref{19fa,,evento de auditoria} @code{urllib.Request} com os argumentos @code{fullurl}, @code{data}, @code{headers}, @code{method} obtidos do objeto de requisição.


Alterado na versão 3.2: `cafile' e `capath' foram adicionados.

Hosts virtuais HTTPS agora são suportados, se possível (ou seja, se @ref{3688,,ssl.HAS_SNI} for verdadeiro).

`data' pode ser um objeto iterável.



Alterado na versão 3.3: `cadefault' foi adicionado.



Alterado na versão 3.4.3: `context' foi adicionado.



Alterado na versão 3.10: A conexão HTTPS agora envia uma extensão ALPN com o indicador de protocolo @code{http/1.1} quando nenhum `context' é fornecido. `context' personalizado deve definir protocolos ALPN com @ref{e93,,set_alpn_protocols()}.



Alterado na versão 3.13: Remove os parâmetros `cafile', `capath' e `cadefault': use o parâmetro `context' em seu lugar.

@end deffn

@geindex install_opener() (no módulo urllib.request)
@anchor{library/urllib request urllib request install_opener}@anchor{3bcd}
@deffn {Função} urllib.request.install_opener (opener)

Instala uma instância de @ref{3bcb,,OpenerDirector} como o abridor global padrão. A instalação de um abridor só é necessária se você quiser que o urlopen o utilize; caso contrário, basta chamar @ref{1012,,OpenerDirector.open()} em vez de @ref{293,,urlopen()}. O código não verifica se há um @ref{3bcb,,OpenerDirector} real, e qualquer classe com a interface apropriada funcionará.
@end deffn

@geindex build_opener() (no módulo urllib.request)
@anchor{library/urllib request urllib request build_opener}@anchor{3bce}
@deffn {Função} urllib.request.build_opener ([handler, ...])

Return an @ref{3bcb,,OpenerDirector} instance, which chains the handlers in the
order given. `handler's can be either instances of @ref{3bcf,,BaseHandler}, or
subclasses of @ref{3bcf,,BaseHandler} (in which case it must be possible to call
the constructor without any parameters).  Instances of the following classes
will be in front of the `handler's, unless the `handler's contain them,
instances of them or subclasses of them: @ref{1b47,,ProxyHandler} (if proxy
settings are detected), @ref{3bcc,,UnknownHandler}, @ref{d1d,,HTTPHandler},
@ref{3bd0,,HTTPDefaultErrorHandler}, @ref{3bd1,,HTTPRedirectHandler},
@ref{3bd2,,FTPHandler}, @ref{3bd3,,FileHandler}, @ref{3bd4,,HTTPErrorProcessor}.

If the Python installation has SSL support (i.e., if the @ref{d0,,ssl} module
can be imported), @ref{1264,,HTTPSHandler} will also be added.

A @ref{3bcf,,BaseHandler} subclass may also change its @code{handler_order}
attribute to modify its position in the handlers list.
@end deffn

@geindex pathname2url() (no módulo urllib.request)
@anchor{library/urllib request urllib request pathname2url}@anchor{167c}
@deffn {Função} urllib.request.pathname2url (path)

Convert the given local path to a @code{file:} URL. This function uses
@ref{bbb,,quote()} function to encode the path. For historical
reasons, the return value omits the @code{file:} scheme prefix. This example
shows the function being used on Windows:

@example
>>> from urllib.request import pathname2url
>>> path = 'C:\\Program Files'
>>> 'file:' + pathname2url(path)
'file:///C:/Program%20Files'
@end example
@end deffn

@geindex url2pathname() (no módulo urllib.request)
@anchor{library/urllib request urllib request url2pathname}@anchor{167d}
@deffn {Função} urllib.request.url2pathname (url)

Convert the given @code{file:} URL to a local path. This function uses
@ref{1883,,unquote()} to decode the URL. For historical reasons,
the given value `must' omit the @code{file:} scheme prefix. This example shows
the function being used on Windows:

@example
>>> from urllib.request import url2pathname
>>> url = 'file:///C:/Program%20Files'
>>> url2pathname(url.removeprefix('file:'))
'C:\\Program Files'
@end example
@end deffn

@geindex getproxies() (no módulo urllib.request)
@anchor{library/urllib request urllib request getproxies}@anchor{3bc7}
@deffn {Função} urllib.request.getproxies ()

This helper function returns a dictionary of scheme to proxy server URL
mappings. It scans the environment for variables named @code{<scheme>_proxy},
in a case insensitive approach, for all operating systems first, and when it
cannot find it, looks for proxy information from System
Configuration for macOS and Windows Systems Registry for Windows.
If both lowercase and uppercase environment variables exist (and disagree),
lowercase is preferred.

@cartouche
@quotation Nota 
If the environment variable @code{REQUEST_METHOD} is set, which usually
indicates your script is running in a CGI environment, the environment
variable @code{HTTP_PROXY} (uppercase @code{_PROXY}) will be ignored. This is
because that variable can be injected by a client using the “Proxy:” HTTP
header. If you need to use an HTTP proxy in a CGI environment, either use
@code{ProxyHandler} explicitly, or make sure the variable name is in
lowercase (or at least the @code{_proxy} suffix).
@end quotation
@end cartouche
@end deffn

As seguintes classes são disponibilizadas:

@geindex Request (classe em urllib.request)
@anchor{library/urllib request urllib request Request}@anchor{100e}
@deffn {Classe} urllib.request.Request (url, data=None, headers=@{@}, origin_req_host=None, unverifiable=False, method=None)

This class is an abstraction of a URL request.

`url' should be a string containing a valid, properly encoded URL.

`data' must be an object specifying additional data to send to the
server, or @code{None} if no such data is needed.  Currently HTTP
requests are the only ones that use `data'.  The supported object
types include bytes, file-like objects, and iterables of bytes-like objects.
If no @code{Content-Length} nor @code{Transfer-Encoding} header field
has been provided, @ref{d1d,,HTTPHandler} will set these headers according
to the type of `data'.  @code{Content-Length} will be used to send
bytes objects, while @code{Transfer-Encoding: chunked} as specified in
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html}, Section 3.3.1 will be used to send files and other iterables.

For an HTTP POST request method, `data' should be a buffer in the
standard @code{application/x-www-form-urlencoded} format.  The
@ref{ec4,,urllib.parse.urlencode()} function takes a mapping or sequence
of 2-tuples and returns an ASCII string in this format. It should
be encoded to bytes before being used as the `data' parameter.

`headers' should be a dictionary, and will be treated as if
@ref{3bd5,,add_header()} was called with each key and value as arguments.
This is often used to “spoof” the @code{User-Agent} header value, which is
used by a browser to identify itself – some HTTP servers only
allow requests coming from common browsers as opposed to scripts.
For example, Mozilla Firefox may identify itself as @code{"Mozilla/5.0
(X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"}, while
@ref{108,,urllib}’s default user agent string is
@code{"Python-urllib/2.6"} (on Python 2.6).
All header keys are sent in 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.

The next two arguments are only of interest for correct handling
of third-party HTTP cookies:

`origin_req_host' should be the request-host of the origin
transaction, as defined by 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.  It defaults to
@code{http.cookiejar.request_host(self)}.  This is the host name or IP
address of the original request that was initiated by the user.
For example, if the request is for an image in an HTML document,
this should be the request-host of the request for the page
containing the image.

`unverifiable' should indicate whether the request is unverifiable,
as defined by 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.  It defaults to @code{False}.  An unverifiable
request is one whose URL the user did not have the option to
approve.  For example, if the request is for an image in an HTML
document, and the user had no option to approve the automatic
fetching of the image, this should be true.

`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{100f,,method} attribute and is used by @ref{11a8,,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{100f,,method} attribute in the class itself.

@cartouche
@quotation Nota 
The request will not work as expected if the data object is unable
to deliver its content more than once (e.g. a file or an iterable
that can produce the content only once) and the request is retried
for HTTP redirects or authentication.  The `data' is sent to the
HTTP server right away after the headers.  There is no support for
a 100-continue expectation in the library.
@end quotation
@end cartouche


Alterado na versão 3.3: @ref{100f,,Request.method} argument is added to the Request class.



Alterado na versão 3.4: Default @ref{100f,,Request.method} may be indicated at the class level.



Alterado na versão 3.6: Do not raise an error if the @code{Content-Length} has not been
provided and `data' is neither @code{None} nor a bytes object.
Fall back to use chunked transfer encoding instead.

@end deffn

@geindex OpenerDirector (classe em urllib.request)
@anchor{library/urllib request urllib request OpenerDirector}@anchor{3bcb}
@deffn {Classe} urllib.request.OpenerDirector

The @ref{3bcb,,OpenerDirector} class opens URLs via @ref{3bcf,,BaseHandler}s chained
together. It manages the chaining of handlers, and recovery from errors.
@end deffn

@geindex BaseHandler (classe em urllib.request)
@anchor{library/urllib request urllib request BaseHandler}@anchor{3bcf}
@deffn {Classe} urllib.request.BaseHandler

This is the base class for all registered handlers — and handles only the
simple mechanics of registration.
@end deffn

@geindex HTTPDefaultErrorHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPDefaultErrorHandler}@anchor{3bd0}
@deffn {Classe} urllib.request.HTTPDefaultErrorHandler

A class which defines a default handler for HTTP error responses; all responses
are turned into @ref{1014,,HTTPError} exceptions.
@end deffn

@geindex HTTPRedirectHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPRedirectHandler}@anchor{3bd1}
@deffn {Classe} urllib.request.HTTPRedirectHandler

Uma classe para lidar com redirecionamentos.
@end deffn

@geindex HTTPCookieProcessor (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPCookieProcessor}@anchor{3bd6}
@deffn {Classe} urllib.request.HTTPCookieProcessor (cookiejar=None)

Classe para lidar com Cookies HTTP.
@end deffn

@geindex ProxyHandler (classe em urllib.request)
@anchor{library/urllib request urllib request ProxyHandler}@anchor{1b47}
@deffn {Classe} urllib.request.ProxyHandler (proxies=None)

Cause requests to go through a proxy. If `proxies' is given, it must be a
dictionary mapping protocol names to URLs of proxies. The default is to read
the list of proxies from the environment variables
@code{<protocol>_proxy}.  If no proxy environment variables are set, then
in a Windows environment proxy settings are obtained from the registry’s
Internet Settings section, and in a macOS environment proxy information
is retrieved from the System Configuration Framework.

To disable autodetected proxy pass an empty dictionary.

The 
@geindex no_proxy
@geindex variável de ambiente; no_proxy
@code{no_proxy} environment variable can be used to specify hosts
which shouldn’t be reached via proxy; if set, it should be a comma-separated
list of hostname suffixes, optionally with @code{:port} appended, for example
@code{cern.ch,ncsa.uiuc.edu,some.host:8080}.

@cartouche
@quotation Nota 
@code{HTTP_PROXY} será ignorado se uma variável @code{REQUEST_METHOD} estiver definida; veja a documentação em @ref{3bc7,,getproxies()}.
@end quotation
@end cartouche
@end deffn

@geindex HTTPPasswordMgr (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgr}@anchor{3bd7}
@deffn {Classe} urllib.request.HTTPPasswordMgr

Keep a database of  @code{(realm, uri) -> (user, password)} mappings.
@end deffn

@geindex HTTPPasswordMgrWithDefaultRealm (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithDefaultRealm}@anchor{3bd8}
@deffn {Classe} urllib.request.HTTPPasswordMgrWithDefaultRealm

Keep a database of  @code{(realm, uri) -> (user, password)} mappings. A realm of
@code{None} is considered a catch-all realm, which is searched if no other realm
fits.
@end deffn

@geindex HTTPPasswordMgrWithPriorAuth (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth}@anchor{ec3}
@deffn {Classe} urllib.request.HTTPPasswordMgrWithPriorAuth

A variant of @ref{3bd8,,HTTPPasswordMgrWithDefaultRealm} that also has a
database of @code{uri -> is_authenticated} mappings.  Can be used by a
BasicAuth handler to determine when to send authentication credentials
immediately instead of waiting for a @code{401} response first.


Adicionado na versão 3.5.

@end deffn

@geindex AbstractBasicAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request AbstractBasicAuthHandler}@anchor{19fb}
@deffn {Classe} urllib.request.AbstractBasicAuthHandler (password_mgr=None)

This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. `password_mgr', if given, should be something that is
compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to section
@ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must be
supported.  If `passwd_mgr' also provides @code{is_authenticated} and
@code{update_authenticated} methods (see
@ref{3bda,,HTTPPasswordMgrWithPriorAuth Objects}), then the handler will use the
@code{is_authenticated} result for a given URI to determine whether or not to
send authentication credentials with the request.  If @code{is_authenticated}
returns @code{True} for the URI, credentials are sent.  If @code{is_authenticated}
is @code{False}, credentials are not sent, and then if a @code{401} response is
received the request is re-sent with the authentication credentials.  If
authentication succeeds, @code{update_authenticated} is called to set
@code{is_authenticated} @code{True} for the URI, so that subsequent requests to
the URI or any of its super-URIs will automatically include the
authentication credentials.


Adicionado na versão 3.5: Added @code{is_authenticated} support.

@end deffn

@geindex HTTPBasicAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPBasicAuthHandler}@anchor{3bdb}
@deffn {Classe} urllib.request.HTTPBasicAuthHandler (password_mgr=None)

Handle authentication with the remote host. `password_mgr', if given, should
be something that is compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to
section @ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must
be supported. HTTPBasicAuthHandler will raise a @ref{202,,ValueError} when
presented with a wrong Authentication scheme.
@end deffn

@geindex ProxyBasicAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request ProxyBasicAuthHandler}@anchor{3bdc}
@deffn {Classe} urllib.request.ProxyBasicAuthHandler (password_mgr=None)

Handle authentication with the proxy. `password_mgr', if given, should be
something that is compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to section
@ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must be
supported.
@end deffn

@geindex AbstractDigestAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request AbstractDigestAuthHandler}@anchor{1afa}
@deffn {Classe} urllib.request.AbstractDigestAuthHandler (password_mgr=None)

This is a mixin class that helps with HTTP authentication, both to the remote
host and to a proxy. `password_mgr', if given, should be something that is
compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to section
@ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must be
supported.
@end deffn

@geindex HTTPDigestAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPDigestAuthHandler}@anchor{3bdd}
@deffn {Classe} urllib.request.HTTPDigestAuthHandler (password_mgr=None)

Handle authentication with the remote host. `password_mgr', if given, should
be something that is compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to
section @ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must
be supported. When both Digest Authentication Handler and Basic
Authentication Handler are both added, Digest Authentication is always tried
first. If the Digest Authentication returns a 40x response again, it is sent
to Basic Authentication handler to Handle.  This Handler method will raise a
@ref{202,,ValueError} when presented with an authentication scheme other than
Digest or Basic.


Alterado na versão 3.3: Raise @ref{202,,ValueError} on unsupported Authentication Scheme.

@end deffn

@geindex ProxyDigestAuthHandler (classe em urllib.request)
@anchor{library/urllib request urllib request ProxyDigestAuthHandler}@anchor{3bde}
@deffn {Classe} urllib.request.ProxyDigestAuthHandler (password_mgr=None)

Handle authentication with the proxy. `password_mgr', if given, should be
something that is compatible with @ref{3bd7,,HTTPPasswordMgr}; refer to section
@ref{3bd9,,HTTPPasswordMgr Objects} for information on the interface that must be
supported.
@end deffn

@geindex HTTPHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPHandler}@anchor{d1d}
@deffn {Classe} urllib.request.HTTPHandler

A class to handle opening of HTTP URLs.
@end deffn

@geindex HTTPSHandler (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPSHandler}@anchor{1264}
@deffn {Classe} urllib.request.HTTPSHandler (debuglevel=0, context=None, check_hostname=None)

A class to handle opening of HTTPS URLs.  `context' and `check_hostname'
have the same meaning as in @ref{b54,,http.client.HTTPSConnection}.


Alterado na versão 3.2: `context' and `check_hostname' were added.

@end deffn

@geindex FileHandler (classe em urllib.request)
@anchor{library/urllib request urllib request FileHandler}@anchor{3bd3}
@deffn {Classe} urllib.request.FileHandler

Abre arquivos locais.
@end deffn

@geindex DataHandler (classe em urllib.request)
@anchor{library/urllib request urllib request DataHandler}@anchor{100d}
@deffn {Classe} urllib.request.DataHandler

Abre dados das URLs.


Adicionado na versão 3.4.

@end deffn

@geindex FTPHandler (classe em urllib.request)
@anchor{library/urllib request urllib request FTPHandler}@anchor{3bd2}
@deffn {Classe} urllib.request.FTPHandler

Abre URLs de FTP.
@end deffn

@geindex CacheFTPHandler (classe em urllib.request)
@anchor{library/urllib request urllib request CacheFTPHandler}@anchor{181d}
@deffn {Classe} urllib.request.CacheFTPHandler

Open FTP URLs, keeping a cache of open FTP connections to minimize delays.
@end deffn

@geindex UnknownHandler (classe em urllib.request)
@anchor{library/urllib request urllib request UnknownHandler}@anchor{3bcc}
@deffn {Classe} urllib.request.UnknownHandler

A catch-all class to handle unknown URLs.
@end deffn

@geindex HTTPErrorProcessor (classe em urllib.request)
@anchor{library/urllib request urllib request HTTPErrorProcessor}@anchor{3bd4}
@deffn {Classe} urllib.request.HTTPErrorProcessor

Process HTTP error responses.
@end deffn

@menu
* Objeto Request:: 
* OpenerDirector Objects:: 
* BaseHandler Objects:: 
* HTTPRedirectHandler Objects:: 
* HTTPCookieProcessor Objects:: 
* ProxyHandler Objects:: 
* HTTPPasswordMgr Objects:: 
* HTTPPasswordMgrWithPriorAuth Objects:: 
* AbstractBasicAuthHandler Objects:: 
* HTTPBasicAuthHandler Objects:: 
* ProxyBasicAuthHandler Objects:: 
* AbstractDigestAuthHandler Objects:: 
* HTTPDigestAuthHandler Objects:: 
* ProxyDigestAuthHandler Objects:: 
* HTTPHandler Objects:: 
* Objetos HTTPSHandler:: 
* FileHandler Objects:: 
* DataHandler Objects:: 
* FTPHandler Objects:: 
* CacheFTPHandler Objects:: 
* Objetos UnknownHandler:: 
* HTTPErrorProcessor Objects:: 
* Exemplos: Exemplos<26>. 
* Legacy interface:: 
* urllib.request Restrictions: urllib request Restrictions. 

@end menu

@node Objeto Request,OpenerDirector Objects,,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request id1}@anchor{3bdf}@anchor{library/urllib request request-objects}@anchor{3be0}
@subsubsection Objeto Request


The following methods describe @ref{100e,,Request}’s public interface,
and so all may be overridden in subclasses.  It also defines several
public attributes that can be used by clients to inspect the parsed
request.

@geindex full_url (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request full_url}@anchor{1010}
@deffn {Atributo} Request.full_url

The original URL passed to the constructor.


Alterado na versão 3.4.


Request.full_url is a property with setter, getter and a deleter. Getting
@ref{1010,,full_url} returns the original request URL with the
fragment, if it was present.
@end deffn

@geindex type (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request type}@anchor{3be1}
@deffn {Atributo} Request.type

The URI scheme.
@end deffn

@geindex host (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request host}@anchor{3be2}
@deffn {Atributo} Request.host

The URI authority, typically a host, but may also contain a port
separated by a colon.
@end deffn

@geindex origin_req_host (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request origin_req_host}@anchor{3be3}
@deffn {Atributo} Request.origin_req_host

The original host for the request, without port.
@end deffn

@geindex selector (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request selector}@anchor{3be4}
@deffn {Atributo} Request.selector

The URI path.  If the @ref{100e,,Request} uses a proxy, then selector
will be the full URL that is passed to the proxy.
@end deffn

@geindex data (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request data}@anchor{1011}
@deffn {Atributo} Request.data

The entity body for the request, or @code{None} if not specified.


Alterado na versão 3.4: Changing value of @ref{1011,,Request.data} now deletes “Content-Length”
header if it was previously set or calculated.

@end deffn

@geindex unverifiable (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request unverifiable}@anchor{3be5}
@deffn {Atributo} Request.unverifiable

boolean, indicates whether the request is unverifiable as defined
by 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}.
@end deffn

@geindex method (atributo urllib.request.Request)
@anchor{library/urllib request urllib request Request method}@anchor{100f}
@deffn {Atributo} Request.method

The HTTP request method to use.  By default its value is @ref{675,,None},
which means that @ref{11a8,,get_method()} will do its normal computation
of the method to be used.  Its value can be set (thus overriding the default
computation in @ref{11a8,,get_method()}) either by providing a default
value by setting it at the class level in a @ref{100e,,Request} subclass, or by
passing a value in to the @ref{100e,,Request} constructor via the `method'
argument.


Adicionado na versão 3.3.



Alterado na versão 3.4: A default value can now be set in subclasses; previously it could only
be set via the constructor argument.

@end deffn

@geindex get_method() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request get_method}@anchor{11a8}
@deffn {Método} Request.get_method ()

Return a string indicating the HTTP request method.  If
@ref{100f,,Request.method} is not @code{None}, return its value, otherwise return
@code{'GET'} if @ref{1011,,Request.data} is @code{None}, or @code{'POST'} if it’s not.
This is only meaningful for HTTP requests.


Alterado na versão 3.3: get_method now looks at the value of @ref{100f,,Request.method}.

@end deffn

@geindex add_header() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request add_header}@anchor{3bd5}
@deffn {Método} Request.add_header (key, val)

Add another header to the request.  Headers are currently ignored by all
handlers except HTTP handlers, where they are added to the list of headers sent
to the server.  Note that there cannot be more than one header with the same
name, and later calls will overwrite previous calls in case the `key' collides.
Currently, this is no loss of HTTP functionality, since all headers which have
meaning when used more than once have a (header-specific) way of gaining the
same functionality using only one header.  Note that headers added using
this method are also added to redirected requests.
@end deffn

@geindex add_unredirected_header() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request add_unredirected_header}@anchor{3be6}
@deffn {Método} Request.add_unredirected_header (key, header)

Add a header that will not be added to a redirected request.
@end deffn

@geindex has_header() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request has_header}@anchor{3be7}
@deffn {Método} Request.has_header (header)

Return whether the instance has the named header (checks both regular and
unredirected).
@end deffn

@geindex remove_header() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request remove_header}@anchor{1013}
@deffn {Método} Request.remove_header (header)

Remove o cabeçalho nomeado da instância de solicitação (tanto de cabeçalhos regulares como de cabeçalhos não-redirecionados).


Adicionado na versão 3.4.

@end deffn

@geindex get_full_url() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request get_full_url}@anchor{3be8}
@deffn {Método} Request.get_full_url ()

Return the URL given in the constructor.


Alterado na versão 3.4.


Returns @ref{1010,,Request.full_url}
@end deffn

@geindex set_proxy() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request set_proxy}@anchor{3be9}
@deffn {Método} Request.set_proxy (host, type)

Prepare the request by connecting to a proxy server. The `host' and `type' will
replace those of the instance, and the instance’s selector will be the original
URL given in the constructor.
@end deffn

@geindex get_header() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request get_header}@anchor{3bea}
@deffn {Método} Request.get_header (header_name, default=None)

Return the value of the given header. If the header is not present, return
the default value.
@end deffn

@geindex header_items() (método urllib.request.Request)
@anchor{library/urllib request urllib request Request header_items}@anchor{3beb}
@deffn {Método} Request.header_items ()

Return a list of tuples (header_name, header_value) of the Request headers.
@end deffn


Alterado na versão 3.4: The request methods add_data, has_data, get_data, get_type, get_host,
get_selector, get_origin_req_host and is_unverifiable that were deprecated
since 3.3 have been removed.


@node OpenerDirector Objects,BaseHandler Objects,Objeto Request,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request opener-director-objects}@anchor{3bec}@anchor{library/urllib request openerdirector-objects}@anchor{3bed}
@subsubsection OpenerDirector Objects


@ref{3bcb,,OpenerDirector} instances have the following methods:

@geindex add_handler() (método urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector add_handler}@anchor{3bee}
@deffn {Método} OpenerDirector.add_handler (handler)

`handler' should be an instance of @ref{3bcf,,BaseHandler}.  The following methods
are searched, and added to the possible chains (note that HTTP errors are a
special case).  Note that, in the following, `protocol' should be replaced
with the actual protocol to handle, for example @code{http_response()} would
be the HTTP protocol response handler.  Also `type' should be replaced with
the actual HTTP code, for example @code{http_error_404()} would handle HTTP
404 errors.


@itemize *

@item 
@code{<protocol>_open()} — signal that the handler knows how to open `protocol'
URLs.

Veja @ref{3bef,,BaseHandler.<protocol>_open()} para maiores informações.

@item 
@code{http_error_<type>()} — signal that the handler knows how to handle HTTP
errors with HTTP error code `type'.

Veja @ref{3bf0,,BaseHandler.http_error_<nnn>()} para maiores informações.

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

Veja @ref{3bf1,,BaseHandler.<protocol>_request()} para maiores informações.

@item 
@code{<protocol>_response()} — signal that the handler knows how to
post-process `protocol' responses.

Veja @ref{3bf2,,BaseHandler.<protocol>_response()} para maiores informações.
@end itemize
@end deffn

@geindex open() (método urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector open}@anchor{1012}
@deffn {Método} OpenerDirector.open (url, data=None[, timeout])

Open the given `url' (which can be a request object or a string), optionally
passing the given `data'. Arguments, return values and exceptions raised are
the same as those of @ref{293,,urlopen()} (which simply calls the @ref{51c,,open()}
method on the currently installed global @ref{3bcb,,OpenerDirector}).  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). The timeout feature actually works only for
HTTP, HTTPS and FTP connections.
@end deffn

@geindex error() (método urllib.request.OpenerDirector)
@anchor{library/urllib request urllib request OpenerDirector error}@anchor{3bf3}
@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.

Return values and exceptions raised are the same as those of @ref{293,,urlopen()}.
@end deffn

OpenerDirector objects open URLs in three stages:

The order in which these methods are called within each stage is determined by
sorting the handler instances.


@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{675,,None}
value (ie. a response), or raises an exception (usually
@ref{3bca,,URLError}).  Exceptions are allowed to propagate.

In fact, the above algorithm is first tried for methods named
@ref{3bf4,,default_open()}.  If all such methods return @ref{675,,None}, the algorithm
is repeated for methods named like @code{<protocol>_open()}.  If all such methods
return @ref{675,,None}, the algorithm is repeated for methods named
@ref{3bf5,,unknown_open()}.

Note that the implementation of these methods may involve calls of the parent
@ref{3bcb,,OpenerDirector} instance’s @ref{1012,,open()} and
@ref{3bf3,,error()} methods.

@item 
Every handler with a method named like @code{<protocol>_response()} has that
method called to post-process the response.
@end enumerate

@node BaseHandler Objects,HTTPRedirectHandler Objects,OpenerDirector Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request base-handler-objects}@anchor{3bf6}@anchor{library/urllib request basehandler-objects}@anchor{3bf7}
@subsubsection BaseHandler Objects


@ref{3bcf,,BaseHandler} objects provide a couple of methods that are directly
useful, and others that are meant to be used by derived classes.  These are
intended for direct use:

@geindex add_parent() (método urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler add_parent}@anchor{3bf8}
@deffn {Método} BaseHandler.add_parent (director)

Add a director as parent.
@end deffn

@geindex close() (método urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler close}@anchor{3bf9}
@deffn {Método} BaseHandler.close ()

Remove any parents.
@end deffn

The following attribute and methods should only be used by classes derived from
@ref{3bcf,,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 urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler parent}@anchor{3bfa}
@deffn {Atributo} BaseHandler.parent

A valid @ref{3bcb,,OpenerDirector}, which can be used to open using a different
protocol, or handle errors.
@end deffn

@geindex default_open() (método urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler default_open}@anchor{3bf4}
@deffn {Método} BaseHandler.default_open (req)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
define it if they want to catch all URLs.

This method, if implemented, will be called by the parent
@ref{3bcb,,OpenerDirector}.  It should return a file-like object as described in
the return value of the @ref{1012,,open()} method of @ref{3bcb,,OpenerDirector}, or @code{None}.
It should raise @ref{3bca,,URLError}, unless a truly exceptional
thing happens (for example, @ref{15c5,,MemoryError} should not be mapped to
@ref{3bca,,URLError}).

This method will be called before any protocol-specific open method.
@end deffn

@anchor{library/urllib request protocol-open}@anchor{3bef}
@deffn {Método} BaseHandler.<protocol>_open(req)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
define it if they want to handle URLs with the given protocol.

This method, if defined, will be called by the parent @ref{3bcb,,OpenerDirector}.
Return values should be the same as for  @ref{3bf4,,default_open()}.
@end deffn

@geindex unknown_open() (método urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler unknown_open}@anchor{3bf5}
@deffn {Método} BaseHandler.unknown_open (req)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
define it if they want to catch all URLs with no specific registered handler to
open it.

This method, if implemented, will be called by the @ref{3bfa,,parent}
@ref{3bcb,,OpenerDirector}.  Return values should be the same as for
@ref{3bf4,,default_open()}.
@end deffn

@geindex http_error_default() (método urllib.request.BaseHandler)
@anchor{library/urllib request urllib request BaseHandler http_error_default}@anchor{3bfb}
@deffn {Método} BaseHandler.http_error_default (req, fp, code, msg, hdrs)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
override it if they intend to provide a catch-all for otherwise unhandled HTTP
errors.  It will be called automatically by the  @ref{3bcb,,OpenerDirector} getting
the error, and should not normally be called in other circumstances.

@ref{3bcb,,OpenerDirector} will call this method with five positional arguments:


@enumerate 

@item 
a @ref{100e,,Request} object,

@item 
a file-like object with the HTTP error body,

@item 
the three-digit code of the error, as a string,

@item 
the user-visible explanation of the code, as a string, and

@item 
the headers of the error, as a mapping object.
@end enumerate

Return values and exceptions raised should be the same as those of
@ref{293,,urlopen()}.
@end deffn

@anchor{library/urllib request http-error-nnn}@anchor{3bf0}
@deffn {Método} BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)

`nnn' should be a three-digit HTTP error code.  This method is also not defined
in @ref{3bcf,,BaseHandler}, but will be called, if it exists, on an instance of a
subclass, when an HTTP error with code `nnn' occurs.

Subclasses should override this method to handle specific HTTP errors.

Arguments, return values and exceptions raised should be the same as for
@ref{3bfb,,http_error_default()}.
@end deffn

@anchor{library/urllib request protocol-request}@anchor{3bf1}
@deffn {Método} BaseHandler.<protocol>_request(req)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
define it if they want to pre-process requests of the given protocol.

This method, if defined, will be called by the parent @ref{3bcb,,OpenerDirector}.
`req' will be a @ref{100e,,Request} object. The return value should be a
@ref{100e,,Request} object.
@end deffn

@anchor{library/urllib request protocol-response}@anchor{3bf2}
@deffn {Método} BaseHandler.<protocol>_response(req, response)

This method is `not' defined in @ref{3bcf,,BaseHandler}, but subclasses should
define it if they want to post-process responses of the given protocol.

This method, if defined, will be called by the parent @ref{3bcb,,OpenerDirector}.
`req' will be a @ref{100e,,Request} object. `response' will be an object
implementing the same interface as the return value of @ref{293,,urlopen()}.  The
return value should implement the same interface as the return value of
@ref{293,,urlopen()}.
@end deffn

@node HTTPRedirectHandler Objects,HTTPCookieProcessor Objects,BaseHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-redirect-handler}@anchor{3bfc}@anchor{library/urllib request httpredirecthandler-objects}@anchor{3bfd}
@subsubsection HTTPRedirectHandler Objects


@cartouche
@quotation Nota 
Some HTTP redirections require action from this module’s client code.  If this
is the case, @ref{1014,,HTTPError} is raised.  See 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} for
details of the precise meanings of the various redirection codes.

An @ref{1014,,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 urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler redirect_request}@anchor{3bfe}
@deffn {Método} HTTPRedirectHandler.redirect_request (req, fp, code, msg, hdrs, newurl)

Return a @ref{100e,,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{100e,,Request} to allow @code{http_error_30*()} to perform the
redirect to `newurl'.  Otherwise, raise @ref{1014,,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 
The default implementation of this method does not strictly follow 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html},
which says that 301 and 302 responses to @code{POST} requests must not be
automatically redirected without confirmation by the user.  In reality, browsers
do allow automatic redirection of these responses, changing the POST to a
@code{GET}, and the default implementation reproduces this behavior.
@end quotation
@end cartouche
@end deffn

@geindex http_error_301() (método urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_301}@anchor{3bff}
@deffn {Método} HTTPRedirectHandler.http_error_301 (req, fp, code, msg, hdrs)

Redirect to the @code{Location:} or @code{URI:} URL.  This method is called by the
parent @ref{3bcb,,OpenerDirector} when getting an HTTP ‘moved permanently’ response.
@end deffn

@geindex http_error_302() (método urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_302}@anchor{3c00}
@deffn {Método} HTTPRedirectHandler.http_error_302 (req, fp, code, msg, hdrs)

The same as @ref{3bff,,http_error_301()}, but called for the ‘found’ response.
@end deffn

@geindex http_error_303() (método urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_303}@anchor{3c01}
@deffn {Método} HTTPRedirectHandler.http_error_303 (req, fp, code, msg, hdrs)

The same as @ref{3bff,,http_error_301()}, but called for the ‘see other’ response.
@end deffn

@geindex http_error_307() (método urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_307}@anchor{3c02}
@deffn {Método} HTTPRedirectHandler.http_error_307 (req, fp, code, msg, hdrs)

The same as @ref{3bff,,http_error_301()}, but called for the ‘temporary redirect’
response. It does not allow changing the request method from @code{POST}
to @code{GET}.
@end deffn

@geindex http_error_308() (método urllib.request.HTTPRedirectHandler)
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_308}@anchor{3c03}
@deffn {Método} HTTPRedirectHandler.http_error_308 (req, fp, code, msg, hdrs)

The same as @ref{3bff,,http_error_301()}, but called for the ‘permanent redirect’
response. It does not allow changing the request method from @code{POST}
to @code{GET}.


Adicionado na versão 3.11.

@end deffn

@node HTTPCookieProcessor Objects,ProxyHandler Objects,HTTPRedirectHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-cookie-processor}@anchor{3c04}@anchor{library/urllib request httpcookieprocessor-objects}@anchor{3c05}
@subsubsection HTTPCookieProcessor Objects


@ref{3bd6,,HTTPCookieProcessor} instances have one attribute:

@geindex cookiejar (atributo urllib.request.HTTPCookieProcessor)
@anchor{library/urllib request urllib request HTTPCookieProcessor cookiejar}@anchor{3c06}
@deffn {Atributo} HTTPCookieProcessor.cookiejar

The @ref{3c07,,http.cookiejar.CookieJar} in which cookies are stored.
@end deffn

@node ProxyHandler Objects,HTTPPasswordMgr Objects,HTTPCookieProcessor Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request proxy-handler}@anchor{3c08}@anchor{library/urllib request proxyhandler-objects}@anchor{3c09}
@subsubsection ProxyHandler Objects



@deffn {Método} ProxyHandler.<protocol>_open(request)

The @ref{1b47,,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 HTTPPasswordMgr Objects,HTTPPasswordMgrWithPriorAuth Objects,ProxyHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-password-mgr}@anchor{3bd9}@anchor{library/urllib request httppasswordmgr-objects}@anchor{3c0a}
@subsubsection HTTPPasswordMgr Objects


These methods are available on @ref{3bd7,,HTTPPasswordMgr} and
@ref{3bd8,,HTTPPasswordMgrWithDefaultRealm} objects.

@geindex add_password() (método urllib.request.HTTPPasswordMgr)
@anchor{library/urllib request urllib request HTTPPasswordMgr add_password}@anchor{3c0b}
@deffn {Método} HTTPPasswordMgr.add_password (realm, uri, user, passwd)

`uri' can be either a single URI, or a sequence of URIs. `realm', `user' and
`passwd' must be strings. This causes @code{(user, passwd)} to be used as
authentication tokens when authentication for `realm' and a super-URI of any of
the given URIs is given.
@end deffn

@geindex find_user_password() (método urllib.request.HTTPPasswordMgr)
@anchor{library/urllib request urllib request HTTPPasswordMgr find_user_password}@anchor{1960}
@deffn {Método} HTTPPasswordMgr.find_user_password (realm, authuri)

Get user/password for given realm and URI, if any.  This method will return
@code{(None, None)} if there is no matching user/password.

For @ref{3bd8,,HTTPPasswordMgrWithDefaultRealm} objects, the realm @code{None} will be
searched if the given `realm' has no matching user/password.
@end deffn

@node HTTPPasswordMgrWithPriorAuth Objects,AbstractBasicAuthHandler Objects,HTTPPasswordMgr Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-password-mgr-with-prior-auth}@anchor{3bda}@anchor{library/urllib request httppasswordmgrwithpriorauth-objects}@anchor{3c0c}
@subsubsection HTTPPasswordMgrWithPriorAuth Objects


This password manager extends @ref{3bd8,,HTTPPasswordMgrWithDefaultRealm} to support
tracking URIs for which authentication credentials should always be sent.

@geindex add_password() (método urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth add_password}@anchor{3c0d}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.add_password (realm, uri, user, passwd, is_authenticated=False)

`realm', `uri', `user', `passwd' are as for
@ref{3c0b,,HTTPPasswordMgr.add_password()}.  `is_authenticated' sets the initial
value of the @code{is_authenticated} flag for the given URI or list of URIs.
If `is_authenticated' is specified as @code{True}, `realm' is ignored.
@end deffn

@geindex find_user_password() (método urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth find_user_password}@anchor{3c0e}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.find_user_password (realm, authuri)

Same as for @ref{3bd8,,HTTPPasswordMgrWithDefaultRealm} objects
@end deffn

@geindex update_authenticated() (método urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth update_authenticated}@anchor{3c0f}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.update_authenticated (self, uri, is_authenticated=False)

Update the @code{is_authenticated} flag for the given `uri' or list
of URIs.
@end deffn

@geindex is_authenticated() (método urllib.request.HTTPPasswordMgrWithPriorAuth)
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth is_authenticated}@anchor{1961}
@deffn {Método} HTTPPasswordMgrWithPriorAuth.is_authenticated (self, authuri)

Returns the current state of the @code{is_authenticated} flag for
the given URI.
@end deffn

@node AbstractBasicAuthHandler Objects,HTTPBasicAuthHandler Objects,HTTPPasswordMgrWithPriorAuth Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request abstract-basic-auth-handler}@anchor{3c10}@anchor{library/urllib request abstractbasicauthhandler-objects}@anchor{3c11}
@subsubsection AbstractBasicAuthHandler Objects


@geindex http_error_auth_reqed() (método urllib.request.AbstractBasicAuthHandler)
@anchor{library/urllib request urllib request AbstractBasicAuthHandler http_error_auth_reqed}@anchor{3c12}
@deffn {Método} AbstractBasicAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

Handle an authentication request by getting a user/password pair, and re-trying
the request.  `authreq' should be the name of the header where the information
about the realm is included in the request, `host' specifies the URL and path to
authenticate for, `req' should be the (failed) @ref{100e,,Request} object, and
`headers' should be the error headers.

`host' is either an authority (e.g. @code{"python.org"}) or a URL containing an
authority component (e.g. @code{"http://python.org/"}). In either case, the
authority must not contain a userinfo component (so, @code{"python.org"} and
@code{"python.org:80"} are fine, @code{"joe:password@@python.org"} is not).
@end deffn

@node HTTPBasicAuthHandler Objects,ProxyBasicAuthHandler Objects,AbstractBasicAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-basic-auth-handler}@anchor{3c13}@anchor{library/urllib request httpbasicauthhandler-objects}@anchor{3c14}
@subsubsection HTTPBasicAuthHandler Objects


@geindex http_error_401() (método urllib.request.HTTPBasicAuthHandler)
@anchor{library/urllib request urllib request HTTPBasicAuthHandler http_error_401}@anchor{3c15}
@deffn {Método} HTTPBasicAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

Retry the request with authentication information, if available.
@end deffn

@node ProxyBasicAuthHandler Objects,AbstractDigestAuthHandler Objects,HTTPBasicAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request proxy-basic-auth-handler}@anchor{3c16}@anchor{library/urllib request proxybasicauthhandler-objects}@anchor{3c17}
@subsubsection ProxyBasicAuthHandler Objects


@geindex http_error_407() (método urllib.request.ProxyBasicAuthHandler)
@anchor{library/urllib request urllib request ProxyBasicAuthHandler http_error_407}@anchor{3c18}
@deffn {Método} ProxyBasicAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

Retry the request with authentication information, if available.
@end deffn

@node AbstractDigestAuthHandler Objects,HTTPDigestAuthHandler Objects,ProxyBasicAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request abstract-digest-auth-handler}@anchor{3c19}@anchor{library/urllib request abstractdigestauthhandler-objects}@anchor{3c1a}
@subsubsection AbstractDigestAuthHandler Objects


@geindex http_error_auth_reqed() (método urllib.request.AbstractDigestAuthHandler)
@anchor{library/urllib request urllib request AbstractDigestAuthHandler http_error_auth_reqed}@anchor{3c1b}
@deffn {Método} AbstractDigestAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

`authreq' should be the name of the header where the information about the realm
is included in the request, `host' should be the host to authenticate to, `req'
should be the (failed) @ref{100e,,Request} object, and `headers' should be the
error headers.
@end deffn

@node HTTPDigestAuthHandler Objects,ProxyDigestAuthHandler Objects,AbstractDigestAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-digest-auth-handler}@anchor{3c1c}@anchor{library/urllib request httpdigestauthhandler-objects}@anchor{3c1d}
@subsubsection HTTPDigestAuthHandler Objects


@geindex http_error_401() (método urllib.request.HTTPDigestAuthHandler)
@anchor{library/urllib request urllib request HTTPDigestAuthHandler http_error_401}@anchor{3c1e}
@deffn {Método} HTTPDigestAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

Retry the request with authentication information, if available.
@end deffn

@node ProxyDigestAuthHandler Objects,HTTPHandler Objects,HTTPDigestAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request proxy-digest-auth-handler}@anchor{3c1f}@anchor{library/urllib request proxydigestauthhandler-objects}@anchor{3c20}
@subsubsection ProxyDigestAuthHandler Objects


@geindex http_error_407() (método urllib.request.ProxyDigestAuthHandler)
@anchor{library/urllib request urllib request ProxyDigestAuthHandler http_error_407}@anchor{3c21}
@deffn {Método} ProxyDigestAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

Retry the request with authentication information, if available.
@end deffn

@node HTTPHandler Objects,Objetos HTTPSHandler,ProxyDigestAuthHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-handler-objects}@anchor{3c22}@anchor{library/urllib request httphandler-objects}@anchor{3c23}
@subsubsection HTTPHandler Objects


@geindex http_open() (método urllib.request.HTTPHandler)
@anchor{library/urllib request urllib request HTTPHandler http_open}@anchor{3c24}
@deffn {Método} HTTPHandler.http_open (req)

Send an HTTP request, which can be either GET or POST, depending on
@code{req.data}.
@end deffn

@node Objetos HTTPSHandler,FileHandler Objects,HTTPHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request https-handler-objects}@anchor{3c25}@anchor{library/urllib request httpshandler-objects}@anchor{3c26}
@subsubsection Objetos HTTPSHandler


@geindex https_open() (método urllib.request.HTTPSHandler)
@anchor{library/urllib request urllib request HTTPSHandler https_open}@anchor{3c27}
@deffn {Método} HTTPSHandler.https_open (req)

Send an HTTPS request, which can be either GET or POST, depending on
@code{req.data}.
@end deffn

@node FileHandler Objects,DataHandler Objects,Objetos HTTPSHandler,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request file-handler-objects}@anchor{3c28}@anchor{library/urllib request filehandler-objects}@anchor{3c29}
@subsubsection FileHandler Objects


@geindex file_open() (método urllib.request.FileHandler)
@anchor{library/urllib request urllib request FileHandler file_open}@anchor{3c2a}
@deffn {Método} FileHandler.file_open (req)

Open the file locally, if there is no host name, or the host name is
@code{'localhost'}.


Alterado na versão 3.2: This method is applicable only for local hostnames.  When a remote
hostname is given, a @ref{3bca,,URLError} is raised.

@end deffn

@node DataHandler Objects,FTPHandler Objects,FileHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request data-handler-objects}@anchor{3c2b}@anchor{library/urllib request datahandler-objects}@anchor{3c2c}
@subsubsection DataHandler Objects


@geindex data_open() (método urllib.request.DataHandler)
@anchor{library/urllib request urllib request DataHandler data_open}@anchor{3c2d}
@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{202,,ValueError} in that case.
@end deffn

@node FTPHandler Objects,CacheFTPHandler Objects,DataHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request ftp-handler-objects}@anchor{3c2e}@anchor{library/urllib request ftphandler-objects}@anchor{3c2f}
@subsubsection FTPHandler Objects


@geindex ftp_open() (método urllib.request.FTPHandler)
@anchor{library/urllib request urllib request FTPHandler ftp_open}@anchor{3c30}
@deffn {Método} FTPHandler.ftp_open (req)

Open the FTP file indicated by `req'. The login is always done with empty
username and password.
@end deffn

@node CacheFTPHandler Objects,Objetos UnknownHandler,FTPHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request cacheftp-handler-objects}@anchor{3c31}@anchor{library/urllib request cacheftphandler-objects}@anchor{3c32}
@subsubsection CacheFTPHandler Objects


@ref{181d,,CacheFTPHandler} objects are @ref{3bd2,,FTPHandler} objects with the
following additional methods:

@geindex setTimeout() (método urllib.request.CacheFTPHandler)
@anchor{library/urllib request urllib request CacheFTPHandler setTimeout}@anchor{3c33}
@deffn {Método} CacheFTPHandler.setTimeout (t)

Set timeout of connections to `t' seconds.
@end deffn

@geindex setMaxConns() (método urllib.request.CacheFTPHandler)
@anchor{library/urllib request urllib request CacheFTPHandler setMaxConns}@anchor{3c34}
@deffn {Método} CacheFTPHandler.setMaxConns (m)

Set maximum number of cached connections to `m'.
@end deffn

@node Objetos UnknownHandler,HTTPErrorProcessor Objects,CacheFTPHandler Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request unknown-handler-objects}@anchor{3c35}@anchor{library/urllib request unknownhandler-objects}@anchor{3c36}
@subsubsection Objetos UnknownHandler


@geindex unknown_open() (método urllib.request.UnknownHandler)
@anchor{library/urllib request urllib request UnknownHandler unknown_open}@anchor{3c37}
@deffn {Método} UnknownHandler.unknown_open ()

Raise a @ref{3bca,,URLError} exception.
@end deffn

@node HTTPErrorProcessor Objects,Exemplos<26>,Objetos UnknownHandler,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request http-error-processor-objects}@anchor{3c38}@anchor{library/urllib request httperrorprocessor-objects}@anchor{3c39}
@subsubsection HTTPErrorProcessor Objects


@geindex http_response() (método urllib.request.HTTPErrorProcessor)
@anchor{library/urllib request urllib request HTTPErrorProcessor http_response}@anchor{3c3a}
@deffn {Método} HTTPErrorProcessor.http_response (request, response)

Process HTTP error responses.

For 200 error codes, the response object is returned immediately.

For non-200 error codes, this simply passes the job on to the
@code{http_error_<type>()} handler methods, via @ref{3bf3,,OpenerDirector.error()}.
Eventually, @ref{3bd0,,HTTPDefaultErrorHandler} will raise an
@ref{1014,,HTTPError} if no other handler handles the error.
@end deffn

@geindex https_response() (método urllib.request.HTTPErrorProcessor)
@anchor{library/urllib request urllib request HTTPErrorProcessor https_response}@anchor{3c3b}
@deffn {Método} HTTPErrorProcessor.https_response (request, response)

Process HTTPS error responses.

The behavior is same as @ref{3c3a,,http_response()}.
@end deffn

@node Exemplos<26>,Legacy interface,HTTPErrorProcessor Objects,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request examples}@anchor{3c3c}@anchor{library/urllib request urllib-request-examples}@anchor{3c3d}
@subsubsection Exemplos


In addition to the examples below, more examples are given in
@ref{3c3e,,Como buscar recursos da Internet usando o pacote urllib}.

This example gets the python.org main page and displays the first 300 bytes of
it:

@example
>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(300))
...
b'<!doctype html>\n<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->\n<!--[if IE 7]>      <html class="no-js ie7 lt-ie8 lt-ie9">          <![endif]-->\n<!--[if IE 8]>      <html class="no-js ie8 lt-ie9">
@end example

Note that urlopen returns a bytes object.  This is because there is no way
for urlopen to automatically determine the encoding of the byte stream
it receives from the HTTP server. In general, a program will decode
the returned bytes object to string once it determines or guesses
the appropriate encoding.

The following HTML spec document, @indicateurl{https://html.spec.whatwg.org/#charset}, lists
the various ways in which an HTML or an XML document could have specified its
encoding information.

For additional information, see the W3C document: @indicateurl{https://www.w3.org/International/questions/qa-html-encoding-declarations}.

As the python.org website uses `utf-8' encoding as specified in its meta tag, we
will use the same for decoding the bytes object:

@example
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(100).decode('utf-8'))
...
<!doctype html>
<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->
<!-
@end example

It is also possible to achieve the same result without using the
@ref{5d4,,context manager} approach:

@example
>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> try:
...     print(f.read(100).decode('utf-8'))
... finally:
...     f.close()
...
<!doctype html>
<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->
<!--
@end example

In the following example, we are sending a data-stream to the stdin of a CGI
and reading the data it returns to us. Note that this example will only work
when the Python installation supports 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

The code for the sample CGI used in the above example is:

@example
#!/usr/bin/env python
import sys
data = sys.stdin.read()
print('Content-type: text/plain\n\nGot Data: "%s"' % data)
@end example

Here is an example of doing a @code{PUT} request using @ref{100e,,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

Use of Basic HTTP Authentication:

@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)
with urllib.request.urlopen('http://www.example.com/login.html') as f:
    print(f.read().decode('utf-8'))
@end example

@ref{3bce,,build_opener()} provides many handlers by default, including a
@ref{1b47,,ProxyHandler}.  By default, @ref{1b47,,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.

This example replaces the default @ref{1b47,,ProxyHandler} with one that uses
programmatically supplied proxy URLs, and adds proxy authorization support with
@ref{3bdc,,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:
with opener.open('http://www.example.com/login.html') as f:
   print(f.read().decode('utf-8'))
@end example

Adicionando cabeçalhos HTTP:

Use the `headers' argument to the @ref{100e,,Request} constructor, or:

@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: . . .)')
with urllib.request.urlopen(req) as f:
    print(f.read().decode('utf-8'))
@end example

@ref{3bcb,,OpenerDirector} automatically adds a @code{User-Agent} header to
every @ref{100e,,Request}.  To change this:

@example
import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
with opener.open('http://www.example.com/') as f:
   print(f.read().decode('utf-8'))
@end example

Also, remember that a few standard headers (@code{Content-Length},
@code{Content-Type} and @code{Host})
are added when the @ref{100e,,Request} is passed to @ref{293,,urlopen()} (or
@ref{1012,,OpenerDirector.open()}).
@anchor{library/urllib request urllib-examples}@anchor{3c3f}
Here is an example session that uses the @code{GET} method to retrieve a URL
containing parameters:

@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

The following example uses the @code{POST} method instead. Note that params output
from urlencode is encoded to bytes before it is sent to urlopen as data:

@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

The following example uses an explicitly specified HTTP proxy, overriding
environment settings:

@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

The following example uses no proxies at all, overriding environment settings:

@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 Legacy interface,urllib request Restrictions,Exemplos<26>,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request legacy-interface}@anchor{3c40}
@subsubsection Legacy interface


The following functions and classes are ported from the Python 2 module
@code{urllib} (as opposed to @code{urllib2}).  They might become deprecated at
some point in the future.

@geindex urlretrieve() (no módulo urllib.request)
@anchor{library/urllib request urllib request urlretrieve}@anchor{3c41}
@deffn {Função} 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{293,,urlopen()} returned (for
a remote object). Exceptions are the same as for @ref{293,,urlopen()}.

The second argument, if present, specifies the file location to copy to (if
absent, the location will be a tempfile with a generated name). The third
argument, if present, is a callable that will be called once on
establishment of the network connection and once after each block read
thereafter.  The callable will be passed three arguments; a count of blocks
transferred so far, a block size in bytes, and the total size of the file.  The
third argument may be @code{-1} on older FTP servers which do not return a file
size in response to a retrieval request.

The following example illustrates the most common usage scenario:

@example
>>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()
@end example

If the `url' uses the @code{http:} scheme identifier, the optional `data'
argument may be given to specify a @code{POST} request (normally the request
type is @code{GET}).  The `data' argument must be a bytes object in standard
@code{application/x-www-form-urlencoded} format; see the
@ref{ec4,,urllib.parse.urlencode()} function.

@ref{3c41,,urlretrieve()} will raise @ref{3c42,,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.

The `Content-Length' is treated as a lower bound: if there’s more data  to read,
urlretrieve reads more data, but if less data is available,  it raises the
exception.

You can still retrieve the downloaded data in this case, it is stored in the
@code{content} attribute of the exception instance.

If no `Content-Length' header was supplied, urlretrieve can not check the size
of the data it has downloaded, and just returns it.  In this case you just have
to assume that the download was successful.
@end deffn

@geindex urlcleanup() (no módulo urllib.request)
@anchor{library/urllib request urllib request urlcleanup}@anchor{1b4e}
@deffn {Função} urllib.request.urlcleanup ()

Cleans up temporary files that may have been left behind by previous
calls to @ref{3c41,,urlretrieve()}.
@end deffn

@geindex URLopener (classe em urllib.request)
@anchor{library/urllib request urllib request URLopener}@anchor{30e}
@deffn {Classe} urllib.request.URLopener (proxies=None, **x509)


Descontinuado desde a versão 3.3.


Base class for opening and reading URLs.  Unless you need to support opening
objects using schemes other than @code{http:}, @code{ftp:}, or @code{file:},
you probably want to use @ref{30f,,FancyURLopener}.

By default, the @ref{30e,,URLopener} class sends a @code{User-Agent} header
of @code{urllib/VVV}, where `VVV' is the @ref{108,,urllib} version number.
Applications can define their own @code{User-Agent} header by subclassing
@ref{30e,,URLopener} or @ref{30f,,FancyURLopener} and setting the class attribute
@ref{3c43,,version} to an appropriate string value in the subclass definition.

The optional `proxies' parameter should be a dictionary mapping scheme names to
proxy URLs, where an empty dictionary turns proxies off completely.  Its default
value is @code{None}, in which case environmental proxy settings will be used if
present, as discussed in the definition of @ref{293,,urlopen()}, above.

Additional keyword parameters, collected in `x509', may be used for
authentication of the client when using the @code{https:} scheme.  The keywords
`key_file' and `cert_file' are supported to provide an  SSL key and certificate;
both are needed to support client authentication.

@ref{30e,,URLopener} objects will raise an @ref{417,,OSError} exception if the server
returns an error code.

@geindex open() (método urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener open}@anchor{3c44}
@deffn {Método} open (fullurl, data=None)

Open `fullurl' using the appropriate protocol.  This method sets up cache and
proxy information, then calls the appropriate open method with its input
arguments.  If the scheme is not recognized, @ref{3c45,,open_unknown()} is called.
The `data' argument has the same meaning as the `data' argument of
@ref{293,,urlopen()}.

This method always quotes `fullurl' using @ref{bbb,,quote()}.
@end deffn

@geindex open_unknown() (método urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener open_unknown}@anchor{3c45}
@deffn {Método} open_unknown (fullurl, data=None)

Overridable interface to open unknown URL types.
@end deffn

@geindex retrieve() (método urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener retrieve}@anchor{1b65}
@deffn {Método} retrieve (url, filename=None, reporthook=None, data=None)

Retrieves the contents of `url' and places it in `filename'.  The return value
is a tuple consisting of a local filename and either an
@ref{27c,,email.message.Message} object containing the response headers (for remote
URLs) or @code{None} (for local URLs).  The caller must then open and read the
contents of `filename'.  If `filename' is not given and the URL refers to a
local file, the input filename is returned.  If the URL is non-local and
`filename' is not given, the filename is the output of @ref{19bb,,tempfile.mktemp()}
with a suffix that matches the suffix of the last path component of the input
URL.  If `reporthook' is given, it must be a function accepting three numeric
parameters: A chunk number, the maximum size chunks are read in and the total size of the download
(-1 if unknown).  It will be called once at the start and after each chunk of data is read from the
network.  `reporthook' is ignored for local URLs.

If the `url' uses the @code{http:} scheme identifier, the optional `data'
argument may be given to specify a @code{POST} request (normally the request type
is @code{GET}).  The `data' argument must in standard
@code{application/x-www-form-urlencoded} format; see the
@ref{ec4,,urllib.parse.urlencode()} function.
@end deffn

@geindex version (atributo urllib.request.URLopener)
@anchor{library/urllib request urllib request URLopener version}@anchor{3c43}
@deffn {Atributo} version

Variable that specifies the user agent of the opener object.  To get
@ref{108,,urllib} to tell servers that it is a particular user agent, set this in a
subclass as a class variable or in the constructor before calling the base
constructor.
@end deffn
@end deffn

@geindex FancyURLopener (classe em urllib.request)
@anchor{library/urllib request urllib request FancyURLopener}@anchor{30f}
@deffn {Classe} urllib.request.FancyURLopener (...)


Descontinuado desde a versão 3.3.


@ref{30f,,FancyURLopener} subclasses @ref{30e,,URLopener} providing default handling
for the following HTTP response codes: 301, 302, 303, 307 and 401.  For the 30x
response codes listed above, the @code{Location} header is used to fetch
the actual URL.  For 401 response codes (authentication required), basic HTTP
authentication is performed.  For the 30x response codes, recursion is bounded
by the value of the `maxtries' attribute, which defaults to 10.

For all other response codes, the method @ref{3bfb,,http_error_default()} is called
which you can override in subclasses to handle the error appropriately.

@cartouche
@quotation Nota 
According to the letter of 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}, 301 and 302 responses to POST requests
must not be automatically redirected without confirmation by the user.  In
reality, browsers do allow automatic redirection of these responses, changing
the POST to a GET, and @ref{108,,urllib} reproduces this behaviour.
@end quotation
@end cartouche

The parameters to the constructor are the same as those for @ref{30e,,URLopener}.

@cartouche
@quotation Nota 
When performing basic authentication, a @ref{30f,,FancyURLopener} instance calls
its @ref{3c46,,prompt_user_passwd()} method.  The default implementation asks the
users for the required information on the controlling terminal.  A subclass may
override this method to support more appropriate behavior if needed.
@end quotation
@end cartouche

The @ref{30f,,FancyURLopener} class offers one additional method that should be
overloaded to provide the appropriate behavior:

@geindex prompt_user_passwd() (método urllib.request.FancyURLopener)
@anchor{library/urllib request urllib request FancyURLopener prompt_user_passwd}@anchor{3c46}
@deffn {Método} prompt_user_passwd (host, realm)

Return information needed to authenticate the user at the given host in the
specified security realm.  The return value should be a tuple, @code{(user,
password)}, which can be used for basic authentication.

The implementation prompts for this information on the terminal; an application
should override this method to use an appropriate interaction model in the local
environment.
@end deffn
@end deffn

@node urllib request Restrictions,,Legacy interface,urllib request — Biblioteca extensível para abrir URLs
@anchor{library/urllib request urllib-request-restrictions}@anchor{3c47}
@subsubsection @code{urllib.request} Restrictions


@geindex HTTP;protocolo
@geindex FTP;protocolo


@itemize *

@item 
Currently, only the following protocols are supported: HTTP (versions 0.9 and
1.0), FTP, local files, and data URLs.


Alterado na versão 3.4: Added support for data URLs.


@item 
The caching feature of @ref{3c41,,urlretrieve()} has been disabled until someone
finds the time to hack proper processing of Expiration time headers.

@item 
There should be a function to query whether a particular URL is in the cache.

@item 
For backward compatibility, if a URL appears to point to a local file but the
file can’t be opened, the URL is re-interpreted using the FTP protocol.  This
can sometimes cause confusing error messages.

@item 
The @ref{293,,urlopen()} and @ref{3c41,,urlretrieve()} functions can cause arbitrarily
long delays while waiting for a network connection to be set up.  This means
that it is difficult to build an interactive web client using these functions
without using threads.

@geindex HTML
@geindex HTTP;protocolo

@item 
The data returned by @ref{293,,urlopen()} or @ref{3c41,,urlretrieve()} is the raw data
returned by the server.  This may be binary data (such as an image), plain text
or (for example) HTML.  The HTTP protocol provides type information in the reply
header, which can be inspected by looking at the @code{Content-Type}
header.  If the returned data is HTML, you can use the module
@ref{6d,,html.parser} to parse it.

@geindex FTP

@item 
The code handling the FTP protocol cannot differentiate between a file and a
directory.  This can lead to unexpected behavior when attempting to read a URL
that points to a file that is not accessible.  If the URL ends in a @code{/}, it is
assumed to refer to a directory and will be handled accordingly.  But if an
attempt to read a file leads to a 550 error (meaning the URL cannot be found or
is not accessible, often for permission reasons), then the path is treated as a
directory in order to handle the case when a directory is specified by a URL but
the trailing @code{/} has been left off.  This can cause misleading results when
you try to fetch a file whose read permissions make it inaccessible; the FTP
code will try to read it, fail with a 550 error, and then perform a directory
listing for the unreadable file. If fine-grained control is needed, consider
using the @ref{5e,,ftplib} module, subclassing @ref{30f,,FancyURLopener}, or changing
`_urlopener' to meet your needs.
@end itemize

@node urllib response — Response classes used by urllib,urllib parse — Analisa URLs para componentes,urllib request — Biblioteca extensível para abrir URLs,Protocolos de Internet e Suporte
@anchor{library/urllib request module-urllib response}@anchor{10c}@anchor{library/urllib request urllib-response-response-classes-used-by-urllib}@anchor{3c48}
@subsection @code{urllib.response} — Response classes used by urllib


@geindex module; urllib.response

The @ref{10c,,urllib.response} module defines functions and classes which define a
minimal file-like interface, including @code{read()} and @code{readline()}.
Functions defined by this module are used internally by the @ref{10b,,urllib.request} module.
The typical response object is a @ref{3bc8,,urllib.response.addinfourl} instance:

@geindex addinfourl (classe em urllib.response)
@anchor{library/urllib request urllib response addinfourl}@anchor{3bc8}
@deffn {Classe} urllib.response.addinfourl

@geindex url (atributo urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl url}@anchor{3c49}
@deffn {Atributo} url

URL of the resource retrieved, commonly used to determine if a redirect was followed.
@end deffn

@geindex headers (atributo urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl headers}@anchor{3c4a}
@deffn {Atributo} headers

Returns the headers of the response in the form of an @ref{27b,,EmailMessage} instance.
@end deffn

@geindex status (atributo urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl status}@anchor{3c4b}
@deffn {Atributo} status


Adicionado na versão 3.9.


Status code returned by server.
@end deffn

@geindex geturl() (método urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl geturl}@anchor{3c4c}
@deffn {Método} geturl ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3c49,,url}.

@end deffn

@geindex info() (método urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl info}@anchor{3c4d}
@deffn {Método} info ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3c4a,,headers}.

@end deffn

@geindex code (atributo urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl code}@anchor{3c4e}
@deffn {Atributo} code


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3c4b,,status}.

@end deffn

@geindex getcode() (método urllib.response.addinfourl)
@anchor{library/urllib request urllib response addinfourl getcode}@anchor{3c4f}
@deffn {Método} getcode ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3c4b,,status}.

@end deffn
@end deffn

@node urllib parse — Analisa URLs para componentes,urllib error — Classes de exceção levantadas por urllib request,urllib response — Response classes used by urllib,Protocolos de Internet e Suporte
@anchor{library/urllib parse doc}@anchor{3c50}@anchor{library/urllib parse module-urllib parse}@anchor{10a}@anchor{library/urllib parse translation-repo}@anchor{3c51}@anchor{library/urllib parse urllib-parse-parse-urls-into-components}@anchor{3c52}
@subsection @code{urllib.parse} — Analisa URLs para componentes


@geindex module; urllib.parse

`Código-fonte:' Lib/urllib/parse.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/urllib/parse.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex URL;parsing
@geindex relativa;URL


__________________________________________________________________


Este módulo define uma interface padrão para quebrar strings de Uniform Resource Locator (URL) em componentes (esquema de endereçamento, local de rede, caminho etc.), para combinar os componentes de volta em uma string de URL e para converter uma “URL relativo” em uma URL absoluta dado uma “URL base”.

O módulo foi projetado para corresponder ao RFC da internet sobre Localizadores de Recursos Uniformes Relativos, ou URL relativa. Ele tem suporte aos seguintes esquemas de URL: @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},`@w{`}rtspu`@w{`}, @code{sftp}, @code{shttp}, @code{sip}, @code{sips}, @code{snews}, @code{svn}, @code{svn+ssh}, @code{telnet}, @code{wais}, @code{ws}, @code{wss}.

A inclusão do esquema de URL @code{itms-services} pode impedir que uma aplicação passe pelo processo de revisão da App Store da Apple para as App Stores do macOS e iOS. O tratamento do esquema @code{itms-services} é sempre removido no iOS; no macOS, ele `pode' ser removido se o CPython tiver sido criado com a opção @ref{16de,,--with-app-store-compliance}.

O módulo @ref{10a,,urllib.parse} define funções que se enquadram em duas grandes categorias: análise de URL e colocação de aspas na URL. Eles são abordados em detalhes nas seções a seguir.

As funções deste módulo usam o termo descontinuado @code{netloc} (ou @code{net_loc}), que foi introduzido no 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html}. No entanto, este termo foi descontinuado pelo 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}, que introduziu o termo @code{authority} como seu substituto. O uso de @code{netloc} continua para compatibilidade com versões anteriores.

@menu
* Análise de URL:: 
* Segurança ao analisar URLs:: 
* Analisando bytes codificados em ASCII:: 
* Structured Parse Results:: 
* URL Quoting:: 

@end menu

@node Análise de URL,Segurança ao analisar URLs,,urllib parse — Analisa URLs para componentes
@anchor{library/urllib parse url-parsing}@anchor{3c53}
@subsubsection Análise de URL


As funções de análise de URL se concentram na divisão de uma string de URL em seus componentes ou na combinação de componentes de URL em uma string de URL.

@geindex urlparse() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlparse}@anchor{30d}
@deffn {Função} urllib.parse.urlparse (urlstring, scheme='@w{'}, allow_fragments=True)

Analisa uma URL em seis componentes, retornando uma @ref{64e,,tupla nomeada} de 6 itens. Isso corresponde à estrutura geral de uma URL: @code{scheme://netloc/path;parameters?query#fragment}. Cada item da tupla é uma string, possivelmente vazia. Os componentes não são divididos em partes menores (por exemplo, o netloc, ou local da rede, é uma única string) e escapes % não são expandidos. Os delimitadores conforme mostrado acima não fazem parte do resultado, exceto por uma barra inicial no componente `path', que é retido se estiver presente. Por exemplo:

@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

Seguindo as especificações de sintaxe em 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html}, o urlparse reconhece um netloc apenas se for introduzido apropriadamente por ‘//’. Caso contrário, presume-se que a entrada seja uma URL relativa e, portanto, comece com um componente de caminho.

@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

O argumento `scheme' fornece o esquema de endereçamento padrão, a ser usado apenas se o URL não especificar um. Deve ser do mesmo tipo (texto ou bytes) que `urlstring', exceto que o valor padrão @code{'@w{'}} é sempre permitido e é automaticamente convertido para @code{b'@w{'}} se apropriado.

Se o argumento `allow_fragments' for falso, os identificadores de fragmento não serão reconhecidos. Em vez disso, eles são analisados como parte do caminho, parâmetros ou componente de consulta, e @code{fragment} é definido como a string vazia no valor de retorno.

O valor de retorno é uma @ref{64e,,tupla nomeada}, o que significa que seus itens podem ser acessados por índice ou como atributos nomeados, que são:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor, se não presente

@item

@code{scheme}

@tab

0

@tab

Especificador do esquema da URL

@tab

parâmetro `scheme'

@item

@code{netloc}

@tab

1

@tab

Parte da localização na rede

@tab

string vazia

@item

@code{path}

@tab

2

@tab

Caminho hierárquico

@tab

string vazia

@item

@code{params}

@tab

3

@tab

Parâmetros para o último elemento de caminho

@tab

string vazia

@item

@code{query}

@tab

4

@tab

Componente da consulta

@tab

string vazia

@item

@code{fragment}

@tab

5

@tab

Identificador do fragmento

@tab

string vazia

@item

@code{username}

@tab

@tab

Nome do usuário

@tab

@ref{675,,None}

@item

@code{password}

@tab

@tab

Senha

@tab

@ref{675,,None}

@item

@code{hostname}

@tab

@tab

Nome de máquina (em minúsculo)

@tab

@ref{675,,None}

@item

@code{port}

@tab

@tab

Número da porta como inteiro, se presente

@tab

@ref{675,,None}

@end multitable


Ler o atributo @code{port} irá levantar uma @ref{202,,ValueError} se uma porta inválida for especificada no URL. Veja a seção @ref{3c54,,Structured Parse Results} para mais informações sobre o objeto de resultado.

Colchetes sem correspondência no atributo @code{netloc} levantará uma @ref{202,,ValueError}.

Caracteres no atributo @code{netloc} que se decompõem sob a normalização NFKC (como usado pela codificação IDNA) em qualquer um dos @code{/}, @code{?}, @code{#}, @code{@@} ou @code{:} vai levantar uma @ref{202,,ValueError}. Se a URL for decomposta antes da análise, nenhum erro será levantado.

Como é o caso com todas as tuplas nomeadas, a subclasse tem alguns métodos e atributos adicionais que são particularmente úteis. Um desses métodos é @code{_replace()}. O método @code{_replace()} retornará um novo objeto ParseResult substituindo os campos especificados por novos 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 Aviso 
@ref{30d,,urlparse()} não realiza validação.  Veja @ref{3c55,,Segurança ao analisar URLs} para detalhes.
@end quotation
@end cartouche


Alterado na versão 3.2: Adicionados recursos de análise de URL IPv6.



Alterado na versão 3.3: O fragmento agora é analisado para todos os esquemas de URL (a menos que `allow_fragments' seja falso), de acordo com a 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}. Anteriormente, existia uma lista de permitidos de esquemas que suportam fragmentos.



Alterado na versão 3.6: Números de porta fora do intervalo agora levantam @ref{202,,ValueError}, em vez de retornar @ref{675,,None}.



Alterado na versão 3.8: Os caracteres que afetam a análise de netloc sob normalização NFKC agora levantarão @ref{202,,ValueError}.

@end deffn

@geindex parse_qs() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse parse_qs}@anchor{27a}
@deffn {Função} urllib.parse.parse_qs (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

Analisa uma string de consulta fornecida como um argumento de string (dados do tipo @code{application/x-www-form-urlencoded}). Os dados são retornados como um dicionário. As chaves de dicionário são os nomes de variáveis de consulta exclusivos e os valores são listas de valores para cada nome.

O argumento opcional `keep_blank_values' é um sinalizador que indica se os valores em branco em consultas codificadas por porcentagem devem ser tratados como strings em branco. Um valor verdadeiro indica que os espaços em branco devem ser mantidos como strings em branco. O valor falso padrão indica que os valores em branco devem ser ignorados e tratados como se não tivessem sido incluídos.

O argumento opcional `strict_parsing' é um sinalizador que indica o que fazer com os erros de análise. Se falso (padrão), os erros são ignorados silenciosamente. Se verdadeiro, os erros levantam uma exceção @ref{202,,ValueError}.

Os parâmetros opcionais `encoding' e `errors' especificam como decodificar sequências codificadas em porcentagem em caracteres Unicode, conforme aceito pelo método @ref{8dc,,bytes.decode()}.

O argumento opcional `max_num_fields' é o número máximo de campos a serem lidos. Se definido, então levanta um @ref{202,,ValueError} se houver mais de `max_num_fields' campos lidos.

O argumento opcional `separador' é o símbolo a ser usado para separar os argumentos da consulta. O padrão é @code{&}.

Use a função @ref{ec4,,urllib.parse.urlencode()} (com o parâmetro @code{doseq} definido como @code{True}) para converter esses dicionários em strings de consulta.


Alterado na versão 3.2: Adicionado os parâmetros `encoding' e `errors'.



Alterado na versão 3.8: Adicionado o parâmetro `max_num_fields'.



Alterado na versão 3.10: Adicionado parâmetro `separator' com o valor padrão de @code{&}. Versões do Python anteriores ao Python 3.10 permitiam o uso de @code{;} e @code{&} como separador de parâmetro de consulta. Isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como o separador padrão.

@end deffn

@geindex parse_qsl() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse parse_qsl}@anchor{279}
@deffn {Função} urllib.parse.parse_qsl (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

Analisa uma string de consulta fornecida como um argumento de string (dados do tipo @code{application/x-www-form-urlencoded}). Os dados são retornados como uma lista de pares de nome e valor.

O argumento opcional `keep_blank_values' é um sinalizador que indica se os valores em branco em consultas codificadas por porcentagem devem ser tratados como strings em branco. Um valor verdadeiro indica que os espaços em branco devem ser mantidos como strings em branco. O valor falso padrão indica que os valores em branco devem ser ignorados e tratados como se não tivessem sido incluídos.

O argumento opcional `strict_parsing' é um sinalizador que indica o que fazer com os erros de análise. Se falso (padrão), os erros são ignorados silenciosamente. Se verdadeiro, os erros levantam uma exceção @ref{202,,ValueError}.

Os parâmetros opcionais `encoding' e `errors' especificam como decodificar sequências codificadas em porcentagem em caracteres Unicode, conforme aceito pelo método @ref{8dc,,bytes.decode()}.

O argumento opcional `max_num_fields' é o número máximo de campos a serem lidos. Se definido, então levanta um @ref{202,,ValueError} se houver mais de `max_num_fields' campos lidos.

O argumento opcional `separador' é o símbolo a ser usado para separar os argumentos da consulta. O padrão é @code{&}.

Use a função @ref{ec4,,urllib.parse.urlencode()} para converter essas listas pares de strings de consulta.


Alterado na versão 3.2: Adicionado os parâmetros `encoding' e `errors'.



Alterado na versão 3.8: Adicionado o parâmetro `max_num_fields'.



Alterado na versão 3.10: Adicionado parâmetro `separator' com o valor padrão de @code{&}. Versões do Python anteriores ao Python 3.10 permitiam o uso de @code{;} e @code{&} como separador de parâmetro de consulta. Isso foi alterado para permitir apenas uma única chave separadora, com @code{&} como o separador padrão.

@end deffn

@geindex urlunparse() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlunparse}@anchor{16c1}
@deffn {Função} urllib.parse.urlunparse (parts)

Constrói uma URL a partir de uma tupla conforme retornada por @code{urlparse()}. O argumento `parts' pode ser qualquer iterável de seis itens. Isso pode resultar em uma URL ligeiramente diferente, mas equivalente, se a URL que foi analisada originalmente tiver delimitadores desnecessários (por exemplo, um @code{?} com uma consulta vazia; o RFC afirma que eles são equivalentes).
@end deffn

@geindex urlsplit() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlsplit}@anchor{d61}
@deffn {Função} urllib.parse.urlsplit (urlstring, scheme='@w{'}, allow_fragments=True)

Isto é similar a @ref{30d,,urlparse()}, mas não divide os parâmetros da URL. Isto deve ser usado geralmente em vez de @ref{30d,,urlparse()} se a sintaxe de URL mais recente permitindo que parâmetros sejam aplicados a cada segmento da porção `path' da URL (veja 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html}) for desejada. Uma função separada é necessária para separar os segmentos de caminho e parâmetros. Esta função retorna uma @ref{64e,,tupla nomeada} de 5 itens:

@example
(esquema de endereçamento, local de rede, caminho, consulta, identificador de fragmento).
@end example

O valor de retorno é uma @ref{64e,,tupla nomeada}, seus itens podem ser acessados por índice ou como atributos nomeados:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor, se não presente

@item

@code{scheme}

@tab

0

@tab

Especificador do esquema da URL

@tab

parâmetro `scheme'

@item

@code{netloc}

@tab

1

@tab

Parte da localização na rede

@tab

string vazia

@item

@code{path}

@tab

2

@tab

Caminho hierárquico

@tab

string vazia

@item

@code{query}

@tab

3

@tab

Componente da consulta

@tab

string vazia

@item

@code{fragment}

@tab

4

@tab

Identificador do fragmento

@tab

string vazia

@item

@code{username}

@tab

@tab

Nome do usuário

@tab

@ref{675,,None}

@item

@code{password}

@tab

@tab

Senha

@tab

@ref{675,,None}

@item

@code{hostname}

@tab

@tab

Nome de máquina (em minúsculo)

@tab

@ref{675,,None}

@item

@code{port}

@tab

@tab

Número da porta como inteiro, se presente

@tab

@ref{675,,None}

@end multitable


Ler o atributo @code{port} irá levantar uma @ref{202,,ValueError} se uma porta inválida for especificada no URL. Veja a seção @ref{3c54,,Structured Parse Results} para mais informações sobre o objeto de resultado.

Colchetes sem correspondência no atributo @code{netloc} levantará uma @ref{202,,ValueError}.

Caracteres no atributo @code{netloc} que se decompõem sob a normalização NFKC (como usado pela codificação IDNA) em qualquer um dos @code{/}, @code{?}, @code{#}, @code{@@} ou @code{:} vai levantar uma @ref{202,,ValueError}. Se a URL for decomposta antes da análise, nenhum erro será levantado.

Seguindo algumas das especificações WHATWG@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser} que atualizam o RFC 3986, os caracteres de controle C0 e espaço iniciais são removidos da URL. Os caracteres @code{\n}, @code{\r} e tab @code{\t} são removidos da URL em qualquer posição.

@cartouche
@quotation Aviso 
@ref{d61,,urlsplit()} não executa validação. Veja @ref{3c55,,Segurança ao analisar URLs} para detalhes.
@end quotation
@end cartouche


Alterado na versão 3.6: Números de porta fora do intervalo agora levantam @ref{202,,ValueError}, em vez de retornar @ref{675,,None}.



Alterado na versão 3.8: Os caracteres que afetam a análise de netloc sob normalização NFKC agora levantarão @ref{202,,ValueError}.



Alterado na versão 3.10: Caracteres de nova linha e tabulação ASCII são removidos do URL.



Alterado na versão 3.12: Os caracteres iniciais de espaço e de controle WHATWG C0 são removidos do URL.

@end deffn

@geindex urlunsplit() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlunsplit}@anchor{16c0}
@deffn {Função} urllib.parse.urlunsplit (parts)

Combina os elementos de uma tupla conforme retornado por @ref{d61,,urlsplit()} em uma URL completa como uma string. O argumento `parts' pode ser qualquer iterável de cinco itens. Isso pode resultar em uma URL ligeiramente diferente, mas equivalente, se a URL que foi analisada originalmente tiver delimitadores desnecessários (por exemplo, um ? com uma consulta vazia; o RFC afirma que eles são equivalentes).
@end deffn

@geindex urljoin() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urljoin}@anchor{ec5}
@deffn {Função} urllib.parse.urljoin (base, url, allow_fragments=True)

Constrói uma URL completa (“absoluta”) combinando uma “URL base” (`base') com outra URL (`url'). Informalmente, isso usa componentes da URL base, em particular o esquema de endereçamento, o local da rede e (parte do) caminho, para fornecer componentes ausentes na URL relativa. Por exemplo:

@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

O argumento `allow_fragments' tem o mesmo significado e padrão que @ref{30d,,urlparse()}.

@cartouche
@quotation Nota 
Se `url' for uma URL absoluta (ou seja, começa com @code{//} ou @code{scheme://}), o nome do host e/ou esquema da `url' estarão presentes no resultado. Por exemplo:

@example
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
...         '//www.python.org/%7Eguido')
'http://www.python.org/%7Eguido'
@end example

Se você não quiser esse comportamento, pré-processe a `url' com @ref{d61,,urlsplit()} e @ref{16c0,,urlunsplit()}, removendo possíveis partes `scheme' e `netloc'.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Como uma URL absoluta pode ser passada como o parâmetro @code{url}, geralmente `não é seguro' usar @code{urljoin} com uma @code{url} controlada pelo invasor. Por exemplo, em @code{urljoin("https://website.com/users/", username)}, se @code{username} puder conter uma URL absoluta, o resultado de @code{urljoin} será a URL absoluta.
@end quotation
@end cartouche


Alterado na versão 3.5: Comportamento atualizado para corresponder à semântica definida no 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}.

@end deffn

@geindex urldefrag() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urldefrag}@anchor{1289}
@deffn {Função} urllib.parse.urldefrag (url)

Se `url' contiver um identificador de fragmento, retorna uma versão modificada de `url' sem identificador de fragmento, e o identificador de fragmento como uma string separada. Se não houver identificador de fragmento em `url', retorna `url' não modificado e uma string vazia.

O valor de retorno é uma @ref{64e,,tupla nomeada}, seus itens podem ser acessados por índice ou como atributos nomeados:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Índice

@tab

Valor

@tab

Valor, se não presente

@item

@code{url}

@tab

0

@tab

URL com nenhum fragmento

@tab

string vazia

@item

@code{fragment}

@tab

1

@tab

Identificador do fragmento

@tab

string vazia

@end multitable


Veja a seção @ref{3c54,,Structured Parse Results} para obter mais informações sobre o objeto de resultado.


Alterado na versão 3.2: O resultado é um objeto estruturado em vez de uma simples tupla de 2 elementos.

@end deffn

@geindex unwrap() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse unwrap}@anchor{3c56}
@deffn {Função} urllib.parse.unwrap (url)

Extrai a URL de uma URL encapsulada (ou seja, uma string formatada como @code{<URL:esquema://host/caminho>}, @code{<esquema://host/caminho>}, @code{URL:esquema://host/caminho} ou @code{esquema://host/caminho}). Se `url' não for uma URL encapsulada, ela será retornada sem alterações.
@end deffn

@node Segurança ao analisar URLs,Analisando bytes codificados em ASCII,Análise de URL,urllib parse — Analisa URLs para componentes
@anchor{library/urllib parse id1}@anchor{3c57}@anchor{library/urllib parse url-parsing-security}@anchor{3c55}
@subsubsection Segurança ao analisar URLs


As APIs @ref{d61,,urlsplit()} e @ref{30d,,urlparse()} não realizam `validação' de entradas. Elas podem não levantar erros em entradas que outras aplicações consideram inválidas. Elas também podem ter sucesso em algumas entradas que podem não ser consideradas URLs em outros lugares. Seu propósito é para funcionalidade prática em vez de pureza.

Em vez de levantar uma exceção em uma entrada incomum, eles podem retornar algumas partes do componente como strings vazias. Ou os componentes podem conter mais do que talvez devessem.

Recomendamos que os usuários dessas APIs, onde os valores podem ser usados em qualquer lugar com implicações de segurança, codifiquem defensivamente. Faça alguma verificação dentro do seu código antes de confiar em uma parte do componente retornada. Esse @code{esquema} faz sentido? Esse @code{caminho} sensato? Há algo estranho sobre esse @code{hostname}? etc.

O que constitui uma URL não é universalmente bem definido. Diferentes aplicações têm diferentes necessidades e restrições desejadas. Por exemplo, a especificação WHATWG@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser} descreve o que os clientes web voltados para o usuário, como um navegador web, exigem. Por outro lado, 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} é mais geral. Essas funções incorporam alguns aspectos de ambos, mas não podem ser reivindicadas como compatíveis com nenhum deles. As APIs e o código de usuário existente com expectativas sobre comportamentos específicos são anteriores a ambos os padrões, o que nos leva a ser muito cautelosos ao fazer alterações no comportamento da API.

@node Analisando bytes codificados em ASCII,Structured Parse Results,Segurança ao analisar URLs,urllib parse — Analisa URLs para componentes
@anchor{library/urllib parse id2}@anchor{3c58}@anchor{library/urllib parse parsing-ascii-encoded-bytes}@anchor{128b}
@subsubsection Analisando bytes codificados em ASCII


As funções de análise de URL foram originalmente projetadas para operar somente em strings de caracteres. Na prática, é útil ser capaz de manipular URLs corretamente citadas e codificadas como sequências de bytes ASCII. Consequentemente, todas as funções de análise de URL neste módulo operam em objetos @ref{1c2,,bytes} e @ref{2ea,,bytearray} além de objetos @ref{44c,,str}.

Se dados @ref{44c,,str} forem passados, o resultado também conterá apenas dados @ref{44c,,str}. Se dados @ref{1c2,,bytes} ou @ref{2ea,,bytearray} forem passados, o resultado conterá apenas dados @ref{1c2,,bytes}.

Tentar misturar dados @ref{44c,,str} com @ref{1c2,,bytes} ou @ref{2ea,,bytearray} em uma única chamada de função resultará em uma @ref{2c3,,TypeError} sendo levantada, enquanto tentar passar valores de bytes não-ASCII acionará @ref{a1d,,UnicodeDecodeError}.

Para prover uma conversão mais fácil de objetos de resultado entre @ref{44c,,str} e @ref{1c2,,bytes}, todos os valores de retorno das funções de análise de URL fornecem um método @code{encode()} (quando o resultado contém dados @ref{44c,,str}) ou um método @code{decode()} (quando o resultado contém dados @ref{1c2,,bytes}). As assinaturas desses métodos correspondem às dos métodos @ref{44c,,str} e @ref{1c2,,bytes} correspondentes (exceto que a codificação padrão é @code{'ascii'} em vez de @code{'utf-8'}). Cada um produz um valor de um tipo correspondente que contém dados @ref{1c2,,bytes} (para métodos @code{encode()}) ou dados @ref{44c,,str} (para métodos @code{decode()}).

Os aplicações que precisam operar em URLs possivelmente envolta em aspas de forma incorreta, e que podem conter dados não ASCII, precisarão fazer sua própria decodificação de bytes para caracteres antes de invocar os métodos de análise de URL.

O comportamento descrito nesta seção se aplica somente às funções de análise de URL. As funções de aplicação de aspas em URL usam suas próprias regras ao produzir ou consumir sequências de bytes, conforme detalhado na documentação das funções de citação de URL individuais.


Alterado na versão 3.2: As funções de análise de URL agora aceitam sequências de bytes codificadas em ASCII


@node Structured Parse Results,URL Quoting,Analisando bytes codificados em ASCII,urllib parse — Analisa URLs para componentes
@anchor{library/urllib parse structured-parse-results}@anchor{3c59}@anchor{library/urllib parse urlparse-result-object}@anchor{3c54}
@subsubsection Structured Parse Results


The result objects from the @ref{30d,,urlparse()}, @ref{d61,,urlsplit()}  and
@ref{1289,,urldefrag()} functions are subclasses of the @ref{370,,tuple} type.
These subclasses add the attributes listed in the documentation for
those functions, the encoding and decoding support described in the
previous section, as well as an additional method:

@geindex geturl() (método urllib.parse.urllib.parse.SplitResult)
@anchor{library/urllib parse urllib parse urllib parse SplitResult geturl}@anchor{3c5a}
@deffn {Método} urllib.parse.SplitResult.geturl ()

Return the re-combined version of the original URL as a string. This may
differ from the original URL in that the scheme may be normalized to lower
case and empty components may be dropped. Specifically, empty parameters,
queries, and fragment identifiers will be removed.

For @ref{1289,,urldefrag()} results, only empty fragment identifiers will be removed.
For @ref{d61,,urlsplit()} and @ref{30d,,urlparse()} results, all noted changes will be
made to the URL returned by this method.

The result of this method remains unchanged if passed back through the original
parsing function:

@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

The following classes provide the implementations of the structured parse
results when operating on @ref{44c,,str} objects:

@geindex DefragResult (classe em urllib.parse)
@anchor{library/urllib parse urllib parse DefragResult}@anchor{3c5b}
@deffn {Classe} urllib.parse.DefragResult (url, fragment)

Concrete class for @ref{1289,,urldefrag()} results containing @ref{44c,,str}
data. The @code{encode()} method returns a @ref{3c5c,,DefragResultBytes}
instance.


Adicionado na versão 3.2.

@end deffn

@geindex ParseResult (classe em urllib.parse)
@anchor{library/urllib parse urllib parse ParseResult}@anchor{3c5d}
@deffn {Classe} urllib.parse.ParseResult (scheme, netloc, path, params, query, fragment)

Concrete class for @ref{30d,,urlparse()} results containing @ref{44c,,str}
data. The @code{encode()} method returns a @ref{3c5e,,ParseResultBytes}
instance.
@end deffn

@geindex SplitResult (classe em urllib.parse)
@anchor{library/urllib parse urllib parse SplitResult}@anchor{3c5f}
@deffn {Classe} urllib.parse.SplitResult (scheme, netloc, path, query, fragment)

Concrete class for @ref{d61,,urlsplit()} results containing @ref{44c,,str}
data. The @code{encode()} method returns a @ref{3c60,,SplitResultBytes}
instance.
@end deffn

The following classes provide the implementations of the parse results when
operating on @ref{1c2,,bytes} or @ref{2ea,,bytearray} objects:

@geindex DefragResultBytes (classe em urllib.parse)
@anchor{library/urllib parse urllib parse DefragResultBytes}@anchor{3c5c}
@deffn {Classe} urllib.parse.DefragResultBytes (url, fragment)

Concrete class for @ref{1289,,urldefrag()} results containing @ref{1c2,,bytes}
data. The @code{decode()} method returns a @ref{3c5b,,DefragResult}
instance.


Adicionado na versão 3.2.

@end deffn

@geindex ParseResultBytes (classe em urllib.parse)
@anchor{library/urllib parse urllib parse ParseResultBytes}@anchor{3c5e}
@deffn {Classe} urllib.parse.ParseResultBytes (scheme, netloc, path, params, query, fragment)

Concrete class for @ref{30d,,urlparse()} results containing @ref{1c2,,bytes}
data. The @code{decode()} method returns a @ref{3c5d,,ParseResult}
instance.


Adicionado na versão 3.2.

@end deffn

@geindex SplitResultBytes (classe em urllib.parse)
@anchor{library/urllib parse urllib parse SplitResultBytes}@anchor{3c60}
@deffn {Classe} urllib.parse.SplitResultBytes (scheme, netloc, path, query, fragment)

Concrete class for @ref{d61,,urlsplit()} results containing @ref{1c2,,bytes}
data. The @code{decode()} method returns a @ref{3c5f,,SplitResult}
instance.


Adicionado na versão 3.2.

@end deffn

@node URL Quoting,,Structured Parse Results,urllib parse — Analisa URLs para componentes
@anchor{library/urllib parse url-quoting}@anchor{3c61}
@subsubsection URL Quoting


The URL quoting functions focus on taking program data and making it safe
for use as URL components by quoting special characters and appropriately
encoding non-ASCII text. They also support reversing these operations to
recreate the original data from the contents of a URL component if that
task isn’t already covered by the URL parsing functions above.

@geindex quote() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote}@anchor{bbb}
@deffn {Função} urllib.parse.quote (string, safe='/', encoding=None, errors=None)

Replace special characters in `string' using the @code{%@var{xx}} escape. Letters,
digits, and the characters @code{'_.-~'} are never quoted. By default, this
function is intended for quoting the path section of a URL. The optional
`safe' parameter specifies additional ASCII characters that should not be
quoted — its default value is @code{'/'}.

`string' may be either a @ref{44c,,str} or a @ref{1c2,,bytes} object.


Alterado na versão 3.7: Moved from 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} to 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} for quoting URL strings. “~” is now
included in the set of unreserved characters.


The optional `encoding' and `errors' parameters specify how to deal with
non-ASCII characters, as accepted by the @ref{8db,,str.encode()} method.
`encoding' defaults to @code{'utf-8'}.
`errors' defaults to @code{'strict'}, meaning unsupported characters raise a
@ref{677,,UnicodeEncodeError}.
`encoding' and `errors' must not be supplied if `string' is a
@ref{1c2,,bytes}, or a @ref{2c3,,TypeError} is raised.

Note that @code{quote(string, safe, encoding, errors)} is equivalent to
@code{quote_from_bytes(string.encode(encoding, errors), safe)}.

Example: @code{quote('/El Niño/')} yields @code{'/El%20Ni%C3%B1o/'}.
@end deffn

@geindex quote_plus() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote_plus}@anchor{128a}
@deffn {Função} urllib.parse.quote_plus (string, safe='@w{'}, encoding=None, errors=None)

Like @ref{bbb,,quote()}, but also replace spaces with plus signs, as required for
quoting HTML form values when building up a query string to go into a URL.
Plus signs in the original string are escaped unless they are included in
`safe'.  It also does not have `safe' default to @code{'/'}.

Example: @code{quote_plus('/El Niño/')} yields @code{'%2FEl+Ni%C3%B1o%2F'}.
@end deffn

@geindex quote_from_bytes() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse quote_from_bytes}@anchor{18da}
@deffn {Função} urllib.parse.quote_from_bytes (bytes, safe='/')

Like @ref{bbb,,quote()}, but accepts a @ref{1c2,,bytes} object rather than a
@ref{44c,,str}, and does not perform string-to-bytes encoding.

Example: @code{quote_from_bytes(b'a&\xef')} yields
@code{'a%26%EF'}.
@end deffn

@geindex unquote() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote}@anchor{1883}
@deffn {Função} urllib.parse.unquote (string, encoding='utf-8', errors='replace')

Replace @code{%@var{xx}} escapes with their single-character equivalent.
The optional `encoding' and `errors' parameters specify how to decode
percent-encoded sequences into Unicode characters, as accepted by the
@ref{8dc,,bytes.decode()} method.

`string' may be either a @ref{44c,,str} or a @ref{1c2,,bytes} object.

`encoding' defaults to @code{'utf-8'}.
`errors' defaults to @code{'replace'}, meaning invalid sequences are replaced
by a placeholder character.

Example: @code{unquote('/El%20Ni%C3%B1o/')} yields @code{'/El Niño/'}.


Alterado na versão 3.9: `string' parameter supports bytes and str objects (previously only str).

@end deffn

@geindex unquote_plus() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote_plus}@anchor{3c62}
@deffn {Função} urllib.parse.unquote_plus (string, encoding='utf-8', errors='replace')

Like @ref{1883,,unquote()}, but also replace plus signs with spaces, as required
for unquoting HTML form values.

`string' must be a @ref{44c,,str}.

Example: @code{unquote_plus('/El+Ni%C3%B1o/')} yields @code{'/El Niño/'}.
@end deffn

@geindex unquote_to_bytes() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse unquote_to_bytes}@anchor{1884}
@deffn {Função} urllib.parse.unquote_to_bytes (string)

Replace @code{%@var{xx}} escapes with their single-octet equivalent, and return a
@ref{1c2,,bytes} object.

`string' may be either a @ref{44c,,str} or a @ref{1c2,,bytes} object.

If it is a @ref{44c,,str}, unescaped non-ASCII characters in `string'
are encoded into UTF-8 bytes.

Example: @code{unquote_to_bytes('a%26%EF')} yields @code{b'a&\xef'}.
@end deffn

@geindex urlencode() (no módulo urllib.parse)
@anchor{library/urllib parse urllib parse urlencode}@anchor{ec4}
@deffn {Função} urllib.parse.urlencode (query, doseq=False, safe='@w{'}, encoding=None, errors=None, quote_via=quote_plus)

Convert a mapping object or a sequence of two-element tuples, which may
contain @ref{44c,,str} or @ref{1c2,,bytes} objects, to a percent-encoded ASCII
text string.  If the resultant string is to be used as a `data' for POST
operation with the @ref{293,,urlopen()} function, then
it should be encoded to bytes, otherwise it would result in a
@ref{2c3,,TypeError}.

The resulting string is a series of @code{key=value} pairs separated by @code{'&'}
characters, where both `key' and `value' are quoted using the `quote_via'
function.  By default, @ref{128a,,quote_plus()} is used to quote the values, which
means spaces are quoted as a @code{'+'} character and ‘/’ characters are
encoded as @code{%2F}, which follows the standard for GET requests
(@code{application/x-www-form-urlencoded}).  An alternate function that can be
passed as `quote_via' is @ref{bbb,,quote()}, which will encode spaces as @code{%20}
and not encode ‘/’ characters.  For maximum control of what is quoted, use
@code{quote} and specify a value for `safe'.

When a sequence of two-element tuples is used as the `query'
argument, the first element of each tuple is a key and the second is a
value. The value element in itself can be a sequence and in that case, if
the optional parameter `doseq' evaluates to @code{True}, individual
@code{key=value} pairs separated by @code{'&'} are generated for each element of
the value sequence for the key.  The order of parameters in the encoded
string will match the order of parameter tuples in the sequence.

The `safe', `encoding', and `errors' parameters are passed down to
`quote_via' (the `encoding' and `errors' parameters are only passed
when a query element is a @ref{44c,,str}).

To reverse this encoding process, @ref{27a,,parse_qs()} and @ref{279,,parse_qsl()} are
provided in this module to parse query strings into Python data structures.

Refer to @ref{3c3f,,urllib examples} to find out how the
@ref{ec4,,urllib.parse.urlencode()} method can be used for generating the query
string of a URL or data for a POST request.


Alterado na versão 3.2: `query' supports bytes and string objects.



Alterado na versão 3.5: Added the `quote_via' parameter.

@end deffn


@subsubheading Ver também



@table @asis

@item WHATWG@footnote{https://url.spec.whatwg.org/} -  URL Living standard

Working Group for the URL Standard that defines URLs, domains, IP addresses, the
application/x-www-form-urlencoded format, and their API.

@geindex RFC; RFC 3986

@item RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} - Uniform Resource Identifiers

This is the current standard (STD66). Any changes to urllib.parse module
should conform to this. Certain deviations could be observed, which are
mostly for backward compatibility purposes and for certain de-facto
parsing requirements as commonly observed in major browsers.

@geindex RFC; RFC 2732

@item RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} - Format for Literal IPv6 Addresses in URL’s.

This specifies the parsing requirements of IPv6 URLs.

@geindex RFC; RFC 2396

@item RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} - Uniform Resource Identifiers (URI): Generic Syntax

Document describing the generic syntactic requirements for both Uniform Resource
Names (URNs) and Uniform Resource Locators (URLs).

@geindex RFC; RFC 2368

@item RFC 2368@footnote{https://datatracker.ietf.org/doc/html/rfc2368.html} - O esquema de URL mailto.

Parsing requirements for mailto URL schemes.

@geindex RFC; RFC 1808

@item RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} - Relative Uniform Resource Locators

This Request For Comments includes the rules for joining an absolute and a
relative URL, including a fair number of “Abnormal Examples” which govern the
treatment of border cases.

@geindex RFC; RFC 1738

@item RFC 1738@footnote{https://datatracker.ietf.org/doc/html/rfc1738.html} - Uniform Resource Locators (URL)

This specifies the formal syntax and semantics of absolute URLs.
@end table


@node urllib error — Classes de exceção levantadas por urllib request,urllib robotparser — Analisador sintático de robots txt,urllib parse — Analisa URLs para componentes,Protocolos de Internet e Suporte
@anchor{library/urllib error doc}@anchor{3c63}@anchor{library/urllib error module-urllib error}@anchor{109}@anchor{library/urllib error translation-repo}@anchor{3c64}@anchor{library/urllib error urllib-error-exception-classes-raised-by-urllib-request}@anchor{3c65}
@subsection @code{urllib.error} — Classes de exceção levantadas por urllib.request


@geindex module; urllib.error

`Código-fonte:' Lib/urllib/error.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/urllib/error.py}


__________________________________________________________________


O módulo @ref{109,,urllib.error} define as classes de exceção para exceções levantadas por @ref{10b,,urllib.request}. A classe de exceção base é @ref{3bca,,URLError}.

As seguintes exceções são levantadas por @ref{109,,urllib.error} conforme apropriado:

@geindex URLError
@anchor{library/urllib error urllib error URLError}@anchor{3bca}
@deffn {Exceção} urllib.error.URLError

Os manipuladores levantam essa exceção (ou exceções derivadas) quando encontram um problema. É uma subclasse de @ref{417,,OSError}.

@geindex reason (atributo urllib.error.URLError)
@anchor{library/urllib error urllib error URLError reason}@anchor{3c66}
@deffn {Atributo} reason

O motivo desse erro. Pode ser uma string de mensagem ou outra instância de exceção.
@end deffn


Alterado na versão 3.3: @ref{3bca,,URLError} costumava ser um subtipo de @ref{108b,,IOError}, que agora é um apelido de @ref{417,,OSError}.

@end deffn

@geindex HTTPError
@anchor{library/urllib error urllib error HTTPError}@anchor{1014}
@deffn {Exceção} urllib.error.HTTPError (url, code, msg, hdrs, fp)

Embora seja uma exceção (uma subclasse de @ref{3bca,,URLError}), uma @ref{1014,,HTTPError} também pode funcionar como um valor de retorno não excepcional do tipo arquivo (a mesma coisa que @ref{293,,urlopen()} retorna). Isso é útil ao lidar com erros de HTTP exóticos, como solicitações de autenticação.

@geindex url (atributo urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError url}@anchor{3c67}
@deffn {Atributo} url

Contém a solicitação URL. Um apelido para `nome do arquivo' atributo.
@end deffn

@geindex code (atributo urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError code}@anchor{3c68}
@deffn {Atributo} code

Um código de status HTTP conforme definido em 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. Este valor numérico corresponde a um valor encontrado no dicionário de códigos conforme encontrado em @ref{3c69,,http.server.BaseHTTPRequestHandler.responses}.
@end deffn

@geindex reason (atributo urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError reason}@anchor{3c6a}
@deffn {Atributo} reason

Geralmente é uma string explicando o motivo desse erro. Um apelido para o atributo `msg'.
@end deffn

@geindex headers (atributo urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError headers}@anchor{1015}
@deffn {Atributo} headers

Os cabeçalhos de resposta HTTP para a solicitação HTTP que causou a @ref{1014,,HTTPError}. Um apelido para o atributo `hdrs'.


Adicionado na versão 3.4.

@end deffn

@geindex fp (atributo urllib.error.HTTPError)
@anchor{library/urllib error urllib error HTTPError fp}@anchor{3c6b}
@deffn {Atributo} fp

Um objeto arquivo ou similar no qual o corpo do HTTP erro pode ser lido.
@end deffn
@end deffn

@geindex ContentTooShortError
@anchor{library/urllib error urllib error ContentTooShortError}@anchor{3c42}
@deffn {Exceção} urllib.error.ContentTooShortError (msg, content)

Esta exceção é levantada quando a função @ref{3c41,,urlretrieve()} detecta que a quantidade de dados baixados é menor que a quantidade esperada (fornecida pelo cabeçalho `Content-Length').

@geindex content (atributo urllib.error.ContentTooShortError)
@anchor{library/urllib error urllib error ContentTooShortError content}@anchor{3c6c}
@deffn {Atributo} content

Os dados baixados (e supostamente truncados).
@end deffn
@end deffn

@node urllib robotparser — Analisador sintático de robots txt,http — módulos HTTP,urllib error — Classes de exceção levantadas por urllib request,Protocolos de Internet e Suporte
@anchor{library/urllib robotparser doc}@anchor{3c6d}@anchor{library/urllib robotparser module-urllib robotparser}@anchor{10d}@anchor{library/urllib robotparser translation-repo}@anchor{3c6e}@anchor{library/urllib robotparser urllib-robotparser-parser-for-robots-txt}@anchor{3c6f}
@subsection @code{urllib.robotparser} —  Analisador sintático de robots.txt


@geindex module; urllib.robotparser

`Código-fonte:' Lib/urllib/robotparser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/urllib/robotparser.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex robots.txt


__________________________________________________________________


Este módulo fornece uma única classe, @ref{d1f,,RobotFileParser}, que responde a perguntas sobre se um agente de usuário específico pode ou não buscar uma URL no site que publicou o arquivo @code{robots.txt}. Para mais detalhes sobre a estrutura dos arquivos @code{robots.txt}, consulte @indicateurl{http://www.robotstxt.org/orig.html}.

@geindex RobotFileParser (classe em urllib.robotparser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser}@anchor{d1f}
@deffn {Classe} urllib.robotparser.RobotFileParser (url='@w{'})

Esta classe fornece métodos para ler, analisar e responder perguntas sobre o arquivo @code{robots.txt} em `url'.

@geindex set_url() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser set_url}@anchor{3c70}
@deffn {Método} set_url (url)

Define a URL referente a um arquivo @code{robots.txt}.
@end deffn

@geindex read() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser read}@anchor{3c71}
@deffn {Método} read ()

Lê o URL @code{robots.txt} e o alimenta para o analisador sintático.
@end deffn

@geindex parse() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser parse}@anchor{1c1c}
@deffn {Método} parse (lines)

Analisa o argumento de linhas.
@end deffn

@geindex can_fetch() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser can_fetch}@anchor{3c72}
@deffn {Método} can_fetch (useragent, url)

Retorna @code{True} se o `useragent' tiver permissão para buscar a `url' de acordo com as regras contidas no arquivo @code{robots.txt} analisado.
@end deffn

@geindex mtime() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser mtime}@anchor{3c73}
@deffn {Método} mtime ()

Retorna o horário em que o arquivo @code{robots.txt} foi buscado pela última vez. Isso é útil para web spiders de longa duração que precisam verificar novos arquivos @code{robots.txt} periodicamente.
@end deffn

@geindex modified() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser modified}@anchor{3c74}
@deffn {Método} modified ()

Define a hora em que o arquivo @code{robots.txt} foi buscado pela última vez para a hora atual.
@end deffn

@geindex crawl_delay() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser crawl_delay}@anchor{3c75}
@deffn {Método} crawl_delay (useragent)

Retorna o valor do parâmetro @code{Crawl-delay} de @code{robots.txt} para o `useragent' em questão. Se não houver tal parâmetro ou se ele não se aplicar ao `useragent' especificado ou se a entrada @code{robots.txt} para este parâmetro tiver sintaxe inválida, retorna @code{None}.


Adicionado na versão 3.6.

@end deffn

@geindex request_rate() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser request_rate}@anchor{3c76}
@deffn {Método} request_rate (useragent)

Retorna o conteúdo do parâmetro @code{Request-rate} de @code{robots.txt} como uma @ref{64e,,tupla nomeada} @code{RequestRate(requests, seconds)}. Se não houver tal parâmetro ou se ele não se aplicar ao `useragent' especificado ou se a entrada @code{robots.txt} para este parâmetro tiver sintaxe inválida, retorna @code{None}.


Adicionado na versão 3.6.

@end deffn

@geindex site_maps() (método urllib.robotparser.RobotFileParser)
@anchor{library/urllib robotparser urllib robotparser RobotFileParser site_maps}@anchor{1bb9}
@deffn {Método} site_maps ()

Retorna o conteúdo do parâmetro @code{Sitemap} de @code{robots.txt} no formato de uma @ref{611,,list()}. Se não houver tal parâmetro ou a entrada @code{robots.txt} para este parâmetro tiver sintaxe inválida, retorna @code{None}.


Adicionado na versão 3.8.

@end deffn
@end deffn

O exemplo a seguir demonstra o uso básico da classe @ref{d1f,,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 — módulos HTTP,http client — HTTP protocol client,urllib robotparser — Analisador sintático de robots txt,Protocolos de Internet e Suporte
@anchor{library/http doc}@anchor{3c77}@anchor{library/http http-http-modules}@anchor{3c78}@anchor{library/http module-http}@anchor{6e}@anchor{library/http translation-repo}@anchor{3c79}
@subsection @code{http} — módulos HTTP


@geindex module; http

`Código-fonte:' Lib/http/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/__init__.py}

@geindex HTTP;protocolo
@geindex HTTP;http (módulo padrão)


__________________________________________________________________


@ref{6e,,http} é um pacote que coleta vários módulos para trabalhar com o Protocolo de Transferência de Hipertexto:


@itemize *

@item 
@ref{6f,,http.client} é um cliente de protocolo HTTP de baixo nível; para abertura de URL de alto nível, use @ref{10b,,urllib.request}

@item 
@ref{72,,http.server} contém classes básicas de servidor HTTP baseadas em @ref{cd,,socketserver}

@item 
@ref{71,,http.cookies} tem utilidades para implementar gerenciamento de estado com cookies

@item 
@ref{70,,http.cookiejar} provê persistência de cookies
@end itemize

O módulo @ref{6e,,http} também define os seguintes enums que podem ajudar você a trabalhar com os status code http relacionados:

@geindex HTTPStatus (classe em http)
@anchor{library/http http HTTPStatus}@anchor{906}
@deffn {Classe} http.HTTPStatus


Adicionado na versão 3.5.


Subclasse de @ref{d00,,enum.IntEnum} que define um conjunto de códigos de status HTTP, frases de razão e descrições longas escritas em 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 status HTTP:: 
* Categorias de HTTP status:: 
* Métodos HTTP:: 

@end menu

@node códigos de status HTTP,Categorias de HTTP status,,http — módulos HTTP
@anchor{library/http http-status-codes}@anchor{3c7a}@anchor{library/http id1}@anchor{3c7b}
@subsubsection códigos de status HTTP


Suportados, códigos de status registrados no IANA@footnote{https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml} disponíveis em @ref{906,,http.HTTPStatus} são:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Código

@tab

Nome da Enumeração

@tab

Detalhes

@item

@code{100}

@tab

@code{CONTINUE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, seção 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}, seção 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}, Seção 10.1

@item

@code{103}

@tab

@code{EARLY_HINTS}

@tab

Um código de status HTTP para indicar dicas 
@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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, Seção 11.1

@item

@code{208}

@tab

@code{ALREADY_REPORTED}

@tab

Extensões Vinculadas WebDAV 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Seção 7.1 (Experimental)

@item

@code{226}

@tab

@code{IM_USED}

@tab

Codificador Delta em HTTP 
@geindex RFC; RFC 3229
RFC 3229@footnote{https://datatracker.ietf.org/doc/html/rfc3229.html}, Seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, Seção 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}, seção 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}, seção 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}, Seção 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}, Seção 11.4

@item

@code{425}

@tab

@code{TOO_EARLY}

@tab

Usando dados antecipados em 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}, seção 15.5.22

@item

@code{428}

@tab

@code{PRECONDITION_REQUIRED}

@tab

Códigos de Status HTTP Adicionais 
@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 Status HTTP Adicionais 
@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 Status HTTP Adicionais 
@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

Um Código de Status HTTP para Relatar Obstáculos Legais 
@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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 15.6.6

@item

@code{506}

@tab

@code{VARIANT_ALSO_NEGOTIATES}

@tab

Negociação Transparente de Conteúdo em HTTP 
@geindex RFC; RFC 2295
RFC 2295@footnote{https://datatracker.ietf.org/doc/html/rfc2295.html}, Seção 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}, Seção 11.5

@item

@code{508}

@tab

@code{LOOP_DETECTED}

@tab

Extensões de Ligação WebDAV 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Seção 7.2 (Experimental)

@item

@code{510}

@tab

@code{NOT_EXTENDED}

@tab

Um Framework de Extensão HTTP 
@geindex RFC; RFC 2774
RFC 2774@footnote{https://datatracker.ietf.org/doc/html/rfc2774.html}, Seção 7 (Experimental)

@item

@code{511}

@tab

@code{NETWORK_AUTHENTICATION_REQUIRED}

@tab

Códigos de Status HTTP Adicionais 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}, Seção 6

@end multitable


Para preservar compatibilidade anterior, valores de enumerações também estão presentes no módulo @ref{6f,,http.client} na forma de constantes. O nome da enumeração é igual ao nome da constante (i.e. @code{http.HTTPStatus.OK} também está disponível como @code{http.client.OK}).


Alterado na versão 3.7: Código de status @code{421 MISDIRECTED_REQUEST} adicionado.



Adicionado na versão 3.8: Código de status @code{451 UNAVAILABLE_FOR_LEGAL_REASONS} adicionado.



Adicionado na versão 3.9: Adicionados os códigos de status @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} e @code{425 TOO_EARLY}.



Alterado na versão 3.13: Implementada a nomenclatura do RFC9110 para constantes de status. Os nomes antigos das constantes foram preservados para compatibilidade com versões anteriores: @code{413 REQUEST_ENTITY_TOO_LARGE}, @code{414 REQUEST_URI_TOO_LONG}, @code{416 REQUESTED_RANGE_NOT_SATISFIABLE} e @code{422 UNPROCESSABLE_ENTITY}.


@node Categorias de HTTP status,Métodos HTTP,códigos de status HTTP,http — módulos HTTP
@anchor{library/http http-status-category}@anchor{3c7c}
@subsubsection Categorias de HTTP status



Adicionado na versão 3.12.


Os valores enum possuem várias propriedades que indicam a categoria do status HTTP.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Propriedade

@tab

Indica que

@tab

Detalhes

@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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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 (classe em http)
@anchor{library/http http HTTPMethod}@anchor{3c7d}
@deffn {Classe} http.HTTPMethod


Adicionado na versão 3.11.


Subclasse de @ref{61a,,enum.StrEnum} que define um conjunto de métodos HTTP e descrições escritas em 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,,Categorias de HTTP status,http — módulos HTTP
@anchor{library/http http-methods}@anchor{3c7e}@anchor{library/http id2}@anchor{3c7f}
@subsubsection Métodos HTTP


Suportados, métodos registrados no IANA@footnote{https://www.iana.org/assignments/http-methods/http-methods.xhtml} disponíveis em @ref{3c7d,,http.HTTPMethod} são:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Nome da Enumeração

@tab

Detalhes

@item

@code{GET}

@tab

@code{GET}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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}, seção 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 — módulos HTTP,Protocolos de Internet e Suporte
@anchor{library/http client doc}@anchor{3c80}@anchor{library/http client http-client-http-protocol-client}@anchor{3c81}@anchor{library/http client module-http client}@anchor{6f}@anchor{library/http client translation-repo}@anchor{3c82}
@subsection @code{http.client} — HTTP protocol client


@geindex module; http.client

`Código-fonte:' Lib/http/client.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/client.py}

@geindex HTTP;protocolo
@geindex HTTP;http.client (standard module)

@geindex módulo;urllib.request


__________________________________________________________________


This module defines classes that implement the client side of the HTTP and
HTTPS protocols.  It is normally not used directly — the module
@ref{10b,,urllib.request} uses it to handle URLs that use HTTP and HTTPS.


@subsubheading Ver também


The Requests package@footnote{https://requests.readthedocs.io/en/latest/}
is recommended for a higher-level HTTP client interface.


@cartouche
@quotation Nota 
Suporte HTTPS está disponível somente se Python foi compilado com suporte SSL (através do módulo @ref{d0,,ssl}).
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

O módulo fornece as seguintes classes:

@geindex HTTPConnection (classe em http.client)
@anchor{library/http client http client HTTPConnection}@anchor{b53}
@deffn {Classe} http.client.HTTPConnection (host, port=None[, timeout], source_address=None, blocksize=8192)

An @ref{b53,,HTTPConnection} instance represents one transaction with an HTTP
server.  It should be instantiated by passing it a host and optional port
number.  If no port number is passed, the port is extracted from the host
string if it has the form @code{host:port}, else the default HTTP port (80) is
used.  If the optional `timeout' parameter is given, blocking
operations (like connection attempts) will timeout after that many seconds
(if it is not given, the global default timeout setting is used).
The optional `source_address' parameter may be a tuple of a (host, port)
to use as the source address the HTTP connection is made from.
The optional `blocksize' parameter sets the buffer size in bytes for
sending a file-like message body.

Por exemplo, todas as seguintes chamadas criam instâncias que conectam ao servidor com o mesmo host e porta:

@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


Alterado na versão 3.2: `source_address' foi adicionado.



Alterado na versão 3.4: The  `strict' parameter was removed. HTTP 0.9-style “Simple Responses” are
no longer supported.



Alterado na versão 3.7: O argumento `blocksize' foi adicionado.

@end deffn

@geindex HTTPSConnection (classe em http.client)
@anchor{library/http client http client HTTPSConnection}@anchor{b54}
@deffn {Classe} http.client.HTTPSConnection (host, port=None, *[, timeout], source_address=None, context=None, blocksize=8192)

Uma subclasse de @ref{b53,,HTTPConnection} que utiliza SSL para comunicação com servidores seguros. A porta padrão é @code{443}. Se `context' for especificado, ele deve ser uma instância de @ref{294,,ssl.SSLContext} descrevendo as várias opções do SSL.

Por favor leia @ref{354c,,Considerações de segurança} para mais informações sobre as melhores práticas.


Alterado na versão 3.2: `source_address', `context' e `check_hostname' foram adicionados.



Alterado na versão 3.2: This class now supports HTTPS virtual hosts if possible (that is,
if @ref{3688,,ssl.HAS_SNI} is true).



Alterado na versão 3.4: O argumento `strict' foi removido. “Respostas Simples” HTTP com o estilo 0.9 não são mais suportadas.



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



Alterado na versão 3.8: Esta classe agora habilita TLS 1.3 @ref{a3b,,ssl.SSLContext.post_handshake_auth} para o padrão `context' ou quanto `cert_file' é fornecido com um `context' personalizado.



Alterado na versão 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{e93,,set_alpn_protocols()}.



Alterado na versão 3.12: The deprecated `key_file', `cert_file' and `check_hostname' parameters
have been removed.

@end deffn

@geindex HTTPResponse (classe em http.client)
@anchor{library/http client http client HTTPResponse}@anchor{110d}
@deffn {Classe} http.client.HTTPResponse (sock, debuglevel=0, method=None, url=None)

Classe em que instâncias são retornadas mediante de conexão bem-sucedida. Não é instanciável diretamente pelo usuário.


Alterado na versão 3.4: O argumento `strict' foi removido. “Respostas Simples” HTTP com o estilo 0.9 não são mais suportadas.

@end deffn

Este módulo fornece a seguinte função:

@geindex parse_headers() (no módulo http.client)
@anchor{library/http client http client parse_headers}@anchor{1bc1}
@deffn {Função} 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{694,,BufferedIOBase} reader
(i.e. not text) and must provide a valid 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} style header.

Esta função retorna uma instância de @ref{3c83,,http.client.HTTPMessage} que armazena os campos do cabeçalho, mas não o payload (o mesmo que @ref{3c84,,HTTPResponse.msg} e @ref{3c85,,http.server.BaseHTTPRequestHandler.headers}). Depois de retornar, o ponteiro de arquivo `fp' está pronto para ler o corpo da requisição HTTP.

@cartouche
@quotation Nota 
@ref{1bc1,,parse_headers()} não analisa a linha inicial de uma mensagem HTTP; ele apenas analisa as linhas de @code{Name: value}. O arquivo deve estar pronto para ler essas linhas de campo, então a primeira linha já deve ter sido consumida antes de chamar a função.
@end quotation
@end cartouche
@end deffn

As seguintes exceções são levantadas conforme apropriado:

@geindex HTTPException
@anchor{library/http client http client HTTPException}@anchor{3c86}
@deffn {Exceção} http.client.HTTPException

A classe base das outras exceções neste módulo. É uma subclasse de @ref{9e2,,Exception}.
@end deffn

@geindex NotConnected
@anchor{library/http client http client NotConnected}@anchor{3c87}
@deffn {Exceção} http.client.NotConnected

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex InvalidURL
@anchor{library/http client http client InvalidURL}@anchor{3c88}
@deffn {Exceção} http.client.InvalidURL

Uma subclasse de @ref{3c86,,HTTPException}, levantada se uma porta é fornecida e esta é não-numérica ou vazia.
@end deffn

@geindex UnknownProtocol
@anchor{library/http client http client UnknownProtocol}@anchor{3c89}
@deffn {Exceção} http.client.UnknownProtocol

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex UnknownTransferEncoding
@anchor{library/http client http client UnknownTransferEncoding}@anchor{3c8a}
@deffn {Exceção} http.client.UnknownTransferEncoding

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex UnimplementedFileMode
@anchor{library/http client http client UnimplementedFileMode}@anchor{3c8b}
@deffn {Exceção} http.client.UnimplementedFileMode

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex IncompleteRead
@anchor{library/http client http client IncompleteRead}@anchor{3c8c}
@deffn {Exceção} http.client.IncompleteRead

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex ImproperConnectionState
@anchor{library/http client http client ImproperConnectionState}@anchor{3c8d}
@deffn {Exceção} http.client.ImproperConnectionState

Uma subclasse de @ref{3c86,,HTTPException}.
@end deffn

@geindex CannotSendRequest
@anchor{library/http client http client CannotSendRequest}@anchor{3c8e}
@deffn {Exceção} http.client.CannotSendRequest

Uma subclasse de @ref{3c8d,,ImproperConnectionState}.
@end deffn

@geindex CannotSendHeader
@anchor{library/http client http client CannotSendHeader}@anchor{3c8f}
@deffn {Exceção} http.client.CannotSendHeader

Uma subclasse de @ref{3c8d,,ImproperConnectionState}.
@end deffn

@geindex ResponseNotReady
@anchor{library/http client http client ResponseNotReady}@anchor{3c90}
@deffn {Exceção} http.client.ResponseNotReady

Uma subclasse de @ref{3c8d,,ImproperConnectionState}.
@end deffn

@geindex BadStatusLine
@anchor{library/http client http client BadStatusLine}@anchor{3c91}
@deffn {Exceção} http.client.BadStatusLine

Uma subclasse de @ref{3c86,,HTTPException}. Levantada se um servidor responde com um código de status HTTP que não é entendido.
@end deffn

@geindex LineTooLong
@anchor{library/http client http client LineTooLong}@anchor{3c92}
@deffn {Exceção} http.client.LineTooLong

Uma subclasse de @ref{3c86,,HTTPException}. Levantada se uma linha excessivamente longa é recebida, do servidor, no protocolo HTTP.
@end deffn

@geindex RemoteDisconnected
@anchor{library/http client http client RemoteDisconnected}@anchor{e35}
@deffn {Exceção} http.client.RemoteDisconnected

Uma subclasse de @ref{1098,,ConnectionResetError} e @ref{3c91,,BadStatusLine}. Levantada por @ref{e34,,HTTPConnection.getresponse()} quando a tentativa de ler a resposta resulta na não leitura dos dados pela conexão, indicando que o fim remoto fechou a conexão.


Adicionado na versão 3.5: Anteriormente, a exceção @ref{3c91,,BadStatusLine}@code{('@w{'})} foi levantada.

@end deffn

As constantes definidas neste módulo são:

@geindex HTTP_PORT (no módulo http.client)
@anchor{library/http client http client HTTP_PORT}@anchor{3c93}
@deffn {Dado} http.client.HTTP_PORT

A porta padrão para o protocolo HTTP (sempre @code{80}).
@end deffn

@geindex HTTPS_PORT (no módulo http.client)
@anchor{library/http client http client HTTPS_PORT}@anchor{3c94}
@deffn {Dado} http.client.HTTPS_PORT

A porta padrão para o protocolo HTTPS (sempre @code{443}).
@end deffn

@geindex responses (no módulo http.client)
@anchor{library/http client http client responses}@anchor{3c95}
@deffn {Dado} http.client.responses

Este dicionário mapeia os códigos de status HTTP 1.1 para os nomes em W3C.

Exemplo: @code{http.client.responses[http.client.NOT_FOUND]} é @code{'Not Found'}.
@end deffn

Ver @ref{3c7a,,códigos de status HTTP} para uma lista de códigos de status HTTP que estão disponíveis neste módulo como constantes.

@menu
* Objetos de HTTPConnection:: 
* Objetos HTTPResponse:: 
* Exemplos: Exemplos<27>. 
* HTTPMessage Objects:: 

@end menu

@node Objetos de HTTPConnection,Objetos HTTPResponse,,http client — HTTP protocol client
@anchor{library/http client httpconnection-objects}@anchor{3c96}@anchor{library/http client id1}@anchor{3c97}
@subsubsection Objetos de HTTPConnection


Instâncias @ref{b53,,HTTPConnection} contêm os seguintes métodos:

@geindex request() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection request}@anchor{cc9}
@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).

Se `body' é especificado, os dados especificados são mandados depois que os cabeçalhos estão prontos. Pode ser um @ref{44c,,str}, um @ref{d4f,,objeto bytes ou similar}, um @ref{1203,,objeto arquivo} aberto, ou um iterável de @ref{1c2,,bytes}. Se `body' é uma string, ele é codificado como ISO-8859-1, o padrão para HTTP. Se é um objeto bytes ou similar, os bytes são enviados como estão. Se é um @ref{1203,,objeto arquivo}, o conteúdo do arquivo é enviado; este objeto arquivo deve oferecer suporte a pelo menos o método @code{read()}. Se o objeto arquivo é uma instância de @ref{695,,io.TextIOBase}, os dados retornados pelo método @code{read()} será codificado como ISO-8859-1, de outra forma os dados retornados por @code{read()} são enviados como estão. Se `body' é um iterável, os elementos do iterável são enviados até o iterável se esgotar.

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

If `headers' contains neither Content-Length nor Transfer-Encoding,
but there is a request body, one of those
header fields will be added automatically.  If
`body' is @code{None}, the Content-Length header is set to @code{0} for
methods that expect a body (@code{PUT}, @code{POST}, and @code{PATCH}).  If
`body' is a string or a bytes-like object that is not also a
@ref{1203,,file}, the Content-Length header is
set to its length.  Any other type of `body' (files
and iterables in general) will be chunk-encoded, and the
Transfer-Encoding header will automatically be set instead of
Content-Length.

The `encode_chunked' argument is only relevant if Transfer-Encoding is
specified in `headers'.  If `encode_chunked' is @code{False}, the
HTTPConnection object assumes that all encoding is handled by the
calling code.  If it is @code{True}, the body will be chunk-encoded.

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 
Chunked transfer encoding has been added to the HTTP protocol
version 1.1.  Unless the HTTP server is known to handle HTTP 1.1,
the caller must either specify the Content-Length, or must pass a
@ref{44c,,str} or bytes-like object that is not also a file as the
body representation.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Note that you must have read the whole response or call @ref{3c98,,close()}
if @ref{e34,,getresponse()} raised an non-@ref{e36,,ConnectionError} exception
before you can send a new request to the server.
@end quotation
@end cartouche


Alterado na versão 3.2: `body' pode agora ser um iterável.



Alterado na versão 3.6: If neither Content-Length nor Transfer-Encoding are set in
`headers', file and iterable `body' objects are now chunk-encoded.
The `encode_chunked' argument was added.
No attempt is made to determine the Content-Length for file
objects.

@end deffn

@geindex getresponse() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection getresponse}@anchor{e34}
@deffn {Método} HTTPConnection.getresponse ()

Should be called after a request is sent to get the response from the server.
Returns an @ref{110d,,HTTPResponse} instance.


Alterado na versão 3.5: Se uma @ref{e36,,ConnectionError} ou subclasse for levantada, o objeto @ref{b53,,HTTPConnection} estará pronto para se reconectar quando uma nova solicitação for enviada.

Note that this does not apply to @ref{417,,OSError}s raised by the underlying
socket. Instead the caller is responsible to call @ref{3c98,,close()} on the
existing connection.

@end deffn

@geindex set_debuglevel() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection set_debuglevel}@anchor{3c99}
@deffn {Método} HTTPConnection.set_debuglevel (level)

Set the debugging level.  The default debug level is @code{0}, meaning no
debugging output is printed.  Any value greater than @code{0} will cause all
currently defined debug output to be printed to stdout.  The @code{debuglevel}
is passed to any new @ref{110d,,HTTPResponse} objects that are created.


Adicionado na versão 3.1.

@end deffn

@geindex set_tunnel() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection set_tunnel}@anchor{1269}
@deffn {Método} HTTPConnection.set_tunnel (host, port=None, headers=None)

Set the host and the port for HTTP Connect Tunnelling. This allows running
the connection through a proxy server.

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.

For example, to tunnel through a HTTPS proxy server running locally on port
8080, we would pass the address of the proxy to the @ref{b54,,HTTPSConnection}
constructor, and the address of the host that we eventually want to reach to
the @ref{1269,,set_tunnel()} method:

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("localhost", 8080)
>>> conn.set_tunnel("www.python.org")
>>> conn.request("HEAD","/index.html")
@end example


Adicionado na versão 3.2.



Alterado na versão 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 http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection get_proxy_response_headers}@anchor{17f5}
@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}.


Adicionado na versão 3.12.

@end deffn

@geindex connect() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection connect}@anchor{3c9a}
@deffn {Método} HTTPConnection.connect ()

Connect to the server specified when the object was created.  By default,
this is called automatically when making a request if the client does not
already have a connection.

Levanta um @ref{19fa,,evento de auditoria} @code{http.client.connect} com os argumentos @code{self}, @code{host}, @code{port}.
@end deffn

@geindex close() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection close}@anchor{3c98}
@deffn {Método} HTTPConnection.close ()

Close the connection to the server.
@end deffn

@geindex blocksize (atributo http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection blocksize}@anchor{3c9b}
@deffn {Atributo} HTTPConnection.blocksize

Buffer size in bytes for sending a file-like message body.


Adicionado na versão 3.7.

@end deffn

As an alternative to using the @ref{cc9,,request()} method described above, you can
also send your request step by step, by using the four functions below.

@geindex putrequest() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection putrequest}@anchor{3c9c}
@deffn {Método} HTTPConnection.putrequest (method, url, skip_host=False, skip_accept_encoding=False)

This should be the first call after the connection to the server has been
made. It sends a line to the server consisting of the `method' string,
the `url' string, and the HTTP version (@code{HTTP/1.1}).  To disable automatic
sending of @code{Host:} or @code{Accept-Encoding:} headers (for example to accept
additional content encodings), specify `skip_host' or `skip_accept_encoding'
with non-False values.
@end deffn

@geindex putheader() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection putheader}@anchor{3c9d}
@deffn {Método} HTTPConnection.putheader (header, argument[, ...])

Send an 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html}-style header to the server.  It sends a line to the server
consisting of the header, a colon and a space, and the first argument.  If more
arguments are given, continuation lines are sent, each consisting of a tab and
an argument.
@end deffn

@geindex endheaders() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection endheaders}@anchor{cca}
@deffn {Método} HTTPConnection.endheaders (message_body=None, *, encode_chunked=False)

Send a blank line to the server, signalling the end of the headers. The
optional `message_body' argument can be used to pass a message body
associated with the request.

If `encode_chunked' is @code{True}, the result of each iteration of
`message_body' will be chunk-encoded as specified in 
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html},
Section 3.3.1.  How the data is encoded is dependent on the type of
`message_body'.  If `message_body' implements the @ref{2e8,,buffer interface} the encoding will result in a single chunk.
If `message_body' is a @ref{23e2,,collections.abc.Iterable}, each iteration
of `message_body' will result in a chunk.  If `message_body' is a
@ref{1203,,file object}, each call to @code{.read()} will result in a chunk.
The method automatically signals the end of the chunk-encoded data
immediately after `message_body'.

@cartouche
@quotation Nota 
Due to the chunked encoding specification, empty chunks
yielded by an iterator body will be ignored by the chunk-encoder.
This is to avoid premature termination of the read of the request by
the target server due to malformed encoding.
@end quotation
@end cartouche


Alterado na versão 3.6: Added chunked encoding support and the `encode_chunked' parameter.

@end deffn

@geindex send() (método http.client.HTTPConnection)
@anchor{library/http client http client HTTPConnection send}@anchor{3c9e}
@deffn {Método} HTTPConnection.send (data)

Send data to the server.  This should be used directly only after the
@ref{cca,,endheaders()} method has been called and before @ref{e34,,getresponse()} is
called.

Levanta um @ref{19fa,,evento de auditoria} @code{http.client.send} com os argumentos @code{self}, @code{data}.
@end deffn

@node Objetos HTTPResponse,Exemplos<27>,Objetos de HTTPConnection,http client — HTTP protocol client
@anchor{library/http client httpresponse-objects}@anchor{3c9f}@anchor{library/http client id2}@anchor{3ca0}
@subsubsection Objetos HTTPResponse


An @ref{110d,,HTTPResponse} instance wraps the HTTP response from the
server.  It provides access to the request headers and the entity
body.  The response is an iterable object and can be used in a with
statement.


Alterado na versão 3.5: The @ref{694,,io.BufferedIOBase} interface is now implemented and
all of its reader operations are supported.


@geindex read() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse read}@anchor{1669}
@deffn {Método} HTTPResponse.read ([amt])

Reads and returns the response body, or up to the next `amt' bytes.
@end deffn

@geindex readinto() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse readinto}@anchor{110e}
@deffn {Método} HTTPResponse.readinto (b)

Reads up to the next len(b) bytes of the response body into the buffer `b'.
Returns the number of bytes read.


Adicionado na versão 3.3.

@end deffn

@geindex getheader() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getheader}@anchor{3ca1}
@deffn {Método} HTTPResponse.getheader (name, default=None)

Return the value of the header `name', or `default' if there is no header
matching `name'.  If there is more than one  header with the name `name',
return all of the values joined by ‘, ‘.  If `default' is any iterable other
than a single string, its elements are similarly returned joined by commas.
@end deffn

@geindex getheaders() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getheaders}@anchor{3ca2}
@deffn {Método} HTTPResponse.getheaders ()

Return a list of (header, value) tuples.
@end deffn

@geindex fileno() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse fileno}@anchor{3ca3}
@deffn {Método} HTTPResponse.fileno ()

Return the @code{fileno} of the underlying socket.
@end deffn

@geindex msg (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse msg}@anchor{3c84}
@deffn {Atributo} HTTPResponse.msg

A @ref{3c83,,http.client.HTTPMessage} instance containing the response
headers.  @ref{3c83,,http.client.HTTPMessage} is a subclass of
@ref{27c,,email.message.Message}.
@end deffn

@geindex version (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse version}@anchor{3ca4}
@deffn {Atributo} HTTPResponse.version

HTTP protocol version used by server.  10 for HTTP/1.0, 11 for HTTP/1.1.
@end deffn

@geindex url (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse url}@anchor{3ca5}
@deffn {Atributo} HTTPResponse.url

URL of the resource retrieved, commonly used to determine if a redirect was followed.
@end deffn

@geindex headers (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse headers}@anchor{3ca6}
@deffn {Atributo} HTTPResponse.headers

Headers of the response in the form of an @ref{27b,,email.message.EmailMessage} instance.
@end deffn

@geindex status (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse status}@anchor{3ca7}
@deffn {Atributo} HTTPResponse.status

Status code returned by server.
@end deffn

@geindex reason (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse reason}@anchor{3bc9}
@deffn {Atributo} HTTPResponse.reason

Reason phrase returned by server.
@end deffn

@geindex debuglevel (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse debuglevel}@anchor{3ca8}
@deffn {Atributo} HTTPResponse.debuglevel

A debugging hook.  If @ref{3ca8,,debuglevel} is greater than zero, messages
will be printed to stdout as the response is read and parsed.
@end deffn

@geindex closed (atributo http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse closed}@anchor{3ca9}
@deffn {Atributo} HTTPResponse.closed

Is @code{True} if the stream is closed.
@end deffn

@geindex geturl() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse geturl}@anchor{3caa}
@deffn {Método} HTTPResponse.geturl ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3ca5,,url}.

@end deffn

@geindex info() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse info}@anchor{3cab}
@deffn {Método} HTTPResponse.info ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3ca6,,headers}.

@end deffn

@geindex getcode() (método http.client.HTTPResponse)
@anchor{library/http client http client HTTPResponse getcode}@anchor{3cac}
@deffn {Método} HTTPResponse.getcode ()


Descontinuado desde a versão 3.9: Deprecated in favor of @ref{3ca7,,status}.

@end deffn

@node Exemplos<27>,HTTPMessage Objects,Objetos HTTPResponse,http client — HTTP protocol client
@anchor{library/http client examples}@anchor{3cad}
@subsubsection Exemplos


Here is an example session that uses the @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

Here is an example session that uses the @code{HEAD} method.  Note that the
@code{HEAD} method never returns any data.

@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

Here is an example session that uses the @code{POST} method:

@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

Client side HTTP @code{PUT} requests are very similar to @code{POST} requests. The
difference lies only on the server side where HTTP servers will allow resources to
be created via @code{PUT} requests. It should be noted that custom HTTP methods
are also handled in @ref{100e,,urllib.request.Request} by setting the appropriate
method attribute. Here is an example session that uses the @code{PUT} method:

@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 HTTPMessage Objects,,Exemplos<27>,http client — HTTP protocol client
@anchor{library/http client httpmessage-objects}@anchor{3cae}@anchor{library/http client id3}@anchor{3caf}
@subsubsection HTTPMessage Objects


@geindex HTTPMessage (classe em http.client)
@anchor{library/http client http client HTTPMessage}@anchor{3c83}
@deffn {Classe} http.client.HTTPMessage (email.message.Message)
@end deffn

An @ref{3c83,,http.client.HTTPMessage} instance holds the headers from an HTTP
response.  It is implemented using the @ref{27c,,email.message.Message} class.

@c XXX Define the methods that clients can depend upon between versions.

@node ftplib — FTP protocol client,poplib — Cliente de protocolo POP3,http client — HTTP protocol client,Protocolos de Internet e Suporte
@anchor{library/ftplib doc}@anchor{3cb0}@anchor{library/ftplib ftplib-ftp-protocol-client}@anchor{3cb1}@anchor{library/ftplib module-ftplib}@anchor{5e}@anchor{library/ftplib translation-repo}@anchor{3cb2}
@subsection @code{ftplib} — FTP protocol client


@geindex module; ftplib

`Código-fonte:' Lib/ftplib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/ftplib.py}

@geindex FTP;protocolo
@geindex FTP;ftplib (standard module)


__________________________________________________________________


This module defines the class @ref{900,,FTP} and a few related items. The
@ref{900,,FTP} class implements the client side of the FTP protocol.  You can use
this to write Python programs that perform a variety of automated FTP jobs, such
as mirroring other FTP servers.  It is also used by the module
@ref{10b,,urllib.request} to handle URLs that use FTP.  For more information on FTP
(File Transfer Protocol), see internet 
@geindex RFC; RFC 959
RFC 959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}.

The default encoding is UTF-8, following 
@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{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

Here’s a sample session using the @ref{5e,,ftplib} module:

@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
* Referência: Referência<6>. 

@end menu

@node Referência<6>,,,ftplib — FTP protocol client
@anchor{library/ftplib ftplib-reference}@anchor{3cb3}@anchor{library/ftplib reference}@anchor{3cb4}
@subsubsection Referência


@menu
* FTP objects:: 
* FTP_TLS objects:: 
* Module variables:: 

@end menu

@node FTP objects,FTP_TLS objects,,Referência<6>
@anchor{library/ftplib ftp-objects}@anchor{3cb5}@anchor{library/ftplib id1}@anchor{3cb6}
@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 (classe em ftplib)
@anchor{library/ftplib ftplib FTP}@anchor{900}
@deffn {Classe} 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{900,,FTP} class.

@*Parâmetros: 

@itemize *

@item 
@code{host} (@ref{44c,,str}) – The hostname to connect to.
If given, @code{connect(host)} is implicitly called by the constructor.

@item 
@code{user} (@ref{44c,,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{44c,,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{44c,,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{2f7,,float}@code{ | }@code{None}) – A timeout in seconds for blocking operations like @ref{3cb7,,connect()}
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{370,,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{44c,,str}) – The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize


The @ref{900,,FTP} class supports the @ref{5d2,,with} statement, e.g.:

@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


Alterado na versão 3.2: Suporte para a instrução @ref{5d2,,with} foi adicionado.



Alterado na versão 3.3: `source_address' parameter was added.



Alterado na versão 3.9: If the `timeout' parameter is set to be zero, it will raise a
@ref{202,,ValueError} to prevent the creation of a non-blocking socket.
The `encoding' parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow 
@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.

@ref{900,,FTP} instances have the following methods:

@geindex set_debuglevel() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP set_debuglevel}@anchor{3cb8}
@deffn {Método} set_debuglevel (level)

Set the instance’s debugging level as an @ref{257,,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 ftplib.FTP)
@anchor{library/ftplib ftplib FTP connect}@anchor{3cb7}
@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{900,,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{44c,,str}) – The host to connect to.

@item 
@code{port} (@ref{257,,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{2f7,,float}@code{ | }@code{None}) – A timeout in seconds for the connection attempt
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{370,,tuple}@code{ | }@code{None}) – A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.
@end itemize


Levanta um @ref{19fa,,evento de auditoria} @code{ftplib.connect} com os argumentos @code{self}, @code{host}, @code{port}.


Alterado na versão 3.3: `source_address' parameter was added.

@end deffn

@geindex getwelcome() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP getwelcome}@anchor{3cb9}
@deffn {Método} getwelcome ()

Return the welcome message sent by the server in reply to the initial
connection.  (This message sometimes contains disclaimers or help information
that may be relevant to the user.)
@end deffn

@geindex login() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP login}@anchor{3cba}
@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{900,,FTP} instance was created.
Most FTP commands are only allowed after the client has logged in.

@*Parâmetros: 

@itemize *

@item 
@code{user} (@ref{44c,,str}) – The username to log in with (default: @code{'anonymous'}).

@item 
@code{passwd} (@ref{44c,,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{44c,,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 ftplib.FTP)
@anchor{library/ftplib ftplib FTP abort}@anchor{3cbb}
@deffn {Método} abort ()

Abort a file transfer that is in progress.  Using this does not always work, but
it’s worth a try.
@end deffn

@geindex sendcmd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP sendcmd}@anchor{3cbc}
@deffn {Método} sendcmd (cmd)

Send a simple command string to the server and return the response string.

Levanta um @ref{19fa,,evento de auditoria} @code{ftplib.sendcmd} com os argumentos @code{self}, @code{cmd}.
@end deffn

@geindex voidcmd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP voidcmd}@anchor{3cbd}
@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{3cbe,,error_reply} otherwise.

Levanta um @ref{19fa,,evento de auditoria} @code{ftplib.sendcmd} com os argumentos @code{self}, @code{cmd}.
@end deffn

@geindex retrbinary() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP retrbinary}@anchor{3cbf}
@deffn {Método} retrbinary (cmd, callback, blocksize=8192, rest=None)

Retrieve a file in binary transfer mode.

@*Parâmetros: 

@itemize *

@item 
@code{cmd} (@ref{44c,,str}) – An appropriate @code{RETR} command: @code{"RETR @var{filename}"}.

@item 
@code{callback} (@ref{2aaf,,callable}) – A single parameter callable that is called
for each block of data received,
with its single argument being the data as @ref{1c2,,bytes}.

@item 
@code{blocksize} (@ref{257,,int}) – The maximum chunk size to read on the low-level
@ref{dc9,,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{257,,int}) – A @code{REST} command to be sent to the server.
See the documentation for the `rest' parameter of the @ref{3cc0,,transfercmd()} method.
@end itemize

@end deffn

@geindex retrlines() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP retrlines}@anchor{3cc1}
@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{3cbf,,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{ae6,,sys.stdout}.
@end deffn

@geindex set_pasv() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP set_pasv}@anchor{3cc2}
@deffn {Método} set_pasv (val)

Enable “passive” mode if `val' is true, otherwise disable passive mode.
Passive mode is on by default.
@end deffn

@geindex storbinary() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP storbinary}@anchor{134e}
@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{44c,,str}) – An appropriate @code{STOR} command: @code{"STOR @var{filename}"}.

@item 
@code{fp} (@ref{1203,,file object}) – A file object (opened in binary mode) which is read until EOF,
using its @ref{e48,,read()} method in blocks of size `blocksize'
to provide the data to be stored.

@item 
@code{blocksize} (@ref{257,,int}) – The read block size.
Defaults to @code{8192}.

@item 
@code{callback} (@ref{2aaf,,callable}) – A single parameter callable that is called
for each block of data sent,
with its single argument being the data as @ref{1c2,,bytes}.

@item 
@code{rest} (@ref{257,,int}) – A @code{REST} command to be sent to the server.
See the documentation for the `rest' parameter of the @ref{3cc0,,transfercmd()} method.
@end itemize



Alterado na versão 3.2: The `rest' parameter was added.

@end deffn

@geindex storlines() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP storlines}@anchor{3cc3}
@deffn {Método} storlines (cmd, fp, callback=None)

Store a file in line mode.  `cmd' should be an appropriate
@code{STOR} command (see @ref{134e,,storbinary()}).  Lines are read until EOF from the
@ref{1203,,file object} `fp' (opened in binary mode) using its @ref{241f,,readline()}
method to provide the data to be stored.  `callback' is an optional single
parameter callable that is called on each line after it is sent.
@end deffn

@geindex transfercmd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP transfercmd}@anchor{3cc0}
@deffn {Método} transfercmd (cmd, rest=None)

Initiate a transfer over the data connection.  If the transfer is active, send an
@code{EPRT} or  @code{PORT} command and the transfer command specified by `cmd', and
accept the connection.  If the server is passive, send an @code{EPSV} or @code{PASV}
command, connect to it, and start the transfer command.  Either way, return the
socket for the connection.

If optional `rest' is given, a @code{REST} command is sent to the server, passing
`rest' as an argument.  `rest' is usually a byte offset into the requested file,
telling the server to restart sending the file’s bytes at the requested offset,
skipping over the initial bytes.  Note however that the @ref{3cc0,,transfercmd()}
method converts `rest' to a string with the `encoding' parameter specified
at initialization, but no check is performed on the string’s contents.  If the
server does not recognize the @code{REST} command, an @ref{3cbe,,error_reply} exception
will be raised.  If this happens, simply call @ref{3cc0,,transfercmd()} without a
`rest' argument.
@end deffn

@geindex ntransfercmd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP ntransfercmd}@anchor{3cc4}
@deffn {Método} ntransfercmd (cmd, rest=None)

Like @ref{3cc0,,transfercmd()}, but returns a tuple of the data connection and the
expected size of the data.  If the expected size could not be computed, @code{None}
will be returned as the expected size.  `cmd' and `rest' means the same thing as
in @ref{3cc0,,transfercmd()}.
@end deffn

@geindex mlsd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP mlsd}@anchor{1101}
@deffn {Método} mlsd (path='@w{'}, facts=[])

List a directory in a standardized format by using @code{MLSD} command
(
@geindex RFC; RFC 3659
RFC 3659@footnote{https://datatracker.ietf.org/doc/html/rfc3659.html}).  If `path' is omitted the current directory is assumed.
`facts' is a list of strings representing the type of information desired
(e.g. @code{["type", "size", "perm"]}).  Return a generator object yielding a
tuple of two elements for every file found in path.  First element is the
file name, the second one is a dictionary containing facts about the file
name.  Content of this dictionary might be limited by the `facts' argument
but server is not guaranteed to return all requested facts.


Adicionado na versão 3.3.

@end deffn

@geindex nlst() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP nlst}@anchor{1102}
@deffn {Método} nlst (argument[, ...])

Return a list of file names as returned by the @code{NLST} command.  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{NLST} command.

@cartouche
@quotation Nota 
If your server supports the command, @ref{1101,,mlsd()} offers a better API.
@end quotation
@end cartouche
@end deffn

@geindex dir() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP dir}@anchor{1103}
@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{3cc1,,retrlines()}; the default prints to
@ref{ae6,,sys.stdout}.  This method returns @code{None}.

@cartouche
@quotation Nota 
If your server supports the command, @ref{1101,,mlsd()} offers a better API.
@end quotation
@end cartouche
@end deffn

@geindex rename() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP rename}@anchor{3cc5}
@deffn {Método} rename (fromname, toname)

Rename file `fromname' on the server to `toname'.
@end deffn

@geindex delete() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP delete}@anchor{3cc6}
@deffn {Método} delete (filename)

Remove the file named `filename' from the server.  If successful, returns the
text of the response, otherwise raises @ref{3cc7,,error_perm} on permission errors or
@ref{3cbe,,error_reply} on other errors.
@end deffn

@geindex cwd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP cwd}@anchor{3cc8}
@deffn {Método} cwd (pathname)

Set the current directory on the server.
@end deffn

@geindex mkd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP mkd}@anchor{3cc9}
@deffn {Método} mkd (pathname)

Create a new directory on the server.
@end deffn

@geindex pwd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP pwd}@anchor{3cca}
@deffn {Método} pwd ()

Return the pathname of the current directory on the server.
@end deffn

@geindex rmd() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP rmd}@anchor{3ccb}
@deffn {Método} rmd (dirname)

Remove the directory named `dirname' on the server.
@end deffn

@geindex size() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP size}@anchor{3ccc}
@deffn {Método} size (filename)

Request the size of the file named `filename' on the server.  On success, the
size of the file is returned as an integer, otherwise @code{None} is returned.
Note that the @code{SIZE} command is not  standardized, but is supported by many
common server implementations.
@end deffn

@geindex quit() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP quit}@anchor{3ccd}
@deffn {Método} quit ()

Send a @code{QUIT} command to the server and close the connection. This is the
“polite” way to close a connection, but it may raise an exception if the server
responds with an error to the @code{QUIT} command.  This implies a call to the
@ref{3cce,,close()} method which renders the @ref{900,,FTP} instance useless for
subsequent calls (see below).
@end deffn

@geindex close() (método ftplib.FTP)
@anchor{library/ftplib ftplib FTP close}@anchor{3cce}
@deffn {Método} close ()

Close the connection unilaterally.  This should not be applied to an already
closed connection such as after a successful call to @ref{3ccd,,quit()}.
After this call the @ref{900,,FTP} instance should not be used any more (after
a call to @ref{3cce,,close()} or @ref{3ccd,,quit()} you cannot reopen the
connection by issuing another @ref{3cba,,login()} method).
@end deffn
@end deffn

@node FTP_TLS objects,Module variables,FTP objects,Referência<6>
@anchor{library/ftplib ftp-tls-objects}@anchor{3ccf}
@subsubsection FTP_TLS objects


@geindex FTP_TLS (classe em ftplib)
@anchor{library/ftplib ftplib FTP_TLS}@anchor{901}
@deffn {Classe} ftplib.FTP_TLS (host='@w{'}, user='@w{'}, passwd='@w{'}, acct='@w{'}, *, context=None, timeout=None, source_address=None, encoding='utf-8')

An @ref{900,,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{3cd0,,prot_p()} method.
@end quotation
@end cartouche

@*Parâmetros: 

@itemize *

@item 
@code{host} (@ref{44c,,str}) – The hostname to connect to.
If given, @code{connect(host)} is implicitly called by the constructor.

@item 
@code{user} (@ref{44c,,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{44c,,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{44c,,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{294,,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{354c,,Considerações de segurança} for best practices.

@item 
@code{timeout} (@ref{2f7,,float}@code{ | }@code{None}) – A timeout in seconds for blocking operations like @ref{3cb7,,connect()}
(default: the global default timeout setting).

@item 
@code{source_address} (@ref{370,,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{44c,,str}) – The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize



Adicionado na versão 3.2.



Alterado na versão 3.3: Added the `source_address' parameter.



Alterado na versão 3.4: A classe agora oferece suporte a verificação de nome de host com @ref{3676,,ssl.SSLContext.check_hostname} e `Indicação de nome de servidor' (veja @ref{3688,,ssl.HAS_SNI}).



Alterado na versão 3.9: If the `timeout' parameter is set to be zero, it will raise a
@ref{202,,ValueError} to prevent the creation of a non-blocking socket.
The `encoding' parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}.



Alterado na versão 3.12: Os parâmetros depreciados `keyfile' e `certfile'  foram removidos.


Here’s a sample session using the @ref{901,,FTP_TLS} class:

@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{900,,FTP},
defining these additional methods and attributes:

@geindex ssl_version (atributo ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS ssl_version}@anchor{3cd1}
@deffn {Atributo} ssl_version

The SSL version to use (defaults to @ref{367a,,ssl.PROTOCOL_SSLv23}).
@end deffn

@geindex auth() (método ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS auth}@anchor{3cd2}
@deffn {Método} auth ()

Set up a secure control connection by using TLS or SSL, depending on what
is specified in the @ref{3cd1,,ssl_version} attribute.


Alterado na versão 3.4: The method now supports hostname check with
@ref{3676,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{3688,,ssl.HAS_SNI}).

@end deffn

@geindex ccc() (método ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS ccc}@anchor{1100}
@deffn {Método} ccc ()

Revert control channel back to plaintext.  This can be useful to take
advantage of firewalls that know how to handle NAT with non-secure FTP
without opening fixed ports.


Adicionado na versão 3.3.

@end deffn

@geindex prot_p() (método ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS prot_p}@anchor{3cd0}
@deffn {Método} prot_p ()

Set up secure data connection.
@end deffn

@geindex prot_c() (método ftplib.FTP_TLS)
@anchor{library/ftplib ftplib FTP_TLS prot_c}@anchor{3cd3}
@deffn {Método} prot_c ()

Set up clear text data connection.
@end deffn
@end deffn

@node Module variables,,FTP_TLS objects,Referência<6>
@anchor{library/ftplib module-variables}@anchor{3cd4}
@subsubsection Module variables


@geindex error_reply
@anchor{library/ftplib ftplib error_reply}@anchor{3cbe}
@deffn {Exceção} ftplib.error_reply

Exception raised when an unexpected reply is received from the server.
@end deffn

@geindex error_temp
@anchor{library/ftplib ftplib error_temp}@anchor{3cd5}
@deffn {Exceção} ftplib.error_temp

Exception raised when an error code signifying a temporary error (response
codes in the range 400–499) is received.
@end deffn

@geindex error_perm
@anchor{library/ftplib ftplib error_perm}@anchor{3cc7}
@deffn {Exceção} ftplib.error_perm

Exception raised when an error code signifying a permanent error (response
codes in the range 500–599) is received.
@end deffn

@geindex error_proto
@anchor{library/ftplib ftplib error_proto}@anchor{3cd6}
@deffn {Exceção} ftplib.error_proto

Exception raised when a reply is received from the server that does not fit
the response specifications of the File Transfer Protocol, i.e. begin with a
digit in the range 1–5.
@end deffn

@geindex all_errors (no módulo ftplib)
@anchor{library/ftplib ftplib all_errors}@anchor{3cd7}
@deffn {Dado} ftplib.all_errors

The set of all exceptions (as a tuple) that methods of @ref{900,,FTP}
instances may raise as a result of problems with the FTP connection (as
opposed to programming errors made by the caller).  This set includes the
four exceptions listed above as well as @ref{417,,OSError} and @ref{131c,,EOFError}.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{9b,,netrc}

Parser for the @code{.netrc} file format.  The file @code{.netrc} is
typically used by FTP clients to load user authentication information
before prompting the user.
@end table


@node poplib — Cliente de protocolo POP3,imaplib — IMAP4 protocol client,ftplib — FTP protocol client,Protocolos de Internet e Suporte
@anchor{library/poplib doc}@anchor{3cd8}@anchor{library/poplib module-poplib}@anchor{ac}@anchor{library/poplib poplib-pop3-protocol-client}@anchor{3cd9}@anchor{library/poplib translation-repo}@anchor{3cda}
@subsection @code{poplib} — Cliente de protocolo POP3


@geindex module; poplib

@c revised by ESR, January 2000

`Source code:' Lib/poplib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/poplib.py}

@geindex POP3;protocolo


__________________________________________________________________


Este módulo define uma classe, @ref{92a,,POP3}, que encapsula uma conexão com um servidor POP3 e implementa o protocolo conforme definido em 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html}. A classe @ref{92a,,POP3} oferece suporte aos conjuntos de comandos mínimos e opcionais de 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html}. A classe @ref{92a,,POP3} também oferece suporte ao comando @code{STLS} introduzido em 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html} para permitir a comunicação criptografada em uma conexão já estabelecida.

Além disso, este módulo fornece uma classe @ref{92b,,POP3_SSL}, que fornece suporte para conexão a servidores POP3 que usam SSL como uma camada de protocolo subjacente.

Observe que o POP3, embora amplamente suportado, está obsoleto. A qualidade de implementação dos servidores POP3 varia muito, e muitos são bastante ruins. Se o seu servidor de e-mail oferece suporte a IMAP, seria melhor usar a classe @ref{909,,imaplib.IMAP4}, pois os servidores IMAP tendem a ter uma implementação melhor.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

O módulo @ref{ac,,poplib} fornece duas classes:

@geindex POP3 (classe em poplib)
@anchor{library/poplib poplib POP3}@anchor{92a}
@deffn {Classe} poplib.POP3 (host, port=POP3_PORT[, timeout])

Esta classe implementa o protocolo POP3 real. A conexão é criada quando a instância é inicializada. Se `port' for omitido, a porta POP3 padrão (110) será usada. O parâmetro opcional `timeout' especifica um tempo limite em segundos para a tentativa de conexão (se não for especificado, a configuração de tempo limite padrão global será usada).

Levanta um @ref{19fa,,evento de auditoria} @code{ftplib.connect} com os argumentos @code{self}, @code{host}, @code{port}.

Todos os comandos levantarão um @ref{19fa,,evento de auditoria} @code{poplib.putline} com os argumentos @code{self} e @code{line}, onde @code{line} são os bytes prestes a serem enviados ao host remoto.


Alterado na versão 3.9: Se o parâmetro `timeout' for definido como zero, será levantada @ref{202,,ValueError} para impedir a criação de um soquete não bloqueante.

@end deffn

@geindex POP3_SSL (classe em poplib)
@anchor{library/poplib poplib POP3_SSL}@anchor{92b}
@deffn {Classe} poplib.POP3_SSL (host, port=POP3_SSL_PORT, *, timeout=None, context=None)

Esta é uma subclasse de @ref{92a,,POP3} que se conecta ao servidor por meio de um soquete criptografado SSL. Se `port' não for especificado, 995, a porta padrão POP3 sobre SSL será usada. `timeout' funciona como no construtor @ref{92a,,POP3}. `context' é um objeto opcional @ref{294,,ssl.SSLContext} que permite agrupar opções de configuração SSL, certificados e chaves privadas em uma única estrutura (potencialmente duradoura). Consulte @ref{354c,,Considerações de segurança} para obter as melhores práticas.

Levanta um @ref{19fa,,evento de auditoria} @code{ftplib.connect} com os argumentos @code{self}, @code{host}, @code{port}.

Todos os comandos levantarão um @ref{19fa,,evento de auditoria} @code{poplib.putline} com os argumentos @code{self} e @code{line}, onde @code{line} são os bytes prestes a serem enviados ao host remoto.


Alterado na versão 3.2: Parâmetro `context' adicionado.



Alterado na versão 3.4: A classe agora oferece suporte a verificação de nome de host com @ref{3676,,ssl.SSLContext.check_hostname} e `Indicação de nome de servidor' (veja @ref{3688,,ssl.HAS_SNI}).



Alterado na versão 3.9: Se o parâmetro `timeout' for definido como zero, será levantada @ref{202,,ValueError} para impedir a criação de um soquete não bloqueante.



Alterado na versão 3.12: Os parâmetros depreciados `keyfile' e `certfile'  foram removidos.

@end deffn

Uma exceção é definida como um atributo do módulo @ref{ac,,poplib}:

@geindex error_proto
@anchor{library/poplib poplib error_proto}@anchor{11db}
@deffn {Exceção} poplib.error_proto

Exceção levantada em caso de erros deste módulo (erros do módulo @ref{cc,,socket} não são detectados). O motivo da exceção é passado ao construtor como uma string.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{74,,imaplib}

The standard Python IMAP module.

@item Frequently Asked Questions About Fetchmail@footnote{http://www.catb.org/~esr/fetchmail/fetchmail-FAQ.html}

The FAQ for the @code{fetchmail} POP/IMAP client collects information on
POP3 server variations and RFC noncompliance that may be useful if you need to
write an application based on the POP protocol.
@end table


@menu
* Objetos POP3:: 
* Exemplo POP3:: 

@end menu

@node Objetos POP3,Exemplo POP3,,poplib — Cliente de protocolo POP3
@anchor{library/poplib id1}@anchor{3cdb}@anchor{library/poplib pop3-objects}@anchor{3cdc}
@subsubsection Objetos POP3


All POP3 commands are represented by methods of the same name, in lowercase;
most return the response text sent by the server.

A @ref{92a,,POP3} instance has the following methods:

@geindex set_debuglevel() (método poplib.POP3)
@anchor{library/poplib poplib POP3 set_debuglevel}@anchor{3cdd}
@deffn {Método} POP3.set_debuglevel (level)

Set the instance’s debugging level.  This controls the amount of debugging
output printed.  The default, @code{0}, produces no debugging output.  A value of
@code{1} produces a moderate amount of debugging output, generally a single line
per request.  A value of @code{2} or higher produces the maximum amount of
debugging output, logging each line sent and received on the control connection.
@end deffn

@geindex getwelcome() (método poplib.POP3)
@anchor{library/poplib poplib POP3 getwelcome}@anchor{3cde}
@deffn {Método} POP3.getwelcome ()

Returns the greeting string sent by the POP3 server.
@end deffn

@geindex capa() (método poplib.POP3)
@anchor{library/poplib poplib POP3 capa}@anchor{fb0}
@deffn {Método} POP3.capa ()

Query the server’s capabilities as specified in 
@geindex RFC; RFC 2449
RFC 2449@footnote{https://datatracker.ietf.org/doc/html/rfc2449.html}.
Returns a dictionary in the form @code{@{'name': ['param'...]@}}.


Adicionado na versão 3.4.

@end deffn

@geindex user() (método poplib.POP3)
@anchor{library/poplib poplib POP3 user}@anchor{3cdf}
@deffn {Método} POP3.user (username)

Send user command, response should indicate that a password is required.
@end deffn

@geindex pass_() (método poplib.POP3)
@anchor{library/poplib poplib POP3 pass_}@anchor{3ce0}
@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{11da,,quit()} is called.
@end deffn

@geindex apop() (método poplib.POP3)
@anchor{library/poplib poplib POP3 apop}@anchor{3ce1}
@deffn {Método} POP3.apop (user, secret)

Use the more secure APOP authentication to log into the POP3 server.
@end deffn

@geindex rpop() (método poplib.POP3)
@anchor{library/poplib poplib POP3 rpop}@anchor{3ce2}
@deffn {Método} POP3.rpop (user)

Use RPOP authentication (similar to UNIX r-commands) to log into POP3 server.
@end deffn

@geindex stat() (método poplib.POP3)
@anchor{library/poplib poplib POP3 stat}@anchor{3ce3}
@deffn {Método} POP3.stat ()

Get mailbox status.  The result is a tuple of 2 integers: @code{(message count,
mailbox size)}.
@end deffn

@geindex list() (método poplib.POP3)
@anchor{library/poplib poplib POP3 list}@anchor{3ce4}
@deffn {Método} POP3.list ([which])

Request message list, result is in the form @code{(response, ['mesg_num octets',
...], octets)}. If `which' is set, it is the message to list.
@end deffn

@geindex retr() (método poplib.POP3)
@anchor{library/poplib poplib POP3 retr}@anchor{3ce5}
@deffn {Método} POP3.retr (which)

Retrieve whole message number `which', and set its seen flag. Result is in form
@code{(response, ['line', ...], octets)}.
@end deffn

@geindex dele() (método poplib.POP3)
@anchor{library/poplib poplib POP3 dele}@anchor{3ce6}
@deffn {Método} POP3.dele (which)

Flag message number `which' for deletion.  On most servers deletions are not
actually performed until QUIT (the major exception is Eudora QPOP, which
deliberately violates the RFCs by doing pending deletes on any disconnect).
@end deffn

@geindex rset() (método poplib.POP3)
@anchor{library/poplib poplib POP3 rset}@anchor{3ce7}
@deffn {Método} POP3.rset ()

Remove any deletion marks for the mailbox.
@end deffn

@geindex noop() (método poplib.POP3)
@anchor{library/poplib poplib POP3 noop}@anchor{3ce8}
@deffn {Método} POP3.noop ()

Do nothing.  Might be used as a keep-alive.
@end deffn

@geindex quit() (método poplib.POP3)
@anchor{library/poplib poplib POP3 quit}@anchor{11da}
@deffn {Método} POP3.quit ()

Signoff:  commit changes, unlock mailbox, drop connection.
@end deffn

@geindex top() (método poplib.POP3)
@anchor{library/poplib poplib POP3 top}@anchor{3ce9}
@deffn {Método} POP3.top (which, howmuch)

Retrieves the message header plus `howmuch' lines of the message after the
header of message number `which'. Result is in form @code{(response, ['line', ...],
octets)}.

The POP3 TOP command this method uses, unlike the RETR command, doesn’t set the
message’s seen flag; unfortunately, TOP is poorly specified in the RFCs and is
frequently broken in off-brand servers. Test this method by hand against the
POP3 servers you will use before trusting it.
@end deffn

@geindex uidl() (método poplib.POP3)
@anchor{library/poplib poplib POP3 uidl}@anchor{3cea}
@deffn {Método} POP3.uidl (which=None)

Return message digest (unique id) list. If `which' is specified, result contains
the unique id for that message in the form @code{'response mesgnum uid}, otherwise
result is list @code{(response, ['mesgnum uid', ...], octets)}.
@end deffn

@geindex utf8() (método poplib.POP3)
@anchor{library/poplib poplib POP3 utf8}@anchor{e77}
@deffn {Método} POP3.utf8 ()

Try to switch to UTF-8 mode. Returns the server response if successful,
raises @ref{11db,,error_proto} if not. Specified in 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html}.


Adicionado na versão 3.5.

@end deffn

@geindex stls() (método poplib.POP3)
@anchor{library/poplib poplib POP3 stls}@anchor{fb1}
@deffn {Método} POP3.stls (context=None)

Start a TLS session on the active connection as specified in 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html}.
This is only allowed before user authentication

`context' parameter is a @ref{294,,ssl.SSLContext} object which allows
bundling SSL configuration options, certificates and private keys into
a single (potentially long-lived) structure.  Please read @ref{354c,,Considerações de segurança}
for best practices.

This method supports hostname checking via
@ref{3676,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{3688,,ssl.HAS_SNI}).


Adicionado na versão 3.4.

@end deffn

Instances of @ref{92b,,POP3_SSL} have no additional methods. The interface of this
subclass is identical to its parent.

@node Exemplo POP3,,Objetos POP3,poplib — Cliente de protocolo POP3
@anchor{library/poplib id2}@anchor{3ceb}@anchor{library/poplib pop3-example}@anchor{3cec}
@subsubsection Exemplo POP3


Here is a minimal example (without error checking) that opens a mailbox and
retrieves and prints all messages:

@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

At the end of the module, there is a test section that contains a more extensive
example of usage.

@node imaplib — IMAP4 protocol client,smtplib — Cliente de protocolo SMTP,poplib — Cliente de protocolo POP3,Protocolos de Internet e Suporte
@anchor{library/imaplib doc}@anchor{3ced}@anchor{library/imaplib imaplib-imap4-protocol-client}@anchor{3cee}@anchor{library/imaplib module-imaplib}@anchor{74}@anchor{library/imaplib translation-repo}@anchor{3cef}
@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-fonte:' Lib/imaplib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/imaplib.py}

@geindex IMAP4;protocolo
@geindex IMAP4_SSL;protocolo
@geindex IMAP4_stream;protocolo


__________________________________________________________________


This module defines three classes, @ref{909,,IMAP4}, @ref{90a,,IMAP4_SSL} and
@ref{90c,,IMAP4_stream}, which encapsulate a connection to an IMAP4 server and
implement a large subset of the IMAP4rev1 client protocol as defined in
@geindex RFC; RFC 2060
RFC 2060@footnote{https://datatracker.ietf.org/doc/html/rfc2060.html}. It is backward compatible with IMAP4 (
@geindex RFC; RFC 1730
RFC 1730@footnote{https://datatracker.ietf.org/doc/html/rfc1730.html}) servers, but
note that the @code{STATUS} command is not supported in IMAP4.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

Three classes are provided by the @ref{74,,imaplib} module, @ref{909,,IMAP4} is the
base class:

@geindex IMAP4 (classe em imaplib)
@anchor{library/imaplib imaplib IMAP4}@anchor{909}
@deffn {Classe} 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.

The @ref{909,,IMAP4} class supports the @ref{5d2,,with} statement.  When used
like this, the IMAP4 @code{LOGOUT} command is issued automatically when the
@code{with} statement exits.  E.g.:

@example
>>> from imaplib import IMAP4
>>> with IMAP4("domain.org") as M:
...     M.noop()
...
('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])
@end example


Alterado na versão 3.5: Suporte para a instrução @ref{5d2,,with} foi adicionado.



Alterado na versão 3.9: O parâmetro opcional  `timeout' foi adicionado.

@end deffn

Three exceptions are defined as attributes of the @ref{909,,IMAP4} class:

@geindex IMAP4.error
@anchor{library/imaplib imaplib IMAP4 error}@anchor{15fa}
@deffn {Exceção} IMAP4.error

Exception raised on any errors.  The reason for the exception is passed to the
constructor as a string.
@end deffn

@geindex IMAP4.abort
@anchor{library/imaplib imaplib IMAP4 abort}@anchor{3cf0}
@deffn {Exceção} IMAP4.abort

IMAP4 server errors cause this exception to be raised.  This is a sub-class of
@ref{15fa,,IMAP4.error}.  Note that closing the instance and instantiating a new one
will usually allow recovery from this exception.
@end deffn

@geindex IMAP4.readonly
@anchor{library/imaplib imaplib IMAP4 readonly}@anchor{3cf1}
@deffn {Exceção} IMAP4.readonly

This exception is raised when a writable mailbox has its status changed by the
server.  This is a sub-class of @ref{15fa,,IMAP4.error}.  Some other client now has
write permission, and the mailbox will need to be re-opened to re-obtain write
permission.
@end deffn

There’s also a subclass for secure connections:

@geindex IMAP4_SSL (classe em imaplib)
@anchor{library/imaplib imaplib IMAP4_SSL}@anchor{90a}
@deffn {Classe} imaplib.IMAP4_SSL (host='@w{'}, port=IMAP4_SSL_PORT, *, ssl_context=None, timeout=None)

This is a subclass derived from @ref{909,,IMAP4} that connects over an SSL
encrypted socket (to use this class you need a socket module that was compiled
with SSL support).  If `host' is not specified, @code{'@w{'}} (the local host) is used.
If `port' is omitted, the standard IMAP4-over-SSL port (993) is used.
`ssl_context' is a @ref{294,,ssl.SSLContext} object which allows bundling
SSL configuration options, certificates and private keys into a single
(potentially long-lived) structure.  Please read @ref{354c,,Considerações de segurança} for
best practices.

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.


Alterado na versão 3.3: `ssl_context' parameter was added.



Alterado na versão 3.4: A classe agora oferece suporte a verificação de nome de host com @ref{3676,,ssl.SSLContext.check_hostname} e `Indicação de nome de servidor' (veja @ref{3688,,ssl.HAS_SNI}).



Alterado na versão 3.9: O parâmetro opcional  `timeout' foi adicionado.



Alterado na versão 3.12: Os parâmetros depreciados `keyfile' e `certfile'  foram removidos.

@end deffn

The second subclass allows for connections created by a child process:

@geindex IMAP4_stream (classe em imaplib)
@anchor{library/imaplib imaplib IMAP4_stream}@anchor{90c}
@deffn {Classe} imaplib.IMAP4_stream (command)

This is a subclass derived from @ref{909,,IMAP4} that connects to the
@code{stdin/stdout} file descriptors created by passing `command' to
@code{subprocess.Popen()}.
@end deffn

The following utility functions are defined:

@geindex Internaldate2tuple() (no módulo imaplib)
@anchor{library/imaplib imaplib Internaldate2tuple}@anchor{3cf2}
@deffn {Função} imaplib.Internaldate2tuple (datestr)

Parse an IMAP4 @code{INTERNALDATE} string and return corresponding local
time.  The return value is a @ref{d0b,,time.struct_time} tuple or
@code{None} if the string has wrong format.
@end deffn

@geindex Int2AP() (no módulo imaplib)
@anchor{library/imaplib imaplib Int2AP}@anchor{3cf3}
@deffn {Função} imaplib.Int2AP (num)

Converts an integer into a bytes representation using characters from the set
[@code{A} .. @code{P}].
@end deffn

@geindex ParseFlags() (no módulo imaplib)
@anchor{library/imaplib imaplib ParseFlags}@anchor{3cf4}
@deffn {Função} imaplib.ParseFlags (flagstr)

Converts an IMAP4 @code{FLAGS} response to a tuple of individual flags.
@end deffn

@geindex Time2Internaldate() (no módulo imaplib)
@anchor{library/imaplib imaplib Time2Internaldate}@anchor{3cf5}
@deffn {Função} imaplib.Time2Internaldate (date_time)

Convert `date_time' to an IMAP4 @code{INTERNALDATE} representation.
The return value is a string in the form: @code{"DD-Mmm-YYYY HH:MM:SS
+HHMM"} (including double-quotes).  The `date_time' argument can
be a number (int or float) representing seconds since epoch (as
returned by @ref{254,,time.time()}), a 9-tuple representing local time
an instance of @ref{d0b,,time.struct_time} (as returned by
@ref{1541,,time.localtime()}), an aware instance of
@ref{1cc,,datetime.datetime}, or a double-quoted string.  In the last
case, it is assumed to already be in the correct format.
@end deffn

Note that IMAP4 message numbers change as the mailbox changes; in particular,
after an @code{EXPUNGE} command performs deletions the remaining messages are
renumbered. So it is highly advisable to use UIDs instead, with the UID command.

At the end of the module, there is a test section that contains a more extensive
example of usage.


@subsubheading Ver também


Documents describing the protocol, sources for servers
implementing it, by the University of Washington’s IMAP Information Center
can all be found at (`Source Code') @indicateurl{https://github.com/uw-imap/imap} (`Not Maintained').


@menu
* Objetos IMAP4:: 
* Exemplo IMAP4:: 

@end menu

@node Objetos IMAP4,Exemplo IMAP4,,imaplib — IMAP4 protocol client
@anchor{library/imaplib id1}@anchor{3cf6}@anchor{library/imaplib imap4-objects}@anchor{3cf7}
@subsubsection Objetos IMAP4


All IMAP4rev1 commands are represented by methods of the same name, either
uppercase or lowercase.

All arguments to commands are converted to strings, except for @code{AUTHENTICATE},
and the last argument to @code{APPEND} which is passed as an IMAP4 literal.  If
necessary (the string contains IMAP4 protocol-sensitive characters and isn’t
enclosed with either parentheses or double quotes) each string is quoted.
However, the `password' argument to the @code{LOGIN} command is always quoted. If
you want to avoid having an argument string quoted (eg: the `flags' argument to
@code{STORE}) then enclose the string in parentheses (eg: @code{r'(\Deleted)'}).

Each command returns a tuple: @code{(type, [data, ...])} where `type' is usually
@code{'OK'} or @code{'NO'}, and `data' is either the text from the command response,
or mandated results from the command. Each `data' is either a @code{bytes}, or a
tuple. If a tuple, then the first part is the header of the response, and the
second part contains the data (ie: ‘literal’ value).

The `message_set' options to commands below is a string specifying one or more
messages to be acted upon.  It may be a simple message number (@code{'1'}), a range
of message numbers (@code{'2:4'}), or a group of non-contiguous ranges separated by
commas (@code{'1:3,6:9'}).  A range can contain an asterisk to indicate an infinite
upper bound (@code{'3:*'}).

An @ref{909,,IMAP4} instance has the following methods:

@geindex append() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 append}@anchor{3cf8}
@deffn {Método} IMAP4.append (mailbox, flags, date_time, message)

Append `message' to named mailbox.
@end deffn

@geindex authenticate() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 authenticate}@anchor{3cf9}
@deffn {Método} IMAP4.authenticate (mechanism, authobject)

Authenticate command — requires response processing.

`mechanism' specifies which authentication mechanism is to be used - it should
appear in the instance variable @code{capabilities} in the form @code{AUTH=mechanism}.

`authobject' must be a callable object:

@example
data = authobject(response)
@end example

It will be called to process server continuation responses; the `response'
argument it is passed will be @code{bytes}.  It should return @code{bytes} `data'
that will be base64 encoded and sent to the server.  It should return
@code{None} if the client abort response @code{*} should be sent instead.


Alterado na versão 3.5: string usernames and passwords are now encoded to @code{utf-8} instead of
being limited to ASCII.

@end deffn

@geindex check() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 check}@anchor{3cfa}
@deffn {Método} IMAP4.check ()

Checkpoint mailbox on server.
@end deffn

@geindex close() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 close}@anchor{90e}
@deffn {Método} IMAP4.close ()

Close currently selected mailbox. Deleted messages are removed from writable
mailbox. This is the recommended command before @code{LOGOUT}.
@end deffn

@geindex copy() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 copy}@anchor{3cfb}
@deffn {Método} IMAP4.copy (message_set, new_mailbox)

Copy `message_set' messages onto end of `new_mailbox'.
@end deffn

@geindex create() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 create}@anchor{3cfc}
@deffn {Método} IMAP4.create (mailbox)

Create new mailbox named `mailbox'.
@end deffn

@geindex delete() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 delete}@anchor{3cfd}
@deffn {Método} IMAP4.delete (mailbox)

Delete old mailbox named `mailbox'.
@end deffn

@geindex deleteacl() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 deleteacl}@anchor{3cfe}
@deffn {Método} IMAP4.deleteacl (mailbox, who)

Delete the ACLs (remove any rights) set for who on mailbox.
@end deffn

@geindex enable() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 enable}@anchor{e39}
@deffn {Método} IMAP4.enable (capability)

Enable `capability' (see 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html}).  Most capabilities do not need to be
enabled.  Currently only the @code{UTF8=ACCEPT} capability is supported
(see 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html}).


Adicionado na versão 3.5: The @ref{e39,,enable()} method itself, and 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} support.

@end deffn

@geindex expunge() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 expunge}@anchor{3cff}
@deffn {Método} IMAP4.expunge ()

Permanently remove deleted items from selected mailbox. Generates an @code{EXPUNGE}
response for each deleted message. Returned data contains a list of @code{EXPUNGE}
message numbers in order received.
@end deffn

@geindex fetch() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 fetch}@anchor{3d00}
@deffn {Método} IMAP4.fetch (message_set, message_parts)

Fetch (parts of) messages.  `message_parts' should be a string of message part
names enclosed within parentheses, eg: @code{"(UID BODY[TEXT])"}.  Returned data
are tuples of message part envelope and data.
@end deffn

@geindex getacl() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getacl}@anchor{3d01}
@deffn {Método} IMAP4.getacl (mailbox)

Get the @code{ACL}s for `mailbox'. The method is non-standard, but is supported
by the @code{Cyrus} server.
@end deffn

@geindex getannotation() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getannotation}@anchor{3d02}
@deffn {Método} IMAP4.getannotation (mailbox, entry, attribute)

Retrieve the specified @code{ANNOTATION}s for `mailbox'. The method is
non-standard, but is supported by the @code{Cyrus} server.
@end deffn

@geindex getquota() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getquota}@anchor{3d03}
@deffn {Método} IMAP4.getquota (root)

Get the @code{quota} `root'’s resource usage and limits. This method is part of the
IMAP4 QUOTA extension defined in rfc2087.
@end deffn

@geindex getquotaroot() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 getquotaroot}@anchor{3d04}
@deffn {Método} IMAP4.getquotaroot (mailbox)

Get the list of @code{quota} @code{roots} for the named `mailbox'. This method is part
of the IMAP4 QUOTA extension defined in rfc2087.
@end deffn

@geindex list() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 list}@anchor{3d05}
@deffn {Método} IMAP4.list ([directory[, pattern]])

List mailbox names in `directory' matching `pattern'.  `directory' defaults to
the top-level mail folder, and `pattern' defaults to match anything.  Returned
data contains a list of @code{LIST} responses.
@end deffn

@geindex login() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 login}@anchor{3d06}
@deffn {Método} IMAP4.login (user, password)

Identify the client using a plaintext password. The `password' will be quoted.
@end deffn

@geindex login_cram_md5() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 login_cram_md5}@anchor{15f9}
@deffn {Método} IMAP4.login_cram_md5 (user, password)

Force use of @code{CRAM-MD5} authentication when identifying the client to protect
the password.  Will only work if the server @code{CAPABILITY} response includes the
phrase @code{AUTH=CRAM-MD5}.


Alterado na versão 3.13.8: An @ref{15fa,,IMAP4.error} is raised if MD5 support is not available.

@end deffn

@geindex logout() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 logout}@anchor{a9d}
@deffn {Método} IMAP4.logout ()

Shutdown connection to server. Returns server @code{BYE} response.


Alterado na versão 3.8: The method no longer ignores silently arbitrary exceptions.

@end deffn

@geindex lsub() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 lsub}@anchor{3d07}
@deffn {Método} IMAP4.lsub (directory='""', pattern='*')

List subscribed mailbox names in directory matching pattern. `directory'
defaults to the top level directory and `pattern' defaults to match any mailbox.
Returned data are tuples of message part envelope and data.
@end deffn

@geindex myrights() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 myrights}@anchor{3d08}
@deffn {Método} IMAP4.myrights (mailbox)

Show my ACLs for a mailbox (i.e. the rights that I have on mailbox).
@end deffn

@geindex namespace() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 namespace}@anchor{3d09}
@deffn {Método} IMAP4.namespace ()

Returns IMAP namespaces as defined in 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html}.
@end deffn

@geindex noop() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 noop}@anchor{3d0a}
@deffn {Método} IMAP4.noop ()

Envia @code{NOOP} para o servidor.
@end deffn

@geindex open() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 open}@anchor{90b}
@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{202,,ValueError} to reject creating a non-blocking socket.
This method is implicitly called by the @ref{909,,IMAP4} constructor.
The connection objects established by this method will be used in
the @ref{3d0b,,IMAP4.read()}, @ref{3d0c,,IMAP4.readline()}, @ref{3d0d,,IMAP4.send()},
and @ref{3d0e,,IMAP4.shutdown()} methods. You may override this method.

Levanta um @ref{19fa,,evento de auditoria} @code{imaplib.open} com os argumentos @code{self}, @code{host}, @code{port}.


Alterado na versão 3.9: The `timeout' parameter was added.

@end deffn

@geindex partial() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 partial}@anchor{3d0f}
@deffn {Método} IMAP4.partial (message_num, message_part, start, length)

Fetch truncated part of a message. Returned data is a tuple of message part
envelope and data.
@end deffn

@geindex proxyauth() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 proxyauth}@anchor{3d10}
@deffn {Método} IMAP4.proxyauth (user)

Assume authentication as `user'. Allows an authorised administrator to proxy
into any user’s mailbox.
@end deffn

@geindex read() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 read}@anchor{3d0b}
@deffn {Método} IMAP4.read (size)

Reads `size' bytes from the remote server. You may override this method.
@end deffn

@geindex readline() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 readline}@anchor{3d0c}
@deffn {Método} IMAP4.readline ()

Reads one line from the remote server. You may override this method.
@end deffn

@geindex recent() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 recent}@anchor{3d11}
@deffn {Método} IMAP4.recent ()

Prompt server for an update. Returned data is @code{None} if no new messages, else
value of @code{RECENT} response.
@end deffn

@geindex rename() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 rename}@anchor{3d12}
@deffn {Método} IMAP4.rename (oldmailbox, newmailbox)

Rename mailbox named `oldmailbox' to `newmailbox'.
@end deffn

@geindex response() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 response}@anchor{3d13}
@deffn {Método} IMAP4.response (code)

Return data for response `code' if received, or @code{None}. Returns the given
code, instead of the usual type.
@end deffn

@geindex search() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 search}@anchor{3d14}
@deffn {Método} IMAP4.search (charset, criterion[, ...])

Search mailbox for matching messages.  `charset' may be @code{None}, in which case
no @code{CHARSET} will be specified in the request to the server.  The IMAP
protocol requires that at least one criterion be specified; an exception will be
raised when the server returns an error.  `charset' must be @code{None} if
the @code{UTF8=ACCEPT} capability was enabled using the @ref{e39,,enable()}
command.

Exemplo:

@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 imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 select}@anchor{3d15}
@deffn {Método} IMAP4.select (mailbox='INBOX', readonly=False)

Select a mailbox. Returned data is the count of messages in `mailbox'
(@code{EXISTS} response).  The default `mailbox' is @code{'INBOX'}.  If the `readonly'
flag is set, modifications to the mailbox are not allowed.
@end deffn

@geindex send() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 send}@anchor{3d0d}
@deffn {Método} IMAP4.send (data)

Sends @code{data} to the remote server. You may override this method.

Levanta um @ref{19fa,,evento de auditoria} @code{imaplib.send} com os argumentos @code{self}, @code{data}.
@end deffn

@geindex setacl() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setacl}@anchor{3d16}
@deffn {Método} IMAP4.setacl (mailbox, who, what)

Set an @code{ACL} for `mailbox'. The method is non-standard, but is supported by
the @code{Cyrus} server.
@end deffn

@geindex setannotation() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setannotation}@anchor{3d17}
@deffn {Método} IMAP4.setannotation (mailbox, entry, attribute[, ...])

Set @code{ANNOTATION}s for `mailbox'. The method is non-standard, but is
supported by the @code{Cyrus} server.
@end deffn

@geindex setquota() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 setquota}@anchor{3d18}
@deffn {Método} IMAP4.setquota (root, limits)

Set the @code{quota} `root'’s resource `limits'. This method is part of the IMAP4
QUOTA extension defined in rfc2087.
@end deffn

@geindex shutdown() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 shutdown}@anchor{3d0e}
@deffn {Método} IMAP4.shutdown ()

Close connection established in @code{open}.  This method is implicitly
called by @ref{a9d,,IMAP4.logout()}.  You may override this method.
@end deffn

@geindex socket() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 socket}@anchor{3d19}
@deffn {Método} IMAP4.socket ()

Returns socket instance used to connect to server.
@end deffn

@geindex sort() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 sort}@anchor{3d1a}
@deffn {Método} IMAP4.sort (sort_criteria, charset, search_criterion[, ...])

The @code{sort} command is a variant of @code{search} with sorting semantics for the
results.  Returned data contains a space separated list of matching message
numbers.

Sort has two arguments before the `search_criterion' argument(s); a
parenthesized list of `sort_criteria', and the searching `charset'.  Note that
unlike @code{search}, the searching `charset' argument is mandatory.  There is also
a @code{uid sort} command which corresponds to @code{sort} the way that @code{uid search}
corresponds to @code{search}.  The @code{sort} command first searches the mailbox for
messages that match the given searching criteria using the charset argument for
the interpretation of strings in the searching criteria.  It then returns the
numbers of matching messages.

This is an @code{IMAP4rev1} extension command.
@end deffn

@geindex starttls() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 starttls}@anchor{1266}
@deffn {Método} IMAP4.starttls (ssl_context=None)

Send a @code{STARTTLS} command.  The `ssl_context' argument is optional
and should be a @ref{294,,ssl.SSLContext} object.  This will enable
encryption on the IMAP connection.  Please read @ref{354c,,Considerações de segurança} for
best practices.


Adicionado na versão 3.2.



Alterado na versão 3.4: The method now supports hostname check with
@ref{3676,,ssl.SSLContext.check_hostname} and `Server Name Indication' (see
@ref{3688,,ssl.HAS_SNI}).

@end deffn

@geindex status() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 status}@anchor{3d1b}
@deffn {Método} IMAP4.status (mailbox, names)

Request named status conditions for `mailbox'.
@end deffn

@geindex store() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 store}@anchor{3d1c}
@deffn {Método} IMAP4.store (message_set, command, flag_list)

Alters flag dispositions for messages in mailbox.  `command' is specified by
section 6.4.6 of 
@geindex RFC; RFC 2060
RFC 2060@footnote{https://datatracker.ietf.org/doc/html/rfc2060.html} as being one of “FLAGS”, “+FLAGS”, or “-FLAGS”,
optionally with a suffix of “.SILENT”.

For example, to set the delete flag on all messages:

@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 imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 subscribe}@anchor{3d1d}
@deffn {Método} IMAP4.subscribe (mailbox)

Subscribe to new mailbox.
@end deffn

@geindex thread() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 thread}@anchor{3d1e}
@deffn {Método} IMAP4.thread (threading_algorithm, charset, search_criterion[, ...])

The @code{thread} command is a variant of @code{search} with threading semantics for
the results.  Returned data contains a space separated list of thread members.

Thread members consist of zero or more messages numbers, delimited by spaces,
indicating successive parent and child.

Thread has two arguments before the `search_criterion' argument(s); a
`threading_algorithm', and the searching `charset'.  Note that unlike
@code{search}, the searching `charset' argument is mandatory.  There is also a
@code{uid thread} command which corresponds to @code{thread} the way that @code{uid
search} corresponds to @code{search}.  The @code{thread} command first searches the
mailbox for messages that match the given searching criteria using the `charset'
argument for the interpretation of strings in the searching criteria. It then
returns the matching messages threaded according to the specified threading
algorithm.

This is an @code{IMAP4rev1} extension command.
@end deffn

@geindex uid() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 uid}@anchor{3d1f}
@deffn {Método} IMAP4.uid (command, arg[, ...])

Execute command args with messages identified by UID, rather than message
number.  Returns response appropriate to command.  At least one argument must be
supplied; if none are provided, the server will return an error and an exception
will be raised.
@end deffn

@geindex unsubscribe() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 unsubscribe}@anchor{3d20}
@deffn {Método} IMAP4.unsubscribe (mailbox)

Unsubscribe from old mailbox.
@end deffn

@geindex unselect() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 unselect}@anchor{90d}
@deffn {Método} IMAP4.unselect ()

@ref{90d,,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{90e,,imaplib.IMAP4.close()}, except
that no messages are permanently removed from the currently
selected mailbox.


Adicionado na versão 3.9.

@end deffn

@geindex xatom() (método imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 xatom}@anchor{3d21}
@deffn {Método} IMAP4.xatom (name[, ...])

Allow simple extension commands notified by server in @code{CAPABILITY} response.
@end deffn

The following attributes are defined on instances of @ref{909,,IMAP4}:

@geindex PROTOCOL_VERSION (atributo imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 PROTOCOL_VERSION}@anchor{3d22}
@deffn {Atributo} IMAP4.PROTOCOL_VERSION

The most recent supported protocol in the @code{CAPABILITY} response from the
server.
@end deffn

@geindex debug (atributo imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 debug}@anchor{3d23}
@deffn {Atributo} IMAP4.debug

Integer value to control debugging output.  The initialize value is taken from
the module variable @code{Debug}.  Values greater than three trace each command.
@end deffn

@geindex utf8_enabled (atributo imaplib.IMAP4)
@anchor{library/imaplib imaplib IMAP4 utf8_enabled}@anchor{e3a}
@deffn {Atributo} IMAP4.utf8_enabled

Boolean value that is normally @code{False}, but is set to @code{True} if an
@ref{e39,,enable()} command is successfully issued for the @code{UTF8=ACCEPT}
capability.


Adicionado na versão 3.5.

@end deffn

@node Exemplo IMAP4,,Objetos IMAP4,imaplib — IMAP4 protocol client
@anchor{library/imaplib id2}@anchor{3d24}@anchor{library/imaplib imap4-example}@anchor{3d25}
@subsubsection Exemplo IMAP4


Here is a minimal example (without error checking) that opens a mailbox and
retrieves and prints all messages:

@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 — Cliente de protocolo SMTP,uuid — Objetos UUID conforme RFC 4122,imaplib — IMAP4 protocol client,Protocolos de Internet e Suporte
@anchor{library/smtplib doc}@anchor{3d26}@anchor{library/smtplib module-smtplib}@anchor{ca}@anchor{library/smtplib smtplib-smtp-protocol-client}@anchor{3d27}@anchor{library/smtplib translation-repo}@anchor{3d28}
@subsection @code{smtplib} — Cliente de protocolo SMTP


@geindex module; smtplib

`Código-fonte:' Lib/smtplib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/smtplib.py}

@geindex SMTP;protocolo
@geindex Simple Mail Transfer Protocol


__________________________________________________________________


O módulo @ref{ca,,smtplib} define um objeto de sessão de cliente SMTP que pode ser usado para enviar e-mails para qualquer máquina da internet com um daemon de escuta SMTP ou ESMTP. Para obter detalhes sobre a operação SMTP e ESMTP, consulte 
@geindex RFC; RFC 821
RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} (Simple Mail Transfer Protocol) e 
@geindex RFC; RFC 1869
RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} (SMTP Service Extensions).

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@geindex SMTP (classe em smtplib)
@anchor{library/smtplib smtplib SMTP}@anchor{934}
@deffn {Classe} smtplib.SMTP (host='@w{'}, port=0, local_hostname=None[, timeout], source_address=None)

An @ref{934,,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{1b41,,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{1875,,socket.getfqdn()}.  If the @ref{1b41,,connect()} call returns anything other
than a success code, an @ref{3d29,,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{838,,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.

For normal use, you should only require the initialization/connect,
@ref{e88,,sendmail()}, and @ref{3d2a,,SMTP.quit()} methods.
An example is included below.

The @ref{934,,SMTP} class supports the @ref{5d2,,with} statement.  When used
like this, the SMTP @code{QUIT} command is issued automatically when the
@code{with} statement exits.  E.g.:

@example
>>> from smtplib import SMTP
>>> with SMTP("domain.org") as smtp:
...     smtp.noop()
...
(250, b'Ok')
>>>
@end example


All commands will raise an @ref{19fa,,auditing event}
@code{smtplib.SMTP.send} with arguments @code{self} and @code{data},
where @code{data} is the bytes about to be sent to the remote host.



Alterado na versão 3.3: Suporte para a instrução @ref{5d2,,with} foi adicionado.



Alterado na versão 3.3: `source_address' argument was added.



Adicionado na versão 3.5: A extensão SMTPUTF8 ( 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} ) é suportada agora.



Alterado na versão 3.9: Se o parâmetro `timeout' for definido como zero, será levantada @ref{202,,ValueError} para impedir a criação de um soquete não bloqueante.

@end deffn

@geindex SMTP_SSL (classe em smtplib)
@anchor{library/smtplib smtplib SMTP_SSL}@anchor{935}
@deffn {Classe} smtplib.SMTP_SSL (host='@w{'}, port=0, local_hostname=None, *[, timeout], context=None, source_address=None)

An @ref{935,,SMTP_SSL} instance behaves exactly the same as instances of
@ref{934,,SMTP}. @ref{935,,SMTP_SSL} should be used for situations where SSL is
required from the beginning of the connection and using @ref{1177,,starttls()}
is not appropriate. If `host' is not specified, the local host is used. If
`port' is zero, the standard SMTP-over-SSL port (465) is used.  The optional
arguments `local_hostname', `timeout' and `source_address' have the same
meaning as they do in the @ref{934,,SMTP} class.  `context', also optional,
can contain a @ref{294,,SSLContext} and allows configuring various
aspects of the secure connection.  Please read @ref{354c,,Considerações de segurança} for
best practices.


Alterado na versão 3.3: `context' foi adicionado.



Alterado na versão 3.3: O argumento `source_address' foi adicionado.



Alterado na versão 3.4: A classe agora oferece suporte a verificação de nome de host com @ref{3676,,ssl.SSLContext.check_hostname} e `Indicação de nome de servidor' (veja @ref{3688,,ssl.HAS_SNI}).



Alterado na versão 3.9: If the `timeout' parameter is set to be zero, it will raise a
@ref{202,,ValueError} to prevent the creation of a non-blocking socket



Alterado na versão 3.12: Os parâmetros depreciados `keyfile' e `certfile'  foram removidos.

@end deffn

@geindex LMTP (classe em smtplib)
@anchor{library/smtplib smtplib LMTP}@anchor{936}
@deffn {Classe} 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
@ref{1b41,,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{934,,SMTP} class. To specify a Unix
socket, you must use an absolute path for `host', starting with a ‘/’.

Authentication is supported, using the regular SMTP mechanism. When using a
Unix socket, LMTP generally don’t support or require any authentication, but
your mileage might vary.


Alterado na versão 3.9: O parâmetro opcional  `timeout' foi adicionado.

@end deffn

A nice selection of exceptions is defined as well:

@geindex SMTPException
@anchor{library/smtplib smtplib SMTPException}@anchor{fd5}
@deffn {Exceção} smtplib.SMTPException

Subclass of @ref{417,,OSError} that is the base exception class for all
the other exceptions provided by this module.


Alterado na versão 3.4: SMTPException became subclass of @ref{417,,OSError}

@end deffn

@geindex SMTPServerDisconnected
@anchor{library/smtplib smtplib SMTPServerDisconnected}@anchor{3d2b}
@deffn {Exceção} smtplib.SMTPServerDisconnected

This exception is raised when the server unexpectedly disconnects, or when an
attempt is made to use the @ref{934,,SMTP} instance before connecting it to a
server.
@end deffn

@geindex SMTPResponseException
@anchor{library/smtplib smtplib SMTPResponseException}@anchor{3d2c}
@deffn {Exceção} smtplib.SMTPResponseException

Base class for all exceptions that include an SMTP error code. These exceptions
are generated in some instances when the SMTP server returns an error code.

@geindex smtp_code (atributo smtplib.SMTPResponseException)
@anchor{library/smtplib smtplib SMTPResponseException smtp_code}@anchor{3d2d}
@deffn {Atributo} smtp_code

O código do erro.
@end deffn

@geindex smtp_error (atributo smtplib.SMTPResponseException)
@anchor{library/smtplib smtplib SMTPResponseException smtp_error}@anchor{3d2e}
@deffn {Atributo} smtp_error

The error message.
@end deffn
@end deffn

@geindex SMTPSenderRefused
@anchor{library/smtplib smtplib SMTPSenderRefused}@anchor{3d2f}
@deffn {Exceção} smtplib.SMTPSenderRefused

Sender address refused.  In addition to the attributes set by on all
@ref{3d2c,,SMTPResponseException} exceptions, this sets ‘sender’ to the string that
the SMTP server refused.
@end deffn

@geindex SMTPRecipientsRefused
@anchor{library/smtplib smtplib SMTPRecipientsRefused}@anchor{3d30}
@deffn {Exceção} smtplib.SMTPRecipientsRefused

All recipient addresses refused.

@geindex recipients (atributo smtplib.SMTPRecipientsRefused)
@anchor{library/smtplib smtplib SMTPRecipientsRefused recipients}@anchor{3d31}
@deffn {Atributo} recipients

A dictionary of exactly the same sort as returned
by @ref{e88,,SMTP.sendmail()} containing the errors for
each recipient.
@end deffn
@end deffn

@geindex SMTPDataError
@anchor{library/smtplib smtplib SMTPDataError}@anchor{3d32}
@deffn {Exceção} smtplib.SMTPDataError

O servidor SMTP recusou aceitar o dados da mensagem.
@end deffn

@geindex SMTPConnectError
@anchor{library/smtplib smtplib SMTPConnectError}@anchor{3d29}
@deffn {Exceção} smtplib.SMTPConnectError

Ocorreu um erro ao estabelecer uma conexão com o servidor.
@end deffn

@geindex SMTPHeloError
@anchor{library/smtplib smtplib SMTPHeloError}@anchor{3d33}
@deffn {Exceção} smtplib.SMTPHeloError

O servidor recusou sua mensagem @code{HELO}.
@end deffn

@geindex SMTPNotSupportedError
@anchor{library/smtplib smtplib SMTPNotSupportedError}@anchor{1b40}
@deffn {Exceção} smtplib.SMTPNotSupportedError

The command or option attempted is not supported by the server.


Adicionado na versão 3.5.

@end deffn

@geindex SMTPAuthenticationError
@anchor{library/smtplib smtplib SMTPAuthenticationError}@anchor{3d34}
@deffn {Exceção} smtplib.SMTPAuthenticationError

SMTP authentication went wrong.  Most probably the server didn’t accept the
username/password combination provided.
@end deffn


@subsubheading Ver também



@table @asis

@geindex RFC; RFC 821

@item RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} - Simple Mail Transfer Protocol

Protocol definition for SMTP.  This document covers the model, operating
procedure, and protocol details for SMTP.

@geindex RFC; RFC 1869

@item RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} - SMTP Service Extensions

Definition of the ESMTP extensions for SMTP.  This describes a framework for
extending SMTP with new commands, supporting dynamic discovery of the commands
provided by the server, and defines a few additional commands.
@end table


@menu
* Objetos SMTP:: 
* Exemplo SMTP:: 

@end menu

@node Objetos SMTP,Exemplo SMTP,,smtplib — Cliente de protocolo SMTP
@anchor{library/smtplib id1}@anchor{3d35}@anchor{library/smtplib smtp-objects}@anchor{3d36}
@subsubsection Objetos SMTP


An @ref{934,,SMTP} instance has the following methods:

@geindex set_debuglevel() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP set_debuglevel}@anchor{e87}
@deffn {Método} SMTP.set_debuglevel (level)

Set the debug output level.  A value of 1 or @code{True} for `level' results in
debug messages for connection and for all messages sent to and received from
the server.  A value of 2 for `level' results in these messages being
timestamped.


Alterado na versão 3.5: Adicionado o nível de depuração 2.

@end deffn

@geindex docmd() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP docmd}@anchor{3d37}
@deffn {Método} SMTP.docmd (cmd, args='@w{'})

Send a command `cmd' to the server.  The optional argument `args' is simply
concatenated to the command, separated by a space.

This returns a 2-tuple composed of a numeric response code and the actual
response line (multiline responses are joined into one long line.)

In normal operation it should not be necessary to call this method explicitly.
It is used to implement other methods and may be useful for testing private
extensions.

If the connection to the server is lost while waiting for the reply,
@ref{3d2b,,SMTPServerDisconnected} will be raised.
@end deffn

@geindex connect() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP connect}@anchor{1b41}
@deffn {Método} SMTP.connect (host='localhost', port=0)

Connect to a host on a given port.  The defaults are to connect to the local
host at the standard SMTP port (25). If the hostname ends with a colon (@code{':'})
followed by a number, that suffix will be stripped off and the number
interpreted as the port number to use. This method is automatically invoked by
the constructor if a host is specified during instantiation.  Returns a
2-tuple of the response code and message sent by the server in its
connection response.

Levanta um @ref{19fa,,evento de auditoria} @code{smtplib.connect} com os argumentos @code{self}, @code{host}, @code{port}.
@end deffn

@geindex helo() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP helo}@anchor{3d38}
@deffn {Método} SMTP.helo (name='@w{'})

Identify yourself to the SMTP server using @code{HELO}.  The hostname argument
defaults to the fully qualified domain name of the local host.
The message returned by the server is stored as the @ref{3d39,,helo_resp} attribute
of the object.

In normal operation it should not be necessary to call this method explicitly.
It will be implicitly called by the @ref{e88,,sendmail()} when necessary.
@end deffn

@geindex ehlo() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP ehlo}@anchor{3d3a}
@deffn {Método} SMTP.ehlo (name='@w{'})

Identify yourself to an ESMTP server using @code{EHLO}.  The hostname argument
defaults to the fully qualified domain name of the local host.  Examine the
response for ESMTP option and store them for use by @ref{3d3b,,has_extn()}.
Also sets several informational attributes: the message returned by
the server is stored as the @ref{3d3c,,ehlo_resp} attribute, @ref{3d3d,,does_esmtp}
is set to @code{True} or @code{False} depending on whether the server supports
ESMTP, and @ref{3d3e,,esmtp_features} will be a dictionary containing the names
of the SMTP service extensions this server supports, and their parameters
(if any).

Unless you wish to use @ref{3d3b,,has_extn()} before sending mail, it should not be
necessary to call this method explicitly.  It will be implicitly called by
@ref{e88,,sendmail()} when necessary.
@end deffn

@geindex ehlo_or_helo_if_needed() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP ehlo_or_helo_if_needed}@anchor{3d3f}
@deffn {Método} SMTP.ehlo_or_helo_if_needed ()

This method calls @ref{3d3a,,ehlo()} and/or @ref{3d38,,helo()} if there has been no
previous @code{EHLO} or @code{HELO} command this session.  It tries ESMTP @code{EHLO}
first.


@table @asis

@item @ref{3d33,,SMTPHeloError}

The server didn’t reply properly to the @code{HELO} greeting.
@end table
@end deffn

@geindex has_extn() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP has_extn}@anchor{3d3b}
@deffn {Método} SMTP.has_extn (name)

Return @ref{c27,,True} if `name' is in the set of SMTP service extensions returned
by the server, @ref{b49,,False} otherwise. Case is ignored.
@end deffn

@geindex verify() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP verify}@anchor{3d40}
@deffn {Método} SMTP.verify (address)

Check the validity of an address on this server using SMTP @code{VRFY}. Returns a
tuple consisting of code 250 and a full 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} address (including human
name) if the user address is valid. Otherwise returns an SMTP error code of 400
or greater and an error string.

@cartouche
@quotation Nota 
Muitos servidores desabilitam o SMTP @code{VRFY} para despistar spammers.
@end quotation
@end cartouche
@end deffn

@geindex login() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP login}@anchor{3d41}
@deffn {Método} SMTP.login (user, password, *, initial_response_ok=True)

Log in on an SMTP server that requires authentication. The arguments are the
username and the password to authenticate with. If there has been no previous
@code{EHLO} or @code{HELO} command this session, this method tries ESMTP @code{EHLO}
first. This method will return normally if the authentication was successful, or
may raise the following exceptions:


@table @asis

@item @ref{3d33,,SMTPHeloError}

The server didn’t reply properly to the @code{HELO} greeting.

@item @ref{3d34,,SMTPAuthenticationError}

O servidor não aceitou a combinação de usuário/senha.

@item @ref{1b40,,SMTPNotSupportedError}

The @code{AUTH} command is not supported by the server.

@item @ref{fd5,,SMTPException}

No suitable authentication method was found.
@end table

Each of the authentication methods supported by @ref{ca,,smtplib} are tried in
turn if they are advertised as supported by the server.  See @ref{e86,,auth()}
for a list of supported authentication methods.  `initial_response_ok' is
passed through to @ref{e86,,auth()}.

Optional keyword argument `initial_response_ok' specifies whether, for
authentication methods that support it, an “initial response” as specified
in 
@geindex RFC; RFC 4954
RFC 4954@footnote{https://datatracker.ietf.org/doc/html/rfc4954.html} can be sent along with the @code{AUTH} command, rather than
requiring a challenge/response.


Alterado na versão 3.5: @ref{1b40,,SMTPNotSupportedError} may be raised, and the
`initial_response_ok' parameter was added.

@end deffn

@geindex auth() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP auth}@anchor{e86}
@deffn {Método} SMTP.auth (mechanism, authobject, *, initial_response_ok=True)

Issue an @code{SMTP} @code{AUTH} command for the specified authentication
`mechanism', and handle the challenge response via `authobject'.

`mechanism' specifies which authentication mechanism is to
be used as argument to the @code{AUTH} command; the valid values are
those listed in the @code{auth} element of @ref{3d3e,,esmtp_features}.

`authobject' must be a callable object taking an optional single argument:

@example
data = authobject(challenge=None)
@end example

If optional keyword argument `initial_response_ok' is true,
@code{authobject()} will be called first with no argument.  It can return the
@geindex RFC; RFC 4954
RFC 4954@footnote{https://datatracker.ietf.org/doc/html/rfc4954.html} “initial response” ASCII @code{str} which will be encoded and sent with
the @code{AUTH} command as below.  If the @code{authobject()} does not support an
initial response (e.g. because it requires a challenge), it should return
@code{None} when called with @code{challenge=None}.  If `initial_response_ok' is
false, then @code{authobject()} will not be called first with @code{None}.

If the initial response check returns @code{None}, or if `initial_response_ok' is
false, @code{authobject()} will be called to process the server’s challenge
response; the `challenge' argument it is passed will be a @code{bytes}.  It
should return ASCII @code{str} `data' that will be base64 encoded and sent to the
server.

The @code{SMTP} class provides @code{authobjects} for the @code{CRAM-MD5}, @code{PLAIN},
and @code{LOGIN} mechanisms; they are named @code{SMTP.auth_cram_md5},
@code{SMTP.auth_plain}, and @code{SMTP.auth_login} respectively.  They all require
that the @code{user} and @code{password} properties of the @code{SMTP} instance are
set to appropriate values.

User code does not normally need to call @code{auth} directly, but can instead
call the @ref{3d41,,login()} method, which will try each of the above mechanisms
in turn, in the order listed.  @code{auth} is exposed to facilitate the
implementation of authentication methods not (or not yet) supported
directly by @ref{ca,,smtplib}.


Adicionado na versão 3.5.

@end deffn

@geindex starttls() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP starttls}@anchor{1177}
@deffn {Método} SMTP.starttls (*, context=None)

Put the SMTP connection in TLS (Transport Layer Security) mode.  All SMTP
commands that follow will be encrypted.  You should then call @ref{3d3a,,ehlo()}
again.

If `keyfile' and `certfile' are provided, they are used to create an
@ref{294,,ssl.SSLContext}.

Optional `context' parameter is an @ref{294,,ssl.SSLContext} object; This is
an alternative to using a keyfile and a certfile and if specified both
`keyfile' and `certfile' should be @code{None}.

If there has been no previous @code{EHLO} or @code{HELO} command this session,
this method tries ESMTP @code{EHLO} first.


Alterado na versão 3.12: Os parâmetros depreciados `keyfile' e `certfile'  foram removidos.



@table @asis

@item @ref{3d33,,SMTPHeloError}

The server didn’t reply properly to the @code{HELO} greeting.

@item @ref{1b40,,SMTPNotSupportedError}

O servidor não da suporte a extensão STARTTLS.

@item @ref{195,,RuntimeError}

SSL/TLS support is not available to your Python interpreter.
@end table


Alterado na versão 3.3: `context' foi adicionado.



Alterado na versão 3.4: The method now supports hostname check with
@ref{3676,,ssl.SSLContext.check_hostname} and `Server Name Indicator' (see
@ref{3688,,HAS_SNI}).



Alterado na versão 3.5: The error raised for lack of STARTTLS support is now the
@ref{1b40,,SMTPNotSupportedError} subclass instead of the base
@ref{fd5,,SMTPException}.

@end deffn

@geindex sendmail() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP sendmail}@anchor{e88}
@deffn {Método} SMTP.sendmail (from_addr, to_addrs, msg, mail_options=(), rcpt_options=())

Send mail.  The required arguments are an 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} from-address string, a list
of 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} to-address strings (a bare string will be treated as a list with 1
address), and a message string.  The caller may pass a list of ESMTP options
(such as @code{"8bitmime"}) to be used in @code{MAIL FROM} commands as `mail_options'.
ESMTP options (such as @code{DSN} commands) that should be used with all @code{RCPT}
commands can be passed as `rcpt_options'. Each option should be passed as a string
containing the full text of the option, including any potential key
(for instance, @code{"NOTIFY=SUCCESS,FAILURE"}). (If you need to use different ESMTP
options to different recipients you have to use the low-level methods such as
@code{mail()}, @code{rcpt()} and @code{data()} to send the message.)

@cartouche
@quotation Nota 
The `from_addr' and `to_addrs' parameters are used to construct the message
envelope used by the transport agents.  @code{sendmail} does not modify the
message headers in any way.
@end quotation
@end cartouche

`msg' may be a string containing characters in the ASCII range, or a byte
string.  A string is encoded to bytes using the ascii codec, and lone @code{\r}
and @code{\n} characters are converted to @code{\r\n} characters.  A byte string is
not modified.

If there has been no previous @code{EHLO} or @code{HELO} command this session, this
method tries ESMTP @code{EHLO} first. If the server does ESMTP, message size and
each of the specified options will be passed to it (if the option is in the
feature set the server advertises).  If @code{EHLO} fails, @code{HELO} will be tried
and ESMTP options suppressed.

This method will return normally if the mail is accepted for at least one
recipient. Otherwise it will raise an exception.  That is, if this method does
not raise an exception, then someone should get your mail. If this method does
not raise an exception, it returns a dictionary, with one entry for each
recipient that was refused.  Each entry contains a tuple of the SMTP error code
and the accompanying error message sent by the server.

If @code{SMTPUTF8} is included in `mail_options', and the server supports it,
`from_addr' and `to_addrs' may contain non-ASCII characters.

Esse método deve levantar as seguintes exceções:


@table @asis

@item @ref{3d30,,SMTPRecipientsRefused}

All recipients were refused.  Nobody got the mail.

@item @ref{3d33,,SMTPHeloError}

The server didn’t reply properly to the @code{HELO} greeting.

@item @ref{3d2f,,SMTPSenderRefused}

O servidor não aceita o  `from_addr'.

@item @ref{3d32,,SMTPDataError}

The server replied with an unexpected error code (other than a refusal of a
recipient).

@item @ref{1b40,,SMTPNotSupportedError}

@code{SMTPUTF8} was given in the `mail_options' but is not supported by the
server.
@end table

Unless otherwise noted, the connection will be open even after an exception is
raised.


Alterado na versão 3.2: `msg' may be a byte string.



Alterado na versão 3.5: @code{SMTPUTF8} support added, and @ref{1b40,,SMTPNotSupportedError} may be
raised if @code{SMTPUTF8} is specified but the server does not support it.

@end deffn

@geindex send_message() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP send_message}@anchor{e89}
@deffn {Método} SMTP.send_message (msg, from_addr=None, to_addrs=None, mail_options=(), rcpt_options=())

This is a convenience method for calling @ref{e88,,sendmail()} with the message
represented by an @ref{27c,,email.message.Message} object.  The arguments have
the same meaning as for @ref{e88,,sendmail()}, except that `msg' is a @code{Message}
object.

If `from_addr' is @code{None} or `to_addrs' is @code{None}, @code{send_message} fills
those arguments with addresses extracted from the headers of `msg' as
specified in 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}: `from_addr' is set to the @code{Sender}
field if it is present, and otherwise to the @code{From} field.
`to_addrs' combines the values (if any) of the @code{To},
@code{Cc}, and @code{Bcc} fields from `msg'.  If exactly one
set of @code{Resent-*} headers appear in the message, the regular
headers are ignored and the @code{Resent-*} headers are used instead.
If the message contains more than one set of @code{Resent-*} headers,
a @ref{202,,ValueError} is raised, since there is no way to unambiguously detect
the most recent set of @code{Resent-} headers.

@code{send_message} serializes `msg' using
@ref{120f,,BytesGenerator} with @code{\r\n} as the `linesep', and
calls @ref{e88,,sendmail()} to transmit the resulting message.  Regardless of the
values of `from_addr' and `to_addrs', @code{send_message} does not transmit any
@code{Bcc} or @code{Resent-Bcc} headers that may appear
in `msg'.  If any of the addresses in `from_addr' and `to_addrs' contain
non-ASCII characters and the server does not advertise @code{SMTPUTF8} support,
an @ref{1b40,,SMTPNotSupportedError} is raised.  Otherwise the @code{Message} is
serialized with a clone of its @ref{4f,,policy} with the
@ref{e24,,utf8} attribute set to @code{True}, and
@code{SMTPUTF8} and @code{BODY=8BITMIME} are added to `mail_options'.


Adicionado na versão 3.2.



Adicionado na versão 3.5: Support for internationalized addresses (@code{SMTPUTF8}).

@end deffn

@geindex quit() (método smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP quit}@anchor{3d2a}
@deffn {Método} SMTP.quit ()

Terminate the SMTP session and close the connection.  Return the result of
the SMTP @code{QUIT} command.
@end deffn

Low-level methods corresponding to the standard SMTP/ESMTP commands @code{HELP},
@code{RSET}, @code{NOOP}, @code{MAIL}, @code{RCPT}, and @code{DATA} are also supported.
Normally these do not need to be called directly, so they are not documented
here.  For details, consult the module code.

Additionally, an SMTP instance has the following attributes:

@geindex helo_resp (atributo smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP helo_resp}@anchor{3d39}
@deffn {Atributo} SMTP.helo_resp

The response to the @code{HELO} command, see @ref{3d38,,helo()}.
@end deffn

@geindex ehlo_resp (atributo smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP ehlo_resp}@anchor{3d3c}
@deffn {Atributo} SMTP.ehlo_resp

The response to the @code{EHLO} command, see @ref{3d3a,,ehlo()}.
@end deffn

@geindex does_esmtp (atributo smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP does_esmtp}@anchor{3d3d}
@deffn {Atributo} SMTP.does_esmtp

A boolean value indicating whether the server supports ESMTP, see
@ref{3d3a,,ehlo()}.
@end deffn

@geindex esmtp_features (atributo smtplib.SMTP)
@anchor{library/smtplib smtplib SMTP esmtp_features}@anchor{3d3e}
@deffn {Atributo} SMTP.esmtp_features

A dictionary of the names of SMTP service extensions supported by the server,
see @ref{3d3a,,ehlo()}.
@end deffn

@node Exemplo SMTP,,Objetos SMTP,smtplib — Cliente de protocolo SMTP
@anchor{library/smtplib id2}@anchor{3d42}@anchor{library/smtplib smtp-example}@anchor{3d43}
@subsubsection Exemplo 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 
In general, you will want to use the @ref{3b,,email} package’s features to
construct an email message, which you can then send
via @ref{e89,,send_message()}; see @ref{f6f,,email; Exemplos}.
@end quotation
@end cartouche

@node uuid — Objetos UUID conforme RFC 4122,socketserver — Um framework para servidores de rede,smtplib — Cliente de protocolo SMTP,Protocolos de Internet e Suporte
@anchor{library/uuid doc}@anchor{3d44}@anchor{library/uuid module-uuid}@anchor{110}@anchor{library/uuid translation-repo}@anchor{3d45}@anchor{library/uuid uuid-uuid-objects-according-to-rfc-4122}@anchor{3d46}
@subsection @code{uuid} — Objetos UUID conforme 
@geindex RFC; RFC 4122
`RFC 4122'


@geindex module; uuid

`Código-fonte:' Lib/uuid.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/uuid.py}


__________________________________________________________________


Este módulo fornece objetos @ref{a6a,,UUID} imutáveis (a classe @ref{a6a,,UUID}) e as funções @ref{bc0,,uuid1()}, @ref{1645,,uuid3()}, @ref{1646,,uuid4()}, @ref{1647,,uuid5()} para gerar UUIDs de versão 1, 3, 4 e 5, conforme especificado em 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.

Se tudo o que você quer é um ID único, você provavelmente deve chamar @ref{bc0,,uuid1()} ou @ref{1646,,uuid4()}. Note que @ref{bc0,,uuid1()} pode comprometer a privacidade, pois cria um UUID contendo o endereço de rede do computador. @ref{1646,,uuid4()} cria um UUID aleatório.

Dependendo do suporte da plataforma subjacente, @ref{bc0,,uuid1()} pode ou não retornar um UUID “seguro”. Um UUID seguro é aquele que é gerado usando métodos de sincronização que garantem que dois processos não possam obter o mesmo UUID. Todas as instâncias de @ref{a6a,,UUID} têm um atributo @ref{bbe,,is_safe} que retransmite qualquer informação sobre a segurança do UUID, usando esta enumeração:

@geindex SafeUUID (classe em uuid)
@anchor{library/uuid uuid SafeUUID}@anchor{3d47}
@deffn {Classe} uuid.SafeUUID


Adicionado na versão 3.7.


@geindex safe (atributo uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID safe}@anchor{3d48}
@deffn {Atributo} safe

O UUID foi gerado pela plataforma de forma segura para multiprocessamento.
@end deffn

@geindex unsafe (atributo uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID unsafe}@anchor{3d49}
@deffn {Atributo} unsafe

O UUID não foi gerado de forma segura para multiprocessamento.
@end deffn

@geindex unknown (atributo uuid.SafeUUID)
@anchor{library/uuid uuid SafeUUID unknown}@anchor{3d4a}
@deffn {Atributo} unknown

A plataforma não fornece informações sobre se o UUID foi gerado com segurança ou não.
@end deffn
@end deffn

@geindex UUID (classe em uuid)
@anchor{library/uuid uuid UUID}@anchor{a6a}
@deffn {Classe} uuid.UUID (hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

Cria um UUID a partir de uma sequência de 32 dígitos hexadecimais, uma sequência de 16 bytes em ordem big-endian como o argumento `bytes', uma sequência de 16 bytes em ordem little-endian como o argumento `bytes_le', uma tupla de seis inteiros (`time_low' de 32 bits, `time_mid' de 16 bits, `time_hi_version' de 16 bits, `clock_seq_hi_variant' de 8 bits, `clock_seq_low' de 8 bits, `node' de 48 bits) como o argumento `fields' ou um único inteiro de 128 bits como o argumento `int'. Quando uma sequência de dígitos hexadecimais é fornecida, chaves, hifens e um prefixo URN são todos opcionais. Por exemplo, todas essas expressões produzem o mesmo 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

Exatamente um de `hex', `bytes', `bytes_le', `fields' ou `int' deve ser fornecido. O argumento `version' é opcional; se fornecido, o UUID resultante terá sua variante e número de versão definidos de acordo com 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}, substituindo bits no `hex', `bytes', `bytes_le', `fields' ou `int' fornecido.

A comparação de objetos UUID é feita por meio da comparação de seus atributos @ref{3d4b,,UUID.int}. A comparação com um objeto não UUID levanta uma @ref{2c3,,TypeError}.

@code{str(uuid)} retorna uma string no formato @code{12345678-1234-5678-1234-567812345678} onde os 32 dígitos hexadecimais representam o UUID.
@end deffn

As instâncias @ref{a6a,,UUID} têm estes atributos de somente leitura:

@geindex bytes (atributo uuid.UUID)
@anchor{library/uuid uuid UUID bytes}@anchor{3d4c}
@deffn {Atributo} UUID.bytes

O UUID como uma string de 16 bytes (contendo os seis campos inteiros em ordem de bytes big-endian).
@end deffn

@geindex bytes_le (atributo uuid.UUID)
@anchor{library/uuid uuid UUID bytes_le}@anchor{3d4d}
@deffn {Atributo} UUID.bytes_le

O UUID como uma string de 16 bytes (com `time_low', `time_mid' e `time_hi_version' em ordem de bytes little-endian).
@end deffn

@geindex fields (atributo uuid.UUID)
@anchor{library/uuid uuid UUID fields}@anchor{3d4e}
@deffn {Atributo} UUID.fields

Uma tupla dos seis campos de inteiros do UUID, que também estão disponíveis como seis atributos individuais e dois atributos derivados:
@end deffn


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

Campo

@tab

Significado

@item

@geindex time_low (atributo uuid.UUID)
@anchor{library/uuid uuid UUID time_low}@anchor{3d4f}
@deffn {Atributo} UUID.time_low
@end deffn

@tab

Os primeiros 32 bits do UUID.

@item

@geindex time_mid (atributo uuid.UUID)
@anchor{library/uuid uuid UUID time_mid}@anchor{3d50}
@deffn {Atributo} UUID.time_mid
@end deffn

@tab

Os próximos 16 bits do UUID.

@item

@geindex time_hi_version (atributo uuid.UUID)
@anchor{library/uuid uuid UUID time_hi_version}@anchor{3d51}
@deffn {Atributo} UUID.time_hi_version
@end deffn

@tab

Os próximos 16 bits do UUID.

@item

@geindex clock_seq_hi_variant (atributo uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq_hi_variant}@anchor{3d52}
@deffn {Atributo} UUID.clock_seq_hi_variant
@end deffn

@tab

Os próximos 8 bits do UUID.

@item

@geindex clock_seq_low (atributo uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq_low}@anchor{3d53}
@deffn {Atributo} UUID.clock_seq_low
@end deffn

@tab

Os próximos 8 bits do UUID.

@item

@geindex node (atributo uuid.UUID)
@anchor{library/uuid uuid UUID node}@anchor{3d54}
@deffn {Atributo} UUID.node
@end deffn

@tab

Os últimos 48 bits do UUID.

@item

@geindex time (atributo uuid.UUID)
@anchor{library/uuid uuid UUID time}@anchor{3d55}
@deffn {Atributo} UUID.time
@end deffn

@tab

O registro de data e hora de 60 bits.

@item

@geindex clock_seq (atributo uuid.UUID)
@anchor{library/uuid uuid UUID clock_seq}@anchor{3d56}
@deffn {Atributo} UUID.clock_seq
@end deffn

@tab

O número de sequência de 14 bits.

@end multitable


@geindex hex (atributo uuid.UUID)
@anchor{library/uuid uuid UUID hex}@anchor{3d57}
@deffn {Atributo} UUID.hex

O UUID como uma sequência hexadecimal de 32 caracteres minúsculos.
@end deffn

@geindex int (atributo uuid.UUID)
@anchor{library/uuid uuid UUID int}@anchor{3d4b}
@deffn {Atributo} UUID.int

O UUID como um inteiro de 128 bits.
@end deffn

@geindex urn (atributo uuid.UUID)
@anchor{library/uuid uuid UUID urn}@anchor{3d58}
@deffn {Atributo} UUID.urn

O UUID como um URN conforme especificado no 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.
@end deffn

@geindex variant (atributo uuid.UUID)
@anchor{library/uuid uuid UUID variant}@anchor{3d59}
@deffn {Atributo} UUID.variant

A variante UUID, que determina o layout interno do UUID. Esta será uma das constantes @ref{3d5a,,RESERVED_NCS}, @ref{3d5b,,RFC_4122}, @ref{3d5c,,RESERVED_MICROSOFT} ou @ref{3d5d,,RESERVED_FUTURE}.
@end deffn

@geindex version (atributo uuid.UUID)
@anchor{library/uuid uuid UUID version}@anchor{3d5e}
@deffn {Atributo} UUID.version

O número da versão do UUID (1 a 5, significativo somente quando a variante é @ref{3d5b,,RFC_4122}).
@end deffn

@geindex is_safe (atributo uuid.UUID)
@anchor{library/uuid uuid UUID is_safe}@anchor{bbe}
@deffn {Atributo} UUID.is_safe

Uma enumeração de @ref{3d47,,SafeUUID} que indica se a plataforma gerou o UUID de forma segura para multiprocessamento.


Adicionado na versão 3.7.

@end deffn

O módulo @ref{110,,uuid} define as seguintes funções:

@geindex getnode() (no módulo uuid)
@anchor{library/uuid uuid getnode}@anchor{bbf}
@deffn {Função} uuid.getnode ()

Obtém o endereço de hardware como um inteiro positivo de 48 bits. Na primeira vez que isso for executado, ele pode iniciar um programa separado, o que pode ser bem lento. Se todas as tentativas de obter o endereço de hardware falharem, escolhemos um número aleatório de 48 bits com o bit multicast (bit menos significativo do primeiro octeto) definido como 1, conforme recomendado no 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}. “Endereço de hardware” significa o endereço MAC de uma interface de rede. Em uma máquina com várias interfaces de rede, endereços MAC administrados universalmente (ou seja, onde o segundo bit menos significativo do primeiro octeto é `não definido') serão preferidos em relação a endereços MAC administrados localmente, mas sem nenhuma outra garantia de ordenação.


Alterado na versão 3.7: Endereços MAC administrados universalmente são preferidos em vez de endereços MAC administrados localmente, pois os primeiros têm garantia de serem globalmente exclusivos, enquanto os últimos não.

@end deffn

@geindex uuid1() (no módulo uuid)
@anchor{library/uuid uuid uuid1}@anchor{bc0}
@deffn {Função} uuid.uuid1 (node=None, clock_seq=None)

Gera um UUID a partir de um ID de host, número de sequência e hora atual. Se `node' não for fornecido, @ref{bbf,,getnode()} é usado para obter o endereço de hardware. Se `clock_seq' for fornecido, ele é usado como o número de sequência; caso contrário, um número de sequência aleatório de 14 bits é escolhido.
@end deffn

@geindex uuid3() (no módulo uuid)
@anchor{library/uuid uuid uuid3}@anchor{1645}
@deffn {Função} uuid.uuid3 (namespace, name)

Gera um UUID com base no hash MD5 de um identificador de espaço de nomes (que é um UUID) e um nome (que é um objeto @ref{1c2,,bytes} ou uma string que será codificada usando UTF-8).
@end deffn

@geindex uuid4() (no módulo uuid)
@anchor{library/uuid uuid uuid4}@anchor{1646}
@deffn {Função} uuid.uuid4 ()

Gera um UUID aleatório.
@end deffn

@geindex uuid5() (no módulo uuid)
@anchor{library/uuid uuid uuid5}@anchor{1647}
@deffn {Função} uuid.uuid5 (namespace, name)

Gera um UUID com base no hash SHA-1 de um identificador de espaço de nomes (que é um UUID) e um nome (que é um objeto @ref{1c2,,bytes} ou uma string que será codificada usando UTF-8).
@end deffn

O módulo @ref{110,,uuid} define os seguintes identificadores de espaço de nomes para uso com @ref{1645,,uuid3()} ou @ref{1647,,uuid5()}.

@geindex NAMESPACE_DNS (no módulo uuid)
@anchor{library/uuid uuid NAMESPACE_DNS}@anchor{3d5f}
@deffn {Dado} uuid.NAMESPACE_DNS

Quando esse espaço de nomes é especificado, a string `name' é um nome de domínio totalmente qualificado.
@end deffn

@geindex NAMESPACE_URL (no módulo uuid)
@anchor{library/uuid uuid NAMESPACE_URL}@anchor{3d60}
@deffn {Dado} uuid.NAMESPACE_URL

Quando esse espaço de nomes é especificado, a string `name' é uma URL.
@end deffn

@geindex NAMESPACE_OID (no módulo uuid)
@anchor{library/uuid uuid NAMESPACE_OID}@anchor{3d61}
@deffn {Dado} uuid.NAMESPACE_OID

Quando esse espaço de nomes é especificado, a string `name' é um OID ISO.
@end deffn

@geindex NAMESPACE_X500 (no módulo uuid)
@anchor{library/uuid uuid NAMESPACE_X500}@anchor{3d62}
@deffn {Dado} uuid.NAMESPACE_X500

Quando esse espaço de nomes é especificado, a string `name' é um DN X.500 em DER ou um formato de saída de texto.
@end deffn

O módulo @ref{110,,uuid} define as seguintes constantes para os valores possíveis do atributo @ref{3d59,,variant}:

@geindex RESERVED_NCS (no módulo uuid)
@anchor{library/uuid uuid RESERVED_NCS}@anchor{3d5a}
@deffn {Dado} uuid.RESERVED_NCS

Reservado para compatibilidade com NCS.
@end deffn

@geindex RFC_4122 (no módulo uuid)
@anchor{library/uuid uuid RFC_4122}@anchor{3d5b}
@deffn {Dado} uuid.RFC_4122

Especifica o layout do UUID fornecido no 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}.
@end deffn

@geindex RESERVED_MICROSOFT (no módulo uuid)
@anchor{library/uuid uuid RESERVED_MICROSOFT}@anchor{3d5c}
@deffn {Dado} uuid.RESERVED_MICROSOFT

Reservado para compatibilidade com Microsoft.
@end deffn

@geindex RESERVED_FUTURE (no módulo uuid)
@anchor{library/uuid uuid RESERVED_FUTURE}@anchor{3d5d}
@deffn {Dado} uuid.RESERVED_FUTURE

Reservado para definição futura.
@end deffn


@subsubheading Ver também



@table @asis

@geindex RFC; RFC 4122

@item RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} - Um espaço de nomes de URN de identificador universalmente exclusivo (UUID)

Esta especificação define um espaço de nomes de Uniform Resource Name para UUIDs, o formato interno de UUIDs e métodos de geração de UUIDs.
@end table


@menu
* Uso na linha de comando: Uso na linha de comando<4>. 
* Exemplo: Exemplo<11>. 
* Exemplo de linha de comando:: 

@end menu

@node Uso na linha de comando<4>,Exemplo<11>,,uuid — Objetos UUID conforme RFC 4122
@anchor{library/uuid command-line-usage}@anchor{3d63}@anchor{library/uuid uuid-cli}@anchor{444}
@subsubsection Uso na linha de comando



Adicionado na versão 3.12.


O módulo @ref{110,,uuid} pode ser invocado como um script na linha de comando:

@example
python -m uuid [-h] [-u @{uuid1,uuid3,uuid4,uuid5@}] [-n ESPAÇO-DE-NOMES] [-N NOME]
@end example

As seguintes opções são aceitas:

@geindex uuid opção de linha de comando; -h
@geindex uuid opção de linha de comando; --help
@anchor{library/uuid cmdoption-uuid-h}@anchor{3d64}@anchor{library/uuid cmdoption-uuid-help}@anchor{3d65}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Mostra a mensagem de ajuda e sai.
@end deffn

@geindex uuid opção de linha de comando; -u
@geindex uuid opção de linha de comando; --uuid
@anchor{library/uuid cmdoption-uuid-u}@anchor{3d66}
@deffn {Option} @w{-}u <uuid>
@anchor{library/uuid cmdoption-uuid-uuid}@anchor{3d67}
@deffnx {Option} @w{-}@w{-}uuid <uuid>

Especifica o nome da função a ser usada para gerar o uuid. Por padrão, @ref{1646,,uuid4()} é usado.
@end deffn

@geindex uuid opção de linha de comando; -n
@geindex uuid opção de linha de comando; --namespace
@anchor{library/uuid cmdoption-uuid-n}@anchor{3d68}
@deffn {Option} @w{-}n <namespace>
@anchor{library/uuid cmdoption-uuid-namespace}@anchor{3d69}
@deffnx {Option} @w{-}@w{-}namespace <namespace>

O espaço de nomes é um @code{UUID}, ou @code{@@ns} onde @code{ns} é um UUID predefinido bem conhecido endereçado pelo nome do espaço de nomes. Como @code{@@dns}, @code{@@url}, @code{@@oid} e @code{@@x500}. Necessário apenas para funções @ref{1645,,uuid3()} / @ref{1647,,uuid5()}.
@end deffn

@geindex uuid opção de linha de comando; -N
@geindex uuid opção de linha de comando; --name
@anchor{library/uuid cmdoption-uuid-N}@anchor{3d6a}
@deffn {Option} @w{-}N <name>
@anchor{library/uuid cmdoption-uuid-name}@anchor{3d6b}
@deffnx {Option} @w{-}@w{-}name <name>

O nome usado como parte da geração do uuid. Requerido apenas para funções @ref{1645,,uuid3()} / @ref{1647,,uuid5()}.
@end deffn

@node Exemplo<11>,Exemplo de linha de comando,Uso na linha de comando<4>,uuid — Objetos UUID conforme RFC 4122
@anchor{library/uuid example}@anchor{3d6c}@anchor{library/uuid uuid-example}@anchor{3d6d}
@subsubsection Exemplo


Aqui estão alguns exemplos de uso típico do módulo @ref{110,,uuid}:

@example
>>> import uuid

>>> # cria um UUID com base no ID do host e o horário atual
>>> uuid.uuid1()
UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

>>> # cria um UUID usando um hash MD5 de um nome e um UUID de espaço de nomes
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

>>> # cria um UUID aleatório
>>> uuid.uuid4()
UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

>>> # cria um UUID usando um hash SHA-1 de um nome e um UUID de espaço de nomes
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

>>> # cria um UUID de uma string de dígitos hex (chaves e hífens ignorados)
>>> x = uuid.UUID('@{00010203-0405-0607-0809-0a0b0c0d0e0f@}')

>>> # converte um UUID para uma string de dígitos hex numa forma padrão
>>> str(x)
'00010203-0405-0607-0809-0a0b0c0d0e0f'

>>> # obtém o objeto bruto de 16 bytes do UUID
>>> x.bytes
b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'

>>> # cria um UUID de um string de 16 bytes
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')
@end example

@node Exemplo de linha de comando,,Exemplo<11>,uuid — Objetos UUID conforme RFC 4122
@anchor{library/uuid command-line-example}@anchor{3d6e}@anchor{library/uuid uuid-cli-example}@anchor{3d6f}
@subsubsection Exemplo de linha de comando


Aqui estão alguns exemplos de uso típico da interface de linha de comando do @ref{110,,uuid}:

@example
# gera um uuid aleatório - por padrão, uuid4() é usado
$ python -m uuid

# gera um uuid usando uuid1()
$ python -m uuid -u uuid1

# gera um uuid usando uuid5
$ python -m uuid -u uuid5 -n @@url -N example.com
@end example

@node socketserver — Um framework para servidores de rede,http server — HTTP servers,uuid — Objetos UUID conforme RFC 4122,Protocolos de Internet e Suporte
@anchor{library/socketserver doc}@anchor{3d70}@anchor{library/socketserver module-socketserver}@anchor{cd}@anchor{library/socketserver socketserver-a-framework-for-network-servers}@anchor{3d71}@anchor{library/socketserver translation-repo}@anchor{3d72}
@subsection @code{socketserver} — Um framework para servidores de rede


@geindex module; socketserver

`Código-fonte:' Lib/socketserver.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/socketserver.py}


__________________________________________________________________


O módulo @ref{cd,,socketserver} simplifica a tarefa de escrever servidores de rede.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

Existem quatro classes básicas de servidores concretos:

@geindex TCPServer (classe em socketserver)
@anchor{library/socketserver socketserver TCPServer}@anchor{1364}
@deffn {Classe} socketserver.TCPServer (server_address, RequestHandlerClass, bind_and_activate=True)

Isso usa o protocolo TCP da internet, que fornece fluxos contínuos de dados entre o cliente e o servidor. Se `bind_and_activate' for true, o construtor tenta automaticamente invocar @ref{3d73,,server_bind()} e @ref{3d74,,server_activate()}. Os outros parâmetros são passados para a classe base @ref{117c,,BaseServer}.
@end deffn

@geindex UDPServer (classe em socketserver)
@anchor{library/socketserver socketserver UDPServer}@anchor{3d75}
@deffn {Classe} socketserver.UDPServer (server_address, RequestHandlerClass, bind_and_activate=True)

Isso usa datagramas, que são pacotes discretos de informações que podem chegar fora de ordem ou ser perdidos durante o trânsito. Os parâmetros são os mesmos de @ref{1364,,TCPServer}.
@end deffn

@geindex UnixStreamServer (classe em socketserver)
@geindex UnixDatagramServer (classe em socketserver)
@anchor{library/socketserver socketserver UnixStreamServer}@anchor{3d76}
@deffn {Classe} socketserver.UnixStreamServer (server_address, RequestHandlerClass, bind_and_activate=True)
@anchor{library/socketserver socketserver UnixDatagramServer}@anchor{3d77}
@deffnx {Classe} socketserver.UnixDatagramServer (server_address, RequestHandlerClass, bind_and_activate=True)

Essas classes usadas com menos frequência são semelhantes às classes TCP e UDP, mas usam soquetes de domínio Unix; elas não estão disponíveis em plataformas não Unix. Os parâmetros são os mesmos de @ref{1364,,TCPServer}.
@end deffn

Essas quatro classes processam solicitações `synchronously'; cada solicitação deve ser concluída antes que a próxima solicitação possa ser iniciada. Isso não é adequado se cada solicitação demorar muito para ser concluída, porque exige muita computação ou porque retorna muitos dados que o cliente demora a processar. A solução é criar um processo ou thread separado para lidar com cada solicitação; as classes misturadas @ref{b90,,ForkingMixIn} e @ref{b58,,ThreadingMixIn} podem ser usadas para oferecer suporte ao comportamento assíncrono.

Criar um servidor requer várias etapas. Primeiro, você deve criar uma classe de manipulador de solicitação estendendo a classe @ref{3d78,,BaseRequestHandler} e substituindo seu método @ref{3d79,,handle()}; esse método processará as solicitações recebidas. Segundo, você deve instanciar uma das classes de servidor, passando a ela o endereço do servidor e a classe de manipulador de solicitação. É recomendável usar o servidor em uma instrução @ref{5d2,,with}. Em seguida, chame o método @ref{1367,,handle_request()} ou @ref{117e,,serve_forever()} do objeto do servidor para processar uma ou muitas solicitações. Finalmente, chame @ref{b8e,,server_close()} para fechar o soquete (a menos que você tenha usado uma instrução @code{with}).

Ao herdar de @ref{b58,,ThreadingMixIn} para comportamento de conexão em threads, você deve declarar explicitamente como quer que suas threads se comportem em um desligamento abrupto. A classe @ref{b58,,ThreadingMixIn} define um atributo `daemon_threads', que indica se o servidor deve ou não esperar pelo término da thread. Você deve definir o sinalizador explicitamente se quiser que as threads se comportem de forma autônoma; o padrão é @ref{b49,,False}, o que significa que o Python não sairá até que todas as threads criadas por @ref{b58,,ThreadingMixIn} tenham sido encerradas.

As classes de servidor têm os mesmos métodos e atributos externos, não importa qual protocolo de rede eles usam.

@menu
* Notas sobre criação do servidor:: 
* Objetos Server: Objetos Server<2>. 
* Objetos manipulador de requisições:: 
* Exemplos: Exemplos<28>. 

@end menu

@node Notas sobre criação do servidor,Objetos Server<2>,,socketserver — Um framework para servidores de rede
@anchor{library/socketserver server-creation-notes}@anchor{3d7a}
@subsubsection Notas sobre criação do servidor


Existem cinco classes em um diagrama de herança, quatro das quais representam servidores síncronos de quatro tipos:

@example
+------------+
| BaseServer |
+------------+
      |
      v
+-----------+        +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+        +------------------+
      |
      v
+-----------+        +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+        +--------------------+
@end example

Observe que @ref{3d77,,UnixDatagramServer} deriva de @ref{3d75,,UDPServer}, não de @ref{3d76,,UnixStreamServer} — a única diferença entre um IP e um servidor Unix é a família de endereços.

@geindex ForkingMixIn (classe em socketserver)
@geindex ThreadingMixIn (classe em socketserver)
@anchor{library/socketserver socketserver ForkingMixIn}@anchor{b90}
@deffn {Classe} socketserver.ForkingMixIn
@anchor{library/socketserver socketserver ThreadingMixIn}@anchor{b58}
@deffnx {Classe} socketserver.ThreadingMixIn

Versões de fork e threads de cada tipo de servidor podem ser criadas usando essas classes mix-in. Por exemplo, @ref{3d7b,,ThreadingUDPServer} é criado da seguinte forma:

@example
class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    pass
@end example

A classe mix-in vem primeiro, pois ela substitui um método definido em @ref{3d75,,UDPServer}. Definir os vários atributos também altera o comportamento do mecanismo de servidor subjacente.

@ref{b90,,ForkingMixIn} e as classes Forking mencionadas abaixo estão disponíveis apenas em plataformas POSIX que oferecem suporte a @ref{197,,fork()}.

@geindex block_on_close (atributo socketserver.ThreadingMixIn)
@anchor{library/socketserver socketserver ThreadingMixIn block_on_close}@anchor{b8f}
@deffn {Atributo} block_on_close

@ref{b8e,,ForkingMixIn.server_close} aguarda até que todos os processos filho sejam concluídos, exceto se o atributo @ref{b8f,,block_on_close} for @code{False}.

@ref{b8e,,ThreadingMixIn.server_close} aguarda até que todos as threads não daemon sejam concluídos, exceto se o atributo @ref{b8f,,block_on_close} for @code{False}.
@end deffn

@geindex daemon_threads (atributo socketserver.ThreadingMixIn)
@anchor{library/socketserver socketserver ThreadingMixIn daemon_threads}@anchor{3d7c}
@deffn {Atributo} daemon_threads

Para @ref{b58,,ThreadingMixIn}, use threads como daemon definindo @ref{3d7c,,ThreadingMixIn.daemon_threads} como @code{True} para não esperar até que as threads sejam concluídas.
@end deffn


Alterado na versão 3.7: @ref{b8e,,ForkingMixIn.server_close} e @ref{b8e,,ThreadingMixIn.server_close} agora esperam até que todos os processos filhos e threads não daemon sejam concluídos. Adicione um novo atributo de classe @ref{b8f,,ForkingMixIn.block_on_close} para optar pelo comportamento pré-3.7.

@end deffn

@geindex ForkingTCPServer (classe em socketserver)
@geindex ForkingUDPServer (classe em socketserver)
@geindex ThreadingTCPServer (classe em socketserver)
@geindex ThreadingUDPServer (classe em socketserver)
@geindex ForkingUnixStreamServer (classe em socketserver)
@geindex ForkingUnixDatagramServer (classe em socketserver)
@geindex ThreadingUnixStreamServer (classe em socketserver)
@geindex ThreadingUnixDatagramServer (classe em socketserver)
@anchor{library/socketserver socketserver ForkingTCPServer}@anchor{3d7d}
@deffn {Classe} socketserver.ForkingTCPServer
@anchor{library/socketserver socketserver ForkingUDPServer}@anchor{3d7e}
@deffnx {Classe} socketserver.ForkingUDPServer
@anchor{library/socketserver socketserver ThreadingTCPServer}@anchor{3d7f}
@deffnx {Classe} socketserver.ThreadingTCPServer
@anchor{library/socketserver socketserver ThreadingUDPServer}@anchor{3d7b}
@deffnx {Classe} socketserver.ThreadingUDPServer
@anchor{library/socketserver socketserver ForkingUnixStreamServer}@anchor{3d80}
@deffnx {Classe} socketserver.ForkingUnixStreamServer
@anchor{library/socketserver socketserver ForkingUnixDatagramServer}@anchor{3d81}
@deffnx {Classe} socketserver.ForkingUnixDatagramServer
@anchor{library/socketserver socketserver ThreadingUnixStreamServer}@anchor{3d82}
@deffnx {Classe} socketserver.ThreadingUnixStreamServer
@anchor{library/socketserver socketserver ThreadingUnixDatagramServer}@anchor{3d83}
@deffnx {Classe} socketserver.ThreadingUnixDatagramServer

Essas classes são predefinidas usando as classes mix-in.
@end deffn


Adicionado na versão 3.12: As classes @code{ForkingUnixStreamServer} e @code{ForkingUnixDatagramServer} foram adicionadas.


Para implementar um serviço, você deve derivar uma classe de @ref{3d78,,BaseRequestHandler} e redefinir seu método @ref{3d79,,handle()}. Você pode então executar várias versões do serviço combinando uma das classes de servidor com sua classe de manipulador de solicitação. A classe de manipulador de solicitação deve ser diferente para serviços de datagrama ou fluxo. Isso pode ser ocultado usando as subclasses de manipulador @ref{cfb,,StreamRequestHandler} ou @ref{3d84,,DatagramRequestHandler}.

Claro, você ainda tem que usar sua cabeça! Por exemplo, não faz sentido usar um servidor de Forking se o serviço contém estado na memória que pode ser modificado por diferentes solicitações, já que as modificações no processo filho nunca atingiriam o estado inicial mantido no processo pai e passado para cada filho. Neste caso, você pode usar um servidor de Threading, mas provavelmente terá que usar travas para proteger a integridade dos dados compartilhados.

Por outro lado, se você estiver construindo um servidor HTTP onde todos os dados são armazenados externamente (por exemplo, no sistema de arquivos), uma classe síncrona essencialmente tornará o serviço “surdo” enquanto uma solicitação estiver sendo manipulada – o que pode ser por um tempo muito longo se um cliente for lento para receber todos os dados que solicitou. Aqui, um servidor de Threading ou Forking é apropriado.

Em alguns casos, pode ser apropriado processar parte de uma solicitação de forma síncrona, mas terminar o processamento em um filho bifurcado dependendo dos dados da solicitação. Isso pode ser implementado usando um servidor síncrono e fazendo uma bifurcação explícita no método da classe do manipulador de solicitações @ref{3d79,,handle()}.

Outra abordagem para lidar com múltiplas requisições simultâneas em um ambiente que não oferece suporte a threads nem @ref{197,,fork()} (ou onde estes são muito caros ou inapropriados para o serviço) é manter uma tabela explícita de requisições parcialmente finalizadas e usar @ref{c2,,selectors} para decidir em qual requisição trabalhar em seguida (ou se deve lidar com uma nova requisição recebida). Isto é particularmente importante para serviços de fluxo onde cada cliente pode potencialmente ficar conectado por um longo tempo (se threads ou subprocessos não puderem ser usados).

@c XXX should data and methods be intermingled, or separate?
@c how should the distinction between class and instance variables be drawn?

@node Objetos Server<2>,Objetos manipulador de requisições,Notas sobre criação do servidor,socketserver — Um framework para servidores de rede
@anchor{library/socketserver server-objects}@anchor{3d85}
@subsubsection Objetos Server


@geindex BaseServer (classe em socketserver)
@anchor{library/socketserver socketserver BaseServer}@anchor{117c}
@deffn {Classe} socketserver.BaseServer (server_address, RequestHandlerClass)

Esta é a superclasse de todos os objetos Server no módulo. Ela define a interface, dada abaixo, mas não implementa a maioria dos métodos, o que é feito em subclasses. Os dois parâmetros são armazenados nos respectivos atributos @ref{3d86,,server_address} e @ref{3d87,,RequestHandlerClass}.

@geindex fileno() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer fileno}@anchor{3d88}
@deffn {Método} fileno ()

Retorna um descritor de arquivo inteiro para o soquete no qual o servidor está escutando. Esta função é mais comumente passada para @ref{c2,,selectors}, para permitir o monitoramento de múltiplos servidores no mesmo processo.
@end deffn

@geindex handle_request() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_request}@anchor{1367}
@deffn {Método} handle_request ()

Processa uma única solicitação. Esta função chama os seguintes métodos em ordem: @ref{3d89,,get_request()}, @ref{3d8a,,verify_request()} e @ref{3d8b,,process_request()}. Se o método @ref{3d79,,handle()} fornecido pelo usuário da classe manipuladora levantar uma exceção, o método @ref{d64,,handle_error()} do servidor será chamado. Se nenhuma solicitação for recebida dentro de @ref{1365,,timeout} segundos, @ref{1366,,handle_timeout()} será chamado e @ref{1367,,handle_request()} retornará.
@end deffn

@geindex serve_forever() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer serve_forever}@anchor{117e}
@deffn {Método} serve_forever (poll_interval=0.5)

Manipula solicitações até uma solicitação explícita @ref{1bad,,shutdown()}. Sonda para desligamento a cada `poll_interval' segundos. Ignora o atributo @ref{1365,,timeout}. Ele também chama @ref{117d,,service_actions()}, que pode ser usado por uma subclasse ou mixin para fornecer ações específicas para um determinado serviço. Por exemplo, a classe @ref{b90,,ForkingMixIn} usa @ref{117d,,service_actions()} para limpar processos filhos zumbis.


Alterado na versão 3.3: Adicionada chamada @code{service_actions} ao método @code{serve_forever}.

@end deffn

@geindex service_actions() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer service_actions}@anchor{117d}
@deffn {Método} service_actions ()

Isso é chamado no laço @ref{117e,,serve_forever()}. Este método pode ser substituído por subclasses ou classes mixin para executar ações específicas para um determinado serviço, como ações de limpeza.


Adicionado na versão 3.3.

@end deffn

@geindex shutdown() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer shutdown}@anchor{1bad}
@deffn {Método} shutdown ()

Diz ao laço @ref{117e,,serve_forever()} para parar e esperar até que isso aconteça. @ref{1bad,,shutdown()} deve ser chamado enquanto @ref{117e,,serve_forever()} estiver em execução em um thread diferente, caso contrário, ocorrerá um impasse.
@end deffn

@geindex server_close() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_close}@anchor{b8e}
@deffn {Método} server_close ()

Limpa o servidor. Pode ser substituído.
@end deffn

@geindex address_family (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer address_family}@anchor{3d8c}
@deffn {Atributo} address_family

A família de protocolos à qual o soquete do servidor pertence. Exemplos comuns são @ref{1938,,socket.AF_INET}, @ref{1939,,socket.AF_INET6} e @ref{193a,,socket.AF_UNIX}. Subclasse as classes de servidor TCP ou UDP neste módulo com o atributo de classe @code{address_family = AF_INET6} definido se você quiser classes de servidor IPv6.
@end deffn

@geindex RequestHandlerClass (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer RequestHandlerClass}@anchor{3d87}
@deffn {Atributo} RequestHandlerClass

A classe de manipulador de solicitações fornecida pelo usuário; uma instância dessa classe é criada para cada solicitação.
@end deffn

@geindex server_address (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_address}@anchor{3d86}
@deffn {Atributo} server_address

O endereço no qual o servidor está escutando. O formato dos endereços varia dependendo da família do protocolo; veja a documentação do módulo @ref{cc,,socket} para detalhes. Para protocolos de internet, esta é uma tupla contendo uma string dando o endereço e um número de porta inteiro: @code{('127.0.0.1', 80)}, por exemplo.
@end deffn

@geindex socket (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer socket}@anchor{3d8d}
@deffn {Atributo} socket

O objeto soquete no qual o servidor ouve para solicitações recebidas.
@end deffn

As classes de servidor oferecem suporte às seguintes variáveis de classe:

@c XXX should class variables be covered before instance variables, or vice versa?

@geindex allow_reuse_address (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer allow_reuse_address}@anchor{3d8e}
@deffn {Atributo} allow_reuse_address

Se o servidor permitirá a reutilização de um endereço. O padrão é @ref{b49,,False}, e pode ser definido em subclasses para alterar a política.
@end deffn

@geindex request_queue_size (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer request_queue_size}@anchor{3d8f}
@deffn {Atributo} request_queue_size

O tamanho da fila de requisições. Se levar muito tempo para processar uma única requisição, todas as requisições que chegarem enquanto o servidor estiver ocupado serão colocadas em uma fila, até @ref{3d8f,,request_queue_size} requisições. Quando a fila estiver cheia, outras requisições de clientes receberão um erro “Conexão negada”. O valor padrão é geralmente 5, mas isso pode ser substituído por subclasses.
@end deffn

@geindex socket_type (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer socket_type}@anchor{3d90}
@deffn {Atributo} socket_type

O tipo de soquete usado pelo servidor; @ref{1337,,socket.SOCK_STREAM} e @ref{1336,,socket.SOCK_DGRAM} são dois valores comuns.
@end deffn

@geindex timeout (atributo socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer timeout}@anchor{1365}
@deffn {Atributo} timeout

Duração do tempo limite, medida em segundos, ou @ref{675,,None} se nenhum tempo limite for desejado. Se @ref{1367,,handle_request()} não receber nenhuma requisição de entrada dentro do período de tempo limite, o método @ref{1366,,handle_timeout()} será chamado.
@end deffn

Existem vários métodos de servidor que podem ser substituídos por subclasses de classes de servidor base, como @ref{1364,,TCPServer}; esses métodos não são úteis para usuários externos do 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 socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer finish_request}@anchor{3d91}
@deffn {Método} finish_request (request, client_address)

Na verdade, processa a solicitação instanciando @ref{3d87,,RequestHandlerClass} e chamando seu método @ref{3d79,,handle()}.
@end deffn

@geindex get_request() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer get_request}@anchor{3d89}
@deffn {Método} get_request ()

Deve aceitar uma solicitação do soquete e retornar uma tupla de 2 elementos contendo o `novo' objeto de soquete a ser usado para se comunicar com o cliente e o endereço do cliente.
@end deffn

@geindex handle_error() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_error}@anchor{d64}
@deffn {Método} handle_error (request, client_address)

Esta função é chamada se o método @ref{3d79,,handle()} de uma instância @ref{3d87,,RequestHandlerClass} levanta uma exceção. A ação padrão é exibir o traceback para erro padrão e continuar manipulando solicitações futuras.


Alterado na versão 3.6: Agora é chamada apenas para exceções derivadas da classe @ref{9e2,,Exception}.

@end deffn

@geindex handle_timeout() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer handle_timeout}@anchor{1366}
@deffn {Método} handle_timeout ()

Esta função é chamada quando o atributo @ref{1365,,timeout} foi definido para um valor diferente de @ref{675,,None} e o período de timeout passou sem que nenhuma solicitação tenha sido recebida. A ação padrão para servidores de bifurcação é coletar o status de quaisquer processos filhos que tenham saído, enquanto em servidores de threading esse método não faz nada.
@end deffn

@geindex process_request() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer process_request}@anchor{3d8b}
@deffn {Método} process_request (request, client_address)

Chama @ref{3d91,,finish_request()} para criar uma instância de @ref{3d87,,RequestHandlerClass}. Se desejado, esta função pode criar um novo processo ou thread para manipular a solicitação; as classes @ref{b90,,ForkingMixIn} e @ref{b58,,ThreadingMixIn} fazem isso.
@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 socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_activate}@anchor{3d74}
@deffn {Método} server_activate ()

Chamado pelo construtor do servidor para ativar o servidor. O comportamento padrão para um servidor TCP apenas invoca @ref{e8d,,listen()} no soquete do servidor. Pode ser substituído.
@end deffn

@geindex server_bind() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer server_bind}@anchor{3d73}
@deffn {Método} server_bind ()

Chamada pelo construtor do servidor para vincular o soquete ao endereço desejado. Pode ser substituída.
@end deffn

@geindex verify_request() (método socketserver.BaseServer)
@anchor{library/socketserver socketserver BaseServer verify_request}@anchor{3d8a}
@deffn {Método} verify_request (request, client_address)

Deve retornar um valor booleano; se o valor for @ref{c27,,True}, a solicitação será processada, e se for @ref{b49,,False}, a solicitação será negada. Esta função pode ser substituída para implementar controles de acesso para um servidor. A implementação padrão sempre retorna @ref{c27,,True}.
@end deffn


Alterado na versão 3.6: Foi adicionado suporte para o protocolo @ref{5d4,,gerenciador de contexto}. Sair do gerenciador de contexto é equivalente a chamar @ref{b8e,,server_close()}.

@end deffn

@node Objetos manipulador de requisições,Exemplos<28>,Objetos Server<2>,socketserver — Um framework para servidores de rede
@anchor{library/socketserver request-handler-objects}@anchor{3d92}
@subsubsection Objetos manipulador de requisições


@geindex BaseRequestHandler (classe em socketserver)
@anchor{library/socketserver socketserver BaseRequestHandler}@anchor{3d78}
@deffn {Classe} socketserver.BaseRequestHandler

Esta é a superclasse de todos os objetos manipulador de requisições. Ela define a interface, dada abaixo. Uma subclasse concreta do manipulador de requisições deve definir um novo método @ref{3d79,,handle()} e pode substituir qualquer um dos outros métodos. Uma nova instância da subclasse é criada para cada requisição.

@geindex setup() (método socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler setup}@anchor{3d93}
@deffn {Método} setup ()

Chamada antes do método @ref{3d79,,handle()} para executar quaisquer ações de inicialização necessárias. A implementação padrão não faz nada.
@end deffn

@geindex handle() (método socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler handle}@anchor{3d79}
@deffn {Método} handle ()

Esta função deve fazer todo o trabalho necessário para atender a uma solicitação. A implementação padrão não faz nada. Vários atributos de instância estão disponíveis para ela; a solicitação está disponível como @ref{3d94,,request}; o endereço do cliente como @ref{3d95,,client_address}; e a instância do servidor como @ref{3d96,,server}, caso precise de acesso a informações por servidor.

O tipo de @ref{3d94,,request} é diferente para serviços de datagrama ou fluxo. Para serviços de fluxo, @ref{3d94,,request} é um objeto soquete; para serviços de datagrama, @ref{3d94,,request} é um par de string e soquete.
@end deffn

@geindex finish() (método socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler finish}@anchor{3d97}
@deffn {Método} finish ()

Chamada após o método @ref{3d79,,handle()} para executar quaisquer ações de limpeza necessárias. A implementação padrão não faz nada. Se @ref{3d93,,setup()} levanta uma exceção, esta função não será chamada.
@end deffn

@geindex request (atributo socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler request}@anchor{3d94}
@deffn {Atributo} request

O `novo' objeto @ref{dc9,,socket.socket} a ser usado para se comunicar com o cliente.
@end deffn

@geindex client_address (atributo socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler client_address}@anchor{3d95}
@deffn {Atributo} client_address

Endereço do cliente retornado por @ref{3d89,,BaseServer.get_request()}.
@end deffn

@geindex server (atributo socketserver.BaseRequestHandler)
@anchor{library/socketserver socketserver BaseRequestHandler server}@anchor{3d96}
@deffn {Atributo} server

Objeto @ref{117c,,BaseServer} usado para manipular a solicitação.
@end deffn
@end deffn

@geindex StreamRequestHandler (classe em socketserver)
@geindex DatagramRequestHandler (classe em socketserver)
@anchor{library/socketserver socketserver StreamRequestHandler}@anchor{cfb}
@deffn {Classe} socketserver.StreamRequestHandler
@anchor{library/socketserver socketserver DatagramRequestHandler}@anchor{3d84}
@deffnx {Classe} socketserver.DatagramRequestHandler

Essas subclasses @ref{3d78,,BaseRequestHandler} substituem os métodos @ref{3d93,,setup()} e @ref{3d97,,finish()} e fornecem os atributos @ref{3d98,,rfile} e @ref{cfa,,wfile}.

@geindex rfile (atributo socketserver.DatagramRequestHandler)
@anchor{library/socketserver socketserver DatagramRequestHandler rfile}@anchor{3d98}
@deffn {Atributo} rfile

Um objeto arquivo do qual recebe a solicitação é lido. Oferece suporte à interface legível @ref{694,,io.BufferedIOBase}.
@end deffn

@geindex wfile (atributo socketserver.DatagramRequestHandler)
@anchor{library/socketserver socketserver DatagramRequestHandler wfile}@anchor{cfa}
@deffn {Atributo} wfile

Um objeto arquivo no qual a resposta é escrita. Oferece suporte à interface gravável @ref{694,,io.BufferedIOBase}
@end deffn


Alterado na versão 3.6: @ref{cfa,,wfile} também oferece suporte à interface gravável @ref{694,,io.BufferedIOBase}.

@end deffn

@node Exemplos<28>,,Objetos manipulador de requisições,socketserver — Um framework para servidores de rede
@anchor{library/socketserver examples}@anchor{3d99}
@subsubsection Exemplos


@menu
* Exemplo de socketserver.TCPServer: Exemplo de socketserver TCPServer. 
* Exemplo socketserver.UDPServer: Exemplo socketserver UDPServer. 
* Mixins assíncronos:: 

@end menu

@node Exemplo de socketserver TCPServer,Exemplo socketserver UDPServer,,Exemplos<28>
@anchor{library/socketserver socketserver-tcpserver-example}@anchor{3d9a}
@subsubsection Exemplo de @code{socketserver.TCPServer}


Este é o lado do servidor:

@example
import socketserver

class MyTCPHandler(socketserver.BaseRequestHandler):
    """
    A classe de manipulador de solicitação para nosso servidor.

    Ela é instanciada uma vez por conexão com o servidor e deve
    substituir o método handle() para implementar a comunicação
    com o cliente.
    """

    def handle(self):
        # self.request é o soquete TCP conectado ao cliente
        pieces = [b'@w{'}]
        total = 0
        while b'\n' not in pieces[-1] and total < 10_000:
            pieces.append(self.request.recv(2000))
            total += len(pieces[-1])
        self.data = b'@w{'}.join(pieces)
        print(f"Received from @{self.client_address[0]@}:")
        print(self.data.decode("utf-8"))
        # só envia de volta os mesmos dados, mas em caixa alta
        self.request.sendall(self.data.upper())
        # após retornarmos, o soquete será fechado.

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999

    # Cria o servidor, ligando-o ao localhost na porta 9999
    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
        # Ativa o servidor; isso vai mantê-lo em execução até você
        # interromper o programa com Ctrl-C
        server.serve_forever()
@end example

Uma classe de manipulador de solicitações alternativa que faz uso de fluxos (objetos arquivo ou similares que simplificam a comunicação ao fornecer a interface de arquivo padrão):

@example
class MyTCPHandler(socketserver.StreamRequestHandler):

    def handle(self):
        # self.rfile é um objeto arquivo ou similar criado pelo manipulador.
        # Agora podemos usar, por exemplo, readline() em vez de chamadas
        # brutas a recv().
        # Nos limitamos a 10000 bytes para evitar abuso pelo remetente.
        self.data = self.rfile.readline(10000).rstrip()
        print(f"@{self.client_address[0]@} wrote:")
        print(self.data.decode("utf-8"))
        # Da mesma forma, self.wfile é um objeto arquivo ou similar para
        # escrever de volta para o cliente
        self.wfile.write(self.data.upper())
@end example

A diferença é que a chamada @code{readline()} no segundo manipulador chamará @code{recv()} várias vezes até encontrar um caractere de nova linha, enquanto o primeiro manipulador teve que usar um laço @code{recv()} para acumular dados até uma nova linha. Se tivesse usado apenas um único @code{recv()} sem o laço, ele teria retornado apenas o que foi recebido até agora do cliente. O TCP é baseado em fluxo: os dados chegam na ordem em que foram enviados, mas não há correlação entre as chamadas @code{send()} ou @code{sendall()} do cliente e o número de chamadas @code{recv()} no servidor necessárias para recebê-los.

Este é o lado do cliente:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# Cria um soquete (SOCK_STREAM significa um soquete TCP)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    # Conecta a um servidor e envia dados
    sock.connect((HOST, PORT))
    sock.sendall(bytes(data, "utf-8"))
    sock.sendall(b"\n")

    # Recebe dados do servidor e desliga
    received = str(sock.recv(1024), "utf-8")

print("Sent:    ", data)
print("Received:", received)
@end example

A saída do exemplo deve se parecer com algo como isso:

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 Exemplo socketserver UDPServer,Mixins assíncronos,Exemplo de socketserver TCPServer,Exemplos<28>
@anchor{library/socketserver socketserver-udpserver-example}@anchor{3d9b}
@subsubsection Exemplo @code{socketserver.UDPServer}


Este é o lado do servidor:

@example
import socketserver

class MyUDPHandler(socketserver.BaseRequestHandler):
    """
    Esta classe funciona de forma semelhante à classe do manipulador TCP,
    exceto que self.request consiste em um par de dados e soquete do cliente
    e, como não há conexão, o endereço do cliente deve ser fornecido
    explicitamente ao enviar dados de volta via sendto().
    """

    def handle(self):
        data = self.request[0].strip()
        socket = self.request[1]
        print(f"@{self.client_address[0]@} wrote:")
        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 é o lado do cliente:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# SOCK_DGRAM é o tipo de soquete para usar para soquetes UDP
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# Como você pode ver, não há uma chamada connect(); UDP não tem conexão.
# Em vez disso, dados são enviados diretamente para o destinatário via sendto().
sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))
received = str(sock.recv(1024), "utf-8")

print("Sent:    ", data)
print("Received:", received)
@end example

A saída do exemplo deve ser exatamente igual à do exemplo do servidor TCP.

@node Mixins assíncronos,,Exemplo socketserver UDPServer,Exemplos<28>
@anchor{library/socketserver asynchronous-mixins}@anchor{3d9c}
@subsubsection Mixins assíncronos


Para construir manipuladores assíncronos, use as classes @ref{b58,,ThreadingMixIn} e @ref{b90,,ForkingMixIn}.

Um exemplo para a classe @ref{b58,,ThreadingMixIn}:

@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__":
    # Porta 0 significa selecionar uma porta não usada arbitrária
    HOST, PORT = "localhost", 0

    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    with server:
        ip, port = server.server_address

        # Inicia uma thread com o servidor -- essa thread vai então
        # iniciar mais um thread para cada requisição
        server_thread = threading.Thread(target=server.serve_forever)
        # Sai da thread do servidor quando a thread principal é encerrada
        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

A saída do exemplo deve se parecer com algo como isso:

@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

A classe @ref{b90,,ForkingMixIn} é usada da mesma forma, exceto que o servidor gerará um novo processo para cada solicitação. Disponível apenas em plataformas POSIX que oferecem suporte a @ref{197,,fork()}.

@node http server — HTTP servers,http cookies — HTTP state management,socketserver — Um framework para servidores de rede,Protocolos de Internet e Suporte
@anchor{library/http server doc}@anchor{3d9d}@anchor{library/http server http-server-http-servers}@anchor{3d9e}@anchor{library/http server module-http server}@anchor{72}@anchor{library/http server translation-repo}@anchor{3d9f}
@subsection @code{http.server} — HTTP servers


@geindex module; http.server

`Código-fonte:' Lib/http/server.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/server.py}

@geindex WWW;server
@geindex HTTP;protocolo
@geindex URL
@geindex httpd


__________________________________________________________________


This module defines classes for implementing HTTP servers.

@cartouche
@quotation Aviso 
@ref{72,,http.server} is not recommended for production. It only implements
@ref{3da0,,basic security checks}.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

One class, @ref{3b97,,HTTPServer}, is a @ref{1364,,socketserver.TCPServer} subclass.
It creates and listens at the HTTP socket, dispatching the requests to a
handler.  Code to create and run the server looks like this:

@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 (classe em http.server)
@anchor{library/http server http server HTTPServer}@anchor{3b97}
@deffn {Classe} http.server.HTTPServer (server_address, RequestHandlerClass)

This class builds on the @ref{1364,,TCPServer} class by storing
the server address as instance variables named @code{server_name} and
@code{server_port}. The server is accessible by the handler, typically
through the handler’s @code{server} instance variable.
@end deffn

@geindex ThreadingHTTPServer (classe em http.server)
@anchor{library/http server http server ThreadingHTTPServer}@anchor{b57}
@deffn {Classe} http.server.ThreadingHTTPServer (server_address, RequestHandlerClass)

This class is identical to HTTPServer but uses threads to handle
requests by using the @ref{b58,,ThreadingMixIn}. This
is useful to handle web browsers pre-opening sockets, on which
@ref{3b97,,HTTPServer} would wait indefinitely.


Adicionado na versão 3.7.

@end deffn

The @ref{3b97,,HTTPServer} and @ref{b57,,ThreadingHTTPServer} must be given
a `RequestHandlerClass' on instantiation, of which this module
provides three different variants:

@geindex BaseHTTPRequestHandler (classe em http.server)
@anchor{library/http server http server BaseHTTPRequestHandler}@anchor{110a}
@deffn {Classe} http.server.BaseHTTPRequestHandler (request, client_address, server)

This class is used to handle the HTTP requests that arrive at the server.  By
itself, it cannot respond to any actual HTTP requests; it must be subclassed
to handle each request method (e.g. GET or POST).
@ref{110a,,BaseHTTPRequestHandler} provides a number of class and instance
variables, and methods for use by subclasses.

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{110a,,BaseHTTPRequestHandler} tem os seguintes atributos de instância:

@geindex client_address (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler client_address}@anchor{3da1}
@deffn {Atributo} client_address

Contains a tuple of the form @code{(host, port)} referring to the client’s
address.
@end deffn

@geindex server (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler server}@anchor{3da2}
@deffn {Atributo} server

Contains the server instance.
@end deffn

@geindex close_connection (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler close_connection}@anchor{3da3}
@deffn {Atributo} close_connection

Boolean that should be set before @ref{3da4,,handle_one_request()} returns,
indicating if another request may be expected, or if the connection should
be shut down.
@end deffn

@geindex requestline (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler requestline}@anchor{3da5}
@deffn {Atributo} requestline

Contains the string representation of the HTTP request line. The
terminating CRLF is stripped. This attribute should be set by
@ref{3da4,,handle_one_request()}. If no valid request line was processed, it
should be set to the empty string.
@end deffn

@geindex command (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler command}@anchor{3da6}
@deffn {Atributo} command

Contains the command (request type). For example, @code{'GET'}.
@end deffn

@geindex path (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler path}@anchor{3da7}
@deffn {Atributo} path

Contains the request path. If query component of the URL is present,
then @code{path} includes the query. Using the terminology of 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html},
@code{path} here includes @code{hier-part} and the @code{query}.
@end deffn

@geindex request_version (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler request_version}@anchor{3da8}
@deffn {Atributo} request_version

Contains the version string from the request. For example, @code{'HTTP/1.0'}.
@end deffn

@geindex headers (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler headers}@anchor{3c85}
@deffn {Atributo} headers

Holds an instance of the class specified by the @ref{3da9,,MessageClass} class
variable. This instance parses and manages the headers in the HTTP
request. The @ref{1bc1,,parse_headers()} function from
@ref{6f,,http.client} is used to parse the headers and it requires that the
HTTP request provide a valid 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} style header.
@end deffn

@geindex rfile (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler rfile}@anchor{3daa}
@deffn {Atributo} rfile

An @ref{694,,io.BufferedIOBase} input stream, ready to read from
the start of the optional input data.
@end deffn

@geindex wfile (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler wfile}@anchor{3dab}
@deffn {Atributo} wfile

Contains the output stream for writing a response back to the
client. Proper adherence to the HTTP protocol must be used when writing to
this stream in order to achieve successful interoperation with HTTP
clients.


Alterado na versão 3.6: This is an @ref{694,,io.BufferedIOBase} stream.

@end deffn

@ref{110a,,BaseHTTPRequestHandler} tem os seguintes atributos:

@geindex server_version (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler server_version}@anchor{3dac}
@deffn {Atributo} server_version

Specifies the server software version.  You may want to override this. The
format is multiple whitespace-separated strings, where each string is of
the form name[/version]. For example, @code{'BaseHTTP/0.2'}.
@end deffn

@geindex sys_version (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler sys_version}@anchor{3dad}
@deffn {Atributo} sys_version

Contains the Python system version, in a form usable by the
@ref{3dae,,version_string} method and the @ref{3dac,,server_version} class
variable. For example, @code{'Python/1.4'}.
@end deffn

@geindex error_message_format (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler error_message_format}@anchor{f84}
@deffn {Atributo} error_message_format

Specifies a format string that should be used by @ref{f83,,send_error()} method
for building an error response to the client. The string is filled by
default with variables from @ref{3c69,,responses} based on the status code
that passed to @ref{f83,,send_error()}.
@end deffn

@geindex error_content_type (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler error_content_type}@anchor{3daf}
@deffn {Atributo} error_content_type

Specifies the Content-Type HTTP header of error responses sent to the
client.  The default value is @code{'text/html'}.
@end deffn

@geindex protocol_version (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler protocol_version}@anchor{3db0}
@deffn {Atributo} protocol_version

Specifies the HTTP version to which the server is conformant. It is sent
in responses to let the client know the server’s communication
capabilities for future requests. If set to
@code{'HTTP/1.1'}, the server will permit HTTP persistent connections;
however, your server `must' then include an accurate @code{Content-Length}
header (using @ref{3db1,,send_header()}) in all of its responses to clients.
For backwards compatibility, the setting defaults to @code{'HTTP/1.0'}.
@end deffn

@geindex MessageClass (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler MessageClass}@anchor{3da9}
@deffn {Atributo} MessageClass

Specifies an @ref{27c,,email.message.Message}-like class to parse HTTP
headers.  Typically, this is not overridden, and it defaults to
@ref{3c83,,http.client.HTTPMessage}.
@end deffn

@geindex responses (atributo http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler responses}@anchor{3c69}
@deffn {Atributo} responses

This attribute contains a mapping of error code integers to two-element tuples
containing a short and long message. For example, @code{@{code: (shortmessage,
longmessage)@}}. The `shortmessage' is usually used as the `message' key in an
error response, and `longmessage' as the `explain' key.  It is used by
@ref{3db2,,send_response_only()} and @ref{f83,,send_error()} methods.
@end deffn

Uma instância de @ref{110a,,BaseHTTPRequestHandler} tem os seguintes métodos:

@geindex handle() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle}@anchor{3db3}
@deffn {Método} handle ()

Calls @ref{3da4,,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 http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle_one_request}@anchor{3da4}
@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 http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler handle_expect_100}@anchor{3db4}
@deffn {Método} handle_expect_100 ()

When an HTTP/1.1 conformant server receives an @code{Expect: 100-continue}
request header it responds back with a @code{100 Continue} followed by @code{200
OK} headers.
This method can be overridden to raise an error if the server does not
want the client to continue.  For e.g. server can choose to send @code{417
Expectation Failed} as a response header and @code{return False}.


Adicionado na versão 3.2.

@end deffn

@geindex send_error() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_error}@anchor{f83}
@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{f84,,error_message_format} attribute and emitted, after
a complete set of headers, as the response body.  The @ref{3c69,,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}.


Alterado na versão 3.4: The error response includes a Content-Length header.
Added the `explain' argument.

@end deffn

@geindex send_response() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_response}@anchor{3db5}
@deffn {Método} send_response (code, message=None)

Adds a response header to the headers buffer and logs the accepted
request. The HTTP response line is written to the internal buffer,
followed by `Server' and `Date' headers. The values for these two headers
are picked up from the @ref{3dae,,version_string()} and
@ref{3db6,,date_time_string()} methods, respectively. If the server does not
intend to send any other headers using the @ref{3db1,,send_header()} method,
then @ref{3db5,,send_response()} should be followed by an @ref{110b,,end_headers()}
call.


Alterado na versão 3.3: Headers are stored to an internal buffer and @ref{110b,,end_headers()}
needs to be called explicitly.

@end deffn

@geindex send_header() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_header}@anchor{3db1}
@deffn {Método} send_header (keyword, value)

Adds the HTTP header to an internal buffer which will be written to the
output stream when either @ref{110b,,end_headers()} or @ref{110c,,flush_headers()} is
invoked. `keyword' should specify the header keyword, with `value'
specifying its value. Note that, after the send_header calls are done,
@ref{110b,,end_headers()} MUST BE called in order to complete the operation.


Alterado na versão 3.2: Headers are stored in an internal buffer.

@end deffn

@geindex send_response_only() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler send_response_only}@anchor{3db2}
@deffn {Método} send_response_only (code, message=None)

Sends the response header only, used for the purposes when @code{100
Continue} response is sent by the server to the client. The headers not
buffered and sent directly the output stream.If the `message' is not
specified, the HTTP message corresponding the response `code'  is sent.


Adicionado na versão 3.2.

@end deffn

@geindex end_headers() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler end_headers}@anchor{110b}
@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{110c,,flush_headers()}.


Alterado na versão 3.2: The buffered headers are written to the output stream.

@end deffn

@geindex flush_headers() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler flush_headers}@anchor{110c}
@deffn {Método} flush_headers ()

Finally send the headers to the output stream and flush the internal
headers buffer.


Adicionado na versão 3.3.

@end deffn

@geindex log_request() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_request}@anchor{3db7}
@deffn {Método} log_request (code='-', size='-')

Logs an accepted (successful) request. `code' should specify the numeric
HTTP code associated with the response. If a size of the response is
available, then it should be passed as the `size' parameter.
@end deffn

@geindex log_error() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_error}@anchor{3db8}
@deffn {Método} log_error (...)

Logs an error when a request cannot be fulfilled. By default, it passes
the message to @ref{3db9,,log_message()}, so it takes the same arguments
(`format' and additional values).
@end deffn

@geindex log_message() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_message}@anchor{3db9}
@deffn {Método} log_message (format, ...)

Logs an arbitrary message to @code{sys.stderr}. This is typically overridden
to create custom error logging mechanisms. The `format' argument is a
standard printf-style format string, where the additional arguments to
@ref{3db9,,log_message()} are applied as inputs to the formatting. The client
ip address and current date and time are prefixed to every message logged.
@end deffn

@geindex version_string() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler version_string}@anchor{3dae}
@deffn {Método} version_string ()

Returns the server software’s version string. This is a combination of the
@ref{3dac,,server_version} and @ref{3dad,,sys_version} attributes.
@end deffn

@geindex date_time_string() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler date_time_string}@anchor{3db6}
@deffn {Método} date_time_string (timestamp=None)

Returns the date and time given by `timestamp' (which must be @code{None} or in
the format returned by @ref{254,,time.time()}), formatted for a message
header. If `timestamp' is omitted, it uses the current date and time.

The result looks like @code{'Sun, 06 Nov 1994 08:49:37 GMT'}.
@end deffn

@geindex log_date_time_string() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler log_date_time_string}@anchor{3dba}
@deffn {Método} log_date_time_string ()

Returns the current date and time, formatted for logging.
@end deffn

@geindex address_string() (método http.server.BaseHTTPRequestHandler)
@anchor{library/http server http server BaseHTTPRequestHandler address_string}@anchor{3dbb}
@deffn {Método} address_string ()

Retorna o endereço do cliente.


Alterado na versão 3.3: Previously, a name lookup was performed. To avoid name resolution
delays, it now always returns the IP address.

@end deffn
@end deffn

@geindex SimpleHTTPRequestHandler (classe em http.server)
@anchor{library/http server http server SimpleHTTPRequestHandler}@anchor{b56}
@deffn {Classe} http.server.SimpleHTTPRequestHandler (request, client_address, server, directory=None)

This class serves files from the directory `directory' and below,
or the current directory if `directory' is not provided, directly
mapping the directory structure to HTTP requests.


Alterado na versão 3.7: Added the `directory' parameter.



Alterado na versão 3.9: The `directory' parameter accepts a @ref{2a0,,path-like object}.


Muito do trabalho, como analisar o pedido, é feito pela classe base @ref{110a,,BaseHTTPRequestHandler}. Esta classe implementa as funções @ref{3dbc,,do_GET()} e @ref{3dbd,,do_HEAD()}.

The following are defined as class-level attributes of
@ref{b56,,SimpleHTTPRequestHandler}:

@geindex server_version (atributo http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler server_version}@anchor{3dbe}
@deffn {Atributo} server_version

This will be @code{"SimpleHTTP/" + __version__}, where @code{__version__} is
defined at the module level.
@end deffn

@geindex extensions_map (atributo http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler extensions_map}@anchor{3dbf}
@deffn {Atributo} extensions_map

A dictionary mapping suffixes into MIME types, contains custom overrides
for the default system mappings. The mapping is used case-insensitively,
and so should contain only lower-cased keys.


Alterado na versão 3.9: This dictionary is no longer filled with the default system mappings,
but only contains overrides.

@end deffn

The @ref{b56,,SimpleHTTPRequestHandler} class defines the following methods:

@geindex do_HEAD() (método http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler do_HEAD}@anchor{3dbd}
@deffn {Método} do_HEAD ()

This method serves the @code{'HEAD'} request type: it sends the headers it
would send for the equivalent @code{GET} request. See the @ref{3dbc,,do_GET()}
method for a more complete explanation of the possible headers.
@end deffn

@geindex do_GET() (método http.server.SimpleHTTPRequestHandler)
@anchor{library/http server http server SimpleHTTPRequestHandler do_GET}@anchor{3dbc}
@deffn {Método} do_GET ()

The request is mapped to a local file by interpreting the request as a
path relative to the current working directory.

If the request was mapped to a directory, the directory is checked for a
file named @code{index.html} or @code{index.htm} (in that order). If found, the
file’s contents are returned; otherwise a directory listing is generated
by calling the @code{list_directory()} method. This method uses
@ref{1139,,os.listdir()} to scan the directory, and returns a @code{404} error
response if the @ref{1139,,listdir()} fails.

If the request was mapped to a file, it is opened. Any @ref{417,,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.

A @code{'Content-type:'} header with the guessed content type is output,
followed by a @code{'Content-Length:'} header with the file’s size and a
@code{'Last-Modified:'} header with the file’s modification time.

Then follows a blank line signifying the end of the headers, and then the
contents of the file are output.

For example usage, see the implementation of the @code{test} function
in Lib/http/server.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/server.py}.


Alterado na versão 3.7: Support of the @code{'If-Modified-Since'} header.

@end deffn
@end deffn

The @ref{b56,,SimpleHTTPRequestHandler} class can be used in the following
manner in order to create a very basic webserver serving files relative to
the current directory:

@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{b56,,SimpleHTTPRequestHandler} can also be subclassed to enhance behavior,
such as using different index file names by overriding the class attribute
@code{index_pages}.

@geindex CGIHTTPRequestHandler (classe em http.server)
@anchor{library/http server http server CGIHTTPRequestHandler}@anchor{2a1}
@deffn {Classe} http.server.CGIHTTPRequestHandler (request, client_address, server)

This class is used to serve either files or output of CGI scripts from the
current directory and below. Note that mapping HTTP hierarchic structure to
local directory structure is exactly as in @ref{b56,,SimpleHTTPRequestHandler}.

@cartouche
@quotation Nota 
CGI scripts run by the @ref{2a1,,CGIHTTPRequestHandler} class cannot execute
redirects (HTTP code 302), because code 200 (script output follows) is
sent prior to execution of the CGI script.  This pre-empts the status
code.
@end quotation
@end cartouche

The class will however, run the CGI script, instead of serving it as a file,
if it guesses it to be a CGI script.  Only directory-based CGI are used —
the other common server configuration is to treat special extensions as
denoting CGI scripts.

The @code{do_GET()} and @code{do_HEAD()} functions are modified to run CGI scripts
and serve the output, instead of serving files, if the request leads to
somewhere below the @code{cgi_directories} path.

The @ref{2a1,,CGIHTTPRequestHandler} defines the following data member:

@geindex cgi_directories (atributo http.server.CGIHTTPRequestHandler)
@anchor{library/http server http server CGIHTTPRequestHandler cgi_directories}@anchor{3dc0}
@deffn {Atributo} cgi_directories

This defaults to @code{['/cgi-bin', '/htbin']} and describes directories to
treat as containing CGI scripts.
@end deffn

The @ref{2a1,,CGIHTTPRequestHandler} defines the following method:

@geindex do_POST() (método http.server.CGIHTTPRequestHandler)
@anchor{library/http server http server CGIHTTPRequestHandler do_POST}@anchor{3dc1}
@deffn {Método} do_POST ()

This method serves the @code{'POST'} request type, only allowed for CGI
scripts.  Error 501, “Can only POST to CGI scripts”, is output when trying
to POST to a non-CGI url.
@end deffn

Note that CGI scripts will be run with UID of user nobody, for security
reasons.  Problems with the CGI script will be translated to error 403.


Descontinuado desde a versão 3.13, será removido na versão 3.15: @ref{2a1,,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{3da0,,security considerations}.

@end deffn

@menu
* Interface de linha de comando: Interface de linha de comando<7>. 
* Considerações de segurança: Considerações de segurança<3>. 

@end menu

@node Interface de linha de comando<7>,Considerações de segurança<3>,,http server — HTTP servers
@anchor{library/http server command-line-interface}@anchor{3dc2}@anchor{library/http server http-server-cli}@anchor{f85}
@subsubsection Interface de linha de comando


@ref{72,,http.server} can also be invoked directly using the @ref{5e1,,-m}
switch of the interpreter.  The following example illustrates how to serve
files relative to the current directory:

@example
python -m http.server [OPTIONS] [port]
@end example

As seguintes opções são aceitas:

@geindex http.server opção de linha de comando; port
@anchor{library/http server cmdoption-http server-arg-port}@anchor{3dc3}
@deffn {Option} port

The server listens to port 8000 by default. The default can be overridden
by passing the desired port number as an argument:

@example
python -m http.server 9000
@end example
@end deffn

@geindex http.server opção de linha de comando; -b
@geindex http.server opção de linha de comando; --bind
@anchor{library/http server cmdoption-http server-b}@anchor{3dc4}@anchor{library/http server cmdoption-http server-bind}@anchor{3dc5}
@deffn {Option} @w{-}b, @w{-}@w{-}bind <address>

Specifies a specific address to which it should bind. Both IPv4 and IPv6
addresses are supported. By default, the server binds itself to all
interfaces. For example, the following command causes the server to bind
to localhost only:

@example
python -m http.server --bind 127.0.0.1
@end example


Adicionado na versão 3.4.



Alterado na versão 3.8: Support IPv6 in the @code{--bind} option.

@end deffn

@geindex http.server opção de linha de comando; -d
@geindex http.server opção de linha de comando; --directory
@anchor{library/http server cmdoption-http server-d}@anchor{3dc6}@anchor{library/http server cmdoption-http server-directory}@anchor{3dc7}
@deffn {Option} @w{-}d, @w{-}@w{-}directory <dir>

Specifies a directory to which it should serve the files. By default,
the server uses the current directory. For example, the following command
uses a specific directory:

@example
python -m http.server --directory /tmp/
@end example


Adicionado na versão 3.7.

@end deffn

@geindex http.server opção de linha de comando; -p
@geindex http.server opção de linha de comando; --protocol
@anchor{library/http server cmdoption-http server-p}@anchor{3dc8}@anchor{library/http server cmdoption-http server-protocol}@anchor{3dc9}
@deffn {Option} @w{-}p, @w{-}@w{-}protocol <version>

Specifies the HTTP version to which the server is conformant. By default,
the server is conformant to HTTP/1.0. For example, the following command
runs an HTTP/1.1 conformant server:

@example
python -m http.server --protocol HTTP/1.1
@end example


Adicionado na versão 3.11.

@end deffn

@geindex http.server opção de linha de comando; --cgi
@anchor{library/http server cmdoption-http server-cgi}@anchor{3dca}
@deffn {Option} @w{-}@w{-}cgi

@ref{2a1,,CGIHTTPRequestHandler} can be enabled in the command line by passing
the @code{--cgi} option:

@example
python -m http.server --cgi
@end example


Descontinuado desde a versão 3.13, será removido na versão 3.15: @ref{72,,http.server} command line @code{--cgi} support is being removed
because @ref{2a1,,CGIHTTPRequestHandler} is being removed.

@end deffn

@cartouche
@quotation Aviso 
@ref{2a1,,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

@node Considerações de segurança<3>,,Interface de linha de comando<7>,http server — HTTP servers
@anchor{library/http server http-server-security}@anchor{3da0}@anchor{library/http server security-considerations}@anchor{3dcb}
@subsubsection Considerações de segurança


@geindex http.server;security

@ref{b56,,SimpleHTTPRequestHandler} will follow symbolic links when handling
requests, this makes it possible for files outside of the specified directory
to be served.

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{110a,,BaseHTTPRequestHandler} @code{.log_message}
implementation. This could allow remote clients connecting to your
server to send nefarious control codes to your terminal.


Alterado na versão 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 de Internet e Suporte
@anchor{library/http cookies doc}@anchor{3dcc}@anchor{library/http cookies http-cookies-http-state-management}@anchor{3dcd}@anchor{library/http cookies module-http cookies}@anchor{71}@anchor{library/http cookies translation-repo}@anchor{3dce}
@subsection @code{http.cookies} — HTTP state management


@geindex module; http.cookies

`Código-fonte:' Lib/http/cookies.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/cookies.py}


__________________________________________________________________


The @ref{71,,http.cookies} module defines classes for abstracting the concept of
cookies, an HTTP state management mechanism. It supports both simple string-only
cookies, and provides an abstraction for having any serializable data-type as
cookie value.

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{1306,,string.ascii_letters}, @ref{245a,,string.digits} and
@code{!#$%&'*+-.^_`|~:} denote the set of valid characters allowed by this module
in a cookie name (as @ref{c1b,,key}).


Alterado na versão 3.3: Allowed ‘:’ as a valid cookie name character.


@cartouche
@quotation Nota 
On encountering an invalid cookie, @ref{3dcf,,CookieError} is raised, so if your
cookie data comes from a browser you should always prepare for invalid data
and catch @ref{3dcf,,CookieError} on parsing.
@end quotation
@end cartouche

@geindex CookieError
@anchor{library/http cookies http cookies CookieError}@anchor{3dcf}
@deffn {Exceção} http.cookies.CookieError

Exception failing because of 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} invalidity: incorrect attributes,
incorrect @code{Set-Cookie} header, etc.
@end deffn

@geindex BaseCookie (classe em http.cookies)
@anchor{library/http cookies http cookies BaseCookie}@anchor{3dd0}
@deffn {Classe} http.cookies.BaseCookie ([input])

This class is a dictionary-like object whose keys are strings and whose values
are @ref{c1e,,Morsel} instances. Note that upon setting a key to a value, the
value is first converted to a @ref{c1e,,Morsel} containing the key and the value.

If `input' is given, it is passed to the @ref{3dd1,,load()} method.
@end deffn

@geindex SimpleCookie (classe em http.cookies)
@anchor{library/http cookies http cookies SimpleCookie}@anchor{1bbb}
@deffn {Classe} http.cookies.SimpleCookie ([input])

This class derives from @ref{3dd0,,BaseCookie} and overrides @ref{3dd2,,value_decode()}
and @ref{3dd3,,value_encode()}. @code{SimpleCookie} supports
strings as cookie values. When setting the value, @code{SimpleCookie}
calls the builtin @ref{44c,,str()} to convert
the value to a string. Values received from HTTP are kept as strings.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{70,,http.cookiejar}

HTTP cookie handling for web `clients'.  The @ref{70,,http.cookiejar} and
@ref{71,,http.cookies} modules do not depend on each other.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - HTTP State Management Mechanism

This is the state management specification implemented by this module.
@end table


@menu
* Objetos Cookie:: 
* Objetos Morsel:: 
* Exemplo: Exemplo<12>. 

@end menu

@node Objetos Cookie,Objetos Morsel,,http cookies — HTTP state management
@anchor{library/http cookies cookie-objects}@anchor{3dd4}@anchor{library/http cookies id1}@anchor{3dd5}
@subsubsection Objetos Cookie


@geindex value_decode() (método http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie value_decode}@anchor{3dd2}
@deffn {Método} BaseCookie.value_decode (val)

Return a tuple @code{(real_value, coded_value)} from a string representation.
@code{real_value} can be any type. This method does no decoding in
@ref{3dd0,,BaseCookie} — it exists so it can be overridden.
@end deffn

@geindex value_encode() (método http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie value_encode}@anchor{3dd3}
@deffn {Método} BaseCookie.value_encode (val)

Return a tuple @code{(real_value, coded_value)}. `val' can be any type, but
@code{coded_value} will always be converted to a string.
This method does no encoding in @ref{3dd0,,BaseCookie} — it exists so it can
be overridden.

In general, it should be the case that @ref{3dd3,,value_encode()} and
@ref{3dd2,,value_decode()} are inverses on the range of `value_decode'.
@end deffn

@geindex output() (método http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie output}@anchor{3dd6}
@deffn {Método} BaseCookie.output (attrs=None, header='Set-Cookie:', sep='\r\n')

Return a string representation suitable to be sent as HTTP headers. `attrs' and
`header' are sent to each @ref{c1e,,Morsel}’s @ref{3dd7,,output()} method. `sep' is used
to join the headers together, and is by default the combination @code{'\r\n'}
(CRLF).
@end deffn

@geindex js_output() (método http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie js_output}@anchor{3dd8}
@deffn {Método} BaseCookie.js_output (attrs=None)

Return an embeddable JavaScript snippet, which, if run on a browser which
supports JavaScript, will act the same as if the HTTP headers was sent.

The meaning for `attrs' is the same as in @ref{3dd6,,output()}.
@end deffn

@geindex load() (método http.cookies.BaseCookie)
@anchor{library/http cookies http cookies BaseCookie load}@anchor{3dd1}
@deffn {Método} BaseCookie.load (rawdata)

If `rawdata' is a string, parse it as an @code{HTTP_COOKIE} and add the values
found there as @ref{c1e,,Morsel}s. If it is a dictionary, it is equivalent to:

@example
for k, v in rawdata.items():
    cookie[k] = v
@end example
@end deffn

@node Objetos Morsel,Exemplo<12>,Objetos Cookie,http cookies — HTTP state management
@anchor{library/http cookies id2}@anchor{3dd9}@anchor{library/http cookies morsel-objects}@anchor{3dda}
@subsubsection Objetos Morsel


@geindex Morsel (classe em http.cookies)
@anchor{library/http cookies http cookies Morsel}@anchor{c1e}
@deffn {Classe} http.cookies.Morsel

Abstract a key/value pair, which has some 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} attributes.

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 http.cookies.Morsel)
@geindex path (atributo http.cookies.Morsel)
@geindex comment (atributo http.cookies.Morsel)
@geindex domain (atributo http.cookies.Morsel)
@geindex secure (atributo http.cookies.Morsel)
@geindex version (atributo http.cookies.Morsel)
@geindex httponly (atributo http.cookies.Morsel)
@geindex samesite (atributo http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel expires}@anchor{3ddb}
@deffn {Atributo} expires
@anchor{library/http cookies http cookies Morsel path}@anchor{3ddc}
@deffnx {Atributo} path
@anchor{library/http cookies http cookies Morsel comment}@anchor{3ddd}
@deffnx {Atributo} comment
@anchor{library/http cookies http cookies Morsel domain}@anchor{3dde}
@deffnx {Atributo} domain

@deffnx {Atributo} max@w{-}age
@anchor{library/http cookies http cookies Morsel secure}@anchor{3ddf}
@deffnx {Atributo} secure
@anchor{library/http cookies http cookies Morsel version}@anchor{3de0}
@deffnx {Atributo} version
@anchor{library/http cookies http cookies Morsel httponly}@anchor{1417}
@deffnx {Atributo} httponly
@anchor{library/http cookies http cookies Morsel samesite}@anchor{3de1}
@deffnx {Atributo} samesite
@end deffn
@end quotation

The attribute @ref{1417,,httponly} specifies that the cookie is only transferred
in HTTP requests, and is not accessible through JavaScript. This is intended
to mitigate some forms of cross-site scripting.

The attribute @ref{3de1,,samesite} controls when the browser sends the cookie with
cross-site requests. This helps to mitigate CSRF attacks. Valid values are
“Strict” (only sent with same-site requests), “Lax” (sent with same-site
requests and top-level navigations), and “None” (sent with same-site and
cross-site requests). When using “None”, the “secure” attribute must also
be set, as required by modern browsers.

The keys are case-insensitive and their default value is @code{'@w{'}}.


Alterado na versão 3.5: @code{__eq__()} now takes @ref{c1b,,key} and @ref{c1c,,value}
into account.



Alterado na versão 3.7: Attributes @ref{c1b,,key}, @ref{c1c,,value} and
@ref{c1d,,coded_value} are read-only.  Use @ref{c1f,,set()} for
setting them.



Alterado na versão 3.8: Added support for the @ref{3de1,,samesite} attribute.

@end deffn

@geindex value (atributo http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel value}@anchor{c1c}
@deffn {Atributo} Morsel.value

O valor do cookie.
@end deffn

@geindex coded_value (atributo http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel coded_value}@anchor{c1d}
@deffn {Atributo} Morsel.coded_value

The encoded value of the cookie — this is what should be sent.
@end deffn

@geindex key (atributo http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel key}@anchor{c1b}
@deffn {Atributo} Morsel.key

O nome do cookie.
@end deffn

@geindex set() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel set}@anchor{c1f}
@deffn {Método} Morsel.set (key, value, coded_value)

Set the `key', `value' and `coded_value' attributes.
@end deffn

@geindex isReservedKey() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel isReservedKey}@anchor{3de2}
@deffn {Método} Morsel.isReservedKey (K)

Whether `K' is a member of the set of keys of a @ref{c1e,,Morsel}.
@end deffn

@geindex output() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel output}@anchor{3dd7}
@deffn {Método} Morsel.output (attrs=None, header='Set-Cookie:')

Return a string representation of the Morsel, suitable to be sent as an HTTP
header. By default, all the attributes are included, unless `attrs' is given, in
which case it should be a list of attributes to use. `header' is by default
@code{"Set-Cookie:"}.
@end deffn

@geindex js_output() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel js_output}@anchor{3de3}
@deffn {Método} Morsel.js_output (attrs=None)

Return an embeddable JavaScript snippet, which, if run on a browser which
supports JavaScript, will act the same as if the HTTP header was sent.

The meaning for `attrs' is the same as in @ref{3dd7,,output()}.
@end deffn

@geindex OutputString() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel OutputString}@anchor{3de4}
@deffn {Método} Morsel.OutputString (attrs=None)

Return a string representing the Morsel, without any surrounding HTTP or
JavaScript.

The meaning for `attrs' is the same as in @ref{3dd7,,output()}.
@end deffn

@geindex update() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel update}@anchor{ef8}
@deffn {Método} Morsel.update (values)

Update the values in the Morsel dictionary with the values in the dictionary
`values'.  Raise an error if any of the keys in the `values' dict is not a
valid 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} attribute.


Alterado na versão 3.5: an error is raised for invalid keys.

@end deffn

@geindex copy() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel copy}@anchor{ef7}
@deffn {Método} Morsel.copy (value)

Return a shallow copy of the Morsel object.


Alterado na versão 3.5: return a Morsel object instead of a dict.

@end deffn

@geindex setdefault() (método http.cookies.Morsel)
@anchor{library/http cookies http cookies Morsel setdefault}@anchor{3de5}
@deffn {Método} Morsel.setdefault (key, value=None)

Raise an error if key is not a valid 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} attribute, otherwise
behave the same as @ref{10b2,,dict.setdefault()}.
@end deffn

@node Exemplo<12>,,Objetos Morsel,http cookies — HTTP state management
@anchor{library/http cookies cookie-example}@anchor{3de6}@anchor{library/http cookies example}@anchor{3de7}
@subsubsection Exemplo


The following example demonstrates how to use the @ref{71,,http.cookies} module.

@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=;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=;"
>>> 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 de servidor e cliente XMLRPC,http cookies — HTTP state management,Protocolos de Internet e Suporte
@anchor{library/http cookiejar doc}@anchor{3de8}@anchor{library/http cookiejar http-cookiejar-cookie-handling-for-http-clients}@anchor{3de9}@anchor{library/http cookiejar module-http cookiejar}@anchor{70}@anchor{library/http cookiejar translation-repo}@anchor{3dea}
@subsection @code{http.cookiejar} — Cookie handling for HTTP clients


@geindex module; http.cookiejar

`Código-fonte:' Lib/http/cookiejar.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/http/cookiejar.py}


__________________________________________________________________


The @ref{70,,http.cookiejar} module defines classes for automatic handling of HTTP
cookies.  It is useful for accessing websites that require small pieces of data
– `cookies' – to be set on the client machine by an HTTP response from a
web server, and then returned to the server in later HTTP requests.

Both the regular Netscape cookie protocol and the protocol defined by
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} are handled.  RFC 2965 handling is switched off by default.
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies are parsed as Netscape cookies and subsequently treated
either as Netscape or RFC 2965 cookies according to the ‘policy’ in effect.
Note that the great majority of cookies on the internet are Netscape cookies.
@ref{70,,http.cookiejar} attempts to follow the de-facto Netscape cookie protocol (which
differs substantially from that set out in the original Netscape specification),
including taking note of the @code{max-age} and @code{port} cookie-attributes
introduced with RFC 2965.

@cartouche
@quotation Nota 
The various named parameters found in @code{Set-Cookie} and
@code{Set-Cookie2} headers (eg. @code{domain} and @code{expires}) are
conventionally referred to as `attributes'.  To distinguish them from
Python attributes, the documentation for this module uses the term
`cookie-attribute' instead.
@end quotation
@end cartouche

The module defines the following exception:

@geindex LoadError
@anchor{library/http cookiejar http cookiejar LoadError}@anchor{3deb}
@deffn {Exceção} http.cookiejar.LoadError

Instances of @ref{3dec,,FileCookieJar} raise this exception on failure to load
cookies from a file.  @ref{3deb,,LoadError} is a subclass of @ref{417,,OSError}.


Alterado na versão 3.3: @ref{3deb,,LoadError} used to be a subtype of @ref{108b,,IOError}, which is now an
alias of @ref{417,,OSError}.

@end deffn

As seguintes classes são disponibilizadas:

@geindex CookieJar (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar CookieJar}@anchor{3c07}
@deffn {Classe} http.cookiejar.CookieJar (policy=None)

`policy' is an object implementing the @ref{3ded,,CookiePolicy} interface.

The @ref{3c07,,CookieJar} class stores HTTP cookies.  It extracts cookies from HTTP
requests, and returns them in HTTP responses. @ref{3c07,,CookieJar} instances
automatically expire contained cookies when necessary.  Subclasses are also
responsible for storing and retrieving cookies from a file or database.
@end deffn

@geindex FileCookieJar (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar FileCookieJar}@anchor{3dec}
@deffn {Classe} http.cookiejar.FileCookieJar (filename=None, delayload=None, policy=None)

`policy' is an object implementing the @ref{3ded,,CookiePolicy} interface.  For the
other arguments, see the documentation for the corresponding attributes.

A @ref{3c07,,CookieJar} which can load cookies from, and perhaps save cookies to, a
file on disk.  Cookies are `NOT' loaded from the named file until either the
@ref{3dee,,load()} or @ref{3def,,revert()} method is called.  Subclasses of this class are
documented in section @ref{3df0,,FileCookieJar subclasses and co-operation with web browsers}.

This should not be initialized directly – use its subclasses below instead.


Alterado na versão 3.8: The filename parameter supports a @ref{2a0,,path-like object}.

@end deffn

@geindex CookiePolicy (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar CookiePolicy}@anchor{3ded}
@deffn {Classe} http.cookiejar.CookiePolicy

This class is responsible for deciding whether each cookie should be accepted
from / returned to the server.
@end deffn

@geindex DefaultCookiePolicy (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy}@anchor{1b89}
@deffn {Classe} 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'))

Constructor arguments should be passed as keyword arguments only.
`blocked_domains' is a sequence of domain names that we never accept cookies
from, nor return cookies to. `allowed_domains' if not @ref{675,,None}, this is a
sequence of the only domains for which we accept and return cookies.
`secure_protocols' is a sequence of protocols for which secure cookies can be
added to. By default `https' and `wss' (secure websocket) are considered
secure protocols. For all other arguments, see the documentation for
@ref{3ded,,CookiePolicy} and @ref{1b89,,DefaultCookiePolicy} objects.

@ref{1b89,,DefaultCookiePolicy} implements the standard accept / reject rules for
Netscape and 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies.  By default, 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies (ie. cookies
received in a @code{Set-Cookie} header with a version cookie-attribute of
1) are treated according to the RFC 2965 rules.  However, if RFC 2965 handling
is turned off or @ref{3df1,,rfc2109_as_netscape} is @code{True}, RFC 2109 cookies are
‘downgraded’ by the @ref{3c07,,CookieJar} instance to Netscape cookies, by
setting the @code{version} attribute of the @ref{3df2,,Cookie} instance to 0.
@ref{1b89,,DefaultCookiePolicy} also provides some parameters to allow some
fine-tuning of policy.
@end deffn

@geindex Cookie (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar Cookie}@anchor{3df2}
@deffn {Classe} http.cookiejar.Cookie

This class represents Netscape, 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} and 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies.  It is not
expected that users of @ref{70,,http.cookiejar} construct their own @ref{3df2,,Cookie}
instances.  Instead, if necessary, call @code{make_cookies()} on a
@ref{3c07,,CookieJar} instance.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{10b,,urllib.request}

URL opening with automatic cookie handling.

@item Module @ref{71,,http.cookies}

HTTP cookie classes, principally useful for server-side code.  The
@ref{70,,http.cookiejar} and @ref{71,,http.cookies} modules do not depend on each
other.

@item @indicateurl{https://curl.se/rfc/cookie_spec.html}

The specification of the original Netscape cookie protocol.  Though this is
still the dominant protocol, the ‘Netscape cookie protocol’ implemented by all
the major browsers (and @ref{70,,http.cookiejar}) only bears a passing resemblance to
the one sketched out in @code{cookie_spec.html}.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - HTTP State Management Mechanism

Obsoleted by 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html}. Uses @code{Set-Cookie} with version=1.

@geindex RFC; RFC 2965

@item RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} - HTTP State Management Mechanism

The Netscape protocol with the bugs fixed.  Uses @code{Set-Cookie2} in
place of @code{Set-Cookie}.  Not widely used.

@item @indicateurl{https://kristol.org/cookie/errata.html}

Unfinished errata to 
@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} - Use of HTTP State Management


@menu
* CookieJar and FileCookieJar Objects:: 
* FileCookieJar subclasses and co-operation with web browsers:: 
* Objeto CookiePolicy:: 
* DefaultCookiePolicy Objects:: 
* Objetos Cookie: Objetos Cookie<2>. 
* Exemplos: Exemplos<29>. 

@end menu

@node CookieJar and FileCookieJar Objects,FileCookieJar subclasses and co-operation with web browsers,,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-jar-objects}@anchor{3df3}@anchor{library/http cookiejar cookiejar-and-filecookiejar-objects}@anchor{3df4}
@subsubsection CookieJar and FileCookieJar Objects


@ref{3c07,,CookieJar} objects support the @ref{1ac,,iterator} protocol for iterating over
contained @ref{3df2,,Cookie} objects.

@ref{3c07,,CookieJar} has the following methods:

@geindex add_cookie_header() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar add_cookie_header}@anchor{3df5}
@deffn {Método} CookieJar.add_cookie_header (request)

Add correct @code{Cookie} header to `request'.

If policy allows (ie. the @code{rfc2965} and @code{hide_cookie2} attributes of
the @ref{3c07,,CookieJar}’s @ref{3ded,,CookiePolicy} instance are true and false
respectively), the @code{Cookie2} header is also added when appropriate.

The `request' object (usually a @ref{100e,,urllib.request.Request} instance)
must support the methods @code{get_full_url()}, @code{has_header()},
@code{get_header()}, @code{header_items()}, @code{add_unredirected_header()}
and the attributes @code{host}, @code{type}, @code{unverifiable}
and @code{origin_req_host} as documented by @ref{10b,,urllib.request}.


Alterado na versão 3.3: `request' object needs @code{origin_req_host} attribute. Dependency on a
deprecated method @code{get_origin_req_host()} has been removed.

@end deffn

@geindex extract_cookies() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar extract_cookies}@anchor{3df6}
@deffn {Método} CookieJar.extract_cookies (response, request)

Extract cookies from HTTP `response' and store them in the @ref{3c07,,CookieJar},
where allowed by policy.

The @ref{3c07,,CookieJar} will look for allowable @code{Set-Cookie} and
@code{Set-Cookie2} headers in the `response' argument, and store cookies
as appropriate (subject to the @ref{3df7,,CookiePolicy.set_ok()} method’s approval).

The `response' object (usually the result of a call to
@ref{293,,urllib.request.urlopen()}, or similar) should support an @code{info()}
method, which returns an @ref{27c,,email.message.Message} instance.

The `request' object (usually a @ref{100e,,urllib.request.Request} instance)
must support the method @code{get_full_url()} and the attributes
@code{host}, @code{unverifiable} and @code{origin_req_host},
as documented by @ref{10b,,urllib.request}.  The request is used to set
default values for cookie-attributes as well as for checking that the
cookie is allowed to be set.


Alterado na versão 3.3: `request' object needs @code{origin_req_host} attribute. Dependency on a
deprecated method @code{get_origin_req_host()} has been removed.

@end deffn

@geindex set_policy() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_policy}@anchor{3df8}
@deffn {Método} CookieJar.set_policy (policy)

Set the @ref{3ded,,CookiePolicy} instance to be used.
@end deffn

@geindex make_cookies() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar make_cookies}@anchor{3df9}
@deffn {Método} CookieJar.make_cookies (response, request)

Return sequence of @ref{3df2,,Cookie} objects extracted from `response' object.

See the documentation for @ref{3df6,,extract_cookies()} for the interfaces required of
the `response' and `request' arguments.
@end deffn

@geindex set_cookie_if_ok() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie_if_ok}@anchor{3dfa}
@deffn {Método} CookieJar.set_cookie_if_ok (cookie, request)

Set a @ref{3df2,,Cookie} if policy says it’s OK to do so.
@end deffn

@geindex set_cookie() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie}@anchor{3dfb}
@deffn {Método} CookieJar.set_cookie (cookie)

Set a @ref{3df2,,Cookie}, without checking with policy to see whether or not it
should be set.
@end deffn

@geindex clear() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar clear}@anchor{3dfc}
@deffn {Método} CookieJar.clear ([domain[, path[, name]]])

Clear some cookies.

If invoked without arguments, clear all cookies.  If given a single argument,
only cookies belonging to that `domain' will be removed. If given two arguments,
cookies belonging to the specified `domain' and URL `path' are removed.  If
given three arguments, then the cookie with the specified `domain', `path' and
`name' is removed.

Raises @ref{344,,KeyError} if no matching cookie exists.
@end deffn

@geindex clear_session_cookies() (método http.cookiejar.CookieJar)
@anchor{library/http cookiejar http cookiejar CookieJar clear_session_cookies}@anchor{3dfd}
@deffn {Método} CookieJar.clear_session_cookies ()

Descarta os cookies de sessão.

Discards all contained cookies that have a true @code{discard} attribute
(usually because they had either no @code{max-age} or @code{expires} cookie-attribute,
or an explicit @code{discard} cookie-attribute).  For interactive browsers, the end
of a session usually corresponds to closing the browser window.

Note that the @code{save()} method won’t save session cookies anyway, unless you
ask otherwise by passing a true `ignore_discard' argument.
@end deffn

@ref{3dec,,FileCookieJar} implements the following additional methods:

@geindex save() (método http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar save}@anchor{3dfe}
@deffn {Método} FileCookieJar.save (filename=None, ignore_discard=False, ignore_expires=False)

Save cookies to a file.

This base class raises @ref{228,,NotImplementedError}.  Subclasses may leave this
method unimplemented.

`filename' is the name of file in which to save cookies.  If `filename' is not
specified, @code{self.filename} is used (whose default is the value passed to
the constructor, if any); if @code{self.filename} is @ref{675,,None},
@ref{202,,ValueError} is raised.

`ignore_discard': save even cookies set to be discarded. `ignore_expires': save
even cookies that have expired

The file is overwritten if it already exists, thus wiping all the cookies it
contains.  Saved cookies can be restored later using the @ref{3dee,,load()} or
@ref{3def,,revert()} methods.
@end deffn

@geindex load() (método http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar load}@anchor{3dee}
@deffn {Método} FileCookieJar.load (filename=None, ignore_discard=False, ignore_expires=False)

Load cookies from a file.

Old cookies are kept unless overwritten by newly loaded ones.

Arguments are as for @ref{3dfe,,save()}.

The named file must be in the format understood by the class, or
@ref{3deb,,LoadError} will be raised.  Also, @ref{417,,OSError} may be raised, for
example if the file does not exist.


Alterado na versão 3.3: @ref{108b,,IOError} costumava ser levantada, agora ela é um apelido para @ref{417,,OSError}.

@end deffn

@geindex revert() (método http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar revert}@anchor{3def}
@deffn {Método} FileCookieJar.revert (filename=None, ignore_discard=False, ignore_expires=False)

Clear all cookies and reload cookies from a saved file.

@ref{3def,,revert()} can raise the same exceptions as @ref{3dee,,load()}. If there is a
failure, the object’s state will not be altered.
@end deffn

@ref{3dec,,FileCookieJar} instances have the following public attributes:

@geindex filename (atributo http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar filename}@anchor{3dff}
@deffn {Atributo} FileCookieJar.filename

Filename of default file in which to keep cookies.  This attribute may be
assigned to.
@end deffn

@geindex delayload (atributo http.cookiejar.FileCookieJar)
@anchor{library/http cookiejar http cookiejar FileCookieJar delayload}@anchor{3e00}
@deffn {Atributo} FileCookieJar.delayload

If true, load cookies lazily from disk.  This attribute should not be assigned
to.  This is only a hint, since this only affects performance, not behaviour
(unless the cookies on disk are changing). A @ref{3c07,,CookieJar} object may
ignore it.  None of the @ref{3dec,,FileCookieJar} classes included in the standard
library lazily loads cookies.
@end deffn

@node FileCookieJar subclasses and co-operation with web browsers,Objeto CookiePolicy,CookieJar and FileCookieJar Objects,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar file-cookie-jar-classes}@anchor{3df0}@anchor{library/http cookiejar filecookiejar-subclasses-and-co-operation-with-web-browsers}@anchor{3e01}
@subsubsection FileCookieJar subclasses and co-operation with web browsers


The following @ref{3c07,,CookieJar} subclasses are provided for reading and
writing.

@geindex MozillaCookieJar (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar MozillaCookieJar}@anchor{3e02}
@deffn {Classe} http.cookiejar.MozillaCookieJar (filename=None, delayload=None, policy=None)

A @ref{3dec,,FileCookieJar} that can load from and save cookies to disk in the
Mozilla @code{cookies.txt} file format (which is also used by curl and the Lynx
and Netscape browsers).

@cartouche
@quotation Nota 
This loses information about 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies, and also about newer or
non-standard cookie-attributes such as @code{port}.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Back up your cookies before saving if you have cookies whose loss / corruption
would be inconvenient (there are some subtleties which may lead to slight
changes in the file over a load / save round-trip).
@end quotation
@end cartouche

Also note that cookies saved while Mozilla is running will get clobbered by
Mozilla.
@end deffn

@geindex LWPCookieJar (classe em http.cookiejar)
@anchor{library/http cookiejar http cookiejar LWPCookieJar}@anchor{3e03}
@deffn {Classe} http.cookiejar.LWPCookieJar (filename=None, delayload=None, policy=None)

A @ref{3dec,,FileCookieJar} that can load from and save cookies to disk in format
compatible with the libwww-perl library’s @code{Set-Cookie3} file format.  This is
convenient if you want to store cookies in a human-readable file.


Alterado na versão 3.8: The filename parameter supports a @ref{2a0,,path-like object}.

@end deffn

@node Objeto CookiePolicy,DefaultCookiePolicy Objects,FileCookieJar subclasses and co-operation with web browsers,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-policy-objects}@anchor{3e04}@anchor{library/http cookiejar cookiepolicy-objects}@anchor{3e05}
@subsubsection Objeto CookiePolicy


Objects implementing the @ref{3ded,,CookiePolicy} interface have the following
methods:

@geindex set_ok() (método http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy set_ok}@anchor{3df7}
@deffn {Método} CookiePolicy.set_ok (cookie, request)

Return boolean value indicating whether cookie should be accepted from server.

`cookie' is a @ref{3df2,,Cookie} instance.  `request' is an object
implementing the interface defined by the documentation for
@ref{3df6,,CookieJar.extract_cookies()}.
@end deffn

@geindex return_ok() (método http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy return_ok}@anchor{3e06}
@deffn {Método} CookiePolicy.return_ok (cookie, request)

Return boolean value indicating whether cookie should be returned to server.

`cookie' is a @ref{3df2,,Cookie} instance.  `request' is an object
implementing the interface defined by the documentation for
@ref{3df5,,CookieJar.add_cookie_header()}.
@end deffn

@geindex domain_return_ok() (método http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy domain_return_ok}@anchor{3e07}
@deffn {Método} CookiePolicy.domain_return_ok (domain, request)

Return @code{False} if cookies should not be returned, given cookie domain.

This method is an optimization.  It removes the need for checking every cookie
with a particular domain (which might involve reading many files).  Returning
true from @ref{3e07,,domain_return_ok()} and @ref{3e08,,path_return_ok()} leaves all the
work to @ref{3e06,,return_ok()}.

If @ref{3e07,,domain_return_ok()} returns true for the cookie domain,
@ref{3e08,,path_return_ok()} is called for the cookie path.  Otherwise,
@ref{3e08,,path_return_ok()} and @ref{3e06,,return_ok()} are never called for that cookie
domain.  If @ref{3e08,,path_return_ok()} returns true, @ref{3e06,,return_ok()} is called
with the @ref{3df2,,Cookie} object itself for a full check.  Otherwise,
@ref{3e06,,return_ok()} is never called for that cookie path.

Note that @ref{3e07,,domain_return_ok()} is called for every `cookie' domain, not just
for the `request' domain.  For example, the function might be called with both
@code{".example.com"} and @code{"www.example.com"} if the request domain is
@code{"www.example.com"}.  The same goes for @ref{3e08,,path_return_ok()}.

The `request' argument is as documented for @ref{3e06,,return_ok()}.
@end deffn

@geindex path_return_ok() (método http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy path_return_ok}@anchor{3e08}
@deffn {Método} CookiePolicy.path_return_ok (path, request)

Return @code{False} if cookies should not be returned, given cookie path.

See the documentation for @ref{3e07,,domain_return_ok()}.
@end deffn

In addition to implementing the methods above, implementations of the
@ref{3ded,,CookiePolicy} interface must also supply the following attributes,
indicating which protocols should be used, and how.  All of these attributes may
be assigned to.

@geindex netscape (atributo http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy netscape}@anchor{3e09}
@deffn {Atributo} CookiePolicy.netscape

Implement Netscape protocol.
@end deffn

@geindex rfc2965 (atributo http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy rfc2965}@anchor{3e0a}
@deffn {Atributo} CookiePolicy.rfc2965

Implement 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} protocol.
@end deffn

@geindex hide_cookie2 (atributo http.cookiejar.CookiePolicy)
@anchor{library/http cookiejar http cookiejar CookiePolicy hide_cookie2}@anchor{3e0b}
@deffn {Atributo} CookiePolicy.hide_cookie2

Don’t add @code{Cookie2} header to requests (the presence of this header
indicates to the server that we understand 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies).
@end deffn

The most useful way to define a @ref{3ded,,CookiePolicy} class is by subclassing
from @ref{1b89,,DefaultCookiePolicy} and overriding some or all of the methods
above.  @ref{3ded,,CookiePolicy} itself may be used as a ‘null policy’ to allow
setting and receiving any and all cookies (this is unlikely to be useful).

@node DefaultCookiePolicy Objects,Objetos Cookie<2>,Objeto CookiePolicy,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar default-cookie-policy-objects}@anchor{3e0c}@anchor{library/http cookiejar defaultcookiepolicy-objects}@anchor{3e0d}
@subsubsection DefaultCookiePolicy Objects


Implements the standard rules for accepting and returning cookies.

Both 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} and Netscape cookies are covered.  RFC 2965 handling is switched
off by default.

The easiest way to provide your own policy is to override this class and call
its methods in your overridden implementations before adding your own additional
checks:

@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

In addition to the features required to implement the @ref{3ded,,CookiePolicy}
interface, this class allows you to block and allow domains from setting and
receiving cookies.  There are also some strictness switches that allow you to
tighten up the rather loose Netscape protocol rules a little bit (at the cost of
blocking some benign cookies).

A domain blocklist and allowlist is provided (both off by default). Only domains
not in the blocklist and present in the allowlist (if the allowlist is active)
participate in cookie setting and returning.  Use the `blocked_domains'
constructor argument, and @code{blocked_domains()} and
@code{set_blocked_domains()} methods (and the corresponding argument and methods
for `allowed_domains').  If you set an allowlist, you can turn it off again by
setting it to @ref{675,,None}.

Domains in block or allow lists that do not start with a dot must equal the
cookie domain to be matched.  For example, @code{"example.com"} matches a blocklist
entry of @code{"example.com"}, but @code{"www.example.com"} does not.  Domains that do
start with a dot are matched by more specific domains too. For example, both
@code{"www.example.com"} and @code{"www.coyote.example.com"} match @code{".example.com"}
(but @code{"example.com"} itself does not).  IP addresses are an exception, and
must match exactly.  For example, if blocked_domains contains @code{"192.168.1.2"}
and @code{".168.1.2"}, 192.168.1.2 is blocked, but 193.168.1.2 is not.

@ref{1b89,,DefaultCookiePolicy} implements the following additional methods:

@geindex blocked_domains() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy blocked_domains}@anchor{3e0e}
@deffn {Método} DefaultCookiePolicy.blocked_domains ()

Return the sequence of blocked domains (as a tuple).
@end deffn

@geindex set_blocked_domains() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_blocked_domains}@anchor{3e0f}
@deffn {Método} DefaultCookiePolicy.set_blocked_domains (blocked_domains)

Set the sequence of blocked domains.
@end deffn

@geindex is_blocked() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_blocked}@anchor{3e10}
@deffn {Método} DefaultCookiePolicy.is_blocked (domain)

Return @code{True} if `domain' is on the blocklist for setting or receiving
cookies.
@end deffn

@geindex allowed_domains() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy allowed_domains}@anchor{3e11}
@deffn {Método} DefaultCookiePolicy.allowed_domains ()

Return @ref{675,,None}, or the sequence of allowed domains (as a tuple).
@end deffn

@geindex set_allowed_domains() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_allowed_domains}@anchor{3e12}
@deffn {Método} DefaultCookiePolicy.set_allowed_domains (allowed_domains)

Set the sequence of allowed domains, or @ref{675,,None}.
@end deffn

@geindex is_not_allowed() (método http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_not_allowed}@anchor{3e13}
@deffn {Método} DefaultCookiePolicy.is_not_allowed (domain)

Return @code{True} if `domain' is not on the allowlist for setting or receiving
cookies.
@end deffn

@ref{1b89,,DefaultCookiePolicy} instances have the following attributes, which are
all initialised from the constructor arguments of the same name, and which may
all be assigned to.

@geindex rfc2109_as_netscape (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy rfc2109_as_netscape}@anchor{3df1}
@deffn {Atributo} DefaultCookiePolicy.rfc2109_as_netscape

If true, request that the @ref{3c07,,CookieJar} instance downgrade 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies
(ie. cookies received in a @code{Set-Cookie} header with a version
cookie-attribute of 1) to Netscape cookies by setting the version attribute of
the @ref{3df2,,Cookie} instance to 0.  The default value is @ref{675,,None}, in which
case RFC 2109 cookies are downgraded if and only if 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} handling is turned
off.  Therefore, RFC 2109 cookies are downgraded by default.
@end deffn

General strictness switches:

@geindex strict_domain (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_domain}@anchor{3e14}
@deffn {Atributo} DefaultCookiePolicy.strict_domain

Don’t allow sites to set two-component domains with country-code top-level
domains like @code{.co.uk}, @code{.gov.uk}, @code{.co.nz}.etc.  This is far from perfect
and isn’t guaranteed to work!
@end deffn

@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} protocol strictness switches:

@geindex strict_rfc2965_unverifiable (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_rfc2965_unverifiable}@anchor{3e15}
@deffn {Atributo} DefaultCookiePolicy.strict_rfc2965_unverifiable

Follow 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} rules on unverifiable transactions (usually, an unverifiable
transaction is one resulting from a redirect or a request for an image hosted on
another site).  If this is false, cookies are `never' blocked on the basis of
verifiability
@end deffn

Netscape protocol strictness switches:

@geindex strict_ns_unverifiable (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_unverifiable}@anchor{3e16}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_unverifiable

Apply 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} rules on unverifiable transactions even to Netscape cookies.
@end deffn

@geindex strict_ns_domain (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_domain}@anchor{3e17}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_domain

Flags indicating how strict to be with domain-matching rules for Netscape
cookies.  See below for acceptable values.
@end deffn

@geindex strict_ns_set_initial_dollar (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_initial_dollar}@anchor{3e18}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_set_initial_dollar

Ignore cookies in Set-Cookie: headers that have names starting with @code{'$'}.
@end deffn

@geindex strict_ns_set_path (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_path}@anchor{3e19}
@deffn {Atributo} DefaultCookiePolicy.strict_ns_set_path

Don’t allow setting cookies whose path doesn’t path-match request URI.
@end deffn

@ref{3e17,,strict_ns_domain} is a collection of flags.  Its value is constructed by
or-ing together (for example, @code{DomainStrictNoDots|DomainStrictNonDomain} means
both flags are set).

@geindex DomainStrictNoDots (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNoDots}@anchor{3e1a}
@deffn {Atributo} DefaultCookiePolicy.DomainStrictNoDots

When setting cookies, the ‘host prefix’ must not contain a dot (eg.
@code{www.foo.bar.com} can’t set a cookie for @code{.bar.com}, because @code{www.foo}
contains a dot).
@end deffn

@geindex DomainStrictNonDomain (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNonDomain}@anchor{3e1b}
@deffn {Atributo} DefaultCookiePolicy.DomainStrictNonDomain

Cookies that did not explicitly specify a @code{domain} cookie-attribute can only
be returned to a domain equal to the domain that set the cookie (eg.
@code{spam.example.com} won’t be returned cookies from @code{example.com} that had no
@code{domain} cookie-attribute).
@end deffn

@geindex DomainRFC2965Match (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainRFC2965Match}@anchor{3e1c}
@deffn {Atributo} DefaultCookiePolicy.DomainRFC2965Match

When setting cookies, require a full 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} domain-match.
@end deffn

The following attributes are provided for convenience, and are the most useful
combinations of the above flags:

@geindex DomainLiberal (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainLiberal}@anchor{3e1d}
@deffn {Atributo} DefaultCookiePolicy.DomainLiberal

Equivalent to 0 (ie. all of the above Netscape domain strictness flags switched
off).
@end deffn

@geindex DomainStrict (atributo http.cookiejar.DefaultCookiePolicy)
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrict}@anchor{3e1e}
@deffn {Atributo} DefaultCookiePolicy.DomainStrict

Equivalente a @code{DomainStrictNoDots|DomainStrictNonDomain}.
@end deffn

@node Objetos Cookie<2>,Exemplos<29>,DefaultCookiePolicy Objects,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar cookie-objects}@anchor{3e1f}
@subsubsection Objetos Cookie


@ref{3df2,,Cookie} instances have Python attributes roughly corresponding to the
standard cookie-attributes specified in the various cookie standards.  The
correspondence is not one-to-one, because there are complicated rules for
assigning default values, because the @code{max-age} and @code{expires}
cookie-attributes contain equivalent information, and because 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies
may be ‘downgraded’ by @ref{70,,http.cookiejar} from version 1 to version 0 (Netscape)
cookies.

Assignment to these attributes should not be necessary other than in rare
circumstances in a @ref{3ded,,CookiePolicy} method.  The class does not enforce
internal consistency, so you should know what you’re doing if you do that.

@geindex version (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie version}@anchor{3e20}
@deffn {Atributo} Cookie.version

Integer or @ref{675,,None}.  Netscape cookies have @ref{3e20,,version} 0. 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} and
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies have a @code{version} cookie-attribute of 1.  However, note that
@ref{70,,http.cookiejar} may ‘downgrade’ RFC 2109 cookies to Netscape cookies, in which
case @ref{3e20,,version} is 0.
@end deffn

@geindex name (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie name}@anchor{3e21}
@deffn {Atributo} Cookie.name

Cookie name (a string).
@end deffn

@geindex value (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie value}@anchor{3e22}
@deffn {Atributo} Cookie.value

Cookie value (a string), or @ref{675,,None}.
@end deffn

@geindex port (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie port}@anchor{3e23}
@deffn {Atributo} Cookie.port

String representing a port or a set of ports (eg. ‘80’, or ‘80,8080’), or
@ref{675,,None}.
@end deffn

@geindex domain (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain}@anchor{3e24}
@deffn {Atributo} Cookie.domain

Cookie domain (a string).
@end deffn

@geindex path (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie path}@anchor{3e25}
@deffn {Atributo} Cookie.path

Cookie path (a string, eg. @code{'/acme/rocket_launchers'}).
@end deffn

@geindex secure (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie secure}@anchor{3e26}
@deffn {Atributo} Cookie.secure

@code{True} if cookie should only be returned over a secure connection.
@end deffn

@geindex expires (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie expires}@anchor{3e27}
@deffn {Atributo} Cookie.expires

Integer expiry date in seconds since epoch, or @ref{675,,None}.  See also the
@ref{3e28,,is_expired()} method.
@end deffn

@geindex discard (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie discard}@anchor{3e29}
@deffn {Atributo} Cookie.discard

@code{True} if this is a session cookie.
@end deffn

@geindex comment (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie comment}@anchor{3e2a}
@deffn {Atributo} Cookie.comment

String comment from the server explaining the function of this cookie, or
@ref{675,,None}.
@end deffn

@geindex comment_url (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie comment_url}@anchor{3e2b}
@deffn {Atributo} Cookie.comment_url

URL linking to a comment from the server explaining the function of this cookie,
or @ref{675,,None}.
@end deffn

@geindex rfc2109 (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie rfc2109}@anchor{3e2c}
@deffn {Atributo} Cookie.rfc2109

@code{True} if this cookie was received as an 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookie (ie. the cookie
arrived in a @code{Set-Cookie} header, and the value of the Version
cookie-attribute in that header was 1).  This attribute is provided because
@ref{70,,http.cookiejar} may ‘downgrade’ RFC 2109 cookies to Netscape cookies, in
which case @ref{3e20,,version} is 0.
@end deffn

@geindex port_specified (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie port_specified}@anchor{3e2d}
@deffn {Atributo} Cookie.port_specified

@code{True} if a port or set of ports was explicitly specified by the server (in the
@code{Set-Cookie} / @code{Set-Cookie2} header).
@end deffn

@geindex domain_specified (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain_specified}@anchor{3e2e}
@deffn {Atributo} Cookie.domain_specified

@code{True} if a domain was explicitly specified by the server.
@end deffn

@geindex domain_initial_dot (atributo http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie domain_initial_dot}@anchor{3e2f}
@deffn {Atributo} Cookie.domain_initial_dot

@code{True} if the domain explicitly specified by the server began with a dot
(@code{'.'}).
@end deffn

Cookies may have additional non-standard cookie-attributes.  These may be
accessed using the following methods:

@geindex has_nonstandard_attr() (método http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie has_nonstandard_attr}@anchor{3e30}
@deffn {Método} Cookie.has_nonstandard_attr (name)

Return @code{True} if cookie has the named cookie-attribute.
@end deffn

@geindex get_nonstandard_attr() (método http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie get_nonstandard_attr}@anchor{3e31}
@deffn {Método} Cookie.get_nonstandard_attr (name, default=None)

If cookie has the named cookie-attribute, return its value. Otherwise, return
`default'.
@end deffn

@geindex set_nonstandard_attr() (método http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie set_nonstandard_attr}@anchor{3e32}
@deffn {Método} Cookie.set_nonstandard_attr (name, value)

Set the value of the named cookie-attribute.
@end deffn

The @ref{3df2,,Cookie} class also defines the following method:

@geindex is_expired() (método http.cookiejar.Cookie)
@anchor{library/http cookiejar http cookiejar Cookie is_expired}@anchor{3e28}
@deffn {Método} Cookie.is_expired (now=None)

@code{True} if cookie has passed the time at which the server requested it should
expire.  If `now' is given (in seconds since the epoch), return whether the
cookie has expired at the specified time.
@end deffn

@node Exemplos<29>,,Objetos Cookie<2>,http cookiejar — Cookie handling for HTTP clients
@anchor{library/http cookiejar examples}@anchor{3e33}
@subsubsection Exemplos


The first example shows the most common usage of @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

This example illustrates how to open a URL using your Netscape, Mozilla, or Lynx
cookies (assumes Unix/Netscape convention for location of the cookies file):

@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

The next example illustrates the use of @ref{1b89,,DefaultCookiePolicy}. Turn on
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies, be more strict about domains when setting and returning
Netscape cookies, and block some domains from setting cookies or having them
returned:

@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 de servidor e cliente XMLRPC,xmlrpc client — Cliente XML-RPC,http cookiejar — Cookie handling for HTTP clients,Protocolos de Internet e Suporte
@anchor{library/xmlrpc doc}@anchor{3e34}@anchor{library/xmlrpc module-xmlrpc}@anchor{12d}@anchor{library/xmlrpc translation-repo}@anchor{3e35}@anchor{library/xmlrpc xmlrpc-xmlrpc-server-and-client-modules}@anchor{3e36}
@subsection @code{xmlrpc} — Módulos de servidor e cliente XMLRPC


@geindex module; xmlrpc

XML-RPC é um método de chamada de procedimento remoto que usa XML passado via HTTP como um transporte. Com ele, um cliente pode chamar métodos com parâmetros em um servidor remoto (o servidor é nomeado por um URI) e receber dados estruturados.

@code{xmlrpc} é um pacote que coleta módulos de servidor e de cliente que implementam o XML-RPC. Os módulos são:


@itemize *

@item 
@ref{12e,,xmlrpc.client}

@item 
@ref{12f,,xmlrpc.server}
@end itemize

@node xmlrpc client — Cliente XML-RPC,xmlrpc server — Servidores XML-RPC básicos,xmlrpc — Módulos de servidor e cliente XMLRPC,Protocolos de Internet e Suporte
@anchor{library/xmlrpc client doc}@anchor{3e37}@anchor{library/xmlrpc client module-xmlrpc client}@anchor{12e}@anchor{library/xmlrpc client translation-repo}@anchor{3e38}@anchor{library/xmlrpc client xmlrpc-client-xml-rpc-client-access}@anchor{3e39}
@subsection @code{xmlrpc.client} — Cliente XML-RPC


@geindex module; xmlrpc.client

`Código-fonte:' Lib/xmlrpc/client.py@footnote{https://github.com/python/cpython/tree/3.13/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 é um método de chamada remota de métodos que usa XML usando HTTP(S) como transporte.  Com ele, um cliente pode chamar métodos com parâmetros em um servidor remoto (o servidor é nomeado por um URI) e receber de volta dados estruturados.  Este módulo oferece suporte à escrita de código de clientes XML-RPC; ele lida com todos os detalhes da tradução entre Python objetos e XML.

@cartouche
@quotation Aviso 
O módulo @ref{12e,,xmlrpc.client} não é seguro contra dados criados com códigos maliciosos. Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche


Alterado na versão 3.5: Para URIs com HTTPS, @ref{12e,,xmlrpc.client} agora faz todas as validações de certificado e nome do servidor necessárias por padrão.


@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@geindex ServerProxy (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client ServerProxy}@anchor{a61}
@deffn {Classe} xmlrpc.client.ServerProxy (uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, headers=(), context=None)

Uma instância de @ref{a61,,ServerProxy} é um objeto que gerencia a comunicação com um servidor XML-RPC remoto. O primeiro argumento obrigatório é uma URI (Uniform Resource Indicator - Indicador de Recurso Uniforme) e normalmente vai ser a URL do servidor. O segundo parâmetro, opcional, é uma instância de um factory de transporte; por padrão é uma instância de @code{SafeTransport} para URLs https e uma instância de @code{Transport} caso contrário. O terceiro parâmetro, opcional, é o encoding, por padrão sendo UTF-8. O quarto argumento, opcional, é a flag de debug.

Os seguinte parâmetros coordenam o uso da instância de proxy retornada. Se `alow_none' for verdadeiro, a constante @code{None} do Python será traduzida para XML; o comportamento padrão é que @code{None} levante uma @ref{2c3,,TypeError}, Isso é uma extensão comum da especificação do XML-RPC, mas não é suportado por todos os clientes e servidores, veja  http://ontosys.com/xml-rpc/extensions.php@footnote{https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php} para uma descrição. A flag `use_builtin_types' pode ser usada para  que valores de data e hora sejam representados como objetos @ref{1cc,,datetime.datetime} e dados binários representados com objetos @ref{1c2,,bytes}; essa flag é False por padrão. Objetos @ref{1cc,,datetime.datetime}, @ref{1c2,,bytes} e @ref{2ea,,bytearray} podem ser usados nas chamadas. O parâmetro `headers' é uma sequência opcional de headers a serem enviados em cada requisição, representados por uma sequência de tuplas de dois valores representando o nome do header e seu valor (como @code{[('Header-Name', 'value')]}). Se uma URL HTTPS é fornecida, `context' pode ser @ref{294,,ssl.SSLContext} e configura as definições SSL da conexão HTTPS subjacente. A flag `use_datetime' é obsoleta e é similar a `use_builtin_types' mas se aplica somente a valores de data e hora.


Alterado na versão 3.3: O sinalizador `use_builtin_types' foi adicionado.



Alterado na versão 3.8: O parâmetro `headers' foi adicionado.


Both the HTTP and HTTPS transports support the URL syntax extension for HTTP
Basic Authentication: @code{http://user:pass@@host:port/path}.  The  @code{user:pass}
portion will be base64-encoded as an HTTP ‘Authorization’ header, and sent to
the remote server as part of the connection process when invoking an XML-RPC
method.  You only need to use this if the remote server requires a Basic
Authentication user and password.

A instância retornada é um objeto proxy com métodos que podem ser usados para invocar a chamada RPC correspondendo no servidor remoto. Se o servidor remoto suportar a API de instrospecção, o proxy também pode ser usado para perguntar ao servidor remoto pelos métodos que ele suporta (descoberta de serviço) e recuperar outros meta-dados associados com o servidor.

Os tipos que são conformáveis (por exemplo, que podem ser convertidos para XML) incluem os seguintes (e exceto onde indicado, eles não são convertidos como o mesmo tipo Python):


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo XML-RPC

@tab

Tipo em Python

@item

@code{boolean}

@tab

@ref{468,,bool}

@item

@code{int}, @code{i1}, @code{i2}, @code{i4}, @code{i8} ou @code{biginteger}

@tab

@ref{257,,int} no intervalo de -2147483648 a 2147483647. Os valores recebem a tag @code{<int>}.

@item

@code{double} ou @code{float}

@tab

@ref{2f7,,float}.  Os valores recebem a tag @code{<double>}.

@item

@code{string}

@tab

@ref{44c,,str}

@item

@code{array}

@tab

@ref{611,,list} ou @ref{370,,tuple} contendo elementos conformáveis.  As matrizes são retornadas como @ref{611,,lists}.

@item

@code{struct}

@tab

@ref{256,,dict}. Chaves devem ser strings, valores podem ser qualquer tipo conformáveis. Objetos de classes definidas pelo usuário pode ser usadas; apenas o atributo @ref{55b,,__dict__} delas é transmitido.

@item

@code{dateTime.iso8601}

@tab

@ref{142a,,DateTime} ou @ref{1cc,,datetime.datetime}. O tipo retornado depende de volumes de sinalizadores `use_builtin_types' e `use_datetime'.

@item

@code{base64}

@tab

@ref{3e3a,,Binary}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}.  O tipo retornado depende do valor da flag `use_builtin_types'.

@item

@code{nil}

@tab

A constante @code{None}.  A passagem é permitida somente se `allow_none' for verdadeiro.

@item

@code{bigdecimal}

@tab

@ref{29d,,decimal.Decimal}.  Somente tipo retornado.

@end multitable


Esta é a lista completa de tipos suportados por XML-RPC. Chamadas de método podem também levantar uma instância de @ref{3e3b,,Fault}, usado para que o servidor XML-RPC indique erros, ou @ref{3e3c,,ProtocolError} para indicar erros na camada HTTP/HTTPS. Tnato @ref{3e3b,,Fault} quanto @ref{3e3c,,ProtocolError} derivam da classe base @code{Error}. Observe que o módulo de cliente xmlrpc atualmente não converte instância de subclasses dos tipos built-in.

Ao passar strings, os caracteres especiais para XML, como @code{<}, @code{>} e @code{&}, serão automaticamente escapados.  No entanto, é responsabilidade do chamador garantir que o string esteja livre de caracteres que não são permitidos em XML, como os caracteres de controle com valores ASCII entre 0 e 31 (exceto, é claro, tabulação, nova linha e retorno de carro); se isso não for feito, resultará em uma solicitação XML-RPC que não é um XML bem formado.  Se você precisar passar bytes arbitrários via XML-RPC, use as classes @ref{1c2,,bytes} ou @ref{2ea,,bytearray} ou a classe wrapper @ref{3e3a,,Binary} descrito abaixo.

@code{Server} foi mantido como um apelido para @ref{a61,,ServerProxy} para compatibilidade retroativa.  Código novo deve usar @ref{a61,,ServerProxy}.


Alterado na versão 3.5: Argumento `context' adicionado.



Alterado na versão 3.6: Adicionado suporte para tags com prefixos (por exemplo @code{ex:nil}) Adicionado suporte para desconversão de tipos adicionados usados pela implementação do Apache XML-RPC para numéricos: @code{i1}, @code{i2}, @code{i8}, @code{biginteger}, @code{float} e @code{bigdecimal}. Veja   @indicateurl{https://ws.apache.org/xmlrpc/types.html} para uma descrição.

@end deffn


@subsubheading Ver também



@table @asis

@item XML-RPC HOWTO@footnote{https://tldp.org/HOWTO/XML-RPC-HOWTO/index.html}

Uma boa descrição das operações XML-RPC e software cliente em vários idiomas. Contém praticamente tudo o que um desenvolvedor de clientes XML-RPC precisa saber.

@item XML-RPC Introspection@footnote{https://xmlrpc-c.sourceforge.io/introspection.html}

Describe a extensão do protocolo XML-RPC para instrospecção.

@item XML-RPC Specification@footnote{http://xmlrpc.scripting.com/spec.html}

A especificação oficial.
@end table


@menu
* Objetos ServerProxy:: 
* Objetos DateTime:: 
* Objetos Binários:: 
* Objetos Fault:: 
* Objetos ProtocolError:: 
* Objetos MultiCall:: 
* Convenience Functions:: 
* Exemplo de uso do cliente:: 
* Example of Client and Server Usage:: 

@end menu

@node Objetos ServerProxy,Objetos DateTime,,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client id1}@anchor{3e3d}@anchor{library/xmlrpc client serverproxy-objects}@anchor{3e3e}
@subsubsection Objetos ServerProxy


A @ref{a61,,ServerProxy} instance has a method corresponding to each remote
procedure call accepted by the XML-RPC server.  Calling the method performs an
RPC, dispatched by both name and argument signature (e.g. the same method name
can be overloaded with multiple argument signatures).  The RPC finishes by
returning a value, which may be either returned data in a conformant type or a
@ref{3e3b,,Fault} or @ref{3e3c,,ProtocolError} object indicating an error.

Servers that support the XML introspection API support some common methods
grouped under the reserved @code{system} attribute:

@geindex listMethods() (método xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system listMethods}@anchor{3e3f}
@deffn {Método} ServerProxy.system.listMethods ()

This method returns a list of strings, one for each (non-system) method
supported by the XML-RPC server.
@end deffn

@geindex methodSignature() (método xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodSignature}@anchor{3e40}
@deffn {Método} ServerProxy.system.methodSignature (name)

This method takes one parameter, the name of a method implemented by the XML-RPC
server. It returns an array of possible signatures for this method. A signature
is an array of types. The first of these types is the return type of the method,
the rest are parameters.

Because multiple signatures (ie. overloading) is permitted, this method returns
a list of signatures rather than a singleton.

Signatures themselves are restricted to the top level parameters expected by a
method. For instance if a method expects one array of structs as a parameter,
and it returns a string, its signature is simply “string, array”. If it expects
three integers and returns a string, its signature is “string, int, int, int”.

If no signature is defined for the method, a non-array value is returned. In
Python this means that the type of the returned  value will be something other
than list.
@end deffn

@geindex methodHelp() (método xmlrpc.client.ServerProxy.system)
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodHelp}@anchor{3e41}
@deffn {Método} ServerProxy.system.methodHelp (name)

This method takes one parameter, the name of a method implemented by the XML-RPC
server.  It returns a documentation string describing the use of that method. If
no such string is available, an empty string is returned. The documentation
string may contain HTML markup.
@end deffn


Alterado na versão 3.5: Instances of @ref{a61,,ServerProxy} support the @ref{5d4,,context manager} protocol
for closing the underlying transport.


A working example follows. The server code:

@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

The client code for the preceding server:

@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 Binários,Objetos ServerProxy,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client datetime-objects}@anchor{3e42}@anchor{library/xmlrpc client id2}@anchor{3e43}
@subsubsection Objetos DateTime


@geindex DateTime (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client DateTime}@anchor{142a}
@deffn {Classe} xmlrpc.client.DateTime

This class may be initialized with seconds since the epoch, a time
tuple, an ISO 8601 time/date string, or a @ref{1cc,,datetime.datetime}
instance.  It has the following methods, supported mainly for internal
use by the marshalling/unmarshalling code:

@geindex decode() (método xmlrpc.client.DateTime)
@anchor{library/xmlrpc client xmlrpc client DateTime decode}@anchor{3e44}
@deffn {Método} decode (string)

Accept a string as the instance’s new time value.
@end deffn

@geindex encode() (método xmlrpc.client.DateTime)
@anchor{library/xmlrpc client xmlrpc client DateTime encode}@anchor{3e45}
@deffn {Método} encode (out)

Write the XML-RPC encoding of this @ref{142a,,DateTime} item to the `out' stream
object.
@end deffn

It also supports certain of Python’s built-in operators through
@ref{12e2,,rich comparison} and @ref{61c,,__repr__()}
methods.
@end deffn

A working example follows. The server code:

@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

The client code for the preceding server:

@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 Binários,Objetos Fault,Objetos DateTime,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client binary-objects}@anchor{3e46}@anchor{library/xmlrpc client id3}@anchor{3e47}
@subsubsection Objetos Binários


@geindex Binary (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client Binary}@anchor{3e3a}
@deffn {Classe} xmlrpc.client.Binary

This class may be initialized from bytes data (which may include NULs). The
primary access to the content of a @ref{3e3a,,Binary} object is provided by an
attribute:

@geindex data (atributo xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary data}@anchor{3e48}
@deffn {Atributo} data

The binary data encapsulated by the @ref{3e3a,,Binary} instance.  The data is
provided as a @ref{1c2,,bytes} object.
@end deffn

@ref{3e3a,,Binary} objects have the following methods, supported mainly for
internal use by the marshalling/unmarshalling code:

@geindex decode() (método xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary decode}@anchor{3e49}
@deffn {Método} decode (bytes)

Accept a base64 @ref{1c2,,bytes} object and decode it as the instance’s new data.
@end deffn

@geindex encode() (método xmlrpc.client.Binary)
@anchor{library/xmlrpc client xmlrpc client Binary encode}@anchor{3e4a}
@deffn {Método} encode (out)

Write the XML-RPC base 64 encoding of this binary item to the `out' stream object.

The encoded data will have newlines every 76 characters as per
@geindex RFC; RFC 2045 Section 6.8
RFC 2045 section 6.8@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html#section-6.8},
which was the de facto standard base64 specification when the
XML-RPC spec was written.
@end deffn

It also supports certain of Python’s built-in operators through
@ref{b0d,,__eq__()} and @ref{1560,,__ne__()} methods.
@end deffn

Example usage of the binary objects.  We’re going to transfer an image over
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

The client gets the image and saves it to a file:

@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 Fault,Objetos ProtocolError,Objetos Binários,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client fault-objects}@anchor{3e4b}@anchor{library/xmlrpc client id4}@anchor{3e4c}
@subsubsection Objetos Fault


@geindex Fault (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client Fault}@anchor{3e3b}
@deffn {Classe} xmlrpc.client.Fault

A @ref{3e3b,,Fault} object encapsulates the content of an XML-RPC fault tag. Fault
objects have the following attributes:

@geindex faultCode (atributo xmlrpc.client.Fault)
@anchor{library/xmlrpc client xmlrpc client Fault faultCode}@anchor{3e4d}
@deffn {Atributo} faultCode

An int indicating the fault type.
@end deffn

@geindex faultString (atributo xmlrpc.client.Fault)
@anchor{library/xmlrpc client xmlrpc client Fault faultString}@anchor{3e4e}
@deffn {Atributo} faultString

A string containing a diagnostic message associated with the fault.
@end deffn
@end deffn

In the following example we’re going to intentionally cause a @ref{3e3b,,Fault} by
returning a complex type object.  The server code:

@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

The client code for the preceding server:

@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 Fault,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client protocol-error-objects}@anchor{3e4f}@anchor{library/xmlrpc client protocolerror-objects}@anchor{3e50}
@subsubsection Objetos ProtocolError


@geindex ProtocolError (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client ProtocolError}@anchor{3e3c}
@deffn {Classe} xmlrpc.client.ProtocolError

A @ref{3e3c,,ProtocolError} object describes a protocol error in the underlying
transport layer (such as a 404 ‘not found’ error if the server named by the URI
does not exist).  It has the following attributes:

@geindex url (atributo xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError url}@anchor{3e51}
@deffn {Atributo} url

The URI or URL that triggered the error.
@end deffn

@geindex errcode (atributo xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError errcode}@anchor{3e52}
@deffn {Atributo} errcode

O código do erro.
@end deffn

@geindex errmsg (atributo xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError errmsg}@anchor{3e53}
@deffn {Atributo} errmsg

The error message or diagnostic string.
@end deffn

@geindex headers (atributo xmlrpc.client.ProtocolError)
@anchor{library/xmlrpc client xmlrpc client ProtocolError headers}@anchor{3e54}
@deffn {Atributo} headers

A dict containing the headers of the HTTP/HTTPS request that triggered the
error.
@end deffn
@end deffn

In the following example we’re going to intentionally cause a @ref{3e3c,,ProtocolError}
by providing an invalid URI:

@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,Convenience Functions,Objetos ProtocolError,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client multicall-objects}@anchor{3e55}
@subsubsection Objetos MultiCall


The @ref{3e56,,MultiCall} object provides a way to encapsulate multiple calls to a
remote server into a single request @footnote{
This approach has been first presented in @uref{https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic,a discussion on xmlrpc.com}.
}.

@geindex MultiCall (classe em xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client MultiCall}@anchor{3e56}
@deffn {Classe} xmlrpc.client.MultiCall (server)

Create an object used to boxcar method calls. `server' is the eventual target of
the call. Calls can be made to the result object, but they will immediately
return @code{None}, and only store the call name and parameters in the
@ref{3e56,,MultiCall} object. Calling the object itself causes all stored calls to
be transmitted as a single @code{system.multicall} request. The result of this call
is a @ref{109a,,generator}; iterating over this generator yields the individual
results.
@end deffn

A usage example of this class follows.  The server code:

@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

The client code for the preceding server:

@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 Convenience Functions,Exemplo de uso do cliente,Objetos MultiCall,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client convenience-functions}@anchor{3e57}
@subsubsection Convenience Functions


@geindex dumps() (no módulo xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client dumps}@anchor{3e58}
@deffn {Função} xmlrpc.client.dumps (params, methodname=None, methodresponse=None, encoding=None, allow_none=False)

Convert `params' into an XML-RPC request, or into a response if `methodresponse'
is true. `params' can be either a tuple of arguments or an instance of the
@ref{3e3b,,Fault} exception class.  If `methodresponse' is true, only a single value
can be returned, meaning that `params' must be of length 1. `encoding', if
supplied, is the encoding to use in the generated XML; the default is UTF-8.
Python’s @ref{675,,None} value cannot be used in standard XML-RPC; to allow using
it via an extension,  provide a true value for `allow_none'.
@end deffn

@geindex loads() (no módulo xmlrpc.client)
@anchor{library/xmlrpc client xmlrpc client loads}@anchor{147c}
@deffn {Função} xmlrpc.client.loads (data, use_datetime=False, use_builtin_types=False)

Convert an XML-RPC request or response into Python objects, a @code{(params,
methodname)}.  `params' is a tuple of argument; `methodname' is a string, or
@code{None} if no method name is present in the packet. If the XML-RPC packet
represents a fault condition, this function will raise a @ref{3e3b,,Fault} exception.
The `use_builtin_types' flag can be used to cause date/time values to be
presented as @ref{1cc,,datetime.datetime} objects and binary data to be
presented as @ref{1c2,,bytes} objects; this flag is false by default.

The obsolete `use_datetime' flag is similar to `use_builtin_types' but it
applies only to date/time values.


Alterado na versão 3.3: O sinalizador `use_builtin_types' foi adicionado.

@end deffn

@node Exemplo de uso do cliente,Example of Client and Server Usage,Convenience Functions,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client example-of-client-usage}@anchor{3e59}@anchor{library/xmlrpc client xmlrpc-client-example}@anchor{3e5a}
@subsubsection Exemplo de uso do 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

To access an XML-RPC server through a HTTP proxy, you need to define a custom
transport.  The following example shows how:

@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 Example of Client and Server Usage,,Exemplo de uso do cliente,xmlrpc client — Cliente XML-RPC
@anchor{library/xmlrpc client example-of-client-and-server-usage}@anchor{3e5b}
@subsubsection Example of Client and Server Usage


Veja @ref{3e5c,,Exemplo de SimpleXMLRPCServer}.

@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 — Servidores XML-RPC básicos,ipaddress — Biblioteca de manipulação de IPv4/IPv6,xmlrpc client — Cliente XML-RPC,Protocolos de Internet e Suporte
@anchor{library/xmlrpc server doc}@anchor{3e5d}@anchor{library/xmlrpc server module-xmlrpc server}@anchor{12f}@anchor{library/xmlrpc server translation-repo}@anchor{3e5e}@anchor{library/xmlrpc server xmlrpc-server-basic-xml-rpc-servers}@anchor{3e5f}
@subsection @code{xmlrpc.server} — Servidores XML-RPC básicos


@geindex module; xmlrpc.server

`Código-fonte:' Lib/xmlrpc/server.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/xmlrpc/server.py}


__________________________________________________________________


O módulo @ref{12f,,xmlrpc.server} fornece um framework básico de servidor para servidores XML-RPC escritos em Python. Os servidores podem ser independentes, usando @ref{3e60,,SimpleXMLRPCServer}, ou incorporados em um ambiente CGI, usando @ref{3e61,,CGIXMLRPCRequestHandler}.

@cartouche
@quotation Aviso 
O módulo @ref{12f,,xmlrpc.server} não é seguro contra dados criados com códigos maliciosos. Se você precisar analisar dados não confiáveis ou não autenticados, consulte @ref{3999,,Segurança no XML}.
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@geindex SimpleXMLRPCServer (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer}@anchor{3e60}
@deffn {Classe} xmlrpc.server.SimpleXMLRPCServer (addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

Cria uma nova instância do servidor. Esta classe fornece métodos para registro de funções que podem ser chamadas pelo protocolo XML-RPC. O parâmetro `requestHandler' deve ser uma fábrica para instâncias do tratador de solicitações; o padrão é @ref{136c,,SimpleXMLRPCRequestHandler}. Os parâmetros `addr' e `requestHandler' são passados para o construtor @ref{1364,,socketserver.TCPServer}. Se `logRequests' for true (o padrão), as solicitações serão registradas; definir esse parâmetro como false desativará os registros. Os parâmetros `allow_none' e `encoding' são transmitidos para @ref{12e,,xmlrpc.client} e controlam as respostas XML-RPC que serão retornadas do servidor. O parâmetro `bind_and_activate' controla se @code{server_bind()} e @code{server_activate()} são chamados imediatamente pelo construtor; o padrão é true. A configuração como false permite que o código manipule a variável de classe `allow_reuse_address' antes que o endereço seja vinculado. O parâmetro `use_builtin_types' é passado para a função @ref{147c,,loads()} e controla quais tipos são processados quando valores de data/hora ou dados binários são recebidos; o padrão é false.


Alterado na versão 3.3: O sinalizador `use_builtin_types' foi adicionado.

@end deffn

@geindex CGIXMLRPCRequestHandler (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler}@anchor{3e61}
@deffn {Classe} xmlrpc.server.CGIXMLRPCRequestHandler (allow_none=False, encoding=None, use_builtin_types=False)

Cria uma nova instância para manipular solicitações XML-RPC em um ambiente CGI. Os parâmetros `allow_none' e `encoding' são transmitidos para @ref{12e,,xmlrpc.client} e controlam as respostas XML-RPC que serão retornadas do servidor. O parâmetro `use_builtin_types' é passado para a função @ref{147c,,loads()} e controla quais tipos são processados quando valores de data/hora ou dados binários são recebidos; o padrão é false.


Alterado na versão 3.3: O sinalizador `use_builtin_types' foi adicionado.

@end deffn

@geindex SimpleXMLRPCRequestHandler (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler}@anchor{136c}
@deffn {Classe} xmlrpc.server.SimpleXMLRPCRequestHandler

Cria uma nova instância do manipulador de solicitações. Este manipulador de solicitação possui suporte a solicitações @code{POST} e modifica o registro para que o parâmetro `logRequests' para o construtor de @ref{3e60,,SimpleXMLRPCServer} seja respeitado.
@end deffn

@menu
* Objetos de SimpleXMLRPCServer:: 
* CGIXMLRPCRequestHandler:: 
* Documentando servidor XMLRPC:: 
* Objetos de DocXMLRPCServer:: 
* DocCGIXMLRPCRequestHandler:: 

@end menu

@node Objetos de SimpleXMLRPCServer,CGIXMLRPCRequestHandler,,xmlrpc server — Servidores XML-RPC básicos
@anchor{library/xmlrpc server simple-xmlrpc-servers}@anchor{3e62}@anchor{library/xmlrpc server simplexmlrpcserver-objects}@anchor{3e63}
@subsubsection Objetos de SimpleXMLRPCServer


A classe @ref{3e60,,SimpleXMLRPCServer} é baseada em @ref{1364,,socketserver.TCPServer} e fornece um meio de criar servidores XML-RPC simples e independentes.

@geindex register_function() (método xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_function}@anchor{3e64}
@deffn {Método} SimpleXMLRPCServer.register_function (function=None, name=None)

Registra uma função que possa responder às solicitações XML-RPC. Se `name' for fornecido, será o nome do método associado a `function', caso contrário, @ref{1317,,function.__name__} será usado. `name' é uma string e pode conter caracteres ilegais para identificadores Python, incluindo o caractere de ponto.

Este método também pode ser usado como um decorador. Quando usado como decorador, `name' só pode ser fornecido como argumento nomeado para registrar `function' em `name'. Se nenhum `name' for fornecido, @ref{1317,,function.__name__} será usado.


Alterado na versão 3.7: @ref{3e64,,register_function()} pode ser usado como um decorador.

@end deffn

@geindex register_instance() (método xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_instance}@anchor{3e65}
@deffn {Método} SimpleXMLRPCServer.register_instance (instance, allow_dotted_names=False)

Registra um objeto que é usado para expor nomes de métodos que não foram registrados usando @ref{3e64,,register_function()}. Se `instance' contiver um método @code{_dispatch()}, ele será chamado com o nome do método solicitado e os parâmetros da solicitação. Sua API é @code{def _dispatch(self, method, params)} (observe que `params' não representa uma lista de argumentos variáveis). Se ele chama uma função subjacente para executar sua tarefa, essa função é chamada como @code{func(*params)}, expandindo a lista de parâmetros. O valor de retorno de @code{_dispatch()} é retornado ao cliente como resultado. Se `instance' não possui o método @code{_dispatch()}, é procurado por um atributo correspondente ao nome do método solicitado.

Se o argumento opcional `allow_dotted_names' for true e a instância não tiver o método @code{_dispatch()}, e se o nome do método solicitado contiver pontos, cada componente do nome do método será pesquisado individualmente, com o efeito de que um simples pesquisa hierárquica é realizada. O valor encontrado nessa pesquisa é chamado com os parâmetros da solicitação e o valor retornado é passado de volta ao cliente.

@cartouche
@quotation Aviso 
A ativação da opção `allow_dotted_names' permite que os invasores acessem as variáveis globais do seu módulo e podem permitir que os invasores executem códigos arbitrários em sua máquina. Use esta opção apenas em uma rede fechada e segura.
@end quotation
@end cartouche
@end deffn

@geindex register_introspection_functions() (método xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_introspection_functions}@anchor{3e66}
@deffn {Método} SimpleXMLRPCServer.register_introspection_functions ()

Registra as funções de introspecção XML-RPC @code{system.listMethods}, @code{system.methodHelp} e @code{system.methodSignature}.
@end deffn

@geindex register_multicall_functions() (método xmlrpc.server.SimpleXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_multicall_functions}@anchor{3e67}
@deffn {Método} SimpleXMLRPCServer.register_multicall_functions ()

Registra a função de multichamada XML-RPC system.multicall.
@end deffn

@geindex rpc_paths (atributo xmlrpc.server.SimpleXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler rpc_paths}@anchor{3e68}
@deffn {Atributo} SimpleXMLRPCRequestHandler.rpc_paths

Um valor de atributo que deve ser uma tupla listando partes do caminho válidas da URL para receber solicitações XML-RPC. Solicitações postadas em outros caminhos resultarão em um erro HTTP 404 “página inexistente”. Se esta tupla estiver vazia, todos os caminhos serão considerados válidos. O valor padrão é @code{('/', '/RPC2')}.
@end deffn

@menu
* Exemplo de SimpleXMLRPCServer:: 

@end menu

@node Exemplo de SimpleXMLRPCServer,,,Objetos de SimpleXMLRPCServer
@anchor{library/xmlrpc server id1}@anchor{3e69}@anchor{library/xmlrpc server simplexmlrpcserver-example}@anchor{3e5c}
@subsubsection Exemplo de SimpleXMLRPCServer


Código do servidor:

@example
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# Restringe a um caminho em particular.
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# Cria o servidor
with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Registra uma função pow(); isso vai usar o valor de
    # pow.__name__ como o nome, que é apenas 'pow'.
    server.register_function(pow)

    # Registra uma função sob um nome diferente
    def adder_function(x, y):
        return x + y
    server.register_function(adder_function, 'add')

    # Registra uma instância; todos os métodos da instância
    # são publicados como métodos XML-RPC (neste caso,
    # apenas 'mul').
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # Executa o laço principal do servidor
    server.serve_forever()
@end example

O código do cliente a seguir chamará os métodos disponibilizados pelo 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

# Exibe uma lista dos métodos disponíveis
print(s.system.listMethods())
@end example

@code{register_function()} também pode ser usado como um decorador. O exemplo anterior do servidor pode registrar funções com um 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()

    # Registra a função pow(); isso vai usar o valor de
    # pow.__name__ como o nome, que é apenas 'pow'.
    server.register_function(pow)

    # Registra uma função sob um nome diferente, usando
    # register_function como um decorador. *name* só pode
    # ser dado como um argumento nomeado.
    @@server.register_function(name='add')
    def adder_function(x, y):
        return x + y

    # Registra uma função sob function.__name__.
    @@server.register_function
    def mul(x, y):
        return x * y

    server.serve_forever()
@end example

O exemplo a seguir, incluído no módulo @code{Lib/xmlrpc/server.py}, mostra um servidor que permite nomes com pontos e registra uma função de várias chamadas.

@cartouche
@quotation Aviso 
A ativação da opção `allow_dotted_names' permite que os invasores acessem as variáveis globais do seu módulo e podem permitir que os invasores executem códigos arbitrários em sua máquina. Use este exemplo apenas em uma rede fechada e 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 demonstração ExampleService pode ser chamada na linha de comando:

@example
python -m xmlrpc.server
@end example

O cliente que interage com o servidor acima está incluído em @code{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 interage com o servidor XMLRPC de demonstração pode ser chamado como:

@example
python -m xmlrpc.client
@end example

@node CGIXMLRPCRequestHandler,Documentando servidor XMLRPC,Objetos de SimpleXMLRPCServer,xmlrpc server — Servidores XML-RPC básicos
@anchor{library/xmlrpc server cgixmlrpcrequesthandler}@anchor{3e6a}
@subsubsection CGIXMLRPCRequestHandler


A classe @ref{3e61,,CGIXMLRPCRequestHandler} pode ser usada para manipular solicitações XML-RPC enviadas para scripts CGI Python.

@geindex register_function() (método xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_function}@anchor{3e6b}
@deffn {Método} CGIXMLRPCRequestHandler.register_function (function=None, name=None)

Registra uma função que possa responder às solicitações XML-RPC. Se `name' for fornecido, será o nome do método associado a `function', caso contrário, @ref{1317,,function.__name__} será usado. `name' é uma string e pode conter caracteres ilegais para identificadores Python, incluindo o caractere de ponto.

Este método também pode ser usado como um decorador. Quando usado como decorador, `name' só pode ser fornecido como argumento nomeado para registrar `function' em `name'. Se nenhum `name' for fornecido, @ref{1317,,function.__name__} será usado.


Alterado na versão 3.7: @ref{3e6b,,register_function()} pode ser usado como um decorador.

@end deffn

@geindex register_instance() (método xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_instance}@anchor{3e6c}
@deffn {Método} CGIXMLRPCRequestHandler.register_instance (instance)

Registra um objeto que é usado para expor nomes de métodos que não foram registrados usando @ref{3e6b,,register_function()}. Se a instância contiver um método @code{_dispatch()}, ela será chamada com o nome do método solicitado e os parâmetros da solicitação; o valor retornado é retornado ao cliente como resultado. Se a instância não tiver um método @code{_dispatch()}, será procurado um atributo correspondente ao nome do método solicitado; se o nome do método solicitado contiver pontos, cada componente do nome do método será pesquisado individualmente, com o efeito de que uma pesquisa hierárquica simples é executada. O valor encontrado nessa pesquisa é chamado com os parâmetros da solicitação e o valor retornado é passado de volta ao cliente.
@end deffn

@geindex register_introspection_functions() (método xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_introspection_functions}@anchor{3e6d}
@deffn {Método} CGIXMLRPCRequestHandler.register_introspection_functions ()

Registra as funções de introspecção XML-RPC @code{system.listMethods}, @code{system.methodHelp} e @code{system.methodSignature}.
@end deffn

@geindex register_multicall_functions() (método xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_multicall_functions}@anchor{3e6e}
@deffn {Método} CGIXMLRPCRequestHandler.register_multicall_functions ()

Registra a função de multichamada XML-RPC @code{system.multicall}.
@end deffn

@geindex handle_request() (método xmlrpc.server.CGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler handle_request}@anchor{3e6f}
@deffn {Método} CGIXMLRPCRequestHandler.handle_request (request_text=None)

Manipula uma solicitação XML-RPC. Se `request_text' for fornecido, devem ser os dados POST fornecidos pelo servidor HTTP, caso contrário, o conteúdo do stdin será usado.
@end deffn

Exemplo:

@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 servidor XMLRPC,Objetos de DocXMLRPCServer,CGIXMLRPCRequestHandler,xmlrpc server — Servidores XML-RPC básicos
@anchor{library/xmlrpc server documenting-xmlrpc-server}@anchor{3e70}
@subsubsection Documentando servidor XMLRPC


Essas classes estendem as classes acima para servir a documentação HTML em resposta a solicitações HTTP GET. Os servidores podem ser independentes, usando @ref{1b35,,DocXMLRPCServer} ou incorporados em um ambiente CGI, usando @ref{3e71,,DocCGIXMLRPCRequestHandler}.

@geindex DocXMLRPCServer (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer}@anchor{1b35}
@deffn {Classe} xmlrpc.server.DocXMLRPCServer (addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

Cria uma nova instância do servidor. Todos os parâmetros têm o mesmo significado que para @ref{3e60,,SimpleXMLRPCServer}; `requestHandler' assume como padrão @ref{3e72,,DocXMLRPCRequestHandler}.


Alterado na versão 3.3: O sinalizador `use_builtin_types' foi adicionado.

@end deffn

@geindex DocCGIXMLRPCRequestHandler (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler}@anchor{3e71}
@deffn {Classe} xmlrpc.server.DocCGIXMLRPCRequestHandler

Cria uma nova instância para manipular solicitações XML-RPC em um ambiente CGI.
@end deffn

@geindex DocXMLRPCRequestHandler (classe em xmlrpc.server)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCRequestHandler}@anchor{3e72}
@deffn {Classe} xmlrpc.server.DocXMLRPCRequestHandler

Cria uma nova instância do manipulador de solicitações. Este manipulador de solicitações possui suporte a solicitações POST de XML-RPC, documenta solicitações GET e modifica o registro para que o parâmetro `logRequests' no parâmetro @ref{1b35,,DocXMLRPCServer} seja respeitado.
@end deffn

@node Objetos de DocXMLRPCServer,DocCGIXMLRPCRequestHandler,Documentando servidor XMLRPC,xmlrpc server — Servidores XML-RPC básicos
@anchor{library/xmlrpc server doc-xmlrpc-servers}@anchor{3e73}@anchor{library/xmlrpc server docxmlrpcserver-objects}@anchor{3e74}
@subsubsection Objetos de DocXMLRPCServer


A classe @ref{1b35,,DocXMLRPCServer} é derivada de @ref{3e60,,SimpleXMLRPCServer} e fornece um meio de criar servidores XML-RPC autodocumentados e independentes. Solicitações HTTP POST são tratadas como chamadas de método XML-RPC. As solicitações HTTP GET são tratadas gerando documentação HTML no estilo pydoc. Isso permite que um servidor forneça sua própria documentação baseada na Web.

@geindex set_server_title() (método xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_title}@anchor{3e75}
@deffn {Método} DocXMLRPCServer.set_server_title (server_title)

Define o título usado na documentação HTML gerada. Este título será usado dentro do elemento “title” do HTML.
@end deffn

@geindex set_server_name() (método xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_name}@anchor{3e76}
@deffn {Método} DocXMLRPCServer.set_server_name (server_name)

Define o nome usado na documentação HTML gerada. Este nome aparecerá na parte superior da documentação gerada dentro de um elemento “h1”.
@end deffn

@geindex set_server_documentation() (método xmlrpc.server.DocXMLRPCServer)
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_documentation}@anchor{3e77}
@deffn {Método} DocXMLRPCServer.set_server_documentation (server_documentation)

Define a descrição usada na documentação HTML gerada. Esta descrição aparecerá na documentação como um parágrafo, abaixo do nome do servidor.
@end deffn

@node DocCGIXMLRPCRequestHandler,,Objetos de DocXMLRPCServer,xmlrpc server — Servidores XML-RPC básicos
@anchor{library/xmlrpc server doccgixmlrpcrequesthandler}@anchor{3e78}
@subsubsection DocCGIXMLRPCRequestHandler


A classe @ref{3e71,,DocCGIXMLRPCRequestHandler} é derivada de @ref{3e61,,CGIXMLRPCRequestHandler} e fornece um meio de criar scripts CGI XML-RPC autodocumentados. Solicitações HTTP POST são tratadas como chamadas de método XML-RPC. As solicitações HTTP GET são tratadas gerando documentação HTML no estilo pydoc. Isso permite que um servidor forneça sua própria documentação baseada na web.

@geindex set_server_title() (método xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_title}@anchor{3e79}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_title (server_title)

Define o título usado na documentação HTML gerada. Este título será usado dentro do elemento “title” do HTML.
@end deffn

@geindex set_server_name() (método xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_name}@anchor{3e7a}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_name (server_name)

Define o nome usado na documentação HTML gerada. Este nome aparecerá na parte superior da documentação gerada dentro de um elemento “h1”.
@end deffn

@geindex set_server_documentation() (método xmlrpc.server.DocCGIXMLRPCRequestHandler)
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_documentation}@anchor{3e7b}
@deffn {Método} DocCGIXMLRPCRequestHandler.set_server_documentation (server_documentation)

Define a descrição usada na documentação HTML gerada. Esta descrição aparecerá na documentação como um parágrafo, abaixo do nome do servidor.
@end deffn

@node ipaddress — Biblioteca de manipulação de IPv4/IPv6,,xmlrpc server — Servidores XML-RPC básicos,Protocolos de Internet e Suporte
@anchor{library/ipaddress doc}@anchor{3e7c}@anchor{library/ipaddress ipaddress-ipv4-ipv6-manipulation-library}@anchor{3e7d}@anchor{library/ipaddress module-ipaddress}@anchor{80}@anchor{library/ipaddress translation-repo}@anchor{3e7e}
@subsection @code{ipaddress} — Biblioteca de manipulação de IPv4/IPv6


@geindex module; ipaddress

`Código-fonte:' Lib/ipaddress.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/ipaddress.py}


__________________________________________________________________


@ref{80,,ipaddress} fornece recursos para criar, manipular e operar em endereços e redes IPv4 e IPv6.

As funções e classes neste módulo facilitam o tratamento de várias tarefas relacionadas a endereços IP, incluindo verificar se dois hosts estão ou não na mesma sub-rede, iterar sobre todos os hosts em uma sub-rede específica, verificar se uma string representa ou não um valor válido. Endereço IP ou definição de rede e assim por diante.

Esta é a referência completa da API do módulo – para uma visão geral e introdução, consulte @ref{3e7f,,Uma introdução ao módulo ipaddress}.


Adicionado na versão 3.3.


@c import ipaddress
@c from ipaddress import (
@c     ip_network, IPv4Address, IPv4Interface, IPv4Network,
@c )

@menu
* Funções de fábrica de conveniência:: 
* Endereços IP:: 
* Definições de rede IP:: 
* Objetos de interface:: 
* Outras funções de nível de módulo:: 
* Exceções personalizadas:: 

@end menu

@node Funções de fábrica de conveniência,Endereços IP,,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress convenience-factory-functions}@anchor{3e80}
@subsubsection Funções de fábrica de conveniência


O módulo @ref{80,,ipaddress} fornece funções de fábrica para criar endereços IP, redes e interfaces de forma conveniente:

@geindex ip_address() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_address}@anchor{3e81}
@deffn {Função} ipaddress.ip_address (address)

Retorna um objeto @ref{1fc,,IPv4Address} ou @ref{1fd,,IPv6Address} dependendo do endereço IP passado como argumento.  Podem ser fornecidos endereços IPv4 ou IPv6;  números inteiros menores que @code{2**32} serão considerados IPv4 por padrão. Uma exceção @ref{202,,ValueError} é levantada se `address' não representar um endereço IPv4 ou IPv6 válido.

@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() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_network}@anchor{3e82}
@deffn {Função} ipaddress.ip_network (address, strict=True)

Retorna um objeto @ref{1fe,,IPv4Network} ou @ref{1ff,,IPv6Network} dependendo do endereço IP passado como argumento. `address' é uma string ou número inteiro que representa a rede IP. Podem ser fornecidas redes IPv4 ou IPv6; números inteiros menores que @code{2**32} serão considerados IPv4 por padrão. `strict' é passado para o construtor @ref{1fe,,IPv4Network} ou @ref{1ff,,IPv6Network}. Uma exceção @ref{202,,ValueError} é levantada se `address' não representar um endereço IPv4 ou IPv6 válido, ou se a rede tiver bits de host configurados.

@example
>>> ipaddress.ip_network('192.168.0.0/28')
IPv4Network('192.168.0.0/28')
@end example
@end deffn

@geindex ip_interface() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress ip_interface}@anchor{3e83}
@deffn {Função} ipaddress.ip_interface (address)

Retorna um objeto @ref{1924,,IPv4Interface} ou @ref{1925,,IPv6Interface} dependendo do endereço IP passado como argumento.  `address' é uma string ou um inteiro representando o endereço IP. Podem ser fornecidos endereços IPv4 ou IPv6;  números inteiros menores que @code{2**32} serão considerados IPv4 por padrão. Uma exceção @ref{202,,ValueError} é levantada se `address' não representar um endereço IPv4 ou IPv6 válido.
@end deffn

Uma desvantagem dessas funções de conveniência é que a necessidade de lidar com os formatos IPv4 e IPv6 significa que as mensagens de erro fornecem informações mínimas sobre o erro exato, pois as funções não sabem se o formato IPv4 ou IPv6 foi pretendido. Relatórios de erros mais detalhados podem ser obtidos chamando diretamente os construtores de classe específicos da versão apropriada.

@node Endereços IP,Definições de rede IP,Funções de fábrica de conveniência,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress ip-addresses}@anchor{3e84}
@subsubsection Endereços IP


@menu
* Objetos de endereço:: 
* Conversão para strings e inteiros:: 
* Operadores: Operadores<3>. 

@end menu

@node Objetos de endereço,Conversão para strings e inteiros,,Endereços IP
@anchor{library/ipaddress address-objects}@anchor{3e85}
@subsubsection Objetos de endereço


Os objetos @ref{1fc,,IPv4Address} e @ref{1fd,,IPv6Address} compartilham muitos atributos comuns. Alguns atributos que são significativos apenas para endereços IPv6 também são implementados por objetos @ref{1fc,,IPv4Address}, para facilitar a escrita de código que lide corretamente com ambas as versões de IP. Os objetos de endereço são @ref{610,,hasheáveis}, portanto podem ser usados como chaves em dicionários.

@geindex IPv4Address (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv4Address}@anchor{1fc}
@deffn {Classe} ipaddress.IPv4Address (address)

Constrói um endereço IPv4. Uma exceção @ref{3e86,,AddressValueError} é levantada se `address' não for um endereço IPv4 válido.

O seguinte constitui um endereço IPv4 válido:


@enumerate 

@item 
Uma string em notação decimal por ponto, consistindo de quatro inteiros decimais em um intervalo inclusivo 0–255 separado por pontos (e.g. @code{192.168.0.1}). Cada inteiro representa um octeto (byte) no endereço. Zeros à esquerda não são tolerados para evitar confusão com notação octal.

@item 
Um inteiro que cabe em 32 bits.

@item 
Um inteiro compactado em um objeto @ref{1c2,,bytes} de comprimento 4 (octeto mais significativo primeiro).
@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


Alterado na versão 3.8: Zeros à esquerda são tolerados, mesmo em casos ambíguos que se parecem com notação octal.



Alterado na versão 3.9.5: Zeros à esquerda não são mais tolerados e são tratados como um erro. As strings de endereço IPv4 agora são analisadas de forma tão estrita quanto glibc @ref{969,,inet_pton()}.


@geindex version (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address version}@anchor{3e87}
@deffn {Atributo} version

O número de versão apropriado: @code{4} para IPv4, @code{6} para IPv6.
@end deffn

@geindex max_prefixlen (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address max_prefixlen}@anchor{3e88}
@deffn {Atributo} max_prefixlen

O número total de bits na representação de endereço para esta versão: @code{32} para IPv4, @code{128} para IPv6.

O prefixo define o número de bits iniciais em um endereço que são comparados para determinar se um endereço faz ou não parte de uma rede.
@end deffn

@geindex compressed (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address compressed}@anchor{3e89}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address exploded}@anchor{3e8a}
@deffn {Atributo} exploded

A representação de string em notação decimal pontilhada. Zeros à esquerda nunca são incluídos na representação.

Como o IPv4 não define uma notação abreviada para endereços com octetos definidos como zero, esses dois atributos são sempre iguais a @code{str(addr)} para endereços IPv4. A exposição desses atributos facilita a gravação de código de exibição que pode tratar endereços IPv4 e IPv6.
@end deffn

@geindex packed (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address packed}@anchor{3e8b}
@deffn {Atributo} packed

A representação binária deste endereço – um objeto @ref{1c2,,bytes} de comprimento apropriado (primeiro o octeto mais significativo). São 4 bytes para IPv4 e 16 bytes para IPv6.
@end deffn

@geindex reverse_pointer (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address reverse_pointer}@anchor{e4b}
@deffn {Atributo} reverse_pointer

O nome do registro PTR de DNS reverso para o endereço IP, por exemplo:

@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 é o nome que pode ser usado para realizar uma pesquisa PTR, não o nome do host resolvido em si.


Adicionado na versão 3.5.

@end deffn

@geindex is_multicast (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_multicast}@anchor{3e8c}
@deffn {Atributo} is_multicast

@code{True} se o endereço estiver reservado para uso multicast. Consulte 
@geindex RFC; RFC 3171
RFC 3171@footnote{https://datatracker.ietf.org/doc/html/rfc3171.html} (para IPv4) ou 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_private (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_private}@anchor{173a}
@deffn {Atributo} is_private

@code{True} se o endereço for definido como não acessível globalmente por iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (para IPv4) ou iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml} (para IPv6) com as seguintes exceções:


@itemize *

@item 
@code{is_private} é @code{False} para o espaço de endereço compartilhado (@code{100.64.0.0/10})

@item 
Para endereços IPv6 mapeados em IPv4, o valor @code{is_private} é determinado pela semântica dos endereços IPv4 subjacentes e a seguinte condição é válida (consulte @ref{3e8d,,IPv6Address.ipv4_mapped}):

@example
address.is_private == address.ipv4_mapped.is_private
@end example
@end itemize

@code{is_private} tem valor oposto a @ref{f93,,is_global}, exceto para o espaço de endereço compartilhado (intervalo @code{100.64.0.0/10}) onde ambos são @code{False}.


Alterado na versão 3.13: Corrigidos alguns falsos positivos e falsos negativos.


@itemize *

@item 
@code{192.0.0.0/24} é considerado privado com exceção de @code{192.0.0.9/32} e @code{192.0.0.10/32} (anteriormente: apenas o sub-intervalo @code{192.0.0.0/29} foi considerado privado).

@item 
@code{64:ff9b:1::/48} é considerado privado.

@item 
@code{2002::/16} é considerado privado.

@item 
Existem exceções em @code{2001::/23} (de outra forma considerado privado): @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}. As exceções não são consideradas privadas.
@end itemize

@end deffn

@geindex is_global (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_global}@anchor{f93}
@deffn {Atributo} is_global

@code{True} se o endereço for definido como não acessível globalmente por iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (para IPv4) ou iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml} (para IPv6) com a seguinte exceção:

Para endereços IPv6 mapeados em IPv4, o valor @code{is_private} é determinado pela semântica dos endereços IPv4 subjacentes e a seguinte condição é válida (consulte @ref{3e8d,,IPv6Address.ipv4_mapped}):

@example
address.is_global == address.ipv4_mapped.is_global
@end example

@code{is_global} tem valor oposto a @ref{173a,,is_private}, exceto para o espaço de endereço compartilhado (intervalo @code{100.64.0.0/10}) onde ambos são @code{False}.


Adicionado na versão 3.4.



Alterado na versão 3.13: Corrigidos alguns falsos positivos e falsos negativos, veja @ref{173a,,is_private} para detalhes.

@end deffn

@geindex is_unspecified (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_unspecified}@anchor{3e8e}
@deffn {Atributo} is_unspecified

@code{True} se o endereço não estiver especificado. Consulte 
@geindex RFC; RFC 5735
RFC 5735@footnote{https://datatracker.ietf.org/doc/html/rfc5735.html} (para IPv4) ou 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_reserved (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_reserved}@anchor{3e8f}
@deffn {Atributo} is_reserved

@code{True} se o endereço for indicado como reservado pela IETF. Para IPv4, este é apenas @code{240.0.0.0/4}, o bloco de endereços @code{Reserved}. Para IPv6, este é todos os endereços alocados@footnote{https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml} como @code{Reserved by IETF} para uso futuro.

@cartouche
@quotation Nota 
Para IPv4, @code{is_reserved} não está relacionado ao valor do bloco de endereço da coluna @code{Reserved-by-Protocol} em iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml}.
@end quotation
@end cartouche

@cartouche
@quotation Cuidado 
Para IPv6, @code{fec0::/10} um antigo prefixo de endereço de escopo Site-Local está atualmente excluído dessa lista (veja @ref{3e90,,is_site_local} & 
@geindex RFC; RFC 3879
RFC 3879@footnote{https://datatracker.ietf.org/doc/html/rfc3879.html}).
@end quotation
@end cartouche
@end deffn

@geindex is_loopback (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_loopback}@anchor{3e91}
@deffn {Atributo} is_loopback

@code{True} se este for um endereço de loopack. Consulte 
@geindex RFC; RFC 3330
RFC 3330@footnote{https://datatracker.ietf.org/doc/html/rfc3330.html} (para IPv4) ou 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (para IPv6).
@end deffn

@geindex is_link_local (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address is_link_local}@anchor{3e92}
@deffn {Atributo} is_link_local

@code{True} se o endereço está reservado para uso de link local. Veja: 
@geindex RFC; RFC 3927
RFC 3927@footnote{https://datatracker.ietf.org/doc/html/rfc3927.html}.
@end deffn

@geindex ipv6_mapped (atributo ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address ipv6_mapped}@anchor{1fb}
@deffn {Atributo} ipv6_mapped

Objeto @ref{1fc,,IPv4Address} representando o endereço IPv6 mapeado para IPv6. Veja 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html}.


Adicionado na versão 3.13.

@end deffn
@end deffn

@geindex __format__() (método ipaddress.IPv4Address)
@anchor{library/ipaddress ipaddress IPv4Address __format__}@anchor{3e93}
@deffn {Método} IPv4Address.__format__ (fmt)

Retorna a representação string do endereço de IP, controlado por uma string de formato explícito. `fmt' pode ser um dos seguintes: @code{'s'}, a opção padrão, equivalente à @ref{44c,,str()}, @code{'b'} para uma string binária preenchida com zeros, @code{'X'} ou @code{'x'} para uma representação hexadecimal maiúscula ou minúscula, ou @code{'n'}, que equivale a @code{'b'} para endereços IPv4 e @code{'x'} para IPv6. Para representações binárias e hexadecimais, o especificador de forma @code{'#'} e a opção de agrupamento @code{'_'} estão disponíveis. @code{__format__} é utilizado por @code{format}, @code{str.format} e 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


Adicionado na versão 3.9.

@end deffn

@geindex IPv6Address (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv6Address}@anchor{1fd}
@deffn {Classe} ipaddress.IPv6Address (address)

Constrói um endereço IPv6. Uma exceção @ref{3e86,,AddressValueError} é levantada se `address' não for um endereço IPv6 válido.

O seguinte constitui um endereço IPv6 válido:


@enumerate 

@item 
Uma string constituída de oito grupos de quatro dígitos hexadecimais, cada grupo representando 16 bits. Os grupos são separados por dois pontos. Isto descreve uma notação `explodida' (longa); A string também pode ser `compactada' (notação curta) por vários meios. Ver 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} para detalhes. Por exemplo, @code{"0000:0000:0000:0000:0000:0abc:0007:0def"} pode ser compactada para @code{"::abc:7:def"}.

Opcionalmente, a string pode ter um ID de escopo de zona, expressado por um sufixo @code{%scope_id}. Se presente, o ID de escopo deve ser não vazio, e pode não conter @code{%}. Ver 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html} para detalhes. Por exemplo, @code{fe80::1234%1} pode identificar o endereço @code{fe80::1234} no primeiro link do nó.

@item 
Um inteiro que cabe em 128 bits.

@item 
Um inteiro compactado em um objeto @ref{1c2,,bytes} de comprimento 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 ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address compressed}@anchor{3e94}
@deffn {Atributo} compressed
@end deffn

A forma curta da representação do endereço, com zeros à esquerda em grupos omitidos e a sequência mais longa de grupos consistida inteiramente por zeros colapsada em um grupo vazio único.

Este também é o valor retornado por @code{str(addr)} para endereços IPv6.

@geindex exploded (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address exploded}@anchor{3e95}
@deffn {Atributo} exploded
@end deffn

A forma longa da representação do endereço, com todos zeros à esquerda em grupos consistindo inteiramente de zeros incluídos.

Para os seguintes atributos e métodos, veja a documentação correspondente para a classe @ref{1fc,,IPv4Address}:

@geindex packed (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address packed}@anchor{3e96}
@deffn {Atributo} packed
@end deffn

@geindex reverse_pointer (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address reverse_pointer}@anchor{16bf}
@deffn {Atributo} reverse_pointer
@end deffn

@geindex version (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address version}@anchor{3e97}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address max_prefixlen}@anchor{3e98}
@deffn {Atributo} max_prefixlen
@end deffn

@geindex is_multicast (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_multicast}@anchor{3e99}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_private}@anchor{173b}
@deffn {Atributo} is_private
@end deffn

@geindex is_global (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_global}@anchor{173c}
@deffn {Atributo} is_global


Adicionado na versão 3.4.

@end deffn

@geindex is_unspecified (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_unspecified}@anchor{3e9a}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_reserved}@anchor{3e9b}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_loopback}@anchor{1720}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_link_local}@anchor{3e9c}
@deffn {Atributo} is_link_local
@end deffn

@geindex is_site_local (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address is_site_local}@anchor{3e90}
@deffn {Atributo} is_site_local

@code{True} se o endereço estiver reservado para uso local do site. Observe que o espaço de endereço local do site foi descontinuado pelo 
@geindex RFC; RFC 3879
RFC 3879@footnote{https://datatracker.ietf.org/doc/html/rfc3879.html}. Use @ref{173a,,is_private} para testar se este endereço está no espaço de endereços locais exclusivos conforme definido pelo 
@geindex RFC; RFC 4193
RFC 4193@footnote{https://datatracker.ietf.org/doc/html/rfc4193.html}.
@end deffn

@geindex ipv4_mapped (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address ipv4_mapped}@anchor{3e8d}
@deffn {Atributo} ipv4_mapped

Para endereços que parecem ser endereços mapeados IPv4 (começando com @code{::FFFF/96}), esta propriedade reportará o endereço IPv4 incorporado. Para qualquer outro endereço, esta propriedade será @code{None}.
@end deffn

@geindex scope_id (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address scope_id}@anchor{914}
@deffn {Atributo} scope_id

Para endereços com escopo definido pelo 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html}, esta propriedade identifica a zona específica do escopo do endereço à qual o endereço pertence, como uma string. Quando nenhuma zona de escopo for especificada, esta propriedade será @code{None}.
@end deffn

@geindex sixtofour (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address sixtofour}@anchor{3e9d}
@deffn {Atributo} sixtofour

Para endereços que parecem ser endereços 6to4 (começando com @code{2002::/16}), como definido pelo 
@geindex RFC; RFC 3056
RFC 3056@footnote{https://datatracker.ietf.org/doc/html/rfc3056.html}, esta propriedade reportará o endereço IPv4 incorporado. Para qualquer outro endereço, esta propriedade será @code{None}.
@end deffn

@geindex teredo (atributo ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address teredo}@anchor{3e9e}
@deffn {Atributo} teredo

Para endereços que parecem ser endereços Teredo (começando com @code{2001::/32}), como definido pelo 
@geindex RFC; RFC 4380
RFC 4380@footnote{https://datatracker.ietf.org/doc/html/rfc4380.html}, esta propriedade reportará o par de endereços @code{(server, client)} incorporado. Para qualquer outro endereço, esta propriedade será @code{None}.
@end deffn
@end deffn

@geindex __format__() (método ipaddress.IPv6Address)
@anchor{library/ipaddress ipaddress IPv6Address __format__}@anchor{3e9f}
@deffn {Método} IPv6Address.__format__ (fmt)

Consulte a documentação do método correspondente em @ref{1fc,,IPv4Address}.


Adicionado na versão 3.9.

@end deffn

@node Conversão para strings e inteiros,Operadores<3>,Objetos de endereço,Endereços IP
@anchor{library/ipaddress conversion-to-strings-and-integers}@anchor{3ea0}
@subsubsection Conversão para strings e inteiros


Para interoperar com interfaces de rede, como o módulo de soquete, os endereços devem ser convertidos em strings ou inteiros. Isso é tratado usando as funções internas @ref{44c,,str()} e @ref{257,,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

Observe que os endereços com escopo IPv6 são convertidos em números inteiros sem ID de zona de escopo.

@node Operadores<3>,,Conversão para strings e inteiros,Endereços IP
@anchor{library/ipaddress operators}@anchor{3ea1}
@subsubsection Operadores


Os objetos de endereço têm suporte a alguns operadores. Salvo indicação em contrário, os operadores só podem ser aplicados entre objetos compatíveis (ou seja, IPv4 com IPv4, IPv6 com IPv6).

@menu
* Operadores de comparação:: 
* Operadores aritméticos:: 

@end menu

@node Operadores de comparação,Operadores aritméticos,,Operadores<3>
@anchor{library/ipaddress comparison-operators}@anchor{3ea2}
@subsubsection Operadores de comparação


Os objetos de endereço podem ser comparados com o conjunto usual de operadores de comparação. Os mesmos endereços IPv6 com IDs de zona de escopo diferentes não são iguais. Alguns exemplos:

@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 comparação,Operadores<3>
@anchor{library/ipaddress arithmetic-operators}@anchor{3ea3}
@subsubsection Operadores aritméticos


Inteiros podem ser adicionados ou subtraídos de objetos de endereço. Alguns exemplos:

@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 Definições de rede IP,Objetos de interface,Endereços IP,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress ip-network-definitions}@anchor{3ea4}
@subsubsection Definições de rede IP


Os objetos @ref{1fe,,IPv4Network} e @ref{1ff,,IPv6Network} fornecem um mecanismo para definir e inspecionar definições de rede IP. Uma definição de rede consiste em uma `máscara' e um `endereço de rede' e, como tal, define um intervalo de endereços IP que é igual ao endereço de rede quando mascarado (E binário) com a máscara. Por exemplo, uma definição de rede com a máscara @code{255.255.255.0} e o endereço de rede @code{192.168.1.0} consiste em endereços IP no intervalo inclusivo @code{192.168.1.0} a @code{192.168.1.255}.

@menu
* Prefixo@comma{} máscara de rede e máscara de host: Prefixo máscara de rede e máscara de host. 
* Objetos de rede:: 
* Operadores: Operadores<4>. 

@end menu

@node Prefixo máscara de rede e máscara de host,Objetos de rede,,Definições de rede IP
@anchor{library/ipaddress prefix-net-mask-and-host-mask}@anchor{3ea5}
@subsubsection Prefixo, máscara de rede e máscara de host


Existem várias maneiras equivalentes de especificar máscaras de rede IP. Um `prefixo' @code{/<nbits>} é uma notação que denota quantos bits de ordem superior estão definidos na máscara de rede. Uma máscara de rede, ou `netmask', é um endereço IP com um certo número de bits de alta ordem definidos. Assim o prefixo @code{/24} é equivalente à máscara de rede @code{255.255.255.0} em IPv4, ou @code{ffff:ff00::} em IPv6. Além disso, uma máscara de host, ou `host mask', é o inverso lógico de uma máscara de rede e às vezes é usada (por exemplo, nas listas de controle de acesso da Cisco) para denotar uma máscara de rede. A máscara de host equivalente a @code{/24} em IPv4 é @code{0.0.0.255}.

@node Objetos de rede,Operadores<4>,Prefixo máscara de rede e máscara de host,Definições de rede IP
@anchor{library/ipaddress network-objects}@anchor{3ea6}
@subsubsection Objetos de rede


Todos os atributos implementados por objetos de endereço também são implementados por objetos de rede. Além disso, os objetos de rede implementam atributos adicionais. Todos estes são comuns entre @ref{1fe,,IPv4Network} e @ref{1ff,,IPv6Network}, portanto, para evitar duplicação, eles são documentados apenas para @ref{1fe,,IPv4Network}. Objetos de rede são @ref{610,,hasheáveis}, portanto podem ser usados como chaves em dicionários.

@geindex IPv4Network (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv4Network}@anchor{1fe}
@deffn {Classe} ipaddress.IPv4Network (address, strict=True)

Constrói uma definição de rede IPv4. `address' pode ser um dos seguintes:


@enumerate 

@item 
Uma string que consiste em um endereço IP e uma máscara opcional, separados por uma barra (@code{/}). O endereço IP é o endereço de rede, e a máscara pode ser um único número, o que significa que é um `prefixo', ou uma representação de string de um endereço IPv4. Se for o último, a máscara será interpretada como uma `máscara de rede' se começar com um campo diferente de zero, ou como uma `máscara de host' se começar com um campo zero, com a única exceção de uma máscara totalmente zero que é tratada como uma `máscara de rede'. Se nenhuma máscara for fornecida, será considerada @code{/32}.

Por exemplo, as seguintes especificações de `address' são equivalentes: @code{192.168.1.0/24}, @code{192.168.1.0/255.255.255.0} e @code{192.168.1.0/0.0.0.255}.

@item 
Um número inteiro que cabe em 32 bits. Isto é equivalente a uma rede de endereço único, com o endereço de rede sendo `address' e a máscara sendo @code{/32}.

@item 
Um inteiro compactado em um objeto @ref{1c2,,bytes} de comprimento 4, big-endian. A interpretação é semelhante a um `address' no formato inteiro.

@item 
Uma tupla de dois elementos de uma descrição de endereço e uma máscara de rede, onde a descrição do endereço é uma string, um número inteiro de 32 bits, um número inteiro compactado de 4 bytes ou um objeto IPv4Address existente; e a máscara de rede é um número inteiro que representa o comprimento do prefixo (por exemplo, @code{24}) ou uma string que representa a máscara do prefixo (por exemplo, @code{255.255.255.0}).
@end enumerate

Uma exceção @ref{3e86,,AddressValueError} é levantada se `address' não for um endereço IPv4 válido. Uma exceção @ref{3ea7,,NetmaskValueError} é levantada se a máscara não for válida para um endereço IPv4.

Se `strict' for @code{True} e os bits do host estiverem definidos no endereço fornecido, então @ref{202,,ValueError} será levantada. Caso contrário, os bits do host serão mascarados para determinar o endereço de rede apropriado.

Salvo indicação em contrário, todos os métodos de rede que aceitam outros objetos rede/endereço irão levantar @ref{2c3,,TypeError} se a versão IP do argumento for incompatível com @code{self}.


Alterado na versão 3.5: Adicionado o formulário de tupla de 2 elementos para o parâmetro do construtor `address'.


@geindex version (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network version}@anchor{3ea8}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network max_prefixlen}@anchor{3ea9}
@deffn {Atributo} max_prefixlen

Consulte a documentação do atributo correspondente em @ref{1fc,,IPv4Address}.
@end deffn

@geindex is_multicast (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_multicast}@anchor{3eaa}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_private}@anchor{3eab}
@deffn {Atributo} is_private
@end deffn

@geindex is_unspecified (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_unspecified}@anchor{3eac}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_reserved}@anchor{3ead}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_loopback}@anchor{3eae}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network is_link_local}@anchor{3eaf}
@deffn {Atributo} is_link_local

Esses atributos terão valor verdadeiro para a rede como um todo se forem verdadeiros tanto para o endereço de rede quanto para o endereço de broadcast.
@end deffn

@geindex network_address (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network network_address}@anchor{3eb0}
@deffn {Atributo} network_address

O endereço de rede da rede. O endereço de rede e o comprimento do prefixo juntos definem exclusivamente uma rede.
@end deffn

@geindex broadcast_address (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network broadcast_address}@anchor{3eb1}
@deffn {Atributo} broadcast_address

O endereço de broadcast da rede. Os pacotes enviados para o endereço de broadcast devem ser recebidos por todos os hosts da rede.
@end deffn

@geindex hostmask (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network hostmask}@anchor{3eb2}
@deffn {Atributo} hostmask

A máscara do host, como um objeto @ref{1fc,,IPv4Address}.
@end deffn

@geindex netmask (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network netmask}@anchor{3eb3}
@deffn {Atributo} netmask

A máscara de rede, como um objeto @ref{1fc,,IPv4Address}.
@end deffn

@geindex with_prefixlen (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_prefixlen}@anchor{3eb4}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex compressed (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network compressed}@anchor{3eb5}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network exploded}@anchor{3eb6}
@deffn {Atributo} exploded

Uma representação de string da rede, com a máscara em notação de prefixo.

@code{with_prefixlen} e @code{compressed} são sempre iguais a @code{str(network)}. @code{exploded} usa a forma explodida do endereço de rede.
@end deffn

@geindex with_netmask (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_netmask}@anchor{3eb7}
@deffn {Atributo} with_netmask

Uma representação em string da rede, com a máscara na notação de máscara de rede.
@end deffn

@geindex with_hostmask (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network with_hostmask}@anchor{3eb8}
@deffn {Atributo} with_hostmask

Uma representação de string da rede, com a máscara na notação de máscara de host.
@end deffn

@geindex num_addresses (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network num_addresses}@anchor{3eb9}
@deffn {Atributo} num_addresses

O número total de endereços na rede.
@end deffn

@geindex prefixlen (atributo ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network prefixlen}@anchor{3eba}
@deffn {Atributo} prefixlen

Comprimento do prefixo de rede, em bits.
@end deffn

@geindex hosts() (método ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network hosts}@anchor{15d1}
@deffn {Método} hosts ()

Retorna um iterador sobre os hosts utilizáveis na rede. Os hosts utilizáveis são todos os endereços IP que pertencem à rede, exceto o próprio endereço de rede e o endereço de transmissão da rede. Para redes com comprimento de máscara 31, o endereço de rede e o endereço de transmissão de rede também são incluídos no resultado. Redes com máscara 32 retornarão uma lista contendo o endereço de host único.

@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 ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network overlaps}@anchor{3ebb}
@deffn {Método} overlaps (other)

@code{True} se esta rede estiver parcial ou totalmente contida em `other' ou `other' estiver totalmente contida nesta rede.
@end deffn

@geindex address_exclude() (método ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network address_exclude}@anchor{3ebc}
@deffn {Método} address_exclude (network)

Calcula as definições de rede resultantes da remoção da `network' fornecida desta. Retorna um iterador de objetos de rede. Levanta @ref{202,,ValueError} se `network' não estiver completamente contida nesta rede.

@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 ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network subnets}@anchor{ecf}
@deffn {Método} subnets (prefixlen_diff=1, new_prefix=None)

As sub-redes que se unem para criar a definição de rede atual, dependendo dos valores dos argumentos. `prefixlen_diff' é o valor pelo qual o comprimento do nosso prefixo deve ser aumentado. `new_prefix' é o novo prefixo desejado das sub-redes; deve ser maior que nosso prefixo. Um, e apenas um, de `prefixlen_diff' e `new_prefix' deve ser definido. Retorna um iterador de objetos de rede.

@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 ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network supernet}@anchor{ed0}
@deffn {Método} supernet (prefixlen_diff=1, new_prefix=None)

As super-redes contendo esta definição de rede, dependendo dos valores dos argumentos. `prefixlen_diff' é o valor pelo qual o comprimento do nosso prefixo deve ser diminuída. `new_prefix' é o novo prefixo desejado da super-rede; deve ser maior que nosso prefixo. Um, e apenas um, de `prefixlen_diff' e `new_prefix' deve ser definido. Retorna um único objeto rede.

@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 ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network subnet_of}@anchor{3ebd}
@deffn {Método} subnet_of (other)

Retorna @code{True} se esta rede é uma sub-rede 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


Adicionado na versão 3.7.

@end deffn

@geindex supernet_of() (método ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network supernet_of}@anchor{3ebe}
@deffn {Método} supernet_of (other)

Retorna @code{True} se esta rede é uma super-rede 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


Adicionado na versão 3.7.

@end deffn

@geindex compare_networks() (método ipaddress.IPv4Network)
@anchor{library/ipaddress ipaddress IPv4Network compare_networks}@anchor{3ebf}
@deffn {Método} compare_networks (other)

Compara esta rede com `other'. Nesta comparação são considerados apenas os endereços de rede; bits de host não são. Retorna @code{-1}, @code{0} ou @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


Descontinuado desde a versão 3.7: Ele usa o mesmo algoritmo de ordenação e comparação que “<”, “==” e “>”

@end deffn
@end deffn

@geindex IPv6Network (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv6Network}@anchor{1ff}
@deffn {Classe} ipaddress.IPv6Network (address, strict=True)

Constrói uma definição de rede IPv6. `address' pode ser um dos seguintes:


@enumerate 

@item 
Uma string que consiste em um endereço IP e um comprimento de prefixo opcional, separados por uma barra (@code{/}). O endereço IP é o endereço de rede e o comprimento do prefixo deve ser um único número, o `prefixo'. Se nenhum comprimento de prefixo for fornecido, será considerado @code{/128}.

Observe que as máscaras de rede expandidas atualmente não são suportadas. Isso significa que @code{2001:db00::0/24} é um argumento válido enquanto @code{2001:db00::0/ffff:ff00::} não é.

@item 
Um número inteiro que cabe em 128 bits. Isto é equivalente a uma rede de endereço único, com o endereço de rede sendo `address' e a máscara sendo @code{/128}.

@item 
Um inteiro compactado em um objeto @ref{1c2,,bytes} de comprimento 16, big-endian. A interpretação é semelhante a um `address' no formato inteiro.

@item 
Uma tupla de dois elementos de uma descrição de endereço e uma máscara de rede, onde a descrição do endereço é uma string, um número inteiro de 128 bits, um número inteiro compactado de 16 bytes ou um objeto IPv6Address existente; e a máscara de rede é um número inteiro que representa o comprimento do prefixo.
@end enumerate

Uma exceção @ref{3e86,,AddressValueError} é levantada se `address' não for um endereço IPv6 válido. Uma exceção @ref{3ea7,,NetmaskValueError} é levantada se a máscara não for válida para um endereço IPv6.

Se `strict' for @code{True} e os bits do host estiverem definidos no endereço fornecido, então @ref{202,,ValueError} será levantada. Caso contrário, os bits do host serão mascarados para determinar o endereço de rede apropriado.


Alterado na versão 3.5: Adicionado o formulário de tupla de 2 elementos para o parâmetro do construtor `address'.


@geindex version (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network version}@anchor{3ec0}
@deffn {Atributo} version
@end deffn

@geindex max_prefixlen (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network max_prefixlen}@anchor{3ec1}
@deffn {Atributo} max_prefixlen
@end deffn

@geindex is_multicast (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_multicast}@anchor{3ec2}
@deffn {Atributo} is_multicast
@end deffn

@geindex is_private (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_private}@anchor{3ec3}
@deffn {Atributo} is_private
@end deffn

@geindex is_unspecified (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_unspecified}@anchor{3ec4}
@deffn {Atributo} is_unspecified
@end deffn

@geindex is_reserved (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_reserved}@anchor{3ec5}
@deffn {Atributo} is_reserved
@end deffn

@geindex is_loopback (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_loopback}@anchor{3ec6}
@deffn {Atributo} is_loopback
@end deffn

@geindex is_link_local (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_link_local}@anchor{3ec7}
@deffn {Atributo} is_link_local
@end deffn

@geindex network_address (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network network_address}@anchor{3ec8}
@deffn {Atributo} network_address
@end deffn

@geindex broadcast_address (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network broadcast_address}@anchor{3ec9}
@deffn {Atributo} broadcast_address
@end deffn

@geindex hostmask (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network hostmask}@anchor{3eca}
@deffn {Atributo} hostmask
@end deffn

@geindex netmask (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network netmask}@anchor{3ecb}
@deffn {Atributo} netmask
@end deffn

@geindex with_prefixlen (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_prefixlen}@anchor{3ecc}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex compressed (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network compressed}@anchor{3ecd}
@deffn {Atributo} compressed
@end deffn

@geindex exploded (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network exploded}@anchor{3ece}
@deffn {Atributo} exploded
@end deffn

@geindex with_netmask (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_netmask}@anchor{3ecf}
@deffn {Atributo} with_netmask
@end deffn

@geindex with_hostmask (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network with_hostmask}@anchor{3ed0}
@deffn {Atributo} with_hostmask
@end deffn

@geindex num_addresses (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network num_addresses}@anchor{3ed1}
@deffn {Atributo} num_addresses
@end deffn

@geindex prefixlen (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network prefixlen}@anchor{3ed2}
@deffn {Atributo} prefixlen
@end deffn

@geindex hosts() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network hosts}@anchor{15d2}
@deffn {Método} hosts ()

Retorna um iterador sobre os hosts utilizáveis na rede. Os hosts utilizáveis são todos os endereços IP que pertencem à rede, exceto o próprio endereço de anycast do roteador da sub-rede. Para redes com comprimento de máscara 127, o endereço anycast do roteador da sub-rede de rede é também incluído no resultado. Redes com máscara 128 retornarão uma lista contendo o endereço de host único.
@end deffn

@geindex overlaps() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network overlaps}@anchor{3ed3}
@deffn {Método} overlaps (other)
@end deffn

@geindex address_exclude() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network address_exclude}@anchor{3ed4}
@deffn {Método} address_exclude (network)
@end deffn

@geindex subnets() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network subnets}@anchor{3ed5}
@deffn {Método} subnets (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex supernet() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network supernet}@anchor{3ed6}
@deffn {Método} supernet (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex subnet_of() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network subnet_of}@anchor{3ed7}
@deffn {Método} subnet_of (other)
@end deffn

@geindex supernet_of() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network supernet_of}@anchor{3ed8}
@deffn {Método} supernet_of (other)
@end deffn

@geindex compare_networks() (método ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network compare_networks}@anchor{3ed9}
@deffn {Método} compare_networks (other)

Consulte a documentação do atributo correspondente em @ref{1fe,,IPv4Network}.
@end deffn

@geindex is_site_local (atributo ipaddress.IPv6Network)
@anchor{library/ipaddress ipaddress IPv6Network is_site_local}@anchor{3eda}
@deffn {Atributo} is_site_local

This atributo terá valor verdadeiro para a rede como um todo se for verdadeiro tanto para o endereço de rede quanto para o endereço de broadcast.
@end deffn
@end deffn

@node Operadores<4>,,Objetos de rede,Definições de rede IP
@anchor{library/ipaddress id1}@anchor{3edb}
@subsubsection Operadores


Os objetos de rede têm suporte a alguns operadores. Salvo indicação em contrário, os operadores só podem ser aplicados entre objetos compatíveis (ou seja, IPv4 com IPv4, IPv6 com IPv6).

@menu
* Operadores lógicos:: 
* Iteração:: 
* Redes como contêineres de endereços:: 

@end menu

@node Operadores lógicos,Iteração,,Operadores<4>
@anchor{library/ipaddress logical-operators}@anchor{3edc}
@subsubsection Operadores lógicos


Os objetos de rede podem ser comparados com o conjunto usual de operadores lógicos. Os objetos de rede são ordenados primeiro por endereço de rede e depois por máscara de rede.

@node Iteração,Redes como contêineres de endereços,Operadores lógicos,Operadores<4>
@anchor{library/ipaddress iteration}@anchor{3edd}
@subsubsection Iteração


Os objetos de rede podem ser iterados para listar todos os endereços pertencentes à rede. Para iteração, `todos' os hosts são retornados, incluindo os hosts inutilizáveis (para hosts utilizáveis, use o método @ref{15d1,,hosts()}). Um exemplo:

@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 contêineres de endereços,,Iteração,Operadores<4>
@anchor{library/ipaddress networks-as-containers-of-addresses}@anchor{3ede}
@subsubsection Redes como contêineres de endereços


Os objetos de rede podem atuar como contêineres de endereços. Alguns exemplos:

@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 interface,Outras funções de nível de módulo,Definições de rede IP,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress interface-objects}@anchor{3edf}
@subsubsection Objetos de interface


Os objetos de interface são @ref{610,,hasheáveis}, portanto podem ser usados como chaves em dicionários.

@geindex IPv4Interface (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv4Interface}@anchor{1924}
@deffn {Classe} ipaddress.IPv4Interface (address)

Constrói uma interface IPv4. O significado de `address' é o mesmo do construtor de @ref{1fe,,IPv4Network}, exceto que endereços de host arbitrários são sempre aceitos.

@ref{1924,,IPv4Interface} é uma subclasse de @ref{1fc,,IPv4Address}, portanto herda todos os atributos dessa classe. Além disso, os seguintes atributos estão disponíveis:

@geindex ip (atributo ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface ip}@anchor{3ee0}
@deffn {Atributo} ip

O endereço (@ref{1fc,,IPv4Address}) sem informações de rede.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.ip
IPv4Address('192.0.2.5')
@end example
@end deffn

@geindex network (atributo ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface network}@anchor{3ee1}
@deffn {Atributo} network

A rede (@ref{1fe,,IPv4Network}) à qual esta interface pertence.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.network
IPv4Network('192.0.2.0/24')
@end example
@end deffn

@geindex with_prefixlen (atributo ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_prefixlen}@anchor{3ee2}
@deffn {Atributo} with_prefixlen

Uma representação de string da interface com a máscara em notação de prefixo.

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_prefixlen
'192.0.2.5/24'
@end example
@end deffn

@geindex with_netmask (atributo ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_netmask}@anchor{3ee3}
@deffn {Atributo} with_netmask

Uma representação de string da interface com a rede como uma máscara de rede.

@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 ipaddress.IPv4Interface)
@anchor{library/ipaddress ipaddress IPv4Interface with_hostmask}@anchor{3ee4}
@deffn {Atributo} with_hostmask

Uma representação de string da interface com a rede como uma 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 (classe em ipaddress)
@anchor{library/ipaddress ipaddress IPv6Interface}@anchor{1925}
@deffn {Classe} ipaddress.IPv6Interface (address)

Constrói uma interface IPv6. O significado de `address' é o mesmo do construtor de @ref{1ff,,IPv6Network}, exceto que endereços de host arbitrários são sempre aceitos.

@ref{1925,,IPv6Interface} é uma subclasse de @ref{1fd,,IPv6Address}, portanto herda todos os atributos dessa classe. Além disso, os seguintes atributos estão disponíveis:

@geindex ip (atributo ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface ip}@anchor{3ee5}
@deffn {Atributo} ip
@end deffn

@geindex network (atributo ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface network}@anchor{3ee6}
@deffn {Atributo} network
@end deffn

@geindex with_prefixlen (atributo ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_prefixlen}@anchor{3ee7}
@deffn {Atributo} with_prefixlen
@end deffn

@geindex with_netmask (atributo ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_netmask}@anchor{3ee8}
@deffn {Atributo} with_netmask
@end deffn

@geindex with_hostmask (atributo ipaddress.IPv6Interface)
@anchor{library/ipaddress ipaddress IPv6Interface with_hostmask}@anchor{3ee9}
@deffn {Atributo} with_hostmask

Consulte a documentação do atributo correspondente em @ref{1924,,IPv4Interface}.
@end deffn
@end deffn

@menu
* Operadores: Operadores<5>. 

@end menu

@node Operadores<5>,,,Objetos de interface
@anchor{library/ipaddress id2}@anchor{3eea}
@subsubsection Operadores


Os objetos de interface têm suporte a alguns operadores. Salvo indicação em contrário, os operadores só podem ser aplicados entre objetos compatíveis (ou seja, IPv4 com IPv4, IPv6 com IPv6).

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

@end menu

@node Operadores lógicos<2>,,,Operadores<5>
@anchor{library/ipaddress id3}@anchor{3eeb}
@subsubsection Operadores lógicos


Os objetos de interface podem ser comparados com o conjunto usual de operadores lógicos.

Para comparação de igualdade (@code{==} e @code{!=}), tanto o endereço IP quanto a rede devem ser iguais para que os objetos sejam iguais. Uma interface não será igual a nenhum endereço ou objeto de rede.

Para ordenação (@code{<}, @code{>}, etc) as regras são diferentes. Objetos de interface e de endereço com a mesma versão IP podem ser comparados e os objetos de endereço sempre serão ordenados antes dos objetos de interface. Dois objetos de interface são primeiro comparados por suas redes e, se forem iguais, então por seus endereços IP.

@node Outras funções de nível de módulo,Exceções personalizadas,Objetos de interface,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress other-module-level-functions}@anchor{3eec}
@subsubsection Outras funções de nível de módulo


O módulo também fornece as seguintes funções de nível de módulo:

@geindex v4_int_to_packed() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress v4_int_to_packed}@anchor{3eed}
@deffn {Função} ipaddress.v4_int_to_packed (address)

Representa um endereço como 4 bytes compactados em ordem de rede (big-endian). `address' é uma representação inteira de um endereço IP IPv4. Uma exceção @ref{202,,ValueError} é levantada se o número inteiro for negativo ou muito grande para ser um endereço 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() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress v6_int_to_packed}@anchor{3eee}
@deffn {Função} ipaddress.v6_int_to_packed (address)

Representa um endereço como 16 bytes compactados em ordem de rede (big-endian). `address' é uma representação inteira de um endereço IP IPv6. Uma exceção @ref{202,,ValueError} é levantada se o número inteiro for negativo ou muito grande para ser um endereço IP IPv6.
@end deffn

@geindex summarize_address_range() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress summarize_address_range}@anchor{ed1}
@deffn {Função} ipaddress.summarize_address_range (first, last)

Retorna um iterador do intervalo de rede resumido, considerando o primeiro e o último endereço IP. `first' é o primeiro @ref{1fc,,IPv4Address} ou @ref{1fd,,IPv6Address} no intervalo e `last' é o último @ref{1fc,,IPv4Address} ou @ref{1fd,,IPv6Address} no intervalo. Uma exceção @ref{2c3,,TypeError} é levantada se `first' ou `last' não forem endereços IP ou não forem da mesma versão. Uma exceção @ref{202,,ValueError} é levantada se `last' não for maior que `first' ou se a versão do `first' endereço não for 4 ou 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() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress collapse_addresses}@anchor{ed2}
@deffn {Função} ipaddress.collapse_addresses (addresses)

Retorna um iterador dos objetos @ref{1fe,,IPv4Network} ou @ref{1ff,,IPv6Network} recolhidos. `addresses' é um @ref{1268,,iterável} de objetos @ref{1fe,,IPv4Network} ou @ref{1ff,,IPv6Network}. Uma exceção @ref{2c3,,TypeError} é levantada se `addresses' contiver objetos de versão mista.

@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() (no módulo ipaddress)
@anchor{library/ipaddress ipaddress get_mixed_type_key}@anchor{3eef}
@deffn {Função} ipaddress.get_mixed_type_key (obj)

Retorna uma chave adequada para ordenação entre redes e endereços. Os objetos de endereço e de rede não são ordenáveis por padrão; eles são fundamentalmente diferentes, então a expressão:

@example
IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')
@end example

não faz sentido. Porém, há alguns momentos em que você pode desejar que @ref{80,,ipaddress} os ordene de qualquer maneira. Se precisar fazer isso, você pode usar esta função como argumento `key' para @ref{be7,,sorted()}

`obj' é um objeto de rede ou de endereço.
@end deffn

@node Exceções personalizadas,,Outras funções de nível de módulo,ipaddress — Biblioteca de manipulação de IPv4/IPv6
@anchor{library/ipaddress custom-exceptions}@anchor{3ef0}
@subsubsection Exceções personalizadas


Para oferecer suporte a relatórios de erros mais específicos de construtores de classe, o módulo define as seguintes exceções:

@geindex AddressValueError
@anchor{library/ipaddress ipaddress AddressValueError}@anchor{3e86}
@deffn {Exceção} ipaddress.AddressValueError (ValueError)

Qualquer erro de valor relacionado ao endereço.
@end deffn

@geindex NetmaskValueError
@anchor{library/ipaddress ipaddress NetmaskValueError}@anchor{3ea7}
@deffn {Exceção} ipaddress.NetmaskValueError (ValueError)

Qualquer erro de valor relacionado à máscara de rede.
@end deffn

@node Serviços Multimídia,Internacionalização,Protocolos de Internet e Suporte,A Biblioteca Padrão do Python
@anchor{library/mm doc}@anchor{3ef1}@anchor{library/mm mmedia}@anchor{3ef2}@anchor{library/mm multimedia-services}@anchor{3ef3}@anchor{library/mm translation-repo}@anchor{3ef4}
@section Serviços Multimídia


Os módulos descritos neste capítulo implementam vários algoritmos ou interfaces que são bastante úteis em aplicações multimídia. Eles estão disponíveis a critério da instalação. Aqui está uma visão geral:

@menu
* wave — Read and write WAV files:: 
* colorsys — Conversões entre sistemas de cores:: 

@end menu

@node wave — Read and write WAV files,colorsys — Conversões entre sistemas de cores,,Serviços Multimídia
@anchor{library/wave doc}@anchor{3ef5}@anchor{library/wave module-wave}@anchor{113}@anchor{library/wave wave-read-and-write-wav-files}@anchor{3ef6}
@subsection @code{wave} — Read and write WAV files


@geindex module; wave

@c Documentations stolen from comments in file.

`Código-fonte:' Lib/wave.py@footnote{https://github.com/python/cpython/tree/3.13/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.


Alterado na versão 3.12: Support for @code{WAVE_FORMAT_EXTENSIBLE} headers was added, provided that the
extended format is @code{KSDATAFORMAT_SUBTYPE_PCM}.


The @ref{113,,wave} module defines the following function and exception:

@geindex open() (no módulo wave)
@anchor{library/wave wave open}@anchor{952}
@deffn {Função} wave.open (file, mode=None)

If `file' is a string, open the file by that name, otherwise treat it as a
file-like object.  `mode' can be:


@table @asis

@item @code{'rb'}

Modo somente para leitura.

@item @code{'wb'}

Modo somente para escrita.
@end table

Note that it does not allow read/write WAV files.

A `mode' of @code{'rb'} returns a @ref{2b6,,Wave_read} object, while a `mode' of
@code{'wb'} returns a @ref{2b7,,Wave_write} object.  If `mode' is omitted and a
file-like object is passed as `file', @code{file.mode} is used as the default
value for `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{952,,open()} function may be used in a @ref{5d2,,with} statement.  When
the @code{with} block completes, the @ref{3ef7,,Wave_read.close()} or
@ref{3ef8,,Wave_write.close()} method is called.


Alterado na versão 3.4: Added support for unseekable files.

@end deffn

@geindex Error
@anchor{library/wave wave Error}@anchor{3ef9}
@deffn {Exceção} wave.Error

An error raised when something is impossible because it violates the WAV
specification or hits an implementation deficiency.
@end deffn

@menu
* Objetos Wave_read:: 
* Objetos Wave_write:: 

@end menu

@node Objetos Wave_read,Objetos Wave_write,,wave — Read and write WAV files
@anchor{library/wave id1}@anchor{3efa}@anchor{library/wave wave-read-objects}@anchor{3efb}
@subsubsection Objetos Wave_read


@geindex Wave_read (classe em wave)
@anchor{library/wave wave Wave_read}@anchor{2b6}
@deffn {Classe} wave.Wave_read

Read a WAV file.

Wave_read objects, as returned by @ref{952,,open()}, have the following methods:

@geindex close() (método wave.Wave_read)
@anchor{library/wave wave Wave_read close}@anchor{3ef7}
@deffn {Método} close ()

Close the stream if it was opened by @ref{113,,wave}, and make the instance
unusable.  This is called automatically on object collection.
@end deffn

@geindex getnchannels() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getnchannels}@anchor{3efc}
@deffn {Método} getnchannels ()

Returns number of audio channels (@code{1} for mono, @code{2} for stereo).
@end deffn

@geindex getsampwidth() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getsampwidth}@anchor{3efd}
@deffn {Método} getsampwidth ()

Retorna a largura da amostra em bytes.
@end deffn

@geindex getframerate() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getframerate}@anchor{3efe}
@deffn {Método} getframerate ()

Retorna a frequência de amostragem.
@end deffn

@geindex getnframes() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getnframes}@anchor{3eff}
@deffn {Método} getnframes ()

Retorna o número de quadros de áudio.
@end deffn

@geindex getcomptype() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getcomptype}@anchor{3f00}
@deffn {Método} getcomptype ()

Returns compression type (@code{'NONE'} is the only supported type).
@end deffn

@geindex getcompname() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getcompname}@anchor{3f01}
@deffn {Método} getcompname ()

Human-readable version of @ref{3f00,,getcomptype()}. Usually @code{'not compressed'}
parallels @code{'NONE'}.
@end deffn

@geindex getparams() (método wave.Wave_read)
@anchor{library/wave wave Wave_read getparams}@anchor{1020}
@deffn {Método} getparams ()

Returns a @ref{1ca,,namedtuple()} @code{(nchannels, sampwidth,
framerate, nframes, comptype, compname)}, equivalent to output of the
@code{get*()} methods.
@end deffn

@geindex readframes() (método wave.Wave_read)
@anchor{library/wave wave Wave_read readframes}@anchor{3f02}
@deffn {Método} readframes (n)

Reads and returns at most `n' frames of audio, as a @ref{1c2,,bytes} object.
@end deffn

@geindex rewind() (método wave.Wave_read)
@anchor{library/wave wave Wave_read rewind}@anchor{3f03}
@deffn {Método} rewind ()

Volta o ponteiro do arquivo para o início do fluxo de áudio.
@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 wave.Wave_read)
@anchor{library/wave wave Wave_read getmarkers}@anchor{2b5}
@deffn {Método} getmarkers ()

Retorna @code{None}.


Descontinuado desde a versão 3.13, será removido na versão 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 wave.Wave_read)
@anchor{library/wave wave Wave_read getmark}@anchor{2b4}
@deffn {Método} getmark (id)

Levanta um erro.


Descontinuado desde a versão 3.13, será removido na versão 3.15: The method only existed for compatibility with the @code{aifc} module
which has been removed in Python 3.13.

@end deffn

Os dois métodos a seguir definem um termo “posição” que é compatível entre eles e é dependente da implementação.

@geindex setpos() (método wave.Wave_read)
@anchor{library/wave wave Wave_read setpos}@anchor{3f04}
@deffn {Método} setpos (pos)

Define o ponteiro de arquivo para a posição especificada.
@end deffn

@geindex tell() (método wave.Wave_read)
@anchor{library/wave wave Wave_read tell}@anchor{3f05}
@deffn {Método} tell ()

Retorna a posição atual do ponteiro de arquivo.
@end deffn
@end deffn

@node Objetos Wave_write,,Objetos Wave_read,wave — Read and write WAV files
@anchor{library/wave id2}@anchor{3f06}@anchor{library/wave wave-write-objects}@anchor{1021}
@subsubsection Objetos Wave_write


@geindex Wave_write (classe em wave)
@anchor{library/wave wave Wave_write}@anchor{2b7}
@deffn {Classe} wave.Wave_write

Escreve um arquivo WAV.

Objetos Wave_write, como retornados por @ref{952,,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{3f07,,setnframes()} or @ref{3f08,,setparams()} with the number
of frames that will be written before @ref{3ef8,,close()} is called and
then using @ref{1022,,writeframesraw()} to write the frame data, or by
calling @ref{1023,,writeframes()} with all of the frame data to be
written.  In the latter case @ref{1023,,writeframes()} will calculate
the number of frames in the data and set `nframes' accordingly before writing
the frame data.


Alterado na versão 3.4: Added support for unseekable files.


Wave_write objects have the following methods:

@geindex close() (método wave.Wave_write)
@anchor{library/wave wave Wave_write close}@anchor{3ef8}
@deffn {Método} close ()

Make sure `nframes' is correct, and close the file if it was opened by
@ref{113,,wave}.  This method is called upon object collection.  It will raise
an exception if the output stream is not seekable and `nframes' does not
match the number of frames actually written.
@end deffn

@geindex setnchannels() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setnchannels}@anchor{3f09}
@deffn {Método} setnchannels (n)

Define o número de canais.
@end deffn

@geindex setsampwidth() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setsampwidth}@anchor{3f0a}
@deffn {Método} setsampwidth (n)

Set the sample width to `n' bytes.
@end deffn

@geindex setframerate() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setframerate}@anchor{3f0b}
@deffn {Método} setframerate (n)

Set the frame rate to `n'.


Alterado na versão 3.2: A non-integral input to this method is rounded to the nearest
integer.

@end deffn

@geindex setnframes() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setnframes}@anchor{3f07}
@deffn {Método} setnframes (n)

Set the number of frames to `n'.  This will be changed later if the number
of frames actually written is different (this update attempt will
raise an error if the output stream is not seekable).
@end deffn

@geindex setcomptype() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setcomptype}@anchor{3f0c}
@deffn {Método} setcomptype (type, name)

Set the compression type and description. At the moment, only compression type
@code{NONE} is supported, meaning no compression.
@end deffn

@geindex setparams() (método wave.Wave_write)
@anchor{library/wave wave Wave_write setparams}@anchor{3f08}
@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 wave.Wave_write)
@anchor{library/wave wave Wave_write tell}@anchor{3f0d}
@deffn {Método} tell ()

Return current position in the file, with the same disclaimer for the
@ref{3f05,,Wave_read.tell()} and @ref{3f04,,Wave_read.setpos()} methods.
@end deffn

@geindex writeframesraw() (método wave.Wave_write)
@anchor{library/wave wave Wave_write writeframesraw}@anchor{1022}
@deffn {Método} writeframesraw (data)

Escreve quadros de áudio, sem corrigir `nframes'.


Alterado na versão 3.4: Todo @ref{d4f,,objeto bytes ou similar} agora é aceito.

@end deffn

@geindex writeframes() (método wave.Wave_write)
@anchor{library/wave wave Wave_write writeframes}@anchor{1023}
@deffn {Método} writeframes (data)

Write audio frames and make sure `nframes' is correct.  It will raise an
error if the output stream is not seekable and the total number of frames
that have been written after `data' has been written does not match the
previously set value for `nframes'.


Alterado na versão 3.4: Todo @ref{d4f,,objeto bytes ou similar} agora é aceito.


Note that it is invalid to set any parameters after calling @ref{1023,,writeframes()}
or @ref{1022,,writeframesraw()}, and any attempt to do so will raise
@ref{3ef9,,wave.Error}.
@end deffn
@end deffn

@node colorsys — Conversões entre sistemas de cores,,wave — Read and write WAV files,Serviços Multimídia
@anchor{library/colorsys doc}@anchor{3f0e}@anchor{library/colorsys colorsys-conversions-between-color-systems}@anchor{3f0f}@anchor{library/colorsys module-colorsys}@anchor{1f}@anchor{library/colorsys translation-repo}@anchor{3f10}
@subsection @code{colorsys} — Conversões entre sistemas de cores


@geindex module; colorsys

`Código-fonte:' Lib/colorsys.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/colorsys.py}


__________________________________________________________________


O módulo @ref{1f,,colorsys} define conversões bidirecionais de valores de cores entre cores expressas no espaço de cores RGB (Red Green Blue) usado em monitores de computador e três outros sistemas de coordenadas: YIQ, HLS (Hue Lightness Saturation) e HSV (Hue Saturation Value). As coordenadas em todos esses espaços de cores são valores de ponto flutuante. No espaço YIQ, a coordenada Y está entre 0 e 1, mas as coordenadas I e Q podem ser positivas ou negativas. Em todos os outros espaços, as coordenadas estão todas entre 0 e 1.


@subsubheading Ver também


Mais informações sobre espaços de cores podem ser encontradas em @indicateurl{https://poynton.ca/ColorFAQ.html} e @indicateurl{https://www.cambridgeincolour.com/tutorials/color-spaces.htm}.


O módulo @ref{1f,,colorsys} define as seguintes funções:

@geindex rgb_to_yiq() (no módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_yiq}@anchor{3f11}
@deffn {Função} colorsys.rgb_to_yiq (r, g, b)

Converte a cor de coordenadas RGB para coordenadas YIQ.
@end deffn

@geindex yiq_to_rgb() (no módulo colorsys)
@anchor{library/colorsys colorsys yiq_to_rgb}@anchor{3f12}
@deffn {Função} colorsys.yiq_to_rgb (y, i, q)

Converte a cor de coordenadas YIQ para coordenadas RGB.
@end deffn

@geindex rgb_to_hls() (no módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_hls}@anchor{17f4}
@deffn {Função} colorsys.rgb_to_hls (r, g, b)

Converte a cor de coordenadas RGB para coordenadas HLS.
@end deffn

@geindex hls_to_rgb() (no módulo colorsys)
@anchor{library/colorsys colorsys hls_to_rgb}@anchor{3f13}
@deffn {Função} colorsys.hls_to_rgb (h, l, s)

Converte a cor de coordenadas HLS para coordenadas RGB.
@end deffn

@geindex rgb_to_hsv() (no módulo colorsys)
@anchor{library/colorsys colorsys rgb_to_hsv}@anchor{3f14}
@deffn {Função} colorsys.rgb_to_hsv (r, g, b)

Converte a cor de coordenadas RGB para coordenadas HSV.
@end deffn

@geindex hsv_to_rgb() (no módulo colorsys)
@anchor{library/colorsys colorsys hsv_to_rgb}@anchor{3f15}
@deffn {Função} colorsys.hsv_to_rgb (h, s, v)

Converte a cor de coordenadas HSV para coordenadas RGB.
@end deffn

Exemplo:

@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 Internacionalização,Interfaces gráficas de usuário com Tk,Serviços Multimídia,A Biblioteca Padrão do Python
@anchor{library/i18n doc}@anchor{3f16}@anchor{library/i18n i18n}@anchor{3f17}@anchor{library/i18n internationalization}@anchor{3f18}@anchor{library/i18n translation-repo}@anchor{3f19}
@section Internacionalização


Os módulos descritos neste capítulo ajudam você a criar um software que é independente de idioma e localidade, fornecendo mecanismos para selecionar um idioma a ser usado em mensagens de programa ou adaptando a saída para corresponder às convenções locais.

A lista de módulos descritos neste capítulo é:

@menu
* gettext — Serviços de internacionalização multilíngues:: 
* locale — Serviços de internacionalização:: 

@end menu

@node gettext — Serviços de internacionalização multilíngues,locale — Serviços de internacionalização,,Internacionalização
@anchor{library/gettext doc}@anchor{3f1a}@anchor{library/gettext gettext-multilingual-internationalization-services}@anchor{3f1b}@anchor{library/gettext module-gettext}@anchor{63}
@subsection @code{gettext} — Serviços de internacionalização multilíngues


@geindex module; gettext

`Código-fonte:' Lib/gettext.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/gettext.py}


__________________________________________________________________


O módulo @ref{63,,gettext} fornece serviços de internacionalização (I18N) e localização (L10N) para seus módulos e aplicativos Python. Ele suporta a API do catálogo de mensagens GNU @code{gettext} e uma API baseada em classes de nível mais alto que podem ser mais apropriadas para arquivos Python. A interface descrita abaixo permite gravar o módulo e as mensagens do aplicativo em um idioma natural e fornecer um catálogo de mensagens traduzidas para execução em diferentes idiomas naturais.

Algumas dicas sobre localização de seus módulos e aplicativos Python também são fornecidas.

@menu
* API do GNU gettext:: 
* API baseada em classe:: 
* Internacionalizando seus programas e módulos:: 
* Reconhecimentos: Reconhecimentos<9>. 

@end menu

@node API do GNU gettext,API baseada em classe,,gettext — Serviços de internacionalização multilíngues
@anchor{library/gettext gnu-gettext-api}@anchor{3f1c}
@subsubsection API do GNU @code{gettext}


O módulo @ref{63,,gettext} define a API a seguir, que é muito semelhante à API do GNU @code{gettext}. Se você usar esta API, você afetará a tradução de todo o seu aplicativo globalmente. Geralmente, é isso que você deseja se o seu aplicativo for monolíngue, com a escolha do idioma dependente da localidade do seu usuário. Se você estiver localizando um módulo Python, ou se seu aplicativo precisar alternar idiomas rapidamente, provavelmente desejará usar a API baseada em classe.

@geindex bindtextdomain() (no módulo gettext)
@anchor{library/gettext gettext bindtextdomain}@anchor{3f1d}
@deffn {Função} gettext.bindtextdomain (domain, localedir=None)

Liga o `domain' ao diretório de localidade `localedir'. Mais concretamente, @ref{63,,gettext} procurará arquivos binários @code{.mo} para o domínio especificado usando o caminho (no Unix): @code{`localedir'/`language'/LC_MESSAGES/`domain'.mo}, sendo `language' pesquisado nas variáveis de ambiente 
@geindex LANGUAGE
@geindex variável de ambiente; LANGUAGE
@code{LANGUAGE}, 
@geindex LC_ALL
@geindex variável de ambiente; LC_ALL
@code{LC_ALL}, 
@geindex LC_MESSAGES
@geindex variável de ambiente; LC_MESSAGES
@code{LC_MESSAGES} e 
@geindex LANG
@geindex variável de ambiente; LANG
@code{LANG} respectivamente.

Se `localedir' for omitido ou @code{None}, a ligação atual para `domain' será retornada. @footnote{
O diretório de localidade padrão depende do sistema; por exemplo, no Red Hat Linux é @code{/usr/share/locale}, mas no Solaris é @code{/usr/lib/locale}. O módulo @code{gettext} não tenta dar suporte a esses padrões dependentes do sistema; em vez disso, seu padrão é @code{`sys.base_prefix'/share/locale} (consulte @ref{3ef,,sys.base_prefix}). Por esse motivo, é sempre melhor chamar @ref{3f1d,,bindtextdomain()} com um caminho absoluto explícito no início da sua aplicação.
}
@end deffn

@geindex textdomain() (no módulo gettext)
@anchor{library/gettext gettext textdomain}@anchor{3f1e}
@deffn {Função} gettext.textdomain (domain=None)

Altera ou consulta o domínio global atual. Se `domain' for @code{None}, o domínio global atual será retornado; caso contrário, o domínio global será definido como `domain', o qual será retornado.
@end deffn

@geindex _ (sublinhado);gettext

@geindex gettext() (no módulo gettext)
@anchor{library/gettext gettext gettext}@anchor{14b1}
@deffn {Função} gettext.gettext (message)

Retorna a tradução localizada de `message', com base no diretório global atual de domínio, idioma e localidade. Essa função geralmente é apelidada como @code{_()} no espaço de nomes local (veja exemplos abaixo).
@end deffn

@geindex dgettext() (no módulo gettext)
@anchor{library/gettext gettext dgettext}@anchor{3f1f}
@deffn {Função} gettext.dgettext (domain, message)

Semelhante a @ref{14b1,,gettext()}, mas procura a mensagem no `domain' especificado.
@end deffn

@geindex ngettext() (no módulo gettext)
@anchor{library/gettext gettext ngettext}@anchor{3f20}
@deffn {Função} gettext.ngettext (singular, plural, n)

Semelhante a @ref{14b1,,gettext()}, mas considera formas plurais. Se uma tradução for encontrada, aplica a fórmula do plural a `n' e retorne a mensagem resultante (alguns idiomas têm mais de duas formas no plural). Se nenhuma tradução for encontrada, retorna `singular' se `n' for 1; retorna `plural' caso contrário.

A fórmula de Plural é retirada do cabeçalho do catálogo. É uma expressão C ou Python que possui uma variável livre `n'; a expressão é avaliada para o índice do plural no catálogo. Veja a documentação do gettext GNU@footnote{https://www.gnu.org/software/gettext/manual/gettext.html} para obter a sintaxe precisa a ser usada em arquivos @code{.po} e as fórmulas para um variedade de idiomas.
@end deffn

@geindex dngettext() (no módulo gettext)
@anchor{library/gettext gettext dngettext}@anchor{3f21}
@deffn {Função} gettext.dngettext (domain, singular, plural, n)

Semelhante a @ref{3f20,,ngettext()}, mas procura a mensagem no `domain' especificado.
@end deffn

@geindex pgettext() (no módulo gettext)
@anchor{library/gettext gettext pgettext}@anchor{9fd}
@deffn {Função} gettext.pgettext (context, message)
@end deffn

@geindex dpgettext() (no módulo gettext)
@anchor{library/gettext gettext dpgettext}@anchor{3f22}
@deffn {Função} gettext.dpgettext (domain, context, message)
@end deffn

@geindex npgettext() (no módulo gettext)
@anchor{library/gettext gettext npgettext}@anchor{3f23}
@deffn {Função} gettext.npgettext (context, singular, plural, n)
@end deffn

@geindex dnpgettext() (no módulo gettext)
@anchor{library/gettext gettext dnpgettext}@anchor{3f24}
@deffn {Função} gettext.dnpgettext (domain, context, singular, plural, n)

Semelhante às funções correspondentes sem o @code{p} no prefixo (ou seja, @ref{63,,gettext()}, @ref{3f1f,,dgettext()}, @ref{3f20,,ngettext()}, @ref{3f21,,dngettext()}), mas a tradução é restrita ao `context' de mensagem fornecido.


Adicionado na versão 3.8.

@end deffn

Note que GNU @code{gettext} também define um método @code{dcgettext()}, mas isso não foi considerado útil e, portanto, atualmente não está implementado.

Aqui está um exemplo de uso típico para esta API:

@example
import gettext
gettext.bindtextdomain('minhaaplicacao', '/caminho/para/diretório/do/meu/idioma')
gettext.textdomain('minhaaplicacao')
_ = gettext.gettext
# ...
print(_('Esta é uma string traduzível.'))
@end example

@node API baseada em classe,Internacionalizando seus programas e módulos,API do GNU gettext,gettext — Serviços de internacionalização multilíngues
@anchor{library/gettext class-based-api}@anchor{3f25}
@subsubsection API baseada em classe


A API baseada em classe do módulo @ref{63,,gettext} oferece mais flexibilidade e maior conveniência do que a API do GNU @code{gettext}. É a maneira recomendada de localizar seus aplicativos e módulos Python. @code{gettext} define uma classe @ref{3f26,,GNUTranslations} que implementa a análise de arquivos no formato GNU @code{.mo} e possui métodos para retornar strings. Instâncias dessa classe também podem se instalar no espaço de nomes embutido como a função @code{_()}.

@geindex find() (no módulo gettext)
@anchor{library/gettext gettext find}@anchor{3f27}
@deffn {Função} gettext.find (domain, localedir=None, languages=None, all=False)

Esta função implementa o algoritmo de busca de arquivos @code{.mo} padrão. É necessário um `domain', idêntico ao que @ref{3f1e,,textdomain()} leva. `localedir' opcional é como em @ref{3f1d,,bindtextdomain()}. `languages' opcional é uma lista de strings, em que cada string é um código de idioma.

Se `localedir' não for fornecido, o diretório local do sistema padrão será usado. @footnote{
Consulte a nota de rodapé para a @ref{3f1d,,bindtextdomain()} acima.
} Se `languages' não for fornecido, as seguintes variáveis de ambiente serão pesquisadas: 
@geindex LANGUAGE
@geindex variável de ambiente; LANGUAGE
@code{LANGUAGE}, 
@geindex LC_ALL
@geindex variável de ambiente; LC_ALL
@code{LC_ALL}, 
@geindex LC_MESSAGES
@geindex variável de ambiente; LC_MESSAGES
@code{LC_MESSAGES} e 
@geindex LANG
@geindex variável de ambiente; LANG
@code{LANG}. O primeiro retornando um valor não vazio é usado para a variável `languages'. As variáveis de ambiente devem conter uma lista de idiomas separada por dois pontos, que será dividida nos dois pontos para produzir a lista esperada de strings de código de idioma.

@ref{3f27,,find()} expande e normaliza os idiomas e itera através deles, procurando por um arquivo existente construído com esses componentes:

@code{`localedir'/`language'/LC_MESSAGES/`domain'.mo}

O primeiro nome de arquivo existente é retornado por @ref{3f27,,find()}. Se nenhum desses arquivos for encontrado, será retornado @code{None}. Se `all' for fornecido, ele retornará uma lista de todos os nomes de arquivos, na ordem em que aparecem na lista de idiomas ou nas variáveis de ambiente.
@end deffn

@geindex translation() (no módulo gettext)
@anchor{library/gettext gettext translation}@anchor{a83}
@deffn {Função} gettext.translation (domain, localedir=None, languages=None, class_=None, fallback=False)

Retorna uma instância de @code{*Translations} com base nos `domain', `localedir' e `languages', que são passados primeiro para @ref{3f27,,find()} para obter uma lista dos caminhos de arquivos @code{.mo} associados. Instâncias com nomes de arquivo idênticos @code{.mo} são armazenados em cache. A classe atual instanciada é `class_' se fornecida, caso contrário @ref{3f26,,GNUTranslations}. O construtor da classe deve usar um único argumento @ref{1203,,objeto arquivo}.

Se vários arquivos forem encontrados, os arquivos posteriores serão usados como fallbacks para os anteriores. Para permitir a configuração do fallback, @ref{534,,copy.copy()} é usado para clonar cada objeto de conversão do cache; os dados reais da instância ainda são compartilhados com o cache.

Se nenhum arquivo @code{.mo} for encontrado, essa função levanta @ref{417,,OSError} se `fallback' for falso (que é o padrão) e retorna uma instância @ref{3f28,,NullTranslations} se `fallback' for verdadeiro.


Alterado na versão 3.3: @ref{108b,,IOError} costumava ser levantada, agora ela é um apelido para @ref{417,,OSError}.



Alterado na versão 3.11: O parâmetro `codeset' foi removido.

@end deffn

@geindex install() (no módulo gettext)
@anchor{library/gettext gettext install}@anchor{a84}
@deffn {Função} gettext.install (domain, localedir=None, *, names=None)

Isso instala a função @code{_()} no espaço de nomes interno do Python, com base em `domain' e `localedir' que são passados para a função @ref{a83,,translation()}.

Para o parâmetro `names', por favor, veja a descrição do método @ref{3f29,,install()} do objeto de tradução.

Como visto abaixo, você normalmente marca as strings candidatas à tradução em sua aplicação, envolvendo-as em uma chamada para a função @code{_()}, assim:

@example
print(_('Esta string será traduzida.'))
@end example

Por conveniência, você deseja que a função @code{_()} seja instalada no espaço de nomes interno do Python, para que seja facilmente acessível em todos os módulos do sua aplicação.


Alterado na versão 3.11: `names' é agora um parâmetro somente-nomeado.

@end deffn

@menu
* A classe NullTranslations:: 
* A classe GNUTranslations:: 
* Suporte a catálogo de mensagens do Solaris:: 
* O construtor Catalog:: 

@end menu

@node A classe NullTranslations,A classe GNUTranslations,,API baseada em classe
@anchor{library/gettext the-nulltranslations-class}@anchor{3f2a}
@subsubsection A classe @code{NullTranslations}


As classes de tradução são o que realmente implementa a tradução de strings de mensagens do arquivo-fonte original para strings de mensagens traduzidas. A classe base usada por todas as classes de tradução é @ref{3f28,,NullTranslations}; isso fornece a interface básica que você pode usar para escrever suas próprias classes de tradução especializadas. Aqui estão os métodos de @code{NullTranslations}:

@geindex NullTranslations (classe em gettext)
@anchor{library/gettext gettext NullTranslations}@anchor{3f28}
@deffn {Classe} gettext.NullTranslations (fp=None)

Recebe um @ref{1203,,objeto arquivo} opcional `fp', que é ignorado pela classe base. Inicializa as variáveis de instância “protegidas” `_info' e `_charset', que são definidas por classes derivadas, bem como `_fallback', que é definido através de @ref{3f2b,,add_fallback()}. Ele então chama @code{self._parse(fp)} se `fp' não for @code{None}.

@geindex _parse() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations _parse}@anchor{3f2c}
@deffn {Método} _parse (fp)

No-op na classe base, esse método pega o objeto arquivo `fp' e lê os dados do arquivo, inicializando seu catálogo de mensagens. Se você tiver um formato de arquivo de catálogo de mensagens não suportado, substitua esse método para analisar seu formato.
@end deffn

@geindex add_fallback() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations add_fallback}@anchor{3f2b}
@deffn {Método} add_fallback (fallback)

Adiciona `fallback' como o objeto reserva para o objeto de tradução atual. Um objeto de tradução deve consultar o fallback se não puder fornecer uma tradução para uma determinada mensagem.
@end deffn

@geindex gettext() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations gettext}@anchor{3f2d}
@deffn {Método} gettext (message)

Se um fallback tiver sido definido, encaminha @code{gettext()} para o fallback. Caso contrário, retorna `message'. Substituído em classes derivadas.
@end deffn

@geindex ngettext() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations ngettext}@anchor{3f2e}
@deffn {Método} ngettext (singular, plural, n)

Se um fallback tiver sido definido, encaminha @code{ngettext()} para o fallback. Caso contrário, retorna `singular' se `n' for 1; do contrário, retorna `plural'. Substituído em classes derivadas.
@end deffn

@geindex pgettext() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations pgettext}@anchor{3f2f}
@deffn {Método} pgettext (context, message)

Se um fallback tiver sido definido, encaminha @ref{9fd,,pgettext()} para o fallback. Caso contrário, retorna a mensagem traduzida. Substituído em classes derivadas.


Adicionado na versão 3.8.

@end deffn

@geindex npgettext() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations npgettext}@anchor{3f30}
@deffn {Método} npgettext (context, singular, plural, n)

Se um fallback tiver sido definido, encaminha @ref{3f23,,npgettext()} para o fallback. Caso contrário, retorna a mensagem traduzida. Substituído em classes derivadas.


Adicionado na versão 3.8.

@end deffn

@geindex info() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations info}@anchor{3f31}
@deffn {Método} info ()

Retorna um dicionário que contém os metadados encontrados no arquivo de catálogo de mensagens.
@end deffn

@geindex charset() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations charset}@anchor{3f32}
@deffn {Método} charset ()

Retorna a codificação do arquivo de catálogo de mensagens.
@end deffn

@geindex install() (método gettext.NullTranslations)
@anchor{library/gettext gettext NullTranslations install}@anchor{3f29}
@deffn {Método} install (names=None)

Este método instala @ref{3f2d,,gettext()} no espaço de nomes embutido, ligando-o a @code{_}.

Se o parâmetro `names' for fornecido, deve ser uma sequência contendo os nomes das funções que você deseja instalar no espaço de nomes embutidos, além de @code{_()}. Há suporte aos nomes @code{'gettext'}, @code{'ngettext'}, @code{'pgettext'} e @code{'npgettext'}

Observe que esta é apenas uma maneira, embora a maneira mais conveniente, de disponibilizar a função @code{_()} para sua aplicação. Como afeta a aplicação inteira globalmente, e especificamente o espaço de nomes embutido, os módulos localizados nunca devem instalar @code{_()}. Em vez disso, eles devem usar este código para disponibilizar @code{_()} para seu módulo:

@example
import gettext
t = gettext.translation('meumódulo', ...)
_ = t.gettext
@end example

Isso coloca @code{_()} apenas no espaço de nomes global do módulo e, portanto, afeta apenas as chamadas dentro deste módulo.


Alterado na versão 3.8: Adicionado @code{'pgettext'} e @code{'npgettext'}.

@end deffn
@end deffn

@node A classe GNUTranslations,Suporte a catálogo de mensagens do Solaris,A classe NullTranslations,API baseada em classe
@anchor{library/gettext the-gnutranslations-class}@anchor{3f33}
@subsubsection A classe @code{GNUTranslations}


O módulo @code{gettext} fornece uma classe adicional derivada de @ref{3f28,,NullTranslations}: @ref{3f26,,GNUTranslations}. Esta classe substitui @code{_parse()} para permitir a leitura de arquivos @code{.mo} do formato GNU @code{gettext} nos formatos big-endian e little-endian.

@ref{3f26,,GNUTranslations} analisa metadados opcionais do catálogo de tradução. É uma convenção com o GNU @code{gettext} incluir metadados como tradução para a string vazia. Esses metadados estão nos pares @code{key: value} no estilo 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} e devem conter a chave @code{Project-Id-Version}. Se a chave @code{Content-Type} for encontrada, a propriedade @code{charset} será usada para inicializar a variável de instância @code{_charset} “protegida”, com o padrão @code{None} se não for encontrada. Se a codificação de “charset” for especificada, todos os IDs e strings de mensagens lidos no catálogo serão convertidos em Unicode usando essa codificação, caso contrário, o ASCII será presumido.

Como os IDs de mensagens também são lidos como strings Unicode, todos os métodos @code{*gettext()} presumem os IDs de mensagens como sendo strings Unicode, não como strings de bytes.

Todo o conjunto de pares chave/valor é colocado em um dicionário e definido como a variável de instância @code{_info} “protegida”.

Se o número mágico do arquivo @code{.mo} for inválido, o número principal da versão é inesperado ou se ocorrerem outros problemas durante a leitura do arquivo, instanciando uma classe @ref{3f26,,GNUTranslations} pode levantar @ref{417,,OSError}.

@geindex GNUTranslations (classe em gettext)
@anchor{library/gettext gettext GNUTranslations}@anchor{3f26}
@deffn {Classe} gettext.GNUTranslations

Os seguintes métodos são substituídos a partir da implementação da classe base:

@geindex gettext() (método gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations gettext}@anchor{3f34}
@deffn {Método} gettext (message)

Procura o ID da `message' no catálogo e retorna a string de mensagens correspondente, como uma string Unicode. Se não houver entrada no catálogo para o ID da `message' e um fallback tiver sido definido, a pesquisa será encaminhada para o método @ref{3f2d,,gettext()} do fallback. Caso contrário, o ID da `message' é retornado.
@end deffn

@geindex ngettext() (método gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations ngettext}@anchor{3f35}
@deffn {Método} ngettext (singular, plural, n)

Faz uma pesquisa de plural-forms de um ID de mensagem. `singular' é usado como o ID da mensagem para fins de pesquisa no catálogo, enquanto `n' é usado para determinar qual forma plural usar. A string de mensagens retornada é uma string Unicode.

Se o ID da mensagem não for encontrado no catálogo e um fallback for especificado, a solicitação será encaminhada para o método do fallback @ref{3f2e,,ngettext()}. Caso contrário, quando `n' for 1, `singular' será retornado e `plural' será retornado em todos os outros casos.

Aqui está um exemplo:

@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 gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations pgettext}@anchor{3f36}
@deffn {Método} pgettext (context, message)

Procura o ID do `context' e da `message' no catálogo e retorna a string de mensagens correspondente, como uma string Unicode. Se não houver entrada no catálogo para o ID do `context' e da `message', e um fallback tiver sido definido, a pesquisa será encaminhada para o método @ref{9fd,,pgettext()} do fallback. Caso contrário, o ID da `message' é retornado.


Adicionado na versão 3.8.

@end deffn

@geindex npgettext() (método gettext.GNUTranslations)
@anchor{library/gettext gettext GNUTranslations npgettext}@anchor{3f37}
@deffn {Método} npgettext (context, singular, plural, n)

Faz uma pesquisa de plural-forms de um ID de mensagem. `singular' é usado como o ID da mensagem para fins de pesquisa no catálogo, enquanto `n' é usado para determinar qual forma plural usar.

Se o ID da mensagem para `context' não for encontrado no catálogo e um fallback for especificado, a solicitação será encaminhada para o método @ref{3f23,,npgettext()} do fallback. Caso contrário, quando `n' for 1, `singular' será retornado e `plural' será retornado em todos os outros casos.


Adicionado na versão 3.8.

@end deffn
@end deffn

@node Suporte a catálogo de mensagens do Solaris,O construtor Catalog,A classe GNUTranslations,API baseada em classe
@anchor{library/gettext solaris-message-catalog-support}@anchor{3f38}
@subsubsection Suporte a catálogo de mensagens do Solaris


O sistema operacional Solaris define seu próprio formato de arquivo binário @code{.mo}, mas como nenhuma documentação pode ser encontrada nesse formato, ela não é suportada no momento.

@node O construtor Catalog,,Suporte a catálogo de mensagens do Solaris,API baseada em classe
@anchor{library/gettext the-catalog-constructor}@anchor{3f39}
@subsubsection O construtor Catalog


@geindex GNOME

O GNOME usa uma versão do módulo @ref{63,,gettext} de James Henstridge, mas esta versão tem uma API um pouco diferente. Seu uso documentado foi:

@example
import gettext
cat = gettext.Catalog(domain, localedir)
_ = cat.gettext
print(_('hello world'))
@end example

Para compatibilidade com este módulo mais antigo, a função @code{Catalog()} é um apelido para a função @ref{a83,,translation()} descrita acima.

Uma diferença entre este módulo e o de Henstridge: seus objetos de catálogo suportavam o acesso por meio de uma API de mapeamento, mas isso parece não ser utilizado e, portanto, não é atualmente suportado.

@node Internacionalizando seus programas e módulos,Reconhecimentos<9>,API baseada em classe,gettext — Serviços de internacionalização multilíngues
@anchor{library/gettext i18n-howto}@anchor{30a8}@anchor{library/gettext internationalizing-your-programs-and-modules}@anchor{3f3a}
@subsubsection Internacionalizando seus programas e módulos


Internationalization (I18N), ou internacionalização (I17O) em português, refere-se à operação pela qual um programa é informado sobre vários idiomas. Localization (L10N), ou localização em português, refere-se à adaptação do seu programa, uma vez internacionalizado, aos hábitos culturais e de idioma local. Para fornecer mensagens multilíngues para seus programas Python, você precisa executar as seguintes etapas:


@enumerate 

@item 
preparar seu programa ou módulo especialmente marcando strings traduzíveis

@item 
executar um conjunto de ferramentas nos arquivos marcados para gerar catálogos de mensagens não tratadas

@item 
criar traduções específicas do idioma dos catálogos de mensagens

@item 
usar o módulo @ref{63,,gettext} para que as strings das mensagens sejam traduzidas corretamente
@end enumerate

Para preparar seu código para I18N, você precisa examinar todas as strings em seus arquivos. Qualquer string que precise ser traduzida deve ser marcada envolvendo-a em @code{_('...')} — isto é, uma chamada para a função @ref{63,,_}. Por exemplo:

@example
filename = 'meulog.txt'
message = _('escrevendo uma mensagem de log')
with open(filename, 'w') as fp:
    fp.write(message)
@end example

Neste exemplo, a string @code{'escrevendo uma mensagem de log'} está marcada como um candidato para tradução, enquanto as strings @code{'meulog.txt'} e @code{'w'} não estão.

Existem algumas ferramentas para extrair as strings destinadas à tradução. O GNU @code{gettext} original tem suporte apenas ao código-fonte C ou C++, mas sua versão estendida @code{xgettext} varre o código escrito em várias linguagens, incluindo Python, para encontrar strings marcadas como traduzíveis. Babel@footnote{https://babel.pocoo.org/} é uma biblioteca de internacionalização do Python que inclui um script @code{pybabel} para extrair e compilar catálogos de mensagens. O programa de François Pinard chamado @code{xpot} faz um trabalho semelhante e está disponível como parte de seu pacote po-utils@footnote{https://github.com/pinard/po-utils}.

(O Python também inclui versões em Python puro desses programas, chamadas @code{pygettext.py} e @code{msgfmt.py}; algumas distribuições do Python as instalam para você. O @code{pygettext.py} é semelhante ao @code{xgettext}, mas apenas entende o código-fonte do Python e não consegue lidar com outras linguagens de programação como C ou C++. O @code{pygettext.py} possui suporte a uma interface de linha de comando semelhante à do @code{xgettext}; para detalhes sobre seu uso, execute @code{pygettext.py --help}. O @code{msgfmt.py} é compatível com binários com GNU @code{msgfmt}. Com esses dois programas, você pode não precisar do pacote GNU @code{gettext} para internacionalizar suas aplicações Python.)

@code{xgettext}, @code{pygettext} e ferramentas similares geram @code{.po} que são catálogos de mensagens. Eles são arquivos legíveis por humanos estruturados que contêm todas as strings marcadas no código-fonte, junto com um espaço reservado para as versões traduzidas dessas strings.

Cópias destes arquivos @code{.po} são entregues aos tradutores humanos individuais que escrevem traduções para todos os idiomas naturais suportados. Eles enviam de volta as versões completas específicas do idioma como um arquivo @code{<nome-do-idioma>.po} que é compilado em um arquivo de catálogo binário legível por máquina @code{.mo} usando o programa @code{msgfmt}. Os arquivos @code{.mo} são usados pelo módulo @ref{63,,gettext} para o processamento de tradução real em tempo de execução.

Como você usa o módulo @ref{63,,gettext} no seu código depende se você está internacionalizando um único módulo ou sua aplicação inteira. As próximas duas seções discutirão cada caso.

@menu
* Localizando seu módulo:: 
* Localizando sua aplicação:: 
* Alterando os idiomas durante o uso:: 
* Traduções adiadas:: 

@end menu

@node Localizando seu módulo,Localizando sua aplicação,,Internacionalizando seus programas e módulos
@anchor{library/gettext localizing-your-module}@anchor{3f3b}
@subsubsection Localizando seu módulo


Se você estiver localizando seu módulo, tome cuidado para não fazer alterações globais, por exemplo para o espaço de nomes embutidos. Você não deve usar a API GNU @code{gettext}, mas a API baseada em classe.

Digamos que seu módulo seja chamado “spam” e as várias traduções do idioma natural do arquivo @code{.mo} residam em @code{/usr/share/locale} no formato GNU @code{gettext}. Aqui está o que você colocaria sobre o seu módulo:

@example
import gettext
t = gettext.translation('spam', '/usr/share/locale')
_ = t.gettext
@end example

@node Localizando sua aplicação,Alterando os idiomas durante o uso,Localizando seu módulo,Internacionalizando seus programas e módulos
@anchor{library/gettext localizing-your-application}@anchor{3f3c}
@subsubsection Localizando sua aplicação


Se você estiver localizando sua aplicação, poderá instalar a função @code{_()} globalmente no espaço de nomes embutidos, geralmente no arquivo principal do driver do sua aplicação. Isso permitirá que todos os arquivos específicos de sua aplicação usem @code{_('...')} sem precisar instalá-la explicitamente em cada arquivo.

No caso simples, você precisa adicionar apenas o seguinte código ao arquivo do driver principal da sua aplicação:

@example
import gettext
gettext.install('minhaaplicacao')
@end example

Se você precisar definir o diretório da localidade, poderá passá-lo para a função @ref{a84,,install()}:

@example
import gettext
gettext.install('minhaaplicacao', '/usr/share/locale')
@end example

@node Alterando os idiomas durante o uso,Traduções adiadas,Localizando sua aplicação,Internacionalizando seus programas e módulos
@anchor{library/gettext changing-languages-on-the-fly}@anchor{3f3d}
@subsubsection Alterando os idiomas durante o uso


Se o seu programa precisar oferecer suporte a vários idiomas ao mesmo tempo, convém criar várias instâncias de tradução e alternar entre elas explicitamente, assim:

@example
import gettext

lang1 = gettext.translation('minhaaplicacao', languages=['en'])
lang2 = gettext.translation('minhaaplicacao', languages=['fr'])
lang3 = gettext.translation('minhaaplicacao', languages=['de'])

# começa usando o idioma 1
lang1.install()

# ... o tempo passa, o usuário seleciona o idioma 2
lang2.install()

# ... mais tempo passa, o usuário seleciona o idioma 3
lang3.install()
@end example

@node Traduções adiadas,,Alterando os idiomas durante o uso,Internacionalizando seus programas e módulos
@anchor{library/gettext deferred-translations}@anchor{3f3e}
@subsubsection Traduções adiadas


Na maioria das situações de codificação, as strings são traduzidas onde são codificadas. Ocasionalmente, no entanto, é necessário marcar strings para tradução, mas adiar a tradução real até mais tarde. Um exemplo clássico é:

@example
animals = ['mollusk',
           'albatross',
           'rat',
           'penguin',
           'python', ]
# ...
for a in animals:
    print(a)
@end example

Aqui, você deseja marcar as strings na lista @code{animals} como traduzíveis, mas na verdade não deseja traduzi-las até que sejam impressas.

Aqui está uma maneira de lidar com esta situação:

@example
def _(message): return message

animals = [_('mollusk'),
           _('albatross'),
           _('rat'),
           _('penguin'),
           _('python'), ]

del _

# ...
for a in animals:
    print(_(a))
@end example

Isso funciona porque a definição fictícia de @code{_()} simplesmente retorna a string inalterada. E essa definição fictícia vai substituir temporariamente qualquer definição de @code{_()} no espaço de nomes embutido (até o comando @ref{18a7,,del}). Tome cuidado, se você tiver uma definição anterior de @code{_()} no espaço de nomes local.

Observe que o segundo uso de @code{_()} não identificará “a” como traduzível para o programa @code{gettext}, porque o parâmetro não é uma string literal.

Outra maneira de lidar com isso é com o seguinte exemplo:

@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

Nesse caso, você está marcando strings traduzíveis com a função @code{N_()}, que não entra em conflito com nenhuma definição de @code{_()}. No entanto, você precisará ensinar seu programa de extração de mensagens a procurar strings traduzíveis marcadas com @code{N_()}. @code{xgettext}, @code{pygettext}, @code{pybabel extract} e @code{xpot} possuem suporte a isso através do uso da opção de linha de comando @code{-k}. A escolha de @code{N_()} aqui é totalmente arbitrária; poderia facilmente ter sido @code{MarkThisStringForTranslation()}.

@node Reconhecimentos<9>,,Internacionalizando seus programas e módulos,gettext — Serviços de internacionalização multilíngues
@anchor{library/gettext acknowledgements}@anchor{3f3f}
@subsubsection Reconhecimentos


As seguintes pessoas contribuíram com código, feedback, sugestões de design, implementações anteriores e experiência valiosa para a criação deste 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

@node locale — Serviços de internacionalização,,gettext — Serviços de internacionalização multilíngues,Internacionalização
@anchor{library/locale doc}@anchor{3f40}@anchor{library/locale locale-internationalization-services}@anchor{3f41}@anchor{library/locale module-locale}@anchor{86}@anchor{library/locale translation-repo}@anchor{3f42}
@subsection @code{locale} — Serviços de internacionalização


@geindex module; locale

`Código-fonte:' Lib/locale.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/locale.py}


__________________________________________________________________


O módulo @ref{86,,locale} abre o acesso ao banco de dados de localidade POSIX e funcionalidade. O mecanismo de localidade POSIX permite que os programadores lidem com certas questões culturais em uma aplicação, sem exigir que o programador conheça todas as especificidades de cada país onde o software é executado.

@geindex módulo;_locale

O módulo @ref{86,,locale} é implementado em cima do módulo @code{_locale}, que por sua vez usa uma implementação a localidade ANSI C se disponível.

O módulo @ref{86,,locale} define a seguinte exceção e funções:

@geindex Error
@anchor{library/locale locale Error}@anchor{3f43}
@deffn {Exceção} locale.Error

Exceção levantada quando a localidade passada para @ref{2db,,setlocale()} não é reconhecida.
@end deffn

@geindex setlocale() (no módulo locale)
@anchor{library/locale locale setlocale}@anchor{2db}
@deffn {Função} locale.setlocale (category, locale=None)

Se `locale' for fornecido e não @code{None}, @ref{2db,,setlocale()} modifica a configuração de locale para a `category'. As categorias disponíveis estão listadas na descrição dos dados abaixo. `locale' pode ser uma @ref{3f44,,string} ou um par, código de idioma e codificação. Uma string vazia especifica as configurações padrão do usuário. Se a modificação da localidade falhar, a exceção @ref{3f43,,Error} é levantada. Se for bem-sucedido, a nova configuração de localidade será retornada.

Se `locale' for um par, ele será convertido em um nome de localidade usando o mecanismo de apelidamento de localidade. O código de idioma tem o mesmo formato de @ref{3f44,,nome da localidade}, mas sem codificação e modificador @code{@@}. O código de idioma e a codificação podem ser @code{None}.

Se `locale' for omitido ou @code{None}, a configuração atual para `category' é retornada.

Exemplo:

@example
>>> import locale
>>> loc = locale.setlocale(locale.LC_ALL)  # get current locale
# use German locale; name and availability varies with platform
>>> locale.setlocale(locale.LC_ALL, 'de_DE.UTF-8')
>>> 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

@ref{2db,,setlocale()} is not thread-safe on most systems. Applications typically
start with a call of:

@example
import locale
locale.setlocale(locale.LC_ALL, '@w{'})
@end example

Isso define a localidade de todas as categorias para a configuração padrão do usuário (normalmente especificada na variável de ambiente 
@geindex LANG
@geindex variável de ambiente; LANG
@code{LANG}). Se a localidade não for alterada depois disso, o uso de multithreading não deve causar problemas.
@end deffn

@geindex localeconv() (no módulo locale)
@anchor{library/locale locale localeconv}@anchor{c18}
@deffn {Função} locale.localeconv ()

Retorna o banco de dados das convenções locais como um dicionário. Este dicionário possui as seguintes strings como chaves:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Categoria

@tab

Chave

@tab

Significado

@item

@ref{3f45,,LC_NUMERIC}

@tab

@code{'decimal_point'}

@tab

Caractere de ponto decimal.

@item

@tab

@code{'grouping'}

@tab

Sequência de números especificando quais posições relativas os @code{'thousands_sep'} são esperados. Se a sequência for terminada com @ref{3f46,,CHAR_MAX}, nenhum agrupamento adicional é realizado. Se a sequência termina com um @code{0}, o tamanho do último grupo é usado repetidamente.

@item

@tab

@code{'thousands_sep'}

@tab

Caractere usado entre grupos.

@item

@ref{3f47,,LC_MONETARY}

@tab

@code{'int_curr_symbol'}

@tab

Símbolo internacional de moeda.

@item

@tab

@code{'currency_symbol'}

@tab

Símbolo local de moeda.

@item

@tab

@code{'p_cs_precedes/n_cs_precedes'}

@tab

Se o símbolo da moeda precede o valor (para valores positivos ou negativos).

@item

@tab

@code{'p_sep_by_space/n_sep_by_space'}

@tab

Se o símbolo monetário está separado do valor por um espaço (para valores positivos ou negativos).

@item

@tab

@code{'mon_decimal_point'}

@tab

Ponto decimal usado para valores monetários.

@item

@tab

@code{'frac_digits'}

@tab

Número de dígitos fracionários usados na formatação local de valores monetários.

@item

@tab

@code{'int_frac_digits'}

@tab

Número de dígitos fracionários usados na formatação internacional de valores monetários.

@item

@tab

@code{'mon_thousands_sep'}

@tab

Separador de grupo usado para valores monetários.

@item

@tab

@code{'mon_grouping'}

@tab

Equivalente a @code{'grouping'}, usado para valores monetários.

@item

@tab

@code{'positive_sign'}

@tab

Símbolo usado para anotar um valor monetário positivo.

@item

@tab

@code{'negative_sign'}

@tab

Símbolo usado para anotar um valor monetário negativo.

@item

@tab

@code{'p_sign_posn/n_sign_posn'}

@tab

A posição do sinal (para valores positivos resp. negativos), veja abaixo.

@end multitable


Todos os valores numéricos podem ser definidos como @ref{3f46,,CHAR_MAX} para indicar que não há valor especificado nesta localidade.

Os valores possíveis para @code{'p_sign_posn'} e @code{'n_sign_posn'} são dados abaixo.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Explicação

@item

@code{0}

@tab

A moeda e o valor estão entre parênteses.

@item

@code{1}

@tab

O sinal deve preceder o valor e o símbolo da moeda.

@item

@code{2}

@tab

O sinal deve seguir o valor e o símbolo da moeda.

@item

@code{3}

@tab

O sinal deve preceder imediatamente o valor.

@item

@code{4}

@tab

O sinal deve seguir imediatamente o valor.

@item

@code{CHAR_MAX}

@tab

Nada é especificado nesta localidade.

@end multitable


A função define temporariamente a localidade de @code{LC_CTYPE} para a localidade de @code{LC_NUMERIC} ou a localidade de @code{LC_MONETARY} se as localidades forem diferentes e as strings numéricas ou monetárias não forem ASCII. Esta mudança temporária afeta outras threads.


Alterado na versão 3.7: A função agora define temporariamente a localidade de @code{LC_CTYPE} para a localidade de @code{LC_NUMERIC} em alguns casos.

@end deffn

@geindex nl_langinfo() (no módulo locale)
@anchor{library/locale locale nl_langinfo}@anchor{3f48}
@deffn {Função} locale.nl_langinfo (option)

Retorna algumas informações específicas da localidade em uma string. Esta função não está disponível em todos os sistemas e o conjunto de opções possíveis também pode variar entre as plataformas. Os valores de argumento possíveis são números, para os quais constantes simbólicas estão disponíveis no módulo da localidade.

A função @ref{3f48,,nl_langinfo()} aceita uma das seguintes chaves. A maioria das descrições são tiradas da descrição correspondente na biblioteca GNU C.

@geindex CODESET (no módulo locale)
@anchor{library/locale locale CODESET}@anchor{3f49}
@deffn {Dado} locale.CODESET

Obtém uma string com o nome da codificação de caracteres usada na localidade selecionado.
@end deffn

@geindex D_T_FMT (no módulo locale)
@anchor{library/locale locale D_T_FMT}@anchor{3f4a}
@deffn {Dado} locale.D_T_FMT

Obtém uma string que pode ser usada como uma string de formato para @ref{1229,,time.strftime()} para representar a data e a hora de uma maneira específica da localidade.
@end deffn

@geindex D_FMT (no módulo locale)
@anchor{library/locale locale D_FMT}@anchor{3f4b}
@deffn {Dado} locale.D_FMT

Obtém uma string que pode ser usada como uma string de formato para @ref{1229,,time.strftime()} para representar uma data de uma maneira específica da localidade.
@end deffn

@geindex T_FMT (no módulo locale)
@anchor{library/locale locale T_FMT}@anchor{3f4c}
@deffn {Dado} locale.T_FMT

Obtém uma string que pode ser usada como uma string de formato para @ref{1229,,time.strftime()} para representar uma hora de uma maneira específica da localidade.
@end deffn

@geindex T_FMT_AMPM (no módulo locale)
@anchor{library/locale locale T_FMT_AMPM}@anchor{3f4d}
@deffn {Dado} locale.T_FMT_AMPM

Obtém uma string de formato para @ref{1229,,time.strftime()} para representar a hora no formato am/pm.
@end deffn

@geindex DAY_1 (no módulo locale)
@geindex DAY_2 (no módulo locale)
@geindex DAY_3 (no módulo locale)
@geindex DAY_4 (no módulo locale)
@geindex DAY_5 (no módulo locale)
@geindex DAY_6 (no módulo locale)
@geindex DAY_7 (no módulo locale)
@anchor{library/locale locale DAY_1}@anchor{3f4e}
@deffn {Dado} locale.DAY_1
@anchor{library/locale locale DAY_2}@anchor{3f4f}
@deffnx {Dado} locale.DAY_2
@anchor{library/locale locale DAY_3}@anchor{3f50}
@deffnx {Dado} locale.DAY_3
@anchor{library/locale locale DAY_4}@anchor{3f51}
@deffnx {Dado} locale.DAY_4
@anchor{library/locale locale DAY_5}@anchor{3f52}
@deffnx {Dado} locale.DAY_5
@anchor{library/locale locale DAY_6}@anchor{3f53}
@deffnx {Dado} locale.DAY_6
@anchor{library/locale locale DAY_7}@anchor{3f54}
@deffnx {Dado} locale.DAY_7

Obtém o nome do enésimo dia da semana.

@cartouche
@quotation Nota 
Isso segue a convenção dos EUA de @ref{3f4e,,DAY_1} ser no domingo, não a convenção internacional (ISO 8601) que segunda-feira é o primeiro dia da semana.
@end quotation
@end cartouche
@end deffn

@geindex ABDAY_1 (no módulo locale)
@geindex ABDAY_2 (no módulo locale)
@geindex ABDAY_3 (no módulo locale)
@geindex ABDAY_4 (no módulo locale)
@geindex ABDAY_5 (no módulo locale)
@geindex ABDAY_6 (no módulo locale)
@geindex ABDAY_7 (no módulo locale)
@anchor{library/locale locale ABDAY_1}@anchor{3f55}
@deffn {Dado} locale.ABDAY_1
@anchor{library/locale locale ABDAY_2}@anchor{3f56}
@deffnx {Dado} locale.ABDAY_2
@anchor{library/locale locale ABDAY_3}@anchor{3f57}
@deffnx {Dado} locale.ABDAY_3
@anchor{library/locale locale ABDAY_4}@anchor{3f58}
@deffnx {Dado} locale.ABDAY_4
@anchor{library/locale locale ABDAY_5}@anchor{3f59}
@deffnx {Dado} locale.ABDAY_5
@anchor{library/locale locale ABDAY_6}@anchor{3f5a}
@deffnx {Dado} locale.ABDAY_6
@anchor{library/locale locale ABDAY_7}@anchor{3f5b}
@deffnx {Dado} locale.ABDAY_7

Obtém o nome abreviado do enésimo dia da semana.
@end deffn

@geindex MON_1 (no módulo locale)
@geindex MON_2 (no módulo locale)
@geindex MON_3 (no módulo locale)
@geindex MON_4 (no módulo locale)
@geindex MON_5 (no módulo locale)
@geindex MON_6 (no módulo locale)
@geindex MON_7 (no módulo locale)
@geindex MON_8 (no módulo locale)
@geindex MON_9 (no módulo locale)
@geindex MON_10 (no módulo locale)
@geindex MON_11 (no módulo locale)
@geindex MON_12 (no módulo locale)
@anchor{library/locale locale MON_1}@anchor{3f5c}
@deffn {Dado} locale.MON_1
@anchor{library/locale locale MON_2}@anchor{3f5d}
@deffnx {Dado} locale.MON_2
@anchor{library/locale locale MON_3}@anchor{3f5e}
@deffnx {Dado} locale.MON_3
@anchor{library/locale locale MON_4}@anchor{3f5f}
@deffnx {Dado} locale.MON_4
@anchor{library/locale locale MON_5}@anchor{3f60}
@deffnx {Dado} locale.MON_5
@anchor{library/locale locale MON_6}@anchor{3f61}
@deffnx {Dado} locale.MON_6
@anchor{library/locale locale MON_7}@anchor{3f62}
@deffnx {Dado} locale.MON_7
@anchor{library/locale locale MON_8}@anchor{3f63}
@deffnx {Dado} locale.MON_8
@anchor{library/locale locale MON_9}@anchor{3f64}
@deffnx {Dado} locale.MON_9
@anchor{library/locale locale MON_10}@anchor{3f65}
@deffnx {Dado} locale.MON_10
@anchor{library/locale locale MON_11}@anchor{3f66}
@deffnx {Dado} locale.MON_11
@anchor{library/locale locale MON_12}@anchor{3f67}
@deffnx {Dado} locale.MON_12

Obtém o nome do enésimo dia do mês.
@end deffn

@geindex ABMON_1 (no módulo locale)
@geindex ABMON_2 (no módulo locale)
@geindex ABMON_3 (no módulo locale)
@geindex ABMON_4 (no módulo locale)
@geindex ABMON_5 (no módulo locale)
@geindex ABMON_6 (no módulo locale)
@geindex ABMON_7 (no módulo locale)
@geindex ABMON_8 (no módulo locale)
@geindex ABMON_9 (no módulo locale)
@geindex ABMON_10 (no módulo locale)
@geindex ABMON_11 (no módulo locale)
@geindex ABMON_12 (no módulo locale)
@anchor{library/locale locale ABMON_1}@anchor{3f68}
@deffn {Dado} locale.ABMON_1
@anchor{library/locale locale ABMON_2}@anchor{3f69}
@deffnx {Dado} locale.ABMON_2
@anchor{library/locale locale ABMON_3}@anchor{3f6a}
@deffnx {Dado} locale.ABMON_3
@anchor{library/locale locale ABMON_4}@anchor{3f6b}
@deffnx {Dado} locale.ABMON_4
@anchor{library/locale locale ABMON_5}@anchor{3f6c}
@deffnx {Dado} locale.ABMON_5
@anchor{library/locale locale ABMON_6}@anchor{3f6d}
@deffnx {Dado} locale.ABMON_6
@anchor{library/locale locale ABMON_7}@anchor{3f6e}
@deffnx {Dado} locale.ABMON_7
@anchor{library/locale locale ABMON_8}@anchor{3f6f}
@deffnx {Dado} locale.ABMON_8
@anchor{library/locale locale ABMON_9}@anchor{3f70}
@deffnx {Dado} locale.ABMON_9
@anchor{library/locale locale ABMON_10}@anchor{3f71}
@deffnx {Dado} locale.ABMON_10
@anchor{library/locale locale ABMON_11}@anchor{3f72}
@deffnx {Dado} locale.ABMON_11
@anchor{library/locale locale ABMON_12}@anchor{3f73}
@deffnx {Dado} locale.ABMON_12

Obtém o nome abreviado do enésimo dia do mês.
@end deffn

@geindex RADIXCHAR (no módulo locale)
@anchor{library/locale locale RADIXCHAR}@anchor{3f74}
@deffn {Dado} locale.RADIXCHAR

Obtém o caractere separador decimal (ponto decimal, vírgula decimal etc.).
@end deffn

@geindex THOUSEP (no módulo locale)
@anchor{library/locale locale THOUSEP}@anchor{3f75}
@deffn {Dado} locale.THOUSEP

Obtém o caractere separador para milhares (grupos de três dígitos).
@end deffn

@geindex YESEXPR (no módulo locale)
@anchor{library/locale locale YESEXPR}@anchor{3f76}
@deffn {Dado} locale.YESEXPR

Obtém uma expressão regular que pode ser usada com a função regex para reconhecer uma resposta positiva a uma pergunta sim/não.
@end deffn

@geindex NOEXPR (no módulo locale)
@anchor{library/locale locale NOEXPR}@anchor{3f77}
@deffn {Dado} locale.NOEXPR

Obtém uma expressão regular que pode ser usada com a função @code{regex(3)} para reconhecer uma resposta negativa a uma pergunta sim/não.

@cartouche
@quotation Nota 
As expressões regulares para @ref{3f76,,YESEXPR} e @ref{3f77,,NOEXPR} usam uma sintaxe adequada para a função @code{regex} da biblioteca C, que pode ser diferente da sintaxe usada em @ref{b9,,re}.
@end quotation
@end cartouche
@end deffn

@geindex CRNCYSTR (no módulo locale)
@anchor{library/locale locale CRNCYSTR}@anchor{3f78}
@deffn {Dado} locale.CRNCYSTR

Obtém o símbolo da moeda, precedido por “-” se o símbolo deve aparecer antes do valor, “+” se o símbolo deve aparecer após o valor ou “.” se o símbolo deve substituir o caractere separador decimal.
@end deffn

@geindex ERA (no módulo locale)
@anchor{library/locale locale ERA}@anchor{3f79}
@deffn {Dado} locale.ERA

Obtém uma string que descreva como os anos são contados e exibidos para cada era em um localidade.

A maioria das localidades não define esse valor. Um exemplo de localidade que define esse valor é o japonês. No Japão, a representação tradicional de datas inclui o nome da época correspondente ao reinado do então imperador.

Normalmente, não deve ser necessário usar esse valor diretamente. Especificar o modificador @code{E} em suas strings de formato faz com que a função @ref{1229,,time.strftime()} use essas informações. O formato da string retornada é especificado em `The Open Group Base Specifications Issue 8', parágrafo 7.3.5.2 LC_TIME C-Language Access@footnote{https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap07.html#tag_07_03_05_02}.
@end deffn

@geindex ERA_D_T_FMT (no módulo locale)
@anchor{library/locale locale ERA_D_T_FMT}@anchor{3f7a}
@deffn {Dado} locale.ERA_D_T_FMT

Obtém uma string de formato para @ref{1229,,time.strftime()} para representar a data e a hora de uma forma baseada na era específica da localidade.
@end deffn

@geindex ERA_D_FMT (no módulo locale)
@anchor{library/locale locale ERA_D_FMT}@anchor{3f7b}
@deffn {Dado} locale.ERA_D_FMT

Obtém uma string de formato para @ref{1229,,time.strftime()} para representar uma data em uma forma baseada em era específica da localidade.
@end deffn

@geindex ERA_T_FMT (no módulo locale)
@anchor{library/locale locale ERA_T_FMT}@anchor{3f7c}
@deffn {Dado} locale.ERA_T_FMT

Obtém uma string de formato para @ref{1229,,time.strftime()} para representar uma hora em uma forma baseada em era específica da localidade.
@end deffn

@geindex ALT_DIGITS (no módulo locale)
@anchor{library/locale locale ALT_DIGITS}@anchor{3f7d}
@deffn {Dado} locale.ALT_DIGITS

Obtém uma string consistindo de até 100 símbolos separados por ponto e vírgula usados para representar os valores de 0 a 99 de uma forma específica de localidade. Na maioria das localidades, esta é uma string vazia.
@end deffn
@end deffn

@geindex getdefaultlocale() (no módulo locale)
@anchor{library/locale locale getdefaultlocale}@anchor{2d9}
@deffn {Função} locale.getdefaultlocale ([envvars])

Tenta determinar as configurações de localidade padrão e as retorna como uma tupla na forma @code{(language code, encoding)}.

De acordo com POSIX, um programa que não chamou @code{setlocale(LC_ALL, '@w{'})} executa usando a localidade portátil @code{'C'}. Chamar @code{setlocale(LC_ALL, '@w{'})} permite que ele use a localidade padrão conforme definido pela variável 
@geindex LANG
@geindex variável de ambiente; LANG
@code{LANG}. Como não queremos interferir com a configuração de localidade atual, emulamos o comportamento da maneira descrita acima.

Para manter a compatibilidade com outras plataformas, não apenas a variável 
@geindex LANG
@geindex variável de ambiente; LANG
@code{LANG} é testada, mas uma lista de variáveis fornecida como parâmetro envvars. Será utilizado o primeiro encontrado a ser definido. `envvars' padroniza para o caminho de pesquisa usado no GNU gettext; deve sempre conter o nome da variável @code{'LANG'}. O caminho de pesquisa do GNU gettext contém @code{'LC_ALL'}, @code{'LC_CTYPE'}, @code{'LANG'} e @code{'LANGUAGE'}, nesta ordem.

O código de idioma tem o mesmo formato de @ref{3f44,,nome de localidade}, mas sem codificação e modificador @code{@@}. O código de idioma e a codificação podem ser @code{None} se seus valores não puderem ser determinados. O locale “C” é representado como @code{(None, None)}.


Descontinuado desde a versão 3.11, será removido na versão 3.15.

@end deffn

@geindex getlocale() (no módulo locale)
@anchor{library/locale locale getlocale}@anchor{2da}
@deffn {Função} locale.getlocale (category=LC_CTYPE)

Retorna a configuração atual para a categoria de localidade fornecida como uma tupla contendo o código de idioma e a codificação. `category' pode ser um dos valores @code{LC_*}, exceto @ref{3f7e,,LC_ALL}. O padrão é @ref{3f7f,,LC_CTYPE}.

O código de idioma tem o mesmo formato de @ref{3f44,,nome de localidade}, mas sem codificação e modificador @code{@@}. O código de idioma e a codificação podem ser @code{None} se seus valores não puderem ser determinados. O locale “C” é representado como @code{(None, None)}.
@end deffn

@geindex getpreferredencoding() (no módulo locale)
@anchor{library/locale locale getpreferredencoding}@anchor{53a}
@deffn {Função} locale.getpreferredencoding (do_setlocale=True)

Retorna a @ref{242,,codificação da localidade} usada para dados de texto, de acordo com as preferências do usuário. As preferências do usuário são expressas de maneira diferente em sistemas diferentes e podem não estar disponíveis programaticamente em alguns sistemas, portanto, essa função retorna apenas uma estimativa.

Em alguns sistemas, é necessário invocar @ref{2db,,setlocale()} para obter as preferências do usuário, portanto, esta função não é segura para thread. Se invocar setlocale não for necessário ou desejado, `do_setlocale' deve ser definido como @code{False}.

No Android ou se o @ref{656,,Modo UTF-8 do Python} é retornado, sempre retorna @code{'utf-8'}, a @ref{242,,codificação da localidade} e o argumento `do_setlocale' são ignorados.

A @ref{3f80,,pré-inicialização do Python} configura a localidade LC_CTYPE. Veja também @ref{53b,,tratador de erros e codificação do sistema de arquivos}.


Alterado na versão 3.7: A função agora sempre retorna @code{"utf-8"} no Android ou se o @ref{656,,Modo UTF-8 do Python} estiver habilitado.

@end deffn

@geindex getencoding() (no módulo locale)
@anchor{library/locale locale getencoding}@anchor{2dc}
@deffn {Função} locale.getencoding ()

Obtém a atual @ref{242,,codificação da localidade}:


@itemize *

@item 
No Android e no VxWorks, retorna @code{"utf-8"}.

@item 
No Unix, retorna a codificação da localidade @ref{3f7f,,LC_CTYPE} atual. Retorna @code{"utf-8"} se @code{nl_langinfo(CODESET)} retornar uma string vazia: por exemplo, se a localidade LC_CTYPE atual não for compatível.

@item 
No Windows, retorna a página de código ANSI.
@end itemize

A @ref{3f80,,pré-inicialização do Python} configura a localidade LC_CTYPE. Veja também @ref{53b,,tratador de erros e codificação do sistema de arquivos}.

Este função é semelhante a @ref{53a,,getpreferredencoding(False)}, exceto pelo fato de que esta função ignora o @ref{656,,Modo UTF-8 do Python}.


Adicionado na versão 3.11.

@end deffn

@geindex normalize() (no módulo locale)
@anchor{library/locale locale normalize}@anchor{3f81}
@deffn {Função} locale.normalize (localename)

Retorna um código de localidade normalizado para o nome de localidade fornecido. O código de localidade retornado é formatado para uso com @ref{2db,,setlocale()}. Se a normalização falhar, o nome original será retornado inalterado.

Se a codificação fornecida não for conhecida, o padrão da função é a codificação padrão para o código da localidade, assim como @ref{2db,,setlocale()}.
@end deffn

@geindex strcoll() (no módulo locale)
@anchor{library/locale locale strcoll}@anchor{3f82}
@deffn {Função} locale.strcoll (string1, string2)

Compara duas strings de acordo com a configuração atual @ref{3f83,,LC_COLLATE}. Como qualquer outra função de comparação, retorna um valor negativo ou positivo, ou @code{0}, dependendo se `string1' agrupa antes ou depois de `string2' ou é igual a ele.
@end deffn

@geindex strxfrm() (no módulo locale)
@anchor{library/locale locale strxfrm}@anchor{15f3}
@deffn {Função} locale.strxfrm (string)

Transforma uma string em uma que pode ser usada em comparações com reconhecimento de localidade. Por exemplo, @code{strxfrm(s1) < strxfrm(s2)} é equivalente a @code{strcoll(s1, s2) < 0}. Esta função pode ser usada quando a mesma string é comparada repetidamente, por exemplo, ao agrupar uma sequência de strings.
@end deffn

@geindex format_string() (no módulo locale)
@anchor{library/locale locale format_string}@anchor{51f}
@deffn {Função} locale.format_string (format, val, grouping=False, monetary=False)

Formata um número `val' de acordo com a configuração atual do @ref{3f45,,LC_NUMERIC}. O formato segue as convenções do operador @code{%}. Para valores de ponto flutuante, o ponto decimal é modificado, se apropriado. Se `grouping' for @code{True}, também levará em conta o agrupamento.

Se `monetary' for verdadeiro, a conversão usa o separador de milhares monetários e strings de agrupamento.

Processa especificadores de formatação como em @code{format % val}, mas leva as configurações de localidade atuais em consideração.


Alterado na versão 3.7: O parâmetro nomeado `monetary' foi adicionado.

@end deffn

@geindex currency() (no módulo locale)
@anchor{library/locale locale currency}@anchor{3f84}
@deffn {Função} locale.currency (val, symbol=True, grouping=False, international=False)

Formata um número `val' de acordo com as configurações atuais de @ref{3f47,,LC_MONETARY}.

A string retornada inclui o símbolo da moeda se `symbol' for verdadeiro, que é o padrão. Se `grouping' for @code{True} (o que não é o padrão), o agrupamento é feito com o valor. Se `international' for @code{True} (o que não é o padrão), o símbolo da moeda internacional será usado.

@cartouche
@quotation Nota 
Esta função não funcionará com a localidade ‘C’, então você deve definir uma localidade via @ref{2db,,setlocale()} primeiro.
@end quotation
@end cartouche
@end deffn

@geindex str() (no módulo locale)
@anchor{library/locale locale str}@anchor{3f85}
@deffn {Função} locale.str (float)

Formata um número de ponto flutuante usando o mesmo formato da função embutida @code{str(float)}, mas leva o ponto decimal em consideração.
@end deffn

@geindex delocalize() (no módulo locale)
@anchor{library/locale locale delocalize}@anchor{e52}
@deffn {Função} locale.delocalize (string)

Converte uma string em uma string numérica normalizada, seguindo as configurações de @ref{3f45,,LC_NUMERIC}.


Adicionado na versão 3.5.

@end deffn

@geindex localize() (no módulo locale)
@anchor{library/locale locale localize}@anchor{3f86}
@deffn {Função} locale.localize (string, grouping=False, monetary=False)

Converte uma string numérica normalizada em uma string formatada, seguindo as configurações de @ref{3f45,,LC_NUMERIC}.


Adicionado na versão 3.10.

@end deffn

@geindex atof() (no módulo locale)
@anchor{library/locale locale atof}@anchor{3f87}
@deffn {Função} locale.atof (string, func=float)

Converte uma string para um número, de acordo com o valor da constante @ref{3f45,,LC_NUMERIC}, chamando `func' com o resultado da chamada à @ref{e52,,delocalize()} em `string'.
@end deffn

@geindex atoi() (no módulo locale)
@anchor{library/locale locale atoi}@anchor{3f88}
@deffn {Função} locale.atoi (string)

Converte uma string em um número inteiro, seguindo as convenções de @ref{3f45,,LC_NUMERIC}.
@end deffn

@geindex LC_CTYPE (no módulo locale)
@anchor{library/locale locale LC_CTYPE}@anchor{3f7f}
@deffn {Dado} locale.LC_CTYPE

Categoria da localidade para as funções de tipo de caracteres. Mais importante ainda, essa categoria define a codificação do texto, ou seja, como os bytes são interpretado como pontos de código Unicode. Consulte 
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} e 
@geindex Propostas de Melhorias do Python; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} para saber como essa variável pode ser automaticamente coagida para @code{C.UTF-8} para evitar problemas criados por configurações inválidas em contêineres ou configurações incompatíveis passadas por conexões remotas com SSH.

O Python não usa internamente funções de transformação de caracteres dependente de localidade do @code{ctype.h}. Em vez disso, @code{pyctype.h} fornece equivalentes independentes de localidade como @ref{139e,,Py_TOLOWER}.
@end deffn

@geindex LC_COLLATE (no módulo locale)
@anchor{library/locale locale LC_COLLATE}@anchor{3f83}
@deffn {Dado} locale.LC_COLLATE

Categoria da localidade para classificação de strings. As funções @ref{3f82,,strcoll()} e @ref{15f3,,strxfrm()} do módulo @ref{86,,locale} são afetadas.
@end deffn

@geindex LC_TIME (no módulo locale)
@anchor{library/locale locale LC_TIME}@anchor{3f89}
@deffn {Dado} locale.LC_TIME

Categoria da localidade para a formatação de hora. A função @ref{1229,,time.strftime()} segue essas convenções.
@end deffn

@geindex LC_MONETARY (no módulo locale)
@anchor{library/locale locale LC_MONETARY}@anchor{3f47}
@deffn {Dado} locale.LC_MONETARY

Categoria da localidade para formatação de valores monetários. As opções disponíveis estão disponíveis na função @ref{c18,,localeconv()}.
@end deffn

@geindex LC_MESSAGES (no módulo locale)
@anchor{library/locale locale LC_MESSAGES}@anchor{3f8a}
@deffn {Dado} locale.LC_MESSAGES

Categoria da localidade para exibição de mensagens. Python atualmente não oferece suporte a mensagens com reconhecimento de localidade específicas da aplicação. Mensagens exibidas pelo sistema operacional, como aquelas retornadas por @ref{2d04,,os.strerror()} podem ser afetadas por esta categoria.

Esse valor pode não estar disponível em sistemas operacionais que não estejam em conformidade com o padrão POSIX, principalmente o Windows.
@end deffn

@geindex LC_NUMERIC (no módulo locale)
@anchor{library/locale locale LC_NUMERIC}@anchor{3f45}
@deffn {Dado} locale.LC_NUMERIC

Categoria da localidade para formatação de números. As funções @ref{51f,,format_string()}, @ref{3f88,,atoi()}, @ref{3f87,,atof()} e @ref{3f85,,str()} do módulo @ref{86,,locale} são afetadas por essa categoria. Todas as outras operações de formatação numérica não são afetadas.
@end deffn

@geindex LC_ALL (no módulo locale)
@anchor{library/locale locale LC_ALL}@anchor{3f7e}
@deffn {Dado} locale.LC_ALL

Combinação de todas as configurações da localidade. Se este sinalizador for usado quando a localidade for alterada, a configuração da localidade para todas as categorias será tentada. Se isso falhar para qualquer categoria, nenhuma categoria é alterada. Quando a localidade é recuperada usando este sinalizador, uma string indicando a configuração para todas as categorias é retornada. Esta string pode ser usada posteriormente para restaurar as configurações.
@end deffn

@geindex CHAR_MAX (no módulo locale)
@anchor{library/locale locale CHAR_MAX}@anchor{3f46}
@deffn {Dado} locale.CHAR_MAX

Esta é uma constante simbólica usada para diferentes valores retornados por @ref{c18,,localeconv()}.
@end deffn

@menu
* Histórico@comma{} detalhes@comma{} dicas@comma{} dicas e advertências: Histórico detalhes dicas dicas e advertências. 
* Nomes de localidades:: 
* Para escritores de extensão e programas que incorporam Python:: 
* Acesso a catálogos de mensagens:: 

@end menu

@node Histórico detalhes dicas dicas e advertências,Nomes de localidades,,locale — Serviços de internacionalização
@anchor{library/locale background-details-hints-tips-and-caveats}@anchor{3f8b}
@subsubsection Histórico, detalhes, dicas, dicas e advertências


O padrão C define a localidade como uma propriedade de todo o programa que pode ser relativamente cara para alterar. Além disso, algumas implementações são interrompidas de forma que mudanças frequentes de localidade podem causar despejos de memória. Isso torna a localidade um tanto dolorosa de usar corretamente.

Inicialmente, quando um programa é iniciado, a localidade é a localidade @code{C}, não importa qual a localidade preferida do usuário. Há uma exceção: a categoria @ref{3f7f,,LC_CTYPE} é alterada na inicialização para definir a codificação de localidade atual para a codificação de localidade preferida do usuário. O programa deve dizer explicitamente que deseja as configurações de localidade preferidas do usuário para outras categorias chamando @code{setlocale(LC_ALL, '@w{'})}.

Geralmente é uma má ideia chamar @ref{2db,,setlocale()} em alguma rotina de biblioteca, já que como efeito colateral afeta todo o programa. Salvar e restaurar é quase tão ruim: é caro e afeta outras threads que são executadas antes de as configurações serem restauradas.

Se, ao codificar um módulo para uso geral, você precisa de uma versão independente da localidade de uma operação que é afetada pela localidade (como certos formatos usados com @ref{1229,,time.strftime()}), você terá que encontrar uma maneira de faça isso sem usar a rotina de biblioteca padrão. Melhor ainda é se convencer de que não há problema em usar as configurações da localidade. Apenas como último recurso, você deve documentar que seu módulo não é compatível com configurações de localidade não-@code{C}.

A única maneira de realizar operações numéricas de acordo com a localidade é usar as funções especiais definidas por este módulo: @ref{3f87,,atof()}, @ref{3f88,,atoi()}, @ref{51f,,format_string()}, @ref{3f85,,str()}.

Não há como realizar conversões de maiúsculas e minúsculas e classificações de caracteres de acordo com a localidade. Para strings de texto (Unicode), isso é feito de acordo com o valor do caractere apenas, enquanto para strings de byte, as conversões e classificações são feitas de acordo com o valor ASCII do byte e bytes cujo bit alto está definido (ou seja, bytes não ASCII ) nunca são convertidos ou considerados parte de uma classe de caracteres, como letras ou espaços em branco.

@node Nomes de localidades,Para escritores de extensão e programas que incorporam Python,Histórico detalhes dicas dicas e advertências,locale — Serviços de internacionalização
@anchor{library/locale locale-name}@anchor{3f44}@anchor{library/locale locale-names}@anchor{3f8c}
@subsubsection Nomes de localidades


O formato do nome de localidade depende da plataforma, e o conjunto de locais suportados pode depender da configuração do sistema.

Em plataformas Posix, isso geralmente tem o formato @footnote{
@uref{https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap08.html#tag_08_02,IEEE Std 1003.1-2024; 8.2 Internationalization Variables}
}:

@example
     language ["_" territory] ["." charset] ["@@" modifier]
@end example

onde `language' é um código de idioma de duas ou três letras da ISO 639@footnote{https://www.iso.org/iso-639-language-code}, `territory' é um código de país ou região de duas letras da ISO 3166@footnote{https://www.iso.org/iso-3166-country-codes.html}, `charset' é uma codificação de localidade e `modifier' é um nome de script, uma subtag de idioma, um identificador de ordem de classificação ou outro modificador de localidade (por exemplo, “latin”, “valencia”, “stroke” e “euro”).

No Windows, vários formatos são suportados. @footnote{
@uref{https://learn.microsoft.com/pt-br/cpp/c-runtime-library/locale-names-languages-and-country-region-strings,Nomes de localidade@comma{} idiomas e strings de país/região do UCRT}
} @footnote{
@uref{https://learn.microsoft.com/pt-br/windows/win32/intl/locale-names,Nomes de localidade}
} Um subconjunto de tags IETF BCP 47@footnote{https://www.rfc-editor.org/info/bcp47}:

@example
     language ["-" script] ["-" territory] ["." charset]
     language ["-" script] "-" territory "-" modifier
@end example

onde `language' e `territory' têm o mesmo significado que em Posix, `script' é um código de script de quatro letras da ISO 15924@footnote{https://www.unicode.org/iso15924/} e `modifier' é uma subtag de idioma, um identificador de ordem de classificação ou modificador personalizado (por exemplo, “valencia”, “stroke” ou “x-python”). São aceitos os separadores hífen (@code{'-'}) e sublinhado (@code{'_'}). Somente a codificação UTF-8 é permitida para tags BCP 47.

O Windows também oferece suporte a nomes de localidade no formato:

@example
     language ["_" territory] ["." charset]
@end example

onde `language' e `territory' são nomes completos, como “English” e “United States”, e `charset' é um número de página de código (por exemplo, “1252”) ou UTF-8. Só é aceito o separador sublinhado neste formato.

A localidade “C” é aceita em todas as plataformas.

@node Para escritores de extensão e programas que incorporam Python,Acesso a catálogos de mensagens,Nomes de localidades,locale — Serviços de internacionalização
@anchor{library/locale embedding-locale}@anchor{3f8d}@anchor{library/locale for-extension-writers-and-programs-that-embed-python}@anchor{3f8e}
@subsubsection Para escritores de extensão e programas que incorporam Python


Módulos de extensão nunca devem chamar @ref{2db,,setlocale()}, exceto para descobrir qual é a localidade atual. Mas uma vez que o valor de retorno só pode ser usado portavelmente para restaurá-lo, isso não é muito útil (exceto talvez para descobrir se a localidade é ou não @code{C}).

Quando o código Python usa o módulo @ref{86,,locale} para alterar a localidade, isso também afeta a aplicação de incorporação. Se a aplicação de incorporação não quiser que isso aconteça, ele deve remover o módulo de extensão @code{_locale} (que faz todo o trabalho) da tabela de módulos embutidos no arquivo @code{config.c} e certificar-se de que o módulo @code{_locale} não está acessível como uma biblioteca compartilhada.

@node Acesso a catálogos de mensagens,,Para escritores de extensão e programas que incorporam Python,locale — Serviços de internacionalização
@anchor{library/locale access-to-message-catalogs}@anchor{3f8f}@anchor{library/locale locale-gettext}@anchor{3f90}
@subsubsection Acesso a catálogos de mensagens


@geindex gettext() (no módulo locale)
@anchor{library/locale locale gettext}@anchor{3f91}
@deffn {Função} locale.gettext (msg)
@end deffn

@geindex dgettext() (no módulo locale)
@anchor{library/locale locale dgettext}@anchor{3f92}
@deffn {Função} locale.dgettext (domain, msg)
@end deffn

@geindex dcgettext() (no módulo locale)
@anchor{library/locale locale dcgettext}@anchor{3f93}
@deffn {Função} locale.dcgettext (domain, msg, category)
@end deffn

@geindex textdomain() (no módulo locale)
@anchor{library/locale locale textdomain}@anchor{3f94}
@deffn {Função} locale.textdomain (domain)
@end deffn

@geindex bindtextdomain() (no módulo locale)
@anchor{library/locale locale bindtextdomain}@anchor{3f95}
@deffn {Função} locale.bindtextdomain (domain, dir)
@end deffn

@geindex bind_textdomain_codeset() (no módulo locale)
@anchor{library/locale locale bind_textdomain_codeset}@anchor{3f96}
@deffn {Função} locale.bind_textdomain_codeset (domain, codeset)
@end deffn

O módulo locale expõe a interface gettext da biblioteca C em sistemas que fornecem essa interface. Consiste nas funções @ref{63,,gettext()}, @ref{3f92,,dgettext()}, @ref{3f93,,dcgettext()}, @ref{3f94,,textdomain()}, @ref{3f95,,bindtextdomain()} e @ref{3f96,,bind_textdomain_codeset()}. Elas são semelhantes às mesmas funções no módulo @ref{63,,gettext}, mas usam o formato binário da biblioteca C para catálogos de mensagens e os algoritmos de pesquisa da biblioteca C para localizar catálogos de mensagens.

As aplicações Python normalmente não precisam invocar essas funções e devem usar @ref{63,,gettext} em seu lugar. Uma exceção conhecida a esta regra são os aplicativos que se vinculam a bibliotecas C adicionais que invocam internamente @code{gettext} ou @code{dcgettext}. Para essas aplicações, pode ser necessário vincular o domínio de texto, para que as bibliotecas possam localizar adequadamente seus catálogos de mensagens.

@node Interfaces gráficas de usuário com Tk,Ferramentas de Desenvolvimento,Internacionalização,A Biblioteca Padrão do Python
@anchor{library/tk doc}@anchor{3f97}@anchor{library/tk graphical-user-interfaces-with-tk}@anchor{3f98}@anchor{library/tk tkinter}@anchor{3f99}@anchor{library/tk translation-repo}@anchor{3f9a}
@section Interfaces gráficas de usuário com Tk


@geindex GUI
@geindex Interface Gráfica do Usuário
@geindex Tkinter
@geindex Tk

Tk/Tcl tem sido parte integrante do Python. Ele fornece um kit de ferramentas de janela robusto e independente de plataforma, que está disponível para programadores Python usando o pacote @ref{f0,,tkinter} e sua extensão, o módulo @ref{f9,,tkinter.ttk}.

O pacote @ref{f0,,tkinter} é uma fina camada orientada a objetos no topo do Tcl/Tk. Para usar @ref{f0,,tkinter}, você não precisa escrever o código Tcl, mas precisará consultar a documentação do Tk e, ocasionalmente, a documentação do Tcl. @ref{f0,,tkinter} é um conjunto de envólucros que implementam os widgets Tk como classes Python.

As principais virtudes do @ref{f0,,tkinter} são que ele é rápido, e que geralmente vem junto com o Python. Embora sua documentação padrão seja fraca, um bom material está disponível, que inclui: referências, tutoriais, um livro e outros. @ref{f0,,tkinter} também é famoso por ter uma aparência desatualizada, que foi amplamente melhorada no Tk 8.5. No entanto, existem muitas outras bibliotecas GUI nas quais você pode estar interessado. A wiki do Python lista várias frameworks e ferramentas GUI@footnote{https://wiki.python.org/moin/GuiProgramming} alternativas.

@menu
* tkinter — Interface Python para Tcl/Tk:: 
* tkinter.colorchooser — Diálogo de escolha de cor: tkinter colorchooser — Diálogo de escolha de cor. 
* tkinter.font — Invólucro de fontes Tkinter: tkinter font — Invólucro de fontes Tkinter. 
* Diálogos Tkinter:: 
* tkinter.messagebox — Prompts de mensagem do Tkinter: tkinter messagebox — Prompts de mensagem do Tkinter. 
* tkinter.scrolledtext — Widget de texto de rolado: tkinter scrolledtext — Widget de texto de rolado. 
* tkinter.dnd — Suporte para arrastar e soltar: tkinter dnd — Suporte para arrastar e soltar. 
* tkinter.ttk — Widgets temáticos do Tk: tkinter ttk — Widgets temáticos do Tk. 
* IDLE — editor e console Python: IDLE — editor e console Python<2>. 
* turtle — Gráficos tartaruga:: 

@end menu

@node tkinter — Interface Python para Tcl/Tk,tkinter colorchooser — Diálogo de escolha de cor,,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter doc}@anchor{3f9b}@anchor{library/tkinter module-tkinter}@anchor{f0}@anchor{library/tkinter tkinter-python-interface-to-tcl-tk}@anchor{3f9c}
@subsection @code{tkinter} — Interface Python para Tcl/Tk


@geindex module; tkinter

`Código-fonte:' Lib/tkinter/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/__init__.py}


__________________________________________________________________


O pacote @ref{f0,,tkinter} (“Tk interface”) é a interface padrão do Python e faz parte do kit de ferramentas Tcl/Tk GUI. Tanto o Tk quanto o @ref{f0,,tkinter} estão disponíveis na maioria das plataformas Unix, incluindo macOS, bem como em sistemas Windows.

Executar @code{python -m tkinter} na linha de comando deve abrir uma janela demonstrando uma interface Tk simples, informando que @ref{f0,,tkinter} está apropriadamente instalado em seu sistema, e também mostrando qual versão do Tcl/Tk está instalado, para que você possa ler a documentação do Tcl/Tk específica para essa versão.

Tkinter tem suporte a uma gama de versões Tcl/Tk, compiladas com ou sem suporte a thread. O lançamento oficial do binário Python agrupa Tcl/Tk 8.6 em thread. Veja o código-fonte do módulo @ref{3,,_tkinter} para mais informações sobre as versões suportadas.

O Tkinter não é um invólucro fino, mas adiciona uma boa quantidade de sua própria lógica para tornar a experiência mais pythônica. Esta documentação se concentrará nessas adições e mudanças, e consulte a documentação oficial do Tcl/Tk para detalhes que não foram alterados.

@cartouche
@quotation Nota 
Tcl/Tk 8.5 (2007) introduziu um conjunto moderno de componentes de interface de usuário para ser usados com a nova API. As APIs antigas e novas ainda estão disponíveis. A maioria da documentação que você encontrará online ainda usa a API antiga e pode estar desatualizada.
@end quotation
@end cartouche


@subsubheading Ver também



@itemize *

@item 

@table @asis

@item TkDocs@footnote{https://tkdocs.com/}

Um extenso tutorial sobre como criar interfaces de usuário com o Tkinter. Explica conceitos chave, e ilustra as abordagens recomendadas usando a API moderna.
@end table

@item 

@table @asis

@item Referência do Tkinter 8.5: uma GUI para Python@footnote{https://www.tkdocs.com/shipman/'}

Documentação de referência para Tkinter 8.5 detalhando classes, métodos e opções disponíveis.
@end table
@end itemize

Recursos Tcl/Tk:


@itemize *

@item 

@table @asis

@item Comandos Tk@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm}

Referência abrangente para cada um dos comandos Tcl/Tk subjacentes usados pelo Tkinter.
@end table

@item 

@table @asis

@item Tcl/Tk Website@footnote{https://www.tcl.tk}

Documentação adicional e links para o desenvolvimento do core do Tcl/Tk.
@end table
@end itemize

Livros:


@itemize *

@item 

@table @asis

@item Modern Tkinter for Busy Python Developers@footnote{https://tkdocs.com/book.html}

Por Mark Roseman. (ISBN 978-1999149567)
@end table

@item 

@table @asis

@item Python GUI programming with Tkinter@footnote{https://www.packtpub.com/en-br/product/python-gui-programming-with-tkinter-9781788835886}

por Alan D. Moore. (ISBN 978-1788835886)
@end table

@item 

@table @asis

@item Programming Python@footnote{https://learning-python.com/about-pp4e.html}

Por Mark Lutz; tem uma excelente cobertura sobre o Tkinter. (ISBN 978-0596158101)
@end table

@item 

@table @asis

@item Tcl and the Tk Toolkit (2nd edition)@footnote{https://www.amazon.com/exec/obidos/ASIN/032133633X}

Por John Ousterhout, criador do Tcl/Tk, e Ken Jones; não cobre o Tkinter. (ISBN 978-0321336330)
@end table
@end itemize


@menu
* Arquitetura:: 
* Módulos Tkinter:: 
* Preservador de vida Tkinter:: 
* Modelo de threading:: 
* Referência Útil:: 
* Tratadores de arquivos:: 

@end menu

@node Arquitetura,Módulos Tkinter,,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter architecture}@anchor{3f9d}
@subsubsection Arquitetura


Tcl/Tk não é uma biblioteca única mas consiste em alguns módulos distintos, cada um com sua própria funcionalidade e sua própria documentação oficial. As versões binárias do Python também incluem um módulo adicional junto com ele.


@table @asis

@item Tcl

Tcl é uma linguagem de programação interpretada dinâmica, assim como Python. Embora possa ser usado sozinho como uma linguagem de programação de propósito geral, é mais comumente embutido em aplicativos C como um mecanismo de script ou uma interface para o kit de ferramentas Tk. A biblioteca Tcl tem uma interface C para criar e gerenciar uma ou mais instâncias de um interpretador Tcl, executar comandos e scripts Tcl nessas instâncias e adicionar comandos personalizados implementados em Tcl ou C. Cada interpretador tem uma fila de eventos, e há instalações para enviar eventos e processá-los. Ao contrário do Python, o modelo de execução do Tcl é projetado em torno da multitarefa cooperativa, e o Tkinter faz a ponte entre essa diferença (veja @ref{3f9e,,Modelo de threading} para detalhes).

@item Tk

Tk é um pacote Tcl@footnote{https://wiki.tcl-lang.org/37432}  implementado em C que adiciona comandos personalizados para criar e manipular widgets GUI. Cada objeto @ref{1722,,Tk} incorpora sua própria instância do interpretador Tcl com Tk carregado nele. Os widgets do Tk são muito personalizáveis, embora ao custo de uma aparência desatualizada. Tk usa a fila de eventos do Tcl para gerar e processar eventos da GUI.

@item Ttk

Themed Tk (Ttk) é uma família mais recente de widgets Tk que fornecem uma aparência muito melhor em diferentes plataformas do que muitos dos widgets Tk clássicos. O Ttk é distribuído como parte do Tk, começando com o Tk versão 8.5. As ligações Python são fornecidas em um módulo separado, @ref{f9,,tkinter.ttk}.
@end table

Internamente, Tk e Ttk usam recursos do sistema operacional, ou seja, Xlib no Unix/X11, Cocoa no macOS, GDI no Windows.

Quando sua aplicação Python usa uma classe do Tkinter, por exemplo, para criar um widget, o módulo @ref{f0,,tkinter} primeiro monta uma sequência de comando Tcl/Tk. Ele passa essa sequência de comando Tcl para um módulo binário interno @ref{3,,_tkinter}, que então chama o interpretador Tcl para avaliá-lo. O interpretador Tcl então chamará os pacotes Tk e/ou Ttk, que por sua vez farão chamadas para Xlib, Cocoa ou GDI.

@node Módulos Tkinter,Preservador de vida Tkinter,Arquitetura,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter tkinter-modules}@anchor{3f9f}
@subsubsection Módulos Tkinter


O suporte para Tkinter está espalhado por vários módulos. A maioria dos aplicativos precisará do módulo @ref{f0,,tkinter} principal, bem como do módulo @ref{f9,,tkinter.ttk}, que fornece o conjunto de widgets temáticos modernos e a API:

@example
from tkinter import *
from tkinter import ttk
@end example

@geindex Tk (classe em tkinter)
@anchor{library/tkinter tkinter Tk}@anchor{1722}
@deffn {Classe} tkinter.Tk (screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)

Construa um Tk widget de alto nível, sendo esse, geralmente, a janela principal de uma aplicação, e inicialize um interpretador Tcl para esse widget. Cada instância tem seu próprio interpretador Tcl associado.

A classe @ref{1722,,Tk} normalmente é instanciada usando todos os valores padrão. No entanto, os seguintes argumentos nomeados são reconhecidos atualmente:


@table @asis

@item `screenName'

Quando fornecido (como uma string), define a variável de ambiente 
@geindex DISPLAY
@geindex variável de ambiente; DISPLAY
@code{DISPLAY}. (Somente X11)

@item `baseName'

Nome do arquivo de perfil. Por padrão, `baseName' é derivado do nome do programa (@code{sys.argv[0]}).

@item `className'

Nome da classe widget. Usado como um arquivo de perfil e também como o nome com o qual Tcl é invocado (`argv0' em `interp').

@item `useTk'

Se @code{True}, inicialize o subsistema Tk. A função @ref{3fa0,,tkinter.Tcl()} define isso como @code{False}.

@item `sync'

Se @code{True}, execute todos os comandos do servidor X de forma síncrona, para que os erros sejam relatados imediatamente. Pode ser usado para depuração. (Somente X11)

@item `use'

Especifica o `id' da janela na qual inserir a aplicação, em vez de criá-la como uma janela de nível superior separada. O `id' deve ser especificado da mesma forma que o valor da opção -use para widgets de nível superior (ou seja, tem um formato como o retornado por @code{winfo_id()}).

Observe que em algumas plataformas isso só funcionará corretamente se `id' se referir a um frame Tk ou nível superior que tenha sua opção -container habilitada.
@end table

@ref{1722,,Tk} lê e interpreta os arquivos de perfil, chamados @code{.`className'.tcl} e @code{.`baseName'.tcl}, por meio do interpretador Tcl e chama @ref{17f,,exec()} no conteúdo de @code{.`className'.py} e @code{.`baseName'.py}. O caminho para os arquivos de perfil encontra-se na variável de ambiente 
@geindex HOME
@geindex variável de ambiente; HOME
@code{HOME} ou, se não estiver definida, então @ref{2990,,os.curdir}.

@geindex tk (atributo tkinter.Tk)
@anchor{library/tkinter tkinter Tk tk}@anchor{3fa1}
@deffn {Atributo} tk

Objeto da aplicação Tk criado ao instanciar @ref{1722,,Tk}. Isso fornece acesso ao interpretador Tcl. Cada widget anexado à mesma instância de @ref{1722,,Tk} tem o mesmo valor para o atributo @ref{3fa1,,tk}.
@end deffn

@geindex master (atributo tkinter.Tk)
@anchor{library/tkinter tkinter Tk master}@anchor{3fa2}
@deffn {Atributo} master

The widget object that contains this widget.  For @ref{1722,,Tk}, the
@code{master} is @ref{675,,None} because it is the main window.  The terms
`master' and `parent' are similar and sometimes used interchangeably
as argument names; however, calling @code{winfo_parent()} returns a
string of the widget name whereas @code{master} returns the object.
`parent'/`child' reflects the tree-like relationship while
`master' (or `container')/`content' reflects the container structure.
@end deffn

@geindex children (atributo tkinter.Tk)
@anchor{library/tkinter tkinter Tk children}@anchor{3fa3}
@deffn {Atributo} children

Descendentes diretos deste widget como um @ref{256,,dict} com os nomes do widget filho como a chave e os objetos de instância filho como o valor.
@end deffn
@end deffn

@geindex Tcl() (no módulo tkinter)
@anchor{library/tkinter tkinter Tcl}@anchor{3fa0}
@deffn {Função} tkinter.Tcl (screenName=None, baseName=None, className='Tk', useTk=False)

A função @ref{3fa0,,Tcl()} é uma função fábrica que cria um objeto assim como o criado pela classe @ref{1722,,Tk}, exceto por não inicializar o subsistema Tk. Isto é útil quando executando o interpretador Tcl em um ambiente onde não se quer criar janelas de alto nível externas, ou quando não se pode (como em sistemas Unix/Linux sem um servidor X). Um objeto criado pelo objeto @ref{3fa0,,Tcl()} pode ter uma janela de alto nível criada (e o subsistema Tk inicializado) chamando o método @code{loadtk()}.
@end deffn

Os módulos que fornecem suporte ao Tk incluem:


@table @asis

@item @ref{f0,,tkinter}

Módulo principal Tkinter.

@item @ref{f1,,tkinter.colorchooser}

Caixa de diálogo para permitir que o usuário escolha uma cor.

@item @ref{f2,,tkinter.commondialog}

Classe base para os diálogos definidos nos outros módulos listados aqui.

@item @ref{f4,,tkinter.filedialog}

Diálogos comuns para permitir ao usuário especificar um arquivo para abrir ou salvar.

@item @ref{f5,,tkinter.font}

Utilitários para ajudar a trabalhar com fontes.

@item @ref{f6,,tkinter.messagebox}

Acesso às caixas de diálogo padrão do Tk.

@item @ref{f7,,tkinter.scrolledtext}

Componente de texto com uma barra de rolagem vertical integrada.

@item @ref{f8,,tkinter.simpledialog}

Diálogos básicos e funções de conveniência.

@item @ref{f9,,tkinter.ttk}

Conjunto de widgets temáticos introduzidos no Tk 8.5, fornecendo alternativas modernas para muitos dos widgets clássicos no módulo principal @ref{f0,,tkinter}.
@end table

Módulos adicionais:

@geindex module; _tkinter
@anchor{library/tkinter module-_tkinter}@anchor{3}

@table @asis

@item @ref{3,,_tkinter}

Um módulo binário que contém a interface de baixo nível para Tcl/Tk. Ele é importado automaticamente pelo módulo principal @ref{f0,,tkinter} e nunca deve ser usado diretamente. Geralmente é uma biblioteca compartilhada (ou DLL), mas pode, em alguns casos, ser vinculada estaticamente ao interpretador Python.

@item @ref{73,,idlelib}

Ambiente Integrado de Desenvolvimento e Aprendizagem do Python (IDLE). Baseado em @ref{f0,,tkinter}.

@item @code{tkinter.constants}

Constantes simbólicas que podem ser usadas no lugar de strings ao passar vários parâmetros para chamadas Tkinter. Este módulo é importado automaticamente pelo módulo principal @ref{f0,,tkinter}.

@item @ref{f3,,tkinter.dnd}

(experimental) Suporte de arrastar e soltar para @ref{f0,,tkinter}. Será descontinuado quando for substituído pelo Tk DND.

@item @ref{101,,turtle}

Gráficos tartaruga em uma janela Tk.
@end table

@node Preservador de vida Tkinter,Modelo de threading,Módulos Tkinter,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter tkinter-life-preserver}@anchor{3fa4}
@subsubsection Preservador de vida Tkinter


Esta seção não foi projetada para ser um tutorial exaustivo sobre Tk ou Tkinter. Para isso, consulte um dos recursos externos mencionados anteriormente. Em vez disso, esta seção fornece uma orientação muito rápida sobre como é uma aplicação Tkinter, identifica os conceitos fundamentais do Tk e explica como o wrapper do Tkinter é estruturado.

O restante desta seção ajudará a identificar as classes, métodos e opções que você precisará em uma aplicação Tkinter e onde encontrar documentação mais detalhada sobre isso, inclusive no guia de referência oficial do Tcl/Tk.

@menu
* Um programa Olá Mundo:: 
* Conceitos importantes do Tk:: 
* Entendendo como Tkinter envolve Tcl/Tk:: 
* Como é que eu…? Que opção faz…?:: 
* Navegando no Manual de Referência Tcl/Tk:: 

@end menu

@node Um programa Olá Mundo,Conceitos importantes do Tk,,Preservador de vida Tkinter
@anchor{library/tkinter a-hello-world-program}@anchor{3fa5}
@subsubsection Um programa Olá Mundo


Começaremos a explorar o Tkinter através de uma simples aplicação “Hello World”. Esta não é a menor aplicação que poderíamos escrever, mas tem o suficiente para ilustrar alguns conceitos-chave que você precisa 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

Após as importações, a próxima linha será criar a instância da classe @code{Tk} que inicia Tk e cria o interpretador associado a Tcl. Ele também cria uma janela de nível superior, conhecida como janela raiz, que serve como a janela principal da aplicação.

A linha a seguir cria um frame widget , que neste caso conterá um rótulo e um botão que criaremos a seguir. O frame se encaixa dentro da janela raiz.

A próxima linha cria um rótulo widget contendo uma string de texto estático. O método @code{grid()} é utilizado para especificar o layout relativo (posição) do rótulo dentro do frame widget, semelhante a como as tabelas em HTML funcionam.

Então um widget de botão é criado, e posicionado à direita do rótulo. Quando pressionado, irá chamar o método @code{destroy()} da janela raiz.

Por fim, o método @code{destroy()} coloca tudo no display, e responde à entrada do usuário até que o programa termine.

@node Conceitos importantes do Tk,Entendendo como Tkinter envolve Tcl/Tk,Um programa Olá Mundo,Preservador de vida Tkinter
@anchor{library/tkinter important-tk-concepts}@anchor{3fa6}
@subsubsection Conceitos importantes do Tk


Mesmo com este programa simples, os conceitos-chave do Tk podem ser mostrados:


@table @asis

@item widgets

A interface de usuário do Tkinter é composta de `widgets' individuais. Cada widget é representado como um objeto Python, instanciado de classes como @code{ttk.Frame}, @code{ttk.Label}, e @code{ttk.Button}.

@item hierarquia dos widgets

Os widgets são organizados em uma `hierarquia'. O rótulo e botão estavam contidos em um frame, que por sua vez estava contido na janela raiz. Quando criamos um widget `filho', seu widget `pai' é passado como primeiro argumento para o construtor do widget.

@item opções de configuração

Widgets possuem `opções de configuração', que modificam sua aparência e comportamento, como o texto a ser exibido em um rótulo ou botão. Diferentes classes de widgets terão diferentes conjuntos de opções.

@item gerenciamento de geometria

Os widgets não são automaticamente adicionados à interface de usuário quando eles são criados. Um `gerenciador de geometria' como @code{grid} controla onde na interface de usuário eles são colocados.

@item loop de eventos

O Tkinter reage à entrada do usuário, muda de seu programa, e até mesmo atualiza a tela somente ao executar ativamente um `loop de eventos'. Se o seu programa não estiver executando o loop de eventos, sua interface de usuário não será atualizada.
@end table

@node Entendendo como Tkinter envolve Tcl/Tk,Como é que eu…? Que opção faz…?,Conceitos importantes do Tk,Preservador de vida Tkinter
@anchor{library/tkinter understanding-how-tkinter-wraps-tcl-tk}@anchor{3fa7}
@subsubsection Entendendo como Tkinter envolve Tcl/Tk


Quando a sua aplicação utiliza as classes e métodos do Tkinter, internamente o Tkinter está montando strings representando comandos Tcl/Tk e executando esses comandos no interpretador Tcl anexado à instância @code{Tk} de sua aplicação.

Seja tentando navegar na documentação de referência, tentando encontrar o método ou opção certa, adaptando algum código existente ou depurando seu aplicativo Tkinter, há momentos em que será útil entender como são os comandos Tcl/Tk subjacentes.

Para ilustrar, aqui está o equivalente Tcl/Tk da parte principal do script Tkinter acima.

@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

A sintaxe do Tcl é semelhante a muitas linguagens de shell, onde a primeira palavra é o comando a ser executado, seguido de argumentos para esse comando separados por espaços. Sem entrar em muitos detalhes, observe o seguinte:


@itemize *

@item 
Os comandos usados para criar widgets (como @code{ttk::frame}) correspondem a classes de widgets no Tkinter.

@item 
As opções de widget Tcl (como @code{-text}) correspondem a argumentos nomeados no Tkinter.

@item 
Widgets são referenciados por um `pathname' em Tcl (like @code{.frm.btn}), enquanto o Tkinter não utiliza nomes, mas referências a objetos.

@item 
O lugar de um widget na hierarquia widget é codificado em seu pathname (hierárquico), que utiliza um @code{.} (ponto) como um separador de caminho. O pathname para a janela raiz é apenas @code{.} (ponto). No Tkinter, a hierarquia é definida não pelo pathname, mas pela especificação do widget pai ao criar cada widget filho.

@item 
Operações que são implementadas como `comandos' separados em Tcl (como @code{grid} ou @code{destroy}) são representadas como `métodos' em objetos de widget Tkinter. Como você verá em breve, em outras ocasiões o Tcl usa o que parecem ser chamadas de método em objetos widget, que espelham mais de perto o que é usado no Tkinter.
@end itemize

@node Como é que eu…? Que opção faz…?,Navegando no Manual de Referência Tcl/Tk,Entendendo como Tkinter envolve Tcl/Tk,Preservador de vida Tkinter
@anchor{library/tkinter how-do-i-what-option-does}@anchor{3fa8}
@subsubsection Como é que eu…? Que opção faz…?


Se você não tem certeza de como fazer algo no Tkinter e não consegue encontrá-lo imediatamente no tutorial ou na documentação de referência que está usando, existem algumas estratégias que podem ser úteis.

Primeiro, lembre-se de que os detalhes de como os widgets individuais funcionam podem variar entre diferentes versões tanto do Tkinter quanto do Tcl/Tk. Se você estiver procurando por documentação, certifique-se de que corresponda às versões do Python e Tcl/Tk instaladas em seu sistema.

Ao procurar como usar uma API, é útil saber o nome exato da classe, opção ou método que você está usando. A introspecção, seja em um console Python interativo ou com a @ref{fa9,,print()}, pode ajudar a identificar o que você precisa.

Para descobrir quais opções de configuração estão disponíveis em qualquer widget, chame o método @code{configure()}, que retorna um dicionário contendo uma variedade de informações sobre cada objeto, incluindo seus valores padrão e atuais. Use @code{keys()} para obter apenas os nomes de cada opção.

@example
btn = ttk.Button(frm, ...)
print(btn.configure().keys())
@end example

Como a maioria dos widgets tem muitas opções de configuração em comum, pode ser útil descobrir quais são específicas para uma determinada classe de widget. Comparar a lista de opções com a de um widget mais simples, como um frame, é uma maneira de fazer isso.

@example
print(set(btn.configure().keys()) - set(frm.configure().keys()))
@end example

Da mesma forma, você pode encontrar os métodos disponíveis para um objeto widget usando a função padrão @ref{632,,dir()}. Se você tentar, verá que existem mais de 200 métodos comuns de widget, então identificar aqueles específicos para uma classe de widget é útil.

@example
print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))
@end example

@node Navegando no Manual de Referência Tcl/Tk,,Como é que eu…? Que opção faz…?,Preservador de vida Tkinter
@anchor{library/tkinter navigating-the-tcl-tk-reference-manual}@anchor{3fa9}
@subsubsection Navegando no Manual de Referência Tcl/Tk


Como observado, o manual (páginas man) de referência oficial dos comandos Tk@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm} é frequentemente a descrição mais precisa do que operações específicas em widgets fazem. Mesmo quando você sabe o nome da opção ou método que você precisa, você ainda pode ter alguns lugares para procurar.

Enquanto todas as operações no Tkinter são implementadas como chamadas de método em objetos de widget, você viu que muitas operações Tcl/Tk aparecem como comandos que recebem um caminho de widget como seu primeiro parâmetro, seguido de parâmetros opcionais, por exemplo.

@example
destroy .
grid .frm.btn -column 0 -row 0
@end example

Outros, no entanto, parecem mais com métodos chamados em um objeto widget (na verdade, quando você cria um widget em Tcl/Tk, ele cria um comando Tcl com o nome do caminho do widget, sendo o primeiro parâmetro desse comando o nome de um método a ser chamado).

@example
.frm.btn invoke
.frm.lbl configure -text "Goodbye"
@end example

Na documentação oficial de referência do Tcl/Tk, você encontrará a maioria das operações que se parecem com chamadas de método na página man de um widget específico (por exemplo, você encontrará o método @code{invoke()} na página man do ttk::button@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_button.htm}), enquanto as funções que recebem um widget como parâmetro geralmente têm sua própria página man (por exemplo, grid@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/grid.htm}).

Você encontrará muitas opções e métodos comuns nas páginas man options@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/options.htm} e ttk::widget@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_widget.htm}, enquanto outros são encontrados na página man para uma classe de widget específica.

Você também encontrará que muitos métodos do Tkinter têm nomes compostos, por exemplo, @code{winfo_x()}, @code{winfo_height()}, @code{winfo_viewable()}. Você encontra documentação para todos eles na página man winfo@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/winfo.htm}.

@cartouche
@quotation Nota 
De forma bem confusa, também existem métodos em todos os widgets do Tkinter que na verdade não operam no widget, mas operam em um escopo global, independente de qualquer widget. Exemplos são métodos para acessar a área de transferência ou o sinal do sistema. (Eles são implementados como métodos na classe base @code{Widget} da qual todos os widgets do Tkinter herdam).
@end quotation
@end cartouche

@node Modelo de threading,Referência Útil,Preservador de vida Tkinter,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter threading-model}@anchor{3f9e}
@subsubsection Modelo de threading


Python e Tcl/Tk têm modelos de threading muito diferentes, que @ref{f0,,tkinter} tenta fazer a ponte. Se você usa threads, pode precisar estar ciente disso.

Um interpretador Python pode ter muitas threads associados a ele. Em Tcl, várias threads podem ser criadas, mas cada thread tem uma instância de interpretador Tcl separada associada a ele. Threads também podem criar mais de uma instância do interpretador, embora cada instância do interpretador possa ser usada apenas pela thread que a criou.

Cada objeto @code{Tk} criado por @ref{f0,,tkinter} contém um interpretador Tcl. Ele também controla qual thread criou aquele interpretador. Chamadas para @ref{f0,,tkinter} podem ser feitas a partir de qualquer thread do Python. Internamente, se uma chamada vier de um thread diferente daquele que criou o objeto @code{Tk}, um evento é postado na fila de eventos do interpretador e, quando executado, o resultado é retornado ao thread de chamada do Python.

As aplicações Tcl/Tk são normalmente orientadas a eventos, o que significa que após a inicialização, o interpretador executa um laço de eventos (ou seja @code{Tk.mainloop()}) e responde aos eventos. Por ser de thread única, os tratadores de eventos devem responder rapidamente, caso contrário, bloquearão o processamento de outros eventos. Para evitar isso, quaisquer cálculos de longa execução não devem ser executados em um tratador de eventos, mas são divididos em pedaços menores usando temporizadores ou executados em outra thread. Isso é diferente de muitos kits de ferramentas de GUI em que a GUI é executada em um thread completamente separado de todo o código do aplicação, incluindo tratadores de eventos.

Se o interpretador Tcl não estiver executando o laço de eventos e processando eventos, qualquer chamada @ref{f0,,tkinter} feita de threads diferentes daquela que está executando o interpretador do Tcl irá falhar.

Existem vários casos especiais:


@itemize *

@item 
Bibliotecas Tcl/Tk podem ser construídas de forma que não reconheçam thread. Neste caso, @ref{f0,,tkinter} chama a biblioteca da thread originadora do Python, mesmo que seja diferente da thread que criou o interpretador Tcl. Uma trava global garante que apenas uma chamada ocorra por vez.

@item 
Enquanto @ref{f0,,tkinter} permite que você crie mais de uma instância de um objeto @code{Tk} (com seu próprio interpretador), todos os interpretadores que fazem parte da mesma thread compartilham uma fila de eventos comum, o que fica muito rápido. Na prática, não crie mais de uma instância de @code{Tk} por vez. Caso contrário, é melhor criá-los em threads separadas e garantir que você esteja executando uma construção Tcl/Tk com reconhecimento de thread.

@item 
Bloquear manipuladores de eventos não é a única maneira de evitar que o interpretador Tcl entre novamente no laço de eventos. É ainda possível executar vários laços de eventos aninhados ou abandonar totalmente o laço de eventos. Se você estiver fazendo algo complicado quando se trata de eventos ou threads, esteja ciente dessas possibilidades.

@item 
Existem algumas funções de seleção do @ref{f0,,tkinter} que atualmente funcionam apenas quando chamadas a partir da thread que criou o interpretador Tcl.
@end itemize

@node Referência Útil,Tratadores de arquivos,Modelo de threading,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter handy-reference}@anchor{3faa}
@subsubsection Referência Útil


@menu
* Opções de Definição:: 
* O Empacotador:: 
* Opções do Empacotador:: 
* Acoplando Variáveis de Widgets:: 
* O Gerenciador de Janela:: 
* Opções de Tipos de Dados do Tk:: 
* Ligações e Eventos:: 
* O Parâmetro index:: 
* Imagens:: 

@end menu

@node Opções de Definição,O Empacotador,,Referência Útil
@anchor{library/tkinter setting-options}@anchor{3fab}@anchor{library/tkinter tkinter-setting-options}@anchor{3fac}
@subsubsection Opções de Definição


As opções controlam coisas como a cor e a largura da borda de um widget. As opções podem ser definidas de três maneiras:


@table @asis

@item No momento da criação do objeto, usando argumentos nomeados

@example
fred = Button(self, fg="red", bg="blue")
@end example

@item Após a criação do objeto, tratando o nome da opção como um índice de dicionário

@example
fred["fg"] = "red"
fred["bg"] = "blue"
@end example

@item Use o método config() para atualizar vários attrs posteriores à criação do objeto

@example
fred.config(fg="red", bg="blue")
@end example
@end table

Para uma explicação completa de uma dada opção e seu comportamento, veja as páginas man do Tk para o widget em questão.

Note que as páginas man listam “OPÇÕES PADRÃO” e “OPÇÕES DE WIDGET ESPECÍFICO” para cada widget. A primeira é uma lista de opções que são comuns a vários widgets, e a segunda são opções que são idiossincráticas ao widget em particular. As Opções Padrão estão documentadas na página man @code{options(3)@footnote{https://manpages.debian.org/options(3)}}.

Nenhuma distinção entre as opções padrão e específicas de widget são feitas neste documento. Algumas opções não se aplicam a alguns tipos de widgets. A resposta de um dado widget a uma opção particular depende da classe do widget; botões possuem a opção @code{command}, etiquetas não.

As opções suportadas por um dado widget estão listadas na página man daquele widget, ou podem ser consultadas no tempo de execução chamando o método @code{config()} sem argumentos, ou chamando o método @code{keys()} daquele widget. O valor retornado por essas chamadas é um dicionário cujas chaves são os nomes das opções como uma string (por exemplo, @code{'relief'}) e cujos valores são tuplas de 5 elementos.

Algumas opções, como @code{bg} são sinônimos para opções comuns com nomes mais longos (@code{bg} é a abreviação de “background”, ou plano de fundo em inglês). Passando o nome de uma opção abreviada ao método @code{config()} irá retornar uma tupla de 2 elementos, e não uma tupla de 5 elementos. A tupla de 2 elementos devolvida irá conter o nome do sinônimo e a opção “verdadeira” (como por exemplo em @code{('bg', 'background')}).


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@tab

Exemplo

@item

0

@tab

nome da opção

@tab

@code{'relief'}

@item

1

@tab

nome da opção para buscas de banco de dados

@tab

@code{'relief'}

@item

2

@tab

classe de opção para busca de banco de dados

@tab

@code{'Relief'}

@item

3

@tab

valor padrão

@tab

@code{'raised'}

@item

4

@tab

valor atual

@tab

@code{'groove'}

@end multitable


Exemplo:

@example
>>> print(fred.config())
@{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')@}
@end example

É claro que o dicionário exibido irá incluir todas as opções disponíveis e seus valores. Isso foi apenas um exemplo.

@node O Empacotador,Opções do Empacotador,Opções de Definição,Referência Útil
@anchor{library/tkinter the-packer}@anchor{3fad}
@subsubsection O Empacotador


@geindex empacotamento (widgets)

The packer is one of Tk’s geometry-management mechanisms.    Geometry managers
are used to specify the relative positioning of widgets within their container.
In contrast to the more cumbersome `placer' (which is
used less commonly, and we do not cover here), the packer takes qualitative
relationship specification - `above', `to the left of', `filling', etc - and
works everything out to determine the exact placement coordinates for you.

The size of any container widget is determined by the size of the “content widgets”
inside.  The packer is used to control where content widgets appear inside the
container into which they are packed.  You can pack widgets into frames, and frames
into other frames, in order to achieve the kind of layout you desire.
Additionally, the arrangement is dynamically adjusted to accommodate incremental
changes to the configuration, once it is packed.

Note que os widgets não aparecem até que eles tenham sua geometria especificada pelo gerenciador de geometria. É um erro comum de iniciantes deixar a geometria de fora da especificação, então se surpreender que o widget é criado sendo que nada apareceu. O widget irá aparecer apenas quando tiver, por exemplo, o método método @code{pack()} do empacotador aplicado a ele.

O método pack() pode ser chamado com pares de palavra reservada-opção/valor que controlam onde o widget deverá aparecer dentro do seu contêiner, e como deverá se comportar quando a janela da aplicação principal for redimensionada. Aqui estão alguns exemplos:

@example
fred.pack()                     # tem como padrão side = "top"
fred.pack(side="left")
fred.pack(expand=1)
@end example

@node Opções do Empacotador,Acoplando Variáveis de Widgets,O Empacotador,Referência Útil
@anchor{library/tkinter packer-options}@anchor{3fae}
@subsubsection Opções do Empacotador


Para uma informação mais completa do empacotador e as opções que pode receber, veja as páginas man e a página 183 do livro do John Ousterhout.


@table @asis

@item anchor

Anchor type.  Denotes where the packer is to place each content in its parcel.

@item expand

Booleano, @code{0} ou @code{1}.

@item fill

Valores legais: @code{'x'}, @code{'y'}, @code{'both'}, @code{'none'}.

@item ipadx e ipady

A distance - designating internal padding on each side of the content.

@item padx e pady

A distance - designating external padding on each side of the content.

@item side

Valores legais são: @code{'left'}, @code{'right'}, @code{'top'}, @code{'bottom'}.
@end table

@node Acoplando Variáveis de Widgets,O Gerenciador de Janela,Opções do Empacotador,Referência Útil
@anchor{library/tkinter coupling-widget-variables}@anchor{3faf}
@subsubsection Acoplando Variáveis de Widgets


A definição do valor atual de alguns widgets (como widgets de entrada de texto) podem ser conectadas diretamente às variáveis da aplicação utilizando métodos especiais. Estas opções são @code{variable}, @code{textvariable}, @code{onvalue}, @code{offvalue}, e @code{value}. A conexão funciona por ambos os lados: Se por algum motivo a variável se altera, o widget ao qual ela está conectada irá se atualizar para refletir este novo valor.

Infelizmente, na atual implementação do @ref{f0,,tkinter} não é possível passar uma variável Python arbitrária para um widget por uma opção @code{variable} ou @code{textvariable}. Os únicos tipos de variáveis para as quais isso funciona são variáveis que são subclasses da classe chamada Variable, definida em @ref{f0,,tkinter}.

Há muitas subclasses de Variable úteis já definidas: @code{StringVar}, @code{IntVar}, @code{DoubleVar}, e @code{BooleanVar}. Para ler o atual valor de uma variável, chame o método @code{get()} nelas, e para alterar o valor você deve chamar o método @code{set()}. Se você seguir este protocolo, o widget irá sempre acompanhar os valores da variável, sem nenhuma intervenção da sua parte.

Por exemplo:

@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()

        # Cria a variável da aplicação.
        self.contents = tk.StringVar()
        # Define-a com algum valor.
        self.contents.set("this is a variable")
        # Fala para o widget de entrada para monitorar essa variável.
        self.entrythingy["textvariable"] = self.contents

        # Define um retorno de chamada para quando o usuário pressionar Enter.
        # Isso imprime o valor atual da variável.
        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 O Gerenciador de Janela,Opções de Tipos de Dados do Tk,Acoplando Variáveis de Widgets,Referência Útil
@anchor{library/tkinter the-window-manager}@anchor{3fb0}
@subsubsection O Gerenciador de Janela


@geindex gerenciador de janela (widgets)

No Tk, existe um comando utilitário, @code{wm}, para interagir com o gerenciador de janelas. As opções do comando @code{wm} permitem que você controle coisas como títulos, localização, ícones bitmap, entre outros. No @ref{f0,,tkinter}, estes comandos foram implementados como métodos da classe @code{Wm} class. Widgets de mais alto nível são subclasses da classe @code{Wm} e portanto podem chamar os métodos @code{Wm} diretamente.

To get at the toplevel window that contains a given widget, you can often just
refer to the widget’s @code{master}.  Of course if the widget has been packed inside of
a frame, the @code{master} won’t represent a toplevel window.  To get at the toplevel
window that contains an arbitrary widget, you can call the @code{_root()} method.
This method begins with an underscore to denote the fact that this function is
part of the implementation, and not an interface to Tk functionality.

Aqui estão alguns exemplos de uso típico:

@example
import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# Cria a aplicação
myapp = App()

#
# aqui estão as chamadas de método para a classe do gerenciador de janelas
#
myapp.master.title("Meu Aplicativo Que Faz Nada")
myapp.master.maxsize(1000, 400)

# inicia o programa
myapp.mainloop()
@end example

@node Opções de Tipos de Dados do Tk,Ligações e Eventos,O Gerenciador de Janela,Referência Útil
@anchor{library/tkinter tk-option-data-types}@anchor{3fb1}
@subsubsection Opções de Tipos de Dados do Tk


@geindex Opções de Tipos de Dados do Tk


@table @asis

@item anchor

Valores legais são os pontos cardeais: @code{"n"}, @code{"ne"}, @code{"e"}, @code{"se"}, @code{"s"}, @code{"sw"}, @code{"w"}, @code{"nw"}, e também @code{"center"}.

@item bitmap

Há 8 bitmaps embutidos nomeados: @code{'error'}, @code{'gray25'}, @code{'gray50'}, @code{'hourglass'}, @code{'info'}, @code{'questhead'}, @code{'question'}, @code{'warning'}. Para especificar um nome de arquivo do bitmap X, passe o caminho completo do arquivo, precedido pelo caractere @code{@@}, como em @code{"@@/usr/contrib/bitmap/gumby.bit"}.

@item booleano

Você pode passar os inteiros 0 ou 1 ou as strings @code{"yes"} ou @code{"no"}.

@item função de retorno

Esta é uma função Python que não aceita argumentos. Por exemplo:

@example
def print_it():
    print("hi there")
fred["command"] = print_it
@end example

@item cor

As cores podem ser fornecidas como nomes de cores X no arquivo rgb.txt ou como strings representando valores RGB em intervalos de 4 bits: @code{"#RGB"}, 8 bit: @code{"#RRGGBB"}, 12 bit: @code{"#RRRGGGBBB"} ou 16 bit:  @code{"#RRRRGGGGBBBB"}, onde R,G,B aqui representam qualquer dígito hexadecimal legal. Veja a página 160 do livro de Ousterhout para detalhes.

@item cursor

Os nomes de cursor X padrão de @code{cursorfont.h} podem ser usados, sem o prefixo @code{XC_}. Por exemplo, para obter um cursor de mão (@code{XC_hand2}), use a string @code{"hand2"}. Você também pode especificar um bitmap e um arquivo de máscara de sua preferência. Veja a página 179 do livro de Ousterhout.

@item distance

As distâncias da tela podem ser especificadas em pixels ou distâncias absolutas. Pixels são dados como números e distâncias absolutas como strings, com os caracteres finais denotando unidades: @code{c} para centímetros, @code{i} para polegadas, @code{m} para milímetros, @code{p} para os pontos da impressora. Por exemplo, 3,5 polegadas é expresso como @code{"3.5i"}.

@item font

Tk usa um formato de nome de fonte de lista, como @code{@{courier 10 bold@}}. Tamanhos de fonte com números positivos são medidos em pontos; tamanhos com números negativos são medidos em pixels.

@item geometria

Esta é uma string no formato @code{widthxheight}, onde largura e altura são medidas em pixels para a maioria dos widgets (em caracteres para widgets que exibem texto). Por exemplo: @code{fred["geometry"] = "200x100"}.

@item justify

Valores aceitos são as strings: @code{"left"}, @code{"center"} e @code{"right"}.

@item region

Esta é uma string com quatro elementos delimitados por espaço, cada um dos quais a uma distância legal (veja acima). Por exemplo:  @code{"2 3 4 5"} e @code{"3i 2i 4.5i 2i"} e @code{"3c 2c 4c 10.43c"} são todas regiões legais.

@item relief

Determina qual será o estilo da borda de um widget. Os valores legais são: @code{"raised"}, @code{"sunken"}, @code{"flat"}, @code{"groove"} e @code{"ridge"}.

@item scrollcommand

Este é quase sempre o método @code{set()} de algum widget da barra de rolagem, mas pode ser qualquer método de widget que receba um único argumento.

@item wrap

Deve ser um de: @code{"none"}, @code{"char"} ou @code{"word"}.
@end table

@node Ligações e Eventos,O Parâmetro index,Opções de Tipos de Dados do Tk,Referência Útil
@anchor{library/tkinter bindings-and-events}@anchor{3fb2}@anchor{library/tkinter id2}@anchor{3fb3}
@subsubsection Ligações e Eventos


@geindex ligação (widgets)
@geindex eventos (widgets)

O método de ligação do comando widget permite que você observe certos eventos e tenha um acionamento de função de retorno de chamada quando esse tipo de evento ocorrer. A forma do método de ligação é:

@example
def bind(self, sequence, func, add='@w{'}):
@end example

sendo que:


@table @asis

@item sequência

é uma string que denota o tipo de evento de destino. (Veja a página man do @code{bind(3tk)@footnote{https://manpages.debian.org/bind(3tk)}} e a página 201 do livro de John Ousterhout, @cite{Tcl and the Tk Toolkit (2nd edition)}, para mais detalhes).

@item func

é uma função Python, tendo um argumento, a ser invocada quando o evento ocorre. Uma instância de evento será passada como argumento. (As funções implantadas dessa forma são comumente conhecidas como `funções de retorno'.)

@item add

é opcional, tanto @code{'@w{'}} ou @code{'+'}. Passar uma string vazia indica que essa ligação substitui todas as outras ligações às quais esse evento está associado. Passar um @code{'+'} significa que esta função deve ser adicionada à lista de funções ligadas a este tipo de evento.
@end table

Por exemplo:

@example
def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)
@end example

Observe como o campo widget do evento está sendo acessado na função de retorno @code{turn_red()}. Este campo contém o widget que capturou o evento X. A tabela a seguir lista os outros campos de evento que você pode acessar e como eles são denotados no Tk, o que pode ser útil ao se referir às páginas man do Tk.


@multitable {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tk

@tab

Campo de Eventos do Tkinter

@tab

Tk

@tab

Campo de Eventos do 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

tipo

@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 O Parâmetro index,Imagens,Ligações e Eventos,Referência Útil
@anchor{library/tkinter the-index-parameter}@anchor{3fb4}
@subsubsection O Parâmetro index


Vários widgets requerem que parâmetros de “indx” sejam passados. Eles são usados para apontar para um local específico em um widget Text, ou para caracteres específicos em um widget Entry, ou para itens de menu específicos em um widget Menu.


@table @asis

@item Índices de widget de entrada (índice, índice de visualização, etc.)

Os widgets de entrada têm opções que se referem às posições dos caracteres no texto exibido. Você pode acessar esses pontos especiais em um widget de texto usando as seguintes funções @ref{f0,,tkinter}:

@item Índice de widget de texto

A notação de índice do widget de texto é muito rica e é melhor detalhada nas páginas do manual Tk.

@item Índices de menu (menu.invoke(), menu.entryconfig(), etc.)

Algumas opções e métodos de menus manipulam entradas de menu específicas. Sempre que um índice de menu é necessário para uma opção ou parâmetro, você pode passar:


@itemize *

@item 
um número inteiro que se refere à posição numérica da entrada no widget, contada do topo, começando com 0;

@item 
a string @code{"active"}, que se refere à posição do menu que está atualmente sob o cursor;

@item 
a string @code{"last"} que se refere ao último item do menu;

@item 
Um inteiro precedido por @code{@@}, como em @code{@@6}, onde o inteiro é interpretado como uma coordenada de pixel y no sistema de coordenadas do menu;

@item 
a string @code{"none"}, que indica nenhuma entrada de menu, mais frequentemente usada com menu.activate() para desativar todas as entradas e, finalmente,

@item 
uma string de texto cujo padrão corresponde ao rótulo da entrada do menu, conforme varrido da parte superior do menu para a parte inferior. Observe que este tipo de índice é considerado após todos os outros, o que significa que as correspondências para itens de menu rotulados como @code{last}, @code{active} ou @code{none} podem ser interpretadas como os literais acima, em vez disso.
@end itemize
@end table

@node Imagens,,O Parâmetro index,Referência Útil
@anchor{library/tkinter images}@anchor{3fb5}
@subsubsection Imagens


Imagens de diferentes formatos podem ser criadas por meio da subclasse correspondente de @code{tkinter.Image}:


@itemize *

@item 
@code{BitmapImage} para imagens no formato XBM.

@item 
@code{PhotoImage} para imagens nos formatos PGM, PPM, GIF e PNG. O suporte ao último foi adicionado a partir do Tk 8.6.
@end itemize

Qualquer tipo de imagem é criado através da opção @code{file} ou @code{data} (outras opções também estão disponíveis).


Alterado na versão 3.13: Adicionado o método @code{copy_replace()} à classe @code{PhotoImage} para copiar uma região de uma imagem para outra imagem, possivelmente com ampliação e subamostragem de pixels. Adiciona parâmetro `from_coords' para os métodos @code{copy()}, @code{zoom()} e @code{subsample()} da classe @code{PhotoImage}. Adiciona parâmetros `zoom' e `subsample' para o método @code{copy()} da classe @code{PhotoImage}.


O objeto imagem pode então ser usado sempre que uma opção @code{image} há suporte em algum widget (por exemplo: rótulos, botões, menus). Nestes casos, o Tk não guardará uma referência à imagem. Quando a última referência Python ao objeto imagem for excluída, os dados da imagem também serão excluídos e o Tk exibirá uma caixa vazia onde quer que a imagem tenha sido usada.


@subsubheading Ver também


O pacote Pillow@footnote{https://python-pillow.org/} adiciona suporte para formatos como BMP, JPEG, TIFF e WebP, entre outros.


@node Tratadores de arquivos,,Referência Útil,tkinter — Interface Python para Tcl/Tk
@anchor{library/tkinter file-handlers}@anchor{3fb6}@anchor{library/tkinter tkinter-file-handlers}@anchor{3fb7}
@subsubsection Tratadores de arquivos


O Tk permite que você registre e cancele o registro de uma função de retorno que será chamada a partir do laço central do Tk quando uma E/S for possível em um descritor de arquivo. Apenas um tratador pode ser registrado por descritor de arquivo. Código de exemplo:

@example
import tkinter
widget = tkinter.Tk()
mask = tkinter.READABLE | tkinter.WRITABLE
widget.tk.createfilehandler(file, mask, callback)
...
widget.tk.deletefilehandler(file)
@end example

Este recurso não está disponível no Windows.

Já que você não sabe quantos bytes estão disponíveis para leitura, você pode não querer usar os métodos @ref{136d,,read()} ou @ref{241f,,readline()} de @ref{694,,BufferedIOBase} ou @ref{695,,TextIOBase}, já que eles insistirão em ler uma quantidade predefinida de bytes. Para sockets, os métodos @ref{dcc,,recv()} ou @ref{dcd,,recvfrom()} vão servir; para outros arquivos, use dados brutos ou @code{os.read(file.fileno(), maxbytecount)}.

@geindex createfilehandler() (método _tkinter.Widget.tk)
@anchor{library/tkinter tkinter Widget tk createfilehandler}@anchor{3fb8}
@deffn {Método} Widget.tk.createfilehandler (file, mask, func)

Registra a função de retorno do tratador de arquivo `func'. O argumento `file' pode ser um objeto com um método @ref{15d0,,fileno()} (como um arquivo ou objeto soquete) ou um descritor de arquivo de inteiro. O argumento `mask' é uma combinação OR de qualquer uma das três constantes abaixo. O retorno de chamada é chamado da seguinte maneira:

@example
callback(file, mask)
@end example
@end deffn

@geindex deletefilehandler() (método _tkinter.Widget.tk)
@anchor{library/tkinter tkinter Widget tk deletefilehandler}@anchor{3fb9}
@deffn {Método} Widget.tk.deletefilehandler (file)

Cancela o registro de um tratador de arquivo.
@end deffn

@geindex READABLE (no módulo _tkinter)
@geindex WRITABLE (no módulo _tkinter)
@geindex EXCEPTION (no módulo _tkinter)
@anchor{library/tkinter tkinter READABLE}@anchor{3fba}
@deffn {Dado} _tkinter.READABLE
@anchor{library/tkinter tkinter WRITABLE}@anchor{3fbb}
@deffnx {Dado} _tkinter.WRITABLE
@anchor{library/tkinter tkinter EXCEPTION}@anchor{3fbc}
@deffnx {Dado} _tkinter.EXCEPTION

Constantes usadas nos argumentos `mask'.
@end deffn

@node tkinter colorchooser — Diálogo de escolha de cor,tkinter font — Invólucro de fontes Tkinter,tkinter — Interface Python para Tcl/Tk,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter colorchooser doc}@anchor{3fbd}@anchor{library/tkinter colorchooser module-tkinter colorchooser}@anchor{f1}@anchor{library/tkinter colorchooser tkinter-colorchooser-color-choosing-dialog}@anchor{3fbe}@anchor{library/tkinter colorchooser translation-repo}@anchor{3fbf}
@subsection @code{tkinter.colorchooser} — Diálogo de escolha de cor


@geindex module; tkinter.colorchooser

`Código-fonte:' Lib/tkinter/colorchooser.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/colorchooser.py}


__________________________________________________________________


O módulo @ref{f1,,tkinter.colorchooser} fornece a classe @ref{3fc0,,Chooser} como uma interface para o diálogo do seletor de cores nativo. @code{Chooser} implementa uma janela de diálogo de escolha de cores modal. A classe @code{Chooser} herda da classe @ref{3fc1,,Dialog}.

@geindex Chooser (classe em tkinter.colorchooser)
@anchor{library/tkinter colorchooser tkinter colorchooser Chooser}@anchor{3fc0}
@deffn {Classe} tkinter.colorchooser.Chooser (master=None, **options)
@end deffn

@geindex askcolor() (no módulo tkinter.colorchooser)
@anchor{library/tkinter colorchooser tkinter colorchooser askcolor}@anchor{3fc2}
@deffn {Função} tkinter.colorchooser.askcolor (color=None, **options)

Cria um diálogo de escolha de cores. Uma chamada para esse método mostrará a janela, aguardará o usuário fazer uma seleção e retornará a cor selecionada (ou @code{None}) ao chamador.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{f2,,tkinter.commondialog}

Módulo de diálogo padrão do Tkinter
@end table


@node tkinter font — Invólucro de fontes Tkinter,Diálogos Tkinter,tkinter colorchooser — Diálogo de escolha de cor,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter font doc}@anchor{3fc3}@anchor{library/tkinter font module-tkinter font}@anchor{f5}@anchor{library/tkinter font tkinter-font-tkinter-font-wrapper}@anchor{3fc4}@anchor{library/tkinter font translation-repo}@anchor{3fc5}
@subsection @code{tkinter.font} — Invólucro de fontes Tkinter


@geindex module; tkinter.font

`Código-fonte:' Lib/tkinter/font.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/font.py}


__________________________________________________________________


O módulo @ref{f5,,tkinter.font} apresenta a classe @ref{1a5a,,Font} para criação e utilização de fontes nomeadas.

Os diferentes pesos e inclinações de fontes são:

@geindex NORMAL (no módulo tkinter.font)
@geindex BOLD (no módulo tkinter.font)
@geindex ITALIC (no módulo tkinter.font)
@geindex ROMAN (no módulo tkinter.font)
@anchor{library/tkinter font tkinter font NORMAL}@anchor{3fc6}
@deffn {Dado} tkinter.font.NORMAL
@anchor{library/tkinter font tkinter font BOLD}@anchor{3fc7}
@deffnx {Dado} tkinter.font.BOLD
@anchor{library/tkinter font tkinter font ITALIC}@anchor{3fc8}
@deffnx {Dado} tkinter.font.ITALIC
@anchor{library/tkinter font tkinter font ROMAN}@anchor{3fc9}
@deffnx {Dado} tkinter.font.ROMAN
@end deffn

@geindex Font (classe em tkinter.font)
@anchor{library/tkinter font tkinter font Font}@anchor{1a5a}
@deffn {Classe} tkinter.font.Font (root=None, font=None, name=None, exists=False, **options)

A classe @ref{1a5a,,Font} representa uma fonte nomeada. Instâncias `font' recebem nomes únicos e podem ser especificadas por família, tamanho e configuração de estilo. Fontes nomeadas são os métodos Tk para criação e identificação de fontes de um objeto singular, ao invés de especificar a fonte por seus atributos em cada ocorrência.

@quotation

argumentos:

@quotation


@display
`font' - tupla de especificação da fonte (família, tamanho, opções)@w{ }
`name' - nome único da fonte@w{ }
`exists' - aponta para uma fonte nomeada existente se for verdadeiro@w{ }
@end display


@end quotation

palavras reservadas opcionais (ignoradas caso `font' seja especificado):

@quotation


@display
`family' - a família da fonte e.x. Courier, Times@w{ }
`size' - tamanho da fonte@w{ }
@display
Se `size' for positivo, ele é interpretado como tamanho em pontos.@w{ }
Caso `size' seja um número negativo, seu valor absoluto é tratado@w{ }
como tamanho em pixels.@w{ }
@end display
`weight' - ênfase da fonte (normal,negrito)@w{ }
`slant' - ROMAN, ITALIC@w{ }
`underline' - sublinhamento da fonte (0 - sem sublinhamento, 1 - sublinhado)@w{ }
`overstrike' - fonte riscada (0 - sem risco, 1 - letras riscadas)@w{ }
@end display


@end quotation
@end quotation

@geindex actual() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font actual}@anchor{3fca}
@deffn {Método} actual (option=None, displayof=None)

Retorna os atributos da fonte.
@end deffn

@geindex cget() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font cget}@anchor{3fcb}
@deffn {Método} cget (option)

Recupera um atributo da fonte.
@end deffn

@geindex config() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font config}@anchor{3fcc}
@deffn {Método} config (**options)

Modifica atributos da fonte.
@end deffn

@geindex copy() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font copy}@anchor{3fcd}
@deffn {Método} copy ()

Retorna uma nova instância da fonte atual.
@end deffn

@geindex measure() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font measure}@anchor{3fce}
@deffn {Método} measure (text, displayof=None)

Retorna a quantidade de espaço que o texto ocuparia na exibição especificada ao ser formatado na fonte atual. Caso nenhuma exibição seja especificada, a exibição presumida será a da janela principal da aplicação.
@end deffn

@geindex metrics() (método tkinter.font.Font)
@anchor{library/tkinter font tkinter font Font metrics}@anchor{3fcf}
@deffn {Método} metrics (*options, **kw)

Retorna dados específicos da fonte. Opções inclusas:


@table @asis

@item `ascent' - distância entre a linha de base e o ponto mais alto que um

caractere da fonte pode ocupar

@item `descent' - distância entre a linha de base e o ponto mais baixo que um

caractere da fonte pode ocupar

@item `linespace' - separação vertical mínima necessária entre dois

caracteres da fonte que garante que não ocorra sobreposição entre as linhas.
@end table

`fixed' - 1 caso a fonte seja de largura fixa, 0 caso contrário
@end deffn
@end deffn

@geindex families() (no módulo tkinter.font)
@anchor{library/tkinter font tkinter font families}@anchor{3fd0}
@deffn {Função} tkinter.font.families (root=None, displayof=None)

Retorna as diferentes famílias de fontes.
@end deffn

@geindex names() (no módulo tkinter.font)
@anchor{library/tkinter font tkinter font names}@anchor{3fd1}
@deffn {Função} tkinter.font.names (root=None)

Retorna os nomes das fontes definidas.
@end deffn

@geindex nametofont() (no módulo tkinter.font)
@anchor{library/tkinter font tkinter font nametofont}@anchor{1a5c}
@deffn {Função} tkinter.font.nametofont (name, root=None)

Retorna a representação @ref{1a5a,,Font} de uma fonte nomeada do tk.


Alterado na versão 3.10: O parâmetro `root' foi adicionado.

@end deffn

@node Diálogos Tkinter,tkinter messagebox — Prompts de mensagem do Tkinter,tkinter font — Invólucro de fontes Tkinter,Interfaces gráficas de usuário com Tk
@anchor{library/dialog doc}@anchor{3fd2}@anchor{library/dialog tkinter-dialogs}@anchor{3fd3}@anchor{library/dialog translation-repo}@anchor{3fd4}
@subsection Diálogos Tkinter


@menu
* tkinter.simpledialog — Diálogos de entrada padrão do Tkinter: tkinter simpledialog — Diálogos de entrada padrão do Tkinter. 
* tkinter.filedialog — Caixas de diálogo de seleção de arquivo: tkinter filedialog — Caixas de diálogo de seleção de arquivo. 
* tkinter.commondialog — Modelos de janela de diálogo: tkinter commondialog — Modelos de janela de diálogo. 

@end menu

@node tkinter simpledialog — Diálogos de entrada padrão do Tkinter,tkinter filedialog — Caixas de diálogo de seleção de arquivo,,Diálogos Tkinter
@anchor{library/dialog module-tkinter simpledialog}@anchor{f8}@anchor{library/dialog tkinter-simpledialog-standard-tkinter-input-dialogs}@anchor{3fd5}
@subsubsection @code{tkinter.simpledialog} — Diálogos de entrada padrão do Tkinter


@geindex module; tkinter.simpledialog

`Código-fonte:' Lib/tkinter/simpledialog.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/simpledialog.py}


__________________________________________________________________


O módulo @ref{f8,,tkinter.simpledialog} contém classes de conveniência e funções para criar diálogos modais simples para obter um valor do usuário.

@geindex askfloat() (no módulo tkinter.simpledialog)
@geindex askinteger() (no módulo tkinter.simpledialog)
@geindex askstring() (no módulo tkinter.simpledialog)
@anchor{library/dialog tkinter simpledialog askfloat}@anchor{3fd6}
@deffn {Função} tkinter.simpledialog.askfloat (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askinteger}@anchor{1a5d}
@deffnx {Função} tkinter.simpledialog.askinteger (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askstring}@anchor{3fd7}
@deffnx {Função} tkinter.simpledialog.askstring (title, prompt, **kw)

As três funções acima fornecem caixas de diálogo que solicitam que o usuário insira um valor do tipo desejado.
@end deffn

@geindex Dialog (classe em tkinter.simpledialog)
@anchor{library/dialog tkinter simpledialog Dialog}@anchor{3fd8}
@deffn {Classe} tkinter.simpledialog.Dialog (parent, title=None)

A classe base para diálogos personalizados.

@geindex body() (método tkinter.simpledialog.Dialog)
@anchor{library/dialog tkinter simpledialog Dialog body}@anchor{3fd9}
@deffn {Método} body (master)

Substitui para construir a interface da caixa de diálogo e retornar o widget que deve ter foco inicial.
@end deffn

@geindex buttonbox() (método tkinter.simpledialog.Dialog)
@anchor{library/dialog tkinter simpledialog Dialog buttonbox}@anchor{3fda}
@deffn {Método} buttonbox ()

O comportamento padrão adiciona botões OK e Cancelar. Substitua para layouts de botão personalizados.
@end deffn
@end deffn

@node tkinter filedialog — Caixas de diálogo de seleção de arquivo,tkinter commondialog — Modelos de janela de diálogo,tkinter simpledialog — Diálogos de entrada padrão do Tkinter,Diálogos Tkinter
@anchor{library/dialog module-tkinter filedialog}@anchor{f4}@anchor{library/dialog tkinter-filedialog-file-selection-dialogs}@anchor{3fdb}
@subsubsection @code{tkinter.filedialog} — Caixas de diálogo de seleção de arquivo


@geindex module; tkinter.filedialog

`Código-fonte:' Lib/tkinter/filedialog.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/filedialog.py}


__________________________________________________________________


The módulo @ref{f4,,tkinter.filedialog} fornece classes e funções de fábrica para criar janelas de seleção de arquivo/diretório.

@menu
* Caixas de diálogo nativos de carregar/salvar:: 

@end menu

@node Caixas de diálogo nativos de carregar/salvar,,,tkinter filedialog — Caixas de diálogo de seleção de arquivo
@anchor{library/dialog native-load-save-dialogs}@anchor{3fdc}
@subsubsection Caixas de diálogo nativos de carregar/salvar


As seguintes classes e funções fornecem janelas de diálogo de arquivo que combinam uma aparência nativa com opções de configuração para personalizar o comportamento. Os seguintes argumentos nomeados são aplicáveis às classes e funções listado abaixo:

@quotation


@display
`parent' - a janela para colocar a caixa de diálogo no topo@w{ }
@end display




@display
`title' - o título da janela@w{ }
@end display




@display
`initialdir' - o diretório no qual a caixa de diálogo começa@w{ }
@end display




@display
`initialfile' - o arquivo selecionado ao abrir a caixa de diálogo@w{ }
@end display




@display
`filetypes' - uma sequência de tuplas (rótulo, padrão), o caractere curinga ‘*’ é permitido@w{ }
@end display




@display
`defaultextension' - extensão padrão para anexar ao arquivo (caixas de diálogo para salvar)@w{ }
@end display




@display
`multiple' - quando verdadeiro, a seleção de vários itens é permitida@w{ }
@end display


@end quotation

`Fábrica de funções estáticas'

As funções a seguir, quando chamadas, criam uma caixa de diálogo modal e nativa, aguardam a seleção do usuário e, em seguida, retornam o(s) valor(es) selecionado(s) ou @code{None} para o chamador.

@geindex askopenfile() (no módulo tkinter.filedialog)
@geindex askopenfiles() (no módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askopenfile}@anchor{3fdd}
@deffn {Função} tkinter.filedialog.askopenfile (mode='r', **options)
@anchor{library/dialog tkinter filedialog askopenfiles}@anchor{3fde}
@deffnx {Função} tkinter.filedialog.askopenfiles (mode='r', **options)

As duas funções acima criam uma caixa de diálogo @ref{3fdf,,Open} e retornam a caixa de diálogo com um ou mais objetos arquivo abertos em modo somente leitura.
@end deffn

@geindex asksaveasfile() (no módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog asksaveasfile}@anchor{3fe0}
@deffn {Função} tkinter.filedialog.asksaveasfile (mode='w', **options)

Cria uma caixa de diálogo @ref{3fe1,,SaveAs} e retorna um objeto arquivo aberto em modo somente escrita.
@end deffn

@geindex askopenfilename() (no módulo tkinter.filedialog)
@geindex askopenfilenames() (no módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askopenfilename}@anchor{3fe2}
@deffn {Função} tkinter.filedialog.askopenfilename (**options)
@anchor{library/dialog tkinter filedialog askopenfilenames}@anchor{3fe3}
@deffnx {Função} tkinter.filedialog.askopenfilenames (**options)

As duas funções acima criam uma caixa de diálogo @ref{3fdf,,Open} e retornam um ou mais nomes de arquivos selecionados que correspondem aos arquivos existentes.
@end deffn

@geindex asksaveasfilename() (no módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog asksaveasfilename}@anchor{3fe4}
@deffn {Função} tkinter.filedialog.asksaveasfilename (**options)

Cria uma caixa de diálogo @ref{3fe1,,SaveAs} e retorna o nome do arquivo selecionado.
@end deffn

@geindex askdirectory() (no módulo tkinter.filedialog)
@anchor{library/dialog tkinter filedialog askdirectory}@anchor{3fe5}
@deffn {Função} tkinter.filedialog.askdirectory (**options)


@display
Solicita ao usuário que selecione um diretório.@w{ }
Opção de palavra reservada adicional:@w{ }
@display
`mustexist' - determina se a seleção deve ser um diretório existente.@w{ }
@end display
@end display


@end deffn

@geindex Open (classe em tkinter.filedialog)
@geindex SaveAs (classe em tkinter.filedialog)
@anchor{library/dialog tkinter filedialog Open}@anchor{3fdf}
@deffn {Classe} tkinter.filedialog.Open (master=None, **options)
@anchor{library/dialog tkinter filedialog SaveAs}@anchor{3fe1}
@deffnx {Classe} tkinter.filedialog.SaveAs (master=None, **options)

As duas classes acima fornecem janelas de diálogo nativas para salvar e carregar files.
@end deffn

`Classes de conveniência'

As classes abaixo são usadas para criar janelas de arquivos/diretórios desde o início. Elas não emulam a aparência nativa da plataforma.

@geindex Directory (classe em tkinter.filedialog)
@anchor{library/dialog tkinter filedialog Directory}@anchor{3fe6}
@deffn {Classe} tkinter.filedialog.Directory (master=None, **options)

Cria uma caixa de diálogo solicitando que o usuário selecione um diretório.
@end deffn

@cartouche
@quotation Nota 
A classe `FileDialog' deve ser uma subclasse para manipulação e comportamento de eventos personalizados.
@end quotation
@end cartouche

@geindex FileDialog (classe em tkinter.filedialog)
@anchor{library/dialog tkinter filedialog FileDialog}@anchor{3fe7}
@deffn {Classe} tkinter.filedialog.FileDialog (master, title=None)

Cria uma caixa de diálogo básica de seleção de arquivo.

@geindex cancel_command() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog cancel_command}@anchor{3fe8}
@deffn {Método} cancel_command (event=None)

Aciona o encerramento da janela de diálogo.
@end deffn

@geindex dirs_double_event() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog dirs_double_event}@anchor{3fe9}
@deffn {Método} dirs_double_event (event)

Manipulador de eventos para evento de clique duplo no diretório.
@end deffn

@geindex dirs_select_event() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog dirs_select_event}@anchor{3fea}
@deffn {Método} dirs_select_event (event)

Manipulador de eventos para evento de clique no diretório.
@end deffn

@geindex files_double_event() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog files_double_event}@anchor{3feb}
@deffn {Método} files_double_event (event)

Manipulador de eventos para evento de clique duplo no arquivo.
@end deffn

@geindex files_select_event() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog files_select_event}@anchor{3fec}
@deffn {Método} files_select_event (event)

Manipulador de eventos para evento de clique único no arquivo.
@end deffn

@geindex filter_command() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog filter_command}@anchor{3fed}
@deffn {Método} filter_command (event=None)

Filtra os arquivos por diretório.
@end deffn

@geindex get_filter() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog get_filter}@anchor{3fee}
@deffn {Método} get_filter ()

Recupera o filtro de arquivo atualmente em uso.
@end deffn

@geindex get_selection() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog get_selection}@anchor{3fef}
@deffn {Método} get_selection ()

Recupera o item atualmente selecionado.
@end deffn

@geindex go() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog go}@anchor{3ff0}
@deffn {Método} go (dir_or_file=os.curdir, pattern='*', default='@w{'}, key=None)

Caixa de diálogo de renderização e inicia um laço de eventos.
@end deffn

@geindex ok_event() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog ok_event}@anchor{3ff1}
@deffn {Método} ok_event (event)

Sai da caixa de diálogo retornando a seleção atual.
@end deffn

@geindex quit() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog quit}@anchor{3ff2}
@deffn {Método} quit (how=None)

Sai da caixa de diálogo retornando o nome do arquivo, se houver.
@end deffn

@geindex set_filter() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog set_filter}@anchor{3ff3}
@deffn {Método} set_filter (dir, pat)

Define o filtro de arquivo.
@end deffn

@geindex set_selection() (método tkinter.filedialog.FileDialog)
@anchor{library/dialog tkinter filedialog FileDialog set_selection}@anchor{3ff4}
@deffn {Método} set_selection (file)

Atualiza a seleção de arquivo atual para `file'.
@end deffn
@end deffn

@geindex LoadFileDialog (classe em tkinter.filedialog)
@anchor{library/dialog tkinter filedialog LoadFileDialog}@anchor{3ff5}
@deffn {Classe} tkinter.filedialog.LoadFileDialog (master, title=None)

Uma subclasse de FileDialog que cria uma janela de diálogo para selecionar um arquivo existente.

@geindex ok_command() (método tkinter.filedialog.LoadFileDialog)
@anchor{library/dialog tkinter filedialog LoadFileDialog ok_command}@anchor{3ff6}
@deffn {Método} ok_command ()

Testa se um arquivo é fornecido e se a seleção indica um já arquivo existente.
@end deffn
@end deffn

@geindex SaveFileDialog (classe em tkinter.filedialog)
@anchor{library/dialog tkinter filedialog SaveFileDialog}@anchor{3ff7}
@deffn {Classe} tkinter.filedialog.SaveFileDialog (master, title=None)

Uma subclasse de FileDialog que cria uma janela de diálogo para selecionar um arquivo de destino.

@geindex ok_command() (método tkinter.filedialog.SaveFileDialog)
@anchor{library/dialog tkinter filedialog SaveFileDialog ok_command}@anchor{3ff8}
@deffn {Método} ok_command ()

Testa se a seleção aponta ou não para um arquivo válido que não é um diretório. A confirmação é necessária se um arquivo já existente for selecionado.
@end deffn
@end deffn

@node tkinter commondialog — Modelos de janela de diálogo,,tkinter filedialog — Caixas de diálogo de seleção de arquivo,Diálogos Tkinter
@anchor{library/dialog module-tkinter commondialog}@anchor{f2}@anchor{library/dialog tkinter-commondialog-dialog-window-templates}@anchor{3ff9}
@subsubsection @code{tkinter.commondialog} — Modelos de janela de diálogo


@geindex module; tkinter.commondialog

`Código-fonte:' Lib/tkinter/commondialog.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/commondialog.py}


__________________________________________________________________


O módulo @ref{f2,,tkinter.commondialog} fornece a a classe @ref{3fc1,,Dialog}, que é a classe base para diálogos definidos em outros módulos de suporte.

@geindex Dialog (classe em tkinter.commondialog)
@anchor{library/dialog tkinter commondialog Dialog}@anchor{3fc1}
@deffn {Classe} tkinter.commondialog.Dialog (master=None, **options)

@geindex show() (método tkinter.commondialog.Dialog)
@anchor{library/dialog tkinter commondialog Dialog show}@anchor{3ffa}
@deffn {Método} show (**options)

Renderiza a janela de diálogo.
@end deffn
@end deffn


@subsubheading Ver também


Módulos @ref{f6,,tkinter.messagebox}, @ref{1e06,,Leitura e escrita de arquivos}


@node tkinter messagebox — Prompts de mensagem do Tkinter,tkinter scrolledtext — Widget de texto de rolado,Diálogos Tkinter,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter messagebox doc}@anchor{3ffb}@anchor{library/tkinter messagebox module-tkinter messagebox}@anchor{f6}@anchor{library/tkinter messagebox tkinter-messagebox-tkinter-message-prompts}@anchor{3ffc}@anchor{library/tkinter messagebox translation-repo}@anchor{3ffd}
@subsection @code{tkinter.messagebox} — Prompts de mensagem do Tkinter


@geindex module; tkinter.messagebox

`Código-fonte:' Lib/tkinter/messagebox.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/messagebox.py}


__________________________________________________________________


O módulo @ref{f6,,tkinter.messagebox} provê uma classe base template e uma variedade de métodos de conveniência para as configurações mais comumente usadas. As caixas de mensagem são modais e vão retornar um conjunto de (@code{True}, @code{False}, @code{None}, @ref{3ffe,,OK}, @ref{3fff,,CANCEL}, @ref{4000,,YES}, @ref{4001,,NO}) baseado na seleção do usuário. Estilos e formatos de janelas comuns estão incluídos, mas não estão limitados a:


@float Figure

@image{python-figures/tk_msg,,,,png}

@end float


@geindex Message (classe em tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox Message}@anchor{4002}
@deffn {Classe} tkinter.messagebox.Message (master=None, **options)

Criar uma janela de mensagem com uma mensagem específica da aplicação, um ícone e um conjunto de botões. Cada botão na janela é identificado com um nome simbólico único (veja as opções de “type”).

As seguintes opções são suportadas:

@quotation


@table @asis

@item “command”

Especifica a função que será invocada quando o usuário fecha a janela de diálogo. O nome do botão clicado pelo usuário para fechar a janela é passada como um argumento. Esta funcionalidade está disponível apenas no macOS.

@item “default”

Fornece o @ref{4003,,nome simbólico} do botão padrão para essa janela de mensagem (@ref{3ffe,,OK}, @ref{3fff,,CANCEL}, e assim por diante). Se essa opção não for especificada, o primeiro botão da caixa de diálogo será o padrão.

@item “detail”

Especifica uma mensagem auxiliar para a mensagem principal fornecida pela opção `message'. Esta mensagem será apresentado abaixo da mensagem principal e, quando suportado pelo sistema operacional, em uma fonte menos enfatizada do que a mensagem principal.

@item “icon”

Especifica um @ref{4004,,icon} a ser apresentado. Se essa opção não for especificada, o ícone @ref{4005,,INFO} será exibido.

@item “message”

Especifica a mensagem para mostrar nessa caixa de mensagem. O padrão valor é uma string vazia.

@item “parent”

Torna a janela especificada a janela pai da caixa de mensagem. A caixa de mensagem é exibida na parte superior de sua janela pai.

@item “title”

Especifica uma string para mostrar como o título da caixa de mensagem. Essa opção é ignorada no macOS, onde a plataforma proíbe o uso de um título nesse tipo de caixa de diálogo.

@item “type”

Organiza um @ref{4006,,conjunto predefinido de botões} a serem mostrados.
@end table
@end quotation

@geindex show() (método tkinter.messagebox.Message)
@anchor{library/tkinter messagebox tkinter messagebox Message show}@anchor{4007}
@deffn {Método} show (**options)

Mostra uma janela de mensagem e aguarda que o usuário selecione um dos botões. Em seguida, retorna o nome simbólico do botão selecionado. Argumentos nomeados pode substituir opções especificadas no construtor.
@end deffn
@end deffn

`Caixa de mensagem de informação'

@geindex showinfo() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showinfo}@anchor{4008}
@deffn {Função} tkinter.messagebox.showinfo (title=None, message=None, **options)

Cria e exibe uma caixa de mensagem informativa com o título e a mensagem especificados.
@end deffn

`Caixas de mensagem de atenção'

@geindex showwarning() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showwarning}@anchor{4009}
@deffn {Função} tkinter.messagebox.showwarning (title=None, message=None, **options)

Cria e exibe uma caixa de mensagem de alerta com o título e a mensagem especificados.
@end deffn

@geindex showerror() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox showerror}@anchor{400a}
@deffn {Função} tkinter.messagebox.showerror (title=None, message=None, **options)

Cria e exibe uma caixa de mensagem de erro com o título e a mensagem especificados.
@end deffn

`Caixas de mensagem de dúvida'

@geindex askquestion() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askquestion}@anchor{400b}
@deffn {Função} tkinter.messagebox.askquestion (title=None, message=None, *, type=YESNO, **options)

Faz uma pergunta. Por padrão mostra os botões @ref{4000,,YES} e @ref{4001,,NO}. Retorna o nome simbólico do botão selecionado.
@end deffn

@geindex askokcancel() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askokcancel}@anchor{400c}
@deffn {Função} tkinter.messagebox.askokcancel (title=None, message=None, **options)

Pergunta se a operação deve prosseguir. Mostra os botões @ref{3ffe,,OK} e @ref{3fff,,CANCEL}. Retorna @code{True} se a resposta for “OK” e @code{False} caso contrário.
@end deffn

@geindex askretrycancel() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askretrycancel}@anchor{400d}
@deffn {Função} tkinter.messagebox.askretrycancel (title=None, message=None, **options)

Pergunta se a operação deve ser tentada novamente. Mostra os botões @ref{400e,,RETRY} e @ref{3fff,,CANCEL}. Retorna @code{True} se a resposta for sim e @code{False} caso contrário.
@end deffn

@geindex askyesno() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askyesno}@anchor{400f}
@deffn {Função} tkinter.messagebox.askyesno (title=None, message=None, **options)

Faz uma pergunta. Mostra os botões @ref{4000,,YES} e @ref{4001,,NO}. Retorna @code{True} se a resposta for sim e @code{False} caso contrário.
@end deffn

@geindex askyesnocancel() (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox askyesnocancel}@anchor{4010}
@deffn {Função} tkinter.messagebox.askyesnocancel (title=None, message=None, **options)

Faz uma pergunta. Mostra os botões @ref{4000,,YES}, @ref{4001,,NO} e @ref{3fff,,CANCEL}. Retorna @code{True} se a resposta for sim, @code{None} se cancelado, e @code{False} caso contrário.
@end deffn
@anchor{library/tkinter messagebox messagebox-buttons}@anchor{4003}
Nomes simbólicos dos botões:

@geindex ABORT (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ABORT}@anchor{4011}
@deffn {Dado} tkinter.messagebox.ABORT = 'abort'
@end deffn

@geindex RETRY (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox RETRY}@anchor{400e}
@deffn {Dado} tkinter.messagebox.RETRY = 'retry'
@end deffn

@geindex IGNORE (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox IGNORE}@anchor{4012}
@deffn {Dado} tkinter.messagebox.IGNORE = 'ignore'
@end deffn

@geindex OK (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox OK}@anchor{3ffe}
@deffn {Dado} tkinter.messagebox.OK = 'ok'
@end deffn

@geindex CANCEL (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox CANCEL}@anchor{3fff}
@deffn {Dado} tkinter.messagebox.CANCEL = 'cancel'
@end deffn

@geindex YES (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YES}@anchor{4000}
@deffn {Dado} tkinter.messagebox.YES = 'yes'
@end deffn

@geindex NO (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox NO}@anchor{4001}
@deffn {Dado} tkinter.messagebox.NO = 'no'
@end deffn
@anchor{library/tkinter messagebox messagebox-types}@anchor{4006}
Conjunto predefinido de botões:

@geindex ABORTRETRYIGNORE (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ABORTRETRYIGNORE}@anchor{4013}
@deffn {Dado} tkinter.messagebox.ABORTRETRYIGNORE = 'abortretryignore'

Exibe três botões cujos nomes simbólicos são @ref{4011,,ABORT}, @ref{400e,,RETRY} e @ref{4012,,IGNORE}.
@end deffn


@deffn {Dado} tkinter.messagebox.OK = 'ok'

Exibe um botão cujo nome simbólico é @ref{3ffe,,OK}.
@end deffn

@geindex OKCANCEL (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox OKCANCEL}@anchor{4014}
@deffn {Dado} tkinter.messagebox.OKCANCEL = 'okcancel'

Exibe dois botões cujos nomes simbólicos são @ref{3ffe,,OK} e @ref{3fff,,CANCEL}.
@end deffn

@geindex RETRYCANCEL (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox RETRYCANCEL}@anchor{4015}
@deffn {Dado} tkinter.messagebox.RETRYCANCEL = 'retrycancel'

Exibe dois botões cujos nomes simbólicos são @ref{400e,,RETRY} e @ref{3fff,,CANCEL}.
@end deffn

@geindex YESNO (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YESNO}@anchor{4016}
@deffn {Dado} tkinter.messagebox.YESNO = 'yesno'

Exibe dois botões cujos nomes simbólicos são @ref{4000,,YES} e @ref{4001,,NO}.
@end deffn

@geindex YESNOCANCEL (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox YESNOCANCEL}@anchor{4017}
@deffn {Dado} tkinter.messagebox.YESNOCANCEL = 'yesnocancel'

Exibe três botões cujos nomes simbólicos são @ref{4000,,YES}, @ref{4001,,NO} e @ref{3fff,,CANCEL}.
@end deffn
@anchor{library/tkinter messagebox messagebox-icons}@anchor{4004}
Imagens de ícones:

@geindex ERROR (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox ERROR}@anchor{4018}
@deffn {Dado} tkinter.messagebox.ERROR = 'error'
@end deffn

@geindex INFO (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox INFO}@anchor{4005}
@deffn {Dado} tkinter.messagebox.INFO = 'info'
@end deffn

@geindex QUESTION (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox QUESTION}@anchor{4019}
@deffn {Dado} tkinter.messagebox.QUESTION = 'question'
@end deffn

@geindex WARNING (no módulo tkinter.messagebox)
@anchor{library/tkinter messagebox tkinter messagebox WARNING}@anchor{401a}
@deffn {Dado} tkinter.messagebox.WARNING = 'warning'
@end deffn

@node tkinter scrolledtext — Widget de texto de rolado,tkinter dnd — Suporte para arrastar e soltar,tkinter messagebox — Prompts de mensagem do Tkinter,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter scrolledtext doc}@anchor{401b}@anchor{library/tkinter scrolledtext module-tkinter scrolledtext}@anchor{f7}@anchor{library/tkinter scrolledtext tkinter-scrolledtext-scrolled-text-widget}@anchor{401c}@anchor{library/tkinter scrolledtext translation-repo}@anchor{401d}
@subsection @code{tkinter.scrolledtext} — Widget de texto de rolado


@geindex module; tkinter.scrolledtext

`Código-fonte:' Lib/tkinter/scrolledtext.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/scrolledtext.py}


__________________________________________________________________


O módulo @ref{f7,,tkinter.scrolledtext} fornece uma classe com o mesmo nome que implementa um widget de texto básico que possui uma barra de rolagem vertical configurada para fazer a “coisa certa”. Usar a classe @ref{401e,,ScrolledText} é muito mais fácil do que configurar um widget de texto e barra de rolagem diretamente.

O widget de texto e a barra de rolagem são agrupados em @code{Frame}, e os métodos dos gerenciadores de geometria @code{Grid} e @code{Pack} são adquiridos do objeto @code{Frame}. Isso permite que o widget @ref{401e,,ScrolledText} seja usado diretamente para obter o comportamento mais normal de gerenciamento de geometria.

Se um controle mais específico for necessário, os seguintes atributos estarão disponíveis:

@geindex ScrolledText (classe em tkinter.scrolledtext)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText}@anchor{401e}
@deffn {Classe} tkinter.scrolledtext.ScrolledText (master=None, **kw)

@geindex frame (atributo tkinter.scrolledtext.ScrolledText)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText frame}@anchor{401f}
@deffn {Atributo} frame

O quadro que envolve os widgets de barra de rolagem e texto.
@end deffn

@geindex vbar (atributo tkinter.scrolledtext.ScrolledText)
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText vbar}@anchor{4020}
@deffn {Atributo} vbar

O widget da barra de rolagem.
@end deffn
@end deffn

@node tkinter dnd — Suporte para arrastar e soltar,tkinter ttk — Widgets temáticos do Tk,tkinter scrolledtext — Widget de texto de rolado,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter dnd doc}@anchor{4021}@anchor{library/tkinter dnd module-tkinter dnd}@anchor{f3}@anchor{library/tkinter dnd tkinter-dnd-drag-and-drop-support}@anchor{4022}@anchor{library/tkinter dnd translation-repo}@anchor{4023}
@subsection @code{tkinter.dnd} — Suporte para arrastar e soltar


@geindex module; tkinter.dnd

`Código-fonte:' Lib/tkinter/dnd.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/dnd.py}


__________________________________________________________________


@cartouche
@quotation Nota 
Isto é experimental e deverá ser descontinuado quando for substituído pelo Tk DND.
@end quotation
@end cartouche

O módulo @ref{f3,,tkinter.dnd} fornece suporte de arrastar e soltar para objetos dentro de uma única aplicação, dentro da mesma janela ou entre janelas. Para permitir que um objeto seja arrastado, você deve criar uma associação de evento para ele que inicie o processo de arrastar e soltar. Normalmente, você associa um evento ButtonPress a uma função de retorno que você escreve (consulte @ref{3fb2,,Ligações e Eventos}). A função deve chamar @ref{4024,,dnd_start()}, onde ‘source’ é o objeto a ser arrastado e ‘event’ é o evento que invocou a chamada (o argumento para sua função de retorno).

A seleção de um objeto de destino ocorre da seguinte forma:


@enumerate 

@item 
Pesquisa de cima para baixo da área sob o mouse para o widget alvo
@end enumerate

@quotation


@itemize *

@item 
O widget alvo deve ter um atributo chamável `dnd_accept'

@item 
Se `dnd_accept' não estiver presente ou retornar @code{None}, a pesquisa vai para o widget pai

@item 
Se nenhum widget de destino for encontrado, o objeto alvo é @code{None}
@end itemize
@end quotation


@enumerate 2

@item 
Chamada para `<old_target>.dnd_leave(source, event)'

@item 
Chamada para `<new_target>.dnd_enter(source, event)'

@item 
Chamada para `<target>.dnd_commit(source, event)' para notificar que soltou

@item 
Chamada para `<source>.dnd_end(target, event)' para sinalizar o fim do arrastar e soltar
@end enumerate

@geindex DndHandler (classe em tkinter.dnd)
@anchor{library/tkinter dnd tkinter dnd DndHandler}@anchor{4025}
@deffn {Classe} tkinter.dnd.DndHandler (source, event)

A classe `DndHandler' trata de eventos de arrastar e soltar que rastreiam eventos Motion e ButtonRelease na raiz do widget de evento.

@geindex cancel() (método tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler cancel}@anchor{4026}
@deffn {Método} cancel (event=None)

Cancela o processo de arrastar e soltar.
@end deffn

@geindex finish() (método tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler finish}@anchor{4027}
@deffn {Método} finish (event, commit=0)

Executa o fim das funções de arrastar e soltar.
@end deffn

@geindex on_motion() (método tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler on_motion}@anchor{4028}
@deffn {Método} on_motion (event)

Inspeciona a área abaixo do mouse para objetos alvos enquanto o arrasto é executado.
@end deffn

@geindex on_release() (método tkinter.dnd.DndHandler)
@anchor{library/tkinter dnd tkinter dnd DndHandler on_release}@anchor{4029}
@deffn {Método} on_release (event)

Sinaliza o fim do arrasto quando o padrão de liberação for acionado.
@end deffn
@end deffn

@geindex dnd_start() (no módulo tkinter.dnd)
@anchor{library/tkinter dnd tkinter dnd dnd_start}@anchor{4024}
@deffn {Função} tkinter.dnd.dnd_start (source, event)

Função de fábrica para processo de arrastar e soltar.
@end deffn


@subsubheading Ver também


@ref{3fb2,,Ligações e Eventos}


@node tkinter ttk — Widgets temáticos do Tk,IDLE — editor e console Python<2>,tkinter dnd — Suporte para arrastar e soltar,Interfaces gráficas de usuário com Tk
@anchor{library/tkinter ttk doc}@anchor{402a}@anchor{library/tkinter ttk module-tkinter ttk}@anchor{f9}@anchor{library/tkinter ttk tkinter-ttk-tk-themed-widgets}@anchor{402b}@anchor{library/tkinter ttk translation-repo}@anchor{402c}
@subsection @code{tkinter.ttk} — Widgets temáticos do Tk


@geindex module; tkinter.ttk

`Código-fonte:' Lib/tkinter/ttk.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tkinter/ttk.py}

@geindex ttk


__________________________________________________________________


O módulo @ref{f9,,tkinter.ttk} introduzido no Tk 8.5, fornece acesso ao conjunto de widgets temáticos do Tk, Alguns dos benefícios incluídos são a renderização de fontes com suavização de serrilhamento no x11 e transparência de janelas (requer um gerenciador de composição de janelas no x11).

A ideia básica para @ref{f9,,tkinter.ttk} é separar, na medida do possível, o código que implementa o comportamento de widget do código que implementa sua aparência.


@subsubheading Ver também



@table @asis

@item Tk Widget Styling Support@footnote{https://core.tcl.tk/tips/doc/trunk/tip/48.md}

Um documento que apresenta o suporte de temas para Tk
@end table


@menu
* Usando Ttk:: 
* Widgets Ttk:: 
* Widget:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk Styling:: 

@end menu

@node Usando Ttk,Widgets Ttk,,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk using-ttk}@anchor{402d}
@subsubsection Usando Ttk


Para começar a usar Ttk, importe seu módulo:

@example
from tkinter import ttk
@end example

Para substituir os widgets básicos do Tk, a importação deve seguir a importação do Tk:

@example
from tkinter import *
from tkinter.ttk import *
@end example

Esse código faz com que vários 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} e @code{Scrollbar}) substituam automaticamente os widgets Tk.

Isso traz o benefício direto de utilizar os widgets novos que possuem melhor aparência e sensação de uso entre as plataformas, contudo, os widgets substitutos não são completamente compatíveis. A maior diferença é que as opções como “fg”, “bg” e outras relacionadas à estilização do widget não estão mais presentes nos widgets Ttk.  Em vez disso, use  a classe @code{ttk.Style} para melhores efeitos de estilização.


@subsubheading Ver também



@table @asis

@item Convertendo aplicações existentes para utilização dos widgets Tile@footnote{https://tktable.sourceforge.net/tile/doc/converting.txt}

Uma monografia (utilizando a terminologia Tcl) sobre diferenças tipicamente encontradas ao mover aplicações para utilização de novos widgets.
@end table


@node Widgets Ttk,Widget,Usando Ttk,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk ttk-widgets}@anchor{402e}
@subsubsection Widgets Ttk


Ttk traz 18 widgets, das quais doze já existiam no tkinter: @code{Button}, @code{Checkbutton}, @code{Entry}, @code{Frame}, @code{Label}, @code{LabelFrame}, @code{Menubutton}, @code{PanedWindow}, @code{Radiobutton}, @code{Scale}, @code{Scrollbar}, e @ref{bac,,Spinbox}. As outras seis são novas: @ref{402f,,Combobox}, @ref{4030,,Notebook}, @ref{4031,,Progressbar}, @code{Separator}, @code{Sizegrip} e @ref{a9f,,Treeview}. E todas elas são subclasses de @ref{4032,,Widget}.

Utilizar os widgets Ttk melhora a experiência de uso e o visual da aplicação. Conforme discutido anteriormente, existem diferenças em como a estilização é codificada.

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 mais informações sobre @ref{4033,,TtkStyling}, veja a documentação da classe @ref{259,,Style}.

@node Widget,Combobox,Widgets Ttk,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk widget}@anchor{4034}
@subsubsection Widget


@code{ttk.Widget} define opções padrão e métodos suportados pelos widgets temáticos Tk e não deve ser instanciada diretamente.

@menu
* Opções padrão:: 
* Opções de ferramenta rolável:: 
* Opções de rótulo:: 
* Opções de compatibilidade:: 
* Estados de Widget:: 
* ttk.Widget: ttk Widget. 

@end menu

@node Opções padrão,Opções de ferramenta rolável,,Widget
@anchor{library/tkinter ttk standard-options}@anchor{4035}
@subsubsection Opções padrão


Todos os Widgets @code{ttk} aceitam as seguintes opções:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

classe

@tab

Specifies the window class. The class is used when querying
the option database for the window’s other options, to
determine the default bindtags for the window, and to select
the widget’s default layout and style. This option is
read-only, and may only be specified when the window is
created.

@item

cursor

@tab

Especifica o cursor do mouse a ser utilizado pelo widget. Caso seja definido como uma string vazia (padrão), o cursor é herdado do widget pai.

@item

takefocus

@tab

Determina se a janela aceitará foco durante a navegação com o teclado. Retorna 0, 1 ou uma string vazia. Caso retorne 0, significa que a janela deve ser completamente ignorada durante a navegação com o teclado. Caso retorne 1, significa que a janela receberá as entradas do teclado enquanto estiver visível. E a string vazia significa que os scripts de navegação determinam quando a janela recebe foco ou não.

@item

estilo

@tab

Pode ser utilizado para especificar um estilo customizado do widget.

@end multitable


@node Opções de ferramenta rolável,Opções de rótulo,Opções padrão,Widget
@anchor{library/tkinter ttk scrollable-widget-options}@anchor{4036}
@subsubsection Opções de ferramenta rolável


As opções a seguir são suportadas pelos widgets que são controlados por uma barra de rolagem.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

xscrollcommand

@tab

Utilizado para comunicação com barras de rolagem horizontais.

Quando a visualização na janela do widget mudar, o widget irá gerar um comando Tcl baseado no comando da barra de rolagem.

Geralmente essa opção consiste no método @code{Scrollbar.set()} de alguma barra de rolagem. Isso fará com que a barra de rolagem seja atualizada sempre que a visualização da janela mude.

@item

yscrollcommand

@tab

Utilizado para comunicação com barras de rolagem verticais. Para mais informações, veja acima.

@end multitable


@node Opções de rótulo,Opções de compatibilidade,Opções de ferramenta rolável,Widget
@anchor{library/tkinter ttk label-options}@anchor{4037}
@subsubsection Opções de rótulo


As opções a seguir são suportadas por rótulos, botões e outros widgets semelhantes.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

text

@tab

Especifica uma string para exibição dentro do widget.

@item

textvariable

@tab

Specifies a name whose value will be used in place of the
text option resource.

@item

underline

@tab

Caso definido, especifica o índice (base-0) de um caractere para sublinhamento na string de texto. O caractere sublinhado é utilizado para ativação mnemônica.

@item

image

@tab

Define uma imagem para exibição. Isso é uma lista de 1 ou mais elementos. O primeiro elemento é o nome da imagem padrão. O resto da lista é uma sequência de pares estado/valor conforme definido por @ref{1a73,,Style.map()}, definindo imagens diferentes para utilização quando o widget estiver em um determinado estado ou em uma combinação de estados. Todas as imagens da lista devem ter o mesmo tamanho.

@item

compound

@tab

Define como exibir a imagem em relação ao texto, no caso em que ambas as opções de texto e imagem estejam presentes. Valores válidos são:


@itemize *

@item 
texto: exibir apenas texto

@item 
imagem: exibir apenas a imagem

@item 
top, bottom, left, right: exibem a imagem acima, abaixo, à esquerda, ou à direita do texto, respectivamente.

@item 
none: o padrão, exibe a imagem caso ela esteja presente, caso contrário , exibe o texto.
@end itemize

@item

width

@tab

Caso maior que zero, especifica quanto espaço, em largura de caracteres, alocar para o rótulo do texto, se menor que zero, especifica a largura mínima. Se zero ou inespecífico, é utilizada a largura normal do rótulo de texto.

@end multitable


@node Opções de compatibilidade,Estados de Widget,Opções de rótulo,Widget
@anchor{library/tkinter ttk compatibility-options}@anchor{4038}
@subsubsection Opções de compatibilidade



@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

state

@tab

May be set to “normal” or “disabled” to control the “disabled”
state bit. This is a write-only option: setting it changes the
widget state, but the @ref{4039,,Widget.state()} method does not
affect this option.

@end multitable


@node Estados de Widget,ttk Widget,Opções de compatibilidade,Widget
@anchor{library/tkinter ttk widget-states}@anchor{403a}
@subsubsection Estados de Widget


O estado do widget é um bitmap de sinalizadores de estado independentes.


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Descrição

@item

active

@tab

O cursor do mouse está sobre o widget e pressionar um botão do mouse causará alguma ação

@item

disabled

@tab

Widget está desabilitado sob controle do programa.

@item

focus

@tab

Widget tem foco do teclado

@item

pressed

@tab

Widget está sendo pressionado

@item

selected

@tab

“On”, “true”, ou “current” para coisas como botões de confirmação e botões de opção.

@item

background

@tab

Windows e Mac possuem uma noção de janela “ativa” ou em primeiro plano. O estado de “plano de fundo” é definido para widgets em uma janela no plano de fundo, e limpo para aqueles na janela de primeiro plano

@item

readonly

@tab

Widget não deve permitir modificação do usuário

@item

alternate

@tab

Um formato de exibição específico do widget

@item

invalid

@tab

O valor do widget é inválido

@end multitable


Uma especificação de estado é uma sequência de nomes de estado, opcionalmente prefixada por um ponto de exclamação indicando que o bit está desligado.

@node ttk Widget,,Estados de Widget,Widget
@anchor{library/tkinter ttk ttk-widget}@anchor{403b}
@subsubsection ttk.Widget


Além dos métodos descritos abaixo, a classe @code{ttk.Widget} oferece suporte aos métodos @code{tkinter.Widget.cget()} e @code{tkinter.Widget.configure()}.

@geindex Widget (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Widget}@anchor{4032}
@deffn {Classe} tkinter.ttk.Widget

@geindex identify() (método tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget identify}@anchor{403c}
@deffn {Método} identify (x, y)

Retorna o nome do elemento na posição `x' `y', ou a string vazia caso o ponto não esteja dentro de algum elemento.

`x' e `y' são coordenadas de pixel relativas ao widget.
@end deffn

@geindex instate() (método tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget instate}@anchor{403d}
@deffn {Método} instate (statespec, callback=None, *args, **kw)

Test the widget’s state. If a callback is not specified, returns @code{True}
if the widget state matches `statespec' and @code{False} otherwise. If callback
is specified then it is called with args if widget state matches
`statespec'.
@end deffn

@geindex state() (método tkinter.ttk.Widget)
@anchor{library/tkinter ttk tkinter ttk Widget state}@anchor{4039}
@deffn {Método} state (statespec=None)

Modify or inquire widget state. If `statespec' is specified, sets the
widget state according to it and return a new `statespec' indicating
which flags were changed. If `statespec' is not specified, returns
the currently enabled state flags.
@end deffn

`statespec' will usually be a list or a tuple.
@end deffn

@node Combobox,Spinbox,Widget,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk combobox}@anchor{403e}
@subsubsection Combobox


O widget @code{ttk.Combobox} combina um campo de texto com uma lista suspensa de valores. Esse widget é uma subclasse de @code{Entry}.

Besides the methods inherited from @ref{4032,,Widget}: @code{Widget.cget()},
@code{Widget.configure()}, @ref{403c,,Widget.identify()}, @ref{403d,,Widget.instate()}
and @ref{4039,,Widget.state()}, and the following inherited from @code{Entry}:
@code{Entry.bbox()}, @code{Entry.delete()}, @code{Entry.icursor()},
@code{Entry.index()}, @code{Entry.insert()}, @code{Entry.selection()},
@code{Entry.xview()}, it has some other methods, described at
@code{ttk.Combobox}.

@menu
* Opções:: 
* Eventos virtuais:: 
* ttk.Combobox: ttk Combobox. 

@end menu

@node Opções,Eventos virtuais,,Combobox
@anchor{library/tkinter ttk options}@anchor{403f}
@subsubsection Opções


Este widget aceita as seguintes opções específicas:


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

exportselection

@tab

Valor booleano. Caso definido, a seleção do widget é vinculada à seleção do Gerenciador de Janelas (que pode ser retornada ao chamar Misc.selection_get, por exemplo).

@item

justify

@tab

Especifica como o texto é alinhado dentro do widget. Pode ser “left”, “center” ou “right”.

@item

height

@tab

Especifica a altura, em linhas, da lista suspensa.

@item

postcommand

@tab

Um script (possivelmente registrado com Misc.register) que é chamado imediatamente antes da exibição dos valores. Ele pode especificar quais valores exibir.

@item

state

@tab

Um dos estados: “normal”, “readonly” ou “disabled”. No estado “readonly”, o valor não pode ser editado diretamente, e o usuário só pode selecionar valores contidos na lista suspensa. No estado “normal”, o campo de texto é diretamente editável. No estado “disabled”, nenhuma interação é possível.

@item

textvariable

@tab

Especifica um nome que terá seu valor vinculado ao valor do widget. Sempre que o valor associado a esse nome mudar, o valor do widget será atualizado, e vice versa. Veja @code{tkinter.StringVar}.

@item

valores

@tab

Especifica a lista de valores para exibição na lista suspensa.

@item

width

@tab

Specifies an integer value indicating the desired width
of the entry window, in average-size characters of the
widget’s font.

@end multitable


@node Eventos virtuais,ttk Combobox,Opções,Combobox
@anchor{library/tkinter ttk virtual-events}@anchor{4040}
@subsubsection Eventos virtuais


Os widgets combobox geram um evento virtual `<<ComboboxSelected>>' quando o usuário seleciona um elemento da lista de valores.

@node ttk Combobox,,Eventos virtuais,Combobox
@anchor{library/tkinter ttk ttk-combobox}@anchor{4041}
@subsubsection ttk.Combobox


@geindex Combobox (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Combobox}@anchor{402f}
@deffn {Classe} tkinter.ttk.Combobox

@geindex current() (método tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox current}@anchor{4042}
@deffn {Método} current (newindex=None)

If `newindex' is specified, sets the combobox value to the element
position `newindex'. Otherwise, returns the index of the current value or
-1 if the current value is not in the values list.
@end deffn

@geindex get() (método tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox get}@anchor{4043}
@deffn {Método} get ()

Retorna o valor atual do combobox.
@end deffn

@geindex set() (método tkinter.ttk.Combobox)
@anchor{library/tkinter ttk tkinter ttk Combobox set}@anchor{4044}
@deffn {Método} set (value)

Sets the value of the combobox to `value'.
@end deffn
@end deffn

@node Spinbox,Notebook,Combobox,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk spinbox}@anchor{4045}
@subsubsection Spinbox


The @code{ttk.Spinbox} widget is a @code{ttk.Entry} enhanced with increment
and decrement arrows.  It can be used for numbers or lists of string values.
This widget is a subclass of @code{Entry}.

Besides the methods inherited from @ref{4032,,Widget}: @code{Widget.cget()},
@code{Widget.configure()}, @ref{403c,,Widget.identify()}, @ref{403d,,Widget.instate()}
and @ref{4039,,Widget.state()}, and the following inherited from @code{Entry}:
@code{Entry.bbox()}, @code{Entry.delete()}, @code{Entry.icursor()},
@code{Entry.index()}, @code{Entry.insert()}, @code{Entry.xview()},
it has some other methods, described at @code{ttk.Spinbox}.

@menu
* Opções: Opções<2>. 
* Eventos virtuais: Eventos virtuais<2>. 
* ttk.Spinbox: ttk Spinbox. 

@end menu

@node Opções<2>,Eventos virtuais<2>,,Spinbox
@anchor{library/tkinter ttk id1}@anchor{4046}
@subsubsection Opções


Este widget aceita as seguintes opções específicas:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

from

@tab

Float value.  If set, this is the minimum value to
which the decrement button will decrement.  Must be
spelled as @code{from_} when used as an argument, since
@code{from} is a Python keyword.

@item

to

@tab

Float value.  If set, this is the maximum value to
which the increment button will increment.

@item

increment

@tab

Float value.  Specifies the amount which the
increment/decrement buttons change the
value. Defaults to 1.0.

@item

valores

@tab

Sequence of string or float values.  If specified,
the increment/decrement buttons will cycle through
the items in this sequence rather than incrementing
or decrementing numbers.

@item

wrap

@tab

Boolean value.  If @code{True}, increment and decrement
buttons will cycle from the @code{to} value to the
@code{from} value or the @code{from} value to the @code{to}
value, respectively.

@item

format

@tab

String value.  This specifies the format of numbers
set by the increment/decrement buttons.  It must be
in the form “%W.Pf”, where W is the padded width of
the value, P is the precision, and ‘%’ and ‘f’ are
literal.

@item

command

@tab

Python callable.  Will be called with no arguments
whenever either of the increment or decrement buttons
are pressed.

@end multitable


@node Eventos virtuais<2>,ttk Spinbox,Opções<2>,Spinbox
@anchor{library/tkinter ttk id2}@anchor{4047}
@subsubsection Eventos virtuais


The spinbox widget generates an `<<Increment>>' virtual event when the
user presses <Up>, and a `<<Decrement>>' virtual event when the user
presses <Down>.

@node ttk Spinbox,,Eventos virtuais<2>,Spinbox
@anchor{library/tkinter ttk ttk-spinbox}@anchor{4048}
@subsubsection ttk.Spinbox


@geindex Spinbox (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Spinbox}@anchor{bac}
@deffn {Classe} tkinter.ttk.Spinbox

@geindex get() (método tkinter.ttk.Spinbox)
@anchor{library/tkinter ttk tkinter ttk Spinbox get}@anchor{4049}
@deffn {Método} get ()

Returns the current value of the spinbox.
@end deffn

@geindex set() (método tkinter.ttk.Spinbox)
@anchor{library/tkinter ttk tkinter ttk Spinbox set}@anchor{404a}
@deffn {Método} set (value)

Sets the value of the spinbox to `value'.
@end deffn
@end deffn

@node Notebook,Progressbar,Spinbox,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk notebook}@anchor{404b}
@subsubsection Notebook


Ttk Notebook widget manages a collection of windows and displays a single
one at a time. Each child window is associated with a tab, which the user
may select to change the currently displayed window.

@menu
* Opções: Opções<3>. 
* Tab Options:: 
* Tab Identifiers:: 
* Virtual Events:: 
* ttk.Notebook: ttk Notebook. 

@end menu

@node Opções<3>,Tab Options,,Notebook
@anchor{library/tkinter ttk id3}@anchor{404c}
@subsubsection Opções


Este widget aceita as seguintes opções específicas:


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

height

@tab

If present and greater than zero, specifies the desired height
of the pane area (not including internal padding or tabs).
Otherwise, the maximum height of all panes is used.

@item

padding

@tab

Specifies the amount of extra space to add around the outside
of the notebook. The padding is a list up to four length
specifications left top right bottom. If fewer than four
elements are specified, bottom defaults to top, right defaults
to left, and top defaults to left.

@item

width

@tab

If present and greater than zero, specified the desired width
of the pane area (not including internal padding). Otherwise,
the maximum width of all panes is used.

@end multitable


@node Tab Options,Tab Identifiers,Opções<3>,Notebook
@anchor{library/tkinter ttk tab-options}@anchor{404d}
@subsubsection Tab Options


There are also specific options for tabs:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

state

@tab

Either “normal”, “disabled” or “hidden”. If “disabled”, then
the tab is not selectable. If “hidden”, then the tab is not
shown.

@item

sticky

@tab

Specifies how the child window is positioned within the pane
area. Value is a string containing zero or more of the
characters “n”, “s”, “e” or “w”. Each letter refers to a
side (north, south, east or west) that the child window will
stick to, as per the @code{grid()} geometry manager.

@item

padding

@tab

Specifies the amount of extra space to add between the
notebook and this pane. Syntax is the same as for the option
padding used by this widget.

@item

text

@tab

Specifies a text to be displayed in the tab.

@item

image

@tab

Specifies an image to display in the tab. See the option
image described in @ref{4032,,Widget}.

@item

compound

@tab

Specifies how to display the image relative to the text, in
the case both options text and image are present. See
@ref{4037,,Label Options} for legal values.

@item

underline

@tab

Specifies the index (0-based) of a character to underline in
the text string. The underlined character is used for
mnemonic activation if @ref{404e,,Notebook.enable_traversal()} is
called.

@end multitable


@node Tab Identifiers,Virtual Events,Tab Options,Notebook
@anchor{library/tkinter ttk tab-identifiers}@anchor{404f}
@subsubsection Tab Identifiers


The tab_id present in several methods of @code{ttk.Notebook} may take any
of the following forms:


@itemize *

@item 
An integer between zero and the number of tabs

@item 
The name of a child window

@item 
A positional specification of the form “@@x,y”, which identifies the tab

@item 
The literal string “current”, which identifies the currently selected tab

@item 
The literal string “end”, which returns the number of tabs (only valid for
@ref{4050,,Notebook.index()})
@end itemize

@node Virtual Events,ttk Notebook,Tab Identifiers,Notebook
@anchor{library/tkinter ttk id4}@anchor{4051}
@subsubsection Virtual Events


This widget generates a `<<NotebookTabChanged>>' virtual event after a new
tab is selected.

@node ttk Notebook,,Virtual Events,Notebook
@anchor{library/tkinter ttk ttk-notebook}@anchor{4052}
@subsubsection ttk.Notebook


@geindex Notebook (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Notebook}@anchor{4030}
@deffn {Classe} tkinter.ttk.Notebook

@geindex add() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook add}@anchor{4053}
@deffn {Método} add (child, **kw)

Adds a new tab to the notebook.

If window is currently managed by the notebook but hidden, it is
restored to its previous position.

See @ref{404d,,Tab Options} for the list of available options.
@end deffn

@geindex forget() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook forget}@anchor{4054}
@deffn {Método} forget (tab_id)

Removes the tab specified by `tab_id', unmaps and unmanages the
associated window.
@end deffn

@geindex hide() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook hide}@anchor{4055}
@deffn {Método} hide (tab_id)

Hides the tab specified by `tab_id'.

The tab will not be displayed, but the associated window remains
managed by the notebook and its configuration remembered. Hidden tabs
may be restored with the @ref{4053,,add()} command.
@end deffn

@geindex identify() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook identify}@anchor{4056}
@deffn {Método} identify (x, y)

Returns the name of the tab element at position `x', `y', or the empty
string if none.
@end deffn

@geindex index() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook index}@anchor{4050}
@deffn {Método} index (tab_id)

Returns the numeric index of the tab specified by `tab_id', or the total
number of tabs if `tab_id' is the string “end”.
@end deffn

@geindex insert() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook insert}@anchor{4057}
@deffn {Método} insert (pos, child, **kw)

Inserts a pane at the specified position.

`pos' is either the string “end”, an integer index, or the name of a
managed child. If `child' is already managed by the notebook, moves it to
the specified position.

See @ref{404d,,Tab Options} for the list of available options.
@end deffn

@geindex select() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook select}@anchor{4058}
@deffn {Método} select (tab_id=None)

Selects the specified `tab_id'.

The associated child window will be displayed, and the
previously selected window (if different) is unmapped. If `tab_id' is
omitted, returns the widget name of the currently selected pane.
@end deffn

@geindex tab() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook tab}@anchor{4059}
@deffn {Método} tab (tab_id, option=None, **kw)

Query or modify the options of the specific `tab_id'.

If `kw' is not given, returns a dictionary of the tab option values. If
`option' is specified, returns the value of that `option'. Otherwise,
sets the options to the corresponding values.
@end deffn

@geindex tabs() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook tabs}@anchor{405a}
@deffn {Método} tabs ()

Returns a list of windows managed by the notebook.
@end deffn

@geindex enable_traversal() (método tkinter.ttk.Notebook)
@anchor{library/tkinter ttk tkinter ttk Notebook enable_traversal}@anchor{404e}
@deffn {Método} enable_traversal ()

Enable keyboard traversal for a toplevel window containing this notebook.

This will extend the bindings for the toplevel window containing the
notebook as follows:


@itemize *

@item 
@code{Control}-@code{Tab}: selects the tab following the currently selected one.

@item 
@code{Shift}-@code{Control}-@code{Tab}: selects the tab preceding the currently selected one.

@item 
@code{Alt}-@code{K}: where `K' is the mnemonic (underlined) character of any tab, will
select that tab.
@end itemize

Multiple notebooks in a single toplevel may be enabled for traversal,
including nested notebooks. However, notebook traversal only works
properly if all panes have the notebook they are in as master.
@end deffn
@end deffn

@node Progressbar,Separator,Notebook,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk progressbar}@anchor{405b}
@subsubsection Progressbar


The @code{ttk.Progressbar} widget shows the status of a long-running
operation. It can operate in two modes:  1) the determinate mode which shows the
amount completed relative to the total amount of work to be done and 2) the
indeterminate mode which provides an animated display to let the user know that
work is progressing.

@menu
* Opções: Opções<4>. 
* ttk.Progressbar: ttk Progressbar. 

@end menu

@node Opções<4>,ttk Progressbar,,Progressbar
@anchor{library/tkinter ttk id5}@anchor{405c}
@subsubsection Opções


Este widget aceita as seguintes opções específicas:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

orient

@tab

One of “horizontal” or “vertical”. Specifies the orientation
of the progress bar.

@item

length

@tab

Specifies the length of the long axis of the progress bar
(width if horizontal, height if vertical).

@item

mode

@tab

One of “determinate” or “indeterminate”.

@item

maximum

@tab

A number specifying the maximum value. Defaults to 100.

@item

valor

@tab

The current value of the progress bar. In “determinate” mode,
this represents the amount of work completed. In
“indeterminate” mode, it is interpreted as modulo `maximum';
that is, the progress bar completes one “cycle” when its value
increases by `maximum'.

@item

variável

@tab

A name which is linked to the option value. If specified, the
value of the progress bar is automatically set to the value of
this name whenever the latter is modified.

@item

phase

@tab

Read-only option. The widget periodically increments the value
of this option whenever its value is greater than 0 and, in
determinate mode, less than maximum. This option may be used
by the current theme to provide additional animation effects.

@end multitable


@node ttk Progressbar,,Opções<4>,Progressbar
@anchor{library/tkinter ttk ttk-progressbar}@anchor{405d}
@subsubsection ttk.Progressbar


@geindex Progressbar (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Progressbar}@anchor{4031}
@deffn {Classe} tkinter.ttk.Progressbar

@geindex start() (método tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar start}@anchor{405e}
@deffn {Método} start (interval=None)

Begin autoincrement mode: schedules a recurring timer event that calls
@ref{405f,,Progressbar.step()} every `interval' milliseconds. If omitted,
`interval' defaults to 50 milliseconds.
@end deffn

@geindex step() (método tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar step}@anchor{405f}
@deffn {Método} step (amount=None)

Increments the progress bar’s value by `amount'.

`amount' defaults to 1.0 if omitted.
@end deffn

@geindex stop() (método tkinter.ttk.Progressbar)
@anchor{library/tkinter ttk tkinter ttk Progressbar stop}@anchor{4060}
@deffn {Método} stop ()

Stop autoincrement mode: cancels any recurring timer event initiated by
@ref{405e,,Progressbar.start()} for this progress bar.
@end deffn
@end deffn

@node Separator,Sizegrip,Progressbar,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk separator}@anchor{4061}
@subsubsection Separator


The @code{ttk.Separator} widget displays a horizontal or vertical separator
bar.

It has no other methods besides the ones inherited from @code{ttk.Widget}.

@menu
* Opções: Opções<5>. 

@end menu

@node Opções<5>,,,Separator
@anchor{library/tkinter ttk id6}@anchor{4062}
@subsubsection Opções


This widget accepts the following specific option:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

orient

@tab

One of “horizontal” or “vertical”. Specifies the orientation of
the separator.

@end multitable


@node Sizegrip,Treeview,Separator,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk sizegrip}@anchor{4063}
@subsubsection Sizegrip


The @code{ttk.Sizegrip} widget (also known as a grow box) allows the user to
resize the containing toplevel window by pressing and dragging the grip.

This widget has neither specific options nor specific methods, besides the
ones inherited from @code{ttk.Widget}.

@menu
* Platform-specific notes:: 
* Bugs:: 

@end menu

@node Platform-specific notes,Bugs,,Sizegrip
@anchor{library/tkinter ttk platform-specific-notes}@anchor{4064}
@subsubsection Platform-specific notes



@itemize *

@item 
On macOS, toplevel windows automatically include a built-in size grip
by default. Adding a @code{Sizegrip} is harmless, since the built-in
grip will just mask the widget.
@end itemize

@node Bugs,,Platform-specific notes,Sizegrip
@anchor{library/tkinter ttk bugs}@anchor{4065}
@subsubsection Bugs



@itemize *

@item 
If the containing toplevel’s position was specified relative to the right
or bottom of the screen (e.g. ….), the @code{Sizegrip} widget will
not resize the window.

@item 
This widget supports only “southeast” resizing.
@end itemize

@node Treeview,Ttk Styling,Sizegrip,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk treeview}@anchor{4066}
@subsubsection Treeview


The @code{ttk.Treeview} widget displays a hierarchical collection of items.
Each item has a textual label, an optional image, and an optional list of data
values. The data values are displayed in successive columns after the tree
label.

The order in which data values are displayed may be controlled by setting
the widget option @code{displaycolumns}. The tree widget can also display column
headings. Columns may be accessed by number or symbolic names listed in the
widget option columns. See @ref{4067,,Column Identifiers}.

Each item is identified by a unique name. The widget will generate item IDs
if they are not supplied by the caller. There is a distinguished root item,
named @code{@{@}}. The root item itself is not displayed; its children appear at the
top level of the hierarchy.

Each item also has a list of tags, which can be used to associate event bindings
with individual items and control the appearance of the item.

The Treeview widget supports horizontal and vertical scrolling, according to
the options described in @ref{4036,,Scrollable Widget Options} and the methods
@ref{4068,,Treeview.xview()} and @ref{4069,,Treeview.yview()}.

@menu
* Opções: Opções<6>. 
* Item Options:: 
* Tag Options:: 
* Column Identifiers:: 
* Virtual Events: Virtual Events<2>. 
* ttk.Treeview: ttk Treeview. 

@end menu

@node Opções<6>,Item Options,,Treeview
@anchor{library/tkinter ttk id7}@anchor{406a}
@subsubsection Opções


Este widget aceita as seguintes opções específicas:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

columns

@tab

A list of column identifiers, specifying the number of
columns and their names.

@item

displaycolumns

@tab

A list of column identifiers (either symbolic or
integer indices) specifying which data columns are
displayed and the order in which they appear, or the
string “#all”.

@item

height

@tab

Specifies the number of rows which should be visible.
Note: the requested width is determined from the sum
of the column widths.

@item

padding

@tab

Specifies the internal padding for the widget. The
padding is a list of up to four length specifications.

@item

selectmode

@tab

Controls how the built-in class bindings manage the
selection. One of “extended”, “browse” or “none”.
If set to “extended” (the default), multiple items may
be selected. If “browse”, only a single item will be
selected at a time. If “none”, the selection will not
be changed.

Note that the application code and tag bindings can set
the selection however they wish, regardless of the
value  of this option.

@item

show

@tab

A list containing zero or more of the following values,
specifying which elements of the tree to display.


@itemize *

@item 
tree: display tree labels in column #0.

@item 
headings: display the heading row.
@end itemize

The default is “tree headings”, i.e., show all
elements.

`Note': Column #0 always refers to the tree column,
even if show=”tree” is not specified.

@end multitable


@node Item Options,Tag Options,Opções<6>,Treeview
@anchor{library/tkinter ttk item-options}@anchor{406b}
@subsubsection Item Options


The following item options may be specified for items in the insert and item
widget commands.


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

text

@tab

The textual label to display for the item.

@item

image

@tab

A Tk Image, displayed to the left of the label.

@item

valores

@tab

The list of values associated with the item.

Each item should have the same number of values as the widget
option columns. If there are fewer values than columns, the
remaining values are assumed empty. If there are more values
than columns, the extra values are ignored.

@item

open

@tab

@code{True}/@code{False} value indicating whether the item’s
children should be displayed or hidden.

@item

tags

@tab

A list of tags associated with this item.

@end multitable


@node Tag Options,Column Identifiers,Item Options,Treeview
@anchor{library/tkinter ttk tag-options}@anchor{406c}
@subsubsection Tag Options


The following options may be specified on tags:


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Opção

@tab

Descrição

@item

foreground

@tab

Specifies the text foreground color.

@item

background

@tab

Specifies the cell or item background color.

@item

font

@tab

Specifies the font to use when drawing text.

@item

image

@tab

Specifies the item image, in case the item’s image option
is empty.

@end multitable


@node Column Identifiers,Virtual Events<2>,Tag Options,Treeview
@anchor{library/tkinter ttk column-identifiers}@anchor{4067}
@subsubsection Column Identifiers


Column identifiers take any of the following forms:


@itemize *

@item 
A symbolic name from the list of columns option.

@item 
An integer n, specifying the nth data column.

@item 
A string of the form #n, where n is an integer, specifying the nth display
column.
@end itemize

Notas:


@itemize *

@item 
Item’s option values may be displayed in a different order than the order
in which they are stored.

@item 
Column #0 always refers to the tree column, even if show=”tree” is not
specified.
@end itemize

A data column number is an index into an item’s option values list; a display
column number is the column number in the tree where the values are displayed.
Tree labels are displayed in column #0. If option displaycolumns is not set,
then data column n is displayed in column #n+1. Again, `column #0 always
refers to the tree column'.

@node Virtual Events<2>,ttk Treeview,Column Identifiers,Treeview
@anchor{library/tkinter ttk id8}@anchor{406d}
@subsubsection Virtual Events


The Treeview widget generates the following virtual events.


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Evento

@tab

Descrição

@item

<<TreeviewSelect>>

@tab

Generated whenever the selection changes.

@item

<<TreeviewOpen>>

@tab

Generated just before settings the focus item to
open=True.

@item

<<TreeviewClose>>

@tab

Generated just after setting the focus item to
open=False.

@end multitable


The @ref{406e,,Treeview.focus()} and @ref{a9e,,Treeview.selection()} methods can be used
to determine the affected item or items.

@node ttk Treeview,,Virtual Events<2>,Treeview
@anchor{library/tkinter ttk ttk-treeview}@anchor{406f}
@subsubsection ttk.Treeview


@geindex Treeview (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Treeview}@anchor{a9f}
@deffn {Classe} tkinter.ttk.Treeview

@geindex bbox() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview bbox}@anchor{4070}
@deffn {Método} bbox (item, column=None)

Returns the bounding box (relative to the treeview widget’s window) of
the specified `item' in the form (x, y, width, height).

If `column' is specified, returns the bounding box of that cell. If the
`item' is not visible (i.e., if it is a descendant of a closed item or is
scrolled offscreen), returns an empty string.
@end deffn

@geindex get_children() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview get_children}@anchor{4071}
@deffn {Método} get_children (item=None)

Returns the list of children belonging to `item'.

If `item' is not specified, returns root children.
@end deffn

@geindex set_children() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview set_children}@anchor{4072}
@deffn {Método} set_children (item, *newchildren)

Replaces `item'’s child with `newchildren'.

Children present in `item' that are not present in `newchildren' are
detached from the tree. No items in `newchildren' may be an ancestor of
`item'. Note that not specifying `newchildren' results in detaching
`item'’s children.
@end deffn

@geindex column() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview column}@anchor{4073}
@deffn {Método} column (column, option=None, **kw)

Query or modify the options for the specified `column'.

If `kw' is not given, returns a dict of the column option values. If
`option' is specified then the value for that `option' is returned.
Otherwise, sets the options to the corresponding values.

The valid options/values are:


@table @asis

@item `id'

Returns the column name. This is a read-only option.

@item `anchor': One of the standard Tk anchor values.

Specifies how the text in this column should be aligned with respect
to the cell.

@item `minwidth': width

The minimum width of the column in pixels. The treeview widget will
not make the column any smaller than specified by this option when
the widget is resized or the user drags a column.

@item `stretch': @code{True}/@code{False}

Specifies whether the column’s width should be adjusted when
the widget is resized.

@item `width': width

The width of the column in pixels.
@end table

To configure the tree column, call this with column = “#0”
@end deffn

@geindex delete() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview delete}@anchor{4074}
@deffn {Método} delete (*items)

Delete all specified `items' and all their descendants.

The root item may not be deleted.
@end deffn

@geindex detach() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview detach}@anchor{4075}
@deffn {Método} detach (*items)

Unlinks all of the specified `items' from the tree.

The items and all of their descendants are still present, and may be
reinserted at another point in the tree, but will not be displayed.

The root item may not be detached.
@end deffn

@geindex exists() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview exists}@anchor{4076}
@deffn {Método} exists (item)

Returns @code{True} if the specified `item' is present in the tree.
@end deffn

@geindex focus() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview focus}@anchor{406e}
@deffn {Método} focus (item=None)

If `item' is specified, sets the focus item to `item'. Otherwise, returns
the current focus item, or ‘’ if there is none.
@end deffn

@geindex heading() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview heading}@anchor{4077}
@deffn {Método} heading (column, option=None, **kw)

Query or modify the heading options for the specified `column'.

If `kw' is not given, returns a dict of the heading option values. If
`option' is specified then the value for that `option' is returned.
Otherwise, sets the options to the corresponding values.

The valid options/values are:


@table @asis

@item `text': text

The text to display in the column heading.

@item `image': imageName

Specifies an image to display to the right of the column heading.

@item `anchor': anchor

Specifies how the heading text should be aligned. One of the standard
Tk anchor values.

@item `command': callback

A callback to be invoked when the heading label is pressed.
@end table

To configure the tree column heading, call this with column = “#0”.
@end deffn

@geindex identify() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify}@anchor{4078}
@deffn {Método} identify (component, x, y)

Returns a description of the specified `component' under the point given
by `x' and `y', or the empty string if no such `component' is present at
that position.
@end deffn

@geindex identify_row() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_row}@anchor{4079}
@deffn {Método} identify_row (y)

Returns the item ID of the item at position `y'.
@end deffn

@geindex identify_column() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_column}@anchor{407a}
@deffn {Método} identify_column (x)

Returns the data column identifier of the cell at position `x'.

The tree column has ID #0.
@end deffn

@geindex identify_region() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_region}@anchor{407b}
@deffn {Método} identify_region (x, y)

Returns one of:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

region

@tab

meaning

@item

heading

@tab

Tree heading area.

@item

separator

@tab

Space between two columns headings.

@item

tree

@tab

The tree area.

@item

cell

@tab

A data cell.

@end multitable


Availability: Tk 8.6.
@end deffn

@geindex identify_element() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview identify_element}@anchor{407c}
@deffn {Método} identify_element (x, y)

Returns the element at position `x', `y'.

Availability: Tk 8.6.
@end deffn

@geindex index() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview index}@anchor{407d}
@deffn {Método} index (item)

Returns the integer index of `item' within its parent’s list of children.
@end deffn

@geindex insert() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview insert}@anchor{407e}
@deffn {Método} insert (parent, index, iid=None, **kw)

Creates a new item and returns the item identifier of the newly created
item.

`parent' is the item ID of the parent item, or the empty string to create
a new top-level item. `index' is an integer, or the value “end”,
specifying where in the list of parent’s children to insert the new item.
If `index' is less than or equal to zero, the new node is inserted at
the beginning; if `index' is greater than or equal to the current number
of children, it is inserted at the end. If `iid' is specified, it is used
as the item identifier; `iid' must not already exist in the tree.
Otherwise, a new unique identifier is generated.

See @ref{406b,,Item Options} for the list of available options.
@end deffn

@geindex item() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview item}@anchor{407f}
@deffn {Método} item (item, option=None, **kw)

Query or modify the options for the specified `item'.

If no options are given, a dict with options/values for the item is
returned.
If `option' is specified then the value for that option is returned.
Otherwise, sets the options to the corresponding values as given by `kw'.
@end deffn

@geindex move() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview move}@anchor{4080}
@deffn {Método} move (item, parent, index)

Moves `item' to position `index' in `parent'’s list of children.

It is illegal to move an item under one of its descendants. If `index' is
less than or equal to zero, `item' is moved to the beginning; if greater
than or equal to the number of children, it is moved to the end. If `item'
was detached it is reattached.
@end deffn

@geindex next() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview next}@anchor{4081}
@deffn {Método} next (item)

Returns the identifier of `item'’s next sibling, or ‘’ if `item' is the
last child of its parent.
@end deffn

@geindex parent() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview parent}@anchor{4082}
@deffn {Método} parent (item)

Returns the ID of the parent of `item', or ‘’ if `item' is at the top
level of the hierarchy.
@end deffn

@geindex prev() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview prev}@anchor{4083}
@deffn {Método} prev (item)

Returns the identifier of `item'’s previous sibling, or ‘’ if `item' is
the first child of its parent.
@end deffn

@geindex reattach() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview reattach}@anchor{4084}
@deffn {Método} reattach (item, parent, index)

An alias for @ref{4080,,Treeview.move()}.
@end deffn

@geindex see() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview see}@anchor{4085}
@deffn {Método} see (item)

Ensure that `item' is visible.

Sets all of `item'’s ancestors open option to @code{True}, and scrolls the
widget if necessary so that `item' is within the visible portion of
the tree.
@end deffn

@geindex selection() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection}@anchor{a9e}
@deffn {Método} selection ()

Returns a tuple of selected items.


Alterado na versão 3.8: @code{selection()} no longer takes arguments.  For changing the selection
state use the following selection methods.

@end deffn

@geindex selection_set() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_set}@anchor{aa0}
@deffn {Método} selection_set (*items)

`items' becomes the new selection.


Alterado na versão 3.6: `items' can be passed as separate arguments, not just as a single tuple.

@end deffn

@geindex selection_add() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_add}@anchor{4086}
@deffn {Método} selection_add (*items)

Add `items' to the selection.


Alterado na versão 3.6: `items' can be passed as separate arguments, not just as a single tuple.

@end deffn

@geindex selection_remove() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_remove}@anchor{4087}
@deffn {Método} selection_remove (*items)

Remove `items' from the selection.


Alterado na versão 3.6: `items' can be passed as separate arguments, not just as a single tuple.

@end deffn

@geindex selection_toggle() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview selection_toggle}@anchor{4088}
@deffn {Método} selection_toggle (*items)

Toggle the selection state of each item in `items'.


Alterado na versão 3.6: `items' can be passed as separate arguments, not just as a single tuple.

@end deffn

@geindex set() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview set}@anchor{4089}
@deffn {Método} set (item, column=None, value=None)

With one argument, returns a dictionary of column/value pairs for the
specified `item'. With two arguments, returns the current value of the
specified `column'. With three arguments, sets the value of given
`column' in given `item' to the specified `value'.
@end deffn

@geindex tag_bind() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_bind}@anchor{408a}
@deffn {Método} tag_bind (tagname, sequence=None, callback=None)

Bind a callback for the given event `sequence' to the tag `tagname'.
When an event is delivered to an item, the callbacks for each of the
item’s tags option are called.
@end deffn

@geindex tag_configure() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_configure}@anchor{408b}
@deffn {Método} tag_configure (tagname, option=None, **kw)

Query or modify the options for the specified `tagname'.

If `kw' is not given, returns a dict of the option settings for
`tagname'. If `option' is specified, returns the value for that `option'
for the specified `tagname'. Otherwise, sets the options to the
corresponding values for the given `tagname'.
@end deffn

@geindex tag_has() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview tag_has}@anchor{408c}
@deffn {Método} tag_has (tagname, item=None)

If `item' is specified, returns 1 or 0 depending on whether the specified
`item' has the given `tagname'. Otherwise, returns a list of all items
that have the specified tag.

Availability: Tk 8.6
@end deffn

@geindex xview() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview xview}@anchor{4068}
@deffn {Método} xview (*args)

Query or modify horizontal position of the treeview.
@end deffn

@geindex yview() (método tkinter.ttk.Treeview)
@anchor{library/tkinter ttk tkinter ttk Treeview yview}@anchor{4069}
@deffn {Método} yview (*args)

Query or modify vertical position of the treeview.
@end deffn
@end deffn

@node Ttk Styling,,Treeview,tkinter ttk — Widgets temáticos do Tk
@anchor{library/tkinter ttk ttk-styling}@anchor{408d}@anchor{library/tkinter ttk ttkstyling}@anchor{4033}
@subsubsection Ttk Styling


Each widget in @code{ttk} is assigned a style, which specifies the set of
elements making up the widget and how they are arranged, along with dynamic
and default settings for element options. By default the style name is the
same as the widget’s class name, but it may be overridden by the widget’s style
option. If you don’t know the class name of a widget, use the method
@code{Misc.winfo_class()} (somewidget.winfo_class()).


@subsubheading Ver também



@table @asis

@item Tcl'2004 conference presentation@footnote{https://tktable.sourceforge.net/tile/tile-tcl2004.pdf}

This document explains how the theme engine works
@end table


@geindex Style (classe em tkinter.ttk)
@anchor{library/tkinter ttk tkinter ttk Style}@anchor{259}
@deffn {Classe} tkinter.ttk.Style

This class is used to manipulate the style database.

@geindex configure() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style configure}@anchor{408e}
@deffn {Método} configure (style, query_opt=None, **kw)

Query or set the default value of the specified option(s) in `style'.

Each key in `kw' is an option and each value is a string identifying
the value for that option.

For example, to change every default button to be a flat button with
some padding and a different background color:

@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 tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style map}@anchor{1a73}
@deffn {Método} map (style, query_opt=None, **kw)

Query or sets dynamic values of the specified option(s) in `style'.

Each key in `kw' is an option and each value should be a list or a
tuple (usually) containing statespecs grouped in tuples, lists, or
some other preference. A statespec is a compound of one
or more states and then a value.

An example may make it more understandable:

@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

Note that the order of the (states, value) sequences for an option does
matter, if the order is changed to @code{[('active', 'blue'), ('pressed',
'red')]} in the foreground option, for example, the result would be a
blue foreground when the widget were in active or pressed states.
@end deffn

@geindex lookup() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style lookup}@anchor{408f}
@deffn {Método} lookup (style, option, state=None, default=None)

Returns the value specified for `option' in `style'.

If `state' is specified, it is expected to be a sequence of one or more
states. If the `default' argument is set, it is used as a fallback value
in case no specification for option is found.

To check what font a Button uses by default:

@example
from tkinter import ttk

print(ttk.Style().lookup("TButton", "font"))
@end example
@end deffn

@geindex layout() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style layout}@anchor{4090}
@deffn {Método} layout (style, layoutspec=None)

Define the widget layout for given `style'. If `layoutspec' is omitted,
return the layout specification for given style.

`layoutspec', if specified, is expected to be a list or some other
sequence type (excluding strings), where each item should be a tuple and
the first item is the layout name and the second item should have the
format described in @ref{4091,,Layouts}.

To understand the format, see the following example (it is not
intended to do anything useful):

@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 tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_create}@anchor{258}
@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.

If “image” is used, `args' should contain the default image name followed
by statespec/value pairs (this is the imagespec), and `kw' may have the
following options:


@table @asis

@item border=padding

padding is a list of up to four integers, specifying the left, top,
right, and bottom borders, respectively.

@item height=height

Specifies a minimum height for the element. If less than zero, the
base image’s height is used as a default.

@item padding=padding

Specifies the element’s interior padding. Defaults to border’s value
if not specified.

@item sticky=spec

Specifies how the image is placed within the final parcel. spec
contains zero or more characters “n”, “s”, “w”, or “e”.

@item width=width

Specifies a minimum width for the element. If less than zero, the
base image’s width is used as a default.
@end table

Exemplo:

@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

If “from” is used as the value of `etype',
@ref{258,,element_create()} will clone an existing
element. `args' is expected to contain a themename, from which
the element will be cloned, and optionally an element to clone from.
If this element to clone from is not specified, an empty element will
be used. `kw' is discarded.

Exemplo:

@example
style = ttk.Style(root)
style.element_create('plain.background', 'from', 'default')
@end example

If “vsapi” is used as the value of `etype', @ref{258,,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

Exemplo:

@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


Alterado na versão 3.13: Added support of the “vsapi” element factory.

@end deffn

@geindex element_names() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_names}@anchor{4092}
@deffn {Método} element_names ()

Returns the list of elements defined in the current theme.
@end deffn

@geindex element_options() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style element_options}@anchor{4093}
@deffn {Método} element_options (elementname)

Returns the list of `elementname'’s options.
@end deffn

@geindex theme_create() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_create}@anchor{4094}
@deffn {Método} theme_create (themename, parent=None, settings=None)

Create a new theme.

It is an error if `themename' already exists. If `parent' is specified,
the new theme will inherit styles, elements and layouts from the parent
theme. If `settings' are present they are expected to have the same
syntax used for @ref{4095,,theme_settings()}.
@end deffn

@geindex theme_settings() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_settings}@anchor{4095}
@deffn {Método} theme_settings (themename, settings)

Temporarily sets the current theme to `themename', apply specified
`settings' and then restore the previous theme.

Each key in `settings' is a style and each value may contain the keys
‘configure’, ‘map’, ‘layout’ and ‘element create’ and they are expected
to have the same format as specified by the methods
@ref{408e,,Style.configure()}, @ref{1a73,,Style.map()}, @ref{4090,,Style.layout()} and
@ref{258,,Style.element_create()} respectively.

As an example, let’s change the Combobox for the default theme a bit:

@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 tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_names}@anchor{4096}
@deffn {Método} theme_names ()

Returns a list of all known themes.
@end deffn

@geindex theme_use() (método tkinter.ttk.Style)
@anchor{library/tkinter ttk tkinter ttk Style theme_use}@anchor{4097}
@deffn {Método} theme_use (themename=None)

If `themename' is not given, returns the theme in use.  Otherwise, sets
the current theme to `themename', refreshes all widgets and emits a
<<ThemeChanged>> event.
@end deffn
@end deffn

@menu
* Layouts:: 

@end menu

@node Layouts,,,Ttk Styling
@anchor{library/tkinter ttk layouts}@anchor{4091}
@subsubsection Layouts


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.

The valid options/values are:


@table @asis

@item `side': whichside

Specifies which side of the cavity to place the element; one of
top, right, bottom or left. If omitted, the element occupies the
entire cavity.

@item `sticky': nswe

Specifies where the element is placed inside its allocated parcel.

@item `unit': 0 ou 1

If set to 1, causes the element and all of its descendants to be treated as
a single element for the purposes of @ref{403c,,Widget.identify()} et al. It’s
used for things like scrollbar thumbs with grips.

@item `children': [sublayout… ]

Specifies a list of elements to place inside the element. Each
element is a tuple (or other sequence type) where the first item is
the layout name, and the other is a @ref{4091,,Layout}.
@end table
@anchor{library/tkinter ttk layout}@anchor{4098}
@node IDLE — editor e console Python<2>,turtle — Gráficos tartaruga,tkinter ttk — Widgets temáticos do Tk,Interfaces gráficas de usuário com Tk
@anchor{library/idle doc}@anchor{4099}@anchor{library/idle idle}@anchor{104b}@anchor{library/idle idle-python-editor-and-shell}@anchor{409a}@anchor{library/idle translation-repo}@anchor{409b}
@subsection IDLE — editor e console Python


`Código-fonte:' Lib/idlelib/@footnote{https://github.com/python/cpython/tree/3.13/Lib/idlelib/}

@geindex IDLE
@geindex Python Editor
@geindex Integrated Development Environment

@c Remember to update Lib/idlelib/help.html with idlelib.help.copy_strip() when modifying this file.


__________________________________________________________________


IDLE é o Ambiente Integrado de Desenvolvimento e Aprendizagem (em inglês, Integrated Development and Learning Environment) do Python.

O IDLE tem os seguintes recursos:


@itemize *

@item 
multiplataforma: funciona basicamente da mesma forma no Windows, Unix e macOS

@item 
janela de console do Python (interpretador interativo) com colorização de entrada de código, saída e mensagens de erro

@item 
editor de texto multijanela com múltiplos desfazer, colorização Python, indentação inteligente, dicas de chamada, preenchimento automático e outros recursos

@item 
pesquisa em qualquer janela, substituição nas janelas do editor e pesquisa em vários arquivos (grep)

@item 
depurador com pontos de interrupção persistentes, etapas e visualização de espaço de nomes global e local

@item 
configuração, navegadores e outros diálogos
@end itemize

A aplicação IDLE está implementada no pacote @ref{73,,idlelib}.

This is an optional module. If it is missing from your copy of CPython, look for documentation from your distributor (that is, whoever provided Python to you).
If you are the distributor, see Requirements for optional modules.

@menu
* Menus:: 
* Editing and Navigation:: 
* Startup and Code Execution:: 
* Help and Preferences:: 
* idlelib — implementation of IDLE application:: 

@end menu

@node Menus,Editing and Navigation,,IDLE — editor e console Python<2>
@anchor{library/idle menus}@anchor{409c}
@subsubsection Menus


O IDLE possui dois tipos principais de janelas: a janela do console e a janela do editor. É possível ter várias janelas do editor abertas simultaneamente. No Windows e no Linux, cada uma tem seu próprio menu superior. Cada menu documentado abaixo indica a qual tipo de janela está associado.

Janelas de saída, como as usadas para Edit => Find in Files, são um subtipo de janela de editor. Atualmente, têm o mesmo menu superior, mas um título predefinido e menu de contexto diferentes.

No macOS, há um menu de aplicações. Ele muda dinamicamente conforme a janela selecionada no momento. Ele possui um menu de IDLE e algumas entradas descritas abaixo foram movidas para atender às diretrizes da Apple.

@menu
* Menu File (Console e editor): Menu File Console e editor. 
* Menu Edit (Shell e Editor): Menu Edit Shell e Editor. 
* Menu Format (Somente na janela do Editor): Menu Format Somente na janela do Editor. 
* Run menu (Editor window only): Run menu Editor window only. 
* Shell menu (Shell window only): Shell menu Shell window only. 
* Debug menu (Shell window only): Debug menu Shell window only. 
* Options menu (Shell and Editor): Options menu Shell and Editor. 
* Window menu (Shell and Editor): Window menu Shell and Editor. 
* Help menu (Shell and Editor): Help menu Shell and Editor. 
* Context menus:: 

@end menu

@node Menu File Console e editor,Menu Edit Shell e Editor,,Menus
@anchor{library/idle file-menu-shell-and-editor}@anchor{409d}
@subsubsection Menu File (Console e editor)



@table @asis

@item New File

Cria uma nova janela de edição de arquivo.

@item Open…

Abre um arquivo existente com uma caixa de diálogo Open.

@item Open Module…

Abre um módulo existente (procura em sys.path).

@item Recent Files

Abre uma lista de arquivos recentes. Clique em um para abri-lo.
@end table

@geindex Module browser
@geindex Path browser


@table @asis

@item Module Browser

Mostra as funções, classes e métodos do arquivo atual do editor em uma estrutura de árvore. No console, abre primeiro um módulo.

@item Path Browser

Mostra os diretórios do sys.path, módulos, funções, classes e métodos em uma estrutura de árvore.

@item Save

Salva o conteúdo da janela atual no arquivo associado, se houver um. Janelas que foram alteradas desde que foram abertas ou salvas pela última vez têm um * antes e depois do título da janela. Se não houver um arquivo associado, executa Save As.

@item Save As…

Salva a janela atual com uma caixa de diálogo Save As. O arquivo salvo torna-se o novo arquivo associado à janela. (Se o seu explorador de arquivos estiver configurado para ocultar extensões, a extensão atual será omitida na caixa de nome do arquivo. Se o novo nome do arquivo não tiver ‘.’, ‘.py’ e ‘.txt’ serão adicionados a arquivos Python e de texto, exceto no macOS Aqua, onde ‘.py’ é adicionado a todos os arquivos.)

@item Save Copy As…

Salva a janela atual em um arquivo diferente sem alterar o arquivo associado.  (veja Save As acima sobre a extensão do nome do arquivo.)

@item Print Window

Imprime a janela atual para a impressora padrão.

@item Close Window

Fecha a janela atual (se for um editor não salvo, pergunta se quer salvar; se for um console não salvo, pergunta se quer sair da execução). Chamar @code{exit()} ou @code{close()} na janela do console também fecha o console. Se esta for a única janela, também sai do IDLE.

@item Exit IDLE

Fecha todas as janelas e sai do IDLE (pergunta se quer salvar as janelas de edição não salvas).
@end table

@node Menu Edit Shell e Editor,Menu Format Somente na janela do Editor,Menu File Console e editor,Menus
@anchor{library/idle edit-menu-shell-and-editor}@anchor{409e}
@subsubsection Menu Edit (Shell e Editor)



@table @asis

@item Undo

Desfaz a última alteração na janela atual. Um máximo de 1000 alterações pode ser desfeito.

@item Redo

Refaz a última alteração desfeita na janela atual.

@item Select All

Seleciona todo o conteúdo da janela atual.

@item Cut

Copia a seleção para a área de transferência do sistema; depois apaga a seleção.

@item Copy

Copia a seleção para a área de transferência do sistema.

@item Paste

Insere o conteúdo da área de transferência do sistema na janela atual.
@end table

As funções da área de transferência também estão disponíveis nos menus de contexto.


@table @asis

@item Find…

Abre uma caixa de diálogo de pesquisa com muitas opções

@item Find Again

Repete a última pesquisa, se houver uma.

@item Find Selection

Procura a string atualmente selecionada, se houver uma.

@item Find in Files…

Abre uma caixa de diálogo de pesquisa de ficheiros. Coloca os resultados numa nova janela de saída.

@item Replace…

Abre uma caixa de diálogo de pesquisa e substituição.

@item Go to Line

Move o cursor para o início da linha solicitada e torna essa linha visível. Um pedido após o final do ficheiro vai para o final. Limpa qualquer seleção e atualiza o estado da linha e da coluna.

@item Show Completions

Open a scrollable list allowing selection of existing names. See
@ref{409f,,Completions} in the Editing and Navigation section below.

@item Expand Word

Expande um prefixo que você digitou para corresponder a uma palavra completa na mesma janela; repita o processo para obter uma expansão diferente.

@item Show Call Tip

After an unclosed parenthesis for a function, open a small window with
function parameter hints.  See @ref{40a0,,Calltips} in the
Editing and Navigation section below.

@item Show Surrounding Parens

Realça os parênteses envolventes.
@end table

@node Menu Format Somente na janela do Editor,Run menu Editor window only,Menu Edit Shell e Editor,Menus
@anchor{library/idle format-menu}@anchor{40a1}@anchor{library/idle format-menu-editor-window-only}@anchor{40a2}
@subsubsection Menu Format (Somente na janela do Editor)



@table @asis

@item Format Paragraph

Rewrap the text block containing the text insert cursor.
Avoid code lines.  See @ref{40a3,,Format block} in the
Editing and Navigation section below.

@item Indent Region

Desloca as linhas selecionadas à direita pela largura de indentação (4 espaços por padrão).

@item Dedent Region

Desloca as linhas selecionadas à esquerda pela largura de indentação (4 espaços por padrão).

@item Comment Out Region

Insere ## à frente das linhas selecionadas.

@item Uncomment Region

Remove # ou ## iniciais das linhas selecionadas.

@item Tabify Region

Converte sequências iniciais de espaços em tabs. (Nota: recomendamos usar blocos de 4 espaços para indentar código Python.)

@item Untabify Region

Converte `todos' os tabs para o número correto de espaços.

@item Toggle Tabs

Abre uma caixa de diálogo para alternar entre espaços e tabs para indentar.

@item New Indent Width

Abre uma caixa de diálogo para alterar a largura de indentação. A largura predefinida aceita pela comunidade Python é de 4 espaços.

@item Strip Trailing Whitespace

Remove espaços e outros caracteres de espaço em branco após o último caractere não branco de uma linha aplicando @ref{14f9,,str.rstrip()} a cada linha, incluindo linhas dentro de strings multilinhas. Exceto para as janelas Shell, remove as novas linhas extras no final do arquivo.
@end table

@geindex Run script

@node Run menu Editor window only,Shell menu Shell window only,Menu Format Somente na janela do Editor,Menus
@anchor{library/idle run-menu-editor-window-only}@anchor{40a4}
@subsubsection Run menu (Editor window only)

@anchor{library/idle run-module}@anchor{40a5}

@table @asis

@item Run Module

Do @ref{40a6,,Check Module}.  If no error, restart the shell to clean the
environment, then execute the module.  Output is displayed in the Shell
window.  Note that output requires use of @code{print} or @code{write}.
When execution is complete, the Shell retains focus and displays a prompt.
At this point, one may interactively explore the result of execution.
This is similar to executing a file with @code{python -i file} at a command
line.
@end table
@anchor{library/idle run-custom}@anchor{40a7}

@table @asis

@item Run… Customized

Same as @ref{40a5,,Run Module}, but run the module with customized
settings.  `Command Line Arguments' extend @ref{12a6,,sys.argv} as if passed
on a command line. The module can be run in the Shell without restarting.
@end table
@anchor{library/idle check-module}@anchor{40a6}

@table @asis

@item Check Module

Check the syntax of the module currently open in the Editor window. If the
module has not been saved IDLE will either prompt the user to save or
autosave, as selected in the General tab of the Idle Settings dialog.  If
there is a syntax error, the approximate location is indicated in the
Editor window.
@end table
@anchor{library/idle python-shell}@anchor{40a8}

@table @asis

@item Python Shell

Open or wake up the Python Shell window.
@end table

@node Shell menu Shell window only,Debug menu Shell window only,Run menu Editor window only,Menus
@anchor{library/idle shell-menu-shell-window-only}@anchor{40a9}
@subsubsection Shell menu (Shell window only)



@table @asis

@item View Last Restart

Scroll the shell window to the last Shell restart.

@item Restart Shell

Restart the shell to clean the environment and reset display and exception handling.

@item Previous History

Cycle through earlier commands in history which match the current entry.

@item Next History

Cycle through later commands in history which match the current entry.

@item Interrupt Execution

Stop a running program.
@end table

@node Debug menu Shell window only,Options menu Shell and Editor,Shell menu Shell window only,Menus
@anchor{library/idle debug-menu-shell-window-only}@anchor{40aa}
@subsubsection Debug menu (Shell window only)



@table @asis

@item Go to File/Line

Look on the current line. with the cursor, and the line above for a filename
and line number.  If found, open the file if not already open, and show the
line.  Use this to view source lines referenced in an exception traceback
and lines found by Find in Files. Also available in the context menu of
the Shell window and Output windows.
@end table

@geindex depurador
@geindex stack viewer


@table @asis

@item Debugger (toggle)

When activated, code entered in the Shell or run from an Editor will run
under the debugger.  In the Editor, breakpoints can be set with the context
menu.  This feature is still incomplete and somewhat experimental.

@item Stack Viewer

Show the stack traceback of the last exception in a tree widget, with
access to locals and globals.

@item Auto-open Stack Viewer

Toggle automatically opening the stack viewer on an unhandled exception.
@end table

@node Options menu Shell and Editor,Window menu Shell and Editor,Debug menu Shell window only,Menus
@anchor{library/idle options-menu-shell-and-editor}@anchor{40ab}
@subsubsection Options menu (Shell and Editor)



@table @asis

@item Configure IDLE

Open a configuration dialog and change preferences for the following:
fonts, indentation, keybindings, text color themes, startup windows and
size, additional help sources, and extensions.  On macOS, open the
configuration dialog by selecting Preferences in the application
menu. For more details, see
@ref{40ac,,Setting preferences} under Help and preferences.
@end table

Most configuration options apply to all windows or all future windows.
The option items below only apply to the active window.


@table @asis

@item Show/Hide Code Context (Editor Window only)

Open a pane at the top of the edit window which shows the block context
of the code which has scrolled above the top of the window.  See
@ref{40ad,,Code Context} in the Editing and Navigation section
below.

@item Show/Hide Line Numbers (Editor Window only)

Open a column to the left of the edit window which shows the number
of each line of text.  The default is off, which may be changed in the
preferences (see @ref{40ac,,Setting preferences}).

@item Zoom/Restore Height

Toggles the window between normal size and maximum height. The initial size
defaults to 40 lines by 80 chars unless changed on the General tab of the
Configure IDLE dialog.  The maximum height for a screen is determined by
momentarily maximizing a window the first time one is zoomed on the screen.
Changing screen settings may invalidate the saved height.  This toggle has
no effect when a window is maximized.
@end table

@node Window menu Shell and Editor,Help menu Shell and Editor,Options menu Shell and Editor,Menus
@anchor{library/idle window-menu-shell-and-editor}@anchor{40ae}
@subsubsection Window menu (Shell and Editor)


Lists the names of all open windows; select one to bring it to the foreground
(deiconifying it if necessary).

@node Help menu Shell and Editor,Context menus,Window menu Shell and Editor,Menus
@anchor{library/idle help-menu-shell-and-editor}@anchor{40af}
@subsubsection Help menu (Shell and Editor)



@table @asis

@item About IDLE

Display version, copyright, license, credits, and more.

@item IDLE Help

Display this IDLE document, detailing the menu options, basic editing and
navigation, and other tips.

@item Python Docs

Access local Python documentation, if installed, or start a web browser
and open docs.python.org showing the latest Python documentation.

@item Turtle Demo

Run the turtledemo module with example Python code and turtle drawings.
@end table

Additional help sources may be added here with the Configure IDLE dialog under
the General tab. See the @ref{40b0,,Help sources} subsection below
for more on Help menu choices.

@geindex Cut
@geindex Copy
@geindex Paste
@geindex Set Breakpoint
@geindex Clear Breakpoint
@geindex breakpoints

@node Context menus,,Help menu Shell and Editor,Menus
@anchor{library/idle context-menus}@anchor{40b1}
@subsubsection Context menus


Open a context menu by right-clicking in a window (Control-click on macOS).
Context menus have the standard clipboard functions also on the Edit menu.


@table @asis

@item Cut

Copia a seleção para a área de transferência do sistema; depois apaga a seleção.

@item Copy

Copia a seleção para a área de transferência do sistema.

@item Paste

Insere o conteúdo da área de transferência do sistema na janela atual.
@end table

Editor windows also have breakpoint functions.  Lines with a breakpoint set are
specially marked.  Breakpoints only have an effect when running under the
debugger.  Breakpoints for a file are saved in the user’s @code{.idlerc}
directory.


@table @asis

@item Set Breakpoint

Set a breakpoint on the current line.

@item Clear Breakpoint

Clear the breakpoint on that line.
@end table

Shell and Output windows also have the following.


@table @asis

@item Go to file/line

Same as in Debug menu.
@end table

The Shell window also has an output squeezing facility explained in the `Python
Shell window' subsection below.


@table @asis

@item Squeeze

If the cursor is over an output line, squeeze all the output between
the code above and the prompt below down to a ‘Squeezed text’ label.
@end table

@node Editing and Navigation,Startup and Code Execution,Menus,IDLE — editor e console Python<2>
@anchor{library/idle editing-and-navigation}@anchor{40b2}@anchor{library/idle id1}@anchor{40b3}
@subsubsection Editing and Navigation


@menu
* Editor windows:: 
* Teclas de atalho:: 
* Indentação automática:: 
* Busca e Substituição:: 
* Completions:: 
* Dicas de chamada:: 
* Format block:: 
* Code Context:: 
* Shell window:: 
* Text colors:: 

@end menu

@node Editor windows,Teclas de atalho,,Editing and Navigation
@anchor{library/idle editor-windows}@anchor{40b4}
@subsubsection Editor windows


IDLE may open editor windows when it starts, depending on settings
and how you start IDLE.  Thereafter, use the File menu.  There can be only
one open editor window for a given file.

The title bar contains the name of the file, the full path, and the version
of Python and IDLE running the window.  The status bar contains the line
number (‘Ln’) and column number (‘Col’).  Line numbers start with 1;
column numbers with 0.

IDLE assumes that files with a known .py* extension contain Python code
and that other files do not.  Run Python code with the Run menu.

@node Teclas de atalho,Indentação automática,Editor windows,Editing and Navigation
@anchor{library/idle key-bindings}@anchor{40b5}
@subsubsection Teclas de atalho


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}-@code{LeftArrow} and @code{C}-@code{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}-@code{Home} and @code{C}-@code{End} go to beginning or end of the file.

@item 
@code{Backspace} and @code{Del} (or @code{C}-@code{d}) delete the previous
or next character.

@item 
@code{C}-@code{Backspace} and @code{C}-@code{Del} delete one word left or right.

@item 
@code{C}-@code{k} deletes (‘kills’) everything to the right.
@end itemize

Standard keybindings (like @code{C}-@code{c} to copy and @code{C}-@code{v} to paste)
may work.  Keybindings are selected in the Configure IDLE dialog.

@node Indentação automática,Busca e Substituição,Teclas de atalho,Editing and Navigation
@anchor{library/idle automatic-indentation}@anchor{40b6}
@subsubsection Indentação automática


Depois de uma instrução de abertura de bloco, a linha seguinte é indentada por 4 espaços (na janela do console Python por um tab). Depois de certas palavras-chave (break, return, etc.) a linha seguinte é desindentada. Na indentação inicial, @code{Backspace} apaga até 4 espaços se eles estiverem lá. @code{Tab} insere espaços (na janela do console Python um tab), o número depende da largura de indentação. Atualmente, os tabs estão limitados a quatro espaços devido a limitações do Tcl/Tk.

Veja também os comandos de indentar/desindentar região no @ref{40a1,,menu Format}.

@node Busca e Substituição,Completions,Indentação automática,Editing and Navigation
@anchor{library/idle search-and-replace}@anchor{40b7}
@subsubsection Busca e Substituição


Any selection becomes a search target.  However, only selections within
a line work because searches are only performed within lines with the
terminal newline removed.  If @code{[x] Regular expression} is checked, the
target is interpreted according to the Python re module.

@node Completions,Dicas de chamada,Busca e Substituição,Editing and Navigation
@anchor{library/idle completions}@anchor{409f}@anchor{library/idle id2}@anchor{40b8}
@subsubsection Completions


Completions are supplied, when requested and available, for module
names, attributes of classes or functions, or filenames.  Each request
method displays a completion box with existing names.  (See tab
completions below for an exception.) For any box, change the name
being completed and the item highlighted in the box by
typing and deleting characters; by hitting @code{Up}, @code{Down},
@code{PageUp}, @code{PageDown}, @code{Home}, and @code{End} keys;
and by a single click within the box.  Close the box with @code{Escape},
@code{Enter}, and double @code{Tab} keys or clicks outside the box.
A double click within the box selects and closes.

One way to open a box is to type a key character and wait for a
predefined interval.  This defaults to 2 seconds; customize it
in the settings dialog.  (To prevent auto popups, set the delay to a
large number of milliseconds, such as 100000000.) For imported module
names or class or function attributes, type ‘.’.
For filenames in the root directory, type @ref{66a,,os.sep} or
@ref{66b,,os.altsep} immediately after an opening quote.  (On Windows,
one can specify a drive first.)  Move into subdirectories by typing a
directory name and a separator.

Instead of waiting, or after a box is closed, open a completion box
immediately with Show Completions on the Edit menu.  The default hot
key is @code{C}-@code{space}.  If one types a prefix for the desired name
before opening the box, the first match or near miss is made visible.
The result is the same as if one enters a prefix
after the box is displayed.  Show Completions after a quote completes
filenames in the current directory instead of a root directory.

Hitting @code{Tab} after a prefix usually has the same effect as Show
Completions.  (With no prefix, it indents.)  However, if there is only
one match to the prefix, that match is immediately added to the editor
text without opening a box.

Invoking ‘Show Completions’, or hitting @code{Tab} after a prefix,
outside of a string and without a preceding ‘.’ opens a box with
keywords, builtin names, and available module-level names.

When editing code in an editor (as oppose to Shell), increase the
available module-level names by running your code
and not restarting the Shell thereafter.  This is especially useful
after adding imports at the top of a file.  This also increases
possible attribute completions.

Completion boxes initially exclude names beginning with ‘_’ or, for
modules, not included in ‘__all__’.  The hidden names can be accessed
by typing ‘_’ after ‘.’, either before or after the box is opened.

@node Dicas de chamada,Format block,Completions,Editing and Navigation
@anchor{library/idle calltips}@anchor{40a0}@anchor{library/idle id3}@anchor{40b9}
@subsubsection Dicas de chamada


A calltip is shown automatically when one types @code{(} after the name
of an `accessible' function.  A function name expression may include
dots and subscripts.  A calltip remains until it is clicked, the cursor
is moved out of the argument area, or @code{)} is typed.  Whenever the
cursor is in the argument part of a definition, select Edit and “Show
Call Tip” on the menu or enter its shortcut to display a calltip.

The calltip consists of the function’s signature and docstring up to
the latter’s first blank line or the fifth non-blank line.  (Some builtin
functions lack an accessible signature.)  A ‘/’ or ‘*’ in the signature
indicates that the preceding or following arguments are passed by
position or name (keyword) only.  Details are subject to change.

In Shell, the accessible functions depends on what modules have been
imported into the user process, including those imported by Idle itself,
and which definitions have been run, all since the last restart.

For example, restart the Shell and enter @code{itertools.count(}.  A calltip
appears because Idle imports itertools into the user process for its own
use.  (This could change.)  Enter @code{turtle.write(} and nothing appears.
Idle does not itself import turtle.  The menu entry and shortcut also do
nothing.  Enter @code{import turtle}.  Thereafter, @code{turtle.write(}
will display a calltip.

In an editor, import statements have no effect until one runs the file.
One might want to run a file after writing import statements, after
adding function definitions, or after opening an existing file.

@node Format block,Code Context,Dicas de chamada,Editing and Navigation
@anchor{library/idle format-block}@anchor{40a3}@anchor{library/idle id4}@anchor{40ba}
@subsubsection Format block


Reformat Paragraph rewraps a block (‘paragraph’) of contiguous equally
indented non-blank comments, a similar block of text within a multiline
string, or a selected subset of either.
If needed, add a blank line to separate string from code.
Partial lines in a selection expand to complete lines.
The resulting lines have the same indent as before
but have maximum total length of N columns (characters).
Change the default N of 72 on the Window tab of IDLE Settings.

@node Code Context,Shell window,Format block,Editing and Navigation
@anchor{library/idle code-context}@anchor{40ad}@anchor{library/idle id5}@anchor{40bb}
@subsubsection Code Context


Within an editor window containing Python code, code context can be toggled
in order to show or hide a pane at the top of the window.  When shown, this
pane freezes the opening lines for block code, such as those beginning with
@code{class}, @code{def}, or @code{if} keywords, that would have otherwise scrolled
out of view.  The size of the pane will be expanded and contracted as needed
to show the all current levels of context, up to the maximum number of
lines defined in the Configure IDLE dialog (which defaults to 15).  If there
are no current context lines and the feature is toggled on, a single blank
line will display.  Clicking on a line in the context pane will move that
line to the top of the editor.

The text and background colors for the context pane can be configured under
the Highlights tab in the Configure IDLE dialog.

@node Shell window,Text colors,Code Context,Editing and Navigation
@anchor{library/idle shell-window}@anchor{40bc}
@subsubsection Shell window


In IDLE’s Shell, enter, edit, and recall complete statements. (Most
consoles and terminals only work with a single physical line at a time).

Submit a single-line statement for execution by hitting @code{Return}
with the cursor anywhere on the line.  If a line is extended with
Backslash (@code{\}), the cursor must be on the last physical line.
Submit a multi-line compound statement by entering a blank line after
the statement.

When one pastes code into Shell, it is not compiled and possibly executed
until one hits @code{Return}, as specified above.
One may edit pasted code first.
If one pastes more than one statement into Shell, the result will be a
@ref{18d,,SyntaxError} when multiple statements are compiled as if they were one.

Lines containing @code{RESTART} mean that the user execution process has been
re-started.  This occurs when the user execution process has crashed,
when one requests a restart on the Shell menu, or when one runs code
in an editor window.

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}-@code{c} attempts to interrupt statement execution (but may fail).

@item 
@code{C}-@code{d} closes Shell if typed at a @code{>>>} prompt.

@item 
@code{Alt}-@code{p} and @code{Alt}-@code{n} (@code{C}-@code{p} and @code{C}-@code{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 Text colors,,Shell window,Editing and Navigation
@anchor{library/idle text-colors}@anchor{40bd}
@subsubsection Text colors


Idle defaults to black on white text, but colors text with special meanings.
For the shell, these are shell output, shell error, user output, and
user error.  For Python code, at the shell prompt or in an editor, these are
keywords, builtin class and function names, names following @code{class} and
@code{def}, strings, and comments. For any text window, these are the cursor (when
present), found text (when possible), and selected text.

IDLE also highlights the @ref{80f,,soft keywords} @ref{810,,match},
@ref{810,,case}, and @ref{811,,_} in
pattern-matching statements. However, this highlighting is not perfect and
will be incorrect in some rare cases, including some @code{_}-s in @code{case}
patterns.

Text coloring is done in the background, so uncolorized text is occasionally
visible.  To change the color scheme, use the Configure IDLE dialog
Highlighting tab.  The marking of debugger breakpoint lines in the editor and
text in popups and dialogs is not user-configurable.

@node Startup and Code Execution,Help and Preferences,Editing and Navigation,IDLE — editor e console Python<2>
@anchor{library/idle startup-and-code-execution}@anchor{40be}
@subsubsection Startup and Code Execution


Upon startup with the @code{-s} option, IDLE will execute the file referenced by
the environment variables 
@geindex IDLESTARTUP
@geindex variável de ambiente; IDLESTARTUP
@code{IDLESTARTUP} or 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP}.
IDLE first checks for @code{IDLESTARTUP}; if @code{IDLESTARTUP} is present the file
referenced is run.  If @code{IDLESTARTUP} is not present, IDLE checks for
@code{PYTHONSTARTUP}.  Files referenced by these environment variables are
convenient places to store functions that are used frequently from the IDLE
shell, or for executing import statements to import common modules.

In addition, @code{Tk} also loads a startup file if it is present.  Note that the
Tk file is loaded unconditionally.  This additional file is @code{.Idle.py} and is
looked for in the user’s home directory.  Statements in this file will be
executed in the Tk namespace, so this file is not useful for importing
functions to be used from IDLE’s Python shell.

@menu
* Uso na linha de comando: Uso na linha de comando<5>. 
* Startup failure:: 
* Running user code:: 
* User output in Shell:: 
* Developing tkinter applications:: 
* Running without a subprocess:: 

@end menu

@node Uso na linha de comando<5>,Startup failure,,Startup and Code Execution
@anchor{library/idle command-line-usage}@anchor{40bf}@anchor{library/idle idlelib-cli}@anchor{40c0}
@subsubsection Uso na linha de comando


IDLE can be invoked from the command line with various options. The general syntax is:

@example
python -m idlelib [options] [file ...]
@end example

The following options are available:

@geindex idle opção de linha de comando; -c
@anchor{library/idle cmdoption-idle-c}@anchor{40c1}
@deffn {Option} @w{-}c <command>

Run the specified Python command in the shell window.
For example, pass @code{-c "print('Hello, World!')"}.
On Windows, the outer quotes must be double quotes as shown.
@end deffn

@geindex idle opção de linha de comando; -d
@anchor{library/idle cmdoption-idle-d}@anchor{40c2}
@deffn {Option} @w{-}d

Enable the debugger and open the shell window.
@end deffn

@geindex idle opção de linha de comando; -e
@anchor{library/idle cmdoption-idle-e}@anchor{40c3}
@deffn {Option} @w{-}e

Open an editor window.
@end deffn

@geindex idle opção de linha de comando; -h
@anchor{library/idle cmdoption-idle-h}@anchor{40c4}
@deffn {Option} @w{-}h

Print a help message with legal combinations of options and exit.
@end deffn

@geindex idle opção de linha de comando; -i
@anchor{library/idle cmdoption-idle-i}@anchor{40c5}
@deffn {Option} @w{-}i

Open a shell window.
@end deffn

@geindex idle opção de linha de comando; -r
@anchor{library/idle cmdoption-idle-r}@anchor{40c6}
@deffn {Option} @w{-}r <file>

Run the specified file in the shell window.
@end deffn

@geindex idle opção de linha de comando; -s
@anchor{library/idle cmdoption-idle-s}@anchor{40c7}
@deffn {Option} @w{-}s

Run the startup file (as defined by the environment variables 
@geindex IDLESTARTUP
@geindex variável de ambiente; IDLESTARTUP
@code{IDLESTARTUP} or 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP}) before opening the shell window.
@end deffn

@geindex idle opção de linha de comando; -t
@anchor{library/idle cmdoption-idle-t}@anchor{40c8}
@deffn {Option} @w{-}t <title>

Set the title of the shell window.
@end deffn

@geindex idle opção de linha de comando; -
@anchor{library/idle cmdoption-idle-0}@anchor{40c9}
@deffn {Option} @w{-}

Read and execute standard input in the shell window. This option must be the last one before any arguments.
@end deffn

If arguments are provided:


@itemize -

@item 
If @code{-}, @code{-c}, or @code{-r} is used, all arguments are placed in @code{sys.argv[1:]},
and @code{sys.argv[0]} is set to @code{'@w{'}}, @code{'-c'}, or @code{'-r'} respectively.
No editor window is opened, even if that is the default set in the `Options' dialog.

@item 
Otherwise, arguments are treated as files to be opened for editing, and @code{sys.argv} reflects the arguments passed to IDLE itself.
@end itemize

@node Startup failure,Running user code,Uso na linha de comando<5>,Startup and Code Execution
@anchor{library/idle startup-failure}@anchor{40ca}
@subsubsection Startup failure


IDLE uses a socket to communicate between the IDLE GUI process and the user
code execution process.  A connection must be established whenever the Shell
starts or restarts.  (The latter is indicated by a divider line that says
‘RESTART’). If the user process fails to connect to the GUI process, it
usually displays a @code{Tk} error box with a ‘cannot connect’ message
that directs the user here.  It then exits.

One specific connection failure on Unix systems results from
misconfigured masquerading rules somewhere in a system’s network setup.
When IDLE is started from a terminal, one will see a message starting
with @code{** Invalid host:}.
The valid value is @code{127.0.0.1 (idlelib.rpc.LOCALHOST)}.
One can diagnose with @code{tcpconnect -irv 127.0.0.1 6543} in one
terminal window and @code{tcplisten <same args>} in another.

A common cause of failure is a user-written file with the same name as a
standard library module, such as `random.py' and `tkinter.py'. When such a
file is located in the same directory as a file that is about to be run,
IDLE cannot import the stdlib file.  The current fix is to rename the
user file.

Though less common than in the past, an antivirus or firewall program may
stop the connection.  If the program cannot be taught to allow the
connection, then it must be turned off for IDLE to work.  It is safe to
allow this internal connection because no data is visible on external
ports.  A similar problem is a network mis-configuration that blocks
connections.

Python installation issues occasionally stop IDLE: multiple versions can
clash, or a single installation might need admin access.  If one undo the
clash, or cannot or does not want to run as admin, it might be easiest to
completely remove Python and start over.

A zombie pythonw.exe process could be a problem.  On Windows, use Task
Manager to check for one and stop it if there is.  Sometimes a restart
initiated by a program crash or Keyboard Interrupt (control-C) may fail
to connect.  Dismissing the error box or using Restart Shell on the Shell
menu may fix a temporary problem.

When IDLE first starts, it attempts to read user configuration files in
@code{~/.idlerc/} (~ is one’s home directory).  If there is a problem, an error
message should be displayed.  Leaving aside random disk glitches, this can
be prevented by never editing the files by hand.  Instead, use the
configuration dialog, under Options.  Once there is an error in a user
configuration file, the best solution may be to delete it and start over
with the settings dialog.

If IDLE quits with no message, and it was not started from a console, try
starting it from a console or terminal (@code{python -m idlelib}) and see if
this results in an error message.

On Unix-based systems with tcl/tk older than @code{8.6.11} (see
@code{About IDLE}) certain characters of certain fonts can cause
a tk failure with a message to the terminal.  This can happen either
if one starts IDLE to edit a file with such a character or later
when entering such a character.  If one cannot upgrade tcl/tk,
then re-configure IDLE to use a font that works better.

@node Running user code,User output in Shell,Startup failure,Startup and Code Execution
@anchor{library/idle running-user-code}@anchor{40cb}
@subsubsection Running user code


With rare exceptions, the result of executing Python code with IDLE is
intended to be the same as executing the same code by the default method,
directly with Python in a text-mode system console or terminal window.
However, the different interface and operation occasionally affect
visible results.  For instance, @code{sys.modules} starts with more entries,
and @code{threading.active_count()} returns 2 instead of 1.

By default, IDLE runs user code in a separate OS process rather than in
the user interface process that runs the shell and editor.  In the execution
process, it replaces @code{sys.stdin}, @code{sys.stdout}, and @code{sys.stderr}
with objects that get input from and send output to the Shell window.
The original values stored in @code{sys.__stdin__}, @code{sys.__stdout__}, and
@code{sys.__stderr__} are not touched, but may be @code{None}.

Sending print output from one process to a text widget in another is
slower than printing to a system terminal in the same process.
This has the most effect when printing multiple arguments, as the string
for each argument, each separator, the newline are sent separately.
For development, this is usually not a problem, but if one wants to
print faster in IDLE, format and join together everything one wants
displayed together and then print a single string.  Both format strings
and @ref{2340,,str.join()} can help combine fields and lines.

IDLE’s standard stream replacements are not inherited by subprocesses
created in the execution process, whether directly by user code or by
modules such as multiprocessing.  If such subprocess use @code{input} from
sys.stdin or @code{print} or @code{write} to sys.stdout or sys.stderr,
IDLE should be started in a command line window.  (On Windows,
use @code{python} or @code{py} rather than @code{pythonw} or @code{pyw}.)
The secondary subprocess
will then be attached to that window for input and output.

If @code{sys} is reset by user code, such as with @code{importlib.reload(sys)},
IDLE’s changes are lost and input from the keyboard and output to the screen
will not work correctly.

When Shell has the focus, it controls the keyboard and screen.  This is
normally transparent, but functions that directly access the keyboard
and screen will not work.  These include system-specific functions that
determine whether a key has been pressed and if so, which.

The IDLE code running in the execution process adds frames to the call stack
that would not be there otherwise.  IDLE wraps @code{sys.getrecursionlimit} and
@code{sys.setrecursionlimit} to reduce the effect of the additional stack
frames.

When user code raises SystemExit either directly or by calling sys.exit,
IDLE returns to a Shell prompt instead of exiting.

@node User output in Shell,Developing tkinter applications,Running user code,Startup and Code Execution
@anchor{library/idle user-output-in-shell}@anchor{40cc}
@subsubsection User output in Shell


When a program outputs text, the result is determined by the
corresponding output device.  When IDLE executes user code, @code{sys.stdout}
and @code{sys.stderr} are connected to the display area of IDLE’s Shell.  Some of
its features are inherited from the underlying Tk Text widget.  Others
are programmed additions.  Where it matters, Shell is designed for development
rather than production runs.

For instance, Shell never throws away output.  A program that sends unlimited
output to Shell will eventually fill memory, resulting in a memory error.
In contrast, some system text windows only keep the last n lines of output.
A Windows console, for instance, keeps a user-settable 1 to 9999 lines,
with 300 the default.

A Tk Text widget, and hence IDLE’s Shell, displays characters (codepoints) in
the BMP (Basic Multilingual Plane) subset of Unicode.  Which characters are
displayed with a proper glyph and which with a replacement box depends on the
operating system and installed fonts.  Tab characters cause the following text
to begin after the next tab stop. (They occur every 8 ‘characters’).  Newline
characters cause following text to appear on a new line.  Other control
characters are ignored or displayed as a space, box, or something else,
depending on the operating system and font.  (Moving the text cursor through
such output with arrow keys may exhibit some surprising spacing behavior.)

@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

The @code{repr} function is used for interactive echo of expression
values.  It returns an altered version of the input string in which
control codes, some BMP codepoints, and all non-BMP codepoints are
replaced with escape codes. As demonstrated above, it allows one to
identify the characters in a string, regardless of how they are displayed.

Normal and error output are generally kept separate (on separate lines)
from code input and each other.  They each get different highlight colors.

For SyntaxError tracebacks, the normal ‘^’ marking where the error was
detected is replaced by coloring the text with an error highlight.
When code run from a file causes other exceptions, one may right click
on a traceback line to jump to the corresponding line in an IDLE editor.
The file will be opened if necessary.

Shell has a special facility for squeezing output lines down to a
‘Squeezed text’ label.  This is done automatically
for output over N lines (N = 50 by default).
N can be changed in the PyShell section of the General
page of the Settings dialog.  Output with fewer lines can be squeezed by
right clicking on the output.  This can be useful lines long enough to slow
down scrolling.

Squeezed output is expanded in place by double-clicking the label.
It can also be sent to the clipboard or a separate view window by
right-clicking the label.

@node Developing tkinter applications,Running without a subprocess,User output in Shell,Startup and Code Execution
@anchor{library/idle developing-tkinter-applications}@anchor{40cd}
@subsubsection Developing tkinter applications


IDLE is intentionally different from standard Python in order to
facilitate development of tkinter programs.  Enter @code{import tkinter as tk;
root = tk.Tk()} in standard Python and nothing appears.  Enter the same
in IDLE and a tk window appears.  In standard Python, one must also enter
@code{root.update()} to see the window.  IDLE does the equivalent in the
background, about 20 times a second, which is about every 50 milliseconds.
Next enter @code{b = tk.Button(root, text='button'); b.pack()}.  Again,
nothing visibly changes in standard Python until one enters @code{root.update()}.

Most tkinter programs run @code{root.mainloop()}, which usually does not
return until the tk app is destroyed.  If the program is run with
@code{python -i} or from an IDLE editor, a @code{>>>} shell prompt does not
appear until @code{mainloop()} returns, at which time there is nothing left
to interact with.

When running a tkinter program from an IDLE editor, one can comment out
the mainloop call.  One then gets a shell prompt immediately and can
interact with the live application.  One just has to remember to
re-enable the mainloop call when running in standard Python.

@node Running without a subprocess,,Developing tkinter applications,Startup and Code Execution
@anchor{library/idle running-without-a-subprocess}@anchor{40ce}
@subsubsection Running without a subprocess


By default, IDLE executes user code in a separate subprocess via a socket,
which uses the internal loopback interface.  This connection is not
externally visible and no data is sent to or received from the internet.
If firewall software complains anyway, you can ignore it.

If the attempt to make the socket connection fails, Idle will notify you.
Such failures are sometimes transient, but if persistent, the problem
may be either a firewall blocking the connection or misconfiguration of
a particular system.  Until the problem is fixed, one can run Idle with
the -n command line switch.

If IDLE is started with the -n command line switch it will run in a
single process and will not create the subprocess which runs the RPC
Python execution server.  This can be useful if Python cannot create
the subprocess or the RPC socket interface on your platform.  However,
in this mode user code is not isolated from IDLE itself.  Also, the
environment is not restarted when Run/Run Module (F5) is selected.  If
your code has been modified, you must reload() the affected modules and
re-import any specific items (e.g. from foo import baz) if the changes
are to take effect.  For these reasons, it is preferable to run IDLE
with the default subprocess if at all possible.


Descontinuado desde a versão 3.4.


@node Help and Preferences,idlelib — implementation of IDLE application,Startup and Code Execution,IDLE — editor e console Python<2>
@anchor{library/idle help-and-preferences}@anchor{40cf}
@subsubsection Help and Preferences


@menu
* Help sources:: 
* Setting preferences:: 
* IDLE on macOS:: 
* Extensions:: 

@end menu

@node Help sources,Setting preferences,,Help and Preferences
@anchor{library/idle help-sources}@anchor{40b0}@anchor{library/idle id6}@anchor{40d0}
@subsubsection Help sources


Help menu entry “IDLE Help” displays a formatted html version of the
IDLE chapter of the Library Reference.  The result, in a read-only
tkinter text window, is close to what one sees in a web browser.
Navigate through the text with a mousewheel,
the scrollbar, or up and down arrow keys held down.
Or click the TOC (Table of Contents) button and select a section
header in the opened box.

Help menu entry “Python Docs” opens the extensive sources of help,
including tutorials, available at @code{docs.python.org/x.y}, where ‘x.y’
is the currently running Python version.  If your system
has an off-line copy of the docs (this may be an installation option),
that will be opened instead.

Selected URLs can be added or removed from the help menu at any time using the
General tab of the Configure IDLE dialog.

@node Setting preferences,IDLE on macOS,Help sources,Help and Preferences
@anchor{library/idle preferences}@anchor{40ac}@anchor{library/idle setting-preferences}@anchor{40d1}
@subsubsection Setting preferences


The font preferences, highlighting, keys, and general preferences can be
changed via Configure IDLE on the Option menu.
Non-default user settings are saved in a @code{.idlerc} directory in the user’s
home directory.  Problems caused by bad user configuration files are solved
by editing or deleting one or more of the files in @code{.idlerc}.

On the Font tab, see the text sample for the effect of font face and size
on multiple characters in multiple languages.  Edit the sample to add
other characters of personal interest.  Use the sample to select
monospaced fonts.  If particular characters have problems in Shell or an
editor, add them to the top of the sample and try changing first size
and then font.

On the Highlights and Keys tab, select a built-in or custom color theme
and key set.  To use a newer built-in color theme or key set with older
IDLEs, save it as a new custom theme or key set and it well be accessible
to older IDLEs.

@node IDLE on macOS,Extensions,Setting preferences,Help and Preferences
@anchor{library/idle idle-on-macos}@anchor{40d2}
@subsubsection IDLE on macOS


Under System Preferences: Dock, one can set “Prefer tabs when opening
documents” to “Always”.  This setting is not compatible with the tk/tkinter
GUI framework used by IDLE, and it breaks a few IDLE features.

@node Extensions,,IDLE on macOS,Help and Preferences
@anchor{library/idle extensions}@anchor{40d3}
@subsubsection Extensions


IDLE contains an extension facility.  Preferences for extensions can be
changed with the Extensions tab of the preferences dialog. See the
beginning of config-extensions.def in the idlelib directory for further
information.  The only current default extension is zzdummy, an example
also used for testing.

@node idlelib — implementation of IDLE application,,Help and Preferences,IDLE — editor e console Python<2>
@anchor{library/idle idlelib-implementation-of-idle-application}@anchor{40d4}@anchor{library/idle module-idlelib}@anchor{73}
@subsubsection idlelib — implementation of IDLE application


@geindex module; idlelib

`Source code:' Lib/idlelib@footnote{https://github.com/python/cpython/tree/3.13/Lib/idlelib}


__________________________________________________________________


The Lib/idlelib package implements the IDLE application.  See the rest
of this page for how to use IDLE.

The files in idlelib are described in idlelib/README.txt.  Access it
either in idlelib or click Help => About IDLE on the IDLE menu.  This
file also maps IDLE menu items to the code that implements the item.
Except for files listed under ‘Startup’, the idlelib code is ‘private’ in
sense that feature changes can be backported (see 
@geindex Propostas de Melhorias do Python; PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/}).

@node turtle — Gráficos tartaruga,,IDLE — editor e console Python<2>,Interfaces gráficas de usuário com Tk
@anchor{library/turtle doc}@anchor{40d5}@anchor{library/turtle module-turtle}@anchor{101}@anchor{library/turtle translation-repo}@anchor{40d6}@anchor{library/turtle turtle-turtle-graphics}@anchor{40d7}
@subsection @code{turtle} — Gráficos tartaruga


@geindex module; turtle

`Código-fonte:' Lib/turtle.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/turtle.py}

@c from turtle import *
@c turtle = Turtle()


__________________________________________________________________


@menu
* Introdução: Introdução<11>. 
* Começando: Começando<2>. 
* Tutorial: Tutorial<4>. 
* Como fazer…:: 
* Referência Gráficos de Tartaruga:: 
* Métodos de RawTurtle/Turtle e funções correspondentes:: 
* métodos do TurtleScreen/Screen e as funções correspondentes:: 
* Classes Públicas:: 
* Explicação: Explicação<2>. 
* Ajuda e Configuração:: 
* turtledemo — Scripts de Demonstração:: 
* Modificações desde a versão do Python 2.6: Modificações desde a versão do Python 2 6. 
* Modificações desde a versão do Python 3.0: Modificações desde a versão do Python 3 0. 

@end menu

@node Introdução<11>,Começando<2>,,turtle — Gráficos tartaruga
@anchor{library/turtle introduction}@anchor{40d8}
@subsubsection Introdução


Gráficos tartaruga são uma implementação das populares ferramentas de desenho geométrico introduzidas em Logo@footnote{https://pt.wikipedia.org/wiki/Logo}, desenvolvido por Wally Feurzeig, Seymour Papert e Cynthia Solomon em 1967.

@node Começando<2>,Tutorial<4>,Introdução<11>,turtle — Gráficos tartaruga
@anchor{library/turtle get-started}@anchor{40d9}
@subsubsection Começando


Imagine uma tartaruga robótica começando em (0, 0) no plano x-y. Depois de um @code{import turtle}, execute o comando @code{turtle.forward(15)}, e ela moverá (na tela!) 15 pixels na direção em que está virada (para frente), desenhando uma linha à medida que se move. Execute o comando @code{turtle.right(25)}, e ela fará uma rotação, de 25 graus no sentido horário, sem sair do lugar.

@subsubheading Turtle star



A tartaruga pode desenhar formas intrincadas usando programas que repetem movimentos simples.

@image{python-figures/turtle-star,,,,png}

Em Python, os gráficos de tartaruga fornecem uma representação de uma “tartaruga” física (um pequeno robô com uma caneta) que desenha em uma folha de papel no chão.

É uma maneira eficaz e comprovada de os alunos conhecerem os conceitos de programação e a interação com o software, pois oferece resposta instantânea e visível. Também oferece acesso conveniente a resultados gráficos em geral.

Desenho de tartaruga foi originalmente criado como uma ferramenta educacional, para ser usado por professores em sala de aula. Para a pessoa que precisa produzir algum resultado gráfico, essa pode ser uma maneira de fazer isso sem a sobrecarga de introduzir bibliotecas mais complexas ou externas em seu trabalho.

@node Tutorial<4>,Como fazer…,Começando<2>,turtle — Gráficos tartaruga
@anchor{library/turtle turtle-tutorial}@anchor{40da}@anchor{library/turtle tutorial}@anchor{40db}
@subsubsection Tutorial


As pessoas recém-chegadas devem começar por aqui. Neste tutorial, exploraremos alguns dos conceitos básicos do desenho de tartarugas.

@menu
* Iniciando um ambiente da tartaruga:: 
* Desenho básico:: 
* Criação de padrões algorítmicos:: 

@end menu

@node Iniciando um ambiente da tartaruga,Desenho básico,,Tutorial<4>
@anchor{library/turtle starting-a-turtle-environment}@anchor{40dc}
@subsubsection Iniciando um ambiente da tartaruga


Em um console do Python, faça a importação de todos os objetos do módulo @code{turtle}:

@example
from turtle import *
@end example

Se você se deparar com a seguinte mensagem de erro @code{No module named '_tkinter'}, será necessário instalar o @ref{f0,,pacote de interface gráfica Tk} em seu sistema.

@node Desenho básico,Criação de padrões algorítmicos,Iniciando um ambiente da tartaruga,Tutorial<4>
@anchor{library/turtle basic-drawing}@anchor{40dd}
@subsubsection Desenho básico


Envie a tartaruga para frente 100 passos:

@example
forward(100)
@end example

Você deverá ver (provavelmente, em uma nova janela na sua tela) uma linha desenhada pela tartaruga, em direção ao leste (→) . Mude a direção da tartaruga, de modo que ela gire 120 graus para a esquerda (sentido anti-horário):

@example
left(120)
@end example

Vamos continuar desenhando um triângulo:

@example
forward(100)
left(120)
forward(100)
@end example

Observe como a tartaruga, representada por uma seta, aponta em diferentes direções à medida que você a guia.

Faça experiências com esses comandos e também com @code{backward()} e @code{right()}.

@menu
* Controle da Caneta:: 
* A posição da tartaruga:: 

@end menu

@node Controle da Caneta,A posição da tartaruga,,Desenho básico
@anchor{library/turtle pen-control}@anchor{40de}
@subsubsection Controle da Caneta


Tente alterar a cor - por exemplo, @code{color('blue')} - e a largura da linha - por exemplo, @code{width(3)} - e, em seguida, desenhe novamente.

Você também pode mover a tartaruga sem desenhar, levantando a caneta: @code{up()} antes de mover. Para começar a desenhar novamente, use @code{down()}.

@node A posição da tartaruga,,Controle da Caneta,Desenho básico
@anchor{library/turtle the-turtle-s-position}@anchor{40df}
@subsubsection A posição da tartaruga


Envie sua tartaruga de volta ao ponto de partida (útil se ela tiver desaparecido da tela):

@example
home()
@end example

A posição inicial da tartaruga está no centro da tela. Se você precisar conhecê-la, obtenha as coordenadas x-y da tartaruga com:

@example
pos()
@end example

A a posição inicial fica em @code{(0, 0)}.

E, depois de um tempo, provavelmente vai querer ajudar a limpar a janela aberta para que possamos começar de novo:

@example
clearscreen()
@end example

@node Criação de padrões algorítmicos,,Desenho básico,Tutorial<4>
@anchor{library/turtle making-algorithmic-patterns}@anchor{40e0}
@subsubsection Criação de padrões algorítmicos


Usando laços de repetição, é possível construir criar padrões geométricos:

@example
for steps in range(100):
    for c in ('blue', 'red', 'green'):
        color(c)
        forward(steps)
        right(30)
@end example

- que, é claro, são limitados apenas pela imaginação!

Vamos desenhar o formato de estrela na parte superior da página. Queremos linhas de contorno vermelhas, com preenchimento em amarelo:

@example
color('red')
fillcolor('yellow')
@end example

Assim como @code{up()} e @code{down()} determinam se as linhas serão desenhadas, o preenchimento pode ser ativado e desativado:

@example
begin_fill()
@end example

Em seguida, vamos criar um laço de repetição:

@example
while True:
    forward(200)
    left(170)
    if abs(pos()) < 1:
        break
@end example

@code{abs(pos()) < 1} é uma boa maneira de saber quando a tartaruga está de volta à sua posição inicial.

Por fim, complete o preenchimento:

@example
end_fill()
@end example

(Observe que o preenchimento só ocorre de fato quando você fornece o comando @code{end_fill()} .)

@node Como fazer…,Referência Gráficos de Tartaruga,Tutorial<4>,turtle — Gráficos tartaruga
@anchor{library/turtle how-to}@anchor{40e1}@anchor{library/turtle turtle-how-to}@anchor{40e2}
@subsubsection Como fazer…


Esta seção aborda alguns casos de uso e abordagens típicos do módulo “turtle”.

@menu
* Comece o mais rápido possível:: 
* Use o espaço de nomes do módulo turtle:: 
* Use o módulo gráfico de tartaruga dentro de um script com código específico:: 
* Use o módulo gráficos da tartaruga orientado a objetos:: 

@end menu

@node Comece o mais rápido possível,Use o espaço de nomes do módulo turtle,,Como fazer…
@anchor{library/turtle get-started-as-quickly-as-possible}@anchor{40e3}
@subsubsection Comece o mais rápido possível


Uma dos prazeres dos gráficos de tartaruga é o feedback visual imediato disponível a partir de comandos simples. É uma excelente maneira de apresentar ideias de programação às crianças, com um mínimo de sofrimento (não apenas às crianças, é claro).

O módulo tartaruga torna isso possível ao expor toda a sua funcionalidade básica como funções, disponíveis com @code{from turtle import *}. O tutorial gráficos de @ref{40da,,turtle} cobre essa abordagem.

Vale a pena observar que muitos dos comandos da tartaruga também possuem equivalentes ainda mais concisos, como usar @code{fd()} para obter o mesmo resultado de @ref{32f1,,forward()}. Esses comandos são especialmente úteis quando se trabalha com alunos para os quais a digitação não é uma habilidade.
@anchor{library/turtle note}@anchor{40e4}
@quotation

Você precisará ter o pacote de interface @ref{f0,,Tk} instalado em seu sistema para que os gráficos do módulo “turtle” funcionem. Esteja ciente de que isso nem sempre é simples, portanto, verifique isso com antecedência se estiver planejando usar os gráficos de tartaruga com um aluno.
@end quotation

@node Use o espaço de nomes do módulo turtle,Use o módulo gráfico de tartaruga dentro de um script com código específico,Comece o mais rápido possível,Como fazer…
@anchor{library/turtle use-the-turtle-module-namespace}@anchor{40e5}
@subsubsection Use o espaço de nomes do módulo @code{turtle}


Usar @code{from turtle import *} é conveniente, mas lembre-se de que ele importa um coleção bastante grande de objetos e, se você estiver fazendo qualquer coisa no seu código que não esteja relacionada com o módulo gráficos de tartaruga, corre o risco de um conflito de nomes de objetos (isso se torna um problema ainda maior se você estiver usando o módulo de gráficos de tartaruga em um script em que outros módulos possam ser também importados).

A solução é usar o identificador/domínio do próprio módulo @code{import turtle} sem o asterisco no final da importação - assim a chamada do objeto/função @code{fd()} torna-se @code{turtle.fd()}, da mesma forma como @code{width()} torna-se @code{turtle.width()} e assim por diante.  (Se digitar “turtle” várias vezes se tornar tedioso, use @code{import turtle as t}, por exemplo, para fornecer um apelido mais conciso e objetivo ao  identificador/domínio dentro do seu código).

@node Use o módulo gráfico de tartaruga dentro de um script com código específico,Use o módulo gráficos da tartaruga orientado a objetos,Use o espaço de nomes do módulo turtle,Como fazer…
@anchor{library/turtle use-turtle-graphics-in-a-script}@anchor{40e6}
@subsubsection Use o módulo gráfico de tartaruga dentro de um script com código específico


Recomenda-se usar o módulo @code{turtle} com uma apelido para identificador/domínio, conforme descrito acima, por exemplo:

@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

No entanto, outra etapa também é necessária ou o Python também fechará a janela da tartaruga assim que o código acima terminar de ser executado. Adicione:

@example
t.mainloop()
@end example

ao final do código anterior. Assim, o código anterior agora conterá uma instrução que aguardará ser dispensado e não sairá até que seja encerrado, por exemplo, fechando a janela aberta pelo módulo gráficos da tartaruga.

@node Use o módulo gráficos da tartaruga orientado a objetos,,Use o módulo gráfico de tartaruga dentro de um script com código específico,Como fazer…
@anchor{library/turtle use-object-oriented-turtle-graphics}@anchor{40e7}
@subsubsection Use o módulo gráficos da tartaruga orientado a objetos



@subsubheading Ver também


@ref{40e8,,Explicação de interface orientada a objetos}


Exceto para fins introdutórios muito básicos ou para experimentar coisas o mais rápido possível, é mais comum e muito mais eficiente usar a abordagem orientada a objetos para gráficos de tartarugas. Por exemplo, isso permite várias tartarugas na tela ao mesmo tempo.

Nessa abordagem, os vários comandos do módulo turtle são métodos de objetos (principalmente objetos  de @code{Turtle}). Você `pode' usar a abordagem orientada a objetos em console, mas ela seria mais típica em um script Python.

O exemplo acima se torna então:

@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

Observe a última linha. @code{t.screen} é um instância da subclasse @ref{40e9,,Screen} que existe numa instância da classe tartaruga ou “turtle”; ela é criada automaticamente junto com a instância de tartaruga.

A tela da tartaruga pode ser personalizada, por exemplo:

@example
t.screen.title('Object-oriented turtle demo')
t.screen.bgcolor("orange")
@end example

@node Referência Gráficos de Tartaruga,Métodos de RawTurtle/Turtle e funções correspondentes,Como fazer…,turtle — Gráficos tartaruga
@anchor{library/turtle turtle-graphics-reference}@anchor{40ea}
@subsubsection Referência Gráficos de Tartaruga


@cartouche
@quotation Nota 
Na documentação a seguir, a lista de argumentos para funções é fornecida. Os métodos, é claro, têm o primeiro argumento adicional `self' que é omitido aqui.
@end quotation
@end cartouche

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

@end menu

@node Métodos de Turtle,Métodos de TurtleScreen/Screen,,Referência Gráficos de Tartaruga
@anchor{library/turtle turtle-methods}@anchor{40eb}
@subsubsection Métodos de Turtle



@table @asis

@item Movimentos de Turtle


@table @asis

@item Movimento e desenho


@display
@ref{32f1,,forward()} | @ref{40ec,,fd()}@w{ }
@ref{40ed,,backward()} | @ref{40ee,,bk()} | @ref{40ef,,back()}@w{ }
@ref{40f0,,right()} | @ref{40f1,,rt()}@w{ }
@ref{40f2,,left()} | @ref{40f3,,lt()}@w{ }
@ref{40f4,,goto()} | @ref{40f5,,setpos()} | @ref{40f6,,setposition()}@w{ }
@ref{181b,,teleport()}@w{ }
@ref{40f7,,setx()}@w{ }
@ref{40f8,,sety()}@w{ }
@ref{40f9,,setheading()} | @ref{40fa,,seth()}@w{ }
@ref{40fb,,home()}@w{ }
@ref{40fc,,circle()}@w{ }
@ref{40fd,,dot()}@w{ }
@ref{40fe,,stamp()}@w{ }
@ref{40ff,,clearstamp()}@w{ }
@ref{4100,,clearstamps()}@w{ }
@ref{4101,,undo()}@w{ }
@ref{4102,,speed()}@w{ }
@end display



@item Fala o estado de Turtle


@display
@ref{4103,,position()} | @ref{4104,,pos()}@w{ }
@ref{4105,,towards()}@w{ }
@ref{4106,,xcor()}@w{ }
@ref{4107,,ycor()}@w{ }
@ref{4108,,heading()}@w{ }
@ref{4109,,distance()}@w{ }
@end display



@item Configuração e Medidas


@display
@ref{410a,,degrees()}@w{ }
@ref{410b,,radians()}@w{ }
@end display


@end table

@item Controle da Caneta


@table @asis

@item Estado do Desenho


@display
@ref{410c,,pendown()} | @ref{410d,,pd()} | @ref{410e,,down()}@w{ }
@ref{410f,,penup()} | @ref{4110,,pu()} | @ref{4111,,up()}@w{ }
@ref{4112,,pensize()} | @ref{4113,,width()}@w{ }
@ref{4114,,pen()}@w{ }
@ref{4115,,isdown()}@w{ }
@end display



@item Controle da Cor


@display
@ref{4116,,color()}@w{ }
@ref{4117,,pencolor()}@w{ }
@ref{4118,,fillcolor()}@w{ }
@end display



@item Preenchimento


@display
@ref{4119,,filling()}@w{ }
@ref{411a,,begin_fill()}@w{ }
@ref{411b,,end_fill()}@w{ }
@end display



@item Mais sobre o Controle do Desenho


@display
@ref{411c,,reset()}@w{ }
@ref{411d,,clear()}@w{ }
@ref{411e,,write()}@w{ }
@end display


@end table

@item Estado da tartaruga


@table @asis

@item Visibilidade


@display
@ref{411f,,showturtle()} | @ref{4120,,st()}@w{ }
@ref{4121,,hideturtle()} | @ref{4122,,ht()}@w{ }
@ref{4123,,isvisible()}@w{ }
@end display



@item Aparência


@display
@ref{4124,,shape()}@w{ }
@ref{4125,,resizemode()}@w{ }
@ref{4126,,shapesize()} | @ref{4127,,turtlesize()}@w{ }
@ref{4128,,shearfactor()}@w{ }
@ref{725,,tiltangle()}@w{ }
@ref{4129,,tilt()}@w{ }
@ref{412a,,shapetransform()}@w{ }
@ref{412b,,get_shapepoly()}@w{ }
@end display


@end table

@item Eventos Utilizados


@display
@ref{412c,,onclick()}@w{ }
@ref{412d,,onrelease()}@w{ }
@ref{412e,,ondrag()}@w{ }
@end display



@item Métodos Especiais da Tartaruga


@display
@ref{412f,,begin_poly()}@w{ }
@ref{4130,,end_poly()}@w{ }
@ref{4131,,get_poly()}@w{ }
@ref{4132,,clone()}@w{ }
@ref{4133,,getturtle()} | @ref{4134,,getpen()}@w{ }
@ref{4135,,getscreen()}@w{ }
@ref{4136,,setundobuffer()}@w{ }
@ref{4137,,undobufferentries()}@w{ }
@end display


@end table

@node Métodos de TurtleScreen/Screen,,Métodos de Turtle,Referência Gráficos de Tartaruga
@anchor{library/turtle methods-of-turtlescreen-screen}@anchor{4138}
@subsubsection Métodos de TurtleScreen/Screen



@table @asis

@item Controle da Janela


@display
@ref{4139,,bgcolor()}@w{ }
@ref{413a,,bgpic()}@w{ }
@ref{413b,,clearscreen()}@w{ }
@ref{413c,,resetscreen()}@w{ }
@ref{413d,,screensize()}@w{ }
@ref{413e,,setworldcoordinates()}@w{ }
@end display



@item Controle da animação


@display
@ref{413f,,delay()}@w{ }
@ref{4140,,tracer()}@w{ }
@ref{4141,,update()}@w{ }
@end display



@item Usando os eventos de tela


@display
@ref{4142,,listen()}@w{ }
@ref{4143,,onkey()} | @ref{4144,,onkeyrelease()}@w{ }
@ref{4145,,onkeypress()}@w{ }
@ref{412c,,onclick()} | @ref{4146,,onscreenclick()}@w{ }
@ref{4147,,ontimer()}@w{ }
@ref{4148,,mainloop()} | @ref{4149,,done()}@w{ }
@end display



@item Configurações e métodos especiais


@display
@ref{414a,,mode()}@w{ }
@ref{414b,,colormode()}@w{ }
@ref{414c,,getcanvas()}@w{ }
@ref{414d,,getshapes()}@w{ }
@ref{414e,,register_shape()} | @ref{414f,,addshape()}@w{ }
@ref{4150,,turtles()}@w{ }
@ref{4151,,window_height()}@w{ }
@ref{4152,,window_width()}@w{ }
@end display



@item Métodos de entrada


@display
@ref{1a06,,textinput()}@w{ }
@ref{1a07,,numinput()}@w{ }
@end display



@item Métodos específicos para Screen


@display
@ref{4153,,bye()}@w{ }
@ref{4154,,exitonclick()}@w{ }
@ref{4155,,setup()}@w{ }
@ref{4156,,title()}@w{ }
@end display


@end table

@node Métodos de RawTurtle/Turtle e funções correspondentes,métodos do TurtleScreen/Screen e as funções correspondentes,Referência Gráficos de Tartaruga,turtle — Gráficos tartaruga
@anchor{library/turtle methods-of-rawturtle-turtle-and-corresponding-functions}@anchor{4157}
@subsubsection Métodos de RawTurtle/Turtle e funções correspondentes


A maioria dos exemplos desta seção referem-se a uma instância Turtle chamada @code{turtle}.

@menu
* Movimentos de Turtle:: 
* Fala o estado de Turtle:: 
* Configurações de medida:: 
* Controle da Caneta: Controle da Caneta<2>. 
* Estado da tartaruga:: 
* Eventos Utilizados:: 
* Métodos Especiais da Tartaruga:: 
* Formas compostas:: 

@end menu

@node Movimentos de Turtle,Fala o estado de Turtle,,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle turtle-motion}@anchor{4158}
@subsubsection Movimentos de Turtle


@geindex forward() (no módulo turtle)
@geindex fd() (no módulo turtle)
@anchor{library/turtle turtle forward}@anchor{32f1}
@deffn {Função} turtle.forward (distance)
@anchor{library/turtle turtle fd}@anchor{40ec}
@deffnx {Função} turtle.fd (distance)

@*Parâmetros: 
@code{distance} – um número (inteiro ou ponto flutuante)


Move a tartaruga para frente pela `distance' especificada, na direção em que a tartaruga está indo.

@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() (no módulo turtle)
@geindex bk() (no módulo turtle)
@geindex backward() (no módulo turtle)
@anchor{library/turtle turtle back}@anchor{40ef}
@deffn {Função} turtle.back (distance)
@anchor{library/turtle turtle bk}@anchor{40ee}
@deffnx {Função} turtle.bk (distance)
@anchor{library/turtle turtle backward}@anchor{40ed}
@deffnx {Função} turtle.backward (distance)

@*Parâmetros: 
@code{distance} – um número


Move a tartaruga para trás por `distance', na direção oposta à direção em que a tartaruga está indo. Não muda o rumo da tartaruga.

@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() (no módulo turtle)
@geindex rt() (no módulo turtle)
@anchor{library/turtle turtle right}@anchor{40f0}
@deffn {Função} turtle.right (angle)
@anchor{library/turtle turtle rt}@anchor{40f1}
@deffnx {Função} turtle.rt (angle)

@*Parâmetros: 
@code{angle} – um número (inteiro ou ponto flutuante)


Vira a tartaruga à direita por unidades de `angle'. (As unidades são por padrão graus, mas podem ser definidas através das funções @ref{410a,,degrees()} e @ref{410b,,radians()}.) A orientação do ângulo depende do modo tartaruga, veja @ref{414a,,mode()}.

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.right(45)
>>> turtle.heading()
337.0
@end example
@end deffn

@geindex left() (no módulo turtle)
@geindex lt() (no módulo turtle)
@anchor{library/turtle turtle left}@anchor{40f2}
@deffn {Função} turtle.left (angle)
@anchor{library/turtle turtle lt}@anchor{40f3}
@deffnx {Função} turtle.lt (angle)

@*Parâmetros: 
@code{angle} – um número (inteiro ou ponto flutuante)


Vira a tartaruga à esquerda por unidades de `angle'. (As unidades são por padrão graus, mas podem ser definidas através das funções @ref{410a,,degrees()} e @ref{410b,,radians()}.) A orientação do ângulo depende do modo tartaruga, veja @ref{414a,,mode()}.

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.left(45)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex goto() (no módulo turtle)
@geindex setpos() (no módulo turtle)
@geindex setposition() (no módulo turtle)
@anchor{library/turtle turtle goto}@anchor{40f4}
@deffn {Função} turtle.goto (x, y=None)
@anchor{library/turtle turtle setpos}@anchor{40f5}
@deffnx {Função} turtle.setpos (x, y=None)
@anchor{library/turtle turtle setposition}@anchor{40f6}
@deffnx {Função} turtle.setposition (x, y=None)

@*Parâmetros: 

@itemize *

@item 
@code{x} – um número ou um par/vetor de números

@item 
@code{y} – um número ou @code{None}
@end itemize


Se `y' for @code{None}, `x' deve ser um par de coordenadas ou uma classe @ref{4159,,Vec2D} (por exemplo, como retornado pela função @ref{4104,,pos()}).

Move a tartaruga para uma posição absoluta. Caso a caneta esteja virada para baixo, traça a linha. Não altera a orientação da tartaruga.

@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() (no módulo turtle)
@anchor{library/turtle turtle teleport}@anchor{181b}
@deffn {Função} turtle.teleport (x, y=None, *, fill_gap=False)

@*Parâmetros: 

@itemize *

@item 
@code{x} – um número ou @code{None}

@item 
@code{y} – um número ou @code{None}

@item 
@code{fill_gap} – um valor booleano
@end itemize


Move a tartaruga para uma posição absoluta. Ao contrário de goto(x, y), uma linha não será desenhada. A orientação da tartaruga não muda. Se estiver sendo preenchido no momento, o(s) polígono(s) teletransportado(s) será(ão) preenchido(s) após sair, e o preenchimento começará novamente após o teletransporte. Isso pode ser desabilitado com fill_gap=True, o que faz com que a linha imaginária percorrida durante o teletransporte atue como uma barreira de preenchimento como em 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


Adicionado na versão 3.12.

@end deffn

@geindex setx() (no módulo turtle)
@anchor{library/turtle turtle setx}@anchor{40f7}
@deffn {Função} turtle.setx (x)

@*Parâmetros: 
@code{x} – um número (inteiro ou ponto flutuante)


Define a primeira coordenada da tartaruga para `x', deixa a segunda coordenada inalterada.

@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() (no módulo turtle)
@anchor{library/turtle turtle sety}@anchor{40f8}
@deffn {Função} turtle.sety (y)

@*Parâmetros: 
@code{y} – um número (inteiro ou ponto flutuante)


Defina a segunda coordenada da tartaruga para `y', deixa a primeira coordenada inalterada.

@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() (no módulo turtle)
@geindex seth() (no módulo turtle)
@anchor{library/turtle turtle setheading}@anchor{40f9}
@deffn {Função} turtle.setheading (to_angle)
@anchor{library/turtle turtle seth}@anchor{40fa}
@deffnx {Função} turtle.seth (to_angle)

@*Parâmetros: 
@code{to_angle} – um número (inteiro ou ponto flutuante)


Define a orientação da tartaruga para  `to_angle'. Aqui estão algumas direções mais comuns em graus:


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

modo padrão

@tab

modo logo

@item

0 - leste

@tab

0 - norte

@item

90 - norte

@tab

90 - leste

@item

180 - oeste

@tab

180 - sul

@item

270 - sul

@tab

270 - oeste

@end multitable


@example
>>> turtle.setheading(90)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex home() (no módulo turtle)
@anchor{library/turtle turtle home}@anchor{40fb}
@deffn {Função} turtle.home ()

Move a tartaruga para a origem – coordenadas (0,0) – e define seu rumo para sua orientação inicial (que depende do modo, veja @ref{414a,,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() (no módulo turtle)
@anchor{library/turtle turtle circle}@anchor{40fc}
@deffn {Função} turtle.circle (radius, extent=None, steps=None)

@*Parâmetros: 

@itemize *

@item 
@code{radius} – um número

@item 
@code{extent} – um número (ou @code{None})

@item 
@code{steps} – um inteiro  (ou @code{None})
@end itemize


Desenha um círculo com dado `radius'. O centro são as unidades de `radius' à esquerda da tartaruga; `extent' – um ângulo – determina qual parte do círculo é desenhada. Se `extent' não for fornecida, desenha o círculo inteiro. Se `extent' não for um círculo completo, uma extremidade do arco será a posição atual da caneta. Desenha o arco no sentido anti-horário se `radius' for positivo, caso contrário, no sentido horário. Finalmente, a direção da tartaruga é alterada pela quantidade de `extent'.

Como o círculo é aproximado por um polígono regular inscrito, `steps' determina o número de passos a serem usados. Caso não seja informado, será calculado automaticamente. Pode ser usado para desenhar 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() (no módulo turtle)
@anchor{library/turtle turtle dot}@anchor{40fd}
@deffn {Função} turtle.dot ()

@deffnx {Função} turtle.dot (size)

@deffnx {Função} turtle.dot (color, /)

@deffnx {Função} turtle.dot (size, color, /)

@deffnx {Função} turtle.dot (size, r, g, b, /)

@*Parâmetros: 

@itemize *

@item 
@code{size} – um inteiro >= 1  (caso seja fornecido)

@item 
@code{color} – uma string de cores ou uma tupla de cores numéricas
@end itemize


Desenha um ponto circular com diâmetro `size', usando `color'. Se `size' não for fornecido, o máximo de @code{pensize+4} e @code{2*pensize} será 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() (no módulo turtle)
@anchor{library/turtle turtle stamp}@anchor{40fe}
@deffn {Função} turtle.stamp ()

Carimba uma cópia da forma da tartaruga na tela na posição atual da tartaruga. Retorna um stamp_id para esse carimbo, que pode ser usado para excluí-lo chamando @code{clearstamp(stamp_id)}.

@example
>>> turtle.color("blue")
>>> stamp_id = turtle.stamp()
>>> turtle.fd(50)
@end example
@end deffn

@geindex clearstamp() (no módulo turtle)
@anchor{library/turtle turtle clearstamp}@anchor{40ff}
@deffn {Função} turtle.clearstamp (stampid)

@*Parâmetros: 
@code{stampid} – um inteiro, deve ser o valor de retorno da chamada de @ref{40fe,,stamp()} anterior


Exclui o carimbo com o `stamp' fornecido.

@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() (no módulo turtle)
@anchor{library/turtle turtle clearstamps}@anchor{4100}
@deffn {Função} turtle.clearstamps (n=None)

@*Parâmetros: 
@code{n} – um inteiro  (ou @code{None})


Exclui todos ou o primeiro/último `n' dos selos da tartaruga. Se `n' for @code{None}, exclui todos os carimbos, se `n' > 0 exclui os primeiros `n' carimbos, senão se `n' < 0 exclui os últimos `n' carimbos.

@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() (no módulo turtle)
@anchor{library/turtle turtle undo}@anchor{4101}
@deffn {Função} turtle.undo ()

Desfaz (repetidamente) a(s) última(s) ação(ões) da tartaruga. O número de ações de desfazer disponíveis é determinado pelo tamanho do buffer de desfazer.

@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() (no módulo turtle)
@anchor{library/turtle turtle speed}@anchor{4102}
@deffn {Função} turtle.speed (speed=None)

@*Parâmetros: 
@code{speed} – um inteiro no intervalo 0..10 ou uma string de velocidade (veja abaixo)


Define a velocidade da tartaruga para um valor inteiro no intervalo 0..10. Se nenhum argumento for fornecido, retorna a velocidade atual.

Se a entrada for um número maior que 10 ou menor que 0,5, a velocidade é definida como 0. As strings de velocidade são mapeadas para valores de velocidade da seguinte forma:


@itemize *

@item 
“fastest”: 0

@item 
“fast”: 10

@item 
“normal”: 6

@item 
“slow”: 3

@item 
“slowest”: 1
@end itemize

Velocidades de 1 a 10  tornam a animação cada vez mais rápida, tanto para o desenho da linha  como para a rotação da tartaruga.

Atenção: `speed' = 0 significa que `nenhuma' animação ocorre. forward/back faz a tartaruga pular e da mesma forma para left/right faz a tartaruga girar instantaneamente.

@example
>>> turtle.speed()
3
>>> turtle.speed('normal')
>>> turtle.speed()
6
>>> turtle.speed(9)
>>> turtle.speed()
9
@end example
@end deffn

@node Fala o estado de Turtle,Configurações de medida,Movimentos de Turtle,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle tell-turtle-s-state}@anchor{415a}
@subsubsection Fala o estado de Turtle


@geindex position() (no módulo turtle)
@geindex pos() (no módulo turtle)
@anchor{library/turtle turtle position}@anchor{4103}
@deffn {Função} turtle.position ()
@anchor{library/turtle turtle pos}@anchor{4104}
@deffnx {Função} turtle.pos ()

Retorna a localização atual da tartaruga (x,y) (como um vetor @ref{4159,,Vec2D}).

@example
>>> turtle.pos()
(440.00,-0.00)
@end example
@end deffn

@geindex towards() (no módulo turtle)
@anchor{library/turtle turtle towards}@anchor{4105}
@deffn {Função} turtle.towards (x, y=None)

@*Parâmetros: 

@itemize *

@item 
@code{x} – um número ou um par/vetor de números ou uma instância de tartaruga

@item 
@code{y} – um número caso `x' seja um número, senão @code{None}
@end itemize


Retorna o ângulo entre a linha da posição da tartaruga para a posição especificada por (x,y), o vetor ou a outra tartaruga. Isso depende da orientação inicial da tartaruga, que depende do modo - “standard”/”world” ou “logo”.

@example
>>> turtle.goto(10, 10)
>>> turtle.towards(0,0)
225.0
@end example
@end deffn

@geindex xcor() (no módulo turtle)
@anchor{library/turtle turtle xcor}@anchor{4106}
@deffn {Função} turtle.xcor ()

Retorna a coordenada X da tartaruga.

@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() (no módulo turtle)
@anchor{library/turtle turtle ycor}@anchor{4107}
@deffn {Função} turtle.ycor ()

Retorna a coordenada Y da tartaruga.

@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() (no módulo turtle)
@anchor{library/turtle turtle heading}@anchor{4108}
@deffn {Função} turtle.heading ()

Retorna o título atual da tartaruga (o valor depende do modo da tartaruga, veja @ref{414a,,mode()}).

@example
>>> turtle.home()
>>> turtle.left(67)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex distance() (no módulo turtle)
@anchor{library/turtle turtle distance}@anchor{4109}
@deffn {Função} turtle.distance (x, y=None)

@*Parâmetros: 

@itemize *

@item 
@code{x} – um número ou um par/vetor de números ou uma instância de tartaruga

@item 
@code{y} – um número caso `x' seja um número, senão @code{None}
@end itemize


Retorna a distância da tartaruga para (x,y), o vetor dado, ou a outra tartaruga dada, em unidades de passo de tartaruga.

@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 Configurações de medida,Controle da Caneta<2>,Fala o estado de Turtle,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle settings-for-measurement}@anchor{415b}
@subsubsection Configurações de medida


@geindex degrees() (no módulo turtle)
@anchor{library/turtle turtle degrees}@anchor{410a}
@deffn {Função} turtle.degrees (fullcircle=360.0)

@*Parâmetros: 
@code{fullcircle} – um número


Define as unidades de medição do ângulo, ou seja, defina o número de “graus” para um círculo completo. O valor padrão é 360 graus.

@example
>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0

>>> # Alterar unidade de medida de ângulo para grad (também
>>> # conhecido como gon, grau ou grado e é igual a 1/100
>>> # do ângulo reto).
>>> turtle.degrees(400.0)
>>> turtle.heading()
100.0
>>> turtle.degrees(360)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex radians() (no módulo turtle)
@anchor{library/turtle turtle radians}@anchor{410b}
@deffn {Função} turtle.radians ()

Define as unidades de medida de ângulo para radianos. 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 Controle da Caneta<2>,Estado da tartaruga,Configurações de medida,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle id1}@anchor{415c}
@subsubsection Controle da Caneta


@menu
* Estado do Desenho:: 
* Controle da Cor:: 
* Preenchimento:: 
* Mais sobre o Controle do Desenho:: 

@end menu

@node Estado do Desenho,Controle da Cor,,Controle da Caneta<2>
@anchor{library/turtle drawing-state}@anchor{415d}
@subsubsection Estado do Desenho


@geindex pendown() (no módulo turtle)
@geindex pd() (no módulo turtle)
@geindex down() (no módulo turtle)
@anchor{library/turtle turtle pendown}@anchor{410c}
@deffn {Função} turtle.pendown ()
@anchor{library/turtle turtle pd}@anchor{410d}
@deffnx {Função} turtle.pd ()
@anchor{library/turtle turtle down}@anchor{410e}
@deffnx {Função} turtle.down ()

Desce a caneta - desenha ao se mover.
@end deffn

@geindex penup() (no módulo turtle)
@geindex pu() (no módulo turtle)
@geindex up() (no módulo turtle)
@anchor{library/turtle turtle penup}@anchor{410f}
@deffn {Função} turtle.penup ()
@anchor{library/turtle turtle pu}@anchor{4110}
@deffnx {Função} turtle.pu ()
@anchor{library/turtle turtle up}@anchor{4111}
@deffnx {Função} turtle.up ()

Levanta a caneta – sem qualquer desenho ao se mover.
@end deffn

@geindex pensize() (no módulo turtle)
@geindex width() (no módulo turtle)
@anchor{library/turtle turtle pensize}@anchor{4112}
@deffn {Função} turtle.pensize (width=None)
@anchor{library/turtle turtle width}@anchor{4113}
@deffnx {Função} turtle.width (width=None)

@*Parâmetros: 
@code{width} – um número positivo


Define a espessura da linha para `width' ou retorna-a. Se resizemode estiver definido como “auto” e a forma de tartaruga for um polígono, esse polígono será desenhado com a mesma espessura de linha. Se nenhum argumento for fornecido, a espessura atual da caneta será retornada.

@example
>>> turtle.pensize()
1
>>> turtle.pensize(10)   # from here on lines of width 10 are drawn
@end example
@end deffn

@geindex pen() (no módulo turtle)
@anchor{library/turtle turtle pen}@anchor{4114}
@deffn {Função} turtle.pen (pen=None, **pendict)

@*Parâmetros: 

@itemize *

@item 
@code{pen} – um dicionário com algumas ou todas as chaves listadas abaixo

@item 
@code{pendict} – um ou mais argumentos nomeados com as chaves listadas abaixo como palavras-chave
@end itemize


Retorna ou define os atributos da caneta em um “dicionário da caneta” com os seguintes pares de chave/valor:


@itemize *

@item 
“shown”: True/False

@item 
“pendown”: True/False

@item 
“pencolor”: string de cores ou tupla de cores

@item 
“fillcolor”: string de cores ou tupla de cores

@item 
“pensize”: número positivo

@item 
“speed”: número na faixa de 0..10.

@item 
“resizemode”: “auto”, “user” ou “noresize”

@item 
“stretchfactor”: (número positivo, número positivo)

@item 
“outline”: número positivo

@item 
“tilt”: número
@end itemize

Este dicionário pode ser usado como argumento para uma chamada subsequente para @ref{4114,,pen()} para restaurar o estado da caneta anterior. Além disso, um ou mais desses atributos podem ser fornecidos como argumentos nomeados. Isso pode ser usado para definir vários atributos de caneta em uma instrução.

@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() (no módulo turtle)
@anchor{library/turtle turtle isdown}@anchor{4115}
@deffn {Função} turtle.isdown ()

Retorna @code{True} se a caneta estiver abaixada, @code{False} se estiver levantada.

@example
>>> turtle.penup()
>>> turtle.isdown()
False
>>> turtle.pendown()
>>> turtle.isdown()
True
@end example
@end deffn

@node Controle da Cor,Preenchimento,Estado do Desenho,Controle da Caneta<2>
@anchor{library/turtle color-control}@anchor{415e}
@subsubsection Controle da Cor


@geindex pencolor() (no módulo turtle)
@anchor{library/turtle turtle pencolor}@anchor{4117}
@deffn {Função} turtle.pencolor ()

@deffnx {Função} turtle.pencolor (color, /)

@deffnx {Função} turtle.pencolor (r, g, b, /)

Retorna ou define a cor da caneta ou pencolor.

São permitidos quatro formatos de entrada:


@table @asis

@item @code{pencolor()}

Retorna a cor da caneta atual como string de especificação de cor ou como uma tupla (veja o exemplo). Pode ser usado como entrada para outra chamada color/pencolor/fillcolor/bgcolor.

@item @code{pencolor(colorstring)}

Define pencolor como `colorstring', que é uma string de especificação de cor Tk, como @code{"red"}, @code{"yellow"} ou @code{"#33cc8c"}.

@item @code{pencolor((r, g, b))}

Define a cor da caneta como a cor RGB representada pela tupla `r', `g', e `b'. Os valores de `r', `g', and `b' precisam estar na faixa 0..colormode, onde colormode é 1.0 ou 255 (ver @ref{414b,,colormode()}).

@item @code{pencolor(r, g, b)}

Define a cor da caneta como a cor RGB representada por `r', `g', e `b'. Os valores de `r', `g', and `b' precisam estar na faixa 0..colormode.
@end table

Se a forma da tartaruga for um polígono, o contorno desse polígono será desenhado com a nova cor de caneta definida.

@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() (no módulo turtle)
@anchor{library/turtle turtle fillcolor}@anchor{4118}
@deffn {Função} turtle.fillcolor ()

@deffnx {Função} turtle.fillcolor (color, /)

@deffnx {Função} turtle.fillcolor (r, g, b, /)

Retorna ou define o fillcolor.

São permitidos quatro formatos de entrada:


@table @asis

@item @code{fillcolor()}

Retorna a cor de preenchimento atual como string, ou em formato de tupla (veja o exemplo).  Pode ser usado como entrada para outra chamada color/pencolor/fillcolor/bgcolor.

@item @code{fillcolor(colorstring)}

Define fillcolor como `colorstring', que é uma especificação de cor do Tk em formato de string, como @code{"red"}, @code{"yellow"}, ou @code{"#33cc8c"}.

@item @code{fillcolor((r, g, b))}

Define fillcolor como a cor no padrão RGB representada por tupla de `r', `g' e `b'.  Cada um de `r', `g' e `b' deve estar no limite 0..colormode, em que colormode é 1,0 ou 255 (consulte @ref{414b,,colormode()}).

@item @code{fillcolor(r, g, b)}

Define fillcolor como uma cor no formato RGB representada por `r', `g' e `b'.  Cada um dos elementos `r', `g' e `b' devem estar no limite 0..colormode.
@end table

Se turtleshape for um polígono, o interior desse polígono será desenhado com a nova cor de preenchimento definida.

@example
>>> turtle.fillcolor("violet")
>>> turtle.fillcolor()
'violet'
>>> turtle.pencolor()
(50.0, 193.0, 143.0)
>>> turtle.fillcolor((50, 193, 143))  # Inteiros, não pontos flutuantes
>>> 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() (no módulo turtle)
@anchor{library/turtle turtle color}@anchor{4116}
@deffn {Função} turtle.color ()

@deffnx {Função} turtle.color (color, /)

@deffnx {Função} turtle.color (r, g, b, /)

@deffnx {Função} turtle.color (pencolor, fillcolor, /)

Retorna ou define os valores de pencolor e fillcolor.

Diversos formatos de entrada são permitidos.  Eles usam de 0 a 3 argumentos da seguinte forma:


@table @asis

@item @code{color()}

Retorna os valores atuais de pencolor e fillcollor como um par de cores como strings ou tuplas conforme retornado por @ref{4117,,pencolor()} e @ref{4118,,fillcolor()}.

@item @code{color(colorstring)}, @code{color((r,g,b))}, @code{color(r,g,b)}

Entradas como em @ref{4117,,pencolor()}, define ambos, fillcolor e pencolor, para o valor informado.

@item @code{color(colorstring1, colorstring2)}, @code{color((r1,g1,b1), (r2,g2,b2))}

Equivalente a @code{pencolor(colorstring1)} e @code{fillcolor(colorstring2)} e de forma análoga se a outra formatação de entrada for usada.
@end table

Se o turtleshape for um polígono, o contorno e o interior desse polígono serão desenhados com as cores recém-definidas.

@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

Veja também: Método da tela @ref{414b,,colormode()}.

@node Preenchimento,Mais sobre o Controle do Desenho,Controle da Cor,Controle da Caneta<2>
@anchor{library/turtle filling}@anchor{415f}
@subsubsection Preenchimento


@c >>> turtle.home()

@geindex filling() (no módulo turtle)
@anchor{library/turtle turtle filling}@anchor{4119}
@deffn {Função} turtle.filling ()

Retorna fillstate (@code{True} se estiver preenchido, @code{False} caso contrário).

@example
>>> turtle.begin_fill()
>>> if turtle.filling():
...    turtle.pensize(5)
... else:
...    turtle.pensize(3)
@end example
@end deffn

@geindex begin_fill() (no módulo turtle)
@anchor{library/turtle turtle begin_fill}@anchor{411a}
@deffn {Função} turtle.begin_fill ()

Deve ser chamado antes de desenhar uma forma a ser preenchida.
@end deffn

@geindex end_fill() (no módulo turtle)
@anchor{library/turtle turtle end_fill}@anchor{411b}
@deffn {Função} turtle.end_fill ()

Preenche a forma desenhada após a última chamada para @ref{411a,,begin_fill()}.

O preenchimento ou não de regiões sobrepostas para polígonos que se cruzam ou formas múltiplas depende dos gráficos do sistema operacional, do tipo de sobreposição e do número de sobreposições. Por exemplo, a estrela da Tartaruga acima pode ser toda amarela ou ter algumas regiões brancas.

@example
>>> turtle.color("black", "red")
>>> turtle.begin_fill()
>>> turtle.circle(80)
>>> turtle.end_fill()
@end example
@end deffn

@node Mais sobre o Controle do Desenho,,Preenchimento,Controle da Caneta<2>
@anchor{library/turtle more-drawing-control}@anchor{4160}
@subsubsection Mais sobre o Controle do Desenho


@geindex reset() (no módulo turtle)
@anchor{library/turtle turtle reset}@anchor{411c}
@deffn {Função} turtle.reset ()

Remove os desenhos da tartaruga da tela, centraliza novamente a tartaruga e define as variáveis para os valores padrões.

@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() (no módulo turtle)
@anchor{library/turtle turtle clear}@anchor{411d}
@deffn {Função} turtle.clear ()

Exclui os desenhos da tartaruga da tela e não move a tartaruga. O atual estado e posição da tartaruga, bem como os desenhos de outras tartarugas, não são afetados.
@end deffn

@geindex write() (no módulo turtle)
@anchor{library/turtle turtle write}@anchor{411e}
@deffn {Função} turtle.write (arg, move=False, align='left', font=('Arial', 8, 'normal'))

@*Parâmetros: 

@itemize *

@item 
@code{arg} – objeto a ser escrito na TurtleScreen

@item 
@code{move} – True/False

@item 
@code{align} – uma das Strings “left”, “center” ou right”

@item 
@code{font} – a triple (fontname, fontsize, fonttype)
@end itemize


Escreve o texto - a representação string de `arg' - na posição atual da tartaruga de acordo com `align' (“left”, “center” ou “right”) e com a fonte fornecida. Se `move' for verdadeiro, a caneta será movida para o canto inferior direito do texto.  Por padrão, `move' é @code{False}.

@example
>>> turtle.write("Home = ", True, align="center")
>>> turtle.write((0,0), True)
@end example
@end deffn

@node Estado da tartaruga,Eventos Utilizados,Controle da Caneta<2>,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle turtle-state}@anchor{4161}
@subsubsection Estado da tartaruga


@menu
* Visibilidade:: 
* Aparência:: 

@end menu

@node Visibilidade,Aparência,,Estado da tartaruga
@anchor{library/turtle visibility}@anchor{4162}
@subsubsection Visibilidade


@geindex hideturtle() (no módulo turtle)
@geindex ht() (no módulo turtle)
@anchor{library/turtle turtle hideturtle}@anchor{4121}
@deffn {Função} turtle.hideturtle ()
@anchor{library/turtle turtle ht}@anchor{4122}
@deffnx {Função} turtle.ht ()

Torna a tartaruga invisível.  É uma boa ideia fazer isso enquanto estiver fazendo algum desenho complexo, pois ocultar a tartaruga acelera o desenho de forma visível.

@example
>>> turtle.hideturtle()
@end example
@end deffn

@geindex showturtle() (no módulo turtle)
@geindex st() (no módulo turtle)
@anchor{library/turtle turtle showturtle}@anchor{411f}
@deffn {Função} turtle.showturtle ()
@anchor{library/turtle turtle st}@anchor{4120}
@deffnx {Função} turtle.st ()

Tornar a tartaruga visível.

@example
>>> turtle.showturtle()
@end example
@end deffn

@geindex isvisible() (no módulo turtle)
@anchor{library/turtle turtle isvisible}@anchor{4123}
@deffn {Função} turtle.isvisible ()

Retorna @code{True} se a Tartaruga for exibida, @code{False} se estiver oculta.

@example
>>> turtle.hideturtle()
>>> turtle.isvisible()
False
>>> turtle.showturtle()
>>> turtle.isvisible()
True
@end example
@end deffn

@node Aparência,,Visibilidade,Estado da tartaruga
@anchor{library/turtle appearance}@anchor{4163}
@subsubsection Aparência


@geindex shape() (no módulo turtle)
@anchor{library/turtle turtle shape}@anchor{4124}
@deffn {Função} turtle.shape (name=None)

@*Parâmetros: 
@code{name} – uma string que é um shapename válido


Define a forma da tartaruga para a forma com o `nome' fornecido ou, se o nome não for fornecido, retorna nome da forma atual.  A forma com `name' deve existir no dicionário TurtleScreen. Inicialmente, há as seguintes formas de polígono: “arrow” (seta), “turtle” (tartaruga), “circle” (círculo), “square” (quadrado), “triangle” (triângulo), “classic” (clássico). Para saber mais sobre como lidar com formas, consulte o método Screen @ref{414e,,register_shape()} .

@example
>>> turtle.shape()
'classic'
>>> turtle.shape("turtle")
>>> turtle.shape()
'turtle'
@end example
@end deffn

@geindex resizemode() (no módulo turtle)
@anchor{library/turtle turtle resizemode}@anchor{4125}
@deffn {Função} turtle.resizemode (rmode=None)

@*Parâmetros: 
@code{rmode} – uma das Strings “auto”, “user”, “noresize”


Define resizemode como um dos valores: “auto”, “user”, “noresize”.  Se `rmode' não for fornecido, retorna o modo de redimensionamento atual.  Os diferentes modos de redimensionamento têm os seguintes efeitos:


@itemize -

@item 
“auto”: adapta a aparência da tartaruga correspondente ao valor do pensize.

@item 
“user”: adapta a aparência da tartaruga de acordo com os valores de stretchfactor e outlinewidth (outline), que são definidos por @ref{4126,,shapesize()}.

@item 
“noresize”: não acontece nenhuma adaptação na aparência da tartaruga.
@end itemize

@code{resizemode("user")} é chamado por @ref{4126,,shapesize()} quando usado com argumentos.

@example
>>> turtle.resizemode()
'noresize'
>>> turtle.resizemode("auto")
>>> turtle.resizemode()
'auto'
@end example
@end deffn

@geindex shapesize() (no módulo turtle)
@geindex turtlesize() (no módulo turtle)
@anchor{library/turtle turtle shapesize}@anchor{4126}
@deffn {Função} turtle.shapesize (stretch_wid=None, stretch_len=None, outline=None)
@anchor{library/turtle turtle turtlesize}@anchor{4127}
@deffnx {Função} 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


Retorna ou define os atributos x/y-stretchfactors e/ou contorno da caneta. Define o modo de redimensionamento como “usuário”. Se e somente se resizemode estiver definido como “user”, a tartaruga será exibida esticada de acordo com seus stretchfactors: `stretch_wid' é stretchfactor perpendicular à sua orientação, `stretch_len' é stretchfactor na direção de sua orientação, `outline' determina a largura do contorno da forma.

@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() (no módulo turtle)
@anchor{library/turtle turtle shearfactor}@anchor{4128}
@deffn {Função} turtle.shearfactor (shear=None)

@*Parâmetros: 
@code{shear} – número (opcional)


Define ou retorna o fator de shearfactor atual. Corta a forma de tartaruga de acordo com o fator de shearfactor fornecido, que é a tangente do ângulo de shearfactor. `Não' muda a direção da tartaruga (direção do movimento). Se o shearfactor não for fornecido: retorna o fator de shearfactor atual, i. Isso é. a tangente do ângulo de shearfactor, pelo qual as linhas paralelas à direção da tartaruga são cortadas.

@example
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.shearfactor(0.5)
>>> turtle.shearfactor()
0.5
@end example
@end deffn

@geindex tilt() (no módulo turtle)
@anchor{library/turtle turtle tilt}@anchor{4129}
@deffn {Função} turtle.tilt (angle)

@*Parâmetros: 
@code{angle} – um número


Gira a forma de tartaruga em um `ângulo' a partir de seu ângulo de inclinação atual, mas `não' altera o rumo da tartaruga (direção do movimento).

@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() (no módulo turtle)
@anchor{library/turtle turtle tiltangle}@anchor{725}
@deffn {Função} turtle.tiltangle (angle=None)

@*Parâmetros: 
@code{angle} – um número (opcional)


Define ou retorna o ângulo de inclinação atual. Se o ângulo for fornecido, gira a forma de tartaruga para apontar na direção especificada pelo ângulo, independentemente do seu ângulo de inclinação atual. `Não' muda a direção da tartaruga (direção do movimento). Se o ângulo não for fornecido: retorna o ângulo de inclinação atual, que é o ângulo entre a orientação da forma da tartaruga e a direção da tartaruga (sua direção de movimento).

@example
>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(45)
>>> turtle.tiltangle()
45.0
@end example
@end deffn

@geindex shapetransform() (no módulo turtle)
@anchor{library/turtle turtle shapetransform}@anchor{412a}
@deffn {Função} turtle.shapetransform (t11=None, t12=None, t21=None, t22=None)

@*Parâmetros: 

@itemize *

@item 
@code{t11} – um número (opcional)

@item 
@code{t12} – um número (opcional)

@item 
@code{t21} – um número (opcional)

@item 
@code{t12} – um número (opcional)
@end itemize


Define ou retorna a matriz de transformação atual da forma da tartaruga.

Se nenhum dos elementos da matriz for fornecido, retorna a matriz de transformação como uma tupla de 4 elementos. Caso contrário, define os elementos fornecidos e transforma a forma da tartaruga de acordo com a matriz que consiste na primeira linha t11, t12 e na segunda linha t21, t22. O resultado de t11 * t22 - t12 * t21 não deve ser zero, caso contrário será gerado um erro. Modifica stretchfactor, shearfactor e tiltangle de acordo com a matriz fornecida.

@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() (no módulo turtle)
@anchor{library/turtle turtle get_shapepoly}@anchor{412b}
@deffn {Função} turtle.get_shapepoly ()

Retorna o polígono da forma atual como uma tupla de pares de coordenadas. Isto pode ser usado para definir uma nova forma ou componentes de uma forma composta.

@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 Eventos Utilizados,Métodos Especiais da Tartaruga,Estado da tartaruga,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle using-events}@anchor{4164}
@subsubsection Eventos Utilizados



@deffn {Função} turtle.onclick (fun, btn=1, add=None)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – um função com dois argumento que serão chamados com as coordenadas do ponto clicado na tela

@item 
@code{btn} – número do botão do mouse, o padrão é 1 (botão esquerdo do mouse)

@item 
@code{add} – @code{True} ou @code{False} – se @code{True}, uma nova ligação será adicionada; caso contrário, ela substituirá uma ligação antiga
@end itemize


Vincula `fun' a eventos de clique do mouse nessa tartaruga. Se `fun' for @code{None}, as associações existentes serão removidas. Exemplo para a tartaruga anônima, ou seja, a forma processual:

@example
>>> def turn(x, y):
...     left(180)
...
>>> onclick(turn)  # Agora, clicar na tartaruga irá girá-la.
>>> onclick(None)  # a associação de eventos será removida
@end example
@end deffn

@geindex onrelease() (no módulo turtle)
@anchor{library/turtle turtle onrelease}@anchor{412d}
@deffn {Função} turtle.onrelease (fun, btn=1, add=None)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – um função com dois argumento que serão chamados com as coordenadas do ponto clicado na tela

@item 
@code{btn} – número do botão do mouse, o padrão é 1 (botão esquerdo do mouse)

@item 
@code{add} – @code{True} ou @code{False} – se @code{True}, uma nova ligação será adicionada; caso contrário, ela substituirá uma ligação antiga
@end itemize


Vincule `fun' aos eventos de liberação do botão do mouse nesta tartaruga.  Se `fun' for @code{None}, as associações existentes serão removidas.

@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)     # clicar na tartaruga torna o preenchimento vermelho,
>>> turtle.onrelease(turtle.unglow) # .liberar a transforma em transparente
@end example
@end deffn

@geindex ondrag() (no módulo turtle)
@anchor{library/turtle turtle ondrag}@anchor{412e}
@deffn {Função} turtle.ondrag (fun, btn=1, add=None)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – um função com dois argumento que serão chamados com as coordenadas do ponto clicado na tela

@item 
@code{btn} – número do botão do mouse, o padrão é 1 (botão esquerdo do mouse)

@item 
@code{add} – @code{True} ou @code{False} – se @code{True}, uma nova ligação será adicionada; caso contrário, ela substituirá uma ligação antiga
@end itemize


Vincule `fun' a eventos de movimentação do mouse nessa tartaruga.  Se `fun' for @code{None}, as associações existentes serão removidas.

Observação: Cada sequência de eventos de movimento do mouse em uma tartaruga é precedida por um evento de clique do mouse naquela tartaruga.

@example
>>> turtle.ondrag(turtle.goto)
@end example

Posteriormente, clicar e arrastar a Tartaruga a moverá pela tela, produzindo desenhos à mão (se a caneta estiver deitada).
@end deffn

@node Métodos Especiais da Tartaruga,Formas compostas,Eventos Utilizados,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle special-turtle-methods}@anchor{4165}
@subsubsection Métodos Especiais da Tartaruga


@geindex begin_poly() (no módulo turtle)
@anchor{library/turtle turtle begin_poly}@anchor{412f}
@deffn {Função} turtle.begin_poly ()

Começa a registrar os vértices de um polígono.  A posição atual da tartaruga é o primeiro vértice do polígono.
@end deffn

@geindex end_poly() (no módulo turtle)
@anchor{library/turtle turtle end_poly}@anchor{4130}
@deffn {Função} turtle.end_poly ()

Para de registrar os vértices de um polígono. A posição atual da tartaruga é o último vértice do polígono. Isto será conectado ao primeiro vértice.
@end deffn

@geindex get_poly() (no módulo turtle)
@anchor{library/turtle turtle get_poly}@anchor{4131}
@deffn {Função} turtle.get_poly ()

Retorna o último polígono registrado.

@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() (no módulo turtle)
@anchor{library/turtle turtle clone}@anchor{4132}
@deffn {Função} turtle.clone ()

Cria e retorna um clone da tartaruga com a mesma posição, direção e propriedades da tartaruga original.

@example
>>> mick = Turtle()
>>> joe = mick.clone()
@end example
@end deffn

@geindex getturtle() (no módulo turtle)
@geindex getpen() (no módulo turtle)
@anchor{library/turtle turtle getturtle}@anchor{4133}
@deffn {Função} turtle.getturtle ()
@anchor{library/turtle turtle getpen}@anchor{4134}
@deffnx {Função} turtle.getpen ()

Retorna o próprio objeto Turtle. Uso recomendado: como função para retornar a “tartaruga anônima”:

@example
>>> pet = getturtle()
>>> pet.fd(50)
>>> pet
<turtle.Turtle object at 0x...>
@end example
@end deffn

@geindex getscreen() (no módulo turtle)
@anchor{library/turtle turtle getscreen}@anchor{4135}
@deffn {Função} turtle.getscreen ()

Retorna o objeto @ref{4166,,TurtleScreen} no qual a tartaruga está sendo desenhada. Os métodos de TurtleScreen podem então ser chamados para este objeto.

@example
>>> ts = turtle.getscreen()
>>> ts
<turtle._Screen object at 0x...>
>>> ts.bgcolor("pink")
@end example
@end deffn

@geindex setundobuffer() (no módulo turtle)
@anchor{library/turtle turtle setundobuffer}@anchor{4136}
@deffn {Função} turtle.setundobuffer (size)

@*Parâmetros: 
@code{size} – um inteiro ou @code{None}


Define ou desativa o undobuffer.  Se `size' for um inteiro, um undobuffer vazio de determinado tamanho será instalado.  `size' fornece o número máximo de ações da tartaruga que podem ser desfeitas pelo método/função @ref{4101,,undo()} . Se `size' for @code{None}, o undobuffer será desativado.

@example
>>> turtle.setundobuffer(42)
@end example
@end deffn

@geindex undobufferentries() (no módulo turtle)
@anchor{library/turtle turtle undobufferentries}@anchor{4137}
@deffn {Função} turtle.undobufferentries ()

Retorna o número de entradas no undobuffer.

@example
>>> while undobufferentries():
...     undo()
@end example
@end deffn

@node Formas compostas,,Métodos Especiais da Tartaruga,Métodos de RawTurtle/Turtle e funções correspondentes
@anchor{library/turtle compound-shapes}@anchor{4167}@anchor{library/turtle compoundshapes}@anchor{4168}
@subsubsection Formas compostas


Para usar formas de tartaruga compostas, que consistem em vários polígonos de cores diferentes, você deve usar a classe auxiliar @ref{4169,,Shape} explicitamente, conforme descrito abaixo:


@enumerate 

@item 
Crie um objeto Shape vazio do tipo “compound”.

@item 
Adicione quantos componentes desejar a esse objeto, usando o método @ref{416a,,addcomponent()}.

Por exemplo:

@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 
Agora, adicione o Shape à lista de formas da tela e use-o:

@example
>>> register_shape("myshape", s)
>>> shape("myshape")
@end example
@end enumerate

@cartouche
@quotation Nota 
A classe @ref{4169,,Shape} é usada internamente pelo método @ref{414e,,register_shape()} de diferentes maneiras.  O programador da aplicação precisa lidar com a classe Shape `somente' ao usar formas compostas como as mostradas acima!
@end quotation
@end cartouche

@node métodos do TurtleScreen/Screen e as funções correspondentes,Classes Públicas,Métodos de RawTurtle/Turtle e funções correspondentes,turtle — Gráficos tartaruga
@anchor{library/turtle methods-of-turtlescreen-screen-and-corresponding-functions}@anchor{416b}
@subsubsection métodos do TurtleScreen/Screen e as funções correspondentes


A maioria dos exemplos desta seção se refere a uma instância de TurtleScreen chamada @code{screen}.

@c >>> screen = Screen()

@menu
* Controle da Janela:: 
* Controle da animação:: 
* Usando os eventos de tela:: 
* Métodos de entrada:: 
* Configurações e métodos especiais:: 
* Métodos específico do Screen@comma{} estes métodos não são herdados do TurtleScreen: Métodos específico do Screen estes métodos não são herdados do TurtleScreen. 

@end menu

@node Controle da Janela,Controle da animação,,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle window-control}@anchor{416c}
@subsubsection Controle da Janela


@geindex bgcolor() (no módulo turtle)
@anchor{library/turtle turtle bgcolor}@anchor{4139}
@deffn {Função} turtle.bgcolor ()

@deffnx {Função} turtle.bgcolor (color, /)

@deffnx {Função} turtle.bgcolor (r, g, b, /)

Retorna ou define a cor de fundo do TurtleScreen.

São permitidos quatro formatos de entrada:


@table @asis

@item @code{bgcolor()}

Retorna a cor de fundo atual como string de especificação de cor ou como uma tupla (veja o exemplo). Pode ser usado como entrada para outra chamada color/pencolor/fillcolor/bgcolor.

@item @code{bgcolor(colorstring)}

Define a cor de fundo como `colorstring', que é uma string de especificação de cor Tk, como @code{"red"}, @code{"yellow"} ou @code{"#33cc8c"}.

@item @code{bgcolor((r, g, b))}

Define a cor de fundo como a cor RGB representada pela tupla `r', `g', e `b'. Os valores de `r', `g', and `b' precisam estar na faixa 0..colormode, onde colormode é 1.0 ou 255 (ver @ref{414b,,colormode()}).

@item @code{bgcolor(r, g, b)}

Define a cor de fundo como a cor RGB representada por `r', `g', e `b'. Os valores de `r', `g', and `b' precisam estar na faixa 0..colormode.
@end table

@example
>>> screen.bgcolor("orange")
>>> screen.bgcolor()
'orange'
>>> screen.bgcolor("#800080")
>>> screen.bgcolor()
(128.0, 0.0, 128.0)
@end example
@end deffn

@geindex bgpic() (no módulo turtle)
@anchor{library/turtle turtle bgpic}@anchor{413a}
@deffn {Função} turtle.bgpic (picname=None)

@*Parâmetros: 
@code{picname} – um string, um nome de um arquivo gif ou @code{"nopic"}, ou @code{None}


Configura a imagem de fundo ou retorna nome da imagem de fundo atual. Se `picname' for um nome de arquivo, definirá a imagem correspondente como plano de fundo. Se `picname' for @code{"nopic"}, exclui a imagem de fundo, caso haja. Se `picname' for @code{None}, retorna o nome do arquivo da imagem de fundo atual:

@example
>>> screen.bgpic()
'nopic'
>>> screen.bgpic("landscape.gif")
>>> screen.bgpic()
"landscape.gif"
@end example
@end deffn


@deffn {Função} turtle.clear ()

@cartouche
@quotation Nota 
Este método de TurtleScreen está disponível como uma função global somente sob o nome @code{clearscreen}. A função global @code{clear} é derivada de forma diferente do método de Turtle @code{clear} .
@end quotation
@end cartouche
@end deffn

@geindex clearscreen() (no módulo turtle)
@anchor{library/turtle turtle clearscreen}@anchor{413b}
@deffn {Função} turtle.clearscreen ()

Remove todos os desenhos e todas as tartarugas da TurtleScreen. Redefine a TurtleScreen, agora vazia, para seu estado inicial: fundo branco, sem imagem de fundo, sem vínculos de eventos e rastreamento ativado.
@end deffn


@deffn {Função} turtle.reset ()

@cartouche
@quotation Nota 
Este método de TurtleScreen está disponível como uma função global somente com o nome @code{resetscreen}. A função global @code{reset} é outra derivada do método de Turtle @code{reset} .
@end quotation
@end cartouche
@end deffn

@geindex resetscreen() (no módulo turtle)
@anchor{library/turtle turtle resetscreen}@anchor{413c}
@deffn {Função} turtle.resetscreen ()

Reinicia todas as Turtles em Screen para seu estado inicial.
@end deffn

@geindex screensize() (no módulo turtle)
@anchor{library/turtle turtle screensize}@anchor{413d}
@deffn {Função} turtle.screensize (canvwidth=None, canvheight=None, bg=None)

@*Parâmetros: 

@itemize *

@item 
@code{canvwidth} – positivo inteiro, a nova largura da tela em pixels

@item 
@code{canvheight} – positivo inteiro, a nova altura da tela em pixels

@item 
@code{bg} – Uma string com a cor ou uma tupla, a nova cor de fundo
@end itemize


Se nenhum argumento for fornecido, retorna o atual (canvaswidth, canvasheight). Caso contrário, redimensiona a tela em que as tartarugas estão desenhadas. Não altera a janela de desenho. Para observar as partes ocultas da tela, use as barras de rolagem. Com este método, é possível tornar visíveis as partes de um desenho que antes estavam fora da tela.

@example
>>> screen.screensize()
(400, 300)
>>> screen.screensize(2000,1500)
>>> screen.screensize()
(2000, 1500)
@end example

Por exemplo, para procurar uma tartaruga que escapou por engano ;-)
@end deffn

@geindex setworldcoordinates() (no módulo turtle)
@anchor{library/turtle turtle setworldcoordinates}@anchor{413e}
@deffn {Função} turtle.setworldcoordinates (llx, lly, urx, ury)

@*Parâmetros: 

@itemize *

@item 
@code{llx} – um número representando a coordenada x do canto inferior esquerdo da tela

@item 
@code{lly} – um número representando a coordenada y do canto inferior esquerdo da tela

@item 
@code{urx} – um número representando a coordenada x do canto superior direito da tela

@item 
@code{ury} – um número representando a coordenada y do canto superior direito da tela
@end itemize


Configura o sistema de coordenadas definido pelo usuário e muda para o modo “world”, se necessário. Isso executa um @code{screen.reset()}. Se o modo “world” já estiver ativo, todos os desenhos atuais serão redesenhados de acordo com as novas coordenadas.

`ATENÇÃO': em sistemas de coordenadas definidos pelo usuário, os ângulos podem aparecer distorcidos.

@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 Controle da animação,Usando os eventos de tela,Controle da Janela,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle animation-control}@anchor{416d}
@subsubsection Controle da animação


@geindex delay() (no módulo turtle)
@anchor{library/turtle turtle delay}@anchor{413f}
@deffn {Função} turtle.delay (delay=None)

@*Parâmetros: 
@code{delay} – um número inteiro positivo


Define ou retorna o `delay' do desenho em milissegundos.  (Esse é aproximadamente o intervalo de tempo entre duas atualizações consecutivas da tela). Quanto maior o atraso do desenho, mais lenta será a animação.

Argumentos opcionais:

@example
>>> screen.delay()
10
>>> screen.delay(5)
>>> screen.delay()
5
@end example
@end deffn

@geindex tracer() (no módulo turtle)
@anchor{library/turtle turtle tracer}@anchor{4140}
@deffn {Função} turtle.tracer (n=None, delay=None)

@*Parâmetros: 

@itemize *

@item 
@code{n} – inteiro não-negativo

@item 
@code{delay} – inteiro não-negativo
@end itemize


Ative ou desative a animação da tartaruga e defina o atraso para atualização dos desenhos. Se `n' for fornecido, apenas cada n-ésima atualização regular da tela será realmente executada. (Pode ser usado para acelerar o desenho de gráficos complexos.) Quando chamado sem argumentos, retorna o valor atualmente armazenado de n. O segundo argumento define o valor do atraso (consulte @ref{413f,,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() (no módulo turtle)
@anchor{library/turtle turtle update}@anchor{4141}
@deffn {Função} turtle.update ()

Executa uma atualização do TurtleScreen. Para ser usado quando o rastreador estiver desligado.
@end deffn

Veja também o método RawTurtle/Turtle @ref{4102,,speed()}.

@node Usando os eventos de tela,Métodos de entrada,Controle da animação,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle using-screen-events}@anchor{416e}
@subsubsection Usando os eventos de tela


@geindex listen() (no módulo turtle)
@anchor{library/turtle turtle listen}@anchor{4142}
@deffn {Função} turtle.listen (xdummy=None, ydummy=None)

Define o foco no TurtleScreen (para coletar eventos-chave). Argumentos fictícios são fornecidos para que seja possível passar @ref{4142,,listen()} para o método onclick.
@end deffn

@geindex onkey() (no módulo turtle)
@geindex onkeyrelease() (no módulo turtle)
@anchor{library/turtle turtle onkey}@anchor{4143}
@deffn {Função} turtle.onkey (fun, key)
@anchor{library/turtle turtle onkeyrelease}@anchor{4144}
@deffnx {Função} turtle.onkeyrelease (fun, key)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – uma função sem argumentos ou @code{None}

@item 
@code{key} – uma string: uma tecla (por exemplo, “a”) ou o nome de uma tecla (por exemplo, “space”)
@end itemize


Vincula `fun' ao evento de liberação da tecla. Se `fun' for @code{None}, as ligações de eventos serão removidas. Observação: para poder registrar eventos-chave, o TurtleScreen deve ter o foco. (Veja o método @ref{4142,,listen()}.)

@example
>>> def f():
...     fd(50)
...     lt(60)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onkeypress() (no módulo turtle)
@anchor{library/turtle turtle onkeypress}@anchor{4145}
@deffn {Função} turtle.onkeypress (fun, key=None)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – uma função sem argumentos ou @code{None}

@item 
@code{key} – uma string: uma tecla (por exemplo, “a”) ou o nome de uma tecla (por exemplo, “space”)
@end itemize


Vincula `fun' ao evento de pressionamento de tecla se a tecla for fornecida, ou a qualquer evento de pressionamento de tecla se nenhuma tecla for fornecida. Observação: para poder registrar eventos-chave, o TurtleScreen deve ter foco. (Veja o método @ref{4142,,listen()}.)

@example
>>> def f():
...     fd(50)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onclick() (no módulo turtle)
@geindex onscreenclick() (no módulo turtle)
@anchor{library/turtle turtle onclick}@anchor{412c}
@deffn {Função} turtle.onclick (fun, btn=1, add=None)
@anchor{library/turtle turtle onscreenclick}@anchor{4146}
@deffnx {Função} turtle.onscreenclick (fun, btn=1, add=None)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – um função com dois argumento que serão chamados com as coordenadas do ponto clicado na tela

@item 
@code{btn} – número do botão do mouse, o padrão é 1 (botão esquerdo do mouse)

@item 
@code{add} – @code{True} ou @code{False} – se @code{True}, uma nova ligação será adicionada; caso contrário, ela substituirá uma ligação antiga
@end itemize


Vincula `fun' a eventos de clique do mouse na tela.  Se `fun' for @code{None}, as associações existentes serão removidas.

Exemplo de uma instância de TurtleScreen chamada @code{screen} e uma instância de Turtle chamada @code{turtle}:

@example
>>> screen.onclick(turtle.goto) # Em seguida, clicar no TurtleScreen
>>>                             # fará a tartaruga se mover até o ponto clicado.
>>> screen.onclick(None)        # remove associação de evento novamente
@end example

@cartouche
@quotation Nota 
Este método TurtleScreen está disponível como uma função global somente com o nome @code{onscreenclick}. A função global @code{onclick} é outra derivada do método de Turtle @code{onclick} .
@end quotation
@end cartouche
@end deffn

@geindex ontimer() (no módulo turtle)
@anchor{library/turtle turtle ontimer}@anchor{4147}
@deffn {Função} turtle.ontimer (fun, t=0)

@*Parâmetros: 

@itemize *

@item 
@code{fun} – um função sem nenhum argumento

@item 
@code{t} – um número >= 0
@end itemize


Instala um cronômetro que chama `fun' após `t' milissegundos.

@example
>>> running = True
>>> def f():
...     if running:
...         fd(50)
...         lt(60)
...         screen.ontimer(f, 250)
>>> f()   ### faz a tartaruga marchar
>>> running = False
@end example
@end deffn

@geindex mainloop() (no módulo turtle)
@geindex done() (no módulo turtle)
@anchor{library/turtle turtle mainloop}@anchor{4148}
@deffn {Função} turtle.mainloop ()
@anchor{library/turtle turtle done}@anchor{4149}
@deffnx {Função} turtle.done ()

Inicia o loop de eventos - chamando a função principal do loop do Tkinter. Deve ser a última instrução em um programa gráfico de tartaruga. `Não' deve ser usado se um script for executado no IDLE no modo -n (sem subprocesso) - para uso interativo de gráficos de tartaruga.

@example
>>> screen.mainloop()
@end example
@end deffn

@node Métodos de entrada,Configurações e métodos especiais,Usando os eventos de tela,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle input-methods}@anchor{416f}
@subsubsection Métodos de entrada


@geindex textinput() (no módulo turtle)
@anchor{library/turtle turtle textinput}@anchor{1a06}
@deffn {Função} turtle.textinput (title, prompt)

@*Parâmetros: 

@itemize *

@item 
@code{title} – string

@item 
@code{prompt} – string
@end itemize


Abre uma janela de diálogo para a entrada de uma string. O parâmetro `title' é o título da janela de diálogo, prompt é um texto que descreve as informações a serem inseridas. Se a caixa de diálogo for preenchida, retorna a string que foi informada. Se a caixa de diálogo for cancelada, retorna @code{None}.

@example
>>> screen.textinput("NIM", "Name of first player:")
@end example
@end deffn

@geindex numinput() (no módulo turtle)
@anchor{library/turtle turtle numinput}@anchor{1a07}
@deffn {Função} turtle.numinput (title, prompt, default=None, minval=None, maxval=None)

@*Parâmetros: 

@itemize *

@item 
@code{title} – string

@item 
@code{prompt} – string

@item 
@code{default} – número (opcional)

@item 
@code{minval} – número (opcional)

@item 
@code{maxval} – número (opcional)
@end itemize


Abre uma janela de diálogo para a entrada de um número. O parâmetro `title' é o título da janela de diálogo, prompt é um texto que descreve principalmente quais informações numéricas devem ser inseridas. default: valor padrão , minval: mínimo valor para entrada, maxval: máximo valor para entrada. O número inserido deve estar no intervalo minval .. maxval, se este for fornecido. Caso contrário, será emitida uma dica e a caixa de diálogo permanecerá aberta para correção. Se a caixa de diálogo for preenchida, retorna o número informado. Se a caixa de diálogo for cancelada, retorna @code{None}.

@example
>>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)
@end example
@end deffn

@node Configurações e métodos especiais,Métodos específico do Screen estes métodos não são herdados do TurtleScreen,Métodos de entrada,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle settings-and-special-methods}@anchor{4170}
@subsubsection Configurações e métodos especiais


@geindex mode() (no módulo turtle)
@anchor{library/turtle turtle mode}@anchor{414a}
@deffn {Função} turtle.mode (mode=None)

@*Parâmetros: 
@code{mode} – uma das strings “standard”, “logo” ou “world”


Define o modo da tartaruga (“padrão”, “logotipo” ou “mundo”) e redefine a posição.  Se o modo não for fornecido, o modo atual será retornado.

O modo “standard” é compatível com o antigo @ref{101,,turtle}.  O modo “logo” é compatível com a maioria dos gráficos de tartaruga. O modo “world” usa “coordenadas mundiais” definidas pelo usuário. `Atenção': nesse modo, os ângulos aparecem distorcidos se a proporção de @code{x/y} não for igual a 1.


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

Modo

@tab

Título inicial da tartaruga

@tab

ângulos positivos

@item

“standard”

@tab

para a direita (east)

@tab

counterclockwise

@item

“logo”

@tab

upward (north)

@tab

sentido horário

@end multitable


@example
>>> mode("logo")   # resets turtle heading to north
>>> mode()
'logo'
@end example
@end deffn

@geindex colormode() (no módulo turtle)
@anchor{library/turtle turtle colormode}@anchor{414b}
@deffn {Função} turtle.colormode (cmode=None)

@*Parâmetros: 
@code{cmode} – um dos valores 1.0 ou 255


Retorna o modo de cor ou defini-lo como 1,0 ou 255.  Posteriormente, os valores `r', `g', `b' das triplas de cores devem estar no limite 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() (no módulo turtle)
@anchor{library/turtle turtle getcanvas}@anchor{414c}
@deffn {Função} turtle.getcanvas ()

Retorna a tela desse TurtleScreen.  Útil para pessoas que sabem o que fazer com uma tela do Tkinter.

@example
>>> cv = screen.getcanvas()
>>> cv
<turtle.ScrolledCanvas object ...>
@end example
@end deffn

@geindex getshapes() (no módulo turtle)
@anchor{library/turtle turtle getshapes}@anchor{414d}
@deffn {Função} turtle.getshapes ()

Retorna uma lista dos nomes de todas as formas de tartarugas disponíveis no momento.

@example
>>> screen.getshapes()
['arrow', 'blank', 'circle', ..., 'turtle']
@end example
@end deffn

@geindex register_shape() (no módulo turtle)
@geindex addshape() (no módulo turtle)
@anchor{library/turtle turtle register_shape}@anchor{414e}
@deffn {Função} turtle.register_shape (name, shape=None)
@anchor{library/turtle turtle addshape}@anchor{414f}
@deffnx {Função} turtle.addshape (name, shape=None)

Há três maneiras diferentes de chamar essa função:


@enumerate 

@item 
`name' é o nome de um arquivo gif e `shape' é @code{None}: Instala a forma de imagem correspondente:

@example
>>> screen.register_shape("turtle.gif")
@end example

@cartouche
@quotation Nota 
As formas de imagem `não' giram ao girar a tartaruga, portanto, elas não exibem o rumo da tartaruga!
@end quotation
@end cartouche

@item 
`name' é uma string arbitrária e `shape' é um tupla de pares de coordenadas: Instala a forma de polígono correspondente.

@example
>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))
@end example

@item 
`name' é uma string arbitrária e `shape' é um objeto (composto) @ref{4169,,Shape}: Instala a forma composta correspondente.
@end enumerate

Adiciona uma forma de tartaruga à lista de formas do TurtleScreen. Somente as formas registradas dessa forma podem ser usadas com o comando @code{shape(shapename)} .
@end deffn

@geindex turtles() (no módulo turtle)
@anchor{library/turtle turtle turtles}@anchor{4150}
@deffn {Função} turtle.turtles ()

Retorne uma lista de tartarugas na tela.

@example
>>> for turtle in screen.turtles():
...     turtle.color("red")
@end example
@end deffn

@geindex window_height() (no módulo turtle)
@anchor{library/turtle turtle window_height}@anchor{4151}
@deffn {Função} turtle.window_height ()

Retorna a altura da janela da tartaruga.

@example
>>> screen.window_height()
480
@end example
@end deffn

@geindex window_width() (no módulo turtle)
@anchor{library/turtle turtle window_width}@anchor{4152}
@deffn {Função} turtle.window_width ()

Retorna a largura da janela da tartaruga.

@example
>>> screen.window_width()
640
@end example
@end deffn

@node Métodos específico do Screen estes métodos não são herdados do TurtleScreen,,Configurações e métodos especiais,métodos do TurtleScreen/Screen e as funções correspondentes
@anchor{library/turtle methods-specific-to-screen-not-inherited-from-turtlescreen}@anchor{4171}@anchor{library/turtle screenspecific}@anchor{4172}
@subsubsection Métodos específico do Screen, estes métodos não são herdados do TurtleScreen


@geindex bye() (no módulo turtle)
@anchor{library/turtle turtle bye}@anchor{4153}
@deffn {Função} turtle.bye ()

Fecha a janela do gráficos de tartaruga.
@end deffn

@geindex exitonclick() (no módulo turtle)
@anchor{library/turtle turtle exitonclick}@anchor{4154}
@deffn {Função} turtle.exitonclick ()

Vincula o método @code{bye()} aos cliques do mouse na tela.

Se o valor “using_IDLE” na configuração dicionário for @code{False} (valor padrão), entra também no loop principal. Observação: Se IDLE for executado com a chave @code{-n} (sem subprocesso), esse valor deverá ser definido como @code{True} em @code{turtle.cfg}. Nesse caso, o loop principal do próprio IDLE também estará ativo para o script do cliente.
@end deffn

@geindex setup() (no módulo turtle)
@anchor{library/turtle turtle setup}@anchor{4155}
@deffn {Função} turtle.setup (width=_CFG['width'], height=_CFG['height'], startx=_CFG['leftright'], starty=_CFG['topbottom'])

Define o tamanho e a posição da janela principal. Os valores padrões dos argumentos são armazenados na configuração dicionário e podem ser alterados por meio de um arquivo @code{turtle.cfg}.

@*Parâmetros: 

@itemize *

@item 
@code{width} – se for um inteiro, o tamanho em pixels; se for um float, uma fração da tela; o padrão é 50% da tela

@item 
@code{height} – se for um inteiro, a altura em pixels; se for um float, uma fração da tela; o padrão é 75% da tela

@item 
@code{startx} – se positivo, este parâmetro define a posição inicial em pixels a partir da borda esquerda da tela; se negativo, define a partir da borda direita; se @code{None}, centraliza a janela horizontalmente

@item 
@code{starty} – se positivo, este parâmetro define a posição inicial, em pixels, a partir da borda superior da tela; se negativo, define a partir da borda inferior; se for @code{None}, centraliza a janela verticalmente
@end itemize


@example
>>> screen.setup (width=200, height=200, startx=0, starty=0)
>>>              # define a janela para 200x200 pixels, no canto superior esquerdo da tela
>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
>>>              # define a janela para 75% da tela por 50% da tela e centraliza
@end example
@end deffn

@geindex title() (no módulo turtle)
@anchor{library/turtle turtle title}@anchor{4156}
@deffn {Função} turtle.title (titlestring)

@*Parâmetros: 
@code{titlestring} – uma string que é exibida na barra de título da janela de gráficos da tartaruga


Define o título da janela da tartaruga como `titlestring'.

@example
>>> screen.title("Welcome to the turtle zoo!")
@end example
@end deffn

@node Classes Públicas,Explicação<2>,métodos do TurtleScreen/Screen e as funções correspondentes,turtle — Gráficos tartaruga
@anchor{library/turtle public-classes}@anchor{4173}
@subsubsection Classes Públicas


@geindex RawTurtle (classe em turtle)
@geindex RawPen (classe em turtle)
@anchor{library/turtle turtle RawTurtle}@anchor{4174}
@deffn {Classe} turtle.RawTurtle (canvas)
@anchor{library/turtle turtle RawPen}@anchor{4175}
@deffnx {Classe} turtle.RawPen (canvas)

@*Parâmetros: 
@code{canvas} – um @code{tkinter.Canvas}, um @ref{4176,,ScrolledCanvas} ou um @ref{4166,,TurtleScreen}


Cria uma tartaruga.  A tartaruga tem todos os métodos descritos acima como “métodos de Turtle/RawTurtle”.
@end deffn

@geindex Turtle (classe em turtle)
@anchor{library/turtle turtle Turtle}@anchor{4177}
@deffn {Classe} turtle.Turtle

Subclasse do RawTurtle, tem a mesma interface, mas desenha em um objeto padrão @ref{40e9,,Screen}, que é criado automaticamente, quando necessário, pela primeira vez.
@end deffn

@geindex TurtleScreen (classe em turtle)
@anchor{library/turtle turtle TurtleScreen}@anchor{4166}
@deffn {Classe} turtle.TurtleScreen (cv)

@*Parâmetros: 
@code{cv} – uma @code{tkinter.Canvas}


Fornece métodos orientado para a tela, como @ref{4139,,bgcolor()} etc., que são descritos acima.
@end deffn

@geindex Screen (classe em turtle)
@anchor{library/turtle turtle Screen}@anchor{40e9}
@deffn {Classe} turtle.Screen

Subclasse do TurtleScreen, com @ref{4172,,quatro métodos adicionados}.
@end deffn

@geindex ScrolledCanvas (classe em turtle)
@anchor{library/turtle turtle ScrolledCanvas}@anchor{4176}
@deffn {Classe} turtle.ScrolledCanvas (master)

@*Parâmetros: 
@code{master} – algum widget do Tkinter para conter o ScrolledCanvas. Exemplo: um Tkinter-canvas com barras de rolagem adicionadas


Usado pela classe Screen, que, portanto, fornece automaticamente um ScrolledCanvas como playground para as tartarugas.
@end deffn

@geindex Shape (classe em turtle)
@anchor{library/turtle turtle Shape}@anchor{4169}
@deffn {Classe} turtle.Shape (type_, data)

@*Parâmetros: 
@code{type_} – uma das strings “polygon”, “image”, “compound”


Estrutura de dados para modelar a forma.  O par @code{(type_, data)} deve seguir essa especificação:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`type_'

@tab

`data'

@item

“polygon”

@tab

Uma tupla com o par de coordenadas do polígono

@item

“image”

@tab

uma imagem (nesse formato, usada apenas internamente!)

@item

“compound”

@tab

@code{None} (uma forma composta deve ser construída usando o método @ref{416a,,addcomponent()})

@end multitable


@geindex addcomponent() (método turtle.Shape)
@anchor{library/turtle turtle Shape addcomponent}@anchor{416a}
@deffn {Método} addcomponent (poly, fill, outline=None)

@*Parâmetros: 

@itemize *

@item 
@code{poly} – um polígono, ou seja, um tupla de pares de números

@item 
@code{fill} – uma cor com a qual o `poly' será preenchido

@item 
@code{outline} – uma cor para o contorno do polígono (se fornecido)
@end itemize


Exemplo:

@example
>>> poly = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s = Shape("compound")
>>> s.addcomponent(poly, "red", "blue")
>>> # ... adicione mais componentes e então use register_shape()
@end example

Veja @ref{4168,,Formas compostas}.
@end deffn
@end deffn

@geindex Vec2D (classe em turtle)
@anchor{library/turtle turtle Vec2D}@anchor{4159}
@deffn {Classe} turtle.Vec2D (x, y)

Uma classe de vetor bidimensional, usada como classe auxiliar para implementar gráficos de tartaruga. Pode ser útil também para programas de gráficos de tartaruga.  Derivado de uma tupla, portanto, um vetor é um tupla!

Fornece (para vetores `a', `b', número `k'):


@itemize *

@item 
@code{a + b} vetor adicional

@item 
@code{a - b} subtração de vetor

@item 
@code{a * b} produto interno

@item 
@code{k * a} e @code{a * k} multiplicação com escalar

@item 
@code{abs(a)} valor absoluto de um

@item 
rotação @code{a.rotate(angle)}
@end itemize
@end deffn

@node Explicação<2>,Ajuda e Configuração,Classes Públicas,turtle — Gráficos tartaruga
@anchor{library/turtle explanation}@anchor{4178}@anchor{library/turtle turtle-explanation}@anchor{40e8}
@subsubsection Explicação


Um objeto tartaruga é baseado em um objeto canvas, e há uma série de classes principais na interface orientada a objetos da tartaruga que podem ser usadas para criá-los e relacioná-los entre si.

Uma instância da classe @ref{4177,,Turtle} cria automaticamente uma nova instância de @ref{40e9,,Screen}, caso esta não esteja presente.

@code{Turtle} é um subclasse de @ref{4174,,RawTurtle}, que `não' cria automaticamente uma superfície de desenho - uma `tela' precisará ser fornecida ou criada para ele. A `tela' pode ser uma @code{tkinter.Canvas}, @ref{4176,,ScrolledCanvas} ou @ref{4166,,TurtleScreen}.

@ref{4166,,TurtleScreen} é a superfície de desenho básica para uma tartaruga. @ref{40e9,,Screen} é uma subclasse de @code{TurtleScreen} e inclui @ref{4172,,alguns métodos adicionais} para gerenciar sua aparência (incluindo tamanho e título) e comportamento. O construtor @code{TurtleScreen} precisa de um @code{tkinter.Canvas} ou um @ref{4176,,ScrolledCanvas} como um argumento.

A interface funcional para gráficos de tartaruga usa os vários métodos de @code{Turtle} e @code{TurtleScreen}/@code{Screen}. Nos bastidores, um objeto de tela é criado automaticamente sempre que um função derivada de um método de @code{Screen} é chamado. Da mesma forma, um objeto de tartaruga é criado automaticamente sempre que qualquer uma das funções derivadas de um método de tartaruga é chamado.

Para usar várias tartarugas em uma tela, a interface orientada a objetos deve ser usada.

@node Ajuda e Configuração,turtledemo — Scripts de Demonstração,Explicação<2>,turtle — Gráficos tartaruga
@anchor{library/turtle help-and-configuration}@anchor{4179}
@subsubsection Ajuda e Configuração


@menu
* Como usar a Ajuda:: 
* Tradução de docstrings em diferentes idiomas:: 
* Como configurar Screen and Turtles:: 

@end menu

@node Como usar a Ajuda,Tradução de docstrings em diferentes idiomas,,Ajuda e Configuração
@anchor{library/turtle how-to-use-help}@anchor{417a}
@subsubsection Como usar a Ajuda


Os métodos públicos das classes Screen e Turtle estão amplamente documentado por meio de docstrings. Eles podem ser usados como ajuda on-line por meio dos recursos de ajuda do Python:


@itemize -

@item 
Ao usar o IDLE, as dicas de ferramentas mostram as assinaturas e as primeiras linhas das docstrings das chamadas de função/método digitadas.

@item 
Chamar @ref{8dd,,help()} em métodos ou funções exibe o seguinte docstring:

@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 
Os docstrings de funções que são derivados do métodos têm um formato diferente:

@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

Esses docstrings modificados são criados automaticamente junto com as definições de função que são derivadas de métodos ao importar.

@node Tradução de docstrings em diferentes idiomas,Como configurar Screen and Turtles,Como usar a Ajuda,Ajuda e Configuração
@anchor{library/turtle translation-of-docstrings-into-different-languages}@anchor{417b}
@subsubsection Tradução de docstrings em diferentes idiomas


Há um utilitário para criar a dicionário cujas chaves são os nomes de método e cujos valores são os docstrings dos métodos públicos das classes Screen e Turtle.

@geindex write_docstringdict() (no módulo turtle)
@anchor{library/turtle turtle write_docstringdict}@anchor{417c}
@deffn {Função} turtle.write_docstringdict (filename='turtle_docstringdict')

@*Parâmetros: 
@code{filename} – uma string, usado como nome de arquivo


Cria e escreve um dicionário de docstring em um script Python com o nome de arquivo fornecido. Esta função deve ser chamada explicitamente (ela não é usada pelas classes gráficas da tartaruga). O dicionário docstring será gravado no script Python @code{`filename'.py}. O objetivo é servir como modelo para traduzir os documentos para diferentes idiomas.
@end deffn

Se você (ou seus alunos) quiserem usar o @ref{101,,turtle} com a ajuda on-line em seu idioma nativo, será necessário traduzir os docstrings e salvar o arquivo resultante como, por exemplo, @code{turtle_docstringdict_german.py}.

Se você tiver uma entrada específica em seu arquivo @code{turtle.cfg}, esse dicionário será lido no momento do importar e substituirá as documentações originais em inglês.

No momento da redação deste texto, há docstring dicionários em alemão e italiano. (Pedidos devem ser enviados para @email{glingl@@aon.at}.)

@node Como configurar Screen and Turtles,,Tradução de docstrings em diferentes idiomas,Ajuda e Configuração
@anchor{library/turtle how-to-configure-screen-and-turtles}@anchor{417d}
@subsubsection Como configurar Screen and Turtles


A configuração padrão integrada imita a aparência e o comportamento do antigo módulo Turtle para manter a melhor compatibilidade possível com ele.

Se quiser usar uma configuração diferente que reflita melhor o recurso deste módulo ou que se adapte melhor às suas necessidades, por exemplo, para uso em uma sala de aula, você pode criar um arquivo de configuração @code{turtle.cfg} que será lido no momento de importar e modifica a configuração de acordo com suas definições.

A configuração que definida no arquivo @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 explicação das entradas selecionadas:


@itemize -

@item 
As quatro primeiras linhas correspondem aos argumentos do método @ref{4155,,Screen.setup}.

@item 
As linhas 5 e 6 correspondem a argumento do método @ref{413d,,Screen.screensize}.

@item 
`shape' pode ser qualquer uma das formas pré-definidas, como por exemplo: seta, tartaruga, etc. Para obter mais informações, consulte @code{help(shape)}.

@item 
Se você não quiser usar nenhuma cor de preenchimento (ou seja, tornar a tartaruga transparente), você deve usar @code{fillcolor = ""} (todas as strings não vazias não devem ter aspas no arquivo cfg).

@item 
Se você quiser refletir o estado da tartaruga, você deve usar @code{resizemode = auto}.

@item 
Se você definir, por exemplo, @code{language = italian}, o docstringdict @code{turtle_docstringdict_italian.py} será carregado ao importar (se estiver presente no caminho de importação, por exemplo, no mesmo diretório que @ref{101,,turtle}).

@item 
As entradas `exampleturtle' e `examplescreen' definem os nomes desses objetos conforme ocorrem nas docstrings. A transformação de “método-docstrings” para “função-docstrings” excluirá esses nomes dos docstrings.

@item 
`using_IDLE': Defina isso como @code{True} se você trabalha regularmente com IDLE e sua chave @code{-n} (“sem subprocesso”). Isso impedirá que o @ref{4154,,exitonclick()} entre no loop principal.
@end itemize

Pode haver um arquivo @code{turtle.cfg} no diretório em que o @ref{101,,turtle} está armazenado e um arquivo adicional no diretório de trabalho atual. O arquivo armazenado no diretório de trabalho atual tem preferência e vai substituir as configurações do primeiro.

O diretório @code{Lib/turtledemo} contém um arquivo chamado @code{turtle.cfg}.  Você pode usá-lo como um exemplo e ver seus efeitos ao executar as demonstrações (de preferência, não utilize visualizador de demonstrações).

@node turtledemo — Scripts de Demonstração,Modificações desde a versão do Python 2 6,Ajuda e Configuração,turtle — Gráficos tartaruga
@anchor{library/turtle module-turtledemo}@anchor{102}@anchor{library/turtle turtledemo-demo-scripts}@anchor{417e}
@subsubsection @code{turtledemo} — Scripts de Demonstração


@geindex module; turtledemo

O pacote @ref{102,,turtledemo} inclui um conjunto de scripts de demonstração.  Esses scripts podem ser executados e visualizados usando o visualizador de demonstração fornecido da seguinte forma:

@example
python -m turtledemo
@end example

Como alternativa, você pode executar os scripts de demonstração individualmente.  Por exemplo,

@example
python -m turtledemo.bytedesign
@end example

O diretório do pacote @ref{102,,turtledemo} contém:


@itemize -

@item 
Um arquivo de exemplo @code{__main__.py} que pode ser usado para visualizar o código-fonte dos scripts e executá-los ao mesmo tempo.

@item 
Vários scripts que demonstram diferentes recursos do módulo @ref{101,,turtle}.  Os exemplos podem ser acessados no menu Exemplos. Eles também podem ser executados de forma isolada.

@item 
Um arquivo @code{turtle.cfg} que serve como exemplo de como escrever e usar esse tipo de arquivos.
@end itemize

Os scripts de demonstração são:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Descrição

@tab

Recursos

@item

@code{bytedesign}

@tab

Padrão de gráficos de tartaruga clássico complexo

@tab

@ref{4140,,tracer()}, @ref{413f,,delay()},
@ref{4141,,update()}

@item

@code{chaos}

@tab

gráficos do modelo de Verhulst, mostram que os cálculos do computador podem gerar resultados às vezes contra as expectativas do bom senso

@tab

coordenadas mundiais

@item

@code{clock}

@tab

Relógio analógico que mostra o horário do seu computador

@tab

tartarugas como ponteiros de relógio, @ref{4147,,ontimer()}

@item

@code{colormixer}

@tab

experimento com r, g, b

@tab

@ref{412e,,ondrag()}

@item

@code{forest}

@tab

3 breadth-first trees

@tab

randomização

@item

@code{fractalcurves}

@tab

Curvas de Hilbert & Koch

@tab

recursão

@item

@code{lindenmayer}

@tab

ethnomathematics
(indian kolams)

@tab

L-System

@item

@code{minimal_hanoi}

@tab

Torres de Hanoi

@tab

Tartarugas retângulos como discos de Hanói (@ref{4124,,shape()}, @ref{4126,,shapesize()})

@item

@code{nim}

@tab

jogue o clássico jogo nim com três montes de gravetos contra o computador.

@tab

tartarugas como gravetos, acionadas por eventos (mouse, teclado)

@item

@code{paint}

@tab

programa de desenho super minimalista

@tab

@ref{412c,,onclick()}

@item

@code{peace}

@tab

elementar

@tab

tartaruga: aparência e animação

@item

@code{penrose}

@tab

ladrilhos irregulares com pipas e dardos

@tab

@ref{40fe,,stamp()}

@item

@code{planet_and_moon}

@tab

simulação de um sistema gravitacional

@tab

formas compostas, @ref{4159,,Vec2D}

@item

@code{rosette}

@tab

um padrão do artigo Wikipédia sobre gráficos de tartaruga

@tab

@ref{4132,,clone()},
@ref{4101,,undo()}

@item

@code{round_dance}

@tab

tartarugas dançantes girando em pares na direção oposta

@tab

formas compostas, @ref{4132,,clone()} @ref{4126,,shapesize()}, @ref{4129,,tilt()}, @ref{412b,,get_shapepoly()}, @ref{4141,,update()}

@item

@code{sorting_animate}

@tab

demonstração visual de diferentes tipos de métodos de ordenação

@tab

alinhamento simples, randomização

@item

@code{tree}

@tab

uma árvore (gráfica) da largura inicial (usando geradores)

@tab

@ref{4132,,clone()}

@item

@code{two_canvases}

@tab

desenho simples

@tab

tartarugas em duas telas

@item

@code{yinyang}

@tab

outro exemplo elementar

@tab

@ref{40fc,,circle()}

@end multitable


Divirta-se!

@node Modificações desde a versão do Python 2 6,Modificações desde a versão do Python 3 0,turtledemo — Scripts de Demonstração,turtle — Gráficos tartaruga
@anchor{library/turtle changes-since-python-2-6}@anchor{417f}
@subsubsection Modificações desde a versão do Python 2.6



@itemize -

@item 
O métodos @ref{4140,,Turtle.tracer}, @ref{4152,,Turtle.window_width} e @ref{4151,,Turtle.window_height} foram removidos. O métodos com esses nomes e funcionalidades agora estão disponíveis apenas como métodos da classe @ref{40e9,,Screen}. As funções derivadas desses métodos continuam disponíveis. (No Python 2.6 esses métodos eram duplicações dos métodos correspondentes das classes @ref{4166,,TurtleScreen}/@ref{40e9,,Screen}).

@item 
O método @code{Turtle.fill()} foi eliminado. O comportamento de @ref{411a,,begin_fill()} e @ref{411b,,end_fill()} foi ligeiramente alterado: agora, todo processo de preenchimento deve ser concluído com uma chamada para @code{end_fill()}.

@item 
Um método @ref{4119,,Turtle.filling} foi adicionado. Ela retorna um valor booleano: @code{True} se um processo de preenchimento estiver em andamento, @code{False} caso contrário. Esse comportamento corresponde a uma chamada @code{fill()} sem argumento em Python 2.6.
@end itemize

@node Modificações desde a versão do Python 3 0,,Modificações desde a versão do Python 2 6,turtle — Gráficos tartaruga
@anchor{library/turtle changes-since-python-3-0}@anchor{4180}
@subsubsection Modificações desde a versão do Python 3.0



@itemize -

@item 
Foram adicionados a class  @ref{4177,,Turtle} os métodos @ref{4128,,shearfactor()} , @ref{412a,,shapetransform()} e @ref{412b,,get_shapepoly()}. Assim, o limite completo de transformações lineares regulares está agora disponível para transformar as formas de tartarugas. O @ref{725,,tiltangle()} foi melhorado em termos de funcionalidade: agora pode ser usado para obter ou definir o ângulo de inclinação.

@item 
Na classe @ref{40e9,,Screen}, o método @ref{4145,,onkeypress()} foi adicionado como um complemento ao @ref{4143,,onkey()}. Como esse último vincula ações ao liberar uma tecla pressionada, um apelido: @ref{4144,,onkeyrelease()} também foi adicionado a ele.

@item 
O método @ref{4148,,Screen.mainloop} foi adicionado. Não é mais necessário utilizar a função @ref{4148,,mainloop()} quando estiver trabalhando com os objetos @ref{40e9,,Screen} e @ref{4177,,Turtle}.

@item 
Dois novos métodos para informar dados foram adicionados: @ref{1a06,,Screen.textinput} e @ref{1a07,,Screen.numinput}. Estes métodos abrem caixas de diálogo para digitação e retornam strings e números, respectivamente.

@item 
Dois scripts de exemplo @code{tdemo_nim.py} e @code{tdemo_round_dance.py} foram adicionados ao diretório @code{Lib/turtledemo}.
@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()))

@c Other sections I have in mind are
@c Tkinter internals
@c Freezing Tkinter applications

@node Ferramentas de Desenvolvimento,Depuração e perfilamento,Interfaces gráficas de usuário com Tk,A Biblioteca Padrão do Python
@anchor{library/development doc}@anchor{4181}@anchor{library/development development}@anchor{4182}@anchor{library/development development-tools}@anchor{4183}@anchor{library/development translation-repo}@anchor{4184}
@section Ferramentas de Desenvolvimento


Os módulos descritos neste capítulo ajudam você a escrever softwares. Por exemplo, o módulo @ref{b5,,pydoc} recebe um módulo e gera documentação com base no conteúdo do módulo. Os módulos @ref{3a,,doctest} e @ref{106,,unittest} contêm frameworks para escrever testes unitários que automaticamente exercitam código e verificam se a saída esperada é produzida.

A lista de módulos descritos neste capítulo é:

@menu
* typing — Suporte para dicas de tipo:: 
* pydoc — Gerador de documentação e sistema de ajuda online:: 
* Modo de Desenvolvimento do Python:: 
* doctest — Teste exemplos interativos de Python:: 
* unittest — Framework de testes unitários:: 
* unittest.mock — mock object library: unittest mock — mock object library. 
* unittest.mock — primeiros passos: unittest mock — primeiros passos. 
* test — Pacote de Testes de Regressão do Python:: 
* test.support — Utilitários para o conjunto de teste do Python: test support — Utilitários para o conjunto de teste do Python. 
* test.support.socket_helper — Utilities for socket tests: test support socket_helper — Utilities for socket tests. 
* test.support.script_helper — Utilities for the Python execution tests: test support script_helper — Utilities for the Python execution tests. 
* test.support.bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode: test support bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode. 
* test.support.threading_helper — Utilities for threading tests: test support threading_helper — Utilities for threading tests. 
* test.support.os_helper — Utilities for os tests: test support os_helper — Utilities for os tests. 
* test.support.import_helper — Utilities for import tests: test support import_helper — Utilities for import tests. 
* test.support.warnings_helper — Utilities for warnings tests: test support warnings_helper — Utilities for warnings tests. 

@end menu

@node typing — Suporte para dicas de tipo,pydoc — Gerador de documentação e sistema de ajuda online,,Ferramentas de Desenvolvimento
@anchor{library/typing doc}@anchor{4185}@anchor{library/typing typing-support-for-type-hints}@anchor{4186}
@subsection @code{typing} — Suporte para dicas de tipo


@c import typing
@c from dataclasses import dataclass
@c from typing import *

@geindex module; typing
@anchor{library/typing module-typing}@anchor{104}

Adicionado na versão 3.5.


`Código-fonte:' Lib/typing.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/typing.py}

@cartouche
@quotation Nota 
O ambiente de execução do Python não força anotações de tipos de variáveis e funções. Elas podem ser usadas por ferramentas de terceiros como @ref{26d,,verificadores de tipo}, IDEs, linters, etc.
@end quotation
@end cartouche


__________________________________________________________________


Este módulo fornece suporte em tempo de execução para dicas de tipo.

Considere a função abaixo:

@example
def surface_area_of_cube(edge_length: float) -> str:
    return f"A área superficial de um cubo é @{6 * edge_length ** 2@}."
@end example

A função @code{surface_area_of_cube} recebe um argumento que se espera ser uma instância de @ref{2f7,,float}, conforme indicado pela @ref{210d,,dica de tipo} @code{edge_length: float}. Espera-se que a função retorne uma instância de @ref{44c,,str}, conforme indicado pela dica @code{-> str}.

Embora as dicas de tipo possam ser classes simples como @ref{2f7,,float} ou @ref{44c,,str}, elas também podem ser mais complexas. O módulo @ref{104,,typing} fornece um vocabulário de dicas de tipo mais avançadas.

Novos recursos são frequentemente adicionados ao módulo @code{typing}. O pacote typing_extensions@footnote{https://pypi.org/project/typing_extensions/} fornece backports desses novos recursos para versões mais antigas do Python.


@subsubheading Ver também



@table @asis

@item Folha de dicas sobre tipagem@footnote{https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html}

Uma visão geral das dicas de tipo (hospedado por mypy docs, em inglês).

@item Seção de referência do sistema de tipos da documentação do mypy@footnote{https://mypy.readthedocs.io/en/stable/index.html}

O sistema de tipagem do Python é padronizado pelas PEPs, portanto esta  referência deve se aplicar a maioria do verificadores de tipo do Python. (Alguns trechos podem se referir especificamente ao mypy. Documento em inglês).

@item Static Typing with Python@footnote{https://typing.python.org/en/latest/}

Documentação independente de verificador de tipo escrita pela comunidade, detalhando os recursos do sistema de tipo, ferramentas úteis de tipagem e melhores práticas.
@end table


@menu
* Especificação para o sistema de tipos do Python:: 
* Apelidos de tipo:: 
* NewType:: 
* Anotações de objetos chamáveis:: 
* Genéricos:: 
* Anotando tuplas:: 
* O tipo de objetos de classe:: 
* Anotando geradores e corrotinas:: 
* Tipos genéricos definidos pelo usuário:: 
* O tipo Any:: 
* Subtipagem nominal vs estrutural:: 
* Conteúdo do módulo: Conteúdo do módulo<7>. 
* Cronograma de descontinuação dos principais recursos:: 

@end menu

@node Especificação para o sistema de tipos do Python,Apelidos de tipo,,typing — Suporte para dicas de tipo
@anchor{library/typing relevant-peps}@anchor{4187}@anchor{library/typing specification-for-the-python-type-system}@anchor{4188}
@subsubsection Especificação para o sistema de tipos do Python


A especificação canônica e atualizada do sistema de tipos Python pode ser encontrada em Specification for the Python type system@footnote{https://typing.python.org/en/latest/spec/index.html}.

@node Apelidos de tipo,NewType,Especificação para o sistema de tipos do Python,typing — Suporte para dicas de tipo
@anchor{library/typing id2}@anchor{4189}@anchor{library/typing type-aliases}@anchor{454}
@subsubsection Apelidos de tipo


Um apelido de tipo é definido utilizando a instrução @ref{438,,type}, que por sua vez cria uma instância da classe @ref{455,,TypeAliasType}. Neste exemplo, @code{Vector} e @code{list[float]} serão tratados de maneira equivalente pelos verificadores de tipo estático:

@example
type Vector = list[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# passa na verificação de tipos; uma lista de floats é qualificada como Vector.
new_vector = scale(2.0, [1.0, -4.2, 5.4])
@end example

Apelidos de tipo são úteis para simplificar assinaturas de tipo complexas. Por exemplo:

@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:
    ...

# O verificador de tipo tratará a assinatura de tipo anterior
# como exatamente equivalente à assinatura abaixo.
def broadcast_message(
    message: str,
    servers: Sequence[tuple[tuple[str, int], dict[str, str]]]
) -> None:
    ...
@end example

A instrução @ref{438,,type} é nova no Python 3.12. Para manter retrocompatibilidade, apelidos de tipo também podem ser criados usando atribuição:

@example
Vector = list[float]
@end example

Ou marcado com @ref{7ca,,TypeAlias} para tornar explícito que se trata de um apelido de tipo e não uma atribuição de variável comum:

@example
from typing import TypeAlias

Vector: TypeAlias = list[float]
@end example

@node NewType,Anotações de objetos chamáveis,Apelidos de tipo,typing — Suporte para dicas de tipo
@anchor{library/typing distinct}@anchor{418a}@anchor{library/typing newtype}@anchor{418b}
@subsubsection NewType


Utilize o auxiliar @ref{d16,,NewType} para criar tipos únicos:

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

O verificador de tipo estático tratará o novo tipo como se fosse uma subclasse do tipo original. Isso é útil para ajudar a encontrar erros de lógica:

@example
def get_user_name(user_id: UserId) -> str:
    ...

# passa na verificação de tipo
user_a = get_user_name(UserId(42351))

# falha na verificação de tipo: um int não é um UserId
user_b = get_user_name(-1)
@end example

Você ainda pode executar todas as operações @code{int} em uma variável do tipo @code{UserId}, mas o resultado sempre será do tipo @code{int}. Isso permite que você passe um @code{UserId} em qualquer ocasião que @code{int} possa ser esperado, mas previne que você acidentalmente crie um @code{UserId} de uma forma inválida:

@example
# 'output' é do tipo 'int', em vez de 'UserId'
output = UserId(23413) + UserId(54341)
@end example

Note que essas verificações são aplicadas apenas pelo verificador de tipo estático. Em tempo de execução, a instrução @code{Derived = NewType('Derived', Base)} irá tornar @code{Derived} um chamável que retornará imediatamente qualquer parâmetro que você passar. Isso significa que a expressão @code{Derived(some_value)} não cria uma nova classe ou introduz sobrecarga além de uma chamada regular de função.instrução

Mais precisamente, a expressão @code{some_value is Derived(some_value)} é sempre verdadeira em tempo de execução.

É inválido criar um subtipo de @code{Derived}:

@example
from typing import NewType

UserId = NewType('UserId', int)

# Falha em tempo de execução e não passa na verificação de tipos
class AdminUserId(UserId): pass
@end example

No entanto, é possível criar um @ref{d16,,NewType} baseado em um ‘derivado’ @code{NewType}:

@example
from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)
@end example

e a verificação de tipos para @code{ProUserId} funcionará como esperado.

Veja 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para mais detalhes.

@cartouche
@quotation Nota 
Lembre-se que o uso de um apelido de tipo declara que dois tipos serão `equivalentes' entre si. Efetuar @code{type Alias = Original} fará o verificador de tipo estático tratar @code{Alias} como sendo `exatamente equivalente' a @code{Original} em todos os casos. Isso é útil quando você deseja simplificar assinaturas de tipo complexas.

Em contraste, @code{NewType} declara que um tipo será `subtipo' de outro. Efetuando @code{Derived = NewType('Derived', Original)} irá fazer o verificador de tipo estático tratar @code{Derived} como uma `subclasse' de @code{Original}, o que significa que um valor do tipo @code{Original} não pode ser utilizado onde um valor do tipo @code{Derived} é esperado. Isso é útil quando você deseja evitar erros de lógica com custo mínimo de tempo de execução.
@end quotation
@end cartouche


Adicionado na versão 3.5.2.



Alterado na versão 3.10: @code{NewType} agora é uma classe em vez de uma função. Consequentemente, existem alguns custos em tempo de execução ao chamar @code{NewType} em vez de uma função comum.



Alterado na versão 3.11: O desempenho de chamar @code{NewType} voltou ao mesmo nível da versão Python 3.9.


@node Anotações de objetos chamáveis,Genéricos,NewType,typing — Suporte para dicas de tipo
@anchor{library/typing annotating-callable-objects}@anchor{418c}@anchor{library/typing annotating-callables}@anchor{2404}
@subsubsection Anotações de objetos chamáveis


Funções – ou outros objetos @ref{2aaf,,chamáveis} – podem ser anotados com @ref{7ec,,collections.abc.Callable} ou com o tipo descontinuado @ref{7c6,,typing.Callable}. @code{Callable[[int], str]} expressa uma função que recebe um único parâmetro de tipo @ref{257,,int} e retorna uma @ref{44c,,str}.

Por exemplo:

@example
from collections.abc import Callable, Awaitable

def feeder(get_next_item: Callable[[], str]) -> None:
    ...  # Corpo

def async_query(on_success: Callable[[int], None],
                on_error: Callable[[int, Exception], None]) -> None:
    ...  # Corpo

async def on_update(value: str) -> None:
    ...  # Corpo

callback: Callable[[str], Awaitable[None]] = on_update
@end example

@geindex ...;literal de reticências

A sintaxe de subscrição deve sempre ser usada com exatamente dois valores: a lista de argumentos e o tipo de retorno. A lista de argumentos deve ser uma lista de tipos, uma @ref{15e,,ParamSpec}, @ref{7c5,,Concatenate} ou reticências (@code{...}). O tipo de retorno deve ser um tipo único.

Se uma reticências literal @code{...} é passada no lugar de uma lista de argumentos, ela indica que um chamável com uma lista de qualquer parâmetro arbitrário seria aceita.

@example
def concat(x: str, y: str) -> str:
    return x + y

x: Callable[..., str]
x = str     # OK
x = concat  # OK também
@end example

@code{Callable} não pode representar assinaturas complexas, como funções que aceitam um número variado de argumentos, @ref{418d,,funções sobrecarregadas}, or funções que recebem apenas parâmetros somente-nomeados. No entanto, essas assinaturas podem ser expressas ao se definir uma  @ref{264,,Protocol} com um método @ref{558,,__call__()}:

@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)   # Erro! Argumento 2 tem tipo incompatível por ter
                         # nome e tipo diferente do callback
@end example

Chamáveis que recebem outros chamáveis como argumentos podem indicar que seus tipos de parâmetro dependem uns dos outros usando @ref{15e,,ParamSpec}. Além disso, se esse chamável adiciona ou remove argumentos de outros chamáveis, o operador @ref{7c5,,Concatenate} pode ser usado.  Eles assumem a forma de @code{Callable[ParamSpecVariable, ReturnType]} e @code{Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]}, respectivamente.


Alterado na versão 3.10: @code{Callable} agora oferece suporte a @ref{15e,,ParamSpec} e @ref{7c5,,Concatenate}. Veja 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para mais detalhes.



@subsubheading Ver também


A documentação para @ref{15e,,ParamSpec} e @ref{7c5,,Concatenate} contém exemplos de uso em @code{Callable}.


@node Genéricos,Anotando tuplas,Anotações de objetos chamáveis,typing — Suporte para dicas de tipo
@anchor{library/typing generics}@anchor{210b}@anchor{library/typing id3}@anchor{418e}
@subsubsection Genéricos


Como a informação de tipo sobre objetos mantidos em contêineres não pode ser inferida estaticamente de uma maneira genérica, muitas classes de contêineres na biblioteca padrão permitem usar subscrição para denotar o tipo esperado dos elementos dos contêineres.

@example
from collections.abc import Mapping, Sequence

class Employee: ...

# Sequence[Employee] indica que todos os elementos na sequência
# devem ser instâncias de "Employee".
# Mapping[str, str] indica que todas as chaves e valores no mapeamento
# devem ser strings.
def notify_by_email(employees: Sequence[Employee],
                    overrides: Mapping[str, str]) -> None: ...
@end example

Funções e classes genéricas podem ser parametrizadas utilizando a @ref{2b3,,sintaxe de parâmetro de tipos}:

@example
from collections.abc import Sequence

def first[T](l: Sequence[T]) -> T:  # Função é genérica sobre TypeVar "T"
    return l[0]
@end example

Ou utilizando a fábrica @ref{15d,,TypeVar} diretamente:

@example
from collections.abc import Sequence
from typing import TypeVar

U = TypeVar('U')                  # Declara tipo variável "U"

def second(l: Sequence[U]) -> U:  # Função é genérica sobre a TypeVar "U"
    return l[1]
@end example


Alterado na versão 3.12: O suporte sintático para genéricos é novo no Python 3.12.


@node Anotando tuplas,O tipo de objetos de classe,Genéricos,typing — Suporte para dicas de tipo
@anchor{library/typing annotating-tuples}@anchor{2405}@anchor{library/typing id4}@anchor{418f}
@subsubsection Anotando tuplas


Para a maior parte dos tipos contêineres em Python, o sistema de tipagem presume que todos os elementos do contêiner são do mesmo tipo. Por exemplo:

@example
from collections.abc import Mapping

# Verificador de tipos irá inferir que todos os elementos em `@w{`}x`@w{`} devem ser ints
x: list[int] = []

# Erro no verificador: `@w{`}list`@w{`} aceita um único tipo de argumento
y: list[int, str] = [1, 'foo']

# Verificador de tipos irá inferir que todas as chaves em `@w{`}z`@w{`} devem ser strings,
# e todos os valores em `@w{`}z`@w{`} devem ser strings ou ints
z: Mapping[str, str | int] = @{@}
@end example

@ref{611,,list} aceita apenas um tipo de argumento, e assim o verificador de tipos emitirá um erro na atribuição @code{y} acima. Da mesma forma, @ref{8d0,,Mapping} aceita apenas dois tipos de argumento: O primeiro indica o tipo das chaves, e o segundo indica o tipo dos valores.

Ao contrário da maioria dos outros contêineres Python, é comum no código Python idiomático que as tuplas tenham elementos que não sejam todos do mesmo tipo. Por esse motivo, as tuplas têm um caso especial no sistema de tipagem do Python. @ref{370,,tuple} aceita `qualquer quantidade' de argumentos de tipo:

@example
# OK: `@w{`}x`@w{`} foi atribuída a uma tupla de comprimento 1, onde o único elemento é um int
x: tuple[int] = (5,)

# OK: `@w{`}y`@w{`} foi atribuída a uma tupla de comprimento 2;
# o elemento 1 é um int, o elemento 2 é uma str
y: tuple[int, str] = (5, "foo")

# Erro: a anotação de tipo indica uma tupla de comprimento 1,
# mas `@w{`}z`@w{`} foi atribuída a uma tupla de comprimento 3
z: tuple[int] = (1, 2, 3)
@end example

@geindex ...;literal de reticências

Para denotar uma tupla que pode ter `qualquer' comprimento e na qual todos os elementos são do mesmo tipo @code{T}, use a literal de reticências @code{...}: @code{tuple[T, ...]}. Para denotar uma tupla vazia, use @code{tuple[()]}. Usar @code{tuple} simples como anotação equivale a usar @code{tuple[Any, ...]}:

@example
x: tuple[int, ...] = (1, 2)
# Essas reatribuições são OK: `@w{`}tuple[int, ...]`@w{`} indica que x pode ter qualquer comprimento
x = (1, 2, 3)
x = ()
# Essa reatribuição é um erro: todos os elementos de `@w{`}x`@w{`} devem ser ints
x = ("foo", "bar")

# `@w{`}y`@w{`} só pode ser atribuída a uma tupla vazia
y: tuple[()] = ()

z: tuple = ("foo", "bar")
# Essas reatribuições são OK: o tipo `@w{`}tuple`@w{`} equivale a `@w{`}tuple[Any, ...]`@w{`}
z = (1, 2, 3)
z = ()
@end example

@node O tipo de objetos de classe,Anotando geradores e corrotinas,Anotando tuplas,typing — Suporte para dicas de tipo
@anchor{library/typing the-type-of-class-objects}@anchor{4190}@anchor{library/typing type-of-class-objects}@anchor{4191}
@subsubsection O tipo de objetos de classe


Uma variável anotada com @code{C} pode aceitar um valor de tipo @code{C}. Por outro lado, uma variável anotada com @code{type[C]} (ou o tipo descontinuado @ref{4192,,typing.Type[C]}) pode aceitar valores que são as próprias classes – mais especificamente, ela aceitará o `objeto classe' de @code{C}. Por exemplo:

@example
a = 3         # Tem tipo `@w{`}int`@w{`}
b = int       # Tem tipo `@w{`}type[int]`@w{`}
c = type(a)   # Também tem tipo `@w{`}type[int]`@w{`}
@end example

Observe que @code{type[C]} é covariante:

@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)   # Também OK: `@w{`}type[ProUser]`@w{`} é subtipo de `@w{`}type[User]`@w{`}
make_new_user(TeamUser)  # Tudo bem
make_new_user(User())    # Erro: esperava-se `@w{`}type[User]`@w{`} mas retornou `@w{`}User`@w{`}
make_new_user(int)       # Erro: `@w{`}type[int]`@w{`} não é subtipo de `@w{`}type[User]`@w{`}
@end example

Os únicos parâmetros válidos para @ref{d6b,,type} são classes, @ref{6ac,,Any}, @ref{210b,,type variables} e uniões de qualquer um desses tipos. Por exemplo:

@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)   # Erro: `@w{`}type[TeamUser]`@w{`} não é subtipo
                              # de `@w{`}type[BasicUser | ProUser]`@w{`}
new_non_team_user(User)       # Também é um erro
@end example

@code{type[Any]} é equivalente a @ref{d6b,,type}, que é a raiz da @ref{2100,,hierarquia de metaclasses} do Python.

@node Anotando geradores e corrotinas,Tipos genéricos definidos pelo usuário,O tipo de objetos de classe,typing — Suporte para dicas de tipo
@anchor{library/typing annotating-generators-and-coroutines}@anchor{26cd}@anchor{library/typing id5}@anchor{4193}
@subsubsection Anotando geradores e corrotinas


Um gerador pode ser anotado usando um tipo genérico @ref{e05,,Generator[YieldType@comma{} SendType@comma{} ReturnType]}. Por exemplo:

@example
def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'
@end example

Note que, diferentemente de outras classes genéricas na biblioteca padrão, o @code{SendType} da classe @ref{e05,,Generator} se comporta contravariantemente, em vez de covariantemente ou invariantemente.

Os parâmetros @code{SendType} e @code{ReturnType} são @code{None} por padrão:

@example
def infinite_stream(start: int) -> Generator[int]:
    while True:
        yield start
        start += 1
@end example

Também é possível definir esses tipos explicitamente:

@example
def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1
@end example

Geradores simples que só produzem valores também podem ser anotados com tipo de retorno @ref{23e2,,Iterable[YieldType]} ou @ref{23e3,,Iterator[YieldType]}:

@example
def infinite_stream(start: int) -> Iterator[int]:
    while True:
        yield start
        start += 1
@end example

Geradores assíncronos são manipulados similarmente, mas não espere um argumento de tipo @code{ReturnType} (@ref{ca8,,AsyncGenerator[YieldType@comma{} SendType]}). O argumento @code{SendType} é @code{None} por padrão, então as seguintes definições são equivalentes:

@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

Como no caso síncrono, @ref{e09,,AsyncIterable[YieldType]} e @ref{e08,,AsyncIterator[YieldType]} também estão disponíveis:

@example
async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)
@end example

Corrotinas podem ser anotadas usando @ref{e07,,Coroutine[YieldType@comma{} SendType@comma{} ReturnType]}. Argumentos genéricos correspondem àqueles da classe @ref{e05,,Generator}, por exemplo:

@example
from collections.abc import Coroutine
c: Coroutine[list[str], str, int]  # Uma corrotina defina em outro lugar
x = c.send('hi')                   # Tipo inferido de 'x' é list[str]
async def bar() -> None:
    y = await c                    # Tipo inferido de 'y' é int
@end example

@node Tipos genéricos definidos pelo usuário,O tipo Any,Anotando geradores e corrotinas,typing — Suporte para dicas de tipo
@anchor{library/typing user-defined-generic-types}@anchor{4194}@anchor{library/typing user-defined-generics}@anchor{4cf}
@subsubsection Tipos genéricos definidos pelo usuário


Uma classe definida pelo usuário pode ser definida como uma classe 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

Esta sintaxe indica que o classe @code{LoggedVar} é parametrizada em torno de uma única  @ref{4195,,type variable} @code{T}. Isso também torna @code{T} válido como um tipo dentro do corpo da classe.

Classes genéricas implicitamente herdar de @ref{15d7,,Generic}. Para compatibilidade com Python 3.11 e versões inferiores, também é possível herdar explicitamente de @ref{15d7,,Generic} para indicar uma classe genérica:

@example
from typing import TypeVar, Generic

T = TypeVar('T')

class LoggedVar(Generic[T]):
    ...
@end example

Classes genéricas têm métodos @ref{73b,,__class_getitem__()}, o que significa que podem ser parametrizadas em tempo de execução (por exemplo, @code{LoggedVar[int]} abaixo):

@example
from collections.abc import Iterable

def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    for var in vars:
        var.set(0)
@end example

Um tipo genérico pode ter qualquer número de tipos de variáveis. Todas as variedades de @ref{15d,,TypeVar} são permitidas como parâmetros para um 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 tipo dos argumentos para @ref{15d7,,Generic} devem ser distintos. Assim, os seguintes exemplos são inválidos:

@example
from typing import TypeVar, Generic
...

class Pair[M, M]:  # SyntaxError
    ...

T = TypeVar('T')

class Pair(Generic[T, T]):   # INVÁLIDO
    ...
@end example

Classes genéricas podem também herdar de outras classes:

@example
from collections.abc import Sized

class LinkedList[T](Sized):
    ...
@end example

Ao herdar das classes genérico, alguns tipos podem ser fixos:

@example
from collections.abc import Mapping

class MyDict[T](Mapping[str, T]):
    ...
@end example

Neste caso @code{MyDict} possui um único parâmetro, @code{T}.

O uso de uma classe genérica sem especificar tipos pressupõe @ref{6ac,,Any} para cada posição. No exemplo a seguir, @code{MyIterable} não é genérico, mas herda implicitamente de @code{Iterable[Any]}:

@example
from collections.abc import Iterable

class MyIterable(Iterable): # Igual a Iterable[Any]
    ...
@end example

Também há suporte para tipos genéricos definidos pelo usuário. Exemplos:

@example
from collections.abc import Iterable

type Response[S] = Iterable[S] | int

# Tipo de retorno aqui é igual a 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: # Igual a Iterable[tuple[T, T]]
    return sum(x*y for x, y in v)
@end example

Para manter retrocompatibilidade, os apelidos de tipos genéricos também podem ser criados usando atribuição:

@example
from collections.abc import Iterable
from typing import TypeVar

S = TypeVar("S")
Response = Iterable[S] | int
@end example


Alterado na versão 3.7: @ref{15d7,,Generic} não possui mais uma metaclasse personalizada.



Alterado na versão 3.12: Suporte sintático para apelidos de tipo e genéricos é novo na versão 3.12. Anteriormente, as classes genéricas precisavam explicitamente herdar de @ref{15d7,,Generic} ou conter um tipo de variável em uma de suas bases.


Genéricos definidos pelo usuário para expressões de parâmetros também oferecem suporte por meio de variáveis de especificação de parâmetros no formato @code{[**P]}. O comportamento é consistente com as variáveis de tipo descritas acima, pois as variáveis de especificação de parâmetro são tratadas pelo módulo @code{typing} como uma variável de tipo especializada. A única exceção a isso é que uma lista de tipos pode ser usada para substituir um @ref{15e,,ParamSpec}:

@example
>>> class Z[T, **P]: ...  # T é um TypeVar; P é um ParamSpec
...
>>> Z[int, [dict, float]]
__main__.Z[int, [dict, float]]
@end example

Classes genéricas sobre um @ref{15e,,ParamSpec} também podem ser criadas usando herança explícita de @ref{15d7,,Generic}. Neste caso, @code{**} não é usado:

@example
from typing import ParamSpec, Generic

P = ParamSpec('P')

class Z(Generic[P]):
    ...
@end example

Outra diferença entre @ref{15d,,TypeVar} e @ref{15e,,ParamSpec} é que um genérico com apenas uma variável de especificação de parâmetro aceitará listas de parâmetros nos formatos @code{X[[Type1, Type2, ...]]} e também @code{X[Type1, Type2, ...]} por razões estéticas. Internamente, o último é convertido no primeiro, portanto são equivalentes:

@example
>>> class X[**P]: ...
...
>>> X[int, str]
__main__.X[[int, str]]
>>> X[[int, str]]
__main__.X[[int, str]]
@end example

Observe que genéricos com @ref{15e,,ParamSpec} podem não ter @code{__parameters__} corretos após a substituição em alguns casos porque eles são destinados principalmente à verificação de tipo estático.


Alterado na versão 3.10: @ref{15d7,,Generic} agora pode ser parametrizado através de expressões de parâmetros. Veja @ref{15e,,ParamSpec} e 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para mais detalhes.


Uma classe genérica definida pelo usuário pode ter ABCs como classes base sem conflito de metaclasse. Não há suporte a metaclasses genéricas. O resultado da parametrização de genéricos é armazenado em cache, e a maioria dos tipos no módulo @code{typing} são @ref{610,,hasheáveis} e comparáveis em termos de igualdade.

@node O tipo Any,Subtipagem nominal vs estrutural,Tipos genéricos definidos pelo usuário,typing — Suporte para dicas de tipo
@anchor{library/typing the-any-type}@anchor{4196}
@subsubsection O tipo @code{Any}


Um tipo especial de tipo é @ref{6ac,,Any}. Um verificador de tipo estático tratará cada tipo como sendo compatível com @ref{6ac,,Any} e @ref{6ac,,Any} como sendo compatível com todos os tipos.

Isso significa que é possível realizar qualquer operação ou chamada de método sobre um valor do tipo @ref{6ac,,Any} e atribuí-lo a qualquer variável:

@example
from typing import Any

a: Any = None
a = []          # OK
a = 2           # OK

s: str = '@w{'}
s = a           # OK

def foo(item: Any) -> int:
    # Passa na verificação de tipos; 'item' pode ser qualquer tipo,
    # e esse tipo pode ter um método 'bar'
    item.bar()
    ...
@end example

Observe que nenhuma verificação de tipo é realizada ao atribuir um valor do tipo @ref{6ac,,Any} a um tipo mais preciso. Por exemplo, o verificador de tipo estático não relatou um erro ao atribuir @code{a} a @code{s} mesmo que @code{s} tenha sido declarado como sendo do tipo @ref{44c,,str} e receba um valor @ref{257,,int} em tempo de execução!

Além disso, todas as funções sem um tipo de retorno ou tipos de parâmetro terão como padrão implicitamente o uso de @ref{6ac,,Any}:

@example
def legacy_parser(text):
    ...
    return data

# Um verificador de tipo estático tratará a função acima
# como tendo a mesma assinatura da função abaixo:
def legacy_parser(text: Any) -> Any:
    ...
    return data
@end example

Este comportamento permite que @ref{6ac,,Any} seja usado como uma `saída de emergência' quando você precisar misturar código tipado dinamicamente e estaticamente.

Compare o comportamento de @ref{6ac,,Any} com o comportamento de @ref{a96,,object}. Semelhante a @ref{6ac,,Any}, todo tipo é um subtipo de @ref{a96,,object}. No entanto, ao contrário de @ref{6ac,,Any}, o inverso não é verdadeiro: @ref{a96,,object} `não' é um subtipo de qualquer outro tipo.

Isso significa que quando o tipo de um valor é @ref{a96,,object}, um verificador de tipo rejeitará quase todas as operações nele, e atribuí-lo a uma variável (ou usá-la como valor de retorno) de um tipo mais especializado é um tipo erro. Por exemplo:

@example
def hash_a(item: object) -> int:
    # Falha na verificação de tipo; um 'object' não tem um método 'magic'.
    item.magic()
    ...

def hash_b(item: Any) -> int:
    # Passa na verificação de tipo
    item.magic()
    ...

# Passa na verificação de tipo, já que ints e strs são subclasses de 'object'
hash_a(42)
hash_a("foo")

# Passa na verificação de tipo, já que Any é compatível com todos os tipos
hash_b(42)
hash_b("foo")
@end example

Use @ref{a96,,object} para indicar que um valor pode ser de qualquer tipo de maneira segura. Use @ref{6ac,,Any} para indicar que um valor é tipado dinamicamente.

@node Subtipagem nominal vs estrutural,Conteúdo do módulo<7>,O tipo Any,typing — Suporte para dicas de tipo
@anchor{library/typing nominal-vs-structural-subtyping}@anchor{4197}
@subsubsection Subtipagem nominal vs estrutural


Inicialmente a 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} definiu o sistema de tipos estáticos do Python como usando `subtipagem nominal'. Isto significa que uma classe @code{A} é permitida onde uma classe @code{B} é esperada se e somente se @code{A} for uma subclasse de @code{B}.

Este requisito anteriormente também se aplicava a classes base abstratas, como @ref{23e2,,Iterable}. O problema com essa abordagem é que uma classe teve que ser marcada explicitamente para suportá-los, o que não é pythônico e diferente do que normalmente seria feito em código Python de tipo dinamicamente idiomático. Por exemplo, isso está em conformidade com 
@geindex Propostas de Melhorias do Python; 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

@geindex Propostas de Melhorias do Python; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} permite resolver este problema permitindo que os usuários escrevam o código acima sem classes base explícitas na definição de classe, permitindo que @code{Bucket} seja implicitamente considerado um subtipo de @code{Sized} e @code{Iterable[int]} por verificador de tipo estático. Isso é conhecido como `subtipagem estrutural' (ou tipagem pato estática):

@example
from collections.abc import Iterator, Iterable

class Bucket:  # Nota: sem classes base
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket())  # Passa na verificação de tipo
@end example

Além disso, ao criar uma subclasse de uma classe especial @ref{264,,Protocol}, um usuário pode definir novos protocolos personalizados para aproveitar ao máximo a subtipagem estrutural (veja exemplos abaixo).

@node Conteúdo do módulo<7>,Cronograma de descontinuação dos principais recursos,Subtipagem nominal vs estrutural,typing — Suporte para dicas de tipo
@anchor{library/typing module-contents}@anchor{4198}
@subsubsection Conteúdo do módulo


O módulo @code{typing} define as seguintes classes, funções e decoracores.

@menu
* Tipos primitivos especiais:: 
* Protocolos: Protocolos<3>. 
* ABCs para trabalhar com E/S:: 
* Funções e decoradores:: 
* Auxiliares de introspecção:: 
* Constante:: 
* Apelidos descontinuados:: 

@end menu

@node Tipos primitivos especiais,Protocolos<3>,,Conteúdo do módulo<7>
@anchor{library/typing special-typing-primitives}@anchor{4199}
@subsubsection Tipos primitivos especiais


@menu
* Tipos especiais:: 
* Formas especiais:: 
* Criando tipos genéricos e apelidos de tipo:: 
* Outras diretivas especiais:: 

@end menu

@node Tipos especiais,Formas especiais,,Tipos primitivos especiais
@anchor{library/typing special-types}@anchor{419a}
@subsubsection Tipos especiais


Eles podem ser usados como tipos em anotações. Eles não oferecem suporte a subscrição usando @code{[]}.

@geindex Any (no módulo typing)
@anchor{library/typing typing Any}@anchor{6ac}
@deffn {Dado} typing.Any

Tipo especial que indica um tipo irrestrito.


@itemize *

@item 
Todos os tipos são compatíveis com @ref{6ac,,Any}.

@item 
@ref{6ac,,Any} é compatível com todos os tipos.
@end itemize


Alterado na versão 3.11: @ref{6ac,,Any} agora pode ser usado como classe base. Isso pode ser útil para evitar erros do verificador de tipo com classes que podem digitar em qualquer lugar ou são altamente dinâmicas.

@end deffn

@geindex AnyStr (no módulo typing)
@anchor{library/typing typing AnyStr}@anchor{2b2}
@deffn {Dado} typing.AnyStr

Uma @ref{419b,,tipo variável restrito}.

Definição:

@example
AnyStr = TypeVar('AnyStr', str, bytes)
@end example

@code{AnyStr} deve ser usado para funções que podem aceitar argumentos @ref{44c,,str} ou @ref{1c2,,bytes} mas não podem permitir que os dois se misturem.

Por exemplo:

@example
def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    return a + b

concat("foo", "bar")    # OK: saída tem tipo 'str'
concat(b"foo", b"bar")  # OK: saída tem tipo 'bytes'
concat("foo", b"bar")   # Erro: não se mistura str com bytes
@end example

Note que, apesar do nome, @code{AnyStr} não tem nada a ver com o tipo @ref{6ac,,Any}, nem significa “qualquer string”. Em particular, @code{AnyStr} e @code{str | bytes} são diferentes entre si e têm casos de uso diferentes:

@example
# Uso inválido de AnyStr:
# A variável de tipo é usada somente uma vez na assinatura da função,
# então não pode ser "resolvida" pelo verificador de tipo
def greet_bad(cond: bool) -> AnyStr:
    return "hi there!" if cond else b"greetings!"

# O jeito melhor de anotar esta função
def greet_proper(cond: bool) -> str | bytes:
    return "hi there!" if cond else b"greetings!"
@end example


Descontinuado desde a versão 3.13, será removido na versão 3.18: Descontinuado em favor da nova @ref{2b3,,sintaxe de parâmetro de tipo}. Use @code{class A[T: (str, bytes)]: ...} em vez de importar @code{AnyStr}. Veja a 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} para mais detalhes.

No Python 3.16, @code{AnyStr} será removido de @code{typing.__all__}, e avisos de descontinuação serão emitidos em tempo de execução quando ele for acessado ou importado de @code{typing}. @code{AnyStr} será removido do @code{typing} no Python 3.18.

@end deffn

@geindex LiteralString (no módulo typing)
@anchor{library/typing typing LiteralString}@anchor{5ca}
@deffn {Dado} typing.LiteralString

Tipo especial que inclui apenas strings literais.

Qualquer literal de string é compatível com @code{LiteralString}, assim como outro @code{LiteralString}. Entretanto, um objeto digitado apenas @code{str} não é. Uma string criada pela composição de objetos do tipo @code{LiteralString} também é aceitável como uma @code{LiteralString}.

Exemplo:

@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)  # erro no verificador
    run_query(  # erro no verificador
        f"SELECT * FROM students WHERE name = @{arbitrary_string@}"
    )
@end example

@code{LiteralString} é útil para APIs sensíveis onde strings arbitrárias geradas pelo usuário podem gerar problemas. Por exemplo, os dois casos acima que geram erros no verificador de tipo podem ser vulneráveis a um ataque de injeção de SQL.

Veja 
@geindex Propostas de Melhorias do Python; PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} para mais detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex Never (no módulo typing)
@geindex NoReturn (no módulo typing)
@anchor{library/typing typing Never}@anchor{6a8}
@deffn {Dado} typing.Never
@anchor{library/typing typing NoReturn}@anchor{419c}
@deffnx {Dado} typing.NoReturn

@code{Never} e @code{NoReturn} representam o tipo inferior@footnote{https://en.wikipedia.org/wiki/Bottom_type}, um tipo que não possui membros.

Eles podem ser usados para indicar que uma função nunca retorna, como @ref{138e,,sys.exit()}:

@example
from typing import Never  # ou NoReturn

def stop() -> Never:
    raise RuntimeError('no way')
@end example

Ou para definir uma função que nunca deve ser chamada, pois não existem argumentos válidos, como @ref{6a7,,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)  # erro no verificador
    match arg:
        case int():
            print("It's an int")
        case str():
            print("It's a str")
        case _:
            never_call_me(arg)  # OK, arg é do tipo Never (ou NoReturn)
@end example

@code{Never} e @code{NoReturn} têm o mesmo significado no sistema de tipos e os verificadores de tipo estático tratam ambos de forma equivalente.


Adicionado na versão 3.6.2: Adicionado @ref{419c,,NoReturn}.



Adicionado na versão 3.11: Adicionado @ref{6a8,,Never}.

@end deffn

@geindex Self (no módulo typing)
@anchor{library/typing typing Self}@anchor{5c7}
@deffn {Dado} typing.Self

Tipo especial para representar a classe atual inclusa.

Por exemplo:

@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())  # Tipo revelado é "Foo"
reveal_type(SubclassOfFoo().return_self())  # Tipo revelado é "SubclassOfFoo"
@end example

Esta anotação é semanticamente equivalente à seguinte, embora de forma mais sucinta:

@example
from typing import TypeVar

Self = TypeVar("Self", bound="Foo")

class Foo:
    def return_self(self: Self) -> Self:
        ...
        return self
@end example

Em geral, se algo retorna @code{self}, como nos exemplos acima, você deve usar @code{Self} como anotação de retorno. Se @code{Foo.return_self} foi anotado como retornando @code{"Foo"}, então o verificador de tipo inferiria o objeto retornado de @code{SubclassOfFoo.return_self} como sendo do tipo @code{Foo} em vez de @code{SubclassOfFoo}.

Outros casos de uso comuns incluem:


@itemize -

@item 
@ref{166,,classmethod}s que são usados como construtores alternativos e retornam instâncias do parâmetro @code{cls}.

@item 
Anotando um método @ref{5c8,,__enter__()} que retorna self.
@end itemize

Você não deveria usar @code{Self} como a anotação de retorno se não for garantido que o método retorne uma instância de uma subclasse quando a classe for subclassificada:

@example
class Eggs:
    # Self seria uma anotação de retorno incorreta aqui,
    # já que o objeto retornado sempre é instância de Eggs,
    # inclusive em subclasses
    def returns_eggs(self) -> "Eggs":
        return Eggs()
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} para mais detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex TypeAlias (no módulo typing)
@anchor{library/typing typing TypeAlias}@anchor{7ca}
@deffn {Dado} typing.TypeAlias

Anotações especiais para declarar explicitamente um @ref{454,,apelido de tipo}.

Por exemplo:

@example
from typing import TypeAlias

Factors: TypeAlias = list[int]
@end example

@code{TypeAlias} é particularmente útil em versões mais antigas do Python para anotar apelidos que fazem uso de referências futuras, pois pode ser difícil para os verificadores de tipo distingui-los das atribuições normais de variáveis:

@example
from typing import Generic, TypeAlias, TypeVar

T = TypeVar("T")

# "Box" não existe ainda,
# então temos que usar aspas para a referência futura em Python <3.12.
# Usar `@w{`}TypeAlias`@w{`} diz ao verificador de tipo que isso é uma declaração de apelido de tipo,
# e não uma atribuição de variável a string.
BoxOfStrings: TypeAlias = "Box[str]"

class Box(Generic[T]):
    @@classmethod
    def make_box_of_strings(cls) -> BoxOfStrings: ...
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} para mais detalhes.


Adicionado na versão 3.10.



Descontinuado desde a versão 3.12: @ref{7ca,,TypeAlias} foi descontinuado em favor da instrução @ref{438,,type}, que cria instâncias de @ref{455,,TypeAliasType} e oferece suporte nativo a  referências futuras. Observe que embora @ref{7ca,,TypeAlias} e @ref{455,,TypeAliasType} sirvam propósitos semelhantes e tenham nomes semelhantes, eles são distintos e o último não é o tipo do primeiro. A remoção de @ref{7ca,,TypeAlias} não está planejada atualmente, mas os usuários são encorajados a migrar para instruções @ref{438,,type}.

@end deffn

@node Formas especiais,Criando tipos genéricos e apelidos de tipo,Tipos especiais,Tipos primitivos especiais
@anchor{library/typing special-forms}@anchor{419d}
@subsubsection Formas especiais


Eles podem ser usados como tipos em anotações. Todos eles oferecem suporte a subscrição usando @code{[]}, mas cada um tem uma sintaxe única.

@geindex Union (no módulo typing)
@anchor{library/typing typing Union}@anchor{63b}
@deffn {Dado} typing.Union

Tipo de união;  @code{Union[X, Y]} é equivalente a @code{X | Y} e significa X ou Y.

Para definir uma união, use, por exemplo. @code{Union[int, str]} ou a abreviatura @code{int | str}. Usar essa abreviação é recomendado. Detalhes:


@itemize *

@item 
Os argumentos devem ser tipos e deve haver pelo menos um.

@item 
As uniões de uniões são achatadas, por exemplo:

@example
Union[Union[int, str], float] == Union[int, str, float]
@end example

Entretanto, isso não se aplica a uniões referenciadas por meio de um apelido de tipo, para evitar forçar a avaliação da @ref{455,,TypeAliasType} subjacente:

@example
type A = Union[int, str]
Union[A, float] != Union[int, str, float]
@end example

@item 
As uniões de um único argumento desaparecem, por exemplo:

@example
Union[int] == int  # O construtor retorna um int
@end example

@item 
Argumento redundantes são pulados, e.g.:

@example
Union[int, str, int] == Union[int, str] == int | str
@end example

@item 
Ao comparar uniões, a ordem de argumentos é ignorada. Por exemplo:

@example
Union[int, str] == Union[str, int]
@end example

@item 
Você não pode estender ou instanciar uma @code{Union}

@item 
Você não pode escrever @code{Union[X][Y]}.
@end itemize


Alterado na versão 3.7: Não remova subclasses explícitas de uniões em tempo de execução.



Alterado na versão 3.10: Uniões agora podem ser escritas com @code{X | Y}. Veja @ref{7c3,,expressões de união de tipos}.

@end deffn

@geindex Optional (no módulo typing)
@anchor{library/typing typing Optional}@anchor{6b3}
@deffn {Dado} typing.Optional

@code{Optional[X]} equivale a @code{X | None} (ou @code{Union[X, None]}).

Note que isso não é o mesmo conceito de um argumento opcional, que possui um valor por padrão. Um argumento opcional com padrão não requer o qualificador @code{Optional} em sua anotação de tipo só por ser opcional. Por exemplo:

@example
def foo(arg: int = 0) -> None:
    ...
@end example

Por outro lado, se um valor explícito de @code{None} for permitido, o uso de @code{Optional} é apropriado, seja o argumento opcional ou não. Por exemplo:

@example
def foo(arg: Optional[int] = None) -> None:
    ...
@end example


Alterado na versão 3.10: Optional agora pode ser escrito como @code{X | None}. Veja @ref{7c3,,expressões de união de tipos}.

@end deffn

@geindex Concatenate (no módulo typing)
@anchor{library/typing typing Concatenate}@anchor{7c5}
@deffn {Dado} typing.Concatenate

Forma especial para anotar funções de ordem superior.

@geindex ...;literal de reticências

@code{Concatenate} pode ser usado em conjunção com @ref{2404,,Callable} e @ref{15e,,ParamSpec} para anotar um chamável de maior ordem que adiciona, remove ou transforma parâmetros de outro chamável. Seu uso é feito na forma @code{Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]}, @code{Concatenate} atualmente só é válido quando usado como primeiro argumento de um @ref{2404,,Callable}. O último parâmetro de @code{Concatenate} deve ser um @ref{15e,,ParamSpec} ou reticências (@code{...}).

Por exemplo, para anotar um decorador @code{with_lock} que oferece uma instância de @ref{176d,,threading.Lock} para a função decorada, @code{Concatenate} pode ser usado para indicar que @code{with_lock} espera um chamável cujo primeiro argumento tem tipo @code{Lock}, e retorna um chamável com uma assinatura de tipos diferente. Neste caso, o @ref{15e,,ParamSpec} indica que os tipos dos parâmetros do chamável retornado dependem dos tipos dos parâmetros do chamável de entrada:

@example
from collections.abc import Callable
from threading import Lock
from typing import Concatenate

# Use esta trava para se certificar de que
# uma única thread a executa a qualquer momento.
my_lock = Lock()

def with_lock[**P, R](f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '@w{'}'Um decorador com segurança de tipos que oferece uma trava.'@w{'}'
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        # Oferece a trava como primeiro argumento.
        return f(my_lock, *args, **kwargs)
    return inner

@@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '@w{'}'Somatório de uma lista de números de modo seguro para threads.'@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


Adicionado na versão 3.10.



@subsubheading Ver também



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} – Variáveis de especificação de parâmetro (a PEP que introduz @code{ParamSpec} e @code{Concatenate})

@item 
@ref{15e,,ParamSpec}

@item 
@ref{2404,,Anotações de objetos chamáveis}
@end itemize

@end deffn

@geindex Literal (no módulo typing)
@anchor{library/typing typing Literal}@anchor{858}
@deffn {Dado} typing.Literal

Forma especial de tipagem para definir “tipos literais”.

@code{Literal} pode ser usado para indicar aos verificadores de tipo que o objeto anotado tem valor equivalente a algum dos literais oferecidos.

Por exemplo:

@example
def validate_simple(data: Any) -> Literal[True]:  # sempre retorna True
    ...

type Mode = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: Mode) -> str:
    ...

open_helper('/some/path', 'r')      # Passa verificação de tipos
open_helper('/other/path', 'typo')  # Erro em verificação de tipos
@end example

@code{Literal[...]} não é subclasse. Em tempo de execução, permite-se um valor arbitrário como argumento de tipo para @code{Literal[...]}, mas verificadores de tipo podem impor restrições. Veja 
@geindex Propostas de Melhorias do Python; PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} para mais detalhes sobre tipos literais.

Detalhes adicionais:


@itemize *

@item 
Os argumentos devem ser valores literais e deve haver pelo menos um.

@item 
Tipos @code{Literal} aninhados são achatados, por exemplo:

@example
assert Literal[Literal[1, 2], 3] == Literal[1, 2, 3]
@end example

Entretanto, isso não se aplica a tipos @code{Literal} referenciadas por meio de um apelido de tipo, para evitar forçar a avaliação da @ref{455,,TypeAliasType} subjacente:

@example
type A = Literal[1, 2]
assert Literal[A, 3] != Literal[1, 2, 3]
@end example

@item 
Argumento redundantes são pulados, e.g.:

@example
assert Literal[1, 2, 1] == Literal[1, 2]
@end example

@item 
Ao comparar literais, a ordem de argumentos é ignorada. Por exemplo:

@example
assert Literal[1, 2] == Literal[2, 1]
@end example

@item 
Você não pode estender ou instanciar uma @code{Literal}.

@item 
Você não pode escrever @code{Literal[X][Y]}.
@end itemize


Adicionado na versão 3.8.



Alterado na versão 3.9.1: @code{Literal} agora remove parâmetros duplicados. Comparações de igualdade entre objetos @code{Literal} não dependem da ordem. Objetos @code{Literal} agora levantam uma exceção @ref{2c3,,TypeError} durante comparações de igualdade se um de seus parâmetros não for @ref{610,,hasheável}.

@end deffn

@geindex ClassVar (no módulo typing)
@anchor{library/typing typing ClassVar}@anchor{266}
@deffn {Dado} typing.ClassVar

Uma construção especial de tipagem para marcar variáveis de classe.

Como introduzido na 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, uma variável cuja anotação de tipo tem um invólucro ClassVar indica que um dado atributo deve ser usado como uma variável de classe, e que ele não deve ser definido em instâncias dessa classe. Modo de usar:

@example
class Starship:
    stats: ClassVar[dict[str, int]] = @{@} # variável de classe
    damage: int = 10                     # variável de instância
@end example

@ref{266,,ClassVar} aceita apenas tipos e não pode ser subscrita posteriormente.

@ref{266,,ClassVar} não é uma classe, e não deve ser usada com @ref{442,,isinstance()} ou @ref{7c2,,issubclass()}. @ref{266,,ClassVar} não muda com o comportamento do Python em tempo de execução, mas pode ser usada por verificadores de tipos de terceiros. Por exemplo, um verificador de tipos pode sinalizar que o seguinte código é errado:

@example
enterprise_d = Starship(3000)
enterprise_d.stats = @{@} # Erro: atribuindo valor a variável de classe de uma instância
Starship.stats = @{@}     # Isso é OK
@end example


Adicionado na versão 3.5.3.



Alterado na versão 3.13: @ref{266,,ClassVar} agora pode ser aninhada em @ref{267,,Final} e vice-versa.

@end deffn

@geindex Final (no módulo typing)
@anchor{library/typing typing Final}@anchor{267}
@deffn {Dado} typing.Final

Uma construção especial de tipagem para indicar nomes finais a verificadores de tipos

Nomes finais não podem ser reatribuídos em qualquer escopo. Nomes finais declarados em escopos de classe não podem ser substituídos em subclasses.

Por exemplo:

@example
MAX_SIZE: Final = 9000
MAX_SIZE += 1  # Erro reportado pelo verificador de tipos

class Connection:
    TIMEOUT: Final[int] = 10

class FastConnector(Connection):
    TIMEOUT = 1  # Error reportado pelo verificador de tipos
@end example

Não há verificação em tempo de execução dessas propriedades. Veja 
@geindex Propostas de Melhorias do Python; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/} para mais detalhes.


Adicionado na versão 3.8.



Alterado na versão 3.13: @ref{267,,Final} agora pode ser aninhada em @ref{266,,ClassVar} e vice-versa.

@end deffn

@geindex Required (no módulo typing)
@anchor{library/typing typing Required}@anchor{5c4}
@deffn {Dado} typing.Required

Uma construção especial de tipagem para marcar uma chave de @ref{162,,TypedDict} como necessária.

Isso é útil principalmente para TypedDicts com @code{total=False}. Veja @ref{162,,TypedDict} e 
@geindex Propostas de Melhorias do Python; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} para obter mais detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex NotRequired (no módulo typing)
@anchor{library/typing typing NotRequired}@anchor{5c5}
@deffn {Dado} typing.NotRequired

Uma construção especial de tipagem para marcar uma chave de @ref{162,,TypedDict} como potencialmente ausente.

Veja @ref{162,,TypedDict} e 
@geindex Propostas de Melhorias do Python; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} para obter mais detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex ReadOnly (no módulo typing)
@anchor{library/typing typing ReadOnly}@anchor{161}
@deffn {Dado} typing.ReadOnly

Uma construção especial de tipagem para marcar um item de um @ref{162,,TypedDict} como somente leitura.

Por exemplo:

@example
class Movie(TypedDict):
   title: ReadOnly[str]
   year: int

def mutate_movie(m: Movie) -> None:
   m["year"] = 1999  # permitido
   m["title"] = "The Matrix"  # erro no verificador de tipos
@end example

Não há verificação em tempo de execução para esta propriedade.

Consulte @ref{162,,TypedDict} e 
@geindex Propostas de Melhorias do Python; PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/} para obter mais detalhes.


Adicionado na versão 3.13.

@end deffn

@geindex Annotated (no módulo typing)
@anchor{library/typing typing Annotated}@anchor{944}
@deffn {Dado} typing.Annotated

Forma especial de tipagem para adicionar metadados específicos de contexto para uma anotação.

Adiciona metadados @code{x} a um determinado tipo @code{T} usando a anotação @code{Annotated[T, x]}. Os metadados adicionados usando @code{Annotated} podem ser usados por ferramentas de análise estática ou em tempo de execução. Em tempo de execução, os metadados são armazenados em um atributo @code{__metadata__}.

Se uma biblioteca ou ferramenta encontrar uma anotação @code{Annotated[T, x]} e ela não tiver lógica especial para os metadados, ela deverá ignorar os metadados e simplesmente tratar a anotação como @code{T}. Dessa forma, @code{Annotated} pode ser útil em códigos que desejarem usar a anotação para propósitos fora do sistema de tipagem estática do Python.

Usar @code{Annotated[T, x]} como um anotação ainda permite a verificação estática do tipo de @code{T}, pois os verificadores de tipo simplesmente ignoram os metadados em @code{x}. Dessa forma, o @code{Annotated} difere do decorador @ref{6b4,,@@no_type_check}, que também pode ser usado para adicionar anotações fora do escopo do sistema de tipagem, mas desativa completamente a verificação de tipos para uma função ou classe.

A responsabilidade de como interpretar os metadados é da ferramenta ou da biblioteca que encontrar uma anotação @code{Annotated}. Uma ferramenta ou biblioteca que encontrar um tipo @code{Annotated} poderá examinar os elementos de metadados para determinar se eles são de interesse (por exemplo, usando @ref{442,,isinstance()}).


@deffn {Describe} Annotated[<type>, <metadata>]
@end deffn

Aqui está um exemplo de como você pode usar @code{Annotated} para adicionar metadados a anotações de tipos se estiver fazendo uma análise de intervalos:

@example
@@dataclass
class ValueRange:
    lo: int
    hi: int

T1 = Annotated[int, ValueRange(-10, 5)]
T2 = Annotated[T1, ValueRange(-20, 3)]
@end example

O primeiro argumento para @code{Annotated} deve ser um tipo válido. Vários elementos de metadados podem ser fornecidos, pois @code{Annotated} suporta argumentos variádicos. A ordem dos elementos de metadados é preservada e importa para verificações de igualdade:

@example
@@dataclass
class ctype:
     kind: str

a1 = Annotated[int, ValueRange(3, 10), ctype("char")]
a2 = Annotated[int, ctype("char"), ValueRange(3, 10)]

assert a1 != a2  # a ordem importa
@end example

Cabe à ferramenta que consome as anotações decidir se o cliente tem permissão de adicionar vários elementos de metadados a uma anotação e como mesclar essas anotações.

Os tipos @code{Annotated} aninhados são achatados. A ordem dos elementos de metadados começa com a anotação mais interna:

@example
assert Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
    int, ValueRange(3, 10), ctype("char")
]
@end example

Entretanto, isso não se aplica a tipos @code{Annotated} referenciadas por meio de um apelido de tipo, para evitar forçar a avaliação da @ref{455,,TypeAliasType} subjacente:

@example
type From3To10[T] = Annotated[T, ValueRange(3, 10)]
assert Annotated[From3To10[int], ctype("char")] != Annotated[
   int, ValueRange(3, 10), ctype("char")
]
@end example

Elementos duplicados de metadata não são removidos:

@example
assert Annotated[int, ValueRange(3, 10)] != Annotated[
    int, ValueRange(3, 10), ValueRange(3, 10)
]
@end example

@code{Annotated} pode ser usado com apelidos aninhados e apelidos genéricos:

@quotation

@example
@@dataclass
class MaxLen:
    value: int

type Vec[T] = Annotated[list[tuple[T, T]], MaxLen(10)]

# Quando usado em uma anotação de tipo, um verificador de tipos tratará "V" da mesma forma que
# `@w{`}Annotated[list[tuple[int, int]], MaxLen(10)]`@w{`}:
type V = Vec[int]
@end example
@end quotation

@code{Annotated} não pode ser usado com um @ref{15f,,TypeVarTuple} desempacotado:

@example
type Variadic[*Ts] = Annotated[*Ts, Ann1] = Annotated[T1, T2, T3, ..., Ann1]  # NÃO válido
@end example

onde @code{T1}, @code{T2}, … são @ref{15d,,TypeVars}. Isso é inválido, pois somente um tipo deve ser passado para Annotated.

Por padrão, @ref{6b1,,get_type_hints()} retira os metadados de anotações. Passe @code{include_extras=True} para preservar os metadados:

@quotation

@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
@end quotation

Em tempo de execução, os metadados associados a um tipo @code{Annotated} podem ser recuperados por meio do atributo @code{__metadata__}:

@quotation

@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
@end quotation

Se você quiser recuperar o tipo original envolvido por @code{Annotated}, use o atributo @code{__origin__}:

@quotation

@example
>>> from typing import Annotated, get_origin
>>> Password = Annotated[str, "secret"]
>>> Password.__origin__
<class 'str'>
@end example
@end quotation

Note que usar @ref{2ec,,get_origin()} retornará o próprio @code{Annotated}:

@quotation

@example
>>> get_origin(Password)
typing.Annotated
@end example
@end quotation


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 593

@item PEP 593@footnote{https://peps.python.org/pep-0593/} - Anotações flexíveis para funções e variáveis

A PEP que introduz @code{Annotated} à biblioteca padrão.
@end table



Adicionado na versão 3.9.

@end deffn

@geindex TypeIs (no módulo typing)
@anchor{library/typing typing TypeIs}@anchor{163}
@deffn {Dado} typing.TypeIs

Uma construção especial de tipagem para marcar funções de predicado de tipo definidas pelo usuário.

@code{TypeIs} pode ser usado para anotar o tipo de retorno de uma função de predicado de tipo definida pelo usuário. @code{TypeIs} aceita apenas um único argumento de tipo. Em tempo de execução, funções marcadas dessa forma devem retornar um booleano e receber, no mínimo, um argumento posicional.

@code{TypeIs} visa beneficiar `estreitamento de tipo' – uma técnica usada por verificador de tipo estático para determinar um tipo mais preciso de expressão dentro do fluxo de código de um programa.  Normalmente, o estreitamento de tipo é feito por meio da análise do fluxo de código condicional e da aplicação do estreitamento a um bloquear código.  A condicional expressão aqui é às vezes chamada de “predicado de tipo”:

@example
def is_str(val: str | float):
    # predicado de tipos "isinstance"
    if isinstance(val, str):
        # Tipo de `@w{`}val`@w{`} é restrito a `@w{`}str`@w{`}
        ...
    else:
        # Senão, tipo de `@w{`}val`@w{`} é restrito a `@w{`}float`@w{`}.
        ...
@end example

Às vezes, seria conveniente usar uma função booleana definida pelo usuário como um predicado de tipo. Essa função deveria usar @code{TypeIs[...]} ou @ref{164,,TypeGuard} como seu tipo de retorno para alertar o verificador de tipo estático sobre essa intenção. @code{TypeIs} geralmente tem um comportamento mais intuitivo do que @code{TypeGuard}, mas não pode ser usado quando os tipos de entrada e saída são incompatíveis (por exemplo, de @code{list[object]} para @code{list[int]}) ou quando a função não retorna @code{True} para todas as instâncias do tipo restrito.

Usar @code{-> TypeIs[NarrowedType]} informa ao verificador de tipo estático que, para uma determinada função:


@enumerate 

@item 
O valor de retorno é um booleano.

@item 
Se o valor de retorno for @code{True}, o tipo de seu argumento será a interseção entre o tipo original do argumento e o @code{NarrowedType}.

@item 
Se o valor de retorno for @code{False}, o tipo de seu argumento será restrito para excluir @code{NarrowedType}.
@end enumerate

Por exemplo:

@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):
        # Tipo de `@w{`}arg`@w{`} é restrito à interseção
        # de `@w{`}Parent`@w{`} e `@w{`}Child`@w{`}, o que equivale a
        # `@w{`}Child`@w{`}.
        assert_type(arg, Child)
    else:
        # Tipo de `@w{`}arg`@w{`} é restrito para excluir `@w{`}Parent`@w{`},
        # então sobrou o tipo `@w{`}Unrelated`@w{`}.
        assert_type(arg, Unrelated)
@end example

O tipo dentro de @code{TypeIs} deve ser consistente com o tipo do argumento da função; caso contrário, o verificador de tipo estático levantará um erro. Uma função @code{TypeIs} escrita incorretamente pode ocasionar um comportamento insensato pelo sistema de tipos; é de responsabilidade do usuário escrever tais funções de forma segura para tipos.

Se uma função @code{TypeIs} for um método de classe ou instância, então o tipo em @code{TypeIs} mapeia para o tipo do segundo parâmetro (depois de @code{cls} ou @code{self}).

Em resumo, a forma @code{def foo(arg: TypeA) -> TypeIs[TypeB]: ...}, significa que se @code{foo(arg)} retorna @code{True}, então @code{arg} é um instância de @code{TypeB}, e se retorna @code{False}, não é um instância de @code{TypeB}.

@code{TypeIs} também funciona com variáveis de tipo. Para mais informações, consulte a 
@geindex Propostas de Melhorias do Python; PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/} (Restringindo tipos com @code{TypeIs}).


Adicionado na versão 3.13.

@end deffn

@geindex TypeGuard (no módulo typing)
@anchor{library/typing typing TypeGuard}@anchor{164}
@deffn {Dado} typing.TypeGuard

Uma construção especial de tipagem para marcar funções de predicado de tipo definidas pelo usuário.

Funções de predicados de tipo são funções definidas pelo usuário que retornam se seu argumento é uma instância de um tipo específico. O @code{TypeGuard} funciona como @ref{163,,TypeIs}, mas tem efeitos sutilmente diferentes sobre o comportamento da verificação de tipos (veja abaixo).

Usar @code{-> TypeGuard} informa ao verificador de tipo estático que, para uma determinada função:


@enumerate 

@item 
O valor de retorno é um booleano.

@item 
Se o valor de retorno for @code{True}, o tipo de seu argumento é o tipo dentro de @code{TypeGuard}.
@end enumerate

@code{TypeGuard} também funciona com tipos variáveis. Consulte a 
@geindex Propostas de Melhorias do Python; PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/} para obter mais detalhes.

Por exemplo:

@example
def is_str_list(val: list[object]) -> TypeGuard[list[str]]:
    '@w{'}'Determina se todos os objetos na lista são strings'@w{'}'
    return all(isinstance(x, str) for x in val)

def func1(val: list[object]):
    if is_str_list(val):
        # Tipo de `@w{`}val`@w{`} é restrito a `@w{`}list[str]`@w{`}.
        print(" ".join(val))
    else:
        # Tipo de `@w{`}val`@w{`} continua sendo `@w{`}list[object]`@w{`}.
        print("Not a list of strings!")
@end example

@code{TypeIs} e @code{TypeGuard} diferem das seguintes maneiras:


@itemize *

@item 
@code{TypeIs} exige que o tipo restrito seja um subtipo do tipo de entrada, enquanto o @code{TypeGuard}, não. O motivo principal é permitir coisas como restringir @code{list[object]} a @code{list[str]}, embora este não seja um subtipo daquele, já que @code{list} é invariante.

@item 
Quando uma função @code{TypeGuard} retorna @code{True}, os verificadores de tipo restringem o tipo da variável exatamente ao tipo @code{TypeGuard}. Quando uma função @code{TypeIs} retorna @code{True}, os verificadores de tipo podem inferir um tipo mais preciso combinando o tipo previamente conhecido da variável com o tipo @code{TypeIs}. (Tecnicamente, isso é conhecido como um tipo de interseção).

@item 
Quando uma função @code{TypeGuard} retorna @code{False}, os verificadores de tipo não podem restringir o tipo da variável. Quando uma função @code{TypeIs} retorna @code{False}, os verificadores de tipo podem restringir o tipo da variável para excluir o tipo @code{TypeIs}.
@end itemize


Adicionado na versão 3.10.

@end deffn

@geindex Unpack (no módulo typing)
@anchor{library/typing typing Unpack}@anchor{171b}
@deffn {Dado} typing.Unpack

Operador de tipagem para marcar conceitualmente um objeto como tendo sido desempacotado.

Por exemplo, usar o operador de desempacotamento @code{*} em uma @ref{419e,,tupla de tipos variáveis} equivale a usar o @code{Unpack} para marcar a tupla de tipos variáveis como tendo sido desempacotada:

@example
Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]
# Efetivamente faz:
tup: tuple[Unpack[Ts]]
@end example

Na verdade, @code{Unpack} pode ser usado de forma intercambiável com @code{*} no contexto dos tipos @ref{15f,,typing.TypeVarTuple} e @ref{370,,builtins.tuple}. Você pode ver @code{Unpack} sendo usado explicitamente em versões mais antigas do Python, onde @code{*} não podia ser usado em certos lugares:

@example
# Em versões mais antigas do Python, TypeVarTuple e Unpack
# estão localizados no pacote de backports `typing_extensions`.
from typing_extensions import TypeVarTuple, Unpack

Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]         # Erro de sintaxe no Python <= 3.10!
tup: tuple[Unpack[Ts]]  # Semanticamente equivalente e compatível com versões anteriores
@end example

@code{Unpack} também pode ser usado com @ref{162,,typing.TypedDict} para a tipagem de @code{**kwargs} em uma assinatura de função:

@example
from typing import TypedDict, Unpack

class Movie(TypedDict):
    name: str
    year: int

# Esta função espera dois argumentos nomeados: `name` de tipo `str`
# e `year` de tipo `int`.
def foo(**kwargs: Unpack[Movie]): ...
@end example

Consulte 
@geindex Propostas de Melhorias do Python; PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} para obter mais detalhes sobre como usar @code{Unpack} para tipagem de @code{**kwargs}.


Adicionado na versão 3.11.

@end deffn

@node Criando tipos genéricos e apelidos de tipo,Outras diretivas especiais,Formas especiais,Tipos primitivos especiais
@anchor{library/typing building-generic-types-and-type-aliases}@anchor{419f}
@subsubsection Criando tipos genéricos e apelidos de tipo


As classes a seguir não devem ser usadas diretamente como anotações. propósito O objetivo delas é construir bloquear para criar genérico e digitar apelido.

Esses objetos podem ser criados por meio de sintaxe especial (@ref{2b3,,listas de parâmetros de tipo} e a instrução @ref{438,,type}). Para compatibilidade com Python 3.11 e versões anteriores, eles também podem ser criados sem a sintaxe dedicada, como documentado abaixo.

@geindex Generic (classe em typing)
@anchor{library/typing typing Generic}@anchor{15d7}
@deffn {Classe} typing.Generic

Classe base abstrata para tipos genéricos

Normalmente, um tipo genérico é declarado adicionando-se uma lista de parâmetros de tipo após o nome da classe:

@example
class Mapping[KT, VT]:
    def __getitem__(self, key: KT) -> VT:
        ...
        # Etc.
@end example

Essa classe herda implicitamente de @code{Generic}. A semântica em tempo de execução dessa sintaxe é discutida na @ref{452,,Referência da Linguagem}.

Esta classe pode ser utilizada como segue:

@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

Aqui os colchetes depois no nome da função indica uma @ref{453,,função genérica}.

Para manter retrocompatibilidade, as classes genéricas também podem ser declaradas herdando explicitamente de @code{Generic}. Nesse caso, os parâmetros de tipo devem ser declarados separadamente:

@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 (classe em typing)
@anchor{library/typing typevar}@anchor{4195}@anchor{library/typing typing TypeVar}@anchor{15d}
@deffn {Classe} typing.TypeVar (name, *constraints, bound=None, covariant=False, contravariant=False, infer_variance=False, default=typing.NoDefault)

Tipo variável.

A maneira preferida de construir um tipo variável é por meio da sintaxe dedicada para @ref{453,,funções genéricas}, @ref{452,,classes genéricas} e @ref{456,,apelidos de tipo genérico}:

@example
class Sequence[T]:  # T é um TypeVar
    ...
@end example

Essa sintaxe também pode ser usada para criar tipos variáveis delimitados e tipos variáveis restritos:

@example
class StrSequence[S: str]:  # S é a TypeVar com como limite superior em `str`;
    ...                     # podemos dizer que S é "delimitada por `str`"


class StrOrBytesSequence[A: (str, bytes)]:  # A é uma TypeVar restrita a str ou bytes
    ...
@end example

No entanto, se desejado, tipos variáveis reutilizáveis também podem ser construídas manualmente, como:

@example
T = TypeVar('T') # Pode ser qualquer coisa
S = TypeVar('S', bound=str) # Pode ser qualquer subtipo de str
A = TypeVar('A', str, bytes) # Deve ser exatamente str ou bytes
@end example

Tipos variáveis existem principalmente para o benefício de verificadores de tipo estático. Eles servem como parâmetros para tipos genéricos, bem como para definições de função genérica  e apelidos de tipo. Consulte @ref{15d7,,Generic} para obter mais informações sobre genérico. Funções genéricas funcionam da seguinte forma:

@example
def repeat[T](x: T, n: int) -> Sequence[T]:
    """Retorna uma lista contendo n referências para x."""
    return [x]*n


def print_capitalized[S: str](x: S) -> S:
    """Exibe x capitalizado, e retorna x."""
    print(x.capitalize())
    return x


def concatenate[A: (str, bytes)](x: A, y: A) -> A:
    """Concatena dois objetos string ou bytes."""
    return x + y
@end example

Observe que tipos variáveis podem ser `delimitados', `restritos', nenhum dos dois, mas não podem ser `ambos'.

A variância de tipos variáveis é inferida pelos verificadores de tipo quando eles são criados por meio do @ref{2b3,,sintaxe de parâmetro de tipo} ou quando @code{infer_variance=True} é passado. Os tipos variáveis criados manualmente podem ser explicitamente marcados como covariante ou contravariantes ao passar @code{covariant=True} ou @code{contravariant=True}. Por padrão, os tipos variáveis criados manualmente são invariante. Consulte 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} para obter mais detalhes.

Tipos variáveis delimitados e tipos variáveis restritos têm semânticas diferentes de várias formas importantes. Usar um tipo variável `delimitado' significa que a @code{TypeVar} será resolvido usando o tipo mais específico possível:

@example
x = print_capitalized('a string')
reveal_type(x)  # tipo revelado é str

class StringSubclass(str):
    pass

y = print_capitalized(StringSubclass('another string'))
reveal_type(y)  # tipo revelado é StringSubclass

z = print_capitalized(45)  # erro: int não é subtipo de str
@end example

O limite superior de um tipo variável pode ser um tipo concreto, um tipo abstrato (classe base abstrata ou protocolo) ou até mesmo uma união de tipos:

@example
# Pode ser qualquer coisa com um método __abs__
def print_abs[T: SupportsAbs](arg: T) -> None:
    print("Absolute value:", abs(arg))

U = TypeVar('U', bound=str|bytes)  # Pode ser qualquer subtipo com a união str | bytes
V = TypeVar('V', bound=SupportsAbs)  # Pode ser qualquer coisa com um método __abs__
@end example
@anchor{library/typing typing-constrained-typevar}@anchor{419b}
Porém, usar um tipo variável `restrito' significa que a @code{TypeVar} só poderá ser resolvida como sendo exatamente uma das restrições dadas:

@example
a = concatenate('one', 'two')
reveal_type(a) # o tipo revelado é str

b = concatenate(StringSubclass('one'), StringSubclass('two'))
reveal_type(b) # o tipo revelado é str, apesar de StringSubclass ter sido passado

c = concatenate('one', b'two') # erro: tipo variável 'A' pode ser str ou bytes em uma chamada de função, mas não ambos
@end example

Em tempo de execução, @code{isinstance(x, T)} levantará @ref{2c3,,TypeError}.

@geindex __name__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __name__}@anchor{41a0}
@deffn {Atributo} __name__

O nome do tipo variável.
@end deffn

@geindex __covariant__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __covariant__}@anchor{41a1}
@deffn {Atributo} __covariant__

Se o tipo variável foi explicitamente marcado como covariante.
@end deffn

@geindex __contravariant__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __contravariant__}@anchor{41a2}
@deffn {Atributo} __contravariant__

Se o tipo variável foi explicitamente marcado como contravariante.
@end deffn

@geindex __infer_variance__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __infer_variance__}@anchor{41a3}
@deffn {Atributo} __infer_variance__

Se a variância de tipo variável deve ser inferida por verificadores de tipo.


Adicionado na versão 3.12.

@end deffn

@geindex __bound__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __bound__}@anchor{41a4}
@deffn {Atributo} __bound__

A limite superior do tipo variável, se houver.


Alterado na versão 3.12: Para tipos variáveis criado por meio da @ref{2b3,,sintaxe de parâmetro de tipo} , a limite é avaliado somente quando o atributo é acessado, não quando o tipo variável é criado (consulte @ref{457,,Avaliação preguiçosa}).

@end deffn

@geindex __constraints__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __constraints__}@anchor{41a5}
@deffn {Atributo} __constraints__

Um tupla contendo as restrições do tipo variável, se houver.


Alterado na versão 3.12: Para tipos variáveis criado por meio da @ref{2b3,,sintaxe de parâmetro de tipo} , a restrição é avaliada somente quando o atributo é acessado, não quando o tipo variável é criado (consulte @ref{457,,Avaliação preguiçosa}).

@end deffn

@geindex __default__ (atributo typing.TypeVar)
@anchor{library/typing typing TypeVar __default__}@anchor{41a6}
@deffn {Atributo} __default__

O padrão valor do tipo variável, ou @ref{262,,typing.NoDefault} se ele não tiver padrão.


Adicionado na versão 3.13.

@end deffn

@geindex has_default() (método typing.TypeVar)
@anchor{library/typing typing TypeVar has_default}@anchor{41a7}
@deffn {Método} has_default ()

Retorna se o tipo variável tem ou não um valor padrão. Isso equivale a verificar se @ref{41a6,,__default__} não é o singleton @ref{262,,typing.NoDefault}, exceto por não forçar a avaliação instantânea do valor padrão que é @ref{457,,avaliado preguiçosamente}.


Adicionado na versão 3.13.

@end deffn


Alterado na versão 3.12: Tipos variáveis agora podem ser declarados usando a @ref{2b3,,sintaxe de parâmetro de tipo} introduzida por 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}. O parâmetro @code{infer_variance} foi adicionado.



Alterado na versão 3.13: Adiciona suporte a valores padrão.

@end deffn

@geindex TypeVarTuple (classe em typing)
@anchor{library/typing typevartuple}@anchor{419e}@anchor{library/typing typing TypeVarTuple}@anchor{15f}
@deffn {Classe} typing.TypeVarTuple (name, *, default=typing.NoDefault)

Tupla de tipo variável. Uma forma especializada de @ref{4195,,tipo variável} que permite genéricos `variádicos'.

Tuplas de tipo variável podem ser declarada em @ref{2b3,,listas de parâmetros de tipo} usando um único asterisco (@code{*}) antes do nome:

@example
def move_first_element_to_last[T, *Ts](tup: tuple[T, *Ts]) -> tuple[*Ts, T]:
    return (*tup[1:], tup[0])
@end example

Ou invocando o construtor @code{TypeVarTuple} explicitamente:

@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

Um tipo variável normal permite a parametrização com um único tipo. Uma tupla de tipos variáveis, por outro lado, permite a parametrização com um número `arbitrário' de tipos, agindo como um número `arbitrário' de tipos variáveis envolvidos em um tupla. Por exemplo:

@example
# T é limitado a int, Ts é limitado a ()
# Valor retornado é (1,), que tem tipo tuple[int]
move_first_element_to_last(tup=(1,))

# T é limitado a int, Ts é limitado a (str,)
# Valor retornado é ('spam', 1), que tem tipo tuple[str, int]
move_first_element_to_last(tup=(1, 'spam'))

# T é limitado a int, Ts é limitado a (str, float)
# Valor retornado é ('spam', 3.0, 1), que tem tipo tuple[str, float, int]
move_first_element_to_last(tup=(1, 'spam', 3.0))

# Isso é um erro para o verificador de tipos (e falha em tempo de execução)
# pois tuple[()] não é compatível com tuple[T, *Ts]
# (pelo menos um elemento é necessário)
move_first_element_to_last(tup=())
@end example

Observe o uso do operador de desempacotamento @code{*} em @code{tuple[T, *Ts]}. Conceitualmente, você pode interpretar @code{Ts} como uma tupla de tipos variáveis @code{(T1, T2, ...)} . Então o tipo @code{tuple[T, *Ts]} se tornaria @code{tuple[T, *(T1, T2, ...)]}, que equivale a @code{tuple[T, T1, T2, ...]}. (Note que, em versões mais antigas de Python, você pode encontrar isso escrito com @ref{171b,,Unpack} em vez de @code{Unpack[Ts]}.)

Tuplas de tipos variáveis devem `sempre' ser desempacotadas. Isso ajuda a distinguir entre tuplas de tipos variáveis e tipos variáveis normais:

@example
x: Ts          # Inválido
x: tuple[Ts]   # Inválido
x: tuple[*Ts]  # O jeito correto
@end example

As tuplas de tipos variáveis podem ser usadas no mesmo contexto que tipos variáveis normais. Por exemplo, em argumentos, tipos de retorno e definições de classes:

@example
class Array[*Shape]:
    def __getitem__(self, key: tuple[*Shape]) -> float: ...
    def __abs__(self) -> "Array[*Shape]": ...
    def get_shape(self) -> tuple[*Shape]: ...
@end example

As tuplas de tipos variáveis podem ser combinadas com tipos variáveis normais:

@example
class Array[DType, *Shape]:  # Tudo certo aqui
    pass

class Array2[*Shape, DType]:  # Tudo certo aqui também
    pass

class Height: ...
class Width: ...

float_array_1d: Array[float, Height] = Array()     # Totalmente certo
int_array_2d: Array[int, Height, Width] = Array()  # Sim, certo também
@end example

No entanto, observe que no máximo uma tupla de tipos variáveis pode aparecer em uma única lista de argumentos de tipo ou parâmetros de tipo:

@example
x: tuple[*Ts, *Ts]             # Inválido
class Array[*Shape, *Shape]:  # Inválido
    pass
@end example

Por fim, uma tupla de tipos variáveis desempacotada pode ser usada como anotação de tipo de @code{*args}:

@example
def call_soon[*Ts](
    callback: Callable[[*Ts], None],
    *args: *Ts
) -> None:
    ...
    callback(*args)
@end example

Ao contrário do que acontece com anotações não desempacotadas de @code{*args} - por exemplo, @code{*args: int}, que especificaria que `todos' os argumentos são @code{int} -, @code{*args: *Ts} permite referenciar os tipos de cada argumento em @code{*args} `individualmente'. Isso nos permite garantir que os tipos em @code{*args} passados para @code{call_soon} correspondem aos tipos dos argumentos (posicionais) de @code{callback}.

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} para mais detalhes sobre tuplas de tipos variáveis.

@geindex __name__ (atributo typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple __name__}@anchor{41a8}
@deffn {Atributo} __name__

O nome da tupla de tipos variáveis.
@end deffn

@geindex __default__ (atributo typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple __default__}@anchor{41a9}
@deffn {Atributo} __default__

O valor padrão da tupla de tipos variáveis, ou @ref{262,,typing.NoDefault} se não existir padrão.


Adicionado na versão 3.13.

@end deffn

@geindex has_default() (método typing.TypeVarTuple)
@anchor{library/typing typing TypeVarTuple has_default}@anchor{41aa}
@deffn {Método} has_default ()

Retorna se a tupla de tipos variáveis tem ou não um valor padrão. Isso equivale a verificar se @ref{41a9,,__default__} não é o singleton @ref{262,,typing.NoDefault}, exceto por não forçar a avaliação instantânea do valor padrão que é @ref{457,,avaliado preguiçosamente}.


Adicionado na versão 3.13.

@end deffn


Adicionado na versão 3.11.



Alterado na versão 3.12: Tuplas de tipos variáveis agora podem ser declaradas usando a sintaxe de @ref{2b3,,parâmetros de tipo} introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Alterado na versão 3.13: Adiciona suporte a valores padrão.

@end deffn

@geindex ParamSpec (classe em typing)
@anchor{library/typing typing ParamSpec}@anchor{15e}
@deffn {Classe} typing.ParamSpec (name, *, bound=None, covariant=False, contravariant=False, default=typing.NoDefault)

Variável de especificação de parâmetro. Uma versão especializada de @ref{4195,,tipos variáveis}.

Em @ref{2b3,,listas de parâmetros de tipo} as especificações de parâmetros podem ser declaradas com dois asteriscos (@code{**}):

@example
type IntFunc[**P] = Callable[P, int]
@end example

Para compatibilidade com Python 3.11 e versões anteriores, os objetos @code{ParamSpec} também podem ser criados da seguinte forma:

@example
P = ParamSpec('P')
@end example

Variáveis de especificação de parâmetro existem principalmente para o benefício de verificadores de tipo estático. São usadas para encaminhar os tipos de parâmetros de um chamável para outro chamável – um padrão comumente encontrado em funções e decoradores de ordem superior. Só são válidas quando usados em @code{Concatenate}, ou como o primeiro argumento para @code{Callable}, ou como parâmetro para genéricos definidos pelo usuário. Consulte @ref{15d7,,Generic} para obter mais informações sobre tipos genéricos.

Por exemplo, para adicionar um registro básico de eventos a uma função, é possível criar um decorador @code{add_logging} para registrar chamadas de função. A variável de especificação de parâmetro informa ao verificador de tipos que o chamável passado para o decorador e o novo chamável retornado por ele têm parâmetros de tipo interdependentes:

@example
from collections.abc import Callable
import logging

def add_logging[T, **P](f: Callable[P, T]) -> Callable[P, T]:
    '@w{'}'Um decorador com segurança de tipos que acrescenta registros de eventos (logs) a uma função.'@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{'}'Soma dois números.'@w{'}'
    return x + y
@end example

Sem o @code{ParamSpec}, a maneira mais simples de anotar isso anteriormente era usar um @ref{15d,,TypeVar} com o limite superior @code{Callable[..., Any]}.  No entanto, isso causa dois problemas:


@enumerate 

@item 
O verificador de tipos não consegue verificar a função @code{inner}, porque @code{*args} e @code{**kwargs} precisam ter tipo @ref{6ac,,Any}.

@item 
@ref{41ab,,cast()} pode ser exigida no corpo do decorador @code{add_logging} ao retornar a função @code{inner}, ou o verificador de tipo estático deverá ser instruído a ignorar o @code{return inner}.
@end enumerate

@geindex args (atributo typing.ParamSpec)
@anchor{library/typing typing ParamSpec args}@anchor{41ac}
@deffn {Atributo} args
@end deffn

@geindex kwargs (atributo typing.ParamSpec)
@anchor{library/typing typing ParamSpec kwargs}@anchor{41ad}
@deffn {Atributo} kwargs

Como @code{ParamSpec} captura tanto parâmetros posicionais quanto parâmetros nomeados, @code{P.args} e @code{P.kwargs} podem ser usados para dividir um @code{ParamSpec} em seus componentes. @code{P.args} representa a tupla de parâmetros posicionais em uma determinada chamada e só deve ser usada para anotar @code{*args}. @code{P.kwargs} representa o mapeamento de parâmetros nomeados para seus valores em uma determinada chamada, e só deve ser usado para anotar @code{**kwargs}. Ambos os atributos exigem que o parâmetro anotado esteja em escopo. Em tempo de execução, @code{P.args} e @code{P.kwargs} são instâncias, respectivamente, de @ref{7c7,,ParamSpecArgs} e @ref{7c8,,ParamSpecKwargs}.
@end deffn

@geindex __name__ (atributo typing.ParamSpec)
@anchor{library/typing typing ParamSpec __name__}@anchor{41ae}
@deffn {Atributo} __name__

O nome da especificação de parâmetros.
@end deffn

@geindex __default__ (atributo typing.ParamSpec)
@anchor{library/typing typing ParamSpec __default__}@anchor{41af}
@deffn {Atributo} __default__

O valor padrão da especificação de parâmetro, ou @ref{262,,typing.NoDefault} se não tiver padrão.


Adicionado na versão 3.13.

@end deffn

@geindex has_default() (método typing.ParamSpec)
@anchor{library/typing typing ParamSpec has_default}@anchor{41b0}
@deffn {Método} has_default ()

Retorna se a especificação de parâmetros tem ou não um  valor padrão. Isso equivale a verificar se @ref{41af,,__default__} não é o singleton @ref{262,,typing.NoDefault}, exceto por não forçar a avaliação instantânea do valor padrão que é @ref{457,,avaliado preguiçosamente}.


Adicionado na versão 3.13.

@end deffn

Variáveis de especificação de parâmetros criadas com @code{covariant=True} ou @code{contravariant=True} podem ser usadas para declarar tipos genéricos covariantes ou contravariantes. O argumento @code{bound} também é aceito, semelhante ao @ref{15d,,TypeVar}. Porém, a semântica real dessas palavras reservadas ainda não foi decidida.


Adicionado na versão 3.10.



Alterado na versão 3.12: Especificações de parâmetros agora podem ser declaradas usando a sintaxe de @ref{2b3,,parâmetros de tipo} introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}.



Alterado na versão 3.13: Adiciona suporte a valores padrão.


@cartouche
@quotation Nota 
Somente variáveis de especificação de parâmetro definidas em escopo global podem ser serializadas com pickle.
@end quotation
@end cartouche


@subsubheading Ver também



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} – Variáveis de especificação de parâmetro (a PEP que introduz @code{ParamSpec} e @code{Concatenate})

@item 
@ref{7c5,,Concatenate}

@item 
@ref{2404,,Anotações de objetos chamáveis}
@end itemize

@end deffn

@geindex ParamSpecArgs (no módulo typing)
@geindex ParamSpecKwargs (no módulo typing)
@anchor{library/typing typing ParamSpecArgs}@anchor{7c7}
@deffn {Dado} typing.ParamSpecArgs
@anchor{library/typing typing ParamSpecKwargs}@anchor{7c8}
@deffnx {Dado} typing.ParamSpecKwargs

Tipos dos argumentos e dos argumentos nomeados de um @ref{15e,,ParamSpec}. O atributo @code{P.args} de um @code{ParamSpec} é uma instância de @code{ParamSpecArgs}, e o atributo @code{P.kwargs} é uma instância de @code{ParamSpecKwargs}. São destinados à introspecção em tempo de execução, e não têm nenhum significado especial para o verificador de tipo estático.

Chamar @ref{2ec,,get_origin()} em qualquer um desses objetos retornará o @code{ParamSpec} original:

@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


Adicionado na versão 3.10.

@end deffn

@geindex TypeAliasType (classe em typing)
@anchor{library/typing typing TypeAliasType}@anchor{455}
@deffn {Classe} typing.TypeAliasType (name, value, *, type_params=())

O tipo de apelidos de tipo criados pela instrução @ref{438,,type}.

Exemplo:

@example
>>> type Alias = int
>>> type(Alias)
<class 'typing.TypeAliasType'>
@end example


Adicionado na versão 3.12.


@geindex __name__ (atributo typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __name__}@anchor{41b1}
@deffn {Atributo} __name__

O nome do apelido de tipo:

@example
>>> type Alias = int
>>> Alias.__name__
'Alias'
@end example
@end deffn

@geindex __module__ (atributo typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __module__}@anchor{41b2}
@deffn {Atributo} __module__

O nome do módulo no qual o apelido de tipo foi definido:

@example
>>> type Alias = int
>>> Alias.__module__
'__main__'
@end example
@end deffn

@geindex __type_params__ (atributo typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __type_params__}@anchor{41b3}
@deffn {Atributo} __type_params__

Os parâmetros de tipo do apelido de tipo, ou uma tupla vazia se o apelido não for genérico:

@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 typing.TypeAliasType)
@anchor{library/typing typing TypeAliasType __value__}@anchor{41b4}
@deffn {Atributo} __value__

O valor do apelido de tipo. Isso é uma @ref{457,,avaliação preguiçosa}, portanto, os nomes usados na definição do apelido não são resolvidos até que o atributo @code{__value__} seja acessado:

@example
>>> type Mutually = Recursive
>>> type Recursive = Mutually
>>> Mutually
Mutually
>>> Recursive
Recursive
>>> Mutually.__value__
Recursive
>>> Recursive.__value__
Mutually
@end example
@end deffn
@end deffn

@node Outras diretivas especiais,,Criando tipos genéricos e apelidos de tipo,Tipos primitivos especiais
@anchor{library/typing other-special-directives}@anchor{41b5}
@subsubsection Outras diretivas especiais


Essas funções e classes não devem ser usadas diretamente como anotações. O objetivo é que sejam blocos de construção para criar e declarar tipos.

@geindex NamedTuple (classe em typing)
@anchor{library/typing typing NamedTuple}@anchor{2b0}
@deffn {Classe} typing.NamedTuple

Versão tipada de @ref{1ca,,collections.namedtuple()}.

Uso:

@example
class Employee(NamedTuple):
    name: str
    id: int
@end example

Isso equivale a:

@example
Employee = collections.namedtuple('Employee', ['name', 'id'])
@end example

Para dar um valor padrão a um campo, você pode atribuir um valor a ele no corpo da classe:

@example
class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3
@end example

Campos com valor padrão devem vir depois de quaisquer campos sem valor padrão.

A classe resultante tem um atributo extra @code{__annotations__} que fornece um dicionário que mapeia os nomes de campos para os tipos de campos. (Os nomes de campos estão no atributo @code{_fields} e os valores padrões estão no atributo @code{_field_defaults}, e ambos fazem parte da API de @ref{1ca,,namedtuple()}.)

Subclasses de @code{NamedTuple} também podem ter strings de documentação e métodos:

@example
class Employee(NamedTuple):
    """Representa um funcionário."""
    name: str
    id: int = 3

    def __repr__(self) -> str:
        return f'<Employee @{self.name@}, id=@{self.id@}>'
@end example

Subclasses de @code{NamedTuple} podem ser genéricas:

@example
class Group[T](NamedTuple):
    key: T
    group: list[T]
@end example

Uso retrocompatível:

@example
# Para criar uma NamedTuple genérica em Python 3.11
T = TypeVar("T")

class Group(NamedTuple, Generic[T]):
    key: T
    group: list[T]

# Também há suporte para a sintaxe funcional
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
@end example


Alterado na versão 3.6: Adiciona suporte à sintaxe de anotação de variáveis da 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}.



Alterado na versão 3.6.1: Adiciona suporte a valores padrões, métodos, e docstrings.



Alterado na versão 3.8: Os atributos @code{_field_types} e @code{__annotations__} agora são dicionários regulares em vez de instâncias de @code{OrderedDict}.



Alterado na versão 3.9: Remove o atributo @code{_field_types} em favor do atributo mais padronizado @code{__annotations__} que tem as mesmas informações.



Alterado na versão 3.9: @code{NamedTuple} is now a function rather than a class.
It can still be used as a class base, as described above.



Alterado na versão 3.11: Adiciona suporte a tuplas nomeadas genéricas.



Descontinuado desde a versão 3.13, será removido na versão 3.15: A sintaxe de argumentos nomeados não documentados para criar classes NamedTuple (@code{NT = NamedTuple("NT", x=int)}) está descontinuado e será proibido na versão 3.15. Em vez disso, use a sintaxe baseada em classes ou a sintaxe funcional.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Ao usar a sintaxe funcional para criar uma classe NamedTuple, não passar um valor para o parâmetro ‘fields’ (@code{NT = NamedTuple("NT")}) está descontinuado. Passar @code{None} para o parâmetro ‘fields’ (@code{NT = NamedTuple("NT", None)}) também está descontinuado. Ambos não serão permitidos em Python 3.15. Para criar uma classe NamedTuple com 0 campos, use @code{class NT(NamedTuple): pass} ou @code{NT = NamedTuple("NT", [])}.

@end deffn

@geindex NewType (classe em typing)
@anchor{library/typing typing NewType}@anchor{d16}
@deffn {Classe} typing.NewType (name, tp)

Classe auxiliar para criar @ref{418a,,tipos únicos} com baixo custo.

Um tipo @code{NewType} é considerado um tipo distinto por um verificador de tipos. Porém, em tempo de execução, chamar @code{NewType} retorna seu argumento inalterado.

Uso:

@example
UserId = NewType('UserId', int) # Declare o NewType "UserId"
first_user = UserId(1) # "UserId" retorna o argumento inalterado em tempo de execução
@end example

@geindex __module__ (atributo typing.NewType)
@anchor{library/typing typing NewType __module__}@anchor{41b6}
@deffn {Atributo} __module__

O nome do módulo no qual o novo tipo é definido.
@end deffn

@geindex __name__ (atributo typing.NewType)
@anchor{library/typing typing NewType __name__}@anchor{41b7}
@deffn {Atributo} __name__

O nome do novo tipo.
@end deffn

@geindex __supertype__ (atributo typing.NewType)
@anchor{library/typing typing NewType __supertype__}@anchor{41b8}
@deffn {Atributo} __supertype__

O tipo na qual o novo tipo é baseado.
@end deffn


Adicionado na versão 3.5.2.



Alterado na versão 3.10: @code{NewType} agora é uma classe em vez de uma função.

@end deffn

@geindex Protocol (classe em typing)
@anchor{library/typing typing Protocol}@anchor{264}
@deffn {Classe} typing.Protocol (Generic)

Classe base para classes de protocolo.

Classes de protocolo são definidas assim:

@example
class Proto(Protocol):
    def meth(self) -> int:
        ...
@end example

Essas classes são usadas principalmente com verificadores de tipo estático que reconhecem a subtipagem estrutural (tipagem pato estática). Por exemplo:

@example
class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passa na verificação de tipos
@end example

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} para obter mais detalhes. Classes de protocolo decoradas com @ref{443,,runtime_checkable()} (descritas posteriormente) funcionam como protocolos em tempo de execução simples, somente verificando a presença de determinados atributos, e ignorando suas assinaturas de tipo. Classes de protocolo sem este decorador não podem ser usadas como o segundo argumento para @ref{442,,isinstance()} ou @ref{7c2,,issubclass()}.

Classes de protocolo podem ser genéricas. Por exemplo:

@example
class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
@end example

Em códigos que precisam ser compatíveis com Python 3.11 ou versões anteriores, protocolos genéricos podem ser escritos da seguinte forma:

@example
T = TypeVar("T")

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...
@end example


Adicionado na versão 3.8.

@end deffn

@geindex runtime_checkable() (no módulo typing)
@anchor{library/typing typing runtime_checkable}@anchor{443}
@deffn {Função} @@typing.runtime_checkable

Marca uma classe de protocolo como um protocolo de tempo de execução.

Esse protocolo pode ser usado com @ref{442,,isinstance()} e @ref{7c2,,issubclass()}. Isso permite uma verificação estrutural simples, muito semelhante a “pôneis de um truque só” em @ref{1e,,collections.abc}, como @ref{23e2,,Iterable}. Por exemplo:

@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

Este decorador levanta @ref{2c3,,TypeError} quando aplicado a uma classe não-protocolo.

@cartouche
@quotation Nota 
@code{runtime_checkable()} verificará apenas a presença dos métodos ou atributos obrigatórios, em vez de tipos ou assinaturas de tipos. Por exemplo, o @ref{b99,,ssl.SSLObject} é uma classe e, portanto, passa por uma verificação @ref{7c2,,issubclass()} em relação a @ref{2404,,Callable}. No entanto, o método @code{ssl.SSLObject.__init__} existe apenas para levantar um @ref{2c3,,TypeError} com uma mensagem mais informativa, o que impossibilita chamar (instanciar) o @ref{b99,,ssl.SSLObject}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
uma verificação com @ref{442,,isinstance()} sobre um protocolo verificável em tempo de execução pode ser surpreendentemente lenta se comparada a uma verificação @code{isinstance()} sobre outros tipos de classe. Considere usar expressões alternativas, como chamar a função @ref{4d2,,hasattr()} para realizar verificações estruturais em código sensível a desempenho.
@end quotation
@end cartouche


Adicionado na versão 3.8.



Alterado na versão 3.12: A implementação interna do @ref{442,,isinstance()} agora verifica os protocolos verificáveis em tempo de execução usando @ref{494,,inspect.getattr_static()} para procurar o atributo (anteriormente, era usado @ref{4d2,,hasattr()}). Como resultado, alguns objetos que costumavam ser considerados instâncias de um protoloco verifiável em tempo de execução podem não ser mais considerados instâncias desse protocolo em Python 3.12+, e vice-versa. É improvável que a maioria dos usuários seja afetada por essa alteração.



Alterado na versão 3.12: Os membros de um protocolo verificável em tempo de execução agora serão considerados “congelados” em tempo de execução assim que a classe for criada. A alteração dinâmica de atributos de um protocolo em tempo de execução ainda funcionará, mas não terá impacto nas verificações de @ref{442,,isinstance()} ao comparar objetos com o protocolo. Consulte o @ref{4d1,,O que há de novo no Python 3.12} para mais detalhes.

@end deffn

@geindex TypedDict (classe em typing)
@anchor{library/typing typing TypedDict}@anchor{162}
@deffn {Classe} typing.TypedDict (dict)

Special construct to add type hints to a dictionary.
At runtime “@code{TypedDict} instances” are simply @ref{256,,dicts}.

@code{TypedDict} declara um tipo dicionário que espera que todas as suas instâncias tenham um determinado conjunto de chaves, onde cada chave está associada a um valor de um tipo consistente. Essa expectativa não é verificada em tempo de execução, mas é imposta apenas por verificadores de tipos. Modo de usar:

@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'@}           # Falha na verificação de tipos

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
@end example

Um modo alternativo de criar um @code{TypedDict} é usando a sintaxe de chamada de função. O segundo argumento deve ser um @ref{256,,dict}:

@example
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': str@})
@end example

Esta sintaxe funcional permite definirmos chaves usando @ref{2021,,identificadores} inválidos, por exemplo, por serem palavras-chave ou conterem hífens, ou quando os nomes das chaves não devem ser @ref{1e43,,desconfigurados} como nomes privados comuns:

@example
# levanta SyntaxError
class Point2D(TypedDict):
    in: int  # 'in' é uma palavra reservada
    x-y: int  # nome com hífen

class Definition(TypedDict):
    __schema: str  # desconfigurado para `_Definition__schema`

# OK, sintaxe funcional
Point2D = TypedDict('Point2D', @{'in': int, 'x-y': int@})
Definition = TypedDict('Definition', @{'__schema': str@})  # não desconfigurado
@end example

Por padrão, todas as chaves devem estar presentes em um @code{TypedDict}. É possível marcar chaves individuais como não-obrigatórias usando @ref{5c5,,NotRequired}:

@example
class Point2D(TypedDict):
    x: int
    y: int
    label: NotRequired[str]

# Sintaxe alternativa
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': NotRequired[str]@})
@end example

Isso significa que um @code{TypedDict} @code{Point2D} pode ter a chave @code{label} omitida.

Também é possível marcar todas as chaves como não necessárias por padrão, especificando a totalidade como @code{False}:

@example
class Point2D(TypedDict, total=False):
    x: int
    y: int

# Sintaxe alternativa
Point2D = TypedDict('Point2D', @{'x': int, 'y': int@}, total=False)
@end example

Isso significa que um @code{TypedDict} @code{Point2D}  pode ter qualquer uma de suas chaves omitidas. Espera-se que um verificador de tipos apenas permita os literais @code{False} ou @code{True} como valores do argumento @code{total}. @code{True} é o padrão, e todos os itens definidos no corpo da classe tornam-se obrigatórios.

As chaves individuais de um @code{TypedDict} com @code{total=False} podem ser marcadas como obrigatórias usando @ref{5c4,,Required}:

@example
class Point2D(TypedDict, total=False):
    x: Required[int]
    y: Required[int]
    label: str

# Sintaxe alternativa
Point2D = TypedDict('Point2D', @{
    'x': Required[int],
    'y': Required[int],
    'label': str
@}, total=False)
@end example

É possível que um tipo @code{TypedDict} herde de um ou mais tipos @code{TypedDict} usando a sintaxe baseada em classes. Modo de usar:

@example
class Point3D(Point2D):
    z: int
@end example

@code{Point3D} tem três itens: @code{x}, @code{y} e @code{z}. Equivale a esta definição:

@example
class Point3D(TypedDict):
    x: int
    y: int
    z: int
@end example

Um @code{TypedDict} não pode herdar de uma classe não @code{TypedDict}, exceto @ref{15d7,,Generic}. Por exemplo:

@example
class X(TypedDict):
    x: int

class Y(TypedDict):
    y: int

class Z(object): pass  # Uma classe não TypedDict

class XY(X, Y): pass  # OK

class XZ(X, Z): pass  # levanta TypeError
@end example

Um @code{TypedDict} pode ser genérico:

@example
class Group[T](TypedDict):
    key: T
    group: list[T]
@end example

Para criar um @code{TypedDict} genérico que seja compatível com Python 3.11 ou inferior, herde de @ref{15d7,,Generic} explicitamente:

@example
T = TypeVar("T")

class Group(TypedDict, Generic[T]):
    key: T
    group: list[T]
@end example

Um @code{TypedDict} pode ser inspecionado por meio de dicionários de anotações (consulte @ref{7da,,Boas práticas para anotações} para obter mais informações sobre as melhores práticas de anotações), @ref{41b9,,__total__}, @ref{41ba,,__required_keys__} e @ref{41bb,,__optional_keys__}.

@geindex __total__ (atributo typing.TypedDict)
@anchor{library/typing typing TypedDict __total__}@anchor{41b9}
@deffn {Atributo} __total__

@code{Point2D.__total__} fornece o valor do argumento @code{total}. Exemplo:

@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

Esse atributo reflete `apenas' o valor do argumento @code{total} para a classe @code{TypedDict} atual, e não que a classe é semanticamente total. Por exemplo, um @code{TypedDict} com @code{__total__} definido como @code{True} pode ter chaves marcadas com @ref{5c5,,NotRequired}, ou pode herdar de outro @code{TypedDict} com @code{total=False}. Portanto, geralmente é melhor usar @ref{41ba,,__required_keys__} e @ref{41bb,,__optional_keys__} para introspecção.
@end deffn

@geindex __required_keys__ (atributo typing.TypedDict)
@anchor{library/typing typing TypedDict __required_keys__}@anchor{41ba}
@deffn {Atributo} __required_keys__


Adicionado na versão 3.9.

@end deffn

@geindex __optional_keys__ (atributo typing.TypedDict)
@anchor{library/typing typing TypedDict __optional_keys__}@anchor{41bb}
@deffn {Atributo} __optional_keys__

@code{Point2D.__required_keys__} e @code{Point2D.__optional_keys__} retornam objetos @ref{5da,,frozenset} contendo chaves obrigatórias e opcionais, respectivamente.

As chaves marcadas com @ref{5c4,,Required} sempre aparecerão em @code{__required_keys__} e as chaves marcadas com @ref{5c5,,NotRequired} sempre aparecerão em @code{__optional_keys__}.

Para manter a retrocompatibilidade com Python 3.10 e versões anteriores, também é possível usar herança para declarar chaves obrigatórias e opcionais no mesmo @code{TypedDict}. Isso é feito declarando um @code{TypedDict} com um valor para o argumento @code{total} e então herdando-a em outro @code{TypedDict} usando um valor @code{total} diferente:

@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


Adicionado na versão 3.9.


@cartouche
@quotation Nota 
Se @code{from __future__ import annotations} for usado ou se anotações forem fornecidas como strings, as anotações não serão avaliadas quando o @code{TypedDict} for definido. Portanto, a introspecção em tempo de execução da qual @code{__required_keys__} e @code{__optional_keys__} dependem pode não funcionar corretamente, e os valores dos atributos podem estar incorretos.
@end quotation
@end cartouche
@end deffn

O suporte para @ref{161,,ReadOnly} está refletido nos seguintes atributos:

@geindex __readonly_keys__ (atributo typing.TypedDict)
@anchor{library/typing typing TypedDict __readonly_keys__}@anchor{41bc}
@deffn {Atributo} __readonly_keys__

Um @ref{5da,,frozenset} contendo os nomes de todas as chaves somente para leitura. As chaves são somente para leitura se tiverem o qualificador @ref{161,,ReadOnly}.


Adicionado na versão 3.13.

@end deffn

@geindex __mutable_keys__ (atributo typing.TypedDict)
@anchor{library/typing typing TypedDict __mutable_keys__}@anchor{41bd}
@deffn {Atributo} __mutable_keys__

Um @ref{5da,,frozenset} contendo os nomes de todas as chaves mutáveis. As chaves são mutáveis se não tiverem o qualificador @ref{161,,ReadOnly}.


Adicionado na versão 3.13.

@end deffn

Consulte 
@geindex Propostas de Melhorias do Python; PEP 589
PEP 589@footnote{https://peps.python.org/pep-0589/} para obter mais exemplos e regras detalhadas sobre o uso de @code{TypedDict}.


Adicionado na versão 3.8.



Alterado na versão 3.9: @code{TypedDict} is now a function rather than a class.
It can still be used as a class base, as described above.



Alterado na versão 3.11: Adicionado suporte para marcar chaves individuais como @ref{5c4,,Required} ou @ref{5c5,,NotRequired}. Consulte 
@geindex Propostas de Melhorias do Python; PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}.



Alterado na versão 3.11: Adicionado suporte para @code{TypedDict}s genéricos.



Alterado na versão 3.13: Removeu suporte para o método de argumento nomeado para criar @code{TypedDict}s.



Alterado na versão 3.13: Adiciona suporte ao qualificador @ref{161,,ReadOnly}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Ao usar a sintaxe funcional para criar uma classe TypedDict, não passar um valor para o parâmetro ‘fields’ (@code{TD = TypedDict("TD")}) está descontinuado. Passar @code{None} para o parâmetro ‘fields’ (@code{TD = TypedDict("TD", None)}) também está descontinuado. Ambos não serão permitidos em Python 3.15. Para criar uma classe TypedDict com 0 campos, use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})}.

@end deffn

@node Protocolos<3>,ABCs para trabalhar com E/S,Tipos primitivos especiais,Conteúdo do módulo<7>
@anchor{library/typing protocols}@anchor{41be}
@subsubsection Protocolos


Os protocolos a seguir são fornecidos pelo módulo @code{typing}. Todos são decorados com @ref{443,,@@runtime_checkable}.

@geindex SupportsAbs (classe em typing)
@anchor{library/typing typing SupportsAbs}@anchor{41bf}
@deffn {Classe} typing.SupportsAbs

Um ABC com um método abstrato @code{__abs__} que é covariante em seu tipo de retorno.
@end deffn

@geindex SupportsBytes (classe em typing)
@anchor{library/typing typing SupportsBytes}@anchor{5ea}
@deffn {Classe} typing.SupportsBytes

Um ABC com um método abstrato @code{__bytes__}.
@end deffn

@geindex SupportsComplex (classe em typing)
@anchor{library/typing typing SupportsComplex}@anchor{5e9}
@deffn {Classe} typing.SupportsComplex

Um ABC com um método abstrato @code{__complex__}.
@end deffn

@geindex SupportsFloat (classe em typing)
@anchor{library/typing typing SupportsFloat}@anchor{41c0}
@deffn {Classe} typing.SupportsFloat

Um ABC com um método abstrato @code{__float__}.
@end deffn

@geindex SupportsIndex (classe em typing)
@anchor{library/typing typing SupportsIndex}@anchor{a4f}
@deffn {Classe} typing.SupportsIndex

Um ABC com um método abstrato @code{__index__}.


Adicionado na versão 3.8.

@end deffn

@geindex SupportsInt (classe em typing)
@anchor{library/typing typing SupportsInt}@anchor{a4e}
@deffn {Classe} typing.SupportsInt

Um ABC com um método abstrato @code{__int__}.
@end deffn

@geindex SupportsRound (classe em typing)
@anchor{library/typing typing SupportsRound}@anchor{41c1}
@deffn {Classe} typing.SupportsRound

Uma ABC com um método abstrato @code{__round__} que é covariante em seu tipo de retorno.
@end deffn

@node ABCs para trabalhar com E/S,Funções e decoradores,Protocolos<3>,Conteúdo do módulo<7>
@anchor{library/typing abcs-for-working-with-io}@anchor{41c2}
@subsubsection ABCs para trabalhar com E/S


@geindex IO (classe em typing)
@geindex TextIO (classe em typing)
@geindex BinaryIO (classe em typing)
@anchor{library/typing typing IO}@anchor{72b}
@deffn {Classe} typing.IO
@anchor{library/typing typing TextIO}@anchor{41c3}
@deffnx {Classe} typing.TextIO
@anchor{library/typing typing BinaryIO}@anchor{41c4}
@deffnx {Classe} typing.BinaryIO

O tipo genérico @code{IO[AnyStr]} e suas subclasses @code{TextIO(IO[str])} e @code{BinaryIO(IO[bytes])} representam os tipos de fluxos de E/S, como os retornados por @ref{51c,,open()}.
@end deffn

@node Funções e decoradores,Auxiliares de introspecção,ABCs para trabalhar com E/S,Conteúdo do módulo<7>
@anchor{library/typing functions-and-decorators}@anchor{41c5}
@subsubsection Funções e decoradores


@geindex cast() (no módulo typing)
@anchor{library/typing typing cast}@anchor{41ab}
@deffn {Função} typing.cast (typ, val)

Converta um valor em um tipo.

Isso retorna o valor inalterado. Para o verificador de tipos, isso indica que o valor de retorno tem o tipo designado, mas em tempo de execução não verificamos nada intencionalmente (queremos que isso seja o mais rápido possível).
@end deffn

@geindex assert_type() (no módulo typing)
@anchor{library/typing typing assert_type}@anchor{6ab}
@deffn {Função} typing.assert_type (val, typ, /)

Pede para um verificador de tipo estático confirmar se `val' tem tipo inferido `typ'.

Essa função faz nada em tempo de execução: ela retorna o primeiro argumento inalterado, sem verificações ou efeitos colaterais, independentemente do tipo real do argumento.

Quando um verificador de tipo estático encontra uma chamada para @code{assert_type()}, ele emite um erro se o valor não for do tipo especificado:

@example
def greet(name: str) -> None:
    assert_type(name, str) # OK, o tipo inferido de `name` é `str`
    assert_type(name, int) # erro no verificador de tipos
@end example

Esse função é útil para garantir que o verificador de tipos entende um script conforme as intenções do desenvolvedor:

@example
def complex_function(arg: object):
    # Realiza alguma lógica complexa de restrição de tipos
    # após a qual esperamos que o tipo seja `int`
    ...
    # Testa se o verificador de tipos entendeu nossa função corretamente
    assert_type(arg, int)
@end example


Adicionado na versão 3.11.

@end deffn

@geindex assert_never() (no módulo typing)
@anchor{library/typing typing assert_never}@anchor{6a7}
@deffn {Função} typing.assert_never (arg, /)

Pede ao verificador de tipo estático para confirmar se uma linha de código é inalcançável.

Exemplo:

@example
def int_or_str(arg: int | str) -> None:
    match arg:
        case int():
            print("É um int")
        case str():
            print("É um str")
        case _ as unreachable:
            assert_never(unreachable)
@end example

Aqui, as anotações permitem que o verificador de tipos deduza que o último caso nunca será executado, pois @code{arg} é um @ref{257,,int} ou uma @ref{44c,,str}, e ambas as opções são cobertas por casos anteriores.

Se um verificador de tipos descobrir que uma chamada para @code{assert_never()} é alcançável, ele emitirá um erro. Por exemplo, se a anotação de tipo para @code{arg} fosse @code{int | str | float}, o verificador de tipos emitiria um erro indicando que @code{unreachable} é do tipo @ref{2f7,,float}. Para que uma chamada para @code{assert_never} passe verificação de tipos, o tipo inferido do argumento passado deve ser o tipo inferior, @ref{6a8,,Never}, e nada mais.

Em tempo de execução, essa função levanta uma exceção quando chamada.


@subsubheading Ver também


Unreachable Code and Exhaustiveness Checking@footnote{https://tipagem.Python.org/en/latest/guides/unreachable.html} tem mais informações sobre a verificação de exaustividade com tipagem estática.



Adicionado na versão 3.11.

@end deffn

@geindex reveal_type() (no módulo typing)
@anchor{library/typing typing reveal_type}@anchor{6aa}
@deffn {Função} typing.reveal_type (obj, /)

Pede para um verificador de tipo estático revelar o tipo inferido de uma expressão.

Quando um verificador de tipo estático encontra uma chamada para essa função, ele emite um diagnóstico com o tipo inferido do argumento. Por exemplo:

@example
x: int = 1
reveal_type(x) # O tipo revelado é "builtins.int"
@end example

Isso pode ser útil quando você deseja depurar como o verificador de tipos lida com um determinado trecho de código.

Em tempo de execução, esta função envia o tipo de seu argumento para @ref{940,,sys.stderr} e retorna o argumento inalterado (permitindo que a chamada seja usada em uma expressão):

@example
x = reveal_type(1)  # exibe "Runtime type is int"
print(x)  # exibe "1"
@end example

Observe que o tipo em tempo de execução pode ser diferente (mais ou menos específico) do tipo inferido estaticamente por um verificador de tipos.

A maioria dos verificadores de tipos dá suporte a @code{reveal_type()} em qualquer lugar, mesmo que o nome não seja importado de @code{typing}. Porém, importar o nome de @code{typing} permite que o código seja executado sem erros em tempo de execução e comunica a intenção com mais clareza.


Adicionado na versão 3.11.

@end deffn

@geindex dataclass_transform() (no módulo typing)
@anchor{library/typing typing dataclass_transform}@anchor{4d4}
@deffn {Função} @@typing.dataclass_transform (*, eq_default=True, order_default=False, kw_only_default=False, frozen_default=False, field_specifiers=(), **kwargs)

Um decorador que marca um objeto como tendo comportamento similar a uma @ref{1cb,,dataclass}.

@code{dataclass_transform} pode ser usado para decorar uma classe, metaclasse, ou função decoradora. A presença de @code{@@dataclass_transform()} informa a um verificador de tipo estático que o objeto decorado executa “mágica” em tempo de execução que transforma uma classe de maneira semelhante a @ref{1cb,,@@dataclasses.dataclass}.

Exemplo de uso com a função decoradora:

@example
@@dataclass_transform()
def create_model[T](cls: type[T]) -> type[T]:
    ...
    return cls

@@create_model
class CustomerModel:
    id: int
    name: str
@end example

Em uma classe base:

@example
@@dataclass_transform()
class ModelBase: ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

Em uma metaclasse:

@example
@@dataclass_transform()
class ModelMeta(type): ...

class ModelBase(metaclass=ModelMeta): ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

As classes @code{CustomerModel} definidas acima serão tratadas pelos verificadores de tipos semelhantemente às classes criadas com @ref{1cb,,@@dataclasses.dataclass}. Por exemplo, os verificadores de tipo presumirão que essas classes têm métodos @code{__init__} que aceitam @code{id} e @code{name}.

A classe, metaclasse ou função decorada pode aceitar os seguintes argumentos booleanos tal que verificadores de tipo presumirão ter o mesmo efeito que teriam no decorador @ref{1cb,,@@dataclasses.dataclass}: @code{init}, @code{eq}, @code{order}, @code{unsafe_hash}, @code{frozen}, @code{match_args}, @code{kw_only}, e @code{slots}. É necessário que o valor desses argumentos (@code{True} ou @code{False}) seja avaliado estaticamente.

Os argumentos do decorador @code{dataclass_transform} podem ser usados para personalizar o comportamento padrão da classe, metaclasse, ou função decorada:

@*Parâmetros: 

@itemize *

@item 
@code{eq_default} (@ref{468,,bool}) – Indica se o parâmetro @code{eq} é presumido como @code{True} ou @code{False} se for omitido pelo chamador. O padrão é @code{True}.

@item 
@code{order_default} (@ref{468,,bool}) – Indica se o parâmetro @code{order} é presumido como @code{True} ou @code{False} se for omitido pelo chamador. O padrão é @code{False}.

@item 
@code{kw_only_default} (@ref{468,,bool}) – Indica se o parâmetro @code{kw_only} é presumido como @code{True} ou @code{False} se for omitido pelo chamador. O padrão é @code{False}.

@item 
@code{frozen_default} (@ref{468,,bool}) – Indica se o parâmetro @code{frozen} é presumido como @code{True} ou @code{False} se for omitido pelo chamador. O padrão é @code{False}. Added in version 3.12

@item 
@code{field_specifiers} (@ref{370,,tuple}@code{[}@ref{7ec,,Callable}@code{[}@code{...}@code{, }@code{Any}@code{]}@code{, }@code{...}@code{]}) – Especifica uma lista estática de classes ou funções compatíveis que descrevem campos, semelhante a @ref{1b98,,dataclasses.field()}. O valor padrão é @code{()}.

@item 
@code{**kwargs} (@code{Any}) – Outros argumentos nomeados arbitrários são aceitos para permitir possíveis futuras extensões.
@end itemize


Verificadores de tipo reconhecem os seguintes parâmetros opcionais em especificadores de campos:
`Parâmetros reconhecidos para especificadores de campos'



@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome do parâmetro

@tab

Descrição

@item

@code{init}

@tab

Indica se o campo deve ser incluído no método @code{__init__} sintetizado. Se não for especificado, o valor padrão de @code{init} é @code{True}.

@item

@code{default}

@tab

Fornece o valor padrão do campo.

@item

@code{default_factory}

@tab

Fornece uma função de retorno de tempo de execução que retorna o valor padrão do campo. Se nem @code{default} nem @code{default_factory} forem especificados, o campo é presumido como sem valor padrão e deverá receber um valor quando a classe for instanciada.

@item

@code{factory}

@tab

Um apelido para o parâmetro @code{default_factory} em especificadores de campos.

@item

@code{kw_only}

@tab

Indica se o campo deve ser marcado como somente-nomeado. Se verdadeiro, o campo será somente-nomeado. Se falso, não será somente-nomeado. Se não for especificado, será usado o valor do parâmetro @code{kw_only} do objeto decorado com @code{dataclass_transform} ou, se este não for especificado, será usado o valor de @code{kw_only_default} no @code{dataclass_transform}.

@item

@code{alias}

@tab

Fornece um nome alternativo para o campo. Esse nome alternativo é usado no método @code{__init__} sintetizado.

@end multitable


Em tempo de execução, esse decorador registra seu argumento no atributo @code{__dataclass_transform__} no objeto decorado. Ele não tem nenhum outro efeito em tempo de execução.

Veja 
@geindex Propostas de Melhorias do Python; PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/} para mais detalhes.


Adicionado na versão 3.11.

@end deffn

@geindex overload() (no módulo typing)
@anchor{library/typing overload}@anchor{418d}@anchor{library/typing typing overload}@anchor{41c6}
@deffn {Função} @@typing.overload

Decorador para criar funções e métodos sobrecarregados.

O decorador @code{@@overload} permite descrever funções e métodos com suporte a várias combinações de tipos de argumento. Uma sequência de definições decoradas com @code{@@overload} deve preceder uma única definição não decorada por @code{@@overload} (para a mesma função/método).

Definições decoradas com @code{@@overload} são usadas somente para benefício do verificador de tipos, já que serão sobrescritas por definições sem decoração de @code{@@overload}. Enquanto isso, definições sem decoração de @code{@@overload} serão usadas em tempo de execução, mas devem ser ignoradas pelo verificador de tipos. Em tempo de execução, chamar uma função decorada por @code{@@overload} diretamente levantará @ref{228,,NotImplementedError}.

Um exemplo de sobrecarga que fornece um tipo mais preciso do que o expressar o tipo expresso por uma união ou um tipo variável:

@example
@@overload
def process(response: None) -> None:
    ...
@@overload
def process(response: int) -> tuple[int, str]:
    ...
@@overload
def process(response: bytes) -> str:
    ...
def process(response):
    ...  # a implementação real vem aqui
@end example

Consulte 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} para mais detalhes e uma comparação com outras semânticas de tipagem.


Alterado na versão 3.11: Funções sobrecarregadas agora podem ser inspecionadas em tempo de execução usando @ref{6ae,,get_overloads()}.

@end deffn

@geindex get_overloads() (no módulo typing)
@anchor{library/typing typing get_overloads}@anchor{6ae}
@deffn {Função} typing.get_overloads (func)

Retorna uma sequência de definições de `func' decoradas com @ref{41c6,,@@overload}.

`func' é o objeto função para a implementação da função sobrecarregada. Por exemplo, dada a definição de @code{process} na documentação de @ref{41c6,,@@overload}, @code{get_overloads(process)} retornará uma sequência de três objetos função para as três sobrecargas definidas. Se for chamada em uma função sem sobrecargas, @code{get_overloads()} retornará uma sequência vazia.

A função @code{get_overloads()} pode ser usada em tempo de execução para introspecção de uma função sobrecarregada.


Adicionado na versão 3.11.

@end deffn

@geindex clear_overloads() (no módulo typing)
@anchor{library/typing typing clear_overloads}@anchor{6af}
@deffn {Função} typing.clear_overloads ()

Apaga todas as sobrecargas registradas no registro interno.

Isso pode ser usado para recuperar a memória usada pelo registro.


Adicionado na versão 3.11.

@end deffn

@geindex final() (no módulo typing)
@anchor{library/typing typing final}@anchor{6ad}
@deffn {Função} @@typing.final

Um decorador para indicar métodos e classes finais.

Decorar um método com @code{@@final} indica a um verificador de tipos que o método não pode ser substituído em uma subclasse. Decorar uma classe com @code{@@final} indica que ela não pode ser herdada.

Por exemplo:

@example
class Base:
    @@final
    def done(self) -> None:
        ...
class Sub(Base):
    def done(self) -> None:  # Erro reportado pelo verificador de tipos
        ...

@@final
class Leaf:
    ...
class Other(Leaf):  # Erro reportado pelo verificador de tipos
    ...
@end example

Não há verificação em tempo de execução dessas propriedades. Veja 
@geindex Propostas de Melhorias do Python; PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/} para mais detalhes.


Adicionado na versão 3.8.



Alterado na versão 3.11: O decorador tentará definir um atributo @code{__final__} como @code{True} no objeto decorado. Assim, uma verificação como @code{if getattr(obj, "__final__", False)} pode ser usada em tempo de execução para determinar se um objeto @code{obj} foi marcado como final. Se o objeto decorado não tem suporte a definição de atributos, o decorador retorna o objeto inalterado sem levantar uma exceção.

@end deffn

@geindex no_type_check() (no módulo typing)
@anchor{library/typing typing no_type_check}@anchor{6b4}
@deffn {Função} @@typing.no_type_check

Decorador para indicar que anotações não são dicas de tipo.

Isso funciona como @ref{731,,decorator} de uma classe ou função. Com uma classe, ele se aplica recursivamente a todos os métodos e classes definidos nessa classe (mas não a métodos definidos em suas superclasses ou subclasses). Os verificadores de tipos ignorarão todas as anotações em uma função ou classe com este decorador.

@code{@@no_type_check} modifica o objeto decorado internamente.
@end deffn

@geindex no_type_check_decorator() (no módulo typing)
@anchor{library/typing typing no_type_check_decorator}@anchor{2b1}
@deffn {Função} @@typing.no_type_check_decorator

Decorador para dar a outro decorador o efeito @ref{6b4,,no_type_check()}.

Isso envolve o decorador com algo que envolve a função decorada em @ref{6b4,,no_type_check()}.


Descontinuado desde a versão 3.13, será removido na versão 3.15: Nenhum verificador de tipos jamais adicionou suporte para @code{@@no_type_check_decorator}. Portanto, ele está descontinuado e será removido no Python 3.15.

@end deffn

@geindex override() (no módulo typing)
@anchor{library/typing typing override}@anchor{44b}
@deffn {Função} @@typing.override

Decorador para indicar que um método em uma subclasse deve substituir um método ou atributo em uma superclasse.

Os verificadores de tipo devem emitir um erro se um método decorado com @code{@@override} substitui nada. Isso ajuda a evitar erros que podem ocorrer quando uma classe base muda sem uma mudança equivalente em uma classe filha.

Por exemplo:

@example
class Base:
    def log_status(self) -> None:
        ...

class Sub(Base):
    @@override
    def log_status(self) -> None:  # OK: substitui Base.log_status
        ...

    @@override
    def done(self) -> None:  # Erro reportado pelo verificador de tipos
        ...
@end example

Não há verificação desta propriedade em tempo de execução.

O decorador tentará definir um atributo @code{__override__} como @code{True} no objeto decorado. Assim, uma verificação como @code{if getattr(obj, "__override__", False)} poderá ser usada em tempo de execução para determinar se um objeto @code{obj} foi marcado como uma substituição. Se o objeto decorado não der suporte à atribuição de atributos, o decorador retorna o objeto inalterado sem levantar uma exceção.

Consulte 
@geindex Propostas de Melhorias do Python; PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/} para obter mais detalhes.


Adicionado na versão 3.12.

@end deffn

@geindex type_check_only() (no módulo typing)
@anchor{library/typing typing type_check_only}@anchor{41c7}
@deffn {Função} @@typing.type_check_only

Decorador para marcar uma classe ou função como indisponível em tempo de execução.

Este decorador em si não está disponível em tempo de execução. Seu objetivo principal é marcar classes definidas em arquivos de tipo stub se uma implementação retornar uma instância de uma classe privada:

@example
@@type_check_only
class Response:  # privado ou indisponível em tempo de execução
    code: int
    def get_header(self, name: str) -> str: ...

def fetch_response() -> Response: ...
@end example

Observe que retornar instâncias de classes privadas não é recomendado. Normalmente, é preferível tornar essas classes públicas.
@end deffn

@node Auxiliares de introspecção,Constante,Funções e decoradores,Conteúdo do módulo<7>
@anchor{library/typing introspection-helpers}@anchor{41c8}
@subsubsection Auxiliares de introspecção


@geindex get_type_hints() (no módulo typing)
@anchor{library/typing typing get_type_hints}@anchor{6b1}
@deffn {Função} typing.get_type_hints (obj, globalns=None, localns=None, include_extras=False)

Retorna um dicionário contendo dicas de tipo para uma função, método, módulo ou objeto classe.

Geralmente é o mesmo que @code{obj.__annotations__}, mas esta função faz as seguintes alterações no dicionário de anotações:


@itemize *

@item 
Referências futuras codificadas como literais de string ou objetos @ref{1964,,ForwardRef} são tratados avaliando-as em `globalns', `localns' e (quando aplicável) no espaço de nomes de @ref{2b3,,parâmetro de tipo} de `obj'. Se `globalns' ou `localns' não forem fornecidos, os dicionários de espaço de nomes apropriados serão inferidos de `obj'.

@item 
@code{None} é substituído por @ref{855,,types.NoneType}.

@item 
Se @ref{6b4,,@@no_type_check} tiver sido aplicada a `obj', será retornado um dicionário vazio.

@item 
Se `obj' for uma classe @code{C}, a função retorna um dicionário que mescla anotações das classes base de @code{C} com as de @code{C} diretamente. Isso é feito percorrendo @ref{20bb,,C.__mro__} e combinando iterativamente os dicionários @code{__annotations__}. Anotações em classes que aparecem antes na @ref{2316,,ordem de resolução de métodos} sempre tem precedência sobre anotações em classes que aparecem depois no ordem de resolução de métodos.

@item 
A função substitui recursivamente todas as ocorrências de @code{Annotated[T, ...]}, @code{Required[T]}, @code{NotRequired[T]} e @code{ReadOnly[T]} por @code{T}, a menos que `include_extras' seja definido como @code{True} (consulte @ref{944,,Annotated} para obter mais informações).
@end itemize

Veja também @ref{816,,inspect.get_annotations()}, uma função de nível mais baixo que retorna anotações mais diretamente.

@cartouche
@quotation Nota 
Se alguma referência futura nas anotações de `obj' não for resolvível ou não for código Python válido, esta função levantará uma exceção como @ref{43f,,NameError}. Por exemplo, isso pode acontecer com @ref{454,,apelidos de tipo} importados que incluem referências futuras, ou com nomes importados em @ref{d15,,if TYPE_CHECKING}.
@end quotation
@end cartouche


Alterado na versão 3.9: Adiciona o parâmetro @code{include_extras} como parte da 
@geindex Propostas de Melhorias do Python; PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}. Consulte a documentação em @ref{944,,Annotated} para mais informações.



Alterado na versão 3.11: Anteriormente, @code{Optional[t]} era adicionado a anotações de funções e métodos se um valor padrão igual a @code{None} fosse definido. Agora, a anotação é retornada inalterada.

@end deffn

@geindex get_origin() (no módulo typing)
@anchor{library/typing typing get_origin}@anchor{2ec}
@deffn {Função} typing.get_origin (tp)

Obtenha o versão sem subscrição de um tipo: para um objeto cujo tipo tem a forma @code{X[Y, Z, ...]}, retorna @code{X} .

Se @code{X} for um apelido do módulo typing para uma classe embutida ou classe de @ref{1d,,collections}, ele será normalizado para a classe original. Se @code{X} for uma instância de @ref{7c7,,ParamSpecArgs} ou @ref{7c8,,ParamSpecKwargs}, retorna o @ref{15e,,ParamSpec} subjacente. Retorna @code{None} para objetos incompatíveis.

Exemplos:

@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


Adicionado na versão 3.8.

@end deffn

@geindex get_args() (no módulo typing)
@anchor{library/typing typing get_args}@anchor{2ed}
@deffn {Função} typing.get_args (tp)

Obtenha os argumentos de tipos com todas as substituições realizadas: para um objeto cujo tipo tem a forma @code{X[Y, Z, ...]}, retorna @code{(Y, Z, ...)} .

Se @code{X} for uma união ou um @ref{858,,Literal}, e estiver contido em outro tipo genérico, a ordem de @code{(Y, Z, ...)} poderá ser diferente da ordem dos argumentos originais @code{[Y, Z, ...]} devido ao armazenamento dos tipos em cache. Retorna @code{()} para objetos sem suporte.

Exemplos:

@example
assert get_args(int) == ()
assert get_args(Dict[int, str]) == (int, str)
assert get_args(Union[int, str]) == (int, str)
@end example


Adicionado na versão 3.8.

@end deffn

@geindex get_protocol_members() (no módulo typing)
@anchor{library/typing typing get_protocol_members}@anchor{263}
@deffn {Função} typing.get_protocol_members (tp)

Retorna o conjunto de membros definidos em um @ref{264,,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

Levanta @ref{2c3,,TypeError} para argumentos que não são protocolos.


Adicionado na versão 3.13.

@end deffn

@geindex is_protocol() (no módulo typing)
@anchor{library/typing typing is_protocol}@anchor{265}
@deffn {Função} typing.is_protocol (tp)

Determina se um tipo é um @ref{264,,Protocol}.

Por exemplo:

@example
class P(Protocol):
    def a(self) -> str: ...
    b: int

is_protocol(P)    # => True
is_protocol(int)  # => False
@end example


Adicionado na versão 3.13.

@end deffn

@geindex is_typeddict() (no módulo typing)
@anchor{library/typing typing is_typeddict}@anchor{859}
@deffn {Função} typing.is_typeddict (tp)

Verifica se um tipo é um @ref{162,,TypedDict}.

Por exemplo:

@example
class Film(TypedDict):
    title: str
    year: int

assert is_typeddict(Film)
assert not is_typeddict(list | str)

# TypedDict é uma fábrica para criar dicionários tipados
# e não um dicionário tipado em si.
assert not is_typeddict(TypedDict)
@end example


Adicionado na versão 3.10.

@end deffn

@geindex ForwardRef (classe em typing)
@anchor{library/typing typing ForwardRef}@anchor{1964}
@deffn {Classe} typing.ForwardRef

Classe usada para representação de tipagem interna de referências futuras como strings.

Por exemplo, o tipo @code{List["SomeClass"]} é implicitamente transformado em @code{List[ForwardRef("SomeClass")]}. @code{ForwardRef} não deve ser instanciado por um usuário, mas pode ser usado por ferramentas de introspecção.

@cartouche
@quotation Nota 
Tipos genéricos da 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} como @code{list["SomeClass"]} não serão transformados implicitamente em @code{list[ForwardRef("SomeClass")]} e, portanto, não serão resolvidos automaticamente para @code{list[SomeClass]}.
@end quotation
@end cartouche


Adicionado na versão 3.7.4.

@end deffn

@geindex NoDefault (no módulo typing)
@anchor{library/typing typing NoDefault}@anchor{262}
@deffn {Dado} typing.NoDefault

Um objeto sinalizador usado para indicar que um parâmetro de tipo não possui valor-padrão. Por exemplo:

@example
>>> T = TypeVar("T")
>>> T.__default__ is typing.NoDefault
True
>>> S = TypeVar("S", default=None)
>>> S.__default__ is None
True
@end example


Adicionado na versão 3.13.

@end deffn

@node Constante,Apelidos descontinuados,Auxiliares de introspecção,Conteúdo do módulo<7>
@anchor{library/typing constant}@anchor{41c9}
@subsubsection Constante


@geindex TYPE_CHECKING (no módulo typing)
@anchor{library/typing typing TYPE_CHECKING}@anchor{d15}
@deffn {Dado} typing.TYPE_CHECKING

Uma constante especial presumida ser @code{True} por verificadores de tipo estático de terceiros. É @code{False} em tempo de execução.

Uso:

@example
if TYPE_CHECKING:
    import expensive_mod

def fun(arg: 'expensive_mod.SomeType') -> None:
    local_var: expensive_mod.AnotherType = other_fun()
@end example

A primeira anotação de tipo deve ser colocada entre aspas, tornando-a uma “referência futura”, para esconder do interpretador a referência ao módulo @code{expensive_mod}. As anotações de tipos em variáveis locais não são avaliadas, então a segunda anotação não precisa ser colocada entre aspas.

@cartouche
@quotation Nota 
Se @code{from __future__ import annotations} for usado, anotações não serão avaliadas no momento de definição de funções. Em vez disso, elas são armazenadas como string em @code{__annotations__}. Isso torna desnecessário o uso de aspas em anotações (consulte 
@geindex Propostas de Melhorias do Python; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}).
@end quotation
@end cartouche


Adicionado na versão 3.5.2.

@end deffn
@anchor{library/typing generic-concrete-collections}@anchor{41ca}
@node Apelidos descontinuados,,Constante,Conteúdo do módulo<7>
@anchor{library/typing deprecated-aliases}@anchor{41cb}@anchor{library/typing id6}@anchor{41cc}
@subsubsection Apelidos descontinuados


Este módulo define vários apelidos descontinuados de classes pré-existentes da biblioteca padrão. Originalmente, elas eram incluídas no módulo @code{typing} para permitir a parametrização dessas classes genéricas usando @code{[]}. Porém, os apelidos se tornaram redundantes no Python 3.9, quando as classes pré-existentes correspondentes passaram a dar suporte a @code{[]} (consulte a 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}).

Os tipos redundantes estão descontinuados desde Python 3.9. No entanto, enquanto os apelidos podem ser removidos em algum momento, essa remoção desses apelidos não está planejada. Assim, nenhum aviso de descontinuação será enviado pelo interpretador para esses apelidos.

Se em algum momento decidirem remover esses apelidos descontinuados, o interpretador emitirá um aviso de descontinuação por, no mínimo, duas versões de lançamento antes da remoção. Os apelidos são garantidos a permanecerem no módulo @code{typing} sem avisos de descontinuação até, no mínimo, Python 3.14.

Verificadores de tipos são encorajados a sinalizar o uso de tipos descontinuados se o programa que estão verificando respeita uma versão mínima de Python 3.9 ou mais nova.

@menu
* Apelidos de tipos embutidos:: 
* Apelidos para tipos em collections:: 
* Apelidos de outros tipos concretos:: 
* Apelidos de contêineres ABC em collections.abc.: Apelidos de contêineres ABC em collections abc. 
* Apelidos para ABCs assíncronas em collections.abc: Apelidos para ABCs assíncronas em collections abc. 
* Apelidos para outros ABCs em collections.abc.: Apelidos para outros ABCs em collections abc. 
* Apelidos de ABCs da contextlib:: 

@end menu

@node Apelidos de tipos embutidos,Apelidos para tipos em collections,,Apelidos descontinuados
@anchor{library/typing aliases-to-built-in-types}@anchor{41cd}@anchor{library/typing corresponding-to-built-in-types}@anchor{41ce}
@subsubsection Apelidos de tipos embutidos


@geindex Dict (classe em typing)
@anchor{library/typing typing Dict}@anchor{41cf}
@deffn {Classe} typing.Dict (dict, MutableMapping[KT, VT])

Apelido descontinuado de @ref{256,,dict}.

Note que, para anotar argumentos, prefere-se usar um tipo de coleção abstrata como @ref{8d0,,Mapping} em vez de @ref{256,,dict} ou @code{typing.Dict}.


Descontinuado desde a versão 3.9: @ref{256,,builtins.dict} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex List (classe em typing)
@anchor{library/typing typing List}@anchor{41d0}
@deffn {Classe} typing.List (list, MutableSequence[T])

Apelido descontinuado de @ref{611,,list}.

Note que, para anotar argumentos, é preferível usar um tipo de coleção abstrata, como @ref{1204,,Sequence} ou @ref{23e2,,Iterable}, em vez de @ref{611,,list} ou @code{typing.List}.


Descontinuado desde a versão 3.9: @ref{611,,builtins.list} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Set (classe em typing)
@anchor{library/typing typing Set}@anchor{41d1}
@deffn {Classe} typing.Set (set, MutableSet[T])

Apelido descontinuado de @ref{5d9,,builtins.set}.

Note que, para anotar argumentos, prefere-se usar um tipo de coleção abstrata como @ref{23da,,collections.abc.Set} em vez de @ref{5d9,,set} ou @ref{41d1,,typing.Set}.


Descontinuado desde a versão 3.9: @ref{5d9,,builtins.set} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex FrozenSet (classe em typing)
@anchor{library/typing typing FrozenSet}@anchor{41d2}
@deffn {Classe} typing.FrozenSet (frozenset, AbstractSet[T_co])

Apelido descontinuado de @ref{5da,,builtins.frozenset}.


Descontinuado desde a versão 3.9: @ref{5da,,builtins.frozenset} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Tuple (no módulo typing)
@anchor{library/typing typing Tuple}@anchor{41d3}
@deffn {Dado} typing.Tuple

Apelido descontinuado para @ref{370,,tuple}.

@ref{370,,tuple} e @code{Tuple} são casos especiais no sistema de tipos; consulte @ref{2405,,Anotando tuplas} para obter mais detalhes.


Descontinuado desde a versão 3.9: @ref{370,,builtins.tuple} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Type (classe em typing)
@anchor{library/typing typing Type}@anchor{4192}
@deffn {Classe} typing.Type (Generic[CT_co])

Apelido descontinuado de @ref{d6b,,type}.

Consulte @ref{4191,,O tipo de objetos de classe} para obter detalhes sobre como usar @ref{d6b,,type} ou @code{typing.Type} em anotações de tipos.


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.9: @ref{d6b,,builtins.type} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@node Apelidos para tipos em collections,Apelidos de outros tipos concretos,Apelidos de tipos embutidos,Apelidos descontinuados
@anchor{library/typing aliases-to-types-in-collections}@anchor{41d4}@anchor{library/typing corresponding-to-types-in-collections}@anchor{41d5}
@subsubsection Apelidos para tipos em @code{collections}


@geindex DefaultDict (classe em typing)
@anchor{library/typing typing DefaultDict}@anchor{41d6}
@deffn {Classe} typing.DefaultDict (collections.defaultdict, MutableMapping[KT, VT])

Apelido descontinuado de @ref{11fc,,collections.defaultdict}.


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.9: @ref{11fc,,collections.defaultdict} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex OrderedDict (classe em typing)
@anchor{library/typing typing OrderedDict}@anchor{41d7}
@deffn {Classe} typing.OrderedDict (collections.OrderedDict, MutableMapping[KT, VT])

Apelido descontinuado de @ref{5db,,collections.OrderedDict}.


Adicionado na versão 3.7.2.



Descontinuado desde a versão 3.9: @ref{5db,,collections.OrderedDict} agora oferece suporte a subscrição (@code{[]}). consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex ChainMap (classe em typing)
@anchor{library/typing typing ChainMap}@anchor{41d8}
@deffn {Classe} typing.ChainMap (collections.ChainMap, MutableMapping[KT, VT])

Apelido descontinuado de @ref{c36,,collections.ChainMap}.


Adicionado na versão 3.6.1.



Descontinuado desde a versão 3.9: @ref{c36,,collections.ChainMap} agora oferece suporte a subscrição (@code{[]}). consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Counter (classe em typing)
@anchor{library/typing typing Counter}@anchor{41d9}
@deffn {Classe} typing.Counter (collections.Counter, Dict[T, int])

Apelido descontinuado de @ref{10d0,,collections.Counter}.


Adicionado na versão 3.6.1.



Descontinuado desde a versão 3.9: @ref{10d0,,collections.Counter} agora oferece suporte a subscrição (@code{[]}). consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Deque (classe em typing)
@anchor{library/typing typing Deque}@anchor{41da}
@deffn {Classe} typing.Deque (deque, MutableSequence[T])

Apelido descontinuado de @ref{5dc,,collections.deque}.


Adicionado na versão 3.6.1.



Descontinuado desde a versão 3.9: @ref{5dc,,collections.deque} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@node Apelidos de outros tipos concretos,Apelidos de contêineres ABC em collections abc,Apelidos para tipos em collections,Apelidos descontinuados
@anchor{library/typing aliases-to-other-concrete-types}@anchor{41db}@anchor{library/typing other-concrete-types}@anchor{41dc}
@subsubsection Apelidos de outros tipos concretos


@geindex Pattern (classe em typing)
@geindex Match (classe em typing)
@anchor{library/typing typing Pattern}@anchor{72c}
@deffn {Classe} typing.Pattern
@anchor{library/typing typing Match}@anchor{41dd}
@deffnx {Classe} typing.Match

Apelidos descontinuados correspondem aos tipos de retorno de @ref{bee,,re.compile()} e @ref{126e,,re.match()}.

Esses tipos (e as funções correspondentes) são genéricas sobre @ref{2b2,,AnyStr}. @code{Pattern} pode ser especializado como @code{Pattern[str]} ou @code{Pattern[bytes]}; @code{Match} pode ser especializado como @code{Match[str]} ou @code{Match[bytes]}.


Descontinuado desde a versão 3.9: Classes @code{Pattern} e @code{Match} de @ref{b9,,re} agora suporte @code{[]}. Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Text (classe em typing)
@anchor{library/typing typing Text}@anchor{30b}
@deffn {Classe} typing.Text

Apelido descontinuado de @ref{44c,,str}.

@code{Text} é fornecida para servir como um caminho compatível com versões futuras para código em Python 2: no Python 2, @code{Text} é um apelido para @code{unicode}.

Use @code{Text} para indicar que um valor deve conter uma string unicode de forma compatível com Python 2 e Python 3:

@example
def add_unicode_checkmark(text: Text) -> Text:
    return text + u' \u2713'
@end example


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.11: Python 2 deixou de receber suporte, e a maioria dos verificadores de tipos também não oferece suporte à verificação de tipos de código de Python 2. A remoção do apelido não está planejada no momento, mas os usuários são incentivados a usar @ref{44c,,str} em vez de @code{Text}.

@end deffn
@anchor{library/typing abstract-base-classes}@anchor{41de}
@node Apelidos de contêineres ABC em collections abc,Apelidos para ABCs assíncronas em collections abc,Apelidos de outros tipos concretos,Apelidos descontinuados
@anchor{library/typing aliases-to-container-abcs-in-collections-abc}@anchor{41df}@anchor{library/typing corresponding-to-collections-in-collections-abc}@anchor{41e0}
@subsubsection Apelidos de contêineres ABC em @code{collections.abc}.


@geindex AbstractSet (classe em typing)
@anchor{library/typing typing AbstractSet}@anchor{41e1}
@deffn {Classe} typing.AbstractSet (Collection[T_co])

Apelido descontinuado de @ref{23da,,collections.abc.Set}.


Descontinuado desde a versão 3.9: @ref{23da,,collections.abc.Set} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex ByteString (classe em typing)
@anchor{library/typing typing ByteString}@anchor{2ee}
@deffn {Classe} typing.ByteString (Sequence[int])

Apelido descontinuado para @ref{2e7,,collections.abc.ByteString}.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

See 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} for more details.


Descontinuado desde a versão 3.9, será removido na versão 3.17.

@end deffn

@geindex Collection (classe em typing)
@anchor{library/typing typing Collection}@anchor{d14}
@deffn {Classe} typing.Collection (Sized, Iterable[T_co], Container[T_co])

Apelido descontinuado de @ref{ca5,,collections.abc.Collection}.


Adicionado na versão 3.6.



Descontinuado desde a versão 3.9: @ref{ca5,,collections.abc.Collection} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Container (classe em typing)
@anchor{library/typing typing Container}@anchor{41e2}
@deffn {Classe} typing.Container (Generic[T_co])

Apelido descontinuado de @ref{23e4,,collections.abc.Container}.


Descontinuado desde a versão 3.9: @ref{23e4,,collections.abc.Container} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex ItemsView (classe em typing)
@anchor{library/typing typing ItemsView}@anchor{41e3}
@deffn {Classe} typing.ItemsView (MappingView, AbstractSet[tuple[KT_co, VT_co]])

Apelido descontinuado de @ref{23e8,,collections.abc.ItemsView}.


Descontinuado desde a versão 3.9: @ref{23e8,,collections.abc.ItemsView} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex KeysView (classe em typing)
@anchor{library/typing typing KeysView}@anchor{41e4}
@deffn {Classe} typing.KeysView (MappingView, AbstractSet[KT_co])

Apelido descontinuado de @ref{23e7,,collections.abc.KeysView}.


Descontinuado desde a versão 3.9: @ref{23e7,,collections.abc.KeysView} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Mapping (classe em typing)
@anchor{library/typing typing Mapping}@anchor{41e5}
@deffn {Classe} typing.Mapping (Collection[KT], Generic[KT, VT_co])

Apelido descontinuado de @ref{8d0,,collections.abc.Mapping}.


Descontinuado desde a versão 3.9: @ref{8d0,,collections.abc.Mapping} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex MappingView (classe em typing)
@anchor{library/typing typing MappingView}@anchor{41e6}
@deffn {Classe} typing.MappingView (Sized)

Apelido descontinuado de @ref{23e6,,collections.abc.MappingView}.


Descontinuado desde a versão 3.9: @ref{23e6,,collections.abc.MappingView} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex MutableMapping (classe em typing)
@anchor{library/typing typing MutableMapping}@anchor{41e7}
@deffn {Classe} typing.MutableMapping (Mapping[KT, VT])

Apelido descontinuado de @ref{10eb,,collections.abc.MutableMapping}.


Descontinuado desde a versão 3.9: @ref{10eb,,collections.abc.MutableMapping} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex MutableSequence (classe em typing)
@anchor{library/typing typing MutableSequence}@anchor{41e8}
@deffn {Classe} typing.MutableSequence (Sequence[T])

Apelido descontinuado de @ref{1a1,,collections.abc.MutableSequence}.


Descontinuado desde a versão 3.9: @ref{1a1,,collections.abc.MutableSequence} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex MutableSet (classe em typing)
@anchor{library/typing typing MutableSet}@anchor{41e9}
@deffn {Classe} typing.MutableSet (AbstractSet[T])

Apelido descontinuado de @ref{23e5,,collections.abc.MutableSet}.


Descontinuado desde a versão 3.9: @ref{23e5,,collections.abc.MutableSet} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Sequence (classe em typing)
@anchor{library/typing typing Sequence}@anchor{41ea}
@deffn {Classe} typing.Sequence (Reversible[T_co], Collection[T_co])

Apelido descontinuado de @ref{1204,,collections.abc.Sequence}.


Descontinuado desde a versão 3.9: @ref{1204,,collections.abc.Sequence} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex ValuesView (classe em typing)
@anchor{library/typing typing ValuesView}@anchor{41eb}
@deffn {Classe} typing.ValuesView (MappingView, Collection[_VT_co])

Apelido descontinuado de @ref{23e9,,collections.abc.ValuesView}.


Descontinuado desde a versão 3.9: @ref{23e9,,collections.abc.ValuesView} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@node Apelidos para ABCs assíncronas em collections abc,Apelidos para outros ABCs em collections abc,Apelidos de contêineres ABC em collections abc,Apelidos descontinuados
@anchor{library/typing aliases-to-asynchronous-abcs-in-collections-abc}@anchor{41ec}@anchor{library/typing asynchronous-programming}@anchor{41ed}
@subsubsection Apelidos para ABCs assíncronas em @code{collections.abc}


@geindex Coroutine (classe em typing)
@anchor{library/typing typing Coroutine}@anchor{1abe}
@deffn {Classe} typing.Coroutine (Awaitable[ReturnType], Generic[YieldType, SendType, ReturnType])

Apelido descontinuado de @ref{e07,,collections.abc.Coroutine}.

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @ref{e07,,collections.abc.Coroutine} e @code{typing.Coroutine} em anotações de tipos.


Adicionado na versão 3.5.3.



Descontinuado desde a versão 3.9: @ref{e07,,collections.abc.Coroutine} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex AsyncGenerator (classe em typing)
@anchor{library/typing typing AsyncGenerator}@anchor{1718}
@deffn {Classe} typing.AsyncGenerator (AsyncIterator[YieldType], Generic[YieldType, SendType])

Apelido descontinuado de @ref{ca8,,collections.abc.AsyncGenerator}.

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @ref{ca8,,collections.abc.AsyncGenerator} e @code{typing.AsyncGenerator} em anotações de tipos.


Adicionado na versão 3.6.1.



Descontinuado desde a versão 3.9: @ref{ca8,,collections.abc.AsyncGenerator} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.



Alterado na versão 3.13: O parâmetro @code{SendType} agora tem um valor-padrão.

@end deffn

@geindex AsyncIterable (classe em typing)
@anchor{library/typing typing AsyncIterable}@anchor{41ee}
@deffn {Classe} typing.AsyncIterable (Generic[T_co])

Apelido descontinuado de @ref{e09,,collections.abc.AsyncIterable}.


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.9: @ref{e09,,collections.abc.AsyncIterable} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex AsyncIterator (classe em typing)
@anchor{library/typing typing AsyncIterator}@anchor{41ef}
@deffn {Classe} typing.AsyncIterator (AsyncIterable[T_co])

Apelido descontinuado de @ref{e08,,collections.abc.AsyncIterator}.


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.9: @ref{e08,,collections.abc.AsyncIterator} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Awaitable (classe em typing)
@anchor{library/typing typing Awaitable}@anchor{41f0}
@deffn {Classe} typing.Awaitable (Generic[T_co])

Apelido descontinuado de @ref{e06,,collections.abc.Awaitable}.


Adicionado na versão 3.5.2.



Descontinuado desde a versão 3.9: @ref{e06,,collections.abc.Awaitable} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@node Apelidos para outros ABCs em collections abc,Apelidos de ABCs da contextlib,Apelidos para ABCs assíncronas em collections abc,Apelidos descontinuados
@anchor{library/typing aliases-to-other-abcs-in-collections-abc}@anchor{41f1}@anchor{library/typing corresponding-to-other-types-in-collections-abc}@anchor{41f2}
@subsubsection Apelidos para outros ABCs em @code{collections.abc}.


@geindex Iterable (classe em typing)
@anchor{library/typing typing Iterable}@anchor{41f3}
@deffn {Classe} typing.Iterable (Generic[T_co])

Apelido descontinuado de @ref{23e2,,collections.abc.Iterable}.


Descontinuado desde a versão 3.9: @ref{23e2,,collections.abc.Iterable} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Iterator (classe em typing)
@anchor{library/typing typing Iterator}@anchor{41f4}
@deffn {Classe} typing.Iterator (Iterable[T_co])

Apelido descontinuado de @ref{23e3,,collections.abc.Iterator}.


Descontinuado desde a versão 3.9: @ref{23e3,,collections.abc.Iterator} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Callable (no módulo typing)
@anchor{library/typing typing Callable}@anchor{7c6}
@deffn {Dado} typing.Callable

Apelido descontinuado de @ref{7ec,,collections.abc.Callable}.

Veja @ref{2404,,Anotações de objetos chamáveis} para detalhes sobre como usar @ref{7ec,,collections.abc.Callable} e @code{typing.Callable} em anotações de tipo.


Descontinuado desde a versão 3.9: @ref{7ec,,collections.abc.Callable} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.



Alterado na versão 3.10: @code{Callable} agora oferece suporte a @ref{15e,,ParamSpec} e @ref{7c5,,Concatenate}. Veja 
@geindex Propostas de Melhorias do Python; PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} para mais detalhes.

@end deffn

@geindex Generator (classe em typing)
@anchor{library/typing typing Generator}@anchor{1717}
@deffn {Classe} typing.Generator (Iterator[YieldType], Generic[YieldType, SendType, ReturnType])

Apelido descontinuado de @ref{e05,,collections.abc.Generator}.

Consulte @ref{26cd,,Anotando geradores e corrotinas} para obter detalhes sobre como usar @ref{e05,,collections.abc.Generator} e @code{typing.Generator} em anotações de tipos.


Descontinuado desde a versão 3.9: @ref{e05,,collections.abc.Generator} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.



Alterado na versão 3.13: Adiciona valores-padrão para os tipos de envio e retorno.

@end deffn

@geindex Hashable (classe em typing)
@anchor{library/typing typing Hashable}@anchor{4f3}
@deffn {Classe} typing.Hashable

Apelido descontinuado de @ref{4f5,,collections.abc.Hashable}.


Descontinuado desde a versão 3.12: Use @ref{4f5,,collections.abc.Hashable} diretamente.

@end deffn

@geindex Reversible (classe em typing)
@anchor{library/typing typing Reversible}@anchor{41f5}
@deffn {Classe} typing.Reversible (Iterable[T_co])

Apelido descontinuado de @ref{ca6,,collections.abc.Reversible}.


Descontinuado desde a versão 3.9: @ref{ca6,,collections.abc.Reversible} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.

@end deffn

@geindex Sized (classe em typing)
@anchor{library/typing typing Sized}@anchor{4f4}
@deffn {Classe} typing.Sized

Apelido descontinuado de @ref{4f6,,collections.abc.Sized}.


Descontinuado desde a versão 3.12: Use @ref{4f6,,collections.abc.Sized} diretamente.

@end deffn

@node Apelidos de ABCs da contextlib,,Apelidos para outros ABCs em collections abc,Apelidos descontinuados
@anchor{library/typing aliases-to-contextlib-abcs}@anchor{41f6}@anchor{library/typing context-manager-types}@anchor{41f7}
@subsubsection Apelidos de ABCs da @code{contextlib}


@geindex ContextManager (classe em typing)
@anchor{library/typing typing ContextManager}@anchor{cac}
@deffn {Classe} typing.ContextManager (Generic[T_co, ExitT_co])

Apelido descontinuado de @ref{cab,,contextlib.AbstractContextManager}.

O primeiro parâmetro de tipo, @code{T_co}, representa o tipo retornado pelo método @ref{5c8,,__enter__()}. O segundo parâmetro opcional de tipo, @code{ExitT_co}, cujo valor-padrão é @code{bool | None}, representa o tipo retornado pelo método @ref{1344,,__exit__()}.


Adicionado na versão 3.5.4.



Descontinuado desde a versão 3.9: @ref{cab,,contextlib.AbstractContextManager} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.



Alterado na versão 3.13: Adiciona o segundo parâmetro opcional de tipo, @code{ExitT_co}.

@end deffn

@geindex AsyncContextManager (classe em typing)
@anchor{library/typing typing AsyncContextManager}@anchor{1715}
@deffn {Classe} typing.AsyncContextManager (Generic[T_co, AExitT_co])

Apelido descontinuado de @ref{b3d,,contextlib.AbstractAsyncContextManager}.

O primeiro parâmetro de tipo, @code{T_co}, representa o tipo retornado pelo método @ref{215e,,__aenter__()}. O segundo parâmetro opcional de tipo, @code{AExitT_co}, cujo valor-padrão é @code{bool | None}, representa o tipo retornado pelo método @ref{1716,,__aexit__()}.


Adicionado na versão 3.6.2.



Descontinuado desde a versão 3.9: @ref{b3d,,contextlib.AbstractAsyncContextManager} agora oferece suporte a subscrição (@code{[]}). Consulte 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} e @ref{6b2,,Tipo Generic Alias}.



Alterado na versão 3.13: Adiciona o segundo parâmetro opcional de tipo, @code{AExitT_co}.

@end deffn

@node Cronograma de descontinuação dos principais recursos,,Conteúdo do módulo<7>,typing — Suporte para dicas de tipo
@anchor{library/typing deprecation-timeline-of-major-features}@anchor{41f8}
@subsubsection Cronograma de descontinuação dos principais recursos


Alguns recursos em @code{typing} estão descontinuados e podem ser removidos em uma versão futura de Python. A tabela a seguir resume as principais descontinuações para sua conveniência. Ela está sujeita a alterações, e nem todas as descontinuações estão listadas.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Recurso

@tab

Descontinuado em

@tab

Remoção planejada

@tab

PEP/issue

@item

versões @code{typing} de coleções-padrão

@tab

3.9

@tab

Não definido (consulte @ref{41cb,,apelidos descontinuados} para mais informações)

@tab

@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}

@item

@ref{2ee,,typing.ByteString}

@tab

3.9

@tab

3.17

@tab

gh-91896@footnote{https://github.com/python/cpython/issues/91896}

@item

@ref{30b,,typing.Text}

@tab

3.11

@tab

Não definido

@tab

gh-92332@footnote{https://github.com/python/cpython/issues/92332}

@item

@ref{4f3,,typing.Hashable} e @ref{4f4,,typing.Sized}

@tab

3.12

@tab

Não definido

@tab

gh-94309@footnote{https://github.com/python/cpython/issues/94309}

@item

@ref{7ca,,typing.TypeAlias}

@tab

3.12

@tab

Não definido

@tab

@geindex Propostas de Melhorias do Python; PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}

@item

@ref{2b1,,@@typing.no_type_check_decorator}

@tab

3.13

@tab

3.15

@tab

gh-106309@footnote{https://github.com/python/cpython/issues/106309}

@item

@ref{2b2,,typing.AnyStr}

@tab

3.13

@tab

3.18

@tab

gh-105578@footnote{https://github.com/python/cpython/issues/105578}

@end multitable


@node pydoc — Gerador de documentação e sistema de ajuda online,Modo de Desenvolvimento do Python,typing — Suporte para dicas de tipo,Ferramentas de Desenvolvimento
@anchor{library/pydoc doc}@anchor{41f9}@anchor{library/pydoc module-pydoc}@anchor{b5}@anchor{library/pydoc pydoc-documentation-generator-and-online-help-system}@anchor{41fa}@anchor{library/pydoc translation-repo}@anchor{41fb}
@subsection @code{pydoc} — Gerador de documentação e sistema de ajuda online


@geindex module; pydoc

`Código-fonte:' Lib/pydoc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pydoc.py}

@geindex documentação;geração
@geindex documentação;online
@geindex help;online


__________________________________________________________________


O módulo @code{pydoc} gera automaticamente a documentação dos módulos Python. A documentação pode ser apresentada como páginas de texto no console, servida em um navegador web ou salva em arquivos HTML.

Para módulos, classes, funções e métodos, a documentação exibida é derivada da docstring (ou seja, o atributo @ref{92e,,__doc__}) do objeto, e recursivamente de seus membros documentáveis. Se não houver docstring, @code{pydoc} tenta obter uma descrição do bloco de linhas de comentário logo acima da definição da classe, função ou método no arquivo fonte, ou no topo do módulo (consulte @ref{16b0,,inspect.getcomments()}).

A função embutida @ref{8dd,,help()} invoca o sistema de ajuda online no interpretador interativo, que usa @code{pydoc} para gerar sua documentação como texto no console. A mesma documentação de texto também pode ser vista de fora do interpretador Python executando @code{pydoc} como um script no prompt de comando do sistema operacional. Por exemplo, executar

@example
python -m pydoc sys
@end example

em um prompt de console exibirá a documentação do módulo @ref{d9,,sys}, em um estilo semelhante às páginas de manual mostradas pelo comando Unix @code{man}. O argumento para @code{pydoc} pode ser o nome de uma função, módulo ou pacote, ou uma referência pontilhada a uma classe, método ou função dentro de um módulo ou módulo em um pacote. Se o argumento para @code{pydoc} parecer um caminho (ou seja, ele contém o separador de caminho para o seu sistema operacional, como uma barra no Unix) e se refere a um arquivo fonte Python existente, então a documentação é produzida para esse arquivo.

@cartouche
@quotation Nota 
Para encontrar objetos e sua documentação, @code{pydoc} importa os módulos a serem documentados. Portanto, qualquer código no nível do módulo será executado nessa ocasião. Use uma proteção @code{if __name__ == '__main__':} para executar código apenas quando um arquivo é chamado como um script e não apenas importado.
@end quotation
@end cartouche

Ao imprimir a saída para o console, @code{pydoc} tenta paginar a saída para facilitar a leitura. Se a variável de ambiente 
@geindex MANPAGER
@geindex variável de ambiente; MANPAGER
@code{MANPAGER} ou a 
@geindex PAGER
@geindex variável de ambiente; PAGER
@code{PAGER} estiver definida, @code{pydoc} usará seu valor como um programa de paginação. Quando ambas estiverem definidas, 
@geindex MANPAGER
@geindex variável de ambiente; MANPAGER
@code{MANPAGER} é usada.

Especificar um sinalizador @code{-w} antes do argumento fará com que a documentação HTML seja escrita em um arquivo no diretório atual, ao invés de exibir texto no console.

Especificar um sinalizador @code{-k} antes do argumento irá pesquisar as linhas de sinopse de todos os módulos disponíveis para a palavra reservada fornecida como o argumento, novamente de uma maneira semelhante ao comando Unix @code{man}. A linha de sinopse de um módulo é a primeira linha de sua string de documentação.

Você também pode usar @code{pydoc} para iniciar um servidor HTTP na máquina local que servirá a documentação para os navegadores web visitantes. @code{python -m pydoc -p 1234} irá iniciar um servidor HTTP na porta 1234, permitindo que você navegue pela documentação em @code{http://localhost:1234/} em seu navegador preferido. Especificar @code{0} como o número da porta irá selecionar uma porta não utilizada arbitrária.

@code{python -m pydoc -n <hostname>} irá iniciar o servidor ouvindo no nome de host fornecido. Por padrão, o nome de host é “localhost”, mas se você deseja que o servidor seja acessado por outras máquinas, você pode alterar o nome de host ao qual o servidor responde. Durante o desenvolvimento, isso é especialmente útil se você deseja executar o pydoc de dentro de um contêiner.

@code{python -m pydoc -b} irá iniciar o servidor e, adicionalmente, abrir um navegador da web para uma página de índice do módulo. Cada página exibida tem uma barra de navegação na parte superior onde você pode escolher `Get' para obter ajuda em um item individual, `Search' para pesquisar todos os módulos com uma palavra reservada em sua linha de sinopse e ir para as páginas de índice do módulo em `Module index', tópicos em `Topics' e palavras reservadas em `Keywords'.

Quando @code{pydoc} gera documentação, ele usa o ambiente atual e o caminho para localizar os módulos. Assim, invocar @code{pydoc spam} documenta precisamente a versão do módulo que você obteria se iniciasse o interpretador Python e digitasse @code{import spam}.

Os documentos do módulo para os módulos principais são presumidos como residindo em @code{https://docs.python.org/X.Y/library/}, sendo @code{X} e @code{Y} os números de versão principal e secundária do interpretador Python. Isso pode ser substituído definindo a variável de ambiente @code{PYTHONDOCS} para uma URL diferente ou para um diretório local contendo as páginas do Manual de Referência da Biblioteca.


Alterado na versão 3.2: Adicionada a opção @code{-b}.



Alterado na versão 3.3: A opção de linha de comando @code{-g} foi removida.



Alterado na versão 3.4: @code{pydoc} agora usa @ref{738,,inspect.signature()} em vez de @ref{739,,inspect.getfullargspec()} para extrair informações de assinatura de chamáveis.



Alterado na versão 3.7: Adicionada a opção @code{-n}.


@node Modo de Desenvolvimento do Python,doctest — Teste exemplos interativos de Python,pydoc — Gerador de documentação e sistema de ajuda online,Ferramentas de Desenvolvimento
@anchor{library/devmode doc}@anchor{41fc}@anchor{library/devmode devmode}@anchor{1f8}@anchor{library/devmode python-development-mode}@anchor{41fd}@anchor{library/devmode translation-repo}@anchor{41fe}
@subsection Modo de Desenvolvimento do Python



Adicionado na versão 3.7.


O Modo de Desenvolvimento do Python introduz verificações de tempo de execução adicionais que são muito custosas para serem ativadas por padrão. Não deve ser mais detalhado que o padrão se o código estiver correto; novos avisos são emitidos somente quando um problema é detectado.

Ele pode ser ativado usando a opção de linha de comando @ref{176,,-X dev} ou configurando a variável de ambiente 
@geindex PYTHONDEVMODE
@geindex variável de ambiente; PYTHONDEVMODE
@ref{b00,,PYTHONDEVMODE} como @code{1}.

Veja também a @ref{1f9,,compilação de depuração do Python}.

@menu
* Efeitos do Modo de Desenvolvimento do Python:: 
* Exemplo de ResourceWarning:: 
* Exemplo de erro de descritor de arquivo inválido:: 

@end menu

@node Efeitos do Modo de Desenvolvimento do Python,Exemplo de ResourceWarning,,Modo de Desenvolvimento do Python
@anchor{library/devmode effects-of-the-python-development-mode}@anchor{41ff}
@subsubsection Efeitos do Modo de Desenvolvimento do Python


A ativação do Modo de Desenvolvimento do Python é semelhante ao comando a seguir, mas com efeitos adicionais descritos abaixo:

@example
PYTHONMALLOC=debug PYTHONASYNCIODEBUG=1 python -W default -X faulthandler
@end example

Efeitos do Modo de Desenvolvimento do Python:


@itemize *

@item 
Adiciona o @ref{1ec1,,filtro de avisos} @code{default}. Os seguintes avisos são exibidos:


@itemize *

@item 
@ref{1a5,,DeprecationWarning}

@item 
@ref{4fa,,ImportWarning}

@item 
@ref{8ce,,PendingDeprecationWarning}

@item 
@ref{244,,ResourceWarning}
@end itemize

Normalmente, os avisos acima são filtrados pelos @ref{1ec1,,filtros de avisos} padrão.

Ele se comporta como se a opção de linha de comando @ref{8cd,,-W default} fosse usada.

Use a opção de linha de comando @ref{8cd,,-W error} ou defina a variável de ambiente 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} com @code{error} para tratar avisos como erros.

@item 
Instala ganchos de depuração nos alocadores de memória para verificar por:


@itemize *

@item 
Estouro negativo de buffer

@item 
Estouro de buffer

@item 
Violação de API de alocador de memória

@item 
Uso inseguro da GIL
@end itemize

Consulte a função C @ref{c85,,PyMem_SetupDebugHooks()}.

Se comporta como se a variável de ambiente 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} estivesse definida com @code{debug}.

Para habilitar o Modo de Desenvolvimento do Python sem instalar ganchos de depuração nos alocadores de memória, defina a variável de ambiente 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} como @code{default}.

@item 
Chama @ref{cbe,,faulthandler.enable()} na inicialização do Python para instalar manipuladores para os sinais @ref{10b9,,SIGSEGV}, @ref{10ba,,SIGFPE}, @ref{10bb,,SIGABRT}, @ref{10bc,,SIGBUS} e @ref{10bd,,SIGILL} para despejar o traceback (situação da pilha de execução) do Python no caso de travamento.

Ele se comporta como se a opção de linha de comando @ref{176,,-X faulthandler} fosse usada ou se a variável de ambiente 
@geindex PYTHONFAULTHANDLER
@geindex variável de ambiente; PYTHONFAULTHANDLER
@ref{10be,,PYTHONFAULTHANDLER} estivesse definida como @code{1}.

@item 
Ativa o @ref{1ed3,,modo de depuração de asyncio}. Por exemplo, @ref{a,,asyncio} verifica as corrotinas que não foram aguardadas (`await') e as registra.

Ele se comporta como se a variável de ambiente 
@geindex PYTHONASYNCIODEBUG
@geindex variável de ambiente; PYTHONASYNCIODEBUG
@ref{1ed2,,PYTHONASYNCIODEBUG} estivesse definida como @code{1}.

@item 
Verifica os argumentos `encoding' e `errors' para operações de codificação e decodificação de strings. Exemplos: @ref{51c,,open()}, @ref{8db,,str.encode()} e @ref{8dc,,bytes.decode()}.

Por padrão, para obter o melhor desempenho, o argumento `errors' é verificado apenas no primeiro erro de codificação/decodificação, e o argumento `encoding' às vezes é ignorado para strings vazias.

@item 
O destrutor de @ref{1f5,,io.IOBase} registra exceções @code{close()}.

@item 
Define o atributo @ref{1c1b,,dev_mode} de @ref{68c,,sys.flags} como @code{True}.
@end itemize

O Modo de Desenvolvimento do Python não ativa o módulo @ref{ff,,tracemalloc} por padrão porque o custo adicional (para desempenho e memória) seria muito grande. A ativação do módulo @ref{ff,,tracemalloc} fornece informações adicionais sobre a origem de alguns erros. Por exemplo, @ref{244,,ResourceWarning} registra o retorno ao local onde o recurso foi alocado, e um erro de estouro de buffer registra o retorno ao local onde o bloco de memória foi alocado.

O Modo de Desenvolvimento do Python não impede que a opção de linha de comando @ref{ddd,,-O} remova as instruções @ref{96f,,assert} nem configure @ref{7db,,__debug__} como @code{False}.

O Modo de Desenvolvimento do Python só pode ser ativado na inicialização do Python. Seu valor pode ser lido de @ref{68c,,sys.flags.dev_mode}.


Alterado na versão 3.8: O destrutor de @ref{1f5,,io.IOBase} agora registra exceções @code{close()}.



Alterado na versão 3.9: Os argumentos `encoding' e `errors' agora são verificados para operações de codificação e decodificação de strings.


@node Exemplo de ResourceWarning,Exemplo de erro de descritor de arquivo inválido,Efeitos do Modo de Desenvolvimento do Python,Modo de Desenvolvimento do Python
@anchor{library/devmode resourcewarning-example}@anchor{4200}
@subsubsection Exemplo de ResourceWarning


Exemplo de um script que conta o número de linhas do arquivo texto especificado na linha de comando:

@example
import sys

def main():
    fp = open(sys.argv[1])
    nlines = len(fp.readlines())
    print(nlines)
    # O arquivo é fechado implicitamente

if __name__ == "__main__":
    main()
@end example

O script não fecha o arquivo explicitamente. Por padrão, o Python não emite nenhum aviso. Exemplo usando README.txt, que possui 269 linhas:

@example
$ python script.py README.txt
269
@end example

A ativação do Modo de Desenvolvimento do Python exibe um aviso @ref{244,,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

Além disso, ativar @ref{ff,,tracemalloc} mostra a linha em que o arquivo foi aberto:

@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

A correção é fechar explicitamente o arquivo. Exemplo usando um gerenciador de contexto:

@example
def main():
    # Fecha o arquivo explicitamente ao sair do bloco with
    with open(sys.argv[1]) as fp:
        nlines = len(fp.readlines())
    print(nlines)
@end example

Não fechar um recurso explicitamente pode deixá-lo aberto por muito mais tempo do que o esperado; isso pode causar problemas graves ao sair do Python. É ruim no CPython, mas é ainda pior no PyPy. Fechar recursos explicitamente torna uma aplicação mais determinística e mais confiável.

@node Exemplo de erro de descritor de arquivo inválido,,Exemplo de ResourceWarning,Modo de Desenvolvimento do Python
@anchor{library/devmode bad-file-descriptor-error-example}@anchor{4201}
@subsubsection Exemplo de erro de descritor de arquivo inválido


Script exibindo sua própria primeira linha:

@example
import os

def main():
    fp = open(__file__)
    firstline = fp.readline()
    print(firstline.rstrip())
    os.close(fp.fileno())
    # O arquivo é fechado explicitamente

main()
@end example

Por padrão, o Python não emite qualquer aviso:

@example
$ python script.py
import os
@end example

O Modo de Desenvolvimento do Python mostra uma @ref{244,,ResourceWarning} e registra um erro “Bad file descriptor” ao finalizar o objeto arquivo:

@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())} fecha o descritor de arquivo. Quando o finalizador de objeto arquivo tenta fechar o descritor de arquivo novamente, ele falha com o erro @code{Bad file descriptor}. Um descritor de arquivo deve ser fechado apenas uma vez. Na pior das hipóteses, fechá-lo duas vezes pode causar um acidente (consulte bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748} para um exemplo).

A correção é remover a linha @code{os.close(fp.fileno())} ou abrir o arquivo com @code{closefd=False}.

@node doctest — Teste exemplos interativos de Python,unittest — Framework de testes unitários,Modo de Desenvolvimento do Python,Ferramentas de Desenvolvimento
@anchor{library/doctest doc}@anchor{4202}@anchor{library/doctest doctest-test-interactive-python-examples}@anchor{4203}@anchor{library/doctest module-doctest}@anchor{3a}@anchor{library/doctest translation-repo}@anchor{4204}
@subsection @code{doctest} — Teste exemplos interativos de Python


@geindex module; doctest

`Código-fonte:' Lib/doctest.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/doctest.py}


__________________________________________________________________


O módulo @ref{3a,,doctest} busca partes de texto que se parecem com sessões interativas do Python e, em seguida, executa essas sessões para verificar se elas funcionam exatamente como mostrado. Existem várias maneiras comuns de usar o doctest:


@itemize *

@item 
Para verificar se as docstrings de um módulo estão atualizadas, verificando que todos os exemplos interativos ainda funcionam conforme documentado.

@item 
Para executar testes de regressão, verificando que os exemplos interativos de um arquivo de teste ou um objeto teste funcionam como esperado.

@item 
Para escrever a documentação do tutorial para um pacote, ilustrado de forma liberal com exemplos de entrada e saída. Dependendo se os exemplos ou o texto expositivo são enfatizados, isso tem o sabor do “teste ilustrado” ou “documentação executável”.
@end itemize

Aqui temos um pequeno exemplo, porém, completo:

@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

Se executar diretamente @code{example.py} desde a linha de comando, @ref{3a,,doctest} a mágica funcionará:

@example
$ python example.py
$
@end example

Observe que nada foi impresso na saída padrão! Isso é normal, e isso significa que todos os exemplos funcionaram. Passe @code{-v} para o script e @ref{3a,,doctest} imprimirá um registro detalhado do que está sendo testando imprimindo ainda um resumo no 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

E assim por diante, eventualmente terminando com:

@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

Isso é tudo o que precisas saber para começar a fazer uso produtivo do módulo @ref{3a,,doctest}! Pule! As seções a seguir fornecem detalhes completos. Observe que há muitos exemplos de doctests no conjunto de testes padrão Python e bibliotecas. Exemplos especialmente úteis podem ser encontrados no arquivo de teste padrão @code{Lib/test/test_doctest/test_doctest.py}.

@menu
* Uso simples; verificando exemplos em Docstrings: Uso simples verificando exemplos em Docstrings. 
* Utilização comum; Verificando exemplos em um arquivo texto: Utilização comum Verificando exemplos em um arquivo texto. 
* Uso na linha de comando: Uso na linha de comando<6>. 
* Como ele funciona:: 
* Basic API:: 
* API do Unittest:: 
* Advanced API:: 
* Depuração:: 
* Soapbox:: 

@end menu

@node Uso simples verificando exemplos em Docstrings,Utilização comum Verificando exemplos em um arquivo texto,,doctest — Teste exemplos interativos de Python
@anchor{library/doctest doctest-simple-testmod}@anchor{4205}@anchor{library/doctest simple-usage-checking-examples-in-docstrings}@anchor{4206}
@subsubsection Uso simples: verificando exemplos em Docstrings


A maneira mais simples de começar a usar o doctest (mas não necessariamente a maneira como você continuará fazendo isso) é encerrar cada módulo @code{M} com:

@example
if __name__ == "__main__":
    import doctest
    doctest.testmod()
@end example

@code{doctest} e então examine a docstrings no módulo @code{M}.

Executar o módulo como um script faz com que os exemplos nas docstrings sejam executados e verificados:

@example
python M.py
@end example

Isso não exibirá nada, a menos que um exemplo falhe, caso em que o(s) exemplo(s) falhando(s) e a(s) causa(s) da(s) falha(s) são impressas em stdout e a linha final de saída será @code{***Test Failed*** N failures.}, onde `N' é o número de exemplos que falharam.

Ao invés disso, execute agora com a opção @code{-v}:

@example
python M.py -v
@end example

e um relatório detalhado de todos os exemplos testados é impresso na saída padrão, junto com diversos resumos no final.

Você pode forçar o modo verboso passando @code{verbose=True} para @ref{14b5,,testmod()}, ou proibi-lo passando @code{verbose=False}. Em qualquer um desses casos, @ref{12a6,,sys.argv} não é examinado por @ref{14b5,,testmod()} (então passar @code{-v} ou não não tem efeito).

Há também um atalho de linha de comando para executar @ref{14b5,,testmod()}, veja a seção @ref{4207,,Uso na linha de comando}.

Para mais informações sobre @ref{14b5,,testmod()}, veja a seção @ref{4208,,Basic API}.

@node Utilização comum Verificando exemplos em um arquivo texto,Uso na linha de comando<6>,Uso simples verificando exemplos em Docstrings,doctest — Teste exemplos interativos de Python
@anchor{library/doctest doctest-simple-testfile}@anchor{4209}@anchor{library/doctest simple-usage-checking-examples-in-a-text-file}@anchor{420a}
@subsubsection Utilização comum: Verificando exemplos em um arquivo texto


Outra aplicação simples do doctest é testar exemplos interativos em um arquivo texto. Isso pode ser feito com a função @ref{420b,,testfile()}:

@example
import doctest
doctest.testfile("example.txt")
@end example

Esse pequeno script executa e verifica quaisquer exemplos interativos do Python contidos no arquivo @code{example.txt}. O conteúdo do arquivo é tratado como se fosse uma única docstring gigante; o arquivo não precisa conter um programa Python! Por exemplo, talvez @code{example.txt} contenha isto:

@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

Executar @code{doctest.testfile("example.txt")} então encontra o erro nesta documentação:

@example
File "./example.txt", line 14, in example.txt
Failed example:
    factorial(6)
Expected:
    120
Got:
    720
@end example

Assim como @ref{14b5,,testmod()}, @ref{420b,,testfile()} não vai exibir nada a menos que um exemplo falhe. Se um exemplo falhar, então o(s) exemplo(s) com falha e a(s) causa(s) da(s) falha(s) são impressos em stdout, usando o mesmo formato que @code{testmod()}.

Por padrão, @ref{420b,,testfile()} procura por arquivos no diretório do módulo chamador. Veja a seção @ref{4208,,Basic API} para uma descrição dos argumentos opcionais que podem ser usados para dizer para procurar por arquivos em outros locais.

Assim como @ref{14b5,,testmod()}, a verbosidade de @ref{420b,,testfile()} pode ser definida com a opção de linha de comando @code{-v} ou com o argumento nomeado opcional `verbose'.

Há também um atalho de linha de comando para executar @ref{420b,,testfile()}, veja a seção @ref{4207,,Uso na linha de comando}.

Para maiores informações em @ref{420b,,testfile()}, veja a seção @ref{4208,,Basic API}.

@node Uso na linha de comando<6>,Como ele funciona,Utilização comum Verificando exemplos em um arquivo texto,doctest — Teste exemplos interativos de Python
@anchor{library/doctest command-line-usage}@anchor{420c}@anchor{library/doctest doctest-cli}@anchor{4207}
@subsubsection Uso na linha de comando


O módulo @ref{3a,,doctest} pode ser invocado como um script na linha de comando:

@example
python -m doctest [-v] [-o OPÇÃO] [-f] arquivo [arquivo ...]
@end example

@geindex doctest opção de linha de comando; -v
@geindex doctest opção de linha de comando; --verbose
@anchor{library/doctest cmdoption-doctest-v}@anchor{420d}@anchor{library/doctest cmdoption-doctest-verbose}@anchor{420e}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

Relatório detalhado de todos os exemplos testados é impresso na saída padrão, junto com diversos resumos no final.

@example
python -m doctest -v example.py
@end example

Isso importará @code{example.py} como um módulo independente e executará @ref{14b5,,testmod()} nele. Observe que isso pode não funcionar corretamente se o arquivo fizer parte de um pacote e importar outros submódulos desse pacote.

Se o nome do arquivo não termina com @code{.py}, @code{doctest} infere que ele deve ser executado com @ref{420b,,testfile()}:

@example
python -m doctest -v example.txt
@end example
@end deffn

@geindex doctest opção de linha de comando; -o
@geindex doctest opção de linha de comando; --option
@anchor{library/doctest cmdoption-doctest-o}@anchor{420f}@anchor{library/doctest cmdoption-doctest-option}@anchor{4210}
@deffn {Option} @w{-}o, @w{-}@w{-}option <option>

Os sinalizadores de opção controlam vários aspectos do comportamento do doctest, consulte a seção @ref{f66,,Flags opcionais}.


Adicionado na versão 3.4.

@end deffn

@geindex doctest opção de linha de comando; -f
@geindex doctest opção de linha de comando; --fail-fast
@anchor{library/doctest cmdoption-doctest-f}@anchor{4211}@anchor{library/doctest cmdoption-doctest-fail-fast}@anchor{4212}
@deffn {Option} @w{-}f, @w{-}@w{-}fail@w{-}fast

Este é um atalho para @code{-o FAIL_FAST}.


Adicionado na versão 3.4.

@end deffn

@node Como ele funciona,Basic API,Uso na linha de comando<6>,doctest — Teste exemplos interativos de Python
@anchor{library/doctest doctest-how-it-works}@anchor{4213}@anchor{library/doctest how-it-works}@anchor{4214}
@subsubsection Como ele funciona


Esta seção examina detalhadamente como o doctest funciona: quais docstrings ele analisa, como encontra exemplos interativos, qual contexto de execução ele usa, como ele lida com exceções e como sinalizadores de opção podem ser usados para controlar seu comportamento. Esta é a informação que você precisa saber para escrever exemplos de doctest; para obter informações sobre como realmente executar o doctest nesses exemplos, consulte as seções a seguir.

@menu
* Quais docstrings são examinadas?:: 
* Como os exemplos de docstrings são reconhecidos?:: 
* Qual é o contexto de execução?:: 
* E quanto às exceções?:: 
* Flags opcionais:: 
* Directives:: 
* Avisos: Avisos<2>. 

@end menu

@node Quais docstrings são examinadas?,Como os exemplos de docstrings são reconhecidos?,,Como ele funciona
@anchor{library/doctest doctest-which-docstrings}@anchor{4215}@anchor{library/doctest which-docstrings-are-examined}@anchor{4216}
@subsubsection Quais docstrings são examinadas?


A docstring do módulo e todas as docstrings de funções, classes e métodos são pesquisadas. Os objetos importados para o módulo não são pesquisados.

@geindex __test__ (atributo module)
@anchor{library/doctest module __test__}@anchor{4217}
Além disso, há casos em que você deseja que os testes façam parte de um módulo, mas não do texto de ajuda, o que exige que os testes não sejam incluídos na documentação. Doctest procura uma variável em nível de módulo chamada @code{__test__} e a utiliza para localizar outros testes. Se @code{M.__test__} existir, deve ser um dicionário, e cada entrada mapeia um nome (string) para um objeto função, objeto classe ou string. As docstrings de funções e objetos classe encontradas em @code{M.__test__} são pesquisadas e as strings são tratadas como se fossem docstrings. Na saída, uma chave @code{K} em @code{M.__test__} aparece com o nome @code{M.__test__.K}.

Por exemplo, coloque este bloco de código no topo de @code{example.py}:

@example
__test__ = @{
    'numbers': """
>>> factorial(6)
720

>>> [factorial(n) for n in range(6)]
[1, 1, 2, 6, 24, 120]
"""
@}
@end example

O valor de @code{example.__test__["numbers"]} será tratado como uma docstring e todos os testes dentro dele serão executados. É importante observar que o valor pode ser mapeado para uma função, objeto classe ou módulo; se sim, @code{doctest} pesquisa recursivamente em busca de docstrings, que são então escaneados em busca de testes.

Quaisquer classes encontradas são pesquisadas recursivamente de forma semelhante, para testar docstrings em seus métodos contidos e classes aninhadas.

@cartouche
@quotation Nota 
@code{doctest} can only automatically discover classes and functions that are
defined at the module level or inside other classes.

Since nested classes and functions only exist when an outer function
is called, they cannot be discovered. Define them outside to make them visible.
@end quotation
@end cartouche

@node Como os exemplos de docstrings são reconhecidos?,Qual é o contexto de execução?,Quais docstrings são examinadas?,Como ele funciona
@anchor{library/doctest doctest-finding-examples}@anchor{4218}@anchor{library/doctest how-are-docstring-examples-recognized}@anchor{4219}
@subsubsection Como os exemplos de docstrings são reconhecidos?


Na maioria dos casos, copiar e colar de uma sessão de console interativo funciona bem, mas o doctest não está tentando fazer uma emulação exata de qualquer shell Python específico.

@example
>>> # comentários são ignorados
>>> x = 12
>>> x
12
>>> if x == 13:
...     print("yes")
... else:
...     print("no")
...     print("NO")
...     print("NO!!!")
...
no
NO
NO!!!
>>>
@end example

@geindex >>>;prompt do interpretador
@geindex ...;prompt do interpretador

Qualquer saída esperada deve seguir imediatamente a linha final @code{'>>> '} ou @code{'... '} contendo o código, e a saída esperada (se houver) se estende até a próxima @code{'>>> '} ou linha com apenas espaços em branco.

A saída formatada:


@itemize *

@item 
A saída esperada não pode conter uma linha com apenas espaços em branco, uma vez que tal linha é usada para sinalizar o fim da saída esperada. Se a saída esperada contiver uma linha vazia, coloque @code{<BLANKLINE>} em seu exemplo doctest em cada local onde uma linha em branco é esperada.

@item 
Todos os caracteres de tabulação rígidos são expandidos para espaços, usando paradas de tabulação de 8 colunas. As guias na saída gerada pelo código testado não são modificadas. Como quaisquer tabulações rígidas na saída de amostra `são' expandidas, isso significa que se a saída do código incluir tabulações rígidas, a única maneira de o doctest passar é se a opção @ref{421a,,NORMALIZE_WHITESPACE} ou a @ref{421b,,diretiva} estiver em vigor. Alternativamente, o teste pode ser reescrito para capturar a saída e compará-la com um valor esperado como parte do teste. Esse tratamento das guias na fonte foi obtido por tentativa e erro e provou ser a maneira menos propensa a erros de lidar com elas. É possível usar um algoritmo diferente para lidar com guias escrevendo uma classe @ref{421c,,DocTestParser} personalizada.

@item 
A saída para stdout é capturada, mas não para stderr (os tracebacks de exceção são capturados por um meio diferente).

@item 
Se você continuar uma linha através de barra invertida em uma sessão interativa, ou por qualquer outro motivo usar uma barra invertida, você deverá usar uma docstring bruta, que preservará suas barras invertidas exatamente como você as digita:

@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

Caso contrário, a barra invertida será interpretada como parte da string. Por exemplo, o @code{\n} acima seria interpretado como um caractere de nova linha. Alternativamente, você pode duplicar cada barra invertida na versão doctest (e não usar uma string bruta):

@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 
A coluna inicial não importa:

@example
>>> assert "Easy!"
      >>> import math
          >>> math.floor(1.9)
          1
@end example

e tantos caracteres de espaço em branco iniciais são removidos da saída esperada quantos apareceram na linha inicial @code{'>>> '} que iniciou o exemplo.
@end itemize

@node Qual é o contexto de execução?,E quanto às exceções?,Como os exemplos de docstrings são reconhecidos?,Como ele funciona
@anchor{library/doctest doctest-execution-context}@anchor{421d}@anchor{library/doctest what-s-the-execution-context}@anchor{421e}
@subsubsection Qual é o contexto de execução?


Por padrão, cada vez que @ref{3a,,doctest} encontra uma docstring para testar, ele usa uma `cópia superficial' dos globais de @code{M}, para que a execução de testes não altere os globais reais do módulo, e para que um teste em @code{M} não possa deixar migalhas que acidentalmente permitam que outro teste funcione. Isso significa que os exemplos podem usar livremente quaisquer nomes definidos no nível superior em @code{M} e nomes definidos anteriormente na docstring que está sendo executada. Os exemplos não podem ver nomes definidos em outras docstrings.

Você pode forçar o uso de seu próprio dicionário como contexto de execução passando @code{globs=seu_dicionario} para @ref{14b5,,testmod()} ou @ref{420b,,testfile()}.

@node E quanto às exceções?,Flags opcionais,Qual é o contexto de execução?,Como ele funciona
@anchor{library/doctest doctest-exceptions}@anchor{421f}@anchor{library/doctest what-about-exceptions}@anchor{4220}
@subsubsection E quanto às exceções?


Não tem problema, desde que o traceback seja a única saída produzida pelo exemplo: basta colar o traceback. @footnote{
Examples containing both expected output and an exception are not supported.
Trying to guess where one ends and the other begins is too error-prone, and that
also makes for a confusing test.
} Como os tracebacks contêm detalhes que provavelmente mudarão rapidamente (por exemplo, caminhos exatos de arquivos e números de linha), este é um caso em que o doctest trabalha duro para ser flexível no que aceita.

Exemplo simples:

@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

Esse doctest será bem-sucedido se @ref{202,,ValueError} for levantada, com o detalhe @code{list.remove(x): x not in list}, conforme mostrado.

A saída esperada para uma exceção deve começar com um cabeçalho do traceback, que pode ser qualquer uma das duas linhas a seguir, indentadas da mesma forma que a primeira linha do exemplo:

@example
Traceback (most recent call last):
Traceback (innermost last):
@end example

The traceback header is followed by an optional traceback stack, whose contents
are ignored by doctest.  The traceback stack is typically omitted, or copied
verbatim from an interactive session.

The traceback stack is followed by the most interesting part: the line(s)
containing the exception type and detail.  This is usually the last line of a
traceback, but can extend across multiple lines if the exception has a
multi-line detail:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: multi
    line
detail
@end example

The last three lines (starting with @ref{202,,ValueError}) are compared against the
exception’s type and detail, and the rest are ignored.

Best practice is to omit the traceback stack, unless it adds significant
documentation value to the example.  So the last example is probably better as:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
    ...
ValueError: multi
    line
detail
@end example

Note that tracebacks are treated very specially.  In particular, in the
rewritten example, the use of @code{...} is independent of doctest’s
@ref{14b6,,ELLIPSIS} option.  The ellipsis in that example could be left out, or
could just as well be three (or three hundred) commas or digits, or an indented
transcript of a Monty Python skit.

Some details you should read once, but won’t need to remember:


@itemize *

@item 
Doctest can’t guess whether your expected output came from an exception
traceback or from ordinary printing.  So, e.g., an example that expects
@code{ValueError: 42 is prime} will pass whether @ref{202,,ValueError} is actually
raised or if the example merely prints that traceback text.  In practice,
ordinary output rarely begins with a traceback header line, so this doesn’t
create real problems.

@item 
Each line of the traceback stack (if present) must be indented further than
the first line of the example, `or' start with a non-alphanumeric character.
The first line following the traceback header indented the same and starting
with an alphanumeric is taken to be the start of the exception detail.  Of
course this does the right thing for genuine tracebacks.

@item 
When the @ref{134d,,IGNORE_EXCEPTION_DETAIL} doctest option is specified,
everything following the leftmost colon and any module information in the
exception name is ignored.

@item 
The interactive shell omits the traceback header line for some
@ref{18d,,SyntaxError}s.  But doctest uses the traceback header line to
distinguish exceptions from non-exceptions.  So in the rare case where you need
to test a @code{SyntaxError} that omits the traceback header, you will need to
manually add the traceback header line to your test example.
@end itemize

@geindex ^ (circunflexo);marker


@itemize *

@item 
For some exceptions, Python displays the position of the error using @code{^}
markers and tildes:

@example
>>> 1 + None
  File "<stdin>", line 1
    1 + None
    ~~^~~~~~
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
@end example

Since the lines showing the position of the error come before the exception type
and detail, they are not checked by doctest.  For example, the following test
would pass, even though it puts the @code{^} marker in the wrong location:

@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{4221}
@node Flags opcionais,Directives,E quanto às exceções?,Como ele funciona
@anchor{library/doctest doctest-options}@anchor{f66}@anchor{library/doctest option-flags}@anchor{4222}
@subsubsection Flags opcionais


A number of option flags control various aspects of doctest’s behavior.
Symbolic names for the flags are supplied as module constants, which can be
@ref{2202,,bitwise ORed} together and passed to various functions.
The names can also be used in @ref{421b,,doctest directives},
and may be passed to the doctest command line interface via the @code{-o} option.

The first group of options define test semantics, controlling aspects of how
doctest decides whether actual output matches an example’s expected output:

@geindex DONT_ACCEPT_TRUE_FOR_1 (no módulo doctest)
@anchor{library/doctest doctest DONT_ACCEPT_TRUE_FOR_1}@anchor{4223}
@deffn {Dado} doctest.DONT_ACCEPT_TRUE_FOR_1

By default, if an expected output block contains just @code{1}, an actual output
block containing just @code{1} or just @code{True} is considered to be a match, and
similarly for @code{0} versus @code{False}.  When @ref{4223,,DONT_ACCEPT_TRUE_FOR_1} is
specified, neither substitution is allowed.  The default behavior caters to that
Python changed the return type of many functions from integer to boolean;
doctests expecting “little integer” output still work in these cases.  This
option will probably go away, but not for several years.
@end deffn

@geindex <BLANKLINE>

@geindex DONT_ACCEPT_BLANKLINE (no módulo doctest)
@anchor{library/doctest doctest DONT_ACCEPT_BLANKLINE}@anchor{4224}
@deffn {Dado} doctest.DONT_ACCEPT_BLANKLINE

By default, if an expected output block contains a line containing only the
string @code{<BLANKLINE>}, then that line will match a blank line in the actual
output.  Because a genuinely blank line delimits the expected output, this is
the only way to communicate that a blank line is expected.  When
@ref{4224,,DONT_ACCEPT_BLANKLINE} is specified, this substitution is not allowed.
@end deffn

@geindex NORMALIZE_WHITESPACE (no módulo doctest)
@anchor{library/doctest doctest NORMALIZE_WHITESPACE}@anchor{421a}
@deffn {Dado} doctest.NORMALIZE_WHITESPACE

When specified, all sequences of whitespace (blanks and newlines) are treated as
equal.  Any sequence of whitespace within the expected output will match any
sequence of whitespace within the actual output. By default, whitespace must
match exactly. @ref{421a,,NORMALIZE_WHITESPACE} is especially useful when a line of
expected output is very long, and you want to wrap it across multiple lines in
your source.
@end deffn

@geindex ...;in doctests

@geindex ELLIPSIS (no módulo doctest)
@anchor{library/doctest doctest ELLIPSIS}@anchor{14b6}
@deffn {Dado} doctest.ELLIPSIS

When specified, an ellipsis marker (@code{...}) in the expected output can match
any substring in the actual output.  This includes substrings that span line
boundaries, and empty substrings, so it’s best to keep usage of this simple.
Complicated uses can lead to the same kinds of “oops, it matched too much!”
surprises that @code{.*} is prone to in regular expressions.
@end deffn

@geindex IGNORE_EXCEPTION_DETAIL (no módulo doctest)
@anchor{library/doctest doctest IGNORE_EXCEPTION_DETAIL}@anchor{134d}
@deffn {Dado} doctest.IGNORE_EXCEPTION_DETAIL

When specified, doctests expecting exceptions pass so long as an exception
of the expected type is raised, even if the details
(message and fully qualified exception name) don’t match.

For example, an example expecting @code{ValueError: 42} will pass if the actual
exception raised is @code{ValueError: 3*14}, but will fail if, say, a
@ref{2c3,,TypeError} is raised instead.
It will also ignore any fully qualified name included before the
exception class, which can vary between implementations and versions
of Python and the code/libraries in use.
Hence, all three of these variations will work with the flag specified:

@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

Note that @ref{14b6,,ELLIPSIS} can also be used to ignore the
details of the exception message, but such a test may still fail based
on whether the module name is present or matches exactly.


Alterado na versão 3.2: @ref{134d,,IGNORE_EXCEPTION_DETAIL} now also ignores any information relating
to the module containing the exception under test.

@end deffn

@geindex SKIP (no módulo doctest)
@anchor{library/doctest doctest SKIP}@anchor{4225}
@deffn {Dado} doctest.SKIP

When specified, do not run the example at all.  This can be useful in contexts
where doctest examples serve as both documentation and test cases, and an
example should be included for documentation purposes, but should not be
checked.  E.g., the example’s output might be random; or the example might
depend on resources which would be unavailable to the test driver.

The SKIP flag can also be used for temporarily “commenting out” examples.
@end deffn

@geindex COMPARISON_FLAGS (no módulo doctest)
@anchor{library/doctest doctest COMPARISON_FLAGS}@anchor{4226}
@deffn {Dado} doctest.COMPARISON_FLAGS

A bitmask or’ing together all the comparison flags above.
@end deffn

The second group of options controls how test failures are reported:

@geindex REPORT_UDIFF (no módulo doctest)
@anchor{library/doctest doctest REPORT_UDIFF}@anchor{14b7}
@deffn {Dado} doctest.REPORT_UDIFF

When specified, failures that involve multi-line expected and actual outputs are
displayed using a unified diff.
@end deffn

@geindex REPORT_CDIFF (no módulo doctest)
@anchor{library/doctest doctest REPORT_CDIFF}@anchor{14b8}
@deffn {Dado} doctest.REPORT_CDIFF

When specified, failures that involve multi-line expected and actual outputs
will be displayed using a context diff.
@end deffn

@geindex REPORT_NDIFF (no módulo doctest)
@anchor{library/doctest doctest REPORT_NDIFF}@anchor{14b9}
@deffn {Dado} doctest.REPORT_NDIFF

When specified, differences are computed by @code{difflib.Differ}, using the same
algorithm as the popular @code{ndiff.py} utility. This is the only method that
marks differences within lines as well as across lines.  For example, if a line
of expected output contains digit @code{1} where actual output contains letter
@code{l}, a line is inserted with a caret marking the mismatching column positions.
@end deffn

@geindex REPORT_ONLY_FIRST_FAILURE (no módulo doctest)
@anchor{library/doctest doctest REPORT_ONLY_FIRST_FAILURE}@anchor{4227}
@deffn {Dado} doctest.REPORT_ONLY_FIRST_FAILURE

When specified, display the first failing example in each doctest, but suppress
output for all remaining examples.  This will prevent doctest from reporting
correct examples that break because of earlier failures; but it might also hide
incorrect examples that fail independently of the first failure.  When
@ref{4227,,REPORT_ONLY_FIRST_FAILURE} is specified, the remaining examples are
still run, and still count towards the total number of failures reported; only
the output is suppressed.
@end deffn

@geindex FAIL_FAST (no módulo doctest)
@anchor{library/doctest doctest FAIL_FAST}@anchor{f67}
@deffn {Dado} doctest.FAIL_FAST

When specified, exit after the first failing example and don’t attempt to run
the remaining examples. Thus, the number of failures reported will be at most
1.  This flag may be useful during debugging, since examples after the first
failure won’t even produce debugging output.
@end deffn

@geindex REPORTING_FLAGS (no módulo doctest)
@anchor{library/doctest doctest REPORTING_FLAGS}@anchor{4228}
@deffn {Dado} doctest.REPORTING_FLAGS

A bitmask or’ing together all the reporting flags above.
@end deffn

There is also a way to register new option flag names, though this isn’t
useful unless you intend to extend @ref{3a,,doctest} internals via subclassing:

@geindex register_optionflag() (no módulo doctest)
@anchor{library/doctest doctest register_optionflag}@anchor{4229}
@deffn {Função} doctest.register_optionflag (name)

Create a new option flag with a given name, and return the new flag’s integer
value.  @ref{4229,,register_optionflag()} can be used when subclassing
@ref{422a,,OutputChecker} or @ref{422b,,DocTestRunner} to create new options that are
supported by your subclasses.  @ref{4229,,register_optionflag()} should always be
called using the following idiom:

@example
MY_FLAG = register_optionflag('MY_FLAG')
@end example
@end deffn

@geindex # (cerquilha);in doctests
@geindex + (mais);in doctests
@geindex - (menos);in doctests

@node Directives,Avisos<2>,Flags opcionais,Como ele funciona
@anchor{library/doctest directives}@anchor{422c}@anchor{library/doctest doctest-directives}@anchor{421b}
@subsubsection Directives


Doctest directives may be used to modify the @ref{f66,,option flags} for an individual example.  Doctest directives are
special Python comments following an example’s source code:

@example
@anchor{library/doctest grammar-token-doctest-directive}@anchor{422d}directive             ::= "#" "doctest:" @ref{422e,,directive_options}
@anchor{library/doctest grammar-token-doctest-directive_options}@anchor{422e}directive_options     ::= @ref{422f,,directive_option} ("," @ref{422f,,directive_option})*
@anchor{library/doctest grammar-token-doctest-directive_option}@anchor{422f}directive_option      ::= @ref{4230,,on_or_off} @ref{4231,,directive_option_name}
@anchor{library/doctest grammar-token-doctest-on_or_off}@anchor{4230}on_or_off             ::= "+" | "-"
@anchor{library/doctest grammar-token-doctest-directive_option_name}@anchor{4231}directive_option_name ::= "DONT_ACCEPT_BLANKLINE" | "NORMALIZE_WHITESPACE" | ...
@end example

Whitespace is not allowed between the @code{+} or @code{-} and the directive option
name.  The directive option name can be any of the option flag names explained
above.

An example’s doctest directives modify doctest’s behavior for that single
example.  Use @code{+} to enable the named behavior, or @code{-} to disable it.

Por exemplo, este teste é aprovado:

@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

Without the directive it would fail, both because the actual output doesn’t have
two blanks before the single-digit list elements, and because the actual output
is on a single line.  This test also passes, and also requires a directive to do
so:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
[0, 1, ..., 18, 19]
@end example

Multiple directives can be used on a single physical line, separated by
commas:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

If multiple directive comments are used for a single example, then they are
combined:

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
...                         # doctest: +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

As the previous example shows, you can add @code{...} lines to your example
containing only directives.  This can be useful when an example is too long for
a directive to comfortably fit on the same line:

@example
>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
... # doctest: +ELLIPSIS
[0, ..., 4, 10, ..., 19, 30, ..., 39]
@end example

Note that since all options are disabled by default, and directives apply only
to the example they appear in, enabling options (via @code{+} in a directive) is
usually the only meaningful choice.  However, option flags can also be passed to
functions that run doctests, establishing different defaults.  In such cases,
disabling an option via @code{-} in a directive can be useful.

@node Avisos<2>,,Directives,Como ele funciona
@anchor{library/doctest doctest-warnings}@anchor{4232}@anchor{library/doctest warnings}@anchor{4233}
@subsubsection Avisos


@ref{3a,,doctest} is serious about requiring exact matches in expected output.  If
even a single character doesn’t match, the test fails.  This will probably
surprise you a few times, as you learn exactly what Python does and doesn’t
guarantee about output.  For example, when printing a set, Python doesn’t
guarantee that the element is printed in any particular order, so a test like

@example
>>> foo()
@{"spam", "eggs"@}
@end example

is vulnerable!  One workaround is to do

@example
>>> foo() == @{"spam", "eggs"@}
True
@end example

instead.  Another is to do

@example
>>> d = sorted(foo())
>>> d
['eggs', 'spam']
@end example

There are others, but you get the idea.

Another bad idea is to print things that embed an object address, like

@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

The @ref{14b6,,ELLIPSIS} directive gives a nice approach for the last example:

@example
>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>
@end example

Floating-point numbers are also subject to small output variations across
platforms, because Python defers to the platform C library for some
floating-point calculations, and C libraries vary widely in quality here.

@example
>>> 1000**0.1  # risky
1.9952623149688797
>>> round(1000**0.1, 9) # safer
1.995262315
>>> print(f'@{1000**0.1:.4f@}') # much safer
1.9953
@end example

Numbers of the form @code{I/2.**J} are safe across all platforms, and I often
contrive doctest examples to produce numbers of that form:

@example
>>> 3./4  # utterly safe
0.75
@end example

Simple fractions are also easier for people to understand, and that makes for
better documentation.

@node Basic API,API do Unittest,Como ele funciona,doctest — Teste exemplos interativos de Python
@anchor{library/doctest basic-api}@anchor{4234}@anchor{library/doctest doctest-basic-api}@anchor{4208}
@subsubsection Basic API


The functions @ref{14b5,,testmod()} and @ref{420b,,testfile()} provide a simple interface to
doctest that should be sufficient for most basic uses.  For a less formal
introduction to these two functions, see sections @ref{4205,,Uso simples; verificando exemplos em Docstrings}
and @ref{4209,,Utilização comum; Verificando exemplos em um arquivo texto}.

@geindex testfile() (no módulo doctest)
@anchor{library/doctest doctest testfile}@anchor{420b}
@deffn {Função} 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)

All arguments except `filename' are optional, and should be specified in keyword
form.

Test examples in the file named `filename'.  Return @code{(failure_count,
test_count)}.

Optional argument `module_relative' specifies how the filename should be
interpreted:


@itemize *

@item 
If `module_relative' is @code{True} (the default), then `filename' specifies an
OS-independent module-relative path.  By default, this path is relative to the
calling module’s directory; but if the `package' argument is specified, then it
is relative to that package.  To ensure OS-independence, `filename' should use
@code{/} characters to separate path segments, and may not be an absolute path
(i.e., it may not begin with @code{/}).

@item 
If `module_relative' is @code{False}, then `filename' specifies an OS-specific
path.  The path may be absolute or relative; relative paths are resolved with
respect to the current working directory.
@end itemize

Optional argument `name' gives the name of the test; by default, or if @code{None},
@code{os.path.basename(filename)} is used.

Optional argument `package' is a Python package or the name of a Python package
whose directory should be used as the base directory for a module-relative
filename.  If no package is specified, then the calling module’s directory is
used as the base directory for module-relative filenames.  It is an error to
specify `package' if `module_relative' is @code{False}.

Optional argument `globs' gives a dict to be used as the globals when executing
examples.  A new shallow copy of this dict is created for the doctest, so its
examples start with a clean slate. By default, or if @code{None}, a new empty dict
is used.

Optional argument `extraglobs' gives a dict merged into the globals used to
execute examples.  This works like @ref{14ad,,dict.update()}:  if `globs' and
`extraglobs' have a common key, the associated value in `extraglobs' appears in
the combined dict.  By default, or if @code{None}, no extra globals are used.  This
is an advanced feature that allows parameterization of doctests.  For example, a
doctest can be written for a base class, using a generic name for the class,
then reused to test any number of subclasses by passing an `extraglobs' dict
mapping the generic name to the subclass to be tested.

Optional argument `verbose' prints lots of stuff if true, and prints only
failures if false; by default, or if @code{None}, it’s true if and only if @code{'-v'}
is in @ref{12a6,,sys.argv}.

Optional argument `report' prints a summary at the end when true, else prints
nothing at the end.  In verbose mode, the summary is detailed, else the summary
is very brief (in fact, empty if all tests passed).

Optional argument `optionflags' (default value @code{0}) takes the
@ref{2202,,bitwise OR} of option flags.
See section @ref{f66,,Flags opcionais}.

Optional argument `raise_on_error' defaults to false.  If true, an exception is
raised upon the first failure or unexpected exception in an example.  This
allows failures to be post-mortem debugged. Default behavior is to continue
running examples.

Optional argument `parser' specifies a @ref{421c,,DocTestParser} (or subclass) that
should be used to extract tests from the files.  It defaults to a normal parser
(i.e., @code{DocTestParser()}).

Optional argument `encoding' specifies an encoding that should be used to
convert the file to unicode.
@end deffn

@geindex testmod() (no módulo doctest)
@anchor{library/doctest doctest testmod}@anchor{14b5}
@deffn {Função} doctest.testmod (m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)

All arguments are optional, and all except for `m' should be specified in
keyword form.

Test examples in docstrings in functions and classes reachable from module `m'
(or module @ref{1,,__main__} if `m' is not supplied or is @code{None}), starting with
@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.

Only docstrings attached to objects belonging to module `m' are searched.

Return @code{(failure_count, test_count)}.

Optional argument `name' gives the name of the module; by default, or if
@code{None}, @code{m.__name__} is used.

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{4235,,doctest.master.summarize} in
conjunction with @ref{14b5,,testmod()} continues to get output for objects with no
tests. The `exclude_empty' argument to the newer @ref{171e,,DocTestFinder}
constructor defaults to true.

Optional arguments `extraglobs', `verbose', `report', `optionflags',
`raise_on_error', and `globs' are the same as for function @ref{420b,,testfile()}
above, except that `globs' defaults to @code{m.__dict__}.
@end deffn

@geindex run_docstring_examples() (no módulo doctest)
@anchor{library/doctest doctest run_docstring_examples}@anchor{4236}
@deffn {Função} doctest.run_docstring_examples (f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)

Test examples associated with object `f'; for example, `f' may be a string,
a module, a function, or a class object.

A shallow copy of dictionary argument `globs' is used for the execution context.

Optional argument `name' is used in failure messages, and defaults to
@code{"NoName"}.

If optional argument `verbose' is true, output is generated even if there are no
failures.  By default, output is generated only in case of an example failure.

Optional argument `compileflags' gives the set of flags that should be used by
the Python compiler when running the examples.  By default, or if @code{None},
flags are deduced corresponding to the set of future features found in `globs'.

Optional argument `optionflags' works as for function @ref{420b,,testfile()} above.
@end deffn

@node API do Unittest,Advanced API,Basic API,doctest — Teste exemplos interativos de Python
@anchor{library/doctest doctest-unittest-api}@anchor{4237}@anchor{library/doctest unittest-api}@anchor{4238}
@subsubsection API do Unittest


As your collection of doctest’ed modules grows, you’ll want a way to run all
their doctests systematically.  @ref{3a,,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{4239,,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

There are two main functions for creating @ref{e20,,unittest.TestSuite} instances
from text files and modules with doctests:

@geindex DocFileSuite() (no módulo doctest)
@anchor{library/doctest doctest DocFileSuite}@anchor{423a}
@deffn {Função} doctest.DocFileSuite (*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)

Convert doctest tests from one or more text files to a
@ref{e20,,unittest.TestSuite}.

The returned @ref{e20,,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{423b,,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.

Pass one or more paths (as strings) to text files to be examined.

Options may be provided as keyword arguments:

Optional argument `module_relative' specifies how the filenames in `paths'
should be interpreted:


@itemize *

@item 
If `module_relative' is @code{True} (the default), then each filename in
`paths' specifies an OS-independent module-relative path.  By default, this
path is relative to the calling module’s directory; but if the `package'
argument is specified, then it is relative to that package.  To ensure
OS-independence, each filename should use @code{/} characters to separate path
segments, and may not be an absolute path (i.e., it may not begin with
@code{/}).

@item 
If `module_relative' is @code{False}, then each filename in `paths' specifies
an OS-specific path.  The path may be absolute or relative; relative paths
are resolved with respect to the current working directory.
@end itemize

Optional argument `package' is a Python package or the name of a Python
package whose directory should be used as the base directory for
module-relative filenames in `paths'.  If no package is specified, then the
calling module’s directory is used as the base directory for module-relative
filenames.  It is an error to specify `package' if `module_relative' is
@code{False}.

Optional argument `setUp' specifies a set-up function for the test suite.
This is called before running the tests in each file.  The `setUp' function
will be passed a @ref{17a5,,DocTest} object.  The `setUp' function can access the
test globals as the @ref{423c,,globs} attribute of the test passed.

Optional argument `tearDown' specifies a tear-down function for the test
suite.  This is called after running the tests in each file.  The `tearDown'
function will be passed a @ref{17a5,,DocTest} object.  The `tearDown' function can
access the test globals as the @ref{423c,,globs} attribute of the test
passed.

Optional argument `globs' is a dictionary containing the initial global
variables for the tests.  A new copy of this dictionary is created for each
test.  By default, `globs' is a new empty dictionary.

Optional argument `optionflags' specifies the default doctest options for the
tests, created by or-ing together individual option flags.  See section
@ref{f66,,Flags opcionais}. See function @ref{423d,,set_unittest_reportflags()} below
for a better way to set reporting options.

Optional argument `parser' specifies a @ref{421c,,DocTestParser} (or subclass)
that should be used to extract tests from the files.  It defaults to a normal
parser (i.e., @code{DocTestParser()}).

Optional argument `encoding' specifies an encoding that should be used to
convert the file to unicode.

The global @code{__file__} is added to the globals provided to doctests loaded
from a text file using @ref{423a,,DocFileSuite()}.
@end deffn

@geindex DocTestSuite() (no módulo doctest)
@anchor{library/doctest doctest DocTestSuite}@anchor{e1f}
@deffn {Função} doctest.DocTestSuite (module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, optionflags=0, checker=None)

Convert doctest tests for a module to a @ref{e20,,unittest.TestSuite}.

The returned @ref{e20,,unittest.TestSuite} is to be run by the unittest framework
and runs each doctest in the module.
Each docstring is run as a separate unit test.
If any of the doctests fail, then the synthesized unit test fails,
and a @ref{423b,,unittest.TestCase.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

Optional argument `module' provides the module to be tested.  It can be a module
object or a (possibly dotted) module name.  If not specified, the module calling
this function is used.

Optional argument `globs' is a dictionary containing the initial global
variables for the tests.  A new copy of this dictionary is created for each
test.  By default, `globs' is the module’s @ref{20b2,,__dict__}.

Optional argument `extraglobs' specifies an extra set of global variables, which
is merged into `globs'.  By default, no extra globals are used.

Optional argument `test_finder' is the @ref{171e,,DocTestFinder} object (or a
drop-in replacement) that is used to extract doctests from the module.

Optional arguments `setUp', `tearDown', and `optionflags' are the same as for
function @ref{423a,,DocFileSuite()} above, but they are called for each docstring.

This function uses the same search technique as @ref{14b5,,testmod()}.


Alterado na versão 3.5: @ref{e1f,,DocTestSuite()} returns an empty @ref{e20,,unittest.TestSuite} if `module'
contains no docstrings instead of raising @ref{202,,ValueError}.

@end deffn

Under the covers, @ref{e1f,,DocTestSuite()} creates a @ref{e20,,unittest.TestSuite} out
of @code{doctest.DocTestCase} instances, and @code{DocTestCase} is a
subclass of @ref{44f,,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{423a,,DocFileSuite()} creates a @ref{e20,,unittest.TestSuite} out of
@code{doctest.DocFileCase} instances, and @code{DocFileCase} is a subclass
of @code{DocTestCase}.

So both ways of creating a @ref{e20,,unittest.TestSuite} run instances of
@code{DocTestCase}.  This is important for a subtle reason: when you run
@ref{3a,,doctest} functions yourself, you can control the @code{doctest} options in
use directly, by passing option flags to @code{doctest} functions.  However, if
you’re writing a @ref{106,,unittest} framework, @code{unittest} ultimately controls
when and how tests get run.  The framework author typically wants to control
@code{doctest} reporting options (perhaps, e.g., specified by command line
options), but there’s no way to pass options through @code{unittest} to
@code{doctest} test runners.

For this reason, @ref{3a,,doctest} also supports a notion of @code{doctest}
reporting flags specific to @ref{106,,unittest} support, via this function:

@geindex set_unittest_reportflags() (no módulo doctest)
@anchor{library/doctest doctest set_unittest_reportflags}@anchor{423d}
@deffn {Função} doctest.set_unittest_reportflags (flags)

Set the @ref{3a,,doctest} reporting flags to use.

Argument `flags' takes the @ref{2202,,bitwise OR} of option flags.  See
section @ref{f66,,Flags opcionais}.  Only “reporting flags” can be used.

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 @code{unittest} reporting flags are
@ref{2202,,bitwise ORed} into the option flags, and the option flags
so augmented are passed to the @ref{422b,,DocTestRunner} instance created to
run the doctest.  If any reporting flags were specified when the
@code{DocTestCase} instance was constructed, @code{doctest}’s
@code{unittest} reporting flags are ignored.

The value of the @ref{106,,unittest} reporting flags in effect before the function
was called is returned by the function.
@end deffn

@node Advanced API,Depuração,API do Unittest,doctest — Teste exemplos interativos de Python
@anchor{library/doctest advanced-api}@anchor{423e}@anchor{library/doctest doctest-advanced-api}@anchor{423f}
@subsubsection Advanced API


The basic API is a simple wrapper that’s intended to make doctest easy to use.
It is fairly flexible, and should meet most users’ needs; however, if you
require more fine-grained control over testing, or wish to extend doctest’s
capabilities, then you should use the advanced API.

The advanced API revolves around two container classes, which are used to store
the interactive examples extracted from doctest cases:


@itemize *

@item 
@ref{4240,,Example}: A single Python @ref{2935,,statement}, paired with its expected
output.

@item 
@ref{17a5,,DocTest}: A collection of @ref{4240,,Example}s, typically extracted
from a single docstring or text file.
@end itemize

Additional processing classes are defined to find, parse, and run, and check
doctest examples:


@itemize *

@item 
@ref{171e,,DocTestFinder}: Finds all docstrings in a given module, and uses a
@ref{421c,,DocTestParser} to create a @ref{17a5,,DocTest} from every docstring that
contains interactive examples.

@item 
@ref{421c,,DocTestParser}: Creates a @ref{17a5,,DocTest} object from a string (such
as an object’s docstring).

@item 
@ref{422b,,DocTestRunner}: Executes the examples in a @ref{17a5,,DocTest}, and uses
an @ref{422a,,OutputChecker} to verify their output.

@item 
@ref{422a,,OutputChecker}: Compares the actual output from a doctest example with
the expected output, and decides whether they match.
@end itemize

The relationships among these processing classes are summarized in the following
diagram:

@example
                            list of:
+------+                   +---------+
|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results
+------+    |        ^     +---------+     |       ^    (printed)
            |        |     | Example |     |       |
            v        |     |   ...   |     v       |
           DocTestParser   | Example |   OutputChecker
                           +---------+
@end example

@menu
* DocTest Objects:: 
* Example Objects:: 
* DocTestFinder objects:: 
* DocTestParser objects:: 
* TestResults objects:: 
* DocTestRunner objects:: 
* OutputChecker objects:: 

@end menu

@node DocTest Objects,Example Objects,,Advanced API
@anchor{library/doctest doctest-doctest}@anchor{4241}@anchor{library/doctest doctest-objects}@anchor{4242}
@subsubsection DocTest Objects


@geindex DocTest (classe em doctest)
@anchor{library/doctest doctest DocTest}@anchor{17a5}
@deffn {Classe} doctest.DocTest (examples, globs, name, filename, lineno, docstring)

A collection of doctest examples that should be run in a single namespace.  The
constructor arguments are used to initialize the attributes of the same names.

@ref{17a5,,DocTest} defines the following attributes.  They are initialized by
the constructor, and should not be modified directly.

@geindex examples (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest examples}@anchor{4243}
@deffn {Atributo} examples

A list of @ref{4240,,Example} objects encoding the individual interactive Python
examples that should be run by this test.
@end deffn

@geindex globs (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest globs}@anchor{423c}
@deffn {Atributo} globs

The namespace (aka globals) that the examples should be run in. This is a
dictionary mapping names to values.  Any changes to the namespace made by the
examples (such as binding new variables) will be reflected in @ref{423c,,globs}
after the test is run.
@end deffn

@geindex name (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest name}@anchor{4244}
@deffn {Atributo} name

A string name identifying the @ref{17a5,,DocTest}.  Typically, this is the name
of the object or file that the test was extracted from.
@end deffn

@geindex filename (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest filename}@anchor{4245}
@deffn {Atributo} filename

The name of the file that this @ref{17a5,,DocTest} was extracted from; or
@code{None} if the filename is unknown, or if the @code{DocTest} was not
extracted from a file.
@end deffn

@geindex lineno (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest lineno}@anchor{1606}
@deffn {Atributo} lineno

The line number within @ref{4245,,filename} where this @ref{17a5,,DocTest} begins, or
@code{None} if the line number is unavailable.  This line number is zero-based
with respect to the beginning of the file.
@end deffn

@geindex docstring (atributo doctest.DocTest)
@anchor{library/doctest doctest DocTest docstring}@anchor{4246}
@deffn {Atributo} docstring

The string that the test was extracted from, or @code{None} if the string is
unavailable, or if the test was not extracted from a string.
@end deffn
@end deffn

@node Example Objects,DocTestFinder objects,DocTest Objects,Advanced API
@anchor{library/doctest doctest-example}@anchor{4247}@anchor{library/doctest example-objects}@anchor{4248}
@subsubsection Example Objects


@geindex Example (classe em doctest)
@anchor{library/doctest doctest Example}@anchor{4240}
@deffn {Classe} doctest.Example (source, want, exc_msg=None, lineno=0, indent=0, options=None)

A single interactive example, consisting of a Python statement and its expected
output.  The constructor arguments are used to initialize the attributes of
the same names.

@ref{4240,,Example} defines the following attributes.  They are initialized by
the constructor, and should not be modified directly.

@geindex source (atributo doctest.Example)
@anchor{library/doctest doctest Example source}@anchor{4249}
@deffn {Atributo} source

A string containing the example’s source code.  This source code consists of a
single Python statement, and always ends with a newline; the constructor adds
a newline when necessary.
@end deffn

@geindex want (atributo doctest.Example)
@anchor{library/doctest doctest Example want}@anchor{424a}
@deffn {Atributo} want

The expected output from running the example’s source code (either from
stdout, or a traceback in case of exception).  @ref{424a,,want} ends with a
newline unless no output is expected, in which case it’s an empty string.  The
constructor adds a newline when necessary.
@end deffn

@geindex exc_msg (atributo doctest.Example)
@anchor{library/doctest doctest Example exc_msg}@anchor{424b}
@deffn {Atributo} exc_msg

The exception message generated by the example, if the example is expected to
generate an exception; or @code{None} if it is not expected to generate an
exception.  This exception message is compared against the return value of
@ref{851,,traceback.format_exception_only()}.  @ref{424b,,exc_msg} ends with a newline
unless it’s @code{None}.  The constructor adds a newline if needed.
@end deffn

@geindex lineno (atributo doctest.Example)
@anchor{library/doctest doctest Example lineno}@anchor{424c}
@deffn {Atributo} lineno

The line number within the string containing this example where the example
begins.  This line number is zero-based with respect to the beginning of the
containing string.
@end deffn

@geindex indent (atributo doctest.Example)
@anchor{library/doctest doctest Example indent}@anchor{424d}
@deffn {Atributo} indent

The example’s indentation in the containing string, i.e., the number of space
characters that precede the example’s first prompt.
@end deffn

@geindex options (atributo doctest.Example)
@anchor{library/doctest doctest Example options}@anchor{424e}
@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{422b,,DocTestRunner}’s @ref{f66,,optionflags}).
By default, no options are set.
@end deffn
@end deffn

@node DocTestFinder objects,DocTestParser objects,Example Objects,Advanced API
@anchor{library/doctest doctest-doctestfinder}@anchor{424f}@anchor{library/doctest doctestfinder-objects}@anchor{4250}
@subsubsection DocTestFinder objects


@geindex DocTestFinder (classe em doctest)
@anchor{library/doctest doctest DocTestFinder}@anchor{171e}
@deffn {Classe} doctest.DocTestFinder (verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)

A processing class used to extract the @ref{17a5,,DocTest}s that are relevant to
a given object, from its docstring and the docstrings of its contained objects.
@ref{17a5,,DocTest}s can be extracted from modules, classes, functions,
methods, staticmethods, classmethods, and properties.

The optional argument `verbose' can be used to display the objects searched by
the finder.  It defaults to @code{False} (no output).

The optional argument `parser' specifies the @ref{421c,,DocTestParser} object (or a
drop-in replacement) that is used to extract doctests from docstrings.

If the optional argument `recurse' is false, then @ref{17f1,,DocTestFinder.find()}
will only examine the given object, and not any contained objects.

If the optional argument `exclude_empty' is false, then
@ref{17f1,,DocTestFinder.find()} will include tests for objects with empty docstrings.

@ref{171e,,DocTestFinder} defines the following method:

@geindex find() (método doctest.DocTestFinder)
@anchor{library/doctest doctest DocTestFinder find}@anchor{17f1}
@deffn {Método} find (obj[, name][, module][, globs][, extraglobs])

Return a list of the @ref{17a5,,DocTest}s that are defined by `obj'’s
docstring, or by any of its contained objects’ docstrings.

The optional argument `name' specifies the object’s name; this name will be
used to construct names for the returned @ref{17a5,,DocTest}s.  If `name' is
not specified, then @code{obj.__name__} is used.

The optional parameter `module' is the module that contains the given object.
If the module is not specified or is @code{None}, then the test finder will attempt
to automatically determine the correct module.  The object’s module is used:


@itemize *

@item 
As a default namespace, if `globs' is not specified.

@item 
To prevent the DocTestFinder from extracting DocTests from objects that are
imported from other modules.  (Contained objects with modules other than
`module' are ignored.)

@item 
To find the name of the file containing the object.

@item 
To help find the line number of the object within its file.
@end itemize

If `module' is @code{False}, no attempt to find the module will be made.  This is
obscure, of use mostly in testing doctest itself: if `module' is @code{False}, or
is @code{None} but cannot be found automatically, then all objects are considered
to belong to the (non-existent) module, so all contained objects will
(recursively) be searched for doctests.

The globals for each @ref{17a5,,DocTest} is formed by combining `globs' and
`extraglobs' (bindings in `extraglobs' override bindings in `globs').  A new
shallow copy of the globals dictionary is created for each @code{DocTest}.
If `globs' is not specified, then it defaults to the module’s
@ref{20b2,,__dict__}, if specified, or @code{@{@}} otherwise.
If `extraglobs' is not specified, then it defaults to @code{@{@}}.
@end deffn
@end deffn

@node DocTestParser objects,TestResults objects,DocTestFinder objects,Advanced API
@anchor{library/doctest doctest-doctestparser}@anchor{4251}@anchor{library/doctest doctestparser-objects}@anchor{4252}
@subsubsection DocTestParser objects


@geindex DocTestParser (classe em doctest)
@anchor{library/doctest doctest DocTestParser}@anchor{421c}
@deffn {Classe} doctest.DocTestParser

A processing class used to extract interactive examples from a string, and use
them to create a @ref{17a5,,DocTest} object.

@ref{421c,,DocTestParser} defines the following methods:

@geindex get_doctest() (método doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser get_doctest}@anchor{4253}
@deffn {Método} get_doctest (string, globs, name, filename, lineno)

Extract all doctest examples from the given string, and collect them into a
@ref{17a5,,DocTest} object.

`globs', `name', `filename', and `lineno' are attributes for the new
@code{DocTest} object.  See the documentation for @ref{17a5,,DocTest} for more
information.
@end deffn

@geindex get_examples() (método doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser get_examples}@anchor{4254}
@deffn {Método} get_examples (string, name='<string>')

Extract all doctest examples from the given string, and return them as a list
of @ref{4240,,Example} objects.  Line numbers are 0-based.  The optional argument
`name' is a name identifying this string, and is only used for error messages.
@end deffn

@geindex parse() (método doctest.DocTestParser)
@anchor{library/doctest doctest DocTestParser parse}@anchor{4255}
@deffn {Método} parse (string, name='<string>')

Divide the given string into examples and intervening text, and return them as
a list of alternating @ref{4240,,Example}s and strings. Line numbers for the
@code{Example}s are 0-based.  The optional argument `name' is a name
identifying this string, and is only used for error messages.
@end deffn
@end deffn

@node TestResults objects,DocTestRunner objects,DocTestParser objects,Advanced API
@anchor{library/doctest testresults-objects}@anchor{4256}
@subsubsection TestResults objects


@geindex TestResults (classe em doctest)
@anchor{library/doctest doctest TestResults}@anchor{4257}
@deffn {Classe} doctest.TestResults (failed, attempted)

@geindex failed (atributo doctest.TestResults)
@anchor{library/doctest doctest TestResults failed}@anchor{4258}
@deffn {Atributo} failed

Number of failed tests.
@end deffn

@geindex attempted (atributo doctest.TestResults)
@anchor{library/doctest doctest TestResults attempted}@anchor{4259}
@deffn {Atributo} attempted

Number of attempted tests.
@end deffn

@geindex skipped (atributo doctest.TestResults)
@anchor{library/doctest doctest TestResults skipped}@anchor{1de}
@deffn {Atributo} skipped

Number of skipped tests.


Adicionado na versão 3.13.

@end deffn
@end deffn

@node DocTestRunner objects,OutputChecker objects,TestResults objects,Advanced API
@anchor{library/doctest doctest-doctestrunner}@anchor{425a}@anchor{library/doctest doctestrunner-objects}@anchor{425b}
@subsubsection DocTestRunner objects


@geindex DocTestRunner (classe em doctest)
@anchor{library/doctest doctest DocTestRunner}@anchor{422b}
@deffn {Classe} doctest.DocTestRunner (checker=None, verbose=None, optionflags=0)

A processing class used to execute and verify the interactive examples in a
@ref{17a5,,DocTest}.

The comparison between expected outputs and actual outputs is done by an
@ref{422a,,OutputChecker}.  This comparison may be customized with a number of
option flags; see section @ref{f66,,Flags opcionais} for more information.  If the
option flags are insufficient, then the comparison may also be customized by
passing a subclass of @code{OutputChecker} to the constructor.

The test runner’s display output can be controlled in two ways. First, an output
function can be passed to @ref{1dc,,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{425c,,report_start()}, @ref{425d,,report_success()},
@ref{425e,,report_unexpected_exception()}, and @ref{425f,,report_failure()}.

The optional keyword argument `checker' specifies the @ref{422a,,OutputChecker}
object (or drop-in replacement) that should be used to compare the expected
outputs to the actual outputs of doctest examples.

The optional keyword argument `verbose' controls the @ref{422b,,DocTestRunner}’s
verbosity.  If `verbose' is @code{True}, then information is printed about each
example, as it is run.  If `verbose' is @code{False}, then only failures are
printed.  If `verbose' is unspecified, or @code{None}, then verbose output is used
iff the command-line switch @code{-v} is used.

The optional keyword argument `optionflags' can be used to control how the test
runner compares expected output to actual output, and how it displays failures.
For more information, see section @ref{f66,,Flags opcionais}.

The test runner accumulates statistics. The aggregated number of attempted,
failed and skipped examples is also available via the @ref{4260,,tries},
@ref{4261,,failures} and @ref{1dd,,skips} attributes. The @ref{1dc,,run()} and
@ref{4235,,summarize()} methods return a @ref{4257,,TestResults} instance.

@ref{422b,,DocTestRunner} defines the following methods:

@geindex report_start() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_start}@anchor{425c}
@deffn {Método} report_start (out, test, example)

Report that the test runner is about to process the given example. This method
is provided to allow subclasses of @ref{422b,,DocTestRunner} to customize their
output; it should not be called directly.

`example' is the example about to be processed.  `test' is the test
containing `example'.  `out' is the output function that was passed to
@ref{1dc,,DocTestRunner.run()}.
@end deffn

@geindex report_success() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_success}@anchor{425d}
@deffn {Método} report_success (out, test, example, got)

Report that the given example ran successfully.  This method is provided to
allow subclasses of @ref{422b,,DocTestRunner} to customize their output; it
should not be called directly.

`example' is the example about to be processed.  `got' is the actual output
from the example.  `test' is the test containing `example'.  `out' is the
output function that was passed to @ref{1dc,,DocTestRunner.run()}.
@end deffn

@geindex report_failure() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_failure}@anchor{425f}
@deffn {Método} report_failure (out, test, example, got)

Report that the given example failed.  This method is provided to allow
subclasses of @ref{422b,,DocTestRunner} to customize their output; it should not
be called directly.

`example' is the example about to be processed.  `got' is the actual output
from the example.  `test' is the test containing `example'.  `out' is the
output function that was passed to @ref{1dc,,DocTestRunner.run()}.
@end deffn

@geindex report_unexpected_exception() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner report_unexpected_exception}@anchor{425e}
@deffn {Método} report_unexpected_exception (out, test, example, exc_info)

Report that the given example raised an unexpected exception. This method is
provided to allow subclasses of @ref{422b,,DocTestRunner} to customize their
output; it should not be called directly.

`example' is the example about to be processed. `exc_info' is a tuple
containing information about the unexpected exception (as returned by
@ref{68a,,sys.exc_info()}). `test' is the test containing `example'.  `out' is the
output function that was passed to @ref{1dc,,DocTestRunner.run()}.
@end deffn

@geindex run() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner run}@anchor{1dc}
@deffn {Método} run (test, compileflags=None, out=None, clear_globs=True)

Run the examples in `test' (a @ref{17a5,,DocTest} object), and display the
results using the writer function `out'. Return a @ref{4257,,TestResults}
instance.

The examples are run in the namespace @code{test.globs}.  If `clear_globs' is
true (the default), then this namespace will be cleared after the test runs,
to help with garbage collection. If you would like to examine the namespace
after the test completes, then use `clear_globs=False'.

`compileflags' gives the set of flags that should be used by the Python
compiler when running the examples.  If not specified, then it will default to
the set of future-import flags that apply to `globs'.

The output of each example is checked using the @ref{422b,,DocTestRunner}’s
output checker, and the results are formatted by the
@code{DocTestRunner.report_*()} methods.
@end deffn

@geindex summarize() (método doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner summarize}@anchor{4235}
@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{4257,,TestResults} instance.

The optional `verbose' argument controls how detailed the summary is.  If the
verbosity is not specified, then the @ref{422b,,DocTestRunner}’s verbosity is
used.
@end deffn

@ref{421c,,DocTestParser} has the following attributes:

@geindex tries (atributo doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner tries}@anchor{4260}
@deffn {Atributo} tries

Number of attempted examples.
@end deffn

@geindex failures (atributo doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner failures}@anchor{4261}
@deffn {Atributo} failures

Number of failed examples.
@end deffn

@geindex skips (atributo doctest.DocTestRunner)
@anchor{library/doctest doctest DocTestRunner skips}@anchor{1dd}
@deffn {Atributo} skips

Number of skipped examples.


Adicionado na versão 3.13.

@end deffn
@end deffn

@node OutputChecker objects,,DocTestRunner objects,Advanced API
@anchor{library/doctest doctest-outputchecker}@anchor{4262}@anchor{library/doctest outputchecker-objects}@anchor{4263}
@subsubsection OutputChecker objects


@geindex OutputChecker (classe em doctest)
@anchor{library/doctest doctest OutputChecker}@anchor{422a}
@deffn {Classe} doctest.OutputChecker

A class used to check the whether the actual output from a doctest example
matches the expected output.  @ref{422a,,OutputChecker} defines two methods:
@ref{4264,,check_output()}, which compares a given pair of outputs, and returns @code{True}
if they match; and @ref{4265,,output_difference()}, which returns a string describing
the differences between two outputs.

@ref{422a,,OutputChecker} define os seguintes métodos:

@geindex check_output() (método doctest.OutputChecker)
@anchor{library/doctest doctest OutputChecker check_output}@anchor{4264}
@deffn {Método} check_output (want, got, optionflags)

Return @code{True} iff the actual output from an example (`got') matches the
expected output (`want').  These strings are always considered to match if
they are identical; but depending on what option flags the test runner is
using, several non-exact match types are also possible.  See section
@ref{f66,,Flags opcionais} for more information about option flags.
@end deffn

@geindex output_difference() (método doctest.OutputChecker)
@anchor{library/doctest doctest OutputChecker output_difference}@anchor{4265}
@deffn {Método} output_difference (example, got, optionflags)

Return a string describing the differences between the expected output for a
given example (`example') and the actual output (`got').  `optionflags' is the
set of option flags used to compare `want' and `got'.
@end deffn
@end deffn

@node Depuração,Soapbox,Advanced API,doctest — Teste exemplos interativos de Python
@anchor{library/doctest debugging}@anchor{4266}@anchor{library/doctest doctest-debugging}@anchor{4267}
@subsubsection Depuração


Doctest provides several mechanisms for debugging doctest examples:


@itemize *

@item 
Several functions convert doctests to executable Python programs, which can be
run under the Python debugger, @ref{a5,,pdb}.

@item 
The @ref{4268,,DebugRunner} class is a subclass of @ref{422b,,DocTestRunner} that
raises an exception for the first failing example, containing information about
that example. This information can be used to perform post-mortem debugging on
the example.

@item 
The @ref{106,,unittest} cases generated by @ref{e1f,,DocTestSuite()} support the
@ref{4269,,debug()} method defined by @ref{44f,,unittest.TestCase}.

@item 
You can add a call to @ref{235,,pdb.set_trace()} in a doctest example, and you’ll
drop into the Python debugger when that line is executed.  Then you can inspect
current values of variables, and so on.  For example, suppose @code{a.py}
contains just this module docstring:

@example
"""
>>> def f(x):
...     g(x*2)
>>> def g(x):
...     print(x+3)
...     import pdb; pdb.set_trace()
>>> f(3)
9
"""
@end example

Then an interactive Python session may look like this:

@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

Functions that convert doctests to Python code, and possibly run the synthesized
code under the debugger:

@geindex script_from_examples() (no módulo doctest)
@anchor{library/doctest doctest script_from_examples}@anchor{426a}
@deffn {Função} doctest.script_from_examples (s)

Convert text with examples to a script.

Argument `s' is a string containing doctest examples.  The string is converted
to a Python script, where doctest examples in `s' are converted to regular code,
and everything else is converted to Python comments.  The generated script is
returned as a string. For example,

@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

displays:

@example
# Set x and y to 1 and 2.
x, y = 1, 2
#
# Print their sum:
print(x+y)
# Expected:
## 3
@end example

This function is used internally by other functions (see below), but can also be
useful when you want to transform an interactive Python session into a Python
script.
@end deffn

@geindex testsource() (no módulo doctest)
@anchor{library/doctest doctest testsource}@anchor{426b}
@deffn {Função} doctest.testsource (module, name)

Convert the doctest for an object to a 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{426a,,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() (no módulo doctest)
@anchor{library/doctest doctest debug}@anchor{4269}
@deffn {Função} doctest.debug (module, name, pm=False)

Debug the doctests for an object.

The `module' and `name' arguments are the same as for function
@ref{426b,,testsource()} above.  The synthesized Python script for the named object’s
docstring is written to a temporary file, and then that file is run under the
control of the Python debugger, @ref{a5,,pdb}.

A shallow copy of @code{module.__dict__} is used for both local and global
execution context.

Optional argument `pm' controls whether post-mortem debugging is used.  If `pm'
has a true value, the script file is run directly, and the debugger gets
involved only if the script terminates via raising an unhandled exception.  If
it does, then post-mortem debugging is invoked, via @ref{1421,,pdb.post_mortem()},
passing the traceback object from the unhandled exception.  If `pm' is not
specified, or is false, the script is run under the debugger from the start, via
passing an appropriate @ref{17f,,exec()} call to @ref{426c,,pdb.run()}.
@end deffn

@geindex debug_src() (no módulo doctest)
@anchor{library/doctest doctest debug_src}@anchor{426d}
@deffn {Função} doctest.debug_src (src, pm=False, globs=None)

Debug the doctests in a string.

This is like function @ref{4269,,debug()} above, except that a string containing
doctest examples is specified directly, via the `src' argument.

Optional argument `pm' has the same meaning as in function @ref{4269,,debug()} above.

Optional argument `globs' gives a dictionary to use as both local and global
execution context.  If not specified, or @code{None}, an empty dictionary is used.
If specified, a shallow copy of the dictionary is used.
@end deffn

The @ref{4268,,DebugRunner} class, and the special exceptions it may raise, are of
most interest to testing framework authors, and will only be sketched here.  See
the source code, and especially @ref{4268,,DebugRunner}’s docstring (which is a
doctest!) for more details:

@geindex DebugRunner (classe em doctest)
@anchor{library/doctest doctest DebugRunner}@anchor{4268}
@deffn {Classe} doctest.DebugRunner (checker=None, verbose=None, optionflags=0)

A subclass of @ref{422b,,DocTestRunner} that raises an exception as soon as a
failure is encountered.  If an unexpected exception occurs, an
@ref{426e,,UnexpectedException} exception is raised, containing the test, the
example, and the original exception.  If the output doesn’t match, then a
@ref{426f,,DocTestFailure} exception is raised, containing the test, the example, and
the actual output.

For information about the constructor parameters and methods, see the
documentation for @ref{422b,,DocTestRunner} in section @ref{423f,,Advanced API}.
@end deffn

There are two exceptions that may be raised by @ref{4268,,DebugRunner} instances:

@geindex DocTestFailure
@anchor{library/doctest doctest DocTestFailure}@anchor{426f}
@deffn {Exceção} doctest.DocTestFailure (test, example, got)

An exception raised by @ref{422b,,DocTestRunner} to signal that a doctest example’s
actual output did not match its expected output. The constructor arguments are
used to initialize the attributes of the same names.
@end deffn

@ref{426f,,DocTestFailure} defines the following attributes:

@geindex test (atributo doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure test}@anchor{4270}
@deffn {Atributo} DocTestFailure.test

The @ref{17a5,,DocTest} object that was being run when the example failed.
@end deffn

@geindex example (atributo doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure example}@anchor{4271}
@deffn {Atributo} DocTestFailure.example

The @ref{4240,,Example} that failed.
@end deffn

@geindex got (atributo doctest.DocTestFailure)
@anchor{library/doctest doctest DocTestFailure got}@anchor{4272}
@deffn {Atributo} DocTestFailure.got

The example’s actual output.
@end deffn

@geindex UnexpectedException
@anchor{library/doctest doctest UnexpectedException}@anchor{426e}
@deffn {Exceção} doctest.UnexpectedException (test, example, exc_info)

An exception raised by @ref{422b,,DocTestRunner} to signal that a doctest
example raised an unexpected exception.  The constructor arguments are used
to initialize the attributes of the same names.
@end deffn

@ref{426e,,UnexpectedException} define os seguintes atributos:

@geindex test (atributo doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException test}@anchor{4273}
@deffn {Atributo} UnexpectedException.test

The @ref{17a5,,DocTest} object that was being run when the example failed.
@end deffn

@geindex example (atributo doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException example}@anchor{4274}
@deffn {Atributo} UnexpectedException.example

The @ref{4240,,Example} that failed.
@end deffn

@geindex exc_info (atributo doctest.UnexpectedException)
@anchor{library/doctest doctest UnexpectedException exc_info}@anchor{4275}
@deffn {Atributo} UnexpectedException.exc_info

A tuple containing information about the unexpected exception, as returned by
@ref{68a,,sys.exc_info()}.
@end deffn

@node Soapbox,,Depuração,doctest — Teste exemplos interativos de Python
@anchor{library/doctest doctest-soapbox}@anchor{4276}@anchor{library/doctest soapbox}@anchor{4277}
@subsubsection Soapbox


As mentioned in the introduction, @ref{3a,,doctest} has grown to have three primary
uses:


@enumerate 

@item 
Checking examples in docstrings.

@item 
Regression testing.

@item 
Executable documentation / literate testing.
@end enumerate

These uses have different requirements, and it is important to distinguish them.
In particular, filling your docstrings with obscure test cases makes for bad
documentation.

When writing a docstring, choose docstring examples with care. There’s an art to
this that needs to be learned—it may not be natural at first.  Examples should
add genuine value to the documentation.  A good example can often be worth many
words. If done with care, the examples will be invaluable for your users, and
will pay back the time it takes to collect them many times over as the years go
by and things change.  I’m still amazed at how often one of my @ref{3a,,doctest}
examples stops working after a “harmless” change.

Doctest also makes an excellent tool for regression testing, especially if you
don’t skimp on explanatory text.  By interleaving prose and examples, it becomes
much easier to keep track of what’s actually being tested, and why.  When a test
fails, good prose can make it much easier to figure out what the problem is, and
how it should be fixed.  It’s true that you could write extensive comments in
code-based testing, but few programmers do. Many have found that using doctest
approaches instead leads to much clearer tests.  Perhaps this is simply because
doctest makes writing prose a little easier than writing code, while writing
comments in code is a little harder.  I think it goes deeper than just that:
the natural attitude when writing a doctest-based test is that you want to
explain the fine points of your software, and illustrate them with examples.
This in turn naturally leads to test files that start with the simplest
features, and logically progress to complications and edge cases.  A coherent
narrative is the result, instead of a collection of isolated functions that test
isolated bits of functionality seemingly at random.  It’s a different attitude,
and produces different results, blurring the distinction between testing and
explaining.

Regression testing is best confined to dedicated objects or files.  There are
several options for organizing tests:


@itemize *

@item 
Write text files containing test cases as interactive examples, and test the
files using @ref{420b,,testfile()} or @ref{423a,,DocFileSuite()}.  This is recommended,
although is easiest to do for new projects, designed from the start to use
doctest.

@item 
Define functions named @code{_regrtest_topic} that consist of single docstrings,
containing test cases for the named topics.  These functions can be included in
the same file as the module, or separated out into a separate test file.

@item 
Define a @ref{4217,,__test__} dictionary mapping from regression test topics to
docstrings containing test cases.
@end itemize

When you have placed your tests in a module, the module can itself be the test
runner.  When a test fails, you can arrange for your test runner to re-run only
the failing doctest while you debug the problem.  Here is a minimal example of
such a 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

@node unittest — Framework de testes unitários,unittest mock — mock object library,doctest — Teste exemplos interativos de Python,Ferramentas de Desenvolvimento
@anchor{library/unittest doc}@anchor{4278}@anchor{library/unittest module-unittest}@anchor{106}@anchor{library/unittest translation-repo}@anchor{4279}@anchor{library/unittest unittest-unit-testing-framework}@anchor{427a}
@subsection @code{unittest} — Framework de testes unitários


@geindex module; unittest

`Código-fonte:' Lib/unittest/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/unittest/__init__.py}


__________________________________________________________________


(Caso já estejas familiarizado com os conceitos básicos de testes, poderás querer ignorar @ref{427b,,a lista de métodos assertivos}.)

O framework de testes unitários @ref{106,,unittest} foi originalmente inspirado no JUnit e tem um sabor semelhante contendo as principais estruturas de teste de unidades existentes em outras linguagens. Ele suporta a automação de testes, compartilhamento de configuração e código de desligamento para testes, agregação de testes em coleções e independência dos testes do framework de relatórios.

Para conseguir isso, o módulo @ref{106,,unittest} suporta alguns conceitos importantes de forma orientada a objetos:


@table @asis

@item definição de contexto de teste

Uma `definição de contexto de teste' representa a preparação necessária pra performar um ou mais testes, além de quaisquer ações de limpeza relacionadas. Isso pode envolver, por exemplo, criar bancos de dados proxy ou temporários, diretórios ou iniciar um processo de servidor.

@item caso de teste

Um `test case' é uma unidade de teste individual. O mesmo verifica uma resposta específica a um determinado conjunto de entradas. O @ref{106,,unittest} fornece uma classe base, @ref{44f,,TestCase}, que pode ser usada para criar novos casos de teste.

@item Suíte de Testes

Uma `test suite' é uma coleção de casos de teste, conjuntos de teste ou ambos. O mesmo é usado para agregar testes que devem ser executados juntos.

@item test runner

Um `test runner' é um componente que orquestra a execução de testes e fornece o resultado para o usuário. O runner pode usar uma interface gráfica, uma interface textual ou retornar um valor especial para indicar os resultados da execução dos testes.
@end table


@subsubheading Ver também



@table @asis

@item Módulo @ref{3a,,doctest}

Outro módulo de suporte a testes com um sabor muito diferente.

@item Simple Smalltalk Testing: With Patterns@footnote{https://web.archive.org/web/20150315073817/http://www.xprogramming.com/testfram.htm}

O documento original de Kent Beck sobre estruturas de teste usando o padrão compartilhado por @ref{106,,unittest}.

@item pytest@footnote{https://docs.pytest.org/}

É um framework externo do unittest com uma sintaxe mais leve para escrever testes. Por exemplo, @code{assert func(10) == 42}.

@item The Python Testing Tools Taxonomy@footnote{https://wiki.python.org/moin/PythonTestingToolsTaxonomy}

Uma extensa lista de ferramentas para testar código Python, incluindo estruturas de teste funcionais e bibliotecas de objetos simulados.

@item Testing in Python Mailing List@footnote{http://lists.idyll.org/listinfo/testing-in-python}

Um grupo de interesse especial para discussão de testes e ferramentas de teste, em Python.
@end table

The script @code{Tools/unittestgui/unittestgui.py} in the Python source distribution is
a GUI tool for test discovery and execution.  This is intended largely for ease of use
for those new to unit testing.  For production environments it is
recommended that tests be driven by a continuous integration system such as
Buildbot@footnote{https://buildbot.net/}, Jenkins@footnote{https://www.jenkins.io/},
GitHub Actions@footnote{https://github.com/features/actions}, or
AppVeyor@footnote{https://www.appveyor.com/}.


@menu
* Exemplo Básico:: 
* Interface de linha de comando: Interface de linha de comando<8>. 
* Test Discovery:: 
* Organizando código teste:: 
* Reutilizando códigos de teste antigos:: 
* Ignorando testes e falhas esperadas:: 
* Distinguindo iterações de teste utilizando subtestes:: 
* Classes e funções:: 
* Classes e Módulos de Definição de Contexto:: 
* Tratamento de sinal:: 

@end menu

@node Exemplo Básico,Interface de linha de comando<8>,,unittest — Framework de testes unitários
@anchor{library/unittest basic-example}@anchor{427c}@anchor{library/unittest unittest-minimal-example}@anchor{427d}
@subsubsection Exemplo Básico


O módulo @ref{106,,unittest} fornece um conjunto amplo de ferramentas para a construção e execução de testes. Esta seção demonstra que um pequeno subconjunto das ferramentas é suficiente para atender às necessidades da maioria dos usuários.

Aqui temos um simples Script para testar três métodos de String:

@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

A test case is created by subclassing @ref{44f,,unittest.TestCase}.  The three
individual tests are defined with methods whose names start with the letters
@code{test}.  This naming convention informs the test runner about which methods
represent tests.

O cerne de cada teste é a invocação de um método @ref{529,,assertEqual()} para verificar se há um resultado esperado; @ref{527,,assertTrue()} ou @ref{528,,assertFalse()} para verificar uma condição; ou @ref{52d,,assertRaises()} para verificar se uma exceção específica será levantada. Esses métodos são usados ao invés de utilizar a expressão @ref{96f,,assert} para que o runner de teste possa acumular todos os resultados do teste e produzir um relatório.

Os métodos @ref{137e,,setUp()} e @ref{137f,,tearDown()} permitem que você defina instruções que serão executadas antes e depois de cada método de teste. Eles são abordados em mais detalhes na seção @ref{427e,,Organizando código teste}.

O bloco final mostra uma maneira simples de executar os testes. A função @ref{1019,,unittest.main()} fornece uma interface de linha de comando para o Script de teste. Quando executado a partir da linha de comando, o Script acima produz uma saída que se parece com isso:

@example
...
----------------------------------------------------------------------
Ran 3 tests in 0.000s

OK
@end example

Passando a opção @code{-v} para o nosso Script de teste instruirá a função @ref{1019,,unittest.main()} a habilitar um nível mais alto de verbosidade e produzirá a seguinte saída:

@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

Os exemplos acima mostram os recursos mais utilizados @ref{106,,unittest} que são suficientes para atender a muitas necessidades de testes diários. O restante da documentação explora o conjunto completo de recursos desde os primeiros princípios.


Alterado na versão 3.11: The behavior of returning a value from a test method (other than the default
@code{None} value), is now deprecated.


@node Interface de linha de comando<8>,Test Discovery,Exemplo Básico,unittest — Framework de testes unitários
@anchor{library/unittest command-line-interface}@anchor{427f}@anchor{library/unittest unittest-command-line-interface}@anchor{4280}
@subsubsection Interface de linha de comando


O módulo unittest pode ser usado diretamente da linha de comando para executar testes de módulos, classes ou mesmo testes de métodos individuais:

@example
python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
@end example

Você pode passar uma lista com qualquer combinação de nomes de módulos e nomes de classes ou métodos totalmente qualificados.

Os módulos de teste podem ser especificados por caminhos de arquivo também:

@example
python -m unittest tests/test_something.py
@end example

Isso permite que você use o auto-completar do console/shell para especificar o módulo de teste. O arquivo especificado precisa ser “importável” como um módulo. O caminho é convertido para um nome de módulo ao remover a extensão @cite{.py} e conversando os separadores do caminho em @cite{.}. Se você quer executar um arquivo de teste que não é importável como um módulo, você deve executar o arquivo diretamente.

Você pode executar os testes com mais detalhes (maior verbosidade) ao usar o sinalizador -v:

@example
python -m unittest -v test_module
@end example

Quando executado sem argumentos @ref{4281,,Test Discovery} é iniciado:

@example
python -m unittest
@end example

Para uma lista de todas as opções de linha de comando:

@example
python -m unittest -h
@end example


Alterado na versão 3.2: Em versões mais antigas, era possível de executar apenas testes de métodos individuais e não de módulos ou classes.


@menu
* Opções de linha de comando: Opções de linha de comando<4>. 

@end menu

@node Opções de linha de comando<4>,,,Interface de linha de comando<8>
@anchor{library/unittest command-line-options}@anchor{4282}
@subsubsection Opções de linha de comando


@code{unittest} suporta as seguintes opções de linha de comando:

@geindex unittest opção de linha de comando; -b
@geindex unittest opção de linha de comando; --buffer
@anchor{library/unittest cmdoption-unittest-b}@anchor{1376}@anchor{library/unittest cmdoption-unittest-buffer}@anchor{4283}
@deffn {Option} @w{-}b, @w{-}@w{-}buffer

Os streams da saída padrão e do erro padrão são carregados durante a execução do teste. A saída de um teste que passou é descartada. A saída geralmente é mostrada quando um teste falha e é adicionada às mensagens de falha.
@end deffn

@geindex unittest opção de linha de comando; -c
@geindex unittest opção de linha de comando; --catch
@anchor{library/unittest cmdoption-unittest-c}@anchor{1377}@anchor{library/unittest cmdoption-unittest-catch}@anchor{4284}
@deffn {Option} @w{-}c, @w{-}@w{-}catch

@code{Control}-@code{C} durante a execução do teste aguarda até que o teste corrente termine e a partir disso mostra todos os resultados até o momento. Um segundo @code{Control}-@code{C} invoca uma exceção @ref{9d9,,KeyboardInterrupt} comum.

Veja @ref{4285,,Signal Handling} para as funções que provêm essa funcionalidade.
@end deffn

@geindex unittest opção de linha de comando; -f
@geindex unittest opção de linha de comando; --failfast
@anchor{library/unittest cmdoption-unittest-f}@anchor{1379}@anchor{library/unittest cmdoption-unittest-failfast}@anchor{4286}
@deffn {Option} @w{-}f, @w{-}@w{-}failfast

Parar a execução do teste no primeiro erro ou falha.
@end deffn

@geindex unittest opção de linha de comando; -k
@anchor{library/unittest cmdoption-unittest-k}@anchor{4287}
@deffn {Option} @w{-}k

Only run test methods and classes that match the pattern or substring.
This option may be used multiple times, in which case all test cases that
match any of the given patterns are included.

Padrões que contém um caractere curinga (@code{*}) são combinados com os testes pelo método @ref{19e0,,fnmatch.fnmatchcase()}; caso contrário, é utilizada uma combinação simples de substrings, diferenciando-se letras maiúsculas e minúsculas.

Padrões são combinados com o nome completo qualificado do método de teste no formato que ele é importado pelo carregador.

Por exemplo, @code{-k foo} combina com @code{foo_tests.SomeTest.test_something}, @code{bar_tests.SomeTest.test_foo}, mas não com @code{bar_tests.FooTest.test_something}.
@end deffn

@geindex unittest opção de linha de comando; --locals
@anchor{library/unittest cmdoption-unittest-locals}@anchor{4288}
@deffn {Option} @w{-}@w{-}locals

Mostra variáveis locais no traceback.
@end deffn

@geindex unittest opção de linha de comando; --durations
@anchor{library/unittest cmdoption-unittest-durations}@anchor{4289}
@deffn {Option} @w{-}@w{-}durations N

Show the N slowest test cases (N=0 for all).
@end deffn


Adicionado na versão 3.2: As opções de linha de comando @code{-b}, @code{-c} e @code{-f} foram adicionadas.



Adicionado na versão 3.5: A opção de linha de comando @code{--locals}.



Adicionado na versão 3.7: A opção de linha de comando @code{-k}.



Adicionado na versão 3.12: The command-line option @code{--durations}.


A linha de comando também pode ser usada para descobrir testes, para executar todos os testes de um projeto ou apenas de um subconjunto.

@node Test Discovery,Organizando código teste,Interface de linha de comando<8>,unittest — Framework de testes unitários
@anchor{library/unittest test-discovery}@anchor{428a}@anchor{library/unittest unittest-test-discovery}@anchor{4281}
@subsubsection Test Discovery



Adicionado na versão 3.2.


Unittest supports simple test discovery. In order to be compatible with test
discovery, all of the test files must be @ref{1ddc,,modules} or
@ref{1ded,,packages} importable from the top-level directory of
the project (this means that their filenames must be valid @ref{2021,,identifiers}).

O descobrimento de testes é implementado no @ref{101b,,TestLoader.discover()}, mas também pode ser utilizado a partir da linha de comando. O comando básico para uso é:

@example
cd project_directory
python -m unittest discover
@end example

@cartouche
@quotation Nota 
Como um atalho, @code{python -m unittest} é o equivalente a @code{python -m unittest discover}. Se você deseja passar argumentos para a descoberta de testes, o subcomando @code{discover} deve ser usado explicitamente.
@end quotation
@end cartouche

O sub-comando @code{discover} (descubra) tem as seguintes opções:

@geindex unittest-discover opção de linha de comando; -v
@geindex unittest-discover opção de linha de comando; --verbose
@anchor{library/unittest cmdoption-unittest-discover-v}@anchor{428b}@anchor{library/unittest cmdoption-unittest-discover-verbose}@anchor{428c}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

Saída verbosa
@end deffn

@geindex unittest-discover opção de linha de comando; -s
@geindex unittest-discover opção de linha de comando; --start-directory
@anchor{library/unittest cmdoption-unittest-discover-s}@anchor{428d}@anchor{library/unittest cmdoption-unittest-discover-start-directory}@anchor{428e}
@deffn {Option} @w{-}s, @w{-}@w{-}start@w{-}directory directory

Diretório no qual se inicia o descobrimento (@code{.} por padrão)
@end deffn

@geindex unittest-discover opção de linha de comando; -p
@geindex unittest-discover opção de linha de comando; --pattern
@anchor{library/unittest cmdoption-unittest-discover-p}@anchor{428f}@anchor{library/unittest cmdoption-unittest-discover-pattern}@anchor{4290}
@deffn {Option} @w{-}p, @w{-}@w{-}pattern pattern

Padrão de texto para se descobrir os arquivos de teste (@code{test*.py} por padrão)
@end deffn

@geindex unittest-discover opção de linha de comando; -t
@geindex unittest-discover opção de linha de comando; --top-level-directory
@anchor{library/unittest cmdoption-unittest-discover-t}@anchor{4291}@anchor{library/unittest cmdoption-unittest-discover-top-level-directory}@anchor{4292}
@deffn {Option} @w{-}t, @w{-}@w{-}top@w{-}level@w{-}directory directory

Diretório raiz do projeto (diretório de início por padrão)
@end deffn

As opções @ref{428d,,-s}, @ref{428f,,-p} e @ref{4291,,-t} podem ser passadas como argumentos posicionais nessa ordem. As duas linhas de comando seguintes são equivalentes:

@example
python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"
@end example

Além de aceitar caminhos, também é possível passar o nome de um pacote, como @code{myproject.subpackage.test}, como diretório de início. O nome do pacote que for passado será importado e sua localização no sistema de arquivos será utilizada como diretório de início.

@cartouche
@quotation Cuidado 
O descobridor de testes importa os testes para carregá-los. Uma vez que o descobridor tiver encontrado todos os arquivos de teste a partir do diretório de início especificado, ele transforma os caminhos em nomes de pacotes para conseguir importá-los. Por exemplo, @code{foo/bar/baz.py} será importado como @code{foo.bar.baz}.

Se você possuir um pacote instalado globalmente e tentar executar o descobrimento em uma versão diferente deste mesmo pacote, a importação `pode' acontecer do lugar errado. Se isso acontecer, o descobridor de testes irá emitir um alerta e encerrar a execução.

Se você configurar o diretório de início como sendo um nome de pacote, não um caminho para um diretório, o descobridor irá presumir que qualquer local do qual ele importar é o local correto. Neste caso, nenhum alerta será emitido.
@end quotation
@end cartouche

Módulos de testes e pacotes podem conter customizações no carregamento de testes utilizando @ref{4293,,load_tests protocol}.


Alterado na versão 3.4: Descoberta de testes suporta @ref{1dee,,pacote de espaço de nomes} para o diretório de início. Perceba que você precisa especificar o diretório de nível superior também (ex: @code{python -m unittest discover -s root/namespace -t root}).



Alterado na versão 3.11: @ref{106,,unittest} dropped the @ref{1dee,,namespace packages}
support in Python 3.11. It has been broken since Python 3.7. Start directory and
subdirectories containing tests must be regular package that have
@code{__init__.py} file.

Directories containing start directory still can be a namespace package.
In this case, you need to specify start directory as dotted package name,
and target directory explicitly. For example:

@example
# proj/  <-- current directory
#   namespace/
#     mypkg/
#       __init__.py
#       test_mypkg.py

python -m unittest discover -s namespace.mypkg -t .
@end example


@node Organizando código teste,Reutilizando códigos de teste antigos,Test Discovery,unittest — Framework de testes unitários
@anchor{library/unittest organizing-test-code}@anchor{4294}@anchor{library/unittest organizing-tests}@anchor{427e}
@subsubsection Organizando código teste


O bloco básico de construção dos testes unitários são os `casos de teste' — cenários únicos que devem ser configurados e avaliados em sua correção. No @ref{106,,unittest}, casos de teste são representados por instâncias @ref{44f,,unittest.TestCase}. Para criar seus próprios casos de teste, você deve escrever subclasses de @ref{44f,,TestCase} ou utilizar @ref{17fb,,FunctionTestCase}.

O código de teste em uma instância da classe @ref{44f,,TestCase} deve ser completamente auto-contido, de maneira que ele possa ser executado isoladamente ou combinado, de forma arbitrária, com quaisquer outros casos de teste.

A mais simples subclasse de @ref{44f,,TestCase} irá implementar um método de teste (i.e. um método cujo nome começa com @code{test}) para executar um teste:

@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{427b,,assert* methods}
provided by the @ref{44f,,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'.

Os testes podem ser muitos, e as configurações podem ser repetitivas. Por sorte, temos como reaproveitar estas configurações implementando um método chamado @ref{137e,,setUp()}, o qual será automaticamente chamado pelo framework de teste para cada teste único que executarmos:

@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 
A ordem de execução dos testes será feita com base na ordenação dos nomes dos métodos de teste respeitando os critérios da ordenação de strings embutida.
@end quotation
@end cartouche

Se o método @ref{137e,,setUp()} levantar uma exceção durante a sua execução, o framework irá considerar que o teste sofreu um erro e o método de teste não será executado.

De maneira similar, pode-se definir um método @ref{137f,,tearDown()} que limpa o ambiente após a execução do método de teste:

@example
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
@end example

Se o método @ref{137e,,setUp()} for bem sucedido, o método @ref{137f,,tearDown()} será executado, independente do resultado do método de teste.

Such a working environment for the testing code is called a
`test fixture'.  A new TestCase instance is created as a unique
test fixture used to execute each individual test method.  Thus
@ref{137e,,setUp()}, @ref{137f,,tearDown()}, and @code{TestCase.__init__()}
will be called once per test.

É recomendado utilizar implementações de TestCase para agrupar testes de acordo com as funcionalidades que eles testam. @ref{106,,unittest} disponibiliza um mecanismo para isso: a `suíte de testes', representada pela classe @ref{e20,,TestSuite} do módulo @ref{106,,unittest}. Em grande parte dos casos, chamar @ref{1019,,unittest.main()} é suficiente para coletar todos os casos de teste do módulo e executá-los para você.

Entretanto, caso você queira customizar a construção da sua suíte de testes, é possível fazê-la desta forma:

@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

Você pode colocar as definições dos casos de teste e suíte de testes em um mesmo módulo que contém o código a ser testado (tal como @code{widget.py}), mas existem várias vantagens ao colocar o código dos testes em um módulo separado, como @code{test_widget.py}:


@itemize *

@item 
O módulo de teste pode ser executado de maneira isolada a partir da linha de comando.

@item 
O código de teste pode ser mais facilmente separado do código a ser entregue.

@item 
Há uma menor tentação para modificar o código de teste para que ele se adéque ao código testado sem que haja uma boa razão.

@item 
O código de teste deve ser modificado muito menos frequentemente do que o código que ele testa.

@item 
Código testado pode ser reformulado mais facilmente.

@item 
Testes para módulos escritos em C devem ser, obrigatoriamente, colocados em módulos separados, então por que não manter a consistência?

@item 
Se as estratégias de teste mudarem, não há a necessidade de mudar o código-fonte.
@end itemize

@node Reutilizando códigos de teste antigos,Ignorando testes e falhas esperadas,Organizando código teste,unittest — Framework de testes unitários
@anchor{library/unittest legacy-unit-tests}@anchor{4295}@anchor{library/unittest re-using-old-test-code}@anchor{4296}
@subsubsection Reutilizando códigos de teste antigos


Alguns usuários irão encontrar antigos códigos de teste que eles gostariam de executar com @ref{106,,unittest} sem converter cada função antiga para uma subclasse de @ref{44f,,TestCase}.

Por isso, @ref{106,,unittest} contém uma classe @ref{17fb,,FunctionTestCase}. Esta subclasse de @ref{44f,,TestCase} pode ser utilizada para englobar funções de teste existentes. Funções de definição de estado inicial e final (set-up e tear-down) também podem ser fornecidas.

Dadas as seguintes funções de teste:

@example
def testSomething():
    something = makeSomething()
    assert something.name is not None
    # ...
@end example

é possível criar uma instância de caso de teste, com métodos opcionais de configuração inicial e final (set-up e tear-down), como mostrado a seguir:

@example
testcase = unittest.FunctionTestCase(testSomething,
                                     setUp=makeSomethingDB,
                                     tearDown=deleteSomethingDB)
@end example

@cartouche
@quotation Nota 
Apesar da classe @ref{17fb,,FunctionTestCase} poder ser utilizada para converter rapidamente um teste existente em um teste do módulo @ref{106,,unittest}, esta abordagem não é recomendada. Investir tempo para configurar corretamente uma subclasse de @ref{44f,,TestCase} irá tornar futuras refatorações infinitamente mais fáceis.
@end quotation
@end cartouche

In some cases, the existing tests may have been written using the @ref{3a,,doctest}
module.  If so, @ref{3a,,doctest} provides a @ref{e1f,,DocTestSuite} class that can
automatically build @ref{e20,,unittest.TestSuite} instances from the existing
@ref{3a,,doctest}-based tests.

@node Ignorando testes e falhas esperadas,Distinguindo iterações de teste utilizando subtestes,Reutilizando códigos de teste antigos,unittest — Framework de testes unitários
@anchor{library/unittest skipping-tests-and-expected-failures}@anchor{4297}@anchor{library/unittest unittest-skipping}@anchor{4298}
@subsubsection Ignorando testes e falhas esperadas



Adicionado na versão 3.1.


Unittest suporta ignorar métodos de teste individuais e, até mesmo, classes de teste inteiras. Além disso, há suporte para a marcação de um teste como uma “falha esperada”, um teste que está incorreto e irá falhar, mas não deve ser considerado como uma falha no @ref{11a6,,TestResult}.

Ignorar um teste é simplesmente uma questão de utilizar o @ref{731,,decorador} @ref{1b50,,skip()} ou uma de suas variantes condicionais, chamando @ref{4299,,TestCase.skipTest()} em um @ref{137e,,setUp()} ou método de teste, ou levantando @ref{101a,,SkipTest} diretamente.

Ignorar se parece basicamente com:

@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 é a saída da execução do exemplo acima em 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

Classes podem ser puladas assim como métodos:

@example
@@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
    def test_not_run(self):
        pass
@end example

@ref{137e,,TestCase.setUp()} também pode ignorar o teste. Isso é útil quando um recurso que precisa ser configurado não está disponível.

Falhas esperadas usam o decorador @ref{429a,,expectedFailure()}:

@example
class ExpectedFailureTestCase(unittest.TestCase):
    @@unittest.expectedFailure
    def test_fail(self):
        self.assertEqual(1, 0, "broken")
@end example

É simples ignorar com decoradores customizados, basta fazer um decorador que chama @ref{1b50,,skip()} no teste quando ele deve ser ignorado. Este decorador ignora o teste a não ser que o objeto fornecido tenha um determinado 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

Os decoradores e exceção seguintes ignoram testes e falhas esperadas:

@geindex skip() (no módulo unittest)
@anchor{library/unittest unittest skip}@anchor{1b50}
@deffn {Função} @@unittest.skip (reason)

Ignora incondicionalmente o teste decorado. `reason' deve descrever a razão pela qual o teste está sendo ignorado.
@end deffn

@geindex skipIf() (no módulo unittest)
@anchor{library/unittest unittest skipIf}@anchor{429b}
@deffn {Função} @@unittest.skipIf (condition, reason)

Ignora o teste decorado se `condition' for verdadeiro.
@end deffn

@geindex skipUnless() (no módulo unittest)
@anchor{library/unittest unittest skipUnless}@anchor{429c}
@deffn {Função} @@unittest.skipUnless (condition, reason)

Ignora o teste decorado a não ser que `condition' seja verdadeiro.
@end deffn

@geindex expectedFailure() (no módulo unittest)
@anchor{library/unittest unittest expectedFailure}@anchor{429a}
@deffn {Função} @@unittest.expectedFailure

Marca o teste como uma falha ou erro esperado. Se o teste falhar ou ocorrerem erros na função de teste mesmo (ao invés de em um dos métodos `test fixture'), então ele será considerado como executado com sucesso. Se o teste passar, ele será considerado como uma falha.
@end deffn

@geindex SkipTest
@anchor{library/unittest unittest SkipTest}@anchor{101a}
@deffn {Exceção} unittest.SkipTest (reason)

Esta exceção é levantada para ignorar um teste.

Normalmente, você pode utilizar @ref{4299,,TestCase.skipTest()} ou um dos decoradores para ignorar sem ter de levantar esta exceção diretamente.
@end deffn

Testes ignorados não terão seus métodos @ref{137e,,setUp()} ou @ref{137f,,tearDown()} executados. Classes ignoradas não terão seus métodos @ref{a58,,setUpClass()} ou @ref{137c,,tearDownClass()} executados. Módulos ignorados não terão seus métodos @ref{a57,,setUpModule()} ou @ref{137b,,tearDownModule()} executados.

@node Distinguindo iterações de teste utilizando subtestes,Classes e funções,Ignorando testes e falhas esperadas,unittest — Framework de testes unitários
@anchor{library/unittest distinguishing-test-iterations-using-subtests}@anchor{429d}@anchor{library/unittest subtests}@anchor{1018}
@subsubsection Distinguindo iterações de teste utilizando subtestes



Adicionado na versão 3.4.


Quando existem pequenas diferenças entre os seus testes, por exemplo alguns parâmetros, unittest permite que você distinga-os dentro do corpo de um método de teste utilizando o gerenciador de contexto @ref{1017,,subTest()}.

Por exemplo, o teste seguinte:

@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

irá produzir a seguinte saída:

@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

Sem usar um subteste, a execução para depois da primeira falha e o erro será menos fácil de ser diagnosticado porque o valor de @code{i} não será mostrado:

@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 Classes e funções,Classes e Módulos de Definição de Contexto,Distinguindo iterações de teste utilizando subtestes,unittest — Framework de testes unitários
@anchor{library/unittest classes-and-functions}@anchor{429e}@anchor{library/unittest unittest-contents}@anchor{429f}
@subsubsection Classes e funções


Esta seção descreve de maneira aprofundada a API do módulo @ref{106,,unittest}.

@menu
* Casos de teste:: 
* Grouping tests:: 
* Carregando e executando testes:: 

@end menu

@node Casos de teste,Grouping tests,,Classes e funções
@anchor{library/unittest test-cases}@anchor{42a0}@anchor{library/unittest testcase-objects}@anchor{42a1}
@subsubsection Casos de teste


@geindex TestCase (classe em unittest)
@anchor{library/unittest unittest TestCase}@anchor{44f}
@deffn {Classe} unittest.TestCase (methodName='runTest')

Instâncias da classe @ref{44f,,TestCase} representam unidades lógicas de teste no universo do @ref{106,,unittest}. Esta classe deve ser utilizada como classe base, com testes específicos sendo implementados por subclasses concretas. Esta classe implementa a interface requerida pelo executor de testes, para permitir o controle dos testes, e métodos que o código de teste pode utilizar para checar e reportar diversos tipos de falhas.

Cada instância da classe @ref{44f,,TestCase} irá executar um único método base: o método chamado `methodName'. Em muitos casos de uso da classe @ref{44f,,TestCase}, você não precisará modificar o `methodName' ou reimplementar o método @code{runTest()} padrão.


Alterado na versão 3.2: @ref{44f,,TestCase} pode ser instanciada com sucesso sem fornecer um `methodName'. Isso torna mais fácil experimentar com @ref{44f,,TestCase} a partir de um interpretador interativo.


Instâncias @ref{44f,,TestCase} possuem três grupos de métodos: um grupo utilizado para executar o teste, outro utilizado pela implementação do teste para checar as condições e reportar falhas, e alguns métodos de investigação para permitir coletar dados sobre o teste em si.

Os métodos do primeiro grupo (que executam os testes) são:

@geindex setUp() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase setUp}@anchor{137e}
@deffn {Método} setUp ()

Método chamado para preparar a definição de contexto de teste. Chamado imediatamente após chamar o método de teste; exceto pelo @ref{6a9,,AssertionError} ou @ref{101a,,SkipTest}, qualquer exceção levantada por este método será considerada um erro além de uma simples falha de teste. A implementação padrão não faz nada.
@end deffn

@geindex tearDown() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase tearDown}@anchor{137f}
@deffn {Método} tearDown ()

Método chamado imediatamente após o método de teste ter sido chamado e o resultado registrado. Este método é chamado mesmo se o método de teste tiver levantado uma exceção, então a implementação em subclasses deve ser feita com cautela ao verificar o estado interno. Qualquer exceção além de @ref{6a9,,AssertionError} ou @ref{101a,,SkipTest} levantada por este método será considerado um erro adicional, e não uma simples falha de teste (que incrementaria o número total de erros no relatório final de testes). Este método será executado apenas se o método @ref{137e,,setUp()} for bem sucedido, independente do resultado do método de teste. A implementação padrão não faz nada.
@end deffn

@geindex setUpClass() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase setUpClass}@anchor{a58}
@deffn {Método} setUpClass ()

Um método de classe chamado antes da execução dos testes de uma classe específica. O método @code{setUpClass} é chamado com a classe sendo o único argumento e deve ser decorada como um @ref{166,,classmethod()}:

@example
@@classmethod
def setUpClass(cls):
    ...
@end example

Veja @ref{42a2,,Classes e Módulos de Definição de Contexto} para mais detalhes.


Adicionado na versão 3.2.

@end deffn

@geindex tearDownClass() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase tearDownClass}@anchor{137c}
@deffn {Método} tearDownClass ()

Um método de classe chamado depois da execução dos testes de uma classe específica. O método @code{tearDownClass} é chamado com a classe sendo o único argumento e deve ser decorada como um @ref{166,,classmethod()}:

@example
@@classmethod
def tearDownClass(cls):
    ...
@end example

Veja @ref{42a2,,Classes e Módulos de Definição de Contexto} para mais detalhes.


Adicionado na versão 3.2.

@end deffn

@geindex run() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase run}@anchor{11a5}
@deffn {Método} run (result=None)

Executa o teste, registrando as informações no objeto resultado @ref{11a6,,TestResult}, passado como `result'. Se `result' for omitido, ou definido como @code{None}, um objeto resultado temporário é criado (chamando o método @ref{42a3,,defaultTestResult()}) e utilizado. O objeto resultado é retornado para quem chamou o método @ref{11a5,,run()}.

O mesmo efeito pode ser obtido ao chamar uma instância da classe @ref{44f,,TestCase}.


Alterado na versão 3.3: Versões anteriores de @code{run} não retornavam o resultado. Nem chamando por uma instância.

@end deffn

@geindex skipTest() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase skipTest}@anchor{4299}
@deffn {Método} skipTest (reason)

Ao se executar durante um método de teste ou @ref{137e,,setUp()}, pula o teste em execução. Veja @ref{4298,,Ignorando testes e falhas esperadas} para mais informações.


Adicionado na versão 3.1.

@end deffn

@geindex subTest() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase subTest}@anchor{1017}
@deffn {Método} subTest (msg=None, **params)

Retorna um gerenciador de contexto que executa, como subteste, o bloco de código englobado. `msg' e `params' são valores opcionais e arbitrários que são mostrados sempre quando um subteste falha, permitindo identificá-los claramente.

Um caso de teste pode conter inúmeras declarações de subteste e elas podem ser aninhadas de forma arbitrária.

Veja @ref{1018,,Distinguindo iterações de teste utilizando subtestes} para mais informações.


Adicionado na versão 3.4.

@end deffn

@geindex debug() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase debug}@anchor{19d4}
@deffn {Método} debug ()

Executa o teste sem coletar o resultado. Permite propagar exceções levantadas pelo teste e pode ser utilizado para oferecer suporte aos testes sob um depurador.
@end deffn
@anchor{library/unittest assert-methods}@anchor{427b}
A classe @ref{44f,,TestCase} oferece diversos métodos de asserção para checar e reportar falhas. A tabela a seguir lista os métodos mais utilizados (veja as tabelas abaixo para mais métodos de asserção).


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Avalia se

@tab

Novo em

@item

@ref{529,,assertEqual(a@comma{} b)}

@tab

@code{a == b}

@tab

@item

@ref{52a,,assertNotEqual(a@comma{} b)}

@tab

@code{a != b}

@tab

@item

@ref{527,,assertTrue(x)}

@tab

@code{bool(x) is True}

@tab

@item

@ref{528,,assertFalse(x)}

@tab

@code{bool(x) is False}

@tab

@item

@ref{1380,,assertIs(a@comma{} b)}

@tab

@code{a is b}

@tab

3.1

@item

@ref{1381,,assertIsNot(a@comma{} b)}

@tab

@code{a is not b}

@tab

3.1

@item

@ref{12cc,,assertIsNone(x)}

@tab

@code{x is None}

@tab

3.1

@item

@ref{12cd,,assertIsNotNone(x)}

@tab

@code{x is not None}

@tab

3.1

@item

@ref{1389,,assertIn(a@comma{} b)}

@tab

@code{a in b}

@tab

3.1

@item

@ref{138a,,assertNotIn(a@comma{} b)}

@tab

@code{a not in b}

@tab

3.1

@item

@ref{1382,,assertIsInstance(a@comma{} b)}

@tab

@code{isinstance(a, b)}

@tab

3.2

@item

@ref{1383,,assertNotIsInstance(a@comma{} b)}

@tab

@code{not isinstance(a, b)}

@tab

3.2

@end multitable


Todos os métodos de asserção aceitam um argumento `msg' que, se especificado, é utilizado como a mensagem de erro em caso de falha (veja também @ref{137a,,longMessage}). Note que o argumento nomeado `msg' pode ser passado para @ref{52d,,assertRaises()}, @ref{52f,,assertRaisesRegex()}, @ref{11a3,,assertWarns()} e @ref{11a4,,assertWarnsRegex()} apenas quando eles são utilizados como gerenciador de contexto.

@geindex assertEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertEqual}@anchor{529}
@deffn {Método} assertEqual (first, second, msg=None)

Testa se `first' e `second' são iguais. Se o resultado da comparação não indicar igualdade, o teste irá falhar.

Além disso, se `first' e `second' são exatamente do mesmo tipo e são uma lista, tupla, dict, set, frozenset, str, ou qualquer outro tipo que é registrado na subclasse com @ref{138d,,addTypeEqualityFunc()}, a função de igualdade específica do tipo é será chamada para gerar uma mensagem de erro mais útil (veja também @ref{42a4,,lista de métodos específicos por tipo})


Alterado na versão 3.1: Adição da chamada automática da função específica por tipo.



Alterado na versão 3.2: método @ref{1388,,assertMultiLineEqual()} adicionado como função de igualdade padrão para o tipo string.

@end deffn

@geindex assertNotEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertNotEqual}@anchor{52a}
@deffn {Método} assertNotEqual (first, second, msg=None)

Testa se `first' e `second' não são iguais. Se o resultado da comparação indicar igualdade, o teste irá falhar.
@end deffn

@geindex assertTrue() (método unittest.TestCase)
@geindex assertFalse() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertTrue}@anchor{527}
@deffn {Método} assertTrue (expr, msg=None)
@anchor{library/unittest unittest TestCase assertFalse}@anchor{528}
@deffnx {Método} assertFalse (expr, msg=None)

Testa se a expressão `expr' é verdadeira (ou falsa).

Note que isso é equivalente a @code{bool(expr) is True} e não a @code{expr is True} (use @code{assertIs(expr, True)} neste último caso). Este método também deve ser evitado quando outros métodos mais específicos estão disponíveis (e.g. @code{assertEqual(a, b)} no lugar de @code{assertTrue(a == b)}), já que estes podem ter uma melhor mensagem de erro em caso de falha.
@end deffn

@geindex assertIs() (método unittest.TestCase)
@geindex assertIsNot() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIs}@anchor{1380}
@deffn {Método} assertIs (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertIsNot}@anchor{1381}
@deffnx {Método} assertIsNot (first, second, msg=None)

Testa que `first' e `second' são (ou não são) o mesmo objeto.


Adicionado na versão 3.1.

@end deffn

@geindex assertIsNone() (método unittest.TestCase)
@geindex assertIsNotNone() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIsNone}@anchor{12cc}
@deffn {Método} assertIsNone (expr, msg=None)
@anchor{library/unittest unittest TestCase assertIsNotNone}@anchor{12cd}
@deffnx {Método} assertIsNotNone (expr, msg=None)

Testa se `expr' é (ou não é) @code{None}.


Adicionado na versão 3.1.

@end deffn

@geindex assertIn() (método unittest.TestCase)
@geindex assertNotIn() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIn}@anchor{1389}
@deffn {Método} assertIn (member, container, msg=None)
@anchor{library/unittest unittest TestCase assertNotIn}@anchor{138a}
@deffnx {Método} assertNotIn (member, container, msg=None)

Testa se `member' está (ou não está) em `container'.


Adicionado na versão 3.1.

@end deffn

@geindex assertIsInstance() (método unittest.TestCase)
@geindex assertNotIsInstance() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertIsInstance}@anchor{1382}
@deffn {Método} assertIsInstance (obj, cls, msg=None)
@anchor{library/unittest unittest TestCase assertNotIsInstance}@anchor{1383}
@deffnx {Método} assertNotIsInstance (obj, cls, msg=None)

Testa se `obj' é (ou não é) uma instância de `cls' (que pode ser uma classe ou uma tupla de classes, como suportado pela função @ref{442,,isinstance()}). Para checar pelo tipo exato, use @ref{1380,,assertIs(type(obj)@comma{} cls)}.


Adicionado na versão 3.2.

@end deffn

Também é possível checar a produção de exceções, avisos e mensagens de log usando os seguintes métodos:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Método

@tab

Avalia se

@tab

Novo em

@item

@ref{52d,,assertRaises(exc@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} levanta `exc'

@tab

@item

@ref{52f,,assertRaisesRegex(exc@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} levanta `exc' e a mensagem casa com a expressão regular `r'

@tab

3.1

@item

@ref{11a3,,assertWarns(warn@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} levanta `warn'

@tab

3.2

@item

@ref{11a4,,assertWarnsRegex(warn@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} levanta `warn' e a mensagem casa com a expressão regular `r'

@tab

3.2

@item

@ref{85c,,assertLogs(logger@comma{} level)}

@tab

O bloco @code{with} registra logs no `logger' com pelo menos um nível `level'

@tab

Módulos para processamento de XML

@item

@ref{85b,,assertNoLogs(logger@comma{} level)}

@tab


@table @asis

@item O bloco @code{with} não loga em

`logger' com `level' mínimo
@end table

@tab

3.10

@end multitable


@geindex assertRaises() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRaises}@anchor{52d}
@deffn {Método} assertRaises (exception, callable, *args, **kwds)

@deffnx {Método} assertRaises (exception, *, msg=None)

Testa se uma exceção é levantada quando `callable' é chamado com quaisquer argumentos nomeados ou posicionais que também são passados para @ref{52d,,assertRaises()}. O teste passa se `exception' for levantada e falha se outra exceção ou nenhuma exceção for levantada.

Se somente os argumentos `exception' e, possivelmente, `msg' forem passados, retorna um gerenciador de contexto para que o código sob teste possa ser escrito de forma embutida ao invés de ser definido como uma função:

@example
with self.assertRaises(SomeException):
    do_something()
@end example

Quando utilizado como gerenciador de contexto, @ref{52d,,assertRaises()} aceita o argumento nomeado adicional `msg'.

The context manager will store the caught exception object in its
@code{exception} attribute.  This can be useful if the intention
is to perform additional checks on the exception raised:

@example
with self.assertRaises(SomeException) as cm:
    do_something()

the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)
@end example


Alterado na versão 3.1: Adicionada a possibilidade de se utilizar @ref{52d,,assertRaises()} como gerenciador de contexto.



Alterado na versão 3.2: Added the @code{exception} attribute.



Alterado na versão 3.3: Adicionado o argumento nomeado `msg' quando utilizado como gerenciador de contexto.

@end deffn

@geindex assertRaisesRegex() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRaisesRegex}@anchor{52f}
@deffn {Método} assertRaisesRegex (exception, regex, callable, *args, **kwds)

@deffnx {Método} assertRaisesRegex (exception, regex, *, msg=None)

Similar ao @ref{52d,,assertRaises()} mas também testa se `regex' casa com a representação em string da exceção levantada. `regex' pode ser um objeto expressão regular ou uma string contendo uma expressão regular compatível com o uso pela função @ref{126d,,re.search()}. Exemplos:

@example
self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
                       int, 'XYZ')
@end example

ou:

@example
with self.assertRaisesRegex(ValueError, 'literal'):
   int('XYZ')
@end example


Adicionado na versão 3.1: Adicionado com o nome @code{assertRaisesRegexp}.



Alterado na versão 3.2: Renomeado para @ref{52f,,assertRaisesRegex()}.



Alterado na versão 3.3: Adicionado o argumento nomeado `msg' quando utilizado como gerenciador de contexto.

@end deffn

@geindex assertWarns() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertWarns}@anchor{11a3}
@deffn {Método} assertWarns (warning, callable, *args, **kwds)

@deffnx {Método} assertWarns (warning, *, msg=None)

Testa se o aviso `warning' é acionado quando `callable' é chamado com quaisquer argumentos nomeados ou posicionais que também são passados para @ref{11a3,,assertWarns()}. O teste passa se `warning' for acionado e falha se não for. Qualquer exceção é considerada como falha. Para capturar qualquer aviso presente em um grupo de avisos, uma tupla contendo as classes de aviso podem ser passadas como `warning'.

Se apenas os argumentos `warning' e, possivelmente, `msg' forem passados, retorna um gerenciador de contexto para que o código sob teste possa ser escrito de forma embutida ao invés de ser definido como uma função:

@example
with self.assertWarns(SomeWarning):
    do_something()
@end example

Quando usado como gerenciador de contexto, @ref{11a3,,assertWarns()} aceita o argumento nomeado adicional `msg'.

The context manager will store the caught warning object in its
@code{warning} attribute, and the source line which triggered the
warnings in the @code{filename} and @code{lineno} attributes.
This can be useful if the intention is to perform additional checks
on the warning caught:

@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 independente dos filtros de aviso configurados no momento em que é chamado.


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionado o argumento nomeado `msg' quando utilizado como gerenciador de contexto.

@end deffn

@geindex assertWarnsRegex() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertWarnsRegex}@anchor{11a4}
@deffn {Método} assertWarnsRegex (warning, regex, callable, *args, **kwds)

@deffnx {Método} assertWarnsRegex (warning, regex, *, msg=None)

Similar ao @ref{11a3,,assertWarns()} mas também testa se `regex' casa com a mensagem do aviso acionado. `regex' pode ser um objeto expressão regular ou uma string contendo uma expressão regular compatível para uso pela função @ref{126d,,re.search()}. Exemplo:

@example
self.assertWarnsRegex(DeprecationWarning,
                      r'legacy_function\(\) is deprecated',
                      legacy_function, 'XYZ')
@end example

ou:

@example
with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    frobnicate('/etc/passwd')
@end example


Adicionado na versão 3.2.



Alterado na versão 3.3: Adicionado o argumento nomeado `msg' quando utilizado como gerenciador de contexto.

@end deffn

@geindex assertLogs() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertLogs}@anchor{85c}
@deffn {Método} assertLogs (logger=None, level=None)

Um gerenciador de contexto para testar se pelo menos uma mensagem é inserida em `logger' ou em um de seus filhos, com pelo menos um nível `level'.

Se fornecido, `logger' deve ser um objeto @ref{b64,,logging.Logger} ou uma @ref{44c,,str} fornecendo o nome de um logger. O padrão é o logger root, o qual irá capturar todas as mensagens que não foram bloqueadas por um logger descendente não-propagante.

If given, `level' should be either a numeric logging level or
its string equivalent (for example either @code{"ERROR"} or
@ref{2e42,,logging.ERROR}).  The default is @ref{2e3b,,logging.INFO}.

O teste passa se pelo menos uma das mensagens emitidas dentro do bloco @code{with} casa com as condições dadas por `logger' e `level', falhando caso contrário.

O objeto retornado pelo gerenciador de contexto é um registro auxiliar que mantém os rastros das mensagens de log capturadas de acordo com os critérios dados. Ele possui dois atributos:

@geindex records (atributo unittest.TestCase)
@anchor{library/unittest unittest TestCase records}@anchor{42a5}
@deffn {Atributo} records

Uma lista de objetos de log da classe @ref{101c,,logging.LogRecord} que foram compatíveis com os critérios dados.
@end deffn

@geindex output (atributo unittest.TestCase)
@anchor{library/unittest unittest TestCase output}@anchor{42a6}
@deffn {Atributo} output

Uma lista de objetos da classe @ref{44c,,str} com a saída formatada das mensagens de log compatíveis com os critérios dados.
@end deffn

Exemplo:

@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


Adicionado na versão 3.4.

@end deffn

@geindex assertNoLogs() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertNoLogs}@anchor{85b}
@deffn {Método} assertNoLogs (logger=None, level=None)

Um gerenciador de contexto para testar que nenhuma mensagem é logada no `logger' ou um dos seus filhos, com pelo menos o `level' fornecido.

Se passado, `logger' deve ser um objeto da classe @ref{b64,,logging.Logger} ou um objeto da classe @ref{44c,,str} com o nome do registrador de logs. O padrão é o registrador de log raiz, que irá capturar todas as mensagens.

If given, `level' should be either a numeric logging level or
its string equivalent (for example either @code{"ERROR"} or
@ref{2e42,,logging.ERROR}).  The default is @ref{2e3b,,logging.INFO}.

Ao contrário de @ref{85c,,assertLogs()}, nada será retornado pelo gerenciador de contexto.


Adicionado na versão 3.10.

@end deffn

Existem também outros métodos usados para executar verificações mais específicas, como:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Avalia se

@tab

Novo em

@item

@ref{52b,,assertAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) == 0}

@tab

@item

@ref{52c,,assertNotAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) != 0}

@tab

@item

@ref{1384,,assertGreater(a@comma{} b)}

@tab

@code{a > b}

@tab

3.1

@item

@ref{1385,,assertGreaterEqual(a@comma{} b)}

@tab

@code{a >= b}

@tab

3.1

@item

@ref{1386,,assertLess(a@comma{} b)}

@tab

@code{a < b}

@tab

3.1

@item

@ref{1387,,assertLessEqual(a@comma{} b)}

@tab

@code{a <= b}

@tab

3.1

@item

@ref{52e,,assertRegex(s@comma{} r)}

@tab

@code{r.search(s)}

@tab

3.1

@item

@ref{530,,assertNotRegex(s@comma{} r)}

@tab

@code{not r.search(s)}

@tab

3.2

@item

@ref{126b,,assertCountEqual(a@comma{} b)}

@tab

`a' e `b' possuem os mesmos elementos na mesma quantidade, independente da sua ordem.

@tab

3.2

@end multitable


@geindex assertAlmostEqual() (método unittest.TestCase)
@geindex assertNotAlmostEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertAlmostEqual}@anchor{52b}
@deffn {Método} assertAlmostEqual (first, second, places=7, msg=None, delta=None)
@anchor{library/unittest unittest TestCase assertNotAlmostEqual}@anchor{52c}
@deffnx {Método} assertNotAlmostEqual (first, second, places=7, msg=None, delta=None)

Testa se `first' e `second' são (ou não são) aproximadamente iguais considerando a diferença entre eles, arredondando para o número de casas decimais dado (7 por padrão), e comparando a zero. Note que estes métodos arredondam os valores considerando o número de casas decimais (i.e. como a função @ref{131d,,round()}) e não o número de algarismos significativos.

Se `delta' é fornecido no lugar de `places', a diferença entre `first' e `second' deve ser menor ou igual a (ou maior que) `delta'.

Passar `delta' e `places' ao mesmo tempo levanta a exceção @ref{2c3,,TypeError}.


Alterado na versão 3.2: @ref{52b,,assertAlmostEqual()} considera, automaticamente, objetos quase iguais que possuem a comparação de igualdade dada como verdadeira. @ref{52c,,assertNotAlmostEqual()} falha automaticamente se os objetos possuem a comparação de igualdade dada como verdadeira. Adicionado o argumento nomeado `delta'.

@end deffn

@geindex assertGreater() (método unittest.TestCase)
@geindex assertGreaterEqual() (método unittest.TestCase)
@geindex assertLess() (método unittest.TestCase)
@geindex assertLessEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertGreater}@anchor{1384}
@deffn {Método} assertGreater (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertGreaterEqual}@anchor{1385}
@deffnx {Método} assertGreaterEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLess}@anchor{1386}
@deffnx {Método} assertLess (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLessEqual}@anchor{1387}
@deffnx {Método} assertLessEqual (first, second, msg=None)

Testa que `first' é respectivamente >, >=, < ou <= que `second', dependendo do nome do método. Se não for, o teste irá falhar:

@example
>>> self.assertGreaterEqual(3, 4)
AssertionError: "3" unexpectedly not greater than or equal to "4"
@end example


Adicionado na versão 3.1.

@end deffn

@geindex assertRegex() (método unittest.TestCase)
@geindex assertNotRegex() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertRegex}@anchor{52e}
@deffn {Método} assertRegex (text, regex, msg=None)
@anchor{library/unittest unittest TestCase assertNotRegex}@anchor{530}
@deffnx {Método} assertNotRegex (text, regex, msg=None)

Testa que uma procura por `regex' corresponde (ou não corresponde) a `text'. Em caso de falha, a mensagem de erro irá incluir o padrão e o `text' (ou o padrão e a parte do `text' que inesperadamente correspondeu). `regex' pode ser um objeto de expressão regular ou uma string contendo uma expressão regular adequada para uso por @ref{126d,,re.search()}.


Adicionado na versão 3.1: Adicionada abaixo do nome @code{assertRegexpMatches}.



Alterado na versão 3.2: O método @code{assertRegexpMatches()} foi renomeado para @ref{52e,,assertRegex()}.



Adicionado na versão 3.2: @ref{530,,assertNotRegex()}.

@end deffn

@geindex assertCountEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertCountEqual}@anchor{126b}
@deffn {Método} assertCountEqual (first, second, msg=None)

Test that sequence `first' contains the same elements as `second',
regardless of their order. When they don’t, an error message listing the
differences between the sequences will be generated.

Elementos duplicados `não' são ignorados ao comparar `first' e `second'. É verificado se cada elemento tem a mesma contagem em ambas sequências. Equivalente a: @code{assertEqual(Counter(list(first)), Counter(list(second)))}, mas também funciona com sequências de objetos não hasheáveis.


Adicionado na versão 3.2.

@end deffn
@anchor{library/unittest type-specific-methods}@anchor{42a4}
The @ref{529,,assertEqual()} method dispatches the equality check for objects of
the same type to different type-specific methods.  These methods are already
implemented for most of the built-in types, but it’s also possible to
register new methods using @ref{138d,,addTypeEqualityFunc()}:

@geindex addTypeEqualityFunc() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase addTypeEqualityFunc}@anchor{138d}
@deffn {Método} addTypeEqualityFunc (typeobj, function)

Registers a type-specific method called by @ref{529,,assertEqual()} to check
if two objects of exactly the same `typeobj' (not subclasses) compare
equal.  `function' must take two positional arguments and a third msg=None
keyword argument just as @ref{529,,assertEqual()} does.  It must raise
@ref{423b,,self.failureException(msg)} when inequality
between the first two parameters is detected – possibly providing useful
information and explaining the inequalities in details in the error
message.


Adicionado na versão 3.1.

@end deffn

The list of type-specific methods automatically used by
@ref{529,,assertEqual()} are summarized in the following table.  Note
that it’s usually not necessary to invoke these methods directly.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

Método

@tab

Usado para comparar

@tab

Novo em

@item

@ref{1388,,assertMultiLineEqual(a@comma{} b)}

@tab

strings

@tab

3.1

@item

@ref{12cb,,assertSequenceEqual(a@comma{} b)}

@tab

sequências

@tab

3.1

@item

@ref{12c9,,assertListEqual(a@comma{} b)}

@tab

listas

@tab

3.1

@item

@ref{12ca,,assertTupleEqual(a@comma{} b)}

@tab

tuplas

@tab

3.1

@item

@ref{12c7,,assertSetEqual(a@comma{} b)}

@tab

sets ou frozensets

@tab

3.1

@item

@ref{12c8,,assertDictEqual(a@comma{} b)}

@tab

dicionários

@tab

3.1

@end multitable


@geindex assertMultiLineEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertMultiLineEqual}@anchor{1388}
@deffn {Método} assertMultiLineEqual (first, second, msg=None)

Test that the multiline string `first' is equal to the string `second'.
When not equal a diff of the two strings highlighting the differences
will be included in the error message. This method is used by default
when comparing strings with @ref{529,,assertEqual()}.


Adicionado na versão 3.1.

@end deffn

@geindex assertSequenceEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertSequenceEqual}@anchor{12cb}
@deffn {Método} assertSequenceEqual (first, second, msg=None, seq_type=None)

Tests that two sequences are equal.  If a `seq_type' is supplied, both
`first' and `second' must be instances of `seq_type' or a failure will
be raised.  If the sequences are different an error message is
constructed that shows the difference between the two.

This method is not called directly by @ref{529,,assertEqual()}, but
it’s used to implement @ref{12c9,,assertListEqual()} and
@ref{12ca,,assertTupleEqual()}.


Adicionado na versão 3.1.

@end deffn

@geindex assertListEqual() (método unittest.TestCase)
@geindex assertTupleEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertListEqual}@anchor{12c9}
@deffn {Método} assertListEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertTupleEqual}@anchor{12ca}
@deffnx {Método} assertTupleEqual (first, second, msg=None)

Tests that two lists or tuples are equal.  If not, an error message is
constructed that shows only the differences between the two.  An error
is also raised if either of the parameters are of the wrong type.
These methods are used by default when comparing lists or tuples with
@ref{529,,assertEqual()}.


Adicionado na versão 3.1.

@end deffn

@geindex assertSetEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertSetEqual}@anchor{12c7}
@deffn {Método} assertSetEqual (first, second, msg=None)

Tests that two sets are equal.  If not, an error message is constructed
that lists the differences between the sets.  This method is used by
default when comparing sets or frozensets with @ref{529,,assertEqual()}.

Fails if either of `first' or `second' does not have a @ref{23cc,,difference()}
method.


Adicionado na versão 3.1.

@end deffn

@geindex assertDictEqual() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase assertDictEqual}@anchor{12c8}
@deffn {Método} assertDictEqual (first, second, msg=None)

Test that two dictionaries are equal.  If not, an error message is
constructed that shows the differences in the dictionaries. This
method will be used by default to compare dictionaries in
calls to @ref{529,,assertEqual()}.


Adicionado na versão 3.1.

@end deffn
@anchor{library/unittest other-methods-and-attrs}@anchor{42a7}
Finally the @ref{44f,,TestCase} provides the following methods and attributes:

@geindex fail() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase fail}@anchor{42a8}
@deffn {Método} fail (msg=None)

Signals a test failure unconditionally, with `msg' or @code{None} for
the error message.
@end deffn

@geindex failureException (atributo unittest.TestCase)
@anchor{library/unittest unittest TestCase failureException}@anchor{423b}
@deffn {Atributo} failureException

This class attribute gives the exception raised by the test method.  If a
test framework needs to use a specialized exception, possibly to carry
additional information, it must subclass this exception in order to “play
fair” with the framework.  The initial value of this attribute is
@ref{6a9,,AssertionError}.
@end deffn

@geindex longMessage (atributo unittest.TestCase)
@anchor{library/unittest unittest TestCase longMessage}@anchor{137a}
@deffn {Atributo} longMessage

This class attribute determines what happens when a custom failure message
is passed as the msg argument to an assertXYY call that fails.
@code{True} is the default value. In this case, the custom message is appended
to the end of the standard failure message.
When set to @code{False}, the custom message replaces the standard message.

The class setting can be overridden in individual test methods by assigning
an instance attribute, self.longMessage, to @code{True} or @code{False} before
calling the assert methods.

The class setting gets reset before each test call.


Adicionado na versão 3.1.

@end deffn

@geindex maxDiff (atributo unittest.TestCase)
@anchor{library/unittest unittest TestCase maxDiff}@anchor{126c}
@deffn {Atributo} maxDiff

This attribute controls the maximum length of diffs output by assert
methods that report diffs on failure. It defaults to 80*8 characters.
Assert methods affected by this attribute are
@ref{12cb,,assertSequenceEqual()} (including all the sequence comparison
methods that delegate to it), @ref{12c8,,assertDictEqual()} and
@ref{1388,,assertMultiLineEqual()}.

Setting @code{maxDiff} to @code{None} means that there is no maximum length of
diffs.


Adicionado na versão 3.2.

@end deffn

Frameworks de teste podem usar os seguintes métodos para coletar informações sobre o teste:

@geindex countTestCases() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase countTestCases}@anchor{42a9}
@deffn {Método} countTestCases ()

Retorna o número de testes representados por esse objeto de teste. Para instâncias @ref{44f,,TestCase} será sempre @code{1}.
@end deffn

@geindex defaultTestResult() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase defaultTestResult}@anchor{42a3}
@deffn {Método} defaultTestResult ()

Return an instance of the test result class that should be used for this
test case class (if no other result instance is provided to the
@ref{11a5,,run()} method).

For @ref{44f,,TestCase} instances, this will always be an instance of
@ref{11a6,,TestResult}; subclasses of @ref{44f,,TestCase} should override this
as necessary.
@end deffn

@geindex id() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase id}@anchor{42aa}
@deffn {Método} id ()

Retorna uma string identificando o caso de teste específico. Geralmente é o nome completo do método do teste, incluindo o módulo e o nome da classe.
@end deffn

@geindex shortDescription() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase shortDescription}@anchor{42ab}
@deffn {Método} shortDescription ()

Retorna uma descrição do teste ou @code{None} se nenhuma descrição for fornecida. A implementação padrão desse método retorna a primeira linha da docstring do método do teste, se disponível, ou @code{None}.


Alterado na versão 3.1: In 3.1 this was changed to add the test name to the short description
even in the presence of a docstring.  This caused compatibility issues
with unittest extensions and adding the test name was moved to the
@ref{531,,TextTestResult} in Python 3.2.

@end deffn

@geindex addCleanup() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase addCleanup}@anchor{a8b}
@deffn {Método} addCleanup (function, /, *args, **kwargs)

Add a function to be called after @ref{137f,,tearDown()} to cleanup resources
used during the test. Functions will be called in reverse order to the
order they are added (@abbr{LIFO}).  They
are called with any arguments and keyword arguments passed into
@ref{a8b,,addCleanup()} when they are added.

If @ref{137e,,setUp()} fails, meaning that @ref{137f,,tearDown()} is not called,
then any cleanup functions added will still be called.


Adicionado na versão 3.1.

@end deffn

@geindex enterContext() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase enterContext}@anchor{6b9}
@deffn {Método} enterContext (cm)

Enter the supplied @ref{5d4,,context manager}.  If successful, also
add its @ref{1344,,__exit__()} method as a cleanup function by
@ref{a8b,,addCleanup()} and return the result of the
@ref{5c8,,__enter__()} method.


Adicionado na versão 3.11.

@end deffn

@geindex doCleanups() (método unittest.TestCase)
@anchor{library/unittest unittest TestCase doCleanups}@anchor{137d}
@deffn {Método} doCleanups ()

This method is called unconditionally after @ref{137f,,tearDown()}, or
after @ref{137e,,setUp()} if @ref{137e,,setUp()} raises an exception.

It is responsible for calling all the cleanup functions added by
@ref{a8b,,addCleanup()}. If you need cleanup functions to be called
`prior' to @ref{137f,,tearDown()} then you can call @ref{137d,,doCleanups()}
yourself.

@ref{137d,,doCleanups()} pops methods off the stack of cleanup
functions one at a time, so it can be called at any time.


Adicionado na versão 3.1.

@end deffn

@geindex addClassCleanup() (método de classe unittest.TestCase)
@anchor{library/unittest unittest TestCase addClassCleanup}@anchor{a56}
@deffn {Método} classmethod addClassCleanup (function, /, *args, **kwargs)

Add a function to be called after @ref{137c,,tearDownClass()} to cleanup
resources used during the test class. Functions will be called in reverse
order to the order they are added (@abbr{LIFO}).
They are called with any arguments and keyword arguments passed into
@ref{a56,,addClassCleanup()} when they are added.

If @ref{a58,,setUpClass()} fails, meaning that @ref{137c,,tearDownClass()} is not
called, then any cleanup functions added will still be called.


Adicionado na versão 3.8.

@end deffn

@geindex enterClassContext() (método de classe unittest.TestCase)
@anchor{library/unittest unittest TestCase enterClassContext}@anchor{6ba}
@deffn {Método} classmethod enterClassContext (cm)

Enter the supplied @ref{5d4,,context manager}.  If successful, also
add its @ref{1344,,__exit__()} method as a cleanup function by
@ref{a56,,addClassCleanup()} and return the result of the
@ref{5c8,,__enter__()} method.


Adicionado na versão 3.11.

@end deffn

@geindex doClassCleanups() (método de classe unittest.TestCase)
@anchor{library/unittest unittest TestCase doClassCleanups}@anchor{42ac}
@deffn {Método} classmethod doClassCleanups ()

This method is called unconditionally after @ref{137c,,tearDownClass()}, or
after @ref{a58,,setUpClass()} if @ref{a58,,setUpClass()} raises an exception.

It is responsible for calling all the cleanup functions added by
@ref{a56,,addClassCleanup()}. If you need cleanup functions to be called
`prior' to @ref{137c,,tearDownClass()} then you can call
@ref{42ac,,doClassCleanups()} yourself.

@ref{42ac,,doClassCleanups()} pops methods off the stack of cleanup
functions one at a time, so it can be called at any time.


Adicionado na versão 3.8.

@end deffn
@end deffn

@geindex IsolatedAsyncioTestCase (classe em unittest)
@anchor{library/unittest unittest IsolatedAsyncioTestCase}@anchor{30c}
@deffn {Classe} unittest.IsolatedAsyncioTestCase (methodName='runTest')

This class provides an API similar to @ref{44f,,TestCase} and also accepts
coroutines as test functions.


Adicionado na versão 3.8.


@geindex loop_factory (atributo unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase loop_factory}@anchor{42ad}
@deffn {Atributo} loop_factory

The `loop_factory' passed to @ref{600,,asyncio.Runner}. Override
in subclasses with @ref{17e9,,asyncio.EventLoop} to avoid using the
asyncio policy system.


Adicionado na versão 3.13.

@end deffn

@geindex asyncSetUp() (método unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncSetUp}@anchor{42ae}
@deffn {Método} async asyncSetUp ()

Method called to prepare the test fixture. This is called after @ref{137e,,TestCase.setUp()}.
This is called immediately before calling the test method; other than
@ref{6a9,,AssertionError} or @ref{101a,,SkipTest}, any exception raised by this method
will be considered an error rather than a test failure. The default implementation
does nothing.
@end deffn

@geindex asyncTearDown() (método unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncTearDown}@anchor{42af}
@deffn {Método} async asyncTearDown ()

Method called immediately after the test method has been called and the
result recorded.  This is called before @ref{137f,,tearDown()}. This is called even if
the test method raised an exception, so the implementation in subclasses may need
to be particularly careful about checking internal state.  Any exception, other than
@ref{6a9,,AssertionError} or @ref{101a,,SkipTest}, raised by this method will be
considered an additional error rather than a test failure (thus increasing
the total number of reported errors). This method will only be called if
the @ref{42ae,,asyncSetUp()} succeeds, regardless of the outcome of the test method.
The default implementation does nothing.
@end deffn

@geindex addAsyncCleanup() (método unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase addAsyncCleanup}@anchor{42b0}
@deffn {Método} addAsyncCleanup (function, /, *args, **kwargs)

This method accepts a coroutine that can be used as a cleanup function.
@end deffn

@geindex enterAsyncContext() (método unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase enterAsyncContext}@anchor{6bb}
@deffn {Método} async enterAsyncContext (cm)

Enter the supplied @ref{5d7,,asynchronous context manager}.  If successful,
also add its @ref{1716,,__aexit__()} method as a cleanup function by
@ref{42b0,,addAsyncCleanup()} and return the result of the
@ref{215e,,__aenter__()} method.


Adicionado na versão 3.11.

@end deffn

@geindex run() (método unittest.IsolatedAsyncioTestCase)
@anchor{library/unittest unittest IsolatedAsyncioTestCase run}@anchor{42b1}
@deffn {Método} run (result=None)

Sets up a new event loop to run the test, collecting the result into
the @ref{11a6,,TestResult} object passed as `result'.  If `result' is
omitted or @code{None}, a temporary result object is created (by calling
the @ref{42a3,,defaultTestResult()} method) and used. The result object is
returned to @ref{42b1,,run()}’s caller. At the end of the test all the tasks
in the event loop are cancelled.
@end deffn

An example illustrating the order:

@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

After running the test, @code{events} would contain @code{["setUp", "asyncSetUp", "test_response", "asyncTearDown", "tearDown", "cleanup"]}.
@end deffn

@geindex FunctionTestCase (classe em unittest)
@anchor{library/unittest unittest FunctionTestCase}@anchor{17fb}
@deffn {Classe} unittest.FunctionTestCase (testFunc, setUp=None, tearDown=None, description=None)

This class implements the portion of the @ref{44f,,TestCase} interface which
allows the test runner to drive the test, but does not provide the methods
which test code can use to check and report errors.  This is used to create
test cases using legacy test code, allowing it to be integrated into a
@ref{106,,unittest}-based test framework.
@end deffn

@node Grouping tests,Carregando e executando testes,Casos de teste,Classes e funções
@anchor{library/unittest grouping-tests}@anchor{42b2}@anchor{library/unittest testsuite-objects}@anchor{42b3}
@subsubsection Grouping tests


@geindex TestSuite (classe em unittest)
@anchor{library/unittest unittest TestSuite}@anchor{e20}
@deffn {Classe} unittest.TestSuite (tests=())

This class represents an aggregation of individual test cases and test suites.
The class presents the interface needed by the test runner to allow it to be run
as any other test case.  Running a @ref{e20,,TestSuite} instance is the same as
iterating over the suite, running each test individually.

If `tests' is given, it must be an iterable of individual test cases or other
test suites that will be used to build the suite initially. Additional methods
are provided to add test cases and suites to the collection later on.

@ref{e20,,TestSuite} objects behave much like @ref{44f,,TestCase} objects, except
they do not actually implement a test.  Instead, they are used to aggregate
tests into groups of tests that should be run together. Some additional
methods are available to add tests to @ref{e20,,TestSuite} instances:

@geindex addTest() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite addTest}@anchor{42b4}
@deffn {Método} addTest (test)

Add a @ref{44f,,TestCase} or @ref{e20,,TestSuite} to the suite.
@end deffn

@geindex addTests() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite addTests}@anchor{42b5}
@deffn {Método} addTests (tests)

Add all the tests from an iterable of @ref{44f,,TestCase} and @ref{e20,,TestSuite}
instances to this test suite.

This is equivalent to iterating over `tests', calling @ref{42b4,,addTest()} for
each element.
@end deffn

@ref{e20,,TestSuite} shares the following methods with @ref{44f,,TestCase}:

@geindex run() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite run}@anchor{42b6}
@deffn {Método} run (result)

Run the tests associated with this suite, collecting the result into the
test result object passed as `result'.  Note that unlike
@ref{11a5,,TestCase.run()}, @ref{42b6,,TestSuite.run()} requires the result object to
be passed in.
@end deffn

@geindex debug() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite debug}@anchor{42b7}
@deffn {Método} debug ()

Run the tests associated with this suite without collecting the
result. This allows exceptions raised by the test to be propagated to the
caller and can be used to support running tests under a debugger.
@end deffn

@geindex countTestCases() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite countTestCases}@anchor{42b8}
@deffn {Método} countTestCases ()

Return the number of tests represented by this test object, including all
individual tests and sub-suites.
@end deffn

@geindex __iter__() (método unittest.TestSuite)
@anchor{library/unittest unittest TestSuite __iter__}@anchor{105f}
@deffn {Método} __iter__ ()

Tests grouped by a @ref{e20,,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{42b6,,TestSuite.run()} must be the
same for each call iteration. After @ref{42b6,,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.


Alterado na versão 3.2: In earlier versions the @ref{e20,,TestSuite} accessed tests directly rather
than through iteration, so overriding @code{__iter__()} wasn’t sufficient
for providing tests.



Alterado na versão 3.4: In earlier versions the @ref{e20,,TestSuite} held references to each
@ref{44f,,TestCase} after @ref{42b6,,TestSuite.run()}. Subclasses can restore
that behavior by overriding @code{TestSuite._removeTestAtIndex()}.

@end deffn

In the typical usage of a @ref{e20,,TestSuite} object, the @ref{42b6,,run()} method
is invoked by a @code{TestRunner} rather than by the end-user test harness.
@end deffn

@node Carregando e executando testes,,Grouping tests,Classes e funções
@anchor{library/unittest loading-and-running-tests}@anchor{42b9}
@subsubsection Carregando e executando testes


@geindex TestLoader (classe em unittest)
@anchor{library/unittest unittest TestLoader}@anchor{28e}
@deffn {Classe} unittest.TestLoader

The @ref{28e,,TestLoader} class is used to create test suites from classes and
modules.  Normally, there is no need to create an instance of this class; the
@ref{106,,unittest} module provides an instance that can be shared as
@ref{42ba,,unittest.defaultTestLoader}.  Using a subclass or instance, however,
allows customization of some configurable properties.

Objetos da classe @ref{28e,,TestLoader} possuem os seguintes atributos:

@geindex errors (atributo unittest.TestLoader)
@anchor{library/unittest unittest TestLoader errors}@anchor{ebb}
@deffn {Atributo} errors

A list of the non-fatal errors encountered while loading tests. Not reset
by the loader at any point. Fatal errors are signalled by the relevant
method raising an exception to the caller. Non-fatal errors are also
indicated by a synthetic test that will raise the original error when
run.


Adicionado na versão 3.5.

@end deffn

Objetos da classe @ref{28e,,TestLoader} possuem os seguintes métodos:

@geindex loadTestsFromTestCase() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromTestCase}@anchor{290}
@deffn {Método} loadTestsFromTestCase (testCaseClass)

Return a suite of all test cases contained in the @ref{44f,,TestCase}-derived
@code{testCaseClass}.

A test case instance is created for each method named by
@ref{291,,getTestCaseNames()}. By default these are the method names
beginning with @code{test}. If @ref{291,,getTestCaseNames()} returns no
methods, but the @code{runTest()} method is implemented, a single test
case is created for that method instead.
@end deffn

@geindex loadTestsFromModule() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromModule}@anchor{28f}
@deffn {Método} loadTestsFromModule (module, *, pattern=None)

Return a suite of all test cases contained in the given module. This
method searches `module' for classes derived from @ref{44f,,TestCase} and
creates an instance of the class for each test method defined for the
class.

@cartouche
@quotation Nota 
While using a hierarchy of @ref{44f,,TestCase}-derived classes can be
convenient in sharing fixtures and helper functions, defining test
methods on base classes that are not intended to be instantiated
directly does not play well with this method.  Doing so, however, can
be useful when the fixtures are different and defined in subclasses.
@end quotation
@end cartouche

If a module provides a @code{load_tests} function it will be called to
load the tests. This allows modules to customize test loading.
This is the @ref{4293,,load_tests protocol}.  The `pattern' argument is passed as
the third argument to @code{load_tests}.


Alterado na versão 3.2: Suporte para @code{load_tests} adicionado.



Alterado na versão 3.5: Support for a keyword-only argument `pattern' has been added.



Alterado na versão 3.12: The undocumented and unofficial `use_load_tests' parameter has been
removed.

@end deffn

@geindex loadTestsFromName() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromName}@anchor{138b}
@deffn {Método} loadTestsFromName (name, module=None)

Return a suite of all test cases given a string specifier.

The specifier `name' is a “dotted name” that may resolve either to a
module, a test case class, a test method within a test case class, a
@ref{e20,,TestSuite} instance, or a callable object which returns a
@ref{44f,,TestCase} or @ref{e20,,TestSuite} instance.  These checks are
applied in the order listed here; that is, a method on a possible test
case class will be picked up as “a test method within a test case class”,
rather than “a callable object”.

For example, if you have a module @code{SampleTests} containing a
@ref{44f,,TestCase}-derived class @code{SampleTestCase} with three test
methods (@code{test_one()}, @code{test_two()}, and @code{test_three()}), the
specifier @code{'SampleTests.SampleTestCase'} would cause this method to
return a suite which will run all three test methods. Using the specifier
@code{'SampleTests.SampleTestCase.test_two'} would cause it to return a test
suite which will run only the @code{test_two()} test method. The specifier
can refer to modules and packages which have not been imported; they will
be imported as a side-effect.

O método opcionalmente resolve o `nome' relativo ao `módulo' dado.


Alterado na versão 3.5: If an @ref{419,,ImportError} or @ref{34b,,AttributeError} occurs while traversing
`name' then a synthetic test that raises that error when run will be
returned. These errors are included in the errors accumulated by
self.errors.

@end deffn

@geindex loadTestsFromNames() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader loadTestsFromNames}@anchor{42bb}
@deffn {Método} loadTestsFromNames (names, module=None)

Similar to @ref{138b,,loadTestsFromName()}, but takes a sequence of names rather
than a single name.  The return value is a test suite which supports all
the tests defined for each name.
@end deffn

@geindex getTestCaseNames() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader getTestCaseNames}@anchor{291}
@deffn {Método} getTestCaseNames (testCaseClass)

Return a sorted sequence of method names found within `testCaseClass';
this should be a subclass of @ref{44f,,TestCase}.
@end deffn

@geindex discover() (método unittest.TestLoader)
@anchor{library/unittest unittest TestLoader discover}@anchor{101b}
@deffn {Método} discover (start_dir, pattern='test*.py', top_level_dir=None)

Find all the test modules by recursing into subdirectories from the
specified start directory, and return a TestSuite object containing them.
Only test files that match `pattern' will be loaded. (Using shell style
pattern matching.) Only module names that are importable (i.e. are valid
Python identifiers) will be loaded.

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.

If importing a module fails, for example due to a syntax error, then
this will be recorded as a single error and discovery will continue.  If
the import failure is due to @ref{101a,,SkipTest} being raised, it will be
recorded as a skip instead of an error.

If a package (a directory containing a file named @code{__init__.py}) is
found, the package will be checked for a @code{load_tests} function. If this
exists then it will be called
@code{package.load_tests(loader, tests, pattern)}. Test discovery takes care
to ensure that a package is only checked for tests once during an
invocation, even if the load_tests function itself calls
@code{loader.discover}.

If @code{load_tests} exists then discovery does `not' recurse into the
package, @code{load_tests} is responsible for loading all tests in the
package.

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' can be a dotted module name as well as a directory.


Adicionado na versão 3.2.



Alterado na versão 3.4: Modules that raise @ref{101a,,SkipTest} on import are recorded as skips,
not errors.



Alterado na versão 3.4: `start_dir' can be a @ref{1dee,,namespace packages}.



Alterado na versão 3.4: Paths are sorted before being imported so that execution order is the
same even if the underlying file system’s ordering is not dependent
on file name.



Alterado na versão 3.5: Found packages are now checked for @code{load_tests} regardless of
whether their path matches `pattern', because it is impossible for
a package name to match the default pattern.



Alterado na versão 3.11: `start_dir' can not be a @ref{1dee,,namespace packages}.
It has been broken since Python 3.7 and Python 3.11 officially remove it.



Alterado na versão 3.13: `top_level_dir' is only stored for the duration of `discover' call.

@end deffn

The following attributes of a @ref{28e,,TestLoader} can be configured either by
subclassing or assignment on an instance:

@geindex testMethodPrefix (atributo unittest.TestLoader)
@anchor{library/unittest unittest TestLoader testMethodPrefix}@anchor{42bc}
@deffn {Atributo} testMethodPrefix

String giving the prefix of method names which will be interpreted as test
methods.  The default value is @code{'test'}.

This affects @ref{291,,getTestCaseNames()} and all the @code{loadTestsFrom*}
methods.
@end deffn

@geindex sortTestMethodsUsing (atributo unittest.TestLoader)
@anchor{library/unittest unittest TestLoader sortTestMethodsUsing}@anchor{42bd}
@deffn {Atributo} sortTestMethodsUsing

Function to be used to compare method names when sorting them in
@ref{291,,getTestCaseNames()} and all the @code{loadTestsFrom*} methods.
@end deffn

@geindex suiteClass (atributo unittest.TestLoader)
@anchor{library/unittest unittest TestLoader suiteClass}@anchor{138c}
@deffn {Atributo} suiteClass

Callable object that constructs a test suite from a list of tests. No
methods on the resulting object are needed.  The default value is the
@ref{e20,,TestSuite} class.

This affects all the @code{loadTestsFrom*} methods.
@end deffn

@geindex testNamePatterns (atributo unittest.TestLoader)
@anchor{library/unittest unittest TestLoader testNamePatterns}@anchor{42be}
@deffn {Atributo} testNamePatterns

List of Unix shell-style wildcard test name patterns that test methods
have to match to be included in test suites (see @code{-k} option).

If this attribute is not @code{None} (the default), all test methods to be
included in test suites must match one of the patterns in this list.
Note that matches are always performed using @ref{19e0,,fnmatch.fnmatchcase()},
so unlike patterns passed to the @code{-k} option, simple substring patterns
will have to be converted using @code{*} wildcards.

This affects all the @code{loadTestsFrom*} methods.


Adicionado na versão 3.7.

@end deffn
@end deffn

@geindex TestResult (classe em unittest)
@anchor{library/unittest unittest TestResult}@anchor{11a6}
@deffn {Classe} unittest.TestResult

This class is used to compile information about which tests have succeeded
and which have failed.

A @ref{11a6,,TestResult} object stores the results of a set of tests.  The
@ref{44f,,TestCase} and @ref{e20,,TestSuite} classes ensure that results are
properly recorded; test authors do not need to worry about recording the
outcome of tests.

Testing frameworks built on top of @ref{106,,unittest} may want access to the
@ref{11a6,,TestResult} object generated by running a set of tests for reporting
purposes; a @ref{11a6,,TestResult} instance is returned by the
@code{TestRunner.run()} method for this purpose.

@ref{11a6,,TestResult} instances have the following attributes that will be of
interest when inspecting the results of running a set of tests:

@geindex errors (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult errors}@anchor{42bf}
@deffn {Atributo} errors

A list containing 2-tuples of @ref{44f,,TestCase} instances and strings
holding formatted tracebacks. Each tuple represents a test which raised an
unexpected exception.
@end deffn

@geindex failures (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult failures}@anchor{42c0}
@deffn {Atributo} failures

A list containing 2-tuples of @ref{44f,,TestCase} instances and strings
holding formatted tracebacks. Each tuple represents a test where a failure
was explicitly signalled using the @ref{427b,,assert* methods}.
@end deffn

@geindex skipped (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult skipped}@anchor{42c1}
@deffn {Atributo} skipped

A list containing 2-tuples of @ref{44f,,TestCase} instances and strings
holding the reason for skipping the test.


Adicionado na versão 3.1.

@end deffn

@geindex expectedFailures (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult expectedFailures}@anchor{42c2}
@deffn {Atributo} expectedFailures

A list containing 2-tuples of @ref{44f,,TestCase} instances and strings
holding formatted tracebacks.  Each tuple represents an expected failure
or error of the test case.
@end deffn

@geindex unexpectedSuccesses (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult unexpectedSuccesses}@anchor{42c3}
@deffn {Atributo} unexpectedSuccesses

A list containing @ref{44f,,TestCase} instances that were marked as expected
failures, but succeeded.
@end deffn

@geindex collectedDurations (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult collectedDurations}@anchor{17fe}
@deffn {Atributo} collectedDurations

A list containing 2-tuples of test case names and floats
representing the elapsed time of each test which was run.


Adicionado na versão 3.12.

@end deffn

@geindex shouldStop (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult shouldStop}@anchor{42c4}
@deffn {Atributo} shouldStop

Set to @code{True} when the execution of tests should stop by @ref{42c5,,stop()}.
@end deffn

@geindex testsRun (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult testsRun}@anchor{42c6}
@deffn {Atributo} testsRun

The total number of tests run so far.
@end deffn

@geindex buffer (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult buffer}@anchor{42c7}
@deffn {Atributo} buffer

If set to true, @code{sys.stdout} and @code{sys.stderr} will be buffered in between
@ref{42c8,,startTest()} and @ref{42c9,,stopTest()} being called. Collected output will
only be echoed onto the real @code{sys.stdout} and @code{sys.stderr} if the test
fails or errors. Any output is also attached to the failure / error message.


Adicionado na versão 3.2.

@end deffn

@geindex failfast (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult failfast}@anchor{42ca}
@deffn {Atributo} failfast

Se definido como true (verdadeiro) @ref{42c5,,stop()} será chamado na primeira falha ou erro, interrompendo a execução do teste.


Adicionado na versão 3.2.

@end deffn

@geindex tb_locals (atributo unittest.TestResult)
@anchor{library/unittest unittest TestResult tb_locals}@anchor{42cb}
@deffn {Atributo} tb_locals

If set to true then local variables will be shown in tracebacks.


Adicionado na versão 3.5.

@end deffn

@geindex wasSuccessful() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult wasSuccessful}@anchor{42cc}
@deffn {Método} wasSuccessful ()

Return @code{True} if all tests run so far have passed, otherwise returns
@code{False}.


Alterado na versão 3.4: Returns @code{False} if there were any @ref{42c3,,unexpectedSuccesses}
from tests marked with the @ref{429a,,expectedFailure()} decorator.

@end deffn

@geindex stop() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult stop}@anchor{42c5}
@deffn {Método} stop ()

This method can be called to signal that the set of tests being run should
be aborted by setting the @ref{42c4,,shouldStop} attribute to @code{True}.
@code{TestRunner} objects should respect this flag and return without
running any additional tests.

For example, this feature is used by the @ref{183e,,TextTestRunner} class to
stop the test framework when the user signals an interrupt from the
keyboard.  Interactive tools which provide @code{TestRunner}
implementations can use this in a similar manner.
@end deffn

The following methods of the @ref{11a6,,TestResult} class are used to maintain
the internal data structures, and may be extended in subclasses to support
additional reporting requirements.  This is particularly useful in building
tools which support interactive reporting while tests are being run.

@geindex startTest() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult startTest}@anchor{42c8}
@deffn {Método} startTest (test)

Called when the test case `test' is about to be run.
@end deffn

@geindex stopTest() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult stopTest}@anchor{42c9}
@deffn {Método} stopTest (test)

Called after the test case `test' has been executed, regardless of the
outcome.
@end deffn

@geindex startTestRun() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult startTestRun}@anchor{138f}
@deffn {Método} startTestRun ()

Called once before any tests are executed.


Adicionado na versão 3.1.

@end deffn

@geindex stopTestRun() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult stopTestRun}@anchor{1390}
@deffn {Método} stopTestRun ()

Called once after all tests are executed.


Adicionado na versão 3.1.

@end deffn

@geindex addError() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addError}@anchor{19d7}
@deffn {Método} addError (test, err)

Called when the test case `test' raises an unexpected exception. `err' is a
tuple of the form returned by @ref{68a,,sys.exc_info()}: @code{(type, value,
traceback)}.

The default implementation appends a tuple @code{(test, formatted_err)} to
the instance’s @ref{42bf,,errors} attribute, where `formatted_err' is a
formatted traceback derived from `err'.
@end deffn

@geindex addFailure() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addFailure}@anchor{19d6}
@deffn {Método} addFailure (test, err)

Called when the test case `test' signals a failure. `err' is a tuple of
the form returned by @ref{68a,,sys.exc_info()}: @code{(type, value, traceback)}.

The default implementation appends a tuple @code{(test, formatted_err)} to
the instance’s @ref{42c0,,failures} attribute, where `formatted_err' is a
formatted traceback derived from `err'.
@end deffn

@geindex addSuccess() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addSuccess}@anchor{42cd}
@deffn {Método} addSuccess (test)

Called when the test case `test' succeeds.

The default implementation does nothing.
@end deffn

@geindex addSkip() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addSkip}@anchor{19d8}
@deffn {Método} addSkip (test, reason)

Called when the test case `test' is skipped.  `reason' is the reason the
test gave for skipping.

The default implementation appends a tuple @code{(test, reason)} to the
instance’s @ref{42c1,,skipped} attribute.
@end deffn

@geindex addExpectedFailure() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addExpectedFailure}@anchor{42ce}
@deffn {Método} addExpectedFailure (test, err)

Called when the test case `test' fails or errors, but was marked with
the @ref{429a,,expectedFailure()} decorator.

The default implementation appends a tuple @code{(test, formatted_err)} to
the instance’s @ref{42c2,,expectedFailures} attribute, where `formatted_err'
is a formatted traceback derived from `err'.
@end deffn

@geindex addUnexpectedSuccess() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addUnexpectedSuccess}@anchor{42cf}
@deffn {Método} addUnexpectedSuccess (test)

Called when the test case `test' was marked with the
@ref{429a,,expectedFailure()} decorator, but succeeded.

The default implementation appends the test to the instance’s
@ref{42c3,,unexpectedSuccesses} attribute.
@end deffn

@geindex addSubTest() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addSubTest}@anchor{19d9}
@deffn {Método} addSubTest (test, subtest, outcome)

Called when a subtest finishes.  `test' is the test case
corresponding to the test method.  `subtest' is a custom
@ref{44f,,TestCase} instance describing the subtest.

If `outcome' is @ref{675,,None}, the subtest succeeded.  Otherwise,
it failed with an exception where `outcome' is a tuple of the form
returned by @ref{68a,,sys.exc_info()}: @code{(type, value, traceback)}.

The default implementation does nothing when the outcome is a
success, and records subtest failures as normal failures.


Adicionado na versão 3.4.

@end deffn

@geindex addDuration() (método unittest.TestResult)
@anchor{library/unittest unittest TestResult addDuration}@anchor{183f}
@deffn {Método} addDuration (test, elapsed)

Called when the test case finishes.  `elapsed' is the time represented in
seconds, and it includes the execution of cleanup functions.


Adicionado na versão 3.12.

@end deffn
@end deffn

@geindex TextTestResult (classe em unittest)
@anchor{library/unittest unittest TextTestResult}@anchor{531}
@deffn {Classe} unittest.TextTestResult (stream, descriptions, verbosity, *, durations=None)

A concrete implementation of @ref{11a6,,TestResult} used by the
@ref{183e,,TextTestRunner}. Subclasses should accept @code{**kwargs} to ensure
compatibility as the interface changes.


Adicionado na versão 3.2.



Alterado na versão 3.12: Added the `durations' keyword parameter.

@end deffn

@geindex defaultTestLoader (no módulo unittest)
@anchor{library/unittest unittest defaultTestLoader}@anchor{42ba}
@deffn {Dado} unittest.defaultTestLoader

Instance of the @ref{28e,,TestLoader} class intended to be shared.  If no
customization of the @ref{28e,,TestLoader} is needed, this instance can be used
instead of repeatedly creating new instances.
@end deffn

@geindex TextTestRunner (classe em unittest)
@anchor{library/unittest unittest TextTestRunner}@anchor{183e}
@deffn {Classe} unittest.TextTestRunner (stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False, durations=None)

A basic test runner implementation that outputs results to a stream. If `stream'
is @code{None}, the default, @ref{940,,sys.stderr} is used as the output stream. This class
has a few configurable parameters, but is essentially very simple.  Graphical
applications which run test suites should provide alternate implementations. Such
implementations should accept @code{**kwargs} as the interface to construct runners
changes when features are added to unittest.

By default this runner shows @ref{1a5,,DeprecationWarning},
@ref{8ce,,PendingDeprecationWarning}, @ref{244,,ResourceWarning} and
@ref{4fa,,ImportWarning} even if they are @ref{42d0,,ignored by default}.  This behavior can
be overridden using Python’s @code{-Wd} or @code{-Wa} options
(see @ref{1ec0,,Warning control}) and leaving
`warnings' to @code{None}.


Alterado na versão 3.2: Added the `warnings' parameter.



Alterado na versão 3.2: The default stream is set to @ref{940,,sys.stderr} at instantiation time rather
than import time.



Alterado na versão 3.5: Added the `tb_locals' parameter.



Alterado na versão 3.12: Added the `durations' parameter.


@geindex _makeResult() (método unittest.TextTestRunner)
@anchor{library/unittest unittest TextTestRunner _makeResult}@anchor{42d1}
@deffn {Método} _makeResult ()

This method returns the instance of @code{TestResult} used by @ref{42d2,,run()}.
It is not intended to be called directly, but can be overridden in
subclasses to provide a custom @code{TestResult}.

@code{_makeResult()} instantiates the class or callable passed in the
@code{TextTestRunner} constructor as the @code{resultclass} argument. It
defaults to @ref{531,,TextTestResult} if no @code{resultclass} is provided.
The result class is instantiated with the following arguments:

@example
stream, descriptions, verbosity
@end example
@end deffn

@geindex run() (método unittest.TextTestRunner)
@anchor{library/unittest unittest TextTestRunner run}@anchor{42d2}
@deffn {Método} run (test)

This method is the main public interface to the @code{TextTestRunner}. This
method takes a @ref{e20,,TestSuite} or @ref{44f,,TestCase} instance. A
@ref{11a6,,TestResult} is created by calling
@ref{42d1,,_makeResult()} and the test(s) are run and the
results printed to stdout.
@end deffn
@end deffn

@geindex main() (no módulo unittest)
@anchor{library/unittest unittest main}@anchor{1019}
@deffn {Função} 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)

A command-line program that loads a set of tests from `module' and runs them;
this is primarily for making test modules conveniently executable.
The simplest use for this function is to include the following line at the
end of a test script:

@example
if __name__ == '__main__':
    unittest.main()
@end example

You can run tests with more detailed information by passing in the verbosity
argument:

@example
if __name__ == '__main__':
    unittest.main(verbosity=2)
@end example

The `defaultTest' argument is either the name of a single test or an
iterable of test names to run if no test names are specified via `argv'.  If
not specified or @code{None} and no test names are provided via `argv', all
tests found in `module' are run.

O argumento `argv' pode ser uma lista de opções passada para o programa, com o primeiro elemento sendo o nome do programa. Se não for especificado ou for @code{None}, os valores de @ref{12a6,,sys.argv} são usados.

The `testRunner' argument can either be a test runner class or an already
created instance of it. By default @code{main} calls @ref{138e,,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.

The `testLoader' argument has to be a @ref{28e,,TestLoader} instance,
and defaults to @ref{42ba,,defaultTestLoader}.

@code{main} supports being used from the interactive interpreter by passing in the
argument @code{exit=False}. This displays the result on standard output without
calling @ref{138e,,sys.exit()}:

@example
>>> from unittest import main
>>> main(module='test_module', exit=False)
@end example

The `failfast', `catchbreak' and `buffer' parameters have the same
effect as the same-name @ref{4282,,command-line options}.

The `warnings' argument specifies the @ref{8cf,,warning filter}
that should be used while running the tests.  If it’s not specified, it will
remain @code{None} if a @code{-W} option is passed to @code{python}
(see @ref{1ec0,,Warning control}),
otherwise it will be set to @code{'default'}.

Calling @code{main} returns an object with the @code{result} attribute that contains
the result of the tests run as a @ref{11a6,,unittest.TestResult}.


Alterado na versão 3.1: The `exit' parameter was added.



Alterado na versão 3.2: The `verbosity', `failfast', `catchbreak', `buffer'
and `warnings' parameters were added.



Alterado na versão 3.4: The `defaultTest' parameter was changed to also accept an iterable of
test names.

@end deffn

@menu
* load_tests Protocol:: 

@end menu

@node load_tests Protocol,,,Carregando e executando testes
@anchor{library/unittest id1}@anchor{4293}@anchor{library/unittest load-tests-protocol}@anchor{4239}
@subsubsection load_tests Protocol



Adicionado na versão 3.2.


Modules or packages can customize how tests are loaded from them during normal
test runs or test discovery by implementing a function called @code{load_tests}.

If a test module defines @code{load_tests} it will be called by
@ref{28f,,TestLoader.loadTestsFromModule()} with the following arguments:

@example
load_tests(loader, standard_tests, pattern)
@end example

where `pattern' is passed straight through from @code{loadTestsFromModule}.  It
defaults to @code{None}.

It should return a @ref{e20,,TestSuite}.

`loader' is the instance of @ref{28e,,TestLoader} doing the loading.
`standard_tests' are the tests that would be loaded by default from the
module. It is common for test modules to only want to add or remove tests
from the standard set of tests.
The third argument is used when loading packages as part of test discovery.

A typical @code{load_tests} function that loads tests from a specific set of
@ref{44f,,TestCase} classes may look like:

@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

If discovery is started in a directory containing a package, either from the
command line or by calling @ref{101b,,TestLoader.discover()}, then the package
@code{__init__.py} will be checked for @code{load_tests}.  If that function does
not exist, discovery will recurse into the package as though it were just
another directory.  Otherwise, discovery of the package’s tests will be left up
to @code{load_tests} which is called with the following arguments:

@example
load_tests(loader, standard_tests, pattern)
@end example

This should return a @ref{e20,,TestSuite} representing all the tests
from the package. (@code{standard_tests} will only contain tests
collected from @code{__init__.py}.)

Because the pattern is passed into @code{load_tests} the package is free to
continue (and potentially modify) test discovery. A ‘do nothing’
@code{load_tests} function for a test package would look like:

@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


Alterado na versão 3.5: Discovery no longer checks package names for matching `pattern' due to the
impossibility of package names matching the default pattern.


@node Classes e Módulos de Definição de Contexto,Tratamento de sinal,Classes e funções,unittest — Framework de testes unitários
@anchor{library/unittest class-and-module-fixtures}@anchor{42a2}
@subsubsection Classes e Módulos de Definição de Contexto


Class and module level fixtures are implemented in @ref{e20,,TestSuite}. When
the test suite encounters a test from a new class then
@ref{137c,,tearDownClass()} from the previous class (if there is one)
is called, followed by @ref{a58,,setUpClass()} from the new class.

Similarly if a test is from a different module from the previous test then
@code{tearDownModule} from the previous module is run, followed by
@code{setUpModule} from the new module.

Após executar todos os testes, haverá a execução final do @code{tearDownClass} e do @code{tearDownModule}.

Note that shared fixtures do not play well with [potential] features like test
parallelization and they break test isolation. They should be used with care.

The default ordering of tests created by the unittest test loaders is to group
all tests from the same modules and classes together. This will lead to
@code{setUpClass} / @code{setUpModule} (etc) being called exactly once per class and
module. If you randomize the order, so that tests from different modules and
classes are adjacent to each other, then these shared fixture functions may be
called multiple times in a single test run.

Shared fixtures are not intended to work with suites with non-standard
ordering. A @code{BaseTestSuite} still exists for frameworks that don’t want to
support shared fixtures.

If there are any exceptions raised during one of the shared fixture functions
the test is reported as an error. Because there is no corresponding test
instance an @code{_ErrorHolder} object (that has the same interface as a
@ref{44f,,TestCase}) is created to represent the error. If you are just using
the standard unittest test runner then this detail doesn’t matter, but if you
are a framework author it may be relevant.

@menu
* setUpClass and tearDownClass:: 
* setUpModule and tearDownModule:: 

@end menu

@node setUpClass and tearDownClass,setUpModule and tearDownModule,,Classes e Módulos de Definição de Contexto
@anchor{library/unittest setupclass-and-teardownclass}@anchor{42d3}
@subsubsection setUpClass and tearDownClass


These must be implemented as class methods:

@example
import unittest

class Test(unittest.TestCase):
    @@classmethod
    def setUpClass(cls):
        cls._connection = createExpensiveConnectionObject()

    @@classmethod
    def tearDownClass(cls):
        cls._connection.destroy()
@end example

If you want the @code{setUpClass} and @code{tearDownClass} on base classes called
then you must call up to them yourself. The implementations in
@ref{44f,,TestCase} are empty.

If an exception is raised during a @code{setUpClass} then the tests in the class
are not run and the @code{tearDownClass} is not run. Skipped classes will not
have @code{setUpClass} or @code{tearDownClass} run. If the exception is a
@ref{101a,,SkipTest} exception then the class will be reported as having been skipped
instead of as an error.

@node setUpModule and tearDownModule,,setUpClass and tearDownClass,Classes e Módulos de Definição de Contexto
@anchor{library/unittest setupmodule-and-teardownmodule}@anchor{42d4}
@subsubsection setUpModule and tearDownModule


@geindex setUpModule() (no módulo unittest)
@geindex tearDownModule() (no módulo unittest)
@anchor{library/unittest unittest setUpModule}@anchor{a57}
These should be implemented as functions:

@example
def setUpModule():
    createConnection()

def tearDownModule():
    closeConnection()
@end example

If an exception is raised in a @code{setUpModule} then none of the tests in the
module will be run and the @code{tearDownModule} will not be run. If the exception is a
@ref{101a,,SkipTest} exception then the module will be reported as having been skipped
instead of as an error.

To add cleanup code that must be run even in the case of an exception, use
@code{addModuleCleanup}:

@geindex addModuleCleanup() (no módulo unittest)
@anchor{library/unittest unittest addModuleCleanup}@anchor{a55}
@deffn {Função} unittest.addModuleCleanup (function, /, *args, **kwargs)

Add a function to be called after @ref{137b,,tearDownModule()} to cleanup
resources used during the test class. Functions will be called in reverse
order to the order they are added (@abbr{LIFO}).
They are called with any arguments and keyword arguments passed into
@ref{a55,,addModuleCleanup()} when they are added.

If @ref{a57,,setUpModule()} fails, meaning that @ref{137b,,tearDownModule()} is not
called, then any cleanup functions added will still be called.


Adicionado na versão 3.8.

@end deffn

@geindex enterModuleContext() (no módulo unittest)
@anchor{library/unittest unittest enterModuleContext}@anchor{6bc}
@deffn {Função} unittest.enterModuleContext (cm)

Enter the supplied @ref{5d4,,context manager}.  If successful, also
add its @ref{1344,,__exit__()} method as a cleanup function by
@ref{a55,,addModuleCleanup()} and return the result of the
@ref{5c8,,__enter__()} method.


Adicionado na versão 3.11.

@end deffn

@geindex doModuleCleanups() (no módulo unittest)
@anchor{library/unittest unittest doModuleCleanups}@anchor{195d}
@deffn {Função} unittest.doModuleCleanups ()

This function is called unconditionally after @ref{137b,,tearDownModule()}, or
after @ref{a57,,setUpModule()} if @ref{a57,,setUpModule()} raises an exception.

It is responsible for calling all the cleanup functions added by
@ref{a55,,addModuleCleanup()}. If you need cleanup functions to be called
`prior' to @ref{137b,,tearDownModule()} then you can call
@ref{195d,,doModuleCleanups()} yourself.

@ref{195d,,doModuleCleanups()} pops methods off the stack of cleanup
functions one at a time, so it can be called at any time.


Adicionado na versão 3.8.

@end deffn

@node Tratamento de sinal,,Classes e Módulos de Definição de Contexto,unittest — Framework de testes unitários
@anchor{library/unittest signal-handling}@anchor{4285}
@subsubsection Tratamento de sinal



Adicionado na versão 3.2.


The @ref{1377,,-c/--catch} command-line option to unittest,
along with the @code{catchbreak} parameter to @ref{1019,,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{9d9,,KeyboardInterrupt} in the usual way.

The control-c handling signal handler attempts to remain compatible with code or
tests that install their own @ref{847,,signal.SIGINT} handler. If the @code{unittest}
handler is called but `isn’t' the installed @ref{847,,signal.SIGINT} handler,
i.e. it has been replaced by the system under test and delegated to, then it
calls the default handler. This will normally be the expected behavior by code
that replaces an installed handler and delegates to it. For individual tests
that need @code{unittest} control-c handling disabled the @ref{1378,,removeHandler()}
decorator can be used.

There are a few utility functions for framework authors to enable control-c
handling functionality within test frameworks.

@geindex installHandler() (no módulo unittest)
@anchor{library/unittest unittest installHandler}@anchor{42d5}
@deffn {Função} unittest.installHandler ()

Install the control-c handler. When a @ref{847,,signal.SIGINT} is received
(usually in response to the user pressing control-c) all registered results
have @ref{42c5,,stop()} called.
@end deffn

@geindex registerResult() (no módulo unittest)
@anchor{library/unittest unittest registerResult}@anchor{42d6}
@deffn {Função} unittest.registerResult (result)

Register a @ref{11a6,,TestResult} object for control-c handling. Registering a
result stores a weak reference to it, so it doesn’t prevent the result from
being garbage collected.

Registering a @ref{11a6,,TestResult} object has no side-effects if control-c
handling is not enabled, so test frameworks can unconditionally register
all results they create independently of whether or not handling is enabled.
@end deffn

@geindex removeResult() (no módulo unittest)
@anchor{library/unittest unittest removeResult}@anchor{42d7}
@deffn {Função} unittest.removeResult (result)

Remove um resultado registrado. Dado que um resultado for removido, então @ref{42c5,,stop()} não será mais chamado no objeto resultado em resposta a um Ctrl+C
@end deffn

@geindex removeHandler() (no módulo unittest)
@anchor{library/unittest unittest removeHandler}@anchor{1378}
@deffn {Função} unittest.removeHandler (function=None)

When called without arguments this function removes the control-c handler
if it has been installed. This function can also be used as a test decorator
to temporarily remove the handler while the test is being executed:

@example
@@unittest.removeHandler
def test_signal_handling(self):
    ...
@end example
@end deffn

@node unittest mock — mock object library,unittest mock — primeiros passos,unittest — Framework de testes unitários,Ferramentas de Desenvolvimento
@anchor{library/unittest mock doc}@anchor{42d8}@anchor{library/unittest mock module-unittest mock}@anchor{107}@anchor{library/unittest mock translation-repo}@anchor{42d9}@anchor{library/unittest mock unittest-mock-mock-object-library}@anchor{42da}
@subsection @code{unittest.mock} — mock object library


@geindex module; unittest.mock


Adicionado na versão 3.3.


`Código-fonte:' Lib/unittest/mock.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/unittest/mock.py}


__________________________________________________________________


@ref{107,,unittest.mock} é uma biblioteca para teste em Python. Que permite substituir partes do seu sistema em teste por objetos simulados e fazer afirmações sobre como elas foram usadas.

@ref{107,,unittest.mock} fornece uma classe core @ref{a54,,Mock} removendo a necessidade de criar uma série de stubs em todo o seu conjunto de testes. Depois de executar uma ação, você pode fazer afirmações sobre quais métodos / atributos foram usados e com quais argumentos foram chamados. Você também pode especificar valores de retorno e definir os atributos necessários da maneira normal.

Adicionalmente, o mock fornece um decorador @ref{ec1,,patch()} que lida com os atributos do módulo de patch e do nível de classe no escopo de um teste, junto com @ref{bb8,,sentinel} para criar objetos únicos. Veja o @ref{42db,,guia rápido} para alguns exemplos de como usar @ref{a54,,Mock}, @ref{ebe,,MagicMock} e @ref{ec1,,patch()}.

Mock foi projetado para uso com @ref{106,,unittest} e é baseado no padrão ‘ação -> asserção’ em vez de ‘gravar -> reproduzir’ usado por muitas estruturas de simulação.

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
* Guia Rápido:: 
* A classe Mock:: 
* Os criadores de patches:: 
* MagicMock and magic method support:: 
* Ajudantes:: 
* Order of precedence of side_effect@comma{} return_value and wraps: Order of precedence of side_effect return_value and wraps. 

@end menu

@node Guia Rápido,A classe Mock,,unittest mock — mock object library
@anchor{library/unittest mock quick-guide}@anchor{42db}
@subsubsection Guia Rápido


@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

Os objetos @ref{a54,,Mock} e @ref{ebe,,MagicMock} criam todos os atributos e métodos à medida que você os acessa e armazena detalhes de como eles foram usados. Você pode configurá-los, especificar valores de retorno ou limitar quais atributos estão disponíveis e, em seguida, fazer afirmações sobre como eles foram usados:

@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{42dc,,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

O Mock tem muitas outras maneiras de configurá-lo e controlar seu comportamento. Por exemplo, o argumento `spec' configura o mock para obter sua especificação de outro objeto. Tentar acessar atributos ou métodos no mock que não existem no spec falhará com um @ref{34b,,AttributeError}.

O gerenciador de contexto / decorador @ref{ec1,,patch()} facilita a simulação de classes ou objetos em um módulo em teste. O objeto que você especificar será substituído por um mock (ou outro objeto) durante o teste e restaurado quando o teste terminar:

@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 
Quando você aninha decoradores de patches, as simulações são passadas para a função decorada na mesma ordem em que foram aplicadas (a ordem normal `Python' em que os decoradores são aplicados). Isso significa de baixo para cima, portanto, no exemplo acima, a simulação para @code{module.ClassName1} é passada primeiro.

Com @ref{ec1,,patch()}, é importante que você faça o patch de objetos no espaço de nomes onde eles são procurados. Normalmente, isso é simples, mas para um guia rápido, leia @ref{42dd,,onde fazer o patch}.
@end quotation
@end cartouche

Assim como um decorador @ref{ec1,,patch()} pode ser usado como um gerenciador de contexto em uma instrução 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

Também existe @ref{1b6a,,patch.dict()} para definir valores em um dicionário apenas durante um escopo e restaurar o dicionário ao seu estado original quando o teste termina:

@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 possui suporte a simulação de @ref{42de,,métodos mágicos} de Python. A maneira mais fácil de usar métodos mágicos é com a classe @ref{ebe,,MagicMock}. Ele permite que você faça coisas como:

@example
>>> mock = MagicMock()
>>> mock.__str__.return_value = 'foobarbaz'
>>> str(mock)
'foobarbaz'
>>> mock.__str__.assert_called_with()
@end example

Mock permite atribuir funções (ou outras instâncias do Mock) a métodos mágicos e elas serão chamadas apropriadamente. A classe @ref{ebe,,MagicMock} é apenas uma variante do Mock que possui todos os métodos mágicos pré-criados para você (bem, todos os úteis de qualquer maneira).

A seguir, é apresentado um exemplo do uso de métodos mágicos com a classe Mock comum:

@example
>>> mock = Mock()
>>> mock.__str__ = Mock(return_value='wheeeeee')
>>> str(mock)
'wheeeeee'
@end example

Para garantir que os objetos mock em seus testes tenham a mesmo API que os objetos que eles estão substituindo, você pode usar @ref{42df,,especificação automática}. A especificação automática pode ser feita por meio do argumento `autospec' para fazer patch ou pela função @ref{16f4,,create_autospec()}. A especificação automática cria objetos mock que têm os mesmos atributos e métodos que os objetos que estão substituindo, e qualquer funções e métodos (incluindo construtores) têm a mesma assinatura de chamada que o objeto real.

Isso garante que seus mocks falharão da mesma forma que o código de produção se forem usados incorretamente:

@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{16f4,,create_autospec()} também pode ser usada com classes, onde copia a assinatura do método @code{__init__}, e com objetos chamáveis onde copia a assinatura do método @code{__call__}.

@node A classe Mock,Os criadores de patches,Guia Rápido,unittest mock — mock object library
@anchor{library/unittest mock the-mock-class}@anchor{42e0}
@subsubsection A classe 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{a54,,Mock} é um objeto simulado flexível destinado a substituir o uso de `stubs' e dublês de teste em todo o seu código. Os mocks são chamáveis e cria atributos como novos mocks à medida que você os acessa @footnote{
The only exceptions are magic methods and attributes (those that have
leading and trailing double underscores). Mock doesn’t create these but
instead raises an @ref{34b,,AttributeError}. This is because the interpreter
will often implicitly request these methods, and gets `very' confused to
get a new Mock object when it expects a magic method. If you need magic
method support see @ref{42de,,magic methods}.
}. Acessar o mesmo atributo sempre retorna o mesmo mock. Os mocks registram como você os utiliza, permitindo que você faça asserções sobre o que o seu código fez com eles.

@ref{ebe,,MagicMock} é uma subclasse de @ref{a54,,Mock} com todos os métodos mágicos pré-criados e prontos para uso. Existem também variantes não chamáveis, úteis quando você está simulando objetos que não são chamáveis: @ref{42e1,,NonCallableMock} e @ref{42e2,,NonCallableMagicMock}

The @ref{ec1,,patch()} decorators makes it easy to temporarily replace classes
in a particular module with a @ref{a54,,Mock} object. By default @ref{ec1,,patch()} will create
a @ref{ebe,,MagicMock} for you. You can specify an alternative class of @ref{a54,,Mock} using
the `new_callable' argument to @ref{ec1,,patch()}.

@geindex Mock (classe em unittest.mock)
@anchor{library/unittest mock unittest mock Mock}@anchor{a54}
@deffn {Classe} unittest.mock.Mock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

Create a new @ref{a54,,Mock} object. @ref{a54,,Mock} takes several optional arguments
that specify the behaviour of the Mock object:


@itemize *

@item 
`spec': This can be either a list of strings or an existing object (a
class or instance) that acts as the specification for the mock object. If
you pass in an object then a list of strings is formed by calling dir on
the object (excluding unsupported magic attributes and methods).
Accessing any attribute not in this list will raise an @ref{34b,,AttributeError}.

If `spec' is an object (rather than a list of strings) then
@ref{14f5,,__class__} returns the class of the spec object. This
allows mocks to pass @ref{442,,isinstance()} tests.

@item 
`spec_set': A stricter variant of `spec'. If used, attempting to `set'
or get an attribute on the mock that isn’t on the object passed as
`spec_set' will raise an @ref{34b,,AttributeError}.

@item 
`side_effect': A function to be called whenever the Mock is called. See
the @ref{42dc,,side_effect} attribute. Useful for raising exceptions or
dynamically changing return values. The function is called with the same
arguments as the mock, and unless it returns @ref{42e3,,DEFAULT}, the return
value of this function is used as the return value.

Alternatively `side_effect' can be an exception class or instance. In
this case the exception will be raised when the mock is called.

If `side_effect' is an iterable then each call to the mock will return
the next value from the iterable.

A `side_effect' can be cleared by setting it to @code{None}.

@item 
`return_value': The value returned when the mock is called. By default
this is a new Mock (created on first access). See the
@ref{42e4,,return_value} attribute.

@item 
`unsafe': By default, accessing any attribute whose name starts with
`assert', `assret', `asert', `aseert' or `assrt' will raise an
@ref{34b,,AttributeError}. Passing @code{unsafe=True} will allow access to
these attributes.


Adicionado na versão 3.5.


@item 
`wraps': Item for the mock object to wrap. If `wraps' is not @code{None} then
calling the Mock will pass the call through to the wrapped object
(returning the real result). Attribute access on the mock will return a
Mock object that wraps the corresponding attribute of the wrapped
object (so attempting to access an attribute that doesn’t exist will
raise an @ref{34b,,AttributeError}).

If the mock has an explicit `return_value' set then calls are not passed
to the wrapped object and the `return_value' is returned instead.

@item 
`name': If the mock has a name then it will be used in the repr of the
mock. This can be useful for debugging. The name is propagated to child
mocks.
@end itemize

Mocks can also be called with arbitrary keyword arguments. These will be
used to set attributes on the mock after it is created. See the
@ref{42e5,,configure_mock()} method for details.

@geindex assert_called() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called}@anchor{d19}
@deffn {Método} assert_called ()

Afirmar que o mock foi chamado pelo menos uma vez.

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called()
@end example


Adicionado na versão 3.6.

@end deffn

@geindex assert_called_once() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_once}@anchor{d1a}
@deffn {Método} assert_called_once ()

Afirma que o mock foi chamado exatamente uma 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


Adicionado na versão 3.6.

@end deffn

@geindex assert_called_with() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_with}@anchor{1b99}
@deffn {Método} assert_called_with (*args, **kwargs)

This method is a convenient way of asserting that the last call has been
made in a particular way:

@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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_called_once_with}@anchor{42e6}
@deffn {Método} assert_called_once_with (*args, **kwargs)

Assert that the mock was called exactly once and that call was with the
specified arguments.

@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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_any_call}@anchor{42e7}
@deffn {Método} assert_any_call (*args, **kwargs)

assert the mock has been called with the specified arguments.

The assert passes if the mock has `ever' been called, unlike
@ref{1b99,,assert_called_with()} and @ref{42e6,,assert_called_once_with()} that
only pass if the call is the most recent one, and in the case of
@ref{42e6,,assert_called_once_with()} it must also be the only call.

@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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_has_calls}@anchor{179d}
@deffn {Método} assert_has_calls (calls, any_order=False)

assert the mock has been called with the specified calls.
The @ref{42e8,,mock_calls} list is checked for the calls.

If `any_order' is false then the calls must be
sequential. There can be extra calls before or after the
specified calls.

If `any_order' is true then the calls can be in any order, but
they must all appear in @ref{42e8,,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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock assert_not_called}@anchor{ebd}
@deffn {Método} assert_not_called ()

Afirma que o mock nunca foi chamado.

@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


Adicionado na versão 3.5.

@end deffn

@geindex reset_mock() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock reset_mock}@anchor{d1b}
@deffn {Método} reset_mock (*, return_value=False, side_effect=False)

The reset_mock method resets all the call attributes on a mock object:

@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{42e4,,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{42dc,,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{d1b,,reset_mock()} `doesn’t' clear the
@ref{42e4,,return_value}, @ref{42dc,,side_effect} or any child attributes you have
set using normal assignment by default.

Child mocks are reset as well.


Alterado na versão 3.6: Foram adicionados dois argumentos somente-nomeado à função reset_mock.

@end deffn

@geindex mock_add_spec() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock mock_add_spec}@anchor{42e9}
@deffn {Método} mock_add_spec (spec, spec_set=False)

Add a spec to a mock. `spec' can either be an object or a
list of strings. Only attributes on the `spec' can be fetched as
attributes from the mock.

If `spec_set' is true then only attributes on the spec can be set.
@end deffn

@geindex attach_mock() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock attach_mock}@anchor{16fa}
@deffn {Método} attach_mock (mock, attribute)

Attach a mock as an attribute of this one, replacing its name and
parent. Calls to the attached mock will be recorded in the
@ref{42ea,,method_calls} and @ref{42e8,,mock_calls} attributes of this one.
@end deffn

@geindex configure_mock() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock configure_mock}@anchor{42e5}
@deffn {Método} configure_mock (**kwargs)

Define atributos no mock por meio de argumentos nomeados.

Attributes plus return values and side effects can be set on child
mocks using standard dot notation and unpacking a dictionary in the
method call:

@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

The same thing can be achieved in the constructor call to mocks:

@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{42e5,,configure_mock()} exists to make it easier to do configuration
after the mock has been created.
@end deffn

@geindex __dir__() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock __dir__}@anchor{42eb}
@deffn {Método} __dir__ ()

@ref{a54,,Mock} objects limit the results of @code{dir(some_mock)} to useful results.
For mocks with a `spec' this includes all the permitted attributes
for the mock.

See @ref{42ec,,FILTER_DIR} for what this filtering does, and how to
switch it off.
@end deffn

@geindex _get_child_mock() (método unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock _get_child_mock}@anchor{42ed}
@deffn {Método} _get_child_mock (**kw)

Create the child mocks for attributes and return value.
By default child mocks will be the same type as the parent.
Subclasses of Mock may want to override this to customize the way
child mocks are made.

For non-callable mocks the callable variant will be used (rather than
any custom subclass).
@end deffn

@geindex called (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock called}@anchor{42ee}
@deffn {Atributo} called

A boolean representing whether or not the mock object has been called:

@example
>>> mock = Mock(return_value=None)
>>> mock.called
False
>>> mock()
>>> mock.called
True
@end example
@end deffn

@geindex call_count (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_count}@anchor{15aa}
@deffn {Atributo} call_count

An integer telling you how many times the mock object has been called:

@example
>>> mock = Mock(return_value=None)
>>> mock.call_count
0
>>> mock()
>>> mock()
>>> mock.call_count
2
@end example
@end deffn

@geindex return_value (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock return_value}@anchor{42e4}
@deffn {Atributo} return_value

Set this to configure the value returned by calling the mock:

@example
>>> mock = Mock()
>>> mock.return_value = 'fish'
>>> mock()
'fish'
@end example

The default return value is a mock object and you can configure it in
the normal way:

@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{42e4,,return_value} também pode ser definido no construtor:

@example
>>> mock = Mock(return_value=3)
>>> mock.return_value
3
>>> mock()
3
@end example
@end deffn

@geindex side_effect (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock side_effect}@anchor{42dc}
@deffn {Atributo} side_effect

This can either be a function to be called when the mock is called,
an iterable or an exception (class or instance) to be raised.

If you pass in a function it will be called with same arguments as the
mock and unless the function returns the @ref{42e3,,DEFAULT} singleton the
call to the mock will then return whatever the function returns. If the
function returns @ref{42e3,,DEFAULT} then the mock will return its normal
value (from the @ref{42e4,,return_value}).

If you pass in an iterable, it is used to retrieve an iterator which
must yield a value on every call.  This value can either be an exception
instance to be raised, or a value to be returned from the call to the
mock (@ref{42e3,,DEFAULT} handling is identical to the function case).

An example of a mock that raises an exception (to test exception
handling of an API):

@example
>>> mock = Mock()
>>> mock.side_effect = Exception('Boom!')
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

Usando @ref{42dc,,side_effect} para retornar um sequência de valores:

@example
>>> mock = Mock()
>>> mock.side_effect = [3, 2, 1]
>>> mock(), mock(), mock()
(3, 2, 1)
@end example

Usando um chamável:

@example
>>> mock = Mock(return_value=3)
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> mock.side_effect = side_effect
>>> mock()
3
@end example

@ref{42dc,,side_effect} can be set in the constructor. Here’s an example that
adds one to the value the mock is called with and returns it:

@example
>>> side_effect = lambda value: value + 1
>>> mock = Mock(side_effect=side_effect)
>>> mock(3)
4
>>> mock(-8)
-7
@end example

Configuração @ref{42dc,,side_effect} para @code{None} limpa isso:

@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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_args}@anchor{1af8}
@deffn {Atributo} call_args

This is either @code{None} (if the mock hasn’t been called), or the
arguments that the mock was last called with. This will be in the
form of a tuple: the first member, which can also be accessed through
the @code{args} property, is any positional arguments the mock was
called with (or an empty tuple) and the second member, which can
also be accessed through the @code{kwargs} property, is any keyword
arguments (or an empty dictionary).

@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

@ref{1af8,,call_args}, along with members of the lists @ref{42ef,,call_args_list},
@ref{42ea,,method_calls} and @ref{42e8,,mock_calls} are @ref{1b45,,call} objects.
These are tuples, so they can be unpacked to get at the individual
arguments and make more complex assertions. See
@ref{42f0,,calls as tuples}.


Alterado na versão 3.8: Adicionadas propriedades @code{args} e @code{kwargs}.

@end deffn

@geindex call_args_list (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock call_args_list}@anchor{42ef}
@deffn {Atributo} call_args_list

This is a list of all the calls made to the mock object in sequence
(so the length of the list is the number of times it has been
called). Before any calls have been made it is an empty list. The
@ref{1b45,,call} object can be used for conveniently constructing lists of
calls to compare with @ref{42ef,,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

Members of @ref{42ef,,call_args_list} are @ref{1b45,,call} objects. These can be
unpacked as tuples to get at the individual arguments. See
@ref{42f0,,calls as tuples}.
@end deffn

@geindex method_calls (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock method_calls}@anchor{42ea}
@deffn {Atributo} method_calls

As well as tracking calls to themselves, mocks also track calls to
methods and attributes, and `their' methods and attributes:

@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

Members of @ref{42ea,,method_calls} are @ref{1b45,,call} objects. These can be
unpacked as tuples to get at the individual arguments. See
@ref{42f0,,calls as tuples}.
@end deffn

@geindex mock_calls (atributo unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock mock_calls}@anchor{42e8}
@deffn {Atributo} mock_calls

@ref{42e8,,mock_calls} records `all' calls to the mock object, its methods,
magic methods `and' return value mocks.

@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

Members of @ref{42e8,,mock_calls} are @ref{1b45,,call} objects. These can be
unpacked as tuples to get at the individual arguments. See
@ref{42f0,,calls as tuples}.

@cartouche
@quotation Nota 
The way @ref{42e8,,mock_calls} are recorded means that where nested
calls are made, the parameters of ancestor calls are not recorded
and so will always compare equal:

@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 unittest.mock.Mock)
@anchor{library/unittest mock unittest mock Mock __class__}@anchor{42f1}
@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{442,,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{442,,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 (classe em unittest.mock)
@anchor{library/unittest mock unittest mock NonCallableMock}@anchor{42e1}
@deffn {Classe} unittest.mock.NonCallableMock (spec=None, wraps=None, name=None, spec_set=None, **kwargs)

A non-callable version of @ref{a54,,Mock}. The constructor parameters have the same
meaning of @ref{a54,,Mock}, with the exception of `return_value' and `side_effect'
which have no meaning on a non-callable mock.
@end deffn

Mock objects that use a class or an instance as a @code{spec} or
@code{spec_set} are able to pass @ref{442,,isinstance()} tests:

@example
>>> mock = Mock(spec=SomeClass)
>>> isinstance(mock, SomeClass)
True
>>> mock = Mock(spec_set=SomeClass())
>>> isinstance(mock, SomeClass)
True
@end example

The @ref{a54,,Mock} classes have support for mocking magic methods. See @ref{42de,,magic methods} for the full details.

The mock classes and the @ref{ec1,,patch()} decorators all take arbitrary keyword
arguments for configuration. For the @ref{ec1,,patch()} decorators the keywords are
passed to the constructor of the mock being created. The keyword arguments
are for configuring attributes of the mock:

@example
>>> m = MagicMock(attribute=3, other='fish')
>>> m.attribute
3
>>> m.other
'fish'
@end example

The return value and side effect of child mocks can be set in the same way,
using dotted notation. As you can’t use dotted names directly in a call you
have to create a dictionary and unpack it using @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

A callable mock which was created with a `spec' (or a `spec_set') will
introspect the specification object’s signature when matching calls to
the mock.  Therefore, it can match the actual call’s arguments regardless
of whether they were passed positionally or by name:

@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

This applies to @ref{1b99,,assert_called_with()},
@ref{42e6,,assert_called_once_with()}, @ref{179d,,assert_has_calls()} and
@ref{42e7,,assert_any_call()}.  When @ref{42df,,Especificação automática}, it will also
apply to method calls on the mock object.


Alterado na versão 3.4: Adicionada introspecção de assinatura em objetos mock especificados e auto-especificados.


@geindex PropertyMock (classe em unittest.mock)
@anchor{library/unittest mock unittest mock PropertyMock}@anchor{42f2}
@deffn {Classe} unittest.mock.PropertyMock (*args, **kwargs)

A mock intended to be used as a @ref{194,,property}, or other
@ref{1658,,descriptor}, on a class. @ref{42f2,,PropertyMock} provides
@ref{1530,,__get__()} and @ref{20f7,,__set__()} methods
so you can specify a return value when it is fetched.

Fetching a @ref{42f2,,PropertyMock} instance from an object calls the mock, with
no args. Setting it calls the mock with the value being set.

@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

Because of the way mock attributes are stored you can’t directly attach a
@ref{42f2,,PropertyMock} to a mock object. Instead you can attach it to the mock type
object:

@example
>>> m = MagicMock()
>>> p = PropertyMock(return_value=3)
>>> type(m).foo = p
>>> m.foo
3
>>> p.assert_called_once_with()
@end example

@cartouche
@quotation Cuidado 
If an @ref{34b,,AttributeError} is raised by @ref{42f2,,PropertyMock},
it will be interpreted as a missing descriptor and
@ref{4d3,,__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{4d3,,__getattr__()} for details.
@end quotation
@end cartouche

@geindex AsyncMock (classe em unittest.mock)
@anchor{library/unittest mock unittest mock AsyncMock}@anchor{a53}
@deffn {Classe} unittest.mock.AsyncMock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

An asynchronous version of @ref{ebe,,MagicMock}. The @ref{a53,,AsyncMock} object will
behave so the object is recognized as an async function, and the result of a
call is an awaitable.

@example
>>> mock = AsyncMock()
>>> asyncio.iscoroutinefunction(mock)
True
>>> inspect.isawaitable(mock())
True
@end example

The result of @code{mock()} is an async function which will have the outcome
of @code{side_effect} or @code{return_value} after it has been awaited:


@itemize -

@item 
if @code{side_effect} is a function, the async function will return the
result of that function,

@item 
if @code{side_effect} is an exception, the async function will raise the
exception,

@item 
if @code{side_effect} is an iterable, the async function will return the
next value of the iterable, however, if the sequence of result is
exhausted, @code{StopAsyncIteration} is raised immediately,

@item 
if @code{side_effect} is not defined, the async function will return the
value defined by @code{return_value}, hence, by default, the async function
returns a new @ref{a53,,AsyncMock} object.
@end itemize

Setting the `spec' of a @ref{a54,,Mock} or @ref{ebe,,MagicMock} to an async function
will result in a coroutine object being returned after calling.

@example
>>> async def async_func(): pass
...
>>> mock = MagicMock(async_func)
>>> mock
<MagicMock spec='function' id='...'>
>>> mock()
<coroutine object AsyncMockMixin._mock_call at ...>
@end example

Setting the `spec' of a @ref{a54,,Mock}, @ref{ebe,,MagicMock}, or @ref{a53,,AsyncMock}
to a class with asynchronous and synchronous functions will automatically
detect the synchronous functions and set them as @ref{ebe,,MagicMock} (if the
parent mock is @ref{a53,,AsyncMock} or @ref{ebe,,MagicMock}) or @ref{a54,,Mock} (if
the parent mock is @ref{a54,,Mock}). All asynchronous functions will be
@ref{a53,,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


Adicionado na versão 3.8.


@geindex assert_awaited() (método unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited}@anchor{42f3}
@deffn {Método} assert_awaited ()

Assert that the mock was awaited at least once. Note that this is separate
from the object having been called, the @code{await} keyword must be used:

@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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once}@anchor{42f4}
@deffn {Método} assert_awaited_once ()

Afirme que o mock foi aguardado exatamente uma 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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_with}@anchor{42f5}
@deffn {Método} assert_awaited_with (*args, **kwargs)

Assert that the last await was with the specified arguments.

@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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once_with}@anchor{42f6}
@deffn {Método} assert_awaited_once_with (*args, **kwargs)

Assert that the mock was awaited exactly once and with the specified
arguments.

@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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_any_await}@anchor{42f7}
@deffn {Método} assert_any_await (*args, **kwargs)

Assert the mock has ever been awaited with the specified arguments.

@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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_has_awaits}@anchor{42f8}
@deffn {Método} assert_has_awaits (calls, any_order=False)

Assert the mock has been awaited with the specified calls.
The @ref{1af7,,await_args_list} list is checked for the awaits.

If `any_order' is false then the awaits must be
sequential. There can be extra calls before or after the
specified awaits.

If `any_order' is true then the awaits can be in any order, but
they must all appear in @ref{1af7,,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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock assert_not_awaited}@anchor{42f9}
@deffn {Método} assert_not_awaited ()

Afirma que o mock nunca foi aguardado.

@example
>>> mock = AsyncMock()
>>> mock.assert_not_awaited()
@end example
@end deffn

@geindex reset_mock() (método unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock reset_mock}@anchor{42fa}
@deffn {Método} reset_mock (*args, **kwargs)

See @ref{d1b,,Mock.reset_mock()}. Also sets @ref{42fb,,await_count} to 0,
@ref{42fc,,await_args} to None, and clears the @ref{1af7,,await_args_list}.
@end deffn

@geindex await_count (atributo unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_count}@anchor{42fb}
@deffn {Atributo} await_count

An integer keeping track of how many times the mock object has been awaited.

@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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_args}@anchor{42fc}
@deffn {Atributo} await_args

This is either @code{None} (if the mock hasn’t been awaited), or the arguments that
the mock was last awaited with. Functions the same as @ref{1af8,,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 unittest.mock.AsyncMock)
@anchor{library/unittest mock unittest mock AsyncMock await_args_list}@anchor{1af7}
@deffn {Atributo} await_args_list

This is a list of all the awaits made to the mock object in sequence (so the
length of the list is the number of times it has been awaited). Before any
awaits have been made it is an empty list.

@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 (classe em unittest.mock)
@anchor{library/unittest mock unittest mock ThreadingMock}@anchor{42fd}
@deffn {Classe} 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{ebe,,MagicMock} for multithreading tests. The
@ref{42fd,,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{42fe,,ThreadingMock.DEFAULT_TIMEOUT} attribute, which defaults to blocking (@code{None}).

You can configure the global default timeout by setting @ref{42fe,,ThreadingMock.DEFAULT_TIMEOUT}.

@geindex wait_until_called() (método unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_called}@anchor{42ff}
@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{6a9,,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 unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_any_call_with}@anchor{4300}
@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{6a9,,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 unittest.mock.ThreadingMock)
@anchor{library/unittest mock unittest mock ThreadingMock DEFAULT_TIMEOUT}@anchor{42fe}
@deffn {Atributo} DEFAULT_TIMEOUT

Global default timeout in seconds to create instances of @ref{42fd,,ThreadingMock}.
@end deffn


Adicionado na versão 3.13.

@end deffn

@menu
* Fazendo chamadas:: 
* Deletando Atributos:: 
* Nomes de Mock e o atributo name:: 
* Anexando Mocks como Atributos:: 

@end menu

@node Fazendo chamadas,Deletando Atributos,,A classe Mock
@anchor{library/unittest mock calling}@anchor{4301}
@subsubsection Fazendo chamadas


Mock objects are callable. The call will return the value set as the
@ref{42e4,,return_value} attribute. The default return value is a new Mock
object; it is created the first time the return value is accessed (either
explicitly or by calling the Mock) - but it is stored and the same one
returned each time.

Calls made to the object will be recorded in the attributes
like @ref{1af8,,call_args} and @ref{42ef,,call_args_list}.

If @ref{42dc,,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.

The simplest way to make a mock raise an exception when called is to make
@ref{42dc,,side_effect} an exception class or instance:

@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{42dc,,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{42e4,,return_value} from inside @ref{42dc,,side_effect}, or return @ref{42e3,,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{42dc,,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{42dc,,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{c15,,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

If any members of the iterable are exceptions they will be raised instead of
returned:

@example
>>> iterable = (33, ValueError, 66)
>>> m = MagicMock(side_effect=iterable)
>>> m()
33
>>> m()
Traceback (most recent call last):
 ...
ValueError
>>> m()
66
@end example

@node Deletando Atributos,Nomes de Mock e o atributo name,Fazendo chamadas,A classe Mock
@anchor{library/unittest mock deleting-attributes}@anchor{4302}@anchor{library/unittest mock id2}@anchor{4303}
@subsubsection Deletando Atributos


Mock objects create attributes on demand. This allows them to pretend to be
objects of any type.

You may want a mock object to return @code{False} to a @ref{4d2,,hasattr()} call, or raise an
@ref{34b,,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.

You “block” attributes by deleting them. Once deleted, accessing an attribute
will raise an @ref{34b,,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 Nomes de Mock e o atributo name,Anexando Mocks como Atributos,Deletando Atributos,A classe Mock
@anchor{library/unittest mock mock-names-and-the-name-attribute}@anchor{4304}
@subsubsection Nomes de Mock e o atributo `name'


Since “name” is an argument to the @ref{a54,,Mock} constructor, if you want your
mock object to have a “name” attribute you can’t just pass it in at creation
time. There are two alternatives. One option is to use
@ref{42e5,,configure_mock()}:

@example
>>> mock = MagicMock()
>>> mock.configure_mock(name='my_name')
>>> mock.name
'my_name'
@end example

A simpler option is to simply set the “name” attribute after mock creation:

@example
>>> mock = MagicMock()
>>> mock.name = "foo"
@end example

@node Anexando Mocks como Atributos,,Nomes de Mock e o atributo name,A classe Mock
@anchor{library/unittest mock attaching-mocks-as-attributes}@anchor{4305}
@subsubsection Anexando Mocks como Atributos


When you attach a mock as an attribute of another mock (or as the return
value) it becomes a “child” of that mock. Calls to the child are recorded in
the @ref{42ea,,method_calls} and @ref{42e8,,mock_calls} attributes of the
parent. This is useful for configuring child mocks and then attaching them to
the parent, or for attaching mocks to a parent that records all calls to the
children and allows you to make assertions about the order of calls between
mocks:

@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

The exception to this is if the mock has a name. This allows you to prevent
the “parenting” if for some reason you don’t want it to happen.

@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

Mocks created for you by @ref{ec1,,patch()} are automatically given names. To
attach mocks that have names to a parent you use the @ref{16fa,,attach_mock()}
method:

@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 Os criadores de patches,MagicMock and magic method support,A classe Mock,unittest mock — mock object library
@anchor{library/unittest mock the-patchers}@anchor{4306}
@subsubsection Os criadores de patches


The patch decorators are used for patching objects only within the scope of
the function they decorate. They automatically handle the unpatching for you,
even if exceptions are raised. All of these functions can also be used in with
statements or as class decorators.

@menu
* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* métodos do patch; start e stop: métodos do patch start e stop. 
* patch de embutidos:: 
* TEST_PREFIX:: 
* Aninhando Decoradores Patch:: 
* Onde fazer patch:: 
* Patching Descriptors and Proxy Objects:: 

@end menu

@node patch,patch object,,Os criadores de patches
@anchor{library/unittest mock patch}@anchor{4307}
@subsubsection patch


@cartouche
@quotation Nota 
The key is to do the patching in the right namespace. See the section @ref{4308,,where to patch}.
@end quotation
@end cartouche

@geindex patch() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch}@anchor{ec1}
@deffn {Função} unittest.mock.patch (target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

@ref{ec1,,patch()} acts as a function decorator, class decorator or a context
manager. Inside the body of the function or with statement, the `target'
is patched with a `new' object. When the function/with statement exits
the patch is undone.

If `new' is omitted, then the target is replaced with an
@ref{a53,,AsyncMock} if the patched object is an async function or
a @ref{ebe,,MagicMock} otherwise.
If @ref{ec1,,patch()} is used as a decorator and `new' is
omitted, the created mock is passed in as an extra argument to the
decorated function. If @ref{ec1,,patch()} is used as a context manager the created
mock is returned by the context manager.

`target' should be a string in the form @code{'package.module.ClassName'}. The
`target' is imported and the specified object replaced with the `new'
object, so the `target' must be importable from the environment you are
calling @ref{ec1,,patch()} from. The target is imported when the decorated function
is executed, not at decoration time.

The `spec' and `spec_set' keyword arguments are passed to the @ref{ebe,,MagicMock}
if patch is creating one for you.

In addition you can pass @code{spec=True} or @code{spec_set=True}, which causes
patch to pass in the object being mocked as the spec/spec_set object.

`new_callable' allows you to specify a different class, or callable object,
that will be called to create the `new' object. By default @ref{a53,,AsyncMock}
is used for async functions and @ref{ebe,,MagicMock} for the rest.

A more powerful form of `spec' is `autospec'. If you set @code{autospec=True}
then the mock will be created with a spec from the object being replaced.
All attributes of the mock will also have the spec of the corresponding
attribute of the object being replaced. Methods and functions being mocked
will have their arguments checked and will raise a @ref{2c3,,TypeError} if they are
called with the wrong signature. For mocks
replacing a class, their return value (the ‘instance’) will have the same
spec as the class. See the @ref{16f4,,create_autospec()} function and
@ref{42df,,Especificação automática}.

Instead of @code{autospec=True} you can pass @code{autospec=some_object} to use an
arbitrary object as the spec instead of the one being replaced.

By default @ref{ec1,,patch()} will fail to replace attributes that don’t exist.
If you pass in @code{create=True}, and the attribute doesn’t exist, patch will
create the attribute for you when the patched function is called, and delete
it again after the patched function has exited. This is useful for writing
tests against attributes that your production code creates at runtime. It is
off by default because it can be dangerous. With it switched on you can
write passing tests against APIs that don’t actually exist!

@cartouche
@quotation Nota 

Alterado na versão 3.5: If you are patching builtins in a module then you don’t
need to pass @code{create=True}, it will be added by default.

@end quotation
@end cartouche

Patch can be used as a @ref{44f,,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{ec1,,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 can be used as a context manager, with the with statement. Here the
patching applies to the indented block after the with statement. If you
use “as” then the patched object will be bound to the name after the
“as”; very useful if @ref{ec1,,patch()} is creating a mock object for you.

@ref{ec1,,patch()} takes arbitrary keyword arguments. These will be passed to
@ref{a53,,AsyncMock} if the patched object is asynchronous, to
@ref{ebe,,MagicMock} otherwise or to `new_callable' if specified.

@code{patch.dict(...)}, @code{patch.multiple(...)} e @code{patch.object(...)} estão disponíveis para casos de uso alternativos.
@end deffn

@ref{ec1,,patch()} as function decorator, creating the mock for you and passing it into
the decorated function:

@example
>>> @@patch('__main__.SomeClass')
... def function(normal_argument, mock_class):
...     print(mock_class is SomeClass)
...
>>> function(None)
True
@end example

Patching a class replaces the class with a @ref{ebe,,MagicMock} `instance'. If the
class is instantiated in the code under test then it will be the
@ref{42e4,,return_value} of the mock that will be used.

If the class is instantiated multiple times you could use
@ref{42dc,,side_effect} to return a new mock each time. Alternatively you
can set the `return_value' to be anything you want.

To configure return values on methods of `instances' on the patched class
you must do this on the @ref{42e4,,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

If you use `spec' or `spec_set' and @ref{ec1,,patch()} is replacing a `class', then the
return value of the created mock will have the same spec.

@example
>>> Original = Class
>>> patcher = patch('__main__.Class', spec=True)
>>> MockClass = patcher.start()
>>> instance = MockClass()
>>> assert isinstance(instance, Original)
>>> patcher.stop()
@end example

The `new_callable' argument is useful where you want to use an alternative
class to the default @ref{ebe,,MagicMock} for the created mock. For example, if
you wanted a @ref{42e1,,NonCallableMock} to be used:

@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

Another use case might be to replace an object with an @ref{f59,,io.StringIO} instance:

@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

When @ref{ec1,,patch()} is creating a mock for you, it is common that the first thing
you need to do is to configure the mock. Some of that configuration can be done
in the call to patch. Any arbitrary keywords you pass into the call will be
used to set attributes on the created mock:

@example
>>> patcher = patch('__main__.thing', first='one', second='two')
>>> mock_thing = patcher.start()
>>> mock_thing.first
'one'
>>> mock_thing.second
'two'
@end example

As well as attributes on the created mock attributes, like the
@ref{42e4,,return_value} and @ref{42dc,,side_effect}, of child mocks can
also be configured. These aren’t syntactically valid to pass in directly as
keyword arguments, but a dictionary with these as keys can still be expanded
into a @ref{ec1,,patch()} call using @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

By default, attempting to patch a function in a module (or a method or an
attribute in a class) that does not exist will fail with @ref{34b,,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

but adding @code{create=True} in the call to @ref{ec1,,patch()} will make the previous example
work as expected:

@example
>>> @@patch('sys.non_existing_attribute', 42, create=True)
... def test(mock_stdout):
...     assert sys.non_existing_attribute == 42
...
>>> test()
@end example


Alterado na versão 3.8: @ref{ec1,,patch()} now returns an @ref{a53,,AsyncMock} if the target is an async function.


@node patch object,patch dict,patch,Os criadores de patches
@anchor{library/unittest mock patch-object}@anchor{4309}
@subsubsection patch.object


@geindex patch.object() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch object}@anchor{167f}
@deffn {Função} patch.object (target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

patch the named member (`attribute') on an object (`target') with a mock
object.

@ref{167f,,patch.object()} can be used as a decorator, class decorator or a context
manager. Arguments `new', `spec', `create', `spec_set', `autospec' and
`new_callable' have the same meaning as for @ref{ec1,,patch()}. Like @ref{ec1,,patch()},
@ref{167f,,patch.object()} takes arbitrary keyword arguments for configuring the mock
object it creates.

When used as a class decorator @ref{167f,,patch.object()} honours @code{patch.TEST_PREFIX}
for choosing which methods to wrap.
@end deffn

You can either call @ref{167f,,patch.object()} with three arguments or two arguments. The
three argument form takes the object to be patched, the attribute name and the
object to replace the attribute with.

When calling with the two argument form you omit the replacement object, and a
mock is created for you and passed in as an extra argument to the decorated
function:

@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' and the other arguments to @ref{167f,,patch.object()} have the same
meaning as they do for @ref{ec1,,patch()}.

@node patch dict,patch multiple,patch object,Os criadores de patches
@anchor{library/unittest mock patch-dict}@anchor{430a}
@subsubsection patch.dict


@geindex patch.dict() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch dict}@anchor{1b6a}
@deffn {Função} 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.

`in_dict' can be a dictionary or a mapping like container. If it is a
mapping then it must at least support getting, setting and deleting items
plus iterating over keys.

`in_dict' can also be a string specifying the name of the dictionary, which
will then be fetched by importing it.

`values' can be a dictionary of values to set in the dictionary. `values'
can also be an iterable of @code{(key, value)} pairs.

If `clear' is true then the dictionary will be cleared before the new
values are set.

@ref{1b6a,,patch.dict()} can also be called with arbitrary keyword arguments to set
values in the dictionary.


Alterado na versão 3.8: @ref{1b6a,,patch.dict()} now returns the patched dictionary when used as a context
manager.

@end deffn

@ref{1b6a,,patch.dict()} can be used as a context manager, decorator or class
decorator:

@example
>>> foo = @{@}
>>> @@patch.dict(foo, @{'newkey': 'newvalue'@})
... def test():
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> test()
>>> assert foo == @{@}
@end example

When used as a class decorator @ref{1b6a,,patch.dict()} honours
@code{patch.TEST_PREFIX} (default to @code{'test'}) for choosing which methods to wrap:

@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

If you want to use a different prefix for your test, you can inform the
patchers of the different prefix by setting @code{patch.TEST_PREFIX}. For
more details about how to change the value of see @ref{430b,,TEST_PREFIX}.

@ref{1b6a,,patch.dict()} can be used to add members to a dictionary, or simply let a test
change a dictionary, and ensure the dictionary is restored when the test
ends.

@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

Keywords can be used in the @ref{1b6a,,patch.dict()} call to set values in the dictionary:

@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{1b6a,,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{283,,__getitem__()}, @ref{130e,,__setitem__()},
@ref{130f,,__delitem__()} and either @ref{1e4a,,__iter__()} or
@ref{1400,,__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 do patch start e stop,patch dict,Os criadores de patches
@anchor{library/unittest mock patch-multiple}@anchor{430c}
@subsubsection patch.multiple


@geindex patch.multiple() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch multiple}@anchor{430d}
@deffn {Função} patch.multiple (target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

Perform multiple patches in a single call. It takes the object to be
patched (either as an object or a string to fetch the object by importing)
and keyword arguments for the patches:

@example
with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...
@end example

Use @ref{42e3,,DEFAULT} as the value if you want @ref{430d,,patch.multiple()} to create
mocks for you. In this case the created mocks are passed into a decorated
function by keyword, and a dictionary is returned when @ref{430d,,patch.multiple()} is
used as a context manager.

@ref{430d,,patch.multiple()} can be used as a decorator, class decorator or a context
manager. The arguments `spec', `spec_set', `create', `autospec' and
`new_callable' have the same meaning as for @ref{ec1,,patch()}. These arguments will
be applied to `all' patches done by @ref{430d,,patch.multiple()}.

When used as a class decorator @ref{430d,,patch.multiple()} honours @code{patch.TEST_PREFIX}
for choosing which methods to wrap.
@end deffn

If you want @ref{430d,,patch.multiple()} to create mocks for you, then you can use
@ref{42e3,,DEFAULT} as the value. If you use @ref{430d,,patch.multiple()} as a decorator
then the created mocks are passed into the decorated function by keyword.

@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{430d,,patch.multiple()} can be nested with other @code{patch} decorators, but put arguments
passed by keyword `after' any of the standard arguments created by @ref{ec1,,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

If @ref{430d,,patch.multiple()} is used as a context manager, the value returned by the
context manager is a dictionary where created mocks are keyed by name:

@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 do patch start e stop,patch de embutidos,patch multiple,Os criadores de patches
@anchor{library/unittest mock patch-methods-start-and-stop}@anchor{430e}@anchor{library/unittest mock start-and-stop}@anchor{430f}
@subsubsection métodos do patch: `start' e `stop'


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{ec1,,patch()}, @ref{167f,,patch.object()} or @ref{1b6a,,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.

If you are using @ref{ec1,,patch()} to create a mock for you then it will be returned by
the call to @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{44f,,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 Cuidado 
If you use this technique you must ensure that the patching is “undone” by
calling @code{stop}. This can be fiddlier than you might think, because if an
exception is raised in the @code{setUp} then @code{tearDown} is not called.
@ref{a8b,,unittest.TestCase.addCleanup()} makes this easier:

@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

As an added bonus you no longer need to keep a reference to the @code{patcher}
object.
@end quotation
@end cartouche

It is also possible to stop all patches which have been started by using
@ref{4310,,patch.stopall()}.

@geindex patch.stopall() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock patch stopall}@anchor{4310}
@deffn {Função} patch.stopall ()

Stop all active patches. Only stops patches started with @code{start}.
@end deffn

@node patch de embutidos,TEST_PREFIX,métodos do patch start e stop,Os criadores de patches
@anchor{library/unittest mock id4}@anchor{4311}@anchor{library/unittest mock patch-builtins}@anchor{4312}
@subsubsection patch de embutidos


You can patch any builtins within a module. The following example patches
builtin @ref{2080,,ord()}:

@example
>>> @@patch('__main__.ord')
... def test(mock_ord):
...     mock_ord.return_value = 101
...     print(ord('c'))
...
>>> test()
101
@end example

@node TEST_PREFIX,Aninhando Decoradores Patch,patch de embutidos,Os criadores de patches
@anchor{library/unittest mock id5}@anchor{4313}@anchor{library/unittest mock test-prefix}@anchor{430b}
@subsubsection TEST_PREFIX


All of the patchers can be used as class decorators. When used in this way
they wrap every test method on the class. The patchers recognise methods that
start with @code{'test'} as being test methods. This is the same way that the
@ref{28e,,unittest.TestLoader} finds test methods by default.

It is possible that you want to use a different prefix for your tests. You can
inform the patchers of the different prefix by setting @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 Aninhando Decoradores Patch,Onde fazer patch,TEST_PREFIX,Os criadores de patches
@anchor{library/unittest mock nesting-patch-decorators}@anchor{4314}
@subsubsection Aninhando Decoradores Patch


If you want to perform multiple patches then you can simply stack up the
decorators.

You can stack up multiple patch decorators using this pattern:

@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

Note that the decorators are applied from the bottom upwards. This is the
standard way that Python applies decorators. The order of the created mocks
passed into your test function matches this order.

@node Onde fazer patch,Patching Descriptors and Proxy Objects,Aninhando Decoradores Patch,Os criadores de patches
@anchor{library/unittest mock id6}@anchor{4308}@anchor{library/unittest mock where-to-patch}@anchor{42dd}
@subsubsection Onde fazer patch


@ref{ec1,,patch()} works by (temporarily) changing the object that a `name' points to with
another one. There can be many names pointing to any individual object, so
for patching to work you must ensure that you patch the name used by the system
under test.

The basic principle is that you patch where an object is `looked up', which
is not necessarily the same place as where it is defined. A couple of
examples will help to clarify this.

Imagine we have a project that we want to test with the following structure:

@example
a.py
    -> Defines SomeClass

b.py
    -> from a import SomeClass
    -> some_function instantiates SomeClass
@end example

Now we want to test @code{some_function} but we want to mock out @code{SomeClass} using
@ref{ec1,,patch()}. The problem is that when we import module b, which we will have to
do when it imports @code{SomeClass} from module a. If we use @ref{ec1,,patch()} to mock out
@code{a.SomeClass} then it will have no effect on our test; module b already has a
reference to the `real' @code{SomeClass} and it looks like our patching had no
effect.

The key is to patch out @code{SomeClass} where it is used (or where it is looked up).
In this case @code{some_function} will actually look up @code{SomeClass} in module b,
where we have imported it. The patching should look like:

@example
@@patch('b.SomeClass')
@end example

However, consider the alternative scenario where instead of @code{from a import
SomeClass} module b does @code{import a} and @code{some_function} uses @code{a.SomeClass}. Both
of these import forms are common. In this case the class we want to patch is
being looked up in the module and so we have to patch @code{a.SomeClass} instead:

@example
@@patch('a.SomeClass')
@end example

@node Patching Descriptors and Proxy Objects,,Onde fazer patch,Os criadores de patches
@anchor{library/unittest mock patching-descriptors-and-proxy-objects}@anchor{4315}
@subsubsection Patching Descriptors and Proxy Objects


Both @ref{4307,,patch} and @ref{4309,,patch.object} correctly patch and restore descriptors: class
methods, static methods and properties. You should patch these on the `class'
rather than an instance. They also work with `some' objects
that proxy attribute access, like the 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 and magic method support,Ajudantes,Os criadores de patches,unittest mock — mock object library
@anchor{library/unittest mock magicmock-and-magic-method-support}@anchor{4316}
@subsubsection MagicMock and magic method support


@menu
* Simulando Métodos Mágicos:: 
* Magic Mock:: 

@end menu

@node Simulando Métodos Mágicos,Magic Mock,,MagicMock and magic method support
@anchor{library/unittest mock magic-methods}@anchor{42de}@anchor{library/unittest mock mocking-magic-methods}@anchor{4317}
@subsubsection Simulando Métodos Mágicos


@ref{a54,,Mock} supports mocking the Python protocol methods, also known as
@ref{4318,,“magic methods”}. This allows mock objects to replace
containers or other objects that implement Python protocols.

Because magic methods are looked up differently from normal methods @footnote{
Magic methods `should' be looked up on the class rather than the
instance. Different versions of Python are inconsistent about applying this
rule. The supported protocol methods should work with all supported versions
of Python.
}, this
support has been specially implemented. This means that only specific magic
methods are supported. The supported list includes `almost' all of them. If
there are any missing that you need please let us know.

You mock magic methods by setting the method you are interested in to a function
or a mock instance. If you are using a function then it `must' take @code{self} as
the first argument @footnote{
The function is basically hooked up to the class, but each @code{Mock}
instance is kept isolated from the others.
}.

@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

One use case for this is for mocking objects used as context managers in a
@ref{5d2,,with} statement:

@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

Calls to magic methods do not appear in @ref{42ea,,method_calls}, but they
are recorded in @ref{42e8,,mock_calls}.

@cartouche
@quotation Nota 
If you use the `spec' keyword argument to create a mock then attempting to
set a magic method that isn’t in the spec will raise an @ref{34b,,AttributeError}.
@end quotation
@end cartouche

A lista completa de métodos mágicos compatíveis é:


@itemize *

@item 
@code{__hash__}, @code{__sizeof__}, @code{__repr__} e @code{__str__}

@item 
@code{__dir__}, @code{__format__} e @code{__subclasses__}

@item 
@code{__round__}, @code{__floor__}, @code{__trunc__} e @code{__ceil__}

@item 
Comparações: @code{__lt__}, @code{__gt__}, @code{__le__}, @code{__ge__}, @code{__eq__} e @code{__ne__}

@item 
Container methods: @code{__getitem__}, @code{__setitem__}, @code{__delitem__},
@code{__contains__}, @code{__len__}, @code{__iter__}, @code{__reversed__}
and @code{__missing__}

@item 
Gerenciador de contexto: @code{__enter__}, @code{__exit__}, @code{__aenter__} e @code{__aexit__}

@item 
Métodos numéricos unários: @code{__neg__}, @code{__pos__} e @code{__invert__}

@item 
The numeric methods (including right hand and in-place variants):
@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__}, and @code{__pow__}

@item 
Métodos de conversão numérica: @code{__complex__}, @code{__int__}, @code{__float__} e @code{__index__}

@item 
Métodos descritores: @code{__get__}, @code{__set__} e @code{__delete__}

@item 
Pickling: @code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} e @code{__setstate__}

@item 
File system path representation: @code{__fspath__}

@item 
Métodos de iteração assíncrona: @code{__aiter__} e @code{__anext__}
@end itemize


Alterado na versão 3.8: Adicionado suporte para @ref{c6d,,os.PathLike.__fspath__()}.



Alterado na versão 3.8: Adicionado suporte para @code{__aenter__}, @code{__aexit__}, @code{__aiter__} e @code{__anext__}.


The following methods exist but are `not' supported as they are either in use
by mock, can’t be set dynamically, or can cause problems:


@itemize *

@item 
@code{__getattr__}, @code{__setattr__}, @code{__init__} e @code{__new__}

@item 
@code{__prepare__}, @code{__instancecheck__}, @code{__subclasscheck__}, @code{__del__}
@end itemize

@node Magic Mock,,Simulando Métodos Mágicos,MagicMock and magic method support
@anchor{library/unittest mock magic-mock}@anchor{4319}
@subsubsection Magic Mock


Existem duas variantes de @code{MagicMock}: @ref{ebe,,MagicMock} e @ref{42e2,,NonCallableMagicMock}.

@geindex MagicMock (classe em unittest.mock)
@anchor{library/unittest mock unittest mock MagicMock}@anchor{ebe}
@deffn {Classe} unittest.mock.MagicMock (*args, **kw)

@code{MagicMock} is a subclass of @ref{a54,,Mock} with default implementations
of most of the @ref{4318,,magic methods}. You can use
@code{MagicMock} without having to configure the magic methods yourself.

The constructor parameters have the same meaning as for @ref{a54,,Mock}.

If you use the `spec' or `spec_set' arguments then `only' magic methods
that exist in the spec will be created.
@end deffn

@geindex NonCallableMagicMock (classe em unittest.mock)
@anchor{library/unittest mock unittest mock NonCallableMagicMock}@anchor{42e2}
@deffn {Classe} unittest.mock.NonCallableMagicMock (*args, **kw)

Uma versão não-chamável de @ref{ebe,,MagicMock}.

The constructor parameters have the same meaning as for
@ref{ebe,,MagicMock}, with the exception of `return_value' and
`side_effect' which have no meaning on a non-callable mock.
@end deffn

The magic methods are setup with @ref{ebe,,MagicMock} objects, so you can configure them
and use them in the usual way:

@example
>>> mock = MagicMock()
>>> mock[3] = 'fish'
>>> mock.__setitem__.assert_called_with(3, 'fish')
>>> mock.__getitem__.return_value = 'result'
>>> mock[2]
'result'
@end example

By default many of the protocol methods are required to return objects of a
specific type. These methods are preconfigured with a default return value, so
that they can be used without you having to do anything if you aren’t interested
in the return value. You can still `set' the return value manually if you want
to change the default.

Métodos e seus padrões:


@itemize *

@item 
@code{__lt__}: @ref{7d3,,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 padrão para o mock

@item 
@code{__str__}: `str' padrão para o mock

@item 
@code{__sizeof__}: `sizeof' padrão para o mock
@end itemize

Por exemplo:

@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{42dc,,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

The return value of @code{MagicMock.__iter__()} can be any iterable object and isn’t
required to be an iterator:

@example
>>> mock = MagicMock()
>>> mock.__iter__.return_value = ['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
@end example

If the return value `is' an iterator, then iterating over it once will consume
it and subsequent iterations will result in an empty list:

@example
>>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
[]
@end example

@code{MagicMock} has all of the supported magic methods configured except for some
of the obscure and obsolete ones. You can still set these up if you want.

Magic methods that are supported but not setup by default in @code{MagicMock} are:


@itemize *

@item 
@code{__subclasses__}

@item 
@code{__dir__}

@item 
@code{__format__}

@item 
@code{__get__}, @code{__set__} e @code{__delete__}

@item 
@code{__reversed__} e @code{__missing__}

@item 
@code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} e @code{__setstate__}

@item 
@code{__getformat__}
@end itemize

@node Ajudantes,Order of precedence of side_effect return_value and wraps,MagicMock and magic method support,unittest mock — mock object library
@anchor{library/unittest mock helpers}@anchor{431a}
@subsubsection Ajudantes


@menu
* sentinel:: 
* DEFAULT:: 
* chamada:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* Especificação automática:: 
* Vedando mocks:: 

@end menu

@node sentinel,DEFAULT,,Ajudantes
@anchor{library/unittest mock sentinel}@anchor{431b}
@subsubsection sentinel


@geindex sentinel (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock sentinel}@anchor{bb8}
@deffn {Dado} unittest.mock.sentinel

The @code{sentinel} object provides a convenient way of providing unique
objects for your tests.

Attributes are created on demand when you access them by name. Accessing
the same attribute will always return the same object. The objects
returned have a sensible repr so that test failure messages are readable.


Alterado na versão 3.7: The @code{sentinel} attributes now preserve their identity when they are
@ref{25,,copied} or @ref{a6,,pickled}.

@end deffn

Sometimes when testing you need to test that a specific object is passed as an
argument to another method, or returned. It can be common to create named
sentinel objects to test this. @ref{bb8,,sentinel} provides a convenient way of
creating and testing the identity of objects like this.

In this example we monkey patch @code{method} to return @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,chamada,sentinel,Ajudantes
@anchor{library/unittest mock default}@anchor{431c}
@subsubsection DEFAULT


@geindex DEFAULT (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock DEFAULT}@anchor{42e3}
@deffn {Dado} unittest.mock.DEFAULT

The @ref{42e3,,DEFAULT} object is a pre-created sentinel (actually
@code{sentinel.DEFAULT}). It can be used by @ref{42dc,,side_effect}
functions to indicate that the normal return value should be used.
@end deffn

@node chamada,create_autospec,DEFAULT,Ajudantes
@anchor{library/unittest mock call}@anchor{431d}
@subsubsection chamada


@geindex call() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock call}@anchor{1b45}
@deffn {Função} unittest.mock.call (*args, **kwargs)

@ref{1b45,,call()} is a helper object for making simpler assertions, for comparing with
@ref{1af8,,call_args}, @ref{42ef,,call_args_list},
@ref{42e8,,mock_calls} and @ref{42ea,,method_calls}. @ref{1b45,,call()} can also be
used with @ref{179d,,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 unittest.mock.call)
@anchor{library/unittest mock unittest mock call call_list}@anchor{431e}
@deffn {Método} call.call_list ()

For a call object that represents multiple calls, @ref{431e,,call_list()}
returns a list of all the intermediate calls as well as the
final call.
@end deffn

@code{call_list} is particularly useful for making assertions on “chained calls”. A
chained call is multiple calls on a single line of code. This results in
multiple entries in @ref{42e8,,mock_calls} on a mock. Manually constructing
the sequence of calls can be tedious.

@ref{431e,,call_list()} can construct the sequence of calls from the same
chained call:

@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{42f0}
A @code{call} object is either a tuple of (positional args, keyword args) or
(name, positional args, keyword args) depending on how it was constructed. When
you construct them yourself this isn’t particularly interesting, but the @code{call}
objects that are in the @ref{1af8,,Mock.call_args}, @ref{42ef,,Mock.call_args_list} and
@ref{42e8,,Mock.mock_calls} attributes can be introspected to get at the individual
arguments they contain.

The @code{call} objects in @ref{1af8,,Mock.call_args} and @ref{42ef,,Mock.call_args_list}
are two-tuples of (positional args, keyword args) whereas the @code{call} objects
in @ref{42e8,,Mock.mock_calls}, along with ones you construct yourself, are
three-tuples of (name, positional args, keyword args).

You can use their “tupleness” to pull out the individual arguments for more
complex introspection and assertions. The positional arguments are a tuple
(an empty tuple if there are no positional arguments) and the keyword
arguments are a dictionary:

@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,chamada,Ajudantes
@anchor{library/unittest mock create-autospec}@anchor{431f}
@subsubsection create_autospec


@geindex create_autospec() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock create_autospec}@anchor{16f4}
@deffn {Função} unittest.mock.create_autospec (spec, spec_set=False, instance=False, **kwargs)

Create a mock object using another object as a spec. Attributes on the
mock will use the corresponding attribute on the `spec' object as their
spec.

Functions or methods being mocked will have their arguments checked to
ensure that they are called with the correct signature.

If `spec_set' is @code{True} then attempting to set attributes that don’t exist
on the spec object will raise an @ref{34b,,AttributeError}.

If a class is used as a spec then the return value of the mock (the
instance of the class) will have the same spec. You can use a class as the
spec for an instance object by passing @code{instance=True}. The returned mock
will only be callable if instances of the mock are callable.

@ref{16f4,,create_autospec()} also takes arbitrary keyword arguments that are passed to
the constructor of the created mock.
@end deffn

See @ref{42df,,Especificação automática} for examples of how to use auto-speccing with
@ref{16f4,,create_autospec()} and the `autospec' argument to @ref{ec1,,patch()}.


Alterado na versão 3.8: @ref{16f4,,create_autospec()} now returns an @ref{a53,,AsyncMock} if the target is
an async function.


@node ANY,FILTER_DIR,create_autospec,Ajudantes
@anchor{library/unittest mock any}@anchor{4320}
@subsubsection ANY


@geindex ANY (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock ANY}@anchor{1b43}
@deffn {Dado} unittest.mock.ANY
@end deffn

Sometimes you may need to make assertions about `some' of the arguments in a
call to mock, but either not care about some of the arguments or want to pull
them individually out of @ref{1af8,,call_args} and make more complex
assertions on them.

To ignore certain arguments you can pass in objects that compare equal to
`everything'. Calls to @ref{1b99,,assert_called_with()} and
@ref{42e6,,assert_called_once_with()} will then succeed no matter what was
passed in.

@example
>>> mock = Mock(return_value=None)
>>> mock('foo', bar=object())
>>> mock.assert_called_once_with('foo', bar=ANY)
@end example

@ref{1b43,,ANY} can also be used in comparisons with call lists like
@ref{42e8,,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{1b43,,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,Ajudantes
@anchor{library/unittest mock filter-dir}@anchor{4321}
@subsubsection FILTER_DIR


@geindex FILTER_DIR (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock FILTER_DIR}@anchor{42ec}
@deffn {Dado} unittest.mock.FILTER_DIR
@end deffn

@ref{42ec,,FILTER_DIR} is a module level variable that controls the way mock objects
respond to @ref{632,,dir()}. The default is @code{True},
which uses the filtering described below, to only show useful members. If you
dislike this filtering, or need to switch it off for diagnostic purposes, then
set @code{mock.FILTER_DIR = False}.

With filtering on, @code{dir(some_mock)} shows only useful attributes and will
include any dynamically created attributes that wouldn’t normally be shown.
If the mock was created with a `spec' (or `autospec' of course) then all the
attributes from the original are shown, even if they haven’t been accessed
yet:

@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

Many of the not-very-useful (private to @ref{a54,,Mock} rather than the thing being
mocked) underscore and double underscore prefixed attributes have been
filtered from the result of calling @ref{632,,dir()} on a @ref{a54,,Mock}. If you dislike this
behaviour you can switch it off by setting the module level switch
@ref{42ec,,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{42ec,,FILTER_DIR}.

@node mock_open,Especificação automática,FILTER_DIR,Ajudantes
@anchor{library/unittest mock mock-open}@anchor{4322}
@subsubsection mock_open


@geindex mock_open() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock mock_open}@anchor{101d}
@deffn {Função} unittest.mock.mock_open (mock=None, read_data=None)

A helper function to create a mock to replace the use of @ref{51c,,open()}. It works
for @ref{51c,,open()} called directly or used as a context manager.

The `mock' argument is the mock object to configure. If @code{None} (the
default) then a @ref{ebe,,MagicMock} will be created for you, with the API limited
to methods or attributes available on standard file handles.

`read_data' is a string for the @ref{e48,,read()},
@ref{241f,,readline()}, and @ref{24c7,,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.


Alterado na versão 3.4: Added @ref{241f,,readline()} and @ref{24c7,,readlines()} support.
The mock of @ref{e48,,read()} changed to consume `read_data' rather
than returning it on each call.



Alterado na versão 3.5: `read_data' is now reset on each call to the `mock'.



Alterado na versão 3.8: Added @ref{1e4a,,__iter__()} to implementation so that iteration
(such as in for loops) correctly consumes `read_data'.

@end deffn

Using @ref{51c,,open()} as a context manager is a great way to ensure your file handles
are closed properly and is becoming common:

@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{51c,,open()} it is the
`returned object' that is used as a context manager (and has @ref{5c8,,__enter__()} and
@ref{1344,,__exit__()} called).

Mocking context managers with a @ref{ebe,,MagicMock} is common enough and fiddly
enough that a helper function is useful.

@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

E para ler arquivos:

@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 Especificação automática,Vedando mocks,mock_open,Ajudantes
@anchor{library/unittest mock auto-speccing}@anchor{42df}@anchor{library/unittest mock autospeccing}@anchor{4323}
@subsubsection Especificação automática


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{2c3,,TypeError} if they are
called incorrectly.

Before I explain how auto-speccing works, here’s why it is needed.

@ref{a54,,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.


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


Note that this is another reason why you need integration tests as well as
unit tests. Testing everything in isolation is all fine and dandy, but if you
don’t test how your units are “wired together” there is still lots of room
for bugs that tests might have caught.

@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

The spec only applies to the mock itself, so we still have the same issue
with any methods on the mock:

@example
>>> mock.header_items()
<mock.Mock object at 0x...>
>>> mock.header_items.assret_called_with()  # Intentional typo!
@end example

Auto-speccing solves this problem. You can either pass @code{autospec=True} to
@ref{ec1,,patch()} / @ref{167f,,patch.object()} or use the @ref{16f4,,create_autospec()} function to create a
mock with a spec. If you use the @code{autospec=True} argument to @ref{ec1,,patch()} then the
object that is being replaced will be used as the spec object. Because the
speccing is done “lazily” (the spec is created as attributes on the mock are
accessed) you can use it with very complex or deeply nested objects (like
modules that import modules that import modules) without a big performance
hit.

Aqui está um exemplo disso em uso:

@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

The spec also applies to instantiated classes (i.e. the return value of
specced mocks):

@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

In many cases you will just be able to add @code{autospec=True} to your existing
@ref{ec1,,patch()} calls and then be protected against bugs due to typos and api
changes.

As well as using `autospec' through @ref{ec1,,patch()} there is a
@ref{16f4,,create_autospec()} for creating autospecced mocks directly:

@example
>>> from urllib import request
>>> mock_request = create_autospec(request)
>>> mock_request.Request('foo', 'bar')
<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>
@end example

This isn’t without caveats and limitations however, which is why it is not
the default behaviour. In order to know what attributes are available on the
spec object, autospec has to introspect (access attributes) the spec. As you
traverse attributes on the mock a corresponding traversal of the original
object is happening under the hood. If any of your specced objects have
properties or descriptors that can trigger code execution then you may not be
able to use autospec. On the other hand it is much better to design your
objects so that introspection is safe @footnote{
This only applies to classes or already instantiated objects. Calling
a mocked class to create a mock instance `does not' create a real instance.
It is only attribute lookups - along with calls to @ref{632,,dir()} - that are done.
}.

A more serious problem is that it is common for instance attributes to be
created in the @ref{6b0,,__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

There are a few different ways of resolving this problem. The easiest, but
not necessarily the least annoying, way is to simply set the required
attributes on the mock after creation. Just because `autospec' doesn’t allow
you to fetch attributes that don’t exist on the spec it doesn’t prevent you
setting them:

@example
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a = 33
...
@end example

There is a more aggressive version of both `spec' and `autospec' that `does'
prevent you setting non-existent attributes. This is useful if you want to
ensure your code only `sets' valid attributes too, but obviously it prevents
this particular scenario:

@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{6b0,,__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

This brings up another issue. It is relatively common to provide a default
value of @code{None} for members that will later be an object of a different type.
@code{None} would be useless as a spec because it wouldn’t let you access `any'
attributes or methods on it. As @code{None} is `never' going to be useful as a
spec, and probably indicates a member that will normally of some other type,
autospec doesn’t use a spec for members that are set to @code{None}. These will
just be ordinary mocks (well - MagicMocks):

@example
>>> class Something:
...     member = None
...
>>> mock = create_autospec(Something)
>>> mock.member.foo.bar.baz()
<MagicMock name='mock.member.foo.bar.baz()' id='...'>
@end example

If modifying your production classes to add defaults isn’t to your liking
then there are more options. One of these is simply to use an instance as the
spec rather than the class. The other is to create a subclass of the
production class and add the defaults to the subclass without affecting the
production class. Both of these require you to use an alternative object as
the spec. Thankfully @ref{ec1,,patch()} supports this - you can simply pass the
alternative object as the `autospec' argument:

@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 Vedando mocks,,Especificação automática,Ajudantes
@anchor{library/unittest mock sealing-mocks}@anchor{4324}
@subsubsection Vedando mocks


@c from unittest.mock import seal

@geindex seal() (no módulo unittest.mock)
@anchor{library/unittest mock unittest mock seal}@anchor{bb9}
@deffn {Função} unittest.mock.seal (mock)

Seal will disable the automatic creation of mocks when accessing an attribute of
the mock being sealed or any of its attributes that are already mocks recursively.

If a mock instance with a name or a spec is assigned to an attribute
it won’t be considered in the sealing chain. This allows one to prevent seal from
fixing part of the mock object.

@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


Adicionado na versão 3.7.

@end deffn

@node Order of precedence of side_effect return_value and wraps,,Ajudantes,unittest mock — mock object library
@anchor{library/unittest mock order-of-precedence-of-side-effect-return-value-and-wraps}@anchor{4325}
@subsubsection Order of precedence of @code{side_effect}, @code{return_value} and `wraps'


The order of their precedence is:


@enumerate 

@item 
@ref{42dc,,side_effect}

@item 
@ref{42e4,,return_value}

@item 
`wraps'
@end enumerate

If all three are set, mock will return the value from @ref{42dc,,side_effect},
ignoring @ref{42e4,,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{42dc,,side_effect}, if you reassign
its value back to @code{None}, the order of precedence will be checked between
@ref{42e4,,return_value} and the wrapped object, ignoring
@ref{42dc,,side_effect}.

@example
>>> order_mock.get_value.side_effect = None
>>> order_mock.get_value()
'second'
@end example

If the value being returned by @ref{42dc,,side_effect} is @ref{42e3,,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{a54,,Mock} wraps an object, the default value of
@ref{42e4,,return_value} will be @ref{42e3,,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{42dc,,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 — primeiros passos,test — Pacote de Testes de Regressão do Python,unittest mock — mock object library,Ferramentas de Desenvolvimento
@anchor{library/unittest mock-examples doc}@anchor{4326}@anchor{library/unittest mock-examples translation-repo}@anchor{4327}@anchor{library/unittest mock-examples unittest-mock-getting-started}@anchor{4328}
@subsection @code{unittest.mock} — primeiros passos



Adicionado na versão 3.3.

@anchor{library/unittest mock-examples getting-started}@anchor{4329}
@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:: 
* Patch Decorators:: 
* Further Examples:: 

@end menu

@node Usando Mock,Patch Decorators,,unittest mock — primeiros passos
@anchor{library/unittest mock-examples using-mock}@anchor{432a}
@subsubsection Usando Mock


@menu
* Métodos de aplicação de patches em Mock:: 
* Mock de chamadas de métodos em um objeto:: 
* Mocking Classes:: 
* Nomeando os mocks:: 
* Rastreando todas as chamadas:: 
* Setting Return Values and Attributes:: 
* Raising exceptions with mocks:: 
* Side effect functions and iterables:: 
* Mocking asynchronous iterators:: 
* Mocking asynchronous context manager:: 
* Creating a Mock from an Existing Object:: 
* Using side_effect to return per file content:: 

@end menu

@node Métodos de aplicação de patches em Mock,Mock de chamadas de métodos em um objeto,,Usando Mock
@anchor{library/unittest mock-examples mock-patching-methods}@anchor{432b}
@subsubsection Métodos de aplicação de patches em Mock


Usos comuns para objetos @ref{a54,,Mock} incluem:


@itemize *

@item 
Métodos de aplicação de patches

@item 
Método de gravação que invoca objetos
@end itemize

Talvez você queira substituir um método em um objeto para verificar se ele foi chamado com os argumentos corretos por outra parte do sistema:

@example
>>> real = SomeClass()
>>> real.method = MagicMock(name='method')
>>> real.method(3, 4, 5, key='value')
<MagicMock name='method()' id='...'>
@end example

Depois que nosso mock for usado (@code{real.method} neste exemplo), ele terá métodos e atributos que permitem que você faça afirmações sobre como ele foi usado.

@cartouche
@quotation Nota 
Na maioria desses exemplos, as classes @ref{a54,,Mock} e @ref{ebe,,MagicMock} são intercambiáveis. Como a @code{MagicMock} é a classe mais capaz, ela faz sentido para ser usada por padrão.
@end quotation
@end cartouche

Uma vez que o mock foi chamado, seu atributo @ref{42ee,,called} é definido como @code{True}. Mais importante, podemos usar o método @ref{1b99,,assert_called_with()} ou @ref{42e6,,assert_called_once_with()} para verificar se ele foi chamado com os argumentos corretos.

Este exemplo testa se a chamada de @code{ProductionClass().method} resulta em uma chamada para o 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 chamadas de métodos em um objeto,Mocking Classes,Métodos de aplicação de patches em Mock,Usando Mock
@anchor{library/unittest mock-examples mock-for-method-calls-on-an-object}@anchor{432c}
@subsubsection Mock de chamadas de métodos em um objeto


No último exemplo, aplicamos um patch em um método diretamente em um objeto para verificar se ele foi chamado corretamente. Outro caso de uso comum é passar um objeto para um método (ou alguma parte do sistema em teste) e então verificar se ele é usado da maneira correta.

O @code{ProductionClass} simples abaixo tem um método @code{closer}. Se ele for chamado com um objeto, então ele chama @code{close} nele.

@example
>>> class ProductionClass:
...     def closer(self, something):
...         something.close()
...
@end example

Então, para testá-lo, precisamos passar um objeto com um método @code{close} e verificar se ele foi chamado corretamente.

@example
>>> real = ProductionClass()
>>> mock = Mock()
>>> real.closer(mock)
>>> mock.close.assert_called_with()
@end example

Não precisamos fazer nenhum trabalho para fornecer o método ‘close’ em nosso mock. Acessar close o cria. Então, se ‘close’ ainda não foi chamado, acessá-lo no teste o criará, mas @ref{1b99,,assert_called_with()} levantará uma exceção de falha.

@node Mocking Classes,Nomeando os mocks,Mock de chamadas de métodos em um objeto,Usando Mock
@anchor{library/unittest mock-examples mocking-classes}@anchor{432d}
@subsubsection Mocking Classes


A common use case is to mock out classes instantiated by your code under test.
When you patch a class, then that class is replaced with a mock. Instances
are created by `calling the class'. This means you access the “mock instance”
by looking at the return value of the mocked class.

In the example below we have a function @code{some_function} that instantiates @code{Foo}
and calls a method on it. The call to @ref{ec1,,patch()} replaces the class @code{Foo} with a
mock. The @code{Foo} instance is the result of calling the mock, so it is configured
by modifying the mock @ref{42e4,,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 Nomeando os mocks,Rastreando todas as chamadas,Mocking Classes,Usando Mock
@anchor{library/unittest mock-examples naming-your-mocks}@anchor{432e}
@subsubsection Nomeando os mocks


It can be useful to give your mocks a name. The name is shown in the repr of
the mock and can be helpful when the mock appears in test failure messages. The
name is also propagated to attributes or methods of the mock:

@example
>>> mock = MagicMock(name='foo')
>>> mock
<MagicMock name='foo' id='...'>
>>> mock.method
<MagicMock name='foo.method' id='...'>
@end example

@node Rastreando todas as chamadas,Setting Return Values and Attributes,Nomeando os mocks,Usando Mock
@anchor{library/unittest mock-examples tracking-all-calls}@anchor{432f}
@subsubsection Rastreando todas as chamadas


Frequentemente você quer rastrear mais de uma chamada para um método. O atributo @ref{42e8,,mock_calls} registra todas as chamadas para atributos filhos do mock - e também para seus filhos.

@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

If you make an assertion about @code{mock_calls} and any unexpected methods
have been called, then the assertion will fail. This is useful because as well
as asserting that the calls you expected have been made, you are also checking
that they were made in the right order and with no additional calls:

You use the @ref{1b45,,call} object to construct lists for comparing with
@code{mock_calls}:

@example
>>> expected = [call.method(), call.attribute.method(10, x=53)]
>>> mock.mock_calls == expected
True
@end example

However, parameters to calls that return mocks are not recorded, which means it is not
possible to track nested calls where the parameters used to create ancestors are important:

@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 Setting Return Values and Attributes,Raising exceptions with mocks,Rastreando todas as chamadas,Usando Mock
@anchor{library/unittest mock-examples setting-return-values-and-attributes}@anchor{4330}
@subsubsection Setting Return Values and Attributes


Setting the return values on a mock object is trivially easy:

@example
>>> mock = Mock()
>>> mock.return_value = 3
>>> mock()
3
@end example

Of course you can do the same for methods on the mock:

@example
>>> mock = Mock()
>>> mock.method.return_value = 3
>>> mock.method()
3
@end example

The return value can also be set in the constructor:

@example
>>> mock = Mock(return_value=3)
>>> mock()
3
@end example

If you need an attribute setting on your mock, just do it:

@example
>>> mock = Mock()
>>> mock.x = 3
>>> mock.x
3
@end example

Sometimes you want to mock up a more complex situation, like for example
@code{mock.connection.cursor().execute("SELECT 1")}. If we wanted this call to
return a list, then we have to configure the result of the nested call.

We can use @ref{1b45,,call} to construct the set of calls in a “chained call” like
this for easy assertion afterwards:

@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

It is the call to @code{.call_list()} that turns our call object into a list of
calls representing the chained calls.

@node Raising exceptions with mocks,Side effect functions and iterables,Setting Return Values and Attributes,Usando Mock
@anchor{library/unittest mock-examples raising-exceptions-with-mocks}@anchor{4331}
@subsubsection Raising exceptions with mocks


A useful attribute is @ref{42dc,,side_effect}. If you set this to an
exception class or instance then the exception will be raised when the mock
is called.

@example
>>> mock = Mock(side_effect=Exception('Boom!'))
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

@node Side effect functions and iterables,Mocking asynchronous iterators,Raising exceptions with mocks,Usando Mock
@anchor{library/unittest mock-examples side-effect-functions-and-iterables}@anchor{4332}
@subsubsection Side effect functions and iterables


@code{side_effect} can also be set to a function or an iterable. The use case for
@code{side_effect} as an iterable is where your mock is going to be called several
times, and you want each call to return a different value. When you set
@code{side_effect} to an iterable every call to the mock returns the next value
from the iterable:

@example
>>> mock = MagicMock(side_effect=[4, 5, 6])
>>> mock()
4
>>> mock()
5
>>> mock()
6
@end example

For more advanced use cases, like dynamically varying the return values
depending on what the mock is called with, @code{side_effect} can be a function.
The function will be called with the same arguments as the mock. Whatever the
function returns is what the call returns:

@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 Mocking asynchronous iterators,Mocking asynchronous context manager,Side effect functions and iterables,Usando Mock
@anchor{library/unittest mock-examples mocking-asynchronous-iterators}@anchor{4333}
@subsubsection Mocking asynchronous iterators


Since Python 3.8, @code{AsyncMock} and @code{MagicMock} have support to mock
@ref{d9f,,Iteradores assíncronos} through @code{__aiter__}. The @ref{42e4,,return_value}
attribute of @code{__aiter__} can be used to set the return values to be used for
iteration.

@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 Mocking asynchronous context manager,Creating a Mock from an Existing Object,Mocking asynchronous iterators,Usando Mock
@anchor{library/unittest mock-examples mocking-asynchronous-context-manager}@anchor{4334}
@subsubsection Mocking asynchronous context manager


Since Python 3.8, @code{AsyncMock} and @code{MagicMock} have support to mock
@ref{5fc,,Gerenciadores de contexto assíncronos} through @code{__aenter__} and @code{__aexit__}.
By default, @code{__aenter__} and @code{__aexit__} are @code{AsyncMock} instances that
return an async function.

@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 Creating a Mock from an Existing Object,Using side_effect to return per file content,Mocking asynchronous context manager,Usando Mock
@anchor{library/unittest mock-examples creating-a-mock-from-an-existing-object}@anchor{4335}
@subsubsection Creating a Mock from an Existing Object


One problem with over use of mocking is that it couples your tests to the
implementation of your mocks rather than your real code. Suppose you have a
class that implements @code{some_method}. In a test for another class, you
provide a mock of this object that `also' provides @code{some_method}. If later
you refactor the first class, so that it no longer has @code{some_method} - then
your tests will continue to pass even though your code is now broken!

@ref{a54,,Mock} allows you to provide an object as a specification for the mock,
using the `spec' keyword argument. Accessing methods / attributes on the
mock that don’t exist on your specification object will immediately raise an
attribute error. If you change the implementation of your specification, then
tests that use that class will start failing immediately without you having to
instantiate the class in those tests.

@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

Using a specification also enables a smarter matching of calls made to the
mock, regardless of whether some parameters were passed as positional or
named arguments:

@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

If you want this smarter matching to also work with method calls on the mock,
you can use @ref{42df,,auto-speccing}.

If you want a stronger form of specification that prevents the setting
of arbitrary attributes as well as the getting of them then you can use
`spec_set' instead of `spec'.

@node Using side_effect to return per file content,,Creating a Mock from an Existing Object,Usando Mock
@anchor{library/unittest mock-examples using-side-effect-to-return-per-file-content}@anchor{4336}
@subsubsection Using side_effect to return per file content


@ref{101d,,mock_open()} is used to patch @ref{51c,,open()} method. @ref{42dc,,side_effect}
can be used to return a new Mock object per call. This can be used to return different
contents per file stored in a dictionary:

@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 Patch Decorators,Further Examples,Usando Mock,unittest mock — primeiros passos
@anchor{library/unittest mock-examples patch-decorators}@anchor{4337}
@subsubsection Patch Decorators


@cartouche
@quotation Nota 
Com @ref{ec1,,patch()}, é importante que você faça o patch de objetos no espaço de nomes onde eles são procurados. Normalmente, isso é simples, mas para um guia rápido, leia @ref{42dd,,onde fazer o patch}.
@end quotation
@end cartouche

A common need in tests is to patch a class attribute or a module attribute,
for example patching a builtin or patching a class in a module to test that it
is instantiated. Modules and classes are effectively global, so patching on
them has to be undone after the test or the patch will persist into other
tests and cause hard to diagnose problems.

mock provides three convenient decorators for this: @ref{ec1,,patch()}, @ref{167f,,patch.object()} and
@ref{1b6a,,patch.dict()}. @code{patch} takes a single string, of the form
@code{package.module.Class.attribute} to specify the attribute you are patching. It
also optionally takes a value that you want the attribute (or class or
whatever) to be replaced with. ‘patch.object’ takes an object and the name of
the attribute you would like patched, plus optionally the value to patch it
with.

@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

If you are patching a module (including @ref{12,,builtins}) then use @ref{ec1,,patch()}
instead of @ref{167f,,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

The module name can be ‘dotted’, in the form @code{package.module} if needed:

@example
>>> @@patch('package.module.ClassName.attribute', sentinel.attribute)
... def test():
...     from package.module import ClassName
...     assert ClassName.attribute == sentinel.attribute
...
>>> test()
@end example

A nice pattern is to actually decorate test methods themselves:

@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

If you want to patch with a Mock, you can use @ref{ec1,,patch()} with only one argument
(or @ref{167f,,patch.object()} with two arguments). The mock will be created for you and
passed into the test function / method:

@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

You can stack up multiple patch decorators using this pattern:

@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

When you nest patch decorators the mocks are passed in to the decorated
function in the same order they applied (the normal `Python' order that
decorators are applied). This means from the bottom up, so in the example
above the mock for @code{test_module.ClassName2} is passed in first.

Também existe @ref{1b6a,,patch.dict()} para definir valores em um dicionário apenas durante um escopo e restaurar o dicionário ao seu estado original quando o teste termina:

@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} can all be used as context managers.

Where you use @ref{ec1,,patch()} to create a mock for you, you can get a reference to the
mock using the “as” form of the with statement:

@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

As an alternative @code{patch}, @code{patch.object} and @code{patch.dict} can be used as
class decorators. When used in this way it is the same as applying the
decorator individually to every method whose name starts with “test”.

@node Further Examples,,Patch Decorators,unittest mock — primeiros passos
@anchor{library/unittest mock-examples further-examples}@anchor{4338}@anchor{library/unittest mock-examples id1}@anchor{4339}
@subsubsection Further Examples


Here are some more examples for some slightly more advanced scenarios.

@menu
* Mocking chained calls:: 
* Partial mocking:: 
* Mocking a Generator Method:: 
* Applying the same patch to every test method:: 
* Mocking Unbound Methods:: 
* Checking multiple calls with mock:: 
* Coping with mutable arguments:: 
* Nesting Patches:: 
* Mocking a dictionary with MagicMock:: 
* Mock subclasses and their attributes:: 
* Mocking imports with patch.dict: Mocking imports with patch dict. 
* Tracking order of calls and less verbose call assertions:: 
* More complex argument matching:: 

@end menu

@node Mocking chained calls,Partial mocking,,Further Examples
@anchor{library/unittest mock-examples mocking-chained-calls}@anchor{433a}
@subsubsection Mocking chained calls


Mocking chained calls is actually straightforward with mock once you
understand the @ref{42e4,,return_value} attribute. When a mock is called for
the first time, or you fetch its @code{return_value} before it has been called, a
new @ref{a54,,Mock} is created.

This means that you can see how the object returned from a call to a mocked
object has been used by interrogating the @code{return_value} mock:

@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

From here it is a simple step to configure and then make assertions about
chained calls. Of course another alternative is writing your code in a more
testable way in the first place…

So, suppose we have some code that looks a little bit like this:

@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

Assuming that @code{BackendProvider} is already well tested, how do we test
@code{method()}? Specifically, we want to test that the code section @code{# more
code} uses the response object in the correct way.

As this chain of calls is made from an instance attribute we can monkey patch
the @code{backend} attribute on a @code{Something} instance. In this particular case
we are only interested in the return value from the final call to
@code{start_call} so we don’t have much configuration to do. Let’s assume the
object it returns is ‘file-like’, so we’ll ensure that our response object
uses the builtin @ref{51c,,open()} as its @code{spec}.

To do this we create a mock instance as our mock backend and create a mock
response object for it. To set the response as the return value for that final
@code{start_call} we could do this:

@example
mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response
@end example

We can do that in a slightly nicer way using the @ref{42e5,,configure_mock()}
method to directly set the return value for us:

@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

With these we monkey patch the “mock backend” in place and can make the real
call:

@example
>>> something.backend = mock_backend
>>> something.method()
@end example

Using @ref{42e8,,mock_calls} we can check the chained call with a single
assert. A chained call is several calls in one line of code, so there will be
several entries in @code{mock_calls}. We can use @ref{431e,,call.call_list()} to create
this list of calls for us:

@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 Partial mocking,Mocking a Generator Method,Mocking chained calls,Further Examples
@anchor{library/unittest mock-examples partial-mocking}@anchor{433b}
@subsubsection Partial mocking


For some tests, you may want to mock out a call to @ref{1512,,datetime.date.today()}
to return a known date, but don’t want to prevent the code under test from
creating new date objects. Unfortunately @ref{1cd,,datetime.date} is written in C,
so you cannot just monkey-patch out the static @ref{1512,,datetime.date.today()} method.

Instead, you can effectively wrap the date
class with a mock, while passing through calls to the constructor to the real
class (and returning real instances).

The @ref{ec1,,patch decorator} is used here to
mock out the @code{date} class in the module under test. The @ref{42dc,,side_effect}
attribute on the mock date class is then set to a lambda function that returns
a real date. When the mock date class is called a real date will be
constructed and returned by @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

Note that we don’t patch @ref{1cd,,datetime.date} globally, we patch @code{date} in the
module that `uses' it. See @ref{42dd,,where to patch}.

When @code{date.today()} is called a known date is returned, but calls to the
@code{date(...)} constructor still return normal dates. Without this you can find
yourself having to calculate an expected result using exactly the same
algorithm as the code under test, which is a classic testing anti-pattern.

Calls to the date constructor are recorded in the @code{mock_date} attributes
(@code{call_count} and friends) which may also be useful for your tests.

Uma forma alternativa de lidar com datas de mock, ou outras classes embutidas, é discutida nesta entrada de blog@footnote{https://williambert.online/2011/07/how-to-unit-testing-in-django-with-mocking-and-patching/}.

@node Mocking a Generator Method,Applying the same patch to every test method,Partial mocking,Further Examples
@anchor{library/unittest mock-examples mocking-a-generator-method}@anchor{433c}
@subsubsection Mocking a Generator Method


A Python generator is a function or method that uses the @ref{9d5,,yield} statement
to return a series of values when iterated over @footnote{
There are also generator expressions and more @uref{http://www.dabeaz.com/coroutines/index.html,advanced uses} of generators, but we aren’t
concerned about them here. A very good introduction to generators and how
powerful they are is: @uref{http://www.dabeaz.com/generators/,Generator Tricks for Systems Programmers}.
}.

A generator method / function is called to return the generator object. It is
the generator object that is then iterated over. The protocol method for
iteration is @ref{1e4a,,__iter__()}, so we can
mock this using a @ref{ebe,,MagicMock}.

Here’s an example class with an “iter” method implemented as a generator:

@example
>>> class Foo:
...     def iter(self):
...         for i in [1, 2, 3]:
...             yield i
...
>>> foo = Foo()
>>> list(foo.iter())
[1, 2, 3]
@end example

How would we mock this class, and in particular its “iter” method?

To configure the values returned from the iteration (implicit in the call to
@ref{611,,list}), we need to configure the object returned by the call to @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 Applying the same patch to every test method,Mocking Unbound Methods,Mocking a Generator Method,Further Examples
@anchor{library/unittest mock-examples applying-the-same-patch-to-every-test-method}@anchor{433d}
@subsubsection Applying the same patch to every test method


If you want several patches in place for multiple test methods the obvious way
is to apply the patch decorators to every method. This can feel like unnecessary
repetition. Instead, you can use @ref{ec1,,patch()} (in all its
various forms) as a class decorator. This applies the patches to all test
methods on the class. A test method is identified by methods whose names start
with @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

An alternative way of managing patches is to use the @ref{430f,,métodos do patch; start e stop}.
These allow you to move the patching into your @code{setUp} and @code{tearDown} methods.

@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

If you use this technique you must ensure that the patching is “undone” by
calling @code{stop}. This can be fiddlier than you might think, because if an
exception is raised in the setUp then tearDown is not called.
@ref{a8b,,unittest.TestCase.addCleanup()} makes this easier:

@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 Unbound Methods,Checking multiple calls with mock,Applying the same patch to every test method,Further Examples
@anchor{library/unittest mock-examples mocking-unbound-methods}@anchor{433e}
@subsubsection Mocking Unbound Methods


Sometimes a test needs to patch an `unbound method', which means patching the
method on the class rather than on the instance. In order to make assertions
about which objects were calling this particular method, you need to pass
@code{self} as the first argument. The issue is that you can’t patch with a mock for
this, because if you replace an unbound method with a mock it doesn’t become
a bound method when fetched from the instance, and so it doesn’t get @code{self}
passed in. The workaround is to patch the unbound method with a real function
instead. The @ref{ec1,,patch()} decorator makes it so simple to patch out methods
with a mock that having to create a real function becomes a nuisance.

If you pass @code{autospec=True} to patch then it does the patching with a
`real' function object. This function object has the same signature as the one
it is replacing, but delegates to a mock under the hood. You still get your
mock auto-created in exactly the same way as before. What it means though, is
that if you use it to patch out an unbound method on a class the mocked
function will be turned into a bound method if it is fetched from an instance.
It will have @code{self} passed in as the first argument, which is exactly what
was needed:

@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

If we don’t use @code{autospec=True} then the unbound method is patched out
with a Mock instance instead, and isn’t called with @code{self}.

@node Checking multiple calls with mock,Coping with mutable arguments,Mocking Unbound Methods,Further Examples
@anchor{library/unittest mock-examples checking-multiple-calls-with-mock}@anchor{433f}
@subsubsection Checking multiple calls with mock


mock has a nice API for making assertions about how your mock objects are used.

@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

If your mock is only being called once you can use the
@ref{42e6,,assert_called_once_with()} method that also asserts that the
@ref{15aa,,call_count} is one.

@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

Both @code{assert_called_with} and @code{assert_called_once_with} make assertions about
the `most recent' call. If your mock is going to be called several times, and
you want to make assertions about `all' those calls you can use
@ref{42ef,,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

The @ref{1b45,,call} helper makes it easy to make assertions about these calls. You
can build up a list of expected calls and compare it to @code{call_args_list}. This
looks remarkably similar to the repr of the @code{call_args_list}:

@example
>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
>>> mock.call_args_list == expected
True
@end example

@node Coping with mutable arguments,Nesting Patches,Checking multiple calls with mock,Further Examples
@anchor{library/unittest mock-examples coping-with-mutable-arguments}@anchor{4340}
@subsubsection Coping with mutable arguments


Another situation is rare, but can bite you, is when your mock is called with
mutable arguments. @code{call_args} and @code{call_args_list} store `references' to the
arguments. If the arguments are mutated by the code under test then you can no
longer make assertions about what the values were when the mock was called.

Here’s some example code that shows the problem. Imagine the following functions
defined in ‘mymodule’:

@example
def frob(val):
    pass

def grob(val):
    "First frob and then clear val"
    frob(val)
    val.clear()
@end example

When we try to test that @code{grob} calls @code{frob} with the correct argument look
what happens:

@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

One possibility would be for mock to copy the arguments you pass in. This
could then cause problems if you do assertions that rely on object identity
for equality.

Here’s one solution that uses the @ref{42dc,,side_effect}
functionality. If you provide a @code{side_effect} function for a mock then
@code{side_effect} will be called with the same args as the mock. This gives us an
opportunity to copy the arguments and store them for later assertions. In this
example I’m using `another' mock to store the arguments so that I can use the
mock methods for doing the assertion. Again a helper function sets this up for
me.

@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} is called with the mock that will be called. It returns a new
mock that we do the assertion on. The @code{side_effect} function makes a copy of
the args and calls our @code{new_mock} with the copy.

@cartouche
@quotation Nota 
If your mock is only going to be used once there is an easier way of
checking arguments at the point they are called. You can simply do the
checking inside a @code{side_effect} function.

@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

An alternative approach is to create a subclass of @ref{a54,,Mock} or
@ref{ebe,,MagicMock} that copies (using @ref{b84,,copy.deepcopy()}) the arguments.
Here’s an example implementation:

@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

When you subclass @code{Mock} or @code{MagicMock} all dynamically created attributes,
and the @code{return_value} will use your subclass automatically. That means all
children of a @code{CopyingMock} will also have the type @code{CopyingMock}.

@node Nesting Patches,Mocking a dictionary with MagicMock,Coping with mutable arguments,Further Examples
@anchor{library/unittest mock-examples nesting-patches}@anchor{4341}
@subsubsection Nesting Patches


Using patch as a context manager is nice, but if you do multiple patches you
can end up with nested with statements indenting further and further to the
right:

@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

With unittest @code{cleanup} functions and the @ref{430f,,métodos do patch; start e stop} we can
achieve the same effect without the nested indentation. A simple helper
method, @code{create_patch}, puts the patch in place and returns the created mock
for us:

@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 dictionary with MagicMock,Mock subclasses and their attributes,Nesting Patches,Further Examples
@anchor{library/unittest mock-examples mocking-a-dictionary-with-magicmock}@anchor{4342}
@subsubsection Mocking a dictionary with MagicMock


You may want to mock a dictionary, or other container object, recording all
access to it whilst having it still behave like a dictionary.

We can do this with @ref{ebe,,MagicMock}, which will behave like a dictionary,
and using @ref{42dc,,side_effect} to delegate dictionary access to a real
underlying dictionary that is under our control.

When the @ref{283,,__getitem__()} and @ref{130e,,__setitem__()} methods
of our @code{MagicMock} are called
(normal dictionary access) then @code{side_effect} is called with the key (and in
the case of @code{__setitem__} the value too). We can also control what is returned.

After the @code{MagicMock} has been used we can use attributes like
@ref{42ef,,call_args_list} to assert about how the dictionary was used:

@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 
An alternative to using @code{MagicMock} is to use @code{Mock} and `only' provide
the magic methods you specifically want:

@example
>>> mock = Mock()
>>> mock.__getitem__ = Mock(side_effect=getitem)
>>> mock.__setitem__ = Mock(side_effect=setitem)
@end example

A `third' option is to use @code{MagicMock} but passing in @code{dict} as the `spec'
(or `spec_set') argument so that the @code{MagicMock} created only has
dictionary magic methods available:

@example
>>> mock = MagicMock(spec_set=dict)
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem
@end example
@end quotation
@end cartouche

With these side effect functions in place, the @code{mock} will behave like a normal
dictionary but recording the access. It even raises a @ref{344,,KeyError} if you try
to access a key that doesn’t exist.

@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

After it has been used you can make assertions about the access using the normal
mock methods and attributes:

@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 subclasses and their attributes,Mocking imports with patch dict,Mocking a dictionary with MagicMock,Further Examples
@anchor{library/unittest mock-examples mock-subclasses-and-their-attributes}@anchor{4343}
@subsubsection Mock subclasses and their attributes


There are various reasons why you might want to subclass @ref{a54,,Mock}. One
reason might be to add helper methods. Here’s a silly example:

@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

The standard behaviour for @code{Mock} instances is that attributes and the return
value mocks are of the same type as the mock they are accessed on. This ensures
that @code{Mock} attributes are @code{Mocks} and @code{MagicMock} attributes are @code{MagicMocks}
@footnote{
An exception to this rule are the non-callable mocks. Attributes use the
callable variant because otherwise non-callable mocks couldn’t have callable
methods.
}. So if you’re subclassing to add helper methods then they’ll also be
available on the attributes and return value mock of instances of your
subclass.

@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

Sometimes this is inconvenient. For example, one user@footnote{https://code.google.com/archive/p/mock/issues/105} is subclassing mock to
created a Twisted adaptor@footnote{https://twisted.org/documents/11.0.0/api/twisted.python.components.html}.
Having this applied to attributes too actually causes errors.

@code{Mock} (in all its flavours) uses a method called @code{_get_child_mock} to create
these “sub-mocks” for attributes and return values. You can prevent your
subclass being used for attributes by overriding this method. The signature is
that it takes arbitrary keyword arguments (@code{**kwargs}) which are then passed
onto the mock constructor:

@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 Mocking imports with patch dict,Tracking order of calls and less verbose call assertions,Mock subclasses and their attributes,Further Examples
@anchor{library/unittest mock-examples mocking-imports-with-patch-dict}@anchor{4344}
@subsubsection Mocking imports with patch.dict


One situation where mocking can be hard is where you have a local import inside
a function. These are harder to mock because they aren’t using an object from
the module namespace that we can patch out.

Generally local imports are to be avoided. They are sometimes done to prevent
circular dependencies, for which there is `usually' a much better way to solve
the problem (refactor the code) or to prevent “up front costs” by delaying the
import. This can also be solved in better ways than an unconditional local
import (store the module as a class or module attribute and only do the import
on first use).

That aside there is a way to use @code{mock} to affect the results of an import.
Importing fetches an `object' from the @ref{1636,,sys.modules} dictionary. Note that it
fetches an `object', which need not be a module. Importing a module for the
first time results in a module object being put in @code{sys.modules}, so usually
when you import something you get a module back. This need not be the case
however.

This means you can use @ref{1b6a,,patch.dict()} to `temporarily' put a mock in place
in @ref{1636,,sys.modules}. Any imports whilst this patch is active will fetch the mock.
When the patch is complete (the decorated function exits, the with statement
body is complete or @code{patcher.stop()} is called) then whatever was there
previously will be restored safely.

Here’s an example that mocks out the ‘fooble’ module.

@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

As you can see the @code{import fooble} succeeds, but on exit there is no ‘fooble’
left in @ref{1636,,sys.modules}.

This also works for the @code{from module import name} form:

@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

With slightly more work you can also mock package imports:

@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 Tracking order of calls and less verbose call assertions,More complex argument matching,Mocking imports with patch dict,Further Examples
@anchor{library/unittest mock-examples tracking-order-of-calls-and-less-verbose-call-assertions}@anchor{4345}
@subsubsection Tracking order of calls and less verbose call assertions


The @ref{a54,,Mock} class allows you to track the `order' of method calls on
your mock objects through the @ref{42ea,,method_calls} attribute. This
doesn’t allow you to track the order of calls between separate mock objects,
however we can use @ref{42e8,,mock_calls} to achieve the same effect.

Because mocks track calls to child mocks in @code{mock_calls}, and accessing an
arbitrary attribute of a mock creates a child mock, we can create our separate
mocks from a parent one. Calls to those child mock will then all be recorded,
in order, in the @code{mock_calls} of the parent:

@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

We can then assert about the calls, including the order, by comparing with
the @code{mock_calls} attribute on the manager mock:

@example
>>> expected_calls = [call.foo.something(), call.bar.other.thing()]
>>> manager.mock_calls == expected_calls
True
@end example

If @code{patch} is creating, and putting in place, your mocks then you can attach
them to a manager mock using the @ref{16fa,,attach_mock()} method. After
attaching calls will be recorded in @code{mock_calls} of the manager.

@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

If many calls have been made, but you’re only interested in a particular
sequence of them then an alternative is to use the
@ref{179d,,assert_has_calls()} method. This takes a list of calls (constructed
with the @ref{1b45,,call} object). If that sequence of calls are in
@ref{42e8,,mock_calls} then the assert succeeds.

@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

Even though the chained call @code{m.one().two().three()} aren’t the only calls that
have been made to the mock, the assert still succeeds.

Sometimes a mock may have several calls made to it, and you are only interested
in asserting about `some' of those calls. You may not even care about the
order. In this case you can pass @code{any_order=True} to @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 More complex argument matching,,Tracking order of calls and less verbose call assertions,Further Examples
@anchor{library/unittest mock-examples more-complex-argument-matching}@anchor{4346}
@subsubsection More complex argument matching


Using the same basic concept as @ref{1b43,,ANY} we can implement matchers to do more
complex assertions on objects used as arguments to mocks.

Suppose we expect some object to be passed to a mock that by default
compares equal based on object identity (which is the Python default for user
defined classes). To use @ref{1b99,,assert_called_with()} we would need to pass
in the exact same object. If we are only interested in some of the attributes
of this object then we can create a matcher that will check these attributes
for us.

You can see in this example how a ‘standard’ call to @code{assert_called_with} isn’t
sufficient:

@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

A comparison function for our @code{Foo} class might look something like this:

@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

And a matcher object that can use comparison functions like this for its
equality operation would look something like this:

@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

Putting all this together:

@example
>>> match_foo = Matcher(compare, Foo(1, 2))
>>> mock.assert_called_with(match_foo)
@end example

The @code{Matcher} is instantiated with our compare function and the @code{Foo} object
we want to compare against. In @code{assert_called_with} the @code{Matcher} equality
method will be called, which compares the object the mock was called with
against the one we created our matcher with. If they match then
@code{assert_called_with} passes, and if they don’t an @ref{6a9,,AssertionError} is raised:

@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

With a bit of tweaking you could have the comparison function raise the
@ref{6a9,,AssertionError} directly and provide a more useful failure message.

As of version 1.5, the Python testing library PyHamcrest@footnote{https://pyhamcrest.readthedocs.io/} provides similar functionality,
that may be useful here, in the form of its equality matcher
(hamcrest.library.integration.match_equality@footnote{https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality}).

@node test — Pacote de Testes de Regressão do Python,test support — Utilitários para o conjunto de teste do Python,unittest mock — primeiros passos,Ferramentas de Desenvolvimento
@anchor{library/test doc}@anchor{4347}@anchor{library/test module-test}@anchor{e2}@anchor{library/test test-regression-tests-package-for-python}@anchor{4348}@anchor{library/test translation-repo}@anchor{4349}
@subsection @code{test} — Pacote de Testes de Regressão do Python


@geindex module; test

@cartouche
@quotation Nota 
O pacote @ref{e2,,test} é apenas para uso interno do Python. O mesmo está sendo documentado para o benefício dos principais desenvolvedores do Python. Qualquer uso deste pacote fora da biblioteca padrão do Python é desencorajado, pois, o código mencionado aqui pode ser alterado ou removido sem aviso prévio entre as versões do Python.
@end quotation
@end cartouche


__________________________________________________________________


O pacote @ref{e2,,test} contém todos os testes de regressão do Python, bem como os módulos @ref{e4,,test.support} e @ref{e3,,test.regrtest}. @ref{e4,,test.support} é utilizado para aprimorar seus testes enquanto o @ref{e3,,test.regrtest} direciona a suite de testes.

Cada módulo no pacote @ref{e2,,test} cujo nome começa com @code{test_} é um conjunto de testes para um módulo ou recurso específico. Todos os novos testes devem ser escritos usando o módulo @ref{106,,unittest} ou @ref{3a,,doctest}. Alguns testes mais antigos são escritos usando um estilo de teste “tradicional” que compara a saída impressa a @code{sys.stdout}. Este estilo de teste foi considerado descontinuado.


@subsubheading Ver também



@table @asis

@item Módulo @ref{106,,unittest}

Escrevendo testes de regressão PyUnit.

@item Módulo @ref{3a,,doctest}

Testes embutidos em Strings da documentação.
@end table


@menu
* Escrever testes unitários para o pacote test:: 
* Executando testes usando a interface de linha de comando:: 

@end menu

@node Escrever testes unitários para o pacote test,Executando testes usando a interface de linha de comando,,test — Pacote de Testes de Regressão do Python
@anchor{library/test writing-tests}@anchor{434a}@anchor{library/test writing-unit-tests-for-the-test-package}@anchor{434b}
@subsubsection Escrever testes unitários para o pacote @code{test}


É preferível que os testes que usam o módulo @ref{106,,unittest} sigam algumas diretrizes. Uma é nomear o módulo de teste iniciando-o com @code{test_} e termine com o nome do módulo que está sendo testado. Os métodos de teste no módulo de teste deve começar com @code{test_} e terminar com uma descrição do que o método está testando. Isso é necessário para que os métodos sejam reconhecidos pelo driver de teste como métodos de teste. Além disso, na string de documentação para o método deve ser incluído. Um comentário (como os @code{# Tests function returns only True or False}) deve ser usado para fornecer documentação para testar métodos. Isso é feito porque as strings de documentação são impressas se existem e, portanto, qual teste está sendo executado não é indicado.

Um boilerplate básico é muitas vezes usado:

@example
import unittest
from test import support

class MyTestCase1(unittest.TestCase):

    # Só use setUp() e tearDown() se necessário

    def setUp(self):
        ... código para executar na preparação de testes ...

    def tearDown(self):
        ... código para executar a limpeza após os testes ...

    def test_feature_one(self):
        # Testa o recurso um.
        ... código de teste ...

    def test_feature_two(self):
        # Testa o recurso dois.
        ... código de teste ...

    ... mais métodos de teste ...

class MyTestCase2(unittest.TestCase):
    ... mesma estrutura que MyTestCase1 ...

... mais classes de teste ...

if __name__ == '__main__':
    unittest.main()
@end example

Este padrão de código permite que o conjunto de testes seja executado pelo @ref{e3,,test.regrtest}, por conta própria, como um script que suporte o @ref{106,,unittest} CLI, ou através do @code{python -m unittest} CLI.

O objetivo do teste de regressão é tentar quebrar o código. Isso leva a algumas diretrizes que devemos seguir:


@itemize *

@item 
O conjunto de testes deve exercitar todas as classes, funções e constantes. Isso inclui não apenas a API externa que deve ser apresentada ao mundo exterior, mas também o código “privado”.

@item 
Os testes de Whitebox (que examinam o código que está sendo testado quando os testes estão sendo gravados) são preferidos. O teste Blackbox (que testa apenas a interface do público de usuário) não é completo o suficiente para garantir que todos os casos de limite e extremos sejam testados.

@item 
Certifique-se de que todos os valores possíveis sejam testados, incluindo os inválidos. Isso garante que não apenas todos os valores válidos são aceitos, mas também, que os valores impróprios são tratados corretamente.

@item 
Esgote o maior número possível de caminhos de código. Teste onde ocorre a ramificação e, assim, personalize a entrada para garantir que tantos caminhos diferentes pelo código sejam tomados.

@item 
Adicione um teste explícito para quaisquer bugs descobertos ao código testado. Isso garantirá que o erro não apareça novamente se o código for alterado no futuro.

@item 
Certifique-se de limpar após seus testes (como fechar e remover todos os arquivos temporários).

@item 
Se um teste depende de uma condição específica do sistema operacional, então verifica se a condição já existe antes de tentar o teste.

@item 
Importa o menor número de módulos possível e faça isso o mais rápido possível. Isso minimiza dependências externas de testes, e também minimiza possíveis comportamento anômalo dos efeitos colaterais da importação de um módulo.

@item 
Tente maximizar a reutilização de código. Ocasionalmente, os testes variam em algo tão pequeno quanto o tipo de entrada é usado. Minimize a duplicação de código criando uma subclasse básica de testes com uma classe que especifica o input:

@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

Ao usar este padrão, lembre-se que todas as classes que herdam de @ref{44f,,unittest.TestCase} são executadas como testes. A classe @code{TestFuncAcceptsSequencesMixin} no exemplo acima não tem nenhum dado e, portanto, não pode ser executada sozinha, portanto, ela não herda de @ref{44f,,unittest.TestCase}.
@end itemize


@subsubheading Ver também



@table @asis

@item Test Driven Development

Um livro de Kent Beck sobre escrita de testes antes do código.
@end table


@node Executando testes usando a interface de linha de comando,,Escrever testes unitários para o pacote test,test — Pacote de Testes de Regressão do Python
@anchor{library/test module-test regrtest}@anchor{e3}@anchor{library/test regrtest}@anchor{103f}@anchor{library/test running-tests-using-the-command-line-interface}@anchor{434c}
@subsubsection Executando testes usando a interface de linha de comando


@geindex module; test.regrtest

O pacote @ref{e2,,test} pode ser executado como um script para conduzir o conjunto de testes de regressão do Python, graças à opção @ref{5e1,,-m}: @code{python -m test}. Nos bastidores, ele usa @ref{e3,,test.regrtest}; a chamada @code{python -m test.regrtest} usado nas versões anteriores do Python ainda funciona. Executar o script por si só começa a executar todos os testes de regressão no pacote @ref{e2,,test}. Ele faz isso encontrando todos os módulos no pacote cujo nome começa com @code{test_}, importando-os e executando a função @code{test_main()} se presente ou carregando os testes via unittest.TestLoader.loadTestsFromModule se @code{test_main} não existir. Os nomes dos testes a serem executados também podem ser passados para o script. Especificando um teste de regressão simples (@code{python -m test test_spam}) minimizará saiba e imprima apenas se o teste passou ou falhou.

A execução de @ref{e2,,test} permite definir diretamente quais recursos estão disponíveis para os testes usarem. Você faz isso usando a opção de linha de comando @code{-u}. Especificar @code{all} como o valor para a opção @code{-u} ativa todos os recursos possíveis: @code{python -m test -uall}. Se todos menos um recurso for desejado (um caso mais comum), uma lista separada por vírgulas de recursos que não são desejados pode ser listada após @code{all}. O comando @code{python -m test -uall,-audio,-largefile} executará @ref{e2,,test} com todos os recursos, exceto os recursos @code{audio} e @code{largefile}. Para obter uma lista de todos os recursos e mais opções de linha de comando, execute @code{python -m test -h}.

Alguns outros meios para executar os testes de regressão dependem em qual plataforma os testes estão sendo executados. No Unix, você pode executar: programa: ‘ make test’ no diretório de mais alto nível onde o Python foi construído. No Windows, executar: programa ‘rt.bat’ do seu diretório: file: ‘PCbuild’ executará todos os testes de regressão.

@node test support — Utilitários para o conjunto de teste do Python,test support socket_helper — Utilities for socket tests,test — Pacote de Testes de Regressão do Python,Ferramentas de Desenvolvimento
@anchor{library/test module-test support}@anchor{e4}@anchor{library/test test-support-utilities-for-the-python-test-suite}@anchor{434d}
@subsection @code{test.support} — Utilitários para o conjunto de teste do Python


@geindex module; test.support

O módulo @ref{e4,,test.support} fornece suporte para a suíte de testes de regressão do Python.

@cartouche
@quotation Nota 
@ref{e4,,test.support} is not a public module.  It is documented here to help
Python developers write tests.  The API of this module is subject to change
without backwards compatibility concerns between releases.
@end quotation
@end cartouche

Esse módulo define as seguintes exceções:

@geindex TestFailed
@anchor{library/test test support TestFailed}@anchor{434e}
@deffn {Exceção} test.support.TestFailed

Exceção a ser levantada quando um teste falha. Isto foi descontinuado em favor dos testes baseados em @ref{106,,unittest} e métodos de asserção de @ref{44f,,unittest.TestCase}.
@end deffn

@geindex ResourceDenied
@anchor{library/test test support ResourceDenied}@anchor{434f}
@deffn {Exceção} test.support.ResourceDenied

Subclasse de @ref{101a,,unittest.SkipTest}. Levantada quando um recurso (como uma conexão de rede) não está disponível. Levantada pela função @ref{4350,,requires()}.
@end deffn

O módulo @ref{e4,,test.support} define as seguintes constantes:

@geindex verbose (no módulo test.support)
@anchor{library/test test support verbose}@anchor{4351}
@deffn {Dado} test.support.verbose

@code{True} quando a saída detalhada está habilitada. Deve ser verificado quando informações mais detalhadas são desejadas sobre um teste em execução. `verbose' é definido por @ref{e3,,test.regrtest}.
@end deffn

@geindex is_jython (no módulo test.support)
@anchor{library/test test support is_jython}@anchor{4352}
@deffn {Dado} test.support.is_jython

@code{True} se o interpretador em execução for Jython.
@end deffn

@geindex is_android (no módulo test.support)
@anchor{library/test test support is_android}@anchor{4353}
@deffn {Dado} test.support.is_android

@code{True} se o sistema é Android.
@end deffn

@geindex unix_shell (no módulo test.support)
@anchor{library/test test support unix_shell}@anchor{4354}
@deffn {Dado} test.support.unix_shell

Caminho para o console se não estiver no Windows; por outro lado @code{None}
@end deffn

@geindex LOOPBACK_TIMEOUT (no módulo test.support)
@anchor{library/test test support LOOPBACK_TIMEOUT}@anchor{1b2b}
@deffn {Dado} test.support.LOOPBACK_TIMEOUT

Tempo limite em segundos para testes usando um servidor de rede escutando na interface de loopback local da rede como @code{127.0.0.1}.

O tempo limite é longo o suficiente para evitar a falha do teste: leva em consideração que o cliente e o servidor podem ser executados em diferentes threads ou mesmo processos diferentes.

O tempo limite deve ser longo o suficiente para os métodos @ref{dcb,,connect()}, @ref{dcc,,recv()} e @ref{dcf,,send()} de @ref{dc9,,socket.socket}.

Seu valor padrão é 5 segundos.

Veja também @ref{1b2c,,INTERNET_TIMEOUT}.
@end deffn

@geindex INTERNET_TIMEOUT (no módulo test.support)
@anchor{library/test test support INTERNET_TIMEOUT}@anchor{1b2c}
@deffn {Dado} test.support.INTERNET_TIMEOUT

Tempo limite em segundos para solicitações de rede indo para a Internet.

O tempo limite é curto o suficiente para evitar que um teste espere muito tempo se a requisição da Internet for bloqueada por qualquer motivo.

Normalmente, um tempo limite usando @ref{1b2c,,INTERNET_TIMEOUT} não deve marcar um teste como falhado, mas ignorá-lo: veja @ref{4355,,transient_internet()}.

Seu valor padrão é 1 minuto.

Veja também @ref{1b2b,,LOOPBACK_TIMEOUT}.
@end deffn

@geindex SHORT_TIMEOUT (no módulo test.support)
@anchor{library/test test support SHORT_TIMEOUT}@anchor{19ee}
@deffn {Dado} test.support.SHORT_TIMEOUT

Tempo limite em segundos para marcar um teste como falho se o teste demorar “muito tempo”.

O valor do tempo limite depende da opção da linha de comando regrtest @code{--timeout}.

Se um teste usando @ref{19ee,,SHORT_TIMEOUT} começar a falhar aleatoriamente em buildbots lentos, use @ref{1b2d,,LONG_TIMEOUT}.

Seu valor padrão é 30 segundos.
@end deffn

@geindex LONG_TIMEOUT (no módulo test.support)
@anchor{library/test test support LONG_TIMEOUT}@anchor{1b2d}
@deffn {Dado} test.support.LONG_TIMEOUT

Tempo limite em segundos para detectar quando um teste trava.

É longo o suficiente para reduzir o risco de falha de teste nos buildbots Python mais lentos. Não deve ser usado para marcar um teste como reprovado se o teste demorar “muito tempo”. O valor do tempo limite depende da opção de linha de comando regrtest @code{--timeout}.

Seu valor padrão é 5 minutos.

Veja também @ref{1b2b,,LOOPBACK_TIMEOUT}, @ref{1b2c,,INTERNET_TIMEOUT} e @ref{19ee,,SHORT_TIMEOUT}.
@end deffn

@geindex PGO (no módulo test.support)
@anchor{library/test test support PGO}@anchor{4356}
@deffn {Dado} test.support.PGO

Definido quando os testes podem ser ignorados quando não são úteis para PGO.
@end deffn

@geindex PIPE_MAX_SIZE (no módulo test.support)
@anchor{library/test test support PIPE_MAX_SIZE}@anchor{4357}
@deffn {Dado} test.support.PIPE_MAX_SIZE

Uma constante que provavelmente é maior que o tamanho do buffer de canal do sistema operacional subjacente, para fazer o bloqueio de escritas.
@end deffn

@geindex Py_DEBUG (no módulo test.support)
@anchor{library/test test support Py_DEBUG}@anchor{4358}
@deffn {Dado} test.support.Py_DEBUG

@code{True} se o Python foi criado com a macro @ref{4359,,Py_DEBUG} definida, ou seja, se o Python foi @ref{1f9,,criado no modo de depuração}.


Adicionado na versão 3.12.

@end deffn

@geindex SOCK_MAX_SIZE (no módulo test.support)
@anchor{library/test test support SOCK_MAX_SIZE}@anchor{435a}
@deffn {Dado} test.support.SOCK_MAX_SIZE

Uma constante que provavelmente é maior que o tamanho do buffer de soquete do sistema operacional subjacente, para fazer o bloqueio de escritas.
@end deffn

@geindex TEST_SUPPORT_DIR (no módulo test.support)
@anchor{library/test test support TEST_SUPPORT_DIR}@anchor{435b}
@deffn {Dado} test.support.TEST_SUPPORT_DIR

Define o diretório de mais alto nível que contém @ref{e4,,test.support}.
@end deffn

@geindex TEST_HOME_DIR (no módulo test.support)
@anchor{library/test test support TEST_HOME_DIR}@anchor{435c}
@deffn {Dado} test.support.TEST_HOME_DIR

Define o diretório de mais alto nível para o pacote de teste.
@end deffn

@geindex TEST_DATA_DIR (no módulo test.support)
@anchor{library/test test support TEST_DATA_DIR}@anchor{435d}
@deffn {Dado} test.support.TEST_DATA_DIR

Define o diretório @code{data} de dentro do pacote de teste.
@end deffn

@geindex MAX_Py_ssize_t (no módulo test.support)
@anchor{library/test test support MAX_Py_ssize_t}@anchor{435e}
@deffn {Dado} test.support.MAX_Py_ssize_t

Define @ref{1205,,sys.maxsize} para grandes testes de memória.
@end deffn

@geindex max_memuse (no módulo test.support)
@anchor{library/test test support max_memuse}@anchor{435f}
@deffn {Dado} test.support.max_memuse

Set by @ref{4360,,set_memlimit()} as the memory limit for big memory tests.
Limited by @ref{435e,,MAX_Py_ssize_t}.
@end deffn

@geindex real_max_memuse (no módulo test.support)
@anchor{library/test test support real_max_memuse}@anchor{4361}
@deffn {Dado} test.support.real_max_memuse

Set by @ref{4360,,set_memlimit()} as the memory limit for big memory tests.  Not
limited by @ref{435e,,MAX_Py_ssize_t}.
@end deffn

@geindex MISSING_C_DOCSTRINGS (no módulo test.support)
@anchor{library/test test support MISSING_C_DOCSTRINGS}@anchor{4362}
@deffn {Dado} test.support.MISSING_C_DOCSTRINGS

Set to @code{True} if Python is built without docstrings (the
@code{WITH_DOC_STRINGS} macro is not defined).
See the @ref{1f37,,configure --without-doc-strings} option.

See also the @ref{4363,,HAVE_DOCSTRINGS} variable.
@end deffn

@geindex HAVE_DOCSTRINGS (no módulo test.support)
@anchor{library/test test support HAVE_DOCSTRINGS}@anchor{4363}
@deffn {Dado} test.support.HAVE_DOCSTRINGS

Set to @code{True} if function docstrings are available.
See the @ref{ddd,,python -OO} option, which strips docstrings of functions implemented in Python.

See also the @ref{4362,,MISSING_C_DOCSTRINGS} variable.
@end deffn

@geindex TEST_HTTP_URL (no módulo test.support)
@anchor{library/test test support TEST_HTTP_URL}@anchor{4364}
@deffn {Dado} test.support.TEST_HTTP_URL

Define the URL of a dedicated HTTP server for the network tests.
@end deffn

@geindex ALWAYS_EQ (no módulo test.support)
@anchor{library/test test support ALWAYS_EQ}@anchor{4365}
@deffn {Dado} test.support.ALWAYS_EQ

Object that is equal to anything.  Used to test mixed type comparison.
@end deffn

@geindex NEVER_EQ (no módulo test.support)
@anchor{library/test test support NEVER_EQ}@anchor{4366}
@deffn {Dado} test.support.NEVER_EQ

Object that is not equal to anything (even to @ref{4365,,ALWAYS_EQ}).
Used to test mixed type comparison.
@end deffn

@geindex LARGEST (no módulo test.support)
@anchor{library/test test support LARGEST}@anchor{4367}
@deffn {Dado} test.support.LARGEST

Object that is greater than anything (except itself).
Used to test mixed type comparison.
@end deffn

@geindex SMALLEST (no módulo test.support)
@anchor{library/test test support SMALLEST}@anchor{4368}
@deffn {Dado} test.support.SMALLEST

Object that is less than anything (except itself).
Used to test mixed type comparison.
@end deffn

O módulo @ref{e4,,test.support} define as seguintes funções:

@geindex busy_retry() (no módulo test.support)
@anchor{library/test test support busy_retry}@anchor{4369}
@deffn {Função} 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{6a9,,AssertionError} if `error' is true,
or just stop the loop if `error' is false.

Exemplo:

@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() (no módulo test.support)
@anchor{library/test test support sleeping_retry}@anchor{436a}
@deffn {Função} 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{4369,,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() (no módulo test.support)
@anchor{library/test test support is_resource_enabled}@anchor{436b}
@deffn {Função} test.support.is_resource_enabled (resource)

Return @code{True} if `resource' is enabled and available. The list of
available resources is only set when @ref{e3,,test.regrtest} is executing the
tests.
@end deffn

@geindex get_resource_value() (no módulo test.support)
@anchor{library/test test support get_resource_value}@anchor{436c}
@deffn {Função} test.support.get_resource_value (resource)

Return the value specified for `resource' (as @code{-u @var{resource}=@var{value}}).
Return @code{None} if `resource' is disabled or no value is specified.
@end deffn

@geindex python_is_optimized() (no módulo test.support)
@anchor{library/test test support python_is_optimized}@anchor{436d}
@deffn {Função} test.support.python_is_optimized ()

Return @code{True} if Python was not built with @code{-O0} or @code{-Og}.
@end deffn

@geindex with_pymalloc() (no módulo test.support)
@anchor{library/test test support with_pymalloc}@anchor{436e}
@deffn {Função} test.support.with_pymalloc ()

Return @code{_testcapi.WITH_PYMALLOC}.
@end deffn

@geindex requires() (no módulo test.support)
@anchor{library/test test support requires}@anchor{4350}
@deffn {Função} test.support.requires (resource, msg=None)

Raise @ref{434f,,ResourceDenied} if `resource' is not available. `msg' is the
argument to @ref{434f,,ResourceDenied} if it is raised. Always returns
@code{True} if called by a function whose @code{__name__} is @code{'__main__'}.
Used when tests are executed by @ref{e3,,test.regrtest}.
@end deffn

@geindex sortdict() (no módulo test.support)
@anchor{library/test test support sortdict}@anchor{436f}
@deffn {Função} test.support.sortdict (dict)

Return a repr of `dict' with keys sorted.
@end deffn

@geindex findfile() (no módulo test.support)
@anchor{library/test test support findfile}@anchor{4370}
@deffn {Função} test.support.findfile (filename, subdir=None)

Return the path to the file named `filename'. If no match is found
`filename' is returned. This does not equal a failure since it could be the
path to the file.

Setting `subdir' indicates a relative path to use to find the file
rather than looking directly in the path directories.
@end deffn

@geindex get_pagesize() (no módulo test.support)
@anchor{library/test test support get_pagesize}@anchor{4371}
@deffn {Função} test.support.get_pagesize ()

Get size of a page in bytes.


Adicionado na versão 3.12.

@end deffn

@geindex setswitchinterval() (no módulo test.support)
@anchor{library/test test support setswitchinterval}@anchor{4372}
@deffn {Função} test.support.setswitchinterval (interval)

Set the @ref{951,,sys.setswitchinterval()} to the given `interval'.  Defines
a minimum interval for Android systems to prevent the system from hanging.
@end deffn

@geindex check_impl_detail() (no módulo test.support)
@anchor{library/test test support check_impl_detail}@anchor{4373}
@deffn {Função} test.support.check_impl_detail (**guards)

Use this check to guard CPython’s implementation-specific tests or to
run them only on the implementations guarded by the arguments.  This
function returns @code{True} or @code{False} depending on the host platform.
Example usage:

@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() (no módulo test.support)
@anchor{library/test test support set_memlimit}@anchor{4360}
@deffn {Função} test.support.set_memlimit (limit)

Define os valores para @ref{435f,,max_memuse} e @ref{4361,,real_max_memuse} para grandes testes de memória.
@end deffn

@geindex record_original_stdout() (no módulo test.support)
@anchor{library/test test support record_original_stdout}@anchor{4374}
@deffn {Função} test.support.record_original_stdout (stdout)

Armazena o valor de `stdout'. Destina-se a manter o stdout no momento em que o registro começou.
@end deffn

@geindex get_original_stdout() (no módulo test.support)
@anchor{library/test test support get_original_stdout}@anchor{4375}
@deffn {Função} test.support.get_original_stdout ()

Retorna o stdout original definido por @ref{4374,,record_original_stdout()} ou @code{sys.stdout} se não estiver definido.
@end deffn

@geindex args_from_interpreter_flags() (no módulo test.support)
@anchor{library/test test support args_from_interpreter_flags}@anchor{4376}
@deffn {Função} test.support.args_from_interpreter_flags ()

Retorna uma lista de argumentos de linha de comando reproduzindo as configurações em @code{sys.flags} e @code{sys.warnoptions}.
@end deffn

@geindex optim_args_from_interpreter_flags() (no módulo test.support)
@anchor{library/test test support optim_args_from_interpreter_flags}@anchor{4377}
@deffn {Função} test.support.optim_args_from_interpreter_flags ()

Retorna a lista de argumentos da linha de comando reproduzindo as configurações de otimização atuais em @code{sys.flags}.
@end deffn

@geindex captured_stdin() (no módulo test.support)
@geindex captured_stdout() (no módulo test.support)
@geindex captured_stderr() (no módulo test.support)
@anchor{library/test test support captured_stdin}@anchor{4378}
@deffn {Função} test.support.captured_stdin ()
@anchor{library/test test support captured_stdout}@anchor{4379}
@deffnx {Função} test.support.captured_stdout ()
@anchor{library/test test support captured_stderr}@anchor{1b6d}
@deffnx {Função} test.support.captured_stderr ()

Um gerenciador de contexto que substitui temporariamente o fluxo nomeado pelo objeto @ref{f59,,io.StringIO}.

Exemplo do uso com fluxos de saída:

@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

Exemplo de uso com fluxo 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() (no módulo test.support)
@anchor{library/test test support disable_faulthandler}@anchor{437a}
@deffn {Função} test.support.disable_faulthandler ()

Um gerenciador de contexto que desativa temporariamente @ref{58,,faulthandler}.
@end deffn

@geindex gc_collect() (no módulo test.support)
@anchor{library/test test support gc_collect}@anchor{437b}
@deffn {Função} test.support.gc_collect ()

Força a coleta de tantos objetos quanto possível. Isso é necessário porque a desalocação oportuna não é garantida pelo coletor de lixo. Isso significa que os métodos @code{__del__} podem ser chamados mais tarde do que o esperado e as referência fraca podem permanecer ativas por mais tempo do que o esperado.
@end deffn

@geindex disable_gc() (no módulo test.support)
@anchor{library/test test support disable_gc}@anchor{437c}
@deffn {Função} test.support.disable_gc ()

A context manager that disables the garbage collector on entry. On
exit, the garbage collector is restored to its prior state.
@end deffn

@geindex swap_attr() (no módulo test.support)
@anchor{library/test test support swap_attr}@anchor{437d}
@deffn {Função} test.support.swap_attr (obj, attr, new_val)

Context manager to swap out an attribute with a new object.

Uso:

@example
with swap_attr(obj, "attr", 5):
    ...
@end example

This will set @code{obj.attr} to 5 for the duration of the @code{with} block,
restoring the old value at the end of the block.  If @code{attr} doesn’t
exist on @code{obj}, it will be created and then deleted at the end of the
block.

The old value (or @code{None} if it doesn’t exist) will be assigned to the
target of the “as” clause, if there is one.
@end deffn

@geindex swap_item() (no módulo test.support)
@anchor{library/test test support swap_item}@anchor{437e}
@deffn {Função} test.support.swap_item (obj, attr, new_val)

Context manager to swap out an item with a new object.

Uso:

@example
with swap_item(obj, "item", 5):
    ...
@end example

This will set @code{obj["item"]} to 5 for the duration of the @code{with} block,
restoring the old value at the end of the block. If @code{item} doesn’t
exist on @code{obj}, it will be created and then deleted at the end of the
block.

The old value (or @code{None} if it doesn’t exist) will be assigned to the
target of the “as” clause, if there is one.
@end deffn

@geindex flush_std_streams() (no módulo test.support)
@anchor{library/test test support flush_std_streams}@anchor{437f}
@deffn {Função} test.support.flush_std_streams ()

Call the @code{flush()} method on @ref{ae6,,sys.stdout} and then on
@ref{940,,sys.stderr}. It can be used to make sure that the logs order is
consistent before writing into stderr.


Adicionado na versão 3.11.

@end deffn

@geindex print_warning() (no módulo test.support)
@anchor{library/test test support print_warning}@anchor{4380}
@deffn {Função} test.support.print_warning (msg)

Print a warning into @ref{4381,,sys.__stderr__}. Format the message as:
@code{f"Warning -- @{msg@}"}. If `msg' is made of multiple lines, add
@code{"Warning -- "} prefix to each line.


Adicionado na versão 3.9.

@end deffn

@geindex wait_process() (no módulo test.support)
@anchor{library/test test support wait_process}@anchor{1aec}
@deffn {Função} test.support.wait_process (pid, *, exitcode, timeout=None)

Wait until process `pid' completes and check that the process exit code is
`exitcode'.

Raise an @ref{6a9,,AssertionError} if the process exit code is not equal to
`exitcode'.

If the process runs longer than `timeout' seconds (@ref{19ee,,SHORT_TIMEOUT} by
default), kill the process and raise an @ref{6a9,,AssertionError}. The timeout
feature is not available on Windows.


Adicionado na versão 3.9.

@end deffn

@geindex calcobjsize() (no módulo test.support)
@anchor{library/test test support calcobjsize}@anchor{4382}
@deffn {Função} test.support.calcobjsize (fmt)

Return the size of the @ref{339,,PyObject} whose structure members are
defined by `fmt'. The returned value includes the size of the Python object header and alignment.
@end deffn

@geindex calcvobjsize() (no módulo test.support)
@anchor{library/test test support calcvobjsize}@anchor{4383}
@deffn {Função} test.support.calcvobjsize (fmt)

Return the size of the @ref{4384,,PyVarObject} whose structure members are
defined by `fmt'. The returned value includes the size of the Python object header and alignment.
@end deffn

@geindex checksizeof() (no módulo test.support)
@anchor{library/test test support checksizeof}@anchor{4385}
@deffn {Função} test.support.checksizeof (test, o, size)

For testcase `test', assert that the @code{sys.getsizeof} for `o' plus the GC
header size equals `size'.
@end deffn

@geindex anticipate_failure() (no módulo test.support)
@anchor{library/test test support anticipate_failure}@anchor{4386}
@deffn {Função} @@test.support.anticipate_failure (condition)

A decorator to conditionally mark tests with
@ref{429a,,unittest.expectedFailure()}. Any use of this decorator should
have an associated comment identifying the relevant tracker issue.
@end deffn

@geindex system_must_validate_cert() (no módulo test.support)
@anchor{library/test test support system_must_validate_cert}@anchor{4387}
@deffn {Função} test.support.system_must_validate_cert (f)

A decorator that skips the decorated test on TLS certification validation failures.
@end deffn

@geindex run_with_locale() (no módulo test.support)
@anchor{library/test test support run_with_locale}@anchor{4388}
@deffn {Função} @@test.support.run_with_locale (catstr, *locales)

A decorator for running a function in a different locale, correctly
resetting it after it has finished.  `catstr' is the locale category as
a string (for example @code{"LC_ALL"}).  The `locales' passed will be tried
sequentially, and the first valid locale will be used.
@end deffn

@geindex run_with_tz() (no módulo test.support)
@anchor{library/test test support run_with_tz}@anchor{4389}
@deffn {Função} @@test.support.run_with_tz (tz)

A decorator for running a function in a specific timezone, correctly
resetting it after it has finished.
@end deffn

@geindex requires_freebsd_version() (no módulo test.support)
@anchor{library/test test support requires_freebsd_version}@anchor{438a}
@deffn {Função} @@test.support.requires_freebsd_version (*min_version)

Decorator for the minimum version when running test on FreeBSD.  If the
FreeBSD version is less than the minimum, the test is skipped.
@end deffn

@geindex requires_linux_version() (no módulo test.support)
@anchor{library/test test support requires_linux_version}@anchor{438b}
@deffn {Função} @@test.support.requires_linux_version (*min_version)

Decorator for the minimum version when running test on Linux.  If the
Linux version is less than the minimum, the test is skipped.
@end deffn

@geindex requires_mac_version() (no módulo test.support)
@anchor{library/test test support requires_mac_version}@anchor{438c}
@deffn {Função} @@test.support.requires_mac_version (*min_version)

Decorator for the minimum version when running test on macOS.  If the
macOS version is less than the minimum, the test is skipped.
@end deffn

@geindex requires_gil_enabled() (no módulo test.support)
@anchor{library/test test support requires_gil_enabled}@anchor{438d}
@deffn {Função} @@test.support.requires_gil_enabled

Decorador para pular testes na construção com threads livres. Se a @ref{159,,GIL} estiver desabilitada, o teste será ignorado.
@end deffn

@geindex requires_IEEE_754() (no módulo test.support)
@anchor{library/test test support requires_IEEE_754}@anchor{438e}
@deffn {Função} @@test.support.requires_IEEE_754

Decorator for skipping tests on non-IEEE 754 platforms.
@end deffn

@geindex requires_zlib() (no módulo test.support)
@anchor{library/test test support requires_zlib}@anchor{438f}
@deffn {Função} @@test.support.requires_zlib

Decorator for skipping tests if @ref{133,,zlib} doesn’t exist.
@end deffn

@geindex requires_gzip() (no módulo test.support)
@anchor{library/test test support requires_gzip}@anchor{4390}
@deffn {Função} @@test.support.requires_gzip

Decorator for skipping tests if @ref{67,,gzip} doesn’t exist.
@end deffn

@geindex requires_bz2() (no módulo test.support)
@anchor{library/test test support requires_bz2}@anchor{4391}
@deffn {Função} @@test.support.requires_bz2

Decorator for skipping tests if @ref{13,,bz2} doesn’t exist.
@end deffn

@geindex requires_lzma() (no módulo test.support)
@anchor{library/test test support requires_lzma}@anchor{4392}
@deffn {Função} @@test.support.requires_lzma

Decorator for skipping tests if @ref{8a,,lzma} doesn’t exist.
@end deffn

@geindex requires_resource() (no módulo test.support)
@anchor{library/test test support requires_resource}@anchor{4393}
@deffn {Função} @@test.support.requires_resource (resource)

Decorator for skipping tests if `resource' is not available.
@end deffn

@geindex requires_docstrings() (no módulo test.support)
@anchor{library/test test support requires_docstrings}@anchor{4394}
@deffn {Função} @@test.support.requires_docstrings

Decorator for only running the test if @ref{4363,,HAVE_DOCSTRINGS}.
@end deffn

@geindex requires_limited_api() (no módulo test.support)
@anchor{library/test test support requires_limited_api}@anchor{4395}
@deffn {Função} @@test.support.requires_limited_api

Decorator for only running the test if @ref{396,,Limited C API}
is available.
@end deffn

@geindex cpython_only() (no módulo test.support)
@anchor{library/test test support cpython_only}@anchor{4396}
@deffn {Função} @@test.support.cpython_only

Decorator for tests only applicable to CPython.
@end deffn

@geindex impl_detail() (no módulo test.support)
@anchor{library/test test support impl_detail}@anchor{4397}
@deffn {Função} @@test.support.impl_detail (msg=None, **guards)

Decorator for invoking @ref{4373,,check_impl_detail()} on `guards'.  If that
returns @code{False}, then uses `msg' as the reason for skipping the test.
@end deffn

@geindex no_tracing() (no módulo test.support)
@anchor{library/test test support no_tracing}@anchor{4398}
@deffn {Função} @@test.support.no_tracing

Decorator to temporarily turn off tracing for the duration of the test.
@end deffn

@geindex refcount_test() (no módulo test.support)
@anchor{library/test test support refcount_test}@anchor{4399}
@deffn {Função} @@test.support.refcount_test

Decorator for tests which involve reference counting.  The decorator does
not run the test if it is not run by CPython.  Any trace function is unset
for the duration of the test to prevent unexpected refcounts caused by
the trace function.
@end deffn

@geindex bigmemtest() (no módulo test.support)
@anchor{library/test test support bigmemtest}@anchor{439a}
@deffn {Função} @@test.support.bigmemtest (size, memuse, dry_run=True)

Decorator for bigmem tests.

`size' is a requested size for the test (in arbitrary, test-interpreted
units.)  `memuse' is the number of bytes per unit for the test, or a good
estimate of it.  For example, a test that needs two byte buffers, of 4 GiB
each, could be decorated with @code{@@bigmemtest(size=_4G, memuse=2)}.

The `size' argument is normally passed to the decorated test method as an
extra argument.  If `dry_run' is @code{True}, the value passed to the test
method may be less than the requested value.  If `dry_run' is @code{False}, it
means the test doesn’t support dummy runs when @code{-M} is not specified.
@end deffn

@geindex bigaddrspacetest() (no módulo test.support)
@anchor{library/test test support bigaddrspacetest}@anchor{439b}
@deffn {Função} @@test.support.bigaddrspacetest

Decorador para testes que preenche o espaço do endereço.
@end deffn

@geindex check_syntax_error() (no módulo test.support)
@anchor{library/test test support check_syntax_error}@anchor{439c}
@deffn {Função} test.support.check_syntax_error (testcase, statement, errtext='@w{'}, *, lineno=None, offset=None)

Test for syntax errors in `statement' by attempting to compile `statement'.
`testcase' is the @ref{106,,unittest} instance for the test.  `errtext' is the
regular expression which should match the string representation of the
raised @ref{18d,,SyntaxError}.  If `lineno' is not @code{None}, compares to
the line of the exception.  If `offset' is not @code{None}, compares to
the offset of the exception.
@end deffn

@geindex open_urlresource() (no módulo test.support)
@anchor{library/test test support open_urlresource}@anchor{439d}
@deffn {Função} test.support.open_urlresource (url, *args, **kw)

Abre `url'. Se falhar em abrir, levanta @ref{434e,,TestFailed}.
@end deffn

@geindex reap_children() (no módulo test.support)
@anchor{library/test test support reap_children}@anchor{439e}
@deffn {Função} test.support.reap_children ()

Use this at the end of @code{test_main} whenever sub-processes are started.
This will help ensure that no extra children (zombies) stick around to
hog resources and create problems when looking for refleaks.
@end deffn

@geindex get_attribute() (no módulo test.support)
@anchor{library/test test support get_attribute}@anchor{439f}
@deffn {Função} test.support.get_attribute (obj, name)

Get an attribute, raising @ref{101a,,unittest.SkipTest} if @ref{34b,,AttributeError}
is raised.
@end deffn

@geindex catch_unraisable_exception() (no módulo test.support)
@anchor{library/test test support catch_unraisable_exception}@anchor{1b4f}
@deffn {Função} test.support.catch_unraisable_exception ()

Context manager catching unraisable exception using
@ref{1f7,,sys.unraisablehook()}.

Storing the exception value (@code{cm.unraisable.exc_value}) creates a
reference cycle. The reference cycle is broken explicitly when the context
manager exits.

Storing the object (@code{cm.unraisable.object}) can resurrect it if it is set
to an object which is being finalized. Exiting the context manager clears
the stored object.

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


Adicionado na versão 3.8.

@end deffn

@geindex load_package_tests() (no módulo test.support)
@anchor{library/test test support load_package_tests}@anchor{43a0}
@deffn {Função} test.support.load_package_tests (pkg_dir, loader, standard_tests, pattern)

Generic implementation of the @ref{106,,unittest} @code{load_tests} protocol for
use in test packages.  `pkg_dir' is the root directory of the package;
`loader', `standard_tests', and `pattern' are the arguments expected by
@code{load_tests}.  In simple cases, the test package’s @code{__init__.py}
can be the following:

@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() (no módulo test.support)
@anchor{library/test test support detect_api_mismatch}@anchor{43a1}
@deffn {Função} test.support.detect_api_mismatch (ref_api, other_api, *, ignore=())

Returns the set of attributes, functions or methods of `ref_api' not
found on `other_api', except for a defined list of items to be
ignored in this check specified in `ignore'.

By default this skips private attributes beginning with ‘_’ but
includes all magic methods, i.e. those starting and ending in ‘__’.


Adicionado na versão 3.5.

@end deffn

@geindex patch() (no módulo test.support)
@anchor{library/test test support patch}@anchor{43a2}
@deffn {Função} test.support.patch (test_instance, object_to_patch, attr_name, new_value)

Override `object_to_patch.attr_name' with `new_value'.  Also add
cleanup procedure to `test_instance' to restore `object_to_patch' for
`attr_name'.  The `attr_name' should be a valid attribute for
`object_to_patch'.
@end deffn

@geindex run_in_subinterp() (no módulo test.support)
@anchor{library/test test support run_in_subinterp}@anchor{43a3}
@deffn {Função} test.support.run_in_subinterp (code)

Run `code' in subinterpreter.  Raise @ref{101a,,unittest.SkipTest} if
@ref{ff,,tracemalloc} is enabled.
@end deffn

@geindex check_free_after_iterating() (no módulo test.support)
@anchor{library/test test support check_free_after_iterating}@anchor{43a4}
@deffn {Função} test.support.check_free_after_iterating (test, iter, cls, args=())

Assert instances of `cls' are deallocated after iterating.
@end deffn

@geindex missing_compiler_executable() (no módulo test.support)
@anchor{library/test test support missing_compiler_executable}@anchor{43a5}
@deffn {Função} test.support.missing_compiler_executable (cmd_names=[])

Check for the existence of the compiler executables whose names are listed
in `cmd_names' or all the compiler executables when `cmd_names' is empty
and return the first missing executable or @code{None} when none is found
missing.
@end deffn

@geindex check__all__() (no módulo test.support)
@anchor{library/test test support check__all__}@anchor{1ac0}
@deffn {Função} test.support.check__all__ (test_case, module, name_of_module=None, extra=(), not_exported=())

Assert that the @code{__all__} variable of `module' contains all public names.

The module’s public names (its API) are detected automatically
based on whether they match the public name convention and were defined in
`module'.

The `name_of_module' argument can specify (as a string or tuple thereof) what
module(s) an API could be defined in order to be detected as a public
API. One case for this is when `module' imports part of its public API from
other modules, possibly a C backend (like @code{csv} and its @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{240c,,__module__}
attribute. If provided, it will be added to the automatically detected ones.

The `not_exported' argument can be a set of names that must not be treated
as part of the public API even though their names indicate otherwise.

Exemplo 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


Adicionado na versão 3.6.

@end deffn

@geindex skip_if_broken_multiprocessing_synchronize() (no módulo test.support)
@anchor{library/test test support skip_if_broken_multiprocessing_synchronize}@anchor{1ac1}
@deffn {Função} test.support.skip_if_broken_multiprocessing_synchronize ()

Skip tests if the @code{multiprocessing.synchronize} module is missing, if
there is no available semaphore implementation, or if creating a lock raises
an @ref{417,,OSError}.


Adicionado na versão 3.10.

@end deffn

@geindex check_disallow_instantiation() (no módulo test.support)
@anchor{library/test test support check_disallow_instantiation}@anchor{43a6}
@deffn {Função} test.support.check_disallow_instantiation (test_case, tp, *args, **kwds)

Assert that type `tp' cannot be instantiated using `args' and `kwds'.


Adicionado na versão 3.10.

@end deffn

@geindex adjust_int_max_str_digits() (no módulo test.support)
@anchor{library/test test support adjust_int_max_str_digits}@anchor{43a7}
@deffn {Função} test.support.adjust_int_max_str_digits (max_digits)

This function returns a context manager that will change the global
@ref{18c5,,sys.set_int_max_str_digits()} setting for the duration of the
context to allow execution of test code that needs a different limit
on the number of digits when converting between an integer and string.


Adicionado na versão 3.11.

@end deffn

The @ref{e4,,test.support} module defines the following classes:

@geindex SuppressCrashReport (classe em test.support)
@anchor{library/test test support SuppressCrashReport}@anchor{43a8}
@deffn {Classe} test.support.SuppressCrashReport

A context manager used to try to prevent crash dialog popups on tests that
are expected to crash a subprocess.

No Windows, desativa as caixas de diálogo Relatório de Erros do Windows usando SetErrorMode <@indicateurl{https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621.aspx}>_.

On UNIX, @ref{1605,,resource.setrlimit()} is used to set
@ref{43a9,,resource.RLIMIT_CORE}’s soft limit to 0 to prevent coredump file
creation.

On both platforms, the old value is restored by @ref{1344,,__exit__()}.
@end deffn

@geindex SaveSignals (classe em test.support)
@anchor{library/test test support SaveSignals}@anchor{43aa}
@deffn {Classe} test.support.SaveSignals

Class to save and restore signal handlers registered by the Python signal
handler.

@geindex save() (método test.support.SaveSignals)
@anchor{library/test test support SaveSignals save}@anchor{43ab}
@deffn {Método} save (self)

Save the signal handlers to a dictionary mapping signal numbers to the
current signal handler.
@end deffn

@geindex restore() (método test.support.SaveSignals)
@anchor{library/test test support SaveSignals restore}@anchor{43ac}
@deffn {Método} restore (self)

Set the signal numbers from the @ref{43ab,,save()} dictionary to the saved
handler.
@end deffn
@end deffn

@geindex Matcher (classe em test.support)
@anchor{library/test test support Matcher}@anchor{43ad}
@deffn {Classe} test.support.Matcher

@geindex matches() (método test.support.Matcher)
@anchor{library/test test support Matcher matches}@anchor{43ae}
@deffn {Método} matches (self, d, **kwargs)

Tenta corresponder um único dicionário com os argumentos fornecidos.
@end deffn

@geindex match_value() (método test.support.Matcher)
@anchor{library/test test support Matcher match_value}@anchor{43af}
@deffn {Método} match_value (self, k, dv, v)

Tente combinar um único valor armazenado (`dv') com um valor fornecido (`v').
@end deffn
@end deffn

@node test support socket_helper — Utilities for socket tests,test support script_helper — Utilities for the Python execution tests,test support — Utilitários para o conjunto de teste do Python,Ferramentas de Desenvolvimento
@anchor{library/test module-test support socket_helper}@anchor{e9}@anchor{library/test test-support-socket-helper-utilities-for-socket-tests}@anchor{43b0}
@subsection @code{test.support.socket_helper} — Utilities for socket tests


@geindex module; test.support.socket_helper

The @ref{e9,,test.support.socket_helper} module provides support for socket tests.


Adicionado na versão 3.9.


@geindex IPV6_ENABLED (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper IPV6_ENABLED}@anchor{43b1}
@deffn {Dado} test.support.socket_helper.IPV6_ENABLED

Set to @code{True} if IPv6 is enabled on this host, @code{False} otherwise.
@end deffn

@geindex find_unused_port() (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper find_unused_port}@anchor{43b2}
@deffn {Função} test.support.socket_helper.find_unused_port (family=socket.AF_INET, socktype=socket.SOCK_STREAM)

Returns an unused port that should be suitable for binding.  This is
achieved by creating a temporary socket with the same family and type as
the @code{sock} parameter (default is @ref{1938,,AF_INET},
@ref{1337,,SOCK_STREAM}),
and binding it to the specified host address (defaults to @code{0.0.0.0})
with the port set to 0, eliciting an unused ephemeral port from the OS.
The temporary socket is then closed and deleted, and the ephemeral port is
returned.

Either this method or @ref{43b3,,bind_port()} should be used for any tests
where a server socket needs to be bound to a particular port for the
duration of the test.
Which one to use depends on whether the calling code is creating a Python
socket, or if an unused port needs to be provided in a constructor
or passed to an external program (i.e. the @code{-accept} argument to
openssl’s s_server mode).  Always prefer @ref{43b3,,bind_port()} over
@ref{43b2,,find_unused_port()} where possible.  Using a hard coded port is
discouraged since it can make multiple instances of the test impossible to
run simultaneously, which is a problem for buildbots.
@end deffn

@geindex bind_port() (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper bind_port}@anchor{43b3}
@deffn {Função} test.support.socket_helper.bind_port (sock, host=HOST)

Bind the socket to a free port and return the port number.  Relies on
ephemeral ports in order to ensure we are using an unbound port.  This is
important as many tests may be running simultaneously, especially in a
buildbot environment.  This method raises an exception if the
@code{sock.family} is @ref{1938,,AF_INET} and @code{sock.type} is
@ref{1337,,SOCK_STREAM}, and the socket has
@code{SO_REUSEADDR} or @code{SO_REUSEPORT} set on it.
Tests should never set these socket options for TCP/IP sockets.
The only case for setting these options is testing multicasting via
multiple UDP sockets.

Additionally, if the @code{SO_EXCLUSIVEADDRUSE} socket option is
available (i.e. on Windows), it will be set on the socket.  This will
prevent anyone else from binding to our host/port for the duration of the
test.
@end deffn

@geindex bind_unix_socket() (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper bind_unix_socket}@anchor{43b4}
@deffn {Função} test.support.socket_helper.bind_unix_socket (sock, addr)

Bind a Unix socket, raising @ref{101a,,unittest.SkipTest} if
@ref{d65,,PermissionError} is raised.
@end deffn

@geindex skip_unless_bind_unix_socket() (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper skip_unless_bind_unix_socket}@anchor{43b5}
@deffn {Função} @@test.support.socket_helper.skip_unless_bind_unix_socket

A decorator for running tests that require a functional @code{bind()} for Unix
sockets.
@end deffn

@geindex transient_internet() (no módulo test.support.socket_helper)
@anchor{library/test test support socket_helper transient_internet}@anchor{4355}
@deffn {Função} test.support.socket_helper.transient_internet (resource_name, *, timeout=30.0, errnos=())

A context manager that raises @ref{434f,,ResourceDenied} when
various issues with the internet connection manifest themselves as
exceptions.
@end deffn

@node test support script_helper — Utilities for the Python execution tests,test support bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode,test support socket_helper — Utilities for socket tests,Ferramentas de Desenvolvimento
@anchor{library/test module-test support script_helper}@anchor{e8}@anchor{library/test test-support-script-helper-utilities-for-the-python-execution-tests}@anchor{43b6}
@subsection @code{test.support.script_helper} — Utilities for the Python execution tests


@geindex module; test.support.script_helper

The @ref{e8,,test.support.script_helper} module provides support for Python’s
script execution tests.

@geindex interpreter_requires_environment() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper interpreter_requires_environment}@anchor{43b7}
@deffn {Função} test.support.script_helper.interpreter_requires_environment ()

Return @code{True} if @code{sys.executable interpreter} requires environment
variables in order to be able to run at all.

This is designed to be used with @code{@@unittest.skipIf()} to annotate tests
that need to use an @code{assert_python*()} function to launch an isolated
mode (@code{-I}) or no environment mode (@code{-E}) sub-interpreter process.

A normal build & test does not run into this situation but it can happen
when trying to run the standard library test suite from an interpreter that
doesn’t have an obvious home with Python’s current home finding logic.

Setting 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} is one way to get most of the testsuite to run
in that situation.  
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} or 
@geindex PYTHONUSERSITE
@geindex variável de ambiente; PYTHONUSERSITE
@code{PYTHONUSERSITE} are
other common environment variables that might impact whether or not the
interpreter can start.
@end deffn

@geindex run_python_until_end() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper run_python_until_end}@anchor{43b8}
@deffn {Função} test.support.script_helper.run_python_until_end (*args, **env_vars)

Set up the environment based on `env_vars' for running the interpreter
in a subprocess.  The values can include @code{__isolated}, @code{__cleanenv},
@code{__cwd}, and @code{TERM}.


Alterado na versão 3.9: The function no longer strips whitespaces from `stderr'.

@end deffn

@geindex assert_python_ok() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper assert_python_ok}@anchor{43b9}
@deffn {Função} test.support.script_helper.assert_python_ok (*args, **env_vars)

Assert that running the interpreter with `args' and optional environment
variables `env_vars' succeeds (@code{rc == 0}) and return a @code{(return code,
stdout, stderr)} tuple.

If the `__cleanenv' keyword-only parameter is set, `env_vars' is used as a fresh
environment.

Python is started in isolated mode (command line option @code{-I}),
except if the `__isolated' keyword-only parameter is set to @code{False}.


Alterado na versão 3.9: The function no longer strips whitespaces from `stderr'.

@end deffn

@geindex assert_python_failure() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper assert_python_failure}@anchor{43ba}
@deffn {Função} test.support.script_helper.assert_python_failure (*args, **env_vars)

Assert that running the interpreter with `args' and optional environment
variables `env_vars' fails (@code{rc != 0}) and return a @code{(return code,
stdout, stderr)} tuple.

See @ref{43b9,,assert_python_ok()} for more options.


Alterado na versão 3.9: The function no longer strips whitespaces from `stderr'.

@end deffn

@geindex spawn_python() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper spawn_python}@anchor{43bb}
@deffn {Função} test.support.script_helper.spawn_python (*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)

Run a Python subprocess with the given arguments.

`kw' is extra keyword args to pass to @ref{199,,subprocess.Popen()}. Returns a
@ref{199,,subprocess.Popen} object.
@end deffn

@geindex kill_python() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper kill_python}@anchor{43bc}
@deffn {Função} test.support.script_helper.kill_python (p)

Run the given @ref{199,,subprocess.Popen} process until completion and return
stdout.
@end deffn

@geindex make_script() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper make_script}@anchor{43bd}
@deffn {Função} test.support.script_helper.make_script (script_dir, script_basename, source, omit_suffix=False)

Cria um script contendo `source' no caminho `script_dir' e `script_basename'. Se `omit_suffix' @code{False}, acrescente @code{.py} ao nome. Retorna o caminho completo do script.
@end deffn

@geindex make_zip_script() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper make_zip_script}@anchor{43be}
@deffn {Função} test.support.script_helper.make_zip_script (zip_dir, zip_basename, script_name, name_in_zip=None)

Cria um arquivo zip em `zip_dir' e `zip_basename' com a extensão @code{zip} que contém os arquivos em `script_name'. `name_in_zip' é o nome do arquivo. Retorna uma tupla contendo @code{(full path, full path of archive name)}.
@end deffn

@geindex make_pkg() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper make_pkg}@anchor{43bf}
@deffn {Função} test.support.script_helper.make_pkg (pkg_dir, init_source='@w{'})

Cria um diretório nomeado `pkg_dir' contendo um arquivo @code{__init__} com `init_source' como seus conteúdos.
@end deffn

@geindex make_zip_pkg() (no módulo test.support.script_helper)
@anchor{library/test test support script_helper make_zip_pkg}@anchor{43c0}
@deffn {Função} test.support.script_helper.make_zip_pkg (zip_dir, zip_basename, pkg_name, script_basename, source, depth=1, compiled=False)

Create a zip package directory with a path of `zip_dir' and `zip_basename'
containing an empty @code{__init__} file and a file `script_basename'
containing the `source'.  If `compiled' is @code{True}, both source files will
be compiled and added to the zip package.  Return a tuple of the full zip
path and the archive name for the zip file.
@end deffn

@node test support bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode,test support threading_helper — Utilities for threading tests,test support script_helper — Utilities for the Python execution tests,Ferramentas de Desenvolvimento
@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{43c1}
@subsection @code{test.support.bytecode_helper} — Ferramentas de suporte para testar a geração correta de bytecode


@geindex module; test.support.bytecode_helper

The @ref{e5,,test.support.bytecode_helper} module provides support for testing
and inspecting bytecode generation.


Adicionado na versão 3.9.


O módulo define a seguinte classe:

@geindex BytecodeTestCase (classe em test.support.bytecode_helper)
@anchor{library/test test support bytecode_helper BytecodeTestCase}@anchor{43c2}
@deffn {Classe} test.support.bytecode_helper.BytecodeTestCase (unittest.TestCase)

This class has custom assertion methods for inspecting bytecode.
@end deffn

@geindex get_disassembly_as_string() (método test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase get_disassembly_as_string}@anchor{43c3}
@deffn {Método} BytecodeTestCase.get_disassembly_as_string (co)

Return the disassembly of `co' as string.
@end deffn

@geindex assertInBytecode() (método test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase assertInBytecode}@anchor{43c4}
@deffn {Método} BytecodeTestCase.assertInBytecode (x, opname, argval=_UNSPECIFIED)

Return instr if `opname' is found, otherwise throws @ref{6a9,,AssertionError}.
@end deffn

@geindex assertNotInBytecode() (método test.support.bytecode_helper.BytecodeTestCase)
@anchor{library/test test support bytecode_helper BytecodeTestCase assertNotInBytecode}@anchor{43c5}
@deffn {Método} BytecodeTestCase.assertNotInBytecode (x, opname, argval=_UNSPECIFIED)

Throws @ref{6a9,,AssertionError} if `opname' is found.
@end deffn

@node test support threading_helper — Utilities for threading tests,test support os_helper — Utilities for os tests,test support bytecode_helper — Ferramentas de suporte para testar a geração correta de bytecode,Ferramentas de Desenvolvimento
@anchor{library/test module-test support threading_helper}@anchor{ea}@anchor{library/test test-support-threading-helper-utilities-for-threading-tests}@anchor{43c6}
@subsection @code{test.support.threading_helper} — Utilities for threading tests


@geindex module; test.support.threading_helper

The @ref{ea,,test.support.threading_helper} module provides support for threading tests.


Adicionado na versão 3.10.


@geindex join_thread() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper join_thread}@anchor{43c7}
@deffn {Função} test.support.threading_helper.join_thread (thread, timeout=None)

Join a `thread' within `timeout'.  Raise an @ref{6a9,,AssertionError} if thread
is still alive after `timeout' seconds.
@end deffn

@geindex reap_threads() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper reap_threads}@anchor{43c8}
@deffn {Função} @@test.support.threading_helper.reap_threads

Decorator to ensure the threads are cleaned up even if the test fails.
@end deffn

@geindex start_threads() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper start_threads}@anchor{43c9}
@deffn {Função} test.support.threading_helper.start_threads (threads, unlock=None)

Context manager to start `threads', which is a sequence of threads.
`unlock' is a function called after the threads are started, even if an
exception was raised; an example would be @ref{3316,,threading.Event.set()}.
@code{start_threads} will attempt to join the started threads upon exit.
@end deffn

@geindex threading_cleanup() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper threading_cleanup}@anchor{43ca}
@deffn {Função} test.support.threading_helper.threading_cleanup (*original_values)

Cleanup up threads not specified in `original_values'.  Designed to emit
a warning if a test leaves running threads in the background.
@end deffn

@geindex threading_setup() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper threading_setup}@anchor{43cb}
@deffn {Função} test.support.threading_helper.threading_setup ()

Return current thread count and copy of dangling threads.
@end deffn

@geindex wait_threads_exit() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper wait_threads_exit}@anchor{43cc}
@deffn {Função} test.support.threading_helper.wait_threads_exit (timeout=None)

Context manager to wait until all threads created in the @code{with} statement
exit.
@end deffn

@geindex catch_threading_exception() (no módulo test.support.threading_helper)
@anchor{library/test test support threading_helper catch_threading_exception}@anchor{43cd}
@deffn {Função} test.support.threading_helper.catch_threading_exception ()

Context manager catching @ref{953,,threading.Thread} exception using
@ref{84e,,threading.excepthook()}.

Attributes set when an exception is caught:


@itemize *

@item 
@code{exc_type}

@item 
@code{exc_value}

@item 
@code{exc_traceback}

@item 
@code{thread}
@end itemize

See @ref{84e,,threading.excepthook()} documentation.

These attributes are deleted at the context manager exit.

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


Adicionado na versão 3.8.

@end deffn

@node test support os_helper — Utilities for os tests,test support import_helper — Utilities for import tests,test support threading_helper — Utilities for threading tests,Ferramentas de Desenvolvimento
@anchor{library/test module-test support os_helper}@anchor{e7}@anchor{library/test test-support-os-helper-utilities-for-os-tests}@anchor{43ce}
@subsection @code{test.support.os_helper} — Utilities for os tests


@geindex module; test.support.os_helper

The @ref{e7,,test.support.os_helper} module provides support for os tests.


Adicionado na versão 3.10.


@geindex FS_NONASCII (no módulo test.support.os_helper)
@anchor{library/test test support os_helper FS_NONASCII}@anchor{43cf}
@deffn {Dado} test.support.os_helper.FS_NONASCII

A non-ASCII character encodable by @ref{c70,,os.fsencode()}.
@end deffn

@geindex SAVEDCWD (no módulo test.support.os_helper)
@anchor{library/test test support os_helper SAVEDCWD}@anchor{43d0}
@deffn {Dado} test.support.os_helper.SAVEDCWD

Set to @ref{1682,,os.getcwd()}.
@end deffn

@geindex TESTFN (no módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN}@anchor{43d1}
@deffn {Dado} test.support.os_helper.TESTFN

Set to a name that is safe to use as the name of a temporary file.  Any
temporary file that is created should be closed and unlinked (removed).
@end deffn

@geindex TESTFN_NONASCII (no módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_NONASCII}@anchor{43d2}
@deffn {Dado} test.support.os_helper.TESTFN_NONASCII

Set to a filename containing the @ref{43cf,,FS_NONASCII} character, if it exists.
This guarantees that if the filename exists, it can be encoded and decoded
with the default filesystem encoding. This allows tests that require a
non-ASCII filename to be easily skipped on platforms where they can’t work.
@end deffn

@geindex TESTFN_UNENCODABLE (no módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNENCODABLE}@anchor{43d3}
@deffn {Dado} test.support.os_helper.TESTFN_UNENCODABLE

Define o nome de arquivo (tipo str) que não pode ser codificado pela codificação do sistema de arquivos no modo estrito. Ele pode ser @code{None} se não for possível gerar como um nome de arquivo.
@end deffn

@geindex TESTFN_UNDECODABLE (no módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNDECODABLE}@anchor{43d4}
@deffn {Dado} test.support.os_helper.TESTFN_UNDECODABLE

Define o nome de arquivo (tipo str) que não pode ser codificado pela codificação do sistema de arquivos no modo estrito. Ele pode ser @code{None} se não for possível ser gerado com um nome de arquivo.
@end deffn

@geindex TESTFN_UNICODE (no módulo test.support.os_helper)
@anchor{library/test test support os_helper TESTFN_UNICODE}@anchor{43d5}
@deffn {Dado} test.support.os_helper.TESTFN_UNICODE

Define um nome não-ASCII para o arquivo temporário.
@end deffn

@geindex EnvironmentVarGuard (classe em test.support.os_helper)
@anchor{library/test test support os_helper EnvironmentVarGuard}@anchor{1429}
@deffn {Classe} test.support.os_helper.EnvironmentVarGuard

Class used to temporarily set or unset environment variables.  Instances can
be used as a context manager and have a complete dictionary interface for
querying/modifying the underlying @code{os.environ}. After exit from the
context manager all changes to environment variables done through this
instance will be rolled back.


Alterado na versão 3.1: Adicionada uma interface para dicionário.

@end deffn

@geindex FakePath (classe em test.support.os_helper)
@anchor{library/test test support os_helper FakePath}@anchor{43d6}
@deffn {Classe} test.support.os_helper.FakePath (path)

Simple @ref{2a0,,path-like object}.  It implements the
@ref{c6d,,__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 test.support.os_helper.EnvironmentVarGuard)
@anchor{library/test test support os_helper EnvironmentVarGuard set}@anchor{43d7}
@deffn {Método} EnvironmentVarGuard.set (envvar, value)

Temporariamente define a variável de ambiente @code{envvar} para o valor @code{value}.
@end deffn

@geindex unset() (método test.support.os_helper.EnvironmentVarGuard)
@anchor{library/test test support os_helper EnvironmentVarGuard unset}@anchor{43d8}
@deffn {Método} EnvironmentVarGuard.unset (envvar)

Desativa temporariamente a variável de ambiente @code{envvar}.
@end deffn

@geindex can_symlink() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper can_symlink}@anchor{43d9}
@deffn {Função} test.support.os_helper.can_symlink ()

Return @code{True} if the OS supports symbolic links, @code{False}
otherwise.
@end deffn

@geindex can_xattr() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper can_xattr}@anchor{43da}
@deffn {Função} test.support.os_helper.can_xattr ()

Return @code{True} if the OS supports xattr, @code{False}
otherwise.
@end deffn

@geindex change_cwd() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper change_cwd}@anchor{43db}
@deffn {Função} test.support.os_helper.change_cwd (path, quiet=False)

A context manager that temporarily changes the current working
directory to `path' and yields the directory.

If `quiet' is @code{False}, the context manager raises an exception
on error.  Otherwise, it issues only a warning and keeps the current
working directory the same.
@end deffn

@geindex create_empty_file() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper create_empty_file}@anchor{43dc}
@deffn {Função} test.support.os_helper.create_empty_file (filename)

Create an empty file with `filename'.  If it already exists, truncate it.
@end deffn

@geindex fd_count() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper fd_count}@anchor{43dd}
@deffn {Função} test.support.os_helper.fd_count ()

Conta o número de descritores de arquivos abertos.
@end deffn

@geindex fs_is_case_insensitive() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper fs_is_case_insensitive}@anchor{43de}
@deffn {Função} test.support.os_helper.fs_is_case_insensitive (directory)

Return @code{True} if the file system for `directory' is case-insensitive.
@end deffn

@geindex make_bad_fd() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper make_bad_fd}@anchor{43df}
@deffn {Função} test.support.os_helper.make_bad_fd ()

Cria um descritor de arquivo inválido abrindo e fechando um arquivo temporário e retornando seu descritor.
@end deffn

@geindex rmdir() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper rmdir}@anchor{43e0}
@deffn {Função} test.support.os_helper.rmdir (filename)

Call @ref{1132,,os.rmdir()} on `filename'.  On Windows platforms, this is
wrapped with a wait loop that checks for the existence of the file,
which is needed due to antivirus programs that can hold files open and prevent
deletion.
@end deffn

@geindex rmtree() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper rmtree}@anchor{43e1}
@deffn {Função} test.support.os_helper.rmtree (path)

Call @ref{301,,shutil.rmtree()} on `path' or call @ref{4a1,,os.lstat()} and
@ref{1132,,os.rmdir()} to remove a path and its contents.  As with @ref{43e0,,rmdir()},
on Windows platforms
this is wrapped with a wait loop that checks for the existence of the files.
@end deffn

@geindex skip_unless_symlink() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper skip_unless_symlink}@anchor{43e2}
@deffn {Função} @@test.support.os_helper.skip_unless_symlink

Um decorador para executar testes que requerem suporte para links simbólicos.
@end deffn

@geindex skip_unless_xattr() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper skip_unless_xattr}@anchor{43e3}
@deffn {Função} @@test.support.os_helper.skip_unless_xattr

Um decorador para execução de testes que requerem suporte para xattr.
@end deffn

@geindex temp_cwd() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_cwd}@anchor{43e4}
@deffn {Função} test.support.os_helper.temp_cwd (name='tempcwd', quiet=False)

Um gerenciador de contexto que cria temporariamente um novo diretório e altera o diretório de trabalho atual (CWD).

The context manager creates a temporary directory in the current
directory with name `name' before temporarily changing the current
working directory.  If `name' is @code{None}, the temporary directory is
created using @ref{21f,,tempfile.mkdtemp()}.

Se `quiet' é @code{False} e ele não possibilita criar ou alterar o CWD, um erro é levantado. Por outro lado, somente um aviso surge e o CWD original é utilizado.
@end deffn

@geindex temp_dir() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_dir}@anchor{43e5}
@deffn {Função} test.support.os_helper.temp_dir (path=None, quiet=False)

Um gerenciador de contexto que cria um diretório temporário no `path' e produz o diretório.

If `path' is @code{None}, the temporary directory is created using
@ref{21f,,tempfile.mkdtemp()}.  If `quiet' is @code{False}, the context manager
raises an exception on error.  Otherwise, if `path' is specified and
cannot be created, only a warning is issued.
@end deffn

@geindex temp_umask() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper temp_umask}@anchor{43e6}
@deffn {Função} test.support.os_helper.temp_umask (umask)

Um gerenciador de contexto que temporariamente define o umask do processo.
@end deffn

@geindex unlink() (no módulo test.support.os_helper)
@anchor{library/test test support os_helper unlink}@anchor{43e7}
@deffn {Função} test.support.os_helper.unlink (filename)

Call @ref{1134,,os.unlink()} on `filename'.  As with @ref{43e0,,rmdir()},
on Windows platforms, this is
wrapped with a wait loop that checks for the existence of the file.
@end deffn

@node test support import_helper — Utilities for import tests,test support warnings_helper — Utilities for warnings tests,test support os_helper — Utilities for os tests,Ferramentas de Desenvolvimento
@anchor{library/test module-test support import_helper}@anchor{e6}@anchor{library/test test-support-import-helper-utilities-for-import-tests}@anchor{43e8}
@subsection @code{test.support.import_helper} — Utilities for import tests


@geindex module; test.support.import_helper

The @ref{e6,,test.support.import_helper} module provides support for import tests.


Adicionado na versão 3.10.


@geindex forget() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper forget}@anchor{43e9}
@deffn {Função} test.support.import_helper.forget (module_name)

Remove the module named `module_name' from @code{sys.modules} and delete any
byte-compiled files of the module.
@end deffn

@geindex import_fresh_module() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper import_fresh_module}@anchor{19ed}
@deffn {Função} test.support.import_helper.import_fresh_module (name, fresh=(), blocked=(), deprecated=False)

This function imports and returns a fresh copy of the named Python module
by removing the named module from @code{sys.modules} before doing the import.
Note that unlike @code{reload()}, the original module is not affected by
this operation.

`fresh' is an iterable of additional module names that are also removed
from the @code{sys.modules} cache before doing the import.

`blocked' is an iterable of module names that are replaced with @code{None}
in the module cache during the import to ensure that attempts to import
them raise @ref{419,,ImportError}.

The named module and any modules named in the `fresh' and `blocked'
parameters are saved before starting the import and then reinserted into
@code{sys.modules} when the fresh import is complete.

Module and package deprecation messages are suppressed during this import
if `deprecated' is @code{True}.

This function will raise @ref{419,,ImportError} if the named module cannot be
imported.

Exemplo 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


Adicionado na versão 3.1.

@end deffn

@geindex import_module() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper import_module}@anchor{43ea}
@deffn {Função} test.support.import_helper.import_module (name, deprecated=False, *, required_on=())

This function imports and returns the named module. Unlike a normal
import, this function raises @ref{101a,,unittest.SkipTest} if the module
cannot be imported.

Module and package deprecation messages are suppressed during this import
if `deprecated' is @code{True}.  If a module is required on a platform but
optional for others, set `required_on' to an iterable of platform prefixes
which will be compared against @ref{a97,,sys.platform}.


Adicionado na versão 3.1.

@end deffn

@geindex modules_setup() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper modules_setup}@anchor{43eb}
@deffn {Função} test.support.import_helper.modules_setup ()

Retorna a cópia de @ref{1636,,sys.modules}.
@end deffn

@geindex modules_cleanup() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper modules_cleanup}@anchor{43ec}
@deffn {Função} test.support.import_helper.modules_cleanup (oldmodules)

Remove modules except for `oldmodules' and @code{encodings} in order to
preserve internal cache.
@end deffn

@geindex unload() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper unload}@anchor{43ed}
@deffn {Função} test.support.import_helper.unload (name)

Exclui o `name' de @code{sys.modules}.
@end deffn

@geindex make_legacy_pyc() (no módulo test.support.import_helper)
@anchor{library/test test support import_helper make_legacy_pyc}@anchor{43ee}
@deffn {Função} test.support.import_helper.make_legacy_pyc (source)

Move a 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} pyc file to its legacy pyc location and return the file
system path to the legacy pyc file.  The `source' value is the file system
path to the source file.  It does not need to exist, however the PEP
3147/488 pyc file must exist.
@end deffn

@geindex CleanImport (classe em test.support.import_helper)
@anchor{library/test test support import_helper CleanImport}@anchor{43ef}
@deffn {Classe} test.support.import_helper.CleanImport (*module_names)

A context manager to force import to return a new module reference.  This
is useful for testing module-level behaviors, such as the emission of a
@ref{1a5,,DeprecationWarning} on import.  Example usage:

@example
with CleanImport('foo'):
    importlib.import_module('foo')  # New reference.
@end example
@end deffn

@geindex DirsOnSysPath (classe em test.support.import_helper)
@anchor{library/test test support import_helper DirsOnSysPath}@anchor{43f0}
@deffn {Classe} test.support.import_helper.DirsOnSysPath (*paths)

A context manager to temporarily add directories to @ref{3b4,,sys.path}.

This makes a copy of @ref{3b4,,sys.path}, appends any directories given
as positional arguments, then reverts @ref{3b4,,sys.path} to the copied
settings when the context ends.

Note that `all' @ref{3b4,,sys.path} modifications in the body of the
context manager, including replacement of the object,
will be reverted at the end of the block.
@end deffn

@node test support warnings_helper — Utilities for warnings tests,,test support import_helper — Utilities for import tests,Ferramentas de Desenvolvimento
@anchor{library/test module-test support warnings_helper}@anchor{eb}@anchor{library/test test-support-warnings-helper-utilities-for-warnings-tests}@anchor{43f1}
@subsection @code{test.support.warnings_helper} — Utilities for warnings tests


@geindex module; test.support.warnings_helper

The @ref{eb,,test.support.warnings_helper} module provides support for warnings tests.


Adicionado na versão 3.10.


@geindex ignore_warnings() (no módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper ignore_warnings}@anchor{43f2}
@deffn {Função} test.support.warnings_helper.ignore_warnings (*, category)

Suppress warnings that are instances of `category',
which must be @ref{244a,,Warning} or a subclass.
Roughly equivalent to @ref{584,,warnings.catch_warnings()}
with @ref{6c1,,warnings.simplefilter('ignore'@comma{} category=category)}.
For example:

@example
@@warning_helper.ignore_warnings(category=DeprecationWarning)
def test_suppress_warning():
    # do something
@end example


Adicionado na versão 3.8.

@end deffn

@geindex check_no_resource_warning() (no módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_no_resource_warning}@anchor{43f3}
@deffn {Função} test.support.warnings_helper.check_no_resource_warning (testcase)

Context manager to check that no @ref{244,,ResourceWarning} was raised.  You
must remove the object which may emit @ref{244,,ResourceWarning} before the
end of the context manager.
@end deffn

@geindex check_syntax_warning() (no módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_syntax_warning}@anchor{43f4}
@deffn {Função} test.support.warnings_helper.check_syntax_warning (testcase, statement, errtext='@w{'}, *, lineno=1, offset=None)

Test for syntax warning in `statement' by attempting to compile `statement'.
Test also that the @ref{466,,SyntaxWarning} is emitted only once, and that it
will be converted to a @ref{18d,,SyntaxError} when turned into error.
`testcase' is the @ref{106,,unittest} instance for the test.  `errtext' is the
regular expression which should match the string representation of the
emitted @ref{466,,SyntaxWarning} and raised @ref{18d,,SyntaxError}.  If `lineno'
is not @code{None}, compares to the line of the warning and exception.
If `offset' is not @code{None}, compares to the offset of the exception.


Adicionado na versão 3.8.

@end deffn

@geindex check_warnings() (no módulo test.support.warnings_helper)
@anchor{library/test test support warnings_helper check_warnings}@anchor{43f5}
@deffn {Função} test.support.warnings_helper.check_warnings (*filters, quiet=True)

A convenience wrapper for @ref{584,,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{6c1,,warnings.simplefilter()} set to @code{always} and with the option to
automatically validate the results that are recorded.

@code{check_warnings} accepts 2-tuples of the form @code{("message regexp",
WarningCategory)} as positional arguments. If one or more `filters' are
provided, or if the optional keyword argument `quiet' is @code{False},
it checks to make sure the warnings are as expected:  each specified filter
must match at least one of the warnings raised by the enclosed code or the
test fails, and if any warnings are raised that do not match any of the
specified filters the test fails.  To disable the first of these checks,
set `quiet' to @code{True}.

Se nenhum argumento é especificado, o padrão é:

@example
check_warnings(("", Warning), quiet=True)
@end example

Nesse caso, todos os avisos são capturados e nenhum erro é gerado.

On entry to the context manager, a @code{WarningRecorder} instance is
returned. The underlying warnings list from
@ref{584,,catch_warnings()} is available via the recorder object’s
@ref{112,,warnings} attribute.  As a convenience, the attributes of the object
representing the most recent warning can also be accessed directly through
the recorder object (see example below).  If no warning has been raised,
then any of the attributes that would otherwise be expected on an object
representing a warning will return @code{None}.

The recorder object also has a @code{reset()} method, which clears the
warnings list.

O gerenciador de contexto é desenhado para ser utilizado dessa forma:

@example
with check_warnings(("assertion is always true", SyntaxWarning),
                    ("", UserWarning)):
    exec('assert(False, "Hey!")')
    warnings.warn(UserWarning("Hide me!"))
@end example

No caso, se um aviso não foi levantado, ou algum outro aviso não foi levantado, @ref{43f5,,check_warnings()} deveria aparecer como um erro.

When a test needs to look more deeply into the warnings, rather than
just checking whether or not they occurred, code like this can be used:

@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

Aqui todos os avisos serão capturados e o código de teste testa os avisos diretamente capturados.


Alterado na versão 3.2: Novos argumentos opcionais `filters' e `quiet'.

@end deffn

@geindex WarningsRecorder (classe em test.support.warnings_helper)
@anchor{library/test test support warnings_helper WarningsRecorder}@anchor{43f6}
@deffn {Classe} test.support.warnings_helper.WarningsRecorder

Class used to record warnings for unit tests. See documentation of
@ref{43f5,,check_warnings()} above for more details.
@end deffn

@node Depuração e perfilamento,Empacotamento e Distribuição de Software,Ferramentas de Desenvolvimento,A Biblioteca Padrão do Python
@anchor{library/debug doc}@anchor{43f7}@anchor{library/debug debugging-and-profiling}@anchor{43f8}@anchor{library/debug translation-repo}@anchor{43f9}
@section Depuração e perfilamento


Essas bibliotecas ajudam no desenvolvimento do Python: o depurador permite que você percorra o código, analise os quadros de pilha e defina pontos de interrupção etc., e os criadores de perfil executam o código e fornecem uma análise detalhada dos tempos de execução, permitindo identificar gargalos em seus programas. Os eventos de auditoria fornecem visibilidade dos comportamentos de tempo de execução que, de outra forma, exigiriam depuração ou correção intrusiva.

@geindex eventos de auditoria
@anchor{library/audit_events audit-events}@anchor{199c}
@menu
* Tabela de eventos de auditoria:: 
* bdb — Framework do depurador:: 
* faulthandler — Dump the Python traceback:: 
* pdb — O depurador do Python:: 
* Os Profilers do Python:: 
* timeit — Mede o tempo de execução de pequenos trechos de código:: 
* trace — Rastreia ou acompanha a execução de instruções Python:: 
* tracemalloc — Trace memory allocations:: 

@end menu

@node Tabela de eventos de auditoria,bdb — Framework do depurador,,Depuração e perfilamento
@anchor{library/audit_events doc}@anchor{43fa}@anchor{library/audit_events audit-events-table}@anchor{43fb}
@subsection Tabela de eventos de auditoria


Esta tabela contém todos os eventos levantados por chamadas de @ref{16a0,,sys.audit()} ou @ref{36f,,PySys_Audit()} durante todo o tempo de execução do CPython e da biblioteca padrão. Essas chamadas foram adicionadas na versão 3.8 ou posterior (veja 
@geindex Propostas de Melhorias do Python; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/}).

Veja @ref{43fc,,sys.addaudithook()} e @ref{43fd,,PySys_AddAuditHook()} para informações sobre como tratar estes eventos.

Esta tabela é gerada a partir da documentação do CPython e pode não representar eventos levantados por outras implementações. Consulte a documentação específica de tempo de execução para obter eventos reais levantados.


@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{43fe,,[1]}

@item

array.__new__

@tab

@code{typecode}, @code{initializer}

@tab

@ref{1a0,,[1]}

@item

builtins.breakpoint

@tab

@code{breakpointhook}

@tab

@ref{234,,[1]}

@item

builtins.id

@tab

@code{id}

@tab

@ref{146a,,[1]}

@item

builtins.input

@tab

@code{prompt}

@tab

@ref{131b,,[1]}

@item

builtins.input/result

@tab

@code{result}

@tab

@ref{131b,,[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{2df,,[1]}

@item

compile

@tab

@code{source}, @code{filename}

@tab

@ref{192,,[1]}

@item

cpython.PyInterpreterState_Clear

@tab



@tab

@ref{43ff,,[1]}

@item

cpython.PyInterpreterState_New

@tab



@tab

@ref{4400,,[1]}

@item

cpython._PySys_ClearAuditHooks

@tab



@tab

@ref{d37,,[1]}

@item

cpython.run_command

@tab

@code{command}

@tab

@ref{5e0,,[1]}

@item

cpython.run_file

@tab

@code{filename}

@tab

@ref{4401,,[1]}

@item

cpython.run_interactivehook

@tab

@code{hook}

@tab

@ref{ffd,,[1]}

@item

cpython.run_module

@tab

@code{module-name}

@tab

@ref{5e1,,[1]}

@item

cpython.run_startup

@tab

@code{filename}

@tab

@ref{ffe,,[1]}

@item

cpython.run_stdin

@tab



@tab

@ref{4402,,[1]}@ref{4403,,[2]}@ref{4404,,[3]}

@item

ctypes.addressof

@tab

@code{obj}

@tab

@ref{301d,,[1]}

@item

ctypes.call_function

@tab

@code{func_pointer}, @code{arguments}

@tab

@ref{3015,,[1]}

@item

ctypes.cdata

@tab

@code{address}

@tab

@ref{302f,,[1]}

@item

ctypes.cdata/buffer

@tab

@code{pointer}, @code{size}, @code{offset}

@tab

@ref{302d,,[1]}@ref{302e,,[2]}

@item

ctypes.create_string_buffer

@tab

@code{init}, @code{size}

@tab

@ref{2fd3,,[1]}

@item

ctypes.create_unicode_buffer

@tab

@code{init}, @code{size}

@tab

@ref{1b46,,[1]}

@item

ctypes.dlopen

@tab

@code{name}

@tab

@ref{3013,,[1]}

@item

ctypes.dlsym

@tab

@code{library}, @code{name}

@tab

@ref{3013,,[1]}

@item

ctypes.dlsym/handle

@tab

@code{handle}, @code{name}

@tab

@ref{3013,,[1]}

@item

ctypes.get_errno

@tab



@tab

@ref{300d,,[1]}

@item

ctypes.get_last_error

@tab



@tab

@ref{300f,,[1]}

@item

ctypes.set_errno

@tab

@code{errno}

@tab

@ref{300e,,[1]}

@item

ctypes.set_exception

@tab

@code{code}

@tab

@ref{3015,,[1]}

@item

ctypes.set_last_error

@tab

@code{error}

@tab

@ref{3010,,[1]}

@item

ctypes.string_at

@tab

@code{ptr}, @code{size}

@tab

@ref{3026,,[1]}

@item

ctypes.wstring_at

@tab

@code{ptr}, @code{size}

@tab

@ref{3028,,[1]}

@item

ensurepip.bootstrap

@tab

@code{root}

@tab

@ref{4405,,[1]}

@item

exec

@tab

@code{code_object}

@tab

@ref{180,,[1]}@ref{17f,,[2]}

@item

fcntl.fcntl

@tab

@code{fd}, @code{cmd}, @code{arg}

@tab

@ref{3652,,[1]}

@item

fcntl.flock

@tab

@code{fd}, @code{operation}

@tab

@ref{4406,,[1]}

@item

fcntl.ioctl

@tab

@code{fd}, @code{request}, @code{arg}

@tab

@ref{14c3,,[1]}

@item

fcntl.lockf

@tab

@code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}

@tab

@ref{1433,,[1]}

@item

ftplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{3cb7,,[1]}

@item

ftplib.sendcmd

@tab

@code{self}, @code{cmd}

@tab

@ref{3cbc,,[1]}@ref{3cbd,,[2]}

@item

function.__new__

@tab

@code{code}

@tab

@ref{887,,[1]}

@item

gc.get_objects

@tab

@code{generation}

@tab

@ref{806,,[1]}

@item

gc.get_referents

@tab

@code{objs}

@tab

@ref{808,,[1]}

@item

gc.get_referrers

@tab

@code{objs}

@tab

@ref{807,,[1]}

@item

glob.glob

@tab

@code{pathname}, @code{recursive}

@tab

@ref{29f,,[1]}@ref{80a,,[2]}

@item

glob.glob/2

@tab

@code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}

@tab

@ref{29f,,[1]}@ref{80a,,[2]}

@item

http.client.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{3c9a,,[1]}

@item

http.client.send

@tab

@code{self}, @code{data}

@tab

@ref{3c9e,,[1]}

@item

imaplib.open

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{90b,,[1]}

@item

imaplib.send

@tab

@code{self}, @code{data}

@tab

@ref{3d0d,,[1]}

@item

import

@tab

@code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}

@tab

@ref{5e2,,[1]}

@item

marshal.dumps

@tab

@code{value}, @code{version}

@tab

@ref{2a76,,[1]}

@item

marshal.load

@tab



@tab

@ref{1b8b,,[1]}

@item

marshal.loads

@tab

@code{bytes}

@tab

@ref{1b8b,,[1]}

@item

mmap.__new__

@tab

@code{fileno}, @code{length}, @code{access}, @code{offset}

@tab

@ref{20b,,[1]}

@item

msvcrt.get_osfhandle

@tab

@code{fd}

@tab

@ref{4407,,[1]}

@item

msvcrt.locking

@tab

@code{fd}, @code{mode}, @code{nbytes}

@tab

@ref{4408,,[1]}

@item

msvcrt.open_osfhandle

@tab

@code{handle}, @code{flags}

@tab

@ref{4409,,[1]}

@item

object.__delattr__

@tab

@code{obj}, @code{name}

@tab

@ref{20c0,,[1]}

@item

object.__getattr__

@tab

@code{obj}, @code{name}

@tab

@ref{beb,,[1]}

@item

object.__setattr__

@tab

@code{obj}, @code{name}, @code{value}

@tab

@ref{20bf,,[1]}

@item

open

@tab

@code{path}, @code{mode}, @code{flags}

@tab

@ref{51c,,[1]}@ref{51d,,[2]}@ref{dba,,[3]}

@item

os.add_dll_directory

@tab

@code{path}

@tab

@ref{9f2,,[1]}

@item

os.chdir

@tab

@code{path}

@tab

@ref{60d,,[1]}@ref{db1,,[2]}

@item

os.chflags

@tab

@code{path}, @code{flags}

@tab

@ref{112c,,[1]}@ref{2d5b,,[2]}

@item

os.chmod

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{21b,,[1]}@ref{21c,,[2]}@ref{21a,,[3]}

@item

os.chown

@tab

@code{path}, @code{uid}, @code{gid}, @code{dir_fd}

@tab

@ref{112d,,[1]}@ref{db2,,[2]}@ref{2d5c,,[3]}

@item

os.exec

@tab

@code{path}, @code{args}, @code{env}

@tab

@ref{2d95,,[1]}

@item

os.fork

@tab



@tab

@ref{197,,[1]}

@item

os.forkpty

@tab



@tab

@ref{198,,[1]}

@item

os.fwalk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks}, @code{dir_fd}

@tab

@ref{b71,,[1]}

@item

os.getxattr

@tab

@code{path}, @code{attribute}

@tab

@ref{1143,,[1]}

@item

os.kill

@tab

@code{pid}, @code{sig}

@tab

@ref{13ae,,[1]}

@item

os.killpg

@tab

@code{pgid}, @code{sig}

@tab

@ref{1b4d,,[1]}

@item

os.link

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{112e,,[1]}

@item

os.listdir

@tab

@code{path}

@tab

@ref{1139,,[1]}

@item

os.listdrives

@tab



@tab

@ref{49d,,[1]}

@item

os.listmounts

@tab

@code{volume}

@tab

@ref{49f,,[1]}

@item

os.listvolumes

@tab



@tab

@ref{49e,,[1]}

@item

os.listxattr

@tab

@code{path}

@tab

@ref{1144,,[1]}

@item

os.lockf

@tab

@code{fd}, @code{cmd}, @code{len}

@tab

@ref{1152,,[1]}

@item

os.mkdir

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{21e,,[1]}@ref{21d,,[2]}

@item

os.posix_spawn

@tab

@code{path}, @code{argv}, @code{env}

@tab

@ref{220,,[1]}@ref{1ba7,,[2]}

@item

os.putenv

@tab

@code{key}, @code{value}

@tab

@ref{922,,[1]}

@item

os.remove

@tab

@code{path}, @code{dir_fd}

@tab

@ref{112f,,[1]}@ref{2d60,,[2]}@ref{1134,,[3]}

@item

os.removexattr

@tab

@code{path}, @code{attribute}

@tab

@ref{1145,,[1]}

@item

os.rename

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{1130,,[1]}@ref{2d61,,[2]}@ref{1131,,[3]}

@item

os.rmdir

@tab

@code{path}, @code{dir_fd}

@tab

@ref{1132,,[1]}

@item

os.scandir

@tab

@code{path}

@tab

@ref{a68,,[1]}

@item

os.setxattr

@tab

@code{path}, @code{attribute}, @code{value}, @code{flags}

@tab

@ref{1146,,[1]}

@item

os.spawn

@tab

@code{mode}, @code{path}, @code{args}, @code{env}

@tab

@ref{1826,,[1]}

@item

os.startfile

@tab

@code{path}, @code{operation}

@tab

@ref{1a0f,,[1]}

@item

os.startfile/2

@tab

@code{path}, @code{operation}, @code{arguments}, @code{cwd}, @code{show_cmd}

@tab

@ref{1a0f,,[1]}

@item

os.symlink

@tab

@code{src}, @code{dst}, @code{dir_fd}

@tab

@ref{1133,,[1]}

@item

os.system

@tab

@code{command}

@tab

@ref{14a5,,[1]}

@item

os.truncate

@tab

@code{fd}, @code{length}

@tab

@ref{db7,,[1]}@ref{e69,,[2]}

@item

os.unsetenv

@tab

@code{key}

@tab

@ref{921,,[1]}

@item

os.utime

@tab

@code{path}, @code{times}, @code{ns}, @code{dir_fd}

@tab

@ref{1135,,[1]}

@item

os.walk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{followlinks}

@tab

@ref{4a9,,[1]}

@item

pathlib.Path.glob

@tab

@code{self}, @code{pattern}

@tab

@ref{22d,,[1]}

@item

pathlib.Path.rglob

@tab

@code{self}, @code{pattern}

@tab

@ref{22e,,[1]}

@item

pdb.Pdb

@tab



@tab

@ref{928,,[1]}

@item

pickle.find_class

@tab

@code{module}, @code{name}

@tab

@ref{2a51,,[1]}

@item

poplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{92a,,[1]}@ref{92b,,[2]}

@item

poplib.putline

@tab

@code{self}, @code{line}

@tab

@ref{92a,,[1]}@ref{92b,,[2]}

@item

pty.spawn

@tab

@code{argv}

@tab

@ref{fb6,,[1]}

@item

resource.prlimit

@tab

@code{pid}, @code{resource}, @code{limits}

@tab

@ref{fbe,,[1]}

@item

resource.setrlimit

@tab

@code{resource}, @code{limits}

@tab

@ref{1605,,[1]}

@item

setopencodehook

@tab



@tab

@ref{181e,,[1]}

@item

shutil.chown

@tab

@code{path}, @code{user}, @code{group}

@tab

@ref{240,,[1]}

@item

shutil.copyfile

@tab

@code{src}, @code{dst}

@tab

@ref{a64,,[1]}@ref{a65,,[2]}@ref{a63,,[3]}

@item

shutil.copymode

@tab

@code{src}, @code{dst}

@tab

@ref{a64,,[1]}@ref{179f,,[2]}

@item

shutil.copystat

@tab

@code{src}, @code{dst}

@tab

@ref{a65,,[1]}@ref{116d,,[2]}

@item

shutil.copytree

@tab

@code{src}, @code{dst}

@tab

@ref{a33,,[1]}

@item

shutil.make_archive

@tab

@code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}

@tab

@ref{4b3,,[1]}

@item

shutil.move

@tab

@code{src}, @code{dst}

@tab

@ref{e82,,[1]}

@item

shutil.rmtree

@tab

@code{path}, @code{dir_fd}

@tab

@ref{301,,[1]}

@item

shutil.unpack_archive

@tab

@code{filename}, @code{extract_dir}, @code{format}

@tab

@ref{46b,,[1]}

@item

signal.pthread_kill

@tab

@code{thread_id}, @code{signalnum}

@tab

@ref{1170,,[1]}

@item

smtplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{1b41,,[1]}

@item

smtplib.send

@tab

@code{self}, @code{data}

@tab

@ref{934,,[1]}

@item

socket.__new__

@tab

@code{self}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{dc9,,[1]}

@item

socket.bind

@tab

@code{self}, @code{address}

@tab

@ref{1583,,[1]}

@item

socket.connect

@tab

@code{self}, @code{address}

@tab

@ref{dcb,,[1]}@ref{1582,,[2]}

@item

socket.getaddrinfo

@tab

@code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{184b,,[1]}

@item

socket.gethostbyaddr

@tab

@code{ip_address}

@tab

@ref{1a10,,[1]}

@item

socket.gethostbyname

@tab

@code{hostname}

@tab

@ref{3647,,[1]}@ref{1a11,,[2]}

@item

socket.gethostname

@tab



@tab

@ref{2d06,,[1]}

@item

socket.getnameinfo

@tab

@code{sockaddr}

@tab

@ref{17b6,,[1]}

@item

socket.getservbyname

@tab

@code{servicename}, @code{protocolname}

@tab

@ref{3649,,[1]}

@item

socket.getservbyport

@tab

@code{port}, @code{protocolname}

@tab

@ref{364a,,[1]}

@item

socket.sendmsg

@tab

@code{self}, @code{address}

@tab

@ref{476,,[1]}

@item

socket.sendto

@tab

@code{self}, @code{address}

@tab

@ref{dd1,,[1]}

@item

socket.sethostname

@tab

@code{name}

@tab

@ref{117a,,[1]}

@item

sqlite3.connect

@tab

@code{database}

@tab

@ref{2a8,,[1]}

@item

sqlite3.connect/handle

@tab

@code{connection_handle}

@tab

@ref{2a8,,[1]}

@item

sqlite3.enable_load_extension

@tab

@code{connection}, @code{enabled}

@tab

@ref{841,,[1]}

@item

sqlite3.load_extension

@tab

@code{connection}, @code{path}

@tab

@ref{4b8,,[1]}

@item

subprocess.Popen

@tab

@code{executable}, @code{args}, @code{cwd}, @code{env}

@tab

@ref{199,,[1]}

@item

sys._current_exceptions

@tab



@tab

@ref{4c2,,[1]}

@item

sys._current_frames

@tab



@tab

@ref{147a,,[1]}

@item

sys._getframe

@tab

@code{frame}

@tab

@ref{6e1,,[1]}

@item

sys._getframemodulename

@tab

@code{depth}

@tab

@ref{1867,,[1]}

@item

sys.addaudithook

@tab



@tab

@ref{43fd,,[1]}@ref{43fc,,[2]}

@item

sys.excepthook

@tab

@code{hook}, @code{type}, @code{value}, @code{traceback}

@tab

@ref{80e,,[1]}

@item

sys.monitoring.register_callback

@tab

@code{func}

@tab

@ref{440a,,[1]}

@item

sys.set_asyncgen_hooks_finalizer

@tab



@tab

@ref{1712,,[1]}

@item

sys.set_asyncgen_hooks_firstiter

@tab



@tab

@ref{1712,,[1]}

@item

sys.setprofile

@tab



@tab

@ref{1546,,[1]}

@item

sys.settrace

@tab



@tab

@ref{1547,,[1]}

@item

sys.unraisablehook

@tab

@code{hook}, @code{unraisable}

@tab

@ref{1f7,,[1]}

@item

syslog.closelog

@tab



@tab

@ref{53f,,[1]}

@item

syslog.openlog

@tab

@code{ident}, @code{logoption}, @code{facility}

@tab

@ref{53e,,[1]}

@item

syslog.setlogmask

@tab

@code{maskpri}

@tab

@ref{440b,,[1]}

@item

syslog.syslog

@tab

@code{priority}, @code{message}

@tab

@ref{540,,[1]}

@item

tempfile.mkdtemp

@tab

@code{fullpath}

@tab

@ref{1275,,[1]}@ref{21f,,[2]}

@item

tempfile.mkstemp

@tab

@code{fullpath}

@tab

@ref{4c6,,[1]}@ref{2a02,,[2]}@ref{2a03,,[3]}

@item

time.sleep

@tab

@code{secs}

@tab

@ref{440c,,[1]}

@item

urllib.Request

@tab

@code{fullurl}, @code{data}, @code{headers}, @code{method}

@tab

@ref{293,,[1]}

@item

webbrowser.open

@tab

@code{url}

@tab

@ref{3b73,,[1]}

@item

winreg.ConnectRegistry

@tab

@code{computer_name}, @code{key}

@tab

@ref{440d,,[1]}

@item

winreg.CreateKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{440e,,[1]}@ref{13a9,,[2]}

@item

winreg.DeleteKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{440f,,[1]}@ref{13aa,,[2]}

@item

winreg.DeleteValue

@tab

@code{key}, @code{value}

@tab

@ref{4410,,[1]}

@item

winreg.DisableReflectionKey

@tab

@code{key}

@tab

@ref{13ab,,[1]}

@item

winreg.EnableReflectionKey

@tab

@code{key}

@tab

@ref{13ac,,[1]}

@item

winreg.EnumKey

@tab

@code{key}, @code{index}

@tab

@ref{4411,,[1]}

@item

winreg.EnumValue

@tab

@code{key}, @code{index}

@tab

@ref{4412,,[1]}

@item

winreg.ExpandEnvironmentStrings

@tab

@code{str}

@tab

@ref{143f,,[1]}

@item

winreg.LoadKey

@tab

@code{key}, @code{sub_key}, @code{file_name}

@tab

@ref{4413,,[1]}

@item

winreg.OpenKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{4414,,[1]}

@item

winreg.OpenKey/result

@tab

@code{key}

@tab

@ref{440e,,[1]}@ref{13a9,,[2]}@ref{4414,,[3]}

@item

winreg.PyHKEY.Detach

@tab

@code{key}

@tab

@ref{4415,,[1]}

@item

winreg.QueryInfoKey

@tab

@code{key}

@tab

@ref{4416,,[1]}

@item

winreg.QueryReflectionKey

@tab

@code{key}

@tab

@ref{13ad,,[1]}

@item

winreg.QueryValue

@tab

@code{key}, @code{sub_key}, @code{value_name}

@tab

@ref{4417,,[1]}@ref{15ab,,[2]}

@item

winreg.SaveKey

@tab

@code{key}, @code{file_name}

@tab

@ref{4418,,[1]}

@item

winreg.SetValue

@tab

@code{key}, @code{sub_key}, @code{type}, @code{value}

@tab

@ref{4419,,[1]}@ref{188b,,[2]}

@end multitable


Os eventos a seguir são levantados internamente e não correspondem a nenhuma API pública de CPython:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Evento de auditoria

@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 — Framework do depurador,faulthandler — Dump the Python traceback,Tabela de eventos de auditoria,Depuração e perfilamento
@anchor{library/bdb doc}@anchor{441a}@anchor{library/bdb bdb-debugger-framework}@anchor{441b}@anchor{library/bdb module-bdb}@anchor{f}@anchor{library/bdb translation-repo}@anchor{441c}
@subsection @code{bdb} — Framework do depurador


@geindex module; bdb

`Código-fonte:' Lib/bdb.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/bdb.py}


__________________________________________________________________


O módulo @ref{f,,bdb}  lida com funções básicas do depurador, como definir pontos de interrupção ou gerenciar a execução por meio do depurador.

A seguinte exceção é definida:

@geindex BdbQuit
@anchor{library/bdb bdb BdbQuit}@anchor{441d}
@deffn {Exceção} bdb.BdbQuit

Exceção levantada pela classe @ref{1346,,Bdb} para sair do depurador.
@end deffn

O módulo @ref{f,,bdb} também define duas classes:

@geindex Breakpoint (classe em bdb)
@anchor{library/bdb bdb Breakpoint}@anchor{441e}
@deffn {Classe} bdb.Breakpoint (self, file, line, temporary=False, cond=None, funcname=None)

Esta classe implementa pontos de interrupção temporários, contagens de ignorar, desativação e (re)ativação, além de condicionais.

Os pontos de interrupção são indexados por número por meio de uma lista chamada @ref{441f,,bpbynumber} e por pares @code{(file, line)} por meio de @ref{4420,,bplist}. O primeiro aponta para uma única instância da classe @ref{441e,,Breakpoint}. O segundo aponta para uma lista dessas instâncias, já que pode haver mais de um ponto de interrupção por linha.

Ao criar um ponto de interrupção, seu @ref{4421,,nome do arquivo} associado deve estar no formato canônico. Se um @ref{4422,,funcname} for definido, um ponto de interrupção @ref{4423,,atingido} será contado quando a primeira linha dessa função for executada. Um ponto de interrupção @ref{4424,,condicional} sempre conta um @ref{4423,,atingido}.

As instâncias de @ref{441e,,Breakpoint} têm os seguintes métodos:

@geindex deleteMe() (método bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint deleteMe}@anchor{4425}
@deffn {Método} deleteMe ()

Exclui o ponto de interrupção da lista associada a um arquivo/linha.  Se for o último ponto de interrupção nessa posição, ele também excluirá a entrada do arquivo/linha.
@end deffn

@geindex enable() (método bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint enable}@anchor{4426}
@deffn {Método} enable ()

Marca o ponto de interrupção como ativado.
@end deffn

@geindex disable() (método bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint disable}@anchor{4427}
@deffn {Método} disable ()

Marca o ponto de interrupção como desativado.
@end deffn

@geindex bpformat() (método bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpformat}@anchor{4428}
@deffn {Método} bpformat ()

Retorna uma string com todas as informações sobre o ponto de interrupção, formatadas de maneira clara:


@itemize *

@item 
Número do ponto de interrupção.

@item 
Status temporário (del ou keep).

@item 
Posição do arquivo/linha.

@item 
Condição de interrupção.

@item 
Número de vezes para ignorar.

@item 
Número de vezes atingido.
@end itemize


Adicionado na versão 3.2.

@end deffn

@geindex bpprint() (método bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpprint}@anchor{4429}
@deffn {Método} bpprint (out=None)

Exibe a saída de @ref{4428,,bpformat()} no arquivo `out' ou, se for @code{None}, na saída padrão.
@end deffn

Instâncias @ref{441e,,Breakpoint} possuem os seguintes atributos:

@geindex file (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint file}@anchor{4421}
@deffn {Atributo} file

Nome do arquivo do @ref{441e,,Breakpoint}.
@end deffn

@geindex line (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint line}@anchor{442a}
@deffn {Atributo} line

Número da linha do @ref{441e,,Breakpoint} dentro de @ref{4421,,file}.
@end deffn

@geindex temporary (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint temporary}@anchor{442b}
@deffn {Atributo} temporary

@code{True} se um @ref{441e,,Breakpoint} em (file, line) for temporário.
@end deffn

@geindex cond (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint cond}@anchor{4424}
@deffn {Atributo} cond

Condição para avaliar um @ref{441e,,Breakpoint} em (file, line).
@end deffn

@geindex funcname (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint funcname}@anchor{4422}
@deffn {Atributo} funcname

Nome da função que define se um @ref{441e,,Breakpoint} é atingido ao entrar na função.
@end deffn

@geindex enabled (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint enabled}@anchor{442c}
@deffn {Atributo} enabled

@code{True} se @ref{441e,,Breakpoint} estiver ativado.
@end deffn

@geindex bpbynumber (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bpbynumber}@anchor{441f}
@deffn {Atributo} bpbynumber

Índice numérico de uma única instância de @ref{441e,,Breakpoint}.
@end deffn

@geindex bplist (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint bplist}@anchor{4420}
@deffn {Atributo} bplist

Dicionário de instâncias de @ref{441e,,Breakpoint} indexadas por tuplas (@ref{4421,,file}, @ref{442a,,line}).
@end deffn

@geindex ignore (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint ignore}@anchor{442d}
@deffn {Atributo} ignore

Número de vezes para ignorar o @ref{441e,,Breakpoint}.
@end deffn

@geindex hits (atributo bdb.Breakpoint)
@anchor{library/bdb bdb Breakpoint hits}@anchor{4423}
@deffn {Atributo} hits

Contagem do número de vezes que um @ref{441e,,Breakpoint} foi atingido.
@end deffn
@end deffn

@geindex Bdb (classe em bdb)
@anchor{library/bdb bdb Bdb}@anchor{1346}
@deffn {Classe} bdb.Bdb (skip=None)

A @ref{1346,,Bdb} atua como uma classe base genérica de depurador em Python.

Esta classe cuida dos detalhes do mecanismo de rastreamento; uma classe derivada deve implementar a interação com o usuário. A classe de depuração padrão (@ref{928,,pdb.Pdb}) é um exemplo.

O argumento `skip', se fornecido, deve ser um iterável de padrões de nomes de módulos no estilo glob. O depurador não entrará em frames que se originam em um módulo que corresponda a um desses padrões. Se um frame é considerado como originado em determinado módulo é determinado pelo valor de @code{__name__} nos globals do frame.


Alterado na versão 3.1: Adicionado o parâmetro `skip'.


Os seguintes métodos de @ref{1346,,Bdb} normalmente não precisam ser substituídos.

@geindex canonic() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb canonic}@anchor{442e}
@deffn {Método} canonic (filename)

Retorna a forma canônica de `filename'.

Para nomes de arquivos reais, a forma canônica é um @ref{135f,,caminho absoluto}, @ref{298f,,normalizado para distinguir maiúsculas e minúsculas}, dependente do sistema operacional. Um `filename' com colchetes angulares, como @code{"<stdin>"} gerado no modo interativo, é retornado sem alterações.
@end deffn

@geindex reset() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb reset}@anchor{442f}
@deffn {Método} reset ()

Define os atributos @code{botframe}, @code{stopframe}, @code{returnframe} e @ref{4430,,quitting} com valores prontos para iniciar a depuração.
@end deffn

@geindex trace_dispatch() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb trace_dispatch}@anchor{4431}
@deffn {Método} trace_dispatch (frame, event, arg)

Esta função é instalada como a função de rastreamento dos frames depurados. Seu valor de retorno é a nova função de rastreamento (na maioria dos casos, ela própria).

A implementação padrão decide como despachar um frame, dependendo do tipo de evento (passado como string) que está prestes a ser executado. `event' pode ser um dos seguintes:


@itemize *

@item 
@code{"line"}: Uma nova linha de código será executada.

@item 
@code{"call"}: Um função está prestes a ser chamada, ou outro bloco de código foi inserido.

@item 
@code{"retorno"}: Um função ou outro bloco de código está prestes a retornar.

@item 
@code{"exception"}: Ocorreu uma exceção.

@item 
@code{"c_call"}: Uma função C está prestes a ser chamada.

@item 
@code{"c_return"}: Uma função C retornou.

@item 
@code{"c_exception"}: Uma função C levantou uma exceção.
@end itemize

Para os eventos Python, são chamadas função especializadas (consulte abaixo).  Para os eventos de C, nenhuma ação é tomada.

O parâmetro `arg' depende do evento anterior.

Consulte a documentação de @ref{1547,,sys.settrace()} para mais informações sobre a função de rastreamento. Para mais informações sobre objetos de código e de frame, consulte @ref{2075,,A hierarquia de tipos padrão}.
@end deffn

@geindex dispatch_line() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_line}@anchor{4432}
@deffn {Método} dispatch_line (frame)

Se o depurador deve parar na linha atual, invoca o método @ref{4433,,user_line()} (que deve ser substituído em subclasses). Levanta a exceção @ref{441d,,BdbQuit} se o sinalizador @ref{4430,,quitting} estiver definido (ele pode ser definido a partir de @ref{4433,,user_line()}). Retorna uma referência ao método @ref{4431,,trace_dispatch()} para continuar o rastreamento nesse escopo.
@end deffn

@geindex dispatch_call() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_call}@anchor{4434}
@deffn {Método} dispatch_call (frame, arg)

Se o depurador deve parar nesta chamada de função, invoca o método @ref{4435,,user_call()} (que deve ser substituído em subclasses). Levanta a exceção @ref{441d,,BdbQuit} se o sinalizador @ref{4430,,quitting} estiver definido (ele pode ser definido a partir de @ref{4435,,user_call()}). Retorna uma referência ao método @ref{4431,,trace_dispatch()} para continuar o rastreamento nesse escopo.
@end deffn

@geindex dispatch_return() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_return}@anchor{4436}
@deffn {Método} dispatch_return (frame, arg)

Se o depurador deve parar no retorno desta função, invoca o método @ref{4437,,user_return()} (que deve ser substituído em subclasses). Levanta a exceção @ref{441d,,BdbQuit} se o sinalizador @ref{4430,,quitting} estiver definido (ele pode ser definido a partir de @ref{4437,,user_return()}). Retorna uma referência ao método @ref{4431,,trace_dispatch()} para continuar o rastreamento nesse escopo.
@end deffn

@geindex dispatch_exception() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb dispatch_exception}@anchor{4438}
@deffn {Método} dispatch_exception (frame, arg)

Se o depurador deve parar nesta exceção, invoca o método @ref{4439,,user_exception()} (que deve ser substituído em subclasses). Levanta a exceção @ref{441d,,BdbQuit} se o sinalizador @ref{4430,,quitting} estiver definido (ele pode ser definido a partir de @ref{4439,,user_exception()}). Retorna uma referência ao método @ref{4431,,trace_dispatch()} para continuar o rastreamento nesse escopo.
@end deffn

Normalmente, as classes derivadas não substituem o seguinte métodos, mas podem fazê-lo se quiserem redefinir a definição de parada e  de pontos de interrupção.

@geindex is_skipped_module() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb is_skipped_module}@anchor{443a}
@deffn {Método} is_skipped_module (module_name)

Retorna @code{True} se `module_name' corresponder a algum padrão de skip.
@end deffn

@geindex stop_here() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb stop_here}@anchor{443b}
@deffn {Método} stop_here (frame)

Retorna @code{True} se frame estiver abaixo do frame inicial na pilha.
@end deffn

@geindex break_here() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb break_here}@anchor{443c}
@deffn {Método} break_here (frame)

Retorna @code{True} se houver um ponto de interrupção efetivo para essa linha.

Verifica se uma linha ou função ponto de interrupção existe e está em vigor.  Exclua os pontos de interrupção temporários com base nas informações de @ref{443d,,effective()}.
@end deffn

@geindex break_anywhere() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb break_anywhere}@anchor{443e}
@deffn {Método} break_anywhere (frame)

Retorna @code{True} se existir algum ponto de interrupção para o nome de arquivo de `frame'’s.
@end deffn

As classes derivadas devem substituir esses métodos para obter controle sobre a operação da depurador.

@geindex user_call() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb user_call}@anchor{4435}
@deffn {Método} user_call (frame, argument_list)

Chamado a partir de @ref{4434,,dispatch_call()} se um ponto de interrupção puder parar dentro da função chamada.

`argument_list' não é mais usado e sempre será @code{None}. O argumento é mantido por retrocompatibilidade.
@end deffn

@geindex user_line() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb user_line}@anchor{4433}
@deffn {Método} user_line (frame)

Chamado a partir de @ref{4432,,dispatch_line()} quando @ref{443b,,stop_here()} ou @ref{443c,,break_here()} retornam @code{True}.
@end deffn

@geindex user_return() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb user_return}@anchor{4437}
@deffn {Método} user_return (frame, return_value)

Chamado a partir de @ref{4436,,dispatch_return()} quando @ref{443b,,stop_here()} retorna @code{True}.
@end deffn

@geindex user_exception() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb user_exception}@anchor{4439}
@deffn {Método} user_exception (frame, exc_info)

Chamado a partir de @ref{4438,,dispatch_exception()} quando @ref{443b,,stop_here()} retorna @code{True}.
@end deffn

@geindex do_clear() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb do_clear}@anchor{443f}
@deffn {Método} do_clear (arg)

Manipula como um ponto de interrupção deve ser removido quando for temporário.

Esse método deve ser implementado por classes derivadas.
@end deffn

As classes derivadas e os clientes podem chamar os métodos a seguir para afetar o estado de stepping.

@geindex set_step() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_step}@anchor{4440}
@deffn {Método} set_step ()

Parar após uma linha de código.
@end deffn

@geindex set_next() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_next}@anchor{4441}
@deffn {Método} set_next (frame)

Parar na próxima linha no frame fornecido ou abaixo dele.
@end deffn

@geindex set_return() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_return}@anchor{4442}
@deffn {Método} set_return (frame)

Parar ao retornar do frame fornecido.
@end deffn

@geindex set_until() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_until}@anchor{4443}
@deffn {Método} set_until (frame, lineno=None)

Parar quando a linha com `lineno' maior que a atual for alcançada ou ao retornar do frame atual.
@end deffn

@geindex set_trace() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_trace}@anchor{4444}
@deffn {Método} set_trace ([frame])

Inicia a depuração a partir de `frame'. Se `frame' não for especificado, a depuração começa a partir do frame do chamador.


Alterado na versão 3.13: @ref{4445,,set_trace()} entrará no depurador imediatamente, em vez da próxima linha de código a ser executada.

@end deffn

@geindex set_continue() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_continue}@anchor{4446}
@deffn {Método} set_continue ()

Pare somente nos pontos de interrupção ou quando terminar.  Se não houver pontos de interrupção, defina o sistema função de rastreamento como @code{None}.
@end deffn

@geindex set_quit() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_quit}@anchor{4430}
@deffn {Método} set_quit ()

@geindex quitting (atributo de bdb.Bdb)

Defina o atributo @code{quitting} como @code{True}. Isso levanta @ref{441d,,BdbQuit} na próxima chamada de um dos métodos @code{dispatch_*()}.
@end deffn

Classes derivadas e clientes podem chamar os métodos a seguir para manipular pontos de interrupção. Esses métodos retornam uma string contendo uma mensagem de erro se algo der errado, ou @code{None} se tudo estiver correto.

@geindex set_break() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb set_break}@anchor{4447}
@deffn {Método} set_break (filename, lineno, temporary=False, cond=None, funcname=None)

Define um novo ponto de interrupção. Se a linha `lineno' não existir para o `filename' passado como argumento, retorna uma mensagem de erro. O `filename' deve estar na forma canônica, conforme descrito no método @ref{442e,,canonic()}.
@end deffn

@geindex clear_break() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_break}@anchor{4448}
@deffn {Método} clear_break (filename, lineno)

Exclui os pontos de interrupção em `filename' e `lineno'. Se nenhum tiver sido definido, retorna uma mensagem de erro.
@end deffn

@geindex clear_bpbynumber() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_bpbynumber}@anchor{4449}
@deffn {Método} clear_bpbynumber (arg)

Exclui o ponto de interrupção cujo índice é `arg' em @ref{441f,,Breakpoint.bpbynumber}. Se `arg' não for numérico ou estiver fora do intervalo, retorna uma mensagem de erro.
@end deffn

@geindex clear_all_file_breaks() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_all_file_breaks}@anchor{444a}
@deffn {Método} clear_all_file_breaks (filename)

Exclui todos os pontos de interrupção em `filename'. Se nenhum tiver sido definido, retorna uma mensagem de erro.
@end deffn

@geindex clear_all_breaks() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb clear_all_breaks}@anchor{444b}
@deffn {Método} clear_all_breaks ()

Exclui todos os pontos de interrupção existentes. Se nenhum tiver sido definido, retorna uma mensagem de erro.
@end deffn

@geindex get_bpbynumber() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_bpbynumber}@anchor{444c}
@deffn {Método} get_bpbynumber (arg)

Retorna o ponto de interrupção especificado pelo número fornecido. Se `arg' for uma string, ele será convertido para um número. Se `arg' for uma string não numérica, se o ponto de interrupção nunca tiver existido ou tiver sido excluído, uma @ref{202,,ValueError} será levantada.


Adicionado na versão 3.2.

@end deffn

@geindex get_break() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_break}@anchor{444d}
@deffn {Método} get_break (filename, lineno)

Retorna @code{True} se houver um ponto de interrupção para `lineno' em `filename'.
@end deffn

@geindex get_breaks() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_breaks}@anchor{444e}
@deffn {Método} get_breaks (filename, lineno)

Retorna todos os pontos de interrupção para `lineno' em `filename', ou uma lista vazia se nenhum estiver definido.
@end deffn

@geindex get_file_breaks() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_file_breaks}@anchor{444f}
@deffn {Método} get_file_breaks (filename)

Retorna todos os pontos de interrupção em `filename', ou uma lista vazia se nenhum estiver definido.
@end deffn

@geindex get_all_breaks() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_all_breaks}@anchor{4450}
@deffn {Método} get_all_breaks ()

Retorna todos os pontos de interrupção definidos.
@end deffn

Classes derivadas e clientes podem chamar os métodos a seguir para obter uma estrutura de dados que represente um stack trace (situação da pilha de execução).

@geindex get_stack() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb get_stack}@anchor{4451}
@deffn {Método} get_stack (f, t)

Retorna uma lista de tuplas (frame, lineno) em um stack trace e um tamanho.

O frame chamado mais recentemente é o último da lista. O tamanho é o número de frames abaixo do frame onde o depurador foi invocado.
@end deffn

@geindex format_stack_entry() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb format_stack_entry}@anchor{4452}
@deffn {Método} format_stack_entry (frame_lineno, lprefix=': ')

Retorna uma string com informações sobre uma entrada da pilha, que é uma tupla @code{(frame, lineno)}. A string retornada contém:


@itemize *

@item 
O nome de arquivo canônico que contém o quadro.

@item 
O nome da função ou @code{"<lambda>"}.

@item 
O argumento de entrada.

@item 
O valor de retorno.

@item 
A linha de código (se existir).
@end itemize
@end deffn

Os dois métodos a seguir podem ser chamados pelos clientes para usar um depurador e depurar uma @ref{2935,,instrução}, fornecida como uma string.

@geindex run() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb run}@anchor{4453}
@deffn {Método} run (cmd, globals=None, locals=None)

Depura uma instrução executada por meio da função @ref{17f,,exec()}. globals assume por padrão @code{__main__.__dict__}, locals assume por padrão globals.
@end deffn

@geindex runeval() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb runeval}@anchor{4454}
@deffn {Método} runeval (expr, globals=None, locals=None)

Depura uma expressão executada por meio da função @ref{180,,eval()}. globals e locals têm o mesmo significado que em @ref{4453,,run()}.
@end deffn

@geindex runctx() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb runctx}@anchor{4455}
@deffn {Método} runctx (cmd, globals, locals)

Por retrocompatibilidade. Chama o método @ref{4453,,run()}.
@end deffn

@geindex runcall() (método bdb.Bdb)
@anchor{library/bdb bdb Bdb runcall}@anchor{a88}
@deffn {Método} runcall (func, /, *args, **kwds)

Depura uma única chamada de função e retorna seu resultado.
@end deffn
@end deffn

Por fim, o módulo define as funções a seguir:

@geindex checkfuncname() (no módulo bdb)
@anchor{library/bdb bdb checkfuncname}@anchor{4456}
@deffn {Função} bdb.checkfuncname (b, frame)

Retorna @code{True} se devemos interromper aqui, dependendo da forma como o @ref{441e,,Breakpoint} foi configurado.

If it was set via line number, it checks if
@ref{442a,,b.line} is the same as the one in `frame'.
If the breakpoint was set via
@ref{4422,,function name}, we have to check we are in
the right `frame' (the right function) and if we are on its first executable
line.
@end deffn

@geindex effective() (no módulo bdb)
@anchor{library/bdb bdb effective}@anchor{443d}
@deffn {Função} bdb.effective (file, line, frame)

Retorna @code{(active breakpoint, delete temporary flag)} ou @code{(None, None)} como o ponto de interrupção sobre o qual agir.

The `active breakpoint' is the first entry in
@ref{4420,,bplist} for the
(@ref{4421,,file}, @ref{442a,,line})
(which must exist) that is @ref{442c,,enabled}, for
which @ref{4456,,checkfuncname()} is true, and that has neither a false
@ref{4424,,condition} nor positive
@ref{442d,,ignore} count.  The `flag', meaning that a
temporary breakpoint should be deleted, is @code{False} only when the
@ref{4424,,cond} cannot be evaluated (in which case,
@ref{442d,,ignore} count is ignored).

Se essa entrada não existir, será retornado @code{(None, None)}.
@end deffn

@geindex set_trace() (no módulo bdb)
@anchor{library/bdb bdb set_trace}@anchor{4445}
@deffn {Função} bdb.set_trace ()

Inicie a depuração com uma instância de @ref{1346,,Bdb} a partir do frame do chamador.
@end deffn

@node faulthandler — Dump the Python traceback,pdb — O depurador do Python,bdb — Framework do depurador,Depuração e perfilamento
@anchor{library/faulthandler doc}@anchor{4457}@anchor{library/faulthandler faulthandler-dump-the-python-traceback}@anchor{4458}@anchor{library/faulthandler module-faulthandler}@anchor{58}@anchor{library/faulthandler translation-repo}@anchor{4459}
@subsection @code{faulthandler} — Dump the Python traceback


@geindex module; faulthandler


Adicionado na versão 3.3.



__________________________________________________________________


This module contains functions to dump Python tracebacks explicitly, on a fault,
after a timeout, or on a user signal. Call @ref{cbe,,faulthandler.enable()} to
install fault handlers for the @ref{10b9,,SIGSEGV},
@ref{10ba,,SIGFPE}, @ref{10bb,,SIGABRT}, @ref{10bc,,SIGBUS}, and
@ref{10bd,,SIGILL} signals. You can also
enable them at startup by setting the 
@geindex PYTHONFAULTHANDLER
@geindex variável de ambiente; PYTHONFAULTHANDLER
@ref{10be,,PYTHONFAULTHANDLER} environment
variable or by using the @ref{176,,-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.

The fault handler is called on catastrophic cases and therefore can only use
signal-safe functions (e.g. it cannot allocate memory on the heap). Because of
this limitation traceback dumping is minimal compared to normal Python
tracebacks:


@itemize *

@item 
Only ASCII is supported. The @code{backslashreplace} error handler is used on
encoding.

@item 
Each string is limited to 500 characters.

@item 
Only the filename, the function name and the line number are
displayed. (no source code)

@item 
It is limited to 100 frames and 100 threads.

@item 
The order is reversed: the most recent call is shown first.
@end itemize

By default, the Python traceback is written to @ref{940,,sys.stderr}. To see
tracebacks, applications must be run in the terminal. A log file can
alternatively be passed to @ref{cbe,,faulthandler.enable()}.

The module is implemented in C, so tracebacks can be dumped on a crash or when
Python is deadlocked.

The @ref{1f8,,Python Development Mode} calls @ref{cbe,,faulthandler.enable()}
at Python startup.


@subsubheading Ver também



@table @asis

@item Module @ref{a5,,pdb}

Interactive source code debugger for Python programs.

@item Módulo @ref{fe,,traceback}

Interface padrão para extrair, formatar e imprimir rastreamentos de pilha de programas Python.
@end table


@menu
* Dumping the traceback:: 
* Fault handler state:: 
* Dumping the tracebacks after a timeout:: 
* Dumping the traceback on a user signal:: 
* Issue with file descriptors:: 
* Exemplo: Exemplo<13>. 

@end menu

@node Dumping the traceback,Fault handler state,,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-traceback}@anchor{445a}
@subsubsection Dumping the traceback


@geindex dump_traceback() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler dump_traceback}@anchor{e2a}
@deffn {Função} faulthandler.dump_traceback (file=sys.stderr, all_threads=True)

Dump the tracebacks of all threads into `file'. If `all_threads' is
@code{False}, dump only the current thread.


@subsubheading Ver também


@ref{eb4,,traceback.print_tb()}, which can be used to print a traceback object.



Alterado na versão 3.5: Added support for passing file descriptor to this function.

@end deffn

@node Fault handler state,Dumping the tracebacks after a timeout,Dumping the traceback,faulthandler — Dump the Python traceback
@anchor{library/faulthandler fault-handler-state}@anchor{445b}
@subsubsection Fault handler state


@geindex enable() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler enable}@anchor{cbe}
@deffn {Função} faulthandler.enable (file=sys.stderr, all_threads=True)

Enable the fault handler: install handlers for the @ref{10b9,,SIGSEGV},
@ref{10ba,,SIGFPE}, @ref{10bb,,SIGABRT}, @ref{10bc,,SIGBUS}
and @ref{10bd,,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.

The `file' must be kept open until the fault handler is disabled: see
@ref{445c,,issue with file descriptors}.


Alterado na versão 3.5: Added support for passing file descriptor to this function.



Alterado na versão 3.6: On Windows, a handler for Windows exception is also installed.



Alterado na versão 3.10: The dump now mentions if a garbage collector collection is running
if `all_threads' is true.

@end deffn

@geindex disable() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler disable}@anchor{445d}
@deffn {Função} faulthandler.disable ()

Disable the fault handler: uninstall the signal handlers installed by
@ref{cbe,,enable()}.
@end deffn

@geindex is_enabled() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler is_enabled}@anchor{445e}
@deffn {Função} faulthandler.is_enabled ()

Check if the fault handler is enabled.
@end deffn

@node Dumping the tracebacks after a timeout,Dumping the traceback on a user signal,Fault handler state,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-tracebacks-after-a-timeout}@anchor{445f}
@subsubsection Dumping the tracebacks after a timeout


@geindex dump_traceback_later() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler dump_traceback_later}@anchor{e2b}
@deffn {Função} 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.

The `file' must be kept open until the traceback is dumped or
@ref{4460,,cancel_dump_traceback_later()} is called: see @ref{445c,,issue with file descriptors}.

This function is implemented using a watchdog thread.


Alterado na versão 3.5: Added support for passing file descriptor to this function.



Alterado na versão 3.7: This function is now always available.

@end deffn

@geindex cancel_dump_traceback_later() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler cancel_dump_traceback_later}@anchor{4460}
@deffn {Função} faulthandler.cancel_dump_traceback_later ()

Cancel the last call to @ref{e2b,,dump_traceback_later()}.
@end deffn

@node Dumping the traceback on a user signal,Issue with file descriptors,Dumping the tracebacks after a timeout,faulthandler — Dump the Python traceback
@anchor{library/faulthandler dumping-the-traceback-on-a-user-signal}@anchor{4461}
@subsubsection Dumping the traceback on a user signal


@geindex register() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler register}@anchor{e29}
@deffn {Função} faulthandler.register (signum, file=sys.stderr, all_threads=True, chain=False)

Register a user signal: install a handler for the `signum' signal to dump
the traceback of all threads, or of the current thread if `all_threads' is
@code{False}, into `file'. Call the previous handler if chain is @code{True}.

The `file' must be kept open until the signal is unregistered by
@ref{4462,,unregister()}: see @ref{445c,,issue with file descriptors}.

Não disponível no Windows.


Alterado na versão 3.5: Added support for passing file descriptor to this function.

@end deffn

@geindex unregister() (no módulo faulthandler)
@anchor{library/faulthandler faulthandler unregister}@anchor{4462}
@deffn {Função} faulthandler.unregister (signum)

Unregister a user signal: uninstall the handler of the `signum' signal
installed by @ref{e29,,register()}. Return @code{True} if the signal was registered,
@code{False} otherwise.

Não disponível no Windows.
@end deffn

@node Issue with file descriptors,Exemplo<13>,Dumping the traceback on a user signal,faulthandler — Dump the Python traceback
@anchor{library/faulthandler faulthandler-fd}@anchor{445c}@anchor{library/faulthandler issue-with-file-descriptors}@anchor{4463}
@subsubsection Issue with file descriptors


@ref{cbe,,enable()}, @ref{e2b,,dump_traceback_later()} and @ref{e29,,register()} keep the
file descriptor of their `file' argument. If the file is closed and its file
descriptor is reused by a new file, or if @ref{b79,,os.dup2()} is used to replace
the file descriptor, the traceback will be written into a different file. Call
these functions again each time that the file is replaced.

@node Exemplo<13>,,Issue with file descriptors,faulthandler — Dump the Python traceback
@anchor{library/faulthandler example}@anchor{4464}
@subsubsection Exemplo


Example of a segmentation fault on Linux with and without enabling the fault
handler:

@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 — O depurador do Python,Os Profilers do Python,faulthandler — Dump the Python traceback,Depuração e perfilamento
@anchor{library/pdb doc}@anchor{4465}@anchor{library/pdb debugger}@anchor{4466}@anchor{library/pdb module-pdb}@anchor{a5}@anchor{library/pdb pdb-the-python-debugger}@anchor{4467}@anchor{library/pdb translation-repo}@anchor{4468}
@subsection @code{pdb} — O depurador do Python


@geindex module; pdb

`Código-fonte:' Lib/pdb.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pdb.py}

@geindex depuração


__________________________________________________________________


O módulo @ref{a5,,pdb} define um depurador de código-fonte interativo para programas Python. Ele possui suporte a definição de pontos de interrupção (condicionais) e passo único no nível da linha de origem, inspeção de quadros de pilha, listagem de código-fonte e avaliação de código Python arbitrário no contexto de qualquer quadro de pilha. Ele também tem suporte a depuração `post-mortem' e pode ser chamado sob controle do programa.

@geindex Pdb (classe no pdb)
@geindex módulo;bdb
@geindex módulo;cmd

O depurador é extensível – na verdade, ele é definido como a classe @ref{928,,Pdb}. Atualmente, isso não está documentado, mas é facilmente compreendido pela leitura do código-fonte. A interface de extensão usa os módulos @ref{f,,bdb} e @ref{19,,cmd}.


@subsubheading Ver também



@table @asis

@item Módulo @ref{58,,faulthandler}

Usado para despejar tracebacks (situação da pilha de execução) do Python explicitamente, em uma falha, após um tempo limite ou em um sinal do usuário.

@item Módulo @ref{fe,,traceback}

Interface padrão para extrair, formatar e imprimir rastreamentos de pilha de programas Python.
@end table


O uso típico para entrar no depurador é inserir:

@example
import pdb; pdb.set_trace()
@end example

ou:

@example
breakpoint()
@end example

no local que você deseja entrar o depurador e, em seguida, executar o programa. Você pode percorrer o código seguindo esta instrução e continuar executando sem o depurador usando o comando @ref{4469,,continue}.


Alterado na versão 3.7: A função embutida @ref{234,,breakpoint()}, quando chamada com valores padrão, pode ser usada em vez de @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

O prompt do depurador é @code{(Pdb)}, que é o indicador de que você está no modo de depuração:

@example
> ...(2)double()
-> breakpoint()
(Pdb) p x
3
(Pdb) continue
3 * 2 is 6
@end example


Alterado na versão 3.3: O preenchimento por tabulação através do módulo @ref{ba,,readline} está disponível para comandos e argumentos de comando, por exemplo os nomes globais e locais atuais são oferecidos como argumentos do comando @code{p}.


@menu
* Interface de linha de comando: Interface de linha de comando<9>. 
* Comandos de depuração:: 

@end menu

@node Interface de linha de comando<9>,Comandos de depuração,,pdb — O depurador do Python
@anchor{library/pdb command-line-interface}@anchor{446a}@anchor{library/pdb pdb-cli}@anchor{446b}
@subsubsection Interface de linha de comando


Você também pode invocar @ref{a5,,pdb} na linha de comando para depurar outros scripts. Por exemplo:

@example
python -m pdb [-c comando] (-m módulo | arquivo-python) [args ...]
@end example

Quando invocado como um módulo, o pdb entra automaticamente na depuração `post-mortem' se o programa que está sendo depurado for encerrado de forma anormal. Após a depuração `post-mortem' (ou após a saída normal do programa), o pdb reiniciará o programa. A reinicialização automática preserva o estado do pdb (p.ex., pontos de interrupção) e, na maioria dos casos, é mais útil do que encerrar o depurador na saída do programa.

@geindex pdb opção de linha de comando; -c
@geindex pdb opção de linha de comando; --command
@anchor{library/pdb cmdoption-pdb-c}@anchor{446c}@anchor{library/pdb cmdoption-pdb-command}@anchor{446d}
@deffn {Option} @w{-}c, @w{-}@w{-}command <command>

Para executar comandos como se fossem dados em um arquivo @code{.pdbrc}. Veja @ref{446e,,Comandos de depuração}.


Alterado na versão 3.2: Adicionada a opção @code{-c}.

@end deffn

@geindex pdb opção de linha de comando; -m
@anchor{library/pdb cmdoption-pdb-m}@anchor{446f}
@deffn {Option} @w{-}m <module>

Para executar módulos de maneira similar ao @code{python -m}. Assim como em um script, o depurador pausará a execução logo antes da primeira linha do módulo.


Alterado na versão 3.7: Adicionada a opção @code{-m}.

@end deffn

O uso típico para executar uma instrução sob o controle do depurador é:

@example
>>> import pdb
>>> def f(x):
...     print(1 / x)
>>> pdb.run("f(2)")
> <string>(1)<module>()
(Pdb) continue
0.5
>>>
@end example

O uso típico para inspecionar um programa com falha é:

@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


Alterado na versão 3.13: A implementação da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} significa que atribuições de nomes feitas via @code{pdb} afetarão imediatamente o escopo ativo, mesmo quando executado dentro de um @ref{17e,,escopo otimizado}.


O módulo define as seguintes funções; cada uma entra no depurador de uma maneira ligeiramente diferente:

@geindex run() (no módulo pdb)
@anchor{library/pdb pdb run}@anchor{426c}
@deffn {Função} pdb.run (statement, globals=None, locals=None)

Executa a instrução `statement' (fornecida como uma string ou um objeto código) sob controle do depurador. O prompt do depurador aparece antes de qualquer código ser executado; você pode definir pontos de interrupção e digitar @ref{4469,,continue} ou pode percorrer a instrução usando @ref{4470,,step} ou @ref{4471,,next} (todos esses comandos são explicados abaixo). Os argumentos opcionais `globals' e `locals' especificam o ambiente em que o código é executado; por padrão, o dicionário do módulo @ref{1,,__main__} é usado. (Veja a explicação das funções embutidas @ref{17f,,exec()} ou @ref{180,,eval()}.)
@end deffn

@geindex runeval() (no módulo pdb)
@anchor{library/pdb pdb runeval}@anchor{4472}
@deffn {Função} pdb.runeval (expression, globals=None, locals=None)

Avalia a expressão `expression' (fornecida como uma string ou um objeto código) sob controle do depurador. Quando @ref{4472,,runeval()} retorna, ele retorna o valor de `expression'. Caso contrário, esta função é semelhante a @ref{426c,,run()}.
@end deffn

@geindex runcall() (no módulo pdb)
@anchor{library/pdb pdb runcall}@anchor{4473}
@deffn {Função} pdb.runcall (function, *args, **kwds)

Chama a função `function' (um objeto função ou método, não uma string) com os argumentos fornecidos. Quando @ref{4473,,runcall()} retorna, ele retorna qualquer que seja a chamada de função retornada. O prompt do depurador aparece assim que a função é inserida.
@end deffn

@geindex set_trace() (no módulo pdb)
@anchor{library/pdb pdb set_trace}@anchor{235}
@deffn {Função} pdb.set_trace (*, header=None)

Entra no depurador no quadro da pilha de chamada. Isso é útil para codificar um ponto de interrupção em um determinado ponto de um programa, mesmo que o código não esteja sendo depurado de outra forma (por exemplo, quando uma asserção falha). Se fornecido, `header' é impresso no console imediatamente antes do início da depuração.


Alterado na versão 3.7: O argumento somente-nomeado `header'.



Alterado na versão 3.13: @ref{235,,set_trace()} entrará no depurador imediatamente, em vez da próxima linha de código a ser executada.

@end deffn

@geindex post_mortem() (no módulo pdb)
@anchor{library/pdb pdb post_mortem}@anchor{1421}
@deffn {Função} pdb.post_mortem (t=None)

Entra em depuração post-mortem da exceção fornecida ou @ref{b07,,objeto traceback}. Se nenhum valor for fornecido, usa a exceção que está sendo tratada no momento ou levanta @code{ValueError} se não houver nenhuma.


Alterado na versão 3.13: Adiciona suporte a objetos exceção.

@end deffn

@geindex pm() (no módulo pdb)
@anchor{library/pdb pdb pm}@anchor{237}
@deffn {Função} pdb.pm ()

Entra a depuração post-mortem da exceção encontrada em @ref{4be,,sys.last_exc}.
@end deffn

As funções @code{run*} e a @ref{235,,set_trace()} são aliases, ou apelidos, para instanciar a classe @ref{928,,Pdb} e chamar o método com o mesmo nome. Se você deseja acessar outros recursos, faça você mesmo:

@geindex Pdb (classe em pdb)
@anchor{library/pdb pdb Pdb}@anchor{928}
@deffn {Classe} pdb.Pdb (completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)

@ref{928,,Pdb} é a classe do depurador.

Os argumentos `completekey', `stdin' e `stdout' são passados para a classe subjacente @ref{17b8,,cmd.Cmd}; veja a descrição lá.

O argumento `skip', se fornecido, deve ser um iterável de padrões de nome de módulo no estilo glob. O depurador não entrará nos quadros que se originam em um módulo que corresponde a um desses padrões. @footnote{
Se um quadro é considerado originário de um determinado módulo é determinado pelo @code{__name__} nos globais do quadro.
}

Por padrão, o Pdb define um manipulador para o sinal SIGINT (que é enviado quando o usuário pressiona @code{Ctrl}-@code{C} no console) quando você dá um comando @ref{4469,,continue}. Isso permite que você entre no depurador novamente pressionando @code{Ctrl}-@code{C}. Se você deseja que o Pdb não toque no manipulador SIGINT, defina `nosigint' como verdadeiro.

O argumento `readrc' é padronizado como verdadeiro e controla se o Pdb carregará arquivos .pdbrc do sistema de arquivos.

Exemplo de chamada para habilitar rastreamento com `skip':

@example
import pdb; pdb.Pdb(skip=['django.*']).set_trace()
@end example

Levanta um @ref{19fa,,evento de auditoria} @code{pdb.Pdb} sem argumentos.


Alterado na versão 3.1: Adicionado o parâmetro `skip'.



Alterado na versão 3.2: Adicionado o parâmetro `nosigint'. Anteriormente, um manipulador de SIGINT nunca era definido por Pdb.



Alterado na versão 3.6: O argumento `readrc'.


@geindex run() (método pdb.Pdb)
@geindex runeval() (método pdb.Pdb)
@geindex runcall() (método pdb.Pdb)
@geindex set_trace() (método pdb.Pdb)
@anchor{library/pdb pdb Pdb run}@anchor{4474}
@deffn {Método} run (statement, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runeval}@anchor{4475}
@deffnx {Método} runeval (expression, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runcall}@anchor{4476}
@deffnx {Método} runcall (function, *args, **kwds)
@anchor{library/pdb pdb Pdb set_trace}@anchor{4477}
@deffnx {Método} set_trace ()

Consulte a documentação para as funções explicadas acima.
@end deffn
@end deffn

@node Comandos de depuração,,Interface de linha de comando<9>,pdb — O depurador do Python
@anchor{library/pdb debugger-commands}@anchor{446e}@anchor{library/pdb id2}@anchor{4478}
@subsubsection Comandos de depuração


Os comandos reconhecidos pelo depurador estão listados abaixo. A maioria dos comandos pode ser abreviada para uma ou duas letras, conforme indicado; por exemplo, @code{h(elp)} significa que @code{h} ou @code{help} podem ser usados para inserir o comando de ajuda (mas não @code{he} ou @code{hel}, nem @code{H} ou @code{Help} ou @code{HELP}). Os argumentos para os comandos devem ser separados por espaços em branco (espaços ou tabulações). Os argumentos opcionais estão entre colchetes (@code{[]}) na sintaxe do comando; os colchetes não devem ser digitados. As alternativas na sintaxe de comando são separadas por uma barra vertical (@code{|}).

Digitar uma linha em branco repete o último comando digitado. Exceção: se o último comando foi um comando @ref{4479,,list}, as próximas 11 linhas serão listadas.

Os comandos que o depurador não reconhece são presumidos como instruções Python e são executados no contexto do programa que está sendo depurado. As instruções Python também podem ser prefixadas com um ponto de exclamação (@code{!}). Essa é uma maneira poderosa de inspecionar o programa que está sendo depurado; é até possível alterar uma variável ou chamar uma função. Quando ocorre uma exceção em uma instrução, o nome da exceção é impresso, mas o estado do depurador não é alterado.


Alterado na versão 3.13: Expressões/instruções, cujo prefixo é um comando pdb, agora são identificadas e executadas corretamente.


O depurador possui suporte a @ref{447a,,aliases}. Os aliases podem ter parâmetros que permitem um certo nível de adaptabilidade ao contexto em exame.

Vários comandos podem ser inseridos em uma única linha, separados por @code{;;}. (Um único @code{;} não é usado, pois é o separador para vários comandos em uma linha que é passada para o analisador Python.) Nenhuma inteligência é aplicada para separar os comandos; a entrada é dividida no primeiro par @code{;;}, mesmo que esteja no meio de uma string entre aspas. Uma solução alternativa para strings com caractere de ponto e vírgula duplo é usar a concatenação de string implícita @code{';'@w{'};'} ou @code{";"";"}.

Para definir uma variável global temporária, use uma `variável de conveniência'. Uma `variável de conveniência' é uma variável cujo nome começa com @code{$}. Por exemplo, @code{$foo = 1} define uma variável global @code{$foo} que você pode usar na sessão do depurador. As `variáveis de conveniência' são limpas quando o programa retoma a execução, portanto é menos provável que interfira em seu programa em comparação ao uso de variáveis normais como @code{foo = 1}.

Existem três `variáveis de conveniência' predefinidas:


@itemize *

@item 
@code{$_frame}: o quadro atual que você está depurando

@item 
@code{$_retval}: o valor de retorno se o quadro estiver retornando

@item 
@code{$_exception}: a exceção se o quadro estiver levantando uma exceção
@end itemize


Adicionado na versão 3.12: Adicionado o recurso de `variável de conveniência'.


@geindex .pdbrc;arquivo
@geindex depurador;configuração;arquivo

Se um arquivo @code{.pdbrc} existe no diretório inicial do usuário ou no diretório atual, ele é lido com a codificação @code{'utf-8'} e executado como se tivesse sido digitado no prompt do depurador, com a exceção de que linhas vazias e linhas iniciando com @code{#} são ignoradas. Isso é particularmente útil para aliases. Se ambos os arquivos existirem, aquele no diretório inicial será lido primeiro e os aliases definidos poderão ser substituídos pelo arquivo local.


Alterado na versão 3.2: @code{.pdbrc} agora pode conter comandos que continuam a depuração, como @ref{4469,,continue} ou @ref{4471,,next}. Anteriormente, esses comandos não tinham efeito.



Alterado na versão 3.11: @code{.pdbrc} agora é lido com a codificação @code{'utf-8'}. Anteriormente, ele era lido com a codificação da localidade do sistema.


@geindex help (pdb command)
@anchor{library/pdb pdbcommand-help}@anchor{447b}
@deffn {Pdbcommand} h(elp) [command]

Sem argumento, imprime a lista de comandos disponíveis. Com um `command' como argumento, imprime ajuda sobre esse comando. @code{help pdb} exibe a documentação completa (a docstring do módulo @ref{a5,,pdb}). Como o argumento `command' deve ser um identificador, @code{help exec} deve ser inserido para obter ajuda sobre o comando @code{!}.
@end deffn

@geindex where (pdb command)
@anchor{library/pdb pdbcommand-where}@anchor{447c}
@deffn {Pdbcommand} w(here)

Exibe um stack trace (situação da pilha de execução), com o quadro mais recente na parte inferior. Uma seta (@code{>}) indica o quadro atual, que determina o contexto da maioria dos comandos.
@end deffn

@geindex down (pdb command)
@anchor{library/pdb pdbcommand-down}@anchor{447d}
@deffn {Pdbcommand} d(own) [count]

Move os níveis do quadro atual `count' (padrão 1) para baixo no stack trace (para um quadro mais recente).
@end deffn

@geindex up (pdb command)
@anchor{library/pdb pdbcommand-up}@anchor{447e}
@deffn {Pdbcommand} u(p) [count]

Move os níveis do quadro atual na `count' (padrão 1) para cima no stack trace (para um quadro mais antigo).
@end deffn

@geindex break (pdb command)
@anchor{library/pdb pdbcommand-break}@anchor{447f}
@deffn {Pdbcommand} b(reak) [([filename:]lineno | function) [, condition]]

Com um argumento `lineno', define uma quebra na linha `lineno' no arquivo atual. O número da linha pode ser prefixado com `filename' e dois pontos, para especificar um ponto de interrupção em outro arquivo (possivelmente um que ainda não tenha sido carregado). O arquivo é pesquisado em @ref{3b4,,sys.path}. Formas aceitáveis de `filename' são @code{/caminhoabsoluto/para/arquivo.py}, @code{caminhorelativo/do/arquivo.py}, @code{módulo} e @code{pacote.módulo}.

Com um argumento `function', define uma interrupção na primeira instrução executável dentro dessa função. `function' pode ser qualquer expressão avaliada como uma função no espaço de nomes atual.

Se um segundo argumento estiver presente, é uma expressão que deve ser avaliada como verdadeira antes que o ponto de interrupção seja respeitado.

Sem argumento, lista todas as quebras, inclusive para cada ponto de interrupção, o número de vezes que o ponto de interrupção foi atingido, a contagem atual de ignorados e a condição associada, se houver.

Cada ponto de interrupção recebe um número ao qual todos os outros comandos de ponto de interrupção se referem.
@end deffn

@geindex tbreak (pdb command)
@anchor{library/pdb pdbcommand-tbreak}@anchor{4480}
@deffn {Pdbcommand} tbreak [([filename:]lineno | function) [, condition]]

Ponto de interrupção temporário, que é removido automaticamente quando é atingido pela primeira vez. Os argumentos são os mesmos que para @ref{447f,,break}.
@end deffn

@geindex clear (pdb command)
@anchor{library/pdb pdbcommand-clear}@anchor{4481}
@deffn {Pdbcommand} cl(ear) [filename:lineno | bpnumber ...]

Com um argumento `filename:lineno', limpa todos os pontos de interrupção nessa linha. Com uma lista separada por espaços de números de ponto de interrupção, limpa esses pontos de interrupção. Sem argumento, limpa todas as quebras (mas primeiro pede a confirmação).
@end deffn

@geindex disable (pdb command)
@anchor{library/pdb pdbcommand-disable}@anchor{4482}
@deffn {Pdbcommand} disable bpnumber [bpnumber ...]

Desativa os pontos de interrupção fornecidos como uma lista separada por espaços de números de pontos de interrupção. Desabilitar um ponto de interrupção significa que ele não pode interromper a execução do programa, mas, ao contrário de limpar um ponto de interrupção, ele permanece na lista de pontos de interrupção e pode ser (re)ativado.
@end deffn

@geindex enable (pdb command)
@anchor{library/pdb pdbcommand-enable}@anchor{4483}
@deffn {Pdbcommand} enable bpnumber [bpnumber ...]

Ativa o ponto de interrupção especificado.
@end deffn

@geindex ignore (pdb command)
@anchor{library/pdb pdbcommand-ignore}@anchor{4484}
@deffn {Pdbcommand} ignore bpnumber [count]

Define a contagem de ignorados para o número do ponto de interrupção especificado. Se `count' for omitida, a contagem de ignorados será definida como 0. Um ponto de interrupção se torna ativo quando a contagem de ignorados é zero. Quando diferente de zero, a contagem é decrementada cada vez que o ponto de interrupção é atingido e o ponto de interrupção não é desativado e qualquer condição associada é avaliada como verdadeira.
@end deffn

@geindex condition (pdb command)
@anchor{library/pdb pdbcommand-condition}@anchor{4485}
@deffn {Pdbcommand} condition bpnumber [condition]

Define uma nova `condition' para o ponto de interrupção, uma expressão que deve ser avaliada como verdadeira antes que o ponto de interrupção seja respeitado. Se `condition' for omitida, qualquer condição existente será removida; isto é, o ponto de interrupção é tornado incondicional.
@end deffn

@geindex commands (pdb command)
@anchor{library/pdb pdbcommand-commands}@anchor{4486}
@deffn {Pdbcommand} commands [bpnumber]

Especifica uma lista de comandos para o número do ponto de interrupção `bpnumber'. Os próprios comandos aparecem nas linhas seguintes. Digite em uma linha contendo apenas @code{end} para finalizar os comandos. Um exemplo:

@example
(Pdb) commands 1
(com) p alguma_variável
(com) end
(Pdb)
@end example

Para remover todos os comandos de um ponto de interrupção, digite @code{commands} e siga-o imediatamente com @code{end}; isto é, não dê comandos.

Sem argumento `bpnumber', @code{commands} refere-se ao último conjunto de pontos de interrupção.

Você pode usar comandos de ponto de interrupção para iniciar seu programa novamente. Simplesmente use o comando @ref{4469,,continue}, ou @ref{4470,,step}, ou qualquer outro comando que reinicie a execução.

Especificar qualquer comando que retome a execução (atualmente @ref{4469,,continue}, @ref{4470,,step}, @ref{4471,,next}, @ref{4487,,return}, @ref{4488,,jump}, @ref{4489,,quit} e suas abreviações) finaliza a lista de comandos (como se esse comando fosse imediatamente seguido pelo final). Isso ocorre sempre que você retoma a execução (mesmo com uma simples etapa ou etapa), você pode encontrar outro ponto de interrupção — que pode ter sua própria lista de comandos, levando a ambiguidades sobre qual lista executar.

Se você usar o comando @code{silent} na lista de comandos, a mensagem usual sobre a parada em um ponto de interrupção não será impressa. Isso pode ser desejável para pontos de interrupção que devem imprimir uma mensagem específica e continuar. Se nenhum dos outros comandos imprimir alguma coisa, você não vê sinal de que o ponto de interrupção foi atingido.
@end deffn

@geindex step (pdb command)
@anchor{library/pdb pdbcommand-step}@anchor{4470}
@deffn {Pdbcommand} s(tep)

Executa a linha atual, interrompe na primeira ocasião possível (em uma função chamada ou na próxima linha na função atual).
@end deffn

@geindex next (pdb command)
@anchor{library/pdb pdbcommand-next}@anchor{4471}
@deffn {Pdbcommand} n(ext)

Continua a execução até que a próxima linha na função atual seja atingida ou ela retorne. (A diferença entre @ref{4471,,next} e @ref{4470,,step} é que @ref{4470,,step} para dentro de uma função chamada, enquanto @ref{4471,,next} executa funções chamadas em (quase) velocidade máxima, parando apenas na próxima linha da função atual.)
@end deffn

@geindex until (pdb command)
@anchor{library/pdb pdbcommand-until}@anchor{448a}
@deffn {Pdbcommand} unt(il) [lineno]

Sem argumento, continua a execução até que a linha com um número maior que o atual seja atingida.

Com `lineno', continua a execução até que uma linha com um número maior ou igual a `lineno' ser alcançada. Nos dois casos, também interrompe quando o quadro atual retornar.


Alterado na versão 3.2: Permite fornecer um número de linha explícito.

@end deffn

@geindex return (pdb command)
@anchor{library/pdb pdbcommand-return}@anchor{4487}
@deffn {Pdbcommand} r(eturn)

Continua a execução até que a função atual retorne.
@end deffn

@geindex continue (pdb command)
@anchor{library/pdb pdbcommand-continue}@anchor{4469}
@deffn {Pdbcommand} c(ont(inue))

Continua a execução, interrompe apenas quando um ponto de interrupção for encontrado.
@end deffn

@geindex jump (pdb command)
@anchor{library/pdb pdbcommand-jump}@anchor{4488}
@deffn {Pdbcommand} j(ump) lineno

Define a próxima linha que será executada. Disponível apenas no quadro mais inferior. Isso permite voltar e executar o código novamente ou avançar para pular o código que você não deseja executar.

Deve-se notar que nem todos os saltos são permitidos – por exemplo, não é possível pular para o meio de um loop de @ref{2f2,,for} ou sair de uma cláusula @ref{9d2,,finally}.
@end deffn

@geindex list (pdb command)
@anchor{library/pdb pdbcommand-list}@anchor{4479}
@deffn {Pdbcommand} l(ist) [first[, last]]

Lista o código-fonte do arquivo atual. Sem argumentos, lista 11 linhas ao redor da linha atual ou continue a listagem anterior. Com @code{.} como argumento, lista 11 linhas ao redor da linha atual. Com um argumento, lista 11 linhas nessa linha. Com dois argumentos, lista o intervalo especificado; se o segundo argumento for menor que o primeiro, ele será interpretado como uma contagem.

A linha atual no quadro atual é indicada por @code{->}. Se uma exceção estiver sendo depurada, a linha em que a exceção foi originalmente gerada ou propagada é indicada por @code{>>}, se for diferente da linha atual.


Alterado na versão 3.2: Adicionado o marcador @code{>>}.

@end deffn

@geindex ll (pdb command)
@anchor{library/pdb pdbcommand-ll}@anchor{448b}
@deffn {Pdbcommand} ll | longlist

Lista todo o código-fonte da função ou quadro atual. As linhas interessantes estão marcadas como para @ref{4479,,list}.


Adicionado na versão 3.2.

@end deffn

@geindex args (pdb command)
@anchor{library/pdb pdbcommand-args}@anchor{448c}
@deffn {Pdbcommand} a(rgs)

Imprime os argumentos da função atual e seus valores atuais.
@end deffn

@geindex p (pdb command)
@anchor{library/pdb pdbcommand-p}@anchor{faa}
@deffn {Pdbcommand} p expression

Avalia `expression' no contexto atual e imprima seu valor.

@cartouche
@quotation Nota 
@code{print()} também pode ser usado, mas não é um comando de depuração — isso executa a função Python @ref{fa9,,print()}.
@end quotation
@end cartouche
@end deffn

@geindex pp (pdb command)
@anchor{library/pdb pdbcommand-pp}@anchor{448d}
@deffn {Pdbcommand} pp expression

Como o comando @ref{faa,,p}, exceto que o valor de `expression' é bastante impresso usando o módulo @ref{ae,,pprint}.
@end deffn

@geindex whatis (pdb command)
@anchor{library/pdb pdbcommand-whatis}@anchor{448e}
@deffn {Pdbcommand} whatis expression

Exibe o tipo de `expression'.
@end deffn

@geindex source (pdb command)
@anchor{library/pdb pdbcommand-source}@anchor{448f}
@deffn {Pdbcommand} source expression

Tenta obter o código-fonte de `expression' e exibe-o.


Adicionado na versão 3.2.

@end deffn

@geindex display (pdb command)
@anchor{library/pdb pdbcommand-display}@anchor{4490}
@deffn {Pdbcommand} display [expression]

Exibe o valor de `expression' caso ela tenha sido alterada, sempre que a execução for interrompida no quadro atual.

Sem `expression', lista todas as expressões de exibição para o quadro atual.

@cartouche
@quotation Nota 
Display avalia `expression' e compara com o resultado da avaliação anterior de `expression', portanto, quando o resultado é mutável, display pode não ser capaz de captar as alterações.
@end quotation
@end cartouche

Exemplo:

@example
lst = []
breakpoint()
pass
lst.append(1)
print(lst)
@end example

Display não perceberá que @code{lst} foi alterado porque o resultado da avaliação foi modificado internamente por @code{lst.append(1)} antes de ser comparado:

@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

Você pode fazer alguns truques com o mecanismo de cópia para fazê-lo funcionar:

@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


Adicionado na versão 3.2.

@end deffn

@geindex undisplay (pdb command)
@anchor{library/pdb pdbcommand-undisplay}@anchor{4491}
@deffn {Pdbcommand} undisplay [expression]

Não exibe mais `expression' no quadro atual. Sem expressão, limpa todas as expressões de exibição para o quadro atual.


Adicionado na versão 3.2.

@end deffn

@geindex interact (pdb command)
@anchor{library/pdb pdbcommand-interact}@anchor{4492}
@deffn {Pdbcommand} interact

Inicia um interpretador interativo (usando o módulo @ref{1a,,code}) em um novo espaço de nomes global inicializado a partir dos espaços de nomes locais e globais para o escopo atual. Use @code{exit()} ou @code{quit()} para sair do interpretador e retornar ao depurador.

@cartouche
@quotation Nota 
Como @code{interact} cria um novo espaço de nomes dedicado para execução de código, atribuições a variáveis não afetarão os espaços de nomes originais. No entanto, as modificações em quaisquer objetos mutáveis referenciados serão refletidas nos espaços de nomes originais, como de costume.
@end quotation
@end cartouche


Adicionado na versão 3.2.



Alterado na versão 3.13: @code{exit()} e @code{quit()} podem ser usados para sair do comando @ref{4492,,interact}.



Alterado na versão 3.13: @ref{4492,,interact} direciona sua saída para o canal de saída do depurador em vez de @ref{940,,sys.stderr}.

@end deffn

@geindex alias (pdb command)
@anchor{library/pdb debugger-aliases}@anchor{447a}@anchor{library/pdb pdbcommand-alias}@anchor{4493}
@deffn {Pdbcommand} alias [name [command]]

Cria um apelido chamado `name' que executa `command'. O comando `command' `não' deve ser colocado entre aspas. Parâmetros substituíveis podem ser indicados por @code{%1}, @code{%2}, … e @code{%9}, enquanto @code{%*} é substituído por todos os parâmetros. Se `command' for omitido, o apelido atual para `name' será mostrado. Se nenhum argumento for fornecido, todos os apelidos serão listados.

Os aliases podem ser aninhados e podem conter qualquer coisa que possa ser digitada legalmente no prompt do pdb. Observe que os comandos internos do pdb `podem' ser substituídos por aliases. Esse comando é oculto até que o alias seja removido. O alias é aplicado recursivamente à primeira palavra da linha de comando; todas as outras palavras da linha são deixadas em paz.

Como exemplo, aqui estão dois aliases úteis (especialmente quando colocados no arquivo @code{.pdbrc}):

@example
# Exibe variáveis de instância (use em "pi classInst")
alias pi for k in %1.__dict__.keys(): print(f"%1.@{k@} = @{%1.__dict__[k]@}")
# Exibe variáveis de instância em self
alias ps pi self
@end example
@end deffn

@geindex unalias (pdb command)
@anchor{library/pdb pdbcommand-unalias}@anchor{4494}
@deffn {Pdbcommand} unalias name

Executa o alias `name' especificado.
@end deffn

@geindex ! (pdb command)
@anchor{library/pdb pdbcommand-0}@anchor{4495}
@deffn {Pdbcommand} ! statement

Executa a instrução `statement' (de uma só linha) no contexto do quadro de pilha atual. O ponto de exclamação pode ser omitido, a menos que a primeira palavra da instrução seja semelhante a um comando de depuração, por exemplo:

@example
(Pdb) ! n=42
(Pdb)
@end example

Para definir uma variável global, você pode prefixar o comando de atribuição com uma instrução @ref{18a,,global} na mesma linha, por exemplo:

@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{4496}
@deffn {Pdbcommand} run [args ...]
@anchor{library/pdb pdbcommand-restart}@anchor{4497}
@deffnx {Pdbcommand} restart [args ...]

Reinicia o programa Python depurado. Se `args' for fornecido, ele é dividido com @ref{c4,,shlex} e o resultado é usado como o novo @ref{12a6,,sys.argv}. Histórico, pontos de interrupção, ações e opções do depurador são preservados. @ref{4497,,restart} é um apelido para @ref{4496,,run}.
@end deffn

@geindex quit (pdb command)
@anchor{library/pdb pdbcommand-quit}@anchor{4489}
@deffn {Pdbcommand} q(uit)

Sai do depurador. O programa que está sendo executado é abortado.
@end deffn

@geindex debug (pdb command)
@anchor{library/pdb pdbcommand-debug}@anchor{4498}
@deffn {Pdbcommand} debug code

Entra em um depurador recursivo que percorre `code' (que é uma expressão ou instrução arbitrária a ser executada no ambiente atual).
@end deffn

@geindex retval (pdb command)
@anchor{library/pdb pdbcommand-retval}@anchor{4499}
@deffn {Pdbcommand} retval

Exibe o valor de retorno para o último retorno de a função atual.
@end deffn

@geindex exceptions (pdb command)
@anchor{library/pdb pdbcommand-exceptions}@anchor{238}
@deffn {Pdbcommand} exceptions [excnumber]

Lista ou salta entre exceções encadeadas.

Ao usar @code{pdb.pm()} ou @code{Pdb.post_mortem(...)} com uma exceção encadeada em vez de um traceback, permite ao usuário mover entre as exceções encadeadas usando o comando @code{exceptions} para listar exceções e @code{exceptions <número>} para mudar para essa exceção.

Exemplo:

@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

chamar @code{pdb.pm()} permitirá mover entre exceções:

@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


Adicionado na versão 3.13.

@end deffn

@node Os Profilers do Python,timeit — Mede o tempo de execução de pequenos trechos de código,pdb — O depurador do Python,Depuração e perfilamento
@anchor{library/profile doc}@anchor{449a}@anchor{library/profile profile}@anchor{449b}@anchor{library/profile the-python-profilers}@anchor{449c}@anchor{library/profile translation-repo}@anchor{449d}
@subsection Os Profilers do Python


`Código-fonte:' Lib/profile.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/profile.py} and Lib/pstats.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pstats.py}


__________________________________________________________________


@menu
* Introdução aos profilers:: 
* Instant User’s Manual:: 
* profile and cProfile Module Reference:: 
* A classe Stats:: 
* What Is Deterministic Profiling?:: 
* Limitações:: 
* Calibration:: 
* Using a custom timer:: 

@end menu

@node Introdução aos profilers,Instant User’s Manual,,Os Profilers do Python
@anchor{library/profile introduction-to-the-profilers}@anchor{449e}@anchor{library/profile profiler-introduction}@anchor{449f}
@subsubsection Introdução aos profilers


@geindex deterministic profiling
@geindex profiling@comma{} deterministic

@ref{27,,cProfile} and @ref{af,,profile} provide `deterministic profiling' of
Python programs. A `profile' is a set of statistics that describes how
often and for how long various parts of the program executed. These statistics
can be formatted into reports via the @ref{b0,,pstats} module.

A biblioteca padrão do Python tem duas implementações diferentes para a mesma interface de profiling:


@enumerate 

@item 
@ref{27,,cProfile} is recommended for most users; it’s a C extension with
reasonable overhead that makes it suitable for profiling long-running
programs.  Based on @code{lsprof}, contributed by Brett Rosen and Ted
Czotter.

@item 
@ref{af,,profile}, a pure Python module whose interface is imitated by
@ref{27,,cProfile}, but which adds significant overhead to profiled programs.
If you’re trying to extend the profiler in some way, the task might be easier
with this module.  Originally designed and written by Jim Roskind.
@end enumerate

@cartouche
@quotation Nota 
The profiler modules are designed to provide an execution profile for a given
program, not for benchmarking purposes (for that, there is @ref{ef,,timeit} for
reasonably accurate results).  This particularly applies to benchmarking
Python code against C code: the profilers introduce overhead for Python code,
but not for C-level functions, and so the C code would seem faster than any
Python one.
@end quotation
@end cartouche

@node Instant User’s Manual,profile and cProfile Module Reference,Introdução aos profilers,Os Profilers do Python
@anchor{library/profile instant-user-s-manual}@anchor{44a0}@anchor{library/profile profile-instant}@anchor{44a1}
@subsubsection Instant User’s Manual


This section is provided for users that “don’t want to read the manual.” It
provides a very brief overview, and allows a user to rapidly perform profiling
on an existing application.

Para realizar profile de uma função que recebe apenas um argumento, você pode fazer:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")')
@end example

(Use @ref{af,,profile} instead of @ref{27,,cProfile} if the latter is not available on
your system.)

The above action would run @ref{bee,,re.compile()} and print profile results like
the following:

@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

for the number of calls.

@item tottime

for the total time spent in the given function (and excluding time made in
calls to sub-functions)

@item percall

is the quotient of @code{tottime} divided by @code{ncalls}

@item cumtime

is the cumulative time spent in this and all subfunctions (from invocation
till exit). This figure is accurate `even' for recursive functions.

@item percall

is the quotient of @code{cumtime} divided by primitive calls

@item filename:lineno(function)

provides the respective data of each function
@end table

When there are two numbers in the first column (for example @code{3/1}), it means
that the function recursed.  The second value is the number of primitive calls
and the former is the total number of calls.  Note that when the function does
not recurse, these two values are the same, and only the single figure is
printed.

Instead of printing the output at the end of the profile run, you can save the
results to a file by specifying a filename to the @code{run()} function:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")', 'restats')
@end example

The @ref{44a2,,pstats.Stats} class reads profile results from a file and formats
them in various ways.
@anchor{library/profile profile-cli}@anchor{44a3}
The files @ref{27,,cProfile} and @ref{af,,profile} can also be invoked as a script to
profile another script.  For example:

@example
python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)
@end example

@geindex cProfile opção de linha de comando; -o
@anchor{library/profile cmdoption-cProfile-o}@anchor{44a4}
@deffn {Option} @w{-}o <output_file>

Writes the profile results to a file instead of to stdout.
@end deffn

@geindex cProfile opção de linha de comando; -s
@anchor{library/profile cmdoption-cProfile-s}@anchor{44a5}
@deffn {Option} @w{-}s <sort_order>

Specifies one of the @ref{44a6,,sort_stats()} sort values
to sort the output by.
This only applies when @ref{44a4,,-o} is not supplied.
@end deffn

@geindex cProfile opção de linha de comando; -m
@anchor{library/profile cmdoption-cProfile-m}@anchor{44a7}
@deffn {Option} @w{-}m <module>

Specifies that a module is being profiled instead of a script.


Adicionado na versão 3.7: Added the @code{-m} option to @ref{27,,cProfile}.



Adicionado na versão 3.8: Added the @code{-m} option to @ref{af,,profile}.

@end deffn

The @ref{b0,,pstats} module’s @ref{44a2,,Stats} class has a variety of methods
for manipulating and printing the data saved into a profile results file:

@example
import pstats
from pstats import SortKey
p = pstats.Stats('restats')
p.strip_dirs().sort_stats(-1).print_stats()
@end example

The @ref{44a8,,strip_dirs()} method removed the extraneous path from all
the module names. The @ref{44a6,,sort_stats()} method sorted all the
entries according to the standard module/line/name string that is printed. The
@ref{44a9,,print_stats()} method printed out all the statistics.  You
might try the following sort calls:

@example
p.sort_stats(SortKey.NAME)
p.print_stats()
@end example

The first call will actually sort the list by function name, and the second call
will print out the statistics.  The following are some interesting calls to
experiment with:

@example
p.sort_stats(SortKey.CUMULATIVE).print_stats(10)
@end example

This sorts the profile by cumulative time in a function, and then only prints
the ten most significant lines.  If you want to understand what algorithms are
taking time, the above line is what you would use.

If you were looking to see what functions were looping a lot, and taking a lot
of time, you would do:

@example
p.sort_stats(SortKey.TIME).print_stats(10)
@end example

to sort according to time spent within each function, and then print the
statistics for the top ten functions.

Você pode tentar também:

@example
p.sort_stats(SortKey.FILENAME).print_stats('__init__')
@end example

This will sort all the statistics by file name, and then print out statistics
for only the class init methods (since they are spelled with @code{__init__} in
them).  As one final example, you could try:

@example
p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')
@end example

This line sorts statistics with a primary key of time, and a secondary key of
cumulative time, and then prints out some of the statistics. To be specific, the
list is first culled down to 50% (re: @code{.5}) of its original size, then only
lines containing @code{init} are maintained, and that sub-sub-list is printed.

If you wondered what functions called the above functions, you could now (@code{p}
is still sorted according to the last criteria) do:

@example
p.print_callers(.5, 'init')
@end example

and you would get a list of callers for each of the listed functions.

If you want more functionality, you’re going to have to read the manual, or
guess what the following functions do:

@example
p.print_callees()
p.add('restats')
@end example

Invoked as a script, the @ref{b0,,pstats} module is a statistics browser for
reading and examining profile dumps.  It has a simple line-oriented interface
(implemented using @ref{19,,cmd}) and interactive help.

@node profile and cProfile Module Reference,A classe Stats,Instant User’s Manual,Os Profilers do Python
@anchor{library/profile module-cProfile}@anchor{27}@anchor{library/profile profile-and-cprofile-module-reference}@anchor{44aa}
@subsubsection @code{profile} and @code{cProfile} Module Reference


@geindex module; cProfile

@geindex module; profile
@anchor{library/profile module-profile}@anchor{af}
Both the @ref{af,,profile} and @ref{27,,cProfile} modules provide the following
functions:

@geindex run() (no módulo profile)
@anchor{library/profile profile run}@anchor{44ab}
@deffn {Função} profile.run (command, filename=None, sort=-1)

This function takes a single argument that can be passed to the @ref{17f,,exec()}
function, and an optional file name.  In all cases this routine executes:

@example
exec(command, __main__.__dict__, __main__.__dict__)
@end example

and gathers profiling statistics from the execution. If no file name is
present, then this function automatically creates a @ref{44a2,,Stats}
instance and prints a simple profiling report. If the sort value is specified,
it is passed to this @ref{44a2,,Stats} instance to control how the
results are sorted.
@end deffn

@geindex runctx() (no módulo profile)
@anchor{library/profile profile runctx}@anchor{44ac}
@deffn {Função} profile.runctx (command, globals, locals, filename=None, sort=-1)

This function is similar to @ref{44ab,,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

and gathers profiling statistics as in the @ref{44ab,,run()} function above.
@end deffn

@geindex Profile (classe em profile)
@anchor{library/profile profile Profile}@anchor{9eb}
@deffn {Classe} profile.Profile (timer=None, timeunit=0.0, subcalls=True, builtins=True)

This class is normally only used if more precise control over profiling is
needed than what the @code{cProfile.run()} function provides.

A custom timer can be supplied for measuring how long code takes to run via
the `timer' argument. This must be a function that returns a single number
representing the current time. If the number is an integer, the `timeunit'
specifies a multiplier that specifies the duration of each unit of time. For
example, if the timer returns times measured in thousands of seconds, the
time unit would be @code{.001}.

Directly using the @ref{9eb,,Profile} class allows formatting profile results
without writing the profile data to a file:

@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

The @ref{9eb,,Profile} class can also be used as a context manager (supported
only in @ref{27,,cProfile} module. see @ref{214e,,Tipos de Gerenciador de Contexto}):

@example
import cProfile

with cProfile.Profile() as pr:
    # ... do something ...

    pr.print_stats()
@end example


Alterado na versão 3.8: Adicionado suporte a gerenciador de contexto.


@geindex enable() (método profile.Profile)
@anchor{library/profile profile Profile enable}@anchor{44ad}
@deffn {Método} enable ()

Inicia a coleta de dados de profilling. Apenas em @ref{27,,cProfile}.
@end deffn

@geindex disable() (método profile.Profile)
@anchor{library/profile profile Profile disable}@anchor{44ae}
@deffn {Método} disable ()

Para de coletar dados de profilling. Apenas em @ref{27,,cProfile}.
@end deffn

@geindex create_stats() (método profile.Profile)
@anchor{library/profile profile Profile create_stats}@anchor{44af}
@deffn {Método} create_stats ()

Stop collecting profiling data and record the results internally
as the current profile.
@end deffn

@geindex print_stats() (método profile.Profile)
@anchor{library/profile profile Profile print_stats}@anchor{44b0}
@deffn {Método} print_stats (sort=-1)

Cria um objeto @ref{44a2,,Stats} com base no perfil atual e imprime os resultados para 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{44a6,,Stats.sort_stats}.


Adicionado na versão 3.13: @ref{44b0,,print_stats()} now accepts a tuple of keys.

@end deffn

@geindex dump_stats() (método profile.Profile)
@anchor{library/profile profile Profile dump_stats}@anchor{44b1}
@deffn {Método} dump_stats (filename)

Escreve os resultados do profile atual para `filename'.
@end deffn

@geindex run() (método profile.Profile)
@anchor{library/profile profile Profile run}@anchor{44b2}
@deffn {Método} run (cmd)

Profile the cmd via @ref{17f,,exec()}.
@end deffn

@geindex runctx() (método profile.Profile)
@anchor{library/profile profile Profile runctx}@anchor{44b3}
@deffn {Método} runctx (cmd, globals, locals)

Profile the cmd via @ref{17f,,exec()} with the specified global and
local environment.
@end deffn

@geindex runcall() (método profile.Profile)
@anchor{library/profile profile Profile runcall}@anchor{a87}
@deffn {Método} runcall (func, /, *args, **kwargs)

Profile @code{func(*args, **kwargs)}
@end deffn
@end deffn

Note that profiling will only work if the called command/function actually
returns.  If the interpreter is terminated (e.g. via a @ref{138e,,sys.exit()} call
during the called command/function execution) no profiling results will be
printed.

@node A classe Stats,What Is Deterministic Profiling?,profile and cProfile Module Reference,Os Profilers do Python
@anchor{library/profile profile-stats}@anchor{44b4}@anchor{library/profile the-stats-class}@anchor{44b5}
@subsubsection A classe @code{Stats}


Analysis of the profiler data is done using the @ref{44a2,,Stats} class.

@geindex module; pstats

@geindex Stats (classe em pstats)
@anchor{library/profile module-pstats}@anchor{b0}@anchor{library/profile pstats Stats}@anchor{44a2}
@deffn {Classe} pstats.Stats (*filenames or profile, stream=sys.stdout)

This class constructor creates an instance of a “statistics object” from a
`filename' (or list of filenames) or from a @code{Profile} instance. Output
will be printed to the stream specified by `stream'.

The file selected by the above constructor must have been created by the
corresponding version of @ref{af,,profile} or @ref{27,,cProfile}.  To be specific,
there is `no' file compatibility guaranteed with future versions of this
profiler, and there is no compatibility with files produced by other
profilers, or the same profiler run on a different operating system.  If
several files are provided, all the statistics for identical functions will
be coalesced, so that an overall view of several processes can be considered
in a single report.  If additional files need to be combined with data in an
existing @ref{44a2,,Stats} object, the @ref{44b6,,add()} method
can be used.

Instead of reading the profile data from a file, a @code{cProfile.Profile}
or @ref{9eb,,profile.Profile} object can be used as the profile data source.

Os objetos de @ref{44a2,,Stats} tem os seguintes métodos:

@geindex strip_dirs() (método pstats.Stats)
@anchor{library/profile pstats Stats strip_dirs}@anchor{44a8}
@deffn {Método} strip_dirs ()

This method for the @ref{44a2,,Stats} class removes all leading path
information from file names.  It is very useful in reducing the size of
the printout to fit within (close to) 80 columns.  This method modifies
the object, and the stripped information is lost.  After performing a
strip operation, the object is considered to have its entries in a
“random” order, as it was just after object initialization and loading.
If @ref{44a8,,strip_dirs()} causes two function names to be
indistinguishable (they are on the same line of the same filename, and
have the same function name), then the statistics for these two entries
are accumulated into a single entry.
@end deffn

@geindex add() (método pstats.Stats)
@anchor{library/profile pstats Stats add}@anchor{44b6}
@deffn {Método} add (*filenames)

This method of the @ref{44a2,,Stats} class accumulates additional profiling
information into the current profiling object.  Its arguments should refer
to filenames created by the corresponding version of @ref{44ab,,profile.run()}
or @code{cProfile.run()}. Statistics for identically named (re: file, line,
name) functions are automatically accumulated into single function
statistics.
@end deffn

@geindex dump_stats() (método pstats.Stats)
@anchor{library/profile pstats Stats dump_stats}@anchor{44b7}
@deffn {Método} dump_stats (filename)

Save the data loaded into the @ref{44a2,,Stats} object to a file named
`filename'.  The file is created if it does not exist, and is overwritten
if it already exists.  This is equivalent to the method of the same name
on the @ref{9eb,,profile.Profile} and @code{cProfile.Profile} classes.
@end deffn

@geindex sort_stats() (método pstats.Stats)
@anchor{library/profile pstats Stats sort_stats}@anchor{44a6}
@deffn {Método} sort_stats (*keys)

This method modifies the @ref{44a2,,Stats} object by sorting it according to
the supplied criteria.  The argument can be either a string or a SortKey
enum identifying the basis of a sort (example: @code{'time'}, @code{'name'},
@code{SortKey.TIME} or @code{SortKey.NAME}). The SortKey enums argument have
advantage over the string argument in that it is more robust and less
error prone.

When more than one key is provided, then additional keys are used as
secondary criteria when there is equality in all keys selected before
them.  For example, @code{sort_stats(SortKey.NAME, SortKey.FILE)} will sort
all the entries according to their function name, and resolve all ties
(identical function names) by sorting by file name.

For the string argument, abbreviations can be used for any key names, as
long as the abbreviation is unambiguous.

The following are the valid string and SortKey:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valid String Arg

@tab

Valid enum Arg

@tab

Significado

@item

@code{'calls'}

@tab

SortKey.CALLS

@tab

call count

@item

@code{'cumulative'}

@tab

SortKey.CUMULATIVE

@tab

cumulative time

@item

@code{'cumtime'}

@tab

N/D

@tab

cumulative time

@item

@code{'file'}

@tab

N/D

@tab

file name

@item

@code{'filename'}

@tab

SortKey.FILENAME

@tab

file name

@item

@code{'module'}

@tab

N/D

@tab

file name

@item

@code{'ncalls'}

@tab

N/D

@tab

call count

@item

@code{'pcalls'}

@tab

SortKey.PCALLS

@tab

primitive call count

@item

@code{'line'}

@tab

SortKey.LINE

@tab

line number

@item

@code{'name'}

@tab

SortKey.NAME

@tab

function name

@item

@code{'nfl'}

@tab

SortKey.NFL

@tab

name/file/line

@item

@code{'stdname'}

@tab

SortKey.STDNAME

@tab

standard name

@item

@code{'time'}

@tab

SortKey.TIME

@tab

internal time

@item

@code{'tottime'}

@tab

N/D

@tab

internal time

@end multitable


Note that all sorts on statistics are in descending order (placing most
time consuming items first), where as name, file, and line number searches
are in ascending order (alphabetical). The subtle distinction between
@code{SortKey.NFL} and @code{SortKey.STDNAME} is that the standard name is a
sort of the name as printed, which means that the embedded line numbers
get compared in an odd way.  For example, lines 3, 20, and 40 would (if
the file names were the same) appear in the string order 20, 3 and 40.
In contrast, @code{SortKey.NFL} does a numeric compare of the line numbers.
In fact, @code{sort_stats(SortKey.NFL)} is the same as
@code{sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)}.

For backward-compatibility reasons, the numeric arguments @code{-1}, @code{0},
@code{1}, and @code{2} are permitted.  They are interpreted as @code{'stdname'},
@code{'calls'}, @code{'time'}, and @code{'cumulative'} respectively.  If this old
style format (numeric) is used, only one sort key (the numeric key) will
be used, and additional arguments will be silently ignored.

@c For compatibility with the old profiler.


Adicionado na versão 3.7: Added the SortKey enum.

@end deffn

@geindex reverse_order() (método pstats.Stats)
@anchor{library/profile pstats Stats reverse_order}@anchor{44b8}
@deffn {Método} reverse_order ()

This method for the @ref{44a2,,Stats} class reverses the ordering of the
basic list within the object.  Note that by default ascending vs
descending order is properly selected based on the sort key of choice.

@c This method is provided primarily for compatibility with the old
@c profiler.
@end deffn

@geindex print_stats() (método pstats.Stats)
@anchor{library/profile pstats Stats print_stats}@anchor{44a9}
@deffn {Método} print_stats (*restrictions)

This method for the @ref{44a2,,Stats} class prints out a report as described
in the @ref{44ab,,profile.run()} definition.

The order of the printing is based on the last
@ref{44a6,,sort_stats()} operation done on the object (subject to
caveats in @ref{44b6,,add()} and
@ref{44a8,,strip_dirs()}).

The arguments provided (if any) can be used to limit the list down to the
significant entries.  Initially, the list is taken to be the complete set
of profiled functions.  Each restriction is either an integer (to select a
count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to
select a percentage of lines), or a string that will be interpreted as a
regular expression (to pattern match the standard name that is printed).
If several restrictions are provided, then they are applied sequentially.
For example:

@example
print_stats(.1, 'foo:')
@end example

would first limit the printing to first 10% of list, and then only print
functions that were part of filename @code{.*foo:}.  In contrast, the
command:

@example
print_stats('foo:', .1)
@end example

would limit the list to all functions having file names @code{.*foo:},
and then proceed to only print the first 10% of them.
@end deffn

@geindex print_callers() (método pstats.Stats)
@anchor{library/profile pstats Stats print_callers}@anchor{44b9}
@deffn {Método} print_callers (*restrictions)

This method for the @ref{44a2,,Stats} class prints a list of all functions
that called each function in the profiled database.  The ordering is
identical to that provided by @ref{44a9,,print_stats()}, and the
definition of the restricting argument is also identical.  Each caller is
reported on its own line.  The format differs slightly depending on the
profiler that produced the stats:


@itemize *

@item 
With @ref{af,,profile}, a number is shown in parentheses after each caller
to show how many times this specific call was made.  For convenience, a
second non-parenthesized number repeats the cumulative time spent in the
function at the right.

@item 
With @ref{27,,cProfile}, each caller is preceded by three numbers: the
number of times this specific call was made, and the total and
cumulative times spent in the current function while it was invoked by
this specific caller.
@end itemize
@end deffn

@geindex print_callees() (método pstats.Stats)
@anchor{library/profile pstats Stats print_callees}@anchor{44ba}
@deffn {Método} print_callees (*restrictions)

This method for the @ref{44a2,,Stats} class prints a list of all function
that were called by the indicated function.  Aside from this reversal of
direction of calls (re: called vs was called by), the arguments and
ordering are identical to the @ref{44b9,,print_callers()} method.
@end deffn

@geindex get_stats_profile() (método pstats.Stats)
@anchor{library/profile pstats Stats get_stats_profile}@anchor{44bb}
@deffn {Método} get_stats_profile ()

This method returns an instance of StatsProfile, which contains a mapping
of function names to instances of FunctionProfile. Each FunctionProfile
instance holds information related to the function’s profile such as how
long the function took to run, how many times it was called, etc…


Adicionado na versão 3.9: Added the following dataclasses: StatsProfile, FunctionProfile.
Added the following function: get_stats_profile.

@end deffn
@end deffn

@node What Is Deterministic Profiling?,Limitações,A classe Stats,Os Profilers do Python
@anchor{library/profile deterministic-profiling}@anchor{44bc}@anchor{library/profile what-is-deterministic-profiling}@anchor{44bd}
@subsubsection What Is Deterministic Profiling?


`Deterministic profiling' is meant to reflect the fact that all `function
call', `function return', and `exception' events are monitored, and precise
timings are made for the intervals between these events (during which time the
user’s code is executing).  In contrast, `statistical profiling' (which is
not done by this module) randomly samples the effective instruction pointer, and
deduces where time is being spent.  The latter technique traditionally involves
less overhead (as the code does not need to be instrumented), but provides only
relative indications of where time is being spent.

In Python, since there is an interpreter active during execution, the presence
of instrumented code is not required in order to do deterministic profiling.
Python automatically provides a `hook' (optional callback) for each event.
In addition, the interpreted nature of Python tends to add so much overhead to
execution, that deterministic profiling tends to only add small processing
overhead in typical applications.  The result is that deterministic profiling is
not that expensive, yet provides extensive run time statistics about the
execution of a Python program.

Call count statistics can be used to identify bugs in code (surprising counts),
and to identify possible inline-expansion points (high call counts).  Internal
time statistics can be used to identify “hot loops” that should be carefully
optimized.  Cumulative time statistics should be used to identify high level
errors in the selection of algorithms.  Note that the unusual handling of
cumulative times in this profiler allows statistics for recursive
implementations of algorithms to be directly compared to iterative
implementations.

@node Limitações,Calibration,What Is Deterministic Profiling?,Os Profilers do Python
@anchor{library/profile limitations}@anchor{44be}@anchor{library/profile profile-limitations}@anchor{44bf}
@subsubsection Limitações


One limitation has to do with accuracy of timing information. There is a
fundamental problem with deterministic profilers involving accuracy.  The most
obvious restriction is that the underlying “clock” is only ticking at a rate
(typically) of about .001 seconds.  Hence no measurements will be more accurate
than the underlying clock.  If enough measurements are taken, then the “error”
will tend to average out. Unfortunately, removing this first error induces a
second source of error.

The second problem is that it “takes a while” from when an event is dispatched
until the profiler’s call to get the time actually `gets' the state of the
clock.  Similarly, there is a certain lag when exiting the profiler event
handler from the time that the clock’s value was obtained (and then squirreled
away), until the user’s code is once again executing.  As a result, functions
that are called many times, or call many functions, will typically accumulate
this error. The error that accumulates in this fashion is typically less than
the accuracy of the clock (less than one clock tick), but it `can' accumulate
and become very significant.

The problem is more important with @ref{af,,profile} than with the lower-overhead
@ref{27,,cProfile}.  For this reason, @ref{af,,profile} provides a means of
calibrating itself for a given platform so that this error can be
probabilistically (on the average) removed. After the profiler is calibrated, it
will be more accurate (in a least square sense), but it will sometimes produce
negative numbers (when call counts are exceptionally low, and the gods of
probability work against you :-). )  Do `not' be alarmed by negative numbers in
the profile.  They should `only' appear if you have calibrated your profiler,
and the results are actually better than without calibration.

@node Calibration,Using a custom timer,Limitações,Os Profilers do Python
@anchor{library/profile calibration}@anchor{44c0}@anchor{library/profile profile-calibration}@anchor{44c1}
@subsubsection Calibration


The profiler of the @ref{af,,profile} module subtracts a constant from each event
handling time to compensate for the overhead of calling the time function, and
socking away the results.  By default, the constant is 0. The following
procedure can be used to obtain a better constant for a given platform (see
@ref{44bf,,Limitações}).

@example
import profile
pr = profile.Profile()
for i in range(5):
    print(pr.calibrate(10000))
@end example

The method executes the number of Python calls given by the argument, directly
and again under the profiler, measuring the time for both. It then computes the
hidden overhead per profiler event, and returns that as a float.  For example,
on a 1.8Ghz Intel Core i5 running macOS, and using Python’s time.process_time() as
the timer, the magical number is about 4.04e-6.

The object of this exercise is to get a fairly consistent result. If your
computer is `very' fast, or your timer function has poor resolution, you might
have to pass 100000, or even 1000000, to get consistent results.

When you have a consistent answer, there are three ways you can use it:

@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

If you have a choice, you are better off choosing a smaller constant, and then
your results will “less often” show up as negative in profile statistics.

@node Using a custom timer,,Calibration,Os Profilers do Python
@anchor{library/profile profile-timers}@anchor{44c2}@anchor{library/profile using-a-custom-timer}@anchor{44c3}
@subsubsection Using a custom timer


If you want to change how current time is determined (for example, to force use
of wall-clock time or elapsed process time), pass the timing function you want
to the @code{Profile} class constructor:

@example
pr = profile.Profile(your_time_func)
@end example

The resulting profiler will then call @code{your_time_func}. Depending on whether
you are using @ref{9eb,,profile.Profile} or @code{cProfile.Profile},
@code{your_time_func}’s return value will be interpreted differently:


@table @asis

@item @ref{9eb,,profile.Profile}

@code{your_time_func} should return a single number, or a list of numbers whose
sum is the current time (like what @ref{1154,,os.times()} returns).  If the
function returns a single time number, or the list of returned numbers has
length 2, then you will get an especially fast version of the dispatch
routine.

Be warned that you should calibrate the profiler class for the timer function
that you choose (see @ref{44c1,,Calibration}).  For most machines, a timer
that returns a lone integer value will provide the best results in terms of
low overhead during profiling.  (@ref{1154,,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} should return a single number.  If it returns integers,
you can also invoke the class constructor with a second argument specifying
the real duration of one unit of time.  For example, if
@code{your_integer_time_func} returns times measured in thousands of seconds,
you would construct the @code{Profile} instance as follows:

@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 adds several new functions in @ref{ee,,time} that can be used to make
precise measurements of process or wall-clock time. For example, see
@ref{a92,,time.perf_counter()}.

@node timeit — Mede o tempo de execução de pequenos trechos de código,trace — Rastreia ou acompanha a execução de instruções Python,Os Profilers do Python,Depuração e perfilamento
@anchor{library/timeit doc}@anchor{44c4}@anchor{library/timeit module-timeit}@anchor{ef}@anchor{library/timeit timeit-measure-execution-time-of-small-code-snippets}@anchor{44c5}@anchor{library/timeit translation-repo}@anchor{44c6}
@subsection @code{timeit} — Mede o tempo de execução de pequenos trechos de código


@geindex module; timeit

`Código-fonte:' Lib/timeit.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/timeit.py}

@geindex Benchmarking
@geindex Desempenho


__________________________________________________________________


Este módulo fornece uma maneira simples de cronometrar pequenos trechos do código Python. Ele tem uma @ref{44c7,,Interface de linha de comando} e um @ref{44c8,,chamável}.  Ele evita uma série de armadilhas comuns para medir os tempos de execução de um script. Veja também o capítulo “Algorithms” de Tim Peters, na segunda edição do `Python Cookbook', publicado pela O’Reilly.

@menu
* Exemplos básicos: Exemplos básicos<2>. 
* Interface em Python:: 
* Interface de linha de comando: Interface de linha de comando<10>. 
* Exemplos: Exemplos<30>. 

@end menu

@node Exemplos básicos<2>,Interface em Python,,timeit — Mede o tempo de execução de pequenos trechos de código
@anchor{library/timeit basic-examples}@anchor{44c9}
@subsubsection Exemplos básicos


O exemplo a seguir mostra como a @ref{44c7,,Interface de linha de comando} pode ser usado para comparar três expressões 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

Isso pode ser obtido da interface @ref{44c8,,Interface em Python}

@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

Um chamável também pode ser passado para a @ref{44c8,,Interface em Python}:

@example
>>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000)
0.19665591977536678
@end example

Observe, entretanto, que @ref{ead,,timeit()} determinará automaticamente o número de repetições somente quando a interface de linha de comando for usada. Na seção @ref{44ca,,Exemplos} você encontrará exemplos mais avançados.

@node Interface em Python,Interface de linha de comando<10>,Exemplos básicos<2>,timeit — Mede o tempo de execução de pequenos trechos de código
@anchor{library/timeit id1}@anchor{44cb}@anchor{library/timeit python-interface}@anchor{44c8}
@subsubsection Interface em Python


Este módulo define três funções e uma classe pública:

@geindex timeit() (no módulo timeit)
@anchor{library/timeit timeit timeit}@anchor{ead}
@deffn {Função} timeit.timeit (stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)

Cria uma instância de @ref{1510,,Timer} com o código de `setup' e a função `timer' função para executar o método @ref{d0e,,timeit()} com o total de execuções informado em `number'. O argumento opcional `globals' especifica um espaço de nomes no qual o código será executado.


Alterado na versão 3.5: O parâmetro opcional `globals' foi adicionado.

@end deffn

@geindex repeat() (no módulo timeit)
@anchor{library/timeit timeit repeat}@anchor{44cc}
@deffn {Função} timeit.repeat (stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)

Cria uma instância @ref{1510,,Timer} com a instrução fornecida, o código de `setup' e a função `timer' e para executar o método @ref{44cd,,repeat()} com o total de execuções informando em `repeat' e o `número' de execuções fornecidos. O argumento opcional `globals' especifica um espaço de nomes no qual executar o código.


Alterado na versão 3.5: O parâmetro opcional `globals' foi adicionado.



Alterado na versão 3.7: Valor padrão de `repetição' mudou de 3 para 5.

@end deffn

@geindex default_timer() (no módulo timeit)
@anchor{library/timeit timeit default_timer}@anchor{44ce}
@deffn {Função} timeit.default_timer ()

O cronômetro padrão, que é sempre time.perf_counter(), retorna segundos com ponto flutuante. Uma alternativa, time.perf_counter_ns, retorna um inteiro em nanossegundos.


Alterado na versão 3.3: @ref{a92,,time.perf_counter()} é o cronômetro padrão agora.

@end deffn

@geindex Timer (classe em timeit)
@anchor{library/timeit timeit Timer}@anchor{1510}
@deffn {Classe} timeit.Timer (stmt='pass', setup='pass', timer=<timer function>, globals=None)

Classe para cronometrar a velocidade de execução de pequenos trechos de código.

O construtor recebe uma instrução a ser cronometrada, uma instrução adicional usada para configuração e uma função de timer. Ambas as instruções têm como padrão @code{'pass'}; a função de timer é dependente da plataforma (veja a string do documento do módulo). `stmt' e `setup' também podem conter múltiplas instruções separadas por @code{;} ou novas linhas, desde que não contenham literais de string multilinhas. A instrução será, por padrão, executada dentro do espaço de nomes do `timeit'; esse comportamento pode ser controlado passando um espaço de nomes para `globals'.

Para medir o tempo de execução da primeira instrução use o método @ref{d0e,,timeit()}. Os métodos @ref{44cd,,repeat()} e @ref{d0d,,autorange()} são convenientes para chamar @ref{d0e,,timeit()} várias vezes.

O tempo de execução de `setup' é excluído do tempo total de execução cronometrado.

Os parâmetros `stmt' e `setup' também podem receber objetos que podem ser chamados sem argumentos. Isso incorporará chamadas a eles em uma função de timer que será executada por @ref{d0e,,timeit()}. Observe que a sobrecarga de temporização é um pouco maior neste caso por causa das chamadas de função extras.


Alterado na versão 3.5: O parâmetro opcional `globals' foi adicionado.


@geindex timeit() (método timeit.Timer)
@anchor{library/timeit timeit Timer timeit}@anchor{d0e}
@deffn {Método} timeit (number=1000000)

Mede o tempo para a quantidade `number' de execuções da instrução principal. Isso executa a instrução setup uma vez e, em seguida, retorna o tempo necessário para executar a instrução principal várias vezes. O temporizador padrão retorna segundos como um float. O argumento é o número de vezes que o laço passa, com padrão de um milhão. A instrução principal, a instrução de configuração e a função de timer a ser usada são passadas para o construtor.

@cartouche
@quotation Nota 
Por padrão, @ref{d0e,,timeit()} desativa temporariamente @ref{1a69,,coleta de lixo} durante a temporização. A vantagem dessa abordagem é que ela torna temporizações independentes mais comparáveis. A desvantagem é que o GC pode ser um componente importante do desempenho da função que está sendo medida. Se for assim, o GC pode ser reativado como a primeira instrução na string `setup'. Por exemplo:

@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 timeit.Timer)
@anchor{library/timeit timeit Timer autorange}@anchor{d0d}
@deffn {Método} autorange (callback=None)

Determina automaticamente quantas vezes chamar @ref{d0e,,timeit()}.

Esta é uma função de conveniência que chama @ref{d0e,,timeit()} repetidamente para que o tempo total seja >= 0,2 segundos, retornando o eventual (número de voltas, tempo gasto para esse número de voltas). Ela chama @ref{d0e,,timeit()} com números crescentes da sequência 1, 2, 5, 10, 20, 50, … até que o tempo gasto seja de pelo menos 0,2 segundos.

Se `callback' for fornecido e não for @code{None}, ele será chamado após cada tentativa e tem dois argumento: @code{callback(number, time_taken)}.


Adicionado na versão 3.6.

@end deffn

@geindex repeat() (método timeit.Timer)
@anchor{library/timeit timeit Timer repeat}@anchor{44cd}
@deffn {Método} repeat (repeat=5, number=1000000)

Chama @ref{d0e,,timeit()} algumas vezes.

Esse é um função de conveniência que chama o @ref{d0e,,timeit()} repetidamente e retorna uma lista de resultados.  O primeiro argumento especifica quantas vezes deve chamar o @ref{d0e,,timeit()}.  O segundo argumento especifica o argumento `number' para @ref{d0e,,timeit()}.

@cartouche
@quotation Nota 
É tentador calcular a média e o desvio padrão do vetor de resultados e relatá-los. No entanto, isso não é muito útil. Em um caso típico, o menor valor fornece um limite inferior para a velocidade com que sua máquina pode executar o trecho de código fornecido; valores mais altos no vetor de resultados normalmente não são causados pela variabilidade na velocidade do Python, mas por outros processos que interferem na precisão do seu tempo. Portanto, o @ref{f3a,,min()} do resultado é provavelmente o único número no qual você deve se interessar. Depois disso, você deve analisar o vetor inteiro e aplicar o bom senso em vez de estatística.
@end quotation
@end cartouche


Alterado na versão 3.7: Valor padrão de `repetição' mudou de 3 para 5.

@end deffn

@geindex print_exc() (método timeit.Timer)
@anchor{library/timeit timeit Timer print_exc}@anchor{44cf}
@deffn {Método} print_exc (file=None)

Função auxiliar para imprimir um traceback do código cronometrado.

Uso típico:

@example
t = Timer(...)       # fora do try/except
try:
    t.timeit(...)    # ou t.repeat(...)
except Exception:
    t.print_exc()
@end example

A vantagem em relação ao traceback padrão é que as linhas de origem no modelo compilado serão exibidas.  O argumento opcional `file' direciona para onde o traceback é enviado; o padrão é @ref{940,,sys.stderr}.
@end deffn
@end deffn

@node Interface de linha de comando<10>,Exemplos<30>,Interface em Python,timeit — Mede o tempo de execução de pequenos trechos de código
@anchor{library/timeit command-line-interface}@anchor{44d0}@anchor{library/timeit timeit-command-line-interface}@anchor{44c7}
@subsubsection Interface de linha de comando


Quando chamado como um programa a partir da linha de comando, as seguintes opções estão disponíveis:

@example
python -m timeit [-n N] [-r N] [-u U] [-s S] [-p] [-v] [-h] [instrução ...]
@end example

As seguintes opções são permitidas

@geindex timeit opção de linha de comando; -n
@geindex timeit opção de linha de comando; --number
@anchor{library/timeit cmdoption-timeit-n}@anchor{44d1}@anchor{library/timeit cmdoption-timeit-number}@anchor{44d2}
@deffn {Option} @w{-}n N, @w{-}@w{-}number=N

Quantas vezes deve executar ‘statement’
@end deffn

@geindex timeit opção de linha de comando; -r
@geindex timeit opção de linha de comando; --repeat
@anchor{library/timeit cmdoption-timeit-r}@anchor{44d3}@anchor{library/timeit cmdoption-timeit-repeat}@anchor{44d4}
@deffn {Option} @w{-}r N, @w{-}@w{-}repeat=N

Quantidade de vezes para repetir o cronômetro (o valor padrão é 5)
@end deffn

@geindex timeit opção de linha de comando; -s
@geindex timeit opção de linha de comando; --setup
@anchor{library/timeit cmdoption-timeit-s}@anchor{44d5}@anchor{library/timeit cmdoption-timeit-setup}@anchor{44d6}
@deffn {Option} @w{-}s S, @w{-}@w{-}setup=S

instrução a ser executada apenas uma vez e quando iniciada (padrão @code{pass} )
@end deffn

@geindex timeit opção de linha de comando; -p
@geindex timeit opção de linha de comando; --process
@anchor{library/timeit cmdoption-timeit-p}@anchor{44d7}@anchor{library/timeit cmdoption-timeit-process}@anchor{44d8}
@deffn {Option} @w{-}p, @w{-}@w{-}process

mede apenas o tempo de processamento, e não o tempo total de execução, usando @ref{a93,,time.process_time()} em vez de @ref{a92,,time.perf_counter()}, que é o padrão


Adicionado na versão 3.3.

@end deffn

@geindex timeit opção de linha de comando; -u
@geindex timeit opção de linha de comando; --unit
@anchor{library/timeit cmdoption-timeit-u}@anchor{44d9}@anchor{library/timeit cmdoption-timeit-unit}@anchor{44da}
@deffn {Option} @w{-}u, @w{-}@w{-}unit=U

especifique uma unidade de tempo para a saída do cronômetro; pode selecionar @code{nsec}, @code{usec}, @code{msec}, ou @code{sec}


Adicionado na versão 3.5.

@end deffn

@geindex timeit opção de linha de comando; -v
@geindex timeit opção de linha de comando; --verbose
@anchor{library/timeit cmdoption-timeit-v}@anchor{44db}@anchor{library/timeit cmdoption-timeit-verbose}@anchor{44dc}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

imprime resultados brutos de tempo; repetir para obter mais precisão de dígitos
@end deffn

@geindex timeit opção de linha de comando; -h
@geindex timeit opção de linha de comando; --help
@anchor{library/timeit cmdoption-timeit-h}@anchor{44dd}@anchor{library/timeit cmdoption-timeit-help}@anchor{44de}
@deffn {Option} @w{-}h, @w{-}@w{-}help

imprime uma mensagem curta de uso e sai
@end deffn

Uma instrução multilinha pode ser fornecida especificando cada linha como um argumento de instrução separado; linhas indentadas são possíveis colocando um argumento entre aspas e usando espaços à esquerda. Múltiplas opções @ref{44d5,,-s} são tratadas de forma semelhante.

Se @ref{44d1,,-n} não for informada, um número adequado de loops será calculado tentando adicionar números numa sequência como 1, 2, 5, 10, 20, 50, … até que o tempo total seja de pelo menos 0,2 segundos.

As medições de @ref{44ce,,default_timer()} podem ser afetadas por outros programas em execução na mesma máquina, portanto, a melhor coisa a fazer quando uma cronometragem precisa é repeti-la algumas vezes e usar o melhor tempo. A opção @ref{44d3,,-r} é boa para isso; o padrão de 5 repetições provavelmente é suficiente na maioria dos casos. Você pode usar @ref{a93,,time.process_time()} para medir o tempo de CPU.

@cartouche
@quotation Nota 
Há uma certa sobrecarga padrão associada à execução de uma instrução `pass'. O código aqui não tenta ocultá-lo, mas você deve estar ciente disso.  A sobrecarga padrão pode ser medida invocando pelo programa sem argumento, e pode ser diferente entre diferentes versões Python.
@end quotation
@end cartouche

@node Exemplos<30>,,Interface de linha de comando<10>,timeit — Mede o tempo de execução de pequenos trechos de código
@anchor{library/timeit examples}@anchor{44df}@anchor{library/timeit timeit-examples}@anchor{44ca}
@subsubsection Exemplos


É possível fornecer uma instrução de configuração que é executada apenas uma vez no início:

@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

Na saída, existem três campos. A contagem de laços, que informa quantas vezes o corpo da instrução foi executado por repetição do laço de temporização. A contagem de repetições (‘melhor de 5’) que informa quantas vezes o laço de temporização foi repetido e, finalmente, o tempo que o corpo da instrução levou, em média, na melhor repetição do laço de temporização. Ou seja, o tempo necessário para a repetição mais rápida dividido pela contagem de interações.

@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

O mesmo pode ser feito usando a classe @ref{1510,,Timer} e seus 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

Os exemplos a seguir mostram como cronometrar expressões que contêm várias linhas. Aqui comparamos o custo de usar @ref{4d2,,hasattr()} vs. @ref{6e9,,try}/@ref{18b,,except} para testar atributos de objetos presentes e ausentes:

@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
>>> # atributo está em falta
>>> 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
>>>
>>> # atributo está presente
>>> 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 ao módulo @ref{ef,,timeit} acesso as funções que você definiu, você pode passar o parâmetro `setup', que contém um instrução de importar:

@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

Outra opção é passar @ref{1993,,globals()} para o parâmetro `globals', o que fará com que o código seja executado em seu espaço de nomes global. Isso pode ser mais conveniente do que especificar individualmente imports:

@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 — Rastreia ou acompanha a execução de instruções Python,tracemalloc — Trace memory allocations,timeit — Mede o tempo de execução de pequenos trechos de código,Depuração e perfilamento
@anchor{library/trace doc}@anchor{44e0}@anchor{library/trace module-trace}@anchor{fd}@anchor{library/trace trace-trace-or-track-python-statement-execution}@anchor{44e1}@anchor{library/trace translation-repo}@anchor{44e2}
@subsection @code{trace} — Rastreia ou acompanha a execução de instruções Python


@geindex module; trace

`Código-fonte:' Lib/trace.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/trace.py}


__________________________________________________________________


O módulo @ref{fd,,trace} permite que você rastreie a execução do programa, gere listagens de cobertura de instrução anotada, imprima relações de chamador/receptor e funções de lista executadas durante a execução de um programa. Ele pode ser usado em outro programa ou na linha de comando.


@subsubheading Ver também



@table @asis

@item Coverage.py@footnote{https://coverage.readthedocs.io/}

Uma popular ferramenta de cobertura de terceiros que fornece saída HTML junto com recursos avançados, como cobertura de ramificações.
@end table


@menu
* Uso na linha de comando: Uso na linha de comando<7>. 
* Interface programática:: 

@end menu

@node Uso na linha de comando<7>,Interface programática,,trace — Rastreia ou acompanha a execução de instruções Python
@anchor{library/trace command-line-usage}@anchor{44e3}@anchor{library/trace trace-cli}@anchor{44e4}
@subsubsection Uso na linha de comando


O módulo @ref{fd,,trace} pode ser chamado a partir da linha de comando. Pode ser tão simples quanto:

@example
python -m trace --count -C . algumarquivo.py ...
@end example

O comando acima irá executar @code{algumarquivo.py} e gerar listagens anotadas de todos os módulos Python importados durante a execução para o diretório atual.

@geindex trace opção de linha de comando; --help
@anchor{library/trace cmdoption-trace-help}@anchor{44e5}
@deffn {Option} @w{-}@w{-}help

Exibe o modo de uso e sai.
@end deffn

@geindex trace opção de linha de comando; --version
@anchor{library/trace cmdoption-trace-version}@anchor{44e6}
@deffn {Option} @w{-}@w{-}version

Exibe a versão do módulo e sai.
@end deffn


Adicionado na versão 3.8: Adicionada a opção @code{--module} que permite executar um módulo executável.


@menu
* Opções principais:: 
* Modificadores:: 
* Filtros:: 

@end menu

@node Opções principais,Modificadores,,Uso na linha de comando<7>
@anchor{library/trace main-options}@anchor{44e7}
@subsubsection Opções principais


Pelo menos uma das seguintes opções deve ser especificada ao invocar @ref{fd,,trace}. A opção @ref{44e8,,--listfuncs} é mutuamente exclusiva com as opções @ref{44e9,,--trace} e @ref{44ea,,--count}. Quando @ref{44e8,,--listfuncs} é fornecida, nem @ref{44ea,,--count} nem @ref{44e9,,--trace} são aceitas, e vice-versa.

@geindex trace opção de linha de comando; -c
@geindex trace opção de linha de comando; --count
@anchor{library/trace cmdoption-trace-c}@anchor{44ea}@anchor{library/trace cmdoption-trace-count}@anchor{44eb}
@deffn {Option} @w{-}c, @w{-}@w{-}count

Produz um conjunto de arquivos de listagem anotada após a conclusão do programa que mostra quantas vezes cada instrução foi executada. Veja também @ref{44ec,,--coverdir}, @ref{44ed,,--file} e @ref{44ee,,--no-report} abaixo.
@end deffn

@geindex trace opção de linha de comando; -t
@geindex trace opção de linha de comando; --trace
@anchor{library/trace cmdoption-trace-t}@anchor{44e9}@anchor{library/trace cmdoption-trace-trace}@anchor{44ef}
@deffn {Option} @w{-}t, @w{-}@w{-}trace

Exibe linhas como elas são executadas.
@end deffn

@geindex trace opção de linha de comando; -l
@geindex trace opção de linha de comando; --listfuncs
@anchor{library/trace cmdoption-trace-l}@anchor{44e8}@anchor{library/trace cmdoption-trace-listfuncs}@anchor{44f0}
@deffn {Option} @w{-}l, @w{-}@w{-}listfuncs

Exibe as funções executadas executando o programa.
@end deffn

@geindex trace opção de linha de comando; -r
@geindex trace opção de linha de comando; --report
@anchor{library/trace cmdoption-trace-r}@anchor{44f1}@anchor{library/trace cmdoption-trace-report}@anchor{44f2}
@deffn {Option} @w{-}r, @w{-}@w{-}report

Produz uma lista anotada de uma execução de programa anterior que usava a opção @ref{44ea,,--count} e @ref{44ed,,--file}. Isso não executa nenhum código.
@end deffn

@geindex trace opção de linha de comando; -T
@geindex trace opção de linha de comando; --trackcalls
@anchor{library/trace cmdoption-trace-T}@anchor{44f3}@anchor{library/trace cmdoption-trace-trackcalls}@anchor{44f4}
@deffn {Option} @w{-}T, @w{-}@w{-}trackcalls

Exibe os relacionamentos de chamada expostos ao executar o programa.
@end deffn

@node Modificadores,Filtros,Opções principais,Uso na linha de comando<7>
@anchor{library/trace modifiers}@anchor{44f5}
@subsubsection Modificadores


@geindex trace opção de linha de comando; -f
@geindex trace opção de linha de comando; --file
@anchor{library/trace cmdoption-trace-f}@anchor{44ed}@anchor{library/trace cmdoption-trace-file}@anchor{44f6}
@deffn {Option} @w{-}f, @w{-}@w{-}file=<file>

Nome de um arquivo para acumular contagens em várias execuções de rastreamento. Deve ser usado com a opção @ref{44ea,,--count}.
@end deffn

@geindex trace opção de linha de comando; -C
@geindex trace opção de linha de comando; --coverdir
@anchor{library/trace cmdoption-trace-C}@anchor{44ec}@anchor{library/trace cmdoption-trace-coverdir}@anchor{44f7}
@deffn {Option} @w{-}C, @w{-}@w{-}coverdir=<dir>

Diretório para onde vão os arquivos de relatório. O relatório de cobertura para @code{pacote.módulo} é escrito em arquivo @code{`dir'/`pacote'/`módulo'.cover}.
@end deffn

@geindex trace opção de linha de comando; -m
@geindex trace opção de linha de comando; --missing
@anchor{library/trace cmdoption-trace-m}@anchor{44f8}@anchor{library/trace cmdoption-trace-missing}@anchor{44f9}
@deffn {Option} @w{-}m, @w{-}@w{-}missing

Ao gerar listagens anotadas, marca as linhas que não foram executadas com @code{>>>>>>}.
@end deffn

@geindex trace opção de linha de comando; -s
@geindex trace opção de linha de comando; --summary
@anchor{library/trace cmdoption-trace-s}@anchor{44fa}@anchor{library/trace cmdoption-trace-summary}@anchor{44fb}
@deffn {Option} @w{-}s, @w{-}@w{-}summary

Ao usar @ref{44ea,,--count} ou @ref{44f1,,--report}, escreve um breve resumo no stdout para cada arquivo processado.
@end deffn

@geindex trace opção de linha de comando; -R
@geindex trace opção de linha de comando; --no-report
@anchor{library/trace cmdoption-trace-R}@anchor{44ee}@anchor{library/trace cmdoption-trace-no-report}@anchor{44fc}
@deffn {Option} @w{-}R, @w{-}@w{-}no@w{-}report

Não gera listagens anotadas. Isso é útil se você pretende fazer várias execuções com @ref{44ea,,--count}, e então produzir um único conjunto de listagens anotadas no final.
@end deffn

@geindex trace opção de linha de comando; -g
@geindex trace opção de linha de comando; --timing
@anchor{library/trace cmdoption-trace-g}@anchor{44fd}@anchor{library/trace cmdoption-trace-timing}@anchor{44fe}
@deffn {Option} @w{-}g, @w{-}@w{-}timing

Prefixa cada linha com o tempo desde o início do programa. Usado apenas durante o rastreamento.
@end deffn

@node Filtros,,Modificadores,Uso na linha de comando<7>
@anchor{library/trace filters}@anchor{44ff}
@subsubsection Filtros


Essas opções podem ser repetidas várias vezes.

@geindex trace opção de linha de comando; --ignore-module
@anchor{library/trace cmdoption-trace-ignore-module}@anchor{4500}
@deffn {Option} @w{-}@w{-}ignore@w{-}module=<mod>

Ignora cada um dos nomes de módulo fornecidos e seus submódulos (se for um pacote). O argumento pode ser uma lista de nomes separados por uma vírgula.
@end deffn

@geindex trace opção de linha de comando; --ignore-dir
@anchor{library/trace cmdoption-trace-ignore-dir}@anchor{4501}
@deffn {Option} @w{-}@w{-}ignore@w{-}dir=<dir>

Ignora todos os módulos e pacotes no diretório e subdiretórios nomeados. O argumento pode ser uma lista de diretórios separados por @ref{1ecc,,os.pathsep}.
@end deffn

@node Interface programática,,Uso na linha de comando<7>,trace — Rastreia ou acompanha a execução de instruções Python
@anchor{library/trace programmatic-interface}@anchor{4502}@anchor{library/trace trace-api}@anchor{4503}
@subsubsection Interface programática


@geindex Trace (classe em trace)
@anchor{library/trace trace Trace}@anchor{4504}
@deffn {Classe} trace.Trace (count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)

Cria um objeto para rastrear a execução de uma única instrução ou expressão. Todos os parâmetros são opcionais. `count' ativa a contagem de números de linha. `trace' ativa o rastreamento de execução de linha. `countfuncs' ativa a listagem das funções chamadas durante a execução. `countcallers' ativa o rastreamento de relacionamento de chamada. `ignoremods' é uma lista de módulos ou pacotes a serem ignorados. `ignoreirs' é uma lista de diretórios cujos módulos ou pacotes devem ser ignorados. `infile' é o nome do arquivo do qual deve ler as informações de contagem armazenadas. `outfile' é o nome do arquivo no qual deve escrever as informações de contagem atualizadas. `timing' ativa a exibição de um carimbo de data/hora relativo ao momento em que o rastreamento foi iniciado.

@geindex run() (método trace.Trace)
@anchor{library/trace trace Trace run}@anchor{4505}
@deffn {Método} run (cmd)

Executa o comando e reúne estatísticas da execução com os parâmetros de rastreamento atuais. `cmd' deve ser uma string ou objeto código, adequado para passar para @ref{17f,,exec()}.
@end deffn

@geindex runctx() (método trace.Trace)
@anchor{library/trace trace Trace runctx}@anchor{4506}
@deffn {Método} runctx (cmd, globals=None, locals=None)

Executa o comando e reúne estatísticas da execução com os parâmetros de rastreamento atuais, nos ambientes global e local definidos. Se não for definido, `globals' e `locals' usam como padrão dicionários vazios.
@end deffn

@geindex runfunc() (método trace.Trace)
@anchor{library/trace trace Trace runfunc}@anchor{a89}
@deffn {Método} runfunc (func, /, *args, **kwds)

Chama `func' com os argumentos fornecidos sob controle do objeto @ref{4504,,Trace} com os parâmetros de rastreamento atuais.
@end deffn

@geindex results() (método trace.Trace)
@anchor{library/trace trace Trace results}@anchor{4507}
@deffn {Método} results ()

Retorna um objeto @ref{4508,,CoverageResults} que contém os resultados cumulativos de todas as chamadas anteriores para @code{run}, @code{runctx} e @code{runfunc} para a instância @ref{4504,,Trace} fornecida. Não redefine os resultados de rastreamento acumulados.
@end deffn
@end deffn

@geindex CoverageResults (classe em trace)
@anchor{library/trace trace CoverageResults}@anchor{4508}
@deffn {Classe} trace.CoverageResults

Um contêiner para resultados de cobertura, criado por @ref{4507,,Trace.results()}. Não deve ser criado diretamente pelo usuário.

@geindex update() (método trace.CoverageResults)
@anchor{library/trace trace CoverageResults update}@anchor{4509}
@deffn {Método} update (other)

Mescla dados de outro objeto @ref{4508,,CoverageResults}.
@end deffn

@geindex write_results() (método trace.CoverageResults)
@anchor{library/trace trace CoverageResults write_results}@anchor{450a}
@deffn {Método} write_results (show_missing=True, summary=False, coverdir=None, *, ignore_missing_files=False)

Escreve os resultados da cobertura. Defina `show_missing' para mostrar as linhas que não tiveram ocorrências. Defina o `summary' para incluir na saída o resumo da cobertura por módulo. `coverdir' especifica o diretório no qual os arquivos de resultados de cobertura serão enviados. Se for @code{None}, os resultados de cada arquivo de origem são colocados em seu diretório.

Se `ignore_missing_files' for @code{True}, as contagens de cobertura para arquivos que não existem mais serão ignoradas silenciosamente. Caso contrário, um arquivo ausente vai levantar @ref{42b,,FileNotFoundError}.


Alterado na versão 3.13: Adicionado o parâmetro `ignore_missing_files'.

@end deffn
@end deffn

Um exemplo simples que demonstra o uso da interface programática:

@example
import sys
import trace

# cria um objeto Trace, dizendo a ele o que ignorar e se deve
# fazer rastreamento ou contagem de linhas ou ambos.
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# executa o novo comando usando o rastreador fornecido
tracer.run('main()')

# faz um relatório, colocando a saída no diretório atual
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")
@end example

@node tracemalloc — Trace memory allocations,,trace — Rastreia ou acompanha a execução de instruções Python,Depuração e perfilamento
@anchor{library/tracemalloc doc}@anchor{450b}@anchor{library/tracemalloc module-tracemalloc}@anchor{ff}@anchor{library/tracemalloc tracemalloc-trace-memory-allocations}@anchor{450c}@anchor{library/tracemalloc translation-repo}@anchor{450d}
@subsection @code{tracemalloc} — Trace memory allocations


@geindex module; tracemalloc


Adicionado na versão 3.4.


`Código-fonte:' Lib/tracemalloc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tracemalloc.py}


__________________________________________________________________


The tracemalloc module is a debug tool to trace memory blocks allocated by
Python. It provides the following information:


@itemize *

@item 
Traceback where an object was allocated

@item 
Statistics on allocated memory blocks per filename and per line number:
total size, number and average size of allocated memory blocks

@item 
Compute the differences between two snapshots to detect memory leaks
@end itemize

To trace most memory blocks allocated by Python, the module should be started
as early as possible by setting the 
@geindex PYTHONTRACEMALLOC
@geindex variável de ambiente; PYTHONTRACEMALLOC
@ref{1ec4,,PYTHONTRACEMALLOC} environment
variable to @code{1}, or by using @ref{176,,-X} @code{tracemalloc} command line
option. The @ref{1ec3,,tracemalloc.start()} function can be called at runtime to
start tracing Python memory allocations.

By default, a trace of an allocated memory block only stores the most recent
frame (1 frame). To store 25 frames at startup: set the
@geindex PYTHONTRACEMALLOC
@geindex variável de ambiente; PYTHONTRACEMALLOC
@ref{1ec4,,PYTHONTRACEMALLOC} environment variable to @code{25}, or use the
@ref{176,,-X} @code{tracemalloc=25} command line option.

@menu
* Exemplos: Exemplos<31>. 
* API:: 

@end menu

@node Exemplos<31>,API,,tracemalloc — Trace memory allocations
@anchor{library/tracemalloc examples}@anchor{450e}
@subsubsection Exemplos


@menu
* Exibe o top 10:: 
* Compute differences:: 
* Get the traceback of a memory block:: 
* Pretty top:: 

@end menu

@node Exibe o top 10,Compute differences,,Exemplos<31>
@anchor{library/tracemalloc display-the-top-10}@anchor{450f}
@subsubsection Exibe o top 10


Display the 10 files allocating the most memory:

@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

Example of output of the Python test suite:

@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

We can see that Python loaded @code{4855 KiB} data (bytecode and constants) from
modules and that the @ref{1d,,collections} module allocated @code{244 KiB} to build
@ref{1ca,,namedtuple} types.

See @ref{4510,,Snapshot.statistics()} for more options.

@node Compute differences,Get the traceback of a memory block,Exibe o top 10,Exemplos<31>
@anchor{library/tracemalloc compute-differences}@anchor{4511}
@subsubsection Compute differences


Take two snapshots and display the differences:

@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

Example of output before/after running some tests of the Python test suite:

@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

We can see that Python has loaded @code{8173 KiB} of module data (bytecode and
constants), and that this is @code{4428 KiB} more than had been loaded before the
tests, when the previous snapshot was taken. Similarly, the @ref{85,,linecache}
module has cached @code{940 KiB} of Python source code to format tracebacks, all
of it since the previous snapshot.

If the system has little free memory, snapshots can be written on disk using
the @ref{4512,,Snapshot.dump()} method to analyze the snapshot offline. Then use the
@ref{4513,,Snapshot.load()} method reload the snapshot.

@node Get the traceback of a memory block,Pretty top,Compute differences,Exemplos<31>
@anchor{library/tracemalloc get-the-traceback-of-a-memory-block}@anchor{4514}
@subsubsection Get the traceback of a memory block


Code to display the traceback of the biggest memory block:

@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

Example of output of the Python test suite (traceback limited to 25 frames):

@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

We can see that the most memory was allocated in the @ref{77,,importlib} module to
load data (bytecode and constants) from modules: @code{870.1 KiB}. The traceback is
where the @ref{77,,importlib} loaded data most recently: on the @code{import pdb}
line of the @ref{3a,,doctest} module. The traceback may change if a new module is
loaded.

@node Pretty top,,Get the traceback of a memory block,Exemplos<31>
@anchor{library/tracemalloc pretty-top}@anchor{4515}
@subsubsection Pretty top


Code to display the 10 lines allocating the most memory with a pretty output,
ignoring @code{<frozen importlib._bootstrap>} and @code{<unknown>} files:

@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

Example of output of the Python test suite:

@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

See @ref{4510,,Snapshot.statistics()} for more options.

@menu
* Record the current and peak size of all traced memory blocks:: 

@end menu

@node Record the current and peak size of all traced memory blocks,,,Pretty top
@anchor{library/tracemalloc record-the-current-and-peak-size-of-all-traced-memory-blocks}@anchor{4516}
@subsubsection Record the current and peak size of all traced memory blocks


The following code computes two sums like @code{0 + 1 + 2 + ...} inefficiently, by
creating a list of those numbers. This list consumes a lot of memory
temporarily. We can use @ref{4517,,get_traced_memory()} and @ref{942,,reset_peak()} to
observe the small memory usage after the sum is computed as well as the peak
memory usage during the computations:

@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

Saída:

@example
first_size=664, first_peak=3592984
second_size=804, second_peak=29704
@end example

Using @ref{942,,reset_peak()} ensured we could accurately record the peak during the
computation of @code{small_sum}, even though it is much smaller than the overall
peak size of memory blocks since the @ref{1ec3,,start()} call. Without the call to
@ref{942,,reset_peak()}, @code{second_peak} would still be the peak from the
computation @code{large_sum} (that is, equal to @code{first_peak}). In this case,
both peaks are much higher than the final memory usage, and which suggests we
could optimise (by removing the unnecessary call to @ref{611,,list}, and writing
@code{sum(range(...))}).

@node API,,Exemplos<31>,tracemalloc — Trace memory allocations
@anchor{library/tracemalloc api}@anchor{4518}
@subsubsection API


@menu
* Funções: Funções<11>. 
* DomainFilter:: 
* Filter:: 
* Frame:: 
* Snapshot:: 
* Statistic:: 
* StatisticDiff:: 
* Trace:: 
* Traceback:: 

@end menu

@node Funções<11>,DomainFilter,,API
@anchor{library/tracemalloc functions}@anchor{4519}
@subsubsection Funções


@geindex clear_traces() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc clear_traces}@anchor{451a}
@deffn {Função} tracemalloc.clear_traces ()

Clear traces of memory blocks allocated by Python.

See also @ref{1668,,stop()}.
@end deffn

@geindex get_object_traceback() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_object_traceback}@anchor{1cd2}
@deffn {Função} tracemalloc.get_object_traceback (obj)

Get the traceback where the Python object `obj' was allocated.
Return a @ref{bae,,Traceback} instance, or @code{None} if the @ref{ff,,tracemalloc}
module is not tracing memory allocations or did not trace the allocation of
the object.

See also @ref{807,,gc.get_referrers()} and @ref{1863,,sys.getsizeof()} functions.
@end deffn

@geindex get_traceback_limit() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_traceback_limit}@anchor{451b}
@deffn {Função} tracemalloc.get_traceback_limit ()

Get the maximum number of frames stored in the traceback of a trace.

The @ref{ff,,tracemalloc} module must be tracing memory allocations to
get the limit, otherwise an exception is raised.

The limit is set by the @ref{1ec3,,start()} function.
@end deffn

@geindex get_traced_memory() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_traced_memory}@anchor{4517}
@deffn {Função} tracemalloc.get_traced_memory ()

Get the current size and peak size of memory blocks traced by the
@ref{ff,,tracemalloc} module as a tuple: @code{(current: int, peak: int)}.
@end deffn

@geindex reset_peak() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc reset_peak}@anchor{942}
@deffn {Função} tracemalloc.reset_peak ()

Set the peak size of memory blocks traced by the @ref{ff,,tracemalloc} module
to the current size.

Do nothing if the @ref{ff,,tracemalloc} module is not tracing memory
allocations.

This function only modifies the recorded peak size, and does not modify or
clear any traces, unlike @ref{451a,,clear_traces()}. Snapshots taken with
@ref{451c,,take_snapshot()} before a call to @ref{942,,reset_peak()} can be
meaningfully compared to snapshots taken after the call.

See also @ref{4517,,get_traced_memory()}.


Adicionado na versão 3.9.

@end deffn

@geindex get_tracemalloc_memory() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc get_tracemalloc_memory}@anchor{451d}
@deffn {Função} tracemalloc.get_tracemalloc_memory ()

Get the memory usage in bytes of the @ref{ff,,tracemalloc} module used to store
traces of memory blocks.
Return an @ref{257,,int}.
@end deffn

@geindex is_tracing() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc is_tracing}@anchor{451e}
@deffn {Função} tracemalloc.is_tracing ()

@code{True} if the @ref{ff,,tracemalloc} module is tracing Python memory
allocations, @code{False} otherwise.

See also @ref{1ec3,,start()} and @ref{1668,,stop()} functions.
@end deffn

@geindex start() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc start}@anchor{1ec3}
@deffn {Função} tracemalloc.start (nframe: int = 1)

Start tracing Python memory allocations: install hooks on Python memory
allocators. Collected tracebacks of traces will be limited to `nframe'
frames. By default, a trace of a memory block only stores the most recent
frame: the limit is @code{1}. `nframe' must be greater or equal to @code{1}.

You can still read the original number of total frames that composed the
traceback by looking at the @ref{451f,,Traceback.total_nframe} attribute.

Storing more than @code{1} frame is only useful to compute statistics grouped
by @code{'traceback'} or to compute cumulative statistics: see the
@ref{4520,,Snapshot.compare_to()} and @ref{4510,,Snapshot.statistics()} methods.

Storing more frames increases the memory and CPU overhead of the
@ref{ff,,tracemalloc} module. Use the @ref{451d,,get_tracemalloc_memory()} function
to measure how much memory is used by the @ref{ff,,tracemalloc} module.

The 
@geindex PYTHONTRACEMALLOC
@geindex variável de ambiente; PYTHONTRACEMALLOC
@ref{1ec4,,PYTHONTRACEMALLOC} environment variable
(@code{PYTHONTRACEMALLOC=NFRAME}) and the @ref{176,,-X} @code{tracemalloc=NFRAME}
command line option can be used to start tracing at startup.

See also @ref{1668,,stop()}, @ref{451e,,is_tracing()} and @ref{451b,,get_traceback_limit()}
functions.
@end deffn

@geindex stop() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc stop}@anchor{1668}
@deffn {Função} tracemalloc.stop ()

Stop tracing Python memory allocations: uninstall hooks on Python memory
allocators. Also clears all previously collected traces of memory blocks
allocated by Python.

Call @ref{451c,,take_snapshot()} function to take a snapshot of traces before
clearing them.

See also @ref{1ec3,,start()}, @ref{451e,,is_tracing()} and @ref{451a,,clear_traces()}
functions.
@end deffn

@geindex take_snapshot() (no módulo tracemalloc)
@anchor{library/tracemalloc tracemalloc take_snapshot}@anchor{451c}
@deffn {Função} tracemalloc.take_snapshot ()

Take a snapshot of traces of memory blocks allocated by Python. Return a new
@ref{4521,,Snapshot} instance.

The snapshot does not include memory blocks allocated before the
@ref{ff,,tracemalloc} module started to trace memory allocations.

Tracebacks of traces are limited to @ref{451b,,get_traceback_limit()} frames. Use
the `nframe' parameter of the @ref{1ec3,,start()} function to store more frames.

The @ref{ff,,tracemalloc} module must be tracing memory allocations to take a
snapshot, see the @ref{1ec3,,start()} function.

See also the @ref{1cd2,,get_object_traceback()} function.
@end deffn

@node DomainFilter,Filter,Funções<11>,API
@anchor{library/tracemalloc domainfilter}@anchor{4522}
@subsubsection DomainFilter


@geindex DomainFilter (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc DomainFilter}@anchor{d12}
@deffn {Classe} tracemalloc.DomainFilter (inclusive: bool, domain: int)

Filter traces of memory blocks by their address space (domain).


Adicionado na versão 3.6.


@geindex inclusive (atributo tracemalloc.DomainFilter)
@anchor{library/tracemalloc tracemalloc DomainFilter inclusive}@anchor{4523}
@deffn {Atributo} inclusive

If `inclusive' is @code{True} (include), match memory blocks allocated
in the address space @ref{4524,,domain}.

If `inclusive' is @code{False} (exclude), match memory blocks not allocated
in the address space @ref{4524,,domain}.
@end deffn

@geindex domain (atributo tracemalloc.DomainFilter)
@anchor{library/tracemalloc tracemalloc DomainFilter domain}@anchor{4524}
@deffn {Atributo} domain

Address space of a memory block (@code{int}). Read-only property.
@end deffn
@end deffn

@node Filter,Frame,DomainFilter,API
@anchor{library/tracemalloc filter}@anchor{4525}
@subsubsection Filter


@geindex Filter (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Filter}@anchor{4526}
@deffn {Classe} tracemalloc.Filter (inclusive: bool, filename_pattern: str, lineno: int = None, all_frames: bool = False, domain: int = None)

Filter on traces of memory blocks.

See the @ref{19df,,fnmatch.fnmatch()} function for the syntax of
`filename_pattern'. The @code{'.pyc'} file extension is
replaced with @code{'.py'}.

Exemplos:


@itemize *

@item 
@code{Filter(True, subprocess.__file__)} only includes traces of the
@ref{d6,,subprocess} module

@item 
@code{Filter(False, tracemalloc.__file__)} excludes traces of the
@ref{ff,,tracemalloc} module

@item 
@code{Filter(False, "<unknown>")} excludes empty tracebacks
@end itemize


Alterado na versão 3.5: The @code{'.pyo'} file extension is no longer replaced with @code{'.py'}.



Alterado na versão 3.6: Added the @ref{4527,,domain} attribute.


@geindex domain (atributo tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter domain}@anchor{4527}
@deffn {Atributo} domain

Address space of a memory block (@code{int} or @code{None}).

tracemalloc uses the domain @code{0} to trace memory allocations made by
Python. C extensions can use other domains to trace other resources.
@end deffn

@geindex inclusive (atributo tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter inclusive}@anchor{4528}
@deffn {Atributo} inclusive

If `inclusive' is @code{True} (include), only match memory blocks allocated
in a file with a name matching @ref{4529,,filename_pattern} at line number
@ref{452a,,lineno}.

If `inclusive' is @code{False} (exclude), ignore memory blocks allocated in
a file with a name matching @ref{4529,,filename_pattern} at line number
@ref{452a,,lineno}.
@end deffn

@geindex lineno (atributo tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter lineno}@anchor{452a}
@deffn {Atributo} lineno

Line number (@code{int}) of the filter. If `lineno' is @code{None}, the filter
matches any line number.
@end deffn

@geindex filename_pattern (atributo tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter filename_pattern}@anchor{4529}
@deffn {Atributo} filename_pattern

Filename pattern of the filter (@code{str}). Read-only property.
@end deffn

@geindex all_frames (atributo tracemalloc.Filter)
@anchor{library/tracemalloc tracemalloc Filter all_frames}@anchor{452b}
@deffn {Atributo} all_frames

If `all_frames' is @code{True}, all frames of the traceback are checked. If
`all_frames' is @code{False}, only the most recent frame is checked.

This attribute has no effect if the traceback limit is @code{1}.  See the
@ref{451b,,get_traceback_limit()} function and @ref{452c,,Snapshot.traceback_limit}
attribute.
@end deffn
@end deffn

@node Frame,Snapshot,Filter,API
@anchor{library/tracemalloc frame}@anchor{452d}
@subsubsection Frame


@geindex Frame (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Frame}@anchor{452e}
@deffn {Classe} tracemalloc.Frame

Frame de um Traceback

The @ref{bae,,Traceback} class is a sequence of @ref{452e,,Frame} instances.

@geindex filename (atributo tracemalloc.Frame)
@anchor{library/tracemalloc tracemalloc Frame filename}@anchor{452f}
@deffn {Atributo} filename

Filename (@code{str}).
@end deffn

@geindex lineno (atributo tracemalloc.Frame)
@anchor{library/tracemalloc tracemalloc Frame lineno}@anchor{4530}
@deffn {Atributo} lineno

Número da linha (@code{int}).
@end deffn
@end deffn

@node Snapshot,Statistic,Frame,API
@anchor{library/tracemalloc snapshot}@anchor{4531}
@subsubsection Snapshot


@geindex Snapshot (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Snapshot}@anchor{4521}
@deffn {Classe} tracemalloc.Snapshot

Snapshot of traces of memory blocks allocated by Python.

The @ref{451c,,take_snapshot()} function creates a snapshot instance.

@geindex compare_to() (método tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot compare_to}@anchor{4520}
@deffn {Método} compare_to (old_snapshot: Snapshot, key_type: str, cumulative: bool = False)

Compute the differences with an old snapshot. Get statistics as a sorted
list of @ref{4532,,StatisticDiff} instances grouped by `key_type'.

See the @ref{4510,,Snapshot.statistics()} method for `key_type' and `cumulative'
parameters.

The result is sorted from the biggest to the smallest by: absolute value
of @ref{4533,,StatisticDiff.size_diff}, @ref{4534,,StatisticDiff.size}, absolute
value of @ref{4535,,StatisticDiff.count_diff}, @ref{4536,,Statistic.count} and
then by @ref{4537,,StatisticDiff.traceback}.
@end deffn

@geindex dump() (método tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot dump}@anchor{4512}
@deffn {Método} dump (filename)

Write the snapshot into a file.

Use @ref{4513,,load()} to reload the snapshot.
@end deffn

@geindex filter_traces() (método tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot filter_traces}@anchor{4538}
@deffn {Método} filter_traces (filters)

Create a new @ref{4521,,Snapshot} instance with a filtered @ref{4539,,traces}
sequence, `filters' is a list of @ref{d12,,DomainFilter} and
@ref{4526,,Filter} instances.  If `filters' is an empty list, return a new
@ref{4521,,Snapshot} instance with a copy of the traces.

All inclusive filters are applied at once, a trace is ignored if no
inclusive filters match it. A trace is ignored if at least one exclusive
filter matches it.


Alterado na versão 3.6: @ref{d12,,DomainFilter} instances are now also accepted in `filters'.

@end deffn

@geindex load() (método de classe tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot load}@anchor{4513}
@deffn {Método} classmethod load (filename)

Load a snapshot from a file.

See also @ref{4512,,dump()}.
@end deffn

@geindex statistics() (método tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot statistics}@anchor{4510}
@deffn {Método} statistics (key_type: str, cumulative: bool = False)

Get statistics as a sorted list of @ref{453a,,Statistic} instances grouped
by `key_type':


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

key_type

@tab

description

@item

@code{'filename'}

@tab

filename

@item

@code{'lineno'}

@tab

filename and line number

@item

@code{'traceback'}

@tab

traceback

@end multitable


If `cumulative' is @code{True}, cumulate size and count of memory blocks of
all frames of the traceback of a trace, not only the most recent frame.
The cumulative mode can only be used with `key_type' equals to
@code{'filename'} and @code{'lineno'}.

The result is sorted from the biggest to the smallest by:
@ref{453b,,Statistic.size}, @ref{4536,,Statistic.count} and then by
@ref{453c,,Statistic.traceback}.
@end deffn

@geindex traceback_limit (atributo tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot traceback_limit}@anchor{452c}
@deffn {Atributo} traceback_limit

Maximum number of frames stored in the traceback of @ref{4539,,traces}:
result of the @ref{451b,,get_traceback_limit()} when the snapshot was taken.
@end deffn

@geindex traces (atributo tracemalloc.Snapshot)
@anchor{library/tracemalloc tracemalloc Snapshot traces}@anchor{4539}
@deffn {Atributo} traces

Traces of all memory blocks allocated by Python: sequence of
@ref{453d,,Trace} instances.

The sequence has an undefined order. Use the @ref{4510,,Snapshot.statistics()}
method to get a sorted list of statistics.
@end deffn
@end deffn

@node Statistic,StatisticDiff,Snapshot,API
@anchor{library/tracemalloc statistic}@anchor{453e}
@subsubsection Statistic


@geindex Statistic (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Statistic}@anchor{453a}
@deffn {Classe} tracemalloc.Statistic

Statistic on memory allocations.

@ref{4510,,Snapshot.statistics()} returns a list of @ref{453a,,Statistic} instances.

See also the @ref{4532,,StatisticDiff} class.

@geindex count (atributo tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic count}@anchor{4536}
@deffn {Atributo} count

Number of memory blocks (@code{int}).
@end deffn

@geindex size (atributo tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic size}@anchor{453b}
@deffn {Atributo} size

Total size of memory blocks in bytes (@code{int}).
@end deffn

@geindex traceback (atributo tracemalloc.Statistic)
@anchor{library/tracemalloc tracemalloc Statistic traceback}@anchor{453c}
@deffn {Atributo} traceback

Traceback where the memory block was allocated, @ref{bae,,Traceback}
instance.
@end deffn
@end deffn

@node StatisticDiff,Trace,Statistic,API
@anchor{library/tracemalloc statisticdiff}@anchor{453f}
@subsubsection StatisticDiff


@geindex StatisticDiff (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc StatisticDiff}@anchor{4532}
@deffn {Classe} tracemalloc.StatisticDiff

Statistic difference on memory allocations between an old and a new
@ref{4521,,Snapshot} instance.

@ref{4520,,Snapshot.compare_to()} returns a list of @ref{4532,,StatisticDiff}
instances. See also the @ref{453a,,Statistic} class.

@geindex count (atributo tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff count}@anchor{4540}
@deffn {Atributo} count

Number of memory blocks in the new snapshot (@code{int}): @code{0} if
the memory blocks have been released in the new snapshot.
@end deffn

@geindex count_diff (atributo tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff count_diff}@anchor{4535}
@deffn {Atributo} count_diff

Difference of number of memory blocks between the old and the new
snapshots (@code{int}): @code{0} if the memory blocks have been allocated in
the new snapshot.
@end deffn

@geindex size (atributo tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff size}@anchor{4534}
@deffn {Atributo} size

Total size of memory blocks in bytes in the new snapshot (@code{int}):
@code{0} if the memory blocks have been released in the new snapshot.
@end deffn

@geindex size_diff (atributo tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff size_diff}@anchor{4533}
@deffn {Atributo} size_diff

Difference of total size of memory blocks in bytes between the old and
the new snapshots (@code{int}): @code{0} if the memory blocks have been
allocated in the new snapshot.
@end deffn

@geindex traceback (atributo tracemalloc.StatisticDiff)
@anchor{library/tracemalloc tracemalloc StatisticDiff traceback}@anchor{4537}
@deffn {Atributo} traceback

Traceback where the memory blocks were allocated, @ref{bae,,Traceback}
instance.
@end deffn
@end deffn

@node Trace,Traceback,StatisticDiff,API
@anchor{library/tracemalloc trace}@anchor{4541}
@subsubsection Trace


@geindex Trace (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Trace}@anchor{453d}
@deffn {Classe} tracemalloc.Trace

Trace of a memory block.

The @ref{4539,,Snapshot.traces} attribute is a sequence of @ref{453d,,Trace}
instances.


Alterado na versão 3.6: Added the @ref{4542,,domain} attribute.


@geindex domain (atributo tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace domain}@anchor{4542}
@deffn {Atributo} domain

Address space of a memory block (@code{int}). Read-only property.

tracemalloc uses the domain @code{0} to trace memory allocations made by
Python. C extensions can use other domains to trace other resources.
@end deffn

@geindex size (atributo tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace size}@anchor{4543}
@deffn {Atributo} size

Size of the memory block in bytes (@code{int}).
@end deffn

@geindex traceback (atributo tracemalloc.Trace)
@anchor{library/tracemalloc tracemalloc Trace traceback}@anchor{4544}
@deffn {Atributo} traceback

Traceback where the memory block was allocated, @ref{bae,,Traceback}
instance.
@end deffn
@end deffn

@node Traceback,,Trace,API
@anchor{library/tracemalloc traceback}@anchor{4545}
@subsubsection Traceback


@geindex Traceback (classe em tracemalloc)
@anchor{library/tracemalloc tracemalloc Traceback}@anchor{bae}
@deffn {Classe} tracemalloc.Traceback

Sequence of @ref{452e,,Frame} instances sorted from the oldest frame to the
most recent frame.

A traceback contains at least @code{1} frame. If the @code{tracemalloc} module
failed to get a frame, the filename @code{"<unknown>"} at line number @code{0} is
used.

When a snapshot is taken, tracebacks of traces are limited to
@ref{451b,,get_traceback_limit()} frames. See the @ref{451c,,take_snapshot()} function.
The original number of frames of the traceback is stored in the
@ref{451f,,Traceback.total_nframe} attribute. That allows to know if a traceback
has been truncated by the traceback limit.

The @ref{4544,,Trace.traceback} attribute is an instance of @ref{bae,,Traceback}
instance.


Alterado na versão 3.7: Frames are now sorted from the oldest to the most recent, instead of most recent to oldest.


@geindex total_nframe (atributo tracemalloc.Traceback)
@anchor{library/tracemalloc tracemalloc Traceback total_nframe}@anchor{451f}
@deffn {Atributo} total_nframe

Total number of frames that composed the traceback before truncation.
This attribute can be set to @code{None} if the information is not
available.
@end deffn


Alterado na versão 3.9: The @ref{451f,,Traceback.total_nframe} attribute was added.


@geindex format() (método tracemalloc.Traceback)
@anchor{library/tracemalloc tracemalloc Traceback format}@anchor{baf}
@deffn {Método} format (limit=None, most_recent_first=False)

Format the traceback as a list of lines. Use the @ref{85,,linecache} module to
retrieve lines from the source code. If `limit' is set, format the `limit'
most recent frames if `limit' is positive. Otherwise, format the
@code{abs(limit)} oldest frames. If `most_recent_first' is @code{True}, the order
of the formatted frames is reversed, returning the most recent frame first
instead of last.

Similar to the @ref{4546,,traceback.format_tb()} function, except that
@ref{baf,,format()} does not include newlines.

Exemplo:

@example
print("Traceback (most recent call first):")
for line in traceback:
    print(line)
@end example

Saída:

@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 Empacotamento e Distribuição de Software,Serviços de Tempo de Execução Python,Depuração e perfilamento,A Biblioteca Padrão do Python
@anchor{library/distribution doc}@anchor{4547}@anchor{library/distribution software-packaging-and-distribution}@anchor{4548}@anchor{library/distribution translation-repo}@anchor{4549}
@section Empacotamento e Distribuição de Software


Essas bibliotecas ajudam você a publicar e instalar software do Python. Embora esses módulos sejam projetados para funcionar em conjunto com o Python Package Index@footnote{https://pypi.org}, eles também podem ser usados com um servidor de indexação local ou sem qualquer servidor de indexação.

@menu
* ensurepip — Inicialização do instalador do pip:: 
* venv — Criação de ambientes virtuais:: 
* zipapp — Gerencia arquivos zip executáveis do Python:: 

@end menu

@node ensurepip — Inicialização do instalador do pip,venv — Criação de ambientes virtuais,,Empacotamento e Distribuição de Software
@anchor{library/ensurepip doc}@anchor{454a}@anchor{library/ensurepip ensurepip-bootstrapping-the-pip-installer}@anchor{454b}@anchor{library/ensurepip module-ensurepip}@anchor{55}
@subsection @code{ensurepip} — Inicialização do instalador do @code{pip}


@geindex module; ensurepip


Adicionado na versão 3.4.


`Código-fonte:' Lib/ensurepip@footnote{https://github.com/python/cpython/tree/3.13/Lib/ensurepip}


__________________________________________________________________


O pacote @ref{55,,ensurepip} fornece suporte a fazer bootstrapping, ou seja, inicializar o instalador do @code{pip} em uma instalação existente do Python ou em um ambiente virtual. Essa abordagem de bootstrapping reflete o fato de que @code{pip} é um projeto independente com seu próprio ciclo de lançamento, e a última versão estável disponível é fornecida com manutenção e lançamentos de recursos do interpretador de referência CPython.

Na maioria dos casos, os usuários finais do Python não precisam invocar esse módulo diretamente (como @code{pip} deve ser inicializado por padrão), mas pode ser necessário se a instalação do @code{pip} foi ignorada ao instalar o Python (ou ao criar um ambiente virtual) ou após desinstalar explicitamente @code{pip}.

@cartouche
@quotation Nota 
Este módulo `não' acessa a Internet. Todos os componentes necessários para iniciar o @code{pip} estão incluídos como partes internas do pacote.
@end quotation
@end cartouche


@subsubheading Ver também



@table @asis

@item @ref{f27,,Instalando módulos Python}

O guia do usuário final para instalar pacotes Python

@geindex Propostas de Melhorias do Python; PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/}: Inicialização explícita de pip em instalações Python

A justificativa e especificação originais para este módulo.
@end table


@c include for modules that don't work on WASM or mobile platforms

@ref{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@menu
* Interface de linha de comando: Interface de linha de comando<11>. 
* API do módulo:: 

@end menu

@node Interface de linha de comando<11>,API do módulo,,ensurepip — Inicialização do instalador do pip
@anchor{library/ensurepip command-line-interface}@anchor{454c}@anchor{library/ensurepip ensurepip-cli}@anchor{454d}
@subsubsection Interface de linha de comando


A interface da linha de comando é chamada usando a opção @code{-m} do interpretador.

A invocação mais simples possível é:

@example
python -m ensurepip
@end example

Essa invocação instalará @code{pip} se ainda não estiver instalada, mas, caso contrário, não fará nada. Para garantir que a versão instalada do @code{pip} seja pelo menos tão recente quanto a disponível do @code{ensurepip}, passe a opção @code{--upgrade}:

@example
python -m ensurepip --upgrade
@end example

Por padrão, @code{pip} é instalado no ambiente virtual atual (se houver um ativo) ou nos pacotes de sites do sistema (se não houver um ambiente virtual ativo). O local da instalação pode ser controlado através de duas opções adicionais de linha de comando:

@geindex ensurepip opção de linha de comando; --root
@anchor{library/ensurepip cmdoption-ensurepip-root}@anchor{454e}
@deffn {Option} @w{-}@w{-}root <dir>

Instala @code{pip} em relação ao diretório raiz fornecido, em vez da raiz do ambiente virtual atualmente ativo (se houver) ou a raiz padrão da instalação atual do Python.
@end deffn

@geindex ensurepip opção de linha de comando; --user
@anchor{library/ensurepip cmdoption-ensurepip-user}@anchor{454f}
@deffn {Option} @w{-}@w{-}user

Instala @code{pip} no diretório de pacotes do site do usuário em vez de globalmente para a instalação atual do Python (essa opção não é permitida dentro de um ambiente virtual ativo).
@end deffn

Por padrão, os scripts @code{pipX} e @code{pipX.Y} serão instalados (onde X.Y representa a versão do Python usada para invocar @code{ensurepip}). Os scripts instalados podem ser controlados através de duas opções adicionais de linha de comando:

@geindex ensurepip opção de linha de comando; --altinstall
@anchor{library/ensurepip cmdoption-ensurepip-altinstall}@anchor{4550}
@deffn {Option} @w{-}@w{-}altinstall

Se uma instalação alternativa for solicitada, o script @code{pipX} `não' será instalado.
@end deffn

@geindex ensurepip opção de linha de comando; --default-pip
@anchor{library/ensurepip cmdoption-ensurepip-default-pip}@anchor{4551}
@deffn {Option} @w{-}@w{-}default@w{-}pip

Se uma instalação “pip padrão” for solicitada, o script @code{pip} será instalado junto com os dois scripts comuns.
@end deffn

Fornecer as duas opções de seleção de script acionará uma exceção.

@node API do módulo,,Interface de linha de comando<11>,ensurepip — Inicialização do instalador do pip
@anchor{library/ensurepip module-api}@anchor{4552}
@subsubsection API do módulo


O @ref{55,,ensurepip} expõe duas funções para uso programático:

@geindex version() (no módulo ensurepip)
@anchor{library/ensurepip ensurepip version}@anchor{4553}
@deffn {Função} ensurepip.version ()

Retorna uma string que especifica a versão disponível do pip que será instalado ao inicializar um ambiente.
@end deffn

@geindex bootstrap() (no módulo ensurepip)
@anchor{library/ensurepip ensurepip bootstrap}@anchor{4405}
@deffn {Função} ensurepip.bootstrap (root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)

Inicializa @code{pip} no ambiente atual ou designado.

`root' especifica um diretório raiz alternativo para instalar em relação a. Se `root' for @code{None}, a instalação utilizará o local de instalação padrão para o ambiente atual.

`upgrade' indica se deve ou não atualizar uma instalação existente de uma versão anterior do @code{pip} para a versão disponível.

`user' indica se é necessário usar o esquema do usuário em vez de instalar globalmente.

Por padrão, os scripts @code{pipX} e @code{pipX.Y} serão instalados (onde X.Y significa a versão atual do Python).

Se `altinstall' estiver definido, o @code{pipX} `não' será instalado.

Se `default_pip' estiver definido, o @code{pip} será instalado além dos dois scripts comuns.

Definir `altinstall' e `default_pip' acionará @ref{202,,ValueError}.

`verbosity' controla o nível de saída para @ref{ae6,,sys.stdout} da operação de inicialização.

Levanta um @ref{19fa,,evento de auditoria} @code{ensurepip.bootstrap} com o argumento @code{root}.

@cartouche
@quotation Nota 
O processo de inicialização tem efeitos colaterais em @code{sys.path} e @code{os.environ}. Invocar a interface da linha de comando em um subprocesso permite que esses efeitos colaterais sejam evitados.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
O processo de inicialização pode instalar módulos adicionais exigidos pelo @code{pip}, mas outro software não deve presumir que essas dependências sempre estarão presentes por padrão (como as dependências podem ser removidas em uma versão futura do @code{pip}).
@end quotation
@end cartouche
@end deffn

@node venv — Criação de ambientes virtuais,zipapp — Gerencia arquivos zip executáveis do Python,ensurepip — Inicialização do instalador do pip,Empacotamento e Distribuição de Software
@anchor{library/venv doc}@anchor{4554}@anchor{library/venv module-venv}@anchor{111}@anchor{library/venv translation-repo}@anchor{4555}@anchor{library/venv venv-creation-of-virtual-environments}@anchor{4556}
@subsection @code{venv} — Criação de ambientes virtuais


@geindex module; venv


Adicionado na versão 3.3.


`Código-fonte:' Lib/venv/@footnote{https://github.com/python/cpython/tree/3.13/Lib/venv/}

@geindex Ambientes;virtual


__________________________________________________________________

@anchor{library/venv venv-def}@anchor{4557}@anchor{library/venv venv-intro}@anchor{4558}
O módulo @code{venv} oferece suporte à criação de “ambientes virtuais” leves, cada um com seu próprio conjunto independente de pacotes Python instalados em seus diretórios @ref{c7,,site}. Um ambiente virtual é criado sobre uma instalação existente do Python, conhecido como o Python “base” do ambiente virtual, e por padrão está isolado dos pacotes no ambiente base, de modo que apenas aqueles explicitamente instalados no ambiente virtual estejam disponíveis.

Quando usadas em um ambiente virtual, ferramentas de instalação comuns, como pip@footnote{https://pypi.org/project/pip/}, instalarão pacotes Python em um ambiente virtual sem precisar ser instruído a fazê-lo explicitamente.

Um ambiente virtual é (dentre outras coisas):


@itemize *

@item 
Usado para conter um interpretador Python específico e bibliotecas de software e binários necessários para dar suporte a um projeto (biblioteca ou aplicação). Eles são, por padrão, isolados de software em outros ambientes virtuais e de interpretadores e bibliotecas Python instalados no sistema operacional.

@item 
Contido em um diretório, convencionalmente denominado @code{.venv} ou @code{venv} no diretório do projeto, ou em um diretório contêiner para vários ambientes virtuais, como @code{~/.virtualenvs}.

@item 
Não inserido em sistemas de controle de código-fonte, como Git.

@item 
Considerado descartável – deve ser simples excluí-lo e recriá-lo do zero. Você não coloca nenhum código de projeto no ambiente.

@item 
Não é considerado móvel ou copiável – basta recriar o mesmo ambiente no local de destino.
@end itemize

Veja 
@geindex Propostas de Melhorias do Python; PEP 405
PEP 405@footnote{https://peps.python.org/pep-0405/} para mais informações sobre ambientes virtuais do Python.


@subsubheading Ver também


Python Packaging User Guide: Criar e usar ambientes virtuais@footnote{https://packaging.python.org/pt-br/latest/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{1ed8,,Disponibilidade}: not Android, not iOS, not WASI.

Este módulo não tem suporte em @ref{1fde,,plataformas móveis} ou @ref{18f5,,plataformas WebAssembly}.

@menu
* Criando ambientes virtuais: Criando ambientes virtuais<2>. 
* Como funcionam os venvs:: 
* API: API<2>. 
* Um exemplo de extensão de EnvBuilder:: 

@end menu

@node Criando ambientes virtuais<2>,Como funcionam os venvs,,venv — Criação de ambientes virtuais
@anchor{library/venv creating-virtual-environments}@anchor{4559}
@subsubsection Criando ambientes virtuais


As @ref{4557,,ambiente virtuais} são criadas executando o módulo @code{venv}:

@example
python -m venv /caminho/para/novo/ambiente/virtual
@end example

Isso cria o diretório de destino (incluindo diretórios pais conforme necessário) e coloca um arquivo @code{pyvenv.cfg} nele com uma chave @code{home} apontando para a instalação do Python da qual o comando foi executado. Ele também cria um subdiretório @code{bin} (ou @code{Scripts} no Windows) contendo uma cópia ou link simbólico do executável Python (conforme apropriado para a plataforma ou argumentos usados no momento da criação do ambiente). Ele também cria um subdiretório @code{lib/pythonX.Y/site-packages} (no Windows, este é @code{Lib\site-packages}). Se um diretório existente for especificado, ele será reutilizado.


Alterado na versão 3.5: O uso de @code{venv} agora é recomendado para a criação de ambientes virtuais.



Descontinuado desde a versão 3.6, removido na versão 3.8: @code{pyvenv} era a ferramenta recomendada para criar ambientes virtuais para Python 3.3 e 3.4, e foi substituída na versão 3.5 pela execução direta de @code{venv}.


No Windows, invoque o comando @code{venv} da seguinte forma:

@example
PS> python -m venv C:\caminho\para\novo\ambiente\virtual
@end example

O comando, se executado com @code{-h}, mostrará as opções disponíveis:

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

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

@geindex venv opção de linha de comando; ENV_DIR
@anchor{library/venv venv-cli}@anchor{455a}@anchor{library/venv cmdoption-venv-arg-ENV_DIR}@anchor{455b}
@deffn {Option} ENV_DIR

Um argumento obrigatório que especifica o diretório para criar o ambiente.
@end deffn

@geindex venv opção de linha de comando; --system-site-packages
@anchor{library/venv cmdoption-venv-system-site-packages}@anchor{455c}
@deffn {Option} @w{-}@w{-}system@w{-}site@w{-}packages

Fornece ao ambiente virtual acesso ao diretório site-packages do sistema.
@end deffn

@geindex venv opção de linha de comando; --symlinks
@anchor{library/venv cmdoption-venv-symlinks}@anchor{455d}
@deffn {Option} @w{-}@w{-}symlinks

Tenta usar links simbólicos em vez de cópias, quando links simbólicos não forem o padrão para a plataforma.
@end deffn

@geindex venv opção de linha de comando; --copies
@anchor{library/venv cmdoption-venv-copies}@anchor{455e}
@deffn {Option} @w{-}@w{-}copies

Tenta usar cópias em vez de links simbólicos, mesmo quando os links simbólicos forem o padrão para a plataforma.
@end deffn

@geindex venv opção de linha de comando; --clear
@anchor{library/venv cmdoption-venv-clear}@anchor{455f}
@deffn {Option} @w{-}@w{-}clear

Exclui o conteúdo do diretório do ambiente, se ele já existir, antes da criação do ambiente.
@end deffn

@geindex venv opção de linha de comando; --upgrade
@anchor{library/venv cmdoption-venv-upgrade}@anchor{4560}
@deffn {Option} @w{-}@w{-}upgrade

Atualiza o diretório do ambiente para usar esta versão do Python, supondo que o Python tenha sido atualizado no local.
@end deffn

@geindex venv opção de linha de comando; --without-pip
@anchor{library/venv cmdoption-venv-without-pip}@anchor{4561}
@deffn {Option} @w{-}@w{-}without@w{-}pip

Ignora a instalação ou atualização do pip no ambiente virtual (o pip é inicializado por padrão).
@end deffn

@geindex venv opção de linha de comando; --prompt
@anchor{library/venv cmdoption-venv-prompt}@anchor{4562}
@deffn {Option} @w{-}@w{-}prompt <PROMPT>

Fornece um prefixo de prompt alternativo para este ambiente.
@end deffn

@geindex venv opção de linha de comando; --upgrade-deps
@anchor{library/venv cmdoption-venv-upgrade-deps}@anchor{4563}
@deffn {Option} @w{-}@w{-}upgrade@w{-}deps

Atualiza as dependências principais (pip) para a versão mais recente no PyPI.
@end deffn

@geindex venv opção de linha de comando; --without-scm-ignore-files
@anchor{library/venv cmdoption-venv-without-scm-ignore-files}@anchor{4564}
@deffn {Option} @w{-}@w{-}without@w{-}scm@w{-}ignore@w{-}files

Ignora a adição de arquivos para ignorar do SCM ao diretório do ambiente (o Git é suportado por padrão).
@end deffn


Alterado na versão 3.4: Instala o pip por padrão, adicionadas as opções @code{--without-pip} e @code{--copies}.



Alterado na versão 3.4: Nas versões anteriores, se o diretório de destino já existia, era levantado um erro, a menos que a opção @code{--clear} ou @code{--upgrade} fosse fornecida.



Alterado na versão 3.9: Adiciona a opção @code{--upgrade-deps} para atualizar pip + setuptools para a última no PyPI.



Alterado na versão 3.12: @code{setuptools} não é mais uma dependência central do venv.



Alterado na versão 3.13: Adicionada a opção @code{--without-scm-ignore-files}.



Alterado na versão 3.13: @code{venv} agora cria um arquivo @code{.gitignore} para Git por padrão.


@cartouche
@quotation Nota 
Embora haja suporte a links simbólicos no Windows, eles não são recomendados. É importante notar que clicar duas vezes em @code{python.exe} no Explorador de Arquivos resolverá o link simbólico com entusiasmo e ignorará o ambiente virtual.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
No Microsoft Windows, pode ser necessário ativar o script @code{Activate.ps1}, definindo a política de execução para o usuário. Você pode fazer isso executando o seguinte comando do PowerShell:

@example
PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
@end example

Consulte About Execution Policies@footnote{https://go.microsoft.com/fwlink/?LinkID=135170} para mais informações.
@end quotation
@end cartouche

O arquivo @code{pyvenv.cfg} criado também inclui a chave @code{include-system-site-packages}, definida como @code{true} se @code{venv} for executado com a opção @code{--system-site-packages}; caso contrário, @code{false}.

A menos que a opção @code{--without-pip} seja dada, @ref{55,,ensurepip} será chamado para inicializar o @code{pip} no ambiente virtual.

Vários caminhos podem ser dados para @code{venv}, caso em que um ambiente virtual idêntico será criado, de acordo com as opções fornecidas, em cada caminho fornecido.

@node Como funcionam os venvs,API<2>,Criando ambientes virtuais<2>,venv — Criação de ambientes virtuais
@anchor{library/venv how-venvs-work}@anchor{4565}@anchor{library/venv venv-explanation}@anchor{44d}
@subsubsection Como funcionam os venvs


Quando um interpretador Python está sendo executado a partir de um ambiente virtual, @ref{3b6,,sys.prefix} e @ref{3b2,,sys.exec_prefix} apontam para os diretórios do ambiente virtual, enquanto @ref{3ef,,sys.base_prefix} e @ref{3ee,,sys.base_exec_prefix} apontam para aqueles do Python base usado para criar o ambiente. É suficiente verificar @code{sys.prefix != sys.base_prefix} para determinar se o interpretador atual está sendo executado a partir de um ambiente virtual.

Um ambiente virtual pode ser “ativado” usando um script em seu diretório binário (@code{bin} no POSIX; @code{Scripts} no Windows). Isso precederá esse diretório ao seu 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}, de modo que a execução de @code{python} invoque o interpretador Python do ambiente e você possa executar os scripts instalados sem precisar usar o caminho completo. A invocação do script de ativação é específica da plataforma (@code{@var{<venv>}} deve ser substituído pelo caminho para o diretório que contém o ambiente virtual):


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Plataforma

@tab

Shell

@tab

Comando para ativar o ambiente 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



Adicionado na versão 3.4: Os scripts de ativação @code{fish} e @code{csh}.



Adicionado na versão 3.8: Scripts de ativação de PowerShell instalados sob POSIX para suporte a PowerShell Core.


Você não `precisa' especificamente ativar um ambiente virtual, pois pode apenas especificar o caminho completo para o interpretador Python desse ambiente ao invocar o Python. Além disso, todos os scripts instalados no ambiente devem ser executáveis sem ativá-lo.

Para isso, os scripts instalados em ambientes virtuais possuem uma linha “shebang” que aponta para o interpretador Python do ambiente @code{#!/@var{<caminho-para-venv>}/bin/python}. Isso significa que o script será executado com esse interpretador independentemente do valor de 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}. No Windows, o processamento de linha “shebang” é suportado se você tiver o @ref{5be,,Inicializador Python para Windows} instalado. Assim, clicar duas vezes em um script instalado em uma janela do Windows Explorer deve executá-lo com o interpretador correto sem que o ambiente precise ser ativado ou no 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.

Quando um ambiente virtual é ativado, a variável de ambiente @code{VIRTUAL_ENV} é definida como o caminho do ambiente. Como não é necessário ativar explicitamente um ambiente virtual para usá-lo, @code{VIRTUAL_ENV} não pode ser usado para determinar se um ambiente virtual está sendo usado.

@cartouche
@quotation Aviso 
Como os scripts instalados em ambientes não devem esperar que o ambiente seja ativado, suas linhas shebang contêm os caminhos absolutos para os interpretadores de seus ambientes. Por causa disso, os ambientes são inerentemente não portáteis, no caso geral. Você sempre deve ter um meio simples de recriar um ambiente (por exemplo, se você tiver um arquivo de requisitos @code{requirements.txt}, você pode invocar @code{pip install -r requirements.txt} usando o @code{pip} do ambiente  para instalar todos os pacotes necessários para o ambiente). Se por algum motivo você precisar mover o ambiente para um novo local, deverá recriá-lo no local desejado e excluir o do local antigo. Se você mover um ambiente porque moveu um diretório pai dele, deverá recriar o ambiente em seu novo local. Caso contrário, o software instalado no ambiente pode não funcionar conforme o esperado.
@end quotation
@end cartouche

Você pode desativar um ambiente virtual digitando @code{deactivate} em seu shell. O mecanismo exato é específico da plataforma e é um detalhe de implementação interna (normalmente, um script ou função de shell será usado).

@node API<2>,Um exemplo de extensão de EnvBuilder,Como funcionam os venvs,venv — Criação de ambientes virtuais
@anchor{library/venv api}@anchor{4566}@anchor{library/venv venv-api}@anchor{f24}
@subsubsection API


O método de alto nível descrito acima utiliza uma API simples que fornece mecanismos para que criadores de ambientes virtuais de terceiros personalizem a criação do ambiente de acordo com suas necessidades, a classe @ref{26a,,EnvBuilder}.

@geindex EnvBuilder (classe em venv)
@anchor{library/venv venv EnvBuilder}@anchor{26a}
@deffn {Classe} venv.EnvBuilder (system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

A classe @ref{26a,,EnvBuilder} aceita os seguintes argumentos nomeados na instanciação:


@itemize *

@item 
`system_site_packages' – um valor booleano indicando que os pacotes de sites do sistema Python devem estar disponíveis para o ambiente (o padrão é @code{False}).

@item 
`clear' – um valor booleano que, se verdadeiro, excluirá o conteúdo de qualquer diretório de destino existente, antes de criar o ambiente.

@item 
`symlinks' – um valor booleano que indica se você deseja vincular o binário Python ao invés de copiar.

@item 
`upgrade' – um valor booleano que, se verdadeiro, atualizará um ambiente existente com o Python em execução - para uso quando o Python tiver sido atualizado localmente (o padrão é @code{False}).

@item 
`with_pip' – um valor booleano que, se verdadeiro, garante que o pip seja instalado no ambiente virtual. Isso usa @ref{55,,ensurepip} com a opção @code{--default-pip}.

@item 
`prompt' – uma string a ser usada após o ambiente virtual ser ativado (o padrão é @code{None}, o que significa que o nome do diretório do ambiente seria usado). Se a string especial @code{"."} for fornecida, o nome da base do diretório atual será usado como prompt.

@item 
`upgrade_deps' – Atualiza os módulos base do venv para os mais recentes no PyPI

@item 
`scm_ignore_files' – Cria arquivos com lista de ignorados com base nos gerenciadores de controle de fonte (SCM) especificados no iterável. O suporte é definido por ter um método chamado @code{create_@{scm@}_ignore_file}. O único valor suportado por padrão é @code{"git"} via @ref{4567,,create_git_ignore_file()}.
@end itemize


Alterado na versão 3.4: Adicionado o parâmetro @code{with_pip}



Alterado na versão 3.6: Adicionado o parâmetro @code{prompt}



Alterado na versão 3.9: Adicionado o parâmetro @code{upgrade_deps}



Alterado na versão 3.13: Adicionado o parâmetro @code{scm_ignore_files}


@ref{26a,,EnvBuilder} pode ser usado como uma classe base.

@geindex create() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create}@anchor{4568}
@deffn {Método} create (env_dir)

Cria um ambiente virtual especificando o diretório de destino (absoluto ou relativo ao diretório atual) que deve conter o ambiente virtual. O método @code{create} cria o ambiente no diretório especificado ou levanta uma exceção apropriada.

O método @code{create} da classe @ref{26a,,EnvBuilder} ilustra os ganchos disponíveis para personalização de subclasse:

@example
def create(self, env_dir):
    """
    Cria um ambiente Python virtualizado em um diretório.
    env_dir é o diretório de destino para criar um ambiente.
    """
    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 um dos métodos @ref{4569,,ensure_directories()}, @ref{456a,,create_configuration()}, @ref{456b,,setup_python()}, @ref{456c,,setup_scripts()} e @ref{456d,,post_setup()} pode ser substituído.
@end deffn

@geindex ensure_directories() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder ensure_directories}@anchor{4569}
@deffn {Método} ensure_directories (env_dir)

Cria o diretório do ambiente e todos os subdiretórios necessários que ainda não existem e retorna um objeto de contexto. Este objeto de contexto é apenas um detentor de atributos (como caminhos) para uso pelos outros métodos. Se o @ref{26a,,EnvBuilder} for criado com o argumento @code{clear=True}, o conteúdo do diretório do ambiente será limpo e todos os subdiretórios necessários serão recriados.

O objeto de contexto retornado é um @ref{1d1,,types.SimpleNamespace} com os seguintes atributos:


@itemize *

@item 
@code{env_dir} - A localização do ambiente virtual. Usado para @code{__VENV_DIR__} em scripts de ativação (veja @ref{456e,,install_scripts()}).

@item 
@code{env_name} - O nome do ambiente virtual. Usado para @code{__VENV_NAME__} em scripts de ativação (veja @ref{456e,,install_scripts()}).

@item 
@code{prompt} - O prompt a ser usado pelos scripts de ativação. Usado para @code{__VENV_PROMPT__} em scripts de ativação (veja @ref{456e,,install_scripts()}).

@item 
@code{executable} - O executável Python subjacente usado pelo ambiente virtual. Isso leva em consideração o caso em que um ambiente virtual é criado a partir de outro ambiente virtual.

@item 
@code{inc_path} - O caminho de inclusão para o ambiente virtual.

@item 
@code{lib_path} - O caminho purelib para o ambiente virtual.

@item 
@code{bin_path} - O caminho do script para o ambiente virtual.

@item 
@code{bin_name} - O nome do caminho do script relativo ao local do ambiente virtual. Usado para @code{__VENV_BIN_NAME__} em scripts de ativação (consulte @ref{456e,,install_scripts()}).

@item 
@code{env_exe} - O nome do interpretador Python no ambiente virtual. Usado para @code{__VENV_PYTHON__} em scripts de ativação (veja @ref{456e,,install_scripts()}).

@item 
@code{env_exec_cmd} - O nome do interpretador Python, levando em consideração os redirecionamentos do sistema de arquivos. Isso pode ser usado para executar o Python no ambiente virtual.
@end itemize


Alterado na versão 3.11: O @ref{68f,,esquema de instalação de sysconfig} do `venv' é usado para construir os caminhos dos diretórios criados.



Alterado na versão 3.12: O atributo @code{lib_path} foi adicionado ao contexto, e o objeto de contexto foi documentado.

@end deffn

@geindex create_configuration() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create_configuration}@anchor{456a}
@deffn {Método} create_configuration (context)

Cria o arquivo de configuração @code{pyvenv.cfg} no ambiente.
@end deffn

@geindex setup_python() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder setup_python}@anchor{456b}
@deffn {Método} setup_python (context)

Cria uma cópia ou link simbólico para o executável Python no ambiente. Nos sistemas POSIX, se um executável específico @code{python3.x} foi usado, links simbólicos para @code{python} e @code{python3} serão criados apontando para esse executável, a menos que já existam arquivos com esses nomes.
@end deffn

@geindex setup_scripts() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder setup_scripts}@anchor{456c}
@deffn {Método} setup_scripts (context)

Instala scripts de ativação apropriados para a plataforma no ambiente virtual.
@end deffn

@geindex upgrade_dependencies() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder upgrade_dependencies}@anchor{456f}
@deffn {Método} upgrade_dependencies (context)

Atualiza os principais pacotes de dependência do venv (atualmente pip@footnote{https://pypi.org/project/pip/}) no ambiente. Isso é feito através da distribuição do executável @code{pip} no ambiente.


Adicionado na versão 3.9.



Alterado na versão 3.12: setuptools@footnote{https://pypi.org/project/setuptools/} não é mais uma dependência central do venv.

@end deffn

@geindex post_setup() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder post_setup}@anchor{456d}
@deffn {Método} post_setup (context)

Um método de espaço reservado que pode ser substituído em implementações de terceiros para pré-instalar pacotes no ambiente virtual ou executar outras etapas pós-criação.
@end deffn

@geindex install_scripts() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder install_scripts}@anchor{456e}
@deffn {Método} install_scripts (context, path)

Este método utilitário que pode ser chamado de @ref{456c,,setup_scripts()} ou @ref{456d,,post_setup()} nas subclasses para ajudar na instalação de scripts personalizados no ambiente virtual.

`path' é o caminho para um diretório que deve conter subdiretórios @code{common}, @code{posix}, @code{nt}; cada um contendo scripts destinados ao diretório @code{bin} no ambiente. O conteúdo de @code{common} e o diretório correspondente a @ref{2ce3,,os.name} são copiados após alguma substituição de texto dos espaços reservados:


@itemize *

@item 
@code{__VENV_DIR__} é substituído pelo caminho absoluto do diretório do ambiente.

@item 
@code{__VENV_NAME__} é substituído pelo nome do ambiente (segmento do caminho final do diretório do ambiente).

@item 
@code{__VENV_PROMPT__} é substituído pelo prompt (o nome do ambiente entre parênteses e com o seguinte espaço)

@item 
@code{__VENV_BIN_NAME__} é substituído pelo nome do diretório bin (@code{bin} ou @code{Scripts}).

@item 
@code{__VENV_PYTHON__} é substituído pelo caminho absoluto do executável do ambiente.
@end itemize

É permitido que os diretórios existam (para quando um ambiente existente estiver sendo atualizado).
@end deffn

@geindex create_git_ignore_file() (método venv.EnvBuilder)
@anchor{library/venv venv EnvBuilder create_git_ignore_file}@anchor{4567}
@deffn {Método} create_git_ignore_file (context)

Cria um arquivo @code{.gitignore} dentro do ambiente virtual que faz com que todo o diretório seja ignorado pelo gerenciador de controle de fonte Git.


Adicionado na versão 3.13.

@end deffn


Alterado na versão 3.7.2: O Windows agora usa scripts redirecionadores para @code{python[w].exe} em vez de copiar os binários reais. No 3.7.2, somente @ref{456b,,setup_python()} não faz nada a menos que seja executado a partir de uma construção na árvore de origem.



Alterado na versão 3.7.3: O Windows copia os scripts redirecionadores como parte do @ref{456b,,setup_python()} em vez de @ref{456c,,setup_scripts()}. Este não foi o caso em 3.7.2. Ao usar links simbólicos, será feito link para os executáveis originais.

@end deffn

Há também uma função de conveniência no nível do módulo:

@geindex create() (no módulo venv)
@anchor{library/venv venv create}@anchor{26b}
@deffn {Função} venv.create (env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

Cria um @ref{26a,,EnvBuilder} com os argumentos nomeados fornecidos e chame seu método @ref{4568,,create()} com o argumento `env_dir'.


Adicionado na versão 3.3.



Alterado na versão 3.4: Adicionado o parâmetro `with_pip'



Alterado na versão 3.6: Adicionado o parâmetro `prompt'



Alterado na versão 3.9: Adicionado o parâmetro `upgrade_deps'



Alterado na versão 3.13: Adicionado o parâmetro `scm_ignore_files'

@end deffn

@node Um exemplo de extensão de EnvBuilder,,API<2>,venv — Criação de ambientes virtuais
@anchor{library/venv an-example-of-extending-envbuilder}@anchor{4570}
@subsubsection Um exemplo de extensão de @code{EnvBuilder}


O script a seguir mostra como estender @ref{26a,,EnvBuilder} implementando uma subclasse que instala setuptools e pip em um ambiente virtual criado:

@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

Esse script também está disponível para download online@footnote{https://gist.github.com/vsajip/4673395}.

@node zipapp — Gerencia arquivos zip executáveis do Python,,venv — Criação de ambientes virtuais,Empacotamento e Distribuição de Software
@anchor{library/zipapp doc}@anchor{4571}@anchor{library/zipapp module-zipapp}@anchor{130}@anchor{library/zipapp translation-repo}@anchor{4572}@anchor{library/zipapp zipapp-manage-executable-python-zip-archives}@anchor{4573}
@subsection @code{zipapp} — Gerencia arquivos zip executáveis do Python


@geindex module; zipapp


Adicionado na versão 3.5.


`Código-fonte:' Lib/zipapp.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/zipapp.py}

@geindex Arquivos zip executáveis


__________________________________________________________________


Este módulo fornece ferramentas para gerenciar a criação de arquivos zip contendo código Python, que pode ser @ref{1eb3,,executado diretamente pelo interpretador Python}. O módulo fornece uma @ref{4574,,Interface de linha de comando} e uma @ref{4575,,API do Python}.

@menu
* Exemplo básico:: 
* Interface de linha de comando: Interface de linha de comando<12>. 
* API do Python:: 
* Exemplos: Exemplos<32>. 
* Especificando o interpretador:: 
* Criando aplicações autônomas com zipapp:: 
* O formato de arquivo da aplicação zip Python:: 

@end menu

@node Exemplo básico,Interface de linha de comando<12>,,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp basic-example}@anchor{4576}
@subsubsection Exemplo básico


O exemplo a seguir mostra como a @ref{4574,,Interface de linha de comando} pode ser usada para criar um arquivo executável a partir de um diretório contendo código Python. Quando executado, o arquivo executará a função @code{main} do módulo @code{myapp} no arquivo.

@example
$ python -m zipapp myapp -m "myapp:main"
$ python myapp.pyz
<output from myapp>
@end example

@node Interface de linha de comando<12>,API do Python,Exemplo básico,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp command-line-interface}@anchor{4577}@anchor{library/zipapp zipapp-command-line-interface}@anchor{4574}
@subsubsection Interface de linha de comando


Quando chamado como um programa a partir da linha de comando, as seguintes opções estão disponíveis:

@example
$ python -m zipapp source [options]
@end example

Se `source' for um diretório, isso criará um arquivo a partir do conteúdo de `source'. Se `source' for um arquivo, ele deve ser um arquivo, e será copiado para o arquivo de destino (ou o conteúdo de sua linha shebang será exibido se a opção –info for especificada).

As seguintes opções são compreendidas:

@geindex zipapp opção de linha de comando; -o
@geindex zipapp opção de linha de comando; --output
@anchor{library/zipapp cmdoption-zipapp-o}@anchor{4578}@anchor{library/zipapp cmdoption-zipapp-output}@anchor{4579}
@deffn {Option} @w{-}o <output>, @w{-}@w{-}output=<output>

Escreve a saída em um arquivo chamado `output'. Se essa opção não for especificada, o nome do arquivo de saída será o mesmo que o `source' de entrada, com a extensão @code{.pyz} adicionada. Se um nome de arquivo explícito for fornecido, ele será usado como está (então uma extensão @code{.pyz} deve ser incluída se necessário).

Um nome de arquivo de saída deve ser especificado se `source' for um arquivo (e nesse caso, `output' não deve ser o mesmo que `source').
@end deffn

@geindex zipapp opção de linha de comando; -p
@geindex zipapp opção de linha de comando; --python
@anchor{library/zipapp cmdoption-zipapp-p}@anchor{457a}@anchor{library/zipapp cmdoption-zipapp-python}@anchor{457b}
@deffn {Option} @w{-}p <interpreter>, @w{-}@w{-}python=<interpreter>

Adiciona uma linha @code{#!} ao arquivo especificando `interpreter' como o comando a ser executado. Além disso, no POSIX, torne o arquivo executável. O padrão é não escrever nenhuma linha @code{#!} e não tornar o arquivo executável.
@end deffn

@geindex zipapp opção de linha de comando; -m
@geindex zipapp opção de linha de comando; --main
@anchor{library/zipapp cmdoption-zipapp-m}@anchor{457c}@anchor{library/zipapp cmdoption-zipapp-main}@anchor{457d}
@deffn {Option} @w{-}m <mainfn>, @w{-}@w{-}main=<mainfn>

Escreve um arquivo @code{__main__.py} no arquivo que executa `mainfn'. O argumento `mainfn' deve ter o formato “pkg.mod:fn”, onde “pkg.mod” é um pacote/módulo no arquivo, e “fn” é um chamável no módulo fornecido. O arquivo @code{__main__.py} executará esse chamável.

@ref{457c,,--main} não pode ser especificado ao copiar um arquivo.
@end deffn

@geindex zipapp opção de linha de comando; -c
@geindex zipapp opção de linha de comando; --compress
@anchor{library/zipapp cmdoption-zipapp-c}@anchor{457e}@anchor{library/zipapp cmdoption-zipapp-compress}@anchor{457f}
@deffn {Option} @w{-}c, @w{-}@w{-}compress

Compacta arquivos com o método deflate, reduzindo o tamanho do arquivo de saída. Por padrão, os arquivos são armazenados descompactados no arquivo.

@ref{457e,,--compress} não tem efeito ao copiar um arquivo.


Adicionado na versão 3.7.

@end deffn

@geindex zipapp opção de linha de comando; --info
@anchor{library/zipapp cmdoption-zipapp-info}@anchor{4580}
@deffn {Option} @w{-}@w{-}info

Exibe o interpretador incorporado no arquivo, para fins de diagnóstico. Neste caso, quaisquer outras opções são ignoradas e SOURCE deve ser um arquivo, não um diretório.
@end deffn

@geindex zipapp opção de linha de comando; -h
@geindex zipapp opção de linha de comando; --help
@anchor{library/zipapp cmdoption-zipapp-h}@anchor{4581}@anchor{library/zipapp cmdoption-zipapp-help}@anchor{4582}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Exibe uma mensagem curta de uso e sai
@end deffn

@node API do Python,Exemplos<32>,Interface de linha de comando<12>,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp python-api}@anchor{4583}@anchor{library/zipapp zipapp-python-api}@anchor{4575}
@subsubsection API do Python


O módulo define duas funções de conveniência:

@geindex create_archive() (no módulo zipapp)
@anchor{library/zipapp zipapp create_archive}@anchor{bc8}
@deffn {Função} zipapp.create_archive (source, target=None, interpreter=None, main=None, filter=None, compressed=False)

Cria um arquivo de aplicação a partir de `source'. A fonte pode ser qualquer um dos seguintes:


@itemize *

@item 
O nome de um diretório, ou um @ref{2a0,,objeto caminho ou similar} referente a um diretório, caso em que um novo arquivo de aplicação será criado a partir do conteúdo desse diretório.

@item 
O nome de um arquivo de aplicação existente, ou um @ref{2a0,,objeto caminho ou similar} referindo-se a tal arquivo, em cujo caso o arquivo é copiado para o alvo (modificando-o para refletir o valor dado para o argumento `interpreter'). O nome do arquivo deve incluir a extensão @code{.pyz}, se necessário.

@item 
Um objeto arquivo aberto para leitura no modo bytes. O conteúdo do arquivo deve ser um arquivo de aplicação, e o objeto arquivo é presumido como estando posicionado no início do arquivo.
@end itemize

O argumento `target' determina onde o arquivo resultante será escrito:


@itemize *

@item 
Se for o nome de um arquivo ou um @ref{2a0,,objeto caminho ou similar}, o arquivo será escrito nesse arquivo.

@item 
Se for um objeto arquivo aberto, o arquivo será escrito naquele objeto arquivo, que deve estar aberto para escrita no modo bytes.

@item 
Se o destino for omitido (ou @code{Nenhum}), a fonte deverá ser um diretório e o destino será um arquivo com o mesmo nome da fonte, com uma extensão @code{.pyz} adicionada.
@end itemize

O argumento `interpreter' especifica o nome do interpretador Python com o qual o arquivo será executado. Ele é escrito como uma linha “shebang” no início do arquivo. No POSIX, isso será interpretado pelo sistema operacional, e no Windows será manipulado pelo inicializador Python. Omitir o `interpreter' resulta em nenhuma linha shebang sendo escrita. Se um interpretador for especificado, e o alvo for um nome de arquivo, o bit executável do arquivo alvo será definido.

O argumento `main' especifica o nome de um chamável que será usado como o programa principal para o arquivo. Ele só pode ser especificado se a fonte for um diretório, e a fonte ainda não contiver um arquivo @code{__main__.py}. O argumento `main' deve ter o formato “pkg.módulo:chamável” e o arquivo será executado importando “pkg.módulo” e executando o chamável fornecido sem argumentos. É um erro omitir `main' se a fonte for um diretório e não contiver um arquivo @code{__main__.py}, pois, caso contrário, o arquivo resultante não seria executável.

O argumento opcional `filter' especifica uma função de retorno de chamada que recebe um objeto Path representando o caminho para o arquivo que está sendo adicionado (relativo ao diretório da fonte). Ele deve retornar @code{True} se o arquivo for adicionado.

O argumento opcional `compressed' determina se os arquivos são compactados. Se definido como @code{True}, os arquivos no arquivo são compactados com o método deflate; caso contrário, os arquivos são armazenados descompactados. Este argumento não tem efeito ao copiar um arquivo existente.

Se um objeto arquivo for especificado para `source' ou `target', é responsabilidade do chamador fechá-lo após chamar create_archive.

Ao copiar um arquivo existente, os objetos arquivo fornecidos precisam apenas dos métodos @code{read} e @code{readline} ou @code{write}. Ao criar um arquivo de um diretório, se o alvo for um objeto arquivo, ele será passado para a classe @code{zipfile.ZipFile} e deve fornecer os métodos necessários para essa classe.


Alterado na versão 3.7: Adicionados os parâmetros `filter' e `compressed'.

@end deffn

@geindex get_interpreter() (no módulo zipapp)
@anchor{library/zipapp zipapp get_interpreter}@anchor{4584}
@deffn {Função} zipapp.get_interpreter (archive)

Retorna o interpretador especificado na linha @code{#!} no início do arquivo. Se não houver nenhuma linha @code{#!}, retorna @ref{675,,None}. O argumento `archive' pode ser um nome de arquivo ou um objeto arquivo ou similar aberto para leitura no modo bytes. É presumido esteja no início do arquivo.
@end deffn

@node Exemplos<32>,Especificando o interpretador,API do Python,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp examples}@anchor{4585}@anchor{library/zipapp zipapp-examples}@anchor{4586}
@subsubsection Exemplos


Compacte um diretório em um arquivo e execute-o.

@example
$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>
@end example

O mesmo pode ser feito usando a função @ref{bc8,,create_archive()}:

@example
>>> import zipapp
>>> zipapp.create_archive('myapp', 'myapp.pyz')
@end example

Para tornar o aplicativo diretamente executável no POSIX, especifique um interpretador a ser usado.

@example
$ python -m zipapp myapp -p "/usr/bin/env python"
$ ./myapp.pyz
<saída de myapp>
@end example

Para substituir a linha shebang em um arquivo existente, crie um arquivo modificado usando a função @ref{bc8,,create_archive()}:

@example
>>> import zipapp
>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')
@end example

Para atualizar o arquivo no local, faça a substituição na memória usando um objeto @ref{ed3,,BytesIO} e, em seguida, sobrescreva a fonte depois. Observe que há um risco ao sobrescrever um arquivo no local de que um erro resultará na perda do arquivo original. Este código não protege contra tais erros, mas o código de produção deve fazê-lo. Além disso, este método só funcionará se o arquivo couber na memória:

@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 Especificando o interpretador,Criando aplicações autônomas com zipapp,Exemplos<32>,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp specifying-the-interpreter}@anchor{4587}@anchor{library/zipapp zipapp-specifying-the-interpreter}@anchor{4588}
@subsubsection Especificando o interpretador


Observe que se você especificar um interpretador e então distribuir seu arquivo de aplicação, você precisa garantir que o interpretador usado seja portátil. O inicializador Python para Windows oferece suporte às formas mais comuns da linha POSIX @code{#!}, mas há outras questões a serem consideradas:


@itemize *

@item 
Se você usar “/usr/bin/env python” (ou outras formas do comando “python”, como “/usr/bin/python”), você precisa considerar que seus usuários podem ter Python 2 ou Python 3 como padrão, e escrever seu código para funcionar em ambas as versões.

@item 
Se você usar uma versão explícita, por exemplo “/usr/bin/env python3”, sua aplicação não funcionará para usuários que não tenham essa versão. (Isso pode ser o que você quer se não tiver tornado seu código compatível com Python 2).

@item 
Não há como dizer “python X.Y ou posterior”, então tome cuidado ao usar uma versão exata como “/usr/bin/env python3.4”, pois você precisará alterar sua linha shebang para usuários do Python 3.5, por exemplo.
@end itemize

Normalmente, você deve usar “/usr/bin/env python2” ou “/usr/bin/env python3”, dependendo se seu código foi escrito para Python 2 ou 3.

@node Criando aplicações autônomas com zipapp,O formato de arquivo da aplicação zip Python,Especificando o interpretador,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp creating-standalone-applications-with-zipapp}@anchor{4589}
@subsubsection Criando aplicações autônomas com zipapp


Usando o módulo @ref{130,,zipapp}, é possível criar programas Python autocontidos, que podem ser distribuídos para usuários finais que precisam apenas ter uma versão adequada do Python instalada em seu sistema. A chave para fazer isso é agrupar todas as dependências da aplicação no arquivo, junto com o código da aplicação.

As etapas para criar um arquivo autônomo são as seguintes:


@enumerate 

@item 
Crie sua aplicação em um diretório normalmente, para que você tenha um diretório @code{myapp} contendo um arquivo @code{__main__.py} e qualquer código de aplicação de suporte.

@item 
Instale todas as dependências da sua aplicação no diretório @code{myapp}, usando pip:

@example
$ python -m pip install -r requirements.txt --target myapp
@end example

(isso presume que você tenha os requisitos do seu projeto em um arquivo @code{requirements.txt} - caso contrário, você pode simplesmente listar as dependências manualmente na linha de comando do pip).

@item 
Empacote a aplicação usando:

@example
$ python -m zipapp -p "interpreter" myapp
@end example
@end enumerate

Isso produzirá um executável autônomo, que pode ser executado em qualquer máquina com o interpretador apropriado disponível. Veja @ref{4588,,Especificando o interpretador} para detalhes. Ele pode ser enviado aos usuários como um único arquivo.

No Unix, o arquivo @code{myapp.pyz} é executável como está. Você pode renomear o arquivo para remover a extensão @code{.pyz} se preferir um nome de comando “simples”. No Windows, o arquivo @code{myapp.pyz[w]} é executável em virtude do fato de que o interpretador Python registra as extensões de arquivo @code{.pyz} e @code{.pyzw} quando instalado.

@menu
* Advertência:: 

@end menu

@node Advertência,,,Criando aplicações autônomas com zipapp
@anchor{library/zipapp caveats}@anchor{458a}
@subsubsection Advertência


Se sua aplicação depende de um pacote que inclui uma extensão C, esse pacote não pode ser executado a partir de um arquivo zip (essa é uma limitação do sistema operacional, pois o código executável deve estar presente no sistema de arquivos para que o carregador do sistema operacional o carregue). Nesse caso, você pode excluir essa dependência do arquivo zip e exigir que seus usuários o tenham instalado ou enviá-lo junto com seu arquivo zip e adicionar código ao seu @code{__main__.py} para incluir o diretório que contém o módulo descompactado em @code{sys.path}. Nesse caso, você precisará certificar-se de enviar binários apropriados para sua(s) arquitetura(s) de destino (e potencialmente escolher a versão correta para adicionar ao @code{sys.path} no tempo de execução, com base na máquina do usuário).

@node O formato de arquivo da aplicação zip Python,,Criando aplicações autônomas com zipapp,zipapp — Gerencia arquivos zip executáveis do Python
@anchor{library/zipapp the-python-zip-application-archive-format}@anchor{458b}
@subsubsection O formato de arquivo da aplicação zip Python


O Python tem sido capaz de executar arquivos zip que contêm um arquivo @code{__main__.py} desde a versão 2.6. Para ser executado pelo Python, um arquivo de aplicação simplesmente tem que ser um arquivo zip padrão contendo um arquivo @code{__main__.py} que será executado como o ponto de entrada para o aplicativo. Como de costume para qualquer script Python, o pai do script (neste caso, o arquivo zip) será colocado em @ref{3b4,,sys.path} e, portanto, outros módulos podem ser importados do arquivo zip.

O formato de arquivo zip permite que dados arbitrários sejam prefixados a um arquivo zip. O formato de aplicação zip usa essa habilidade para prefixar uma linha “shebang” padrão POSIX ao arquivo (@code{#!/caminho/para/interpretador}).

Formalmente, o formato de aplicação zip Python é:


@enumerate 

@item 
Uma linha shebang opcional, contendo os caracteres @code{b'#!'} seguidos por um nome de interpretador e, em seguida, um caractere de nova linha (@code{b'\n'}). O nome do interpretador pode ser qualquer coisa aceitável para o processamento “shebang” do sistema operacional ou o inicializador Python no Windows. O interpretador deve ser codificado em UTF-8 no Windows e em @ref{c74,,sys.getfilesystemencoding()} no POSIX.

@item 
Dados padrão do zipfile, conforme gerados pelo módulo @ref{131,,zipfile}. O conteúdo do zipfile `deve' incluir um arquivo chamado @code{__main__.py} (que deve estar na “raiz” do zipfile - ou seja, não pode estar em um subdiretório). Os dados do zipfile podem ser compactados ou descompactados.
@end enumerate

Se um arquivo de aplicação tiver uma linha shebang, ele poderá ter o bit executável definido em sistemas POSIX, para permitir que seja executado diretamente.

Não há exigência de que as ferramentas neste módulo sejam usadas para criar arquivos de aplicações - o módulo é uma conveniência, mas arquivos no formato acima criados por qualquer meio são aceitáveis para Python.

@node Serviços de Tempo de Execução Python,Interpretadores Python Personalizados,Empacotamento e Distribuição de Software,A Biblioteca Padrão do Python
@anchor{library/python doc}@anchor{458c}@anchor{library/python python}@anchor{458d}@anchor{library/python python-runtime-services}@anchor{458e}@anchor{library/python translation-repo}@anchor{458f}
@section Serviços de Tempo de Execução Python


Os módulos descritos neste capítulo oferecem uma ampla gama de serviços relacionados ao interpretador Python e sua interação com o ambiente. Aqui está uma visão geral:

@menu
* sys — Parâmetros e funções específicas do sistema:: 
* sys.monitoring — Monitoramento de eventos de execução: sys monitoring — Monitoramento de eventos de execução. 
* sysconfig — Fornece acesso às informações de configuração do Python:: 
* builtins — Objetos embutidos:: 
* __main__ — Ambiente de código principal:: 
* warnings — Controle de avisos:: 
* dataclasses — Data Classes:: 
* contextlib — Utilitários para contextos da instrução with:: 
* abc — Classes base abstratas:: 
* atexit — Manipuladores de saída:: 
* traceback — Imprime ou recupera um traceback da pilha:: 
* __future__ — Definições de instruções future:: 
* gc — Interface para o coletor de lixo:: 
* inspect — Inspecione objetos vivos:: 
* site — Gancho de configuração específico do site:: 

@end menu

@node sys — Parâmetros e funções específicas do sistema,sys monitoring — Monitoramento de eventos de execução,,Serviços de Tempo de Execução Python
@anchor{library/sys doc}@anchor{4590}@anchor{library/sys module-sys}@anchor{d9}@anchor{library/sys sys-system-specific-parameters-and-functions}@anchor{4591}
@subsection @code{sys} — Parâmetros e funções específicas do sistema


@geindex module; sys


__________________________________________________________________


Este módulo fornece acesso a algumas variáveis usadas ou mantidas pelo interpretador e a funções que interagem fortemente com o interpretador. Sempre disponível. A menos que explicitamente indicado o contrário, todas as variáveis são somente leitura.

@geindex abiflags (no módulo sys)
@anchor{library/sys sys abiflags}@anchor{a6d}
@deffn {Dado} sys.abiflags

Em sistemas POSIX onde Python foi construído com o script @code{configure} padrão, ele contém os sinalizadores ABI conforme especificado por 
@geindex Propostas de Melhorias do Python; PEP 3149
PEP 3149@footnote{https://peps.python.org/pep-3149/}.


Adicionado na versão 3.2.



Alterado na versão 3.8: Os sinalizadores padrões se tornaram uma string vazia (o sinalizador @code{m} para pymalloc foi removido).


@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex addaudithook() (no módulo sys)
@anchor{library/sys sys addaudithook}@anchor{43fc}
@deffn {Função} sys.addaudithook (hook)

Anexa o `hook' chamável à lista de ganchos de auditoria ativos para o (sub)interpretador atual.

Quando um evento de auditoria é levantado através da função @ref{16a0,,sys.audit()}, cada gancho será chamado na ordem em que foi adicionado com o nome do evento e a tupla de argumentos. Ganchos nativos adicionados por @ref{43fd,,PySys_AddAuditHook()} são chamados primeiro, seguidos por ganchos adicionados no (sub)interpretador atual. Os ganchos podem registrar o evento, levantar uma exceção para cancelar a operação ou encerrar o processo completamente.

Observe que os ganchos de auditoria são principalmente para coletar informações sobre ações internas ou não observáveis, seja por Python ou bibliotecas escritas em Python. Eles não são adequados para implementar um ambiente isolado estilo “sandbox”. Em particular, o código malicioso pode desabilitar ou ignorar os ganchos adicionados usando esta função. No mínimo, quaisquer ganchos sensíveis à segurança devem ser adicionados usando a API C @ref{43fd,,PySys_AddAuditHook()} antes de inicializar o tempo de execução, e quaisquer módulos que permitam modificação arbitrária da memória (como @ref{2a,,ctypes}) devem ser completamente removidos ou monitorados de perto.

Chamar @ref{43fc,,sys.addaudithook()} levantará um evento de auditoria denominado @code{sys.addaudithook} sem argumentos. Se qualquer gancho existente levantar uma exceção derivada de @ref{195,,RuntimeError}, o novo gancho não será adicionado e a exceção será suprimida. Como resultado, os chamadores não podem presumir que seu gancho foi adicionado, a menos que controlem todos os ganchos existentes.

Veja @ref{199c,,tabela de eventos de auditoria} para todos os eventos levantados pelo CPython, e 
@geindex Propostas de Melhorias do Python; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para a discussão do projeto original.


Adicionado na versão 3.8.



Alterado na versão 3.8.1: Exceções derivadas de @ref{9e2,,Exception}, mas não de @ref{195,,RuntimeError}, não são mais suprimidas.


Quando o rastreamento está ativado (consulte @ref{1547,,settrace()}), os ganchos do Python são rastreados apenas se o chamável tiver um membro @code{__cantrace__} definido como um valor verdadeiro. Caso contrário, as funções de rastreamento ignorarão o gancho.
@end deffn

@geindex argv (no módulo sys)
@anchor{library/sys sys argv}@anchor{12a6}
@deffn {Dado} sys.argv

A lista de argumentos de linha de comando passados para um script Python. @code{argv[0]} é o nome do script (depende do sistema operacional se este é um nome de caminho completo ou não). Se o comando foi executado usando a opção de linha de comando @ref{5e0,,-c} para o interpretador, @code{argv[0]} é definido como a string @code{'-c'}. Se nenhum nome de script foi passado para o interpretador Python, @code{argv[0]} é a string vazia.

Para percorrer a entrada padrão ou a lista de arquivos fornecida na linha de comando, consulte o módulo @ref{5b,,fileinput}.

Veja também @ref{843,,sys.orig_argv}.

@cartouche
@quotation Nota 
No Unix, os argumentos da linha de comando são passados por bytes do sistema operacional. O Python os decodifica com a codificação do sistema de arquivos e o tratador de erros “surrogateescape”. Quando você precisar de bytes originais, você pode obtê-los por @code{[os.fsencode(arg) for arg in sys.argv]}.
@end quotation
@end cartouche
@end deffn

@geindex audit() (no módulo sys)
@anchor{library/sys auditing}@anchor{19fa}@anchor{library/sys sys audit}@anchor{16a0}
@deffn {Função} sys.audit (event, *args)

@geindex auditoria

Levanta um evento de auditoria e aciona quaisquer ganchos de auditoria ativos. `event' é uma string que identifica o evento e `args' pode conter argumentos opcionais com mais informações sobre o evento. O número e os tipos de argumentos para um determinado evento são considerados uma API pública e estável e não devem ser modificados entre as versões.

Por exemplo, um evento de auditoria é denominado @code{os.chdir}. Este evento tem um argumento chamado `path' que conterá o novo diretório de trabalho solicitado.

@ref{16a0,,sys.audit()} chamará os ganchos de auditoria existentes, passando o nome do evento e os argumentos, e levantará novamente a primeira exceção de qualquer gancho. Em geral, se uma exceção for levantada, ela não deve ser tratada e o processo deve ser encerrado o mais rápido possível. Isso permite que as implementações de gancho decidam como responder a eventos específicos: elas podem simplesmente registrar o evento ou abortar a operação levantando uma exceção.

Ganchos são adicionados usando as funções @ref{43fc,,sys.addaudithook()} ou @ref{43fd,,PySys_AddAuditHook()}.

O equivalente nativo desta função é @ref{36f,,PySys_Audit()}. Usar a função nativa é preferível quando possível.

Veja @ref{199c,,tabela de eventos de auditoria} para todos os eventos levantados pelo CPython.


Adicionado na versão 3.8.

@end deffn

@geindex base_exec_prefix (no módulo sys)
@anchor{library/sys sys base_exec_prefix}@anchor{3ee}
@deffn {Dado} sys.base_exec_prefix

Definido durante a inicialização do Python, antes de @code{site.py} ser executado, para o mesmo valor que @ref{3b2,,exec_prefix}. Se não estiver executando em um @ref{4557,,ambiente virtual}, os valores permanecerão os mesmos; se @code{site.py} descobrir que um ambiente virtual está em uso, os valores de @ref{3b6,,prefix} e @ref{3b2,,exec_prefix} serão alterados para apontar para o ambiente virtual, enquanto @ref{3ef,,base_prefix} e @ref{3ee,,base_exec_prefix} permanecerá apontando para a instalação base do Python (aquela a partir da qual o ambiente virtual foi criado).


Adicionado na versão 3.3.

@end deffn

@geindex base_prefix (no módulo sys)
@anchor{library/sys sys base_prefix}@anchor{3ef}
@deffn {Dado} sys.base_prefix

Definido durante a inicialização do Python, antes de @code{site.py} ser executado, para o mesmo valor que @ref{3b6,,prefix}. Se não estiver executando em um @ref{4557,,ambiente virtual}, os valores permanecerão os mesmos; se @code{site.py} descobrir que um ambiente virtual está em uso, os valores de @ref{3b6,,prefix} e @ref{3b2,,exec_prefix} serão alterados para apontar para o ambiente virtual, enquanto @ref{3ef,,base_prefix} e @ref{3ee,,base_exec_prefix} permanecerá apontando para a instalação base do Python (aquela a partir da qual o ambiente virtual foi criado).


Adicionado na versão 3.3.

@end deffn

@geindex byteorder (no módulo sys)
@anchor{library/sys sys byteorder}@anchor{2330}
@deffn {Dado} sys.byteorder

Um indicador da ordem nativa de bytes. Isso terá o valor @code{'big'} em plataformas big endian (byte mais significativo primeiro) e @code{'little'} em plataformas little endian (byte menos significativo primeiro).
@end deffn

@geindex builtin_module_names (no módulo sys)
@anchor{library/sys sys builtin_module_names}@anchor{1de5}
@deffn {Dado} sys.builtin_module_names

Uma tupla de strings contendo os nomes de todos os módulos compilados neste interpretador Python. (Esta informação não está disponível de nenhuma outra forma — @code{modules.keys()} apenas lista os módulos importados.)

Veja também a lista de @ref{844,,sys.stdlib_module_names}.
@end deffn

@geindex call_tracing() (no módulo sys)
@anchor{library/sys sys call_tracing}@anchor{194d}
@deffn {Função} sys.call_tracing (func, args)

Chama @code{func(*args)}, enquanto o rastreamento está habilitado. O estado de rastreamento é salvo e restaurado posteriormente. Isso deve ser chamado de um depurador de um ponto de verificação, para depurar ou analisar o desempenho recursivamente algum outro código.

O rastreamento é suspenso ao chamar uma função de rastreamento definida por @ref{1547,,settrace()} ou @ref{1546,,setprofile()} para evitar recursão infinita. @code{call_tracing()} habilita a recursão explícita da função de rastreamento.
@end deffn

@geindex copyright (no módulo sys)
@anchor{library/sys sys copyright}@anchor{4592}
@deffn {Dado} sys.copyright

Uma string contendo os direitos autorais pertencentes ao interpretador Python.
@end deffn

@geindex _clear_type_cache() (no módulo sys)
@anchor{library/sys sys _clear_type_cache}@anchor{1767}
@deffn {Função} sys._clear_type_cache ()

Limpa o cache de tipo interno. O cache de tipo é usado para acelerar pesquisas de atributos e métodos. Use a função `apenas' para descartar referências desnecessárias durante a depuração de vazamento de referência.

Esta função deve ser usada apenas para fins internos e especializados.


Descontinuado desde a versão 3.13: Em vez disso, use a função mais geral @ref{1766,,_clear_internal_caches()}.

@end deffn

@geindex _clear_internal_caches() (no módulo sys)
@anchor{library/sys sys _clear_internal_caches}@anchor{1766}
@deffn {Função} sys._clear_internal_caches ()

Limpa todos os caches internos relacionados ao desempenho. Use esta função `somente' para liberar referências e blocos de memória desnecessários ao procurar por vazamentos.


Adicionado na versão 3.13.

@end deffn

@geindex _current_frames() (no módulo sys)
@anchor{library/sys sys _current_frames}@anchor{147a}
@deffn {Função} sys._current_frames ()

Retorna um dicionário mapeando o identificador de cada encadeamento (`thread') para o quadro de pilha mais alto atualmente ativo nesse encadeamento no momento em que a função é chamada. Observe que as funções no módulo @ref{fe,,traceback} podem construir a pilha de chamadas dado tal quadro.

Isso é mais útil para fazer a depuração de impasses: esta função não requer a cooperação das threads em impasse e as pilhas de chamadas de tais threads são congeladas enquanto permanecerem em impasse (`deadlock'). O quadro retornado para uma thread sem impasse pode não ter nenhuma relação com a atividade atual da thread no momento em que o código de chamada examina o quadro.

Esta função deve ser usada apenas para fins internos e especializados.

Levanta um @ref{19fa,,evento de auditoria} @code{sys._current_frames} sem argumentos.
@end deffn

@geindex _current_exceptions() (no módulo sys)
@anchor{library/sys sys _current_exceptions}@anchor{4c2}
@deffn {Função} sys._current_exceptions ()

Retorna um dicionário mapeando o identificador de cada encadeamento (`thread') para a exceção mais alta atualmente ativo nesse encadeamento no momento em que a função é chamada. Se um encadeamento não estiver manipulando uma exceção no momento, ele não será incluído no dicionário de resultados.

Isso é mais útil para criação de perfil estatístico.

Esta função deve ser usada apenas para fins internos e especializados.

Levanta um @ref{19fa,,evento de auditoria} @code{sys._current_exceptions} sem argumentos.


Alterado na versão 3.12: Cada valor no dicionário agora é uma única instância de exceção, em vez de uma tupla de 3 elementos, como retornado de @code{sys.exc_info()}.

@end deffn

@geindex breakpointhook() (no módulo sys)
@anchor{library/sys sys breakpointhook}@anchor{aea}
@deffn {Função} sys.breakpointhook ()

Esta função de gancho é chamada pela função embutida @ref{234,,breakpoint()}. Por padrão, ela leva você ao depurador @ref{a5,,pdb}, mas pode ser configurado para qualquer outra função para que você possa escolher qual depurador será usado.

A assinatura dessa função depende do que ela chama. Por exemplo, a ligação padrão (por exemplo, @code{pdb.set_trace()}) não espera nenhum argumento, mas você pode vinculá-la a uma função que espera argumentos adicionais (posicionais e/ou nomeados). A função embutida @code{breakpoint()} passa seus @code{*args} e @code{**kws} diretamente. O que quer que @code{breakpointhooks()} retorne é retornado de @code{breakpoint()}.

A implementação padrão primeiro consulta a variável de ambiente 
@geindex PYTHONBREAKPOINT
@geindex variável de ambiente; PYTHONBREAKPOINT
@ref{aeb,,PYTHONBREAKPOINT}. Se for definido como @code{"0"}, então esta função retorna imediatamente; ou seja, é um no-op. Se a variável de ambiente não for definida, ou for definida como uma string vazia, @code{pdb.set_trace()} será chamado. Caso contrário, essa variável deve nomear uma função a ser executada, usando a nomenclatura de importação pontilhada do Python, por exemplo @code{package.subpackage.module.function}. Neste caso, @code{package.subpackage.module} seria importado e o módulo resultante deve ter um chamável chamado @code{function()}. Isso é executado, passando @code{*args} e @code{**kws}, e qualquer que seja o retorno de @code{function()}, @code{sys.breakpointhook()} retorna para a função embutida @ref{234,,breakpoint()}.

Observe que se algo der errado ao importar o chamável nomeado por 
@geindex PYTHONBREAKPOINT
@geindex variável de ambiente; PYTHONBREAKPOINT
@ref{aeb,,PYTHONBREAKPOINT}, uma @ref{1bd,,RuntimeWarning} é relatado e o ponto de interrupção é ignorado.

Observe também que se @code{sys.breakpointhook()} for sobrescrito programaticamente, 
@geindex PYTHONBREAKPOINT
@geindex variável de ambiente; PYTHONBREAKPOINT
@ref{aeb,,PYTHONBREAKPOINT} `não' será consultado.


Adicionado na versão 3.7.

@end deffn

@geindex _debugmallocstats() (no módulo sys)
@anchor{library/sys sys _debugmallocstats}@anchor{4593}
@deffn {Função} sys._debugmallocstats ()

Imprima informações de baixo nível para stderr sobre o estado do alocador de memória do CPython.

Se o Python for @ref{1f9,,compilado no modo de depuração} (@ref{424,,opção --with-pydebug do configure}), ele também executa algumas verificações de consistência interna custosas.


Adicionado na versão 3.3.


Esta função é específica para CPython. O formato de saída exato não é definido aqui e pode mudar.
@end deffn

@geindex dllhandle (no módulo sys)
@anchor{library/sys sys dllhandle}@anchor{4594}
@deffn {Dado} sys.dllhandle

Número inteiro que especifica o identificador da DLL do Python.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex displayhook() (no módulo sys)
@anchor{library/sys sys displayhook}@anchor{1568}
@deffn {Função} sys.displayhook (value)

Se `value' não for @code{None}, esta função imprime @code{repr(value)} em @code{sys.stdout}, e salva `value' em @code{builtins._}. Se @code{repr(value)} não for codificável para @code{sys.stdout.encoding} com o tratador de erros @code{sys.stdout.errors} (que provavelmente é @code{'strict'}), codifica-o para @code{sys.stdout.encoding} com tratador de erros @code{'backslashreplace'}.

@code{sys.displayhook} é chamado no resultado da avaliação de uma @ref{2111,,expressão} inserida em uma sessão interativa do Python. A exibição desses valores pode ser personalizada atribuindo outra função de um argumento a @code{sys.displayhook}.

Pseudocódigo:

@example
def displayhook(value):
    if value is None:
        return
    # Define '_' como None para evitar recursão
    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


Alterado na versão 3.2: Usa o tratador de erros @code{'backslashreplace'} ao ser levantada @ref{677,,UnicodeEncodeError}.

@end deffn

@geindex dont_write_bytecode (no módulo sys)
@anchor{library/sys sys dont_write_bytecode}@anchor{4595}
@deffn {Dado} sys.dont_write_bytecode

Se isso for true, o Python não tentará escrever arquivos @code{.pyc} na importação de módulos fonte. Este valor é inicialmente definido como @code{True} ou @code{False} dependendo da opção de linha de comando @ref{1414,,-B} e da variável de ambiente 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE}, mas você mesmo pode configurá-lo para controlar geração de arquivo bytecode.
@end deffn

@geindex _emscripten_info (no módulo sys)
@anchor{library/sys sys _emscripten_info}@anchor{1919}
@deffn {Dado} sys._emscripten_info

Um @ref{64e,,tupla nomeada} contendo informações sobre o ambiente na plataforma `wasm32-emscripten'. A tupla nomeada é provisória e pode mudar no futuro.

@geindex emscripten_version (atributo sys._emscripten_info)
@anchor{library/sys sys _emscripten_info emscripten_version}@anchor{4596}
@deffn {Atributo} _emscripten_info.emscripten_version

Versão emscripten como tupla de ints (maior, menor, micro), por exemplo @code{(3, 1, 8)}.
@end deffn

@geindex runtime (atributo sys._emscripten_info)
@anchor{library/sys sys _emscripten_info runtime}@anchor{4597}
@deffn {Atributo} _emscripten_info.runtime

String em tempo de execução; por exemplo, user-agent do navegador, @code{'Node.js v14.18.2'}, ou @code{'UNKNOWN'}.
@end deffn

@geindex pthreads (atributo sys._emscripten_info)
@anchor{library/sys sys _emscripten_info pthreads}@anchor{4598}
@deffn {Atributo} _emscripten_info.pthreads

@code{True} se o Python for compilado com suporte a pthreads do Emscripten.
@end deffn

@geindex shared_memory (atributo sys._emscripten_info)
@anchor{library/sys sys _emscripten_info shared_memory}@anchor{4599}
@deffn {Atributo} _emscripten_info.shared_memory

@code{True} se o Python for compilado com suporte a memória compartilhada.
@end deffn

@ref{1ed8,,Disponibilidade}: Emscripten.


Adicionado na versão 3.11.

@end deffn

@geindex pycache_prefix (no módulo sys)
@anchor{library/sys sys pycache_prefix}@anchor{9ac}
@deffn {Dado} sys.pycache_prefix

Se for definido (não @code{None}), o Python escreverá arquivos de cache de bytecode @code{.pyc} para (e os lerá de) uma árvore de diretórios paralela com raiz neste diretório, em vez de diretórios @code{__pycache__} na árvore de código-fonte. Quaisquer diretórios @code{__pycache__} na árvore de código-fonte serão ignorados e novos arquivos @code{.pyc} gravados dentro do prefixo pycache. Portanto, se você usar @ref{20,,compileall} como uma etapa de pré-compilação, certifique-se de executá-lo com o mesmo prefixo pycache (se houver) que usará em tempo de execução.

Um caminho relativo é interpretado em relação ao diretório de trabalho atual.

Este valor é definido inicialmente com base no valor da opção de linha de comando @ref{176,,-X} @code{pycache_prefix=PATH} ou na variável de ambiente 
@geindex PYTHONPYCACHEPREFIX
@geindex variável de ambiente; PYTHONPYCACHEPREFIX
@ref{9ab,,PYTHONPYCACHEPREFIX} (a linha de comando tem precedência). Se nenhum estiver definido, é @code{None}.


Adicionado na versão 3.8.

@end deffn

@geindex excepthook() (no módulo sys)
@anchor{library/sys sys excepthook}@anchor{80e}
@deffn {Função} sys.excepthook (type, value, traceback)

Esta função imprime um determinado traceback (situação da pilha de execução) e exceção para @code{sys.stderr}.

Quando uma exceção além da @ref{d63,,SystemExit} é levantada e não capturada, o interpretador chama @code{sys.excepthook} com três argumentos, a classe de exceção, a instância de exceção e um objeto traceback. Em uma sessão interativa, isso acontece logo antes de o controle retornar ao prompt; em um programa Python, isso acontece pouco antes de o programa ser encerrado. A manipulação de tais exceções de nível superior pode ser personalizada atribuindo outra função de três argumentos a @code{sys.excepthook}.

Levanta um evento de auditoria @code{sys.excepthook} com os argumentos @code{hook}, @code{type}, @code{value}, @code{traceback} quando ocorre uma exceção não capturada. Se nenhum gancho foi definido, @code{hook} pode ser @code{None}. Se algum gancho gerar uma exceção derivada de @ref{195,,RuntimeError}, a chamada para o gancho será suprimida. Caso contrário, a exceção de gancho de auditoria será relatada como não aumentável e @code{sys.excepthook} será chamado.


@subsubheading Ver também


A função @ref{1f7,,sys.unraisablehook()} lida com exceções que não podem ser levantadas e a função @ref{84e,,threading.excepthook()} trata exceções levantadas por @ref{a46,,threading.Thread.run()}.

@end deffn

@geindex __breakpointhook__ (no módulo sys)
@geindex __displayhook__ (no módulo sys)
@geindex __excepthook__ (no módulo sys)
@geindex __unraisablehook__ (no módulo sys)
@anchor{library/sys sys __breakpointhook__}@anchor{459a}
@deffn {Dado} sys.__breakpointhook__
@anchor{library/sys sys __displayhook__}@anchor{459b}
@deffnx {Dado} sys.__displayhook__
@anchor{library/sys sys __excepthook__}@anchor{459c}
@deffnx {Dado} sys.__excepthook__
@anchor{library/sys sys __unraisablehook__}@anchor{459d}
@deffnx {Dado} sys.__unraisablehook__

Esses objetos contêm os valores originais de @code{breakpointhook}, @code{displayhook}, @code{excepthook} e @code{unraisablehook} no início do programa. Eles são salvos para que @code{breakpointhook}, @code{displayhook} e @code{excepthook}, @code{unraisablehook} possam ser restaurados caso sejam substituídos por objetos quebrados ou alternativos.


Adicionado na versão 3.7: __breakpointhook__



Adicionado na versão 3.8: __unraisablehook__

@end deffn

@geindex exception() (no módulo sys)
@anchor{library/sys sys exception}@anchor{68b}
@deffn {Função} sys.exception ()

Esta função, quando chamada enquanto um tratador de exceção está em execução (como uma cláusula @code{except} ou @code{except*}), retorna a instância da exceção que foi capturada por este tratador. Quando os manipuladores de exceção estão aninhados um dentro do outro, apenas a exceção tratada pelo tratador mais interno é acessível.

Se nenhum tratador de exceções estiver em execução, esta função retornará @code{None}.


Adicionado na versão 3.11.

@end deffn

@geindex exc_info() (no módulo sys)
@anchor{library/sys sys exc_info}@anchor{68a}
@deffn {Função} sys.exc_info ()

Essa função retorna a representação de estilo antigo da exceção tratada. Se uma exceção @code{e} é tratada atualmente (de forma que @ref{68b,,exception()} retornaria @code{e}), @ref{68a,,exc_info()} retorna a tupla @code{(type(e), e, e.__traceback__)}. Ou seja, uma tupla contendo o tipo da exceção (uma subclasse de @ref{5bb,,BaseException}), a própria exceção e um @ref{b07,,objeto de traceback} que normalmente encapsula a pilha de chamadas no ponto em que a última exceção ocorreu.

@geindex objeto;traceback

Se nenhuma exceção estiver sendo tratada em qualquer lugar da pilha, esta função retornará uma tupla contendo três valores @code{None}.


Alterado na versão 3.11: Os campos @code{type} e @code{traceback} agora são derivados do @code{value} (a instância da exceção), portanto, quando uma exceção é modificada enquanto está sendo tratada, as alterações são refletidas nos resultados das subsequentes chamadas para @ref{68a,,exc_info()}.

@end deffn

@geindex exec_prefix (no módulo sys)
@anchor{library/sys sys exec_prefix}@anchor{3b2}
@deffn {Dado} sys.exec_prefix

Uma string que fornece o prefixo do diretório específico do site onde os arquivos Python dependentes da plataforma são instalados; por padrão, também é @code{'/usr/local'}. Isso pode ser definido em tempo de compilação com o argumento @code{--exec-prefix} para o script @code{configure}. Especificamente, todos os arquivos de configuração (por exemplo, o arquivo de cabeçalho @code{pyconfig.h}) são instalados no diretório @code{`exec_prefix'/lib/python`X.Y'/config}, e os módulos da biblioteca compartilhada são instalados em @code{`exec_prefix'/lib/python`X.Y'/lib-dynload}, onde `X.Y' é o número da versão do Python, por exemplo @code{3.2}.

@cartouche
@quotation Nota 
Se um @ref{4557,,ambiente virtual} estiver em vigor, este valor será alterado em @code{site.py} para apontar para o ambiente virtual. O valor para a instalação do Python ainda estará disponível, via @ref{3ee,,base_exec_prefix}.
@end quotation
@end cartouche
@end deffn

@geindex executable (no módulo sys)
@anchor{library/sys sys executable}@anchor{3b8}
@deffn {Dado} sys.executable

Uma string que fornece o caminho absoluto do binário executável para o interpretador Python, em sistemas onde isso faz sentido. Se o Python não conseguir recuperar o caminho real para seu executável, @ref{3b8,,sys.executable} será uma string vazia ou @code{None}.
@end deffn

@geindex exit() (no módulo sys)
@anchor{library/sys sys exit}@anchor{138e}
@deffn {Função} sys.exit ([arg])

Levanta uma exceção @ref{d63,,SystemExit}, sinalizando a intenção de sair do interpretador.

O argumento opcional `arg' pode ser um número inteiro dando o status de saída (o padrão é zero) ou outro tipo de objeto. Se for um número inteiro, zero é considerado “terminação bem-sucedida” e qualquer valor diferente de zero é considerado “terminação anormal” por shells e similares. A maioria dos sistemas exige que ele esteja no intervalo de 0 a 127 e, caso contrário, produz resultados indefinidos. Alguns sistemas têm uma convenção para atribuir significados específicos a códigos de saída específicos, mas estes são geralmente pouco desenvolvidos; programas Unix geralmente usam 2 para erros de sintaxe de linha de comando e 1 para todos os outros tipos de erros. Se outro tipo de objeto for passado, @code{None} é equivalente a passar zero, e qualquer outro objeto é impresso em @ref{940,,stderr} e resulta em um código de saída de 1. Em particular, @code{sys.exit( "alguma mensagem de erro")} é uma maneira rápida de sair de um programa quando ocorre um erro.

Uma vez que @ref{2320,,exit()} em última análise, “apenas” gera uma exceção, ele só sairá do processo quando chamado da thread principal e a exceção não é interceptada. As ações de limpeza especificadas pelas cláusulas finally de instruções @ref{6e9,,try} são honradas e é possível interceptar a tentativa de saída em um nível externo.


Alterado na versão 3.6: Se ocorrer um erro na limpeza após o interpretador Python ter capturado @ref{d63,,SystemExit} (como um erro ao liberar dados em buffer nos fluxos padrão), o status de saída é alterado para 120.

@end deffn

@geindex flags (no módulo sys)
@anchor{library/sys sys flags}@anchor{68c}
@deffn {Dado} sys.flags

A @ref{64e,,tupla nomeada} `flags' expõe o status dos sinalizadores de linha de comando. Os atributos são somente leitura.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex debug (atributo sys.flags)
@anchor{library/sys sys flags debug}@anchor{459e}
@deffn {Atributo} flags.debug
@end deffn

@tab

@ref{1ebb,,-d}

@item

@geindex inspect (atributo sys.flags)
@anchor{library/sys sys flags inspect}@anchor{15b5}
@deffn {Atributo} flags.inspect
@end deffn

@tab

@ref{1523,,-i}

@item

@geindex interactive (atributo sys.flags)
@anchor{library/sys sys flags interactive}@anchor{459f}
@deffn {Atributo} flags.interactive
@end deffn

@tab

@ref{1523,,-i}

@item

@geindex isolated (atributo sys.flags)
@anchor{library/sys sys flags isolated}@anchor{45a0}
@deffn {Atributo} flags.isolated
@end deffn

@tab

@ref{965,,-I}

@item

@geindex optimize (atributo sys.flags)
@anchor{library/sys sys flags optimize}@anchor{45a1}
@deffn {Atributo} flags.optimize
@end deffn

@tab

@ref{ddd,,-O} ou @ref{dde,,-OO}

@item

@geindex dont_write_bytecode (atributo sys.flags)
@anchor{library/sys sys flags dont_write_bytecode}@anchor{45a2}
@deffn {Atributo} flags.dont_write_bytecode
@end deffn

@tab

@ref{1414,,-B}

@item

@geindex no_user_site (atributo sys.flags)
@anchor{library/sys sys flags no_user_site}@anchor{45a3}
@deffn {Atributo} flags.no_user_site
@end deffn

@tab

@ref{13d5,,-s}

@item

@geindex no_site (atributo sys.flags)
@anchor{library/sys sys flags no_site}@anchor{45a4}
@deffn {Atributo} flags.no_site
@end deffn

@tab

@ref{11e7,,-S}

@item

@geindex ignore_environment (atributo sys.flags)
@anchor{library/sys sys flags ignore_environment}@anchor{45a5}
@deffn {Atributo} flags.ignore_environment
@end deffn

@tab

@ref{964,,-E}

@item

@geindex verbose (atributo sys.flags)
@anchor{library/sys sys flags verbose}@anchor{45a6}
@deffn {Atributo} flags.verbose
@end deffn

@tab

@ref{146c,,-v}

@item

@geindex bytes_warning (atributo sys.flags)
@anchor{library/sys sys flags bytes_warning}@anchor{45a7}
@deffn {Atributo} flags.bytes_warning
@end deffn

@tab

@ref{5e3,,-b}

@item

@geindex quiet (atributo sys.flags)
@anchor{library/sys sys flags quiet}@anchor{45a8}
@deffn {Atributo} flags.quiet
@end deffn

@tab

@ref{15a5,,-q}

@item

@geindex hash_randomization (atributo sys.flags)
@anchor{library/sys sys flags hash_randomization}@anchor{45a9}
@deffn {Atributo} flags.hash_randomization
@end deffn

@tab

@ref{1c11,,-R}

@item

@geindex dev_mode (atributo sys.flags)
@anchor{library/sys sys flags dev_mode}@anchor{1c1b}
@deffn {Atributo} flags.dev_mode
@end deffn

@tab

@ref{176,,-X dev} (@ref{1f8,,Modo de Desenvolvimento do Python})

@item

@geindex utf8_mode (atributo sys.flags)
@anchor{library/sys sys flags utf8_mode}@anchor{45aa}
@deffn {Atributo} flags.utf8_mode
@end deffn

@tab

@ref{176,,-X utf8}

@item

@geindex safe_path (atributo sys.flags)
@anchor{library/sys sys flags safe_path}@anchor{236}
@deffn {Atributo} flags.safe_path
@end deffn

@tab

@ref{5a4,,-P}

@item

@geindex int_max_str_digits (atributo sys.flags)
@anchor{library/sys sys flags int_max_str_digits}@anchor{2410}
@deffn {Atributo} flags.int_max_str_digits
@end deffn

@tab

@ref{176,,-X int_max_str_digits} (@ref{5f5,,limitação de comprimento de string na conversão para inteiro})

@item

@geindex warn_default_encoding (atributo sys.flags)
@anchor{library/sys sys flags warn_default_encoding}@anchor{45ab}
@deffn {Atributo} flags.warn_default_encoding
@end deffn

@tab

@ref{176,,-X warn_default_encoding}

@end multitable



Alterado na versão 3.2: Adicionado o atributo @code{quiet} para o novo sinalizador @ref{15a5,,-q}.



Adicionado na versão 3.2.3: O atributo @code{hash_randomization}.



Alterado na versão 3.3: Removido o atributo obsoleto @code{division_warning}.



Alterado na versão 3.4: Adicionado o atributo @code{isolated} para o sinalizador @ref{965,,-I} @code{isolated}.



Alterado na versão 3.7: Adicionado o atributo @code{dev_mode} para o novo @ref{1f8,,Modo de Desenvolvimento do Python} e o atributo @code{utf8_mode} para o novo sinalizador @ref{176,,-X} @code{utf8}.



Alterado na versão 3.10: Adicionado o atributo @code{warn_default_encoding} para o sinalizador @ref{176,,-X} @code{warn_default_encoding}.



Alterado na versão 3.11: Adicionado o atributo @code{safe_path} para a opção @ref{5a4,,-P}.



Alterado na versão 3.11: Adicionado o atributo @code{int_max_str_digits}.

@end deffn

@geindex float_info (no módulo sys)
@anchor{library/sys sys float_info}@anchor{1b62}
@deffn {Dado} sys.float_info

Uma @ref{64e,,tupla nomeada} contendo informações sobre o tipo float, ponto flutuante. Ele contém informações de baixo nível sobre a precisão e a representação interna. Os valores correspondem às várias constantes de ponto flutuante definidas no arquivo de cabeçalho padrão @code{float.h} para a linguagem de programação ‘C’; consulte a seção 5.2.4.2.2 do padrão ISO/IEC C de 1999 @ref{45ac,,[C99]}, ‘Características dos tipos flutuantes’, para obter detalhes.
Atributos da tupla nomeada @code{float_info}



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

atributo

@tab

macro em float.h

@tab

explicação

@item

@geindex epsilon (atributo sys.float_info)
@anchor{library/sys sys float_info epsilon}@anchor{45ad}
@deffn {Atributo} float_info.epsilon
@end deffn

@tab

@code{DBL_EPSILON}

@tab

diferença entre 1,0 e o menor valor maior que 1,0 que pode ser representado como ponto flutuante.

Veja também @code{math.ulp.()}

@item

@geindex dig (atributo sys.float_info)
@anchor{library/sys sys float_info dig}@anchor{45ae}
@deffn {Atributo} float_info.dig
@end deffn

@tab

@code{DBL_DIG}

@tab

O número máximo de dígitos decimais que podem ser fielmente representados em um ponto flutuante; veja abaixo.

@item

@geindex mant_dig (atributo sys.float_info)
@anchor{library/sys sys float_info mant_dig}@anchor{45af}
@deffn {Atributo} float_info.mant_dig
@end deffn

@tab

@code{DBL_MANT_DIG}

@tab

Precisão do ponto flutuante: o número de dígitos de base @code{radix} no significando de um ponto flutuante.

@item

@geindex max (atributo sys.float_info)
@anchor{library/sys sys float_info max}@anchor{45b0}
@deffn {Atributo} float_info.max
@end deffn

@tab

@code{DBL_MAX}

@tab

O ponto flutuante finito positivo máximo representável.

@item

@geindex max_exp (atributo sys.float_info)
@anchor{library/sys sys float_info max_exp}@anchor{45b1}
@deffn {Atributo} float_info.max_exp
@end deffn

@tab

@code{DBL_MAX_EXP}

@tab

O inteiro máximo `e' de tal modo que @code{radix**(e-1)} é um ponto flutuante finito representável.

@item

@geindex max_10_exp (atributo sys.float_info)
@anchor{library/sys sys float_info max_10_exp}@anchor{45b2}
@deffn {Atributo} float_info.max_10_exp
@end deffn

@tab

@code{DBL_MAX_10_EXP}

@tab

O inteiro máximo `e' de tal modo que @code{10**e} é um intervalo de pontos flutuantes finitos representáveis.

@item

@geindex min (atributo sys.float_info)
@anchor{library/sys sys float_info min}@anchor{45b3}
@deffn {Atributo} float_info.min
@end deffn

@tab

@code{DBL_MIN}

@tab

O ponto flutuante `normalizado' positivo mínimo representável.

Use @ref{918,,math.ulp(0.0)} para obter o menor ponto flutuante representável positivo `desnormalizado'.

@item

@geindex min_exp (atributo sys.float_info)
@anchor{library/sys sys float_info min_exp}@anchor{45b4}
@deffn {Atributo} float_info.min_exp
@end deffn

@tab

@code{DBL_MIN_EXP}

@tab

O inteiro mínimo `e' de tal modo que @code{radix**(e-1)} é um ponto flutuante normalizado.

@item

@geindex min_10_exp (atributo sys.float_info)
@anchor{library/sys sys float_info min_10_exp}@anchor{45b5}
@deffn {Atributo} float_info.min_10_exp
@end deffn

@tab

@code{DBL_MIN_10_EXP}

@tab

O inteiro mínimo `e' de tal modo que @code{10**e} é um ponto flutuante normalizado.

@item

@geindex radix (atributo sys.float_info)
@anchor{library/sys sys float_info radix}@anchor{45b6}
@deffn {Atributo} float_info.radix
@end deffn

@tab

@code{FLT_RADIX}

@tab

A raiz da representação do expoente.

@item

@geindex rounds (atributo sys.float_info)
@anchor{library/sys sys float_info rounds}@anchor{45b7}
@deffn {Atributo} float_info.rounds
@end deffn

@tab

@code{FLT_ROUNDS}

@tab

Um inteiro representando o modo de arredondamento para aritmética de ponto flutuante. Isso reflete o valor da macro do sistema @code{FLT_ROUNDS} no momento da inicialização do interpretador:


@itemize *

@item 
@code{-1}: indeterminável

@item 
@code{0}: em direção a zero

@item 
@code{1}: para o mais próximo

@item 
@code{2}: em direção ao infinito positivo

@item 
@code{3}: em direção ao infinito negativo
@end itemize

Todos os outros valores para @code{FLT_ROUNDS} caracterizam o comportamento de arredondamento definido pela implementação.

@end multitable


O atributo @ref{45ae,,sys.float_info.dig} precisa de mais explicações. Se @code{s} for qualquer string representando um número decimal com no máximo @code{sys.float_info.dig} dígitos significativos, então converter @code{s} para ponto flutuante e vice-versa recuperará uma string representando o mesmo decimal valor:

@example
>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # string decimal com 15 dígitos significativos
>>> format(float(s), '.15g')  # converter para float e desconverter retorna mesmo valor
'3.14159265358979'
@end example

Mas para strings com mais de @ref{45ae,,sys.float_info.dig} dígitos significativos, isso nem sempre é verdade:

@example
>>> s = '9876543211234567'    # 16 dígitos significativos é muito!
>>> format(float(s), '.16g')  # a conversão muda o valor
'9876543211234568'
@end example
@end deffn

@geindex float_repr_style (no módulo sys)
@anchor{library/sys sys float_repr_style}@anchor{133e}
@deffn {Dado} sys.float_repr_style

Uma string indicando como a função @ref{800,,repr()} se comporta para floats. Se a string tem valor @code{'short'} então para um ponto flutuante finito @code{x}, @code{repr(x)} visa produzir uma string curta com a propriedade que @code{float(repr(x)) == x}. Este é o comportamento usual no Python 3.1 e posterior. Caso contrário, @code{float_repr_style} tem valor @code{'legacy'} e @code{repr(x)} se comporta da mesma forma que nas versões do Python anteriores a 3.1.


Adicionado na versão 3.1.

@end deffn

@geindex getallocatedblocks() (no módulo sys)
@anchor{library/sys sys getallocatedblocks}@anchor{ffb}
@deffn {Função} sys.getallocatedblocks ()

Retorna a quantidade de blocos de memória alocados atualmente pelo interpretador, independentemente do tamanho. Esta função é útil principalmente ao acompanhar e depurar vazamentos de memória. Devido aos caches internos do interpretador, o resultado pode variar de chamada a chamada; você pode ter que chamar @ref{1766,,_clear_internal_caches()} e @ref{a43,,gc.collect()} para obter resultados mais previsíveis.

Se uma construção ou implementação do Python não puder computar razoavelmente essas informações, @ref{ffb,,getallocatedblocks()} poderá retornar 0 em seu lugar.


Adicionado na versão 3.4.

@end deffn

@geindex getunicodeinternedsize() (no módulo sys)
@anchor{library/sys sys getunicodeinternedsize}@anchor{45b8}
@deffn {Função} sys.getunicodeinternedsize ()

Retorna o número de objetos unicode que foram internalizados.


Adicionado na versão 3.12.

@end deffn

@geindex getandroidapilevel() (no módulo sys)
@anchor{library/sys sys getandroidapilevel}@anchor{ba2}
@deffn {Função} sys.getandroidapilevel ()

Retorna o nível de API de tempo de construção do Android como um inteiro. Isso representa a versão mínima do Android em que esta construção do Python pode ser executada. Para obter informações sobre a versão de tempo de execução, consulte @ref{173d,,platform.android_ver()}.

@ref{1ed8,,Disponibilidade}: Android.


Adicionado na versão 3.7.

@end deffn

@geindex getdefaultencoding() (no módulo sys)
@anchor{library/sys sys getdefaultencoding}@anchor{45b9}
@deffn {Função} sys.getdefaultencoding ()

Retorna @code{'utf-8'}. Este é o nome da codificação de string padrão, usada em métodos como @ref{8db,,str.encode()}.
@end deffn

@geindex getdlopenflags() (no módulo sys)
@anchor{library/sys sys getdlopenflags}@anchor{1557}
@deffn {Função} sys.getdlopenflags ()

Retorna o valor atual dos sinalizadores que são usados para chamadas @code{dlopen()}. Nomes simbólicos para os valores dos sinalizadores podem ser encontrados no módulo @ref{a1,,os} (constantes @code{RTLD_@var{xxx}}, por exemplo @ref{1157,,os.RTLD_LAZY}).

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex getfilesystemencoding() (no módulo sys)
@anchor{library/sys sys getfilesystemencoding}@anchor{c74}
@deffn {Função} sys.getfilesystemencoding ()

Obtém o @ref{53b,,codificação do sistema de arquivos}: a codificação usada com o @ref{53b,,manipulador de erros do sistema de arquivos} para converter entre nomes de arquivos Unicode e nomes de arquivos de bytes. O manipulador de erros do sistema de arquivos é retornado de @ref{d07,,getfilesystemencodeerrors()}.

Para melhor compatibilidade, str deve ser usado para nomes de arquivos em todos os casos, embora a representação de nomes de arquivos como bytes também seja suportada. As funções que aceitam ou retornam nomes de arquivo devem suportar str ou bytes e converter internamente para a representação preferencial do sistema.

@ref{c70,,os.fsencode()} e @ref{c6f,,os.fsdecode()} devem ser usados para garantir que a codificação correta e o modo de erros sejam usados.

O @ref{53b,,tratador de erros e codificação do sistema de arquivos} são configurados na inicialização do Python pela função @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} do @ref{3a6,,PyConfig}.


Alterado na versão 3.2: O resultado de @ref{c74,,getfilesystemencoding()} não pode mais ser @code{None}.



Alterado na versão 3.6: O Windows não tem mais garantia de retornar @code{'mbcs'}. Veja 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} e @ref{2ae,,_enablelegacywindowsfsencoding()} para mais informações.



Alterado na versão 3.7: Retorna @code{'utf-8'} se o @ref{656,,Modo UTF-8 do Python} estiver ativado.

@end deffn

@geindex getfilesystemencodeerrors() (no módulo sys)
@anchor{library/sys sys getfilesystemencodeerrors}@anchor{d07}
@deffn {Função} sys.getfilesystemencodeerrors ()

Obtém o @ref{53b,,manipulador de erros do sistema de arquivos}: o manipulador de erros usado com a @ref{53b,,codificação do sistema de arquivos} para converter entre nomes de arquivos Unicode e nomes de arquivos de bytes. A codificação do sistema de arquivos é retornado de @ref{c74,,getfilesystemencoding()}.

@ref{c70,,os.fsencode()} e @ref{c6f,,os.fsdecode()} devem ser usados para garantir que a codificação correta e o modo de erros sejam usados.

O @ref{53b,,tratador de erros e codificação do sistema de arquivos} são configurados na inicialização do Python pela função @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} do @ref{3a6,,PyConfig}.


Adicionado na versão 3.6.

@end deffn

@geindex get_int_max_str_digits() (no módulo sys)
@anchor{library/sys sys get_int_max_str_digits}@anchor{1614}
@deffn {Função} sys.get_int_max_str_digits ()

Retorna o valor atual para a @ref{5f5,,limitação de comprimento de string na conversão para inteiro}. Veja também @ref{18c5,,set_int_max_str_digits()}.


Adicionado na versão 3.11.

@end deffn

@geindex getrefcount() (no módulo sys)
@anchor{library/sys sys getrefcount}@anchor{45ba}
@deffn {Função} sys.getrefcount (object)

Retorna a contagem de referências do `object'. A contagem retornada é geralmente um valor maior do que o esperado, porque inclui a referência (temporária) passada como argumento para @ref{45ba,,getrefcount()}.

Observe que o valor retornado pode não refletir realmente quantas referências ao objeto são realmente mantidas. Por exemplo, alguns objetos são @ref{45bb,,imortais} e têm uma contagem de referências muito alta, que não reflete o número real de referências. Consequentemente, não confie no valor retornado para ser preciso, exceto um valor de 0 ou 1.


Alterado na versão 3.12: Objetos imortais têm contagens de referência muito grandes que não correspondem ao número real de referências ao objeto.

@end deffn

@geindex getrecursionlimit() (no módulo sys)
@anchor{library/sys sys getrecursionlimit}@anchor{4c4}
@deffn {Função} sys.getrecursionlimit ()

Retorna o valor atual do limite de recursão, a profundidade máxima da pilha do interpretador Python. Esse limite evita que a recursão infinita cause um estouro da pilha C e falhe o Python. Pode ser definido por @ref{4c3,,setrecursionlimit()}.
@end deffn

@geindex getsizeof() (no módulo sys)
@anchor{library/sys sys getsizeof}@anchor{1863}
@deffn {Função} sys.getsizeof (object[, default])

Retorna o tamanho de um objeto em bytes. O objeto pode ser qualquer tipo de objeto. Todos os objetos embutidos retornarão resultados corretos, mas isso não precisa ser verdadeiro para extensões de terceiros, pois é específico da implementação.

Apenas o consumo de memória diretamente atribuído ao objeto é contabilizado, não o consumo de memória dos objetos a que ele se refere.

Se fornecido, `default' será retornado se o objeto não fornecer meios para recuperar o tamanho. Caso contrário, uma exceção @ref{2c3,,TypeError} será levantada.

@ref{1863,,getsizeof()} chama o método @code{__sizeof__} do objeto e adiciona uma sobrecarga adicional do coletor de lixo se o objeto for gerenciado pelo coletor de lixo.

Consulte receita de tamanho recursivo@footnote{https://code.activestate.com/recipes/577504-compute-memory-footprint-of-an-object-and-its-cont/} para obter um exemplo de uso de @ref{1863,,getsizeof()} recursivamente para encontrar o tamanho dos contêineres e todo o seu conteúdo.
@end deffn

@geindex getswitchinterval() (no módulo sys)
@anchor{library/sys sys getswitchinterval}@anchor{950}
@deffn {Função} sys.getswitchinterval ()

Retorna o “intervalo de troca de thread” do interpretador em segundos; veja @ref{951,,setswitchinterval()}.


Adicionado na versão 3.2.

@end deffn

@geindex _getframe() (no módulo sys)
@anchor{library/sys sys _getframe}@anchor{6e1}
@deffn {Função} sys._getframe ([depth])

Retorna um objeto quadro da pilha de chamadas. Se o inteiro opcional `depth' for fornecido, retorna o objeto de quadro que muitos chamam abaixo do topo da pilha. Se for mais profundo do que a pilha de chamadas, @ref{202,,ValueError} é levantada. O padrão para `depth' é zero, retornando o quadro no topo da pilha de chamadas.

Levanta um @ref{19fa,,evento de auditoria} @code{sys._getframe} com o argumento @code{frame}.

Esta função deve ser usada apenas para fins internos e especializados. Não é garantido que exista em todas as implementações do Python.
@end deffn

@geindex _getframemodulename() (no módulo sys)
@anchor{library/sys sys _getframemodulename}@anchor{1867}
@deffn {Função} sys._getframemodulename ([depth])

Retorna o nome de um módulo da pilha de chamadas. Se o inteiro opcional `depth' for fornecido, retorna o módulo que muitas chamadas abaixo do topo da pilha. Se for mais profundo do que a pilha de chamadas, ou se o módulo não for identificável, @code{None} é retornado. O padrão para `depth' é zero, retornando o módulo no topo da pilha de chamadas.

Levanta um @ref{19fa,,evento de auditoria} @code{sys._getframemodulename} com o argumento @code{depth}.

Esta função deve ser usada apenas para fins internos e especializados. Não é garantido que exista em todas as implementações do Python.


Adicionado na versão 3.12.

@end deffn

@geindex getobjects() (no módulo sys)
@anchor{library/sys sys getobjects}@anchor{427}
@deffn {Função} sys.getobjects (limit[, type])

Esta função só existe se o CPython foi construído usando a opção de configuração especializada @ref{395,,--with-trace-refs}. Ela é destinada apenas para depurar problemas de coleta de lixo.

Retorna uma lista de até `limit' objetos Python alocados dinamicamente. Se `type' for fornecido, somente objetos daquele tipo exato (não subtipos) serão incluídos.

Objetos da lista não são seguros para uso. Especificamente, o resultado incluirá objetos de todos os interpretadores que compartilham seu estado de alocador de objetos (ou seja, aqueles criados com @ref{45bc,,PyInterpreterConfig.use_main_obmalloc} definido como 1 ou usando @ref{18b9,,Py_NewInterpreter()} e o @ref{587,,interpretador principal}). Misturar objetos de diferentes iinterpretadores pode levar a travamentos ou outros comportamentos inesperados.

Esta função deve ser usada apenas para fins especializados. Não é garantido que exista em todas as implementações do Python.


Alterado na versão 3.13.1: O resultado pode incluir objetos de outros interpretadores.

@end deffn

@geindex getprofile() (no módulo sys)
@anchor{library/sys sys getprofile}@anchor{1427}
@deffn {Função} sys.getprofile ()

@geindex função de perfilação
@geindex perfilador

Obtém a função do criador de perfil conforme definido por @ref{1546,,setprofile()}.
@end deffn

@geindex gettrace() (no módulo sys)
@anchor{library/sys sys gettrace}@anchor{1428}
@deffn {Função} sys.gettrace ()

@geindex função de rastreamento
@geindex depurador

Obtém a função trace conforme definido por @ref{1547,,settrace()}.

A função @ref{1428,,gettrace()} destina-se apenas à implementação de depuradores, perfiladores, ferramentas de cobertura e similares. Seu comportamento faz parte da plataforma de implementação, e não da definição da linguagem e, portanto, pode não estar disponível em todas as implementações do Python.
@end deffn

@geindex getwindowsversion() (no módulo sys)
@anchor{library/sys sys getwindowsversion}@anchor{d08}
@deffn {Função} sys.getwindowsversion ()

Retorna uma tupla nomeada que descreve a versão do Windows em execução no momento. Os elementos nomeados são `major', `minor', `build', `platform', `service_pack', `service_pack_minor', `service_pack_major', `suite_mask', `product_type' e `platform_version'. `service_pack' contém uma string, `platform_version' uma tupla de 3 elementos e todos os outros valores são inteiros. Os componentes também podem ser acessados pelo nome, então @code{sys.getwindowsversion()[0]} é equivalente a @code{sys.getwindowsversion().major}. Para compatibilidade com versões anteriores, apenas os primeiros 5 elementos são recuperáveis por indexação.

`platform' será @code{2} (VER_PLATFORM_WIN32_NT).

`product_type' pode ser um dos seguintes valores:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Significado

@item

@code{1} (VER_NT_WORKSTATION)

@tab

O sistema é uma estação de trabalho

@item

@code{2} (VER_NT_DOMAIN_CONTROLLER)

@tab

O sistema é um controlador de domínio.

@item

@code{3} (VER_NT_SERVER)

@tab

O sistema é um servidor, mas não um controlador de domínio.

@end multitable


Esta função atua como um envólucro em volta da função Win32 @code{GetVersionEx()}; consulte a documentação da Microsoft em @code{OSVERSIONINFOEX()} para obter mais informações sobre esses campos.

`platform_version' retorna a versão principal, a versão secundária e o número de compilação do sistema operacional atual, em vez da versão que está sendo emulada para o processo. Destina-se a ser usado no registro, e não na detecção de recursos.

@cartouche
@quotation Nota 
`platform_version' deriva a versão de kernel32.dll que pode ser de uma versão diferente da versão do sistema operacional. Use o módulo @ref{aa,,platform} para obter a versão precisa do sistema operacional.
@end quotation
@end cartouche

@ref{1ed8,,Disponibilidade}: Windows.


Alterado na versão 3.2: Alterado para uma tupla nomeada e adicionado `service_pack_minor', `service_pack_major', `suite_mask' e `product_type'.



Alterado na versão 3.6: Adicionado `platform_version'

@end deffn

@geindex get_asyncgen_hooks() (no módulo sys)
@anchor{library/sys sys get_asyncgen_hooks}@anchor{194e}
@deffn {Função} sys.get_asyncgen_hooks ()

Retorna um objeto `asyncgen_hooks', que é semelhante a um @ref{1ca,,namedtuple} no formato @code{(firstiter, finalizer)}, onde `firstiter' e `finalizer' devem ser @code{None} ou funções que recebem um @ref{45bd,,iterador gerador assíncrono} como argumento e são usadas para agendar a finalização de um gerador assíncrono por um laço de eventos.


Adicionado na versão 3.6: Veja 
@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} para mais detalhes.


@cartouche
@quotation Nota 
Esta função foi adicionada provisoriamente (veja 
@geindex Propostas de Melhorias do Python; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para detalhes.)
@end quotation
@end cartouche
@end deffn

@geindex get_coroutine_origin_tracking_depth() (no módulo sys)
@anchor{library/sys sys get_coroutine_origin_tracking_depth}@anchor{ba3}
@deffn {Função} sys.get_coroutine_origin_tracking_depth ()

Obtém a profundidade de rastreamento da origem da corrotina atual, conforme definido por @ref{ba4,,set_coroutine_origin_tracking_depth()}.


Adicionado na versão 3.7.


@cartouche
@quotation Nota 
Esta função foi adicionada provisoriamente (veja 
@geindex Propostas de Melhorias do Python; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para detalhes.) Use-a apenas para propósitos de depuração.
@end quotation
@end cartouche
@end deffn

@geindex hash_info (no módulo sys)
@anchor{library/sys sys hash_info}@anchor{1035}
@deffn {Dado} sys.hash_info

Uma @ref{64e,,tupla nomeada} fornecendo parâmetros da implementação de hash numérico. Para mais detalhes sobre hashing de tipos numéricos, veja @ref{2335,,Hashing de tipos numéricos}.

@geindex width (atributo sys.hash_info)
@anchor{library/sys sys hash_info width}@anchor{45be}
@deffn {Atributo} hash_info.width

A largura em bits usada para fazer hash de valores
@end deffn

@geindex modulus (atributo sys.hash_info)
@anchor{library/sys sys hash_info modulus}@anchor{2336}
@deffn {Atributo} hash_info.modulus

O módulo primo P usado para esquema de hash numérico
@end deffn

@geindex inf (atributo sys.hash_info)
@anchor{library/sys sys hash_info inf}@anchor{45bf}
@deffn {Atributo} hash_info.inf

O valor de hash retornado para um infinito positivo
@end deffn

@geindex nan (atributo sys.hash_info)
@anchor{library/sys sys hash_info nan}@anchor{45c0}
@deffn {Atributo} hash_info.nan

(Este atributo não é mais usado)
@end deffn

@geindex imag (atributo sys.hash_info)
@anchor{library/sys sys hash_info imag}@anchor{45c1}
@deffn {Atributo} hash_info.imag

O multiplicador usado para a parte imaginária de um número complexo
@end deffn

@geindex algorithm (atributo sys.hash_info)
@anchor{library/sys sys hash_info algorithm}@anchor{45c2}
@deffn {Atributo} hash_info.algorithm

O nome do algoritmo para hash de str, bytes e memoryview
@end deffn

@geindex hash_bits (atributo sys.hash_info)
@anchor{library/sys sys hash_info hash_bits}@anchor{45c3}
@deffn {Atributo} hash_info.hash_bits

O tamanho da saída interna do algoritmo de hash
@end deffn

@geindex seed_bits (atributo sys.hash_info)
@anchor{library/sys sys hash_info seed_bits}@anchor{45c4}
@deffn {Atributo} hash_info.seed_bits

O tamanho da chave semente do algoritmo hash
@end deffn

@geindex cutoff (atributo sys.hash_info)
@anchor{library/sys sys hash_info cutoff}@anchor{45c5}
@deffn {Atributo} hash_info.cutoff

Limite para otimização de strings pequenas DJBX33A no intervalo @code{[1, cutoff)}.
@end deffn


Adicionado na versão 3.2.



Alterado na versão 3.4: Adicionados `algorithm', `hash_bits', `seed_bits' e `cutoff'.

@end deffn

@geindex hexversion (no módulo sys)
@anchor{library/sys sys hexversion}@anchor{45c6}
@deffn {Dado} sys.hexversion

O número da versão codificado como um único inteiro. Isso é garantido para aumentar com cada versão, incluindo suporte adequado para lançamentos de não produção. Por exemplo, para testar se o interpretador Python é pelo menos a versão 1.5.2, use:

@example
if sys.hexversion >= 0x010502F0:
    # usa algum recurso avançado
    ...
else:
    # usa uma implementação alternativa ou adverte o usuário
    ...
@end example

Isso é chamado @code{hexversion} já que só parece realmente significativo quando visto como o resultado de passá-lo para a função embutida @ref{1312,,hex()}. A @ref{64e,,tupla nomeada} @ref{6a0,,sys.version_info} pode ser usada para uma codificação mais amigável das mesmas informações.

Mais detalhes sobre @code{hexversion} podem ser encontrados em @ref{45c7,,API e Versionamento de ABI}.
@end deffn

@geindex implementation (no módulo sys)
@anchor{library/sys sys implementation}@anchor{517}
@deffn {Dado} sys.implementation

Um objeto que contém informações sobre a implementação do interpretador Python em execução no momento. Os atributos a seguir devem existir em todas as implementações do Python.

`name' é o identificador da implementação, por exemplo @code{'cpython'}. A string real é definida pela implementação do Python, mas é garantido que seja minúscula.

`version' é uma tupla nomeada, no mesmo formato que @ref{6a0,,sys.version_info}. Ela representa a versão da implementação Python em `implementation'. Isso tem um significado distinto da versão específica da `linguagem' Python à qual o interpretador em execução no momento está em conformidade, que @code{sys.version_info} representa. Por exemplo, para PyPy 1.8 @code{sys.implementation.version} pode ser @code{sys.version_info(1, 8, 0, 'final', 0)}, enquanto @code{sys.version_info} seria @code{sys.version_info(2, 7, 2, 'final', 0)}. Para CPython, eles são o mesmo valor, pois é a implementação de referência.

`hexversion' é a versão de implementação em formato hexadecimal, como @ref{45c6,,sys.hexversion}.

`cache_tag' é a tag usada pelo mecanismo de importação nos nomes de arquivo dos módulos em cache. Por convenção, seria um composto do nome e da versão da implementação, como @code{'cpython-33'}. No entanto, uma implementação Python pode usar algum outro valor, se apropriado. Se @code{cache_tag} for definido como @code{None}, isso indica que o cache do módulo deve ser desabilitado.

@ref{517,,sys.implementation} pode conter atributos adicionais específicos para a implementação do Python. Esses atributos não padrão devem começar com um sublinhado e não são descritos aqui. Independentemente do seu conteúdo, @ref{517,,sys.implementation} não mudará durante uma execução do interpretador, nem entre versões de implementação. (No entanto, ele pode mudar entre versões da linguagem Python.) Veja a 
@geindex Propostas de Melhorias do Python; PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/} para mais informações.


Adicionado na versão 3.3.


@cartouche
@quotation Nota 
A adição de novos atributos obrigatórios deve passar pelo processo normal de PEPs. Veja a 
@geindex Propostas de Melhorias do Python; PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/} para mais informações.
@end quotation
@end cartouche
@end deffn

@geindex int_info (no módulo sys)
@anchor{library/sys sys int_info}@anchor{12d5}
@deffn {Dado} sys.int_info

Uma @ref{64e,,tupla nomeada} que contém informações sobre a representação interna de inteiros do Python. Os atributos são somente leitura.

@geindex bits_per_digit (atributo sys.int_info)
@anchor{library/sys sys int_info bits_per_digit}@anchor{45c8}
@deffn {Atributo} int_info.bits_per_digit

O número de bits mantidos em cada dígito. Os inteiros do Python são armazenados internamente na base @code{2**int_info.bits_per_digit}.
@end deffn

@geindex sizeof_digit (atributo sys.int_info)
@anchor{library/sys sys int_info sizeof_digit}@anchor{45c9}
@deffn {Atributo} int_info.sizeof_digit

O tamanho em bytes do tipo C usado para representar um dígito.
@end deffn

@geindex default_max_str_digits (atributo sys.int_info)
@anchor{library/sys sys int_info default_max_str_digits}@anchor{2411}
@deffn {Atributo} int_info.default_max_str_digits

O valor padrão para @ref{1614,,sys.get_int_max_str_digits()} quando não estiver explicitamente configurado.
@end deffn

@geindex str_digits_check_threshold (atributo sys.int_info)
@anchor{library/sys sys int_info str_digits_check_threshold}@anchor{45ca}
@deffn {Atributo} int_info.str_digits_check_threshold

O valor mínimo diferente de zero para @ref{18c5,,sys.set_int_max_str_digits()}, 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,PYTHONINTMAXSTRDIGITS} ou @ref{176,,-X int_max_str_digits}.
@end deffn


Adicionado na versão 3.1.



Alterado na versão 3.11: Adicionados @ref{2411,,default_max_str_digits} e @ref{45ca,,str_digits_check_threshold}.

@end deffn

@geindex __interactivehook__ (no módulo sys)
@anchor{library/sys sys __interactivehook__}@anchor{ffd}
@deffn {Dado} sys.__interactivehook__

Quando esse atributo existe, seu valor é chamado automaticamente (sem argumentos) quando o interpretador é iniciado em @ref{ffc,,modo interativo}. Isso é feito após o arquivo 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP} ser lido, para que você possa definir esse gancho lá. O módulo @ref{c7,,site} @ref{fff,,define isso}.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.run_interactivehook} com o objeto gancho como o argumento quando o gancho é chamado na inicialização.


Adicionado na versão 3.4.

@end deffn

@geindex intern() (no módulo sys)
@anchor{library/sys sys intern}@anchor{131e}
@deffn {Função} sys.intern (string)

Insere `string' na tabela de strings “internalizadas” e retorna a string internalizada – que é a própria `string' ou uma cópia. Strings internalizadas são úteis para obter um pouco de desempenho na pesquisa de dicionário – se as chaves em um dicionário foram internalizadas, e a chave de pesquisa para internalizada, já que comparações de chaves (após o hash) podem ser feitas por uma comparação de ponteiros em vez de uma comparação de strings. Normalmente, os nomes usados em programas Python são internalizados automaticamente, e os dicionários usados para armazenar atributos de módulo, classe ou instância têm chaves internalizadas.

Strings internalizadas não são @ref{45bb,,imortais}; você deve manter uma referência ao valor de retorno de @ref{131e,,intern()} para se beneficiar dela.
@end deffn

@geindex _is_gil_enabled() (no módulo sys)
@anchor{library/sys sys _is_gil_enabled}@anchor{45cb}
@deffn {Função} sys._is_gil_enabled ()

Retorna @ref{c27,,True} se a @ref{159,,GIL} estiver habiltada e @ref{b49,,False} caso contrário.


Adicionado na versão 3.13.


Não há garantia de que exista em todas as implementações do Python.
@end deffn

@geindex is_finalizing() (no módulo sys)
@anchor{library/sys sys is_finalizing}@anchor{a99}
@deffn {Função} sys.is_finalizing ()

Retorna @ref{c27,,True} se o interpretador Python principal estiver @ref{14e,,desligando}. Retorna @ref{b49,,False} caso contrário.

Veja também a exceção @ref{14d,,PythonFinalizationError}.


Adicionado na versão 3.5.

@end deffn

@geindex last_exc (no módulo sys)
@anchor{library/sys sys last_exc}@anchor{4be}
@deffn {Dado} sys.last_exc

Esta variável nem sempre está definida; ela é definida para a instância de exceção quando uma exceção não é tratada e o interpretador imprime uma mensagem de erro e um stack traceback. Seu uso pretendido é permitir que um usuário interativo importe um módulo depurador e se envolva na depuração post-mortem sem ter que reexecutar o comando que causou o erro. (O uso típico é @code{import pdb; pdb.pm()} para entrar no depurador post-mortem; veja o módulo @ref{a5,,pdb} para mais informações.)


Adicionado na versão 3.12.

@end deffn

@geindex _is_interned() (no módulo sys)
@anchor{library/sys sys _is_interned}@anchor{250}
@deffn {Função} sys._is_interned (string)

Retorna @ref{c27,,True} se a string fornecida for “internalizada”, @ref{b49,,False} caso contrário.


Adicionado na versão 3.13.


Não há garantia de que exista em todas as implementações do Python.
@end deffn

@geindex last_type (no módulo sys)
@geindex last_value (no módulo sys)
@geindex last_traceback (no módulo sys)
@anchor{library/sys sys last_type}@anchor{4bf}
@deffn {Dado} sys.last_type
@anchor{library/sys sys last_value}@anchor{4c0}
@deffnx {Dado} sys.last_value
@anchor{library/sys sys last_traceback}@anchor{4c1}
@deffnx {Dado} sys.last_traceback

Essas três variáveis estão descontinuadas; use @ref{4be,,sys.last_exc} em vez disso. Elas mantêm a representação legada de @code{sys.last_exc}, conforme retornada de @ref{68a,,exc_info()} acima.
@end deffn

@geindex maxsize (no módulo sys)
@anchor{library/sys sys maxsize}@anchor{1205}
@deffn {Dado} sys.maxsize

Um inteiro que fornece o valor máximo que uma variável do tipo @ref{a69,,Py_ssize_t} pode assumir. Geralmente é @code{2**31 - 1} em uma plataforma de 32 bits e @code{2**63 - 1} em uma plataforma de 64 bits.
@end deffn

@geindex maxunicode (no módulo sys)
@anchor{library/sys sys maxunicode}@anchor{1085}
@deffn {Dado} sys.maxunicode

Um inteiro que fornece o valor do maior ponto de código Unicode, ou seja, @code{1114111} (@code{0x10FFFF} em hexadecimal).


Alterado na versão 3.3: Antes da 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}, @code{sys.maxunicode} costumava ser @code{0xFFFF} ou @code{0x10FFFF}, dependendo da opção de configuração que especificava se os caracteres Unicode eram armazenados como UCS-2 ou UCS-4.

@end deffn

@geindex meta_path (no módulo sys)
@anchor{library/sys sys meta_path}@anchor{d4d}
@deffn {Dado} sys.meta_path

Uma lista de objetos @ref{10a9,,localizadores de metacaminho} que têm seus métodos @ref{86c,,find_spec()} chamados para que algum deles localize o módulo a ser importado. Por padrão, armazena entradas que implementam a semântica de importação padrão de Python. O método @ref{86c,,find_spec()} é chamado com pelo menos o nome absoluto do módulo a ser importado. Se o módulo a ser importado estiver contido num pacote, o atributo @ref{1df4,,__path__} do pacote pai é passado como segundo argumento. O método retorna um @ref{20a6,,spec de módulo}, ou @code{None} se o módulo não for encontrado.


@subsubheading Ver também



@table @asis

@item @ref{872,,importlib.abc.MetaPathFinder}

A classe base abstrata que define a interface dos objetos localizadores em @ref{d4d,,meta_path}.

@item @ref{1fee,,importlib.machinery.ModuleSpec}

A classe concreta da qual @ref{86c,,find_spec()} deve retornar instâncias.
@end table



Alterado na versão 3.4: @ref{20a6,,Especificações de módulo} foram introduzidas no Python 3.4, pela 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}.



Alterado na versão 3.12: Foi removido o alternativa que procurava um método @code{find_module()} se uma entrada @ref{d4d,,meta_path} não tivesse um método @ref{86c,,find_spec()}.

@end deffn

@geindex modules (no módulo sys)
@anchor{library/sys sys modules}@anchor{1636}
@deffn {Dado} sys.modules

Este é um dicionário que mapeia nomes de módulos para módulos que já foram carregados. Isso pode ser manipulado para forçar o recarregamento de módulos e outros truques. No entanto, substituir o dicionário não vai funcionar necessariamente como esperado e excluir itens essenciais do dicionário pode fazer com que o Python falhe. Se você quiser iterar sobre este dicionário global, sempre use @code{sys.modules.copy()} ou @code{tuple(sys.modules)} para evitar exceções, pois seu tamanho pode mudar durante a iteração como um efeito colateral do código ou atividade em outros threads.
@end deffn

@geindex orig_argv (no módulo sys)
@anchor{library/sys sys orig_argv}@anchor{843}
@deffn {Dado} sys.orig_argv

A lista dos argumentos originais da linha de comando passados para o executável Python.

Os elementos de @ref{843,,sys.orig_argv} são os argumentos para o interpretador Python, enquanto os elementos de @ref{12a6,,sys.argv} são os argumentos para o programa do usuário. Os argumentos consumidos pelo próprio interpretador estarão presentes em @ref{843,,sys.orig_argv} e ausentes em @ref{12a6,,sys.argv}.


Adicionado na versão 3.10.

@end deffn

@geindex path (no módulo sys)
@anchor{library/sys sys path}@anchor{3b4}
@deffn {Dado} sys.path

@geindex módulo;pesquisa;caminho

Uma lista de strings que especifica o caminho de pesquisa para módulos. Inicializado a partir da variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}, mais um padrão dependente da instalação.

Por padrão, conforme inicializado na inicialização do programa, um caminho potencialmente inseguro é adicionado ao @ref{3b4,,sys.path} (`antes' das entradas inseridas como resultado de 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}):


@itemize *

@item 
A linha de comando @code{python -m módulo}: adiciona o diretório de trabalho atual

@item 
A linha de comando @code{python script.py}: prefixa o diretório do script. Se for um link simbólico, resolve links simbólicos.

@item 
As linhas de comando @code{python -c código} e @code{python} (REPL): adiciona uma string vazia, que indica o diretório de trabalho atual.
@end itemize

Para não acrescentar esse caminho potencialmente inseguro, use a opção de linha de comando @ref{5a4,,-P} ou a variável de ambiente 
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH}.

Um programa é livre para modificar esta lista para seus próprios propósitos. Somente strings devem ser adicionadas a @ref{3b4,,sys.path}; todos os outros tipos de dados são ignorados durante a importação.


@subsubheading Ver também



@itemize *

@item 
Módulo @ref{c7,,site} Descreve como usar arquivos .pth para estender @ref{3b4,,sys.path}.
@end itemize

@end deffn

@geindex path_hooks (no módulo sys)
@anchor{library/sys sys path_hooks}@anchor{105a}
@deffn {Dado} sys.path_hooks

Uma lista de chamáveis que recebem um argumento de caminho para tentar criar um @ref{20ae,,localizador} para o caminho. Se um localizador puder ser criado, ele deve ser retornado pelo chamável, senão, ele levanta @ref{419,,ImportError}.

Originalmente especificado na 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.
@end deffn

@geindex path_importer_cache (no módulo sys)
@anchor{library/sys sys path_importer_cache}@anchor{5e4}
@deffn {Dado} sys.path_importer_cache

Um dicionário atuando como um cache para objetos do @ref{20ae,,localizador}. As chaves são caminhos que foram passados para @ref{105a,,sys.path_hooks} e os valores são os localizadores que são encontrados. Se um caminho for um caminho de sistema de arquivo válido, mas nenhum localizador for encontrado em @ref{105a,,sys.path_hooks}, então @code{None} é armazenado.

Originalmente especificado na 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.
@end deffn

@geindex platform (no módulo sys)
@anchor{library/sys sys platform}@anchor{a97}
@deffn {Dado} sys.platform

Uma string contendo um identificador da plataforma. Valores conhecidos são:


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sistema

@tab

Valor de @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


Em sistemas Unix não listados na tabela, o valor é o nome do sistema operacional em letras minúsculas, conforme retornado por @code{uname -s}, com a primeira parte da versão, conforme retornado por @code{uname -r} anexada, por exemplo, @code{'sunos5'} ou @code{'freebsd8'}, `no momento em que o Python foi construído'. A menos que você queira testar uma versão específica do sistema, é recomendável usar o seguinte idioma:

@example
if sys.platform.startswith('freebsd'):
    # Código para FreeBSD aqui...
@end example


Alterado na versão 3.3: No Linux, @ref{a97,,sys.platform} não contém mais a versão principal. É sempre @code{'linux'}, em vez de @code{'linux2'} ou @code{'linux3'}.



Alterado na versão 3.8: No AIX, @ref{a97,,sys.platform} não contém mais a versão principal. É sempre @code{'aix'}, em vez de @code{'aix5'} ou @code{'aix7'}.



Alterado na versão 3.13: No Android, @ref{a97,,sys.platform} agora retorna @code{'android'} em vez de @code{'linux'}.



@subsubheading Ver também


@ref{2ce3,,os.name} tem uma granularidade mais substancial. @ref{1155,,os.uname()} fornece informações de versão dependentes do sistema.

O módulo @ref{aa,,platform} fornece verificações detalhadas sobre a identificação do sistema.

@end deffn

@geindex platlibdir (no módulo sys)
@anchor{library/sys sys platlibdir}@anchor{93f}
@deffn {Dado} sys.platlibdir

Nome do diretório da biblioteca específica da plataforma. É usado para construir o caminho da biblioteca padrão e os caminhos dos módulos de extensão instalados.

É igual a @code{"lib"} na maioria das plataformas. No Fedora e SuSE, é igual a @code{"lib64"} em plataformas de 64 bits, o que fornece os seguintes caminhos @code{sys.path} (onde @code{X.Y} é a versão @code{major.minor} do Python):


@itemize *

@item 
@code{/usr/lib64/pythonX.Y/}: Biblioteca padrão (como @code{os.py} do módulo @ref{a1,,os})

@item 
@code{/usr/lib64/pythonX.Y/lib-dynload/}: Módulos de extensão C da biblioteca padrão (como o módulo @ref{57,,errno}, o nome exato do arquivo é específico da plataforma)

@item 
@code{/usr/lib/pythonX.Y/site-packages/} (sempre usa @code{lib}, não @ref{93f,,sys.platlibdir}): Módulos de terceiros

@item 
@code{/usr/lib64/pythonX.Y/site-packages/}: Módulos de extensão C de pacotes de terceiros
@end itemize


Adicionado na versão 3.9.

@end deffn

@geindex prefix (no módulo sys)
@anchor{library/sys sys prefix}@anchor{3b6}
@deffn {Dado} sys.prefix

Uma string que fornece o prefixo do diretório específico do site onde os arquivos Python independentes de plataforma são instalados; no Unix, o padrão é @code{/usr/local}. Isso pode ser definido no momento da construção com o argumento @ref{1ee7,,--prefix} para o script @code{configure}. Veja @ref{68f,,Caminhos de instalação} para caminhos derivados.

@cartouche
@quotation Nota 
Se um @ref{4557,,ambiente virtual} estiver em vigor, este valor será alterado em @code{site.py} para apontar para o ambiente virtual. O valor para a instalação do Python ainda estará disponível, via @ref{3ef,,base_prefix}.
@end quotation
@end cartouche
@end deffn

@geindex ps1 (no módulo sys)
@geindex ps2 (no módulo sys)
@anchor{library/sys sys ps1}@anchor{1ecd}
@deffn {Dado} sys.ps1
@anchor{library/sys sys ps2}@anchor{1ece}
@deffnx {Dado} sys.ps2

@geindex prompts do interpretador
@geindex interpretador@comma{} prompts
@geindex >>>;prompt do interpretador
@geindex ...;prompt do interpretador

Strings especificando o prompt primário e secundário do interpretador. Elas são definidas somente se o interpretador estiver no modo interativo. Seus valores iniciais neste caso são @code{'>>> '} e @code{'... '}. Se um objeto não string for atribuído a qualquer variável, seu @ref{44c,,str()} é reavaliado cada vez que o interpretador se prepara para ler um novo comando interativo; isso pode ser usado para implementar um prompt dinâmico.
@end deffn

@geindex setdlopenflags() (no módulo sys)
@anchor{library/sys sys setdlopenflags}@anchor{115e}
@deffn {Função} sys.setdlopenflags (n)

Define os sinalizadores usados pelo interpretador para chamadas @code{dlopen()}, como quando o interpretador carrega módulos de extensão. Entre outras coisas, isso habilitará uma resolução preguiçosa de símbolos ao importar um módulo, se chamado como @code{sys.setdlopenflags(0)}. Para compartilhar símbolos entre módulos de extensão, chame como @code{sys.setdlopenflags(os.RTLD_GLOBAL)}. Nomes simbólicos para os valores de sinalizadores podem ser encontrados no módulo @ref{a1,,os} (constantes @code{RTLD_@var{xxx}}, por exemplo, @ref{1157,,os.RTLD_LAZY}).

@ref{1ed8,,Disponibilidade}: Unix.
@end deffn

@geindex set_int_max_str_digits() (no módulo sys)
@anchor{library/sys sys set_int_max_str_digits}@anchor{18c5}
@deffn {Função} sys.set_int_max_str_digits (maxdigits)

Define a @ref{5f5,,limitação de comprimento de string na conversão para inteiro} usada por este interpretador. Veja também @ref{1614,,get_int_max_str_digits()}.


Adicionado na versão 3.11.

@end deffn

@geindex setprofile() (no módulo sys)
@anchor{library/sys sys setprofile}@anchor{1546}
@deffn {Função} sys.setprofile (profilefunc)

@geindex função de perfilação
@geindex perfilador

Define a função de perfil do sistema, que permite implementar um perfilador de código-fonte Python em Python. Veja o capítulo @ref{449b,,Os Profilers do Python} para mais informações sobre o perfilador Python. A função de perfil do sistema é chamada de forma semelhante à função de rastreamento do sistema (veja @ref{1547,,settrace()}), mas é chamada com eventos diferentes, por exemplo, não é chamada para cada linha de código executada (apenas na chamada e retorno, mas o evento de retorno é relatado mesmo quando uma exceção foi definida). A função é específica do thread, mas não há como o perfilador saber sobre trocas de contexto entre threads, então não faz sentido usá-la na presença de vários threads. Além disso, seu valor de retorno não é usado, então ele pode simplesmente retornar @code{None}. Um erro na função de perfil fará com que sua própria definição seja removida.

@cartouche
@quotation Nota 
O mesmo mecanismo de rastreamento é usado para @code{setprofile()} como @ref{1547,,settrace()}. Para rastrear chamadas com @code{setprofile()} dentro de uma função de rastreamento (por exemplo, em um ponto de interrupção do depurador), consulte @ref{194d,,call_tracing()}.
@end quotation
@end cartouche

As funções de perfil devem ter três argumentos: `frame', `event' e `arg'. `frame' é o quadro de pilha atual. `event' é uma string: @code{'call'}, @code{'return'}, @code{'c_call'}, @code{'c_return'} ou @code{'c_exception'}. `arg' depende do tipo de evento.

Os eventos têm o seguinte significado:


@table @asis

@item @code{'call'}

Uma função é chamada (ou algum outro bloco de código é inserido). A função de perfil é chamada; `arg' é @code{None}.

@item @code{'return'}

Uma função (ou outro bloco de código) está prestes a retornar. A função de perfilação é chamada; `arg' é o valor que será retornado, ou @code{None} se o evento for causado por uma exceção sendo levantada.

@item @code{'c_call'}

Uma função C está prestes a ser chamada. Pode ser uma função de extensão ou uma embutida. `arg' é o objeto da função C.

@item @code{'c_return'}

Uma função C foi retornada. `arg' é o objeto da função C.

@item @code{'c_exception'}

Uma função C levantou uma exceção. `arg' é o objeto da função C.
@end table

Levanta um @ref{19fa,,evento de auditoria} @code{sys.setprofile} sem argumentos.
@end deffn

@geindex setrecursionlimit() (no módulo sys)
@anchor{library/sys sys setrecursionlimit}@anchor{4c3}
@deffn {Função} sys.setrecursionlimit (limit)

Define a profundidade máxima da pilha do interpretador Python para `limit'. Esse limite impede que a recursão infinita cause um estouro da pilha C e trave o Python.

O limite mais alto possível depende da plataforma. Um usuário pode precisar definir o limite mais alto quando tiver um programa que exija recursão profunda e uma plataforma que dê suporte a um limite mais alto. Isso deve ser feito com cuidado, porque um limite muito alto pode levar a uma falha.

Se o novo limite for muito baixo na profundidade de recursão atual, uma exceção @ref{d90,,RecursionError} será levantada.


Alterado na versão 3.5.1: Uma exceção @ref{d90,,RecursionError} agora é levantada se o novo limite for muito baixo na profundidade de recursão atual.

@end deffn

@geindex setswitchinterval() (no módulo sys)
@anchor{library/sys sys setswitchinterval}@anchor{951}
@deffn {Função} sys.setswitchinterval (interval)

Define o intervalo de troca de thread do interpretador (em segundos). Este valor de ponto flutuante determina a duração ideal das “fatias de tempo” alocadas para threads Python em execução simultânea. Observe que o valor real pode ser maior, especialmente se funções ou métodos internos de execução longa forem usados. Além disso, qual thread se torna agendada no final do intervalo é uma decisão do sistema operacional. O interpretador não tem seu próprio escalonador.


Adicionado na versão 3.2.

@end deffn

@geindex settrace() (no módulo sys)
@anchor{library/sys sys settrace}@anchor{1547}
@deffn {Função} sys.settrace (tracefunc)

@geindex função de rastreamento
@geindex depurador

Define a função trace do sistema, que permite que você implemente um depurador de código-fonte Python em Python. A função é específica de thread; para um depurador suportar múltiplas threads, ele deve registrar uma função trace usando @ref{1547,,settrace()} para cada thread que está sendo depurada ou usar @ref{84b,,threading.settrace()}.

As funções de rastreamento devem ter três argumentos: `frame', `event' e `arg'. `frame' é o @ref{6e0,,quadro de pilha atual}. `event' é uma string: @code{'call'}, @code{'line'}, @code{'return'}, @code{'exception'} ou @code{'opcode'}. `arg' depende do tipo de evento.

A função de rastreamento é invocada (com `event' definido como @code{'call'}) sempre que um novo escopo local é inserido; ela deve retornar uma referência a uma função de rastreamento local a ser usada para o novo escopo, ou @code{None} se o escopo não deve ser rastreado.

A função de rastreamento local deve retornar uma referência a si mesma ou a outra função que seria então usada como a função de rastreamento local para o escopo.

Se ocorrer algum erro na função de rastreamento, ela será desativada, assim como @code{settrace(None)} é chamado.

@cartouche
@quotation Nota 
O rastreamento é desabilitado ao chamar a função de rastreamento (por exemplo, uma função definida por @code{settrace()}). Para rastreamento recursivo, veja @ref{194d,,call_tracing()}.
@end quotation
@end cartouche

Os eventos têm o seguinte significado:


@table @asis

@item @code{'call'}

Uma função é chamada (ou algum outro bloco de código é inserido). A função de rastreamento global é chamada; `arg' é @code{None}; o valor de retorno especifica a função de rastreamento local.

@item @code{'line'}

O interpretador está prestes a executar uma nova linha de código ou reexecutar a condição de um laço. A função de rastreamento local é chamada; `arg' é @code{None}; o valor de retorno especifica a nova função de rastreamento local. Veja @code{Objects/lnotab_notes.txt} para uma explicação detalhada de como isso funciona. Eventos por linha podem ser desabilitados para um quadro definindo @ref{bf6,,f_trace_lines} como @ref{b49,,False} naquele @ref{6e0,,quadro}.

@item @code{'return'}

Uma função (ou outro bloco de código) está prestes a retornar. A função de rastreamento local é chamada; `arg' é o valor que será retornado, ou @code{None} se o evento for causado por uma exceção sendo levantada. O valor de retorno da função de rastreamento é ignorado.

@item @code{'exception'}

Ocorreu uma exceção. A função de rastreamento local é chamada; `arg' é uma tupla @code{(exception, value, traceback)}; o valor de retorno especifica a nova função de rastreamento local.

@item @code{'opcode'}

O interpretador está prestes a executar um novo opcode (veja @ref{38,,dis} para detalhes do opcode). A função de rastreamento local é chamada; `arg' é @code{None}; o valor de retorno especifica a nova função de rastreamento local. Eventos por opcode não são emitidos por padrão: eles devem ser explicitamente solicitados definindo @ref{bf7,,f_trace_opcodes} como @ref{c27,,True} no @ref{6e0,,quadro}.
@end table

Observe que, à medida que uma exceção é propagada pela cadeia de chamadores, um evento @code{'exception'} é gerado em cada nível.

Para um uso mais refinado, é possível definir uma função de rastreamento atribuindo @code{frame.f_trace = tracefunc} explicitamente, em vez de depender de ser definida indiretamente por meio do valor de retorno de uma função de rastreamento já instalada. Isso também é necessário para ativar a função de rastreamento no quadro atual, o que @ref{1547,,settrace()} não faz. Observe que, para que isso funcione, uma função de rastreamento global deve ter sido instalada com @ref{1547,,settrace()} para habilitar o maquinário de rastreamento em tempo de execução, mas não precisa ser a mesma função de rastreamento (por exemplo, pode ser uma função de rastreamento de baixa sobrecarga que simplesmente retorna @code{None} para se desabilitar imediatamente em cada quadro).

Para mais informações sobre objetos de código e quadro, consulte @ref{2075,,A hierarquia de tipos padrão}.

Levanta um @ref{19fa,,evento de auditoria} @code{sys.settrace} sem argumentos.

A função @ref{1547,,settrace()} destina-se apenas à implementação de depuradores, perfiladores, ferramentas de cobertura e similares. Seu comportamento faz parte da plataforma de implementação, e não da definição da linguagem e, portanto, pode não estar disponível em todas as implementações do Python.


Alterado na versão 3.7: Tipo de evento @code{'opcode'} adicionado; atributos @ref{bf6,,f_trace_lines} e @ref{bf7,,f_trace_opcodes} adicionados a quadros

@end deffn

@geindex set_asyncgen_hooks() (no módulo sys)
@anchor{library/sys sys set_asyncgen_hooks}@anchor{1712}
@deffn {Função} sys.set_asyncgen_hooks ([firstiter] [, finalizer])

Aceita dois argumentos nomeados opcionais que são chamáveis que aceitam um @ref{45bd,,iterador gerador assíncrono} como argumento. O chamável `firstiter' será chamado quando um gerador assíncrono for iterado pela primeira vez. O `finalizer' será chamado quando um gerador assíncrono estiver prestes a ser coletado como lixo.

Levanta um @ref{19fa,,evento de auditoria} @code{sys.set_asyncgen_hooks_firstiter} sem argumentos.

Levanta um @ref{19fa,,evento de auditoria} @code{sys.set_asyncgen_hooks_finalizer} sem argumentos.

Dois eventos de auditoria são gerados porque a API subjacente consiste em duas chamadas, cada uma das quais deve levantar seu próprio evento.


Adicionado na versão 3.6: Veja a 
@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} para mais detalhes, e para um exemplo de referência de um método `finalizer' veja a implementação de @code{asyncio.Loop.shutdown_asyncgens} em Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/asyncio/base_events.py}


@cartouche
@quotation Nota 
Esta função foi adicionada provisoriamente (veja 
@geindex Propostas de Melhorias do Python; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para detalhes.)
@end quotation
@end cartouche
@end deffn

@geindex set_coroutine_origin_tracking_depth() (no módulo sys)
@anchor{library/sys sys set_coroutine_origin_tracking_depth}@anchor{ba4}
@deffn {Função} sys.set_coroutine_origin_tracking_depth (depth)

Permite habilitar ou desabilitar o rastreamento de origem de corrotina. Quando habilitado, o atributo @code{cr_origin} em objetos de corrotina conterá uma tupla de tuplas (nome do arquivo, número da linha, nome da função) descrevendo o traceback onde o objeto corrotina foi criado, com a chamada mais recente primeiro. Quando desabilitado, @code{cr_origin} será @code{None}.

Para habilitar, passe um valor `depth' maior que zero; isso define o número de quadros cujas informações serão capturadas. Para desabilitar, defina `depth' para zero.

Esta configuração é específica do thread.


Adicionado na versão 3.7.


@cartouche
@quotation Nota 
Esta função foi adicionada provisoriamente (veja 
@geindex Propostas de Melhorias do Python; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para detalhes.) Use-a apenas para propósitos de depuração.
@end quotation
@end cartouche
@end deffn

@geindex activate_stack_trampoline() (no módulo sys)
@anchor{library/sys sys activate_stack_trampoline}@anchor{46f}
@deffn {Função} sys.activate_stack_trampoline (backend, /)

Ativa o trampolim do perfilador de pilha `backend'. O único backend suportado é @code{"perf"}.

@ref{1ed8,,Disponibilidade}: Linux.


Adicionado na versão 3.12.



@subsubheading Ver também



@itemize *

@item 
@ref{18f,,Suporte do Python ao perfilador perf do Linux}

@item 
@indicateurl{https://perf.wiki.kernel.org}
@end itemize

@end deffn

@geindex deactivate_stack_trampoline() (no módulo sys)
@anchor{library/sys sys deactivate_stack_trampoline}@anchor{470}
@deffn {Função} sys.deactivate_stack_trampoline ()

Desativa o backend trampolim do perfilador de pilha atual.

Se nenhum perfilador de pilha estiver ativado, esta função não terá efeito.

@ref{1ed8,,Disponibilidade}: Linux.


Adicionado na versão 3.12.

@end deffn

@geindex is_stack_trampoline_active() (no módulo sys)
@anchor{library/sys sys is_stack_trampoline_active}@anchor{471}
@deffn {Função} sys.is_stack_trampoline_active ()

Retorna @code{True} se um trampolim de perfilador de pilha estiver ativo.

@ref{1ed8,,Disponibilidade}: Linux.


Adicionado na versão 3.12.

@end deffn

@geindex _enablelegacywindowsfsencoding() (no módulo sys)
@anchor{library/sys sys _enablelegacywindowsfsencoding}@anchor{2ae}
@deffn {Função} sys._enablelegacywindowsfsencoding ()

Altera @ref{53b,,tratador de erros e codificação do sistema de arquivos} para ‘replace’ e ‘mbcs’ respectivamente, para consistência com versões do Python anteriores à 3.6.

Isso é equivalente a definir a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} antes de iniciar o Python.

Veja também @ref{c74,,sys.getfilesystemencoding()} e @ref{d07,,sys.getfilesystemencodeerrors()}.

@ref{1ed8,,Disponibilidade}: Windows.

@cartouche
@quotation Nota 
Alterar a codificação do sistema de arquivos após a inicialização do Python é arriscado porque o fsencoding antigo ou os caminhos codificados pelo fsencoding antigo podem estar armazenados em cache em algum lugar. Use 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} em vez disso.
@end quotation
@end cartouche


Adicionado na versão 3.6: Veja 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para mais detalhes.



Descontinuado desde a versão 3.13, será removido na versão 3.16: Use 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING}.

@end deffn

@geindex stdin (no módulo sys)
@geindex stdout (no módulo sys)
@geindex stderr (no módulo sys)
@anchor{library/sys sys stdin}@anchor{53d}
@deffn {Dado} sys.stdin
@anchor{library/sys sys stdout}@anchor{ae6}
@deffnx {Dado} sys.stdout
@anchor{library/sys sys stderr}@anchor{940}
@deffnx {Dado} sys.stderr

@ref{1203,,Objetos arquivo} usados pelo interpretador para entrada padrão, saída e erros:


@itemize *

@item 
@code{stdin} é usado para todas as entradas interativas (incluindo chamadas para @ref{131b,,input()});

@item 
@code{stdout} é usado para a saída das instruções @ref{fa9,,print()} e @ref{2111,,expressões} e para os prompts de @ref{131b,,input()};

@item 
Os prompts do próprio interpretador e suas mensagens de erro vão para @code{stderr}.
@end itemize

Esses fluxos são @ref{1e0d,,arquivos texto} regulares como aqueles retornados pela função @ref{51c,,open()}. Seus parâmetros são escolhidos da seguinte forma:


@itemize *

@item 
A codificação e o tratamento de erros são inicializados a partir de @ref{3a3,,PyConfig.stdio_encoding} e @ref{45cc,,PyConfig.stdio_errors}.

No Windows, o UTF-8 é usado para o dispositivo de console. Dispositivos não-caracteres, como arquivos de disco e pipes, usam a codificação da localidade do sistema (ou seja, a página de código ANSI). Dispositivos de caracteres não-console, como NUL (ou seja, onde @code{isatty()} retorna @code{True}) usam o valor das páginas de código de entrada e saída do console na inicialização, respectivamente para stdin e stdout/stderr. Isso assume como padrão a @ref{242,,codificação da localidade} do sistema se o processo não for inicialmente anexado a um console.

O comportamento especial do console pode ser substituído definindo a variável de ambiente PYTHONLEGACYWINDOWSSTDIO antes de iniciar o Python. Nesse caso, as páginas de código do console são usadas como para qualquer outro dispositivo de caractere.

Em todas as plataformas, você pode substituir a codificação de caracteres definindo a variável de ambiente 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} antes de iniciar o Python ou usando a nova opção de linha de comando @ref{176,,-X} @code{utf8} e a variável de ambiente 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8}. No entanto, para o console do Windows, isso só se aplica quando 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@ref{c76,,PYTHONLEGACYWINDOWSSTDIO} também está definido.

@item 
Quando interativo, o fluxo @code{stdout} é armazenado em buffer de linha. Caso contrário, ele é armazenado em buffer de bloco como arquivos texto comuns. O fluxo @code{stderr} é armazenado em buffer de linha em ambos os casos. Você pode tornar ambos os fluxos sem buffer passando a opção de linha de comando @ref{1b1c,,-u} ou definindo a variável de ambiente 
@geindex PYTHONUNBUFFERED
@geindex variável de ambiente; PYTHONUNBUFFERED
@ref{1b1d,,PYTHONUNBUFFERED}.
@end itemize


Alterado na versão 3.9: @code{stderr} não interativo agora é armazenado em buffer de linha em vez de totalmente armazenado em buffer.


@cartouche
@quotation Nota 
Para escrever ou ler dados binários de/para os fluxos padrão, use o objeto binário subjacente @ref{12e5,,buffer}. Por exemplo, para escrever bytes em @ref{ae6,,stdout}, use @code{sys.stdout.buffer.write(b'abc')}.

Entretanto, se você estiver escrevendo uma biblioteca (e não controlar em qual contexto seu código será executado), esteja ciente de que os fluxos padrão podem ser substituídos por objetos arquivo ou similares, como @ref{f59,,io.StringIO}, que não oferecem suporte ao atributo @code{buffer}.
@end quotation
@end cartouche
@end deffn

@geindex __stdin__ (no módulo sys)
@geindex __stdout__ (no módulo sys)
@geindex __stderr__ (no módulo sys)
@anchor{library/sys sys __stdin__}@anchor{45cd}
@deffn {Dado} sys.__stdin__
@anchor{library/sys sys __stdout__}@anchor{2a33}
@deffnx {Dado} sys.__stdout__
@anchor{library/sys sys __stderr__}@anchor{4381}
@deffnx {Dado} sys.__stderr__

Esses objetos contêm os valores originais de @code{stdin}, @code{stderr} e @code{stdout} no início do programa. Eles são usados durante a finalização e podem ser úteis para imprimir no fluxo padrão real, não importa se o objeto @code{sys.std*} foi redirecionado.

Ele também pode ser usado para restaurar os arquivos reais para objetos arquivo de trabalho conhecidos, caso tenham sido substituídos por um objeto quebrado. No entanto, a maneira preferida de fazer isso é salvar explicitamente o fluxo anterior antes de substituí-lo e restaurar o objeto salvo.

@cartouche
@quotation Nota 
Sob algumas condições, @code{stdin}, @code{stdout} e @code{stderr}, bem como os valores originais de @code{__stdin__}, @code{__stdout__} e @code{__stderr__} podem ser @code{None}. Geralmente é o caso de aplicativos GUI do Windows que não estão conectados a um console e aplicativos Python iniciados com @code{pythonw}.
@end quotation
@end cartouche
@end deffn

@geindex stdlib_module_names (no módulo sys)
@anchor{library/sys sys stdlib_module_names}@anchor{844}
@deffn {Dado} sys.stdlib_module_names

Um frozenset de strings contendo os nomes dos módulos da biblioteca padrão.

É o mesmo em todas as plataformas. Módulos que não estão disponíveis em algumas plataformas e módulos desabilitados na construção do Python também são listados. Todos os tipos de módulos são listados: Python puro, módulos embutidos, congelados e de extensão. Módulos de teste são excluídos.

Para pacotes, somente o pacote principal é listado: subpacotes e submódulos não são listados. Por exemplo, o pacote @code{email} é listado, mas o subpacote @code{email.mime} e o submódulo @code{email.message} não são listados.

Veja também a lista de @ref{1de5,,sys.builtin_module_names}.


Adicionado na versão 3.10.

@end deffn

@geindex thread_info (no módulo sys)
@anchor{library/sys sys thread_info}@anchor{118f}
@deffn {Dado} sys.thread_info

Uma @ref{64e,,tupla nomeada} contendo informações sobre a implementação de threads.

@geindex name (atributo sys.thread_info)
@anchor{library/sys sys thread_info name}@anchor{45ce}
@deffn {Atributo} thread_info.name

O nome da implementação da thread:


@itemize *

@item 
@code{"nt"}: Threads do Windows

@item 
@code{"pthread"}: Threads do POSIX

@item 
@code{"pthread-stubs"}: stubs de threads POSIX (em plataformas WebAssembly que não implementam threads).

@item 
@code{"solaris"}: Threads do Solaris
@end itemize
@end deffn

@geindex lock (atributo sys.thread_info)
@anchor{library/sys sys thread_info lock}@anchor{45cf}
@deffn {Atributo} thread_info.lock

O nome da implementação de trava.


@itemize *

@item 
@code{"semaphore"}: uma trava usa um semáforo

@item 
@code{"mutex+cond"}: uma trava usa um mutex e uma variável de condição

@item 
@code{None} se essa informação for desconhecida
@end itemize
@end deffn

@geindex version (atributo sys.thread_info)
@anchor{library/sys sys thread_info version}@anchor{45d0}
@deffn {Atributo} thread_info.version

O nome e a versão da biblioteca de threads. É uma string, ou @code{None} se essa informação for desconhecida.
@end deffn


Adicionado na versão 3.3.

@end deffn

@geindex tracebacklimit (no módulo sys)
@anchor{library/sys sys tracebacklimit}@anchor{16c4}
@deffn {Dado} sys.tracebacklimit

Quando essa variável é definida como um valor inteiro, ela determina o número máximo de níveis de informações de traceback impressas quando ocorre uma exceção não tratada. O padrão é @code{1000}. Quando definida como @code{0} ou menos, todas as informações de traceback são suprimidas e apenas o tipo e o valor da exceção são impressos.
@end deffn

@geindex unraisablehook() (no módulo sys)
@anchor{library/sys sys unraisablehook}@anchor{1f7}
@deffn {Função} sys.unraisablehook (unraisable, /)

Manipula uma exceção não levantada

Chamada quando uma exceção ocorreu, mas não há como o Python manipulá-la. Por exemplo, quando um destrutor levanta uma exceção ou durante a coleta de lixo (@ref{a43,,gc.collect()}).

O argumento `unraisable' tem os seguintes atributos:


@itemize *

@item 
@code{exc_type}: Tipo de exceção.

@item 
@code{exc_value}: Valor da exceção, pode ser @code{None}.

@item 
@code{exc_traceback}: Traceback da exceção, pode ser @code{None}.

@item 
@code{err_msg}: Mensagem de erro, pode ser @code{None}.

@item 
@code{object}: O objeto que causa a exceção pode ser @code{None}.
@end itemize

Os formatos de gancho padrão @code{err_msg} e @code{object} como: @code{f'@{err_msg@}: @{object!r@}'}; usa a mensagem de erro “Exception ignored in” se @code{err_msg} for @code{None}.

@ref{1f7,,sys.unraisablehook()} pode ser substituída para controlar como exceções não levantáveis são manipuladas.


@subsubheading Ver também


@ref{80e,,excepthook()}, que manipula exceções não capturadas.


@cartouche
@quotation Aviso 
Armazena @code{exc_value} usando um gancho personalizado pode criar um ciclo de referência. Ele deve ser limpo explicitamente para quebrar o ciclo de referência quando a exceção não for mais necessária.

Armazenar @code{object} usando um gancho personalizado pode ressuscitá-lo se ele for definido como um objeto que está sendo finalizado. Evite armazenar @code{object} após o gancho personalizado ser concluído para evitar ressuscitar objetos.
@end quotation
@end cartouche

Levanta um evento de auditoria @code{sys.unraisablehook} com argumentos `hook' e `unraisable' quando ocorrer uma exceção que não puder ser manipulada. O objeto `unraisable' é o mesmo que será passado para o gancho. Se nenhum gancho tiver sido definido, `hook' pode ser @code{None}.


Adicionado na versão 3.8.

@end deffn

@geindex version (no módulo sys)
@anchor{library/sys sys version}@anchor{178}
@deffn {Dado} sys.version

Uma string contendo o número da versão do interpretador Python mais informações adicionais sobre o número da construção e o compilador usado. Esta string é exibida quando o interpretador interativo é iniciado. Não extraia informações de versão dela, em vez disso, use @ref{6a0,,version_info} e as funções fornecidas pelo módulo @ref{aa,,platform}.
@end deffn

@geindex api_version (no módulo sys)
@anchor{library/sys sys api_version}@anchor{45d1}
@deffn {Dado} sys.api_version

A versão da API C para este interpretador. Programadores podem achar isso útil ao depurar conflitos de versão entre Python e módulos de extensão.
@end deffn

@geindex version_info (no módulo sys)
@anchor{library/sys sys version_info}@anchor{6a0}
@deffn {Dado} sys.version_info

Uma tupla contendo os cinco componentes do número da versão: `major', `minor', `micro', `releaselevel' e `serial'. Todos os valores, exceto `releaselevel', são inteiros; o nível de versão é @code{'alpha'}, @code{'beta'}, @code{'candidate'} ou @code{'final'}. O valor @code{version_info} correspondente à versão 2.0 do Python é @code{(2, 0, 0, 'final', 0)}. Os componentes também podem ser acessados por nome, então @code{sys.version_info[0]} é equivalente a @code{sys.version_info.major} e assim por diante.


Alterado na versão 3.1: Adiciona componentes nomeados como atributos.

@end deffn

@geindex warnoptions (no módulo sys)
@anchor{library/sys sys warnoptions}@anchor{3b0}
@deffn {Dado} sys.warnoptions

Este é um detalhe de implementação do framework de avisos; não modifique este valor. Consulte o módulo @ref{112,,warnings} para obter mais informações sobre o framework de avisos.
@end deffn

@geindex winver (no módulo sys)
@anchor{library/sys sys winver}@anchor{45d2}
@deffn {Dado} sys.winver

O número da versão usado para formar chaves de registro em plataformas Windows. Isso é armazenado como recurso de string 1000 na DLL do Python. O valor normalmente é a versão principal e secundária do interpretador Python em execução. Ele é fornecido no módulo @ref{d9,,sys} para fins informativos; modificar esse valor não tem efeito nas chaves de registro usadas pelo Python.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn


@deffn {Dado} sys.monitoring

Espaço de nomes contendo funções e constantes para função de retorno de registro e controle de eventos de monitoramento. Veja @ref{da,,sys.monitoring} para detalhes.
@end deffn

@geindex _xoptions (no módulo sys)
@anchor{library/sys sys _xoptions}@anchor{1ec7}
@deffn {Dado} sys._xoptions

Um dicionário dos vários sinalizadores específicos de implementação passados pela opção de linha de comando @ref{176,,-X}. Os nomes de opção são mapeados para seus valores, se fornecidos explicitamente, ou para @ref{c27,,True}. Exemplo:

@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

Esta é uma maneira específica do CPython de acessar opções passadas por @ref{176,,-X}. Outras implementações podem exportá-las por outros meios, ou não exportá-las.


Adicionado na versão 3.2.

@end deffn

@subsubheading Citações


@anchor{library/sys c99}@anchor{45ac}@w{(C99)} 
ISO/IEC 9899:1999.  “Programming languages – C.” Um rascunho público desta norma está disponível em @indicateurl{https://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf}.

@node sys monitoring — Monitoramento de eventos de execução,sysconfig — Fornece acesso às informações de configuração do Python,sys — Parâmetros e funções específicas do sistema,Serviços de Tempo de Execução Python
@anchor{library/sys monitoring doc}@anchor{45d3}@anchor{library/sys monitoring module-sys monitoring}@anchor{da}@anchor{library/sys monitoring sys-monitoring-execution-event-monitoring}@anchor{45d4}@anchor{library/sys monitoring translation-repo}@anchor{45d5}
@subsection @code{sys.monitoring} — Monitoramento de eventos de execução


@geindex module; sys.monitoring


Adicionado na versão 3.12.



__________________________________________________________________


@cartouche
@quotation Nota 
@ref{da,,sys.monitoring} é um espaço de nomes dentro do módulo @ref{d9,,sys}, não um módulo independente, então não há necessidade de importá-lo com @code{import sys.monitoring}, bastando usar @code{import sys} e então usar @code{sys.monitoring}.
@end quotation
@end cartouche

Esse espaço de nomes fornece acesso às funções e constantes necessárias para ativar e controlar o monitoramento de eventos.

À medida que os programas são executados, ocorrem eventos que podem ser de interesse para as ferramentas que monitoram a execução. O espaço de nomes @ref{da,,sys.monitoring} fornece meios para receber retornos de chamada quando ocorrem eventos de interesse.

A API de monitoramento consiste em três componentes:


@itemize *

@item 
@ref{45d6,,Identificadores de ferramenta}

@item 
@ref{45d7,,Eventos}

@item 
@ref{45d8,,Funções de retorno de chamadas}
@end itemize

@menu
* Identificadores de ferramenta:: 
* Eventos:: 
* Ativação e desativação de eventos:: 
* Registro de funções de retorno de chamada:: 

@end menu

@node Identificadores de ferramenta,Eventos,,sys monitoring — Monitoramento de eventos de execução
@anchor{library/sys monitoring tool-identifiers}@anchor{45d6}
@subsubsection Identificadores de ferramenta


Um identificador de ferramenta é um número inteiro e o nome associado. Os identificadores de ferramenta são usados para evitar que as ferramentas interfiram umas nas outras e para permitir que várias ferramentas operem ao mesmo tempo. Atualmente, as ferramentas são totalmente independentes e não podem ser usadas para monitorar umas às outras. Essa restrição poderá ser suspensa no futuro.

Antes de registrar ou ativar eventos, uma ferramenta deve escolher um identificador. Os identificadores são números inteiros no intervalo de 0 a 5, inclusive.

@menu
* Registro e uso de ferramentas:: 

@end menu

@node Registro e uso de ferramentas,,,Identificadores de ferramenta
@anchor{library/sys monitoring registering-and-using-tools}@anchor{45d9}
@subsubsection Registro e uso de ferramentas


@geindex use_tool_id() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring use_tool_id}@anchor{45da}
@deffn {Função} sys.monitoring.use_tool_id (tool_id: int, name: str, /) -> None

Deve ser chamado antes que `tool_id' possa ser usado. `tool_id' deve estar no intervalo de 0 a 5, inclusive. Levanta um @ref{202,,ValueError} se `tool_id' estiver em uso.
@end deffn

@geindex free_tool_id() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring free_tool_id}@anchor{45db}
@deffn {Função} sys.monitoring.free_tool_id (tool_id: int, /) -> None

Deve ser chamado quando uma ferramenta não precisar mais do endereço `tool_id'.
@end deffn

@cartouche
@quotation Nota 
@ref{45db,,free_tool_id()} não desabilitará eventos globais ou locais associados a `tool_id', nem cancelará o registro de qualquer função de retorno. Essa função deve ser usada apenas para notificar a VM de que o `tool_id' específico não está mais em uso.
@end quotation
@end cartouche

@geindex get_tool() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_tool}@anchor{45dc}
@deffn {Função} sys.monitoring.get_tool (tool_id: int, /) -> str | None

Retorna o nome da ferramenta se `tool_id' estiver em uso; caso contrário, retorna @code{None}. `tool_id' deve estar no intervalo de 0 a 5, inclusive.
@end deffn

Todas as IDs são tratadas da mesma forma pela VM com relação aos eventos, mas as seguintes IDs são predefinidas para facilitar a cooperação entre as ferramentas:

@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,Ativação e desativação de eventos,Identificadores de ferramenta,sys monitoring — Monitoramento de eventos de execução
@anchor{library/sys monitoring events}@anchor{45d7}
@subsubsection Eventos


Os seguintes eventos são suportados:

@geindex BRANCH (monitoring event)
@anchor{library/sys monitoring monitoring-event-BRANCH}@anchor{45dd}
@deffn {monitoring-event} sys.monitoring.events.BRANCH

Uma ramificação condicional é feita (ou não).
@end deffn

@geindex CALL (monitoring event)
@anchor{library/sys monitoring monitoring-event-CALL}@anchor{1734}
@deffn {monitoring-event} sys.monitoring.events.CALL

Uma chamada no código Python (o evento ocorre antes da chamada).
@end deffn

@geindex C_RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RAISE}@anchor{45de}
@deffn {monitoring-event} sys.monitoring.events.C_RAISE

Uma exceção levantada por qualquer chamável, exceto funções Python (o evento ocorre após a saída).
@end deffn

@geindex C_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RETURN}@anchor{45df}
@deffn {monitoring-event} sys.monitoring.events.C_RETURN

Retorno de qualquer chamável, exceto por funções Python (o evento ocorre após o retorno).
@end deffn

@geindex EXCEPTION_HANDLED (monitoring event)
@anchor{library/sys monitoring monitoring-event-EXCEPTION_HANDLED}@anchor{45e0}
@deffn {monitoring-event} sys.monitoring.events.EXCEPTION_HANDLED

Uma exceção é tratada.
@end deffn

@geindex INSTRUCTION (monitoring event)
@anchor{library/sys monitoring monitoring-event-INSTRUCTION}@anchor{45e1}
@deffn {monitoring-event} sys.monitoring.events.INSTRUCTION

Uma instrução VM está prestes a ser executada.
@end deffn

@geindex JUMP (monitoring event)
@anchor{library/sys monitoring monitoring-event-JUMP}@anchor{45e2}
@deffn {monitoring-event} sys.monitoring.events.JUMP

É feito um salto incondicional no gráfico do fluxo de controle.
@end deffn

@geindex LINE (monitoring event)
@anchor{library/sys monitoring monitoring-event-LINE}@anchor{45e3}
@deffn {monitoring-event} sys.monitoring.events.LINE

Está prestes a ser executada uma instrução que tem um número de linha diferente da instrução anterior.
@end deffn

@geindex PY_RESUME (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RESUME}@anchor{45e4}
@deffn {monitoring-event} sys.monitoring.events.PY_RESUME

Retomada de uma função Python (para funções geradoras e de corrotina), exceto para chamadas @code{throw()}.
@end deffn

@geindex PY_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RETURN}@anchor{45e5}
@deffn {monitoring-event} sys.monitoring.events.PY_RETURN

Retorno de uma função Python (ocorre imediatamente antes do retorno, o quadro do receptor estará na pilha).
@end deffn

@geindex PY_START (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_START}@anchor{45e6}
@deffn {monitoring-event} sys.monitoring.events.PY_START

Início de uma função Python (ocorre imediatamente após a chamada, o quadro do receptor da chamada estará na pilha)
@end deffn

@geindex PY_THROW (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_THROW}@anchor{45e7}
@deffn {monitoring-event} sys.monitoring.events.PY_THROW

Uma função Python é retomada por uma chamada @code{throw()}.
@end deffn

@geindex PY_UNWIND (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_UNWIND}@anchor{45e8}
@deffn {monitoring-event} sys.monitoring.events.PY_UNWIND

Saída de uma função Python durante o desenrolar da exceção.
@end deffn

@geindex PY_YIELD (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_YIELD}@anchor{45e9}
@deffn {monitoring-event} sys.monitoring.events.PY_YIELD

Produz de uma função Python (ocorre imediatamente antes do yield, o quadro do receptor estará na pilha).
@end deffn

@geindex RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RAISE}@anchor{16da}
@deffn {monitoring-event} sys.monitoring.events.RAISE

Uma exceção é levantada, exceto aquelas que causam um evento @ref{45ea,,STOP_ITERATION}.
@end deffn

@geindex RERAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RERAISE}@anchor{45eb}
@deffn {monitoring-event} sys.monitoring.events.RERAISE

Uma exceção é levantada novamente, por exemplo, no final de um bloco @ref{9d2,,finally}.
@end deffn

@geindex STOP_ITERATION (monitoring event)
@anchor{library/sys monitoring monitoring-event-STOP_ITERATION}@anchor{45ea}
@deffn {monitoring-event} sys.monitoring.events.STOP_ITERATION

Uma exceção artificial @ref{c15,,StopIteration} é levantada; consulte @ref{45ec,,o evento STOP_ITERATION}.
@end deffn

Mais eventos poderão ser adicionados no futuro.

Esses eventos são atributos do espaço de nomes @code{sys.monitoring.events}. Cada evento é representado como uma constante de potência de 2 inteiros. Para definir um conjunto de eventos, basta aplicar OU (OR) bit a bit nos eventos individuais juntos. Por exemplo, para especificar os eventos @ref{45e5,,PY_RETURN} e @ref{45e6,,PY_START}, use a expressão @code{PY_RETURN | PY_START}.

@geindex NO_EVENTS (monitoring event)
@anchor{library/sys monitoring monitoring-event-NO_EVENTS}@anchor{45ed}
@deffn {monitoring-event} sys.monitoring.events.NO_EVENTS

Um apelido para @code{0} para que os usuários possam fazer comparações explícitas como:

@example
if get_events(DEBUGGER_ID) == NO_EVENTS:
    ...
@end example
@end deffn

Os eventos são divididos em três grupos:

@menu
* Eventos locais:: 
* Eventos auxiliares:: 
* Outros eventos:: 
* O evento STOP_ITERATION:: 

@end menu

@node Eventos locais,Eventos auxiliares,,Eventos
@anchor{library/sys monitoring local-events}@anchor{45ee}@anchor{library/sys monitoring monitoring-event-local}@anchor{45ef}
@subsubsection Eventos locais


Os eventos locais estão associados à execução normal do programa e ocorrem em locais claramente definidos. Todos os eventos locais podem ser desativados. Os eventos locais são:


@itemize *

@item 
@ref{45e6,,PY_START}

@item 
@ref{45e4,,PY_RESUME}

@item 
@ref{45e5,,PY_RETURN}

@item 
@ref{45e9,,PY_YIELD}

@item 
@ref{1734,,CALL}

@item 
@ref{45e3,,LINE}

@item 
@ref{45e1,,INSTRUCTION}

@item 
@ref{45e2,,JUMP}

@item 
@ref{45dd,,BRANCH}

@item 
@ref{45ea,,STOP_ITERATION}
@end itemize

@node Eventos auxiliares,Outros eventos,Eventos locais,Eventos
@anchor{library/sys monitoring ancillary-events}@anchor{45f0}
@subsubsection Eventos auxiliares


Os eventos auxiliares podem ser monitorados como outros eventos, mas são controlados por outro evento:


@itemize *

@item 
@ref{45de,,C_RAISE}

@item 
@ref{45df,,C_RETURN}
@end itemize

Os eventos @ref{45df,,C_RETURN} e @ref{45de,,C_RAISE} são controlados pelo evento @ref{1734,,CALL}. Os eventos @ref{45df,,C_RETURN} e @ref{45de,,C_RAISE} só serão vistos se o evento @ref{1734,,CALL} correspondente estiver sendo monitorado.

@node Outros eventos,O evento STOP_ITERATION,Eventos auxiliares,Eventos
@anchor{library/sys monitoring monitoring-event-global}@anchor{45f1}@anchor{library/sys monitoring other-events}@anchor{45f2}
@subsubsection Outros eventos


Outros eventos não estão necessariamente vinculados a um local específico no programa e não podem ser desativados individualmente via @ref{45f3,,DISABLE}.

Os outros eventos que podem ser monitorados são:


@itemize *

@item 
@ref{45e7,,PY_THROW}

@item 
@ref{45e8,,PY_UNWIND}

@item 
@ref{16da,,RAISE}

@item 
@ref{45e0,,EXCEPTION_HANDLED}
@end itemize

@node O evento STOP_ITERATION,,Outros eventos,Eventos
@anchor{library/sys monitoring the-stop-iteration-event}@anchor{45ec}
@subsubsection O evento STOP_ITERATION


@geindex Propostas de Melhorias do Python; PEP 380#use-of-stopiteration-to-return-values
PEP 380@footnote{https://peps.python.org/pep-0380/#use-of-stopiteration-to-return-values} especifica que uma exceção @ref{c15,,StopIteration} é levantada ao retornar um valor de um gerador ou corrotina. No entanto, essa é uma maneira muito ineficiente de retornar um valor, portanto, algumas implementações do Python, especialmente o CPython 3.12+, não levantam uma exceção, a menos que ela seja visível para outro código.

Para permitir que as ferramentas monitorem exceções reais sem reduzir a velocidade dos geradores e das corrotinas, o evento @ref{45ea,,STOP_ITERATION} é fornecido. O @ref{45ea,,STOP_ITERATION} pode ser desativado localmente, ao contrário do @ref{16da,,RAISE}.

@node Ativação e desativação de eventos,Registro de funções de retorno de chamada,Eventos,sys monitoring — Monitoramento de eventos de execução
@anchor{library/sys monitoring turning-events-on-and-off}@anchor{45f4}
@subsubsection Ativação e desativação de eventos


Para monitorar um evento, ele deve ser ativado e uma função de retorno correspondente deve ser registrada. Os eventos podem ser ativados ou desativados definindo-os globalmente ou para um objeto código específico.

@menu
* Definir eventos globalmente:: 
* Eventos por objeto código:: 
* Desativação de eventos:: 

@end menu

@node Definir eventos globalmente,Eventos por objeto código,,Ativação e desativação de eventos
@anchor{library/sys monitoring setting-events-globally}@anchor{45f5}
@subsubsection Definir eventos globalmente


Os eventos podem ser controlados globalmente, modificando o conjunto de eventos que estão sendo monitorados.

@geindex get_events() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_events}@anchor{45f6}
@deffn {Função} sys.monitoring.get_events (tool_id: int, /) -> int

Retorna o endereço @code{int} que representa todos os eventos ativos.
@end deffn

@geindex set_events() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring set_events}@anchor{45f7}
@deffn {Função} sys.monitoring.set_events (tool_id: int, event_set: int, /) -> None

Ativa todos os eventos definidos em `event_set'. Levanta um @ref{202,,ValueError} se `tool_id' não estiver em uso.
@end deffn

Nenhum evento está ativo por padrão.

@node Eventos por objeto código,Desativação de eventos,Definir eventos globalmente,Ativação e desativação de eventos
@anchor{library/sys monitoring per-code-object-events}@anchor{45f8}
@subsubsection Eventos por objeto código


Os eventos também podem ser controlados por objeto código. As funções definidas abaixo que aceitam um @ref{2df,,types.CodeType} devem estar preparadas para aceitar um objeto semelhante de funções que não são definidas no Python (veja @ref{15c,,API C de monitoramento}).

@geindex get_local_events() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring get_local_events}@anchor{45f9}
@deffn {Função} sys.monitoring.get_local_events (tool_id: int, code: CodeType, /) -> int

Retorna todos os @ref{45ef,,eventos locais} para `code'
@end deffn

@geindex set_local_events() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring set_local_events}@anchor{45fa}
@deffn {Função} sys.monitoring.set_local_events (tool_id: int, code: CodeType, event_set: int, /) -> None

Ativa todos os @ref{45ef,,eventos locais} para `code' que estão definidos em `event_set'. Levanta a @ref{202,,ValueError} se `tool_id' não estiver em uso.
@end deffn

Os eventos locais são adicionados aos eventos globais, mas não os mascaram. Em outras palavras, todos os eventos globais serão acionados para um objeto código, independentemente dos eventos locais.

@node Desativação de eventos,,Eventos por objeto código,Ativação e desativação de eventos
@anchor{library/sys monitoring disabling-events}@anchor{45fb}
@subsubsection Desativação de eventos


@geindex DISABLE (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring DISABLE}@anchor{45f3}
@deffn {Dado} sys.monitoring.DISABLE

Um valor especial que pode ser retornado de um função de retorno função para desativar eventos para o local do código atual.
@end deffn

Os @ref{45ef,,eventos locais} podem ser desativados para um local de código específico, retornando @ref{45f3,,sys.monitoring.DISABLE} de uma função de retorno de chamada. Isso não altera quais eventos são definidos ou quaisquer outros locais de código para o mesmo evento.

A desativação de eventos para locais específicos é muito importante para o monitoramento de alto desempenho. Por exemplo, um programa pode ser executado em um depurador sem sobrecarga se o depurador desativar todo o monitoramento, exceto alguns pontos de interrupção.

Se @ref{45f3,,DISABLE} for retornado por um função de retorno (callback) para um @ref{45f1,,evento global}, @ref{202,,ValueError} será levantada pelo interpretador em um local não específico (ou seja, nenhum traceback será fornecido).

@geindex restart_events() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring restart_events}@anchor{45fc}
@deffn {Função} sys.monitoring.restart_events () -> None

Habilita todos os eventos que foram desabilitados por @ref{45f3,,sys.monitoring.DISABLE} para todas as ferramentas.
@end deffn

@node Registro de funções de retorno de chamada,,Ativação e desativação de eventos,sys monitoring — Monitoramento de eventos de execução
@anchor{library/sys monitoring callbacks}@anchor{45d8}@anchor{library/sys monitoring registering-callback-functions}@anchor{45fd}
@subsubsection Registro de funções de retorno de chamada


Para registrar um chamável para eventos, chame

@geindex register_callback() (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring register_callback}@anchor{440a}
@deffn {Função} sys.monitoring.register_callback (tool_id: int, event: int, func: Callable | None, /) -> Callable | None

Registra o chamável `func' para o `event' com o `tool_id' fornecido

Se outra função de retorno tiver sido registrada para o `tool_id' e o `event' fornecidos, ela será cancelada e retornada. Caso contrário, @ref{440a,,register_callback()} retorna @code{None}.

Levanta um @ref{19fa,,evento de auditoria} @code{sys.monitoring.register_callback} com o argumento @code{func}.
@end deffn

As funções podem ser canceladas chamando @code{sys.monitoring.register_callback(tool_id, event, None)}.

As funções de retorno de chamada podem ser registradas e canceladas a qualquer momento.

@menu
* Argumentos da função de retorno de chamada:: 

@end menu

@node Argumentos da função de retorno de chamada,,,Registro de funções de retorno de chamada
@anchor{library/sys monitoring callback-function-arguments}@anchor{45fe}
@subsubsection Argumentos da função de retorno de chamada


@geindex MISSING (no módulo sys.monitoring)
@anchor{library/sys monitoring sys monitoring MISSING}@anchor{45ff}
@deffn {Dado} sys.monitoring.MISSING

Um valor especial que é passado para uma função de retorno para indicar que não há argumento para a chamada.
@end deffn

Quando ocorre um evento ativo, a função de retorno de chamada registrada é chamada. Eventos diferentes fornecerão à função de retorno de chamada argumentos diferentes, como segue:


@itemize *

@item 
@ref{45e6,,PY_START} e @ref{45e4,,PY_RESUME}:

@example
func(code: CodeType, instruction_offset: int) -> DISABLE | Any
@end example

@item 
@ref{45e5,,PY_RETURN} e @ref{45e9,,PY_YIELD}:

@example
func(code: CodeType, instruction_offset: int, retval: object) -> DISABLE | Any
@end example

@item 
@ref{1734,,CALL}, @ref{45de,,C_RAISE} e @ref{45df,,C_RETURN}:

@example
func(code: CodeType, instruction_offset: int, callable: object, arg0: object | MISSING) -> DISABLE | Any
@end example

Se não houver argumentos, `arg0' será definido como @ref{45ff,,sys.monitoring.MISSING}.

@item 
@ref{16da,,RAISE}, @ref{45eb,,RERAISE}, @ref{45e0,,EXCEPTION_HANDLED}, @ref{45e8,,PY_UNWIND}, @ref{45e7,,PY_THROW} e @ref{45ea,,STOP_ITERATION}:

@example
func(code: CodeType, instruction_offset: int, exception: BaseException) -> DISABLE | Any
@end example

@item 
@ref{45e3,,LINE}:

@example
func(code: CodeType, line_number: int) -> DISABLE | Any
@end example

@item 
@ref{45dd,,BRANCH} e @ref{45e2,,JUMP}:

@example
func(code: CodeType, instruction_offset: int, destination_offset: int) -> DISABLE | Any
@end example

Observe que `destination_offset' é onde o código será executado em seguida. Para uma ramificação não executada, esse será o deslocamento da instrução que segue a ramificação.

@item 
@ref{45e1,,INSTRUCTION}:

@example
func(code: CodeType, instruction_offset: int) -> DISABLE | Any
@end example
@end itemize

@node sysconfig — Fornece acesso às informações de configuração do Python,builtins — Objetos embutidos,sys monitoring — Monitoramento de eventos de execução,Serviços de Tempo de Execução Python
@anchor{library/sysconfig doc}@anchor{4600}@anchor{library/sysconfig module-sysconfig}@anchor{db}@anchor{library/sysconfig sysconfig-provide-access-to-python-s-configuration-information}@anchor{4601}@anchor{library/sysconfig translation-repo}@anchor{4602}
@subsection @code{sysconfig} — Fornece acesso às informações de configuração do Python


@geindex module; sysconfig


Adicionado na versão 3.2.


`Código-fonte:' Lib/sysconfig@footnote{https://github.com/python/cpython/tree/3.13/Lib/sysconfig}

@geindex informações de configuração


__________________________________________________________________


O módulo @ref{db,,sysconfig} fornece acesso às informações de configuração do Python, como a lista de caminhos de instalação e as variáveis de configuração relevantes para a plataforma atual.

@menu
* Variáveis de configuração:: 
* Caminhos de instalação:: 
* Esquema de usuário:: 
* Esquema de home:: 
* Esquema de prefixo:: 
* Funções de caminho de instalação:: 
* Outras funções: Outras funções<3>. 
* Uso na linha de comando: Uso na linha de comando<8>. 

@end menu

@node Variáveis de configuração,Caminhos de instalação,,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig configuration-variables}@anchor{4603}
@subsubsection Variáveis de configuração


Uma distribuição do Python contém um arquivo de cabeçalho @code{Makefile} e @code{pyconfig.h} que são necessários para construir o próprio binário do Python e extensões C de terceiros compiladas usando @code{setuptools}.

@ref{db,,sysconfig} coloca todas as variáveis encontradas nestes arquivos em um dicionário que pode ser acessado usando @ref{1064,,get_config_vars()} ou @ref{1063,,get_config_var()}.

Note que no Windows, é um conjunto muito menor.

@geindex get_config_vars() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_vars}@anchor{1064}
@deffn {Função} sysconfig.get_config_vars (*args)

Sem argumentos, retorna um dicionário de todas as variáveis de configuração relevantes para a plataforma atual.

Com argumentos, retorna uma lista de valores resultantes da pesquisa de cada argumento no dicionário de variáveis de configuração.

Para cada argumento, se o valor não for encontrado, retorna @code{None}.
@end deffn

@geindex get_config_var() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_var}@anchor{1063}
@deffn {Função} sysconfig.get_config_var (name)

Retorna o valor de uma única variável `name'. Equivalente a @code{get_config_vars().get(name)}.

Se `name' não for encontrado, retorna @code{None}.
@end deffn

Exemplo 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 Caminhos de instalação,Esquema de usuário,Variáveis de configuração,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig id1}@anchor{4604}@anchor{library/sysconfig installation-paths}@anchor{68f}
@subsubsection Caminhos de instalação


O Python usa um esquema de instalação que difere dependendo da plataforma e das opções de instalação. Esses esquemas são armazenados em @ref{db,,sysconfig} sob identificadores únicos baseados no valor retornado por @ref{2ce3,,os.name}. Os esquemas são usados por instaladores de pacote para determinar para onde copiar arquivos.

Python atualmente oferece suporte a nove esquemas:


@itemize -

@item 
`posix_prefix': esquema para plataformas POSIX como Linux ou macOS. Este é o esquema padrão usado quando o Python ou um componente é instalado.

@item 
`posix_home': esquema para plataformas POSIX, quando a opção `home' é usada. Esse esquema define caminhos localizados sob um prefixo inicial específico.

@item 
`posix_user': esquema para plataformas POSIX, quando a opção `user' é usada. Esse esquema define caminhos localizados sob o diretório pessoal (home) do usuário (@ref{1361,,site.USER_BASE}).

@item 
`posix_venv': esquema para @ref{111,,ambientes virtuais do Python} em plataformas POSIX; por padrão, é o mesmo que `posix_prefix'.

@item 
`nt': esquema para Windows. Este é o esquema padrão usado quando o Python ou um componente é instalado.

@item 
`nt_user': esquema para Windows, quando utilizada a opção `user'.

@item 
`nt_venv': esquema para @ref{111,,ambientes virtuais do Python} no Windows; por padrão, é o mesmo que `nt_prefix'.

@item 
`venv': um esquema com valores de `posix_venv' ou `nt_venv' dependendo da plataforma em que o Python é executado.

@item 
`osx_framework_user': esquema para plataformas macOS, quando utilizada a opção `user'.
@end itemize

Cada esquema é composto por uma série de caminhos e cada caminho possui um identificador único. Python atualmente usa oito caminhos:


@itemize -

@item 
`stdlib': diretório que contém os arquivos da biblioteca Python padrão que não são específicos da plataforma.

@item 
`platstdlib': diretório que contém os arquivos da biblioteca Python padrão que são específicos da plataforma.

@item 
`platlib': diretório para arquivos específicos do site e específicos da plataforma.

@item 
`purelib': diretório para arquivos específicos do site e não específicos da plataforma (Python ‘pure’).

@item 
`include': diretório para arquivos de cabeçalho não específicos da plataforma para a API C do Python.

@item 
`platinclude': diretório para arquivos de cabeçalho específicos da plataforma para a API C do Python.

@item 
`scripts': diretório para arquivos de script.

@item 
`data': diretório para arquivos de dados.
@end itemize

@node Esquema de usuário,Esquema de home,Caminhos de instalação,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig sysconfig-user-scheme}@anchor{1ed0}@anchor{library/sysconfig user-scheme}@anchor{4605}
@subsubsection Esquema de usuário


Este esquema foi projetado para ser a solução mais conveniente para usuários que não têm permissão de escrita no diretório global de pacotes de sites ou não desejam instalar nele.

Os arquivos serão instalados em subdiretórios de @ref{1361,,site.USER_BASE} (escrito como @code{`userbase'} daqui em diante). Este esquema instala módulos Python puros e módulos de extensão no mesmo local (também conhecido como @ref{1ecf,,site.USER_SITE}).

@menu
* posix_user:: 
* nt_user:: 
* osx_framework_user:: 

@end menu

@node posix_user,nt_user,,Esquema de usuário
@anchor{library/sysconfig posix-user}@anchor{4606}
@subsubsection @code{posix_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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,Esquema de usuário
@anchor{library/sysconfig nt-user}@anchor{4607}
@subsubsection @code{nt_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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,Esquema de usuário
@anchor{library/sysconfig osx-framework-user}@anchor{4608}
@subsubsection @code{osx_framework_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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 Esquema de home,Esquema de prefixo,Esquema de usuário,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig home-scheme}@anchor{4609}@anchor{library/sysconfig sysconfig-home-scheme}@anchor{460a}
@subsubsection Esquema de home


A ideia por trás do “esquema home” é que você construa e mantenha um estoque pessoal de módulos Python. O nome deste esquema é derivado da ideia de um diretório “home” no Unix, uma vez que não é incomum para um usuário Unix fazer seu diretório home ter um layout semelhante a @code{/usr/} ou @code{/usr/local/}. Este esquema pode ser usado por qualquer pessoa, independentemente do sistema operacional para o qual está instalando.

@menu
* posix_home:: 

@end menu

@node posix_home,,,Esquema de home
@anchor{library/sysconfig posix-home}@anchor{460b}
@subsubsection @code{posix_home}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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 Esquema de prefixo,Funções de caminho de instalação,Esquema de home,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig prefix-scheme}@anchor{460c}@anchor{library/sysconfig sysconfig-prefix-scheme}@anchor{460d}
@subsubsection Esquema de prefixo


O “esquema prefixo” é útil quando você deseja usar uma instalação Python para realizar a compilação/instalação (ou seja, para executar o script de configuração), mas instalar módulos no diretório de módulo de terceiros de uma instalação Python diferente (ou algo que parece uma instalação diferente do Python). Se isso parece um pouco incomum, então é – é por isso que os esquemas usuário e home vêm antes. No entanto, existem pelo menos dois casos conhecidos em que o esquema prefixo será útil.

Primeiro, considere que muitas distribuições Linux colocam Python em @code{/usr}, ao invés do mais tradicional @code{/usr/local}. Isso é totalmente apropriado, já que, nesses casos, o Python é parte do “sistema” em vez de um complemento local. No entanto, se você estiver instalando módulos Python a partir do código-fonte, provavelmente deseja que eles entrem em @code{/usr/local/lib/python2.`X'} em vez de @code{/usr/lib/python2.`X'}.

Outra possibilidade é um sistema de arquivos de rede onde o nome usado para escrever em um diretório remoto é diferente do nome usado para lê-lo: por exemplo, o interpretador Python acessado como @code{/usr/local/bin/python} pode pesquisar por módulos em @code{/usr/local/lib/python2.`X'}, mas esses módulos teriam que ser instalados em, digamos, @code{/mnt/`@@server'/export/lib/python2.`X'}.

@menu
* posix_prefix:: 
* nt:: 

@end menu

@node posix_prefix,nt,,Esquema de prefixo
@anchor{library/sysconfig posix-prefix}@anchor{460e}
@subsubsection @code{posix_prefix}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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,Esquema de prefixo
@anchor{library/sysconfig nt}@anchor{460f}
@subsubsection @code{nt}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caminho

@tab

Diretório de instalação

@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 Funções de caminho de instalação,Outras funções<3>,Esquema de prefixo,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig installation-path-functions}@anchor{4610}
@subsubsection Funções de caminho de instalação


@ref{db,,sysconfig} fornece algumas funções para determinar esses caminhos de instalação.

@geindex get_scheme_names() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_scheme_names}@anchor{4611}
@deffn {Função} sysconfig.get_scheme_names ()

Retorna uma tupla contendo todos os esquemas atualmente suportados em @ref{db,,sysconfig}.
@end deffn

@geindex get_default_scheme() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_default_scheme}@anchor{193f}
@deffn {Função} sysconfig.get_default_scheme ()

Retorna o nome do esquema padrão para a plataforma atual.


Adicionado na versão 3.10: Esta função era chamada de @code{_get_default_scheme()} e considerada um detalhe de implementação.



Alterado na versão 3.11: Quando o Python é executado em um ambiente virtual, o esquema `venv' é retornado.

@end deffn

@geindex get_preferred_scheme() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_preferred_scheme}@anchor{690}
@deffn {Função} sysconfig.get_preferred_scheme (key)

Retorna um nome de esquema preferido para um layout de instalação especificado por `key'.

`key' deve ser @code{"prefix"}, @code{"home"} ou @code{"user"}.

O valor de retorno é um nome de esquema listado em @ref{4611,,get_scheme_names()}. Ele pode ser passado para as funções @ref{db,,sysconfig} que recebem um argumento `scheme', como @ref{1285,,get_paths()}.


Adicionado na versão 3.10.



Alterado na versão 3.11: Quando o Python é executado em um ambiente virtual e @code{key="prefix"}, o esquema `venv' é retornado.

@end deffn

@geindex _get_preferred_schemes() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig _get_preferred_schemes}@anchor{4612}
@deffn {Função} sysconfig._get_preferred_schemes ()

Retorna um dict contendo nomes de esquema preferidos na plataforma atual. Os implementadores e redistribuidores do Python podem adicionar seus esquemas preferidos ao valor global de nível de módulo @code{_INSTALL_SCHEMES} e modificar esta função para retornar esses nomes de esquema. Por exemplo, fornecer esquemas diferentes para os gerenciadores de pacotes de sistema e idioma usarem, de modo que os pacotes instalados por um não se misturem com os do outro.

Os usuários finais não devem usar esta função, mas @ref{193f,,get_default_scheme()} e @ref{690,,get_preferred_scheme()}.


Adicionado na versão 3.10.

@end deffn

@geindex get_path_names() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_path_names}@anchor{4613}
@deffn {Função} sysconfig.get_path_names ()

Retorna uma tupla contendo todos os nomes de caminhos atualmente suportados em @ref{db,,sysconfig}.
@end deffn

@geindex get_path() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_path}@anchor{1372}
@deffn {Função} sysconfig.get_path (name[, scheme[, vars[, expand]]])

Retorna um caminho de instalação correspondente ao caminho `name', do esquema de instalação denominado `scheme'.

`name' deve ser um valor da lista retornada por @ref{4613,,get_path_names()}.

@ref{db,,sysconfig} armazena os caminhos de instalação correspondentes a cada nome de caminho, para cada plataforma, com variáveis a serem expandidas. Por exemplo, o caminho `stdlib' para o esquema `nt' é: @code{@{base@}/Lib}.

@ref{1372,,get_path()} usará as variáveis retornadas por @ref{1064,,get_config_vars()} para expandir o caminho. Todas as variáveis possuem valores padrão para cada plataforma, portanto, pode-se chamar esta função e obter o valor padrão.

Se `scheme' for fornecido, deve ser um valor da lista retornada por @ref{4611,,get_scheme_names()}. Caso contrário, o esquema padrão para a plataforma atual é usado.

Se `vars' for fornecido, deve ser um dicionário de variáveis que atualizará o dicionário retornado por @ref{1064,,get_config_vars()}.

Se `expand' for definido como @code{False}, o caminho não será expandido usando as variáveis.

Se `name' não for encontrado, levanta uma @ref{344,,KeyError}.
@end deffn

@geindex get_paths() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_paths}@anchor{1285}
@deffn {Função} sysconfig.get_paths ([scheme[, vars[, expand]]])

Retorna um dicionário contendo todos os caminhos de instalação correspondentes a um esquema de instalação. Veja @ref{1372,,get_path()} para mais informações.

Se `esquema' não for fornecido, usará o esquema padrão para a plataforma atual.

Se `vars' for fornecido, deve ser um dicionário de variáveis que atualizará o dicionário usado para expandir os caminhos.

Se `expand' for definido como falso, os caminhos não serão expandidos.

Se `scheme' não for um esquema existente, @ref{1285,,get_paths()} vai levantar uma @ref{344,,KeyError}.
@end deffn

@node Outras funções<3>,Uso na linha de comando<8>,Funções de caminho de instalação,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig other-functions}@anchor{4614}
@subsubsection Outras funções


@geindex get_python_version() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_python_version}@anchor{1284}
@deffn {Função} sysconfig.get_python_version ()

Retorna o número da versão Python @code{MAJOR.MINOR} como uma string. Semelhante a @code{'%d.%d' % sys.version_info[:2]}.
@end deffn

@geindex get_platform() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_platform}@anchor{1283}
@deffn {Função} sysconfig.get_platform ()

Retorna uma string que identifica a plataforma atual.

Isso é usado principalmente para distinguir diretórios de construção específicos da plataforma e distribuições construídas específicas da plataforma. Geralmente inclui o nome e a versão do sistema operacional e a arquitetura (conforme fornecido por @ref{1155,,os.uname()}), embora as informações exatas incluídas dependam do sistema operacional; por exemplo, no Linux, a versão do kernel não é particularmente importante.

Exemplos de valores retornados:

Windows:


@itemize -

@item 
win-amd64 (Windows 64 bits no AMD64, isto é, x86_64, Intel64 e EM64T)

@item 
win-arm64 (Windows 64 bits no ARM64, isto é, AArch64)

@item 
win32 (todos os demais - especificamente, sys.platform é retornado)
@end itemize

SO baseado em POSIX:


@itemize -

@item 
linux-x86_64

@item 
macosx-15.5-arm64

@item 
macosx-26.0-universal2 (macOS sobre Apple Silicon ou Intel)

@item 
android-24-arm64_v8a
@end itemize

Para outras plataformas não POSIX, é retornado apenas @ref{a97,,sys.platform}.
@end deffn

@geindex is_python_build() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig is_python_build}@anchor{2dd}
@deffn {Função} sysconfig.is_python_build ()

Retorna @code{True} se o interpretador Python em execução foi construído a partir do código-fonte e está sendo executado a partir de seu local de construção, e não de um local resultante de, por exemplo, executando @code{make install} ou instalando através de um instalador binário.
@end deffn

@geindex parse_config_h() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig parse_config_h}@anchor{4615}
@deffn {Função} sysconfig.parse_config_h (fp[, vars])

Analisa um arquivo no estilo @code{config.h}.

`fp' é um objeto arquivo ou similar apontando para o arquivo @code{config.h} ou similar.

Um dicionário contendo pares nome/valor é retornado. Se um dicionário opcional for passado como segundo argumento, ele será usado no lugar de um novo dicionário e atualizado com os valores lidos no arquivo.
@end deffn

@geindex get_config_h_filename() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_config_h_filename}@anchor{4616}
@deffn {Função} sysconfig.get_config_h_filename ()

Retorna o caminho do @code{pyconfig.h}.
@end deffn

@geindex get_makefile_filename() (no módulo sysconfig)
@anchor{library/sysconfig sysconfig get_makefile_filename}@anchor{4617}
@deffn {Função} sysconfig.get_makefile_filename ()

Retorna o caminho do @code{Makefile}.
@end deffn
@anchor{library/sysconfig sysconfig-cli}@anchor{4618}
@node Uso na linha de comando<8>,,Outras funções<3>,sysconfig — Fornece acesso às informações de configuração do Python
@anchor{library/sysconfig command-line-usage}@anchor{4619}@anchor{library/sysconfig using-sysconfig-as-a-script}@anchor{461a}
@subsubsection Uso na linha de comando


Você pode usar @ref{db,,sysconfig} como um script com a opção `-m' do 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 chamada imprimirá na saída padrão as informações retornadas por @ref{1283,,get_platform()}, @ref{1284,,get_python_version()}, @ref{1372,,get_path()} e @ref{1064,,get_config_vars()}.

@node builtins — Objetos embutidos,__main__ — Ambiente de código principal,sysconfig — Fornece acesso às informações de configuração do Python,Serviços de Tempo de Execução Python
@anchor{library/builtins doc}@anchor{461b}@anchor{library/builtins builtins-built-in-objects}@anchor{461c}@anchor{library/builtins module-builtins}@anchor{12}@anchor{library/builtins translation-repo}@anchor{461d}
@subsection @code{builtins} — Objetos embutidos


@geindex module; builtins


__________________________________________________________________


Este módulo fornece acesso direto a todos os identificadores embutidos do Python; Por exemplo, @code{builtins.open} é o nome completo para a função embutida @ref{51c,,open()}.

Este módulo normalmente não é acessado explicitamente pela maioria dos aplicativos, mas pode ser útil em módulos que fornecem objetos com o mesmo nome como um valor embutido, mas em que o objeto embutido desse nome também é necessário. Por exemplo, em um módulo que deseja implementar uma função @ref{51c,,open()} que envolve o embutido @ref{51c,,open()}, este módulo pode ser usado diretamente:

@example
import builtins

def open(path):
    f = builtins.open(path, 'r')
    return UpperCaser(f)

class UpperCaser:
    '@w{'}'Envoltório em volta de um arquivo que converte saída para maiúsculo.'@w{'}'

    def __init__(self, f):
        self._f = f

    def read(self, count=-1):
        return self._f.read(count).upper()

    # ...
@end example

Como um detalhe de implementação, a maioria dos módulos tem o nome @code{__builtins__} disponibilizados como parte de seus globais. O valor de @code{__builtins__} normalmente, este é o módulo ou o valor desse módulo @ref{55b,,__dict__} atributo. Uma vez que este é um detalhe de implementação, ele não pode ser usado por implementações alternativas do Python.


@subsubheading Ver também



@itemize *

@item 
@ref{231a,,Constantes embutidas}

@item 
@ref{19b1,,Exceções embutidas}

@item 
@ref{129e,,Funções embutidas}

@item 
@ref{2322,,Tipos embutidos}
@end itemize


@node __main__ — Ambiente de código principal,warnings — Controle de avisos,builtins — Objetos embutidos,Serviços de Tempo de Execução Python
@anchor{library/__main__ doc}@anchor{461e}@anchor{library/__main__ main-top-level-code-environment}@anchor{461f}@anchor{library/__main__ module-__main__}@anchor{1}@anchor{library/__main__ translation-repo}@anchor{4620}
@subsection @code{__main__} — Ambiente de código principal


@geindex module; __main__


__________________________________________________________________


Em Python, o nome especial @code{__main__} é usado em duas construções importantes:


@enumerate 

@item 
O nome do ambiente principal do programa, que pode ser verificado usando a expressão @code{__name__ == '__main__'}; e

@item 
o arquivo @code{__main__.py} em pacotes Python.
@end enumerate

Ambas as formas estão relacionadas aos módulos Python; como os usuários interagem com eles e como eles interagem entre si. Eles serão explicados em detalhes abaixo. Se você ainda não conhece módulos Python, veja a seção @ref{1ddc,,Módulos} para uma introdução.

@menu
* __name__ == '__main__':: 
* __main__.py em pacotes Python: __main__ py em pacotes Python. 
* import __main__:: 

@end menu

@node __name__ == '__main__',__main__ py em pacotes Python,,__main__ — Ambiente de código principal
@anchor{library/__main__ name-equals-main}@anchor{4621}@anchor{library/__main__ name-main}@anchor{4622}
@subsubsection @code{__name__ == '__main__'}


Quando um pacote ou módulo Python é importado, @code{__name__} é definido como o nome do módulo. Normalmente, este é o nome do próprio arquivo Python sem a extensão @code{.py}:

@example
>>> import configparser
>>> configparser.__name__
'configparser'
@end example

Caso o arquivo seja parte de um pacote, @code{__name__} também incluirá o nome da pasta raiz do pacote.

@example
>>> from concurrent.futures import process
>>> process.__name__
'concurrent.futures.process'
@end example

Porém, se o módulo for executado como o código principal, @code{__name__} passa a ser definido como a string @code{'__main__'}

@menu
* O que é o “ambiente de código principal”?:: 
* Uso idiomático:: 
* Considerações sobre pacotes:: 

@end menu

@node O que é o “ambiente de código principal”?,Uso idiomático,,__name__ == '__main__'
@anchor{library/__main__ what-is-the-top-level-code-environment}@anchor{4623}
@subsubsection O que é o “ambiente de código principal”?


@code{__main__} é o nome do ambiente principal no qual o código é executado. “Ambiente de código principal” é o primeiro módulo Python definido pelo usuário que começa a ser executado. É considerado principal porque ele importa todos os outros módulos que o programa precisa. As vezes, “ambiente principal” também pode ser chamado de “ponto de entrada” da aplicação.

O ambiente de código principal pode ser:


@itemize *

@item 
o escopo de um prompt de comando interativo:

@example
>>> __name__
'__main__'
@end example

@item 
o módulo Python passado ao interpretador do Python como um argumento correspondente ao nome do arquivo:

@example
$ python helloworld.py
Hello, world!
@end example

@item 
o módulo ou pacote Python passado ao interpretador do Python com o argumento @ref{5e1,,-m}:

@example
$ python -m tarfile
usage: tarfile.py [-h] [-v] (...)
@end example

@item 
código Python lido pelo interpretador através da entrada padrão de linha de comando:

@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 Python passado ao interpretador do Python com o argumento @ref{5e0,,-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

Em cada uma destas situações, a variável especial @code{__name__} passa a ser definida como @code{'__main__'}.

Como resultado, um módulo pode saber se está ou não sendo executado no ambiente principal verificando seu próprio @code{__name__}, que habilita um termo comum para executar código condicionalmente quando o módulo não é inicializado a partir de uma instrução de importação:

@example
if __name__ == '__main__':
    # Executa quando o módulo não é inicializado por uma instrução de importação.
    ...
@end example


@subsubheading Ver também


Para uma visão mais detalhada sobre como @code{__name__} é definido em todas as situações, veja a sessão @ref{1ddc,,Módulos}.


@node Uso idiomático,Considerações sobre pacotes,O que é o “ambiente de código principal”?,__name__ == '__main__'
@anchor{library/__main__ idiomatic-usage}@anchor{4624}
@subsubsection Uso idiomático


Alguns módulos contém códigos que são específicos para serem usados como scripts, como análise de argumentos através de linha de comando ou leitura de dados da entrada padrão. Se um módulo como o citado for importado em um outro módulo diferente, por exemplo em testes unitários, o código do script também seria executado de forma indesejada.

É aqui onde o uso do trecho de código @code{if __name__ == '__main__'} revela-se útil. Os códigos dentro desta condicional não rodarão ao não ser que o módulo seja executado através do ambiente principal.

Colocar o mínimo de instruções possível no bloco abaixo de @code{if __name__ == '__main__'} pode melhorar a clareza e a precisão do código. Na maioria das vezes, uma função chamada de @code{main} encapsula o comportamento principal do programa:

@example
# echo.py

import shlex
import sys

def echo(phrase: str) -> None:
   """Um invólucro fictício sobre print."""
   # com propósito de demonstração, imagine que existe
   # uma lógica reutilizável valiosa nesta função
   print(phrase)

def main() -> int:
    """Ecoa os argumentos de entrada para a saída padrão."""
    phrase = shlex.join(sys.argv)
    echo(phrase)
    return 0

if __name__ == '__main__':
    sys.exit(main())  # a próxima seção explica o uso de sys.exit
@end example

Repare quem se o módulo, ao invés de ter encapsulado o código dentro da função @code{main}, fosse colocado direto dentro do bloco @code{if __name__ == '__main__'}, a variável @code{phrase} seria global para todo o módulo. Isto é suscetível à erros pois outras funções dentro do módulo poderiam inadvertidamente usar a variável global ao invés da local. A função @code{main} resolve este problema.

O uso da função @code{main} tem o benefício adicional de a própria função @code{echo} ser isolada e importável em outro lugar. Quando @code{echo.py} é importado, as funções @code{echo} e @code{main} serão definidas, mas nenhuma delas será chamada por conta do bloco @code{__name__ != '__main__'}.

@node Considerações sobre pacotes,,Uso idiomático,__name__ == '__main__'
@anchor{library/__main__ packaging-considerations}@anchor{4625}
@subsubsection Considerações sobre pacotes


@code{main} são funções frequentemente usadas para criar ferramentas de linha de comando especificando-as como pontos de entrada para scripts de console. Quando isto é feito, pip@footnote{https://pip.pypa.io/} insere a chamada da função em um modelo de script, onde o valor de retorno de @code{main} é passado para @ref{138e,,sys.exit()}. Por exemplo:

@example
sys.exit(main())
@end example

Uma vez que a chamada à @code{main} está embutida dentro de @ref{138e,,sys.exit()}, a expectativa é que a sua função retorne somente valores aceitável para @ref{138e,,sys.exit()}; normalmente um inteiro ou @code{None} (retornado de forma implícita, caso a sua função não tenha uma instrução de retorno).

Seguindo proativamente essa convenção, nosso módulo terá o mesmo comportamento quando executado diretamente (ou seja, @code{python echo.py}) como terá também se posteriormente criarmos um pacote como um ponto de entrada de script de console em um pacote instalável via pip.

Em particular, tenha cuidado ao retornar strings de sua função @code{main}. @ref{138e,,sys.exit()} interpretará um argumento de string como uma mensagem de falha, então seu programa terá um código de saída @code{1}, indicando falha, e a string será escrita em @ref{940,,sys.stderr}. O exemplo anterior de @code{echo.py} exemplifica o uso da convenção @code{sys.exit(main())}.


@subsubheading Ver também


O Guia de Usuário para Empacotamento de Python@footnote{https://packaging.python.org/} contém uma coleção de tutoriais e referências sobre como distribuir e instalar pacotes Python com ferramentas modernas.


@node __main__ py em pacotes Python,import __main__,__name__ == '__main__',__main__ — Ambiente de código principal
@anchor{library/__main__ main-py-in-python-packages}@anchor{4626}
@subsubsection @code{__main__.py} em pacotes Python


Se você não estiver familiarizado com pacotes Python, veja a seção @ref{1ded,,Pacotes} do tutorial. Mais comumente, o arquivo @code{__main__.py} é usado para fornecer uma interface de linha de comando para um pacote. Considere o seguinte pacote hipotético, “bandclass”:

@example
bandclass
  ├── __init__.py
  ├── __main__.py
  └── student.py
@end example

@code{__main__.py} será executado quando o próprio pacote for invocado diretamente da linha de comando usando o sinalizador @ref{5e1,,-m}. Por exemplo:

@example
$ python -m bandclass
@end example

Este comando fará com que @code{__main__.py} seja executado. Como você utiliza esse mecanismo dependerá da natureza do pacote que você está escrevendo, mas neste caso hipotético, pode fazer sentido permitir que o professor procure alunos:

@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'Estudante encontrado(a): @{search_students(student_name)@}')
@end example

Observe que @code{from .student import search_students} é um exemplo de importação relativa. Esse estilo de importação pode ser usado ao fazer referência a módulos em um pacote. Para mais detalhes, veja @ref{1df2,,Referências em um mesmo pacote} na seção @ref{1ddc,,Módulos} do tutorial.

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

@end menu

@node Uso idiomático<2>,,,__main__ py em pacotes Python
@anchor{library/__main__ id1}@anchor{4627}
@subsubsection Uso idiomático


O conteúdo do @code{__main__.py} normalmente não é protegido por um bloco @code{if __name__ == '__main__'} .  Em vez disso, esses arquivos são mantidos curtos e importa funções para serem executados a partir de outros módulos.  Esses outros módulos podem então ter suas unidades facilmente testadas e são adequadamente reutilizáveis.

Se usado, o bloco condicional @code{if __name__ == '__main__'} ainda funcionará como esperado para o arquivo @code{__main__.py} dentro de um pacote, pois seu atributo @code{__name__} incluirá o caminho do pacote se importado:

@example
>>> import asyncio.__main__
>>> asyncio.__main__.__name__
'asyncio.__main__'
@end example

Porém, isso não funcionará para arquivos @code{__main__.py} no diretório raiz de um arquivo @code{.zip}. Portanto, para consistência, é preferível um @code{__main__.py} mínimo sem uma verificação de @code{__name__}.


@subsubheading Ver também


Veja @ref{111,,venv}, da biblioteca padrão, para um exemplo de pacote com um @code{__main__.py} minimalista. Ele não contém um bloco @code{if __name__ == '__main__'}. Você pode invocá-lo com @code{python -m venv [directory]}.

Veja @ref{be,,runpy} para mais detalhes sobre o sinalizador @ref{5e1,,-m} para o executável do interpretador.

Veja @ref{130,,zipapp} para saber como executar aplicativos compactados como arquivos `.zip'. Nesse caso, o Python procura um arquivo @code{__main__.py} no diretório raiz do arquivo.


@node import __main__,,__main__ py em pacotes Python,__main__ — Ambiente de código principal
@anchor{library/__main__ import-main}@anchor{4628}
@subsubsection @code{import __main__}


Independentemente do módulo com o qual um programa Python foi iniciado, outros módulos executados no mesmo programa podem importar o escopo do ambiente principal (@ref{1ddd,,espaço de nomes}) importando o módulo @code{__main__}. Isso não faz a importação de um arquivo @code{__main__.py}, mas sim qualquer módulo que recebeu o nome especial @code{'__main__'}.

Aqui está um módulo de exemplo que consome o espaço de nomes @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('Defina a variável `my_name`!')

    if '__file__' in dir(__main__):
        print(__main__.my_name, "encontrado no arquivo", __main__.__file__)
    else:
        print(__main__.my_name)
@end example

Exemplo de uso deste módulo pode ser como abaixo:

@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

Agora, se iniciarmos nosso programa, o resultado seria assim:

@example
$ python start.py
Defina a variável `my_name`!
@end example

O código de saída do programa seria 1, indicando um erro. Descomentar a linha com @code{my_name = "Dinsdale"} corrige o programa e agora ele sai com o código de status 0, indicando sucesso:

@example
$ python start.py
Dinsdale encontrado no arquivo /path/to/start.py
@end example

Observe que a importação de @code{__main__} não causa nenhum problema com a execução involuntária de código principal destinado ao uso de script que é colocado no bloco @code{if __name__ == "__main__"} do módulo @code{start}. Por que isso funciona?

O Python insere um módulo @code{__main__} vazio em @ref{1636,,sys.modules} na inicialização do interpretador e o preenche executando o código principal. Em nosso exemplo, este é o módulo @code{start} que executa linha por linha e importa @code{namely}. Por sua vez, @code{namely} importa @code{__main__} (que é realmente @code{start}). Isso é um ciclo de importação! Felizmente, como o módulo @code{__main__} parcialmente preenchido está presente em @ref{1636,,sys.modules}, o Python o passa para @code{namely}. Veja @ref{219a,,Considerações especiais sobre __main__} na referência do sistema de importação para detalhes sobre como isso funciona.

O REPL do Python é outro exemplo de um “ambiente principal”, então qualquer coisa definida no REPL se torna parte do escopo do @code{__main__}:

@example
>>> import namely
>>> namely.did_user_define_their_name()
False
>>> namely.print_user_name()
Traceback (most recent call last):
...
ValueError: Defina a variável `my_name`!
>>> my_name = 'Jabberwocky'
>>> namely.did_user_define_their_name()
True
>>> namely.print_user_name()
Jabberwocky
@end example

Note que neste caso o escopo @code{__main__} não contém um atributo @code{__file__}, pois é interativo.

O escopo @code{__main__} é usado na implementação de @ref{a5,,pdb} e @ref{bd,,rlcompleter}.

@node warnings — Controle de avisos,dataclasses — Data Classes,__main__ — Ambiente de código principal,Serviços de Tempo de Execução Python
@anchor{library/warnings doc}@anchor{4629}@anchor{library/warnings module-warnings}@anchor{112}@anchor{library/warnings translation-repo}@anchor{462a}@anchor{library/warnings warnings-warning-control}@anchor{462b}
@subsection @code{warnings} — Controle de avisos


@geindex module; warnings

`Código-fonte:' Lib/warnings.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/warnings.py}

@geindex avisos


__________________________________________________________________


As mensagens de aviso são normalmente emitidas em situações em que é útil alertar o usuário sobre alguma condição em um programa, em que essa condição (normalmente) não garante o levantamento de uma exceção nem o encerramento do programa. Por exemplo, pode-se querer emitir um aviso quando um programa usa um módulo obsoleto.

Pessoas que programam em Python emitem avisos chamando a função @ref{1562,,warn()} definida neste módulo. (Com C usam @ref{1494,,PyErr_WarnEx()}; veja @ref{462c,,Tratamento de exceções} para detalhes).

Mensagens de aviso são normalmente escritas no @ref{940,,sys.stderr}, mas sua disposição pode ser alterada de forma flexível, desde ignorar todos os avisos até transformá-los em exceções. A disposição dos avisos pode variar de acordo com a @ref{2449,,categoria de aviso}, o texto da mensagem de aviso e o local de origem em que ela é emitida. As repetições de um aviso específico para o mesmo local de origem são normalmente suprimidas.

Existem duas etapas no controle de avisos: primeiro, cada vez que um aviso é emitido, determina-se se uma mensagem deve ser emitida ou não; a seguir, se uma mensagem deve ser emitida, ela é formatada e impressa usando um gancho configurável pelo usuário.

A determinação de emitir ou não uma mensagem de aviso é controlada pelo @ref{8cf,,filtro de aviso}, que é uma sequência de regras e ações correspondentes. As regras podem ser adicionadas ao filtro chamando @ref{14f1,,filterwarnings()} e redefinidas para o estado padrão chamando @ref{462d,,resetwarnings()}.

A exibição de mensagens de aviso é feita chamando @ref{462e,,showwarning()}, que pode ser substituída; a implementação padrão desta função formata a mensagem chamando @ref{1b8d,,formatwarning()}, que também está disponível para uso por implementações personalizadas.


@subsubheading Ver também


@ref{2e89,,logging.captureWarnings()} permite que você manipule todos os avisos com a infraestrutura de registro padrão.


@menu
* Categorias de avisos:: 
* O filtro de avisos:: 
* Temporarily Suppressing Warnings:: 
* Testing Warnings:: 
* Updating Code For New Versions of Dependencies:: 
* Funções disponíveis:: 
* Gerenciadores de contexto disponíveis:: 

@end menu

@node Categorias de avisos,O filtro de avisos,,warnings — Controle de avisos
@anchor{library/warnings id1}@anchor{462f}@anchor{library/warnings warning-categories}@anchor{2449}
@subsubsection Categorias de avisos


Existem várias exceções embutidas que representam categorias de aviso. Essa categorização é útil para filtrar grupos de avisos.

Embora sejam tecnicamente @ref{2447,,exceções embutidas}, elas são documentadas aqui, porque conceitualmente pertencem ao mecanismo de avisos.

O código do usuário pode definir categorias de aviso adicionais criando uma subclasse de uma das categorias de aviso padrão. Uma categoria de aviso deve ser sempre uma subclasse da classe  @ref{244a,,Warning}.

As seguintes classes de categorias de avisos estão definidas atualmente:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Classe

@tab

Descrição

@item

@ref{244a,,Warning}

@tab

Esta é a classe base de todas as classes de categoria de aviso. É uma subclasse de @ref{9e2,,Exception}.

@item

@ref{244b,,UserWarning}

@tab

A categoria padrão para @ref{1562,,warn()}.

@item

@ref{1a5,,DeprecationWarning}

@tab

Categoria base para avisos sobre recursos descontinuados quando esses avisos são destinados a outros desenvolvedores Python (ignorado por padrão, a menos que acionado por código em @code{__main__}).

@item

@ref{466,,SyntaxWarning}

@tab

Categoria base para avisos sobre recursos sintáticos duvidosos (normalmente emitidos ao compilar código-fonte Python e, portanto, não podem ser suprimidos por filtros de tempo de execução)

@item

@ref{1bd,,RuntimeWarning}

@tab

Categoria base para avisos sobre recursos duvidosos de tempo de execução.

@item

@ref{415,,FutureWarning}

@tab

Categoria base para avisos sobre recursos descontinuados quando esses avisos se destinam a usuários finais de aplicações escritas em Python.

@item

@ref{8ce,,PendingDeprecationWarning}

@tab

Categoria base para avisos sobre recursos que serão descontinuados no futuro (ignorados por padrão).

@item

@ref{4fa,,ImportWarning}

@tab

Categoria base para avisos acionados durante o processo de importação de um módulo (ignorado por padrão).

@item

@ref{146b,,UnicodeWarning}

@tab

Categoria base para avisos relacionados a Unicode.

@item

@ref{c3d,,BytesWarning}

@tab

Categoria base para avisos relacionados a @ref{1c2,,bytes} e @ref{2ea,,bytearray}.

@item

@ref{244,,ResourceWarning}

@tab

Categoria base para avisos relacionados a uso de recursos (ignorado por padrão).

@end multitable



Alterado na versão 3.7: Anteriormente, @ref{1a5,,DeprecationWarning} e @ref{415,,FutureWarning} eram diferenciadas com base em se um recurso estava sendo removido completamente ou mudando seu comportamento. Elas agora são diferenciadas com base em seu público-alvo e na maneira como são tratadas pelos filtros de avisos padrão.


@node O filtro de avisos,Temporarily Suppressing Warnings,Categorias de avisos,warnings — Controle de avisos
@anchor{library/warnings the-warnings-filter}@anchor{4630}@anchor{library/warnings warning-filter}@anchor{8cf}
@subsubsection O filtro de avisos


O filtro de avisos controla se os avisos são ignorados, exibidos ou transformados em erros (levantando uma exceção).

Conceitualmente, o filtro de avisos mantém uma lista ordenada de especificações de filtro; qualquer aviso específico é comparado a cada especificação de filtro na lista, até que uma correspondência seja encontrada; o filtro determina a disposição da correspondência. Cada entrada é uma tupla no formato (`action', `message', `category', `module', `lineno'), sendo:


@itemize *

@item 
`action' é uma das seguintes strings:


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Valor

@tab

Disposição

@item

@code{"default"}

@tab

exibe a primeira ocorrência de avisos correspondentes para cada local (módulo + número da linha) onde o aviso é emitido

@item

@code{"error"}

@tab

transforma avisos correspondentes em exceções

@item

@code{"ignore"}

@tab

nunca exibe avisos correspondentes

@item

@code{"always"}

@tab

sempre exibe avisos correspondentes

@item

@code{"module"}

@tab

exibe a primeira ocorrência de avisos correspondentes para cada módulo onde o aviso é emitido (independentemente do número da linha)

@item

@code{"once"}

@tab

exibe apenas a primeira ocorrência de avisos correspondentes, independentemente da localização

@end multitable


@item 
`message' é uma string contendo uma expressão regular à qual o início da mensagem de aviso deve corresponder, sem distinção entre maiúsculas e minúsculas. Em @ref{8cd,,-W} e em 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}, `message' é uma string literal que o início da mensagem de aviso deve conter (sem distinção entre maiúsculas e minúsculas), ignorando qualquer espaço em branco no início ou no fim de `message'.

@item 
`category' é uma classe (uma subclasse de @ref{244a,,Warning}) da qual a categoria de aviso deve ser uma subclasse para corresponder.

@item 
`module' é uma string contendo uma expressão regular que o início do nome do módulo totalmente qualificado deve corresponder, diferenciando maiúsculas de minúsculas. Em @ref{8cd,,-W} e em 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}, `module' é uma string literal cujo nome, o módulo totalmente qualificado, deve ser igual a (diferenciando maiúsculas de minúsculas), ignorando qualquer espaço em branco no início ou no fim de `module'.

@item 
`lineno' é um número inteiro que deve corresponder ao número da linha onde ocorreu o aviso, ou @code{0} para corresponder a todos os números de linha.
@end itemize

Como a classe @ref{244a,,Warning} é derivada da classe embutida @ref{9e2,,Exception}, para transformar um aviso em um erro, basta levantarmos @code{category(message)}.

Se um aviso for relatado e não corresponder a nenhum filtro registrado, a ação “default” (padrão em inglês) será aplicada (daí o nome).

@menu
* Critérios de supressão de avisos repetidos:: 
* Descrevendo filtros de aviso:: 
* Filtro de avisos padrão:: 
* Overriding the default filter:: 

@end menu

@node Critérios de supressão de avisos repetidos,Descrevendo filtros de aviso,,O filtro de avisos
@anchor{library/warnings id2}@anchor{4631}@anchor{library/warnings repeated-warning-suppression-criteria}@anchor{4632}
@subsubsection Critérios de supressão de avisos repetidos


Os filtros que suprimem avisos repetidos aplicam os seguintes critérios para determinar se um aviso é considerado uma repetição:


@itemize -

@item 
@code{"default"}: Um aviso é considerado uma repetição somente se (`message', `category', `module', `lineno') forem todos iguais.

@item 
@code{"module"}: Um aviso é considerado uma repetição se (`message', `category', `module') forem os mesmos, ignorando o número da linha.

@item 
@code{"once"}: Um aviso é considerado uma repetição se (`message', `category') forem os mesmos, ignorando o módulo e o número da linha.
@end itemize

@node Descrevendo filtros de aviso,Filtro de avisos padrão,Critérios de supressão de avisos repetidos,O filtro de avisos
@anchor{library/warnings describing-warning-filters}@anchor{1ec1}@anchor{library/warnings id3}@anchor{4633}
@subsubsection Descrevendo filtros de aviso


O filtro de avisos é inicializado pelas opções @ref{8cd,,-W} passadas para a linha de comando do interpretador Python e para a variável de ambiente 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}. O interpretador salva os argumentos para todas as entradas fornecidas sem interpretação em @ref{3b0,,sys.warnoptions}; o módulo @ref{112,,warnings} os analisa na primeira importação (opções inválidas são ignoradas após a exibição de uma mensagem em @ref{940,,sys.stderr}).

Os filtros de avisos individuais são especificados como uma sequência de campos separados por dois pontos:

@example
action:message:category:module:line
@end example

The meaning of each of these fields is as described in @ref{8cf,,O filtro de avisos}.
When listing multiple filters on a single line (as for
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS}), the individual filters are separated by commas and
the filters listed later take precedence over those listed before them (as
they’re applied left-to-right, and the most recently applied filters take
precedence over earlier ones).

Commonly used warning filters apply to either all warnings, warnings in a
particular category, or warnings raised by particular modules or packages.
Some examples:

@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 avisos padrão,Overriding the default filter,Descrevendo filtros de aviso,O filtro de avisos
@anchor{library/warnings default-warning-filter}@anchor{4634}@anchor{library/warnings id4}@anchor{4635}
@subsubsection Filtro de avisos padrão


By default, Python installs several warning filters, which can be overridden by
the @ref{8cd,,-W} command-line option, the 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} environment
variable and calls to @ref{14f1,,filterwarnings()}.

In regular release builds, the default warning filter has the following entries
(in order of precedence):

@example
default::DeprecationWarning:__main__
ignore::DeprecationWarning
ignore::PendingDeprecationWarning
ignore::ImportWarning
ignore::ResourceWarning
@end example

In a @ref{1f9,,debug build}, the list of default warning filters is empty.


Alterado na versão 3.2: @ref{1a5,,DeprecationWarning} is now ignored by default in addition to
@ref{8ce,,PendingDeprecationWarning}.



Alterado na versão 3.7: @ref{1a5,,DeprecationWarning} is once again shown by default when triggered
directly by code in @code{__main__}.



Alterado na versão 3.7: @ref{c3d,,BytesWarning} no longer appears in the default filter list and is
instead configured via @ref{3b0,,sys.warnoptions} when @ref{5e3,,-b} is specified
twice.


@node Overriding the default filter,,Filtro de avisos padrão,O filtro de avisos
@anchor{library/warnings overriding-the-default-filter}@anchor{4636}@anchor{library/warnings warning-disable}@anchor{4637}
@subsubsection Overriding the default filter


Developers of applications written in Python may wish to hide `all' Python level
warnings from their users by default, and only display them when running tests
or otherwise working on the application. The @ref{3b0,,sys.warnoptions} attribute
used to pass filter configurations to the interpreter can be used as a marker to
indicate whether or not warnings should be disabled:

@example
import sys

if not sys.warnoptions:
    import warnings
    warnings.simplefilter("ignore")
@end example

Developers of test runners for Python code are advised to instead ensure that
`all' warnings are displayed by default for the code under test, using code
like:

@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

Finally, developers of interactive shells that run user code in a namespace
other than @code{__main__} are advised to ensure that @ref{1a5,,DeprecationWarning}
messages are made visible by default, using code like the following (where
@code{user_ns} is the module used to execute code entered interactively):

@example
import warnings
warnings.filterwarnings("default", category=DeprecationWarning,
                                   module=user_ns.get("__name__"))
@end example

@node Temporarily Suppressing Warnings,Testing Warnings,O filtro de avisos,warnings — Controle de avisos
@anchor{library/warnings temporarily-suppressing-warnings}@anchor{4638}@anchor{library/warnings warning-suppress}@anchor{4639}
@subsubsection Temporarily Suppressing Warnings


If you are using code that you know will raise a warning, such as a deprecated
function, but do not want to see the warning (even when warnings have been
explicitly configured via the command line), then it is possible to suppress
the warning using the @ref{584,,catch_warnings} context manager:

@example
import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    fxn()
@end example

While within the context manager all warnings will simply be ignored. This
allows you to use known-deprecated code without having to see the warning while
not suppressing the warning for other code that might not be aware of its use
of deprecated code.  Note: this can only be guaranteed in a single-threaded
application. If two or more threads use the @ref{584,,catch_warnings} context
manager at the same time, the behavior is undefined.

@node Testing Warnings,Updating Code For New Versions of Dependencies,Temporarily Suppressing Warnings,warnings — Controle de avisos
@anchor{library/warnings testing-warnings}@anchor{463a}@anchor{library/warnings warning-testing}@anchor{463b}
@subsubsection Testing Warnings


To test warnings raised by code, use the @ref{584,,catch_warnings} context
manager. With it you can temporarily mutate the warnings filter to facilitate
your testing. For instance, do the following to capture all raised warnings to
check:

@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

One can also cause all warnings to be exceptions by using @code{error} instead of
@code{always}. One thing to be aware of is that if a warning has already been
raised because of a @code{once}/@code{default} rule, then no matter what filters are
set the warning will not be seen again unless the warnings registry related to
the warning has been cleared.

Once the context manager exits, the warnings filter is restored to its state
when the context was entered. This prevents tests from changing the warnings
filter in unexpected ways between tests and leading to indeterminate test
results. The @ref{462e,,showwarning()} function in the module is also restored to
its original value.  Note: this can only be guaranteed in a single-threaded
application. If two or more threads use the @ref{584,,catch_warnings} context
manager at the same time, the behavior is undefined.

When testing multiple operations that raise the same kind of warning, it
is important to test them in a manner that confirms each operation is raising
a new warning (e.g. set warnings to be raised as exceptions and check the
operations raise exceptions, check that the length of the warning list
continues to increase after each operation, or else delete the previous
entries from the warnings list before each new operation).

@node Updating Code For New Versions of Dependencies,Funções disponíveis,Testing Warnings,warnings — Controle de avisos
@anchor{library/warnings updating-code-for-new-versions-of-dependencies}@anchor{463c}@anchor{library/warnings warning-ignored}@anchor{42d0}
@subsubsection Updating Code For New Versions of Dependencies


Warning categories that are primarily of interest to Python developers (rather
than end users of applications written in Python) are ignored by default.

Notably, this “ignored by default” list includes @ref{1a5,,DeprecationWarning}
(for every module except @code{__main__}), which means developers should make sure
to test their code with typically ignored warnings made visible in order to
receive timely notifications of future breaking API changes (whether in the
standard library or third party packages).

In the ideal case, the code will have a suitable test suite, and the test runner
will take care of implicitly enabling all warnings when running tests
(the test runner provided by the @ref{106,,unittest} module does this).

In less ideal cases, applications can be checked for use of deprecated
interfaces by passing @ref{8cd,,-Wd} to the Python interpreter (this is
shorthand for @code{-W default}) or setting @code{PYTHONWARNINGS=default} in
the environment. This enables default handling for all warnings, including those
that are ignored by default. To change what action is taken for encountered
warnings you can change what argument is passed to @ref{8cd,,-W} (e.g.
@code{-W error}). See the @ref{8cd,,-W} flag for more details on what is
possible.

@node Funções disponíveis,Gerenciadores de contexto disponíveis,Updating Code For New Versions of Dependencies,warnings — Controle de avisos
@anchor{library/warnings available-functions}@anchor{463d}@anchor{library/warnings warning-functions}@anchor{463e}
@subsubsection Funções disponíveis


@geindex warn() (no módulo warnings)
@anchor{library/warnings warnings warn}@anchor{1562}
@deffn {Função} warnings.warn (message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=())

Issue a warning, or maybe ignore it or raise an exception.  The `category'
argument, if given, must be a @ref{2449,,warning category class}; it
defaults to @ref{244b,,UserWarning}.  Alternatively, `message' can be a @ref{244a,,Warning} instance,
in which case `category' will be ignored and @code{message.__class__} will be used.
In this case, the message text will be @code{str(message)}. This function raises an
exception if the particular warning issued is changed into an error by the
@ref{8cf,,warnings filter}.  The `stacklevel' argument can be used by wrapper
functions written in Python, like this:

@example
def deprecated_api(message):
    warnings.warn(message, DeprecationWarning, stacklevel=2)
@end example

This makes the warning refer to @code{deprecated_api}’s caller, rather than to
the source of @code{deprecated_api} itself (since the latter would defeat the
purpose of the warning message).

The `skip_file_prefixes' keyword argument can be used to indicate which
stack frames are ignored when counting stack levels. This can be useful when
you want the warning to always appear at call sites outside of a package
when a constant `stacklevel' does not fit all call paths or is otherwise
challenging to maintain. If supplied, it must be a tuple of strings. When
prefixes are supplied, stacklevel is implicitly overridden to be @code{max(2,
stacklevel)}. To cause a warning to be attributed to the caller from
outside of the current package you might write:

@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

This makes the warning refer to both the @code{example.lower.one_way()} and
@code{example.higher.another_way()} call sites only from calling code living
outside of @code{example} package.

`source', if supplied, is the destroyed object which emitted a
@ref{244,,ResourceWarning}.


Alterado na versão 3.6: Adicionado o parâmetro `source'.



Alterado na versão 3.12: Added `skip_file_prefixes'.

@end deffn

@geindex warn_explicit() (no módulo warnings)
@anchor{library/warnings warnings warn_explicit}@anchor{d22}
@deffn {Função} warnings.warn_explicit (message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)

This is a low-level interface to the functionality of @ref{1562,,warn()}, passing in
explicitly the message, category, filename and line number, and optionally
other arguments.
`message' must be a string and `category' a subclass of @ref{244a,,Warning} or
`message' may be a @ref{244a,,Warning} instance, in which case `category' will be
ignored.

`module', if supplied, should be the module name.
If no module is passed, the filename with @code{.py} stripped is used.

`registry', if supplied, should be the @code{__warningregistry__} dictionary
of the module.
If no registry is passed, each warning is treated as the first occurrence,
that is, filter actions @code{"default"}, @code{"module"} and @code{"once"} are
handled as @code{"always"}.

`module_globals', if supplied, should be the global namespace in use by the code
for which the warning is issued.  (This argument is used to support displaying
source for modules found in zipfiles or other non-filesystem import
sources).

`source', if supplied, is the destroyed object which emitted a
@ref{244,,ResourceWarning}.


Alterado na versão 3.6: Adiciona o parâmetro `source'.

@end deffn

@geindex showwarning() (no módulo warnings)
@anchor{library/warnings warnings showwarning}@anchor{462e}
@deffn {Função} warnings.showwarning (message, category, filename, lineno, file=None, line=None)

Write a warning to a file.  The default implementation calls
@code{formatwarning(message, category, filename, lineno, line)} and writes the
resulting string to `file', which defaults to @ref{940,,sys.stderr}.  You may replace
this function with any callable by assigning to @code{warnings.showwarning}.
`line' is a line of source code to be included in the warning
message; if `line' is not supplied, @ref{462e,,showwarning()} will
try to read the line specified by `filename' and `lineno'.
@end deffn

@geindex formatwarning() (no módulo warnings)
@anchor{library/warnings warnings formatwarning}@anchor{1b8d}
@deffn {Função} warnings.formatwarning (message, category, filename, lineno, line=None)

Format a warning the standard way.  This returns a string which may contain
embedded newlines and ends in a newline.  `line' is a line of source code to
be included in the warning message; if `line' is not supplied,
@ref{1b8d,,formatwarning()} will try to read the line specified by `filename' and
`lineno'.
@end deffn

@geindex filterwarnings() (no módulo warnings)
@anchor{library/warnings warnings filterwarnings}@anchor{14f1}
@deffn {Função} warnings.filterwarnings (action, message='@w{'}, category=Warning, module='@w{'}, lineno=0, append=False)

Insert an entry into the list of @ref{8cf,,warnings filter specifications}.  The entry is inserted at the front by default; if
`append' is true, it is inserted at the end.  This checks the types of the
arguments, compiles the `message' and `module' regular expressions, and
inserts them as a tuple in the list of warnings filters.  Entries closer to
the front of the list override entries later in the list, if both match a
particular warning.  Omitted arguments default to a value that matches
everything.
@end deffn

@geindex simplefilter() (no módulo warnings)
@anchor{library/warnings warnings simplefilter}@anchor{6c1}
@deffn {Função} warnings.simplefilter (action, category=Warning, lineno=0, append=False)

Insert a simple entry into the list of @ref{8cf,,warnings filter specifications}.  The meaning of the function parameters is as for
@ref{14f1,,filterwarnings()}, but regular expressions are not needed as the filter
inserted always matches any message in any module as long as the category and
line number match.
@end deffn

@geindex resetwarnings() (no módulo warnings)
@anchor{library/warnings warnings resetwarnings}@anchor{462d}
@deffn {Função} warnings.resetwarnings ()

Reset the warnings filter.  This discards the effect of all previous calls to
@ref{14f1,,filterwarnings()}, including that of the @ref{8cd,,-W} command line options
and calls to @ref{6c1,,simplefilter()}.
@end deffn

@geindex deprecated() (no módulo warnings)
@anchor{library/warnings warnings deprecated}@anchor{160}
@deffn {Função} @@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{26d,,static type checkers}
will also generate a diagnostic on usage of the deprecated object.

Uso:

@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{41c6,,@@~typing.overload} decorator
for the attribute to exist on the overload as returned by
@ref{6ae,,typing.get_overloads()}.


Adicionado na versão 3.13: See 
@geindex Propostas de Melhorias do Python; PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}.

@end deffn

@node Gerenciadores de contexto disponíveis,,Funções disponíveis,warnings — Controle de avisos
@anchor{library/warnings available-context-managers}@anchor{463f}
@subsubsection Gerenciadores de contexto disponíveis


@geindex catch_warnings (classe em warnings)
@anchor{library/warnings warnings catch_warnings}@anchor{584}
@deffn {Classe} warnings.catch_warnings (*, record=False, module=None, action=None, category=Warning, lineno=0, append=False)

Um gerenciador de contexto que copia e, ao sair, restaura o filtro de avisos e a função @ref{462e,,showwarning()}. Se o argumento `record' for @ref{b49,,False} (o padrão), o gerenciador de contexto retorna @ref{675,,None} na entrada. Se `record' for @ref{c27,,True}, será retornada uma lista que é preenchida progressivamente com objetos conforme vistos por uma função @ref{462e,,showwarning()} personalizada (que também suprime a saída para @code{sys.stdout}). Cada objeto na lista tem atributos com os mesmos nomes que os argumentos de @ref{462e,,showwarning()}.

O argumento `module' recebe um módulo que será usado em vez do módulo retornado quando você importar @ref{112,,warnings} cujo filtro será protegido. Esse argumento serve principalmente para testar o módulo @ref{112,,warnings} em si.

Se o argumento `action' não for @code{None}, os argumentos restantes serão passados para @ref{6c1,,simplefilter()} como se fossem chamados imediatamente ao entrar no contexto.

Consulte @ref{8cf,,O filtro de avisos} para saber o significado de `category' e `lineno'.

@cartouche
@quotation Nota 
The @ref{584,,catch_warnings} manager works by replacing and
then later restoring the module’s
@ref{462e,,showwarning()} function and internal list of filter
specifications.  This means the context manager is modifying
global state and therefore is not thread-safe.
@end quotation
@end cartouche


Alterado na versão 3.11: Adicionados os parâmetros `action', `category', `lineno' e `append'.

@end deffn

@node dataclasses — Data Classes,contextlib — Utilitários para contextos da instrução with,warnings — Controle de avisos,Serviços de Tempo de Execução Python
@anchor{library/dataclasses doc}@anchor{4640}@anchor{library/dataclasses dataclasses-data-classes}@anchor{4641}@anchor{library/dataclasses module-dataclasses}@anchor{2f}@anchor{library/dataclasses translation-repo}@anchor{4642}
@subsection @code{dataclasses} — Data Classes


@geindex module; dataclasses

`Código-fonte:' Lib/dataclasses.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dataclasses.py}


__________________________________________________________________


Este módulo fornece um decorador e funções para adicionar automaticamente @ref{19eb,,métodos especiais} tais como @ref{6b0,,__init__()} e @ref{61c,,__repr__()} a classes definidas pelo usuário. Foi originalmente descrita em 
@geindex Propostas de Melhorias do Python; PEP 557
PEP 557@footnote{https://peps.python.org/pep-0557/}.

Variáveis-membro a serem usadas nesses métodos gerados são definidas usando as anotações de tipo da 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}. Por exemplo, esse 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

adicionará, entre outras coisas, um @code{__init__()} como esse:

@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

Observe que este método é adicionado automaticamente à classe: ele não é especificado diretamente na definição @code{InventoryItem} mostrada acima.


Adicionado na versão 3.7.


@menu
* Conteúdo do módulo: Conteúdo do módulo<8>. 
* Processamento pós-inicialização:: 
* Variáveis de classe:: 
* Variáveis de inicialização apenas:: 
* Frozen instances:: 
* Herança: Herança<2>. 
* Re-ordering of keyword-only parameters in __init__(): Re-ordering of keyword-only parameters in __init__. 
* Funções padrão de fábrica:: 
* Valores padrão mutáveis:: 
* Descriptor-typed fields:: 

@end menu

@node Conteúdo do módulo<8>,Processamento pós-inicialização,,dataclasses — Data Classes
@anchor{library/dataclasses module-contents}@anchor{4643}
@subsubsection Conteúdo do módulo


@geindex dataclass() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses dataclass}@anchor{1cb}
@deffn {Função} @@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)

Esta função é um @ref{731,,decorador} que é usado para adicionar @ref{19eb,,métodos especiais} para classes, conforme descrito abaixo.

O decorador @code{@@dataclass} examina a classe para encontrar campos (@code{field}.  Um @code{field} é definido como uma variável de classe que tem uma @ref{d79,,anotação de tipo}.  Com duas exceções, descritas mais adiante, @code{@@dataclass} não examina o tipo especificado na anotação de variável.

A ordem dos campos em todos os métodos gerados é a ordem em que eles aparecem na definição de classe.

O decorador @code{@@dataclass} adicionará vários métodos “dunder” à classe, descritos abaixo. Se algum dos métodos adicionados já existir na classe, o comportamento dependerá do parâmetro, conforme documentado abaixo. O decorador retorna a mesma classe decorada; nenhuma nova classe é criada.

Se @code{@@dataclass} for usado apenas como um simples decorador, sem parâmetros, ele age como se tivesse os valores padrão documentados nessa assinatura. Ou seja, esses três usos de @code{@@dataclass} são equivalentes:

@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

Os parâmetros do @code{@@dataclass} são:


@itemize -

@item 
`init': Se verdadeiro (o padrão), o método @ref{6b0,,__init__()} será gerado.

Se a classe do usuário definir @code{__init__()} esse parâmetro é ignorado.

@item 
`repr': Se verdadeiro (o padrão), um método @ref{61c,,__repr__()} será gerado. A sequência de string de representação gerada terá o nome da classe e o nome e representação de cada campo, na ordem em que são definidos na classe. Os campos marcados como excluídos da representação não são incluídos. Por exemplo: @code{InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)}.

Se a classe do usuário já define @code{__repr__()} esse parâmetro é ignorado.

@item 
`eq': Se verdadeiro (o padrão), um método @ref{b0d,,__eq__()} será gerado. Este método compara a classe como se fosse uma tupla de campos, em ordem. Ambas as instâncias na comparação devem ser de tipo idêntico.

Se a classe do usuário já define @code{__eq__()} esse parâmetro é ignorado.

@item 
`order': Se verdadeiro (o padrão é @code{False}), os métodos @ref{12e2,,__lt__()}, @ref{134f,,__le__()}, @ref{1350,,__gt__()} e @ref{1351,,__ge__()} serão gerados.  Comparam a classe como se fosse uma tupla de campos, em ordem.  Ambas instâncias na comparação devem ser de tipo idêntico.  Se `order' é verdadeiro e `eq' é falso, a exceção @ref{202,,ValueError} é levantada.

Se a classe do usuário já define algum dentre @code{__lt__()}, @code{__le__()}, @code{__gt__()} ou @code{__ge__()}, então @ref{2c3,,TypeError} é levantada.

@item 
`unsafe_hash': Se verdadeiro, força @code{dataclasses} a criar um método @ref{b0e,,__hash__()}, mesmo que não seja seguro fazê-lo. Caso contrário, gera um método @ref{b0e,,__hash__()} de acordo com a configuração de `eq' e `frozen'. O valor padrão é @code{False}.

@code{__hash__()} é usado para prover o método embutido @ref{5eb,,hash()}, e quando objetos são adicionados a coleções do tipo dicionário ou conjunto. Ter um método @code{__hash__()} implica que instâncias da classe serão imutáveis. Mutabilidade é uma propriedade complicada, que depende da intenção do programador, da existência e comportamento do método @code{__eq__()}, e dos valores dos parâmetros `eq' e `frozen' no decorador @code{@@dataclass}.

Por padrão, @code{@@dataclass} não vai adicionar implicitamente um método @ref{b0e,,__hash__()}, a menos que seja seguro fazê-lo.  Nem irá adicionar ou modificar um método @code{__hash__()} existente, definido explicitamente. Configurar o atributo de classe @code{__hash__ = None} tem um significado específico para o Python, conforme descrito na documentação de @code{__hash__()}.

Se @code{__hash__()} não é definido explicitamente, ou se é configurado como @code{None}, então @code{@@dataclass} `pode' adicionar um método @code{__hash__()} implícito. Mesmo que não seja recomendado, pode-se forçar @code{@@dataclass} a criar um método @code{__hash__()} com  @code{unsafe_hash=True}. Este pode ser o caso se sua classe é logicamente imutável, mas na prática pode ser mudada. Esse é um caso de uso específico e deve ser considerado com muito cuidado.

Essas são as regras governando a criação implícita de um método  @code{__hash__()}.  Observe que não pode ter um método @code{__hash__()} explícito na dataclass e configurar @code{unsafe_hash=True}; isso resultará em um @ref{2c3,,TypeError}.

Se `eq' e `frozen' são ambos verdadeiros, por padrão @code{@@dataclass} vai gerar um método @code{__hash__()}. Se `eq' é verdadeiro e `frozen' é falso, @code{__hash__()} será configurado para @code{None}, marcando a classe como não-hasheável (já que é mutável). Se `eq' é falso, @code{__hash__()} será deixado intocado, o que significa que o método @code{__hash__()} da superclasse será usado (se a superclasse é @ref{a96,,object}, significa que voltará para o hash baseado em id).

@item 
`frozen': If true (the default is @code{False}), assigning to fields will
generate an exception.  This emulates read-only frozen instances.
See the @ref{4644,,discussion} below.

If @ref{20bf,,__setattr__()} or @ref{20c0,,__delattr__()} is defined in the class
and `frozen' is true, then @ref{2c3,,TypeError} is raised.

@item 
`match_args': Se verdadeiro (o padrão é @code{True}), a tupla @ref{1a01,,__match_args__} será criada a partir da lista de parâmetros não-somente-nomeado para o método @ref{6b0,,__init__()} gerado (mesmo se @code{__init__()} não for gerado, veja acima). Se falso, ou se @code{__match_args__} já estiver definido na classe, então @code{__match_args__} não será gerado.
@end itemize

@quotation


Adicionado na versão 3.10.

@end quotation


@itemize -

@item 
`kw_only': Se verdadeiro (o valor padrão é @code{False}), então todos os campos serão marcados como somente-nomeado. Se um campo for marcado como somente-nomeado, então o único efeito é que o parâmetro @ref{6b0,,__init__()} gerado a partir de um campo somente-nomeado deve ser especificado com um campo quando @code{__init__()} é chamado. Veja a entrada @ref{208f,,parâmetro} do glossário para detalhes. Veja também a seção @ref{4645,,KW_ONLY}.

Campos somente-nomeados não são incluídos em @code{__match_args__}.
@end itemize

@quotation


Adicionado na versão 3.10.

@end quotation


@itemize -

@item 
`slots': Se true (o padrão é @code{False}), o atributo @ref{1533,,__slots__} será gerado e uma nova classe será retornada no lugar da original. Se @code{__slots__} já estiver definido na classe, então @ref{2c3,,TypeError} será levantada.
@end itemize

@quotation

@cartouche
@quotation Aviso 
Calling no-arg @ref{4db,,super()} in dataclasses using @code{slots=True}
will result in the following exception being raised:
@code{TypeError: super(type, obj): obj must be an instance or subtype of type}.
The two-arg @ref{4db,,super()} is a valid workaround.
See gh-90562@footnote{https://github.com/python/cpython/issues/90562} for full details.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Passar parâmetros para uma classe base @ref{631,,__init_subclass__()} ao usar @code{slots=True} resultará em um @ref{2c3,,TypeError}. Use @code{__init_subclass__} sem parâmetros ou use valores padrão como solução alternativa. Consulte gh-91126@footnote{https://github.com/python/cpython/issues/91126} para obter detalhes completos.
@end quotation
@end cartouche


Adicionado na versão 3.10.



Alterado na versão 3.11: Se um nome de campo já estiver incluído no @code{__slots__} de uma classe base, ele não será incluído no @code{__slots__} gerado para evitar @ref{20fc,,substitui-los}. Portanto, não use @code{__slots__} para recuperar os nomes dos campos de uma classe de dados. Use @ref{183b,,fields()} em vez disso. Para poder determinar os slots herdados, a classe base @code{__slots__} pode ser qualquer iterável, mas `não' um iterador.

@end quotation


@itemize -

@item 
`weakref_slot': Se verdadeiro (o padrão é @code{False}), adicione um slot chamado “__weakref__”, que é necessário para tornar uma instância @ref{1026,,fraca}. É um erro especificar @code{weakref_slot=True} sem também especificar @code{slots=True}.
@end itemize

@quotation


Adicionado na versão 3.11.

@end quotation

@code{field}s pode opcionalmente especificar um valor padrão, usando sintaxe Python normal:

@example
@@dataclass
class C:
    a: int       # 'a' tem nenhum valor mínimo
    b: int = 0   # atribui um valor padrão para 'b'
@end example

Nesse exemplo, @code{a} e @code{b} serão incluídos no método @ref{6b0,,__init__()} adicionado, que será definido como:

@example
def __init__(self, a: int, b: int = 0):
@end example

@ref{2c3,,TypeError} será levantada se um campo sem valor padrão for definido após um campo com valor padrão.  Isso é verdadeiro se ocorrer numa classe simples, ou como resultado de uma herança de classe.
@end deffn

@geindex field() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses field}@anchor{1b98}
@deffn {Função} dataclasses.field (*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING)

Para casos de uso comuns e simples, nenhuma outra funcionalidade é necessária. Existem, no entanto, alguns recursos que requerem informações adicionais por campo. Para satisfazer essa necessidade de informações adicionais, você pode substituir o valor do campo padrão por uma chamada para a função @code{field()} fornecida. Por exemplo:

@example
@@dataclass
class C:
    mylist: list[int] = field(default_factory=list)

c = C()
c.mylist += [1, 2, 3]
@end example

Como mostrado acima, o valor @ref{4646,,MISSING} é um objeto sentinela usado para detectar se alguns parâmetros são fornecidos pelo usuário. Este sentinela é usado porque @code{None} é um valor válido para alguns parâmetros com um significado distinto.  Nenhum código deve usar diretamente o valor @ref{4646,,MISSING}.

Os parâmetros de @code{field()} são:


@itemize -

@item 
`default': Se fornecido, este será o valor padrão para este campo. Isso é necessário porque a própria chamada @code{field()} substitui a posição normal do valor padrão.

@item 
`default_factory': Se fornecido, deve ser um chamável sem argumento que será chamado quando um valor padrão for necessário para este campo. Entre outras finalidades, isso pode ser usado para especificar campos com valores padrão mutáveis, conforme discutido abaixo. É um erro especificar ambos `default' e `default_factory'.

@item 
`init': Se verdadeiro (o padrão), este campo é incluído como um parâmetro para o método @ref{6b0,,__init__()} gerado.

@item 
`repr': Se verdadeiro (o padrão), este campo é incluído na string retornada pelo método @ref{61c,,__repr__()} gerado.

@item 
`hash': Pode ser um bool ou @code{None}. Se verdadeiro, este campo é incluído no método @ref{b0e,,__hash__()} gerado. Se false, este campo é excluído do @ref{b0e,,__hash__()} gerado. Se @code{None} (o padrão), usa o valor de `compare': este seria normalmente o comportamento esperado, já que um campo deve ser incluído no hash se for usado para comparações. Definir este valor para algo diferente de @code{None} é desencorajado.

Uma possível razão para definir @code{hash=False} mas @code{compare=True} seria se um campo for caro para calcular um valor de hash, esse campo for necessário para teste de igualdade e houver outros campos que contribuem para o valor de hash do tipo. Mesmo que um campo seja excluído do hash, ele ainda será usado para comparações.

@item 
`compare': Se verdadeiro (o padrão), este campo é incluído nos métodos de igualdade e comparação gerados (@ref{b0d,,__eq__()}, @ref{1350,,__gt__()}, etc.).

@item 
`metadata': Pode ser um mapeamento ou @code{None}. @code{None} é tratado como um dicionário vazio. Este valor é agrupado em @ref{46d,,MappingProxyType()} para torná-lo somente leitura e exposto no objeto @ref{23ea,,Field}. Ele não é usado por Data Classes e é fornecido como um mecanismo de extensão de terceiros. Vários terceiros podem ter sua própria chave, para usar como um espaço de nomes nos metadados.

@item 
`kw_only': Se verdadeiro, este campo será marcado como somente-nomeado. Isso é usado quando os parâmetros do método @ref{6b0,,__init__()} gerados são calculados.

Campos somente-nomeados também não são incluídos em @code{__match_args__}.
@end itemize

@quotation


Adicionado na versão 3.10.

@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{1cb,,@@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 (classe em dataclasses)
@anchor{library/dataclasses dataclasses Field}@anchor{23ea}
@deffn {Classe} dataclasses.Field

@code{Field} objects describe each defined field. These objects
are created internally, and are returned by the @ref{183b,,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{1b98,,field()} function.
@end itemize

Outros atributos podem existir, mas são privados e não devem ser inspecionados ou confiáveis.
@end deffn

@geindex InitVar (classe em dataclasses)
@anchor{library/dataclasses dataclasses InitVar}@anchor{193e}
@deffn {Classe} dataclasses.InitVar

@code{InitVar[T]} type annotations describe variables that are @ref{4647,,init-only}. Fields annotated with @code{InitVar}
are considered pseudo-fields, and thus are neither returned by the
@ref{183b,,fields()} function nor used in any way except adding them as
parameters to @ref{6b0,,__init__()} and an optional
@ref{4648,,__post_init__()}.
@end deffn

@geindex fields() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses fields}@anchor{183b}
@deffn {Função} dataclasses.fields (class_or_instance)

Retorna uma tupla de objetos @ref{23ea,,Field} que definem os campos para esta classe de dados. Aceita uma classe de dados ou uma instância de uma classe de dados. Levanta @ref{2c3,,TypeError} se não for passada uma classe de dados ou instância de uma. Não retorna pseudocampos que são @code{ClassVar} ou @code{InitVar}.
@end deffn

@geindex asdict() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses asdict}@anchor{1819}
@deffn {Função} 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{b84,,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

Para criar uma cópia rasa, a seguinte solução alternativa pode ser usada:

@example
@{field.name: getattr(obj, field.name) for field in fields(obj)@}
@end example

@code{asdict()} raises @ref{2c3,,TypeError} if `obj' is not a dataclass
instance.
@end deffn

@geindex astuple() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses astuple}@anchor{1822}
@deffn {Função} 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{b84,,copy.deepcopy()}.

Continuando a partir do exemplo anterior:

@example
assert astuple(p) == (10, 20)
assert astuple(c) == ([(0, 0), (10, 4)],)
@end example

Para criar uma cópia rasa, a seguinte solução alternativa pode ser usada:

@example
tuple(getattr(obj, field.name) for field in dataclasses.fields(obj))
@end example

@code{astuple()} raises @ref{2c3,,TypeError} if `obj' is not a dataclass
instance.
@end deffn

@geindex make_dataclass() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses make_dataclass}@anchor{183d}
@deffn {Função} 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)

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{6ac,,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{1cb,,@@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.

This function is not strictly required, because any Python
mechanism for creating a new class with @code{__annotations__} can
then apply the @ref{1cb,,@@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

É equivalente a:

@example
@@dataclass
class C:
    x: int
    y: 'typing.Any'
    z: int = 5

    def add_one(self):
        return self.x + 1
@end example
@end deffn

@geindex replace() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses replace}@anchor{17ec}
@deffn {Função} 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{2c3,,TypeError}.  If keys in `changes' are not
field names of the given dataclass, raises @ref{2c3,,TypeError}.

The newly returned object is created by calling the @ref{6b0,,__init__()}
method of the dataclass.  This ensures that
@ref{4648,,__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{4648,,__post_init__()}.

It is an error for `changes' to contain any fields that are
defined as having @code{init=False}.  A @ref{202,,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{4648,,__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{151,,copy.replace()}.
@end deffn

@geindex is_dataclass() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses is_dataclass}@anchor{19a0}
@deffn {Função} 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}.

Se você precisa saber se a classe é uma instância de dataclass (e não a dataclass de fato), então adicione uma verificação 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 (no módulo dataclasses)
@anchor{library/dataclasses dataclasses MISSING}@anchor{4646}
@deffn {Dado} dataclasses.MISSING

A sentinel value signifying a missing default or default_factory.
@end deffn

@geindex KW_ONLY (no módulo dataclasses)
@anchor{library/dataclasses dataclasses KW_ONLY}@anchor{4645}
@deffn {Dado} 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{6b0,,__init__()} parameters that must be specified as keywords when
the class is instantiated.

In this example, the fields @code{y} and @code{z} will be marked as keyword-only fields:

@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}.


Adicionado na versão 3.10.

@end deffn

@geindex FrozenInstanceError
@anchor{library/dataclasses dataclasses FrozenInstanceError}@anchor{4649}
@deffn {Exceção} dataclasses.FrozenInstanceError

Raised when an implicitly defined @ref{20bf,,__setattr__()} or
@ref{20c0,,__delattr__()} is called on a dataclass which was defined with
@code{frozen=True}. It is a subclass of @ref{34b,,AttributeError}.
@end deffn

@node Processamento pós-inicialização,Variáveis de classe,Conteúdo do módulo<8>,dataclasses — Data Classes
@anchor{library/dataclasses id1}@anchor{464a}@anchor{library/dataclasses post-init-processing}@anchor{464b}
@subsubsection Processamento pós-inicialização


@geindex __post_init__() (no módulo dataclasses)
@anchor{library/dataclasses dataclasses __post_init__}@anchor{4648}
@deffn {Função} dataclasses.__post_init__ ()

When defined on the class, it will be called by the generated
@ref{6b0,,__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.

Among other uses, this allows for initializing field values that
depend on one or more other fields.  For example:

@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{6b0,,__init__()} method generated by @ref{1cb,,@@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{4648,,__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{17ec,,replace()} handles @code{init=False} fields.

@node Variáveis de classe,Variáveis de inicialização apenas,Processamento pós-inicialização,dataclasses — Data Classes
@anchor{library/dataclasses class-variables}@anchor{464c}@anchor{library/dataclasses dataclasses-class-variables}@anchor{464d}
@subsubsection Variáveis de classe


One of the few places where @ref{1cb,,@@dataclass} actually inspects the type
of a field is to determine if a field is a class variable as defined
in 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}.  It does this by checking if the type of the field is
@ref{266,,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{183b,,fields()} function.

@node Variáveis de inicialização apenas,Frozen instances,Variáveis de classe,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-init-only-variables}@anchor{4647}@anchor{library/dataclasses init-only-variables}@anchor{464e}
@subsubsection Variáveis de inicialização apenas


Another place where @ref{1cb,,@@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 @ref{193e,,InitVar}.  If a field
is an @ref{193e,,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{183b,,fields()} function.  Init-only fields are added as
parameters to the generated @ref{6b0,,__init__()} method, and are passed to
the optional @ref{4648,,__post_init__()} method.  They are not otherwise used
by dataclasses.

For example, suppose a field will be initialized from a database, if a
value is not provided when creating the class:

@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{183b,,fields()} will return @ref{23ea,,Field} objects for @code{i} and
@code{j}, but not for @code{database}.

@node Frozen instances,Herança<2>,Variáveis de inicialização apenas,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-frozen}@anchor{4644}@anchor{library/dataclasses frozen-instances}@anchor{464f}
@subsubsection Frozen instances


It is not possible to create truly immutable Python objects.  However,
by passing @code{frozen=True} to the @ref{1cb,,@@dataclass} decorator you can
emulate immutability.  In that case, dataclasses will add
@ref{20bf,,__setattr__()} and @ref{20c0,,__delattr__()} methods to the class.  These
methods will raise a @ref{4649,,FrozenInstanceError} when invoked.

There is a tiny performance penalty when using @code{frozen=True}:
@ref{6b0,,__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 Herança<2>,Re-ordering of keyword-only parameters in __init__,Frozen instances,dataclasses — Data Classes
@anchor{library/dataclasses dataclasses-inheritance}@anchor{4650}@anchor{library/dataclasses inheritance}@anchor{4651}
@subsubsection Herança


When the dataclass is being created by the @ref{1cb,,@@dataclass} decorator,
it looks through all of the class’s base classes in reverse MRO (that
is, starting at @ref{a96,,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{257,,int}, as specified in class @code{C}.

The generated @ref{6b0,,__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__,Funções padrão de fábrica,Herança<2>,dataclasses — Data Classes
@anchor{library/dataclasses re-ordering-of-keyword-only-parameters-in-init}@anchor{4652}
@subsubsection Re-ordering of keyword-only parameters in @code{__init__()}


After the parameters needed for @ref{6b0,,__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

Note that the parameters have been re-ordered from how they appear in
the list of fields: parameters derived from regular fields are
followed by parameters derived from keyword-only fields.

The relative ordering of keyword-only parameters is maintained in the
re-ordered @code{__init__()} parameter list.

@node Funções padrão de fábrica,Valores padrão mutáveis,Re-ordering of keyword-only parameters in __init__,dataclasses — Data Classes
@anchor{library/dataclasses default-factory-functions}@anchor{4653}
@subsubsection Funções padrão de fábrica


If a @ref{1b98,,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{6b0,,__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 padrão mutáveis,Descriptor-typed fields,Funções padrão de fábrica,dataclasses — Data Classes
@anchor{library/dataclasses mutable-default-values}@anchor{4654}
@subsubsection Valores padrão mutáveis


Python stores default member variable values in class attributes.
Consider this example, not using dataclasses:

@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 dataclasses, `se' este código fosse válido:

@example
@@dataclass
class D:
    x: list = []      # This code raises ValueError
    def add(self, element):
        self.x.append(element)
@end example

Geraria 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{1cb,,@@dataclass} decorator will raise a @ref{202,,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.

Using default factory functions is a way to create new instances of
mutable types as default values for fields:

@example
@@dataclass
class D:
    x: list = field(default_factory=list)

assert D().x is not D().x
@end example


Alterado na versão 3.11: Instead of looking for and disallowing objects of type @ref{611,,list},
@ref{256,,dict}, or @ref{5d9,,set}, unhashable objects are now not allowed as
default values.  Unhashability is used to approximate
mutability.


@node Descriptor-typed fields,,Valores padrão mutáveis,dataclasses — Data Classes
@anchor{library/dataclasses descriptor-typed-fields}@anchor{4655}
@subsubsection Descriptor-typed fields


Fields that are assigned @ref{c6a,,descriptor objects} as their
default value have the following special behaviors:


@itemize *

@item 
The value for the field passed to the dataclass’s @ref{6b0,,__init__()} method is
passed to the descriptor’s @ref{20f7,,__set__()} method rather than overwriting the
descriptor object.

@item 
Similarly, when getting or setting the field, the descriptor’s
@ref{1530,,__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{1cb,,@@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{34b,,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

Note that if a field is annotated with a descriptor type, but is not assigned
a descriptor object as its default value, the field will act like a normal
field.

@node contextlib — Utilitários para contextos da instrução with,abc — Classes base abstratas,dataclasses — Data Classes,Serviços de Tempo de Execução Python
@anchor{library/contextlib doc}@anchor{4656}@anchor{library/contextlib contextlib-utilities-for-with-statement-contexts}@anchor{4657}@anchor{library/contextlib module-contextlib}@anchor{23}@anchor{library/contextlib translation-repo}@anchor{4658}
@subsection @code{contextlib} — Utilitários para contextos da instrução @code{with}


@geindex module; contextlib

`Código-fonte:' Lib/contextlib.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/contextlib.py}


__________________________________________________________________


Este módulo fornece utilitários para tarefas comuns envolvendo a instrução @ref{5d2,,with}. Para mais informações, veja também @ref{214e,,Tipos de Gerenciador de Contexto} e @ref{214c,,Gerenciadores de contexto da instrução with}.

@menu
* Utilitários:: 
* Exemplos e receitas: Exemplos e receitas<3>. 
* Single use@comma{} reusable and reentrant context managers: Single use reusable and reentrant context managers. 

@end menu

@node Utilitários,Exemplos e receitas<3>,,contextlib — Utilitários para contextos da instrução with
@anchor{library/contextlib utilities}@anchor{4659}
@subsubsection Utilitários


Funções e classes fornecidas:

@geindex AbstractContextManager (classe em contextlib)
@anchor{library/contextlib contextlib AbstractContextManager}@anchor{cab}
@deffn {Classe} contextlib.AbstractContextManager

Uma @ref{11f5,,classe base abstrata} para classes que implementam @ref{5c8,,object.__enter__()} e @ref{1344,,object.__exit__()}. Uma implementação padrão para @ref{5c8,,object.__enter__()} é fornecida, que retorna @code{self}, enquanto @ref{1344,,object.__exit__()} é um método abstrato que, por padrão, retorna @code{None}. Veja também a definição de @ref{214e,,Tipos de Gerenciador de Contexto}.


Adicionado na versão 3.6.

@end deffn

@geindex AbstractAsyncContextManager (classe em contextlib)
@anchor{library/contextlib contextlib AbstractAsyncContextManager}@anchor{b3d}
@deffn {Classe} contextlib.AbstractAsyncContextManager

Uma @ref{11f5,,classe base abstrata} para classes que implementam @ref{215e,,object.__aenter__()} e @ref{1716,,object.__aexit__()}. Uma implementação padrão para @ref{215e,,object.__aenter__()} é fornecida, que retorna @code{self}, enquanto @ref{1716,,object.__aexit__()} é um método abstrato que, por padrão, retorna @code{None}. Veja também a definição de @ref{5fc,,Gerenciadores de contexto assíncronos}


Adicionado na versão 3.7.

@end deffn

@geindex contextmanager() (no módulo contextlib)
@anchor{library/contextlib contextlib contextmanager}@anchor{1242}
@deffn {Função} @@contextlib.contextmanager

Esta função é um @ref{731,,decorador} que pode ser usado para definir uma função de fábrica para gerenciadores de contexto de instrução @ref{5d2,,with}, sem precisar criar uma classe ou separar os métodos @ref{5c8,,__enter__()} e @ref{1344,,__exit__()}.

While many objects natively support use in with statements, sometimes a
resource needs to be managed that isn’t a context manager in its own right,
and doesn’t implement a @code{close()} method for use with @code{contextlib.closing}.

Um exemplo abstrato seria o seguinte para garantir o gerenciamento correto dos recursos:

@example
from contextlib import contextmanager

@@contextmanager
def managed_resource(*args, **kwds):
    # Códigopara obter recursos como, por exemplo:
    resource = acquire_resource(*args, **kwds)
    try:
        yield resource
    finally:
        # Código para liberar recursos como, por exemplo:
        release_resource(resource)
@end example

A função pode, então,  ser usada da seguinte forma:

@example
>>> with managed_resource(timeout=3600) as resource:
...     # O recurso é liberado no final deste bloco,
...     # mesmo que o código no bloco levante uma exceção
@end example

A função que está sendo decorada deve retornar um iterador @ref{109a,,gerador} quando chamada. Este iterador deve produzir exatamente um valor, que será vinculado aos alvos na cláusula @code{as} da instrução @ref{5d2,,with}, se houver.

No ponto em que o gerador é produzido, o bloco aninhado na instrução @ref{5d2,,with} é executado. O gerador é então retomado após o bloco ser encerrado. Se uma exceção não tratada ocorrer no bloco, ela será levantada novamente dentro do gerador no ponto em que a produção ocorreu. Assim, você pode usar uma instrução @ref{6e9,,try}…@ref{18b,,except}…@ref{9d2,,finally} para capturar o erro (se houver), ou garantir que alguma limpeza ocorra. Se uma exceção for capturada apenas para registrá-la ou para executar alguma ação (em vez de suprimi-la completamente), o gerador deve levantar novamente essa exceção. Caso contrário, o gerenciador de contexto do gerador indicará à instrução @code{with} que a exceção foi tratada, e a execução será retomada com a instrução imediatamente após a instrução @code{with}.

@ref{1242,,contextmanager()} usa @ref{1241,,ContextDecorator} para que os gerenciadores de contexto que ela cria possam ser usados como decoradores, bem como em instruções @ref{5d2,,with}. Quando usada como um decorador, uma nova instância do gerador é implicitamente criada em cada chamada de função (isso permite que os gerenciadores de contexto criados por @ref{1242,,contextmanager()} atendam ao requisito de que os gerenciadores de contexto ofereçam suporte a múltiplas invocações para serem usados como decoradores).


Alterado na versão 3.2: Uso de @ref{1241,,ContextDecorator}.

@end deffn

@geindex asynccontextmanager() (no módulo contextlib)
@anchor{library/contextlib contextlib asynccontextmanager}@anchor{b3c}
@deffn {Função} @@contextlib.asynccontextmanager

Semelhante a @ref{1242,,contextmanager()}, mas cria um @ref{5fc,,gerenciador de contexto assíncrono}.

Esta função é um @ref{731,,decorador} que pode ser usado para definir uma função de fábrica para gerenciadores de contexto assíncronos de instrução @ref{5d5,,async with}, sem precisar criar uma classe ou separar os métodos @ref{215e,,__aenter__()} e @ref{1716,,__aexit__()}. Ela deve ser aplicada a uma função que atua como @ref{21cf,,gerador assíncrono}.

Um exemplo simples:

@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


Adicionado na versão 3.7.


Gerenciadores de contexto definidos com @ref{b3c,,asynccontextmanager()} podem ser usados como decoradores ou com instruções @ref{5d5,,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():
    # ... código do async ...
@end example

Quando usada como um decorador, uma nova instância do gerador é implicitamente criada em cada chamada de função. Isso permite que os gerenciadores de contexto criados por @ref{b3c,,asynccontextmanager()} atendam ao requisito de que os gerenciadores de contexto ofereçam suporte a múltiplas invocações para serem usados como decoradores.


Alterado na versão 3.10: Gerenciadores de contexto assíncronos criados com @ref{b3c,,asynccontextmanager()} podem ser usados como decoradores.

@end deffn

@geindex closing() (no módulo contextlib)
@anchor{library/contextlib contextlib closing}@anchor{13d0}
@deffn {Função} contextlib.closing (thing)

Retorna um gerenciador de contexto que fecha `thing' após a conclusão do bloco. Isso basicamente equivale a:

@example
from contextlib import contextmanager

@@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()
@end example

E permite que você escreva código como isso:

@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

sem precisar fechar explicitamente @code{page}. Mesmo se ocorrer um erro, @code{page.close()} será chamado quando o bloco @ref{5d2,,with} for encerrado.

@cartouche
@quotation Nota 
A maioria dos tipos que gerenciam recursos suporta o protocolo de @ref{5d4,,gerenciador de contexto}, que fecha `thing' ao sair da declaração @ref{5d2,,with}. Como tal, @code{closing()} é mais útil para tipos de terceiros que não oferecem suporte a gerenciadores de contexto. Este exemplo é puramente para fins ilustrativos, pois @ref{293,,urlopen()} normalmente seria usado em um gerenciador de contexto.
@end quotation
@end cartouche
@end deffn

@geindex aclosing() (no módulo contextlib)
@anchor{library/contextlib contextlib aclosing}@anchor{7ef}
@deffn {Função} contextlib.aclosing (thing)

Retorna um gerenciador de contexto async que chama o método @code{aclose()} de `thing' após a conclusão do bloco. Isso basicamente equivale a:

@example
from contextlib import asynccontextmanager

@@asynccontextmanager
async def aclosing(thing):
    try:
        yield thing
    finally:
        await thing.aclose()
@end example

De forma significativa, @code{aclosing()} oferece suporte a limpeza determinística de geradores assíncronos quando eles são encerrados mais cedo por @ref{ab8,,break} ou uma exceção. Por exemplo:

@example
from contextlib import aclosing

async with aclosing(my_generator()) as values:
    async for value in values:
        if value == 42:
            break
@end example

Esse padrão garante que o código de saída assíncrono do gerador seja executado no mesmo contexto que suas iterações (para que exceções e variáveis de contexto funcionem conforme o esperado, e o código de saída não seja executado após o tempo de vida de alguma tarefa da qual ele depende).


Adicionado na versão 3.10.

@end deffn

@geindex nullcontext() (no módulo contextlib)
@anchor{library/contextlib simplifying-support-for-single-optional-context-managers}@anchor{465a}@anchor{library/contextlib contextlib nullcontext}@anchor{7f0}
@deffn {Função} contextlib.nullcontext (enter_result=None)

Retorna um gerenciador de contexto que retorna `enter_result' de @code{__enter__}, mas não faz nada de outra forma. Ele foi criado para ser usado como um substituto para um gerenciador de contexto opcional, por exemplo:

@example
def myfunction(arg, ignore_exceptions=False):
    if ignore_exceptions:
        # Usa suppress para ignorar todas as exceções.
        cm = contextlib.suppress(Exception)
    else:
        # Não ignora quaisquer exceções, cm não tem efeito.
        cm = contextlib.nullcontext()
    with cm:
        # Faz algo
@end example

Um exemplo usando `enter_result':

@example
def process_file(file_or_path):
    if isinstance(file_or_path, str):
        # Se for uma string, abre o arquivo
        cm = open(file_or_path)
    else:
        # O chamador é responsável por fechar o arquivo
        cm = nullcontext(file_or_path)

    with cm as file:
        # Efetua um processamento no arquivo
@end example

Também pode ser usado como um substituto para @ref{5fc,,gerenciadores de contexto assíncronos}:

@example
async def send_http(session=None):
    if not session:
        # Se houver nenhuma sessão http, cria-a com aiohttp
        cm = aiohttp.ClientSession()
    else:
        # O chamador é responsável por fechar a sessão
        cm = nullcontext(session)

    async with cm as session:
        # Envia requisições http com sessão
@end example


Adicionado na versão 3.7.



Alterado na versão 3.10: Suporte a @ref{5d7,,gerenciador de contexto assíncrono} foi adicionado.

@end deffn

@geindex suppress() (no módulo contextlib)
@anchor{library/contextlib contextlib suppress}@anchor{f58}
@deffn {Função} contextlib.suppress (*exceptions)

Retorna um gerenciador de contexto que suprime qualquer uma das exceções especificadas se elas ocorrerem no corpo de uma instrução @code{with} e então retoma a execução com a primeira instrução após o final da instrução @code{with}.

Como qualquer outro mecanismo que suprime completamente exceções, este gerenciador de contexto deve ser usado apenas para cobrir erros muito específicos, onde continuar silenciosamente com a execução do programa é considerado a coisa certa a fazer.

Por exemplo:

@example
from contextlib import suppress

with suppress(FileNotFoundError):
    os.remove('algumarquivo.tmp')

with suppress(FileNotFoundError):
    os.remove('outroarquivo.tmp')
@end example

Este código equivale a:

@example
try:
    os.remove('algumarquivo.tmp')
except FileNotFoundError:
    pass

try:
    os.remove('outroarquivo.tmp')
except FileNotFoundError:
    pass
@end example

O gerenciador de contexto é @ref{465b,,reentrante}.

Se o código dentro do bloco @code{with} levantar uma exceção @ref{25f,,BaseExceptionGroup}, exceções suprimidas são removidas do grupo. Quaisquer exceções do grupo que não forem suprimidas são levantadas novamente em um novo grupo que é criado usando o método @ref{17b3,,derive()} do grupo original.


Adicionado na versão 3.4.



Alterado na versão 3.12: @code{suppress} now supports suppressing exceptions raised as
part of a @ref{25f,,BaseExceptionGroup}.

@end deffn

@geindex redirect_stdout() (no módulo contextlib)
@anchor{library/contextlib contextlib redirect_stdout}@anchor{e12}
@deffn {Função} contextlib.redirect_stdout (new_target)

Context manager for temporarily redirecting @ref{ae6,,sys.stdout} to
another file or file-like object.

This tool adds flexibility to existing functions or classes whose output
is hardwired to stdout.

For example, the output of @ref{8dd,,help()} normally is sent to `sys.stdout'.
You can capture that output in a string by redirecting the output to an
@ref{f59,,io.StringIO} object. The replacement stream is returned from the
@code{__enter__} method and so is available as the target of the
@ref{5d2,,with} statement:

@example
with redirect_stdout(io.StringIO()) as f:
    help(pow)
s = f.getvalue()
@end example

To send the output of @ref{8dd,,help()} to a file on disk, redirect the output
to a regular file:

@example
with open('help.txt', 'w') as f:
    with redirect_stdout(f):
        help(pow)
@end example

To send the output of @ref{8dd,,help()} to `sys.stderr':

@example
with redirect_stdout(sys.stderr):
    help(pow)
@end example

Note that the global side effect on @ref{ae6,,sys.stdout} means that this
context manager is not suitable for use in library code and most threaded
applications. It also has no effect on the output of subprocesses.
However, it is still a useful approach for many utility scripts.

O gerenciador de contexto é @ref{465b,,reentrante}.


Adicionado na versão 3.4.

@end deffn

@geindex redirect_stderr() (no módulo contextlib)
@anchor{library/contextlib contextlib redirect_stderr}@anchor{e11}
@deffn {Função} contextlib.redirect_stderr (new_target)

Similar to @ref{e12,,redirect_stdout()} but redirecting
@ref{940,,sys.stderr} to another file or file-like object.

O gerenciador de contexto é @ref{465b,,reentrante}.


Adicionado na versão 3.5.

@end deffn

@geindex chdir() (no módulo contextlib)
@anchor{library/contextlib contextlib chdir}@anchor{60c}
@deffn {Função} contextlib.chdir (path)

Non parallel-safe context manager to change the current working directory.
As this changes a global state, the working directory, it is not suitable
for use in most threaded or async contexts. It is also not suitable for most
non-linear code execution, like generators, where the program execution is
temporarily relinquished – unless explicitly desired, you should not yield
when this context manager is active.

This is a simple wrapper around @ref{60d,,chdir()}, it changes the current
working directory upon entering and restores the old one on exit.

O gerenciador de contexto é @ref{465b,,reentrante}.


Adicionado na versão 3.11.

@end deffn

@geindex ContextDecorator (classe em contextlib)
@anchor{library/contextlib contextlib ContextDecorator}@anchor{1241}
@deffn {Classe} contextlib.ContextDecorator

A base class that enables a context manager to also be used as a decorator.

Context managers inheriting from @code{ContextDecorator} have to implement
@code{__enter__} and @code{__exit__} as normal. @code{__exit__} retains its optional
exception handling even when used as a decorator.

@code{ContextDecorator} is used by @ref{1242,,contextmanager()}, so you get this
functionality automatically.

Example of @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

The class can then be used like this:

@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

This change is just syntactic sugar for any construct of the following form:

@example
def f():
    with cm():
        # Do stuff
@end example

@code{ContextDecorator} lets you instead write:

@example
@@cm()
def f():
    # Do stuff
@end example

It makes it clear that the @code{cm} applies to the whole function, rather than
just a piece of it (and saving an indentation level is nice, too).

Existing context managers that already have a base class can be extended by
using @code{ContextDecorator} as a mixin class:

@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 
As the decorated function must be able to be called multiple times, the
underlying context manager must support use in multiple @ref{5d2,,with}
statements. If this is not the case, then the original construct with the
explicit @code{with} statement inside the function should be used.
@end quotation
@end cartouche


Adicionado na versão 3.2.

@end deffn

@geindex AsyncContextDecorator (classe em contextlib)
@anchor{library/contextlib contextlib AsyncContextDecorator}@anchor{7f1}
@deffn {Classe} contextlib.AsyncContextDecorator

Similar to @ref{1241,,ContextDecorator} but only for asynchronous functions.

Example of @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

The class can then be used like this:

@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


Adicionado na versão 3.10.

@end deffn

@geindex ExitStack (classe em contextlib)
@anchor{library/contextlib contextlib ExitStack}@anchor{b3b}
@deffn {Classe} contextlib.ExitStack

A context manager that is designed to make it easy to programmatically
combine other context managers and cleanup functions, especially those
that are optional or otherwise driven by input data.

For example, a set of files may easily be handled in a single with
statement as follows:

@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{5c8,,__enter__()} method returns the @ref{b3b,,ExitStack} instance, and
performs no additional operations.

Each instance maintains a stack of registered callbacks that are called in
reverse order when the instance is closed (either explicitly or implicitly
at the end of a @ref{5d2,,with} statement). Note that callbacks are `not'
invoked implicitly when the context stack instance is garbage collected.

This stack model is used so that context managers that acquire their
resources in their @code{__init__} method (such as file objects) can be
handled correctly.

Since registered callbacks are invoked in the reverse order of
registration, this ends up behaving as if multiple nested @ref{5d2,,with}
statements had been used with the registered set of callbacks. This even
extends to exception handling - if an inner callback suppresses or replaces
an exception, then outer callbacks will be passed arguments based on that
updated state.

This is a relatively low level API that takes care of the details of
correctly unwinding the stack of exit callbacks. It provides a suitable
foundation for higher level context managers that manipulate the exit
stack in application specific ways.


Adicionado na versão 3.3.


@geindex enter_context() (método contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack enter_context}@anchor{5d3}
@deffn {Método} enter_context (cm)

Enters a new context manager and adds its @ref{1344,,__exit__()} method to
the callback stack. The return value is the result of the context
manager’s own @ref{5c8,,__enter__()} method.

These context managers may suppress exceptions just as they normally
would if used directly as part of a @ref{5d2,,with} statement.


Alterado na versão 3.11: Raises @ref{2c3,,TypeError} instead of @ref{34b,,AttributeError} if `cm'
is not a context manager.

@end deffn

@geindex push() (método contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack push}@anchor{465c}
@deffn {Método} push (exit)

Adds a context manager’s @ref{1344,,__exit__()} method to the callback stack.

As @code{__enter__} is `not' invoked, this method can be used to cover
part of an @ref{5c8,,__enter__()} implementation with a context manager’s own
@ref{1344,,__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{1344,,__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{1344,,__exit__()} methods can.

The passed in object is returned from the function, allowing this
method to be used as a function decorator.
@end deffn

@geindex callback() (método contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack callback}@anchor{a8d}
@deffn {Método} callback (callback, /, *args, **kwds)

Accepts an arbitrary callback function and arguments and adds it to
the callback stack.

Unlike the other methods, callbacks added this way cannot suppress
exceptions (as they are never passed the exception details).

The passed in callback is returned from the function, allowing this
method to be used as a function decorator.
@end deffn

@geindex pop_all() (método contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack pop_all}@anchor{465d}
@deffn {Método} pop_all ()

Transfers the callback stack to a fresh @ref{b3b,,ExitStack} instance
and returns it. No callbacks are invoked by this operation - instead,
they will now be invoked when the new stack is closed (either
explicitly or implicitly at the end of a @ref{5d2,,with} statement).

For example, a group of files can be opened as an “all or nothing”
operation as follows:

@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 contextlib.ExitStack)
@anchor{library/contextlib contextlib ExitStack close}@anchor{465e}
@deffn {Método} close ()

Immediately unwinds the callback stack, invoking callbacks in the
reverse order of registration. For any context managers and exit
callbacks registered, the arguments passed in will indicate that no
exception occurred.
@end deffn
@end deffn

@geindex AsyncExitStack (classe em contextlib)
@anchor{library/contextlib contextlib AsyncExitStack}@anchor{b3e}
@deffn {Classe} contextlib.AsyncExitStack

An @ref{5fc,,asynchronous context manager}, similar
to @ref{b3b,,ExitStack}, that supports combining both synchronous and
asynchronous context managers, as well as having coroutines for
cleanup logic.

The @ref{465e,,close()} method is not implemented; @ref{465f,,aclose()} must be used
instead.

@geindex enter_async_context() (método contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack enter_async_context}@anchor{5d6}
@deffn {Método} async enter_async_context (cm)

Similar to @ref{5d3,,ExitStack.enter_context()} but expects an asynchronous context
manager.


Alterado na versão 3.11: Raises @ref{2c3,,TypeError} instead of @ref{34b,,AttributeError} if `cm'
is not an asynchronous context manager.

@end deffn

@geindex push_async_exit() (método contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack push_async_exit}@anchor{4660}
@deffn {Método} push_async_exit (exit)

Similar to @ref{465c,,ExitStack.push()} but expects either an asynchronous context manager
or a coroutine function.
@end deffn

@geindex push_async_callback() (método contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack push_async_callback}@anchor{a8e}
@deffn {Método} push_async_callback (callback, /, *args, **kwds)

Similar to @ref{a8d,,ExitStack.callback()} but expects a coroutine function.
@end deffn

@geindex aclose() (método contextlib.AsyncExitStack)
@anchor{library/contextlib contextlib AsyncExitStack aclose}@anchor{465f}
@deffn {Método} async aclose ()

Similar to @ref{465e,,ExitStack.close()} but properly handles awaitables.
@end deffn

Continuing the example for @ref{b3c,,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


Adicionado na versão 3.7.

@end deffn

@node Exemplos e receitas<3>,Single use reusable and reentrant context managers,Utilitários,contextlib — Utilitários para contextos da instrução with
@anchor{library/contextlib examples-and-recipes}@anchor{4661}
@subsubsection Exemplos e receitas


This section describes some examples and recipes for making effective use of
the tools provided by @ref{23,,contextlib}.

@menu
* Supporting a variable number of context managers:: 
* Catching exceptions from __enter__ methods:: 
* Cleaning up in an __enter__ implementation:: 
* Replacing any use of try-finally and flag variables:: 
* Using a context manager as a function decorator:: 

@end menu

@node Supporting a variable number of context managers,Catching exceptions from __enter__ methods,,Exemplos e receitas<3>
@anchor{library/contextlib supporting-a-variable-number-of-context-managers}@anchor{4662}
@subsubsection Supporting a variable number of context managers


The primary use case for @ref{b3b,,ExitStack} is the one given in the class
documentation: supporting a variable number of context managers and other
cleanup operations in a single @ref{5d2,,with} statement. The variability
may come from the number of context managers needed being driven by user
input (such as opening a user specified collection of files), or from
some of the context managers being optional:

@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

As shown, @ref{b3b,,ExitStack} also makes it quite easy to use @ref{5d2,,with}
statements to manage arbitrary resources that don’t natively support the
context management protocol.

@node Catching exceptions from __enter__ methods,Cleaning up in an __enter__ implementation,Supporting a variable number of context managers,Exemplos e receitas<3>
@anchor{library/contextlib catching-exceptions-from-enter-methods}@anchor{4663}
@subsubsection Catching exceptions from @code{__enter__} methods


It is occasionally desirable to catch exceptions from an @code{__enter__}
method implementation, `without' inadvertently catching exceptions from
the @ref{5d2,,with} statement body or the context manager’s @code{__exit__}
method. By using @ref{b3b,,ExitStack} the steps in the context management
protocol can be separated slightly in order to allow this:

@example
stack = ExitStack()
try:
    x = stack.enter_context(cm)
except Exception:
    # handle __enter__ exception
else:
    with stack:
        # Handle normal case
@end example

Actually needing to do this is likely to indicate that the underlying API
should be providing a direct resource management interface for use with
@ref{6e9,,try}/@ref{18b,,except}/@ref{9d2,,finally} statements, but not
all APIs are well designed in that regard. When a context manager is the
only resource management API provided, then @ref{b3b,,ExitStack} can make it
easier to handle various situations that can’t be handled directly in a
@ref{5d2,,with} statement.

@node Cleaning up in an __enter__ implementation,Replacing any use of try-finally and flag variables,Catching exceptions from __enter__ methods,Exemplos e receitas<3>
@anchor{library/contextlib cleaning-up-in-an-enter-implementation}@anchor{4664}
@subsubsection Cleaning up in an @code{__enter__} implementation


As noted in the documentation of @ref{465c,,ExitStack.push()}, this
method can be useful in cleaning up an already allocated resource if later
steps in the @ref{5c8,,__enter__()} implementation fail.

Here’s an example of doing this for a context manager that accepts resource
acquisition and release functions, along with an optional validation function,
and maps them to the context management protocol:

@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 Replacing any use of try-finally and flag variables,Using a context manager as a function decorator,Cleaning up in an __enter__ implementation,Exemplos e receitas<3>
@anchor{library/contextlib replacing-any-use-of-try-finally-and-flag-variables}@anchor{4665}
@subsubsection Replacing any use of @code{try-finally} and flag variables


A pattern you will sometimes see is a @code{try-finally} statement with a flag
variable to indicate whether or not the body of the @code{finally} clause should
be executed. In its simplest form (that can’t already be handled just by
using an @code{except} clause instead), it looks something like this:

@example
cleanup_needed = True
try:
    result = perform_operation()
    if result:
        cleanup_needed = False
finally:
    if cleanup_needed:
        cleanup_resources()
@end example

As with any @code{try} statement based code, this can cause problems for
development and review, because the setup code and the cleanup code can end
up being separated by arbitrarily long sections of code.

@ref{b3b,,ExitStack} makes it possible to instead register a callback for
execution at the end of a @code{with} statement, and then later decide to skip
executing that callback:

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

If a particular application uses this pattern a lot, it can be simplified
even further by means of a small helper class:

@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

If the resource cleanup isn’t already neatly bundled into a standalone
function, then it is still possible to use the decorator form of
@ref{a8d,,ExitStack.callback()} to declare the resource cleanup in
advance:

@example
from contextlib import ExitStack

with ExitStack() as stack:
    @@stack.callback
    def cleanup_resources():
        ...
    result = perform_operation()
    if result:
        stack.pop_all()
@end example

Devido à maneira como o protocolo decorador funciona, uma função de retorno de chamada declarada dessa forma não pode receber nenhum parâmetro. Em vez disso, quaisquer recursos a serem liberados devem ser acessados como variáveis de clausura.

@node Using a context manager as a function decorator,,Replacing any use of try-finally and flag variables,Exemplos e receitas<3>
@anchor{library/contextlib using-a-context-manager-as-a-function-decorator}@anchor{4666}
@subsubsection Using a context manager as a function decorator


@ref{1241,,ContextDecorator} makes it possible to use a context manager in
both an ordinary @code{with} statement and also as a function decorator.

For example, it is sometimes useful to wrap functions or groups of statements
with a logger that can track the time of entry and time of exit.  Rather than
writing both a function decorator and a context manager for the task,
inheriting from @ref{1241,,ContextDecorator} provides both capabilities in a
single definition:

@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

Instances of this class can be used as both a context manager:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

And also as a function decorator:

@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{5c8,,__enter__()}. If that value is needed, then it is still necessary to use
an explicit @code{with} statement.


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - A instrução “with”

A especificação, o histórico e os exemplos para a instrução Python @ref{5d2,,with}.
@end table


@node Single use reusable and reentrant context managers,,Exemplos e receitas<3>,contextlib — Utilitários para contextos da instrução with
@anchor{library/contextlib single-use-reusable-and-reentrant-cms}@anchor{f5a}@anchor{library/contextlib single-use-reusable-and-reentrant-context-managers}@anchor{4667}
@subsubsection Single use, reusable and reentrant context managers


Most context managers are written in a way that means they can only be
used effectively in a @ref{5d2,,with} statement once. These single use
context managers must be created afresh each time they’re used -
attempting to use them a second time will trigger an exception or
otherwise not work correctly.

This common limitation means that it is generally advisable to create
context managers directly in the header of the @ref{5d2,,with} statement
where they are used (as shown in all of the usage examples above).

Files are an example of effectively single use context managers, since
the first @ref{5d2,,with} statement will close the file, preventing any
further IO operations using that file object.

Context managers created using @ref{1242,,contextmanager()} are also single use
context managers, and will complain about the underlying generator failing
to yield if an attempt is made to use them a second time:

@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
* Reentrant context managers:: 
* Gerenciadores de contexto reutilizáveis:: 

@end menu

@node Reentrant context managers,Gerenciadores de contexto reutilizáveis,,Single use reusable and reentrant context managers
@anchor{library/contextlib reentrant-cms}@anchor{465b}@anchor{library/contextlib reentrant-context-managers}@anchor{4668}
@subsubsection Reentrant context managers


More sophisticated context managers may be “reentrant”. These context
managers can not only be used in multiple @ref{5d2,,with} statements,
but may also be used `inside' a @code{with} statement that is already
using the same context manager.

@ref{2de,,threading.RLock} is an example of a reentrant context manager, as are
@ref{f58,,suppress()}, @ref{e12,,redirect_stdout()}, and @ref{60c,,chdir()}. Here’s a very
simple example of reentrant use:

@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

Real world examples of reentrancy are more likely to involve multiple
functions calling each other and hence be far more complicated than this
example.

Note also that being reentrant is `not' the same thing as being thread safe.
@ref{e12,,redirect_stdout()}, for example, is definitely not thread safe, as it
makes a global modification to the system state by binding @ref{ae6,,sys.stdout}
to a different stream.

@node Gerenciadores de contexto reutilizáveis,,Reentrant context managers,Single use reusable and reentrant context managers
@anchor{library/contextlib reusable-cms}@anchor{4669}@anchor{library/contextlib reusable-context-managers}@anchor{466a}
@subsubsection Gerenciadores de contexto reutilizáveis


Distinct from both single use and reentrant context managers are “reusable”
context managers (or, to be completely explicit, “reusable, but not
reentrant” context managers, since reentrant context managers are also
reusable). These context managers support being used multiple times, but
will fail (or otherwise not work correctly) if the specific context manager
instance has already been used in a containing with statement.

@ref{176d,,threading.Lock} is an example of a reusable, but not reentrant,
context manager (for a reentrant lock, it is necessary to use
@ref{2de,,threading.RLock} instead).

Another example of a reusable, but not reentrant, context manager is
@ref{b3b,,ExitStack}, as it invokes `all' currently registered callbacks
when leaving any with statement, regardless of where those callbacks
were added:

@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

As the output from the example shows, reusing a single stack object across
multiple with statements works correctly, but attempting to nest them
will cause the stack to be cleared at the end of the innermost with
statement, which is unlikely to be desirable behaviour.

Using separate @ref{b3b,,ExitStack} instances instead of reusing a single
instance avoids that problem:

@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 — Classes base abstratas,atexit — Manipuladores de saída,contextlib — Utilitários para contextos da instrução with,Serviços de Tempo de Execução Python
@anchor{library/abc doc}@anchor{466b}@anchor{library/abc abc-abstract-base-classes}@anchor{466c}@anchor{library/abc module-abc}@anchor{4}@anchor{library/abc translation-repo}@anchor{466d}
@subsection @code{abc} — Classes base abstratas


@geindex module; abc

@c much of the content adapted from docstrings

`Código-fonte:' Lib/abc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/abc.py}


__________________________________________________________________


Este módulo fornece a infraestrutura para definir @ref{11f5,,classes base abstratas} (ABCs, do inglês `abstract base class') em Python, como delineado em 
@geindex Propostas de Melhorias do Python; PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}; veja o PEP para entender o porquê isto foi adicionado ao Python. (Veja também 
@geindex Propostas de Melhorias do Python; PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/} e o módulo @ref{9e,,numbers} sobre uma hierarquia de tipo para números baseado nas ABCs.)

O módulo @ref{1d,,collections} tem algumas classes concretas que derivam de ABCs; essas podem, evidentemente, ser ainda mais derivadas. Além disso, o submódulo @ref{1e,,collections.abc} tem algumas ABCs que podem ser usadas para testar se uma classe ou instância oferece uma interface particular, por exemplo, se é @ref{610,,hasheável} ou se é um @ref{11fb,,mapeamento}.

Este módulo fornece a metaclasse @ref{f4a,,ABCMeta} para definir ABCs e uma classe auxiliar @ref{f49,,ABC} para alternativamente definir ABCs através de herança:

@geindex ABC (classe em abc)
@anchor{library/abc abc ABC}@anchor{f49}
@deffn {Classe} abc.ABC

Uma classe auxiliar que tem @ref{f4a,,ABCMeta} como sua metaclasse. Com essa classe, uma classe base abstrata pode ser criada simplesmente derivando da @code{ABC} evitando às vezes confundir o uso da metaclasse, por exemplo:

@example
from abc import ABC

class MyABC(ABC):
    pass
@end example

Note que o tipo da classe @code{ABC} ainda é @ref{f4a,,ABCMeta}, portanto herdar da @code{ABC} requer as precauções usuais a respeito do uso da metaclasse, pois herança múltipla pode levar a conflitos de metaclasse. Pode-se também definir uma classe base abstrata ao passar a palavra reservada metaclasse e usar @code{ABCMeta} diretamente, por exemplo:

@example
from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass
@end example


Adicionado na versão 3.4.

@end deffn

@geindex ABCMeta (classe em abc)
@anchor{library/abc abc ABCMeta}@anchor{f4a}
@deffn {Classe} abc.ABCMeta

Metaclasse para definir Classe Base Abstrata (ABCs).

Use esta metaclasse para criar uma ABC. Uma ABC pode ser diretamente estendida, e então agir como uma classe misturada. Você também pode registrar classes concretas não relacionadas (até mesmo classes embutidas) e ABCs não relacionadas como “subclasses virtuais” – estas e suas descendentes serão consideradas subclasses da ABC de registro pela função embutida @ref{7c2,,issubclass()}, mas a ABC de registro não irá aparecer na MRO (Ordem de Resolução do Método) e nem as implementações do método definidas pela ABC de registro será chamável (nem mesmo via @ref{4db,,super()}). @footnote{
Programadores C++ devem notar que o conceito da classe base virtual do Python não é o mesmo que o de C++.
}

Classes criadas com a metaclasse de @code{ABCMeta} tem o seguinte método:

@geindex register() (método abc.ABCMeta)
@anchor{library/abc abc ABCMeta register}@anchor{10c7}
@deffn {Método} register (subclass)

Registra `subclass' como uma “subclasse virtual” desta ABC. Por exemplo:

@example
from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

assert issubclass(tuple, MyABC)
assert isinstance((), MyABC)
@end example


Alterado na versão 3.3: Retorna a subclasse registrada, para permitir o uso como um decorador de classe.



Alterado na versão 3.4: Para detectar chamadas para @code{register()}, você pode usar a função @ref{f48,,get_cache_token()}.

@end deffn

Você também pode sobrepor este método em uma classe base abstrata:

@geindex __subclasshook__() (método abc.ABCMeta)
@anchor{library/abc abc ABCMeta __subclasshook__}@anchor{26cb}
@deffn {Método} __subclasshook__ (subclass)

(Deve obrigatoriamente ser definido como um método de classe.)

Verifica se `subclass' é considerada uma subclasse desta ABC. Isto significa que você pode personalizar ainda mais o comportamento de @ref{7c2,,issubclass()} sem a necessidade de chamar @ref{10c7,,register()} em toda classe que você queira considerar uma subclasse da ABC. (Este método de classe é chamado do método @ref{2109,,__subclasscheck__()} da ABC.)

Este método deve retornar @code{True}, @code{False} ou @ref{7d3,,NotImplemented}. Se retornar @code{True}, `subclass' é considerada uma subclasse desta ABC. Se retornar @code{False}, `subclass' não é considerada uma subclasse desta ABC, mesmo que normalmente seria uma. Se retornar @code{NotImplemented}, a verificação da subclasse é continuada com o mecanismo usual.

@c XXX explain the "usual mechanism"
@end deffn

Para uma demonstração destes conceitos, veja este exemplo de definição ABC:

@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

A @code{MyIterable} da ABC define o método iterável padrão, @ref{c8a,,__iter__()}, como um método abstrato. A implementação dada aqui pode ainda ser chamada da subclasse. O método @code{get_iterator()} é também parte da classe base abstrata @code{MyIterable}, mas não precisa ser substituído nas classes derivadas não abstratas.

O método de classe @ref{26cb,,__subclasshook__()} definido aqui diz que qualquer classe que tenha um método @ref{c8a,,__iter__()} em seu @ref{55b,,__dict__} (ou no de uma de suas classes base, acessados via lista @ref{20bb,,__mro__}) é considerada uma @code{MyIterable} também.

Finalmente, a última linha faz de @code{Foo} uma subclasse virtual da @code{MyIterable}, apesar de não definir um método @ref{c8a,,__iter__()} (ela usa o protocolo iterável antigo, definido em termos de @ref{15b4,,__len__()} e @ref{283,,__getitem__()}). Note que isto não fará o @code{get_iterator} disponível como um método de @code{Foo}, então ele é fornecido separadamente.
@end deffn

O módulo @code{abc} também fornece o seguinte decorador:

@geindex abstractmethod() (no módulo abc)
@anchor{library/abc abc abstractmethod}@anchor{10c4}
@deffn {Função} @@abc.abstractmethod

Um decorador indicando métodos abstratos.

Usar este decorador requer que a metaclasse da classe seja @ref{f4a,,ABCMeta} ou seja derivada desta. Uma classe que tem uma metaclasse derivada de @code{ABCMeta} não pode ser instanciada, a menos que todos os seus métodos abstratos e propriedades estejam substituídos. Os métodos abstratos podem ser chamados usando qualquer um dos mecanismos normais de chamadas a ‘super’. @code{abstractmethod()} pode ser usado para declarar métodos abstratos para propriedades e descritores.

Adicionar dinamicamente métodos abstratos a uma classe, ou tentar modificar o status de abstração de um método ou classe uma vez que estejam criados, só é suportado usando a função @ref{466e,,update_abstractmethods()}. A @code{abstractmethod()} afeta apenas subclasses derivadas usando herança regular; “subclasses virtuais” registradas com o método @ref{10c7,,register()} da ABC não são afetadas.

Quando @code{abstractmethod()} é aplicado em combinação com outros descritores de método, ele deve ser aplicado como o decorador mais interno, como mostrado nos seguintes exemplos de uso:

@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

Para que interopere corretamente com o maquinário da classe base abstrata, o descritor precisa identificar-se como abstrato usando @code{__isabstractmethod__}. No geral, este atributo deve ser @code{True} se algum dos métodos usados para compor o descritor for abstrato. Por exemplo, a @ref{194,,property} embutida do Python faz o equivalente a:

@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 
Diferente de métodos abstratos Java, esses métodos abstratos podem ter uma implementação. Esta implementação pode ser chamada via mecanismo da @ref{4db,,super()} da classe que a substitui. Isto pode ser útil como um ponto final para uma super chamada em um framework que usa herança múltipla cooperativa.
@end quotation
@end cartouche
@end deffn

O módulo @code{abc} também suporta os seguintes decoradores herdados:

@geindex abstractclassmethod() (no módulo abc)
@anchor{library/abc abc abstractclassmethod}@anchor{10c5}
@deffn {Função} @@abc.abstractclassmethod


Adicionado na versão 3.2.



Descontinuado desde a versão 3.3: Agora é possível usar @ref{166,,classmethod} com @ref{10c4,,abstractmethod()}, tornando redundante este decorador.


Uma subclasse da @ref{166,,classmethod()} embutida, indicando um método de classe abstrato. Caso contrário, é similar à @ref{10c4,,abstractmethod()}.

Este caso especial está descontinuado, pois o decorador da @ref{166,,classmethod()} está agora corretamente identificado como abstrato quando aplicado a um método abstrato:

@example
class C(ABC):
    @@classmethod
    @@abstractmethod
    def my_abstract_classmethod(cls, arg):
        ...
@end example
@end deffn

@geindex abstractstaticmethod() (no módulo abc)
@anchor{library/abc abc abstractstaticmethod}@anchor{10c6}
@deffn {Função} @@abc.abstractstaticmethod


Adicionado na versão 3.2.



Descontinuado desde a versão 3.3: Agora é possível usar @ref{416,,staticmethod} com @ref{10c4,,abstractmethod()}, tornando redundante este decorador.


Uma subclasse da @ref{416,,staticmethod()} embutida, indicando um método estático abstrato. Caso contrário, ela é similar à @ref{10c4,,abstractmethod()}.

Este caso especial está descontinuado, pois o decorador da @ref{416,,staticmethod()} está agora corretamente identificado como abstrato quando aplicado a um método abstrato:

@example
class C(ABC):
    @@staticmethod
    @@abstractmethod
    def my_abstract_staticmethod(arg):
        ...
@end example
@end deffn

@geindex abstractproperty() (no módulo abc)
@anchor{library/abc abc abstractproperty}@anchor{10c3}
@deffn {Função} @@abc.abstractproperty


Descontinuado desde a versão 3.3: Agora é possível usar @ref{194,,property}, @ref{1750,,property.getter()}, @ref{1751,,property.setter()} e @ref{1752,,property.deleter()} com @ref{10c4,,abstractmethod()}, tornando redundante este decorador.


Uma subclasse da @ref{194,,property()} embutida, indicando uma propriedade abstrata.

Este caso especial está descontinuado, pois o decorador da @ref{194,,property()} está agora corretamente identificado como abstrato quando aplicado a um método abstrato:

@example
class C(ABC):
    @@property
    @@abstractmethod
    def my_abstract_property(self):
        ...
@end example

O exemplo acima define uma propriedade somente leitura; você também pode definir uma propriedade abstrata de leitura e escrita marcando apropriadamente um ou mais dos métodos subjacentes como abstratos:

@example
class C(ABC):
    @@property
    def x(self):
        ...

    @@x.setter
    @@abstractmethod
    def x(self, val):
        ...
@end example

Se apenas alguns componentes são abstratos, apenas estes componentes precisam ser atualizados para criar uma propriedade concreta em uma subclasse:

@example
class D(C):
    @@C.x.setter
    def x(self, val):
        ...
@end example
@end deffn

O módulo @code{abc} também fornece as seguintes funções:

@geindex get_cache_token() (no módulo abc)
@anchor{library/abc abc get_cache_token}@anchor{f48}
@deffn {Função} abc.get_cache_token ()

Retorna o token de cache da classe base abstrata atual.

O token é um objeto opaco (que suporta teste de igualdade) identificando a versão atual do cache da classe base abstrata para subclasses virtuais. O token muda a cada chamada ao @ref{10c7,,ABCMeta.register()} em qualquer CBA.


Adicionado na versão 3.4.

@end deffn

@geindex update_abstractmethods() (no módulo abc)
@anchor{library/abc abc update_abstractmethods}@anchor{466e}
@deffn {Função} abc.update_abstractmethods (cls)

Uma função para recalcular o status de abstração de uma classe abstrata. Esta função deve ser chamada se os métodos abstratos de uma classe foram implementados ou alterados após sua criação. Normalmente, essa função deve ser chamada de dentro de um decorador de classe.

Retorna `cls', para permitir o uso como decorador de classe.

Se `cls' não for uma instância de @ref{f4a,,ABCMeta}, não faz nada.

@cartouche
@quotation Nota 
Esta função presume que as superclasses de `cls' já estão atualizadas. Ele não atualiza nenhuma subclasse.
@end quotation
@end cartouche


Adicionado na versão 3.10.

@end deffn

@node atexit — Manipuladores de saída,traceback — Imprime ou recupera um traceback da pilha,abc — Classes base abstratas,Serviços de Tempo de Execução Python
@anchor{library/atexit doc}@anchor{466f}@anchor{library/atexit atexit-exit-handlers}@anchor{4670}@anchor{library/atexit module-atexit}@anchor{c}@anchor{library/atexit translation-repo}@anchor{4671}
@subsection @code{atexit} — Manipuladores de saída


@geindex module; atexit


__________________________________________________________________


O módulo @ref{c,,atexit} define funções para registrar e cancelar o registro de funções de limpeza. As funções assim registradas são executadas automaticamente após a conclusão normal do interpretador. O módulo @ref{c,,atexit} executa essas funções na ordem `reversa' na qual foram registradas; se você inscrever @code{A}, @code{B} e @code{C}, no momento do término do interpretador, eles serão executados na ordem @code{C}, @code{B}, @code{A} .

`Nota:' As funções registradas através deste módulo não são invocadas quando o programa é morto por um sinal não tratado pelo Python, quando um erro interno fatal do Python é detectado ou quando a função @ref{242f,,os._exit()} é invocada.

`Nota:' O efeito de registrar ou cancelar o registro de funções dentro de uma função de limpeza é indefinido.


Alterado na versão 3.7: Quando usadas com os subinterpretadores de C-API, as funções registradas são locais para o interpretador em que foram registradas.


@geindex register() (no módulo atexit)
@anchor{library/atexit atexit register}@anchor{882}
@deffn {Função} atexit.register (func, *args, **kwargs)

Registre `func' como uma função a ser executada no término. Qualquer o argumento opcional que deve ser passado para `func' for passado como argumento para @ref{882,,register()}. É possível registrar mais ou menos a mesma função e argumentos.

Na terminação normal do programa (por exemplo, se @ref{138e,,sys.exit()} for chamado ou a execução do módulo principal for concluída), todas as funções registradas serão chamadas por último, pela primeira ordem. A suposição é que os módulos de nível inferior normalmente serão importados antes dos módulos de nível mais alto e, portanto, devem ser limpos posteriormente.

Se uma exceção é levantada durante a execução dos manipuladores de saída, um traceback é impresso (a menos que @ref{d63,,SystemExit} seja levantada) e as informações de exceção sejam salvas. Depois de todos os manipuladores de saída terem tido a chance de executar a última exceção a ser levantada, é levantada novamente.

Esta função retorna `func', o que torna possível usá-la como um decorador.

@cartouche
@quotation Aviso 
Iniciar novas threads ou chamar @ref{197,,os.fork()} de uma função registrada pode levar a uma condição de corrida entre os estados de thread de liberação de thread principal do tempo de execução do Python enquanto as rotinas internas @ref{ed,,threading} ou o novo processo tentam usar esse estado. Isso pode levar a travamentos em vez de desligamento normal.
@end quotation
@end cartouche


Alterado na versão 3.12: Tentativas de iniciar uma nova thread ou @ref{197,,os.fork()} um novo processo em uma função registrada agora leva a @ref{195,,RuntimeError}.

@end deffn

@geindex unregister() (no módulo atexit)
@anchor{library/atexit atexit unregister}@anchor{15a6}
@deffn {Função} atexit.unregister (func)

Remove `func' da lista de funções a serem executadas no desligamento do interpretador. @ref{15a6,,unregister()} silenciosamente não faz nada se `func' não foi registrado anteriormente. Se `func' foi registrado mais de uma vez, cada ocorrência dessa função na pilha de chamada @ref{c,,atexit} será removida. Comparações de igualdade (@code{==}) são usadas internamente durante o cancelamento do registro, portanto, as referências de função não precisam ter identidades correspondentes.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{ba,,readline}

Exemplo útil de @ref{c,,atexit} para ler e escrever arquivos de histórico de @ref{ba,,readline}.
@end table


@menu
* Exemplo do atexit:: 

@end menu

@node Exemplo do atexit,,,atexit — Manipuladores de saída
@anchor{library/atexit atexit-example}@anchor{4672}@anchor{library/atexit id1}@anchor{4673}
@subsubsection Exemplo do @code{atexit}


O exemplo simples a seguir demonstra como um módulo pode inicializar um contador de um arquivo quando ele é importado e salvar automaticamente o valor atualizado do contador quando o programa termina, sem depender que a aplicação faça uma chamada explícita nesse módulo na finalização.

@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

Os argumentos posicional e de palavra reservada também podem ser passados para @ref{882,,register()} para ser passada para a função registrada quando é chamada

@example
def goodbye(name, adjective):
    print('Goodbye %s, it was %s to meet you.' % (name, adjective))

import atexit

atexit.register(goodbye, 'Donny', 'nice')
# ou:
atexit.register(goodbye, adjective='nice', name='Donny')
@end example

Utilizado como um @ref{731,,decorador}:

@example
import atexit

@@atexit.register
def goodbye():
    print('You are now leaving the Python sector.')
@end example

Isso só funciona com funções que podem ser invocadas sem argumentos.

@node traceback — Imprime ou recupera um traceback da pilha,__future__ — Definições de instruções future,atexit — Manipuladores de saída,Serviços de Tempo de Execução Python
@anchor{library/traceback doc}@anchor{4674}@anchor{library/traceback module-traceback}@anchor{fe}@anchor{library/traceback traceback-print-or-retrieve-a-stack-traceback}@anchor{4675}@anchor{library/traceback translation-repo}@anchor{4676}
@subsection @code{traceback} — Imprime ou recupera um traceback da pilha


@geindex module; traceback

`Código-fonte:' Lib/traceback.py@footnote{https://github.com/python/cpython/tree/3.13/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 objeto;traceback

The module uses @ref{b07,,traceback objects} — these are
objects of type @ref{b05,,types.TracebackType},
which are assigned to the @ref{1309,,__traceback__} field of
@ref{5bb,,BaseException} instances.


@subsubheading Ver também



@table @asis

@item Módulo @ref{58,,faulthandler}

Usado para despejar tracebacks (situação da pilha de execução) do Python explicitamente, em uma falha, após um tempo limite ou em um sinal do usuário.

@item Module @ref{a5,,pdb}

Interactive source code debugger for Python programs.
@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{25c,,TracebackException} class and its helper classes
@ref{eb2,,StackSummary} and @ref{eb3,,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
* Funções de nível de módulo: Funções de nível de módulo<2>. 
* TracebackException Objects:: 
* StackSummary Objects:: 
* FrameSummary Objects:: 
* Examples of Using the Module-Level Functions:: 
* Examples of Using TracebackException:: 

@end menu

@node Funções de nível de módulo<2>,TracebackException Objects,,traceback — Imprime ou recupera um traceback da pilha
@anchor{library/traceback module-level-functions}@anchor{4677}
@subsubsection Funções de nível de módulo


@geindex print_tb() (no módulo traceback)
@anchor{library/traceback traceback print_tb}@anchor{eb4}
@deffn {Função} traceback.print_tb (tb, limit=None, file=None)

Print up to `limit' stack trace entries from
@ref{b07,,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{940,,sys.stderr}; otherwise it should be an open
@ref{1203,,file} or @ref{15cf,,file-like object} to
receive the output.

@cartouche
@quotation Nota 
The meaning of the `limit' parameter is different than the meaning
of @ref{16c4,,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


Alterado na versão 3.5: Added negative `limit' support.

@end deffn

@geindex print_exception() (no módulo traceback)
@anchor{library/traceback traceback print_exception}@anchor{852}
@deffn {Função} traceback.print_exception (exc, /[, value, tb], limit=None, file=None, chain=True)

Print exception information and stack trace entries from
@ref{b07,,traceback object}
`tb' to `file'. This differs from @ref{eb4,,print_tb()} in the following
ways:


@itemize *

@item 
if `tb' is not @code{None}, it prints a header @code{Traceback (most recent
call last):}

@item 
it prints the exception type and `value' after the stack trace
@end itemize

@geindex ^ (circunflexo);marker


@itemize *

@item 
if `type(value)' is @ref{18d,,SyntaxError} and `value' has the appropriate
format, it prints the line where the syntax error occurred with a caret
indicating the approximate position of the error.
@end itemize

Since Python 3.10, instead of passing `value' and `tb', an exception object
can be passed as the first argument. If `value' and `tb' are provided, the
first argument is ignored in order to provide backwards compatibility.

The optional `limit' argument has the same meaning as for @ref{eb4,,print_tb()}.
If `chain' is true (the default), then chained exceptions (the
@ref{130b,,__cause__} or @ref{130a,,__context__}
attributes of the exception) will be
printed as well, like the interpreter itself does when printing an unhandled
exception.


Alterado na versão 3.5: The `etype' argument is ignored and inferred from the type of `value'.



Alterado na versão 3.10: The `etype' parameter has been renamed to `exc' and is now
positional-only.

@end deffn

@geindex print_exc() (no módulo traceback)
@anchor{library/traceback traceback print_exc}@anchor{19ad}
@deffn {Função} traceback.print_exc (limit=None, file=None, chain=True)

This is a shorthand for @code{print_exception(sys.exception(), limit=limit, file=file,
chain=chain)}.
@end deffn

@geindex print_last() (no módulo traceback)
@anchor{library/traceback traceback print_last}@anchor{4678}
@deffn {Função} traceback.print_last (limit=None, file=None, chain=True)

This is a shorthand for @code{print_exception(sys.last_exc, limit=limit, file=file,
chain=chain)}.  In general it will work only after an exception has reached
an interactive prompt (see @ref{4be,,sys.last_exc}).
@end deffn

@geindex print_stack() (no módulo traceback)
@anchor{library/traceback traceback print_stack}@anchor{eb5}
@deffn {Função} 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{6e0,,stack frame}
to start.  The optional `file' argument has the same meaning as for
@ref{eb4,,print_tb()}.


Alterado na versão 3.5: Added negative `limit' support.

@end deffn

@geindex extract_tb() (no módulo traceback)
@anchor{library/traceback traceback extract_tb}@anchor{4679}
@deffn {Função} traceback.extract_tb (tb, limit=None)

Return a @ref{eb2,,StackSummary} object representing a list of “pre-processed”
stack trace entries extracted from the
@ref{b07,,traceback object} `tb'.  It is useful
for alternate formatting of stack traces.  The optional `limit' argument has
the same meaning as for @ref{eb4,,print_tb()}.  A “pre-processed” stack trace
entry is a @ref{eb3,,FrameSummary} object containing attributes
@ref{467a,,filename}, @ref{467b,,lineno},
@ref{467c,,name}, and @ref{467d,,line} representing the
information that is usually printed for a stack trace.
@end deffn

@geindex extract_stack() (no módulo traceback)
@anchor{library/traceback traceback extract_stack}@anchor{467e}
@deffn {Função} traceback.extract_stack (f=None, limit=None)

Extract the raw traceback from the current
@ref{6e0,,stack frame}.  The return value has
the same format as for @ref{4679,,extract_tb()}.  The optional `f' and `limit'
arguments have the same meaning as for @ref{eb5,,print_stack()}.
@end deffn

@geindex print_list() (no módulo traceback)
@anchor{library/traceback traceback print_list}@anchor{467f}
@deffn {Função} traceback.print_list (extracted_list, file=None)

Print the list of tuples as returned by @ref{4679,,extract_tb()} or
@ref{467e,,extract_stack()} as a formatted stack trace to the given file.
If `file' is @code{None}, the output is written to @ref{940,,sys.stderr}.
@end deffn

@geindex format_list() (no módulo traceback)
@anchor{library/traceback traceback format_list}@anchor{4680}
@deffn {Função} traceback.format_list (extracted_list)

Given a list of tuples or @ref{eb3,,FrameSummary} objects as returned by
@ref{4679,,extract_tb()} or @ref{467e,,extract_stack()}, return a list of strings ready
for printing.  Each string in the resulting list corresponds to the item with
the same index in the argument list.  Each string ends in a newline; the
strings may contain internal newlines as well, for those items whose source
text line is not @code{None}.
@end deffn

@geindex format_exception_only() (no módulo traceback)
@anchor{library/traceback traceback format_exception_only}@anchor{851}
@deffn {Função} 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{4c0,,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{18d,,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{2419,,notes}.

Since Python 3.10, instead of passing `value', an exception object
can be passed as the first argument.  If `value' is provided, the first
argument is ignored in order to provide backwards compatibility.

When `show_group' is @code{True}, and the exception is an instance of
@ref{25f,,BaseExceptionGroup}, the nested exceptions are included as
well, recursively, with indentation relative to their nesting depth.


Alterado na versão 3.10: The `etype' parameter has been renamed to `exc' and is now
positional-only.



Alterado na versão 3.11: The returned list now includes any
@ref{2419,,notes} attached to the exception.



Alterado na versão 3.13: `show_group' parameter was added.

@end deffn

@geindex format_exception() (no módulo traceback)
@anchor{library/traceback traceback format_exception}@anchor{850}
@deffn {Função} traceback.format_exception (exc, /[, value, tb], limit=None, chain=True)

Format a stack trace and the exception information.  The arguments  have the
same meaning as the corresponding arguments to @ref{852,,print_exception()}.  The
return value is a list of strings, each ending in a newline and some
containing internal newlines.  When these lines are concatenated and printed,
exactly the same text is printed as does @ref{852,,print_exception()}.


Alterado na versão 3.5: The `etype' argument is ignored and inferred from the type of `value'.



Alterado na versão 3.10: This function’s behavior and signature were modified to match
@ref{852,,print_exception()}.

@end deffn

@geindex format_exc() (no módulo traceback)
@anchor{library/traceback traceback format_exc}@anchor{4681}
@deffn {Função} traceback.format_exc (limit=None, chain=True)

This is like @code{print_exc(limit)} but returns a string instead of printing to
a file.
@end deffn

@geindex format_tb() (no módulo traceback)
@anchor{library/traceback traceback format_tb}@anchor{4546}
@deffn {Função} traceback.format_tb (tb, limit=None)

A shorthand for @code{format_list(extract_tb(tb, limit))}.
@end deffn

@geindex format_stack() (no módulo traceback)
@anchor{library/traceback traceback format_stack}@anchor{4682}
@deffn {Função} traceback.format_stack (f=None, limit=None)

A shorthand for @code{format_list(extract_stack(f, limit))}.
@end deffn

@geindex clear_frames() (no módulo traceback)
@anchor{library/traceback traceback clear_frames}@anchor{100a}
@deffn {Função} traceback.clear_frames (tb)

Clears the local variables of all the stack frames in a
@ref{b07,,traceback} `tb'
by calling the @ref{280,,clear()} method of each
@ref{6e0,,frame object}.


Adicionado na versão 3.4.

@end deffn

@geindex walk_stack() (no módulo traceback)
@anchor{library/traceback traceback walk_stack}@anchor{eb0}
@deffn {Função} traceback.walk_stack (f)

Walk a stack following @ref{78c,,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{4683,,StackSummary.extract()}.


Adicionado na versão 3.5.

@end deffn

@geindex walk_tb() (no módulo traceback)
@anchor{library/traceback traceback walk_tb}@anchor{eb1}
@deffn {Função} traceback.walk_tb (tb)

Walk a traceback following @ref{b06,,tb_next} yielding the frame and
line number
for each frame. This helper is used with @ref{4683,,StackSummary.extract()}.


Adicionado na versão 3.5.

@end deffn

@node TracebackException Objects,StackSummary Objects,Funções de nível de módulo<2>,traceback — Imprime ou recupera um traceback da pilha
@anchor{library/traceback tracebackexception-objects}@anchor{4684}
@subsubsection @code{TracebackException} Objects



Adicionado na versão 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{b07,,traceback} and @ref{6e0,,frame} objects.
In addition, they expose more options to configure the output compared to
the module-level functions described above.

@geindex TracebackException (classe em traceback)
@anchor{library/traceback traceback TracebackException}@anchor{25c}
@deffn {Classe} 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{eb2,,StackSummary}
class.

If `compact' is true, only data that is required by
@code{TracebackException}’s @ref{61f,,format()} method
is saved in the class attributes. In particular, the
@ref{4685,,__context__} field is calculated only if @ref{4686,,__cause__} is
@code{None} and @ref{4687,,__suppress_context__} is false.

Note that when locals are captured, they are also shown in the traceback.

`max_group_width' and `max_group_depth' control the formatting of exception
groups (see @ref{25f,,BaseExceptionGroup}). The depth refers to the nesting
level of the group, and the width refers to the size of a single exception
group’s exceptions array. The formatted output is truncated when either
limit is exceeded.


Alterado na versão 3.10: Adicionado o parâmetro `compact'.



Alterado na versão 3.11: Added the `max_group_width' and `max_group_depth' parameters.


@geindex __cause__ (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __cause__}@anchor{4686}
@deffn {Atributo} __cause__

A @code{TracebackException} of the original
@ref{130b,,__cause__}.
@end deffn

@geindex __context__ (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __context__}@anchor{4685}
@deffn {Atributo} __context__

A @code{TracebackException} of the original
@ref{130a,,__context__}.
@end deffn

@geindex exceptions (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exceptions}@anchor{4688}
@deffn {Atributo} exceptions

If @code{self} represents an @ref{1b6,,ExceptionGroup}, this field holds a list of
@code{TracebackException} instances representing the nested exceptions.
Otherwise it is @code{None}.


Adicionado na versão 3.11.

@end deffn

@geindex __suppress_context__ (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __suppress_context__}@anchor{4687}
@deffn {Atributo} __suppress_context__

The @ref{224a,,__suppress_context__} value from the original
exception.
@end deffn

@geindex __notes__ (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException __notes__}@anchor{4689}
@deffn {Atributo} __notes__

The @ref{2419,,__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.


Adicionado na versão 3.11.

@end deffn

@geindex stack (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException stack}@anchor{468a}
@deffn {Atributo} stack

A @ref{eb2,,StackSummary} representing the traceback.
@end deffn

@geindex exc_type (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exc_type}@anchor{25d}
@deffn {Atributo} exc_type

The class of the original traceback.


Descontinuado desde a versão 3.13.

@end deffn

@geindex exc_type_str (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException exc_type_str}@anchor{25b}
@deffn {Atributo} exc_type_str

String display of the class of the original exception.


Adicionado na versão 3.13.

@end deffn

@geindex filename (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException filename}@anchor{468b}
@deffn {Atributo} filename

For syntax errors - the file name where the error occurred.
@end deffn

@geindex lineno (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException lineno}@anchor{468c}
@deffn {Atributo} lineno

For syntax errors - the line number where the error occurred.
@end deffn

@geindex end_lineno (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException end_lineno}@anchor{468d}
@deffn {Atributo} end_lineno

For syntax errors - the end line number where the error occurred.
Can be @code{None} if not present.


Adicionado na versão 3.10.

@end deffn

@geindex text (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException text}@anchor{468e}
@deffn {Atributo} text

For syntax errors - the text where the error occurred.
@end deffn

@geindex offset (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException offset}@anchor{468f}
@deffn {Atributo} offset

For syntax errors - the offset into the text where the error occurred.
@end deffn

@geindex end_offset (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException end_offset}@anchor{4690}
@deffn {Atributo} end_offset

For syntax errors - the end offset into the text where the error occurred.
Can be @code{None} if not present.


Adicionado na versão 3.10.

@end deffn

@geindex msg (atributo traceback.TracebackException)
@anchor{library/traceback traceback TracebackException msg}@anchor{4691}
@deffn {Atributo} msg

For syntax errors - the compiler error message.
@end deffn

@geindex from_exception() (método de classe traceback.TracebackException)
@anchor{library/traceback traceback TracebackException from_exception}@anchor{4692}
@deffn {Método} classmethod from_exception (exc, *, limit=None, lookup_lines=True, capture_locals=False)

Capture an exception for later rendering. `limit', `lookup_lines' and
`capture_locals' are as for the @ref{eb2,,StackSummary} class.

Note that when locals are captured, they are also shown in the traceback.
@end deffn

@geindex print() (método traceback.TracebackException)
@anchor{library/traceback traceback TracebackException print}@anchor{6a4}
@deffn {Método} print (*, file=None, chain=True)

Print to `file' (default @code{sys.stderr}) the exception information returned by
@ref{61f,,format()}.


Adicionado na versão 3.11.

@end deffn

@geindex format() (método traceback.TracebackException)
@anchor{library/traceback traceback TracebackException format}@anchor{4693}
@deffn {Método} format (*, chain=True)

Format the exception.

If `chain' is not @code{True}, @ref{4686,,__cause__} and @ref{4685,,__context__}
will not be formatted.

The return value is a generator of strings, each ending in a newline and
some containing internal newlines. @ref{852,,print_exception()}
is a wrapper around this method which just prints the lines to a file.
@end deffn

@geindex format_exception_only() (método traceback.TracebackException)
@anchor{library/traceback traceback TracebackException format_exception_only}@anchor{25e}
@deffn {Método} format_exception_only (*, show_group=False)

Format the exception part of the traceback.

The return value is a generator of strings, each ending in a newline.

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{18d,,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{25f,,BaseExceptionGroup}, the nested exceptions are included as
well, recursively, with indentation relative to their nesting depth.


Alterado na versão 3.11: The exception’s @ref{2419,,notes} are now
included in the output.



Alterado na versão 3.13: Added the `show_group' parameter.

@end deffn
@end deffn

@node StackSummary Objects,FrameSummary Objects,TracebackException Objects,traceback — Imprime ou recupera um traceback da pilha
@anchor{library/traceback stacksummary-objects}@anchor{4694}
@subsubsection @code{StackSummary} Objects



Adicionado na versão 3.5.


@code{StackSummary} objects represent a call stack ready for formatting.

@geindex StackSummary (classe em traceback)
@anchor{library/traceback traceback StackSummary}@anchor{eb2}
@deffn {Classe} traceback.StackSummary

@geindex extract() (método de classe traceback.StackSummary)
@anchor{library/traceback traceback StackSummary extract}@anchor{4683}
@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{eb0,,walk_stack()} or
@ref{eb1,,walk_tb()}).

If `limit' is supplied, only this many frames are taken from `frame_gen'.
If `lookup_lines' is @code{False}, the returned @ref{eb3,,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.


Alterado na versão 3.12: Exceptions raised from @ref{800,,repr()} on a local variable (when
`capture_locals' is @code{True}) are no longer propagated to the caller.

@end deffn

@geindex from_list() (método de classe traceback.StackSummary)
@anchor{library/traceback traceback StackSummary from_list}@anchor{4695}
@deffn {Método} classmethod from_list (a_list)

Construct a @code{StackSummary} object from a supplied list of
@ref{eb3,,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 traceback.StackSummary)
@anchor{library/traceback traceback StackSummary format}@anchor{4696}
@deffn {Método} format ()

Returns a list of strings ready for printing.  Each string in the
resulting list corresponds to a single @ref{6e0,,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.

For long sequences of the same frame and line, the first few
repetitions are shown, followed by a summary line stating the exact
number of further repetitions.


Alterado na versão 3.6: Long sequences of repeated frames are now abbreviated.

@end deffn

@geindex format_frame_summary() (método traceback.StackSummary)
@anchor{library/traceback traceback StackSummary format_frame_summary}@anchor{6a3}
@deffn {Método} format_frame_summary (frame_summary)

Returns a string for printing one of the @ref{6e0,,frames}
involved in the stack.
This method is called for each @ref{eb3,,FrameSummary} object to be
printed by @ref{4696,,StackSummary.format()}. If it returns @code{None}, the
frame is omitted from the output.


Adicionado na versão 3.11.

@end deffn
@end deffn

@node FrameSummary Objects,Examples of Using the Module-Level Functions,StackSummary Objects,traceback — Imprime ou recupera um traceback da pilha
@anchor{library/traceback framesummary-objects}@anchor{4697}
@subsubsection @code{FrameSummary} Objects



Adicionado na versão 3.5.


A @code{FrameSummary} object represents a single @ref{6e0,,frame}
in a @ref{b07,,traceback}.

@geindex FrameSummary (classe em traceback)
@anchor{library/traceback traceback FrameSummary}@anchor{eb3}
@deffn {Classe} traceback.FrameSummary (filename, lineno, name, *, lookup_line=True, locals=None, line=None, end_lineno=None, colno=None, end_colno=None)

Represents a single @ref{6e0,,frame} in the
@ref{b07,,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{467d,,line}
attribute accessed (which also happens when casting it to a @ref{370,,tuple}).
@ref{467d,,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 traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary filename}@anchor{467a}
@deffn {Atributo} filename

The filename of the source code for this frame. Equivalent to accessing
@ref{13b4,,f.f_code.co_filename} on a
@ref{6e0,,frame object} `f'.
@end deffn

@geindex lineno (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary lineno}@anchor{467b}
@deffn {Atributo} lineno

The line number of the source code for this frame.
@end deffn

@geindex name (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary name}@anchor{467c}
@deffn {Atributo} name

Equivalent to accessing @ref{20c8,,f.f_code.co_name} on
a @ref{6e0,,frame object} `f'.
@end deffn

@geindex line (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary line}@anchor{467d}
@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

@geindex end_lineno (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary end_lineno}@anchor{4698}
@deffn {Atributo} end_lineno

The last line number of the source code for this frame.
By default, it is set to @code{lineno} and indexation starts from 1.


Alterado na versão 3.13: The default value changed from @code{None} to @code{lineno}.

@end deffn

@geindex colno (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary colno}@anchor{4699}
@deffn {Atributo} colno

The column number of the source code for this frame.
By default, it is @code{None} and indexation starts from 0.
@end deffn

@geindex end_colno (atributo traceback.FrameSummary)
@anchor{library/traceback traceback FrameSummary end_colno}@anchor{469a}
@deffn {Atributo} end_colno

The last column number of the source code for this frame.
By default, it is @code{None} and indexation starts from 0.
@end deffn
@end deffn

@node Examples of Using the Module-Level Functions,Examples of Using TracebackException,FrameSummary Objects,traceback — Imprime ou recupera um traceback da pilha
@anchor{library/traceback examples-of-using-the-module-level-functions}@anchor{469b}@anchor{library/traceback traceback-example}@anchor{469c}
@subsubsection Examples of Using the Module-Level Functions


This simple example implements a basic read-eval-print loop, similar to (but
less useful than) the standard Python interactive interpreter loop.  For a more
complete implementation of the interpreter loop, refer to the @ref{1a,,code}
module.

@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

The following example demonstrates the different ways to print and format the
exception and traceback:

@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

The output for the example would look similar to this:

@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

The following example shows the different ways to print and format the stack:

@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

This last example demonstrates the final few formatting functions:

@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 — Imprime ou recupera um traceback da pilha
@anchor{library/traceback examples-of-using-tracebackexception}@anchor{469d}
@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__ — Definições de instruções future,gc — Interface para o coletor de lixo,traceback — Imprime ou recupera um traceback da pilha,Serviços de Tempo de Execução Python
@anchor{library/__future__ doc}@anchor{469e}@anchor{library/__future__ future-future-statement-definitions}@anchor{469f}@anchor{library/__future__ module-__future__}@anchor{0}@anchor{library/__future__ translation-repo}@anchor{46a0}
@subsection @code{__future__} — Definições de instruções future


@geindex module; __future__

`Código-fonte:' Lib/__future__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/__future__.py}


__________________________________________________________________


Instruções do tipo @code{from __future__ import feature} são chamadas de @ref{189,,instruções future}. Esses são casos especiais do compilador do Python para permitir o uso de novos recursos do Python em módulos que contêm a instrução future antes da versão em que o recurso se torna padrão.

Embora o compilador Python dê um significado especial adicional a essas instruções future, elas ainda são executadas como qualquer outra instrução de importação. O módulo @ref{0,,__future__} existe e é tratado pelo sistema de importação da mesma forma que qualquer outro módulo Python. Isso serve a três propósitos:


@itemize *

@item 
Para evitar confundir as ferramentas existentes que analisam as instruções de importação e esperam encontrar os módulos  sendo importados.

@item 
Para documentar quando as mudanças incompatíveis foram introduzidas e quando elas serão — ou foram — obrigatórias. Esta é uma forma de documentação executável e pode ser inspecionada programaticamente por meio da importação @ref{0,,__future__} e da análise de seus conteúdos.

@item 
Para garantir que @ref{189,,instruções future} sejam executadas em versões anteriores a Python 2.1, pelo menos, processe exceções de tempo de execução (a importação de @ref{0,,__future__} falhará, porque não havia nenhum módulo com esse nome antes de 2.1).
@end itemize

@menu
* Conteúdo do módulo: Conteúdo do módulo<9>. 

@end menu

@node Conteúdo do módulo<9>,,,__future__ — Definições de instruções future
@anchor{library/__future__ module-contents}@anchor{46a1}
@subsubsection Conteúdo do módulo


Nenhuma descrição de característica será excluída de @ref{0,,__future__}. Desde a sua introdução no Python 2.1, os seguintes recursos encontraram o caminho para o idioma usando esse mecanismo:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

característica

@tab

opcional em

@tab

obrigatório em

@tab

efeito

@item

@geindex nested_scopes (no módulo __future__)
@anchor{library/__future__ future__ nested_scopes}@anchor{46a2}
@deffn {Dado} __future__.nested_scopes
@end deffn

@tab

2.1.0b1

@tab

2.2

@tab

@geindex Propostas de Melhorias do Python; PEP 227
PEP 227@footnote{https://peps.python.org/pep-0227/}: `Statically Nested Scopes'

@item

@geindex generators (no módulo __future__)
@anchor{library/__future__ future__ generators}@anchor{46a3}
@deffn {Dado} __future__.generators
@end deffn

@tab

2.2.0a1

@tab

2.3

@tab

@geindex Propostas de Melhorias do Python; PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/}: `Simple Generators'

@item

@geindex division (no módulo __future__)
@anchor{library/__future__ future__ division}@anchor{46a4}
@deffn {Dado} __future__.division
@end deffn

@tab

2.2.0a2

@tab

3.0

@tab

@geindex Propostas de Melhorias do Python; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: `Changing the Division Operator'

@item

@geindex absolute_import (no módulo __future__)
@anchor{library/__future__ future__ absolute_import}@anchor{46a5}
@deffn {Dado} __future__.absolute_import
@end deffn

@tab

2.5.0a1

@tab

3.0

@tab

@geindex Propostas de Melhorias do Python; PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/}: `Imports: Multi-Line and Absolute/Relative'

@item

@geindex with_statement (no módulo __future__)
@anchor{library/__future__ future__ with_statement}@anchor{46a6}
@deffn {Dado} __future__.with_statement
@end deffn

@tab

2.5.0a1

@tab

2.6

@tab

@geindex Propostas de Melhorias do Python; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}: `The “with” Statement'

@item

@geindex print_function (no módulo __future__)
@anchor{library/__future__ future__ print_function}@anchor{46a7}
@deffn {Dado} __future__.print_function
@end deffn

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Propostas de Melhorias do Python; PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}: `Make print a function'

@item

@geindex unicode_literals (no módulo __future__)
@anchor{library/__future__ future__ unicode_literals}@anchor{46a8}
@deffn {Dado} __future__.unicode_literals
@end deffn

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Propostas de Melhorias do Python; PEP 3112
PEP 3112@footnote{https://peps.python.org/pep-3112/}: `Bytes literals in Python 3000'

@item

@geindex generator_stop (no módulo __future__)
@anchor{library/__future__ future__ generator_stop}@anchor{46a9}
@deffn {Dado} __future__.generator_stop
@end deffn

@tab

3.5.0b1

@tab

3.7

@tab

@geindex Propostas de Melhorias do Python; PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}: `StopIteration handling inside generators'

@item

@geindex annotations (no módulo __future__)
@anchor{library/__future__ future__ annotations}@anchor{46aa}
@deffn {Dado} __future__.annotations
@end deffn

@tab

3.7.0b1

@tab

Nunca @footnote{
@code{from __future__ import annotations} foi programado anteriormente para se tornar obrigatório no Python 3.10, mas o Python Steering Council decidiu duas vezes adiar a mudança (@uref{https://mail.python.org/archives/list/python-dev@@python.org/message/CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ/,anúncio para o Python 3.10}; @uref{https://mail.python.org/archives/list/python-dev@@python.org/message/VIZEBX5EYMSYIJNDBF6DMUMZOCWHARSO/,anúncio para o Python 3.11}). Nenhuma decisão final foi tomada ainda. Veja também 
@geindex Propostas de Melhorias do Python; PEP 563
@uref{https://peps.python.org/pep-0563/,PEP 563} e 
@geindex Propostas de Melhorias do Python; PEP 649
@uref{https://peps.python.org/pep-0649/,PEP 649}.
}

@tab

@geindex Propostas de Melhorias do Python; PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}: `Postponed evaluation of annotations'

@end multitable


@c XXX Adding a new entry?  Remember to update simple_stmts.rst, too.

@geindex _Feature (classe em __future__)
@anchor{library/__future__ future-classes}@anchor{46ab}@anchor{library/__future__ future__ _Feature}@anchor{22fd}
@deffn {Classe} __future__._Feature

Cada instrução em @code{__future__.py} é da forma:

@example
FeatureName = _Feature(OptionalRelease, MandatoryRelease,
                       CompilerFlag)
@end example

Onde, normalmente, `OptionalRelease' é inferior a `MandatoryRelease', e ambos são tuplas de 5 entradas da mesma forma que @ref{6a0,,sys.version_info}:

@example
(PY_MAJOR_VERSION, # o 2 em 2.1.0a3; um int
 PY_MINOR_VERSION, # o 1; um int
 PY_MICRO_VERSION, # o 0; um int
 PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" ou "final"; uma string
 PY_RELEASE_SERIAL # o 3; um int
)
@end example
@end deffn

@geindex getOptionalRelease() (método __future__._Feature)
@anchor{library/__future__ future__ _Feature getOptionalRelease}@anchor{46ac}
@deffn {Método} _Feature.getOptionalRelease ()

`OptionalRelease' registra o primeiro lançamento no qual o recurso foi aceito.
@end deffn

@geindex getMandatoryRelease() (método __future__._Feature)
@anchor{library/__future__ future__ _Feature getMandatoryRelease}@anchor{46ad}
@deffn {Método} _Feature.getMandatoryRelease ()

No caso de um `MandatoryRelease' que ainda não ocorreu, `MandatoryRelease' prevê o lançamento em que o recurso se tornará parte da linguagem.

Senão `MandatoryRelease' registra quando o recurso se tornou parte do idioma; Em versões em ou depois disso, os módulos não precisam mais de uma instrução future para usar o recurso em questão, mas podem continuar a usar essas importações.

`MandatoryRelease' também pode ser @code{None}, o que significa que uma característica planejada foi descartada ou que isso ainda não está decidido.
@end deffn

@geindex compiler_flag (atributo __future__._Feature)
@anchor{library/__future__ future__ _Feature compiler_flag}@anchor{20d8}
@deffn {Atributo} _Feature.compiler_flag

`CompilerFlag' é o sinalizador (bitfield) que deve ser passado no quarto argumento para a função embutida @ref{192,,compile()} para habilitar o recurso no código compilado dinamicamente. Este sinalizador é armazenado no atributo @ref{20d8,,_Feature.compiler_flag} em instâncias de @ref{22fd,,_Feature}.
@end deffn


@subsubheading Ver também



@table @asis

@item @ref{189,,Instruções future}

Como o compilador trata as importações de future.

@geindex Propostas de Melhorias do Python; PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - De volta ao __future__

A proposta original para o mecanismo do __future__.
@end table


@node gc — Interface para o coletor de lixo,inspect — Inspecione objetos vivos,__future__ — Definições de instruções future,Serviços de Tempo de Execução Python
@anchor{library/gc doc}@anchor{46ae}@anchor{library/gc gc-garbage-collector-interface}@anchor{46af}@anchor{library/gc module-gc}@anchor{60}@anchor{library/gc translation-repo}@anchor{46b0}
@subsection @code{gc} — Interface para o coletor de lixo


@geindex module; gc


__________________________________________________________________


Este módulo fornece uma interface para o coletor de lixo opcional. Ele permite desabilitar o coletor, ajustar a frequência de coleta e configurar as opções de depuração. Ele também fornece acesso a objetos inacessíveis que o coletor encontra, mas não pode “limpar”. Como o coletor complementa a contagem de referência já usada em Python, você pode desabilitá-lo se tem certeza de que seu programa não cria ciclos de referência. A coleta automática pode ser desativada pela chamada @code{gc.disable()}. Para depurar um programa vazando, chame @code{gc.set_debug(gc.DEBUG_LEAK)}. Perceba que isto inclui @code{gc.DEBUG_SAVEALL}, fazendo com que os objetos coletados pelo coletor de lixo sejam salvos para inspeção em gc.garbage.

O módulo @ref{60,,gc} fornece as seguintes funções:

@geindex enable() (no módulo gc)
@anchor{library/gc gc enable}@anchor{46b1}
@deffn {Função} gc.enable ()

Habilita a coleta de lixo automática.
@end deffn

@geindex disable() (no módulo gc)
@anchor{library/gc gc disable}@anchor{46b2}
@deffn {Função} gc.disable ()

Desabilita a coleta de lixo automática.
@end deffn

@geindex isenabled() (no módulo gc)
@anchor{library/gc gc isenabled}@anchor{46b3}
@deffn {Função} gc.isenabled ()

Retorna @code{True} se a coleta automática estiver habilitada.
@end deffn

@geindex collect() (no módulo gc)
@anchor{library/gc gc collect}@anchor{a43}
@deffn {Função} gc.collect (generation=2)

Sem argumentos, execute uma coleta completa. O argumento opcional `generation' pode ser um inteiro especificando qual geração coletar (de 0 a 2). Uma exceção @ref{202,,ValueError} é levantada se o número de geração for inválido. A soma dos objetos coletados e dos objetos incoletáveis é retornada.

As listas livres mantidas para vários tipos embutidos são limpas sempre que uma coleta completa ou a da geração mais alta (2) é executada. Nem todos os itens em algumas listas livres podem ser liberados devido à implementação particular, em particular @ref{2f7,,float}.

O efeito de chamar @code{gc.collect()} enquanto o interpretador já está realizando uma coleta é indefinido.
@end deffn

@geindex set_debug() (no módulo gc)
@anchor{library/gc gc set_debug}@anchor{46b4}
@deffn {Função} gc.set_debug (flags)

Define os sinalizadores de depuração da coleta de lixo. As informações de depuração serão gravadas em @code{sys.stderr}. Veja abaixo uma lista de sinalizadores de depuração que podem ser combinados usando operações de bit para controlar a depuração.
@end deffn

@geindex get_debug() (no módulo gc)
@anchor{library/gc gc get_debug}@anchor{46b5}
@deffn {Função} gc.get_debug ()

Retorna os sinalizadores de depuração atualmente definidos.
@end deffn

@geindex get_objects() (no módulo gc)
@anchor{library/gc gc get_objects}@anchor{806}
@deffn {Função} gc.get_objects (generation=None)

Retorna uma lista de todos os objetos rastreados pelo coletor, excluindo a lista retornada. Se `generation' não for @code{None}, retorna apenas os objetos rastreados pelo coletor que estão nessa geração.


Alterado na versão 3.8: Novo parâmetro `generation'.


Levanta um @ref{19fa,,evento de auditoria} @code{gc.get_objects} com o argumento @code{generation}.
@end deffn

@geindex get_stats() (no módulo gc)
@anchor{library/gc gc get_stats}@anchor{f77}
@deffn {Função} gc.get_stats ()

Retorna uma lista de três dicionários por geração contendo estatísticas de coleta desde o início do interpretador. O número de chaves pode mudar no futuro, mas atualmente cada dicionário conterá os seguintes itens:


@itemize *

@item 
@code{collections} é o número de vezes que esta geração foi coletada;

@item 
@code{collected} é o número total de objetos coletados nesta geração;

@item 
@code{uncollectable} é o número total de objetos que foram considerados incobráveis (e, portanto, movidos para a lista @ref{1201,,garbage}) dentro desta geração.
@end itemize


Adicionado na versão 3.4.

@end deffn

@geindex set_threshold() (no módulo gc)
@anchor{library/gc gc set_threshold}@anchor{46b6}
@deffn {Função} gc.set_threshold (threshold0[, threshold1[, threshold2]])

Define os limites de coleta de lixo (a frequência de coleta). Definir `threshold0' como zero desativa a coleta.

O GC classifica os objetos em três gerações, dependendo de quantas varreduras de coleta eles sobreviveram. Novos objetos são colocados na geração mais nova (geração @code{0}). Se um objeto sobreviver a uma coleção, ele será movido para a próxima geração mais antiga. Como a geração @code{2} é a geração mais antiga, os objetos dessa geração permanecem lá após uma coleta. Para decidir quando executar, o coletor acompanha o número de alocações e desalocações de objetos desde a última coleta. Quando o número de alocações menos o número de desalocações exceder `threshold0', a coleta será iniciada. Inicialmente, apenas a geração @code{0} é examinada. Se a geração @code{0} foi examinada mais de `threshold1' vezes desde que a geração @code{1} foi examinada, então a geração @code{1} também é examinada. Com a terceira geração, as coisas são um pouco mais complicadas, veja Coletando a geração mais antiga@footnote{https://github.com/python/cpython/blob/ff0ef0a54bef26fc507fbf9b7a6009eb7d3f17f5/InternalDocs/garbage_collector.md#collecting-the-oldest-generation} para mais informações.
@end deffn

@geindex get_count() (no módulo gc)
@anchor{library/gc gc get_count}@anchor{46b7}
@deffn {Função} gc.get_count ()

Retorna as contagens da coleta atual como uma tupla de @code{(count0, count1, count2)}.
@end deffn

@geindex get_threshold() (no módulo gc)
@anchor{library/gc gc get_threshold}@anchor{46b8}
@deffn {Função} gc.get_threshold ()

Retorna os limites da coleta atual como uma tupla de @code{(threshold0, threshold1, threshold2)}.
@end deffn

@geindex get_referrers() (no módulo gc)
@anchor{library/gc gc get_referrers}@anchor{807}
@deffn {Função} gc.get_referrers (*objs)

Retorna a lista de objetos que se referem diretamente a qualquer um dos objs. Esta função localizará apenas os contêineres que suportam coleta de lixo; tipos de extensão que se referem a outros objetos, mas não suportam coleta de lixo, não serão encontrados.

Observe que os objetos que já foram desreferenciados, mas que vivem em ciclos e ainda não foram coletados pelo coletor de lixo podem ser listados entre os referenciadores resultantes. Para obter apenas os objetos atualmente ativos, chame @ref{a43,,collect()} antes de chamar @ref{807,,get_referrers()}.

@cartouche
@quotation Aviso 
Deve-se tomar cuidado ao usar objetos retornados por @ref{807,,get_referrers()} porque alguns deles ainda podem estar em construção e, portanto, em um estado temporariamente inválido. Evite usar @ref{807,,get_referrers()} para qualquer finalidade que não seja depuração.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{gc.get_referrers} com o argumento @code{objs}.
@end deffn

@geindex get_referents() (no módulo gc)
@anchor{library/gc gc get_referents}@anchor{808}
@deffn {Função} gc.get_referents (*objs)

Retorna uma lista de objetos diretamente referenciados por qualquer um dos argumentos. Os referentes retornados são aqueles objetos visitados pelos métodos a nível do C @ref{77e,,tp_traverse} dos argumentos (se houver), e podem não ser todos os objetos diretamente alcançáveis. Os métodos @ref{77e,,tp_traverse} são suportados apenas por objetos que suportam coleta de lixo e são necessários apenas para visitar objetos que possam estar envolvidos em um ciclo. Assim, por exemplo, se um número inteiro pode ser acessado diretamente de um argumento, esse objeto inteiro pode ou não aparecer na lista de resultados.

Levanta um @ref{19fa,,evento de auditoria} @code{gc.get_referents} com o argumento @code{objs}.
@end deffn

@geindex is_tracked() (no módulo gc)
@anchor{library/gc gc is_tracked}@anchor{1352}
@deffn {Função} gc.is_tracked (obj)

Retorna @code{True} se o objeto está atualmente rastreado pelo coletor de lixo, @code{False} caso contrário. Como regra geral, as instâncias de tipos atômicos não são rastreadas e as instâncias de tipos não atômicos (contêineres, objetos definidos pelo usuário…) são. No entanto, algumas otimizações específicas do tipo podem estar presentes para suprimir a pegada do coletor de lixo de instâncias simples (por exemplo, dicts contendo apenas chaves e 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


Adicionado na versão 3.1.

@end deffn

@geindex is_finalized() (no módulo gc)
@anchor{library/gc gc is_finalized}@anchor{903}
@deffn {Função} gc.is_finalized (obj)

Retorna @code{True} se o objeto fornecido foi finalizado pelo coletor de lixo, @code{False} caso contrário.

@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


Adicionado na versão 3.9.

@end deffn

@geindex freeze() (no módulo gc)
@anchor{library/gc gc freeze}@anchor{b4c}
@deffn {Função} gc.freeze ()

Congela todos os objetos rastreados pelo coletor de lixo; move-os para uma geração permanente e ignora-os em todas as coleções futuras.

Se um processo for @code{fork()} sem @code{exec()}, evitar cópia em gravação (copy-on-write) desnecessário em processos filho maximizará o compartilhamento de memória e reduzirá o uso geral de memória. Isso requer evitar a criação de “buracos” liberados nas páginas de memória no processo pai e garantir que as coleções GC nos processos filho não toquem no contador @code{gc_refs} de objetos de vida longa originados no processo pai. Para realizar ambos, chame @code{gc.disable()} no início do processo pai, @code{gc.freeze()} logo antes de @code{fork()} e @code{gc.enable()} no início em processos filhos.


Adicionado na versão 3.7.

@end deffn

@geindex unfreeze() (no módulo gc)
@anchor{library/gc gc unfreeze}@anchor{b4d}
@deffn {Função} gc.unfreeze ()

Descongela os objetos na geração permanente, coloca-os de volta na geração mais antiga.


Adicionado na versão 3.7.

@end deffn

@geindex get_freeze_count() (no módulo gc)
@anchor{library/gc gc get_freeze_count}@anchor{b4e}
@deffn {Função} gc.get_freeze_count ()

Retorna o número de objetos na geração permanente.


Adicionado na versão 3.7.

@end deffn

As seguintes variáveis são fornecidas para acesso somente leitura (você pode alterar os valores, mas não deve revinculá-los):

@geindex garbage (no módulo gc)
@anchor{library/gc gc garbage}@anchor{1201}
@deffn {Dado} gc.garbage

Uma lista de objetos que o coletor considerou inacessíveis, mas não puderam ser liberados (objetos não coletáveis). A partir do Python 3.4, esta lista deve estar vazia na maioria das vezes, exceto ao usar instâncias de tipos de extensão C com um slot @code{tp_del} não-@code{NULL}.

Se @ref{46b9,,DEBUG_SAVEALL} for definido, todos os objetos inacessíveis serão adicionados a esta lista ao invés de liberados.


Alterado na versão 3.2: Se esta lista não estiver vazia no @ref{14e,,desligamento do interpretador}, um @ref{244,,ResourceWarning} é emitido, que é silencioso por padrão. Se @ref{1202,,DEBUG_UNCOLLECTABLE} for definido, além disso, todos os objetos não coletáveis serão impressos.



Alterado na versão 3.4: Seguindo a 
@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}, objetos com um método @ref{1033,,__del__()} não vão mais para @ref{1201,,gc.garbage}.

@end deffn

@geindex callbacks (no módulo gc)
@anchor{library/gc gc callbacks}@anchor{1106}
@deffn {Dado} gc.callbacks

Uma lista de retornos de chamada que serão invocados pelo coletor de lixo antes e depois da coleta. As funções de retorno serão chamadas com dois argumentos, `phase' e `info'.

`phase' pode ser um dos dois valores:

@quotation

“start”: A coleta de lixo está prestes a começar.

“stop”: A coleta de lixo terminou.
@end quotation

`info' é um ditado que fornece mais informações para a função de retorno. As seguintes chaves estão atualmente definidas:

@quotation

“generation”: A geração mais antiga sendo coletada.

“collected”: Quando `phase' é “stop”, o número de objetos coletados com sucesso.

“uncollectable”: Quando `phase' é “stop”, o número de objetos que não puderam ser coletados e foram colocados em @ref{1201,,garbage}.
@end quotation

As aplicações podem adicionar suas próprias funções de retorno a essa lista. Os principais casos de uso são:

@quotation

Reunir estatísticas sobre coleta de lixo, como com que frequência várias gerações são coletadas e quanto tempo leva a coleta.

Permitindo que os aplicativos identifiquem e limpem seus próprios tipos não colecionáveis quando eles aparecem em @ref{1201,,garbage}.
@end quotation


Adicionado na versão 3.3.

@end deffn

As seguintes constantes são fornecidas para uso com @ref{46b4,,set_debug()}:

@geindex DEBUG_STATS (no módulo gc)
@anchor{library/gc gc DEBUG_STATS}@anchor{46ba}
@deffn {Dado} gc.DEBUG_STATS

Imprimir estatísticas durante a coleta. Esta informação pode ser útil ao sintonizar a frequência de coleta.
@end deffn

@geindex DEBUG_COLLECTABLE (no módulo gc)
@anchor{library/gc gc DEBUG_COLLECTABLE}@anchor{46bb}
@deffn {Dado} gc.DEBUG_COLLECTABLE

Imprimir informações sobre objetos colecionáveis encontrados.
@end deffn

@geindex DEBUG_UNCOLLECTABLE (no módulo gc)
@anchor{library/gc gc DEBUG_UNCOLLECTABLE}@anchor{1202}
@deffn {Dado} gc.DEBUG_UNCOLLECTABLE

Imprime informações de objetos não colecionáveis encontrados (objetos que não são alcançáveis, mas não podem ser liberados pelo coletor). Esses objetos serão adicionados à lista @code{garbage}.


Alterado na versão 3.2: Imprime também o conteúdo da lista @ref{1201,,garbage} em @ref{14e,,desligamento do interpretador}, se não estiver vazia.

@end deffn

@geindex DEBUG_SAVEALL (no módulo gc)
@anchor{library/gc gc DEBUG_SAVEALL}@anchor{46b9}
@deffn {Dado} gc.DEBUG_SAVEALL

Quando definido, todos os objetos inacessíveis encontrados serão anexados ao `lixo' em vez de serem liberados. Isso pode ser útil para depurar um programa com vazamento.
@end deffn

@geindex DEBUG_LEAK (no módulo gc)
@anchor{library/gc gc DEBUG_LEAK}@anchor{46bc}
@deffn {Dado} gc.DEBUG_LEAK

Os sinalizadores de depuração necessários para o coletor imprimir informações sobre um programa com vazamento (igual a @code{DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL}).
@end deffn

@node inspect — Inspecione objetos vivos,site — Gancho de configuração específico do site,gc — Interface para o coletor de lixo,Serviços de Tempo de Execução Python
@anchor{library/inspect doc}@anchor{46bd}@anchor{library/inspect inspect-inspect-live-objects}@anchor{46be}@anchor{library/inspect translation-repo}@anchor{46bf}
@subsection @code{inspect} — Inspecione objetos vivos


@c import inspect
@c from inspect import *

@geindex module; inspect
@anchor{library/inspect module-inspect}@anchor{7e}
`Código-fonte:' Lib/inspect.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/inspect.py}


__________________________________________________________________


O módulo @ref{7e,,inspect} fornece diversas funções úteis para ajudar a obter informações sobre objetos ativos, como módulos, classes, métodos, funções, tracebacks, objetos quadro e objetos código. Por exemplo, ele pode ajudar você a examinar o conteúdo de uma classe, recuperar o código-fonte de um método, extrair e formatar a lista de argumentos de uma função ou obter todas as informações necessárias para exibir um traceback detalhado.

Há quatro tipos principais de serviços fornecidos por este módulo: verificação de tipos, obtenção de código-fonte, inspeção de classes e funções e exame da pilha do interpretador.

@menu
* Tipos e membros:: 
* Retrieving source code:: 
* Introspecting callables with the Signature object:: 
* Classes e funções: Classes e funções<2>. 
* A pilha to interpretador:: 
* Fetching attributes statically:: 
* Current State of Generators@comma{} Coroutines@comma{} and Asynchronous Generators: Current State of Generators Coroutines and Asynchronous Generators. 
* Code Objects Bit Flags:: 
* Buffer flags:: 
* Interface de linha de comando: Interface de linha de comando<13>. 

@end menu

@node Tipos e membros,Retrieving source code,,inspect — Inspecione objetos vivos
@anchor{library/inspect inspect-types}@anchor{1b21}@anchor{library/inspect types-and-members}@anchor{46c0}
@subsubsection Tipos e membros


A função @ref{197a,,getmembers()} recupera os membros de um objeto, como uma classe ou módulo. As funções cujos nomes começam com “is” são fornecidas principalmente como opções convenientes para o segundo argumento de @ref{197a,,getmembers()}. Elas também ajudam a determinar quando você pode esperar encontrar os seguintes atributos especiais (consulte @ref{20a4,,Atributos relacionados à importação em objetos de módulo} para atributos de módulo):

@c this function name is too big to fit in the ascii-art table below


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo

@tab

Atributo

@tab

Descrição

@item

classe

@tab

__doc__

@tab

string de documentação

@item

@tab

__name__

@tab

nome com o qual esta classe foi definida

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

__module__

@tab

nome do módulo no qual esta classe foi definida

@item

@tab

__type_params__

@tab

Uma tupla contendo os @ref{2b3,,parâmetros de tipo} de uma classe genérica

@item

método

@tab

__doc__

@tab

string de documentação

@item

@tab

__name__

@tab

nome com o qual este método foi definido

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

__func__

@tab

objeto função contendo implementação de método

@item

@tab

__self__

@tab

instância para o qual este método está vinculado, ou @code{None}.

@item

@tab

__module__

@tab

nome do módulo no qual este método foi definido

@item

função

@tab

__doc__

@tab

string de documentação

@item

@tab

__name__

@tab

nome com o qual esta função foi definida

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

__code__

@tab

objeto código contendo @ref{187,,bytecode} da função compilada

@item

@tab

__defaults__

@tab

tupla de quaisquer valores padrão para parâmetros posicionais ou de parâmetros nomeados

@item

@tab

__kwdefaults__

@tab

mapeamento de quaisquer valores padrão para parâmetros somente-nomeados

@item

@tab

__globals__

@tab

espaço de nomes global no qual esta função foi definida

@item

@tab

__builtins__

@tab

espaço de nomes de métodos e funções embutidas

@item

@tab

__annotations__

@tab

mapeamento de nomes de parâmetros para anotações; a chave @code{"return"} é reservada para anotações de retorno.

@item

@tab

__type_params__

@tab

Uma tupla contendo os @ref{2b3,,parâmetros de tipo} de uma função genérica

@item

@tab

__module__

@tab

nome do módulo no qual esta função foi definida

@item

traceback

@tab

tb_frame

@tab

objeto quadro neste nível

@item

@tab

tb_lasti

@tab

índice da última instrução tentada no bytecode

@item

@tab

tb_lineno

@tab

número da linha atual no código-fonte do Python

@item

@tab

tb_next

@tab

próximo objeto de traceback interno (chamado por este nível)

@item

quadro

@tab

f_back

@tab

próximo objeto de quadro externo (chamador deste quadro)

@item

@tab

f_builtins

@tab

espaço de nomes de métodos e funçõess embutidas visto por este quadro

@item

@tab

f_code

@tab

objeto código sendo executado neste quadro

@item

@tab

f_globals

@tab

espaço de nomes global visto por este quadro

@item

@tab

f_lasti

@tab

índice da última instrução tentada no bytecode

@item

@tab

f_lineno

@tab

número da linha atual no código-fonte do Python

@item

@tab

f_locals

@tab

espaço de nomes local visto por este quadro

@item

@tab

f_trace

@tab

função de rastreamento para este quadro, ou @code{None}

@item

código

@tab

co_argcount

@tab

número de argumentos (não incluindo argumentos somente-nomeados, args * ou **)

@item

@tab

co_code

@tab

string de bytecode compilado bruto

@item

@tab

co_cellvars

@tab

tuple of names of cell
variables (referenced by
containing scopes)

@item

@tab

co_consts

@tab

tuple of constants used
in the bytecode

@item

@tab

co_filename

@tab

name of file in which
this code object was
created

@item

@tab

co_firstlineno

@tab

number of first line in
Python source code

@item

@tab

co_flags

@tab

bitmap of @code{CO_*} flags,
read more @ref{20d7,,here}

@item

@tab

co_lnotab

@tab

encoded mapping of line
numbers to bytecode
indices

@item

@tab

co_freevars

@tab

tuple of names of free
variables (referenced via
a function’s closure)

@item

@tab

co_posonlyargcount

@tab

number of positional only
arguments

@item

@tab

co_kwonlyargcount

@tab

number of keyword only
arguments (not including
** arg)

@item

@tab

co_name

@tab

name with which this code
object was defined

@item

@tab

co_qualname

@tab

fully qualified name with
which this code object
was defined

@item

@tab

co_names

@tab

tuple of names other
than arguments and
function locals

@item

@tab

co_nlocals

@tab

number of local variables

@item

@tab

co_stacksize

@tab

virtual machine stack
space required

@item

@tab

co_varnames

@tab

tuple of names of
arguments and local
variables

@item

gerador

@tab

__name__

@tab

nome

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

gi_frame

@tab

quadro

@item

@tab

gi_running

@tab

is the generator running?

@item

@tab

gi_suspended

@tab

is the generator
suspended?

@item

@tab

gi_code

@tab

código

@item

@tab

gi_yieldfrom

@tab

object being iterated by
@code{yield from}, or
@code{None}

@item

async generator

@tab

__name__

@tab

nome

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

ag_await

@tab

object being awaited on,
or @code{None}

@item

@tab

ag_frame

@tab

quadro

@item

@tab

ag_running

@tab

is the generator running?

@item

@tab

ag_suspended

@tab

is the generator
suspended?

@item

@tab

ag_code

@tab

código

@item

corrotina

@tab

__name__

@tab

nome

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

cr_await

@tab

object being awaited on,
or @code{None}

@item

@tab

cr_frame

@tab

quadro

@item

@tab

cr_running

@tab

is the coroutine running?

@item

@tab

cr_suspended

@tab

is the coroutine
suspended?

@item

@tab

cr_code

@tab

código

@item

@tab

cr_origin

@tab

where coroutine was
created, or @code{None}. See
@ref{ba4,,sys.set_coroutine_origin_tracking_depth()}

@item

builtin

@tab

__doc__

@tab

string de documentação

@item

@tab

__name__

@tab

original name of this
function or method

@item

@tab

__qualname__

@tab

nome qualificado

@item

@tab

__self__

@tab

instance to which a
method is bound, or
@code{None}

@end multitable



Alterado na versão 3.5: Add @code{__qualname__} and @code{gi_yieldfrom} attributes to generators.

The @code{__name__} attribute of generators is now set from the function
name, instead of the code name, and it can now be modified.



Alterado na versão 3.7: Add @code{cr_origin} attribute to coroutines.



Alterado na versão 3.10: Add @code{__builtins__} attribute to functions.



Alterado na versão 3.11: Add @code{gi_suspended} attribute to generators.



Alterado na versão 3.11: Add @code{cr_suspended} attribute to coroutines.



Alterado na versão 3.12: Add @code{ag_suspended} attribute to async generators.


@geindex getmembers() (no módulo inspect)
@anchor{library/inspect inspect getmembers}@anchor{197a}
@deffn {Função} inspect.getmembers (object[, predicate])

Return all the members of an object in a list of @code{(name, value)}
pairs sorted by name. If the optional `predicate' argument—which will be
called with the @code{value} object of each member—is supplied, only members
for which the predicate returns a true value are included.

@cartouche
@quotation Nota 
@ref{197a,,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{15fe,,__dir__()}.
@end quotation
@end cartouche
@end deffn

@geindex getmembers_static() (no módulo inspect)
@anchor{library/inspect inspect getmembers_static}@anchor{649}
@deffn {Função} inspect.getmembers_static (object[, predicate])

Return all the members of an object in a list of @code{(name, value)}
pairs sorted by name without triggering dynamic lookup via the descriptor
protocol, __getattr__ or __getattribute__. Optionally, only return members
that satisfy a given predicate.

@cartouche
@quotation Nota 
@ref{649,,getmembers_static()} may not be able to retrieve all members
that getmembers can fetch (like dynamically created attributes)
and may find members that getmembers can’t (like descriptors
that raise AttributeError). It can also return descriptor objects
instead of instance members in some cases.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex getmodulename() (no módulo inspect)
@anchor{library/inspect inspect getmodulename}@anchor{d5b}
@deffn {Função} inspect.getmodulename (path)

Return the name of the module named by the file `path', without including the
names of enclosing packages. The file extension is checked against all of
the entries in @ref{46c1,,importlib.machinery.all_suffixes()}. If it matches,
the final path component is returned with the extension removed.
Otherwise, @code{None} is returned.

Note that this function `only' returns a meaningful name for actual
Python modules - paths that potentially refer to Python packages will
still return @code{None}.


Alterado na versão 3.3: The function is based directly on @ref{77,,importlib}.

@end deffn

@geindex ismodule() (no módulo inspect)
@anchor{library/inspect inspect ismodule}@anchor{46c2}
@deffn {Função} inspect.ismodule (object)

Return @code{True} if the object is a module.
@end deffn

@geindex isclass() (no módulo inspect)
@anchor{library/inspect inspect isclass}@anchor{46c3}
@deffn {Função} inspect.isclass (object)

Return @code{True} if the object is a class, whether built-in or created in Python
code.
@end deffn

@geindex ismethod() (no módulo inspect)
@anchor{library/inspect inspect ismethod}@anchor{46c4}
@deffn {Função} inspect.ismethod (object)

Return @code{True} if the object is a bound method written in Python.
@end deffn

@geindex isfunction() (no módulo inspect)
@anchor{library/inspect inspect isfunction}@anchor{46c5}
@deffn {Função} inspect.isfunction (object)

Return @code{True} if the object is a Python function, which includes functions
created by a @ref{28ec,,lambda} expression.
@end deffn

@geindex isgeneratorfunction() (no módulo inspect)
@anchor{library/inspect inspect isgeneratorfunction}@anchor{18e6}
@deffn {Função} inspect.isgeneratorfunction (object)

Return @code{True} if the object is a Python generator function.


Alterado na versão 3.8: Functions wrapped in @ref{414,,functools.partial()} now return @code{True} if the
wrapped function is a Python generator function.



Alterado na versão 3.13: Functions wrapped in @ref{a85,,functools.partialmethod()} now return @code{True}
if the wrapped function is a Python generator function.

@end deffn

@geindex isgenerator() (no módulo inspect)
@anchor{library/inspect inspect isgenerator}@anchor{46c6}
@deffn {Função} inspect.isgenerator (object)

Return @code{True} if the object is a generator.
@end deffn

@geindex iscoroutinefunction() (no módulo inspect)
@anchor{library/inspect inspect iscoroutinefunction}@anchor{2e4}
@deffn {Função} inspect.iscoroutinefunction (object)

Return @code{True} if the object is a @ref{d9b,,coroutine function} (a function
defined with an @ref{5d1,,async def} syntax), a @ref{414,,functools.partial()}
wrapping a @ref{d9b,,coroutine function}, or a sync function marked with
@ref{490,,markcoroutinefunction()}.


Adicionado na versão 3.5.



Alterado na versão 3.8: Functions wrapped in @ref{414,,functools.partial()} now return @code{True} if the
wrapped function is a @ref{d9b,,coroutine function}.



Alterado na versão 3.12: Sync functions marked with @ref{490,,markcoroutinefunction()} now return
@code{True}.



Alterado na versão 3.13: Functions wrapped in @ref{a85,,functools.partialmethod()} now return @code{True}
if the wrapped function is a @ref{d9b,,coroutine function}.

@end deffn

@geindex markcoroutinefunction() (no módulo inspect)
@anchor{library/inspect inspect markcoroutinefunction}@anchor{490}
@deffn {Função} inspect.markcoroutinefunction (func)

Decorator to mark a callable as a @ref{d9b,,coroutine function} if it would not
otherwise be detected by @ref{2e4,,iscoroutinefunction()}.

This may be of use for sync functions that return a @ref{491,,coroutine}, if
the function is passed to an API that requires @ref{2e4,,iscoroutinefunction()}.

When possible, using an @ref{5d1,,async def} function is preferred. Also
acceptable is calling the function and testing the return with
@ref{e42,,iscoroutine()}.


Adicionado na versão 3.12.

@end deffn

@geindex iscoroutine() (no módulo inspect)
@anchor{library/inspect inspect iscoroutine}@anchor{e42}
@deffn {Função} inspect.iscoroutine (object)

Return @code{True} if the object is a @ref{491,,coroutine} created by an
@ref{5d1,,async def} function.


Adicionado na versão 3.5.

@end deffn

@geindex isawaitable() (no módulo inspect)
@anchor{library/inspect inspect isawaitable}@anchor{e43}
@deffn {Função} inspect.isawaitable (object)

Return @code{True} if the object can be used in @ref{1b9,,await} expression.

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


Adicionado na versão 3.5.

@end deffn

@geindex isasyncgenfunction() (no módulo inspect)
@anchor{library/inspect inspect isasyncgenfunction}@anchor{18e7}
@deffn {Função} inspect.isasyncgenfunction (object)

Return @code{True} if the object is an @ref{21cf,,asynchronous generator} function,
for example:

@example
>>> async def agen():
...     yield 1
...
>>> inspect.isasyncgenfunction(agen)
True
@end example


Adicionado na versão 3.6.



Alterado na versão 3.8: Functions wrapped in @ref{414,,functools.partial()} now return @code{True} if the
wrapped function is an @ref{21cf,,asynchronous generator} function.



Alterado na versão 3.13: Functions wrapped in @ref{a85,,functools.partialmethod()} now return @code{True}
if the wrapped function is a @ref{21cf,,asynchronous generator} function.

@end deffn

@geindex isasyncgen() (no módulo inspect)
@anchor{library/inspect inspect isasyncgen}@anchor{46c7}
@deffn {Função} inspect.isasyncgen (object)

Return @code{True} if the object is an @ref{45bd,,asynchronous generator iterator}
created by an @ref{21cf,,asynchronous generator} function.


Adicionado na versão 3.6.

@end deffn

@geindex istraceback() (no módulo inspect)
@anchor{library/inspect inspect istraceback}@anchor{46c8}
@deffn {Função} inspect.istraceback (object)

Return @code{True} if the object is a traceback.
@end deffn

@geindex isframe() (no módulo inspect)
@anchor{library/inspect inspect isframe}@anchor{46c9}
@deffn {Função} inspect.isframe (object)

Return @code{True} if the object is a frame.
@end deffn

@geindex iscode() (no módulo inspect)
@anchor{library/inspect inspect iscode}@anchor{46ca}
@deffn {Função} inspect.iscode (object)

Return @code{True} if the object is a code.
@end deffn

@geindex isbuiltin() (no módulo inspect)
@anchor{library/inspect inspect isbuiltin}@anchor{46cb}
@deffn {Função} inspect.isbuiltin (object)

Return @code{True} if the object is a built-in function or a bound built-in method.
@end deffn

@geindex ismethodwrapper() (no módulo inspect)
@anchor{library/inspect inspect ismethodwrapper}@anchor{64a}
@deffn {Função} inspect.ismethodwrapper (object)

Return @code{True} if the type of object is a @ref{64b,,MethodWrapperType}.

These are instances of @ref{64b,,MethodWrapperType}, such as @ref{61d,,__str__()},
@ref{b0d,,__eq__()} and @ref{61c,,__repr__()}.


Adicionado na versão 3.11.

@end deffn

@geindex isroutine() (no módulo inspect)
@anchor{library/inspect inspect isroutine}@anchor{16d6}
@deffn {Função} inspect.isroutine (object)

Return @code{True} if the object is a user-defined or built-in function or method.
@end deffn

@geindex isabstract() (no módulo inspect)
@anchor{library/inspect inspect isabstract}@anchor{46cc}
@deffn {Função} inspect.isabstract (object)

Return @code{True} if the object is an abstract base class.
@end deffn

@geindex ismethoddescriptor() (no módulo inspect)
@anchor{library/inspect inspect ismethoddescriptor}@anchor{16d5}
@deffn {Função} inspect.ismethoddescriptor (object)

Return @code{True} if the object is a method descriptor, but not if
@ref{46c4,,ismethod()}, @ref{46c3,,isclass()}, @ref{46c5,,isfunction()} or @ref{46cb,,isbuiltin()}
are true.

This, for example, is true of @code{int.__add__}.  An object passing this test
has a @ref{1530,,__get__()} method, but not a @ref{20f7,,__set__()}
method or a @ref{16f5,,__delete__()} method.  Beyond that, the set of
attributes varies.  A @ref{109f,,__name__} attribute is usually
sensible, and @ref{92e,,__doc__} often is.

Methods implemented via descriptors that also pass one of the other tests
return @code{False} from the @ref{16d5,,ismethoddescriptor()} test, simply because the
other tests promise more – you can, e.g., count on having the
@ref{1340,,__func__} attribute (etc) when an object passes
@ref{46c4,,ismethod()}.


Alterado na versão 3.13: This function no longer incorrectly reports objects with @ref{1530,,__get__()}
and @ref{16f5,,__delete__()}, but not @ref{20f7,,__set__()}, as being method
descriptors (such objects are data descriptors, not method descriptors).

@end deffn

@geindex isdatadescriptor() (no módulo inspect)
@anchor{library/inspect inspect isdatadescriptor}@anchor{46cd}
@deffn {Função} inspect.isdatadescriptor (object)

Return @code{True} if the object is a data descriptor.

Data descriptors have a @ref{20f7,,__set__} or a @ref{16f5,,__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{109f,,__name__} and @code{__doc__} attributes
(properties, getsets, and members have both of these attributes), but this is
not guaranteed.
@end deffn

@geindex isgetsetdescriptor() (no módulo inspect)
@anchor{library/inspect inspect isgetsetdescriptor}@anchor{46ce}
@deffn {Função} inspect.isgetsetdescriptor (object)

Return @code{True} if the object is a getset descriptor.

`Detalhes da implementação do CPython:' getsets are attributes defined in extension modules via
@ref{bd1,,PyGetSetDef} structures.  For Python implementations without such
types, this method will always return @code{False}.
@end deffn

@geindex ismemberdescriptor() (no módulo inspect)
@anchor{library/inspect inspect ismemberdescriptor}@anchor{46cf}
@deffn {Função} inspect.ismemberdescriptor (object)

Return @code{True} if the object is a member descriptor.

`Detalhes da implementação do CPython:' Member descriptors are attributes defined in extension modules via
@ref{54f,,PyMemberDef} structures.  For Python implementations without such
types, this method will always return @code{False}.
@end deffn

@node Retrieving source code,Introspecting callables with the Signature object,Tipos e membros,inspect — Inspecione objetos vivos
@anchor{library/inspect inspect-source}@anchor{46d0}@anchor{library/inspect retrieving-source-code}@anchor{46d1}
@subsubsection Retrieving source code


@geindex getdoc() (no módulo inspect)
@anchor{library/inspect inspect getdoc}@anchor{a02}
@deffn {Função} inspect.getdoc (object)

Get the documentation string for an object, cleaned up with @ref{17a8,,cleandoc()}.
If the documentation string for an object is not provided and the object is
a class, a method, a property or a descriptor, retrieve the documentation
string from the inheritance hierarchy.
Return @code{None} if the documentation string is invalid or missing.


Alterado na versão 3.5: Strings de documentação agora são herdadas, se não forem sobrescritas.

@end deffn

@geindex getcomments() (no módulo inspect)
@anchor{library/inspect inspect getcomments}@anchor{16b0}
@deffn {Função} inspect.getcomments (object)

Return in a single string any lines of comments immediately preceding the
object’s source code (for a class, function, or method), or at the top of the
Python source file (if the object is a module).  If the object’s source code
is unavailable, return @code{None}.  This could happen if the object has been
defined in C or the interactive shell.
@end deffn

@geindex getfile() (no módulo inspect)
@anchor{library/inspect inspect getfile}@anchor{1c1e}
@deffn {Função} inspect.getfile (object)

Retorna o nome do arquivo (texto ou binário) no qual um objeto foi definido. Isso falhará com um @ref{2c3,,TypeError} se o objeto for um módulo, classe ou função embutidos.
@end deffn

@geindex getmodule() (no módulo inspect)
@anchor{library/inspect inspect getmodule}@anchor{18f8}
@deffn {Função} inspect.getmodule (object)

Try to guess which module an object was defined in. Return @code{None}
if the module cannot be determined.
@end deffn

@geindex getsourcefile() (no módulo inspect)
@anchor{library/inspect inspect getsourcefile}@anchor{18f9}
@deffn {Função} inspect.getsourcefile (object)

Return the name of the Python source file in which an object was defined
or @code{None} if no way can be identified to get the source.  This
will fail with a @ref{2c3,,TypeError} if the object is a built-in module, class, or
function.
@end deffn

@geindex getsourcelines() (no módulo inspect)
@anchor{library/inspect inspect getsourcelines}@anchor{15d8}
@deffn {Função} 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{417,,OSError} is raised if the source code cannot
be retrieved.
A @ref{2c3,,TypeError} is raised if the object is a built-in module, class, or
function.


Alterado na versão 3.3: @ref{417,,OSError} is raised instead of @ref{108b,,IOError}, now an alias of the
former.

@end deffn

@geindex getsource() (no módulo inspect)
@anchor{library/inspect inspect getsource}@anchor{15f8}
@deffn {Função} 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{417,,OSError} is raised if the source code
cannot be retrieved.
A @ref{2c3,,TypeError} is raised if the object is a built-in module, class, or
function.


Alterado na versão 3.3: @ref{417,,OSError} is raised instead of @ref{108b,,IOError}, now an alias of the
former.

@end deffn

@geindex cleandoc() (no módulo inspect)
@anchor{library/inspect inspect cleandoc}@anchor{17a8}
@deffn {Função} inspect.cleandoc (doc)

Clean up indentation from docstrings that are indented to line up with blocks
of code.

All leading whitespace is removed from the first line.  Any leading whitespace
that can be uniformly removed from the second line onwards is removed.  Empty
lines at the beginning and end are subsequently removed.  Also, all tabs are
expanded to spaces.
@end deffn

@node Introspecting callables with the Signature object,Classes e funções<2>,Retrieving source code,inspect — Inspecione objetos vivos
@anchor{library/inspect inspect-signature-object}@anchor{46d2}@anchor{library/inspect introspecting-callables-with-the-signature-object}@anchor{46d3}
@subsubsection Introspecting callables with the Signature object



Adicionado na versão 3.3.


The @ref{1cf,,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() (no módulo inspect)
@anchor{library/inspect inspect signature}@anchor{738}
@deffn {Função} inspect.signature (callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)

Return a @ref{1cf,,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

Accepts a wide range of Python callables, from plain functions and classes to
@ref{414,,functools.partial()} objects.

For objects defined in modules using stringized annotations
(@code{from __future__ import annotations}), @ref{738,,signature()} will
attempt to automatically un-stringize the annotations using
@ref{816,,get_annotations()}.  The
`globals', `locals', and `eval_str' parameters are passed
into @ref{816,,get_annotations()} when resolving the
annotations; see the documentation for @ref{816,,get_annotations()}
for instructions on how to use these parameters.

Raises @ref{202,,ValueError} if no signature can be provided, and
@ref{2c3,,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{816,,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{230b,,the FAQ entry on positional-only parameters}.


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



Alterado na versão 3.10: The `globals', `locals', and `eval_str' parameters were added.


@cartouche
@quotation Nota 
Some callables may not be introspectable in certain implementations of
Python.  For example, in CPython, some built-in functions defined in
C provide no metadata about their arguments.
@end quotation
@end cartouche

`Detalhes da implementação do 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 (classe em inspect)
@anchor{library/inspect inspect Signature}@anchor{1cf}
@deffn {Classe} 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{1d0,,Parameter} object in its @ref{46d4,,parameters} collection.

The optional `parameters' argument is a sequence of @ref{1d0,,Parameter}
objects, which is validated to check that there are no parameters with
duplicate names, and that the parameters are in the right order, i.e.
positional-only first, then positional-or-keyword, and that parameters with
defaults follow parameters without defaults.

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{46d5,,Signature.replace()} or
@ref{151,,copy.replace()} to make a modified copy.


Alterado na versão 3.5: @code{Signature} objects are now picklable and @ref{610,,hashable}.


@geindex empty (atributo inspect.Signature)
@anchor{library/inspect inspect Signature empty}@anchor{46d6}
@deffn {Atributo} empty

A special class-level marker to specify absence of a return annotation.
@end deffn

@geindex parameters (atributo inspect.Signature)
@anchor{library/inspect inspect Signature parameters}@anchor{46d4}
@deffn {Atributo} parameters

An ordered mapping of parameters’ names to the corresponding
@ref{1d0,,Parameter} objects.  Parameters appear in strict definition
order, including keyword-only parameters.


Alterado na versão 3.7: Python only explicitly guaranteed that it preserved the declaration
order of keyword-only parameters as of version 3.7, although in practice
this order had always been preserved in Python 3.

@end deffn

@geindex return_annotation (atributo inspect.Signature)
@anchor{library/inspect inspect Signature return_annotation}@anchor{46d7}
@deffn {Atributo} return_annotation

The “return” annotation for the callable.  If the callable has no “return”
annotation, this attribute is set to @ref{46d6,,Signature.empty}.
@end deffn

@geindex bind() (método inspect.Signature)
@anchor{library/inspect inspect Signature bind}@anchor{1648}
@deffn {Método} bind (*args, **kwargs)

Create a mapping from positional and keyword arguments to parameters.
Returns @ref{10a2,,BoundArguments} if @code{*args} and @code{**kwargs} match the
signature, or raises a @ref{2c3,,TypeError}.
@end deffn

@geindex bind_partial() (método inspect.Signature)
@anchor{library/inspect inspect Signature bind_partial}@anchor{46d8}
@deffn {Método} bind_partial (*args, **kwargs)

Works the same way as @ref{1648,,Signature.bind()}, but allows the omission of
some required arguments (mimics @ref{414,,functools.partial()} behavior.)
Returns @ref{10a2,,BoundArguments}, or raises a @ref{2c3,,TypeError} if the
passed arguments do not match the signature.
@end deffn

@geindex replace() (método inspect.Signature)
@anchor{library/inspect inspect Signature replace}@anchor{46d5}
@deffn {Método} replace (*[, parameters][, return_annotation])

Create a new @ref{1cf,,Signature} instance based on the instance
@ref{46d5,,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{46d6,,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{1cf,,Signature} objects are also supported by the generic function
@ref{151,,copy.replace()}.
@end deffn

@geindex format() (método inspect.Signature)
@anchor{library/inspect inspect Signature format}@anchor{46d9}
@deffn {Método} format (*, max_width=None)

Create a string representation of the @ref{1cf,,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.


Adicionado na versão 3.13.

@end deffn

@geindex from_callable() (método de classe inspect.Signature)
@anchor{library/inspect inspect Signature from_callable}@anchor{73a}
@deffn {Método} classmethod from_callable (obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)

Return a @ref{1cf,,Signature} (or its subclass) object for a given callable
`obj'.

This method simplifies subclassing of @ref{1cf,,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{738,,signature()}.


Adicionado na versão 3.5.



Alterado na versão 3.10: The `globals', `locals', and `eval_str' parameters were added.

@end deffn
@end deffn

@geindex Parameter (classe em inspect)
@anchor{library/inspect inspect Parameter}@anchor{1d0}
@deffn {Classe} inspect.Parameter (name, kind, *, default=Parameter.empty, annotation=Parameter.empty)

Objetos @code{Parameter} são `imutáveis'. Em vez de modificar um objeto @code{Parameter}, você pode usar @ref{46da,,Parameter.replace()} ou @ref{151,,copy.replace()} para criar uma cópia modificada.


Alterado na versão 3.5: Objetos Parameter agora são compatíveis com pickle e @ref{610,,hasheável}.


@geindex empty (atributo inspect.Parameter)
@anchor{library/inspect inspect Parameter empty}@anchor{46db}
@deffn {Atributo} empty

Um marcador de nível de classe especial para especificar a ausência de valor padrão e anotação.
@end deffn

@geindex name (atributo inspect.Parameter)
@anchor{library/inspect inspect Parameter name}@anchor{46dc}
@deffn {Atributo} name

O nome do parâmetro como uma string. O nome deve ser um identificador Python válido.

CPython gera nomes de parâmetro implícito na forma @code{.0} no código objeto usado para implementar compreensão e expressão geradora.


Alterado na versão 3.6: Esses nomes de parâmetro agora são expostos por este módulo como nomes como @code{implicit0}.

@end deffn

@geindex default (atributo inspect.Parameter)
@anchor{library/inspect inspect Parameter default}@anchor{46dd}
@deffn {Atributo} default

O padrão valor para o parâmetro. Se o parâmetro não tiver padrão valor, esse atributo será definido como @ref{46db,,Parameter.empty}.
@end deffn

@geindex annotation (atributo inspect.Parameter)
@anchor{library/inspect inspect Parameter annotation}@anchor{46de}
@deffn {Atributo} annotation

A anotação para o parâmetro. Se o parâmetro não tiver anotação, esse atributo será definido como @ref{46db,,Parameter.empty}.
@end deffn

@geindex kind (atributo inspect.Parameter)
@anchor{library/inspect inspect Parameter kind}@anchor{46df}
@deffn {Atributo} kind

Descreve como valores de argumento são vinculados ao parâmetro. Os possíveis valores são acessíveis via @ref{1d0,,Parameter} (como @code{Parameter.KEYWORD_ONLY}) e tem suporte para comparação e ordenação, na seguinte ordem:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome

@tab

Significado

@item

`POSITIONAL_ONLY'

@tab

Valor deve ser fornecido como argumento posicional. Parâmetros somente-posicionais são aqueles que aparecem antes de uma entrada @code{/} (se presente) em uma definição de função Python.

@item

`POSITIONAL_OR_KEYWORD'

@tab

Valor pode ser fornecido como argumento posicional ou nomeado (esse é o comportamento de ligação padrão para funções implementadas em Python).

@item

@code{`*VAR_POSITIONAL*`}

@tab

Uma tupla de argumentos posicionais que não estão vinculados a nenhum outro parâmetro. Isso corresponde a um parâmetro @code{*args} em uma definição de função Python.

@item

`KEYWORD_ONLY'

@tab

Valor deve ser fornecido como argumento nomeado. Parâmetros somente-nomeados são aqueles que aparecem após uma entrada @code{*} ou @code{*args} em uma definição de função Python.

@item

`VAR_KEYWORD'

@tab

Um dicionário de argumentos nomeados que não estão vinculados a nenhum outro parâmetro. Isso corresponde a um parâmetro @code{**kwargs} em uma definição de função Python.

@end multitable


Exemplo: exibir todos argumentos somente-nomeados sem padrão valor:

@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 inspect.Parameter.kind)
@anchor{library/inspect inspect Parameter kind description}@anchor{46e0}
@deffn {Atributo} kind.description

Descreve um valor enumerado de @ref{46df,,Parameter.kind}.


Adicionado na versão 3.8.


Exemplo: exibir as descrições de todos os argumento:

@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 inspect.Parameter)
@anchor{library/inspect inspect Parameter replace}@anchor{46da}
@deffn {Método} replace (*[, name][, kind][, default][, annotation])

Cria uma nova instância de @ref{1d0,,Parameter} com base na instância em que o método foi chamado. Para substituir um atributo de @code{Parameter}, passe o argumento correspondente.  Para remover um valor padrão ou/e uma anotação de um @code{Parameter}, passe @ref{46db,,Parameter.empty}.

@example
>>> from inspect import Parameter
>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
>>> str(param)
'foo=42'

>>> str(param.replace()) # Criará uma cópia rasa de 'param'
'foo=42'

>>> str(param.replace(default=Parameter.empty, annotation='spam'))
"foo: 'spam'"
@end example

Objetos @ref{1d0,,Parameter} também são suportados pela função genérica @ref{151,,copy.replace()}.
@end deffn


Alterado na versão 3.4: Em Python 3.3, era permitido objetos @ref{1d0,,Parameter} terem @code{name} definido como @code{None} se @code{kind} estivesse definido como @code{POSITIONAL_ONLY}. Isso não é mais permitido.

@end deffn

@geindex BoundArguments (classe em inspect)
@anchor{library/inspect inspect BoundArguments}@anchor{10a2}
@deffn {Classe} inspect.BoundArguments

Result of a @ref{1648,,Signature.bind()} or @ref{46d8,,Signature.bind_partial()} call.
Holds the mapping of arguments to the function’s parameters.

@geindex arguments (atributo inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments arguments}@anchor{912}
@deffn {Atributo} arguments

A mutable mapping of parameters’ names to arguments’ values.
Contains only explicitly bound arguments.  Changes in @ref{912,,arguments}
will reflect in @ref{46e1,,args} and @ref{46e2,,kwargs}.

Should be used in conjunction with @ref{46d4,,Signature.parameters} for any
argument processing purposes.

@cartouche
@quotation Nota 
Arguments for which @ref{1648,,Signature.bind()} or
@ref{46d8,,Signature.bind_partial()} relied on a default value are skipped.
However, if needed, use @ref{e41,,BoundArguments.apply_defaults()} to add
them.
@end quotation
@end cartouche


Alterado na versão 3.9: @ref{912,,arguments} is now of type @ref{256,,dict}. Formerly, it was of
type @ref{5db,,collections.OrderedDict}.

@end deffn

@geindex args (atributo inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments args}@anchor{46e1}
@deffn {Atributo} args

A tuple of positional arguments values.  Dynamically computed from the
@ref{912,,arguments} attribute.
@end deffn

@geindex kwargs (atributo inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments kwargs}@anchor{46e2}
@deffn {Atributo} kwargs

A dict of keyword arguments values.  Dynamically computed from the
@ref{912,,arguments} attribute.  Arguments that can be passed positionally
are included in @ref{46e1,,args} instead.
@end deffn

@geindex signature (atributo inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments signature}@anchor{46e3}
@deffn {Atributo} signature

A reference to the parent @ref{1cf,,Signature} object.
@end deffn

@geindex apply_defaults() (método inspect.BoundArguments)
@anchor{library/inspect inspect BoundArguments apply_defaults}@anchor{e41}
@deffn {Método} apply_defaults ()

Set default values for missing arguments.

For variable-positional arguments (@code{*args}) the default is an
empty tuple.

For variable-keyword arguments (@code{**kwargs}) the default is an
empty dict.

@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


Adicionado na versão 3.5.

@end deffn

The @ref{46e1,,args} and @ref{46e2,,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 também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/} - Function Signature Object.

The detailed specification, implementation details and examples.
@end table


@node Classes e funções<2>,A pilha to interpretador,Introspecting callables with the Signature object,inspect — Inspecione objetos vivos
@anchor{library/inspect classes-and-functions}@anchor{46e4}@anchor{library/inspect inspect-classes-functions}@anchor{46e5}
@subsubsection Classes e funções


@geindex getclasstree() (no módulo inspect)
@anchor{library/inspect inspect getclasstree}@anchor{46e6}
@deffn {Função} inspect.getclasstree (classes, unique=False)

Arrange the given list of classes into a hierarchy of nested lists. Where a
nested list appears, it contains classes derived from the class whose entry
immediately precedes the list.  Each entry is a 2-tuple containing a class and a
tuple of its base classes.  If the `unique' argument is true, exactly one entry
appears in the returned structure for each class in the given list.  Otherwise,
classes using multiple inheritance and their descendants will appear multiple
times.
@end deffn

@geindex getfullargspec() (no módulo inspect)
@anchor{library/inspect inspect getfullargspec}@anchor{739}
@deffn {Função} inspect.getfullargspec (func)

Get the names and default values of a Python function’s parameters.  A
@ref{64e,,named tuple} is returned:

@code{FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults,
annotations)}

`args' is a list of the positional parameter names.
`varargs' is the name of the @code{*} parameter or @code{None} if arbitrary
positional arguments are not accepted.
`varkw' is the name of the @code{**} parameter or @code{None} if arbitrary
keyword arguments are not accepted.
`defaults' is an `n'-tuple of default argument values corresponding to the
last `n' positional parameters, or @code{None} if there are no such defaults
defined.
`kwonlyargs' is a list of keyword-only parameter names in declaration order.
`kwonlydefaults' is a dictionary mapping parameter names from `kwonlyargs'
to the default values used if no argument is supplied.
`annotations' is a dictionary mapping parameter names to annotations.
The special key @code{"return"} is used to report the function return value
annotation (if any).

Note that @ref{738,,signature()} and
@ref{46d2,,Signature Object} provide the recommended
API for callable introspection, and support additional behaviours (like
positional-only arguments) that are sometimes encountered in extension module
APIs. This function is retained primarily for use in code that needs to
maintain compatibility with the Python 2 @code{inspect} module API.


Alterado na versão 3.4: This function is now based on @ref{738,,signature()}, but still ignores
@code{__wrapped__} attributes and includes the already bound first
parameter in the signature output for bound methods.



Alterado na versão 3.6: This method was previously documented as deprecated in favour of
@ref{738,,signature()} in Python 3.5, but that decision has been reversed
in order to restore a clearly supported standard interface for
single-source Python 2/3 code migrating away from the legacy
@code{getargspec()} API.



Alterado na versão 3.7: Python only explicitly guaranteed that it preserved the declaration
order of keyword-only parameters as of version 3.7, although in practice
this order had always been preserved in Python 3.

@end deffn

@geindex getargvalues() (no módulo inspect)
@anchor{library/inspect inspect getargvalues}@anchor{eee}
@deffn {Função} inspect.getargvalues (frame)

Get information about arguments passed into a particular frame.  A
@ref{64e,,named tuple} @code{ArgInfo(args, varargs, keywords, locals)} is
returned. `args' is a list of the argument names.  `varargs' and `keywords'
are the names of the @code{*} and @code{**} arguments or @code{None}.  `locals' is the
locals dictionary of the given frame.

@cartouche
@quotation Nota 
This function was inadvertently marked as deprecated in Python 3.5.
@end quotation
@end cartouche
@end deffn

@geindex formatargvalues() (no módulo inspect)
@anchor{library/inspect inspect formatargvalues}@anchor{eef}
@deffn {Função} inspect.formatargvalues (args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])

Format a pretty argument spec from the four values returned by
@ref{eee,,getargvalues()}.  The format* arguments are the corresponding optional
formatting functions that are called to turn names and values into strings.

@cartouche
@quotation Nota 
This function was inadvertently marked as deprecated in Python 3.5.
@end quotation
@end cartouche
@end deffn

@geindex getmro() (no módulo inspect)
@anchor{library/inspect inspect getmro}@anchor{46e7}
@deffn {Função} inspect.getmro (cls)

Return a tuple of class cls’s base classes, including cls, in method resolution
order.  No class appears more than once in this tuple. Note that the method
resolution order depends on cls’s type.  Unless a very peculiar user-defined
metatype is in use, cls will be the first element of the tuple.
@end deffn

@geindex getcallargs() (no módulo inspect)
@anchor{library/inspect inspect getcallargs}@anchor{eed}
@deffn {Função} 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


Adicionado na versão 3.2.



Descontinuado desde a versão 3.5: Use @ref{1648,,Signature.bind()} and @ref{46d8,,Signature.bind_partial()} instead.

@end deffn

@geindex getclosurevars() (no módulo inspect)
@anchor{library/inspect inspect getclosurevars}@anchor{1114}
@deffn {Função} inspect.getclosurevars (func)

Get the mapping of external name references in a Python function or
method `func' to their current values. A
@ref{64e,,named tuple} @code{ClosureVars(nonlocals, globals, builtins, unbound)}
is returned. `nonlocals' maps referenced names to lexical closure
variables, `globals' to the function’s module globals and `builtins' to
the builtins visible from the function body. `unbound' is the set of names
referenced in the function that could not be resolved at all given the
current module globals and builtins.

@ref{2c3,,TypeError} is raised if `func' is not a Python function or method.


Adicionado na versão 3.3.

@end deffn

@geindex unwrap() (no módulo inspect)
@anchor{library/inspect inspect unwrap}@anchor{f90}
@deffn {Função} inspect.unwrap (func, *, stop=None)

Get the object wrapped by `func'. It follows the chain of @code{__wrapped__}
attributes returning the last object in the chain.

`stop' is an optional callback accepting an object in the wrapper chain
as its sole argument that allows the unwrapping to be terminated early if
the callback returns a true value. If the callback never returns a true
value, the last object in the chain is returned as usual. For example,
@ref{738,,signature()} uses this to stop unwrapping if any object in the
chain has a @code{__signature__} attribute defined.

@ref{202,,ValueError} is raised if a cycle is encountered.


Adicionado na versão 3.4.

@end deffn

@geindex get_annotations() (no módulo inspect)
@anchor{library/inspect inspect get_annotations}@anchor{816}
@deffn {Função} inspect.get_annotations (obj, *, globals=None, locals=None, eval_str=False)

Calcula o dicionário de anotações para um objeto.

@code{obj} may be a callable, class, or module.
Passing in an object of any other type raises @ref{2c3,,TypeError}.

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.

Esta função cuida de vários detalhes para você:


@itemize *

@item 
If @code{eval_str} is true, values of type @code{str} will
be un-stringized using @ref{180,,eval()}.  This is intended
for use with stringized annotations
(@code{from __future__ import annotations}).

@item 
If @code{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.  If a class
doesn’t have its own annotations dict, returns an empty dict.

@item 
Todos os acessos aos membros do objeto e valores do dicionário são feitos usando @code{getattr()} e @code{dict.get()} por segurança.

@item 
Always, always, always returns a freshly created dict.
@end itemize

@code{eval_str} controls whether or not values of type @code{str} are replaced
with the result of calling @ref{180,,eval()} on those values:


@itemize *

@item 
If eval_str is true, @ref{180,,eval()} is called on values of type @code{str}.
(Note that @code{get_annotations} doesn’t catch exceptions; if @ref{180,,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

@code{globals} and @code{locals} are passed in to @ref{180,,eval()}; see the documentation
for @ref{180,,eval()} for more information.  If @code{globals} or @code{locals}
is @code{None}, this function may replace that value with a context-specific
default, contingent on @code{type(obj)}:


@itemize *

@item 
If @code{obj} is a module, @code{globals} defaults to @code{obj.__dict__}.

@item 
If @code{obj} is a class, @code{globals} defaults to
@code{sys.modules[obj.__module__].__dict__} and @code{locals} defaults
to the @code{obj} class namespace.

@item 
If @code{obj} is a callable, @code{globals} defaults to
@ref{1316,,obj.__globals__},
although if @code{obj} is a wrapped function (using
@ref{1058,,functools.update_wrapper()}) it is first unwrapped.
@end itemize

Calling @code{get_annotations} is best practice for accessing the
annotations dict of any object.  See @ref{7da,,Boas práticas para anotações} for
more information on annotations best practices.


Adicionado na versão 3.10.

@end deffn

@node A pilha to interpretador,Fetching attributes statically,Classes e funções<2>,inspect — Inspecione objetos vivos
@anchor{library/inspect inspect-stack}@anchor{46e8}@anchor{library/inspect the-interpreter-stack}@anchor{46e9}
@subsubsection A pilha to interpretador


Some of the following functions return
@ref{64c,,FrameInfo} objects. For backwards compatibility these objects allow
tuple-like operations on all attributes except @code{positions}. This behavior
is considered deprecated and may be removed in the future.

@geindex FrameInfo (classe em inspect)
@anchor{library/inspect inspect FrameInfo}@anchor{64c}
@deffn {Classe} inspect.FrameInfo

@geindex frame (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo frame}@anchor{46ea}
@deffn {Atributo} frame

The @ref{6e0,,frame object} that the record corresponds to.
@end deffn

@geindex filename (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo filename}@anchor{46eb}
@deffn {Atributo} filename

The file name associated with the code being executed by the frame this record
corresponds to.
@end deffn

@geindex lineno (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo lineno}@anchor{46ec}
@deffn {Atributo} lineno

The line number of the current line associated with the code being
executed by the frame this record corresponds to.
@end deffn

@geindex function (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo function}@anchor{46ed}
@deffn {Atributo} function

The function name that is being executed by the frame this record corresponds to.
@end deffn

@geindex code_context (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo code_context}@anchor{46ee}
@deffn {Atributo} code_context

A list of lines of context from the source code that’s being executed by the frame
this record corresponds to.
@end deffn

@geindex index (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo index}@anchor{46ef}
@deffn {Atributo} index

The index of the current line being executed in the @ref{46ee,,code_context} list.
@end deffn

@geindex positions (atributo inspect.FrameInfo)
@anchor{library/inspect inspect FrameInfo positions}@anchor{46f0}
@deffn {Atributo} positions

A @ref{46f1,,dis.Positions} object containing the start line number, end line
number, start column offset, and end column offset associated with the
instruction being executed by the frame this record corresponds to.
@end deffn


Alterado na versão 3.5: Return a @ref{64e,,named tuple} instead of a @ref{370,,tuple}.



Alterado na versão 3.11: @code{FrameInfo} is now a class instance
(that is backwards compatible with the previous @ref{64e,,named tuple}).

@end deffn

@geindex Traceback (classe em inspect)
@anchor{library/inspect inspect Traceback}@anchor{64d}
@deffn {Classe} inspect.Traceback

@geindex filename (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback filename}@anchor{46f2}
@deffn {Atributo} filename

The file name associated with the code being executed by the frame this traceback
corresponds to.
@end deffn

@geindex lineno (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback lineno}@anchor{46f3}
@deffn {Atributo} lineno

The line number of the current line associated with the code being
executed by the frame this traceback corresponds to.
@end deffn

@geindex function (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback function}@anchor{46f4}
@deffn {Atributo} function

The function name that is being executed by the frame this traceback corresponds to.
@end deffn

@geindex code_context (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback code_context}@anchor{46f5}
@deffn {Atributo} code_context

A list of lines of context from the source code that’s being executed by the frame
this traceback corresponds to.
@end deffn

@geindex index (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback index}@anchor{46f6}
@deffn {Atributo} index

The index of the current line being executed in the @ref{46f5,,code_context} list.
@end deffn

@geindex positions (atributo inspect.Traceback)
@anchor{library/inspect inspect Traceback positions}@anchor{46f7}
@deffn {Atributo} positions

A @ref{46f1,,dis.Positions} object containing the start line number, end
line number, start column offset, and end column offset associated with
the instruction being executed by the frame this traceback corresponds
to.
@end deffn


Alterado na versão 3.11: @code{Traceback} is now a class instance
(that is backwards compatible with the previous @ref{64e,,named tuple}).

@end deffn

@cartouche
@quotation Nota 
Keeping references to frame objects, as found in the first element of the frame
records these functions return, can cause your program to create reference
cycles.  Once a reference cycle has been created, the lifespan of all objects
which can be accessed from the objects which form the cycle can become much
longer even if Python’s optional cycle detector is enabled.  If such cycles must
be created, it is important to ensure they are explicitly broken to avoid the
delayed destruction of objects and increased memory consumption which occurs.

Though the cycle detector will catch these, destruction of the frames (and local
variables) can be made deterministic by removing the cycle in a
@ref{9d2,,finally} clause.  This is also important if the cycle detector was
disabled when Python was compiled or using @ref{46b2,,gc.disable()}.  For example:

@example
def handle_stackframe_without_leak():
    frame = inspect.currentframe()
    try:
        # do something with the frame
    finally:
        del frame
@end example

If you want to keep the frame around (for example to print a traceback
later), you can also break reference cycles by using the
@ref{280,,frame.clear()} method.
@end quotation
@end cartouche

The optional `context' argument supported by most of these functions specifies
the number of lines of context to return, which are centered around the current
line.

@geindex getframeinfo() (no módulo inspect)
@anchor{library/inspect inspect getframeinfo}@anchor{64f}
@deffn {Função} inspect.getframeinfo (frame, context=1)

Get information about a frame or traceback object.  A @ref{64d,,Traceback} object
is returned.


Alterado na versão 3.11: A @ref{64d,,Traceback} object is returned instead of a named tuple.

@end deffn

@geindex getouterframes() (no módulo inspect)
@anchor{library/inspect inspect getouterframes}@anchor{650}
@deffn {Função} inspect.getouterframes (frame, context=1)

Get a list of @ref{64c,,FrameInfo} objects for a frame and all outer frames.
These frames represent the calls that lead to the creation of `frame'. The
first entry in the returned list represents `frame'; the last entry
represents the outermost call on `frame'’s stack.


Alterado na versão 3.5: A list of @ref{64e,,named tuples}
@code{FrameInfo(frame, filename, lineno, function, code_context, index)}
is returned.



Alterado na versão 3.11: A list of @ref{64c,,FrameInfo} objects is returned.

@end deffn

@geindex getinnerframes() (no módulo inspect)
@anchor{library/inspect inspect getinnerframes}@anchor{651}
@deffn {Função} inspect.getinnerframes (traceback, context=1)

Get a list of @ref{64c,,FrameInfo} objects for a traceback’s frame and all
inner frames.  These frames represent calls made as a consequence of `frame'.
The first entry in the list represents `traceback'; the last entry represents
where the exception was raised.


Alterado na versão 3.5: A list of @ref{64e,,named tuples}
@code{FrameInfo(frame, filename, lineno, function, code_context, index)}
is returned.



Alterado na versão 3.11: A list of @ref{64c,,FrameInfo} objects is returned.

@end deffn

@geindex currentframe() (no módulo inspect)
@anchor{library/inspect inspect currentframe}@anchor{6e2}
@deffn {Função} inspect.currentframe ()

Return the frame object for the caller’s stack frame.

`Detalhes da implementação do CPython:' This function relies on Python stack frame support in the interpreter,
which isn’t guaranteed to exist in all implementations of Python.  If
running in an implementation without Python stack frame support this
function returns @code{None}.
@end deffn

@geindex stack() (no módulo inspect)
@anchor{library/inspect inspect stack}@anchor{652}
@deffn {Função} inspect.stack (context=1)

Return a list of @ref{64c,,FrameInfo} objects for the caller’s stack.  The
first entry in the returned list represents the caller; the last entry
represents the outermost call on the stack.


Alterado na versão 3.5: A list of @ref{64e,,named tuples}
@code{FrameInfo(frame, filename, lineno, function, code_context, index)}
is returned.



Alterado na versão 3.11: A list of @ref{64c,,FrameInfo} objects is returned.

@end deffn

@geindex trace() (no módulo inspect)
@anchor{library/inspect inspect trace}@anchor{653}
@deffn {Função} inspect.trace (context=1)

Return a list of @ref{64c,,FrameInfo} objects for the stack between the current
frame and the frame in which an exception currently being handled was raised
in.  The first entry in the list represents the caller; the last entry
represents where the exception was raised.


Alterado na versão 3.5: A list of @ref{64e,,named tuples}
@code{FrameInfo(frame, filename, lineno, function, code_context, index)}
is returned.



Alterado na versão 3.11: A list of @ref{64c,,FrameInfo} objects is returned.

@end deffn

@node Fetching attributes statically,Current State of Generators Coroutines and Asynchronous Generators,A pilha to interpretador,inspect — Inspecione objetos vivos
@anchor{library/inspect fetching-attributes-statically}@anchor{46f8}
@subsubsection Fetching attributes statically


Both @ref{bea,,getattr()} and @ref{4d2,,hasattr()} can trigger code execution when
fetching or checking for the existence of attributes. Descriptors, like
properties, will be invoked and @ref{4d3,,__getattr__()} and
@ref{beb,,__getattribute__()}
may be called.

For cases where you want passive introspection, like documentation tools, this
can be inconvenient. @ref{494,,getattr_static()} has the same signature as @ref{bea,,getattr()}
but avoids executing code when it fetches attributes.

@geindex getattr_static() (no módulo inspect)
@anchor{library/inspect inspect getattr_static}@anchor{494}
@deffn {Função} inspect.getattr_static (obj, attr, default=None)

Retrieve attributes without triggering dynamic lookup via the
descriptor protocol, @ref{4d3,,__getattr__()}
or @ref{beb,,__getattribute__()}.

Note: this function may not be able to retrieve all attributes
that getattr can fetch (like dynamically created attributes)
and may find attributes that getattr can’t (like descriptors
that raise AttributeError). It can also return descriptors objects
instead of instance members.

If the instance @ref{55b,,__dict__} is shadowed by another member (for
example a property) then this function will be unable to find instance
members.


Adicionado na versão 3.2.

@end deffn

@ref{494,,getattr_static()} does not resolve descriptors, for example slot descriptors or
getset descriptors on objects implemented in C. The descriptor object
is returned instead of the underlying attribute.

You can handle these with code like the following. Note that
for arbitrary getset descriptors invoking these may trigger
code execution:

@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,Code Objects Bit Flags,Fetching attributes statically,inspect — Inspecione objetos vivos
@anchor{library/inspect current-state-of-generators-coroutines-and-asynchronous-generators}@anchor{46f9}
@subsubsection Current State of Generators, Coroutines, and Asynchronous Generators


When implementing coroutine schedulers and for other advanced uses of
generators, it is useful to determine whether a generator is currently
executing, is waiting to start or resume or execution, or has already
terminated. @ref{1277,,getgeneratorstate()} allows the current state of a
generator to be determined easily.

@geindex getgeneratorstate() (no módulo inspect)
@anchor{library/inspect inspect getgeneratorstate}@anchor{1277}
@deffn {Função} inspect.getgeneratorstate (generator)

Get current state of a generator-iterator.

Possible states are:


@itemize *

@item 
GEN_CREATED: Waiting to start execution.

@item 
GEN_RUNNING: Currently being executed by the interpreter.

@item 
GEN_SUSPENDED: Currently suspended at a yield expression.

@item 
GEN_CLOSED: Execution has completed.
@end itemize


Adicionado na versão 3.2.

@end deffn

@geindex getcoroutinestate() (no módulo inspect)
@anchor{library/inspect inspect getcoroutinestate}@anchor{e45}
@deffn {Função} inspect.getcoroutinestate (coroutine)

Get current state of a coroutine object.  The function is intended to be
used with coroutine objects created by @ref{5d1,,async def} functions, but
will accept any coroutine-like object that has @code{cr_running} and
@code{cr_frame} attributes.

Possible states are:


@itemize *

@item 
CORO_CREATED: Waiting to start execution.

@item 
CORO_RUNNING: Currently being executed by the interpreter.

@item 
CORO_SUSPENDED: Currently suspended at an await expression.

@item 
CORO_CLOSED: Execution has completed.
@end itemize


Adicionado na versão 3.5.

@end deffn

@geindex getasyncgenstate() (no módulo inspect)
@anchor{library/inspect inspect getasyncgenstate}@anchor{492}
@deffn {Função} 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{5d1,,async def} functions which use the @ref{9d5,,yield} statement,
but will accept any asynchronous generator-like object that has
@code{ag_running} and @code{ag_frame} attributes.

Possible states are:


@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


Adicionado na versão 3.12.

@end deffn

The current internal state of the generator can also be queried. This is
mostly useful for testing purposes, to ensure that internal state is being
updated as expected:

@geindex getgeneratorlocals() (no módulo inspect)
@anchor{library/inspect inspect getgeneratorlocals}@anchor{1115}
@deffn {Função} inspect.getgeneratorlocals (generator)

Get the mapping of live local variables in `generator' to their current
values.  A dictionary is returned that maps from variable names to values.
This is the equivalent of calling @ref{141,,locals()} in the body of the
generator, and all the same caveats apply.

If `generator' is a @ref{109a,,generator} with no currently associated frame,
then an empty dictionary is returned.  @ref{2c3,,TypeError} is raised if
`generator' is not a Python generator object.

`Detalhes da implementação do CPython:' This function relies on the generator exposing a Python stack frame
for introspection, which isn’t guaranteed to be the case in all
implementations of Python. In such cases, this function will always
return an empty dictionary.


Adicionado na versão 3.3.

@end deffn

@geindex getcoroutinelocals() (no módulo inspect)
@anchor{library/inspect inspect getcoroutinelocals}@anchor{e44}
@deffn {Função} inspect.getcoroutinelocals (coroutine)

This function is analogous to @ref{1115,,getgeneratorlocals()}, but
works for coroutine objects created by @ref{5d1,,async def} functions.


Adicionado na versão 3.5.

@end deffn

@geindex getasyncgenlocals() (no módulo inspect)
@anchor{library/inspect inspect getasyncgenlocals}@anchor{493}
@deffn {Função} inspect.getasyncgenlocals (agen)

This function is analogous to @ref{1115,,getgeneratorlocals()}, but
works for asynchronous generator objects created by @ref{5d1,,async def}
functions which use the @ref{9d5,,yield} statement.


Adicionado na versão 3.12.

@end deffn

@node Code Objects Bit Flags,Buffer flags,Current State of Generators Coroutines and Asynchronous Generators,inspect — Inspecione objetos vivos
@anchor{library/inspect code-objects-bit-flags}@anchor{46fa}@anchor{library/inspect inspect-module-co-flags}@anchor{20d7}
@subsubsection Code Objects Bit Flags


Python code objects have a @ref{20d6,,co_flags} attribute,
which is a bitmap of the following flags:

@geindex CO_OPTIMIZED (no módulo inspect)
@anchor{library/inspect inspect CO_OPTIMIZED}@anchor{46fb}
@deffn {Dado} inspect.CO_OPTIMIZED

The code object is optimized, using fast locals.
@end deffn

@geindex CO_NEWLOCALS (no módulo inspect)
@anchor{library/inspect inspect CO_NEWLOCALS}@anchor{46fc}
@deffn {Dado} inspect.CO_NEWLOCALS

If set, a new dict will be created for the frame’s @ref{182,,f_locals}
when the code object is executed.
@end deffn

@geindex CO_VARARGS (no módulo inspect)
@anchor{library/inspect inspect CO_VARARGS}@anchor{46fd}
@deffn {Dado} inspect.CO_VARARGS

The code object has a variable positional parameter (@code{*args}-like).
@end deffn

@geindex CO_VARKEYWORDS (no módulo inspect)
@anchor{library/inspect inspect CO_VARKEYWORDS}@anchor{46fe}
@deffn {Dado} inspect.CO_VARKEYWORDS

The code object has a variable keyword parameter (@code{**kwargs}-like).
@end deffn

@geindex CO_NESTED (no módulo inspect)
@anchor{library/inspect inspect CO_NESTED}@anchor{46ff}
@deffn {Dado} inspect.CO_NESTED

The flag is set when the code object is a nested function.
@end deffn

@geindex CO_GENERATOR (no módulo inspect)
@anchor{library/inspect inspect CO_GENERATOR}@anchor{4700}
@deffn {Dado} inspect.CO_GENERATOR

The flag is set when the code object is a generator function, i.e.
a generator object is returned when the code object is executed.
@end deffn

@geindex CO_COROUTINE (no módulo inspect)
@anchor{library/inspect inspect CO_COROUTINE}@anchor{4701}
@deffn {Dado} inspect.CO_COROUTINE

The flag is set when the code object is a coroutine function.
When the code object is executed it returns a coroutine object.
See 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} for more details.


Adicionado na versão 3.5.

@end deffn

@geindex CO_ITERABLE_COROUTINE (no módulo inspect)
@anchor{library/inspect inspect CO_ITERABLE_COROUTINE}@anchor{4702}
@deffn {Dado} inspect.CO_ITERABLE_COROUTINE

The flag is used to transform generators into generator-based
coroutines.  Generator objects with this flag can be used in
@code{await} expression, and can @code{yield from} coroutine objects.
See 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} for more details.


Adicionado na versão 3.5.

@end deffn

@geindex CO_ASYNC_GENERATOR (no módulo inspect)
@anchor{library/inspect inspect CO_ASYNC_GENERATOR}@anchor{4703}
@deffn {Dado} inspect.CO_ASYNC_GENERATOR

The flag is set when the code object is an asynchronous generator
function.  When the code object is executed it returns an
asynchronous generator object.  See 
@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} for more details.


Adicionado na versão 3.6.

@end deffn

@cartouche
@quotation Nota 
The flags are specific to CPython, and may not be defined in other
Python implementations.  Furthermore, the flags are an implementation
detail, and can be removed or deprecated in future Python releases.
It’s recommended to use public APIs from the @ref{7e,,inspect} module
for any introspection needs.
@end quotation
@end cartouche

@node Buffer flags,Interface de linha de comando<13>,Code Objects Bit Flags,inspect — Inspecione objetos vivos
@anchor{library/inspect buffer-flags}@anchor{4704}
@subsubsection Buffer flags


@geindex BufferFlags (classe em inspect)
@anchor{library/inspect inspect BufferFlags}@anchor{460}
@deffn {Classe} inspect.BufferFlags

This is an @ref{cbb,,enum.IntFlag} that represents the flags that
can be passed to the @ref{45f,,__buffer__()} method of objects
implementing the @ref{2e8,,buffer protocol}.

The meaning of the flags is explained at @ref{4705,,Tipos de solicitação do buffer}.

@geindex SIMPLE (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags SIMPLE}@anchor{4706}
@deffn {Atributo} SIMPLE
@end deffn

@geindex WRITABLE (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags WRITABLE}@anchor{4707}
@deffn {Atributo} WRITABLE
@end deffn

@geindex FORMAT (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FORMAT}@anchor{4708}
@deffn {Atributo} FORMAT
@end deffn

@geindex ND (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags ND}@anchor{4709}
@deffn {Atributo} ND
@end deffn

@geindex STRIDES (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDES}@anchor{470a}
@deffn {Atributo} STRIDES
@end deffn

@geindex C_CONTIGUOUS (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags C_CONTIGUOUS}@anchor{470b}
@deffn {Atributo} C_CONTIGUOUS
@end deffn

@geindex F_CONTIGUOUS (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags F_CONTIGUOUS}@anchor{470c}
@deffn {Atributo} F_CONTIGUOUS
@end deffn

@geindex ANY_CONTIGUOUS (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags ANY_CONTIGUOUS}@anchor{470d}
@deffn {Atributo} ANY_CONTIGUOUS
@end deffn

@geindex INDIRECT (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags INDIRECT}@anchor{470e}
@deffn {Atributo} INDIRECT
@end deffn

@geindex CONTIG (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags CONTIG}@anchor{470f}
@deffn {Atributo} CONTIG
@end deffn

@geindex CONTIG_RO (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags CONTIG_RO}@anchor{4710}
@deffn {Atributo} CONTIG_RO
@end deffn

@geindex STRIDED (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDED}@anchor{4711}
@deffn {Atributo} STRIDED
@end deffn

@geindex STRIDED_RO (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags STRIDED_RO}@anchor{4712}
@deffn {Atributo} STRIDED_RO
@end deffn

@geindex RECORDS (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags RECORDS}@anchor{4713}
@deffn {Atributo} RECORDS
@end deffn

@geindex RECORDS_RO (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags RECORDS_RO}@anchor{4714}
@deffn {Atributo} RECORDS_RO
@end deffn

@geindex FULL (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FULL}@anchor{4715}
@deffn {Atributo} FULL
@end deffn

@geindex FULL_RO (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags FULL_RO}@anchor{4716}
@deffn {Atributo} FULL_RO
@end deffn

@geindex READ (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags READ}@anchor{169c}
@deffn {Atributo} READ
@end deffn

@geindex WRITE (atributo inspect.BufferFlags)
@anchor{library/inspect inspect BufferFlags WRITE}@anchor{169d}
@deffn {Atributo} WRITE
@end deffn


Adicionado na versão 3.12.

@end deffn

@node Interface de linha de comando<13>,,Buffer flags,inspect — Inspecione objetos vivos
@anchor{library/inspect command-line-interface}@anchor{4717}@anchor{library/inspect inspect-module-cli}@anchor{f8f}
@subsubsection Interface de linha de comando


The @ref{7e,,inspect} module also provides a basic introspection capability
from the command line.

By default, accepts the name of a module and prints the source of that
module. A class or function within the module can be printed instead by
appended a colon and the qualified name of the target object.

@geindex inspect opção de linha de comando; --details
@anchor{library/inspect cmdoption-inspect-details}@anchor{4718}
@deffn {Option} @w{-}@w{-}details

Print information about the specified object rather than the source code
@end deffn

@node site — Gancho de configuração específico do site,,inspect — Inspecione objetos vivos,Serviços de Tempo de Execução Python
@anchor{library/site doc}@anchor{4719}@anchor{library/site module-site}@anchor{c7}@anchor{library/site site-site-specific-configuration-hook}@anchor{471a}@anchor{library/site translation-repo}@anchor{471b}
@subsection @code{site} — Gancho de configuração específico do site


@geindex module; site

`Código-fonte:' Lib/site.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/site.py}


__________________________________________________________________


`Este módulo é importado automaticamente durante a inicialização.' A importação automática pode ser suprimida usando a opção @ref{11e7,,-S} do interpretador.

@geindex módulo;pesquisa;caminho

A importação deste módulo normalmente anexa caminhos específicos do site ao caminho de pesquisa de módulos e adiciona @ref{231e,,chamáveis}, incluindo @ref{8dd,,help()} ao espaço de nomes embutido. No entanto, a opção de inicialização do Python @ref{11e7,,-S} bloqueia isso e este módulo pode ser importado com segurança sem modificações automáticas no caminho de pesquisa de módulos ou adições aos módulos embutidos. Para acionar explicitamente as adições usuais específicas do site, chame a função @ref{1ebe,,main()}.


Alterado na versão 3.3: A importação do módulo usado para acionar a manipulação de caminhos, mesmo ao usar @ref{11e7,,-S}.


@geindex site-packages;diretório

Ele começa construindo até quatro diretórios a partir de uma parte no início e uma no final. Para a parte no início, ele usa @code{sys.prefix} e @code{sys.exec_prefix}; inícios vazios são ignorados. Para a parte no final, ele usa a string vazia e então @code{lib/site-packages} (no Windows) ou @code{lib/python`X.Y[t]'/site-packages} (no Unix e macOS). (O sufixo opcional “t” indica a construção com @ref{15e4,,threads livres} e é anexado se @code{"t"} estiver presente na constante @ref{a6d,,sys.abiflags}.) Para cada uma das combinações distintas início-fim, ele vê se se refere a um diretório existente e, se sim, adiciona-o a @code{sys.path} e também inspeciona o caminho recém-adicionado para arquivos de configuração.


Alterado na versão 3.5: Suporte para o diretório “site-python” foi removido.



Alterado na versão 3.13: No Unix, as instalações do Python @ref{15e4,,threads livres} são identificadas pelo sufixo “t” no nome do diretório específico da versão, como @code{lib/python3.13t/}.


Se um arquivo chamado “pyvenv.cfg” existir em um diretório acima, então sys.executable, sys.prefix e sys.exec_prefix serão configurados para esse diretório e também será verificado se há site-packages (sys.base_prefix e sys.base_exec_prefix será sempre os prefixos “reais” da instalação do Python). Se “pyvenv.cfg” (um arquivo de configuração de autoinicialização) contiver a chave “include-system-site-packages” configurada para algo diferente de “true” (sem distinção entre maiúsculas e minúsculas), os prefixos no nível do sistema não serão pesquisados quanto ao site-packages; caso contrário, eles irão.

@geindex # (cerquilha);comentário
@geindex instrução;import

Um arquivo de configuração de caminho é aquele cujo nome tem o formato @code{`name'.pth} e que existe em um dos quatro diretórios mencionados acima; seu conteúdo são itens adicionais (um por linha) a serem adicionados ao @code{sys.path}. Itens inexistentes nunca são adicionados ao @code{sys.path} e não é verificado se o item se refere a um diretório, e não a um arquivo. Nenhum item é adicionado ao @code{sys.path} mais de uma vez. Linhas em branco e linhas iniciadas com @code{#} são ignoradas. Linhas iniciadas com @code{import} (seguidas de espaço ou tabulação) são executadas.

@cartouche
@quotation Nota 
Uma linha executável em um arquivo @code{.pth} é executada a cada inicialização do Python, independentemente de um módulo em particular ser realmente usado. Seu impacto deve, portanto, ser reduzido ao mínimo. O objetivo principal das linhas executáveis é tornar o(s) módulo(s) correspondente(s) importável (carregar ganchos de importação de terceiros, ajustar 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} etc). Qualquer outra inicialização deve ser feita na importação real de um módulo, se e quando isso acontecer. Limitar um fragmento de código a uma única linha é uma medida deliberada para desencorajar colocar qualquer coisa mais complexa aqui.
@end quotation
@end cartouche


Alterado na versão 3.13: Os arquivos @code{.pth} agora são decodificados primeiro por UTF-8 e depois pela @ref{242,,codificação da localidade} se falhar.


@geindex pacote
@geindex caminho;configuração;arquivo

Por exemplo, suponha que @code{sys.prefix} e @code{sys.exec_prefix} sejam definidos com @code{/usr/local}. A biblioteca Python X.Y é instalado em @code{/usr/local/lib/python`X.Y'}. Suponha que isso tenha um subdiretório @code{/usr/local/lib/python`X.Y'/site-packages} com três subsubdiretórios, @code{foo}, @code{bar} e @code{spam}, e dois caminhos arquivos de configuração, @code{foo.pth} e @code{bar.pth}.  Presuma que @code{foo.pth} contém o seguinte:

@example
# configuração do pacote foo

foo
bar
bletch
@end example

e que @code{bar.pth} contém:

@example
# configuração do pacote bar

bar
@end example

Em seguida, os seguintes diretórios específicos da versão são adicionados a @code{sys.path}, nesta ordem:

@example
/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo
@end example

Observe que @code{bletch} é omitido porque não existe; o diretório @code{bar} precede o diretório @code{foo} porque @code{bar.pth} vem em ordem alfabética antes de @code{foo.pth}; e @code{spam} é omitido porque não é mencionado em nenhum dos arquivos de configuração de caminho.

@menu
* sitecustomize:: 
* usercustomize:: 
* Configuração Readline:: 
* Conteúdo do módulo: Conteúdo do módulo<10>. 
* Interface de linha de comando: Interface de linha de comando<14>. 

@end menu

@node sitecustomize,usercustomize,,site — Gancho de configuração específico do site
@anchor{library/site module-sitecustomize}@anchor{c8}@anchor{library/site sitecustomize}@anchor{471c}
@subsubsection @code{sitecustomize}


@geindex module; sitecustomize

Após essas manipulações de caminho, é feita uma tentativa de importar um módulo chamado @ref{c8,,sitecustomize}, que pode executar personalizações arbitrárias específicas do site. Ele é normalmente criado por um administrador de sistema no diretório site-packages. Se essa importação falhar com uma @ref{419,,ImportError} ou sua exceção de subclasse, e o atributo @ref{2420,,name} da exceção for igual a @code{'sitecustomize'}, ele será ignorado silenciosamente. Se o Python for iniciado sem fluxos de saída disponíveis, como com @code{pythonw.exe} no Windows (que é usado por padrão para iniciar o IDLE), a tentativa de saída de @ref{c8,,sitecustomize} será ignorada. Qualquer outra exceção causa uma falha silenciosa e talvez misteriosa do processo.

@node usercustomize,Configuração Readline,sitecustomize,site — Gancho de configuração específico do site
@anchor{library/site module-usercustomize}@anchor{10e}@anchor{library/site usercustomize}@anchor{471d}
@subsubsection @code{usercustomize}


@geindex module; usercustomize

Depois disso, é feita uma tentativa de importar um módulo chamado @ref{10e,,usercustomize}, que pode executar personalizações arbitrárias específicas do usuário, se @ref{471e,,ENABLE_USER_SITE} for true. Este arquivo deve ser criado no diretório site-packages de usuário (veja abaixo), que faz parte de @code{sys.path} a menos que seja desabilitado por @ref{13d5,,-s}. Se esta importação falhar com um @ref{419,,ImportError} ou sua exceção de subclasse, e o atributo @ref{2420,,name} da exceção for igual a @code{'usercustomize'}, ele será ignorado silenciosamente.

Observe que, para alguns sistemas não Unix, @code{sys.prefix} e @code{sys.exec_prefix} estão vazios, e as manipulações de caminho são ignoradas; no entanto, a importação de @ref{c8,,sitecustomize} e @ref{10e,,usercustomize} ainda é tentada.

@node Configuração Readline,Conteúdo do módulo<10>,usercustomize,site — Gancho de configuração específico do site
@anchor{library/site readline-configuration}@anchor{471f}@anchor{library/site rlcompleter-config}@anchor{fff}
@subsubsection Configuração Readline


Em sistemas que oferecem suporte a @ref{ba,,readline}, este módulo também importará e configurará o módulo @ref{bd,,rlcompleter}, se o Python for iniciado em @ref{ffc,,modo interativo} e sem a opção @ref{11e7,,-S}. O comportamento padrão é habilitar tab-completion e usar @code{~/.python_history} como o arquivo de salvamento do histórico. Para desabilitá-lo, exclua (ou substitua) o atributo @ref{ffd,,sys.__interactivehook__} no seu módulo @ref{c8,,sitecustomize} ou @ref{10e,,usercustomize} ou no seu arquivo 
@geindex PYTHONSTARTUP
@geindex variável de ambiente; PYTHONSTARTUP
@ref{ffe,,PYTHONSTARTUP}.


Alterado na versão 3.4: A ativação do rlcompleter e do histórico foi feita automaticamente.


@node Conteúdo do módulo<10>,Interface de linha de comando<14>,Configuração Readline,site — Gancho de configuração específico do site
@anchor{library/site module-contents}@anchor{4720}
@subsubsection Conteúdo do módulo


@geindex PREFIXES (no módulo site)
@anchor{library/site site PREFIXES}@anchor{4721}
@deffn {Dado} site.PREFIXES

Uma lista de prefixos para diretórios site-package.
@end deffn

@geindex ENABLE_USER_SITE (no módulo site)
@anchor{library/site site ENABLE_USER_SITE}@anchor{471e}
@deffn {Dado} site.ENABLE_USER_SITE

Sinalizador mostrando o status do diretório site-packages do usuário. @code{True} significa que ele está habilitado e foi adicionado a @code{sys.path}. @code{False} significa que ele foi desabilitado por solicitação do usuário (com @ref{13d5,,-s} ou 
@geindex PYTHONNOUSERSITE
@geindex variável de ambiente; PYTHONNOUSERSITE
@ref{13d6,,PYTHONNOUSERSITE}). @code{None} significa que ele foi desabilitado por motivos de segurança (incompatibilidade entre o ID do usuário ou grupo e o ID efetivo) ou por um administrador.
@end deffn

@geindex USER_SITE (no módulo site)
@anchor{library/site site USER_SITE}@anchor{1ecf}
@deffn {Dado} site.USER_SITE

Caminho para o usuário site-packages para o Python em execução. Pode ser @code{None} se @ref{1281,,getusersitepackages()} ainda não tiver sido chamado. O valor padrão é @code{~/.local/lib/python`X.Y'[t]/site-packages} para construções UNIX e macOS não-framework, @code{~/Library/Python/`X.Y'/lib/python/site-packages} para construções macOS framework e @code{`%APPDATA%'\Python\Python`XY'\site-packages} no Windows. O “t” opcional indica a construção com threads livres. Este diretório é um diretório de site, o que significa que os arquivos @code{.pth} nele serão processados.
@end deffn

@geindex USER_BASE (no módulo site)
@anchor{library/site site USER_BASE}@anchor{1361}
@deffn {Dado} site.USER_BASE

Caminho para o diretório base para os pacotes do site do usuário. Pode ser @code{None} se @ref{1280,,getuserbase()} ainda não tiver sido chamado. O valor padrão é @code{~/.local} para construções não-framework UNIX e macOS, @code{~/Library/Python/`X.Y'} para construções de framework macOS e @code{`%APPDATA%'\Python} para Windows. Este valor é usado para calcular os diretórios de instalação para scripts, arquivos de dados, módulos Python, etc. para o @ref{1ed0,,esquema de instalação de usuário}. Veja também 
@geindex PYTHONUSERBASE
@geindex variável de ambiente; PYTHONUSERBASE
@ref{13d4,,PYTHONUSERBASE}.
@end deffn

@geindex main() (no módulo site)
@anchor{library/site site main}@anchor{1ebe}
@deffn {Função} site.main ()

Adiciona todos os diretórios padrão específicos do site ao caminho de pesquisa de módulos. Esta função é chamada automaticamente quando este módulo é importado, a menos que o interpretador Python tenha sido iniciado com o sinalizador @ref{11e7,,-S}.


Alterado na versão 3.3: Esta função costumava ser chamada incondicionalmente.

@end deffn

@geindex addsitedir() (no módulo site)
@anchor{library/site site addsitedir}@anchor{1ff3}
@deffn {Função} site.addsitedir (sitedir, known_paths=None)

Adiciona um diretório a sys.path e processa seus arquivos @code{.pth}. Normalmente usado em @ref{c8,,sitecustomize} ou @ref{10e,,usercustomize} (veja acima).
@end deffn

@geindex getsitepackages() (no módulo site)
@anchor{library/site site getsitepackages}@anchor{127f}
@deffn {Função} site.getsitepackages ()

Retorna uma lista contendo todos os diretórios globais de pacotes de sites.


Adicionado na versão 3.2.

@end deffn

@geindex getuserbase() (no módulo site)
@anchor{library/site site getuserbase}@anchor{1280}
@deffn {Função} site.getuserbase ()

Retorna o caminho do diretório base do usuário, @ref{1361,,USER_BASE}. Se ele ainda não foi inicializado, esta função também o definirá, respeitando 
@geindex PYTHONUSERBASE
@geindex variável de ambiente; PYTHONUSERBASE
@ref{13d4,,PYTHONUSERBASE}.


Adicionado na versão 3.2.

@end deffn

@geindex getusersitepackages() (no módulo site)
@anchor{library/site site getusersitepackages}@anchor{1281}
@deffn {Função} site.getusersitepackages ()

Retorna o caminho do diretório site-packages específico do usuário, @ref{1ecf,,USER_SITE}. Se ele ainda não foi inicializado, esta função também o definirá, respeitando @ref{1361,,USER_BASE}. Para determinar se o site-packages específico do usuário foi adicionado a @code{sys.path}, @ref{471e,,ENABLE_USER_SITE} deve ser usado.


Adicionado na versão 3.2.

@end deffn

@node Interface de linha de comando<14>,,Conteúdo do módulo<10>,site — Gancho de configuração específico do site
@anchor{library/site command-line-interface}@anchor{4722}@anchor{library/site site-commandline}@anchor{4723}
@subsubsection Interface de linha de comando


O módulo @ref{c7,,site} também fornece uma maneira de obter os diretórios do usuário a partir da linha de comando:

@example
$ python -m site --user-site
/home/user/.local/lib/python3.11/site-packages
@end example

Se for chamado sem argumentos, ele vai exibir o conteúdo de @ref{3b4,,sys.path} na saída padrão, seguido pelo valor de @ref{1361,,USER_BASE} e se o diretório existe, depois o mesmo para @ref{1ecf,,USER_SITE} e, finalmente, o valor de @ref{471e,,ENABLE_USER_SITE}.

@geindex site opção de linha de comando; --user-base
@anchor{library/site cmdoption-site-user-base}@anchor{4724}
@deffn {Option} @w{-}@w{-}user@w{-}base

Exibe o caminho para o diretório base do usuário.
@end deffn

@geindex site opção de linha de comando; --user-site
@anchor{library/site cmdoption-site-user-site}@anchor{4725}
@deffn {Option} @w{-}@w{-}user@w{-}site

Exibe o caminho para o diretório site-packages do usuário.
@end deffn

Se ambas as opções forem fornecidas, a base do usuário e o site do usuário serão exibidos (sempre nesta ordem), separados por @ref{1ecc,,os.pathsep}.

Se qualquer opção for fornecida, o script sairá com um destes valores: @code{0} se o diretório site-packages do usuário estiver habilitado, @code{1} se ele foi desabilitado pelo usuário, @code{2} se ele foi desabilitado por motivos de segurança ou por um administrador, e um valor maior que 2 se houver um erro.


@subsubheading Ver também



@itemize *

@item 
@geindex Propostas de Melhorias do Python; PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} – Diretório site-packages por usuário.

@item 
@ref{1de6,,A inicialização do caminho de pesquisa de módulos sys.path} – A inicialização de @ref{3b4,,sys.path}.
@end itemize


@node Interpretadores Python Personalizados,Importando módulos,Serviços de Tempo de Execução Python,A Biblioteca Padrão do Python
@anchor{library/custominterp doc}@anchor{4726}@anchor{library/custominterp custom-python-interpreters}@anchor{4727}@anchor{library/custominterp custominterp}@anchor{4728}@anchor{library/custominterp translation-repo}@anchor{4729}
@section Interpretadores Python Personalizados


Os módulos descritos neste capítulo permitem a escrita de interfaces semelhantes ao interpretador interativo da Python. Se você quer um interpretador de Python que suporte algum recurso especial, além do idioma de Python, você deve olhar para o módulo @ref{1a,,code}. (O módulo @ref{1c,,codeop} é de nível inferior, usado para suportar compilação de um pedaço possivelmente incompleto do código Python).

A lista completa de módulos descritos neste capítulo é:

@menu
* code — Classes bases do interpretador:: 
* codeop — Compila código Python:: 

@end menu

@node code — Classes bases do interpretador,codeop — Compila código Python,,Interpretadores Python Personalizados
@anchor{library/code doc}@anchor{472a}@anchor{library/code code-interpreter-base-classes}@anchor{472b}@anchor{library/code module-code}@anchor{1a}
@subsection @code{code} — Classes bases do interpretador


@geindex module; code

`Código-fonte:' Lib/code.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/code.py}


__________________________________________________________________


O módulo @code{code} fornece facilidades para implementar laços de leitura-execução-escrita no código Python. São incluídas duas classes e funções de conveniência que podem ser usadas para criar aplicações que fornecem um prompt de interpretador interativo.

@geindex InteractiveInterpreter (classe em code)
@anchor{library/code code InteractiveInterpreter}@anchor{16c3}
@deffn {Classe} code.InteractiveInterpreter (locals=None)

Esta classe trata de análise e estado do interpretador (espaço de nomes do usuário); o mesmo não lida com buffer de entrada ou solicitação ou nomeação de arquivo de entrada (o nome do arquivo é sempre passado explicitamente). O argumento opcional `locals' especifica um mapeamento para usar como espaço de nomes no qual o código será executado; ele é padrão para um dicionário recém-criado com a chave @code{'__name__'} definida com @code{'__console__'} e a chave @code{'__doc__'} definida com @code{None}.

Observe que objetos funções e classes criados sob uma instância @code{InteractiveInterpreter} pertencerão ao espaço de nomes especificado por `locals'. Só serão selecionáveis se `locals' for o espaço de nomes de um módulo existente.
@end deffn

@geindex InteractiveConsole (classe em code)
@anchor{library/code code InteractiveConsole}@anchor{2533}
@deffn {Classe} code.InteractiveConsole (locals=None, filename='<console>', local_exit=False)

Emula de forma muito semelhante o comportamento do interpretador Python interativo. Esta classe baseia-se em @ref{16c3,,InteractiveInterpreter} e adiciona prompts usando os familiares @code{sys.ps1} e @code{sys.ps2}, e buffer de entrada. Se `local_exit' for verdadeiro, @code{exit()} e @code{quit()} no console não levantarão @ref{d63,,SystemExit}, mas retornarão ao código de chamada.


Alterado na versão 3.13: Adicionado o parâmetro `local_exit'.

@end deffn

@geindex interact() (no módulo code)
@anchor{library/code code interact}@anchor{17c8}
@deffn {Função} code.interact (banner=None, readfunc=None, local=None, exitmsg=None, local_exit=False)

Função de conveniência para executar um laço de leitura-execução-impressão. Isto cria uma nova instância de @ref{2533,,InteractiveConsole} e define `readfunc' para ser usado como o método @ref{472c,,InteractiveConsole.raw_input()}, se fornecido. Se `local' for fornecido, ele será passado para o construtor @ref{2533,,InteractiveConsole} para uso como espaço de nomes padrão para o laço do interpretador. Se `local_exit' for fornecido, ele será passado para o construtor @ref{2533,,InteractiveConsole}. O método @ref{472d,,interact()} da instância é então executado com `banner' e `exitmsg' passados como banner e mensagem de saída a serem usados, se fornecidos. O objeto console é descartado após o uso.


Alterado na versão 3.6: Parâmetro adicionado `exitmsg'.



Alterado na versão 3.13: Adicionado o parâmetro `local_exit'.

@end deffn

@geindex compile_command() (no módulo code)
@anchor{library/code code compile_command}@anchor{472e}
@deffn {Função} code.compile_command (source, filename='<input>', symbol='single')

Esta função é útil para programas que desejam emular o laço principal do interpretador Python (também conhecido como laço de leitura-execução-impressão). A parte complicada é determinar quando o usuário digitou um comando incompleto que pode ser concluído inserindo mais texto (em vez de um comando completo ou um erro de sintaxe). Esta função `quase' sempre toma a mesma decisão que o laço principal do interpretador real.

`source' é a string fonte; `filename' é o nome do arquivo opcional do qual a fonte foi lida, sendo o padrão @code{'<input>'}; e `symbol' é o símbolo opcional de início da gramática, que deve ser @code{'single'} (o padrão), @code{'eval'} ou @code{'exec'}.

Retorna um objeto código (o mesmo que @code{compile(source, filename, symbol)}) se o comando for completo e válido; @code{None} se o comando estiver incompleto; levanta @ref{18d,,SyntaxError} se o comando estiver completo e contém um erro de sintaxe, ou levanta @ref{885,,OverflowError} ou @ref{202,,ValueError} se o comando contiver um literal inválido.
@end deffn

@menu
* Objetos de interpretador interativo:: 
* Objetos de console Interativo:: 

@end menu

@node Objetos de interpretador interativo,Objetos de console Interativo,,code — Classes bases do interpretador
@anchor{library/code interactive-interpreter-objects}@anchor{472f}@anchor{library/code interpreter-objects}@anchor{4730}
@subsubsection Objetos de interpretador interativo


@geindex runsource() (método code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter runsource}@anchor{4731}
@deffn {Método} InteractiveInterpreter.runsource (source, filename='<input>', symbol='single')

Compila e executa alguma fonte no interpretador. Os argumentos são os mesmos de @ref{472e,,compile_command()}; o padrão para `filename' é @code{'<input>'}, e para `symbol' é @code{'single'}. Uma de várias coisas pode acontecer:


@itemize *

@item 
A entrada está incorreta; @ref{472e,,compile_command()} levantou uma exceção (@ref{18d,,SyntaxError} ou @ref{885,,OverflowError}). Um traceback da sintaxe será impresso chamando o método @ref{4732,,showsyntaxerror()}. @ref{4731,,runsource()} retorna @code{False}.

@item 
A entrada está incompleta e são necessárias mais entradas; @ref{472e,,compile_command()} retornou @code{None}. @ref{4731,,runsource()} retorna @code{True}.

@item 
A entrada está completa; @ref{472e,,compile_command()} retornou um objeto código. O código é executado chamando @ref{4733,,runcode()} (que também lida com exceções de tempo de execução, exceto @ref{d63,,SystemExit}). @ref{4731,,runsource()} retorna @code{False}.
@end itemize

O valor de retorno pode ser usado para decidir se usar @code{sys.ps1} ou @code{sys.ps2} para solicitar a próxima linha.
@end deffn

@geindex runcode() (método code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter runcode}@anchor{4733}
@deffn {Método} InteractiveInterpreter.runcode (code)

Executa um objeto código. Quando ocorre uma exceção, @ref{df8,,showtraceback()} é chamado para exibir um traceback. Todas as exceções são capturadas, exceto @ref{d63,,SystemExit}, que pode ser propagada.

Uma observação sobre @ref{9d9,,KeyboardInterrupt}: esta exceção pode ocorrer em outro lugar neste código e nem sempre pode ser detectada. O chamador deve estar preparado para lidar com isso.
@end deffn

@geindex showsyntaxerror() (método code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter showsyntaxerror}@anchor{4732}
@deffn {Método} InteractiveInterpreter.showsyntaxerror (filename=None)

Exibe o erro de sintaxe que acabou de ocorrer. Isso não exibe um stack trace (situação da pilha de execução) porque não há um para erros de sintaxe. Se `filename' for fornecido, ele será inserido na exceção em vez do nome de arquivo padrão fornecido pelo analisador sintático do Python, porque ele sempre usa @code{'<string>'} ao ler uma string. A saída é escrita pelo método @ref{4734,,write()}.
@end deffn

@geindex showtraceback() (método code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter showtraceback}@anchor{df8}
@deffn {Método} InteractiveInterpreter.showtraceback ()

Exibe a exceção que acabou de ocorrer. Removemos o primeiro item da pilha porque ele está dentro da implementação do objeto interpretador. A saída é escrita pelo método @ref{4734,,write()}.


Alterado na versão 3.5: O traceback encadeado completo é exibido em vez de apenas o traceback primário.

@end deffn

@geindex write() (método code.InteractiveInterpreter)
@anchor{library/code code InteractiveInterpreter write}@anchor{4734}
@deffn {Método} InteractiveInterpreter.write (data)

Escreve uma string no fluxo de erro padrão (@code{sys.stderr}). As classes derivadas devem substituir isso para fornecer o tratamento de saída apropriado conforme necessário.
@end deffn

@node Objetos de console Interativo,,Objetos de interpretador interativo,code — Classes bases do interpretador
@anchor{library/code console-objects}@anchor{4735}@anchor{library/code interactive-console-objects}@anchor{4736}
@subsubsection Objetos de console Interativo


A classe @ref{2533,,InteractiveConsole} é uma subclasse de @ref{16c3,,InteractiveInterpreter} e, portanto, oferece todos os métodos dos objetos interpretadores, bem como as seguintes adições.

@geindex interact() (método code.InteractiveConsole)
@anchor{library/code code InteractiveConsole interact}@anchor{472d}
@deffn {Método} InteractiveConsole.interact (banner=None, exitmsg=None)

Emula de forma muito semelhante o console interativo do Python. O argumento opcional `banner' especifica o banner a ser impresso antes da primeira interação; por padrão ele imprime um banner semelhante ao impresso pelo interpretador Python padrão, seguido pelo nome da classe do objeto console entre parênteses (para não confundir isso com o interpretador real – já que está tão próximo!).

O argumento opcional `exitmsg' especifica uma mensagem de saída impressa ao sair. Passe a string vazia para suprimir a mensagem de saída. Se `exitmsg' não for fornecido ou @code{None}, uma mensagem padrão será impressa.


Alterado na versão 3.4: Para suprimir a impressão de qualquer banner, passe uma string vazia.



Alterado na versão 3.6: Imprime uma mensagem de saída ao sair.

@end deffn

@geindex push() (método code.InteractiveConsole)
@anchor{library/code code InteractiveConsole push}@anchor{4737}
@deffn {Método} InteractiveConsole.push (line)

Envia uma linha do texto fonte para o interpretador. A linha não deve ter uma nova linha à direita; pode ter novas linhas internas. A linha é anexada a um buffer e o método @ref{4731,,runsource()} do interpretador é chamado com o conteúdo concatenado do buffer como fonte. Se isso indicar que o comando foi executado ou é inválido, o buffer será redefinido; caso contrário, o comando estará incompleto e o buffer permanecerá como estava após a linha ser anexada. O valor de retorno é @code{True} se mais entrada for necessária, @code{False} se a linha foi tratada de alguma forma (isto é o mesmo que @code{runsource()}).
@end deffn

@geindex resetbuffer() (método code.InteractiveConsole)
@anchor{library/code code InteractiveConsole resetbuffer}@anchor{4738}
@deffn {Método} InteractiveConsole.resetbuffer ()

Remove qualquer texto fonte não tratado do buffer de entrada.
@end deffn

@geindex raw_input() (método code.InteractiveConsole)
@anchor{library/code code InteractiveConsole raw_input}@anchor{472c}
@deffn {Método} InteractiveConsole.raw_input (prompt='@w{'})

Escreve um prompt e leia uma linha. A linha retornada não inclui a nova linha final. Quando o usuário insere a sequência de teclas de fim de linha, uma exceção @ref{131c,,EOFError} é levantada. A implementação base lê @code{sys.stdin}; uma subclasse pode substituir isso por uma implementação diferente.
@end deffn

@node codeop — Compila código Python,,code — Classes bases do interpretador,Interpretadores Python Personalizados
@anchor{library/codeop doc}@anchor{4739}@anchor{library/codeop codeop-compile-python-code}@anchor{473a}@anchor{library/codeop module-codeop}@anchor{1c}@anchor{library/codeop translation-repo}@anchor{473b}
@subsection @code{codeop} — Compila código Python


@geindex module; codeop

`Código-fonte:' Lib/codeop.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/codeop.py}


__________________________________________________________________


O módulo @ref{1c,,codeop} fornece utilitários sobre os quais o loop de leitura-execução-exibição do Python pode ser emulado, como é feito no módulo @ref{1a,,code}. Como resultado, você provavelmente não deseja usar o módulo diretamente; se você deseja incluir tal loop em seu programa, você provavelmente deseja usar o módulo @ref{1a,,code}.

Há duas partes para esta tarefa:


@enumerate 

@item 
Ser capaz de dizer se uma linha de entrada completa uma instrução Python: em suma, dizer se deve exibir ‘@code{>>>}’ ou ‘@code{...}’ em seguida.

@item 
Lembrar quais instruções futuras o usuário inseriu, para que as entradas subsequentes possam ser compiladas com essas declarações em vigor.
@end enumerate

O módulo @ref{1c,,codeop} fornece uma maneira de fazer cada uma dessas coisas e uma maneira de fazer as duas coisas.

Para fazer apenas a primeira:

@geindex compile_command() (no módulo codeop)
@anchor{library/codeop codeop compile_command}@anchor{18dd}
@deffn {Função} codeop.compile_command (source, filename='<input>', symbol='single')

Tenta compilar `source', que deve ser uma string de código Python e retornar um objeto código se `source' for um código Python válido. Nesse caso, o atributo de nome de arquivo do objeto código será `filename', cujo padrão é @code{'<input>'}. Retorna @code{None} se `source' `não' é um código Python válido, mas é um prefixo de código Python válido.

Se houver um problema com `source', uma exceção será levantada. @ref{18d,,SyntaxError} é levantada se houver sintaxe Python inválida, e @ref{885,,OverflowError} ou @ref{202,,ValueError} se houver um literal inválido.

O argumento `symbol' determina se `source' é compilado como uma instrução (@code{'single'}, o padrão), como uma sequência de @ref{2935,,instruções} (@code{'exec'}) ou como uma @ref{2111,,expressão} (@code{'eval'}). Qualquer outro valor fará com que @ref{202,,ValueError} seja levantada.

@cartouche
@quotation Nota 
É possível (mas não provável) que o analisador sintático pare de analisar com um resultado bem-sucedido antes de chegar ao final da fonte; neste caso, os símbolos finais podem ser ignorados em vez de causar um erro. Por exemplo, uma barra invertida seguida por duas novas linhas pode ser seguida por lixo arbitrário. Isso será corrigido quando a API para o analisador for melhor.
@end quotation
@end cartouche
@end deffn

@geindex Compile (classe em codeop)
@anchor{library/codeop codeop Compile}@anchor{473c}
@deffn {Classe} codeop.Compile

Instâncias desta classe têm métodos @ref{558,,__call__()} idênticos em assinatura à função embutida @ref{192,,compile()}, mas com a diferença de que se a instância compilar o texto do programa contendo uma instrução @ref{0,,__future__}, a instância se “lembra” e compila todos os textos de programa subsequentes com a instrução em vigor.
@end deffn

@geindex CommandCompiler (classe em codeop)
@anchor{library/codeop codeop CommandCompiler}@anchor{473d}
@deffn {Classe} codeop.CommandCompiler

Instâncias desta classe têm métodos @ref{558,,__call__()} idênticos em assinatura a @ref{18dd,,compile_command()}; a diferença é que se a instância compila o texto do programa contendo uma instrução @ref{0,,__future__}, a instância se “lembra” e compila todos os textos do programa subsequentes com a instrução em vigor.
@end deffn

@node Importando módulos,Serviços da Linguagem Python,Interpretadores Python Personalizados,A Biblioteca Padrão do Python
@anchor{library/modules doc}@anchor{473e}@anchor{library/modules importing-modules}@anchor{473f}@anchor{library/modules modules}@anchor{4740}@anchor{library/modules translation-repo}@anchor{4741}
@section Importando módulos


Os módulos descritos neste capítulo fornecem novas maneiras de importar outros módulos Python e hooks para personalizar o processo de importação.

A lista completa de módulos descritos neste capítulo é:

@menu
* zipimport - Importa módulos de arquivos Zip:: 
* pkgutil — Utilitário de extensão de pacote:: 
* modulefinder — Procura módulos usados por um script:: 
* runpy — Localizando e executando módulos Python:: 
* importlib — A implementação de import:: 
* importlib.resources – Leitura@comma{} abertura e acesso a recursos de pacotes: importlib resources – Leitura abertura e acesso a recursos de pacotes. 
* importlib.resources.abc – Classes base abstratas para recursos: importlib resources abc – Classes base abstratas para recursos. 
* importlib.metadata – Acessando metadados do pacote: importlib metadata – Acessando metadados do pacote. 
* A inicialização do caminho de pesquisa de módulos sys.path: A inicialização do caminho de pesquisa de módulos sys path. 

@end menu

@node zipimport - Importa módulos de arquivos Zip,pkgutil — Utilitário de extensão de pacote,,Importando módulos
@anchor{library/zipimport doc}@anchor{4742}@anchor{library/zipimport module-zipimport}@anchor{132}@anchor{library/zipimport zipimport-import-modules-from-zip-archives}@anchor{4743}
@subsection @code{zipimport} - Importa módulos de arquivos Zip


@geindex module; zipimport

`Código-fonte:' Lib/zipimport.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/zipimport.py}


__________________________________________________________________


Este módulo adiciona a capacidade de importar módulos Python (@code{*.py}, @code{*.pyc}) e pacotes de arquivos em formato ZIP. Normalmente, não é necessário usar o módulo @ref{132,,zipimport} explicitamente; ele é usado automaticamente pelo mecanismo embutido no @ref{5e2,,import} para itens @ref{3b4,,sys.path} que são caminhos para arquivos ZIP.

Normalmente, @ref{3b4,,sys.path} é uma lista de nomes de diretórios como strings. Este módulo também permite que um item de @ref{3b4,,sys.path} seja uma string que nomeia um arquivo ZIP. O arquivo ZIP pode conter uma estrutura de subdiretório para suportar importações de pacotes, e um caminho dentro do arquivo pode ser especificado para importar apenas de um subdiretório. Por exemplo, o caminho @code{example.zip/lib/} importaria apenas do subdiretório @code{lib/} dentro do arquivo.

Quaisquer arquivos podem estar presentes no arquivo ZIP, mas os importadores são invocados apenas para os arquivos @code{.py} e @code{.pyc}. A importação ZIP de módulos dinâmicos (@code{.pyd}, @code{.so}) não é permitida. Observe que, se um arquivo contiver apenas arquivos @code{.py}, o Python não tentará modificá-lo adicionando o arquivo @code{.pyc} correspondente, o que significa que, se um arquivo ZIP não contiver arquivos @code{.pyc}, a importação poderá ser bastante lenta.


Alterado na versão 3.13: Suporte para ZIP64.



Alterado na versão 3.8: Anteriormente, não havia suporte para arquivos ZIP com um comentário de arquivo.



@subsubheading Ver também



@table @asis

@item Nota da aplicação PKZIP@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

Documentação do formato de arquivo ZIP feita por Phil Katz, criador do formato e dos algoritmos usados.

@geindex Propostas de Melhorias do Python; PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - Import Modules from Zip Archives

Escrito por James C. Ahlstrom, que também forneceu uma implementação. O Python 2.3 segue a especificação em 
@geindex Propostas de Melhorias do Python; PEP 273
PEP 273@footnote{https://peps.python.org/pep-0273/}, mas usa uma implementação escrita por Just van Rossum que utiliza os ganchos de importação descritos em 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@item @ref{77,,importlib} - A importação do maquinário de importação

Pacote que fornece os protocolos relevantes para todos os importadores implementarem.
@end table


Este módulo define uma exceção:

@geindex ZipImportError
@anchor{library/zipimport zipimport ZipImportError}@anchor{4744}
@deffn {Exceção} zipimport.ZipImportError

Exceção levantada por objetos zipimporter. É uma subclasse de @ref{419,,ImportError}, portanto, também pode ser capturada como @ref{419,,ImportError}.
@end deffn

@menu
* Objetos zipimporter:: 
* Exemplos: Exemplos<33>. 

@end menu

@node Objetos zipimporter,Exemplos<33>,,zipimport - Importa módulos de arquivos Zip
@anchor{library/zipimport id1}@anchor{4745}@anchor{library/zipimport zipimporter-objects}@anchor{4746}
@subsubsection Objetos zipimporter


@ref{4747,,zipimporter} é a classe para importar arquivos ZIP.

@geindex zipimporter (classe em zipimport)
@anchor{library/zipimport zipimport zipimporter}@anchor{4747}
@deffn {Classe} zipimport.zipimporter (archivepath)

Cria uma nova instância de zipimporter. `archivepath' deve ser um caminho para um arquivo ZIP ou para um caminho específico dentro de um arquivo ZIP. Por exemplo, um `archivepath' de @code{foo/bar.zip/lib} procurará módulos no diretório @code{lib} dentro do arquivo ZIP @code{foo/bar.zip} (desde que exista).

@ref{4744,,ZipImportError} é levantada se `archivepath' não apontar para um arquivo ZIP válido.


Alterado na versão 3.12: Os métodos @code{find_loader()} e @code{find_module()}, descontinuados na versão 3.10, foram removidos. Em vez disso, use @ref{861,,find_spec()}.


@geindex create_module() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter create_module}@anchor{862}
@deffn {Método} create_module (spec)

Implementação de @ref{cce,,importlib.abc.Loader.create_module()} que retorna @ref{675,,None} para solicitar explicitamente a semântica padrão.


Adicionado na versão 3.10.

@end deffn

@geindex exec_module() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter exec_module}@anchor{312}
@deffn {Método} exec_module (module)

Implementação de @ref{86e,,importlib.abc.Loader.exec_module()}.


Adicionado na versão 3.10.

@end deffn

@geindex find_spec() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter find_spec}@anchor{861}
@deffn {Método} find_spec (fullname, target=None)

Uma implementação de @ref{870,,importlib.abc.PathEntryFinder.find_spec()}.


Adicionado na versão 3.10.

@end deffn

@geindex get_code() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_code}@anchor{4748}
@deffn {Método} get_code (fullname)

Retorna o objeto código para o módulo especificado. Levanta @ref{4744,,ZipImportError} se o módulo não puder ser importado.
@end deffn

@geindex get_data() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_data}@anchor{4749}
@deffn {Método} get_data (pathname)

Retorna os dados associados a `pathname'. Levanta @ref{417,,OSError} se o arquivo não for encontrado.


Alterado na versão 3.3: @ref{108b,,IOError} costumava ser levantada, agora ela é um apelido para @ref{417,,OSError}.

@end deffn

@geindex get_filename() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_filename}@anchor{474a}
@deffn {Método} get_filename (fullname)

Retorna o valor que @code{__file__} seria definido se o módulo especificado fosse importado. Levanta @ref{4744,,ZipImportError} se o módulo não puder ser importado.


Adicionado na versão 3.1.

@end deffn

@geindex get_source() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter get_source}@anchor{474b}
@deffn {Método} get_source (fullname)

Retorna o código-fonte do módulo especificado. Levanta @ref{4744,,ZipImportError} se o módulo não puder ser encontrado, e retorna @ref{675,,None} se o arquivo contiver o módulo, mas não tiver o código-fonte para ele.
@end deffn

@geindex is_package() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter is_package}@anchor{474c}
@deffn {Método} is_package (fullname)

Retorna @code{True} se o módulo especificado por `fullname' é um pacote. Levanta @ref{4744,,ZipImportError} se o módulo não pode ser localizado.
@end deffn

@geindex load_module() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter load_module}@anchor{311}
@deffn {Método} load_module (fullname)

Carrega o módulo especificado por `fullname'. `fullname' deve ser o nome completo (com pontos) do módulo. Retorna o módulo importado em caso de sucesso e levanta @ref{4744,,ZipImportError} em caso de falha.


Descontinuado desde a versão 3.10: Use @ref{312,,exec_module()}.

@end deffn

@geindex invalidate_caches() (método zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter invalidate_caches}@anchor{863}
@deffn {Método} invalidate_caches ()

Limpa o cache interno de informações sobre arquivos encontrados no arquivo ZIP.


Adicionado na versão 3.10.

@end deffn

@geindex archive (atributo zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter archive}@anchor{474d}
@deffn {Atributo} archive

O nome do arquivo ZIP associado ao importador, sem um possível subcaminho.
@end deffn

@geindex prefix (atributo zipimport.zipimporter)
@anchor{library/zipimport zipimport zipimporter prefix}@anchor{474e}
@deffn {Atributo} prefix

O subcaminho dentro do arquivo ZIP onde os módulos são pesquisados. Esta é a string vazia para objetos zipimporter que apontam para a raiz do arquivo ZIP.
@end deffn

Os atributos @ref{474d,,archive} e @ref{474e,,prefix}, quando combinados com uma barra, são iguais ao argumento original `archivepath' fornecido ao construtor da @ref{4747,,zipimporter}.
@end deffn

@node Exemplos<33>,,Objetos zipimporter,zipimport - Importa módulos de arquivos Zip
@anchor{library/zipimport examples}@anchor{474f}@anchor{library/zipimport zipimport-examples}@anchor{4750}
@subsubsection Exemplos


Aqui está um exemplo que importa um módulo de um arquivo ZIP - observe que o módulo @ref{132,,zipimport} não é usado explicitamente.

@example
$ unzip -l arquivo_exemplo.zip
Archive:  arquivo_exemplo.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  01-01-00 12:30   exemplo.py
 --------                   -------
     8467                   1 file
@end example

@example
>>> import sys
>>> # Adiciona o arquivo para a frente do caminho de pesquisa de módulos
>>> sys.path.insert(0, 'arquivo_exemplo.zip')
>>> import exemplo
>>> exemplo.__file__
'arquivo_exemplo.zip/exemplo.py'
@end example

@node pkgutil — Utilitário de extensão de pacote,modulefinder — Procura módulos usados por um script,zipimport - Importa módulos de arquivos Zip,Importando módulos
@anchor{library/pkgutil doc}@anchor{4751}@anchor{library/pkgutil module-pkgutil}@anchor{a9}@anchor{library/pkgutil pkgutil-package-extension-utility}@anchor{4752}@anchor{library/pkgutil translation-repo}@anchor{4753}
@subsection @code{pkgutil} — Utilitário de extensão de pacote


@geindex module; pkgutil

`Código-fonte:' Lib/pkgutil.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pkgutil.py}


__________________________________________________________________


Este módulo fornece utilitários para o sistema de importação, em particular suporte a pacotes.

@geindex ModuleInfo (classe em pkgutil)
@anchor{library/pkgutil pkgutil ModuleInfo}@anchor{d6f}
@deffn {Classe} pkgutil.ModuleInfo (module_finder, name, ispkg)

Um namedtuple que contém um breve resumo das informações de um módulo.


Adicionado na versão 3.6.

@end deffn

@geindex extend_path() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil extend_path}@anchor{16d0}
@deffn {Função} pkgutil.extend_path (path, name)

Estende o caminho de pesquisa para os módulos que compõem um pacote. O uso pretendido é colocar o seguinte código no @code{__init__.py} de um pacote:

@example
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
@end example

Para cada diretório em @ref{3b4,,sys.path} que tenha um subdiretório que corresponda ao nome do pacote, adiciona o subdiretório ao @ref{1df4,,__path__} do pacote. Isto é útil se quisermos distribuir diferentes partes de um único pacote lógico como múltiplos diretórios.

Também procura por arquivos @code{*.pkg} que começam onde @code{*} corresponde ao argumento `name'. Este recurso é semelhante aos arquivos @code{*.pth} (consulte o módulo @ref{c7,,site} para mais informações), exceto que não considera casos especiais para linhas que começam com @code{import}. Um arquivo @code{*.pkg} é confiável por natureza: além de pular linhas em branco e ignorar comentários, todas as entradas encontradas em um arquivo @code{*.pkg} são adicionadas ao caminho, independentemente de existirem ou não no sistema de arquivos (este é um recurso).

Se o caminho de entrada não for uma lista (como é o caso de pacotes congelados), ele será retornado inalterado. O caminho de entrada não é modificado; uma cópia estendida é retornada. Os itens são anexados à cópia apenas no final.

Presume-se que @ref{3b4,,sys.path} seja uma sequência. Itens de @ref{3b4,,sys.path} que não sejam strings referentes a diretórios existentes são ignorados. Itens Unicode em @ref{3b4,,sys.path} que causam erros quando usados como nomes de arquivo podem fazer com que esta função levante uma exceção (em linha com o comportamento de @ref{a1a,,os.path.isdir()}).
@end deffn

@geindex find_loader() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil find_loader}@anchor{2cb}
@deffn {Função} pkgutil.find_loader (fullname)

Recupera o @ref{17a4,,carregador} de um módulo para o `fullname' fornecido.

Este é um invólucro para retrocompatibilidade em torno de @ref{2cd,,importlib.util.find_spec()} que converte a maioria das falhas em @ref{419,,ImportError} e retorna apenas o carregador, em vez do @ref{1fee,,importlib.machinery.ModuleSpec} completo.


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.



Alterado na versão 3.4: Atualizado para ser baseado na 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}



Descontinuado desde a versão 3.12, será removido na versão 3.14: Use @ref{2cd,,importlib.util.find_spec()}.

@end deffn

@geindex get_importer() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil get_importer}@anchor{4754}
@deffn {Função} pkgutil.get_importer (path_item)

Recupera um @ref{20ae,,localizador} para o `path_item' fornecido.

O localizador retornado é armazenado em cache em @ref{5e4,,sys.path_importer_cache} se ele foi criado recentemente por um gancho de caminho.

O cache (ou parte dele) pode ser limpo manualmente se uma nova varredura de @ref{105a,,sys.path_hooks} for necessária.


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@end deffn

@geindex get_loader() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil get_loader}@anchor{2cc}
@deffn {Função} pkgutil.get_loader (module_or_name)

Obtém um objeto @ref{17a4,,carregador} para `module_or_name'.

Se o módulo ou pacote estiver acessível pelo mecanismo de importação normal, um invólucro em torno da parte relevante desse maquinário será retornado. Retorna @code{None} se o módulo não puder ser encontrado ou importado. Se o módulo nomeado ainda não tiver sido importado, o pacote que o contém (se houver) será importado para estabelecer o pacote @code{__path__}.


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.



Alterado na versão 3.4: Atualizado para ser baseado na 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}



Descontinuado desde a versão 3.12, será removido na versão 3.14: Use @ref{2cd,,importlib.util.find_spec()}.

@end deffn

@geindex iter_importers() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil iter_importers}@anchor{11d8}
@deffn {Função} pkgutil.iter_importers (fullname='@w{'})

Produz objetos @ref{20ae,,localizador} para o nome do módulo fornecido.

Se `fullname' contiver @code{'.'}, os localizadores serão para o pacote que contém `fullname', caso contrário, serão todos os localizadores de nível superior registrados (ou seja, aqueles em @ref{d4d,,sys.meta_path} e @ref{105a,,sys.path_hooks}).

Se o módulo nomeado estiver em um pacote, esse pacote será importado como um efeito colateral da invocação desta função.

Se nenhum nome de módulo for especificado, todos os localizadores de nível superior serão produzidos.


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@end deffn

@geindex iter_modules() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil iter_modules}@anchor{d6e}
@deffn {Função} pkgutil.iter_modules (path=None, prefix='@w{'})

Levanta @ref{d6f,,ModuleInfo} para todos os submódulos em `path' ou, se `path' for @code{None}, todos os módulos de nível superior em @ref{3b4,,sys.path}.

`path' deve ser @code{None} ou uma lista de caminhos para procurar módulos.

`prefix' é uma string a ser exibida na frente de cada nome de módulo na saída.

@cartouche
@quotation Nota 
Funciona apenas para um @ref{20ae,,localizador} que define um método @code{iter_modules()}. Esta interface não é padrão, portanto, o módulo também fornece implementações para @ref{10ab,,importlib.machinery.FileFinder} e @ref{4747,,zipimport.zipimporter}.
@end quotation
@end cartouche


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@end deffn

@geindex walk_packages() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil walk_packages}@anchor{c19}
@deffn {Função} pkgutil.walk_packages (path=None, prefix='@w{'}, onerror=None)

Levanta @ref{d6f,,ModuleInfo} para todos os módulos recursivamente em `path', ou, se `path' for @code{None}, todos os módulos acessíveis.

`path' deve ser @code{None} ou uma lista de caminhos para procurar módulos.

`prefix' é uma string a ser exibida na frente de cada nome de módulo na saída.

Observe que esta função deve importar todos os `pacotes' (`não' todos os módulos!) no caminho `path' fornecido, para acessar o atributo @code{__path__} para encontrar submódulos.

`onerror' é uma função que é chamada com um argumento (o nome do pacote que estava sendo importado) caso ocorra alguma exceção durante a tentativa de importação de um pacote. Se nenhuma função `onerror' for fornecida, @ref{419,,ImportError}s são capturadas e ignoradas, enquanto todas as outras exceções são propagadas, encerrando a busca.

Exemplos:

@example
# lista todos os módulos que o python consegue acessars
walk_packages()

# lista todos os submódulos de ctypes
walk_packages(ctypes.__path__, ctypes.__name__ + '.')
@end example

@cartouche
@quotation Nota 
Funciona apenas para um @ref{20ae,,localizador} que define um método @code{iter_modules()}. Esta interface não é padrão, portanto, o módulo também fornece implementações para @ref{10ab,,importlib.machinery.FileFinder} e @ref{4747,,zipimport.zipimporter}.
@end quotation
@end cartouche


Alterado na versão 3.3: Atualizado para ser baseado diretamente em @ref{77,,importlib} em vez de depender da emulação de importação interna do pacote da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@end deffn

@geindex get_data() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil get_data}@anchor{4755}
@deffn {Função} pkgutil.get_data (package, resource)

Obtém um recurso de um pacote.

Este é um invólucro para a API @ref{4756,,get_data} do @ref{17a4,,carregador}. O argumento `package' deve ser o nome de um pacote, no formato de módulo padrão (@code{foo.bar}). O argumento `resource' deve estar no formato de um nome de arquivo relativo, usando @code{/} como separador de caminho. O nome do diretório pai @code{..} não é permitido, nem um nome raiz (começando com @code{/}).

A função retorna uma string binária que é o conteúdo do recurso especificado.

Para pacotes localizados no sistema de arquivos, que já foram importados, isso é o equivalente aproximado de:

@example
d = os.path.dirname(sys.modules[package].__file__)
data = open(os.path.join(d, resource), 'rb').read()
@end example

Se o pacote não puder ser localizado ou carregado, ou se usar um @ref{17a4,,carregador} que não oferece suporte a @ref{4756,,get_data}, @code{None} será retornado. Em particular, o @ref{17a4,,carregador} para @ref{1dee,,pacotes de espaço de nomes} não oferece suporte a @ref{4756,,get_data}.
@end deffn

@geindex resolve_name() (no módulo pkgutil)
@anchor{library/pkgutil pkgutil resolve_name}@anchor{4757}
@deffn {Função} pkgutil.resolve_name (name)

Resolve um nome a um objeto.

Essa funcionalidade é usada em vários lugares na biblioteca padrão (veja bpo-12915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12915}) - e funcionalidades equivalentes também estão amplamente utilizadas em pacotes de terceiros, como setuptools, Django e Pyramid.

Espera-se que `name' seja uma string em um dos seguintes formatos, onde W é uma abreviação para um identificador Python válido e ponto representa um ponto literal nessas pseudo-regexes:


@itemize *

@item 
@code{W(.W)*}

@item 
@code{W(.W)*:(W(.W)*)?}
@end itemize

A primeira forma destina-se apenas à retrocompatibilidade. Ela presume que parte do nome pontilhado seja um pacote e o restante seja um objeto em algum lugar dentro desse pacote, possivelmente aninhado dentro de outros objetos. Como o ponto onde o pacote termina e a hierarquia de objetos começa não pode ser inferido por inspeção, tentativas repetidas de importação devem ser feitas com esta forma.

Na segunda forma, o chamador deixa claro o ponto de divisão por meio de um caractere de dois pontos: o nome pontilhado à esquerda do caractere de dois pontos representa um pacote a ser importado, e o nome pontilhado à direita representa a hierarquia de objetos dentro desse pacote. Apenas uma importação é necessária nesta forma. Se terminar com caractere de dois pontos, um objeto de módulo será retornado.

A função retornará um objeto (que pode ser um módulo) ou levantará uma das seguintes exceções:

@ref{202,,ValueError} – se `name' não estiver em um formato reconhecido.

@ref{419,,ImportError} – se uma importação falhou quando não deveria.

@ref{34b,,AttributeError} – Se ocorrer uma falha ao percorrer a hierarquia de objetos dentro do pacote importado para chegar ao objeto desejado.


Adicionado na versão 3.9.

@end deffn

@node modulefinder — Procura módulos usados por um script,runpy — Localizando e executando módulos Python,pkgutil — Utilitário de extensão de pacote,Importando módulos
@anchor{library/modulefinder doc}@anchor{4758}@anchor{library/modulefinder module-modulefinder}@anchor{91}@anchor{library/modulefinder modulefinder-find-modules-used-by-a-script}@anchor{4759}@anchor{library/modulefinder translation-repo}@anchor{475a}
@subsection @code{modulefinder} — Procura módulos usados por um script


@geindex module; modulefinder

`Código-fonte:' Lib/modulefinder.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/modulefinder.py}


__________________________________________________________________


Este módulo fornece uma classe @ref{1b7a,,ModuleFinder} que pode ser usada para determinar o conjunto de módulos importados por um script. O @code{modulefinder.py} também pode ser executado como um script, fornecendo o nome do arquivo de um script Python como seu argumento, após o qual um relatório dos módulos importados será impresso.

@geindex AddPackagePath() (no módulo modulefinder)
@anchor{library/modulefinder modulefinder AddPackagePath}@anchor{475b}
@deffn {Função} modulefinder.AddPackagePath (pkg_name, path)

Registra que o pacote chamado `pkg_name' pode ser encontrado no caminho especificado em `path'
@end deffn

@geindex ReplacePackage() (no módulo modulefinder)
@anchor{library/modulefinder modulefinder ReplacePackage}@anchor{475c}
@deffn {Função} modulefinder.ReplacePackage (oldname, newname)

Permite especificar que o módulo chamado `oldname' é de fato o pacote chamado `newname'.
@end deffn

@geindex ModuleFinder (classe em modulefinder)
@anchor{library/modulefinder modulefinder ModuleFinder}@anchor{1b7a}
@deffn {Classe} modulefinder.ModuleFinder (path=None, debug=0, excludes=[], replace_paths=[])

Esta classe fornece os métodos @ref{475d,,run_script()} e @ref{475e,,report()} para determinar o conjunto de módulos importados por um script. `path' pode ser uma lista de diretórios para procurar por módulos; se não especificado, @code{sys.path} é usado. `debug' define o nível de depuração; valores mais altos fazem a classe imprimir mensagens de depuração sobre o que está fazendo. `excludes' é uma lista de nomes de módulos a serem excluídos da análise. `replace_paths' é uma lista de tuplas @code{(oldpath, newpath)} que serão substituídas nos caminhos dos módulos.

@geindex report() (método modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder report}@anchor{475e}
@deffn {Método} report ()

Imprime um relatório na saída padrão que lista os módulos importados pelo script e seus caminhos, bem como os módulos que estão faltando ou parecem estar ausentes.
@end deffn

@geindex run_script() (método modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder run_script}@anchor{475d}
@deffn {Método} run_script (pathname)

Analisa o conteúdo do arquivo `pathname', que deve conter o código Python.
@end deffn

@geindex modules (atributo modulefinder.ModuleFinder)
@anchor{library/modulefinder modulefinder ModuleFinder modules}@anchor{475f}
@deffn {Atributo} modules

Um nome de módulo de mapeamento de dicionário para módulos. Veja @ref{4760,,Exemplo de uso de ModuleFinder}.
@end deffn
@end deffn

@menu
* Exemplo de uso de ModuleFinder:: 

@end menu

@node Exemplo de uso de ModuleFinder,,,modulefinder — Procura módulos usados por um script
@anchor{library/modulefinder example-usage-of-modulefinder}@anchor{4761}@anchor{library/modulefinder modulefinder-example}@anchor{4760}
@subsubsection Exemplo de uso de @code{ModuleFinder}


O script que será analisado posteriormente (bacon.py):

@example
import re, itertools

try:
    import baconhameggs
except ImportError:
    pass

try:
    import guido.python.ham
except ImportError:
    pass
@end example

O script que irá gerar o relatório 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

Exemplo de saída (pode variar dependendo da arquitetura):

@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 — Localizando e executando módulos Python,importlib — A implementação de import,modulefinder — Procura módulos usados por um script,Importando módulos
@anchor{library/runpy doc}@anchor{4762}@anchor{library/runpy module-runpy}@anchor{be}@anchor{library/runpy runpy-locating-and-executing-python-modules}@anchor{4763}@anchor{library/runpy translation-repo}@anchor{4764}
@subsection @code{runpy} — Localizando e executando módulos Python


@geindex module; runpy

`Código-fonte:' Lib/runpy.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/runpy.py}


__________________________________________________________________


O módulo @ref{be,,runpy} é usado para localizar e executar módulos Python sem importá-los primeiro. Seu principal uso é implementar a opção de linha de comando @ref{5e1,,-m} que permite que os scripts sejam localizados usando o espaço de nomes do módulo Python em vez do sistema de arquivos.

Observe que este `não' é um módulo isolado - todo o código é executado no processo atual, e quaisquer efeitos colaterais (como importações em cache de outros módulos) irão permanecer em vigor após o retorno da função.

Além disso, quaisquer funções e classes definidas pelo código executado não têm garantia de funcionar corretamente após o retorno de uma função @ref{be,,runpy}. Se essa limitação não for aceitável para um determinado caso de uso, @ref{77,,importlib} provavelmente será uma escolha mais adequada do que este módulo.

O módulo @ref{be,,runpy} fornece duas funções:

@geindex run_module() (no módulo runpy)
@anchor{library/runpy runpy run_module}@anchor{1922}
@deffn {Função} runpy.run_module (mod_name, init_globals=None, run_name=None, alter_sys=False)

@geindex módulo;__main__

Executa o código do módulo especificado e retorna o dicionário de globals do módulo resultante. O código do módulo é localizado primeiro usando o mecanismo de importação padrão (consulte 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para detalhes) e então executado em um novo espaço de nomes de módulo.

O argumento `mod_name' deve ser um nome de módulo absoluto. Se o nome do módulo se referir a um pacote ao invés de um módulo normal, então esse pacote é importado e o submódulo @ref{1,,__main__} dentro desse pacote é então executado e o dicionário global do módulo resultante retornado.

O argumento opcional de dicionário `init_globals' pode ser usado para preencher previamente o dicionário global do módulo antes do código ser executado. `init_globals' não será modificado. Se qualquer uma das variáveis globais especiais abaixo for definida em `init_globals', estas definições serão substituídas por @ref{1922,,run_module()}.

As variáveis globais especiais @code{__name__}, @code{__spec__}, @code{__file__}, @code{__cached__}, @code{__loader__} e @code{__package__} são definidas no dicionário global antes que o código do módulo seja executado (Observe que este é um conjunto mínimo de variáveis - outras variáveis podem ser definidas implicitamente como um detalhe de implementação do interpretador).

@code{__name__} é definido como `run_name' se este argumento opcional não for @ref{675,,None}, para @code{mod_name + '.__main__'} se o módulo nomeado for um pacote e para o argumento `mod_name' caso contrário .

@code{__spec__} será definido adequadamente para o módulo `efetivamente' importado (isto é, @code{__spec__.name} vai sempre ser `mod_name' ou @code{mod_name + '.__main__'}, nunca `run_name').

@code{__file__}, @code{__cached__}, @code{__loader__} e @code{__package__} são @ref{20a4,,definidos como normal} com base no spec de módulo.

Se o argumento `alter_sys' for fornecido e for avaliado como @ref{c27,,True}, então @code{sys.argv[0]} será atualizado com o valor de @code{__file__} e @code{sys.modules[__name__]} é atualizado com um objeto de módulo temporário para o módulo que está sendo executado. Ambos @code{sys.argv[0]} e @code{sys.modules[__name__]} são restaurados para seus valores originais antes que a função retorne.

Note que esta manipulação de @ref{d9,,sys} não é segura para thread. Outras threads podem ver o módulo parcialmente inicializado, bem como a lista alterada de argumentos. É recomendado que o módulo @code{sys} seja deixado sozinho ao invocar esta função a partir do código encadeado.


@subsubheading Ver também


A opção @ref{5e1,,-m} oferece funcionalidade equivalente na linha de comando.



Alterado na versão 3.1: Adicionada capacidade de executar pacotes procurando por um submódulo @ref{1,,__main__}.



Alterado na versão 3.2: Adicionada a variável global @code{__cached__} (veja 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}).



Alterado na versão 3.4: Atualizado para aproveitar o recurso de spec de módulo adicionado por 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}. Isso permite que @code{__cached__} seja configurado corretamente para módulos executados desta forma, assim como garante que o nome real do módulo esteja sempre acessível como @code{__spec__.name}.



Alterado na versão 3.12: A definição de @code{__cached__}, @code{__loader__} e @code{__package__} foi descontinuada. Veja @ref{1fee,,ModuleSpec} para alternativas.

@end deffn

@geindex run_path() (no módulo runpy)
@anchor{library/runpy runpy run_path}@anchor{181}
@deffn {Função} runpy.run_path (path_name, init_globals=None, run_name=None)

@geindex módulo;__main__

Executa o código no local do sistema de arquivos nomeado e retorna o dicionário de globals do módulo resultante. Assim como um nome de script fornecido à linha de comando CPython, `file_path' pode se referir a um arquivo fonte Python, um arquivo compilado em bytecode ou uma entrada válida de @ref{3b4,,sys.path} contendo um módulo @ref{1,,__main__} (por exemplo, um arquivo zip contendo um arquivo de nível superior @code{__main__.py}).

Para um script simples, o código especificado é simplesmente executado em um novo espaço de nomes de módulo. Para uma entrada válida @ref{3b4,,sys.path} (normalmente um arquivo zip ou diretório), a entrada é primeiro adicionada ao início de @code{sys.path}. A função então procura e executa um módulo @ref{1,,__main__} usando o caminho atualizado. Observe que não há proteção especial contra invocar uma entrada @code{__main__} existente localizada em outro lugar em @code{sys.path} se não houver tal módulo no local especificado.

O argumento opcional de dicionário `init_globals' pode ser usado para preencher previamente o dicionário de globals do módulo antes do código ser executado. `init_globals' não será modificado. Se qualquer uma das variáveis globais especiais abaixo for definida em `init_globals', estas definições serão substituídas por @ref{181,,run_path()}.

As variáveis globais especiais @code{__name__}, @code{__spec__}, @code{__file__}, @code{__cached__}, @code{__loader__} e @code{__package__} são definidas no dicionário global antes que o código do módulo seja executado (Observe que este é um conjunto mínimo de variáveis - outras variáveis podem ser definidas implicitamente como um detalhe de implementação do interpretador).

@code{__name__} é definido como `run_name' se este argumento opcional não for @ref{675,,None} e como @code{'<run_path>'} caso contrário.

Se `file_path' fizer referência diretamente a um arquivo de script (seja como fonte ou como bytecode pré-compilado), então @code{__file__} será definido para `file_path' e @code{__spec__}, @code{__cached__}, @code{__loader__} e @code{__package__} serão todos definidos como @ref{675,,None}.

Se `file_path' for uma referência a uma entrada válida de @ref{3b4,,sys.path}, então @code{__spec__} será definido apropriadamente para o módulo @ref{1,,__main__} importado (ou seja, @code{__spec__.name} sempre será @code{__main__}). @code{__file__}, @code{__cached__}, @code{__loader__} e @code{__package__} serão @ref{20a4,,definidos como normal} com base no spec de módulo.

Várias alterações também são feitas no módulo @ref{d9,,sys}. Primeiramente, @ref{3b4,,sys.path} pode ser alterado conforme descrito acima. @code{sys.argv[0]} é atualizado com o valor de `file_path' e @code{sys.modules[__name__]} é atualizado com um objeto de módulo temporário para o módulo que está sendo executado. Todas as modificações em itens em @ref{d9,,sys} são revertidas antes que a função retorne.

Note que, diferentemente de @ref{1922,,run_module()}, as alterações feitas em @ref{d9,,sys} não são opcionais nesta função, pois esses ajustes são essenciais para permitir a execução das entradas do @ref{3b4,,sys.path}. Como as limitações de segurança de threads ainda se aplicam, o uso dessa função no código encadeado deve ser serializado com a trava de importação ou delegado a um processo separado.


@subsubheading Ver também


@ref{1eb3,,Opções de interface} para funcionalidade equivalente na linha de comando (@code{python path/to/script}).



Adicionado na versão 3.2.



Alterado na versão 3.4: Atualizado para aproveitar o recurso de spec de módulo adicionado por 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}. Isso permite que @code{__cached__} seja definido corretamente no caso em que @code{__main__} é importado de uma entrada @ref{3b4,,sys.path} válida em vez de ser executado diretamente.



Alterado na versão 3.12: A definição de @code{__cached__}, @code{__loader__} e @code{__package__} foi descontinuada.

@end deffn


@subsubheading Ver também



@table @asis

@geindex Propostas de Melhorias do Python; PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} – Executando módulos como scripts

PEP escrita e implementada por Nick Coghlan.

@geindex Propostas de Melhorias do Python; PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/} – Importações relativas explícitas do módulo principal

PEP escrita e implementada por Nick Coghlan.

@geindex Propostas de Melhorias do Python; PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/} – Um tipo ModuleSpec para o sistema de importação

PEP escrita e implementada por Eric Snow
@end table

@ref{1b36,,Linha de comando e ambiente} - Detalhes da linha de comando do CPython

A função @ref{518,,importlib.import_module()}


@node importlib — A implementação de import,importlib resources – Leitura abertura e acesso a recursos de pacotes,runpy — Localizando e executando módulos Python,Importando módulos
@anchor{library/importlib doc}@anchor{4765}@anchor{library/importlib importlib-the-implementation-of-import}@anchor{4766}@anchor{library/importlib module-importlib}@anchor{77}@anchor{library/importlib translation-repo}@anchor{4767}
@subsection @code{importlib} — A implementação de @code{import}


@geindex module; importlib


Adicionado na versão 3.1.


`Código-fonte:' Lib/importlib/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/__init__.py}


__________________________________________________________________


@menu
* Introdução: Introdução<12>. 
* Funções: Funções<12>. 
* importlib.abc – classes base abstratas relacionadas a importação: importlib abc – classes base abstratas relacionadas a importação. 
* importlib.machinery – Importadores e ganchos de caminho: importlib machinery – Importadores e ganchos de caminho. 
* importlib.util – Utility code for importers: importlib util – Utility code for importers. 
* Exemplos: Exemplos<34>. 

@end menu

@node Introdução<12>,Funções<12>,,importlib — A implementação de import
@anchor{library/importlib introduction}@anchor{4768}
@subsubsection Introdução


O pacote @ref{77,,importlib} tem três propósitos.

Uma é fornecer a implementação da instrução @ref{5e2,,import} (e, portanto, por extensão, a função @ref{8da,,__import__()}) no código-fonte Python. Isso fornece uma implementação de @code{import} que é portável para qualquer interpretador Python. Isso também fornece uma implementação que é mais fácil de compreender do que aquela implementada em uma linguagem de programação diferente do Python.

Dois, os componentes para implementar @ref{5e2,,import} são expostos neste pacote, tornando mais fácil para os usuários criarem seus próprios objetos personalizados (conhecidos genericamente como @ref{2184,,importador}) para participar do processo de importação.

Terceiro, o pacote contém módulos que expõem funcionalidades adicionais para gerenciar aspectos de pacotes Python:


@itemize *

@item 
@ref{7a,,importlib.metadata} apresenta acesso a metadados de distribuições de terceiros.

@item 
@ref{7b,,importlib.resources} fornece rotinas para acessar “recursos” não codificados de pacotes Python.
@end itemize


@subsubheading Ver também



@table @asis

@item @ref{5e2,,A instrução import}

A referência da linguagem para a instrução @ref{5e2,,import}.

@item Especificação dos pacotes@footnote{https://www.python.org/doc/essays/packages/}

Especificação original dos pacotes. Algumas semânticas mudaram desde a redação deste documento (por exemplo, redirecionamento baseado em @code{None} em @ref{1636,,sys.modules}).

@item A função @ref{10a6,,__import__()}

A instrução @ref{5e2,,import} é um açúcar sintático para esta função.

@item @ref{1de6,,A inicialização do caminho de pesquisa de módulos sys.path}

A inicialização de @ref{3b4,,sys.path}.

@geindex Propostas de Melhorias do Python; PEP 235

@item PEP 235@footnote{https://peps.python.org/pep-0235/}

Importação em plataformas que diferenciam maiúsculo de minúsculo

@geindex Propostas de Melhorias do Python; PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/}

Definindo codificações do código-fonte do Python

@geindex Propostas de Melhorias do Python; PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/}

Novos ganchos de importação

@geindex Propostas de Melhorias do Python; PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/}

Importações: Multilinha e Absoluto/Relativo

@geindex Propostas de Melhorias do Python; PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/}

Importações relativas explícitas do módulo principal

@geindex Propostas de Melhorias do Python; PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/}

Pacotes de espaço de nomes implícitos

@geindex Propostas de Melhorias do Python; PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/}

Um tipo de ModuleSpec para o sistema de importação

@geindex Propostas de Melhorias do Python; PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/}

Eliminação de arquivos PYO

@geindex Propostas de Melhorias do Python; PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/}

Inicialização de módulo extensão multifase

@geindex Propostas de Melhorias do Python; PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/}

pycs determinísticos

@geindex Propostas de Melhorias do Python; PEP 3120

@item PEP 3120@footnote{https://peps.python.org/pep-3120/}

Usando UTF-8 como fonte padrão de codificação

@geindex Propostas de Melhorias do Python; PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/}

Diretórios de repositório de PYC
@end table


@node Funções<12>,importlib abc – classes base abstratas relacionadas a importação,Introdução<12>,importlib — A implementação de import
@anchor{library/importlib functions}@anchor{4769}
@subsubsection Funções


@geindex __import__() (no módulo importlib)
@anchor{library/importlib importlib __import__}@anchor{10a6}
@deffn {Função} importlib.__import__ (name, globals=None, locals=None, fromlist=(), level=0)

Uma implementação da função embutida @ref{8da,,__import__()}.

@cartouche
@quotation Nota 
A importação programática de módulos deve usar @ref{518,,import_module()} em vez desta função.
@end quotation
@end cartouche
@end deffn

@geindex import_module() (no módulo importlib)
@anchor{library/importlib importlib import_module}@anchor{518}
@deffn {Função} importlib.import_module (name, package=None)

Importa um módulo. O argumento `name' especifica qual módulo importar em termos absolutos ou relativos (por exemplo, @code{pkg.mod} ou @code{..mod}). Se o nome for especificado em termos relativos, então o argumento `package' deve ser definido como o nome do pacote que atuará como âncora para resolver o nome do pacote (por exemplo, @code{import_module('..mod', 'pkg.subpkg')} importará @code{pkg.mod}).

A função @ref{518,,import_module()} atua como um wrapper simplificador em torno de @ref{10a6,,importlib.__import__()}. Isso significa que toda a semântica da função é derivada de @ref{10a6,,importlib.__import__()}. A diferença mais importante entre essas duas funções é que @ref{518,,import_module()} retorna o pacote ou módulo especificado (por exemplo, @code{pkg.mod}), enquanto @ref{8da,,__import__()} retorna o pacote ou módulo de nível superior (por exemplo, @code{pkg}).

Se você estiver importando dinamicamente um módulo que foi criado desde que o interpretador iniciou a execução (por exemplo, criou um arquivo fonte Python), você pode precisar chamar @ref{c2a,,invalidate_caches()} para que o novo módulo seja notado pelo sistema de importação.


Alterado na versão 3.3: Os pacotes pai são importados automaticamente.

@end deffn

@geindex invalidate_caches() (no módulo importlib)
@anchor{library/importlib importlib invalidate_caches}@anchor{c2a}
@deffn {Função} importlib.invalidate_caches ()

Invalida os caches internos dos localizadores armazenados em @ref{d4d,,sys.meta_path}. Se um localizador implementar @code{invalidate_caches()} então ele será chamado para realizar a invalidação. Esta função deve ser chamada se algum módulo for criado/instalado enquanto seu programa estiver em execução para garantir que todos os localizadores notarão a existência do novo módulo.


Adicionado na versão 3.3.



Alterado na versão 3.10: Pacotes de espaço de nomes criados/instalados em um local @ref{3b4,,sys.path} diferente após o mesmo espaço de nomes já ter sido importado são notados.

@end deffn

@geindex reload() (no módulo importlib)
@anchor{library/importlib importlib reload}@anchor{519}
@deffn {Função} importlib.reload (module)

Recarrega um `module' importado anteriormente. O argumento deve ser um objeto módulo, portanto deve ter sido importado com êxito antes. Isso é útil se você editou o arquivo fonte do módulo usando um editor externo e deseja experimentar a nova versão sem sair do interpretador Python. O valor de retorno é o objeto módulo (que pode ser diferente se a reimportação fizer com que um objeto diferente seja colocado em @ref{1636,,sys.modules}).

Quando @ref{519,,reload()} é executado:


@itemize *

@item 
O código do módulo Python é recompilado e o código em nível de módulo é reexecutado, definindo um novo conjunto de objetos que são vinculados a nomes no dicionário do módulo reutilizando o @ref{17a4,,carregador} que originalmente carregou o módulo. A função @code{init} dos módulos de extensão não é chamada uma segunda vez.

@item 
Tal como acontece com todos os outros objetos em Python, os objetos antigos só são recuperados depois que suas contagens de referências caem para zero.

@item 
Os nomes no espaço de nomes do módulo são atualizados para apontar para quaisquer objetos novos ou alterados.

@item 
Outras referências aos objetos antigos (como nomes externos ao módulo) não são religadas para se referir aos novos objetos e devem ser atualizadas em cada espaço de nomes onde ocorrem, se isso for desejado.
@end itemize

Existem várias outras ressalvas:

Quando um módulo é recarregado, seu dicionário (contendo as variáveis globais do módulo) é retido. As redefinições de nomes vão substituir as definições antigas, portanto isso geralmente não é um problema. Se a nova versão de um módulo não definir um nome definido pela versão antiga, a definição antiga permanecerá. Este recurso pode ser usado para vantagem do módulo se ele mantiver uma tabela global ou cache de objetos – com uma instrução @ref{6e9,,try} ele pode testar a presença da tabela e pular sua inicialização se desejar:

@example
try:
    cache
except NameError:
    cache = @{@}
@end example

Geralmente não é muito útil recarregar módulos embutidos ou carregados dinamicamente. Recarregar @ref{d9,,sys}, @ref{1,,__main__}, @ref{12,,builtins} e outros módulos principais não é recomendado. Em muitos casos, os módulos de extensão não são projetados para serem inicializados mais de uma vez e podem falhar de maneiras arbitrárias quando recarregados.

Se um módulo importa objetos de outro módulo usando @ref{12ee,,from} … @ref{5e2,,import} …, chamar @ref{519,,reload()} para o outro módulo não redefine os objetos importados dele – uma maneira de contornar isso é executar novamente a instrução @code{from}, outra é usar @code{import} e nomes qualificados (`module.name').

Se um módulo instancia instâncias de uma classe, recarregar o módulo que define a classe não afeta as definições de método das instâncias – elas continuam a usar a definição de classe antiga. O mesmo se aplica às classes derivadas.


Adicionado na versão 3.4.



Alterado na versão 3.7: @ref{b5b,,ModuleNotFoundError} é levantada quando o módulo que está sendo recarregado não possui um @ref{1fee,,ModuleSpec}.


@cartouche
@quotation Aviso 
This function is not thread-safe. Calling it from multiple threads can result
in unexpected behavior. It’s recommended to use the @ref{176d,,threading.Lock}
or other synchronization primitives for thread-safe module reloading.
@end quotation
@end cartouche
@end deffn

@node importlib abc – classes base abstratas relacionadas a importação,importlib machinery – Importadores e ganchos de caminho,Funções<12>,importlib — A implementação de import
@anchor{library/importlib importlib-abc-abstract-base-classes-related-to-import}@anchor{476a}@anchor{library/importlib module-importlib abc}@anchor{78}
@subsubsection @code{importlib.abc} – classes base abstratas relacionadas a importação


@geindex module; importlib.abc

`Código-fonte:' Lib/importlib/abc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/abc.py}


__________________________________________________________________


O módulo @ref{78,,importlib.abc} contém todas as principais classes base abstratas usadas por @ref{5e2,,import}. Algumas subclasses das classes base abstratas principais também são fornecidas para ajudar na implementação dss ABCs principais.

Hierarquia de ABC:

@example
object
 +-- MetaPathFinder
 +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader
@end example

@geindex MetaPathFinder (classe em importlib.abc)
@anchor{library/importlib importlib abc MetaPathFinder}@anchor{872}
@deffn {Classe} importlib.abc.MetaPathFinder

Uma classe base abstrata que representa um @ref{10a9,,localizador de metacaminho}.


Adicionado na versão 3.3.



Alterado na versão 3.10: Não é mais uma subclasse de @code{Finder}.


@geindex find_spec() (método importlib.abc.MetaPathFinder)
@anchor{library/importlib importlib abc MetaPathFinder find_spec}@anchor{86c}
@deffn {Método} find_spec (fullname, path, target=None)

Um método abstrato para encontrar um @ref{20a6,,spec} para o módulo especificado. Se esta for uma importação de nível superior, `path' será @code{None}. Caso contrário, esta é uma busca por um subpacote ou módulo e `path' será o valor de @ref{1df4,,__path__} do pacote pai. Se um spec não puder ser encontrado, @code{None} será retornado. Quando passado, @code{target} é um objeto de módulo que o localizador pode usar para fazer uma estimativa mais informada sobre qual spec retornar. @ref{871,,importlib.util.spec_from_loader()} pode ser útil para implementar @code{MetaPathFinders} concretos.


Adicionado na versão 3.4.

@end deffn

@geindex invalidate_caches() (método importlib.abc.MetaPathFinder)
@anchor{library/importlib importlib abc MetaPathFinder invalidate_caches}@anchor{476b}
@deffn {Método} invalidate_caches ()

Um método opcional que, quando chamado, deve invalidar qualquer cache interno usado pelo localizador. Usado por @ref{c2a,,importlib.invalidate_caches()} ao invalidar os caches de todos os localizadores em @ref{d4d,,sys.meta_path}.


Alterado na versão 3.4: Retorna @code{None} quando chamado em vez de @ref{7d3,,NotImplemented}.

@end deffn
@end deffn

@geindex PathEntryFinder (classe em importlib.abc)
@anchor{library/importlib importlib abc PathEntryFinder}@anchor{873}
@deffn {Classe} importlib.abc.PathEntryFinder

Uma classe base abstrata que representa um @ref{10aa,,localizador de entrada de caminho}. Embora tenha algumas semelhanças com @ref{872,,MetaPathFinder}, @code{PathEntryFinder} deve ser usado apenas dentro do subsistema de importação baseado em caminho fornecido por @ref{1059,,importlib.machinery.PathFinder}.


Adicionado na versão 3.3.



Alterado na versão 3.10: Não é mais uma subclasse de @code{Finder}.


@geindex find_spec() (método importlib.abc.PathEntryFinder)
@anchor{library/importlib importlib abc PathEntryFinder find_spec}@anchor{870}
@deffn {Método} find_spec (fullname, target=None)

Um método abstrato para encontrar um @ref{20a6,,spec} para o módulo especificado. O localizador irá procurar pelo módulo apenas dentro do @ref{2193,,entrada de caminho} ao qual ele está atribuído. Se um spec não puder ser encontrado, @code{None} será retornado. Quando passado, @code{target} é um objeto de módulo que o localizador pode usar para fazer uma estimativa mais informada sobre qual spec retornar. @ref{871,,importlib.util.spec_from_loader()} pode ser útil para implementar @code{PathEntryFinders} concretos.


Adicionado na versão 3.4.

@end deffn

@geindex invalidate_caches() (método importlib.abc.PathEntryFinder)
@anchor{library/importlib importlib abc PathEntryFinder invalidate_caches}@anchor{476c}
@deffn {Método} invalidate_caches ()

Um método opcional que, quando chamado, deve invalidar qualquer cache interno usado pelo localizador. Usado por @ref{c29,,importlib.machinery.PathFinder.invalidate_caches()} ao invalidar os caches de todos os localizadores em cache.
@end deffn
@end deffn

@geindex Loader (classe em importlib.abc)
@anchor{library/importlib importlib abc Loader}@anchor{ef6}
@deffn {Classe} importlib.abc.Loader

Uma classe base abstrata para um @ref{17a4,,carregador}. Veja 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para a definição exata de um carregador.

Carregadores que desejam oferecer suporte a leitura de recursos devem implementar um método @code{get_resource_reader()} conforme especificado por @ref{476d,,importlib.resources.abc.ResourceReader}.


Alterado na versão 3.7: Introduzido o método opcional @code{get_resource_reader()}.


@geindex create_module() (método importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader create_module}@anchor{cce}
@deffn {Método} create_module (spec)

Um método que retorna o objeto do módulo a ser usado ao importar um módulo. Este método pode retornar @code{None}, indicando que a semântica padrão de criação do módulo deve ocorrer.


Adicionado na versão 3.4.



Alterado na versão 3.6: Este método não é mais opcional quando @ref{86e,,exec_module()} é definido.

@end deffn

@geindex exec_module() (método importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader exec_module}@anchor{86e}
@deffn {Método} exec_module (module)

Um método abstrato que executa o módulo em seu próprio espaço de nomes quando um módulo é importado ou recarregado. O módulo já deve estar inicializado quando @ref{86e,,exec_module()} for chamado. Quando este método existir, @ref{cce,,create_module()} deve ser definido.


Adicionado na versão 3.4.



Alterado na versão 3.6: @ref{cce,,create_module()} deve ser definido.

@end deffn

@geindex load_module() (método importlib.abc.Loader)
@anchor{library/importlib importlib abc Loader load_module}@anchor{86d}
@deffn {Método} load_module (fullname)

Um método legado para carregar um módulo. Se o módulo não puder ser carregado, @ref{419,,ImportError} será levantada, caso contrário, o módulo carregado será retornado.

Se o módulo solicitado já existir em @ref{1636,,sys.modules}, esse módulo deverá ser usado e recarregado. Caso contrário, o carregador deve criar um novo módulo e inseri-lo em @ref{1636,,sys.modules} antes de qualquer carregamento começar, para evitar a recursão da importação. Se o carregador inseriu um módulo e o carregamento falhar, ele deverá ser removido pelo carregador de @ref{1636,,sys.modules}; módulos já em @ref{1636,,sys.modules} antes do carregador iniciar a execução devem ser deixados sozinhos.

O carregador deve definir vários atributos no módulo (observe que alguns desses atributos podem mudar quando um módulo é recarregado):


@itemize -

@item 
@ref{13d2,,module.__name__}

@item 
@ref{20ad,,module.__file__}

@item 
@ref{2d5,,module.__cached__} `(descontinuado)'

@item 
@ref{1df4,,module.__path__}

@item 
@ref{2d7,,module.__package__} `(descontinuado)'

@item 
@ref{2e2,,module.__loader__} `(descontinuado)'
@end itemize

Quando @ref{86e,,exec_module()} está disponível, então a funcionalidade compatível com versões anteriores é fornecida.


Alterado na versão 3.4: Levanta @ref{419,,ImportError} quando chamado em vez de @ref{228,,NotImplementedError}. Funcionalidade fornecida quando @ref{86e,,exec_module()} está disponível.



Descontinuado desde a versão 3.4, será removido na versão 3.15: A API recomendada para carregar um módulo é @ref{86e,,exec_module()} (e @ref{cce,,create_module()}). Os carregadores devem implementá-lo em vez de @ref{86d,,load_module()}. O mecanismo de importação cuida de todas as outras responsabilidades de @ref{86d,,load_module()} quando @ref{86e,,exec_module()} é implementado.

@end deffn
@end deffn

@geindex ResourceLoader (classe em importlib.abc)
@anchor{library/importlib importlib abc ResourceLoader}@anchor{c02}
@deffn {Classe} importlib.abc.ResourceLoader

`Substituída por TraversableResources'

@quotation

Uma classe base abstrata para um @ref{17a4,,carregador} que implementa o protocolo opcional 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para carregar recursos arbitrários do back-end de armazenamento.


Descontinuado desde a versão 3.7: Este ABC foi descontinuado em favor do suporte ao carregamento de recursos por meio de @ref{2c5,,importlib.resources.abc.TraversableResources}.


@geindex get_data() (método importlib.abc.ResourceLoader)
@anchor{library/importlib importlib abc ResourceLoader get_data}@anchor{4756}
@deffn {Método} abstractmethod get_data (path)

@quotation

Um método abstrato para retornar os bytes dos dados localizados em `path'. Carregadores que possuem um backend de armazenamento arquivo ou similar que permite o armazenamento de dados arbitrários podem implementar esse método abstrato para fornecer acesso direto aos dados armazenados. @ref{417,,OSError} deve ser levantada se o `path' não puder ser encontrado. Espera-se que o `path' seja construído usando o atributo @ref{20ad,,__file__} de um módulo ou um item de @ref{1df4,,__path__} de um pacote.


Alterado na versão 3.4: Levanta @ref{417,,OSError} em vez de @ref{228,,NotImplementedError}.

@end quotation
@end deffn
@end quotation
@end deffn

@geindex InspectLoader (classe em importlib.abc)
@anchor{library/importlib importlib abc InspectLoader}@anchor{f88}
@deffn {Classe} importlib.abc.InspectLoader

Uma classe base abstrata para um @ref{17a4,,carregador} que implementa o protocolo opcional da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} para carregadores que inspecionam módulos.

@geindex get_code() (método importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader get_code}@anchor{f89}
@deffn {Método} get_code (fullname)

Retorna o objeto de código para um módulo, ou @code{None} se o módulo não tiver um objeto código (como seria o caso, por exemplo, para um módulo embutido). Levanta um @ref{419,,ImportError} se o carregador não conseguir encontrar o módulo solicitado.

@cartouche
@quotation Nota 
Embora o método tenha uma implementação padrão, sugere-se que ele seja substituído, se possível, para desempenho.
@end quotation
@end cartouche

@geindex novas linhas universais;Método importlib.abc.InspectLoader.get_source


Alterado na versão 3.4: Não é mais abstrato e uma implementação concreta é fornecida.

@end deffn

@geindex get_source() (método importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader get_source}@anchor{f8c}
@deffn {Método} abstractmethod get_source (fullname)

@quotation

Um método abstrato para retornar a fonte de um módulo. Ele é retornado como uma string de texto usando @ref{d5c,,novas linhas universais}, traduzindo todos os separadores de linha reconhecidos em caracteres @code{'\n'}. Retorna @code{None} se nenhuma fonte estiver disponível (por exemplo, um módulo embutido). Levanta @ref{419,,ImportError} se o carregador não puder encontrar o módulo especificado.


Alterado na versão 3.4: Levanta @ref{419,,ImportError} em vez de @ref{228,,NotImplementedError}.

@end quotation
@end deffn

@geindex is_package() (método importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader is_package}@anchor{476e}
@deffn {Método} is_package (fullname)

Um método opcional para retornar um valor verdadeiro se o módulo for um pacote, um valor falso caso contrário. @ref{419,,ImportError} é levantada se o @ref{17a4,,carregador} não puder encontrar o módulo.


Alterado na versão 3.4: Levanta @ref{419,,ImportError} em vez de @ref{228,,NotImplementedError}.

@end deffn

@geindex source_to_code() (método estático importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader source_to_code}@anchor{e3d}
@deffn {Método} static source_to_code (data, path='<string>')

Cria um objeto código a partir de código-fonte Python

O argumento `data' pode ser qualquer coisa a qual a função @ref{192,,compile()} tenha suporte (por exemplo, string ou bytes). O argumento `path' deve ser o “caminho” de onde o código-fonte se originou, o que pode ser um conceito abstrato (por exemplo, local em um arquivo zip).

Com o objeto de código subsequente, é possível executá-lo em um módulo executando @code{exec(code, module.__dict__)}.


Adicionado na versão 3.4.



Alterado na versão 3.5: O método foi tornado estático.

@end deffn

@geindex exec_module() (método importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader exec_module}@anchor{1048}
@deffn {Método} exec_module (module)

Implementação de @ref{86e,,Loader.exec_module()}.


Adicionado na versão 3.4.

@end deffn

@geindex load_module() (método importlib.abc.InspectLoader)
@anchor{library/importlib importlib abc InspectLoader load_module}@anchor{476f}
@deffn {Método} load_module (fullname)

Implementação de @ref{86d,,Loader.load_module()}.


Descontinuado desde a versão 3.4, será removido na versão 3.15: use @ref{1048,,exec_module()}.

@end deffn
@end deffn

@geindex ExecutionLoader (classe em importlib.abc)
@anchor{library/importlib importlib abc ExecutionLoader}@anchor{4770}
@deffn {Classe} importlib.abc.ExecutionLoader

Uma classe base abstrata que herda de @ref{f88,,InspectLoader} que, quando implementada, ajuda um módulo a ser executado como um script. A ABC representa um protocolo opcional da 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}.

@geindex get_filename() (método importlib.abc.ExecutionLoader)
@anchor{library/importlib importlib abc ExecutionLoader get_filename}@anchor{4771}
@deffn {Método} abstractmethod get_filename (fullname)

@quotation

Um método abstrato que deve retornar o valor de @ref{20ad,,__file__} para o módulo especificado. Se nenhum caminho estiver disponível, @ref{419,,ImportError} é levantada.

Se o código-fonte estiver disponível, o método deverá retornar o caminho para o arquivo fonte, independentemente de um bytecode ter sido usado para carregar o módulo.


Alterado na versão 3.4: Levanta @ref{419,,ImportError} em vez de @ref{228,,NotImplementedError}.

@end quotation
@end deffn
@end deffn

@geindex FileLoader (classe em importlib.abc)
@anchor{library/importlib importlib abc FileLoader}@anchor{10ac}
@deffn {Classe} importlib.abc.FileLoader (fullname, path)

Uma classe base abstrata que herda de @ref{c02,,ResourceLoader} e @ref{4770,,ExecutionLoader}, fornecendo implementações concretas de @ref{4756,,ResourceLoader.get_data()} e @ref{4771,,ExecutionLoader.get_filename()}.

O argumento `fullname' é um nome totalmente resolvido do módulo que o carregador deve manipular. O argumento `path' é o caminho para o arquivo do módulo.


Adicionado na versão 3.3.


@geindex name (atributo importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader name}@anchor{4772}
@deffn {Atributo} name

O nome do módulo que o carregador pode manipular.
@end deffn

@geindex path (atributo importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader path}@anchor{4773}
@deffn {Atributo} path

Caminho para o arquivo do módulo
@end deffn

@geindex load_module() (método importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader load_module}@anchor{4774}
@deffn {Método} load_module (fullname)

Chama @code{load_module()} do super.


Descontinuado desde a versão 3.4, será removido na versão 3.15: Use @ref{86e,,Loader.exec_module()}

@end deffn

@geindex get_filename() (método importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader get_filename}@anchor{4775}
@deffn {Método} abstractmethod get_filename (fullname)

Retorna @ref{4773,,path}.
@end deffn

@geindex get_data() (método importlib.abc.FileLoader)
@anchor{library/importlib importlib abc FileLoader get_data}@anchor{4776}
@deffn {Método} abstractmethod get_data (path)

Lê `caminho' como um arquivo binário e retorna os bytes dele.
@end deffn
@end deffn

@geindex SourceLoader (classe em importlib.abc)
@anchor{library/importlib importlib abc SourceLoader}@anchor{4777}
@deffn {Classe} importlib.abc.SourceLoader

Uma classe base abstrata para implementar o carregamento de arquivo fonte (e opcionalmente bytecode). A classe herda de @ref{c02,,ResourceLoader} e @ref{4770,,ExecutionLoader}, exigindo a implementação de:


@itemize *

@item 
@ref{4756,,ResourceLoader.get_data()}

@item 

@table @asis

@item @ref{4771,,ExecutionLoader.get_filename()}

Deve retornar apenas o caminho para o arquivo fonte; o carregamento sem fonte não é suportado.
@end table
@end itemize

Os métodos abstratos definidos por esta classe são para adicionar suporte opcional ao arquivo bytecode. Não implementar esses métodos opcionais (ou fazer com que eles levantem @ref{228,,NotImplementedError}) faz com que o carregador funcione apenas com código-fonte. Implementar os métodos permite que o carregador funcione com arquivos de código-fonte `e' bytecode; ele não permite carregamento `sem fonte' onde apenas o bytecode é fornecido. Arquivos de bytecode são uma otimização para acelerar o carregamento removendo a etapa de análise do compilador do Python e, portanto, nenhuma API específica de bytecode é exposta.

@geindex path_stats() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader path_stats}@anchor{11c9}
@deffn {Método} path_stats (path)

Método abstrato opcional que retorna um @ref{256,,dict} contendo metadados sobre o caminho especificado. As chaves de dicionário suportadas são:


@itemize -

@item 
@code{'mtime'} (obrigatório): um número inteiro ou de ponto flutuante que representa o tempo de modificação do código-fonte;

@item 
@code{'size'} (opcional): o tamanho em bytes do código-fonte.
@end itemize

Quaisquer outras chaves no dicionário são ignoradas, para permitir extensões futuras. Se o caminho não puder ser manipulado, @ref{417,,OSError} é levantada.


Adicionado na versão 3.3.



Alterado na versão 3.4: Levanta @ref{417,,OSError} em vez de @ref{228,,NotImplementedError}.

@end deffn

@geindex path_mtime() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader path_mtime}@anchor{11c8}
@deffn {Método} path_mtime (path)

Método abstrato opcional que retorna o horário de modificação do caminho especificado.


Descontinuado desde a versão 3.3: Este método foi descontinuado em favor de @ref{11c9,,path_stats()}. Você não precisa implementá-lo, mas ele ainda está disponível para fins de compatibilidade. Levanta @ref{417,,OSError} se o caminho não puder ser manipulado.



Alterado na versão 3.4: Levanta @ref{417,,OSError} em vez de @ref{228,,NotImplementedError}.

@end deffn

@geindex set_data() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader set_data}@anchor{4778}
@deffn {Método} set_data (path, data)

Método abstrato opcional que grava os bytes especificados em um caminho de arquivo. Quaisquer diretórios intermediários que não existam devem ser criados automaticamente.

Quando a gravação no caminho falhar porque o caminho é somente leitura (@ref{2444,,errno.EACCES}/@ref{d65,,PermissionError}), não propaga a exceção.


Alterado na versão 3.4: Não mais levanta @ref{228,,NotImplementedError} quando chamado.

@end deffn

@geindex get_code() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader get_code}@anchor{4779}
@deffn {Método} get_code (fullname)

Implementação concreta de @ref{f89,,InspectLoader.get_code()}.
@end deffn

@geindex exec_module() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader exec_module}@anchor{1049}
@deffn {Método} exec_module (module)

Implementação concreta de @ref{86e,,Loader.exec_module()}.


Adicionado na versão 3.4.

@end deffn

@geindex load_module() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader load_module}@anchor{477a}
@deffn {Método} load_module (fullname)

Implementação concreta de @ref{86d,,Loader.load_module()}.


Descontinuado desde a versão 3.4, será removido na versão 3.15: Use @ref{1049,,exec_module()}.

@end deffn

@geindex get_source() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader get_source}@anchor{1057}
@deffn {Método} get_source (fullname)

Implementação concreta de @ref{f8c,,InspectLoader.get_source()}.
@end deffn

@geindex is_package() (método importlib.abc.SourceLoader)
@anchor{library/importlib importlib abc SourceLoader is_package}@anchor{477b}
@deffn {Método} is_package (fullname)

Implementação concreta de @ref{476e,,InspectLoader.is_package()}. Um módulo é determinado como um pacote se seu caminho de arquivo (conforme fornecido por @ref{4771,,ExecutionLoader.get_filename()}) for um arquivo chamado @code{__init__} quando a extensão do arquivo for removida `e' o nome do módulo em si não terminar em @code{__init__}.
@end deffn
@end deffn

@geindex ResourceReader (classe em importlib.abc)
@anchor{library/importlib importlib abc ResourceReader}@anchor{b10}
@deffn {Classe} importlib.abc.ResourceReader

`Substituída por TraversableResources'

Uma @ref{11f5,,classe base abstrata} para fornecer a capacidade de ler `recursos'.

Da perspectiva deste ABC, um `recurso' é um artefato binário que é enviado dentro de um pacote. Normalmente isso é algo como um arquivo de dados que fica próximo ao arquivo @code{__init__.py} do pacote. O objetivo desta classe é ajudar a abstrair o acesso a tais arquivos de dados para que não importe se o pacote e seu(s) arquivo(s) de dados estão armazenados, por exemplo, em um arquivo zip versus no sistema de arquivos.

Para qualquer um dos métodos desta classe, espera-se que o argumento `resource' seja um @ref{2a0,,objeto caminho ou similar} que representa conceitualmente apenas um nome de arquivo. Isso significa que nenhum caminho de subdiretório deve ser incluído no argumento `resource'. Isso ocorre porque a localização do pacote para o qual o leitor se destina, atua como o “diretório”. Portanto, a metáfora para diretórios e nomes de arquivos são pacotes e recursos, respectivamente. É também por isso que se espera que as instâncias dessa classe se correlacionem diretamente a um pacote específico (em vez de representar potencialmente vários pacotes ou um módulo).

Carregadores que desejam oferecer suporte à leitura de recursos devem fornecer um método chamado @code{get_resource_reader(nomecompleto)} que retorna um objeto implementando esta interface ABC. Se o módulo especificado por nomecompleto não for um pacote, este método deve retornar @ref{675,,None}. Um objeto compatível com este ABC só deve ser retornado quando o módulo especificado for um pacote.


Adicionado na versão 3.7.



Descontinuado desde a versão 3.12, será removido na versão 3.14: Use @ref{2c5,,importlib.resources.abc.TraversableResources}.


@geindex open_resource() (método importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader open_resource}@anchor{477c}
@deffn {Método} abstractmethod open_resource (resource)

@quotation

Retorna um @ref{15cf,,objeto arquivo ou similar} aberto para leitura binária de `resource'.

Se o recurso não puder ser encontrado, @ref{42b,,FileNotFoundError} é levantada.
@end quotation
@end deffn

@geindex resource_path() (método importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader resource_path}@anchor{477d}
@deffn {Método} abstractmethod resource_path (resource)

@quotation

Retorna o caminho do sistema de arquivos para `resource'.

Se o recurso não existir concretamente no sistema de arquivos, levanta @ref{42b,,FileNotFoundError}.
@end quotation
@end deffn

@geindex is_resource() (método importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader is_resource}@anchor{477e}
@deffn {Método} abstractmethod is_resource (name)

@quotation

Retorna @code{True} se o `name' nomeado for considerado um recurso. @ref{42b,,FileNotFoundError} é levantada se `name' não existir.
@end quotation
@end deffn

@geindex contents() (método importlib.abc.ResourceReader)
@anchor{library/importlib importlib abc ResourceReader contents}@anchor{1bbc}
@deffn {Método} abstractmethod contents ()

@quotation

Retorna um @ref{1268,,iterável} de strings sobre o conteúdo do pacote. Observe que não é necessário que todos os nomes retornados pelo iterador sejam recursos reais, por exemplo, é aceitável retornar nomes para os quais @ref{477e,,is_resource()} seria falso.

Permitir que nomes que não são recursos sejam retornados é permitir situações em que a forma como um pacote e seus recursos são armazenados é conhecida a priori e os nomes que não são recursos seriam úteis. Por exemplo, o retorno de nomes de subdiretórios é permitido para que, quando se souber que o pacote e os recursos estão armazenados no sistema de arquivos, esses nomes de subdiretórios possam ser usados diretamente.

O método abstrato retorna um iterável sem itens.
@end quotation
@end deffn
@end deffn

@geindex Traversable (classe em importlib.abc)
@anchor{library/importlib importlib abc Traversable}@anchor{19b2}
@deffn {Classe} importlib.abc.Traversable

Um objeto com um subconjunto de métodos de @ref{229,,pathlib.Path} adequados para percorrer diretórios e abrir arquivos.

Para uma representação do objeto no sistema de arquivos, use @ref{48d,,importlib.resources.as_file()}.


Adicionado na versão 3.9.



Descontinuado desde a versão 3.12, será removido na versão 3.14: Use @ref{1f3,,importlib.resources.abc.Traversable}.


@geindex name (atributo importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable name}@anchor{477f}
@deffn {Atributo} name

Abstrato. O nome base deste objeto sem nenhuma referência pai.
@end deffn

@geindex iterdir() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable iterdir}@anchor{4780}
@deffn {Método} abstractmethod iterdir ()

Produz objetos @code{Traversable} em @code{self}.
@end deffn

@geindex is_dir() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable is_dir}@anchor{4781}
@deffn {Método} abstractmethod is_dir ()

Retorna @code{True} se @code{self} for um diretório.
@end deffn

@geindex is_file() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable is_file}@anchor{4782}
@deffn {Método} abstractmethod is_file ()

Retorna @code{True} se @code{self} for um arquivo.
@end deffn

@geindex joinpath() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable joinpath}@anchor{4783}
@deffn {Método} abstractmethod joinpath (child)

Retorna o filho Traversable em @code{self}.
@end deffn

@geindex __truediv__() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable __truediv__}@anchor{4784}
@deffn {Método} abstractmethod __truediv__ (child)

Retorna o filho @code{Traversable} em @code{self}.
@end deffn

@geindex open() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable open}@anchor{4785}
@deffn {Método} abstractmethod open (mode='r', *args, **kwargs)

`mode' pode ser ‘r’ ou ‘rb’ para abrir como texto ou binário. Retorna um manipulador adequado para leitura (o mesmo que @ref{2976,,pathlib.Path.open}).

Ao abrir como texto, aceita parâmetros de codificação como os aceitos por @ref{7bc,,io.TextIOWrapper}.
@end deffn

@geindex read_bytes() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable read_bytes}@anchor{4786}
@deffn {Método} read_bytes ()

Lê o conteúdo de @code{self} como bytes.
@end deffn

@geindex read_text() (método importlib.abc.Traversable)
@anchor{library/importlib importlib abc Traversable read_text}@anchor{4787}
@deffn {Método} read_text (encoding=None)

Lê o conteúdo de @code{self} como texto.
@end deffn
@end deffn

@geindex TraversableResources (classe em importlib.abc)
@anchor{library/importlib importlib abc TraversableResources}@anchor{19b0}
@deffn {Classe} importlib.abc.TraversableResources

Uma classe base abstrata para leitores de recursos capaz de servir a interface @ref{48e,,importlib.resources.files()}. Subclasse @ref{476d,,importlib.resources.abc.ResourceReader} e fornece implementações concretas dos métodos abstratos de @ref{476d,,importlib.resources.abc.ResourceReader}. Portanto, qualquer carregador que forneça @ref{19b0,,importlib.abc.TraversableResources} também fornece ResourceReader.

Espera-se que os carregadores que desejam oferecer suporte à leitura de recursos implementem essa interface.


Adicionado na versão 3.9.



Descontinuado desde a versão 3.12, será removido na versão 3.14: Use @ref{2c5,,importlib.resources.abc.TraversableResources}.


@geindex files() (método importlib.abc.TraversableResources)
@anchor{library/importlib importlib abc TraversableResources files}@anchor{4788}
@deffn {Método} abstractmethod files ()

Retorna um objeto @ref{1f3,,importlib.resources.abc.Traversable} para o pacote carregado.
@end deffn
@end deffn

@node importlib machinery – Importadores e ganchos de caminho,importlib util – Utility code for importers,importlib abc – classes base abstratas relacionadas a importação,importlib — A implementação de import
@anchor{library/importlib importlib-machinery-importers-and-path-hooks}@anchor{4789}@anchor{library/importlib module-importlib machinery}@anchor{79}
@subsubsection @code{importlib.machinery} – Importadores e ganchos de caminho


@geindex module; importlib.machinery

`Código-fonte:' Lib/importlib/machinery.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/machinery.py}


__________________________________________________________________


Este módulo contém vários objetos que ajudam o @ref{5e2,,import} a localizar e carregar módulos.

@geindex SOURCE_SUFFIXES (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery SOURCE_SUFFIXES}@anchor{514}
@deffn {Dado} importlib.machinery.SOURCE_SUFFIXES

Uma lista de strings representando os sufixos de arquivo reconhecidos para módulos em código-fonte.


Adicionado na versão 3.3.

@end deffn

@geindex DEBUG_BYTECODE_SUFFIXES (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery DEBUG_BYTECODE_SUFFIXES}@anchor{478a}
@deffn {Dado} importlib.machinery.DEBUG_BYTECODE_SUFFIXES

Uma lista de strings representando os sufixos de arquivo para módulos em bytecode não otimizado.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.5: Use @ref{516,,BYTECODE_SUFFIXES} instead.

@end deffn

@geindex OPTIMIZED_BYTECODE_SUFFIXES (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery OPTIMIZED_BYTECODE_SUFFIXES}@anchor{478b}
@deffn {Dado} importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

Uma lista de strings representando os sufixos de arquivo para módulos em bytecode otimizado.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.5: Use @ref{516,,BYTECODE_SUFFIXES} instead.

@end deffn

@geindex BYTECODE_SUFFIXES (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery BYTECODE_SUFFIXES}@anchor{516}
@deffn {Dado} importlib.machinery.BYTECODE_SUFFIXES

Uma lista de strings representando os sufixos de arquivo reconhecidos para módulos em bytecode (incluindo com ponto no início).


Adicionado na versão 3.3.



Alterado na versão 3.5: O valor não mais depende de @code{__debug__}.

@end deffn

@geindex EXTENSION_SUFFIXES (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery EXTENSION_SUFFIXES}@anchor{515}
@deffn {Dado} importlib.machinery.EXTENSION_SUFFIXES

Uma lista de strings representando os sufixos de arquivo reconhecidos para módulos de extensão.


Adicionado na versão 3.3.

@end deffn

@geindex all_suffixes() (no módulo importlib.machinery)
@anchor{library/importlib importlib machinery all_suffixes}@anchor{46c1}
@deffn {Função} importlib.machinery.all_suffixes ()

Retorna uma lista combinada de strings representando todos os sufixos de arquivo para módulos reconhecidos pelo maquinário de importação padrão. Este é um auxiliar para código que simplesmente precisa saber se um caminho de sistema de arquivos potencialmente se refere a um módulo sem precisar de detalhes sobre o tipo de módulo (por exemplo, @ref{d5b,,inspect.getmodulename()}).


Adicionado na versão 3.3.

@end deffn

@geindex BuiltinImporter (classe em importlib.machinery)
@anchor{library/importlib importlib machinery BuiltinImporter}@anchor{ccf}
@deffn {Classe} importlib.machinery.BuiltinImporter

Um @ref{2184,,importador} para módulos embutidos. Todos os módulos embutidos conhecidos estão listados em @ref{1de5,,sys.builtin_module_names}. Esta classe implementa os ABCs @ref{872,,importlib.abc.MetaPathFinder} e @ref{f88,,importlib.abc.InspectLoader}.

Somente métodos de classe são definidos por esta classe para aliviar a necessidade de instanciação.


Alterado na versão 3.5: Como parte da 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}, o importador embutido agora implementa @code{Loader.create_module()} e @code{Loader.exec_module()}

@end deffn

@geindex FrozenImporter (classe em importlib.machinery)
@anchor{library/importlib importlib machinery FrozenImporter}@anchor{1055}
@deffn {Classe} importlib.machinery.FrozenImporter

Um @ref{2184,,importador} para módulos congelados. Esta classe implementa os ABCs @ref{872,,importlib.abc.MetaPathFinder} e @ref{f88,,importlib.abc.InspectLoader}.

Somente métodos de classe são definidos por esta classe para aliviar a necessidade de instanciação.


Alterado na versão 3.4: Ganhou os métodos @code{create_module()} e @code{exec_module()}.

@end deffn

@geindex WindowsRegistryFinder (classe em importlib.machinery)
@anchor{library/importlib importlib machinery WindowsRegistryFinder}@anchor{d4c}
@deffn {Classe} importlib.machinery.WindowsRegistryFinder

@ref{20ae,,Localizador} para módulos declarados no registro do Windows. Esta classe implementa a ABC @ref{872,,importlib.abc.MetaPathFinder}.

Somente métodos de classe são definidos por esta classe para aliviar a necessidade de instanciação.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.6: Use a configuração de @ref{c7,,site} em vez disso. Versões futuras do Python podem não habilitar esse localizador por padrão.

@end deffn

@geindex PathFinder (classe em importlib.machinery)
@anchor{library/importlib importlib machinery PathFinder}@anchor{1059}
@deffn {Classe} importlib.machinery.PathFinder

Um @ref{20ae,,Localizador} para atributos @ref{3b4,,sys.path} e pacote @code{__path__}. Esta classe implementa a ABC @ref{872,,importlib.abc.MetaPathFinder}.

Somente métodos de classe são definidos por esta classe para aliviar a necessidade de instanciação.

@geindex find_spec() (método de classe importlib.machinery.PathFinder)
@anchor{library/importlib importlib machinery PathFinder find_spec}@anchor{1047}
@deffn {Método} classmethod find_spec (fullname, path=None, target=None)

Método de classe que tenta encontrar um @ref{20a6,,spec} para o módulo especificado por `fullname' em @ref{3b4,,sys.path} ou, se definido, em `path'. Para cada entrada de caminho pesquisada, @ref{5e4,,sys.path_importer_cache} é verificado. Se um objeto não falso for encontrado, ele será usado como o @ref{10aa,,localizador de entrada de caminho} para procurar o módulo que está sendo pesquisado. Se nenhuma entrada for encontrada em @ref{5e4,,sys.path_importer_cache}, então @ref{105a,,sys.path_hooks} será pesquisado para um localizador para a entrada de caminho e, se encontrado, será armazenado em @ref{5e4,,sys.path_importer_cache} junto com a consulta sobre o módulo. Se nenhum localizador for encontrado, então @code{None} será armazenado no cache e retornado.


Adicionado na versão 3.4.



Alterado na versão 3.5: Se o diretório de trabalho atual — representado por uma string vazia — não for mais válido, @code{None} será retornado, mas nenhum valor será armazenado em cache em @ref{5e4,,sys.path_importer_cache}.

@end deffn

@geindex invalidate_caches() (método de classe importlib.machinery.PathFinder)
@anchor{library/importlib importlib machinery PathFinder invalidate_caches}@anchor{c29}
@deffn {Método} classmethod invalidate_caches ()

Chama @ref{476c,,importlib.abc.PathEntryFinder.invalidate_caches()} em todos os localizadores armazenados em @ref{5e4,,sys.path_importer_cache} que definem o método. Caso contrário, as entradas em @ref{5e4,,sys.path_importer_cache} definidas como @code{None} são excluídas.


Alterado na versão 3.7: Entradas de @code{None} em @ref{5e4,,sys.path_importer_cache} são excluídas.

@end deffn


Alterado na versão 3.4: Chama objetos em @ref{105a,,sys.path_hooks} com o diretório de trabalho atual para @code{'@w{'}} (ou seja, a string vazia).

@end deffn

@geindex FileFinder (classe em importlib.machinery)
@anchor{library/importlib importlib machinery FileFinder}@anchor{10ab}
@deffn {Classe} importlib.machinery.FileFinder (path, *loader_details)

Uma implementação concreta de @ref{873,,importlib.abc.PathEntryFinder} que armazena em cache os resultados do sistema de arquivos.

O argumento `path' é o diretório que o localizador é responsável por pesquisar.

O argumento `loader_details' é um número variável de tuplas de 2 itens, cada uma contendo um carregador e uma sequência de sufixos de arquivo que o carregador reconhece. Espera-se que os carregadores sejam chamáveis que aceitam dois argumentos do nome do módulo e o caminho para o arquivo encontrado.

O localizador armazenará em cache o conteúdo do diretório conforme necessário, fazendo chamadas de “stat” para cada pesquisa de módulo para verificar se o cache não está desatualizado. Como a obsolescência do cache depende da granularidade das informações de estado do sistema operacional do sistema de arquivos, há uma condição de corrida potencial de busca por um módulo, criação de um novo arquivo e, em seguida, busca pelo módulo que o novo arquivo representa. Se as operações ocorrerem rápido o suficiente para caber na granularidade das chamadas de “stat”, a pesquisa do módulo falhará. Para evitar que isso aconteça, ao criar um módulo dinamicamente, certifique-se de chamar @ref{c2a,,importlib.invalidate_caches()}.


Adicionado na versão 3.3.


@geindex path (atributo importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder path}@anchor{478c}
@deffn {Atributo} path

O caminho que o localizador irá procurar.
@end deffn

@geindex find_spec() (método importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder find_spec}@anchor{ef5}
@deffn {Método} find_spec (fullname, target=None)

Tenta encontrar o spec para manipular `fullname' dentro de @ref{478c,,path}.


Adicionado na versão 3.4.

@end deffn

@geindex invalidate_caches() (método importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder invalidate_caches}@anchor{478d}
@deffn {Método} invalidate_caches ()

Limpa o cache interno.
@end deffn

@geindex path_hook() (método de classe importlib.machinery.FileFinder)
@anchor{library/importlib importlib machinery FileFinder path_hook}@anchor{478e}
@deffn {Método} classmethod path_hook (*loader_details)

Um método de classe que retorna uma clausura para uso em @ref{105a,,sys.path_hooks}. Uma instância de @ref{10ab,,FileFinder} é retornada pela clausura usando o argumento de caminho dado à clausura diretamente e `loader_details' indiretamente.

Se o argumento para a clausura não for um diretório existente, @ref{419,,ImportError} será levantada.
@end deffn
@end deffn

@geindex SourceFileLoader (classe em importlib.machinery)
@anchor{library/importlib importlib machinery SourceFileLoader}@anchor{10ad}
@deffn {Classe} importlib.machinery.SourceFileLoader (fullname, path)

Uma implementação concreta de @ref{4777,,importlib.abc.SourceLoader} subclassificando @ref{10ac,,importlib.abc.FileLoader} e fornecendo algumas implementações concretas de outros métodos.


Adicionado na versão 3.3.


@geindex name (atributo importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader name}@anchor{478f}
@deffn {Atributo} name

O nome do módulo que este carregador irá manipular.
@end deffn

@geindex path (atributo importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader path}@anchor{4790}
@deffn {Atributo} path

O caminho para o arquivo fonte.
@end deffn

@geindex is_package() (método importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader is_package}@anchor{4791}
@deffn {Método} is_package (fullname)

Retorna @code{True} se @ref{4790,,path} parecer ser para um pacote.
@end deffn

@geindex path_stats() (método importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader path_stats}@anchor{4792}
@deffn {Método} path_stats (path)

Implementação concreta de @ref{11c9,,importlib.abc.SourceLoader.path_stats()}.
@end deffn

@geindex set_data() (método importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader set_data}@anchor{4793}
@deffn {Método} set_data (path, data)

Implementação concreta de @ref{4778,,importlib.abc.SourceLoader.set_data()}.
@end deffn

@geindex load_module() (método importlib.machinery.SourceFileLoader)
@anchor{library/importlib importlib machinery SourceFileLoader load_module}@anchor{d4a}
@deffn {Método} load_module (name=None)

Implementação concreta de @ref{86d,,importlib.abc.Loader.load_module()} onde a especificação do nome do módulo para carregar é opcional


Descontinuado desde a versão 3.6, será removido na versão 3.15: Use @ref{86e,,importlib.abc.Loader.exec_module()}.

@end deffn
@end deffn

@geindex SourcelessFileLoader (classe em importlib.machinery)
@anchor{library/importlib importlib machinery SourcelessFileLoader}@anchor{10ae}
@deffn {Classe} importlib.machinery.SourcelessFileLoader (fullname, path)

Uma implementação concreta de @ref{10ac,,importlib.abc.FileLoader} que pode importar arquivos de bytecode (ou seja, não existem arquivos de código-fonte).

Observe que o uso direto de arquivos de bytecode (e, portanto, não de arquivos de código-fonte) impede que seus módulos sejam utilizáveis por todas as implementações do Python ou novas versões do Python que alteram o formato do bytecode.


Adicionado na versão 3.3.


@geindex name (atributo importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader name}@anchor{4794}
@deffn {Atributo} name

O nome do módulo que o carregador vai manipular.
@end deffn

@geindex path (atributo importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader path}@anchor{4795}
@deffn {Atributo} path

O caminho para o arquivo de bytecode.
@end deffn

@geindex is_package() (método importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader is_package}@anchor{4796}
@deffn {Método} is_package (fullname)

Determina se o módulo é um pacote baseado em @ref{4795,,path}.
@end deffn

@geindex get_code() (método importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader get_code}@anchor{4797}
@deffn {Método} get_code (fullname)

Retorna o objeto código para @ref{4794,,name} criado a partir de @ref{4795,,path}.
@end deffn

@geindex get_source() (método importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader get_source}@anchor{4798}
@deffn {Método} get_source (fullname)

Retorna @code{None}, pois os arquivos de bytecode não têm código-fonte quando este carregador é usado.
@end deffn

@geindex load_module() (método importlib.machinery.SourcelessFileLoader)
@anchor{library/importlib importlib machinery SourcelessFileLoader load_module}@anchor{d4b}
@deffn {Método} load_module (name=None)
@end deffn

Implementação concreta de @ref{86d,,importlib.abc.Loader.load_module()} onde a especificação do nome do módulo para carregar é opcional


Descontinuado desde a versão 3.6, será removido na versão 3.15: Use @ref{86e,,importlib.abc.Loader.exec_module()}.

@end deffn

@geindex ExtensionFileLoader (classe em importlib.machinery)
@anchor{library/importlib importlib machinery ExtensionFileLoader}@anchor{cd0}
@deffn {Classe} importlib.machinery.ExtensionFileLoader (fullname, path)

Uma implementação concreta de @ref{4770,,importlib.abc.ExecutionLoader} para módulos de extensão.

O argumento `fullname' especifica o nome do módulo ao qual o carregador deve dar suporte. O argumento `path' é o caminho para o arquivo do módulo de extensão.

Observe que, por padrão, a importação de um módulo de extensão falhará em subinterpretadores se ele não implementar inicialização multifásica (consulte a 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}), mesmo que ele seja importado com sucesso.


Adicionado na versão 3.3.



Alterado na versão 3.12: A inicialização multifásica agora é necessária para uso em subinterpretadores.


@geindex name (atributo importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader name}@anchor{4799}
@deffn {Atributo} name

Nome do módulo ao qual o carregador dá suporte.
@end deffn

@geindex path (atributo importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader path}@anchor{479a}
@deffn {Atributo} path

Caminho para o módulo de extensão.
@end deffn

@geindex create_module() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader create_module}@anchor{479b}
@deffn {Método} create_module (spec)

Cria o objeto do módulo a partir da especificação fornecida de acordo com a 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}.


Adicionado na versão 3.5.

@end deffn

@geindex exec_module() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader exec_module}@anchor{479c}
@deffn {Método} exec_module (module)

Inicializa o objeto do módulo fornecido de acordo com a 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}.


Adicionado na versão 3.5.

@end deffn

@geindex is_package() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader is_package}@anchor{479d}
@deffn {Método} is_package (fullname)

Returns @code{True} if the file path points to a package’s @code{__init__}
module based on @ref{515,,EXTENSION_SUFFIXES}.
@end deffn

@geindex get_code() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_code}@anchor{479e}
@deffn {Método} get_code (fullname)

Retorna @code{None}, pois os módulos de extensão não possuem um objeto código.
@end deffn

@geindex get_source() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_source}@anchor{479f}
@deffn {Método} get_source (fullname)

Retorna @code{None} pois os módulos de extensão não possuem código-fonte.
@end deffn

@geindex get_filename() (método importlib.machinery.ExtensionFileLoader)
@anchor{library/importlib importlib machinery ExtensionFileLoader get_filename}@anchor{f8d}
@deffn {Método} get_filename (fullname)

Retorna @ref{479a,,path}.


Adicionado na versão 3.4.

@end deffn
@end deffn

@geindex NamespaceLoader (classe em importlib.machinery)
@anchor{library/importlib importlib machinery NamespaceLoader}@anchor{f8a}
@deffn {Classe} importlib.machinery.NamespaceLoader (name, path, path_finder)

Uma implementação concreta de @ref{f88,,importlib.abc.InspectLoader} para pacotes de espaço de nomes. Este é um apelido para uma classe privada e só é tornado público para introspecção do atributo @code{__loader__} em pacotes de espaço de nomes:

@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


Adicionado na versão 3.11.

@end deffn

@geindex ModuleSpec (classe em importlib.machinery)
@anchor{library/importlib importlib machinery ModuleSpec}@anchor{1fee}
@deffn {Classe} 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{20a7,,__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{20ad,,__file__} at runtime and this will not be
automatically reflected in the module’s
@ref{47a0,,__spec__.origin}, and vice versa.


Adicionado na versão 3.4.


@geindex name (atributo importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec name}@anchor{20a8}
@deffn {Atributo} name

The module’s fully qualified name (see @ref{13d2,,module.__name__}).
The @ref{20ae,,finder} should always set this attribute to a non-empty string.
@end deffn

@geindex loader (atributo importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec loader}@anchor{2e3}
@deffn {Atributo} loader

The @ref{17a4,,loader} used to load the module (see @ref{2e2,,module.__loader__}).
The @ref{20ae,,finder} should always set this attribute.
@end deffn

@geindex origin (atributo importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec origin}@anchor{47a0}
@deffn {Atributo} origin

The location the @ref{17a4,,loader} should use to load the module
(see @ref{20ad,,module.__file__}).
For example, for modules loaded from a @code{.py} file this is the filename.
The @ref{20ae,,finder} should always set this attribute to a meaningful value
for the @ref{17a4,,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 importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec submodule_search_locations}@anchor{20ac}
@deffn {Atributo} submodule_search_locations

A (possibly empty) @ref{4f1,,sequence} of strings enumerating the locations
in which a package’s submodules will be found
(see @ref{1df4,,module.__path__}). Most of the time there will only be a
single directory in this list.

The @ref{20ae,,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 importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec loader_state}@anchor{47a1}
@deffn {Atributo} loader_state

The @ref{20ae,,finder} may set this attribute to an object containing additional,
module-specific data to use when loading the module.  Otherwise it should be
set to @code{None}.
@end deffn

@geindex cached (atributo importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec cached}@anchor{2d6}
@deffn {Atributo} cached

The filename of a compiled version of the module’s code
(see @ref{2d5,,module.__cached__}).
The @ref{20ae,,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 importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec parent}@anchor{2d8}
@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{2d7,,module.__package__}.
If the module is a package then this is the same as @ref{20a8,,name}.
@end deffn

@geindex has_location (atributo importlib.machinery.ModuleSpec)
@anchor{library/importlib importlib machinery ModuleSpec has_location}@anchor{47a2}
@deffn {Atributo} has_location

@code{True} if the spec’s @ref{47a0,,origin} refers to a loadable location,
@code{False} otherwise.  This value impacts how @code{origin} is interpreted
and how the module’s @ref{20ad,,__file__} is populated.
@end deffn
@end deffn

@geindex AppleFrameworkLoader (classe em importlib.machinery)
@anchor{library/importlib importlib machinery AppleFrameworkLoader}@anchor{1fed}
@deffn {Classe} importlib.machinery.AppleFrameworkLoader (name, path)

A specialization of @ref{cd0,,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 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.

Por exemplo, considere o caso de uma importação @code{from foo.bar import _whiz}, onde @code{_whiz} é implementado com o módulo binário @code{sources/foo/bar/_whiz.abi3.so}, com @code{sources} sendo o local registrado em @code{sys.path}, relativo ao pacote da aplicação. Este módulo `deve' ser distribuído como @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz} (criando o nome do framework a partir do caminho de importação completo do módulo), com um arquivo @code{Info.plist} no diretório @code{.framework} identificando o binário como um framework. O módulo @code{foo.bar._whiz} seria representado no local original com um arquivo marcador @code{sources/foo/bar/_whiz.abi3.fwork}, contendo o caminho @code{Frameworks/foo.bar._whiz/foo.bar._whiz}. O framework também conteria @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}, contendo o caminho para o arquivo @code{.fwork}.

Quando um módulo é carregado com este carregador, o @code{__file__} para o módulo será reportado como o local do arquivo @code{.fwork}. Isso permite que o código use o @code{__file__} de um módulo como uma âncora para travessia do sistema de arquivos. No entanto, a origem do spec fará referência ao local do binário `real' na pasta @code{.framework}.

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.


Adicionado na versão 3.13.


@ref{1ed8,,Disponibilidade}: iOS.

@geindex name (atributo importlib.machinery.AppleFrameworkLoader)
@anchor{library/importlib importlib machinery AppleFrameworkLoader name}@anchor{47a3}
@deffn {Atributo} name

Nome do módulo ao qual o carregador dá suporte.
@end deffn

@geindex path (atributo importlib.machinery.AppleFrameworkLoader)
@anchor{library/importlib importlib machinery AppleFrameworkLoader path}@anchor{47a4}
@deffn {Atributo} path

Path to the @code{.fwork} file for the extension module.
@end deffn
@end deffn

@node importlib util – Utility code for importers,Exemplos<34>,importlib machinery – Importadores e ganchos de caminho,importlib — A implementação de import
@anchor{library/importlib importlib-util-utility-code-for-importers}@anchor{47a5}@anchor{library/importlib module-importlib util}@anchor{7d}
@subsubsection @code{importlib.util} – Utility code for importers


@geindex module; importlib.util

`Source code:' Lib/importlib/util.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/util.py}


__________________________________________________________________


This module contains the various objects that help in the construction of
an @ref{2184,,importer}.

@geindex MAGIC_NUMBER (no módulo importlib.util)
@anchor{library/importlib importlib util MAGIC_NUMBER}@anchor{513}
@deffn {Dado} importlib.util.MAGIC_NUMBER

The bytes which represent the bytecode version number. If you need help with
loading/writing bytecode then consider @ref{4777,,importlib.abc.SourceLoader}.


Adicionado na versão 3.4.

@end deffn

@geindex cache_from_source() (no módulo importlib.util)
@anchor{library/importlib importlib util cache_from_source}@anchor{2fe}
@deffn {Função} importlib.util.cache_from_source (path, debug_override=None, *, optimization=None)

Return the 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} path to the byte-compiled file associated
with the source `path'.  For example, if `path' is @code{/foo/bar/baz.py} the return
value would be @code{/foo/bar/__pycache__/baz.cpython-32.pyc} for Python 3.2.
The @code{cpython-32} string comes from the current magic tag (see
@code{get_tag()}; if @code{sys.implementation.cache_tag} is not defined then
@ref{228,,NotImplementedError} will be raised).

The `optimization' parameter is used to specify the optimization level of the
bytecode file. An empty string represents no optimization, so
@code{/foo/bar/baz.py} with an `optimization' of @code{'@w{'}} will result in a
bytecode path of @code{/foo/bar/__pycache__/baz.cpython-32.pyc}. @code{None} causes
the interpreter’s optimization level to be used. Any other value’s string
representation is used, so @code{/foo/bar/baz.py} with an `optimization' of
@code{2} will lead to the bytecode path of
@code{/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc}. The string representation
of `optimization' can only be alphanumeric, else @ref{202,,ValueError} is raised.

The `debug_override' parameter is deprecated and can be used to override
the system’s value for @code{__debug__}. A @code{True} value is the equivalent of
setting `optimization' to the empty string. A @code{False} value is the same as
setting `optimization' to @code{1}. If both `debug_override' an `optimization'
are not @code{None} then @ref{2c3,,TypeError} is raised.


Adicionado na versão 3.4.



Alterado na versão 3.5: The `optimization' parameter was added and the `debug_override' parameter
was deprecated.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex source_from_cache() (no módulo importlib.util)
@anchor{library/importlib importlib util source_from_cache}@anchor{51a}
@deffn {Função} importlib.util.source_from_cache (path)

Given the `path' to a 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} file name, return the associated source code
file path.  For example, if `path' is
@code{/foo/bar/__pycache__/baz.cpython-32.pyc} the returned path would be
@code{/foo/bar/baz.py}.  `path' need not exist, however if it does not conform
to 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} or 
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} format, a @ref{202,,ValueError} is raised. If
@code{sys.implementation.cache_tag} is not defined,
@ref{228,,NotImplementedError} is raised.


Adicionado na versão 3.4.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex decode_source() (no módulo importlib.util)
@anchor{library/importlib importlib util decode_source}@anchor{f8b}
@deffn {Função} importlib.util.decode_source (source_bytes)

Decode the given bytes representing source code and return it as a string
with universal newlines (as required by
@ref{f8c,,importlib.abc.InspectLoader.get_source()}).


Adicionado na versão 3.4.

@end deffn

@geindex resolve_name() (no módulo importlib.util)
@anchor{library/importlib importlib util resolve_name}@anchor{910}
@deffn {Função} importlib.util.resolve_name (name, package)

Resolve a relative module name to an absolute one.

If  `name' has no leading dots, then `name' is simply returned. This
allows for usage such as
@code{importlib.util.resolve_name('sys', __spec__.parent)} without doing a
check to see if the `package' argument is needed.

@ref{419,,ImportError} is raised if `name' is a relative module name but
`package' is a false value (e.g. @code{None} or the empty string).
@ref{419,,ImportError} is also raised if a relative name would escape its
containing package (e.g. requesting @code{..bacon} from within the @code{spam}
package).


Adicionado na versão 3.3.



Alterado na versão 3.9: To improve consistency with import statements, raise
@ref{419,,ImportError} instead of @ref{202,,ValueError} for invalid relative
import attempts.

@end deffn

@geindex find_spec() (no módulo importlib.util)
@anchor{library/importlib importlib util find_spec}@anchor{2cd}
@deffn {Função} importlib.util.find_spec (name, package=None)

Localiza o @ref{20a6,,spec} para um módulo, opcionalmente relativo ao nome do `package' especificado. Se o módulo estiver em @ref{1636,,sys.modules}, então @code{sys.modules[name].__spec__} será retornado (a menos que o spec seja @code{None} ou não esteja definido, nesse caso @ref{202,,ValueError} é levantada). Caso contrário, uma pesquisa usando @ref{d4d,,sys.meta_path} é feita. @code{None} é retornado se nenhum spec for encontrada.

If `name' is for a submodule (contains a dot), the parent module is
automatically imported.

`name' and `package' work the same as for @code{import_module()}.


Adicionado na versão 3.4.



Alterado na versão 3.7: Raises @ref{b5b,,ModuleNotFoundError} instead of @ref{34b,,AttributeError} if
`package' is in fact not a package (i.e. lacks a
@ref{1df4,,__path__} attribute).

@end deffn

@geindex module_from_spec() (no módulo importlib.util)
@anchor{library/importlib importlib util module_from_spec}@anchor{e3e}
@deffn {Função} importlib.util.module_from_spec (spec)

Create a new module based on `spec' and
@ref{cce,,spec.loader.create_module}.

If @ref{cce,,spec.loader.create_module}
does not return @code{None}, then any pre-existing attributes will not be reset.
Also, no @ref{34b,,AttributeError} will be raised if triggered while accessing
`spec' or setting an attribute on the module.

This function is preferred over using @ref{e3f,,types.ModuleType} to create a
new module as `spec' is used to set as many import-controlled attributes on
the module as possible.


Adicionado na versão 3.5.

@end deffn

@geindex spec_from_loader() (no módulo importlib.util)
@anchor{library/importlib importlib util spec_from_loader}@anchor{871}
@deffn {Função} importlib.util.spec_from_loader (name, loader, *, origin=None, is_package=None)

A factory function for creating a @ref{1fee,,ModuleSpec}
instance based on a loader.  The parameters have the same meaning as they do
for ModuleSpec.  The function uses available @ref{17a4,,loader} APIs, such as
@code{InspectLoader.is_package()}, to fill in any missing
information on the spec.


Adicionado na versão 3.4.

@end deffn

@geindex spec_from_file_location() (no módulo importlib.util)
@anchor{library/importlib importlib util spec_from_file_location}@anchor{cd1}
@deffn {Função} importlib.util.spec_from_file_location (name, location, *, loader=None, submodule_search_locations=None)

A factory function for creating a @ref{1fee,,ModuleSpec}
instance based on the path to a file.  Missing information will be filled in
on the spec by making use of loader APIs and by the implication that the
module will be file-based.


Adicionado na versão 3.4.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex source_hash() (no módulo importlib.util)
@anchor{library/importlib importlib util source_hash}@anchor{b5c}
@deffn {Função} importlib.util.source_hash (source_bytes)

Return the hash of `source_bytes' as bytes. A hash-based @code{.pyc} file embeds
the @ref{b5c,,source_hash()} of the corresponding source file’s contents in its
header.


Adicionado na versão 3.7.

@end deffn

@geindex _incompatible_extension_module_restrictions() (no módulo importlib.util)
@anchor{library/importlib importlib util _incompatible_extension_module_restrictions}@anchor{47a6}
@deffn {Função} 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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) and lying about
support for multiple interpreters (or per-interpreter GIL).

@cartouche
@quotation Aviso 
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


Adicionado na versão 3.12.

@end deffn

@geindex LazyLoader (classe em importlib.util)
@anchor{library/importlib importlib util LazyLoader}@anchor{ccd}
@deffn {Classe} importlib.util.LazyLoader (loader)

A class which postpones the execution of the loader of a module until the
module has an attribute accessed.

This class `only' works with loaders that define
@ref{86e,,exec_module()} as control over what module type
is used for the module is required. For those same reasons, the loader’s
@ref{cce,,create_module()} method must return @code{None} or a
type for which its @code{__class__} attribute can be mutated along with not
using @ref{5df,,slots}. Finally, modules which substitute the object
placed into @ref{1636,,sys.modules} will not work as there is no way to properly
replace the module references throughout the interpreter safely;
@ref{202,,ValueError} is raised if such a substitution is detected.

@cartouche
@quotation Nota 
For projects where startup time is critical, this class allows for
potentially minimizing the cost of loading a module if it is never used.
For projects where startup time is not essential then use of this class is
`heavily' discouraged due to error messages created during loading being
postponed and thus occurring out of context.
@end quotation
@end cartouche


Adicionado na versão 3.5.



Alterado na versão 3.6: Began calling @ref{cce,,create_module()}, removing the
compatibility warning for @ref{ccf,,importlib.machinery.BuiltinImporter} and
@ref{cd0,,importlib.machinery.ExtensionFileLoader}.


@geindex factory() (método de classe importlib.util.LazyLoader)
@anchor{library/importlib importlib util LazyLoader factory}@anchor{47a7}
@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 Exemplos<34>,,importlib util – Utility code for importers,importlib — A implementação de import
@anchor{library/importlib examples}@anchor{47a8}@anchor{library/importlib importlib-examples}@anchor{47a9}
@subsubsection Exemplos


@menu
* Importing programmatically:: 
* Checando se o módulo pode ser importado:: 
* Importa o arquivo de origem diretamente:: 
* Implementing lazy imports:: 
* Setting up an importer:: 
* Approximating importlib.import_module(): Approximating importlib import_module. 

@end menu

@node Importing programmatically,Checando se o módulo pode ser importado,,Exemplos<34>
@anchor{library/importlib importing-programmatically}@anchor{47aa}
@subsubsection Importing programmatically


To programmatically import a module, use @ref{518,,importlib.import_module()}.

@example
import importlib

itertools = importlib.import_module('itertools')
@end example

@node Checando se o módulo pode ser importado,Importa o arquivo de origem diretamente,Importing programmatically,Exemplos<34>
@anchor{library/importlib checking-if-a-module-can-be-imported}@anchor{47ab}
@subsubsection Checando se o módulo pode ser importado


If you need to find out if a module can be imported without actually doing the
import, then you should use @ref{2cd,,importlib.util.find_spec()}.

Note that if @code{name} is a submodule (contains a dot),
@ref{2cd,,importlib.util.find_spec()} will import the parent module.

@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 Importa o arquivo de origem diretamente,Implementing lazy imports,Checando se o módulo pode ser importado,Exemplos<34>
@anchor{library/importlib importing-a-source-file-directly}@anchor{47ac}
@subsubsection Importa o arquivo de origem diretamente


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{3b4,,sys.path} being searched. Alternatives should first be considered first,
such as modifying @ref{3b4,,sys.path} when a proper module is required, or using
@ref{181,,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 Implementing lazy imports,Setting up an importer,Importa o arquivo de origem diretamente,Exemplos<34>
@anchor{library/importlib implementing-lazy-imports}@anchor{47ad}
@subsubsection Implementing lazy imports


The example below shows how to implement lazy imports:

@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 Setting up an importer,Approximating importlib import_module,Implementing lazy imports,Exemplos<34>
@anchor{library/importlib setting-up-an-importer}@anchor{47ae}
@subsubsection Setting up an importer


For deep customizations of import, you typically want to implement an
@ref{2184,,importer}. This means managing both the @ref{20ae,,finder} and @ref{17a4,,loader}
side of things. For finders there are two flavours to choose from depending on
your needs: a @ref{10a9,,meta path finder} or a @ref{10aa,,path entry finder}. The
former is what you would put on @ref{d4d,,sys.meta_path} while the latter is what
you create using a @ref{2195,,path entry hook} on @ref{105a,,sys.path_hooks} which works
with @ref{3b4,,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 Approximating importlib import_module,,Setting up an importer,Exemplos<34>
@anchor{library/importlib approximating-importlib-import-module}@anchor{47af}
@subsubsection Approximating @code{importlib.import_module()}


Import itself is implemented in Python code, making it possible to
expose most of the import machinery through importlib. The following
helps illustrate the various APIs that importlib exposes by providing an
approximate implementation of
@ref{518,,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 – Leitura abertura e acesso a recursos de pacotes,importlib resources abc – Classes base abstratas para recursos,importlib — A implementação de import,Importando módulos
@anchor{library/importlib resources doc}@anchor{47b0}@anchor{library/importlib resources importlib-resources-package-resource-reading-opening-and-access}@anchor{47b1}@anchor{library/importlib resources module-importlib resources}@anchor{7b}@anchor{library/importlib resources translation-repo}@anchor{47b2}
@subsection @code{importlib.resources} – Leitura, abertura e acesso a recursos de pacotes


@geindex module; importlib.resources

`Código-fonte:' Lib/importlib/resources/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/resources/__init__.py}


__________________________________________________________________



Adicionado na versão 3.7.


Esse módulo aproveita o sistema de importação do Python para fornecer acesso a `recursos' dentro de `pacotes'.

“Recursos” são recursos arquivo ou similares associados a um módulo ou pacote em Python. Os recursos podem estar contidos diretamente em um pacote, em um subdiretório contido nesse pacote ou adjacentes a módulos fora de um pacote. Os recursos podem ser de texto ou binários. Como resultado, as fontes de módulos Python de um pacote (.py), artefatos de compilação (pycache) e artefatos de instalação (como @ref{223,,nomes de arquivos reservados} em diretórios) são tecnicamente recursos de fato desse pacote. Na prática, entretanto, os recursos são principalmente os artefatos não-Python expostos especificamente pelo autor do pacote.

Os recursos podem ser abertos ou lidos no modo binário ou de texto.

Os recursos são mais ou menos semelhantes a arquivos dentro de diretórios, embora seja importante ter em mente que isso é apenas uma metáfora.  Recursos e pacotes `não' precisam existir como arquivos e diretórios físicos no sistema de arquivos: por exemplo, um pacote e seus recursos podem ser importados de um arquivo zip usando @ref{132,,zipimport}.

@cartouche
@quotation Nota 
Esse módulo fornece funcionalidade semelhante ao Basic Resource Access@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access} do pkg_resources@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html} sem a sobrecarga de desempenho desse pacote.  Isso facilita a leitura de recursos incluídos em pacotes, com uma semântica mais estável e consistente.

O backport autônomo desse módulo fornece mais informações sobre uso do importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/using.html} e migração do pkg_resources para o importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/migration.html}.
@end quotation
@end cartouche

@ref{ef6,,Loaders} que desejam oferecer suporte à leitura de recursos devem implementar um método @code{get_resource_reader(fullname)} conforme especificado por @ref{476d,,importlib.resources.abc.ResourceReader}.

@geindex Anchor (classe em importlib.resources)
@anchor{library/importlib resources importlib resources Anchor}@anchor{47b3}
@deffn {Classe} importlib.resources.Anchor

Representa uma âncora para recursos, seja um @ref{e3f,,objeto módulo} ou um nome de módulo como uma string. Definido como @code{Union[str, ModuleType]}.
@end deffn

@geindex files() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources files}@anchor{48e}
@deffn {Função} importlib.resources.files (anchor: Anchor | None = None)

Retorna um objeto @ref{1f3,,Traversable} que representa o contêiner de recursos (pense em diretório) e seus recursos (pense em arquivos). Um Traversable pode conter outros contêineres (pense em subdiretórios).

`anchor' é um @ref{47b3,,Anchor} opcional. Se a âncora for um pacote, os recursos são resolvidos a partir desse pacote. Se for um módulo, os recursos são resolvidos ao lado desse módulo (no mesmo pacote ou na raiz do pacote). Se a âncora for omitida, o módulo do chamador é usado.


Adicionado na versão 3.9.



Alterado na versão 3.12: O parâmetro `package' foi renomeado para `anchor'. `anchor' agora pode ser um módulo sem ser pacote e, se omitido, será o módulo do chamador por padrão. `package' ainda é aceito por compatibilidade, mas irá levantar um @ref{1a5,,DeprecationWarning}. Considere passar a posição da âncora de forma posicional ou usar @code{importlib_resources >= 5.10} para uma interface compatível em versões mais antigas do Python.

@end deffn

@geindex as_file() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources as_file}@anchor{48d}
@deffn {Função} importlib.resources.as_file (traversable)

Dado um objeto @ref{1f3,,Traversable} que representa um arquivo ou diretório, normalmente de @ref{48e,,importlib.resources.files()}, retorna um gerenciador de contexto para uso em uma instrução @ref{5d2,,with}. O gerenciador de contexto fornece um objeto @ref{229,,pathlib.Path}.

Sair do gerenciador de contexto limpa qualquer arquivo ou diretório temporário criado quando o recurso foi extraído, por exemplo, de um arquivo zip.

Use @code{as_file} quando os métodos de Traversable (@code{read_text}, etc.) forem insuficientes e for necessário um arquivo ou diretório real no sistema de arquivos.


Adicionado na versão 3.9.



Alterado na versão 3.12: Adicionado suporte para `traversable' representando um diretório.

@end deffn

@menu
* API funcional:: 

@end menu

@node API funcional,,,importlib resources – Leitura abertura e acesso a recursos de pacotes
@anchor{library/importlib resources functional-api}@anchor{47b4}@anchor{library/importlib resources importlib-resources-functional}@anchor{47b5}
@subsubsection API funcional


Um conjunto de auxiliares simplificados e compatíveis com versões anteriores está disponível. Estes permitem operações comuns em uma única chamada de função.

Para todas as funções a seguir:


@itemize -

@item 
`anchor' é um @ref{47b3,,Anchor}, assim como em @ref{48e,,files()}. Ao contrário do comportamento em @code{files}, `anchor' aqui não pode ser omitido.

@item 
`path_names' são componentes do nome do caminho de um recurso, relativo à âncora. Por exemplo, para obter o texto de um recurso chamado @code{info.txt}, use:

@example
importlib.resources.read_text(my_module, "info.txt")
@end example

Assim como em @ref{1f3,,Traversable.joinpath}, os componentes individuais devem usar barras ordinárias (@code{/}) como separadores do caminho. Por exemplo, as seguintes chamadas são equivalentes:

@example
importlib.resources.read_binary(my_module, "pics/painting.png")
importlib.resources.read_binary(my_module, "pics", "painting.png")
@end example

Por motivos de compatibilidade com versões anteriores, funções que leem texto requerem um argumento `encoding' explícito se múltiplos `path_names' forem fornecidos. Por exemplo, para obter o texto de @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() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources open_binary}@anchor{1ed}
@deffn {Função} importlib.resources.open_binary (anchor, *path_names)

Abre o recurso nomeado para leitura binária.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'.

Esta função retorna um objeto @ref{41c4,,BinaryIO}, isto é, um fluxo binário aberto para leitura.

Esta função é mais ou menos equivalente a:

@example
files(anchor).joinpath(*path_names).open('rb')
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos.

@end deffn

@geindex open_text() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources open_text}@anchor{1ee}
@deffn {Função} importlib.resources.open_text (anchor, *path_names, encoding='utf-8', errors='strict')

Abre o recurso nomeado para leitura de texto. Por padrão, o conteúdo é lido como UTF-8 estrito.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'. `encoding' e `errors' têm o mesmo significado que na embutida @ref{51c,,open()}.

Por motivos de compatibilidade com versões anteriores, o argumento `encoding' precisa ser passado explicitamente se houver múltiplos `path_names'. Essa limitação está agendada para ser removida no Python 3.15.

Esta função retorna um objeto @ref{41c3,,TextIO}, isto é, um fluxo de texto aberto para leitura.

Esta função é mais ou menos equivalente a:

@example
files(anchor).joinpath(*path_names).open('r', encoding=encoding)
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos. `encoding' e `errors' precisam ser fornecidos como argumentos nomeados.

@end deffn

@geindex read_binary() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources read_binary}@anchor{1f0}
@deffn {Função} importlib.resources.read_binary (anchor, *path_names)

Lê e retorna o conteúdo do recurso nomeado como @ref{1c2,,bytes}.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'.

Esta função é mais ou menos equivalente a:

@example
files(anchor).joinpath(*path_names).read_bytes()
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos.

@end deffn

@geindex read_text() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources read_text}@anchor{1f1}
@deffn {Função} importlib.resources.read_text (anchor, *path_names, encoding='utf-8', errors='strict')

Lê e retorna o conteúdo do recurso nomeado como @ref{44c,,str}. Por padrão, o conteúdo é lido como UTF-8 estrito.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'. `encoding' e `errors' têm o mesmo significado que na embutida @ref{51c,,open()}.

Por motivos de compatibilidade com versões anteriores, o argumento `encoding' precisa ser passado explicitamente se houver múltiplos `path_names'. Essa limitação está agendada para ser removida no Python 3.15.

Esta função é mais ou menos equivalente a:

@example
files(anchor).joinpath(*path_names).read_text(encoding=encoding)
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos. `encoding' e `errors' precisam ser fornecidos como argumentos nomeados.

@end deffn

@geindex path() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources path}@anchor{1ef}
@deffn {Função} importlib.resources.path (anchor, *path_names)

Fornece o caminho para o `resource' como um caminho real do sistema de arquivos.  Essa função retorna um gerenciador de contexto para uso em uma instrução @ref{5d2,,with}. O gerenciador de contexto fornece um objeto @ref{229,,pathlib.Path}.

Sair do gerenciador de contexto limpa qualquer arquivo temporário criado, por exemplo quando o recurso precisa ser extraído de um arquivo zip.

Por exemplo, o método @ref{826,,stat()} requer um caminho real em um sistema de arquivos; ele pode ser usado assim:

@example
with importlib.resources.path(anchor, "resource.txt") as fspath:
    result = fspath.stat()
@end example

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'.

Esta função é mais ou menos equivalente a:

@example
as_file(files(anchor).joinpath(*path_names))
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos. `encoding' e `errors' precisam ser fornecidos como argumentos nomeados.

@end deffn

@geindex is_resource() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources is_resource}@anchor{1ec}
@deffn {Função} importlib.resources.is_resource (anchor, *path_names)

Retorna @code{True} se o recurso nomeado existe, senão @code{False}. Esta função não considera diretórios como sendo recursos.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'.

Esta função é mais ou menos equivalente a:

@example
files(anchor).joinpath(*path_names).is_file()
@end example


Alterado na versão 3.13: Múltiplos `path_names' são aceitos.

@end deffn

@geindex contents() (no módulo importlib.resources)
@anchor{library/importlib resources importlib resources contents}@anchor{1f2}
@deffn {Função} importlib.resources.contents (anchor, *path_names)

Retorna um iterável sobre os itens nomeados no pacote ou caminho. O iterável retorna nomes de recursos (por exemplo, arquivos) e outros itens que não recursos (por exemplo, diretórios) como @ref{44c,,str}. O iterável não recorre em subdiretórios.

Veja @ref{47b5,,a introdução} para detalhes sobre `anchor' e `path_names'.

Esta função é mais ou menos equivalente a:

@example
for resource in files(anchor).joinpath(*path_names).iterdir():
    yield resource.name
@end example


Descontinuado desde a versão 3.11: Prefira @code{iterdir()} como acima, que oferece mais controle sobre os resultados e funcionalidade mais rica.

@end deffn

@node importlib resources abc – Classes base abstratas para recursos,importlib metadata – Acessando metadados do pacote,importlib resources – Leitura abertura e acesso a recursos de pacotes,Importando módulos
@anchor{library/importlib resources abc doc}@anchor{47b6}@anchor{library/importlib resources abc importlib-resources-abc-abstract-base-classes-for-resources}@anchor{47b7}@anchor{library/importlib resources abc module-importlib resources abc}@anchor{7c}@anchor{library/importlib resources abc translation-repo}@anchor{47b8}
@subsection @code{importlib.resources.abc} – Classes base abstratas para recursos


@geindex module; importlib.resources.abc

`Código-fonte:' Lib/importlib/resources/abc.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/resources/abc.py}


__________________________________________________________________



Adicionado na versão 3.11.


@geindex ResourceReader (classe em importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc ResourceReader}@anchor{476d}
@deffn {Classe} importlib.resources.abc.ResourceReader

`Substituída por TraversableResources'

Uma @ref{11f5,,classe base abstrata} para fornecer a capacidade de ler `recursos'.

Da perspectiva deste ABC, um `recurso' é um artefato binário que é enviado dentro de um pacote. Normalmente isso é algo como um arquivo de dados que fica próximo ao arquivo @code{__init__.py} do pacote. O objetivo desta classe é ajudar a abstrair o acesso a tais arquivos de dados para que não importe se o pacote e seu(s) arquivo(s) de dados estão armazenados, por exemplo, em um arquivo zip versus no sistema de arquivos.

Para qualquer um dos métodos desta classe, espera-se que o argumento `resource' seja um @ref{2a0,,objeto caminho ou similar} que representa conceitualmente apenas um nome de arquivo. Isso significa que nenhum caminho de subdiretório deve ser incluído no argumento `resource'. Isso ocorre porque a localização do pacote para o qual o leitor se destina, atua como o “diretório”. Portanto, a metáfora para diretórios e nomes de arquivos são pacotes e recursos, respectivamente. É também por isso que se espera que as instâncias dessa classe se correlacionem diretamente a um pacote específico (em vez de representar potencialmente vários pacotes ou um módulo).

Carregadores que desejam oferecer suporte à leitura de recursos devem fornecer um método chamado @code{get_resource_reader(nomecompleto)} que retorna um objeto implementando esta interface ABC. Se o módulo especificado por nomecompleto não for um pacote, este método deve retornar @ref{675,,None}. Um objeto compatível com este ABC só deve ser retornado quando o módulo especificado for um pacote.


Descontinuado desde a versão 3.12: Use @ref{2c5,,importlib.resources.abc.TraversableResources}.


@geindex open_resource() (método importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader open_resource}@anchor{47b9}
@deffn {Método} abstractmethod open_resource (resource)

Retorna um @ref{15cf,,objeto arquivo ou similar} aberto para leitura binária de `resource'.

Se o recurso não puder ser encontrado, @ref{42b,,FileNotFoundError} é levantada.
@end deffn

@geindex resource_path() (método importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader resource_path}@anchor{47ba}
@deffn {Método} abstractmethod resource_path (resource)

Retorna o caminho do sistema de arquivos para `resource'.

Se o recurso não existir concretamente no sistema de arquivos, levanta @ref{42b,,FileNotFoundError}.
@end deffn

@geindex is_resource() (método importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader is_resource}@anchor{47bb}
@deffn {Método} abstractmethod is_resource (path)

Returns @code{True} if the named `path' is considered a resource.
@ref{42b,,FileNotFoundError} is raised if `path' does not exist.


Alterado na versão 3.10: The argument `name' was renamed to `path'.

@end deffn

@geindex contents() (método importlib.resources.abc.ResourceReader)
@anchor{library/importlib resources abc importlib resources abc ResourceReader contents}@anchor{47bc}
@deffn {Método} abstractmethod contents ()

Retorna um @ref{1268,,iterável} de strings sobre o conteúdo do pacote. Observe que não é necessário que todos os nomes retornados pelo iterador sejam recursos reais, por exemplo, é aceitável retornar nomes para os quais @ref{47bb,,is_resource()} seria falso.

Permitir que nomes que não são recursos sejam retornados é permitir situações em que a forma como um pacote e seus recursos são armazenados é conhecida a priori e os nomes que não são recursos seriam úteis. Por exemplo, o retorno de nomes de subdiretórios é permitido para que, quando se souber que o pacote e os recursos estão armazenados no sistema de arquivos, esses nomes de subdiretórios possam ser usados diretamente.

O método abstrato retorna um iterável sem itens.
@end deffn
@end deffn

@geindex Traversable (classe em importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc Traversable}@anchor{1f3}
@deffn {Classe} importlib.resources.abc.Traversable

Um objeto com um subconjunto de métodos de @ref{229,,pathlib.Path} adequados para percorrer diretórios e abrir arquivos.

Para uma representação do objeto no sistema de arquivos, use @ref{48d,,importlib.resources.as_file()}.

@geindex name (atributo importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable name}@anchor{47bd}
@deffn {Atributo} name

Abstrato. O nome base deste objeto sem nenhuma referência pai.
@end deffn

@geindex iterdir() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable iterdir}@anchor{47be}
@deffn {Método} abstractmethod iterdir ()

Produz objetos Traversable em self.
@end deffn

@geindex is_dir() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable is_dir}@anchor{47bf}
@deffn {Método} abstractmethod is_dir ()

Retorna @code{True} se self for um diretório.
@end deffn

@geindex is_file() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable is_file}@anchor{47c0}
@deffn {Método} abstractmethod is_file ()

Retorna @code{True} se self for um arquivo.
@end deffn

@geindex joinpath() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable joinpath}@anchor{47c1}
@deffn {Método} abstractmethod joinpath (*pathsegments)

Percorre os diretórios de acordo com `pathsegments' e retorna o resultado como @code{Traversable}.

Cada argumento `pathsegments' pode conter vários nomes separados por barras (@code{/}, @code{posixpath.sep}). Por exemplo, os seguintes são equivalentes:

@example
files.joinpath('subdir', 'subsuddir', 'arquivo.txt')
files.joinpath('subdir/subsuddir/arquivo.txt')
@end example

Observe que algumas implementações de @code{Traversable} podem não ser atualizadas para a versão mais recente do protocolo. Para compatibilidade com tais implementações, forneça um único argumento sem separadores de caminho para cada chamada para @code{joinpath}. Por exemplo:

@example
files.joinpath('subdir').joinpath('subsubdir').joinpath('arquivo.txt')
@end example


Alterado na versão 3.11: @code{joinpath} aceita múltiplos `pathsegments', e estes segmentos podem conter barras como separadores de caminho. Anteriormente, apenas um único argumento `child' era aceito.

@end deffn

@geindex __truediv__() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable __truediv__}@anchor{47c2}
@deffn {Método} abstractmethod __truediv__ (child)

Retorna um filho Traversable em si mesmo. Equivalente a @code{joinpath(child)}.
@end deffn

@geindex open() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable open}@anchor{47c3}
@deffn {Método} abstractmethod open (mode='r', *args, **kwargs)

`mode' pode ser ‘r’ ou ‘rb’ para abrir como texto ou binário. Retorna um manipulador adequado para leitura (o mesmo que @ref{2976,,pathlib.Path.open}).

Ao abrir como texto, aceita parâmetros de codificação como os aceitos por @ref{7bc,,io.TextIOWrapper}.
@end deffn

@geindex read_bytes() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable read_bytes}@anchor{47c4}
@deffn {Método} read_bytes ()

Lê o conteúdo de self como bytes.
@end deffn

@geindex read_text() (método importlib.resources.abc.Traversable)
@anchor{library/importlib resources abc importlib resources abc Traversable read_text}@anchor{47c5}
@deffn {Método} read_text (encoding=None)

Lê o conteúdo de self como texto.
@end deffn
@end deffn

@geindex TraversableResources (classe em importlib.resources.abc)
@anchor{library/importlib resources abc importlib resources abc TraversableResources}@anchor{2c5}
@deffn {Classe} importlib.resources.abc.TraversableResources

Uma classe base abstrata para leitores de recursos capaz de servir a interface @ref{48e,,importlib.resources.files()}. É uma subclasse de @ref{476d,,ResourceReader} e fornece implementações concretas dos métodos abstratos de @code{ResourceReader}. Portanto, qualquer carregador que forneça @code{TraversableResources} também fornece @code{ResourceReader}.

Espera-se que os carregadores que desejam oferecer suporte à leitura de recursos implementem essa interface.

@geindex files() (método importlib.resources.abc.TraversableResources)
@anchor{library/importlib resources abc importlib resources abc TraversableResources files}@anchor{47c6}
@deffn {Método} abstractmethod files ()

Retorna um objeto @ref{1f3,,importlib.resources.abc.Traversable} para o pacote carregado.
@end deffn
@end deffn

@node importlib metadata – Acessando metadados do pacote,A inicialização do caminho de pesquisa de módulos sys path,importlib resources abc – Classes base abstratas para recursos,Importando módulos
@anchor{library/importlib metadata doc}@anchor{47c7}@anchor{library/importlib metadata importlib-metadata-accessing-package-metadata}@anchor{47c8}@anchor{library/importlib metadata module-importlib metadata}@anchor{7a}@anchor{library/importlib metadata translation-repo}@anchor{47c9}@anchor{library/importlib metadata using}@anchor{47ca}
@subsection @code{importlib.metadata} – Acessando metadados do pacote


@geindex module; importlib.metadata


Adicionado na versão 3.8.



Alterado na versão 3.10: @code{importlib.metadata} não é mais provisório.


`Código-fonte:' Lib/importlib/metadata/__init__.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/importlib/metadata/__init__.py}

@code{importlib.metadata} é uma biblioteca que fornece acesso aos metadados de um Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Import-Package} instalado, como seus pontos de entrada ou seus nomes de nível superior (Pacotes de Importação@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Import-Package}, módulos, se houver). Construída em parte no sistema de importação do Python, esta biblioteca pretende substituir funcionalidades semelhantes na API de ponto de entrada@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points} e API de metadados@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api} de @code{pkg_resources}. Junto com @ref{7b,,importlib.resources}, este pacote pode eliminar a necessidade de usar o pacote @code{pkg_resources} mais antigo e menos eficiente.

@code{importlib.metadata} opera em `pacotes de distribuição' de terceiros instalados no diretório @code{site-packages} do Python através de ferramentas como pip@footnote{https://pypi.org/project/pip/}. Especificamente, ele funciona com distribuições com diretórios @code{dist-info} ou @code{egg-info} detectáveis, e metadados definidos pelas Especificações de metadados principais@footnote{https://packaging.python.org/pt_BR/latest/specifications/core-metadata/#core-metadata}.

@cartouche
@quotation Importante 
Eles `não' são necessariamente equivalentes ou correspondem 1:1 aos nomes de `pacotes de importação' de nível superior que podem ser importados dentro do código Python. Um `pacote de distribuição' pode conter vários `pacotes de importação' (e módulos únicos), e um `pacote de importação' de nível superior pode ser mapeado para vários `pacotes de distribuição' se for um pacote de espaço de nomes. Você pode usar @ref{813,,packages_distributions()} para obter um mapeamento entre eles.
@end quotation
@end cartouche

Por padrão, os metadados de distribuição podem residir no sistema de arquivos ou em arquivos zip em @ref{3b4,,sys.path}. Através de um mecanismo de extensão, os metadados podem residir em praticamente qualquer lugar.


@subsubheading Ver também



@table @asis

@item @indicateurl{https://importlib-metadata.readthedocs.io/}

A documentação para @code{importlib_metadata}, que fornece um backport de @code{importlib.metadata}. Isso inclui uma referência de API@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html} para as classes e funções deste módulo, bem como um guia de migração@footnote{https://importlib-metadata.readthedocs.io/en/latest/migration.html} para usuários existentes de @code{pkg_resources}.
@end table


@menu
* Visão Geral: Visão Geral<3>. 
* API funcional: API funcional<2>. 
* Distribuições:: 
* Descoberta de distribuição:: 
* Estendendo o algoritmo de pesquisa:: 

@end menu

@node Visão Geral<3>,API funcional<2>,,importlib metadata – Acessando metadados do pacote
@anchor{library/importlib metadata overview}@anchor{47cb}
@subsubsection Visão Geral


Digamos que você queira obter a string da versão de um Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} que você instalou usando @code{pip}. Começamos criando um ambiente virtual e instalando algo nele:

@example
$ python -m venv exemplo
$ source exemplo/bin/activate
(exemplo) $ python -m pip install wheel
@end example

Você pode obter a string de versão para @code{wheel} executando o seguinte:

@example
(example) $ python
>>> from importlib.metadata import version
>>> version('wheel')
'0.32.3'
@end example

Você também pode obter uma coleção de pontos de entrada selecionáveis pelas propriedades do EntryPoint (normalmente ‘group’ ou ‘name’), como @code{console_scripts}, @code{distutils.commands} e outros. Cada grupo contém uma coleção de objetos @ref{284,,EntryPoint}.

Você pode obter os @ref{47cc,,metadados para uma distribuição}:

@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

Você também pode obter uma @ref{47cd,,número da versão da distribuição}, listar seus @ref{47ce,,arquivos constituintes} e obter uma lista dos @ref{47cf,,Requisitos de distribuição} da distribuição.

@geindex PackageNotFoundError
@anchor{library/importlib metadata importlib metadata PackageNotFoundError}@anchor{47d0}
@deffn {Exceção} importlib.metadata.PackageNotFoundError

Subclasse de @ref{b5b,,ModuleNotFoundError} levantada por diversas funções neste módulo quando consultada sobre um pacote de distribuição que não está instalado no ambiente Python atual.
@end deffn

@node API funcional<2>,Distribuições,Visão Geral<3>,importlib metadata – Acessando metadados do pacote
@anchor{library/importlib metadata functional-api}@anchor{47d1}
@subsubsection API funcional


Este pacote fornece a seguinte funcionalidade por meio de sua API pública.

@menu
* Pontos de entrada:: 
* Metadados de distribuição:: 
* Versões de distribuição:: 
* Arquivos de distribuição:: 
* Requisitos de distribuição:: 
* Mapeando importação pra pacotes de distribuição:: 

@end menu

@node Pontos de entrada,Metadados de distribuição,,API funcional<2>
@anchor{library/importlib metadata entry-points}@anchor{284}@anchor{library/importlib metadata id2}@anchor{47d2}
@subsubsection Pontos de entrada


@geindex entry_points() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata entry_points}@anchor{47d3}
@deffn {Função} importlib.metadata.entry_points (**select_params)

Retorna uma instância de @ref{47d4,,EntryPoints} descrevendo pontos de entrada para o ambiente atual. Quaisquer parâmetros nomeados fornecidos são passados para o método @code{select()} para comparação com os atributos das definições de pontos de entrada individuais.

Observação: atualmente não é possível consultar pontos de entrada com base no atributo @code{EntryPoint.dist} (já que instâncias diferentes de @code{Distribution} não são comparadas como iguais, mesmo que tenham os mesmos atributos)
@end deffn

@geindex EntryPoints (classe em importlib.metadata)
@anchor{library/importlib metadata importlib metadata EntryPoints}@anchor{47d4}
@deffn {Classe} importlib.metadata.EntryPoints

Detalhes de uma coleção de pontos de entrada instalados.

Também fornece um atributo @code{.groups} que relata todos os grupos de pontos de entrada identificados e um atributo @code{.names} que relata todos os nomes de pontos de entrada identificados.
@end deffn

@geindex EntryPoint (classe em importlib.metadata)
@anchor{library/importlib metadata importlib metadata EntryPoint}@anchor{47d5}
@deffn {Classe} importlib.metadata.EntryPoint

Detalhes de um ponto de entrada instalado.

Cada instância de @code{EntryPoint} tem os atributos @code{.name}, @code{.group} e @code{.value} e um método @code{.load()} para resolver o valor. Há também os atributos @code{.module}, @code{.attr} e @code{.extras} para obter os componentes do atributo @code{.value} e @code{.dist} para obter informações sobre o pacote de distribuição que fornece o ponto de entrada.
@end deffn

Consultar todos os pontos de entrada:

@example
>>> eps = entry_points()
@end example

A função @code{entry_points()} retorna um objeto @code{EntryPoints}, uma coleção de todos os objetos @code{EntryPoint} com atributos @code{names} e @code{groups} por conveniência:

@example
>>> sorted(eps.groups)
['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']
@end example

@code{EntryPoints} possui um método @code{select()} para selecionar pontos de entrada correspondendo a propriedades específicas. Selecione pontos de entrada no grupo @code{console_scripts}:

@example
>>> scripts = eps.select(group='console_scripts')
@end example

Equivalentemente, já que @code{entry_points()} passa argumentos nomeados para a seleção:

@example
>>> scripts = entry_points(group='console_scripts')
@end example

Escolha um script específico chamado “wheel” (encontrado no projeto wheel):

@example
>>> 'wheel' in scripts.names
True
>>> wheel = scripts['wheel']
@end example

De forma equivalente, consulte esse ponto de entrada durante a seleção:

@example
>>> (wheel,) = entry_points(group='console_scripts', name='wheel')
>>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')
@end example

Inspecione o ponto de entrada resolvido:

@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

O @code{group} e @code{name} são valores arbitrários definidos pelo autor do pacote e normalmente um cliente desejará resolver todos os pontos de entrada para um grupo específico. Leia a documentação do setuptools@footnote{https://setuptools.pypa.io/en/latest/userguide/entry_point.html} para obter mais informações sobre pontos de entrada, sua definição e uso.


Alterado na versão 3.12: Os pontos de entrada “selecionáveis” foram introduzidos em @code{importlib_metadata} 3.6 e Python 3.10. Antes dessas mudanças, @code{entry_points} não aceitava parâmetros e sempre retornava um dicionário de pontos de entrada, chaveado por grupo. Com @code{importlib_metadata} 5.0 e Python 3.12, @code{entry_points} sempre retorna um objeto @code{EntryPoints}. Veja backports.entry_points_selectable@footnote{https://pypi.org/project/backports.entry_points_selectable/} para opções de compatibilidade.



Alterado na versão 3.13: Objetos @code{EntryPoint} não apresentam mais uma interface tupla ou similar (@ref{283,,__getitem__()}).


@node Metadados de distribuição,Versões de distribuição,Pontos de entrada,API funcional<2>
@anchor{library/importlib metadata distribution-metadata}@anchor{47d6}@anchor{library/importlib metadata metadata}@anchor{47cc}
@subsubsection Metadados de distribuição


@geindex metadata() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata metadata}@anchor{47d7}
@deffn {Função} importlib.metadata.metadata (distribution_name)

Retorna os metadados de distribuição correspondentes ao pacote de distribuição nomeado como uma instância de @ref{47d8,,PackageMetadata}.

Levanta @ref{47d0,,PackageNotFoundError} se o pacote de distribuição nomeado não estiver instalado no ambiente Python atual.
@end deffn

@geindex PackageMetadata (classe em importlib.metadata)
@anchor{library/importlib metadata importlib metadata PackageMetadata}@anchor{47d8}
@deffn {Classe} importlib.metadata.PackageMetadata

Uma implementação concreta do protocolo PackageMetadata@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata}.

Além de fornecer os métodos e atributos de protocolo definidos, subscrever a instância é equivalente a chamar o método @code{get()}.
@end deffn

Cada Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} inclui alguns metadados, que você pode extrair usando a função @code{metadata()}:

@example
>>> wheel_metadata = metadata('wheel')
@end example

As chaves da estrutura de dados retornada nomeiam as palavras reservadas dos metadados, e os valores são retornados sem análise dos metadados de distribuição:

@example
>>> wheel_metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
@end example

@ref{47d8,,PackageMetadata} também apresenta um atributo @code{json} que retorna todos os metadados em um formato compatível com JSON pela 
@geindex Propostas de Melhorias do Python; 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

O conjunto completo de metadados disponíveis não é descrito aqui. Consulte a especificação de metadados principais do PyPA@footnote{https://packaging.python.org/pt_BR/latest/specifications/core-metadata/#core-metadata} para obter detalhes adicionais.


Alterado na versão 3.10: A @code{Description} agora é incluída nos metadados quando apresentada através do payload. Os caracteres de continuação de linha foram removidos.

O atributo @code{json} foi adicionado.


@node Versões de distribuição,Arquivos de distribuição,Metadados de distribuição,API funcional<2>
@anchor{library/importlib metadata distribution-versions}@anchor{47d9}@anchor{library/importlib metadata version}@anchor{47cd}
@subsubsection Versões de distribuição


@geindex version() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata version}@anchor{1699}
@deffn {Função} importlib.metadata.version (distribution_name)

Retorna a versão@footnote{https://packaging.python.org/pt-br/latest/specifications/core-metadata/#version} do pacote de distribuição instalado para o pacote de distribuição nomeado.

Levanta @ref{47d0,,PackageNotFoundError} se o pacote de distribuição nomeado não estiver instalado no ambiente Python atual.
@end deffn

A função @code{version()} é a maneira mais rápida de obter o número de versão de um Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package}, como uma string:

@example
>>> version('wheel')
'0.32.3'
@end example

@node Arquivos de distribuição,Requisitos de distribuição,Versões de distribuição,API funcional<2>
@anchor{library/importlib metadata distribution-files}@anchor{47da}@anchor{library/importlib metadata files}@anchor{47ce}
@subsubsection Arquivos de distribuição


@geindex files() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata files}@anchor{47db}
@deffn {Função} importlib.metadata.files (distribution_name)

Retorna o conjunto completo de arquivos contidos no pacote de distribuição nomeado.

Levanta @ref{47d0,,PackageNotFoundError} se o pacote de distribuição nomeado não estiver instalado no ambiente Python atual.

Retorna @ref{675,,None} se a distribuição for encontrada, mas os registros do banco de dados de instalação que relatam os arquivos associados ao pacote de distribuição estiverem ausentes.
@end deffn

@geindex PackagePath (classe em importlib.metadata)
@anchor{library/importlib metadata importlib metadata PackagePath}@anchor{47dc}
@deffn {Classe} importlib.metadata.PackagePath

Um objeto derivado de @ref{4a6,,pathlib.PurePath} com propriedades adicionais @code{dist}, @code{size} e @code{hash} correspondentes aos metadados de instalação do pacote de distribuição para esse arquivo.
@end deffn

A função @code{files()} pega um nome Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} e retorna todos os arquivos instalados por este distribuição. Cada  arquivo é é relatado como uma instância de @ref{47dc,,PackagePath}. Por exemplo:

@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

Uma vez que tenha o arquivo, você também pode ler seu conteúdo:

@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

Você também pode usar o método @code{locate()} para obter o caminho absoluto para o arquivo:

@example
>>> util.locate()
PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')
@end example

No caso em que o arquivo de metadados que lista os arquivos (@code{RECORD} ou @code{SOURCES.txt}) estiver faltando, @code{files()} retornará @ref{675,,None}. O chamador pode querer agrupar chamadas para @code{files()} em always_iterable@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable} ou de outra forma se proteger contra isso condição se a distribuição de destino não for conhecida por ter os metadados presentes.

@node Requisitos de distribuição,Mapeando importação pra pacotes de distribuição,Arquivos de distribuição,API funcional<2>
@anchor{library/importlib metadata distribution-requirements}@anchor{47dd}@anchor{library/importlib metadata requirements}@anchor{47cf}
@subsubsection Requisitos de distribuição


@geindex requires() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata requires}@anchor{47de}
@deffn {Função} importlib.metadata.requires (distribution_name)

Retorna os especificadores de dependência declarados para o pacote de distribuição nomeado.

Levanta @ref{47d0,,PackageNotFoundError} se o pacote de distribuição nomeado não estiver instalado no ambiente Python atual.
@end deffn

Para obter o conjunto completo de requisitos para um Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package}, use a função @code{requires()}:

@example
>>> requires('wheel')
["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]
@end example
@anchor{library/importlib metadata package-distributions}@anchor{813}
@node Mapeando importação pra pacotes de distribuição,,Requisitos de distribuição,API funcional<2>
@anchor{library/importlib metadata import-distribution-package-mapping}@anchor{47df}@anchor{library/importlib metadata mapping-import-to-distribution-packages}@anchor{47e0}
@subsubsection Mapeando importação pra pacotes de distribuição


@geindex packages_distributions() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata packages_distributions}@anchor{47e1}
@deffn {Função} importlib.metadata.packages_distributions ()

Retorna um mapeamento do módulo de nível superior e importa os nomes dos pacotes encontrados via @ref{d4d,,sys.meta_path} para os nomes dos pacotes de distribuição (se houver) que fornecem os arquivos correspondentes.

Para permitir pacotes de espaço de nomes (que podem ter membros fornecidos por vários pacotes de distribuição), cada nome de importação de nível superior é mapeado para uma lista de nomes de distribuição em vez de mapear diretamente para um único nome.
@end deffn

Um método conveniente para resolver o nome do Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} (ou nomes, no caso de um pacote de espaço de nomes) que fornece cada módulo Python de nível superior importável ou Pacote de Importação@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Import-Package}:

@example
>>> packages_distributions()
@{'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...@}
@end example

Algumas instalações editáveis não fornecem nomes de nível superior@footnote{https://github.com/pypa/packaging-problems/issues/609} e, portanto, esta função não é confiável com tais instalações.


Adicionado na versão 3.10.


@node Distribuições,Descoberta de distribuição,API funcional<2>,importlib metadata – Acessando metadados do pacote
@anchor{library/importlib metadata distributions}@anchor{814}@anchor{library/importlib metadata id9}@anchor{47e2}
@subsubsection Distribuições


@geindex distribution() (no módulo importlib.metadata)
@anchor{library/importlib metadata importlib metadata distribution}@anchor{47e3}
@deffn {Função} importlib.metadata.distribution (distribution_name)

Retorna uma instância de @ref{47e4,,Distribution} descrevendo o pacote de distribuição nomeado.

Levanta @ref{47d0,,PackageNotFoundError} se o pacote de distribuição nomeado não estiver instalado no ambiente Python atual.
@end deffn

@geindex Distribution (classe em importlib.metadata)
@anchor{library/importlib metadata importlib metadata Distribution}@anchor{47e4}
@deffn {Classe} importlib.metadata.Distribution

Detalhes de um pacote de distribuição instalado.

Observação: instâncias diferentes de @code{Distribution} não são atualmente consideradas iguais em uma comparação, mesmo que estejam relacionadas à mesma distribuição instalada e, portanto, tenham os mesmos atributos.
@end deffn

Embora a API de nível de módulo descrita acima seja o uso mais comum e conveniente, você pode obter todas essas informações da classe @code{Distribution}. @code{Distribution} é um objeto abstrato que representa os metadados para um Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} Python. Você pode obter a instância concreta de subclasse de @code{Distribution} para um pacote de distribuição instalado chamando a função @ref{47e3,,distribution()}:

@example
>>> from importlib.metadata import distribution
>>> dist = distribution('wheel')
>>> type(dist)
<class 'importlib.metadata.PathDistribution'>
@end example

Assim, uma forma alternativa de obter o número da versão é através da instância @code{Distribution}:

@example
>>> dist.version
'0.32.3'
@end example

Existem todos os tipos de metadados adicionais disponíveis em instâncias de @code{Distribution}:

@example
>>> dist.metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
>>> dist.metadata['License']
'MIT'
@end example

Para pacotes editáveis, uma propriedade @code{origin} pode apresentar metadados conforme a 
@geindex Propostas de Melhorias do Python; PEP 610
PEP 610@footnote{https://peps.python.org/pep-0610/}:

@example
>>> dist.origin.url
'file:///caminho/para/wheel-0.32.3.editable-py3-none-any.whl'
@end example

O conjunto completo de metadados disponíveis não é descrito aqui. Consulte a especificação de metadados principais do PyPA@footnote{https://packaging.python.org/pt_BR/latest/specifications/core-metadata/#core-metadata} para obter detalhes adicionais.


Adicionado na versão 3.13: A propriedade @code{.origin} foi adicionada.


@node Descoberta de distribuição,Estendendo o algoritmo de pesquisa,Distribuições,importlib metadata – Acessando metadados do pacote
@anchor{library/importlib metadata distribution-discovery}@anchor{47e5}
@subsubsection Descoberta de distribuição


Por padrão, este pacote fornece suporte embutido para descoberta de metadados para sistema de arquivos e arquivo zip Pacotes de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package}. Esta pesquisa do localizador de metadados tem como padrão @code{sys.path}, mas varia um pouco na maneira como ela interpreta esses valores em relação a outras mecanismo de importação. Em particular:


@itemize -

@item 
@code{importlib.metadata} não honra objetos @ref{1c2,,bytes} em @code{sys.path}.

@item 
@code{importlib.metadata} irá incidentalmente honrar objetos @ref{229,,pathlib.Path} em @code{sys.path} mesmo que tais valores sejam ignorados para importações.
@end itemize

@node Estendendo o algoritmo de pesquisa,,Descoberta de distribuição,importlib metadata – Acessando metadados do pacote
@anchor{library/importlib metadata extending-the-search-algorithm}@anchor{47e6}
@subsubsection Estendendo o algoritmo de pesquisa


Como os metadados de Pacote de Distribuição@footnote{https://packaging.python.org/pt_BR/latest/glossary/#term-Distribution-Package} não estão disponíveis por meio de pesquisas a @ref{3b4,,sys.path} ou carregadores de pacotes diretamente, os metadados de uma distribuição são encontrados através de @ref{2182,,localizadores} do sistema de importação. Para encontrar os metadados de um pacote de distribuição, @code{importlib.metadata} consulta a lista de @ref{10a9,,localizadores de metacaminho} em @ref{d4d,,sys.meta_path}.

Por padrão @code{importlib.metadata} instala um localizador para pacotes de distribuição encontrados no sistema de arquivos. Na verdade, esse localizador não encontra nenhuma `distribuição', mas pode encontrar seus metadados.

A classe abstrata @ref{872,,importlib.abc.MetaPathFinder} define a interface esperada dos localizadores pelo sistema de importação do Python. @code{importlib.metadata} estende este protocolo procurando por um chamável @code{find_distributions} opcional nos localizadores de @ref{d4d,,sys.meta_path} e apresenta esta interface estendida como a classe base abstrata @code{DistributionFinder}, que define este método abstrato:

@example
@@abc.abstractmethod
def find_distributions(context=DistributionFinder.Context()):
    """Return an iterable of all Distribution instances capable of
    loading the metadata for packages for the indicated `@w{`}context`@w{`}.
    """
@end example

O objeto @code{DistributionFinder.Context} fornece propriedades @code{.path} e @code{.name} indicando o caminho para pesquisar e o nome a ser correspondido e pode fornecer outro contexto relevante.

O que isso significa na prática é que para prover suporte à localização de metadados de pacotes de distribuição em outros locais fora do sistema de arquivos, crie uma subclasse @code{Distribution} e implemente os métodos abstratos. Então, a partir de um localizador personalizado, retorne instâncias deste derivado de @code{Distribution} no método @code{find_distributions()}.

@menu
* Exemplo: Exemplo<14>. 

@end menu

@node Exemplo<14>,,,Estendendo o algoritmo de pesquisa
@anchor{library/importlib metadata example}@anchor{47e7}
@subsubsection Exemplo


Considere, por exemplo, um localizador personalizado que carrega módulos Python de um banco de dados:

@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

Esse importador agora provavelmente fornece módulos importáveis de um banco de dados, mas não fornece metadados ou pontos de entrada. Para que este importador personalizado forneça metadados, ele também precisaria implementar @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

Desta forma, @code{query_distributions} retornaria registros para cada distribuição servida pelo banco de dados correspondente à consulta. Por exemplo, se @code{requests-1.0} estiver no banco de dados, @code{find_distributions} produziria um @code{DatabaseDistribution} para @code{Context(name='requests')} ou @code{Context(name=None)}.

Por uma questão de simplicidade, este exemplo ignora @code{context.path}. O atributo @code{path} tem como padrão @code{sys.path} e é o conjunto de caminhos de importação a serem considerados na pesquisa. Um @code{DatabaseImporter} poderia funcionar potencialmente sem qualquer preocupação com um caminho de pesquisa. Supondo que o importador não faça particionamento, o caminho “path” seria irrelevante. Para ilustrar o propósito de @code{path}, o exemplo precisaria ilustrar um @code{DatabaseImporter} mais complexo cujo comportamento variasse dependendo de @code{sys.path}/@code{PYTHONPATH}. Nesse caso, @code{find_distributions} deve respeitar o @code{context.path} e produzir apenas @code{Distribution}s pertinentes a esse caminho.

@code{DatabaseDistribution}, então, se pareceria com algo como:

@example
class DatabaseDistribution(importlib.metadata.Distribution):
    def __init__(self, record):
        self.record = record

    def read_text(self, filename):
        """
        Lê um arquivo como "METADATA" para a atual distribuição.
        """
        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

Esta implementação básica deve fornecer metadados e pontos de entrada para pacotes servidos pelo @code{DatabaseImporter}, presumindo que o @code{record} forneça os atributos @code{.name}, @code{.version} e @code{.entry_points} adequados.

O @code{DatabaseDistribution} também pode fornecer outros arquivos de metadados, como @code{RECORD} (necessário para @code{Distribution.files}) ou substituir a implementação de @code{Distribution.files}. Veja o código-fonte para mais inspiração.

@node A inicialização do caminho de pesquisa de módulos sys path,,importlib metadata – Acessando metadados do pacote,Importando módulos
@anchor{library/sys_path_init doc}@anchor{47e8}@anchor{library/sys_path_init sys-path-init}@anchor{1de6}@anchor{library/sys_path_init the-initialization-of-the-sys-path-module-search-path}@anchor{47e9}@anchor{library/sys_path_init translation-repo}@anchor{47ea}
@subsection A inicialização do caminho de pesquisa de módulos @code{sys.path}


Um caminho de pesquisa de módulos é inicializado quando o Python é iniciado. Este caminho de pesquisa de módulos pode ser acessado em @ref{3b4,,sys.path}.

A primeira entrada no caminho de pesquisa de módulos é o diretório que contém o script de entrada, se houver. Caso contrário, a primeira entrada é o diretório atual, que é o caso ao executar o console interativo, um comando com @ref{5e0,,-c} ou um módulo com @ref{5e1,,-m}.

A variável de ambiente 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} é frequentemente usada para adicionar diretórios ao caminho de pesquisa. Se esta variável de ambiente for encontrada, o conteúdo será adicionado ao caminho de pesquisa de módulos.

@cartouche
@quotation Nota 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} afetará todas as versões/ambientes Python instalados. Tenha cuidado ao definir isso em seu perfil do shell ou em variáveis de ambiente globais. O módulo @ref{c7,,site} oferece técnicas mais diferenciadas, conforme mencionado abaixo.
@end quotation
@end cartouche

Os próximos itens adicionados são os diretórios contendo módulos padrão do Python, bem como quaisquer @ref{47eb,,módulos de extensão} dos quais esses módulos dependem. Módulos de extensão são arquivos @code{.pyd} no Windows e arquivos @code{.so} em outras plataformas. O diretório com os módulos Python independentes de plataforma é chamado @code{prefix}. O diretório com os módulos de extensão é chamado @code{exec_prefix}.

A variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} pode ser usada para definir os locais @code{prefix} e @code{exec_prefix}. Caso contrário, esses diretórios serão encontrados usando o executável Python como ponto de partida e, em seguida, procurando por vários arquivos e diretórios “de referência”. Observe que todos os links simbólicos são seguidos para que o local real do executável do Python seja usado como ponto de partida da pesquisa. O local do executável do Python é chamado @code{home}.

Uma vez que @code{home} é determinado, o diretório @code{prefix} é encontrado procurando primeiro por @code{python`majorversion'`minorversion'.zip} (@code{python311.zip}). No Windows, o arquivo zip é procurado em @code{home} e no Unix espera-se que o arquivo esteja em @code{lib}. Observe que o local esperado do arquivo zip é adicionado ao caminho de pesquisa de módulos, mesmo que o arquivo não exista. Se nenhum arquivo for encontrado, o Python no Windows continuará a pesquisa por @code{prefix} procurando por @code{Lib\os.py}. Python no Unix procurará por @code{lib/python`majorversion'.`minorversion'/os.py} (@code{lib/python3.11/os.py}). No Windows, @code{prefix} e @code{exec_prefix} são iguais, porém em outras plataformas @code{lib/python`majorversion'.`minorversion'/lib-dynload} (@code{lib/python3.11/lib-dynload}) é pesquisado e usado como âncora para @code{exec_prefix}. Em algumas plataformas, @code{lib} pode ser @code{lib64} ou outro valor, veja @ref{93f,,sys.platlibdir} e 
@geindex PYTHONPLATLIBDIR
@geindex variável de ambiente; PYTHONPLATLIBDIR
@ref{1ab0,,PYTHONPLATLIBDIR}.

Uma vez encontrados, @code{prefix} e @code{exec_prefix} estão disponíveis em @ref{3b6,,sys.prefix} e @ref{3b2,,sys.exec_prefix}, respectivamente.

Finalmente, o módulo @ref{c7,,site} é processado e os diretórios @code{site-packages} são adicionados ao caminho de pesquisa de módulos. Uma maneira comum de personalizar o caminho de pesquisa é criar módulos @ref{c8,,sitecustomize} ou @ref{10e,,usercustomize} conforme descrito na documentação do módulo @ref{c7,,site}.

@cartouche
@quotation Nota 
Certas opções de linha de comando podem afetar ainda mais os cálculos de caminho. Veja @ref{964,,-E}, @ref{965,,-I}, @ref{13d5,,-s} e @ref{11e7,,-S} para mais detalhes.
@end quotation
@end cartouche

@menu
* Ambientes virtuais: Ambientes virtuais<2>. 
* Arquivos _pth:: 
* Python embarcado:: 

@end menu

@node Ambientes virtuais<2>,Arquivos _pth,,A inicialização do caminho de pesquisa de módulos sys path
@anchor{library/sys_path_init virtual-environments}@anchor{47ec}
@subsubsection Ambientes virtuais


Se Python for executado em um ambiente virtual (conforme descrito em @ref{1e83,,Ambientes virtuais e pacotes}), então @code{prefix} e @code{exec_prefix} são específicos para o ambiente virtual.

Se um arquivo @code{pyvenv.cfg} for encontrado juntamente com o principal executável, ou no diretório um nível acima do executável, as seguintes variações se aplicam:


@itemize *

@item 
Se @code{home} é um caminho absoluto e 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} não está definido, o caminho é usado ao invés do caminho ao principal executável quando deduzindo @code{prefix} e @code{exec_prefix}.
@end itemize

@node Arquivos _pth,Python embarcado,Ambientes virtuais<2>,A inicialização do caminho de pesquisa de módulos sys path
@anchor{library/sys_path_init pth-files}@anchor{47ed}
@subsubsection Arquivos _pth


Para substituir completamente @ref{3b4,,sys.path}, crie um arquivo @code{._pth} com o mesmo nome da biblioteca compartilhada ou executável (@code{python._pth} ou @code{python311._pth}). O caminho da biblioteca compartilhada é sempre conhecido no Windows, mas pode não estar disponível em outras plataformas. No arquivo @code{._pth}, especifique uma linha para cada caminho a ser adicionado a @ref{3b4,,sys.path}. O arquivo baseado no nome da biblioteca compartilhada substitui aquele baseado no executável, o que permite que os caminhos sejam restritos para qualquer programa que carregue o tempo de execução, se desejado.

Quando o arquivo existe, todos os registros e variáveis de ambiente são ignorados, o modo isolado é ativado, e @ref{c7,,site} não é importado a menos que uma linha do arquivo especifique @code{import site}. Caminhos em branco e linhas começando com @code{#} são ignorados. Cada caminho pode ser absoluto ou relativo ao local do arquivo. Instruções de importação diferente de @code{site} não são permitidas, e código arbitrário não pode ser especificado.

Note que arquivos @code{.pth} (sem o sublinhado no início) serão processados normalmente pelo módulo @ref{c7,,site} quando @code{import site} tiver sido especificado.

@node Python embarcado,,Arquivos _pth,A inicialização do caminho de pesquisa de módulos sys path
@anchor{library/sys_path_init embedded-python}@anchor{47ee}
@subsubsection Python embarcado


Se o Python estiver incorporado em outra aplicação, @ref{3c5,,Py_InitializeFromConfig()} e a estrutura @ref{3a6,,PyConfig} podem ser usados para inicializar o Python. Os detalhes específicos do caminho estão descritos em @ref{8b2,,Python Path Configuration}.


@subsubheading Ver também



@itemize *

@item 
@ref{c3b,,Encontrando módulos} para observações detalhadas do Windows.

@item 
@ref{1edd,,Utilizando Python em plataformas Unix} para detalhes do Unix.
@end itemize


@node Serviços da Linguagem Python,Serviços Específicos do MS Windows,Importando módulos,A Biblioteca Padrão do Python
@anchor{library/language doc}@anchor{47ef}@anchor{library/language language}@anchor{47f0}@anchor{library/language python-language-services}@anchor{47f1}@anchor{library/language translation-repo}@anchor{47f2}
@section Serviços da Linguagem Python


O Python fornece vários módulos para ajudar a trabalhar com a linguagem Python. Estes módulos suportam tokenizing, parsing, análise de sintaxe, disassembly de bytecode e várias outras facilidades.

Esses módulos incluem:

@menu
* ast — Árvores de Sintaxe Abstrata:: 
* symtable — Acesso a tabela de símbolos do compilador:: 
* token — Constantes usadas com árvores de análises do Python:: 
* keyword — Testando palavras reservadas do Python:: 
* tokenize — Tokenizador para código-fonte Python:: 
* tabnanny — Detecção de indentação ambígua:: 
* pyclbr — Suporte a navegador de módulos do Python:: 
* py_compile — Compila arquivos fonte do Python:: 
* compileall — Compilar bibliotecas do Python para bytecode:: 
* dis — Disassembler de bytecode do Python:: 
* pickletools — Ferramentas para desenvolvedores pickle:: 

@end menu

@node ast — Árvores de Sintaxe Abstrata,symtable — Acesso a tabela de símbolos do compilador,,Serviços da Linguagem Python
@anchor{library/ast doc}@anchor{47f3}@anchor{library/ast ast-abstract-syntax-trees}@anchor{47f4}@anchor{library/ast module-ast}@anchor{8}
@subsection @code{ast} — Árvores de Sintaxe Abstrata


@geindex module; ast

@c import ast

`Código-fonte:' Lib/ast.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/ast.py}


__________________________________________________________________


O módulo @ref{8,,ast} ajuda as aplicações Python a processar árvores da gramática de sintaxe abstrata do Python. A sintaxe abstrata em si pode mudar em cada lançamento do Python; este módulo ajuda a descobrir programaticamente como é a gramática atual.

Uma árvore de sintaxe abstrata pode ser gerada passando @ref{47f5,,ast.PyCF_ONLY_AST} como um sinalizador para a função embutida @ref{192,,compile()}, ou usando o auxiliar @ref{1a8,,parse()} fornecido neste módulo. O resultado será uma árvore de objetos cujas classes herdam de @ref{1a6,,ast.AST}. Uma árvore de sintaxe abstrata pode ser compilada em um objeto código Python usando a função embutida @ref{192,,compile()}.

@menu
* Gramática Abstrata:: 
* Classes de nós:: 
* Auxiliares de ast:: 
* Sinalizadores do compilador: Sinalizadores do compilador<2>. 
* Uso na linha de comando: Uso na linha de comando<9>. 

@end menu

@node Gramática Abstrata,Classes de nós,,ast — Árvores de Sintaxe Abstrata
@anchor{library/ast abstract-grammar}@anchor{47f6}@anchor{library/ast id1}@anchor{47f7}
@subsubsection Gramática Abstrata


A gramática abstrata está atualmente definida da seguinte forma:

@example
-- 4 tipos embutidos da ASDL são:
-- 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' indica que anotamos nome simples sem parênteses
          | AnnAssign(expr target, expr annotation, expr? value, int simple)

          -- usa 'orelse' porque else é uma palavra reservada em idiomas alvos
          | 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 é o deslocamente do bytes na string utf8 que o analisador sintático usa
          attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

          -- BoolOp() pode usar esquerda e direita?
    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)
         -- as restrições gramaticais onde yield expressions pode ocorrer
         | Await(expr value)
         | Yield(expr? value)
         | YieldFrom(expr value)
         -- precisa de sequências para comparar para distringuir entre
         -- 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)

         -- a expressão a seguir pode aparecer no contexto da atribuição
         | 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)

         -- pode aparecer apenas em subscrição
         | Slice(expr? lower, expr? upper, expr? step)

          -- col_offset é o deslocamente do bytes na string utf8 que o analisador sintático usa
          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)

    -- argumentos nomeados fornecidos à chamada (identificador NULL para **kwargs)
    keyword = (identifier? arg, expr value)
               attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    -- nomes de importação com o apelido opcional 'as'.
    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)
            -- O parâmetro opcional de MatchMapping "rest" lida com a captura de chaves extras de mapeamento

            | 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 Classes de nós,Auxiliares de ast,Gramática Abstrata,ast — Árvores de Sintaxe Abstrata
@anchor{library/ast node-classes}@anchor{47f8}
@subsubsection Classes de nós


@geindex AST (classe em ast)
@anchor{library/ast ast AST}@anchor{1a6}
@deffn {Classe} ast.AST

Esta é a base de todas as classes de nós de AST. As classes de nós reais são derivadas do arquivo @code{Parser/Python.asdl}, que é reproduzido @ref{47f6,,acima}. Elas são definidas no módulo C @code{_ast} e reexportadas no @ref{8,,ast}.

Há uma classe definida para cada símbolo do lado esquerdo na gramática abstrata (por exemplo, @code{ast.stmt} ou @code{ast.expr}). Além disso, existe uma classe definida para cada construtor no lado direito; essas classes herdam das classes para as árvores do lado esquerdo. Por exemplo, @ref{1b44,,ast.BinOp} herda de @code{ast.expr}. Para regras de produção com alternativas (“somas”), a classe do lado esquerdo é abstrata: apenas instâncias de nós construtores específicos são criadas.

@geindex ? (interrogação);em gramática de AST

@geindex * (asterisco);em gramática de AST

@geindex _fields (atributo ast.AST)
@anchor{library/ast ast AST _fields}@anchor{15e3}
@deffn {Atributo} _fields

Cada classe concreta possui um atributo @code{_fields} que fornece os nomes de todos os nós filhos.

Cada instância de uma classe concreta tem um atributo para cada nó filho, do tipo definido na gramática. Por exemplo, as instâncias @ref{1b44,,ast.BinOp} possuem um atributo @code{left} do tipo @code{ast.expr}.

Se estes atributos estiverem marcados como opcionais na gramática (usando um ponto de interrogação), o valor pode ser @code{None}. Se os atributos puderem ter valor zero ou mais (marcados com um asterisco), os valores serão representados como listas do Python. Todos os atributos possíveis devem estar presentes e ter valores válidos ao compilar uma AST com @ref{192,,compile()}.
@end deffn

@geindex _field_types (atributo ast.AST)
@anchor{library/ast ast AST _field_types}@anchor{1a7}
@deffn {Atributo} _field_types

O atributo @code{_field_types} em cada classe concreta é um dicionário que mapeia nomes de campos (como também listado em @ref{15e3,,_fields}) para seus tipos.

@example
>>> ast.TypeVar._field_types
@{'name': <class 'str'>, 'bound': ast.expr | None, 'default_value': ast.expr | None@}
@end example


Adicionado na versão 3.13.

@end deffn

@geindex lineno (atributo ast.AST)
@geindex col_offset (atributo ast.AST)
@geindex end_lineno (atributo ast.AST)
@geindex end_col_offset (atributo ast.AST)
@anchor{library/ast ast AST lineno}@anchor{47f9}
@deffn {Atributo} lineno
@anchor{library/ast ast AST col_offset}@anchor{47fa}
@deffnx {Atributo} col_offset
@anchor{library/ast ast AST end_lineno}@anchor{47fb}
@deffnx {Atributo} end_lineno
@anchor{library/ast ast AST end_col_offset}@anchor{47fc}
@deffnx {Atributo} end_col_offset

As instâncias das subclasses @code{ast.expr} e @code{ast.stmt} possuem os atributos @ref{47f9,,lineno}, @ref{47fa,,col_offset}, @ref{47fb,,end_lineno} e @ref{47fc,,end_col_offset}. O @ref{47f9,,lineno} e @ref{47fb,,end_lineno} são o primeiro e o último número de linha do intervalo do texto de origem (indexado em 1, para que a primeira linha seja a linha 1) e o @ref{47fa,,col_offset} e @ref{47fc,,end_col_offset} são os deslocamentos de byte UTF-8 correspondentes do primeiro e do último tokens que geraram o nó. O deslocamento UTF-8 é registrado porque o analisador sintático usa UTF-8 internamente.

Observe que as posições finais não são exigidas pelo compilador e, portanto, são opcionais. O deslocamento final está `após' o último símbolo, por exemplo, é possível obter o segmento de origem de um nó de expressão de uma linha usando @code{source_line[node.col_offset : node.end_col_offset]}.
@end deffn

O construtor de uma classe @code{ast.T} analisa seus argumentos da seguinte forma:


@itemize *

@item 
Se houver argumentos posicionais, deve haver tantos quanto houver itens em @code{T._fields}; eles serão atribuídos como atributos desses nomes.

@item 
Se houver argumentos nomeados, eles definirão os atributos dos mesmos nomes para os valores fornecidos.
@end itemize

Por exemplo, para criar e popular um nó @ref{47fd,,ast.UnaryOp}, você poderia usar

@example
node = ast.UnaryOp(ast.USub(), ast.Constant(5, lineno=0, col_offset=0),
                   lineno=0, col_offset=0)
@end example

Se um campo que é opcional na gramática for omitido do construtor, o padrão é @code{None}. Se um campo de lista for omitido, o padrão será a lista vazia. Se um campo do tipo @code{ast.expr_context} for omitido, o padrão é @ref{1a4,,Load()}. Se qualquer outro campo for omitido, uma @ref{1a5,,DeprecationWarning} será levantada e o nó AST não terá este campo. No Python 3.15, esta condição levantará um erro.
@end deffn


Alterado na versão 3.8: A classe @ref{2b9,,ast.Constant} é agora usada para todas as constantes.



Alterado na versão 3.9: Os índices simples são representados por seus valores, as fatias estendidas são representadas como tuplas.



Descontinuado desde a versão 3.8: Classes antigas @code{ast.Num}, @code{ast.Str}, @code{ast.Bytes}, @code{ast.NameConstant} e @code{ast.Ellipsis} ainda estão disponíveis, mas serão removidos em versões futuras do Python. Enquanto isso, instanciá-las retornará uma instância de uma classe diferente.



Descontinuado desde a versão 3.9: Classes antigas @code{ast.Index} e @code{ast.ExtSlice} ainda estão disponíveis, mas serão removidos em versões futuras do Python. Enquanto isso, instanciá-las retornará uma instância de uma classe diferente.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Versões anteriores do Python permitiam a criação de nós AST sem campos obrigatórios. Da mesma forma, os construtores do nó AST permitiam argumentos nomeados arbitrários que eram definidos como atributos do nó AST, mesmo que não correspondessem a nenhum dos campos do nó AST. Este comportamento foi descontinuado e será removido no Python 3.15.


@cartouche
@quotation Nota 
As descrições das classes de nós específicas exibidas aqui foram inicialmente adaptadas do fantástico projeto Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/en/latest/} e de todos os seus contribuidores.
@end quotation
@end cartouche

@menu
* Nós raízes:: 
* Literais: Literais<3>. 
* Variáveis:: 
* Expressões: Expressões<2>. 
* Instruções:: 
* Fluxo de controle:: 
* Correspondência de padrões:: 
* Anotações de tipos:: 
* Parâmetros de tipo:: 
* Definições de função e classe:: 
* Async e await:: 

@end menu

@node Nós raízes,Literais<3>,,Classes de nós
@anchor{library/ast ast-root-nodes}@anchor{47fe}@anchor{library/ast root-nodes}@anchor{47ff}
@subsubsection Nós raízes


@geindex Module (classe em ast)
@anchor{library/ast ast Module}@anchor{4800}
@deffn {Classe} ast.Module (body, type_ignores)

Um módulo Python, como @ref{22d3,,entrada de arquivo}. Tipo de nó gerado por @ref{1a8,,ast.parse()} com `mode' no padrão @code{"exec"}.

@code{body} é uma @ref{611,,list} das @ref{4801,,Instruções} do módulo.

@code{type_ignores} é uma @ref{611,,list} dos comentários de ignorar tipo do módulo; veja @ref{1a8,,ast.parse()} para mais detalhes.

@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 (classe em ast)
@anchor{library/ast ast Expression}@anchor{4802}
@deffn {Classe} ast.Expression (body)

Uma única @ref{22d9,,entrada de expressão} Python. Tipo de nó gerado por @ref{1a8,,ast.parse()} quando `mode' é @code{"eval"}.

@code{body} é um nó único, um dos @ref{4803,,tipos de expressão}.

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex Interactive (classe em ast)
@anchor{library/ast ast Interactive}@anchor{4804}
@deffn {Classe} ast.Interactive (body)

Uma única @ref{22d6,,entrada interativa}, como em @ref{16f,,Modo interativo}. Tipo de nó gerado por @ref{1a8,,ast.parse()} quando `mode' é @code{"single"}.

@code{body} é uma @ref{611,,list} de @ref{4801,,nós de instrução}.

@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 (classe em ast)
@anchor{library/ast ast FunctionType}@anchor{4805}
@deffn {Classe} ast.FunctionType (argtypes, returns)

Uma representação de comentários de tipo antigo para funções, já que as versões do Python anteriores a 3.5 não davam suporte às anotações da 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}. Tipo de nó gerado por @ref{1a8,,ast.parse()} quando `mode' é @code{"func_type"}.

Esses comentários de tipo ficariam assim:

@example
def sum_two_number(a, b):
    # tipo: (int, int) -> int
    return a + b
@end example

@code{argtypes} é uma @ref{611,,list} de @ref{4803,,nós de expressão}.

@code{returns} é um único @ref{4803,,nó de expressão}.

@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


Adicionado na versão 3.8.

@end deffn

@node Literais<3>,Variáveis,Nós raízes,Classes de nós
@anchor{library/ast literals}@anchor{4806}
@subsubsection Literais


@geindex Constant (classe em ast)
@anchor{library/ast ast Constant}@anchor{2b9}
@deffn {Classe} ast.Constant (value)

Um valor constante. O atributo @code{value} do literal @code{Constant} contém o objeto Python que ele representa. Os valores representados podem ser instâncias de @ref{44c,,str}, @ref{1c2,,bytes}, @ref{257,,int}, @ref{2f7,,float}, @ref{2f8,,complex} e @ref{468,,bool}, e as constantes @ref{675,,None} e @ref{231c,,Ellipsis}.

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex FormattedValue (classe em ast)
@anchor{library/ast ast FormattedValue}@anchor{4807}
@deffn {Classe} ast.FormattedValue (value, conversion, format_spec)

Nó que representa um único campo de formatação em uma f-string. Se a string contiver um único campo de formatação e nada mais, o nó poderá ser isolado, caso contrário ele aparecerá em @ref{17de,,JoinedStr}.


@itemize *

@item 
@code{value} é qualquer nó de expressão (como um literal, uma variável ou uma chamada de função).

@item 
@code{conversion} é um inteiro:


@itemize *

@item 
-1: sem formatação

@item 
115: @code{!s} formatação de string

@item 
114: @code{!r} formatação de repr

@item 
97: @code{!a} formatação ascii
@end itemize

@item 
@code{format_spec} é um nó @ref{17de,,JoinedStr} que representa a formatação do valor, ou @code{None} se nenhum formato foi especificado. Tanto @code{conversion} quanto @code{format_spec} podem ser configurados ao mesmo tempo.
@end itemize
@end deffn

@geindex JoinedStr (classe em ast)
@anchor{library/ast ast JoinedStr}@anchor{17de}
@deffn {Classe} ast.JoinedStr (values)

Uma f-string, compreendendo uma série de nós @ref{4807,,FormattedValue} e @ref{2b9,,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 (classe em ast)
@geindex Tuple (classe em ast)
@anchor{library/ast ast List}@anchor{4808}
@deffn {Classe} ast.List (elts, ctx)
@anchor{library/ast ast Tuple}@anchor{4809}
@deffnx {Classe} ast.Tuple (elts, ctx)

Uma lista ou tupla. @code{elts} contém uma lista de nós que representam os elementos. @code{ctx} é @ref{480a,,Store} se o contêiner for um alvo de atribuição (ou seja, @code{(x,y)=algumacoisa}), e @ref{1a4,,Load} caso contrário.

@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 (classe em ast)
@anchor{library/ast ast Set}@anchor{480b}
@deffn {Classe} ast.Set (elts)

Um conjunto. @code{elts} contém uma lista de nós que representam os elementos do conjunto.

@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 (classe em ast)
@anchor{library/ast ast Dict}@anchor{1ad6}
@deffn {Classe} ast.Dict (keys, values)

Um dicionário. @code{keys} e @code{values} contêm listas de nós que representam as chaves e os valores respectivamente, em ordem correspondente (o que seria retornado ao chamar @code{dictionary.keys()} e @code{dictionary.values()}).

Ao desempacotar o dicionário usando literais de dicionário, a expressão a ser expandida vai para a lista @code{values}, com um @code{None} na posição correspondente em @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 Variáveis,Expressões<2>,Literais<3>,Classes de nós
@anchor{library/ast variables}@anchor{480c}
@subsubsection Variáveis


@geindex Name (classe em ast)
@anchor{library/ast ast Name}@anchor{1aaf}
@deffn {Classe} ast.Name (id, ctx)

Um nome de variável. @code{id} contém o nome como uma string e @code{ctx} é um dos seguintes tipos.
@end deffn

@geindex Load (classe em ast)
@geindex Store (classe em ast)
@geindex Del (classe em ast)
@anchor{library/ast ast Load}@anchor{1a4}
@deffn {Classe} ast.Load
@anchor{library/ast ast Store}@anchor{480a}
@deffnx {Classe} ast.Store
@anchor{library/ast ast Del}@anchor{480d}
@deffnx {Classe} ast.Del

As referências de variáveis podem ser usadas para carregar o valor de uma variável, para atribuir um novo valor a ela ou para excluí-la. As referências de variáveis recebem um contexto para distinguir esses 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 (classe em ast)
@anchor{library/ast ast Starred}@anchor{480e}
@deffn {Classe} ast.Starred (value, ctx)

Uma referência de variável @code{*var}. @code{value} contém a variável, normalmente um nó @ref{1aaf,,Name}. Este tipo deve ser usado ao construir um nó @ref{480f,,Call} com @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 Expressões<2>,Instruções,Variáveis,Classes de nós
@anchor{library/ast ast-expressions}@anchor{4803}@anchor{library/ast expressions}@anchor{4810}
@subsubsection Expressões


@geindex Expr (classe em ast)
@anchor{library/ast ast Expr}@anchor{4811}
@deffn {Classe} ast.Expr (value)

Quando uma expressão, como uma chamada de função, aparece como uma instrução por si só com seu valor de retorno não usado ou armazenado, ela é encapsulada neste contêiner. @code{value} contém um dos outros nós nesta seção, um nó @ref{2b9,,Constant}, um @ref{1aaf,,Name}, um @ref{4812,,Lambda}, um @ref{4813,,Yield} ou @ref{4814,,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 (classe em ast)
@anchor{library/ast ast UnaryOp}@anchor{47fd}
@deffn {Classe} ast.UnaryOp (op, operand)

Uma operação unária. @code{op} é o operador e @code{operand} qualquer nó de expressão.
@end deffn

@geindex UAdd (classe em ast)
@geindex USub (classe em ast)
@geindex Not (classe em ast)
@geindex Invert (classe em ast)
@anchor{library/ast ast UAdd}@anchor{4815}
@deffn {Classe} ast.UAdd
@anchor{library/ast ast USub}@anchor{4816}
@deffnx {Classe} ast.USub
@anchor{library/ast ast Not}@anchor{4817}
@deffnx {Classe} ast.Not
@anchor{library/ast ast Invert}@anchor{4818}
@deffnx {Classe} ast.Invert

Tokens de operador unário. @ref{4817,,Not} é a palavra reservada @code{not}, @ref{4818,,Invert} é o 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 (classe em ast)
@anchor{library/ast ast BinOp}@anchor{1b44}
@deffn {Classe} ast.BinOp (left, op, right)

Uma operação binária (como adição ou divisão). @code{op} é o operador, e @code{left} e @code{right} são quaisquer nós de expressão.

@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 (classe em ast)
@geindex Sub (classe em ast)
@geindex Mult (classe em ast)
@geindex Div (classe em ast)
@geindex FloorDiv (classe em ast)
@geindex Mod (classe em ast)
@geindex Pow (classe em ast)
@geindex LShift (classe em ast)
@geindex RShift (classe em ast)
@geindex BitOr (classe em ast)
@geindex BitXor (classe em ast)
@geindex BitAnd (classe em ast)
@geindex MatMult (classe em ast)
@anchor{library/ast ast Add}@anchor{4819}
@deffn {Classe} ast.Add
@anchor{library/ast ast Sub}@anchor{481a}
@deffnx {Classe} ast.Sub
@anchor{library/ast ast Mult}@anchor{481b}
@deffnx {Classe} ast.Mult
@anchor{library/ast ast Div}@anchor{481c}
@deffnx {Classe} ast.Div
@anchor{library/ast ast FloorDiv}@anchor{481d}
@deffnx {Classe} ast.FloorDiv
@anchor{library/ast ast Mod}@anchor{481e}
@deffnx {Classe} ast.Mod
@anchor{library/ast ast Pow}@anchor{481f}
@deffnx {Classe} ast.Pow
@anchor{library/ast ast LShift}@anchor{4820}
@deffnx {Classe} ast.LShift
@anchor{library/ast ast RShift}@anchor{4821}
@deffnx {Classe} ast.RShift
@anchor{library/ast ast BitOr}@anchor{4822}
@deffnx {Classe} ast.BitOr
@anchor{library/ast ast BitXor}@anchor{4823}
@deffnx {Classe} ast.BitXor
@anchor{library/ast ast BitAnd}@anchor{4824}
@deffnx {Classe} ast.BitAnd
@anchor{library/ast ast MatMult}@anchor{4825}
@deffnx {Classe} ast.MatMult

Tokens de operador binário.
@end deffn

@geindex BoolOp (classe em ast)
@anchor{library/ast ast BoolOp}@anchor{4826}
@deffn {Classe} ast.BoolOp (op, values)

Uma operação booleana, ‘or’ ou ‘and’. @code{op} é @ref{4827,,Or} ou @ref{4828,,And}. @code{values} são os valores envolvidos. Operações consecutivas com o mesmo operador, como @code{a or b or c}, são recolhidas em um nó com vários valores.

Isso não inclui @code{not}, que é um @ref{47fd,,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 (classe em ast)
@geindex Or (classe em ast)
@anchor{library/ast ast And}@anchor{4828}
@deffn {Classe} ast.And
@anchor{library/ast ast Or}@anchor{4827}
@deffnx {Classe} ast.Or

Tokens de operador booleano.
@end deffn

@geindex Compare (classe em ast)
@anchor{library/ast ast Compare}@anchor{4829}
@deffn {Classe} ast.Compare (left, ops, comparators)

Uma comparação de dois ou mais valores. @code{left} é o primeiro valor na comparação, @code{ops} a lista de operadores e @code{comparators} a lista de valores após o primeiro elemento na comparação.

@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 (classe em ast)
@geindex NotEq (classe em ast)
@geindex Lt (classe em ast)
@geindex LtE (classe em ast)
@geindex Gt (classe em ast)
@geindex GtE (classe em ast)
@geindex Is (classe em ast)
@geindex IsNot (classe em ast)
@geindex In (classe em ast)
@geindex NotIn (classe em ast)
@anchor{library/ast ast Eq}@anchor{482a}
@deffn {Classe} ast.Eq
@anchor{library/ast ast NotEq}@anchor{482b}
@deffnx {Classe} ast.NotEq
@anchor{library/ast ast Lt}@anchor{482c}
@deffnx {Classe} ast.Lt
@anchor{library/ast ast LtE}@anchor{482d}
@deffnx {Classe} ast.LtE
@anchor{library/ast ast Gt}@anchor{482e}
@deffnx {Classe} ast.Gt
@anchor{library/ast ast GtE}@anchor{482f}
@deffnx {Classe} ast.GtE
@anchor{library/ast ast Is}@anchor{4830}
@deffnx {Classe} ast.Is
@anchor{library/ast ast IsNot}@anchor{4831}
@deffnx {Classe} ast.IsNot
@anchor{library/ast ast In}@anchor{4832}
@deffnx {Classe} ast.In
@anchor{library/ast ast NotIn}@anchor{4833}
@deffnx {Classe} ast.NotIn

Tokens de operador de comparação.
@end deffn

@geindex Call (classe em ast)
@anchor{library/ast ast Call}@anchor{480f}
@deffn {Classe} ast.Call (func, args, keywords)

Uma chamada de função. @code{func} é a função, que geralmente será um objeto @ref{1aaf,,Name} ou @ref{4834,,Attribute}. Dos argumentos:


@itemize *

@item 
@code{args} contém uma lista dos argumentos passados por posição.

@item 
@code{keywords} contém uma lista de objetos @ref{4835,,keyword} representando argumentos passados como nomeados.
@end itemize

Os argumentos @code{args} e @code{keywords} são opcionais e padrão para listas vazias.

@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 (classe em ast)
@anchor{library/ast ast keyword}@anchor{4835}
@deffn {Classe} ast.keyword (arg, value)

Um argumento nomeado para uma chamada de função ou definição de classe. @code{arg} é uma string bruta do nome do parâmetro, @code{value} é um nó para passar.
@end deffn

@geindex IfExp (classe em ast)
@anchor{library/ast ast IfExp}@anchor{4836}
@deffn {Classe} ast.IfExp (test, body, orelse)

Uma expressão como @code{a if b else c}. Cada campo contém um único nó, portanto, no exemplo a seguir, todos os três são nós @ref{1aaf,,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 (classe em ast)
@anchor{library/ast ast Attribute}@anchor{4834}
@deffn {Classe} ast.Attribute (value, attr, ctx)

Acesso a atributo como, por exemplo, @code{d.keys}. @code{value} é um nó, normalmente um @ref{1aaf,,Name}. @code{attr} é uma string simples fornecendo o nome do atributo, e @code{ctx} é @ref{1a4,,Load}, @ref{480a,,Store} ou @ref{480d,,Del} de acordo com como o atributo é acionado sobre.

@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 (classe em ast)
@anchor{library/ast ast NamedExpr}@anchor{4837}
@deffn {Classe} ast.NamedExpr (target, value)

Uma expressão nomeada. Este nó de AST é produzido pelo operador de expressões de atribuição (também conhecido como operador morsa). Ao contrário do nó @ref{4838,,Assign} no qual o primeiro argumento pode ser múltiplos nós, neste caso ambos @code{target} e @code{value} devem ser nós ú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


Adicionado na versão 3.8.

@end deffn

@menu
* Subscrição:: 
* Compreensões:: 

@end menu

@node Subscrição,Compreensões,,Expressões<2>
@anchor{library/ast subscripting}@anchor{4839}
@subsubsection Subscrição


@geindex Subscript (classe em ast)
@anchor{library/ast ast Subscript}@anchor{483a}
@deffn {Classe} ast.Subscript (value, slice, ctx)

Um subscrito, como @code{l[1]}. @code{value} é o objeto subscrito (geralmente sequência ou mapeamento). @code{slice} é um índice, fatia ou chave. Pode ser uma @ref{4809,,Tuple} e conter uma @ref{483b,,Slice}. @code{ctx} é @ref{1a4,,Load}, @ref{480a,,Store} ou @ref{480d,,Del} de acordo com a ação realizada com o subscrito.

@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 (classe em ast)
@anchor{library/ast ast Slice}@anchor{483b}
@deffn {Classe} ast.Slice (lower, upper, step)

Fatiamento regular (no formato @code{lower:upper} ou @code{lower:upper:step}). Pode ocorrer apenas dentro do campo `slice' de @ref{483a,,Subscript}, diretamente ou como um elemento de @ref{4809,,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 Compreensões,,Subscrição,Expressões<2>
@anchor{library/ast comprehensions}@anchor{483c}
@subsubsection Compreensões


@geindex ListComp (classe em ast)
@geindex SetComp (classe em ast)
@geindex GeneratorExp (classe em ast)
@geindex DictComp (classe em ast)
@anchor{library/ast ast ListComp}@anchor{483d}
@deffn {Classe} ast.ListComp (elt, generators)
@anchor{library/ast ast SetComp}@anchor{483e}
@deffnx {Classe} ast.SetComp (elt, generators)
@anchor{library/ast ast GeneratorExp}@anchor{483f}
@deffnx {Classe} ast.GeneratorExp (elt, generators)
@anchor{library/ast ast DictComp}@anchor{4840}
@deffnx {Classe} ast.DictComp (key, value, generators)

Lista e define compreensões, expressões geradoras e compreensões de dicionário. @code{elt} (ou @code{key} e @code{value}) é um único nó que representa a parte que será avaliada para cada item.

@code{generators} é uma lista de nós de @ref{4841,,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 (classe em ast)
@anchor{library/ast ast comprehension}@anchor{4841}
@deffn {Classe} ast.comprehension (target, iter, ifs, is_async)

Uma cláusula @code{for} em uma compreensão. @code{target} é a referência a ser usada para cada elemento - normalmente um nó @ref{1aaf,,Name} ou @ref{4809,,Tuple}. @code{iter} é o objeto sobre o qual iterar. @code{ifs} é uma lista de expressões de teste: cada cláusula @code{for} pode ter múltiplos @code{ifs}.

@code{is_async} indica que uma compreensão é assíncrona (usando um @code{async for} em vez de @code{for}). O valor é um número inteiro (0 ou 1).

@example
>>> print(ast.dump(ast.parse('[ord(c) for line in file for c in line]', mode='eval'),
...                indent=4)) # Várias compreensões em uma.
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)) # compreensão de gerador
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)) # compreensão de async
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 Instruções,Fluxo de controle,Expressões<2>,Classes de nós
@anchor{library/ast ast-statements}@anchor{4801}@anchor{library/ast statements}@anchor{4842}
@subsubsection Instruções


@geindex Assign (classe em ast)
@anchor{library/ast ast Assign}@anchor{4838}
@deffn {Classe} ast.Assign (targets, value, type_comment)

Uma atribuição. @code{targets} é uma lista de nós e @code{value} é um único nó.

Vários nós em @code{targets} representam a atribuição do mesmo valor a cada um. O desempacotamento é representada colocando uma @ref{4809,,Tuple} ou @ref{4808,,List} dentro de @code{targets}.

@geindex type_comment (atributo ast.Assign)
@anchor{library/ast ast Assign type_comment}@anchor{4843}
@deffn {Atributo} type_comment

@code{type_comment} é uma string opcional com a anotação de tipo como comentário.
@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 (classe em ast)
@anchor{library/ast ast AnnAssign}@anchor{4844}
@deffn {Classe} ast.AnnAssign (target, annotation, value, simple)

Uma atribuição com uma anotação de tipo. @code{target} é um nó único e pode ser uma classe @ref{1aaf,,Name}, @ref{4834,,Attribute} ou @ref{483a,,Subscript}. @code{annotation} é a anotação, como um nó @ref{2b9,,Constant} ou @ref{1aaf,,Name}. @code{value} é um único nó opcional.

@code{simple} é sempre 0 (indicando um alvo “complexo”) ou 1 (indicando um alvo “simples”). Um alvo “simples” consiste apenas em um nó @ref{1aaf,,Name} que não aparece entre parênteses; todos os outros alvos são considerados complexos. Apenas alvos simples aparecem no dicionário @code{__annotations__} de módulos e 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 (classe em ast)
@anchor{library/ast ast AugAssign}@anchor{4845}
@deffn {Classe} ast.AugAssign (target, op, value)

Atribuição aumentada, como @code{a += 1}. No exemplo a seguir, @code{target} é um nó @ref{1aaf,,Name} para @code{x} (com o contexto @ref{480a,,Store}), @code{op} é @ref{4819,,Add}, e @code{value} é uma @ref{2b9,,Constant} com valor para 1.

O atributo @code{target} não pode ser da classe @ref{4809,,Tuple} ou @ref{4808,,List}, diferentemente dos alvos de @ref{4838,,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 (classe em ast)
@anchor{library/ast ast Raise}@anchor{4846}
@deffn {Classe} ast.Raise (exc, cause)

Uma instrução @code{raise}. @code{exc} é o objeto de exceção a ser levantado, normalmente uma @ref{480f,,Call} ou @ref{1aaf,,Name}, ou @code{None} para um @code{raise} independente. @code{cause} é a parte opcional para @code{y} em @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 (classe em ast)
@anchor{library/ast ast Assert}@anchor{4847}
@deffn {Classe} ast.Assert (test, msg)

Uma asserção. @code{test} contém a condição, como um nó @ref{4829,,Compare}. @code{msg} contém a mensagem de falha.

@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 (classe em ast)
@anchor{library/ast ast Delete}@anchor{4848}
@deffn {Classe} ast.Delete (targets)

Representa uma instrução @code{del}. @code{targets} é uma lista de nós, como nós @ref{1aaf,,Name}, @ref{4834,,Attribute} ou @ref{483a,,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 (classe em ast)
@anchor{library/ast ast Pass}@anchor{4849}
@deffn {Classe} ast.Pass

Uma instrução @code{pass}.

@example
>>> print(ast.dump(ast.parse('pass'), indent=4))
Module(
    body=[
        Pass()])
@end example
@end deffn

@geindex TypeAlias (classe em ast)
@anchor{library/ast ast TypeAlias}@anchor{17d4}
@deffn {Classe} ast.TypeAlias (name, type_params, value)

Um @ref{454,,apelido de tipo} criado através da instrução @ref{438,,type}. @code{name} é o nome do apelido, @code{type_params} é uma lista de @ref{484a,,parâmetros de tipo}, e @code{value} é o valor do apelido do 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


Adicionado na versão 3.12.

@end deffn

Outras instruções que são aplicáveis apenas dentro de funções ou laços são descritas em outras seções.

@menu
* Importações:: 

@end menu

@node Importações,,,Instruções
@anchor{library/ast imports}@anchor{484b}
@subsubsection Importações


@geindex Import (classe em ast)
@anchor{library/ast ast Import}@anchor{484c}
@deffn {Classe} ast.Import (names)

Uma instrução de importação. @code{names} é uma lista de nós de @ref{1a00,,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 (classe em ast)
@anchor{library/ast ast ImportFrom}@anchor{484d}
@deffn {Classe} ast.ImportFrom (module, names, level)

Representa @code{from x import y}. @code{module} é uma string bruta do nome ‘from’, sem quaisquer pontos iniciais, ou @code{None} para instruções como @code{from . import foo}. @code{level} é um número inteiro que contém o nível da importação relativa (0 significa importação 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 (classe em ast)
@anchor{library/ast ast alias}@anchor{1a00}
@deffn {Classe} ast.alias (name, asname)

Ambos os parâmetros são strings brutas dos nomes. @code{asname} pode ser @code{None} se o nome normal for usado.

@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 Fluxo de controle,Correspondência de padrões,Instruções,Classes de nós
@anchor{library/ast control-flow}@anchor{484e}
@subsubsection Fluxo de controle


@cartouche
@quotation Nota 
Cláusulas opcionais como @code{else} são armazenadas como uma lista vazia se não estiverem presentes.
@end quotation
@end cartouche

@geindex If (classe em ast)
@anchor{library/ast ast If}@anchor{484f}
@deffn {Classe} ast.If (test, body, orelse)

Uma instrução @code{if}. @code{test} contém um único nó, como um nó @ref{4829,,Compare}. @code{body} e @code{orelse} contêm, cada um, uma lista de nós.

As cláusulas @code{elif} não têm uma representação especial no AST, mas aparecem como nós extras de @ref{484f,,If} dentro da seção @code{orelse} da cláusula 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 (classe em ast)
@anchor{library/ast ast For}@anchor{4850}
@deffn {Classe} ast.For (target, iter, body, orelse, type_comment)

Um laço @code{for}. @code{target} contém as variáveis às quais o laço atribui, como um único nó de @ref{1aaf,,Name}, @ref{4809,,Tuple}, @ref{4808,,List}, @ref{4834,,Attribute} ou @ref{483a,,Subscript}. @code{iter} contém o item a ser repetido, novamente como um único nó. @code{body} e @code{orelse} contêm listas de nós para executar. Aqueles em @code{orelse} são executados se o laço terminar normalmente, ao invés de através de uma instrução @code{break}.

@geindex type_comment (atributo ast.For)
@anchor{library/ast ast For type_comment}@anchor{4851}
@deffn {Atributo} type_comment

@code{type_comment} é uma string opcional com a anotação de tipo como comentário.
@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 (classe em ast)
@anchor{library/ast ast While}@anchor{4852}
@deffn {Classe} ast.While (test, body, orelse)

Um laço @code{while}. @code{test} contém a condição, como um nó de @ref{4829,,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 (classe em ast)
@geindex Continue (classe em ast)
@anchor{library/ast ast Break}@anchor{4853}
@deffn {Classe} ast.Break
@anchor{library/ast ast Continue}@anchor{4854}
@deffnx {Classe} ast.Continue

As instruções @code{break} e @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 (classe em ast)
@anchor{library/ast ast Try}@anchor{4855}
@deffn {Classe} ast.Try (body, handlers, orelse, finalbody)

Blocos @code{try}. Todos os atributos são uma lista de nós a serem executados, exceto @code{handlers}, que é uma lista de nós de @ref{4856,,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 (classe em ast)
@anchor{library/ast ast TryStar}@anchor{4857}
@deffn {Classe} ast.TryStar (body, handlers, orelse, finalbody)

Blocos @code{try} que são seguidos por cláusulas @code{except*}. Os atributos são os mesmos de @ref{4855,,Try}, mas os nós @ref{4856,,ExceptHandler} em @code{handlers} são interpretados como blocos @code{except*} em vez 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


Adicionado na versão 3.11.

@end deffn

@geindex ExceptHandler (classe em ast)
@anchor{library/ast ast ExceptHandler}@anchor{4856}
@deffn {Classe} ast.ExceptHandler (type, name, body)

Uma única cláusula @code{except}. @code{type} é o tipo de exceção que irá corresponder, normalmente um nó de @ref{1aaf,,Name} (ou @code{None} para uma cláusula abrangente @code{except:}). @code{name} é uma string bruta para o nome conter a exceção, ou @code{None} se a cláusula não tiver @code{as foo}. @code{body} é uma lista de nós.

@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 (classe em ast)
@anchor{library/ast ast With}@anchor{4858}
@deffn {Classe} ast.With (items, body, type_comment)

Um bloco @code{with}. @code{items} é uma lista de nós @ref{4859,,withitem} representando os gerenciadores de contexto, e @code{body} é o bloco indentado dentro do contexto.

@geindex type_comment (atributo ast.With)
@anchor{library/ast ast With type_comment}@anchor{485a}
@deffn {Atributo} type_comment

@code{type_comment} é uma string opcional com a anotação de tipo como comentário.
@end deffn
@end deffn

@geindex withitem (classe em ast)
@anchor{library/ast ast withitem}@anchor{4859}
@deffn {Classe} ast.withitem (context_expr, optional_vars)

Um único gerenciador de contexto em um bloco @code{with}. @code{context_expr} é o gerenciador de contexto, geralmente um nó de @ref{480f,,Call}. @code{optional_vars} é um @ref{1aaf,,Name}, @ref{4809,,Tuple} ou @ref{4808,,List} para a parte @code{as foo}, ou @code{None} se não for usado.

@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 Correspondência de padrões,Anotações de tipos,Fluxo de controle,Classes de nós
@anchor{library/ast pattern-matching}@anchor{485b}
@subsubsection Correspondência de padrões


@geindex Match (classe em ast)
@anchor{library/ast ast Match}@anchor{485c}
@deffn {Classe} ast.Match (subject, cases)

Uma instrução @code{match}. @code{subject} contém o assunto da correspondência (o objeto que está sendo comparado com os casos) e @code{cases} contém um iterável de nós de @ref{485d,,match_case} com os diferentes casos.


Adicionado na versão 3.10.

@end deffn

@geindex match_case (classe em ast)
@anchor{library/ast ast match_case}@anchor{485d}
@deffn {Classe} ast.match_case (pattern, guard, body)

Um padrão de caso único em uma instrução @code{match}. @code{pattern} contém o padrão de correspondência com o qual o assunto será comparado. Observe que os nós @ref{1a6,,AST} produzidos para padrões diferem daqueles produzidos para expressões, mesmo quando compartilham a mesma sintaxe.

O atributo @code{guard} contém uma expressão que será avaliada se o padrão corresponder ao assunto.

@code{body} contém uma lista de nós a serem executados se o padrão corresponder e o resultado da avaliação da expressão de guarda for verdadeiro.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchValue (classe em ast)
@anchor{library/ast ast MatchValue}@anchor{485e}
@deffn {Classe} ast.MatchValue (value)

Um literal de correspondência ou padrão de valor que é comparado por igualdade. @code{value} é um nó de expressão. Os nós de valor permitido são restritos conforme descrito na documentação da instrução de correspondência. Este padrão será bem-sucedido se o assunto da correspondência for igual ao valor avaliado.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchSingleton (classe em ast)
@anchor{library/ast ast MatchSingleton}@anchor{485f}
@deffn {Classe} ast.MatchSingleton (value)

Um padrão literal de correspondência que compara por identidade. @code{value} é o singleton a ser comparado com: @code{None}, @code{True} ou @code{False}. Este padrão será bem-sucedido se o assunto da correspondência for a constante fornecida.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchSequence (classe em ast)
@anchor{library/ast ast MatchSequence}@anchor{4860}
@deffn {Classe} ast.MatchSequence (patterns)

Um padrão de sequência de correspondência. @code{patterns} contém os padrões a serem comparados aos elementos do assunto se o assunto for uma sequência. Corresponde a uma sequência de comprimento variável se um dos subpadrões for um nó @code{MatchStar}, caso contrário corresponde a uma sequência de comprimento fixo.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchStar (classe em ast)
@anchor{library/ast ast MatchStar}@anchor{4861}
@deffn {Classe} ast.MatchStar (name)

Corresponde ao restante da sequência em um padrão de sequência de correspondência de comprimento variável. Se @code{name} não for @code{None}, uma lista contendo os elementos restantes da sequência será vinculada a esse nome se o padrão de sequência geral for bem-sucedido.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchMapping (classe em ast)
@anchor{library/ast ast MatchMapping}@anchor{4862}
@deffn {Classe} ast.MatchMapping (keys, patterns, rest)

Um padrão de mapeamento de correspondência. @code{keys} é uma sequência de nós de expressão. @code{patterns} é uma sequência correspondente de nós padrão. @code{rest} é um nome opcional que pode ser especificado para capturar os elementos restantes do mapeamento. As expressões-chave permitidas são restritas conforme descrito na documentação da instrução match.

Este padrão será bem-sucedido se o assunto for um mapeamento, todas as expressões-chave avaliadas estiverem presentes no mapeamento e o valor correspondente a cada chave corresponder ao subpadrão correspondente. Se @code{rest} não for @code{None}, um dict contendo os elementos de mapeamento restantes será vinculado a esse nome se o padrão de mapeamento geral for bem-sucedido.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchClass (classe em ast)
@anchor{library/ast ast MatchClass}@anchor{4863}
@deffn {Classe} ast.MatchClass (cls, patterns, kwd_attrs, kwd_patterns)

Um padrão de classe de correspondência. @code{cls} é uma expressão que fornece a classe nominal a ser correspondida. @code{patterns} é uma sequência de nós padrão a serem comparados com a sequência definida pela classe de atributos de correspondência de padrões. @code{kwd_attrs} é uma sequência de atributos adicionais a serem correspondidos (especificados como argumentos nomeados no padrão de classe), @code{kwd_patterns} são os padrões correspondentes (especificados como valores de argumentos nomeados no padrão de classe).

Esse padrão será bem-sucedido se o assunto for uma instância da classe indicada, todos os padrões posicionais corresponderem aos atributos correspondentes definidos pela classe e quaisquer atributos, passados como argumentos nomeados, especificados corresponderem ao seu padrão correspondente.

Nota: as classes podem definir uma propriedade que retorna self para corresponder um nó padrão à instância que está sendo correspondida. Vários tipos internos também são combinados dessa forma, conforme descrito na documentação da instrução match.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchAs (classe em ast)
@anchor{library/ast ast MatchAs}@anchor{4864}
@deffn {Classe} ast.MatchAs (pattern, name)

Uma correspondência “como padrão”, padrão de captura ou padrão curinga. @code{pattern} contém o padrão de correspondência com o qual o assunto será comparado. Se o padrão for @code{None}, o nó representa um padrão de captura (ou seja, um nome simples) e sempre terá sucesso.

O atributo @code{name} contém o nome que será vinculado se o padrão for bem-sucedido. Se @code{name} for @code{None}, @code{pattern} também deverá ser @code{None} e o nó representa o padrão curinga.

@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


Adicionado na versão 3.10.

@end deffn

@geindex MatchOr (classe em ast)
@anchor{library/ast ast MatchOr}@anchor{4865}
@deffn {Classe} ast.MatchOr (patterns)

Uma correspondência de “padrão ou”. Um “padrão ou” corresponde cada um de seus subpadrões com o assunto, até que um seja bem-sucedido. O “padrão ou” é então considerado bem-sucedido. Se nenhum dos subpadrões for bem-sucedido, o padrão or falhará. O atributo @code{patterns} contém uma lista de nós de padrões de correspondência que serão comparados com o assunto.

@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


Adicionado na versão 3.10.

@end deffn

@node Anotações de tipos,Parâmetros de tipo,Correspondência de padrões,Classes de nós
@anchor{library/ast type-annotations}@anchor{4866}
@subsubsection Anotações de tipos


@geindex TypeIgnore (classe em ast)
@anchor{library/ast ast TypeIgnore}@anchor{1896}
@deffn {Classe} ast.TypeIgnore (lineno, tag)

Um comentário @code{# type: ignore} localizado em `lineno'. `tag' é a tag opcional especificada pelo formato @code{# type: ignore <tag>}.

@example
>>> print(ast.dump(ast.parse('x = 1 # type: ignore', type_comments=True), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1))],
    type_ignores=[
        TypeIgnore(lineno=1, tag='@w{'})])
>>> print(ast.dump(ast.parse('x: bool = 1 # type: ignore[assignment]', type_comments=True), indent=4))
Module(
    body=[
        AnnAssign(
            target=Name(id='x', ctx=Store()),
            annotation=Name(id='bool', ctx=Load()),
            value=Constant(value=1),
            simple=1)],
    type_ignores=[
        TypeIgnore(lineno=1, tag='[assignment]')])
@end example

@cartouche
@quotation Nota 
Os nós @code{TypeIgnore} não são gerados quando o parâmetro `type_comments' está definido como @code{False} (padrão). Consulte @ref{1a8,,ast.parse()} para obter mais detalhes.
@end quotation
@end cartouche


Adicionado na versão 3.8.

@end deffn

@node Parâmetros de tipo,Definições de função e classe,Anotações de tipos,Classes de nós
@anchor{library/ast ast-type-params}@anchor{484a}@anchor{library/ast type-parameters}@anchor{4867}
@subsubsection Parâmetros de tipo


@ref{2b3,,Parâmetros de tipo} podem existir em classes, funções e apelidos de tipo.

@geindex TypeVar (classe em ast)
@anchor{library/ast ast TypeVar}@anchor{4868}
@deffn {Classe} ast.TypeVar (name, bound, default_value)

Uma @ref{15d,,typing.TypeVar}. @code{name} é o nome da variável de tipo. @code{bound} é o limite ou as restrições, se houver. Se @code{bound} for uma @ref{4809,,Tuple}, ele representa restrições; caso contrário, representa o limite. @code{default_value} é o valor padrão; se @code{TypeVar} não tiver padrão, este atributo será definido como @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


Adicionado na versão 3.12.



Alterado na versão 3.13: Adicionado o parâmetro `default_value'.

@end deffn

@geindex ParamSpec (classe em ast)
@anchor{library/ast ast ParamSpec}@anchor{4869}
@deffn {Classe} ast.ParamSpec (name, default_value)

Uma @ref{15e,,typing.ParamSpec}. @code{name} é o nome da especificação do parâmetro. @code{default_value} é o valor padrão; se @code{ParamSpec} não tiver padrão, este atributo será definido como @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=List(
                        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


Adicionado na versão 3.12.



Alterado na versão 3.13: Adicionado o parâmetro `default_value'.

@end deffn

@geindex TypeVarTuple (classe em ast)
@anchor{library/ast ast TypeVarTuple}@anchor{486a}
@deffn {Classe} ast.TypeVarTuple (name, default_value)

Uma @ref{15f,,typing.TypeVarTuple}. @code{name} é o nome da tupla da variável de tipo. @code{default_value} é o valor padrão; se @code{TypeVarTuple} não tiver padrão, este atributo será definido como @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


Adicionado na versão 3.12.



Alterado na versão 3.13: Adicionado o parâmetro `default_value'.

@end deffn

@node Definições de função e classe,Async e await,Parâmetros de tipo,Classes de nós
@anchor{library/ast function-and-class-definitions}@anchor{486b}
@subsubsection Definições de função e classe


@geindex FunctionDef (classe em ast)
@anchor{library/ast ast FunctionDef}@anchor{17fa}
@deffn {Classe} ast.FunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

Uma definição de função


@itemize *

@item 
@code{name} é uma string bruta do nome da função.

@item 
@code{args} é um nó @ref{486c,,arguments}.

@item 
@code{body} é a lista de nós dentro da função.

@item 
@code{decorator_list} é a lista de decoradores a serem aplicados, armazenados primeiro na parte externa (ou seja, o primeiro da lista será aplicado por último).

@item 
@code{returns} é a anotação de retorno.

@item 
@code{type_params} é uma lista de @ref{484a,,parâmetros de tipo}.
@end itemize

@geindex type_comment (atributo ast.FunctionDef)
@anchor{library/ast ast FunctionDef type_comment}@anchor{486d}
@deffn {Atributo} type_comment

@code{type_comment} é uma string opcional com a anotação de tipo como comentário.
@end deffn


Alterado na versão 3.12: Adicionado @code{type_params}.

@end deffn

@geindex Lambda (classe em ast)
@anchor{library/ast ast Lambda}@anchor{4812}
@deffn {Classe} ast.Lambda (args, body)

@code{lambda} é uma definição mínima de função que pode ser usada dentro de uma expressão. Ao contrário de @ref{17fa,,FunctionDef}, @code{body} contém um único nó.

@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 (classe em ast)
@anchor{library/ast ast arguments}@anchor{486c}
@deffn {Classe} ast.arguments (posonlyargs, args, vararg, kwonlyargs, kw_defaults, kwarg, defaults)

Os argumentos para uma função.


@itemize *

@item 
@code{posonlyargs}, @code{args} e @code{kwonlyargs} são listas de nós @ref{486e,,arg}.

@item 
@code{vararg} e @code{kwarg} são nós @ref{486e,,arg} únicos, referindo-se aos parâmetros @code{*args, **kwargs}.

@item 
@code{kw_defaults} é uma lista de valores padrão para argumentos somente-nomeados. Se um for @code{None}, o argumento correspondente é necessário.

@item 
@code{defaults} é uma lista de valores padrão para argumentos que podem ser passados posicionalmente. Se houver menos padrões, eles corresponderão aos últimos n argumentos.
@end itemize
@end deffn

@geindex arg (classe em ast)
@anchor{library/ast ast arg}@anchor{486e}
@deffn {Classe} ast.arg (arg, annotation, type_comment)

Um único argumento em uma lista. @code{arg} é uma string bruta do nome do argumento; @code{annotation} é sua anotação, como um nó @ref{1aaf,,Name}.

@geindex type_comment (atributo ast.arg)
@anchor{library/ast ast arg type_comment}@anchor{486f}
@deffn {Atributo} type_comment

@code{type_comment} é uma string opcional com a anotação de tipo como comentário
@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 (classe em ast)
@anchor{library/ast ast Return}@anchor{4870}
@deffn {Classe} ast.Return (value)

Uma instrução @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 (classe em ast)
@geindex YieldFrom (classe em ast)
@anchor{library/ast ast Yield}@anchor{4813}
@deffn {Classe} ast.Yield (value)
@anchor{library/ast ast YieldFrom}@anchor{4814}
@deffnx {Classe} ast.YieldFrom (value)

Uma expressão @code{yield} ou @code{yield from}. Por serem expressões, elas devem ser agrupadas em um nó @ref{4811,,Expr} se o valor enviado de volta não for usado.

@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 (classe em ast)
@geindex Nonlocal (classe em ast)
@anchor{library/ast ast Global}@anchor{4871}
@deffn {Classe} ast.Global (names)
@anchor{library/ast ast Nonlocal}@anchor{4872}
@deffnx {Classe} ast.Nonlocal (names)

Instruções @code{global} e @code{nonlocal}. @code{names} é uma lista de strings brutas.

@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 (classe em ast)
@anchor{library/ast ast ClassDef}@anchor{17f8}
@deffn {Classe} ast.ClassDef (name, bases, keywords, body, decorator_list, type_params)

Uma definição de classe


@itemize *

@item 
@code{name} é uma string bruta para o nome da classe

@item 
@code{bases} é uma lista de nós para classes base especificadas explicitamente.

@item 
@code{keywords} é uma lista de nós @ref{4835,,keyword}, principalmente para ‘metaclass’. Outras argumentos nomeados serão passadas para a metaclasse, conforme a 
@geindex Propostas de Melhorias do Python; PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}.

@item 
@code{body} é uma lista de nós que representam o código dentro da definição de classe.

@item 
@code{decorator_list} é uma lista de nós, como em @ref{17fa,,FunctionDef}.

@item 
@code{type_params} é uma lista de @ref{484a,,parâmetros 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


Alterado na versão 3.12: Adicionado @code{type_params}.

@end deffn

@node Async e await,,Definições de função e classe,Classes de nós
@anchor{library/ast async-and-await}@anchor{4873}
@subsubsection Async e await


@geindex AsyncFunctionDef (classe em ast)
@anchor{library/ast ast AsyncFunctionDef}@anchor{17f9}
@deffn {Classe} ast.AsyncFunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

Uma definição de função @code{async def}. Possui os mesmos campos que @ref{17fa,,FunctionDef}.


Alterado na versão 3.12: Adicionado @code{type_params}.

@end deffn

@geindex Await (classe em ast)
@anchor{library/ast ast Await}@anchor{4874}
@deffn {Classe} ast.Await (value)

Uma expressão @code{await}. @code{value} é o que ela espera. Válido apenas no corpo de um @ref{17f9,,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 (classe em ast)
@geindex AsyncWith (classe em ast)
@anchor{library/ast ast AsyncFor}@anchor{4875}
@deffn {Classe} ast.AsyncFor (target, iter, body, orelse, type_comment)
@anchor{library/ast ast AsyncWith}@anchor{4876}
@deffnx {Classe} ast.AsyncWith (items, body, type_comment)

Laços @code{async for} e gerenciadores de contexto @code{async with}. Eles têm os mesmos campos que @ref{4850,,For} e @ref{4858,,With}, respectivamente. Válido apenas no corpo de @ref{17f9,,AsyncFunctionDef}.
@end deffn

@cartouche
@quotation Nota 
Quando uma string é analisada por @ref{1a8,,ast.parse()}, os nós operadores (subclasses de @code{ast.operator}, @code{ast.unaryop}, @code{ast.cmpop}, @code{ast.boolop} e @code{ast.expr_context}) na árvore retornada serão singletons. As alterações em um serão refletidas em todas as outras ocorrências do mesmo valor (por exemplo, @ref{4819,,ast.Add}).
@end quotation
@end cartouche

@node Auxiliares de ast,Sinalizadores do compilador<2>,Classes de nós,ast — Árvores de Sintaxe Abstrata
@anchor{library/ast ast-helpers}@anchor{4877}
@subsubsection Auxiliares de @code{ast}


Além das classes de nós, o módulo @ref{8,,ast} define essas funções e classes utilitárias para percorrer árvores de sintaxe abstrata:

@geindex parse() (no módulo ast)
@anchor{library/ast ast parse}@anchor{1a8}
@deffn {Função} ast.parse (source, filename='<unknown>', mode='exec', *, type_comments=False, feature_version=None, optimize=-1)

Analisa a fonte como um nó AST. Equivalente a @code{compile(source, filename, mode, flags=FLAGS_VALUE, optimize=optimize)}, onde @code{FLAGS_VALUE} é @code{ast.PyCF_ONLY_AST} se @code{optimize <= 0} e @code{ast.PyCF_OPTIMIZED_AST} caso contrário.

Se @code{type_comments=True} é fornecido, o analisador é modificado para verificar e retornar comentários do tipo, conforme especificado por 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}. Isso é equivalente a adicionar @ref{4878,,ast.PyCF_TYPE_COMMENTS} aos sinalizadores passados para @ref{192,,compile()}. Isso relatará erros de sintaxe para comentários do tipo extraviado. Sem esse sinalizador, os comentários do tipo serão ignorados e o campo @code{type_comment} nos nós AST selecionados sempre será @code{None}. Além disso, os locais dos comentários @code{# type: ignore} serão retornados como o atributo @code{type_ignores} de @ref{4800,,Module} (caso contrário, é sempre uma lista vazia).

Além disso, se @code{mode} for @code{'func_type'}, a sintaxe de entrada é modificada para corresponder a “comentários de tipo de assinatura” de 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, por exemplo, @code{(str, int) -> List[str]}.

Definir @code{feature_version} como uma tupla @code{(major, minor)} resultará em uma tentativa de “melhor esforço” de análise usando a gramática daquela versão do Python. Por exemplo, definir @code{feature_version=(3, 9)} tentará proibir a análise de instruções @ref{810,,match}. Atualmente @code{major} deve ser igual a @code{3}. A versão mais baixa suportada é @code{(3, 7)} (e isso pode aumentar em versões futuras do Python); o mais alto é @code{sys.version_info[0:2]}. A tentativa de “melhor esforço” significa que não há garantia de que a análise (ou sucesso da análise) seja a mesma que quando executada na versão Python correspondente a @code{feature_version}.

Se a fonte contém um caractere nulo (@code{\0}), @ref{202,,ValueError} é levantada.

@cartouche
@quotation Aviso 
Observe que a análise bem-sucedida do código-fonte em um objeto AST não garante que o código-fonte fornecido seja um código Python válido que pode ser executado, pois a etapa de compilação pode levantar mais exceções @ref{18d,,SyntaxError}. Por exemplo, a fonte @code{return 42} gera um nó AST válido para uma instrução return, mas não pode ser compilado sozinho (precisa estar dentro de um nó de função).

Em particular, @ref{1a8,,ast.parse()} não fará nenhuma verificação de escopo, o que a etapa de compilação faz.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
É possível travar o interpretador Python com uma string suficientemente grande/complexa devido às limitações de profundidade da pilha no compilador de AST do Python.
@end quotation
@end cartouche


Alterado na versão 3.8: Adicionado @code{type_comments}, @code{mode='func_type'} e @code{feature_version}.



Alterado na versão 3.13: A versão mínima suportada para @code{feature_version} agora é @code{(3, 7)}. O argumento @code{optimize} foi adicionado.

@end deffn

@geindex unparse() (no módulo ast)
@anchor{library/ast ast unparse}@anchor{8eb}
@deffn {Função} ast.unparse (ast_obj)

Desfaz análise de um objeto @ref{1a6,,ast.AST} e gera uma string com código que produziria um objeto @ref{1a6,,ast.AST} equivalente se analisado novamente com @ref{1a8,,ast.parse()}.

@cartouche
@quotation Aviso 
A string de código produzida não será necessariamente igual ao código original que gerou o objeto @ref{1a6,,ast.AST} (sem quaisquer otimizações do compilador, como tuplas/frozensets constantes).
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
Tentar desfazer análise de uma expressão altamente complexa resultaria em @ref{d90,,RecursionError}.
@end quotation
@end cartouche


Adicionado na versão 3.9.

@end deffn

@geindex literal_eval() (no módulo ast)
@anchor{library/ast ast literal_eval}@anchor{c32}
@deffn {Função} ast.literal_eval (node_or_string)

Avalia um nó de expressão ou uma string contendo apenas um literal Python ou uma exibição de contêiner. A string ou nó fornecido pode consistir apenas nas seguintes estruturas literais Python: strings, bytes, números, tuplas, listas, dicionários, conjuntos, booleanos, @code{None} e @code{Ellipsis}.

Isso pode ser usado para avaliar strings contendo valores Python sem a necessidade de analisar os valores por conta própria. Não é capaz de avaliar expressões arbitrariamente complexas, por exemplo, envolvendo operadores ou indexação.

Esta função foi documentada como “segura” no passado sem definir o que isso significava. Isso foi enganoso. Isso foi projetado especificamente para não executar código Python, ao contrário do @ref{180,,eval()} mais geral. Não há espaço de nomes, pesquisas de nome ou capacidade de chamada. Mas não está livre de ataques: uma entrada relativamente pequena pode levar ao esgotamento da memória ou ao esgotamento da pilha C, travando o processo. Também existe a possibilidade de negação de serviço por consumo excessivo de CPU em algumas entradas. Portanto, não é recomendado chamá-la em dados não confiáveis.

@cartouche
@quotation Aviso 
É possível travar o interpretador Python devido às limitações de profundidade da pilha no compilador AST do Python.

Pode levantar @ref{202,,ValueError}, @ref{2c3,,TypeError}, @ref{18d,,SyntaxError}, @ref{15c5,,MemoryError} e @ref{d90,,RecursionError} dependendo da entrada malformada.
@end quotation
@end cartouche


Alterado na versão 3.2: Agora permite bytes e literais de conjuntos.



Alterado na versão 3.9: Agora oferece suporte à criação de conjuntos vazios com @code{'set()'}.



Alterado na versão 3.10: Para entradas de string, os espaços iniciais e tabulações agora são removidos.

@end deffn

@geindex get_docstring() (no módulo ast)
@anchor{library/ast ast get_docstring}@anchor{1bd4}
@deffn {Função} ast.get_docstring (node, clean=True)

Retorna a docstring do `node' dado (que deve ser um nó @ref{17fa,,FunctionDef}, @ref{17f9,,AsyncFunctionDef}, @ref{17f8,,ClassDef} ou @ref{4800,,Module}) ou @code{None} se não tiver uma docstring. Se `clean' for verdadeiro, limpa o recuo da docstring com @ref{17a8,,inspect.cleandoc()}.


Alterado na versão 3.5: Não há suporte a @ref{17f9,,AsyncFunctionDef}.

@end deffn

@geindex get_source_segment() (no módulo ast)
@anchor{library/ast ast get_source_segment}@anchor{9e0}
@deffn {Função} ast.get_source_segment (source, node, *, padded=False)

Obtém o segmento de código-fonte do `source' que gerou o `node'. Se alguma informação de localização (@ref{47f9,,lineno}, @ref{47fb,,end_lineno}, @ref{47fa,,col_offset} ou @ref{47fc,,end_col_offset}) está faltando, retorna @code{None}.

Se `padded' for @code{True}, a primeira linha de uma instrução multilinha será preenchida com espaços para corresponder à sua posição original.


Adicionado na versão 3.8.

@end deffn

@geindex fix_missing_locations() (no módulo ast)
@anchor{library/ast ast fix_missing_locations}@anchor{4879}
@deffn {Função} ast.fix_missing_locations (node)

Quando você compila uma árvore de nós com @ref{192,,compile()}, o compilador espera atributos @ref{47f9,,lineno} e @ref{47fa,,col_offset} para cada nó que os suporta. Isso é tedioso para preencher nós gerados, portanto, esse auxiliar adiciona esses atributos recursivamente, onde ainda não estão definidos, definindo-os para os valores do nó pai. Ele funciona recursivamente a partir do `node'.
@end deffn

@geindex increment_lineno() (no módulo ast)
@anchor{library/ast ast increment_lineno}@anchor{1895}
@deffn {Função} ast.increment_lineno (node, n=1)

Incrementa o número da linhas e o número da linha final de cada nó na árvore começando em `node' em `n'. Isso é útil para “mover código” para um local diferente em um arquivo.
@end deffn

@geindex copy_location() (no módulo ast)
@anchor{library/ast ast copy_location}@anchor{487a}
@deffn {Função} ast.copy_location (new_node, old_node)

Copia o local de origem (@ref{47f9,,lineno}, @ref{47fa,,col_offset}, @ref{47fb,,end_lineno} e @ref{47fc,,end_col_offset}) de `old_node' para `new_node' se possível e, então, retorna `new_node'.
@end deffn

@geindex iter_fields() (no módulo ast)
@anchor{library/ast ast iter_fields}@anchor{487b}
@deffn {Função} ast.iter_fields (node)

Produz uma tupla de @code{(fieldname, value)} para cada campo em @code{node._fields} que esteja presente em `node'.
@end deffn

@geindex iter_child_nodes() (no módulo ast)
@anchor{library/ast ast iter_child_nodes}@anchor{487c}
@deffn {Função} ast.iter_child_nodes (node)

Produz todos os nós filhos diretos de `node', ou seja, todos os campos que são nós e todos os itens de campos que são listas de nós.
@end deffn

@geindex walk() (no módulo ast)
@anchor{library/ast ast walk}@anchor{487d}
@deffn {Função} ast.walk (node)

Produz recursivamente todos os nós descendentes na árvore começando em `node' (incluindo o próprio `node'), em nenhuma ordem especificada. Isso é útil se você quiser apenas modificar nós no lugar e não se importar com o contexto.
@end deffn

@geindex NodeVisitor (classe em ast)
@anchor{library/ast ast NodeVisitor}@anchor{a77}
@deffn {Classe} ast.NodeVisitor

Uma classe base de visitante de nó que percorre a árvore de sintaxe abstrata e chama uma função de visitante para cada nó encontrado. Esta função pode retornar um valor que é encaminhado pelo método @ref{487e,,visit()}.

Esta classe deve ser uma subclasse, com a subclasse adicionando métodos visitantes.

@geindex visit() (método ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor visit}@anchor{487e}
@deffn {Método} visit (node)

Visita um nó. A implementação padrão chama o método chamado @code{self.visit_@var{nomedaclasse}} sendo `nomedaclasse' o nome da classe do nó, ou @ref{487f,,generic_visit()} se aquele método não existir.
@end deffn

@geindex generic_visit() (método ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor generic_visit}@anchor{487f}
@deffn {Método} generic_visit (node)

Este visitante chama @ref{487e,,visit()} em todos os filhos do nó.

Observe que nós filhos de nós que possuem um método de visitante personalizado não serão visitados, a menos que o visitante chame @ref{487f,,generic_visit()} ou os visite por conta própria.
@end deffn

@geindex visit_Constant() (método ast.NodeVisitor)
@anchor{library/ast ast NodeVisitor visit_Constant}@anchor{a78}
@deffn {Método} visit_Constant (node)

Manipula todos os nós constantes.
@end deffn

Não use o @ref{a77,,NodeVisitor} se você quiser aplicar mudanças nos nós durante a travessia. Para isso existe um visitante especial (@ref{4880,,NodeTransformer}) que permite modificações.


Descontinuado desde a versão 3.8: Os métodos @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()}, @code{visit_NameConstant()} e @code{visit_Ellipsis()} estão agora descontinuados e não serão chamados em futuras versões do Python. Adicione um método @ref{a78,,visit_Constant()} para lidar com nós de constantes.

@end deffn

@geindex NodeTransformer (classe em ast)
@anchor{library/ast ast NodeTransformer}@anchor{4880}
@deffn {Classe} ast.NodeTransformer

A subclasse @ref{a77,,NodeVisitor} que percorre a árvore de sintaxe abstrata e permite a modificação de nós.

O @ref{4880,,NodeTransformer} percorrerá a AST e usará o valor de retorno dos métodos do visitante para substituir ou remover o nó antigo. Se o valor de retorno do método visitante for @code{None}, o nó será removido de seu local, caso contrário, ele será substituído pelo valor de retorno. O valor de retorno pode ser o nó original, caso em que não há substituição.

Aqui está um exemplo de transformador que rescreve todas as ocorrências de procuras por nome (@code{foo}) para @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

Tenha em mente que, se o nó em que você está operando tiver nós filhos, você deve transformar os nós filhos por conta própria ou chamar o método @ref{487f,,generic_visit()} para o nó primeiro.

Para nós que faziam parte de uma coleção de instruções (que se aplica a todos os nós de instrução), o visitante também pode retornar uma lista de nós em vez de apenas um único nó.

Se @ref{4880,,NodeTransformer} introduz novos nós (que não faziam parte da árvore original) sem fornecer informações de localização (como @ref{47f9,,lineno}), @ref{4879,,fix_missing_locations()} deve ser chamado com o novo subárvore para recalcular as informações de localização:

@example
tree = ast.parse('foo', mode='eval')
new_tree = fix_missing_locations(RewriteName().visit(tree))
@end example

Normalmente você usa o transformador assim:

@example
node = YourTransformer().visit(node)
@end example
@end deffn

@geindex dump() (no módulo ast)
@anchor{library/ast ast dump}@anchor{8ea}
@deffn {Função} ast.dump (node, annotate_fields=True, include_attributes=False, *, indent=None, show_empty=False)

Retorne um despejo formatado da árvore em `node'. Isso é útil principalmente para fins de depuração. Se `annotate_fields' for verdadeiro (por padrão), a sequência retornada mostrará os nomes e os valores para os campos. Se `annotate_fields' for falso, a sequência de resultados será mais compacta ao omitir nomes de campos não ambíguos. Atributos como números de linha e deslocamentos de coluna não são despejados por padrão. Se isso for desejado, `include_attributes' pode ser definido como verdadeiro.

Se `indent' for um inteiro não negativo ou uma string, então a árvore terá uma saída formatada com este nível de indentação. Um nível de indentação 0, negativo ou @code{""} apenas colocará novas linhas. @code{None} (o padrão) seleciona a representação de uma única linha. Usando um inteiro positivo a indentação terá alguns espaços por nível. Se `indent' for uma string (como @code{"\t"}), essa string será usada para indentar cada nível.

Se `show_empty' for falso (o padrão), listas vazias opcionais serão omitidas da saída. Valores opcionais @code{None} são sempre omitidos.


Alterado na versão 3.9: Adicionada a opção `indent'.



Alterado na versão 3.13: Adicionada a opção `show_empty'.

@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 Sinalizadores do compilador<2>,Uso na linha de comando<9>,Auxiliares de ast,ast — Árvores de Sintaxe Abstrata
@anchor{library/ast ast-compiler-flags}@anchor{22fc}@anchor{library/ast compiler-flags}@anchor{4881}
@subsubsection Sinalizadores do compilador


Os seguintes sinalizadores podem ser passados para @ref{192,,compile()} para alterar os efeitos na compilação de um programa:

@geindex PyCF_ALLOW_TOP_LEVEL_AWAIT (no módulo ast)
@anchor{library/ast ast PyCF_ALLOW_TOP_LEVEL_AWAIT}@anchor{4882}
@deffn {Dado} ast.PyCF_ALLOW_TOP_LEVEL_AWAIT

Habilita suporte para @code{await}, @code{async for}, @code{async with} e compreensões assíncronas de nível superior.


Adicionado na versão 3.8.

@end deffn

@geindex PyCF_ONLY_AST (no módulo ast)
@anchor{library/ast ast PyCF_ONLY_AST}@anchor{47f5}
@deffn {Dado} ast.PyCF_ONLY_AST

Gera e retorna uma árvore de sintaxe abstrata em vez de retornar um objeto de código compilado.
@end deffn

@geindex PyCF_OPTIMIZED_AST (no módulo ast)
@anchor{library/ast ast PyCF_OPTIMIZED_AST}@anchor{4883}
@deffn {Dado} ast.PyCF_OPTIMIZED_AST

O AST retornado é otimizado de acordo com o argumento `optimize' em @ref{192,,compile()} ou @ref{1a8,,ast.parse()}.


Adicionado na versão 3.13.

@end deffn

@geindex PyCF_TYPE_COMMENTS (no módulo ast)
@anchor{library/ast ast PyCF_TYPE_COMMENTS}@anchor{4878}
@deffn {Dado} ast.PyCF_TYPE_COMMENTS

Habilita suporte para comentários do tipo 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} (@code{# type: <type>}, @code{# type: ignore <stuff>}).


Adicionado na versão 3.8.

@end deffn

@node Uso na linha de comando<9>,,Sinalizadores do compilador<2>,ast — Árvores de Sintaxe Abstrata
@anchor{library/ast ast-cli}@anchor{4884}@anchor{library/ast command-line-usage}@anchor{4885}
@subsubsection Uso na linha de comando



Adicionado na versão 3.9.


O módulo @ref{8,,ast} pode ser executado como um script na linha de comando. É tão simples quanto:

@example
python -m ast [-m <mode>] [-a] [infile]
@end example

As seguintes opções são aceitas:

@geindex ast opção de linha de comando; -h
@geindex ast opção de linha de comando; --help
@anchor{library/ast cmdoption-ast-h}@anchor{4886}@anchor{library/ast cmdoption-ast-help}@anchor{4887}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Mostra a mensagem de ajuda e sai.
@end deffn

@geindex ast opção de linha de comando; -m
@geindex ast opção de linha de comando; --mode
@anchor{library/ast cmdoption-ast-m}@anchor{4888}
@deffn {Option} @w{-}m <mode>
@anchor{library/ast cmdoption-ast-mode}@anchor{4889}
@deffnx {Option} @w{-}@w{-}mode <mode>

Especifica que tipo de código deve ser compilado, como o argumento `mode' em @ref{1a8,,parse()}.
@end deffn

@geindex ast opção de linha de comando; --no-type-comments
@anchor{library/ast cmdoption-ast-no-type-comments}@anchor{488a}
@deffn {Option} @w{-}@w{-}no@w{-}type@w{-}comments

Não analisa comentários de tipo.
@end deffn

@geindex ast opção de linha de comando; -a
@geindex ast opção de linha de comando; --include-attributes
@anchor{library/ast cmdoption-ast-a}@anchor{488b}@anchor{library/ast cmdoption-ast-include-attributes}@anchor{488c}
@deffn {Option} @w{-}a, @w{-}@w{-}include@w{-}attributes

Inclui atributos como números de linha e deslocamentos de colunas.
@end deffn

@geindex ast opção de linha de comando; -i
@geindex ast opção de linha de comando; --indent
@anchor{library/ast cmdoption-ast-i}@anchor{488d}
@deffn {Option} @w{-}i <indent>
@anchor{library/ast cmdoption-ast-indent}@anchor{488e}
@deffnx {Option} @w{-}@w{-}indent <indent>

indentação de nós em AST (número de espaços).
@end deffn

Se @code{infile} for especificado, seu conteúdo será analisado no AST e despejado no stdout. Caso contrário, o conteúdo será lido em stdin.


@subsubheading Ver também


Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/}, um recurso de documentação externo, possui bons detalhes sobre trabalhar com ASTs do Python.

ASTTokens@footnote{https://asttokens.readthedocs.io/en/latest/user-guide.html} anota ASTs do Python com as posições de tokens e texto no código-fonte que as gerou. Isso é útil para ferramentas que fazem transformações de código-fonte.

leoAst.py@footnote{https://leo-editor.github.io/leo-editor/appendices.html#leoast-py} unifica as visualizações baseadas em token e em árvore de análise de programas python, inserindo links duas vias entre tokens e nós de ast.

LibCST@footnote{https://libcst.readthedocs.io/} analisa o código como uma árvore de sintaxe concreta que se parece com uma árvore ast e mantém todos os detalhes de formatação. É útil para construir linters e aplicações de refatoração automatizada (codemod).

Parso@footnote{https://parso.readthedocs.io} é um analisador Python que oferece suporte a recuperação de erros e análise de ida e volta para diferentes versões do Python (em várias versões do Python). Parso também é capaz de listar vários erros de sintaxe em seu arquivo Python.


@node symtable — Acesso a tabela de símbolos do compilador,token — Constantes usadas com árvores de análises do Python,ast — Árvores de Sintaxe Abstrata,Serviços da Linguagem Python
@anchor{library/symtable doc}@anchor{488f}@anchor{library/symtable module-symtable}@anchor{d8}@anchor{library/symtable symtable-access-to-the-compiler-s-symbol-tables}@anchor{4890}@anchor{library/symtable translation-repo}@anchor{4891}
@subsection @code{symtable} — Acesso a tabela de símbolos do compilador


@geindex module; symtable

`Código-fonte:' Lib/symtable.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/symtable.py}


__________________________________________________________________


Symbol tables are generated by the compiler from AST just before bytecode is
generated.  The symbol table is responsible for calculating the scope of every
identifier in the code.  @ref{d8,,symtable} provides an interface to examine these
tables.

@menu
* Generating Symbol Tables:: 
* Examining Symbol Tables:: 
* Uso na linha de comando: Uso na linha de comando<10>. 

@end menu

@node Generating Symbol Tables,Examining Symbol Tables,,symtable — Acesso a tabela de símbolos do compilador
@anchor{library/symtable generating-symbol-tables}@anchor{4892}
@subsubsection Generating Symbol Tables


@geindex symtable() (no módulo symtable)
@anchor{library/symtable symtable symtable}@anchor{1b64}
@deffn {Função} symtable.symtable (code, filename, compile_type)

Return the toplevel @ref{4893,,SymbolTable} for the Python source `code'.
`filename' is the name of the file containing the code.  `compile_type' is
like the `mode' argument to @ref{192,,compile()}.
@end deffn

@node Examining Symbol Tables,Uso na linha de comando<10>,Generating Symbol Tables,symtable — Acesso a tabela de símbolos do compilador
@anchor{library/symtable examining-symbol-tables}@anchor{4894}
@subsubsection Examining Symbol Tables


@geindex SymbolTableType (classe em symtable)
@anchor{library/symtable symtable SymbolTableType}@anchor{16f8}
@deffn {Classe} symtable.SymbolTableType

An enumeration indicating the type of a @ref{4893,,SymbolTable} object.

@geindex MODULE (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType MODULE}@anchor{4895}
@deffn {Atributo} MODULE = "module"

Used for the symbol table of a module.
@end deffn

@geindex FUNCTION (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType FUNCTION}@anchor{4896}
@deffn {Atributo} FUNCTION = "function"

Used for the symbol table of a function.
@end deffn

@geindex CLASS (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType CLASS}@anchor{4897}
@deffn {Atributo} CLASS = "class"

Used for the symbol table of a class.
@end deffn

The following members refer to different flavors of
@ref{188,,annotation scopes}.

@geindex ANNOTATION (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType ANNOTATION}@anchor{4898}
@deffn {Atributo} ANNOTATION = "annotation"

Used for annotations if @code{from __future__ import annotations} is active.
@end deffn

@geindex TYPE_ALIAS (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_ALIAS}@anchor{4899}
@deffn {Atributo} TYPE_ALIAS = "type alias"

Used for the symbol table of @ref{438,,type} constructions.
@end deffn

@geindex TYPE_PARAMETERS (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_PARAMETERS}@anchor{489a}
@deffn {Atributo} TYPE_PARAMETERS = "type parameters"

Used for the symbol table of @ref{453,,generic functions}
or @ref{452,,generic classes}.
@end deffn

@geindex TYPE_VARIABLE (atributo symtable.SymbolTableType)
@anchor{library/symtable symtable SymbolTableType TYPE_VARIABLE}@anchor{489b}
@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


Adicionado na versão 3.13.

@end deffn

@geindex SymbolTable (classe em symtable)
@anchor{library/symtable symtable SymbolTable}@anchor{4893}
@deffn {Classe} symtable.SymbolTable

A namespace table for a block.  The constructor is not public.

@geindex get_type() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_type}@anchor{16f9}
@deffn {Método} get_type ()

Return the type of the symbol table.  Possible values are members
of the @ref{16f8,,SymbolTableType} enumeration.


Alterado na versão 3.12: Added @code{'annotation'},  @code{'TypeVar bound'}, @code{'type alias'},
and @code{'type parameter'} as possible return values.



Alterado na versão 3.13: Return values are members of the @ref{16f8,,SymbolTableType} enumeration.

The exact values of the returned string may change in the future,
and thus, it is recommended to use @ref{16f8,,SymbolTableType} members
instead of hard-coded strings.

@end deffn

@geindex get_id() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_id}@anchor{489c}
@deffn {Método} get_id ()

Return the table’s identifier.
@end deffn

@geindex get_name() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_name}@anchor{489d}
@deffn {Método} get_name ()

Return the table’s name.  This is the name of the class if the table is
for a class, the name of the function if the table is for a function, or
@code{'top'} if the table is global (@ref{16f9,,get_type()} returns @code{'module'}).
For type parameter scopes (which are used for generic classes, functions,
and type aliases), it is the name of the underlying class, function, or
type alias. For type alias scopes, it is the name of the type alias.
For @ref{15d,,TypeVar} bound scopes, it is the name of the @code{TypeVar}.
@end deffn

@geindex get_lineno() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_lineno}@anchor{489e}
@deffn {Método} get_lineno ()

Return the number of the first line in the block this table represents.
@end deffn

@geindex is_optimized() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable is_optimized}@anchor{489f}
@deffn {Método} is_optimized ()

Return @code{True} if the locals in this table can be optimized.
@end deffn

@geindex is_nested() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable is_nested}@anchor{48a0}
@deffn {Método} is_nested ()

Return @code{True} if the block is a nested class or function.
@end deffn

@geindex has_children() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable has_children}@anchor{48a1}
@deffn {Método} has_children ()

Return @code{True} if the block has nested namespaces within it.  These can
be obtained with @ref{48a2,,get_children()}.
@end deffn

@geindex get_identifiers() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_identifiers}@anchor{48a3}
@deffn {Método} get_identifiers ()

Return a view object containing the names of symbols in the table.
See the @ref{23d8,,documentation of view objects}.
@end deffn

@geindex lookup() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable lookup}@anchor{48a4}
@deffn {Método} lookup (name)

Lookup `name' in the table and return a @ref{17c1,,Symbol} instance.
@end deffn

@geindex get_symbols() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_symbols}@anchor{48a5}
@deffn {Método} get_symbols ()

Return a list of @ref{17c1,,Symbol} instances for names in the table.
@end deffn

@geindex get_children() (método symtable.SymbolTable)
@anchor{library/symtable symtable SymbolTable get_children}@anchor{48a2}
@deffn {Método} get_children ()

Return a list of the nested symbol tables.
@end deffn
@end deffn

@geindex Function (classe em symtable)
@anchor{library/symtable symtable Function}@anchor{48a6}
@deffn {Classe} symtable.Function

A namespace for a function or method.  This class inherits from
@ref{4893,,SymbolTable}.

@geindex get_parameters() (método symtable.Function)
@anchor{library/symtable symtable Function get_parameters}@anchor{48a7}
@deffn {Método} get_parameters ()

Return a tuple containing names of parameters to this function.
@end deffn

@geindex get_locals() (método symtable.Function)
@anchor{library/symtable symtable Function get_locals}@anchor{48a8}
@deffn {Método} get_locals ()

Return a tuple containing names of locals in this function.
@end deffn

@geindex get_globals() (método symtable.Function)
@anchor{library/symtable symtable Function get_globals}@anchor{48a9}
@deffn {Método} get_globals ()

Return a tuple containing names of globals in this function.
@end deffn

@geindex get_nonlocals() (método symtable.Function)
@anchor{library/symtable symtable Function get_nonlocals}@anchor{48aa}
@deffn {Método} get_nonlocals ()

Return a tuple containing names of explicitly declared nonlocals in this function.
@end deffn

@geindex get_frees() (método symtable.Function)
@anchor{library/symtable symtable Function get_frees}@anchor{48ab}
@deffn {Método} get_frees ()

Return a tuple containing names of @ref{20d1,,free (closure) variables}
in this function.
@end deffn
@end deffn

@geindex Class (classe em symtable)
@anchor{library/symtable symtable Class}@anchor{48ac}
@deffn {Classe} symtable.Class

A namespace of a class.  This class inherits from @ref{4893,,SymbolTable}.

@geindex get_methods() (método symtable.Class)
@anchor{library/symtable symtable Class get_methods}@anchor{2e5}
@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{14a2,,def} or @ref{5d1,,async def}.

Functions defined in a deeper scope (e.g., in an inner class) are not
picked up by @ref{2e5,,get_methods()}.

Por exemplo:

@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()[1]
>>> class_A.get_methods()
('f', 'g', 'h')
@end example

Although @code{A().f()} raises @ref{2c3,,TypeError} at runtime, @code{A.f} is still
considered as a method-like function.
@end deffn
@end deffn

@geindex Symbol (classe em symtable)
@anchor{library/symtable symtable Symbol}@anchor{17c1}
@deffn {Classe} symtable.Symbol

An entry in a @ref{4893,,SymbolTable} corresponding to an identifier in the
source.  The constructor is not public.

@geindex get_name() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol get_name}@anchor{48ad}
@deffn {Método} get_name ()

Return the symbol’s name.
@end deffn

@geindex is_referenced() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_referenced}@anchor{48ae}
@deffn {Método} is_referenced ()

Return @code{True} if the symbol is used in its block.
@end deffn

@geindex is_imported() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_imported}@anchor{48af}
@deffn {Método} is_imported ()

Return @code{True} if the symbol is created from an import statement.
@end deffn

@geindex is_parameter() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_parameter}@anchor{48b0}
@deffn {Método} is_parameter ()

Return @code{True} if the symbol is a parameter.
@end deffn

@geindex is_global() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_global}@anchor{48b1}
@deffn {Método} is_global ()

Return @code{True} if the symbol is global.
@end deffn

@geindex is_nonlocal() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_nonlocal}@anchor{1ba3}
@deffn {Método} is_nonlocal ()

Return @code{True} if the symbol is nonlocal.
@end deffn

@geindex is_declared_global() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_declared_global}@anchor{136a}
@deffn {Método} is_declared_global ()

Return @code{True} if the symbol is declared global with a global statement.
@end deffn

@geindex is_local() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_local}@anchor{48b2}
@deffn {Método} is_local ()

Return @code{True} if the symbol is local to its block.
@end deffn

@geindex is_annotated() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_annotated}@anchor{48b3}
@deffn {Método} is_annotated ()

Return @code{True} if the symbol is annotated.


Adicionado na versão 3.6.

@end deffn

@geindex is_free() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_free}@anchor{48b4}
@deffn {Método} is_free ()

Return @code{True} if the symbol is referenced in its block, but not assigned
to.
@end deffn

@geindex is_assigned() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_assigned}@anchor{48b5}
@deffn {Método} is_assigned ()

Return @code{True} if the symbol is assigned to in its block.
@end deffn

@geindex is_namespace() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol is_namespace}@anchor{48b6}
@deffn {Método} is_namespace ()

Return @code{True} if name binding introduces new namespace.

If the name is used as the target of a function or class statement, this
will be true.

Por exemplo:

@example
>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True
@end example

Note that a single name can be bound to multiple objects.  If the result
is @code{True}, the name may also be bound to other objects, like an int or
list, that does not introduce a new namespace.
@end deffn

@geindex get_namespaces() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol get_namespaces}@anchor{48b7}
@deffn {Método} get_namespaces ()

Return a list of namespaces bound to this name.
@end deffn

@geindex get_namespace() (método symtable.Symbol)
@anchor{library/symtable symtable Symbol get_namespace}@anchor{48b8}
@deffn {Método} get_namespace ()

Return the namespace bound to this name. If more than one or no namespace
is bound to this name, a @ref{202,,ValueError} is raised.
@end deffn
@end deffn

@node Uso na linha de comando<10>,,Examining Symbol Tables,symtable — Acesso a tabela de símbolos do compilador
@anchor{library/symtable command-line-usage}@anchor{48b9}@anchor{library/symtable symtable-cli}@anchor{48ba}
@subsubsection Uso na linha de comando



Adicionado na versão 3.13.


O módulo @ref{d8,,symtable} pode ser invocado como um script na linha de comando:

@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 — Constantes usadas com árvores de análises do Python,keyword — Testando palavras reservadas do Python,symtable — Acesso a tabela de símbolos do compilador,Serviços da Linguagem Python
@anchor{library/token doc}@anchor{48bb}@anchor{library/token module-token}@anchor{fa}@anchor{library/token token-constants-used-with-python-parse-trees}@anchor{48bc}@anchor{library/token translation-repo}@anchor{48bd}
@subsection @code{token} — Constantes usadas com árvores de análises do Python


@geindex module; token

`Código-fonte:' Lib/token.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/token.py}


__________________________________________________________________


Este módulo fornece constantes que representam os valores numéricos dos nós das folhas da árvore de análise (tokens terminais). Consulte o arquivo @code{Grammar/Tokens} na distribuição Python para obter as definições dos nomes no contexto da gramática da linguagem. Os valores numéricos específicos para os quais os nomes são mapeados podem mudar entre as versões do Python.

O módulo também fornece um mapeamento de códigos numéricos para nomes e algumas funções. As funções espelham definições nos arquivos de cabeçalho do Python C.

Observe que o valor de um token pode depender das opções do tokenizador. Por exemplo, um token @code{"+"} pode ser relatado como @ref{48be,,PLUS} ou @ref{48bf,,OP}, ou um token @code{"match"} pode ser @ref{48c0,,NAME} ou @ref{48c1,,SOFT_KEYWORD}.

@geindex tok_name (no módulo token)
@anchor{library/token token tok_name}@anchor{48c2}
@deffn {Dado} token.tok_name

Dicionário que mapeia os valores numéricos das constantes definidas neste módulo de volta para cadeias de nomes, permitindo que seja gerada uma representação mais legível de árvores de análise.
@end deffn

@geindex ISTERMINAL() (no módulo token)
@anchor{library/token token ISTERMINAL}@anchor{48c3}
@deffn {Função} token.ISTERMINAL (x)

Retorna @code{True} para valores de tokens terminais.
@end deffn

@geindex ISNONTERMINAL() (no módulo token)
@anchor{library/token token ISNONTERMINAL}@anchor{48c4}
@deffn {Função} token.ISNONTERMINAL (x)

Retorna @code{True} para valores de tokens não terminais.
@end deffn

@geindex ISEOF() (no módulo token)
@anchor{library/token token ISEOF}@anchor{48c5}
@deffn {Função} token.ISEOF (x)

Retorna @code{True} se `x' for o marcador que indica o final da entrada.
@end deffn

Os constantes de tokens são:

@geindex NAME (no módulo token)
@anchor{library/token token NAME}@anchor{48c0}
@deffn {Dado} token.NAME

Valor de token que indica um @ref{2021,,identificador}. Observe que as palavras reservadas também são inicialmente tokenizadas como tokens @code{NAME}.
@end deffn

@geindex NUMBER (no módulo token)
@anchor{library/token token NUMBER}@anchor{48c6}
@deffn {Dado} token.NUMBER

Valor de token que indica um @ref{2052,,literal numérico}
@end deffn

@geindex STRING (no módulo token)
@anchor{library/token token STRING}@anchor{48c7}
@deffn {Dado} token.STRING

Valor de token que indica um @ref{2031,,literal de string ou byte}, excluindo @ref{9b1,,literais de strings formatadas}. A string de token não é interpretada: ela inclui as aspas ao redor e o prefixo (se fornecido); contrabarras são incluídas literalmente, sem processar sequências de escape.
@end deffn

@geindex OP (no módulo token)
@anchor{library/token token OP}@anchor{48bf}
@deffn {Dado} token.OP

Um valor de token genérico que indica um @ref{206c,,operador} ou @ref{206d,,delimitador}.

Este valor é relatado apenas pelo módulo @ref{fb,,tokenize}. Internamente, o tokenizador usa @ref{48c8,,tipos exatos de tokens} em vez disso.
@end deffn

@geindex COMMENT (no módulo token)
@anchor{library/token token COMMENT}@anchor{48c9}
@deffn {Dado} token.COMMENT

Valor de token usado para indicar um comentário. O analisador sintático ignora tokens @code{COMMENT}.
@end deffn

@geindex NEWLINE (no módulo token)
@anchor{library/token token NEWLINE}@anchor{48ca}
@deffn {Dado} token.NEWLINE

Valor de token que indica o fim de uma @ref{200e,,linha lógica}.
@end deffn

@geindex NL (no módulo token)
@anchor{library/token token NL}@anchor{48cb}
@deffn {Dado} token.NL

Valor de token usado para indicar uma nova linha não terminante. Os tokens @code{NL} são gerados quando uma linha lógica de código é continuada em várias linhas físicas. O analisador sintático ignora os tokens @code{NL}.
@end deffn

@geindex INDENT (no módulo token)
@anchor{library/token token INDENT}@anchor{1e95}
@deffn {Dado} token.INDENT

Valor de token usado no início de uma @ref{200e,,linha lógica} para indicar o início de um @ref{201c,,bloco indentado}.
@end deffn

@geindex DEDENT (no módulo token)
@anchor{library/token token DEDENT}@anchor{48cc}
@deffn {Dado} token.DEDENT

Valor de token usado no início de uma @ref{200e,,linha lógica} para indicar o fim de um @ref{201c,,bloco indentado}.
@end deffn

@geindex FSTRING_START (no módulo token)
@anchor{library/token token FSTRING_START}@anchor{48cd}
@deffn {Dado} token.FSTRING_START

Valor de token usado para indicar o início de um @ref{9b1,,literal de f-string}.

A string de token inclui o prefixo e as aspas iniciais, mas nenhum conteúdo do literal.
@end deffn

@geindex FSTRING_MIDDLE (no módulo token)
@anchor{library/token token FSTRING_MIDDLE}@anchor{48ce}
@deffn {Dado} token.FSTRING_MIDDLE

Valor de token usado para texto literal dentro de um @ref{9b1,,literal de f-string}, incluindo especificações de formato.

Campos de substituição (ou seja, as partes não literais de f-strings) usam os mesmos tokens que outras expressões e são delimitados pelos tokens @ref{48cf,,LBRACE}, @ref{48d0,,RBRACE}, @ref{48d1,,EXCLAMATION} e @ref{48d2,,COLON}.
@end deffn

@geindex FSTRING_END (no módulo token)
@anchor{library/token token FSTRING_END}@anchor{48d3}
@deffn {Dado} token.FSTRING_END

Valor de token usado para indicar o fim de um @ref{9b1,,literal de f-string}.

A string do token contém as aspas de fechamento.
@end deffn

@geindex ENDMARKER (no módulo token)
@anchor{library/token token ENDMARKER}@anchor{48d4}
@deffn {Dado} token.ENDMARKER

Valor de token que indica o fim da entrada.
@end deffn

@geindex ENCODING (no módulo token)
@anchor{library/token token ENCODING}@anchor{48d5}
@deffn {Dado} token.ENCODING

Valor de token que indica a codificação usada para decodificar os bytes de origem em texto. O primeiro token retornado por @ref{4d9,,tokenize.tokenize()} sempre será um token @code{ENCODING}.

Este tipo de token não é usado pelo tokenizador do C, mas é necessário para o módulo @ref{fb,,tokenize}.
@end deffn

Os seguintes tipos de token não são produzidos pelo módulo @ref{fb,,tokenize} e são definidos para usos especiais no tokenizador ou analisador:

@geindex TYPE_IGNORE (no módulo token)
@anchor{library/token token TYPE_IGNORE}@anchor{48d6}
@deffn {Dado} token.TYPE_IGNORE

Valor de token indicando que um comentário @code{type: ignore} foi reconhecido. Tais tokens são produzidos em vez de tokens @ref{48c9,,COMMENT} regulares somente com o sinalizador @ref{4878,,PyCF_TYPE_COMMENTS}.
@end deffn

@geindex TYPE_COMMENT (no módulo token)
@anchor{library/token token TYPE_COMMENT}@anchor{48d7}
@deffn {Dado} token.TYPE_COMMENT

Valor de token indicando que um comentário de tipo foi reconhecido. Tais tokens são produzidos em vez de tokens @ref{48c9,,COMMENT} regulares somente com o sinalizador @ref{4878,,PyCF_TYPE_COMMENTS}.
@end deffn

@geindex SOFT_KEYWORD (no módulo token)
@anchor{library/token token SOFT_KEYWORD}@anchor{48c1}
@deffn {Dado} token.SOFT_KEYWORD

Valor de token indicando uma @ref{80f,,palavra reservada contextual}.

O tokenizador nunca produz esse valor. Para verificar uma palavra reservada contextual, passe uma string do token @ref{48c0,,NAME} para @ref{48d8,,keyword.issoftkeyword()}.
@end deffn

@geindex ERRORTOKEN (no módulo token)
@anchor{library/token token ERRORTOKEN}@anchor{48d9}
@deffn {Dado} token.ERRORTOKEN

Valor de token usado para indicar uma entrada errada.

O módulo @ref{fb,,tokenize} geralmente indica erros levantando exceções em vez de emitir este token. Ele também pode emitir tokens como @ref{48bf,,OP} ou @ref{48c0,,NAME} com strings que são rejeitadas posteriormente pelo parser.
@end deffn
@anchor{library/token token-operators-delimiters}@anchor{48c8}
Os tokens restantes representam @ref{206c,,operadores} e @ref{206d,,delimitadores} específicos. (O módulo @ref{fb,,tokenize} os relata como @ref{48bf,,OP}; consulte @code{exact_type} na documentação @ref{fb,,tokenize} para obter detalhes.)

@c Auto-generated by Tools/build/generate_token.py


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Token

@tab

Valor

@item

@geindex LPAR (no módulo token)
@anchor{library/token token LPAR}@anchor{48da}
@deffn {Dado} token.LPAR
@end deffn

@tab

@code{"("}

@item

@geindex RPAR (no módulo token)
@anchor{library/token token RPAR}@anchor{48db}
@deffn {Dado} token.RPAR
@end deffn

@tab

@code{")"}

@item

@geindex LSQB (no módulo token)
@anchor{library/token token LSQB}@anchor{48dc}
@deffn {Dado} token.LSQB
@end deffn

@tab

@code{"["}

@item

@geindex RSQB (no módulo token)
@anchor{library/token token RSQB}@anchor{48dd}
@deffn {Dado} token.RSQB
@end deffn

@tab

@code{"]"}

@item

@geindex COLON (no módulo token)
@anchor{library/token token COLON}@anchor{48d2}
@deffn {Dado} token.COLON
@end deffn

@tab

@code{":"}

@item

@geindex COMMA (no módulo token)
@anchor{library/token token COMMA}@anchor{48de}
@deffn {Dado} token.COMMA
@end deffn

@tab

@code{","}

@item

@geindex SEMI (no módulo token)
@anchor{library/token token SEMI}@anchor{48df}
@deffn {Dado} token.SEMI
@end deffn

@tab

@code{";"}

@item

@geindex PLUS (no módulo token)
@anchor{library/token token PLUS}@anchor{48be}
@deffn {Dado} token.PLUS
@end deffn

@tab

@code{"+"}

@item

@geindex MINUS (no módulo token)
@anchor{library/token token MINUS}@anchor{48e0}
@deffn {Dado} token.MINUS
@end deffn

@tab

@code{"-"}

@item

@geindex STAR (no módulo token)
@anchor{library/token token STAR}@anchor{48e1}
@deffn {Dado} token.STAR
@end deffn

@tab

@code{"*"}

@item

@geindex SLASH (no módulo token)
@anchor{library/token token SLASH}@anchor{48e2}
@deffn {Dado} token.SLASH
@end deffn

@tab

@code{"/"}

@item

@geindex VBAR (no módulo token)
@anchor{library/token token VBAR}@anchor{48e3}
@deffn {Dado} token.VBAR
@end deffn

@tab

@code{"|"}

@item

@geindex AMPER (no módulo token)
@anchor{library/token token AMPER}@anchor{48e4}
@deffn {Dado} token.AMPER
@end deffn

@tab

@code{"&"}

@item

@geindex LESS (no módulo token)
@anchor{library/token token LESS}@anchor{48e5}
@deffn {Dado} token.LESS
@end deffn

@tab

@code{"<"}

@item

@geindex GREATER (no módulo token)
@anchor{library/token token GREATER}@anchor{48e6}
@deffn {Dado} token.GREATER
@end deffn

@tab

@code{">"}

@item

@geindex EQUAL (no módulo token)
@anchor{library/token token EQUAL}@anchor{48e7}
@deffn {Dado} token.EQUAL
@end deffn

@tab

@code{"="}

@item

@geindex DOT (no módulo token)
@anchor{library/token token DOT}@anchor{48e8}
@deffn {Dado} token.DOT
@end deffn

@tab

@code{"."}

@item

@geindex PERCENT (no módulo token)
@anchor{library/token token PERCENT}@anchor{48e9}
@deffn {Dado} token.PERCENT
@end deffn

@tab

@code{"%"}

@item

@geindex LBRACE (no módulo token)
@anchor{library/token token LBRACE}@anchor{48cf}
@deffn {Dado} token.LBRACE
@end deffn

@tab

@code{"@{"}

@item

@geindex RBRACE (no módulo token)
@anchor{library/token token RBRACE}@anchor{48d0}
@deffn {Dado} token.RBRACE
@end deffn

@tab

@code{"@}"}

@item

@geindex EQEQUAL (no módulo token)
@anchor{library/token token EQEQUAL}@anchor{48ea}
@deffn {Dado} token.EQEQUAL
@end deffn

@tab

@code{"=="}

@item

@geindex NOTEQUAL (no módulo token)
@anchor{library/token token NOTEQUAL}@anchor{48eb}
@deffn {Dado} token.NOTEQUAL
@end deffn

@tab

@code{"!="}

@item

@geindex LESSEQUAL (no módulo token)
@anchor{library/token token LESSEQUAL}@anchor{48ec}
@deffn {Dado} token.LESSEQUAL
@end deffn

@tab

@code{"<="}

@item

@geindex GREATEREQUAL (no módulo token)
@anchor{library/token token GREATEREQUAL}@anchor{48ed}
@deffn {Dado} token.GREATEREQUAL
@end deffn

@tab

@code{">="}

@item

@geindex TILDE (no módulo token)
@anchor{library/token token TILDE}@anchor{48ee}
@deffn {Dado} token.TILDE
@end deffn

@tab

@code{"~"}

@item

@geindex CIRCUMFLEX (no módulo token)
@anchor{library/token token CIRCUMFLEX}@anchor{48ef}
@deffn {Dado} token.CIRCUMFLEX
@end deffn

@tab

@code{"^"}

@item

@geindex LEFTSHIFT (no módulo token)
@anchor{library/token token LEFTSHIFT}@anchor{48f0}
@deffn {Dado} token.LEFTSHIFT
@end deffn

@tab

@code{"<<"}

@item

@geindex RIGHTSHIFT (no módulo token)
@anchor{library/token token RIGHTSHIFT}@anchor{48f1}
@deffn {Dado} token.RIGHTSHIFT
@end deffn

@tab

@code{">>"}

@item

@geindex DOUBLESTAR (no módulo token)
@anchor{library/token token DOUBLESTAR}@anchor{48f2}
@deffn {Dado} token.DOUBLESTAR
@end deffn

@tab

@code{"**"}

@item

@geindex PLUSEQUAL (no módulo token)
@anchor{library/token token PLUSEQUAL}@anchor{48f3}
@deffn {Dado} token.PLUSEQUAL
@end deffn

@tab

@code{"+="}

@item

@geindex MINEQUAL (no módulo token)
@anchor{library/token token MINEQUAL}@anchor{48f4}
@deffn {Dado} token.MINEQUAL
@end deffn

@tab

@code{"-="}

@item

@geindex STAREQUAL (no módulo token)
@anchor{library/token token STAREQUAL}@anchor{48f5}
@deffn {Dado} token.STAREQUAL
@end deffn

@tab

@code{"*="}

@item

@geindex SLASHEQUAL (no módulo token)
@anchor{library/token token SLASHEQUAL}@anchor{48f6}
@deffn {Dado} token.SLASHEQUAL
@end deffn

@tab

@code{"/="}

@item

@geindex PERCENTEQUAL (no módulo token)
@anchor{library/token token PERCENTEQUAL}@anchor{48f7}
@deffn {Dado} token.PERCENTEQUAL
@end deffn

@tab

@code{"%="}

@item

@geindex AMPEREQUAL (no módulo token)
@anchor{library/token token AMPEREQUAL}@anchor{48f8}
@deffn {Dado} token.AMPEREQUAL
@end deffn

@tab

@code{"&="}

@item

@geindex VBAREQUAL (no módulo token)
@anchor{library/token token VBAREQUAL}@anchor{48f9}
@deffn {Dado} token.VBAREQUAL
@end deffn

@tab

@code{"|="}

@item

@geindex CIRCUMFLEXEQUAL (no módulo token)
@anchor{library/token token CIRCUMFLEXEQUAL}@anchor{48fa}
@deffn {Dado} token.CIRCUMFLEXEQUAL
@end deffn

@tab

@code{"^="}

@item

@geindex LEFTSHIFTEQUAL (no módulo token)
@anchor{library/token token LEFTSHIFTEQUAL}@anchor{48fb}
@deffn {Dado} token.LEFTSHIFTEQUAL
@end deffn

@tab

@code{"<<="}

@item

@geindex RIGHTSHIFTEQUAL (no módulo token)
@anchor{library/token token RIGHTSHIFTEQUAL}@anchor{48fc}
@deffn {Dado} token.RIGHTSHIFTEQUAL
@end deffn

@tab

@code{">>="}

@item

@geindex DOUBLESTAREQUAL (no módulo token)
@anchor{library/token token DOUBLESTAREQUAL}@anchor{48fd}
@deffn {Dado} token.DOUBLESTAREQUAL
@end deffn

@tab

@code{"**="}

@item

@geindex DOUBLESLASH (no módulo token)
@anchor{library/token token DOUBLESLASH}@anchor{48fe}
@deffn {Dado} token.DOUBLESLASH
@end deffn

@tab

@code{"//"}

@item

@geindex DOUBLESLASHEQUAL (no módulo token)
@anchor{library/token token DOUBLESLASHEQUAL}@anchor{48ff}
@deffn {Dado} token.DOUBLESLASHEQUAL
@end deffn

@tab

@code{"//="}

@item

@geindex AT (no módulo token)
@anchor{library/token token AT}@anchor{4900}
@deffn {Dado} token.AT
@end deffn

@tab

@code{"@@"}

@item

@geindex ATEQUAL (no módulo token)
@anchor{library/token token ATEQUAL}@anchor{4901}
@deffn {Dado} token.ATEQUAL
@end deffn

@tab

@code{"@@="}

@item

@geindex RARROW (no módulo token)
@anchor{library/token token RARROW}@anchor{4902}
@deffn {Dado} token.RARROW
@end deffn

@tab

@code{"->"}

@item

@geindex ELLIPSIS (no módulo token)
@anchor{library/token token ELLIPSIS}@anchor{4903}
@deffn {Dado} token.ELLIPSIS
@end deffn

@tab

@code{"..."}

@item

@geindex COLONEQUAL (no módulo token)
@anchor{library/token token COLONEQUAL}@anchor{4904}
@deffn {Dado} token.COLONEQUAL
@end deffn

@tab

@code{":="}

@item

@geindex EXCLAMATION (no módulo token)
@anchor{library/token token EXCLAMATION}@anchor{48d1}
@deffn {Dado} token.EXCLAMATION
@end deffn

@tab

@code{"!"}

@end multitable


As seguintes constantes não-tokens são fornecidas:

@geindex N_TOKENS (no módulo token)
@anchor{library/token token N_TOKENS}@anchor{4905}
@deffn {Dado} token.N_TOKENS

O número de tipos de token definidos neste módulo.
@end deffn

@c NT_OFFSET is deliberately undocumented; if you need it you should be
@c reading the source

@geindex EXACT_TOKEN_TYPES (no módulo token)
@anchor{library/token token EXACT_TOKEN_TYPES}@anchor{167b}
@deffn {Dado} token.EXACT_TOKEN_TYPES

Um dicionário que mapeia a representação de string de um token para seu código numérico.


Adicionado na versão 3.8.

@end deffn


Alterado na versão 3.5: Adicionados os tokens @code{AWAIT} e @code{ASYNC}.



Alterado na versão 3.7: Adicionados os tokens @ref{48c9,,COMMENT}, @ref{48cb,,NL} e @ref{48d5,,ENCODING}.



Alterado na versão 3.7: Removido os tokens @code{AWAIT} e @code{ASYNC}. “async” e “await” são agora tokenizados como tokens @ref{48c0,,NAME}.



Alterado na versão 3.8: Adicionados @ref{48d7,,TYPE_COMMENT}, @ref{48d6,,TYPE_IGNORE}, @ref{4904,,COLONEQUAL}. Adicionados os tokens @code{AWAIT} e @code{ASYNC} (eles são necessários para dar suporte à análise de versões mais antigas do Python para @ref{1a8,,ast.parse()} com @code{feature_version} definido como 6 ou inferior).



Alterado na versão 3.12: Adicionado @ref{48d1,,EXCLAMATION}.



Alterado na versão 3.13: Removidos novamente os tokens @code{AWAIT} e @code{ASYNC}.


@node keyword — Testando palavras reservadas do Python,tokenize — Tokenizador para código-fonte Python,token — Constantes usadas com árvores de análises do Python,Serviços da Linguagem Python
@anchor{library/keyword doc}@anchor{4906}@anchor{library/keyword keyword-testing-for-python-keywords}@anchor{4907}@anchor{library/keyword module-keyword}@anchor{84}@anchor{library/keyword translation-repo}@anchor{4908}
@subsection @code{keyword} — Testando palavras reservadas do Python


@geindex module; keyword

`Código-fonte:' Lib/keyword.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/keyword.py}


__________________________________________________________________


Este módulo permite a um programa Python determinar se uma string é uma @ref{2029,,palavra reservada} ou @ref{80f,,palavra reservada contextual}.

@geindex iskeyword() (no módulo keyword)
@anchor{library/keyword keyword iskeyword}@anchor{235c}
@deffn {Função} keyword.iskeyword (s)

Retorna @code{True} se `s' for uma @ref{2029,,palavra reservada} do Python.
@end deffn

@geindex kwlist (no módulo keyword)
@anchor{library/keyword keyword kwlist}@anchor{4909}
@deffn {Dado} keyword.kwlist

Sequência contendo todas as @ref{2029,,palavras reservadas} definidas para o interpretador. Se alguma palavra reservada estiver definida para apenas estar ativa quando instruções @ref{0,,__future__} específicas tiverem efeito, estas serão incluídas também.
@end deffn

@geindex issoftkeyword() (no módulo keyword)
@anchor{library/keyword keyword issoftkeyword}@anchor{48d8}
@deffn {Função} keyword.issoftkeyword (s)

Retorna @code{True} se `s' for uma @ref{80f,,palavra reservada contextual} do Python.


Adicionado na versão 3.9.

@end deffn

@geindex softkwlist (no módulo keyword)
@anchor{library/keyword keyword softkwlist}@anchor{490a}
@deffn {Dado} keyword.softkwlist

Sequência contendo todas as @ref{80f,,palavras reservadas contextuais} definidas para o interpretador. Se alguma palavra reservada contextual estiver definida para apenas estar ativo quando instruções @ref{0,,__future__} tiverem efeito, estas serão incluídas também.


Adicionado na versão 3.9.

@end deffn

@node tokenize — Tokenizador para código-fonte Python,tabnanny — Detecção de indentação ambígua,keyword — Testando palavras reservadas do Python,Serviços da Linguagem Python
@anchor{library/tokenize doc}@anchor{490b}@anchor{library/tokenize module-tokenize}@anchor{fb}@anchor{library/tokenize tokenize-tokenizer-for-python-source}@anchor{490c}@anchor{library/tokenize translation-repo}@anchor{490d}
@subsection @code{tokenize} — Tokenizador para código-fonte Python


@geindex module; tokenize

`Código-fonte:' Lib/tokenize.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tokenize.py}


__________________________________________________________________


O módulo @ref{fb,,tokenize} fornece um scanner léxico para código-fonte Python, implementado em Python. O scanner neste módulo retorna comentários como tokens também, tornando-o útil para implementar “pretty-printers”, incluindo colorizadores para exibições na tela.

Para simplificar o tratamento do fluxo de tokens, todos os tokens @ref{206c,,operadores} e @ref{206d,,delimitadores} e @ref{231c,,Ellipsis} são retornados usando o tipo de token genérico @ref{48bf,,OP}. O tipo exato pode ser determinado verificando a propriedade @code{exact_type} na @ref{64e,,tupla nomeada} retornada de @ref{4d9,,tokenize.tokenize()}.

@cartouche
@quotation Aviso 
Observe que as funções neste módulo são projetadas apenas para analisar código Python sintaticamente válido (código que não levanta exceção quando analisado usando @ref{1a8,,ast.parse()}). O comportamento das funções neste módulo é `indefinido' ao fornecer código Python inválido e pode mudar a qualquer momento.
@end quotation
@end cartouche

@menu
* Tokenizando entradas:: 
* Uso na linha de comando: Uso na linha de comando<11>. 
* Exemplos: Exemplos<35>. 

@end menu

@node Tokenizando entradas,Uso na linha de comando<11>,,tokenize — Tokenizador para código-fonte Python
@anchor{library/tokenize tokenizing-input}@anchor{490e}
@subsubsection Tokenizando entradas


O ponto de entrada principal é um @ref{109a,,gerador}:

@geindex tokenize() (no módulo tokenize)
@anchor{library/tokenize tokenize tokenize}@anchor{4d9}
@deffn {Função} tokenize.tokenize (readline)

O gerador @ref{4d9,,tokenize()} requer um argumento, `readline', que deve ser um objeto chamável que fornece a mesma interface que o método @ref{241f,,io.IOBase.readline()} de objetos arquivo. Cada chamada para a função deve retornar uma linha de entrada como bytes.

O gerador produz tuplas de 5 elementos com estes membros: o tipo de token; a string de token; uma tupla de 2 elementos @code{(srow, scol)} de ints especificando a linha e a coluna onde o token começa na fonte; uma tupla de 2 elementos @code{(erow, ecol)} de ints especificando a linha e a coluna onde o token termina na fonte; e a linha na qual o token foi encontrado. A linha passada (o último item da tupla) é a linha `física'. A tupla 5 elementos é retornada como uma @ref{64e,,tupla nomeada} com os nomes dos campos: @code{tipo string início fim linha}.

A @ref{64e,,tupla nomeada} retornada tem uma propriedade adicional chamada @code{exact_type} que contém o tipo exato do operador para tokens @ref{48bf,,OP}. Para todos os outros tipos de token, @code{exact_type} é igual ao campo @code{type} da tupla nomeada.


Alterado na versão 3.1: Adiciona suporte para tuplas nomeadas.



Alterado na versão 3.3: Adicionado suporte para @code{exact_type}.


@ref{4d9,,tokenize()} determina a codificação de origem do arquivo procurando por um BOM UTF-8 ou cookie de codificação, de acordo com 
@geindex Propostas de Melhorias do Python; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}.
@end deffn

@geindex generate_tokens() (no módulo tokenize)
@anchor{library/tokenize tokenize generate_tokens}@anchor{4da}
@deffn {Função} tokenize.generate_tokens (readline)

Tokeniza uma fonte lendo strings unicode em vez de bytes.

Assim como @ref{4d9,,tokenize()}, o argumento `readline' é um chamável que retorna uma única linha de entrada. No entanto, @ref{4da,,generate_tokens()} espera que `readline' retorne um objeto str em vez de bytes.

O resultado é um iterador produzindo tuplas nomeadas, exatamente como @ref{4d9,,tokenize()}. Ele não produz um token @ref{48d5,,ENCODING}.
@end deffn

Todas as constantes do módulo @ref{fa,,token} também são exportadas de @ref{fb,,tokenize}.

Outra função é fornecida para reverter o processo de tokenização. Isso é útil para criar ferramentas que tokenizam um script, modificam o fluxo de tokens e escrevem de volta o script modificado.

@geindex untokenize() (no módulo tokenize)
@anchor{library/tokenize tokenize untokenize}@anchor{166b}
@deffn {Função} tokenize.untokenize (iterable)

Converte tokens de volta para o código-fonte Python. O `iterable' deve retornar sequências com pelo menos dois elementos, o tipo de token e a string do token. Quaisquer elementos de sequência adicionais são ignorados.

O resultado é garantido para tokenizar de volta para corresponder à entrada, de modo que a conversão seja sem perdas e as viagens de ida e volta sejam garantidas. A garantia se aplica somente ao tipo de token e à sequência de tokens, pois o espaçamento entre os tokens (posições de coluna) pode mudar.

Retorna bytes, codificados usando o token @ref{48d5,,ENCODING}, que é a primeira sequência de tokens gerada por @ref{4d9,,tokenize()}. Se não houver nenhum token de codificação na entrada, ele retorna um str em vez disso.
@end deffn

@ref{4d9,,tokenize()} precisa detectar a codificação dos arquivos fonte que ele tokeniza. A função que ele usa para fazer isso está disponível:

@geindex detect_encoding() (no módulo tokenize)
@anchor{library/tokenize tokenize detect_encoding}@anchor{2a19}
@deffn {Função} tokenize.detect_encoding (readline)

A função @ref{2a19,,detect_encoding()} é usada para detectar a codificação que deve ser usada para decodificar um arquivo de origem Python. Ela requer um argumento, readline, da mesma forma que o gerador @ref{4d9,,tokenize()}.

Ele chamará readline no máximo duas vezes e retornará a codificação usada (como uma string) e uma lista de todas as linhas (não decodificadas de bytes) que ele leu.

Ele detecta a codificação a partir da presença de um BOM UTF-8 ou um cookie de codificação conforme especificado em 
@geindex Propostas de Melhorias do Python; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}. Se um BOM e um cookie estiverem presentes, mas discordarem, uma exceção @ref{18d,,SyntaxError} será levantada. Observe que se o BOM for encontrado, @code{'utf-8-sig'} será retornado como uma codificação.

Se nenhuma codificação for especificada, o padrão @code{'utf-8'} será retornado.

Use @ref{2a18,,open()} para abrir arquivos de código-fonte Python: ele usa @ref{2a19,,detect_encoding()} para detectar a codificação do arquivo.
@end deffn

@geindex open() (no módulo tokenize)
@anchor{library/tokenize tokenize open}@anchor{2a18}
@deffn {Função} tokenize.open (filename)

Abre um arquivo no modo somente leitura usando a codificação detectada por @ref{2a19,,detect_encoding()}.


Adicionado na versão 3.2.

@end deffn

@geindex TokenError
@anchor{library/tokenize tokenize TokenError}@anchor{542}
@deffn {Exceção} tokenize.TokenError

Levantada quando uma docstring ou expressão que pode ser dividida em várias linhas não é concluída em nenhum lugar do arquivo, por exemplo:

@example
"""Início da
docstring
@end example

ou:

@example
[1,
 2,
 3
@end example
@end deffn

@node Uso na linha de comando<11>,Exemplos<35>,Tokenizando entradas,tokenize — Tokenizador para código-fonte Python
@anchor{library/tokenize command-line-usage}@anchor{490f}@anchor{library/tokenize tokenize-cli}@anchor{4910}
@subsubsection Uso na linha de comando



Adicionado na versão 3.3.


O módulo @ref{fb,,tokenize} pode ser executado como um script a partir da linha de comando. É tão simples quanto:

@example
python -m tokenize [-e] [nome-do-arquivo.py]
@end example

As seguintes opções são aceitas:

@geindex tokenize opção de linha de comando; -h
@geindex tokenize opção de linha de comando; --help
@anchor{library/tokenize cmdoption-tokenize-h}@anchor{4911}@anchor{library/tokenize cmdoption-tokenize-help}@anchor{4912}
@deffn {Option} @w{-}h, @w{-}@w{-}help

mostra esta mensagem de ajuda e sai
@end deffn

@geindex tokenize opção de linha de comando; -e
@geindex tokenize opção de linha de comando; --exact
@anchor{library/tokenize cmdoption-tokenize-e}@anchor{4913}@anchor{library/tokenize cmdoption-tokenize-exact}@anchor{4914}
@deffn {Option} @w{-}e, @w{-}@w{-}exact

exibe nomes de tokens usando o tipo exato
@end deffn

Se @code{nome-de-arquivo.py} for especificado, seu conteúdo será tokenizado para stdout. Caso contrário, a tokenização será realizada em stdin.

@node Exemplos<35>,,Uso na linha de comando<11>,tokenize — Tokenizador para código-fonte Python
@anchor{library/tokenize examples}@anchor{4915}
@subsubsection Exemplos


Exemplo de um reescritor de script que transforma literais float em objetos Decimal:

@example
from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
from io import BytesIO

def decistmt(s):
    """Substitui Decimals por floats em uma string de instruções.

    >>> from decimal import Decimal
    >>> s = 'print(+21.3e-5*-.1234/81.7)'
    >>> decistmt(s)
    "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"

    O formato do expoente é herdado da biblioteca da plataforma C. Casos
    conhecidos são "e-007" (Windows) e "e-07" (não Windows). Como estamos
    mostrando apenas 12 dígitos, e o 13º não está próximo de 5, o restante
    da saída deve ser independente da plataforma.

    >>> exec(s)  #doctest: +ELLIPSIS
    -3.21716034272e-0...7

    A saída dos cálculos com Decimal deve ser idêntica em todas as
    plataformas.

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

Exemplo de tokenização a partir da linha de comando. O script:

@example
def say_hello():
    print("Hello, World!")

say_hello()
@end example

será tokenizado para a seguinte saída, onde a primeira coluna é o intervalo das coordenadas da linha/coluna onde o token é encontrado, a segunda coluna é o nome do token e a coluna final é o valor do token (se houver)

@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

Os nomes exatos dos tipos de token podem ser exibidos usando a opção @ref{4913,,-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

Exemplo de tokenização de um arquivo programaticamente, lendo strings unicode em vez de bytes com @ref{4da,,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

Ou lendo bytes diretamente com @ref{4d9,,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 — Detecção de indentação ambígua,pyclbr — Suporte a navegador de módulos do Python,tokenize — Tokenizador para código-fonte Python,Serviços da Linguagem Python
@anchor{library/tabnanny doc}@anchor{4916}@anchor{library/tabnanny module-tabnanny}@anchor{dd}@anchor{library/tabnanny tabnanny-detection-of-ambiguous-indentation}@anchor{4917}@anchor{library/tabnanny translation-repo}@anchor{4918}
@subsection @code{tabnanny} — Detecção de indentação ambígua


@geindex module; tabnanny

@c rudimentary documentation based on module comments

`Código-fonte:' Lib/tabnanny.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tabnanny.py}


__________________________________________________________________


Por enquanto, este módulo deve ser chamado como um script. No entanto, é possível importá-lo para um IDE e usar a função @ref{4919,,check()} descrita abaixo.

@cartouche
@quotation Nota 
A API fornecida por este módulo provavelmente mudará em versões futuras; essas mudanças podem não ser compatíveis com versões anteriores.
@end quotation
@end cartouche

@geindex check() (no módulo tabnanny)
@anchor{library/tabnanny tabnanny check}@anchor{4919}
@deffn {Função} tabnanny.check (file_or_dir)

Se `file_or_dir' for um diretório e não um link simbólico, desce recursivamente a árvore de diretórios nomeada por `file_or_dir', verificando todos os arquivos @code{.py} ao longo do caminho. Se `file_or_dir' for um arquivo-fonte comum do Python, ele será verificado quanto a problemas relacionados ao espaço em branco. As mensagens de diagnóstico são gravadas na saída padrão usando a função @ref{fa9,,print()}.
@end deffn

@geindex verbose (no módulo tabnanny)
@anchor{library/tabnanny tabnanny verbose}@anchor{491a}
@deffn {Dado} tabnanny.verbose

Sinalizador indicando se as mensagens detalhadas devem ser impressas. Isso é incrementado pela opção @code{-v} se chamado como um script.
@end deffn

@geindex filename_only (no módulo tabnanny)
@anchor{library/tabnanny tabnanny filename_only}@anchor{491b}
@deffn {Dado} tabnanny.filename_only

Sinalizador indicando se os nomes dos arquivos devem ser impressos apenas com problemas relacionados a espaços em branco. Isso é definido como true pela opção @code{-q} se chamado como um script.
@end deffn

@geindex NannyNag
@anchor{library/tabnanny tabnanny NannyNag}@anchor{491c}
@deffn {Exceção} tabnanny.NannyNag

Levantada por @ref{491d,,process_tokens()} se detectar um recuo ambíguo. Capturado e manipulado em @ref{4919,,check()}.
@end deffn

@geindex process_tokens() (no módulo tabnanny)
@anchor{library/tabnanny tabnanny process_tokens}@anchor{491d}
@deffn {Função} tabnanny.process_tokens (tokens)

Esta função é usada por @ref{4919,,check()} para processar os tokens gerados pelo módulo @ref{fb,,tokenize}.
@end deffn

@c XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
@c reset_globals


@subsubheading Ver também



@table @asis

@item Módulo @ref{fb,,tokenize}

Scanner léxico para código-fonte Python.
@end table


@node pyclbr — Suporte a navegador de módulos do Python,py_compile — Compila arquivos fonte do Python,tabnanny — Detecção de indentação ambígua,Serviços da Linguagem Python
@anchor{library/pyclbr doc}@anchor{491e}@anchor{library/pyclbr module-pyclbr}@anchor{b4}@anchor{library/pyclbr pyclbr-python-module-browser-support}@anchor{491f}@anchor{library/pyclbr translation-repo}@anchor{4920}
@subsection @code{pyclbr} — Suporte a navegador de módulos do Python


@geindex module; pyclbr

`Código-fonte:' Lib/pyclbr.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pyclbr.py}


__________________________________________________________________


O módulo @ref{b4,,pyclbr} fornece informações limitadas sobre as funções, classes e métodos definidos em um módulo codificado em Python. As informações são suficientes para implementar um navegador de módulos. As informações são extraídas do código-fonte do Python em vez de importar o módulo, portanto, este módulo é seguro para uso com código não confiável. Essa restrição torna impossível o uso deste módulo com módulos não implementados no Python, incluindo todos os módulos de extensão padrão e opcionais.

@geindex readmodule() (no módulo pyclbr)
@anchor{library/pyclbr pyclbr readmodule}@anchor{82e}
@deffn {Função} pyclbr.readmodule (module, path=None)

Retorna um dicionário que mapeia os nomes de classe no nível do módulo aos descritores de classe. Se possível, descritores para classes base importadas estão incluídos. O parâmetro `module' é uma string com o nome do módulo a ser lido; pode ser o nome de um módulo dentro de um pacote. Se fornecido, `path' é uma sequência de caminhos de diretório anexada a @code{sys.path}, que é usada para localizar o código-fonte do módulo.

Esta função é a interface original e é mantida apenas para compatibilidade reversa. Ela retorna uma versão filtrada da seguinte.
@end deffn

@geindex readmodule_ex() (no módulo pyclbr)
@anchor{library/pyclbr pyclbr readmodule_ex}@anchor{82f}
@deffn {Função} pyclbr.readmodule_ex (module, path=None)

Retorna uma árvore baseada em dicionário que contém uma função ou descritores de classe para cada função e classe definida no módulo com uma instrução @code{def} ou @code{class}. O dicionário retornado mapeia os nomes das funções e das classes no nível do módulo para seus descritores. Objetos aninhados são inseridos no dicionário filho de seus pais. Como em readmodule, `module' nomeia o módulo a ser lido e `path' é anexado ao sys.path. Se o módulo que está sendo lido for um pacote, o dicionário retornado terá uma chave @code{'__path__'} cujo valor é uma lista que contém o caminho de pesquisa do pacote.
@end deffn


Adicionado na versão 3.7: Descritores para definições aninhadas. Eles são acessados através do novo atributo filho. Cada um tem um novo atributo pai.


Os descritores retornados por essas funções são instâncias das classes Function e Class. Não se espera que os usuários criem instâncias dessas classes.

@menu
* Objetos Function:: 
* Objetos classe: Objetos classe<2>. 

@end menu

@node Objetos Function,Objetos classe<2>,,pyclbr — Suporte a navegador de módulos do Python
@anchor{library/pyclbr function-objects}@anchor{4921}@anchor{library/pyclbr pyclbr-function-objects}@anchor{4922}
@subsubsection Objetos Function


@geindex Function (classe em pyclbr)
@anchor{library/pyclbr pyclbr Function}@anchor{4923}
@deffn {Classe} pyclbr.Function

Instâncias da classe @code{Function} descrevem funções definidas por instruções def. Elas têm os seguintes atributos:

@geindex file (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function file}@anchor{4924}
@deffn {Atributo} file

Nome do arquivo no qual a função está definida.
@end deffn

@geindex module (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function module}@anchor{4925}
@deffn {Atributo} module

O nome do módulo que define a função descrita.
@end deffn

@geindex name (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function name}@anchor{4926}
@deffn {Atributo} name

O nome da função.
@end deffn

@geindex lineno (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function lineno}@anchor{4927}
@deffn {Atributo} lineno

O número da linha no arquivo em que a definição é iniciada.
@end deffn

@geindex parent (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function parent}@anchor{4928}
@deffn {Atributo} parent

Para funções de nível superior, @code{None}. Para funções aninhadas, o pai.


Adicionado na versão 3.7.

@end deffn

@geindex children (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function children}@anchor{4929}
@deffn {Atributo} children

Um @ref{256,,dicionário} que mapeia nomes para descritores para funções e classes aninhadas.


Adicionado na versão 3.7.

@end deffn

@geindex is_async (atributo pyclbr.Function)
@anchor{library/pyclbr pyclbr Function is_async}@anchor{492a}
@deffn {Atributo} is_async

@code{True} para funções que são definidas com o prefixo @ref{5d1,,async}. Caso contrário, @code{False}.


Adicionado na versão 3.10.

@end deffn
@end deffn

@node Objetos classe<2>,,Objetos Function,pyclbr — Suporte a navegador de módulos do Python
@anchor{library/pyclbr class-objects}@anchor{492b}@anchor{library/pyclbr pyclbr-class-objects}@anchor{492c}
@subsubsection Objetos classe


@geindex Class (classe em pyclbr)
@anchor{library/pyclbr pyclbr Class}@anchor{492d}
@deffn {Classe} pyclbr.Class

Instâncias da classe @code{Class} descrevem classes definidas por instruções class. Elas têm os mesmos atributos que @ref{4923,,Functions} e mais dois.

@geindex file (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class file}@anchor{492e}
@deffn {Atributo} file

Nome do arquivo no qual a classe está definida.
@end deffn

@geindex module (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class module}@anchor{492f}
@deffn {Atributo} module

O nome do módulo que define a classe descrita.
@end deffn

@geindex name (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class name}@anchor{4930}
@deffn {Atributo} name

O nome da classe.
@end deffn

@geindex lineno (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class lineno}@anchor{4931}
@deffn {Atributo} lineno

O número da linha no arquivo em que a definição é iniciada.
@end deffn

@geindex parent (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class parent}@anchor{4932}
@deffn {Atributo} parent

Para classes de nível superior, @code{None}. Para classes aninhadas, o pai.


Adicionado na versão 3.7.

@end deffn

@geindex children (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class children}@anchor{4933}
@deffn {Atributo} children

Um dicionário que mapeia nomes para descritores para funções e classes aninhadas.


Adicionado na versão 3.7.

@end deffn

@geindex super (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class super}@anchor{4934}
@deffn {Atributo} super

Uma lista de objetos @code{Class} que descreve as classes base imediatas da classe que está sendo descrita. Classes nomeadas como superclasses, mas que não podem ser descobertas por @ref{82f,,readmodule_ex()} são listadas como uma string com o nome da classe em vez de como objetos de @code{Class}.
@end deffn

@geindex methods (atributo pyclbr.Class)
@anchor{library/pyclbr pyclbr Class methods}@anchor{4935}
@deffn {Atributo} methods

Um @ref{256,,dicionário} que mapeia nomes de métodos para números de linha. Isso pode ser derivado do dicionário @ref{4933,,children} mais novo, mas permanece para compatibilidade retroativa.
@end deffn
@end deffn

@node py_compile — Compila arquivos fonte do Python,compileall — Compilar bibliotecas do Python para bytecode,pyclbr — Suporte a navegador de módulos do Python,Serviços da Linguagem Python
@anchor{library/py_compile doc}@anchor{4936}@anchor{library/py_compile module-py_compile}@anchor{b3}@anchor{library/py_compile py-compile-compile-python-source-files}@anchor{4937}@anchor{library/py_compile translation-repo}@anchor{4938}
@subsection @code{py_compile} — Compila arquivos fonte do Python


@geindex module; py_compile

@c documentation based on module docstrings

`Código-fonte:' Lib/py_compile.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/py_compile.py}

@geindex arquivo;byte-code


__________________________________________________________________


O módulo @ref{b3,,py_compile} fornece uma função para gerar um arquivo de bytecode a partir de um arquivo fonte, e outra função usada quando o arquivo fonte do módulo é chamado como um script.

Embora nem sempre seja necessária, essa função pode ser útil ao instalar módulos para uso compartilhado, especialmente se alguns usuários não tiverem permissão para gravar os arquivos de cache de bytecodes no diretório que contém o código-fonte.

@geindex PyCompileError
@anchor{library/py_compile py_compile PyCompileError}@anchor{4939}
@deffn {Exceção} py_compile.PyCompileError

Exceção levantada quando ocorre um erro ao tentar compilar o arquivo.
@end deffn

@geindex compile() (no módulo py_compile)
@anchor{library/py_compile py_compile compile}@anchor{a2f}
@deffn {Função} py_compile.compile (file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP, quiet=0)

Compila um arquivo fonte para bytecode e grava o arquivo de cache de bytecode. O código-fonte é carregado a partir do arquivo chamado `file'. O bytecode é gravado em `cfile', cujo padrão é o caminho 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Propostas de Melhorias do Python; PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}, terminando em @code{.pyc}. Por exemplo, se `file' for @code{/foo/bar/baz.py}, o `cfile' será padronizado como @code{/foo/bar/__pycache__/baz.cpython-32.pyc} para o Python 3.2. Se `dfile' for especificado, ele será usado em vez de `file' como o nome do arquivo fonte do qual as linhas de origem são obtidas para exibição em tracebacks de exceção. Se `doraise' for verdadeiro, a @ref{4939,,PyCompileError} será levantada quando um erro for encontrado durante a compilação de `file'. Se `doraise' for false (o padrão), uma string de erros será gravada em @code{sys.stderr}, mas nenhuma exceção será levantada. Essa função retorna o caminho para o arquivo compilado em bytes, ou seja, qualquer valor `cfile' foi usado.

Os argumentos `doraise' e `quiet' determinam como os erros são tratados durante a compilação do arquivo. Se `quiet' for 0 ou 1 e `doraise' for false, o comportamento padrão será ativado: uma string de erros será gravada em @code{sys.stderr} e a função retornará @code{None} em vez de um caminho. Se `doraise' for verdadeiro, uma @ref{4939,,PyCompileError} será levantada. No entanto, se `quiet' for 2, nenhuma mensagem será escrita e `doraise' não terá efeito.

Se o caminho que `cfile' se tornar (especificado ou computado explicitamente) for um link simbólico ou um arquivo não regular, @ref{1056,,FileExistsError} será levantada. Isso serve como um aviso de que a importação transformará esses caminhos em arquivos regulares se for permitido gravar arquivos compilados em bytes nesses caminhos. Esse é um efeito colateral da importação usando a renomeação de arquivo para colocar o arquivo final compilado em bytecode para evitar problemas de gravação simultânea de arquivos.

`optimize' controla o nível de otimização e é passado para a função embutida @ref{192,,compile()}. O padrão de @code{-1} seleciona o nível de otimização do interpretador atual.

`invalidation_mode' deve ser um membro da enum @ref{493a,,PycInvalidationMode} e controla como o cache do bytecode gerado é invalidado em tempo de execução. O padrão é @ref{493b,,PycInvalidationMode.CHECKED_HASH} se a variável de ambiente 
@geindex SOURCE_DATE_EPOCH
@geindex variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} estiver configurada, caso contrário, o padrão é @ref{493c,,PycInvalidationMode.TIMESTAMP}.


Alterado na versão 3.2: Alterado o valor padrão de `cfile' para ficar em conformidade com a 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}. O padrão anterior era `file' + @code{'c'} (@code{'o'} se a otimização estivesse ativada). Também foi adicionado o parâmetro `optimize'.



Alterado na versão 3.4: Alterado o código para usar @ref{77,,importlib} para a gravação do arquivo de cache do bytecode. Isso significa que a semântica de criação/gravação de arquivo agora corresponde ao que @ref{77,,importlib} faz, por exemplo, permissões, semântica de gravação e movimentação, etc. Também foi adicionada a ressalva de que @ref{1056,,FileExistsError} é levantada se `cfile' for um link simbólico ou um arquivo não regular.



Alterado na versão 3.7: O parâmetro `invalidation_mode' foi adicionado conforme especificado em 
@geindex Propostas de Melhorias do Python; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/}. Se a variável de ambiente 
@geindex SOURCE_DATE_EPOCH
@geindex variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} estiver configurada, `invalidation_mode' será forçado a @ref{493b,,PycInvalidationMode.CHECKED_HASH}.



Alterado na versão 3.7.2: A variável de ambiente 
@geindex SOURCE_DATE_EPOCH
@geindex variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} não substitui mais o valor do argumento `invalidation_mode' e, em vez disso, determina seu valor padrão.



Alterado na versão 3.8: O parâmetro `quiet' foi adicionado.

@end deffn

@geindex PycInvalidationMode (classe em py_compile)
@anchor{library/py_compile py_compile PycInvalidationMode}@anchor{493a}
@deffn {Classe} py_compile.PycInvalidationMode

Uma enumeração de métodos possíveis que o interpretador pode usar para determinar se um arquivo de bytecode está atualizado com um arquivo fonte. O arquivo @code{.pyc} indica o modo de invalidação desejado em seu cabeçalho. Veja @ref{5ec,,Invalidação de bytecode em cache} para obter mais informações sobre como o Python invalida arquivos @code{.pyc} em tempo de execução.


Adicionado na versão 3.7.


@geindex TIMESTAMP (atributo py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode TIMESTAMP}@anchor{493c}
@deffn {Atributo} TIMESTAMP

O arquivo @code{.pyc} inclui o carimbo de data e hora e o tamanho do arquivo fonte, que o Python comparará com os metadados do arquivo fonte no tempo de execução para determinar se o arquivo @code{.pyc} precisa ser gerado novamente.
@end deffn

@geindex CHECKED_HASH (atributo py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode CHECKED_HASH}@anchor{493b}
@deffn {Atributo} CHECKED_HASH

O arquivo @code{.pyc} inclui um hash do conteúdo do arquivo fonte, com o qual o Python comparará o fonte em tempo de execução para determinar se o arquivo @code{.pyc} precisa ser gerado novamente.
@end deffn

@geindex UNCHECKED_HASH (atributo py_compile.PycInvalidationMode)
@anchor{library/py_compile py_compile PycInvalidationMode UNCHECKED_HASH}@anchor{493d}
@deffn {Atributo} UNCHECKED_HASH

Como @ref{493b,,CHECKED_HASH}, o arquivo @code{.pyc} inclui um hash do conteúdo do arquivo fonte. No entanto, em tempo de execução, o Python presumirá que o arquivo @code{.pyc} está atualizado e não validará o @code{.pyc} contra o arquivo fonte.

Essa opção é útil quando os @code{.pycs} são atualizados por algum sistema externo ao Python, como um sistema de compilação.
@end deffn
@end deffn

@menu
* Interface de linha de comando: Interface de linha de comando<15>. 

@end menu

@node Interface de linha de comando<15>,,,py_compile — Compila arquivos fonte do Python
@anchor{library/py_compile command-line-interface}@anchor{493e}@anchor{library/py_compile py-compile-cli}@anchor{493f}
@subsubsection Interface de linha de comando


Este módulo pode ser invocado como um script para compilar vários arquivos fonte. Os arquivos nomeados em `filenames' são compilados e o bytecode resultante é armazenado em cache da maneira normal. Este programa não pesquisa uma estrutura de diretórios para localizar arquivos de origem; ele apenas compila arquivos nomeados explicitamente. O status de saída será diferente de zero se um dos arquivos não puder ser compilado.

@geindex python--m-py_compile opção de linha de comando; <file>
@geindex python--m-py_compile opção de linha de comando; -
@anchor{library/py_compile cmdoption-python-m-py_compile-arg-file}@anchor{4940}
@deffn {Option} <file> ... <fileN>
@anchor{library/py_compile cmdoption-python-m-py_compile}@anchor{4941}
@deffnx {Option} @w{-}

Argumentos posicionais são arquivos para compilar. Se @code{-} for o único parâmetro, a lista de arquivos será obtida da entrada padrão.
@end deffn

@geindex python--m-py_compile opção de linha de comando; -q
@geindex python--m-py_compile opção de linha de comando; --quiet
@anchor{library/py_compile cmdoption-python-m-py_compile-q}@anchor{4942}@anchor{library/py_compile cmdoption-python-m-py_compile-quiet}@anchor{4943}
@deffn {Option} @w{-}q, @w{-}@w{-}quiet

Suprime a saída de erros.
@end deffn


Alterado na versão 3.2: Adicionado suporte a @code{-}.



Alterado na versão 3.10: Adicionado suporte a @ref{4942,,-q}.



@subsubheading Ver também



@table @asis

@item Módulo @ref{20,,compileall}

Utilitários para compilar todos os arquivos fontes Python em uma árvore de diretórios.
@end table


@node compileall — Compilar bibliotecas do Python para bytecode,dis — Disassembler de bytecode do Python,py_compile — Compila arquivos fonte do Python,Serviços da Linguagem Python
@anchor{library/compileall doc}@anchor{4944}@anchor{library/compileall compileall-byte-compile-python-libraries}@anchor{4945}@anchor{library/compileall module-compileall}@anchor{20}@anchor{library/compileall translation-repo}@anchor{4946}
@subsection @code{compileall} — Compilar bibliotecas do Python para bytecode


@geindex module; compileall

`Código-fonte:' Lib/compileall.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/compileall.py}


__________________________________________________________________


Este módulo fornece algumas funções utilitárias para dar suporte à instalação de bibliotecas Python. Essas funções compilam arquivos fonte Python em uma árvore de diretórios. Este módulo pode ser usado para criar os arquivos de bytecodes em cache no momento da instalação da biblioteca, o que os torna disponíveis para uso mesmo por usuários que não têm permissão de gravação nos diretórios da biblioteca.

@c include for modules that don't work on WASM

@ref{1ed8,,Disponibilidade}: not WASI.

Este módulo não funciona ou não está disponível em WebAssembly. Veja @ref{18f5,,Plataformas WebAssembly} para mais informações.

@menu
* Uso na linha de comando: Uso na linha de comando<12>. 
* Funções públicas:: 

@end menu

@node Uso na linha de comando<12>,Funções públicas,,compileall — Compilar bibliotecas do Python para bytecode
@anchor{library/compileall command-line-use}@anchor{4947}@anchor{library/compileall compileall-cli}@anchor{4948}
@subsubsection Uso na linha de comando


Este módulo pode funcionar como um script (usando @code{python -m compileall}) para compilar fontes do Python.

@geindex compileall opção de linha de comando; directory
@geindex compileall opção de linha de comando; file
@anchor{library/compileall cmdoption-compileall-arg-directory}@anchor{4949}
@deffn {Option} directory ...
@anchor{library/compileall cmdoption-compileall-arg-file}@anchor{494a}
@deffnx {Option} file ...

Argumentos posicionais são arquivos a serem compilados ou diretórios que contêm arquivos de origem, percorridos recursivamente. Se nenhum argumento for fornecido, comporta-se como se a linha de comando fosse  @code{-l @var{<diretórios do sys.path>}}.
@end deffn

@geindex compileall opção de linha de comando; -l
@anchor{library/compileall cmdoption-compileall-l}@anchor{494b}
@deffn {Option} @w{-}l

Não atua recursivamente em subdiretórios, apenas compila arquivos de código-fonte diretamente contidos nos diretórios nomeados ou implícitos.
@end deffn

@geindex compileall opção de linha de comando; -f
@anchor{library/compileall cmdoption-compileall-f}@anchor{494c}
@deffn {Option} @w{-}f

Força a recompilação, mesmo que os carimbos de data e hora estejam atualizados.
@end deffn

@geindex compileall opção de linha de comando; -q
@anchor{library/compileall cmdoption-compileall-q}@anchor{494d}
@deffn {Option} @w{-}q

Não imprime a lista de arquivos compilados. Se passado uma vez, as mensagens de erro ainda serão impressas. Se passado duas vezes (@code{-qq}), toda a saída é suprimida.
@end deffn

@geindex compileall opção de linha de comando; -d
@anchor{library/compileall cmdoption-compileall-d}@anchor{494e}
@deffn {Option} @w{-}d destdir

Diretório anexado ao caminho de cada arquivo que está sendo compilado. Isso aparecerá nos tracebacks em tempo de compilação e também será compilado no arquivo de bytecode, onde será usado em tracebacks e outras mensagens nos casos em que o arquivo de origem não exista no momento em que o arquivo de bytecode for executado.
@end deffn

@geindex compileall opção de linha de comando; -s
@anchor{library/compileall cmdoption-compileall-s}@anchor{494f}
@deffn {Option} @w{-}s strip_prefix

Remove o prefixo especificado dos caminhos gravados nos arquivos @code{.pyc}. Caminhos são tornados relativos ao prefixo.

Esta opção pode ser usada com @code{-p}, mas não com @code{-d}.
@end deffn

@geindex compileall opção de linha de comando; -p
@anchor{library/compileall cmdoption-compileall-p}@anchor{4950}
@deffn {Option} @w{-}p prepend_prefix

Adiciona o prefixo fornecido aos caminhos registrados nos arquivos @code{.pyc}. Use @code{-p /} para tornar os caminhos absolutos.

Esta opção pode ser usada com @code{-s}, mas não com @code{-d}.
@end deffn

@geindex compileall opção de linha de comando; -x
@anchor{library/compileall cmdoption-compileall-x}@anchor{4951}
@deffn {Option} @w{-}x regex

A expressão regular @code{regex} é usada para pesquisar o caminho completo para cada arquivo considerado para compilação e, se a @code{regex} produzir uma correspondência, o arquivo será ignorado.
@end deffn

@geindex compileall opção de linha de comando; -i
@anchor{library/compileall cmdoption-compileall-i}@anchor{4952}
@deffn {Option} @w{-}i list

Lê o arquivo @code{list} e adicione cada linha que ele contém à lista de arquivos e diretórios a serem compilados. Se @code{list} for @code{-}, lê as linhas do @code{stdin}.
@end deffn

@geindex compileall opção de linha de comando; -b
@anchor{library/compileall cmdoption-compileall-b}@anchor{4953}
@deffn {Option} @w{-}b

Escreve os arquivos de bytecode em seus locais e nomes legados, que podem sobrescrever arquivos de bytecode criados por outra versão do Python. O padrão é gravar arquivos em seus locais e nomes do 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, o que permite que arquivos de bytecode de várias versões do Python coexistam.
@end deffn

@geindex compileall opção de linha de comando; -r
@anchor{library/compileall cmdoption-compileall-r}@anchor{4954}
@deffn {Option} @w{-}r

Controla o nível máximo de recursão para subdiretórios. Se isso for dado, a opção @code{-l} não será levada em consideração. @code{python -m compileall <diretório> -r 0} é equivalente a @code{python -m compileall <diretório> -l}.
@end deffn

@geindex compileall opção de linha de comando; -j
@anchor{library/compileall cmdoption-compileall-j}@anchor{4955}
@deffn {Option} @w{-}j N

Usa `N' workers para compilar os arquivos dentro do diretório especificado. Se @code{0} for usado, o resultado de @ref{1c4,,os.process_cpu_count()} será usado.
@end deffn

@geindex compileall opção de linha de comando; --invalidation-mode
@anchor{library/compileall cmdoption-compileall-invalidation-mode}@anchor{4956}
@deffn {Option} @w{-}@w{-}invalidation@w{-}mode [timestamp|checked@w{-}hash|unchecked@w{-}hash]

Controla como os arquivos de bytecode gerados são invalidados no tempo de execução. O valor @code{timestamp} significa que os arquivos @code{.pyc} com o carimbo de data/hora do fonte e o tamanho incorporado serão gerados. Os valores @code{selected-hash} e @code{unchecked-hash} fazem com que os pycs baseados em hash sejam gerados. Arquivos pycs baseados em hash incorporam um hash do conteúdo do arquivo fonte em vez de um carimbo de data/hora. Veja @ref{5ec,,Invalidação de bytecode em cache} para obter mais informações sobre como o Python valida os arquivos de cache do bytecode em tempo de execução. O padrão é @code{timestamp} se a variável de ambiente 
@geindex SOURCE_DATE_EPOCH
@geindex variável de ambiente; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} não estiver configurada e @code{selected-hash} se a variável de ambiente @code{SOURCE_DATE_EPOCH} estiver configurada.
@end deffn

@geindex compileall opção de linha de comando; -o
@anchor{library/compileall cmdoption-compileall-o}@anchor{4957}
@deffn {Option} @w{-}o level

Compila com o nível de otimização fornecido. Pode ser usado várias vezes para compilar para vários níveis por vez (por exemplo, @code{compileall -o 1 -o 2}).
@end deffn

@geindex compileall opção de linha de comando; -e
@anchor{library/compileall cmdoption-compileall-e}@anchor{4958}
@deffn {Option} @w{-}e dir

Ignora links simbólicos que apontam para fora do diretório especificado.
@end deffn

@geindex compileall opção de linha de comando; --hardlink-dupes
@anchor{library/compileall cmdoption-compileall-hardlink-dupes}@anchor{4959}
@deffn {Option} @w{-}@w{-}hardlink@w{-}dupes

Se dois arquivos @code{.pyc} com nível de otimização diferente tiverem o mesmo conteúdo, usa links físicos para consolidar arquivos duplicados.
@end deffn


Alterado na versão 3.2: Adicionadas as opções @code{-i}, @code{-b} e @code{-h}.



Alterado na versão 3.5: Adicionadas as opções @code{-j}, @code{-r} e @code{-qq}. A opção @code{-q} foi alterada para um valor multinível. @code{-b} sempre produzirá um arquivo de bytecodes que termina em @code{.pyc}, nunca em @code{.pyo}.



Alterado na versão 3.7: Adicionada a opção @code{--invalidation-mode}.



Alterado na versão 3.9: Adicionadas as opções @code{-s}, @code{-p}, @code{-e} e @code{--hardlink-dupes}. Aumentado o limite de recursão padrão de 10 para @ref{4c4,,sys.getrecursionlimit()}. Adicionada a possibilidade de especificar a opção @code{-o} várias vezes.


Não há opção na linha de comando para controlar o nível de otimização usado pela função @ref{192,,compile()} porque o próprio interpretador Python já fornece a opção: @code{python -O -m compileall}.

Da mesma forma, a função @ref{192,,compile()} respeita a configuração @ref{9ac,,sys.pycache_prefix}. O cache do bytecode gerado somente será útil se @ref{192,,compile()} for executado com o mesmo @ref{9ac,,sys.pycache_prefix} (se houver) que será usado em tempo de execução.

@node Funções públicas,,Uso na linha de comando<12>,compileall — Compilar bibliotecas do Python para bytecode
@anchor{library/compileall public-functions}@anchor{495a}
@subsubsection Funções públicas


@geindex compile_dir() (no módulo compileall)
@anchor{library/compileall compileall compile_dir}@anchor{b38}
@deffn {Função} 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)

Desce recursivamente a árvore de diretórios nomeada por `dir', compilando todos os arquivos @code{.py} ao longo do caminho. Retorna um valor verdadeiro se todos os arquivos forem compilados com êxito e um valor falso caso contrário.

O parâmetro `maxlevels' é usado para limitar a profundidade da recursão; o padrão é @code{sys.getrecursionlimit()}.

Se `ddir' for fornecido, ele será anexado ao caminho de cada arquivo que está sendo compilado para uso em tracebacks em tempo de compilação e também será compilado no arquivo de bytecode, onde será usado em tracebacks e outras mensagens nos casos em que o arquivo de origem não existe no momento em que o arquivo de bytecode é executado.

Se `force' for verdadeiro, os módulos serão recompilados, mesmo que os carimbos de data e hora estejam atualizados.

Se `rx' for fornecido, seu método @code{search} será chamado no caminho completo para cada arquivo considerado para compilação e, se retornar um valor verdadeiro, o arquivo será ignorado. Isso pode ser usado para excluir arquivos correspondendo a uma expressão regular, dado como um objeto @ref{fbb,,re.Pattern}.

Se `quiet' for @code{False} ou @code{0} (o padrão), os nomes dos arquivos e outras informações serão impressos com o padrão. Definido como @code{1}, apenas os erros são impressos. Definido como @code{2}, toda a saída é suprimida.

Se `legacy' for verdadeiro, os arquivos de bytecodes serão gravados em seus locais e nomes herdados, o que poderá sobrescrever arquivos de bytecodes criados por outra versão do Python. O padrão é gravar arquivos em seus locais e nomes do 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, o que permite que arquivos de bytecodes de várias versões do Python coexistam.

`optimize' especifica o nível de otimização para o compilador. Ele é passado para a função embutida @ref{192,,compile()}. Aceita também uma sequência de níveis de otimização que levam a várias compilações de um arquivo @code{.py} em uma chamada.

O argumento `workers' especifica quantos workers são usados para compilar arquivos em paralelo. O padrão é não usar vários workers. Se a plataforma não puder usar vários workers e o argumento `workers' for fornecido, a compilação sequencial será usada como reserva. Se `workers' for 0, o número de núcleos no sistema é usado. Se `workers' for menor que @code{0}, a @ref{202,,ValueError} será levantada.

`invalidation_mode' deve ser um membro de enum @ref{493a,,py_compile.PycInvalidationMode} e controla como os pycs gerados são invalidados em tempo de execução.

Os argumentos `stripdir', `prependdir' e `limit_sl_dest' correspondem às opções @code{-s}, @code{-p} e @code{-e} descrita acima. eles podem ser especificados como @code{str} ou @ref{c6c,,os.PathLike}.

Se `hardlink_dupes' for verdadeiro e dois arquivos @code{.pyc} com nível de otimização diferente tiverem o mesmo conteúdo, usa links físicos para consolidar arquivos duplicados.


Alterado na versão 3.2: Adicionado os parâmetros `legacy' e `optimize'.



Alterado na versão 3.5: Adicionado o parâmetro `workers'.



Alterado na versão 3.5: O parâmetro `quiet' foi alterado para um valor multinível.



Alterado na versão 3.5: O parâmetro `legacy' grava apenas arquivos @code{.pyc}, não os arquivos @code{.pyo}, independentemente do valor de `optimize'.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.



Alterado na versão 3.7: O parâmetro `invalidation_mode' foi adicionado.



Alterado na versão 3.7.2: O valor padrão do parâmetro `invalidation_mode' é atualizado para @code{None}.



Alterado na versão 3.8: A definição de `workers' como 0 agora escolhe o número ideal de núcleos.



Alterado na versão 3.9: Adicionados os argumentos `stripdir', `prependdir', `limit_sl_dest' e `hardlink_dupes'. O valor padrão de `maxlevels' foi alterado de @code{10} para @code{sys.getrecursionlimit()}

@end deffn

@geindex compile_file() (no módulo compileall)
@anchor{library/compileall compileall compile_file}@anchor{e0b}
@deffn {Função} 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)

Compila o arquivo com o caminho `fullname'. Retorna um valor verdadeiro se o arquivo compilado com êxito e um valor falso caso contrário.

Se `ddir' for fornecido, ele será anexado ao caminho do arquivo que está sendo compilado para uso em rastreamentos em tempo de compilação e também será compilado no arquivo de bytecode, onde será usado em tracebacks e outras mensagens nos casos em que o arquivo fonte não existe no momento em que o arquivo de bytecode é executado.

Se `rx' for fornecido, seu método @code{search} passará o nome do caminho completo para o arquivo que está sendo compilado e, se retornar um valor verdadeiro, o arquivo não será compilado e @code{True} será retornado. Isso pode ser usado para excluir arquivos correspondendo a uma expressão regular, dado como um objeto @ref{fbb,,re.Pattern}.

Se `quiet' for @code{False} ou @code{0} (o padrão), os nomes dos arquivos e outras informações serão impressos com o padrão. Definido como @code{1}, apenas os erros são impressos. Definido como @code{2}, toda a saída é suprimida.

Se `legacy' for verdadeiro, os arquivos de bytecodes serão gravados em seus locais e nomes herdados, o que poderá sobrescrever arquivos de bytecodes criados por outra versão do Python. O padrão é gravar arquivos em seus locais e nomes do 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}, o que permite que arquivos de bytecodes de várias versões do Python coexistam.

`optimize' especifica o nível de otimização para o compilador. Ele é passado para a função embutida @ref{192,,compile()}. Aceita também uma sequência de níveis de otimização que levam a várias compilações de um arquivo @code{.py} em uma chamada.

`invalidation_mode' deve ser um membro de enum @ref{493a,,py_compile.PycInvalidationMode} e controla como os pycs gerados são invalidados em tempo de execução.

Os argumentos `stripdir', `prependdir' e `limit_sl_dest' correspondem às opções @code{-s}, @code{-p} e @code{-e} descrita acima. eles podem ser especificados como @code{str} ou @ref{c6c,,os.PathLike}.

Se `hardlink_dupes' for verdadeiro e dois arquivos @code{.pyc} com nível de otimização diferente tiverem o mesmo conteúdo, usa links físicos para consolidar arquivos duplicados.


Adicionado na versão 3.2.



Alterado na versão 3.5: O parâmetro `quiet' foi alterado para um valor multinível.



Alterado na versão 3.5: O parâmetro `legacy' grava apenas arquivos @code{.pyc}, não os arquivos @code{.pyo}, independentemente do valor de `optimize'.



Alterado na versão 3.7: O parâmetro `invalidation_mode' foi adicionado.



Alterado na versão 3.7.2: O valor padrão do parâmetro `invalidation_mode' é atualizado para @code{None}.



Alterado na versão 3.9: Adicionados os argumentos `stripdir', `prependdir', `limit_sl_dest' e `hardlink_dupes'.

@end deffn

@geindex compile_path() (no módulo compileall)
@anchor{library/compileall compileall compile_path}@anchor{e0c}
@deffn {Função} compileall.compile_path (skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=None)

Compila Byte para bytecodes todos os arquivos @code{.py} encontrados ao longo de @code{sys.path}. Retorna um valor verdadeiro se todos os arquivos forem compilados com êxito e um valor falso caso contrário.

Se `skip_curdir' for verdadeiro (o padrão), o diretório atual não será incluído na pesquisa. Todos os outros parâmetros são passados para a função @ref{b38,,compile_dir()}. Note que, ao contrário das outras funções de compilação, @code{maxlevels} é padronizado como @code{0}.


Alterado na versão 3.2: Adicionado os parâmetros `legacy' e `optimize'.



Alterado na versão 3.5: O parâmetro `quiet' foi alterado para um valor multinível.



Alterado na versão 3.5: O parâmetro `legacy' grava apenas arquivos @code{.pyc}, não os arquivos @code{.pyo}, independentemente do valor de `optimize'.



Alterado na versão 3.7: O parâmetro `invalidation_mode' foi adicionado.



Alterado na versão 3.7.2: O valor padrão do parâmetro `invalidation_mode' é atualizado para @code{None}.

@end deffn

Para forçar uma recompilação de todos os arquivos @code{.py} no subdiretório @code{Lib/} e todos os seus subdiretórios:

@example
import compileall

compileall.compile_dir('Lib/', force=True)

# Efetua a mesma compilação, excluindo arquivos em diretórios .svn.
import re
compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)

# Objetos pathlib.Path também podem ser usados.
import pathlib
compileall.compile_dir(pathlib.Path('Lib/'), force=True)
@end example


@subsubheading Ver também



@table @asis

@item Módulo @ref{b3,,py_compile}

Compila para bytecode um único arquivo fonte.
@end table


@node dis — Disassembler de bytecode do Python,pickletools — Ferramentas para desenvolvedores pickle,compileall — Compilar bibliotecas do Python para bytecode,Serviços da Linguagem Python
@anchor{library/dis doc}@anchor{495b}@anchor{library/dis dis-disassembler-for-python-bytecode}@anchor{495c}@anchor{library/dis module-dis}@anchor{38}@anchor{library/dis translation-repo}@anchor{495d}
@subsection @code{dis} — Disassembler de bytecode do Python


@geindex module; dis

`Código-fonte:' Lib/dis.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/dis.py}

@c import dis
@c def myfunc(alist):
@c     return len(alist)


__________________________________________________________________


O módulo @ref{38,,dis} oferece suporte à análise de @ref{187,,bytecode} do CPython, desmontando-o. O bytecode do CPython que o módulo leva como entrada é definido no arquivo @code{Include/opcode.h} e usado pelo compilador e pelo interpretador.

O bytecode é um detalhe de implementação do interpretador CPython. Não há garantias de que bytecodes não serão adicionados, removidos ou alterados entre as versões do Python. O uso deste módulo não deve ser considerado que funcionará em todas as VMs do Python ou mesmo versões do Python.


Alterado na versão 3.6: Cada instrução ocupa 2 bytes. Anteriormente, o número de bytes variava de acordo com a instrução.



Alterado na versão 3.10: O argumento para instruções de pulo, tratamento de exceção e laço é agora o deslocamento em instruções, ao invés de em bytes.



Alterado na versão 3.11: Algumas instruções vêm acompanhadas de uma ou mais entradas de cache em linha, as quais assumem a forma de instruções @ref{6f9,,CACHE}. Tais instruções são escondidas por padrão, mas podem ser visualizadas passando @code{show_caches=True} para qualquer utilidade do @ref{38,,dis}. Além disso, o interpretador agora adapta o bytecode para especializá-lo a diferentes condições de tempo de execução. O bytecode adaptativo pode ser visualizado passando @code{adaptive=True}.



Alterado na versão 3.12: O argumento de um pulo é o deslocamento da instrução alvo relativo à instrução que aparece imediatamente após as entradas @ref{6f9,,CACHE} da instrução de pulo.

Como consequência, a presença de instruções @ref{6f9,,CACHE} é transparente para pulos adiante, mas precisa ser considerada ao lidar com pulos para trás.



Alterado na versão 3.13: A saída agora mostra rótulos lógicos ao invés dos deslocamentos das instruções para alvos de pulos e de tratadores de exceções. A opção de linha de comando @code{-O} e o argumento @code{show_offsets} foram adicionados.


Exemplo: Dada a função @code{myfunc()}:

@example
def myfunc(alist):
    return len(alist)
@end example

o comando a seguir pode ser usado para mostrar a desconstrução de @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

(O “2” é o número da linha).

@menu
* Interface de linha de comando: Interface de linha de comando<16>. 
* Análise de bytecode:: 
* Funções de análise:: 
* Instruções em bytecode do Python:: 
* Opcode collections:: 

@end menu

@node Interface de linha de comando<16>,Análise de bytecode,,dis — Disassembler de bytecode do Python
@anchor{library/dis command-line-interface}@anchor{495e}@anchor{library/dis dis-cli}@anchor{495f}
@subsubsection Interface de linha de comando


O módulo @ref{38,,dis} pode ser invocado como um script na linha de comando:

@example
python -m dis [-h] [-C] [-O] [infile]
@end example

As seguintes opções são aceitas:

@geindex dis opção de linha de comando; -h
@geindex dis opção de linha de comando; --help
@anchor{library/dis cmdoption-dis-h}@anchor{4960}@anchor{library/dis cmdoption-dis-help}@anchor{4961}
@deffn {Option} @w{-}h, @w{-}@w{-}help

Exibe o modo de uso e sai.
@end deffn

@geindex dis opção de linha de comando; -C
@geindex dis opção de linha de comando; --show-caches
@anchor{library/dis cmdoption-dis-C}@anchor{4962}@anchor{library/dis cmdoption-dis-show-caches}@anchor{4963}
@deffn {Option} @w{-}C, @w{-}@w{-}show@w{-}caches

Mostra caches em linha


Adicionado na versão 3.13.

@end deffn

@geindex dis opção de linha de comando; -O
@geindex dis opção de linha de comando; --show-offsets
@anchor{library/dis cmdoption-dis-O}@anchor{1d8}@anchor{library/dis cmdoption-dis-show-offsets}@anchor{4964}
@deffn {Option} @w{-}O, @w{-}@w{-}show@w{-}offsets

Mostra os deslocamentos das instruções


Adicionado na versão 3.13.

@end deffn

Se @code{infile} for especificada, o seu código desmontado será escrito no stdout. Caso contrário, será feito o desmonte da compilação do código-fonte recebido do stdin.

@node Análise de bytecode,Funções de análise,Interface de linha de comando<16>,dis — Disassembler de bytecode do Python
@anchor{library/dis bytecode-analysis}@anchor{4965}
@subsubsection Análise de bytecode



Adicionado na versão 3.4.


A API de análise de bytecode permite que partes do código Python sejam encapsuladas em um objeto @ref{f61,,Bytecode} que facilite o acesso aos detalhes do código compilado.

@geindex Bytecode (classe em dis)
@anchor{library/dis dis Bytecode}@anchor{f61}
@deffn {Classe} dis.Bytecode (x, *, first_line=None, current_offset=None, show_caches=False, adaptive=False, show_offsets=False)

Analisa o bytecode correspondente a uma função, um gerador, um gerador assíncrono, uma corrotina, um método, uma string de código-fonte, ou um objeto de código (conforme retornado por @ref{192,,compile()}).

Esta é um invólucro de conveniência que encapsula muitas das funções listadas abaixo, principalmente a @ref{1d9,,get_instructions()}, já que iterar sobre sobre uma instância de @ref{f61,,Bytecode} produz operações bytecode como instâncias de @ref{1da,,Instruction}.

Se `first_line' não for @code{None}, ele indica o número de linha que deve ser reportado para a primeira linha de código-fonte no código desmontado.  Caso contrário, a informação de linha de código-fonte (se houver) é extraída diretamente da desconstrução do objeto de código.

Se `current_offset' não for @code{None}, ele é um deslocamento em instruções no código desconstruído. Definir este argumento significa que o @ref{f62,,dis()} vai mostrar um marcador de “instrução atual” sobre o opcode especificado.

Se `show_caches' for @code{True}, o @ref{f62,,dis()} vai exibir entradas de cache em linha usadas pelo interpretador para especializar o bytecode.

Se `adaptive' for @code{True}, o @ref{f62,,dis()} vai exibir bytecode especializado que pode ser diferente do bytecode original.

Se `show_offsets' for @code{True}, o @ref{f62,,dis()} vai incluir deslocamentos em instruções na saída.

@geindex from_traceback() (método de classe dis.Bytecode)
@anchor{library/dis dis Bytecode from_traceback}@anchor{f63}
@deffn {Método} classmethod from_traceback (tb, *, show_caches=False)

Constrói uma instância de @ref{f61,,Bytecode} a partir do traceback fornecido, definindo `current_offset' apontando para a instrução responsável pela exceção.
@end deffn

@geindex Bytecode.codeobj (no módulo dis)
@anchor{library/dis dis Bytecode codeobj}@anchor{4966}
@deffn {Dado} codeobj

O objeto de código compilado.
@end deffn

@geindex Bytecode.first_line (no módulo dis)
@anchor{library/dis dis Bytecode first_line}@anchor{4967}
@deffn {Dado} first_line

A primeira linha de código-fonte do objeto de código (caso disponível).
@end deffn

@geindex dis() (método dis.Bytecode)
@anchor{library/dis dis Bytecode dis}@anchor{f62}
@deffn {Método} dis ()

Retorna uma visualização formatada das operações em bytecode (as mesmas que seriam impressas pela @ref{b46,,dis.dis()}, mas retornadas como uma string multilinha).
@end deffn

@geindex info() (método dis.Bytecode)
@anchor{library/dis dis Bytecode info}@anchor{4968}
@deffn {Método} info ()

Retorna uma string multilinha formatada com informação detalhada sobre o objeto de código, como @ref{127a,,code_info()}.
@end deffn


Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.



Alterado na versão 3.11: Adicionados os parâmetros `show_caches' e `adaptive'.

@end deffn

Exemplo:

@example
>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST
CALL
RETURN_VALUE
@end example

@node Funções de análise,Instruções em bytecode do Python,Análise de bytecode,dis — Disassembler de bytecode do Python
@anchor{library/dis analysis-functions}@anchor{4969}
@subsubsection Funções de análise


O módulo @ref{38,,dis} também define as seguintes funções que convertem a entrada diretamente para a saída desejada. Elas podem ser úteis se somente uma única operação está sendo feita, de forma que o objeto de análise intermediário não é útil:

@geindex code_info() (no módulo dis)
@anchor{library/dis dis code_info}@anchor{127a}
@deffn {Função} dis.code_info (x)

Retorna uma string multilinha formatada com informação detalhada sobre o objeto de código correspondente à função, gerador, gerador assíncrono, corrotina, método, string de código-fonte ou objeto de código fornecido.

Observe que o conteúdo exato de strings de informação de código são altamente dependentes da implementação e podem mudar de forma arbitrária através de VMs Python ou lançamentos do Python.


Adicionado na versão 3.2.



Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.

@end deffn

@geindex show_code() (no módulo dis)
@anchor{library/dis dis show_code}@anchor{f5e}
@deffn {Função} dis.show_code (x, *, file=None)

Imprime no arquivo `file' (ou @code{sys.stdout} caso `file' não seja especificado) informações detalhadas sobre o objeto de código correspondente à função, método, string de código-fonte fornecido.

Este é um atalho conveniente para @code{print(code_info(x), file=file)}, destinado à exploração interativa no prompt do interpretador.


Adicionado na versão 3.2.



Alterado na versão 3.4: Adicionado o parâmetro `file'.

@end deffn

@geindex dis() (no módulo dis)
@anchor{library/dis dis dis}@anchor{b46}
@deffn {Função} dis.dis (x=None, *, file=None, depth=None, show_caches=False, adaptive=False)

Desmonta o objeto `x'.  `x' pode denotar um módulo, uma classe, um método, uma função, um gerador, um gerador assíncrono, uma corrotina, um objeto de código, uma string de código-fonte ou uma sequência de bytes contendo bytecode bruto. Para um módulo, são desmontadas todas as funções. Para uma classe, são desmontados todos os métodos (incluindo métodos de classe e estáticos). Para um objeto de código ou sequência de bytecodes brutos, é impressa uma linha para cada instrução de bytecode. Além disso, objetos de código aninhados são desmontados recursivamente. Estes podem incluir expressões geradoras, funções aninhadas, corpos de classes aninhadas, e objetos de código usados para @ref{188,,escopos de anotação}. Strings são compiladas para objetos de código com a função embutida @ref{192,,compile()} antes de serem desmontadas.  Se nenhum objeto for fornecido, o último traceback é desmontado.

O resultado é escrito como texto no arquivo `file' caso tenha sido fornecido como argumento, ou para @code{sys.stdout} caso contrário.

A profundidade máxima de recursão é limitada por `depth' a menos que seja @code{None}. @code{depth=0} significa não fazer recursão.

Se `show_caches' for @code{True}, essa função vai exibir entradas de cache em linha usadas pelo interpretador para especializar o bytecode.

Se `adaptive' for @code{True}, essa função vai exibir bytecode especializado que pode ser diferente do bytecode original.


Alterado na versão 3.4: Adicionado o parâmetro `file'.



Alterado na versão 3.7: Foi implementada a desmontagem recursiva, e adicionado o parâmetro `depth'.



Alterado na versão 3.7: Este método agora lida com objetos de corrotina e de gerador assíncrono.



Alterado na versão 3.11: Adicionados os parâmetros `show_caches' e `adaptive'.

@end deffn

@geindex distb() (no módulo dis)
@anchor{library/dis dis distb}@anchor{f5f}
@deffn {Função} dis.distb (tb=None, *, file=None, show_caches=False, adaptive=False, show_offset=False)

Desmonta a função no topo da pilha de um traceback, usando o último traceback caso nenhum tenha sido passado.  A instrução que causou a exceção é indicada.

O resultado é escrito como texto no arquivo `file' caso tenha sido fornecido como argumento, ou para @code{sys.stdout} caso contrário.


Alterado na versão 3.4: Adicionado o parâmetro `file'.



Alterado na versão 3.11: Adicionados os parâmetros `show_caches' e `adaptive'.



Alterado na versão 3.13: Foi adicionado o parâmetro `show_offsets'.

@end deffn

@geindex disassemble() (no módulo dis)
@anchor{library/dis dis disassemble}@anchor{f60}
@deffn {Função} dis.disassemble (code, lasti=-1, *, file=None, show_caches=False, adaptive=False)

@deffnx {Função} disco(code, lasti=@w{-}1, *, file=None, show_caches=False, adaptive=False,

@deffnx {Função} show_offsets=False)

Desmonta um objeto de código, indicando a última instrução se `lasti' tiver sido fornecido.  A saída é dividida em colunas da seguinte forma:


@enumerate 

@item 
o número da linha, para a primeira instrução de cada linha

@item 
a instrução atual, indicada por @code{-->},

@item 
um rótulo da instrução, indicado com @code{>>},

@item 
o endereço da instrução

@item 
o nome do código da operação,

@item 
os parâmetros da operação, e

@item 
a interpretação dos parâmetros, em parênteses.
@end enumerate

A interpretação dos parâmetros reconhece nomes de variáveis locais e globais, valores de constantes, alvos de ramificações, e operadores de comparação.

O resultado é escrito como texto no arquivo `file' caso tenha sido fornecido como argumento, ou para @code{sys.stdout} caso contrário.


Alterado na versão 3.4: Adicionado o parâmetro `file'.



Alterado na versão 3.11: Adicionados os parâmetros `show_caches' e `adaptive'.



Alterado na versão 3.13: Foi adicionado o parâmetro `show_offsets'.

@end deffn

@geindex get_instructions() (no módulo dis)
@anchor{library/dis dis get_instructions}@anchor{1d9}
@deffn {Função} dis.get_instructions (x, *, first_line=None, show_caches=False, adaptive=False)

Retorna um iterador sobre as instruções na função, método, string de código-fonte ou objeto de código fornecido.

O iterador gera uma série de tuplas nomeadas @ref{1da,,Instruction} contendo detalhes de cada operação no código fornecido.

Se `first_line' não for @code{None}, ele indica o número de linha que deve ser reportado para a primeira linha de código-fonte no código desmontado.  Caso contrário, a informação de linha de código-fonte (se houver) é extraída diretamente da desconstrução do objeto de código.

O parâmetro `adaptive' funciona assim como na função @ref{38,,dis()}.


Adicionado na versão 3.4.



Alterado na versão 3.11: Adicionados os parâmetros `show_caches' e `adaptive'.



Alterado na versão 3.13: O parâmetro `show_caches' foi descontinuado e não tem mais efeito. O iterador gera as instâncias da @ref{1da,,Instruction} com o campo `cache_info' populado (independentemente do valor de `show_caches') e não gera mais items separados para as entradas de cache.

@end deffn

@geindex findlinestarts() (no módulo dis)
@anchor{library/dis dis findlinestarts}@anchor{496a}
@deffn {Função} dis.findlinestarts (code)

Essa função geradora usa o método @ref{2fb,,co_lines()} do @ref{1d2,,objeto de código} `code' para encontrar as posições que correspondem aos inícios de cada linha do código-fonte.  Elas são geradas em pares @code{(offset, lineno)}.


Alterado na versão 3.6: Números de linhas podem ser decrescentes. Antes, eles eram sempre crescentes.



Alterado na versão 3.10: O método @ref{2fb,,co_lines()} da 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} é usado ao invés dos atributos @ref{20d4,,co_firstlineno} e @ref{2e0,,co_lnotab} do @ref{1d2,,objeto de código}.



Alterado na versão 3.13: Números de linha podem ser @code{None} para bytecode que não corresponde a um código-fonte.

@end deffn

@geindex findlabels() (no módulo dis)
@anchor{library/dis dis findlabels}@anchor{496b}
@deffn {Função} dis.findlabels (code)

Detecta todas as posições na string de bytecode compilado bruto `code' que são alvos de pulos, e as retorna em uma lista.
@end deffn

@geindex stack_effect() (no módulo dis)
@anchor{library/dis dis stack_effect}@anchor{f64}
@deffn {Função} dis.stack_effect (opcode, oparg=None, *, jump=None)

Calcula o efeito que o `opcode' com argumento `oparg' tem na pilha.

Se a operação tiver um alvo de pulo e `jump' for @code{True}, @ref{f64,,stack_effect()} vai retornar o efeito na pilha de realizar o pulo.  Se `jump' for @code{False}, ela vai retornar o efeito na pilha de não pular. E se `jump' for @code{None} (o padrão), vai retornar o efeito máximo na pilha dentre os dois casos.


Adicionado na versão 3.4.



Alterado na versão 3.8: Adicionado o parâmetro `jump'.



Alterado na versão 3.13: Se @code{oparg} for omitido (ou @code{None}), agora é retornado o efeito na pilha para o caso @code{oparg=0}. Anteriormente isso era um erro caso o opcode usasse o seu argumento. Além disso, agora não é mais um erro passar um inteiro como @code{oparg} quando o @code{opcode} não o usa; o @code{oparg} nesse caso é ignorado.

@end deffn

@node Instruções em bytecode do Python,Opcode collections,Funções de análise,dis — Disassembler de bytecode do Python
@anchor{library/dis bytecodes}@anchor{5b2}@anchor{library/dis python-bytecode-instructions}@anchor{496c}
@subsubsection Instruções em bytecode do Python


A função @ref{1d9,,get_instructions()} e a classe @ref{f61,,Bytecode} fornecem detalhes de instruções de bytecode como instâncias de @ref{1da,,Instruction}:

@geindex Instruction (classe em dis)
@anchor{library/dis dis Instruction}@anchor{1da}
@deffn {Classe} dis.Instruction

Detalhes de uma operação em bytecode

@geindex Instruction.opcode (no módulo dis)
@anchor{library/dis dis Instruction opcode}@anchor{496d}
@deffn {Dado} opcode

código numérico da operação, correspondendo aos valores dos opcodes listados abaixo e aos valores dos bytecodes nas @ref{496e,,Opcode collections}.
@end deffn

@geindex Instruction.opname (no módulo dis)
@anchor{library/dis dis Instruction opname}@anchor{496f}
@deffn {Dado} opname

nome legível por humanos para a operação
@end deffn

@geindex Instruction.baseopcode (no módulo dis)
@anchor{library/dis dis Instruction baseopcode}@anchor{4970}
@deffn {Dado} baseopcode

código numérico para a operação base caso a operação seja especializada; caso contrário, igual ao @ref{496d,,opcode}
@end deffn

@geindex Instruction.baseopname (no módulo dis)
@anchor{library/dis dis Instruction baseopname}@anchor{4971}
@deffn {Dado} baseopname

nome legível por humanos para a operação base caso a operação seja especializada; caso contrário, igual ao @ref{4972,,opname}
@end deffn

@geindex Instruction.arg (no módulo dis)
@anchor{library/dis dis Instruction arg}@anchor{4973}
@deffn {Dado} arg

argumento numérico para a operação (se houver), caso contrário @code{None}
@end deffn

@geindex Instruction.oparg (no módulo dis)
@anchor{library/dis dis Instruction oparg}@anchor{4974}
@deffn {Dado} oparg

apelido para @ref{4973,,arg}
@end deffn

@geindex Instruction.argval (no módulo dis)
@anchor{library/dis dis Instruction argval}@anchor{4975}
@deffn {Dado} argval

valor resolvido do argumento (se houver), caso contrário @code{None}
@end deffn

@geindex Instruction.argrepr (no módulo dis)
@anchor{library/dis dis Instruction argrepr}@anchor{4976}
@deffn {Dado} argrepr

descrição legível por humanos do argumento da operação (se houver), caso contrário uma string vazia.
@end deffn

@geindex Instruction.offset (no módulo dis)
@anchor{library/dis dis Instruction offset}@anchor{4977}
@deffn {Dado} offset

índice de início da operação dentro da sequência de bytecodes
@end deffn

@geindex Instruction.start_offset (no módulo dis)
@anchor{library/dis dis Instruction start_offset}@anchor{4978}
@deffn {Dado} start_offset

índice de início da operação dentro da sequência de bytecodes, incluindo as operações de @code{EXTENDED_ARG} prefixadas, caso presentes; caso contrário, igual a @ref{4977,,offset}
@end deffn

@geindex Instruction.cache_offset (no módulo dis)
@anchor{library/dis dis Instruction cache_offset}@anchor{4979}
@deffn {Dado} cache_offset

índice de início das entradas de cache que seguem a operação
@end deffn

@geindex Instruction.end_offset (no módulo dis)
@anchor{library/dis dis Instruction end_offset}@anchor{497a}
@deffn {Dado} end_offset

índice de fim das entradas de cache que seguem a operação
@end deffn

@geindex Instruction.starts_line (no módulo dis)
@anchor{library/dis dis Instruction starts_line}@anchor{497b}
@deffn {Dado} starts_line

@code{True} se esse opcode inicia uma linha, @code{False} caso contrário
@end deffn

@geindex Instruction.line_number (no módulo dis)
@anchor{library/dis dis Instruction line_number}@anchor{497c}
@deffn {Dado} line_number

linha de código-fonte associada a esse opcode (se houver), senão @code{None}
@end deffn

@geindex Instruction.is_jump_target (no módulo dis)
@anchor{library/dis dis Instruction is_jump_target}@anchor{497d}
@deffn {Dado} is_jump_target

@code{True} se algum outro código pula para cá, senão @code{False}
@end deffn

@geindex Instruction.jump_target (no módulo dis)
@anchor{library/dis dis Instruction jump_target}@anchor{497e}
@deffn {Dado} jump_target

índice do bytecode que é alvo do pulo caso essa seja uma operação de pulo, caso contrário @code{None}
@end deffn

@geindex Instruction.positions (no módulo dis)
@anchor{library/dis dis Instruction positions}@anchor{497f}
@deffn {Dado} positions

objeto @ref{46f1,,dis.Positions} contendo os pontos de início e fim cobertos por esta instrução.
@end deffn

@geindex Instruction.cache_info (no módulo dis)
@anchor{library/dis dis Instruction cache_info}@anchor{4980}
@deffn {Dado} cache_info

Informações sobre as entradas de cache desta instrução, como tripletos do formato @code{(nome, tamanho, dados)}, onde @code{nome} e @code{tamanho} descrevem o formato do cache e dados são o conteúdo do cache. @code{cache_info} é @code{None} se a instrução não tiver caches.
@end deffn


Adicionado na versão 3.4.



Alterado na versão 3.11: Adicionado o campo @code{positions}.



Alterado na versão 3.13: Alterado o campo @code{starts_line}.

Adicionados os campos @code{start_offset}, @code{cache_offset}, @code{end_offset}, @code{baseopname}, @code{baseopcode}, @code{jump_target}, @code{oparg}, @code{line_number} e @code{cache_info}.

@end deffn

@geindex Positions (classe em dis)
@anchor{library/dis dis Positions}@anchor{46f1}
@deffn {Classe} dis.Positions

Caso a informação não esteja disponível, alguns campos podem ser @code{None}.

@geindex Positions.lineno (no módulo dis)
@anchor{library/dis dis Positions lineno}@anchor{4981}
@deffn {Dado} lineno
@end deffn

@geindex Positions.end_lineno (no módulo dis)
@anchor{library/dis dis Positions end_lineno}@anchor{4982}
@deffn {Dado} end_lineno
@end deffn

@geindex Positions.col_offset (no módulo dis)
@anchor{library/dis dis Positions col_offset}@anchor{4983}
@deffn {Dado} col_offset
@end deffn

@geindex Positions.end_col_offset (no módulo dis)
@anchor{library/dis dis Positions end_col_offset}@anchor{4984}
@deffn {Dado} end_col_offset
@end deffn


Adicionado na versão 3.11.

@end deffn

O compilador de Python atualmente gera as seguintes instruções de bytecode.

`Instruções gerais'

A seguir, vamos usar @code{STACK} para nos referirmos à pilha do interpretador, e vamos descrever operações nela como se ela fosse uma lista do Python. Nessa linguagem, @code{STACK[-1]} é o topo da pilha.

@geindex NOP (opcode)
@anchor{library/dis opcode-NOP}@anchor{4985}
@deffn {Opcode} NOP

Código para não fazer nada.  Usado como espaço reservado pelo otimizador de bytecode, e para gerar eventos de rastreamento de linha.
@end deffn

@geindex POP_TOP (opcode)
@anchor{library/dis opcode-POP_TOP}@anchor{4986}
@deffn {Opcode} POP_TOP

Remove o item no topo da pilha:

@example
STACK.pop()
@end example
@end deffn

@geindex END_FOR (opcode)
@anchor{library/dis opcode-END_FOR}@anchor{4987}
@deffn {Opcode} END_FOR

Remove o item no topo da pilha. Equivalente a @code{POP_TOP}. Usado como limpeza ao final de laços, o que explica o nome.


Adicionado na versão 3.12.

@end deffn

@geindex END_SEND (opcode)
@anchor{library/dis opcode-END_SEND}@anchor{4988}
@deffn {Opcode} END_SEND

Implementa @code{del STACK[-2]}. Usado como limpeza quando um gerador termina.


Adicionado na versão 3.12.

@end deffn

@geindex COPY (opcode)
@anchor{library/dis opcode-COPY}@anchor{709}
@deffn {Opcode} COPY (i)

Coloca o i-ésimo item no topo da pilha sem removê-lo da sua posição original:

@example
assert i > 0
STACK.append(STACK[-i])
@end example


Adicionado na versão 3.11.

@end deffn

@geindex SWAP (opcode)
@anchor{library/dis opcode-SWAP}@anchor{70a}
@deffn {Opcode} SWAP (i)

Troca o topo da pilha de lugar com o i-ésimo elemento.

@example
STACK[-i], STACK[-1] = STACK[-1], STACK[-i]
@end example


Adicionado na versão 3.11.

@end deffn

@geindex CACHE (opcode)
@anchor{library/dis opcode-CACHE}@anchor{6f9}
@deffn {Opcode} CACHE

Ao invés de ser uma instrução de fato, este opcode é usado para demarcar espaço extra para o interpretador armazenar dados úteis diretamente no próprio bytecode. É escondido automaticamente por todas as utilidades do @code{dis}, mas pode ser visualizado com @code{show_caches=True}.

Do ponto de vista lógico, este espaço faz parte da instrução anterior. Muitos opcodes esperam ser seguidos por um número exato de caches, e instruem o interpretador a pulá-los em tempo de execução.

Caches populados podem se parecer com qualquer instrução, de forma que ler ou modificar bytecode adaptativo bruto contendo dados “quickened” requer muito cuidado.


Adicionado na versão 3.11.

@end deffn

`Operações unárias'

Operações unárias tiram o topo da pilha, aplicam a operação, e põem o resultado de volta na pilha.

@geindex UNARY_NEGATIVE (opcode)
@anchor{library/dis opcode-UNARY_NEGATIVE}@anchor{4989}
@deffn {Opcode} UNARY_NEGATIVE

Implementa @code{STACK[-1] = -STACK[-1]}.
@end deffn

@geindex UNARY_NOT (opcode)
@anchor{library/dis opcode-UNARY_NOT}@anchor{17e3}
@deffn {Opcode} UNARY_NOT

Implementa @code{STACK[-1] = not STACK[-1]}.


Alterado na versão 3.13: Essa instrução agora requer que o operando seja exatamente do tipo @ref{468,,bool}.

@end deffn

@geindex UNARY_INVERT (opcode)
@anchor{library/dis opcode-UNARY_INVERT}@anchor{498a}
@deffn {Opcode} UNARY_INVERT

Implementa @code{STACK[-1] = ~STACK[-1]}.
@end deffn

@geindex GET_ITER (opcode)
@anchor{library/dis opcode-GET_ITER}@anchor{498b}
@deffn {Opcode} GET_ITER

Implementa @code{STACK[-1] = iter(STACK[-1])}.
@end deffn

@geindex GET_YIELD_FROM_ITER (opcode)
@anchor{library/dis opcode-GET_YIELD_FROM_ITER}@anchor{498c}
@deffn {Opcode} GET_YIELD_FROM_ITER

Se @code{STACK[-1]} for um @ref{bf9,,iterador gerador} ou um objeto @ref{491,,corrotina}, nada acontece.  Caso contrário, implementa @code{STACK[-1] = iter(STACK[-1])}.


Adicionado na versão 3.5.

@end deffn

@geindex TO_BOOL (opcode)
@anchor{library/dis opcode-TO_BOOL}@anchor{17e0}
@deffn {Opcode} TO_BOOL

Implementa @code{STACK[-1] = bool(STACK[-1])}.


Adicionado na versão 3.13.

@end deffn

`Operações binárias e internas'

Operações binárias removem os dois itens no topo da pilha (@code{STACK[-1]} e @code{STACK[-2]}). A operação é realizada, e o resultado é colocado de volta na pilha.

As operações internas são como as operações binárias, só que a operação é feita internamente caso suportado por @code{STACK[-2]}, e o @code{STACK[-1]} resultante pode ser (mas não necessariamente é) o @code{STACK[-2]} original.

@geindex BINARY_OP (opcode)
@anchor{library/dis opcode-BINARY_OP}@anchor{706}
@deffn {Opcode} BINARY_OP (op)

Implementa os operadores binários e locais (depende do valor de `op'):

@example
rhs = STACK.pop()
lhs = STACK.pop()
STACK.append(lhs op rhs)
@end example


Adicionado na versão 3.11.

@end deffn

@geindex BINARY_SUBSCR (opcode)
@anchor{library/dis opcode-BINARY_SUBSCR}@anchor{1835}
@deffn {Opcode} BINARY_SUBSCR

Implementa:

@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{1936}
@deffn {Opcode} STORE_SUBSCR

Implementa:

@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{498d}
@deffn {Opcode} DELETE_SUBSCR

Implementa:

@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{4df}
@deffn {Opcode} BINARY_SLICE

Implementa:

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
STACK.append(container[start:end])
@end example


Adicionado na versão 3.12.

@end deffn

@geindex STORE_SLICE (opcode)
@anchor{library/dis opcode-STORE_SLICE}@anchor{4e0}
@deffn {Opcode} STORE_SLICE

Implementa:

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[start:end] = value
@end example


Adicionado na versão 3.12.

@end deffn

`Opcodes para corrotinas'

@geindex GET_AWAITABLE (opcode)
@anchor{library/dis opcode-GET_AWAITABLE}@anchor{1951}
@deffn {Opcode} GET_AWAITABLE (where)

Implementa @code{STACK[-1] = get_awaitable(STACK[-1])}, onde @code{get_awaitable(o)} retorna @code{o} se @code{o} for um objeto de corrotina ou um gerador com o sinalizador @ref{4702,,CO_ITERABLE_COROUTINE}, ou então resolve @code{o.__await__}.

@quotation

Se o operando @code{where} não for zero, ele indica onde a instrução ocorre:


@itemize *

@item 
@code{1}: Após uma chamada a @code{__aenter__}

@item 
@code{2}: Após uma chamada a @code{__aexit__}
@end itemize
@end quotation


Adicionado na versão 3.5.



Alterado na versão 3.11: Anteriormente, esta instrução não tinha um oparg.

@end deffn

@geindex GET_AITER (opcode)
@anchor{library/dis opcode-GET_AITER}@anchor{498e}
@deffn {Opcode} GET_AITER

Implementa @code{STACK[-1] = STACK[-1].__aiter__()}.


Adicionado na versão 3.5.



Alterado na versão 3.7: Não é mais aceitado que o @code{__aiter__} retorne objetos aguardáveis.

@end deffn

@geindex GET_ANEXT (opcode)
@anchor{library/dis opcode-GET_ANEXT}@anchor{498f}
@deffn {Opcode} GET_ANEXT

Implementa @code{STACK.append(get_awaitable(STACK[-1].__anext__()))}. Veja @code{GET_AWAITABLE} para o significado de @code{get_awaitable}.


Adicionado na versão 3.5.

@end deffn

@geindex END_ASYNC_FOR (opcode)
@anchor{library/dis opcode-END_ASYNC_FOR}@anchor{ab9}
@deffn {Opcode} END_ASYNC_FOR

Termina um laço @ref{aba,,async for}.  Trata exceções levantadas ao aguardar um item seguinte. A pilha contém o iterável async em @code{STACK[-2]} e a exceção levantada em @code{STACK[-1]}. Ambos são retirados. Se a exceção não for @ref{1ba5,,StopAsyncIteration}, ela é re-levantada.


Adicionado na versão 3.8.



Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

@end deffn

@geindex CLEANUP_THROW (opcode)
@anchor{library/dis opcode-CLEANUP_THROW}@anchor{4e3}
@deffn {Opcode} CLEANUP_THROW

Trata uma exceção levantada durante um chamada a @ref{4f8,,throw()} ou @ref{15b9,,close()} através do quadro atual.  Se @code{STACK[-1]} for uma instância de @ref{c15,,StopIteration}, remove três valores da pilha e põe de volta o seu membro @code{value}.  Caso contrário, re-levanta @code{STACK[-1]}.


Adicionado na versão 3.12.

@end deffn

@geindex BEFORE_ASYNC_WITH (opcode)
@anchor{library/dis opcode-BEFORE_ASYNC_WITH}@anchor{4990}
@deffn {Opcode} BEFORE_ASYNC_WITH

Resolve os métodos especiais @code{__aenter__} e @code{__aexit__} de @code{STACK[-1]}. Põe na pilha @code{__aexit__} e o resultado de @code{__aenter__()}:

@example
STACK.extend((__aexit__, __aenter__())
@end example


Adicionado na versão 3.5.

@end deffn

`Opcodes genéricos'

@geindex SET_ADD (opcode)
@anchor{library/dis opcode-SET_ADD}@anchor{4991}
@deffn {Opcode} SET_ADD (i)

Implementa:

@example
item = STACK.pop()
set.add(STACK[-i], item)
@end example

Usado para implementar compreensões de conjuntos.
@end deffn

@geindex LIST_APPEND (opcode)
@anchor{library/dis opcode-LIST_APPEND}@anchor{4992}
@deffn {Opcode} LIST_APPEND (i)

Implementa:

@example
item = STACK.pop()
list.append(STACK[-i], item)
@end example

Usado para implementar compreensões de lista.
@end deffn

@geindex MAP_ADD (opcode)
@anchor{library/dis opcode-MAP_ADD}@anchor{abb}
@deffn {Opcode} MAP_ADD (i)

Implementa:

@example
value = STACK.pop()
key = STACK.pop()
dict.__setitem__(STACK[-i], key, value)
@end example

Usado para implementar compreensões de dicionário.


Adicionado na versão 3.1.



Alterado na versão 3.8: O valor do mapa é @code{STACK[-1]}, e a sua chave, @code{STACK[-2]}. Antes, eles estavam ao contrário.

@end deffn

Para as instruções @ref{4991,,SET_ADD}, @ref{4992,,LIST_APPEND} e @ref{abb,,MAP_ADD}, o valor ou par chave/valor é removido da pilha, mas o objeto de contêiner continua na pilha para que ele esteja disponível para as iterações seguintes do laço.

@geindex RETURN_VALUE (opcode)
@anchor{library/dis opcode-RETURN_VALUE}@anchor{18a8}
@deffn {Opcode} RETURN_VALUE

Retorna @code{STACK[-1]} para quem chamou a função.
@end deffn

@geindex RETURN_CONST (opcode)
@anchor{library/dis opcode-RETURN_CONST}@anchor{4e9}
@deffn {Opcode} RETURN_CONST (consti)

Retorna @code{co_consts[consti]} para quem chamou a função.


Adicionado na versão 3.12.

@end deffn

@geindex YIELD_VALUE (opcode)
@anchor{library/dis opcode-YIELD_VALUE}@anchor{314}
@deffn {Opcode} YIELD_VALUE

Gera @code{STACK.pop()} a partir de um @ref{109a,,gerador}.


Alterado na versão 3.11: oparg definido como sendo a profundidade da pilha.



Alterado na versão 3.12: oparg definido como sendo a profundidade do bloco exception, para o fechamento eficiente de geradores.



Alterado na versão 3.13: oparg é @code{1} caso esta instrução seja parte de um yield-from ou await, e @code{0} caso contrário.

@end deffn

@geindex SETUP_ANNOTATIONS (opcode)
@anchor{library/dis opcode-SETUP_ANNOTATIONS}@anchor{d78}
@deffn {Opcode} SETUP_ANNOTATIONS

Verifica se @code{__annotations__} está definido em @code{locals()} e, se não estiver, é inicializado como um @code{dict} vazio. Este opcode é emitido somente se o corpo de uma classe ou módulo contém @ref{d79,,anotações de variáveis} estaticamente.


Adicionado na versão 3.6.

@end deffn

@geindex POP_EXCEPT (opcode)
@anchor{library/dis opcode-POP_EXCEPT}@anchor{4993}
@deffn {Opcode} POP_EXCEPT

Remove o valor no topo da pilha, o qual é usado para restaurar o estado de exceção.


Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

@end deffn

@geindex RERAISE (opcode)
@anchor{library/dis opcode-RERAISE}@anchor{4994}
@deffn {Opcode} RERAISE

Re-levanta a exceção que se encontra no topo da pilha. Se o oparg não for zero, remove um valor adicional do topo da pilha, o qual é atribuído ao @ref{88c,,f_lasti} do quadro atual.


Adicionado na versão 3.9.



Alterado na versão 3.11: A representação da exceção na pilha consiste agora de um item, ao invés de três.

@end deffn

@geindex PUSH_EXC_INFO (opcode)
@anchor{library/dis opcode-PUSH_EXC_INFO}@anchor{703}
@deffn {Opcode} PUSH_EXC_INFO

Remove um valor do topo da pilha. Põe a exceção atual no topo da pilha. Põe de volta no topo da pilha o valor que foi removido inicialmente. Usado em tratadores de exceções.


Adicionado na versão 3.11.

@end deffn

@geindex CHECK_EXC_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EXC_MATCH}@anchor{70b}
@deffn {Opcode} CHECK_EXC_MATCH

Verifica correspondências de exceções em @code{except}. Testa de @code{STACK[-2]} é uma exceção que corresponde a @code{STACK[-1]}. Remove @code{STACK[-1]} do topo da pilha, e põe no seu lugar o resultado booleano do teste.


Adicionado na versão 3.11.

@end deffn

@geindex CHECK_EG_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EG_MATCH}@anchor{702}
@deffn {Opcode} CHECK_EG_MATCH

Verifica correspondências de exceções em @code{except*}. Aplica @code{split(STACK[-1])} no grupo de exceções que representa @code{STACK[-2]}.

No caso de uma correspondência, remove dois itens do topo da pilha e põe nela o subgrupo que falhou a correspondência (@code{None} caso a correspondência tenha sido total), seguido pelo subgrupo que correspondeu. Quando não há correspondência nenhuma, remove um item (o tipo da correspondência) e põe @code{None} no seu lugar.


Adicionado na versão 3.11.

@end deffn

@geindex WITH_EXCEPT_START (opcode)
@anchor{library/dis opcode-WITH_EXCEPT_START}@anchor{4995}
@deffn {Opcode} WITH_EXCEPT_START

Chama a função na posição 4 da pilha com argumentos (tipo, val, tb) representando a exceção no topo da pilha. Usado para implementar a chamada @code{context_manager.__exit__(*exc_info())} quando uma exceção ocorreu em uma instrução @ref{5d2,,with}.


Adicionado na versão 3.9.



Alterado na versão 3.11: A função @code{__exit__} fica agora na posição 4 pilha, ao invés da 7. A representação da exceção pilha consiste agora de um item, não três.

@end deffn

@geindex LOAD_ASSERTION_ERROR (opcode)
@anchor{library/dis opcode-LOAD_ASSERTION_ERROR}@anchor{96e}
@deffn {Opcode} LOAD_ASSERTION_ERROR

Põe @ref{6a9,,AssertionError} no topo da pilha.  Usado pela instrução @ref{96f,,assert}.


Adicionado na versão 3.9.

@end deffn

@geindex LOAD_BUILD_CLASS (opcode)
@anchor{library/dis opcode-LOAD_BUILD_CLASS}@anchor{4996}
@deffn {Opcode} LOAD_BUILD_CLASS

Põe a função @code{builtins.__build_class__()} no topo da pilha.  Ela será chamada posteriormente para construir uma classe.
@end deffn

@geindex BEFORE_WITH (opcode)
@anchor{library/dis opcode-BEFORE_WITH}@anchor{70d}
@deffn {Opcode} BEFORE_WITH

Este opcode realiza várias operações antes do início de um bloco “with”.  Primeiro, ele carrega o @ref{1344,,__exit__()} do gerenciador de contexto e o coloca no topo da pilha para ser usado posteriormente pela @ref{4995,,WITH_EXCEPT_START}.  Então, o método @ref{5c8,,__enter__()} é chamado. Por fim, o resultado do @code{__enter__()} é posto no topo da pilha.


Adicionado na versão 3.11.

@end deffn

@geindex GET_LEN (opcode)
@anchor{library/dis opcode-GET_LEN}@anchor{4997}
@deffn {Opcode} GET_LEN

Executa @code{STACK.append(len(STACK[-1]))}. Usado em instruções @ref{810,,match} onde a comparação com a estrutura do padrão é necessária.


Adicionado na versão 3.10.

@end deffn

@geindex MATCH_MAPPING (opcode)
@anchor{library/dis opcode-MATCH_MAPPING}@anchor{4998}
@deffn {Opcode} MATCH_MAPPING

Se @code{STACK[-1]} for uma instância de @ref{8d0,,collections.abc.Mapping} (ou, de forma mais técnica: se tiver o sinalizador @ref{19e3,,Py_TPFLAGS_MAPPING} definido no seu @ref{19fd,,tp_flags}), põe @code{True} no topo da pilha. Caso contrário, põe @code{False}.


Adicionado na versão 3.10.

@end deffn

@geindex MATCH_SEQUENCE (opcode)
@anchor{library/dis opcode-MATCH_SEQUENCE}@anchor{4999}
@deffn {Opcode} MATCH_SEQUENCE

Se @code{STACK[-1]} for uma instância de @ref{1204,,collections.abc.Sequence} e `não' for uma instância de @ref{44c,,str}/@ref{1c2,,bytes}/@ref{2ea,,bytearray} (ou, de forma mais técnica: se tiver o sinalizador @ref{19e4,,Py_TPFLAGS_SEQUENCE} definido no seu @ref{19fd,,tp_flags}), põe @code{True} no topo da pilha. Caso contrário, põe @code{False}.


Adicionado na versão 3.10.

@end deffn

@geindex MATCH_KEYS (opcode)
@anchor{library/dis opcode-MATCH_KEYS}@anchor{713}
@deffn {Opcode} MATCH_KEYS

@code{STACK[-1]} é uma tupla de chaves de um mapeamento, e @code{STACK[-2]} é o sujeito de uma correspondência. Se @code{STACK[-2]} contiver todas as chaves em @code{STACK[-1]}, põe no topo da pilha um @ref{370,,tuple} contendo os valores correspondentes. Caso contrário, põe @code{None}.


Adicionado na versão 3.10.



Alterado na versão 3.11: Anteriormente, essa instrução também colocava na pilha um valor booleano indicando sucesso (@code{True}) ou falha (@code{False}).

@end deffn

@geindex STORE_NAME (opcode)
@anchor{library/dis opcode-STORE_NAME}@anchor{499a}
@deffn {Opcode} STORE_NAME (namei)

Implementa @code{name = STACK.pop()}. `namei' é o índice de `name' no atributo @ref{20d3,,co_names} do @ref{1d2,,objeto de código}. O compilador tenta usar @ref{17e5,,STORE_FAST} ou @ref{499b,,STORE_GLOBAL} se possível.
@end deffn

@geindex DELETE_NAME (opcode)
@anchor{library/dis opcode-DELETE_NAME}@anchor{499c}
@deffn {Opcode} DELETE_NAME (namei)

Implementa @code{del name}, onde `namei' é o índice no atributo @ref{20d3,,co_names} do @ref{1d2,,objeto de código}.
@end deffn

@geindex UNPACK_SEQUENCE (opcode)
@anchor{library/dis opcode-UNPACK_SEQUENCE}@anchor{1953}
@deffn {Opcode} UNPACK_SEQUENCE (count)

Desempacota @code{STACK[-1]} em `count' valores individuais, os quais são postos na pilha da direita para a esquerda. Requer que haja exatamente `count' valores:

@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{499d}
@deffn {Opcode} UNPACK_EX (counts)

Implementa atribuição com um alvo estrelado: desempacota o iterável @code{STACK[-1]} em valores individuais, sendo que pode haver menos valores do que itens no iterável: um dos novos valores será a lista de todos os itens que sobraram.

A quantidade de valores antes e após o valor que será a lista é limitada a 255.

A quantidade de valores antes do valor lista é passada no argumento do opcode. A quantidade de valores após a lista, se houver, é passada usando um @code{EXTENDED_ARG}. A consequência é que o argumento pode ser visto como um valor de dois bytes, onde o byte “de baixo” de `counts' é a quantidade de valores antes do valor lista, e o byte “de cima” de `counts', a quantidade após.

Os valores extraídos são postos na pilha da direita para a esquerda, ou seja, após executar @code{a, *b, c = d} os valores serão armazenados como @code{STACK.extend((a, b, c))}.
@end deffn

@geindex STORE_ATTR (opcode)
@anchor{library/dis opcode-STORE_ATTR}@anchor{1952}
@deffn {Opcode} STORE_ATTR (namei)

Implementa:

@example
obj = STACK.pop()
value = STACK.pop()
obj.name = value
@end example

onde `namei' é o índice do nome no @ref{20d3,,co_names} do @ref{1d2,,objeto de código}.
@end deffn

@geindex DELETE_ATTR (opcode)
@anchor{library/dis opcode-DELETE_ATTR}@anchor{499e}
@deffn {Opcode} DELETE_ATTR (namei)

Implementa:

@example
obj = STACK.pop()
del obj.name
@end example

onde `namei' é o índice do nome no @ref{20d3,,co_names} do @ref{1d2,,objeto de código}.
@end deffn

@geindex STORE_GLOBAL (opcode)
@anchor{library/dis opcode-STORE_GLOBAL}@anchor{499b}
@deffn {Opcode} STORE_GLOBAL (namei)

Funciona como o @ref{499a,,STORE_NAME}, mas o nome é armazenado com um nome global.
@end deffn

@geindex DELETE_GLOBAL (opcode)
@anchor{library/dis opcode-DELETE_GLOBAL}@anchor{499f}
@deffn {Opcode} DELETE_GLOBAL (namei)

Funciona como o @ref{499c,,DELETE_NAME}, mas deleta um nome global.
@end deffn

@geindex LOAD_CONST (opcode)
@anchor{library/dis opcode-LOAD_CONST}@anchor{49a0}
@deffn {Opcode} LOAD_CONST (consti)

Põe @code{co_consts[consti]} no topo da pilha.
@end deffn

@geindex LOAD_NAME (opcode)
@anchor{library/dis opcode-LOAD_NAME}@anchor{49a1}
@deffn {Opcode} LOAD_NAME (namei)

Põe no topo da pilha o valor associado a @code{co_names[namei]}. O nome é procurado nos locais, nos globais, e então nos embutidos.
@end deffn

@geindex LOAD_LOCALS (opcode)
@anchor{library/dis opcode-LOAD_LOCALS}@anchor{4e8}
@deffn {Opcode} LOAD_LOCALS

Envia uma referência ao dicionário local para a pilha. Isso é usado para preparar dicionários de espaço de nomes para @ref{4e6,,LOAD_FROM_DICT_OR_DEREF} e @ref{4e7,,LOAD_FROM_DICT_OR_GLOBALS}.


Adicionado na versão 3.12.

@end deffn

@geindex LOAD_FROM_DICT_OR_GLOBALS (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_GLOBALS}@anchor{4e7}
@deffn {Opcode} LOAD_FROM_DICT_OR_GLOBALS (i)

Extrai um mapeamento da pilha e procura o valor de @code{co_names[namei]}. Se o nome não for encontrado, procura-o nas variáveis globais e, em seguida, nas variáveis embutidas, semelhante a @ref{17dc,,LOAD_GLOBAL}. Isso é usado para carregar variáveis globais em @ref{188,,escopos de anotação} dentro dos corpos de classe.


Adicionado na versão 3.12.

@end deffn

@geindex BUILD_TUPLE (opcode)
@anchor{library/dis opcode-BUILD_TUPLE}@anchor{49a2}
@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{49a3}
@deffn {Opcode} BUILD_LIST (count)

Works as @ref{49a2,,BUILD_TUPLE}, but creates a list.
@end deffn

@geindex BUILD_SET (opcode)
@anchor{library/dis opcode-BUILD_SET}@anchor{49a4}
@deffn {Opcode} BUILD_SET (count)

Works as @ref{49a2,,BUILD_TUPLE}, but creates a set.
@end deffn

@geindex BUILD_MAP (opcode)
@anchor{library/dis opcode-BUILD_MAP}@anchor{17d5}
@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]@}}.


Alterado na versão 3.5: The dictionary is created from stack items instead of creating an
empty dictionary pre-sized to hold `count' items.

@end deffn

@geindex BUILD_CONST_KEY_MAP (opcode)
@anchor{library/dis opcode-BUILD_CONST_KEY_MAP}@anchor{d75}
@deffn {Opcode} BUILD_CONST_KEY_MAP (count)

The version of @ref{17d5,,BUILD_MAP} specialized for constant keys. Pops the
top element on the stack which contains a tuple of keys, then starting from
@code{STACK[-2]}, pops `count' values to form values in the built dictionary.


Adicionado na versão 3.6.

@end deffn

@geindex BUILD_STRING (opcode)
@anchor{library/dis opcode-BUILD_STRING}@anchor{d74}
@deffn {Opcode} BUILD_STRING (count)

Concatenates `count' strings from the stack and pushes the resulting string
onto the stack.


Adicionado na versão 3.6.

@end deffn

@geindex LIST_EXTEND (opcode)
@anchor{library/dis opcode-LIST_EXTEND}@anchor{49a5}
@deffn {Opcode} LIST_EXTEND (i)

Implementa:

@example
seq = STACK.pop()
list.extend(STACK[-i], seq)
@end example

Used to build lists.


Adicionado na versão 3.9.

@end deffn

@geindex SET_UPDATE (opcode)
@anchor{library/dis opcode-SET_UPDATE}@anchor{49a6}
@deffn {Opcode} SET_UPDATE (i)

Implementa:

@example
seq = STACK.pop()
set.update(STACK[-i], seq)
@end example

Used to build sets.


Adicionado na versão 3.9.

@end deffn

@geindex DICT_UPDATE (opcode)
@anchor{library/dis opcode-DICT_UPDATE}@anchor{49a7}
@deffn {Opcode} DICT_UPDATE (i)

Implementa:

@example
map = STACK.pop()
dict.update(STACK[-i], map)
@end example

Used to build dicts.


Adicionado na versão 3.9.

@end deffn

@geindex DICT_MERGE (opcode)
@anchor{library/dis opcode-DICT_MERGE}@anchor{49a8}
@deffn {Opcode} DICT_MERGE (i)

Like @ref{49a7,,DICT_UPDATE} but raises an exception for duplicate keys.


Adicionado na versão 3.9.

@end deffn

@geindex LOAD_ATTR (opcode)
@anchor{library/dis opcode-LOAD_ATTR}@anchor{4de}
@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{707,,CALL}
or @ref{17d6,,CALL_KW} when calling the unbound method.
Otherwise, @code{NULL} and the object returned by
the attribute lookup are pushed.


Alterado na versão 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{4dc}
@deffn {Opcode} LOAD_SUPER_ATTR (namei)

This opcode implements @ref{4db,,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{4de,,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{4de,,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{4db,,super()} (unset means zero-argument).


Adicionado na versão 3.12.

@end deffn

@geindex COMPARE_OP (opcode)
@anchor{library/dis opcode-COMPARE_OP}@anchor{970}
@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}.


Alterado na versão 3.13: The fifth-lowest bit of the oparg now indicates a forced conversion to
@ref{468,,bool}.

@end deffn

@geindex IS_OP (opcode)
@anchor{library/dis opcode-IS_OP}@anchor{49a9}
@deffn {Opcode} IS_OP (invert)

Performs @code{is} comparison, or @code{is not} if @code{invert} is 1.


Adicionado na versão 3.9.

@end deffn

@geindex CONTAINS_OP (opcode)
@anchor{library/dis opcode-CONTAINS_OP}@anchor{49aa}
@deffn {Opcode} CONTAINS_OP (invert)

Performs @code{in} comparison, or @code{not in} if @code{invert} is 1.


Adicionado na versão 3.9.

@end deffn

@geindex IMPORT_NAME (opcode)
@anchor{library/dis opcode-IMPORT_NAME}@anchor{49ab}
@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{8da,,__import__()}.
The module object is pushed onto the stack.  The current namespace is not affected: for a proper import statement, a subsequent @ref{17e5,,STORE_FAST} instruction
modifies the namespace.
@end deffn

@geindex IMPORT_FROM (opcode)
@anchor{library/dis opcode-IMPORT_FROM}@anchor{49ac}
@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{17e5,,STORE_FAST} instruction.
@end deffn

@geindex JUMP_FORWARD (opcode)
@anchor{library/dis opcode-JUMP_FORWARD}@anchor{16cb}
@deffn {Opcode} JUMP_FORWARD (delta)

Increments bytecode counter by `delta'.
@end deffn

@geindex JUMP_BACKWARD (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD}@anchor{70c}
@deffn {Opcode} JUMP_BACKWARD (delta)

Decrements bytecode counter by `delta'. Checks for interrupts.


Adicionado na versão 3.11.

@end deffn

@geindex JUMP_BACKWARD_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD_NO_INTERRUPT}@anchor{6ff}
@deffn {Opcode} JUMP_BACKWARD_NO_INTERRUPT (delta)

Decrements bytecode counter by `delta'. Does not check for interrupts.


Adicionado na versão 3.11.

@end deffn

@geindex POP_JUMP_IF_TRUE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_TRUE}@anchor{17e1}
@deffn {Opcode} POP_JUMP_IF_TRUE (delta)

If @code{STACK[-1]} is true, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.


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



Alterado na versão 3.12: This is no longer a pseudo-instruction.



Alterado na versão 3.13: Essa instrução agora requer que o operando seja exatamente do tipo @ref{468,,bool}.

@end deffn

@geindex POP_JUMP_IF_FALSE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_FALSE}@anchor{17e2}
@deffn {Opcode} POP_JUMP_IF_FALSE (delta)

If @code{STACK[-1]} is false, increments the bytecode counter by `delta'.
@code{STACK[-1]} is popped.


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



Alterado na versão 3.12: This is no longer a pseudo-instruction.



Alterado na versão 3.13: Essa instrução agora requer que o operando seja exatamente do tipo @ref{468,,bool}.

@end deffn

@geindex POP_JUMP_IF_NOT_NONE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_NOT_NONE}@anchor{190b}
@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.


Adicionado na versão 3.11.



Alterado na versão 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{190a}
@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.


Adicionado na versão 3.11.



Alterado na versão 3.12: This is no longer a pseudo-instruction.

@end deffn

@geindex FOR_ITER (opcode)
@anchor{library/dis opcode-FOR_ITER}@anchor{184a}
@deffn {Opcode} FOR_ITER (delta)

@code{STACK[-1]} is an @ref{1ac,,iterator}.  Call its @ref{1310,,__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'.


Alterado na versão 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{17dc}
@deffn {Opcode} LOAD_GLOBAL (namei)

Loads the global named @code{co_names[namei>>1]} onto the stack.


Alterado na versão 3.11: If the low bit of @code{namei} is set, then a @code{NULL} is pushed to the
stack before the global variable.

@end deffn

@geindex LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST}@anchor{49ad}
@deffn {Opcode} LOAD_FAST (var_num)

Pushes a reference to the local @code{co_varnames[var_num]} onto the stack.


Alterado na versão 3.12: This opcode is now only used in situations where the local variable is
guaranteed to be initialized. It cannot raise @ref{157f,,UnboundLocalError}.

@end deffn

@geindex LOAD_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST_LOAD_FAST}@anchor{49ae}
@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.


Adicionado na versão 3.13.

@end deffn

@geindex LOAD_FAST_CHECK (opcode)
@anchor{library/dis opcode-LOAD_FAST_CHECK}@anchor{4e5}
@deffn {Opcode} LOAD_FAST_CHECK (var_num)

Pushes a reference to the local @code{co_varnames[var_num]} onto the stack,
raising an @ref{157f,,UnboundLocalError} if the local variable has not been
initialized.


Adicionado na versão 3.12.

@end deffn

@geindex LOAD_FAST_AND_CLEAR (opcode)
@anchor{library/dis opcode-LOAD_FAST_AND_CLEAR}@anchor{4e4}
@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}.


Adicionado na versão 3.12.

@end deffn

@geindex STORE_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST}@anchor{17e5}
@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{49af}
@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]}.


Adicionado na versão 3.13.

@end deffn

@geindex STORE_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST_LOAD_FAST}@anchor{49b0}
@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.


Adicionado na versão 3.13.

@end deffn

@geindex DELETE_FAST (opcode)
@anchor{library/dis opcode-DELETE_FAST}@anchor{49b1}
@deffn {Opcode} DELETE_FAST (var_num)

Deletes local @code{co_varnames[var_num]}.
@end deffn

@geindex MAKE_CELL (opcode)
@anchor{library/dis opcode-MAKE_CELL}@anchor{700}
@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.


Adicionado na versão 3.11.

@end deffn

@geindex LOAD_DEREF (opcode)
@anchor{library/dis opcode-LOAD_DEREF}@anchor{49b2}
@deffn {Opcode} LOAD_DEREF (i)

Loads the cell contained in slot @code{i} of the “fast locals” storage.
Pushes a reference to the object the cell contains on the stack.


Alterado na versão 3.11: @code{i} is no longer offset by the length of @ref{20ce,,co_varnames}.

@end deffn

@geindex LOAD_FROM_DICT_OR_DEREF (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_DEREF}@anchor{4e6}
@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{49b2,,LOAD_DEREF}. This is used for loading
@ref{20d1,,closure variables} in class bodies (which previously used
@code{LOAD_CLASSDEREF}) and in
@ref{188,,annotation scopes} within class bodies.


Adicionado na versão 3.12.

@end deffn

@geindex STORE_DEREF (opcode)
@anchor{library/dis opcode-STORE_DEREF}@anchor{49b3}
@deffn {Opcode} STORE_DEREF (i)

Stores @code{STACK.pop()} into the cell contained in slot @code{i} of the “fast locals”
storage.


Alterado na versão 3.11: @code{i} is no longer offset by the length of @ref{20ce,,co_varnames}.

@end deffn

@geindex DELETE_DEREF (opcode)
@anchor{library/dis opcode-DELETE_DEREF}@anchor{49b4}
@deffn {Opcode} DELETE_DEREF (i)

Empties the cell contained in slot @code{i} of the “fast locals” storage.
Used by the @ref{18a7,,del} statement.


Adicionado na versão 3.2.



Alterado na versão 3.11: @code{i} is no longer offset by the length of @ref{20ce,,co_varnames}.

@end deffn

@geindex COPY_FREE_VARS (opcode)
@anchor{library/dis opcode-COPY_FREE_VARS}@anchor{6fe}
@deffn {Opcode} COPY_FREE_VARS (n)

Copia as @code{n} @ref{20d1,,variáveis livres (de clausura)} do fechamento para o quadro. Remove a necessidade de código especial do lado do chamador ao chamar closures.


Adicionado na versão 3.11.

@end deffn

@geindex RAISE_VARARGS (opcode)
@anchor{library/dis opcode-RAISE_VARARGS}@anchor{49b5}
@deffn {Opcode} RAISE_VARARGS (argc)

Raises an exception using one of the 3 forms of the @code{raise} statement,
depending on the value of `argc':


@itemize *

@item 
0: @code{raise} (re-raise previous exception)

@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{707}
@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 
The callable

@item 
@code{self} or @code{NULL}

@item 
The remaining positional arguments
@end itemize

@code{argc} is the total of the positional arguments, excluding @code{self}.

@code{CALL} pops all arguments and the callable object off the stack,
calls the callable object with those arguments, and pushes the return value
returned by the callable object.


Adicionado na versão 3.11.



Alterado na versão 3.13: The callable now always appears at the same position on the stack.



Alterado na versão 3.13: Calls with keyword arguments are now handled by @ref{17d6,,CALL_KW}.

@end deffn

@geindex CALL_KW (opcode)
@anchor{library/dis opcode-CALL_KW}@anchor{17d6}
@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 
The callable

@item 
@code{self} or @code{NULL}

@item 
The remaining positional arguments

@item 
The named arguments

@item 
A @ref{370,,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.


Adicionado na versão 3.13.

@end deffn

@geindex CALL_FUNCTION_EX (opcode)
@anchor{library/dis opcode-CALL_FUNCTION_EX}@anchor{d77}
@deffn {Opcode} CALL_FUNCTION_EX (flags)

Calls a callable object with variable set of positional and keyword
arguments.  If the lowest bit of `flags' is set, the top of the stack
contains a mapping object containing additional keyword arguments.
Before the callable is called, the mapping object and iterable object
are each “unpacked” and their contents passed in as keyword and
positional arguments respectively.
@code{CALL_FUNCTION_EX} pops all arguments and the callable object off the stack,
calls the callable object with those arguments, and pushes the return value
returned by the callable object.


Adicionado na versão 3.6.

@end deffn

@geindex PUSH_NULL (opcode)
@anchor{library/dis opcode-PUSH_NULL}@anchor{708}
@deffn {Opcode} PUSH_NULL

Pushes a @code{NULL} to the stack.
Used in the call sequence to match the @code{NULL} pushed by
@ref{c39,,LOAD_METHOD} for non-method calls.


Adicionado na versão 3.11.

@end deffn

@geindex MAKE_FUNCTION (opcode)
@anchor{library/dis opcode-MAKE_FUNCTION}@anchor{d76}
@deffn {Opcode} MAKE_FUNCTION

Pushes a new function object on the stack built from the code object at @code{STACK[-1]}.


Alterado na versão 3.10: Flag value @code{0x04} is a tuple of strings instead of dictionary



Alterado na versão 3.11: Qualified name at @code{STACK[-1]} was removed.



Alterado na versão 3.13: Extra function attributes on the stack, signaled by oparg flags, were
removed. They now use @ref{49b6,,SET_FUNCTION_ATTRIBUTE}.

@end deffn

@geindex SET_FUNCTION_ATTRIBUTE (opcode)
@anchor{library/dis opcode-SET_FUNCTION_ATTRIBUTE}@anchor{49b6}
@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} a tuple of default values for positional-only and
positional-or-keyword parameters in positional order

@item 
@code{0x02} a dictionary of keyword-only parameters’ default values

@item 
@code{0x04} a tuple of strings containing parameters’ annotations

@item 
@code{0x08} a tuple containing cells for free variables, making a closure
@end itemize


Adicionado na versão 3.13.

@end deffn

@geindex BUILD_SLICE (opcode)
@anchor{library/dis opcode-BUILD_SLICE}@anchor{49b7}
@deffn {Opcode} BUILD_SLICE (argc)

@geindex função embutida;fatia

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{469,,slice()} built-in function for more information.
@end deffn

@geindex EXTENDED_ARG (opcode)
@anchor{library/dis opcode-EXTENDED_ARG}@anchor{18a6}
@deffn {Opcode} EXTENDED_ARG (ext)

Prefixes any opcode which has an argument too big to fit into the default one
byte. `ext' holds an additional byte which act as higher bits in the argument.
For each opcode, at most three prefixal @code{EXTENDED_ARG} are allowed, forming
an argument from two-byte to four-byte.
@end deffn

@geindex CONVERT_VALUE (opcode)
@anchor{library/dis opcode-CONVERT_VALUE}@anchor{49b8}
@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{44c,,str()} on `value'

@item 
@code{oparg == 2}: call @ref{800,,repr()} on `value'

@item 
@code{oparg == 3}: call @ref{142d,,ascii()} on `value'
@end itemize

Used for implementing formatted string literals (f-strings).


Adicionado na versão 3.13.

@end deffn

@geindex FORMAT_SIMPLE (opcode)
@anchor{library/dis opcode-FORMAT_SIMPLE}@anchor{49b9}
@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 string literals (f-strings).


Adicionado na versão 3.13.

@end deffn

@geindex FORMAT_WITH_SPEC (opcode)
@anchor{library/dis opcode-FORMAT_WITH_SPEC}@anchor{49ba}
@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 string literals (f-strings).


Adicionado na versão 3.13.

@end deffn

@geindex MATCH_CLASS (opcode)
@anchor{library/dis opcode-MATCH_CLASS}@anchor{712}
@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}.


Adicionado na versão 3.10.



Alterado na versão 3.11: Anteriormente, essa instrução também colocava na pilha um valor booleano indicando sucesso (@code{True}) ou falha (@code{False}).

@end deffn

@geindex RESUME (opcode)
@anchor{library/dis opcode-RESUME}@anchor{315}
@deffn {Opcode} RESUME (context)

A no-op. Performs internal tracing, debugging and optimization checks.

The @code{context} oparand 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} Depois de uma expressão @code{yield}

@item 
@code{2} After a @code{yield from} expression

@item 
@code{3} Depois de uma expressão @code{await}
@end itemize

The next bit is @code{1} if the RESUME is at except-depth @code{1}, and @code{0}
otherwise.


Adicionado na versão 3.11.



Alterado na versão 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{6fc}
@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.


Adicionado na versão 3.11.

@end deffn

@geindex SEND (opcode)
@anchor{library/dis opcode-SEND}@anchor{6fd}
@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{c15,,StopIteration}, pop the top value from the stack,
push the exception’s @code{value} attribute, and increment the bytecode counter
by `delta'.


Adicionado na versão 3.11.

@end deffn

@geindex HAVE_ARGUMENT (opcode)
@anchor{library/dis opcode-HAVE_ARGUMENT}@anchor{489}
@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{29e,,hasarg} collection instead.


Alterado na versão 3.6: Now every instruction has an argument, but opcodes @code{< HAVE_ARGUMENT}
ignore it. Before, only opcodes @code{>= HAVE_ARGUMENT} had an argument.



Alterado na versão 3.12: Pseudo instructions were added to the @ref{38,,dis} module, and for them
it is not true that comparison with @code{HAVE_ARGUMENT} indicates whether
they use their arg.



Descontinuado desde a versão 3.13: Use @ref{29e,,hasarg} instead.

@end deffn

@geindex CALL_INTRINSIC_1 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_1}@anchor{4e1}
@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

Descrição

@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

Cria um @ref{15d,,typing.TypeVar}

@item

@code{INTRINSIC_PARAMSPEC}

@tab

Cria um @ref{15e,,typing.ParamSpec}

@item

@code{INTRINSIC_TYPEVARTUPLE}

@tab

Cria um @ref{15f,,typing.TypeVarTuple}

@item

@code{INTRINSIC_SUBSCRIPT_GENERIC}

@tab

Returns @ref{15d7,,typing.Generic}
subscripted with the argument

@item

@code{INTRINSIC_TYPEALIAS}

@tab

Creates a
@ref{455,,typing.TypeAliasType};
used in the @ref{438,,type}
statement. The argument is a tuple
of the type alias’s name,
type parameters, and value.

@end multitable



Adicionado na versão 3.12.

@end deffn

@geindex CALL_INTRINSIC_2 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_2}@anchor{4e2}
@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

Descrição

@item

@code{INTRINSIC_2_INVALID}

@tab

Not valid

@item

@code{INTRINSIC_PREP_RERAISE_STAR}

@tab

Calculates the
@ref{1b6,,ExceptionGroup} to raise
from a @code{try-except*}.

@item

@code{INTRINSIC_TYPEVAR_WITH_BOUND}

@tab

Creates a @ref{15d,,typing.TypeVar}
with a bound.

@item

@code{INTRINSIC_TYPEVAR_WITH_CONSTRAINTS}

@tab

Creates a
@ref{15d,,typing.TypeVar} with
constraints.

@item

@code{INTRINSIC_SET_FUNCTION_TYPE_PARAMS}

@tab

Sets the @code{__type_params__}
attribute of a function.

@end multitable



Adicionado na versão 3.12.

@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{49bb}
@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{49bc}
@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{49bd}
@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{5d2,,with} and @ref{5d5,,async with}
constructs, which push the return value of the context manager’s
@ref{5c8,,__enter__()} or @ref{215e,,__aenter__()} to the stack.
@end deffn

@geindex POP_BLOCK (opcode)
@anchor{library/dis opcode-POP_BLOCK}@anchor{49be}
@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{49bf}
@deffn {Opcode} JUMP
@end deffn

@geindex JUMP_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP_NO_INTERRUPT}@anchor{1930}
@deffn {Opcode} JUMP_NO_INTERRUPT

Undirected relative jump instructions which are replaced by their
directed (forward/backward) counterparts by the assembler.
@end deffn

@geindex LOAD_CLOSURE (opcode)
@anchor{library/dis opcode-LOAD_CLOSURE}@anchor{17df}
@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.


Alterado na versão 3.13: This opcode is now a pseudo-instruction.

@end deffn

@geindex LOAD_METHOD (opcode)
@anchor{library/dis opcode-LOAD_METHOD}@anchor{c39}
@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 Opcode collections,,Instruções em bytecode do Python,dis — Disassembler de bytecode do Python
@anchor{library/dis id1}@anchor{49c0}@anchor{library/dis opcode-collections}@anchor{496e}
@subsubsection Opcode collections


These collections are provided for automatic introspection of bytecode
instructions:


Alterado na versão 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 (no módulo dis)
@anchor{library/dis dis opname}@anchor{4972}
@deffn {Dado} dis.opname

Sequence of operation names, indexable using the bytecode.
@end deffn

@geindex opmap (no módulo dis)
@anchor{library/dis dis opmap}@anchor{49c1}
@deffn {Dado} dis.opmap

Dictionary mapping operation names to bytecodes.
@end deffn

@geindex cmp_op (no módulo dis)
@anchor{library/dis dis cmp_op}@anchor{49c2}
@deffn {Dado} dis.cmp_op

Sequence of all compare operation names.
@end deffn

@geindex hasarg (no módulo dis)
@anchor{library/dis dis hasarg}@anchor{29e}
@deffn {Dado} dis.hasarg

Sequence of bytecodes that use their argument.


Adicionado na versão 3.12.

@end deffn

@geindex hasconst (no módulo dis)
@anchor{library/dis dis hasconst}@anchor{49c3}
@deffn {Dado} dis.hasconst

Sequence of bytecodes that access a constant.
@end deffn

@geindex hasfree (no módulo dis)
@anchor{library/dis dis hasfree}@anchor{49c4}
@deffn {Dado} dis.hasfree

Sequence of bytecodes that access a @ref{20d1,,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 (no módulo dis)
@anchor{library/dis dis hasname}@anchor{49c5}
@deffn {Dado} dis.hasname

Sequence of bytecodes that access an attribute by name.
@end deffn

@geindex hasjump (no módulo dis)
@anchor{library/dis dis hasjump}@anchor{49c6}
@deffn {Dado} dis.hasjump

Sequence of bytecodes that have a jump target. All jumps
are relative.


Adicionado na versão 3.13.

@end deffn

@geindex haslocal (no módulo dis)
@anchor{library/dis dis haslocal}@anchor{49c7}
@deffn {Dado} dis.haslocal

Sequence of bytecodes that access a local variable.
@end deffn

@geindex hascompare (no módulo dis)
@anchor{library/dis dis hascompare}@anchor{49c8}
@deffn {Dado} dis.hascompare

Sequence of bytecodes of Boolean operations.
@end deffn

@geindex hasexc (no módulo dis)
@anchor{library/dis dis hasexc}@anchor{48a}
@deffn {Dado} dis.hasexc

Sequence of bytecodes that set an exception handler.


Adicionado na versão 3.12.

@end deffn

@geindex hasjrel (no módulo dis)
@anchor{library/dis dis hasjrel}@anchor{49c9}
@deffn {Dado} dis.hasjrel

Sequence of bytecodes that have a relative jump target.


Descontinuado desde a versão 3.13: All jumps are now relative. Use @ref{49c6,,hasjump}.

@end deffn

@geindex hasjabs (no módulo dis)
@anchor{library/dis dis hasjabs}@anchor{49ca}
@deffn {Dado} dis.hasjabs

Sequence of bytecodes that have an absolute jump target.


Descontinuado desde a versão 3.13: All jumps are now relative. This list is empty.

@end deffn

@node pickletools — Ferramentas para desenvolvedores pickle,,dis — Disassembler de bytecode do Python,Serviços da Linguagem Python
@anchor{library/pickletools doc}@anchor{49cb}@anchor{library/pickletools module-pickletools}@anchor{a7}@anchor{library/pickletools pickletools-tools-for-pickle-developers}@anchor{49cc}@anchor{library/pickletools translation-repo}@anchor{49cd}
@subsection @code{pickletools} — Ferramentas para desenvolvedores pickle


@geindex module; pickletools

`Código-fonte:' Lib/pickletools.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pickletools.py}


__________________________________________________________________


Este módulo contém várias constantes relacionadas aos detalhes íntimos do módulo @ref{a6,,pickle}, alguns comentários extensos sobre a implementação e algumas funções úteis para analisar dados em conserva. O conteúdo deste módulo é útil para desenvolvedores do núcleo Python que estão trabalhando no @ref{a6,,pickle}; usuários comuns do módulo @ref{a6,,pickle} provavelmente não acharão o módulo @ref{a7,,pickletools} relevante.

@menu
* Uso na linha de comando: Uso na linha de comando<13>. 
* Interface programática: Interface programática<2>. 

@end menu

@node Uso na linha de comando<13>,Interface programática<2>,,pickletools — Ferramentas para desenvolvedores pickle
@anchor{library/pickletools command-line-usage}@anchor{49ce}@anchor{library/pickletools pickletools-cli}@anchor{49cf}
@subsubsection Uso na linha de comando



Adicionado na versão 3.2.


Quando chamado a partir da linha de comando, @code{python -m pickletools} irá desmontar o conteúdo de um ou mais arquivos pickle. Note que se você quiser ver o objeto Python armazenado serializado em pickle ao invés dos detalhes do formato pickle, você pode usar @code{-m pickle}. No entanto, quando o arquivo serializado em pickle que você deseja examinar vem de uma fonte não confiável, @code{-m pickletools} é uma opção mais segura porque não executa bytecode pickle.

Por exemplo, com uma tupla @code{(1, 2)} tratada com pickling no arquivo @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
* Opções da linha de comando: Opções da linha de comando<2>. 

@end menu

@node Opções da linha de comando<2>,,,Uso na linha de comando<13>
@anchor{library/pickletools command-line-options}@anchor{49d0}
@subsubsection Opções da linha de comando


@geindex pickletools opção de linha de comando; -a
@geindex pickletools opção de linha de comando; --annotate
@anchor{library/pickletools cmdoption-pickletools-a}@anchor{49d1}@anchor{library/pickletools cmdoption-pickletools-annotate}@anchor{49d2}
@deffn {Option} @w{-}a, @w{-}@w{-}annotate

Anota cada linha com uma descrição curta do código de operação.
@end deffn

@geindex pickletools opção de linha de comando; -o
@geindex pickletools opção de linha de comando; --output
@anchor{library/pickletools cmdoption-pickletools-o}@anchor{49d3}@anchor{library/pickletools cmdoption-pickletools-output}@anchor{49d4}
@deffn {Option} @w{-}o, @w{-}@w{-}output=<file>

Nome de um arquivo no qual a saída deve ser escrita.
@end deffn

@geindex pickletools opção de linha de comando; -l
@geindex pickletools opção de linha de comando; --indentlevel
@anchor{library/pickletools cmdoption-pickletools-l}@anchor{49d5}@anchor{library/pickletools cmdoption-pickletools-indentlevel}@anchor{49d6}
@deffn {Option} @w{-}l, @w{-}@w{-}indentlevel=<num>

O número de espaços em branco para indentar um novo nível MARK.
@end deffn

@geindex pickletools opção de linha de comando; -m
@geindex pickletools opção de linha de comando; --memo
@anchor{library/pickletools cmdoption-pickletools-m}@anchor{49d7}@anchor{library/pickletools cmdoption-pickletools-memo}@anchor{49d8}
@deffn {Option} @w{-}m, @w{-}@w{-}memo

Quando vários objetos são desmontados, preserva memo entre as desmontagens.
@end deffn

@geindex pickletools opção de linha de comando; -p
@geindex pickletools opção de linha de comando; --preamble
@anchor{library/pickletools cmdoption-pickletools-p}@anchor{49d9}@anchor{library/pickletools cmdoption-pickletools-preamble}@anchor{49da}
@deffn {Option} @w{-}p, @w{-}@w{-}preamble=<preamble>

Quando mais de um arquivo serializado em pickle for especificado, imprime o preâmbulo fornecido antes de cada desmontagem.
@end deffn

@node Interface programática<2>,,Uso na linha de comando<13>,pickletools — Ferramentas para desenvolvedores pickle
@anchor{library/pickletools programmatic-interface}@anchor{49db}
@subsubsection Interface programática


@geindex dis() (no módulo pickletools)
@anchor{library/pickletools pickletools dis}@anchor{ce3}
@deffn {Função} pickletools.dis (pickle, out=None, memo=None, indentlevel=4, annotate=0)

Produz uma desmontagem simbólica do pickle para o objeto arquivo ou similar `out', tendo como padrão @code{sys.stdout}. `pickle' pode ser uma string ou um objeto arquivo ou similar. `memo' pode ser um dicionário Python que será usado como memo do pickle; ele pode ser usado para realizar desmontagens em várias serializações com pickle criadas pelo mesmo pickler. Níveis sucessivos, indicados por códigos de operação @code{MARK} no fluxo, são indentados por espaços `indentlevel'. Se um valor diferente de zero for fornecido para `annotate', cada código de operação na saída será anotado com uma breve descrição. O valor de `annotate' é usado como uma dica para a coluna onde a anotação deve começar.


Alterado na versão 3.2: Adicionado o parâmetro `annotate'.

@end deffn

@geindex genops() (no módulo pickletools)
@anchor{library/pickletools pickletools genops}@anchor{49dc}
@deffn {Função} pickletools.genops (pickle)

Fornece um @ref{1ac,,iterador} sobre todos os códigos de operação em uma serialização com pickle, retornando uma sequência de triplos @code{(opcode, arg, pos)}. `opcode' é uma instância de uma classe @code{OpcodeInfo}; `arg' é o valor decodificado, como um objeto Python, do argumento do opcode; `pos' é a posição em que este código de operação está localizado. `pickle' pode ser uma string ou um objeto arquivo ou similar.
@end deffn

@geindex optimize() (no módulo pickletools)
@anchor{library/pickletools pickletools optimize}@anchor{2a4f}
@deffn {Função} pickletools.optimize (picklestring)

Retorna uma nova string pickle equivalente após eliminar códigos de operação @code{PUT} não utilizados. O pickle otimizado é mais curto, leva menos tempo de transmissão, requer menos espaço de armazenamento e efetua unpickling com mais eficiência.
@end deffn

@node Serviços Específicos do MS Windows,Serviços específicos do Unix,Serviços da Linguagem Python,A Biblioteca Padrão do Python
@anchor{library/windows doc}@anchor{49dd}@anchor{library/windows ms-windows-specific-services}@anchor{49de}@anchor{library/windows mswin-specific-services}@anchor{1fbb}@anchor{library/windows translation-repo}@anchor{49df}
@section Serviços Específicos do MS Windows


Este capítulo descreve módulos que estão disponíveis somente na plataformas MS Windows.

@menu
* msvcrt — Rotinas úteis do runtime MS VC++:: 
* winreg — Acesso aos registros do Windows:: 
* winsound — Interface de reprodução de som para o Windows:: 

@end menu

@node msvcrt — Rotinas úteis do runtime MS VC++,winreg — Acesso aos registros do Windows,,Serviços Específicos do MS Windows
@anchor{library/msvcrt doc}@anchor{49e0}@anchor{library/msvcrt module-msvcrt}@anchor{93}@anchor{library/msvcrt msvcrt-useful-routines-from-the-ms-vc-runtime}@anchor{49e1}
@subsection @code{msvcrt} — Rotinas úteis do runtime MS VC++


@geindex module; msvcrt


__________________________________________________________________


Essas funções fornecem acesso a alguns recursos úteis em plataformas Windows. Alguns módulos de nível superior usam essas funções para construir as implementações de seus serviços no Windows. Por exemplo, o módulo @ref{62,,getpass} usa isso na implementação da função @ref{62,,getpass()}.

Mais documentação sobre essas funções pode ser encontrada na documentação da API da plataforma.

O módulo implementa as variantes normal e ampla de caracteres da API de E/S do console. A API normal lida apenas com caracteres ASCII e é de uso limitado para aplicativos internacionalizados. A API ampla de caracteres deve ser usada sempre que possível.

@ref{1ed8,,Disponibilidade}: Windows.


Alterado na versão 3.3: As operações neste módulo agora levantam @ref{417,,OSError} onde @ref{108b,,IOError} foi levantado.


@menu
* Operações com arquivos:: 
* E/S de console:: 
* Outras funções: Outras funções<4>. 

@end menu

@node Operações com arquivos,E/S de console,,msvcrt — Rotinas úteis do runtime MS VC++
@anchor{library/msvcrt file-operations}@anchor{49e2}@anchor{library/msvcrt msvcrt-files}@anchor{49e3}
@subsubsection Operações com arquivos


@geindex locking() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt locking}@anchor{4408}
@deffn {Função} msvcrt.locking (fd, mode, nbytes)

Trava parte de um arquivo com base no descritor de arquivo `fd' do runtime do C. Levanta @ref{417,,OSError} em caso de falha. A região travada do arquivo se estende da posição atual do arquivo por `nbytes' bytes e pode continuar além do final do arquivo. `mode' deve ser uma das constantes @code{LK_*} listadas abaixo. Várias regiões em um arquivo podem ser travadas ao mesmo tempo, mas não podem se sobrepor. Regiões adjacentes não são mescladas; elas devem ser destravadas individualmente.

Levanta um @ref{19fa,,evento de auditoria} @code{msvcrt.locking} com os argumentos @code{fd}, @code{mode}, @code{nbytes}.
@end deffn

@geindex LK_LOCK (no módulo msvcrt)
@geindex LK_RLCK (no módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_LOCK}@anchor{49e4}
@deffn {Dado} msvcrt.LK_LOCK
@anchor{library/msvcrt msvcrt LK_RLCK}@anchor{49e5}
@deffnx {Dado} msvcrt.LK_RLCK

Trava os bytes especificados. Se os bytes não puderem ser travados, o programa tenta novamente imediatamente após 1 segundo. Se, após 10 tentativas, os bytes não puderem ser travados, @ref{417,,OSError} é levantada.
@end deffn

@geindex LK_NBLCK (no módulo msvcrt)
@geindex LK_NBRLCK (no módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_NBLCK}@anchor{49e6}
@deffn {Dado} msvcrt.LK_NBLCK
@anchor{library/msvcrt msvcrt LK_NBRLCK}@anchor{49e7}
@deffnx {Dado} msvcrt.LK_NBRLCK

Trava os bytes especificados. Se os bytes não puderem ser travados, uma exceção @ref{417,,OSError} é levantada.
@end deffn

@geindex LK_UNLCK (no módulo msvcrt)
@anchor{library/msvcrt msvcrt LK_UNLCK}@anchor{49e8}
@deffn {Dado} msvcrt.LK_UNLCK

Destrava os bytes especificados, que devem ter sido travados anteriormente.
@end deffn

@geindex setmode() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt setmode}@anchor{49e9}
@deffn {Função} msvcrt.setmode (fd, flags)

Defina o modo de conversão de final de linha para o descritor de arquivo `fd'. Para configurá-lo no modo de texto, `flags' deve ser @ref{2d35,,os.O_TEXT}; para binário, deve ser @ref{2d26,,os.O_BINARY}.
@end deffn

@geindex open_osfhandle() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt open_osfhandle}@anchor{4409}
@deffn {Função} msvcrt.open_osfhandle (handle, flags)

Crie um descritor de arquivo de tempo de execução do C a partir do identificador de arquivo `handle'. O parâmetro `flags' deve ser um OU bit a bit de @ref{2d28,,os.O_APPEND}, @ref{2d24,,os.O_RDONLY}, @ref{2d35,,os.O_TEXT} e @ref{2d30,,os.O_NOINHERIT}. O descritor de arquivo retornado pode ser usado como parâmetro para @ref{20c4,,os.fdopen()} para criar um objeto de arquivo.

O descritor de arquivo é herdável por padrão. Passe o sinalizador @ref{2d30,,os.O_NOINHERIT} para torná-lo não herdável.

Levanta um @ref{19fa,,evento de auditoria} @code{msvcrt.open_osfhandle} com os argumentos @code{handle}, @code{flags}.
@end deffn

@geindex get_osfhandle() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt get_osfhandle}@anchor{4407}
@deffn {Função} msvcrt.get_osfhandle (fd)

Retorna o identificador de arquivo para o descritor de arquivo `fd'. Levanta @ref{417,,OSError} se `fd' não for reconhecido.

Levanta um @ref{19fa,,evento de auditoria} @code{msvcrt.get_osfhandle} com o argumento @code{fd}.
@end deffn

@node E/S de console,Outras funções<4>,Operações com arquivos,msvcrt — Rotinas úteis do runtime MS VC++
@anchor{library/msvcrt console-i-o}@anchor{49ea}@anchor{library/msvcrt msvcrt-console}@anchor{49eb}
@subsubsection E/S de console


@geindex kbhit() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt kbhit}@anchor{49ec}
@deffn {Função} msvcrt.kbhit ()

Retorna um valor diferente de zero se houver uma tecla pressionada aguardando leitura. Caso contrário, retorna 0.
@end deffn

@geindex getch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt getch}@anchor{49ed}
@deffn {Função} msvcrt.getch ()

Lê um pressionamento de tecla e retorna o caractere resultante como uma sequência de bytes. Nada é ecoado no console. Essa chamada será bloqueada se um pressionamento de tecla ainda não estiver disponível, mas não esperará que @code{Enter} seja pressionado. Se a tecla pressionada for uma tecla de função especial, ela retornará @code{'\000'} ou @code{'\xe0'}; a próxima chamada retornará o código da chave. A tecla @code{Control}-@code{C} não pode ser lida com esta função.
@end deffn

@geindex getwch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt getwch}@anchor{143c}
@deffn {Função} msvcrt.getwch ()

Variante com caractere largo de @ref{49ed,,getch()}, retornando um valor Unicode.
@end deffn

@geindex getche() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt getche}@anchor{49ee}
@deffn {Função} msvcrt.getche ()

Semelhante a @ref{49ed,,getch()}, mas o pressionamento de tecla será repetido se representar um caractere imprimível.
@end deffn

@geindex getwche() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt getwche}@anchor{143d}
@deffn {Função} msvcrt.getwche ()

Variante com caractere largo de @ref{49ee,,getche()}, retornando um valor Unicode.
@end deffn

@geindex putch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt putch}@anchor{49ef}
@deffn {Função} msvcrt.putch (char)

Imprime a string de bytes `char' no console sem armazenar em buffer.
@end deffn

@geindex putwch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt putwch}@anchor{143e}
@deffn {Função} msvcrt.putwch (unicode_char)

Variante com caractere largo de @ref{49ef,,putch()}, retornando um valor Unicode.
@end deffn

@geindex ungetch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt ungetch}@anchor{49f0}
@deffn {Função} msvcrt.ungetch (char)

Faz com que a string de bytes `char' seja “empurrada” para o buffer do console; será o próximo caractere lido por @ref{49ed,,getch()} ou @ref{49ee,,getche()}.
@end deffn

@geindex ungetwch() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt ungetwch}@anchor{49f1}
@deffn {Função} msvcrt.ungetwch (unicode_char)

Variante com caractere largo de @ref{49f0,,ungetch()}, retornando um valor Unicode.
@end deffn

@node Outras funções<4>,,E/S de console,msvcrt — Rotinas úteis do runtime MS VC++
@anchor{library/msvcrt msvcrt-other}@anchor{49f2}@anchor{library/msvcrt other-functions}@anchor{49f3}
@subsubsection Outras funções


@geindex heapmin() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt heapmin}@anchor{49f4}
@deffn {Função} msvcrt.heapmin ()

Força o heap @code{malloc()} a ser limpado e retorna os blocos não utilizados ao sistema operacional. Em caso de falha, isso levanta @ref{417,,OSError}.
@end deffn

@geindex set_error_mode() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt set_error_mode}@anchor{49f5}
@deffn {Função} msvcrt.set_error_mode (mode)

Altera o local onde o ambiente de execução C grava uma mensagem de erro para um erro que pode encerrar o programa. `mode' deve ser uma das constantes @code{OUT_*} listadas abaixo ou @ref{49f6,,REPORT_ERRMODE}. Retorna a configuração anterior ou -1 se ocorrer um erro. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex OUT_TO_DEFAULT (no módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_DEFAULT}@anchor{49f7}
@deffn {Dado} msvcrt.OUT_TO_DEFAULT

O destino dos erros é determinado pelo tipo da aplicação. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex OUT_TO_STDERR (no módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_STDERR}@anchor{49f8}
@deffn {Dado} msvcrt.OUT_TO_STDERR

O destino dos erros é um de erro padrão. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex OUT_TO_MSGBOX (no módulo msvcrt)
@anchor{library/msvcrt msvcrt OUT_TO_MSGBOX}@anchor{49f9}
@deffn {Dado} msvcrt.OUT_TO_MSGBOX

O destino dos erros é um de caixa de mensagem. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex REPORT_ERRMODE (no módulo msvcrt)
@anchor{library/msvcrt msvcrt REPORT_ERRMODE}@anchor{49f6}
@deffn {Dado} msvcrt.REPORT_ERRMODE

Relata o valor atual do modo de erro. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex CrtSetReportMode() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CrtSetReportMode}@anchor{49fa}
@deffn {Função} msvcrt.CrtSetReportMode (type, mode)

Especifica o destino ou destinos para um tipo de relatório específico gerado por @code{_CrtDbgReport()} no ambiente de execução do MS VC++. `type' deve ser uma das constantes @code{CRT_*} listadas abaixo. `mode' deve ser uma das constantes @code{CRTDBG_*} listadas abaixo. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex CrtSetReportFile() (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CrtSetReportFile}@anchor{49fb}
@deffn {Função} msvcrt.CrtSetReportFile (type, file)

Após usar @ref{49fa,,CrtSetReportMode()} para especificar @ref{49fc,,CRTDBG_MODE_FILE}, você pode especificar o identificador do arquivo que receberá o texto da mensagem. `type' deve ser uma das constantes @code{CRT_*} listadas abaixo. `file' deve ser o identificador do arquivo que você deseja especificar. Disponível apenas na @ref{1f9,,construção de depuração do Python}.
@end deffn

@geindex CRT_WARN (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_WARN}@anchor{49fd}
@deffn {Dado} msvcrt.CRT_WARN

Avisos, mensagens e informações que não exigem atenção imediata.
@end deffn

@geindex CRT_ERROR (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ERROR}@anchor{49fe}
@deffn {Dado} msvcrt.CRT_ERROR

Erros, problemas irrecuperáveis e questões que exigem atenção imediata.
@end deffn

@geindex CRT_ASSERT (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ASSERT}@anchor{49ff}
@deffn {Dado} msvcrt.CRT_ASSERT

Falhas de asserção.
@end deffn

@geindex CRTDBG_MODE_DEBUG (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_DEBUG}@anchor{4a00}
@deffn {Dado} msvcrt.CRTDBG_MODE_DEBUG

Escreve a mensagem na janela de saída do depurador.
@end deffn

@geindex CRTDBG_MODE_FILE (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_FILE}@anchor{49fc}
@deffn {Dado} msvcrt.CRTDBG_MODE_FILE

Escreve a mensagem em um descritor de arquivo fornecido pelo usuário. @ref{49fb,,CrtSetReportFile()} deve ser chamada para definir o arquivo ou fluxo específico a ser usado como destino.
@end deffn

@geindex CRTDBG_MODE_WNDW (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_MODE_WNDW}@anchor{4a01}
@deffn {Dado} msvcrt.CRTDBG_MODE_WNDW

Cria uma caixa de mensagem para exibir a mensagem juntamente com os botões @code{Abort}, @code{Retry} e @code{Ignore}.
@end deffn

@geindex CRTDBG_REPORT_MODE (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRTDBG_REPORT_MODE}@anchor{4a02}
@deffn {Dado} msvcrt.CRTDBG_REPORT_MODE

Retorna o `modole' atual para o `type' especificado.
@end deffn

@geindex CRT_ASSEMBLY_VERSION (no módulo msvcrt)
@anchor{library/msvcrt msvcrt CRT_ASSEMBLY_VERSION}@anchor{13a6}
@deffn {Dado} msvcrt.CRT_ASSEMBLY_VERSION

A versão do CRT Assembly, do arquivo de cabeçalho @code{crtassem.h}.
@end deffn

@geindex VC_ASSEMBLY_PUBLICKEYTOKEN (no módulo msvcrt)
@anchor{library/msvcrt msvcrt VC_ASSEMBLY_PUBLICKEYTOKEN}@anchor{13a7}
@deffn {Dado} msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN

O token da chave pública do VC Assembly, do arquivo de cabeçalho @code{crtassem.h}.
@end deffn

@geindex LIBRARIES_ASSEMBLY_NAME_PREFIX (no módulo msvcrt)
@anchor{library/msvcrt msvcrt LIBRARIES_ASSEMBLY_NAME_PREFIX}@anchor{13a8}
@deffn {Dado} msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX

O prefixo do nome de Libraries Assembly, do arquivo de cabeçalho @code{crtassem.h}.
@end deffn

@node winreg — Acesso aos registros do Windows,winsound — Interface de reprodução de som para o Windows,msvcrt — Rotinas úteis do runtime MS VC++,Serviços Específicos do MS Windows
@anchor{library/winreg doc}@anchor{4a03}@anchor{library/winreg module-winreg}@anchor{116}@anchor{library/winreg translation-repo}@anchor{4a04}@anchor{library/winreg winreg-windows-registry-access}@anchor{4a05}
@subsection @code{winreg} — Acesso aos registros do Windows


@geindex module; winreg


__________________________________________________________________


Essas funções expõem a API de registro do Windows ao Python. Em vez de usar um inteiro como identificador de registro, um @ref{4a06,,objeto identificador} é usado para garantir que os identificadores sejam fechados corretamente, mesmo que o programador não os feche explicitamente.

@ref{1ed8,,Disponibilidade}: Windows.
@anchor{library/winreg exception-changed}@anchor{4a07}

Alterado na versão 3.3: Várias funções neste módulo costumavam levantar um @ref{108d,,WindowsError} , que agora é um apelido de @ref{417,,OSError}.


@menu
* Funções: Funções<13>. 
* Constantes: Constantes<10>. 
* Objetos identificador de registro:: 

@end menu

@node Funções<13>,Constantes<10>,,winreg — Acesso aos registros do Windows
@anchor{library/winreg functions}@anchor{4a08}@anchor{library/winreg id1}@anchor{4a09}
@subsubsection Funções


Este módulo oferece as seguintes funções:

@geindex CloseKey() (no módulo winreg)
@anchor{library/winreg winreg CloseKey}@anchor{4a0a}
@deffn {Função} winreg.CloseKey (hkey)

Fecha uma chave de registro aberta anteriormente. O argumento `hkey' especifica uma chave aberta anteriormente.

@cartouche
@quotation Nota 
Se `hkey' não for fechado usando este método (ou via @ref{4a0b,,hkey.Close()}), ele será fechado quando o objeto `hkey' for destruído pelo Python.
@end quotation
@end cartouche
@end deffn

@geindex ConnectRegistry() (no módulo winreg)
@anchor{library/winreg winreg ConnectRegistry}@anchor{440d}
@deffn {Função} winreg.ConnectRegistry (computer_name, key)

Estabelece uma conexão com um identificador de registro predefinido em outro computador e retorna um @ref{4a06,,objeto identificador}.

`computer_name' é o nome do computador remoto, no formato @code{r"\\computername"}. Se @code{None}, o computador local será usado.

`key' é o identificador predefinido para conexão.

O valor de retorno é o identificador da chave aberta. Se a função falhar, uma exceção @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.ConnectRegistry} com os argumentos @code{computer_name}, @code{key}.


Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex CreateKey() (no módulo winreg)
@anchor{library/winreg winreg CreateKey}@anchor{440e}
@deffn {Função} winreg.CreateKey (key, sub_key)

Cria ou abre a chave especificada, retornando um @ref{4a06,,objeto identificador}.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que nomeia a chave que este método abre ou cria.

Se `key' for uma das chaves predefinidas, `sub_key' poderá ser @code{None}. Nesse caso, o identificador retornado será o mesmo identificador de chave passado para a função.

Se a chave já existir, esta função abre a chave existente.

O valor de retorno é o identificador da chave aberta. Se a função falhar, uma exceção @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.CreateKey} com os argumentos @code{key}, @code{sub_key}, @code{access}.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.OpenKey/result} com o argumento @code{key}.


Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex CreateKeyEx() (no módulo winreg)
@anchor{library/winreg winreg CreateKeyEx}@anchor{13a9}
@deffn {Função} winreg.CreateKeyEx (key, sub_key, reserved=0, access=KEY_WRITE)

Cria ou abre a chave especificada, retornando um @ref{4a06,,objeto identificador}.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que nomeia a chave que este método abre ou cria.

`reserved' é um inteiro reservado e deve ser zero. O padrão é zero.

`access' é um inteiro que especifica uma máscara de acesso que descreve o acesso de segurança desejado para a chave. O padrão é @ref{4a0d,,KEY_WRITE}. Consulte @ref{4a0e,,Direitos de acesso} para outros valores permitidos.

Se `key' for uma das chaves predefinidas, `sub_key' poderá ser @code{None}. Nesse caso, o identificador retornado será o mesmo identificador de chave passado para a função.

Se a chave já existir, esta função abre a chave existente.

O valor de retorno é o identificador da chave aberta. Se a função falhar, uma exceção @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.CreateKey} com os argumentos @code{key}, @code{sub_key}, @code{access}.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.OpenKey/result} com o argumento @code{key}.


Adicionado na versão 3.2.



Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex DeleteKey() (no módulo winreg)
@anchor{library/winreg winreg DeleteKey}@anchor{440f}
@deffn {Função} winreg.DeleteKey (key, sub_key)

Exclui a chave especificada.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que deve ser uma subchave da chave identificada pelo parâmetro `key'. Este valor não pode ser @code{None}, e a chave não pode ter subchaves.

`Este método não pode excluir chaves com subchaves.'

Se o método for bem-sucedido, a chave inteira, incluindo todos os seus valores, será removida. Se o método falhar, uma exceção @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.DeleteKey} com os argumentos @code{key}, @code{sub_key}, @code{access}.


Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex DeleteKeyEx() (no módulo winreg)
@anchor{library/winreg winreg DeleteKeyEx}@anchor{13aa}
@deffn {Função} winreg.DeleteKeyEx (key, sub_key, access=KEY_WOW64_64KEY, reserved=0)

Exclui a chave especificada.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que deve ser uma subchave da chave identificada pelo parâmetro `key'. Este valor não pode ser @code{None}, e a chave não pode ter subchaves.

`reserved' é um inteiro reservado e deve ser zero. O padrão é zero.

`access' é um inteiro que especifica uma máscara de acesso que descreve o acesso de segurança desejado para a chave. O padrão é @ref{4a0f,,KEY_WOW64_64KEY}. No Windows de 32 bits, as constantes WOW64 são ignoradas. Consulte @ref{4a0e,,Direitos de acesso} para outros valores permitidos.

`Este método não pode excluir chaves com subchaves.'

Se o método for bem-sucedido, a chave inteira, incluindo todos os seus valores, será removida. Se o método falhar, uma exceção @ref{417,,OSError} será levantada.

Em versões do Windows sem suporte, @ref{228,,NotImplementedError} é levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.DeleteKey} com os argumentos @code{key}, @code{sub_key}, @code{access}.


Adicionado na versão 3.2.



Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex DeleteValue() (no módulo winreg)
@anchor{library/winreg winreg DeleteValue}@anchor{4410}
@deffn {Função} winreg.DeleteValue (key, value)

Remove um valor nomeado de uma chave de registro.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`value' é uma string que identifica o valor a ser removido.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.DeleteValue} com os argumentos @code{key}, @code{value}.
@end deffn

@geindex EnumKey() (no módulo winreg)
@anchor{library/winreg winreg EnumKey}@anchor{4411}
@deffn {Função} winreg.EnumKey (key, index)

Enumera subchaves de uma chave de registro aberta, retornando uma string.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`index' é um inteiro que identifica o índice da chave a ser recuperada.

A função recupera o nome de uma subchave cada vez que é chamada. Normalmente, ela é chamada repetidamente até que uma exceção @ref{417,,OSError} seja levantada, indicando que não há mais valores disponíveis.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.EnumKey} com os argumentos @code{key}, @code{index}.


Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex EnumValue() (no módulo winreg)
@anchor{library/winreg winreg EnumValue}@anchor{4412}
@deffn {Função} winreg.EnumValue (key, index)

Enumera valores de uma chave de registro aberta, retornando uma tupla.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`index' é um inteiro que identifica o índice do valor a ser recuperado.

A função recupera o nome de uma subchave cada vez que é chamada. Normalmente, ela é chamada repetidamente, até que uma exceção @ref{417,,OSError} seja levantada, indicando que não há mais valores.

O resultado é uma tupla de 3 itens:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

Uma string que identifica o nome do valor

@item

@code{1}

@tab

Um objeto que contém os dados de valor e cujo tipo depende do tipo de registro subjacente

@item

@code{2}

@tab

Um inteiro que identifica o tipo dos dados do valor (veja a tabela na documentação para @ref{188b,,SetValueEx()})

@end multitable


Levanta um @ref{19fa,,evento de auditoria} @code{winreg.EnumValue} com os argumentos @code{key}, @code{index}.


Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex % (porcentagem);expansão de variáveis de ambiente (Windows)

@geindex ExpandEnvironmentStrings() (no módulo winreg)
@anchor{library/winreg winreg ExpandEnvironmentStrings}@anchor{143f}
@deffn {Função} winreg.ExpandEnvironmentStrings (str)

Expande os espaços reservados de posição de variáveis de ambiente @code{%NAME%} em strings como @ref{4a10,,REG_EXPAND_SZ}:

@example
>>> ExpandEnvironmentStrings('%windir%')
'C:\\Windows'
@end example

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.ExpandEnvironmentStrings} com o argumento @code{str}.
@end deffn

@geindex FlushKey() (no módulo winreg)
@anchor{library/winreg winreg FlushKey}@anchor{4a11}
@deffn {Função} winreg.FlushKey (key)

Grava todos os atributos de uma chave no registro.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

Não é necessário chamar @ref{4a11,,FlushKey()} para alterar uma chave. As alterações do registro são descarregadas no disco pelo registro usando seu limpador lento. As alterações do registro também são descarregadas no disco no desligamento do sistema. Ao contrário de @ref{4a0a,,CloseKey()}, o método @ref{4a11,,FlushKey()} retorna somente quando todos os dados foram gravados no registro. Uma aplicação só deve chamar @ref{4a11,,FlushKey()} se precisar de certeza absoluta de que as alterações do registro estão no disco.

@cartouche
@quotation Nota 
Se você não sabe se uma chamada @ref{4a11,,FlushKey()} é necessária, provavelmente não é.
@end quotation
@end cartouche
@end deffn

@geindex LoadKey() (no módulo winreg)
@anchor{library/winreg winreg LoadKey}@anchor{4413}
@deffn {Função} winreg.LoadKey (key, sub_key, file_name)

Cria uma subchave sob a chave especificada e armazena informações de registro de um arquivo especificado nessa subchave.

`key' é um identificador retornado por @ref{440d,,ConnectRegistry()} ou uma das constantes @ref{4a12,,HKEY_USERS} ou @ref{4a13,,HKEY_LOCAL_MACHINE}.

`sub_key' é uma string que identifica a subchave a ser carregada.

`file_name' é o nome do arquivo do qual serão carregados os dados do registro. Este arquivo deve ter sido criado com a função @ref{4418,,SaveKey()}. No sistema de arquivos da tabela de alocação de arquivos (FAT), o nome do arquivo não pode ter extensão.

Uma chamada para @ref{4413,,LoadKey()} falhará se o processo de chamada não tiver o privilégio @code{SE_RESTORE_PRIVILEGE}. Observe que privilégios são diferentes de permissões — consulte a documentação do RegLoadKey@footnote{https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx} para mais detalhes.

Se `key' for um identificador retornado por @ref{440d,,ConnectRegistry()}, então o caminho especificado em `file_name' será relativo ao computador remoto.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.LoadKey} com os argumentos @code{key}, @code{sub_key}, @code{file_name}.
@end deffn

@geindex OpenKey() (no módulo winreg)
@geindex OpenKeyEx() (no módulo winreg)
@anchor{library/winreg winreg OpenKey}@anchor{4414}
@deffn {Função} winreg.OpenKey (key, sub_key, reserved=0, access=KEY_READ)
@anchor{library/winreg winreg OpenKeyEx}@anchor{4a14}
@deffnx {Função} winreg.OpenKeyEx (key, sub_key, reserved=0, access=KEY_READ)

Abre a chave especificada, retornando um @ref{4a06,,objeto identificador}.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que identifica a sub_key a ser aberta.

`reserved' é um inteiro reservado e deve ser zero. O padrão é zero.

`access' é um inteiro que especifica uma máscara de acesso que descreve o acesso de segurança desejado para a chave. O padrão é @ref{4a15,,KEY_READ}. Consulte @ref{4a0e,,Direitos de acesso} para outros valores permitidos.

O resultado é um novo identificador para a chave especificada.

Se a função falhar, @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.OpenKey} com os argumentos @code{key}, @code{sub_key}, @code{access}.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.OpenKey/result} com o argumento @code{key}.


Alterado na versão 3.2: Permite o uso de argumentos nomeados.



Alterado na versão 3.3: Veja @ref{4a07,,acima}.

@end deffn

@geindex QueryInfoKey() (no módulo winreg)
@anchor{library/winreg winreg QueryInfoKey}@anchor{4416}
@deffn {Função} winreg.QueryInfoKey (key)

Retorna informações sobre uma chave, como uma tupla.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

O resultado é uma tupla de 3 itens:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

Um inteiro que fornece o número de subchaves que esta chave possui.

@item

@code{1}

@tab

Um inteiro que fornece o número de valores que esta chave possui.

@item

@code{2}

@tab

Um número inteiro que indica quando a chave foi modificada pela última vez (se disponível) em centenas de nanossegundos desde 1º de janeiro de 1601.

@end multitable


Levanta um @ref{19fa,,evento de auditoria} @code{winreg.QueryInfoKey} com o argumento @code{key}.
@end deffn

@geindex QueryValue() (no módulo winreg)
@anchor{library/winreg winreg QueryValue}@anchor{4417}
@deffn {Função} winreg.QueryValue (key, sub_key)

Recupera o valor sem nome de uma chave, como uma string.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que contém o nome da subchave à qual o valor está associado. Se este parâmetro for @code{None} ou estiver vazio, a função recupera o valor definido pelo método @ref{4419,,SetValue()} para a chave identificada por `key'.

Os valores no registro têm componentes de nome, tipo e dados. Este método recupera os dados do primeiro valor de uma chave que possui um nome @code{NULL}. Mas a chamada de API subjacente não retorna o tipo, portanto, sempre use @ref{15ab,,QueryValueEx()} se possível.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.QueryValue} com os argumentos @code{key}, @code{sub_key}, @code{value_name}.
@end deffn

@geindex QueryValueEx() (no módulo winreg)
@anchor{library/winreg winreg QueryValueEx}@anchor{15ab}
@deffn {Função} winreg.QueryValueEx (key, value_name)

Recupera o tipo e os dados de um nome de valor especificado associado a uma chave de registro aberta.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`value_name' é uma string que indica o valor a ser consultado.

O resultado é uma tupla de 2 itens:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Significado

@item

@code{0}

@tab

O valor do item do registro.

@item

@code{1}

@tab

Um inteiro que fornece o tipo de registro para este valor (veja a tabela na documentação para @ref{188b,,SetValueEx()})

@end multitable


Levanta um @ref{19fa,,evento de auditoria} @code{winreg.QueryValue} com os argumentos @code{key}, @code{sub_key}, @code{value_name}.
@end deffn

@geindex SaveKey() (no módulo winreg)
@anchor{library/winreg winreg SaveKey}@anchor{4418}
@deffn {Função} winreg.SaveKey (key, file_name)

Salva a chave especificada e todas as suas subchaves no arquivo especificado.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`file_name' é o nome do arquivo para salvar os dados do registro. Este arquivo não pode existir. Se este nome de arquivo incluir uma extensão, ele não poderá ser usado em sistemas de arquivos FAT (tabela de alocação de arquivos) pelo método @ref{4413,,LoadKey()}.

Se `key' representa uma chave em um computador remoto, o caminho descrito por `file_name' é relativo ao computador remoto. O chamador deste método deve possuir o privilégio de segurança `SeBackupPrivilege'. Observe que privilégios são diferentes de permissões — consulte a documentação Conflitos entre Direitos e Permissões do Usuário@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx} para obter mais detalhes.

Esta função passa @code{NULL} para `security_attributes' para a API.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.SaveKey} com os argumentos @code{key}, @code{file_name}.
@end deffn

@geindex SetValue() (no módulo winreg)
@anchor{library/winreg winreg SetValue}@anchor{4419}
@deffn {Função} winreg.SetValue (key, sub_key, type, value)

Associa um valor a uma chave especificada.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`sub_key' é uma string que nomeia a subchave à qual o valor está associado.

`type' é um inteiro que especifica o tipo dos dados. Atualmente, deve ser @ref{4a16,,REG_SZ}, o que significa que apenas strings são suportadas. Use a função @ref{188b,,SetValueEx()} para suporte a outros tipos de dados.

`valor' é uma string que especifica o novo valor.

Se a chave especificada pelo parâmetro `sub_key' não existir, a função SetValue a criará.

O comprimento dos valores é limitado pela memória disponível. Valores longos (mais de 2048 bytes) devem ser armazenados como arquivos com os nomes dos arquivos armazenados no registro de configuração. Isso ajuda o registro a funcionar com eficiência.

A chave identificada pelo parâmetro `key' deve ter sido aberta com acesso @ref{4a17,,KEY_SET_VALUE}.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.SetValue} com os argumentos @code{key}, @code{sub_key}, @code{type}, @code{value}.
@end deffn

@geindex SetValueEx() (no módulo winreg)
@anchor{library/winreg winreg SetValueEx}@anchor{188b}
@deffn {Função} winreg.SetValueEx (key, value_name, reserved, type, value)

Armazena dados no campo de valor de uma chave de registro aberta.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

`value_name' é uma string que nomeia a subchave à qual o valor está associado.

`reserved' pode ser qualquer coisa – zero é sempre passado para a API.

`type' é um inteiro que especifica o tipo dos dados. Consulte @ref{4a18,,Tipos de valor} para os tipos disponíveis.

`valor' é uma string que especifica o novo valor.

Este método também pode definir informações adicionais de valor e tipo para a chave especificada. A chave identificada pelo parâmetro key deve ter sido aberta com o acesso @ref{4a17,,KEY_SET_VALUE}.

Para abrir a chave, use os métodos @ref{440e,,CreateKey()} ou @ref{4414,,OpenKey()}.

O comprimento dos valores é limitado pela memória disponível. Valores longos (mais de 2048 bytes) devem ser armazenados como arquivos com os nomes dos arquivos armazenados no registro de configuração. Isso ajuda o registro a funcionar com eficiência.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.SetValue} com os argumentos @code{key}, @code{sub_key}, @code{type}, @code{value}.
@end deffn

@geindex DisableReflectionKey() (no módulo winreg)
@anchor{library/winreg winreg DisableReflectionKey}@anchor{13ab}
@deffn {Função} winreg.DisableReflectionKey (key)

Desabilita a reflexão do registro para processos de 32 bits em execução em um sistema operacional de 64 bits.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

Geralmente levantará @ref{228,,NotImplementedError} se executado em um sistema operacional de 32 bits.

Se a chave não estiver na lista de reflexão, a função será bem-sucedida, mas não terá efeito. Desabilitar a reflexão para uma chave não afeta a reflexão de nenhuma subchave.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.DisableReflectionKey} com o argumento @code{key}.
@end deffn

@geindex EnableReflectionKey() (no módulo winreg)
@anchor{library/winreg winreg EnableReflectionKey}@anchor{13ac}
@deffn {Função} winreg.EnableReflectionKey (key)

Restaura a reflexão do registro para a chave desabilitada especificada.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

Geralmente levantará @ref{228,,NotImplementedError} se executado em um sistema operacional de 32 bits.

Restaura a reflexão de uma chave não afeta a reflexão de nenhuma subchave.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.EnableReflectionKey} com o argumento @code{key}.
@end deffn

@geindex QueryReflectionKey() (no módulo winreg)
@anchor{library/winreg winreg QueryReflectionKey}@anchor{13ad}
@deffn {Função} winreg.QueryReflectionKey (key)

Determina o estado de reflexão para a chave especificada.

`key' é uma chave já aberta, ou uma das constantes predefinidas @ref{4a0c,,HKEY_*}.

Retorna @code{True} se a reflexão estiver desabilitada.

Geralmente levantará @ref{228,,NotImplementedError} se executado em um sistema operacional de 32 bits.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.QueryReflectionKey} com o argumento @code{key}.
@end deffn

@node Constantes<10>,Objetos identificador de registro,Funções<13>,winreg — Acesso aos registros do Windows
@anchor{library/winreg constants}@anchor{4a19}@anchor{library/winreg id2}@anchor{4a1a}
@subsubsection Constantes


As seguintes constantes são definidas para uso em muitas funções @ref{116,,winreg}.

@menu
* Constantes HKEY_*:: 
* Direitos de acesso:: 
* Tipos de valores:: 

@end menu

@node Constantes HKEY_*,Direitos de acesso,,Constantes<10>
@anchor{library/winreg hkey-constants}@anchor{4a0c}@anchor{library/winreg id3}@anchor{4a1b}
@subsubsection Constantes HKEY_*


@geindex HKEY_CLASSES_ROOT (no módulo winreg)
@anchor{library/winreg winreg HKEY_CLASSES_ROOT}@anchor{4a1c}
@deffn {Dado} winreg.HKEY_CLASSES_ROOT

Entradas de registro subordinadas a esta chave definem tipos (ou classes) de documentos e as propriedades associadas a esses tipos. Aplicações Shell e COM utilizam as informações armazenadas sob esta chave.
@end deffn

@geindex HKEY_CURRENT_USER (no módulo winreg)
@anchor{library/winreg winreg HKEY_CURRENT_USER}@anchor{4a1d}
@deffn {Dado} winreg.HKEY_CURRENT_USER

As entradas de registro subordinadas a esta chave definem as preferências do usuário atual. Essas preferências incluem as configurações de variáveis de ambiente, dados sobre grupos de programas, cores, impressoras, conexões de rede e preferências de aplicações.
@end deffn

@geindex HKEY_LOCAL_MACHINE (no módulo winreg)
@anchor{library/winreg winreg HKEY_LOCAL_MACHINE}@anchor{4a13}
@deffn {Dado} winreg.HKEY_LOCAL_MACHINE

As entradas de registro subordinadas a esta chave definem o estado físico do computador, incluindo dados sobre o tipo de barramento, memória do sistema e hardware e software instalados.
@end deffn

@geindex HKEY_USERS (no módulo winreg)
@anchor{library/winreg winreg HKEY_USERS}@anchor{4a12}
@deffn {Dado} winreg.HKEY_USERS

As entradas de registro subordinadas a esta chave definem a configuração de usuário padrão para novos usuários no computador local e a configuração de usuário para o usuário atual.
@end deffn

@geindex HKEY_PERFORMANCE_DATA (no módulo winreg)
@anchor{library/winreg winreg HKEY_PERFORMANCE_DATA}@anchor{4a1e}
@deffn {Dado} winreg.HKEY_PERFORMANCE_DATA

Entradas de registro subordinadas a esta chave permitem que você acesse dados de desempenho. Os dados não são armazenados no registro; as funções de registro fazem com que o sistema colete os dados de sua fonte.
@end deffn

@geindex HKEY_CURRENT_CONFIG (no módulo winreg)
@anchor{library/winreg winreg HKEY_CURRENT_CONFIG}@anchor{4a1f}
@deffn {Dado} winreg.HKEY_CURRENT_CONFIG

Contém informações sobre o perfil de hardware atual do sistema de computador local.
@end deffn

@geindex HKEY_DYN_DATA (no módulo winreg)
@anchor{library/winreg winreg HKEY_DYN_DATA}@anchor{4a20}
@deffn {Dado} winreg.HKEY_DYN_DATA

Esta chave não é usada em versões do Windows posteriores à 98.
@end deffn

@node Direitos de acesso,Tipos de valores,Constantes HKEY_*,Constantes<10>
@anchor{library/winreg access-rights}@anchor{4a0e}@anchor{library/winreg id4}@anchor{4a21}
@subsubsection Direitos de acesso


Para obter mais informações, consulte Segurança e acesso a chaves do registro@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx}.

@geindex KEY_ALL_ACCESS (no módulo winreg)
@anchor{library/winreg winreg KEY_ALL_ACCESS}@anchor{4a22}
@deffn {Dado} winreg.KEY_ALL_ACCESS

Combina os direitos de acesso STANDARD_RIGHTS_REQUIRED, @ref{4a23,,KEY_QUERY_VALUE}, @ref{4a17,,KEY_SET_VALUE}, @ref{4a24,,KEY_CREATE_SUB_KEY}, @ref{4a25,,KEY_ENUMERATE_SUB_KEYS}, @ref{4a26,,KEY_NOTIFY} e @ref{4a27,,KEY_CREATE_LINK}.
@end deffn

@geindex KEY_WRITE (no módulo winreg)
@anchor{library/winreg winreg KEY_WRITE}@anchor{4a0d}
@deffn {Dado} winreg.KEY_WRITE

Combina os direitos de acesso STANDARD_RIGHTS_WRITE, @ref{4a17,,KEY_SET_VALUE} e @ref{4a24,,KEY_CREATE_SUB_KEY}.
@end deffn

@geindex KEY_READ (no módulo winreg)
@anchor{library/winreg winreg KEY_READ}@anchor{4a15}
@deffn {Dado} winreg.KEY_READ

Combina os valores STANDARD_RIGHTS_READ, @ref{4a23,,KEY_QUERY_VALUE}, @ref{4a25,,KEY_ENUMERATE_SUB_KEYS} e @ref{4a26,,KEY_NOTIFY}.
@end deffn

@geindex KEY_EXECUTE (no módulo winreg)
@anchor{library/winreg winreg KEY_EXECUTE}@anchor{4a28}
@deffn {Dado} winreg.KEY_EXECUTE

Equivalente a @ref{4a15,,KEY_READ}.
@end deffn

@geindex KEY_QUERY_VALUE (no módulo winreg)
@anchor{library/winreg winreg KEY_QUERY_VALUE}@anchor{4a23}
@deffn {Dado} winreg.KEY_QUERY_VALUE

Necessário para consultar os valores de uma chave de registro.
@end deffn

@geindex KEY_SET_VALUE (no módulo winreg)
@anchor{library/winreg winreg KEY_SET_VALUE}@anchor{4a17}
@deffn {Dado} winreg.KEY_SET_VALUE

Necessário para criar, excluir ou definir um valor de registro.
@end deffn

@geindex KEY_CREATE_SUB_KEY (no módulo winreg)
@anchor{library/winreg winreg KEY_CREATE_SUB_KEY}@anchor{4a24}
@deffn {Dado} winreg.KEY_CREATE_SUB_KEY

Necessário para criar uma subchave de uma chave de registro.
@end deffn

@geindex KEY_ENUMERATE_SUB_KEYS (no módulo winreg)
@anchor{library/winreg winreg KEY_ENUMERATE_SUB_KEYS}@anchor{4a25}
@deffn {Dado} winreg.KEY_ENUMERATE_SUB_KEYS

Necessário para enumerar as subchaves de uma chave de registro.
@end deffn

@geindex KEY_NOTIFY (no módulo winreg)
@anchor{library/winreg winreg KEY_NOTIFY}@anchor{4a26}
@deffn {Dado} winreg.KEY_NOTIFY

Necessário para solicitar notificações de alteração para uma chave de registro ou para subchaves de uma chave de registro.
@end deffn

@geindex KEY_CREATE_LINK (no módulo winreg)
@anchor{library/winreg winreg KEY_CREATE_LINK}@anchor{4a27}
@deffn {Dado} winreg.KEY_CREATE_LINK

Reservado para uso pelo sistema.
@end deffn

@menu
* Específico de 64 bits:: 

@end menu

@node Específico de 64 bits,,,Direitos de acesso
@anchor{library/winreg bit-access-rights}@anchor{4a29}@anchor{library/winreg bit-specific}@anchor{4a2a}
@subsubsection Específico de 64 bits


Para obter mais informações, consulte Acessando uma exibição alternativa do Registro@footnote{https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx}.

@geindex KEY_WOW64_64KEY (no módulo winreg)
@anchor{library/winreg winreg KEY_WOW64_64KEY}@anchor{4a0f}
@deffn {Dado} winreg.KEY_WOW64_64KEY

Indica que uma aplicação no Windows 64 bits deve operar na visualização de registro de 64 bits. No Windows de 32 bits, esta constante é ignorada.
@end deffn

@geindex KEY_WOW64_32KEY (no módulo winreg)
@anchor{library/winreg winreg KEY_WOW64_32KEY}@anchor{4a2b}
@deffn {Dado} winreg.KEY_WOW64_32KEY

Indica que uma aplicação no Windows 64 bits deve operar na visualização de registro de 32 bits. No Windows de 32 bits, esta constante é ignorada.
@end deffn

@node Tipos de valores,,Direitos de acesso,Constantes<10>
@anchor{library/winreg id5}@anchor{4a2c}@anchor{library/winreg value-types}@anchor{4a18}
@subsubsection Tipos de valores


Para obter mais informações, consulte Tipos de valor do Registro@footnote{https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx}.

@geindex REG_BINARY (no módulo winreg)
@anchor{library/winreg winreg REG_BINARY}@anchor{4a2d}
@deffn {Dado} winreg.REG_BINARY

Dados binários em qualquer formato.
@end deffn

@geindex REG_DWORD (no módulo winreg)
@anchor{library/winreg winreg REG_DWORD}@anchor{4a2e}
@deffn {Dado} winreg.REG_DWORD

Número de 32 bits.
@end deffn

@geindex REG_DWORD_LITTLE_ENDIAN (no módulo winreg)
@anchor{library/winreg winreg REG_DWORD_LITTLE_ENDIAN}@anchor{4a2f}
@deffn {Dado} winreg.REG_DWORD_LITTLE_ENDIAN

Um número de 32 bits no formato little-endian. Equivalente a @ref{4a2e,,REG_DWORD}.
@end deffn

@geindex REG_DWORD_BIG_ENDIAN (no módulo winreg)
@anchor{library/winreg winreg REG_DWORD_BIG_ENDIAN}@anchor{4a30}
@deffn {Dado} winreg.REG_DWORD_BIG_ENDIAN

Um número de 32 bits no formato big-endian.
@end deffn

@geindex REG_EXPAND_SZ (no módulo winreg)
@anchor{library/winreg winreg REG_EXPAND_SZ}@anchor{4a10}
@deffn {Dado} winreg.REG_EXPAND_SZ

String terminada em nulo contendo referências a variáveis de ambiente (@code{%PATH%}).
@end deffn

@geindex REG_LINK (no módulo winreg)
@anchor{library/winreg winreg REG_LINK}@anchor{4a31}
@deffn {Dado} winreg.REG_LINK

Um link simbólico Unicode.
@end deffn

@geindex REG_MULTI_SZ (no módulo winreg)
@anchor{library/winreg winreg REG_MULTI_SZ}@anchor{1b55}
@deffn {Dado} winreg.REG_MULTI_SZ

Uma sequência de strings terminadas em nulo, terminadas por dois caracteres nulos. (O Python lida com essa terminação automaticamente.)
@end deffn

@geindex REG_NONE (no módulo winreg)
@anchor{library/winreg winreg REG_NONE}@anchor{4a32}
@deffn {Dado} winreg.REG_NONE

Nenhum tipo de valor definido.
@end deffn

@geindex REG_QWORD (no módulo winreg)
@anchor{library/winreg winreg REG_QWORD}@anchor{d24}
@deffn {Dado} winreg.REG_QWORD

Um número de 64 bits.


Adicionado na versão 3.6.

@end deffn

@geindex REG_QWORD_LITTLE_ENDIAN (no módulo winreg)
@anchor{library/winreg winreg REG_QWORD_LITTLE_ENDIAN}@anchor{4a33}
@deffn {Dado} winreg.REG_QWORD_LITTLE_ENDIAN

Um número de 64 bits no formato little-endian. Equivalente a @ref{d24,,REG_QWORD}.


Adicionado na versão 3.6.

@end deffn

@geindex REG_RESOURCE_LIST (no módulo winreg)
@anchor{library/winreg winreg REG_RESOURCE_LIST}@anchor{4a34}
@deffn {Dado} winreg.REG_RESOURCE_LIST

Uma lista de recursos de driver de dispositivo.
@end deffn

@geindex REG_FULL_RESOURCE_DESCRIPTOR (no módulo winreg)
@anchor{library/winreg winreg REG_FULL_RESOURCE_DESCRIPTOR}@anchor{4a35}
@deffn {Dado} winreg.REG_FULL_RESOURCE_DESCRIPTOR

Uma configuração de hardware.
@end deffn

@geindex REG_RESOURCE_REQUIREMENTS_LIST (no módulo winreg)
@anchor{library/winreg winreg REG_RESOURCE_REQUIREMENTS_LIST}@anchor{4a36}
@deffn {Dado} winreg.REG_RESOURCE_REQUIREMENTS_LIST

Uma lista de recursos de hardware.
@end deffn

@geindex REG_SZ (no módulo winreg)
@anchor{library/winreg winreg REG_SZ}@anchor{4a16}
@deffn {Dado} winreg.REG_SZ

Uma string terminada em nulo.
@end deffn

@node Objetos identificador de registro,,Constantes<10>,winreg — Acesso aos registros do Windows
@anchor{library/winreg handle-object}@anchor{4a06}@anchor{library/winreg registry-handle-objects}@anchor{4a37}
@subsubsection Objetos identificador de registro


Este objeto encapsula um objeto HKEY do Windows, fechando-o automaticamente quando o objeto é destruído. Para garantir a limpeza, você pode chamar o método @ref{4a0b,,Close()} no objeto ou a função @ref{4a0a,,CloseKey()}.

Todas as funções de registro neste módulo retornam um destes objetos.

Todas as funções de registro neste módulo que aceitam um objeto identificador também aceitam um inteiro; no entanto, o uso do objeto identificador é incentivado.

Objetos identificador fornecem semântica para @ref{1318,,__bool__()} – portanto

@example
if handle:
    print("Sim")
@end example

vai exibir @code{Sim} se o identificador for válido no momento (não foi fechado ou desanexado).

Objetos identificador podem ser convertidos em um inteiro (por exemplo, usando a função embutida @ref{257,,int()}), caso em que o valor do identificador do Windows subjacente é retornado. Você também pode usar o método @ref{4415,,Detach()} para retornar o identificador inteiro e também desconectar o identificador do Windows do objeto identificador.

@geindex Close() (método winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY Close}@anchor{4a0b}
@deffn {Método} PyHKEY.Close ()

Fecha o identificador subjacente do Windows.

Se o identificador já estiver fechado, nenhum erro será levantado.
@end deffn

@geindex Detach() (método winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY Detach}@anchor{4415}
@deffn {Método} PyHKEY.Detach ()

Separa o identificador do Windows do objeto identificador.

O resultado é um inteiro que contém o valor do identificador antes de ser destacado. Se o identificador já estiver destacado ou fechado, isso retornará zero.

Após chamar esta função, o identificador é efetivamente invalidado, mas não é fechado. Você chamaria esta função quando precisasse que o identificador subjacente de Win32 existisse além do tempo de vida do objeto identificador.

Levanta um @ref{19fa,,evento de auditoria} @code{winreg.PyHKEY.Detach} com o argumento @code{key}.
@end deffn

@geindex __enter__() (método winreg.PyHKEY)
@geindex __exit__() (método winreg.PyHKEY)
@anchor{library/winreg winreg PyHKEY __enter__}@anchor{4a38}
@deffn {Método} PyHKEY.__enter__ ()
@anchor{library/winreg winreg PyHKEY __exit__}@anchor{4a39}
@deffnx {Método} PyHKEY.__exit__ (*exc_info)

O objeto HKEY implementa @ref{5c8,,__enter__()} e @ref{1344,,__exit__()} e, portanto, oferece suporte ao protocolo de contexto para a instrução @ref{5d2,,with}:

@example
with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    ...  # trabalha com a chave "key"
@end example

vai fechar automaticamente `key' quando o controle sair do bloco @ref{5d2,,with}.
@end deffn

@node winsound — Interface de reprodução de som para o Windows,,winreg — Acesso aos registros do Windows,Serviços Específicos do MS Windows
@anchor{library/winsound doc}@anchor{4a3a}@anchor{library/winsound module-winsound}@anchor{117}@anchor{library/winsound translation-repo}@anchor{4a3b}@anchor{library/winsound winsound-sound-playing-interface-for-windows}@anchor{4a3c}
@subsection @code{winsound} — Interface de reprodução de som para o Windows


@geindex module; winsound


__________________________________________________________________


O módulo @ref{117,,winsound} fornece acesso ao mecanismo básico de reprodução de som fornecido pelas plataformas Windows. Inclui funções e várias constantes.

@ref{1ed8,,Disponibilidade}: Windows.

@geindex Beep() (no módulo winsound)
@anchor{library/winsound winsound Beep}@anchor{d26}
@deffn {Função} winsound.Beep (frequency, duration)

Emite um bipe no alto-falante do PC. O parâmetro `frequency' especifica a frequência, em hertz, do som e deve estar no intervalo de 37 a 32.767. O parâmetro `duration' especifica o número de milissegundos que o som deve durar. Se o sistema não conseguir emitir um bipe no alto-falante, @ref{195,,RuntimeError} é levantado.
@end deffn

@geindex PlaySound() (no módulo winsound)
@anchor{library/winsound winsound PlaySound}@anchor{d28}
@deffn {Função} winsound.PlaySound (sound, flags)

Chama a função subjacente @code{PlaySound()} da API da plataforma. O parâmetro `sound' pode ser um nome de arquivo, um apelido de som do sistema, dados de áudio como um @ref{d4f,,objeto bytes ou similar} ou @code{None}. Sua interpretação depende do valor de `flags', que pode ser uma combinação OU bit a bit das constantes descritas abaixo. Se o parâmetro `sound' for @code{None}, qualquer som de forma de onda em execução no momento será interrompido. Se o sistema indicar um erro, @ref{195,,RuntimeError} será levantada.
@end deffn

@geindex MessageBeep() (no módulo winsound)
@anchor{library/winsound winsound MessageBeep}@anchor{d27}
@deffn {Função} winsound.MessageBeep (type=MB_OK)

Chama a função subjacente @code{MessageBeep()} da API da plataforma. Isso reproduz um som conforme especificado no registro. O argumento `type' especifica qual som reproduzir; os valores possíveis são @code{-1}, @code{MB_ICONASTERISK}, @code{MB_ICONEXCLAMATION}, @code{MB_ICONHAND}, @code{MB_ICONQUESTION} e @code{MB_OK}, todos descritos abaixo. O valor @code{-1} produz um “bipe simples”; este é o fallback final se um som não puder ser reproduzido de outra forma. Se o sistema indicar um erro, @ref{195,,RuntimeError} será levantada.
@end deffn

@geindex SND_FILENAME (no módulo winsound)
@anchor{library/winsound winsound SND_FILENAME}@anchor{4a3d}
@deffn {Dado} winsound.SND_FILENAME

O parâmetro `sound' é o nome de um arquivo WAV. Não use com @ref{4a3e,,SND_ALIAS}.
@end deffn

@geindex SND_ALIAS (no módulo winsound)
@anchor{library/winsound winsound SND_ALIAS}@anchor{4a3e}
@deffn {Dado} winsound.SND_ALIAS

O parâmetro `sound' é um nome de associação de som do registro. Se o registro não contiver tal nome, reproduza o som padrão do sistema, a menos que @ref{4a3f,,SND_NODEFAULT} também seja especificado. Se nenhum som padrão for registrado, levanta @ref{195,,RuntimeError}. Não use com @ref{4a3d,,SND_FILENAME}.

Todos os sistemas Win32 oferecem suporte a pelo menos o seguinte; a maioria dos sistemas oferecem suporte a muito mais:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`name' @ref{d28,,PlaySound()}

@tab

Nome do som correspondente no Painel de Controle

@item

@code{'SystemAsterisk'}

@tab

Asterisco

@item

@code{'SystemExclamation'}

@tab

Exclamação

@item

@code{'SystemExit'}

@tab

Logoff do Windows

@item

@code{'SystemHand'}

@tab

Parada crítica

@item

@code{'SystemQuestion'}

@tab

Pergunta

@end multitable


Por exemplo:

@example
import winsound
# Reproduz o som de logoff do Windows.
winsound.PlaySound("SystemExit", winsound.SND_ALIAS)

# Provavelmente reproduz o som padrão do Windows, se algum
# estiver registrado (porque "*" provavelmente não é o nome registrado
# de algum som).
winsound.PlaySound("*", winsound.SND_ALIAS)
@end example
@end deffn

@geindex SND_LOOP (no módulo winsound)
@anchor{library/winsound winsound SND_LOOP}@anchor{4a40}
@deffn {Dado} winsound.SND_LOOP

Reproduz o som repetidamente. O sinalizador @ref{4a41,,SND_ASYNC} também deve ser usado para evitar bloqueio. Não pode ser usado com @ref{4a42,,SND_MEMORY}.
@end deffn

@geindex SND_MEMORY (no módulo winsound)
@anchor{library/winsound winsound SND_MEMORY}@anchor{4a42}
@deffn {Dado} winsound.SND_MEMORY

O parâmetro `sound' para @ref{d28,,PlaySound()} é uma imagem de memória de um arquivo WAV, como um @ref{d4f,,objeto bytes ou similar}.

@cartouche
@quotation Nota 
Este módulo não oferece suporte à reprodução de uma imagem de memória de forma assíncrona, portanto, uma combinação deste sinalizador e @ref{4a41,,SND_ASYNC} levantará @ref{195,,RuntimeError}.
@end quotation
@end cartouche
@end deffn

@geindex SND_PURGE (no módulo winsound)
@anchor{library/winsound winsound SND_PURGE}@anchor{4a43}
@deffn {Dado} winsound.SND_PURGE

Para de reproduzir todas as instâncias do som especificado.

@cartouche
@quotation Nota 
Não há suporte a este sinalizador em plataformas Windows modernas.
@end quotation
@end cartouche
@end deffn

@geindex SND_ASYNC (no módulo winsound)
@anchor{library/winsound winsound SND_ASYNC}@anchor{4a41}
@deffn {Dado} winsound.SND_ASYNC

Retorna imediatamente, permitindo que os sons sejam reproduzidos de forma assíncrona.
@end deffn

@geindex SND_NODEFAULT (no módulo winsound)
@anchor{library/winsound winsound SND_NODEFAULT}@anchor{4a3f}
@deffn {Dado} winsound.SND_NODEFAULT

Se o som especificado não for encontrado, o som padrão do sistema não será reproduzido.
@end deffn

@geindex SND_NOSTOP (no módulo winsound)
@anchor{library/winsound winsound SND_NOSTOP}@anchor{4a44}
@deffn {Dado} winsound.SND_NOSTOP

Não interrompe os sons que estão sendo reproduzidos.
@end deffn

@geindex SND_NOWAIT (no módulo winsound)
@anchor{library/winsound winsound SND_NOWAIT}@anchor{4a45}
@deffn {Dado} winsound.SND_NOWAIT

Retorna imediatamente se o driver de som estiver ocupado.

@cartouche
@quotation Nota 
Não há suporte a este sinalizador em plataformas Windows modernas.
@end quotation
@end cartouche
@end deffn

@geindex SND_APPLICATION (no módulo winsound)
@anchor{library/winsound winsound SND_APPLICATION}@anchor{4a46}
@deffn {Dado} winsound.SND_APPLICATION

O parâmetro `sound' é um apelido específico da aplicação no registro. Este sinalizador pode ser combinado com o sinalizador @ref{4a3e,,SND_ALIAS} para especificar um apelido de som definido pela aplicação.
@end deffn

@geindex MB_ICONASTERISK (no módulo winsound)
@anchor{library/winsound winsound MB_ICONASTERISK}@anchor{4a47}
@deffn {Dado} winsound.MB_ICONASTERISK

Reproduz o som @code{SystemDefault}.
@end deffn

@geindex MB_ICONEXCLAMATION (no módulo winsound)
@anchor{library/winsound winsound MB_ICONEXCLAMATION}@anchor{4a48}
@deffn {Dado} winsound.MB_ICONEXCLAMATION

Reproduz o som @code{SystemExclamation}.
@end deffn

@geindex MB_ICONHAND (no módulo winsound)
@anchor{library/winsound winsound MB_ICONHAND}@anchor{4a49}
@deffn {Dado} winsound.MB_ICONHAND

Reproduz o som @code{SystemHand}.
@end deffn

@geindex MB_ICONQUESTION (no módulo winsound)
@anchor{library/winsound winsound MB_ICONQUESTION}@anchor{4a4a}
@deffn {Dado} winsound.MB_ICONQUESTION

Reproduz o som @code{SystemQuestion}.
@end deffn

@geindex MB_OK (no módulo winsound)
@anchor{library/winsound winsound MB_OK}@anchor{4a4b}
@deffn {Dado} winsound.MB_OK

Reproduz o som @code{SystemDefault}.
@end deffn

@node Serviços específicos do Unix,Interface de linha de comando CLI de módulos,Serviços Específicos do MS Windows,A Biblioteca Padrão do Python
@anchor{library/unix doc}@anchor{4a4c}@anchor{library/unix translation-repo}@anchor{4a4d}@anchor{library/unix unix}@anchor{4a4e}@anchor{library/unix unix-specific-services}@anchor{4a4f}
@section Serviços específicos do Unix


Os módulos descritos neste capítulo fornecem interfaces para recursos que são exclusivos do sistema operacional Unix ou, em alguns casos, para algumas ou várias variantes do mesmo. Aqui está uma visão geral:

@menu
* shlex — Simple lexical analysis:: 
* posix — As chamadas de sistema mais comuns do POSIX:: 
* pwd — A senha do banco de dados:: 
* grp — O banco de dados de grupos:: 
* termios — Controle de tty no estilo POSIX:: 
* tty — Funções de controle de terminal:: 
* pty — Utilitários de pseudoterminal:: 
* fcntl — as chamadas de sistema fcntl e ioctl:: 
* resource — Informação de uso de recursos:: 
* syslog — Rotinas da biblioteca syslog do Unix:: 

@end menu

@node shlex — Simple lexical analysis,posix — As chamadas de sistema mais comuns do POSIX,,Serviços específicos do Unix
@anchor{library/shlex doc}@anchor{4a50}@anchor{library/shlex module-shlex}@anchor{c4}@anchor{library/shlex shlex-simple-lexical-analysis}@anchor{4a51}
@subsection @code{shlex} — Simple lexical analysis


@geindex module; shlex

`Código-fonte:' Lib/shlex.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/shlex.py}


__________________________________________________________________


The @ref{ced,,shlex} class makes it easy to write lexical analyzers for
simple syntaxes resembling that of the Unix shell.  This will often be useful
for writing minilanguages, (for example, in run control files for Python
applications) or for parsing quoted strings.

The @ref{c4,,shlex} module defines the following functions:

@geindex split() (no módulo shlex)
@anchor{library/shlex shlex split}@anchor{53c}
@deffn {Função} shlex.split (s, comments=False, posix=True)

Split the string `s' using shell-like syntax. If `comments' is @ref{b49,,False}
(the default), the parsing of comments in the given string will be disabled
(setting the @ref{4a52,,commenters} attribute of the
@ref{ced,,shlex} instance to the empty string).  This function operates
in POSIX mode by default, but uses non-POSIX mode if the `posix' argument is
false.


Alterado na versão 3.12: Passing @code{None} for `s' argument now raises an exception, rather than
reading @ref{53d,,sys.stdin}.

@end deffn

@geindex join() (no módulo shlex)
@anchor{library/shlex shlex join}@anchor{a31}
@deffn {Função} shlex.join (split_command)

Concatenate the tokens of the list `split_command' and return a string.
This function is the inverse of @ref{53c,,split()}.

@example
>>> from shlex import join
>>> print(join(['echo', '-n', 'Multiple words']))
echo -n 'Multiple words'
@end example

The returned value is shell-escaped to protect against injection
vulnerabilities (see @ref{27d,,quote()}).


Adicionado na versão 3.8.

@end deffn

@geindex quote() (no módulo shlex)
@anchor{library/shlex shlex quote}@anchor{27d}
@deffn {Função} shlex.quote (s)

Return a shell-escaped version of the string `s'.  The returned value is a
string that can safely be used as one token in a shell command line, for
cases where you cannot use a list.
@anchor{library/shlex shlex-quote-warning}@anchor{340f}
@cartouche
@quotation Aviso 
The @code{shlex} module is `only designed for Unix shells'.

The @ref{27d,,quote()} function is not guaranteed to be correct on non-POSIX
compliant shells or shells from other operating systems such as Windows.
Executing commands quoted by this module on such shells can open up the
possibility of a command injection vulnerability.

Consider using functions that pass command arguments with lists such as
@ref{b9e,,subprocess.run()} with @code{shell=False}.
@end quotation
@end cartouche

Este idioma seria 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{27d,,quote()} lets you plug the security hole:

@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

The quoting is compatible with UNIX shells and with @ref{53c,,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


Adicionado na versão 3.3.

@end deffn

The @ref{c4,,shlex} module defines the following class:

@geindex shlex (classe em shlex)
@anchor{library/shlex shlex shlex}@anchor{ced}
@deffn {Classe} shlex.shlex (instream=None, infile=None, posix=False, punctuation_chars=False)

A @ref{ced,,shlex} instance or subclass instance is a lexical analyzer
object.  The initialization argument, if present, specifies where to read
characters from.  It must be a file-/stream-like object with
@ref{1e0c,,read()} and @ref{1e46,,readline()} methods, or
a string.  If no argument is given, input will be taken from @code{sys.stdin}.
The second optional argument is a filename string, which sets the initial
value of the @ref{4a53,,infile} attribute.  If the `instream'
argument is omitted or equal to @code{sys.stdin}, this second argument
defaults to “stdin”.  The `posix' argument defines the operational mode:
when `posix' is not true (default), the @ref{ced,,shlex} instance will
operate in compatibility mode.  When operating in POSIX mode,
@ref{ced,,shlex} will try to be as close as possible to the POSIX shell
parsing rules.  The `punctuation_chars' argument provides a way to make the
behaviour even closer to how real shells parse.  This can take a number of
values: the default value, @code{False}, preserves the behaviour seen under
Python 3.5 and earlier.  If set to @code{True}, then parsing of the characters
@code{();<>|&} is changed: any run of these characters (considered punctuation
characters) is returned as a single token.  If set to a non-empty string of
characters, those characters will be used as the punctuation characters.  Any
characters in the @ref{4a54,,wordchars} attribute that appear in
`punctuation_chars' will be removed from @ref{4a54,,wordchars}.  See
@ref{cee,,Improved Compatibility with Shells} for more information. `punctuation_chars'
can be set only upon @ref{ced,,shlex} instance creation and can’t be
modified later.


Alterado na versão 3.6: The `punctuation_chars' parameter was added.

@end deffn


@subsubheading Ver também



@table @asis

@item Module @ref{22,,configparser}

Parser for configuration files similar to the Windows @code{.ini} files.
@end table


@menu
* shlex Objects:: 
* Regras de análise:: 
* Improved Compatibility with Shells:: 

@end menu

@node shlex Objects,Regras de análise,,shlex — Simple lexical analysis
@anchor{library/shlex id1}@anchor{4a55}@anchor{library/shlex shlex-objects}@anchor{4a56}
@subsubsection shlex Objects


A @ref{ced,,shlex} instance has the following methods:

@geindex get_token() (método shlex.shlex)
@anchor{library/shlex shlex shlex get_token}@anchor{4a57}
@deffn {Método} shlex.get_token ()

Return a token.  If tokens have been stacked using @ref{4a58,,push_token()}, pop a
token off the stack.  Otherwise, read one from the input stream.  If reading
encounters an immediate end-of-file, @ref{4a59,,eof} is returned (the empty
string (@code{'@w{'}}) in non-POSIX mode, and @code{None} in POSIX mode).
@end deffn

@geindex push_token() (método shlex.shlex)
@anchor{library/shlex shlex shlex push_token}@anchor{4a58}
@deffn {Método} shlex.push_token (str)

Push the argument onto the token stack.
@end deffn

@geindex read_token() (método shlex.shlex)
@anchor{library/shlex shlex shlex read_token}@anchor{4a5a}
@deffn {Método} shlex.read_token ()

Read a raw token.  Ignore the pushback stack, and do not interpret source
requests.  (This is not ordinarily a useful entry point, and is documented here
only for the sake of completeness.)
@end deffn

@geindex sourcehook() (método shlex.shlex)
@anchor{library/shlex shlex shlex sourcehook}@anchor{4a5b}
@deffn {Método} shlex.sourcehook (filename)

When @ref{ced,,shlex} detects a source request (see @ref{4a5c,,source}
below) this method is given the following token as argument, and expected
to return a tuple consisting of a filename and an open file-like object.

Normally, this method first strips any quotes off the argument.  If the result
is an absolute pathname, or there was no previous source request in effect, or
the previous source was a stream (such as @code{sys.stdin}), the result is left
alone.  Otherwise, if the result is a relative pathname, the directory part of
the name of the file immediately before it on the source inclusion stack is
prepended (this behavior is like the way the C preprocessor handles @code{#include
"file.h"}).

The result of the manipulations is treated as a filename, and returned as the
first component of the tuple, with @ref{51c,,open()} called on it to yield the second
component. (Note: this is the reverse of the order of arguments in instance
initialization!)

This hook is exposed so that you can use it to implement directory search paths,
addition of file extensions, and other namespace hacks. There is no
corresponding ‘close’ hook, but a shlex instance will call the
@ref{1f6,,close()} method of the sourced input stream when it returns
EOF.

For more explicit control of source stacking, use the @ref{4a5d,,push_source()} and
@ref{4a5e,,pop_source()} methods.
@end deffn

@geindex push_source() (método shlex.shlex)
@anchor{library/shlex shlex shlex push_source}@anchor{4a5d}
@deffn {Método} shlex.push_source (newstream, newfile=None)

Push an input source stream onto the input stack.  If the filename argument is
specified it will later be available for use in error messages.  This is the
same method used internally by the @ref{4a5b,,sourcehook()} method.
@end deffn

@geindex pop_source() (método shlex.shlex)
@anchor{library/shlex shlex shlex pop_source}@anchor{4a5e}
@deffn {Método} shlex.pop_source ()

Pop the last-pushed input source from the input stack. This is the same method
used internally when the lexer reaches EOF on a stacked input stream.
@end deffn

@geindex error_leader() (método shlex.shlex)
@anchor{library/shlex shlex shlex error_leader}@anchor{4a5f}
@deffn {Método} shlex.error_leader (infile=None, lineno=None)

This method generates an error message leader in the format of a Unix C compiler
error label; the format is @code{'"%s", line %d: '}, where the @code{%s} is replaced
with the name of the current source file and the @code{%d} with the current input
line number (the optional arguments can be used to override these).

This convenience is provided to encourage @ref{c4,,shlex} users to generate error
messages in the standard, parseable format understood by Emacs and other Unix
tools.
@end deffn

Instances of @ref{ced,,shlex} subclasses have some public instance
variables which either control lexical analysis or can be used for debugging:

@geindex commenters (atributo shlex.shlex)
@anchor{library/shlex shlex shlex commenters}@anchor{4a52}
@deffn {Atributo} shlex.commenters

The string of characters that are recognized as comment beginners. All
characters from the comment beginner to end of line are ignored. Includes just
@code{'#'} by default.
@end deffn

@geindex wordchars (atributo shlex.shlex)
@anchor{library/shlex shlex shlex wordchars}@anchor{4a54}
@deffn {Atributo} shlex.wordchars

The string of characters that will accumulate into multi-character tokens.  By
default, includes all ASCII alphanumerics and underscore.  In POSIX mode, the
accented characters in the Latin-1 set are also included.  If
@ref{1b48,,punctuation_chars} is not empty, the characters @code{~-./*?=}, which can
appear in filename specifications and command line parameters, will also be
included in this attribute, and any characters which appear in
@code{punctuation_chars} will be removed from @code{wordchars} if they are present
there. If @ref{4a60,,whitespace_split} is set to @code{True}, this will have no
effect.
@end deffn

@geindex whitespace (atributo shlex.shlex)
@anchor{library/shlex shlex shlex whitespace}@anchor{4a61}
@deffn {Atributo} shlex.whitespace

Characters that will be considered whitespace and skipped.  Whitespace bounds
tokens.  By default, includes space, tab, linefeed and carriage-return.
@end deffn

@geindex escape (atributo shlex.shlex)
@anchor{library/shlex shlex shlex escape}@anchor{4a62}
@deffn {Atributo} shlex.escape

Characters that will be considered as escape. This will be only used in POSIX
mode, and includes just @code{'\'} by default.
@end deffn

@geindex quotes (atributo shlex.shlex)
@anchor{library/shlex shlex shlex quotes}@anchor{4a63}
@deffn {Atributo} shlex.quotes

Characters that will be considered string quotes.  The token accumulates until
the same quote is encountered again (thus, different quote types protect each
other as in the shell.)  By default, includes ASCII single and double quotes.
@end deffn

@geindex escapedquotes (atributo shlex.shlex)
@anchor{library/shlex shlex shlex escapedquotes}@anchor{4a64}
@deffn {Atributo} shlex.escapedquotes

Characters in @ref{4a63,,quotes} that will interpret escape characters defined in
@ref{4a62,,escape}.  This is only used in POSIX mode, and includes just @code{'"'} by
default.
@end deffn

@geindex whitespace_split (atributo shlex.shlex)
@anchor{library/shlex shlex shlex whitespace_split}@anchor{4a60}
@deffn {Atributo} shlex.whitespace_split

If @code{True}, tokens will only be split in whitespaces.  This is useful, for
example, for parsing command lines with @ref{ced,,shlex}, getting
tokens in a similar way to shell arguments.  When used in combination with
@ref{1b48,,punctuation_chars}, tokens will be split on whitespace in addition to
those characters.


Alterado na versão 3.8: The @ref{1b48,,punctuation_chars} attribute was made compatible with the
@ref{4a60,,whitespace_split} attribute.

@end deffn

@geindex infile (atributo shlex.shlex)
@anchor{library/shlex shlex shlex infile}@anchor{4a53}
@deffn {Atributo} shlex.infile

The name of the current input file, as initially set at class instantiation time
or stacked by later source requests.  It may be useful to examine this when
constructing error messages.
@end deffn

@geindex instream (atributo shlex.shlex)
@anchor{library/shlex shlex shlex instream}@anchor{4a65}
@deffn {Atributo} shlex.instream

The input stream from which this @ref{ced,,shlex} instance is reading
characters.
@end deffn

@geindex source (atributo shlex.shlex)
@anchor{library/shlex shlex shlex source}@anchor{4a5c}
@deffn {Atributo} shlex.source

This attribute is @code{None} by default.  If you assign a string to it, that
string will be recognized as a lexical-level inclusion request similar to the
@code{source} keyword in various shells.  That is, the immediately following token
will be opened as a filename and input will be taken from that stream until
EOF, at which point the @ref{1f6,,close()} method of that stream will be
called and the input source will again become the original input stream.  Source
requests may be stacked any number of levels deep.
@end deffn

@geindex debug (atributo shlex.shlex)
@anchor{library/shlex shlex shlex debug}@anchor{4a66}
@deffn {Atributo} shlex.debug

If this attribute is numeric and @code{1} or more, a @ref{ced,,shlex}
instance will print verbose progress output on its behavior.  If you need
to use this, you can read the module source code to learn the details.
@end deffn

@geindex lineno (atributo shlex.shlex)
@anchor{library/shlex shlex shlex lineno}@anchor{4a67}
@deffn {Atributo} shlex.lineno

Source line number (count of newlines seen so far plus one).
@end deffn

@geindex token (atributo shlex.shlex)
@anchor{library/shlex shlex shlex token}@anchor{4a68}
@deffn {Atributo} shlex.token

The token buffer.  It may be useful to examine this when catching exceptions.
@end deffn

@geindex eof (atributo shlex.shlex)
@anchor{library/shlex shlex shlex eof}@anchor{4a59}
@deffn {Atributo} shlex.eof

Token used to determine end of file. This will be set to the empty string
(@code{'@w{'}}), in non-POSIX mode, and to @code{None} in POSIX mode.
@end deffn

@geindex punctuation_chars (atributo shlex.shlex)
@anchor{library/shlex shlex shlex punctuation_chars}@anchor{1b48}
@deffn {Atributo} shlex.punctuation_chars

A read-only property. Characters that will be considered punctuation. Runs of
punctuation characters will be returned as a single token. However, note that no
semantic validity checking will be performed: for example, ‘>>>’ could be
returned as a token, even though it may not be recognised as such by shells.


Adicionado na versão 3.6.

@end deffn

@node Regras de análise,Improved Compatibility with Shells,shlex Objects,shlex — Simple lexical analysis
@anchor{library/shlex parsing-rules}@anchor{4a69}@anchor{library/shlex shlex-parsing-rules}@anchor{4a6a}
@subsubsection Regras de análise


When operating in non-POSIX mode, @ref{ced,,shlex} will try to obey to the
following rules.


@itemize *

@item 
Quote characters are not recognized within words (@code{Do"Not"Separate} is
parsed as the single word @code{Do"Not"Separate});

@item 
Escape characters are not recognized;

@item 
Enclosing characters in quotes preserve the literal value of all characters
within the quotes;

@item 
Closing quotes separate words (@code{"Do"Separate} is parsed as @code{"Do"} and
@code{Separate});

@item 
If @ref{4a60,,whitespace_split} is @code{False}, any character not
declared to be a word character, whitespace, or a quote will be returned as
a single-character token. If it is @code{True}, @ref{ced,,shlex} will only
split words in whitespaces;

@item 
EOF is signaled with an empty string (@code{'@w{'}});

@item 
It’s not possible to parse empty strings, even if quoted.
@end itemize

When operating in POSIX mode, @ref{ced,,shlex} will try to obey to the
following parsing rules.


@itemize *

@item 
Quotes are stripped out, and do not separate words (@code{"Do"Not"Separate"} is
parsed as the single word @code{DoNotSeparate});

@item 
Non-quoted escape characters (e.g. @code{'\'}) preserve the literal value of the
next character that follows;

@item 
Enclosing characters in quotes which are not part of
@ref{4a64,,escapedquotes} (e.g. @code{"'"}) preserve the literal value
of all characters within the quotes;

@item 
Enclosing characters in quotes which are part of
@ref{4a64,,escapedquotes} (e.g. @code{'"'}) preserves the literal value
of all characters within the quotes, with the exception of the characters
mentioned in @ref{4a62,,escape}.  The escape characters retain its
special meaning only when followed by the quote in use, or the escape
character itself. Otherwise the escape character will be considered a
normal character.

@item 
EOF is signaled with a @ref{675,,None} value;

@item 
Quoted empty strings (@code{'@w{'}}) are allowed.
@end itemize

@node Improved Compatibility with Shells,,Regras de análise,shlex — Simple lexical analysis
@anchor{library/shlex improved-compatibility-with-shells}@anchor{4a6b}@anchor{library/shlex improved-shell-compatibility}@anchor{cee}
@subsubsection Improved Compatibility with Shells



Adicionado na versão 3.6.


The @ref{c4,,shlex} class provides compatibility with the parsing performed by
common Unix shells like @code{bash}, @code{dash}, and @code{sh}.  To take advantage of
this compatibility, specify the @code{punctuation_chars} argument in the
constructor.  This defaults to @code{False}, which preserves pre-3.6 behaviour.
However, if it is set to @code{True}, then parsing of the characters @code{();<>|&}
is changed: any run of these characters is returned as a single token.  While
this is short of a full parser for shells (which would be out of scope for the
standard library, given the multiplicity of shells out there), it does allow
you to perform processing of command lines more easily than you could
otherwise.  To illustrate, you can see the difference in the following snippet:

@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

Of course, tokens will be returned which are not valid for shells, and you’ll
need to implement your own error checks on the returned tokens.

Instead of passing @code{True} as the value for the punctuation_chars parameter,
you can pass a string with specific characters, which will be used to determine
which characters constitute punctuation. For example:

@example
>>> import shlex
>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
>>> list(s)
['a', '&', '&', 'b', '||', 'c']
@end example

@cartouche
@quotation Nota 
When @code{punctuation_chars} is specified, the @ref{4a54,,wordchars}
attribute is augmented with the characters @code{~-./*?=}.  That is because these
characters can appear in file names (including wildcards) and command-line
arguments (e.g. @code{--color=auto}). Hence:

@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

However, to match the shell as closely as possible, it is recommended to
always use @code{posix} and @ref{4a60,,whitespace_split} when using
@ref{1b48,,punctuation_chars}, which will negate
@ref{4a54,,wordchars} entirely.
@end quotation
@end cartouche

For best effect, @code{punctuation_chars} should be set in conjunction with
@code{posix=True}. (Note that @code{posix=False} is the default for
@ref{ced,,shlex}.)

@node posix — As chamadas de sistema mais comuns do POSIX,pwd — A senha do banco de dados,shlex — Simple lexical analysis,Serviços específicos do Unix
@anchor{library/posix doc}@anchor{4a6c}@anchor{library/posix module-posix}@anchor{ad}@anchor{library/posix posix-the-most-common-posix-system-calls}@anchor{4a6d}@anchor{library/posix translation-repo}@anchor{4a6e}
@subsection @code{posix} — As chamadas de sistema mais comuns do POSIX


@geindex module; posix


__________________________________________________________________


Este módulo fornece acesso à funcionalidade do sistema operacional padronizada pelo padrão C e pelo padrão POSIX (uma interface Unix levemente disfarçada).

@ref{1ed8,,Disponibilidade}: Unix.

@geindex módulo;os

`Não importe este módulo diretamente.' Em vez disso, importe o módulo @ref{a1,,os}, que fornece uma versão `portátil' dessa interface. No Unix, o módulo @ref{a1,,os} fornece um superconjunto da interface @ref{ad,,posix}. Em sistemas operacionais não Unix, o módulo @ref{ad,,posix} não está disponível, mas um subconjunto está sempre disponível na interface @ref{a1,,os}. Uma vez que @ref{a1,,os} é importado, seu uso `não' causa penalidade de desempenho em comparação com @ref{ad,,posix}. Além disso, @ref{a1,,os} fornece algumas funcionalidades adicionais, como chamar automaticamente @ref{922,,putenv()} quando uma entrada em @code{os.environ} é alterada.

Erros são relatados como exceções. As exceções usuais são dadas para erros de tipo, enquanto os erros relatados pelas chamadas do sistema levantam @ref{417,,OSError}.

@menu
* Suporte a arquivos grandes:: 
* Conteúdo notável do módulo:: 

@end menu

@node Suporte a arquivos grandes,Conteúdo notável do módulo,,posix — As chamadas de sistema mais comuns do POSIX
@anchor{library/posix large-file-support}@anchor{4a6f}@anchor{library/posix posix-large-files}@anchor{4a70}
@subsubsection Suporte a arquivos grandes


@geindex arquivos grandes
@geindex arquivo;arquivos grandes

Vários sistemas operacionais (incluindo AIX e Solaris) fornecem suporte a arquivos maiores que 2 GiB a partir de um modelo de programação C em que int e long são valores de 32 bits. Isso geralmente é realizado definindo o tamanho relevante e os tipos de deslocamento como valores de 64 bits. Esses arquivos às vezes são chamados de `arquivos grandes'.

O suporte a arquivos grandes é ativado no Python quando o tamanho de um @code{off_t} é maior que a long e long long é pelo menos tão grande quanto um @code{off_t}. Pode ser necessário configurar e compilar o Python com certos sinalizadores do compilador para ativar esse modo. Por exemplo, com o Solaris 2.6 e 2.7, você precisa fazer algo como:

@example
CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

Em sistemas Linux com capacidade para arquivos grandes, isso pode funcionar:

@example
CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

@node Conteúdo notável do módulo,,Suporte a arquivos grandes,posix — As chamadas de sistema mais comuns do POSIX
@anchor{library/posix notable-module-contents}@anchor{4a71}@anchor{library/posix posix-contents}@anchor{4a72}
@subsubsection Conteúdo notável do módulo


Além de muitas funções descritas na documentação do módulo @ref{a1,,os}, @ref{ad,,posix} define o seguinte item de dados:

@geindex environ (no módulo posix)
@anchor{library/posix posix environ}@anchor{4a73}
@deffn {Dado} posix.environ

Um dicionário que representa o ambiente de strings no momento em que o interpretador foi iniciado. Chaves e valores são bytes no Unix e str no Windows. Por exemplo, @code{environ[b'HOME']} (@code{environ['HOME']} no Windows) é o nome do caminho do diretório inicial, equivalente a @code{getenv("HOME")} em C .

A modificação deste dicionário não afeta o ambiente de strings passado por @ref{2cf9,,execv()}, @ref{a91,,popen()} ou @ref{14a5,,system()}. Se você precisar alterar o ambiente, passe @code{environ} para @ref{1138,,execve()} ou adicione atribuições de variável e instruções de exportação para a string de comando para @ref{14a5,,system()} ou @ref{a91,,popen()}.


Alterado na versão 3.2: No Unix, chaves e valores são bytes.


@cartouche
@quotation Nota 
O módulo @ref{a1,,os} fornece uma implementação alternativa de @code{environ} que atualiza o ambiente ao ocorrerem modificações. Observe também que a atualização de @ref{11f9,,os.environ} tornará este dicionário obsoleto. O uso do módulo @ref{a1,,os} é recomendado sobre o acesso direto ao módulo @ref{ad,,posix}.
@end quotation
@end cartouche
@end deffn

@node pwd — A senha do banco de dados,grp — O banco de dados de grupos,posix — As chamadas de sistema mais comuns do POSIX,Serviços específicos do Unix
@anchor{library/pwd doc}@anchor{4a74}@anchor{library/pwd module-pwd}@anchor{b2}@anchor{library/pwd pwd-the-password-database}@anchor{4a75}@anchor{library/pwd translation-repo}@anchor{4a76}
@subsection @code{pwd} — A senha do banco de dados


@geindex module; pwd


__________________________________________________________________


Este módulo provê acesso ao banco de dados das contas de usuário do sistema e suas respectivas senhas. Isto está disponível para todas as versões do Unix.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not iOS.

As entradas do banco de dados de senhas são reportadas como um objeto do tipo tupla, cujos atributos correspondem aos membros da estrutura @code{passwd} (Campos dos atributos abaixo, veja @code{<pwd.h>}):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Atributo

@tab

Significado

@item

0

@tab

@code{pw_name}

@tab

Nome de login

@item

1

@tab

@code{pw_passwd}

@tab

Senha encriptada opcional

@item

2

@tab

@code{pw_uid}

@tab

ID numérico do usuário

@item

3

@tab

@code{pw_gid}

@tab

ID numérico do grupo

@item

4

@tab

@code{pw_gecos}

@tab

Nome do usuário ou campo de comentário

@item

5

@tab

@code{pw_dir}

@tab

Diretório home do usuário

@item

6

@tab

@code{pw_shell}

@tab

Interpretador de comandos do usuário

@end multitable


O uid e o gid são números inteiros, e os outros são strings. @ref{344,,KeyError} é levando se o campo requerido não puder ser encontrado.

@cartouche
@quotation Nota 
Em Unix tradicional, o campo @code{pw_passwd} geralmente contém uma senha encriptada com um algoritmo derivado de DES. No entanto, a maioria dos sistemas tipo Unix modernos usam o chamado sistema `shadow password'. Nesses Unixes o campo `pw_passwd' só contém um asterisco (@code{'*'}) ou a letra @code{'x'} e a senha encriptada é guardada no arquivo @code{/etc/shadow} o qual não é permitido o acesso irrestrito a leitura. Se o campo `pw_passwd' contém alguma coisa útil dependerá do sistema.
@end quotation
@end cartouche

Isto define os seguintes itens

@geindex getpwuid() (no módulo pwd)
@anchor{library/pwd pwd getpwuid}@anchor{1ba8}
@deffn {Função} pwd.getpwuid (uid)

Retorna a entrada do banco de dados de senhas para um dado ID de usuário
@end deffn

@geindex getpwnam() (no módulo pwd)
@anchor{library/pwd pwd getpwnam}@anchor{33ff}
@deffn {Função} pwd.getpwnam (name)

Retorna a entrada do banco de dados de senhas para um dado nome de usuário
@end deffn

@geindex getpwall() (no módulo pwd)
@anchor{library/pwd pwd getpwall}@anchor{4a77}
@deffn {Função} pwd.getpwall ()

Retorna uma lista de todos as entradas disponíveis no banco de dados de senhas, em uma ordem arbitrária.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{66,,grp}

Uma interface para o banco de dados do grupo, similar a esta.
@end table


@node grp — O banco de dados de grupos,termios — Controle de tty no estilo POSIX,pwd — A senha do banco de dados,Serviços específicos do Unix
@anchor{library/grp doc}@anchor{4a78}@anchor{library/grp grp-the-group-database}@anchor{4a79}@anchor{library/grp module-grp}@anchor{66}@anchor{library/grp translation-repo}@anchor{4a7a}
@subsection @code{grp} — O banco de dados de grupos


@geindex module; grp


__________________________________________________________________


Este módulo fornece acesso ao banco de dados de grupos Unix. Ele está disponível em todas as versões do Unix.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not Android, not iOS.

As entradas do banco de dados de grupos são relatadas como um objeto tupla ou similar, cujos atributos correspondem aos membros da estrutura @code{group} (campo Atributo abaixo, consulte @code{<grp.h>}):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Atributo

@tab

Significado

@item

0

@tab

gr_name

@tab

o nome do grupo

@item

1

@tab

gr_passwd

@tab

a senha do grupo (criptografada); geralmente vazia

@item

2

@tab

gr_gid

@tab

O ID numérico do grupo

@item

3

@tab

gr_mem

@tab

todos os nomes de usuários dos membros do grupo

@end multitable


O gid é um inteiro, nome e senha são strings, e a lista de membros é uma lista de strings. (Observe que a maioria dos usuários não são listados explicitamente como membros do grupo em que estão, de acordo com o banco de dados de senhas. Verifique ambos os bancos de dados para obter informações completas sobre associação. Observe também que um @code{gr_name} que começa com @code{+} ou @code{-} provavelmente é uma referência YP/NIS e pode não ser acessível via @ref{33fe,,getgrnam()} ou @ref{d48,,getgrgid()}.)

Isto define os seguintes itens

@geindex getgrgid() (no módulo grp)
@anchor{library/grp grp getgrgid}@anchor{d48}
@deffn {Função} grp.getgrgid (id)

Retorna a entrada do banco de dados de grupos para o ID do grupo numérico fornecido. @ref{344,,KeyError} é levantada se a entrada solicitada não puder ser encontrada.


Alterado na versão 3.10: @ref{2c3,,TypeError} é levantada para argumentos não inteiros, como pontos flutuantes ou strings.

@end deffn

@geindex getgrnam() (no módulo grp)
@anchor{library/grp grp getgrnam}@anchor{33fe}
@deffn {Função} grp.getgrnam (name)

Retorna a entrada do banco de dados de grupos para o nome do grupo fornecido. @ref{344,,KeyError} é levantada se a entrada solicitada não puder ser encontrada.
@end deffn

@geindex getgrall() (no módulo grp)
@anchor{library/grp grp getgrall}@anchor{167e}
@deffn {Função} grp.getgrall ()

Retorna uma lista de todas as entradas de grupo disponíveis, em ordem arbitrária.
@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{b2,,pwd}

Uma interface para o banco de dados de usuários, semelhante a esta.
@end table


@node termios — Controle de tty no estilo POSIX,tty — Funções de controle de terminal,grp — O banco de dados de grupos,Serviços específicos do Unix
@anchor{library/termios doc}@anchor{4a7b}@anchor{library/termios module-termios}@anchor{e1}@anchor{library/termios termios-posix-style-tty-control}@anchor{4a7c}@anchor{library/termios translation-repo}@anchor{4a7d}
@subsection @code{termios} — Controle de tty no estilo POSIX


@geindex module; termios

@geindex POSIX;controle de E/S
@geindex tty;controle de E/S


__________________________________________________________________


Este módulo fornece uma interface para as chamadas POSIX para controle de E/S do tty. Para uma descrição completa dessas chamadas, consulte a página de manual Unix @code{termios(3)@footnote{https://manpages.debian.org/termios(3)}}. Está disponível apenas para as versões Unix que tenham suporte ao controle de E/S de tty no estilo POSIX do `termios' configurado durante a instalação.

@ref{1ed8,,Disponibilidade}: Unix.

Todas as funções neste módulo usam um descritor de arquivo `fd' como seu primeiro argumento. Pode ser um descritor de arquivo de tipo inteiro, como retornado por @code{sys.stdin.fileno()}, ou um @ref{1203,,objeto arquivo}, como o próprio @code{sys.stdin}.

Este módulo também define todas as constantes necessárias para trabalhar com as funções fornecidas aqui; estes têm o mesmo nome de seus equivalentes em C. Consulte a documentação do sistema para mais informações sobre o uso dessas interfaces de controle de terminal.

O módulo define as seguintes funções:

@geindex tcgetattr() (no módulo termios)
@anchor{library/termios termios tcgetattr}@anchor{176c}
@deffn {Função} termios.tcgetattr (fd)

Retorna uma lista contendo os atributos tty para o descritor de arquivo `fd', da seguinte forma: @code{[iflag, oflag, cflag, lflag, ispeed, ospeed, cc]} onde `cc' é uma lista dos caracteres especiais do tty (cada uma string de comprimento 1, exceto os itens com índices @code{VMIN} e @code{VTIME}, que são números inteiros quando esses campos são definidos). A interpretação dos sinalizadores e as velocidades, bem como a indexação no vetor `cc', devem ser feitas usando as constantes simbólicas definidas no módulo @ref{e1,,termios}.
@end deffn

@geindex tcsetattr() (no módulo termios)
@anchor{library/termios termios tcsetattr}@anchor{17eb}
@deffn {Função} termios.tcsetattr (fd, when, attributes)

Define os atributos do tty para descritor de arquivo `fd' a partir de `attributes', que é uma lista como a retornada por @ref{176c,,tcgetattr()}. O argumento `when' determina quando os atributos são alterados:

@geindex TCSANOW (no módulo termios)
@anchor{library/termios termios TCSANOW}@anchor{4a7e}
@deffn {Dado} termios.TCSANOW

Altera os atributos imediatamente.
@end deffn

@geindex TCSADRAIN (no módulo termios)
@anchor{library/termios termios TCSADRAIN}@anchor{4a7f}
@deffn {Dado} termios.TCSADRAIN

Altera os atributos depois de transmitir todas as saídas enfileiradas.
@end deffn

@geindex TCSAFLUSH (no módulo termios)
@anchor{library/termios termios TCSAFLUSH}@anchor{4a80}
@deffn {Dado} termios.TCSAFLUSH

Altera os atributos depois de transmitir todas as saídas enfileiradas e descartar todas as entradas enfileiradas.
@end deffn
@end deffn

@geindex tcsendbreak() (no módulo termios)
@anchor{library/termios termios tcsendbreak}@anchor{4a81}
@deffn {Função} termios.tcsendbreak (fd, duration)

Envia uma quebra no descritor de arquivo `fd'. Uma duração zero, representada por `duration', envia uma pausa por 0,25 a 0,5 segundos; `duration' com valor diferente de zero tem um significado dependente do sistema.
@end deffn

@geindex tcdrain() (no módulo termios)
@anchor{library/termios termios tcdrain}@anchor{4a82}
@deffn {Função} termios.tcdrain (fd)

Aguarda até que toda a saída escrita no descritor de arquivo `fd' seja transmitida.
@end deffn

@geindex tcflush() (no módulo termios)
@anchor{library/termios termios tcflush}@anchor{4a83}
@deffn {Função} termios.tcflush (fd, queue)

Descarta dados na fila no descritor de arquivo `fd'. O seletor `queue' especifica qual fila: @code{TCIFLUSH} para a fila de entrada, @code{TCOFLUSH} para a fila de saída ou @code{TCIOFLUSH} para as duas filas.
@end deffn

@geindex tcflow() (no módulo termios)
@anchor{library/termios termios tcflow}@anchor{4a84}
@deffn {Função} termios.tcflow (fd, action)

Suspende ou retoma a entrada ou saída no descritor de arquivo `fd'. O argumento `action' pode ser @code{TCOOFF} para suspender a saída, @code{TCOON} para reiniciar a saída, @code{TCIOFF} para suspender a entrada ou @code{TCION} para reiniciar a entrada.
@end deffn

@geindex tcgetwinsize() (no módulo termios)
@anchor{library/termios termios tcgetwinsize}@anchor{4a85}
@deffn {Função} termios.tcgetwinsize (fd)

Retorna uma tupla @code{(ws_row, ws_col)} contendo o tamanho da janela de terminal para o descritor de arquivo `fd'. Requer @code{termios.TIOCGWINSZ} ou @code{termios.TIOCGSIZE}.


Adicionado na versão 3.11.

@end deffn

@geindex tcsetwinsize() (no módulo termios)
@anchor{library/termios termios tcsetwinsize}@anchor{4a86}
@deffn {Função} termios.tcsetwinsize (fd, winsize)

Define o tamanho da janela de terminal para o descritor de arquivo `fd' de `winsize', que é uma tupla de dois elementos @code{(ws_row, ws_col)} como a retornada por @ref{4a85,,tcgetwinsize()}. Requer pelo menos um dos pares (@code{termios.TIOCGWINSZ}, @code{termios.TIOCSWINSZ}); (@code{termios.TIOCGSIZE}, @code{termios.TIOCSSIZE}) a ser definido.


Adicionado na versão 3.11.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{100,,tty}

Funções de conveniência para operações comuns de controle de terminal.
@end table


@menu
* Exemplo: Exemplo<15>. 

@end menu

@node Exemplo<15>,,,termios — Controle de tty no estilo POSIX
@anchor{library/termios example}@anchor{4a87}@anchor{library/termios termios-example}@anchor{4a88}
@subsubsection Exemplo


Aqui está uma função que solicita uma senha com o eco desativado. Observe a técnica usando uma chamada separada @ref{176c,,tcgetattr()} e uma instrução @ref{6e9,,try} … @ref{9d2,,finally} para garantir que os atributos tty antigos sejam restaurados exatamente, aconteça o que acontecer:

@example
def getpass(prompt="Senha: "):
    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 — Funções de controle de terminal,pty — Utilitários de pseudoterminal,termios — Controle de tty no estilo POSIX,Serviços específicos do Unix
@anchor{library/tty doc}@anchor{4a89}@anchor{library/tty module-tty}@anchor{100}@anchor{library/tty translation-repo}@anchor{4a8a}@anchor{library/tty tty-terminal-control-functions}@anchor{4a8b}
@subsection @code{tty} — Funções de controle de terminal


@geindex module; tty

`Código-fonte:' Lib/tty.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/tty.py}


__________________________________________________________________


O módulo @ref{100,,tty} define funções para colocar o tty nos modos de cbreak e não tratados (raw).

@ref{1ed8,,Disponibilidade}: Unix.

Por requerer o módulo @ref{e1,,termios}, ele funcionará apenas no Unix.

O módulo @ref{100,,tty} define as seguintes funções:

@geindex cfmakeraw() (no módulo tty)
@anchor{library/tty tty cfmakeraw}@anchor{17bf}
@deffn {Função} tty.cfmakeraw (mode)

Converte a lista de atributos de tty `mode', que é uma lista como a retornada por @ref{176c,,termios.tcgetattr()}, para a de um tty em modo raw.


Adicionado na versão 3.12.

@end deffn

@geindex cfmakecbreak() (no módulo tty)
@anchor{library/tty tty cfmakecbreak}@anchor{176f}
@deffn {Função} tty.cfmakecbreak (mode)

Converte a lista de atributos de tty `mode', que é uma lista como a retornada por @ref{176c,,termios.tcgetattr()}, para a de um tty em modo cbreak.

Isto limpa os sinalizadores de modo local @code{ECHO} e @code{ICANON} em `mode' bem como configura a entrada mínima para 1 byte sem atraso.


Adicionado na versão 3.12.



Alterado na versão 3.12.2: O sinalizador @code{ICRNL} não está mais limpo. Isso corresponde ao comportamento @code{stty cbreak} do Linux e macOS e ao que @ref{176e,,setcbreak()} historicamente fez.

@end deffn

@geindex setraw() (no módulo tty)
@anchor{library/tty tty setraw}@anchor{17be}
@deffn {Função} tty.setraw (fd, when=termios.TCSAFLUSH)

Altera o modo do descritor de arquivo `fd' para raw. Se `when' for omitido, o padrão é @ref{4a80,,termios.TCSAFLUSH}, e é passado para @ref{17eb,,termios.tcsetattr()}. O retorna valor de @ref{176c,,termios.tcgetattr()} é salvo antes de definir `fd' para o modo raw; esse valor é retornado.


Alterado na versão 3.12: O valor de retorno agora é o atributos originais do tty, em vez de @code{None}.

@end deffn

@geindex setcbreak() (no módulo tty)
@anchor{library/tty tty setcbreak}@anchor{176e}
@deffn {Função} tty.setcbreak (fd, when=termios.TCSAFLUSH)

Altera o modo de descritor de arquivo `fd' para cbreak. Se `when' for omitido, o padrão é @ref{4a80,,termios.TCSAFLUSH}, e é passado para @ref{17eb,,termios.tcsetattr()}. O retorna valor de @ref{176c,,termios.tcgetattr()} é salvo antes de definir `fd' para o modo cbreak; esse valor é retornado.

Isto limpa os sinalizadores de modo local @code{ECHO} e @code{ICANON} bem como configura a entrada mínima para 1 byte sem atraso.


Alterado na versão 3.12: O valor de retorno agora é o atributos originais do tty, em vez de @code{None}.



Alterado na versão 3.12.2: O sinalizador @code{ICRNL} não está mais limpo. Isso restaura o comportamento do Python 3.11 e anteriores, além de corresponder ao que Linux, macOS e BSDs descrevem em suas páginas de manual @code{stty(1)} em relação ao modo cbreak.

@end deffn


@subsubheading Ver também



@table @asis

@item Módulo @ref{e1,,termios}

Interface baixo nível para controle de terminal.
@end table


@node pty — Utilitários de pseudoterminal,fcntl — as chamadas de sistema fcntl e ioctl,tty — Funções de controle de terminal,Serviços específicos do Unix
@anchor{library/pty doc}@anchor{4a8c}@anchor{library/pty module-pty}@anchor{b1}@anchor{library/pty pty-pseudo-terminal-utilities}@anchor{4a8d}@anchor{library/pty translation-repo}@anchor{4a8e}
@subsection @code{pty} — Utilitários de pseudoterminal


@geindex module; pty

`Código-fonte:' Lib/pty.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/pty.py}


__________________________________________________________________


O módulo @ref{b1,,pty} define operações para lidar com o conceito de pseudoterminal: iniciar outro processo e poder gravar e ler de seu terminal de controle programaticamente.

@ref{1ed8,,Disponibilidade}: Unix.

O tratamento do pseudoterminal é altamente dependente da plataforma. Esse código foi testado principalmente no Linux, no FreeBSD e no macOS (supõe-se que funcione em outras plataformas POSIX, mas não foi testado exaustivamente).

O módulo @ref{b1,,pty} define as seguintes funções:

@geindex fork() (no módulo pty)
@anchor{library/pty pty fork}@anchor{1851}
@deffn {Função} pty.fork ()

Faz um fork. Conecta o terminal de controle do filho a um pseudoterminal. O valor de retorno é @code{(pid, fd)}. Observe que a criança recebe `pid' 0 e o `fd' é `inválido'. O valor de retorno do pai é o `pid' do filho, e o `fd' é um descritor de arquivo conectado ao terminal de controle do filho (e também à entrada e à saída padrão do filho).

@cartouche
@quotation Aviso 
No macOS, o uso desta função é inseguro quando combinado com o uso de APIs de sistema de nível mais alto, e isso inclui o uso de @ref{10b,,urllib.request}.
@end quotation
@end cartouche
@end deffn

@geindex openpty() (no módulo pty)
@anchor{library/pty pty openpty}@anchor{2ce}
@deffn {Função} pty.openpty ()

Abre um novo par de pseudoterminais, usando @ref{2d3b,,os.openpty()}, se possível, ou código de emulação para sistemas genérico Unix . Retorna um par de descritores de arquivo @code{(master, slave)}, para a extremidade mestre e escrava, respectivamente.
@end deffn

@geindex spawn() (no módulo pty)
@anchor{library/pty pty spawn}@anchor{fb6}
@deffn {Função} pty.spawn (argv[, master_read[, stdin_read]])

Gera um processo e conecta seu terminal de controle com o E/S padrão do processo atual. Isso é frequentemente usado para confundir programas que insistem em ler no terminal de controle. Espera-se que o processo gerado por trás do pty acabe sendo encerrado e, quando isso acontecer, o `spawn' é retornado.

Um laço copia o STDIN do processo atual para o filho e os dados recebidos do filho para o STDOUT do site processar atual. Não é sinalizado para o filho se o STDIN do processar atual fechar.

As funções `master_read' e o `stdin_read' recebem um descritor de arquivo do qual devem ler e devem sempre retorna uma string de bytes. Para forçar `spawn' retornar antes que o processo filho saia, um byte vazio vetor deve ser retornado para sinalizar o fim do arquivo.

A implementação padrão para ambos os funções vai ler e retornar até 1024 bytes cada vez que a função for chamada. A função de retorno `master_read' é passada para o descritor de arquivo mestre do pseudoterminal para ler a saída do processo filho, e ao `stdin_read' é passado o descritor de arquivo 0, para ler a entrada padrão do processo pai.

Retornar uma string de bytes vazia de qualquer uma das funções de retorno é interpretado como uma condição de fim de vida (EOF), e que a função de retorno não será chamada depois disso. Se `stdin_read' sinalizar EOF, o terminal de controle não poderá mais se comunicar com o processo pai OU o processo filho. A menos que o filho processar seja encerrado sem nenhuma entrada, `spawn' vai então fazer o laço para sempre. Se `master_read' sinalizar EOF, os mesmos comportamento resultados (pelo menos no Linux).

Retorna o valor de status de saída de @ref{dc2,,os.waitpid()} no processo filho.

@ref{923,,os.waitstatus_to_exitcode()} pode ser usado para converter o status de saída em um código de saída.

Levanta um @ref{19fa,,evento de auditoria} @code{pty.spawn} com o argumento @code{argv}.


Alterado na versão 3.4: @ref{fb6,,spawn()} agora retorna o valor de status de @ref{dc2,,os.waitpid()} no processo filho.

@end deffn

@menu
* Exemplo: Exemplo<16>. 

@end menu

@node Exemplo<16>,,,pty — Utilitários de pseudoterminal
@anchor{library/pty example}@anchor{4a8f}
@subsubsection Exemplo


O programa a seguir funciona como o comando Unix @code{script(1)@footnote{https://manpages.debian.org/script(1)}} , usando um pseudoterminal para registrar todas as entradas e saídas de uma sessão de terminal em um “script”.

@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 — as chamadas de sistema fcntl e ioctl,resource — Informação de uso de recursos,pty — Utilitários de pseudoterminal,Serviços específicos do Unix
@anchor{library/fcntl doc}@anchor{4a90}@anchor{library/fcntl fcntl-the-fcntl-and-ioctl-system-calls}@anchor{4a91}@anchor{library/fcntl module-fcntl}@anchor{59}@anchor{library/fcntl translation-repo}@anchor{4a92}
@subsection @code{fcntl} — as chamadas de sistema @code{fcntl} e @code{ioctl}


@geindex module; fcntl

@geindex UNIX;controle de arquivo
@geindex UNIX;controle de E/S


__________________________________________________________________


Este módulo executa o controle de arquivos e de E/S em descritores de arquivos. É uma interface para as rotinas @code{fcntl()} e @code{ioctl()} do Unix. Veja as páginas de manual do Unix  @code{fcntl(2)@footnote{https://manpages.debian.org/fcntl(2)}} e @code{ioctl(2)@footnote{https://manpages.debian.org/ioctl(2)}} para mais detalhes.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

Todas as funções neste módulo recebem um descritor de arquivo `fd' como seu primeiro argumento. Este pode ser um descritor de arquivo inteiro, como retornado por @code{sys.stdin.fileno()}, ou um objeto @ref{1f5,,io.IOBase}, como o próprio @code{sys.stdin}, que fornece um @ref{15d0,,fileno()} que retorna um descritor de arquivo genuíno.


Alterado na versão 3.3: As operações neste módulo costumavam levantar um @ref{108b,,IOError}, mas agora levantam um @ref{417,,OSError}.



Alterado na versão 3.8: O módulo @code{fcntl} agora contém constantes @code{F_ADD_SEALS}, @code{F_GET_SEALS} e @code{F_SEAL_*} para selar descritores de arquivo @ref{a13,,os.memfd_create()}.



Alterado na versão 3.9: No macOS, o módulo @code{fcntl} expõe a constante @code{F_GETPATH}, que obtém o caminho de um arquivo de um descritor de arquivo. No Linux(>=3.15), o módulo @code{fcntl} expõe as constantes @code{F_OFD_GETLK}, @code{F_OFD_SETLK} e @code{F_OFD_SETLKW}, que são usadas ao trabalhar com travas de descrição de arquivo aberto.



Alterado na versão 3.10: No Linux >= 2.6.11, o módulo @code{fcntl} expõe as constantes @code{F_GETPIPE_SZ} e @code{F_SETPIPE_SZ}, que permitem verificar e modificar o tamanho de um encadeamento, respectivamente.



Alterado na versão 3.11: No FreeBSD, o módulo @code{fcntl} expõe as constantes @code{F_DUP2FD} e @code{F_DUP2FD_CLOEXEC}, que permitem duplicar um descritor de arquivo, sendo que esta última define também o sinalizador @code{FD_CLOEXEC}.



Alterado na versão 3.12: No Linux >= 4.5, o módulo @ref{59,,fcntl} expõe as constantes @code{FICLONE} e @code{FICLONERANGE}, que permitem compartilhar alguns dados de um arquivo com outro arquivo por meio de reflinking em alguns sistemas de arquivos (por exemplo, btrfs, OCFS2 e XFS). Esse comportamento é comumente chamado de “copy-on-write”.



Alterado na versão 3.13: No Linux >= 2.6.32, o módulo @code{fcntl} expõe as constantes @code{F_GETOWN_EX}, @code{F_SETOWN_EX}, @code{F_OWNER_TID}, @code{F_OWNER_PID}, @code{F_OWNER_PGRP}, que permitem direcionar sinais de disponibilidade de E/S para uma thread, processo ou grupo de processos específico. No Linux >= 4.13, o módulo @code{fcntl} expõe as constantes @code{F_GET_RW_HINT}, @code{F_SET_RW_HINT}, @code{F_GET_FILE_RW_HINT}, @code{F_SET_FILE_RW_HINT} e @code{RWH_WRITE_LIFE_*}, que permitem informar o kernel sobre o tempo de vida relativo esperado de gravações em um determinado nó-i ou por meio de uma descrição de arquivo aberto específica. No Linux >= 5.1 e NetBSD, o módulo @code{fcntl} expõe a constante @code{F_SEAL_FUTURE_WRITE} para uso com as operações @code{F_ADD_SEALS} e @code{F_GET_SEALS}. No FreeBSD, o módulo @code{fcntl} expõe as constantes @code{F_READAHEAD}, @code{F_ISUNIONSTACK} e @code{F_KINFO}. No macOS e FreeBSD, o módulo @code{fcntl} expõe a constante @code{F_RDAHEAD}. No NetBSD e AIX, o módulo @code{fcntl} expõe a constante @code{F_CLOSEM}. No NetBSD, o módulo @code{fcntl} expõe a constante @code{F_MAXFD}. No macOS e no NetBSD, o módulo @code{fcntl} expõe as constantes @code{F_GETNOSIGPIPE} e @code{F_SETNOSIGPIPE}.


O módulo define as seguintes funções:

@geindex fcntl() (no módulo fcntl)
@anchor{library/fcntl fcntl fcntl}@anchor{3652}
@deffn {Função} fcntl.fcntl (fd, cmd, arg=0, /)

Executa a operação `cmd' no descritor de arquivo `fd' (objetos arquivo que fornecem um método @ref{15d0,,fileno()} também são aceitos). Os valores usados para `cmd' dependem do sistema operacional e estão disponíveis como constantes no módulo @ref{59,,fcntl}, usando os mesmos nomes usados nos arquivos de cabeçalho C relevantes. O argumento `arg' pode ser um valor inteiro, um objeto @ref{1c2,,bytes} ou uma string. O tipo e o tamanho de `arg' devem corresponder ao tipo e ao tamanho do argumento da operação, conforme especificado na documentação C relevante.

Quando `arg' é um inteiro, a função retorna o valor de retorno inteiro da chamada C @code{fcntl()}.

Quando o argumento é bytes, ele representa uma estrutura binária, por exemplo, criada por @ref{12b8,,struct.pack()}. Um valor de string é codificado em binário usando a codificação UTF-8. Os dados binários são copiados para um buffer cujo endereço é passado para a chamada @code{fcntl()} em C. O valor de retorno após uma chamada bem-sucedida é o conteúdo do buffer, convertido em um objeto @ref{1c2,,bytes}. O comprimento do objeto retornado será igual ao comprimento do argumento `arg'. Este é limitado a 1024 bytes.

Se a chamada a @code{fcntl()} falhar, um exceção @ref{417,,OSError} é levantada.

@cartouche
@quotation Nota 
Se o tipo ou o tamanho de `arg' não corresponder ao tipo ou tamanho do argumento da operação (por exemplo, se um inteiro for passado quando um ponteiro for esperado, ou se as informações retornadas no buffer pelo sistema operacional forem maiores que 1024 bytes), é mais provável que isso resulte em uma violação de segmentação ou em uma corrupção de dados mais sutil.
@end quotation
@end cartouche

Levanta um @ref{19fa,,evento de auditoria} @code{fcntl.fcntl} com os argumentos @code{fd}, @code{cmd}, @code{arg}.
@end deffn

@geindex ioctl() (no módulo fcntl)
@anchor{library/fcntl fcntl ioctl}@anchor{14c3}
@deffn {Função} fcntl.ioctl (fd, request, arg=0, mutate_flag=True, /)

Esta função é idêntica à função @ref{3652,,fcntl()}, exceto que o tratamento de argumentos é ainda mais complicado.

O parâmetro `request' é limitado a valores que cabem em 32 ou 64 bits, dependendo da plataforma. Constantes adicionais de interesse para uso como argumento `request' podem ser encontradas no módulo @ref{e1,,termios}, com os mesmos nomes usados nos arquivos de cabeçalho C relevantes.

O parâmetro `arg' pode ser um inteiro, um @ref{d4f,,objeto bytes ou similar} ou uma string. O tipo e o tamanho de `arg' devem corresponder ao tipo e ao tamanho do argumento da operação, conforme especificado na documentação C relevante.

Se `arg' não oferecer suporte à interface de buffer de leitura e escrita ou o `mutate_flag' for falso, o comportamento será o mesmo da função @ref{3652,,fcntl()}.

Se `arg' oferece suporte à interface de buffer de leitura e escrita (como @ref{2ea,,bytearray}) e `mutate_flag' for true (o padrão), o buffer será (na prática) passado para a chamada de sistema subjacente @code{ioctl()}, o código de retorno desta última será passado de volta para o Python que fez a chamada, e o novo conteúdo do buffer refletirá a ação de @code{ioctl()}. Esta é uma pequena simplificação, pois se o buffer fornecido tiver menos de 1024 bytes, ele será primeiro copiado para um buffer estático de 1024 bytes, que será então passado para @ref{14c3,,ioctl()} e copiado de volta para o buffer fornecido.

Se a chamada a @code{ioctl()} falhar, uma exceção @ref{417,,OSError} é levantada.

@cartouche
@quotation Nota 
Se o tipo ou o tamanho de `arg' não corresponder ao tipo ou tamanho do argumento da operação (por exemplo, se um inteiro for passado quando um ponteiro for esperado, ou se as informações retornadas no buffer pelo sistema operacional forem maiores que 1024 bytes ou o tamanho do objeto byte ou similar mutável é pequeno demais), é mais provável que isso resulte em uma violação de segmentação ou em uma corrupção de dados mais sutil.
@end quotation
@end cartouche

Um exemplo:

@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

Levanta um @ref{19fa,,evento de auditoria} @code{fcntl.ioctl} com os argumentos @code{fd}, @code{request}, @code{arg}.
@end deffn

@geindex flock() (no módulo fcntl)
@anchor{library/fcntl fcntl flock}@anchor{4406}
@deffn {Função} fcntl.flock (fd, operation, /)

Executa a operação de trava `operation' no descritor de arquivo `fd' (objetos arquivo que fornecem um método @ref{15d0,,fileno()} também são aceitos). Consulte o manual do Unix @code{flock(2)@footnote{https://manpages.debian.org/flock(2)}} para obter detalhes. (Em alguns sistemas, esta função é emulada usando @code{fcntl()}.)

Se a chamada @code{flock()} falhar, uma exceção @ref{417,,OSError} será levantada.

Levanta um @ref{19fa,,evento de auditoria} @code{fcntl.flock} com os argumentos @code{fd} e @code{operation}.
@end deffn

@geindex lockf() (no módulo fcntl)
@anchor{library/fcntl fcntl lockf}@anchor{1433}
@deffn {Função} fcntl.lockf (fd, cmd, len=0, start=0, whence=0, /)

Este é essencialmente um invólucro em torno das chamadas de trava @ref{3652,,fcntl()}. `fd' é o descritor de arquivo (objetos arquivo que fornecem um método @ref{15d0,,fileno()} também são aceitos) do arquivo para travar ou destravar, e `cmd' é um dos seguintes valores:

@geindex LOCK_UN (no módulo fcntl)
@anchor{library/fcntl fcntl LOCK_UN}@anchor{4a93}
@deffn {Dado} fcntl.LOCK_UN

Libera uma trava existente.
@end deffn

@geindex LOCK_SH (no módulo fcntl)
@anchor{library/fcntl fcntl LOCK_SH}@anchor{4a94}
@deffn {Dado} fcntl.LOCK_SH

Adquire uma trava compartilhada.
@end deffn

@geindex LOCK_EX (no módulo fcntl)
@anchor{library/fcntl fcntl LOCK_EX}@anchor{4a95}
@deffn {Dado} fcntl.LOCK_EX

Adquire uma trava exclusiva.
@end deffn

@geindex LOCK_NB (no módulo fcntl)
@anchor{library/fcntl fcntl LOCK_NB}@anchor{4a96}
@deffn {Dado} fcntl.LOCK_NB

Aplica OU (OR) bit a bit com qualquer uma das outras três constantes @code{LOCK_*} para tornar a solicitação não bloqueante.
@end deffn

Se @code{LOCK_NB} for usado e a trava não puder ser obtido, uma exceção @ref{417,,OSError} será levantada e terá um atributo `errno' definido como @ref{2444,,EACCES} ou @ref{2435,,EAGAIN} (dependendo do sistema operacional; para portabilidade, verifique ambos os valores). Em pelo menos alguns sistemas, @code{LOCK_EX} só pode ser usado se o descritor de arquivo se referir a um arquivo aberto para escrita.

`len' é o número de bytes para travar, `start' é o deslocamento de bytes em que a trava começa, em relação a `whence', e `whence' é como em @ref{12ce,,io.IOBase.seek()}, especificamente:


@itemize *

@item 
@code{0} – relativo ao início do arquivo (@ref{12cf,,os.SEEK_SET})

@item 
@code{1} – relativo à posição atual do buffer (@ref{12d0,,os.SEEK_CUR})

@item 
@code{2} – relativo ao fim do arquivo (@ref{12d1,,os.SEEK_END})
@end itemize

O padrão para `start' é 0, o que significa iniciar no início do arquivo. O padrão para `len' é 0, o que significa travar no final do arquivo. O padrão para `whence' também é 0.

Levanta um @ref{19fa,,evento de auditoria} @code{fcntl.lockf} com os argumentos @code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}.
@end deffn

Exemplos (todos em um sistema compatível com 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

Observe que, no primeiro exemplo, a variável de valor de retorno `rv' conterá um valor inteiro; no segundo exemplo, ela conterá um objeto @ref{1c2,,bytes}. O layout da estrutura da variável `lockdata' depende do sistema — portanto, usar a chamada @ref{4406,,flock()} pode ser melhor.


@subsubheading Ver também



@table @asis

@item Módulo @ref{a1,,os}

Se os sinalizadores de trava @ref{1476,,O_SHLOCK} e @ref{1477,,O_EXLOCK} estiverem presentes no módulo @ref{a1,,os} (somente no BSD), a função @ref{dba,,os.open()} fornece uma alternativa às funções @ref{1433,,lockf()} e @ref{4406,,flock()}.
@end table


@node resource — Informação de uso de recursos,syslog — Rotinas da biblioteca syslog do Unix,fcntl — as chamadas de sistema fcntl e ioctl,Serviços específicos do Unix
@anchor{library/resource doc}@anchor{4a97}@anchor{library/resource module-resource}@anchor{bc}@anchor{library/resource resource-resource-usage-information}@anchor{4a98}@anchor{library/resource translation-repo}@anchor{4a99}
@subsection @code{resource} — Informação de uso de recursos


@geindex module; resource


__________________________________________________________________


Este módulo fornece mecanismos básicos para medir e controlar os recursos do sistema usados por um programa.

@ref{1ed8,,Disponibilidade}: Unix, not WASI.

Constantes simbólicas são usadas para especificar recursos específicos do sistema e para solicitar informações de uso sobre o processo atual ou seus filhos.

Uma exceção @ref{417,,OSError} é levantada em caso de falha de chamada de sistema.

@geindex error
@anchor{library/resource resource error}@anchor{4a9a}
@deffn {Exceção} resource.error

Um apelido descontinuado de @ref{417,,OSError}.


Alterado na versão 3.3: Seguindo a 
@geindex Propostas de Melhorias do Python; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}, esta classe foi transformada em um apelido de @ref{417,,OSError}.

@end deffn

@menu
* Limites de recursos:: 
* Uso de recursos:: 

@end menu

@node Limites de recursos,Uso de recursos,,resource — Informação de uso de recursos
@anchor{library/resource resource-limits}@anchor{4a9b}
@subsubsection Limites de recursos


O uso de recursos pode ser limitado usando a função @ref{1605,,setrlimit()} descrita abaixo. Cada recurso é controlado por um par de limites: um limite suave e um limite rígido. O limite suave é o limite atual e pode ser reduzido ou aumentado por um processo ao longo do tempo. O limite suave nunca pode exceder o limite rígido. O limite rígido pode ser reduzido para qualquer valor maior que o limite suave, mas não aumentado. (Somente processos com o UID efetivo do superusuário podem aumentar um limite rígido.)

Os recursos específicos que podem ser limitados dependem do sistema. Eles são descritos na página man @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}}. Os recursos listados abaixo são suportados quando o sistema operacional subjacente os suporta; recursos que não podem ser verificados ou controlados pelo sistema operacional não são definidos neste módulo para essas plataformas.

@geindex RLIM_INFINITY (no módulo resource)
@anchor{library/resource resource RLIM_INFINITY}@anchor{1604}
@deffn {Dado} resource.RLIM_INFINITY

Constante usada para representar o limite de um recurso ilimitado.
@end deffn

@geindex getrlimit() (no módulo resource)
@anchor{library/resource resource getrlimit}@anchor{1603}
@deffn {Função} resource.getrlimit (resource)

Retorna uma tupla @code{(suave, rígido)} com os limites soft e hard atuais de `resource'. Levanta @ref{202,,ValueError} se um recurso inválido for especificado, ou @ref{4a9a,,error} se a chamada do sistema subjacente falhar inesperadamente.
@end deffn

@geindex setrlimit() (no módulo resource)
@anchor{library/resource resource setrlimit}@anchor{1605}
@deffn {Função} resource.setrlimit (resource, limits)

Define novos limites de consumo de `resource'. O argumento `limits' deve ser uma tupla @code{(suave, rígido)} de dois inteiros descrevendo os novos limites. Um valor de @ref{1604,,RLIM_INFINITY} pode ser usado para solicitar um limite ilimitado.

Levanta @ref{202,,ValueError} se um recurso inválido for especificado, se o novo limite suave exceder o limite rígido ou se um processo tentar aumentar seu limite rígido. Especificar um limite de @ref{1604,,RLIM_INFINITY} quando o limite rígido ou do sistema para esse recurso não for ilimitado resultará em uma exceção @ref{202,,ValueError}. Um processo com o UID efetivo de superusuário pode solicitar qualquer valor limite válido, incluindo ilimitado, mas @ref{202,,ValueError} ainda será levantada se o limite solicitado exceder o limite imposto pelo sistema.

@code{setrlimit} também pode levantar @ref{4a9a,,error} se a chamada do sistema subjacente falhar.

VxWorks só oferece suporte a definir @ref{4a9c,,RLIMIT_NOFILE}.

Levanta um @ref{19fa,,evento de auditoria} @code{resource.setrlimit} com os argumentos @code{resource}, @code{limits}.
@end deffn

@geindex prlimit() (no módulo resource)
@anchor{library/resource resource prlimit}@anchor{fbe}
@deffn {Função} resource.prlimit (pid, resource[, limits])

Combina @ref{1605,,setrlimit()} e @ref{1603,,getrlimit()} em uma única função e permite obter e definir os limites de recursos de um processo arbitrário. Se `pid' for 0, a chamada se aplica ao processo atual. `resource' e `limits' têm o mesmo significado que em @ref{1605,,setrlimit()}, exceto que `limits' é opcional.

Quando `limits' não é fornecido, a função retorna o limite de `resource' do processo `pid'. Quando `limits' é fornecido, o limite de `resource' do processo é definido e o limite de recurso anterior é retornado.

Levanta @ref{1094,,ProcessLookupError} quando `pid' não pode ser encontrado e @ref{d65,,PermissionError} quando o usuário não tem @code{CAP_SYS_RESOURCE} para o processo.

Levanta um @ref{19fa,,evento de auditoria} @code{resource.prlimit} com os argumentos @code{pid}, @code{resource}, @code{limits}.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.36 with glibc >= 2.13.


Adicionado na versão 3.4.

@end deffn

Esses símbolos definem recursos cujo consumo pode ser controlado usando as funções @ref{1605,,setrlimit()} e @ref{1603,,getrlimit()} descritas abaixo. Os valores desses símbolos são exatamente as constantes usadas por programas em C.

A página man do Unix para @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}} lista os recursos disponíveis. Observe que nem todos os sistemas usam o mesmo símbolo ou o mesmo valor para denotar o mesmo recurso. Este módulo não tenta mascarar diferenças de plataforma — símbolos não definidos para uma plataforma não estarão disponíveis neste módulo para essa plataforma.

@geindex RLIMIT_CORE (no módulo resource)
@anchor{library/resource resource RLIMIT_CORE}@anchor{43a9}
@deffn {Dado} resource.RLIMIT_CORE

O tamanho máximo (em bytes) de um arquivo de núcleo (core file) que o processo atual pode criar. Isso pode resultar na criação de um arquivo de núcleo parcial se um núcleo maior for necessário para conter a imagem completa do processo.
@end deffn

@geindex RLIMIT_CPU (no módulo resource)
@anchor{library/resource resource RLIMIT_CPU}@anchor{4a9d}
@deffn {Dado} resource.RLIMIT_CPU

O tempo máximo de processador (em segundos) que um processo pode usar. Se esse limite for excedido, um sinal @ref{3722,,SIGXCPU} é enviado ao processo. (Consulte a documentação do módulo @ref{c6,,signal} para obter informações sobre como capturar esse sinal e fazer algo útil, por exemplo, liberar arquivos abertos no disco.)
@end deffn

@geindex RLIMIT_FSIZE (no módulo resource)
@anchor{library/resource resource RLIMIT_FSIZE}@anchor{4a9e}
@deffn {Dado} resource.RLIMIT_FSIZE

O tamanho máximo de um arquivo que o processo pode criar.
@end deffn

@geindex RLIMIT_DATA (no módulo resource)
@anchor{library/resource resource RLIMIT_DATA}@anchor{4a9f}
@deffn {Dado} resource.RLIMIT_DATA

O tamanho máximo (em bytes) da heap do processo.
@end deffn

@geindex RLIMIT_STACK (no módulo resource)
@anchor{library/resource resource RLIMIT_STACK}@anchor{4aa0}
@deffn {Dado} resource.RLIMIT_STACK

O tamanho máximo (em bytes) da pilha de chamadas para o processo atual. Isso afeta apenas a pilha da thread principal em um processo multithread.
@end deffn

@geindex RLIMIT_RSS (no módulo resource)
@anchor{library/resource resource RLIMIT_RSS}@anchor{4aa1}
@deffn {Dado} resource.RLIMIT_RSS

O tamanho máximo do conjunto de residentes que deve ser disponibilizado para o processo.
@end deffn

@geindex RLIMIT_NPROC (no módulo resource)
@anchor{library/resource resource RLIMIT_NPROC}@anchor{4aa2}
@deffn {Dado} resource.RLIMIT_NPROC

O número máximo de processos que o processo atual pode criar.
@end deffn

@geindex RLIMIT_NOFILE (no módulo resource)
@anchor{library/resource resource RLIMIT_NOFILE}@anchor{4a9c}
@deffn {Dado} resource.RLIMIT_NOFILE

O número máximo de descritores de arquivo abertos para o processo atual.
@end deffn

@geindex RLIMIT_OFILE (no módulo resource)
@anchor{library/resource resource RLIMIT_OFILE}@anchor{4aa3}
@deffn {Dado} resource.RLIMIT_OFILE

O nome BSD para @ref{4a9c,,RLIMIT_NOFILE}.
@end deffn

@geindex RLIMIT_MEMLOCK (no módulo resource)
@anchor{library/resource resource RLIMIT_MEMLOCK}@anchor{4aa4}
@deffn {Dado} resource.RLIMIT_MEMLOCK

O espaço máximo de endereço que pode ser travado na memória.
@end deffn

@geindex RLIMIT_VMEM (no módulo resource)
@anchor{library/resource resource RLIMIT_VMEM}@anchor{4aa5}
@deffn {Dado} resource.RLIMIT_VMEM

A maior área de memória mapeada que o processo pode ocupar. Geralmente um apelido de @ref{4aa6,,RLIMIT_AS}.

@ref{1ed8,,Disponibilidade}: Solaris, FreeBSD, NetBSD.
@end deffn

@geindex RLIMIT_AS (no módulo resource)
@anchor{library/resource resource RLIMIT_AS}@anchor{4aa6}
@deffn {Dado} resource.RLIMIT_AS

A área máxima (em bytes) de espaço de endereço que pode ser ocupada pelo processo.
@end deffn

@geindex RLIMIT_MSGQUEUE (no módulo resource)
@anchor{library/resource resource RLIMIT_MSGQUEUE}@anchor{fbf}
@deffn {Dado} resource.RLIMIT_MSGQUEUE

O número de bytes que podem ser alocados para filas de mensagens POSIX.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.8.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_NICE (no módulo resource)
@anchor{library/resource resource RLIMIT_NICE}@anchor{fc0}
@deffn {Dado} resource.RLIMIT_NICE

O teto para o nível agradável do processo (calculado como 20 - rlim_cur).

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.12.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_RTPRIO (no módulo resource)
@anchor{library/resource resource RLIMIT_RTPRIO}@anchor{fc1}
@deffn {Dado} resource.RLIMIT_RTPRIO

O teto da prioridade em tempo real.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.12.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_RTTIME (no módulo resource)
@anchor{library/resource resource RLIMIT_RTTIME}@anchor{fc2}
@deffn {Dado} resource.RLIMIT_RTTIME

O limite de tempo (em microssegundos) no tempo de CPU que um processo pode gastar sob agendamento em tempo real sem fazer uma chamada de sistema de bloqueio.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.25.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_SIGPENDING (no módulo resource)
@anchor{library/resource resource RLIMIT_SIGPENDING}@anchor{fc3}
@deffn {Dado} resource.RLIMIT_SIGPENDING

O número de sinais que o processo pode enfileirar.

@ref{1ed8,,Disponibilidade}: Linux >= 2.6.8.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_SBSIZE (no módulo resource)
@anchor{library/resource resource RLIMIT_SBSIZE}@anchor{fc4}
@deffn {Dado} resource.RLIMIT_SBSIZE

O tamanho máximo (em bytes) de uso do buffer de soquete para este usuário. Isso limita a quantidade de memória de rede e, portanto, a quantidade de mbufs que este usuário pode armazenar a qualquer momento.

@ref{1ed8,,Disponibilidade}: FreeBSD, NetBSD.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_SWAP (no módulo resource)
@anchor{library/resource resource RLIMIT_SWAP}@anchor{fc5}
@deffn {Dado} resource.RLIMIT_SWAP

O tamanho máximo (em bytes) do espaço de swap que pode ser reservado ou utilizado por todos os processos deste ID de usuário. Este limite é aplicado somente se o bit 1 do sysctl vm.overcommit estiver definido. Consulte tuning(7)@footnote{https://man.freebsd.org/cgi/man.cgi?query=tuning&sektion=7} para uma descrição completa deste sysctl.

@ref{1ed8,,Disponibilidade}: FreeBSD >= 8.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_NPTS (no módulo resource)
@anchor{library/resource resource RLIMIT_NPTS}@anchor{fc6}
@deffn {Dado} resource.RLIMIT_NPTS

O número máximo de pseudoterminais criados por este ID de usuário.

@ref{1ed8,,Disponibilidade}: FreeBSD >= 8.


Adicionado na versão 3.4.

@end deffn

@geindex RLIMIT_KQUEUES (no módulo resource)
@anchor{library/resource resource RLIMIT_KQUEUES}@anchor{1a32}
@deffn {Dado} resource.RLIMIT_KQUEUES

O número máximo de kqueues que esse ID de usuário tem permissão para criar.

@ref{1ed8,,Disponibilidade}: FreeBSD >= 11.


Adicionado na versão 3.10.

@end deffn

@node Uso de recursos,,Limites de recursos,resource — Informação de uso de recursos
@anchor{library/resource resource-usage}@anchor{4aa7}
@subsubsection Uso de recursos


Essas funções são usadas para recuperar informações de uso de recursos:

@geindex getrusage() (no módulo resource)
@anchor{library/resource resource getrusage}@anchor{1478}
@deffn {Função} resource.getrusage (who)

Esta função retorna um objeto que descreve os recursos consumidos pelo processo atual ou seus filhos, conforme especificado pelo parâmetro `who'. O parâmetro `who' deve ser especificado usando uma das constantes @code{RUSAGE_*} descritas abaixo.

Um exemplo simples:

@example
from resource import *
import time

# uma tarefa não vinculada à CPU
time.sleep(3)
print(getrusage(RUSAGE_SELF))

# uma tarefa vinculada à CPU
for i in range(10 ** 8):
   _ = 1 + 1
print(getrusage(RUSAGE_SELF))
@end example

Os campos do valor de retorno descrevem como um recurso específico do sistema foi utilizado, por exemplo, a quantidade de tempo gasto em execução no modo de usuário ou o número de vezes que o processo foi trocado da memória principal. Alguns valores dependem do tique do relógio interno, por exemplo, a quantidade de memória que o processo está usando.

Para retrocompatibilidade, o valor de retorno também pode ser acessado como uma tupla de 16 elementos.

Os campos @code{ru_utime} e @code{ru_stime} do valor de retorno são valores de ponto flutuante que representam o tempo gasto na execução no modo usuário e o tempo gasto na execução no modo sistema, respectivamente. Os valores restantes são inteiros. Consulte a página man @code{getrusage(2)@footnote{https://manpages.debian.org/getrusage(2)}} para obter informações detalhadas sobre esses valores. Um breve resumo é apresentado aqui:


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Índice

@tab

Campo

@tab

Recurso

@item

@code{0}

@tab

@code{ru_utime}

@tab

tempo no modo de usuário (segundos em pontos flutuantes)

@item

@code{1}

@tab

@code{ru_stime}

@tab

tempo no modo de sistema (segundos em pontos flutuantes)

@item

@code{2}

@tab

@code{ru_maxrss}

@tab

tamanho máximo do conjunto residente

@item

@code{3}

@tab

@code{ru_ixrss}

@tab

tamanho da memória compartilhada

@item

@code{4}

@tab

@code{ru_idrss}

@tab

tamanho da memória não compartilhada

@item

@code{5}

@tab

@code{ru_isrss}

@tab

tamanho da pilha não compartilhada

@item

@code{6}

@tab

@code{ru_minflt}

@tab

falhas de página que não requerem E/S

@item

@code{7}

@tab

@code{ru_majflt}

@tab

falhas de página que requerem E/S

@item

@code{8}

@tab

@code{ru_nswap}

@tab

número de trocas para a memórias de swap

@item

@code{9}

@tab

@code{ru_inblock}

@tab

operações de entrada de bloco

@item

@code{10}

@tab

@code{ru_oublock}

@tab

operações de saída de bloco

@item

@code{11}

@tab

@code{ru_msgsnd}

@tab

mensagens enviadas

@item

@code{12}

@tab

@code{ru_msgrcv}

@tab

mensagens recebidas

@item

@code{13}

@tab

@code{ru_nsignals}

@tab

sinais recebidos

@item

@code{14}

@tab

@code{ru_nvcsw}

@tab

trocas voluntárias de contexto

@item

@code{15}

@tab

@code{ru_nivcsw}

@tab

trocas involuntárias de contexto

@end multitable


Esta função levantará uma @ref{202,,ValueError} se um parâmetro `who' inválido for especificado. Também pode levantar uma exceção @ref{4a9a,,error} em circunstâncias incomuns.
@end deffn

@geindex getpagesize() (no módulo resource)
@anchor{library/resource resource getpagesize}@anchor{4aa8}
@deffn {Função} resource.getpagesize ()

Retorna o número de bytes em uma página do sistema. (Não precisa ser o mesmo que o tamanho da página de hardware.)
@end deffn

Os seguintes símbolos @code{RUSAGE_*} são passados para a função @ref{1478,,getrusage()} para especificar quais informações de processos devem ser fornecidas.

@geindex RUSAGE_SELF (no módulo resource)
@anchor{library/resource resource RUSAGE_SELF}@anchor{4aa9}
@deffn {Dado} resource.RUSAGE_SELF

Passeapara @ref{1478,,getrusage()} para solicitar recursos consumidos pelo processo de chamada, que é a soma dos recursos usados por todas as threads no processo.
@end deffn

@geindex RUSAGE_CHILDREN (no módulo resource)
@anchor{library/resource resource RUSAGE_CHILDREN}@anchor{4aaa}
@deffn {Dado} resource.RUSAGE_CHILDREN

Passa para @ref{1478,,getrusage()} para solicitar recursos consumidos por processos filhos do processo de chamada que foram encerrados e aguardados.
@end deffn

@geindex RUSAGE_BOTH (no módulo resource)
@anchor{library/resource resource RUSAGE_BOTH}@anchor{4aab}
@deffn {Dado} resource.RUSAGE_BOTH

Passa para @ref{1478,,getrusage()} para solicitar recursos consumidos pelo processo atual e pelos processos filhos. Pode não estar disponível em todos os sistemas.
@end deffn

@geindex RUSAGE_THREAD (no módulo resource)
@anchor{library/resource resource RUSAGE_THREAD}@anchor{4aac}
@deffn {Dado} resource.RUSAGE_THREAD

Passa para @ref{1478,,getrusage()} para solicitar recursos consumidos pela thread atual. Pode não estar disponível em todos os sistemas.


Adicionado na versão 3.2.

@end deffn

@node syslog — Rotinas da biblioteca syslog do Unix,,resource — Informação de uso de recursos,Serviços específicos do Unix
@anchor{library/syslog doc}@anchor{4aad}@anchor{library/syslog module-syslog}@anchor{dc}@anchor{library/syslog syslog-unix-syslog-library-routines}@anchor{4aae}@anchor{library/syslog translation-repo}@anchor{4aaf}
@subsection @code{syslog} — Rotinas da biblioteca syslog do Unix


@geindex module; syslog


__________________________________________________________________


Este módulo fornece uma interface para as rotinas da biblioteca @code{syslog} do Unix. Consulte as páginas de manual do Unix para uma descrição detalhada do recurso @code{syslog}.

@ref{1ed8,,Disponibilidade}: Unix, not WASI, not iOS.

Este módulo é uma camada para a família de rotinas @code{syslog} do sistema. Uma biblioteca Python pura que pode se comunicar com um servidor syslog está disponível no módulo @ref{89,,logging.handlers} como @ref{65c,,SysLogHandler}.

O módulo define as seguintes funções:

@geindex syslog() (no módulo syslog)
@anchor{library/syslog syslog syslog}@anchor{540}
@deffn {Função} syslog.syslog (message)

@deffnx {Função} syslog.syslog (priority, message)

Envia a string `message' para o registrador do sistema. Uma nova linha final é adicionada, se necessário. Cada mensagem é marcada com uma prioridade composta por um `facility' e um `level'. O argumento opcional `priority', cujo padrão é @ref{4ab0,,LOG_INFO}, determina a prioridade da mensagem. Se a facilidade não está codificada em `priority' usando o OU lógico (@code{LOG_INFO | LOG_USER}), o valor dado na chamada @ref{53e,,openlog()} é usado.

Se @ref{53e,,openlog()} não foi chamado antes da chamada para @ref{dc,,syslog()}, @ref{53e,,openlog()} será chamado sem argumentos.

Levanta um @ref{19fa,,evento de auditoria} @code{syslog.syslog} com os argumentos @code{priority}, @code{message}.


Alterado na versão 3.2: Nas versões anteriores, @ref{53e,,openlog()} não seria chamado automaticamente se não fosse chamado antes da chamada para @ref{dc,,syslog()}, adiando a implementação do syslog para chamar @code{openlog()}.



Alterado na versão 3.12: Esta função é restrita em subinterpretadores. (Apenas o código que executa em vários interpretadores é afetado e a restrição não é relevante para a maioria dos usuários.) @ref{53e,,openlog()} deve ser chamado no interpretador principal antes de @ref{dc,,syslog()} pode ser usado em um subinterpretador. Caso contrário, vai levantar @ref{195,,RuntimeError}.

@end deffn

@geindex openlog() (no módulo syslog)
@anchor{library/syslog syslog openlog}@anchor{53e}
@deffn {Função} syslog.openlog ([ident[, logoption[, facility]]])

As opções de log das chamadas subsequentes @ref{dc,,syslog()} podem ser definidas chamando @ref{53e,,openlog()}. @ref{dc,,syslog()} irá chamar @ref{53e,,openlog()} sem argumentos se o log não estiver aberto no momento.

O argumento nomeado opcional `ident' é uma string que é prefixada a cada mensagem, e o padrão é @code{sys.argv[0]} com os componentes do caminho inicial removidos. O argumento nomeado opcional `logoption' (o padrão é 0) é um campo de bits – veja abaixo os valores possíveis para combinar. O argumento nomeado opcional `facility' (o padrão é @ref{4ab1,,LOG_USER}) define o recurso padrão para mensagens que não possuem um recurso explicitamente codificado.

Levanta um @ref{19fa,,evento de auditoria} @code{syslog.openlog} com os argumentos @code{ident}, @code{logoption}, @code{facility}.


Alterado na versão 3.2: Nas versões anteriores, os argumentos nomeados não eram permitidos e `ident' era obrigatório.



Alterado na versão 3.12: Esta função é restrita em subinterpretadores. (Apenas o código que executa em vários interpretadores é afetado e a restrição não é relevante para a maioria dos usuários.) Isso deve ser chamado no interpretador principal.Vai levantar @ref{195,,RuntimeError} se chamado em um subinterpretador.

@end deffn

@geindex closelog() (no módulo syslog)
@anchor{library/syslog syslog closelog}@anchor{53f}
@deffn {Função} syslog.closelog ()

Redefine os valores do módulo syslog e chama a biblioteca de sistema @code{closelog()}.

Isso faz com que o módulo se comporte como quando importado inicialmente. Por exemplo, @ref{53e,,openlog()} será chamado na primeira chamada @ref{dc,,syslog()} (se @ref{53e,,openlog()} ainda não foi chamado), e `ident' e outro @ref{53e,,openlog()} os parâmetros são redefinidos para os padrões.

Levanta um @ref{19fa,,evento de auditoria} @code{syslog.closelog} sem argumentos.


Alterado na versão 3.12: Esta função é restrita em subinterpretadores. (Apenas o código que executa em vários interpretadores é afetado e a restrição não é relevante para a maioria dos usuários.) Isso deve ser chamado no interpretador principal.Vai levantar @ref{195,,RuntimeError} se chamado em um subinterpretador.

@end deffn

@geindex setlogmask() (no módulo syslog)
@anchor{library/syslog syslog setlogmask}@anchor{440b}
@deffn {Função} syslog.setlogmask (maskpri)

Define a máscara de prioridade como `maskpri' e retorna o valor da máscara anterior. Chamadas para @ref{dc,,syslog()} com um nível de prioridade não definido em `maskpri' são ignoradas. O padrão é registrar todas as prioridades. A função @code{LOG_MASK(pri)} calcula a máscara para a prioridade individual `pri'. A função @code{LOG_UPTO(pri)} calcula a máscara para todas as prioridades até e incluindo `pri'.

Levanta um @ref{19fa,,evento de auditoria} @code{syslog.setlogmask} com o argumento @code{maskpri}.
@end deffn

O módulo define as seguintes constantes:

@geindex LOG_EMERG (no módulo syslog)
@geindex LOG_ALERT (no módulo syslog)
@geindex LOG_CRIT (no módulo syslog)
@geindex LOG_ERR (no módulo syslog)
@geindex LOG_WARNING (no módulo syslog)
@geindex LOG_NOTICE (no módulo syslog)
@geindex LOG_INFO (no módulo syslog)
@geindex LOG_DEBUG (no módulo syslog)
@anchor{library/syslog syslog LOG_EMERG}@anchor{4ab2}
@deffn {Dado} syslog.LOG_EMERG
@anchor{library/syslog syslog LOG_ALERT}@anchor{4ab3}
@deffnx {Dado} syslog.LOG_ALERT
@anchor{library/syslog syslog LOG_CRIT}@anchor{4ab4}
@deffnx {Dado} syslog.LOG_CRIT
@anchor{library/syslog syslog LOG_ERR}@anchor{4ab5}
@deffnx {Dado} syslog.LOG_ERR
@anchor{library/syslog syslog LOG_WARNING}@anchor{4ab6}
@deffnx {Dado} syslog.LOG_WARNING
@anchor{library/syslog syslog LOG_NOTICE}@anchor{4ab7}
@deffnx {Dado} syslog.LOG_NOTICE
@anchor{library/syslog syslog LOG_INFO}@anchor{4ab0}
@deffnx {Dado} syslog.LOG_INFO
@anchor{library/syslog syslog LOG_DEBUG}@anchor{4ab8}
@deffnx {Dado} syslog.LOG_DEBUG

Níveis de prioridade (alto a baixo).
@end deffn

@geindex LOG_AUTH (no módulo syslog)
@geindex LOG_AUTHPRIV (no módulo syslog)
@geindex LOG_CRON (no módulo syslog)
@geindex LOG_DAEMON (no módulo syslog)
@geindex LOG_FTP (no módulo syslog)
@geindex LOG_INSTALL (no módulo syslog)
@geindex LOG_KERN (no módulo syslog)
@geindex LOG_LAUNCHD (no módulo syslog)
@geindex LOG_LPR (no módulo syslog)
@geindex LOG_MAIL (no módulo syslog)
@geindex LOG_NETINFO (no módulo syslog)
@geindex LOG_NEWS (no módulo syslog)
@geindex LOG_RAS (no módulo syslog)
@geindex LOG_REMOTEAUTH (no módulo syslog)
@geindex LOG_SYSLOG (no módulo syslog)
@geindex LOG_USER (no módulo syslog)
@geindex LOG_UUCP (no módulo syslog)
@geindex LOG_LOCAL0 (no módulo syslog)
@geindex LOG_LOCAL1 (no módulo syslog)
@geindex LOG_LOCAL2 (no módulo syslog)
@geindex LOG_LOCAL3 (no módulo syslog)
@geindex LOG_LOCAL4 (no módulo syslog)
@geindex LOG_LOCAL5 (no módulo syslog)
@geindex LOG_LOCAL6 (no módulo syslog)
@geindex LOG_LOCAL7 (no módulo syslog)
@anchor{library/syslog syslog LOG_AUTH}@anchor{4ab9}
@deffn {Dado} syslog.LOG_AUTH
@anchor{library/syslog syslog LOG_AUTHPRIV}@anchor{4aba}
@deffnx {Dado} syslog.LOG_AUTHPRIV
@anchor{library/syslog syslog LOG_CRON}@anchor{4abb}
@deffnx {Dado} syslog.LOG_CRON
@anchor{library/syslog syslog LOG_DAEMON}@anchor{4abc}
@deffnx {Dado} syslog.LOG_DAEMON
@anchor{library/syslog syslog LOG_FTP}@anchor{4abd}
@deffnx {Dado} syslog.LOG_FTP
@anchor{library/syslog syslog LOG_INSTALL}@anchor{4abe}
@deffnx {Dado} syslog.LOG_INSTALL
@anchor{library/syslog syslog LOG_KERN}@anchor{4abf}
@deffnx {Dado} syslog.LOG_KERN
@anchor{library/syslog syslog LOG_LAUNCHD}@anchor{4ac0}
@deffnx {Dado} syslog.LOG_LAUNCHD
@anchor{library/syslog syslog LOG_LPR}@anchor{4ac1}
@deffnx {Dado} syslog.LOG_LPR
@anchor{library/syslog syslog LOG_MAIL}@anchor{4ac2}
@deffnx {Dado} syslog.LOG_MAIL
@anchor{library/syslog syslog LOG_NETINFO}@anchor{4ac3}
@deffnx {Dado} syslog.LOG_NETINFO
@anchor{library/syslog syslog LOG_NEWS}@anchor{4ac4}
@deffnx {Dado} syslog.LOG_NEWS
@anchor{library/syslog syslog LOG_RAS}@anchor{4ac5}
@deffnx {Dado} syslog.LOG_RAS
@anchor{library/syslog syslog LOG_REMOTEAUTH}@anchor{4ac6}
@deffnx {Dado} syslog.LOG_REMOTEAUTH
@anchor{library/syslog syslog LOG_SYSLOG}@anchor{4ac7}
@deffnx {Dado} syslog.LOG_SYSLOG
@anchor{library/syslog syslog LOG_USER}@anchor{4ab1}
@deffnx {Dado} syslog.LOG_USER
@anchor{library/syslog syslog LOG_UUCP}@anchor{4ac8}
@deffnx {Dado} syslog.LOG_UUCP
@anchor{library/syslog syslog LOG_LOCAL0}@anchor{4ac9}
@deffnx {Dado} syslog.LOG_LOCAL0
@anchor{library/syslog syslog LOG_LOCAL1}@anchor{4aca}
@deffnx {Dado} syslog.LOG_LOCAL1
@anchor{library/syslog syslog LOG_LOCAL2}@anchor{4acb}
@deffnx {Dado} syslog.LOG_LOCAL2
@anchor{library/syslog syslog LOG_LOCAL3}@anchor{4acc}
@deffnx {Dado} syslog.LOG_LOCAL3
@anchor{library/syslog syslog LOG_LOCAL4}@anchor{4acd}
@deffnx {Dado} syslog.LOG_LOCAL4
@anchor{library/syslog syslog LOG_LOCAL5}@anchor{4ace}
@deffnx {Dado} syslog.LOG_LOCAL5
@anchor{library/syslog syslog LOG_LOCAL6}@anchor{4acf}
@deffnx {Dado} syslog.LOG_LOCAL6
@anchor{library/syslog syslog LOG_LOCAL7}@anchor{4ad0}
@deffnx {Dado} syslog.LOG_LOCAL7

Facilidades, dependendo da disponibilidade em @code{<syslog.h>} para @ref{4aba,,LOG_AUTHPRIV}, @ref{4abd,,LOG_FTP}, @ref{4ac3,,LOG_NETINFO}, @ref{4ac6,,LOG_REMOTEAUTH}, @ref{4abe,,LOG_INSTALL} e @ref{4ac5,,LOG_RAS}.


Alterado na versão 3.13: Adicionados @ref{4abd,,LOG_FTP}, @ref{4ac3,,LOG_NETINFO}, @ref{4ac6,,LOG_REMOTEAUTH}, @ref{4abe,,LOG_INSTALL}, @ref{4ac5,,LOG_RAS} e @ref{4ac0,,LOG_LAUNCHD}.

@end deffn

@geindex LOG_PID (no módulo syslog)
@geindex LOG_CONS (no módulo syslog)
@geindex LOG_NDELAY (no módulo syslog)
@geindex LOG_ODELAY (no módulo syslog)
@geindex LOG_NOWAIT (no módulo syslog)
@geindex LOG_PERROR (no módulo syslog)
@anchor{library/syslog syslog LOG_PID}@anchor{4ad1}
@deffn {Dado} syslog.LOG_PID
@anchor{library/syslog syslog LOG_CONS}@anchor{4ad2}
@deffnx {Dado} syslog.LOG_CONS
@anchor{library/syslog syslog LOG_NDELAY}@anchor{4ad3}
@deffnx {Dado} syslog.LOG_NDELAY
@anchor{library/syslog syslog LOG_ODELAY}@anchor{4ad4}
@deffnx {Dado} syslog.LOG_ODELAY
@anchor{library/syslog syslog LOG_NOWAIT}@anchor{4ad5}
@deffnx {Dado} syslog.LOG_NOWAIT
@anchor{library/syslog syslog LOG_PERROR}@anchor{4ad6}
@deffnx {Dado} syslog.LOG_PERROR

Opções de log, dependendo da disponibilidade em @code{<syslog.h>} para @ref{4ad4,,LOG_ODELAY}, @ref{4ad5,,LOG_NOWAIT} e @ref{4ad6,,LOG_PERROR}.
@end deffn

@menu
* Exemplos: Exemplos<36>. 

@end menu

@node Exemplos<36>,,,syslog — Rotinas da biblioteca syslog do Unix
@anchor{library/syslog examples}@anchor{4ad7}
@subsubsection Exemplos


@menu
* Exemplo simples:: 

@end menu

@node Exemplo simples,,,Exemplos<36>
@anchor{library/syslog simple-example}@anchor{4ad8}
@subsubsection Exemplo simples


Um conjunto simples de exemplos:

@example
import syslog

syslog.syslog('Processing started')
if error:
    syslog.syslog(syslog.LOG_ERR, 'Processing started')
@end example

Um exemplo de configuração de algumas opções de log, isso incluiria o ID do processo nas mensagens registradas e escreveria as mensagens no recurso de destino usado para o log de correio:

@example
syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...')
@end example

@node Interface de linha de comando CLI de módulos,Módulos substituídos,Serviços específicos do Unix,A Biblioteca Padrão do Python
@anchor{library/cmdline doc}@anchor{4ad9}@anchor{library/cmdline modules-command-line-interface-cli}@anchor{4ada}@anchor{library/cmdline translation-repo}@anchor{4adb}
@section Interface de linha de comando (CLI) de módulos


Os seguintes módulos têm uma interface de linha de comando.


@itemize *

@item 
@ref{4884,,ast}

@item 
@ref{3480,,asyncio}

@item 
@ref{e,,base64}

@item 
@ref{268a,,calendar}

@item 
@ref{1a,,code}

@item 
@ref{4948,,compileall}

@item 
@ref{27,,cProfile}: veja @ref{44a3,,profile}

@item 
@ref{24c8,,difflib}

@item 
@ref{495f,,dis}

@item 
@ref{4207,,doctest}

@item 
@code{encodings.rot_13}

@item 
@ref{454d,,ensurepip}

@item 
@ref{5a,,filecmp}

@item 
@ref{5b,,fileinput}

@item 
@ref{5e,,ftplib}

@item 
@ref{2b3c,,gzip}

@item 
@ref{f85,,http.server}

@item 
@ref{40c0,,idlelib}

@item 
@ref{f8f,,inspect}

@item 
@ref{388c,,json.tool}

@item 
@ref{8f,,mimetypes}

@item 
@ref{446b,,pdb}

@item 
@ref{a6,,pickle}

@item 
@ref{49cf,,pickletools}

@item 
@ref{2f2a,,platform}

@item 
@ref{ac,,poplib}

@item 
@ref{44a3,,profile}

@item 
@ref{b0,,pstats}

@item 
@ref{493f,,py_compile}

@item 
@ref{b4,,pyclbr}

@item 
@ref{b5,,pydoc}

@item 
@ref{b7,,quopri}

@item 
@ref{154,,random}

@item 
@ref{be,,runpy}

@item 
@ref{4723,,site}

@item 
@ref{441,,sqlite3}

@item 
@ref{48ba,,symtable}

@item 
@ref{4618,,sysconfig}

@item 
@ref{dd,,tabnanny}

@item 
@ref{1001,,tarfile}

@item 
@code{this}

@item 
@ref{44c7,,timeit}

@item 
@ref{4910,,tokenize}

@item 
@ref{44e4,,trace}

@item 
@ref{102,,turtledemo}

@item 
@ref{4280,,unittest}

@item 
@ref{444,,uuid}

@item 
@ref{455a,,venv}

@item 
@ref{3b75,,webbrowser}

@item 
@ref{4574,,zipapp}

@item 
@ref{2bac,,zipfile}
@end itemize

Consulte também a @ref{1b36,,interface de linha de comando do Python}.

@node Módulos substituídos,Módulos removidos,Interface de linha de comando CLI de módulos,A Biblioteca Padrão do Python
@anchor{library/superseded doc}@anchor{4adc}@anchor{library/superseded superseded}@anchor{4add}@anchor{library/superseded superseded-modules}@anchor{4ade}@anchor{library/superseded translation-repo}@anchor{4adf}
@section Módulos substituídos


Os módulos descritos neste capítulo foram substituídos por outros módulos para a maioria dos casos de uso e são mantidos principalmente para preservar a retrocompatibilidade.

Os módulos podem aparecer neste capítulo porque eles cobrem apenas um subconjunto limitado de um espaço de problema, e uma solução mais geralmente aplicável está disponível em outro lugar na biblioteca padrão (por exemplo, @ref{61,,getopt} cobre a tarefa muito específica de “imitar a API C @code{getopt()} no Python”, em vez dos recursos mais amplos de análise de opções de linha de comando e análise de argumentos oferecidos por @ref{a0,,optparse} e @ref{6,,argparse}).

Alternativamente, módulos podem aparecer neste capítulo porque estão totalmente descontinuados e aguardando remoção em uma versão futura, ou estão @ref{209,,suavemente descontinuados} e seu uso é ativamente desencorajado em novos projetos. Com a remoção de vários módulos obsoletos por meio da 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}, atualmente não há módulos nesta última categoria.

@menu
* getopt — Analisador sintático no estilo C para opções de linha de comando:: 

@end menu

@node getopt — Analisador sintático no estilo C para opções de linha de comando,,,Módulos substituídos
@anchor{library/getopt doc}@anchor{4ae0}@anchor{library/getopt getopt-c-style-parser-for-command-line-options}@anchor{4ae1}@anchor{library/getopt module-getopt}@anchor{61}
@subsection @code{getopt} — Analisador sintático no estilo C para opções de linha de comando


@geindex module; getopt

`Código-fonte:' Lib/getopt.py@footnote{https://github.com/python/cpython/tree/3.13/Lib/getopt.py}

@cartouche
@quotation Nota 
Este módulo é considerado completo em recursos. Uma alternativa mais declarativa e extensível para esta API é fornecida no módulo @ref{a0,,optparse}. Outros aprimoramentos funcionais para processamento de parâmetros de linha de comando são fornecidos como módulos de terceiros no PyPI ou como recursos no módulo @ref{6,,argparse}.
@end quotation
@end cartouche


__________________________________________________________________


Este módulo ajuda os scripts a analisar os argumentos da linha de comando em @code{sys.argv}. Ele suporta as mesmas convenções da função Unix @code{getopt()} (incluindo os significados especiais de argumentos da forma ‘@code{-}’ e ‘@code{--}‘). Longas opções semelhantes às suportadas pelo software GNU também podem ser usadas por meio de um terceiro argumento opcional.

Usuários que não estão familiarizados com a função Unix @code{getopt()} devem considerar usar o módulo @ref{6,,argparse} em vez disso. Usuários que estão familiarizados com a função Unix @code{getopt()}, mas gostariam de obter um comportamento equivalente enquanto escrevem menos código e obtêm melhor ajuda e mensagens de erro devem considerar usar o módulo @ref{a0,,optparse}. Veja @ref{3044,,Escolhendo uma biblioteca de análise de linha de comando} para detalhes adicionais.

Este módulo fornece duas funções e uma exceção:

@geindex getopt() (no módulo getopt)
@anchor{library/getopt getopt getopt}@anchor{1503}
@deffn {Função} getopt.getopt (args, shortopts, longopts=[])

Analisa opções de linha de comando e lista de parâmetros. `args' é a lista de argumentos a ser analisada, sem a referência inicial para o programa em execução. Normalmente, isso significa @code{sys.argv[1:]}. `shortopts' é a string de letras de opção que o script deseja reconhecer, com opções que requerem um argumento seguido por dois pontos (@code{':'}; ou seja, o mesmo formato que Unix @code{getopt()} usa).

@cartouche
@quotation Nota 
Ao contrário do GNU @code{getopt()}, após um argumento sem opção, todos os argumentos adicionais são considerados também sem opção. Isso é semelhante à maneira como os sistemas Unix não GNU funcionam.
@end quotation
@end cartouche

`longopts', se especificado, deve ser uma lista de strings com os nomes das opções longas que devem ser suportadas. Os caracteres @code{'--'} no início não devem ser incluídos no nome da opção. Opções longas que requerem um argumento devem ser seguidas por um sinal de igual (@code{'='}). Argumentos opcionais não são suportados. Para aceitar apenas opções longas, `shortopts' deve ser uma string vazia. Opções longas na linha de comando podem ser reconhecidas, desde que forneçam um prefixo do nome da opção que corresponda exatamente a uma das opções aceitas. Por exemplo, se `longopts' for @code{['foo', 'frob']}, a opção @code{--fo} irá corresponder a @code{--foo}, mas @code{--f} não corresponderá exclusivamente, então @ref{4ae2,,GetoptError} será levantada.

O valor de retorno consiste em dois elementos: o primeiro é uma lista de pares @code{(option, value)}; a segunda é a lista de argumentos de programa restantes depois que a lista de opções foi removida (esta é uma fatia ao final de `args'). Cada par de opção e valor retornado tem a opção como seu primeiro elemento, prefixado com um hífen para opções curtas (por exemplo, @code{'-x'}) ou dois hifenes para opções longas (por exemplo, @code{'--long-option'}), e o argumento da opção como seu segundo elemento, ou uma string vazia se a opção não tiver argumento. As opções ocorrem na lista na mesma ordem em que foram encontradas, permitindo assim múltiplas ocorrências. Opções longas e curtas podem ser misturadas.
@end deffn

@geindex gnu_getopt() (no módulo getopt)
@anchor{library/getopt getopt gnu_getopt}@anchor{1502}
@deffn {Função} getopt.gnu_getopt (args, shortopts, longopts=[])

Esta função funciona como @ref{61,,getopt()}, exceto que o modo de digitalização do estilo GNU é usado por padrão. Isso significa que os argumentos de opção e não opção podem ser misturados. A função @ref{61,,getopt()} interrompe o processamento das opções assim que um argumento não opcional é encontrado.

Se o primeiro caractere da string de opção for @code{'+'}, ou se a variável de ambiente @code{POSIXLY_CORRECT} estiver definida, então o processamento da opção para assim que um argumento não opcional for encontrado.
@end deffn

@geindex GetoptError
@anchor{library/getopt getopt GetoptError}@anchor{4ae2}
@deffn {Exceção} getopt.GetoptError

Isso é levantado quando uma opção não reconhecida é encontrada na lista de argumentos ou quando uma opção que requer um argumento não é fornecida. O argumento para a exceção é uma string que indica a causa do erro. Para opções longas, um argumento dado a uma opção que não requer uma também fará com que essa exceção seja levantada. Os atributos @code{msg} e @code{opt} fornecem a mensagem de erro e a opção relacionada; se não houver uma opção específica à qual a exceção se relaciona, @code{opt} é uma string vazia.
@end deffn

@c XXX deprecated?

@geindex error
@anchor{library/getopt getopt error}@anchor{4ae3}
@deffn {Exceção} getopt.error

Apelido para @ref{4ae2,,GetoptError}; para compatibilidade reversa.
@end deffn

Um exemplo usando apenas opções 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 nomes de opções longos é 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

Em um script, o uso típico é algo assim:

@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"
    process(args, output=output, verbose=verbose)

if __name__ == "__main__":
    main()
@end example

Observe que uma interface de linha de comando equivalente pode ser produzida com menos código e mais mensagens de erro de ajuda e erro informativas usando o módulo @ref{a0,,optparse}:

@example
import optparse

if __name__ == '__main__':
    parser = optparse.OptionParser()
    parser.add_option('-o', '--output')
    parser.add_option('-v', dest='verbose', action='store_true')
    opts, args = parser.parse_args()
    process(args, output=opts.output, verbose=opts.verbose)
@end example

Uma interface de linha de comando aproximadamente equivalente para este caso também pode ser produzida usando o módulo @ref{6,,argparse}:

@example
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    parser.add_argument('rest', nargs='*')
    args = parser.parse_args()
    process(args.rest, output=args.output, verbose=args.verbose)
@end example

Veja @ref{3044,,Escolhendo uma biblioteca de análise de linha de comando} para detalhes sobre como a versão @code{argparse} deste código difere em comportamento da versão @code{optparse} (e @code{getopt}).


@subsubheading Ver também



@table @asis

@item Módulo @ref{a0,,optparse}

Análise de opções de linha de comando declarativa.

@item Módulo @ref{6,,argparse}

Opção de linha de comando e biblioteca de análise de argumentos mais opinativa.
@end table


@node Módulos removidos,Considerações de Segurança<3>,Módulos substituídos,A Biblioteca Padrão do Python
@anchor{library/removed doc}@anchor{4ae4}@anchor{library/removed removed}@anchor{4ae5}@anchor{library/removed removed-modules}@anchor{4ae6}@anchor{library/removed translation-repo}@anchor{4ae7}
@section Módulos removidos


Os módulos descritos neste capítulo foram removidos da biblioteca padrão do Python. Eles estão documentados aqui para ajudar as pessoas a encontrarem substituições.

@menu
* aifc — Lê e escreve arquivos AIFF e AIFC:: 
* asynchat — Manipulador de comando/resposta de socket assíncrono:: 
* asyncore — Manipulador de socket assíncrono:: 
* audioop — Manipulando dados de áudio original:: 
* cgi — Suporte a Common Gateway Interface:: 
* cgitb — Gerenciador de traceback para scripts de CGI:: 
* chunk — Lê dados em blocos IFF:: 
* crypt — Função para verificar senhas Unix:: 
* distutils — Criação e instalação de módulos do Python:: 
* imghdr — Determina o tipo de uma imagem:: 
* imp — Acessa os componentes internos de importação:: 
* mailcap — Manipulação de arquivo Mailcap:: 
* msilib — Lê e escreve arquivos do Microsoft Installer:: 
* nis — Interface para NIS da Sun (Yellow Pages): nis — Interface para NIS da Sun Yellow Pages. 
* nntplib — Cliente de protocolo NNTP:: 
* ossaudiodev — Acesso a dispositivos de áudio compatíveis com OSS:: 
* pipes — Interface para pipelines do shell:: 
* smtpd — Serviços SMTP:: 
* sndhdr — Determina o tipo de arquivos de som:: 
* spwd — O banco de dados de senhas shadow:: 
* sunau — Lê e escreve arquivos AU da Sun:: 
* telnetlib — cliente Telnet:: 
* uu — Codifica e decodifica arquivos uuencode:: 
* xdrlib — Codifica e decodifica dados XDR:: 

@end menu

@node aifc — Lê e escreve arquivos AIFF e AIFC,asynchat — Manipulador de comando/resposta de socket assíncrono,,Módulos removidos
@anchor{library/aifc doc}@anchor{4ae8}@anchor{library/aifc aifc-read-and-write-aiff-and-aifc-files}@anchor{4ae9}@anchor{library/aifc module-aifc}@anchor{5}
@subsection @code{aifc} — Lê e escreve arquivos AIFF e AIFC


@geindex module; aifc


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{aifc} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/aifc.html}.

@node asynchat — Manipulador de comando/resposta de socket assíncrono,asyncore — Manipulador de socket assíncrono,aifc — Lê e escreve arquivos AIFF e AIFC,Módulos removidos
@anchor{library/asynchat doc}@anchor{4aea}@anchor{library/asynchat asynchat-asynchronous-socket-command-response-handler}@anchor{4aeb}@anchor{library/asynchat module-asynchat}@anchor{9}@anchor{library/asynchat translation-repo}@anchor{4aec}
@subsection @code{asynchat} — Manipulador de comando/resposta de socket assíncrono


@geindex module; asynchat


Descontinuado desde a versão 3.6, removido na versão 3.12.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{502,,removido no Python 3.12} após ser descontinuado no Python 3.6. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

As aplicações devem usar o módulo @ref{a,,asyncio} em vez disso.

A última versão do Python que forneceu o módulo @code{asynchat} foi o Python 3.11@footnote{https://docs.python.org/3.11/library/asynchat.html}.

@node asyncore — Manipulador de socket assíncrono,audioop — Manipulando dados de áudio original,asynchat — Manipulador de comando/resposta de socket assíncrono,Módulos removidos
@anchor{library/asyncore doc}@anchor{4aed}@anchor{library/asyncore asyncore-asynchronous-socket-handler}@anchor{4aee}@anchor{library/asyncore module-asyncore}@anchor{b}@anchor{library/asyncore translation-repo}@anchor{4aef}
@subsection @code{asyncore} — Manipulador de socket assíncrono


@geindex module; asyncore


Descontinuado desde a versão 3.6, removido na versão 3.12.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{502,,removido no Python 3.12} após ser descontinuado no Python 3.6. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

As aplicações devem usar o módulo @ref{a,,asyncio} em vez disso.

A última versão do Python que forneceu o módulo @code{asyncore} foi o Python 3.11@footnote{https://docs.python.org/3.11/library/asyncore.html}.

@node audioop — Manipulando dados de áudio original,cgi — Suporte a Common Gateway Interface,asyncore — Manipulador de socket assíncrono,Módulos removidos
@anchor{library/audioop doc}@anchor{4af0}@anchor{library/audioop audioop-manipulate-raw-audio-data}@anchor{4af1}@anchor{library/audioop module-audioop}@anchor{d}@anchor{library/audioop translation-repo}@anchor{4af2}
@subsection @code{audioop}  — Manipulando dados de áudio original


@geindex module; audioop


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{audioop} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/audioop.html}.

@node cgi — Suporte a Common Gateway Interface,cgitb — Gerenciador de traceback para scripts de CGI,audioop — Manipulando dados de áudio original,Módulos removidos
@anchor{library/cgi doc}@anchor{4af3}@anchor{library/cgi cgi-common-gateway-interface-support}@anchor{4af4}@anchor{library/cgi module-cgi}@anchor{15}@anchor{library/cgi translation-repo}@anchor{4af5}
@subsection @code{cgi} — Suporte a Common Gateway Interface


@geindex module; cgi


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Um fork do módulo no PyPI pode ser usado em vez disso: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}. Esta é uma cópia do módulo cgi, não mais mantido ou suportado pela equipe core do Python.

A última versão do Python que forneceu o módulo @code{cgi} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/cgi.html}.

@node cgitb — Gerenciador de traceback para scripts de CGI,chunk — Lê dados em blocos IFF,cgi — Suporte a Common Gateway Interface,Módulos removidos
@anchor{library/cgitb doc}@anchor{4af6}@anchor{library/cgitb cgitb-traceback-manager-for-cgi-scripts}@anchor{4af7}@anchor{library/cgitb module-cgitb}@anchor{16}@anchor{library/cgitb translation-repo}@anchor{4af8}
@subsection @code{cgitb} — Gerenciador de traceback para scripts de CGI


@geindex module; cgitb


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Um fork do módulo no PyPI agora pode ser usado em vez disso: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}. Esta é uma cópia do módulo cgi, não mais mantido ou suportado pela equipe core do Python.

A última versão do Python que forneceu o módulo @code{cgitb} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/cgitb.html}.

@node chunk — Lê dados em blocos IFF,crypt — Função para verificar senhas Unix,cgitb — Gerenciador de traceback para scripts de CGI,Módulos removidos
@anchor{library/chunk doc}@anchor{4af9}@anchor{library/chunk chunk-read-iff-chunked-data}@anchor{4afa}@anchor{library/chunk module-chunk}@anchor{17}@anchor{library/chunk translation-repo}@anchor{4afb}
@subsection @code{chunk} — Lê dados em blocos IFF


@geindex module; chunk


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{chunk} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/chunk.html}.

@node crypt — Função para verificar senhas Unix,distutils — Criação e instalação de módulos do Python,chunk — Lê dados em blocos IFF,Módulos removidos
@anchor{library/crypt doc}@anchor{4afc}@anchor{library/crypt crypt-function-to-check-unix-passwords}@anchor{4afd}@anchor{library/crypt module-crypt}@anchor{28}@anchor{library/crypt translation-repo}@anchor{4afe}
@subsection @code{crypt} — Função para verificar senhas Unix


@geindex module; crypt


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

As aplicações podem usar o módulo @ref{68,,hashlib} da biblioteca padrão. Outras possíveis substituições são bibliotecas de terceiros do PyPI: legacycrypt@footnote{https://pypi.org/project/legacycrypt/}, bcrypt@footnote{https://pypi.org/project/bcrypt/} ou argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}. Elas não são suportadas nem mantidas pela equipe core do Python.

A última versão do Python que forneceu o módulo @code{crypt} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/crypt.html}.

@node distutils — Criação e instalação de módulos do Python,imghdr — Determina o tipo de uma imagem,crypt — Função para verificar senhas Unix,Módulos removidos
@anchor{library/distutils doc}@anchor{4aff}@anchor{library/distutils distutils-building-and-installing-python-modules}@anchor{4b00}@anchor{library/distutils module-distutils}@anchor{39}@anchor{library/distutils translation-repo}@anchor{4b01}
@subsection @code{distutils} — Criação e instalação de módulos do Python


@geindex module; distutils


Descontinuado desde a versão 3.10, removido na versão 3.12.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{508,,removido no Python 3.12} após ser descontinuado no Python 3.10. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}, a qual tem um conselho de migração@footnote{https://peps.python.org/pep-0632/#migration-advice}.

A última versão do Python que forneceu o módulo @code{distutils} foi o Python 3.11@footnote{https://docs.python.org/3.11/library/distutils.html}.

@node imghdr — Determina o tipo de uma imagem,imp — Acessa os componentes internos de importação,distutils — Criação e instalação de módulos do Python,Módulos removidos
@anchor{library/imghdr doc}@anchor{4b02}@anchor{library/imghdr imghdr-determine-the-type-of-an-image}@anchor{4b03}@anchor{library/imghdr module-imghdr}@anchor{75}@anchor{library/imghdr translation-repo}@anchor{4b04}
@subsection @code{imghdr} — Determina o tipo de uma imagem


@geindex module; imghdr


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possíveis substituições são bibliotecas de terceiros do PyPI: filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} ou python-magic@footnote{https://pypi.org/project/python-magic/}. Eles não são suportados ou mantidos pela equipe principal do Python.

A última versão do Python que forneceu o módulo @code{imghdr} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/imghdr.html}.

@node imp — Acessa os componentes internos de importação,mailcap — Manipulação de arquivo Mailcap,imghdr — Determina o tipo de uma imagem,Módulos removidos
@anchor{library/imp doc}@anchor{4b05}@anchor{library/imp imp-access-the-import-internals}@anchor{4b06}@anchor{library/imp module-imp}@anchor{76}@anchor{library/imp translation-repo}@anchor{4b07}
@subsection @code{imp} — Acessa os componentes internos de importação


@geindex module; imp


Descontinuado desde a versão 3.4, removido na versão 3.12.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{512,,removido no Python 3.12} após ser descontinuado no Python 3.4.

O @ref{512,,aviso de remoção} inclui orientação para migrar código de @code{imp} para @ref{77,,importlib}.

A última versão do Python que forneceu o módulo @code{imp} foi o Python 3.11@footnote{https://docs.python.org/3.11/library/imp.html}.

@node mailcap — Manipulação de arquivo Mailcap,msilib — Lê e escreve arquivos do Microsoft Installer,imp — Acessa os componentes internos de importação,Módulos removidos
@anchor{library/mailcap doc}@anchor{4b08}@anchor{library/mailcap mailcap-mailcap-file-handling}@anchor{4b09}@anchor{library/mailcap module-mailcap}@anchor{8c}@anchor{library/mailcap translation-repo}@anchor{4b0a}
@subsection @code{mailcap} — Manipulação de arquivo Mailcap


@geindex module; mailcap


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{mailcap} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/mailcap.html}.

@node msilib — Lê e escreve arquivos do Microsoft Installer,nis — Interface para NIS da Sun Yellow Pages,mailcap — Manipulação de arquivo Mailcap,Módulos removidos
@anchor{library/msilib doc}@anchor{4b0b}@anchor{library/msilib module-msilib}@anchor{92}@anchor{library/msilib msilib-read-and-write-microsoft-installer-files}@anchor{4b0c}@anchor{library/msilib translation-repo}@anchor{4b0d}
@subsection @code{msilib} — Lê e escreve arquivos do Microsoft Installer


@geindex module; msilib


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{msilib} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/msilib.html}.

@node nis — Interface para NIS da Sun Yellow Pages,nntplib — Cliente de protocolo NNTP,msilib — Lê e escreve arquivos do Microsoft Installer,Módulos removidos
@anchor{library/nis doc}@anchor{4b0e}@anchor{library/nis module-nis}@anchor{9c}@anchor{library/nis nis-interface-to-suns-nis-yellow-pages}@anchor{4b0f}@anchor{library/nis translation-repo}@anchor{4b10}
@subsection @code{nis} — Interface para NIS da Sun (Yellow Pages)


@geindex module; nis


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{nis} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/nis.html}.

@node nntplib — Cliente de protocolo NNTP,ossaudiodev — Acesso a dispositivos de áudio compatíveis com OSS,nis — Interface para NIS da Sun Yellow Pages,Módulos removidos
@anchor{library/nntplib doc}@anchor{4b11}@anchor{library/nntplib module-nntplib}@anchor{9d}@anchor{library/nntplib nntplib-nntp-protocol-client}@anchor{4b12}@anchor{library/nntplib translation-repo}@anchor{4b13}
@subsection @code{nntplib} — Cliente de protocolo NNTP


@geindex module; nntplib


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{nntplib} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/nntplib.html}.

@node ossaudiodev — Acesso a dispositivos de áudio compatíveis com OSS,pipes — Interface para pipelines do shell,nntplib — Cliente de protocolo NNTP,Módulos removidos
@anchor{library/ossaudiodev doc}@anchor{4b14}@anchor{library/ossaudiodev module-ossaudiodev}@anchor{a3}@anchor{library/ossaudiodev ossaudiodev-access-to-oss-compatible-audio-devices}@anchor{4b15}@anchor{library/ossaudiodev translation-repo}@anchor{4b16}
@subsection @code{ossaudiodev} — Acesso a dispositivos de áudio compatíveis com OSS


@geindex module; ossaudiodev


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{ossaudiodev} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/ossaudiodev.html}.

@node pipes — Interface para pipelines do shell,smtpd — Serviços SMTP,ossaudiodev — Acesso a dispositivos de áudio compatíveis com OSS,Módulos removidos
@anchor{library/pipes doc}@anchor{4b17}@anchor{library/pipes module-pipes}@anchor{a8}@anchor{library/pipes pipes-interface-to-shell-pipelines}@anchor{4b18}@anchor{library/pipes translation-repo}@anchor{4b19}
@subsection @code{pipes} — Interface para pipelines do shell


@geindex module; pipes


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

As aplicações devem usar o módulo @ref{d6,,subprocess} em vez disso.

A última versão do Python que forneceu o módulo @code{pipes} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/pipes.html}.

@node smtpd — Serviços SMTP,sndhdr — Determina o tipo de arquivos de som,pipes — Interface para pipelines do shell,Módulos removidos
@anchor{library/smtpd doc}@anchor{4b1a}@anchor{library/smtpd module-smtpd}@anchor{c9}@anchor{library/smtpd smtpd-smtp-server}@anchor{4b1b}@anchor{library/smtpd translation-repo}@anchor{4b1c}
@subsection @code{smtpd} — Serviços SMTP


@geindex module; smtpd


Descontinuado desde a versão 3.6, removido na versão 3.12.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{502,,removido no Python 3.12} após ser descontinuado no Python 3.6. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Uma possível substituição é a biblioteca de terceiros aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/}. Esta biblioteca não é mantida ou suportada pela equipe principal do Python.

A última versão do Python que forneceu o módulo @code{smtpd} foi o Python 3.11@footnote{https://docs.python.org/3.11/library/smtpd.html}.

@node sndhdr — Determina o tipo de arquivos de som,spwd — O banco de dados de senhas shadow,smtpd — Serviços SMTP,Módulos removidos
@anchor{library/sndhdr doc}@anchor{4b1d}@anchor{library/sndhdr module-sndhdr}@anchor{cb}@anchor{library/sndhdr sndhdr-determine-type-of-sound-file}@anchor{4b1e}@anchor{library/sndhdr translation-repo}@anchor{4b1f}
@subsection @code{sndhdr} — Determina o tipo de arquivos de som


@geindex module; sndhdr


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possíveis substituições são módulos de terceiros do PyPI: filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} ou python-magic@footnote{https://pypi.org/project/python-magic/}. Eles não são suportados ou mantidos pela equipe principal do Python.

A última versão do Python que forneceu o módulo @code{sndhdr} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/sndhdr.html}.

@node spwd — O banco de dados de senhas shadow,sunau — Lê e escreve arquivos AU da Sun,sndhdr — Determina o tipo de arquivos de som,Módulos removidos
@anchor{library/spwd doc}@anchor{4b20}@anchor{library/spwd module-spwd}@anchor{ce}@anchor{library/spwd spwd-the-shadow-password-database}@anchor{4b21}@anchor{library/spwd translation-repo}@anchor{4b22}
@subsection @code{spwd} — O banco de dados de senhas shadow


@geindex module; spwd


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Uma possível substituição é a biblioteca de terceiros python-pam@footnote{https://pypi.org/project/python-pam/}. Esta biblioteca não é suportada ou mantida pela equipe principal do Python.

A última versão do Python que forneceu o módulo @code{spwd} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/spwd.html}.

@node sunau — Lê e escreve arquivos AU da Sun,telnetlib — cliente Telnet,spwd — O banco de dados de senhas shadow,Módulos removidos
@anchor{library/sunau doc}@anchor{4b23}@anchor{library/sunau module-sunau}@anchor{d7}@anchor{library/sunau sunau-read-and-write-sun-au-files}@anchor{4b24}@anchor{library/sunau translation-repo}@anchor{4b25}
@subsection @code{sunau} — Lê e escreve arquivos AU da Sun


@geindex module; sunau


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{sunau} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/sunau.html}.

@node telnetlib — cliente Telnet,uu — Codifica e decodifica arquivos uuencode,sunau — Lê e escreve arquivos AU da Sun,Módulos removidos
@anchor{library/telnetlib doc}@anchor{4b26}@anchor{library/telnetlib module-telnetlib}@anchor{df}@anchor{library/telnetlib telnetlib-telnet-client}@anchor{4b27}@anchor{library/telnetlib translation-repo}@anchor{4b28}
@subsection @code{telnetlib} — cliente Telnet


@geindex module; telnetlib


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

Possíveis substituições são bibliotecas de terceiros do PyPI: telnetlib3@footnote{https://pypi.org/project/telnetlib3/} ou Exscript@footnote{https://pypi.org/project/Exscript/}. Elas não são suportadas ou mantidas pela equipe principal do Python.

A última versão do Python que forneceu o módulo @code{telnetlib} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/telnetlib.html}.

@node uu — Codifica e decodifica arquivos uuencode,xdrlib — Codifica e decodifica dados XDR,telnetlib — cliente Telnet,Módulos removidos
@anchor{library/uu doc}@anchor{4b29}@anchor{library/uu module-uu}@anchor{10f}@anchor{library/uu translation-repo}@anchor{4b2a}@anchor{library/uu uu-encode-and-decode-uuencode-files}@anchor{4b2b}
@subsection @code{uu} — Codifica e decodifica arquivos uuencode


@geindex module; uu


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{uu} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/uu.html}.

@node xdrlib — Codifica e decodifica dados XDR,,uu — Codifica e decodifica arquivos uuencode,Módulos removidos
@anchor{library/xdrlib doc}@anchor{4b2c}@anchor{library/xdrlib module-xdrlib}@anchor{11f}@anchor{library/xdrlib translation-repo}@anchor{4b2d}@anchor{library/xdrlib xdrlib-encode-and-decode-xdr-data}@anchor{4b2e}
@subsection @code{xdrlib} — Codifica e decodifica dados XDR


@geindex module; xdrlib


Descontinuado desde a versão 3.11, removido na versão 3.13.


Este módulo não faz mais parte da biblioteca padrão do Python. Ele foi @ref{143,,removido no Python 3.13} após ser descontinuado no Python 3.11. A remoção foi decidida na 
@geindex Propostas de Melhorias do Python; PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}.

A última versão do Python que forneceu o módulo @code{xdrlib} foi o Python 3.12@footnote{https://docs.python.org/3.12/library/xdrlib.html}.

@geindex considerações de segurança
@anchor{library/security_warnings security-warnings}@anchor{4b2f}
@node Considerações de Segurança<3>,,Módulos removidos,A Biblioteca Padrão do Python
@anchor{library/security_warnings doc}@anchor{4b30}@anchor{library/security_warnings security-considerations}@anchor{4b31}@anchor{library/security_warnings translation-repo}@anchor{4b32}
@section Considerações de Segurança


Os módulos a seguir têm considerações de segurança específicas:


@itemize *

@item 
@ref{e,,base64}: @ref{3965,,considerações de segurança do base64} na 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}

@item 
@ref{68,,hashlib}: @ref{2caa,,todos os construtores usam um argumento somente-nomeado “usedforsecurity”@comma{} desativando algoritmos conhecidos não seguros e bloqueados}

@item 
@ref{72,,http.server} não é adequado para uso em produção, implementando apenas verificações básicas de segurança. Veja as @ref{3da0,,considerações de segurança}.

@item 
@ref{87,,logging}: @ref{2e92,,configuração do Logging usa eval()}

@item 
@ref{94,,multiprocessing}: @ref{336a,,Connection.recv() usa pickle}

@item 
@ref{a6,,pickle}: @ref{2a52,,Restringindo globais no pickle}

@item 
@ref{b8,,random} não deve ser usado para o propósito de segurança. Em vez disso, use @ref{c0,,secrets}

@item 
@ref{c3,,shelve}: @ref{2a70,,shelve é baseado no pickle e@comma{} portanto@comma{} inadequado para lidar com fontes não confiáveis}

@item 
@ref{d0,,ssl}: @ref{354c,,Considerações de segurança de SSL/TLS}

@item 
@ref{d6,,subprocess}: @ref{340e,,Considerações de segurança de Subprocess}

@item 
@ref{e0,,tempfile}: @ref{2a0d,,mktemp foi descontinuado em razão de vulnerabilidade de condições de corrida}

@item 
@ref{120,,xml}: @ref{3999,,Segurança no XML}

@item 
@ref{131,,zipfile}: @ref{2bbb,,Arquivos .zip preparados de forma maliciosa podem causar esgotamento do volume do disco}
@end itemize

A opção de linha de comando @ref{965,,-I} pode ser usada para executar o Python no modo isolado. Quando não pode ser usado, a opção @ref{5a4,,-P} ou a variável de ambiente 
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH} pode ser usada para não preceder um caminho potencialmente inseguro para @ref{3b4,,sys.path} como o diretório atual, o diretório do script ou uma string vazia.

@node Estendendo e incorporando o interpretador Python,Manual de referência da API Python/C,A Biblioteca Padrão do Python,Top
@anchor{extending/index doc}@anchor{4b33}@anchor{extending/index extending-and-embedding-the-python-interpreter}@anchor{4b34}@anchor{extending/index extending-index}@anchor{1d56}@anchor{extending/index translation-repo}@anchor{4b35}
@chapter Estendendo e incorporando o interpretador Python


Neste documento descreveremos o desenvolvimento de módulos com C ou C++ para adicionar recursos ao interpretador Python criando novos módulos. Esses módulos podem não somente definir novas funções, mas também novos tipos de objetos e seu conjunto de métodos. O documento também descreve como incorporar o interpretador Python em outro aplicativo, de forma a utilizá-lo como sendo uma extensão da linguagem. Por fim, estudaremos como podemos compilar e fazer a vinculação dos módulos de extensão para que estes possam ser carregados dinamicamente (em tempo de execução) pelo interpretador, caso o sistema operacional subjacente suportar esse recurso.

Este documento pressupõe conhecimentos básicos sobre Python. Para uma introdução informal à linguagem, consulte @ref{1d55,,O tutorial do Python}. @ref{145,,A Referência da Linguagem Python} fornece uma definição mais formal da linguagem. @ref{144,,A Biblioteca Padrão do Python} documenta os tipos, funções e módulos de objetos existentes (embutidos e escritos em Python) que dão à linguagem sua ampla gama de aplicações.

Para uma descrição detalhada de toda a API Python/C, consulte o @ref{1d57,,Manual de referência da API Python/C} separado.

@menu
* Ferramentas de terceiros recomendadas:: 
* Criando extensões sem ferramentas de terceiros:: 
* Incorporando o tempo de execução do CPython em uma aplicação maior:: 

@end menu

@node Ferramentas de terceiros recomendadas,Criando extensões sem ferramentas de terceiros,,Estendendo e incorporando o interpretador Python
@anchor{extending/index recommended-third-party-tools}@anchor{4b36}
@section Ferramentas de terceiros recomendadas


Este guia aborda apenas as ferramentas básicas para a criação de extensões fornecidas como parte desta versão do CPython. Algumas @ref{4b37,,ferramentas de terceiros} oferecem abordagens mais simples e mais sofisticadas para a criação de extensões em C e C++ para Python.

@node Criando extensões sem ferramentas de terceiros,Incorporando o tempo de execução do CPython em uma aplicação maior,Ferramentas de terceiros recomendadas,Estendendo e incorporando o interpretador Python
@anchor{extending/index creating-extensions-without-third-party-tools}@anchor{4b38}
@section Criando extensões sem ferramentas de terceiros


Esta seção do guia aborda a criação de extensões C e C++ sem assistência de ferramentas de terceiros. Destina-se principalmente aos criadores dessas ferramentas, em vez de ser uma maneira recomendada de criar suas próprias extensões C.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} – Inicialização de módulo extensão multifase


@menu
* Estendendo Python com C ou C++:: 
* Definindo Tipos de Extensão; Tutorial: Definindo Tipos de Extensão Tutorial. 
* Defining Extension Types; Assorted Topics: Defining Extension Types Assorted Topics. 
* Construindo extensões C e C++:: 
* Construindo Extensões C e C++ no Windows:: 

@end menu

@node Estendendo Python com C ou C++,Definindo Tipos de Extensão Tutorial,,Criando extensões sem ferramentas de terceiros
@anchor{extending/extending doc}@anchor{4b39}@anchor{extending/extending extending-intro}@anchor{4b3a}@anchor{extending/extending extending-python-with-c-or-c}@anchor{4b3b}
@subsection Estendendo Python com C ou C++


É muito fácil adicionar novos módulos embutidos ao Python, se você souber programar em C. Você pode adicionar `módulos de extensão' para fazer duas coisas que não podem ser feitas diretamente no Python: eles podem implementar novos nos tipos de objetos embutidos e eles podem chamar funções da biblioteca C e chamadas do sistema.

Para dar suporte a extensões, a API do Python API (Application Programmers Interface) define um conjunto de funções, macros e variáveis que fornecem acesso à maior parte dos aspectos do sistema de tempo de execução do Python.  A API do Python pode ser incorporada em um arquivo fonte em C com a inclusão do cabeçalho @code{"Python.h"}.

A compilação de um módulo de extensão depende do uso pretendido e da configuração do sistema; detalhes serão dados nos próximos capítulos.

@cartouche
@quotation Nota 
A interface de extensões em C é específica para o CPython, e módulos de extensão não funcionam em outras implementações do Python.  Em muitos casos, é possível evitar a criação destas extensões em C e preservar a portabilidade para outras implementações. Por exemplo, se o seu caso de uso for o de fazer chamadas a funções em bibliotecas C ou chamadas de sistema, considere utilizar o módulo @ref{2a,,ctypes} ou a biblioteca cffi@footnote{https://cffi.readthedocs.io/} ao invés de escrever código C personalizado. Esses módulos permitem escrever código Python que pode interoperar com código C e que é mais portável entre implementações do Python do que escrever e compilar um módulo de extensão em C.
@end quotation
@end cartouche

@menu
* Um Exemplo Simples:: 
* Intermezzo; erros e exceções: Intermezzo erros e exceções. 
* De volta ao exemplo:: 
* A tabela de métodos e a função de inicialização do módulo:: 
* Compilação e vinculação:: 
* Chamando funções Python de C:: 
* Extraindo parâmetros em funções de extensão:: 
* Parâmetros nomeados para funções de extensão:: 
* Construindo valores arbitrários:: 
* Contagens de referências:: 
* Escrevendo extensões em C++:: 
* Fornecendo uma API C para um módulo de extensão:: 

@end menu

@node Um Exemplo Simples,Intermezzo erros e exceções,,Estendendo Python com C ou C++
@anchor{extending/extending a-simple-example}@anchor{4b3c}@anchor{extending/extending extending-simpleexample}@anchor{4b3d}
@subsubsection Um Exemplo Simples


Vamos criar um módulo de extensão chamado @code{spam} (a comida favorita dos fãs de Monty Python…) e digamos que nosso objetivo seja criar uma interface em Python para a função da biblioteca C @code{system()} @footnote{
Uma interface para esta função já existe no módulo padrão @ref{a1,,os} — ela foi escolhida como um exemplo simples e direto.
}. Essa função toma uma string de caracteres terminada em nulo como argumento e retorna um número inteiro. Queremos que essa função seja chamável a partir do Python como abaixo:

@example
>>> import spam
>>> status = spam.system("ls -l")
@end example

Comece criando um arquivo chamado @code{spammodule.c}.  (Historicamente, se um módulo for chamado @code{spam}, o arquivo C contendo sua implementação é chamado @code{spammodule.c}; se o nome do módulo for muito longo, como @code{spammify}, o nome do arquivo pode ser só @code{spammify.c}.)

As duas primeiras linhas do nosso arquivo podem ser:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

o que carrega a API do Python (você pode adicionar um comentário descrevendo o propósito do módulo e uma nota de copyright, se desejar).

@cartouche
@quotation Nota 
Uma vez que Python pode definir algumas definições de pré-processador que afetam os cabeçalhos padrão em alguns sistemas, você `deve' incluir @code{Python.h} antes de quaisquer cabeçalhos padrão serem incluídos.

@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{38b,,Strings e buffers} for a description of this macro.
@end quotation
@end cartouche

All user-visible symbols defined by @code{Python.h} have a prefix of @code{Py} or
@code{PY}, except those defined in standard header files.

@cartouche
@quotation Dica 
For backward compatibility, @code{Python.h} includes several standard header files.
C extensions should include the standard headers that they use,
and should not rely on these implicit includes.
If using the limited C API version 3.13 or newer, the implicit includes are:


@itemize *

@item 
@code{<assert.h>}

@item 
@code{<intrin.h>} (on Windows)

@item 
@code{<inttypes.h>}

@item 
@code{<limits.h>}

@item 
@code{<math.h>}

@item 
@code{<stdarg.h>}

@item 
@code{<wchar.h>}

@item 
@code{<sys/types.h>} (if present)
@end itemize

If @ref{41e,,Py_LIMITED_API} is not defined, or is set to version 3.12 or older,
the headers below are also included:


@itemize *

@item 
@code{<ctype.h>}

@item 
@code{<unistd.h>} (on POSIX)
@end itemize

If @ref{41e,,Py_LIMITED_API} is not defined, or is set to version 3.10 or older,
the headers below are also included:


@itemize *

@item 
@code{<errno.h>}

@item 
@code{<stdio.h>}

@item 
@code{<stdlib.h>}

@item 
@code{<string.h>}
@end itemize
@end quotation
@end cartouche

A próxima coisa que adicionamos ao nosso arquivo de módulo é a função C que será chamada quando a expressão Python @code{spam.system(string)} for avaliada (veremos em breve como ela acaba sendo chamada):

@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

There is a straightforward translation from the argument list in Python (for
example, the single expression @code{"ls -l"}) to the arguments passed to the C
function.  The C function always has two arguments, conventionally named `self'
and `args'.

O argumento `self' aponta para o objeto do módulo para funções de nível de módulo; para um método, ele apontaria para a instância do objeto.

The `args' argument will be a pointer to a Python tuple object containing the
arguments.  Each item of the tuple corresponds to an argument in the call’s
argument list.  The arguments are Python objects — in order to do anything
with them in our C function we have to convert them to C values.  The function
@ref{571,,PyArg_ParseTuple()} in the Python API checks the argument types and
converts them to C values.  It uses a template string to determine the required
types of the arguments as well as the types of the C variables into which to
store the converted values.  More about this later.

@ref{571,,PyArg_ParseTuple()} returns true (nonzero) if all arguments have the right
type and its components have been stored in the variables whose addresses are
passed.  It returns false (zero) if an invalid argument list was passed.  In the
latter case it also raises an appropriate exception so the calling function can
return @code{NULL} immediately (as we saw in the example).

@node Intermezzo erros e exceções,De volta ao exemplo,Um Exemplo Simples,Estendendo Python com C ou C++
@anchor{extending/extending extending-errors}@anchor{4b3e}@anchor{extending/extending intermezzo-errors-and-exceptions}@anchor{4b3f}
@subsubsection Intermezzo: erros e exceções


An important convention throughout the Python interpreter is the following: when
a function fails, it should set an exception condition and return an error value
(usually @code{-1} or a @code{NULL} pointer).  Exception information is stored in
three members of the interpreter’s thread state.  These are @code{NULL} if
there is no exception.  Otherwise they are the C equivalents of the members
of the Python tuple returned by @ref{68a,,sys.exc_info()}.  These are the
exception type, exception instance, and a traceback object.  It is important
to know about them to understand how errors are passed around.

A API Python define uma série de funções para definir vários tipos de exceções.

The most common one is @ref{57c,,PyErr_SetString()}.  Its arguments are an exception
object and a C string.  The exception object is usually a predefined object like
@ref{4b40,,PyExc_ZeroDivisionError}.  The C string indicates the cause of the error
and is converted to a Python string object and stored as the “associated value”
of the exception.

Another useful function is @ref{4b41,,PyErr_SetFromErrno()}, which only takes an
exception argument and constructs the associated value by inspection of the
global variable @code{errno}.  The most general function is
@ref{57b,,PyErr_SetObject()}, which takes two object arguments, the exception and
its associated value.  You don’t need to @ref{56e,,Py_INCREF()} the objects passed
to any of these functions.

You can test non-destructively whether an exception has been set with
@ref{1a3b,,PyErr_Occurred()}.  This returns the current exception object, or @code{NULL}
if no exception has occurred.  You normally don’t need to call
@ref{1a3b,,PyErr_Occurred()} to see whether an error occurred in a function call,
since you should be able to tell from the return value.

When a function `f' that calls another function `g' detects that the latter
fails, `f' should itself return an error value (usually @code{NULL} or @code{-1}).  It
should `not' call one of the @code{PyErr_*} functions — one has already
been called by `g'. `f'’s caller is then supposed to also return an error
indication to `its' caller, again `without' calling @code{PyErr_*}, and so on
— the most detailed cause of the error was already reported by the function
that first detected it.  Once the error reaches the Python interpreter’s main
loop, this aborts the currently executing Python code and tries to find an
exception handler specified by the Python programmer.

(There are situations where a module can actually give a more detailed error
message by calling another @code{PyErr_*} function, and in such cases it is
fine to do so.  As a general rule, however, this is not necessary, and can cause
information about the cause of the error to be lost: most operations can fail
for a variety of reasons.)

To ignore an exception set by a function call that failed, the exception
condition must be cleared explicitly by calling @ref{1069,,PyErr_Clear()}.  The only
time C code should call @ref{1069,,PyErr_Clear()} is if it doesn’t want to pass the
error on to the interpreter but wants to handle it completely by itself
(possibly by trying something else, or pretending nothing went wrong).

Every failing @code{malloc()} call must be turned into an exception — the
direct caller of @code{malloc()} (or @code{realloc()}) must call
@ref{4b42,,PyErr_NoMemory()} and return a failure indicator itself.  All the
object-creating functions (for example, @ref{195a,,PyLong_FromLong()}) already do
this, so this note is only relevant to those who call @code{malloc()} directly.

Also note that, with the important exception of @ref{571,,PyArg_ParseTuple()} and
friends, functions that return an integer status usually return a positive value
or zero for success and @code{-1} for failure, like Unix system calls.

Finally, be careful to clean up garbage (by making @ref{78f,,Py_XDECREF()} or
@ref{56f,,Py_DECREF()} calls for objects you have already created) when you return
an error indicator!

The choice of which exception to raise is entirely yours.  There are predeclared
C objects corresponding to all built-in Python exceptions, such as
@ref{4b40,,PyExc_ZeroDivisionError}, which you can use directly. Of course, you
should choose exceptions wisely — don’t use @ref{4b43,,PyExc_TypeError} to mean
that a file couldn’t be opened (that should probably be @ref{4b44,,PyExc_OSError}).
If something’s wrong with the argument list, the @ref{571,,PyArg_ParseTuple()}
function usually raises @ref{4b43,,PyExc_TypeError}.  If you have an argument whose
value must be in a particular range or must satisfy other conditions,
@ref{4b45,,PyExc_ValueError} is appropriate.

You can also define a new exception that is unique to your module.
The simplest way to do this is to declare a static global object variable at
the beginning of the file:

@example
static PyObject *SpamError = NULL;
@end example

and initialize it by calling @ref{12ab,,PyErr_NewException()} in the module’s
@ref{985,,Py_mod_exec} function (@code{spam_module_exec()}):

@example
SpamError = PyErr_NewException("spam.error", NULL, NULL);
@end example

Since @code{SpamError} is a global variable, it will be overwritten every time
the module is reinitialized, when the @ref{985,,Py_mod_exec} function is called.

For now, let’s avoid the issue: we will block repeated initialization by raising an
@ref{419,,ImportError}:

@example
static PyObject *SpamError = NULL;

static int
spam_module_exec(PyObject *m)
@{
    if (SpamError != NULL) @{
        PyErr_SetString(PyExc_ImportError,
                        "cannot initialize spam module more than once");
        return -1;
    @}
    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    if (PyModule_AddObjectRef(m, "SpamError", SpamError) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot spam_module_slots[] = @{
    @{Py_mod_exec, spam_module_exec@},
    @{0, NULL@}
@};

static struct PyModuleDef spam_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    .m_size = 0,  // non-negative
    .m_slots = spam_module_slots,
@};

PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModuleDef_Init(&spam_module);
@}
@end example

Note that the Python name for the exception object is @code{spam.error}.  The
@ref{12ab,,PyErr_NewException()} function may create a class with the base class
being @ref{9e2,,Exception} (unless another class is passed in instead of @code{NULL}),
described in @ref{19b1,,Exceções embutidas}.

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.

For now, the @ref{56f,,Py_DECREF()} call to remove this reference is missing.
Even when the Python interpreter shuts down, the global @code{SpamError}
variable will not be garbage-collected. It will “leak”.
We did, however, ensure that this will happen at most once per process.

We discuss the use of @ref{151b,,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{57c,,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 volta ao exemplo,A tabela de métodos e a função de inicialização do módulo,Intermezzo erros e exceções,Estendendo Python com C ou C++
@anchor{extending/extending back-to-the-example}@anchor{4b46}@anchor{extending/extending backtoexample}@anchor{4b47}
@subsubsection De volta ao exemplo


Going back to our example function, you should now be able to understand this
statement:

@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{571,,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}).

The next statement is a call to the Unix function @code{system()}, passing it
the string we just got from @ref{571,,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{195a,,PyLong_FromLong()}.

@example
return PyLong_FromLong(sts);
@end example

Neste caso, ele retornará um objeto inteiro (sim, até mesmo inteiros são objetos no heap em Python!)

If you have a C function that returns no useful argument (a function returning
void), the corresponding Python function must return @code{None}.   You
need this idiom to do so (which is implemented by the @ref{14bb,,Py_RETURN_NONE}
macro):

@example
Py_INCREF(Py_None);
return Py_None;
@end example

@ref{4b48,,Py_None} is the C name for the special Python object @code{None}.  It is a
genuine Python object rather than a @code{NULL} pointer, which means “error” in most
contexts, as we have seen.

@node A tabela de métodos e a função de inicialização do módulo,Compilação e vinculação,De volta ao exemplo,Estendendo Python com C ou C++
@anchor{extending/extending methodtable}@anchor{4b49}@anchor{extending/extending the-module-s-method-table-and-initialization-function}@anchor{4b4a}
@subsubsection A tabela de métodos e a função de inicialização do módulo


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 spam_methods[] = @{
    ...
    @{"system",  spam_system, METH_VARARGS,
     "Execute a shell command."@},
    ...
    @{NULL, NULL, 0, NULL@}        /* Sentinel */
@};
@end example

Note the third entry (@code{METH_VARARGS}).  This is a flag telling the interpreter
the calling convention to be used for the C function.  It should normally always
be @code{METH_VARARGS} or @code{METH_VARARGS | METH_KEYWORDS}; a value of @code{0} means
that an obsolete variant of @ref{571,,PyArg_ParseTuple()} is used.

When using only @code{METH_VARARGS}, the function should expect the Python-level
parameters to be passed in as a tuple acceptable for parsing via
@ref{571,,PyArg_ParseTuple()}; more information on this function is provided below.

The @ref{4b4b,,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{383,,PyArg_ParseTupleAndKeywords()} to parse the arguments to such a
function.

A tabela de métodos deve ser referenciada na estrutura de definição do módulo:

@example
static struct PyModuleDef spam_module = @{
    ...
    .m_methods = spam_methods,
    ...
@};
@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 PyModuleDef_Init(&spam_module);
@}
@end example

Note that @ref{151b,,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"}.

@code{PyInit_spam()} is called when each interpreter imports its module
@code{spam} for the first time.  (See below for comments about embedding Python.)
A pointer to the module definition must be returned via @ref{4b4c,,PyModuleDef_Init()},
so that the import machinery can create the module and store it in @code{sys.modules}.

When embedding Python, the @code{PyInit_spam()} function is not called
automatically unless there’s an entry in the @ref{18a3,,PyImport_Inittab} table.
To add the module to the initialization table, use @ref{18a4,,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 
If you declare a global variable or a local static one, the module may
experience unintended side-effects on re-initialisation, for example when
removing entries from @code{sys.modules} or importing compiled modules into
multiple interpreters within a process
(or following a @code{fork()} without an intervening @code{exec()}).
If module state is not yet fully @ref{4b4d,,isolated},
authors should consider marking the module as having no support for subinterpreters
(via @ref{4b4e,,Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED}).
@end quotation
@end cartouche

A more substantial example module is included in the Python source distribution
as @code{Modules/xxlimited.c}.  This file may be used as a template or simply
read as an example.

@node Compilação e vinculação,Chamando funções Python de C,A tabela de métodos e a função de inicialização do módulo,Estendendo Python com C ou C++
@anchor{extending/extending compilation}@anchor{4b4f}@anchor{extending/extending compilation-and-linkage}@anchor{4b50}
@subsubsection Compilação e vinculação


Há mais duas coisas a fazer antes de usar sua nova extensão: compilá-la e vinculá-la ao sistema Python. Se você usa carregamento dinâmico, os detalhes podem depender do estilo de carregamento dinâmico que seu sistema utiliza; consulte os capítulos sobre construção de módulos de extensão (capítulo @ref{4b51,,Construindo extensões C e C++}) e informações adicionais referentes apenas à construção no Windows (capítulo @ref{1fbf,,Construindo Extensões C e C++ no Windows}) para obter mais informações sobre isso.

If you can’t use dynamic loading, or if you want to make your module a permanent
part of the Python interpreter, you will have to change the configuration setup
and rebuild the interpreter.  Luckily, this is very simple on Unix: just place
your file (@code{spammodule.c} for example) in the @code{Modules/} directory
of an unpacked source distribution, add a line to the file
@code{Modules/Setup.local} describing your file:

@example
spam spammodule.o
@end example

and rebuild the interpreter by running @code{make} in the toplevel
directory.  You can also run @code{make} in the @code{Modules/}
subdirectory, but then you must first rebuild @code{Makefile} there by running
‘@code{make} Makefile’.  (This is necessary each time you change the
@code{Setup} file.)

If your module requires additional libraries to link with, these can be listed
on the line in the configuration file as well, for instance:

@example
spam spammodule.o -lX11
@end example

@node Chamando funções Python de C,Extraindo parâmetros em funções de extensão,Compilação e vinculação,Estendendo Python com C ou C++
@anchor{extending/extending calling-python-functions-from-c}@anchor{4b52}@anchor{extending/extending callingpython}@anchor{4b53}
@subsubsection Chamando funções Python de C


Até agora, nos concentramos em tornar funções C chamáveis a partir de Python. O inverso também é útil: chamar funções Python a partir de C. Isso é especialmente verdadeiro para bibliotecas que oferecem suporte às chamadas funções de “callback”. Se uma interface C utiliza callbacks, o Python equivalente frequentemente precisa fornecer um mecanismo de callback ao programador Python; a implementação exigirá a chamada das funções de callback Python a partir de um callback C. Outros usos também são imagináveis.

Felizmente, o interpretador Python é facilmente chamado recursivamente, e há uma interface padrão para chamar uma função Python. (Não vou me aprofundar em como chamar o analisador sintático do Python com uma string específica como entrada — se você estiver interessado, dê uma olhada na implementação da opção de linha de comando @ref{5e0,,-c} em @code{Modules/main.c} do código-fonte Python.)

Calling a Python function is easy.  First, the Python program must somehow pass
you the Python function object.  You should provide a function (or some other
interface) to do this.  When this function is called, save a pointer to the
Python function object (be careful to @ref{56e,,Py_INCREF()} it!) in a global
variable — or wherever you see fit. For example, the following function might
be part of a module definition:

@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{1551,,METH_VARARGS} flag; this is described in section @ref{4b49,,A tabela de métodos e a função de inicialização do módulo}.  The
@ref{571,,PyArg_ParseTuple()} function and its arguments are documented in section
@ref{4b54,,Extraindo parâmetros em funções de extensão}.

The macros @ref{a6e,,Py_XINCREF()} and @ref{78f,,Py_XDECREF()} increment/decrement the
reference count of an object and are safe in the presence of @code{NULL} pointers
(but note that `temp' will not be  @code{NULL} in this context).  More info on them
in section @ref{4b55,,Contagens de referências}.

@geindex PyObject_CallObject (C function)

Later, when it is time to call the function, you call the C function
@ref{4b56,,PyObject_CallObject()}.  This function has two arguments, both pointers to
arbitrary Python objects: the Python function, and the argument list.  The
argument list must always be a tuple object, whose length is the number of
arguments.  To call the Python function with no arguments, pass in @code{NULL}, or
an empty tuple; to call it with one argument, pass a singleton tuple.
@ref{8ac,,Py_BuildValue()} returns a tuple when its format string consists of zero
or more format codes between parentheses.  For example:

@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{4b56,,PyObject_CallObject()} returns a Python object pointer: this is the return
value of the Python function.  @ref{4b56,,PyObject_CallObject()} is
“reference-count-neutral” with respect to its arguments.  In the example a new
tuple was created to serve as the argument list, which is
@ref{56f,,Py_DECREF()}-ed immediately after the @ref{4b56,,PyObject_CallObject()}
call.

The return value of @ref{4b56,,PyObject_CallObject()} is “new”: either it is a brand
new object, or it is an existing object whose reference count has been
incremented.  So, unless you want to save it in a global variable, you should
somehow @ref{56f,,Py_DECREF()} the result, even (especially!) if you are not
interested in its value.

Before you do this, however, it is important to check that the return value
isn’t @code{NULL}.  If it is, the Python function terminated by raising an exception.
If the C code that called @ref{4b56,,PyObject_CallObject()} is called from Python, it
should now return an error indication to its Python caller, so the interpreter
can print a stack trace, or the calling Python code can handle the exception.
If this is not possible or desirable, the exception should be cleared by calling
@ref{1069,,PyErr_Clear()}.  For example:

@example
if (result == NULL)
    return NULL; /* Pass error back */
...use result...
Py_DECREF(result);
@end example

Depending on the desired interface to the Python callback function, you may also
have to provide an argument list to @ref{4b56,,PyObject_CallObject()}.  In some cases
the argument list is also provided by the Python program, through the same
interface that specified the callback function.  It can then be saved and used
in the same manner as the function object.  In other cases, you may have to
construct a new tuple to pass as the argument list.  The simplest way to do this
is to call @ref{8ac,,Py_BuildValue()}.  For example, if you want to pass an integral
event code, you might use the following code:

@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

Note the placement of @code{Py_DECREF(arglist)} immediately after the call, before
the error check!  Also note that strictly speaking this code is not complete:
@ref{8ac,,Py_BuildValue()} may run out of memory, and this should be checked.

You may also call a function with keyword arguments by using
@ref{39c,,PyObject_Call()}, which supports arguments and keyword arguments.  As in
the above example, we use @ref{8ac,,Py_BuildValue()} to construct the dictionary.

@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 Extraindo parâmetros em funções de extensão,Parâmetros nomeados para funções de extensão,Chamando funções Python de C,Estendendo Python com C ou C++
@anchor{extending/extending extracting-parameters-in-extension-functions}@anchor{4b57}@anchor{extending/extending parsetuple}@anchor{4b54}
@subsubsection Extraindo parâmetros em funções de extensão


@geindex PyArg_ParseTuple (C function)

The @ref{571,,PyArg_ParseTuple()} function is declared as follows:

@example
int PyArg_ParseTuple(PyObject *arg, const char *format, ...);
@end example

O argumento `arg' deve ser um objeto tupla contendo uma lista de argumentos passada de Python para uma função C. O argumento `format' deve ser uma string de formato, cuja sintaxe é explicada em @ref{8ad,,Análise de argumentos e construção de valores} no Manual de Referência da API C/Python. Os argumentos restantes devem ser endereços de variáveis cujo tipo é determinado pela string de formato.

Note that while @ref{571,,PyArg_ParseTuple()} checks that the Python arguments have
the required types, it cannot check the validity of the addresses of C variables
passed to the call: if you make mistakes there, your code will probably crash or
at least overwrite random bits in memory.  So be careful!

Note que quaisquer referências a objeto Python que são fornecidas ao chamador são referências `emprestadas'; não decremente a contagem de referências delas!

Alguns exemplos de chamadas:

@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 nomeados para funções de extensão,Construindo valores arbitrários,Extraindo parâmetros em funções de extensão,Estendendo Python com C ou C++
@anchor{extending/extending keyword-parameters-for-extension-functions}@anchor{4b58}@anchor{extending/extending parsetupleandkeywords}@anchor{4b59}
@subsubsection Parâmetros nomeados para funções de extensão


@geindex PyArg_ParseTupleAndKeywords (C function)

The @ref{383,,PyArg_ParseTupleAndKeywords()} function is declared as follows:

@example
int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
                                const char *format, char * const *kwlist, ...);
@end example

The `arg' and `format' parameters are identical to those of the
@ref{571,,PyArg_ParseTuple()} function.  The `kwdict' parameter is the dictionary of
keywords received as the third parameter from the Python runtime.  The `kwlist'
parameter is a @code{NULL}-terminated list of strings which identify the parameters;
the names are matched with the type information from `format' from left to
right.  On success, @ref{383,,PyArg_ParseTupleAndKeywords()} returns true, otherwise
it returns false and raises an appropriate exception.

@cartouche
@quotation Nota 
Nested tuples cannot be parsed when using keyword arguments!  Keyword parameters
passed in which are not present in the `kwlist' will cause @ref{2c3,,TypeError} to
be raised.
@end quotation
@end cartouche

@geindex Philbrick@comma{} Geoff

Aqui está um módulo de exemplo que usa parâmetros nomeados, baseado em um exemplo de Geoff Philbrick (@email{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 keywdarg_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "keywdarg",
    .m_size = 0,
    .m_methods = keywdarg_methods,
@};

PyMODINIT_FUNC
PyInit_keywdarg(void)
@{
    return PyModuleDef_Init(&keywdarg_module);
@}
@end example

@node Construindo valores arbitrários,Contagens de referências,Parâmetros nomeados para funções de extensão,Estendendo Python com C ou C++
@anchor{extending/extending building-arbitrary-values}@anchor{4b5a}@anchor{extending/extending buildvalue}@anchor{4b5b}
@subsubsection Construindo valores arbitrários


This function is the counterpart to @ref{571,,PyArg_ParseTuple()}.  It is declared
as follows:

@example
PyObject *Py_BuildValue(const char *format, ...);
@end example

It recognizes a set of format units similar to the ones recognized by
@ref{571,,PyArg_ParseTuple()}, but the arguments (which are input to the function,
not output) must not be pointers, just values.  It returns a new Python object,
suitable for returning from a C function called from Python.

One difference with @ref{571,,PyArg_ParseTuple()}: while the latter requires its
first argument to be a tuple (since Python argument lists are always represented
as tuples internally), @ref{8ac,,Py_BuildValue()} does not always build a tuple.  It
builds a tuple only if its format string contains two or more format units. If
the format string is empty, it returns @code{None}; if it contains exactly one
format unit, it returns whatever object is described by that format unit.  To
force it to return a tuple of size 0 or one, parenthesize the format string.

Examples (to the left the call, to the right the resulting Python value):

@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 Contagens de referências,Escrevendo extensões em C++,Construindo valores arbitrários,Estendendo Python com C ou C++
@anchor{extending/extending refcounts}@anchor{4b55}@anchor{extending/extending reference-counts}@anchor{4b5c}
@subsubsection Contagens de referências


In languages like C or C++, the programmer is responsible for dynamic allocation
and deallocation of memory on the heap.  In C, this is done using the functions
@code{malloc()} and @code{free()}.  In C++, the operators @code{new} and
@code{delete} are used with essentially the same meaning and we’ll restrict
the following discussion to the C case.

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.

Causas comuns de vazamentos de memória são caminhos incomuns no código. Por exemplo, uma função pode alocar um bloco de memória, executar algum cálculo e, em seguida, liberar o bloco novamente. Agora, uma alteração nos requisitos da função pode adicionar um teste ao cálculo que detecta uma condição de erro e pode retornar prematuramente da função. É fácil esquecer de liberar o bloco de memória alocado ao executar essa saída prematura, especialmente quando ela é adicionada posteriormente ao código. Esses vazamentos, uma vez introduzidos, geralmente passam despercebidos por um longo tempo: a saída de erro é executada apenas em uma pequena fração de todas as chamadas, e a maioria das máquinas modernas tem bastante memória virtual, portanto, o vazamento só se torna aparente em um processo de longa duração que usa a função com vazamento com frequência. Portanto, é importante evitar que vazamentos aconteçam por meio de uma convenção ou estratégia de codificação que minimize esse tipo de erro.

Since Python makes heavy use of @code{malloc()} and @code{free()}, it needs a
strategy to avoid memory leaks as well as the use of freed memory.  The chosen
method is called `reference counting'.  The principle is simple: every
object contains a counter, which is incremented when a reference to the object
is stored somewhere, and which is decremented when a reference to it is deleted.
When the counter reaches zero, the last reference to the object has been deleted
and the object is freed.

An alternative strategy is called `automatic garbage collection'.
(Sometimes, reference counting is also referred to as a garbage collection
strategy, hence my use of “automatic” to distinguish the two.)  The big
advantage of automatic garbage collection is that the user doesn’t need to call
@code{free()} explicitly.  (Another claimed advantage is an improvement in speed
or memory usage — this is no hard fact however.)  The disadvantage is that for
C, there is no truly portable automatic garbage collector, while reference
counting can be implemented portably (as long as the functions @code{malloc()}
and @code{free()} are available — which the C Standard guarantees). Maybe some
day a sufficiently portable automatic garbage collector will be available for C.
Until then, we’ll have to live with reference counts.

Embora o Python utilize a implementação tradicional de contagem de referências, ele também oferece um detector de ciclos que funciona para detectar ciclos de referência. Isso permite que as aplicações não se preocupem em criar referências circulares diretas ou indiretas; esses são os pontos fracos da coleta de lixo implementada usando apenas a contagem de referências. Ciclos de referência consistem em objetos que contêm referências (possivelmente indiretas) a si mesmos, de modo que cada objeto no ciclo tem uma contagem de referências diferente de zero. Implementações típicas de contagem de referências não são capazes de recuperar a memória pertencente a nenhum objeto em um ciclo de referência, ou referenciada a partir dos objetos no ciclo, mesmo que não haja mais referências ao próprio ciclo.

The cycle detector is able to detect garbage cycles and can reclaim them.
The @ref{60,,gc} module exposes a way to run the detector (the
@ref{a43,,collect()} function), as well as configuration
interfaces and the ability to disable the detector at runtime.

@menu
* Contagem de referências no Python:: 
* Regras de propriedade:: 
* Gelo fino:: 
* Ponteiros NULL:: 

@end menu

@node Contagem de referências no Python,Regras de propriedade,,Contagens de referências
@anchor{extending/extending refcountsinpython}@anchor{4b5d}@anchor{extending/extending reference-counting-in-python}@anchor{4b5e}
@subsubsection Contagem de referências no Python


There are two macros, @code{Py_INCREF(x)} and @code{Py_DECREF(x)}, which handle the
incrementing and decrementing of the reference count. @ref{56f,,Py_DECREF()} also
frees the object when the count reaches zero. For flexibility, it doesn’t call
@code{free()} directly — rather, it makes a call through a function pointer in
the object’s `type object'.  For this purpose (and others), every object
also contains a pointer to its type object.

The big question now remains: when to use @code{Py_INCREF(x)} and @code{Py_DECREF(x)}?
Let’s first introduce some terms.  Nobody “owns” an object; however, you can
`own a reference' to an object.  An object’s reference count is now defined
as the number of owned references to it.  The owner of a reference is
responsible for calling @ref{56f,,Py_DECREF()} when the reference is no longer
needed.  Ownership of a reference can be transferred.  There are three ways to
dispose of an owned reference: pass it on, store it, or call @ref{56f,,Py_DECREF()}.
Forgetting to dispose of an owned reference creates a memory leak.

It is also possible to `borrow' @footnote{
A metáfora de “pegar emprestado” uma referência não é completamente correta: o proprietário ainda tem uma cópia da referência.
} a reference to an object.  The
borrower of a reference should not call @ref{56f,,Py_DECREF()}.  The borrower must
not hold on to the object longer than the owner from which it was borrowed.
Using a borrowed reference after the owner has disposed of it risks using freed
memory and should be avoided completely @footnote{
Checking that the reference count is at least 1 `does not work' — the
reference count itself could be in freed memory and may thus be reused for
another object!
}.

The advantage of borrowing over owning a reference is that you don’t need to
take care of disposing of the reference on all possible paths through the code
— in other words, with a borrowed reference you don’t run the risk of leaking
when a premature exit is taken.  The disadvantage of borrowing over owning is
that there are some subtle situations where in seemingly correct code a borrowed
reference can be used after the owner from which it was borrowed has in fact
disposed of it.

A borrowed reference can be changed into an owned reference by calling
@ref{56e,,Py_INCREF()}.  This does not affect the status of the owner from which the
reference was borrowed — it creates a new owned reference, and gives full
owner responsibilities (the new owner must dispose of the reference properly, as
well as the previous owner).

@node Regras de propriedade,Gelo fino,Contagem de referências no Python,Contagens de referências
@anchor{extending/extending ownership-rules}@anchor{4b5f}@anchor{extending/extending ownershiprules}@anchor{4b60}
@subsubsection Regras de propriedade


Sempre que uma referência de objeto é passada para dentro ou para fora de uma função, faz parte da especificação da interface da função se a propriedade é transferida com a referência ou não.

Most functions that return a reference to an object pass on ownership with the
reference.  In particular, all functions whose function it is to create a new
object, such as @ref{195a,,PyLong_FromLong()} and @ref{8ac,,Py_BuildValue()}, pass
ownership to the receiver.  Even if the object is not actually new, you still
receive ownership of a new reference to that object.  For instance,
@ref{195a,,PyLong_FromLong()} maintains a cache of popular values and can return a
reference to a cached item.

Many functions that extract objects from other objects also transfer ownership
with the reference, for instance @ref{348,,PyObject_GetAttrString()}.  The picture
is less clear, here, however, since a few common routines are exceptions:
@ref{4b61,,PyTuple_GetItem()}, @ref{35a,,PyList_GetItem()}, @ref{387,,PyDict_GetItem()}, and
@ref{388,,PyDict_GetItemString()} all return references that you borrow from the
tuple, list or dictionary.

The function @ref{357,,PyImport_AddModule()} also returns a borrowed reference, even
though it may actually create the object it returns: this is possible because an
owned reference to the object is stored in @code{sys.modules}.

When you pass an object reference into another function, in general, the
function borrows the reference from you — if it needs to store it, it will use
@ref{56e,,Py_INCREF()} to become an independent owner.  There are exactly two
important exceptions to this rule: @ref{4b62,,PyTuple_SetItem()} and
@ref{165e,,PyList_SetItem()}.  These functions take over ownership of the item passed
to them — even if they fail!  (Note that @ref{4b63,,PyDict_SetItem()} and friends
don’t take over ownership — they are “normal.”)

When a C function is called from Python, it borrows references to its arguments
from the caller.  The caller owns a reference to the object, so the borrowed
reference’s lifetime is guaranteed until the function returns.  Only when such a
borrowed reference must be stored or passed on, it must be turned into an owned
reference by calling @ref{56e,,Py_INCREF()}.

A referência de objeto retornada de uma função C chamada do Python deve ser uma referência própria — a propriedade é transferida da função para seu chamador.

@node Gelo fino,Ponteiros NULL,Regras de propriedade,Contagens de referências
@anchor{extending/extending thin-ice}@anchor{4b64}@anchor{extending/extending thinice}@anchor{4b65}
@subsubsection Gelo fino


There are a few situations where seemingly harmless use of a borrowed reference
can lead to problems.  These all have to do with implicit invocations of the
interpreter, which can cause the owner of a reference to dispose of it.

The first and most important case to know about is using @ref{56f,,Py_DECREF()} on
an unrelated object while borrowing a reference to a list item.  For instance:

@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 função primeiro toma emprestada uma referência a @code{list[0]}, depois substitui @code{list[1]} pelo valor @code{0} e, por fim, imprime a referência emprestada. Parece inofensivo, certo? Mas não é!

Let’s follow the control flow into @ref{165e,,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. Internally,
@ref{165e,,PyList_SetItem()} calls @ref{56f,,Py_DECREF()} on the replaced item,
which invokes replaced item’s corresponding
@ref{4b66,,tp_dealloc} function. During
deallocation, @ref{4b66,,tp_dealloc} calls
@ref{ab5,,tp_finalize}, which is mapped to the
@code{__del__()} method for class instances (see 
@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}). This entire
sequence happens synchronously within the @ref{165e,,PyList_SetItem()} call.

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

A solução, depois de descobrir a origem do problema, é fácil: incrementar temporariamente a contagem de referências. A versão correta da função é:

@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…

The second case of problems with a borrowed reference is a variant involving
threads.  Normally, multiple threads in the Python interpreter can’t get in each
other’s way, because there is a @ref{148,,global lock}
protecting Python’s entire object space.
However, it is possible to temporarily release this lock using the macro
@ref{4b67,,Py_BEGIN_ALLOW_THREADS}, and to re-acquire it using
@ref{a98,,Py_END_ALLOW_THREADS}.  This is common around blocking I/O calls, to
let other threads use the processor while waiting for the I/O to complete.
Obviously, the following function has the same problem as the previous one:

@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 Ponteiros NULL,,Gelo fino,Contagens de referências
@anchor{extending/extending null-pointers}@anchor{4b68}@anchor{extending/extending nullpointers}@anchor{4b69}
@subsubsection Ponteiros NULL


In general, functions that take object references as arguments do not expect you
to pass them @code{NULL} pointers, and will dump core (or cause later core dumps) if
you do so.  Functions that return object references generally return @code{NULL} only
to indicate that an exception occurred.  The reason for not testing for @code{NULL}
arguments is that functions often pass the objects they receive on to other
function — if each function were to test for @code{NULL}, there would be a lot of
redundant tests and the code would run more slowly.

It is better to test for @code{NULL} only at the “source:” when a pointer that may be
@code{NULL} is received, for example, from @code{malloc()} or from a function that
may raise an exception.

The macros @ref{56e,,Py_INCREF()} and @ref{56f,,Py_DECREF()} do not check for @code{NULL}
pointers — however, their variants @ref{a6e,,Py_XINCREF()} and @ref{78f,,Py_XDECREF()}
do.

The macros for checking for a particular object type (@code{Pytype_Check()}) don’t
check for @code{NULL} pointers — again, there is much code that calls several of
these in a row to test an object against various different expected types, and
this would generate redundant tests.  There are no variants with @code{NULL}
checking.

The C function calling mechanism guarantees that the argument list passed to C
functions (@code{args} in the examples) is never @code{NULL} — in fact it guarantees
that it is always a tuple @footnote{
These guarantees don’t hold when you use the “old” style calling convention —
this is still found in much existing code.
}.

It is a severe error to ever let a @code{NULL} pointer “escape” to the Python user.

@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 Escrevendo extensões em C++,Fornecendo uma API C para um módulo de extensão,Contagens de referências,Estendendo Python com C ou C++
@anchor{extending/extending cplusplus}@anchor{4b6a}@anchor{extending/extending writing-extensions-in-c}@anchor{4b6b}
@subsubsection Escrevendo extensões em C++


É possível escrever módulos de extensão em C++. Algumas restrições se aplicam. Se o programa principal (o interpretador Python) for compilado e vinculado pelo compilador C, objetos globais ou estáticos com construtores não poderão ser usados. Isso não é um problema se o programa principal for vinculado pelo compilador C++. Funções que serão chamadas pelo interpretador Python (em particular, funções de inicialização de módulos) devem ser declaradas usando @code{extern "C"}. Não é necessário incluir os arquivos de cabeçalho Python entre @code{extern "C" @{...@}} — eles já usam esta forma se o símbolo @code{__cplusplus} estiver definido (todos os compiladores C++ recentes definem este símbolo).

@node Fornecendo uma API C para um módulo de extensão,,Escrevendo extensões em C++,Estendendo Python com C ou C++
@anchor{extending/extending providing-a-c-api-for-an-extension-module}@anchor{4b6c}@anchor{extending/extending using-capsules}@anchor{13a4}
@subsubsection Fornecendo uma API C para um módulo de extensão


Muitos módulos de extensão apenas fornecem novas funções e tipos para serem usados em Python, mas às vezes o código em um módulo de extensão pode ser útil para outros módulos de extensão. Por exemplo, um módulo de extensão poderia implementar um tipo “collection”, que funciona como listas sem ordem. Assim como o tipo de lista padrão do Python possui uma API C que permite que os módulos de extensão criem e manipulem listas, esse novo tipo de coleção deve ter um conjunto de funções em C para manipulação direta de outros módulos de extensão.

À primeira vista, isso parece fácil: basta escrever as funções (sem declará-las @code{static}, é claro), fornecer um arquivo de cabeçalho apropriado e documentar a API C. E, de fato, isso funcionaria se todos os módulos de extensão estivessem sempre vinculados estaticamente ao interpretador Python. Quando os módulos são usados como bibliotecas compartilhadas, no entanto, os símbolos definidos em um módulo podem não ser visíveis para outro módulo. Os detalhes de visibilidade dependem do sistema operacional; alguns sistemas usam um espaço de nomes global para o interpretador Python e todos os módulos de extensão (Windows, por exemplo), enquanto outros exigem uma lista explícita de símbolos importados no momento da vinculação do módulo (AIX é um exemplo) ou oferecem uma escolha de estratégias diferentes (a maioria dos Unices). E mesmo que os símbolos sejam globalmente visíveis, o módulo cujas funções se deseja chamar pode não ter sido carregado ainda!

A portabilidade, portanto, exige que não se façam suposições sobre a visibilidade dos símbolos. Isso significa que todos os símbolos em módulos de extensão devem ser declarados @code{static}, exceto a função de inicialização do módulo, a fim de evitar conflitos de nomes com outros módulos de extensão (conforme discutido na seção @ref{4b49,,A tabela de métodos e a função de inicialização do módulo}). E significa que os símbolos que `deveriam' ser acessíveis a partir de outros módulos de extensão devem ser exportados de uma maneira diferente.

Python provides a special mechanism to pass C-level information (pointers) from
one extension module to another one: Capsules. A Capsule is a Python data type
which stores a pointer (void*).  Capsules can only be created and
accessed via their C API, but they can be passed around like any other Python
object. In particular,  they can be assigned to a name in an extension module’s
namespace. Other extension modules can then import this module, retrieve the
value of this name, and then retrieve the pointer from the Capsule.

Existem muitas maneiras de usar Cápsulas para exportar a API C de um módulo de extensão. Cada função pode obter sua própria Cápsula, ou todos os ponteiros da API C podem ser armazenados em um array cujo endereço é publicado em uma Cápsula. E as diversas tarefas de armazenamento e recuperação dos ponteiros podem ser distribuídas de diferentes maneiras entre o módulo que fornece o código e os módulos clientes.

Whichever method you choose, it’s important to name your Capsules properly.
The function @ref{4b6d,,PyCapsule_New()} takes a name parameter
(const char*); you’re permitted to pass in a @code{NULL} name, but
we strongly encourage you to specify a name.  Properly named Capsules provide
a degree of runtime type-safety; there is no feasible way to tell one unnamed
Capsule from another.

Em particular, as Cápsulas usadas para expor APIs C devem receber um nome seguindo esta convenção:

@example
modulename.attributename
@end example

The convenience function @ref{1999,,PyCapsule_Import()} makes it easy to
load a C API provided via a Capsule, but only if the Capsule’s name
matches this convention.  This behavior gives C API users a high degree
of certainty that the Capsule they load contains the correct C API.

The following example demonstrates an approach that puts most of the burden on
the writer of the exporting module, which is appropriate for commonly used
library modules. It stores all C API pointers (just one in the example!) in an
array of void pointers which becomes the value of a Capsule. The header
file corresponding to the module provides a macro that takes care of importing
the module and retrieving its C API pointers; client modules only have to call
this macro before accessing the C API.

The exporting module is a modification of the @code{spam} module from section
@ref{4b3d,,Um Exemplo Simples}. 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

No início do módulo, logo após a linha

@example
#include <Python.h>
@end example

mais duas linhas devem ser adicionadas:

@example
#define SPAM_MODULE
#include "spammodule.h"
@end example

The @code{#define} is used to tell the header file that it is being included in the
exporting module, not a client module. Finally, the module’s @ref{985,,mod_exec} function must take care of initializing the C API pointer array:

@example
static int
spam_module_exec(PyObject *m)
@{
    static void *PySpam_API[PySpam_API_pointers];
    PyObject *c_api_object;

    /* 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) @{
        return -1;
    @}

    return 0;
@}
@end example

Note that @code{PySpam_API} is declared @code{static}; otherwise the pointer
array would disappear when @code{PyInit_spam()} terminates!

A maior parte do trabalho está no arquivo de cabeçalho @code{spammodule.h}, que se parece com isso:

@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 @ref{985,,mod_exec} function:

@example
static int
client_module_exec(PyObject *m)
@{
    if (import_spam() < 0) @{
        return -1;
    @}
    /* additional initialization can happen here */
    return 0;
@}
@end example

The main disadvantage of this approach is that the file @code{spammodule.h} is
rather complicated. However, the basic structure is the same for each function
that is exported, so it has to be learned only once.

Por fim, vale mencionar que as Cápsulas oferecem funcionalidades adicionais, especialmente úteis para alocação e desalocação de memória do ponteiro armazenado em uma Cápsula. Os detalhes são descritos no Manual de Referência da API Python/C, na seção @ref{2723,,Capsules} e na implementação das Cápsulas (arquivos @code{Include/pycapsule.h} e @code{Objects/pycapsule.c} na distribuição do código-fonte Python).

@node Definindo Tipos de Extensão Tutorial,Defining Extension Types Assorted Topics,Estendendo Python com C ou C++,Criando extensões sem ferramentas de terceiros
@anchor{extending/newtypes_tutorial doc}@anchor{1945}@anchor{extending/newtypes_tutorial defining-extension-types-tutorial}@anchor{4b6e}@anchor{extending/newtypes_tutorial defining-new-types}@anchor{4b6f}@anchor{extending/newtypes_tutorial translation-repo}@anchor{4b70}
@subsection Definindo Tipos de Extensão: Tutorial


O Python permite que o desenvolvedor de um módulo de extensão em C defina novos tipos que podem ser manipulados a partir do código Python, da mesma forma que os tipos embutidos @ref{44c,,str} e @ref{611,,list}. O código para de todos tipos de extensão segue um padrão, mas há alguns detalhes que você precisa entender antes de começar. Este documento é uma introdução suave ao tópico.

@menu
* O básico: O básico<2>. 
* Adicionando dados e métodos ao exemplo básico:: 
* Fornecendo controle mais preciso sobre atributos de dados:: 
* Apoiando a coleta de lixo cíclica:: 
* Criando subclasses de outros tipos:: 

@end menu

@node O básico<2>,Adicionando dados e métodos ao exemplo básico,,Definindo Tipos de Extensão Tutorial
@anchor{extending/newtypes_tutorial dnt-basics}@anchor{4b71}@anchor{extending/newtypes_tutorial the-basics}@anchor{4b72}
@subsubsection O básico


O tempo de execução do @ref{6f6,,CPython} trata todos os objetos Python como variáveis do tipo @ref{339,,PyObject}*, que funciona como um “tipo base” para todos os objetos Python. A estrutura @ref{339,,PyObject} em si contém apenas a @ref{4b73,,contagem de referências} do objeto e um ponteiro para o “objeto de tipo” correspondente. É nesse objeto de tipo que tudo acontece: ele determina quais funções em C o interpretador chama quando, por exemplo, um atributo é acessado em um objeto, um método é chamado ou o objeto é multiplicado por outro. Essas funções em C são chamadas de “métodos de tipo”.

Então, se você quiser definir um novo tipo de extensão, você precisa criar um novo objeto de tipo.

Esse tipo de coisa só pode ser explicado com exemplo, então aqui está um módulo mínimo, mas completo, que define um novo tipo nomeado @code{Custom} dentro de um módulo de extensão C @code{custom}:

@cartouche
@quotation Nota 
O que estamos mostrando aqui é a maneira tradicional de definir tipos de extensão `estáticos'. Deve ser adequada para a maioria dos usos. A API C também permite definir tipos de extensão alocados em heap usando a função @ref{57d,,PyType_FromSpec()}, que não é abordada neste tutorial.
@end quotation
@end cartouche

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct @{
    PyObject_HEAD
    /* Campos específico do tipo vão aqui. */
@} 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 int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    // Só use isso quando estiver usando tipos estáticos
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

Isso é bastante informação para assimilar de uma só vez, mas algumas partes devem parecer familiares pelo que foi visto no capítulo anterior. Este arquivo define três elementos:


@enumerate 

@item 
O que um `objeto' @code{Custom} contém: esta é uma estrutura @code{CustomObject}, alocada uma vez para cada instância de @code{Custom}.

@item 
Como o `tipo' @code{Custom} se comporta: esta é a estrutura @code{CustomType}, que define um conjunto de sinalizadores e ponteiros de função que o interpretador inspeciona quando operações específicas são solicitadas.

@item 
Como definir e executar o módulo @code{custom}: esta é a função @code{PyInit_custom} e a estrutura associada @code{custom_module} para definir o módulo, e a função @code{custom_module_exec} para configurar um novo objeto de módulo.
@end enumerate

O primeiro bit é

@example
typedef struct @{
    PyObject_HEAD
@} CustomObject;
@end example

Isto é o que um objeto Custom conterá. @code{PyObject_HEAD} é obrigatório no início de cada estrutura de objeto e define um campo chamado @code{ob_base} do tipo @ref{339,,PyObject}, contendo um ponteiro para um objeto de tipo e uma contagem de referências (esses podem ser acessados usando os macros @ref{780,,Py_TYPE} e @ref{8ae,,Py_REFCNT}, respectivamente). O objetivo do macro é abstrair o layout e permitir campos adicionais em @ref{1f9,,construções de depuração}.

@cartouche
@quotation Nota 
Não há ponto e vírgula acima após o macro @ref{1321,,PyObject_HEAD}. Tenha cuidado para não adicionar um por engano: alguns compiladores podem emitir erros.
@end quotation
@end cartouche

Obviamente, objetos geralmente armazenam dados adicionais além do padrão @code{PyObject_HEAD} boilerplate; por exemplo, aqui está a definição do padrão Python floats:

@example
typedef struct @{
    PyObject_HEAD
    double ob_fval;
@} PyFloatObject;
@end example

O segundo bit é a definição do objeto de tipo.

@example
estático PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom.Custom",
    .tp_doc = PyDoc_STR("Custom objeto"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_new = PyType_GenericNew,
@};
@end example

@cartouche
@quotation Nota 
Recomendamos usar inicializadores nomeados no estilo C99, como mostrado acima, para evitar listar todos os campos de @ref{ab4,,PyTypeObject} com os quais você não precisa se preocupar e também para não depender da ordem de declaração desses campos
@end quotation
@end cartouche

A definição real de @ref{ab4,,PyTypeObject} no @code{object.h} possui muito mais @ref{994,,campos} do que a definição acima. Os campos restantes serão preenchidos com zeros pelo compilador C, e é prática comum não especificá-los explicitamente, a menos que sejam necessários.

Vamos separá-lo, um campo de cada vez

@example
.ob_base = PyVarObject_HEAD_INIT(NULL, 0)
@end example

Essa linha é um boilerplate obrigatório para inicializar o campo @code{ob_base} mencionado acima.

@example
.tp_name = "custom.Custom",
@end example

O nome do nosso tipo.  Ele aparecerá na representação textual padrão do nosso objeto e em algumas mensagens erro, por exemplo:

@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

Observe que o nome é um nome pontilhado que inclui o nome módulo e o nome do tipo dentro do módulo. O módulo, neste caso, é @code{custom} e o tipo é @code{Custom}, portanto, definimos o nome do tipo como @code{custom.Custom}. O uso do pontilhado real caminho de importação é importante para tornar seu tipo compatível com o @ref{b5,,pydoc} e os módulos @ref{a6,,pickle}.

@example
.tp_basicsize = sizeof(CustomObject),
.tp_itemsize = 0,
@end example

Isso serve para que o Python saiba quanta memória deve ser alocada ao criar novas instâncias do @code{Custom}. O @ref{20fd,,tp_itemsize} é usado somente para objeto de tamanho variável e, caso contrário, deve ser zero.

@cartouche
@quotation Nota 
Se você quiser que seu tipo possa ser subclassificado a partir do Python, e seu tipo tiver o mesmo @ref{98e,,tp_basicsize} que seu tipo base, você poderá ter problemas com herança múltipla. Uma subclasse Python do seu tipo terá de listar o seu tipo primeiro em @ref{14f4,,__bases__}, caso contrário ela não conseguirá chamar o método @ref{580,,__new__()} do seu tipo sem gerar um erro. Você pode evitar esse problema garantindo que seu tipo tenha um valor de @ref{98e,,tp_basicsize} maior que o do tipo base. Na maior parte do tempo, isso já será verdadeiro, pois ou o tipo base será @ref{a96,,object}, ou você estará adicionando membros de dados ao seu tipo base e, portanto, aumentando seu tamanho.
@end quotation
@end cartouche

Definimos os sinalizadores da classe como @ref{4b74,,Py_TPFLAGS_DEFAULT}.

@example
.tp_flags = Py_TPFLAGS_DEFAULT,
@end example

Todos os tipos devem incluir essa constante em seus sinalizadores. Ela habilita todos os membros definidos até pelo menos o Python 3.3. Se você precisar de membros adicionais, será necessário fazer um OR com os sinalizadores correspondentes.

Fornecemos uma docstring para o tipo em tp_doc @ref{4b75,,tp_doc}.

@example
.tp_doc = PyDoc_STR("Custom objects"),
@end example

Para habilitar a criação de objetos, precisamos fornecer um manipulador para @ref{57f,,tp_new}. Esse é o equivalente ao método Python @ref{580,,__new__()}, mas precisa ser especificado explicitamente. Neste caso, podemos simplesmente usar a implementação padrão fornecida pela função da API @ref{4b76,,PyType_GenericNew()}.

@example
.tp_new = PyType_GenericNew,
@end example

Todo o restante do arquivo deve ser familiar, exceto por alguns códigos em @code{custom_module_exec()}:

@example
se (PyType_Ready(&CustomType) < 0) @{
    retorno -1;
@}
@end example

Isso inicializa o tipo @code{Custom}, preenchendo vários membros com os valores padrão apropriados, incluindo @ref{4b77,,ob_type}, que definimos inicialmente como @code{NULL}.

@example
if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
return -1;
@}
@end example

Isso adiciona o tipo ao dicionário do módulo.
Isso nos permite criar instâncias de @code{Custom} chamando a classe @code{Custom}:

@example
>>> import custom
>>> mycustom = custom.Custom()
@end example

É isso! Só resta compilá-lo; coloque o código acima em um arquivo chamado @code{custom.c},

@example
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "custom"
version = "1"
@end example

Em um arquivo chamado @code{pyproject.toml}, e

@example
from setuptools import Extension, setup
setup(ext_modules=[Extension("custom", ["custom.c"])])
@end example

Em um arquivo chamado @code{setup.py}; e então digitando

@example
$ python -m pip install .
@end example

no console deverá gerar um arquivo @code{custom.so} em um subdiretório e instalá-lo; agora abra o Python — você já deve conseguir @code{import custom} e experimentar objetos @code{Custom}.

Isso não foi tão difícil, foi?

Naturalmente, o tipo Custom atual é bastante desinteressante. Não tem dados e não faz nada. Não pode nem ser subclassificado.

@node Adicionando dados e métodos ao exemplo básico,Fornecendo controle mais preciso sobre atributos de dados,O básico<2>,Definindo Tipos de Extensão Tutorial
@anchor{extending/newtypes_tutorial adding-data-and-methods-to-the-basic-example}@anchor{4b78}
@subsubsection Adicionando dados e métodos ao exemplo básico


Vamos estender o exemplo básico para adicionar alguns dados e métodos. Também vamos tornar o tipo utilizável como uma classe base. Iremos criar um novo módulo, @code{custom2}, que adiciona esses recursos:

@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 = 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;
@}

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 int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom2",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom2(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

Esta versão do módulo possui várias alterações.

O tipo @code{Custom} agora possui três atributos de dados em sua estrutura C: first, last e number. As variáveis first e last são strings Python contendo o primeiro e o último nome. O atributo number é um inteiro em C.

A estrutura do objeto é atualizada de acordo

@example
typedef struct @{
PyObject_HEAD
PyObject *first; /* first name */
PyObject *last; /* last name */
int number;
@} CustomObject;
@end example

Como agora temos dados para gerenciar, precisamos ter mais cuidado com a alocação e a desalocação do objeto.  No mínimo, precisamos de método de desalocação:

@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 é atribuído ao membro @ref{4b66,,tp_dealloc}:

@example
.tp_dealloc = (destructor) Custom_dealloc,
@end example

Esse método primeiro limpa a contagem de referências dos dois atributos Python. @ref{78f,,Py_XDECREF()} lida corretamente com o caso em que seu argumento é @code{NULL} (o que pode acontecer aqui se @code{tp_new} falhou no meio do processo). Em seguida, ele chama o membro @ref{4b79,,tp_free} do tipo do objeto (obtido por @code{Py_TYPE(self)}) para liberar a memória do objeto. Observe que o tipo do objeto pode não ser @code{CustomType}, pois o objeto pode ser uma instância de uma subclasse.

@cartouche
@quotation Nota 
The explicit cast to @code{destructor} above is needed because we defined
@code{Custom_dealloc} to take a @code{CustomObject *} argument, but the @code{tp_dealloc}
function pointer expects to receive a @code{PyObject *} argument.  Otherwise,
the compiler will emit a warning.  This is object-oriented polymorphism,
in C!
@end quotation
@end cartouche

Queremos nos certificar de que o primeiro e o último nome sejam inicializados como strings vazias, portanto, fornecemos uma implementação:: @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 instale-o no membro:: @ref{57f,,tp_new}

@example
.tp_new = Custom_new,
@end example

O manipulador @code{tp_new} é responsável por criar (em oposição a inicializar) os objetos do tipo. Ele é exposto no Python como o método @ref{580,,__new__()}. Não é obrigatório definir um membro @code{tp_new} e, de fato, muitos tipos de extensão simplesmente reutilizam @ref{4b76,,PyType_GenericNew()}, como na primeira versão do tipo @code{Custom} acima. Neste caso, usamos o manipulador @code{tp_new} para inicializar os atributos @code{first} e @code{last} com valores padrão que não sejam @code{NULL}.

O @code{tp_new} recebe o tipo que está sendo instanciado (não necessariamente @code{CustomType}, caso uma subclasse esteja sendo instanciada) e quaisquer argumentos passados quando o tipo foi chamado, e deve retornar a instância criada. Manipuladores @code{tp_new} sempre aceitam argumentos posicionais e argumentos nomeados, mas frequentemente os ignoram, deixando o tratamento dos argumentos para os métodos inicializadores (ou seja, @code{tp_init} em C ou @code{__init__} em Python).

@cartouche
@quotation Nota 
@code{tp_new} não deve chamar @code{tp_init} explicitamente, pois o interpretador fará isso por conta própria.
@end quotation
@end cartouche

A implementação de @code{tp_new} chama o slot @ref{4b7a,,tp_alloc} para alocar memória:

@example
self = (CustomObject *) type->tp_alloc(type, 0);
@end example

Como a alocação de memória pode falhar, precisamos verificar se o resultado de @ref{4b7a,,tp_alloc} é @code{NULL} antes de prosseguir.

@cartouche
@quotation Nota 
Nós não preenchemos o slot @ref{4b7a,,tp_alloc} por conta própria. Em vez disso, @ref{77c,,PyType_Ready()} o preenche herdando-o da nossa classe base, que por padrão é @ref{a96,,object}. A maioria dos tipos usa a estratégia de alocação padrão.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
Se você estiver criando um @ref{57f,,tp_new} cooperativo (um que chama o @ref{57f,,tp_new} ou @ref{580,,__new__()} de um tipo base), você `não' deve tentar determinar qual método chamar usando a ordem de resolução de métodos em tempo de execução. Sempre determine estaticamente qual tipo você vai chamar e chame seu @ref{57f,,tp_new} diretamente ou via @code{type->tp_base->tp_new}. Se você não fizer isso, as subclasses Python do seu tipo que também herdam de outras classes definidas em Python podem não funcionar corretamente. (Especificamente, você pode não conseguir criar instâncias dessas subclasses sem receber um @ref{2c3,,TypeError}.)
@end quotation
@end cartouche

Também definimos uma função de inicialização que aceita argumentos para fornecer valores iniciais para nosso instância:

@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

preenchendo o slot :: @ref{581,,tp_init}.

@example
.tp_init = (initproc) Custom_init,
@end example

O slot @ref{581,,tp_init} é exposto em Python como o método @ref{6b0,,__init__()}. Ele é usado para inicializar um objeto depois que ele é criado. Inicializadores sempre aceitam argumentos posicionais e argumentos nomeados, e devem retornar @code{0} em caso de sucesso ou @code{-1} em caso de erro.

Ao contrário do manipulador @code{tp_new}, não há garantia de que  seja chamado (por exemplo, o módulo @ref{a6,,pickle} por padrão não chama @ref{6b0,,__init__()} em instâncias desserializadas). Além disso, @code{tp_init} pode ser chamado várias vezes. Qualquer um pode chamar o método @code{__init__()} em nossos objetos. Por esse motivo, precisamos ter cuidado redobrado ao atribuir os novos valores de atributos. Poderíamos ficar tentados, por exemplo, a atribuir o membro @code{first} assim:

@example
if (first) @{ Py_XDECREF(self->first); Py_INCREF(first); self->first = first;@}
@end example

But this would be risky.  Our type doesn’t restrict the type of the
@code{first} member, so it could be any kind of object.  It could have a
destructor that causes code to be executed that tries to access the
@code{first} member; or that destructor could release the
@ref{159,,Global interpreter Lock} and let arbitrary code run in other
threads that accesses and modifies our object.

Para sermos extremamente cautelosos e nos proteger dessa possibilidade, quase sempre atribuímos novamente os membros antes de decrementar a contagem de referências. Quando não precisamos fazer isso?


@itemize *

@item 
quando sabemos absolutamente que a contagem de referência é maior que 1;

@item 
when we know that deallocation of the object @footnote{
Isso é verdade quando sabemos que o objeto é um tipo básico, como uma string ou um float.
} will neither release
the @ref{159,,GIL} nor cause any calls back into our type’s code;

@item 
quando estamos decrementando uma contagem de referências em um manipulador @ref{4b66,,tp_dealloc} de um tipo que não oferece suporte à coleta de lixo cíclica @footnote{
Confiamos nisso no manipulador @ref{4b66,,tp_dealloc} neste exemplo, porque o nosso tipo não oferece suporte à coleta de lixo.
}.
@end itemize

Queremos expor nossas variáveis de instância como atributos. Há várias maneiras de fazer isso. A forma mais simples é estabelecer definições de membros:

@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

e colocar as definições no slot @ref{4b7b,,tp_members}:

@example
.tp_members = Custom_members,
@end example

Cada definição de membro possui um nome de membro, um tipo, um deslocamento, sinalizadores de acesso e uma string de documentação. Consulte a seção @ref{4b7c,,Generic Attribute Management} abaixo para mais detalhes.

Uma desvantagem dessa abordagem é que ela não fornece uma forma de restringir os tipos de objetos que podem ser atribuídos aos atributos em Python. Esperamos que os nomes first e last sejam strings, mas qualquer objeto Python pode ser atribuído. Além disso, os atributos podem ser excluídos, fazendo com que os ponteiros em C sejam definidos como @code{NULL}. Mesmo que possamos garantir que os membros sejam inicializados com valores não @code{NULL}, eles ainda podem acabar sendo definidos como @code{NULL} caso os atributos sejam apagados.

Definimos um único método,:meth:@cite{!Custom.name}, que exibe o nome do objeto como a concatenação do primeiro nome com o último nome

@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

O método é implementado como uma função em C que recebe uma instância de @code{Custom} (ou de uma subclasse de @code{Custom}) como primeiro argumento. Métodos sempre recebem a instância como primeiro argumento. Eles também costumam aceitar argumentos posicionais e nomeados, mas, neste caso, não recebemos nenhum e não precisamos aceitar uma tupla de argumentos posicionais nem um dicionário de argumentos nomeados. Este método equivale ao método Python:

@example
def name(self): return "%s %s" % (self.first, self.last)
@end example

Observe que precisamos verificar a possibilidade de que nossos atributos @code{first} e @code{last} estejam com valor @code{NULL}. Isso ocorre porque eles podem ser excluídos e, nesse caso, ficam definidos como @code{NULL}. Seria melhor impedir a exclusão desses atributos e restringir seus valores para que sejam sempre strings. Veremos como fazer isso na próxima seção.

Agora que definimos o método, precisamos criar uma array de definições 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 que usamos o sinalizador @ref{151c,,METH_NOARGS} para indicar que o método não espera argumentos além de `self')

e atribuí-lo para o slot:: @ref{4b7d,,tp_methods}

@example
.tp_methods = Custom_methods,
@end example

Por fim, tornaremos nosso tipo utilizável como classe base para herança. Escrevemos nossos métodos com cuidado até agora, garantindo que eles não façam suposições sobre o tipo do objeto que está sendo criado ou utilizado; portanto, tudo o que precisamos fazer é adicionar a @ref{4b7e,,Py_TPFLAGS_BASETYPE} à definição dos sinalizadores da nossa classe:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
@end example

Renomeamos @code{PyInit_custom()} para @code{PyInit_custom2()}, atualizamos o nome do módulo na estrutura @ref{984,,PyModuleDef}, e atualizamos o nome completo da classe na estrutura @ref{ab4,,PyTypeObject}.

Finalmente, atualizamos nosso arquivo @code{setup.py} para incluir o novo módulo,

@example
from setuptools import Extension, setupsetup(ext_modules=[ Extension("custom", ["custom.c"]), Extension("custom2", ["custom2.c"]),])
@end example

então podemos instalar novamente para realizarmos o @code{import custom2}

@example
$ python -m pip install .
@end example

@node Fornecendo controle mais preciso sobre atributos de dados,Apoiando a coleta de lixo cíclica,Adicionando dados e métodos ao exemplo básico,Definindo Tipos de Extensão Tutorial
@anchor{extending/newtypes_tutorial providing-finer-control-over-data-attributes}@anchor{4b7f}
@subsubsection Fornecendo controle mais preciso sobre atributos de dados


Nesta seção, forneceremos um controle mais preciso sobre como os atributos @code{first} e @code{last} são definidos no exemplo @code{Custom}. Na versão anterior do nosso módulo, as variáveis de instância @code{first} e @code{last} podiam receber valores que não fossem strings ou até mesmo ser excluídas. Queremos garantir que esses atributos sempre contenham 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 = 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;
@}

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 int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom3",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom3(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

Para oferecer um controle maior sobre os atributos @code{first} e @code{last}, usaremos funções personalizadas de acesso (getters) e modificação (setters). A seguir estão as funções para obter e definir o atributo @code{first}:

@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

A função getter recebe um objeto @code{Custom} e um closure, que é um ponteiro para void. Neste caso, o closure é ignorado. (O closure oferece suporte a um modo de usar mais avançado, no qual dados de definição são passados ao getter e ao setter. Isso pode, por exemplo, permitir que um único conjunto de funções getter e setter decida qual atributo obter ou definir com base nos dados presentes no closure.)

A função setter recebe o objeto @code{Custom}, o novo valor e o closure. O novo valor pode ser @code{NULL}, caso em que o atributo está sendo excluído. No nosso setter, levantamos um erro se o atributo for excluído ou se o novo valor não for uma string.

Nós criamos um vetor de estruturas @ref{bd1,,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

e registra isso num slot @ref{4b80,,tp_getset}:

@example
.tp_getset = Custom_getsetters,
@end example

A última entrada em uma estrutura @ref{bd1,,PyGetSetDef} é o “closure” mencionado acima. Neste caso, não estamos usando um closure, então simplesmente passamos @code{NULL}.

Também removemos as definições de membros para esses atributos:

@example
static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};
@end example

Também precisamos atualizar o manipulador @ref{581,,tp_init} para permitir apenas strings @footnote{
Agora sabemos que o primeiro e último membros são strings, então talvez pudéssemos ter menos cuidado com a diminuição de suas contagens de referência, no entanto, aceitamos instâncias de subclasses de string. Mesmo que a desalocação de strings normais não retorne aos nossos objetos, não podemos garantir que a desalocação de uma instância de uma subclasse de cadeias de caracteres não retornará aos nossos objetos.
} como valores passados:

@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

Com essas alterações, podemos garantir que os membros @code{first} e @code{last} nunca sejam @code{NULL}, de modo que podemos remover quase todas as verificações de valores @code{NULL}. Isso significa que a maioria das chamadas para @ref{78f,,Py_XDECREF()} pode ser substituída por chamadas para @ref{56f,,Py_DECREF()}. O único lugar em que não podemos substituir essas chamadas é na implementação de @code{tp_dealloc}, onde existe a possibilidade de que a inicialização desses membros tenha falhado em @code{tp_new}.

Também renomeamos a função de inicialização do módulo e o nome do módulo dentro da função de inicialização, como fizemos anteriormente, e adicionamos uma definição extra ao arquivo @code{setup.py}.

@node Apoiando a coleta de lixo cíclica,Criando subclasses de outros tipos,Fornecendo controle mais preciso sobre atributos de dados,Definindo Tipos de Extensão Tutorial
@anchor{extending/newtypes_tutorial supporting-cyclic-garbage-collection}@anchor{4b81}
@subsubsection Apoiando a coleta de lixo cíclica


O Python possui um @ref{1a69,,coletor de lixo (GC) cíclico} que pode identificar objetos que não são mais necessários mesmo quando suas contagens de referências não são zero. Isso pode acontecer quando os objetos participam de ciclos. Por exemplo, considere:

@example
>>> l = []
>>> l.append(l)
>>> del l
@end example

Neste exemplo, criamos uma lista que contém a si mesma. Quando a apagamos, ela ainda possui uma referência apontando para si própria. Sua contagem de referências não cai para zero. Felizmente, o coletor de lixo cíclico do Python acabará percebendo que a lista é lixo e irá liberá-la.

No segunda versão do exemplo de @code{Custom}, permitimos que qualquer tipo de objeto fosse armazenado nos atributos @code{first} ou @code{last} @footnote{
Além disso, mesmo com nossos atributos restritos a instâncias de strings, o usuário poderia passar arbitrariamente subclasses @ref{44c,,str} e, portanto, ainda criar ciclos de referência.
}. Além disso, na segunda e na terceira versões, permitimos estender @code{Custom}, e subclasses podem adicionar atributos arbitrários. Por qualquer um desses dois motivos, instâncias de @code{Custom} podem participar de ciclos:

@example
>>> import custom3
>>> class Derived(custom3.Custom): pass
...
>>> n = Derived()
>>> n.some_attribute = n
@end example

Para permitir que uma instância de @code{Custom} que participa de um ciclo de referência seja corretamente detectada e coletada pelo coletor de lixo cíclico, nosso tipo @code{Custom} precisa preencher dois slots adicionais e ativar um sinalizador que habilita esses 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 = 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;
@}

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 int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom4",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom4(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

Primeiro, o método de travessia informa ao coletor de lixo cíclico quais subobjetos podem participar de 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

Para cada subobjeto que pode participar de ciclos, precisamos chamar a função @code{visit()}, que é passada para o método de travessia. A função @code{visit()} recebe como argumentos o subobjeto e o argumento extra `arg' fornecido ao método de travessia. Ela retorna um valor inteiro que deve ser retornado se for diferente de zero.

O Python fornece o macro @ref{4b82,,Py_VISIT()}, que automatiza as chamadas às funções visit. Com @ref{4b82,,Py_VISIT()}, podemos minimizar a quantidade de boilerplate em @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 
A implementação de @ref{77e,,tp_traverse} deve nomear seus argumentos exatamente como `visit' e `arg' para que seja possível usar @ref{4b82,,Py_VISIT()}.
@end quotation
@end cartouche

Segundo, precisamos fornecer um método para limpar quaisquer subobjetos que possam participar de ciclos:

@example
static int
Custom_clear(CustomObject *self)
@{
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
@}
@end example

Observe o uso do macro @ref{578,,Py_CLEAR()}. Ele é a forma recomendada e segura de limpar atributos de dados de tipos arbitrários enquanto decrementa suas contagens de referências. Se você chamasse @ref{78f,,Py_XDECREF()} no atributo antes de defini-lo como @code{NULL}, haveria a possibilidade de que o destrutor do atributo chamasse novamente algum código que lesse o atributo (especialmente se houver um ciclo de referência).

@cartouche
@quotation Nota 
Você poderia emular @ref{578,,Py_CLEAR()} ao escrever:

@example
PyObject *tmp;
tmp = self->first;
self->first = NULL;
Py_XDECREF(tmp);
@end example

Apesar disso, é muito mais fácil e menos propenso a erros, usar sempre @ref{578,,Py_CLEAR()} ao excluir um atributo. Não tente micro‐otimizar às custas da robustez!
@end quotation
@end cartouche

O desalocador @code{Custom_dealloc} pode executar código arbitrário ao limpar atributos. Isso significa que o GC pode ser acionado dentro da função. Como o GC presume que a contagem de referências não é zero, precisamos remover o objeto do rastreamento do GC chamando @ref{154e,,PyObject_GC_UnTrack()} antes de limpar os membros. A seguir está nossa versão reimplementada do desalocador usando @ref{154e,,PyObject_GC_UnTrack()} e @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

Por fim, adicionamos o macro @ref{77d,,Py_TPFLAGS_HAVE_GC} aos sinalizadores da classe:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
@end example

Isso é praticamente tudo. Se tivéssemos escrito manipuladores personalizados para @ref{4b7a,,tp_alloc} ou @ref{4b79,,tp_free}, precisaríamos adaptá-los para a coleta de lixo cíclica. A maior parte das extensões usará as versões fornecidas automaticamente.

@node Criando subclasses de outros tipos,,Apoiando a coleta de lixo cíclica,Definindo Tipos de Extensão Tutorial
@anchor{extending/newtypes_tutorial subclassing-other-types}@anchor{4b83}
@subsubsection Criando subclasses de outros tipos


É possível criar novos tipos de extensão derivados de tipos já existentes. É mais fácil herdar dos tipos embutidos, já que uma extensão pode usar diretamente o @ref{ab4,,PyTypeObject} de que precisa. Pode ser difícil compartilhar essas estruturas @ref{ab4,,PyTypeObject} entre módulos de extensão distintos.

Neste exemplo, criaremos um tipo @code{SubList} que herda do tipo embutido @ref{611,,list}. O novo tipo será totalmente compatível com listas comuns, mas terá um método adicional, @code{increment()}, que incrementa um contador interno:

@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 = @{
    .ob_base = 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 int
sublist_module_exec(PyObject *m)
@{
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot sublist_module_slots[] = @{
    @{Py_mod_exec, sublist_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef sublist_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "sublist",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = sublist_module_slots,
@};

PyMODINIT_FUNC
PyInit_sublist(void)
@{
    return PyModuleDef_Init(&sublist_module);
@}
@end example

Como você pode consultar, o código-fonte se assemelha bastante aos exemplos de @code{Custom} das seções anteriores. Vamos detalhar as principais diferenças entre eles.

@example
typedef struct @{
    PyListObject list;
    int state;
@} SubListObject;
@end example

A diferença principal para objetos de tipos derivados é que a estrutura de objeto do tipo base deve ser o primeiro valor. O tipo base já inclui o @ref{1321,,PyObject_HEAD()} no início de sua própria estrutura.

Quando um objeto Python é uma instância de @code{SubList}, seu ponteiro @code{PyObject *} pode ser convertido com segurança tanto para @code{PyListObject *} quanto para @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

Vemos acima como chamar o método @ref{6b0,,__init__()} do tipo base.

Esse padrão é importante ao escrever um tipo que possui membros personalizados em @ref{57f,,tp_new} e @ref{4b66,,tp_dealloc}. O manipulador @ref{57f,,tp_new} não deve realmente criar a memória do objeto usando o seu próprio @ref{4b7a,,tp_alloc}; em vez disso, deve permitir que a classe base faça isso, chamando o seu próprio @ref{57f,,tp_new}.

A estrutura @ref{ab4,,PyTypeObject} provê o campo @ref{20b8,,tp_base}, que especifica a classe base concreta do tipo. Devido a problemas de compilação multiplataforma, não se deve preencher esse campo diretamente com uma referência para @ref{4b84,,PyList_Type}; isso deve ser feito dentro da função @ref{985,,Py_mod_exec}:

@example
static int
sublist_module_exec(PyObject *m)
@{
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        return -1;
    @}

    return 0;
@}
@end example

Antes de chamar @ref{77c,,PyType_Ready()}, a estrutura do tipo deve ter o slot @ref{20b8,,tp_base} preenchido. Ao derivarmos um tipo existente, não é necessário preencher o slot @ref{4b7a,,tp_alloc} com @ref{4b76,,PyType_GenericNew()} — a função de alocação do tipo base será herdada.

Depois disso, chamar @ref{77c,,PyType_Ready()} e adicionar o objeto de tipo ao módulo é o mesmo processo usado nos exemplos básicos com @code{Custom}.

@node Defining Extension Types Assorted Topics,Construindo extensões C e C++,Definindo Tipos de Extensão Tutorial,Criando extensões sem ferramentas de terceiros
@anchor{extending/newtypes doc}@anchor{4b85}@anchor{extending/newtypes defining-extension-types-assorted-topics}@anchor{4b86}@anchor{extending/newtypes new-types-topics}@anchor{4b87}@anchor{extending/newtypes translation-repo}@anchor{4b88}
@subsection Defining Extension Types: Assorted Topics

@anchor{extending/newtypes dnt-type-methods}@anchor{4b89}
This section aims to give a quick fly-by on the various type methods you can
implement and what they do.

Here is the definition of @ref{ab4,,PyTypeObject}, with some fields only used in
@ref{1f9,,debug builds} omitted:

@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

Now that’s a `lot' of methods.  Don’t worry too much though – if you have
a type you want to define, the chances are very good that you will only
implement a handful of these.

As you probably expect by now, we’re going to go over this and give more
information about the various handlers.  We won’t go in the order they are
defined in the structure, because there is a lot of historical baggage that
impacts the ordering of the fields.  It’s often easiest to find an example
that includes the fields you need and then change the values to suit your new
type.

@example
const char *tp_name; /* For printing */
@end example

The name of the type – as mentioned in the previous chapter, this will appear in
various places, almost entirely for diagnostic purposes. Try to choose something
that will be helpful in such a situation!

@example
Py_ssize_t tp_basicsize, tp_itemsize; /* For allocation */
@end example

These fields tell the runtime how much memory to allocate when new objects of
this type are created.  Python has some built-in support for variable length
structures (think: strings, tuples) which is where the @ref{20fd,,tp_itemsize} field
comes in.  This will be dealt with later.

@example
const char *tp_doc;
@end example

Here you can put a string (or its address) that you want returned when the
Python script references @code{obj.__doc__} to retrieve the doc string.

Now we come to the basic type methods – the ones most extension types will
implement.

@menu
* Finalization and De-allocation:: 
* Object Presentation:: 
* Attribute Management:: 
* Object Comparison:: 
* Abstract Protocol Support:: 
* Weak Reference Support:: 
* More Suggestions:: 

@end menu

@node Finalization and De-allocation,Object Presentation,,Defining Extension Types Assorted Topics
@anchor{extending/newtypes finalization-and-de-allocation}@anchor{4b8a}
@subsubsection Finalization and De-allocation


@geindex objeto;deallocation
@geindex deallocation@comma{} object
@geindex objeto;finalization
@geindex finalization@comma{} of objects

@example
destructor tp_dealloc;
@end example

This function is called when the reference count of the instance of your type is
reduced to zero and the Python interpreter wants to reclaim it.  If your type
has memory to free or other clean-up to perform, you can put it here.  The
object itself needs to be freed here as well.  Here is an example of this
function:

@example
static void
newdatatype_dealloc(newdatatypeobject *obj)
@{
    free(obj->obj_UnderlyingDatatypePtr);
    Py_TYPE(obj)->tp_free((PyObject *)obj);
@}
@end example

If your type supports garbage collection, the destructor should call
@ref{154e,,PyObject_GC_UnTrack()} before clearing any member fields:

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

One important requirement of the deallocator function is that it leaves any
pending exceptions alone.  This is important since deallocators are frequently
called as the interpreter unwinds the Python stack; when the stack is unwound
due to an exception (rather than normal returns), nothing is done to protect the
deallocators from seeing that an exception has already been set.  Any actions
which a deallocator performs which may cause additional Python code to be
executed may detect that an exception has been set.  This can lead to misleading
errors from the interpreter.  The proper way to protect against this is to save
a pending exception before performing the unsafe action, and restoring it when
done.  This can be done using the @ref{3f3,,PyErr_Fetch()} and
@ref{3f6,,PyErr_Restore()} functions:

@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 
There are limitations to what you can safely do in a deallocator function.
First, if your type supports garbage collection (using @ref{77e,,tp_traverse}
and/or @ref{4b8b,,tp_clear}), some of the object’s members can have been
cleared or finalized by the time @ref{4b66,,tp_dealloc} is called.  Second, in
@ref{4b66,,tp_dealloc}, your object is in an unstable state: its reference
count is equal to zero.  Any call to a non-trivial object or API (as in the
example above) might end up calling @ref{4b66,,tp_dealloc} again, causing a
double free and a crash.

Starting with Python 3.4, it is recommended not to put any complex
finalization code in @ref{4b66,,tp_dealloc}, and instead use the new
@ref{ab5,,tp_finalize} type method.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} explains the new finalization scheme.

@end quotation
@end cartouche

@geindex string;object representation
@geindex função embutida;repr

@node Object Presentation,Attribute Management,Finalization and De-allocation,Defining Extension Types Assorted Topics
@anchor{extending/newtypes object-presentation}@anchor{4b8c}
@subsubsection Object Presentation


In Python, there are two ways to generate a textual representation of an object:
the @ref{800,,repr()} function, and the @ref{44c,,str()} function.  (The @ref{fa9,,print()}
function just calls @ref{44c,,str()}.)  These handlers are both optional.

@example
reprfunc tp_repr;
reprfunc tp_str;
@end example

The @ref{4b8d,,tp_repr} handler should return a string object containing a
representation of the instance for which it is called.  Here is a simple
example:

@example
static PyObject *
newdatatype_repr(newdatatypeobject *obj)
@{
    return PyUnicode_FromFormat("Repr-ified_newdatatype@{@{size:%d@}@}",
                                obj->obj_UnderlyingDatatypePtr->size);
@}
@end example

If no @ref{4b8d,,tp_repr} handler is specified, the interpreter will supply a
representation that uses the type’s @ref{1a3c,,tp_name} and a uniquely identifying
value for the object.

The @ref{4b8e,,tp_str} handler is to @ref{44c,,str()} what the @ref{4b8d,,tp_repr} handler
described above is to @ref{800,,repr()}; that is, it is called when Python code calls
@ref{44c,,str()} on an instance of your object.  Its implementation is very similar
to the @ref{4b8d,,tp_repr} function, but the resulting string is intended for human
consumption.  If @ref{4b8e,,tp_str} is not specified, the @ref{4b8d,,tp_repr} handler is
used instead.

Here is a simple example:

@example
static PyObject *
newdatatype_str(newdatatypeobject *obj)
@{
    return PyUnicode_FromFormat("Stringified_newdatatype@{@{size:%d@}@}",
                                obj->obj_UnderlyingDatatypePtr->size);
@}
@end example

@node Attribute Management,Object Comparison,Object Presentation,Defining Extension Types Assorted Topics
@anchor{extending/newtypes attribute-management}@anchor{4b8f}
@subsubsection Attribute Management


For every object which can support attributes, the corresponding type must
provide the functions that control how the attributes are resolved.  There needs
to be a function which can retrieve attributes (if any are defined), and another
to set attributes (if setting attributes is allowed).  Removing an attribute is
a special case, for which the new value passed to the handler is @code{NULL}.

Python supports two pairs of attribute handlers; a type that supports attributes
only needs to implement the functions for one pair.  The difference is that one
pair takes the name of the attribute as a char*, while the other
accepts a @ref{339,,PyObject}*.  Each type can use whichever pair makes more
sense for the implementation’s convenience.

@example
getattrfunc  tp_getattr;        /* char * version */
setattrfunc  tp_setattr;
/* ... */
getattrofunc tp_getattro;       /* PyObject * version */
setattrofunc tp_setattro;
@end example

If accessing attributes of an object is always a simple operation (this will be
explained shortly), there are generic implementations which can be used to
provide the @ref{339,,PyObject}* version of the attribute management functions.
The actual need for type-specific attribute handlers almost completely
disappeared starting with Python 2.2, though there are many examples which have
not been updated to use some of the new generic mechanism that is available.

@menu
* Generic Attribute Management:: 
* Type-specific Attribute Management:: 

@end menu

@node Generic Attribute Management,Type-specific Attribute Management,,Attribute Management
@anchor{extending/newtypes generic-attribute-management}@anchor{4b7c}@anchor{extending/newtypes id1}@anchor{4b90}
@subsubsection Generic Attribute Management


Most extension types only use `simple' attributes.  So, what makes the
attributes simple?  There are only a couple of conditions that must be met:


@enumerate 

@item 
The name of the attributes must be known when @ref{77c,,PyType_Ready()} is
called.

@item 
No special processing is needed to record that an attribute was looked up or
set, nor do actions need to be taken based on the value.
@end enumerate

Note that this list does not place any restrictions on the values of the
attributes, when the values are computed, or how relevant data is stored.

When @ref{77c,,PyType_Ready()} is called, it uses three tables referenced by the
type object to create @ref{1658,,descriptor}s which are placed in the dictionary of the
type object.  Each descriptor controls access to one attribute of the instance
object.  Each of the tables is optional; if all three are @code{NULL}, instances of
the type will only have attributes that are inherited from their base type, and
should leave the @ref{17e6,,tp_getattro} and @ref{4b91,,tp_setattro} fields @code{NULL} as
well, allowing the base type to handle attributes.

The tables are declared as three fields of the type object:

@example
struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;
@end example

If @ref{4b7d,,tp_methods} is not @code{NULL}, it must refer to an array of
@ref{151f,,PyMethodDef} structures.  Each entry in the table is an instance of this
structure:

@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{4b92,,ml_name} field of the sentinel must be @code{NULL}.

The second table is used to define attributes which map directly to data stored
in the instance.  A variety of primitive C types are supported, and access may
be read-only or read-write.  The structures in the table are defined as:

@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{1658,,descriptor} will be constructed and added to the
type which will be able to extract a value from the instance structure.  The
@ref{4b93,,type} field should contain a type code like @ref{58f,,Py_T_INT} or
@ref{590,,Py_T_DOUBLE}; the value will be used to determine how to
convert Python values to and from C values.  The @ref{4b94,,flags} field is used to
store flags which control how the attribute can be accessed: you can set it to
@ref{591,,Py_READONLY} to prevent Python code from setting it.

An interesting advantage of using the @ref{4b7b,,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{1e35,,__doc__} attribute.

As with the @ref{4b7d,,tp_methods} table, a sentinel entry with a @ref{4b92,,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 Type-specific Attribute Management,,Generic Attribute Management,Attribute Management
@anchor{extending/newtypes type-specific-attribute-management}@anchor{4b95}
@subsubsection Type-specific Attribute Management


For simplicity, only the char* version will be demonstrated here; the
type of the name parameter is the only difference between the char*
and @ref{339,,PyObject}* flavors of the interface. This example effectively does
the same thing as the generic example above, but does not use the generic
support added in Python 2.2.  It explains how the handler functions are
called, so that if you do need to extend their functionality, you’ll understand
what needs to be done.

The @ref{4b96,,tp_getattr} handler is called when the object requires an attribute
look-up.  It is called in the same situations where the @ref{4d3,,__getattr__()}
method of a class would be called.

Aqui está um exemplo:

@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{4b97,,tp_setattr} handler is called when the @ref{20bf,,__setattr__()} or
@ref{20c0,,__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{4b97,,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 Object Comparison,Abstract Protocol Support,Attribute Management,Defining Extension Types Assorted Topics
@anchor{extending/newtypes object-comparison}@anchor{4b98}
@subsubsection Object Comparison


@example
richcmpfunc tp_richcompare;
@end example

The @ref{4b99,,tp_richcompare} handler is called when comparisons are needed.  It is
analogous to the @ref{20f0,,rich comparison methods}, like
@code{__lt__()}, and also called by @ref{4b9a,,PyObject_RichCompare()} and
@ref{1b1b,,PyObject_RichCompareBool()}.

This function is called with two Python objects and the operator as arguments,
where the operator is one of @code{Py_EQ}, @code{Py_NE}, @code{Py_LE}, @code{Py_GE},
@code{Py_LT} or @code{Py_GT}.  It should compare the two objects with respect to the
specified operator and return @code{Py_True} or @code{Py_False} if the comparison is
successful, @code{Py_NotImplemented} to indicate that comparison is not
implemented and the other object’s comparison method should be tried, or @code{NULL}
if an exception was set.

Here is a sample implementation, for a datatype that is considered equal if the
size of an internal pointer is equal:

@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 Abstract Protocol Support,Weak Reference Support,Object Comparison,Defining Extension Types Assorted Topics
@anchor{extending/newtypes abstract-protocol-support}@anchor{4b9b}
@subsubsection Abstract Protocol Support


Python supports a variety of `abstract' ‘protocols;’ the specific interfaces
provided to use these interfaces are documented in @ref{4b9c,,Camada de Objetos Abstratos}.

A number of these abstract interfaces were defined early in the development of
the Python implementation.  In particular, the number, mapping, and sequence
protocols have been part of Python since the beginning.  Other protocols have
been added over time.  For protocols which depend on several handler routines
from the type implementation, the older protocols have been defined as optional
blocks of handlers referenced by the type object.  For newer protocols there are
additional slots in the main type object, with a flag bit being set to indicate
that the slots are present and should be checked by the interpreter.  (The flag
bit does not indicate that the slot values are non-@code{NULL}. The flag may be set
to indicate the presence of a slot, but a slot may still be unfilled.)

@example
PyNumberMethods   *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods  *tp_as_mapping;
@end example

If you wish your object to be able to act like a number, a sequence, or a
mapping object, then you place the address of a structure that implements the C
type @ref{1465,,PyNumberMethods}, @ref{4b9d,,PySequenceMethods}, or
@ref{4b9e,,PyMappingMethods}, respectively. It is up to you to fill in this
structure with appropriate values. You can find examples of the use of each of
these in the @code{Objects} directory of the Python source distribution.

@example
hashfunc tp_hash;
@end example

This function, if you choose to provide it, should return a hash number for an
instance of your data type. Here is a simple example:

@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{12a5,,Py_hash_t} is a signed integer type with a platform-varying width.
Returning @code{-1} from @ref{4b9f,,tp_hash} indicates an error,
which is why you should be careful to avoid returning it when hash computation
is successful, as seen above.

@example
ternaryfunc tp_call;
@end example

This function is called when an instance of your data type is “called”, for
example, if @code{obj1} is an instance of your data type and the Python script
contains @code{obj1('hello')}, the @ref{559,,tp_call} handler is invoked.

This function takes three arguments:


@enumerate 

@item 
`self' is the instance of the data type which is the subject of the call.
If the call is @code{obj1('hello')}, then `self' is @code{obj1}.

@item 
`args' is a tuple containing the arguments to the call.  You can use
@ref{571,,PyArg_ParseTuple()} to extract the arguments.

@item 
`kwds' is a dictionary of keyword arguments that were passed. If this is
non-@code{NULL} and you support keyword arguments, use
@ref{383,,PyArg_ParseTupleAndKeywords()} to extract the arguments.  If you
do not want to support keyword arguments and this is non-@code{NULL}, raise a
@ref{2c3,,TypeError} with a message saying that keyword arguments are not supported.
@end enumerate

Here is a toy @code{tp_call} implementation:

@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{1537,,tp_iter} corresponds
to the Python @ref{c8a,,__iter__()} method, while @ref{1538,,tp_iternext}
corresponds to the Python @ref{1310,,__next__()} method.

Any @ref{1268,,iterable} object must implement the @ref{1537,,tp_iter}
handler, which must return an @ref{1ac,,iterator} object.  Here the same guidelines
apply as for Python classes:


@itemize *

@item 
For collections (such as lists and tuples) which can support multiple
independent iterators, a new iterator should be created and returned by
each call to @ref{1537,,tp_iter}.

@item 
Objects which can only be iterated over once (usually due to side effects of
iteration, such as file objects) can implement @ref{1537,,tp_iter}
by returning a new reference to themselves – and should also therefore
implement the @ref{1538,,tp_iternext}  handler.
@end itemize

Any @ref{1ac,,iterator} object should implement both @ref{1537,,tp_iter}
and @ref{1538,,tp_iternext}.  An iterator’s
@ref{1537,,tp_iter} handler should return a new reference
to the iterator.  Its @ref{1538,,tp_iternext} handler should
return a new reference to the next object in the iteration, if there is one.
If the iteration has reached the end, @ref{1538,,tp_iternext}
may return @code{NULL} without setting an exception, or it may set
@ref{c15,,StopIteration} `in addition' to returning @code{NULL}; avoiding
the exception can yield slightly better performance.  If an actual error
occurs, @ref{1538,,tp_iternext} should always set an exception
and return @code{NULL}.

@node Weak Reference Support,More Suggestions,Abstract Protocol Support,Defining Extension Types Assorted Topics
@anchor{extending/newtypes weak-reference-support}@anchor{4ba0}@anchor{extending/newtypes weakref-support}@anchor{26ff}
@subsubsection Weak Reference Support


One of the goals of Python’s weak reference implementation is to allow any type
to participate in the weak reference mechanism without incurring the overhead on
performance-critical objects (such as numbers).


@subsubheading Ver também


Documentação do 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{19fd,,tp_flags}
field. The legacy @ref{98f,,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{576,,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 More Suggestions,,Weak Reference Support,Defining Extension Types Assorted Topics
@anchor{extending/newtypes more-suggestions}@anchor{4ba1}
@subsubsection More Suggestions


In order to learn how to implement any specific method for your new data type,
get the @ref{6f6,,CPython} source code.  Go to the @code{Objects} directory,
then search the C source files for @code{tp_} plus the function you want
(for example, @code{tp_richcompare}).  You will find examples of the function
you want to implement.

When you need to verify that an object is a concrete instance of the type you
are implementing, use the @ref{1a41,,PyObject_TypeCheck()} function.  A sample of
its use might be something like the following:

@example
if (!PyObject_TypeCheck(some_object, &MyType)) @{
    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    return NULL;
@}
@end example


@subsubheading Ver também



@table @asis

@item Download CPython source releases.

@indicateurl{https://www.python.org/downloads/source/}

@item The CPython project on GitHub, where the CPython source code is developed.

@indicateurl{https://github.com/python/cpython}
@end table


@node Construindo extensões C e C++,Construindo Extensões C e C++ no Windows,Defining Extension Types Assorted Topics,Criando extensões sem ferramentas de terceiros
@anchor{extending/building doc}@anchor{4ba2}@anchor{extending/building building}@anchor{4b51}@anchor{extending/building building-c-and-c-extensions}@anchor{4ba3}@anchor{extending/building translation-repo}@anchor{4ba4}
@subsection Construindo extensões C e C++


Uma extensão C para CPython é uma biblioteca compartilhada (por exemplo, um arquivo @code{.so} no Linux, @code{.pyd} no Windows), que exporta uma `função de inicialização'.

Para ser importável, a biblioteca compartilhada deve estar disponível em 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}, e deve ser nomeada após o nome do módulo, com uma extensão apropriada. Ao usar setuptools, o nome do arquivo correto é gerado automaticamente.

A função de inicialização tem a assinatura:

@geindex PyInit_modulename (C function)
@anchor{extending/building c PyInit_modulename}@anchor{4ba5}
@deffn {C Função} @ref{339,,PyObject} *PyInit_modulename (void)
@end deffn

Ela retorna um módulo totalmente inicializado ou uma instância de @ref{984,,PyModuleDef}. Veja @ref{4ba6,,Inicializando módulos C} para detalhes.

Para módulos com nomes com somente ASCII, a função deve ser nomeada @code{PyInit_@var{<nome>}}, com @code{<nome>} substituído pelo nome do módulo. Ao usar @ref{4ba7,,Inicialização multifásica}, nomes de módulos não ASCII são permitidos. Neste caso, o nome da função de inicialização é @code{PyInitU_@var{<nome>}}, com @code{<nome>} codificado usando a codificação `punycode' do Python com hífenes substituídos por sublinhados. Em Python:

@example
def nome_func_iniciadora(nome):
    try:
        sufixo = b'_' + nome.encode('ascii')
    except UnicodeEncodeError:
        sufixo = b'U_' + nome.encode('punycode').replace(b'-', b'_')
    return b'PyInit' + sufixo
@end example

É possível exportar vários módulos de uma única biblioteca compartilhada, definindo várias funções de inicialização. No entanto, importá-los requer o uso de links simbólicos ou um importador personalizado, porque por padrão apenas a função correspondente ao nome do arquivo é encontrada. Veja a seção  `“Multiple modules in one library”' na 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} para detalhes.
@anchor{extending/building install-index}@anchor{f28}
@menu
* Construindo extensões C e C ++ com setuptools:: 

@end menu

@node Construindo extensões C e C ++ com setuptools,,,Construindo extensões C e C++
@anchor{extending/building building-c-and-c-extensions-with-setuptools}@anchor{4ba8}@anchor{extending/building setuptools-index}@anchor{f29}
@subsubsection Construindo extensões C e C ++ com setuptools


O Python 3.12 e mais recente não vêm mais com distutils. Consulte a documentação @code{setuptools} em @indicateurl{https://setuptools.readthedocs.io/en/latest/setuptools.html} para saber mais sobre como construir e distribuir extensões C/C++ com setuptools.

@node Construindo Extensões C e C++ no Windows,,Construindo extensões C e C++,Criando extensões sem ferramentas de terceiros
@anchor{extending/windows doc}@anchor{4ba9}@anchor{extending/windows building-c-and-c-extensions-on-windows}@anchor{4baa}@anchor{extending/windows building-on-windows}@anchor{1fbf}@anchor{extending/windows translation-repo}@anchor{4bab}
@subsection Construindo Extensões C e C++ no Windows


Este capítulo explica brevemente como criar um módulo de extensão do Windows para Python usando o Microsoft Visual C++ e segue com informações mais detalhadas sobre como ele funciona. O material explicativo é útil para o programador do Windows aprender a construir extensões Python e o programador Unix interessado em produzir software que possa ser construído com sucesso no Unix e no Windows.

Os autores de módulos são encorajados a usar a abordagem distutils para construir módulos de extensão, em vez daquele descrito nesta seção. Você ainda precisará do compilador C que foi usado para construir o Python; normalmente o Microsoft Visual C++.

@cartouche
@quotation Nota 
Este capítulo menciona vários nomes de arquivos que incluem um número de versão do Python codificado. Esses nomes de arquivos são representados com o número da versão mostrado como @code{XY}; na prática, @code{'X'} será o número da versão principal e @code{'Y'} será o número da versão secundária da versão do Python com a qual você está trabalhando. Por exemplo, se você estiver usando o Python 2.2.1, @code{XY} será @code{22}.
@end quotation
@end cartouche

@menu
* Uma abordagem de livro de receitas:: 
* Diferenças entre o Unix e o Windows:: 
* Usando DLLs na prática:: 

@end menu

@node Uma abordagem de livro de receitas,Diferenças entre o Unix e o Windows,,Construindo Extensões C e C++ no Windows
@anchor{extending/windows a-cookbook-approach}@anchor{4bac}@anchor{extending/windows win-cookbook}@anchor{4bad}
@subsubsection Uma abordagem de livro de receitas


Existem duas abordagens para construir módulos de extensão no Windows, assim como no Unix: use o pacote @code{setuptools} para controlar o processo de construção ou faça as coisas manualmente. A abordagem setuptools funciona bem para a maioria das extensões; documentação sobre o uso de @code{setuptools} para construir e empacotar módulos de extensão está disponível em @ref{f29,,Construindo extensões C e C ++ com setuptools}. Se você achar que realmente precisa fazer as coisas manualmente, pode ser instrutivo estudar o arquivo do projeto para o módulo de biblioteca padrão winsound@footnote{https://github.com/python/cpython/tree/3.13/PCbuild/winsound.vcxproj}.

@node Diferenças entre o Unix e o Windows,Usando DLLs na prática,Uma abordagem de livro de receitas,Construindo Extensões C e C++ no Windows
@anchor{extending/windows differences-between-unix-and-windows}@anchor{4bae}@anchor{extending/windows dynamic-linking}@anchor{4baf}
@subsubsection Diferenças entre o Unix e o Windows


O Unix e o Windows usam paradigmas completamente diferentes para o carregamento do código em tempo de execução. Antes de tentar construir um módulo que possa ser carregado dinamicamente, esteja ciente de como o seu sistema funciona.

No Unix, um arquivo de objeto compartilhado (@code{.so}) contém código a ser usado pelo programa e também os nomes de funções e dados que ele espera encontrar no programa. Quando o arquivo é associado ao programa, todas as referências a essas funções e dados no código do arquivo são alteradas para apontar para os locais reais no programa em que as funções e os dados são colocados na memória. Isso é basicamente uma operação de vinculação.

No Windows, um arquivo de biblioteca de vínculo dinâmico (@code{.dll}) não possui referências pendentes. Em vez disso, um acesso a funções ou dados passa por uma tabela de pesquisa. Portanto, o código DLL não precisa ser corrigido no tempo de execução para se referir à memória do programa; em vez disso, o código já usa a tabela de pesquisa da DLL e a tabela de pesquisa é modificada em tempo de execução para apontar para as funções e dados.

No Unix, existe apenas um tipo de arquivo de biblioteca (@code{.a}) que contém código de vários arquivos de objetos (@code{.o}). Durante a etapa da vinculação para criar um arquivo de objeto compartilhado (@code{.so}), o vinculador pode achar que não sabe onde um identificador está definido. O vinculador procurará nos arquivos de objeto nas bibliotecas; se encontrar, incluirá todo o código desse arquivo de objeto.

No Windows, existem dois tipos de biblioteca, uma biblioteca estática e uma biblioteca de importação (ambas chamadas @code{.lib}). Uma biblioteca estática é como um arquivo Unix @code{.a}; contém código a ser incluído conforme necessário. Uma biblioteca de importação é basicamente usada apenas para garantir ao vinculador que um determinado identificador é legal e estará presente no programa quando a DLL for carregada. Portanto, o vinculador usa as informações da biblioteca de importação para construir a tabela de pesquisa para o uso de identificadores que não estão incluídos na DLL. Quando uma aplicação ou uma DLL é vinculado, pode ser gerada uma biblioteca de importação, que precisará ser usada para todas as DLLs futuras que dependem dos símbolos na aplicação ou DLL.

Suponha que você esteja construindo dois módulos de carregamento dinâmico, B e C, que devem compartilhar outro bloco de código A. No Unix, você `não' passaria @code{A.a} ao ligador para @code{B.so} e @code{C.so}; isso faria com que fosse incluído duas vezes, para que B e C tivessem sua própria cópia. No Windows, a construção @code{A.dll} também construirá @code{A.lib}. Você `passa' @code{A.lib} ao ligador para B e C. @code{A.lib} não contém código; apenas contém informações que serão usadas em tempo de execução para acessar o código de A.

No Windows, usar uma biblioteca de importação é como usar @code{import spam}; fornece acesso aos nomes de spam, mas não cria uma cópia separada. No Unix, vincular a uma biblioteca é mais como @code{from spam import *}; ele cria uma cópia separada.

@node Usando DLLs na prática,,Diferenças entre o Unix e o Windows,Construindo Extensões C e C++ no Windows
@anchor{extending/windows using-dlls-in-practice}@anchor{4bb0}@anchor{extending/windows win-dlls}@anchor{4bb1}
@subsubsection Usando DLLs na prática


O Python para Windows é criado no Microsoft Visual C++; o uso de outros compiladores pode ou não funcionar. O restante desta seção é específico do MSVC++.

Ao criar DLLs no Windows, você deve passar @code{pythonXY.lib} para o ligador. Para construir duas DLLs, spam e ni (que usa funções C encontradas em spam), você pode usar estes 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

O primeiro comando criou três arquivos: @code{spam.obj}, @code{spam.dll} e @code{spam.lib}. O @code{spam.dll} não contém nenhuma função Python (como @ref{571,,PyArg_ParseTuple()}), mas sabe como encontrar o código Python graças a @code{pythonXY.lib}.

O segundo comando criou @code{ni.dll} (e @code{.obj} e @code{.lib}), que sabe como encontrar as funções necessárias do spam e também do executável do Python.

Nem todo identificador é exportado para a tabela de pesquisa. Se você deseja que outros módulos (incluindo Python) possam ver seus identificadores, é necessário dizer @code{_declspec(dllexport)}, como em @code{void _declspec(dllexport) initspam(void)} ou @code{PyObject _declspec(dllexport) *NiGetSpamData(void)}.

O Developer Studio incluirá muitas bibliotecas importadas que você realmente não precisa, adicionando cerca de 100K ao seu executável.  Para se livrar delas, use a caixa de diálogo de configurações do projeto, na aba vincular, para especificar `ignorar bibliotecas padrão'.  Adicione o @code{msvcrt`xx'.lib} correto à lista de bibliotecas.

@node Incorporando o tempo de execução do CPython em uma aplicação maior,,Criando extensões sem ferramentas de terceiros,Estendendo e incorporando o interpretador Python
@anchor{extending/index embedding-the-cpython-runtime-in-a-larger-application}@anchor{4bb2}
@section Incorporando o tempo de execução do CPython em uma aplicação maior


Às vezes, em vez de criar uma extensão que é executada dentro do interpretador Python como a aplicação principal, é desejável incorporar o tempo de execução do CPython em uma aplicação maior. Esta seção aborda alguns dos detalhes envolvidos para fazer isso com êxito.

@menu
* Incorporando o Python numa Outra Aplicação:: 

@end menu

@node Incorporando o Python numa Outra Aplicação,,,Incorporando o tempo de execução do CPython em uma aplicação maior
@anchor{extending/embedding doc}@anchor{4bb3}@anchor{extending/embedding embedding}@anchor{1fdd}@anchor{extending/embedding embedding-python-in-another-application}@anchor{4bb4}
@subsection Incorporando o Python numa Outra Aplicação


Os capítulos anteriores discutiram como estender o Python, ou seja, como expandir a funcionalidade do Python anexando uma biblioteca de funções em C a ele. Também é possível fazer o inverso: enriquecer sua aplicação em C/C++ incorporando o Python nela. A incorporação fornece à sua aplicação a capacidade de implementar parte da funcionalidade da aplicação em Python em vez de C ou C++. Isso pode ser usado para diversos propósitos; um exemplo seria permitir que os usuários personalizem a aplicação de acordo com suas necessidades escrevendo alguns scripts em Python. Você também pode usá-la se parte da funcionalidade puder ser escrita em Python mais facilmente.

Incorporar o Python é semelhante a estendê-lo, mas não exatamente. A diferença é que, ao estender o Python, o programa principal da aplicação ainda é o interpretador Python, enquanto que, se você incorporar o Python, o programa principal pode não ter nada a ver com o Python — em vez disso, algumas partes da aplicação chamam ocasionalmente o interpretador Python para executar algum código Python.

So if you are embedding Python, you are providing your own main program.  One of
the things this main program has to do is initialize the Python interpreter.  At
the very least, you have to call the function @ref{8b1,,Py_Initialize()}.  There are
optional calls to pass command line arguments to Python.  Then later you can
call the interpreter from any part of the application.

There are several different ways to call the interpreter: you can pass a string
containing Python statements to @ref{4bb5,,PyRun_SimpleString()}, or you can pass a
stdio file pointer and a file name (for identification in error messages only)
to @ref{4bb6,,PyRun_SimpleFile()}.  You can also call the lower-level operations
described in the previous chapters to construct and use Python objects.


@subsubheading Ver também



@table @asis

@item @ref{1d57,,Manual de referência da API Python/C}

The details of Python’s C interface are given in this manual. A great deal of
necessary information can be found here.
@end table


@menu
* Very High Level Embedding:: 
* Beyond Very High Level Embedding; An overview: Beyond Very High Level Embedding An overview. 
* Pure Embedding:: 
* Extending Embedded Python:: 
* Embedding Python in C++:: 
* Compiling and Linking under Unix-like systems:: 

@end menu

@node Very High Level Embedding,Beyond Very High Level Embedding An overview,,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding high-level-embedding}@anchor{4bb7}@anchor{extending/embedding very-high-level-embedding}@anchor{4bb8}
@subsubsection Very High Level Embedding


The simplest form of embedding Python is the use of the very high level
interface. This interface is intended to execute a Python script without needing
to interact with the application directly. This can for example be used to
perform some operation on a file.

@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{38b,,Strings e buffers} for a description of this macro.
@end quotation
@end cartouche

Setting @ref{3c4,,PyConfig.program_name} should be called before
@ref{3c5,,Py_InitializeFromConfig()} to inform the interpreter about paths to Python run-time
libraries.  Next, the Python interpreter is initialized with
@ref{8b1,,Py_Initialize()}, followed by the execution of a hard-coded Python script
that prints the date and time.  Afterwards, the @ref{d37,,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{4bb6,,PyRun_SimpleFile()} function, which saves you the
trouble of allocating memory space and loading the file contents.

@node Beyond Very High Level Embedding An overview,Pure Embedding,Very High Level Embedding,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding beyond-very-high-level-embedding-an-overview}@anchor{4bb9}@anchor{extending/embedding lower-level-embedding}@anchor{4bba}
@subsubsection Beyond Very High Level Embedding: An overview


The high level interface gives you the ability to execute arbitrary pieces of
Python code from your application, but exchanging data values is quite
cumbersome to say the least. If you want that, you should use lower level calls.
At the cost of having to write more C code, you can achieve almost anything.

It should be noted that extending Python and embedding Python is quite the same
activity, despite the different intent. Most topics discussed in the previous
chapters are still valid. To show this, consider what the extension code from
Python to C really does:


@enumerate 

@item 
Convert data values from Python to C,

@item 
Perform a function call to a C routine using the converted values, and

@item 
Convert the data values from the call from C to Python.
@end enumerate

When embedding Python, the interface code does:


@enumerate 

@item 
Convert data values from C to Python,

@item 
Perform a function call to a Python interface routine using the converted
values, and

@item 
Convert the data values from the call from Python to C.
@end enumerate

As you can see, the data conversion steps are simply swapped to accommodate the
different direction of the cross-language transfer. The only difference is the
routine that you call between both data conversions. When extending, you call a
C routine, when embedding, you call a Python routine.

This chapter will not discuss how to convert data from Python to C and vice
versa.  Also, proper use of references and dealing with errors is assumed to be
understood.  Since these aspects do not differ from extending the interpreter,
you can refer to earlier chapters for the required information.

@node Pure Embedding,Extending Embedded Python,Beyond Very High Level Embedding An overview,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding id1}@anchor{4bbb}@anchor{extending/embedding pure-embedding}@anchor{4bbc}
@subsubsection Pure Embedding


The first program aims to execute a function in a Python script. Like in the
section about the very high level interface, the Python interpreter does not
directly interact with the application (but that will change in the next
section).

The code to run a function defined in a Python script is:

@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

This code loads a Python script using @code{argv[1]}, and calls the function named
in @code{argv[2]}.  Its integer arguments are the other values of the @code{argv}
array.  If you @ref{4bbd,,compile and link} this program (let’s call
the finished executable @code{call}), and use it to execute a Python
script, such as:

@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

then the result should be:

@example
$ call multiply multiply 3 2
Will compute 3 times 2
Result of call: 6
@end example

Although the program is quite large for its functionality, most of the code is
for data conversion between Python and C, and for error reporting.  The
interesting part with respect to embedding Python starts with

@example
Py_Initialize();
pName = PyUnicode_DecodeFSDefault(argv[1]);
/* Error checking of pName left out */
pModule = PyImport_Import(pName);
@end example

After initializing the interpreter, the script is loaded using
@ref{1443,,PyImport_Import()}.  This routine needs a Python string as its argument,
which is constructed using the @ref{180a,,PyUnicode_DecodeFSDefault()} data
conversion routine.

@example
pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc is a new reference */

if (pFunc && PyCallable_Check(pFunc)) @{
    ...
@}
Py_XDECREF(pFunc);
@end example

Once the script is loaded, the name we’re looking for is retrieved using
@ref{348,,PyObject_GetAttrString()}.  If the name exists, and the object returned is
callable, you can safely assume that it is a function.  The program then
proceeds by constructing a tuple of arguments as normal.  The call to the Python
function is then made with:

@example
pValue = PyObject_CallObject(pFunc, pArgs);
@end example

Upon return of the function, @code{pValue} is either @code{NULL} or it contains a
reference to the return value of the function.  Be sure to release the reference
after examining the value.

@node Extending Embedded Python,Embedding Python in C++,Pure Embedding,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding extending-embedded-python}@anchor{4bbe}@anchor{extending/embedding extending-with-embedding}@anchor{4bbf}
@subsubsection Extending Embedded Python


Until now, the embedded Python interpreter had no access to functionality from
the application itself.  The Python API allows this by extending the embedded
interpreter.  That is, the embedded interpreter gets extended with routines
provided by the application. While it sounds complex, it is not so bad.  Simply
forget for a while that the application starts the Python interpreter.  Instead,
consider the application to be a set of subroutines, and write some glue code
that gives Python access to those routines, just like you would write a normal
Python extension.  For example:

@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 emb_module_methods[] = @{
    @{"numargs", emb_numargs, METH_VARARGS,
     "Return the number of arguments received by the process."@},
    @{NULL, NULL, 0, NULL@}
@};

static struct PyModuleDef emb_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "emb",
    .m_size = 0,
    .m_methods = emb_module_methods,
@};

static PyObject*
PyInit_emb(void)
@{
    return PyModuleDef_Init(&emb_module);
@}
@end example

Insert the above code just above the @code{main()} function. Also, insert the
following two statements before the call to @ref{8b1,,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

Em uma aplicação real, os métodos exporão uma API da aplicação para Python.

@c TODO: threads, code examples do not really behave well if errors happen
@c (what to watch out for)

@node Embedding Python in C++,Compiling and Linking under Unix-like systems,Extending Embedded Python,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding embedding-python-in-c}@anchor{4bc0}@anchor{extending/embedding embeddingincplusplus}@anchor{4bc1}
@subsubsection Embedding Python in C++


It is also possible to embed Python in a C++ program; precisely how this is done
will depend on the details of the C++ system used; in general you will need to
write the main program in C++, and use the C++ compiler to compile and link your
program.  There is no need to recompile Python itself using C++.

@node Compiling and Linking under Unix-like systems,,Embedding Python in C++,Incorporando o Python numa Outra Aplicação
@anchor{extending/embedding compiling}@anchor{4bbd}@anchor{extending/embedding compiling-and-linking-under-unix-like-systems}@anchor{4bc2}
@subsubsection Compiling and Linking under Unix-like systems


It is not necessarily trivial to find the right flags to pass to your
compiler (and linker) in order to embed the Python interpreter into your
application, particularly because Python needs to load library modules
implemented as C dynamic extensions (@code{.so} files) linked against
it.

To find out the required compiler and linker flags, you can execute the
@code{python`X.Y'-config} script which is generated as part of the
installation process (a @code{python3-config} script may also be
available).  This script has several options, of which the following will
be directly useful to you:


@itemize *

@item 
@code{pythonX.Y-config --cflags} will give you the recommended flags when
compiling:

@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 
To avoid confusion between several Python installations (and especially
between the system Python and your own compiled Python), it is recommended
that you use the absolute path to @code{python`X.Y'-config}, as in the above
example.
@end quotation
@end cartouche

If this procedure doesn’t work for you (it is not guaranteed to work for
all Unix-like platforms; however, we welcome @ref{4bc3,,bug reports})
you will have to read your system’s documentation about dynamic linking and/or
examine Python’s @code{Makefile} (use @ref{4617,,sysconfig.get_makefile_filename()}
to find its location) and compilation
options.  In this case, the @ref{db,,sysconfig} module is a useful tool to
programmatically extract the configuration values that you will want to
combine together.  For example:

@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 referência da API Python/C,Instalando módulos Python,Estendendo e incorporando o interpretador Python,Top
@anchor{c-api/index doc}@anchor{4bc4}@anchor{c-api/index c-api-index}@anchor{1d57}@anchor{c-api/index python-c-api-reference-manual}@anchor{4bc5}@anchor{c-api/index translation-repo}@anchor{4bc6}
@chapter Manual de referência da API Python/C


Este manual documenta a API usada por programadores C e C++ que desejam escrever módulos de extensões ou embutir Python. É um complemento para @ref{1d56,,Estendendo e incorporando o interpretador Python}, que descreve os princípios gerais da escrita de extensões mas não documenta as funções da API em detalhes.

@menu
* Introdução: Introdução<13>. 
* Estabilidade da API C:: 
* A camada de nível muito alto:: 
* Contagem de referências:: 
* Tratamento de exceções: Tratamento de exceções<2>. 
* Utilitários: Utilitários<2>. 
* Camada de Objetos Abstratos:: 
* Camada de Objetos Concretos:: 
* Inicialização@comma{} finalização e threads: Inicialização finalização e threads. 
* Configuração de inicialização do Python:: 
* Gerenciamento de Memória:: 
* Suporte a implementação de Objetos:: 
* API e Versionamento de ABI:: 
* API C de monitoramento:: 
* Gerando eventos de execução:: 

@end menu

@node Introdução<13>,Estabilidade da API C,,Manual de referência da API Python/C
@anchor{c-api/intro doc}@anchor{4bc7}@anchor{c-api/intro api-intro}@anchor{4bc8}@anchor{c-api/intro introduction}@anchor{4bc9}
@section Introdução


A Interface de Programação de Aplicações (API) para Python fornece aos programadores C e C++ acesso ao interpretador Python em uma variedade de níveis. A API pode ser usada igualmente em C++, mas, para abreviar, geralmente é chamada de API Python/C. Existem dois motivos fundamentalmente diferentes para usar a API Python/C. A primeira razão é escrever `módulos de extensão' para propósitos específicos; esses são módulos C que estendem o interpretador Python. Este é provavelmente o uso mais comum. O segundo motivo é usar Python como um componente em uma aplicação maior; esta técnica é geralmente referida como `incorporação' Python em uma aplicação.

Escrever um módulo de extensão é um processo relativamente bem compreendido, no qual uma abordagem de “livro de receitas” funciona bem. Existem várias ferramentas que automatizam o processo até certo ponto. Embora as pessoas tenham incorporado o Python em outras aplicações desde sua existência inicial, o processo de incorporação do Python é menos direto do que escrever uma extensão.

Muitas funções da API são úteis independentemente de você estar incorporando ou estendendo o Python; além disso, a maioria das aplicações que incorporam Python também precisará fornecer uma extensão customizada, portanto, é provavelmente uma boa ideia se familiarizar com a escrita de uma extensão antes de tentar incorporar Python em uma aplicação real.

@menu
* Padrões de codificação:: 
* Arquivos de inclusão:: 
* Macros úteis:: 
* Objetos@comma{} tipos e contagens de referências: Objetos tipos e contagens de referências. 
* Exceções: Exceções<21>. 
* Incorporando Python: Incorporando Python<2>. 
* Compilações de depuração:: 
* Ferramentas de terceiros recomendadas: Ferramentas de terceiros recomendadas<2>. 

@end menu

@node Padrões de codificação,Arquivos de inclusão,,Introdução<13>
@anchor{c-api/intro coding-standards}@anchor{4bca}
@subsection Padrões de codificação


Se você estiver escrevendo código C para inclusão no CPython, `deve' seguir as diretrizes e padrões definidos na 
@geindex Propostas de Melhorias do Python; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}. Essas diretrizes se aplicam independentemente da versão do Python com a qual você está contribuindo. Seguir essas convenções não é necessário para seus próprios módulos de extensão de terceiros, a menos que você eventualmente espere contribuí-los para o Python.

@node Arquivos de inclusão,Macros úteis,Padrões de codificação,Introdução<13>
@anchor{c-api/intro api-includes}@anchor{784}@anchor{c-api/intro include-files}@anchor{4bcb}
@subsection Arquivos de inclusão


Todas as definições de função, tipo e macro necessárias para usar a API Python/C estão incluídas em seu código pela seguinte linha:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

Isso implica a inclusão dos seguintes cabeçalhos padrão: @code{<stdio.h>}, @code{<string.h>}, @code{<errno.h>}, @code{<limits.h>}, @code{<assert.h>} e @code{<stdlib.h>} (se disponível).

@cartouche
@quotation Nota 
Uma vez que Python pode definir algumas definições de pré-processador que afetam os cabeçalhos padrão em alguns sistemas, você `deve' incluir @code{Python.h} antes de quaisquer cabeçalhos padrão serem incluídos.

É recomendável sempre definir @code{PY_SSIZE_T_CLEAN} antes de incluir @code{Python.h}. Veja @ref{8ad,,Análise de argumentos e construção de valores} para uma descrição desta macro.
@end quotation
@end cartouche

Todos os nomes visíveis ao usuário definidos por Python.h (exceto aqueles definidos pelos cabeçalhos padrão incluídos) têm um dos prefixos @code{Py} ou @code{_Py}. Nomes começando com @code{_Py} são para uso interno pela implementação Python e não devem ser usados por escritores de extensão. Os nomes dos membros da estrutura não têm um prefixo reservado.

@cartouche
@quotation Nota 
O código do usuário nunca deve definir nomes que começam com @code{Py} ou @code{_Py}. Isso confunde o leitor e coloca em risco a portabilidade do código do usuário para versões futuras do Python, que podem definir nomes adicionais começando com um desses prefixos.
@end quotation
@end cartouche

Os arquivos de cabeçalho são normalmente instalados com Python. No Unix, eles estão localizados nos diretórios @code{`prefix'/include/pythonversion/} e @code{`exec_prefix'/include/pythonversion/}, onde @ref{1ee7,,prefix} e @ref{1ee8,,exec_prefix} são definidos pelos parâmetros correspondentes ao script @code{configure} e `version' do Python é @code{'%d.%d' % sys.version_info[:2]}. No Windows, os cabeçalhos são instalados em @code{`prefix'/include}, onde @code{prefix} é o diretório de instalação especificado para o instalador.

Para incluir os cabeçalhos, coloque os dois diretórios (se diferentes) no caminho de pesquisa do compilador para as inclusões. `Não' coloque os diretórios pais no caminho de busca e então use @code{#include <pythonX.Y/Python.h>}; isto irá quebrar em compilações multiplataforma, uma vez que os cabeçalhos independentes da plataforma em @ref{1ee7,,prefix} incluem os cabeçalhos específicos da plataforma de @ref{1ee8,,exec_prefix}.

Os usuários de C++ devem notar que embora a API seja definida inteiramente usando C, os arquivos de cabeçalho declaram apropriadamente os pontos de entrada como @code{extern "C"}. Como resultado, não há necessidade de fazer nada especial para usar a API do C++.

@node Macros úteis,Objetos tipos e contagens de referências,Arquivos de inclusão,Introdução<13>
@anchor{c-api/intro useful-macros}@anchor{4bcc}
@subsection Macros úteis


Diversas macros úteis são definidas nos arquivos de cabeçalho do Python. Muitas são definidas mais próximas de onde são úteis (por exemplo, @ref{14bb,,Py_RETURN_NONE}). Outras de utilidade mais geral são definidas aqui. Esta não é necessariamente uma lista completa.

@geindex PyMODINIT_FUNC (C macro)
@anchor{c-api/intro c PyMODINIT_FUNC}@anchor{151b}
@deffn {C Macro} PyMODINIT_FUNC

Declara uma função de inicialização do módulo de extensão @code{PyInit}. O tipo de retorno da função é @ref{339,,PyObject}*. A macro declara quaisquer declarações de ligação especial necessárias pela plataforma e, para C++, declara a função como @code{extern "C"}.

A função de inicialização deve ser nomeada @code{PyInit_@var{name}}, onde `name' é o nome do módulo, e deve ser o único item não-@code{static} definido no arquivo do módulo. Exemplo:

@example
static struct PyModuleDef spam_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    ...
@};

PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModuleDef_Init(&spam_module);
@}
@end example
@end deffn

@geindex Py_ABS (C macro)
@anchor{c-api/intro c Py_ABS}@anchor{4bcd}
@deffn {C Macro} Py_ABS (x)

Retorna o valor absoluto de @code{x}.

Se o resultado não puder ser representado (por exemplo, se @code{x} tiver o valor @code{INT_MIN} para o tipo int), o comportamento é indefinido.


Adicionado na versão 3.3.

@end deffn

@geindex Py_ALWAYS_INLINE (C macro)
@anchor{c-api/intro c Py_ALWAYS_INLINE}@anchor{19f6}
@deffn {C Macro} Py_ALWAYS_INLINE

Pede ao compilador para sempre embutir uma função em linha estática. O compilador pode ignorá-lo e decide não inserir a função.

Ele pode ser usado para inserir funções em linha estáticas críticas de desempenho ao compilar Python no modo de depuração com função de inserir em linha desabilitada. Por exemplo, o MSC desabilita a função de inserir em linha ao compilar no modo de depuração.

Marcar cegamente uma função em linha estática com Py_ALWAYS_INLINE pode resultar em desempenhos piores (devido ao aumento do tamanho do código, por exemplo). O compilador geralmente é mais inteligente que o desenvolvedor para a análise de custo/benefício.

Se o Python tiver sido @ref{1f9,,compilado em modo de depuração} (se a macro @ref{4359,,Py_DEBUG} estiver definida), a macro @ref{19f6,,Py_ALWAYS_INLINE} não fará nada.

Deve ser especificado antes do tipo de retorno da função. Uso:

@example
static inline Py_ALWAYS_INLINE int random(void) @{ return 4; @}
@end example


Adicionado na versão 3.11.

@end deffn

@geindex Py_CHARMASK (C macro)
@anchor{c-api/intro c Py_CHARMASK}@anchor{4bce}
@deffn {C Macro} Py_CHARMASK (c)

O argumento deve ser um caractere ou um número inteiro no intervalo [-128, 127] ou [0, 255]. Esta macro retorna @code{c} convertido em um @code{unsigned char}.
@end deffn

@geindex Py_DEPRECATED (C macro)
@anchor{c-api/intro c Py_DEPRECATED}@anchor{ab3}
@deffn {C Macro} Py_DEPRECATED (version)

Use isso para declarações descontinuadas. A macro deve ser colocada antes do nome do símbolo.

Exemplo:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example


Alterado na versão 3.8: Suporte a MSVC foi adicionado.

@end deffn

@geindex Py_GETENV (C macro)
@anchor{c-api/intro c Py_GETENV}@anchor{4bcf}
@deffn {C Macro} Py_GETENV (s)

Como @code{getenv(s)}, mas retorna @code{NULL} se a opção @ref{964,,-E} foi passada na linha de comando (veja @ref{3d9,,PyConfig.use_environment}).
@end deffn

@geindex Py_LOCAL (C macro)
@anchor{c-api/intro c Py_LOCAL}@anchor{1492}
@deffn {C Macro} Py_LOCAL (type)

Declara uma função que retorne o `type' especificado usando um qualificador de chamada rápida para funções locais ao arquivo atual. Semanticamente, isso equivale a @code{static type}.
@end deffn

@geindex Py_LOCAL_INLINE (C macro)
@anchor{c-api/intro c Py_LOCAL_INLINE}@anchor{1493}
@deffn {C Macro} Py_LOCAL_INLINE (type)

Equivalente a @ref{1492,,Py_LOCAL}, mas que também exige que a função seja inserida localmente.
@end deffn

@geindex Py_LOCAL_SYMBOL (C macro)
@anchor{c-api/intro c Py_LOCAL_SYMBOL}@anchor{4bd0}
@deffn {C Macro} Py_LOCAL_SYMBOL

Macro used to declare a symbol as local to the shared library (hidden).
On supported platforms, it ensures the symbol is not exported.

On compatible versions of GCC/Clang, it
expands to @code{__attribute__((visibility("hidden")))}.
@end deffn

@geindex Py_MAX (C macro)
@anchor{c-api/intro c Py_MAX}@anchor{4bd1}
@deffn {C Macro} Py_MAX (x, y)

Retorna o valor máximo entre @code{x} e @code{y}.


Adicionado na versão 3.3.

@end deffn

@geindex Py_MEMBER_SIZE (C macro)
@anchor{c-api/intro c Py_MEMBER_SIZE}@anchor{4bd2}
@deffn {C Macro} Py_MEMBER_SIZE (type, member)

Retorna o tamanho do @code{member} de uma estrutura (@code{type}) em bytes.


Adicionado na versão 3.6.

@end deffn

@geindex Py_MIN (C macro)
@anchor{c-api/intro c Py_MIN}@anchor{4bd3}
@deffn {C Macro} Py_MIN (x, y)

Retorna o valor mínimo entre @code{x} e @code{y}.


Adicionado na versão 3.3.

@end deffn

@geindex Py_NO_INLINE (C macro)
@anchor{c-api/intro c Py_NO_INLINE}@anchor{19f7}
@deffn {C Macro} Py_NO_INLINE

Desabilita a inserção em linha em uma função. Por exemplo, isso reduz o consumo da pilha C: útil em compilações LTO+PGO que faz uso intenso de inserção em linha de código (veja 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


Adicionado na versão 3.11.

@end deffn

@geindex Py_STRINGIFY (C macro)
@anchor{c-api/intro c Py_STRINGIFY}@anchor{4bd4}
@deffn {C Macro} Py_STRINGIFY (x)

Converte @code{x} para uma string C. Por exemplo, @code{Py_STRINGIFY(123)} retorna @code{"123"}.


Adicionado na versão 3.4.

@end deffn

@geindex Py_UNREACHABLE (C macro)
@anchor{c-api/intro c Py_UNREACHABLE}@anchor{bcd}
@deffn {C Macro} Py_UNREACHABLE ()

Use isso quando você tiver um caminho de código que não pode ser alcançado por design. Por exemplo, na cláusula @code{default:} em uma instrução @code{switch} para a qual todos os valores possíveis são incluídos nas instruções @code{case}. Use isto em lugares onde você pode ficar tentado a colocar uma chamada @code{assert(0)} ou @code{abort()}.

No modo de lançamento, a macro ajuda o compilador a otimizar o código e evita um aviso sobre código inacessível. Por exemplo, a macro é implementada com @code{__builtin_unreachable()} no GCC em modo de lançamento.

Um uso para @code{Py_UNREACHABLE()} é seguir uma chamada de uma função que nunca retorna, mas que não é declarada com @code{_Py_NO_RETURN}.

Se um caminho de código for um código muito improvável, mas puder ser alcançado em casos excepcionais, esta macro não deve ser usada. Por exemplo, sob condição de pouca memória ou se uma chamada de sistema retornar um valor fora do intervalo esperado. Nesse caso, é melhor relatar o erro ao chamador. Se o erro não puder ser reportado ao chamador, @ref{98a,,Py_FatalError()} pode ser usada.


Adicionado na versão 3.7.

@end deffn

@geindex Py_UNUSED (C macro)
@anchor{c-api/intro c Py_UNUSED}@anchor{180c}
@deffn {C Macro} Py_UNUSED (arg)

Use isso para argumentos não usados em uma definição de função para silenciar avisos do compilador. Exemplo: @code{int func(int a, int Py_UNUSED(b)) @{ return a; @}}.


Adicionado na versão 3.4.

@end deffn

@geindex Py_BUILD_ASSERT (C macro)
@anchor{c-api/intro c Py_BUILD_ASSERT}@anchor{1729}
@deffn {C Macro} Py_BUILD_ASSERT (cond)

Realiza asserção de uma condição de tempo de compilação `cond', como uma instrução. A construção falhará se a condição for falsa ou não puder ser avaliada em tempo de compilação.

Por exemplo:

@example
Py_BUILD_ASSERT(sizeof(PyTime_t) == sizeof(int64_t));
@end example


Adicionado na versão 3.3.

@end deffn

@geindex Py_BUILD_ASSERT_EXPR (C macro)
@anchor{c-api/intro c Py_BUILD_ASSERT_EXPR}@anchor{172a}
@deffn {C Macro} Py_BUILD_ASSERT_EXPR (cond)

Realiza asserção de uma condição de tempo de compilação `cond', como uma expressão que é avaliada com @code{0}. A construção falhará se a condição for falsa ou não puder ser avaliada em tempo de compilação.

Por exemplo:

@example
#define foo_to_char(foo) \
    ((char *)(foo) + Py_BUILD_ASSERT_EXPR(offsetof(struct foo, string) == 0))
@end example


Adicionado na versão 3.3.

@end deffn

@geindex PyDoc_STRVAR (C macro)
@anchor{c-api/intro c PyDoc_STRVAR}@anchor{1aea}
@deffn {C Macro} PyDoc_STRVAR (name, str)

Cria uma variável com o nome `name' que pode ser usada em docstrings. Se o Python for construído sem docstrings, o valor estará vazio.

Use @ref{1aea,,PyDoc_STRVAR} para docstrings para ter suporte à compilação do Python sem docstrings, conforme especificado em 
@geindex Propostas de Melhorias do Python; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}.

Exemplo:

@example
PyDoc_STRVAR(pop_doc, "Remove e retorna o elemento mais à direita.");

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{1921}
@deffn {C Macro} PyDoc_STR (str)

Cria uma docstring para a string de entrada fornecida ou uma string vazia se docstrings estiverem desabilitadas.

Use @ref{1921,,PyDoc_STR} ao especificar docstrings para ter suporte à compilação do Python sem docstrings, conforme especificado em 
@geindex Propostas de Melhorias do Python; PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/}.

Exemplo:

@example
static PyMethodDef pysqlite_row_methods[] = @{
    @{"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,
        PyDoc_STR("Retorna as chaves da linha.")@},
    @{NULL, NULL@}
@};
@end example
@end deffn

@geindex PyDoc_VAR (C macro)
@anchor{c-api/intro c PyDoc_VAR}@anchor{1b85}
@deffn {C Macro} PyDoc_VAR (name)

Declara uma variável estática de vetor de caracteres com o nome fornecido `name'.

Por exemplo:

@example
PyDoc_VAR(python_doc) = PyDoc_STR("A genus of constricting snakes in the Pythonidae family native "
                                  "to the tropics and subtropics of the Eastern Hemisphere.");
@end example
@end deffn

@geindex Py_ARRAY_LENGTH (C macro)
@anchor{c-api/intro c Py_ARRAY_LENGTH}@anchor{4bd5}
@deffn {C Macro} Py_ARRAY_LENGTH (array)

Calcula o comprimento de um vetor C alocado estaticamente em tempo de compilação.

O argumento `array' deve ser um vetor C com tamanho conhecido em tempo de compilação. Passar um vetor com tamanho desconhecido, como um vetor alocado na heap, resultará em um erro de compilação em alguns compiladores ou produzirá resultados incorretos.

Isso é aproximadamente equivalente a:

@example
sizeof(array) / sizeof((array)[0])
@end example
@end deffn

@geindex Py_EXPORTED_SYMBOL (C macro)
@anchor{c-api/intro c Py_EXPORTED_SYMBOL}@anchor{4bd6}
@deffn {C Macro} Py_EXPORTED_SYMBOL

Macro used to declare a symbol (function or data) as exported.
On Windows, this expands to @code{__declspec(dllexport)}.
On compatible versions of GCC/Clang, it
expands to @code{__attribute__((visibility("default")))}.
This macro is for defining the C API itself; extension modules should not use it.
@end deffn

@geindex Py_IMPORTED_SYMBOL (C macro)
@anchor{c-api/intro c Py_IMPORTED_SYMBOL}@anchor{4bd7}
@deffn {C Macro} Py_IMPORTED_SYMBOL

Macro used to declare a symbol as imported.
On Windows, this expands to @code{__declspec(dllimport)}.
This macro is for defining the C API itself; extension modules should not use it.
@end deffn

@geindex PyAPI_FUNC (C macro)
@anchor{c-api/intro c PyAPI_FUNC}@anchor{4bd8}
@deffn {C Macro} PyAPI_FUNC (type)

Macro used by CPython to declare a function as part of the C API.
Its expansion depends on the platform and build configuration.
This macro is intended for defining CPython’s C API itself;
extension modules should not use it for their own symbols.
@end deffn

@geindex PyAPI_DATA (C macro)
@anchor{c-api/intro c PyAPI_DATA}@anchor{4bd9}
@deffn {C Macro} PyAPI_DATA (type)

Macro used by CPython to declare a public global variable as part of the C API.
Its expansion depends on the platform and build configuration.
This macro is intended for defining CPython’s C API itself;
extension modules should not use it for their own symbols.
@end deffn

@node Objetos tipos e contagens de referências,Exceções<21>,Macros úteis,Introdução<13>
@anchor{c-api/intro api-objects}@anchor{4bda}@anchor{c-api/intro objects-types-and-reference-counts}@anchor{4bdb}
@subsection Objetos, tipos e contagens de referências


@geindex objeto;tipo

A maioria das funções da API Python/C tem um ou mais argumentos, bem como um valor de retorno do tipo @ref{339,,PyObject}*. Este tipo é um ponteiro para um tipo de dados opaco que representa um objeto Python arbitrário. Como todos os tipos de objeto Python são tratados da mesma maneira pela linguagem Python na maioria das situações (por exemplo, atribuições, regras de escopo e passagem de argumento), é adequado que eles sejam representados por um único tipo C. Quase todos os objetos Python vivem na pilha: você nunca declara uma variável automática ou estática do tipo @ref{339,,PyObject}, variáveis de apenas ponteiro do tipo @ref{339,,PyObject}* podem ser declaradas. A única exceção são os objetos de tipo; uma vez que estes nunca devem ser desalocados, eles são normalmente objetos estáticos @ref{ab4,,PyTypeObject}.

Todos os objetos Python (mesmo inteiros Python) têm um `tipo' e uma `contagem de referências'. O tipo de um objeto determina que tipo de objeto ele é (por exemplo, um número inteiro, uma lista ou uma função definida pelo usuário; existem muitos mais, conforme explicado em @ref{2075,,A hierarquia de tipos padrão}). Para cada um dos tipos conhecidos, há uma macro para verificar se um objeto é desse tipo; por exemplo, @code{PyList_Check(a)} é verdadeiro se (e somente se) o objeto apontado por `a' for uma lista Python.

@menu
* Contagens de referências: Contagens de referências<2>. 
* Tipos:: 

@end menu

@node Contagens de referências<2>,Tipos,,Objetos tipos e contagens de referências
@anchor{c-api/intro api-refcounts}@anchor{4bdc}@anchor{c-api/intro reference-counts}@anchor{4bdd}
@subsubsection Contagens de referências


A contagem de referências é importante porque os computadores atuais têm um tamanho de memória finito (e frequentemente severamente limitado); ela conta quantos lugares diferentes existem que possuem uma @ref{33d,,referência forte} a um objeto. Tal lugar pode ser outro objeto, ou uma variável C global (ou estática), ou uma variável local em alguma função C. Quando a última @ref{33d,,referência forte} a um objeto é liberada (ou seja, sua contagem de referências se torna zero), o objeto é desalocado. Se ele contiver referências a outros objetos, essas referências são liberadas. Esses outros objetos podem ser desalocados por sua vez, se não houver mais referências a eles, e assim por diante. (Há um problema óbvio com objetos que referenciam uns aos outros aqui; por enquanto, a solução é “não faça isso”.)

@geindex Py_INCREF (função C)
@geindex Py_DECREF (função C)

Contagens de referências são sempre manipuladas explicitamente. A maneira normal é usar a macro @ref{56e,,Py_INCREF()} para obter uma nova referência a um objeto (ou seja, incrementar sua contagem de referências em um), e @ref{56f,,Py_DECREF()} para liberar essa referência (ou seja, decrementar a contagem de referências em um). A macro @ref{56f,,Py_DECREF()} é consideravelmente mais complexa do que a incref, pois deve verificar se a contagem de referências se torna zero e, em seguida, fazer com que o desalocador do objeto seja chamado. O desalocador é um ponteiro para função contido na estrutura de tipo do objeto. O desalocador específico do tipo cuida da liberação de referências para outros objetos contidos no objeto se este for um tipo de objeto composto, como uma lista, bem como de executar qualquer finalização adicional necessária. Não há chance de a contagem de referências transbordar; pelo menos tantos bits são usados para armazenar a contagem de referência quantos forem os locais de memória distintos na memória virtual (presumindo @code{sizeof(Py_ssize_t) >= sizeof(void*)}). Portanto, o incremento da contagem de referências é uma operação simples.

Não é necessário manter uma @ref{33d,,referência forte} (ou seja, incrementar a contagem de referências) para cada variável local que contém um ponteiro para um objeto. Em teoria, a contagem de referências do objeto aumenta em um quando a variável é feita para apontar para ele e diminui em um quando a variável sai do escopo. No entanto, esses dois se cancelam, portanto, no final, a contagem de referências não mudou. A única razão real para usar a contagem de referências é evitar que o objeto seja desalocado enquanto nossa variável estiver apontando para ele. Se sabemos que existe pelo menos uma outra referência ao objeto que vive pelo menos tanto quanto nossa variável, não há necessidade de tomar uma nova @ref{33d,,referência forte} (ou seja, incrementar a contagem de referências) temporariamente. Uma situação importante em que isso ocorre é em objetos que são passados como argumentos para funções C em um módulo de extensão que são chamados de Python; o mecanismo de chamada garante manter uma referência a todos os argumentos durante a chamada.

No entanto, uma armadilha comum é extrair um objeto de uma lista e mantê-lo por um tempo, sem tomar uma nova referência. Alguma outra operação poderia remover o objeto da lista, liberando essa referência e possivelmente desalocando-o. O perigo real é que operações aparentemente inocentes podem invocar código Python arbitrário que poderia fazer isso; existe um caminho de código que permite que o controle flua de volta para o usuário a partir de um @ref{56f,,Py_DECREF()}, então quase qualquer operação é potencialmente perigosa.

Uma abordagem segura é sempre usar as operações genéricas (funções cujo nome começa com @code{PyObject_}, @code{PyNumber_}, @code{PySequence_} ou @code{PyMapping_}). Essas operações sempre criam uma nova @ref{33d,,referência forte} (ou seja, incrementam a contagem de referências) do objeto que retornam. Isso deixa o chamador com a responsabilidade de chamar @ref{56f,,Py_DECREF()} quando terminar com o resultado; isso logo se torna uma segunda natureza.

@menu
* Detalhes da contagem de referências:: 

@end menu

@node Detalhes da contagem de referências,,,Contagens de referências<2>
@anchor{c-api/intro api-refcountdetails}@anchor{4bde}@anchor{c-api/intro reference-count-details}@anchor{4bdf}
@subsubsection Detalhes da contagem de referências


O comportamento da contagem de referências de funções na API C/Python é melhor explicado em termos de `propriedade de referências'. A propriedade pertence às referências, nunca aos objetos (os objetos não são possuídos: eles são sempre compartilhados). “Possuir uma referência” significa ser responsável por chamar Py_DECREF nela quando a referência não for mais necessária. A propriedade também pode ser transferida, o que significa que o código que recebe a propriedade da referência torna-se responsável por eventualmente efetuar um liberando ela chamando @ref{56f,,Py_DECREF()} ou @ref{78f,,Py_XDECREF()} quando não é mais necessário – ou passando essa responsabilidade (geralmente para o responsável pela chamada). Quando uma função passa a propriedade de uma referência para seu chamador, diz-se que o chamador recebe uma `nova' referência. Quando nenhuma propriedade é transferida, diz-se que o chamador `toma emprestado' a referência. Nada precisa ser feito para uma @ref{33e,,referência emprestada}.

Por outro lado, quando uma função de chamada passa uma referência a um objeto, há duas possibilidades: a função `rouba' uma referência ao objeto, ou não. `Roubar uma referência' significa que quando você passa uma referência para uma função, essa função presume que agora ela possui essa referência e você não é mais responsável por ela.

@geindex PyList_SetItem (função C)
@geindex PyTuple_SetItem (função C)

Poucas funções roubam referências; as duas exceções notáveis são @ref{165e,,PyList_SetItem()} e @ref{4b62,,PyTuple_SetItem()}, que roubam uma referência para o item (mas não para a tupla ou lista na qual o item é colocado!). Essas funções foram projetadas para roubar uma referência devido a um idioma comum para preencher uma tupla ou lista com objetos recém-criados; por exemplo, o código para criar a tupla @code{(1, 2, "three")} pode ser parecido com isto (esquecendo o tratamento de erros por enquanto; uma maneira melhor de codificar isso é mostrada abaixo):

@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("três"));
@end example

Aqui, @ref{195a,,PyLong_FromLong()} retorna uma nova referência que é imediatamente roubada por @ref{4b62,,PyTuple_SetItem()}. Quando você quiser continuar usando um objeto, embora a referência a ele seja roubada, use @ref{56e,,Py_INCREF()} para obter outra referência antes de chamar a função de roubo de referência.

A propósito, @ref{4b62,,PyTuple_SetItem()} é a `única' maneira de definir itens de tupla; @ref{1bce,,PySequence_SetItem()} e @ref{4be0,,PyObject_SetItem()} se recusam a fazer isso, pois tuplas são um tipo de dados imutável. Você só deve usar @ref{4b62,,PyTuple_SetItem()} para tuplas que você mesmo está criando.

O código equivalente para preencher uma lista pode ser escrita usando @ref{4be1,,PyList_New()} e @ref{165e,,PyList_SetItem()}.

No entanto, na prática, você raramente usará essas maneiras de criar e preencher uma tupla ou lista. Existe uma função genérica, @ref{8ac,,Py_BuildValue()}, que pode criar objetos mais comuns a partir de valores C, dirigidos por uma `string de formato'. Por exemplo, os dois blocos de código acima podem ser substituídos pelos seguintes (que também cuidam da verificação de erros):

@example
PyObject *tuple, *list;

tuple = Py_BuildValue("(iis)", 1, 2, "três");
list = Py_BuildValue("[iis]", 1, 2, "três");
@end example

É muito mais comum usar @ref{4be0,,PyObject_SetItem()} e amigos com itens cujas referências você está apenas pegando emprestado, como argumentos que foram passados para a função que você está escrevendo. Nesse caso, o comportamento deles em relação às referências é muito mais são, já que você não precisa tomar uma nova referência só para poder doá-la (“mande-a ser roubada”). Por exemplo, esta função define todos os itens de uma lista (na verdade, qualquer sequência mutável) para um determinado 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()

A situação é ligeiramente diferente para os valores de retorno da função. Embora passar uma referência para a maioria das funções não altere suas responsabilidades de propriedade para aquela referência, muitas funções que retornam uma referência a um objeto fornecem a propriedade da referência. O motivo é simples: em muitos casos, o objeto retornado é criado instantaneamente e a referência que você obtém é a única referência ao objeto. Portanto, as funções genéricas que retornam referências a objetos, como @ref{4be2,,PyObject_GetItem()} e @ref{1bcd,,PySequence_GetItem()}, sempre retornam uma nova referência (o chamador torna-se o dono da referência).

É importante perceber que se você possui uma referência retornada por uma função depende de qual função você chama apenas — `a plumagem' (o tipo do objeto passado como um argumento para a função) `não entra nela!' Assim, se você extrair um item de uma lista usando @ref{35a,,PyList_GetItem()}, você não possui a referência — mas se obtiver o mesmo item da mesma lista usando @ref{1bcd,,PySequence_GetItem()} (que leva exatamente os mesmos argumentos), você possui uma referência ao objeto retornado.

@geindex PyList_GetItem (função C)
@geindex PySequence_GetItem (função C)

Aqui está um exemplo de como você poderia escrever uma função que calcula a soma dos itens em uma lista de inteiros; uma vez usando @ref{35a,,PyList_GetItem()}, e uma vez usando @ref{1bcd,,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; /* Não é uma lista */
    for (i = 0; i < n; i++) @{
        item = PyList_GetItem(list, i); /* Não pode falhar */
        if (!PyLong_Check(item)) continue; /* Ignora não-inteiros */
        value = PyLong_AsLong(item);
        if (value == -1 && PyErr_Occurred())
            /* Inteiro muito grande para caber em um C longo, sai */
            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; /* Não tem comprimento */
    for (i = 0; i < n; i++) @{
        item = PySequence_GetItem(sequence, i);
        if (item == NULL)
            return -1; /* Não é uma sequência ou outra falha */
        if (PyLong_Check(item)) @{
            value = PyLong_AsLong(item);
            Py_DECREF(item);
            if (value == -1 && PyErr_Occurred())
                /* Inteiro muito grande para caber em um C longo, sai */
                return -1;
            total += value;
        @}
        else @{
            Py_DECREF(item); /* Descartar propriedade de referência */
        @}
    @}
    return total;
@}
@end example

@geindex sum_sequence()

@node Tipos,,Contagens de referências<2>,Objetos tipos e contagens de referências
@anchor{c-api/intro api-types}@anchor{4be3}@anchor{c-api/intro types}@anchor{4be4}
@subsubsection Tipos


Existem alguns outros tipos de dados que desempenham um papel significativo na API Python/C; a maioria são tipos C simples, como int, long, double e char*. Alguns tipos de estrutura são usados para descrever tabelas estáticas usadas para listar as funções exportadas por um módulo ou os atributos de dados de um novo tipo de objeto, e outro é usado para descrever o valor de um número complexo. Eles serão discutidos junto com as funções que os utilizam.

@geindex Py_ssize_t (C type)
@anchor{c-api/intro c Py_ssize_t}@anchor{a69}
@deffn {C Tipo} type Py_ssize_t
` Parte da @ref{553,,ABI Estável}.'
Um tipo integral assinado tal que @code{sizeof(Py_ssize_t) == sizeof(size_t)}. C99 não define tal coisa diretamente (size_t é um tipo integral não assinado). Veja 
@geindex Propostas de Melhorias do Python; PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} para mais detalhes. @code{PY_SSIZE_T_MAX} é o maior valor positivo do tipo @ref{a69,,Py_ssize_t}.
@end deffn

@node Exceções<21>,Incorporando Python<2>,Objetos tipos e contagens de referências,Introdução<13>
@anchor{c-api/intro api-exceptions}@anchor{4be5}@anchor{c-api/intro exceptions}@anchor{4be6}
@subsection Exceções


O programador Python só precisa lidar com exceções se o tratamento de erros específico for necessário; as exceções não tratadas são propagadas automaticamente para o chamador, depois para o chamador e assim por diante, até chegarem ao interpretador de nível superior, onde são relatadas ao usuário acompanhadas por um traceback (situação da pilha de execução).

@geindex PyErr_Occurred (função C)

Para programadores C, entretanto, a verificação de erros sempre deve ser explícita. Todas as funções na API Python/C podem levantar exceções, a menos que uma declaração explícita seja feita de outra forma na documentação de uma função. Em geral, quando uma função encontra um erro, ela define uma exceção, descarta todas as referências de objeto de sua propriedade e retorna um indicador de erro. Se não for documentado de outra forma, este indicador é @code{NULL} ou @code{-1}, dependendo do tipo de retorno da função. Algumas funções retornam um resultado booleano verdadeiro/falso, com falso indicando um erro. Muito poucas funções não retornam nenhum indicador de erro explícito ou têm um valor de retorno ambíguo e requerem teste explícito para erros com @ref{1a3b,,PyErr_Occurred()}. Essas exceções são sempre documentadas explicitamente.

@geindex PyErr_SetString (função C)
@geindex PyErr_Clear (função C)

O estado de exceção é mantido no armazenamento por thread (isso é equivalente a usar o armazenamento global em uma aplicação sem thread). Uma thread pode estar em um de dois estados: ocorreu uma exceção ou não. A função @ref{1a3b,,PyErr_Occurred()} pode ser usada para verificar isso: ela retorna uma referência emprestada ao objeto do tipo de exceção quando uma exceção ocorreu, e @code{NULL} caso contrário. Existem várias funções para definir o estado de exceção: @ref{57c,,PyErr_SetString()} é a função mais comum (embora não a mais geral) para definir o estado de exceção, e @ref{1069,,PyErr_Clear()} limpa o estado da exceção.

O estado de exceção completo consiste em três objetos (todos os quais podem ser @code{NULL}): o tipo de exceção, o valor de exceção correspondente e o traceback. Eles têm os mesmos significados que o resultado no Python de @code{sys.exc_info()}; no entanto, eles não são os mesmos: os objetos Python representam a última exceção sendo tratada por uma instrução Python @ref{6e9,,try} … @ref{18b,,except}, enquanto o estado de exceção de nível C só existe enquanto uma exceção está sendo transmitido entre funções C até atingir o laço de repetição principal do interpretador de bytecode Python, que se encarrega de transferi-lo para @code{sys.exc_info()} e amigos.

@geindex exc_info (no módulo sys)

Observe que a partir do Python 1.5, a maneira preferida e segura para thread para acessar o estado de exceção do código Python é chamar a função @ref{68a,,sys.exc_info()}, que retorna o estado de exceção por thread para o código Python. Além disso, a semântica de ambas as maneiras de acessar o estado de exceção mudou, de modo que uma função que captura uma exceção salvará e restaurará o estado de exceção de seu segmento de modo a preservar o estado de exceção de seu chamador. Isso evita bugs comuns no código de tratamento de exceções causados por uma função aparentemente inocente sobrescrevendo a exceção sendo tratada; também reduz a extensão da vida útil frequentemente indesejada para objetos que são referenciados pelos quadros de pilha no traceback.

Como princípio geral, uma função que chama outra função para realizar alguma tarefa deve verificar se a função chamada levantou uma exceção e, em caso afirmativo, passar o estado da exceção para seu chamador. Ele deve descartar todas as referências de objeto que possui e retornar um indicador de erro, mas `não' deve definir outra exceção — que sobrescreveria a exceção que acabou de ser gerada e perderia informações importantes sobre a causa exata do erro.

@geindex sum_sequence()

Um exemplo simples de detecção de exceções e transmiti-las é mostrado no exemplo @code{sum_sequence()} acima. Acontece que este exemplo não precisa limpar nenhuma referência de propriedade quando detecta um erro. A função de exemplo a seguir mostra alguma limpeza de erro. Primeiro, para lembrar por que você gosta de Python, mostramos o código Python equivalente:

@example
def incr_item(dict, key):
    try:
        item = dict[key]
    except KeyError:
        item = 0
    dict[key] = item + 1
@end example

@geindex incr_item()

Aqui está o código C correspondente, em toda sua glória:

@example
int
incr_item(PyObject *dict, PyObject *key)
@{
    /* Objetos todos inicializados para NULL para Py_XDECREF */
    PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
    int rv = -1; /* Retorna valor inicializado para -1 (falha) */

    item = PyObject_GetItem(dict, key);
    if (item == NULL) @{
        /* Trata de KeyError apenas: */
        if (!PyErr_ExceptionMatches(PyExc_KeyError))
            goto error;

        /* Limpa o erro e usa 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 */
    /* Continua com o código de limpeza */

 error:
    /* Código de limpeza, compartilhado pelo caminho sucesso e falha */

    /* Usa Py_XDECREF() para ignorar referências NULL */
    Py_XDECREF(item);
    Py_XDECREF(const_one);
    Py_XDECREF(incremented_item);

    return rv; /* -1 para erro, 0 para sucesso */
@}
@end example

@geindex incr_item()

@geindex PyErr_ExceptionMatches (função C)
@geindex PyErr_Clear (função C)
@geindex Py_XDECREF (função C)

Este exemplo representa um uso endossado da instrução @code{goto} em C! Ele ilustra o uso de @ref{4be7,,PyErr_ExceptionMatches()} e @ref{1069,,PyErr_Clear()} para lidar com exceções específicas, e o uso de @ref{78f,,Py_XDECREF()} para descartar referências de propriedade que podem ser @code{NULL} (observe o @code{'X'} no nome; @ref{56f,,Py_DECREF()} travaria quando confrontado com uma referência @code{NULL}). É importante que as variáveis usadas para manter as referências de propriedade sejam inicializadas com @code{NULL} para que isso funcione; da mesma forma, o valor de retorno proposto é inicializado para @code{-1} (falha) e apenas definido para sucesso após a chamada final feita ser bem sucedida.

@node Incorporando Python<2>,Compilações de depuração,Exceções<21>,Introdução<13>
@anchor{c-api/intro api-embedding}@anchor{4be8}@anchor{c-api/intro embedding-python}@anchor{4be9}
@subsection Incorporando Python


A única tarefa importante com a qual apenas os incorporadores (em oposição aos escritores de extensão) do interpretador Python precisam se preocupar é a inicialização e, possivelmente, a finalização do interpretador Python. A maior parte da funcionalidade do interpretador só pode ser usada após a inicialização do interpretador.

@geindex Py_Initialize (função C)
@geindex módulo;builtins
@geindex módulo;__main__
@geindex módulo;sys
@geindex módulo;pesquisa;caminho
@geindex path (no módulo sys)

A função de inicialização básica é @ref{8b1,,Py_Initialize()}. Isso inicializa a tabela de módulos carregados e cria os módulos fundamentais @ref{12,,builtins}, @ref{1,,__main__} e @ref{d9,,sys}. Ela também inicializa o caminho de pesquisa de módulos (@code{sys.path}).

@ref{8b1,,Py_Initialize()} não define a “lista de argumentos de script” (@code{sys.argv}). Se esta variável for necessária para o código Python que será executado posteriormente, @ref{3c3,,PyConfig.argv} e @ref{1a7e,,PyConfig.parse_argv} devem estar definidas; veja @ref{3a7,,Configuração de inicialização do Python}.

Na maioria dos sistemas (em particular, no Unix e no Windows, embora os detalhes sejam ligeiramente diferentes), @ref{8b1,,Py_Initialize()} calcula o caminho de pesquisa de módulos com base em sua melhor estimativa para a localização do executável do interpretador Python padrão, presumindo que a biblioteca Python é encontrada em um local fixo em relação ao executável do interpretador Python. Em particular, ele procura por um diretório chamado @code{lib/python`X.Y'} relativo ao diretório pai onde o executável chamado @code{python} é encontrado no caminho de pesquisa de comandos do shell (a variável de ambiente 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}).

Por exemplo, se o executável Python for encontrado em @code{/usr/local/bin/python}, ele presumirá que as bibliotecas estão em @code{/usr/local/lib/python`X.Y'}. (Na verdade, este caminho particular também é o local reserva, usado quando nenhum arquivo executável chamado @code{python} é encontrado ao longo de 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH}.) O usuário pode substituir este comportamento definindo a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}, ou insira diretórios adicionais na frente do caminho padrão definindo 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH}.

@geindex Py_GetPath (função C)
@geindex Py_GetPrefix (função C)
@geindex Py_GetExecPrefix (função C)
@geindex Py_GetProgramFullPath (função C)

A aplicação de incorporação pode orientar a pesquisa definindo @ref{3c4,,PyConfig.program_name} `antes' de chamar @ref{3c5,,Py_InitializeFromConfig()}. Observe que 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} ainda substitui isso e 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} ainda é inserido na frente do caminho padrão. Uma aplicação que requer controle total deve fornecer sua própria implementação de @ref{3b3,,Py_GetPath()}, @ref{3b5,,Py_GetPrefix()}, @ref{3b1,,Py_GetExecPrefix()} e @ref{3b7,,Py_GetProgramFullPath()} (todas definidas em @code{Modules/getpath.c}).

@geindex Py_IsInitialized (função C)

Às vezes, é desejável “desinicializar” o Python. Por exemplo, a aplicação pode querer iniciar novamente (fazer outra chamada para @ref{8b1,,Py_Initialize()}) ou a aplicação simplesmente termina com o uso de Python e deseja liberar memória alocada pelo Python. Isso pode ser feito chamando @ref{d37,,Py_FinalizeEx()}. A função @ref{4bea,,Py_IsInitialized()} retorna verdadeiro se o Python está atualmente no estado inicializado. Mais informações sobre essas funções são fornecidas em um capítulo posterior. Observe que @ref{d37,,Py_FinalizeEx()} `não' libera toda a memória alocada pelo interpretador Python, por exemplo, a memória alocada por módulos de extensão atualmente não pode ser liberada.

@node Compilações de depuração,Ferramentas de terceiros recomendadas<2>,Incorporando Python<2>,Introdução<13>
@anchor{c-api/intro api-debugging}@anchor{4beb}@anchor{c-api/intro debugging-builds}@anchor{4bec}
@subsection Compilações de depuração


Python pode ser compilado com várias macros para permitir verificações extras do interpretador e módulos de extensão. Essas verificações tendem a adicionar uma grande quantidade de sobrecarga ao tempo de execução, portanto, não são habilitadas por padrão.

Uma lista completa dos vários tipos de compilações de depuração está no arquivo @code{Misc/SpecialBuilds.txt} na distribuição do código-fonte do Python. Estão disponíveis compilações que oferecem suporte ao rastreamento de contagens de referências, depuração do alocador de memória ou criação de perfil de baixo nível do laço do interpretador principal. Apenas as compilações usadas com mais frequência serão descritas no restante desta seção.

@geindex Py_DEBUG (C macro)
@anchor{c-api/intro c Py_DEBUG}@anchor{4359}
@deffn {C Macro} Py_DEBUG
@end deffn

Compilar o interpretador com a macro @code{Py_DEBUG} definida produz o que geralmente se entende por @ref{1f9,,uma construção de depuração do Python}. @code{Py_DEBUG} é habilitada na construção Unix adicionando @ref{424,,--with-pydebug} ao comando @code{./configure}. Também está implícito na presença da macro não específica do Python @code{_DEBUG}. Quando @code{Py_DEBUG} está habilitado na construção do Unix, a otimização do compilador é desabilitada.

Além da depuração de contagem de referências descrita abaixo, verificações extras são realizadas, consulte @ref{1f9,,Compilação de Depuração do Python}.

Definir @code{Py_TRACE_REFS} habilita o rastreamento de referência (veja a opção @ref{395,,opção --with-trace-refs de configure}). Quando definida, uma lista circular duplamente vinculada de objetos ativos é mantida adicionando dois campos extras a cada @ref{339,,PyObject}. As alocações totais também são rastreadas. Ao sair, todas as referências existentes são impressas. (No modo interativo, isso acontece após cada instrução executada pelo interpretador.)

Consulte @code{Misc/SpecialBuilds.txt} na distribuição do código-fonte Python para informações mais detalhadas.

@node Ferramentas de terceiros recomendadas<2>,,Compilações de depuração,Introdução<13>
@anchor{c-api/intro c-api-tools}@anchor{4b37}@anchor{c-api/intro recommended-third-party-tools}@anchor{4bed}
@subsection Ferramentas de terceiros recomendadas


As seguintes ferramentas de terceiros oferecem abordagens mais simples e mais sofisticadas para criar extensões C, C++ e Rust para Python:


@itemize *

@item 
Cython@footnote{https://cython.org/}

@item 
cffi@footnote{https://cffi.readthedocs.io}

@item 
HPy@footnote{https://hpyproject.org/}

@item 
nanobind@footnote{https://github.com/wjakob/nanobind} (C++)

@item 
Numba@footnote{https://numba.pydata.org/}

@item 
pybind11@footnote{https://pybind11.readthedocs.io/} (C++)

@item 
PyO3@footnote{https://pyo3.rs/} (Rust)

@item 
SWIG@footnote{https://www.swig.org}
@end itemize

O uso de ferramentas como essas pode ajudar a evitar a criação de código estritamente vinculado a uma versão específica do CPython, evitar erros de contagem de referências e focar mais no seu próprio código do que em usar a API do CPython. Em geral, novas versões do Python podem ser suportadas atualizando a ferramenta, e seu código frequentemente usará APIs mais novas e eficientes automaticamente. Algumas ferramentas também oferecem suporte à compilação para outras implementações do Python a partir de um único conjunto de fontes.

Esses projetos não são suportados pelas mesmas pessoas que mantêm o Python, e quaisquer problemas precisam ser relatados diretamente aos projetos. Lembre-se de verificar se o projeto ainda é mantido e tem suporte, pois a lista acima pode ficar desatualizada.


@subsubheading Ver também



@table @asis

@item Guia do Usuário de Empacotamento do Python: Extensões Binárias@footnote{https://packaging.python.org/guides/packaging-binary-extensions/}

O Guia do Usuário de Empacotamento do Python não abrange apenas várias ferramentas disponíveis que simplificam a criação de extensões binárias, mas também discute os vários motivos pelos quais a criação de um módulo de extensão pode ser desejável em primeiro lugar.
@end table


@node Estabilidade da API C,A camada de nível muito alto,Introdução<13>,Manual de referência da API Python/C
@anchor{c-api/stable doc}@anchor{4bee}@anchor{c-api/stable c-api-stability}@anchor{4bef}@anchor{c-api/stable stable}@anchor{553}@anchor{c-api/stable translation-repo}@anchor{4bf0}
@section Estabilidade da API C


A menos que documentado de outra forma, a API C do Python é coberta pela Política de Compatibilidade com versões anteriores, 
@geindex Propostas de Melhorias do Python; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}. A maioria das alterações são compatíveis com a fonte (normalmente adicionando apenas uma nova API). A alteração ou remoção da API existente só é feita após um período de descontinuação ou para corrigir problemas sérios.

A Interface Binária de Aplicação (ABI) do CPython é compatível para frente e para trás através de uma versão menor (se elas forem compiladas da mesma maneira; veja @ref{4bf1,,Considerações da plataforma} abaixo). Portanto, o código compilado para Python 3.10.0 funcionará em 3.10.8 e vice-versa, mas precisará ser compilado separadamente para 3.9.x e 3.11.x.

Existem dois níveis de API C com diferentes expectativas de estabilidade:


@itemize -

@item 
@ref{547,,API Instável} (“Unstable API”), pode mudar em versões menores sem período de depreciação. É marcado pelo prefixo @code{PyUnstable} nos nomes.

@item 
@ref{396,,API Limitada} (“Limited API”), é compatível em várias versões menores. Quando @ref{41e,,Py_LIMITED_API} é definido, apenas este subconjunto é exposto de @code{Python.h}.
@end itemize

Elas são discutidas em mais detalhes abaixo.

Nomes prefixados por um sublinhado, como @code{_Py_InternalState}, são APIs privadas que podem ser alteradas sem aviso prévio, mesmo em lançamentos de correção. Se você precisa usar essa API, considere entrar em contato com os desenvolvedores do CPython@footnote{https://discuss.python.org/c/core-dev/c-api/30} para discutir a adição de uma API pública para o seu caso de uso.

@menu
* API C Instável:: 
* Interface Binária de Aplicação Estável:: 
* Considerações da plataforma:: 
* Conteúdo da API Limitada:: 

@end menu

@node API C Instável,Interface Binária de Aplicação Estável,,Estabilidade da API C
@anchor{c-api/stable id1}@anchor{4bf2}@anchor{c-api/stable unstable-c-api}@anchor{547}
@subsection API C Instável


@geindex PyUnstable

Qualquer API nomeada com o prefixo “PyUnstable” expõe detalhes de implementação do CPython e pode mudar em cada versão menor (por exemplo, de 3.9 para 3.10) sem nenhum aviso de depreciação. No entanto, não mudará em uma versão de correção de bugs (por exemplo, de 3.10.0 para 3.10.1).

É geralmente destinado a ferramentas especializadas de baixo nível, como depuradores.

Projetos que utilizam esta API são esperados para seguir o desenvolvimento do CPython e dedicar esforço extra para se ajustar às mudanças.

@node Interface Binária de Aplicação Estável,Considerações da plataforma,API C Instável,Estabilidade da API C
@anchor{c-api/stable stable-application-binary-interface}@anchor{4bf3}
@subsection Interface Binária de Aplicação Estável


Para simplificar, este documento fala sobre `extensões', mas a API Limitada e a ABI Estável funcionam da mesma maneira para todos os usos da API – por exemplo, embutir o Python.

@menu
* API C Limitada:: 
* ABI Estável:: 
* Escopo e Desempenho da API Limitada:: 
* Limitações da API Limitada:: 

@end menu

@node API C Limitada,ABI Estável,,Interface Binária de Aplicação Estável
@anchor{c-api/stable id2}@anchor{4bf4}@anchor{c-api/stable limited-c-api}@anchor{396}
@subsubsection API C Limitada


Python 3.2 introduziu a `API Limitada', um subconjunto da API C do Python. Extensões que apenas usam o Limited API podem ser compiladas uma vez e ser carregadas em várias versões do Python. Os conteúdos da API Limitada estão @ref{79a,,listados abaixo}.

@geindex Py_LIMITED_API (C macro)
@anchor{c-api/stable c Py_LIMITED_API}@anchor{41e}
@deffn {C Macro} Py_LIMITED_API

Defina essa macro antes de incluir @code{Python.h} para optar por usar apenas a API Limitada e selecionar a versão da API Limitada.

Defina @code{Py_LIMITED_API} com o valor de @ref{757,,PY_VERSION_HEX} correspondente à versão mais baixa do Python que sua extensão suporta. A extensão terá compatibilidade com a ABI de todas as versões do Python 3 a partir daquela especificada, e poderá usar a API Limitada introduzida até aquela versão.

Em vez de usar diretamente a macro @code{PY_VERSION_HEX}, codifique uma versão menor mínima (por exemplo, @code{0x030A0000} para o Python 3.10) para garantir estabilidade ao compilar com versões futuras do Python.

Você também pode definir @code{Py_LIMITED_API} como @code{3}. Isso funciona da mesma forma que @code{0x03020000} (Python 3.2, a versão que introduziu a API Limitada).
@end deffn

@node ABI Estável,Escopo e Desempenho da API Limitada,API C Limitada,Interface Binária de Aplicação Estável
@anchor{c-api/stable id3}@anchor{4bf5}@anchor{c-api/stable stable-abi}@anchor{4bf6}
@subsubsection ABI Estável


Para habilitar isso, o Python fornece uma `ABI Estável': um conjunto de símbolos que permanecerão compatíveis com ABI em todas as versões do Python 3.x.

@cartouche
@quotation Nota 
O ABI Estável previne problemas de ABI, como erros de ligador devido a símbolos ausentes ou corrupção de dados devido a alterações em layouts de estrutura ou assinaturas de função. No entanto, outras alterações no Python podem alterar o `comportamento' das extensões. Veja a Política de Retrocompatibilidade do Python (
@geindex Propostas de Melhorias do Python; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}) para detalhes.
@end quotation
@end cartouche

A ABI Estável contém símbolos expostos na @ref{396,,API Limitada}, mas também outros – por exemplo, funções necessárias para suportar versões mais antigas da API Limitada.

No Windows, as extensões que usam a ABI Estável devem ser vinculadas a @code{python3.dll} em vez de uma biblioteca específica de versão, como @code{python39.dll}.

Em algumas plataformas, o Python procurará e carregará arquivos de biblioteca compartilhada com o nome marcado como @code{abi3} (por exemplo, @code{meumódulo.abi3.so}). Ele não verifica se essas extensões estão em conformidade com uma ABI Estável. O usuário (ou suas ferramentas de empacotamento) precisa garantir que, por exemplo, as extensões construídas com a API Limitada 3.10+ não sejam instaladas em versões mais baixas do Python.

Todas as funções na ABI estável estão presentes como funções na biblioteca compartilhada do Python, não apenas como macros. Isso as torna utilizáveis em linguagens que não utilizam o pré-processador C.

@node Escopo e Desempenho da API Limitada,Limitações da API Limitada,ABI Estável,Interface Binária de Aplicação Estável
@anchor{c-api/stable limited-api-scope-and-performance}@anchor{4bf7}
@subsubsection Escopo e Desempenho da API Limitada


O objetivo da API Limitada é permitir tudo o que é possível com a API C completa, mas possivelmente com uma penalidade de desempenho.

Por exemplo, enquanto @ref{35a,,PyList_GetItem()} está disponível, sua variante de macro “insegura” @ref{4bf8,,PyList_GET_ITEM()} não está. A macro pode ser mais rápida porque pode depender de detalhes de implementação específicos da versão do objeto da lista.

Sem a definição de @code{Py_LIMITED_API}, algumas funções da API C são colocadas “inline” ou substituídas por macros. Definir @code{Py_LIMITED_API} desativa esse inline, permitindo estabilidade à medida que as estruturas de dados do Python são aprimoradas, mas possivelmente reduzindo o desempenho.

Ao deixar de fora a definição @code{Py_LIMITED_API}, é possível compilar uma extensão da API Limitada com uma ABI específica da versão. Isso pode melhorar o desempenho para essa versão do Python, mas limitará a compatibilidade. Compilar com @code{Py_LIMITED_API} vai produzir uma extensão que pode ser distribuída quando uma específica da versão não estiver disponível – por exemplo, para pré-lançamentos de uma próxima versão do Python.

@node Limitações da API Limitada,,Escopo e Desempenho da API Limitada,Interface Binária de Aplicação Estável
@anchor{c-api/stable limited-api-caveats}@anchor{4bf9}
@subsubsection Limitações da API Limitada


Observe que compilar com @code{Py_LIMITED_API} `não' é uma garantia completa de que o código esteja em conformidade com a @ref{396,,API Limitada} ou com a @ref{4bf6,,ABI Estável}. @code{Py_LIMITED_API} abrange apenas definições, mas uma API também inclui outras questões, como semântica esperada.

Uma questão que @code{Py_LIMITED_API} não protege é a chamada de uma função com argumentos inválidos em uma versão inferior do Python. Por exemplo, considere uma função que começa a aceitar @code{NULL} como argumento. No Python 3.9, @code{NULL} agora seleciona um comportamento padrão, mas no Python 3.8, o argumento será usado diretamente, causando uma referência @code{NULL} e uma falha. Um argumento similar funciona para campos de estruturas.

Outra questão é que alguns campos de estrutura não estão atualmente ocultos quando @code{Py_LIMITED_API} é definido, mesmo que eles façam parte da API Limitada.

Por esses motivos, recomendamos testar uma extensão com `todas' as versões menores do Python que ela oferece suporte e, preferencialmente, construir com a versão `mais baixa' dessas.

Também recomendamos revisar a documentação de todas as APIs utilizadas para verificar se ela faz parte explicitamente da API Limitada. Mesmo com a definição de @code{Py_LIMITED_API}, algumas declarações privadas são expostas por razões técnicas (ou até mesmo acidentalmente, como bugs).

Também observe que a API Limitada não é necessariamente estável: compilar com @code{Py_LIMITED_API} com Python 3.8 significa que a extensão será executada com Python 3.12, mas não necessariamente será `compilada' com Python 3.12. Em particular, partes da API Limitada podem ser descontinuadas e removidas, desde que a ABI Estável permaneça estável.

@node Considerações da plataforma,Conteúdo da API Limitada,Interface Binária de Aplicação Estável,Estabilidade da API C
@anchor{c-api/stable platform-considerations}@anchor{4bfa}@anchor{c-api/stable stable-abi-platform}@anchor{4bf1}
@subsection Considerações da plataforma


A estabilidade da ABI depende não apenas do Python, mas também do compilador utilizado, das bibliotecas de nível inferior e das opções do compilador. Para os fins da @ref{4bf6,,ABI Estável}, esses detalhes definem uma “plataforma”. Geralmente, eles dependem do tipo de sistema operacional e da arquitetura do processador.

É responsabilidade de cada distribuidor particular do Python garantir que todas as versões do Python em uma plataforma específica sejam construídas de forma a não quebrar a ABI estável. Isso é válido para as versões do Windows e macOS disponibilizadas pela @code{python.org} e por muitos distribuidores terceiros.

@node Conteúdo da API Limitada,,Considerações da plataforma,Estabilidade da API C
@anchor{c-api/stable contents-of-limited-api}@anchor{4bfb}@anchor{c-api/stable limited-api-list}@anchor{79a}
@subsection Conteúdo da API Limitada


Atualmente, a @ref{396,,API Limitada} inclui os seguintes itens:



@itemize *

@item 
@ref{151d,,METH_CLASS}

@item 
@ref{14bf,,METH_COEXIST}

@item 
@ref{1713,,METH_FASTCALL}

@item 
@ref{977,,METH_METHOD}

@item 
@ref{151c,,METH_NOARGS}

@item 
@ref{1550,,METH_O}

@item 
@ref{151e,,METH_STATIC}

@item 
@ref{1551,,METH_VARARGS}

@item 
@ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET}

@item 
@ref{4bfc,,PyAIter_Check()}

@item 
@ref{1b5b,,PyArg_Parse()}

@item 
@ref{571,,PyArg_ParseTuple()}

@item 
@ref{383,,PyArg_ParseTupleAndKeywords()}

@item 
@ref{154f,,PyArg_UnpackTuple()}

@item 
@ref{4bfd,,PyArg_VaParse()}

@item 
@ref{384,,PyArg_VaParseTupleAndKeywords()}

@item 
@ref{4bfe,,PyArg_ValidateKeywordArguments()}

@item 
@ref{4bff,,PyBUF_ANY_CONTIGUOUS}

@item 
@ref{4c00,,PyBUF_CONTIG}

@item 
@ref{4c01,,PyBUF_CONTIG_RO}

@item 
@ref{13fd,,PyBUF_C_CONTIGUOUS}

@item 
@ref{4c02,,PyBUF_FORMAT}

@item 
@ref{4c03,,PyBUF_FULL}

@item 
@ref{4c04,,PyBUF_FULL_RO}

@item 
@ref{13fe,,PyBUF_F_CONTIGUOUS}

@item 
@ref{4c05,,PyBUF_INDIRECT}

@item 
@ref{4c06,,PyBUF_MAX_NDIM}

@item 
@ref{4c07,,PyBUF_ND}

@item 
@ref{1786,,PyBUF_READ}

@item 
@ref{4c08,,PyBUF_RECORDS}

@item 
@ref{4c09,,PyBUF_RECORDS_RO}

@item 
@ref{4c0a,,PyBUF_SIMPLE}

@item 
@ref{4c0b,,PyBUF_STRIDED}

@item 
@ref{4c0c,,PyBUF_STRIDED_RO}

@item 
@ref{4c0d,,PyBUF_STRIDES}

@item 
@ref{13fc,,PyBUF_WRITABLE}

@item 
@ref{1787,,PyBUF_WRITE}

@item 
@ref{4c0e,,PyBaseObject_Type}

@item 
@ref{4c0f,,PyBool_FromLong()}

@item 
@ref{4c10,,PyBool_Type}

@item 
@ref{75f,,PyBuffer_FillContiguousStrides()}

@item 
@ref{760,,PyBuffer_FillInfo()}

@item 
@ref{75c,,PyBuffer_FromContiguous()}

@item 
@ref{759,,PyBuffer_GetPointer()}

@item 
@ref{75e,,PyBuffer_IsContiguous()}

@item 
@ref{39a,,PyBuffer_Release()}

@item 
@ref{75a,,PyBuffer_SizeFromFormat()}

@item 
@ref{75b,,PyBuffer_ToContiguous()}

@item 
@ref{4c11,,PyByteArrayIter_Type}

@item 
@ref{4c12,,PyByteArray_AsString()}

@item 
@ref{4c13,,PyByteArray_Concat()}

@item 
@ref{13ef,,PyByteArray_FromObject()}

@item 
@ref{13f0,,PyByteArray_FromStringAndSize()}

@item 
@ref{4c14,,PyByteArray_Resize()}

@item 
@ref{4c15,,PyByteArray_Size()}

@item 
@ref{4c16,,PyByteArray_Type}

@item 
@ref{4c17,,PyBytesIter_Type}

@item 
@ref{88b,,PyBytes_AsString()}

@item 
@ref{4c18,,PyBytes_AsStringAndSize()}

@item 
@ref{4c19,,PyBytes_Concat()}

@item 
@ref{4c1a,,PyBytes_ConcatAndDel()}

@item 
@ref{4c1b,,PyBytes_DecodeEscape()}

@item 
@ref{1ba1,,PyBytes_FromFormat()}

@item 
@ref{4c1c,,PyBytes_FromFormatV()}

@item 
@ref{4c1d,,PyBytes_FromObject()}

@item 
@ref{4c1e,,PyBytes_FromString()}

@item 
@ref{13e7,,PyBytes_FromStringAndSize()}

@item 
@ref{4c1f,,PyBytes_Repr()}

@item 
@ref{4c20,,PyBytes_Size()}

@item 
@ref{4c21,,PyBytes_Type}

@item 
@ref{14c0,,PyCFunction}

@item 
@ref{4c22,,PyCFunctionFast}

@item 
@ref{4c23,,PyCFunctionFastWithKeywords}

@item 
@ref{4c24,,PyCFunctionWithKeywords}

@item 
@ref{4c25,,PyCFunction_GetFlags()}

@item 
@ref{4c26,,PyCFunction_GetFunction()}

@item 
@ref{4c27,,PyCFunction_GetSelf()}

@item 
@ref{1a3d,,PyCFunction_New()}

@item 
@ref{1b05,,PyCFunction_NewEx()}

@item 
@ref{4c28,,PyCFunction_Type}

@item 
@ref{1a37,,PyCMethod_New()}

@item 
@ref{4c29,,PyCallIter_New()}

@item 
@ref{4c2a,,PyCallIter_Type}

@item 
@ref{4c2b,,PyCallable_Check()}

@item 
@ref{4c2c,,PyCapsule_Destructor}

@item 
@ref{4c2d,,PyCapsule_GetContext()}

@item 
@ref{4c2e,,PyCapsule_GetDestructor()}

@item 
@ref{4c2f,,PyCapsule_GetName()}

@item 
@ref{4c30,,PyCapsule_GetPointer()}

@item 
@ref{1999,,PyCapsule_Import()}

@item 
@ref{13a3,,PyCapsule_IsValid()}

@item 
@ref{4b6d,,PyCapsule_New()}

@item 
@ref{4c31,,PyCapsule_SetContext()}

@item 
@ref{4c32,,PyCapsule_SetDestructor()}

@item 
@ref{4c33,,PyCapsule_SetName()}

@item 
@ref{4c34,,PyCapsule_SetPointer()}

@item 
@ref{4c35,,PyCapsule_Type}

@item 
@ref{4c36,,PyClassMethodDescr_Type}

@item 
@ref{4c37,,PyCodec_BackslashReplaceErrors()}

@item 
@ref{3ff,,PyCodec_Decode()}

@item 
@ref{4c38,,PyCodec_Decoder()}

@item 
@ref{400,,PyCodec_Encode()}

@item 
@ref{4c39,,PyCodec_Encoder()}

@item 
@ref{4c3a,,PyCodec_IgnoreErrors()}

@item 
@ref{4c3b,,PyCodec_IncrementalDecoder()}

@item 
@ref{4c3c,,PyCodec_IncrementalEncoder()}

@item 
@ref{4c3d,,PyCodec_KnownEncoding()}

@item 
@ref{4c3e,,PyCodec_LookupError()}

@item 
@ref{ede,,PyCodec_NameReplaceErrors()}

@item 
@ref{4c3f,,PyCodec_Register()}

@item 
@ref{4c40,,PyCodec_RegisterError()}

@item 
@ref{4c41,,PyCodec_ReplaceErrors()}

@item 
@ref{4c42,,PyCodec_StreamReader()}

@item 
@ref{4c43,,PyCodec_StreamWriter()}

@item 
@ref{4c44,,PyCodec_StrictErrors()}

@item 
@ref{89b,,PyCodec_Unregister()}

@item 
@ref{4c45,,PyCodec_XMLCharRefReplaceErrors()}

@item 
@ref{4c46,,PyComplex_FromDoubles()}

@item 
@ref{178e,,PyComplex_ImagAsDouble()}

@item 
@ref{178d,,PyComplex_RealAsDouble()}

@item 
@ref{4c47,,PyComplex_Type}

@item 
@ref{4c48,,PyDescr_NewClassMethod()}

@item 
@ref{4c49,,PyDescr_NewGetSet()}

@item 
@ref{4c4a,,PyDescr_NewMember()}

@item 
@ref{1b04,,PyDescr_NewMethod()}

@item 
@ref{4c4b,,PyDictItems_Type}

@item 
@ref{4c4c,,PyDictIterItem_Type}

@item 
@ref{4c4d,,PyDictIterKey_Type}

@item 
@ref{4c4e,,PyDictIterValue_Type}

@item 
@ref{4c4f,,PyDictKeys_Type}

@item 
@ref{4c50,,PyDictProxy_New()}

@item 
@ref{4c51,,PyDictProxy_Type}

@item 
@ref{4c52,,PyDictRevIterItem_Type}

@item 
@ref{4c53,,PyDictRevIterKey_Type}

@item 
@ref{4c54,,PyDictRevIterValue_Type}

@item 
@ref{4c55,,PyDictValues_Type}

@item 
@ref{4c56,,PyDict_Clear()}

@item 
@ref{338,,PyDict_Contains()}

@item 
@ref{420,,PyDict_Copy()}

@item 
@ref{4c57,,PyDict_DelItem()}

@item 
@ref{4c58,,PyDict_DelItemString()}

@item 
@ref{387,,PyDict_GetItem()}

@item 
@ref{33a,,PyDict_GetItemRef()}

@item 
@ref{388,,PyDict_GetItemString()}

@item 
@ref{33b,,PyDict_GetItemStringRef()}

@item 
@ref{33c,,PyDict_GetItemWithError()}

@item 
@ref{4c59,,PyDict_Items()}

@item 
@ref{4c5a,,PyDict_Keys()}

@item 
@ref{4c5b,,PyDict_Merge()}

@item 
@ref{4c5c,,PyDict_MergeFromSeq2()}

@item 
@ref{4c5d,,PyDict_New()}

@item 
@ref{16fd,,PyDict_Next()}

@item 
@ref{4b63,,PyDict_SetItem()}

@item 
@ref{16eb,,PyDict_SetItemString()}

@item 
@ref{4c5e,,PyDict_Size()}

@item 
@ref{4c5f,,PyDict_Type}

@item 
@ref{4c60,,PyDict_Update()}

@item 
@ref{4c61,,PyDict_Values()}

@item 
@ref{4c62,,PyEllipsis_Type}

@item 
@ref{4c63,,PyEnum_Type}

@item 
@ref{4c64,,PyErr_BadArgument()}

@item 
@ref{4c65,,PyErr_BadInternalCall()}

@item 
@ref{467,,PyErr_CheckSignals()}

@item 
@ref{1069,,PyErr_Clear()}

@item 
@code{PyErr_Display()}

@item 
@ref{402,,PyErr_DisplayException()}

@item 
@ref{4be7,,PyErr_ExceptionMatches()}

@item 
@ref{3f3,,PyErr_Fetch()}

@item 
@ref{ee0,,PyErr_Format()}

@item 
@ref{edf,,PyErr_FormatV()}

@item 
@ref{772,,PyErr_GetExcInfo()}

@item 
@ref{76f,,PyErr_GetHandledException()}

@item 
@ref{3f4,,PyErr_GetRaisedException()}

@item 
@ref{4c66,,PyErr_GivenExceptionMatches()}

@item 
@ref{12ab,,PyErr_NewException()}

@item 
@ref{12aa,,PyErr_NewExceptionWithDoc()}

@item 
@ref{4b42,,PyErr_NoMemory()}

@item 
@ref{3f5,,PyErr_NormalizeException()}

@item 
@ref{1a3b,,PyErr_Occurred()}

@item 
@ref{1ab9,,PyErr_Print()}

@item 
@ref{4c67,,PyErr_PrintEx()}

@item 
@ref{4c68,,PyErr_ProgramText()}

@item 
@ref{d39,,PyErr_ResourceWarning()}

@item 
@ref{3f6,,PyErr_Restore()}

@item 
@ref{4c69,,PyErr_SetExcFromWindowsErr()}

@item 
@ref{1808,,PyErr_SetExcFromWindowsErrWithFilename()}

@item 
@ref{4c6a,,PyErr_SetExcFromWindowsErrWithFilenameObject()}

@item 
@ref{4c6b,,PyErr_SetExcFromWindowsErrWithFilenameObjects()}

@item 
@ref{771,,PyErr_SetExcInfo()}

@item 
@ref{4b41,,PyErr_SetFromErrno()}

@item 
@ref{1807,,PyErr_SetFromErrnoWithFilename()}

@item 
@ref{4c6c,,PyErr_SetFromErrnoWithFilenameObject()}

@item 
@ref{4c6d,,PyErr_SetFromErrnoWithFilenameObjects()}

@item 
@ref{4c6e,,PyErr_SetFromWindowsErr()}

@item 
@ref{1809,,PyErr_SetFromWindowsErrWithFilename()}

@item 
@ref{770,,PyErr_SetHandledException()}

@item 
@ref{d60,,PyErr_SetImportError()}

@item 
@ref{d38,,PyErr_SetImportErrorSubclass()}

@item 
@ref{4c6f,,PyErr_SetInterrupt()}

@item 
@ref{8a2,,PyErr_SetInterruptEx()}

@item 
@ref{4c70,,PyErr_SetNone()}

@item 
@ref{57b,,PyErr_SetObject()}

@item 
@ref{3f7,,PyErr_SetRaisedException()}

@item 
@ref{57c,,PyErr_SetString()}

@item 
@ref{4c71,,PyErr_SyntaxLocation()}

@item 
@ref{4c72,,PyErr_SyntaxLocationEx()}

@item 
@ref{1494,,PyErr_WarnEx()}

@item 
@ref{180f,,PyErr_WarnExplicit()}

@item 
@ref{4c73,,PyErr_WarnFormat()}

@item 
@ref{34d,,PyErr_WriteUnraisable()}

@item 
@ref{3aa,,PyEval_AcquireThread()}

@item 
@ref{88a,,PyEval_EvalCode()}

@item 
@ref{1862,,PyEval_EvalCodeEx()}

@item 
@ref{4c74,,PyEval_EvalFrame()}

@item 
@ref{1066,,PyEval_EvalFrameEx()}

@item 
@ref{34f,,PyEval_GetBuiltins()}

@item 
@ref{18c1,,PyEval_GetFrame()}

@item 
@ref{34e,,PyEval_GetFrameBuiltins()}

@item 
@ref{350,,PyEval_GetFrameGlobals()}

@item 
@ref{352,,PyEval_GetFrameLocals()}

@item 
@ref{4c75,,PyEval_GetFuncDesc()}

@item 
@ref{4c76,,PyEval_GetFuncName()}

@item 
@ref{351,,PyEval_GetGlobals()}

@item 
@ref{353,,PyEval_GetLocals()}

@item 
@ref{172f,,PyEval_InitThreads()}

@item 
@ref{4c77,,PyEval_ReleaseThread()}

@item 
@ref{3a9,,PyEval_RestoreThread()}

@item 
@ref{3a8,,PyEval_SaveThread()}

@item 
@ref{4c78,,PyExc_ArithmeticError}

@item 
@ref{4c79,,PyExc_AssertionError}

@item 
@ref{4c7a,,PyExc_AttributeError}

@item 
@ref{4c7b,,PyExc_BaseException}

@item 
@ref{4c7c,,PyExc_BaseExceptionGroup}

@item 
@ref{4c7d,,PyExc_BlockingIOError}

@item 
@ref{4c7e,,PyExc_BrokenPipeError}

@item 
@ref{4c7f,,PyExc_BufferError}

@item 
@ref{4c80,,PyExc_BytesWarning}

@item 
@ref{4c81,,PyExc_ChildProcessError}

@item 
@ref{4c82,,PyExc_ConnectionAbortedError}

@item 
@ref{4c83,,PyExc_ConnectionError}

@item 
@ref{4c84,,PyExc_ConnectionRefusedError}

@item 
@ref{4c85,,PyExc_ConnectionResetError}

@item 
@ref{4c86,,PyExc_DeprecationWarning}

@item 
@ref{4c87,,PyExc_EOFError}

@item 
@ref{4c88,,PyExc_EncodingWarning}

@item 
@ref{4c89,,PyExc_EnvironmentError}

@item 
@ref{4c8a,,PyExc_Exception}

@item 
@ref{4c8b,,PyExc_FileExistsError}

@item 
@ref{4c8c,,PyExc_FileNotFoundError}

@item 
@ref{4c8d,,PyExc_FloatingPointError}

@item 
@ref{4c8e,,PyExc_FutureWarning}

@item 
@ref{4c8f,,PyExc_GeneratorExit}

@item 
@ref{4c90,,PyExc_IOError}

@item 
@ref{4c91,,PyExc_ImportError}

@item 
@ref{4c92,,PyExc_ImportWarning}

@item 
@ref{4c93,,PyExc_IndentationError}

@item 
@ref{4c94,,PyExc_IndexError}

@item 
@ref{4c95,,PyExc_InterruptedError}

@item 
@ref{4c96,,PyExc_IsADirectoryError}

@item 
@ref{4c97,,PyExc_KeyError}

@item 
@ref{4c98,,PyExc_KeyboardInterrupt}

@item 
@ref{4c99,,PyExc_LookupError}

@item 
@ref{4c9a,,PyExc_MemoryError}

@item 
@ref{4c9b,,PyExc_ModuleNotFoundError}

@item 
@ref{4c9c,,PyExc_NameError}

@item 
@ref{4c9d,,PyExc_NotADirectoryError}

@item 
@ref{4c9e,,PyExc_NotImplementedError}

@item 
@ref{4b44,,PyExc_OSError}

@item 
@ref{4c9f,,PyExc_OverflowError}

@item 
@ref{4ca0,,PyExc_PendingDeprecationWarning}

@item 
@ref{4ca1,,PyExc_PermissionError}

@item 
@ref{4ca2,,PyExc_ProcessLookupError}

@item 
@ref{ee1,,PyExc_RecursionError}

@item 
@ref{4ca3,,PyExc_ReferenceError}

@item 
@ref{4ca4,,PyExc_ResourceWarning}

@item 
@ref{4ca5,,PyExc_RuntimeError}

@item 
@ref{4ca6,,PyExc_RuntimeWarning}

@item 
@ref{4ca7,,PyExc_StopAsyncIteration}

@item 
@ref{4ca8,,PyExc_StopIteration}

@item 
@ref{4ca9,,PyExc_SyntaxError}

@item 
@ref{4caa,,PyExc_SyntaxWarning}

@item 
@ref{4cab,,PyExc_SystemError}

@item 
@ref{4cac,,PyExc_SystemExit}

@item 
@ref{4cad,,PyExc_TabError}

@item 
@ref{4cae,,PyExc_TimeoutError}

@item 
@ref{4b43,,PyExc_TypeError}

@item 
@ref{4caf,,PyExc_UnboundLocalError}

@item 
@ref{4cb0,,PyExc_UnicodeDecodeError}

@item 
@ref{4cb1,,PyExc_UnicodeEncodeError}

@item 
@ref{4cb2,,PyExc_UnicodeError}

@item 
@ref{4cb3,,PyExc_UnicodeTranslateError}

@item 
@ref{4cb4,,PyExc_UnicodeWarning}

@item 
@ref{4cb5,,PyExc_UserWarning}

@item 
@ref{4b45,,PyExc_ValueError}

@item 
@ref{4cb6,,PyExc_Warning}

@item 
@ref{4cb7,,PyExc_WindowsError}

@item 
@ref{4b40,,PyExc_ZeroDivisionError}

@item 
@ref{a6f,,PyExceptionClass_Name()}

@item 
@ref{56a,,PyException_GetArgs()}

@item 
@ref{4cb8,,PyException_GetCause()}

@item 
@ref{4cb9,,PyException_GetContext()}

@item 
@ref{4cba,,PyException_GetTraceback()}

@item 
@ref{56b,,PyException_SetArgs()}

@item 
@ref{4cbb,,PyException_SetCause()}

@item 
@ref{4cbc,,PyException_SetContext()}

@item 
@ref{1b61,,PyException_SetTraceback()}

@item 
@ref{4cbd,,PyFile_FromFd()}

@item 
@ref{4cbe,,PyFile_GetLine()}

@item 
@ref{4cbf,,PyFile_WriteObject()}

@item 
@ref{4cc0,,PyFile_WriteString()}

@item 
@ref{4cc1,,PyFilter_Type}

@item 
@ref{a73,,PyFloat_AsDouble()}

@item 
@ref{4cc2,,PyFloat_FromDouble()}

@item 
@ref{4cc3,,PyFloat_FromString()}

@item 
@ref{1437,,PyFloat_GetInfo()}

@item 
@ref{1435,,PyFloat_GetMax()}

@item 
@ref{1436,,PyFloat_GetMin()}

@item 
@ref{4cc4,,PyFloat_Type}

@item 
@ref{789,,PyFrameObject}

@item 
@ref{78a,,PyFrame_GetCode()}

@item 
@ref{78b,,PyFrame_GetLineNumber()}

@item 
@ref{148d,,PyFrozenSet_New()}

@item 
@ref{4cc5,,PyFrozenSet_Type}

@item 
@ref{995,,PyGC_Collect()}

@item 
@ref{8a9,,PyGC_Disable()}

@item 
@ref{8a8,,PyGC_Enable()}

@item 
@ref{8aa,,PyGC_IsEnabled()}

@item 
@ref{3ab,,PyGILState_Ensure()}

@item 
@ref{4cc6,,PyGILState_GetThisThreadState()}

@item 
@ref{3ac,,PyGILState_Release()}

@item 
@ref{4cc7,,PyGILState_STATE}

@item 
@ref{bd1,,PyGetSetDef}

@item 
@ref{4cc8,,PyGetSetDescr_Type}

@item 
@ref{357,,PyImport_AddModule()}

@item 
@ref{4cc9,,PyImport_AddModuleObject()}

@item 
@ref{356,,PyImport_AddModuleRef()}

@item 
@ref{18a4,,PyImport_AppendInittab()}

@item 
@ref{4cca,,PyImport_ExecCodeModule()}

@item 
@ref{4ccb,,PyImport_ExecCodeModuleEx()}

@item 
@ref{4ccc,,PyImport_ExecCodeModuleObject()}

@item 
@ref{4ccd,,PyImport_ExecCodeModuleWithPathnames()}

@item 
@ref{1806,,PyImport_GetImporter()}

@item 
@ref{11e2,,PyImport_GetMagicNumber()}

@item 
@ref{4cce,,PyImport_GetMagicTag()}

@item 
@ref{bcb,,PyImport_GetModule()}

@item 
@ref{4ccf,,PyImport_GetModuleDict()}

@item 
@ref{1443,,PyImport_Import()}

@item 
@ref{4cd0,,PyImport_ImportFrozenModule()}

@item 
@ref{4cd1,,PyImport_ImportFrozenModuleObject()}

@item 
@ref{3be,,PyImport_ImportModule()}

@item 
@ref{11e3,,PyImport_ImportModuleLevel()}

@item 
@ref{4cd2,,PyImport_ImportModuleLevelObject()}

@item 
@ref{3bd,,PyImport_ImportModuleNoBlock()}

@item 
@ref{4cd3,,PyImport_ReloadModule()}

@item 
@ref{991,,PyIndex_Check()}

@item 
@ref{8c2,,PyInterpreterState}

@item 
@ref{43ff,,PyInterpreterState_Clear()}

@item 
@ref{4cd4,,PyInterpreterState_Delete()}

@item 
@ref{3ad,,PyInterpreterState_Get()}

@item 
@ref{4cd5,,PyInterpreterState_GetDict()}

@item 
@ref{bdf,,PyInterpreterState_GetID()}

@item 
@ref{4400,,PyInterpreterState_New()}

@item 
@ref{1a3e,,PyIter_Check()}

@item 
@ref{4cd6,,PyIter_Next()}

@item 
@ref{89c,,PyIter_Send()}

@item 
@ref{4cd7,,PyListIter_Type}

@item 
@ref{4cd8,,PyListRevIter_Type}

@item 
@ref{4cd9,,PyList_Append()}

@item 
@ref{4cda,,PyList_AsTuple()}

@item 
@ref{35a,,PyList_GetItem()}

@item 
@ref{359,,PyList_GetItemRef()}

@item 
@ref{4cdb,,PyList_GetSlice()}

@item 
@ref{165d,,PyList_Insert()}

@item 
@ref{4be1,,PyList_New()}

@item 
@ref{4cdc,,PyList_Reverse()}

@item 
@ref{165e,,PyList_SetItem()}

@item 
@ref{4cdd,,PyList_SetSlice()}

@item 
@ref{1461,,PyList_Size()}

@item 
@ref{4cde,,PyList_Sort()}

@item 
@ref{4b84,,PyList_Type}

@item 
@ref{588,,PyLongObject}

@item 
@ref{4cdf,,PyLongRangeIter_Type}

@item 
@ref{4ce0,,PyLong_AsDouble()}

@item 
@ref{35f,,PyLong_AsInt()}

@item 
@ref{360,,PyLong_AsLong()}

@item 
@ref{12a8,,PyLong_AsLongAndOverflow()}

@item 
@ref{4ce1,,PyLong_AsLongLong()}

@item 
@ref{12a7,,PyLong_AsLongLongAndOverflow()}

@item 
@ref{4ce2,,PyLong_AsSize_t()}

@item 
@ref{4ce3,,PyLong_AsSsize_t()}

@item 
@ref{4ce4,,PyLong_AsUnsignedLong()}

@item 
@ref{12d6,,PyLong_AsUnsignedLongLong()}

@item 
@ref{1b5d,,PyLong_AsUnsignedLongLongMask()}

@item 
@ref{4ce5,,PyLong_AsUnsignedLongMask()}

@item 
@ref{4ce6,,PyLong_AsVoidPtr()}

@item 
@ref{949,,PyLong_FromDouble()}

@item 
@ref{195a,,PyLong_FromLong()}

@item 
@ref{195b,,PyLong_FromLongLong()}

@item 
@ref{1b3a,,PyLong_FromSize_t()}

@item 
@ref{4ce7,,PyLong_FromSsize_t()}

@item 
@ref{4ce8,,PyLong_FromString()}

@item 
@ref{1b38,,PyLong_FromUnsignedLong()}

@item 
@ref{1b39,,PyLong_FromUnsignedLongLong()}

@item 
@ref{4ce9,,PyLong_FromVoidPtr()}

@item 
@ref{4cea,,PyLong_GetInfo()}

@item 
@ref{4ceb,,PyLong_Type}

@item 
@ref{4cec,,PyMap_Type}

@item 
@ref{4ced,,PyMapping_Check()}

@item 
@ref{4cee,,PyMapping_GetItemString()}

@item 
@ref{345,,PyMapping_GetOptionalItem()}

@item 
@ref{346,,PyMapping_GetOptionalItemString()}

@item 
@ref{37f,,PyMapping_HasKey()}

@item 
@ref{381,,PyMapping_HasKeyString()}

@item 
@ref{380,,PyMapping_HasKeyStringWithError()}

@item 
@ref{37e,,PyMapping_HasKeyWithError()}

@item 
@ref{bd7,,PyMapping_Items()}

@item 
@ref{bd5,,PyMapping_Keys()}

@item 
@ref{4cef,,PyMapping_Length()}

@item 
@ref{4cf0,,PyMapping_SetItemString()}

@item 
@ref{1bd0,,PyMapping_Size()}

@item 
@ref{bd6,,PyMapping_Values()}

@item 
@ref{edc,,PyMem_Calloc()}

@item 
@ref{148a,,PyMem_Free()}

@item 
@ref{c81,,PyMem_Malloc()}

@item 
@ref{391,,PyMem_RawCalloc()}

@item 
@ref{393,,PyMem_RawFree()}

@item 
@ref{390,,PyMem_RawMalloc()}

@item 
@ref{392,,PyMem_RawRealloc()}

@item 
@ref{106a,,PyMem_Realloc()}

@item 
@ref{54f,,PyMemberDef}

@item 
@ref{4cf1,,PyMemberDescr_Type}

@item 
@ref{58d,,PyMember_GetOne()}

@item 
@ref{58e,,PyMember_SetOne()}

@item 
@ref{761,,PyMemoryView_FromBuffer()}

@item 
@ref{11af,,PyMemoryView_FromMemory()}

@item 
@ref{4cf2,,PyMemoryView_FromObject()}

@item 
@ref{4cf3,,PyMemoryView_GetContiguous()}

@item 
@ref{4cf4,,PyMemoryView_Type}

@item 
@ref{151f,,PyMethodDef}

@item 
@ref{4cf5,,PyMethodDescr_Type}

@item 
@ref{984,,PyModuleDef}

@item 
@code{PyModuleDef_Base}

@item 
@ref{4b4c,,PyModuleDef_Init()}

@item 
@ref{4cf6,,PyModuleDef_Slot}

@item 
@code{PyModuleDef_Type}

@item 
@ref{364,,PyModule_Add()}

@item 
@ref{4cf7,,PyModule_AddFunctions()}

@item 
@ref{1585,,PyModule_AddIntConstant()}

@item 
@ref{366,,PyModule_AddObject()}

@item 
@ref{365,,PyModule_AddObjectRef()}

@item 
@ref{1586,,PyModule_AddStringConstant()}

@item 
@ref{97c,,PyModule_AddType()}

@item 
@ref{4cf8,,PyModule_Create2()}

@item 
@ref{ee4,,PyModule_ExecDef()}

@item 
@ref{ee3,,PyModule_FromDefAndSpec2()}

@item 
@ref{4cf9,,PyModule_GetDef()}

@item 
@ref{4cfa,,PyModule_GetDict()}

@item 
@ref{3f8,,PyModule_GetFilename()}

@item 
@ref{3f9,,PyModule_GetFilenameObject()}

@item 
@ref{4cfb,,PyModule_GetName()}

@item 
@ref{4cfc,,PyModule_GetNameObject()}

@item 
@ref{987,,PyModule_GetState()}

@item 
@ref{4cfd,,PyModule_New()}

@item 
@ref{4cfe,,PyModule_NewObject()}

@item 
@ref{4cff,,PyModule_SetDocString()}

@item 
@ref{4d00,,PyModule_Type}

@item 
@ref{4d01,,PyNumber_Absolute()}

@item 
@ref{4d02,,PyNumber_Add()}

@item 
@ref{4d03,,PyNumber_And()}

@item 
@ref{4d04,,PyNumber_AsSsize_t()}

@item 
@ref{a70,,PyNumber_Check()}

@item 
@ref{4d05,,PyNumber_Divmod()}

@item 
@ref{a72,,PyNumber_Float()}

@item 
@ref{4d06,,PyNumber_FloorDivide()}

@item 
@ref{4d07,,PyNumber_InPlaceAdd()}

@item 
@ref{4d08,,PyNumber_InPlaceAnd()}

@item 
@ref{4d09,,PyNumber_InPlaceFloorDivide()}

@item 
@ref{4d0a,,PyNumber_InPlaceLshift()}

@item 
@ref{ee6,,PyNumber_InPlaceMatrixMultiply()}

@item 
@ref{4d0b,,PyNumber_InPlaceMultiply()}

@item 
@ref{4d0c,,PyNumber_InPlaceOr()}

@item 
@ref{4d0d,,PyNumber_InPlacePower()}

@item 
@ref{4d0e,,PyNumber_InPlaceRemainder()}

@item 
@ref{4d0f,,PyNumber_InPlaceRshift()}

@item 
@ref{4d10,,PyNumber_InPlaceSubtract()}

@item 
@ref{4d11,,PyNumber_InPlaceTrueDivide()}

@item 
@ref{4d12,,PyNumber_InPlaceXor()}

@item 
@ref{897,,PyNumber_Index()}

@item 
@ref{4d13,,PyNumber_Invert()}

@item 
@ref{a71,,PyNumber_Long()}

@item 
@ref{4d14,,PyNumber_Lshift()}

@item 
@ref{ee5,,PyNumber_MatrixMultiply()}

@item 
@ref{4d15,,PyNumber_Multiply()}

@item 
@ref{4d16,,PyNumber_Negative()}

@item 
@ref{4d17,,PyNumber_Or()}

@item 
@ref{4d18,,PyNumber_Positive()}

@item 
@ref{4d19,,PyNumber_Power()}

@item 
@ref{4d1a,,PyNumber_Remainder()}

@item 
@ref{4d1b,,PyNumber_Rshift()}

@item 
@ref{4d1c,,PyNumber_Subtract()}

@item 
@ref{18fe,,PyNumber_ToBase()}

@item 
@ref{4d1d,,PyNumber_TrueDivide()}

@item 
@ref{4d1e,,PyNumber_Xor()}

@item 
@ref{3fa,,PyOS_AfterFork()}

@item 
@ref{3fb,,PyOS_AfterFork_Child()}

@item 
@ref{bd9,,PyOS_AfterFork_Parent()}

@item 
@ref{bd8,,PyOS_BeforeFork()}

@item 
@ref{192c,,PyOS_CheckStack()}

@item 
@ref{d3a,,PyOS_FSPath()}

@item 
@ref{585,,PyOS_InputHook}

@item 
@ref{1acf,,PyOS_InterruptOccurred()}

@item 
@ref{4d1f,,PyOS_double_to_string()}

@item 
@ref{1587,,PyOS_getsig()}

@item 
@ref{1ac8,,PyOS_mystricmp()}

@item 
@ref{1ac7,,PyOS_mystrnicmp()}

@item 
@ref{1588,,PyOS_setsig()}

@item 
@ref{4d20,,PyOS_sighandler_t}

@item 
@ref{1552,,PyOS_snprintf()}

@item 
@ref{12d7,,PyOS_string_to_double()}

@item 
@ref{4d21,,PyOS_strtol()}

@item 
@ref{4d22,,PyOS_strtoul()}

@item 
@ref{1553,,PyOS_vsnprintf()}

@item 
@ref{339,,PyObject}

@item 
@ref{8a3,,PyObject.ob_refcnt}

@item 
@ref{4b77,,PyObject.ob_type}

@item 
@ref{4d23,,PyObject_ASCII()}

@item 
@ref{4d24,,PyObject_AsFileDescriptor()}

@item 
@ref{4d25,,PyObject_Bytes()}

@item 
@ref{39c,,PyObject_Call()}

@item 
@ref{39e,,PyObject_CallFunction()}

@item 
@ref{4d26,,PyObject_CallFunctionObjArgs()}

@item 
@ref{39f,,PyObject_CallMethod()}

@item 
@ref{1b74,,PyObject_CallMethodObjArgs()}

@item 
@ref{39b,,PyObject_CallNoArgs()}

@item 
@ref{4b56,,PyObject_CallObject()}

@item 
@ref{edd,,PyObject_Calloc()}

@item 
@ref{398,,PyObject_CheckBuffer()}

@item 
@ref{576,,PyObject_ClearWeakRefs()}

@item 
@ref{75d,,PyObject_CopyData()}

@item 
@ref{161f,,PyObject_DelAttr()}

@item 
@ref{1620,,PyObject_DelAttrString()}

@item 
@ref{4d27,,PyObject_DelItem()}

@item 
@ref{4d28,,PyObject_DelItemString()}

@item 
@ref{4d29,,PyObject_Dir()}

@item 
@ref{4d2a,,PyObject_Format()}

@item 
@ref{c80,,PyObject_Free()}

@item 
@ref{154c,,PyObject_GC_Del()}

@item 
@ref{97e,,PyObject_GC_IsFinalized()}

@item 
@ref{97d,,PyObject_GC_IsTracked()}

@item 
@ref{154d,,PyObject_GC_Track()}

@item 
@ref{154e,,PyObject_GC_UnTrack()}

@item 
@ref{4d2b,,PyObject_GenericGetAttr()}

@item 
@ref{1a92,,PyObject_GenericGetDict()}

@item 
@ref{4d2c,,PyObject_GenericSetAttr()}

@item 
@ref{4d2d,,PyObject_GenericSetDict()}

@item 
@ref{4d2e,,PyObject_GetAIter()}

@item 
@ref{347,,PyObject_GetAttr()}

@item 
@ref{348,,PyObject_GetAttrString()}

@item 
@ref{399,,PyObject_GetBuffer()}

@item 
@ref{4be2,,PyObject_GetItem()}

@item 
@ref{4d2f,,PyObject_GetIter()}

@item 
@ref{349,,PyObject_GetOptionalAttr()}

@item 
@ref{34a,,PyObject_GetOptionalAttrString()}

@item 
@ref{549,,PyObject_GetTypeData()}

@item 
@ref{37b,,PyObject_HasAttr()}

@item 
@ref{37d,,PyObject_HasAttrString()}

@item 
@ref{37c,,PyObject_HasAttrStringWithError()}

@item 
@ref{37a,,PyObject_HasAttrWithError()}

@item 
@ref{403,,PyObject_Hash()}

@item 
@ref{140d,,PyObject_HashNotImplemented()}

@item 
@ref{a74,,PyObject_Init()}

@item 
@ref{1acd,,PyObject_InitVar()}

@item 
@ref{ed5,,PyObject_IsInstance()}

@item 
@ref{ed6,,PyObject_IsSubclass()}

@item 
@ref{4d30,,PyObject_IsTrue()}

@item 
@ref{4d31,,PyObject_Length()}

@item 
@ref{c83,,PyObject_Malloc()}

@item 
@ref{4d32,,PyObject_Not()}

@item 
@ref{148b,,PyObject_Realloc()}

@item 
@ref{1067,,PyObject_Repr()}

@item 
@ref{4b9a,,PyObject_RichCompare()}

@item 
@ref{1b1b,,PyObject_RichCompareBool()}

@item 
@ref{4d33,,PyObject_SelfIter()}

@item 
@ref{4d34,,PyObject_SetAttr()}

@item 
@ref{16ec,,PyObject_SetAttrString()}

@item 
@ref{4be0,,PyObject_SetItem()}

@item 
@ref{4d35,,PyObject_Size()}

@item 
@ref{1068,,PyObject_Str()}

@item 
@ref{4d36,,PyObject_Type()}

@item 
@ref{55c,,PyObject_Vectorcall()}

@item 
@ref{55d,,PyObject_VectorcallMethod()}

@item 
@ref{4d37,,PyProperty_Type}

@item 
@ref{4d38,,PyRangeIter_Type}

@item 
@ref{4d39,,PyRange_Type}

@item 
@ref{4d3a,,PyReversed_Type}

@item 
@ref{4d3b,,PySeqIter_New()}

@item 
@ref{4d3c,,PySeqIter_Type}

@item 
@ref{4d3d,,PySequence_Check()}

@item 
@ref{4d3e,,PySequence_Concat()}

@item 
@ref{4d3f,,PySequence_Contains()}

@item 
@ref{4d40,,PySequence_Count()}

@item 
@ref{1bcf,,PySequence_DelItem()}

@item 
@ref{4d41,,PySequence_DelSlice()}

@item 
@ref{4d42,,PySequence_Fast()}

@item 
@ref{1bcd,,PySequence_GetItem()}

@item 
@ref{4d43,,PySequence_GetSlice()}

@item 
@code{PySequence_In()}

@item 
@ref{4d44,,PySequence_InPlaceConcat()}

@item 
@ref{4d45,,PySequence_InPlaceRepeat()}

@item 
@ref{4d46,,PySequence_Index()}

@item 
@ref{4d47,,PySequence_Length()}

@item 
@ref{4d48,,PySequence_List()}

@item 
@ref{4d49,,PySequence_Repeat()}

@item 
@ref{1bce,,PySequence_SetItem()}

@item 
@ref{4d4a,,PySequence_SetSlice()}

@item 
@ref{1bcc,,PySequence_Size()}

@item 
@ref{4d4b,,PySequence_Tuple()}

@item 
@ref{4d4c,,PySetIter_Type}

@item 
@ref{148e,,PySet_Add()}

@item 
@ref{4d4d,,PySet_Clear()}

@item 
@ref{1490,,PySet_Contains()}

@item 
@ref{148f,,PySet_Discard()}

@item 
@ref{148c,,PySet_New()}

@item 
@ref{4d4e,,PySet_Pop()}

@item 
@ref{1491,,PySet_Size()}

@item 
@ref{4d4f,,PySet_Type}

@item 
@ref{3fe,,PySlice_AdjustIndices()}

@item 
@ref{4d50,,PySlice_GetIndices()}

@item 
@ref{3fc,,PySlice_GetIndicesEx()}

@item 
@ref{4d51,,PySlice_New()}

@item 
@ref{4d52,,PySlice_Type}

@item 
@ref{3fd,,PySlice_Unpack()}

@item 
@ref{4d53,,PyState_AddModule()}

@item 
@ref{4d54,,PyState_FindModule()}

@item 
@ref{4d55,,PyState_RemoveModule()}

@item 
@ref{bd3,,PyStructSequence_Desc}

@item 
@ref{bd2,,PyStructSequence_Field}

@item 
@ref{4d56,,PyStructSequence_GetItem()}

@item 
@ref{4d57,,PyStructSequence_New()}

@item 
@ref{4d58,,PyStructSequence_NewType()}

@item 
@ref{4d59,,PyStructSequence_SetItem()}

@item 
@ref{989,,PyStructSequence_UnnamedField}

@item 
@ref{4d5a,,PySuper_Type}

@item 
@ref{36f,,PySys_Audit()}

@item 
@ref{36e,,PySys_AuditTuple()}

@item 
@ref{4d5b,,PySys_FormatStderr()}

@item 
@ref{4d5c,,PySys_FormatStdout()}

@item 
@ref{389,,PySys_GetObject()}

@item 
@ref{4d5d,,PySys_GetXOptions()}

@item 
@ref{3af,,PySys_ResetWarnOptions()}

@item 
@ref{172e,,PySys_SetArgv()}

@item 
@ref{172d,,PySys_SetArgvEx()}

@item 
@ref{4d5e,,PySys_SetObject()}

@item 
@ref{4d5f,,PySys_WriteStderr()}

@item 
@ref{4d60,,PySys_WriteStdout()}

@item 
@ref{78d,,PyThreadState}

@item 
@ref{170b,,PyThreadState_Clear()}

@item 
@ref{1b18,,PyThreadState_Delete()}

@item 
@ref{372,,PyThreadState_Get()}

@item 
@ref{4d61,,PyThreadState_GetDict()}

@item 
@ref{78e,,PyThreadState_GetFrame()}

@item 
@ref{979,,PyThreadState_GetID()}

@item 
@ref{978,,PyThreadState_GetInterpreter()}

@item 
@ref{4d62,,PyThreadState_New()}

@item 
@ref{bdd,,PyThreadState_SetAsyncExc()}

@item 
@ref{4d63,,PyThreadState_Swap()}

@item 
@ref{4d64,,PyThread_GetInfo()}

@item 
@ref{40e,,PyThread_ReInitTLS()}

@item 
@ref{4d65,,PyThread_acquire_lock()}

@item 
@ref{4d66,,PyThread_acquire_lock_timed()}

@item 
@ref{4d67,,PyThread_allocate_lock()}

@item 
@ref{404,,PyThread_create_key()}

@item 
@ref{406,,PyThread_delete_key()}

@item 
@ref{40c,,PyThread_delete_key_value()}

@item 
@ref{4d68,,PyThread_exit_thread()}

@item 
@ref{4d69,,PyThread_free_lock()}

@item 
@ref{40a,,PyThread_get_key_value()}

@item 
@ref{4d6a,,PyThread_get_stacksize()}

@item 
@ref{4d6b,,PyThread_get_thread_ident()}

@item 
@ref{192d,,PyThread_get_thread_native_id()}

@item 
@ref{4d6c,,PyThread_init_thread()}

@item 
@ref{4d6d,,PyThread_release_lock()}

@item 
@ref{408,,PyThread_set_key_value()}

@item 
@ref{4d6e,,PyThread_set_stacksize()}

@item 
@ref{1bc4,,PyThread_start_new_thread()}

@item 
@ref{405,,PyThread_tss_alloc()}

@item 
@ref{4d6f,,PyThread_tss_create()}

@item 
@ref{40d,,PyThread_tss_delete()}

@item 
@ref{407,,PyThread_tss_free()}

@item 
@ref{40b,,PyThread_tss_get()}

@item 
@ref{4d70,,PyThread_tss_is_created()}

@item 
@ref{409,,PyThread_tss_set()}

@item 
@ref{4d71,,PyTraceBack_Here()}

@item 
@ref{4d72,,PyTraceBack_Print()}

@item 
@ref{4d73,,PyTraceBack_Type}

@item 
@ref{4d74,,PyTupleIter_Type}

@item 
@ref{4b61,,PyTuple_GetItem()}

@item 
@ref{4d75,,PyTuple_GetSlice()}

@item 
@ref{39d,,PyTuple_New()}

@item 
@ref{4d76,,PyTuple_Pack()}

@item 
@ref{4b62,,PyTuple_SetItem()}

@item 
@ref{4d77,,PyTuple_Size()}

@item 
@ref{4d78,,PyTuple_Type}

@item 
@ref{ab4,,PyTypeObject}

@item 
@ref{4d79,,PyType_ClearCache()}

@item 
@ref{550,,PyType_FromMetaclass()}

@item 
@ref{551,,PyType_FromModuleAndSpec()}

@item 
@ref{57d,,PyType_FromSpec()}

@item 
@ref{57e,,PyType_FromSpecWithBases()}

@item 
@ref{a75,,PyType_GenericAlloc()}

@item 
@ref{4b76,,PyType_GenericNew()}

@item 
@ref{1aca,,PyType_GetFlags()}

@item 
@ref{373,,PyType_GetFullyQualifiedName()}

@item 
@ref{975,,PyType_GetModule()}

@item 
@ref{394,,PyType_GetModuleByDef()}

@item 
@ref{375,,PyType_GetModuleName()}

@item 
@ref{976,,PyType_GetModuleState()}

@item 
@ref{752,,PyType_GetName()}

@item 
@ref{753,,PyType_GetQualName()}

@item 
@ref{8a0,,PyType_GetSlot()}

@item 
@ref{54a,,PyType_GetTypeDataSize()}

@item 
@ref{4d7a,,PyType_IsSubtype()}

@item 
@ref{1906,,PyType_Modified()}

@item 
@ref{77c,,PyType_Ready()}

@item 
@ref{4d7b,,PyType_Slot}

@item 
@ref{180b,,PyType_Spec}

@item 
@ref{54d,,PyType_Type}

@item 
@ref{4d7c,,PyUnicodeDecodeError_Create()}

@item 
@ref{4d7d,,PyUnicodeDecodeError_GetEncoding()}

@item 
@ref{4d7e,,PyUnicodeDecodeError_GetEnd()}

@item 
@ref{4d7f,,PyUnicodeDecodeError_GetObject()}

@item 
@ref{4d80,,PyUnicodeDecodeError_GetReason()}

@item 
@ref{4d81,,PyUnicodeDecodeError_GetStart()}

@item 
@ref{4d82,,PyUnicodeDecodeError_SetEnd()}

@item 
@ref{4d83,,PyUnicodeDecodeError_SetReason()}

@item 
@ref{4d84,,PyUnicodeDecodeError_SetStart()}

@item 
@ref{4d85,,PyUnicodeEncodeError_GetEncoding()}

@item 
@ref{4d86,,PyUnicodeEncodeError_GetEnd()}

@item 
@ref{4d87,,PyUnicodeEncodeError_GetObject()}

@item 
@ref{4d88,,PyUnicodeEncodeError_GetReason()}

@item 
@ref{4d89,,PyUnicodeEncodeError_GetStart()}

@item 
@ref{4d8a,,PyUnicodeEncodeError_SetEnd()}

@item 
@ref{4d8b,,PyUnicodeEncodeError_SetReason()}

@item 
@ref{4d8c,,PyUnicodeEncodeError_SetStart()}

@item 
@ref{4d8d,,PyUnicodeIter_Type}

@item 
@ref{4d8e,,PyUnicodeTranslateError_GetEnd()}

@item 
@ref{4d8f,,PyUnicodeTranslateError_GetObject()}

@item 
@ref{4d90,,PyUnicodeTranslateError_GetReason()}

@item 
@ref{4d91,,PyUnicodeTranslateError_GetStart()}

@item 
@ref{4d92,,PyUnicodeTranslateError_SetEnd()}

@item 
@ref{4d93,,PyUnicodeTranslateError_SetReason()}

@item 
@ref{4d94,,PyUnicodeTranslateError_SetStart()}

@item 
@code{PyUnicode_Append()}

@item 
@code{PyUnicode_AppendAndDel()}

@item 
@ref{11d1,,PyUnicode_AsASCIIString()}

@item 
@ref{4d95,,PyUnicode_AsCharmapString()}

@item 
@code{PyUnicode_AsDecodedObject()}

@item 
@code{PyUnicode_AsDecodedUnicode()}

@item 
@code{PyUnicode_AsEncodedObject()}

@item 
@ref{4d96,,PyUnicode_AsEncodedString()}

@item 
@code{PyUnicode_AsEncodedUnicode()}

@item 
@ref{11d0,,PyUnicode_AsLatin1String()}

@item 
@ref{11d2,,PyUnicode_AsMBCSString()}

@item 
@ref{11cf,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@ref{11b7,,PyUnicode_AsUCS4()}

@item 
@ref{8c0,,PyUnicode_AsUCS4Copy()}

@item 
@ref{4d97,,PyUnicode_AsUTF16String()}

@item 
@ref{4d98,,PyUnicode_AsUTF32String()}

@item 
@ref{89d,,PyUnicode_AsUTF8AndSize()}

@item 
@ref{11cd,,PyUnicode_AsUTF8String()}

@item 
@ref{11ce,,PyUnicode_AsUnicodeEscapeString()}

@item 
@ref{1bd1,,PyUnicode_AsWideChar()}

@item 
@ref{8c1,,PyUnicode_AsWideCharString()}

@item 
@ref{17e4,,PyUnicode_BuildEncodingMap()}

@item 
@ref{8bc,,PyUnicode_Compare()}

@item 
@ref{12a9,,PyUnicode_CompareWithASCIIString()}

@item 
@ref{11e0,,PyUnicode_Concat()}

@item 
@ref{4d99,,PyUnicode_Contains()}

@item 
@ref{4d9a,,PyUnicode_Count()}

@item 
@ref{1b59,,PyUnicode_Decode()}

@item 
@ref{4d9b,,PyUnicode_DecodeASCII()}

@item 
@ref{4d9c,,PyUnicode_DecodeCharmap()}

@item 
@ref{4d9d,,PyUnicode_DecodeCodePageStateful()}

@item 
@ref{180a,,PyUnicode_DecodeFSDefault()}

@item 
@ref{4d9e,,PyUnicode_DecodeFSDefaultAndSize()}

@item 
@ref{4d9f,,PyUnicode_DecodeLatin1()}

@item 
@ref{4da0,,PyUnicode_DecodeLocale()}

@item 
@ref{be2,,PyUnicode_DecodeLocaleAndSize()}

@item 
@ref{4da1,,PyUnicode_DecodeMBCS()}

@item 
@ref{4da2,,PyUnicode_DecodeMBCSStateful()}

@item 
@ref{4da3,,PyUnicode_DecodeRawUnicodeEscape()}

@item 
@ref{4da4,,PyUnicode_DecodeUTF16()}

@item 
@ref{4da5,,PyUnicode_DecodeUTF16Stateful()}

@item 
@ref{4da6,,PyUnicode_DecodeUTF32()}

@item 
@ref{4da7,,PyUnicode_DecodeUTF32Stateful()}

@item 
@ref{4da8,,PyUnicode_DecodeUTF7()}

@item 
@ref{4da9,,PyUnicode_DecodeUTF7Stateful()}

@item 
@ref{4daa,,PyUnicode_DecodeUTF8()}

@item 
@ref{189f,,PyUnicode_DecodeUTF8Stateful()}

@item 
@ref{4dab,,PyUnicode_DecodeUnicodeEscape()}

@item 
@ref{11d3,,PyUnicode_EncodeCodePage()}

@item 
@ref{1bca,,PyUnicode_EncodeFSDefault()}

@item 
@ref{be3,,PyUnicode_EncodeLocale()}

@item 
@ref{377,,PyUnicode_EqualToUTF8()}

@item 
@ref{376,,PyUnicode_EqualToUTF8AndSize()}

@item 
@ref{d3b,,PyUnicode_FSConverter()}

@item 
@ref{577,,PyUnicode_FSDecoder()}

@item 
@ref{4dac,,PyUnicode_Find()}

@item 
@ref{8be,,PyUnicode_FindChar()}

@item 
@ref{4dad,,PyUnicode_Format()}

@item 
@ref{4dae,,PyUnicode_FromEncodedObject()}

@item 
@ref{38a,,PyUnicode_FromFormat()}

@item 
@ref{574,,PyUnicode_FromFormatV()}

@item 
@ref{4daf,,PyUnicode_FromObject()}

@item 
@ref{4db0,,PyUnicode_FromOrdinal()}

@item 
@ref{4db1,,PyUnicode_FromString()}

@item 
@ref{4db2,,PyUnicode_FromStringAndSize()}

@item 
@ref{11cb,,PyUnicode_FromWideChar()}

@item 
@ref{4db3,,PyUnicode_GetDefaultEncoding()}

@item 
@ref{8b8,,PyUnicode_GetLength()}

@item 
@ref{16ea,,PyUnicode_InternFromString()}

@item 
@ref{8b6,,PyUnicode_InternInPlace()}

@item 
@ref{1b15,,PyUnicode_IsIdentifier()}

@item 
@ref{11e1,,PyUnicode_Join()}

@item 
@ref{1655,,PyUnicode_Partition()}

@item 
@ref{1656,,PyUnicode_RPartition()}

@item 
@ref{1654,,PyUnicode_RSplit()}

@item 
@ref{11b0,,PyUnicode_ReadChar()}

@item 
@ref{4db4,,PyUnicode_Replace()}

@item 
@code{PyUnicode_Resize()}

@item 
@ref{4db5,,PyUnicode_RichCompare()}

@item 
@ref{4db6,,PyUnicode_Split()}

@item 
@ref{4db7,,PyUnicode_Splitlines()}

@item 
@ref{8bb,,PyUnicode_Substring()}

@item 
@ref{8bd,,PyUnicode_Tailmatch()}

@item 
@ref{4db8,,PyUnicode_Translate()}

@item 
@ref{4db9,,PyUnicode_Type}

@item 
@ref{11b1,,PyUnicode_WriteChar()}

@item 
@ref{4384,,PyVarObject}

@item 
@code{PyVarObject.ob_base}

@item 
@ref{4dba,,PyVarObject.ob_size}

@item 
@ref{556,,PyVectorcall_Call()}

@item 
@ref{555,,PyVectorcall_NARGS()}

@item 
@code{PyWeakReference}

@item 
@ref{379,,PyWeakref_GetObject()}

@item 
@ref{378,,PyWeakref_GetRef()}

@item 
@ref{4dbb,,PyWeakref_NewProxy()}

@item 
@ref{196f,,PyWeakref_NewRef()}

@item 
@ref{4dbc,,PyWrapperDescr_Type}

@item 
@ref{4dbd,,PyWrapper_New()}

@item 
@ref{4dbe,,PyZip_Type}

@item 
@ref{592,,Py_AUDIT_READ}

@item 
@ref{988,,Py_AddPendingCall()}

@item 
@ref{4dbf,,Py_AtExit()}

@item 
@ref{4b67,,Py_BEGIN_ALLOW_THREADS}

@item 
@ref{4dc0,,Py_BLOCK_THREADS}

@item 
@ref{8ac,,Py_BuildValue()}

@item 
@ref{9c9,,Py_BytesMain()}

@item 
@ref{889,,Py_CompileString()}

@item 
@ref{4dc1,,Py_DecRef()}

@item 
@ref{be0,,Py_DecodeLocale()}

@item 
@ref{a98,,Py_END_ALLOW_THREADS}

@item 
@ref{be1,,Py_EncodeLocale()}

@item 
@ref{1985,,Py_EndInterpreter()}

@item 
@ref{97a,,Py_EnterRecursiveCall()}

@item 
@ref{d72,,Py_Exit()}

@item 
@ref{98a,,Py_FatalError()}

@item 
@code{Py_FileSystemDefaultEncodeErrors}

@item 
@code{Py_FileSystemDefaultEncoding}

@item 
@ref{13a0,,Py_Finalize()}

@item 
@ref{d37,,Py_FinalizeEx()}

@item 
@ref{4dc2,,Py_GenericAlias()}

@item 
@ref{4dc3,,Py_GenericAliasType}

@item 
@ref{1479,,Py_GetBuildInfo()}

@item 
@ref{4dc4,,Py_GetCompiler()}

@item 
@ref{354,,Py_GetConstant()}

@item 
@ref{355,,Py_GetConstantBorrowed()}

@item 
@ref{4dc5,,Py_GetCopyright()}

@item 
@ref{3b1,,Py_GetExecPrefix()}

@item 
@ref{3b3,,Py_GetPath()}

@item 
@ref{4dc6,,Py_GetPlatform()}

@item 
@ref{3b5,,Py_GetPrefix()}

@item 
@ref{3b7,,Py_GetProgramFullPath()}

@item 
@ref{3b9,,Py_GetProgramName()}

@item 
@ref{3ba,,Py_GetPythonHome()}

@item 
@ref{4dc7,,Py_GetRecursionLimit()}

@item 
@ref{4dc8,,Py_GetVersion()}

@item 
@code{Py_HasFileSystemDefaultEncoding}

@item 
@ref{4dc9,,Py_IncRef()}

@item 
@ref{8b1,,Py_Initialize()}

@item 
@ref{4dca,,Py_InitializeEx()}

@item 
@ref{8a4,,Py_Is()}

@item 
@ref{8a7,,Py_IsFalse()}

@item 
@ref{358,,Py_IsFinalizing()}

@item 
@ref{4bea,,Py_IsInitialized()}

@item 
@ref{8a5,,Py_IsNone()}

@item 
@ref{8a6,,Py_IsTrue()}

@item 
@ref{97b,,Py_LeaveRecursiveCall()}

@item 
@ref{c3f,,Py_Main()}

@item 
@ref{4dcb,,Py_MakePendingCalls()}

@item 
@ref{18b9,,Py_NewInterpreter()}

@item 
@ref{89e,,Py_NewRef()}

@item 
@ref{591,,Py_READONLY}

@item 
@ref{54e,,Py_RELATIVE_OFFSET}

@item 
@ref{4dcc,,Py_ReprEnter()}

@item 
@ref{4dcd,,Py_ReprLeave()}

@item 
@ref{172c,,Py_SetProgramName()}

@item 
@ref{172b,,Py_SetPythonHome()}

@item 
@ref{4dce,,Py_SetRecursionLimit()}

@item 
@ref{4b7e,,Py_TPFLAGS_BASETYPE}

@item 
@ref{4b74,,Py_TPFLAGS_DEFAULT}

@item 
@ref{77d,,Py_TPFLAGS_HAVE_GC}

@item 
@ref{554,,Py_TPFLAGS_HAVE_VECTORCALL}

@item 
@ref{54b,,Py_TPFLAGS_ITEMS_AT_END}

@item 
@ref{4dcf,,Py_TPFLAGS_METHOD_DESCRIPTOR}

@item 
@ref{4dd0,,Py_T_BOOL}

@item 
@ref{4dd1,,Py_T_BYTE}

@item 
@ref{4dd2,,Py_T_CHAR}

@item 
@ref{590,,Py_T_DOUBLE}

@item 
@ref{4dd3,,Py_T_FLOAT}

@item 
@ref{58f,,Py_T_INT}

@item 
@ref{4dd4,,Py_T_LONG}

@item 
@ref{4dd5,,Py_T_LONGLONG}

@item 
@ref{594,,Py_T_OBJECT_EX}

@item 
@ref{4dd6,,Py_T_PYSSIZET}

@item 
@ref{4dd7,,Py_T_SHORT}

@item 
@ref{4dd8,,Py_T_STRING}

@item 
@ref{4dd9,,Py_T_STRING_INPLACE}

@item 
@ref{4dda,,Py_T_UBYTE}

@item 
@ref{4ddb,,Py_T_UINT}

@item 
@ref{4ddc,,Py_T_ULONG}

@item 
@ref{4ddd,,Py_T_ULONGLONG}

@item 
@ref{4dde,,Py_T_USHORT}

@item 
@ref{29b,,Py_UCS4}

@item 
@ref{4ddf,,Py_UNBLOCK_THREADS}

@item 
@code{Py_UTF8Mode}

@item 
@ref{4de0,,Py_VaBuildValue()}

@item 
@ref{756,,Py_Version}

@item 
@ref{89f,,Py_XNewRef()}

@item 
@ref{4de1,,Py_am_aiter}

@item 
@ref{4de2,,Py_am_anext}

@item 
@ref{4de3,,Py_am_await}

@item 
@ref{4de4,,Py_am_send}

@item 
@ref{4de5,,Py_bf_getbuffer}

@item 
@ref{4de6,,Py_bf_releasebuffer}

@item 
@ref{758,,Py_buffer}

@item 
@code{Py_intptr_t}

@item 
@ref{4de7,,Py_mod_create}

@item 
@ref{985,,Py_mod_exec}

@item 
@ref{158,,Py_mod_gil}

@item 
@ref{4de8,,Py_mod_multiple_interpreters}

@item 
@ref{4de9,,Py_mp_ass_subscript}

@item 
@ref{4dea,,Py_mp_length}

@item 
@ref{4deb,,Py_mp_subscript}

@item 
@ref{4dec,,Py_nb_absolute}

@item 
@ref{4ded,,Py_nb_add}

@item 
@ref{4dee,,Py_nb_and}

@item 
@ref{4def,,Py_nb_bool}

@item 
@ref{4df0,,Py_nb_divmod}

@item 
@ref{4df1,,Py_nb_float}

@item 
@ref{4df2,,Py_nb_floor_divide}

@item 
@ref{4df3,,Py_nb_index}

@item 
@ref{4df4,,Py_nb_inplace_add}

@item 
@ref{4df5,,Py_nb_inplace_and}

@item 
@ref{4df6,,Py_nb_inplace_floor_divide}

@item 
@ref{4df7,,Py_nb_inplace_lshift}

@item 
@ref{4df8,,Py_nb_inplace_matrix_multiply}

@item 
@ref{4df9,,Py_nb_inplace_multiply}

@item 
@ref{4dfa,,Py_nb_inplace_or}

@item 
@ref{4dfb,,Py_nb_inplace_power}

@item 
@ref{4dfc,,Py_nb_inplace_remainder}

@item 
@ref{4dfd,,Py_nb_inplace_rshift}

@item 
@ref{4dfe,,Py_nb_inplace_subtract}

@item 
@ref{4dff,,Py_nb_inplace_true_divide}

@item 
@ref{4e00,,Py_nb_inplace_xor}

@item 
@ref{4e01,,Py_nb_int}

@item 
@ref{4e02,,Py_nb_invert}

@item 
@ref{4e03,,Py_nb_lshift}

@item 
@ref{4e04,,Py_nb_matrix_multiply}

@item 
@ref{4e05,,Py_nb_multiply}

@item 
@ref{4e06,,Py_nb_negative}

@item 
@ref{4e07,,Py_nb_or}

@item 
@ref{4e08,,Py_nb_positive}

@item 
@ref{4e09,,Py_nb_power}

@item 
@ref{4e0a,,Py_nb_remainder}

@item 
@ref{4e0b,,Py_nb_rshift}

@item 
@ref{4e0c,,Py_nb_subtract}

@item 
@ref{4e0d,,Py_nb_true_divide}

@item 
@ref{4e0e,,Py_nb_xor}

@item 
@ref{4e0f,,Py_sq_ass_item}

@item 
@ref{4e10,,Py_sq_concat}

@item 
@ref{4e11,,Py_sq_contains}

@item 
@ref{4e12,,Py_sq_inplace_concat}

@item 
@ref{4e13,,Py_sq_inplace_repeat}

@item 
@ref{4e14,,Py_sq_item}

@item 
@ref{4e15,,Py_sq_length}

@item 
@ref{4e16,,Py_sq_repeat}

@item 
@ref{a69,,Py_ssize_t}

@item 
@ref{4e17,,Py_tp_alloc}

@item 
@ref{4e18,,Py_tp_base}

@item 
@ref{4e19,,Py_tp_bases}

@item 
@ref{4e1a,,Py_tp_call}

@item 
@ref{4e1b,,Py_tp_clear}

@item 
@ref{4e1c,,Py_tp_dealloc}

@item 
@ref{4e1d,,Py_tp_del}

@item 
@ref{4e1e,,Py_tp_descr_get}

@item 
@ref{4e1f,,Py_tp_descr_set}

@item 
@ref{4e20,,Py_tp_doc}

@item 
@ref{4e21,,Py_tp_finalize}

@item 
@ref{4e22,,Py_tp_free}

@item 
@ref{4e23,,Py_tp_getattr}

@item 
@ref{4e24,,Py_tp_getattro}

@item 
@ref{4e25,,Py_tp_getset}

@item 
@ref{4e26,,Py_tp_hash}

@item 
@ref{4e27,,Py_tp_init}

@item 
@ref{4e28,,Py_tp_is_gc}

@item 
@ref{4e29,,Py_tp_iter}

@item 
@ref{4e2a,,Py_tp_iternext}

@item 
@ref{4e2b,,Py_tp_members}

@item 
@ref{4e2c,,Py_tp_methods}

@item 
@ref{4e2d,,Py_tp_new}

@item 
@ref{4e2e,,Py_tp_repr}

@item 
@ref{4e2f,,Py_tp_richcompare}

@item 
@ref{4e30,,Py_tp_setattr}

@item 
@ref{4e31,,Py_tp_setattro}

@item 
@ref{4e32,,Py_tp_str}

@item 
@ref{4e33,,Py_tp_traverse}

@item 
@code{Py_uintptr_t}

@item 
@ref{4e34,,allocfunc}

@item 
@ref{4e35,,binaryfunc}

@item 
@ref{4e36,,descrgetfunc}

@item 
@ref{4e37,,descrsetfunc}

@item 
@ref{4e38,,destructor}

@item 
@ref{4e39,,getattrfunc}

@item 
@ref{4e3a,,getattrofunc}

@item 
@ref{4e3b,,getbufferproc}

@item 
@ref{4e3c,,getiterfunc}

@item 
@ref{4e3d,,getter}

@item 
@ref{4e3e,,hashfunc}

@item 
@ref{4e3f,,initproc}

@item 
@ref{4e40,,inquiry}

@item 
@ref{4e41,,iternextfunc}

@item 
@ref{4e42,,lenfunc}

@item 
@ref{4e43,,newfunc}

@item 
@ref{4e44,,objobjargproc}

@item 
@ref{4e45,,objobjproc}

@item 
@ref{4e46,,releasebufferproc}

@item 
@ref{4e47,,reprfunc}

@item 
@ref{4e48,,richcmpfunc}

@item 
@ref{4e49,,setattrfunc}

@item 
@ref{4e4a,,setattrofunc}

@item 
@ref{4e4b,,setter}

@item 
@ref{4e4c,,ssizeargfunc}

@item 
@ref{4e4d,,ssizeobjargproc}

@item 
@code{ssizessizeargfunc}

@item 
@code{ssizessizeobjargproc}

@item 
@code{symtable}

@item 
@ref{4e4e,,ternaryfunc}

@item 
@ref{4e4f,,traverseproc}

@item 
@ref{4e50,,unaryfunc}

@item 
@ref{557,,vectorcallfunc}

@item 
@ref{4e51,,visitproc}
@end itemize


@node A camada de nível muito alto,Contagem de referências,Estabilidade da API C,Manual de referência da API Python/C
@anchor{c-api/veryhigh doc}@anchor{4e52}@anchor{c-api/veryhigh the-very-high-level-layer}@anchor{4e53}@anchor{c-api/veryhigh translation-repo}@anchor{4e54}@anchor{c-api/veryhigh veryhigh}@anchor{4e55}
@section A camada de nível muito alto


As funções neste capítulo permitirão que você execute um código-fonte Python fornecido em um arquivo ou buffer, mas não permitirão que você interaja de forma mais detalhada com o interpretador.

Várias dessas funções aceitam um símbolo de início da gramática como parâmetro. Os símbolos de início disponíveis são @ref{4e56,,Py_eval_input}, @ref{4e57,,Py_file_input} e @ref{4e58,,Py_single_input} e @ref{4e59,,Py_func_type_input}. Eles são descritos seguindo as funções que os aceitam como parâmetros.

Note também que várias dessas funções aceitam parâmetros FILE*. Um problema específico que precisa ser tratado com cuidado é que a estrutura @code{FILE} para diferentes bibliotecas C pode ser diferente e incompatível. No Windows (pelo menos), é possível que extensões vinculadas dinamicamente usem bibliotecas diferentes, então deve-se tomar cuidado para que os parâmetros FILE* sejam passados para essas funções somente se for certo que elas foram criadas pela mesma biblioteca que o tempo de execução do Python está usando.

@geindex PyRun_AnyFile (C function)
@anchor{c-api/veryhigh c PyRun_AnyFile}@anchor{4e5a}
@deffn {C Função} int PyRun_AnyFile (FILE *fp, const char *filename)

Esta é uma interface simplificada para @ref{4e5b,,PyRun_AnyFileExFlags()} abaixo, deixando `closeit' definido como @code{0} e `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_AnyFileFlags (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileFlags}@anchor{4e5c}
@deffn {C Função} int PyRun_AnyFileFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Esta é uma interface simplificada para @ref{4e5b,,PyRun_AnyFileExFlags()} abaixo, deixando o argumento `closeit' definido como @code{0}.
@end deffn

@geindex PyRun_AnyFileEx (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileEx}@anchor{4e5d}
@deffn {C Função} int PyRun_AnyFileEx (FILE *fp, const char *filename, int closeit)

Esta é uma interface simplificada para @ref{4e5b,,PyRun_AnyFileExFlags()} abaixo, deixando o argumento `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_AnyFileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_AnyFileExFlags}@anchor{4e5b}
@deffn {C Função} int PyRun_AnyFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

Se `fp' se referir a um arquivo associado a um dispositivo interativo (entrada de console ou terminal ou pseudo-terminal Unix), retorna o valor de @ref{4e5e,,PyRun_InteractiveLoop()}, caso contrário, retorna o resultado de @ref{4bb6,,PyRun_SimpleFile()}. `filename' é decodificado da codificação do sistema de arquivos (@ref{c74,,sys.getfilesystemencoding()}). Se `filename' for @code{NULL}, esta função usa @code{"???"} como o nome do arquivo. Se `closeit' for verdadeiro, o arquivo será fechado antes de @code{PyRun_SimpleFileExFlags()} retornar.
@end deffn

@geindex PyRun_SimpleString (C function)
@anchor{c-api/veryhigh c PyRun_SimpleString}@anchor{4bb5}
@deffn {C Função} int PyRun_SimpleString (const char *command)

Esta é uma interface simplificada para @ref{4e5f,,PyRun_SimpleStringFlags()} abaixo, deixando o argumento @ref{ab0,,PyCompilerFlags}* definido como @code{NULL}.
@end deffn

@geindex PyRun_SimpleStringFlags (C function)
@anchor{c-api/veryhigh c PyRun_SimpleStringFlags}@anchor{4e5f}
@deffn {C Função} int PyRun_SimpleStringFlags (const char *command, PyCompilerFlags *flags)

Executa o código-fonte Python de `command' no módulo @ref{1,,__main__} de acordo com o argumento `flags'. Se @ref{1,,__main__} ainda não existir, ele será criado. Retorna @code{0} em caso de sucesso ou @code{-1} se uma exceção foi gerada. Se houve um erro, não há como obter as informações da exceção. Para o significado de `flags', veja abaixo.

Observe que se uma exceção @ref{d63,,SystemExit} não tratada for levantada, esta função não retornará @code{-1}, mas sairá do processo, desde que @ref{3cf,,PyConfig.inspect} seja zero.
@end deffn

@geindex PyRun_SimpleFile (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFile}@anchor{4bb6}
@deffn {C Função} int PyRun_SimpleFile (FILE *fp, const char *filename)

Esta é uma interface simplificada para @ref{1a56,,PyRun_SimpleFileExFlags()} abaixo, deixando `closeit' definido como @code{0} e `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_SimpleFileEx (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFileEx}@anchor{4e60}
@deffn {C Função} int PyRun_SimpleFileEx (FILE *fp, const char *filename, int closeit)

Esta é uma interface simplificada para @ref{1a56,,PyRun_SimpleFileExFlags()} abaixo, deixando o `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_SimpleFileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_SimpleFileExFlags}@anchor{1a56}
@deffn {C Função} int PyRun_SimpleFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

Semelhante a @ref{4e5f,,PyRun_SimpleStringFlags()}, mas o código-fonte Python é lido de `fp' em vez de uma string na memória. `filename' deve ser o nome do arquivo, ele é decodificado a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Se `closeit' for true, o arquivo será fechado antes que @code{PyRun_SimpleFileExFlags()} retorne.

@cartouche
@quotation Nota 
No Windows, `fp' deve ser aberto como modo binário (por exemplo, @code{fopen(filename, "rb")}). Caso contrário, o Python pode não manipular corretamente o arquivo de script com final de linha LF.
@end quotation
@end cartouche
@end deffn

@geindex PyRun_InteractiveOneObject (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveOneObject}@anchor{4e61}
@deffn {C Função} int PyRun_InteractiveOneObject (FILE *fp, PyObject *filename, PyCompilerFlags *flags)

Lê e executa uma única instrução de um arquivo associado a um dispositivo interativo de acordo com o argumento `flags'. O usuário será solicitado usando @code{sys.ps1} e @code{sys.ps2}. `filename' deve ser um objeto @ref{44c,,str} Python.

Retorna @code{0} quando a entrada foi executada com sucesso, @code{-1} se houve uma exceção ou um código de erro do arquivo de inclusão @code{errcode.h} distribuído como parte do Python se houve um erro de análise. (Observe que @code{errcode.h} não é incluído por @code{Python.h}, então deve ser incluído especificamente se necessário.)
@end deffn

@geindex PyRun_InteractiveOne (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveOne}@anchor{4e62}
@deffn {C Função} int PyRun_InteractiveOne (FILE *fp, const char *filename)

Esta é uma interface simplificada para @ref{4e63,,PyRun_InteractiveOneFlags()} abaixo, deixando `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_InteractiveOneFlags (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveOneFlags}@anchor{4e63}
@deffn {C Função} int PyRun_InteractiveOneFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Semelhante a @ref{4e61,,PyRun_InteractiveOneObject()}, mas `filename' é um const char*, que é decodificado a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}.
@end deffn

@geindex PyRun_InteractiveLoop (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveLoop}@anchor{4e5e}
@deffn {C Função} int PyRun_InteractiveLoop (FILE *fp, const char *filename)

Esta é uma interface simplificada para @ref{4e64,,PyRun_InteractiveLoopFlags()} abaixo, deixando `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_InteractiveLoopFlags (C function)
@anchor{c-api/veryhigh c PyRun_InteractiveLoopFlags}@anchor{4e64}
@deffn {C Função} int PyRun_InteractiveLoopFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

Lê e executa instruções de um arquivo associado a um dispositivo interativo até que o EOF seja atingido. O usuário será consultado usando @code{sys.ps1} e @code{sys.ps2}. `filename' é decodificado a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Retorna @code{0} no EOF ou um número negativo em caso de falha.
@end deffn

@geindex PyOS_InputHook (C var)
@anchor{c-api/veryhigh c PyOS_InputHook}@anchor{585}
@deffn {C Variável} int (*PyOS_InputHook)(void)
` Parte da @ref{553,,ABI Estável}.'
Pode ser definido para apontar para uma função com o protótipo @code{int func(void)}. A função será chamada quando o prompt do interpretador do Python estiver prestes a ficar ocioso e aguardar a entrada do usuário no terminal. O valor de retorno é ignorado. A substituição deste hook pode ser usada para integrar o prompt do interpretador com outros laços de eventos, como feito em @code{Modules/_tkinter.c} no código-fonte do Python.


Alterado na versão 3.12: Esta função só é chamada pelo @ref{587,,interpretador principal}.

@end deffn

@geindex PyOS_ReadlineFunctionPointer (C var)
@anchor{c-api/veryhigh c PyOS_ReadlineFunctionPointer}@anchor{586}
@deffn {C Variável} char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)

Pode ser definido para apontar para uma função com o protótipo @code{char *func(FILE *stdin, FILE *stdout, char *prompt)}, substituindo a função padrão usada para ler uma única linha de entrada no prompt do interpretador. Espera-se que a função produza a string `prompt' se não for @code{NULL} e, em seguida, leia uma linha de entrada do arquivo de entrada padrão fornecido, retornando a string resultante. Por exemplo, o módulo @ref{ba,,readline} define este gancho para fornecer recursos de edição de linha e preenchimento de tabulação.

O resultado deve ser uma string alocada por @ref{390,,PyMem_RawMalloc()} ou @ref{392,,PyMem_RawRealloc()}, ou @code{NULL} se ocorrer um erro.


Alterado na versão 3.4: O resultado deve ser alocado por @ref{390,,PyMem_RawMalloc()} ou @ref{392,,PyMem_RawRealloc()}, em vez de ser alocado por @ref{c81,,PyMem_Malloc()} ou @ref{106a,,PyMem_Realloc()}.



Alterado na versão 3.12: Esta função só é chamada pelo @ref{587,,interpretador principal}.

@end deffn

@geindex PyRun_String (C function)
@anchor{c-api/veryhigh c PyRun_String}@anchor{1b52}
@deffn {C Função} @ref{339,,PyObject} *PyRun_String (const char *str, int start, PyObject *globals, PyObject *locals)
`Retorna valor: Nova referência.'
Esta é uma interface simplificada para @ref{4e65,,PyRun_StringFlags()} abaixo, deixando `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_StringFlags (C function)
@anchor{c-api/veryhigh c PyRun_StringFlags}@anchor{4e65}
@deffn {C Função} @ref{339,,PyObject} *PyRun_StringFlags (const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`Retorna valor: Nova referência.'
Execut o código-fonte Python de `str' no contexto especificado pelos objetos `globals' e `locals' com os sinalizadores do compilador especificados por `flags'. `globals' deve ser um dicionário; `locals' pode ser qualquer objeto que implemente o protocolo de mapeamento. O parâmetro `start' especifica o símbolo inicial e deve ser um dos @ref{4e66,,símbolos iniciais disponíveis}.

Retorna o resultado da execução do código como um objeto Python, ou @code{NULL} se uma exceção foi levantada.
@end deffn

@geindex PyRun_File (C function)
@anchor{c-api/veryhigh c PyRun_File}@anchor{4e67}
@deffn {C Função} @ref{339,,PyObject} *PyRun_File (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
`Retorna valor: Nova referência.'
Esta é uma interface simplificada para @ref{4e68,,PyRun_FileExFlags()} abaixo, deixando `closeit' definido como @code{0} e `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_FileEx (C function)
@anchor{c-api/veryhigh c PyRun_FileEx}@anchor{4e69}
@deffn {C Função} @ref{339,,PyObject} *PyRun_FileEx (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)
`Retorna valor: Nova referência.'
Esta é uma interface simplificada para @ref{4e68,,PyRun_FileExFlags()} abaixo, deixando `flags' definido como @code{NULL}.
@end deffn

@geindex PyRun_FileFlags (C function)
@anchor{c-api/veryhigh c PyRun_FileFlags}@anchor{4e6a}
@deffn {C Função} @ref{339,,PyObject} *PyRun_FileFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`Retorna valor: Nova referência.'
Esta é uma interface simplificada para @ref{4e68,,PyRun_FileExFlags()} abaixo, deixando `closeit' definido como @code{0}.
@end deffn

@geindex PyRun_FileExFlags (C function)
@anchor{c-api/veryhigh c PyRun_FileExFlags}@anchor{4e68}
@deffn {C Função} @ref{339,,PyObject} *PyRun_FileExFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)
`Retorna valor: Nova referência.'
Semelhante a @ref{4e65,,PyRun_StringFlags()}, mas o código-fonte Python é lido de `fp' em vez de uma string na memória. `filename' deve ser o nome do arquivo, ele é decodificado a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Se `closeit' for true, o arquivo será fechado antes que @ref{4e68,,PyRun_FileExFlags()} retorne.
@end deffn

@geindex Py_CompileString (C function)
@anchor{c-api/veryhigh c Py_CompileString}@anchor{889}
@deffn {C Função} @ref{339,,PyObject} *Py_CompileString (const char *str, const char *filename, int start)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Esta é uma interface simplificada para @ref{4e6b,,Py_CompileStringFlags()} abaixo, deixando `flags' definido como @code{NULL}.
@end deffn

@geindex Py_CompileStringFlags (C function)
@anchor{c-api/veryhigh c Py_CompileStringFlags}@anchor{4e6b}
@deffn {C Função} @ref{339,,PyObject} *Py_CompileStringFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags)
`Retorna valor: Nova referência.'
Esta é uma interface simplificada para @ref{4e6c,,Py_CompileStringExFlags()} abaixo, com `optimize' definido como @code{-1}.
@end deffn

@geindex Py_CompileStringObject (C function)
@anchor{c-api/veryhigh c Py_CompileStringObject}@anchor{4e6d}
@deffn {C Função} @ref{339,,PyObject} *Py_CompileStringObject (const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)
`Retorna valor: Nova referência.'
Analisa e compila o código-fonte Python em `str', retornando o objeto de código resultante. O símbolo inicial é fornecido por `start'; isso pode ser usado para restringir o código que pode ser compilado e deve ser @ref{4e66,,símbolos iniciais disponíveis}. O nome do arquivo especificado por `filename' é usado para construir o objeto de código e pode aparecer em tracebacks ou mensagens de exceção @ref{18d,,SyntaxError}. Isso retorna @code{NULL} se o código não puder ser analisado ou compilado.

O inteiro `optimize' especifica o nível de otimização do compilador; um valor de @code{-1} seleciona o nível de otimização do interpretador dado pela opção @ref{ddd,,-O}. Níveis explícitos são @code{0} (nenhuma otimização; @code{__debug__} é verdadeiro), @code{1} (instruções @code{assert} são removidas, @code{__debug__} é falso) ou @code{2} (strings de documentação também são removidas).


Adicionado na versão 3.4.

@end deffn

@geindex Py_CompileStringExFlags (C function)
@anchor{c-api/veryhigh c Py_CompileStringExFlags}@anchor{4e6c}
@deffn {C Função} @ref{339,,PyObject} *Py_CompileStringExFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)
`Retorna valor: Nova referência.'
Como @ref{4e6d,,Py_CompileStringObject()}, mas `filename' é uma string de bytes decodificada a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}.


Adicionado na versão 3.2.

@end deffn

@geindex PyEval_EvalCode (C function)
@anchor{c-api/veryhigh c PyEval_EvalCode}@anchor{88a}
@deffn {C Função} @ref{339,,PyObject} *PyEval_EvalCode (PyObject *co, PyObject *globals, PyObject *locals)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Esta é uma interface simplificada para @ref{1862,,PyEval_EvalCodeEx()}, com apenas o objeto código e variáveis locais e globais. Os outros argumentos são definidos como @code{NULL}.
@end deffn

@geindex PyEval_EvalCodeEx (C function)
@anchor{c-api/veryhigh c PyEval_EvalCodeEx}@anchor{1862}
@deffn {C Função} @ref{339,,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)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Avalia um objeto código pré-compilado, dado um ambiente particular para sua avaliação. Este ambiente consiste em um dicionário de variáveis globais, um objeto mapeamento de variáveis locais, vetores de argumentos, nomeados e padrões, um dicionário de valores padrões para argumentos @ref{2a5,,somente-nomeados} e uma tupla de clausura de células.
@end deffn

@geindex PyEval_EvalFrame (C function)
@anchor{c-api/veryhigh c PyEval_EvalFrame}@anchor{4c74}
@deffn {C Função} @ref{339,,PyObject} *PyEval_EvalFrame (PyFrameObject *f)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Avalia um quadro de execução. Esta é uma interface simplificada para @ref{1066,,PyEval_EvalFrameEx()}, para retrocompatibilidade.
@end deffn

@geindex PyEval_EvalFrameEx (C function)
@anchor{c-api/veryhigh c PyEval_EvalFrameEx}@anchor{1066}
@deffn {C Função} @ref{339,,PyObject} *PyEval_EvalFrameEx (PyFrameObject *f, int throwflag)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Esta é a função principal e sem retoques da interpretação Python. O objeto código associado ao quadro de execução `f' é executado, interpretando bytecode e executando chamadas conforme necessário. O parâmetro adicional `throwflag' pode ser ignorado na maioria das vezes - se verdadeiro, ele faz com que uma exceção seja levantada imediatamente; isso é usado para os métodos @ref{4f8,,throw()} de objetos geradores.


Alterado na versão 3.4: Essa função agora inclui uma asserção de depuração para ajudar a garantir que ela não descarte silenciosamente uma exceção ativa.

@end deffn

@geindex PyEval_MergeCompilerFlags (C function)
@anchor{c-api/veryhigh c PyEval_MergeCompilerFlags}@anchor{4e6e}
@deffn {C Função} int PyEval_MergeCompilerFlags (PyCompilerFlags *cf)

Esta função altera os sinalizadores do quadro de avaliação atual e retorna verdadeiro em caso de sucesso e falso em caso de falha.
@end deffn

@geindex PyCompilerFlags (C struct)
@anchor{c-api/veryhigh c PyCompilerFlags}@anchor{ab0}
@deffn {C Struct} struct PyCompilerFlags

Esta é a estrutura usada para manter os sinalizadores do compilador. Em casos onde o código está apenas sendo compilado, ele é passado como @code{int flags}, e em casos onde o código está sendo executado, ele é passado como @code{PyCompilerFlags *flags}. Neste caso, @code{from __future__ import} pode modificar `flags'.

Sempre que @code{PyCompilerFlags *flags} for @code{NULL}, @ref{4e6f,,cf_flags} é tratado como igual a @code{0}, e qualquer modificação devido a @code{from __future__ import} é descartada.

@geindex PyCompilerFlags.cf_flags (C member)
@anchor{c-api/veryhigh c PyCompilerFlags cf_flags}@anchor{4e6f}
@deffn {C Membro} int cf_flags

Sinalizadores do compilador.
@end deffn

@geindex PyCompilerFlags.cf_feature_version (C member)
@anchor{c-api/veryhigh c PyCompilerFlags cf_feature_version}@anchor{4e70}
@deffn {C Membro} int cf_feature_version

`cf_feature_version' é a versão secundária do Python. Deve ser inicializada como @code{PY_MINOR_VERSION}.

O campo é ignorado por padrão, ele é usado se e somente se o sinalizador @code{PyCF_ONLY_AST} estiver definido em @ref{4e6f,,cf_flags}.
@end deffn


Alterado na versão 3.8: Adicionado campo `cf_feature_version'.


Os sinalizadores do compilador disponíveis são acessíveis como macros:

@geindex PyCF_ALLOW_TOP_LEVEL_AWAIT (C macro)
@geindex PyCF_ONLY_AST (C macro)
@geindex PyCF_OPTIMIZED_AST (C macro)
@geindex PyCF_TYPE_COMMENTS (C macro)
@anchor{c-api/veryhigh c PyCF_ALLOW_TOP_LEVEL_AWAIT}@anchor{4e71}
@deffn {C Macro} PyCF_ALLOW_TOP_LEVEL_AWAIT
@anchor{c-api/veryhigh c PyCF_ONLY_AST}@anchor{4e72}
@deffnx {C Macro} PyCF_ONLY_AST
@anchor{c-api/veryhigh c PyCF_OPTIMIZED_AST}@anchor{4e73}
@deffnx {C Macro} PyCF_OPTIMIZED_AST
@anchor{c-api/veryhigh c PyCF_TYPE_COMMENTS}@anchor{4e74}
@deffnx {C Macro} PyCF_TYPE_COMMENTS

Veja @ref{22fc,,sinalizadores do compilador} na documentação do módulo Python @code{ast}, que exporta essas constantes com os mesmos nomes.
@end deffn

Os sinalizadores “@code{PyCF}” acima podem ser combinados com sinalizadores “@code{CO_FUTURE}”, como @ref{4e75,,CO_FUTURE_ANNOTATIONS}, para habilitar recursos normalmente selecionáveis usando @ref{189,,instruções future}. Consulte @ref{4e76,,Sinalizadores de objetos código} para obter uma lista completa.
@end deffn

@menu
* Símbolos iniciais disponíveis:: 
* Stack Effects:: 

@end menu

@node Símbolos iniciais disponíveis,Stack Effects,,A camada de nível muito alto
@anchor{c-api/veryhigh available-start-symbols}@anchor{4e77}@anchor{c-api/veryhigh start-symbols}@anchor{4e66}
@subsection Símbolos iniciais disponíveis


@geindex Py_eval_input (C var)
@anchor{c-api/veryhigh c Py_eval_input}@anchor{4e56}
@deffn {C Variável} int Py_eval_input

@geindex Py_CompileString (função C)

O símbolo inicial da gramática Python para expressões isoladas; para uso com @ref{889,,Py_CompileString()}.
@end deffn

@geindex Py_file_input (C var)
@anchor{c-api/veryhigh c Py_file_input}@anchor{4e57}
@deffn {C Variável} int Py_file_input

@geindex Py_CompileString (função C)

O símbolo de início da gramática Python para sequências de instruções conforme lidas de um arquivo ou outra fonte; para uso com @ref{889,,Py_CompileString()}. Este é o símbolo a ser usado ao compilar código-fonte Python arbitrariamente longo.
@end deffn

@geindex Py_single_input (C var)
@anchor{c-api/veryhigh c Py_single_input}@anchor{4e58}
@deffn {C Variável} int Py_single_input

@geindex Py_CompileString (função C)

O símbolo de início da gramática Python para uma única declaração; para uso com @ref{889,,Py_CompileString()}. Este é o símbolo usado para o laço do interpretador interativo.
@end deffn

@geindex Py_func_type_input (C var)
@anchor{c-api/veryhigh c Py_func_type_input}@anchor{4e59}
@deffn {C Variável} int Py_func_type_input

@geindex Py_CompileString (função C)

O símbolo inicial da gramática Python para um tipo de função; para uso com @ref{889,,Py_CompileString()}. É usado para analisar “comentários de tipo de assinatura” de 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}.

Isso requer que o sinalizador @ref{4e72,,PyCF_ONLY_AST} seja definido.


@subsubheading Ver também



@itemize *

@item 
@ref{4805,,ast.FunctionType}

@item 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}
@end itemize



Adicionado na versão 3.8.

@end deffn

@node Stack Effects,,Símbolos iniciais disponíveis,A camada de nível muito alto
@anchor{c-api/veryhigh stack-effects}@anchor{4e78}
@subsection Stack Effects



@subsubheading Ver também


@ref{f64,,dis.stack_effect()}


@geindex PY_INVALID_STACK_EFFECT (C macro)
@anchor{c-api/veryhigh c PY_INVALID_STACK_EFFECT}@anchor{4e79}
@deffn {C Macro} PY_INVALID_STACK_EFFECT

Sentinel value representing an invalid stack effect.

This is currently equivalent to @code{INT_MAX}.


Adicionado na versão 3.8.

@end deffn

@geindex PyCompile_OpcodeStackEffect (C function)
@anchor{c-api/veryhigh c PyCompile_OpcodeStackEffect}@anchor{4e7a}
@deffn {C Função} int PyCompile_OpcodeStackEffect (int opcode, int oparg)

Calcula o efeito que o `opcode' com argumento `oparg' tem na pilha.

On success, this function returns the stack effect; on failure, this
returns @ref{4e79,,PY_INVALID_STACK_EFFECT}.


Adicionado na versão 3.4.

@end deffn

@geindex PyCompile_OpcodeStackEffectWithJump (C function)
@anchor{c-api/veryhigh c PyCompile_OpcodeStackEffectWithJump}@anchor{1bcb}
@deffn {C Função} int PyCompile_OpcodeStackEffectWithJump (int opcode, int oparg, int jump)

Similar to @ref{4e7a,,PyCompile_OpcodeStackEffect()}, but don’t include the
stack effect of jumping if `jump' is zero.

If `jump' is @code{0}, this will not include the stack effect of jumping, but
if `jump' is @code{1} or @code{-1}, this will include it.

On success, this function returns the stack effect; on failure, this
returns @ref{4e79,,PY_INVALID_STACK_EFFECT}.


Adicionado na versão 3.8.

@end deffn

@node Contagem de referências,Tratamento de exceções<2>,A camada de nível muito alto,Manual de referência da API Python/C
@anchor{c-api/refcounting doc}@anchor{4e7b}@anchor{c-api/refcounting countingrefs}@anchor{4e7c}@anchor{c-api/refcounting reference-counting}@anchor{4e7d}@anchor{c-api/refcounting translation-repo}@anchor{4e7e}
@section Contagem de referências


As funções e macros nesta sessão são usadas para o gerenciamento de contagem de referências de objetos Python.

@geindex Py_REFCNT (C function)
@anchor{c-api/refcounting c Py_REFCNT}@anchor{8ae}
@deffn {C Função} @ref{a69,,Py_ssize_t} Py_REFCNT (PyObject *o)

Obtêm a contagem de referências do objeto Python `o'.

Observe que o valor retornado pode não refletir realmente quantas referências ao objeto são realmente mantidas. Por exemplo, alguns objetos são @ref{45bb,,imortais} e têm uma contagem de referências muito alta, que não reflete o número real de referências. Consequentemente, não confie no valor retornado para ser preciso, exceto um valor de 0 ou 1.

Use a função @ref{8af,,Py_SET_REFCNT()} para definir uma contagem de referências de um objeto.


Alterado na versão 3.10: @ref{8ae,,Py_REFCNT()} is changed to the inline static function.



Alterado na versão 3.11: The parameter type is no longer const @ref{339,,PyObject}*.

@end deffn

@geindex Py_SET_REFCNT (C function)
@anchor{c-api/refcounting c Py_SET_REFCNT}@anchor{8af}
@deffn {C Função} void Py_SET_REFCNT (PyObject *o, Py_ssize_t refcnt)

Set the object `o' reference counter to `refcnt'.

Em uma @ref{1f00,,construção do Python com threads threads livres}, se `refcnt' for maior que @code{UINT32_MAX}, o objeto será transformado em @ref{45bb,,imortal}.

Esta função não tem efeito sobre objetos @ref{45bb,,imortais}.


Adicionado na versão 3.9.



Alterado na versão 3.12: Os objetos imortais não são modificados.

@end deffn

@geindex Py_INCREF (C function)
@anchor{c-api/refcounting c Py_INCREF}@anchor{56e}
@deffn {C Função} void Py_INCREF (PyObject *o)

Indicate taking a new @ref{33d,,strong reference} to object `o',
indicating it is in use and should not be destroyed.

Esta função não tem efeito sobre objetos @ref{45bb,,imortais}.

Esta função é geralmente usada para transformar uma @ref{33e,,referência emprestada} em uma @ref{33d,,referência forte} local. A função @ref{89e,,Py_NewRef()} pode ser usada para criar uma nova @ref{33d,,referência forte}.

When done using the object, release is by calling @ref{56f,,Py_DECREF()}.

The object must not be @code{NULL}; if you aren’t sure that it isn’t
@code{NULL}, use @ref{a6e,,Py_XINCREF()}.

Do not expect this function to actually modify `o' in any way.
For at least 
@geindex Propostas de Melhorias do Python; PEP 0683
some objects@footnote{https://peps.python.org/pep-0683/},
this function has no effect.


Alterado na versão 3.12: Os objetos imortais não são modificados.

@end deffn

@geindex Py_XINCREF (C function)
@anchor{c-api/refcounting c Py_XINCREF}@anchor{a6e}
@deffn {C Função} void Py_XINCREF (PyObject *o)

Semelhante a @ref{56e,,Py_INCREF()}, mas o objeto `o' pode ser @code{NULL}, caso em que isso não tem efeito.

Veja também @ref{89f,,Py_XNewRef()}.
@end deffn

@geindex Py_NewRef (C function)
@anchor{c-api/refcounting c Py_NewRef}@anchor{89e}
@deffn {C Função} @ref{339,,PyObject} *Py_NewRef (PyObject *o)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Create a new @ref{33d,,strong reference} to an object:
call @ref{56e,,Py_INCREF()} on `o' and return the object `o'.

When the @ref{33d,,strong reference} is no longer needed, @ref{56f,,Py_DECREF()}
should be called on it to release the reference.

The object `o' must not be @code{NULL}; use @ref{89f,,Py_XNewRef()} if `o' can be
@code{NULL}.

Por exemplo:

@example
Py_INCREF(obj);
self->attr = obj;
@end example

can be written as:

@example
self->attr = Py_NewRef(obj);
@end example

See also @ref{56e,,Py_INCREF()}.


Adicionado na versão 3.10.

@end deffn

@geindex Py_XNewRef (C function)
@anchor{c-api/refcounting c Py_XNewRef}@anchor{89f}
@deffn {C Função} @ref{339,,PyObject} *Py_XNewRef (PyObject *o)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Semelhante a @ref{89e,,Py_NewRef()}, mas o objeto `o' pode ser NULL.

Se o objeto `o' é @code{NULL}, a função apenas retorna @code{NULL}.


Adicionado na versão 3.10.

@end deffn

@geindex Py_DECREF (C function)
@anchor{c-api/refcounting c Py_DECREF}@anchor{56f}
@deffn {C Função} void Py_DECREF (PyObject *o)

Release a @ref{33d,,strong reference} to object `o', indicating the
reference is no longer used.

Esta função não tem efeito sobre objetos @ref{45bb,,imortais}.

Once the last @ref{33d,,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.

This function is usually used to delete a @ref{33d,,strong reference} before
exiting its scope.

The object must not be @code{NULL}; if you aren’t sure that it isn’t @code{NULL},
use @ref{78f,,Py_XDECREF()}.

Do not expect this function to actually modify `o' in any way.
For at least 
@geindex Propostas de Melhorias do Python; PEP 683
some objects@footnote{https://peps.python.org/pep-0683/},
this function has no effect.

@cartouche
@quotation Aviso 
The deallocation function can cause arbitrary Python code to be invoked (e.g.
when a class instance with a @ref{1033,,__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{56f,,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{56f,,Py_DECREF()} for the temporary variable.
@end quotation
@end cartouche


Alterado na versão 3.12: Os objetos imortais não são modificados.

@end deffn

@geindex Py_XDECREF (C function)
@anchor{c-api/refcounting c Py_XDECREF}@anchor{78f}
@deffn {C Função} void Py_XDECREF (PyObject *o)

Similar to @ref{56f,,Py_DECREF()}, but the object `o' can be @code{NULL},
in which case this has no effect.
The same warning from @ref{56f,,Py_DECREF()} applies here as well.
@end deffn

@geindex Py_CLEAR (C function)
@anchor{c-api/refcounting c Py_CLEAR}@anchor{578}
@deffn {C Função} void Py_CLEAR (PyObject *o)

Release a @ref{33d,,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{56f,,Py_DECREF()}, except that the argument is also set to @code{NULL}.  The warning
for @ref{56f,,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.


Alterado na versão 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{4dc9}
@deffn {C Função} void Py_IncRef (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Indicate taking a new @ref{33d,,strong reference} to object `o'.
A function version of @ref{a6e,,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{4dc1}
@deffn {C Função} void Py_DecRef (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Release a @ref{33d,,strong reference} to object `o'.
A function version of @ref{78f,,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{579}
@deffn {C Macro} Py_SETREF (dst, src)

Macro safely releasing a @ref{33d,,strong reference} to object `dst'
and setting `dst' to `src'.

As in case of @ref{578,,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.


Adicionado na versão 3.6.



Alterado na versão 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{57a}
@deffn {C Macro} Py_XSETREF (dst, src)

Variant of @ref{579,,Py_SETREF} macro that uses @ref{78f,,Py_XDECREF()} instead
of @ref{56f,,Py_DECREF()}.


Adicionado na versão 3.6.



Alterado na versão 3.12: The macro arguments are now only evaluated once. If an argument has side
effects, these are no longer duplicated.

@end deffn

@node Tratamento de exceções<2>,Utilitários<2>,Contagem de referências,Manual de referência da API Python/C
@anchor{c-api/exceptions doc}@anchor{4e7f}@anchor{c-api/exceptions exception-handling}@anchor{4e80}@anchor{c-api/exceptions exceptionhandling}@anchor{462c}@anchor{c-api/exceptions translation-repo}@anchor{4e81}
@section Tratamento de exceções


As funções descritas nesse capítulo permitem você tratar e gerar exceções em Python. É importante entender alguns princípios básicos no tratamento de exceções no Python. Funciona de forma parecida com a variável POSIX @code{errno}: existe um indicador global (por thread) do último erro ocorrido. A maioria das funções da API C não o zera ao obter sucesso, mas o define para indicar a causa do erro ao falhar. A maioria das funções da API retorna um indicador de erro, geralmente, @code{NULL} se eles devem retornar um ponteiro, ou @code{-1} se retornarem um inteiro (exceção: as funções @code{PyArg_*} retornam @code{1} para sucesso e @code{0} para falha).

De forma concreta, o indicador de erro consiste em três ponteiros de objeto: o tipo da exceção, o valor da exceção e o objeto de traceback. Qualquer um desses ponteiros pode ser @code{NULL} se não definido (embora algumas combinações sejam proibidas, por exemplo, você não pode ter um retorno não @code{NULL} se o tipo de exceção for @code{NULL}).

Quando uma função deve falhar porque devido à falha de alguma função que ela chamou, ela geralmente não define o indicador de erro; a função que ela chamou já o definiu. Ela é responsável por manipular o erro e limpar a exceção ou retornar após limpar todos os recursos que possui (como referências a objetos ou alocações de memória); ela `não' deve continuar normalmente se não estiver preparada para lidar com o erro. Se estiver retornando devido a um erro, é importante indicar ao chamador que um erro foi definido. Se o erro não for manipulado ou propagado com cuidado, chamadas adicionais para a API Python/C podem não se comportar conforme o esperado e podem falhar de maneiras misteriosas.

@cartouche
@quotation Nota 
O indicador de erro `não' é resultado de @ref{68a,,sys.exc_info()}. O primeiro corresponde a uma exceção que ainda não foi capturada (e, portanto, ainda está se propagando), enquanto o segundo retorna uma exceção após ser capturada (e, portanto, parou de se propagar).
@end quotation
@end cartouche

@menu
* Impressão e limpeza:: 
* Levantando exceções: Levantando exceções<2>. 
* Emitindo avisos:: 
* Consultando o indicador de erro:: 
* Tratamento de sinal: Tratamento de sinal<2>. 
* Classes de exceção:: 
* Objeto Exceção:: 
* Objetos de exceção Unicode:: 
* Controle de recursão:: 
* Exception and warning types:: 
* Tracebacks:: 

@end menu

@node Impressão e limpeza,Levantando exceções<2>,,Tratamento de exceções<2>
@anchor{c-api/exceptions printing-and-clearing}@anchor{4e82}
@subsection Impressão e limpeza


@geindex PyErr_Clear (C function)
@anchor{c-api/exceptions c PyErr_Clear}@anchor{1069}
@deffn {C Função} void PyErr_Clear ()
` Parte da @ref{553,,ABI Estável}.'
Limpe o indicador de erro. Se o indicador de erro não estiver definido, não haverá efeito.
@end deffn

@geindex PyErr_PrintEx (C function)
@anchor{c-api/exceptions c PyErr_PrintEx}@anchor{4c67}
@deffn {C Função} void PyErr_PrintEx (int set_sys_last_vars)
` Parte da @ref{553,,ABI Estável}.'
Exibe um traceback padrão para @code{sys.stderr} e limpe o indicador de erro. `A menos que' o erro seja um @code{SystemExit}, nesse caso, nenhum traceback será impresso e o processo Python será encerrado com o código de erro especificado pela instância @code{SystemExit}.

Chame esta função `apenas' quando o indicador de erro estiver definido. Caso contrário, causará um erro fatal!

Se `set_sys_last_vars' for diferente de zero, a variável @ref{4be,,sys.last_exc} será definida com a exceção exibida. Para manter a retrocompatibilidade, as variáveis descontinuadas @ref{4bf,,sys.last_type}, @ref{4c0,,sys.last_value} e @ref{4c1,,sys.last_traceback} também serão definidas com o tipo, valor e traceback dessa exceção, respectivamente.


Alterado na versão 3.12: A configuração de @ref{4be,,sys.last_exc} foi adicionada.

@end deffn

@geindex PyErr_Print (C function)
@anchor{c-api/exceptions c PyErr_Print}@anchor{1ab9}
@deffn {C Função} void PyErr_Print ()
` Parte da @ref{553,,ABI Estável}.'
Apelido para @code{PyErr_PrintEx(1)}.
@end deffn

@geindex PyErr_WriteUnraisable (C function)
@anchor{c-api/exceptions c PyErr_WriteUnraisable}@anchor{34d}
@deffn {C Função} void PyErr_WriteUnraisable (PyObject *obj)
` Parte da @ref{553,,ABI Estável}.'
Chama @ref{1f7,,sys.unraisablehook()} usando a exceção atual e o argumento `obj'.

Esta função utilitária imprime uma mensagem de aviso para @code{sys.stderr} quando uma exceção foi definida, mas é impossível para o interpretador realmente gerar a exceção. É usada, por exemplo, quando ocorre uma exceção em um método @ref{1033,,__del__()}.

A função é chamada com um único argumento `obj' que identifica o contexto em que ocorreu a exceção não gerável. Se possível, o repr de `obj' será impresso na mensagem de aviso. Se `obj' for @code{NULL}, apenas o traceback será impresso.

Uma exceção deve ser definida ao chamar essa função.


Alterado na versão 3.4: Exibe o traceback (situação da pilha de execução). Exibe apenas o traceback se `obj' for @code{NULL}.



Alterado na versão 3.8: Utiliza @ref{1f7,,sys.unraisablehook()}.

@end deffn

@geindex PyErr_FormatUnraisable (C function)
@anchor{c-api/exceptions c PyErr_FormatUnraisable}@anchor{34c}
@deffn {C Função} void PyErr_FormatUnraisable (const char *format, ...)

Similar a @ref{34d,,PyErr_WriteUnraisable()}, mas `format' e parâmetros subsequentes ajudam a formatar a mensagem de aviso; eles têm o mesmo significado e valores que em @ref{38a,,PyUnicode_FromFormat()}. @code{PyErr_WriteUnraisable(obj)} é aproximadamente equivalente à @code{PyErr_FormatUnraisable("Exception ignored in: %R", obj)}. Se `format' é @code{NULL}, somente o rastreamento é impresso.


Adicionado na versão 3.13.

@end deffn

@geindex PyErr_DisplayException (C function)
@anchor{c-api/exceptions c PyErr_DisplayException}@anchor{402}
@deffn {C Função} void PyErr_DisplayException (PyObject *exc)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Imprime a exibição padrão do traceback de @code{exc} em @code{sys.stderr}, incluindo as exceções encadeadas e notas.


Adicionado na versão 3.12.

@end deffn

@node Levantando exceções<2>,Emitindo avisos,Impressão e limpeza,Tratamento de exceções<2>
@anchor{c-api/exceptions raising-exceptions}@anchor{4e83}
@subsection Levantando exceções


Essas funções ajudam a definir o indicador de erro do thread. Por conveniência, algumas dessas funções sempre retornam um ponteiro @code{NULL} ao usar instrução com @code{return}.

@geindex PyErr_SetString (C function)
@anchor{c-api/exceptions c PyErr_SetString}@anchor{57c}
@deffn {C Função} void PyErr_SetString (PyObject *type, const char *message)
` Parte da @ref{553,,ABI Estável}.'
Esse é o modo mais comum de definir o indicador de erro. O primeiro argumento especifica o tipo da exceção; é normalmente uma das exceções padrão, como @ref{4ca5,,PyExc_RuntimeError}.  Você não precisa criar um novo @ref{33d,,strong reference} para ela (como em @ref{56e,,Py_INCREF()}). O segundo argumento é uma mensagem de erro; ela é codificada com @code{'utf-8'}.
@end deffn

@geindex PyErr_SetObject (C function)
@anchor{c-api/exceptions c PyErr_SetObject}@anchor{57b}
@deffn {C Função} void PyErr_SetObject (PyObject *type, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Essa função é semelhante à @ref{57c,,PyErr_SetString()} mas permite especificar um objeto Python arbitrário para o valor da exceção.
@end deffn

@geindex PyErr_Format (C function)
@anchor{c-api/exceptions c PyErr_Format}@anchor{ee0}
@deffn {C Função} @ref{339,,PyObject} *PyErr_Format (PyObject *exception, const char *format, ...)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
Essa função define o indicador de erro e retorna @code{NULL}. `exception' deve ser uma classe Python de exceção. O `format' e parâmetros subsequentes ajudam a formatar a mensagem de erro; eles têm o mesmo significado e valores que em @ref{38a,,PyUnicode_FromFormat()}. `format' é uma string codificada em ASCII.
@end deffn

@geindex PyErr_FormatV (C function)
@anchor{c-api/exceptions c PyErr_FormatV}@anchor{edf}
@deffn {C Função} @ref{339,,PyObject} *PyErr_FormatV (PyObject *exception, const char *format, va_list vargs)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} desde a versão 3.5.'
Igual a @ref{ee0,,PyErr_Format()}, mas usando o argumento @code{va_list} em vez de um número variável de argumentos.


Adicionado na versão 3.5.

@end deffn

@geindex PyErr_SetNone (C function)
@anchor{c-api/exceptions c PyErr_SetNone}@anchor{4c70}
@deffn {C Função} void PyErr_SetNone (PyObject *type)
` Parte da @ref{553,,ABI Estável}.'
Isso é uma abreviação para @code{PyErr_SetObject(type, Py_None)}.
@end deffn

@geindex PyErr_BadArgument (C function)
@anchor{c-api/exceptions c PyErr_BadArgument}@anchor{4c64}
@deffn {C Função} int PyErr_BadArgument ()
` Parte da @ref{553,,ABI Estável}.'
Essa é uma abreviação de @code{PyErr_SetString(PyExc_TypeError, message)}, na qual `message' indica que uma operação embutida foi invocada com um argumento ilegal. Ela é principalmente para uso interno.
@end deffn

@geindex PyErr_NoMemory (C function)
@anchor{c-api/exceptions c PyErr_NoMemory}@anchor{4b42}
@deffn {C Função} @ref{339,,PyObject} *PyErr_NoMemory ()
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
Essa é uma abreviação para @code{PyErr_SetNone(PyExc_MemoryError)}; que retorna @code{NULL}  para que uma função de alocação de objeto possa escrever @code{return PyErr_NoMemory();}  quando ficar sem memória.
@end deffn

@geindex PyErr_SetFromErrno (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrno}@anchor{4b41}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromErrno (PyObject *type)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
@geindex strerror (C function)

Esta é uma função conveniente para levantar uma exceção quando uma função da biblioteca C retornou um erro e definir a variável C @code{errno}. Ela constrói um objeto tupla cujo primeiro item é o valor inteiro @code{errno} e cujo segundo item é a mensagem de erro correspondente (obtida de @code{strerror()}), e então chama @code{PyErr_SetObject(type, object)}. No Unix, quando o valor @code{errno} é @code{EINTR}, indicando uma chamada de sistema interrompida, isso chama @ref{467,,PyErr_CheckSignals()}, e se isso definir o indicador de erro, deixa-o definido como tal. A função retorna sempre @code{NULL}, de forma que uma função que envolve uma chamada de sistema pode retornar @code{return PyErr_SetFromErrno(type);} quando a chamada de sistema retornar um erro.
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObject (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObject}@anchor{4c6c}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromErrnoWithFilenameObject (PyObject *type, PyObject *filenameObject)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
Similar à @ref{4b41,,PyErr_SetFromErrno()}, com o comportamento adicional de que, se `filenameObject' não é @code{NULL}, ele é passado para o construtor de `type' como um terceiro parâmetro. No caso da exceção @ref{417,,OSError}, isso é usado para definir o atributo @code{filename} da instância da exceção.
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObjects (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObjects}@anchor{4c6d}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromErrnoWithFilenameObjects (PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Similar à @ref{4c6c,,PyErr_SetFromErrnoWithFilenameObject()}, mas recebe um segundo objeto filename, para levantar erros quando uma função que recebe dois nomes de arquivos falha.


Adicionado na versão 3.4.

@end deffn

@geindex PyErr_SetFromErrnoWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilename}@anchor{1807}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromErrnoWithFilename (PyObject *type, const char *filename)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
Similar à @ref{4c6c,,PyErr_SetFromErrnoWithFilenameObject()}, mas o nome do arquivo é fornecido como uma string C. `filename' é decodificado do @ref{53b,,filesystem encoding and error handler}.
@end deffn

@geindex PyErr_SetFromWindowsErr (C function)
@anchor{c-api/exceptions c PyErr_SetFromWindowsErr}@anchor{4c6e}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromWindowsErr (int ierr)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Essa é uma função conveniente para levantar @ref{417,,OSError}. Se chamada com `ierr' de @code{0}, o código de erro retornado por uma chamada para @code{GetLastError()} é usado instantaneamente. Ela chama a função Win32 @code{FormatMessage()} para retornar a descrição Windows do código de erro dado por `ierr' ou @code{GetLastError()}, e então constrói um objeto @ref{417,,OSError} com o atributo @ref{2425,,winerror} definido para o código de erro, o atributo @ref{2426,,strerror} definido para a mensagem de erro correspondente (lida de @code{FormatMessage()}), e então chama @code{PyErr_SetObject(PyExc_OSError, object)}. Essa função sempre retorna @code{NULL}.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErr (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErr}@anchor{4c69}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetExcFromWindowsErr (PyObject *type, int ierr)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Semelhante a @ref{4c6e,,PyErr_SetFromWindowsErr()}, com um parâmetro adicional que especifica o tipo de exceção a ser levantada.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex PyErr_SetFromWindowsErrWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetFromWindowsErrWithFilename}@anchor{1809}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetFromWindowsErrWithFilename (int ierr, const char *filename)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Semelhante a @ref{4c6e,,PyErr_SetFromWindowsErr()}, com o comportamento adicional de que, se `filename' não for @code{NULL}, ele é decodificado a partir da codificação do sistema de arquivos (@ref{c6f,,os.fsdecode()}) e passado para o construtor de @ref{417,,OSError} como um terceiro parâmetro a ser usado para definir o atributo @code{filename} da instância da exceção.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObject (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObject}@anchor{4c6a}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObject (PyObject *type, int ierr, PyObject *filename)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Semelhante a @ref{4c69,,PyErr_SetExcFromWindowsErr()}, com o comportamento adicional de que, se `filename' não for @code{NULL}, ele é passado para o construtor de @ref{417,,OSError} como um terceiro parâmetro a ser usado para definir o atributo @code{filename} da instância da exceção.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObjects (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObjects}@anchor{4c6b}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObjects (PyObject *type, int ierr, PyObject *filename, PyObject *filename2)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Similar à @ref{4c6a,,PyErr_SetExcFromWindowsErrWithFilenameObject()}, mas aceita um segundo caminho do objeto.

@ref{1ed8,,Disponibilidade}: Windows.


Adicionado na versão 3.4.

@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilename (C function)
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilename}@anchor{1808}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetExcFromWindowsErrWithFilename (PyObject *type, int ierr, const char *filename)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Similar à @ref{1809,,PyErr_SetFromWindowsErrWithFilename()}, com um parâmetro adicional especificando o tipo de exceção a ser gerado.

@ref{1ed8,,Disponibilidade}: Windows.
@end deffn

@geindex PyErr_SetImportError (C function)
@anchor{c-api/exceptions c PyErr_SetImportError}@anchor{d60}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetImportError (PyObject *msg, PyObject *name, PyObject *path)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Essa é uma função conveniente para levantar @ref{419,,ImportError}. `msg' será definido como a string da mensagem de exceção. `name' e `path', ambos os quais podem ser @code{NULL}, serão definidos como, respectivamente, os atributos @code{name} e @code{path} de @ref{419,,ImportError}.


Adicionado na versão 3.3.

@end deffn

@geindex PyErr_SetImportErrorSubclass (C function)
@anchor{c-api/exceptions c PyErr_SetImportErrorSubclass}@anchor{d38}
@deffn {C Função} @ref{339,,PyObject} *PyErr_SetImportErrorSubclass (PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável} desde a versão 3.6.'
Muito parecido com @ref{d60,,PyErr_SetImportError()} mas a função permite especificar uma subclasse de @ref{419,,ImportError} para levantar uma exceção.


Adicionado na versão 3.6.

@end deffn

@geindex PyErr_SyntaxLocationObject (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocationObject}@anchor{4e84}
@deffn {C Função} void PyErr_SyntaxLocationObject (PyObject *filename, int lineno, int col_offset)

Define informações de arquivo, linha e deslocamento para a atual exceção. Se a exceção não é @ref{18d,,SyntaxError}, define atributos adicionais, os quais fazem o subsistema de impressão de exceções pensar que trata-se de um @ref{18d,,SyntaxError}.


Adicionado na versão 3.4.

@end deffn

@geindex PyErr_RangedSyntaxLocationObject (C function)
@anchor{c-api/exceptions c PyErr_RangedSyntaxLocationObject}@anchor{4e85}
@deffn {C Função} void PyErr_RangedSyntaxLocationObject (PyObject *filename, int lineno, int col_offset, int end_lineno, int end_col_offset)

Similar a @ref{4e84,,PyErr_SyntaxLocationObject()}, mas também define as informações `end_lineno' e `end_col_offset' para a exceção atual.


Adicionado na versão 3.10.

@end deffn

@geindex PyErr_SyntaxLocationEx (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocationEx}@anchor{4c72}
@deffn {C Função} void PyErr_SyntaxLocationEx (const char *filename, int lineno, int col_offset)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Como @ref{4e84,,PyErr_SyntaxLocationObject()}, mas `filename' é uma bytestring descodificada a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}.


Adicionado na versão 3.2.

@end deffn

@geindex PyErr_SyntaxLocation (C function)
@anchor{c-api/exceptions c PyErr_SyntaxLocation}@anchor{4c71}
@deffn {C Função} void PyErr_SyntaxLocation (const char *filename, int lineno)
` Parte da @ref{553,,ABI Estável}.'
Como @ref{4c72,,PyErr_SyntaxLocationEx()}, mas o parâmetro `col_offset' é omitido.
@end deffn

@geindex PyErr_BadInternalCall (C function)
@anchor{c-api/exceptions c PyErr_BadInternalCall}@anchor{4c65}
@deffn {C Função} void PyErr_BadInternalCall ()
` Parte da @ref{553,,ABI Estável}.'
Essa é uma abreviação de @code{PyErr_SetString(PyExc_SystemError, message)}, onde `message' indica que uma operação interna (por exemplo, uma função API C/Python) foi invocada com um argumento ilegal. Ela é principalmente para uso interno.
@end deffn

@geindex PyErr_ProgramTextObject (C function)
@anchor{c-api/exceptions c PyErr_ProgramTextObject}@anchor{4e86}
@deffn {C Função} @ref{339,,PyObject} *PyErr_ProgramTextObject (PyObject *filename, int lineno)

Obtém a linha de código-fonte em `filename' na linha `lineno'. `filename' deve ser um objeto @ref{44c,,str} Python.

Em caso de sucesso, esta função retorna um objeto string do Python com a linha encontrada. Em caso de falha, esta função retorna @code{NULL} sem definir uma exceção.
@end deffn

@geindex PyErr_ProgramText (C function)
@anchor{c-api/exceptions c PyErr_ProgramText}@anchor{4c68}
@deffn {C Função} @ref{339,,PyObject} *PyErr_ProgramText (const char *filename, int lineno)
` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{4e86,,PyErr_ProgramTextObject()}, mas `filename' é um const char*, que é decodificado com @ref{53b,,tratador de erros e codificação do sistema de arquivos}, em vez de uma referência de objeto Python.
@end deffn

@node Emitindo avisos,Consultando o indicador de erro,Levantando exceções<2>,Tratamento de exceções<2>
@anchor{c-api/exceptions issuing-warnings}@anchor{4e87}
@subsection Emitindo avisos


Use essas funções para emitir avisos a partir de código C. Elas espelham funções semelhantes exportadas pelo módulo @ref{112,,warnings} do Python. Normalmente, elas exibem uma mensagem de aviso em `sys.stderr'; no entanto, também é possível que o usuário tenha especificado que os avisos devem ser transformados em erros, e nesse caso, uma exceção será lançada. Também é possível que as funções levantem uma exceção devido a um problema com o mecanismo de avisos. O valor de retorno é @code{0} se nenhuma exceção for lançada, ou @code{-1} se uma exceção for lançada. (Não é possível determinar se uma mensagem de aviso é realmente impressa, nem qual é o motivo da exceção; isso é intencional.) Se uma exceção for levantada, a função que chamou a função deve realizar seu tratamento de exceções normal (por exemplo, liberar as referências pertencentes a @ref{56f,,Py_DECREF()} e retornar um valor de erro).

@geindex PyErr_WarnEx (C function)
@anchor{c-api/exceptions c PyErr_WarnEx}@anchor{1494}
@deffn {C Função} int PyErr_WarnEx (PyObject *category, const char *message, Py_ssize_t stack_level)
` Parte da @ref{553,,ABI Estável}.'
Emite uma mensagem de aviso. O argumento `category' é uma categoria de aviso (veja abaixo) ou @code{NULL}; o argumento `message' é uma string codificada em UTF-8. `stack_level' é um número positivo que indica o número de quadros da pilha; o aviso será emitido a partir da linha de código atualmente em execução nesse quadro da pilha. Um `stack_level' de 1 é a função que chama @ref{1494,,PyErr_WarnEx()}, 2 é a função acima dessa e assim por diante.

As categorias de aviso devem ser subclasses de @ref{4cb6,,PyExc_Warning}; @ref{4cb6,,PyExc_Warning} é uma subclasse de @ref{4c8a,,PyExc_Exception}; a categoria de aviso padrão é @ref{4ca6,,PyExc_RuntimeWarning}. As categorias de aviso padrão do Python estão disponíveis como variáveis globais cujos nomes estão enumerados em @ref{4e88,,Warning types}.

Para obter informações sobre o controle de avisos, consulte a documentação do módulo @ref{112,,warnings} e a opção @ref{8cd,,-W} na documentação da linha de comando. Não existe uma API C para o controle de avisos.
@end deffn

@geindex PyErr_WarnExplicitObject (C function)
@anchor{c-api/exceptions c PyErr_WarnExplicitObject}@anchor{4e89}
@deffn {C Função} int PyErr_WarnExplicitObject (PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)

Emite uma mensagem de aviso com controle explícito sobre todos os atributos de aviso. Trata-se de um invólucro simples em torno da função Python @ref{d22,,warnings.warn_explicit()}; consulte-a para obter mais informações. Os argumentos `module' e `registry' podem ser definidos como @code{NULL} para obter o efeito padrão descrito nessa função.


Adicionado na versão 3.4.

@end deffn

@geindex PyErr_WarnExplicit (C function)
@anchor{c-api/exceptions c PyErr_WarnExplicit}@anchor{180f}
@deffn {C Função} int PyErr_WarnExplicit (PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)
` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{4e89,,PyErr_WarnExplicitObject()}, exceto que `message' e `module' são strings codificadas em UTF-8 e `filename' é decodificado a partir do @ref{53b,,tratador de erros e codificação do sistema de arquivos}.
@end deffn

@geindex PyErr_WarnFormat (C function)
@anchor{c-api/exceptions c PyErr_WarnFormat}@anchor{4c73}
@deffn {C Função} int PyErr_WarnFormat (PyObject *category, Py_ssize_t stack_level, const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Function similar to @ref{1494,,PyErr_WarnEx()}, but use
@ref{38a,,PyUnicode_FromFormat()} to format the warning message.  `format' is
an ASCII-encoded string.


Adicionado na versão 3.2.

@end deffn

@geindex PyErr_WarnExplicitFormat (C function)
@anchor{c-api/exceptions c PyErr_WarnExplicitFormat}@anchor{4e8a}
@deffn {C Função} int PyErr_WarnExplicitFormat (PyObject *category, const char *filename, int lineno, const char *module, PyObject *registry, const char *format, ...)

Similar to @ref{180f,,PyErr_WarnExplicit()}, but uses
@ref{38a,,PyUnicode_FromFormat()} to format the warning message. `format' is
an ASCII-encoded string.


Adicionado na versão 3.2.

@end deffn

@geindex PyErr_ResourceWarning (C function)
@anchor{c-api/exceptions c PyErr_ResourceWarning}@anchor{d39}
@deffn {C Função} int PyErr_ResourceWarning (PyObject *source, Py_ssize_t stack_level, const char *format, ...)
` Parte da @ref{553,,ABI Estável} desde a versão 3.6.'
Function similar to @ref{4c73,,PyErr_WarnFormat()}, but `category' is
@ref{244,,ResourceWarning} and it passes `source' to @code{warnings.WarningMessage}.


Adicionado na versão 3.6.

@end deffn

@node Consultando o indicador de erro,Tratamento de sinal<2>,Emitindo avisos,Tratamento de exceções<2>
@anchor{c-api/exceptions querying-the-error-indicator}@anchor{4e8b}
@subsection Consultando o indicador de erro


@geindex PyErr_Occurred (C function)
@anchor{c-api/exceptions c PyErr_Occurred}@anchor{1a3b}
@deffn {C Função} @ref{339,,PyObject} *PyErr_Occurred ()
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Test whether the error indicator is set.  If set, return the exception `type'
(the first argument to the last call to one of the @code{PyErr_Set*}
functions or to @ref{3f6,,PyErr_Restore()}).  If not set, return @code{NULL}.  You do not
own a reference to the return value, so you do not need to @ref{56f,,Py_DECREF()}
it.

The caller must hold the GIL.

@cartouche
@quotation Nota 
Do not compare the return value to a specific exception; use
@ref{4be7,,PyErr_ExceptionMatches()} instead, shown below.  (The comparison could
easily fail since the exception may be an instance instead of a class, in the
case of a class exception, or it may be a subclass of the expected exception.)
@end quotation
@end cartouche
@end deffn

@geindex PyErr_ExceptionMatches (C function)
@anchor{c-api/exceptions c PyErr_ExceptionMatches}@anchor{4be7}
@deffn {C Função} int PyErr_ExceptionMatches (PyObject *exc)
` Parte da @ref{553,,ABI Estável}.'
Equivalent to @code{PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)}.  This
should only be called when an exception is actually set; a memory access
violation will occur if no exception has been raised.
@end deffn

@geindex PyErr_GivenExceptionMatches (C function)
@anchor{c-api/exceptions c PyErr_GivenExceptionMatches}@anchor{4c66}
@deffn {C Função} int PyErr_GivenExceptionMatches (PyObject *given, PyObject *exc)
` Parte da @ref{553,,ABI Estável}.'
Return true if the `given' exception matches the exception type in `exc'.  If
`exc' is a class object, this also returns true when `given' is an instance
of a subclass.  If `exc' is a tuple, all exception types in the tuple (and
recursively in subtuples) are searched for a match.
@end deffn

@geindex PyErr_GetRaisedException (C function)
@anchor{c-api/exceptions c PyErr_GetRaisedException}@anchor{3f4}
@deffn {C Função} @ref{339,,PyObject} *PyErr_GetRaisedException (void)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 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.

Por exemplo:

@example
@{
   PyObject *exc = PyErr_GetRaisedException();

   /* ... code that might produce other errors ... */

   PyErr_SetRaisedException(exc);
@}
@end example


@subsubheading Ver também


@ref{76f,,PyErr_GetHandledException()},
to save the exception currently being handled.



Adicionado na versão 3.12.

@end deffn

@geindex PyErr_SetRaisedException (C function)
@anchor{c-api/exceptions c PyErr_SetRaisedException}@anchor{3f7}
@deffn {C Função} void PyErr_SetRaisedException (PyObject *exc)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Set `exc' as the exception currently being raised,
clearing the existing exception if one is set.

@cartouche
@quotation Aviso 
This call steals a reference to `exc', which must be a valid exception.
@end quotation
@end cartouche


Adicionado na versão 3.12.

@end deffn

@geindex PyErr_Fetch (C function)
@anchor{c-api/exceptions c PyErr_Fetch}@anchor{3f3}
@deffn {C Função} void PyErr_Fetch (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.12: Use @ref{3f4,,PyErr_GetRaisedException()} em vez disso.


Retrieve the error indicator into three variables whose addresses are passed.
If the error indicator is not set, set all three variables to @code{NULL}.  If it is
set, it will be cleared and you own a reference to each object retrieved.  The
value and traceback object may be @code{NULL} even when the type object is not.

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

Por exemplo:

@example
@{
PyObject *type, *value, *traceback;
PyErr_Fetch(&type, &value, &traceback);

/* ... código que pode reproduzir outros erros ... */

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{3f6}
@deffn {C Função} void PyErr_Restore (PyObject *type, PyObject *value, PyObject *traceback)
` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.12: Use @ref{3f7,,PyErr_SetRaisedException()} em vez disso.


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{3f3,,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{3f5}
@deffn {C Função} void PyErr_NormalizeException (PyObject **exc, PyObject **val, PyObject **tb)
` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.12: Use @ref{3f4,,PyErr_GetRaisedException()} em vez disso, para evitar qualquer possível desnormalização.


Under certain circumstances, the values returned by @ref{3f3,,PyErr_Fetch()} below
can be “unnormalized”, meaning that @code{*exc} is a class object but @code{*val} is
not an instance of the  same class.  This function can be used to instantiate
the class in that case.  If the values are already normalized, nothing happens.
The delayed normalization is implemented to improve performance.

@cartouche
@quotation Nota 
This function `does not' implicitly set the
@ref{1309,,__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{76f}
@deffn {C Função} @ref{339,,PyObject} *PyErr_GetHandledException (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retrieve the active exception instance, as would be returned by @ref{68b,,sys.exception()}.
This refers to an exception that was `already caught', not to an exception that was
freshly raised. Returns a new reference to the exception or @code{NULL}.
Does not modify the interpreter’s exception state.

@cartouche
@quotation Nota 
This function is not normally used by code that wants to handle exceptions.
Rather, it can be used when code needs to save and restore the exception
state temporarily.  Use @ref{770,,PyErr_SetHandledException()} to restore or
clear the exception state.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex PyErr_SetHandledException (C function)
@anchor{c-api/exceptions c PyErr_SetHandledException}@anchor{770}
@deffn {C Função} void PyErr_SetHandledException (PyObject *exc)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Set the active exception, as known from @code{sys.exception()}.  This refers
to an exception that was `already caught', not to an exception that was
freshly raised.
To clear the exception state, pass @code{NULL}.

@cartouche
@quotation Nota 
This function is not normally used by code that wants to handle exceptions.
Rather, it can be used when code needs to save and restore the exception
state temporarily.  Use @ref{76f,,PyErr_GetHandledException()} to get the exception
state.
@end quotation
@end cartouche


Adicionado na versão 3.11.

@end deffn

@geindex PyErr_GetExcInfo (C function)
@anchor{c-api/exceptions c PyErr_GetExcInfo}@anchor{772}
@deffn {C Função} void PyErr_GetExcInfo (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Retrieve the old-style representation of the exception info, as known from
@ref{68a,,sys.exc_info()}.  This refers to an exception that was `already caught',
not to an exception that was freshly raised.  Returns new references for the
three objects, any of which may be @code{NULL}.  Does not modify the exception
info state.  This function is kept for backwards compatibility. Prefer using
@ref{76f,,PyErr_GetHandledException()}.

@cartouche
@quotation Nota 
This function is not normally used by code that wants to handle exceptions.
Rather, it can be used when code needs to save and restore the exception
state temporarily.  Use @ref{771,,PyErr_SetExcInfo()} to restore or clear the
exception state.
@end quotation
@end cartouche


Adicionado na versão 3.3.

@end deffn

@geindex PyErr_SetExcInfo (C function)
@anchor{c-api/exceptions c PyErr_SetExcInfo}@anchor{771}
@deffn {C Função} void PyErr_SetExcInfo (PyObject *type, PyObject *value, PyObject *traceback)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Set the exception info, as known from @code{sys.exc_info()}.  This refers
to an exception that was `already caught', not to an exception that was
freshly raised.  This function steals the references of the arguments.
To clear the exception state, pass @code{NULL} for all three arguments.
This function is kept for backwards compatibility. Prefer using
@ref{770,,PyErr_SetHandledException()}.

@cartouche
@quotation Nota 
This function is not normally used by code that wants to handle exceptions.
Rather, it can be used when code needs to save and restore the exception
state temporarily.  Use @ref{772,,PyErr_GetExcInfo()} to read the exception
state.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 3.11: The @code{type} and @code{traceback} arguments are no longer used and
can be NULL. The interpreter now derives them from the exception
instance (the @code{value} argument). The function still steals
references of all three arguments.

@end deffn

@node Tratamento de sinal<2>,Classes de exceção,Consultando o indicador de erro,Tratamento de exceções<2>
@anchor{c-api/exceptions signal-handling}@anchor{4e8c}
@subsection Tratamento de sinal


@geindex PyErr_CheckSignals (C function)
@anchor{c-api/exceptions c PyErr_CheckSignals}@anchor{467}
@deffn {C Função} int PyErr_CheckSignals ()
` Parte da @ref{553,,ABI Estável}.'
@geindex módulo;signal
@geindex SIGINT (C macro)
@geindex KeyboardInterrupt (built-in exception)

Essa função interage com o manipulador de sinais do Python.

If the function is called from the main thread and under the main Python
interpreter, it checks whether a signal has been sent to the processes
and if so, invokes the corresponding signal handler.  If the @ref{c6,,signal}
module is supported, this can invoke a signal handler written in Python.

The function attempts to handle all pending signals, and then returns @code{0}.
However, if a Python signal handler raises an exception, the error
indicator is set and the function returns @code{-1} immediately (such that
other pending signals may not have been handled yet: they will be on the
next @ref{467,,PyErr_CheckSignals()} invocation).

If the function is called from a non-main thread, or under a non-main
Python interpreter, it does nothing and returns @code{0}.

This function can be called by long-running C code that wants to
be interruptible by user requests (such as by pressing Ctrl-C).

@cartouche
@quotation Nota 
The default Python signal handler for @code{SIGINT} raises the
@ref{9d9,,KeyboardInterrupt} exception.
@end quotation
@end cartouche
@end deffn

@geindex PyErr_SetInterrupt (C function)
@anchor{c-api/exceptions c PyErr_SetInterrupt}@anchor{4c6f}
@deffn {C Função} void PyErr_SetInterrupt ()
` Parte da @ref{553,,ABI Estável}.'
@geindex módulo;signal
@geindex SIGINT (C macro)
@geindex KeyboardInterrupt (built-in exception)

Simula o efeito de um sinal @code{SIGINT} chegando. Isto é equivalente a @code{PyErr_SetInterruptEx(SIGINT)}.

@cartouche
@quotation Nota 
This function is async-signal-safe.  It can be called without
the @ref{159,,GIL} and from a C signal handler.
@end quotation
@end cartouche
@end deffn

@geindex PyErr_SetInterruptEx (C function)
@anchor{c-api/exceptions c PyErr_SetInterruptEx}@anchor{8a2}
@deffn {C Função} int PyErr_SetInterruptEx (int signum)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
@geindex módulo;signal
@geindex KeyboardInterrupt (built-in exception)

Simulate the effect of a signal arriving. The next time
@ref{467,,PyErr_CheckSignals()} is called,  the Python signal handler for
the given signal number will be called.

This function can be called by C code that sets up its own signal handling
and wants Python signal handlers to be invoked as expected when an
interruption is requested (for example when the user presses Ctrl-C
to interrupt an operation).

Se o sinal fornecido não for tratado pelo Python (foi definido como @ref{193c,,signal.SIG_DFL} ou @ref{193b,,signal.SIG_IGN}), ele será ignorado.

If `signum' is outside of the allowed range of signal numbers, @code{-1}
is returned.  Otherwise, @code{0} is returned.  The error indicator is
never changed by this function.

@cartouche
@quotation Nota 
This function is async-signal-safe.  It can be called without
the @ref{159,,GIL} and from a C signal handler.
@end quotation
@end cartouche


Adicionado na versão 3.10.

@end deffn

@geindex PySignal_SetWakeupFd (C function)
@anchor{c-api/exceptions c PySignal_SetWakeupFd}@anchor{1422}
@deffn {C Função} int PySignal_SetWakeupFd (int fd)

This utility function specifies a file descriptor to which the signal number
is written as a single byte whenever a signal is received. `fd' must be
non-blocking. It returns the previous such file descriptor.

O valor @code{-1} desabilita o recurso; este é o estado inicial. Isso é equivalente à @ref{b86,,signal.set_wakeup_fd()} em Python, mas sem nenhuma verificação de erro. `fd' deve ser um descritor de arquivo válido. A função só deve ser chamada a partir da thread principal.


Alterado na versão 3.5: No Windows, a função agora também suporta manipuladores de socket.

@end deffn

@node Classes de exceção,Objeto Exceção,Tratamento de sinal<2>,Tratamento de exceções<2>
@anchor{c-api/exceptions exception-classes}@anchor{4e8d}
@subsection Classes de exceção


@geindex PyErr_NewException (C function)
@anchor{c-api/exceptions c PyErr_NewException}@anchor{12ab}
@deffn {C Função} @ref{339,,PyObject} *PyErr_NewException (const char *name, PyObject *base, PyObject *dict)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
This utility function creates and returns a new exception class. The `name'
argument must be the name of the new exception, a C string of the form
@code{module.classname}.  The `base' and `dict' arguments are normally @code{NULL}.
This creates a class object derived from @ref{9e2,,Exception} (accessible in C as
@ref{4c8a,,PyExc_Exception}).

The @ref{374,,__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{12aa}
@deffn {C Função} @ref{339,,PyObject} *PyErr_NewExceptionWithDoc (const char *name, const char *doc, PyObject *base, PyObject *dict)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Same as @ref{12ab,,PyErr_NewException()}, except that the new exception class can
easily be given a docstring: If `doc' is non-@code{NULL}, it will be used as the
docstring for the exception class.


Adicionado na versão 3.2.

@end deffn

@geindex PyExceptionClass_Check (C function)
@anchor{c-api/exceptions c PyExceptionClass_Check}@anchor{4e8e}
@deffn {C Função} int PyExceptionClass_Check (PyObject *ob)

Return non-zero if `ob' is an exception class, zero otherwise. This function always succeeds.
@end deffn

@geindex PyExceptionClass_Name (C function)
@anchor{c-api/exceptions c PyExceptionClass_Name}@anchor{a6f}
@deffn {C Função} const char *PyExceptionClass_Name (PyObject *ob)
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
Retorna @ref{1a3c,,tp_name} da classe de exceção `ob'.
@end deffn

@node Objeto Exceção,Objetos de exceção Unicode,Classes de exceção,Tratamento de exceções<2>
@anchor{c-api/exceptions exception-objects}@anchor{4e8f}
@subsection Objeto Exceção


@geindex PyExceptionInstance_Check (C function)
@anchor{c-api/exceptions c PyExceptionInstance_Check}@anchor{4e90}
@deffn {C Função} int PyExceptionInstance_Check (PyObject *op)

Return true if `op' is an instance of @ref{5bb,,BaseException}, false
otherwise. This function always succeeds.
@end deffn

@geindex PyExceptionInstance_Class (C macro)
@anchor{c-api/exceptions c PyExceptionInstance_Class}@anchor{4e91}
@deffn {C Macro} PyExceptionInstance_Class (op)

Equivalent to @ref{780,,Py_TYPE(op)}.
@end deffn

@geindex PyException_GetTraceback (C function)
@anchor{c-api/exceptions c PyException_GetTraceback}@anchor{4cba}
@deffn {C Função} @ref{339,,PyObject} *PyException_GetTraceback (PyObject *ex)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return the traceback associated with the exception as a new reference, as
accessible from Python through the @ref{1309,,__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{1b61}
@deffn {C Função} int PyException_SetTraceback (PyObject *ex, PyObject *tb)
` Parte da @ref{553,,ABI Estável}.'
Defina o retorno traceback (situação da pilha de execução) associado à exceção como `tb'. Use @code{Py_None} para limpá-lo.
@end deffn

@geindex PyException_GetContext (C function)
@anchor{c-api/exceptions c PyException_GetContext}@anchor{4cb9}
@deffn {C Função} @ref{339,,PyObject} *PyException_GetContext (PyObject *ex)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{130a,,__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{4cbc}
@deffn {C Função} void PyException_SetContext (PyObject *ex, PyObject *ctx)
` Parte da @ref{553,,ABI Estável}.'
Set the context associated with the exception to `ctx'.  Use @code{NULL} to clear
it.  There is no type check to make sure that `ctx' is an exception instance.
This steals a reference to `ctx'.
@end deffn

@geindex PyException_GetCause (C function)
@anchor{c-api/exceptions c PyException_GetCause}@anchor{4cb8}
@deffn {C Função} @ref{339,,PyObject} *PyException_GetCause (PyObject *ex)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{130b,,__cause__} attribute.
@end deffn

@geindex PyException_SetCause (C function)
@anchor{c-api/exceptions c PyException_SetCause}@anchor{4cbb}
@deffn {C Função} void PyException_SetCause (PyObject *ex, PyObject *cause)
` Parte da @ref{553,,ABI Estável}.'
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{224a,,__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{56a}
@deffn {C Função} @ref{339,,PyObject} *PyException_GetArgs (PyObject *ex)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Retorna @ref{56c,,args} da exceção `ex'.
@end deffn

@geindex PyException_SetArgs (C function)
@anchor{c-api/exceptions c PyException_SetArgs}@anchor{56b}
@deffn {C Função} void PyException_SetArgs (PyObject *ex, PyObject *args)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Set @ref{56c,,args} of exception `ex' to `args'.
@end deffn

@geindex PyUnstable_Exc_PrepReraiseStar (C function)
@anchor{c-api/exceptions c PyUnstable_Exc_PrepReraiseStar}@anchor{4e92}
@deffn {C Função} @ref{339,,PyObject} *PyUnstable_Exc_PrepReraiseStar (PyObject *orig, PyObject *excs)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@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{1b6,,ExceptionGroup} that needs to be reraised in the end, or
@code{None} if there is nothing to reraise.


Adicionado na versão 3.12.

@end deffn

@node Objetos de exceção Unicode,Controle de recursão,Objeto Exceção,Tratamento de exceções<2>
@anchor{c-api/exceptions unicode-exception-objects}@anchor{4e93}@anchor{c-api/exceptions unicodeexceptions}@anchor{4e94}
@subsection Objetos de exceção Unicode


As seguintes funções são usadas para criar e modificar exceções Unicode de C.

@geindex PyUnicodeDecodeError_Create (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_Create}@anchor{4d7c}
@deffn {C Função} @ref{339,,PyObject} *PyUnicodeDecodeError_Create (const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Create a @ref{a1d,,UnicodeDecodeError} object with the attributes `encoding',
`object', `length', `start', `end' and `reason'. `encoding' and `reason' are
UTF-8 encoded strings.
@end deffn

@geindex PyUnicodeDecodeError_GetEncoding (C function)
@geindex PyUnicodeEncodeError_GetEncoding (C function)
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetEncoding}@anchor{4d7d}
@deffn {C Função} @ref{339,,PyObject} *PyUnicodeDecodeError_GetEncoding (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEncoding}@anchor{4d85}
@deffnx {C Função} @ref{339,,PyObject} *PyUnicodeEncodeError_GetEncoding (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o atributo * encoding* dado no objeto da exceção.
@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{4d7f}
@deffn {C Função} @ref{339,,PyObject} *PyUnicodeDecodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetObject}@anchor{4d87}
@deffnx {C Função} @ref{339,,PyObject} *PyUnicodeEncodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetObject}@anchor{4d8f}
@deffnx {C Função} @ref{339,,PyObject} *PyUnicodeTranslateError_GetObject (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o atributo `object' dado no objeto da exceção.
@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{4d81}
@deffn {C Função} int PyUnicodeDecodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetStart}@anchor{4d89}
@deffnx {C Função} int PyUnicodeEncodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetStart}@anchor{4d91}
@deffnx {C Função} int PyUnicodeTranslateError_GetStart (PyObject *exc, Py_ssize_t *start)
` Parte da @ref{553,,ABI Estável}.'
Obtém o atributo `start' do objeto da exceção coloca-o em `*start'. `start' não deve ser @code{NULL}. Retorna @code{0} se não der erro, @code{-1} caso dê erro.
@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{4d84}
@deffn {C Função} int PyUnicodeDecodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetStart}@anchor{4d8c}
@deffnx {C Função} int PyUnicodeEncodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetStart}@anchor{4d94}
@deffnx {C Função} int PyUnicodeTranslateError_SetStart (PyObject *exc, Py_ssize_t start)
` Parte da @ref{553,,ABI Estável}.'
Define o atributo `start' dado no objeto de exceção `start'. Em caso de sucesso, retorna @code{0}, em caso de falha, retorna @code{-1}.
@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{4d7e}
@deffn {C Função} int PyUnicodeDecodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEnd}@anchor{4d86}
@deffnx {C Função} int PyUnicodeEncodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetEnd}@anchor{4d8e}
@deffnx {C Função} int PyUnicodeTranslateError_GetEnd (PyObject *exc, Py_ssize_t *end)
` Parte da @ref{553,,ABI Estável}.'
Obtenha o atributo `end' dado no objeto de exceção e coloque `*end'. O `end' não deve ser @code{NULL}. Em caso de sucesso, retorna @code{0}, em caso de falha, retorna @code{-1}.
@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{4d82}
@deffn {C Função} int PyUnicodeDecodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetEnd}@anchor{4d8a}
@deffnx {C Função} int PyUnicodeEncodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetEnd}@anchor{4d92}
@deffnx {C Função} int PyUnicodeTranslateError_SetEnd (PyObject *exc, Py_ssize_t end)
` Parte da @ref{553,,ABI Estável}.'
Set the `end' attribute of the given exception object to `end'.  Return @code{0}
on success, @code{-1} on failure.
@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{4d80}
@deffn {C Função} @ref{339,,PyObject} *PyUnicodeDecodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetReason}@anchor{4d88}
@deffnx {C Função} @ref{339,,PyObject} *PyUnicodeEncodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetReason}@anchor{4d90}
@deffnx {C Função} @ref{339,,PyObject} *PyUnicodeTranslateError_GetReason (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o atributo `reason' dado no objeto da exceção.
@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{4d83}
@deffn {C Função} int PyUnicodeDecodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetReason}@anchor{4d8b}
@deffnx {C Função} int PyUnicodeEncodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetReason}@anchor{4d93}
@deffnx {C Função} int PyUnicodeTranslateError_SetReason (PyObject *exc, const char *reason)
` Parte da @ref{553,,ABI Estável}.'
Set the `reason' attribute of the given exception object to `reason'.  Return
@code{0} on success, @code{-1} on failure.
@end deffn

@node Controle de recursão,Exception and warning types,Objetos de exceção Unicode,Tratamento de exceções<2>
@anchor{c-api/exceptions recursion}@anchor{4e95}@anchor{c-api/exceptions recursion-control}@anchor{4e96}
@subsection Controle de recursão


These two functions provide a way to perform safe recursive calls at the C
level, both in the core and in extension modules.  They are needed if the
recursive code does not necessarily invoke Python code (which tracks its
recursion depth automatically).
They are also not needed for `tp_call' implementations
because the @ref{583,,call protocol} takes care of recursion handling.

@geindex Py_EnterRecursiveCall (C function)
@anchor{c-api/exceptions c Py_EnterRecursiveCall}@anchor{97a}
@deffn {C Função} int Py_EnterRecursiveCall (const char *where)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Marca um ponto em que a chamada recursiva em nível C está prestes a ser executada.

If @code{USE_STACKCHECK} is defined, this function checks if the OS
stack overflowed using @ref{192c,,PyOS_CheckStack()}.  If this is the case, it
sets a @ref{15c5,,MemoryError} and returns a nonzero value.

The function then checks if the recursion limit is reached.  If this is the
case, a @ref{d90,,RecursionError} is set and a nonzero value is returned.
Otherwise, zero is returned.

`where' should be a UTF-8 encoded string such as @code{" in instance check"} to
be concatenated to the @ref{d90,,RecursionError} message caused by the recursion
depth limit.


Alterado na versão 3.9: Esta função agora também está disponível na @ref{396,,API limitada}.

@end deffn

@geindex Py_LeaveRecursiveCall (C function)
@anchor{c-api/exceptions c Py_LeaveRecursiveCall}@anchor{97b}
@deffn {C Função} void Py_LeaveRecursiveCall (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Ends a @ref{97a,,Py_EnterRecursiveCall()}.  Must be called once for each
`successful' invocation of @ref{97a,,Py_EnterRecursiveCall()}.


Alterado na versão 3.9: Esta função agora também está disponível na @ref{396,,API limitada}.

@end deffn

Properly implementing @ref{4b8d,,tp_repr} for container types requires
special recursion handling.  In addition to protecting the stack,
@ref{4b8d,,tp_repr} also needs to track objects to prevent cycles.  The
following two functions facilitate this functionality.  Effectively,
these are the C equivalent to @ref{1233,,reprlib.recursive_repr()}.

@geindex Py_ReprEnter (C function)
@anchor{c-api/exceptions c Py_ReprEnter}@anchor{4dcc}
@deffn {C Função} int Py_ReprEnter (PyObject *object)
` Parte da @ref{553,,ABI Estável}.'
Chamado no início da implementação @ref{4b8d,,tp_repr} para detectar ciclos.

If the object has already been processed, the function returns a
positive integer.  In that case the @ref{4b8d,,tp_repr} implementation
should return a string object indicating a cycle.  As examples,
@ref{256,,dict} objects return @code{@{...@}} and @ref{611,,list} objects
return @code{[...]}.

A função retornará um inteiro negativo se o limite da recursão for atingido. Nesse caso a implementação @ref{4b8d,,tp_repr} deverá, normalmente,. retornar @code{NULL}.

Caso contrário, a função retorna zero e a implementação @ref{4b8d,,tp_repr} poderá continuar normalmente.
@end deffn

@geindex Py_ReprLeave (C function)
@anchor{c-api/exceptions c Py_ReprLeave}@anchor{4dcd}
@deffn {C Função} void Py_ReprLeave (PyObject *object)
` Parte da @ref{553,,ABI Estável}.'
Termina a @ref{4dcc,,Py_ReprEnter()}. Deve ser chamado uma vez para cada chamada de @ref{4dcc,,Py_ReprEnter()} que retorna zero.
@end deffn

@geindex Py_GetRecursionLimit (C function)
@anchor{c-api/exceptions c Py_GetRecursionLimit}@anchor{4dc7}
@deffn {C Função} int Py_GetRecursionLimit (void)
` Parte da @ref{553,,ABI Estável}.'
Get the recursion limit for the current interpreter. It can be set with
@ref{4dce,,Py_SetRecursionLimit()}. The recursion limit prevents the
Python interpreter stack from growing infinitely.

This function cannot fail, and the caller must hold the
@ref{159,,GIL}.


@subsubheading Ver também


@ref{4c4,,sys.getrecursionlimit()}

@end deffn

@geindex Py_SetRecursionLimit (C function)
@anchor{c-api/exceptions c Py_SetRecursionLimit}@anchor{4dce}
@deffn {C Função} void Py_SetRecursionLimit (int new_limit)
` Parte da @ref{553,,ABI Estável}.'
Set the recursion limit for the current interpreter.

This function cannot fail, and the caller must hold the
@ref{159,,GIL}.


@subsubheading Ver também


@ref{4c3,,sys.setrecursionlimit()}

@end deffn

@node Exception and warning types,Tracebacks,Controle de recursão,Tratamento de exceções<2>
@anchor{c-api/exceptions exception-and-warning-types}@anchor{4e97}@anchor{c-api/exceptions standardexceptions}@anchor{4e98}
@subsection Exception and warning types


All standard Python exceptions and warning categories are available as global
variables whose names are @code{PyExc_} followed by the Python exception name.
These have the type @ref{339,,PyObject}*; they are all class objects.

For completeness, here are all the variables:

@menu
* Tipos de exceção:: 
* OSError aliases:: 
* Warning types:: 

@end menu

@node Tipos de exceção,OSError aliases,,Exception and warning types
@anchor{c-api/exceptions exception-types}@anchor{4e99}
@subsubsection Tipos de exceção



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome C

@tab

Nome Python

@item

@geindex PyExc_BaseException (C var)
@anchor{c-api/exceptions c PyExc_BaseException}@anchor{4c7b}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BaseException
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{5bb,,BaseException}

@item

@geindex PyExc_BaseExceptionGroup (C var)
@anchor{c-api/exceptions c PyExc_BaseExceptionGroup}@anchor{4c7c}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BaseExceptionGroup
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

@ref{25f,,BaseExceptionGroup}

@item

@geindex PyExc_Exception (C var)
@anchor{c-api/exceptions c PyExc_Exception}@anchor{4c8a}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_Exception
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{9e2,,Exception}

@item

@geindex PyExc_ArithmeticError (C var)
@anchor{c-api/exceptions c PyExc_ArithmeticError}@anchor{4c78}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ArithmeticError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{241a,,ArithmeticError}

@item

@geindex PyExc_AssertionError (C var)
@anchor{c-api/exceptions c PyExc_AssertionError}@anchor{4c79}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_AssertionError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{6a9,,AssertionError}

@item

@geindex PyExc_AttributeError (C var)
@anchor{c-api/exceptions c PyExc_AttributeError}@anchor{4c7a}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_AttributeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{34b,,AttributeError}

@item

@geindex PyExc_BlockingIOError (C var)
@anchor{c-api/exceptions c PyExc_BlockingIOError}@anchor{4c7d}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BlockingIOError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1090,,BlockingIOError}

@item

@geindex PyExc_BrokenPipeError (C var)
@anchor{c-api/exceptions c PyExc_BrokenPipeError}@anchor{4c7e}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BrokenPipeError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1095,,BrokenPipeError}

@item

@geindex PyExc_BufferError (C var)
@anchor{c-api/exceptions c PyExc_BufferError}@anchor{4c7f}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BufferError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{15bd,,BufferError}

@item

@geindex PyExc_ChildProcessError (C var)
@anchor{c-api/exceptions c PyExc_ChildProcessError}@anchor{4c81}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ChildProcessError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1091,,ChildProcessError}

@item

@geindex PyExc_ConnectionAbortedError (C var)
@anchor{c-api/exceptions c PyExc_ConnectionAbortedError}@anchor{4c82}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ConnectionAbortedError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1096,,ConnectionAbortedError}

@item

@geindex PyExc_ConnectionError (C var)
@anchor{c-api/exceptions c PyExc_ConnectionError}@anchor{4c83}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ConnectionError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{e36,,ConnectionError}

@item

@geindex PyExc_ConnectionRefusedError (C var)
@anchor{c-api/exceptions c PyExc_ConnectionRefusedError}@anchor{4c84}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ConnectionRefusedError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1097,,ConnectionRefusedError}

@item

@geindex PyExc_ConnectionResetError (C var)
@anchor{c-api/exceptions c PyExc_ConnectionResetError}@anchor{4c85}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ConnectionResetError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1098,,ConnectionResetError}

@item

@geindex PyExc_EOFError (C var)
@anchor{c-api/exceptions c PyExc_EOFError}@anchor{4c87}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_EOFError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{131c,,EOFError}

@item

@geindex PyExc_FileExistsError (C var)
@anchor{c-api/exceptions c PyExc_FileExistsError}@anchor{4c8b}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_FileExistsError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1056,,FileExistsError}

@item

@geindex PyExc_FileNotFoundError (C var)
@anchor{c-api/exceptions c PyExc_FileNotFoundError}@anchor{4c8c}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_FileNotFoundError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{42b,,FileNotFoundError}

@item

@geindex PyExc_FloatingPointError (C var)
@anchor{c-api/exceptions c PyExc_FloatingPointError}@anchor{4c8d}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_FloatingPointError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{241b,,FloatingPointError}

@item

@geindex PyExc_GeneratorExit (C var)
@anchor{c-api/exceptions c PyExc_GeneratorExit}@anchor{4c8f}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_GeneratorExit
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{140e,,GeneratorExit}

@item

@geindex PyExc_ImportError (C var)
@anchor{c-api/exceptions c PyExc_ImportError}@anchor{4c91}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ImportError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{419,,ImportError}

@item

@geindex PyExc_IndentationError (C var)
@anchor{c-api/exceptions c PyExc_IndentationError}@anchor{4c93}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_IndentationError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{7a9,,IndentationError}

@item

@geindex PyExc_IndexError (C var)
@anchor{c-api/exceptions c PyExc_IndexError}@anchor{4c94}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_IndexError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{157e,,IndexError}

@item

@geindex PyExc_InterruptedError (C var)
@anchor{c-api/exceptions c PyExc_InterruptedError}@anchor{4c95}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_InterruptedError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{db0,,InterruptedError}

@item

@geindex PyExc_IsADirectoryError (C var)
@anchor{c-api/exceptions c PyExc_IsADirectoryError}@anchor{4c96}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_IsADirectoryError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1092,,IsADirectoryError}

@item

@geindex PyExc_KeyError (C var)
@anchor{c-api/exceptions c PyExc_KeyError}@anchor{4c97}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_KeyError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{344,,KeyError}

@item

@geindex PyExc_KeyboardInterrupt (C var)
@anchor{c-api/exceptions c PyExc_KeyboardInterrupt}@anchor{4c98}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_KeyboardInterrupt
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{9d9,,KeyboardInterrupt}

@item

@geindex PyExc_LookupError (C var)
@anchor{c-api/exceptions c PyExc_LookupError}@anchor{4c99}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_LookupError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{2367,,LookupError}

@item

@geindex PyExc_MemoryError (C var)
@anchor{c-api/exceptions c PyExc_MemoryError}@anchor{4c9a}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_MemoryError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{15c5,,MemoryError}

@item

@geindex PyExc_ModuleNotFoundError (C var)
@anchor{c-api/exceptions c PyExc_ModuleNotFoundError}@anchor{4c9b}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ModuleNotFoundError
` Parte da @ref{553,,ABI Estável} desde a versão 3.6.'
@end deffn

@tab

@ref{b5b,,ModuleNotFoundError}

@item

@geindex PyExc_NameError (C var)
@anchor{c-api/exceptions c PyExc_NameError}@anchor{4c9c}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_NameError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{43f,,NameError}

@item

@geindex PyExc_NotADirectoryError (C var)
@anchor{c-api/exceptions c PyExc_NotADirectoryError}@anchor{4c9d}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_NotADirectoryError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1093,,NotADirectoryError}

@item

@geindex PyExc_NotImplementedError (C var)
@anchor{c-api/exceptions c PyExc_NotImplementedError}@anchor{4c9e}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_NotImplementedError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{228,,NotImplementedError}

@item

@geindex PyExc_OSError (C var)
@anchor{c-api/exceptions c PyExc_OSError}@anchor{4b44}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_OSError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{417,,OSError}

@item

@geindex PyExc_OverflowError (C var)
@anchor{c-api/exceptions c PyExc_OverflowError}@anchor{4c9f}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_OverflowError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{885,,OverflowError}

@item

@geindex PyExc_PermissionError (C var)
@anchor{c-api/exceptions c PyExc_PermissionError}@anchor{4ca1}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_PermissionError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{d65,,PermissionError}

@item

@geindex PyExc_ProcessLookupError (C var)
@anchor{c-api/exceptions c PyExc_ProcessLookupError}@anchor{4ca2}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ProcessLookupError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1094,,ProcessLookupError}

@item

@geindex PyExc_PythonFinalizationError (C var)
@anchor{c-api/exceptions c PyExc_PythonFinalizationError}@anchor{4e9a}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_PythonFinalizationError
@end deffn

@tab

@ref{14d,,PythonFinalizationError}

@item

@geindex PyExc_RecursionError (C var)
@anchor{c-api/exceptions c PyExc_RecursionError}@anchor{ee1}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_RecursionError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{d90,,RecursionError}

@item

@geindex PyExc_ReferenceError (C var)
@anchor{c-api/exceptions c PyExc_ReferenceError}@anchor{4ca3}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ReferenceError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{1556,,ReferenceError}

@item

@geindex PyExc_RuntimeError (C var)
@anchor{c-api/exceptions c PyExc_RuntimeError}@anchor{4ca5}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_RuntimeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{195,,RuntimeError}

@item

@geindex PyExc_StopAsyncIteration (C var)
@anchor{c-api/exceptions c PyExc_StopAsyncIteration}@anchor{4ca7}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_StopAsyncIteration
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{1ba5,,StopAsyncIteration}

@item

@geindex PyExc_StopIteration (C var)
@anchor{c-api/exceptions c PyExc_StopIteration}@anchor{4ca8}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_StopIteration
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{c15,,StopIteration}

@item

@geindex PyExc_SyntaxError (C var)
@anchor{c-api/exceptions c PyExc_SyntaxError}@anchor{4ca9}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_SyntaxError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{18d,,SyntaxError}

@item

@geindex PyExc_SystemError (C var)
@anchor{c-api/exceptions c PyExc_SystemError}@anchor{4cab}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_SystemError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{575,,SystemError}

@item

@geindex PyExc_SystemExit (C var)
@anchor{c-api/exceptions c PyExc_SystemExit}@anchor{4cac}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_SystemExit
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{d63,,SystemExit}

@item

@geindex PyExc_TabError (C var)
@anchor{c-api/exceptions c PyExc_TabError}@anchor{4cad}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_TabError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{543,,TabError}

@item

@geindex PyExc_TimeoutError (C var)
@anchor{c-api/exceptions c PyExc_TimeoutError}@anchor{4cae}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_TimeoutError
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{838,,TimeoutError}

@item

@geindex PyExc_TypeError (C var)
@anchor{c-api/exceptions c PyExc_TypeError}@anchor{4b43}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_TypeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{2c3,,TypeError}

@item

@geindex PyExc_UnboundLocalError (C var)
@anchor{c-api/exceptions c PyExc_UnboundLocalError}@anchor{4caf}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnboundLocalError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{157f,,UnboundLocalError}

@item

@geindex PyExc_UnicodeDecodeError (C var)
@anchor{c-api/exceptions c PyExc_UnicodeDecodeError}@anchor{4cb0}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnicodeDecodeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{a1d,,UnicodeDecodeError}

@item

@geindex PyExc_UnicodeEncodeError (C var)
@anchor{c-api/exceptions c PyExc_UnicodeEncodeError}@anchor{4cb1}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnicodeEncodeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{677,,UnicodeEncodeError}

@item

@geindex PyExc_UnicodeError (C var)
@anchor{c-api/exceptions c PyExc_UnicodeError}@anchor{4cb2}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnicodeError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{12e6,,UnicodeError}

@item

@geindex PyExc_UnicodeTranslateError (C var)
@anchor{c-api/exceptions c PyExc_UnicodeTranslateError}@anchor{4cb3}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnicodeTranslateError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{2434,,UnicodeTranslateError}

@item

@geindex PyExc_ValueError (C var)
@anchor{c-api/exceptions c PyExc_ValueError}@anchor{4b45}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ValueError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{202,,ValueError}

@item

@geindex PyExc_ZeroDivisionError (C var)
@anchor{c-api/exceptions c PyExc_ZeroDivisionError}@anchor{4b40}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ZeroDivisionError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{94c,,ZeroDivisionError}

@end multitable



Adicionado na versão 3.3: @ref{4c7d,,PyExc_BlockingIOError}, @ref{4c7e,,PyExc_BrokenPipeError}, @ref{4c81,,PyExc_ChildProcessError}, @ref{4c83,,PyExc_ConnectionError}, @ref{4c82,,PyExc_ConnectionAbortedError}, @ref{4c84,,PyExc_ConnectionRefusedError}, @ref{4c85,,PyExc_ConnectionResetError}, @ref{4c8b,,PyExc_FileExistsError}, @ref{4c8c,,PyExc_FileNotFoundError}, @ref{4c95,,PyExc_InterruptedError}, @ref{4c96,,PyExc_IsADirectoryError}, @ref{4c9d,,PyExc_NotADirectoryError}, @ref{4ca1,,PyExc_PermissionError}, @ref{4ca2,,PyExc_ProcessLookupError} e @ref{4cae,,PyExc_TimeoutError} foram introduzidos seguindo a 
@geindex Propostas de Melhorias do Python; PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}.



Adicionado na versão 3.5: @ref{4ca7,,PyExc_StopAsyncIteration} e @ref{ee1,,PyExc_RecursionError}.



Adicionado na versão 3.6: @ref{4c9b,,PyExc_ModuleNotFoundError}.



Adicionado na versão 3.11: @ref{4c7c,,PyExc_BaseExceptionGroup}.


@node OSError aliases,Warning types,Tipos de exceção,Exception and warning types
@anchor{c-api/exceptions oserror-aliases}@anchor{4e9b}
@subsubsection OSError aliases


The following are a compatibility aliases to @ref{4b44,,PyExc_OSError}.


Alterado na versão 3.3: Esses aliases costumavam ser tipos de exceção separados.



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome C

@tab

Nome Python

@tab

Notas

@item

@geindex PyExc_EnvironmentError (C var)
@anchor{c-api/exceptions c PyExc_EnvironmentError}@anchor{4c89}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_EnvironmentError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{417,,OSError}

@tab

@item

@geindex PyExc_IOError (C var)
@anchor{c-api/exceptions c PyExc_IOError}@anchor{4c90}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_IOError
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{417,,OSError}

@tab

@item

@geindex PyExc_WindowsError (C var)
@anchor{c-api/exceptions c PyExc_WindowsError}@anchor{4cb7}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_WindowsError
` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
@end deffn

@tab

@ref{417,,OSError}

@tab

@ref{4e9c,,[win]}

@end multitable


Notas:

@anchor{c-api/exceptions win}@anchor{4e9c}@w{(win)} 
@code{PyExc_WindowsError} is only defined on Windows; protect code that uses this by testing that the preprocessor macro @code{MS_WINDOWS} is defined.

@node Warning types,,OSError aliases,Exception and warning types
@anchor{c-api/exceptions standardwarningcategories}@anchor{4e88}@anchor{c-api/exceptions warning-types}@anchor{4e9d}
@subsubsection Warning types



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nome C

@tab

Nome Python

@item

@geindex PyExc_Warning (C var)
@anchor{c-api/exceptions c PyExc_Warning}@anchor{4cb6}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_Warning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{244a,,Warning}

@item

@geindex PyExc_BytesWarning (C var)
@anchor{c-api/exceptions c PyExc_BytesWarning}@anchor{4c80}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_BytesWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{c3d,,BytesWarning}

@item

@geindex PyExc_DeprecationWarning (C var)
@anchor{c-api/exceptions c PyExc_DeprecationWarning}@anchor{4c86}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_DeprecationWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{1a5,,DeprecationWarning}

@item

@geindex PyExc_EncodingWarning (C var)
@anchor{c-api/exceptions c PyExc_EncodingWarning}@anchor{4c88}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_EncodingWarning
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
@end deffn

@tab

@ref{1ec5,,EncodingWarning}

@item

@geindex PyExc_FutureWarning (C var)
@anchor{c-api/exceptions c PyExc_FutureWarning}@anchor{4c8e}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_FutureWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{415,,FutureWarning}

@item

@geindex PyExc_ImportWarning (C var)
@anchor{c-api/exceptions c PyExc_ImportWarning}@anchor{4c92}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ImportWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{4fa,,ImportWarning}

@item

@geindex PyExc_PendingDeprecationWarning (C var)
@anchor{c-api/exceptions c PyExc_PendingDeprecationWarning}@anchor{4ca0}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_PendingDeprecationWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{8ce,,PendingDeprecationWarning}

@item

@geindex PyExc_ResourceWarning (C var)
@anchor{c-api/exceptions c PyExc_ResourceWarning}@anchor{4ca4}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_ResourceWarning
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@end deffn

@tab

@ref{244,,ResourceWarning}

@item

@geindex PyExc_RuntimeWarning (C var)
@anchor{c-api/exceptions c PyExc_RuntimeWarning}@anchor{4ca6}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_RuntimeWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{1bd,,RuntimeWarning}

@item

@geindex PyExc_SyntaxWarning (C var)
@anchor{c-api/exceptions c PyExc_SyntaxWarning}@anchor{4caa}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_SyntaxWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{466,,SyntaxWarning}

@item

@geindex PyExc_UnicodeWarning (C var)
@anchor{c-api/exceptions c PyExc_UnicodeWarning}@anchor{4cb4}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UnicodeWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{146b,,UnicodeWarning}

@item

@geindex PyExc_UserWarning (C var)
@anchor{c-api/exceptions c PyExc_UserWarning}@anchor{4cb5}
@deffn {C Variável} @ref{339,,PyObject} *PyExc_UserWarning
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{244b,,UserWarning}

@end multitable



Adicionado na versão 3.2: @ref{4ca4,,PyExc_ResourceWarning}.



Adicionado na versão 3.10: @ref{4c88,,PyExc_EncodingWarning}.


@node Tracebacks,,Exception and warning types,Tratamento de exceções<2>
@anchor{c-api/exceptions tracebacks}@anchor{4e9e}
@subsection Tracebacks


@geindex PyTraceBack_Type (C var)
@anchor{c-api/exceptions c PyTraceBack_Type}@anchor{4d73}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyTraceBack_Type
` Parte da @ref{553,,ABI Estável}.'
Type object for traceback objects. This is available as
@ref{b05,,types.TracebackType} in the Python layer.
@end deffn

@geindex PyTraceBack_Check (C function)
@anchor{c-api/exceptions c PyTraceBack_Check}@anchor{4e9f}
@deffn {C Função} int PyTraceBack_Check (PyObject *op)

Return true if `op' is a traceback object, false otherwise. This function
does not account for subtypes.
@end deffn

@geindex PyTraceBack_Here (C function)
@anchor{c-api/exceptions c PyTraceBack_Here}@anchor{4d71}
@deffn {C Função} int PyTraceBack_Here (PyFrameObject *f)
` Parte da @ref{553,,ABI Estável}.'
Replace the @ref{1309,,__traceback__} attribute on the current
exception with a new traceback prepending `f' to the existing chain.

Calling this function without an exception set is undefined behavior.

Esta função retorna @code{0} em caso de sucesso e retorna @code{-1} com uma exceção definida em caso de falha.
@end deffn

@geindex PyTraceBack_Print (C function)
@anchor{c-api/exceptions c PyTraceBack_Print}@anchor{4d72}
@deffn {C Função} int PyTraceBack_Print (PyObject *tb, PyObject *f)
` Parte da @ref{553,,ABI Estável}.'
Write the traceback `tb' into the file `f'.

Esta função retorna @code{0} em caso de sucesso e retorna @code{-1} com uma exceção definida em caso de falha.
@end deffn

@node Utilitários<2>,Camada de Objetos Abstratos,Tratamento de exceções<2>,Manual de referência da API Python/C
@anchor{c-api/utilities doc}@anchor{4ea0}@anchor{c-api/utilities id1}@anchor{4ea1}@anchor{c-api/utilities translation-repo}@anchor{4ea2}@anchor{c-api/utilities utilities}@anchor{4ea3}
@section Utilitários


As funções neste capítulo executam várias tarefas de utilidade pública, desde ajudar o código C a ser mais portátil em plataformas, usando módulos Python de C, como também, a analise de argumentos de função e a construção de valores Python a partir de valores C.

@menu
* Utilitários do sistema operacional:: 
* Funções de sistema:: 
* Controle de processos:: 
* Importando módulos: Importando módulos<2>. 
* Suporte a marshalling de dados:: 
* Análise de argumentos e construção de valores:: 
* Conversão e formação de strings:: 
* Classificação e conversão de caracteres:: 
* API do PyHash:: 
* Reflexão:: 
* Registro de codec e funções de suporte:: 
* API C PyTime:: 
* Suporte a Mapas do Perf:: 

@end menu

@node Utilitários do sistema operacional,Funções de sistema,,Utilitários<2>
@anchor{c-api/sys doc}@anchor{4ea4}@anchor{c-api/sys operating-system-utilities}@anchor{4ea5}@anchor{c-api/sys os}@anchor{4ea6}
@subsection Utilitários do sistema operacional


@geindex PyOS_FSPath (C function)
@anchor{c-api/sys c PyOS_FSPath}@anchor{d3a}
@deffn {C Função} @ref{339,,PyObject} *PyOS_FSPath (PyObject *path)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.6.'
Retorna a representação do sistema de arquivos para `path'. Se o objeto for um objeto @ref{44c,,str} ou @ref{1c2,,bytes}, então uma nova @ref{33d,,referência forte} é retornada. Se o objeto implementa a interface @ref{c6c,,os.PathLike}, então @ref{c6d,,__fspath__()} é retornado desde que seja um objeto @ref{44c,,str} ou @ref{1c2,,bytes}. Caso contrário, @ref{2c3,,TypeError} é levantada e @code{NULL} é retornado.


Adicionado na versão 3.6.

@end deffn

@geindex Py_FdIsInteractive (C function)
@anchor{c-api/sys c Py_FdIsInteractive}@anchor{4ea7}
@deffn {C Função} int Py_FdIsInteractive (FILE *fp, const char *filename)

Retorna verdadeiro (não zero) se o arquivo padrão de E/S `fp' com o nome `filename' for considerado interativo. Este é o caso dos arquivos para os quais @code{isatty(fileno(fp))} é verdade. Se @ref{3cd,,PyConfig.interactive} for não zero, esta função também retorna true se o ponteiro `filename' for @code{NULL} ou se o nome for igual a uma das strings @code{'<stdin>'} ou @code{'???'}.

Esta função não deve ser chamada antes da inicialização do Python.
@end deffn

@geindex PyOS_BeforeFork (C function)
@anchor{c-api/sys c PyOS_BeforeFork}@anchor{bd8}
@deffn {C Função} void PyOS_BeforeFork ()
` Parte da @ref{553,,ABI Estável} on platforms with fork() desde a versão 3.7.'
Função para preparar algum estado interno antes de ser feito um fork do processo. Isso deve ser chamado antes de chamar @code{fork()} ou qualquer função semelhante que clone o processo atual. Disponível apenas em sistemas onde @code{fork()} é definido.

@cartouche
@quotation Aviso 
A chamada C @code{fork()} só deve ser feita a partir da @ref{4ea8,,thread “main”} (do @ref{587,,interpretador “main”}). O mesmo vale para @code{PyOS_BeforeFork()}.
@end quotation
@end cartouche


Adicionado na versão 3.7.

@end deffn

@geindex PyOS_AfterFork_Parent (C function)
@anchor{c-api/sys c PyOS_AfterFork_Parent}@anchor{bd9}
@deffn {C Função} void PyOS_AfterFork_Parent ()
` Parte da @ref{553,,ABI Estável} on platforms with fork() desde a versão 3.7.'
Função para atualizar algum estado interno depois de ser feito um fork do processo. Isso deve ser chamado a partir do processo pai depois de chamar @code{fork()} ou qualquer função semelhante que clone o processo atual, independentemente da clonagem do processo ter sido bem-sucedida ou não. Disponível apenas em sistemas onde @code{fork()} é definido.

@cartouche
@quotation Aviso 
A chamada C @code{fork()} só deve ser feita a partir da @ref{4ea8,,thread “main”} (do @ref{587,,interpretador “main”}). O mesmo vale para @code{PyOS_AfterFork_Parent()}.
@end quotation
@end cartouche


Adicionado na versão 3.7.

@end deffn

@geindex PyOS_AfterFork_Child (C function)
@anchor{c-api/sys c PyOS_AfterFork_Child}@anchor{3fb}
@deffn {C Função} void PyOS_AfterFork_Child ()
` Parte da @ref{553,,ABI Estável} on platforms with fork() desde a versão 3.7.'
Função para atualizar o estado interno do interpretador depois de ser feito um fork do processo. Isso deve ser chamado a partir do processo filho depois de chamar @code{fork()} ou qualquer função semelhante que clone o processo atual, se houver alguma chance do processo ter uma chamada de retorno para o interpretador Python. Disponível apenas em sistemas onde @code{fork()} é definido.

@cartouche
@quotation Aviso 
A chamada C @code{fork()} só deve ser feita a partir da @ref{4ea8,,thread “main”} (do @ref{587,,interpretador “main”}). O mesmo vale para @code{PyOS_AfterFork_Child()}.
@end quotation
@end cartouche


Adicionado na versão 3.7.



@subsubheading Ver também


@ref{300,,os.register_at_fork()} permite registrar funções personalizadas do Python para serem chamadas por @ref{bd8,,PyOS_BeforeFork()}, @ref{bd9,,PyOS_AfterFork_Parent()} e  @ref{3fb,,PyOS_AfterFork_Child()}.

@end deffn

@geindex PyOS_AfterFork (C function)
@anchor{c-api/sys c PyOS_AfterFork}@anchor{3fa}
@deffn {C Função} void PyOS_AfterFork ()
` Parte da @ref{553,,ABI Estável} on platforms with fork().'
Função para atualizar algum estado interno após ser feito um fork de processo; isso deve ser chamado no novo processo se o interpretador do Python continuar a ser usado. Se um novo executável é carregado no novo processo, esta função não precisa ser chamada.


Descontinuado desde a versão 3.7: Esta função foi sucedida por @ref{3fb,,PyOS_AfterFork_Child()}.

@end deffn

@geindex PyOS_CheckStack (C function)
@anchor{c-api/sys c PyOS_CheckStack}@anchor{192c}
@deffn {C Função} int PyOS_CheckStack ()
` Parte da @ref{553,,ABI Estável} on platforms with USE_STACKCHECK desde a versão 3.7.'
@geindex USE_STACKCHECK (macro C)

Retorna verdadeiro quando o interpretador fica sem espaço na pilha. Esta é uma verificação confiável, mas só está disponível quando @code{USE_STACKCHECK} é definido (atualmente em certas versões do Windows usando o compilador Microsoft Visual C++). @code{USE_STACKCHECK} será definido automaticamente; você nunca deve alterar a definição em seu próprio código.
@end deffn

@geindex PyOS_sighandler_t (C type)
@anchor{c-api/sys c PyOS_sighandler_t}@anchor{4d20}
@deffn {C Tipo} typedef void (*PyOS_sighandler_t)(int)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyOS_getsig (C function)
@anchor{c-api/sys c PyOS_getsig}@anchor{1587}
@deffn {C Função} @ref{4d20,,PyOS_sighandler_t} PyOS_getsig (int i)
` Parte da @ref{553,,ABI Estável}.'
Retorna o manipulador de sinal atual para o sinal `i'. Este é um invólucro fino em torno de @code{sigaction()} ou @code{signal()}. Não chame essas funções diretamente!
@end deffn

@geindex PyOS_setsig (C function)
@anchor{c-api/sys c PyOS_setsig}@anchor{1588}
@deffn {C Função} @ref{4d20,,PyOS_sighandler_t} PyOS_setsig (int i, PyOS_sighandler_t h)
` Parte da @ref{553,,ABI Estável}.'
Define o manipulador de sinal para o sinal `i' como `h'; retornar o manipulador de sinal antigo. Este é um invólucro fino em torno de @code{sigaction()} ou @code{signal()}. Não chame essas funções diretamente!
@end deffn

@geindex PyOS_InterruptOccurred (C function)
@anchor{c-api/sys c PyOS_InterruptOccurred}@anchor{1acf}
@deffn {C Função} int PyOS_InterruptOccurred (void)
` Parte da @ref{553,,ABI Estável}.'
Verifica se um sinal @code{SIGINT} foi recebido.

Retorna @code{1} se um @code{SIGINT} ocorreu e limpa o sinalizador de sinal, ou @code{0} caso contrário.

Na maioria dos casos, você deve preferir @ref{467,,PyErr_CheckSignals()} em vez desta função. @code{PyErr_CheckSignals()} invoca os manipuladores de sinal apropriados para todos os sinais pendentes, permitindo que o código Python lide com o sinal corretamente. Esta função detecta apenas @code{SIGINT} e não invoca nenhum manipulador de sinal do Python.

This function is async-signal-safe and this function cannot fail.
The caller must hold an attached thread state.
@end deffn

@geindex Py_DecodeLocale (C function)
@anchor{c-api/sys c Py_DecodeLocale}@anchor{be0}
@deffn {C Função} wchar_t *Py_DecodeLocale (const char *arg, size_t *size)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@cartouche
@quotation Aviso 
Esta função não deve ser chamada diretamente: use a API @ref{3a6,,PyConfig} com a função @ref{9bc,,PyConfig_SetBytesString()} que garante que @ref{3f80,,Python esteja pré-inicializado}.

Esta função não deve ser chamada antes de @ref{3f80,,Python estar pré-inicializado} e para que a localidade LC_CTYPE seja configurada corretamente: consulte a função @ref{3eb,,Py_PreInitialize()}.
@end quotation
@end cartouche

Decodifica uma string de bytes do @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Se o tratador de erros for o @ref{2580,,tratador de errors surrogateescape}, bytes não decodificáveis são decodificados como caracteres no intervalo U+DC80..U+DCFF; e se uma string de bytes puder ser decodificada como um caractere substituto, os bytes são escapados usando o tratador de erros surrogateescape em vez de decodificá-los.

Retorna um ponteiro para uma string de caracteres largos recém-alocada, usa @ref{393,,PyMem_RawFree()} para liberar a memória. Se o tamanho não for @code{NULL}, escreve o número de caracteres largos excluindo o caractere nulo em @code{*size}

Retorna @code{NULL} em erro de decodificação ou erro de alocação de memória. Se `size' não for @code{NULL}, @code{*size} é definido como @code{(size_t)-1} em erro de memória ou definido como @code{(size_t)-2} em erro de decodificação.

@ref{53b,,tratador de erros e codificação do sistema de arquivos} são selecionados por @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} de @ref{3a6,,PyConfig}.

Erros de decodificação nunca devem acontecer, a menos que haja um bug na biblioteca C.

Use a função @ref{be1,,Py_EncodeLocale()} para codificar a string de caracteres de volta para uma string de bytes.


@subsubheading Ver também


As funções @ref{4d9e,,PyUnicode_DecodeFSDefaultAndSize()} e @ref{be2,,PyUnicode_DecodeLocaleAndSize()}.



Adicionado na versão 3.5.



Alterado na versão 3.7: A função agora usa a codificação UTF-8 no @ref{656,,Modo UTF-8 do Python}.



Alterado na versão 3.8: A função agora usa a codificação UTF-8 no Windows se @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding} for zero;

@end deffn

@geindex Py_EncodeLocale (C function)
@anchor{c-api/sys c Py_EncodeLocale}@anchor{be1}
@deffn {C Função} char *Py_EncodeLocale (const wchar_t *text, size_t *error_pos)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Codifica uma string de caracteres largos para o @ref{53b,,tratador de erros e codificação do sistema de arquivos}. Se o tratador de erros for um @ref{2580,,tratador de erros substituto}, os caracteres substitutos no intervalo U+DC80..U+DCFF são convertidos em bytes 0x80..0xFF.

Retorna um ponteiro para uma string de bytes recém-alocada; use @ref{148a,,PyMem_Free()} para liberar a memória. Retorna @code{NULL} em caso de erro de codificação ou de erro de alocação de memória.

Se error_pos não for @code{NULL}, @code{*error_pos} será definido como @code{(size_t)-1} em caso de sucesso, ou definido como o índice do caractere inválido em caso de erro de codificação.

@ref{53b,,tratador de erros e codificação do sistema de arquivos} são selecionados por @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} de @ref{3a6,,PyConfig}.

Use a função @ref{be0,,Py_DecodeLocale()} para decodificar a string de bytes de volta para uma string de caracteres largos.

@cartouche
@quotation Aviso 
Esta função não deve ser chamada antes de @ref{3f80,,Python estar pré-inicializado} e para que a localidade LC_CTYPE seja configurada corretamente: consulte a função @ref{3eb,,Py_PreInitialize()}.
@end quotation
@end cartouche


@subsubheading Ver também


As funções @ref{1bca,,PyUnicode_EncodeFSDefault()} e @ref{be3,,PyUnicode_EncodeLocale()}.



Adicionado na versão 3.5.



Alterado na versão 3.7: A função agora usa a codificação UTF-8 no @ref{656,,Modo UTF-8 do Python}.



Alterado na versão 3.8: A função agora usa a codificação UTF-8 no Windows se @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding} for zero.

@end deffn

@node Funções de sistema,Controle de processos,Utilitários do sistema operacional,Utilitários<2>
@anchor{c-api/sys system-functions}@anchor{4ea9}@anchor{c-api/sys systemfunctions}@anchor{4eaa}
@subsection Funções de sistema


Essas são funções utilitárias que tornam a funcionalidade do módulo @ref{d9,,sys} acessível ao código C. Todas elas funcionam com o dicionário do módulo @ref{d9,,sys} da thread do interpretador atual, que está contido na estrutura interna do estado de thread.

@geindex PySys_GetObject (C function)
@anchor{c-api/sys c PySys_GetObject}@anchor{389}
@deffn {C Função} @ref{339,,PyObject} *PySys_GetObject (const char *name)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna o objeto `name' do módulo @ref{d9,,sys} ou @code{NULL} se ele não existir, sem lançar uma exceção.
@end deffn

@geindex PySys_SetObject (C function)
@anchor{c-api/sys c PySys_SetObject}@anchor{4d5e}
@deffn {C Função} int PySys_SetObject (const char *name, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
Define `name' no módulo @ref{d9,,sys} como `v', a menos que `v' seja @code{NULL}, caso em que `name' é excluído do módulo sys. Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro.
@end deffn

@geindex PySys_ResetWarnOptions (C function)
@anchor{c-api/sys c PySys_ResetWarnOptions}@anchor{3af}
@deffn {C Função} void PySys_ResetWarnOptions ()
` Parte da @ref{553,,ABI Estável}.'
Redefine @ref{3b0,,sys.warnoptions} para uma lista vazia. Esta função pode ser chamada antes de @ref{8b1,,Py_Initialize()}.


Descontinuado desde a versão 3.13, será removido na versão 3.15: Limpe @ref{3b0,,sys.warnoptions} e @code{warnings.filters} em vez disso.

@end deffn

@geindex PySys_WriteStdout (C function)
@anchor{c-api/sys c PySys_WriteStdout}@anchor{4d60}
@deffn {C Função} void PySys_WriteStdout (const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Escreve a string de saída descrita por `format' em @ref{ae6,,sys.stdout}. Nenhuma exceção será levantada, mesmo que ocorra truncamento (veja abaixo).

`format' deve limitar o tamanho total da string de saída formatada a 1000 bytes ou menos – após 1000 bytes, a string de saída é truncada. Em particular, isso significa que não devem ocorrer formatos “%s” irrestritos; estes devem ser limitados usando “%.1s”, onde 2 é um número decimal calculado de forma que 3 mais o tamanho máximo de outros textos formatados não exceda 1000 bytes. Também fique atento a “%f”, que pode exibir centenas de dígitos para números muito grandes.

Se ocorrer um problema, ou se @ref{ae6,,sys.stdout} não estiver definido, a mensagem formatada será escrita na saída padrão (nível C) `stdout'.
@end deffn

@geindex PySys_WriteStderr (C function)
@anchor{c-api/sys c PySys_WriteStderr}@anchor{4d5f}
@deffn {C Função} void PySys_WriteStderr (const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Como @ref{4d60,,PySys_WriteStdout()}, mas escreve em @ref{940,,sys.stderr} ou `stderr' em vez disso.
@end deffn

@geindex PySys_FormatStdout (C function)
@anchor{c-api/sys c PySys_FormatStdout}@anchor{4d5c}
@deffn {C Função} void PySys_FormatStdout (const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Função semelhante a PySys_WriteStdout(), mas formata a mensagem usando @ref{574,,PyUnicode_FromFormatV()} e não trunca a mensagem para um comprimento arbitrário.


Adicionado na versão 3.2.

@end deffn

@geindex PySys_FormatStderr (C function)
@anchor{c-api/sys c PySys_FormatStderr}@anchor{4d5b}
@deffn {C Função} void PySys_FormatStderr (const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Como @ref{4d5c,,PySys_FormatStdout()}, mas escreve em @ref{940,,sys.stderr} ou `stderr' em vez disso.


Adicionado na versão 3.2.

@end deffn

@geindex PySys_GetXOptions (C function)
@anchor{c-api/sys c PySys_GetXOptions}@anchor{4d5d}
@deffn {C Função} @ref{339,,PyObject} *PySys_GetXOptions ()
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Retorna o dicionário atual de opções @ref{176,,-X}, de forma semelhante a @ref{1ec7,,sys._xoptions}. Em caso de erro, retorna @code{NULL} e uma exceção é definida.


Adicionado na versão 3.2.

@end deffn

@geindex PySys_Audit (C function)
@anchor{c-api/sys c PySys_Audit}@anchor{36f}
@deffn {C Função} int PySys_Audit (const char *event, const char *format, ...)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Levanta um evento de auditoria com todos os ganchos ativos. Retorna zero em caso de sucesso e um valor diferente de zero com uma exceção definida em caso de falha.

O argumento de string `event' não pode ser `NULL'.

Se algum gancho tiver sido adicionado, o argumento `format' e outros serão usados para construir uma tupla a ser passada. Além de @code{N}, os mesmos caracteres de formatação usados  em @ref{8ac,,Py_BuildValue()} estão disponíveis. Se o valor construído não for uma tupla, ele será adicionado a uma tupla de um único elemento.

A opção de formato @code{N} não deve ser usada. Ela consome uma referência, mas como não há como saber se os argumentos dessa função serão consumidos, usá-la pode causar vazamentos de referência.

Observe que os caracteres de formato @code{#} devem sempre ser tratados como @ref{a69,,Py_ssize_t}, independentemente de @code{PY_SSIZE_T_CLEAN} ter sido definido.

@ref{16a0,,sys.audit()} executa a mesma função a partir do código Python.

Veja também @ref{36e,,PySys_AuditTuple()}.


Adicionado na versão 3.8.



Alterado na versão 3.8.2: É necessário o tipo @ref{a69,,Py_ssize_t} para caracteres de formato @code{#}. Anteriormente, um aviso de descontinuação era levantado.

@end deffn

@geindex PySys_AuditTuple (C function)
@anchor{c-api/sys c PySys_AuditTuple}@anchor{36e}
@deffn {C Função} int PySys_AuditTuple (const char *event, PyObject *args)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Semelhante a @ref{36f,,PySys_Audit()}, mas passa argumentos como um objeto Python. `args' deve ser uma @ref{370,,tuple}. Para não passar argumentos, `args' pode ser `NULL'.


Adicionado na versão 3.13.

@end deffn

@geindex PySys_AddAuditHook (C function)
@anchor{c-api/sys c PySys_AddAuditHook}@anchor{43fd}
@deffn {C Função} int PySys_AddAuditHook (Py_AuditHookFunction hook, void *userData)

Adiciona o `gancho' chamável à lista de ganchos de auditoria ativos. Retorna zero em caso de sucesso e um valor diferente de zero em caso de falha. Se o ambiente de execução já tiver sido inicializado, também define um erro em caso de falha. Os ganchos adicionados por meio desta API são chamados para todos os interpretadores criados pelo ambiente de execução.

O ponteiro `userData' é passado para a função de gancho. Como as funções de gancho podem ser chamadas de diferentes tempos de execução, esse ponteiro não deve se referir diretamente ao estado do Python.

Esta função pode ser chamada com segurança antes de @ref{8b1,,Py_Initialize()}. Quando chamada após a inicialização em tempo de execução, os ganchos de auditoria existentes são notificados e podem abortar silenciosamente a operação, levantando um erro da classe @ref{9e2,,Exception} (outros erros não serão silenciados).

The hook function is always called with the GIL held by the Python
interpreter that raised the event.

Consulte a 
@geindex Propostas de Melhorias do Python; PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} para uma descrição detalhada da auditoria. As funções no ambiente de execução e na biblioteca padrão que levantam eventos estão listadas na @ref{199c,,tabela de eventos de auditoria}. Os detalhes estão na documentação de cada função.

Se o interpretador estiver inicializado, esta função levanta um evento de auditoria @code{sys.addaudithook} sem argumentos. Se algum gancho existente levantar uma exceção derivada de @ref{9e2,,Exception}, o novo gancho não será adicionado e a exceção será tratada. Consequentemente, os chamadores não podem presumir que seu gancho foi adicionado, a menos que controlem todos os ganchos existentes.

@geindex Py_AuditHookFunction (C type)
@anchor{c-api/sys c Py_AuditHookFunction}@anchor{4eab}
@deffn {C Tipo} typedef int (*Py_AuditHookFunction)(const char *event, @ref{339,,PyObject} *args, void *userData)

O tipo da função de gancho. `event' é o argumento de evento em string C passado para @ref{36f,,PySys_Audit()} ou @ref{36e,,PySys_AuditTuple()}. `args' tem a garantia de ser um @ref{4eac,,PyTupleObject}. `userData' é o argumento passado para PySys_AddAuditHook().
@end deffn


Adicionado na versão 3.8.

@end deffn

@node Controle de processos,Importando módulos<2>,Funções de sistema,Utilitários<2>
@anchor{c-api/sys process-control}@anchor{4ead}@anchor{c-api/sys processcontrol}@anchor{4eae}
@subsection Controle de processos


@geindex Py_FatalError (C function)
@anchor{c-api/sys c Py_FatalError}@anchor{98a}
@deffn {C Função} void Py_FatalError (const char *message)
` Parte da @ref{553,,ABI Estável}.'
@geindex abort (função C)

Exibe uma mensagem de erro fatal e encerra forçadamente o processo. Nenhuma limpeza é realizada. Esta função só deve ser invocada quando uma condição for detectada que torne perigoso continuar usando o interpretador Python; por exemplo, quando a administração de objetos parecer estar corrompida. No Unix, a função da biblioteca padrão C @code{abort()} é chamada, que tentará produzir um arquivo @code{core}.

A função @code{Py_FatalError()} é substituída por uma macro que registra automaticamente o nome da função atual, a menos que a macro @code{Py_LIMITED_API} esteja definida.


Alterado na versão 3.9: Registra o nome da função automaticamente.

@end deffn

@geindex Py_Exit (C function)
@anchor{c-api/sys c Py_Exit}@anchor{d72}
@deffn {C Função} void Py_Exit (int status)
` Parte da @ref{553,,ABI Estável}.'
@geindex Py_FinalizeEx (função C)
@geindex exit (função C)

Encerra o processo atual. Isso chama @ref{d37,,Py_FinalizeEx()} e, em seguida, chama a função da biblioteca padrão C @code{exit(status)}. Se @ref{d37,,Py_FinalizeEx()} indicar um erro, o código de status de saída será definido como 120.


Alterado na versão 3.6: Erros da finalização não são mais ignorados.

@end deffn

@geindex Py_AtExit (C function)
@anchor{c-api/sys c Py_AtExit}@anchor{4dbf}
@deffn {C Função} int Py_AtExit (void (*func)())
` Parte da @ref{553,,ABI Estável}.'
@geindex Py_FinalizeEx (função C)
@geindex funções de limpeza

Registra uma função de limpeza para ser chamada por @ref{d37,,Py_FinalizeEx()}. A função de limpeza será chamada sem argumentos e não deve retornar nenhum valor. No máximo 32 funções de limpeza podem ser registradas. Quando o registro for bem-sucedido, @ref{4dbf,,Py_AtExit()} retorna @code{0}; em caso de falha, retorna @code{-1}. A última função de limpeza registrada é chamada primeiro. Cada função de limpeza será chamada no máximo uma vez. Como a finalização interna do Python terá sido concluída antes da função de limpeza, nenhuma API do Python deve ser chamada por `func'.


@subsubheading Ver também


@ref{1672,,PyUnstable_AtExit()} para passar um argumento @code{void *data}.

@end deffn

@node Importando módulos<2>,Suporte a marshalling de dados,Controle de processos,Utilitários<2>
@anchor{c-api/import doc}@anchor{4eaf}@anchor{c-api/import importing}@anchor{4eb0}@anchor{c-api/import importing-modules}@anchor{4eb1}@anchor{c-api/import translation-repo}@anchor{4eb2}
@subsection Importando módulos


@geindex PyImport_ImportModule (C function)
@anchor{c-api/import c PyImport_ImportModule}@anchor{3be}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ImportModule (const char *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex package variable;__all__
@geindex __all__ (package variable)
@geindex modules (in module sys)

Esta é uma função auxiliar em torno de @ref{1443,,PyImport_Import()}, que recebe um const char* como argumento em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyImport_ImportModuleNoBlock (C function)
@anchor{c-api/import c PyImport_ImportModuleNoBlock}@anchor{3bd}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ImportModuleNoBlock (const char *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Esta função é um alias descontinuado de @ref{3be,,PyImport_ImportModule()}.


Alterado na versão 3.3: Essa função falhava em alguns casos, quando a trava de importação era mantida por outra thread. No Python 3.3, no entanto, o esquema de trava mudou passando a ser de travas por módulo na maior parte, dessa forma, o comportamento especial dessa função não é mais necessário.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Use @ref{3be,,PyImport_ImportModule()}.

@end deffn

@geindex PyImport_ImportModuleEx (C function)
@anchor{c-api/import c PyImport_ImportModuleEx}@anchor{11e4}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ImportModuleEx (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
`Retorna valor: Nova referência.'
@geindex função embutida;__import__

Importa um módulo. Isso é melhor descrito referindo-se à função embutida do Python @ref{8da,,__import__()}.

O valor de retorno é uma nova referência ao módulo importado ou pacote de nível superior, ou @code{NULL} com uma exceção definida em caso de falha. Como para @ref{8da,,__import__()}, o valor de retorno quando um submódulo de um pacote é solicitado é normalmente o pacote de nível superior, a menos que um `fromlist' não vazio seja fornecido.

As importações com falhas removem objetos incompletos do módulo, como em @ref{3be,,PyImport_ImportModule()}.
@end deffn

@geindex PyImport_ImportModuleLevelObject (C function)
@anchor{c-api/import c PyImport_ImportModuleLevelObject}@anchor{4cd2}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ImportModuleLevelObject (PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Importa um módulo. Isso é melhor descrito referindo-se à função embutida do Python @ref{8da,,__import__()}, já que a função padrão @ref{8da,,__import__()} chama essa função diretamente.

O valor de retorno é uma nova referência ao módulo importado ou pacote de nível superior, ou @code{NULL} com uma exceção definida em caso de falha. Como para @ref{8da,,__import__()}, o valor de retorno quando um submódulo de um pacote é solicitado é normalmente o pacote de nível superior, a menos que um `fromlist' não vazio seja fornecido.


Adicionado na versão 3.3.

@end deffn

@geindex PyImport_ImportModuleLevel (C function)
@anchor{c-api/import c PyImport_ImportModuleLevel}@anchor{11e3}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ImportModuleLevel (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Semelhante para @ref{4cd2,,PyImport_ImportModuleLevelObject()}, mas o nome é uma string codificada em UTF-8 de um objeto Unicode.


Alterado na versão 3.3: Valores negativos para `level' não são mais aceitos.

@end deffn

@geindex PyImport_Import (C function)
@anchor{c-api/import c PyImport_Import}@anchor{1443}
@deffn {C Função} @ref{339,,PyObject} *PyImport_Import (PyObject *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Essa é uma interface de alto nível que chama a atual “função auxiliar de importação” (com um `level' explícito de 0, significando importação absoluta). Invoca a função @ref{8da,,__import__()} a partir de @code{__builtins__} da global atual. Isso significa que a importação é feita usando quaisquer extras de importação instalados no ambiente atual.

Esta função sempre usa importações absolutas.
@end deffn

@geindex PyImport_ReloadModule (C function)
@anchor{c-api/import c PyImport_ReloadModule}@anchor{4cd3}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ReloadModule (PyObject *m)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Recarrega um módulo. Retorna uma nova referência para o módulo recarregado, ou @code{NULL} com uma exceção definida em caso de falha (o módulo ainda existe neste caso).
@end deffn

@geindex PyImport_AddModuleRef (C function)
@anchor{c-api/import c PyImport_AddModuleRef}@anchor{356}
@deffn {C Função} @ref{339,,PyObject} *PyImport_AddModuleRef (const char *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna o objeto do módulo correspondente ao nome do módulo.

O argumento `name' pode ter o formato @code{pacote.módulo}. Primeiro, verifica se existe um módulo no dicionário de módulos e, caso contrário, cria um novo e insere-o no dicionário de módulos.

Retorna uma @ref{33d,,referência forte} ao módulo em caso de sucesso. Retorna @code{NULL} com uma exceção definida em caso de falha.

O nome do módulo `name' é decodificado de UTF-8.

Esta função não carrega nem importa o módulo; se o módulo ainda não estiver carregado, você receberá um objeto de módulo vazio. Use @ref{3be,,PyImport_ImportModule()} ou uma de suas variantes para importar um módulo. Estruturas de pacotes implícitas por um nome com pontos para `name' não são criadas se ainda não existirem.


Adicionado na versão 3.13.

@end deffn

@geindex PyImport_AddModuleObject (C function)
@anchor{c-api/import c PyImport_AddModuleObject}@anchor{4cc9}
@deffn {C Função} @ref{339,,PyObject} *PyImport_AddModuleObject (PyObject *name)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Semelhante a @ref{356,,PyImport_AddModuleRef()}, mas retorna uma @ref{33e,,referência emprestada} e `name' é um objeto Python @ref{44c,,str}.


Adicionado na versão 3.3.

@end deffn

@geindex PyImport_AddModule (C function)
@anchor{c-api/import c PyImport_AddModule}@anchor{357}
@deffn {C Função} @ref{339,,PyObject} *PyImport_AddModule (const char *name)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{356,,PyImport_AddModuleRef()}, mas retorna uma @ref{33e,,referência emprestada}.
@end deffn

@geindex PyImport_ExecCodeModule (C function)
@anchor{c-api/import c PyImport_ExecCodeModule}@anchor{4cca}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ExecCodeModule (const char *name, PyObject *co)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;compile

Dado um nome de módulo (possivelmente no formato @code{pacote.módulo}) e um objeto código lido de um arquivo bytecode Python ou obtido da função embutida @ref{192,,compile()}, carrea o módulo. Retorna uma nova referência ao objeto do módulo ou @code{NULL} com uma exceção definida se ocorrer um erro. `name' é removido de @ref{1636,,sys.modules} em casos de erro, mesmo que `name' já estivesse em @ref{1636,,sys.modules} na entrada de @ref{4cca,,PyImport_ExecCodeModule()}. Deixar módulos incompletamente inicializados em @ref{1636,,sys.modules} é perigoso, pois as importações desses módulos não têm como saber que o objeto do módulo está em um estado desconhecido (e provavelmente corrompido em relação às intenções do autor do módulo).

Os atributos @ref{20a7,,__spec__} e @ref{2e2,,__loader__} do módulo serão definidos, caso ainda não estejam, com os valores apropriados. O carregador do spec será definido como o atributo @code{__loader__} do módulo (se definido) e, caso contrário, como uma instância de @ref{10ad,,SourceFileLoader}.

O atributo @ref{20ad,,__file__} do módulo será definido para o @ref{13b4,,co_filename} do objeto código. Se aplicável, @ref{2d5,,__cached__} também será definido.

Esta função recarregará o módulo se este já tiver sido importado. Veja @ref{4cd3,,PyImport_ReloadModule()} para forma desejada de recarregar um módulo.

Se `name' apontar para um nome pontilhado no formato de @code{package.module}, quaisquer estruturas de pacote ainda não criadas ainda não serão criadas.

Veja também @ref{4ccb,,PyImport_ExecCodeModuleEx()} e  @ref{4ccd,,PyImport_ExecCodeModuleWithPathnames()}.


Alterado na versão 3.12: A configuração de @ref{2d5,,__cached__} e @ref{2e2,,__loader__} está descontinuada. Consulte @ref{1fee,,ModuleSpec} para alternativas.

@end deffn

@geindex PyImport_ExecCodeModuleEx (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleEx}@anchor{4ccb}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ExecCodeModuleEx (const char *name, PyObject *co, const char *pathname)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Como @ref{4cca,,PyImport_ExecCodeModule()}, mas o atributo @ref{20ad,,__file__} do objeto módulo é definido como `pathname'  se não for @code{NULL}.

Veja também @ref{4ccd,,PyImport_ExecCodeModuleWithPathnames()}.
@end deffn

@geindex PyImport_ExecCodeModuleObject (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleObject}@anchor{4ccc}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ExecCodeModuleObject (PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Como @ref{4ccb,,PyImport_ExecCodeModuleEx()}, mas o atributo @ref{2d5,,__cached__} do objeto módulo é definido como `cpathname'  se não for @code{NULL}. Das três funções, esta é a preferida para usar.


Adicionado na versão 3.3.



Alterado na versão 3.12: A configuração de @ref{2d5,,__cached__} está descontinuada. Consulte @ref{1fee,,ModuleSpec} para alternativas.

@end deffn

@geindex PyImport_ExecCodeModuleWithPathnames (C function)
@anchor{c-api/import c PyImport_ExecCodeModuleWithPathnames}@anchor{4ccd}
@deffn {C Função} @ref{339,,PyObject} *PyImport_ExecCodeModuleWithPathnames (const char *name, PyObject *co, const char *pathname, const char *cpathname)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Como @ref{4ccc,,PyImport_ExecCodeModuleObject()}, mas `name', `pathname' e `cpathname' são strings codificadas em UTF-8. Também são feitas tentativas para descobrir qual valor para `pathname' deve ser de `cpathname' se o primeiro estiver definido como @code{NULL}.


Adicionado na versão 3.2.



Alterado na versão 3.3: Usa @code{imp.source_from_cache()} no cálculo do caminho de origem se apenas o caminho do bytecode for fornecido.



Alterado na versão 3.12: Não usa mais o módulo @code{imp} removido.

@end deffn

@geindex PyImport_GetMagicNumber (C function)
@anchor{c-api/import c PyImport_GetMagicNumber}@anchor{11e2}
@deffn {C Função} long PyImport_GetMagicNumber ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o número mágico para arquivos de bytecode Python (também conhecido como arquivo @code{.pyc}). O número mágico deve estar presente nos primeiros quatro bytes do arquivo bytecode, na ordem de bytes little-endian. Retorna @code{-1} em caso de erro.


Alterado na versão 3.3: Retorna o valor de @code{-1} no caso de falha.

@end deffn

@geindex PyImport_GetMagicTag (C function)
@anchor{c-api/import c PyImport_GetMagicTag}@anchor{4cce}
@deffn {C Função} const char *PyImport_GetMagicTag ()
` Parte da @ref{553,,ABI Estável}.'
Retorna a string de tag mágica para nomes de arquivo de bytecode Python no formato de 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}. Tenha em mente que o valor em @code{sys.implementation.cache_tag} é autoritativo e deve ser usado no lugar desta função.


Adicionado na versão 3.2.

@end deffn

@geindex PyImport_GetModuleDict (C function)
@anchor{c-api/import c PyImport_GetModuleDict}@anchor{4ccf}
@deffn {C Função} @ref{339,,PyObject} *PyImport_GetModuleDict ()
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna o dicionário usado para a administração do módulo (também conhecido como @code{sys.modules}). Observe que esta é uma variável por interpretador.
@end deffn

@geindex PyImport_GetModule (C function)
@anchor{c-api/import c PyImport_GetModule}@anchor{bcb}
@deffn {C Função} @ref{339,,PyObject} *PyImport_GetModule (PyObject *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
Retorna o módulo já importado com o nome fornecido. Se o módulo ainda não foi importado, retorna @code{NULL}, mas não define um erro. Retorna @code{NULL} e define um erro se a pesquisa falhar.


Adicionado na versão 3.7.

@end deffn

@geindex PyImport_GetImporter (C function)
@anchor{c-api/import c PyImport_GetImporter}@anchor{1806}
@deffn {C Função} @ref{339,,PyObject} *PyImport_GetImporter (PyObject *path)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return a finder object for a @ref{3b4,,sys.path}/@code{pkg.__path__} item
`path', possibly by fetching it from the @ref{5e4,,sys.path_importer_cache}
dict.  If it wasn’t yet cached, traverse @ref{105a,,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{2188,,path based finder} could not find a
finder for this path item. Cache the result in @ref{5e4,,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{4cd1}
@deffn {C Função} int PyImport_ImportFrozenModuleObject (PyObject *name)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Carrega um módulo congelado chamado `name'. Retorna @code{1} para sucesso, @code{0} se o módulo não for encontrado e @code{-1} com uma exceção definida se a inicialização falhar. Para acessar o módulo importado em um carregamento bem-sucedido, use @ref{3be,,PyImport_ImportModule()}. (Observe o nome incorreto — esta função recarregaria o módulo se ele já tivesse sido importado.)


Adicionado na versão 3.3.



Alterado na versão 3.4: O atributo @code{__file__} não está mais definido no módulo.

@end deffn

@geindex PyImport_ImportFrozenModule (C function)
@anchor{c-api/import c PyImport_ImportFrozenModule}@anchor{4cd0}
@deffn {C Função} int PyImport_ImportFrozenModule (const char *name)
` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{4cd1,,PyImport_ImportFrozenModuleObject()}, mas o nome é uma string codificada em UTF-8 em vez de um objeto Unicode.
@end deffn

@geindex _frozen (C struct)
@anchor{c-api/import c _frozen}@anchor{775}
@deffn {C Struct} struct _frozen

@geindex freeze utility

Esta é a definição do tipo de estrutura para descritores de módulo congelados, conforme gerado pelo utilitário @code{freeze} (veja @code{Tools/freeze/} na distribuição fonte do Python). Sua definição, encontrada em @code{Include/import.h}, é:

@example
struct _frozen @{
    const char *name;
    const unsigned char *code;
    int size;
    bool is_package;
@};
@end example


Alterado na versão 3.11: O novo campo @code{is_package} indica se o módulo é um pacote ou não. Isso substitui a configuração do campo @code{size} para um valor negativo.

@end deffn

@geindex PyImport_FrozenModules (C var)
@anchor{c-api/import c PyImport_FrozenModules}@anchor{3000}
@deffn {C Variável} const struct @ref{775,,_frozen} *PyImport_FrozenModules

Este ponteiro é inicializado para apontar para um vetor de registros de @ref{775,,_frozen}, terminado por um cujos membros são todos @code{NULL} ou zero. Quando um módulo congelado é importado, ele é pesquisado nesta tabela. O código de terceiros pode fazer truques com isso para fornecer uma coleção criada dinamicamente de módulos congelados.
@end deffn

@geindex PyImport_AppendInittab (C function)
@anchor{c-api/import c PyImport_AppendInittab}@anchor{18a4}
@deffn {C Função} int PyImport_AppendInittab (const char *name, PyObject *(*initfunc)(void))
` Parte da @ref{553,,ABI Estável}.'
Adiciona um único módulo à tabela existente de módulos embutidos. Este é um invólucro prático em torno de @ref{18a5,,PyImport_ExtendInittab()}, retornando @code{-1} se a tabela não puder ser estendida. O novo módulo pode ser importado pelo nome `name' e usa a função `initfunc' como a função de inicialização chamada na primeira tentativa de importação. Deve ser chamado antes de @ref{8b1,,Py_Initialize()}.
@end deffn

@geindex _inittab (C struct)
@anchor{c-api/import c _inittab}@anchor{4eb3}
@deffn {C Struct} 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{18a5,,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{4eb4}
@deffn {C Membro} 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{4eb5}
@deffn {C Membro} @ref{339,,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{18a5}
@deffn {C Função} 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{4eb4,,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{8b1,,Py_Initialize()}.

Se Python é inicializado várias vezes, @ref{18a4,,PyImport_AppendInittab()} ou @ref{18a5,,PyImport_ExtendInittab()} devem ser chamados antes de cada inicialização do Python.
@end deffn

@geindex PyImport_Inittab (C var)
@anchor{c-api/import c PyImport_Inittab}@anchor{18a3}
@deffn {C Variável} struct @ref{4eb3,,_inittab} *PyImport_Inittab

The table of built-in modules used by Python initialization. Do not use this directly;
use @ref{18a4,,PyImport_AppendInittab()} and @ref{18a5,,PyImport_ExtendInittab()}
instead.
@end deffn

@node Suporte a marshalling de dados,Análise de argumentos e construção de valores,Importando módulos<2>,Utilitários<2>
@anchor{c-api/marshal doc}@anchor{4eb6}@anchor{c-api/marshal data-marshalling-support}@anchor{4eb7}@anchor{c-api/marshal marshalling-utils}@anchor{4eb8}@anchor{c-api/marshal translation-repo}@anchor{4eb9}
@subsection Suporte a `marshalling' de dados


Essas rotinas permitem que o código C trabalhe com objetos serializados usando o mesmo formato de dados que o módulo @ref{8d,,marshal}. Existem funções para gravar dados no formato de serialização e funções adicionais que podem ser usadas para ler os dados novamente. Os arquivos usados para armazenar dados empacotados devem ser abertos no modo binário.

Os valores numéricos são armazenados primeiro com o byte menos significativo.

O módulo oferece suporte a duas versões do formato de dados: a versão 0 é a versão histórica, a versão 1 compartilha strings internas no arquivo e após a desserialização. A versão 2 usa um formato binário para números de ponto flutuante. @code{Py_MARSHAL_VERSION} indica o formato do arquivo atual (atualmente 2).

@geindex PyMarshal_WriteLongToFile (C function)
@anchor{c-api/marshal c PyMarshal_WriteLongToFile}@anchor{796}
@deffn {C Função} void PyMarshal_WriteLongToFile (long value, FILE *file, int version)

Aplica `marshalling' em um inteiro long, `value', para `file'. Isso escreverá apenas os 32 bits menos significativos de `value'; independentemente do tamanho do tipo nativo long. `version' indica o formato do arquivo.

Esta função pode falhar, caso em que define o indicador de erro. Use @ref{1a3b,,PyErr_Occurred()} para verificar isso.
@end deffn

@geindex PyMarshal_WriteObjectToFile (C function)
@anchor{c-api/marshal c PyMarshal_WriteObjectToFile}@anchor{797}
@deffn {C Função} void PyMarshal_WriteObjectToFile (PyObject *value, FILE *file, int version)

Aplica `marshalling' em um objeto Python, `value', para `file'. `version' indica o formato do arquivo.

Esta função pode falhar, caso em que define o indicador de erro. Use @ref{1a3b,,PyErr_Occurred()} para verificar isso.
@end deffn

@geindex PyMarshal_WriteObjectToString (C function)
@anchor{c-api/marshal c PyMarshal_WriteObjectToString}@anchor{799}
@deffn {C Função} @ref{339,,PyObject} *PyMarshal_WriteObjectToString (PyObject *value, int version)
`Retorna valor: Nova referência.'
Retorna um objeto de bytes que contém a representação pós-`marshalling' de `value'. `version' indica o formato do arquivo.
@end deffn

As seguintes funções permitem que os valores pós-`marshalling' sejam lidos novamente.

@geindex PyMarshal_ReadLongFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadLongFromFile}@anchor{4eba}
@deffn {C Função} long PyMarshal_ReadLongFromFile (FILE *file)

Retorna um long C do fluxo de dados em um FILE* aberto para leitura. Somente um valor de 32 bits pode ser lido usando essa função, independentemente do tamanho nativo de long.

Em caso de erro, define a exceção apropriada (@ref{131c,,EOFError}) e retorna @code{-1}.
@end deffn

@geindex PyMarshal_ReadShortFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadShortFromFile}@anchor{4ebb}
@deffn {C Função} int PyMarshal_ReadShortFromFile (FILE *file)

Retorna um short C do fluxo de dados em um FILE* aberto para leitura. Somente um valor de 16 bits pode ser lido usando essa função, independentemente do tamanho nativo de short.

Em caso de erro, define a exceção apropriada (@ref{131c,,EOFError}) e retorna @code{-1}.
@end deffn

@geindex PyMarshal_ReadObjectFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadObjectFromFile}@anchor{4ebc}
@deffn {C Função} @ref{339,,PyObject} *PyMarshal_ReadObjectFromFile (FILE *file)
`Retorna valor: Nova referência.'
Retorna um objeto Python do fluxo de dados em um FILE* aberto para leitura.

Em caso de erro, define a exceção apropriada (@ref{131c,,EOFError}, @ref{202,,ValueError} ou @ref{2c3,,TypeError}) e retorna @code{NULL}.
@end deffn

@geindex PyMarshal_ReadLastObjectFromFile (C function)
@anchor{c-api/marshal c PyMarshal_ReadLastObjectFromFile}@anchor{4ebd}
@deffn {C Função} @ref{339,,PyObject} *PyMarshal_ReadLastObjectFromFile (FILE *file)
`Retorna valor: Nova referência.'
Retorna um objeto Python do fluxo de dados em um FILE* aberto para leitura. Diferentemente de @ref{4ebc,,PyMarshal_ReadObjectFromFile()}, essa função presume que nenhum objeto adicional será lido do arquivo, permitindo que ela carregue agressivamente os dados do arquivo na memória, para que a desserialização possa operar a partir de dados na memória em vez de ler um byte por vez do arquivo. Use essa variante apenas se tiver certeza de que não estará lendo mais nada do arquivo.

Em caso de erro, define a exceção apropriada (@ref{131c,,EOFError}, @ref{202,,ValueError} ou @ref{2c3,,TypeError}) e retorna @code{NULL}.
@end deffn

@geindex PyMarshal_ReadObjectFromString (C function)
@anchor{c-api/marshal c PyMarshal_ReadObjectFromString}@anchor{798}
@deffn {C Função} @ref{339,,PyObject} *PyMarshal_ReadObjectFromString (const char *data, Py_ssize_t len)
`Retorna valor: Nova referência.'
Retorna um objeto Python do fluxo de dados em um buffer de bytes contendo `len' bytes apontados por `data'.

Em caso de erro, define a exceção apropriada (@ref{131c,,EOFError}, @ref{202,,ValueError} ou @ref{2c3,,TypeError}) e retorna @code{NULL}.
@end deffn

@node Análise de argumentos e construção de valores,Conversão e formação de strings,Suporte a marshalling de dados,Utilitários<2>
@anchor{c-api/arg doc}@anchor{4ebe}@anchor{c-api/arg arg-parsing}@anchor{8ad}@anchor{c-api/arg parsing-arguments-and-building-values}@anchor{4ebf}@anchor{c-api/arg translation-repo}@anchor{4ec0}
@subsection Análise de argumentos e construção de valores


Essas funções são úteis ao criar suas próprias funções e métodos de extensão. Informações adicionais e exemplos estão disponíveis em @ref{1d56,,Estendendo e incorporando o interpretador Python}.

As três primeiras funções descritas, @ref{571,,PyArg_ParseTuple()}, @ref{383,,PyArg_ParseTupleAndKeywords()}, e @ref{1b5b,,PyArg_Parse()}, todas usam a `string de formatação' que informam à função sobre os argumentos esperados. As strings de formato usam a mesma sintaxe para cada uma dessas funções.

@menu
* Análise de argumentos: Análise de argumentos<2>. 
* Construindo valores:: 

@end menu

@node Análise de argumentos<2>,Construindo valores,,Análise de argumentos e construção de valores
@anchor{c-api/arg parsing-arguments}@anchor{4ec1}
@subsubsection Análise de argumentos


Uma string de formato consiste em zero ou mais “unidades de formato”. Uma unidade de formato descreve um objeto Python; geralmente é um único caractere ou uma sequência entre parênteses de unidades de formato. Com algumas poucas exceções, uma unidade de formato que não é uma sequência entre parênteses normalmente corresponde a um único argumento de endereço para essas funções. Na descrição a seguir, a forma citada é a unidade de formato; a entrada em parênteses ( ) é o tipo de objeto Python que corresponde à unidade de formato; e a entrada em colchetes [ ] é o tipo da variável(s) C cujo endereço deve ser passado.

@menu
* Strings e buffers:: 
* Números: Números<2>. 
* Outros objetos:: 
* Funções da API:: 

@end menu

@node Strings e buffers,Números<2>,,Análise de argumentos<2>
@anchor{c-api/arg arg-parsing-string-and-buffers}@anchor{38b}@anchor{c-api/arg strings-and-buffers}@anchor{4ec2}
@subsubsection Strings e buffers


@cartouche
@quotation Nota 
No Python 3.12 e anteriores, a macro @code{PY_SSIZE_T_CLEAN} deve ser definida antes da inclusão de @code{Python.h} para usar todas as variantes no formato @code{#} (@code{s#}, @code{y#}, etc.) explicadas abaixo. Isso não é necessário no Python 3.13 e posteriores.
@end quotation
@end cartouche

Esses formatos permitem acessar um objeto como um pedaço contíguo de memória. Você não precisa fornecer armazenamento bruto para a área de unicode ou bytes retornada.

Salvo indicação em contrário, os buffers não são terminados em NUL.

Existem três maneiras pelas quais strings e buffers podem ser convertidos em C:


@itemize *

@item 
Formatos como @code{y*} e @code{s*} estão dentro de uma estrutura @ref{758,,Py_buffer}.  Isso bloqueia o buffer  subjacente para que o chamador  possa posteriormente usar o buffer, mesmo dentro de um bloco @ref{4b67,,Py_BEGIN_ALLOW_THREADS} sem que haja o risco de que dados mutáveis sejam redimensionados ou destruídos. Dessa forma, `você precisa chamar' @ref{39a,,PyBuffer_Release()} depois de ter concluído o processamento de dados (ou em qualquer caso de interrupção precoce).

@item 
Os formatos @code{es}, @code{es#}, @code{et} e @code{et#} alocam o buffer resultante. `Você precisa chamar' @ref{148a,,PyMem_Free()} depois de ter concluído o processamento de dados (ou em qualquer caso de interrupção precoce).

@item @anchor{c-api/arg c-arg-borrowed-buffer}@anchor{4ec3}
Outros formatos usam um @ref{44c,,str} ou um @ref{d4f,,objeto bytes ou similar} somente leitura, como @ref{1c2,,bytes}, e fornecem um ponteiro @code{const char *} para seu buffer. Nesse caso, o buffer é “emprestado”: ele é gerenciado pelo objeto Python correspondente e compartilha o tempo de vida desse objeto. Você mesmo não precisará liberar nenhuma memória.

Para garantir que o buffer subjacente possa ser emprestado com segurança, o campo @ref{763,,PyBufferProcs.bf_releasebuffer} do objeto deve ser @code{NULL}. Isso não permite objetos mutáveis comuns, como @ref{2ea,,bytearray}, mas também alguns objetos somente leitura, como @ref{2eb,,memoryview} ou @ref{1c2,,bytes}.

Além desse requisito @code{bf_releasebuffer}, não há nenhuma verificação para saber se o objeto de entrada é imutável (por exemplo, se ele atenderia a uma solicitação de um buffer gravável ou se outro thread pode alterar os dados).
@end itemize


@table @asis

@item @code{s} (@ref{44c,,str}) [const char *]

Converte um objeto Unicode para um ponteiro em C para uma string. Um ponteiro para uma string existente é armazenado na variável do ponteiro do caractere cujo o endereço que você está passando. A string em C é terminada em NULO. A string no Python não deve conter pontos de código nulo embutidos; se isso acontecer, uma exceção @ref{202,,ValueError} é levantada. Objetos Unicode são convertidos para strings em C usando a codificação @code{'utf-8'}. Se essa conversão falhar, uma exceção @ref{12e6,,UnicodeError} é levantada.

@cartouche
@quotation Nota 
Esse formato não aceita @ref{d4f,,objetos bytes ou similares}. Se você quer aceitar caminhos de sistema de arquivos e convertê-los para strings de caracteres em C, é preferível que use o formato @code{O&} com @ref{d3b,,PyUnicode_FSConverter()} como `conversor'.
@end quotation
@end cartouche


Alterado na versão 3.5: Anteriormente, a exceção @ref{2c3,,TypeError} era levantada quando pontos de código nulo embutidos em string Python eram encontrados.


@item @code{s*} (@ref{44c,,str} ou @ref{d4f,,objeto bytes ou similar}) [Py_buffer]

Esse formato aceita tanto objetos Unicode quanto objetos bytes ou similares. Preenche uma estrutura @ref{758,,Py_buffer} fornecida pelo chamador. Nesse caso, a string em C resultante pode conter bytes NUL embutidos. Objetos Unicode são convertidos para strings em C usando codificação @code{'utf-8'}.

@item @code{s#} (@ref{44c,,str}, @ref{d4f,,objeto bytes ou similar} somente leitura) [const char *, @ref{a69,,Py_ssize_t}]

Como @code{s*}, exceto que não fornece um @ref{4ec3,,buffer emprestado}. O resultado é armazenado em duas variáveis em C, a primeira é um ponteiro para uma string em C, a segunda é o tamanho. A string pode conter bytes nulos embutidos. Objetos Unicode são convertidos para strings em C usando codificação @code{'utf-8'}.

@item @code{z} (@ref{44c,,str} ou @code{None}) [const char *]

Como @code{s}, mas o objeto Python também pode ser @code{None}, caso em que o ponteiro C é definido como @code{NULL}.

@item @code{z*} (@ref{44c,,str}, @ref{d4f,,objeto bytes ou similar} ou @code{None}) [Py_buffer]

Como @code{s*}, mas o objeto Python também pode ser @code{None}, caso em que o membro @code{buf} da estrutura @ref{758,,Py_buffer} é definida como @code{NULL}.

@item @code{z#} (@ref{44c,,str}, @ref{d4f,,objeto bytes ou similar} somente leitura ou @code{None}) [const char *, @ref{a69,,Py_ssize_t}]

Como @code{s#}, mas o objeto Python também pode ser @code{None}, caso em que o ponteiro C é definido como @code{NULL}.

@item @code{y} (@ref{d4f,,objeto bytes ou similar} somente leitura) [const char *]

Este formato converte um objeto bytes ou similar para um ponteiro C para uma string de caracteres @ref{4ec3,,emprestada}; não aceita objetos Unicode. O buffer de bytes não pode conter bytes nulos embutidos; se isso ocorrer uma exceção @ref{202,,ValueError} será levantada.


Alterado na versão 3.5: Anteriormente, a exceção @ref{2c3,,TypeError} era levantada quando pontos de código nulo embutidos em string Python eram encontrados no buffer de bytes.


@item @code{y*} (@ref{d4f,,objeto bytes ou similar}) [Py_buffer]

Esta variante em @code{s*} não aceita objetos unicode, apenas objetos bytes ou similares. `Esta é a maneira recomendada para aceitar dados binários.'

@item @code{y#} (@ref{d4f,,objeto bytes ou similar} somente leitura) [const char *, @ref{a69,,Py_ssize_t}]

Esta variação de @code{s#} não aceita objetos Unicode, apenas objetos bytes ou similares.

@item @code{S} (@ref{1c2,,bytes}) [PyBytesObject *]

Exige que o objeto Python seja um objeto @ref{1c2,,bytes}, sem tentar nenhuma conversão. Levanta @ref{2c3,,TypeError} se o objeto não for um objeto byte. A variável C pode ser declarada como @ref{339,,PyObject}*.

@item @code{Y} (@ref{2ea,,bytearray}) [PyByteArrayObject *]

Exige que o objeto Python seja um objeto @ref{2ea,,bytearray}, sem aceitar qualquer conversão.  Levanta @ref{2c3,,TypeError} se o objeto não é um objeto @ref{2ea,,bytearray}. A variável C apenas pode ser declarada como @ref{339,,PyObject}*.

@item @code{U} (@ref{44c,,str}) [PyObject *]

Exige que o objeto python seja um objeto Unicode, sem tentar alguma conversão. Levanta @ref{2c3,,TypeError} se o objeto não for um objeto Unicode. A variável C deve ser declarada como @ref{339,,PyObject}*.

@item @code{w*} (@ref{d4f,,objeto bytes ou similar} de leitura e escrita) [Py_buffer]

Este formato aceita qualquer objeto que implemente a interface do buffer de leitura e escrita. Ele preenche uma estrutura @ref{758,,Py_buffer} fornecida pelo chamador. O buffer pode conter bytes nulos incorporados. O chamador deve chamar @ref{39a,,PyBuffer_Release()} quando isso for feito com o buffer.

@item @code{es} (@ref{44c,,str}) [const char *encoding, char **buffer]

Esta variante em @code{s} é utilizada para codificação do Unicode em um buffer de caracteres. Ele só funciona para dados codificados sem NUL bytes incorporados.

Este formato exige dois argumentos. O primeiro é usado apenas como entrada e deve ser a const char* que aponta para o nome de uma codificação como uma string terminada em NUL ou @code{NULL}, nesse caso a codificação @code{'utf-8'} é usada. Uma exceção é levantada se a codificação nomeada não for conhecida pelo Python. O segundo argumento deve ser um char**; o valor do ponteiro a que ele faz referência será definido como um buffer com o conteúdo do texto do argumento. O texto será codificado na codificação especificada pelo primeiro argumento.

@ref{571,,PyArg_ParseTuple()} alocará um buffer do tamanho necessário, copiará os dados codificados nesse buffer e ajustará `*buffer' para referenciar o armazenamento recém-alocado. O chamador é responsável por chamar @ref{148a,,PyMem_Free()} para liberar o buffer alocado após o uso.

@item @code{et} (@ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}) [const char *encoding, char **buffer]

O mesmo que @code{es}, exceto que os objetos strings de bytes são passados sem os recodificar. Em vez disso, a implementação presume que o objeto string de bytes usa a codificação passada como parâmetro.

@item @code{es#} (@ref{44c,,str}) [const char *encoding, char **buffer, @ref{a69,,Py_ssize_t} *buffer_length]

Essa variante em @code{s#} é usada para codificar Unicode em um buffer de caracteres. Diferente do formato @code{es}, essa variante permite a entrada de dados que contêm caracteres NUL.

Exige três argumentos. O primeiro é usado apenas como entrada e deve ser a const char* que aponta para o nome de uma codificação como uma string terminada em NUL ou @code{NULL}, nesse caso a codificação @code{'utf-8'} é usada. Uma exceção será gerada se a codificação nomeada não for conhecida pelo Python. O segundo argumento deve ser um char**; o valor do ponteiro a que ele faz referência será definido como um buffer com o conteúdo do texto do argumento. O texto será codificado na codificação especificada pelo primeiro argumento. O terceiro argumento deve ser um ponteiro para um número inteiro; o número inteiro referenciado será definido como o número de bytes no buffer de saída.

Há dois modos de operação:

Se `*buffer' apontar um ponteiro @code{NULL}, a função irá alocar um buffer do tamanho necessário, copiar os dados codificados para dentro desse buffer e configurar `*buffer' para referenciar o novo armazenamento alocado. O chamador é responsável por chamar @ref{148a,,PyMem_Free()} para liberar o buffer alocado após o uso.

Se `*buffer' apontar para um ponteiro que não seja @code{NULL} (um buffer já alocado), @ref{571,,PyArg_ParseTuple()} irá usar essa localização como buffer e interpretar o valor inicial de `*buffer_length' como sendo o tamanho do buffer. Depois ela vai copiar os dados codificados para dentro do buffer e terminá-lo com NUL. Se o buffer não for suficientemente grande, um @ref{202,,ValueError} será definido.

Em ambos os casos, o `*buffer_length' é definido como o comprimento dos dados codificados sem o byte NUL à direita.

@item @code{et#} (@ref{44c,,str}, @ref{1c2,,bytes} ou @ref{2ea,,bytearray}) [const char *encoding, char **buffer, @ref{a69,,Py_ssize_t} *buffer_length]

O mesmo que @code{es#}, exceto que os objetos strings de bytes são passados sem que sejam recodificados. Em vez disso, a implementação presume que o objeto string de bytes usa a codificação passada como parâmetro.
@end table


Alterado na versão 3.12: @code{u}, @code{u#}, @code{Z} e @code{Z#} foram removidos porque usavam uma representação herdada de @code{Py_UNICODE*}.


@node Números<2>,Outros objetos,Strings e buffers,Análise de argumentos<2>
@anchor{c-api/arg numbers}@anchor{4ec4}
@subsubsection Números


Esses formatos permitem representar números Python ou caracteres únicos como números C. Formatos que exigem @ref{257,,int}, @ref{2f7,,float} ou @ref{2f8,,complex} também podem usar os métodos especiais correspondentes @ref{71d,,__index__()}, @ref{9d4,,__float__()} ou @ref{5e7,,__complex__()} para converter o objeto Python para o tipo necessário.

Para formatos inteiros com sinal, @ref{885,,OverflowError} é levantada se o valor estiver fora do intervalo para o tipo C. Para formatos inteiros não assinados, nenhuma verificação de intervalo é feita — os bits mais significativos são silenciosamente truncados quando o campo de recebimento é muito pequeno para receber o valor.


@table @asis

@item @code{b} (@ref{257,,int}) [unsigned char]

Converte um inteiro Python não negativo em um inteiro pequeno sem sinal (unsigned tiny integer), armazenado em um unsigned char do C.

@item @code{B} (@ref{257,,int}) [unsigned char]

Converte um inteiro Python para um inteiro pequeno (tiny integer) sem verificação de estouro, armazenado em um unsigned char do C.

@item @code{h} (@ref{257,,int}) [short int]

Converte um inteiro Python para um short int do C.

@item @code{H} (@ref{257,,int}) [unsigned short int]

Converte um inteiro Python para um unsigned short int do C, sem verificação de estouro.

@item @code{i} (@ref{257,,int}) [int]

Converte um inteiro Python para um int simples do C.

@item @code{I} (@ref{257,,int}) [unsigned int]

Converte um inteiro Python para um unsigned int do C, sem verificação de estouro.

@item @code{l} (@ref{257,,int}) [long int]

Converte um inteiro Python para um long int do C.

@item @code{k} (@ref{257,,int}) [unsigned long]

Converte um inteiro Python para um unsigned long do C sem verificação de estouro.

@item @code{L} (@ref{257,,int}) [longo longo]

Converte um inteiro Python para um long long do C.

@item @code{K} (@ref{257,,int}) [unsigned long long]

Converte um inteiro Python para um unsigned long long do C sem verificação de estouro.

@item @code{n} (@ref{257,,int}) [@ref{a69,,Py_ssize_t}]

Converte um inteiro Python para um @ref{a69,,Py_ssize_t} do C.

@item @code{c} (@ref{1c2,,bytes} ou @ref{2ea,,bytearray} de comprimento 1) [char]

Converte um byte Python, representado com um objeto @code{byte} ou @ref{2ea,,bytearray} de comprimento 1, para um char do C.


Alterado na versão 3.3: Permite objetos @ref{2ea,,bytearray}.


@item @code{C} (@ref{44c,,str} de comprimento 1) [int]

Converte um caractere Python, representado como uma @ref{44c,,str} objeto de comprimento 1, para um int do C

@item @code{f`} (@ref{2f7,,float}) [float]

Converte um número de ponto flutuante Python para um float do C.

@item @code{d} (@ref{2f7,,float}) [double]

Converte um número de ponto flutuante Python para um double do C.

@item @code{D} (@ref{2f8,,complex}) [Py_complex]

Converte um número complexo Python para uma estrutura C @ref{4ec5,,Py_complex}
@end table

@node Outros objetos,Funções da API,Números<2>,Análise de argumentos<2>
@anchor{c-api/arg other-objects}@anchor{4ec6}
@subsubsection Outros objetos



@table @asis

@item @code{O} (objeto) [PyObject*]

Armazena um objeto Python (sem qualquer conversão) em um ponteiro de objeto C. O programa C então recebe o objeto real que foi passado. Uma nova @ref{33d,,referência forte} ao objeto não é criado (isto é sua contagem de referências não é aumentada). O ponteiro armazenado não é @code{NULL}.

@item @code{O!} (objeto) [`typeobject', PyObject *]

Armazena um objeto Python em um ponteiro de objeto C. Isso é similar a @code{O}, mas usa dois argumentos C: o primeiro é o endereço de um objeto do tipo Python, o segundo é um endereço da variável C (de tipo @ref{339,,PyObject}*) no qual o ponteiro do objeto está armazenado. Se o objeto Python não tiver o tipo necessário, @ref{2c3,,TypeError} é levantada.
@end table
@anchor{c-api/arg o-ampersand}@anchor{4ec7}

@table @asis

@item @code{O&} (objeto) [`converter', `address']

Converte um objeto Python em uma variável C através de uma função `converter'. Isso leva dois argumentos: o primeiro é a função, o segundo é o endereço da variável C (de tipo arbitrário), convertendo para void*. A função `converter' por sua vez,  é chamada da seguinte maneira:

@example
status = converter(object, address);
@end example

onde `object' é o objeto Python a ser convertido e `address' é o argumento void* que foi passado para a função @code{PyArg_Parse*}. O `status' retornado deve ser @code{1} para uma conversão bem-sucedida e @code{0} se a conversão falhar. Quando a conversão falha, a função `converter' deve levantar uma exceção e deixar o conteúdo de `address' inalterado.

@geindex Py_CLEANUP_SUPPORTED (C macro)
@anchor{c-api/arg c Py_CLEANUP_SUPPORTED}@anchor{4ec8}
Se o `converter' retornar @code{Py_CLEANUP_SUPPORTED}, ele poderá ser chamado uma segunda vez se a análise do argumento eventualmente falhar, dando ao conversor a chance de liberar qualquer memória que já havia alocado. Nesta segunda chamada, o parâmetro `object' será @code{NULL}; `address' terá o mesmo valor que na chamada original.

Exemplos de conversores: @ref{d3b,,PyUnicode_FSConverter()} e @ref{577,,PyUnicode_FSDecoder()}.


Alterado na versão 3.1: @code{Py_CLEANUP_SUPPORTED} foi adicionado.


@item @code{p} (@ref{468,,bool}) [int]

Testa o valor transmitido para a verdade (um booleano `p'redicado) e converte o resultado em seu valor inteiro C verdadeiro/falso equivalente. Define o int como @code{1} se a expressão for verdadeira e @code{0} se for falsa. Isso aceita qualquer valor válido do Python. Veja @ref{162d,,Teste do valor verdade} para obter mais informações sobre como o Python testa valores para a verdade.


Adicionado na versão 3.3.


@item @code{(items)} (@ref{370,,tuple}) [`matching-items']

O objeto deve ser uma sequência Python cujo comprimento seja o número de unidades de formato em `items'. Os argumentos C devem corresponder às unidades de formato individuais em `items'. As unidades de formato para sequências podem ser aninhadas.
@end table

Alguns outros caracteres possuem significados na string de formatação. Isso pode não ocorrer dentro de parênteses aninhados. Eles são:


@table @asis

@item @code{|}

Indica que os argumentos restantes na lista de argumentos do Python são opcionais. As variáveis C correspondentes a argumentos opcionais devem ser inicializadas para seus valores padrão — quando um argumento opcional não é especificado, @ref{571,,PyArg_ParseTuple()} não toca no conteúdo da(s) variável(eis) C correspondente(s).

@item @code{$}

@ref{383,,PyArg_ParseTupleAndKeywords()} apenas: Indica que os argumentos restantes na lista de argumentos do Python são somente-nomeados. Atualmente, todos os argumentos somente-nomeados devem ser também argumentos opcionais, então @code{|} deve sempre ser especificado antes de @code{$} na string de formatação.


Adicionado na versão 3.3.


@item @code{:}

A lista de unidades de formatação acaba aqui; a string após os dois pontos é usada como o nome da função nas mensagens de erro (o “valor associado” da exceção que @ref{571,,PyArg_ParseTuple()} levanta).

@item @code{;}

A lista de unidades de formatação acaba aqui; a string após o ponto e vírgula é usada como a mensagem de erro `ao invés' da mensagem de erro padrão. @code{:} e @code{;} se excluem mutuamente.
@end table

Note que quaisquer referências a objeto Python que são fornecidas ao chamador são referências `emprestadas'; não libera-as (isto é, não decremente a contagem de referências delas)!

Argumentos adicionais passados para essas funções devem ser endereços de variáveis cujo tipo é determinado pela string de formatação; estes são usados para armazenar valores vindos da tupla de entrada. Existem alguns casos, como descrito na lista de unidades de formatação acima, onde esses parâmetros são usados como valores de entrada; eles devem concordar com o que é especificado para a unidade de formatação correspondente nesse caso.

Para a conversão funcionar, o objeto `arg' deve corresponder ao formato e o formato deve estar completo. Em caso de sucesso, as funções @code{PyArg_Parse*} retornam verdadeiro, caso contrário retornam falso e levantam uma exceção apropriada. Quando as funções @code{PyArg_Parse*} falham devido a uma falha de conversão em uma das unidades de formatação, as variáveis nos endereços correspondentes àquela unidade e às unidades de formatação seguintes são deixadas intocadas.

@node Funções da API,,Outros objetos,Análise de argumentos<2>
@anchor{c-api/arg api-functions}@anchor{4ec9}
@subsubsection Funções da API


@geindex PyArg_ParseTuple (C function)
@anchor{c-api/arg c PyArg_ParseTuple}@anchor{571}
@deffn {C Função} int PyArg_ParseTuple (PyObject *args, const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Analisa os parâmetros de uma função que recebe apenas parâmetros posicionais em variáveis locais. Retorna verdadeiro em caso de sucesso; em caso de falha, retorna falso e levanta a exceção apropriada.
@end deffn

@geindex PyArg_VaParse (C function)
@anchor{c-api/arg c PyArg_VaParse}@anchor{4bfd}
@deffn {C Função} int PyArg_VaParse (PyObject *args, const char *format, va_list vargs)
` Parte da @ref{553,,ABI Estável}.'
Idêntico a @ref{571,,PyArg_ParseTuple()}, exceto que aceita uma va_list ao invés de um número variável de argumentos.
@end deffn

@geindex PyArg_ParseTupleAndKeywords (C function)
@anchor{c-api/arg c PyArg_ParseTupleAndKeywords}@anchor{383}
@deffn {C Função} int PyArg_ParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, ...)
` Parte da @ref{553,,ABI Estável}.'
Analisa os parâmetros de uma função que aceita tanto parâmetros posicionais quando parâmetros nomeados e os converte em variáveis locais. O argumento `keywords' é um array terminado em @code{NULL} de nomes de parâmetros nomeados especificados como strings C codificadas em ASCII ou UTF-8 e terminadas com nulo. Nomes vazios representam @ref{a8f,,parâmetros somente-posicional}. Retorna verdadeiro em caso de sucesso; em caso de falha, retorna falso e levanta a exceção apropriada.

@cartouche
@quotation Nota 
A declaração do parâmetro `keywords' é char *const* em C e const char *const* em C++. Isso pode ser substituído com a macro  @ref{385,,PY_CXX_CONST}.
@end quotation
@end cartouche


Alterado na versão 3.6: Adicionado suporte para @ref{a8f,,positional-only parameters}.



Alterado na versão 3.13: O parâmetro `keywords' é agora do tipo char *const* em C e const char *const* em C++, no lugar de char**. Adicionado suporte para nomes de parâmetros nomeados não-ASCII.

@end deffn

@geindex PyArg_VaParseTupleAndKeywords (C function)
@anchor{c-api/arg c PyArg_VaParseTupleAndKeywords}@anchor{384}
@deffn {C Função} int PyArg_VaParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, va_list vargs)
` Parte da @ref{553,,ABI Estável}.'
Idêntico a @ref{383,,PyArg_ParseTupleAndKeywords()}, exceto que aceita uma va_list ao invés de um número variável de argumentos.
@end deffn

@geindex PyArg_ValidateKeywordArguments (C function)
@anchor{c-api/arg c PyArg_ValidateKeywordArguments}@anchor{4bfe}
@deffn {C Função} int PyArg_ValidateKeywordArguments (PyObject*)
` Parte da @ref{553,,ABI Estável}.'
Garante que as chaves no dicionário de argumento de palavras reservadas são strings. Isso só é necessário se @ref{383,,PyArg_ParseTupleAndKeywords()} não é usado, já que o último já faz essa checagem.


Adicionado na versão 3.2.

@end deffn

@geindex PyArg_Parse (C function)
@anchor{c-api/arg c PyArg_Parse}@anchor{1b5b}
@deffn {C Função} int PyArg_Parse (PyObject *args, const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Analisa o parâmetro de uma função que recebe um único parâmetro posicional e o converte em uma variável local. Retorna verdadeiro em caso de sucesso; em caso de falha, retorna falso e levanta a exceção apropriada.

Exemplo:

@example
// Função usando a convenção de chamada ao método METH_O
static PyObject*
my_function(PyObject *module, PyObject *arg)
@{
    int value;
    if (!PyArg_Parse(arg, "i:my_function", &value)) @{
        return NULL;
    @}
    // ... usar valor ...
@}
@end example
@end deffn

@geindex PyArg_UnpackTuple (C function)
@anchor{c-api/arg c PyArg_UnpackTuple}@anchor{154f}
@deffn {C Função} int PyArg_UnpackTuple (PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
` Parte da @ref{553,,ABI Estável}.'
Uma forma mais simples de recuperação de parâmetro que não usa uma string de formato para especificar os tipos de argumentos. Funções que usam este método para recuperar seus parâmetros devem ser declaradas como @ref{1551,,METH_VARARGS} em tabelas de função ou método. A tupla contendo os parâmetros reais deve ser passada como `args'; deve realmente ser uma tupla. O comprimento da tupla deve ser de pelo menos `min' e não mais do que `max'; `min' e `max' podem ser iguais. Argumentos adicionais devem ser passados para a função, cada um dos quais deve ser um ponteiro para uma variável @ref{339,,PyObject}*; eles serão preenchidos com os valores de `args'; eles conterão @ref{33e,,referências emprestadas}. As variáveis que correspondem a parâmetros opcionais não fornecidos por `args' não serão preenchidas; estes devem ser inicializados pelo chamador. Esta função retorna verdadeiro em caso de sucesso e falso se `args' não for uma tupla ou contiver o número incorreto de elementos; uma exceção será definida se houver uma falha.

Este é um exemplo do uso dessa função, tirado das fontes do módulo auxiliar para referências fracas @code{_weakref}:

@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

A chamada à @ref{154f,,PyArg_UnpackTuple()} neste exemplo é inteiramente equivalente à chamada para @ref{571,,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{385}
@deffn {C Macro} PY_CXX_CONST

O valor para ser inserido, se houver, antes de char *const* na declaração do parâmetro `keywords' das funções  @ref{383,,PyArg_ParseTupleAndKeywords()} e @ref{384,,PyArg_VaParseTupleAndKeywords()}. Por padrão, é vazio para C e @code{const} for C++ (const char *const*). Para substituir, defina o valor desejado antes de incluir @code{Python.h}.


Adicionado na versão 3.13.

@end deffn

@node Construindo valores,,Análise de argumentos<2>,Análise de argumentos e construção de valores
@anchor{c-api/arg building-values}@anchor{4eca}
@subsubsection Construindo valores


@geindex Py_BuildValue (C function)
@anchor{c-api/arg c Py_BuildValue}@anchor{8ac}
@deffn {C Função} @ref{339,,PyObject} *Py_BuildValue (const char *format, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um novo valor baseado em uma string de formatação similar àquelas aceitas pela família de funções @code{PyArg_Parse*} e uma sequência de valores. Retorna o valor ou @code{NULL} em caso de erro; uma exceção será levantada se @code{NULL} for retornado.

@ref{8ac,,Py_BuildValue()} não constrói sempre uma tupla. Ela constrói uma tupla apenas se a sua string de formatação contém duas ou mais unidades de formatação. Se a string de formatação estiver vazia, ela retorna @code{None}; se ela contém exatamente uma unidade de formatação, ela retorna qualquer que seja o objeto que for descrito pela unidade de formatação. Para forçar ela a retornar uma tupla de tamanho 0 ou um, use parênteses na string de formatação.

Quando buffers de memória são passados como parâmetros para fornecer dados para construir objetos, como nos formatos @code{s} e @code{s#}, os dados necessários são copiados. Buffers fornecidos pelo chamador nunca são referenciados pelos objetos criados por @ref{8ac,,Py_BuildValue()}. Em outras palavras, se o seu código invoca @code{malloc()} e passa a memória alocada para @ref{8ac,,Py_BuildValue()}, seu código é responsável por chamar @code{free()} para aquela memória uma vez que @ref{8ac,,Py_BuildValue()} tiver retornado.

Na descrição a seguir, a forma entre aspas é a unidade de formatação; a entrada em parênteses (arredondado) é o tipo do objeto Python que a unidade de formatação irá retornar; e a entrada em colchetes [quadrado] é o tipo do(s) valor(es) C a ser(em) passado(s).

Os caracteres de espaço, tab, dois pontos e vírgula são ignorados em strings de formatação (mas não dentro de unidades de formatação como @code{s#}). Isso pode ser usado para tornar strings de formatação longas um pouco mais legíveis.


@table @asis

@item @code{s} (@ref{44c,,str} ou @code{None}) [const char *]

Converte uma string C terminada em NULL em um objeto Python @ref{44c,,str} usando codificação @code{'utf-8'}. Se o ponteiro da string C é @code{NULL}, @code{None} é usado.

@item @code{s#} (@ref{44c,,str} ou @code{None}) [const char *, @ref{a69,,Py_ssize_t}]

Converte uma string C e seu comprimento em um objeto Python @ref{44c,,str} usando a codificação @code{'utf-8'}. Se o ponteiro da string C é @code{NULL}, o comprimento é ignorado e @code{None} é retornado.

@item @code{y} (@ref{1c2,,bytes}) [const char *]

Isso converte uma string C para um objeto Python @ref{1c2,,bytes}. Se o ponteiro da string C é @code{NULL}, @code{None} é retornado.

@item @code{y#} (@ref{1c2,,bytes}) [const char *, @ref{a69,,Py_ssize_t}]

Isso converte uma string C e seu comprimento para um objeto Python. Se o ponteiro da string C é @code{NULL}, @code{None} é retornado.

@item @code{z} (@ref{44c,,str} ou @code{None}) [const char *]

O mesmo de @code{s}.

@item @code{z#} (@ref{44c,,str} ou @code{None}) [const char *, @ref{a69,,Py_ssize_t}]

O mesmo de @code{s#}.

@item @code{u} (@ref{44c,,str}) [const wchar_t *]

Converte um buffer terminado por null @code{wchar_t} de dados Unicode (UTF-16 ou UCS-4) para um objeto Python Unicode. Se o ponteiro do buffer Unicode é @code{NULL}, @code{None} é retornado.

@item @code{u#} (@ref{44c,,str}) [const wchar_t *, @ref{a69,,Py_ssize_t}]

Converte um buffer de dados Unicode (UTF-17 ou UCS-4) e seu comprimento em um objeto Python Unicode. Se o ponteiro do buffer Unicode é @code{NULL}, o comprimento é ignorado e @code{None} é retornado.

@item @code{U} (@ref{44c,,str} ou @code{None}) [const char *]

O mesmo de @code{s}.

@item @code{U#} (@ref{44c,,str} ou @code{None}) [const char *, @ref{a69,,Py_ssize_t}]

O mesmo de @code{s#}.

@item @code{i} (@ref{257,,int}) [int]

Converte um simples int do C em um objeto inteiro do Python.

@item @code{b} (@ref{257,,int}) [char]

Converte um simples char do C em um objeto inteiro do Python.

@item @code{h} (@ref{257,,int}) [short int]

Converte um simples short int do C em um objeto inteiro do Python.

@item @code{l} (@ref{257,,int}) [long int]

Converte um long int do C em um objeto inteiro do Python.

@item @code{B} (@ref{257,,int}) [unsigned char]

Converte um unsigned char do C em um objeto inteiro do Python.

@item @code{H} (@ref{257,,int}) [unsigned short int]

Converte um unsigned short int do C em um objeto inteiro do Python.

@item @code{I} (@ref{257,,int}) [unsigned int]

Converte um unsigned int do C em um objeto inteiro do Python.

@item @code{k} (@ref{257,,int}) [unsigned long]

Converte um unsigned long do C em um objeto inteiro do Python.

@item @code{L} (@ref{257,,int}) [longo longo]

Converte um long long do C em um objeto inteiro do Python.
@end table
@anchor{c-api/arg capi-py-buildvalue-format-k}@anchor{163a}

@table @asis

@item @code{K} (@ref{257,,int}) [unsigned long long]

Converte um unsigned long long do C em um objeto inteiro do Python.

@item @code{n} (@ref{257,,int}) [@ref{a69,,Py_ssize_t}]

Converte um @ref{a69,,Py_ssize_t} do C em um objeto inteiro do Python.

@item @code{c} (@ref{1c2,,bytes} de comprimento 1) [char]

Converte um int representando um byte do C em um objeto @ref{1c2,,bytes} de comprimento 1 do Python.

@item @code{C} (@ref{44c,,str} de comprimento 1) [int]

Converte um int representando um caractere do C em um objeto @ref{44c,,str} de comprimento 1 do Python.

@item @code{d} (@ref{2f7,,float}) [double]

Converte um double do C em um número ponto flutuante do Python.

@item @code{f`} (@ref{2f7,,float}) [float]

Converte um float do C em um número ponto flutuante do Python.

@item @code{D} (@ref{2f8,,complex}) [Py_complex *]

Converte uma estrutura @ref{4ec5,,Py_complex} do C em um número complexo do Python.

@item @code{O} (objeto) [PyObject*]

Passa um objeto Python intocado, mas cria uma nova @ref{33d,,referência forte} a ele (isto é, sua contagem de referências é incrementada por um). Se o objeto passado é um ponteiro @code{NULL}, presume-se que isso foi causado porque a chamada que produziu o argumento encontrou um erro e definiu uma exceção. Portanto, @ref{8ac,,Py_BuildValue()} irá retornar @code{NULL} mas não irá levantar uma exceção. Se nenhuma exceção foi levantada ainda, @ref{575,,SystemError} é definida.

@item @code{S} (objeto) [PyObject *]

O mesmo que @code{O}.

@item @code{N} (objeto) [PyObject *]

O mesmo que @code{O}, exceto que não cria uma nova @ref{33d,,referência forte}. Útil quando o objeto é criado por uma chamada a um construtor de objeto na lista de argumento.

@item @code{O&} (objeto) [`converter', `anything']

Converte `anything' para um objeto Python através de uma função `converter'. A função é chamada com `anything' (que deve ser compatível com o void*) como argumento e deve retornar um “novo” objeto Python, ou @code{NULL} se um erro ocorreu.

@item @code{(items)} (@ref{370,,tuple}) [`matching-items']

Converte uma sequência de valores C para uma tupla Python com o mesmo número de itens.

@item @code{[items]} (@ref{611,,list}) [`matching-items']

Converte uma sequência de valores C para uma lista Python com o mesmo número de itens.

@item @code{@{items@}} (@ref{256,,dict}) [`matching-items']

Converte uma sequência de valores C para um dicionário Python. Cada par de valores consecutivos do C adiciona um item ao dicionário, servindo como chave e valor, respectivamente.
@end table

Se existir um erro na string de formatação, a exceção @ref{575,,SystemError} é definida e @code{NULL} é retornado.
@end deffn

@geindex Py_VaBuildValue (C function)
@anchor{c-api/arg c Py_VaBuildValue}@anchor{4de0}
@deffn {C Função} @ref{339,,PyObject} *Py_VaBuildValue (const char *format, va_list vargs)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Idêntico a @ref{8ac,,Py_BuildValue()}, exceto que aceita uma va_list ao invés de um número variável de argumentos.
@end deffn

@node Conversão e formação de strings,Classificação e conversão de caracteres,Análise de argumentos e construção de valores,Utilitários<2>
@anchor{c-api/conversion doc}@anchor{4ecb}@anchor{c-api/conversion string-conversion}@anchor{4ecc}@anchor{c-api/conversion string-conversion-and-formatting}@anchor{4ecd}@anchor{c-api/conversion translation-repo}@anchor{4ece}
@subsection Conversão e formação de strings


Funções para conversão de números e saída formatada de strings.

@geindex PyOS_snprintf (C function)
@anchor{c-api/conversion c PyOS_snprintf}@anchor{1552}
@deffn {C Função} int PyOS_snprintf (char *str, size_t size, const char *format, ...)
` Parte da @ref{553,,ABI Estável}.'
Saída não superior a `size' bytes para `str' de acordo com a string de formato `format' e os argumentos extras. Veja a página man do 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{1553}
@deffn {C Função} int PyOS_vsnprintf (char *str, size_t size, const char *format, va_list va)
` Parte da @ref{553,,ABI Estável}.'
Saída não superior a `size' bytes para `str' de acordo com o string de formato `format' e a variável argumento de lista `va'. Página man do Unix @code{vsnprintf(3)@footnote{https://manpages.debian.org/vsnprintf(3)}}.
@end deffn

@ref{1552,,PyOS_snprintf()} e @ref{1553,,PyOS_vsnprintf()} envolvem as funções @code{snprintf()} e @code{vsnprintf()} da biblioteca Standard C. Seu objetivo é garantir um comportamento consistente em casos extremos, o que as funções do Standard C não garantem.

Os invólucros garantem que @code{str[size-1]} seja sempre @code{'\0'} no retorno. Eles nunca escrevem mais do que `size' bytes (incluindo o @code{'\0'} ao final) em str. Ambas as funções exigem que @code{str != NULL}, @code{size > 0}, @code{format != NULL} e @code{size < INT_MAX}. Note que isso significa que não há equivalente ao @code{n = snprintf(NULL, 0, ...)} do C99 que determinaria o tamanho de buffer necessário.

O valor de retorno (`rv') para essas funções deve ser interpretado da seguinte forma:


@itemize *

@item 
Quando @code{0 <= rv < size}, a conversão de saída foi bem-sucedida e os caracteres de `rv' foram escritos em `str' (excluindo o @code{'\0'} byte em @code{str[rv]}).

@item 
Quando @code{rv >= size}, a conversão de saída foi truncada e um buffer com @code{rv + 1} bytes teria sido necessário para ter sucesso. @code{str[size-1]} é @code{'\0'} neste caso.

@item 
Quando @code{rv < 0}, a conversão da saída falhou e @code{str[size-1]} é @code{'\0'} neste caso também, mas o resto de `str' é indefinido. A causa exata do erro depende da plataforma subjacente.
@end itemize

As funções a seguir fornecem strings independentes de localidade para conversões de números.

@geindex PyOS_strtoul (C function)
@anchor{c-api/conversion c PyOS_strtoul}@anchor{4d22}
@deffn {C Função} unsigned long PyOS_strtoul (const char *str, char **ptr, int base)
` Parte da @ref{553,,ABI Estável}.'
Converte a parte inicial da string em @code{str} para um valor unsigned long de acordo com a @code{base} fornecida, que deve estar entre @code{2} e @code{36} inclusive, ou ser o valor especial @code{0}.

Espaços em branco iniciais e diferenciação entre caracteres maiúsculos e minúsculos são ignorados. Se @code{base} for zero, procura um @code{0b}, @code{0o} ou @code{0x} inicial para informar qual base. Se estes estiverem ausentes, o padrão é @code{10}. Base deve ser 0 ou entre 2 e 36 (inclusive). Se @code{ptr} não for @code{NULL}, conterá um ponteiro para o fim da varredura.

Se o valor convertido ficar fora do intervalo do tipo de retorno correspondente, ocorrerá um erro de intervalo (@code{errno} é definido como @code{ERANGE}) e @code{ULONG_MAX} será retornado. Se nenhuma conversão puder ser realizada, @code{0} será retornado.

Veja também a página man do Unix @code{strtoul(3)@footnote{https://manpages.debian.org/strtoul(3)}}.


Adicionado na versão 3.2.

@end deffn

@geindex PyOS_strtol (C function)
@anchor{c-api/conversion c PyOS_strtol}@anchor{4d21}
@deffn {C Função} long PyOS_strtol (const char *str, char **ptr, int base)
` Parte da @ref{553,,ABI Estável}.'
Converte a parte inicial da string em @code{str} para um valor long de acordo com a @code{base} fornecida, que deve estar entre @code{2} e @code{36} inclusive, ou ser o valor especial @code{0}.

O mesmo que @ref{4d22,,PyOS_strtoul()}, mas retorna um valor long e @code{LONG_MAX} em caso de estouro.

Veja também a página man do Unix @code{strtol(3)@footnote{https://manpages.debian.org/strtol(3)}}.


Adicionado na versão 3.2.

@end deffn

@geindex PyOS_string_to_double (C function)
@anchor{c-api/conversion c PyOS_string_to_double}@anchor{12d7}
@deffn {C Função} double PyOS_string_to_double (const char *s, char **endptr, PyObject *overflow_exception)
` Parte da @ref{553,,ABI Estável}.'
Converte uma string @code{s} em double, levantando uma exceção Python em caso de falha. O conjunto de strings aceitas corresponde ao conjunto de strings aceito pelo construtor @ref{2f7,,float()} do Python, exceto que @code{s} não deve ter espaços em branco à esquerda ou à direita. A conversão é independente da localidade atual.

Se @code{endptr} for @code{NULL}, converte a string inteira. Levanta @ref{202,,ValueError} e retorna @code{-1.0} se a string não for uma representação válida de um número de ponto flutuante.

Se endptr não for @code{NULL}, converte o máximo possível da string e define @code{*endptr} para apontar para o primeiro caractere não convertido. Se nenhum segmento inicial da string for a representação válida de um número de ponto flutuante, define @code{*endptr} para apontar para o início da string, levanta ValueError e retorna @code{-1.0}.

Se @code{s} representa um valor que é muito grande para armazenar em um ponto flutuante (por exemplo, @code{"1e500"} é uma string assim em muitas plataformas), então se @code{overflow_exception} for @code{NULL} retorna @code{Py_HUGE_VAL} (com um sinal apropriado) e não define nenhuma exceção. Caso contrário, @code{overflow_exception} deve apontar para um objeto de exceção Python; levanta essa exceção e retorna @code{-1.0}. Em ambos os casos, define @code{*endptr} para apontar para o primeiro caractere após o valor convertido.

Se qualquer outro erro ocorrer durante a conversão (por exemplo, um erro de falta de memória), define a exceção Python apropriada e retorna @code{-1.0}.


Adicionado na versão 3.1.

@end deffn

@geindex PyOS_double_to_string (C function)
@anchor{c-api/conversion c PyOS_double_to_string}@anchor{4d1f}
@deffn {C Função} char *PyOS_double_to_string (double val, char format_code, int precision, int flags, int *ptype)
` Parte da @ref{553,,ABI Estável}.'
Converte um `val' double para uma string usando `format_code', `precision' e `flags' fornecidos.

`format_code' deve ser um entre @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} ou @code{'r'}. Para @code{'r'}, a precisão `precision' fornecida deve ser 0 e é ignorada. O código de formato @code{'r'} especifica o formato padrão de @ref{800,,repr()}.

`flags' podem ser zero ou mais dos seguintes valores combinados por meio do operador OR:

@geindex Py_DTSF_SIGN (C macro)
@anchor{c-api/conversion c Py_DTSF_SIGN}@anchor{4ecf}
@deffn {C Macro} Py_DTSF_SIGN

Sempre preceda a string retornada com um caractere de sinal, mesmo que `val' não seja negativo.
@end deffn

@geindex Py_DTSF_ADD_DOT_0 (C macro)
@anchor{c-api/conversion c Py_DTSF_ADD_DOT_0}@anchor{4ed0}
@deffn {C Macro} Py_DTSF_ADD_DOT_0

Garante que a string retornada não se pareça com um número inteiro.
@end deffn

@geindex Py_DTSF_ALT (C macro)
@anchor{c-api/conversion c Py_DTSF_ALT}@anchor{4ed1}
@deffn {C Macro} Py_DTSF_ALT

Aplica as regras de formatação “alternativas”. Veja a documentação para o especificador @code{'#'} de @ref{1552,,PyOS_snprintf()} para detalhes.
@end deffn

@geindex Py_DTSF_NO_NEG_0 (C macro)
@anchor{c-api/conversion c Py_DTSF_NO_NEG_0}@anchor{4ed2}
@deffn {C Macro} Py_DTSF_NO_NEG_0

Zero negativo é convertido para zerp positivo.


Adicionado na versão 3.11.

@end deffn

If `ptype' is non-@code{NULL}, then the value it points to will be set to one
of the following constants depending on the type of `val':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`*ptype'

@tab

type of `val'

@item

@geindex Py_DTST_FINITE (C macro)
@anchor{c-api/conversion c Py_DTST_FINITE}@anchor{4ed3}
@deffn {C Macro} Py_DTST_FINITE
@end deffn

@tab

finite number

@item

@geindex Py_DTST_INFINITE (C macro)
@anchor{c-api/conversion c Py_DTST_INFINITE}@anchor{4ed4}
@deffn {C Macro} Py_DTST_INFINITE
@end deffn

@tab

infinite number

@item

@geindex Py_DTST_NAN (C macro)
@anchor{c-api/conversion c Py_DTST_NAN}@anchor{4ed5}
@deffn {C Macro} Py_DTST_NAN
@end deffn

@tab

not a number

@end multitable


O valor de retorno é um ponteiro para `buffer' com a string convertida ou @code{NULL} se a conversão falhou. O chamador é responsável por liberar a string retornada chamando @ref{148a,,PyMem_Free()}.


Adicionado na versão 3.1.

@end deffn

@geindex PyOS_mystricmp (C function)
@geindex PyOS_mystrnicmp (C function)
@anchor{c-api/conversion c PyOS_mystricmp}@anchor{1ac8}
@deffn {C Função} int PyOS_mystricmp (const char *str1, const char *str2)
@anchor{c-api/conversion c PyOS_mystrnicmp}@anchor{1ac7}
@deffnx {C Função} int PyOS_mystrnicmp (const char *str1, const char *str2, Py_ssize_t size)
` Parte da @ref{553,,ABI Estável}.'
Comparação de strings sem distinção entre maiúsculas e minúsculas. Essas funções funcionam de maneira quase idêntica a @code{strcmp()} e @code{strncmp()} (respectivamente), exceto pelo fato de ignorarem maiúsculas e minúsculas em caracteres ASCII.

Retorna @code{0} se as strings forem iguais, um valor negativo se `str1' for ordenada lexicograficamente antes de `str2', ou um valor positivo se for ordenada depois.

Nos argumentos `str1' ou `str2', um byte NUL marca o fim da string. Para @code{PyOS_mystrnicmp()}, o argumento `size' fornece o tamanho máximo da string, como se NUL estivesse presente no índice fornecido por `size'.

Estas funções não usam a localidade.
@end deffn

@geindex PyOS_stricmp (C function)
@geindex PyOS_strnicmp (C function)
@anchor{c-api/conversion c PyOS_stricmp}@anchor{4ed6}
@deffn {C Função} int PyOS_stricmp (const char *str1, const char *str2)
@anchor{c-api/conversion c PyOS_strnicmp}@anchor{4ed7}
@deffnx {C Função} int PyOS_strnicmp (const char *str1, const char *str2, Py_ssize_t size)

Comparação de strings sem distinção entre maiúsculas e minúsculas.

No Windows, estes são apelidos de @code{stricmp()} e @code{strnicmp()}, respectivamente.

Em outras plataformas, são apelidos de @ref{1ac8,,PyOS_mystricmp()} e @ref{1ac7,,PyOS_mystrnicmp()}, respectivamente.
@end deffn

@node Classificação e conversão de caracteres,API do PyHash,Conversão e formação de strings,Utilitários<2>
@anchor{c-api/conversion character-classification-and-conversion}@anchor{4ed8}
@subsection Classificação e conversão de caracteres


As macros a seguir fornecem classificação e conversão de caracteres independentes de localidade (ao contrário da biblioteca padrão C @code{ctype.h}). O argumento deve ser um char com ou sem sinal.

@geindex Py_ISALNUM (C macro)
@anchor{c-api/conversion c Py_ISALNUM}@anchor{1397}
@deffn {C Macro} Py_ISALNUM (c)

Retorna verdadeiro se o caractere `c' for um caractere alfanumérico.
@end deffn

@geindex Py_ISALPHA (C macro)
@anchor{c-api/conversion c Py_ISALPHA}@anchor{1398}
@deffn {C Macro} Py_ISALPHA (c)

Retorna verdadeiro se o caractere `c' for um caractere alfabético (@code{a-z} e @code{A-Z}).
@end deffn

@geindex Py_ISDIGIT (C macro)
@anchor{c-api/conversion c Py_ISDIGIT}@anchor{1399}
@deffn {C Macro} Py_ISDIGIT (c)

Retorna verdadeiro se o caractere `c' for um dígito decimal (@code{0-9}).
@end deffn

@geindex Py_ISLOWER (C macro)
@anchor{c-api/conversion c Py_ISLOWER}@anchor{139a}
@deffn {C Macro} Py_ISLOWER (c)

Retorna verdadeiro se o caractere `c' for uma letra minúscula do ASCII (@code{a-z}).
@end deffn

@geindex Py_ISUPPER (C macro)
@anchor{c-api/conversion c Py_ISUPPER}@anchor{139c}
@deffn {C Macro} Py_ISUPPER (c)

Retorna verdadeiro se o caractere `c' for uma letra maiúscula do ASCII (@code{A-Z}).
@end deffn

@geindex Py_ISSPACE (C macro)
@anchor{c-api/conversion c Py_ISSPACE}@anchor{139b}
@deffn {C Macro} Py_ISSPACE (c)

Retorna verdadeiro se o caractere `c' for um caractere de espaço em branco (espaço, tabulação, retorno de carro, nova linha, tabulação vertical ou alimentação de formulário).
@end deffn

@geindex Py_ISXDIGIT (C macro)
@anchor{c-api/conversion c Py_ISXDIGIT}@anchor{139d}
@deffn {C Macro} Py_ISXDIGIT (c)

Retorna verdadeiro se o caractere `c' for um dígito hexadecimal (@code{0-9}, @code{a-f} e @code{A-F}).
@end deffn

@geindex Py_TOLOWER (C macro)
@anchor{c-api/conversion c Py_TOLOWER}@anchor{139e}
@deffn {C Macro} Py_TOLOWER (c)

Retorna o equivalente em minúsculas do caractere `c'.
@end deffn

@geindex Py_TOUPPER (C macro)
@anchor{c-api/conversion c Py_TOUPPER}@anchor{139f}
@deffn {C Macro} Py_TOUPPER (c)

Retorna o equivalente em maiúsculas do caractere `c'.
@end deffn

@node API do PyHash,Reflexão,Classificação e conversão de caracteres,Utilitários<2>
@anchor{c-api/hash doc}@anchor{4ed9}@anchor{c-api/hash pyhash-api}@anchor{4eda}@anchor{c-api/hash translation-repo}@anchor{4edb}
@subsection API do PyHash


Veja também o membro @ref{4b9f,,PyTypeObject.tp_hash} e @ref{2335,,Hashing de tipos numéricos}.

@geindex Py_hash_t (C type)
@anchor{c-api/hash c Py_hash_t}@anchor{12a5}
@deffn {C Tipo} type Py_hash_t

Tipo de valor do hash: inteiro com sinal.


Adicionado na versão 3.2.

@end deffn

@geindex Py_uhash_t (C type)
@anchor{c-api/hash c Py_uhash_t}@anchor{4edc}
@deffn {C Tipo} type Py_uhash_t

Tipo de valor do hash: inteiro sem sinal.


Adicionado na versão 3.2.

@end deffn

@geindex Py_HASH_ALGORITHM (C macro)
@anchor{c-api/hash c Py_HASH_ALGORITHM}@anchor{4edd}
@deffn {C Macro} Py_HASH_ALGORITHM

Um valor numérico que indica o algoritmo de hash para @ref{44c,,str}, @ref{1c2,,bytes} e @ref{2eb,,memoryview}.

O nome do algoritmo é exposto por @ref{45c2,,sys.hash_info.algorithm}.


Adicionado na versão 3.4.

@end deffn

@geindex Py_HASH_FNV (C macro)
@geindex Py_HASH_SIPHASH24 (C macro)
@geindex Py_HASH_SIPHASH13 (C macro)
@anchor{c-api/hash c Py_HASH_FNV}@anchor{4ede}
@deffn {C Macro} Py_HASH_FNV
@anchor{c-api/hash c Py_HASH_SIPHASH24}@anchor{4edf}
@deffnx {C Macro} Py_HASH_SIPHASH24
@anchor{c-api/hash c Py_HASH_SIPHASH13}@anchor{4ee0}
@deffnx {C Macro} Py_HASH_SIPHASH13

Valores numéricos a serem comparados com @ref{4edd,,Py_HASH_ALGORITHM} para determinar qual algoritmo é usado para o hashing. O algoritmo de hash pode ser configurado através da opção @ref{1f4b,,--with-hash-algorithm} do comando configure.


Adicionado na versão 3.4: Adiciona @code{Py_HASH_FNV} e @code{Py_HASH_SIPHASH24}.



Adicionado na versão 3.11: Adiciona @code{Py_HASH_SIPHASH13}.

@end deffn

@geindex Py_HASH_CUTOFF (C macro)
@anchor{c-api/hash c Py_HASH_CUTOFF}@anchor{4ee1}
@deffn {C Macro} Py_HASH_CUTOFF

Buffers de comprimento no intervalo @code{[1, Py_HASH_CUTOFF)} são hasheados usando DJBX33A em vez do algoritmo descrito por @ref{4edd,,Py_HASH_ALGORITHM}.


@itemize -

@item 
Uma @code{Py_HASH_CUTOFF} de 0 desabilita a otimização.

@item 
@code{Py_HASH_CUTOFF} deve ser não-negativo ou menor ou igual a 7.
@end itemize

Plataformas de 32 bits devem usar um limite de corte menor do que plataformas de 64 bits, pois é mais fácil criar strings que colidam. Um limite de corte de 7 em plataformas de 64 bits e 5 em plataformas de 32 bits deve fornecer uma margem de segurança adequada.

Isso corresponde à constante @ref{45c5,,sys.hash_info.cutoff}.


Adicionado na versão 3.4.

@end deffn

@geindex PyHASH_MODULUS (C macro)
@anchor{c-api/hash c PyHASH_MODULUS}@anchor{175f}
@deffn {C Macro} PyHASH_MODULUS

O primo de Mersenne@footnote{https://pt.wikipedia.org/wiki/Primo_de_Mersenne} @code{P = 2**n -1}, usado para esquema de hash numérico.

Isso corresponde à constante @ref{2336,,sys.hash_info.modulus}.


Adicionado na versão 3.13.

@end deffn

@geindex PyHASH_BITS (C macro)
@anchor{c-api/hash c PyHASH_BITS}@anchor{1760}
@deffn {C Macro} PyHASH_BITS

O expoente @code{n} de @code{P} em @ref{175f,,PyHASH_MODULUS}.


Adicionado na versão 3.13.

@end deffn

@geindex PyHASH_MULTIPLIER (C macro)
@anchor{c-api/hash c PyHASH_MULTIPLIER}@anchor{170c}
@deffn {C Macro} PyHASH_MULTIPLIER

Multiplicador de primo usado em strings e vários outros hashes.


Adicionado na versão 3.13.

@end deffn

@geindex PyHASH_INF (C macro)
@anchor{c-api/hash c PyHASH_INF}@anchor{1761}
@deffn {C Macro} PyHASH_INF

O valor de hash retornado para um infinito positivo.

Isso corresponde à constante @ref{45bf,,sys.hash_info.inf}.


Adicionado na versão 3.13.

@end deffn

@geindex PyHASH_IMAG (C macro)
@anchor{c-api/hash c PyHASH_IMAG}@anchor{1762}
@deffn {C Macro} PyHASH_IMAG

O multiplicador usado para a parte imaginária de um número complexo.

Isso corresponde à constante @ref{45c1,,sys.hash_info.imag}.


Adicionado na versão 3.13.

@end deffn

@geindex PyHash_FuncDef (C type)
@anchor{c-api/hash c PyHash_FuncDef}@anchor{4ee2}
@deffn {C Tipo} type PyHash_FuncDef

Definição de função de hash usada por @ref{4ee3,,PyHash_GetFuncDef()}.

@geindex PyHash_FuncDef.hash (C member)
@anchor{c-api/hash c PyHash_FuncDef hash}@anchor{4ee4}
@deffn {C Membro} @ref{12a5,,Py_hash_t} (*const hash)(const void*, @ref{a69,,Py_ssize_t})

Função de hash.
@end deffn

@geindex PyHash_FuncDef.name (C member)
@anchor{c-api/hash c PyHash_FuncDef name}@anchor{4ee5}
@deffn {C Membro} const char *name

Nome de função hash (string codificada em UTF-8).

Isso corresponde à constante @ref{45c2,,sys.hash_info.algorithm}.
@end deffn

@geindex PyHash_FuncDef.hash_bits (C member)
@anchor{c-api/hash c PyHash_FuncDef hash_bits}@anchor{4ee6}
@deffn {C Membro} const int hash_bits

Tamanho interno do valor do hash em bits.

Isso corresponde à constante @ref{45c3,,sys.hash_info.hash_bits}.
@end deffn

@geindex PyHash_FuncDef.seed_bits (C member)
@anchor{c-api/hash c PyHash_FuncDef seed_bits}@anchor{4ee7}
@deffn {C Membro} const int seed_bits

Tamanho da entrada de seed em bits.

Isso corresponde à constante @ref{45c4,,sys.hash_info.seed_bits}.
@end deffn


Adicionado na versão 3.4.

@end deffn

@geindex PyHash_GetFuncDef (C function)
@anchor{c-api/hash c PyHash_GetFuncDef}@anchor{4ee3}
@deffn {C Função} @ref{4ee2,,PyHash_FuncDef} *PyHash_GetFuncDef (void)

Obtém a definição de função de hash.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} “Algoritmo de hash seguro e intercambiável”.



Adicionado na versão 3.4.

@end deffn

@geindex Py_HashPointer (C function)
@anchor{c-api/hash c Py_HashPointer}@anchor{368}
@deffn {C Função} @ref{12a5,,Py_hash_t} Py_HashPointer (const void *ptr)

Hash de um valor de ponteiro: processa o valor do ponteiro como um inteiro (converte-o para @code{uintptr_t} internamente). O ponteiro não é desreferenciado.

A função não pode falhar: ela não pode retornar @code{-1}.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_GenericHash (C function)
@anchor{c-api/hash c PyObject_GenericHash}@anchor{367}
@deffn {C Função} @ref{12a5,,Py_hash_t} PyObject_GenericHash (PyObject *obj)

Função de hash genérica que deve ser colocada no slot @code{tp_hash} de um objeto de tipo. Seu resultado depende apenas da identidade do objeto.

No CPython, é equivalente a @ref{368,,Py_HashPointer()}.


Adicionado na versão 3.13.

@end deffn

@node Reflexão,Registro de codec e funções de suporte,API do PyHash,Utilitários<2>
@anchor{c-api/reflection doc}@anchor{4ee8}@anchor{c-api/reflection id1}@anchor{4ee9}@anchor{c-api/reflection reflection}@anchor{4eea}@anchor{c-api/reflection translation-repo}@anchor{4eeb}
@subsection Reflexão


@geindex PyEval_GetBuiltins (C function)
@anchor{c-api/reflection c PyEval_GetBuiltins}@anchor{34f}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetBuiltins (void)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.13: Use @ref{34e,,PyEval_GetFrameBuiltins()}.


Retorna um dicionário dos componentes embutidos no quadro de execução atual ou o interpretador do estado da thread, se nenhum quadro estiver em execução no momento.
@end deffn

@geindex PyEval_GetLocals (C function)
@anchor{c-api/reflection c PyEval_GetLocals}@anchor{353}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetLocals (void)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.13: Use @ref{352,,PyEval_GetFrameLocals()} para obter o mesmo comportamento que chamar @ref{141,,locals()} no código Python, ou então chame @ref{41f,,PyFrame_GetLocals()} no resultado de @ref{18c1,,PyEval_GetFrame()} para acessar o atributo @ref{182,,f_locals} do quadro atualmente em execução.


Retorna um mapeamento fornecendo acesso às variáveis locais no quadro de execução atual ou @code{NULL} se nenhum quadro estiver sendo executado no momento.

Consulte @ref{141,,locals()} para detalhes do mapeamento retornado em diferentes escopos.

Como esta função retorna uma @ref{33e,,referência emprestada}, o dicionário retornado para @ref{17e,,escopos otimizados} é armazenado em cache no objeto frame e permanecerá ativo enquanto o objeto frame o fizer. Ao contrário de @ref{352,,PyEval_GetFrameLocals()} e @ref{141,,locals()}, chamadas subsequentes para esta função no mesmo quadro atualizarão o conteúdo do dicionário em cache para refletir as mudanças no estado das variáveis locais em vez de retornar um novo snapshot.


Alterado na versão 3.13: Como parte da 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, @ref{41f,,PyFrame_GetLocals()}, @ref{141,,locals()} e @ref{182,,FrameType.f_locals} não fazem mais uso do dicionário de cache compartilhado. Consulte a @ref{142,,entrada de O Que Há de Novo} para detalhes adicionais.

@end deffn

@geindex PyEval_GetGlobals (C function)
@anchor{c-api/reflection c PyEval_GetGlobals}@anchor{351}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetGlobals (void)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'

Descontinuado desde a versão 3.13: Use @ref{350,,PyEval_GetFrameGlobals()}.


Retorna um dicionário das variáveis globais no quadro de execução atual ou @code{NULL} se nenhum quadro estiver sendo executado no momento.
@end deffn

@geindex PyEval_GetFrame (C function)
@anchor{c-api/reflection c PyEval_GetFrame}@anchor{18c1}
@deffn {C Função} @ref{789,,PyFrameObject} *PyEval_GetFrame (void)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna o quadro do estado atual da thread, que é @code{NULL} se nenhum quadro estiver em execução no momento.

Veja também @ref{78e,,PyThreadState_GetFrame()}.
@end deffn

@geindex PyEval_GetFrameBuiltins (C function)
@anchor{c-api/reflection c PyEval_GetFrameBuiltins}@anchor{34e}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetFrameBuiltins (void)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna um dicionário dos componentes embutidos no quadro de execução atual ou o interpretador do estado da thread, se nenhum quadro estiver em execução no momento.


Adicionado na versão 3.13.

@end deffn

@geindex PyEval_GetFrameLocals (C function)
@anchor{c-api/reflection c PyEval_GetFrameLocals}@anchor{352}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetFrameLocals (void)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna um dicionário das variáveis locais no quadro de execução atual ou @code{NULL} se nenhum quadro estiver sendo executado no momento. Equivalente a chamar @ref{141,,locals()} em código Python.

Para acessar @ref{182,,f_locals} no quadro atual sem fazer um snapshot independente em @ref{17e,,escopos otimizados}, chame @ref{41f,,PyFrame_GetLocals()} no resultado de @ref{18c1,,PyEval_GetFrame()}.


Adicionado na versão 3.13.

@end deffn

@geindex PyEval_GetFrameGlobals (C function)
@anchor{c-api/reflection c PyEval_GetFrameGlobals}@anchor{350}
@deffn {C Função} @ref{339,,PyObject} *PyEval_GetFrameGlobals (void)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna um dicionário das variáveis globais no quadro de execução atual ou @code{NULL} se nenhum quadro estiver sendo executado no momento. Equivalente a chamar @ref{1993,,globals()} em código Python.


Adicionado na versão 3.13.

@end deffn

@geindex PyEval_GetFuncName (C function)
@anchor{c-api/reflection c PyEval_GetFuncName}@anchor{4c76}
@deffn {C Função} const char *PyEval_GetFuncName (PyObject *func)
` Parte da @ref{553,,ABI Estável}.'
Retorna o nome de `func' se for uma função, classe ou objeto de instância, senão o nome do tipo da `func'.
@end deffn

@geindex PyEval_GetFuncDesc (C function)
@anchor{c-api/reflection c PyEval_GetFuncDesc}@anchor{4c75}
@deffn {C Função} const char *PyEval_GetFuncDesc (PyObject *func)
` Parte da @ref{553,,ABI Estável}.'
Retorna uma sequência de caracteres de descrição, dependendo do tipo de `func'. Os valores de retorno incluem “()” para funções e métodos, “ constructor”, “ instance” e “ object”.. Concatenado com o resultado de @ref{4c76,,PyEval_GetFuncName()}, o resultado será uma descrição de `func'.
@end deffn

@node Registro de codec e funções de suporte,API C PyTime,Reflexão,Utilitários<2>
@anchor{c-api/codec doc}@anchor{4eec}@anchor{c-api/codec codec-registry}@anchor{d57}@anchor{c-api/codec codec-registry-and-support-functions}@anchor{4eed}@anchor{c-api/codec translation-repo}@anchor{4eee}
@subsection Registro de codec e funções de suporte


@geindex PyCodec_Register (C function)
@anchor{c-api/codec c PyCodec_Register}@anchor{4c3f}
@deffn {C Função} int PyCodec_Register (PyObject *search_function)
` Parte da @ref{553,,ABI Estável}.'
Registra uma nova função de busca de codec.

Como efeito colateral, tenta carregar o pacote @code{encodings}, se isso ainda não tiver sido feito, com o propósito de garantir que ele sempre seja o primeiro na lista de funções de busca.
@end deffn

@geindex PyCodec_Unregister (C function)
@anchor{c-api/codec c PyCodec_Unregister}@anchor{89b}
@deffn {C Função} int PyCodec_Unregister (PyObject *search_function)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Cancela o registro de uma função de busca de codec e limpa o cache de registro. Se a função de busca não está registrada, não faz nada. Retorna 0 no sucesso. Levanta uma exceção e retorna -1 em caso de erro.


Adicionado na versão 3.10.

@end deffn

@geindex PyCodec_KnownEncoding (C function)
@anchor{c-api/codec c PyCodec_KnownEncoding}@anchor{4c3d}
@deffn {C Função} int PyCodec_KnownEncoding (const char *encoding)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} ou @code{0} dependendo se há um codec registrado para a dada codificação `encoding'. Essa função sempre é bem-sucedida.
@end deffn

@geindex PyCodec_Encode (C function)
@anchor{c-api/codec c PyCodec_Encode}@anchor{400}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_Encode (PyObject *object, const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
API de codificação baseada em codec genérico.

`object' é passado através da função de codificação encontrada para a codificação fornecida por meio de `encoding', usando o método de tratamento de erros definido por `errors'. `errors' pode ser @code{NULL} para usar o método padrão definido para o codec. Levanta um @ref{2367,,LookupError} se nenhum codificador puder ser encontrado.
@end deffn

@geindex PyCodec_Decode (C function)
@anchor{c-api/codec c PyCodec_Decode}@anchor{3ff}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_Decode (PyObject *object, const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
API de decodificação baseada em decodificador genérico.

`object' é passado através da função de decodificação encontrada para a codificação fornecida por meio de `encoding', usando o método de tratamento de erros definido por `errors'. `errors' pode ser @code{NULL} para usar o método padrão definido para o codec. Levanta um @ref{2367,,LookupError} se nenhum decodificador puder ser encontrado.
@end deffn

@menu
* API de pesquisa de codec:: 
* API de registro de tratamentos de erros de decodificação Unicode:: 
* Variáveis utilitárias de codec:: 

@end menu

@node API de pesquisa de codec,API de registro de tratamentos de erros de decodificação Unicode,,Registro de codec e funções de suporte
@anchor{c-api/codec codec-lookup-api}@anchor{4eef}
@subsubsection API de pesquisa de codec


Nas funções a seguir, a string `encoding' é pesquisada com todos os caracteres sendo convertidos para minúsculo, o que faz com que as codificações pesquisadas por esse mecanismo não façam distinção entre maiúsculas e minúsculas. Se nenhum codec for encontrado, um @ref{344,,KeyError} é definido e @code{NULL} é retornado.

@geindex PyCodec_Encoder (C function)
@anchor{c-api/codec c PyCodec_Encoder}@anchor{4c39}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_Encoder (const char *encoding)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém uma função de codificação para o `encoding' dado.
@end deffn

@geindex PyCodec_Decoder (C function)
@anchor{c-api/codec c PyCodec_Decoder}@anchor{4c38}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_Decoder (const char *encoding)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém uma função de decodificação para o `encoding' dado.
@end deffn

@geindex PyCodec_IncrementalEncoder (C function)
@anchor{c-api/codec c PyCodec_IncrementalEncoder}@anchor{4c3c}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_IncrementalEncoder (const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém um objeto @ref{2563,,IncrementalEncoder} para o `encoding' dado.
@end deffn

@geindex PyCodec_IncrementalDecoder (C function)
@anchor{c-api/codec c PyCodec_IncrementalDecoder}@anchor{4c3b}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_IncrementalDecoder (const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém um objeto @ref{2564,,IncrementalDecoder} para o `encoding' dado.
@end deffn

@geindex PyCodec_StreamReader (C function)
@anchor{c-api/codec c PyCodec_StreamReader}@anchor{4c42}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_StreamReader (const char *encoding, PyObject *stream, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém uma função de fábrica @ref{2568,,StreamReader} para o `encoding' dado.
@end deffn

@geindex PyCodec_StreamWriter (C function)
@anchor{c-api/codec c PyCodec_StreamWriter}@anchor{4c43}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_StreamWriter (const char *encoding, PyObject *stream, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Obtém uma função de fábrica @ref{2567,,StreamWriter} para o `encoding' dado.
@end deffn

@node API de registro de tratamentos de erros de decodificação Unicode,Variáveis utilitárias de codec,API de pesquisa de codec,Registro de codec e funções de suporte
@anchor{c-api/codec registry-api-for-unicode-encoding-error-handlers}@anchor{4ef0}
@subsubsection API de registro de tratamentos de erros de decodificação Unicode


@geindex PyCodec_RegisterError (C function)
@anchor{c-api/codec c PyCodec_RegisterError}@anchor{4c40}
@deffn {C Função} int PyCodec_RegisterError (const char *name, PyObject *error)
` Parte da @ref{553,,ABI Estável}.'
Registra a função de retorno de chamada de tratamento de `erro' para o `nome' fornecido. Esta chamada de função é invocada por um codificador quando encontra caracteres/bytes indecodificáveis e `nome' é especificado como o parâmetro de erro na chamada da função de codificação/decodificação.

O retorno de chamada obtém um único argumento, uma instância de @ref{677,,UnicodeEncodeError}, @ref{a1d,,UnicodeDecodeError} ou @ref{2434,,UnicodeTranslateError} que contém informações sobre a sequencia problemática de caracteres ou bytes e seu deslocamento na string original (consulte @ref{4e94,,Objetos de exceção Unicode} para funções que extraem essa informação). A função de retorno de chamada deve levantar a exceção dada, ou retornar uma tupla de dois itens contendo a substituição para a sequência problemática, e um inteiro fornecendo o deslocamento na string original na qual a codificação/decodificação deve ser retomada.

Retorna @code{0} em caso de sucesso, @code{-1} em caso de erro.
@end deffn

@geindex PyCodec_LookupError (C function)
@anchor{c-api/codec c PyCodec_LookupError}@anchor{4c3e}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_LookupError (const char *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Pesquisa a função de retorno de chamada de tratamento de erros registrada em `name'. Como um caso especial, @code{NULL} pode ser passado; nesse caso, o erro no tratamento de retorno de chamada para “strict” será retornado.
@end deffn

@geindex PyCodec_StrictErrors (C function)
@anchor{c-api/codec c PyCodec_StrictErrors}@anchor{4c44}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_StrictErrors (PyObject *exc)
`Retorna valor: Sempre NULL.'` Parte da @ref{553,,ABI Estável}.'
Levanta `exc' como uma exceção.
@end deffn

@geindex PyCodec_IgnoreErrors (C function)
@anchor{c-api/codec c PyCodec_IgnoreErrors}@anchor{4c3a}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_IgnoreErrors (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Ignora o erro de unicode, ignorando a entrada que causou o erro.
@end deffn

@geindex PyCodec_ReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_ReplaceErrors}@anchor{4c41}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_ReplaceErrors (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Substitui o erro de unicode por @code{?} ou @code{U+FFFD}.
@end deffn

@geindex PyCodec_XMLCharRefReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_XMLCharRefReplaceErrors}@anchor{4c45}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_XMLCharRefReplaceErrors (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Substitui o erro de unicode por caracteres da referência XML.
@end deffn

@geindex PyCodec_BackslashReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_BackslashReplaceErrors}@anchor{4c37}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_BackslashReplaceErrors (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Substitui o erro de unicode com escapes de barra invertida (@code{\x}, @code{\u} e @code{\U}).
@end deffn

@geindex PyCodec_NameReplaceErrors (C function)
@anchor{c-api/codec c PyCodec_NameReplaceErrors}@anchor{ede}
@deffn {C Função} @ref{339,,PyObject} *PyCodec_NameReplaceErrors (PyObject *exc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Substitui os erros de codificação unicode com escapes @code{\N@{...@}}.


Adicionado na versão 3.5.

@end deffn

@node Variáveis utilitárias de codec,,API de registro de tratamentos de erros de decodificação Unicode,Registro de codec e funções de suporte
@anchor{c-api/codec codec-utility-variables}@anchor{4ef1}
@subsubsection Variáveis utilitárias de codec


@geindex Py_hexdigits (C var)
@anchor{c-api/codec c Py_hexdigits}@anchor{4ef2}
@deffn {C Variável} const char *Py_hexdigits

Uma constante string contendo os dígitos hexadecimais minúsculos: @code{"0123456789abcdef"}.


Adicionado na versão 3.3.

@end deffn

@node API C PyTime,Suporte a Mapas do Perf,Registro de codec e funções de suporte,Utilitários<2>
@anchor{c-api/time doc}@anchor{15a}@anchor{c-api/time c-api-time}@anchor{4ef3}@anchor{c-api/time pytime-c-api}@anchor{4ef4}@anchor{c-api/time translation-repo}@anchor{4ef5}
@subsection API C PyTime



Adicionado na versão 3.13.


A API C de relógios provê acesso a relógios do sistema. Ela é similar ao módulo Python @ref{ee,,time}.

Para uma API C relacionada ao módulo @ref{30,,datetime}, veja @ref{4ef6,,Objetos DateTime}.

@menu
* Tipos: Tipos<2>. 
* Funções de relógio:: 
* Funções de relógio brutas:: 
* Funções de conversão:: 

@end menu

@node Tipos<2>,Funções de relógio,,API C PyTime
@anchor{c-api/time types}@anchor{4ef7}
@subsubsection Tipos


@geindex PyTime_t (C type)
@anchor{c-api/time c PyTime_t}@anchor{32d}
@deffn {C Tipo} type PyTime_t

Um registro de data e hora ou uma duração em nanossegundos, representados como um inteiro de 64 bits com sinal.

O ponto de referência para registros de data e hora depende do relógio usado. Por exemplo, @ref{335,,PyTime_Time()} retorna registros relativos à época UNIX.

É suportada uma amplitude em torno de [-292.3 anos; +292.3 anos]. Usando o início da época UNIX (1º de Janeiro de 1970) como referência, a gama de datas suportadas é em torno de [1677-09-21; 2262-04-11]. Os limites exatos são expostos como constantes:
@end deffn

@geindex PyTime_MIN (C var)
@anchor{c-api/time c PyTime_MIN}@anchor{32e}
@deffn {C Variável} @ref{32d,,PyTime_t} PyTime_MIN

Valor mínimo de @ref{32d,,PyTime_t}.
@end deffn

@geindex PyTime_MAX (C var)
@anchor{c-api/time c PyTime_MAX}@anchor{32f}
@deffn {C Variável} @ref{32d,,PyTime_t} PyTime_MAX

Valor máximo de @ref{32d,,PyTime_t}.
@end deffn

@node Funções de relógio,Funções de relógio brutas,Tipos<2>,API C PyTime
@anchor{c-api/time clock-functions}@anchor{4ef8}
@subsubsection Funções de relógio


As funções a seguir aceitam um ponteiro para @ref{32d,,PyTime_t} ao qual elas atribuem o valor de um determinado relógio. Detalhes de cada relógio estão disponíveis nas documentações das funções Python correspondentes.

As funções retornam @code{0} em caso de sucesso, ou @code{-1} (com uma exceção definida) em caso de falha.

Em caso de estouro de inteiros, elas definem a exceção @ref{4c9f,,PyExc_OverflowError} e definem @code{*result} como o valor limitado ao intervalo @code{[PyTime_MIN; PyTime_MAX]}. (Em sistemas atuais, estouros de inteiros são provavelmente causados por uma má configuração do tempo do sistema).

Como qualquer outra API C (se não especificado o contrário), as funções devem ser chamadas sob posse da @ref{159,,GIL}.

@geindex PyTime_Monotonic (C function)
@anchor{c-api/time c PyTime_Monotonic}@anchor{331}
@deffn {C Função} int PyTime_Monotonic (PyTime_t *result)

Lê o relógio monótono. Veja @ref{253,,time.monotonic()} para detalhes importantes sobre este relógio.
@end deffn

@geindex PyTime_PerfCounter (C function)
@anchor{c-api/time c PyTime_PerfCounter}@anchor{333}
@deffn {C Função} int PyTime_PerfCounter (PyTime_t *result)

Lê o contador de desempenho. Veja @ref{a92,,time.perf_counter()} para detalhes importantes sobre este relógio.
@end deffn

@geindex PyTime_Time (C function)
@anchor{c-api/time c PyTime_Time}@anchor{335}
@deffn {C Função} int PyTime_Time (PyTime_t *result)

Lê o “relógio de parede”. Veja @ref{254,,time.time()} para detalhes importantes sobre este relógio.
@end deffn

@node Funções de relógio brutas,Funções de conversão,Funções de relógio,API C PyTime
@anchor{c-api/time raw-clock-functions}@anchor{4ef9}
@subsubsection Funções de relógio brutas


Similares às funções de relógio, mas não definem uma exceção em condições de erro, e não requerem que o chamador possua a trava @cite{GIL}.

Em caso de sucesso, as funções retornam @code{0}.

Em caso de falha, elas definem @code{*result} como @code{0} e retornam @code{-1}, `sem' definir uma exceção. Para acessar a causa do erro, obtenha a GIL e chame a função regular (sem o sufixo @code{Raw}). Obserrve que a função regular pode ser bem-sucedida mesmo após a bruta falhar.

@geindex PyTime_MonotonicRaw (C function)
@anchor{c-api/time c PyTime_MonotonicRaw}@anchor{332}
@deffn {C Função} int PyTime_MonotonicRaw (PyTime_t *result)

Similar a @ref{331,,PyTime_Monotonic()}, mas não define uma exceção em caso de erro, e não exige a posse da GIL.
@end deffn

@geindex PyTime_PerfCounterRaw (C function)
@anchor{c-api/time c PyTime_PerfCounterRaw}@anchor{334}
@deffn {C Função} int PyTime_PerfCounterRaw (PyTime_t *result)

Similar a @ref{333,,PyTime_PerfCounter()}, mas não define uma exceção em caso de erro e não requer a posse da GIL.
@end deffn

@geindex PyTime_TimeRaw (C function)
@anchor{c-api/time c PyTime_TimeRaw}@anchor{336}
@deffn {C Função} int PyTime_TimeRaw (PyTime_t *result)

Similar a @ref{335,,PyTime_Time()}, mas não define uma exceção em caso de erro e não requer a posse da GIL.
@end deffn

@node Funções de conversão,,Funções de relógio brutas,API C PyTime
@anchor{c-api/time conversion-functions}@anchor{4efa}
@subsubsection Funções de conversão


@geindex PyTime_AsSecondsDouble (C function)
@anchor{c-api/time c PyTime_AsSecondsDouble}@anchor{330}
@deffn {C Função} double PyTime_AsSecondsDouble (PyTime_t t)

Converte um registro de data e hora para uma quantidade de segundos como um double C.

Esta função nunca falha, mas note que double tem acurácia limitada para valores grandes.
@end deffn

@node Suporte a Mapas do Perf,,API C PyTime,Utilitários<2>
@anchor{c-api/perfmaps doc}@anchor{4efb}@anchor{c-api/perfmaps perfmaps}@anchor{4efc}@anchor{c-api/perfmaps support-for-perf-maps}@anchor{4efd}@anchor{c-api/perfmaps translation-repo}@anchor{4efe}
@subsection Suporte a Mapas do Perf


Em plataformas suportadas (no momento em que este livro foi escrito, apenas Linux), o tempo de execução pode tirar vantagem dos `arquivos de mapa perf' para tornar as funções Python visíveis para uma ferramenta de perfilação externa (como perf@footnote{https://perf.wiki.kernel.org/index.php/Main_Page}). Um processo em execução pode criar um arquivo no diretório @code{/tmp}, que contém entradas que podem mapear uma seção de código executável para um nome. Esta interface é descrita na documentação da ferramenta Linux Perf@footnote{https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/Documentation/jit-interface.txt}.

Em Python, essas APIs auxiliares podem ser usadas por bibliotecas e recursos que dependem da geração de código de máquina dinamicamente.

Observe que manter a trava global do interpretador (GIL) não é necessário para essas APIs.

@geindex PyUnstable_PerfMapState_Init (C function)
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Init}@anchor{182f}
@deffn {C Função} int PyUnstable_PerfMapState_Init (void)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Abre o arquivo @code{/tmp/perf-$pid.map}, a menos que já esteja aberto, e cria uma trava para garantir escritas seguras para thread no arquivo (desde que as escritas sejam feitas através de @ref{182e,,PyUnstable_WritePerfMapEntry()} ). Normalmente, não há necessidade de chamar isso explicitamente; basta usar @ref{182e,,PyUnstable_WritePerfMapEntry()} e ele inicializará o estado na primeira chamada.

Retorna @code{0} em caso de sucesso, @code{-1} em caso de falha ao criar/abrir o arquivo de mapa de desempenho ou @code{-2} em caso de falha na criação de uma trava. Verifique @code{errno} para mais informações sobre a causa de uma falha.
@end deffn

@geindex PyUnstable_WritePerfMapEntry (C function)
@anchor{c-api/perfmaps c PyUnstable_WritePerfMapEntry}@anchor{182e}
@deffn {C Função} int PyUnstable_WritePerfMapEntry (const void *code_addr, unsigned int code_size, const char *entry_name)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Escreve uma única entrada no arquivo @code{/tmp/perf-$pid.map}. Esta função é segura para thread. Aqui está a aparência de um exemplo de entrada:

@example
# endereço  tamanho  nome
7f3529fcf759 b     py::bar:/run/t.py
@end example

Chamará @ref{182f,,PyUnstable_PerfMapState_Init()} antes de escrever a entrada, se o arquivo de mapa de desempenho ainda não estiver aberto. Retorna @code{0} em caso de sucesso ou os mesmos códigos de erro que @ref{182f,,PyUnstable_PerfMapState_Init()} em caso de falha.
@end deffn

@geindex PyUnstable_PerfMapState_Fini (C function)
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Fini}@anchor{1830}
@deffn {C Função} void PyUnstable_PerfMapState_Fini (void)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Fecha o arquivo de mapa do perf aberto por @ref{182f,,PyUnstable_PerfMapState_Init()}. Isso é chamado pelo próprio tempo de execução durante o desligamento do interpretador. Em geral, não deve haver motivo para chamar isso explicitamente, exceto para lidar com cenários específicos, como bifurcação.
@end deffn

@node Camada de Objetos Abstratos,Camada de Objetos Concretos,Utilitários<2>,Manual de referência da API Python/C
@anchor{c-api/abstract doc}@anchor{4eff}@anchor{c-api/abstract abstract}@anchor{4b9c}@anchor{c-api/abstract abstract-objects-layer}@anchor{4f00}@anchor{c-api/abstract translation-repo}@anchor{4f01}
@section Camada de Objetos Abstratos


As funções neste capítulo interagem com objetos Python independentemente do seu tipo, ou com classes amplas de tipos de objetos (por exemplo, todos os tipos numéricos ou todos os tipos de sequência). Quando usadas em tipos de objetos para os quais não se aplicam, elas irão levantar uma exceção Python.

Não é possível usar essas funções em objetos que não foram inicializados corretamente, como um objeto de lista criado por @ref{4be1,,PyList_New()}, mas cujos itens ainda não foram definidos para algum valor diferente de @code{NULL}.

@menu
* Protocolo de objeto:: 
* Protocolo de chamada:: 
* Protocolo de número:: 
* Protocolo de sequência:: 
* Protocolo de mapeamento:: 
* Protocolo Iterador:: 
* Protocolo de buffer:: 

@end menu

@node Protocolo de objeto,Protocolo de chamada,,Camada de Objetos Abstratos
@anchor{c-api/object doc}@anchor{4f02}@anchor{c-api/object object}@anchor{4f03}@anchor{c-api/object object-protocol}@anchor{4f04}
@subsection Protocolo de objeto


@geindex Py_GetConstant (C function)
@anchor{c-api/object c Py_GetConstant}@anchor{354}
@deffn {C Função} @ref{339,,PyObject} *Py_GetConstant (unsigned int constant_id)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Obtém uma @ref{33d,,referência forte} para uma constante.

Define uma exceção e retorna @code{NULL} se `constant_id' for inválido.

`constant_id' deve ser um destes identificadores constantes:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Identificador da constante

@tab

Valor

@tab

Objeto retornado

@item

@geindex Py_CONSTANT_NONE (C macro)
@anchor{c-api/object c Py_CONSTANT_NONE}@anchor{4f05}
@deffn {C Macro} Py_CONSTANT_NONE
@end deffn

@tab

@code{0}

@tab

@ref{675,,None}

@item

@geindex Py_CONSTANT_FALSE (C macro)
@anchor{c-api/object c Py_CONSTANT_FALSE}@anchor{4f06}
@deffn {C Macro} Py_CONSTANT_FALSE
@end deffn

@tab

@code{1}

@tab

@ref{b49,,False}

@item

@geindex Py_CONSTANT_TRUE (C macro)
@anchor{c-api/object c Py_CONSTANT_TRUE}@anchor{4f07}
@deffn {C Macro} Py_CONSTANT_TRUE
@end deffn

@tab

@code{2}

@tab

@ref{c27,,True}

@item

@geindex Py_CONSTANT_ELLIPSIS (C macro)
@anchor{c-api/object c Py_CONSTANT_ELLIPSIS}@anchor{4f08}
@deffn {C Macro} Py_CONSTANT_ELLIPSIS
@end deffn

@tab

@code{3}

@tab

@ref{231c,,Ellipsis}

@item

@geindex Py_CONSTANT_NOT_IMPLEMENTED (C macro)
@anchor{c-api/object c Py_CONSTANT_NOT_IMPLEMENTED}@anchor{4f09}
@deffn {C Macro} Py_CONSTANT_NOT_IMPLEMENTED
@end deffn

@tab

@code{4}

@tab

@ref{7d3,,NotImplemented}

@item

@geindex Py_CONSTANT_ZERO (C macro)
@anchor{c-api/object c Py_CONSTANT_ZERO}@anchor{4f0a}
@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{4f0b}
@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{4f0c}
@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{4f0d}
@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{4f0e}
@deffn {C Macro} Py_CONSTANT_EMPTY_TUPLE
@end deffn

@tab

@code{9}

@tab

@code{()}

@end multitable


Valores numéricos são fornecidos apenas para projetos que não podem usar identificadores constantes.


Adicionado na versão 3.13.


No CPython, todas essas constantes são @ref{45bb,,imortais}.
@end deffn

@geindex Py_GetConstantBorrowed (C function)
@anchor{c-api/object c Py_GetConstantBorrowed}@anchor{355}
@deffn {C Função} @ref{339,,PyObject} *Py_GetConstantBorrowed (unsigned int constant_id)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Semelhante a @ref{354,,Py_GetConstant()}, mas retorna uma @ref{33e,,referência emprestada}.

Esta função destina-se principalmente à compatibilidade com versões anteriores: usar @ref{354,,Py_GetConstant()} é recomendado para novo código.

A referência é emprestada do interpretador e é válida até a finalização do interpretador.


Adicionado na versão 3.13.

@end deffn

@geindex Py_NotImplemented (C var)
@anchor{c-api/object c Py_NotImplemented}@anchor{4f0f}
@deffn {C Variável} @ref{339,,PyObject} *Py_NotImplemented

O singleton @code{NotImplemented}, usado para sinalizar que uma operação não foi implementada para a combinação de tipo fornecida.
@end deffn

@geindex Py_RETURN_NOTIMPLEMENTED (C macro)
@anchor{c-api/object c Py_RETURN_NOTIMPLEMENTED}@anchor{15e6}
@deffn {C Macro} Py_RETURN_NOTIMPLEMENTED

Manipula adequadamente o retorno de @ref{4f0f,,Py_NotImplemented} de dentro de uma função C (ou seja, cria uma nova @ref{33d,,referência forte} para @ref{7d3,,NotImplemented} e retorna-a).
@end deffn

@geindex Py_PRINT_RAW (C macro)
@anchor{c-api/object c Py_PRINT_RAW}@anchor{4f10}
@deffn {C Macro} Py_PRINT_RAW

Flag to be used with multiple functions that print the object (like
@ref{16dc,,PyObject_Print()} and @ref{4cbf,,PyFile_WriteObject()}).
If passed, these functions use the @ref{44c,,str()} of the object
instead of the @ref{800,,repr()}.
@end deffn

@geindex PyObject_Print (C function)
@anchor{c-api/object c PyObject_Print}@anchor{16dc}
@deffn {C Função} 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{4f10,,Py_PRINT_RAW}; if given, the @ref{44c,,str()} of the object is written
instead of the @ref{800,,repr()}.
@end deffn

@geindex PyObject_HasAttrWithError (C function)
@anchor{c-api/object c PyObject_HasAttrWithError}@anchor{37a}
@deffn {C Função} int PyObject_HasAttrWithError (PyObject *o, PyObject *attr_name)
` Parte da @ref{553,,ABI Estável} desde a versão 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}.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_HasAttrStringWithError (C function)
@anchor{c-api/object c PyObject_HasAttrStringWithError}@anchor{37c}
@deffn {C Função} int PyObject_HasAttrStringWithError (PyObject *o, const char *attr_name)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
This is the same as @ref{37a,,PyObject_HasAttrWithError()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_HasAttr (C function)
@anchor{c-api/object c PyObject_HasAttr}@anchor{37b}
@deffn {C Função} int PyObject_HasAttr (PyObject *o, PyObject *attr_name)
` Parte da @ref{553,,ABI Estável}.'
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{4d3,,__getattr__()} and
@ref{beb,,__getattribute__()} methods aren’t propagated,
but instead given to @ref{1f7,,sys.unraisablehook()}.
For proper error handling, use @ref{37a,,PyObject_HasAttrWithError()},
@ref{349,,PyObject_GetOptionalAttr()} or @ref{347,,PyObject_GetAttr()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyObject_HasAttrString (C function)
@anchor{c-api/object c PyObject_HasAttrString}@anchor{37d}
@deffn {C Função} int PyObject_HasAttrString (PyObject *o, const char *attr_name)
` Parte da @ref{553,,ABI Estável}.'
This is the same as @ref{37b,,PyObject_HasAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,PyObject}*.

@cartouche
@quotation Nota 
Exceptions that occur when this calls @ref{4d3,,__getattr__()} and
@ref{beb,,__getattribute__()} methods or while creating the temporary
@ref{44c,,str} object are silently ignored.
For proper error handling, use @ref{37c,,PyObject_HasAttrStringWithError()},
@ref{34a,,PyObject_GetOptionalAttrString()}
or @ref{348,,PyObject_GetAttrString()} instead.
@end quotation
@end cartouche
@end deffn

@geindex PyObject_GetAttr (C function)
@anchor{c-api/object c PyObject_GetAttr}@anchor{347}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GetAttr (PyObject *o, PyObject *attr_name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retrieve an attribute named `attr_name' from object `o'. Returns the attribute
value on success, or @code{NULL} on failure.  This is the equivalent of the Python
expression @code{o.attr_name}.

If the missing attribute should not be treated as a failure, you can use
@ref{349,,PyObject_GetOptionalAttr()} instead.
@end deffn

@geindex PyObject_GetAttrString (C function)
@anchor{c-api/object c PyObject_GetAttrString}@anchor{348}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GetAttrString (PyObject *o, const char *attr_name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
This is the same as @ref{347,,PyObject_GetAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,PyObject}*.

If the missing attribute should not be treated as a failure, you can use
@ref{34a,,PyObject_GetOptionalAttrString()} instead.
@end deffn

@geindex PyObject_GetOptionalAttr (C function)
@anchor{c-api/object c PyObject_GetOptionalAttr}@anchor{349}
@deffn {C Função} int PyObject_GetOptionalAttr (PyObject *obj, PyObject *attr_name, PyObject **result);
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Variant of @ref{347,,PyObject_GetAttr()} which doesn’t raise
@ref{34b,,AttributeError} if the attribute is not found.

If the attribute is found, return @code{1} and set `*result' to a new
@ref{33d,,strong reference} to the attribute.
If the attribute is not found, return @code{0} and set `*result' to @code{NULL};
the @ref{34b,,AttributeError} is silenced.
If an error other than @ref{34b,,AttributeError} is raised, return @code{-1} and
set `*result' to @code{NULL}.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_GetOptionalAttrString (C function)
@anchor{c-api/object c PyObject_GetOptionalAttrString}@anchor{34a}
@deffn {C Função} int PyObject_GetOptionalAttrString (PyObject *obj, const char *attr_name, PyObject **result);
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
This is the same as @ref{349,,PyObject_GetOptionalAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_GenericGetAttr (C function)
@anchor{c-api/object c PyObject_GenericGetAttr}@anchor{4d2b}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GenericGetAttr (PyObject *o, PyObject *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Generic attribute getter function that is meant to be put into a type
object’s @code{tp_getattro} slot.  It looks for a descriptor in the dictionary
of classes in the object’s MRO as well as an attribute in the object’s
@ref{55b,,__dict__} (if present).  As outlined in @ref{c6a,,Implementando descritores},
data descriptors take preference over instance attributes, while non-data
descriptors don’t.  Otherwise, an @ref{34b,,AttributeError} is raised.
@end deffn

@geindex PyObject_SetAttr (C function)
@anchor{c-api/object c PyObject_SetAttr}@anchor{4d34}
@deffn {C Função} int PyObject_SetAttr (PyObject *o, PyObject *attr_name, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
Set the value of the attribute named `attr_name', for object `o', to the value
`v'. Raise an exception and return @code{-1} on failure;
return @code{0} on success.  This is the equivalent of the Python statement
@code{o.attr_name = v}.

If `v' is @code{NULL}, the attribute is deleted. This behaviour is deprecated
in favour of using @ref{161f,,PyObject_DelAttr()}, but there are currently no
plans to remove it.
@end deffn

@geindex PyObject_SetAttrString (C function)
@anchor{c-api/object c PyObject_SetAttrString}@anchor{16ec}
@deffn {C Função} int PyObject_SetAttrString (PyObject *o, const char *attr_name, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
This is the same as @ref{4d34,,PyObject_SetAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,PyObject}*.

If `v' is @code{NULL}, the attribute is deleted, but this feature is
deprecated in favour of using @ref{1620,,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{4db1,,PyUnicode_FromString()} and @ref{4d34,,PyObject_SetAttr()} directly.
For more details, see @ref{16ea,,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{4d2c}
@deffn {C Função} int PyObject_GenericSetAttr (PyObject *o, PyObject *name, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Generic attribute setter and deleter function that is meant
to be put into a type object’s @ref{4b91,,tp_setattro}
slot.  It looks for a data descriptor in the
dictionary of classes in the object’s MRO, and if found it takes preference
over setting or deleting the attribute in the instance dictionary. Otherwise, the
attribute is set or deleted in the object’s @ref{55b,,__dict__} (if present).
On success, @code{0} is returned, otherwise an @ref{34b,,AttributeError}
is raised and @code{-1} is returned.
@end deffn

@geindex PyObject_DelAttr (C function)
@anchor{c-api/object c PyObject_DelAttr}@anchor{161f}
@deffn {C Função} int PyObject_DelAttr (PyObject *o, PyObject *attr_name)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Delete attribute named `attr_name', for object `o'. Returns @code{-1} on failure.
This is the equivalent of the Python statement @code{del o.attr_name}.
@end deffn

@geindex PyObject_DelAttrString (C function)
@anchor{c-api/object c PyObject_DelAttrString}@anchor{1620}
@deffn {C Função} int PyObject_DelAttrString (PyObject *o, const char *attr_name)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
This is the same as @ref{161f,,PyObject_DelAttr()}, but `attr_name' is
specified as a const char* UTF-8 encoded bytes string,
rather than a @ref{339,,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{4db1,,PyUnicode_FromString()} and @ref{161f,,PyObject_DelAttr()} directly.
For more details, see @ref{16ea,,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{1a92}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GenericGetDict (PyObject *o, void *context)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
A generic implementation for the getter of a @code{__dict__} descriptor. It
creates the dictionary if necessary.

This function may also be called to get the @ref{55b,,__dict__}
of the object `o'. Pass @code{NULL} for `context' when calling it.
Since this function may need to allocate memory for the
dictionary, it may be more efficient to call @ref{347,,PyObject_GetAttr()}
when accessing an attribute on the object.

On failure, returns @code{NULL} with an exception set.


Adicionado na versão 3.3.

@end deffn

@geindex PyObject_GenericSetDict (C function)
@anchor{c-api/object c PyObject_GenericSetDict}@anchor{4d2d}
@deffn {C Função} int PyObject_GenericSetDict (PyObject *o, PyObject *value, void *context)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
A generic implementation for the setter of a @code{__dict__} descriptor. This
implementation does not allow the dictionary to be deleted.


Adicionado na versão 3.3.

@end deffn

@geindex _PyObject_GetDictPtr (C function)
@anchor{c-api/object c _PyObject_GetDictPtr}@anchor{4f11}
@deffn {C Função} @ref{339,,PyObject} **_PyObject_GetDictPtr (PyObject *obj)

Return a pointer to @ref{55b,,__dict__} of the object `obj'.
If there is no @code{__dict__}, return @code{NULL} without setting an exception.

This function may need to allocate memory for the
dictionary, so it may be more efficient to call @ref{347,,PyObject_GetAttr()}
when accessing an attribute on the object.
@end deffn

@geindex PyObject_RichCompare (C function)
@anchor{c-api/object c PyObject_RichCompare}@anchor{4b9a}
@deffn {C Função} @ref{339,,PyObject} *PyObject_RichCompare (PyObject *o1, PyObject *o2, int opid)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Compare the values of `o1' and `o2' using the operation specified by `opid',
which must be one of @ref{4f12,,Py_LT}, @ref{4f13,,Py_LE}, @ref{4f14,,Py_EQ},
@ref{4f15,,Py_NE}, @ref{4f16,,Py_GT}, or @ref{4f17,,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{1b1b}
@deffn {C Função} int PyObject_RichCompareBool (PyObject *o1, PyObject *o2, int opid)
` Parte da @ref{553,,ABI Estável}.'
Compare the values of `o1' and `o2' using the operation specified by `opid',
like @ref{4b9a,,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{1b1b,,PyObject_RichCompareBool()}
will always return @code{1} for @ref{4f14,,Py_EQ} and @code{0} for @ref{4f15,,Py_NE}.
@end quotation
@end cartouche

@geindex PyObject_Format (C function)
@anchor{c-api/object c PyObject_Format}@anchor{4d2a}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Format (PyObject *obj, PyObject *format_spec)
` Parte da @ref{553,,ABI Estável}.'
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{1067}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Repr (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;repr

Compute a string representation of object `o'.  Returns the string
representation on success, @code{NULL} on failure.  This is the equivalent of the
Python expression @code{repr(o)}.  Called by the @ref{800,,repr()} built-in function.


Alterado na versão 3.4: Essa função agora inclui uma asserção de depuração para ajudar a garantir que ela não descarte silenciosamente uma exceção ativa.

@end deffn

@geindex PyObject_ASCII (C function)
@anchor{c-api/object c PyObject_ASCII}@anchor{4d23}
@deffn {C Função} @ref{339,,PyObject} *PyObject_ASCII (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;ascii

As @ref{1067,,PyObject_Repr()}, compute a string representation of object `o', but
escape the non-ASCII characters in the string returned by
@ref{1067,,PyObject_Repr()} with @code{\x}, @code{\u} or @code{\U} escapes.  This generates
a string similar to that returned by @ref{1067,,PyObject_Repr()} in Python 2.
Called by the @ref{142d,,ascii()} built-in function.

@geindex string;PyObject_Str (C function)
@end deffn

@geindex PyObject_Str (C function)
@anchor{c-api/object c PyObject_Str}@anchor{1068}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Str (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Compute a string representation of object `o'.  Returns the string
representation on success, @code{NULL} on failure.  This is the equivalent of the
Python expression @code{str(o)}.  Called by the @ref{44c,,str()} built-in function
and, therefore, by the @ref{fa9,,print()} function.


Alterado na versão 3.4: Essa função agora inclui uma asserção de depuração para ajudar a garantir que ela não descarte silenciosamente uma exceção ativa.

@end deffn

@geindex PyObject_Bytes (C function)
@anchor{c-api/object c PyObject_Bytes}@anchor{4d25}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Bytes (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;bytes

Compute a bytes representation of object `o'.  @code{NULL} is returned on
failure and a bytes object on success.  This is equivalent to the Python
expression @code{bytes(o)}, when `o' is not an integer.  Unlike @code{bytes(o)},
a TypeError is raised when `o' is an integer instead of a zero-initialized
bytes object.
@end deffn

@geindex PyObject_IsSubclass (C function)
@anchor{c-api/object c PyObject_IsSubclass}@anchor{ed6}
@deffn {C Função} int PyObject_IsSubclass (PyObject *derived, PyObject *cls)
` Parte da @ref{553,,ABI Estável}.'
Return @code{1} if the class `derived' is identical to or derived from the class
`cls', otherwise return @code{0}.  In case of an error, return @code{-1}.

If `cls' is a tuple, the check will be done against every entry in `cls'.
The result will be @code{1} when at least one of the checks returns @code{1},
otherwise it will be @code{0}.

If `cls' has a @ref{2109,,__subclasscheck__()} method, it will be called to
determine the subclass status as described in 
@geindex Propostas de Melhorias do Python; 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{20bb,,cls.__mro__}.

Normally only class objects, i.e. instances of @ref{d6b,,type} or a derived
class, are considered classes.  However, objects can override this by having
a @ref{14f4,,__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{ed5}
@deffn {C Função} int PyObject_IsInstance (PyObject *inst, PyObject *cls)
` Parte da @ref{553,,ABI Estável}.'
Return @code{1} if `inst' is an instance of the class `cls' or a subclass of
`cls', or @code{0} if not.  On error, returns @code{-1} and sets an exception.

If `cls' is a tuple, the check will be done against every entry in `cls'.
The result will be @code{1} when at least one of the checks returns @code{1},
otherwise it will be @code{0}.

If `cls' has a @ref{2108,,__instancecheck__()} method, it will be called to
determine the subclass status as described in 
@geindex Propostas de Melhorias do Python; 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{14f5,,__class__} attribute.

An object `cls' can override if it is considered a class, and what its base
classes are, by having a @ref{14f4,,__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{403}
@deffn {C Função} @ref{12a5,,Py_hash_t} PyObject_Hash (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;hash

Compute and return the hash value of an object `o'.  On failure, return @code{-1}.
This is the equivalent of the Python expression @code{hash(o)}.


Alterado na versão 3.2: The return type is now Py_hash_t.  This is a signed integer the same size
as @ref{a69,,Py_ssize_t}.

@end deffn

@geindex PyObject_HashNotImplemented (C function)
@anchor{c-api/object c PyObject_HashNotImplemented}@anchor{140d}
@deffn {C Função} @ref{12a5,,Py_hash_t} PyObject_HashNotImplemented (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Set a @ref{2c3,,TypeError} indicating that @code{type(o)} is not @ref{610,,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{4d30}
@deffn {C Função} int PyObject_IsTrue (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Returns @code{1} if the object `o' is considered to be true, and @code{0} otherwise.
This is equivalent to the Python expression @code{not not o}.  On failure, return
@code{-1}.
@end deffn

@geindex PyObject_Not (C function)
@anchor{c-api/object c PyObject_Not}@anchor{4d32}
@deffn {C Função} int PyObject_Not (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Returns @code{0} if the object `o' is considered to be true, and @code{1} otherwise.
This is equivalent to the Python expression @code{not o}.  On failure, return
@code{-1}.
@end deffn

@geindex PyObject_Type (C function)
@anchor{c-api/object c PyObject_Type}@anchor{4d36}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Type (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;tipo

When `o' is non-@code{NULL}, returns a type object corresponding to the object type
of object `o'. On failure, raises @ref{575,,SystemError} and returns @code{NULL}.  This
is equivalent to the Python expression @code{type(o)}.
This function creates a new @ref{33d,,strong reference} to the return value.
There’s really no reason to use this
function instead of the @ref{780,,Py_TYPE()} function, which returns a
pointer of type @ref{ab4,,PyTypeObject}*, except when a new
@ref{33d,,strong reference} is needed.
@end deffn

@geindex PyObject_TypeCheck (C function)
@anchor{c-api/object c PyObject_TypeCheck}@anchor{1a41}
@deffn {C Função} int PyObject_TypeCheck (PyObject *o, PyTypeObject *type)

Return non-zero if the object `o' is of type `type' or a subtype of `type', and
@code{0} otherwise.  Both parameters must be non-@code{NULL}.
@end deffn

@geindex PyObject_Size (C function)
@geindex PyObject_Length (C function)
@anchor{c-api/object c PyObject_Size}@anchor{4d35}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyObject_Size (PyObject *o)
@anchor{c-api/object c PyObject_Length}@anchor{4d31}
@deffnx {C Função} @ref{a69,,Py_ssize_t} PyObject_Length (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Return the length of object `o'.  If the object `o' provides either the sequence
and mapping protocols, the sequence length is returned.  On error, @code{-1} is
returned.  This is the equivalent to the Python expression @code{len(o)}.
@end deffn

@geindex PyObject_LengthHint (C function)
@anchor{c-api/object c PyObject_LengthHint}@anchor{103a}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyObject_LengthHint (PyObject *o, Py_ssize_t defaultvalue)

Return an estimated length for the object `o'. First try to return its
actual length, then an estimate using @ref{f3d,,__length_hint__()}, and
finally return the default value. On error return @code{-1}. This is the
equivalent to the Python expression @code{operator.length_hint(o, defaultvalue)}.


Adicionado na versão 3.4.

@end deffn

@geindex PyObject_GetItem (C function)
@anchor{c-api/object c PyObject_GetItem}@anchor{4be2}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GetItem (PyObject *o, PyObject *key)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return element of `o' corresponding to the object `key' or @code{NULL} on failure.
This is the equivalent of the Python expression @code{o[key]}.
@end deffn

@geindex PyObject_SetItem (C function)
@anchor{c-api/object c PyObject_SetItem}@anchor{4be0}
@deffn {C Função} int PyObject_SetItem (PyObject *o, PyObject *key, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
Map the object `key' to the value `v'.  Raise an exception and
return @code{-1} on failure; return @code{0} on success.  This is the
equivalent of the Python statement @code{o[key] = v}.  This function `does
not' steal a reference to `v'.
@end deffn

@geindex PyObject_DelItem (C function)
@anchor{c-api/object c PyObject_DelItem}@anchor{4d27}
@deffn {C Função} int PyObject_DelItem (PyObject *o, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Remove the mapping for the object `key' from the object `o'.  Return @code{-1}
on failure.  This is equivalent to the Python statement @code{del o[key]}.
@end deffn

@geindex PyObject_DelItemString (C function)
@anchor{c-api/object c PyObject_DelItemString}@anchor{4d28}
@deffn {C Função} int PyObject_DelItemString (PyObject *o, const char *key)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{4d27,,PyObject_DelItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyObject_Dir (C function)
@anchor{c-api/object c PyObject_Dir}@anchor{4d29}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Dir (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
This is equivalent to the Python expression @code{dir(o)}, returning a (possibly
empty) list of strings appropriate for the object argument, or @code{NULL} if there
was an error.  If the argument is @code{NULL}, this is like the Python @code{dir()},
returning the names of the current locals; in this case, if no execution frame
is active then @code{NULL} is returned but @ref{1a3b,,PyErr_Occurred()} will return false.
@end deffn

@geindex PyObject_GetIter (C function)
@anchor{c-api/object c PyObject_GetIter}@anchor{4d2f}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GetIter (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
This is equivalent to the Python expression @code{iter(o)}. It returns a new
iterator for the object argument, or the object  itself if the object is already
an iterator.  Raises @ref{2c3,,TypeError} and returns @code{NULL} if the object cannot be
iterated.
@end deffn

@geindex PyObject_SelfIter (C function)
@anchor{c-api/object c PyObject_SelfIter}@anchor{4d33}
@deffn {C Função} @ref{339,,PyObject} *PyObject_SelfIter (PyObject *obj)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
This is equivalent to the Python @code{__iter__(self): return self} method.
It is intended for @ref{1ac,,iterator} types, to be used in the @ref{1537,,PyTypeObject.tp_iter} slot.
@end deffn

@geindex PyObject_GetAIter (C function)
@anchor{c-api/object c PyObject_GetAIter}@anchor{4d2e}
@deffn {C Função} @ref{339,,PyObject} *PyObject_GetAIter (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
This is the equivalent to the Python expression @code{aiter(o)}. Takes an
@code{AsyncIterable} object and returns an @code{AsyncIterator} for it.
This is typically a new iterator but if the argument is an
@code{AsyncIterator}, this returns itself. Raises @ref{2c3,,TypeError} and
returns @code{NULL} if the object cannot be iterated.


Adicionado na versão 3.10.

@end deffn

@geindex PyObject_GetTypeData (C function)
@anchor{c-api/object c PyObject_GetTypeData}@anchor{549}
@deffn {C Função} void *PyObject_GetTypeData (PyObject *o, PyTypeObject *cls)
` Parte da @ref{553,,ABI Estável} desde a versão 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{548,,PyType_Spec.basicsize}.
Python does not check this.

On error, set an exception and return @code{NULL}.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_GetTypeDataSize (C function)
@anchor{c-api/object c PyType_GetTypeDataSize}@anchor{54a}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyType_GetTypeDataSize (PyTypeObject *cls)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Return the size of the instance memory space reserved for `cls', i.e. the size of the
memory @ref{549,,PyObject_GetTypeData()} returns.

This may be larger than requested using @ref{548,,-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{548,,PyType_Spec.basicsize}.
Python does not check this.

On error, set an exception and return a negative value.


Adicionado na versão 3.12.

@end deffn

@geindex PyObject_GetItemData (C function)
@anchor{c-api/object c PyObject_GetItemData}@anchor{54c}
@deffn {C Função} void *PyObject_GetItemData (PyObject *o)

Get a pointer to per-item data for a class with
@ref{54b,,Py_TPFLAGS_ITEMS_AT_END}.

On error, set an exception and return @code{NULL}.
@ref{2c3,,TypeError} is raised if `o' does not have
@ref{54b,,Py_TPFLAGS_ITEMS_AT_END} set.


Adicionado na versão 3.12.

@end deffn

@geindex PyObject_VisitManagedDict (C function)
@anchor{c-api/object c PyObject_VisitManagedDict}@anchor{369}
@deffn {C Função} 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{36b,,Py_TPFLAGS_MANAGED_DICT} flag set.


Adicionado na versão 3.13.

@end deffn

@geindex PyObject_ClearManagedDict (C function)
@anchor{c-api/object c PyObject_ClearManagedDict}@anchor{36a}
@deffn {C Função} void PyObject_ClearManagedDict (PyObject *obj)

Clear the managed dictionary of `obj'.

This function must only be called in a clear function of the type which
has the @ref{36b,,Py_TPFLAGS_MANAGED_DICT} flag set.


Adicionado na versão 3.13.

@end deffn

@node Protocolo de chamada,Protocolo de número,Protocolo de objeto,Camada de Objetos Abstratos
@anchor{c-api/call doc}@anchor{4f18}@anchor{c-api/call call}@anchor{583}@anchor{c-api/call call-protocol}@anchor{4f19}@anchor{c-api/call translation-repo}@anchor{4f1a}
@subsection Protocolo de chamada


O CPython permite dois protocolos de chamada: `tp_call' e vectorcall.

@menu
* O protocolo tp_call:: 
* O protocolo vectorcall:: 
* API de chamada de objetos:: 
* API de suporte a chamadas:: 

@end menu

@node O protocolo tp_call,O protocolo vectorcall,,Protocolo de chamada
@anchor{c-api/call the-tp-call-protocol}@anchor{4f1b}
@subsubsection O protocolo `tp_call'


Instâncias de classe que definem @ref{559,,tp_call} são chamáveis. A assinatura do slot é:

@example
PyObject *tp_call(PyObject *callable, PyObject *args, PyObject *kwargs);
@end example

Uma chamada é feita usando uma tupla para os argumentos posicionais e um dicionário para os argumentos nomeados, similar a @code{callable(*args, **kwargs)} no Python. `args' não pode ser nulo (utilize uma tupla vazia se não houver argumentos), mas `kwargs' pode ser `NULL' se não houver argumentos nomeados.

Esta convenção não é somente usada por `tp_call': @ref{57f,,tp_new} e @ref{581,,tp_init} também passam argumento dessa forma.

Para chamar um objeto, use @ref{39c,,PyObject_Call()} ou outra @ref{4f1c,,API de chamada}.

@node O protocolo vectorcall,API de chamada de objetos,O protocolo tp_call,Protocolo de chamada
@anchor{c-api/call the-vectorcall-protocol}@anchor{4f1d}@anchor{c-api/call vectorcall}@anchor{552}
@subsubsection O protocolo vectorcall



Adicionado na versão 3.9.


O protocolo vectorcall foi introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} como um protocolo adicional para tornar invocações mais eficientes.

Como regra de ouro, CPython vai preferir o vectorcall para chamadas internas se o chamável suportar. Entretanto, isso não é uma regra rígida. Ademais, alguma extensões de terceiros usam `tp_call' diretamente (em vez de utilizar @ref{39c,,PyObject_Call()}). Portanto, uma classe que suporta vectorcall precisa também implementar @ref{559,,tp_call}. Além disso, o chamável precisa se comportar da mesma forma independe de qual protocolo é utilizado. A forma recomendada de alcançar isso é definindo @ref{559,,tp_call} para @ref{556,,PyVectorcall_Call()}. Vale a pena repetir:

@cartouche
@quotation Aviso 
Uma classe que suporte vectorcall também `precisa' implementar @ref{559,,tp_call} com a mesma semântica.
@end quotation
@end cartouche


Alterado na versão 3.12: O sinalizador @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} agora é removido da classe quando o método @ref{558,,__call__()} está reatribuído. (Internamente, isso apenas define @ref{559,,tp_call}, e portanto, pode fazê-lo comportar-se de forma diferente da função vectorcall. Em versões anteriores do Python, vectorcall só deve ser usado com tipos @ref{3c2,,imutáveis} ou estáticos.


Uma classe não deve implementar vectorcall se for mais lento que `tp_call'. Por exemplo, se o chamador precisa converter os argumentos para uma tupla args e um dicionário kwargs de qualquer forma, então não é necessário implementar vectorcall.

Classes podem implementar o protocolo vectorcall ativando o sinalizador @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} e configurando @ref{4f1e,,tp_vectorcall_offset} para o offset dentro da estrutura do objeto onde uma `vectorcallfunc' aparece. Este é um ponteiro para uma função com a seguinte assinatura:

@geindex vectorcallfunc (C type)
@anchor{c-api/call c vectorcallfunc}@anchor{557}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*vectorcallfunc)(@ref{339,,PyObject} *callable, @ref{339,,PyObject} *const *args, size_t nargsf, @ref{339,,PyObject} *kwnames)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn


@itemize -

@item 
`callable' é o objeto sendo chamado.

@item 

@table @asis

@item `args' é um array C formado pelos argumentos posicionais seguidos de

valores dos argumentos nomeados. Este pode ser `NULL' se não existirem argumentos.
@end table

@item 

@table @asis

@item `nargsf' é o número de argumentos posicionais somado á possível

Sinalizador @ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET}. Para obter o número real de argumentos posicionais de `nargsf', use @ref{555,,PyVectorcall_NARGS()}.
@end table

@item 

@table @asis

@item `kwnames' é uma tupla contendo os nomes dos argumentos nomeados;

em outras palavras, as chaves do dicionário kwargs. Estes nomes devem ser strings (instâncias de @code{str} ou uma subclasse) e eles devem ser únicos. Se não existem argumentos nomeados, então `kwnames' deve então ser `NULL'.
@end table
@end itemize

@geindex PY_VECTORCALL_ARGUMENTS_OFFSET (C macro)
@anchor{c-api/call c PY_VECTORCALL_ARGUMENTS_OFFSET}@anchor{55e}
@deffn {C Macro} PY_VECTORCALL_ARGUMENTS_OFFSET
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Se esse sinalizador é definido em um argumento `nargsf' do vectorcall, deve ser permitido ao chamado temporariamente mudar @code{args[-1]}. Em outras palavras, `args' aponta para o argumento 1 (não 0) no vetor alocado. O chamado deve restaurar o valor de @code{args[-1]} antes de retornar.

Para  @ref{55d,,PyObject_VectorcallMethod()}, este sinalizador significa que @code{args[0]} pode ser alterado.

Sempre que podem realizar a um custo tão baixo (sem alocações adicionais), invocadores são encorajados a usar @ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET}. Isso permitirá invocados como métodos vinculados a instâncias fazerem suas próprias invocações (o que inclui um argumento `self') muito eficientemente.


Adicionado na versão 3.8.

@end deffn

Para invocar um objeto que implementa vectorcall, utilize a função @ref{4f1c,,call API}  como qualquer outra invocável. @ref{55c,,PyObject_Vectorcall()} será normalmente mais eficiente.

@menu
* Controle de recursão: Controle de recursão<2>. 
* API de suporte à chamada de vetores:: 

@end menu

@node Controle de recursão<2>,API de suporte à chamada de vetores,,O protocolo vectorcall
@anchor{c-api/call recursion-control}@anchor{4f1f}
@subsubsection Controle de recursão


Quando utilizando `tp_call', invocadores não precisam se preocupar sobre @ref{4e95,,recursão}: CPython usa @ref{97a,,Py_EnterRecursiveCall()} e @ref{97b,,Py_LeaveRecursiveCall()} para chamadas utilizando `tp_call'.

Por questão de eficiência, este não é o caso de chamadas utilizando o vectorcall: o que chama deve utilizar `Py_EnterRecursiveCall' e `Py_LeaveRecursiveCall' se necessário.

@node API de suporte à chamada de vetores,,Controle de recursão<2>,O protocolo vectorcall
@anchor{c-api/call vectorcall-support-api}@anchor{4f20}
@subsubsection API de suporte à chamada de vetores


@geindex PyVectorcall_NARGS (C function)
@anchor{c-api/call c PyVectorcall_NARGS}@anchor{555}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyVectorcall_NARGS (size_t nargsf)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Dado um argumento de chamada de vetor `nargsf', retorna o número real de argumentos. Atualmente equivalente a:

@example
(Py_ssize_t)(nargsf & ~PY_VECTORCALL_ARGUMENTS_OFFSET)
@end example

Entretanto, a função @code{PyVectorcall_NARGS} deve ser usada para permitir para futuras extensões.


Adicionado na versão 3.8.

@end deffn

@geindex PyVectorcall_Function (C function)
@anchor{c-api/call c PyVectorcall_Function}@anchor{4f21}
@deffn {C Função} @ref{557,,vectorcallfunc} PyVectorcall_Function (PyObject *op)

Se `op' não suporta o protocolo de chamada de vetor (seja porque o tipo ou a instância específica não suportam), retorne `NULL'. Se não, retorne o ponteiro da função chamada de vetor armazenado em `op'. Esta função nunca levanta uma exceção.

É mais útil checar se `op' suporta ou não chamada de vetor, o que pode ser feito checando @code{PyVectorcall_Function(op) != NULL}.


Adicionado na versão 3.9.

@end deffn

@geindex PyVectorcall_Call (C function)
@anchor{c-api/call c PyVectorcall_Call}@anchor{556}
@deffn {C Função} @ref{339,,PyObject} *PyVectorcall_Call (PyObject *callable, PyObject *tuple, PyObject *dict)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Chama o @ref{557,,vectorcallfunc} de `callable' com argumentos posicionais e nomeados dados em uma tupla e dicionário, respectivamente.

Esta é uma função especializada, feita para ser colocada no slot @ref{559,,tp_call} ou usada em uma implementação de @code{tp_call}. Ela não verifica o sinalizador @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} e não retorna para @code{tp_call}.


Adicionado na versão 3.8.

@end deffn

@node API de chamada de objetos,API de suporte a chamadas,O protocolo vectorcall,Protocolo de chamada
@anchor{c-api/call capi-call}@anchor{4f1c}@anchor{c-api/call object-calling-api}@anchor{4f22}
@subsubsection API de chamada de objetos


Várias funções estão disponíveis para chamar um objeto Python. Cada uma converte seus argumentos para uma convenção suportada pelo objeto chamado – seja `tp_call' ou chamada de vetor. Para fazer o mínimo possível de conversões, escolha um que melhor se adapte ao formato de dados que você tem disponível.

A tabela a seguir resume as funções disponíveis; por favor, veja a documentação individual para detalhes.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Função

@tab

chamável

@tab

args

@tab

kwargs

@item

@ref{39c,,PyObject_Call()}

@tab

@code{PyObject *}

@tab

tupla

@tab

dict/@code{NULL}

@item

@ref{39b,,PyObject_CallNoArgs()}

@tab

@code{PyObject *}

@tab

—

@tab

—

@item

@ref{97f,,PyObject_CallOneArg()}

@tab

@code{PyObject *}

@tab

1 objeto

@tab

—

@item

@ref{4b56,,PyObject_CallObject()}

@tab

@code{PyObject *}

@tab

tupla/@code{NULL}

@tab

—

@item

@ref{39e,,PyObject_CallFunction()}

@tab

@code{PyObject *}

@tab

format

@tab

—

@item

@ref{39f,,PyObject_CallMethod()}

@tab

obj + @code{char*}

@tab

format

@tab

—

@item

@ref{4d26,,PyObject_CallFunctionObjArgs()}

@tab

@code{PyObject *}

@tab

variádica

@tab

—

@item

@ref{1b74,,PyObject_CallMethodObjArgs()}

@tab

obj + nome

@tab

variádica

@tab

—

@item

@ref{4f23,,PyObject_CallMethodNoArgs()}

@tab

obj + nome

@tab

—

@tab

—

@item

@ref{4f24,,PyObject_CallMethodOneArg()}

@tab

obj + nome

@tab

1 objeto

@tab

—

@item

@ref{55c,,PyObject_Vectorcall()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

vectorcall

@item

@ref{4f25,,PyObject_VectorcallDict()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

dict/@code{NULL}

@item

@ref{55d,,PyObject_VectorcallMethod()}

@tab

arg + nome

@tab

vectorcall

@tab

vectorcall

@end multitable


@geindex PyObject_Call (C function)
@anchor{c-api/call c PyObject_Call}@anchor{39c}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Call (PyObject *callable, PyObject *args, PyObject *kwargs)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama um objeto Python chamável de `callable', com argumentos dados pela tupla `args', e argumentos nomeados dados pelo dicionário `kwargs'.

`args' não deve ser `NULL'; use uma tupla vazia se não precisar de argumentos. Se nenhum argumento nomeado é necessário, `kwargs' pode ser `NULL'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.

Esse é o equivalente da expressão Python: @code{callable(*args, **kwargs)}.
@end deffn

@geindex PyObject_CallNoArgs (C function)
@anchor{c-api/call c PyObject_CallNoArgs}@anchor{39b}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallNoArgs (PyObject *callable)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Chama um objeto Python chamável de `callable' sem nenhum argumento. É o jeito mais eficiente de chamar um objeto Python sem nenhum argumento.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_CallOneArg (C function)
@anchor{c-api/call c PyObject_CallOneArg}@anchor{97f}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallOneArg (PyObject *callable, PyObject *arg)
`Retorna valor: Nova referência.'
Chama um objeto Python chamável de `callable' com exatamente 1 argumento posicional `arg' e nenhum argumento nomeado.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_CallObject (C function)
@anchor{c-api/call c PyObject_CallObject}@anchor{4b56}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallObject (PyObject *callable, PyObject *args)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama um objeto Python chamável de `callable' com argumentos dados pela tupla `args'. Se nenhum argumento é necessário, `args' pode ser `NULL'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.

Este é o equivalente da expressão Python: @code{callable(*args)}.
@end deffn

@geindex PyObject_CallFunction (C function)
@anchor{c-api/call c PyObject_CallFunction}@anchor{39e}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallFunction (PyObject *callable, const char *format, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama um objeto Python chamável de `callable', com um número variável de argumentos C. Os argumentos C são descritos usando uma string de estilo no formato @ref{8ac,,Py_BuildValue()}. O formato pode ser `NULL', indicando que nenhum argumento foi provido.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.

Este é o equivalente da expressão Python: @code{callable(*args)}.

Note que se você apenas passa argumentos @ref{339,,PyObject}*, @ref{4d26,,PyObject_CallFunctionObjArgs()} é uma alternativa mais rápida.


Alterado na versão 3.4: O tipo de `format' foi mudado de @code{char *}.

@end deffn

@geindex PyObject_CallMethod (C function)
@anchor{c-api/call c PyObject_CallMethod}@anchor{39f}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallMethod (PyObject *obj, const char *name, const char *format, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama o método chamado `name' do objeto `obj' com um número variável de argumentos C. Os argumentos C são descritos com uma string de formato @ref{8ac,,Py_BuildValue()} que deve produzir uma tupla.

O formato pode ser `NULL', indicado que nenhum argumento foi provido.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.

Este é o equivalente da expressão Python: @code{obj.name(arg1, arg2, ...)}.

Note que se você apenas passa argumentos @ref{339,,PyObject}*, @ref{1b74,,PyObject_CallMethodObjArgs()} é uma alternativa mais rápida.


Alterado na versão 3.4: Os tipos de `name' e `format' foram mudados de @code{char *}.

@end deffn

@geindex PyObject_CallFunctionObjArgs (C function)
@anchor{c-api/call c PyObject_CallFunctionObjArgs}@anchor{4d26}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallFunctionObjArgs (PyObject *callable, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama um objeto Python chamável de `callable', com um número variável de argumentos @ref{339,,PyObject}*. Os argumentos são providos como um número variável de parâmetros seguidos por um `NULL'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.

Este é o equivalente da expressão Python: @code{callable(arg1, arg2, ...)}.
@end deffn

@geindex PyObject_CallMethodObjArgs (C function)
@anchor{c-api/call c PyObject_CallMethodObjArgs}@anchor{1b74}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallMethodObjArgs (PyObject *obj, PyObject *name, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Chama um método do objeto Python `obj', onde o nome do método é dado como um objeto string Python em `name'. É chamado com um número variável de argumentos @ref{339,,PyObject}*. Os argumentos são providos como um número variável de parâmetros seguidos por um `NULL'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.
@end deffn

@geindex PyObject_CallMethodNoArgs (C function)
@anchor{c-api/call c PyObject_CallMethodNoArgs}@anchor{4f23}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallMethodNoArgs (PyObject *obj, PyObject *name)

Chama um método do objeto Python `obj' sem argumentos, onde o nome do método é fornecido como um objeto string do Python em `name'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_CallMethodOneArg (C function)
@anchor{c-api/call c PyObject_CallMethodOneArg}@anchor{4f24}
@deffn {C Função} @ref{339,,PyObject} *PyObject_CallMethodOneArg (PyObject *obj, PyObject *name, PyObject *arg)

Chama um método do objeto Python `obj' com um argumento posicional `arg', onde o nome do método é fornecido como um objeto string do Python em `name'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.9.

@end deffn

@geindex _PyObject_Vectorcall (C function)

@geindex PyObject_Vectorcall (C function)
@anchor{c-api/call c _PyObject_Vectorcall}@anchor{4f26}@anchor{c-api/call c PyObject_Vectorcall}@anchor{55c}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Vectorcall (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Chama um objeto Python chamável `callable'. Os argumentos são os mesmos de @ref{557,,vectorcallfunc}. Se `callable' tiver suporte a @ref{552,,vectorcall}, isso chamará diretamente a função vectorcall armazenada em `callable'.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.8: as @code{_PyObject_Vectorcall}



Alterado na versão 3.9: Renamed to the current name, without the leading underscore.
The old provisional name is @ref{209,,soft deprecated}.

@end deffn

@geindex PyObject_VectorcallDict (C function)
@anchor{c-api/call c PyObject_VectorcallDict}@anchor{4f25}
@deffn {C Função} @ref{339,,PyObject} *PyObject_VectorcallDict (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)

Chama `callable' com argumentos posicionais passados exatamente como no protocolo @ref{552,,vectorcall}, mas com argumentos nomeados passados como um dicionário `kwdict'. O array `args' contém apenas os argumentos posicionais.

Independentemente de qual protocolo é usado internamente, uma conversão de argumentos precisa ser feita. Portanto, esta função só deve ser usada se o chamador já tiver um dicionário pronto para usar para os argumentos nomeados, mas não uma tupla para os argumentos posicionais.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_VectorcallMethod (C function)
@anchor{c-api/call c PyObject_VectorcallMethod}@anchor{55d}
@deffn {C Função} @ref{339,,PyObject} *PyObject_VectorcallMethod (PyObject *name, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Chama um método usando a convenção de chamada vectorcall. O nome do método é dado como uma string Python `name'. O objeto cujo método é chamado é `args[0]', e o array `args' começando em `args[1]' representa os argumentos da chamada. Deve haver pelo menos um argumento posicional. `nargsf' é o número de argumentos posicionais incluindo `args[0]', mais @ref{55e,,PY_VECTORCALL_ARGUMENTS_OFFSET} se o valor de @code{args[0]} puder ser alterado temporariamente. Argumentos nomeados podem ser passados como em @ref{55c,,PyObject_Vectorcall()}.

Se o objeto tem o recurso @ref{4dcf,,Py_TPFLAGS_METHOD_DESCRIPTOR}, isso irá chamar o objeto de método não vinculado com o vetor `args' inteiro como argumentos.

Retorna o resultado da chamada em sucesso, ou levanta uma exceção e retorna `NULL' em caso de falha.


Adicionado na versão 3.9.

@end deffn

@node API de suporte a chamadas,,API de chamada de objetos,Protocolo de chamada
@anchor{c-api/call call-support-api}@anchor{4f27}
@subsubsection API de suporte a chamadas


@geindex PyCallable_Check (C function)
@anchor{c-api/call c PyCallable_Check}@anchor{4c2b}
@deffn {C Função} int PyCallable_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Determine se o objeto `o' é chamável. Devolva @code{1} se o objeto é chamável e @code{0} caso contrário. Esta função sempre tem êxito.
@end deffn

@node Protocolo de número,Protocolo de sequência,Protocolo de chamada,Camada de Objetos Abstratos
@anchor{c-api/number doc}@anchor{4f28}@anchor{c-api/number number}@anchor{4f29}@anchor{c-api/number number-protocol}@anchor{4f2a}@anchor{c-api/number translation-repo}@anchor{4f2b}
@subsection Protocolo de número


@geindex PyNumber_Check (C function)
@anchor{c-api/number c PyNumber_Check}@anchor{a70}
@deffn {C Função} int PyNumber_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se o objeto `o' fornece protocolos numéricos; caso contrário, retorna falso. Esta função sempre tem sucesso.


Alterado na versão 3.8: Retorna @code{1} se `o' for um número inteiro de índice.

@end deffn

@geindex PyNumber_Add (C function)
@anchor{c-api/number c PyNumber_Add}@anchor{4d02}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Add (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o resultado da adição de `o1' e `o2', ou @code{NULL} em caso de falha. Este é o equivalente da expressão Python @code{o1 + o2}.
@end deffn

@geindex PyNumber_Subtract (C function)
@anchor{c-api/number c PyNumber_Subtract}@anchor{4d1c}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Subtract (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o resultado da subtração de `o2' por `o1', ou @code{NULL} em caso de falha. Este é o equivalente da expressão Python @code{o1 - o2}.
@end deffn

@geindex PyNumber_Multiply (C function)
@anchor{c-api/number c PyNumber_Multiply}@anchor{4d15}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Multiply (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o resultado da multiplicação de `o1' e `o2', ou @code{NULL} em caso de falha. Este é o equivalente da expressão Python @code{o1 * o2}.
@end deffn

@geindex PyNumber_MatrixMultiply (C function)
@anchor{c-api/number c PyNumber_MatrixMultiply}@anchor{ee5}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_MatrixMultiply (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Retorna o resultado da multiplicação da matriz em `o1' e `o2', ou @code{NULL} em caso de falha. Este é o equivalente da expressão Python @code{o1 @@ o2}.


Adicionado na versão 3.5.

@end deffn

@geindex PyNumber_FloorDivide (C function)
@anchor{c-api/number c PyNumber_FloorDivide}@anchor{4d06}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_FloorDivide (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return the floor of `o1' divided by `o2', or @code{NULL} on failure.  This is
the equivalent of the Python expression @code{o1 // o2}.
@end deffn

@geindex PyNumber_TrueDivide (C function)
@anchor{c-api/number c PyNumber_TrueDivide}@anchor{4d1d}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_TrueDivide (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{4d1a}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Remainder (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the remainder of dividing `o1' by `o2', or @code{NULL} on failure.  This is
the equivalent of the Python expression @code{o1 % o2}.
@end deffn

@geindex PyNumber_Divmod (C function)
@anchor{c-api/number c PyNumber_Divmod}@anchor{4d05}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Divmod (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;divmod

See the built-in function @ref{9a9,,divmod()}. Returns @code{NULL} on failure.  This is
the equivalent of the Python expression @code{divmod(o1, o2)}.
@end deffn

@geindex PyNumber_Power (C function)
@anchor{c-api/number c PyNumber_Power}@anchor{4d19}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Power (PyObject *o1, PyObject *o2, PyObject *o3)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;pow

See the built-in function @ref{9da,,pow()}. Returns @code{NULL} on failure.  This is the
equivalent of the Python expression @code{pow(o1, o2, o3)}, where `o3' is optional.
If `o3' is to be ignored, pass @ref{4b48,,Py_None} in its place (passing @code{NULL} for
`o3' would cause an illegal memory access).
@end deffn

@geindex PyNumber_Negative (C function)
@anchor{c-api/number c PyNumber_Negative}@anchor{4d16}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Negative (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the negation of `o' on success, or @code{NULL} on failure. This is the
equivalent of the Python expression @code{-o}.
@end deffn

@geindex PyNumber_Positive (C function)
@anchor{c-api/number c PyNumber_Positive}@anchor{4d18}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Positive (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns `o' on success, or @code{NULL} on failure.  This is the equivalent of the
Python expression @code{+o}.
@end deffn

@geindex PyNumber_Absolute (C function)
@anchor{c-api/number c PyNumber_Absolute}@anchor{4d01}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Absolute (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;abs

Returns the absolute value of `o', or @code{NULL} on failure.  This is the equivalent
of the Python expression @code{abs(o)}.
@end deffn

@geindex PyNumber_Invert (C function)
@anchor{c-api/number c PyNumber_Invert}@anchor{4d13}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Invert (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the bitwise negation of `o' on success, or @code{NULL} on failure.  This is
the equivalent of the Python expression @code{~o}.
@end deffn

@geindex PyNumber_Lshift (C function)
@anchor{c-api/number c PyNumber_Lshift}@anchor{4d14}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Lshift (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of left shifting `o1' by `o2' on success, or @code{NULL} on
failure.  This is the equivalent of the Python expression @code{o1 << o2}.
@end deffn

@geindex PyNumber_Rshift (C function)
@anchor{c-api/number c PyNumber_Rshift}@anchor{4d1b}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Rshift (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of right shifting `o1' by `o2' on success, or @code{NULL} on
failure.  This is the equivalent of the Python expression @code{o1 >> o2}.
@end deffn

@geindex PyNumber_And (C function)
@anchor{c-api/number c PyNumber_And}@anchor{4d03}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_And (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise and” of `o1' and `o2' on success and @code{NULL} on failure.
This is the equivalent of the Python expression @code{o1 & o2}.
@end deffn

@geindex PyNumber_Xor (C function)
@anchor{c-api/number c PyNumber_Xor}@anchor{4d1e}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Xor (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise exclusive or” of `o1' by `o2' on success, or @code{NULL} on
failure.  This is the equivalent of the Python expression @code{o1 ^ o2}.
@end deffn

@geindex PyNumber_Or (C function)
@anchor{c-api/number c PyNumber_Or}@anchor{4d17}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Or (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise or” of `o1' and `o2' on success, or @code{NULL} on failure.
This is the equivalent of the Python expression @code{o1 | o2}.
@end deffn

@geindex PyNumber_InPlaceAdd (C function)
@anchor{c-api/number c PyNumber_InPlaceAdd}@anchor{4d07}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceAdd (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of adding `o1' and `o2', or @code{NULL} on failure.  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_InPlaceSubtract (C function)
@anchor{c-api/number c PyNumber_InPlaceSubtract}@anchor{4d10}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceSubtract (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of subtracting `o2' from `o1', or @code{NULL} on failure.  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_InPlaceMultiply (C function)
@anchor{c-api/number c PyNumber_InPlaceMultiply}@anchor{4d0b}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceMultiply (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of multiplying `o1' and `o2', or @code{NULL} on failure.  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_InPlaceMatrixMultiply (C function)
@anchor{c-api/number c PyNumber_InPlaceMatrixMultiply}@anchor{ee6}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceMatrixMultiply (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Returns the result of matrix multiplication on `o1' and `o2', or @code{NULL} on
failure.  The operation is done `in-place' when `o1' supports it.  This is
the equivalent of the Python statement @code{o1 @@= o2}.


Adicionado na versão 3.5.

@end deffn

@geindex PyNumber_InPlaceFloorDivide (C function)
@anchor{c-api/number c PyNumber_InPlaceFloorDivide}@anchor{4d09}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceFloorDivide (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the mathematical floor of dividing `o1' by `o2', or @code{NULL} on failure.
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_InPlaceTrueDivide (C function)
@anchor{c-api/number c PyNumber_InPlaceTrueDivide}@anchor{4d11}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceTrueDivide (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{4d0e}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceRemainder (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the remainder of dividing `o1' by `o2', or @code{NULL} on failure.  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_InPlacePower (C function)
@anchor{c-api/number c PyNumber_InPlacePower}@anchor{4d0d}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlacePower (PyObject *o1, PyObject *o2, PyObject *o3)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;pow

See the built-in function @ref{9da,,pow()}. Returns @code{NULL} on failure.  The operation
is done `in-place' when `o1' supports it.  This is the equivalent of the Python
statement @code{o1 **= o2} when o3 is @ref{4b48,,Py_None}, or an in-place variant of
@code{pow(o1, o2, o3)} otherwise. If `o3' is to be ignored, pass @ref{4b48,,Py_None}
in its place (passing @code{NULL} for `o3' would cause an illegal memory access).
@end deffn

@geindex PyNumber_InPlaceLshift (C function)
@anchor{c-api/number c PyNumber_InPlaceLshift}@anchor{4d0a}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceLshift (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of left shifting `o1' by `o2' on success, or @code{NULL} on
failure.  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_InPlaceRshift (C function)
@anchor{c-api/number c PyNumber_InPlaceRshift}@anchor{4d0f}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceRshift (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the result of right shifting `o1' by `o2' on success, or @code{NULL} on
failure.  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_InPlaceAnd (C function)
@anchor{c-api/number c PyNumber_InPlaceAnd}@anchor{4d08}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceAnd (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise and” of `o1' and `o2' on success and @code{NULL} on failure. 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_InPlaceXor (C function)
@anchor{c-api/number c PyNumber_InPlaceXor}@anchor{4d12}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceXor (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise exclusive or” of `o1' by `o2' on success, or @code{NULL} on
failure.  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_InPlaceOr (C function)
@anchor{c-api/number c PyNumber_InPlaceOr}@anchor{4d0c}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_InPlaceOr (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the “bitwise or” of `o1' and `o2' on success, or @code{NULL} on failure.  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_Long (C function)
@anchor{c-api/number c PyNumber_Long}@anchor{a71}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Long (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;int

Returns the `o' converted to an integer object on success, or @code{NULL} on
failure.  This is the equivalent of the Python expression @code{int(o)}.
@end deffn

@geindex PyNumber_Float (C function)
@anchor{c-api/number c PyNumber_Float}@anchor{a72}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Float (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;ponto flutuante

Returns the `o' converted to a float object on success, or @code{NULL} on failure.
This is the equivalent of the Python expression @code{float(o)}.
@end deffn

@geindex PyNumber_Index (C function)
@anchor{c-api/number c PyNumber_Index}@anchor{897}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_Index (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the `o' converted to a Python int on success or @code{NULL} with a
@ref{2c3,,TypeError} exception raised on failure.


Alterado na versão 3.10: O resultado sempre tem o tipo exato @ref{257,,int}. Anteriormente, o resultado poderia ter sido uma instância de uma subclasse de @code{int}.

@end deffn

@geindex PyNumber_ToBase (C function)
@anchor{c-api/number c PyNumber_ToBase}@anchor{18fe}
@deffn {C Função} @ref{339,,PyObject} *PyNumber_ToBase (PyObject *n, int base)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Returns the integer `n' converted to base `base' as a string.  The `base'
argument must be one of 2, 8, 10, or 16.  For base 2, 8, or 16, the
returned string is prefixed with a base marker of @code{'0b'}, @code{'0o'}, or
@code{'0x'}, respectively.  If `n' is not a Python int, it is converted with
@ref{897,,PyNumber_Index()} first.
@end deffn

@geindex PyNumber_AsSsize_t (C function)
@anchor{c-api/number c PyNumber_AsSsize_t}@anchor{4d04}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyNumber_AsSsize_t (PyObject *o, PyObject *exc)
` Parte da @ref{553,,ABI Estável}.'
Returns `o' converted to a @ref{a69,,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{a69,,Py_ssize_t} value would raise an @ref{885,,OverflowError}, then the
`exc' argument is the type of exception that will be raised (usually
@ref{157e,,IndexError} or @ref{885,,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{991}
@deffn {C Função} int PyIndex_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável} desde a versão 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 sequência,Protocolo de mapeamento,Protocolo de número,Camada de Objetos Abstratos
@anchor{c-api/sequence doc}@anchor{4f2c}@anchor{c-api/sequence sequence}@anchor{4f2d}@anchor{c-api/sequence sequence-protocol}@anchor{4f2e}@anchor{c-api/sequence translation-repo}@anchor{4f2f}
@subsection Protocolo de sequência


@geindex PySequence_Check (C function)
@anchor{c-api/sequence c PySequence_Check}@anchor{4d3d}
@deffn {C Função} int PySequence_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se o objeto fornecer o protocolo de sequência e @code{0} caso contrário. Note que ele retorna @code{1} para classes Python com um método @ref{283,,__getitem__()} a menos que sejam subclasses de @ref{256,,dict} já que no caso geral é impossível determinar que tipo de chaves a classe provê. Esta função sempre obtém sucesso.
@end deffn

@geindex PySequence_Size (C function)
@geindex PySequence_Length (C function)
@anchor{c-api/sequence c PySequence_Size}@anchor{1bcc}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySequence_Size (PyObject *o)
@anchor{c-api/sequence c PySequence_Length}@anchor{4d47}
@deffnx {C Função} @ref{a69,,Py_ssize_t} PySequence_Length (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Retorna o número de objetos na sequência `o' em caso de sucesso, ou @code{-1} em caso de falha. Equivale à expressão Python @code{len(o)}.
@end deffn

@geindex PySequence_Concat (C function)
@anchor{c-api/sequence c PySequence_Concat}@anchor{4d3e}
@deffn {C Função} @ref{339,,PyObject} *PySequence_Concat (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a concatenação de `o1' e `o2' em caso de sucesso, e @code{NULL} em caso de falha. Equivale à expressão Python @code{o1 + o2}.
@end deffn

@geindex PySequence_Repeat (C function)
@anchor{c-api/sequence c PySequence_Repeat}@anchor{4d49}
@deffn {C Função} @ref{339,,PyObject} *PySequence_Repeat (PyObject *o, Py_ssize_t count)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o resultado da repetição do objeto sequência `o' `count' vezes ou @code{NULL} em caso de falha. Equivale à expressão Python @code{o * count}.
@end deffn

@geindex PySequence_InPlaceConcat (C function)
@anchor{c-api/sequence c PySequence_InPlaceConcat}@anchor{4d44}
@deffn {C Função} @ref{339,,PyObject} *PySequence_InPlaceConcat (PyObject *o1, PyObject *o2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a concatenação de `o1' e `o2' em caso de sucesso, e @code{NULL} em caso de falha. A operação é feita `localmente' se `o1' permitir. Equivale à expressão Python @code{o1 += o2}.
@end deffn

@geindex PySequence_InPlaceRepeat (C function)
@anchor{c-api/sequence c PySequence_InPlaceRepeat}@anchor{4d45}
@deffn {C Função} @ref{339,,PyObject} *PySequence_InPlaceRepeat (PyObject *o, Py_ssize_t count)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o resultado da repetição do objeto sequência `o' `count' vezes ou @code{NULL} em caso de falha. A operação é feita `localmente' se `o' permitir. Equivale à expressão Python @code{o *= count}.
@end deffn

@geindex PySequence_GetItem (C function)
@anchor{c-api/sequence c PySequence_GetItem}@anchor{1bcd}
@deffn {C Função} @ref{339,,PyObject} *PySequence_GetItem (PyObject *o, Py_ssize_t i)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o elemento `i' de `o' ou @code{NULL} em caso de falha. Equivale à expressão Python @code{o[i]}.
@end deffn

@geindex PySequence_GetSlice (C function)
@anchor{c-api/sequence c PySequence_GetSlice}@anchor{4d43}
@deffn {C Função} @ref{339,,PyObject} *PySequence_GetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a fatia do objeto sequência `o' entre `i1' e `i2', ou @code{NULL} em caso de falha. Equivale à expressão Python @code{o[i1:i2]}.
@end deffn

@geindex PySequence_SetItem (C function)
@anchor{c-api/sequence c PySequence_SetItem}@anchor{1bce}
@deffn {C Função} int PySequence_SetItem (PyObject *o, Py_ssize_t i, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
Atribui o objeto `v' ao elemento `i' de `o'. Levanta uma exceção e retorna @code{-1} em caso de falha; retorna @code{0} em caso de sucesso. Esta função `não' rouba uma referência a `v'. Equivale à instrução Python @code{o[i]=v}.

Se `v' for @code{NULL}, o elemento será removido, mas este recurso foi descontinuado em favor do uso de @ref{1bcf,,PySequence_DelItem()}.
@end deffn

@geindex PySequence_DelItem (C function)
@anchor{c-api/sequence c PySequence_DelItem}@anchor{1bcf}
@deffn {C Função} int PySequence_DelItem (PyObject *o, Py_ssize_t i)
` Parte da @ref{553,,ABI Estável}.'
Exclui o elemento `i' do objeto `o'. Retorna @code{-1} em caso de falha. Equivale à instrução Python @code{del o[i]}.
@end deffn

@geindex PySequence_SetSlice (C function)
@anchor{c-api/sequence c PySequence_SetSlice}@anchor{4d4a}
@deffn {C Função} int PySequence_SetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
Atribui o objeto sequência `v' à fatia no objeto sequência `o' de `i1' a `i2'. Equivale à instrução Python @code{o[i1:i2] = v}.
@end deffn

@geindex PySequence_DelSlice (C function)
@anchor{c-api/sequence c PySequence_DelSlice}@anchor{4d41}
@deffn {C Função} int PySequence_DelSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
` Parte da @ref{553,,ABI Estável}.'
Exclui a fatia no objeto sequência `o' de `i1' a `i2'. Retorna @code{-1} em caso de falha. Equivale à instrução Python @code{del o[i1:i2]}.
@end deffn

@geindex PySequence_Count (C function)
@anchor{c-api/sequence c PySequence_Count}@anchor{4d40}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySequence_Count (PyObject *o, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Retorna a quantidade de ocorrências de `value' em `o', isto é, retorna a quantidade de chaves onde @code{o[key] == value}. Em caso de falha, retorna @code{-1}. Equivale à expressão Python @code{o.count(value)}.
@end deffn

@geindex PySequence_Contains (C function)
@anchor{c-api/sequence c PySequence_Contains}@anchor{4d3f}
@deffn {C Função} int PySequence_Contains (PyObject *o, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Determina se `o' contém `value'. Se um item em `o' for igual a `value', retorna @code{1}, senão, retorna @code{0}. Em caso de erro, retorna @code{-1}. Equivale à expressão Python @code{value in o}.
@end deffn

@geindex PySequence_Index (C function)
@anchor{c-api/sequence c PySequence_Index}@anchor{4d46}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySequence_Index (PyObject *o, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Retorna o primeiro índice `i' tal que @code{o[i] == value}. Em caso de erro, retorna @code{-1}. Equivale à expressão Python @code{o.index(value)}.
@end deffn

@geindex PySequence_List (C function)
@anchor{c-api/sequence c PySequence_List}@anchor{4d48}
@deffn {C Função} @ref{339,,PyObject} *PySequence_List (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um objeto lista com o mesmo conteúdo da sequência ou iterável `o', ou @code{NULL} em caso de falha. Garante-se que a lista retornada será nova. Equivale à expressão Python @code{list(o)}.
@end deffn

@geindex PySequence_Tuple (C function)
@anchor{c-api/sequence c PySequence_Tuple}@anchor{4d4b}
@deffn {C Função} @ref{339,,PyObject} *PySequence_Tuple (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;tupla

Retorna o objeto tupla com o mesmo conteúdo da sequência ou iterável `o', ou @code{NULL} em caso de falha. Se `o' for uma tupla, retorna uma nova referência. Senão, uma tupla será construída com o conteúdo apropriado. Equivale à expressão Python @code{tuple(o)}.
@end deffn

@geindex PySequence_Fast (C function)
@anchor{c-api/sequence c PySequence_Fast}@anchor{4d42}
@deffn {C Função} @ref{339,,PyObject} *PySequence_Fast (PyObject *o, const char *m)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a sequência ou iterável `o' como um objeto usável por outras funções da família @code{PySequence_Fast*}. Se o objeto não for uma sequência ou iterável, levanta @ref{2c3,,TypeError} com `m' sendo o texto da mensagem. Retorna @code{NULL} em caso de falha.

As funções @code{PySequence_Fast*} têm esse nome porque presumem que `o' é um @ref{4eac,,PyTupleObject} ou um @ref{4f30,,PyListObject} e porque acessam os campos de dados de `o' diretamente.

Como detalhe de implementação de CPython, se `o' já for uma sequência ou lista, ele será retornado.
@end deffn

@geindex PySequence_Fast_GET_SIZE (C function)
@anchor{c-api/sequence c PySequence_Fast_GET_SIZE}@anchor{4f31}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySequence_Fast_GET_SIZE (PyObject *o)

Retorna o comprimento de `o', presumindo que `o' foi retornado por @ref{4d42,,PySequence_Fast()} e que `o' não seja @code{NULL}. O tamanho também pode ser obtido ao chamar @ref{1bcc,,PySequence_Size()} em `o', mas @ref{4f31,,PySequence_Fast_GET_SIZE()} é mais rápida, ao supor que `o' é uma lista ou tupla.
@end deffn

@geindex PySequence_Fast_GET_ITEM (C function)
@anchor{c-api/sequence c PySequence_Fast_GET_ITEM}@anchor{4f32}
@deffn {C Função} @ref{339,,PyObject} *PySequence_Fast_GET_ITEM (PyObject *o, Py_ssize_t i)
`Retorna valor: Referência emprestada.'
Retorna o elemento `i' de `o', presumindo que `o' foi retornado por @ref{4d42,,PySequence_Fast()}, que `o' seja @code{NULL}, e que `i' esteja nos limites.
@end deffn

@geindex PySequence_Fast_ITEMS (C function)
@anchor{c-api/sequence c PySequence_Fast_ITEMS}@anchor{4f33}
@deffn {C Função} @ref{339,,PyObject} **PySequence_Fast_ITEMS (PyObject *o)

Retorna o vetor subjacente de ponteiros PyObject. Presume que `o' foi retornado por @ref{4d42,,PySequence_Fast()} e que `o' não seja @code{NULL}.

Note que, se uma lista for redimensionada, a realocação poderá reposicionar o vetor de itens. Portanto, só use o ponteiro de vetor subjacente em contextos onde a sequência não mudará.
@end deffn

@geindex PySequence_ITEM (C function)
@anchor{c-api/sequence c PySequence_ITEM}@anchor{4f34}
@deffn {C Função} @ref{339,,PyObject} *PySequence_ITEM (PyObject *o, Py_ssize_t i)
`Retorna valor: Nova referência.'
Retorna o elemento `i' de `o', ou @code{NULL} em caso de falha. É uma forma mais rápida de @ref{1bcd,,PySequence_GetItem()}, mas sem verificar se @ref{4d3d,,PySequence_Check()} em `o' é verdadeiro e sem ajustar índices negativos.
@end deffn

@node Protocolo de mapeamento,Protocolo Iterador,Protocolo de sequência,Camada de Objetos Abstratos
@anchor{c-api/mapping doc}@anchor{4f35}@anchor{c-api/mapping mapping}@anchor{4f36}@anchor{c-api/mapping mapping-protocol}@anchor{4f37}@anchor{c-api/mapping translation-repo}@anchor{4f38}
@subsection Protocolo de mapeamento


Veja também @ref{4be2,,PyObject_GetItem()}, @ref{4be0,,PyObject_SetItem()} e @ref{4d27,,PyObject_DelItem()}.

@geindex PyMapping_Check (C function)
@anchor{c-api/mapping c PyMapping_Check}@anchor{4ced}
@deffn {C Função} int PyMapping_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se o objeto fornece protocolo de mapeamento ou suporta fatiamento e @code{0} caso contrário. Note que ele retorna @code{1} para classes Python com um método @ref{283,,__getitem__()} visto que geralmente é impossível determinar a que tipo de chaves a classe tem suporte. Esta função sempre tem sucesso.
@end deffn

@geindex PyMapping_Size (C function)
@geindex PyMapping_Length (C function)
@anchor{c-api/mapping c PyMapping_Size}@anchor{1bd0}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyMapping_Size (PyObject *o)
@anchor{c-api/mapping c PyMapping_Length}@anchor{4cef}
@deffnx {C Função} @ref{a69,,Py_ssize_t} PyMapping_Length (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Retorna o número de chaves no objeto `o' em caso de sucesso e @code{-1} em caso de falha. Isso é equivalente à expressão Python @code{len(o)}.
@end deffn

@geindex PyMapping_GetItemString (C function)
@anchor{c-api/mapping c PyMapping_GetItemString}@anchor{4cee}
@deffn {C Função} @ref{339,,PyObject} *PyMapping_GetItemString (PyObject *o, const char *key)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{4be2,,PyObject_GetItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyMapping_GetOptionalItem (C function)
@anchor{c-api/mapping c PyMapping_GetOptionalItem}@anchor{345}
@deffn {C Função} int PyMapping_GetOptionalItem (PyObject *obj, PyObject *key, PyObject **result)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Variante de @ref{4be2,,PyObject_GetItem()} que não levanta @ref{344,,KeyError} se a chave não for encontrada.

Se a chave for encontrada, retorna @code{1} e define `*result' como uma nova @ref{33d,,referência forte} para o valor correspondente. Se a chave não for encontrada, retorna @code{0} e define `*result' como @code{NULL}; o @ref{344,,KeyError} é silenciado. Se um erro diferente de @ref{344,,KeyError} for levanta, retorna @code{-1} e define `*result' como @code{NULL}.


Adicionado na versão 3.13.

@end deffn

@geindex PyMapping_GetOptionalItemString (C function)
@anchor{c-api/mapping c PyMapping_GetOptionalItemString}@anchor{346}
@deffn {C Função} int PyMapping_GetOptionalItemString (PyObject *obj, const char *key, PyObject **result)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
É o mesmo que @ref{345,,PyMapping_GetOptionalItem()}, mas `key' é especificado como uma string de bytes codificada em UTF-8 const char*, em vez de um @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyMapping_SetItemString (C function)
@anchor{c-api/mapping c PyMapping_SetItemString}@anchor{4cf0}
@deffn {C Função} int PyMapping_SetItemString (PyObject *o, const char *key, PyObject *v)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{4be0,,PyObject_SetItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyMapping_DelItem (C function)
@anchor{c-api/mapping c PyMapping_DelItem}@anchor{4f39}
@deffn {C Função} int PyMapping_DelItem (PyObject *o, PyObject *key)

Este é um apelido de @ref{4d27,,PyObject_DelItem()}.
@end deffn

@geindex PyMapping_DelItemString (C function)
@anchor{c-api/mapping c PyMapping_DelItemString}@anchor{4f3a}
@deffn {C Função} int PyMapping_DelItemString (PyObject *o, const char *key)

É o mesmo que @ref{4d27,,PyObject_DelItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyMapping_HasKeyWithError (C function)
@anchor{c-api/mapping c PyMapping_HasKeyWithError}@anchor{37e}
@deffn {C Função} int PyMapping_HasKeyWithError (PyObject *o, PyObject *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna @code{1} se o objeto de mapeamento tiver a chave `key' e @code{0} caso contrário. Isso é equivalente à expressão Python @code{key in o}. Em caso de falha, retorna @code{-1}.


Adicionado na versão 3.13.

@end deffn

@geindex PyMapping_HasKeyStringWithError (C function)
@anchor{c-api/mapping c PyMapping_HasKeyStringWithError}@anchor{380}
@deffn {C Função} int PyMapping_HasKeyStringWithError (PyObject *o, const char *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
É o mesmo que @ref{37e,,PyMapping_HasKeyWithError()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyMapping_HasKey (C function)
@anchor{c-api/mapping c PyMapping_HasKey}@anchor{37f}
@deffn {C Função} int PyMapping_HasKey (PyObject *o, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se o objeto de mapeamento tiver a chave `key' e @code{0} caso contrário. Isso é equivalente à expressão Python @code{key in o}. Esta função sempre tem sucesso.

@cartouche
@quotation Nota 
As exceções que ocorrem quando este construtor chama o método @ref{283,,__getitem__()} são silenciosamente ignoradas. Para o tratamento adequado de erros, use @ref{37e,,PyMapping_HasKeyWithError()}, @ref{345,,PyMapping_GetOptionalItem()} ou @ref{4be2,,PyObject_GetItem()} em vez disso.
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_HasKeyString (C function)
@anchor{c-api/mapping c PyMapping_HasKeyString}@anchor{381}
@deffn {C Função} int PyMapping_HasKeyString (PyObject *o, const char *key)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{37f,,PyMapping_HasKey()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.

@cartouche
@quotation Nota 
As exceções que ocorrem quando este construtor chama o método @ref{283,,__getitem__()} ou ao criar o objeto temporário @ref{44c,,str} são silenciosamente ignoradas. Para o tratamento adequado de erros, use @ref{380,,PyMapping_HasKeyStringWithError()}, @ref{346,,PyMapping_GetOptionalItemString()} ou @ref{4cee,,PyMapping_GetItemString()} em vez disso.
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_Keys (C function)
@anchor{c-api/mapping c PyMapping_Keys}@anchor{bd5}
@deffn {C Função} @ref{339,,PyObject} *PyMapping_Keys (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Em caso de sucesso, retorna uma lista das chaves no objeto `o'. Em caso de falha, retorna @code{NULL}.


Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.

@end deffn

@geindex PyMapping_Values (C function)
@anchor{c-api/mapping c PyMapping_Values}@anchor{bd6}
@deffn {C Função} @ref{339,,PyObject} *PyMapping_Values (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Em caso de sucesso, retorna uma lista dos valores no objeto `o'. Em caso de falha, retorna @code{NULL}.


Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.

@end deffn

@geindex PyMapping_Items (C function)
@anchor{c-api/mapping c PyMapping_Items}@anchor{bd7}
@deffn {C Função} @ref{339,,PyObject} *PyMapping_Items (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Em caso de sucesso, retorna uma lista dos itens no objeto `o', onde cada item é uma tupla contendo um par de valores-chave. Em caso de falha, retorna @code{NULL}.


Alterado na versão 3.7: Anteriormente, a função retornava uma lista ou tupla.

@end deffn

@node Protocolo Iterador,Protocolo de buffer,Protocolo de mapeamento,Camada de Objetos Abstratos
@anchor{c-api/iter doc}@anchor{4f3b}@anchor{c-api/iter iterator}@anchor{4f3c}@anchor{c-api/iter iterator-protocol}@anchor{4f3d}@anchor{c-api/iter translation-repo}@anchor{4f3e}
@subsection Protocolo Iterador


Existem duas funções especificas para trabalhar com iteradores.

@geindex PyIter_Check (C function)
@anchor{c-api/iter c PyIter_Check}@anchor{1a3e}
@deffn {C Função} int PyIter_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
Retorna valor diferente de zero se o objeto `o' puder ser passado com segurança para @ref{4cd6,,PyIter_Next()}, e @code{0} caso contrário. Esta função sempre é bem-sucedida.
@end deffn

@geindex PyAIter_Check (C function)
@anchor{c-api/iter c PyAIter_Check}@anchor{4bfc}
@deffn {C Função} int PyAIter_Check (PyObject *o)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Retorna valor diferente de zero se o objeto `o' fornecer o protocolo @code{AsyncIterator} e @code{0} caso contrário. Esta função sempre é bem-sucedida.


Adicionado na versão 3.10.

@end deffn

@geindex PyIter_Next (C function)
@anchor{c-api/iter c PyIter_Next}@anchor{4cd6}
@deffn {C Função} @ref{339,,PyObject} *PyIter_Next (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna o próximo valor do iterador `o'. O objeto deve ser um iterador de acordo com @ref{1a3e,,PyIter_Check()} (cabe ao chamador verificar isso). Se não houver valores restantes, retorna @code{NULL} sem nenhuma exceção definida. Se ocorrer um erro ao recuperar o item, retorna @code{NULL} e passa a exceção.
@end deffn

Para escrever um laço que itere sobre um iterador, o código C deve ser algo como isto:

@example
PyObject *iterator = PyObject_GetIter(obj);
PyObject *item;

if (iterator == NULL) @{
    /* propaga o erro */
@}

while ((item = PyIter_Next(iterator))) @{
    /* faz algo com o item */
    ...
    /* liberar a referência quando concluído */
    Py_DECREF(item);
@}

Py_DECREF(iterator);

if (PyErr_Occurred()) @{
    /* propaga o erro */
@}
else @{
    /* continua fazendo algum trabalho útil */
@}
@end example

@geindex PySendResult (C type)
@anchor{c-api/iter c PySendResult}@anchor{4f3f}
@deffn {C Tipo} type PySendResult

O valor de enum usado para representar diferentes resultados de @ref{89c,,PyIter_Send()}.


Adicionado na versão 3.10.

@end deffn

@geindex PyIter_Send (C function)
@anchor{c-api/iter c PyIter_Send}@anchor{89c}
@deffn {C Função} @ref{4f3f,,PySendResult} PyIter_Send (PyObject *iter, PyObject *arg, PyObject **presult)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Envia o valor `arg' para o iterador `iter'. Retorna:


@itemize -

@item 
@code{PYGEN_RETURN} se o iterador retornar. O valor de retorno é retornado via `presult'.

@item 
@code{PYGEN_NEXT} se o iterador render. O valor produzido é retornado via `presult'.

@item 
@code{PYGEN_ERROR} se o iterador tiver levantado uma exceção. `presult' é definido como @code{NULL}.
@end itemize


Adicionado na versão 3.10.

@end deffn

@geindex protocolo de buffer
@geindex interface de buffer;(veja o protocolo de buffer)
@geindex objeto buffer;(veja o protocolo de buffer)

@node Protocolo de buffer,,Protocolo Iterador,Camada de Objetos Abstratos
@anchor{c-api/buffer doc}@anchor{4f40}@anchor{c-api/buffer buffer-protocol}@anchor{4f41}@anchor{c-api/buffer bufferobjects}@anchor{2e8}@anchor{c-api/buffer translation-repo}@anchor{4f42}
@subsection Protocolo de buffer


Certos objetos disponíveis no Python envolvem o acesso a um vetor ou `buffer' de memória subjacente. Esses objetos incluem as classes @ref{1c2,,bytes} e @ref{2ea,,bytearray} embutidas, e alguns tipos de extensão como @ref{1a0,,array.array}. As bibliotecas de terceiros podem definir seus próprios tipos para fins especiais, como processamento de imagem ou análise numérica.

Embora cada um desses tipos tenha sua própria semântica, eles compartilham a característica comum de serem suportados por um buffer de memória possivelmente grande. É desejável, em algumas situações, acessar esse buffer diretamente e sem cópia intermediária.

Python fornece essa facilidade no nível C e Python sob a forma de @ref{2e8,,protocolo de buffer}. Este protocolo tem dois lados:

@geindex PyBufferProcs (tipo C)


@itemize -

@item 
do lado do produtor, um tipo pode exportar uma “interface de buffer” que permite que objetos desse tipo exponham informações sobre o buffer subjacente. Esta interface é descrita na seção @ref{4f43,,Buffer Object Structures}; para Python, consulte @ref{2152,,Emulando tipos buffer}.

@item 
do lado do consumidor, vários meios estão disponíveis para obter o ponteiro para os dados subjacentes de um objeto (por exemplo, um parâmetro de método). Para Python, consulte @ref{2152,,Emulando tipos buffer}.
@end itemize

Objetos simples como @ref{1c2,,bytes} e @ref{2ea,,bytearray} expõem seu buffer subjacente em uma forma orientada a byte. Outras formas são possíveis; por exemplo, os elementos expostos por uma @ref{1a0,,array.array} podem ser valores de vários bytes.

Um exemplo de interface de um consumidor de buffer é o método @ref{cfc,,write()} de objetos arquivo: qualquer objeto que possa exportar uma série de bytes por meio da interface de buffer pode ser gravado em um arquivo. Enquanto o @code{write()} precisa apenas de acesso somente de leitura ao conteúdo interno do objeto passado, outros métodos, como @ref{2df6,,readinto()}, precisam de acesso somente de escrita ao conteúdo interno. A interface de buffer permite que os objetos possam permitir ou rejeitar a exportação para buffers de leitura e escrita ou somente leitura.

Existem duas maneiras para um consumidor da interface de buffer adquirir um buffer em um objeto alvo:


@itemize *

@item 
chamar @ref{399,,PyObject_GetBuffer()} com os parâmetros certos;

@item 
chamar @ref{571,,PyArg_ParseTuple()} (ou um dos seus irmãos) com um dos @ref{8ad,,códigos de formatação} @code{y*}, @code{w*} ou @code{s*}.
@end itemize

Em ambos os casos, @ref{39a,,PyBuffer_Release()} deve ser chamado quando o buffer não é mais necessário. A falta de tal pode levar a vários problemas, tais como vazamentos de recursos.


Adicionado na versão 3.12: O protocolo de buffer agora está acessível em Python, veja @ref{2152,,Emulando tipos buffer} e @ref{2eb,,memoryview}.


@menu
* Estrutura de Buffer:: 
* Tipos de solicitação do buffer:: 
* Vetores Complexos:: 
* Funções relacionadas ao Buffer:: 

@end menu

@node Estrutura de Buffer,Tipos de solicitação do buffer,,Protocolo de buffer
@anchor{c-api/buffer buffer-structure}@anchor{4f44}@anchor{c-api/buffer id1}@anchor{4f45}
@subsubsection Estrutura de Buffer


As estruturas de buffer (ou simplesmente “buffers”) são úteis como uma maneira de expor os dados binários de outro objeto para o programador Python. Eles também podem ser usados como um mecanismo de cópia silenciosa. Usando sua capacidade de fazer referência a um bloco de memória, é possível expor facilmente qualquer dado ao programador Python. A memória pode ser uma matriz grande e constante em uma extensão C, pode ser um bloco bruto de memória para manipulação antes de passar para uma biblioteca do sistema operacional, ou pode ser usado para transmitir dados estruturados no formato nativo e formato de memória.

Ao contrário da maioria dos tipos de dados expostos pelo interpretador Python, os buffers não são ponteiros @ref{339,,PyObject} mas sim estruturas C simples. Isso permite que eles sejam criados e copiados de forma muito simples. Quando um invólucro genérico em torno de um buffer é necessário, um objeto @ref{4f46,,memoryview} pode ser criado.

Para obter instruções curtas sobre como escrever um objeto exportador, consulte @ref{4f43,,Buffer Object Structures}. Para obter um buffer, veja @ref{399,,PyObject_GetBuffer()}.

@geindex Py_buffer (C type)
@anchor{c-api/buffer c Py_buffer}@anchor{758}
@deffn {C Tipo} type Py_buffer
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros) desde a versão 3.11.'
@geindex Py_buffer.buf (C member)
@anchor{c-api/buffer c Py_buffer buf}@anchor{4f47}
@deffn {C Membro} void *buf

Um ponteiro para o início da estrutura lógica descrita pelos campos do buffer. Este pode ser qualquer local dentro do bloco de memória física subjacente do exportador. Por exemplo, com negativo @ref{4f48,,strides} o valor pode apontar para o final do bloco de memória.

Para vetores @ref{23b9,,contíguos}, o valor aponta para o início do bloco de memória.
@end deffn

@geindex Py_buffer.obj (C member)
@anchor{c-api/buffer c Py_buffer obj}@anchor{4f49}
@deffn {C Membro} @ref{339,,PyObject} *obj

Uma nova referência ao objeto sendo exporta. A referência pertence ao consumidor e é automaticamente liberada (por exemplo, a contagem de referências é decrementada) e é atribuída para @code{NULL}  por @ref{39a,,PyBuffer_Release()}. O campo equivale ao valor de retorno de qualquer função padrão da API C.

Como um caso especial, para buffers `temporários' que são encapsulados por @ref{761,,PyMemoryView_FromBuffer()} ou @ref{760,,PyBuffer_FillInfo()} esse campo é @code{NULL}. Em geral, objetos exportadores NÃO DEVEM usar esse esquema.
@end deffn

@geindex Py_buffer.len (C member)
@anchor{c-api/buffer c Py_buffer len}@anchor{4f4a}
@deffn {C Membro} @ref{a69,,Py_ssize_t} len

@code{product(shape) * itemsize}. Para matrizes contíguas, este é o comprimento do bloco de memória subjacente. Para matrizes não contíguas, é o comprimento que a estrutura lógica teria se fosse copiado para uma representação contígua.

Acessando @code{((char *)buf)[0] up to ((char *)buf)[len-1]} só é válido se o buffer tiver sido obtido por uma solicitação que garanta a contiguidade. Na maioria dos casos, esse pedido será @ref{4c0a,,PyBUF_SIMPLE} ou @ref{13fc,,PyBUF_WRITABLE}.
@end deffn

@geindex Py_buffer.readonly (C member)
@anchor{c-api/buffer c Py_buffer readonly}@anchor{4f4b}
@deffn {C Membro} int readonly

Um indicador de se o buffer é somente leitura. Este campo é controlado pelo sinalizador @ref{13fc,,PyBUF_WRITABLE}.
@end deffn

@geindex Py_buffer.itemsize (C member)
@anchor{c-api/buffer c Py_buffer itemsize}@anchor{4f4c}
@deffn {C Membro} @ref{a69,,Py_ssize_t} itemsize

O tamanho do item em bytes de um único elemento. O mesmo que o valor de @ref{1b3b,,struct.calcsize()} chamado em valores não @code{NULL} de @ref{4f4d,,format}.

Exceção importante: Se um consumidor requisita um buffer sem sinalizador @ref{4c02,,PyBUF_FORMAT}, @ref{4f4d,,format} será definido como @code{NULL}, mas @ref{4f4c,,itemsize} ainda terá seu valor para o formato original.

Se @ref{4f4e,,shape} está presente, a igualdade @code{product(shape) * itemsize == len} ainda é válida e o usuário pode usar @ref{4f4c,,itemsize} para navegar o buffer.

Se @ref{4f4e,,shape} é @code{NULL} como resultado de uma @ref{4c0a,,PyBUF_SIMPLE} ou uma requisição @ref{13fc,,PyBUF_WRITABLE}, o consumidor deve ignorar @ref{4f4c,,itemsize} e presumir @code{itemsize == 1}.
@end deffn

@geindex Py_buffer.format (C member)
@anchor{c-api/buffer c Py_buffer format}@anchor{4f4d}
@deffn {C Membro} char *format

Uma string terminada por `NULL' no estilo de sintaxe de módulo @ref{d5,,struct} descrevendo os conteúdos de um único item. Se isso é @code{NULL}, @code{"B"} (unsigned bytes) é presumido.

Este campo é controlado pelo sinalizador @ref{4c02,,PyBUF_FORMAT}.
@end deffn

@geindex Py_buffer.ndim (C member)
@anchor{c-api/buffer c Py_buffer ndim}@anchor{4f4f}
@deffn {C Membro} int ndim

O número de dimensões de memória representado como um array n-dimensional. Se for @code{0}, @ref{4f47,,buf} aponta para um único elemento representando um escalar. Neste caso, @ref{4f4e,,shape}, @ref{4f48,,strides} e @ref{4f50,,suboffsets} DEVEM ser @code{NULL}. O número máximo de dimensões é dado por @ref{4c06,,PyBUF_MAX_NDIM}.
@end deffn

@geindex Py_buffer.shape (C member)
@anchor{c-api/buffer c Py_buffer shape}@anchor{4f4e}
@deffn {C Membro} @ref{a69,,Py_ssize_t} *shape

Uma matriz de @ref{a69,,Py_ssize_t} do comprimento @ref{4f4f,,ndim} indicando a forma da memória como uma matriz n-dimensional. Observe que a forma @code{shape[0] * ... * shape[ndim-1] * itemsize} DEVE ser igual a @ref{4f4a,,len}.

Os valores da forma são restritos a @code{shape[n] >= 0}. The case @code{shape[n] == 0} requer atenção especial. Veja @ref{4f51,,complex arrays} para mais informações.

A forma de acesso a matriz é de somente leitura para o usuário.
@end deffn

@geindex Py_buffer.strides (C member)
@anchor{c-api/buffer c Py_buffer strides}@anchor{4f48}
@deffn {C Membro} @ref{a69,,Py_ssize_t} *strides

Um vetor de @ref{a69,,Py_ssize_t} de comprimento @ref{4f4f,,ndim} dando o número de bytes para saltar para obter um novo elemento em cada dimensão.

Os valores de Stride podem ser qualquer número inteiro. Para arrays regulares, os passos são geralmente positivos, mas um consumidor DEVE ser capaz de lidar com o caso @code{strides[n] <= 0}. Veja @ref{4f51,,complex arrays} para mais informações.

A matriz de passos é somente leitura para o consumidor.
@end deffn

@geindex Py_buffer.suboffsets (C member)
@anchor{c-api/buffer c Py_buffer suboffsets}@anchor{4f50}
@deffn {C Membro} @ref{a69,,Py_ssize_t} *suboffsets

Uma matriz de @ref{a69,,Py_ssize_t} de comprimento @ref{4f4f,,ndim}. Se @code{suboffsets[n] >= 0}, os valores armazenados ao longo da n-ésima dimensão são ponteiros e o valor suboffset determina quantos bytes para adicionar a cada ponteiro após desreferenciar. Um valor de suboffset que é negativo indica que não deve ocorrer desreferenciação (caminhando em um bloco de memória contíguo).

Se todos os subconjuntos forem negativos (ou seja, não é necessário fazer referência), então este campo deve ser @code{NULL} (o valor padrão).

Esse tipo de representação de matriz é usado pela Python Imaging Library (PIL). Veja @ref{4f51,,complex arrays} para obter mais informações sobre como acessar elementos dessa matriz.a matriz.

A matriz de subconjuntos é somente leitura para o consumidor.
@end deffn

@geindex Py_buffer.internal (C member)
@anchor{c-api/buffer c Py_buffer internal}@anchor{4f52}
@deffn {C Membro} void *internal

Isso é para uso interno pelo objeto exportador. Por exemplo, isso pode ser re-moldado como um número inteiro pelo exportador e usado para armazenar bandeiras sobre se os conjuntos de forma, passos e suboffsets devem ou não ser liberados quando o buffer é liberado. O consumidor NÃO DEVE alterar esse valor.
@end deffn
@end deffn

Constantes:

@geindex PyBUF_MAX_NDIM (C macro)
@anchor{c-api/buffer c PyBUF_MAX_NDIM}@anchor{4c06}
@deffn {C Macro} PyBUF_MAX_NDIM
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
O número máximo de dimensões que a memória representa. Exportadores DEVEM respeitar esse limite, consumidores de buffers multidimensionais DEVEM ser capazes de lidar com até @code{PyBUF_MAX_NDIM} dimensões. Atualmente definido como 64.
@end deffn

@node Tipos de solicitação do buffer,Vetores Complexos,Estrutura de Buffer,Protocolo de buffer
@anchor{c-api/buffer buffer-request-types}@anchor{4705}@anchor{c-api/buffer id2}@anchor{4f53}
@subsubsection Tipos de solicitação do buffer


Os buffers geralmente são obtidos enviando uma solicitação de buffer para um objeto exportador via @ref{399,,PyObject_GetBuffer()}. Uma vez que a complexidade da estrutura lógica da memória pode variar drasticamente, o consumidor usa o argumento `flags' para especificar o tipo de buffer exato que pode manipular.

Todos os campos @ref{758,,Py_buffer} são definidos de forma não-ambígua pelo tipo de requisição.

@menu
* campos independentes do pedido:: 
* apenas em formato:: 
* forma@comma{} avanços@comma{} suboffsets: forma avanços suboffsets. 
* requisições contíguas:: 
* requisições compostas:: 

@end menu

@node campos independentes do pedido,apenas em formato,,Tipos de solicitação do buffer
@anchor{c-api/buffer request-independent-fields}@anchor{4f54}
@subsubsection campos independentes do pedido


Os seguintes campos não são influenciados por `flags' e devem sempre ser preenchidos com os valores corretos: @ref{4f49,,obj}, @ref{4f47,,buf}, @ref{4f4a,,len}, @ref{4f4c,,itemsize}, @ref{4f4f,,ndim}.

@node apenas em formato,forma avanços suboffsets,campos independentes do pedido,Tipos de solicitação do buffer
@anchor{c-api/buffer readonly-format}@anchor{4f55}
@subsubsection apenas em formato


@quotation

@geindex PyBUF_WRITABLE (C macro)
@anchor{c-api/buffer c PyBUF_WRITABLE}@anchor{13fc}
@deffn {C Macro} PyBUF_WRITABLE
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Controla o campo @ref{4f4b,,readonly} . Se configurado, o exportador DEVE fornecer um buffer gravável ou então relatar falha. Do contrário, o exportador PODE fornecer um buffer somente leitura ou um buffer gravável , mas a escolha DEVE ser consistente para todos os consumidores. Por exemplo, @ref{4c0a,,PyBUF_SIMPLE} | @ref{13fc,,PyBUF_WRITABLE} pode ser usado para requisitar um buffer simples gravável.
@end deffn

@geindex PyBUF_WRITEABLE (C macro)
@anchor{c-api/buffer c PyBUF_WRITEABLE}@anchor{4f56}
@deffn {C Macro} PyBUF_WRITEABLE

Este é um apelido @ref{209,,suavemente descontinuado} para @ref{13fc,,PyBUF_WRITABLE}.
@end deffn

@geindex PyBUF_FORMAT (C macro)
@anchor{c-api/buffer c PyBUF_FORMAT}@anchor{4c02}
@deffn {C Macro} PyBUF_FORMAT
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Controla o campo @ref{4f4d,,format}. Se configurado, este campo DEVE ser preenchido corretamente. Caso contrário, este campo DEVE ser @code{NULL}.
@end deffn
@end quotation

:@ref{13fc,,PyBUF_WRITABLE} pode ser |’d para qualquer um dos sinalizadores na próxima seção. Uma vez que @ref{13fc,,PyBUF_WRITABLE} é definido como 0, @ref{13fc,,PyBUF_WRITABLE} pode ser usado como uma bandeira autônoma para solicitar um buffer simples gravável.

@ref{4c02,,PyBUF_FORMAT} deve ser |’d para qualquer um dos sinalizadores exceto @ref{4c0a,,PyBUF_SIMPLE}, uma vez que este já indica que o formato @code{B} (unsigned bytes). @code{PyBUF_FORMAT} não pode ser utilizado sozinho.

@node forma avanços suboffsets,requisições contíguas,apenas em formato,Tipos de solicitação do buffer
@anchor{c-api/buffer shape-strides-suboffsets}@anchor{4f57}
@subsubsection forma, avanços, suboffsets


As bandeiras que controlam a estrutura lógica da memória estão listadas em ordem decrescente de complexidade. Observe que cada bandeira contém todos os bits das bandeiras abaixo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Solicitação

@tab

Forma

@tab

Avanços

@tab

subconjuntos

@item

@geindex PyBUF_INDIRECT (C macro)
@anchor{c-api/buffer c PyBUF_INDIRECT}@anchor{4c05}
@deffn {C Macro} PyBUF_INDIRECT
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

se necessário

@item

@geindex PyBUF_STRIDES (C macro)
@anchor{c-api/buffer c PyBUF_STRIDES}@anchor{4c0d}
@deffn {C Macro} PyBUF_STRIDES
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@item

@geindex PyBUF_ND (C macro)
@anchor{c-api/buffer c PyBUF_ND}@anchor{4c07}
@deffn {C Macro} PyBUF_ND
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

NULL

@tab

NULL

@item

@geindex PyBUF_SIMPLE (C macro)
@anchor{c-api/buffer c PyBUF_SIMPLE}@anchor{4c0a}
@deffn {C Macro} PyBUF_SIMPLE
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

NULL

@tab

NULL

@tab

NULL

@end multitable


@geindex contíguo
@geindex contíguo C
@geindex contíguo Fortran

@node requisições contíguas,requisições compostas,forma avanços suboffsets,Tipos de solicitação do buffer
@anchor{c-api/buffer contiguity-requests}@anchor{4f58}
@subsubsection requisições contíguas


@ref{23b9,,contiguity} do C ou Fortran podem ser explicitamente solicitadas, com ou sem informação de avanço. Sem informação de avanço, o buffer deve ser C-contíguo.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

Solicitação

@tab

Forma

@tab

Avanços

@tab

subconjuntos

@tab

contig

@item

@geindex PyBUF_C_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_C_CONTIGUOUS}@anchor{13fd}
@deffn {C Macro} PyBUF_C_CONTIGUOUS
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

C

@item

@geindex PyBUF_F_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_F_CONTIGUOUS}@anchor{13fe}
@deffn {C Macro} PyBUF_F_CONTIGUOUS
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

F

@item

@geindex PyBUF_ANY_CONTIGUOUS (C macro)
@anchor{c-api/buffer c PyBUF_ANY_CONTIGUOUS}@anchor{4bff}
@deffn {C Macro} PyBUF_ANY_CONTIGUOUS
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

C ou F

@item

@ref{4c07,,PyBUF_ND}

@tab

sim

@tab

NULL

@tab

NULL

@tab

C

@end multitable


@node requisições compostas,,requisições contíguas,Tipos de solicitação do buffer
@anchor{c-api/buffer compound-requests}@anchor{4f59}
@subsubsection requisições compostas


Todas as requisições possíveis foram completamente definidas por alguma combinação dos sinalizadores na seção anterior. Por conveniência, o protocolo do buffer fornece combinações frequentemente utilizadas como sinalizadores únicos.

Na seguinte tabela `U' significa contiguidade indefinida. O consumidor deve chamar @ref{75e,,PyBuffer_IsContiguous()} para determinar a contiguidade.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

Solicitação

@tab

Forma

@tab

Avanços

@tab

subconjuntos

@tab

contig

@tab

readonly

@tab

format

@item

@geindex PyBUF_FULL (C macro)
@anchor{c-api/buffer c PyBUF_FULL}@anchor{4c03}
@deffn {C Macro} PyBUF_FULL
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

se necessário

@tab

U

@tab

0

@tab

sim

@item

@geindex PyBUF_FULL_RO (C macro)
@anchor{c-api/buffer c PyBUF_FULL_RO}@anchor{4c04}
@deffn {C Macro} PyBUF_FULL_RO
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

se necessário

@tab

U

@tab

1 ou 0

@tab

sim

@item

@geindex PyBUF_RECORDS (C macro)
@anchor{c-api/buffer c PyBUF_RECORDS}@anchor{4c08}
@deffn {C Macro} PyBUF_RECORDS
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

U

@tab

0

@tab

sim

@item

@geindex PyBUF_RECORDS_RO (C macro)
@anchor{c-api/buffer c PyBUF_RECORDS_RO}@anchor{4c09}
@deffn {C Macro} PyBUF_RECORDS_RO
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

U

@tab

1 ou 0

@tab

sim

@item

@geindex PyBUF_STRIDED (C macro)
@anchor{c-api/buffer c PyBUF_STRIDED}@anchor{4c0b}
@deffn {C Macro} PyBUF_STRIDED
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

U

@tab

0

@tab

NULL

@item

@geindex PyBUF_STRIDED_RO (C macro)
@anchor{c-api/buffer c PyBUF_STRIDED_RO}@anchor{4c0c}
@deffn {C Macro} PyBUF_STRIDED_RO
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

sim

@tab

NULL

@tab

U

@tab

1 ou 0

@tab

NULL

@item

@geindex PyBUF_CONTIG (C macro)
@anchor{c-api/buffer c PyBUF_CONTIG}@anchor{4c00}
@deffn {C Macro} PyBUF_CONTIG
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@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{4c01}
@deffn {C Macro} PyBUF_CONTIG_RO
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
@end deffn

@tab

sim

@tab

NULL

@tab

NULL

@tab

C

@tab

1 ou 0

@tab

NULL

@end multitable


@node Vetores Complexos,Funções relacionadas ao Buffer,Tipos de solicitação do buffer,Protocolo de buffer
@anchor{c-api/buffer complex-arrays}@anchor{4f51}
@subsubsection Vetores Complexos


@menu
* Estilo NumPy; forma e avanços: Estilo NumPy forma e avanços. 
* Estilo-PIL; forma@comma{} avanços e suboffsets: Estilo-PIL forma avanços e suboffsets. 

@end menu

@node Estilo NumPy forma e avanços,Estilo-PIL forma avanços e suboffsets,,Vetores Complexos
@anchor{c-api/buffer numpy-style-shape-and-strides}@anchor{4f5a}
@subsubsection Estilo NumPy: forma e avanços


A estrutura lógica de vetores do estilo NumPy é definida por @ref{4f4c,,itemsize}, @ref{4f4f,,ndim}, @ref{4f4e,,shape} e @ref{4f48,,strides}.

Se @code{ndim == 0}, a localização da memória apontada para @ref{4f47,,buf} é interpretada como um escalar de tamanho @ref{4f4c,,itemsize}. Nesse caso, ambos @ref{4f4e,,shape} e @ref{4f48,,strides} são @code{NULL}.

Se @ref{4f48,,strides} é @code{NULL}, o vetor é interpretado como um vetor C n-dimensional padrão. Caso contrário, o consumidor deve acessar um vetor n-dimensional como a seguir:

@example
ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1];
item = *((typeof(item) *)ptr);
@end example

Como notado acima, @ref{4f47,,buf} pode apontar para qualquer localização dentro do bloco de memória em si. Um exportador pode verificar a validade de um buffer com essa função:

@example
def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    """Verifica se os parâmetros representa um vetor válido dentro
       dos limites da memória alocada:
           char *mem: início do bloco de memória física
           memlen: comprimento do bloco de memória física
           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 avanços e suboffsets,,Estilo NumPy forma e avanços,Vetores Complexos
@anchor{c-api/buffer pil-style-shape-strides-and-suboffsets}@anchor{4f5b}
@subsubsection Estilo-PIL: forma, avanços e suboffsets


Além dos itens normais, uma matriz em estilo PIL pode conter ponteiros que devem ser seguidos para se obter o próximo elemento em uma dimensão. Por exemplo, a matriz tridimensional em C @code{char v[2][2][3]} também pode ser vista como um vetor de 2 ponteiros para duas matrizes bidimensionais: @code{char (*v[2])[2][3]}. Na representação por suboffsets, esses dois ponteiros podem ser embutidos no início de @ref{4f47,,buf}, apontando para duas matrizes @code{char x[2][3]} que podem estar localizadas em qualquer lugar na memória.

Esta é uma função que retorna um ponteiro para o elemento em uma matriz N-D apontada por um índice N-dimensional onde existem ambos passos e subconjuntos não-@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 Funções relacionadas ao Buffer,,Vetores Complexos,Protocolo de buffer
@anchor{c-api/buffer buffer-related-functions}@anchor{4f5c}
@subsubsection Funções relacionadas ao Buffer


@geindex PyObject_CheckBuffer (C function)
@anchor{c-api/buffer c PyObject_CheckBuffer}@anchor{398}
@deffn {C Função} int PyObject_CheckBuffer (PyObject *obj)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retorna @code{1} se `obj' oferece suporte à interface de buffer, se não, @code{0}. Quando @code{1} é retornado, isso não garante que @ref{399,,PyObject_GetBuffer()} será bem sucedida. Esta função é sempre bem sucedida.
@end deffn

@geindex PyObject_GetBuffer (C function)
@anchor{c-api/buffer c PyObject_GetBuffer}@anchor{399}
@deffn {C Função} int PyObject_GetBuffer (PyObject *exporter, Py_buffer *view, int flags)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Envia uma requisição ao `exporter' para preencher a `view' conforme especificado por `flags'. Se o exporter não conseguir prover um buffer do tipo especificado, ele DEVE levantar @ref{15bd,,BufferError}, definir @code{view->obj} para @code{NULL} e retornar @code{-1}.

Em caso de sucesso, preenche `view', define @code{view->obj} para uma nova referência para `exporter' e retorna 0. No caso de provedores de buffer encadeados que redirecionam requisições para um único objeto, @code{view->obj} DEVE se referir a este objeto em vez de `exporter' (Veja @ref{4f43,,Buffer Object Structures}).

Chamadas bem sucedidas para @ref{399,,PyObject_GetBuffer()} devem ser emparelhadas a chamadas para  @ref{39a,,PyBuffer_Release()}, similar para @code{malloc()} e @code{free()}. Assim, após o consumidor terminar com o buffer, @ref{39a,,PyBuffer_Release()} deve ser chamado exatamente uma vez.
@end deffn

@geindex PyBuffer_Release (C function)
@anchor{c-api/buffer c PyBuffer_Release}@anchor{39a}
@deffn {C Função} void PyBuffer_Release (Py_buffer *view)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Libera o buffer de `view' e libera o @ref{33d,,strong reference} (por exemplo, decrementa o contador de referências) para o objeto de suporte da view, @code{view->obj}. Esta função DEVE ser chamada quando o buffer não estiver mais sendo usado, ou o vazamento de referências pode acontecer.

É um erro chamar essa função em um buffer que não foi obtido via @ref{399,,PyObject_GetBuffer()}.
@end deffn

@geindex PyBuffer_SizeFromFormat (C function)
@anchor{c-api/buffer c PyBuffer_SizeFromFormat}@anchor{75a}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyBuffer_SizeFromFormat (const char *format)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retorna o @ref{4f4c,,itemsize} implícito de @ref{4f4d,,format}. Em erro, levantar e exceção e retornar -1.


Adicionado na versão 3.9.

@end deffn

@geindex PyBuffer_IsContiguous (C function)
@anchor{c-api/buffer c PyBuffer_IsContiguous}@anchor{75e}
@deffn {C Função} int PyBuffer_IsContiguous (const Py_buffer *view, char order)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retorna @code{1} se a memória definida pela `view' é @ref{23b9,,contígua} no estilo C (`order' é @code{'C'}) ou no estilo Fortran (`order' é @code{'F'}) ou qualquer outra (`order' é @code{'A'}). Retorna @code{0} caso contrário. Essa função é sempre bem sucedida.
@end deffn

@geindex PyBuffer_GetPointer (C function)
@anchor{c-api/buffer c PyBuffer_GetPointer}@anchor{759}
@deffn {C Função} void *PyBuffer_GetPointer (const Py_buffer *view, const Py_ssize_t *indices)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Recebe a área de memória apontada pelos `indices' dentro da `view' dada. `indices' deve apontar para um array de @code{view->ndim} índices.
@end deffn

@geindex PyBuffer_FromContiguous (C function)
@anchor{c-api/buffer c PyBuffer_FromContiguous}@anchor{75c}
@deffn {C Função} int PyBuffer_FromContiguous (const Py_buffer *view, const void *buf, Py_ssize_t len, char fort)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Copia `len' bytes contíguos de `buf' para `view'. `fort' pode ser @code{'C'} ou @code{'F'} (para ordenação estilo C ou estilo Fortran). Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro.
@end deffn

@geindex PyBuffer_ToContiguous (C function)
@anchor{c-api/buffer c PyBuffer_ToContiguous}@anchor{75b}
@deffn {C Função} int PyBuffer_ToContiguous (void *buf, const Py_buffer *src, Py_ssize_t len, char order)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Copia `len' bytes de `src' para sua representação contígua em `buf'. `order' pode ser @code{'C'} ou @code{'F'} ou @code{'A'} (para ordenação estilo C, Fortran ou qualquer uma). O retorno é @code{0} em caso de sucesso e @code{-1} em caso de falha.

Esta função falha se `len' != `src->len'.
@end deffn

@geindex PyObject_CopyData (C function)
@anchor{c-api/buffer c PyObject_CopyData}@anchor{75d}
@deffn {C Função} int PyObject_CopyData (PyObject *dest, PyObject *src)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Copia os dados do buffer `src' para o buffer `dest'. Pode converter entre buffers de estilo C e/ou estilo Fortran.

@code{0} é retornado em caso de sucesso, @code{-1} em caso de erro.
@end deffn

@geindex PyBuffer_FillContiguousStrides (C function)
@anchor{c-api/buffer c PyBuffer_FillContiguousStrides}@anchor{75f}
@deffn {C Função} void PyBuffer_FillContiguousStrides (int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Preenche o array `strides' com byte-strides de um array @ref{23b9,,contíguo} (estilo C se `order' é @code{'C'} ou estilo Fortran se `order' for @code{'F'}) da forma dada com o número dado de bytes por elemento.
@end deffn

@geindex PyBuffer_FillInfo (C function)
@anchor{c-api/buffer c PyBuffer_FillInfo}@anchor{760}
@deffn {C Função} int PyBuffer_FillInfo (Py_buffer *view, PyObject *exporter, void *buf, Py_ssize_t len, int readonly, int flags)
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Manipula requisições de buffer para um exportador que quer expor `buf' de tamanho `len' com capacidade de escrita definida de acordo com `readonly'. `buf' é interpretada como uma sequência de bytes sem sinal.

O argumento `flags' indica o tipo de requisição. Esta função sempre preenche `view' como especificado por `flags', a não ser que `buf' seja designado como somente leitura e @ref{13fc,,PyBUF_WRITABLE} esteja definido em `flags'.

Em caso de sucesso, defina @code{view->obj} como um novo referência para `exporter' e retorna 0. Caso contrário, levante @ref{15bd,,BufferError} , defina @code{view->obj} para @code{NULL} e retorne @code{-1} ;

Se esta função é usada como parte de um @ref{4f43,,getbufferproc}, `exporter' DEVE ser definida para o objeto de exportação e `flags' deve ser passado sem modificações. Caso contrário, `exporter' DEVE ser @code{NULL}.
@end deffn

@node Camada de Objetos Concretos,Inicialização finalização e threads,Camada de Objetos Abstratos,Manual de referência da API Python/C
@anchor{c-api/concrete doc}@anchor{4f5d}@anchor{c-api/concrete concrete}@anchor{4f5e}@anchor{c-api/concrete concrete-objects-layer}@anchor{4f5f}@anchor{c-api/concrete translation-repo}@anchor{4f60}
@section Camada de Objetos Concretos


As funções neste capítulo são específicas para certos tipos de objetos Python. Passar para eles um objeto do tipo errado não é uma boa ideia; se você receber um objeto de um programa Python e não tiver certeza de que ele tem o tipo certo, primeiro execute uma verificação de tipo; por exemplo, para verificar se um objeto é um dicionário, use @ref{4f61,,PyDict_Check()}. O capítulo está estruturado como a “árvore genealógica” dos tipos de objetos Python.

@cartouche
@quotation Aviso 
Enquanto as funções descritas neste capítulo verificam cuidadosamente o tipo de objetos passados, muitos deles não verificam a passagem de @code{NULL} em vez de um objeto válido. Permitir a passagem de @code{NULL} pode causar violações ao acesso à memória e encerramento imediato do interpretador.
@end quotation
@end cartouche

@menu
* Objetos Fundamentais:: 
* Objetos Numéricos:: 
* Objetos Sequência:: 
* Coleções:: 
* Objetos Function: Objetos Function<2>. 
* Outros Objetos:: 
* API C para módulos de extensão:: 

@end menu

@node Objetos Fundamentais,Objetos Numéricos,,Camada de Objetos Concretos
@anchor{c-api/concrete fundamental}@anchor{4f62}@anchor{c-api/concrete fundamental-objects}@anchor{4f63}
@subsection Objetos Fundamentais


Esta seção descreve os objetos de tipo Python e o objeto singleton @code{None}.

@menu
* Objetos tipo: Objetos tipo<2>. 
* O Objeto None:: 

@end menu

@node Objetos tipo<2>,O Objeto None,,Objetos Fundamentais
@anchor{c-api/type doc}@anchor{4f64}@anchor{c-api/type type-objects}@anchor{4f65}@anchor{c-api/type typeobjects}@anchor{4f66}
@subsubsection Objetos tipo


@geindex objeto;tipo

@geindex PyTypeObject (C type)
@anchor{c-api/type c PyTypeObject}@anchor{ab4}
@deffn {C Tipo} type PyTypeObject
` Parte da @ref{553,,API Limitada} (como uma estrutura opaca).'
A estrutura C dos objetos usados para descrever tipos embutidos.
@end deffn

@geindex PyType_Type (C var)
@anchor{c-api/type c PyType_Type}@anchor{54d}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyType_Type
` Parte da @ref{553,,ABI Estável}.'
Este é o objeto de tipo para objetos tipo; é o mesmo objeto que @ref{d6b,,type} na camada Python.
@end deffn

@geindex PyType_Check (C function)
@anchor{c-api/type c PyType_Check}@anchor{1b16}
@deffn {C Função} int PyType_Check (PyObject *o)

Retorna valor diferente de zero se o objeto `o' for um objeto tipo, incluindo instâncias de tipos derivados do objeto tipo padrão. Retorna 0 em todos os outros casos. Esta função sempre tem sucesso.
@end deffn

@geindex PyType_CheckExact (C function)
@anchor{c-api/type c PyType_CheckExact}@anchor{1b17}
@deffn {C Função} int PyType_CheckExact (PyObject *o)

Retorna valor diferente de zero se o objeto `o' for um objeto tipo, mas não um subtipo do objeto tipo padrão. Retorna 0 em todos os outros casos. Esta função sempre tem sucesso.
@end deffn

@geindex PyType_ClearCache (C function)
@anchor{c-api/type c PyType_ClearCache}@anchor{4d79}
@deffn {C Função} unsigned int PyType_ClearCache ()
` Parte da @ref{553,,ABI Estável}.'
Limpa o cache de pesquisa interno. Retorna a marcação de versão atual.
@end deffn

@geindex PyType_GetFlags (C function)
@anchor{c-api/type c PyType_GetFlags}@anchor{1aca}
@deffn {C Função} unsigned long PyType_GetFlags (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável}.'
Return the @ref{19fd,,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{19fd,,tp_flags} itself is not part of the @ref{396,,limited API}.


Adicionado na versão 3.2.



Alterado na versão 3.4: O tipo de retorno é agora um @code{unsigned long} em vez de um @code{long}.

@end deffn

@geindex PyType_GetDict (C function)
@anchor{c-api/type c PyType_GetDict}@anchor{180d}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetDict (PyTypeObject *type)

Return the type object’s internal namespace, which is otherwise only
exposed via a read-only proxy (@ref{c78,,cls.__dict__}).
This is a
replacement for accessing @ref{180e,,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{347,,PyObject_GetAttr()}) isn’t adequate.

Extension modules should continue to use @code{tp_dict},
directly or indirectly, when setting up their own types.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_Modified (C function)
@anchor{c-api/type c PyType_Modified}@anchor{1906}
@deffn {C Função} void PyType_Modified (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável}.'
Invalida o cache de pesquisa interna para o tipo e todos os seus subtipos. Esta função deve ser chamada após qualquer modificação manual dos atributos ou classes bases do tipo.
@end deffn

@geindex PyType_AddWatcher (C function)
@anchor{c-api/type c PyType_AddWatcher}@anchor{564}
@deffn {C Função} 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{565,,PyType_Watch()}. In case of
error (e.g. no more watcher IDs available), return @code{-1} and set an
exception.

In free-threaded builds, @ref{564,,PyType_AddWatcher()} is not thread-safe,
so it must be called at start up (before spawning the first thread).


Adicionado na versão 3.12.

@end deffn

@geindex PyType_ClearWatcher (C function)
@anchor{c-api/type c PyType_ClearWatcher}@anchor{4f67}
@deffn {C Função} int PyType_ClearWatcher (int watcher_id)

Clear watcher identified by `watcher_id' (previously returned from
@ref{564,,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{564,,PyType_AddWatcher()}.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_Watch (C function)
@anchor{c-api/type c PyType_Watch}@anchor{565}
@deffn {C Função} int PyType_Watch (int watcher_id, PyObject *type)

Mark `type' as watched. The callback granted `watcher_id' by
@ref{564,,PyType_AddWatcher()} will be called whenever
@ref{1906,,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{564,,PyType_AddWatcher()}.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_Unwatch (C function)
@anchor{c-api/type c PyType_Unwatch}@anchor{4f68}
@deffn {C Função} int PyType_Unwatch (int watcher_id, PyObject *type)

Mark `type' as not watched. This undoes a previous call to
@ref{565,,PyType_Watch()}. `type' must not be @code{NULL}.

An extension should never call this function with a `watcher_id' that was
not returned to it by a previous call to @ref{564,,PyType_AddWatcher()}.

On success, this function returns @code{0}. On failure, this function returns
@code{-1} with an exception set.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_WatchCallback (C type)
@anchor{c-api/type c PyType_WatchCallback}@anchor{4f69}
@deffn {C Tipo} typedef int (*PyType_WatchCallback)(@ref{339,,PyObject} *type)

Type of a type-watcher callback function.

The callback must not modify `type' or cause @ref{1906,,PyType_Modified()} to be
called on `type' or any type in its MRO; violating this rule could cause
infinite recursion.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_HasFeature (C function)
@anchor{c-api/type c PyType_HasFeature}@anchor{1ac9}
@deffn {C Função} int PyType_HasFeature (PyTypeObject *o, int feature)

Retorna valor diferente de zero se o objeto tipo `o' define o recurso `feature'. Os recursos de tipo são denotados por sinalizadores de bit único.
@end deffn

@geindex PyType_FastSubclass (C function)
@anchor{c-api/type c PyType_FastSubclass}@anchor{4f6a}
@deffn {C Função} int PyType_FastSubclass (PyTypeObject *type, int flag)

Return non-zero if the type object `type' sets the subclass flag `flag'.
Subclass flags are denoted by
@ref{4f6b,,Py_TPFLAGS_*_SUBCLASS}.
This function is used by many @code{_Check} functions for common types.


@subsubheading Ver também


@ref{1a41,,PyObject_TypeCheck()}, which is used as a slower alternative in
@code{_Check} functions for types that don’t come with subclass flags.

@end deffn

@geindex PyType_IS_GC (C function)
@anchor{c-api/type c PyType_IS_GC}@anchor{4f6c}
@deffn {C Função} int PyType_IS_GC (PyTypeObject *o)

Return true if the type object includes support for the cycle detector; this
tests the type flag @ref{77d,,Py_TPFLAGS_HAVE_GC}.
@end deffn

@geindex PyType_IsSubtype (C function)
@anchor{c-api/type c PyType_IsSubtype}@anchor{4d7a}
@deffn {C Função} int PyType_IsSubtype (PyTypeObject *a, PyTypeObject *b)
` Parte da @ref{553,,ABI Estável}.'
Retorna verdadeiro se `a' for um subtipo de `b'.

This function only checks for actual subtypes, which means that
@ref{2109,,__subclasscheck__()} is not called on `b'.  Call
@ref{ed6,,PyObject_IsSubclass()} to do the same check that @ref{7c2,,issubclass()}
would do.
@end deffn

@geindex PyType_GenericAlloc (C function)
@anchor{c-api/type c PyType_GenericAlloc}@anchor{a75}
@deffn {C Função} @ref{339,,PyObject} *PyType_GenericAlloc (PyTypeObject *type, Py_ssize_t nitems)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Manipulador genérico para o slot @ref{4b7a,,tp_alloc} de um objeto tipo. Use o mecanismo de alocação de memória padrão do Python para alocar uma nova instância e inicializar todo o seu conteúdo para @code{NULL}.
@end deffn

@geindex PyType_GenericNew (C function)
@anchor{c-api/type c PyType_GenericNew}@anchor{4b76}
@deffn {C Função} @ref{339,,PyObject} *PyType_GenericNew (PyTypeObject *type, PyObject *args, PyObject *kwds)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Manipulador genérico para o slot @ref{57f,,tp_new} de um objeto tipo. Cria uma nova instância usando o slot @ref{4b7a,,tp_alloc} do tipo.
@end deffn

@geindex PyType_Ready (C function)
@anchor{c-api/type c PyType_Ready}@anchor{77c}
@deffn {C Função} int PyType_Ready (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável}.'
Finaliza um objeto tipo. Isso deve ser chamado em todos os objetos tipo para finalizar sua inicialização. Esta função é responsável por adicionar slots herdados da classe base de um tipo. Retorna @code{0} em caso de sucesso, ou retorna @code{-1} e define uma exceção em caso de erro.

@cartouche
@quotation Nota 
If some of the base classes implements the GC protocol and the provided
type does not include the @ref{77d,,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{77d,,Py_TPFLAGS_HAVE_GC} in its flags then it `must' implement the
GC protocol itself by at least implementing the
@ref{77e,,tp_traverse} handle.
@end quotation
@end cartouche
@end deffn

@geindex PyType_GetName (C function)
@anchor{c-api/type c PyType_GetName}@anchor{752}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetName (PyTypeObject *type)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retorna o nome do tipo. Equivalente a pegar o atributo @ref{14f3,,__name__} do tipo.


Adicionado na versão 3.11.

@end deffn

@geindex PyType_GetQualName (C function)
@anchor{c-api/type c PyType_GetQualName}@anchor{753}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetQualName (PyTypeObject *type)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Retorna o nome qualificado do tipo. Equivalente a pegar o atributo @ref{20b6,,__qualname__} do tipo.


Adicionado na versão 3.11.

@end deffn

@geindex PyType_GetFullyQualifiedName (C function)
@anchor{c-api/type c PyType_GetFullyQualifiedName}@anchor{373}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetFullyQualifiedName (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna o nome qualificado do tipo. Equivalente à @code{f"@{type.__module__@}.@{type.__qualname__@}"}, ou @ref{20b6,,type.__qualname__} se @ref{374,,type.__module__} não é uma string ou é igual a @code{"builtins"}.


Adicionado na versão 3.13.

@end deffn

@geindex PyType_GetModuleName (C function)
@anchor{c-api/type c PyType_GetModuleName}@anchor{375}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetModuleName (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna o nome do tipo do módulo. Equivalente a pegar o atributo @ref{374,,type.__module__}.


Adicionado na versão 3.13.

@end deffn

@geindex PyType_GetSlot (C function)
@anchor{c-api/type c PyType_GetSlot}@anchor{8a0}
@deffn {C Função} void *PyType_GetSlot (PyTypeObject *type, int slot)
` Parte da @ref{553,,ABI Estável} desde a versão 3.4.'
Retorna o ponteiro de função armazenado no slot fornecido. Se o resultado for @code{NULL}, isso indica que o slot é @code{NULL} ou que a função foi chamada com parâmetros inválidos. Os chamadores normalmente lançarão o ponteiro do resultado no tipo de função apropriado.

Veja @ref{4f6d,,PyType_Slot.slot} por possíveis valores do argumento `slot'.


Adicionado na versão 3.4.



Alterado na versão 3.10: @ref{8a0,,PyType_GetSlot()} agora aceita todos os tipos. Antes, estava limitada a @ref{96c,,tipos heap}.

@end deffn

@geindex PyType_GetModule (C function)
@anchor{c-api/type c PyType_GetModule}@anchor{975}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetModule (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Retorna o objeto de módulo associado ao tipo fornecido quando o tipo foi criado usando @ref{551,,PyType_FromModuleAndSpec()}.

Se nenhum módulo estiver associado com o tipo fornecido, define @ref{2c3,,TypeError} e 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{764,,PyCMethod} to get the class that defines the method.
See @ref{394,,PyType_GetModuleByDef()} for cases when @code{PyCMethod} cannot
be used.


Adicionado na versão 3.9.

@end deffn

@geindex PyType_GetModuleState (C function)
@anchor{c-api/type c PyType_GetModuleState}@anchor{976}
@deffn {C Função} void *PyType_GetModuleState (PyTypeObject *type)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Return the state of the module object associated with the given type.
This is a shortcut for calling @ref{987,,PyModule_GetState()} on the result
of @ref{975,,PyType_GetModule()}.

Se nenhum módulo estiver associado com o tipo fornecido, define @ref{2c3,,TypeError} e retorna @code{NULL}.

Se o `tipo' tem um módulo associado mas o seu estado é @code{NULL}, retorna @code{NULL} sem definir uma exceção.


Adicionado na versão 3.9.

@end deffn

@geindex PyType_GetModuleByDef (C function)
@anchor{c-api/type c PyType_GetModuleByDef}@anchor{394}
@deffn {C Função} @ref{339,,PyObject} *PyType_GetModuleByDef (PyTypeObject *type, struct PyModuleDef *def)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Encontra a primeira super-classe da qual o módulo foi criado por @ref{984,,PyModuleDef} `def', e retorna esse módulo.

Se nenhum módulo é encontrado, levanta um @ref{2c3,,TypeError} e retorna @code{NULL}.

This function is intended to be used together with
@ref{987,,PyModule_GetState()} to get module state from slot methods (such as
@ref{581,,tp_init} or @ref{4f6e,,nb_add})
and other places where a method’s defining class cannot be passed using the
@ref{764,,PyCMethod} calling convention.

The returned reference is @ref{33e,,borrowed} from `type',
and will be valid as long as you hold a reference to `type'.
Do not release it with @ref{56f,,Py_DECREF()} or similar.


Adicionado na versão 3.11.

@end deffn

@geindex PyUnstable_Type_AssignVersionTag (C function)
@anchor{c-api/type c PyUnstable_Type_AssignVersionTag}@anchor{4f6f}
@deffn {C Função} int PyUnstable_Type_AssignVersionTag (PyTypeObject *type)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@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.


Adicionado na versão 3.12.

@end deffn

@geindex PyType_SUPPORTS_WEAKREFS (C function)
@anchor{c-api/type c PyType_SUPPORTS_WEAKREFS}@anchor{4f70}
@deffn {C Função} int PyType_SUPPORTS_WEAKREFS (PyTypeObject *type)

Return true if instances of `type' support creating weak references, false
otherwise. This function always succeeds. `type' must not be @code{NULL}.


@subsubheading Ver também



@itemize *

@item 
@ref{4f71,,Objetos referência fraca}

@item 
@ref{114,,weakref}
@end itemize

@end deffn

@menu
* Creating Heap-Allocated Types:: 

@end menu

@node Creating Heap-Allocated Types,,,Objetos tipo<2>
@anchor{c-api/type creating-heap-allocated-types}@anchor{4f72}
@subsubsection Creating Heap-Allocated Types


The following functions and structs are used to create
@ref{96c,,heap types}.

@geindex PyType_FromMetaclass (C function)
@anchor{c-api/type c PyType_FromMetaclass}@anchor{550}
@deffn {C Função} @ref{339,,PyObject} *PyType_FromMetaclass (PyTypeObject *metaclass, PyObject *module, PyType_Spec *spec, PyObject *bases)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Create and return a @ref{96c,,heap type} from the `spec'
(see @ref{8b4,,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{57f,,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.)

The `bases' argument can be used to specify base classes; it can either
be only one class or a tuple of classes.
If `bases' is @code{NULL}, the `Py_tp_bases' slot is used instead.
If that also is @code{NULL}, the `Py_tp_base' slot is used instead.
If that also is @code{NULL}, the new type derives from @ref{a96,,object}.

The `module' argument can be used to record the module in which the new
class is defined. It must be a module object or @code{NULL}.
If not @code{NULL}, the module is associated with the new type and can later be
retrieved with @ref{975,,PyType_GetModule()}.
The associated module is not inherited by subclasses; it must be specified
for each class individually.

This function calls @ref{77c,,PyType_Ready()} on the new type.

Note that this function does `not' fully match the behavior of
calling @ref{d6b,,type()} or using the @ref{131a,,class} statement.
With user-provided base types or metaclasses, prefer
@ref{4f1c,,calling} @ref{d6b,,type} (or the metaclass)
over @code{PyType_From*} functions.
Specifically:


@itemize *

@item 
@ref{580,,__new__()} is not called on the new class
(and it must be set to @code{type.__new__}).

@item 
@ref{6b0,,__init__()} is not called on the new class.

@item 
@ref{631,,__init_subclass__()} is not called on any bases.

@item 
@ref{c69,,__set_name__()} is not called on new descriptors.
@end itemize


Adicionado na versão 3.12.

@end deffn

@geindex PyType_FromModuleAndSpec (C function)
@anchor{c-api/type c PyType_FromModuleAndSpec}@anchor{551}
@deffn {C Função} @ref{339,,PyObject} *PyType_FromModuleAndSpec (PyObject *module, PyType_Spec *spec, PyObject *bases)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Equivalent to @code{PyType_FromMetaclass(NULL, module, spec, bases)}.


Adicionado na versão 3.9.



Alterado na versão 3.10: The function now accepts a single class as the `bases' argument and
@code{NULL} as the @code{tp_doc} slot.



Alterado na versão 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes.  Previously, only @ref{d6b,,type} instances were returned.

The @ref{57f,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{57f,,tp_new} is deprecated and in Python 3.14+ it
will be no longer allowed.

@end deffn

@geindex PyType_FromSpecWithBases (C function)
@anchor{c-api/type c PyType_FromSpecWithBases}@anchor{57e}
@deffn {C Função} @ref{339,,PyObject} *PyType_FromSpecWithBases (PyType_Spec *spec, PyObject *bases)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.3.'
Equivalent to @code{PyType_FromMetaclass(NULL, NULL, spec, bases)}.


Adicionado na versão 3.3.



Alterado na versão 3.12: The function now finds and uses a metaclass corresponding to the provided
base classes.  Previously, only @ref{d6b,,type} instances were returned.

The @ref{57f,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{57f,,tp_new} is deprecated and in Python 3.14+ it
will be no longer allowed.

@end deffn

@geindex PyType_FromSpec (C function)
@anchor{c-api/type c PyType_FromSpec}@anchor{57d}
@deffn {C Função} @ref{339,,PyObject} *PyType_FromSpec (PyType_Spec *spec)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Equivalent to @code{PyType_FromMetaclass(NULL, NULL, spec, NULL)}.


Alterado na versão 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{d6b,,type} instances were returned.

The @ref{57f,,tp_new} of the metaclass is `ignored'.
which may result in incomplete initialization.
Creating classes whose metaclass overrides
@ref{57f,,tp_new} is deprecated and in Python 3.14+ it
will be no longer allowed.

@end deffn

@geindex PyType_Spec (C type)
@anchor{c-api/type c PyType_Spec}@anchor{180b}
@deffn {C Tipo} type PyType_Spec
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Structure defining a type’s behavior.

@geindex PyType_Spec.name (C member)
@anchor{c-api/type c PyType_Spec name}@anchor{4f73}
@deffn {C Membro} const char *name

Name of the type, used to set @ref{1a3c,,PyTypeObject.tp_name}.
@end deffn

@geindex PyType_Spec.basicsize (C member)
@anchor{c-api/type c PyType_Spec basicsize}@anchor{548}
@deffn {C Membro} int basicsize

If positive, specifies the size of the instance in bytes.
It is used to set @ref{98e,,PyTypeObject.tp_basicsize}.

If zero, specifies that @ref{98e,,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{549,,PyObject_GetTypeData()} to get a pointer to subclass-specific
memory reserved this way.
For negative @code{basicsize}, Python will insert padding when
needed to meet @ref{98e,,tp_basicsize}’s alignment
requirements.


Alterado na versão 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{4f74}
@deffn {C Membro} int itemsize

Size of one element of a variable-size type, in bytes.
Used to set @ref{20fd,,PyTypeObject.tp_itemsize}.
See @code{tp_itemsize} documentation for caveats.

If zero, @ref{20fd,,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{20fd,,tp_itemsize}).

@item 
The requested @ref{548,,PyType_Spec.basicsize} is positive,
suggesting that the memory layout of the base class is known.

@item 
The requested @ref{548,,PyType_Spec.basicsize} is zero,
suggesting that the subclass does not access the instance’s memory
directly.

@item 
With the @ref{54b,,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{4f75}
@deffn {C Membro} unsigned int flags

Type flags, used to set @ref{19fd,,PyTypeObject.tp_flags}.

If the @code{Py_TPFLAGS_HEAPTYPE} flag is not set,
@ref{57e,,PyType_FromSpecWithBases()} sets it automatically.
@end deffn

@geindex PyType_Spec.slots (C member)
@anchor{c-api/type c PyType_Spec slots}@anchor{4f76}
@deffn {C Membro} @ref{4d7b,,PyType_Slot} *slots

Array of @ref{4d7b,,PyType_Slot} structures.
Terminated by the special slot value @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{4d7b}
@deffn {C Tipo} type PyType_Slot
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Structure defining optional functionality of a type, containing a slot ID
and a value pointer.

@geindex PyType_Slot.slot (C member)
@anchor{c-api/type c PyType_Slot slot}@anchor{4f6d}
@deffn {C Membro} int slot

A slot ID.

Slot IDs are named like the field names of the structures
@ref{ab4,,PyTypeObject}, @ref{1465,,PyNumberMethods},
@ref{4b9d,,PySequenceMethods}, @ref{4b9e,,PyMappingMethods} and
@ref{4f77,,PyAsyncMethods} with an added @code{Py_} prefix.
For example, use:


@itemize *

@item 
@code{Py_tp_dealloc} to set @ref{4b66,,PyTypeObject.tp_dealloc}

@item 
@code{Py_nb_add} to set @ref{4f6e,,PyNumberMethods.nb_add}

@item 
@code{Py_sq_length} to set @ref{4f78,,PySequenceMethods.sq_length}
@end itemize

The following “offset” fields cannot be set using @ref{4d7b,,PyType_Slot}:


@itemize *

@item 
@ref{98f,,tp_weaklistoffset}
(use @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} instead if possible)

@item 
@ref{4f79,,tp_dictoffset}
(use @ref{36b,,Py_TPFLAGS_MANAGED_DICT} instead if possible)

@item 
@ref{4f1e,,tp_vectorcall_offset}
(use @code{"__vectorcalloffset__"} in
@ref{4f7a,,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{4b7b,,Py_tp_members}.
See @ref{4f7a,,PyMemberDef documentation}
for details.

The following fields cannot be set at all when creating a heap type:


@itemize *

@item 
@ref{4f7b,,tp_vectorcall}
(use @ref{57f,,tp_new} and/or
@ref{581,,tp_init})

@item 
Internal fields:
@ref{180e,,tp_dict},
@ref{4f7c,,tp_mro},
@ref{4f7d,,tp_cache},
@ref{572,,tp_subclasses}, and
@ref{4f7e,,tp_weaklist}.
@end itemize

Setting @ref{4e19,,Py_tp_bases} or @ref{4e18,,Py_tp_base} may be
problematic on some platforms.
To avoid issues, use the `bases' argument of
@ref{57e,,PyType_FromSpecWithBases()} instead.


Alterado na versão 3.9: Slots in @ref{4f7f,,PyBufferProcs} may be set in the unlimited API.



Alterado na versão 3.11: @ref{762,,bf_getbuffer} and
@ref{763,,bf_releasebuffer} are now available
under the @ref{396,,limited API}.

@end deffn

@geindex PyType_Slot.pfunc (C member)
@anchor{c-api/type c PyType_Slot pfunc}@anchor{4f80}
@deffn {C Membro} void *pfunc

The desired value of the slot. In most cases, this is a pointer
to a function.

Slots other than @code{Py_tp_doc} may not be @code{NULL}.
@end deffn
@end deffn

@node O Objeto None,,Objetos tipo<2>,Objetos Fundamentais
@anchor{c-api/none doc}@anchor{4f81}@anchor{c-api/none noneobject}@anchor{4f82}@anchor{c-api/none the-none-object}@anchor{4f83}@anchor{c-api/none translation-repo}@anchor{4f84}
@subsubsection O Objeto @code{None}


@geindex objeto;None

Observe que o @ref{ab4,,PyTypeObject} para @code{None} não está diretamente exposto pela API Python/C. Como @code{None} é um singleton, é suficiente testar a identidade do objeto (usando @code{==} em C). Não há nenhuma função @code{PyNone_Check()} pela mesma razão.

@geindex Py_None (C var)
@anchor{c-api/none c Py_None}@anchor{4b48}
@deffn {C Variável} @ref{339,,PyObject} *Py_None

O objeto Python @code{None}, denotando falta de valor. Este objeto não tem métodos e é @ref{45bb,,imortal}.


Alterado na versão 3.12: @ref{4b48,,Py_None} é @ref{45bb,,imortal}.

@end deffn

@geindex Py_RETURN_NONE (C macro)
@anchor{c-api/none c Py_RETURN_NONE}@anchor{14bb}
@deffn {C Macro} Py_RETURN_NONE

Retorna @ref{4b48,,Py_None} de uma função.
@end deffn

@node Objetos Numéricos,Objetos Sequência,Objetos Fundamentais,Camada de Objetos Concretos
@anchor{c-api/concrete numeric-objects}@anchor{4f85}@anchor{c-api/concrete numericobjects}@anchor{4f86}
@subsection Objetos Numéricos


@geindex objeto;numérico

@menu
* Objetos Inteiros:: 
* Objetos Booleanos:: 
* Objetos de ponto flutuante:: 
* Objetos números complexos:: 

@end menu

@node Objetos Inteiros,Objetos Booleanos,,Objetos Numéricos
@anchor{c-api/long doc}@anchor{4f87}@anchor{c-api/long integer-objects}@anchor{4f88}@anchor{c-api/long longobjects}@anchor{4f89}
@subsubsection Objetos Inteiros


@geindex objeto;long integer
@geindex objeto;inteiro

Todos os inteiros são implementados como objetos inteiros “longos” de tamanho arbitrário.

Em caso de erro, a maioria das APIs @code{PyLong_As*} retorna @code{(tipo de retorno)-1} que não pode ser distinguido de um número. Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.

@geindex PyLongObject (C type)
@anchor{c-api/long c PyLongObject}@anchor{588}
@deffn {C Tipo} type PyLongObject
` Parte da @ref{553,,API Limitada} (como uma estrutura opaca).'
Este subtipo de @ref{339,,PyObject} representa um objeto inteiro Python.
@end deffn

@geindex PyLong_Type (C var)
@anchor{c-api/long c PyLong_Type}@anchor{4ceb}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyLong_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo inteiro Python. Este é o mesmo objeto que @ref{257,,int} na camada Python.
@end deffn

@geindex PyLong_Check (C function)
@anchor{c-api/long c PyLong_Check}@anchor{4f8a}
@deffn {C Função} int PyLong_Check (PyObject *p)

Retorna true se seu argumento é um @ref{588,,PyLongObject} ou um subtipo de @ref{588,,PyLongObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyLong_CheckExact (C function)
@anchor{c-api/long c PyLong_CheckExact}@anchor{4f8b}
@deffn {C Função} int PyLong_CheckExact (PyObject *p)

Retorna true se seu argumento é um @ref{588,,PyLongObject}, mas não um subtipo de @ref{588,,PyLongObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyLong_FromLong (C function)
@anchor{c-api/long c PyLong_FromLong}@anchor{195a}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromLong (long v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de `v' ou @code{NULL} em caso de falha.

`Detalhes da implementação do CPython:' CPython 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{1b38}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromUnsignedLong (unsigned long v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de um unsigned long C ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromSsize_t (C function)
@anchor{c-api/long c PyLong_FromSsize_t}@anchor{4ce7}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromSsize_t (Py_ssize_t v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de um @ref{a69,,Py_ssize_t} C ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromSize_t (C function)
@anchor{c-api/long c PyLong_FromSize_t}@anchor{1b3a}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromSize_t (size_t v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de um @code{size_t} C ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromLongLong (C function)
@anchor{c-api/long c PyLong_FromLongLong}@anchor{195b}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromLongLong (long long v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de um long long C ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromUnsignedLongLong (C function)
@anchor{c-api/long c PyLong_FromUnsignedLongLong}@anchor{1b39}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromUnsignedLongLong (unsigned long long v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} de um unsigned long long C ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromDouble (C function)
@anchor{c-api/long c PyLong_FromDouble}@anchor{949}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromDouble (double v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{588,,PyLongObject} da parte inteira de `v' ou @code{NULL} em caso de falha.
@end deffn

@geindex PyLong_FromString (C function)
@anchor{c-api/long c PyLong_FromString}@anchor{4ce8}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromString (const char *str, char **pend, int base)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo @ref{588,,PyLongObject} com base no valor da string em `str', que é interpretado de acordo com a raiz em `base' ou @code{NULL} em caso de falha. Se `pend' não for @code{NULL}, `*pend' apontará para o fim do `str' em caso de sucesso ou para seu primeiro caractere que não pode ser processado em caso de erro. Se `base' for @code{0}, `str' é interpretado usando a definição de @ref{2055,,Inteiros literais}; neste caso, zeros à esquerda em um número decimal diferente de zero aumenta um @ref{202,,ValueError}. Se `base' não for @code{0}, deve estar entre @code{2} e @code{36}, inclusive. Espaços em branco no início ou no final e sublinhados simples após um especificador de base e entre dígitos são ignorados. Se não houver dígitos ou `str' não for terminado em NULL após os dígitos e espaços em branco à direita, @ref{202,,ValueError} será levantada.


@subsubheading Ver também


Python methods @ref{19bd,,int.to_bytes()} and @ref{1972,,int.from_bytes()}
to convert a @ref{588,,PyLongObject} to/from an array of bytes in base
@code{256}. You can call those from C using @ref{39f,,PyObject_CallMethod()}.

@end deffn

@geindex PyLong_FromUnicodeObject (C function)
@anchor{c-api/long c PyLong_FromUnicodeObject}@anchor{8bf}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromUnicodeObject (PyObject *u, int base)
`Retorna valor: Nova referência.'
Converte uma sequência de dígitos Unicode na string `u' para um valor inteiro Python.


Adicionado na versão 3.3.

@end deffn

@geindex PyLong_FromVoidPtr (C function)
@anchor{c-api/long c PyLong_FromVoidPtr}@anchor{4ce9}
@deffn {C Função} @ref{339,,PyObject} *PyLong_FromVoidPtr (void *p)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um inteiro Python a partir do ponteiro `p'. O valor do ponteiro pode ser recuperado do valor resultante usando @ref{4ce6,,PyLong_AsVoidPtr()}.
@end deffn

@geindex PyLong_FromNativeBytes (C function)
@anchor{c-api/long c PyLong_FromNativeBytes}@anchor{362}
@deffn {C Função} @ref{339,,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{361,,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{363,,PyLong_FromUnsignedNativeBytes()}. Other flags are ignored.


Adicionado na versão 3.13.

@end deffn

@geindex PyLong_FromUnsignedNativeBytes (C function)
@anchor{c-api/long c PyLong_FromUnsignedNativeBytes}@anchor{363}
@deffn {C Função} @ref{339,,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{361,,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.


Adicionado na versão 3.13.

@end deffn

@geindex PyLong_FromPid (C macro)
@anchor{c-api/long c PyLong_FromPid}@anchor{4f8c}
@deffn {C Macro} PyLong_FromPid (pid)

Macro for creating a Python integer from a process identifier.

This can be defined as an alias to @ref{195a,,PyLong_FromLong()} or
@ref{195b,,PyLong_FromLongLong()}, depending on the size of the system’s
PID type.


Adicionado na versão 3.2.

@end deffn

@geindex PyLong_AsLong (C function)
@anchor{c-api/long c PyLong_AsLong}@anchor{360}
@deffn {C Função} long PyLong_AsLong (PyObject *obj)
` Parte da @ref{553,,ABI Estável}.'
@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{588,,PyLongObject}, first call its @ref{71d,,__index__()} method
(if present) to convert it to a @ref{588,,PyLongObject}.

Raise @ref{885,,OverflowError} if the value of `obj' is out of range for a
long.

Retorna @code{-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.


@geindex PyLong_AS_LONG (C function)
@anchor{c-api/long c PyLong_AS_LONG}@anchor{4f8d}
@deffn {C Função} long PyLong_AS_LONG (PyObject *obj)

A @ref{209,,soft deprecated} alias.
Exactly equivalent to the preferred @code{PyLong_AsLong}. In particular,
it can fail with @ref{885,,OverflowError} or another exception.


Descontinuado desde a versão 3.14: The function is soft deprecated.

@end deffn
@end deffn

@geindex PyLong_AsInt (C function)
@anchor{c-api/long c PyLong_AsInt}@anchor{35f}
@deffn {C Função} int PyLong_AsInt (PyObject *obj)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Similar to @ref{360,,PyLong_AsLong()}, but store the result in a C
int instead of a C long.


Adicionado na versão 3.13.

@end deffn

@geindex PyLong_AsLongAndOverflow (C function)
@anchor{c-api/long c PyLong_AsLongAndOverflow}@anchor{12a8}
@deffn {C Função} long PyLong_AsLongAndOverflow (PyObject *obj, int *overflow)
` Parte da @ref{553,,ABI Estável}.'
Return a C long representation of `obj'.  If `obj' is not an
instance of @ref{588,,PyLongObject}, first call its @ref{71d,,__index__()}
method (if present) to convert it to a @ref{588,,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} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.

@end deffn

@geindex PyLong_AsLongLong (C function)
@anchor{c-api/long c PyLong_AsLongLong}@anchor{4ce1}
@deffn {C Função} long long PyLong_AsLongLong (PyObject *obj)
` Parte da @ref{553,,ABI Estável}.'
@geindex OverflowError (built-in exception)

Return a C long long representation of `obj'.  If `obj' is not an
instance of @ref{588,,PyLongObject}, first call its @ref{71d,,__index__()} method
(if present) to convert it to a @ref{588,,PyLongObject}.

Raise @ref{885,,OverflowError} if the value of `obj' is out of range for a
long long.

Retorna @code{-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.

@end deffn

@geindex PyLong_AsLongLongAndOverflow (C function)
@anchor{c-api/long c PyLong_AsLongLongAndOverflow}@anchor{12a7}
@deffn {C Função} long long PyLong_AsLongLongAndOverflow (PyObject *obj, int *overflow)
` Parte da @ref{553,,ABI Estável}.'
Return a C long long representation of `obj'.  If `obj' is not an
instance of @ref{588,,PyLongObject}, first call its @ref{71d,,__index__()} method
(if present) to convert it to a @ref{588,,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} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Adicionado na versão 3.2.



Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.

@end deffn

@geindex PyLong_AsSsize_t (C function)
@anchor{c-api/long c PyLong_AsSsize_t}@anchor{4ce3}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyLong_AsSsize_t (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
@geindex PY_SSIZE_T_MAX (C macro)
@geindex OverflowError (built-in exception)

Retorna uma representação de @ref{a69,,Py_ssize_t} C de `pylong'. `pylong' deve ser uma instância de @ref{588,,PyLongObject}.

Levanta @ref{885,,OverflowError} se o valor de `pylong' estiver fora do intervalo de um @ref{a69,,Py_ssize_t}.

Retorna @code{-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsUnsignedLong (C function)
@anchor{c-api/long c PyLong_AsUnsignedLong}@anchor{4ce4}
@deffn {C Função} unsigned long PyLong_AsUnsignedLong (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
@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{588,,PyLongObject}.

Raise @ref{885,,OverflowError} if the value of `pylong' is out of range for a
unsigned long.

Retorna @code{(unsigned long)-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsSize_t (C function)
@anchor{c-api/long c PyLong_AsSize_t}@anchor{4ce2}
@deffn {C Função} size_t PyLong_AsSize_t (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
@geindex SIZE_MAX (C macro)
@geindex OverflowError (built-in exception)

Retorna uma representação de @code{size_t} C de `pylong'. `pylong' deve ser uma instância de @ref{588,,PyLongObject}.

Levanta @ref{885,,OverflowError} se o valor de `pylong' estiver fora do intervalo de um @code{size_t}.

Retorna @code{(size)-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsUnsignedLongLong (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongLong}@anchor{12d6}
@deffn {C Função} unsigned long long PyLong_AsUnsignedLongLong (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
@geindex OverflowError (built-in exception)

Return a C unsigned long long representation of `pylong'.  `pylong'
must be an instance of @ref{588,,PyLongObject}.

Raise @ref{885,,OverflowError} if the value of `pylong' is out of range for an
unsigned long long.

Retorna @code{(unsigned long long)-1} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.1: Um `pylong' negativo agora levanta @ref{885,,OverflowError}, não @ref{2c3,,TypeError}.

@end deffn

@geindex PyLong_AsUnsignedLongMask (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongMask}@anchor{4ce5}
@deffn {C Função} unsigned long PyLong_AsUnsignedLongMask (PyObject *obj)
` Parte da @ref{553,,ABI Estável}.'
Return a C unsigned long representation of `obj'.  If `obj' is not
an instance of @ref{588,,PyLongObject}, first call its @ref{71d,,__index__()}
method (if present) to convert it to a @ref{588,,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} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.

@end deffn

@geindex PyLong_AsUnsignedLongLongMask (C function)
@anchor{c-api/long c PyLong_AsUnsignedLongLongMask}@anchor{1b5d}
@deffn {C Função} unsigned long long PyLong_AsUnsignedLongLongMask (PyObject *obj)
` Parte da @ref{553,,ABI Estável}.'
Return a C unsigned long long representation of `obj'.  If `obj'
is not an instance of @ref{588,,PyLongObject}, first call its
@ref{71d,,__index__()} method (if present) to convert it to a
@ref{588,,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} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.



Alterado na versão 3.10: This function will no longer use @ref{71c,,__int__()}.

@end deffn

@geindex PyLong_AsDouble (C function)
@anchor{c-api/long c PyLong_AsDouble}@anchor{4ce0}
@deffn {C Função} double PyLong_AsDouble (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
Return a C double representation of `pylong'.  `pylong' must be
an instance of @ref{588,,PyLongObject}.

Raise @ref{885,,OverflowError} if the value of `pylong' is out of range for a
double.

Retorna @code{-1.0} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsVoidPtr (C function)
@anchor{c-api/long c PyLong_AsVoidPtr}@anchor{4ce6}
@deffn {C Função} void *PyLong_AsVoidPtr (PyObject *pylong)
` Parte da @ref{553,,ABI Estável}.'
Convert a Python integer `pylong' to a C void pointer.
If `pylong' cannot be converted, an @ref{885,,OverflowError} will be raised.  This
is only assured to produce a usable void pointer for values created
with @ref{4ce9,,PyLong_FromVoidPtr()}.

Retorna @code{NULL} no caso de erro.  Use @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyLong_AsPid (C macro)
@anchor{c-api/long c PyLong_AsPid}@anchor{1746}
@deffn {C Macro} PyLong_AsPid (pid)

Macro for converting a Python integer into a process identifier.

This can be defined as an alias to @ref{360,,PyLong_AsLong()},
@ref{195b,,PyLong_FromLongLong()}, or @ref{35f,,PyLong_AsInt()}, depending on the
size of the system’s PID type.


Adicionado na versão 3.2.

@end deffn

@geindex PyLong_AsNativeBytes (C function)
@anchor{c-api/long c PyLong_AsNativeBytes}@anchor{361}
@deffn {C Função} @ref{a69,,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: remaining bytes filled by
copies of the sign bit.

If the returned value is greater 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

Sinalizador

@tab

Valor

@item

@geindex Py_ASNATIVEBYTES_DEFAULTS (C macro)
@anchor{c-api/long c Py_ASNATIVEBYTES_DEFAULTS}@anchor{4f8e}
@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{4f8f}
@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{4f90}
@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{4f91}
@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{4f92}
@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{4f93}
@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{4f94}
@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{71d,,__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{2c3,,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


Adicionado na versão 3.13.

@end deffn

@geindex PyLong_GetInfo (C function)
@anchor{c-api/long c PyLong_GetInfo}@anchor{4cea}
@deffn {C Função} @ref{339,,PyObject} *PyLong_GetInfo (void)
` Parte da @ref{553,,ABI Estável}.'
On success, return a read only @ref{64e,,named tuple}, that holds
information about Python’s internal representation of integers.
See @ref{12d5,,sys.int_info} for description of individual fields.

Em caso de falha, retorna @code{NULL} com uma exceção definida.


Adicionado na versão 3.1.

@end deffn

@geindex PyUnstable_Long_IsCompact (C function)
@anchor{c-api/long c PyUnstable_Long_IsCompact}@anchor{589}
@deffn {C Função} int PyUnstable_Long_IsCompact (const PyLongObject *op)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@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{58a,,PyUnstable_Long_CompactValue()}; for others fall back to a
@ref{4ce2,,PyLong_As*} function or
@ref{361,,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.


Adicionado na versão 3.12.

@end deffn

@geindex PyUnstable_Long_CompactValue (C function)
@anchor{c-api/long c PyUnstable_Long_CompactValue}@anchor{58a}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnstable_Long_CompactValue (const PyLongObject *op)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

If `op' is compact, as determined by @ref{589,,PyUnstable_Long_IsCompact()},
return its value.

Otherwise, the return value is undefined.


Adicionado na versão 3.12.

@end deffn

@node Objetos Booleanos,Objetos de ponto flutuante,Objetos Inteiros,Objetos Numéricos
@anchor{c-api/bool doc}@anchor{4f95}@anchor{c-api/bool boolean-objects}@anchor{4f96}@anchor{c-api/bool boolobjects}@anchor{4f97}@anchor{c-api/bool translation-repo}@anchor{4f98}
@subsubsection Objetos Booleanos


Os booleanos no Python são implementados como um subclasse de inteiros. Há apenas dois booleanos, @ref{4f99,,Py_False} e @ref{4f9a,,Py_True}. Assim sendo, as funções de criação e a exclusão normais não se aplicam aos booleanos. No entanto, as seguintes macros estão disponíveis.

@geindex PyBool_Type (C var)
@anchor{c-api/bool c PyBool_Type}@anchor{4c10}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyBool_Type
` Parte da @ref{553,,ABI Estável}.'
Este instância de @ref{ab4,,PyTypeObject} representa o tipo booleano em Python; é o mesmo objeto que @ref{468,,bool} na camada Python.
@end deffn

@geindex PyBool_Check (C function)
@anchor{c-api/bool c PyBool_Check}@anchor{4f9b}
@deffn {C Função} int PyBool_Check (PyObject *o)

Retorna verdadeiro se `o' for do tipo @ref{4c10,,PyBool_Type}. Esta função sempre tem sucesso.
@end deffn

@geindex Py_False (C var)
@anchor{c-api/bool c Py_False}@anchor{4f99}
@deffn {C Variável} @ref{339,,PyObject} *Py_False

O objeto Python @code{False}. Este objeto não tem métodos e é @ref{45bb,,imortal}.


Alterado na versão 3.12: @ref{4f99,,Py_False} é @ref{45bb,,imortal}.

@end deffn

@geindex Py_True (C var)
@anchor{c-api/bool c Py_True}@anchor{4f9a}
@deffn {C Variável} @ref{339,,PyObject} *Py_True

O objeto Python @code{True}. Este objeto não tem métodos e é @ref{45bb,,imortal}.


Alterado na versão 3.12: @ref{4f9a,,Py_True} é @ref{45bb,,imortal}.

@end deffn

@geindex Py_RETURN_FALSE (C macro)
@anchor{c-api/bool c Py_RETURN_FALSE}@anchor{14bd}
@deffn {C Macro} Py_RETURN_FALSE

Retorna @ref{4f99,,Py_False} de uma função.
@end deffn

@geindex Py_RETURN_TRUE (C macro)
@anchor{c-api/bool c Py_RETURN_TRUE}@anchor{14bc}
@deffn {C Macro} Py_RETURN_TRUE

Retorna @ref{4f9a,,Py_True} de uma função.
@end deffn

@geindex PyBool_FromLong (C function)
@anchor{c-api/bool c PyBool_FromLong}@anchor{4c0f}
@deffn {C Função} @ref{339,,PyObject} *PyBool_FromLong (long v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna @ref{4f9a,,Py_True} ou @ref{4f99,,Py_False}, dependendo do valor verdade de `v'.
@end deffn

@node Objetos de ponto flutuante,Objetos números complexos,Objetos Booleanos,Objetos Numéricos
@anchor{c-api/float doc}@anchor{4f9c}@anchor{c-api/float floating-point-objects}@anchor{4f9d}@anchor{c-api/float floatobjects}@anchor{4f9e}@anchor{c-api/float translation-repo}@anchor{4f9f}
@subsubsection Objetos de ponto flutuante


@geindex objeto;ponto flutuante

@geindex PyFloatObject (C type)
@anchor{c-api/float c PyFloatObject}@anchor{4fa0}
@deffn {C Tipo} type PyFloatObject

Este subtipo de @ref{339,,PyObject} representa um objeto de ponto flutuante do Python.
@end deffn

@geindex PyFloat_Type (C var)
@anchor{c-api/float c PyFloat_Type}@anchor{4cc4}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFloat_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância do @ref{ab4,,PyTypeObject} representa o tipo de ponto flutuante do Python. Este é o mesmo objeto @ref{2f7,,float} na camada do Python.
@end deffn

@geindex PyFloat_Check (C function)
@anchor{c-api/float c PyFloat_Check}@anchor{4fa1}
@deffn {C Função} int PyFloat_Check (PyObject *p)

Retorna true se seu argumento é um @ref{4fa0,,PyFloatObject} ou um subtipo de @ref{4fa0,,PyFloatObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyFloat_CheckExact (C function)
@anchor{c-api/float c PyFloat_CheckExact}@anchor{4fa2}
@deffn {C Função} int PyFloat_CheckExact (PyObject *p)

Retorna true se seu argumento é um @ref{4fa0,,PyFloatObject}, mas um subtipo de @ref{4fa0,,PyFloatObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyFloat_FromString (C function)
@anchor{c-api/float c PyFloat_FromString}@anchor{4cc3}
@deffn {C Função} @ref{339,,PyObject} *PyFloat_FromString (PyObject *str)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um objeto @ref{4fa0,,PyFloatObject} baseado em uma string de valor “str” ou @code{NULL} em falha.
@end deffn

@geindex PyFloat_FromDouble (C function)
@anchor{c-api/float c PyFloat_FromDouble}@anchor{4cc2}
@deffn {C Função} @ref{339,,PyObject} *PyFloat_FromDouble (double v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um objeto @ref{4fa0,,PyFloatObject} de `v' ou @code{NULL} em falha.
@end deffn

@geindex PyFloat_AsDouble (C function)
@anchor{c-api/float c PyFloat_AsDouble}@anchor{a73}
@deffn {C Função} double PyFloat_AsDouble (PyObject *pyfloat)
` Parte da @ref{553,,ABI Estável}.'
Retorna uma representação C double do conteúdo de `pyfloat'. Se `pyfloat' não é um objeto de ponto flutuante do Python, mas possui o método @ref{9d4,,__float__()}, esse método será chamado primeiro para converter `pyfloat' em um ponto flutuante. Se @code{__float__()} não estiver definido, será usado @code{__index__()}. Este método retorna @code{-1.0} em caso de falha, portanto, deve-se chamar @ref{1a3b,,PyErr_Occurred()} para verificar se há erros.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.

@end deffn

@geindex PyFloat_AS_DOUBLE (C function)
@anchor{c-api/float c PyFloat_AS_DOUBLE}@anchor{4fa3}
@deffn {C Função} double PyFloat_AS_DOUBLE (PyObject *pyfloat)

Retorna uma representação C double do conteúdo de `pyfloat', mas sem verificação de erro.
@end deffn

@geindex PyFloat_GetInfo (C function)
@anchor{c-api/float c PyFloat_GetInfo}@anchor{1437}
@deffn {C Função} @ref{339,,PyObject} *PyFloat_GetInfo (void)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma instância de structseq que contém informações sobre a precisão, os valores mínimo e máximo de um ponto flutuante. É um invólucro fino em torno do arquivo de cabeçalho @code{float.h}.
@end deffn

@geindex PyFloat_GetMax (C function)
@anchor{c-api/float c PyFloat_GetMax}@anchor{1435}
@deffn {C Função} double PyFloat_GetMax ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o ponto flutuante finito máximo representável `DBL_MAX' como double do C.
@end deffn

@geindex PyFloat_GetMin (C function)
@anchor{c-api/float c PyFloat_GetMin}@anchor{1436}
@deffn {C Função} double PyFloat_GetMin ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o ponto flutuante positivo mínimo normalizado `DBL_MIN' como double do C.
@end deffn

@geindex Py_INFINITY (C macro)
@anchor{c-api/float c Py_INFINITY}@anchor{4fa4}
@deffn {C Macro} Py_INFINITY

Esta macro expande uma expressão constante do tipo double, que representa o infinito positivo.

Na maioria das plataformas, isso equivale à macro @code{INFINITY} do cabeçalho @code{<math.h>} do padrão C11.
@end deffn

@geindex Py_NAN (C macro)
@anchor{c-api/float c Py_NAN}@anchor{4fa5}
@deffn {C Macro} Py_NAN

Esta macro expande uma expressão constante do tipo double, que representa um valor não um número quieto (qNaN).

Na maioria das plataformas, isso equivale à macro @code{NAN} do cabeçalho @code{<math.h>} do padrão C11.
@end deffn

@geindex Py_HUGE_VAL (C macro)
@anchor{c-api/float c Py_HUGE_VAL}@anchor{4fa6}
@deffn {C Macro} Py_HUGE_VAL

Equivalente a @code{INFINITY}.


Descontinuado desde a versão 3.14: A macro está @ref{209,,suavemente descontinuada}.

@end deffn

@geindex Py_MATH_E (C macro)
@anchor{c-api/float c Py_MATH_E}@anchor{4fa7}
@deffn {C Macro} Py_MATH_E

A definição (precisa para um tipo double) da constante @ref{27b5,,math.e}.
@end deffn

@geindex Py_MATH_El (C macro)
@anchor{c-api/float c Py_MATH_El}@anchor{4fa8}
@deffn {C Macro} Py_MATH_El

Definição de alta precisão (long double) da constante @ref{27b5,,e}.
@end deffn

@geindex Py_MATH_PI (C macro)
@anchor{c-api/float c Py_MATH_PI}@anchor{4fa9}
@deffn {C Macro} Py_MATH_PI

A definição (precisa para um tipo double) da constante @ref{27b4,,math.pi}.
@end deffn

@geindex Py_MATH_PIl (C macro)
@anchor{c-api/float c Py_MATH_PIl}@anchor{4faa}
@deffn {C Macro} Py_MATH_PIl

Definição de alta precisão (long double) da constante @ref{27b4,,pi}.
@end deffn

@geindex Py_MATH_TAU (C macro)
@anchor{c-api/float c Py_MATH_TAU}@anchor{4fab}
@deffn {C Macro} Py_MATH_TAU

A definição (precisa para um tipo double) da constante @ref{27b6,,math.tau}.


Adicionado na versão 3.6.

@end deffn

@geindex Py_RETURN_NAN (C macro)
@anchor{c-api/float c Py_RETURN_NAN}@anchor{4fac}
@deffn {C Macro} Py_RETURN_NAN

Retorna @ref{663,,math.nan} de uma função.

Na maioria das plataformas, isso equivale a @code{return PyFloat_FromDouble(NAN)}.
@end deffn

@geindex Py_RETURN_INF (C macro)
@anchor{c-api/float c Py_RETURN_INF}@anchor{4fad}
@deffn {C Macro} Py_RETURN_INF (sign)

Retorna @ref{ca1,,math.inf} ou @ref{ca1,,-math.inf} de uma função, dependendo do sinal de `sign'.

Na maioria das plataformas, isso equivale ao seguinte:

@example
return PyFloat_FromDouble(copysign(INFINITY, sign));
@end example
@end deffn

@geindex Py_IS_FINITE (C macro)
@anchor{c-api/float c Py_IS_FINITE}@anchor{4fae}
@deffn {C Macro} Py_IS_FINITE (X)

Retorna @code{1} se o número de ponto flutuante `X' fornecido for finito, ou seja, for normal, subnormal ou zero, mas não infinito ou NaN. Caso contrário, retorna @code{0}.


Descontinuado desde a versão 3.14: A macro está @ref{209,,suavemente descontinuada}. Use @code{isfinite} em vez disso.

@end deffn

@geindex Py_IS_INFINITY (C macro)
@anchor{c-api/float c Py_IS_INFINITY}@anchor{4faf}
@deffn {C Macro} Py_IS_INFINITY (X)

Retorna @code{1} se o número de ponto flutuante `X' fornecido for infinito positivo ou negativo. Caso contrário, retorna @code{0}.


Descontinuado desde a versão 3.14: A macro está @ref{209,,suavemente descontinuada}. Use @code{isinf} em vez disso.

@end deffn

@geindex Py_IS_NAN (C macro)
@anchor{c-api/float c Py_IS_NAN}@anchor{14be}
@deffn {C Macro} Py_IS_NAN (X)

Retorna @code{1} se o número de ponto flutuante fornecido `X' for um valor não numérico (NaN). Caso contrário, retorna @code{0}.


Descontinuado desde a versão 3.14: A macro está @ref{209,,suavemente descontinuada}. Use @code{isnan} em vez disso.

@end deffn

@menu
* As funções Pack e Unpack:: 

@end menu

@node As funções Pack e Unpack,,,Objetos de ponto flutuante
@anchor{c-api/float pack-and-unpack-functions}@anchor{4fb0}
@subsubsection As funções Pack e Unpack


As funções de empacotamento e desempacotamento, pack e unpack respectivamente, fornecem uma maneira eficiente e independente de plataforma de armazenar valores de ponto flutuante como strings de bytes. As rotinas de Pack produzem uma string de bytes a partir de um C double, e as rotinas de Unpack produzem um C double a partir dessa string de bytes. O sufixo (2, 4 ou 8) especifica o número de bytes na string de bytes.

Em plataformas que parecem usar o formato IEEE 754, essas funções funcionam copiando bits. Em outras plataformas, o formato de 2 bytes é idêntico ao formato de meia precisão binário 16 do IEEE 754, o formato de 4 bytes (32 bits) é idêntico ao formato de precisão simples binário 32 do IEEE 754 e o formato de 8 bytes ao formato de precisão dupla binário 64 do IEEE 754, embora o empacotamento de INFs e NaNs (se tais recursos existirem na plataforma) não seja tratado corretamente, e tentar desempacotar uma string de bytes contendo um INF ou NaN do IEEE levantará uma exceção.

Em plataformas que não aderem IEEE com maior precisão ou maior alcance dinâmico do que o suportado pelo IEEE 754, nem todos os valores podem ser empacotados; em plataformas que não aderem IEEE com menor precisão ou menor alcance dinâmico, nem todos os valores podem ser desempacotados. O que acontece nesses casos é em parte acidental (infelizmente).


Adicionado na versão 3.11.


@menu
* Funções Pack:: 
* Funções de Unpack:: 

@end menu

@node Funções Pack,Funções de Unpack,,As funções Pack e Unpack
@anchor{c-api/float pack-functions}@anchor{4fb1}
@subsubsection Funções Pack


As rotinas de empacotamento gravam 2, 4 ou 8 bytes, começando em `p'. `le' é um argumento int, diferente de zero se você quiser a sequência de bytes no formato little-endian (expoente por último, em @code{p+1}, @code{p+3} ou @code{p+6} @code{p+7}), zero se você quiser o formato big-endian (expoente primeiro, em `p'). A constante @code{PY_BIG_ENDIAN} pode ser usada para usar o endian nativo: é igual a @code{1} em processadores big-endian ou @code{0} em processadores little-endian.

Valor de retorno: @code{0} se tudo estiver OK, @code{-1} se houver erro (e uma exceção for definida, provavelmente @ref{885,,OverflowError}).

Existem dois problemas em plataformas não IEEE:


@itemize *

@item 
O que isso faz é indefinido se `x' é um NaN ou infinito.

@item 
@code{-0.0} e @code{+0.0} produzem a mesma sequência de bytes.
@end itemize

@geindex PyFloat_Pack2 (C function)
@anchor{c-api/float c PyFloat_Pack2}@anchor{765}
@deffn {C Função} int PyFloat_Pack2 (double x, char *p, int le)

Empacota um C duplo como o formato de meia precisão binário16 IEEE 754.
@end deffn

@geindex PyFloat_Pack4 (C function)
@anchor{c-api/float c PyFloat_Pack4}@anchor{766}
@deffn {C Função} int PyFloat_Pack4 (double x, char *p, int le)

Empacota um C duplo como o formato de precisão simples binário32 IEEE 754.
@end deffn

@geindex PyFloat_Pack8 (C function)
@anchor{c-api/float c PyFloat_Pack8}@anchor{767}
@deffn {C Função} int PyFloat_Pack8 (double x, char *p, int le)

Empacota um C duplo como o formato de precisão dupla binária 64 IEEE 754.
@end deffn

@node Funções de Unpack,,Funções Pack,As funções Pack e Unpack
@anchor{c-api/float unpack-functions}@anchor{4fb2}
@subsubsection Funções de Unpack


As rotinas de desempacotamento leem 2, 4 ou 8 bytes, começando em `p'. `le' é um argumento int, diferente de zero se a sequência de bytes estiver no formato little-endian (expoente por último, em @code{p+1}, @code{p+3} ou @code{p+6} e @code{p+7}), zero se big-endian (expoente primeiro, em `p'). A constante @code{PY_BIG_ENDIAN} pode ser usada para usar o endian nativo: é igual a @code{1} em processadores big-endian ou @code{0} em processadores little-endian.

Valor de retorno: O double descompactado. Em caso de erro, é @code{-1.0} e @ref{1a3b,,PyErr_Occurred()} é verdadeiro (e uma exceção é definida, provavelmente @ref{885,,OverflowError}).

Observe que em uma plataforma que não adere IEEE isso se recusará a descompactar uma sequência de bytes que representa um NaN ou infinito.

@geindex PyFloat_Unpack2 (C function)
@anchor{c-api/float c PyFloat_Unpack2}@anchor{768}
@deffn {C Função} double PyFloat_Unpack2 (const char *p, int le)

Descompacta o formato de meia precisão IEEE 754 binary16 como um double C.
@end deffn

@geindex PyFloat_Unpack4 (C function)
@anchor{c-api/float c PyFloat_Unpack4}@anchor{769}
@deffn {C Função} double PyFloat_Unpack4 (const char *p, int le)

Descompacta o formato IEEE 754 binary32 de precisão simples como um C double.
@end deffn

@geindex PyFloat_Unpack8 (C function)
@anchor{c-api/float c PyFloat_Unpack8}@anchor{76a}
@deffn {C Função} double PyFloat_Unpack8 (const char *p, int le)

Descompacta o formato IEEE 754 binary64 de precisão dupla como um C double.
@end deffn

@node Objetos números complexos,,Objetos de ponto flutuante,Objetos Numéricos
@anchor{c-api/complex doc}@anchor{4fb3}@anchor{c-api/complex complex-number-objects}@anchor{4fb4}@anchor{c-api/complex complexobjects}@anchor{4fb5}@anchor{c-api/complex translation-repo}@anchor{4fb6}
@subsubsection Objetos números complexos


@geindex objeto;número complexo

Os objetos números complexos do Python são implementados como dois tipos distintos quando visualizados na API C: um é o objeto Python exposto aos programas Python e o outro é uma estrutura C que representa o valor real do número complexo. A API fornece funções para trabalhar com ambos.

@menu
* Números complexos como estruturas C.: Números complexos como estruturas C. 
* Números complexos como objetos Python:: 

@end menu

@node Números complexos como estruturas C,Números complexos como objetos Python,,Objetos números complexos
@anchor{c-api/complex complex-numbers-as-c-structures}@anchor{4fb7}
@subsubsection Números complexos como estruturas C.


Observe que as funções que aceitam essas estruturas como parâmetros e as retornam como resultados o fazem `por valor' em vez de desreferenciá-las por meio de ponteiros. Isso é consistente em toda a API.

@geindex Py_complex (C type)
@anchor{c-api/complex c Py_complex}@anchor{4ec5}
@deffn {C Tipo} type Py_complex

A estrutura C que corresponde à parte do valor de um objeto de número complexo Python. A maioria das funções para lidar com objetos de números complexos usa estruturas desse tipo como valores de entrada ou saída, conforme apropriado.

@geindex Py_complex.real (C member)
@geindex Py_complex.imag (C member)
@anchor{c-api/complex c Py_complex real}@anchor{4fb8}
@deffn {C Membro} double real
@anchor{c-api/complex c Py_complex imag}@anchor{4fb9}
@deffnx {C Membro} double imag
@end deffn

A estrutura é definida como:

@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{4fba}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_sum (Py_complex left, Py_complex right)

Retorna a soma de dois números complexos, utilizando a representação C @ref{4ec5,,Py_complex}.
@end deffn

@geindex _Py_c_diff (C function)
@anchor{c-api/complex c _Py_c_diff}@anchor{4fbb}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_diff (Py_complex left, Py_complex right)

Retorna a diferença entre dois números complexos, utilizando a representação C @ref{4ec5,,Py_complex}.
@end deffn

@geindex _Py_c_neg (C function)
@anchor{c-api/complex c _Py_c_neg}@anchor{4fbc}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_neg (Py_complex num)

Retorna a negação do número complexo `num', utilizando a representação C @ref{4ec5,,Py_complex}.
@end deffn

@geindex _Py_c_prod (C function)
@anchor{c-api/complex c _Py_c_prod}@anchor{4fbd}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_prod (Py_complex left, Py_complex right)

Retorna o produto de dois números complexos, utilizando a representação C @ref{4ec5,,Py_complex}.
@end deffn

@geindex _Py_c_quot (C function)
@anchor{c-api/complex c _Py_c_quot}@anchor{4fbe}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_quot (Py_complex dividend, Py_complex divisor)

Retorna o quociente de dois números complexos, utilizando a representação C @ref{4ec5,,Py_complex}.

Se `divisor' é nulo, este método retorna zero e define @code{errno} para @code{EDOM}.
@end deffn

@geindex _Py_c_pow (C function)
@anchor{c-api/complex c _Py_c_pow}@anchor{169b}
@deffn {C Função} @ref{4ec5,,Py_complex} _Py_c_pow (Py_complex num, Py_complex exp)

Retorna a exponenciação de `num' por `exp', utilizando a representação C @ref{4ec5,,Py_complex}

Se `num' for nulo e `exp' não for um número real positivo, este método retorna zero e define @code{errno} para @code{EDOM}.
@end deffn

@node Números complexos como objetos Python,,Números complexos como estruturas C,Objetos números complexos
@anchor{c-api/complex complex-numbers-as-python-objects}@anchor{4fbf}
@subsubsection Números complexos como objetos Python


@geindex PyComplexObject (C type)
@anchor{c-api/complex c PyComplexObject}@anchor{4fc0}
@deffn {C Tipo} type PyComplexObject

Este subtipo de @ref{339,,PyObject} representa um objeto Python de número complexo.
@end deffn

@geindex PyComplex_Type (C var)
@anchor{c-api/complex c PyComplex_Type}@anchor{4c47}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyComplex_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de número complexo Python. É o mesmo objeto que @ref{2f8,,complex} na camada Python.
@end deffn

@geindex PyComplex_Check (C function)
@anchor{c-api/complex c PyComplex_Check}@anchor{4fc1}
@deffn {C Função} int PyComplex_Check (PyObject *p)

Retorna true se seu argumento é um @ref{4fc0,,PyComplexObject} ou um subtipo de @ref{4fc0,,PyComplexObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyComplex_CheckExact (C function)
@anchor{c-api/complex c PyComplex_CheckExact}@anchor{4fc2}
@deffn {C Função} int PyComplex_CheckExact (PyObject *p)

Retorna true se seu argumento é um @ref{4fc0,,PyComplexObject}, mas não um subtipo de @ref{4fc0,,PyComplexObject}. Esta função sempre tem sucesso.
@end deffn

@geindex PyComplex_FromCComplex (C function)
@anchor{c-api/complex c PyComplex_FromCComplex}@anchor{4fc3}
@deffn {C Função} @ref{339,,PyObject} *PyComplex_FromCComplex (Py_complex v)
`Retorna valor: Nova referência.'
Cria um novo objeto de número complexo Python a partir de um valor C @ref{4ec5,,Py_complex}. Retorna @code{NULL} com uma exceção definida ao ocorrer um erro.
@end deffn

@geindex PyComplex_FromDoubles (C function)
@anchor{c-api/complex c PyComplex_FromDoubles}@anchor{4c46}
@deffn {C Função} @ref{339,,PyObject} *PyComplex_FromDoubles (double real, double imag)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto @ref{4fc0,,PyComplexObject} de `real' e `imag'. Retorna @code{NULL} com uma exceção definida ao ocorrer um erro.
@end deffn

@geindex PyComplex_RealAsDouble (C function)
@anchor{c-api/complex c PyComplex_RealAsDouble}@anchor{178d}
@deffn {C Função} double PyComplex_RealAsDouble (PyObject *op)
` Parte da @ref{553,,ABI Estável}.'
Retorna a parte real de `op' como um double C.

Se `op' não é um objeto de número complexo Python, mas tem um método @ref{5e7,,__complex__()}, este método será primeiro chamado para converter `op' em um objeto de número complexo Python. Se @code{__complex__()} não estiver definido, ele volta a chamar @ref{a73,,PyFloat_AsDouble()} e retorna seu resultado.

Em caso de falha, este método retorna @code{-1.0} com uma exceção definida, então deve-se chamar @ref{1a3b,,PyErr_Occurred()} para verificar se há erros.


Alterado na versão 3.13: Usa @ref{5e7,,__complex__()}, se disponível.

@end deffn

@geindex PyComplex_ImagAsDouble (C function)
@anchor{c-api/complex c PyComplex_ImagAsDouble}@anchor{178e}
@deffn {C Função} double PyComplex_ImagAsDouble (PyObject *op)
` Parte da @ref{553,,ABI Estável}.'
Retorna a parte imaginária de `op' como um double C.

Se `op' não é um objeto de número complexo Python, mas tem um método @ref{5e7,,__complex__()}, este método será primeiro chamado para converter `op' em um objeto de número complexo Python. Se @code{__complex__()} não estiver definido, ele volta a chamar @ref{a73,,PyFloat_AsDouble()} e retorna @code{0.0} em caso de sucesso.

Em caso de falha, este método retorna @code{-1.0} com uma exceção definida, então deve-se chamar @ref{1a3b,,PyErr_Occurred()} para verificar se há erros.


Alterado na versão 3.13: Usa @ref{5e7,,__complex__()}, se disponível.

@end deffn

@geindex PyComplex_AsCComplex (C function)
@anchor{c-api/complex c PyComplex_AsCComplex}@anchor{1438}
@deffn {C Função} @ref{4ec5,,Py_complex} PyComplex_AsCComplex (PyObject *op)

Retorna o valor @ref{4ec5,,Py_complex} do número complexo `op'.

Se `op' não é um objeto de número complexo Python, mas tem um método @ref{5e7,,__complex__()}, este método será primeiro chamado para converter `op' em um objeto de número complexo Python. Se @code{__complex__()} não for definido, então ele recorre a @ref{9d4,,__float__()}. Se @code{__float__()} não estiver definido, então ele volta para @ref{71d,,__index__()}.

Em caso de falha, este método retorna @ref{4ec5,,Py_complex} com @ref{4fb8,,real} definido para @code{-1.0} e com uma exceção definida, então deve-se chamar @ref{1a3b,,PyErr_Occurred()} para verificar se há erros.


Alterado na versão 3.8: Usa @ref{71d,,__index__()}, se disponível.

@end deffn

@node Objetos Sequência,Coleções,Objetos Numéricos,Camada de Objetos Concretos
@anchor{c-api/concrete sequence-objects}@anchor{4fc4}@anchor{c-api/concrete sequenceobjects}@anchor{4fc5}
@subsection Objetos Sequência


@geindex objeto;sequência

Operações genéricas em objetos de sequência foram discutidas no capítulo anterior; Esta seção lida com os tipos específicos de objetos sequência que são intrínsecos à linguagem Python.

@c XXX sort out unicode, str, bytes and bytearray

@menu
* Objetos bytes: Objetos bytes<2>. 
* Objetos byte array:: 
* Objetos Unicode e Codecs:: 
* Objeto tupla:: 
* Objetos sequência de estrutura:: 
* Objeto List:: 

@end menu

@node Objetos bytes<2>,Objetos byte array,,Objetos Sequência
@anchor{c-api/bytes doc}@anchor{4fc6}@anchor{c-api/bytes bytes-objects}@anchor{4fc7}@anchor{c-api/bytes bytesobjects}@anchor{4fc8}
@subsubsection Objetos bytes


Estas funções levantam @ref{2c3,,TypeError} quando se espera um parâmetro bytes e são chamados com um parâmetro que não é bytes.

@geindex objeto;bytes

@geindex PyBytesObject (C type)
@anchor{c-api/bytes c PyBytesObject}@anchor{792}
@deffn {C Tipo} type PyBytesObject

Esta é uma instância de @ref{339,,PyObject} representando o objeto bytes do Python.
@end deffn

@geindex PyBytes_Type (C var)
@anchor{c-api/bytes c PyBytes_Type}@anchor{4c21}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyBytes_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de bytes Python; é o mesmo objeto que @ref{1c2,,bytes} na camada de Python.
@end deffn

@geindex PyBytes_Check (C function)
@anchor{c-api/bytes c PyBytes_Check}@anchor{13e6}
@deffn {C Função} int PyBytes_Check (PyObject *o)

Retorna verdadeiro se o objeto `o' for um objeto bytes ou se for uma instância de um subtipo do tipo bytes. Esta função sempre tem sucesso.
@end deffn

@geindex PyBytes_CheckExact (C function)
@anchor{c-api/bytes c PyBytes_CheckExact}@anchor{4fc9}
@deffn {C Função} int PyBytes_CheckExact (PyObject *o)

Retorna verdadeiro se o objeto `o' for um objeto bytes, mas não uma instância de um subtipo do tipo bytes. Esta função sempre tem sucesso.
@end deffn

@geindex PyBytes_FromString (C function)
@anchor{c-api/bytes c PyBytes_FromString}@anchor{4c1e}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_FromString (const char *v)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto de bytes com uma cópia da string `v' como valor em caso de sucesso e @code{NULL} em caso de falha. O parâmetro `v' não deve ser @code{NULL} e isso não será verificado.
@end deffn

@geindex PyBytes_FromStringAndSize (C function)
@anchor{c-api/bytes c PyBytes_FromStringAndSize}@anchor{13e7}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_FromStringAndSize (const char *v, Py_ssize_t len)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto de bytes com uma cópia da string `v' como valor e comprimento `len' em caso de sucesso e @code{NULL} em caso de falha. Se `v' for @code{NULL}, o conteúdo do objeto bytes não será inicializado.
@end deffn

@geindex PyBytes_FromFormat (C function)
@anchor{c-api/bytes c PyBytes_FromFormat}@anchor{1ba1}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_FromFormat (const char *format, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Leva uma string tipo @code{printf()} do C `format' e um número variável de argumentos, calcula o tamanho do objeto bytes do Python resultante e retorna um objeto bytes com os valores formatados nela. Os argumentos da variável devem ser tipos C e devem corresponder exatamente aos caracteres de formato na string `format'. Os seguintes formatos de caracteres são permitidos:

@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 Formatados

@tab

Tipo

@tab

Comentário

@item

@code{%%}

@tab

`n/d'

@tab

O caractere literal %.

@item

@code{%c}

@tab

int

@tab

Um único byte, representado como um C int.

@item

@code{%d}

@tab

int

@tab

Equivalente a @code{printf("%d")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%u}

@tab

unsigned int

@tab

Equivalente a @code{printf("%u")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%ld}

@tab

long

@tab

Equivalente a @code{printf("%ld")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%lu}

@tab

unsigned long

@tab

Equivalente a @code{printf("%lu")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%zd}

@tab

@ref{a69,,Py_ssize_t}

@tab

Equivalente a @code{printf("%zd")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%zu}

@tab

size_t

@tab

Equivalente a @code{printf("%zu")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%i}

@tab

int

@tab

Equivalente a @code{printf("%i")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%x}

@tab

int

@tab

Equivalente a @code{printf("%x")}. @footnote{
Para especificadores de número inteiro (d, u, ld, lu, zd, zu, i, x): o sinalizador de conversão 0 tem efeito mesmo quando uma precisão é fornecida.
}

@item

@code{%s}

@tab

const char*

@tab

Uma matriz de caracteres C com terminação nula.

@item

@code{%p}

@tab

const void*

@tab

A representação hexadecimal de um ponteiro C. Principalmente equivalente a @code{printf("%p")} exceto que é garantido que comece com o literal @code{0x} independentemente do que o @code{printf} da plataforma ceda.

@end multitable


Um caractere de formato não reconhecido faz com que todo o resto da string de formato seja copiado como é para o objeto resultante e todos os argumentos extras sejam descartados.
@end deffn

@geindex PyBytes_FromFormatV (C function)
@anchor{c-api/bytes c PyBytes_FromFormatV}@anchor{4c1c}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_FromFormatV (const char *format, va_list vargs)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Idêntico a @ref{1ba1,,PyBytes_FromFormat()} exceto que é preciso exatamente dois argumentos.
@end deffn

@geindex PyBytes_FromObject (C function)
@anchor{c-api/bytes c PyBytes_FromObject}@anchor{4c1d}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_FromObject (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a representação de bytes do objeto `o' que implementa o protocolo de buffer.
@end deffn

@geindex PyBytes_Size (C function)
@anchor{c-api/bytes c PyBytes_Size}@anchor{4c20}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyBytes_Size (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Retorna o comprimento dos bytes em objeto bytes `o'.
@end deffn

@geindex PyBytes_GET_SIZE (C function)
@anchor{c-api/bytes c PyBytes_GET_SIZE}@anchor{4fca}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyBytes_GET_SIZE (PyObject *o)

Similar a @ref{4c20,,PyBytes_Size()}, mas sem verificação de erro.
@end deffn

@geindex PyBytes_AsString (C function)
@anchor{c-api/bytes c PyBytes_AsString}@anchor{88b}
@deffn {C Função} char *PyBytes_AsString (PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Retorna um ponteiro para o conteúdo de `o'. O ponteiro se refere ao buffer interno de `o', que consiste em @code{len(o) + 1} bytes. O último byte no buffer é sempre nulo, independentemente de haver outros bytes nulos. Os dados não devem ser modificados de forma alguma, a menos que o objeto tenha sido criado usando @code{PyBytes_FromStringAndSize(NULL, size)}. Não deve ser desalocado. Se `o' não é um objeto de bytes, @ref{88b,,PyBytes_AsString()} retorna @code{NULL} e levanta @ref{2c3,,TypeError}.
@end deffn

@geindex PyBytes_AS_STRING (C function)
@anchor{c-api/bytes c PyBytes_AS_STRING}@anchor{4fcb}
@deffn {C Função} char *PyBytes_AS_STRING (PyObject *string)

Similar a @ref{88b,,PyBytes_AsString()}, mas sem verificação de erro.
@end deffn

@geindex PyBytes_AsStringAndSize (C function)
@anchor{c-api/bytes c PyBytes_AsStringAndSize}@anchor{4c18}
@deffn {C Função} int PyBytes_AsStringAndSize (PyObject *obj, char **buffer, Py_ssize_t *length)
` Parte da @ref{553,,ABI Estável}.'
Retorna os conteúdos terminados nulos do objeto `obj' através das variáveis de saída `buffer' e `length'. Retorna @code{0} em caso de sucesso.

Se `length' for @code{NULL}, o objeto bytes não poderá conter bytes nulos incorporados; se isso acontecer, a função retornará @code{-1} e a @ref{202,,ValueError} será levantado.

O buffer refere-se a um buffer interno de `obj', que inclui um byte nulo adicional no final (não contado em `length'). Os dados não devem ser modificados de forma alguma, a menos que o objeto tenha sido criado apenas usando @code{PyBytes_FromStringAndSize(NULL, size)}. Não deve ser desalinhado. Se `obj' não é um objeto bytes, @ref{4c18,,PyBytes_AsStringAndSize()} retorna @code{-1} e levanta @ref{2c3,,TypeError}.


Alterado na versão 3.5: Anteriormente @ref{2c3,,TypeError} era levantado quando os bytes nulos incorporados eram encontrados no objeto bytes.

@end deffn

@geindex PyBytes_Concat (C function)
@anchor{c-api/bytes c PyBytes_Concat}@anchor{4c19}
@deffn {C Função} void PyBytes_Concat (PyObject **bytes, PyObject *newpart)
` Parte da @ref{553,,ABI Estável}.'
Cria um novo objeto de bytes em `*bytes' contendo o conteúdo de `newpart' anexado a `bytes'; o chamador será o proprietário da nova referência. A referência ao valor antigo de `bytes' será roubada. Se o novo objeto não puder ser criado, a antiga referência a `bytes' ainda será descartada e o valor de `*bytes' será definido como @code{NULL}; a exceção apropriada será definida.
@end deffn

@geindex PyBytes_ConcatAndDel (C function)
@anchor{c-api/bytes c PyBytes_ConcatAndDel}@anchor{4c1a}
@deffn {C Função} void PyBytes_ConcatAndDel (PyObject **bytes, PyObject *newpart)
` Parte da @ref{553,,ABI Estável}.'
“Crie um novo objeto bytes em `*bytes' contendo o conteúdo de newpart anexado a bytes. Esta versão libera a @ref{33d,,strong reference} (referência forte) para newpart (ou seja, decrementa a contagem de referências a ele).”
@end deffn

@geindex _PyBytes_Resize (C function)
@anchor{c-api/bytes c _PyBytes_Resize}@anchor{1745}
@deffn {C Função} int _PyBytes_Resize (PyObject **bytes, Py_ssize_t newsize)

Redimensiona um objeto de bytes. `newsize' será o novo tamanho do objeto bytes. Você pode pensar nisso como se estivesse criando um novo objeto de bytes e destruindo o antigo, só que de forma mais eficiente. Passe o endereço de um objeto de bytes existente como um lvalue (pode ser gravado) e o novo tamanho desejado. Em caso de sucesso, `*bytes' mantém o objeto de bytes redimensionados e @code{0} é retornado; o endereço em `*bytes' pode diferir do seu valor de entrada. Se a realocação falhar, o objeto de bytes originais em `*bytes' é desalocado, `*bytes' é definido como @code{NULL}, @ref{15c5,,MemoryError} é definido e @code{-1} é retornado.
@end deffn

@geindex PyBytes_Repr (C function)
@anchor{c-api/bytes c PyBytes_Repr}@anchor{4c1f}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_Repr (PyObject *bytes, int smartquotes)
` Parte da @ref{553,,ABI Estável}.'
Obtém a representação em string de `bytes'. Esta função é atualmente usada para implementar @code{bytes.__repr__()} em Python.

Esta função não realiza verificação de tipo; é um comportamento indefinido passar `bytes' como um objeto que não seja do tipo bytes ou @code{NULL}.

Se `smartquotes' for verdadeiro, a representação usará uma string entre aspas duplas em vez de aspas simples quando aspas simples estiverem presentes em `bytes'. Por exemplo, a string de bytes @code{'Python'} seria representada como @code{b"'Python'"} quando `smartquotes' for verdadeiro, ou @code{b'\'Python\'@w{'}} quando for falso.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} a um objeto @ref{44c,,str} contendo a representação. Em caso de falha, ela retorna @code{NULL} com uma exceção definida.
@end deffn

@geindex PyBytes_DecodeEscape (C function)
@anchor{c-api/bytes c PyBytes_DecodeEscape}@anchor{4c1b}
@deffn {C Função} @ref{339,,PyObject} *PyBytes_DecodeEscape (const char *s, Py_ssize_t len, const char *errors, Py_ssize_t unicode, const char *recode_encoding)
` Parte da @ref{553,,ABI Estável}.'
Remove um string `s' que foi escapada com contrabarra. `s' não pode ser @code{NULL}. `len' deve ser o tamanho de `s'.

`errors' deve ser um dos seguintes valores: @code{"strict"}, @code{"replace"} ou @code{"ignore"}. Se `errors' for @code{NULL}, o valor padrão será @code{"strict"}.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} a um objeto Python @ref{1c2,,bytes} contendo a string sem escape. Em caso de falha, esta função retorna @code{NULL} com uma exceção definida.


Alterado na versão 3.9: `unicode' e `recode_encoding' não são mais usadas.

@end deffn

@node Objetos byte array,Objetos Unicode e Codecs,Objetos bytes<2>,Objetos Sequência
@anchor{c-api/bytearray doc}@anchor{4fcc}@anchor{c-api/bytearray byte-array-objects}@anchor{4fcd}@anchor{c-api/bytearray bytearrayobjects}@anchor{4fce}@anchor{c-api/bytearray translation-repo}@anchor{4fcf}
@subsubsection Objetos byte array


@geindex objeto;bytearray

@geindex PyByteArrayObject (C type)
@anchor{c-api/bytearray c PyByteArrayObject}@anchor{4fd0}
@deffn {C Tipo} type PyByteArrayObject

Esse subtipo de @ref{339,,PyObject} representa um objeto Python bytearray.
@end deffn

@geindex PyByteArray_Type (C var)
@anchor{c-api/bytearray c PyByteArray_Type}@anchor{4c16}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyByteArray_Type
` Parte da @ref{553,,ABI Estável}.'
Essa instância de @ref{ab4,,PyTypeObject} representa um tipo Python bytearray; é o mesmo objeto que o @ref{2ea,,bytearray} na camada Python.
@end deffn

@menu
* Macros para verificação de tipo:: 
* Funções diretas da API:: 
* Macros:: 

@end menu

@node Macros para verificação de tipo,Funções diretas da API,,Objetos byte array
@anchor{c-api/bytearray type-check-macros}@anchor{4fd1}
@subsubsection Macros para verificação de tipo


@geindex PyByteArray_Check (C function)
@anchor{c-api/bytearray c PyByteArray_Check}@anchor{4fd2}
@deffn {C Função} int PyByteArray_Check (PyObject *o)

Retorna verdadeiro se o objeto `o' for um objeto bytearray ou se for uma instância de um subtipo do tipo bytearray. Esta função sempre tem sucesso.
@end deffn

@geindex PyByteArray_CheckExact (C function)
@anchor{c-api/bytearray c PyByteArray_CheckExact}@anchor{4fd3}
@deffn {C Função} int PyByteArray_CheckExact (PyObject *o)

Retorna verdadeiro se o objeto `o' for um objeto bytearray, mas não uma instância de um subtipo do tipo bytearray. Esta função sempre tem sucesso.
@end deffn

@node Funções diretas da API,Macros,Macros para verificação de tipo,Objetos byte array
@anchor{c-api/bytearray direct-api-functions}@anchor{4fd4}
@subsubsection Funções diretas da API


@geindex PyByteArray_FromObject (C function)
@anchor{c-api/bytearray c PyByteArray_FromObject}@anchor{13ef}
@deffn {C Função} @ref{339,,PyObject} *PyByteArray_FromObject (PyObject *o)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto bytearray, `o', que implementa o @ref{2e8,,protocolo de buffer}.

Em caso de falha, retorna @code{NULL} com uma exceção definida.
@end deffn

@geindex PyByteArray_FromStringAndSize (C function)
@anchor{c-api/bytearray c PyByteArray_FromStringAndSize}@anchor{13f0}
@deffn {C Função} @ref{339,,PyObject} *PyByteArray_FromStringAndSize (const char *string, Py_ssize_t len)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um novo objeto bytearray a partir de `string' e seu comprimento, `len'.

Em caso de falha, retorna @code{NULL} com uma exceção definida.
@end deffn

@geindex PyByteArray_Concat (C function)
@anchor{c-api/bytearray c PyByteArray_Concat}@anchor{4c13}
@deffn {C Função} @ref{339,,PyObject} *PyByteArray_Concat (PyObject *a, PyObject *b)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Concatena os bytearrays `a' e `b' e retorna um novo bytearray com o resultado.

Em caso de falha, retorna @code{NULL} com uma exceção definida.
@end deffn

@geindex PyByteArray_Size (C function)
@anchor{c-api/bytearray c PyByteArray_Size}@anchor{4c15}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyByteArray_Size (PyObject *bytearray)
` Parte da @ref{553,,ABI Estável}.'
Retorna o tamanho de `bytearray' após verificar se há um ponteiro @code{NULL}.
@end deffn

@geindex PyByteArray_AsString (C function)
@anchor{c-api/bytearray c PyByteArray_AsString}@anchor{4c12}
@deffn {C Função} char *PyByteArray_AsString (PyObject *bytearray)
` Parte da @ref{553,,ABI Estável}.'
Retorna o conteúdo de `bytearray' como uma matriz de caracteres após verificar um ponteiro @code{NULL}. O array retornado sempre tem um byte nulo extra acrescentado.
@end deffn

@geindex PyByteArray_Resize (C function)
@anchor{c-api/bytearray c PyByteArray_Resize}@anchor{4c14}
@deffn {C Função} int PyByteArray_Resize (PyObject *bytearray, Py_ssize_t len)
` Parte da @ref{553,,ABI Estável}.'
Redimensiona o buffer interno de `bytearray' para o tamanho `len'.
@end deffn

@node Macros,,Funções diretas da API,Objetos byte array
@anchor{c-api/bytearray macros}@anchor{4fd5}
@subsubsection Macros


Estas macros trocam segurança por velocidade e não verificam os ponteiros.

@geindex PyByteArray_AS_STRING (C function)
@anchor{c-api/bytearray c PyByteArray_AS_STRING}@anchor{4fd6}
@deffn {C Função} char *PyByteArray_AS_STRING (PyObject *bytearray)

Similar a @ref{4c12,,PyByteArray_AsString()}, mas sem verificação de erro.
@end deffn

@geindex PyByteArray_GET_SIZE (C function)
@anchor{c-api/bytearray c PyByteArray_GET_SIZE}@anchor{4fd7}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyByteArray_GET_SIZE (PyObject *bytearray)

Similar a @ref{4c15,,PyByteArray_Size()}, mas sem verificação de erro.
@end deffn

@node Objetos Unicode e Codecs,Objeto tupla,Objetos byte array,Objetos Sequência
@anchor{c-api/unicode doc}@anchor{11df}@anchor{c-api/unicode translation-repo}@anchor{4fd8}@anchor{c-api/unicode unicode-objects-and-codecs}@anchor{4fd9}@anchor{c-api/unicode unicodeobjects}@anchor{4fda}
@subsubsection Objetos Unicode e Codecs


@menu
* Objetos Unicode:: 
* Built-in Codecs:: 
* Methods and Slot Functions:: 

@end menu

@node Objetos Unicode,Built-in Codecs,,Objetos Unicode e Codecs
@anchor{c-api/unicode unicode-objects}@anchor{4fdb}
@subsubsection Objetos Unicode


Desde a implementação da 
@geindex Propostas de Melhorias do Python; PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} no Python 3.3, os objetos Unicode usam internamente uma variedade de representações para permitir o processamento de toda a gama de caracteres Unicode, mantendo a eficiência de memória. Há casos especiais para strings em que todos os pontos de código estão abaixo de 128, 256 ou 65536; caso contrário, os pontos de código devem estar abaixo de 1114112 (que é a gama completa de caracteres Unicode).

A representação UTF-8 é criada sob demanda e armazenada em cache no objeto Unicode.

@cartouche
@quotation Nota 
A representação @ref{3ed,,Py_UNICODE} foi removida desde o Python 3.12 com APIs descontinuadas. Consulte 
@geindex Propostas de Melhorias do Python; PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} para obter mais informações.
@end quotation
@end cartouche

@menu
* Tipo Unicode:: 
* Propriedade de caracteres Unicode:: 
* Creating and accessing Unicode strings:: 
* Locale Encoding:: 
* File System Encoding:: 
* wchar_t Support:: 

@end menu

@node Tipo Unicode,Propriedade de caracteres Unicode,,Objetos Unicode
@anchor{c-api/unicode unicode-type}@anchor{4fdc}
@subsubsection Tipo Unicode


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

@geindex Py_UCS4 (C type)
@geindex Py_UCS2 (C type)
@geindex Py_UCS1 (C type)
@anchor{c-api/unicode c Py_UCS4}@anchor{29b}
@deffn {C Tipo} type Py_UCS4
@anchor{c-api/unicode c Py_UCS2}@anchor{11b3}
@deffnx {C Tipo} type Py_UCS2
@anchor{c-api/unicode c Py_UCS1}@anchor{11b2}
@deffnx {C Tipo} type Py_UCS1
` Parte da @ref{553,,ABI Estável}.'
Esses tipos são definições de tipo para tipos inteiros sem sinal, amplos o suficiente para conter caracteres de 32 bits, 16 bits e 8 bits, respectivamente. Ao lidar com caracteres Unicode simples, use @ref{29b,,Py_UCS4}.


Adicionado na versão 3.3.

@end deffn

@geindex Py_UNICODE (C type)
@anchor{c-api/unicode c Py_UNICODE}@anchor{3ed}
@deffn {C Tipo} type Py_UNICODE

Este é um typedef de @code{wchar_t}, que é um tipo de 16 bits ou 32 bits, dependendo da plataforma.


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



Descontinuado desde a versão 3.13, será removido na versão 3.15.

@end deffn

@geindex PyASCIIObject (C type)
@geindex PyCompactUnicodeObject (C type)
@geindex PyUnicodeObject (C type)
@anchor{c-api/unicode c PyASCIIObject}@anchor{11b4}
@deffn {C Tipo} type PyASCIIObject
@anchor{c-api/unicode c PyCompactUnicodeObject}@anchor{11b5}
@deffnx {C Tipo} type PyCompactUnicodeObject
@anchor{c-api/unicode c PyUnicodeObject}@anchor{794}
@deffnx {C Tipo} type PyUnicodeObject

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_Type (C var)
@anchor{c-api/unicode c PyUnicode_Type}@anchor{4db9}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyUnicode_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo Unicode do Python. Ela é exposta ao código Python como @code{str}.
@end deffn

@geindex PyUnicodeIter_Type (C var)
@anchor{c-api/unicode c PyUnicodeIter_Type}@anchor{4d8d}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyUnicodeIter_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo iterador Unicode do Python. É usada para iterar sobre objetos string Unicode.
@end deffn

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

@geindex PyUnicode_Check (C function)
@anchor{c-api/unicode c PyUnicode_Check}@anchor{4fdd}
@deffn {C Função} int PyUnicode_Check (PyObject *obj)

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

@geindex PyUnicode_CheckExact (C function)
@anchor{c-api/unicode c PyUnicode_CheckExact}@anchor{4fde}
@deffn {C Função} int PyUnicode_CheckExact (PyObject *obj)

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

@geindex PyUnicode_READY (C function)
@anchor{c-api/unicode c PyUnicode_READY}@anchor{401}
@deffn {C Função} int PyUnicode_READY (PyObject *unicode)

Retorna @code{0}. Essa API é mantida apenas para retrocompatibilidade.


Adicionado na versão 3.3.



Descontinuado desde a versão 3.10: Esta API não faz nada desde o Python 3.12.

@end deffn

@geindex PyUnicode_GET_LENGTH (C function)
@anchor{c-api/unicode c PyUnicode_GET_LENGTH}@anchor{8b9}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_GET_LENGTH (PyObject *unicode)

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


Adicionado na versão 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{11b9}
@deffn {C Função} @ref{11b2,,Py_UCS1} *PyUnicode_1BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_2BYTE_DATA}@anchor{11ba}
@deffnx {C Função} @ref{11b3,,Py_UCS2} *PyUnicode_2BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_4BYTE_DATA}@anchor{11bb}
@deffnx {C Função} @ref{29b,,Py_UCS4} *PyUnicode_4BYTE_DATA (PyObject *unicode)

Retorna um ponteiro para a representação canônica convertida para tipos inteiros UCS1, UCS2 ou UCS4 para acesso direto aos caracteres. Nenhuma verificação é realizada se a representação canônica tem o tamanho de caractere correto; use @ref{11bc,,PyUnicode_KIND()} para selecionar a função correta.


Adicionado na versão 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{11bd}
@deffn {C Macro} PyUnicode_1BYTE_KIND
@anchor{c-api/unicode c PyUnicode_2BYTE_KIND}@anchor{11be}
@deffnx {C Macro} PyUnicode_2BYTE_KIND
@anchor{c-api/unicode c PyUnicode_4BYTE_KIND}@anchor{11bf}
@deffnx {C Macro} PyUnicode_4BYTE_KIND

Valores de retorno da macro @ref{11bc,,PyUnicode_KIND()}.


Adicionado na versão 3.3.



Alterado na versão 3.12: @code{PyUnicode_WCHAR_KIND} foi removida.

@end deffn

@geindex PyUnicode_KIND (C function)
@anchor{c-api/unicode c PyUnicode_KIND}@anchor{11bc}
@deffn {C Função} int PyUnicode_KIND (PyObject *unicode)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_DATA (C function)
@anchor{c-api/unicode c PyUnicode_DATA}@anchor{11b8}
@deffn {C Função} void *PyUnicode_DATA (PyObject *unicode)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_WRITE (C function)
@anchor{c-api/unicode c PyUnicode_WRITE}@anchor{11c2}
@deffn {C Função} void PyUnicode_WRITE (int kind, void *data, Py_ssize_t index, Py_UCS4 value)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_READ (C function)
@anchor{c-api/unicode c PyUnicode_READ}@anchor{11c0}
@deffn {C Função} @ref{29b,,Py_UCS4} PyUnicode_READ (int kind, void *data, Py_ssize_t index)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_READ_CHAR (C function)
@anchor{c-api/unicode c PyUnicode_READ_CHAR}@anchor{11c1}
@deffn {C Função} @ref{29b,,Py_UCS4} PyUnicode_READ_CHAR (PyObject *unicode, Py_ssize_t index)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_MAX_CHAR_VALUE (C function)
@anchor{c-api/unicode c PyUnicode_MAX_CHAR_VALUE}@anchor{11c3}
@deffn {C Função} @ref{29b,,Py_UCS4} PyUnicode_MAX_CHAR_VALUE (PyObject *unicode)

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


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_IsIdentifier (C function)
@anchor{c-api/unicode c PyUnicode_IsIdentifier}@anchor{1b15}
@deffn {C Função} int PyUnicode_IsIdentifier (PyObject *unicode)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se a string é um identificador válido conforme a definição da linguagem, seção @ref{2021,,Identificadores e palavras-chave}. Do contrário, retorna @code{0}.


Alterado na versão 3.9: A função não chama mais @ref{98a,,Py_FatalError()} se a string não estiver pronta.

@end deffn

@node Propriedade de caracteres Unicode,Creating and accessing Unicode strings,Tipo Unicode,Objetos Unicode
@anchor{c-api/unicode unicode-character-properties}@anchor{4fdf}
@subsubsection Propriedade de caracteres Unicode


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

@geindex Py_UNICODE_ISSPACE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISSPACE}@anchor{1a51}
@deffn {C Função} int Py_UNICODE_ISSPACE (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere de espaço em branco.
@end deffn

@geindex Py_UNICODE_ISLOWER (C function)
@anchor{c-api/unicode c Py_UNICODE_ISLOWER}@anchor{4fe0}
@deffn {C Função} int Py_UNICODE_ISLOWER (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere minúsculo.
@end deffn

@geindex Py_UNICODE_ISUPPER (C function)
@anchor{c-api/unicode c Py_UNICODE_ISUPPER}@anchor{4fe1}
@deffn {C Função} int Py_UNICODE_ISUPPER (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere maiúsculo.
@end deffn

@geindex Py_UNICODE_ISTITLE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISTITLE}@anchor{4fe2}
@deffn {C Função} int Py_UNICODE_ISTITLE (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere em TitleCase.
@end deffn

@geindex Py_UNICODE_ISLINEBREAK (C function)
@anchor{c-api/unicode c Py_UNICODE_ISLINEBREAK}@anchor{4fe3}
@deffn {C Função} int Py_UNICODE_ISLINEBREAK (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere de quebra de linha.
@end deffn

@geindex Py_UNICODE_ISDECIMAL (C function)
@anchor{c-api/unicode c Py_UNICODE_ISDECIMAL}@anchor{4fe4}
@deffn {C Função} int Py_UNICODE_ISDECIMAL (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere decimal.
@end deffn

@geindex Py_UNICODE_ISDIGIT (C function)
@anchor{c-api/unicode c Py_UNICODE_ISDIGIT}@anchor{4fe5}
@deffn {C Função} int Py_UNICODE_ISDIGIT (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere de dígito.
@end deffn

@geindex Py_UNICODE_ISNUMERIC (C function)
@anchor{c-api/unicode c Py_UNICODE_ISNUMERIC}@anchor{4fe6}
@deffn {C Função} int Py_UNICODE_ISNUMERIC (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere numérico.
@end deffn

@geindex Py_UNICODE_ISALPHA (C function)
@anchor{c-api/unicode c Py_UNICODE_ISALPHA}@anchor{4fe7}
@deffn {C Função} int Py_UNICODE_ISALPHA (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere alfabético.
@end deffn

@geindex Py_UNICODE_ISALNUM (C function)
@anchor{c-api/unicode c Py_UNICODE_ISALNUM}@anchor{4fe8}
@deffn {C Função} int Py_UNICODE_ISALNUM (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere alfanumérico.
@end deffn

@geindex Py_UNICODE_ISPRINTABLE (C function)
@anchor{c-api/unicode c Py_UNICODE_ISPRINTABLE}@anchor{4fe9}
@deffn {C Função} int Py_UNICODE_ISPRINTABLE (Py_UCS4 ch)

Retorna @code{1} ou @code{0} dependendo se `ch' é um caractere imprimível, no sentido de @ref{e02,,str.isprintable()}.
@end deffn

These APIs can be used for fast direct character conversions:

@geindex Py_UNICODE_TOLOWER (C function)
@anchor{c-api/unicode c Py_UNICODE_TOLOWER}@anchor{4fea}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_TOLOWER (Py_UCS4 ch)

Return the character `ch' converted to lower case.
@end deffn

@geindex Py_UNICODE_TOUPPER (C function)
@anchor{c-api/unicode c Py_UNICODE_TOUPPER}@anchor{4feb}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_TOUPPER (Py_UCS4 ch)

Return the character `ch' converted to upper case.
@end deffn

@geindex Py_UNICODE_TOTITLE (C function)
@anchor{c-api/unicode c Py_UNICODE_TOTITLE}@anchor{4fec}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_TOTITLE (Py_UCS4 ch)

Return the character `ch' converted to title case.
@end deffn

@geindex Py_UNICODE_TODECIMAL (C function)
@anchor{c-api/unicode c Py_UNICODE_TODECIMAL}@anchor{4fed}
@deffn {C Função} 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{4fee}
@deffn {C Função} 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{4fef}
@deffn {C Função} 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

These APIs can be used to work with surrogates:

@geindex Py_UNICODE_IS_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_IS_SURROGATE}@anchor{4ff0}
@deffn {C Função} int Py_UNICODE_IS_SURROGATE (Py_UCS4 ch)

Check if `ch' is a surrogate (@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{4ff1}
@deffn {C Função} int Py_UNICODE_IS_HIGH_SURROGATE (Py_UCS4 ch)

Check if `ch' is a high surrogate (@code{0xD800 <= ch <= 0xDBFF}).
@end deffn

@geindex Py_UNICODE_IS_LOW_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_IS_LOW_SURROGATE}@anchor{4ff2}
@deffn {C Função} int Py_UNICODE_IS_LOW_SURROGATE (Py_UCS4 ch)

Check if `ch' is a low surrogate (@code{0xDC00 <= ch <= 0xDFFF}).
@end deffn

@geindex Py_UNICODE_HIGH_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_HIGH_SURROGATE}@anchor{4ff3}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_HIGH_SURROGATE (Py_UCS4 ch)

Return the high UTF-16 surrogate (@code{0xD800} to @code{0xDBFF}) for a Unicode
code point in the range @code{[0x10000; 0x10FFFF]}.
@end deffn

@geindex Py_UNICODE_LOW_SURROGATE (C function)
@anchor{c-api/unicode c Py_UNICODE_LOW_SURROGATE}@anchor{4ff4}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_LOW_SURROGATE (Py_UCS4 ch)

Return the low UTF-16 surrogate (@code{0xDC00} to @code{0xDFFF}) for a Unicode
code point in the range @code{[0x10000; 0x10FFFF]}.
@end deffn

@geindex Py_UNICODE_JOIN_SURROGATES (C function)
@anchor{c-api/unicode c Py_UNICODE_JOIN_SURROGATES}@anchor{4ff5}
@deffn {C Função} @ref{29b,,Py_UCS4} Py_UNICODE_JOIN_SURROGATES (Py_UCS4 high, Py_UCS4 low)

Join two surrogate code points and return a single @ref{29b,,Py_UCS4} value.
`high' and `low' are respectively the leading and trailing surrogates in a
surrogate pair. `high' must be in the range @code{[0xD800; 0xDBFF]} and `low' must
be in the range @code{[0xDC00; 0xDFFF]}.
@end deffn

@node Creating and accessing Unicode strings,Locale Encoding,Propriedade de caracteres Unicode,Objetos Unicode
@anchor{c-api/unicode creating-and-accessing-unicode-strings}@anchor{4ff6}
@subsubsection Creating and accessing Unicode strings


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

@geindex PyUnicode_New (C function)
@anchor{c-api/unicode c PyUnicode_New}@anchor{8b0}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_New (Py_ssize_t size, Py_UCS4 maxchar)
`Retorna valor: Nova referência.'
Create a new Unicode object.  `maxchar' should be the true maximum code point
to be placed in the string.  As an approximation, it can be rounded up to the
nearest value in the sequence 127, 255, 65535, 1114111.

This is the recommended way to allocate a new Unicode object.  Objects
created using this function are not resizable.

On error, set an exception and return @code{NULL}.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_FromKindAndData (C function)
@anchor{c-api/unicode c PyUnicode_FromKindAndData}@anchor{11b6}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromKindAndData (int kind, const void *buffer, Py_ssize_t size)
`Retorna valor: Nova referência.'
Cria um novo objeto Unicode com o tipo `type' fornecido (os valores possíveis são @ref{11bd,,PyUnicode_1BYTE_KIND} etc., conforme retornado por @ref{11bc,,PyUnicode_KIND()}). O `buffer' deve apontar para um array de unidades com `size' de 1, 2 ou 4 bytes por caractere, conforme fornecido pelo tipo.

If necessary, the input `buffer' is copied and transformed into the
canonical representation.  For example, if the `buffer' is a UCS4 string
(@ref{11bf,,PyUnicode_4BYTE_KIND}) and it consists only of codepoints in
the UCS1 range, it will be transformed into UCS1
(@ref{11bd,,PyUnicode_1BYTE_KIND}).


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_FromStringAndSize (C function)
@anchor{c-api/unicode c PyUnicode_FromStringAndSize}@anchor{4db2}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromStringAndSize (const char *str, Py_ssize_t size)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Create a Unicode object from the char buffer `str'.  The bytes will be
interpreted as being UTF-8 encoded.  The buffer is copied into the new
object.
The return value might be a shared object, i.e. modification of the data is
not allowed.

This function raises @ref{575,,SystemError} when:


@itemize *

@item 
`size' < 0,

@item 
`str' is @code{NULL} and `size' > 0
@end itemize


Alterado na versão 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{4db1}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromString (const char *str)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{38a}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromFormat (const char *format, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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.

Um especificador de conversão contém dois ou mais caracteres e tem os seguintes componentes, que devem aparecer nesta ordem:


@enumerate 

@item 
O caractere @code{'%'}, que determina o início do especificador.

@item 
Flags de conversão (opcional), que afetam o resultado de alguns tipos de conversão.

@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 
Modificador de comprimento (opcional).

@item 
Tipo de conversão.
@end enumerate

Os caracteres flags de conversão são:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@item

@code{0}

@tab

A conversão será preenchida por zeros para valores numéricos.

@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

Tipos

@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

Comentário

@item

@code{%}

@tab

`n/d'

@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

Uma matriz de caracteres C com terminação nula.

@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{339,,PyObject}*

@tab

The result of calling @ref{142d,,ascii()}.

@item

@code{U}

@tab

@ref{339,,PyObject}*

@tab

A Unicode object.

@item

@code{V}

@tab

@ref{339,,PyObject}*, const char* or const wchar_t*

@tab

A Unicode object (which may be @code{NULL}) and a null-terminated
C character array as a second parameter (which will be used,
if the first parameter is @code{NULL}).

@item

@code{S}

@tab

@ref{339,,PyObject}*

@tab

The result of calling @ref{1068,,PyObject_Str()}.

@item

@code{R}

@tab

@ref{339,,PyObject}*

@tab

The result of calling @ref{1067,,PyObject_Repr()}.

@item

@code{T}

@tab

@ref{339,,PyObject}*

@tab

Get the fully qualified name of an object type;
call @ref{373,,PyType_GetFullyQualifiedName()}.

@item

@code{#T}

@tab

@ref{339,,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{ab4,,PyTypeObject}*

@tab

Get the fully qualified name of a type;
call @ref{373,,PyType_GetFullyQualifiedName()}.

@item

@code{#N}

@tab

@ref{ab4,,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


Alterado na versão 3.2: Suporte adicionado para @code{"%lld"} e @code{"%llu"}.



Alterado na versão 3.3: Support for @code{"%li"}, @code{"%lli"} and @code{"%zi"} added.



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



Alterado na versão 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{575,,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.



Alterado na versão 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{574}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromFormatV (const char *format, va_list vargs)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Identical to @ref{38a,,PyUnicode_FromFormat()} except that it takes exactly two
arguments.
@end deffn

@geindex PyUnicode_FromObject (C function)
@anchor{c-api/unicode c PyUnicode_FromObject}@anchor{4daf}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromObject (PyObject *obj)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Copy an instance of a Unicode subtype to a new true Unicode object if
necessary. If `obj' is already a true Unicode object (not a subtype),
return a new @ref{33d,,strong reference} to the object.

Objects other than Unicode or its subtypes will cause a @ref{2c3,,TypeError}.
@end deffn

@geindex PyUnicode_FromOrdinal (C function)
@anchor{c-api/unicode c PyUnicode_FromOrdinal}@anchor{4db0}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromOrdinal (int ordinal)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Create a Unicode Object from the given Unicode code point `ordinal'.

The ordinal must be in @code{range(0x110000)}. A @ref{202,,ValueError} is
raised in the case it is not.
@end deffn

@geindex PyUnicode_FromEncodedObject (C function)
@anchor{c-api/unicode c PyUnicode_FromEncodedObject}@anchor{4dae}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromEncodedObject (PyObject *obj, const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Decode an encoded object `obj' to a Unicode object.

@ref{1c2,,bytes}, @ref{2ea,,bytearray} and other
@ref{d4f,,bytes-like objects}
are decoded according to the given `encoding' and using the error handling
defined by `errors'. Both can be @code{NULL} to have the interface use the default
values (see @ref{4ff7,,Built-in Codecs} for details).

All other objects, including Unicode objects, cause a @ref{2c3,,TypeError} to be
set.

The API returns @code{NULL} if there was an error.  The caller is responsible for
decref’ing the returned objects.
@end deffn

@geindex PyUnicode_BuildEncodingMap (C function)
@anchor{c-api/unicode c PyUnicode_BuildEncodingMap}@anchor{17e4}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_BuildEncodingMap (PyObject *string)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return a mapping suitable for decoding a custom single-byte encoding.
Given a Unicode string `string' of up to 256 characters representing an encoding
table, returns either a compact internal mapping object or a dictionary
mapping character ordinals to byte values. Raises a @ref{2c3,,TypeError} and
return @code{NULL} on invalid input.
.. versionadded:: 3.2
@end deffn

@geindex PyUnicode_GetDefaultEncoding (C function)
@anchor{c-api/unicode c PyUnicode_GetDefaultEncoding}@anchor{4db3}
@deffn {C Função} const char *PyUnicode_GetDefaultEncoding (void)
` Parte da @ref{553,,ABI Estável}.'
Return the name of the default string encoding, @code{"utf-8"}.
See @ref{45b9,,sys.getdefaultencoding()}.

The returned string does not need to be freed, and is valid
until interpreter shutdown.
@end deffn

@geindex PyUnicode_GetLength (C function)
@anchor{c-api/unicode c PyUnicode_GetLength}@anchor{8b8}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_GetLength (PyObject *unicode)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return the length of the Unicode object, in code points.

On error, set an exception and return @code{-1}.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_CopyCharacters (C function)
@anchor{c-api/unicode c PyUnicode_CopyCharacters}@anchor{8ba}
@deffn {C Função} @ref{a69,,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.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_Fill (C function)
@anchor{c-api/unicode c PyUnicode_Fill}@anchor{11cc}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_Fill (PyObject *unicode, Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)

Fill a string with a character: write `fill_char' into
@code{unicode[start:start+length]}.

Fail if `fill_char' is bigger than the string maximum character, or if the
string has more than 1 reference.

Return the number of written character, or return @code{-1} and raise an
exception on error.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_WriteChar (C function)
@anchor{c-api/unicode c PyUnicode_WriteChar}@anchor{11b1}
@deffn {C Função} int PyUnicode_WriteChar (PyObject *unicode, Py_ssize_t index, Py_UCS4 character)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Write a character to a string.  The string must have been created through
@ref{8b0,,PyUnicode_New()}.  Since Unicode strings are supposed to be immutable,
the string must not be shared, or have been hashed yet.

This function checks that `unicode' is a Unicode object, that the index is
not out of bounds, and that the object can be modified safely (i.e. that it
its reference count is one).

Return @code{0} on success, @code{-1} on error with an exception set.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_ReadChar (C function)
@anchor{c-api/unicode c PyUnicode_ReadChar}@anchor{11b0}
@deffn {C Função} @ref{29b,,Py_UCS4} PyUnicode_ReadChar (PyObject *unicode, Py_ssize_t index)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Read a character from a string.  This function checks that `unicode' is a
Unicode object and the index is not out of bounds, in contrast to
@ref{11c1,,PyUnicode_READ_CHAR()}, which performs no error checking.

Return character on success, @code{-1} on error with an exception set.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_Substring (C function)
@anchor{c-api/unicode c PyUnicode_Substring}@anchor{8bb}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Substring (PyObject *unicode, Py_ssize_t start, Py_ssize_t end)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return a substring of `unicode', from character index `start' (included) to
character index `end' (excluded).  Negative indices are not supported.
On error, set an exception and return @code{NULL}.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_AsUCS4 (C function)
@anchor{c-api/unicode c PyUnicode_AsUCS4}@anchor{11b7}
@deffn {C Função} @ref{29b,,Py_UCS4} *PyUnicode_AsUCS4 (PyObject *unicode, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Copy the string `unicode' into a UCS4 buffer, including a null character, if
`copy_null' is set.  Returns @code{NULL} and sets an exception on error (in
particular, a @ref{575,,SystemError} if `buflen' is smaller than the length of
`unicode').  `buffer' is returned on success.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_AsUCS4Copy (C function)
@anchor{c-api/unicode c PyUnicode_AsUCS4Copy}@anchor{8c0}
@deffn {C Função} @ref{29b,,Py_UCS4} *PyUnicode_AsUCS4Copy (PyObject *unicode)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Copy the string `unicode' into a new UCS4 buffer that is allocated using
@ref{c81,,PyMem_Malloc()}.  If this fails, @code{NULL} is returned with a
@ref{15c5,,MemoryError} set.  The returned buffer always has an extra
null code point appended.


Adicionado na versão 3.3.

@end deffn

@node Locale Encoding,File System Encoding,Creating and accessing Unicode strings,Objetos Unicode
@anchor{c-api/unicode locale-encoding}@anchor{4ff8}
@subsubsection Locale Encoding


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

@geindex PyUnicode_DecodeLocaleAndSize (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLocaleAndSize}@anchor{be2}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeLocaleAndSize (const char *str, Py_ssize_t length, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Decode a string from UTF-8 on Android and VxWorks, or from the current
locale encoding on other platforms. The supported
error handlers are @code{"strict"} and @code{"surrogateescape"}
(
@geindex Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). The decoder uses @code{"strict"} error handler if
`errors' is @code{NULL}.  `str' must end with a null character but
cannot contain embedded null characters.

Use @ref{4d9e,,PyUnicode_DecodeFSDefaultAndSize()} to decode a string from
the @ref{53b,,filesystem encoding and error handler}.

This function ignores the @ref{656,,Python UTF-8 Mode}.


@subsubheading Ver também


The @ref{be0,,Py_DecodeLocale()} function.



Adicionado na versão 3.3.



Alterado na versão 3.7: The function now also uses the current locale encoding for the
@code{surrogateescape} error handler, except on Android. Previously, @ref{be0,,Py_DecodeLocale()}
was used for the @code{surrogateescape}, and the current locale encoding was
used for @code{strict}.

@end deffn

@geindex PyUnicode_DecodeLocale (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLocale}@anchor{4da0}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeLocale (const char *str, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Similar to @ref{be2,,PyUnicode_DecodeLocaleAndSize()}, but compute the string
length using @code{strlen()}.


Adicionado na versão 3.3.

@end deffn

@geindex PyUnicode_EncodeLocale (C function)
@anchor{c-api/unicode c PyUnicode_EncodeLocale}@anchor{be3}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_EncodeLocale (PyObject *unicode, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Encode a Unicode object to UTF-8 on Android and VxWorks, or to the current
locale encoding on other platforms. The
supported error handlers are @code{"strict"} and @code{"surrogateescape"}
(
@geindex Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}). The encoder uses @code{"strict"} error handler if
`errors' is @code{NULL}. Return a @ref{1c2,,bytes} object. `unicode' cannot
contain embedded null characters.

Use @ref{1bca,,PyUnicode_EncodeFSDefault()} to encode a string to the
@ref{53b,,filesystem encoding and error handler}.

This function ignores the @ref{656,,Python UTF-8 Mode}.


@subsubheading Ver também


The @ref{be1,,Py_EncodeLocale()} function.



Adicionado na versão 3.3.



Alterado na versão 3.7: The function now also uses the current locale encoding for the
@code{surrogateescape} error handler, except on Android. Previously,
@ref{be1,,Py_EncodeLocale()}
was used for the @code{surrogateescape}, and the current locale encoding was
used for @code{strict}.

@end deffn

@node File System Encoding,wchar_t Support,Locale Encoding,Objetos Unicode
@anchor{c-api/unicode file-system-encoding}@anchor{4ff9}
@subsubsection File System Encoding


Functions encoding to and decoding from the @ref{53b,,filesystem encoding and error handler} (
@geindex Propostas de Melhorias do Python; PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} and 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}).

To encode file names to @ref{1c2,,bytes} during argument parsing, the @code{"O&"}
converter should be used, passing @code{PyUnicode_FSConverter()} as the
conversion function:

@geindex PyUnicode_FSConverter (C function)
@anchor{c-api/unicode c PyUnicode_FSConverter}@anchor{d3b}
@deffn {C Função} int PyUnicode_FSConverter (PyObject *obj, void *result)
` Parte da @ref{553,,ABI Estável}.'
@ref{8ad,,PyArg_Parse* converter}: encode @ref{44c,,str} objects – obtained directly or
through the @ref{c6c,,os.PathLike} interface – to @ref{1c2,,bytes} using
@ref{1bca,,PyUnicode_EncodeFSDefault()}; @ref{1c2,,bytes} objects are output as-is.
`result' must be an address of a C variable of type @ref{339,,PyObject}*
(or @ref{792,,PyBytesObject}*).
On success, set the variable to a new @ref{33d,,strong reference} to
a @ref{4fc8,,bytes object} which must be released
when it is no longer used and return a non-zero value
(@ref{4ec8,,Py_CLEANUP_SUPPORTED}).
Embedded null bytes are not allowed in the result.
On failure, return @code{0} with an exception set.

If `obj' is @code{NULL}, the function releases a strong reference
stored in the variable referred by `result' and returns @code{1}.


Adicionado na versão 3.1.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

To decode file names to @ref{44c,,str} during argument parsing, the @code{"O&"}
converter should be used, passing @code{PyUnicode_FSDecoder()} as the
conversion function:

@geindex PyUnicode_FSDecoder (C function)
@anchor{c-api/unicode c PyUnicode_FSDecoder}@anchor{577}
@deffn {C Função} int PyUnicode_FSDecoder (PyObject *obj, void *result)
` Parte da @ref{553,,ABI Estável}.'
@ref{8ad,,PyArg_Parse* converter}: decode @ref{1c2,,bytes} objects – obtained either
directly or indirectly through the @ref{c6c,,os.PathLike} interface – to
@ref{44c,,str} using @ref{4d9e,,PyUnicode_DecodeFSDefaultAndSize()}; @ref{44c,,str}
objects are output as-is.
`result' must be an address of a C variable of type @ref{339,,PyObject}*
(or @ref{794,,PyUnicodeObject}*).
On success, set the variable to a new @ref{33d,,strong reference} to
a @ref{4fda,,Unicode object} which must be released
when it is no longer used and return a non-zero value
(@ref{4ec8,,Py_CLEANUP_SUPPORTED}).
Embedded null characters are not allowed in the result.
On failure, return @code{0} with an exception set.

If `obj' is @code{NULL}, release the strong reference
to the object referred to by `result' and return @code{1}.


Adicionado na versão 3.2.



Alterado na versão 3.6: Aceita um @ref{2a0,,objeto caminho ou similar}.

@end deffn

@geindex PyUnicode_DecodeFSDefaultAndSize (C function)
@anchor{c-api/unicode c PyUnicode_DecodeFSDefaultAndSize}@anchor{4d9e}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeFSDefaultAndSize (const char *str, Py_ssize_t size)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Decode a string from the @ref{53b,,filesystem encoding and error handler}.

If you need to decode a string from the current locale encoding, use
@ref{be2,,PyUnicode_DecodeLocaleAndSize()}.


@subsubheading Ver também


The @ref{be0,,Py_DecodeLocale()} function.



Alterado na versão 3.6: The @ref{53b,,filesystem error handler} is now used.

@end deffn

@geindex PyUnicode_DecodeFSDefault (C function)
@anchor{c-api/unicode c PyUnicode_DecodeFSDefault}@anchor{180a}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeFSDefault (const char *str)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Decode a null-terminated string from the @ref{53b,,filesystem encoding and error handler}.

If the string length is known, use
@ref{4d9e,,PyUnicode_DecodeFSDefaultAndSize()}.


Alterado na versão 3.6: The @ref{53b,,filesystem error handler} is now used.

@end deffn

@geindex PyUnicode_EncodeFSDefault (C function)
@anchor{c-api/unicode c PyUnicode_EncodeFSDefault}@anchor{1bca}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_EncodeFSDefault (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object to the @ref{53b,,filesystem encoding and error handler}, and return @ref{1c2,,bytes}. Note that the resulting @ref{1c2,,bytes}
object can contain null bytes.

If you need to encode a string to the current locale encoding, use
@ref{be3,,PyUnicode_EncodeLocale()}.


@subsubheading Ver também


The @ref{be1,,Py_EncodeLocale()} function.



Adicionado na versão 3.2.



Alterado na versão 3.6: The @ref{53b,,filesystem error handler} is now used.

@end deffn

@node wchar_t Support,,File System Encoding,Objetos Unicode
@anchor{c-api/unicode wchar-t-support}@anchor{4ffa}
@subsubsection wchar_t Support


@code{wchar_t} support for platforms which support it:

@geindex PyUnicode_FromWideChar (C function)
@anchor{c-api/unicode c PyUnicode_FromWideChar}@anchor{11cb}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_FromWideChar (const wchar_t *wstr, Py_ssize_t size)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{1bd1}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_AsWideChar (PyObject *unicode, wchar_t *wstr, Py_ssize_t size)
` Parte da @ref{553,,ABI Estável}.'
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{8c1}
@deffn {C Função} wchar_t *PyUnicode_AsWideCharString (PyObject *unicode, Py_ssize_t *size)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Convert the Unicode object to a wide character string. The output string
always ends with a null character. If `size' is not @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{202,,ValueError} is raised.

Returns a buffer allocated by @ref{156d,,PyMem_New} (use
@ref{148a,,PyMem_Free()} to free it) on success. On error, returns @code{NULL}
and `*size' is undefined. Raises a @ref{15c5,,MemoryError} if memory allocation
is failed.


Adicionado na versão 3.2.



Alterado na versão 3.7: Raises a @ref{202,,ValueError} if `size' is @code{NULL} and the wchar_t*
string contains null characters.

@end deffn

@node Built-in Codecs,Methods and Slot Functions,Objetos Unicode,Objetos Unicode e Codecs
@anchor{c-api/unicode built-in-codecs}@anchor{4ffb}@anchor{c-api/unicode builtincodecs}@anchor{4ff7}
@subsubsection Built-in Codecs


Python provides a set of built-in codecs which are written in C for speed. All of
these codecs are directly usable via the following functions.

Many of the following APIs take two arguments encoding and errors, and they
have the same semantics as the ones of the built-in @ref{44c,,str()} string object
constructor.

Setting encoding to @code{NULL} causes the default encoding to be used
which is UTF-8.  The file system calls should use
@ref{d3b,,PyUnicode_FSConverter()} for encoding file names. This uses the
@ref{53b,,filesystem encoding and error handler} internally.

Error handling is set by errors which may also be set to @code{NULL} meaning to use
the default handling defined for the codec.  Default error handling for all
built-in codecs is “strict” (@ref{202,,ValueError} is raised).

The codecs all use a similar interface.  Only deviations from the following
generic ones are documented for simplicity.

@menu
* Generic Codecs:: 
* UTF-8 Codecs:: 
* UTF-32 Codecs:: 
* UTF-16 Codecs:: 
* UTF-7 Codecs:: 
* Unicode-Escape Codecs:: 
* Raw-Unicode-Escape Codecs:: 
* Latin-1 Codecs:: 
* ASCII Codecs:: 
* Character Map Codecs:: 
* MBCS codecs for Windows:: 

@end menu

@node Generic Codecs,UTF-8 Codecs,,Built-in Codecs
@anchor{c-api/unicode generic-codecs}@anchor{4ffc}
@subsubsection Generic Codecs


These are the generic codec APIs:

@geindex PyUnicode_Decode (C function)
@anchor{c-api/unicode c PyUnicode_Decode}@anchor{1b59}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Decode (const char *str, Py_ssize_t size, const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Create a Unicode object by decoding `size' bytes of the encoded string `str'.
`encoding' and `errors' have the same meaning as the parameters of the same name
in the @ref{44c,,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{4d96}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsEncodedString (PyObject *unicode, const char *encoding, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object and return the result as Python bytes object.
`encoding' and `errors' have the same meaning as the parameters of the same
name in the Unicode @ref{8db,,encode()} method. 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

@node UTF-8 Codecs,UTF-32 Codecs,Generic Codecs,Built-in Codecs
@anchor{c-api/unicode utf-8-codecs}@anchor{4ffd}
@subsubsection UTF-8 Codecs


These are the UTF-8 codec APIs:

@geindex PyUnicode_DecodeUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF8}@anchor{4daa}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF8 (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{189f}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF8Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
If `consumed' is @code{NULL}, behave like @ref{4daa,,PyUnicode_DecodeUTF8()}. If
`consumed' is not @code{NULL}, trailing incomplete UTF-8 byte sequences will not be
treated as an error. Those bytes will not be decoded and the number of bytes
that have been decoded will be stored in `consumed'.
@end deffn

@geindex PyUnicode_AsUTF8String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF8String}@anchor{11cd}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsUTF8String (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using UTF-8 and return the result as Python bytes
object.  Error handling is “strict”.  Return @code{NULL} if an exception was
raised by the codec.

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{89d}
@deffn {C Função} const char *PyUnicode_AsUTF8AndSize (PyObject *unicode, Py_ssize_t *size)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Return a pointer to the UTF-8 encoding of the Unicode object, and
store the size of the encoded representation (in bytes) in `size'.  The
`size' argument can be @code{NULL}; in this case no size will be stored.  The
returned buffer always has an extra null byte appended (not included in
`size'), regardless of whether there are any other null code points.

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.


Adicionado na versão 3.3.



Alterado na versão 3.7: The return type is now @code{const char *} rather of @code{char *}.



Alterado na versão 3.10: This function is a part of the @ref{396,,limited API}.

@end deffn

@geindex PyUnicode_AsUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF8}@anchor{bd4}
@deffn {C Função} const char *PyUnicode_AsUTF8 (PyObject *unicode)

As @ref{89d,,PyUnicode_AsUTF8AndSize()}, but does not store the size.

@cartouche
@quotation Aviso 
This function does not have any special behavior for
null characters@footnote{https://en.wikipedia.org/wiki/Null_character} embedded within
`unicode'. As a result, strings containing null characters will remain in the returned
string, which some C functions might interpret as the end of the string, leading to
truncation. If truncation is an issue, it is recommended to use @ref{89d,,PyUnicode_AsUTF8AndSize()}
instead.
@end quotation
@end cartouche


Adicionado na versão 3.3.



Alterado na versão 3.7: The return type is now @code{const char *} rather of @code{char *}.

@end deffn

@node UTF-32 Codecs,UTF-16 Codecs,UTF-8 Codecs,Built-in Codecs
@anchor{c-api/unicode utf-32-codecs}@anchor{4ffe}
@subsubsection UTF-32 Codecs


These are the UTF-32 codec APIs:

@geindex PyUnicode_DecodeUTF32 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF32}@anchor{4da6}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF32 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Decode `size' bytes from a UTF-32 encoded buffer string and return the
corresponding Unicode object.  `errors' (if non-@code{NULL}) defines the error
handling. It defaults to “strict”.

If `byteorder' is non-@code{NULL}, the decoder starts decoding using the given byte
order:

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

If @code{*byteorder} is zero, and the first four bytes of the input data are a
byte order mark (BOM), the decoder switches to this byte order and the BOM is
not copied into the resulting Unicode string.  If @code{*byteorder} is @code{-1} or
@code{1}, any byte order mark is copied to the output.

After completion, `*byteorder' is set to the current byte order at the end
of input data.

If `byteorder' is @code{NULL}, the codec starts in native order mode.

Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_DecodeUTF32Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF32Stateful}@anchor{4da7}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF32Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
If `consumed' is @code{NULL}, behave like @ref{4da6,,PyUnicode_DecodeUTF32()}. If
`consumed' is not @code{NULL}, @ref{4da7,,PyUnicode_DecodeUTF32Stateful()} will not treat
trailing incomplete UTF-32 byte sequences (such as a number of bytes not divisible
by four) as an error. Those bytes will not be decoded and the number of bytes
that have been decoded will be stored in `consumed'.
@end deffn

@geindex PyUnicode_AsUTF32String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF32String}@anchor{4d98}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsUTF32String (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return a Python byte string using the UTF-32 encoding in native byte
order. The string always starts with a BOM mark.  Error handling is “strict”.
Return @code{NULL} if an exception was raised by the codec.
@end deffn

@node UTF-16 Codecs,UTF-7 Codecs,UTF-32 Codecs,Built-in Codecs
@anchor{c-api/unicode utf-16-codecs}@anchor{4fff}
@subsubsection UTF-16 Codecs


These are the UTF-16 codec APIs:

@geindex PyUnicode_DecodeUTF16 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF16}@anchor{4da4}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF16 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Decode `size' bytes from a UTF-16 encoded buffer string and return the
corresponding Unicode object.  `errors' (if non-@code{NULL}) defines the error
handling. It defaults to “strict”.

If `byteorder' is non-@code{NULL}, the decoder starts decoding using the given byte
order:

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

If @code{*byteorder} is zero, and the first two bytes of the input data are a
byte order mark (BOM), the decoder switches to this byte order and the BOM is
not copied into the resulting Unicode string.  If @code{*byteorder} is @code{-1} or
@code{1}, any byte order mark is copied to the output (where it will result in
either a @code{\ufeff} or a @code{\ufffe} character).

After completion, @code{*byteorder} is set to the current byte order at the end
of input data.

If `byteorder' is @code{NULL}, the codec starts in native order mode.

Return @code{NULL} if an exception was raised by the codec.
@end deffn

@geindex PyUnicode_DecodeUTF16Stateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF16Stateful}@anchor{4da5}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF16Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
If `consumed' is @code{NULL}, behave like @ref{4da4,,PyUnicode_DecodeUTF16()}. If
`consumed' is not @code{NULL}, @ref{4da5,,PyUnicode_DecodeUTF16Stateful()} will not treat
trailing incomplete UTF-16 byte sequences (such as an odd number of bytes or a
split surrogate pair) as an error. Those bytes will not be decoded and the
number of bytes that have been decoded will be stored in `consumed'.
@end deffn

@geindex PyUnicode_AsUTF16String (C function)
@anchor{c-api/unicode c PyUnicode_AsUTF16String}@anchor{4d97}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsUTF16String (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return a Python byte string using the UTF-16 encoding in native byte
order. The string always starts with a BOM mark.  Error handling is “strict”.
Return @code{NULL} if an exception was raised by the codec.
@end deffn

@node UTF-7 Codecs,Unicode-Escape Codecs,UTF-16 Codecs,Built-in Codecs
@anchor{c-api/unicode utf-7-codecs}@anchor{5000}
@subsubsection UTF-7 Codecs


These are the UTF-7 codec APIs:

@geindex PyUnicode_DecodeUTF7 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUTF7}@anchor{4da8}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF7 (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{4da9}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUTF7Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
If `consumed' is @code{NULL}, behave like @ref{4da8,,PyUnicode_DecodeUTF7()}.  If
`consumed' is not @code{NULL}, trailing incomplete UTF-7 base-64 sections will not
be treated as an error.  Those bytes will not be decoded and the number of
bytes that have been decoded will be stored in `consumed'.
@end deffn

@node Unicode-Escape Codecs,Raw-Unicode-Escape Codecs,UTF-7 Codecs,Built-in Codecs
@anchor{c-api/unicode unicode-escape-codecs}@anchor{5001}
@subsubsection Unicode-Escape Codecs


These are the “Unicode Escape” codec APIs:

@geindex PyUnicode_DecodeUnicodeEscape (C function)
@anchor{c-api/unicode c PyUnicode_DecodeUnicodeEscape}@anchor{4dab}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{11ce}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsUnicodeEscapeString (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using Unicode-Escape and return the result as a
bytes object.  Error handling is “strict”.  Return @code{NULL} if an exception was
raised by the codec.
@end deffn

@node Raw-Unicode-Escape Codecs,Latin-1 Codecs,Unicode-Escape Codecs,Built-in Codecs
@anchor{c-api/unicode raw-unicode-escape-codecs}@anchor{5002}
@subsubsection Raw-Unicode-Escape Codecs


These are the “Raw Unicode Escape” codec APIs:

@geindex PyUnicode_DecodeRawUnicodeEscape (C function)
@anchor{c-api/unicode c PyUnicode_DecodeRawUnicodeEscape}@anchor{4da3}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeRawUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{11cf}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsRawUnicodeEscapeString (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using Raw-Unicode-Escape and return the result as
a bytes object.  Error handling is “strict”.  Return @code{NULL} if an exception
was raised by the codec.
@end deffn

@node Latin-1 Codecs,ASCII Codecs,Raw-Unicode-Escape Codecs,Built-in Codecs
@anchor{c-api/unicode latin-1-codecs}@anchor{5003}
@subsubsection Latin-1 Codecs


These are the Latin-1 codec APIs: Latin-1 corresponds to the first 256 Unicode
ordinals and only these are accepted by the codecs during encoding.

@geindex PyUnicode_DecodeLatin1 (C function)
@anchor{c-api/unicode c PyUnicode_DecodeLatin1}@anchor{4d9f}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeLatin1 (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{11d0}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsLatin1String (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using Latin-1 and return the result as Python bytes
object.  Error handling is “strict”.  Return @code{NULL} if an exception was
raised by the codec.
@end deffn

@node ASCII Codecs,Character Map Codecs,Latin-1 Codecs,Built-in Codecs
@anchor{c-api/unicode ascii-codecs}@anchor{5004}
@subsubsection ASCII Codecs


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

@geindex PyUnicode_DecodeASCII (C function)
@anchor{c-api/unicode c PyUnicode_DecodeASCII}@anchor{4d9b}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeASCII (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{11d1}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsASCIIString (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using ASCII and return the result as Python bytes
object.  Error handling is “strict”.  Return @code{NULL} if an exception was
raised by the codec.
@end deffn

@node Character Map Codecs,MBCS codecs for Windows,ASCII Codecs,Built-in Codecs
@anchor{c-api/unicode character-map-codecs}@anchor{5005}
@subsubsection Character Map Codecs


This codec is special in that it can be used to implement many different codecs
(and this is in fact what was done to obtain most of the standard codecs
included in the @code{encodings} package). The codec uses mappings to encode and
decode characters.  The mapping objects provided must support the
@ref{283,,__getitem__()} mapping interface; dictionaries and sequences work well.

These are the mapping codec APIs:

@geindex PyUnicode_DecodeCharmap (C function)
@anchor{c-api/unicode c PyUnicode_DecodeCharmap}@anchor{4d9c}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeCharmap (const char *str, Py_ssize_t length, PyObject *mapping, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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.

If `mapping' is @code{NULL}, Latin-1 decoding will be applied.  Else
`mapping' must map bytes ordinals (integers in the range from 0 to 255)
to Unicode strings, integers (which are then interpreted as Unicode
ordinals) or @code{None}.  Unmapped data bytes – ones which cause a
@ref{2367,,LookupError}, as well as ones which get mapped to @code{None},
@code{0xFFFE} or @code{'\ufffe'}, are treated as undefined mappings and cause
an error.
@end deffn

@geindex PyUnicode_AsCharmapString (C function)
@anchor{c-api/unicode c PyUnicode_AsCharmapString}@anchor{4d95}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsCharmapString (PyObject *unicode, PyObject *mapping)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Encode a Unicode object using the given `mapping' object and return the
result as a bytes object.  Error handling is “strict”.  Return @code{NULL} if an
exception was raised by the codec.

The `mapping' object must map Unicode ordinal integers to bytes objects,
integers in the range from 0 to 255 or @code{None}.  Unmapped character
ordinals (ones which cause a @ref{2367,,LookupError}) as well as mapped to
@code{None} are treated as “undefined mapping” and cause an error.
@end deffn

The following codec API is special in that maps Unicode to Unicode.

@geindex PyUnicode_Translate (C function)
@anchor{c-api/unicode c PyUnicode_Translate}@anchor{4db8}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Translate (PyObject *unicode, PyObject *table, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Translate a string by applying a character mapping table to it and return the
resulting Unicode object. Return @code{NULL} if an exception was raised by the
codec.

The mapping table must map Unicode ordinal integers to Unicode ordinal integers
or @code{None} (causing deletion of the character).

Mapping tables need only provide the @ref{283,,__getitem__()} interface; dictionaries
and sequences work well.  Unmapped character ordinals (ones which cause a
@ref{2367,,LookupError}) are left untouched and are copied as-is.

`errors' has the usual meaning for codecs. It may be @code{NULL} which indicates to
use the default error handling.
@end deffn

@node MBCS codecs for Windows,,Character Map Codecs,Built-in Codecs
@anchor{c-api/unicode mbcs-codecs-for-windows}@anchor{5006}
@subsubsection MBCS codecs for Windows


These are the MBCS codec APIs. They are currently only available on Windows and
use the Win32 MBCS converters to implement the conversions.  Note that MBCS (or
DBCS) is a class of encodings, not just one.  The target encoding is defined by
the user settings on the machine running the codec.

@geindex PyUnicode_DecodeMBCS (C function)
@anchor{c-api/unicode c PyUnicode_DecodeMBCS}@anchor{4da1}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeMBCS (const char *str, Py_ssize_t size, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Create a Unicode object by decoding `size' bytes of the MBCS encoded string `str'.
Return @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{4da2}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeMBCSStateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
If `consumed' is @code{NULL}, behave like @ref{4da1,,PyUnicode_DecodeMBCS()}. If
`consumed' is not @code{NULL}, @ref{4da2,,PyUnicode_DecodeMBCSStateful()} will not decode
trailing lead byte and the number of bytes that have been decoded will be stored
in `consumed'.
@end deffn

@geindex PyUnicode_DecodeCodePageStateful (C function)
@anchor{c-api/unicode c PyUnicode_DecodeCodePageStateful}@anchor{4d9d}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_DecodeCodePageStateful (int code_page, const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Similar to @ref{4da2,,PyUnicode_DecodeMBCSStateful()}, except uses the code page
specified by `code_page'.
@end deffn

@geindex PyUnicode_AsMBCSString (C function)
@anchor{c-api/unicode c PyUnicode_AsMBCSString}@anchor{11d2}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_AsMBCSString (PyObject *unicode)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Encode a Unicode object using MBCS and return the result as Python bytes
object.  Error handling is “strict”.  Return @code{NULL} if an exception was
raised by the codec.
@end deffn

@geindex PyUnicode_EncodeCodePage (C function)
@anchor{c-api/unicode c PyUnicode_EncodeCodePage}@anchor{11d3}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_EncodeCodePage (int code_page, PyObject *unicode, const char *errors)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} on Windows desde a versão 3.7.'
Encode the Unicode object using the specified code page and return a Python
bytes object.  Return @code{NULL} if an exception was raised by the codec. Use
@code{CP_ACP} code page to get the MBCS encoder.


Adicionado na versão 3.3.

@end deffn

@node Methods and Slot Functions,,Built-in Codecs,Objetos Unicode e Codecs
@anchor{c-api/unicode methods-and-slot-functions}@anchor{5007}@anchor{c-api/unicode unicodemethodsandslots}@anchor{5008}
@subsubsection Methods and Slot Functions


The following APIs are capable of handling Unicode objects and strings on input
(we refer to them as strings in the descriptions) and return Unicode objects or
integers as appropriate.

They all return @code{NULL} or @code{-1} if an exception occurs.

@geindex PyUnicode_Concat (C function)
@anchor{c-api/unicode c PyUnicode_Concat}@anchor{11e0}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Concat (PyObject *left, PyObject *right)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Concat two strings giving a new Unicode string.
@end deffn

@geindex PyUnicode_Split (C function)
@anchor{c-api/unicode c PyUnicode_Split}@anchor{4db6}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Split (PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Split a string giving a list of Unicode strings.  If `sep' is @code{NULL}, splitting
will be done at all whitespace substrings.  Otherwise, splits occur at the given
separator.  At most `maxsplit' splits will be done.  If negative, no limit is
set.  Separators are not included in the resulting list.

On error, return @code{NULL} with an exception set.

Equivalent to @ref{ed9,,str.split()}.
@end deffn

@geindex PyUnicode_RSplit (C function)
@anchor{c-api/unicode c PyUnicode_RSplit}@anchor{1654}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_RSplit (PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Similar to @ref{4db6,,PyUnicode_Split()}, but splitting will be done beginning
at the end of the string.

On error, return @code{NULL} with an exception set.

Equivalent to @ref{1297,,str.rsplit()}.
@end deffn

@geindex PyUnicode_Splitlines (C function)
@anchor{c-api/unicode c PyUnicode_Splitlines}@anchor{4db7}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Splitlines (PyObject *unicode, int keepends)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Split a Unicode string at line breaks, returning a list of Unicode strings.
CRLF is considered to be one line break.  If `keepends' is @code{0}, the Line break
characters are not included in the resulting strings.
@end deffn

@geindex PyUnicode_Partition (C function)
@anchor{c-api/unicode c PyUnicode_Partition}@anchor{1655}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Partition (PyObject *unicode, PyObject *sep)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Split a Unicode string at the first occurrence of `sep', and return
a 3-tuple containing the part before the separator, the separator itself,
and the part after the separator. If the separator is not found,
return a 3-tuple containing the string itself, followed by two empty strings.

`sep' must not be empty.

On error, return @code{NULL} with an exception set.

Equivalent to @ref{eda,,str.partition()}.
@end deffn

@geindex PyUnicode_RPartition (C function)
@anchor{c-api/unicode c PyUnicode_RPartition}@anchor{1656}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_RPartition (PyObject *unicode, PyObject *sep)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Similar to @ref{1655,,PyUnicode_Partition()}, but split a Unicode string at the
last occurrence of `sep'. If the separator is not found, return a 3-tuple
containing two empty strings, followed by the string itself.

`sep' must not be empty.

On error, return @code{NULL} with an exception set.

Equivalent to @ref{129a,,str.rpartition()}.
@end deffn

@geindex PyUnicode_Join (C function)
@anchor{c-api/unicode c PyUnicode_Join}@anchor{11e1}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Join (PyObject *separator, PyObject *seq)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Join a sequence of strings using the given `separator' and return the resulting
Unicode string.
@end deffn

@geindex PyUnicode_Tailmatch (C function)
@anchor{c-api/unicode c PyUnicode_Tailmatch}@anchor{8bd}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_Tailmatch (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` Parte da @ref{553,,ABI Estável}.'
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{4dac}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_Find (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` Parte da @ref{553,,ABI Estável}.'
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{8be}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_FindChar (PyObject *unicode, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)
` Parte da @ref{553,,ABI Estável} desde a versão 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.


Adicionado na versão 3.3.



Alterado na versão 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{4d9a}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnicode_Count (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end)
` Parte da @ref{553,,ABI Estável}.'
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{4db4}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Replace (PyObject *unicode, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
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{8bc}
@deffn {C Função} int PyUnicode_Compare (PyObject *left, PyObject *right)
` Parte da @ref{553,,ABI Estável}.'
Compare two strings and return @code{-1}, @code{0}, @code{1} for less than, equal, and greater than,
respectively.

This function returns @code{-1} upon failure, so one should call
@ref{1a3b,,PyErr_Occurred()} to check for errors.
@end deffn

@geindex PyUnicode_EqualToUTF8AndSize (C function)
@anchor{c-api/unicode c PyUnicode_EqualToUTF8AndSize}@anchor{376}
@deffn {C Função} int PyUnicode_EqualToUTF8AndSize (PyObject *unicode, const char *string, Py_ssize_t size)
` Parte da @ref{553,,ABI Estável} desde a versão 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.

This function does not raise exceptions.


Adicionado na versão 3.13.

@end deffn

@geindex PyUnicode_EqualToUTF8 (C function)
@anchor{c-api/unicode c PyUnicode_EqualToUTF8}@anchor{377}
@deffn {C Função} int PyUnicode_EqualToUTF8 (PyObject *unicode, const char *string)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Similar to @ref{376,,PyUnicode_EqualToUTF8AndSize()}, but compute `string'
length using @code{strlen()}.
If the Unicode object contains null characters, false (@code{0}) is returned.


Adicionado na versão 3.13.

@end deffn

@geindex PyUnicode_CompareWithASCIIString (C function)
@anchor{c-api/unicode c PyUnicode_CompareWithASCIIString}@anchor{12a9}
@deffn {C Função} int PyUnicode_CompareWithASCIIString (PyObject *unicode, const char *string)
` Parte da @ref{553,,ABI Estável}.'
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.

This function does not raise exceptions.
@end deffn

@geindex PyUnicode_RichCompare (C function)
@anchor{c-api/unicode c PyUnicode_RichCompare}@anchor{4db5}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_RichCompare (PyObject *left, PyObject *right, int op)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Rich compare two Unicode strings and return one of the following:


@itemize *

@item 
@code{NULL} in case an exception was raised

@item 
@ref{4f9a,,Py_True} or @ref{4f99,,Py_False} for successful comparisons

@item 
@ref{4f0f,,Py_NotImplemented} in case the type combination is unknown
@end itemize

Possible values for `op' are @ref{4f16,,Py_GT}, @ref{4f17,,Py_GE}, @ref{4f14,,Py_EQ},
@ref{4f15,,Py_NE}, @ref{4f12,,Py_LT}, and @ref{4f13,,Py_LE}.
@end deffn

@geindex PyUnicode_Format (C function)
@anchor{c-api/unicode c PyUnicode_Format}@anchor{4dad}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_Format (PyObject *format, PyObject *args)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Return a new string object from `format' and `args'; this is analogous to
@code{format % args}.
@end deffn

@geindex PyUnicode_Contains (C function)
@anchor{c-api/unicode c PyUnicode_Contains}@anchor{4d99}
@deffn {C Função} int PyUnicode_Contains (PyObject *unicode, PyObject *substr)
` Parte da @ref{553,,ABI Estável}.'
Check whether `substr' is contained in `unicode' and return true or false
accordingly.

`substr' has to coerce to a one element Unicode string. @code{-1} is returned
if there was an error.
@end deffn

@geindex PyUnicode_InternInPlace (C function)
@anchor{c-api/unicode c PyUnicode_InternInPlace}@anchor{8b6}
@deffn {C Função} void PyUnicode_InternInPlace (PyObject **p_unicode)
` Parte da @ref{553,,ABI Estável}.'
Intern the argument *@ref{8b6,,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{8b6,,p_unicode}, it sets *@ref{8b6,,p_unicode} to
it (releasing the reference to the old string object and creating a new
@ref{33d,,strong reference} to the interned string object), otherwise it leaves
*@ref{8b6,,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{44c,,str} may not be interned, that is,
@ref{4fde,,PyUnicode_CheckExact}(*@ref{8b6,,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{16ea}
@deffn {C Função} @ref{339,,PyObject} *PyUnicode_InternFromString (const char *str)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
A combination of @ref{4db1,,PyUnicode_FromString()} and
@ref{8b6,,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{45bb,,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{4db1,,PyUnicode_FromString()} and
@ref{8b6,,PyUnicode_InternInPlace()} directly.
@end deffn

@node Objeto tupla,Objetos sequência de estrutura,Objetos Unicode e Codecs,Objetos Sequência
@anchor{c-api/tuple doc}@anchor{5009}@anchor{c-api/tuple translation-repo}@anchor{500a}@anchor{c-api/tuple tuple-objects}@anchor{500b}@anchor{c-api/tuple tupleobjects}@anchor{500c}
@subsubsection Objeto tupla


@geindex objeto;tupla

@geindex PyTupleObject (C type)
@anchor{c-api/tuple c PyTupleObject}@anchor{4eac}
@deffn {C Tipo} type PyTupleObject

Este subtipo de @ref{339,,PyObject} representa um objeto tupla em Python.
@end deffn

@geindex PyTuple_Type (C var)
@anchor{c-api/tuple c PyTuple_Type}@anchor{4d78}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyTuple_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo tupla de Python; é o mesmo objeto que @ref{370,,tuple} na camada Python.
@end deffn

@geindex PyTuple_Check (C function)
@anchor{c-api/tuple c PyTuple_Check}@anchor{500d}
@deffn {C Função} int PyTuple_Check (PyObject *p)

Retorna verdadeiro se `p' é um objeto tupla ou uma instância de um subtipo do tipo tupla. Esta função sempre tem sucesso.
@end deffn

@geindex PyTuple_CheckExact (C function)
@anchor{c-api/tuple c PyTuple_CheckExact}@anchor{500e}
@deffn {C Função} int PyTuple_CheckExact (PyObject *p)

Retorna verdadeiro se `p' é um objeto tupla, mas não uma instância de um subtipo do tipo tupla. Esta função sempre tem sucesso.
@end deffn

@geindex PyTuple_New (C function)
@anchor{c-api/tuple c PyTuple_New}@anchor{39d}
@deffn {C Função} @ref{339,,PyObject} *PyTuple_New (Py_ssize_t len)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto tupla de tamanho `len', ou @code{NULL} com uma exceção definida em caso de falha.
@end deffn

@geindex PyTuple_Pack (C function)
@anchor{c-api/tuple c PyTuple_Pack}@anchor{4d76}
@deffn {C Função} @ref{339,,PyObject} *PyTuple_Pack (Py_ssize_t n, ...)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto tupla de tamanho `n', ou @code{NULL} com uma exceção em caso de falha. Os valores da tupla são inicializados para os `n' argumentos C subsequentes apontando para objetos Python. @code{`PyTuple_Pack(2, a, b)} é equivalente a @code{Py_BuildValue("(OO)", a, b)}.
@end deffn

@geindex PyTuple_Size (C function)
@anchor{c-api/tuple c PyTuple_Size}@anchor{4d77}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyTuple_Size (PyObject *p)
` Parte da @ref{553,,ABI Estável}.'
Pega um ponteiro para um objeto tupla e retorna o tamanho dessa tupla. No erro, retorna @code{-1} com uma exceção definida.
@end deffn

@geindex PyTuple_GET_SIZE (C function)
@anchor{c-api/tuple c PyTuple_GET_SIZE}@anchor{500f}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyTuple_GET_SIZE (PyObject *p)

Como @ref{4d77,,PyTuple_Size()}, mas sem verificação de erro.
@end deffn

@geindex PyTuple_GetItem (C function)
@anchor{c-api/tuple c PyTuple_GetItem}@anchor{4b61}
@deffn {C Função} @ref{339,,PyObject} *PyTuple_GetItem (PyObject *p, Py_ssize_t pos)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna o objeto na posição `pos' na tupla apontada por `p'. Se `pos' estiver fora dos limites, retorna @code{NULL} e define uma exceção @ref{157e,,IndexError}.

A referência retornada é emprestada da tupla `p' (ou seja: ela só é válida enquanto você mantém uma referência a `p'). Para obter uma @ref{33d,,referência forte}, use @ref{89e,,Py_NewRef(PyTuple_GetItem(...))} ou @ref{1bcd,,PySequence_GetItem()}.
@end deffn

@geindex PyTuple_GET_ITEM (C function)
@anchor{c-api/tuple c PyTuple_GET_ITEM}@anchor{5010}
@deffn {C Função} @ref{339,,PyObject} *PyTuple_GET_ITEM (PyObject *p, Py_ssize_t pos)
`Retorna valor: Referência emprestada.'
Como @ref{4b61,,PyTuple_GetItem()}, mas faz nenhuma verificação de seus argumentos.
@end deffn

@geindex PyTuple_GetSlice (C function)
@anchor{c-api/tuple c PyTuple_GetSlice}@anchor{4d75}
@deffn {C Função} @ref{339,,PyObject} *PyTuple_GetSlice (PyObject *p, Py_ssize_t low, Py_ssize_t high)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna a fatia da tupla apontada por `p' entre `low' e `high', ou @code{NULL} com uma exceção definida em caso de falha.

Isso é o equivalente da expressão Python @code{p[low:high]}. A indexação do final da tupla não é suportada.
@end deffn

@geindex PyTuple_SetItem (C function)
@anchor{c-api/tuple c PyTuple_SetItem}@anchor{4b62}
@deffn {C Função} int PyTuple_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Insere uma referência ao objeto `o' na posição `pos' da tupla apontada por `p'. Retorna @code{0} em caso de sucesso. Se `pos' estiver fora dos limites, retorne @code{-1} e define uma exceção @ref{157e,,IndexError}.

@cartouche
@quotation Nota 
Esta função “rouba” uma referência a `o' e descarta uma referência a um item já na tupla na posição afetada.
@end quotation
@end cartouche
@end deffn

@geindex PyTuple_SET_ITEM (C function)
@anchor{c-api/tuple c PyTuple_SET_ITEM}@anchor{38d}
@deffn {C Função} void PyTuple_SET_ITEM (PyObject *p, Py_ssize_t pos, PyObject *o)

Como @ref{4b62,,PyTuple_SetItem()}, mas não verifica erros e deve `apenas' ser usado para preencher novas tuplas.

A verificação de limites é realizada como uma asserção se o Python for construído em @ref{1f9,,modo de depuração} ou @ref{38c,,com asserções}.

@cartouche
@quotation Nota 
Esta função “rouba” uma referência para `o' e, ao contrário de @ref{4b62,,PyTuple_SetItem()}, `não' descarta uma referência para nenhum item que esteja sendo substituído; qualquer referência na tupla na posição `pos' será perdida.
@end quotation
@end cartouche
@end deffn

@geindex _PyTuple_Resize (C function)
@anchor{c-api/tuple c _PyTuple_Resize}@anchor{1554}
@deffn {C Função} int _PyTuple_Resize (PyObject **p, Py_ssize_t newsize)

Pode ser usado para redimensionar uma tupla. `newsize' será o novo comprimento da tupla. Como as tuplas são `supostamente' imutáveis, isso só deve ser usado se houver apenas uma referência ao objeto. `Não' use isto se a tupla já for conhecida por alguma outra parte do código. A tupla sempre aumentará ou diminuirá no final. Pense nisso como destruir a tupla antiga e criar uma nova, mas com mais eficiência. Retorna @code{0} em caso de sucesso. O código do cliente nunca deve presumir que o valor resultante de @code{*p} será o mesmo de antes de chamar esta função. Se o objeto referenciado por @code{*p} for substituído, o @code{*p} original será destruído. Em caso de falha, retorna @code{-1} e define @code{*p} para @code{NULL}, e levanta @ref{15c5,,MemoryError} ou @ref{575,,SystemError}.
@end deffn

@node Objetos sequência de estrutura,Objeto List,Objeto tupla,Objetos Sequência
@anchor{c-api/tuple id1}@anchor{5011}@anchor{c-api/tuple struct-sequence-objects}@anchor{11ff}
@subsubsection Objetos sequência de estrutura


Objetos sequência de estrutura são o equivalente em C dos objetos @code{namedtuple()}, ou seja, uma sequência cujos itens também podem ser acessados por meio de atributos. Para criar uma sequência de estrutura, você primeiro precisa criar um tipo de sequência de estrutura específico.

@geindex PyStructSequence_NewType (C function)
@anchor{c-api/tuple c PyStructSequence_NewType}@anchor{4d58}
@deffn {C Função} @ref{ab4,,PyTypeObject} *PyStructSequence_NewType (PyStructSequence_Desc *desc)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um novo tipo de sequência de estrutura a partir dos dados em `desc', descrito abaixo. Instâncias do tipo resultante podem ser criadas com @ref{4d57,,PyStructSequence_New()}.

Retorna @code{NULL} com uma exceção definida em caso de falha.
@end deffn

@geindex PyStructSequence_InitType (C function)
@anchor{c-api/tuple c PyStructSequence_InitType}@anchor{1039}
@deffn {C Função} void PyStructSequence_InitType (PyTypeObject *type, PyStructSequence_Desc *desc)

Inicializa um tipo de sequência de estrutura `type' de `desc' no lugar.
@end deffn

@geindex PyStructSequence_InitType2 (C function)
@anchor{c-api/tuple c PyStructSequence_InitType2}@anchor{1038}
@deffn {C Função} int PyStructSequence_InitType2 (PyTypeObject *type, PyStructSequence_Desc *desc)

Como @ref{1039,,PyStructSequence_InitType()}, mas retorna @code{0} em caso de sucesso e @code{-1} com uma exceção definida em caso de falha.


Adicionado na versão 3.4.

@end deffn

@geindex PyStructSequence_Desc (C type)
@anchor{c-api/tuple c PyStructSequence_Desc}@anchor{bd3}
@deffn {C Tipo} type PyStructSequence_Desc
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Contém as metainformações de um tipo de sequência de estrutura a ser criado.

@geindex PyStructSequence_Desc.name (C member)
@anchor{c-api/tuple c PyStructSequence_Desc name}@anchor{5012}
@deffn {C Membro} const char *name

Nome totalmente qualificado do tipo; codificado em UTF-8 terminado em nulo. O nome deve conter o nome do módulo.
@end deffn

@geindex PyStructSequence_Desc.doc (C member)
@anchor{c-api/tuple c PyStructSequence_Desc doc}@anchor{5013}
@deffn {C Membro} const char *doc

Ponteiro para docstring para o tipo ou @code{NULL} para omitir
@end deffn

@geindex PyStructSequence_Desc.fields (C member)
@anchor{c-api/tuple c PyStructSequence_Desc fields}@anchor{5014}
@deffn {C Membro} @ref{bd2,,PyStructSequence_Field} *fields

Ponteiro para um vetor terminado em @code{NULL} com nomes de campos do novo tipo
@end deffn

@geindex PyStructSequence_Desc.n_in_sequence (C member)
@anchor{c-api/tuple c PyStructSequence_Desc n_in_sequence}@anchor{5015}
@deffn {C Membro} int n_in_sequence

Número de campos visíveis para o lado Python (se usado como tupla)
@end deffn
@end deffn

@geindex PyStructSequence_Field (C type)
@anchor{c-api/tuple c PyStructSequence_Field}@anchor{bd2}
@deffn {C Tipo} type PyStructSequence_Field
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Descreve um campo de uma sequência de estrutura. Como uma sequência de estrutura é modelada como uma tupla, todos os campos são digitados como @ref{339,,PyObject}*. O índice no vetor @ref{5014,,fields} do @ref{bd3,,PyStructSequence_Desc} determina qual campo da sequência de estrutura é descrito.

@geindex PyStructSequence_Field.name (C member)
@anchor{c-api/tuple c PyStructSequence_Field name}@anchor{5016}
@deffn {C Membro} const char *name

Nome do campo ou @code{NULL} para terminar a lista de campos nomeados; definida para @ref{989,,PyStructSequence_UnnamedField} para deixar sem nome.
@end deffn

@geindex PyStructSequence_Field.doc (C member)
@anchor{c-api/tuple c PyStructSequence_Field doc}@anchor{5017}
@deffn {C Membro} const char *doc

Campo docstring ou @code{NULL} para omitir.
@end deffn
@end deffn

@geindex PyStructSequence_UnnamedField (C var)
@anchor{c-api/tuple c PyStructSequence_UnnamedField}@anchor{989}
@deffn {C Variável} const char *const PyStructSequence_UnnamedField
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Valor especial para um nome de campo para deixá-lo sem nome.


Alterado na versão 3.9: O tipo foi alterado de @code{char *}.

@end deffn

@geindex PyStructSequence_New (C function)
@anchor{c-api/tuple c PyStructSequence_New}@anchor{4d57}
@deffn {C Função} @ref{339,,PyObject} *PyStructSequence_New (PyTypeObject *type)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um instância de `type', que deve ser criada com @ref{4d58,,PyStructSequence_NewType()}.

Retorna @code{NULL} com uma exceção definida em caso de falha.
@end deffn

@geindex PyStructSequence_GetItem (C function)
@anchor{c-api/tuple c PyStructSequence_GetItem}@anchor{4d56}
@deffn {C Função} @ref{339,,PyObject} *PyStructSequence_GetItem (PyObject *p, Py_ssize_t pos)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna o objeto na posição `pos' na sequência de estrutura apontada por `p'.

A verificação de limites é realizada como uma asserção se o Python for construído em @ref{1f9,,modo de depuração} ou @ref{38c,,com asserções}.
@end deffn

@geindex PyStructSequence_GET_ITEM (C function)
@anchor{c-api/tuple c PyStructSequence_GET_ITEM}@anchor{5018}
@deffn {C Função} @ref{339,,PyObject} *PyStructSequence_GET_ITEM (PyObject *p, Py_ssize_t pos)
`Retorna valor: Referência emprestada.'
Apelido para @ref{4d56,,PyStructSequence_GetItem()}.


Alterado na versão 3.13: Agora implementada como um apelido para @ref{4d56,,PyStructSequence_GetItem()}.

@end deffn

@geindex PyStructSequence_SetItem (C function)
@anchor{c-api/tuple c PyStructSequence_SetItem}@anchor{4d59}
@deffn {C Função} void PyStructSequence_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Define o campo no índice `pos' da sequência de estrutura `p' para o valor `o'. Como @ref{38d,,PyTuple_SET_ITEM()}, isto só deve ser usado para preencher novas instâncias.

A verificação de limites é realizada como uma asserção se o Python for construído em @ref{1f9,,modo de depuração} ou @ref{38c,,com asserções}.

@cartouche
@quotation Nota 
Esta função “rouba” uma referência a `o'.
@end quotation
@end cartouche
@end deffn

@geindex PyStructSequence_SET_ITEM (C function)
@anchor{c-api/tuple c PyStructSequence_SET_ITEM}@anchor{5019}
@deffn {C Função} void PyStructSequence_SET_ITEM (PyObject *p, Py_ssize_t *pos, PyObject *o)

Apelido para @ref{4d59,,PyStructSequence_SetItem()}.


Alterado na versão 3.13: Agora implementada como um apelido para @ref{4d59,,PyStructSequence_SetItem()}.

@end deffn

@node Objeto List,,Objetos sequência de estrutura,Objetos Sequência
@anchor{c-api/list doc}@anchor{501a}@anchor{c-api/list list-objects}@anchor{501b}@anchor{c-api/list listobjects}@anchor{501c}@anchor{c-api/list translation-repo}@anchor{501d}
@subsubsection Objeto List


@geindex objeto;lista

@geindex PyListObject (C type)
@anchor{c-api/list c PyListObject}@anchor{4f30}
@deffn {C Tipo} type PyListObject

Este subtipo de @ref{339,,PyObject} representa um objeto de lista Python.
@end deffn

@geindex PyList_Type (C var)
@anchor{c-api/list c PyList_Type}@anchor{4b84}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyList_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de lista Python. Este é o mesmo objeto que @ref{611,,list} na camada Python.
@end deffn

@geindex PyList_Check (C function)
@anchor{c-api/list c PyList_Check}@anchor{501e}
@deffn {C Função} int PyList_Check (PyObject *p)

Retorna verdadeiro se `p' é um objeto lista ou uma instância de um subtipo do tipo lista. Esta função sempre tem sucesso.
@end deffn

@geindex PyList_CheckExact (C function)
@anchor{c-api/list c PyList_CheckExact}@anchor{501f}
@deffn {C Função} int PyList_CheckExact (PyObject *p)

Retorna verdadeiro se `p' é um objeto lista, mas não uma instância de um subtipo do tipo lista. Esta função sempre tem sucesso.
@end deffn

@geindex PyList_New (C function)
@anchor{c-api/list c PyList_New}@anchor{4be1}
@deffn {C Função} @ref{339,,PyObject} *PyList_New (Py_ssize_t len)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma nova lista de comprimento `len' em caso de sucesso, ou @code{NULL} em caso de falha.

@cartouche
@quotation Nota 
Se `len' for maior que zero, os itens do objeto da lista retornada são definidos como @code{NULL}. Portanto, você não pode usar funções API abstratas, como @ref{1bce,,PySequence_SetItem()} ou expor o objeto ao código Python antes de definir todos os itens para um objeto real com @ref{165e,,PyList_SetItem()} ou @ref{38e,,PyList_SET_ITEM()}. As seguintes APIs são seguras desde que antes as listas tenham sido inicializadas: @ref{165e,,PyList_SetItem()} e @ref{38e,,PyList_SET_ITEM()}.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Size (C function)
@anchor{c-api/list c PyList_Size}@anchor{1461}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyList_Size (PyObject *list)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Retorna o comprimento do objeto de lista em `list'; isto é equivalente a @code{len(list)} em um objeto lista.
@end deffn

@geindex PyList_GET_SIZE (C function)
@anchor{c-api/list c PyList_GET_SIZE}@anchor{5020}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyList_GET_SIZE (PyObject *list)

Similar a @ref{1461,,PyList_Size()}, mas sem verificação de erro.
@end deffn

@geindex PyList_GetItemRef (C function)
@anchor{c-api/list c PyList_GetItemRef}@anchor{359}
@deffn {C Função} @ref{339,,PyObject} *PyList_GetItemRef (PyObject *list, Py_ssize_t index)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna o objeto na posição `index' na lista apontada por `list'. A posição deve ser não negativa; não há suporte à indexação do final da lista. Se `index' estiver fora dos limites (@code{<0 or >=len(list)}), retorna @code{NULL} e levanta uma exceção @ref{157e,,IndexError}.


Adicionado na versão 3.13.

@end deffn

@geindex PyList_GetItem (C function)
@anchor{c-api/list c PyList_GetItem}@anchor{35a}
@deffn {C Função} @ref{339,,PyObject} *PyList_GetItem (PyObject *list, Py_ssize_t index)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Como @ref{359,,PyList_GetItemRef()}, mas retorna uma @ref{33e,,referência emprestada} em vez de uma @ref{33d,,referência forte}.
@end deffn

@geindex PyList_GET_ITEM (C function)
@anchor{c-api/list c PyList_GET_ITEM}@anchor{4bf8}
@deffn {C Função} @ref{339,,PyObject} *PyList_GET_ITEM (PyObject *list, Py_ssize_t i)
`Retorna valor: Referência emprestada.'
Similar a @ref{35a,,PyList_GetItem()}, mas sem verificação de erro.
@end deffn

@geindex PyList_SetItem (C function)
@anchor{c-api/list c PyList_SetItem}@anchor{165e}
@deffn {C Função} int PyList_SetItem (PyObject *list, Py_ssize_t index, PyObject *item)
` Parte da @ref{553,,ABI Estável}.'
Define o item no índice `index' na lista como `item'. Retorna @code{0} em caso de sucesso. Se `index' estiver fora dos limites, retorna @code{-1} e levanta uma exceção @ref{157e,,IndexError}.

@cartouche
@quotation Nota 
Esta função “rouba” uma referência para o `item' e descarta uma referência para um item já presente na lista na posição afetada.
@end quotation
@end cartouche
@end deffn

@geindex PyList_SET_ITEM (C function)
@anchor{c-api/list c PyList_SET_ITEM}@anchor{38e}
@deffn {C Função} void PyList_SET_ITEM (PyObject *list, Py_ssize_t i, PyObject *o)

Forma macro de @ref{165e,,PyList_SetItem()} sem verificação de erro. Este é normalmente usado apenas para preencher novas listas onde não há conteúdo anterior.

A verificação de limites é realizada como uma asserção se o Python for construído em @ref{1f9,,modo de depuração} ou @ref{38c,,com asserções}.

@cartouche
@quotation Nota 
Esta macro “rouba” uma referência para o `item' e, ao contrário de @ref{165e,,PyList_SetItem()}, `não' descarta uma referência para nenhum item que esteja sendo substituído; qualquer referência em `list' será perdida.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Insert (C function)
@anchor{c-api/list c PyList_Insert}@anchor{165d}
@deffn {C Função} int PyList_Insert (PyObject *list, Py_ssize_t index, PyObject *item)
` Parte da @ref{553,,ABI Estável}.'
Insere o item `item' na lista `list' na frente do índice `index'. Retorna @code{0} se for bem-sucedido; retorna @code{-1} e levanta uma exceção se malsucedido. Análogo a @code{list.insert(index, item)}.
@end deffn

@geindex PyList_Append (C function)
@anchor{c-api/list c PyList_Append}@anchor{4cd9}
@deffn {C Função} int PyList_Append (PyObject *list, PyObject *item)
` Parte da @ref{553,,ABI Estável}.'
Adiciona o item `item' ao final da lista `list'. Retorna @code{0} se for bem-sucedido; retorna @code{-1} e levanta uma exceção se malsucedido. Análogo a @code{list.insert(index, item)}.
@end deffn

@geindex PyList_GetSlice (C function)
@anchor{c-api/list c PyList_GetSlice}@anchor{4cdb}
@deffn {C Função} @ref{339,,PyObject} *PyList_GetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma lista dos objetos em `list' contendo os objetos `entre' `low' e `alto'. Retorne @code{NULL} e levanta uma exceção se malsucedido. Análogo a @code{list[low:high]}. Não há suporte à indexação do final da lista.
@end deffn

@geindex PyList_SetSlice (C function)
@anchor{c-api/list c PyList_SetSlice}@anchor{4cdd}
@deffn {C Função} int PyList_SetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)
` Parte da @ref{553,,ABI Estável}.'
Define a fatia de `list' entre `low' e `high' para o conteúdo de `itemlist'. Análogo a @code{list[low:high] = itemlist}. `itemlist' pode ser @code{NULL}, indicando a atribuição de uma lista vazia (exclusão de fatia). Retorna @code{0} em caso de sucesso, @code{-1} em caso de falha. Não há suporte à indexação do final da lista.
@end deffn

@geindex PyList_Extend (C function)
@anchor{c-api/list c PyList_Extend}@anchor{35b}
@deffn {C Função} int PyList_Extend (PyObject *list, PyObject *iterable)

Estende `list' com o conteúdo de `iterable'. Isto é o mesmo que @code{PyList_SetSlice(list, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, iterable)} e análogo a @code{list.extend(iterable)} ou @code{list += iterable}.

Levanta uma exceção e retorna @code{-1} se `list' não for um objeto @ref{611,,list}. Retorna 0 em caso de sucesso.


Adicionado na versão 3.13.

@end deffn

@geindex PyList_Clear (C function)
@anchor{c-api/list c PyList_Clear}@anchor{35c}
@deffn {C Função} int PyList_Clear (PyObject *list)

Remove todos os itens da `lista'. Isto é o mesmo que @code{PyList_SetSlice(list, 0, PY_SSIZE_T_MAX, NULL)} e análogo a @code{list.clear()} ou @code{del list[:]}.

Levanta uma exceção e retorna @code{-1} se `list' não for um objeto @ref{611,,list}. Retorna 0 em caso de sucesso.


Adicionado na versão 3.13.

@end deffn

@geindex PyList_Sort (C function)
@anchor{c-api/list c PyList_Sort}@anchor{4cde}
@deffn {C Função} int PyList_Sort (PyObject *list)
` Parte da @ref{553,,ABI Estável}.'
Ordena os itens de `list' no mesmo lugar. Retorna @code{0} em caso de sucesso, e @code{-1} em caso de falha. Isso é o equivalente de @code{list.sort()}.
@end deffn

@geindex PyList_Reverse (C function)
@anchor{c-api/list c PyList_Reverse}@anchor{4cdc}
@deffn {C Função} int PyList_Reverse (PyObject *list)
` Parte da @ref{553,,ABI Estável}.'
Inverte os itens de `list' no mesmo lugar. Retorna @code{0} em caso de sucesso, e @code{-1} em caso de falha. Isso é o equivalente de @code{list.reverse()}.
@end deffn

@geindex PyList_AsTuple (C function)
@anchor{c-api/list c PyList_AsTuple}@anchor{4cda}
@deffn {C Função} @ref{339,,PyObject} *PyList_AsTuple (PyObject *list)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;tupla

Retorna um novo objeto tupla contendo os conteúdos de `list'; equivale a @code{tuple(list)}.
@end deffn

@node Coleções,Objetos Function<2>,Objetos Sequência,Camada de Objetos Concretos
@anchor{c-api/concrete container-objects}@anchor{5021}@anchor{c-api/concrete mapobjects}@anchor{5022}
@subsection Coleções


@geindex objeto;mapeamento

@menu
* Objetos dicionários:: 
* Objeto Set:: 

@end menu

@node Objetos dicionários,Objeto Set,,Coleções
@anchor{c-api/dict doc}@anchor{5023}@anchor{c-api/dict dictionary-objects}@anchor{5024}@anchor{c-api/dict dictobjects}@anchor{5025}
@subsubsection Objetos dicionários


@geindex objeto;dicionário

@geindex PyDictObject (C type)
@anchor{c-api/dict c PyDictObject}@anchor{3c1}
@deffn {C Tipo} type PyDictObject

Este subtipo do @ref{339,,PyObject} representa um objeto dicionário Python.
@end deffn

@geindex PyDict_Type (C var)
@anchor{c-api/dict c PyDict_Type}@anchor{4c5f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDict_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância do @ref{ab4,,PyTypeObject} representa o tipo do dicionário Python. Este é o mesmo objeto @ref{256,,dict} na camada do Python.
@end deffn

@geindex PyDict_Check (C function)
@anchor{c-api/dict c PyDict_Check}@anchor{4f61}
@deffn {C Função} int PyDict_Check (PyObject *p)

Retorna verdadeiro se `p' é um objeto dicionário ou uma instância de um subtipo do tipo dicionário. Esta função sempre tem sucesso.
@end deffn

@geindex PyDict_CheckExact (C function)
@anchor{c-api/dict c PyDict_CheckExact}@anchor{5026}
@deffn {C Função} int PyDict_CheckExact (PyObject *p)

Retorna verdadeiro se `p' é um objeto dicionário, mas não uma instância de um subtipo do tipo dicionário. Esta função sempre tem sucesso.
@end deffn

@geindex PyDict_New (C function)
@anchor{c-api/dict c PyDict_New}@anchor{4c5d}
@deffn {C Função} @ref{339,,PyObject} *PyDict_New ()
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo dicionário vazio ou @code{NULL} em caso de falha.
@end deffn

@geindex PyDictProxy_New (C function)
@anchor{c-api/dict c PyDictProxy_New}@anchor{4c50}
@deffn {C Função} @ref{339,,PyObject} *PyDictProxy_New (PyObject *mapping)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um objeto @ref{46d,,types.MappingProxyType} para um mapeamento que reforça o comportamento somente leitura. Isso normalmente é usado para criar uma visão para evitar a modificação do dicionário para tipos de classes não dinâmicas.
@end deffn

@geindex PyDictProxy_Type (C var)
@anchor{c-api/dict c PyDictProxy_Type}@anchor{4c51}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictProxy_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para mapear objetos proxy criados por @ref{4c50,,PyDictProxy_New()} e para o atributo somente leitura @code{__dict__} de muitos tipos embutidos. Uma instância de @ref{4c51,,PyDictProxy_Type} fornece uma visão dinâmica e somente leitura de um dicionário subjacente: as alterações no dicionário subjacente são refletidas no proxy, mas o próprio proxy não oferece suporte a operações de mutação. Isso corresponde a @ref{46d,,types.MappingProxyType} no Python.
@end deffn

@geindex PyDict_Clear (C function)
@anchor{c-api/dict c PyDict_Clear}@anchor{4c56}
@deffn {C Função} void PyDict_Clear (PyObject *p)
` Parte da @ref{553,,ABI Estável}.'
Esvazia um dicionário existente de todos os pares chave-valor.
@end deffn

@geindex PyDict_Contains (C function)
@anchor{c-api/dict c PyDict_Contains}@anchor{338}
@deffn {C Função} int PyDict_Contains (PyObject *p, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Determina se o dicionário `p' contém `key'. Se um item em `p' corresponder à `key', retorna @code{1}, caso contrário, retorna @code{0}. Em caso de erro, retorna @code{-1}. Isso equivale à expressão Python @code{key in p}.
@end deffn

@geindex PyDict_ContainsString (C function)
@anchor{c-api/dict c PyDict_ContainsString}@anchor{337}
@deffn {C Função} int PyDict_ContainsString (PyObject *p, const char *key)

É o mesmo que @ref{338,,PyDict_Contains()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyDict_Copy (C function)
@anchor{c-api/dict c PyDict_Copy}@anchor{420}
@deffn {C Função} @ref{339,,PyObject} *PyDict_Copy (PyObject *p)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo dicionário que contém o mesmo chave-valor como `p'.
@end deffn

@geindex PyDict_SetItem (C function)
@anchor{c-api/dict c PyDict_SetItem}@anchor{4b63}
@deffn {C Função} int PyDict_SetItem (PyObject *p, PyObject *key, PyObject *val)
` Parte da @ref{553,,ABI Estável}.'
Insere `val' no dicionário `p' com a tecla `key'. `key' deve ser @ref{610,,hasheável}; se não for, @ref{2c3,,TypeError} será levantada. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de falha. Esta função `não' rouba uma referência a `val'.
@end deffn

@geindex PyDict_SetItemString (C function)
@anchor{c-api/dict c PyDict_SetItemString}@anchor{16eb}
@deffn {C Função} int PyDict_SetItemString (PyObject *p, const char *key, PyObject *val)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{4b63,,PyDict_SetItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyDict_DelItem (C function)
@anchor{c-api/dict c PyDict_DelItem}@anchor{4c57}
@deffn {C Função} int PyDict_DelItem (PyObject *p, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Remove a entrada no dicionário `p' com a chave `key'. `key' deve ser @ref{610,,hasheável}; se não for, @ref{2c3,,TypeError} é levantada. Se `key' não estiver no dicionário, @ref{344,,KeyError} é levantada. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de falha.
@end deffn

@geindex PyDict_DelItemString (C function)
@anchor{c-api/dict c PyDict_DelItemString}@anchor{4c58}
@deffn {C Função} int PyDict_DelItemString (PyObject *p, const char *key)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{4c57,,PyDict_DelItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.
@end deffn

@geindex PyDict_GetItemRef (C function)
@anchor{c-api/dict c PyDict_GetItemRef}@anchor{33a}
@deffn {C Função} int PyDict_GetItemRef (PyObject *p, PyObject *key, PyObject **result)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna uma nova @ref{33d,,referência forte} para o objeto dicionário `p' que possui uma chave `key':


@itemize *

@item 
Se a chave estiver presente, define `*result' como uma nova @ref{33d,,referência forte} para o valor e retorna @code{1}.

@item 
Se a chave estiver ausente, define `*result' como @code{NULL} e retorna @code{0}.

@item 
Em caso de erro, levanta uma exceção e retorna @code{-1}.
@end itemize


Adicionado na versão 3.13.


Veja também a função @ref{4be2,,PyObject_GetItem()}.
@end deffn

@geindex PyDict_GetItem (C function)
@anchor{c-api/dict c PyDict_GetItem}@anchor{387}
@deffn {C Função} @ref{339,,PyObject} *PyDict_GetItem (PyObject *p, PyObject *key)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna um @ref{33e,,referência emprestada} para o objeto do dicionário `p' que possui uma chave `key'. Retorna @code{NULL} se a chave `key' não estiver presente, mas `sem' definir uma exceção.

@cartouche
@quotation Nota 
Exceções que ocorrem ao chamar os métodos @ref{b0e,,__hash__()} e @ref{b0d,,__eq__()} são ignoradas silenciosamente. Ao invés disso, use a função @ref{33c,,PyDict_GetItemWithError()}.
@end quotation
@end cartouche


Alterado na versão 3.10: Chamar esta API sem @ref{159,,GIL} retida era permitido por motivos históricos. Não é mais permitido.

@end deffn

@geindex PyDict_GetItemWithError (C function)
@anchor{c-api/dict c PyDict_GetItemWithError}@anchor{33c}
@deffn {C Função} @ref{339,,PyObject} *PyDict_GetItemWithError (PyObject *p, PyObject *key)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Variante de @ref{387,,PyDict_GetItem()} que não suprime exceções. Retorna @code{NULL} `com' uma exceção definida se uma exceção ocorreu. Retorna @code{NULL} ** sem ** uma exceção definida se a chave não estiver presente.
@end deffn

@geindex PyDict_GetItemString (C function)
@anchor{c-api/dict c PyDict_GetItemString}@anchor{388}
@deffn {C Função} @ref{339,,PyObject} *PyDict_GetItemString (PyObject *p, const char *key)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @ref{387,,PyDict_GetItem()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.

@cartouche
@quotation Nota 
Exceções que ocorrem ao chamar os métodos @ref{b0e,,__hash__()} e @ref{b0d,,__eq__()} ou ao criar objetos temporários da classe @ref{44c,,str} são ignoradas silenciosamente. Ao invés disso, prefira usar a função @ref{33c,,PyDict_GetItemWithError()} com sua própria `key' de @ref{4db1,,PyUnicode_FromString()}.
@end quotation
@end cartouche
@end deffn

@geindex PyDict_GetItemStringRef (C function)
@anchor{c-api/dict c PyDict_GetItemStringRef}@anchor{33b}
@deffn {C Função} int PyDict_GetItemStringRef (PyObject *p, const char *key, PyObject **result)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Similar a @ref{33a,,PyDict_GetItemRef()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyDict_SetDefault (C function)
@anchor{c-api/dict c PyDict_SetDefault}@anchor{340}
@deffn {C Função} @ref{339,,PyObject} *PyDict_SetDefault (PyObject *p, PyObject *key, PyObject *defaultobj)
`Retorna valor: Referência emprestada.'
Isso é o mesmo que o @ref{10b2,,dict.setdefault()} de nível Python. Se presente, ele retorna o valor correspondente a `key' do dicionário `p'. Se a chave não estiver no dict, ela será inserida com o valor `defaultobj' e `defaultobj' será retornado. Esta função avalia a função hash de `key' apenas uma vez, em vez de avaliá-la independentemente para a pesquisa e a inserção.


Adicionado na versão 3.4.

@end deffn

@geindex PyDict_SetDefaultRef (C function)
@anchor{c-api/dict c PyDict_SetDefaultRef}@anchor{33f}
@deffn {C Função} int PyDict_SetDefaultRef (PyObject *p, PyObject *key, PyObject *default_value, PyObject **result)

Insere `default_value' no dicionário `p' com uma chave `key' se a chave ainda não estiver presente no dicionário. Se `result' não for @code{NULL}, então `*result' é definido como uma @ref{33d,,referência forte} para `default_value', se a chave não estiver presente, ou para o valor existente, se `key' já estava presente no dicionário. Retorna @code{1} se a chave estava presente e `default_value' não foi inserido, ou @code{0} se a chave não estava presente e `default_value' foi inserido. Em caso de falha, retorna @code{-1}, define uma exceção e define @code{*result} como @code{NULL}.

Para maior clareza: se você tiver uma referência forte para `default_value' antes de chamar esta função, então depois que ela retornar, você terá uma referência forte para `default_value' e `*result' (se não for @code{NULL}). Estes podem referir-se ao mesmo objeto: nesse caso você mantém duas referências separadas para ele.


Adicionado na versão 3.13.

@end deffn

@geindex PyDict_Pop (C function)
@anchor{c-api/dict c PyDict_Pop}@anchor{341}
@deffn {C Função} int PyDict_Pop (PyObject *p, PyObject *key, PyObject **result)

Remove `key' do dicionário `p' e, opcionalmente, retorna o valor removido. Não levanta @ref{344,,KeyError} se a chave estiver ausente.


@itemize -

@item 
Se a chave estiver presente, define `*result' como uma nova referência para o valor se `result' não for @code{NULL} e retorna @code{1}.

@item 
Se a chave estiver ausente, define `*result' como @code{NULL} se `result' não for @code{NULL} e retorna @code{0}.

@item 
Em caso de erro, levanta uma exceção e retorna @code{-1}.
@end itemize

Similar a @ref{343,,dict.pop()}, mas sem o valor padrão e sem levantar @ref{344,,KeyError} se a chave estiver ausente.


Adicionado na versão 3.13.

@end deffn

@geindex PyDict_PopString (C function)
@anchor{c-api/dict c PyDict_PopString}@anchor{342}
@deffn {C Função} int PyDict_PopString (PyObject *p, const char *key, PyObject **result)

Similar a @ref{341,,PyDict_Pop()}, mas `key' é especificada como uma string de bytes const char* codificada em UTF-8, em vez de um @ref{339,,PyObject}*.


Adicionado na versão 3.13.

@end deffn

@geindex PyDict_Items (C function)
@anchor{c-api/dict c PyDict_Items}@anchor{4c59}
@deffn {C Função} @ref{339,,PyObject} *PyDict_Items (PyObject *p)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um @ref{4f30,,PyListObject} contendo todos os itens do dicionário.
@end deffn

@geindex PyDict_Keys (C function)
@anchor{c-api/dict c PyDict_Keys}@anchor{4c5a}
@deffn {C Função} @ref{339,,PyObject} *PyDict_Keys (PyObject *p)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um @ref{4f30,,PyListObject} contendo todas as chaves do dicionário.
@end deffn

@geindex PyDict_Values (C function)
@anchor{c-api/dict c PyDict_Values}@anchor{4c61}
@deffn {C Função} @ref{339,,PyObject} *PyDict_Values (PyObject *p)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um @ref{4f30,,PyListObject} contendo todos os valores do dicionário `p'.
@end deffn

@geindex PyDict_Size (C function)
@anchor{c-api/dict c PyDict_Size}@anchor{4c5e}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyDict_Size (PyObject *p)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Retorna o número de itens no dicionário. Isso é equivalente a @code{len(p)} em um dicionário.
@end deffn

@geindex PyDict_GET_SIZE (C function)
@anchor{c-api/dict c PyDict_GET_SIZE}@anchor{5027}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyDict_GET_SIZE (PyObject *p)

Similar a @ref{4c5e,,PyDict_Size()}, mas sem verificação de erro.
@end deffn

@geindex PyDict_Next (C function)
@anchor{c-api/dict c PyDict_Next}@anchor{16fd}
@deffn {C Função} int PyDict_Next (PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)
` Parte da @ref{553,,ABI Estável}.'
Itera todos os pares de valores-chave no dicionário `p'. O @ref{a69,,Py_ssize_t} referido por `ppos' deve ser inicializado para @code{0} antes da primeira chamada para esta função para iniciar a iteração; a função retorna true para cada par no dicionário e false quando todos os pares forem relatados. Os parâmetros `pkey' e `pvalue' devem apontar para variáveis de @ref{339,,PyObject}* que serão preenchidas com cada chave e valor, respectivamente, ou podem ser @code{NULL}. Todas as referências retornadas por meio deles são emprestadas. `ppos' não deve ser alterado durante a iteração. Seu valor representa deslocamentos dentro da estrutura do dicionário interno e, como a estrutura é esparsa, os deslocamentos não são consecutivos.

Por exemplo:

@example
PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    /* fazer algo de interessante com os valores... */
    ...
@}
@end example

O dicionário `p' não deve sofrer mutação durante a iteração. É seguro modificar os valores das chaves à medida que você itera no dicionário, mas apenas enquanto o conjunto de chaves não mudar. Por exemplo:

@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

A função não é segura para thread na construção com @ref{15e4,,threads livres} sem sincronização externa. Você pode usar @ref{5028,,Py_BEGIN_CRITICAL_SECTION} para travar o dicionário enquanto itera sobre ele:

@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{4c5b}
@deffn {C Função} int PyDict_Merge (PyObject *a, PyObject *b, int override)
` Parte da @ref{553,,ABI Estável}.'
Itera sobre o objeto de mapeamento `b' adicionando pares de valores-chave ao dicionário `a'. `b' pode ser um dicionário, ou qualquer objeto que suporte @ref{bd5,,PyMapping_Keys()} e @ref{4be2,,PyObject_GetItem()}. Se `override' for verdadeiro, os pares existentes em `a' serão substituídos se uma chave correspondente for encontrada em `b', caso contrário, os pares serão adicionados apenas se não houver uma chave correspondente em `a'. Retorna @code{0} em caso de sucesso ou @code{-1} se uma exceção foi levantada.
@end deffn

@geindex PyDict_Update (C function)
@anchor{c-api/dict c PyDict_Update}@anchor{4c60}
@deffn {C Função} int PyDict_Update (PyObject *a, PyObject *b)
` Parte da @ref{553,,ABI Estável}.'
É o mesmo que @code{PyDict_Merge(a, b, 1)} em C, e é semelhante a @code{a.update(b)} em Python, exceto que @ref{4c60,,PyDict_Update()} não cai na iteração em uma sequência de pares de valores de chave se o segundo argumento não tiver o atributo “keys”. Retorna @code{0} em caso de sucesso ou @code{-1} se uma exceção foi levantada.
@end deffn

@geindex PyDict_MergeFromSeq2 (C function)
@anchor{c-api/dict c PyDict_MergeFromSeq2}@anchor{4c5c}
@deffn {C Função} int PyDict_MergeFromSeq2 (PyObject *a, PyObject *seq2, int override)
` Parte da @ref{553,,ABI Estável}.'
Atualiza ou mescla no dicionário `a', a partir dos pares de chave-valor em `seq2'. `seq2' deve ser um objeto iterável produzindo objetos iteráveis de comprimento 2, vistos como pares chave-valor. No caso de chaves duplicadas, a última vence se `override' for verdadeiro, caso contrário, a primeira vence. Retorne @code{0} em caso de sucesso ou @code{-1} se uma exceção foi levantada. Python equivalente (exceto para o 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{562}
@deffn {C Função} int PyDict_AddWatcher (PyDict_WatchCallback callback)

Registra `callback' como um observador de dicionário. Retorna um ID inteiro não negativo que deve ser passado para futuras chamadas a @ref{563,,PyDict_Watch()}. Em caso de erro (por exemplo, não há mais IDs de observador disponíveis), retorna @code{-1} e define uma exceção.


Adicionado na versão 3.12.

@end deffn

@geindex PyDict_ClearWatcher (C function)
@anchor{c-api/dict c PyDict_ClearWatcher}@anchor{5029}
@deffn {C Função} int PyDict_ClearWatcher (int watcher_id)

Limpa o observador identificado por `watcher_id' retornado anteriormente de @ref{562,,PyDict_AddWatcher()}. Retorna @code{0} em caso de sucesso, @code{-1} em caso de erro (por exemplo, se o `watcher_id' fornecido nunca foi registrado).


Adicionado na versão 3.12.

@end deffn

@geindex PyDict_Watch (C function)
@anchor{c-api/dict c PyDict_Watch}@anchor{563}
@deffn {C Função} int PyDict_Watch (int watcher_id, PyObject *dict)

Marca o dicionário `dict' como observado. A função de retorno concedida a `watcher_id' por @ref{562,,PyDict_AddWatcher()} será chamada quando `dict' for modificado ou desalocado. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de erro.


Adicionado na versão 3.12.

@end deffn

@geindex PyDict_Unwatch (C function)
@anchor{c-api/dict c PyDict_Unwatch}@anchor{502a}
@deffn {C Função} int PyDict_Unwatch (int watcher_id, PyObject *dict)

Marca o dicionário `dict' como não mais observado. A função de retorno concedida a `watcher_id' por @ref{562,,PyDict_AddWatcher()} será chamada quando `dict' for modificado ou desalocado. O dicionário deve ter sido observado anteriormente por este observador. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de erro.


Adicionado na versão 3.12.

@end deffn

@geindex PyDict_WatchEvent (C type)
@anchor{c-api/dict c PyDict_WatchEvent}@anchor{502b}
@deffn {C Tipo} type PyDict_WatchEvent

Enumeração de possíveis eventos de observador de dicionário: @code{PyDict_EVENT_ADDED}, @code{PyDict_EVENT_MODIFIED}, @code{PyDict_EVENT_DELETED}, @code{PyDict_EVENT_CLONED}, @code{PyDict_EVENT_CLEARED} ou @code{PyDict_EVENT_DEALLOCATED}.


Adicionado na versão 3.12.

@end deffn

@geindex PyDict_WatchCallback (C type)
@anchor{c-api/dict c PyDict_WatchCallback}@anchor{502c}
@deffn {C Tipo} typedef int (*PyDict_WatchCallback)(@ref{502b,,PyDict_WatchEvent} event, @ref{339,,PyObject} *dict, @ref{339,,PyObject} *key, @ref{339,,PyObject} *new_value)

Tipo de uma função de retorno de chamada de observador de dicionário.

Se `event' for @code{PyDict_EVENT_CLEARED} ou @code{PyDict_EVENT_DEALLOCATED}, tanto `key' quanto `new_value' serão @code{NULL}. Se `event' for @code{PyDict_EVENT_ADDED} ou @code{PyDict_EVENT_MODIFIED}, `new_value' será o novo valor de `key'. Se `event' for @code{PyDict_EVENT_DELETED}, `key' estará sendo excluída do dicionário e `new_value' será @code{NULL}.

@code{PyDict_EVENT_CLONED} ocorre quando `dict' estava anteriormente vazio e outro dict é mesclado a ele. Para manter a eficiência dessa operação, os eventos @code{PyDict_EVENT_ADDED} por chave não são emitidos nesse caso; em vez disso, um único @code{PyDict_EVENT_CLONED} é emitido e `key' será o dicionário de origem.

A função de retorno pode inspecionar, mas não deve modificar o `dict'; isso pode ter efeitos imprevisíveis, inclusive recursão infinita. Não acione a execução do código Python na função de retorno, pois isso poderia modificar o dict como um efeito colateral.

Se `event' for @code{PyDict_EVENT_DEALLOCATED}, a obtenção de uma nova referência na função de retorno para o dicionário prestes a ser destruído o ressuscitará e impedirá que ele seja liberado nesse momento. Quando o objeto ressuscitado for destruído mais tarde, quaisquer funções de retorno do observador ativos naquele momento serão chamados novamente.

As funções de retorno ocorrem antes que a modificação notificada no `dict' ocorra, de modo que o estado anterior do `dict' possa ser inspecionado.

Se a função de retorno definir uma exceção, ela deverá retornar @code{-1}. Essa exceção será exibida como uma exceção não levantável usando @ref{34d,,PyErr_WriteUnraisable()}. Caso contrário, deverá retornar @code{0}.

É possível que já exista uma exceção pendente definida na entrada da função de retorno. Nesse caso, a função de retorno deve retornar @code{0} com a mesma exceção ainda definida. Isso significa que a função de retorno não pode chamar nenhuma outra API que possa definir uma exceção, a menos que salve e limpe o estado da exceção primeiro e restaure a exceção antes de retornar.


Adicionado na versão 3.12.

@end deffn

@menu
* Objetos visão de dicionário:: 
* Dicionários ordenados:: 

@end menu

@node Objetos visão de dicionário,Dicionários ordenados,,Objetos dicionários
@anchor{c-api/dict dictionary-view-objects}@anchor{502d}
@subsubsection Objetos visão de dicionário


@geindex PyDictViewSet_Check (C function)
@anchor{c-api/dict c PyDictViewSet_Check}@anchor{502e}
@deffn {C Função} int PyDictViewSet_Check (PyObject *op)

Retorna verdadeiro se `op' for uma visão de um conjunto dentro de um dicionário. Isso atualmente equivale a @ref{502f,,PyDictKeys_Check}(@ref{502e,,op}) || @ref{5030,,PyDictItems_Check}(@ref{502e,,op}). Esta função sempre tem sucesso.
@end deffn

@geindex PyDictKeys_Type (C var)
@anchor{c-api/dict c PyDictKeys_Type}@anchor{4c4f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictKeys_Type
` Parte da @ref{553,,ABI Estável}.'
Objeto tipo para uma visualização das chaves do dicionário. Em Python, este é o tipo do objeto retornado por @ref{7ce,,dict.keys()}.
@end deffn

@geindex PyDictKeys_Check (C function)
@anchor{c-api/dict c PyDictKeys_Check}@anchor{502f}
@deffn {C Função} int PyDictKeys_Check (PyObject *op)

Retorna verdadeiro se `op' for uma instância de uma visualização de chaves de dicionário. Esta função sempre tem sucesso.
@end deffn

@geindex PyDictValues_Type (C var)
@anchor{c-api/dict c PyDictValues_Type}@anchor{4c55}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictValues_Type
` Parte da @ref{553,,ABI Estável}.'
Objeto tipo para uma visualização dos valores do dicionário. Em Python, este é o tipo do objeto retornado por @ref{7cf,,dict.values()}.
@end deffn

@geindex PyDictValues_Check (C function)
@anchor{c-api/dict c PyDictValues_Check}@anchor{5031}
@deffn {C Função} int PyDictValues_Check (PyObject *op)

Retorna verdadeiro se `op' for uma instância de uma visualização de valores de dicionário. Esta função sempre tem sucesso.
@end deffn

@geindex PyDictItems_Type (C var)
@anchor{c-api/dict c PyDictItems_Type}@anchor{4c4b}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictItems_Type
` Parte da @ref{553,,ABI Estável}.'
Objeto tipo para uma visualização de itens de dicionário. Em Python, este é o tipo do objeto retornado por @ref{7d0,,dict.items()}.
@end deffn

@geindex PyDictItems_Check (C function)
@anchor{c-api/dict c PyDictItems_Check}@anchor{5030}
@deffn {C Função} int PyDictItems_Check (PyObject *op)

Retorna verdadeiro se `op' for uma instância de uma visualização de itens de dicionário. Esta função sempre tem sucesso.
@end deffn

@node Dicionários ordenados,,Objetos visão de dicionário,Objetos dicionários
@anchor{c-api/dict ordered-dictionaries}@anchor{5032}
@subsubsection Dicionários ordenados


A API C do Python fornece uma interface para @ref{5db,,collections.OrderedDict} do C. Desde o Python 3.7, os dicionários são ordenados por padrão, então geralmente há pouca necessidade dessas funções; prefira @code{PyDict*} sempre que possível.

@geindex PyODict_Type (C var)
@anchor{c-api/dict c PyODict_Type}@anchor{5033}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyODict_Type

Objeto de tipo para dicionários ordenados. Este é o mesmo objeto que @ref{5db,,collections.OrderedDict} na camada Python.
@end deffn

@geindex PyODict_Check (C function)
@anchor{c-api/dict c PyODict_Check}@anchor{5034}
@deffn {C Função} int PyODict_Check (PyObject *od)

Retorna verdadeiro se `od' for um objeto de dicionário ordenado ou uma instância de um subtipo do tipo @ref{5db,,OrderedDict}. Esta função sempre tem sucesso..
@end deffn

@geindex PyODict_CheckExact (C function)
@anchor{c-api/dict c PyODict_CheckExact}@anchor{5035}
@deffn {C Função} int PyODict_CheckExact (PyObject *od)

Retorna verdadeiro se `od' for um objeto de dicionário ordenado, mas não uma instância de um subtipo do tipo @ref{5db,,OrderedDict}. Esta função sempre tem sucesso.
@end deffn

@geindex PyODictKeys_Type (C var)
@anchor{c-api/dict c PyODictKeys_Type}@anchor{5036}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyODictKeys_Type

Análogo a @ref{4c4f,,PyDictKeys_Type} para dicionários ordenados.
@end deffn

@geindex PyODictValues_Type (C var)
@anchor{c-api/dict c PyODictValues_Type}@anchor{5037}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyODictValues_Type

Análogo a @ref{4c55,,PyDictValues_Type} para dicionários ordenados.
@end deffn

@geindex PyODictItems_Type (C var)
@anchor{c-api/dict c PyODictItems_Type}@anchor{5038}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyODictItems_Type

Análogo a @ref{4c4b,,PyDictItems_Type} para dicionários ordenados.
@end deffn

@geindex PyODict_New (C function)
@anchor{c-api/dict c PyODict_New}@anchor{5039}
@deffn {C Função} @ref{339,,PyObject} *PyODict_New (void)

Retorna um novo dicionário ordenado vazio ou @code{NULL} em caso de falha.

Isso é análogo a @ref{4c5d,,PyDict_New()}.
@end deffn

@geindex PyODict_SetItem (C function)
@anchor{c-api/dict c PyODict_SetItem}@anchor{503a}
@deffn {C Função} int PyODict_SetItem (PyObject *od, PyObject *key, PyObject *value)

Insere o valor `value' no dicionário ordenado `od' com a chave de `key'. Retorna @code{0} em caso de sucesso ou @code{-1} com uma exceção definida em caso de falha.

Isso é análogo a @ref{4b63,,PyDict_SetItem()}.
@end deffn

@geindex PyODict_DelItem (C function)
@anchor{c-api/dict c PyODict_DelItem}@anchor{503b}
@deffn {C Função} int PyODict_DelItem (PyObject *od, PyObject *key)

Remove a entrada do dicionário ordenado `od' com a chave `key'. Retorna @code{0} em caso de sucesso ou @code{-1} com uma exceção definida em caso de falha.

Isso é análogo a @ref{4c57,,PyDict_DelItem()}.
@end deffn

Estes são apelidos @ref{209,,suavemente descontinuados} a APIs de @code{PyDict}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@code{PyODict}

@tab

@code{PyDict}

@item

@geindex PyODict_GetItem (C macro)
@anchor{c-api/dict c PyODict_GetItem}@anchor{503c}
@deffn {C Macro} PyODict_GetItem (od, key)
@end deffn

@tab

@ref{387,,PyDict_GetItem()}

@item

@geindex PyODict_GetItemWithError (C macro)
@anchor{c-api/dict c PyODict_GetItemWithError}@anchor{503d}
@deffn {C Macro} PyODict_GetItemWithError (od, key)
@end deffn

@tab

@ref{33c,,PyDict_GetItemWithError()}

@item

@geindex PyODict_GetItemString (C macro)
@anchor{c-api/dict c PyODict_GetItemString}@anchor{503e}
@deffn {C Macro} PyODict_GetItemString (od, key)
@end deffn

@tab

@ref{388,,PyDict_GetItemString()}

@item

@geindex PyODict_Contains (C macro)
@anchor{c-api/dict c PyODict_Contains}@anchor{503f}
@deffn {C Macro} PyODict_Contains (od, key)
@end deffn

@tab

@ref{338,,PyDict_Contains()}

@item

@geindex PyODict_Size (C macro)
@anchor{c-api/dict c PyODict_Size}@anchor{5040}
@deffn {C Macro} PyODict_Size (od)
@end deffn

@tab

@ref{4c5e,,PyDict_Size()}

@item

@geindex PyODict_SIZE (C macro)
@anchor{c-api/dict c PyODict_SIZE}@anchor{5041}
@deffn {C Macro} PyODict_SIZE (od)
@end deffn

@tab

@ref{5027,,PyDict_GET_SIZE()}

@end multitable


@node Objeto Set,,Objetos dicionários,Coleções
@anchor{c-api/set doc}@anchor{5042}@anchor{c-api/set set-objects}@anchor{5043}@anchor{c-api/set setobjects}@anchor{5044}@anchor{c-api/set translation-repo}@anchor{5045}
@subsubsection Objeto Set


@geindex objeto;set
@geindex objeto;frozenset

Esta seção detalha a API pública para os objetos @ref{5d9,,set} e @ref{5da,,frozenset}. Qualquer funcionalidade não listada abaixo é melhor acessada usando o protocolo de objeto abstrato (incluindo @ref{39f,,PyObject_CallMethod()}, @ref{1b1b,,PyObject_RichCompareBool()}, @ref{403,,PyObject_Hash()}, @ref{1067,,PyObject_Repr()}, @ref{4d30,,PyObject_IsTrue()}, @ref{16dc,,PyObject_Print()} e @ref{4d2f,,PyObject_GetIter()}) ou o protocolo abstrato de número (incluindo @ref{4d03,,PyNumber_And()}, @ref{4d1c,,PyNumber_Subtract()}, @ref{4d17,,PyNumber_Or()}, @ref{4d1e,,PyNumber_Xor()}, @ref{4d08,,PyNumber_InPlaceAnd()}, @ref{4d10,,PyNumber_InPlaceSubtract()}, @ref{4d0c,,PyNumber_InPlaceOr()} e @ref{4d12,,PyNumber_InPlaceXor()}).

@geindex PySetObject (C type)
@anchor{c-api/set c PySetObject}@anchor{5046}
@deffn {C Tipo} type PySetObject

Este subtipo de @ref{339,,PyObject} é usado para manter os dados internos para ambos os objetos @ref{5d9,,set} e @ref{5da,,frozenset}. É como um @ref{3c1,,PyDictObject} em que tem um tamanho fixo para conjuntos pequenos (muito parecido com o armazenamento de tupla) e apontará para um bloco de memória de tamanho variável separado para conjuntos de tamanho médio e grande (muito parecido com lista armazenamento). Nenhum dos campos desta estrutura deve ser considerado público e todos estão sujeitos a alterações. Todo o acesso deve ser feito por meio da API documentada, em vez de manipular os valores na estrutura.
@end deffn

@geindex PySet_Type (C var)
@anchor{c-api/set c PySet_Type}@anchor{4d4f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PySet_Type
` Parte da @ref{553,,ABI Estável}.'
Essa é uma instância de @ref{ab4,,PyTypeObject} representando o tipo Python @ref{5d9,,set}
@end deffn

@geindex PyFrozenSet_Type (C var)
@anchor{c-api/set c PyFrozenSet_Type}@anchor{4cc5}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFrozenSet_Type
` Parte da @ref{553,,ABI Estável}.'
Esta é uma instância de @ref{ab4,,PyTypeObject} representando o tipo Python @ref{5da,,frozenset}.
@end deffn

As macros de verificação de tipo a seguir funcionam em ponteiros para qualquer objeto Python. Da mesma forma, as funções construtoras funcionam com qualquer objeto Python iterável.

@geindex PySet_Check (C function)
@anchor{c-api/set c PySet_Check}@anchor{5047}
@deffn {C Função} int PySet_Check (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5d9,,set} ou uma instância de um subtipo. Esta função sempre tem sucesso.
@end deffn

@geindex PyFrozenSet_Check (C function)
@anchor{c-api/set c PyFrozenSet_Check}@anchor{5048}
@deffn {C Função} int PyFrozenSet_Check (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5da,,frozenset} ou uma instância de um subtipo. Esta função sempre tem sucesso.
@end deffn

@geindex PyAnySet_Check (C function)
@anchor{c-api/set c PyAnySet_Check}@anchor{5049}
@deffn {C Função} int PyAnySet_Check (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5d9,,set}, um objeto @ref{5da,,frozenset} ou uma instância de um subtipo. Esta função sempre tem sucesso.
@end deffn

@geindex PySet_CheckExact (C function)
@anchor{c-api/set c PySet_CheckExact}@anchor{8a1}
@deffn {C Função} int PySet_CheckExact (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5d9,,set}, mas não uma instância de um subtipo. Esta função sempre tem sucesso.


Adicionado na versão 3.10.

@end deffn

@geindex PyAnySet_CheckExact (C function)
@anchor{c-api/set c PyAnySet_CheckExact}@anchor{504a}
@deffn {C Função} int PyAnySet_CheckExact (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5d9,,set} ou um objeto @ref{5da,,frozenset}, mas não uma instância de um subtipo. Esta função sempre tem sucesso.
@end deffn

@geindex PyFrozenSet_CheckExact (C function)
@anchor{c-api/set c PyFrozenSet_CheckExact}@anchor{504b}
@deffn {C Função} int PyFrozenSet_CheckExact (PyObject *p)

Retorna verdadeiro se `p' for um objeto @ref{5da,,frozenset}, mas não uma instância de um subtipo. Esta função sempre tem sucesso.
@end deffn

@geindex PySet_New (C function)
@anchor{c-api/set c PySet_New}@anchor{148c}
@deffn {C Função} @ref{339,,PyObject} *PySet_New (PyObject *iterable)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma nova @ref{5d9,,set} contendo objetos retornados pelo iterável `iterable'. O `iterable' pode ser @code{NULL} para criar um novo conjunto vazio. Retorna o novo conjunto em caso de sucesso ou @code{NULL} em caso de falha. Levanta @ref{2c3,,TypeError} se `iterable' não for realmente iterável. O construtor também é útil para copiar um conjunto (@code{c=set(s)}).
@end deffn

@geindex PyFrozenSet_New (C function)
@anchor{c-api/set c PyFrozenSet_New}@anchor{148d}
@deffn {C Função} @ref{339,,PyObject} *PyFrozenSet_New (PyObject *iterable)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma nova @ref{5da,,frozenset} contendo objetos retornados pelo iterável `iterable'. O `iterable' pode ser @code{NULL} para criar um novo frozenset vazio. Retorna o novo conjunto em caso de sucesso ou @code{NULL} em caso de falha. Levanta @ref{2c3,,TypeError} se `iterable' não for realmente iterável.
@end deffn

As seguintes funções e macros estão disponíveis para instâncias de @ref{5d9,,set} ou @ref{5da,,frozenset} ou instâncias de seus subtipos.

@geindex PySet_Size (C function)
@anchor{c-api/set c PySet_Size}@anchor{1491}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySet_Size (PyObject *anyset)
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;len

Retorna o comprimento de um objeto @ref{5d9,,set} ou @ref{5da,,frozenset}. Equivalente a @code{len(anyset)}. Levanta um @ref{575,,SystemError} se `anyset' não for um @ref{5d9,,set}, @ref{5da,,frozenset}, ou uma instância de um subtipo.
@end deffn

@geindex PySet_GET_SIZE (C function)
@anchor{c-api/set c PySet_GET_SIZE}@anchor{504c}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySet_GET_SIZE (PyObject *anyset)

Forma macro de @ref{1491,,PySet_Size()} sem verificação de erros.
@end deffn

@geindex PySet_Contains (C function)
@anchor{c-api/set c PySet_Contains}@anchor{1490}
@deffn {C Função} int PySet_Contains (PyObject *anyset, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se encontrado, @code{0} se não encontrado, e @code{-1} se um erro é encontrado. Ao contrário do método Python @ref{1400,,__contains__()}, esta função não converte automaticamente conjuntos não hasheáveis em frozensets temporários. Levanta um @ref{2c3,,TypeError} se a `key' não for hasheável. Levanta @ref{575,,SystemError} se `anyset' não é um @ref{5d9,,set}, @ref{5da,,frozenset}, ou uma instância de um subtipo.
@end deffn

@geindex PySet_Add (C function)
@anchor{c-api/set c PySet_Add}@anchor{148e}
@deffn {C Função} int PySet_Add (PyObject *set, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Adiciona `key' a uma instância de @ref{5d9,,set}. Também funciona com instâncias de @ref{5da,,frozenset} (como @ref{4b62,,PyTuple_SetItem()}, ele pode ser usado para preencher os valores de novos conjuntos de congelamentos antes que eles sejam expostos a outro código). Retorna @code{0} em caso de sucesso ou @code{-1} em caso de falha. Levanta um @ref{2c3,,TypeError} se a `key' não for hasheável. Levanta uma @ref{15c5,,MemoryError} se não houver espaço para crescer. Levanta uma @ref{575,,SystemError} se `set' não for uma instância de @ref{5d9,,set} ou seu subtipo.
@end deffn

As seguintes funções estão disponíveis para instâncias de @ref{5d9,,set} ou seus subtipos, mas não para instâncias de @ref{5da,,frozenset} ou seus subtipos.

@geindex PySet_Discard (C function)
@anchor{c-api/set c PySet_Discard}@anchor{148f}
@deffn {C Função} int PySet_Discard (PyObject *set, PyObject *key)
` Parte da @ref{553,,ABI Estável}.'
Retorna @code{1} se encontrado e removido, @code{0} se não encontrado (nenhuma ação realizada) e @code{-1} se um erro for encontrado. Não levanta @ref{344,,KeyError} para chaves ausentes. Levanta uma @ref{2c3,,TypeError} se a `key' não for hasheável. Ao contrário do método Python @ref{23d4,,discard()}, esta função não converte automaticamente conjuntos não hasheáveis em frozensets temporários. Levanta @ref{575,,SystemError} se `set' não é uma instância de @ref{5d9,,set} ou seu subtipo.
@end deffn

@geindex PySet_Pop (C function)
@anchor{c-api/set c PySet_Pop}@anchor{4d4e}
@deffn {C Função} @ref{339,,PyObject} *PySet_Pop (PyObject *set)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma nova referência a um objeto arbitrário no `set' e remove o objeto do `set'. Retorna @code{NULL} em caso de falha. Levanta @ref{344,,KeyError} se o conjunto estiver vazio. Levanta uma @ref{575,,SystemError} se `set' não for uma instância de @ref{5d9,,set} ou seu subtipo.
@end deffn

@geindex PySet_Clear (C function)
@anchor{c-api/set c PySet_Clear}@anchor{4d4d}
@deffn {C Função} int PySet_Clear (PyObject *set)
` Parte da @ref{553,,ABI Estável}.'
Esvazia um conjunto existente de todos os elementos. Retorna @code{0} em caso de sucesso. Retorna @code{-1} e levanta @ref{575,,SystemError} se `set' não for uma instância de @ref{5d9,,set} ou seu subtipo.
@end deffn

@node Objetos Function<2>,Outros Objetos,Coleções,Camada de Objetos Concretos
@anchor{c-api/concrete function-objects}@anchor{504d}@anchor{c-api/concrete otherobjects}@anchor{504e}
@subsection Objetos Function


@menu
* Objetos Function: Objetos Function<3>. 
* Objetos de Método de Instância:: 
* Objetos método: Objetos método<2>. 
* Objeto célula:: 
* Objetos código: Objetos código<3>. 
* Sinalizadores de objetos código:: 
* Informação adicional:: 

@end menu

@node Objetos Function<3>,Objetos de Método de Instância,,Objetos Function<2>
@anchor{c-api/function doc}@anchor{504f}@anchor{c-api/function function-objects}@anchor{5050}@anchor{c-api/function id1}@anchor{5051}
@subsubsection Objetos Function


@geindex objeto;função

Existem algumas funções específicas para as funções do Python.

@geindex PyFunctionObject (C type)
@anchor{c-api/function c PyFunctionObject}@anchor{561}
@deffn {C Tipo} type PyFunctionObject

A estrutura C usada para funções.
@end deffn

@geindex PyFunction_Type (C var)
@anchor{c-api/function c PyFunction_Type}@anchor{5052}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFunction_Type

@geindex MethodType (em tipos de módulos)

Esta é uma instância de @ref{ab4,,PyTypeObject} e representa o tipo de função Python. Está exposta a programadores Python como @code{types.FunctionType}.
@end deffn

@geindex PyFunction_Check (C function)
@anchor{c-api/function c PyFunction_Check}@anchor{5053}
@deffn {C Função} int PyFunction_Check (PyObject *o)

Retorna verdadeiro se `o' for um objeto função (tem tipo @ref{5052,,PyFunction_Type}). O parâmetro não deve ser @code{NULL}. Esta função sempre obtém sucesso.
@end deffn

@geindex PyFunction_New (C function)
@anchor{c-api/function c PyFunction_New}@anchor{5054}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_New (PyObject *code, PyObject *globals)
`Retorna valor: Nova referência.'
Retorna um novo objeto função associado ao objeto código `code'. `globals' deve ser um dicionário com as variáveis globais acessíveis à função.

O nome e `docstring' da função são adquiridos pelo objeto código. O atributo @ref{208e,,__module__} é adquirido por meio de `globals'. Os valores-padrão de argumentos, anotações, e fechamento são definidos como @code{NULL}. O atributo @ref{208d,,__qualname__} é definido com o mesmo valor do campo @ref{20c9,,co_qualname} de um objeto código.
@end deffn

@geindex PyFunction_NewWithQualName (C function)
@anchor{c-api/function c PyFunction_NewWithQualName}@anchor{5055}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_NewWithQualName (PyObject *code, PyObject *globals, PyObject *qualname)
`Retorna valor: Nova referência.'
Similar a @ref{5054,,PyFunction_New()}, mas também permite definir o atributo @ref{208d,,__qualname__} do objeto função. `qualname' deve ser um objeto Unicode ou @code{NULL}. Se @code{NULL}, o atributo @code{__qualname__} é definido com o mesmo valor do campo @ref{20c9,,co_qualname} do objeto código.


Adicionado na versão 3.3.

@end deffn

@geindex PyFunction_GetCode (C function)
@anchor{c-api/function c PyFunction_GetCode}@anchor{5056}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetCode (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna o objeto código associado ao objeto função `op'.
@end deffn

@geindex PyFunction_GetGlobals (C function)
@anchor{c-api/function c PyFunction_GetGlobals}@anchor{5057}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetGlobals (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna o dicionário global associado ao objeto função `op'.
@end deffn

@geindex PyFunction_GetModule (C function)
@anchor{c-api/function c PyFunction_GetModule}@anchor{5058}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetModule (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna uma @ref{33e,,referência emprestada} ao atributo @ref{208e,,__module__} do @ref{299,,objeto função} `op'. Pode ser @cite{NULL}.

Normalmente, trata-se de um @ref{44c,,string} contendo o nome do módulo, mas pode ser definido como qualquer outro objeto pelo código Python.
@end deffn

@geindex PyFunction_GetDefaults (C function)
@anchor{c-api/function c PyFunction_GetDefaults}@anchor{5059}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetDefaults (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna os valores-padrão de argumentos do objeto função `op'. Pode ser uma tupla de argumentos ou @code{NULL}.
@end deffn

@geindex PyFunction_SetDefaults (C function)
@anchor{c-api/function c PyFunction_SetDefaults}@anchor{505a}
@deffn {C Função} int PyFunction_SetDefaults (PyObject *op, PyObject *defaults)

Define os valores-padrão dos argumentos do objeto função `op'. `defaults' deve ser @code{Py_None} ou uma tupla.

Levanta @ref{575,,SystemError} e retorna @code{-1} em caso de falha.
@end deffn

@geindex PyFunction_SetVectorcall (C function)
@anchor{c-api/function c PyFunction_SetVectorcall}@anchor{560}
@deffn {C Função} void PyFunction_SetVectorcall (PyFunctionObject *func, vectorcallfunc vectorcall)

Define o campo `vectorcall' de um objeto função `func'.

Atenção: extensões que usam essa API devem preservar o comportamento inalterado (padrão) de uma função `vectorcall'!


Adicionado na versão 3.12.

@end deffn

@geindex PyFunction_GetKwDefaults (C function)
@anchor{c-api/function c PyFunction_GetKwDefaults}@anchor{505b}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetKwDefaults (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna os valores-padrão de argumentos somente-nomeados do objeto função `op'. Pode ser um dicionário de argumentos ou @code{NULL}.
@end deffn

@geindex PyFunction_SetKwDefaults (C function)
@anchor{c-api/function c PyFunction_SetKwDefaults}@anchor{505c}
@deffn {C Função} int PyFunction_SetKwDefaults (PyObject *op, PyObject *defaults)

Define os valores padrão dos argumentos somente-nomeados do objeto função `op'. `defaults' deve ser um dicionário de argumentos somente-nomeados ou @code{Py_None}.

Esta função retorna @code{0} em caso de sucesso e retorna @code{-1} com uma exceção definida em caso de falha.
@end deffn

@geindex PyFunction_GetClosure (C function)
@anchor{c-api/function c PyFunction_GetClosure}@anchor{505d}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetClosure (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna o fechamento associado ao objeto função `op'. Pode ser @code{NULL} ou uma tupla de objetos célula.
@end deffn

@geindex PyFunction_SetClosure (C function)
@anchor{c-api/function c PyFunction_SetClosure}@anchor{505e}
@deffn {C Função} int PyFunction_SetClosure (PyObject *op, PyObject *closure)

Define o fechamento associado ao objeto função `op'. `closure' deve ser @code{Py_None} ou uma tupla de objetos de célula.

Levanta @ref{575,,SystemError} e retorna @code{-1} em caso de falha.
@end deffn

@geindex PyFunction_GetAnnotations (C function)
@anchor{c-api/function c PyFunction_GetAnnotations}@anchor{18bf}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GetAnnotations (PyObject *op)
`Retorna valor: Referência emprestada.'
Retorna as anotações do objeto função `op'. Este pode ser um dicionário mutável ou @code{NULL}.
@end deffn

@geindex PyFunction_SetAnnotations (C function)
@anchor{c-api/function c PyFunction_SetAnnotations}@anchor{505f}
@deffn {C Função} int PyFunction_SetAnnotations (PyObject *op, PyObject *annotations)

Define as anotações para o objeto função `op'. `annotations' deve ser um dicionário ou @code{Py_None}.

Levanta @ref{575,,SystemError} e retorna @code{-1} em caso de falha.
@end deffn

@geindex PyFunction_GET_CODE (C function)
@geindex PyFunction_GET_GLOBALS (C function)
@geindex PyFunction_GET_MODULE (C function)
@geindex PyFunction_GET_DEFAULTS (C function)
@geindex PyFunction_GET_KW_DEFAULTS (C function)
@geindex PyFunction_GET_CLOSURE (C function)
@geindex PyFunction_GET_ANNOTATIONS (C function)
@anchor{c-api/function c PyFunction_GET_CODE}@anchor{5060}
@deffn {C Função} @ref{339,,PyObject} *PyFunction_GET_CODE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_GLOBALS}@anchor{5061}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_GLOBALS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_MODULE}@anchor{5062}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_MODULE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_DEFAULTS}@anchor{5063}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_DEFAULTS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_KW_DEFAULTS}@anchor{5064}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_KW_DEFAULTS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_CLOSURE}@anchor{5065}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_CLOSURE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_ANNOTATIONS}@anchor{5066}
@deffnx {C Função} @ref{339,,PyObject} *PyFunction_GET_ANNOTATIONS (PyObject *op)
`Retorna valor: Referência emprestada.'
Essas funções são semelhantes às suas contrapartes @code{PyFunction_Get*}, mas não realizam verificação de tipos. Passar qualquer coisa que não seja uma instância de @ref{5052,,PyFunction_Type} é um comportamento indefinido.
@end deffn

@geindex PyFunction_AddWatcher (C function)
@anchor{c-api/function c PyFunction_AddWatcher}@anchor{5067}
@deffn {C Função} int PyFunction_AddWatcher (PyFunction_WatchCallback callback)

Registra `callback' como uma sentinela de função para o interpretador atual. Retorna um ID que pode ser passado para @ref{5068,,PyFunction_ClearWatcher()}. Em caso de erro (por exemplo, sem novos IDs de sentinelas disponíveis), retorna @code{-1} e define uma exceção.


Adicionado na versão 3.12.

@end deffn

@geindex PyFunction_ClearWatcher (C function)
@anchor{c-api/function c PyFunction_ClearWatcher}@anchor{5068}
@deffn {C Função} int PyFunction_ClearWatcher (int watcher_id)

Cancela o registro da sentinela identificada pelo `watcher_id' retornado por @ref{5067,,PyFunction_AddWatcher()} para o interpretador atual. Retorna @code{0} em caso de sucesso, ou @code{-1} e define uma exceção em caso de erro (por exemplo, ao receber um `watcher_id' desconhecido.)


Adicionado na versão 3.12.

@end deffn

@geindex PyFunction_WatchEvent (C type)
@anchor{c-api/function c PyFunction_WatchEvent}@anchor{5069}
@deffn {C Tipo} type PyFunction_WatchEvent

@quotation

Enumeração de possíveis eventos do observador de funções:


@itemize -

@item 
@code{PyFunction_EVENT_CREATE}

@item 
@code{PyFunction_EVENT_DESTROY}

@item 
@code{PyFunction_EVENT_MODIFY_CODE}

@item 
@code{PyFunction_EVENT_MODIFY_DEFAULTS}

@item 
@code{PyFunction_EVENT_MODIFY_KWDEFAULTS}
@end itemize
@end quotation


Adicionado na versão 3.12.

@end deffn

@geindex PyFunction_WatchCallback (C type)
@anchor{c-api/function c PyFunction_WatchCallback}@anchor{506a}
@deffn {C Tipo} typedef int (*PyFunction_WatchCallback)(@ref{5069,,PyFunction_WatchEvent} event, @ref{561,,PyFunctionObject} *func, @ref{339,,PyObject} *new_value)

Tipo de uma função de retorno de sentinela de função.

Se `event' for @code{PyFunction_EVENT_CREATE} ou @code{PyFunction_EVENT_DESTROY}, `new_value' será @code{NULL}. Senão, `new_value' portará uma @ref{33e,,referência emprestada} ao novo valor prestes a ser guardado em `func' para o atributo que está sendo modificado.

A função de retorno poderá somente inspecionar, e não modificar `func'. Caso contrário, poderíamos ter efeitos imprevisíveis, incluindo recursão infinita.

Se `event' for @code{PyFunction_EVENT_CREATE}, a função de retorno será invocada após `func' ter sido completamente inicializada. Caso contrário, a função de retorno será invocada antes de modificar `func', então o estado anterior de `func' poderá ser inspecionado. O ambiente de execução pode otimizar a criação de objetos função, quando possível, ao ignorá-las. Nesses casos, nenhum evento será emitido. Apesar de decisões de otimização criarem diferenças de comportamento em tempo de execução, elas não mudam a semântica do código Python sendo executado.

Se `event' for @code{PyFunction_EVENT_DESTROY}, então obter uma referência dentro da função de retorno para a função prestes a ser destruída irá revivê-la, impedindo que esta função seja liberada nesse tempo. Quando o objeto revivido for destruído, quaisquer funções de retorno sentinelas ativas nesse momento poderão ser chamadas novamente.

Se a função de retorno definir uma exceção, ela deverá retornar @code{-1}. Essa exceção será exibida como uma exceção não levantável usando @ref{34d,,PyErr_WriteUnraisable()}. Caso contrário, deverá retornar @code{0}.

É possível que já exista uma exceção pendente definida na entrada da função de retorno. Nesse caso, a função de retorno deve retornar @code{0} com a mesma exceção ainda definida. Isso significa que a função de retorno não pode chamar nenhuma outra API que possa definir uma exceção, a menos que salve e limpe o estado da exceção primeiro e restaure a exceção antes de retornar.


Adicionado na versão 3.12.

@end deffn

@node Objetos de Método de Instância,Objetos método<2>,Objetos Function<3>,Objetos Function<2>
@anchor{c-api/method doc}@anchor{506b}@anchor{c-api/method instance-method-objects}@anchor{506c}@anchor{c-api/method instancemethod-objects}@anchor{506d}@anchor{c-api/method translation-repo}@anchor{506e}
@subsubsection Objetos de Método de Instância


@geindex objeto;instancemethod

Um método de instância é um invólucro para um @ref{14c0,,PyCFunction} e a nova maneira de vincular um @ref{14c0,,PyCFunction} a um objeto classe. Ele substitui a chamada anterior @code{PyMethod_New(func, NULL, class)}.

@geindex PyInstanceMethod_Type (C var)
@anchor{c-api/method c PyInstanceMethod_Type}@anchor{506f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyInstanceMethod_Type

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de método de instância Python. Não é exposto a programas Python.
@end deffn

@geindex PyInstanceMethod_Check (C function)
@anchor{c-api/method c PyInstanceMethod_Check}@anchor{5070}
@deffn {C Função} int PyInstanceMethod_Check (PyObject *o)

Retorna verdadeiro se `o' é um objeto de método de instância (tem tipo @ref{506f,,PyInstanceMethod_Type}). O parâmetro não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyInstanceMethod_New (C function)
@anchor{c-api/method c PyInstanceMethod_New}@anchor{5071}
@deffn {C Função} @ref{339,,PyObject} *PyInstanceMethod_New (PyObject *func)
`Retorna valor: Nova referência.'
Retorna um novo objeto de método de instância, com `func' sendo qualquer objeto chamável. `func' é a função que será chamada quando o método de instância for chamado.
@end deffn

@geindex PyInstanceMethod_Function (C function)
@anchor{c-api/method c PyInstanceMethod_Function}@anchor{5072}
@deffn {C Função} @ref{339,,PyObject} *PyInstanceMethod_Function (PyObject *im)
`Retorna valor: Referência emprestada.'
Retorna o objeto função associado ao método de instância `im'.
@end deffn

@geindex PyInstanceMethod_GET_FUNCTION (C function)
@anchor{c-api/method c PyInstanceMethod_GET_FUNCTION}@anchor{5073}
@deffn {C Função} @ref{339,,PyObject} *PyInstanceMethod_GET_FUNCTION (PyObject *im)
`Retorna valor: Referência emprestada.'
Versão macro de @ref{5072,,PyInstanceMethod_Function()} que evita a verificação de erros.
@end deffn

@node Objetos método<2>,Objeto célula,Objetos de Método de Instância,Objetos Function<2>
@anchor{c-api/method id1}@anchor{5074}@anchor{c-api/method method-objects}@anchor{5075}
@subsubsection Objetos método


@geindex objeto;método

Métodos são objetos função vinculados. Os métodos são sempre associados a uma instância de uma classe definida pelo usuário. Métodos não vinculados (métodos vinculados a um objeto de classe) não estão mais disponíveis.

@geindex PyMethod_Type (C var)
@anchor{c-api/method c PyMethod_Type}@anchor{5076}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyMethod_Type

@geindex MethodType (em tipos de módulos)

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de método Python. Isso é exposto a programas Python como @code{types.MethodType}.
@end deffn

@geindex PyMethod_Check (C function)
@anchor{c-api/method c PyMethod_Check}@anchor{5077}
@deffn {C Função} int PyMethod_Check (PyObject *o)

Retorna verdadeiro se `o' é um objeto de método (tem tipo @ref{5076,,PyMethod_Type}). O parâmetro não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyMethod_New (C function)
@anchor{c-api/method c PyMethod_New}@anchor{5078}
@deffn {C Função} @ref{339,,PyObject} *PyMethod_New (PyObject *func, PyObject *self)
`Retorna valor: Nova referência.'
Retorna um novo objeto de método, com `func' sendo qualquer objeto chamável e `self' a instância à qual o método deve ser vinculado. `func' é a função que será chamada quando o método for chamado. `self' não deve ser @code{NULL}.
@end deffn

@geindex PyMethod_Function (C function)
@anchor{c-api/method c PyMethod_Function}@anchor{5079}
@deffn {C Função} @ref{339,,PyObject} *PyMethod_Function (PyObject *meth)
`Retorna valor: Referência emprestada.'
Retorna o objeto função associado ao método `meth'.
@end deffn

@geindex PyMethod_GET_FUNCTION (C function)
@anchor{c-api/method c PyMethod_GET_FUNCTION}@anchor{507a}
@deffn {C Função} @ref{339,,PyObject} *PyMethod_GET_FUNCTION (PyObject *meth)
`Retorna valor: Referência emprestada.'
Versão macro de @ref{5079,,PyMethod_Function()} que evita a verificação de erros.
@end deffn

@geindex PyMethod_Self (C function)
@anchor{c-api/method c PyMethod_Self}@anchor{507b}
@deffn {C Função} @ref{339,,PyObject} *PyMethod_Self (PyObject *meth)
`Retorna valor: Referência emprestada.'
Retorna a instância associada com o método `meth'.
@end deffn

@geindex PyMethod_GET_SELF (C function)
@anchor{c-api/method c PyMethod_GET_SELF}@anchor{507c}
@deffn {C Função} @ref{339,,PyObject} *PyMethod_GET_SELF (PyObject *meth)
`Retorna valor: Referência emprestada.'
Versão macro de @ref{507b,,PyMethod_Self()} que evita a verificação de erros.
@end deffn

@node Objeto célula,Objetos código<3>,Objetos método<2>,Objetos Function<2>
@anchor{c-api/cell doc}@anchor{507d}@anchor{c-api/cell cell-objects}@anchor{701}@anchor{c-api/cell id1}@anchor{507e}@anchor{c-api/cell translation-repo}@anchor{507f}
@subsubsection Objeto célula


Objetos “cell” são usados para implementar variáveis referenciadas por múltiplos escopos. Para cada variável, um objeto célula é criado para armazenar o valor; as variáveis locais de cada quadro de pilha que referencia o valor contêm uma referência para as células de escopos externos que também usam essa variável. Quando o valor é acessado, o valor contido na célula é usado em vez do próprio objeto da célula. Essa des-referência do objeto da célula requer suporte do código de bytes gerado; estes não são automaticamente desprezados quando acessados. Objetos de células provavelmente não serão úteis em outro lugar.

@geindex PyCellObject (C type)
@anchor{c-api/cell c PyCellObject}@anchor{5080}
@deffn {C Tipo} type PyCellObject

A estrutura C usada para objetos célula.
@end deffn

@geindex PyCell_Type (C var)
@anchor{c-api/cell c PyCell_Type}@anchor{5081}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCell_Type

O objeto de tipo correspondente aos objetos célula.
@end deffn

@geindex PyCell_Check (C function)
@anchor{c-api/cell c PyCell_Check}@anchor{5082}
@deffn {C Função} int PyCell_Check (PyObject *ob)

Retorna verdadeiro se `ob' for um objeto célula; `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyCell_New (C function)
@anchor{c-api/cell c PyCell_New}@anchor{5083}
@deffn {C Função} @ref{339,,PyObject} *PyCell_New (PyObject *ob)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto célula contendo o valor `ob'. O parâmetro pode ser @code{NULL}.
@end deffn

@geindex PyCell_Get (C function)
@anchor{c-api/cell c PyCell_Get}@anchor{5084}
@deffn {C Função} @ref{339,,PyObject} *PyCell_Get (PyObject *cell)
`Retorna valor: Nova referência.'
Retorna o conteúdo da célula `cell', que pode ser @code{NULL}. Se `cell' não for um objeto célula, retorna @code{NULL} com um conjunto de exceções.
@end deffn

@geindex PyCell_GET (C function)
@anchor{c-api/cell c PyCell_GET}@anchor{5085}
@deffn {C Função} @ref{339,,PyObject} *PyCell_GET (PyObject *cell)
`Retorna valor: Referência emprestada.'
Retorna o conteúdo da célula `cell', mas sem verificar se `cell' não é @code{NULL} e um objeto célula.
@end deffn

@geindex PyCell_Set (C function)
@anchor{c-api/cell c PyCell_Set}@anchor{5086}
@deffn {C Função} int PyCell_Set (PyObject *cell, PyObject *value)

Define o conteúdo do objeto da célula `cell' como `value'. Isso libera a referência a qualquer conteúdo atual da célula. `value' pode ser @code{NULL}. `cell' não pode ser @code{NULL}.

Em caso de sucesso, retorna @code{0}. Se `cell' não for um objeto célula, define uma exceção e retorna @code{-1}.
@end deffn

@geindex PyCell_SET (C function)
@anchor{c-api/cell c PyCell_SET}@anchor{8b3}
@deffn {C Função} void PyCell_SET (PyObject *cell, PyObject *value)

Define o valor do objeto da célula `cell' como `value'. Nenhuma contagem de referência é ajustada e nenhuma verificação é feita quanto à segurança; `cell' não pode ser @code{NULL} e deve ser um objeto célula.
@end deffn

@geindex objeto;código
@geindex objeto código

@node Objetos código<3>,Sinalizadores de objetos código,Objeto célula,Objetos Function<2>
@anchor{c-api/code doc}@anchor{5087}@anchor{c-api/code code-objects}@anchor{5088}@anchor{c-api/code codeobjects}@anchor{5b5}@anchor{c-api/code translation-repo}@anchor{5089}
@subsubsection Objetos código


Os objetos código são um detalhe de baixo nível da implementação do CPython. Cada um representa um pedaço de código executável que ainda não foi vinculado a uma função.

@geindex PyCodeObject (C type)
@anchor{c-api/code c PyCodeObject}@anchor{777}
@deffn {C Tipo} type PyCodeObject

A estrutura C dos objetos usados para descrever objetos código. Os campos deste tipo estão sujeitos a alterações a qualquer momento.
@end deffn

@geindex PyCode_Type (C var)
@anchor{c-api/code c PyCode_Type}@anchor{508a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCode_Type

Esta é uma instância de @ref{ab4,,PyTypeObject} representando o @ref{1d2,,objeto código} Python.
@end deffn

@geindex PyCode_Check (C function)
@anchor{c-api/code c PyCode_Check}@anchor{508b}
@deffn {C Função} int PyCode_Check (PyObject *co)

Retorna verdadeiro se `co' for um @ref{1d2,,objeto código}. Esta função sempre tem sucesso.
@end deffn

@geindex PyCode_GetNumFree (C function)
@anchor{c-api/code c PyCode_GetNumFree}@anchor{508c}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyCode_GetNumFree (PyCodeObject *co)

Retorna o número de @ref{20d1,,variáveis livres (de clausura)} em um objeto código.
@end deffn

@geindex PyUnstable_Code_GetFirstFree (C function)
@anchor{c-api/code c PyUnstable_Code_GetFirstFree}@anchor{386}
@deffn {C Função} int PyUnstable_Code_GetFirstFree (PyCodeObject *co)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Retorna a posição da primeira @ref{20d1,,variável livre (de clausura)} em um objeto código.


Alterado na versão 3.13: Renomeado de @code{PyCode_GetFirstFree} como parte da @ref{547,,API C Instável}. O nome antigo foi descontinuado, mas continuará disponível até que a assinatura mude novamente.

@end deffn

@geindex PyUnstable_Code_New (C function)
@anchor{c-api/code c PyUnstable_Code_New}@anchor{508d}
@deffn {C Função} @ref{777,,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 Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Devolve um novo objeto código. Se precisar de um objeto código vazio para criar um quadro, use @ref{1396,,PyCode_NewEmpty()}

Como a definição de bytecode muda constantemente, chamar @ref{508d,,PyUnstable_Code_New()} diretamente pode vinculá-lo a uma versão de Python específica.

Os vários argumentos desta função são inter-dependentes de maneiras complexas, significando que mesmo alterações discretas de valor tem chances de resultar em execução incorreta ou erros fatais de VM. Tenha extremo cuidado ao usar esta função.


Alterado na versão 3.11: Adicionou os parâmetros @code{qualname} e @code{exceptiontable}


@geindex PyCode_New (função C)


Alterado na versão 3.12: Renomeado de @code{PyCode_New} como parte da @ref{547,,API C Instável}. O nome antigo foi descontinuado, mas continuará disponível até que a assinatura mude novamente.

@end deffn

@geindex PyCode_NewWithPosOnlyArgs (C function)

@geindex PyUnstable_Code_NewWithPosOnlyArgs (C function)
@anchor{c-api/code c PyCode_NewWithPosOnlyArgs}@anchor{508e}@anchor{c-api/code c PyUnstable_Code_NewWithPosOnlyArgs}@anchor{508f}
@deffn {C Função} @ref{777,,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 Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Similar a @ref{508d,,PyUnstable_Code_New()}, mas com um “posonlyargcount” extra para argumentos somente-posicionais. As mesmas ressalvas que se aplicam a @code{PyUnstable_Code_New} também se aplicam a essa função.


Adicionado na versão 3.8: Como @code{PyCode_NewWithPosOnlyArgs}



Alterado na versão 3.11: Adicionados os parâmetros @code{qualname} e @code{exceptiontable}



Alterado na versão 3.12: Renomeado para @code{PyUnstable_Code_NewWithPosOnlyArgs}. O nome antigo foi descontinuado, mas continuará disponível até que a assinatura mude novamente.

@end deffn

@geindex PyCode_NewEmpty (C function)
@anchor{c-api/code c PyCode_NewEmpty}@anchor{1396}
@deffn {C Função} @ref{777,,PyCodeObject} *PyCode_NewEmpty (const char *filename, const char *funcname, int firstlineno)
`Retorna valor: Nova referência.'
Retorna um novo objeto código vazio com o nome de arquivo, nome da função e número da primeira linha especificados. O objeto código resultante irá levantar uma @code{Exception} se executado.
@end deffn

@geindex PyCode_Addr2Line (C function)
@anchor{c-api/code c PyCode_Addr2Line}@anchor{88d}
@deffn {C Função} int PyCode_Addr2Line (PyCodeObject *co, int byte_offset)

Retorna o número da linha da instrução que ocorre em ou antes de @code{byte_offset} e termina depois disso. Se você só precisa do número da linha de um quadro, use @ref{78b,,PyFrame_GetLineNumber()}.

Para iterar eficientemente sobre os números de linha em um objeto código, use 
@geindex Propostas de Melhorias do Python; PEP 0626#out-of-process-debuggers-and-profilers
a API descrita na 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{5b4}
@deffn {C Função} int PyCode_Addr2Location (PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column)

Define os ponteiros @code{int} passados para a linha do código-fonte e os números da coluna para a instrução em @code{byte_offset}. Define o valor como @code{0} quando as informações não estão disponíveis para nenhum elemento em particular.

Retorna @code{1} se a função for bem-sucedida e 0 caso contrário.


Adicionado na versão 3.11.

@end deffn

@geindex PyCode_GetCode (C function)
@anchor{c-api/code c PyCode_GetCode}@anchor{778}
@deffn {C Função} @ref{339,,PyObject} *PyCode_GetCode (PyCodeObject *co)

Equivalente ao código Python @code{getattr(co, 'co_code')}. Retorna uma referência forte a um @ref{792,,PyBytesObject} representando o bytecode em um objeto código. Em caso de erro, @code{NULL} é retornado e uma exceção é levantada.

Este @code{PyBytesObject} pode ser criado sob demanda pelo interpretador e não representa necessariamente o bytecode realmente executado pelo CPython. O caso de uso primário para esta função são depuradores e criadores de perfil.


Adicionado na versão 3.11.

@end deffn

@geindex PyCode_GetVarnames (C function)
@anchor{c-api/code c PyCode_GetVarnames}@anchor{779}
@deffn {C Função} @ref{339,,PyObject} *PyCode_GetVarnames (PyCodeObject *co)

Equivalente ao código Python @code{getattr(co, 'co_varnames')}. Retorna uma nova referência a um @ref{4eac,,PyTupleObject} contendo os nomes das variáveis locais. Em caso de erro, @code{NULL} é retornado e uma exceção é levantada.


Adicionado na versão 3.11.

@end deffn

@geindex PyCode_GetCellvars (C function)
@anchor{c-api/code c PyCode_GetCellvars}@anchor{77a}
@deffn {C Função} @ref{339,,PyObject} *PyCode_GetCellvars (PyCodeObject *co)

Equivalente ao código Python @code{getattr(co, 'co_cellvars')}. Retorna uma nova referência a um @ref{4eac,,PyTupleObject} contendo os nomes das variáveis locais referenciadas por funções aninhadas. Em caso de erro, @code{NULL} é retornado e uma exceção é levantada.


Adicionado na versão 3.11.

@end deffn

@geindex PyCode_GetFreevars (C function)
@anchor{c-api/code c PyCode_GetFreevars}@anchor{77b}
@deffn {C Função} @ref{339,,PyObject} *PyCode_GetFreevars (PyCodeObject *co)

Equivalente ao código Python @code{getattr(co, 'co_freevars')}. Retorna uma nova referência a um @ref{4eac,,PyTupleObject} contendo os nomes das @ref{20d1,,variáveis livres (de clausura)}. Em caso de erro, @code{NULL} é retornado e uma exceção é levantada.


Adicionado na versão 3.11.

@end deffn

@geindex PyCode_AddWatcher (C function)
@anchor{c-api/code c PyCode_AddWatcher}@anchor{566}
@deffn {C Função} int PyCode_AddWatcher (PyCode_WatchCallback callback)

Registra `callback' como um observador do objeto código para o interpretador atual.  Devolve um ID que pode ser passado para @ref{567,,PyCode_ClearWatcher()}. Em caso de erro (por exemplo, não há IDs de observadores disponíveis), devolve @code{-1} e define uma exceção.


Adicionado na versão 3.12.

@end deffn

@geindex PyCode_ClearWatcher (C function)
@anchor{c-api/code c PyCode_ClearWatcher}@anchor{567}
@deffn {C Função} int PyCode_ClearWatcher (int watcher_id)

Libera o observador identificado por `watcher_id' anteriormente retornado por @ref{566,,PyCode_AddWatcher()} para o interpretador atual. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de erro e levanta uma exceção (ex., se o `watcher_id' dado não foi registrado.)


Adicionado na versão 3.12.

@end deffn

@geindex PyCodeEvent (C type)
@anchor{c-api/code c PyCodeEvent}@anchor{5090}
@deffn {C Tipo} type PyCodeEvent

Enumeração dos possíveis eventos de observador do objeto código: @code{PY_CODE_EVENT_CREATE} - @code{PY_CODE_EVENT_DESTROY}


Adicionado na versão 3.12.

@end deffn

@geindex PyCode_WatchCallback (C type)
@anchor{c-api/code c PyCode_WatchCallback}@anchor{5091}
@deffn {C Tipo} typedef int (*PyCode_WatchCallback)(@ref{5090,,PyCodeEvent} event, @ref{777,,PyCodeObject} *co)

Tipo de uma função de callback de observador de objeto código.

Se `evento' é @code{PY_CODE_EVENT_CREATE}, então a função de retorno é invocada após `co' ter sido completamente inicializado. Senão, a função de retorno é invocada antes que a destruição de `co' ocorra, para que o estado anterior de `co' possa ser inspecionado.

Se `evento' for @code{PY_CODE_EVENT_DESTROY}, obter uma referência para a função de retorno do objeto-a-ser-destruído irá reativá-lo e impedirá que o objeto seja liberado. Quando o objeto reativado é posteriormente destruído, qualquer observador de funções de retorno ativos naquele momento serão chamados novamente.

Usuários desta API não devem depender de detalhes internos de implementação em tempo de execução. Tais detalhes podem incluir, mas não estão limitados a: o ordem e o momento exatos da criação e destruição de objetos código. Enquanto alterações nestes detalhes podem resultar em diferenças que são visíveis para os observadores (incluindo se uma função de retorno é chamada ou não), isso não muda a semântica do código Python executado.

Se a função de retorno definir uma exceção, ela deverá retornar @code{-1}. Essa exceção será exibida como uma exceção não levantável usando @ref{34d,,PyErr_WriteUnraisable()}. Caso contrário, deverá retornar @code{0}.

É possível que já exista uma exceção pendente definida na entrada da função de retorno. Nesse caso, a função de retorno deve retornar @code{0} com a mesma exceção ainda definida. Isso significa que a função de retorno não pode chamar nenhuma outra API que possa definir uma exceção, a menos que salve e limpe o estado da exceção primeiro e restaure a exceção antes de retornar.


Adicionado na versão 3.12.

@end deffn

@geindex PyCode_Optimize (C function)
@anchor{c-api/code c PyCode_Optimize}@anchor{5092}
@deffn {C Função} @ref{339,,PyObject} *PyCode_Optimize (PyObject *code, PyObject *consts, PyObject *names, PyObject *lnotab_obj)

Esta é uma função @ref{209,,suavemente descontinuada} que faz nada.

Antes do Python 3.10, essa função realizava otimizações básicas em um objeto código.


Alterado na versão 3.10: Esta função agora não faz nada.

@end deffn

@node Sinalizadores de objetos código,Informação adicional,Objetos código<3>,Objetos Function<2>
@anchor{c-api/code c-codeobject-flags}@anchor{4e76}@anchor{c-api/code code-object-flags}@anchor{5093}
@subsubsection Sinalizadores de objetos código


Objetos código contêm um campo de bits de sinalizadores, que podem ser recuperados como o atributo Python @ref{20d6,,co_flags} (por exemplo, usando @ref{348,,PyObject_GetAttrString()}) e definidos usando um argumento `flags' para @ref{508d,,PyUnstable_Code_New()} e funções semelhantes.

Os sinalizadores cujos nomes começam com @code{CO_FUTURE_} correspondem a recursos normalmente selecionáveis por @ref{189,,instruções future}. Esses sinalizadores podem ser usados em @ref{4e6f,,PyCompilerFlags.cf_flags}. Observe que muitos sinalizadores @code{CO_FUTURE_} são obrigatórios nas versões atuais do Python, e defini-los não tem efeito.

Os seguintes sinalizador estão disponíveis. Para saber o significado delas, consulte a documentação vinculada de seus equivalentes em Python.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@item

@geindex CO_OPTIMIZED (C macro)
@anchor{c-api/code c CO_OPTIMIZED}@anchor{5094}
@deffn {C Macro} CO_OPTIMIZED
@end deffn

@tab

@ref{46fb,,inspect.CO_OPTIMIZED}

@item

@geindex CO_NEWLOCALS (C macro)
@anchor{c-api/code c CO_NEWLOCALS}@anchor{5095}
@deffn {C Macro} CO_NEWLOCALS
@end deffn

@tab

@ref{46fc,,inspect.CO_NEWLOCALS}

@item

@geindex CO_VARARGS (C macro)
@anchor{c-api/code c CO_VARARGS}@anchor{5096}
@deffn {C Macro} CO_VARARGS
@end deffn

@tab

@ref{46fd,,inspect.CO_VARARGS}

@item

@geindex CO_VARKEYWORDS (C macro)
@anchor{c-api/code c CO_VARKEYWORDS}@anchor{5097}
@deffn {C Macro} CO_VARKEYWORDS
@end deffn

@tab

@ref{46fe,,inspect.CO_VARKEYWORDS}

@item

@geindex CO_NESTED (C macro)
@anchor{c-api/code c CO_NESTED}@anchor{5098}
@deffn {C Macro} CO_NESTED
@end deffn

@tab

@ref{46ff,,inspect.CO_NESTED}

@item

@geindex CO_GENERATOR (C macro)
@anchor{c-api/code c CO_GENERATOR}@anchor{5099}
@deffn {C Macro} CO_GENERATOR
@end deffn

@tab

@ref{4700,,inspect.CO_GENERATOR}

@item

@geindex CO_COROUTINE (C macro)
@anchor{c-api/code c CO_COROUTINE}@anchor{509a}
@deffn {C Macro} CO_COROUTINE
@end deffn

@tab

@ref{4701,,inspect.CO_COROUTINE}

@item

@geindex CO_ITERABLE_COROUTINE (C macro)
@anchor{c-api/code c CO_ITERABLE_COROUTINE}@anchor{509b}
@deffn {C Macro} CO_ITERABLE_COROUTINE
@end deffn

@tab

@ref{4702,,inspect.CO_ITERABLE_COROUTINE}

@item

@geindex CO_ASYNC_GENERATOR (C macro)
@anchor{c-api/code c CO_ASYNC_GENERATOR}@anchor{509c}
@deffn {C Macro} CO_ASYNC_GENERATOR
@end deffn

@tab

@ref{4703,,inspect.CO_ASYNC_GENERATOR}

@item

@geindex CO_FUTURE_DIVISION (C macro)
@anchor{c-api/code c CO_FUTURE_DIVISION}@anchor{509d}
@deffn {C Macro} CO_FUTURE_DIVISION
@end deffn

@tab

sem efeito (@ref{46a4,,__future__.division})

@item

@geindex CO_FUTURE_ABSOLUTE_IMPORT (C macro)
@anchor{c-api/code c CO_FUTURE_ABSOLUTE_IMPORT}@anchor{509e}
@deffn {C Macro} CO_FUTURE_ABSOLUTE_IMPORT
@end deffn

@tab

sem efeito (@ref{46a5,,__future__.absolute_import})

@item

@geindex CO_FUTURE_WITH_STATEMENT (C macro)
@anchor{c-api/code c CO_FUTURE_WITH_STATEMENT}@anchor{509f}
@deffn {C Macro} CO_FUTURE_WITH_STATEMENT
@end deffn

@tab

sem efeito (@ref{46a6,,__future__.with_statement})

@item

@geindex CO_FUTURE_PRINT_FUNCTION (C macro)
@anchor{c-api/code c CO_FUTURE_PRINT_FUNCTION}@anchor{50a0}
@deffn {C Macro} CO_FUTURE_PRINT_FUNCTION
@end deffn

@tab

sem efeito (@ref{46a7,,__future__.print_function})

@item

@geindex CO_FUTURE_UNICODE_LITERALS (C macro)
@anchor{c-api/code c CO_FUTURE_UNICODE_LITERALS}@anchor{50a1}
@deffn {C Macro} CO_FUTURE_UNICODE_LITERALS
@end deffn

@tab

sem efeito (@ref{46a8,,__future__.unicode_literals})

@item

@geindex CO_FUTURE_GENERATOR_STOP (C macro)
@anchor{c-api/code c CO_FUTURE_GENERATOR_STOP}@anchor{50a2}
@deffn {C Macro} CO_FUTURE_GENERATOR_STOP
@end deffn

@tab

sem efeito (@ref{46a9,,__future__.generator_stop})

@item

@geindex CO_FUTURE_ANNOTATIONS (C macro)
@anchor{c-api/code c CO_FUTURE_ANNOTATIONS}@anchor{4e75}
@deffn {C Macro} CO_FUTURE_ANNOTATIONS
@end deffn

@tab

@ref{46aa,,__future__.annotations}

@end multitable


@node Informação adicional,,Sinalizadores de objetos código,Objetos Function<2>
@anchor{c-api/code extra-information}@anchor{50a3}
@subsubsection Informação adicional


Para oferece suporte a extensões de baixo nível de avaliação de quadro (frame), tais como compiladores “just-in-time”, é possível anexar dados arbitrários adicionais a objetos código.

Estas funções são parte da camada instável da API C: Essa funcionalidade é um detalhe de implementação do CPython, e a API pode mudar sem avisos de descontinuidade.

@geindex _PyEval_RequestCodeExtraIndex (C function)

@geindex PyUnstable_Eval_RequestCodeExtraIndex (C function)
@anchor{c-api/code c _PyEval_RequestCodeExtraIndex}@anchor{50a4}@anchor{c-api/code c PyUnstable_Eval_RequestCodeExtraIndex}@anchor{50a5}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyUnstable_Eval_RequestCodeExtraIndex (freefunc free)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Retorna um novo e opaco valor de índice usado para adicionar dados a objetos código.

Geralmente, você chama esta função apenas uma vez (por interpretador) e usa o resultado com @code{PyCode_GetExtra} e @code{PyCode_SetExtra} para manipular dados em objetos código individuais.

Se `free' não for @code{NULL}: quando o objeto código é desalocado, `free' será chamado em dados não-@code{NULL} armazenados sob o novo índice. Use @ref{4dc1,,Py_DecRef()} quando armazenar @ref{339,,PyObject}.


Adicionado na versão 3.6: como @code{_PyEval_RequestCodeExtraIndex}



Alterado na versão 3.12: Renomeado para @code{PyUnstable_Eval_RequestCodeExtraIndex}. O nome antigo nome privado foi descontinuado, mas continuará disponível até a mudança da API.

@end deffn

@geindex _PyCode_GetExtra (C function)

@geindex PyUnstable_Code_GetExtra (C function)
@anchor{c-api/code c _PyCode_GetExtra}@anchor{50a6}@anchor{c-api/code c PyUnstable_Code_GetExtra}@anchor{50a7}
@deffn {C Função} int PyUnstable_Code_GetExtra (PyObject *code, Py_ssize_t index, void **extra)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Define `extra' para os dados adicionais armazenados sob o novo índice dado. Retorna 0 em caso de sucesso. Define uma exceção e retorna -1 em caso de erro.

Se nenhum dado foi determinado sob o índice, define `extra' como @code{NULL} e retorna 0 sem definir nenhuma exceção.


Adicionado na versão 3.6: como @code{_PyCode_GetExtra}



Alterado na versão 3.12: Renomeado para @code{PyUnstable_Code_GetExtra}. O nome antigo privado foi descontinuado, mas continuará disponível até a mudança da API.

@end deffn

@geindex _PyCode_SetExtra (C function)

@geindex PyUnstable_Code_SetExtra (C function)
@anchor{c-api/code c _PyCode_SetExtra}@anchor{50a8}@anchor{c-api/code c PyUnstable_Code_SetExtra}@anchor{50a9}
@deffn {C Função} int PyUnstable_Code_SetExtra (PyObject *code, Py_ssize_t index, void *extra)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Define os dados extras armazenados sob o índice dado a `extra'. Retorna 0 em caso de sucesso. Define uma exceção e retorna -1 em caso de erro.


Adicionado na versão 3.6: como @code{_PyCode_SetExtra}



Alterado na versão 3.12: Renomeado para @code{PyUnstable_Code_SetExtra}. O nome antigo privado foi descontinuado, mas continuará disponível até a mudança da API.

@end deffn

@node Outros Objetos,API C para módulos de extensão,Objetos Function<2>,Camada de Objetos Concretos
@anchor{c-api/concrete other-objects}@anchor{50aa}
@subsection Outros Objetos


@menu
* Objetos arquivos:: 
* Objetos do Módulo:: 
* Objetos Iteradores:: 
* Objetos descritores:: 
* Objetos Slice:: 
* Objetos MemoryView:: 
* Objetos buffer serializados com pickle:: 
* Objetos referência fraca: Objetos referência fraca<2>. 
* Capsules: Capsules<2>. 
* Objetos Frame:: 
* Objetos Geradores:: 
* Objetos corrotina: Objetos corrotina<2>. 
* Objetos de variáveis de contexto:: 
* Objetos de indicação de tipos:: 

@end menu

@node Objetos arquivos,Objetos do Módulo,,Outros Objetos
@anchor{c-api/file doc}@anchor{50ab}@anchor{c-api/file file-objects}@anchor{50ac}@anchor{c-api/file fileobjects}@anchor{50ad}
@subsubsection Objetos arquivos


@geindex objeto;arquivo

Essas APIs são uma emulação mínima da API C do Python 2 para objetos arquivo embutidos, que costumavam depender do suporte de E/S em buffer (FILE*) da biblioteca C padrão. No Python 3, arquivos e streams usam o novo módulo @ref{7f,,io}, que define várias camadas sobre a E/S sem buffer de baixo nível do sistema operacional. As funções descritas a seguir são invólucros de conveniência para o C sobre essas novas APIs e são destinadas principalmente para relatórios de erros internos no interpretador; código de terceiros é recomendado para acessar as APIs de @ref{7f,,io}.

@geindex PyFile_FromFd (C function)
@anchor{c-api/file c PyFile_FromFd}@anchor{4cbd}
@deffn {C Função} @ref{339,,PyObject} *PyFile_FromFd (int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um objeto arquivo Python a partir do descritor de arquivo de um arquivo já aberto `fd'. Os argumentos `name', `encoding', `errors' and `newline' podem ser @code{NULL} para usar os padrões; `buffering' pode ser `-1' para usar o padrão. `name' é ignorado e mantido para compatibilidade com versões anteriores. Retorna @code{NULL} em caso de falha. Para uma descrição mais abrangente dos argumentos, consulte a documentação da função @ref{51d,,io.open()}.

@cartouche
@quotation Aviso 
Como os streams do Python têm sua própria camada de buffer, combiná-los com os descritores de arquivo no nível do sistema operacional pode produzir vários problemas (como ordenação inesperada de dados).
@end quotation
@end cartouche


Alterado na versão 3.2: Ignora atributo `name'.

@end deffn

@geindex PyObject_AsFileDescriptor (C function)
@anchor{c-api/file c PyObject_AsFileDescriptor}@anchor{4d24}
@deffn {C Função} int PyObject_AsFileDescriptor (PyObject *p)
` Parte da @ref{553,,ABI Estável}.'
Retorna o descritor de arquivo associado a `p' como um int. Se o objeto for um inteiro, seu valor será retornado. Caso contrário, o método @ref{15d0,,fileno()} do objeto será chamado se existir; o método deve retornar um inteiro, que é retornado como o valor do descritor de arquivo. Define uma exceção e retorna @code{-1} em caso de falha.
@end deffn

@geindex PyFile_GetLine (C function)
@anchor{c-api/file c PyFile_GetLine}@anchor{4cbe}
@deffn {C Função} @ref{339,,PyObject} *PyFile_GetLine (PyObject *p, int n)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex EOFError (exceção embutida)

Equivalente a @code{p.readline([n])}, esta função lê uma linha do objeto `p'. `p' pode ser um objeto arquivo ou qualquer objeto com um método @ref{241f,,readline()}. Se `n' for @code{0}, exatamente uma linha é lida, independentemente do comprimento da linha. Se `n' for maior que @code{0}, não mais do que `n' bytes serão lidos do arquivo; uma linha parcial pode ser retornada. Em ambos os casos, uma string vazia é retornada se o final do arquivo for alcançado imediatamente. Se `n' for menor que @code{0}, entretanto, uma linha é lida independentemente do comprimento, mas @ref{131c,,EOFError} é levantada se o final do arquivo for alcançado imediatamente.
@end deffn

@geindex PyFile_SetOpenCodeHook (C function)
@anchor{c-api/file c PyFile_SetOpenCodeHook}@anchor{181e}
@deffn {C Função} int PyFile_SetOpenCodeHook (Py_OpenCodeHookFunction handler)

Substitui o comportamento normal de @ref{181c,,io.open_code()} para passar seu parâmetro por meio do manipulador fornecido.

O `handler' é uma função do tipo:

@geindex Py_OpenCodeHookFunction (C type)
@anchor{c-api/file c Py_OpenCodeHookFunction}@anchor{50ae}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*Py_OpenCodeHookFunction)(@ref{339,,PyObject}*, void*)

Equivalente de @ref{339,,PyObject} *(*)(@ref{339,,PyObject} *path, void *userData), sendo `path' garantido como sendo @ref{794,,PyUnicodeObject}.
@end deffn

O ponteiro `userData' é passado para a função de gancho. Como as funções de gancho podem ser chamadas de diferentes tempos de execução, esse ponteiro não deve se referir diretamente ao estado do Python.

Como este gancho é usado intencionalmente durante a importação, evite importar novos módulos durante sua execução, a menos que eles estejam congelados ou disponíveis em @code{sys.modules}.

Uma vez que um gancho foi definido, ele não pode ser removido ou substituído, e chamadas posteriores para @ref{181e,,PyFile_SetOpenCodeHook()} irão falhar. Em caso de falha, a função retorna -1 e define uma exceção se o interpretador foi inicializado.

É seguro chamar esta função antes @ref{8b1,,Py_Initialize()}.

Levanta um @ref{19fa,,evento de auditoria} @code{setopencodehook} sem argumentos.


Adicionado na versão 3.8.

@end deffn

@geindex PyFile_OpenCodeObject (C function)
@anchor{c-api/file c PyFile_OpenCodeObject}@anchor{50af}
@deffn {C Função} @ref{339,,PyObject} *PyFile_OpenCodeObject (PyObject *path)

Abre o arquivo `path' com o modo @code{'rb'}. `path' deve ser um objeto Python da classe @ref{44c,,str}. O comportamento desta função pode ser substituído por @ref{181e,,PyFile_SetOpenCodeHook()} para permitir algum pré-processamento do texto.

Isso é análogo a @ref{181c,,io.open_code()} no Python.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} a um objeto arquivo Python. Em caso de falha, esta função retorna @code{NULL} com uma exceção definida.


Adicionado na versão 3.8.

@end deffn

@geindex PyFile_OpenCode (C function)
@anchor{c-api/file c PyFile_OpenCode}@anchor{50b0}
@deffn {C Função} @ref{339,,PyObject} *PyFile_OpenCode (const char *path)

Semelhante a @ref{50af,,PyFile_OpenCodeObject()}, mas `path' é um const char* codificado em UTF-8.


Adicionado na versão 3.8.

@end deffn

@geindex PyFile_WriteObject (C function)
@anchor{c-api/file c PyFile_WriteObject}@anchor{4cbf}
@deffn {C Função} int PyFile_WriteObject (PyObject *obj, PyObject *p, int flags)
` Parte da @ref{553,,ABI Estável}.'
@geindex Py_PRINT_RAW (macro C)

Escreve o objeto `obj' no objeto arquivo `p'. O único sinalizador suportado para `flags' é @ref{4f10,,Py_PRINT_RAW}; se fornecido, o @ref{44c,,str()} do objeto é escrito em vez de @ref{800,,repr()}. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de falha; a exceção apropriada será definida.
@end deffn

@geindex PyFile_WriteString (C function)
@anchor{c-api/file c PyFile_WriteString}@anchor{4cc0}
@deffn {C Função} int PyFile_WriteString (const char *s, PyObject *p)
` Parte da @ref{553,,ABI Estável}.'
Escreve a string `s' no objeto arquivo `p'. Retorna @code{0} em caso de sucesso ou @code{-1} em caso de falha; a exceção apropriada será definida.
@end deffn

@node Objetos do Módulo,Objetos Iteradores,Objetos arquivos,Outros Objetos
@anchor{c-api/module doc}@anchor{50b1}@anchor{c-api/module module-objects}@anchor{50b2}@anchor{c-api/module moduleobjects}@anchor{50b3}@anchor{c-api/module translation-repo}@anchor{50b4}
@subsubsection Objetos do Módulo


@geindex objeto;módulo

@geindex PyModule_Type (C var)
@anchor{c-api/module c PyModule_Type}@anchor{4d00}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyModule_Type
` Parte da @ref{553,,ABI Estável}.'
@geindex ModuleType (in module types)

This instance of @ref{ab4,,PyTypeObject} represents the Python module type.  This
is exposed to Python programs as @ref{e3f,,types.ModuleType}.
@end deffn

@geindex PyModule_Check (C function)
@anchor{c-api/module c PyModule_Check}@anchor{50b5}
@deffn {C Função} int PyModule_Check (PyObject *p)

Retorna true se `p' for um objeto de módulo ou um subtipo de um objeto de módulo. Esta função sempre é bem-sucedida.
@end deffn

@geindex PyModule_CheckExact (C function)
@anchor{c-api/module c PyModule_CheckExact}@anchor{50b6}
@deffn {C Função} int PyModule_CheckExact (PyObject *p)

Retorna true se `p' for um objeto de módulo, mas não um subtipo de @ref{4d00,,PyModule_Type}. Essa função é sempre bem-sucedida.
@end deffn

@geindex PyModule_NewObject (C function)
@anchor{c-api/module c PyModule_NewObject}@anchor{4cfe}
@deffn {C Função} @ref{339,,PyObject} *PyModule_NewObject (PyObject *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@geindex __name__ (atributo de módulo)
@geindex __doc__ (atributo de módulo)
@geindex __file__ (atributo de módulo)
@geindex __package__ (atributo de módulo)
@geindex __loader__ (atributo de módulo)

Retorna um novo objeto de módulo com @ref{13d2,,module.__name__} definido como `name'. Os atributos @code{__name__}, @ref{1978,,__doc__}, @ref{2d7,,__package__} e @ref{2e2,,__loader__} do módulo são preenchidos (todos, exceto @code{__name__}, são definidos como @code{None}). O chamador é responsável por definir um atributo @ref{20ad,,__file__}.

Retorna @code{NULL} com uma exceção definida em caso de erro.


Adicionado na versão 3.3.



Alterado na versão 3.4: @ref{2d7,,__package__} e @ref{2e2,,__loader__} agora estão definidos como @code{None}.

@end deffn

@geindex PyModule_New (C function)
@anchor{c-api/module c PyModule_New}@anchor{4cfd}
@deffn {C Função} @ref{339,,PyObject} *PyModule_New (const char *name)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{4cfe,,PyModule_NewObject()}, mas o nome é uma string codificada em UTF-8 em vez de um objeto Unicode.
@end deffn

@geindex PyModule_GetDict (C function)
@anchor{c-api/module c PyModule_GetDict}@anchor{4cfa}
@deffn {C Função} @ref{339,,PyObject} *PyModule_GetDict (PyObject *module)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
@geindex __dict__ (atributo de módulo)

Retorna o objeto dicionário que implementa o espaço de nomes de `module'; este objeto é o mesmo que o atributo @ref{55b,,__dict__} do objeto de módulo. Se `module' não for um objeto de módulo (ou um subtipo de um objeto de módulo), @ref{575,,SystemError} é levantada e @code{NULL} é retornado.

É recomendado que as extensões usem outras funções @code{PyModule_*} e @code{PyObject_*} em vez de manipular diretamente o @ref{55b,,__dict__} de um módulo.

The returned reference is borrowed from the module; it is valid until
the module is destroyed.
@end deffn

@geindex PyModule_GetNameObject (C function)
@anchor{c-api/module c PyModule_GetNameObject}@anchor{4cfc}
@deffn {C Função} @ref{339,,PyObject} *PyModule_GetNameObject (PyObject *module)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
@geindex __name__ (atributo de módulo)
@geindex SystemError (built-in exception)

Retorna o valor @ref{13d2,,__name__} do `module'. Se o módulo não fornecer um, ou se não for uma string, @ref{575,,SystemError} é levantada e @code{NULL} é retornado.


Adicionado na versão 3.3.

@end deffn

@geindex PyModule_GetName (C function)
@anchor{c-api/module c PyModule_GetName}@anchor{4cfb}
@deffn {C Função} const char *PyModule_GetName (PyObject *module)
` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{4cfc,,PyModule_GetNameObject()} mas retorna o nome codificado em @code{'utf-8'}

The returned buffer is only valid until the module is renamed or destroyed.
Note that Python code may rename a module by setting its @ref{13d2,,__name__}
attribute.
@end deffn

@geindex PyModule_GetState (C function)
@anchor{c-api/module c PyModule_GetState}@anchor{987}
@deffn {C Função} void *PyModule_GetState (PyObject *module)
` Parte da @ref{553,,ABI Estável}.'
Retorna o “estado” do módulo, ou seja, um ponteiro para o bloco de memória alocado no momento de criação do módulo, ou @code{NULL}. Ver @ref{986,,PyModuleDef.m_size}.
@end deffn

@geindex PyModule_GetDef (C function)
@anchor{c-api/module c PyModule_GetDef}@anchor{4cf9}
@deffn {C Função} @ref{984,,PyModuleDef} *PyModule_GetDef (PyObject *module)
` Parte da @ref{553,,ABI Estável}.'
Retorna um ponteiro para a estrutura @ref{984,,PyModuleDef} da qual o módulo foi criado, ou @code{NULL} se o módulo não foi criado de uma definição.

On error, return @code{NULL} with an exception set.
Use @ref{1a3b,,PyErr_Occurred()} to tell this case apart from a missing
@code{PyModuleDef}.
@end deffn

@geindex PyModule_GetFilenameObject (C function)
@anchor{c-api/module c PyModule_GetFilenameObject}@anchor{3f9}
@deffn {C Função} @ref{339,,PyObject} *PyModule_GetFilenameObject (PyObject *module)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@geindex __file__ (atributo de módulo)
@geindex SystemError (built-in exception)

Retorna o nome do arquivo do qual o `module' foi carregado usando o atributo @ref{20ad,,__file__} do `module'. Se não estiver definido, ou se não for uma string unicode, levanta @ref{575,,SystemError} e retorna @code{NULL}; Caso contrário, retorna uma referência a um objeto Unicode.


Adicionado na versão 3.2.

@end deffn

@geindex PyModule_GetFilename (C function)
@anchor{c-api/module c PyModule_GetFilename}@anchor{3f8}
@deffn {C Função} const char *PyModule_GetFilename (PyObject *module)
` Parte da @ref{553,,ABI Estável}.'
Semelhante a @ref{3f9,,PyModule_GetFilenameObject()} mas retorna o nome do arquivo codificado em ‘utf-8’.

The returned buffer is only valid until the module’s @ref{20ad,,__file__} attribute
is reassigned or the module is destroyed.


Descontinuado desde a versão 3.2: @ref{3f8,,PyModule_GetFilename()}: levanta @ref{677,,UnicodeEncodeError} quando há nomes de arquivos não codificáveis, use @ref{3f9,,PyModule_GetFilenameObject()}.

@end deffn

@menu
* Inicializando módulos C:: 
* Pesquisa por módulos:: 

@end menu

@node Inicializando módulos C,Pesquisa por módulos,,Objetos do Módulo
@anchor{c-api/module initializing-c-modules}@anchor{50b7}@anchor{c-api/module initializing-modules}@anchor{4ba6}
@subsubsection Inicializando módulos C


Objetos de módulos são geralmente criados a partir de módulos de extensão (bibliotecas compartilhadas que exportam uma função de inicialização), ou módulos compilados (onde a função de inicialização é adicionada usando @ref{18a4,,PyImport_AppendInittab()}). Ver @ref{4b51,,Construindo extensões C e C++} ou @ref{4bbf,,Extending Embedded Python} para mais detalhes.

A função de inicialização pode passar uma instância de definição de módulo para @ref{50b8,,PyModule_Create()} e retornar o objeto de módulo resultante ou solicitar “inicialização multifásica” retornando a própria estrutura de definição.

@geindex PyModuleDef (C type)
@anchor{c-api/module c PyModuleDef}@anchor{984}
@deffn {C Tipo} type PyModuleDef
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
A estrutura de definição de módulo, que contém todas as informações necessária para criar um objeto de módulo. Geralmente, há apenas uma variável inicializada estaticamente desse tipo para cada módulo.

@geindex PyModuleDef.m_base (C member)
@anchor{c-api/module c PyModuleDef m_base}@anchor{50b9}
@deffn {C Membro} PyModuleDef_Base m_base

Sempre inicializa este membro para @code{PyModuleDef_HEAD_INIT}.
@end deffn

@geindex PyModuleDef.m_name (C member)
@anchor{c-api/module c PyModuleDef m_name}@anchor{50ba}
@deffn {C Membro} const char *m_name

Nome para o novo módulo.
@end deffn

@geindex PyModuleDef.m_doc (C member)
@anchor{c-api/module c PyModuleDef m_doc}@anchor{50bb}
@deffn {C Membro} const char *m_doc

Docstring para o módulo; geralmente uma variável docstring criada com @ref{1aea,,PyDoc_STRVAR} é usada.
@end deffn

@geindex PyModuleDef.m_size (C member)
@anchor{c-api/module c PyModuleDef m_size}@anchor{986}
@deffn {C Membro} @ref{a69,,Py_ssize_t} m_size

O estado do módulo pode ser mantido em uma área de memória por módulo que pode ser recuperada com @ref{987,,PyModule_GetState()}, em vez de em globais estáticos. Isso torna os módulos seguros para uso em vários subinterpretadores.

Esta área de memória é alocada com base em `m_size' na criação do módulo e liberada quando o objeto do módulo é desalocado, após a função @ref{983,,m_free} ter sido chamada, se presente.

Definir @code{m_size} como @code{-1} significa que o módulo não oferece suporte a subinterpretadores, porque ele tem estado global.

Defini-lo como um valor não negativo significa que o módulo pode ser reinicializado e especifica a quantidade adicional de memória necessária para seu estado. @code{m_size} não negativo é necessário para inicialização multifásica.

Ver 
@geindex Propostas de Melhorias do Python; PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/} para mais detalhes.
@end deffn

@geindex PyModuleDef.m_methods (C member)
@anchor{c-api/module c PyModuleDef m_methods}@anchor{50bc}
@deffn {C Membro} @ref{151f,,PyMethodDef} *m_methods

Um ponteiro para uma tabela de funções de nível de módulo, descritas por valores @ref{151f,,PyMethodDef}. Pode ser @code{NULL} se nenhuma função estiver presente.
@end deffn

@geindex PyModuleDef.m_slots (C member)
@anchor{c-api/module c PyModuleDef m_slots}@anchor{50bd}
@deffn {C Membro} @ref{4cf6,,PyModuleDef_Slot} *m_slots

Uma matriz de definições de slot para inicialização multifásica, terminada por uma entrada @code{@{0, NULL@}}. Ao usar inicialização monofásica, `m_slots' deve ser @code{NULL}.


Alterado na versão 3.5: Antes da versão 3.5, esse membro era sempre definido como @code{NULL} e era definido como:

@quotation

@geindex PyModuleDef.m_slots.m_reload (C member)
@anchor{c-api/module c PyModuleDef m_slots m_reload}@anchor{50be}
@deffn {C Membro} @ref{4e40,,inquiry} m_reload
@end deffn
@end quotation

@end deffn

@geindex PyModuleDef.m_traverse (C member)
@anchor{c-api/module c PyModuleDef m_traverse}@anchor{981}
@deffn {C Membro} @ref{4e4f,,traverseproc} m_traverse

Uma função de travessia para chamar durante a travessia do GC do objeto do módulo, ou @code{NULL} se não for necessário.

Esta função não é mais chamada se o estado do módulo foi solicitado, mas ainda não está alocado. Este é o caso imediatamente após o módulo ser criado e antes de o módulo ser executado (função @ref{985,,Py_mod_exec}). Mais precisamente, esta função não é chamada se @ref{986,,m_size} for maior que 0 e o estado do módulo (como retornado por @ref{987,,PyModule_GetState()}) for @code{NULL}.


Alterado na versão 3.9: Não é mais chamado antes que o estado do módulo seja alocado.

@end deffn

@geindex PyModuleDef.m_clear (C member)
@anchor{c-api/module c PyModuleDef m_clear}@anchor{982}
@deffn {C Membro} @ref{4e40,,inquiry} m_clear

Uma função de limpeza para chamar durante a limpeza do GC do objeto do módulo, ou @code{NULL} se não for necessário.

Esta função não é mais chamada se o estado do módulo foi solicitado, mas ainda não está alocado. Este é o caso imediatamente após o módulo ser criado e antes de o módulo ser executado (função @ref{985,,Py_mod_exec}). Mais precisamente, esta função não é chamada se @ref{986,,m_size} for maior que 0 e o estado do módulo (como retornado por @ref{987,,PyModule_GetState()}) for @code{NULL}.

Assim como @ref{4b8b,,PyTypeObject.tp_clear}, esta função não é `sempre' chamada antes de um módulo ser desalocado. Por exemplo, quando a contagem de referências é suficiente para determinar que um objeto não é mais usado, o coletor de lixo cíclico não é envolvido e @ref{983,,m_free} é chamado diretamente.


Alterado na versão 3.9: Não é mais chamado antes que o estado do módulo seja alocado.

@end deffn

@geindex PyModuleDef.m_free (C member)
@anchor{c-api/module c PyModuleDef m_free}@anchor{983}
@deffn {C Membro} @ref{50bf,,freefunc} m_free

Uma função para ser chamada durante a desalocação do objeto do módulo, ou @code{NULL} se não for necessário.

Esta função não é mais chamada se o estado do módulo foi solicitado, mas ainda não está alocado. Este é o caso imediatamente após o módulo ser criado e antes de o módulo ser executado (função @ref{985,,Py_mod_exec}). Mais precisamente, esta função não é chamada se @ref{986,,m_size} for maior que 0 e o estado do módulo (como retornado por @ref{987,,PyModule_GetState()}) for @code{NULL}.


Alterado na versão 3.9: Não é mais chamado antes que o estado do módulo seja alocado.

@end deffn
@end deffn

@menu
* inicialização de fase única:: 
* Inicialização multifásica:: 
* Funções de criação de módulo de baixo nível:: 
* Support functions:: 

@end menu

@node inicialização de fase única,Inicialização multifásica,,Inicializando módulos C
@anchor{c-api/module single-phase-initialization}@anchor{50c0}
@subsubsection inicialização de fase única


A função de inicialização do módulo pode criar e retornar o objeto do módulo diretamente. Isso é chamado de “inicialização de fase única” e usa uma das duas funções de criação de módulo a seguir:

@geindex PyModule_Create (C function)
@anchor{c-api/module c PyModule_Create}@anchor{50b8}
@deffn {C Função} @ref{339,,PyObject} *PyModule_Create (PyModuleDef *def)
`Retorna valor: Nova referência.'
Cria um novo objeto de módulo, dada a definição em `def'. Isso se comporta como @ref{4cf8,,PyModule_Create2()} com `module_api_version' definido como @code{PYTHON_API_VERSION}
@end deffn

@geindex PyModule_Create2 (C function)
@anchor{c-api/module c PyModule_Create2}@anchor{4cf8}
@deffn {C Função} @ref{339,,PyObject} *PyModule_Create2 (PyModuleDef *def, int module_api_version)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Create a new module object, given the definition in `def', assuming the
API version `module_api_version'.  If that version does not match the version
of the running interpreter, a @ref{1bd,,RuntimeWarning} is emitted.

Retorna @code{NULL} com uma exceção definida em caso de erro.

@cartouche
@quotation Nota 
A maioria dos usos dessa função deve ser feita com @ref{50b8,,PyModule_Create()}; use-o apenas se tiver certeza de que precisa.
@end quotation
@end cartouche
@end deffn

Before it is returned from in the initialization function, the resulting module
object is typically populated using functions like @ref{365,,PyModule_AddObjectRef()}.

@node Inicialização multifásica,Funções de criação de módulo de baixo nível,inicialização de fase única,Inicializando módulos C
@anchor{c-api/module id1}@anchor{50c1}@anchor{c-api/module multi-phase-initialization}@anchor{4ba7}
@subsubsection Inicialização multifásica


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 @ref{580,,__new__()} and
@ref{6b0,,__init__()} methods of classes.

Unlike modules created using single-phase initialization, these modules are not
singletons.
For example, if the @ref{1636,,sys.modules} entry is removed and the module
is re-imported, a new module object is created, and typically populated with
fresh method and type objects.
The old module is subject to normal garbage collection.
This mirrors the behavior of pure-Python modules.

Additional module instances may be created in
@ref{587,,sub-interpreters}
or after after Python runtime reinitialization
(@ref{13a0,,Py_Finalize()} and @ref{8b1,,Py_Initialize()}).
In these cases, sharing Python objects between module instances would likely
cause crashes or undefined behavior.

To avoid such issues, each instance of an extension module should
be `isolated': changes to one instance should not implicitly affect the others,
and all state, including references to Python objects, should be specific to
a particular module instance.
See @ref{4b4d,,Isolando módulos de extensão} for more details and a practical guide.

Uma maneira mais simples de evitar esses problemas é @ref{50c2,,levantar um erro na inicialização repetida}.

All modules created using multi-phase initialization are expected to support
@ref{587,,sub-interpreters}, or otherwise explicitly
signal a lack of support.
This is usually achieved by isolation or blocking repeated initialization,
as above.
A module may also be limited to the main interpreter using
the @ref{4de8,,Py_mod_multiple_interpreters} slot.

To request multi-phase initialization, the initialization function
(PyInit_modulename) returns a @ref{984,,PyModuleDef} instance with non-empty
@ref{50bd,,m_slots}. Before it is returned, the @code{PyModuleDef}
instance must be initialized with the following function:

@geindex PyModuleDef_Init (C function)
@anchor{c-api/module c PyModuleDef_Init}@anchor{4b4c}
@deffn {C Função} @ref{339,,PyObject} *PyModuleDef_Init (PyModuleDef *def)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável} desde a versão 3.5.'
Garante que uma definição de módulo é um objeto Python devidamente inicializado que reporta corretamente seu tipo e contagem de referências.

Returns `def' cast to @code{PyObject*}, or @code{NULL} if an error occurred.


Adicionado na versão 3.5.

@end deffn

The `m_slots' member of the module definition must point to an array of
@code{PyModuleDef_Slot} structures:

@geindex PyModuleDef_Slot (C type)
@anchor{c-api/module c PyModuleDef_Slot}@anchor{4cf6}
@deffn {C Tipo} type PyModuleDef_Slot
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros) desde a versão 3.5.'
@geindex PyModuleDef_Slot.slot (C member)
@anchor{c-api/module c PyModuleDef_Slot slot}@anchor{50c3}
@deffn {C Membro} int slot

Um ID de lot, escolhido a partir dos valores disponíveis explicados abaixo.
@end deffn

@geindex PyModuleDef_Slot.value (C member)
@anchor{c-api/module c PyModuleDef_Slot value}@anchor{50c4}
@deffn {C Membro} void *value

Valor do slot, cujo significado depende do ID do slot.
@end deffn


Adicionado na versão 3.5.

@end deffn

The `m_slots' array must be terminated by a slot with id 0.

Os tipos de slot disponíveis são:

@geindex Py_mod_create (C macro)
@anchor{c-api/module c Py_mod_create}@anchor{4de7}
@deffn {C Macro} Py_mod_create
` Parte da @ref{553,,ABI Estável} desde a versão 3.5.'
Specifies a function that is called to create the module object itself.
The `value' pointer of this slot must point to a function of the signature:

@anchor{c-api/module c Py_mod_create create_module}@anchor{50c5}
@deffn {C Função} @ref{339,,PyObject} *create_module (PyObject *spec, PyModuleDef *def)
@end deffn

The function receives a @ref{1fee,,ModuleSpec}
instance, as defined in 
@geindex Propostas de Melhorias do Python; PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}, and the module definition.
It should return a new module object, or set an error
and return @code{NULL}.

This function should be kept minimal. In particular, it should not
call arbitrary Python code, as trying to import the same module again may
result in an infinite loop.

Múltiplos slots @code{Py_mod_create} podem não estar especificados em uma definição de módulo.

If @code{Py_mod_create} is not specified, the import machinery will create
a normal module object using @ref{4cfd,,PyModule_New()}. The name is taken from
`spec', not the definition, to allow extension modules to dynamically adjust
to their place in the module hierarchy and be imported under different
names through symlinks, all while sharing a single module definition.

There is no requirement for the returned object to be an instance of
@ref{4d00,,PyModule_Type}. Any type can be used, as long as it supports
setting and getting import-related attributes.
However, only @code{PyModule_Type} instances may be returned if the
@code{PyModuleDef} has non-@code{NULL} @code{m_traverse}, @code{m_clear},
@code{m_free}; non-zero @code{m_size}; or slots other than @code{Py_mod_create}.


Adicionado na versão 3.5.

@end deffn

@geindex Py_mod_exec (C macro)
@anchor{c-api/module c Py_mod_exec}@anchor{985}
@deffn {C Macro} Py_mod_exec
` Parte da @ref{553,,ABI Estável} desde a versão 3.5.'
Specifies a function that is called to `execute' the module.
This is equivalent to executing the code of a Python module: typically,
this function adds classes and constants to the module.
The signature of the function is:

@anchor{c-api/module c Py_mod_exec exec_module}@anchor{50c6}
@deffn {C Função} int exec_module (PyObject *module)
@end deffn

Se vários slots @code{Py_mod_exec} forem especificados, eles serão processados na ordem em que aparecem no vetor `m_slots'.


Adicionado na versão 3.5.

@end deffn

@geindex Py_mod_multiple_interpreters (C macro)
@anchor{c-api/module c Py_mod_multiple_interpreters}@anchor{4de8}
@deffn {C Macro} Py_mod_multiple_interpreters
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
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{4b4e}
@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{50c7}
@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{4b4d,,Isolando módulos de extensão}.)
@end deffn

@geindex Py_MOD_PER_INTERPRETER_GIL_SUPPORTED (C macro)
@anchor{c-api/module c Py_MOD_PER_INTERPRETER_GIL_SUPPORTED}@anchor{50c8}
@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{4b4d,,Isolando módulos de extensão}.)
@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_SUPPORTED}.


Adicionado na versão 3.12.

@end deffn

@geindex Py_mod_gil (C macro)
@anchor{c-api/module c Py_mod_gil}@anchor{158}
@deffn {C Macro} Py_mod_gil
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Specifies one of the following values:

@geindex Py_MOD_GIL_USED (C macro)
@anchor{c-api/module c Py_MOD_GIL_USED}@anchor{50c9}
@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{50ca}
@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{174,,--disable-gil}.  Otherwise, it determines whether or not importing
this module will cause the GIL to be automatically enabled. See
@ref{13f,,CPython com threads livres} 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}.


Adicionado na versão 3.13.

@end deffn

Ver 
@geindex Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} para obter mais detalhes sobre a inicialização multifásica.

@node Funções de criação de módulo de baixo nível,Support functions,Inicialização multifásica,Inicializando módulos C
@anchor{c-api/module low-level-module-creation-functions}@anchor{50cb}
@subsubsection Funções de criação de módulo de baixo nível


The following functions are called under the hood when using multi-phase
initialization. They can be used directly, for example when creating module
objects dynamically. Note that both @code{PyModule_FromDefAndSpec} and
@code{PyModule_ExecDef} must be called to fully initialize a module.

@geindex PyModule_FromDefAndSpec (C function)
@anchor{c-api/module c PyModule_FromDefAndSpec}@anchor{ee2}
@deffn {C Função} @ref{339,,PyObject} *PyModule_FromDefAndSpec (PyModuleDef *def, PyObject *spec)
`Retorna valor: Nova referência.'
Create a new module object, given the definition in `def' and the
ModuleSpec `spec'.  This behaves like @ref{ee3,,PyModule_FromDefAndSpec2()}
with `module_api_version' set to @code{PYTHON_API_VERSION}.


Adicionado na versão 3.5.

@end deffn

@geindex PyModule_FromDefAndSpec2 (C function)
@anchor{c-api/module c PyModule_FromDefAndSpec2}@anchor{ee3}
@deffn {C Função} @ref{339,,PyObject} *PyModule_FromDefAndSpec2 (PyModuleDef *def, PyObject *spec, int module_api_version)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 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{1bd,,RuntimeWarning} is emitted.

Retorna @code{NULL} com uma exceção definida em caso de erro.

@cartouche
@quotation Nota 
Most uses of this function should be using @ref{ee2,,PyModule_FromDefAndSpec()}
instead; only use this if you are sure you need it.
@end quotation
@end cartouche


Adicionado na versão 3.5.

@end deffn

@geindex PyModule_ExecDef (C function)
@anchor{c-api/module c PyModule_ExecDef}@anchor{ee4}
@deffn {C Função} int PyModule_ExecDef (PyObject *module, PyModuleDef *def)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Process any execution slots (@ref{985,,Py_mod_exec}) given in `def'.


Adicionado na versão 3.5.

@end deffn

@geindex PyModule_SetDocString (C function)
@anchor{c-api/module c PyModule_SetDocString}@anchor{4cff}
@deffn {C Função} int PyModule_SetDocString (PyObject *module, const char *docstring)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Set the docstring for `module' to `docstring'.
This function is called automatically when creating a module from
@code{PyModuleDef}, using either @code{PyModule_Create} or
@code{PyModule_FromDefAndSpec}.

Return @code{0} on success.
Return @code{-1} with an exception set on error.


Adicionado na versão 3.5.

@end deffn

@geindex PyModule_AddFunctions (C function)
@anchor{c-api/module c PyModule_AddFunctions}@anchor{4cf7}
@deffn {C Função} int PyModule_AddFunctions (PyObject *module, PyMethodDef *functions)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Add the functions from the @code{NULL} terminated `functions' array to `module'.
Refer to the @ref{151f,,PyMethodDef} documentation for details on individual
entries (due to the lack of a shared module namespace, module level
“functions” implemented in C typically receive the module as their first
parameter, making them similar to instance methods on Python classes).
This function is called automatically when creating a module from
@code{PyModuleDef}, using either @code{PyModule_Create} or
@code{PyModule_FromDefAndSpec}.

The `functions' array must be statically allocated (or otherwise guaranteed
to outlive the module object).


Adicionado na versão 3.5.

@end deffn

@node Support functions,,Funções de criação de módulo de baixo nível,Inicializando módulos C
@anchor{c-api/module support-functions}@anchor{50cc}
@subsubsection Support functions


The module initialization function (if using single phase initialization) or
a function called from a module execution slot (if using multi-phase
initialization), can use the following functions to help initialize the module
state:

@geindex PyModule_AddObjectRef (C function)
@anchor{c-api/module c PyModule_AddObjectRef}@anchor{365}
@deffn {C Função} int PyModule_AddObjectRef (PyObject *module, const char *name, PyObject *value)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Add an object to `module' as `name'.  This is a convenience function which
can be used from the module’s initialization function.

On success, return @code{0}. On error, raise an exception and return @code{-1}.

Exemplo 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

To be convenient, the function accepts @code{NULL} `value' with an exception
set. In this case, return @code{-1} and just leave the raised exception
unchanged.

O exemplo também pode ser escrito sem verificar explicitamente se `obj' é @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 that @code{Py_XDECREF()} should be used instead of @code{Py_DECREF()} in
this case, since `obj' can be @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{4db1,,PyUnicode_FromString()} and @ref{4d34,,PyObject_SetAttr()} directly.
For more details, see @ref{16ea,,PyUnicode_InternFromString()}, which may be
used internally to create a key object.


Adicionado na versão 3.10.

@end deffn

@geindex PyModule_Add (C function)
@anchor{c-api/module c PyModule_Add}@anchor{364}
@deffn {C Função} int PyModule_Add (PyObject *module, const char *name, PyObject *value)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Similar to @ref{365,,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.

Exemplo de uso:

@example
if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) @{
    goto error;
@}
@end example


Adicionado na versão 3.13.

@end deffn

@geindex PyModule_AddObject (C function)
@anchor{c-api/module c PyModule_AddObject}@anchor{366}
@deffn {C Função} int PyModule_AddObject (PyObject *module, const char *name, PyObject *value)
` Parte da @ref{553,,ABI Estável}.'
Similar to @ref{365,,PyModule_AddObjectRef()}, but steals a reference to
`value' on success (if it returns @code{0}).

The new @ref{364,,PyModule_Add()} or @ref{365,,PyModule_AddObjectRef()}
functions are recommended, since it is
easy to introduce reference leaks by misusing the
@ref{366,,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{78f,,Py_XDECREF()} `value' manually on error.
@end quotation
@end cartouche

Exemplo 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


Descontinuado desde a versão 3.13: @ref{366,,PyModule_AddObject()} is @ref{209,,soft deprecated}.

@end deffn

@geindex PyModule_AddIntConstant (C function)
@anchor{c-api/module c PyModule_AddIntConstant}@anchor{1585}
@deffn {C Função} int PyModule_AddIntConstant (PyObject *module, const char *name, long value)
` Parte da @ref{553,,ABI Estável}.'
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{195a,,PyLong_FromLong()} and
@ref{365,,PyModule_AddObjectRef()}; see their documentation for details.
@end deffn

@geindex PyModule_AddStringConstant (C function)
@anchor{c-api/module c PyModule_AddStringConstant}@anchor{1586}
@deffn {C Função} int PyModule_AddStringConstant (PyObject *module, const char *name, const char *value)
` Parte da @ref{553,,ABI Estável}.'
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{16ea,,PyUnicode_InternFromString()} and @ref{365,,PyModule_AddObjectRef()};
see their documentation for details.
@end deffn

@geindex PyModule_AddIntMacro (C macro)
@anchor{c-api/module c PyModule_AddIntMacro}@anchor{143a}
@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{1439}
@deffn {C Macro} PyModule_AddStringMacro (module, macro)

Add a string constant to `module'.
@end deffn

@geindex PyModule_AddType (C function)
@anchor{c-api/module c PyModule_AddType}@anchor{97c}
@deffn {C Função} int PyModule_AddType (PyObject *module, PyTypeObject *type)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Add a type object to `module'.
The type object is finalized by calling internally @ref{77c,,PyType_Ready()}.
The name of the type object is taken from the last component of
@ref{1a3c,,tp_name} after dot.
Return @code{-1} with an exception set on error, @code{0} on success.


Adicionado na versão 3.9.

@end deffn

@geindex PyUnstable_Module_SetGIL (C function)
@anchor{c-api/module c PyUnstable_Module_SetGIL}@anchor{179}
@deffn {C Função} int PyUnstable_Module_SetGIL (PyObject *module, void *gil)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@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{158,,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{174,,--disable-gil}.
Return @code{-1} with an exception set on error, @code{0} on success.


Adicionado na versão 3.13.

@end deffn

@node Pesquisa por módulos,,Inicializando módulos C,Objetos do Módulo
@anchor{c-api/module module-lookup}@anchor{50cd}
@subsubsection Pesquisa por módulos


Single-phase initialization creates singleton modules that can be looked up
in the context of the current interpreter. This allows the module object to be
retrieved later with only a reference to the module definition.

These functions will not work on modules created using multi-phase initialization,
since multiple such modules can be created from a single definition.

@geindex PyState_FindModule (C function)
@anchor{c-api/module c PyState_FindModule}@anchor{4d54}
@deffn {C Função} @ref{339,,PyObject} *PyState_FindModule (PyModuleDef *def)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Returns the module object that was created from `def' for the current interpreter.
This method requires that the module object has been attached to the interpreter state with
@ref{4d53,,PyState_AddModule()} beforehand. In case the corresponding module object is not
found or has not been attached to the interpreter state yet, it returns @code{NULL}.
@end deffn

@geindex PyState_AddModule (C function)
@anchor{c-api/module c PyState_AddModule}@anchor{4d53}
@deffn {C Função} int PyState_AddModule (PyObject *module, PyModuleDef *def)
` Parte da @ref{553,,ABI Estável} desde a versão 3.3.'
Attaches the module object passed to the function to the interpreter state. This allows
the module object to be accessible via @ref{4d54,,PyState_FindModule()}.

Only effective on modules created using single-phase initialization.

Python calls @code{PyState_AddModule} automatically after importing a module,
so it is unnecessary (but harmless) to call it from module initialization
code. An explicit call is needed only if the module’s own init code
subsequently calls @code{PyState_FindModule}.
The function is mainly intended for implementing alternative import
mechanisms (either by calling it directly, or by referring to its
implementation for details of the required state updates).

The caller must hold the GIL.

Retorna @code{-1} com uma exceção definida em caso de erro, @code{0} em caso de sucesso.


Adicionado na versão 3.3.

@end deffn

@geindex PyState_RemoveModule (C function)
@anchor{c-api/module c PyState_RemoveModule}@anchor{4d55}
@deffn {C Função} int PyState_RemoveModule (PyModuleDef *def)
` Parte da @ref{553,,ABI Estável} desde a versão 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.

The caller must hold the GIL.


Adicionado na versão 3.3.

@end deffn

@node Objetos Iteradores,Objetos descritores,Objetos do Módulo,Outros Objetos
@anchor{c-api/iterator doc}@anchor{50ce}@anchor{c-api/iterator id1}@anchor{50cf}@anchor{c-api/iterator iterator-objects}@anchor{50d0}@anchor{c-api/iterator translation-repo}@anchor{50d1}
@subsubsection Objetos Iteradores


O Python fornece dois objetos iteradores de propósito geral. O primeiro, um iterador de sequência, trabalha com uma sequência arbitrária suportando o método @ref{283,,__getitem__()}. O segundo trabalha com um objeto chamável e um valor de sentinela, chamando o chamável para cada item na sequência e finalizando a iteração quando o valor de sentinela é retornado.

@geindex PySeqIter_Type (C var)
@anchor{c-api/iterator c PySeqIter_Type}@anchor{4d3c}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PySeqIter_Type
` Parte da @ref{553,,ABI Estável}.'
Objeto de tipo para objetos iteradores retornados por @ref{4d3b,,PySeqIter_New()} e a forma de um argumento da função embutida @ref{7d8,,iter()} para os tipos de sequência embutidos.
@end deffn

@geindex PySeqIter_Check (C function)
@anchor{c-api/iterator c PySeqIter_Check}@anchor{50d2}
@deffn {C Função} int PySeqIter_Check (PyObject *op)

Retorna true se o tipo de `op' for @ref{4d3c,,PySeqIter_Type}. Esta função sempre é bem-sucedida.
@end deffn

@geindex PySeqIter_New (C function)
@anchor{c-api/iterator c PySeqIter_New}@anchor{4d3b}
@deffn {C Função} @ref{339,,PyObject} *PySeqIter_New (PyObject *seq)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um iterador que funcione com um objeto de sequência geral, `seq'. A iteração termina quando a sequência levanta @ref{157e,,IndexError} para a operação de assinatura.
@end deffn

@geindex PyCallIter_Type (C var)
@anchor{c-api/iterator c PyCallIter_Type}@anchor{4c2a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCallIter_Type
` Parte da @ref{553,,ABI Estável}.'
Objeto de tipo para objetos iteradores retornados por @ref{4c29,,PyCallIter_New()} e a forma de dois argumentos da função embutida @ref{7d8,,iter()}.
@end deffn

@geindex PyCallIter_Check (C function)
@anchor{c-api/iterator c PyCallIter_Check}@anchor{50d3}
@deffn {C Função} int PyCallIter_Check (PyObject *op)

Retorna true se o tipo de `op' for @ref{4c2a,,PyCallIter_Type}. Esta função sempre é bem-sucedida.
@end deffn

@geindex PyCallIter_New (C function)
@anchor{c-api/iterator c PyCallIter_New}@anchor{4c29}
@deffn {C Função} @ref{339,,PyObject} *PyCallIter_New (PyObject *callable, PyObject *sentinel)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo iterador. O primeiro parâmetro, `callable', pode ser qualquer objeto chamável do Python que possa ser chamado sem parâmetros; cada chamada deve retornar o próximo item na iteração. Quando `callable' retorna um valor igual a `sentinel', a iteração será encerrada.
@end deffn

@menu
* Objetos intervalo:: 
* Tipos de iteradores embutidos:: 
* Outros objetos iteradores:: 

@end menu

@node Objetos intervalo,Tipos de iteradores embutidos,,Objetos Iteradores
@anchor{c-api/iterator range-objects}@anchor{50d4}
@subsubsection Objetos intervalo


@geindex PyRange_Type (C var)
@anchor{c-api/iterator c PyRange_Type}@anchor{4d39}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyRange_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto tipo para objetos @ref{94a,,range}.
@end deffn

@geindex PyRange_Check (C function)
@anchor{c-api/iterator c PyRange_Check}@anchor{50d5}
@deffn {C Função} int PyRange_Check (PyObject *o)

Retorna verdadeiro se o objeto `op' for uma instância de um objeto @ref{94a,,range}. Esta função sempre tem sucesso.
@end deffn

@node Tipos de iteradores embutidos,Outros objetos iteradores,Objetos intervalo,Objetos Iteradores
@anchor{c-api/iterator builtin-iterator-types}@anchor{50d6}
@subsubsection Tipos de iteradores embutidos


Esses são tipos de iteração embutidos que estão incluídos na API C do Python, mas não fornecem funções adicionais. Eles estão aqui para fins de completude.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tipo em C

@tab

Tipo em Python

@item

@geindex PyEnum_Type (C var)
@anchor{c-api/iterator c PyEnum_Type}@anchor{4c63}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyEnum_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{14c9,,enumerate}

@item

@geindex PyFilter_Type (C var)
@anchor{c-api/iterator c PyFilter_Type}@anchor{4cc1}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFilter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{868,,filter}

@item

@geindex PyMap_Type (C var)
@anchor{c-api/iterator c PyMap_Type}@anchor{4cec}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyMap_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{867,,map}

@item

@geindex PyReversed_Type (C var)
@anchor{c-api/iterator c PyReversed_Type}@anchor{4d3a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyReversed_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{869,,reversed}

@item

@geindex PyZip_Type (C var)
@anchor{c-api/iterator c PyZip_Type}@anchor{4dbe}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyZip_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@tab

@ref{7d1,,zip}

@end multitable


@node Outros objetos iteradores,,Tipos de iteradores embutidos,Objetos Iteradores
@anchor{c-api/iterator other-iterator-objects}@anchor{50d7}
@subsubsection Outros objetos iteradores


@geindex PyByteArrayIter_Type (C var)
@anchor{c-api/iterator c PyByteArrayIter_Type}@anchor{4c11}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyByteArrayIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyBytesIter_Type (C var)
@anchor{c-api/iterator c PyBytesIter_Type}@anchor{4c17}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyBytesIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyListIter_Type (C var)
@anchor{c-api/iterator c PyListIter_Type}@anchor{4cd7}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyListIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyListRevIter_Type (C var)
@anchor{c-api/iterator c PyListRevIter_Type}@anchor{4cd8}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyListRevIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PySetIter_Type (C var)
@anchor{c-api/iterator c PySetIter_Type}@anchor{4d4c}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PySetIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyTupleIter_Type (C var)
@anchor{c-api/iterator c PyTupleIter_Type}@anchor{4d74}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyTupleIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyRangeIter_Type (C var)
@anchor{c-api/iterator c PyRangeIter_Type}@anchor{4d38}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyRangeIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyLongRangeIter_Type (C var)
@anchor{c-api/iterator c PyLongRangeIter_Type}@anchor{4cdf}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyLongRangeIter_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDictIterKey_Type (C var)
@anchor{c-api/iterator c PyDictIterKey_Type}@anchor{4c4d}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictIterKey_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDictRevIterKey_Type (C var)
@anchor{c-api/iterator c PyDictRevIterKey_Type}@anchor{4c53}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictRevIterKey_Type
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
@end deffn

@geindex PyDictIterValue_Type (C var)
@anchor{c-api/iterator c PyDictIterValue_Type}@anchor{4c4e}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictIterValue_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDictRevIterValue_Type (C var)
@anchor{c-api/iterator c PyDictRevIterValue_Type}@anchor{4c54}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictRevIterValue_Type
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
@end deffn

@geindex PyDictIterItem_Type (C var)
@anchor{c-api/iterator c PyDictIterItem_Type}@anchor{4c4c}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictIterItem_Type
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDictRevIterItem_Type (C var)
@anchor{c-api/iterator c PyDictRevIterItem_Type}@anchor{4c52}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDictRevIterItem_Type
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
@end deffn

@geindex PyODictIter_Type (C var)
@anchor{c-api/iterator c PyODictIter_Type}@anchor{50d8}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyODictIter_Type

Objetos de tipo para iteradores de vários objetos embutidos.

Não cria instâncias dessas diretamente; prefira chamar @ref{4d2f,,PyObject_GetIter()} em vez disso.

Note que não há garantia de que um determinado tipo embutido utilize um determinado tipo de iterador. Por exemplo, iterar sobre um @ref{94a,,range} utilizará um de dois tipos de iterador, dependendo do tamanho do intervalo. Outros tipos podem começar a usar um esquema semelhante no futuro, sem aviso prévio.
@end deffn

@node Objetos descritores,Objetos Slice,Objetos Iteradores,Outros Objetos
@anchor{c-api/descriptor doc}@anchor{50d9}@anchor{c-api/descriptor descriptor-objects}@anchor{50da}@anchor{c-api/descriptor id1}@anchor{50db}@anchor{c-api/descriptor translation-repo}@anchor{50dc}
@subsubsection Objetos descritores


“Descritores” são objetos que descrevem algum atributo de um objeto. Eles são encontrados no dicionário de objetos de tipo.

@c XXX document these!

@geindex PyProperty_Type (C var)
@anchor{c-api/descriptor c PyProperty_Type}@anchor{4d37}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyProperty_Type
` Parte da @ref{553,,ABI Estável}.'
O tipo de objeto para os tipos de descritores embutidos.
@end deffn

@geindex PyDescr_NewGetSet (C function)
@anchor{c-api/descriptor c PyDescr_NewGetSet}@anchor{4c49}
@deffn {C Função} @ref{339,,PyObject} *PyDescr_NewGetSet (PyTypeObject *type, struct PyGetSetDef *getset)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDescr_NewMember (C function)
@anchor{c-api/descriptor c PyDescr_NewMember}@anchor{4c4a}
@deffn {C Função} @ref{339,,PyObject} *PyDescr_NewMember (PyTypeObject *type, struct PyMemberDef *meth)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyMemberDescr_Type (C var)
@anchor{c-api/descriptor c PyMemberDescr_Type}@anchor{4cf1}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyMemberDescr_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para descritores de membros criados a partir de estruturas @ref{54f,,PyMemberDef}. Esses descritores expõem campos de uma estrutura C como atributos de um tipo e correspondem a objetos @ref{271c,,types.MemberDescriptorType} em Python.
@end deffn

@geindex PyGetSetDescr_Type (C var)
@anchor{c-api/descriptor c PyGetSetDescr_Type}@anchor{4cc8}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyGetSetDescr_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para descritores get/set criados a partir de estruturas @ref{bd1,,PyGetSetDef}. Esses descritores implementam atributos cujo valor é calculado por funções getter e setter em C e são usados para muitos atributos de tipo embutidos.
@end deffn

@geindex PyDescr_NewMethod (C function)
@anchor{c-api/descriptor c PyDescr_NewMethod}@anchor{1b04}
@deffn {C Função} @ref{339,,PyObject} *PyDescr_NewMethod (PyTypeObject *type, struct PyMethodDef *meth)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyMethodDescr_Type (C var)
@anchor{c-api/descriptor c PyMethodDescr_Type}@anchor{4cf5}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyMethodDescr_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para descritores de métodos criados a partir de estruturas @ref{151f,,PyMethodDef}. Esses descritores expõem funções C como métodos de um tipo e correspondem a objetos @ref{271c,,types.MemberDescriptorType} em Python.
@end deffn

@geindex PyDescr_NewWrapper (C function)
@anchor{c-api/descriptor c PyDescr_NewWrapper}@anchor{50dd}
@deffn {C Função} @ref{339,,PyObject} *PyDescr_NewWrapper (PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
`Retorna valor: Nova referência.'
@end deffn

@geindex PyWrapperDescr_Type (C var)
@anchor{c-api/descriptor c PyWrapperDescr_Type}@anchor{4dbc}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyWrapperDescr_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para objetos descritores de encapsulamento criados por @ref{50dd,,PyDescr_NewWrapper()} e @ref{4dbd,,PyWrapper_New()}. Os descritores de encapsulamento são usados internamente para expor métodos especiais implementados por meio de estruturas de encapsulamento e aparecem em Python como objetos @ref{bb1,,types.WrapperDescriptorType}.
@end deffn

@geindex PyDescr_NewClassMethod (C function)
@anchor{c-api/descriptor c PyDescr_NewClassMethod}@anchor{4c48}
@deffn {C Função} @ref{339,,PyObject} *PyDescr_NewClassMethod (PyTypeObject *type, PyMethodDef *method)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyDescr_IsData (C function)
@anchor{c-api/descriptor c PyDescr_IsData}@anchor{1a3f}
@deffn {C Função} int PyDescr_IsData (PyObject *descr)

Retorna não-zero se o objeto descritor `descr' descrevem um atributo de dados, ou @code{0} se os mesmos descrevem um método. `descr' deve ser um objeto descritor; não há verificação de erros.
@end deffn

@geindex PyWrapper_New (C function)
@anchor{c-api/descriptor c PyWrapper_New}@anchor{4dbd}
@deffn {C Função} @ref{339,,PyObject} *PyWrapper_New (PyObject*, PyObject*)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
@end deffn

@menu
* Descritores embutidos:: 

@end menu

@node Descritores embutidos,,,Objetos descritores
@anchor{c-api/descriptor built-in-descriptors}@anchor{50de}
@subsubsection Descritores embutidos


@geindex PySuper_Type (C var)
@anchor{c-api/descriptor c PySuper_Type}@anchor{4d5a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PySuper_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para superobjetos. Este é o mesmo objeto que @ref{4db,,super} na camada Python.
@end deffn

@geindex PyClassMethod_Type (C var)
@anchor{c-api/descriptor c PyClassMethod_Type}@anchor{50df}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyClassMethod_Type

O tipo de objeto de método de classe. Este é o mesmo objeto que @ref{166,,classmethod} na camada Python.
@end deffn

@geindex PyClassMethodDescr_Type (C var)
@anchor{c-api/descriptor c PyClassMethodDescr_Type}@anchor{4c36}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyClassMethodDescr_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo para descritores de métodos de classe em nível C. Este é o tipo dos descritores criados para @ref{166,,classmethod()} definidos em tipos de extensão C, e é o mesmo objeto que @ref{166,,classmethod} em Python.
@end deffn

@geindex PyClassMethod_New (C function)
@anchor{c-api/descriptor c PyClassMethod_New}@anchor{50e0}
@deffn {C Função} @ref{339,,PyObject} *PyClassMethod_New (PyObject *callable)

Cria um novo objeto @ref{166,,classmethod} que envolve `callable'. `callable' deve ser um objeto chamável e não deve ser @code{NULL}.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} a um novo descritor de método de classe. Em caso de falha, esta função retorna @code{NULL} com uma exceção definida.
@end deffn

@geindex PyStaticMethod_Type (C var)
@anchor{c-api/descriptor c PyStaticMethod_Type}@anchor{50e1}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyStaticMethod_Type

O tipo de objeto de método estático. Este é o mesmo objeto que @ref{416,,staticmethod} na camada Python.
@end deffn

@geindex PyStaticMethod_New (C function)
@anchor{c-api/descriptor c PyStaticMethod_New}@anchor{50e2}
@deffn {C Função} @ref{339,,PyObject} *PyStaticMethod_New (PyObject *callable)

Cria um novo objeto @ref{416,,staticmethod} que envolve `callable'. `callable' deve ser um objeto chamável e não deve ser @code{NULL}.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} a um novo descritor de método estático. Em caso de falha, esta função retorna @code{NULL} com uma exceção definida.
@end deffn

@node Objetos Slice,Objetos MemoryView,Objetos descritores,Outros Objetos
@anchor{c-api/slice doc}@anchor{50e3}@anchor{c-api/slice id1}@anchor{50e4}@anchor{c-api/slice slice-objects}@anchor{50e5}@anchor{c-api/slice translation-repo}@anchor{50e6}
@subsubsection Objetos Slice


@geindex PySlice_Type (C var)
@anchor{c-api/slice c PySlice_Type}@anchor{4d52}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PySlice_Type
` Parte da @ref{553,,ABI Estável}.'
Tipo de objeto para objetos fatia. Isso é o mesmo que @ref{469,,slice} na camada Python.
@end deffn

@geindex PySlice_Check (C function)
@anchor{c-api/slice c PySlice_Check}@anchor{50e7}
@deffn {C Função} int PySlice_Check (PyObject *ob)

Retorna true se `ob' for um objeto fatia; `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PySlice_New (C function)
@anchor{c-api/slice c PySlice_New}@anchor{4d51}
@deffn {C Função} @ref{339,,PyObject} *PySlice_New (PyObject *start, PyObject *stop, PyObject *step)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um novo objeto fatia com os valores fornecidos. Os parâmetros `start', `stop' e `step' são usados como os valores dos atributos do objeto fatia com os mesmos nomes. Qualquer um dos valores pode ser @code{NULL}, caso em que @code{None} será usado para o atributo correspondente.

Retorna @code{NULL} com uma exceção definida se o novo objeto não puder ser alocado.
@end deffn

@geindex PySlice_GetIndices (C function)
@anchor{c-api/slice c PySlice_GetIndices}@anchor{4d50}
@deffn {C Função} int PySlice_GetIndices (PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` Parte da @ref{553,,ABI Estável}.'
Recupera os índices de início, parada e intermediário do objeto fatia `slice', presumindo uma sequência de comprimento `length'. Trata índices maiores que `length' como erros.

Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro sem exceção definida (a menos que um dos índices não fosse @code{None} e falhou ao ser convertido para um inteiro, neste caso @code{-1} é retornado com uma exceção definida).

Você provavelmente não deseja usar esta função.


Alterado na versão 3.2: O tipo de parâmetro para o parâmetro `slice' era antes de @code{PySliceObject*}.

@end deffn

@geindex PySlice_GetIndicesEx (C function)
@anchor{c-api/slice c PySlice_GetIndicesEx}@anchor{3fc}
@deffn {C Função} 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)
` Parte da @ref{553,,ABI Estável}.'
Substituição utilizável para @ref{4d50,,PySlice_GetIndices()}. Recupera os índices de início, parada e intermediário do objeto fatia `slice' presumindo uma sequência de comprimento `length' e armazena o comprimento da fatia em `slicelength'. Índices fora dos limites são cortados de maneira consistente com o tratamento de fatias normais.

Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro com uma exceção definida.

@cartouche
@quotation Nota 
Esta função não é considerada segura para sequências redimensionáveis. Sua invocação deve ser substituída por uma combinação de @ref{3fd,,PySlice_Unpack()} e @ref{3fe,,PySlice_AdjustIndices()} sendo

@example
if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) @{
    // retorna erro
@}
@end example

substituído por

@example
if (PySlice_Unpack(slice, &start, &stop, &step) < 0) @{
    // retorna erro
@}
slicelength = PySlice_AdjustIndices(length, &start, &stop, step);
@end example
@end quotation
@end cartouche


Alterado na versão 3.2: O tipo de parâmetro para o parâmetro `slice' era antes de @code{PySliceObject*}.



Alterado na versão 3.6.1: Se @code{Py_LIMITED_API} não estiver definido ou estiver definido com um valor entre @code{0x03050400} e @code{0x03060000} (não incluso) ou @code{0x03060100} ou mais alto, @code{PySlice_GetIndicesEx()} é implementado como uma macro usando @code{PySlice_Unpack()} e @code{PySlice_AdjustIndices()}. Os argumentos `start', `stop' e `step' são avaliados mais de uma vez.



Descontinuado desde a versão 3.6.1: Se @code{Py_LIMITED_API} estiver definido para um valor menor que @code{0x03050400} ou entre @code{0x03060000} e @code{0x03060100} (não incluso), @code{PySlice_GetIndicesEx()} é uma função descontinuada.

@end deffn

@geindex PySlice_Unpack (C function)
@anchor{c-api/slice c PySlice_Unpack}@anchor{3fd}
@deffn {C Função} int PySlice_Unpack (PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Extrai os membros de dados de início, parada e intermediário de um objeto fatia como C inteiros. Reduz silenciosamente os valores maiores do que @code{PY_SSIZE_T_MAX} para @code{PY_SSIZE_T_MAX}, aumenta silenciosamente os valores de início e parada menores que @code{PY_SSIZE_T_MIN} para @code{PY_SSIZE_T_MIN}, e silenciosamente aumenta os valores de intermediário menores que @code{-PY_SSIZE_T_MAX} para @code{-PY_SSIZE_T_MAX}.

Retorna @code{-1} com uma exceção definida em caso de erro, @code{0} em caso de sucesso.


Adicionado na versão 3.6.1.

@end deffn

@geindex PySlice_AdjustIndices (C function)
@anchor{c-api/slice c PySlice_AdjustIndices}@anchor{3fe}
@deffn {C Função} @ref{a69,,Py_ssize_t} PySlice_AdjustIndices (Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Ajusta os índices de fatias inicial/final presumindo uma sequência do comprimento especificado. Índices fora dos limites são cortados de maneira consistente com o tratamento de fatias normais.

Retorna o comprimento da fatia. Sempre bem-sucedido. Não chama o código Python.


Adicionado na versão 3.6.1.

@end deffn

@menu
* Objeto Ellipsis:: 

@end menu

@node Objeto Ellipsis,,,Objetos Slice
@anchor{c-api/slice ellipsis-object}@anchor{50e8}
@subsubsection Objeto Ellipsis


@geindex PyEllipsis_Type (C var)
@anchor{c-api/slice c PyEllipsis_Type}@anchor{4c62}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyEllipsis_Type
` Parte da @ref{553,,ABI Estável}.'
O tipo do objeto Python @ref{231c,,Ellipsis}. O mesmo que @ref{854,,types.EllipsisType} na camada Python.
@end deffn

@geindex Py_Ellipsis (C var)
@anchor{c-api/slice c Py_Ellipsis}@anchor{50e9}
@deffn {C Variável} @ref{339,,PyObject} *Py_Ellipsis

O objeto Python @code{Ellipsis}. Este objeto não tem métodos. Como @ref{4b48,,Py_None}, é um objeto singleton @ref{45bb,,imortal}.


Alterado na versão 3.12: @ref{50e9,,Py_Ellipsis} é imortal.

@end deffn

@geindex objeto;memoryview
@anchor{c-api/memoryview memoryview-objects}@anchor{4f46}
@node Objetos MemoryView,Objetos buffer serializados com pickle,Objetos Slice,Outros Objetos
@anchor{c-api/memoryview doc}@anchor{50ea}@anchor{c-api/memoryview id1}@anchor{50eb}@anchor{c-api/memoryview translation-repo}@anchor{50ec}
@subsubsection Objetos MemoryView


Um objeto @ref{2eb,,memoryview} expõe a @ref{2e8,,interface de buffer} a nível de C como um objeto Python que pode ser passado como qualquer outro objeto.

@geindex PyMemoryView_Type (C var)
@anchor{c-api/memoryview c PyMemoryView_Type}@anchor{4cf4}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyMemoryView_Type
` Parte da @ref{553,,ABI Estável}.'
Esta instância de @ref{ab4,,PyTypeObject} representa o tipo memoryview Python. Este é o mesmo objeto que @ref{2eb,,memoryview} na camada Python.
@end deffn

@geindex PyMemoryView_FromObject (C function)
@anchor{c-api/memoryview c PyMemoryView_FromObject}@anchor{4cf2}
@deffn {C Função} @ref{339,,PyObject} *PyMemoryView_FromObject (PyObject *obj)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um objeto memoryview a partir de um objeto que fornece a interface do buffer. Se `obj' tiver suporte a exportações de buffer graváveis, o objeto memoryview será de leitura/gravação; caso contrário, poderá ser somente leitura ou leitura/gravação, a critério do exportador.
@end deffn

@geindex PyBUF_READ (C macro)
@anchor{c-api/memoryview c PyBUF_READ}@anchor{1786}
@deffn {C Macro} PyBUF_READ
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Sinalizador para solicitar um buffer de somente leitura.
@end deffn

@geindex PyBUF_WRITE (C macro)
@anchor{c-api/memoryview c PyBUF_WRITE}@anchor{1787}
@deffn {C Macro} PyBUF_WRITE
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Sinalizador para solicitar um buffer gravável.
@end deffn

@geindex PyMemoryView_FromMemory (C function)
@anchor{c-api/memoryview c PyMemoryView_FromMemory}@anchor{11af}
@deffn {C Função} @ref{339,,PyObject} *PyMemoryView_FromMemory (char *mem, Py_ssize_t size, int flags)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Cria um objeto memoryview usando `mem' como o buffer subjacente. `flags' pode ser um dos seguintes @ref{1786,,PyBUF_READ} ou @ref{1787,,PyBUF_WRITE}.


Adicionado na versão 3.3.

@end deffn

@geindex PyMemoryView_FromBuffer (C function)
@anchor{c-api/memoryview c PyMemoryView_FromBuffer}@anchor{761}
@deffn {C Função} @ref{339,,PyObject} *PyMemoryView_FromBuffer (const Py_buffer *view)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
Cria um objeto de memoryview envolvendo a estrutura de buffer `view' fornecida. Para buffers de bytes simples, @ref{11af,,PyMemoryView_FromMemory()} é a função preferida.
@end deffn

@geindex PyMemoryView_GetContiguous (C function)
@anchor{c-api/memoryview c PyMemoryView_GetContiguous}@anchor{4cf3}
@deffn {C Função} @ref{339,,PyObject} *PyMemoryView_GetContiguous (PyObject *obj, int buffertype, char order)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um objeto memoryview para um pedaço @ref{23b9,,contíguo} de memória (na ordem ‘C’ ou ‘F’ortran, representada por `order') a partir de um objeto que define a interface do buffer. Se a memória for contígua, o objeto memoryview apontará para a memória original. Caso contrário, é feita uma cópia e a visualização da memória aponta para um novo objeto bytes.

`buffertype' pode ser um entre @ref{1786,,PyBUF_READ} ou @ref{1787,,PyBUF_WRITE}.
@end deffn

@geindex PyMemoryView_Check (C function)
@anchor{c-api/memoryview c PyMemoryView_Check}@anchor{50ed}
@deffn {C Função} int PyMemoryView_Check (PyObject *obj)

Retorna true se o objeto `obj' for um objeto memoryview. Atualmente, não é permitido criar subclasses de @ref{2eb,,memoryview}. Esta função sempre tem sucesso.
@end deffn

@geindex PyMemoryView_GET_BUFFER (C function)
@anchor{c-api/memoryview c PyMemoryView_GET_BUFFER}@anchor{50ee}
@deffn {C Função} @ref{758,,Py_buffer} *PyMemoryView_GET_BUFFER (PyObject *mview)

Retorna um ponteiro para a cópia privada da memória do buffer do exportador. `mview' `deve' ser uma instância de memoryview; Se essa macro não verificar seu tipo, faça você mesmo ou corre o risco de travar.
@end deffn

@geindex PyMemoryView_GET_BASE (C function)
@anchor{c-api/memoryview c PyMemoryView_GET_BASE}@anchor{50ef}
@deffn {C Função} @ref{339,,PyObject} *PyMemoryView_GET_BASE (PyObject *mview)

Retorna um ponteiro para o objeto de exportação no qual a memória é baseada ou @code{NULL} se a memória tiver sido criada por uma das funções @ref{11af,,PyMemoryView_FromMemory()} ou @ref{761,,PyMemoryView_FromBuffer()}. `mview' `deve' ser uma instância de memoryview.
@end deffn

@geindex objeto;PickleBuffer
@anchor{c-api/picklebuffer picklebuffer-objects}@anchor{50f0}
@node Objetos buffer serializados com pickle,Objetos referência fraca<2>,Objetos MemoryView,Outros Objetos
@anchor{c-api/picklebuffer doc}@anchor{50f1}@anchor{c-api/picklebuffer pickle-buffer-objects}@anchor{50f2}@anchor{c-api/picklebuffer translation-repo}@anchor{50f3}
@subsubsection Objetos buffer serializados com pickle



Adicionado na versão 3.8.


Um objeto @ref{15a2,,pickle.PickleBuffer} encapsula um @ref{2e8,,objeto provedor de buffer} para transferência de dados fora de banda com o módulo @ref{a6,,pickle}.

@geindex PyPickleBuffer_Type (C var)
@anchor{c-api/picklebuffer c PyPickleBuffer_Type}@anchor{50f4}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyPickleBuffer_Type

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo de buffer serializado com pickle do Python. Este é o mesmo objeto que @ref{15a2,,pickle.PickleBuffer} na camada Python.
@end deffn

@geindex PyPickleBuffer_Check (C function)
@anchor{c-api/picklebuffer c PyPickleBuffer_Check}@anchor{50f5}
@deffn {C Função} int PyPickleBuffer_Check (PyObject *op)

Retorna verdadeiro se `op' for uma instância de buffer serializado com pickle. Esta função sempre tem sucesso.
@end deffn

@geindex PyPickleBuffer_FromObject (C function)
@anchor{c-api/picklebuffer c PyPickleBuffer_FromObject}@anchor{50f6}
@deffn {C Função} @ref{339,,PyObject} *PyPickleBuffer_FromObject (PyObject *obj)

Cria um buffer serializado com pickle a partir do objeto `obj'.

Esta função falhará se `obj' não oferecer suporte ao @ref{2e8,,protocolo de buffer}.

Em caso de sucesso, retorna uma nova instância de buffer serializado com pickle. Em caso de falha, define uma exceção e retorna @code{NULL}.

Análogo a chamar @ref{15a2,,pickle.PickleBuffer} com `obj' em Python.
@end deffn

@geindex PyPickleBuffer_GetBuffer (C function)
@anchor{c-api/picklebuffer c PyPickleBuffer_GetBuffer}@anchor{50f7}
@deffn {C Função} const @ref{758,,Py_buffer} *PyPickleBuffer_GetBuffer (PyObject *picklebuf)

Obtém um ponteiro para o @ref{758,,Py_buffer} subjacente que o buffer serializado com pickle encapsula.

O ponteiro retornado é válido enquanto `picklebuf' estiver ativo e não tiver sido liberado. O chamador não deve modificar ou liberar o @ref{758,,Py_buffer} retornado. Se o buffer serializado com pickle tiver sido liberado, levanta uma exceção @ref{202,,ValueError}.

Em caso de sucesso, retorna um ponteiro para a visualização do buffer. Em caso de falha, define uma exceção e retorna @code{NULL}.
@end deffn

@geindex PyPickleBuffer_Release (C function)
@anchor{c-api/picklebuffer c PyPickleBuffer_Release}@anchor{50f8}
@deffn {C Função} int PyPickleBuffer_Release (PyObject *picklebuf)

Libera o buffer subjacente mantido pelo buffer serializado com pickle.

Retorna @code{0} em caso de sucesso. Em caso de falha, define uma exceção e retorna @code{-1}.

Análogo a chamar @ref{2a54,,pickle.PickleBuffer.release()} em Python.
@end deffn

@node Objetos referência fraca<2>,Capsules<2>,Objetos buffer serializados com pickle,Outros Objetos
@anchor{c-api/weakref doc}@anchor{50f9}@anchor{c-api/weakref translation-repo}@anchor{50fa}@anchor{c-api/weakref weak-reference-objects}@anchor{50fb}@anchor{c-api/weakref weakrefobjects}@anchor{4f71}
@subsubsection Objetos referência fraca


O Python oferece suporte a `referências fracas' como objetos de primeira classe. Existem dois tipos de objetos específicos que implementam diretamente referências fracas. O primeiro é um objeto de referência simples, e o segundo atua como um intermediário ao objeto original tanto quanto ele pode.

@geindex PyWeakref_Check (C function)
@anchor{c-api/weakref c PyWeakref_Check}@anchor{50fc}
@deffn {C Função} int PyWeakref_Check (PyObject *ob)

Retorna não zero se `ob' for um objeto referência ou um objeto intermediário. Esta função sempre tem sucesso.
@end deffn

@geindex PyWeakref_CheckRef (C function)
@anchor{c-api/weakref c PyWeakref_CheckRef}@anchor{50fd}
@deffn {C Função} int PyWeakref_CheckRef (PyObject *ob)

Retorna não zero se `ob' for um objeto referência ou uma subclasse do tipo de referência. Esta função sempre tem sucesso.
@end deffn

@geindex PyWeakref_CheckRefExact (C function)
@anchor{c-api/weakref c PyWeakref_CheckRefExact}@anchor{50fe}
@deffn {C Função} int PyWeakref_CheckRefExact (PyObject *ob)

Retorna não zero se `ob' for um objeto referência, mas não uma subclasse do tipo de referência. Esta função sempre tem sucesso.
@end deffn

@geindex PyWeakref_CheckProxy (C function)
@anchor{c-api/weakref c PyWeakref_CheckProxy}@anchor{50ff}
@deffn {C Função} int PyWeakref_CheckProxy (PyObject *ob)

Retorna não zero se `ob' for um objeto intermediário. Esta função sempre tem sucesso.
@end deffn

@geindex PyWeakref_NewRef (C function)
@anchor{c-api/weakref c PyWeakref_NewRef}@anchor{196f}
@deffn {C Função} @ref{339,,PyObject} *PyWeakref_NewRef (PyObject *ob, PyObject *callback)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um objeto de referência fraco para o objeto `ob'. Isso sempre retornará uma nova referência, mas não é garantido para criar um novo objeto; um objeto de referência existente pode ser retornado. O segundo parâmetro, `callback', pode ser um objeto chamável que recebe notificação quando `ob' for lixo coletado; ele deve aceitar um único parâmetro, que será o objeto de referência fraco propriamente dito. `callback' também pode ser @code{None} ou @code{NULL}. Se `ob' não for um objeto fracamente referenciável, ou se `callback' não for um chamável, @code{None}, ou @code{NULL}, isso retornará @code{NULL} e levantará a @ref{2c3,,TypeError}.


@subsubheading Ver também


@ref{4f70,,PyType_SUPPORTS_WEAKREFS()} para verificar se `ob' é fracamente referenciável.

@end deffn

@geindex PyWeakref_NewProxy (C function)
@anchor{c-api/weakref c PyWeakref_NewProxy}@anchor{4dbb}
@deffn {C Função} @ref{339,,PyObject} *PyWeakref_NewProxy (PyObject *ob, PyObject *callback)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Retorna um objeto de proxy de referência fraca para o objeto `ob'. Isso sempre retornará uma nova referência, mas não é garantido para criar um novo objeto; um objeto de proxy existente pode ser retornado. O segundo parâmetro, `callback', pode ser um objeto chamável que recebe notificação quando `ob' for lixo coletado; ele deve aceitar um único parâmetro, que será o objeto de referência fraco propriamente dito. `callback' também pode ser @code{None} ou @code{NULL}. Se `ob' não for um objeto referência fraca, ou se `callback' não for um chamável, @code{None}, ou @code{NULL}, isso retornará @code{NULL} e levantará a @ref{2c3,,TypeError}.


@subsubheading Ver também


@ref{4f70,,PyType_SUPPORTS_WEAKREFS()} para verificar se `ob' é fracamente referenciável.

@end deffn

@geindex PyWeakref_GetRef (C function)
@anchor{c-api/weakref c PyWeakref_GetRef}@anchor{378}
@deffn {C Função} int PyWeakref_GetRef (PyObject *ref, PyObject **pobj)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Obtém uma @ref{33d,,referência forte} para o objeto referenciado a partir de uma referência fraca, `ref', em `*pobj'.


@itemize *

@item 
Em caso de sucesso, define `*pobj' como uma nova @ref{33d,,referência forte} para o objeto referenciado e retorna 1.

@item 
Se a referência estiver quebrada, define `*pobj' como @code{NULL} e retorna 0.

@item 
Em caso de erro, levanta uma exceção e retorna -1.
@end itemize


Adicionado na versão 3.13.

@end deffn

@geindex PyWeakref_GetObject (C function)
@anchor{c-api/weakref c PyWeakref_GetObject}@anchor{379}
@deffn {C Função} @ref{339,,PyObject} *PyWeakref_GetObject (PyObject *ref)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Retorna uma @ref{33e,,referência emprestada} ao objeto referenciado a partir de uma referência fraca, `ref'. Se o referente não estiver mais em tempo real, retorna @code{Py_None}.

@cartouche
@quotation Nota 
Esta função retorna uma @ref{33e,,referência emprestada} para o objeto referenciado. Isso significa que você deve sempre chamar @ref{56e,,Py_INCREF()} no objeto, exceto quando ele não puder ser destruído antes do último uso da referência emprestada.
@end quotation
@end cartouche


Descontinuado desde a versão 3.13, será removido na versão 3.15: Usa @ref{378,,PyWeakref_GetRef()}.

@end deffn

@geindex PyWeakref_GET_OBJECT (C function)
@anchor{c-api/weakref c PyWeakref_GET_OBJECT}@anchor{3bf}
@deffn {C Função} @ref{339,,PyObject} *PyWeakref_GET_OBJECT (PyObject *ref)
`Retorna valor: Referência emprestada.'
Semelhante a @ref{379,,PyWeakref_GetObject()}, mas não verifica erros.


Descontinuado desde a versão 3.13, será removido na versão 3.15: Usa @ref{378,,PyWeakref_GetRef()}.

@end deffn

@geindex PyObject_ClearWeakRefs (C function)
@anchor{c-api/weakref c PyObject_ClearWeakRefs}@anchor{576}
@deffn {C Função} void PyObject_ClearWeakRefs (PyObject *object)
` Parte da @ref{553,,ABI Estável}.'
Esta função é chamada pelo tratador @ref{4b66,,tp_dealloc} para limpar referências fracas.

Isso itera pelas referências fracas para `object' e chama retornos de chamada para as referências que possuem um. Ele retorna quando todos os retornos de chamada foram tentados.
@end deffn

@geindex PyUnstable_Object_ClearWeakRefsNoCallbacks (C function)
@anchor{c-api/weakref c PyUnstable_Object_ClearWeakRefsNoCallbacks}@anchor{16fe}
@deffn {C Função} void PyUnstable_Object_ClearWeakRefsNoCallbacks (PyObject *object)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Limpa as referências fracas para `object' sem chamar as funções de retorno

Esta função é chamada pelo manipulador @ref{4b66,,tp_dealloc} para tipos com finalizadores (por exemplo, @ref{1033,,__del__()}). O manipulador para esses objetos primeiro chama @ref{576,,PyObject_ClearWeakRefs()} para limpar referências fracas e chamar suas funções de retorno, depois o finalizador e, finalmente, esta função para limpar quaisquer referências fracas que possam ter sido criadas pelo finalizador.

Na maioria das circunstâncias, é mais apropriado usar @ref{576,,PyObject_ClearWeakRefs()} para limpar referências fracas em vez desta função.


Adicionado na versão 3.13.

@end deffn

@node Capsules<2>,Objetos Frame,Objetos referência fraca<2>,Outros Objetos
@anchor{c-api/capsule doc}@anchor{5100}@anchor{c-api/capsule capsules}@anchor{2723}@anchor{c-api/capsule id1}@anchor{5101}@anchor{c-api/capsule translation-repo}@anchor{5102}
@subsubsection Capsules


@geindex objeto;Cápsula

Consulte @ref{13a4,,Fornecendo uma API C para um módulo de extensão} para obter mais informações sobre o uso desses objetos.


Adicionado na versão 3.1.


@geindex PyCapsule (C type)
@anchor{c-api/capsule c PyCapsule}@anchor{12b4}
@deffn {C Tipo} type PyCapsule

Este subtipo de @ref{339,,PyObject} representa um valor opaco, útil para módulos de extensão C que precisam passar um valor opaco (como ponteiro void*) através do código Python para outro código C . É frequentemente usado para disponibilizar um ponteiro de função C definido em um módulo para outros módulos, para que o mecanismo de importação regular possa ser usado para acessar APIs C definidas em módulos carregados dinamicamente.
@end deffn

@geindex PyCapsule_Type (C var)
@anchor{c-api/capsule c PyCapsule_Type}@anchor{4c35}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCapsule_Type
` Parte da @ref{553,,ABI Estável}.'
O objeto de tipo correspondente aos objetos cápsula. Este é o mesmo objeto que @ref{2722,,types.CapsuleType} na camada Python.
@end deffn

@geindex PyCapsule_Destructor (C type)
@anchor{c-api/capsule c PyCapsule_Destructor}@anchor{4c2c}
@deffn {C Tipo} type PyCapsule_Destructor
` Parte da @ref{553,,ABI Estável}.'
O tipo de um retorno de chamada destruidor para uma cápsula. Definido como:

@example
typedef void (*PyCapsule_Destructor)(PyObject *);
@end example

Veja @ref{4b6d,,PyCapsule_New()} para a semântica dos retornos de chamada PyCapsule_Destructor.
@end deffn

@geindex PyCapsule_CheckExact (C function)
@anchor{c-api/capsule c PyCapsule_CheckExact}@anchor{5103}
@deffn {C Função} int PyCapsule_CheckExact (PyObject *p)

Retorna true se seu argumento é um @ref{12b4,,PyCapsule}. Esta função sempre tem sucesso.
@end deffn

@geindex PyCapsule_New (C function)
@anchor{c-api/capsule c PyCapsule_New}@anchor{4b6d}
@deffn {C Função} @ref{339,,PyObject} *PyCapsule_New (void *pointer, const char *name, PyCapsule_Destructor destructor)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Cria um @ref{12b4,,PyCapsule} que encapsula o `ponteiro'. O argumento `pointer' pode não ser @code{NULL}.

Em caso de falha, define uma exceção e retorna @code{NULL}.

A string `name' pode ser @code{NULL} ou um ponteiro para uma string C válida. Se não for @code{NULL}, essa string deverá sobreviver à cápsula. (Embora seja permitido liberá-lo dentro do `descructor'.)

Se o argumento `destructor' não for @code{NULL}, ele será chamado com a cápsula como argumento quando for destruído.

Se esta cápsula for armazenada como um atributo de um módulo, o `name' deve ser especificado como @code{modulename.attributename}. Isso permitirá que outros módulos importem a cápsula usando @ref{1999,,PyCapsule_Import()}.
@end deffn

@geindex PyCapsule_GetPointer (C function)
@anchor{c-api/capsule c PyCapsule_GetPointer}@anchor{4c30}
@deffn {C Função} void *PyCapsule_GetPointer (PyObject *capsule, const char *name)
` Parte da @ref{553,,ABI Estável}.'
Recupera o `pointer' armazenado na cápsula. Em caso de falha, define uma exceção e retorna @code{NULL}.

O parâmetro `name' deve ser comparado exatamente com o nome armazenado na cápsula. Se o nome armazenado na cápsula for @code{NULL}, o `name' passado também deve ser @code{NULL}. Python usa a função C @code{strcmp()} para comparar nomes de cápsulas.
@end deffn

@geindex PyCapsule_GetDestructor (C function)
@anchor{c-api/capsule c PyCapsule_GetDestructor}@anchor{4c2e}
@deffn {C Função} @ref{4c2c,,PyCapsule_Destructor} PyCapsule_GetDestructor (PyObject *capsule)
` Parte da @ref{553,,ABI Estável}.'
Retorna o destruidor atual armazenado na cápsula. Em caso de falha, define uma exceção e retorna @code{NULL}.

É legal para uma cápsula ter um destruidor @code{NULL}. Isso torna um código de retorno @code{NULL} um tanto ambíguo; use @ref{13a3,,PyCapsule_IsValid()} ou @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_GetContext (C function)
@anchor{c-api/capsule c PyCapsule_GetContext}@anchor{4c2d}
@deffn {C Função} void *PyCapsule_GetContext (PyObject *capsule)
` Parte da @ref{553,,ABI Estável}.'
Retorna o contexto atual armazenado na cápsula. Em caso de falha, define uma exceção e retorna @code{NULL}.

É legal para uma cápsula ter um contexto @code{NULL}. Isso torna um código de retorno @code{NULL} um tanto ambíguo; use @ref{13a3,,PyCapsule_IsValid()} ou @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_GetName (C function)
@anchor{c-api/capsule c PyCapsule_GetName}@anchor{4c2f}
@deffn {C Função} const char *PyCapsule_GetName (PyObject *capsule)
` Parte da @ref{553,,ABI Estável}.'
Retorna o nome atual armazenado na cápsula. Em caso de falha, define uma exceção e retorna @code{NULL}.

É legal para uma cápsula ter um nome @code{NULL}. Isso torna um código de retorno @code{NULL} um tanto ambíguo; use @ref{13a3,,PyCapsule_IsValid()} ou @ref{1a3b,,PyErr_Occurred()} para desambiguar.
@end deffn

@geindex PyCapsule_Import (C function)
@anchor{c-api/capsule c PyCapsule_Import}@anchor{1999}
@deffn {C Função} void *PyCapsule_Import (const char *name, int no_block)
` Parte da @ref{553,,ABI Estável}.'
Importa um ponteiro para um objeto C de um atributo de cápsula em um módulo. O parâmetro `name' deve especificar o nome completo do atributo, como em @code{module.attribute}. O `name' armazenado na cápsula deve corresponder exatamente a essa string.

Esta função divide `name' no caractere @code{.} e importa o primeiro elemento. Em seguida, processa os elementos seguintes usando pesquisas de atributos.

Retorna o ponteiro interno `pointer' da cápsula com sucesso. Em caso de falha, define uma exceção e retorna @code{NULL}.

@cartouche
@quotation Nota 
Se `name' apontar para um atributo de algum submódulo ou subpacote, esse submódulo ou subpacote deverá ser importado previamente usando outros meios (por exemplo, usando @ref{3be,,PyImport_ImportModule()}) para que as pesquisas de atributos sejam bem-sucedidas.
@end quotation
@end cartouche


Alterado na versão 3.3: `no_block' não tem mais efeito.

@end deffn

@geindex PyCapsule_IsValid (C function)
@anchor{c-api/capsule c PyCapsule_IsValid}@anchor{13a3}
@deffn {C Função} int PyCapsule_IsValid (PyObject *capsule, const char *name)
` Parte da @ref{553,,ABI Estável}.'
Determina se `capsule' é ou não uma cápsula válida. Uma cápsula válida é diferente de @code{NULL}, passa @ref{5103,,PyCapsule_CheckExact()}, possui um ponteiro diferente de @code{NULL} armazenado e seu nome interno corresponde ao parâmetro `name'. (Consulte @ref{4c30,,PyCapsule_GetPointer()} para obter informações sobre como os nomes das cápsulas são comparados.)

Em outras palavras, se @ref{13a3,,PyCapsule_IsValid()} retornar um valor verdadeiro, as chamadas para qualquer um dos acessadores (qualquer função que comece com @code{PyCapsule_Get}) terão êxito garantido.

Retorna um valor diferente de zero se o objeto for válido e corresponder ao nome passado. Retorna @code{0} caso contrário. Esta função não falhará.
@end deffn

@geindex PyCapsule_SetContext (C function)
@anchor{c-api/capsule c PyCapsule_SetContext}@anchor{4c31}
@deffn {C Função} int PyCapsule_SetContext (PyObject *capsule, void *context)
` Parte da @ref{553,,ABI Estável}.'
Define o ponteiro de contexto dentro de `capsule' para `context'.

Retorna @code{0} em caso de sucesso. Retorna diferente de zero e define uma exceção em caso de falha.
@end deffn

@geindex PyCapsule_SetDestructor (C function)
@anchor{c-api/capsule c PyCapsule_SetDestructor}@anchor{4c32}
@deffn {C Função} int PyCapsule_SetDestructor (PyObject *capsule, PyCapsule_Destructor destructor)
` Parte da @ref{553,,ABI Estável}.'
Define o destrutor dentro de `capsule' para `destructor'.

Retorna @code{0} em caso de sucesso. Retorna diferente de zero e define uma exceção em caso de falha.
@end deffn

@geindex PyCapsule_SetName (C function)
@anchor{c-api/capsule c PyCapsule_SetName}@anchor{4c33}
@deffn {C Função} int PyCapsule_SetName (PyObject *capsule, const char *name)
` Parte da @ref{553,,ABI Estável}.'
Define o nome dentro de `capsule' como `name'. Se não for @code{NULL}, o nome deve sobreviver à cápsula. Se o `name' anterior armazenado na cápsula não era @code{NULL}, nenhuma tentativa será feita para liberá-lo.

Retorna @code{0} em caso de sucesso. Retorna diferente de zero e define uma exceção em caso de falha.
@end deffn

@geindex PyCapsule_SetPointer (C function)
@anchor{c-api/capsule c PyCapsule_SetPointer}@anchor{4c34}
@deffn {C Função} int PyCapsule_SetPointer (PyObject *capsule, void *pointer)
` Parte da @ref{553,,ABI Estável}.'
Define o ponteiro nulo dentro de `capsule' para `pointer'. O ponteiro não pode ser @code{NULL}.

Retorna @code{0} em caso de sucesso. Retorna diferente de zero e define uma exceção em caso de falha.
@end deffn

@node Objetos Frame,Objetos Geradores,Capsules<2>,Outros Objetos
@anchor{c-api/frame doc}@anchor{5104}@anchor{c-api/frame frame-objects}@anchor{5105}@anchor{c-api/frame translation-repo}@anchor{5106}
@subsubsection Objetos Frame


@geindex PyFrameObject (C type)
@anchor{c-api/frame c PyFrameObject}@anchor{789}
@deffn {C Tipo} type PyFrameObject
` Parte da @ref{553,,API Limitada} (como uma estrutura opaca).'
A estrutura C dos objetos usados para descrever objetos frame.

Não há membros públicos nesta estrutura.


Alterado na versão 3.11: Os membros dessa estrutura foram removidos da API C pública. Consulte a @ref{788,,entrada O Que há de Novo} para detalhes.

@end deffn

As funções @ref{18c1,,PyEval_GetFrame()} e @ref{78e,,PyThreadState_GetFrame()} podem ser utilizadas para obter um objeto frame.

Veja também @ref{4eea,,Reflexão}.

@geindex PyFrame_Type (C var)
@anchor{c-api/frame c PyFrame_Type}@anchor{787}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFrame_Type

O tipo de objetos frame. É o mesmo objeto que @ref{1977,,types.FrameType} na camada Python.


Alterado na versão 3.11: Anteriormente, este tipo só estava disponível após incluir @code{<frameobject.h>}.

@end deffn

@geindex PyFrame_New (C function)
@anchor{c-api/frame c PyFrame_New}@anchor{1877}
@deffn {C Função} @ref{789,,PyFrameObject} *PyFrame_New (PyThreadState *tstate, PyCodeObject *code, PyObject *globals, PyObject *locals)

Cria um novo objeto quadro. Esta função retorna uma @ref{33d,,referência forte} ao novo objeto quadro em caso de sucesso e retorna @code{NULL} com uma exceção definida em caso de falha.
@end deffn

@geindex PyFrame_Check (C function)
@anchor{c-api/frame c PyFrame_Check}@anchor{785}
@deffn {C Função} int PyFrame_Check (PyObject *obj)

Retorna diferente de zero se `obj' é um objeto frame


Alterado na versão 3.11: Anteriormente, esta função só estava disponível após incluir @code{<frameobject.h>}.

@end deffn

@geindex PyFrame_GetBack (C function)
@anchor{c-api/frame c PyFrame_GetBack}@anchor{786}
@deffn {C Função} @ref{789,,PyFrameObject} *PyFrame_GetBack (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Obtém o `frame' próximo ao quadro externo.

Retorna uma @ref{33d,,referência forte} ou @code{NULL} se `frame' não tiver quadro externo.


Adicionado na versão 3.9.

@end deffn

@geindex PyFrame_GetBuiltins (C function)
@anchor{c-api/frame c PyFrame_GetBuiltins}@anchor{76b}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetBuiltins (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Obtém o atributo @ref{20df,,f_builtins} do `frame'.

Retorna uma @ref{33d,,referência forte}. O resultado não pode ser @code{NULL}.


Adicionado na versão 3.11.

@end deffn

@geindex PyFrame_GetCode (C function)
@anchor{c-api/frame c PyFrame_GetCode}@anchor{78a}
@deffn {C Função} @ref{777,,PyCodeObject} *PyFrame_GetCode (PyFrameObject *frame)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Obtém o código de `frame'.

Retorna uma @ref{33d,,referência forte}.

O resultado (código do frame) não pode ser @code{NULL}.


Adicionado na versão 3.9.

@end deffn

@geindex PyFrame_GetGenerator (C function)
@anchor{c-api/frame c PyFrame_GetGenerator}@anchor{76c}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetGenerator (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Obtém o gerador, corrotina ou gerador assíncrono que possui este frame, ou @code{NULL} se o frame não pertence a um gerador. Não levanta exceção, mesmo que o valor retornado seja @code{NULL}.

Retorna uma @ref{33d,,referência forte}, ou @code{NULL}.


Adicionado na versão 3.11.

@end deffn

@geindex PyFrame_GetGlobals (C function)
@anchor{c-api/frame c PyFrame_GetGlobals}@anchor{76d}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetGlobals (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Obtenha o atributo @ref{20de,,f_globals} do `frame'.

Retorna uma @ref{33d,,referência forte}. O resultado não pode ser @code{NULL}.


Adicionado na versão 3.11.

@end deffn

@geindex PyFrame_GetLasti (C function)
@anchor{c-api/frame c PyFrame_GetLasti}@anchor{76e}
@deffn {C Função} int PyFrame_GetLasti (PyFrameObject *frame)

Obtenha o atributo @ref{88c,,f_lasti} do `frame'.

Retorna -1 se @code{frame.f_lasti} é @code{None}.


Adicionado na versão 3.11.

@end deffn

@geindex PyFrame_GetVar (C function)
@anchor{c-api/frame c PyFrame_GetVar}@anchor{568}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetVar (PyFrameObject *frame, PyObject *name)
`Retorna valor: Nova referência.'
Obtém a variável `name' de `frame'.


@itemize *

@item 
Retorna uma @ref{33d,,referência forte} ao valor da variável em caso de sucesso.

@item 
Levanta uma exceção @ref{43f,,NameError} e retorna @code{NULL} se a variável não existir.

@item 
Levanta uma exceção e retorna @code{NULL} em caso de erro.
@end itemize

Tipo de `name' deve ser um @ref{44c,,str}.


Adicionado na versão 3.12.

@end deffn

@geindex PyFrame_GetVarString (C function)
@anchor{c-api/frame c PyFrame_GetVarString}@anchor{569}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetVarString (PyFrameObject *frame, const char *name)
`Retorna valor: Nova referência.'
Semelhante a @ref{568,,PyFrame_GetVar()}, mas o nome da variável é uma string C codificada em UTF-8.


Adicionado na versão 3.12.

@end deffn

@geindex PyFrame_GetLocals (C function)
@anchor{c-api/frame c PyFrame_GetLocals}@anchor{41f}
@deffn {C Função} @ref{339,,PyObject} *PyFrame_GetLocals (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Obtém o atributo @ref{182,,f_locals} do `frame'. Se o quadro se referir a um @ref{17e,,escopo otimizado}, isso retorna um objeto proxy de escrita direta que permite modificar as variáveis locais. Em todos os outros casos (classes, módulos, @ref{17f,,exec()} e @ref{180,,eval()}), retorna o mapeamento que representa as variáveis locais do frame diretamente (como descrito para @ref{141,,locals()}).

Retorna uma @ref{33d,,referência forte}.


Adicionado na versão 3.11.



Alterado na versão 3.13: Como parte de 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}, retorna uma instância de @ref{5107,,PyFrameLocalsProxy_Type}.

@end deffn

@geindex PyFrame_GetLineNumber (C function)
@anchor{c-api/frame c PyFrame_GetLineNumber}@anchor{78b}
@deffn {C Função} int PyFrame_GetLineNumber (PyFrameObject *frame)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Retorna o número da linha do `frame' atualmente em execução.
@end deffn

@menu
* Proxies locais de quadro:: 
* Legacy Local Variable APIs:: 
* Internal Frames:: 

@end menu

@node Proxies locais de quadro,Legacy Local Variable APIs,,Objetos Frame
@anchor{c-api/frame frame-locals-proxies}@anchor{5108}
@subsubsection Proxies locais de quadro



Adicionado na versão 3.13.


The @ref{182,,f_locals} attribute on a @ref{6e0,,frame object}
is an instance of a “frame-locals proxy”. The proxy object exposes a
write-through view of the underlying locals dictionary for the frame. This
ensures that the variables exposed by @code{f_locals} are always up to date with
the live local variables in the frame itself.

See 
@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} for more information.

@geindex PyFrameLocalsProxy_Type (C var)
@anchor{c-api/frame c PyFrameLocalsProxy_Type}@anchor{5107}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyFrameLocalsProxy_Type

The type of frame @ref{141,,locals()} proxy objects.
@end deffn

@geindex PyFrameLocalsProxy_Check (C function)
@anchor{c-api/frame c PyFrameLocalsProxy_Check}@anchor{5109}
@deffn {C Função} int PyFrameLocalsProxy_Check (PyObject *obj)

Return non-zero if `obj' is a frame @ref{141,,locals()} proxy.
@end deffn

@node Legacy Local Variable APIs,Internal Frames,Proxies locais de quadro,Objetos Frame
@anchor{c-api/frame legacy-local-variable-apis}@anchor{510a}
@subsubsection Legacy Local Variable APIs


These APIs are @ref{209,,soft deprecated}. As of Python 3.13, they do nothing.
They exist solely for backwards compatibility.

@geindex PyFrame_LocalsToFast (C function)
@anchor{c-api/frame c PyFrame_LocalsToFast}@anchor{510b}
@deffn {C Função} void PyFrame_LocalsToFast (PyFrameObject *f, int clear)

This function is @ref{209,,soft deprecated} and does nothing.

Prior to Python 3.13, this function would copy the @ref{182,,f_locals}
attribute of `f' to the internal “fast” array of local variables, allowing
changes in frame objects to be visible to the interpreter. If `clear' was
true, this function would process variables that were unset in the locals
dictionary.


Alterado na versão 3.13: Esta função agora não faz nada.

@end deffn

@geindex PyFrame_FastToLocals (C function)
@anchor{c-api/frame c PyFrame_FastToLocals}@anchor{510c}
@deffn {C Função} void PyFrame_FastToLocals (PyFrameObject *f)

This function is @ref{209,,soft deprecated} and does nothing.

Prior to Python 3.13, this function would copy the internal “fast” array
of local variables (which is used by the interpreter) to the
@ref{182,,f_locals} attribute of `f', allowing changes in local
variables to be visible to frame objects.


Alterado na versão 3.13: Esta função agora não faz nada.

@end deffn

@geindex PyFrame_FastToLocalsWithError (C function)
@anchor{c-api/frame c PyFrame_FastToLocalsWithError}@anchor{510d}
@deffn {C Função} int PyFrame_FastToLocalsWithError (PyFrameObject *f)

This function is @ref{209,,soft deprecated} and does nothing.

Prior to Python 3.13, this function was similar to
@ref{510c,,PyFrame_FastToLocals()}, but would return @code{0} on success, and
@code{-1} with an exception set on failure.


Alterado na versão 3.13: Esta função agora não faz nada.

@end deffn


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}


@node Internal Frames,,Legacy Local Variable APIs,Objetos Frame
@anchor{c-api/frame internal-frames}@anchor{510e}
@subsubsection Internal Frames


Unless using 
@geindex Propostas de Melhorias do Python; 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{510f}
@deffn {C Struct} struct _PyInterpreterFrame

The interpreter’s internal frame representation.


Adicionado na versão 3.11.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetCode (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetCode}@anchor{5110}
@deffn {C Função} @ref{339,,PyObject} *PyUnstable_InterpreterFrame_GetCode (struct _PyInterpreterFrame *frame);

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

@quotation

Return a @ref{33d,,strong reference} to the code object for the frame.
@end quotation


Adicionado na versão 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLasti (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLasti}@anchor{5111}
@deffn {C Função} int PyUnstable_InterpreterFrame_GetLasti (struct _PyInterpreterFrame *frame);

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Return the byte offset into the last executed instruction.


Adicionado na versão 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLine (C function)
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLine}@anchor{5112}
@deffn {C Função} int PyUnstable_InterpreterFrame_GetLine (struct _PyInterpreterFrame *frame);

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Return the currently executing line number, or -1 if there is no line number.


Adicionado na versão 3.12.

@end deffn

@node Objetos Geradores,Objetos corrotina<2>,Objetos Frame,Outros Objetos
@anchor{c-api/gen doc}@anchor{5113}@anchor{c-api/gen gen-objects}@anchor{5114}@anchor{c-api/gen generator-objects}@anchor{5115}@anchor{c-api/gen translation-repo}@anchor{5116}
@subsubsection Objetos Geradores


Objetos geradores são o que o Python usa para implementar iteradores geradores. Eles são normalmente criados por iteração sobre uma função que produz valores, em vez de invocar explicitamente @ref{5117,,PyGen_New()} ou @ref{5118,,PyGen_NewWithQualName()}.

@geindex PyGenObject (C type)
@anchor{c-api/gen c PyGenObject}@anchor{5119}
@deffn {C Tipo} type PyGenObject

A estrutura C usada para objetos geradores.
@end deffn

@geindex PyGen_Type (C var)
@anchor{c-api/gen c PyGen_Type}@anchor{511a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyGen_Type

O objeto de tipo correspondendo a objetos geradores.
@end deffn

@geindex PyGen_Check (C function)
@anchor{c-api/gen c PyGen_Check}@anchor{511b}
@deffn {C Função} int PyGen_Check (PyObject *ob)

Retorna verdadeiro se `ob' for um objeto gerador; `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyGen_CheckExact (C function)
@anchor{c-api/gen c PyGen_CheckExact}@anchor{511c}
@deffn {C Função} int PyGen_CheckExact (PyObject *ob)

Retorna verdadeiro se o tipo do `ob' é @ref{511a,,PyGen_Type}; `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyGen_New (C function)
@anchor{c-api/gen c PyGen_New}@anchor{5117}
@deffn {C Função} @ref{339,,PyObject} *PyGen_New (PyFrameObject *frame)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto gerador com base no objeto `frame'. Uma referência a `quadro' é roubada por esta função. O argumento não deve ser @code{NULL}.
@end deffn

@geindex PyGen_NewWithQualName (C function)
@anchor{c-api/gen c PyGen_NewWithQualName}@anchor{5118}
@deffn {C Função} @ref{339,,PyObject} *PyGen_NewWithQualName (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto gerador com base no objeto `frame', com @code{__name__} e @code{__qualname__} definidos como `name' e `qualname'. Uma referência a `frame' é roubada por esta função. O argumento `frame' não deve ser @code{NULL}.
@end deffn

@geindex PyGen_GetCode (C function)
@anchor{c-api/gen c PyGen_GetCode}@anchor{511d}
@deffn {C Função} @ref{777,,PyCodeObject} *PyGen_GetCode (PyGenObject *gen)

Retorna uma nova @ref{33d,,referência forte} ao objeto de código encapsulado por `gen'. Esta função sempre tem sucesso.
@end deffn

@menu
* Objetos geradores assíncronos:: 

@end menu

@node Objetos geradores assíncronos,,,Objetos Geradores
@anchor{c-api/gen asynchronous-generator-objects}@anchor{511e}
@subsubsection Objetos geradores assíncronos



@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}


@geindex PyAsyncGen_Type (C var)
@anchor{c-api/gen c PyAsyncGen_Type}@anchor{511f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyAsyncGen_Type

O objeto de tipo correspondente aos objetos geradores assíncronos. Está disponível como @ref{2717,,types.AsyncGeneratorType} na camada Python.


Adicionado na versão 3.6.

@end deffn

@geindex PyAsyncGen_New (C function)
@anchor{c-api/gen c PyAsyncGen_New}@anchor{5120}
@deffn {C Função} @ref{339,,PyObject} *PyAsyncGen_New (PyFrameObject *frame, PyObject *name, PyObject *qualname)

Cria um novo gerador assíncrono que encapsule `frame', com @code{__name__} e @code{__qualname__} definidos como `name' e `qualname'. `frame' é apropriado por esta função e não deve ser @code{NULL}.

Em caso de sucesso, esta função retorna uma @ref{33d,,referência forte} ao novo gerador assíncrono. Em caso de falha, esta função retorna @code{NULL} com uma exceção definida.


Adicionado na versão 3.6.

@end deffn

@geindex PyAsyncGen_CheckExact (C function)
@anchor{c-api/gen c PyAsyncGen_CheckExact}@anchor{5121}
@deffn {C Função} int PyAsyncGen_CheckExact (PyObject *op)

Retorna verdadeiro se `op' for um objeto gerador assíncrono, falso caso contrário. Esta função sempre tem sucesso.


Adicionado na versão 3.6.

@end deffn

@node Objetos corrotina<2>,Objetos de variáveis de contexto,Objetos Geradores,Outros Objetos
@anchor{c-api/coro doc}@anchor{5122}@anchor{c-api/coro coro-objects}@anchor{eff}@anchor{c-api/coro coroutine-objects}@anchor{5123}@anchor{c-api/coro translation-repo}@anchor{5124}
@subsubsection Objetos corrotina



Adicionado na versão 3.5.


Os objetos corrotina são aquelas funções declaradas com um retorno de palavra-chave @code{async}.

@geindex PyCoroObject (C type)
@anchor{c-api/coro c PyCoroObject}@anchor{5125}
@deffn {C Tipo} type PyCoroObject

A estrutura C utilizada para objetos corrotinas.
@end deffn

@geindex PyCoro_Type (C var)
@anchor{c-api/coro c PyCoro_Type}@anchor{5126}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCoro_Type

O tipo de objeto correspondente a objetos corrotina.
@end deffn

@geindex PyCoro_CheckExact (C function)
@anchor{c-api/coro c PyCoro_CheckExact}@anchor{5127}
@deffn {C Função} int PyCoro_CheckExact (PyObject *ob)

Retorna true se o tipo do `ob' é @ref{5126,,PyCoro_Type}; `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyCoro_New (C function)
@anchor{c-api/coro c PyCoro_New}@anchor{5128}
@deffn {C Função} @ref{339,,PyObject} *PyCoro_New (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto de corrotina com base no objeto `frame', com @code{__name__} e @code{__qualname__} definido como `name' e `qualname'. Uma referência a `frame' é roubada por esta função. O argumento `frame' não deve ser @code{NULL}.
@end deffn

@node Objetos de variáveis de contexto,Objetos de indicação de tipos,Objetos corrotina<2>,Outros Objetos
@anchor{c-api/contextvars doc}@anchor{5129}@anchor{c-api/contextvars context-variables-objects}@anchor{512a}@anchor{c-api/contextvars contextvarsobjects}@anchor{b0b}@anchor{c-api/contextvars translation-repo}@anchor{512b}
@subsubsection Objetos de variáveis de contexto

@anchor{c-api/contextvars contextvarsobjects-pointertype-change}@anchor{c40}

Adicionado na versão 3.7.



Alterado na versão 3.7.1: 

@cartouche
@quotation Nota 
No Python 3.7.1, as assinaturas de todas as APIs C de variáveis de contexto foram `alteradas' para usar ponteiros @ref{339,,PyObject} em vez de @ref{512c,,PyContext}, @ref{512d,,PyContextVar} e @ref{512e,,PyContextToken}. Por exemplo:

@example
// no 3.7.0:
PyContext *PyContext_New(void);

// no 3.7.1+:
PyObject *PyContext_New(void);
@end example

Veja bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762} para mais detalhes.
@end quotation
@end cartouche


Esta seção detalha a API C pública para o módulo @ref{24,,contextvars}.

@geindex PyContext (C type)
@anchor{c-api/contextvars c PyContext}@anchor{512c}
@deffn {C Tipo} type PyContext

A estrutura C usada para representar um objeto @ref{15b7,,contextvars.Context}.
@end deffn

@geindex PyContextVar (C type)
@anchor{c-api/contextvars c PyContextVar}@anchor{512d}
@deffn {C Tipo} type PyContextVar

A estrutura C usada para representar um objeto @ref{1643,,contextvars.ContextVar}.
@end deffn

@geindex PyContextToken (C type)
@anchor{c-api/contextvars c PyContextToken}@anchor{512e}
@deffn {C Tipo} type PyContextToken

A estrutura C usada para representar um objeto @ref{3455,,contextvars.Token}
@end deffn

@geindex PyContext_Type (C var)
@anchor{c-api/contextvars c PyContext_Type}@anchor{512f}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyContext_Type

O objeto de tipo que representa o tipo de `contexto'.
@end deffn

@geindex PyContextVar_Type (C var)
@anchor{c-api/contextvars c PyContextVar_Type}@anchor{5130}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyContextVar_Type

O objeto de tipo que representa o tipo de `variável de contexto'.
@end deffn

@geindex PyContextToken_Type (C var)
@anchor{c-api/contextvars c PyContextToken_Type}@anchor{5131}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyContextToken_Type

O objeto de tipo que representa o tipo de `token de variável de contexto'.
@end deffn

Macros de verificação de tipo:

@geindex PyContext_CheckExact (C function)
@anchor{c-api/contextvars c PyContext_CheckExact}@anchor{5132}
@deffn {C Função} int PyContext_CheckExact (PyObject *o)

Retorna verdadeiro se `o' for do tipo @ref{512f,,PyContext_Type}. `o' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyContextVar_CheckExact (C function)
@anchor{c-api/contextvars c PyContextVar_CheckExact}@anchor{5133}
@deffn {C Função} int PyContextVar_CheckExact (PyObject *o)

Retorna verdadeiro se `o' for do tipo @ref{5130,,PyContextVar_Type}. `o' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyContextToken_CheckExact (C function)
@anchor{c-api/contextvars c PyContextToken_CheckExact}@anchor{5134}
@deffn {C Função} int PyContextToken_CheckExact (PyObject *o)

Retorna verdadeiro se `o' for do tipo @ref{5131,,PyContextToken_Type}. `o' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

Funções de gerenciamento de objetos de contexto:

@geindex PyContext_New (C function)
@anchor{c-api/contextvars c PyContext_New}@anchor{5135}
@deffn {C Função} @ref{339,,PyObject} *PyContext_New (void)
`Retorna valor: Nova referência.'
Cria um novo objeto de contexto vazio. Retorna @code{NULL} se um erro ocorreu.
@end deffn

@geindex PyContext_Copy (C function)
@anchor{c-api/contextvars c PyContext_Copy}@anchor{5136}
@deffn {C Função} @ref{339,,PyObject} *PyContext_Copy (PyObject *ctx)
`Retorna valor: Nova referência.'
Cria uma cópia rasa do objeto de contexto `ctx' passado. Retorna @code{NULL} se um erro ocorreu.
@end deffn

@geindex PyContext_CopyCurrent (C function)
@anchor{c-api/contextvars c PyContext_CopyCurrent}@anchor{5137}
@deffn {C Função} @ref{339,,PyObject} *PyContext_CopyCurrent (void)
`Retorna valor: Nova referência.'
Cria uma cópia rasa do contexto da thread atual. Retorna @code{NULL} se um erro ocorreu.
@end deffn

@geindex PyContext_Enter (C function)
@anchor{c-api/contextvars c PyContext_Enter}@anchor{5138}
@deffn {C Função} int PyContext_Enter (PyObject *ctx)

Defina `ctx' como o contexto atual para o thread atual. Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro.
@end deffn

@geindex PyContext_Exit (C function)
@anchor{c-api/contextvars c PyContext_Exit}@anchor{5139}
@deffn {C Função} int PyContext_Exit (PyObject *ctx)

Desativa  o contexto `ctx' e restaura o contexto anterior como o contexto atual para a thread atual. Retorna @code{0} em caso de sucesso e @code{-1} em caso de erro.
@end deffn

Funções de variável de contexto:

@geindex PyContextVar_New (C function)
@anchor{c-api/contextvars c PyContextVar_New}@anchor{513a}
@deffn {C Função} @ref{339,,PyObject} *PyContextVar_New (const char *name, PyObject *def)
`Retorna valor: Nova referência.'
Cria um novo objeto @code{ContextVar}. O parâmetro `name' é usado para fins de introspecção e depuração. O parâmetro `def' especifica um valor padrão para a variável de contexto, ou  @code{NULL} para nenhum padrão. Se ocorrer um erro, esta função retorna @code{NULL}.
@end deffn

@geindex PyContextVar_Get (C function)
@anchor{c-api/contextvars c PyContextVar_Get}@anchor{513b}
@deffn {C Função} int PyContextVar_Get (PyObject *var, PyObject *default_value, PyObject **value)

Obtém o valor de uma variável de contexto. Retorna @code{-1} se um erro ocorreu durante a pesquisa, e @code{0} se nenhum erro ocorreu, se um valor foi encontrado ou não.

Se a variável de contexto foi encontrada, `value' será um ponteiro para ela. Se a variável de contexto `não' foi encontrada, `value' apontará para:


@itemize -

@item 
`default_value', se não for @code{NULL};

@item 
o valor padrão de `var', se não for @code{NULL};

@item 
@code{NULL}
@end itemize

Exceto para @code{NULL}, a função retorna uma nova referência.
@end deffn

@geindex PyContextVar_Set (C function)
@anchor{c-api/contextvars c PyContextVar_Set}@anchor{513c}
@deffn {C Função} @ref{339,,PyObject} *PyContextVar_Set (PyObject *var, PyObject *value)
`Retorna valor: Nova referência.'
Define o valor de `var' como `value' no contexto atual. Retorna um novo objeto token para esta alteração, ou @code{NULL} se um erro ocorreu.
@end deffn

@geindex PyContextVar_Reset (C function)
@anchor{c-api/contextvars c PyContextVar_Reset}@anchor{513d}
@deffn {C Função} int PyContextVar_Reset (PyObject *var, PyObject *token)

Redefine o estado da variável de contexto `var' para o estado que anterior a @ref{513c,,PyContextVar_Set()} que retornou o `token' foi chamado. Esta função retorna @code{0} em caso de sucesso e @code{-1} em caso de erro.
@end deffn

@node Objetos de indicação de tipos,,Objetos de variáveis de contexto,Outros Objetos
@anchor{c-api/typehints doc}@anchor{513e}@anchor{c-api/typehints objects-for-type-hinting}@anchor{513f}@anchor{c-api/typehints translation-repo}@anchor{5140}@anchor{c-api/typehints typehintobjects}@anchor{5141}
@subsubsection Objetos de indicação de tipos


São fornecidos vários tipos embutidos para sugestão de tipo.  Atualmente, dois tipos existem – @ref{6b2,,GenericAlias} e @ref{7c3,,Union}.  Apenas @code{GenericAlias} está exposto ao C.

@geindex Py_GenericAlias (C function)
@anchor{c-api/typehints c Py_GenericAlias}@anchor{4dc2}
@deffn {C Função} @ref{339,,PyObject} *Py_GenericAlias (PyObject *origin, PyObject *args)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Cria um objeto @ref{6b2,,GenericAlias}. Equivalente a chamar a classe Python @ref{7ed,,types.GenericAlias}. Os argumentos `origin' e `args' definem os atributos @code{__origin__} e @code{__args__} de @code{GenericAlias} respectivamente. `origin' deve ser um @ref{ab4,,PyTypeObject}*, e `args' pode ser um @ref{4eac,,PyTupleObject}* ou qualquer @code{PyObject*}. Se `args' passado não for uma tupla, uma tupla de 1 elemento é construída automaticamente e @code{__args__} é definido como @code{(args,)}. A verificação mínima é feita para os argumentos, então a função terá sucesso mesmo se `origin' não for um tipo. O atributo @code{__parameters__} de @code{GenericAlias} é construído lentamente a partir de @code{__args__}. Em caso de falha, uma exceção é levantada e @code{NULL} é retornado.

Aqui está um exemplo de como tornar um tipo de extensão genérico:

@example
...
static PyMethodDef my_obj_methods[] = @{
    // Outros métodos.
    ...
    @{"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS, "Veja PEP 585"@}
    ...
@}
@end example


@subsubheading Ver também


O método de modelo de dados @ref{73b,,__class_getitem__()}.



Adicionado na versão 3.9.

@end deffn

@geindex Py_GenericAliasType (C var)
@anchor{c-api/typehints c Py_GenericAliasType}@anchor{4dc3}
@deffn {C Variável} @ref{ab4,,PyTypeObject} Py_GenericAliasType
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
O tipo C do objeto retornado por @ref{4dc2,,Py_GenericAlias()}. Equivalente a @ref{7ed,,types.GenericAlias} no Python.


Adicionado na versão 3.9.

@end deffn

@node API C para módulos de extensão,,Outros Objetos,Camada de Objetos Concretos
@anchor{c-api/concrete c-api-for-extension-modules}@anchor{5142}
@subsection API C para módulos de extensão


@menu
* API C de curses:: 
* Dados internos:: 
* Objetos DateTime: Objetos DateTime<2>. 
* Dados internos: Dados internos<2>. 

@end menu

@node API C de curses,Dados internos,,API C para módulos de extensão
@anchor{c-api/curses doc}@anchor{5143}@anchor{c-api/curses curses-c-api}@anchor{5144}
@subsubsection API C de curses


@ref{2b,,curses} expõe uma pequena interface C para módulos de extensão. Os usuários devem incluir o arquivo de cabeçalho @code{py_curses.h} (que não é incluído por padrão em @code{Python.h}) e @ref{5145,,import_curses()} deve ser invocada, geralmente como parte da função de inicialização do módulo, para popular @ref{5146,,PyCurses_API}.

@cartouche
@quotation Aviso 
Nem a API C nem o módulo @ref{2b,,curses} do Python puro são compatíveis com subinterpretadores.
@end quotation
@end cartouche

@geindex import_curses (C macro)
@anchor{c-api/curses c import_curses}@anchor{5145}
@deffn {C Macro} import_curses ()

Importa a API C do curses. A macro não precisa de ponto e vírgula para ser chamada.

Em caso de sucesso, popula o ponteiro @ref{5146,,PyCurses_API}.

Em caso de falha, define @ref{5146,,PyCurses_API} como NULL e levanta uma exceção. O chamador deve verificar se ocorreu um erro através de @ref{1a3b,,PyErr_Occurred()}:

@example
import_curses();  // O ponto e vírgula é opcional, mas recomendado.
if (PyErr_Occurred()) @{ /* cleanup */ @}
@end example
@end deffn

@geindex PyCurses_API (C var)
@anchor{c-api/curses c PyCurses_API}@anchor{5146}
@deffn {C Variável} void **PyCurses_API

Objeto alocado dinamicamente contendo a API C do curses. Esta variável só estará disponível após a execução bem-sucedida da macro @ref{5145,,import_curses}.

@code{PyCurses_API[0]} corresponde a @ref{5147,,PyCursesWindow_Type}.

@code{PyCurses_API[1]}, @code{PyCurses_API[2]} e @code{PyCurses_API[3]} são ponteiros para funções predicativas do tipo @code{int (*)(void)}.

Quando chamados, esses predicados retornam se @ref{3185,,curses.setupterm()}, @ref{1689,,curses.initscr()} e @ref{3186,,curses.start_color()} foram chamados, respectivamente.

Veja também as macros de conveniência @ref{5148,,PyCursesSetupTermCalled}, @ref{5149,,PyCursesInitialised} e @ref{514a,,PyCursesInitialisedColor}.

@cartouche
@quotation Nota 
O número de entradas nesta estrutura está sujeito a alterações. Considere usar @ref{514b,,PyCurses_API_pointers} para verificar se novos campos estão disponíveis.
@end quotation
@end cartouche
@end deffn

@geindex PyCurses_API_pointers (C macro)
@anchor{c-api/curses c PyCurses_API_pointers}@anchor{514b}
@deffn {C Macro} PyCurses_API_pointers

O número de campos acessíveis (@code{4}) em @ref{5146,,PyCurses_API}. Esse número é incrementado sempre que novos campos são adicionados.
@end deffn

@geindex PyCursesWindow_Type (C var)
@anchor{c-api/curses c PyCursesWindow_Type}@anchor{5147}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCursesWindow_Type

O @ref{96c,,tipo de heap} correspondente a @ref{10d4,,curses.window}.
@end deffn

@geindex PyCursesWindow_Check (C function)
@anchor{c-api/curses c PyCursesWindow_Check}@anchor{514c}
@deffn {C Função} int PyCursesWindow_Check (PyObject *op)

Retorna verdadeiro se `op' for uma instância de @ref{10d4,,curses.window}, falso caso contrário.
@end deffn

As macros a seguir são macros de conveniência que se expandem em instruções C. Em particular, elas só podem ser usadas como @code{macro;} ou @code{macro}, mas não como @code{macro()} ou @code{macro();}.

@geindex PyCursesSetupTermCalled (C macro)
@anchor{c-api/curses c PyCursesSetupTermCalled}@anchor{5148}
@deffn {C Macro} PyCursesSetupTermCalled

Macro que verifica se @ref{3185,,curses.setupterm()} foi chamada.

A expansão de macro é aproximadamente equivalente a:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_setupterm_called = (predicate_t)PyCurses_API[1];
    if (!was_setupterm_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@geindex PyCursesInitialised (C macro)
@anchor{c-api/curses c PyCursesInitialised}@anchor{5149}
@deffn {C Macro} PyCursesInitialised

Macro que verifica se @ref{1689,,curses.initscr()} foi chamada.

A expansão de macro é aproximadamente equivalente a:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_initscr_called = (predicate_t)PyCurses_API[2];
    if (!was_initscr_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@geindex PyCursesInitialisedColor (C macro)
@anchor{c-api/curses c PyCursesInitialisedColor}@anchor{514a}
@deffn {C Macro} PyCursesInitialisedColor

Macro que verifica se @ref{3186,,curses.start_color()} foi chamada.

A expansão de macro é aproximadamente equivalente a:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_start_color_called = (predicate_t)PyCurses_API[3];
    if (!was_start_color_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@node Dados internos,Objetos DateTime<2>,API C de curses,API C para módulos de extensão
@anchor{c-api/curses internal-data}@anchor{514d}
@subsubsection Dados internos


Os seguintes objetos são expostos pela API C, mas devem ser considerados apenas para uso interno.

@geindex PyCurses_CAPSULE_NAME (C macro)
@anchor{c-api/curses c PyCurses_CAPSULE_NAME}@anchor{514e}
@deffn {C Macro} PyCurses_CAPSULE_NAME

Nome da cápsula do curses a ser passada para @ref{1999,,PyCapsule_Import()}.

Uso interno apenas. Use @ref{5145,,import_curses} em vez disso.
@end deffn

@node Objetos DateTime<2>,Dados internos<2>,Dados internos,API C para módulos de extensão
@anchor{c-api/datetime doc}@anchor{514f}@anchor{c-api/datetime datetime-objects}@anchor{5150}@anchor{c-api/datetime datetimeobjects}@anchor{4ef6}@anchor{c-api/datetime translation-repo}@anchor{5151}
@subsubsection Objetos DateTime


Vários objetos de data e hora são fornecidos pelo módulo @ref{30,,datetime}. Antes de usar qualquer uma dessas funções, o arquivo de cabeçalho @code{datetime.h} deve ser incluído na sua fonte (observe que isso não é incluído por @code{Python.h}) e a macro @ref{5152,,PyDateTime_IMPORT} deve ser chamada, geralmente como parte da função de inicialização do módulo. A macro coloca um ponteiro para uma estrutura C em uma variável estática, @ref{5153,,PyDateTimeAPI}, usada pelas macros a seguir.

@geindex PyDateTime_IMPORT (C macro)
@anchor{c-api/datetime c PyDateTime_IMPORT}@anchor{5152}
@deffn {C Macro} PyDateTime_IMPORT ()

Importa a API C de datetime.

Em caso de sucesso, preenche o ponteiro @ref{5153,,PyDateTimeAPI}. Em caso de falha, define @ref{5153,,PyDateTimeAPI} como @code{NULL} e lança uma exceção. O chamador deve verificar se ocorreu um erro através de @ref{1a3b,,PyErr_Occurred()}:

@example
PyDateTime_IMPORT;
if (PyErr_Occurred()) @{ /* limpeza */ @}
@end example

@cartouche
@quotation Aviso 
Isso não é compatível com subinterpretadores.
@end quotation
@end cartouche
@end deffn

@geindex PyDateTime_CAPI (C type)
@anchor{c-api/datetime c PyDateTime_CAPI}@anchor{5154}
@deffn {C Tipo} type PyDateTime_CAPI

Estrutura contendo os campos para a API C de datetime.

Os campos desta estrutura são privados e sujeitos a alterações.

Não use isto diretamente; prefira as APIs @code{PyDateTime_*}.
@end deffn

@geindex PyDateTimeAPI (C var)
@anchor{c-api/datetime c PyDateTimeAPI}@anchor{5153}
@deffn {C Variável} @ref{5154,,PyDateTime_CAPI} *PyDateTimeAPI

Objeto alocado dinamicamente contendo a API C de datetime.

Esta variável só estará disponível após a execução bem-sucedida de @ref{5152,,PyDateTime_IMPORT}.
@end deffn

@geindex PyDateTime_Date (C type)
@anchor{c-api/datetime c PyDateTime_Date}@anchor{5155}
@deffn {C Tipo} type PyDateTime_Date

Esta é uma instância de @ref{339,,PyObject} representando o objeto data do Python.
@end deffn

@geindex PyDateTime_DateTime (C type)
@anchor{c-api/datetime c PyDateTime_DateTime}@anchor{5156}
@deffn {C Tipo} type PyDateTime_DateTime

Esta é uma instância de @ref{339,,PyObject} representando o objeto datetime do Python.
@end deffn

@geindex PyDateTime_Time (C type)
@anchor{c-api/datetime c PyDateTime_Time}@anchor{5157}
@deffn {C Tipo} type PyDateTime_Time

Esta é uma instância de @ref{339,,PyObject} representando o objeto hora do Python.
@end deffn

@geindex PyDateTime_Delta (C type)
@anchor{c-api/datetime c PyDateTime_Delta}@anchor{5158}
@deffn {C Tipo} type PyDateTime_Delta

Esta é uma instância de @ref{339,,PyObject} representando a diferença entre dois valores de datetime.
@end deffn

@geindex PyDateTime_DateType (C var)
@anchor{c-api/datetime c PyDateTime_DateType}@anchor{5159}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDateTime_DateType

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo data do Python; é o mesmo objeto que @ref{1cd,,datetime.date} na camada de Python.
@end deffn

@geindex PyDateTime_DateTimeType (C var)
@anchor{c-api/datetime c PyDateTime_DateTimeType}@anchor{515a}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDateTime_DateTimeType

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo datetime do Python; é o mesmo objeto que @ref{1cc,,datetime.datetime} na camada de Python.
@end deffn

@geindex PyDateTime_TimeType (C var)
@anchor{c-api/datetime c PyDateTime_TimeType}@anchor{515b}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDateTime_TimeType

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo hora do Python; é o mesmo objeto que @ref{1ce,,datetime.time} na camada de Python.
@end deffn

@geindex PyDateTime_DeltaType (C var)
@anchor{c-api/datetime c PyDateTime_DeltaType}@anchor{515c}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDateTime_DeltaType

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo Python para a diferença entre dois valores de datetime; é o mesmo objeto que @ref{9d7,,datetime.timedelta} na camada de Python.
@end deffn

@geindex PyDateTime_TZInfoType (C var)
@anchor{c-api/datetime c PyDateTime_TZInfoType}@anchor{515d}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyDateTime_TZInfoType

Esta instância de @ref{ab4,,PyTypeObject} representa o tipo fuso horário do Python; é o mesmo objeto que @ref{5de,,datetime.tzinfo} na camada de Python.
@end deffn

Macro para acesso ao singleton UTC:

@geindex PyDateTime_TimeZone_UTC (C var)
@anchor{c-api/datetime c PyDateTime_TimeZone_UTC}@anchor{bdc}
@deffn {C Variável} @ref{339,,PyObject} *PyDateTime_TimeZone_UTC

Retorna um singleton do fuso horário representando o UTC, o mesmo objeto que @ref{614,,datetime.timezone.utc}.


Adicionado na versão 3.7.

@end deffn

Macros de verificação de tipo:

@geindex PyDate_Check (C function)
@anchor{c-api/datetime c PyDate_Check}@anchor{515e}
@deffn {C Função} int PyDate_Check (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{5159,,PyDateTime_DateType} ou um subtipo de @code{PyDateTime_DateType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyDate_CheckExact (C function)
@anchor{c-api/datetime c PyDate_CheckExact}@anchor{515f}
@deffn {C Função} int PyDate_CheckExact (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{5159,,PyDateTime_DateType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyDateTime_Check (C function)
@anchor{c-api/datetime c PyDateTime_Check}@anchor{5160}
@deffn {C Função} int PyDateTime_Check (PyObject *ob)

Retorna verdadeiro se `ob' é do tipo @ref{515a,,PyDateTime_DateTimeType} ou um subtipo de @code{PyDateTime_DateTimeType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyDateTime_CheckExact (C function)
@anchor{c-api/datetime c PyDateTime_CheckExact}@anchor{5161}
@deffn {C Função} int PyDateTime_CheckExact (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515a,,PyDateTime_DateTimeType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyTime_Check (C function)
@anchor{c-api/datetime c PyTime_Check}@anchor{5162}
@deffn {C Função} int PyTime_Check (PyObject *ob)

Retorna verdadeiro se `ob' é do tipo @ref{515b,,PyDateTime_TimeType} ou um subtipo de @code{PyDateTime_TimeType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyTime_CheckExact (C function)
@anchor{c-api/datetime c PyTime_CheckExact}@anchor{5163}
@deffn {C Função} int PyTime_CheckExact (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515b,,PyDateTime_TimeType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyDelta_Check (C function)
@anchor{c-api/datetime c PyDelta_Check}@anchor{5164}
@deffn {C Função} int PyDelta_Check (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515c,,PyDateTime_DeltaType} ou um subtipo de @code{PyDateTime_DeltaType}. `ob' não pode ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyDelta_CheckExact (C function)
@anchor{c-api/datetime c PyDelta_CheckExact}@anchor{5165}
@deffn {C Função} int PyDelta_CheckExact (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515c,,PyDateTime_DeltaType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyTZInfo_Check (C function)
@anchor{c-api/datetime c PyTZInfo_Check}@anchor{5166}
@deffn {C Função} int PyTZInfo_Check (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515d,,PyDateTime_TZInfoType} ou um subtipo de @code{PyDateTime_TZInfoType}. `ob' não pode ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

@geindex PyTZInfo_CheckExact (C function)
@anchor{c-api/datetime c PyTZInfo_CheckExact}@anchor{5167}
@deffn {C Função} int PyTZInfo_CheckExact (PyObject *ob)

Retorna verdadeiro se `ob' for do tipo @ref{515d,,PyDateTime_TZInfoType}. `ob' não deve ser @code{NULL}. Esta função sempre tem sucesso.
@end deffn

Macros para criar objetos:

@geindex PyDate_FromDate (C function)
@anchor{c-api/datetime c PyDate_FromDate}@anchor{5168}
@deffn {C Função} @ref{339,,PyObject} *PyDate_FromDate (int year, int month, int day)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{1cd,,datetime.date} com o ano, mês e dia especificados.
@end deffn

@geindex PyDateTime_FromDateAndTime (C function)
@anchor{c-api/datetime c PyDateTime_FromDateAndTime}@anchor{5169}
@deffn {C Função} @ref{339,,PyObject} *PyDateTime_FromDateAndTime (int year, int month, int day, int hour, int minute, int second, int usecond)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{1cc,,datetime.datetime} com o ano, mês, dia, hora, minuto, segundo, microssegundo especificados.
@end deffn

@geindex PyDateTime_FromDateAndTimeAndFold (C function)
@anchor{c-api/datetime c PyDateTime_FromDateAndTimeAndFold}@anchor{516a}
@deffn {C Função} @ref{339,,PyObject} *PyDateTime_FromDateAndTimeAndFold (int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{1cc,,datetime.datetime} com o ano, mês, dia, hora, minuto, segundo, microssegundo e a dobra especificados.


Adicionado na versão 3.6.

@end deffn

@geindex PyTime_FromTime (C function)
@anchor{c-api/datetime c PyTime_FromTime}@anchor{516b}
@deffn {C Função} @ref{339,,PyObject} *PyTime_FromTime (int hour, int minute, int second, int usecond)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{1ce,,datetime.time} com a hora, minuto, segundo e microssegundo especificados.
@end deffn

@geindex PyTime_FromTimeAndFold (C function)
@anchor{c-api/datetime c PyTime_FromTimeAndFold}@anchor{516c}
@deffn {C Função} @ref{339,,PyObject} *PyTime_FromTimeAndFold (int hour, int minute, int second, int usecond, int fold)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{1ce,,datetime.time} com a hora, minuto, segundo, microssegundo e a dobra especificados.


Adicionado na versão 3.6.

@end deffn

@geindex PyDelta_FromDSU (C function)
@anchor{c-api/datetime c PyDelta_FromDSU}@anchor{516d}
@deffn {C Função} @ref{339,,PyObject} *PyDelta_FromDSU (int days, int seconds, int useconds)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{9d7,,datetime.timedelta} representando o número especificado de dias, segundos e microssegundos. A normalização é realizada para que o número resultante de microssegundos e segundos esteja nos intervalos documentados para objetos de @ref{9d7,,datetime.timedelta}.
@end deffn

@geindex PyTimeZone_FromOffset (C function)
@anchor{c-api/datetime c PyTimeZone_FromOffset}@anchor{bda}
@deffn {C Função} @ref{339,,PyObject} *PyTimeZone_FromOffset (PyObject *offset)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{10fe,,datetime.timezone} com um deslocamento fixo sem nome representado pelo argumento `offset'.


Adicionado na versão 3.7.

@end deffn

@geindex PyTimeZone_FromOffsetAndName (C function)
@anchor{c-api/datetime c PyTimeZone_FromOffsetAndName}
@deffn {C Função} @ref{339,,PyObject} *PyTimeZone_FromOffsetAndName (PyObject *offset, PyObject *name)
`Retorna valor: Nova referência.'
Retorna um objeto @ref{10fe,,datetime.timezone} com um deslocamento fixo representado pelo argumento `offset' e com tzname `name'.


Adicionado na versão 3.7.

@end deffn

Macros para extrair campos de objetos `date'. O argumento deve ser uma instância de @ref{5155,,PyDateTime_Date}, inclusive subclasses (como @ref{5156,,PyDateTime_DateTime}). O argumento não deve ser @code{NULL}, e o tipo não é verificado:

@geindex PyDateTime_GET_YEAR (C function)
@anchor{c-api/datetime c PyDateTime_GET_YEAR}@anchor{516e}
@deffn {C Função} int PyDateTime_GET_YEAR (PyDateTime_Date *o)

Retorna o ano, como um inteiro positivo.
@end deffn

@geindex PyDateTime_GET_MONTH (C function)
@anchor{c-api/datetime c PyDateTime_GET_MONTH}@anchor{516f}
@deffn {C Função} int PyDateTime_GET_MONTH (PyDateTime_Date *o)

Retorna o mês, como um inteiro de 1 a 12.
@end deffn

@geindex PyDateTime_GET_DAY (C function)
@anchor{c-api/datetime c PyDateTime_GET_DAY}@anchor{5170}
@deffn {C Função} int PyDateTime_GET_DAY (PyDateTime_Date *o)

Retorna o dia, como um inteiro de 1 a 31.
@end deffn

Macros para extrair campos de objetos `datetime'.  O argumento deve ser uma instância de @ref{5156,,PyDateTime_DateTime}, inclusive subclasses. O argumento não deve ser @code{NULL}, e o tipo não é verificado:

@geindex PyDateTime_DATE_GET_HOUR (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_HOUR}@anchor{5171}
@deffn {C Função} int PyDateTime_DATE_GET_HOUR (PyDateTime_DateTime *o)

Retorna a hora, como um inteiro de 0 a 23.
@end deffn

@geindex PyDateTime_DATE_GET_MINUTE (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_MINUTE}@anchor{5172}
@deffn {C Função} int PyDateTime_DATE_GET_MINUTE (PyDateTime_DateTime *o)

Retorna o minuto, como um inteiro de 0 a 59.
@end deffn

@geindex PyDateTime_DATE_GET_SECOND (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_SECOND}@anchor{5173}
@deffn {C Função} int PyDateTime_DATE_GET_SECOND (PyDateTime_DateTime *o)

Retorna o segundo, como um inteiro de 0 a 59.
@end deffn

@geindex PyDateTime_DATE_GET_MICROSECOND (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_MICROSECOND}@anchor{5174}
@deffn {C Função} int PyDateTime_DATE_GET_MICROSECOND (PyDateTime_DateTime *o)

Retorna o microssegundo, como um inteiro de 0 a 999999.
@end deffn

@geindex PyDateTime_DATE_GET_FOLD (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_FOLD}@anchor{5175}
@deffn {C Função} int PyDateTime_DATE_GET_FOLD (PyDateTime_DateTime *o)

Retorna a dobra, como um inteiro de 0 a 1.


Adicionado na versão 3.6.

@end deffn

@geindex PyDateTime_DATE_GET_TZINFO (C function)
@anchor{c-api/datetime c PyDateTime_DATE_GET_TZINFO}@anchor{899}
@deffn {C Função} @ref{339,,PyObject} *PyDateTime_DATE_GET_TZINFO (PyDateTime_DateTime *o)

Retorna o tzinfo (que pode ser @code{None}).


Adicionado na versão 3.10.

@end deffn

Macros para extrair campos de objetos `time'. O argumento deve ser uma instância de @ref{5157,,PyDateTime_Time}, inclusive subclasses. O argumento não deve ser @code{NULL}, e o tipo não é verificado:

@geindex PyDateTime_TIME_GET_HOUR (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_HOUR}@anchor{5176}
@deffn {C Função} int PyDateTime_TIME_GET_HOUR (PyDateTime_Time *o)

Retorna a hora, como um inteiro de 0 a 23.
@end deffn

@geindex PyDateTime_TIME_GET_MINUTE (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_MINUTE}@anchor{5177}
@deffn {C Função} int PyDateTime_TIME_GET_MINUTE (PyDateTime_Time *o)

Retorna o minuto, como um inteiro de 0 a 59.
@end deffn

@geindex PyDateTime_TIME_GET_SECOND (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_SECOND}@anchor{5178}
@deffn {C Função} int PyDateTime_TIME_GET_SECOND (PyDateTime_Time *o)

Retorna o segundo, como um inteiro de 0 a 59.
@end deffn

@geindex PyDateTime_TIME_GET_MICROSECOND (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_MICROSECOND}@anchor{5179}
@deffn {C Função} int PyDateTime_TIME_GET_MICROSECOND (PyDateTime_Time *o)

Retorna o microssegundo, como um inteiro de 0 a 999999.
@end deffn

@geindex PyDateTime_TIME_GET_FOLD (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_FOLD}@anchor{517a}
@deffn {C Função} int PyDateTime_TIME_GET_FOLD (PyDateTime_Time *o)

Retorna a dobra, como um inteiro de 0 a 1.


Adicionado na versão 3.6.

@end deffn

@geindex PyDateTime_TIME_GET_TZINFO (C function)
@anchor{c-api/datetime c PyDateTime_TIME_GET_TZINFO}@anchor{89a}
@deffn {C Função} @ref{339,,PyObject} *PyDateTime_TIME_GET_TZINFO (PyDateTime_Time *o)

Retorna o tzinfo (que pode ser @code{None}).


Adicionado na versão 3.10.

@end deffn

Macros para extrair campos de objetos `time delta'. O argumento deve ser uma instância de @ref{5158,,PyDateTime_Delta}, inclusive subclasses. O argumento não deve ser @code{NULL}, e o tipo não é verificado:

@geindex PyDateTime_DELTA_GET_DAYS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_DAYS}@anchor{517b}
@deffn {C Função} int PyDateTime_DELTA_GET_DAYS (PyDateTime_Delta *o)

Retorna o número de dias, como um inteiro de -999999999 a 999999999.


Adicionado na versão 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_SECONDS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_SECONDS}@anchor{517c}
@deffn {C Função} int PyDateTime_DELTA_GET_SECONDS (PyDateTime_Delta *o)

Retorna o número de segundos, como um inteiro de 0 a 86399.


Adicionado na versão 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_MICROSECONDS (C function)
@anchor{c-api/datetime c PyDateTime_DELTA_GET_MICROSECONDS}@anchor{517d}
@deffn {C Função} int PyDateTime_DELTA_GET_MICROSECONDS (PyDateTime_Delta *o)

Retorna o número de microssegundos, como um inteiro de 0 a 999999.


Adicionado na versão 3.3.

@end deffn

Macros para a conveniência de módulos implementando a API de DB:

@geindex PyDateTime_FromTimestamp (C function)
@anchor{c-api/datetime c PyDateTime_FromTimestamp}@anchor{517e}
@deffn {C Função} @ref{339,,PyObject} *PyDateTime_FromTimestamp (PyObject *args)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto @ref{1cc,,datetime.datetime} dado uma tupla de argumentos que possa ser passada ao método @ref{4ed,,datetime.datetime.fromtimestamp()}.
@end deffn

@geindex PyDate_FromTimestamp (C function)
@anchor{c-api/datetime c PyDate_FromTimestamp}@anchor{1b86}
@deffn {C Função} @ref{339,,PyObject} *PyDate_FromTimestamp (PyObject *args)
`Retorna valor: Nova referência.'
Cria e retorna um novo objeto @ref{1cd,,datetime.date} dado uma tupla de argumentos que possa ser passada ao método @ref{bed,,datetime.date.fromtimestamp()}.
@end deffn

@node Dados internos<2>,,Objetos DateTime<2>,API C para módulos de extensão
@anchor{c-api/datetime internal-data}@anchor{517f}
@subsubsection Dados internos


Os seguintes símbolos são expostos pela API C, mas devem ser considerados apenas para uso interno.

@geindex PyDateTime_CAPSULE_NAME (C macro)
@anchor{c-api/datetime c PyDateTime_CAPSULE_NAME}@anchor{5180}
@deffn {C Macro} PyDateTime_CAPSULE_NAME

Nome da cápsula de datetime a ser passada para @ref{1999,,PyCapsule_Import()}.

Uso interno apenas. Use @ref{5152,,PyDateTime_IMPORT} em vez disso.
@end deffn

@node Inicialização finalização e threads,Configuração de inicialização do Python,Camada de Objetos Concretos,Manual de referência da API Python/C
@anchor{c-api/init doc}@anchor{5181}@anchor{c-api/init initialization}@anchor{5182}@anchor{c-api/init initialization-finalization-and-threads}@anchor{5183}@anchor{c-api/init translation-repo}@anchor{5184}
@section Inicialização, finalização e threads


Veja @ref{3a7,,Configuração de inicialização do Python} para detalhes sobre como configurar o interpretador antes da inicialização.

@menu
* Antes da inicialização do Python:: 
* Variáveis de configuração global:: 
* Inicializando e encerrando o interpretador:: 
* Parâmetros de todo o processo:: 
* Estado de thread e a trava global do interpretador:: 
* Sub-interpreter support:: 
* Notificações assíncronas:: 
* Profiling and Tracing:: 
* Reference tracing:: 
* Advanced Debugger Support:: 
* Thread Local Storage Support:: 
* Synchronization Primitives: Synchronization Primitives<2>. 
* Operating System Thread APIs:: 

@end menu

@node Antes da inicialização do Python,Variáveis de configuração global,,Inicialização finalização e threads
@anchor{c-api/init before-python-initialization}@anchor{5185}@anchor{c-api/init pre-init-safe}@anchor{bde}
@subsection Antes da inicialização do Python


Em uma aplicação que incorpora Python, a função @ref{8b1,,Py_Initialize()} deve ser chamada antes de usar qualquer outra função da API Python/C; com exceção de algumas funções e as @ref{5186,,variáveis globais de configuração}.

As seguintes funções podem ser seguramente chamadas antes da inicialização do Python.


@itemize *

@item 
Funções que inicializam o interpretador:


@itemize *

@item 
@ref{8b1,,Py_Initialize()}

@item 
@ref{4dca,,Py_InitializeEx()}

@item 
@ref{3c5,,Py_InitializeFromConfig()}

@item 
@ref{9c9,,Py_BytesMain()}

@item 
@ref{c3f,,Py_Main()}

@item 
as funções de pré-inicialização de tempo de execução cobertas em @ref{3a7,,Configuração de inicialização do Python}
@end itemize

@item 
Funções de configuração:


@itemize *

@item 
@ref{18a4,,PyImport_AppendInittab()}

@item 
@ref{18a5,,PyImport_ExtendInittab()}

@item 
@code{PyInitFrozenExtensions()}

@item 
@ref{58b,,PyMem_SetAllocator()}

@item 
@ref{c85,,PyMem_SetupDebugHooks()}

@item 
@ref{5187,,PyObject_SetArenaAllocator()}

@item 
@ref{172c,,Py_SetProgramName()}

@item 
@ref{172b,,Py_SetPythonHome()}

@item 
@ref{3af,,PySys_ResetWarnOptions()}

@item 
as funções de configuração cobertas em @ref{3a7,,Configuração de inicialização do Python}
@end itemize

@item 
Funções informativas:


@itemize *

@item 
@ref{4bea,,Py_IsInitialized()}

@item 
@ref{5188,,PyMem_GetAllocator()}

@item 
@ref{5189,,PyObject_GetArenaAllocator()}

@item 
@ref{1479,,Py_GetBuildInfo()}

@item 
@ref{4dc4,,Py_GetCompiler()}

@item 
@ref{4dc5,,Py_GetCopyright()}

@item 
@ref{4dc6,,Py_GetPlatform()}

@item 
@ref{4dc8,,Py_GetVersion()}

@item 
@ref{4bea,,Py_IsInitialized()}
@end itemize

@item 
Utilitários:


@itemize *

@item 
@ref{be0,,Py_DecodeLocale()}

@item 
o relatório de status e funções utilitárias cobertas em @ref{3a7,,Configuração de inicialização do Python}
@end itemize

@item 
Alocadores de memória:


@itemize *

@item 
@ref{390,,PyMem_RawMalloc()}

@item 
@ref{392,,PyMem_RawRealloc()}

@item 
@ref{391,,PyMem_RawCalloc()}

@item 
@ref{393,,PyMem_RawFree()}
@end itemize

@item 
Sincronização:


@itemize *

@item 
@ref{32b,,PyMutex_Lock()}

@item 
@ref{32c,,PyMutex_Unlock()}
@end itemize
@end itemize

@cartouche
@quotation Nota 
Apesar de sua aparente semelhança com algumas das funções listadas acima, as seguintes funções `não devem ser chamadas' antes que o interpretador tenha sido inicializado: @ref{be1,,Py_EncodeLocale()}, @ref{3b3,,Py_GetPath()}, @ref{3b5,,Py_GetPrefix()}, @ref{3b1,,Py_GetExecPrefix()}, @ref{3b7,,Py_GetProgramFullPath()}, @ref{3ba,,Py_GetPythonHome()}, @ref{3b9,,Py_GetProgramName()}, @ref{172f,,PyEval_InitThreads()}, e @ref{9cd,,Py_RunMain()}.
@end quotation
@end cartouche

@node Variáveis de configuração global,Inicializando e encerrando o interpretador,Antes da inicialização do Python,Inicialização finalização e threads
@anchor{c-api/init global-conf-vars}@anchor{5186}@anchor{c-api/init global-configuration-variables}@anchor{518a}
@subsection Variáveis de configuração global


Python tem variáveis para a configuração global a fim de controlar diferentes características e opções. Por padrão, estes sinalizadores são controlados por @ref{1eb3,,opções de linha de comando}.

Quando um sinalizador é definido por uma opção, o valor do sinalizador é o número de vezes que a opção foi definida. Por exemplo, @code{-b} define @ref{3d4,,Py_BytesWarningFlag} para 1 e @code{-bb} define @ref{3d4,,Py_BytesWarningFlag} para 2.

@geindex Py_BytesWarningFlag (C var)
@anchor{c-api/init c Py_BytesWarningFlag}@anchor{3d4}
@deffn {C Variável} int Py_BytesWarningFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3d5,,PyConfig.bytes_warning} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Emite um aviso ao comparar @ref{1c2,,bytes} ou @ref{2ea,,bytearray} com @ref{44c,,str} ou @ref{1c2,,bytes} com @ref{257,,int}. Emite um erro se for maior ou igual a @code{2}.

Definida pela opção @ref{5e3,,-b}.


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

@end deffn

@geindex Py_DebugFlag (C var)
@anchor{c-api/init c Py_DebugFlag}@anchor{3c6}
@deffn {C Variável} int Py_DebugFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3c7,,PyConfig.parser_debug} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Ativa a saída de depuração do analisador sintático (somente para especialistas, dependendo das opções de compilação).

Definida pela a opção @ref{1ebb,,-d} e a variável de ambiente 
@geindex PYTHONDEBUG
@geindex variável de ambiente; PYTHONDEBUG
@ref{1ebc,,PYTHONDEBUG}.


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

@end deffn

@geindex Py_DontWriteBytecodeFlag (C var)
@anchor{c-api/init c Py_DontWriteBytecodeFlag}@anchor{3da}
@deffn {C Variável} int Py_DontWriteBytecodeFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3db,,PyConfig.write_bytecode} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Se definida como diferente de zero, o Python não tentará escrever arquivos @code{.pyc} na importação de módulos fonte.

Definida pela opção @ref{1414,,-B} e pela variável de ambiente 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE}.


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

@end deffn

@geindex Py_FrozenFlag (C var)
@anchor{c-api/init c Py_FrozenFlag}@anchor{3d6}
@deffn {C Variável} int Py_FrozenFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3d7,,PyConfig.pathconfig_warnings} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Suprime mensagens de erro ao calcular o caminho de pesquisa do módulo em @ref{3b3,,Py_GetPath()}.

Sinalizador privado usado pelos programas @code{_freeze_module} e @code{frozenmain}.


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

@end deffn

@geindex Py_HashRandomizationFlag (C var)
@anchor{c-api/init c Py_HashRandomizationFlag}@anchor{3e0}
@deffn {C Variável} int Py_HashRandomizationFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração de @ref{3e2,,PyConfig.hash_seed} e @ref{3e1,,PyConfig.use_hash_seed} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Definida como @code{1} se a variável de ambiente 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} estiver definida como uma string não vazia.

Se o sinalizador for diferente de zero, lê a variável de ambiente 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} para inicializar a semente de hash secreta.


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

@end deffn

@geindex Py_IgnoreEnvironmentFlag (C var)
@anchor{c-api/init c Py_IgnoreEnvironmentFlag}@anchor{3d8}
@deffn {C Variável} int Py_IgnoreEnvironmentFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3d9,,PyConfig.use_environment} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Ignora todas as variáveis de ambiente @code{PYTHON*}, por exemplo 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} e 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}, que podem estar definidas.

Definida pelas opções @ref{964,,-E} e @ref{965,,-I}.


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

@end deffn

@geindex Py_InspectFlag (C var)
@anchor{c-api/init c Py_InspectFlag}@anchor{3ce}
@deffn {C Variável} int Py_InspectFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3cf,,PyConfig.inspect} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Quando um script é passado como primeiro argumento ou a opção @ref{5e0,,-c} é usada, entre no modo interativo após executar o script ou o comando, mesmo quando @ref{53d,,sys.stdin} não parece ser um terminal.

Definida pela opção @ref{1523,,-i} e pela variável de ambiente 
@geindex PYTHONINSPECT
@geindex variável de ambiente; PYTHONINSPECT
@ref{1522,,PYTHONINSPECT}.


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

@end deffn

@geindex Py_InteractiveFlag (C var)
@anchor{c-api/init c Py_InteractiveFlag}@anchor{3cc}
@deffn {C Variável} int Py_InteractiveFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3cd,,PyConfig.interactive} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Definida pela opção @ref{1523,,-i}.


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

@end deffn

@geindex Py_IsolatedFlag (C var)
@anchor{c-api/init c Py_IsolatedFlag}@anchor{3e3}
@deffn {C Variável} int Py_IsolatedFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3e4,,PyConfig.isolated} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Executa o Python no modo isolado. No modo isolado, @ref{3b4,,sys.path} não contém nem o diretório do script nem o diretório de pacotes de sites do usuário.

Definida pela opção @ref{965,,-I}.


Adicionado na versão 3.4.



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

@end deffn

@geindex Py_LegacyWindowsFSEncodingFlag (C var)
@anchor{c-api/init c Py_LegacyWindowsFSEncodingFlag}@anchor{3e5}
@deffn {C Variável} int Py_LegacyWindowsFSEncodingFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Se o sinalizador for diferente de zero, use a codificação @code{mbcs} com o tratador de erros @code{replace}, em vez da codificação UTF-8 com o tratador de erros @code{surrogatepass}, para a codificação do sistema de arquivos e @ref{53b,,tratador de erros e codificação do sistema de arquivos}.

Definida como @code{1} se a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} estiver definida como uma string não vazia.

Veja 
@geindex Propostas de Melhorias do Python; PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} para mais detalhes.

@ref{1ed8,,Disponibilidade}: Windows.


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

@end deffn

@geindex Py_LegacyWindowsStdioFlag (C var)
@anchor{c-api/init c Py_LegacyWindowsStdioFlag}@anchor{3e7}
@deffn {C Variável} int Py_LegacyWindowsStdioFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3a4,,PyConfig.legacy_windows_stdio} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Se o sinalizador for diferente de zero, usa @ref{1354,,io.FileIO} em vez de @code{io._WindowsConsoleIO} para fluxos padrão @ref{d9,,sys}.

Definida como @code{1} se a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@ref{c76,,PYTHONLEGACYWINDOWSSTDIO} estiver definida como uma string não vazia.

Veja a 
@geindex Propostas de Melhorias do Python; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} para mais detalhes.

@ref{1ed8,,Disponibilidade}: Windows.


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

@end deffn

@geindex Py_NoSiteFlag (C var)
@anchor{c-api/init c Py_NoSiteFlag}@anchor{3d2}
@deffn {C Variável} int Py_NoSiteFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3d3,,PyConfig.site_import} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Desabilita a importação do módulo @ref{c7,,site} e as manipulações dependentes do site de @ref{3b4,,sys.path} que isso acarreta. Também desabilita essas manipulações se @ref{c7,,site} for explicitamente importado mais tarde (chame @ref{1ebe,,site.main()} se você quiser que eles sejam acionados).

Definida pela opção @ref{11e7,,-S}.


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

@end deffn

@geindex Py_NoUserSiteDirectory (C var)
@anchor{c-api/init c Py_NoUserSiteDirectory}@anchor{3dc}
@deffn {C Variável} int Py_NoUserSiteDirectory

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3dd,,PyConfig.user_site_directory} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Não adiciona o @code{diretório site-packages de usuário} a @ref{3b4,,sys.path}.

Definida pelas opções @ref{13d5,,-s} e @ref{965,,-I}, e pela variável de ambiente 
@geindex PYTHONNOUSERSITE
@geindex variável de ambiente; PYTHONNOUSERSITE
@ref{13d6,,PYTHONNOUSERSITE}.


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

@end deffn

@geindex Py_OptimizeFlag (C var)
@anchor{c-api/init c Py_OptimizeFlag}@anchor{3d0}
@deffn {C Variável} int Py_OptimizeFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3d1,,PyConfig.optimization_level} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Definida pela opção @ref{ddd,,-O} e pela variável de ambiente 
@geindex PYTHONOPTIMIZE
@geindex variável de ambiente; PYTHONOPTIMIZE
@ref{1ebd,,PYTHONOPTIMIZE}.


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

@end deffn

@geindex Py_QuietFlag (C var)
@anchor{c-api/init c Py_QuietFlag}@anchor{3ca}
@deffn {C Variável} int Py_QuietFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3cb,,PyConfig.quiet} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Não exibe as mensagens de direitos autorais e de versão nem mesmo no modo interativo.

Definida pela opção @ref{15a5,,-q}.


Adicionado na versão 3.2.



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

@end deffn

@geindex Py_UnbufferedStdioFlag (C var)
@anchor{c-api/init c Py_UnbufferedStdioFlag}@anchor{3de}
@deffn {C Variável} int Py_UnbufferedStdioFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3df,,PyConfig.buffered_stdio} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Força os fluxos stdout e stderr a não serem armazenados em buffer.

Definida pela opção @ref{1b1c,,-u} e pela variável de ambiente 
@geindex PYTHONUNBUFFERED
@geindex variável de ambiente; PYTHONUNBUFFERED
@ref{1b1d,,PYTHONUNBUFFERED}.


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

@end deffn

@geindex Py_VerboseFlag (C var)
@anchor{c-api/init c Py_VerboseFlag}@anchor{3c8}
@deffn {C Variável} int Py_VerboseFlag

Esta API é mantida para compatibilidade com versões anteriores: a configuração @ref{3c9,,PyConfig.verbose} deve ser usada em seu lugar, consulte @ref{3a7,,Configuração de inicialização do Python}.

Exibe uma mensagem cada vez que um módulo é inicializado, mostrando o local (nome do arquivo ou módulo embutido) de onde ele é carregado. Se maior ou igual a @code{2}, exibe uma mensagem para cada arquivo que é verificado durante a busca por um módulo. Também fornece informações sobre a limpeza do módulo na saída.

Definida pela a opção @ref{146c,,-v} e a variável de ambiente 
@geindex PYTHONVERBOSE
@geindex variável de ambiente; PYTHONVERBOSE
@ref{1ebf,,PYTHONVERBOSE}.


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

@end deffn

@node Inicializando e encerrando o interpretador,Parâmetros de todo o processo,Variáveis de configuração global,Inicialização finalização e threads
@anchor{c-api/init initializing-and-finalizing-the-interpreter}@anchor{518b}
@subsection Inicializando e encerrando o interpretador


@geindex Py_Initialize (C function)
@anchor{c-api/init c Py_Initialize}@anchor{8b1}
@deffn {C Função} void Py_Initialize ()
` Parte da @ref{553,,ABI Estável}.'
@geindex PyEval_InitThreads()
@geindex modules (in module sys)
@geindex path (no módulo sys)
@geindex módulo;builtins
@geindex módulo;__main__
@geindex módulo;sys
@geindex módulo;pesquisa;caminho
@geindex Py_FinalizeEx (função C)

Inicializa o interpretador Python. Em uma aplicação que incorpora o Python, isto deve ser chamado antes do uso de qualquer outra função do API C/Python; veja @ref{bde,,Antes da inicialização do Python} para algumas exceções.

Isso inicializa a tabela de módulos carregados (@code{sys.modules}) e cria os módulos fundamentais @ref{12,,builtins}, @ref{1,,__main__} e @ref{d9,,sys}. Também inicializa o caminho de pesquisa de módulos (@code{sys.path}). Isso não define @code{sys.argv}; use a API da @ref{3a7,,Configuração de inicialização do Python} para isso. Isso é um no-op quando chamado pela segunda vez (sem chamar @ref{d37,,Py_FinalizeEx()} primeiro). Não há valor de retorno; é um erro fatal se a inicialização falhar.

Usa @ref{3c5,,Py_InitializeFromConfig()} para personalizar a @ref{3a7,,Configuração de inicialização do Python}.

@cartouche
@quotation Nota 
No Windows, altera o modo do console de @code{O_TEXT} para @code{O_BINARY}, o que também afetará usos não Python do console usando o Runtime C.
@end quotation
@end cartouche
@end deffn

@geindex Py_InitializeEx (C function)
@anchor{c-api/init c Py_InitializeEx}@anchor{4dca}
@deffn {C Função} void Py_InitializeEx (int initsigs)
` Parte da @ref{553,,ABI Estável}.'
Esta função funciona como @ref{8b1,,Py_Initialize()} se `initsigs' for @code{1}. Se `initsigs' for @code{0}, ela pula o registro de inicialização de manipuladores de sinal, o que pode ser útil quando o CPython é incorporado como parte de uma aplicação maior.

Usa @ref{3c5,,Py_InitializeFromConfig()} para personalizar a @ref{3a7,,Configuração de inicialização do Python}.
@end deffn

@geindex Py_InitializeFromConfig (C function)
@anchor{c-api/init c Py_InitializeFromConfig}@anchor{3c5}
@deffn {C Função} @ref{9b5,,PyStatus} Py_InitializeFromConfig (const PyConfig *config)

Inicializa o Python a partir da configuração `config', conforme descrito em @ref{518c,,Initialization with PyConfig}.

Consulte a seção @ref{3a7,,Configuração de inicialização do Python} para obter detalhes sobre como pré-inicializar o interpretador, preencher a estrutura de configuração do tempo de execução e consultar a estrutura de status retornada.
@end deffn

@geindex Py_IsInitialized (C function)
@anchor{c-api/init c Py_IsInitialized}@anchor{4bea}
@deffn {C Função} int Py_IsInitialized ()
` Parte da @ref{553,,ABI Estável}.'
Retorna verdadeiro (diferente de zero) quando o interpretador Python foi inicializado, falso (zero) se não. Após @ref{d37,,Py_FinalizeEx()} ser chamado, isso retorna falso até que @ref{8b1,,Py_Initialize()} seja chamado novamente.
@end deffn

@geindex Py_IsFinalizing (C function)
@anchor{c-api/init c Py_IsFinalizing}@anchor{358}
@deffn {C Função} int Py_IsFinalizing ()
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Retorna verdadeiro (diferente de zero) se o interpretador Python principal estiver em @ref{14e,,desligamento}. Retorna falso (zero) caso contrário.


Adicionado na versão 3.13.

@end deffn

@geindex Py_FinalizeEx (C function)
@anchor{c-api/init c Py_FinalizeEx}@anchor{d37}
@deffn {C Função} int Py_FinalizeEx ()
` Parte da @ref{553,,ABI Estável} desde a versão 3.6.'
Undo all initializations made by @ref{8b1,,Py_Initialize()} and subsequent use of
Python/C API functions, and destroy all sub-interpreters (see
@ref{18b9,,Py_NewInterpreter()} below) that were created and not yet destroyed since
the last call to @ref{8b1,,Py_Initialize()}.  Ideally, this frees all memory
allocated by the Python interpreter.  This is a no-op when called for a second
time (without calling @ref{8b1,,Py_Initialize()} again first).

Como isso é o inverso de @ref{8b1,,Py_Initialize()}, ele deve ser chamado na mesma thread com o mesmo interpretador ativo. Isso significa a thread principal e o interpretador principal. Isso nunca deve ser chamado enquanto @ref{9cd,,Py_RunMain()} estiver em execução.

Normalmente, o valor de retorno é @code{0}. Se houver erros durante a finalização (limpeza de dados armazenados em buffer), @code{-1} será retornado.

Esta função é fornecida por vários motivos. Uma aplicação de incorporação pode querer reiniciar o Python sem precisar reiniciar a própria aplicação. Uma aplicação que carregou o interpretador Python de uma biblioteca carregável dinamicamente (ou DLL) pode querer liberar toda a memória alocada pelo Python antes de descarregar a DLL. Durante uma busca por vazamentos de memória em uma aplicação, um desenvolvedor pode querer liberar toda a memória alocada pelo Python antes de sair da aplicação.

`Bugs and caveats:' The destruction of modules and objects in modules is done
in random order; this may cause destructors (@ref{1033,,__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.  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{8b1,,Py_Initialize()} and
@ref{d37,,Py_FinalizeEx()} more than once.  @ref{d37,,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{c,,atexit} handlers, object finalizers, or any code that may be run
while flushing the stdout and stderr files.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython._PySys_ClearAuditHooks} sem argumentos.


Adicionado na versão 3.6.

@end deffn

@geindex Py_Finalize (C function)
@anchor{c-api/init c Py_Finalize}@anchor{13a0}
@deffn {C Função} void Py_Finalize ()
` Parte da @ref{553,,ABI Estável}.'
Esta é uma versão retrocompatível de @ref{d37,,Py_FinalizeEx()} que desconsidera o valor de retorno.
@end deffn

@geindex Py_BytesMain (C function)
@anchor{c-api/init c Py_BytesMain}@anchor{9c9}
@deffn {C Função} int Py_BytesMain (int argc, char **argv)
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
Semelhante a @ref{c3f,,Py_Main()}, mas `argv' é um vetor de strings de bytes, permitindo que a aplicação chamadora delegue a etapa de decodificação de texto ao ambiente de execução do CPython.


Adicionado na versão 3.8.

@end deffn

@geindex Py_Main (C function)
@anchor{c-api/init c Py_Main}@anchor{c3f}
@deffn {C Função} int Py_Main (int argc, wchar_t **argv)
` Parte da @ref{553,,ABI Estável}.'
O programa principal para o interpretador padrão, encapsulando um ciclo completo de inicialização/finalização, bem como comportamento adicional para implementar a leitura de configurações do ambiente e da linha de comando e, em seguida, executar @code{__main__} de acordo com a @ref{103d,,Linha de comando}.

Isso é disponibilizado para programas que desejam oferecer suporte à interface de linha de comando completa do CPython, em vez de apenas incorporar um ambiente de execução do Python em uma aplicação maior.

Os parâmetros `argc' e `argv' são semelhantes aos passados para a função @code{main()} de um programa C, exceto que as entradas `argv' são primeiro convertidas para @code{wchar_t} usando @ref{be0,,Py_DecodeLocale()}. Também é importante observar que as entradas da lista de argumentos podem ser modificadas para apontar para strings diferentes daquelas passadas (no entanto, o conteúdo das strings apontadas pela lista de argumentos não é modificado).

O valor de retorno é @code{2} se a lista de argumentos não representar uma linha de comando Python válida e, caso contrário, o mesmo que @ref{9cd,,Py_RunMain()}.

Em termos das APIs de configuração de tempo de execução do CPython documentadas na seção de @ref{3a7,,configuração do ambiente de execução} (e sem levar em conta o tratamento de erros), @code{Py_Main} é aproximadamente equivalente a:

@example
PyConfig config;
PyConfig_InitPythonConfig(&config);
PyConfig_SetArgv(&config, argc, argv);
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);

Py_RunMain();
@end example

Em uso normal, uma aplicação de incorporação chamará esta função `em vez' de chamar @ref{8b1,,Py_Initialize()}, @ref{4dca,,Py_InitializeEx()} ou @ref{3c5,,Py_InitializeFromConfig()} diretamente, e todas as configurações serão aplicadas conforme descrito em outra parte desta documentação. Se esta função for chamada `após' uma chamada anterior à API de inicialização do ambiente de execução, as configurações de ambiente e de linha de comando que serão atualizadas dependem da versão (pois dependem de quais configurações oferecem suporte corretamente à modificação após já terem sido definidas uma vez na primeira inicialização do ambiente de execução).
@end deffn

@geindex Py_RunMain (C function)
@anchor{c-api/init c Py_RunMain}@anchor{9cd}
@deffn {C Função} int Py_RunMain (void)

Executa o módulo principal em um ambiente de execução CPython totalmente configurado.

Executa o comando (@ref{518d,,PyConfig.run_command}), o script (@ref{518e,,PyConfig.run_filename}) ou o módulo (@ref{518f,,PyConfig.run_module}) especificado na linha de comando ou na configuração. Se nenhum desses valores estiver definido, executa o prompt interativo do Python (REPL) usando o espaço de nomes global do módulo @code{__main__}.

Se @ref{3cf,,PyConfig.inspect} não estiver definido (o padrão), o valor de retorno será @code{0} se o interpretador terminar normalmente (ou seja, sem levantar uma exceção), o status de saída de uma exceção @ref{d63,,SystemExit} não tratada ou @code{1} para qualquer outra exceção não tratada.

Se @ref{3cf,,PyConfig.inspect} estiver definido (como quando a opção @ref{1523,,-i} é usada), em vez de retornar quando o interpretador for encerrado, a execução será retomada em um prompt interativo do Python (REPL) usando o espaço de nomes global do módulo @code{__main__}. Se o interpretador for encerrado com uma exceção, ela será imediatamente levantada na sessão do REPL. O valor de retorno da função é então determinado pela forma como a `sessão do REPL' termina: @code{0}, @code{1} ou o status de uma exceção @ref{d63,,SystemExit}, conforme especificado acima.

Essa função sempre finaliza o interpretador Python antes de retornar.

Consulte a @ref{5190,,Configuração do Python} para obter um exemplo de um Python personalizado que sempre é executado em modo isolado usando @ref{9cd,,Py_RunMain()}.
@end deffn

@geindex PyUnstable_AtExit (C function)
@anchor{c-api/init c PyUnstable_AtExit}@anchor{1672}
@deffn {C Função} int PyUnstable_AtExit (PyInterpreterState *interp, void (*func)(void*), void *data)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Registra uma função de retorno de chamada @ref{c,,atexit} para o interpretador de destino `interp'. Isso é semelhante a @ref{4dbf,,Py_AtExit()}, mas recebe um interpretador explícito e um ponteiro de dados para a função de retorno de chamada.

The @ref{159,,GIL} must be held for `interp'.


Adicionado na versão 3.13.

@end deffn

@node Parâmetros de todo o processo,Estado de thread e a trava global do interpretador,Inicializando e encerrando o interpretador,Inicialização finalização e threads
@anchor{c-api/init process-wide-parameters}@anchor{5191}
@subsection Parâmetros de todo o processo


@geindex Py_SetProgramName (C function)
@anchor{c-api/init c Py_SetProgramName}@anchor{172c}
@deffn {C Função} void Py_SetProgramName (const wchar_t *name)
` Parte da @ref{553,,ABI Estável}.'
@geindex Py_Initialize()
@geindex main()
@geindex Py_GetPath()

Esta API é mantida para compatibilidade com versões anteriores: em vez disso, deve-se usar a configuração @ref{3c4,,PyConfig.program_name}, consulte @ref{3a7,,Configuração de inicialização do Python}.

Esta função deve ser chamada antes de @ref{8b1,,Py_Initialize()} ser chamada pela primeira vez, caso seja solicitada. Ela diz ao interpretador o valor do argumento @code{argv[0]} para a função @code{main()} do programa (convertido em caracteres amplos). Isto é utilizado por @ref{3b3,,Py_GetPath()} e algumas outras funções abaixo para encontrar as bibliotecas de tempo de execução relativas ao executável do interpretador. O valor padrão é @code{'python'}. O argumento deve apontar para um caractere string amplo terminado em zero no armazenamento estático, cujo conteúdo não mudará durante a execução do programa. Nenhum código no interpretador Python mudará o conteúdo deste armazenamento.

Use @ref{be0,,Py_DecodeLocale()} para decodificar uma string de bytes e obter uma string wchar_t*.


Descontinuado desde a versão 3.11.

@end deffn

@geindex Py_GetProgramName (C function)
@anchor{c-api/init c Py_GetProgramName}@anchor{3b9}
@deffn {C Função} wchar_t *Py_GetProgramName ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o nome do programa definido com @ref{3c4,,PyConfig.program_name}, ou o valor padrão. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3b8,,sys.executable} instead.

@end deffn

@geindex Py_GetPrefix (C function)
@anchor{c-api/init c Py_GetPrefix}@anchor{3b5}
@deffn {C Função} wchar_t *Py_GetPrefix ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o `prefix' para arquivos instalados que independem da plataforma. Este prefixo é derivado de uma série de regras complexas a partir do nome do programa definido com @ref{3c4,,PyConfig.program_name} e algumas variáveis de ambiente; por exemplo, se o nome do programa for @code{'/usr/local/bin/python'}, o prefixo será @code{'/usr/local'}. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. Isso corresponde à variável @code{prefix} no arquivo @code{Makefile} de nível superior e ao argumento @ref{1ee7,,--prefix} do script @code{configure} em tempo de construção. O valor está disponível para o código Python como @code{sys.base_prefix}. É útil apenas em sistemas Unix. Veja também a próxima função.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3ef,,sys.base_prefix} instead, or @ref{3b6,,sys.prefix} if
@ref{4557,,virtual environments} need to be handled.

@end deffn

@geindex Py_GetExecPrefix (C function)
@anchor{c-api/init c Py_GetExecPrefix}@anchor{3b1}
@deffn {C Função} wchar_t *Py_GetExecPrefix ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o `exec-prefix' para arquivos instalados que `dependem' da plataforma. Este prefixo é derivado de uma série de regras complexas a partir do nome do programa definido com @ref{3c4,,PyConfig.program_name} e algumas variáveis de ambiente; por exemplo, se o nome do programa for @code{'/usr/local/bin/python'}, o exec-prefix será @code{'/usr/local'}. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. Isso corresponde à variável @code{exec_prefix} no arquivo @code{Makefile} de nível superior e ao argumento @code{--exec-prefix} do script @code{configure} em tempo de construção. O valor está disponível para o código Python como @code{sys.base_exec_prefix}. É útil apenas em sistemas Unix.

Contexto: O exec-prefix difere do prefixo padrão quando arquivos dependentes da plataforma (como executáveis e bibliotecas compartilhadas) são instalados em uma árvore de diretórios diferente. Em uma instalação típica, arquivos dependentes da plataforma podem ser instalados na subárvore @code{/usr/local/plat}, enquanto arquivos independentes da plataforma podem ser instalados em @code{/usr/local}.

De modo geral, uma plataforma é uma combinação de famílias de hardware e software. Por exemplo, máquinas Sparc executando o sistema operacional Solaris 2.x são consideradas a mesma plataforma, mas máquinas Intel executando Solaris 2.x são outra plataforma, e máquinas Intel executando Linux são uma terceira. Diferentes revisões principais do mesmo sistema operacional geralmente também formam plataformas diferentes. Sistemas operacionais não-Unix são um caso à parte; as estratégias de instalação nesses sistemas são tão diferentes que o prefixo e o prefixo de execução são irrelevantes e definidos como uma string vazia. Observe que arquivos de bytecode Python compilados são independentes de plataforma (mas não independentes da versão do Python com a qual foram compilados!).

Os administradores de sistema saberão como configurar os programas @code{mount} ou @code{automount} para compartilhar o arquivo @code{/usr/local} entre plataformas, mantendo o arquivo @code{/usr/local/plat} como um sistema de arquivos diferente para cada plataforma.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3ee,,sys.base_exec_prefix} instead, or @ref{3b2,,sys.exec_prefix} if
@ref{4557,,virtual environments} need to be handled.

@end deffn

@geindex Py_GetProgramFullPath (C function)
@anchor{c-api/init c Py_GetProgramFullPath}@anchor{3b7}
@deffn {C Função} wchar_t *Py_GetProgramFullPath ()
` Parte da @ref{553,,ABI Estável}.'
@geindex executable (in module sys)

Retorna o nome completo do executável Python; este valor é calculado como um efeito colateral da obtenção do caminho de pesquisa de módulos padrão a partir do nome do programa (definido por @ref{3c4,,PyConfig.program_name}). A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. O valor está disponível para o código Python como @code{sys.executable}.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3b8,,sys.executable} instead.

@end deffn

@geindex Py_GetPath (C function)
@anchor{c-api/init c Py_GetPath}@anchor{3b3}
@deffn {C Função} wchar_t *Py_GetPath ()
` Parte da @ref{553,,ABI Estável}.'
@geindex módulo;pesquisa;caminho
@geindex path (no módulo sys)

Retorna o caminho de pesquisa de módulos padrão; este é calculado a partir do nome do programa (definido por @ref{3c4,,PyConfig.program_name}) e algumas variáveis de ambiente. A string retornada consiste em uma série de nomes de diretórios separados por um caractere delimitador que depende da plataforma. O caractere delimitador é @code{':'} no Unix e macOS, e @code{';'} no Windows. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. A lista @ref{3b4,,sys.path} é inicializada com este valor na inicialização do interpretador; ela pode ser (e geralmente é) modificada posteriormente para alterar o caminho de pesquisa para carregamento de módulos.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.

@c XXX should give the exact rules


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3b4,,sys.path} instead.

@end deffn

@geindex Py_GetVersion (C function)
@anchor{c-api/init c Py_GetVersion}@anchor{4dc8}
@deffn {C Função} const char *Py_GetVersion ()
` Parte da @ref{553,,ABI Estável}.'
Retorna a verão deste interpretador Python. Esta é uma string que se parece com

@example
"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"
@end example

@geindex version (in module sys)

A primeira palavra (até o primeiro espaço em branco) representa a versão atual do Python; os primeiros caracteres indicam a versão principal e a versão secundária, separados por um ponto. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. O valor fica disponível para o código Python como @ref{178,,sys.version}.

Veja também a constante @ref{756,,Py_Version}.
@end deffn

@geindex Py_GetPlatform (C function)
@anchor{c-api/init c Py_GetPlatform}@anchor{4dc6}
@deffn {C Função} const char *Py_GetPlatform ()
` Parte da @ref{553,,ABI Estável}.'
@geindex platform (in module sys)

Retorna o identificador da plataforma atual. No Unix, este identificador é formado pelo nome “oficial” do sistema operacional, convertido para minúsculas, seguido pelo número da revisão principal; por exemplo, para Solaris 2.x, também conhecido como SunOS 5.x, o valor é @code{'sunos5'}. No macOS, é @code{'darwin'}. No Windows, é @code{'win'}. A string retornada aponta para um armazenamento estático; o chamador não deve modificar seu valor. O valor está disponível para o código Python como @code{sys.platform}.
@end deffn

@geindex Py_GetCopyright (C function)
@anchor{c-api/init c Py_GetCopyright}@anchor{4dc5}
@deffn {C Função} const char *Py_GetCopyright ()
` Parte da @ref{553,,ABI Estável}.'
Retorna a string oficial de direitos autoriais para a versão atual do Python, por exemplo

@code{'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'}

@geindex copyright (in module sys)

A string retornada aponta para o armazenamento estático; o chamador não deve modificar o seu valor. O valor está disponível para o código Python como @code{sys.copyright}.
@end deffn

@geindex Py_GetCompiler (C function)
@anchor{c-api/init c Py_GetCompiler}@anchor{4dc4}
@deffn {C Função} const char *Py_GetCompiler ()
` Parte da @ref{553,,ABI Estável}.'
Retorna uma indicação do compilador usado para construir a atual versão do Python, em colchetes, por exemplo:

@example
"[GCC 2.7.2.2]"
@end example

@geindex version (in module sys)

A string retornada aponta para o armazenamento estático; o chamador não deve modificar o seu valor. O valor está disponível para o código Python como @code{sys.version}.
@end deffn

@geindex Py_GetBuildInfo (C function)
@anchor{c-api/init c Py_GetBuildInfo}@anchor{1479}
@deffn {C Função} const char *Py_GetBuildInfo ()
` Parte da @ref{553,,ABI Estável}.'
Retorna informação sobre o número de sequência e a data e hora da construção da instância atual do interpretador Python, por exemplo

@example
"#67, Aug  1 1997, 22:34:28"
@end example

@geindex version (in module sys)

A string retornada aponta para o armazenamento estático; o chamador não deve modificar o seu valor. O valor está disponível para o código Python como @code{sys.version}.
@end deffn

@geindex PySys_SetArgvEx (C function)
@anchor{c-api/init c PySys_SetArgvEx}@anchor{172d}
@deffn {C Função} void PySys_SetArgvEx (int argc, wchar_t **argv, int updatepath)
` Parte da @ref{553,,ABI Estável}.'
@geindex main()
@geindex Py_FatalError()
@geindex argv (in module sys)

Esta API é mantida para compatibilidade com versões anteriores: em vez disso, deve-se usar a configuração @ref{3c3,,PyConfig.argv}, @ref{1a7e,,PyConfig.parse_argv} e @ref{773,,PyConfig.safe_path}, consulte @ref{3a7,,Configuração de inicialização do Python}.

Define @ref{12a6,,sys.argv} com base em `argc' e `argv'. Esses parâmetros são semelhantes aos passados para a função @code{main()} do programa, com a diferença de que a primeira entrada deve se referir ao arquivo de script a ser executado, em vez do executável que hospeda o interpretador Python. Se não houver um script a ser executado, a primeira entrada em `argv' pode ser uma string vazia. Se esta função falhar ao inicializar @ref{12a6,,sys.argv}, uma condição fatal será sinalizada usando @ref{98a,,Py_FatalError()}.

Se `updatepath' é zero, isto é tudo o que a função faz. Se `updatepath' não é zero, a função também modifica @ref{3b4,,sys.path} de acordo com o seguinte algoritmo:


@itemize -

@item 
Se o nome de um script existente for passado em @code{argv[0]}, o caminho absoluto do diretório onde o script está localizado será adicionado a @ref{3b4,,sys.path}.

@item 
Caso contrário (isto é, se `argc' for @code{0} ou @code{argv[0]} não apontar para um nome de arquivo existente), uma string vazia é adicionada ao início de @ref{3b4,,sys.path}, o que é o mesmo que adicionar o diretório de trabalho atual (@code{"."}).
@end itemize

Use @ref{be0,,Py_DecodeLocale()} para decodificar uma string de bytes e obter uma string wchar_t*.

Veja também os membros @ref{898,,PyConfig.orig_argv} e @ref{3c3,,PyConfig.argv} da @ref{3a7,,Configuração de inicialização do Python}.

@cartouche
@quotation Nota 
Recomenda-se que aplicações que incorporam o interpretador Python para fins que não sejam a execução de um único script passem @code{0} como `updatepath', e atualizem @ref{3b4,,sys.path} por conta própria, se desejarem. Veja 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}.

Em versões anteriores à 3.1.3, você pode obter o mesmo efeito removendo manualmente o primeiro elemento de @ref{3b4,,sys.path} após ter chamado @ref{172e,,PySys_SetArgv()}, por exemplo, usando:

@example
PyRun_SimpleString("import sys; sys.path.pop(0)\n");
@end example
@end quotation
@end cartouche


Adicionado na versão 3.1.3.


@c XXX impl. doesn't seem consistent in allowing ``0``/``NULL`` for the params;
@c check w/ Guido.


Descontinuado desde a versão 3.11.

@end deffn

@geindex PySys_SetArgv (C function)
@anchor{c-api/init c PySys_SetArgv}@anchor{172e}
@deffn {C Função} void PySys_SetArgv (int argc, wchar_t **argv)
` Parte da @ref{553,,ABI Estável}.'
Esta API é mantida para retrocompatibilidade: em vez disso, devem ser usadas as configurações @ref{3c3,,PyConfig.argv} e @ref{1a7e,,PyConfig.parse_argv}, consulte a @ref{3a7,,Configuração de inicialização do Python}.

Esta função funciona como @ref{172d,,PySys_SetArgvEx()} com `updatepath' definido como @code{1} a menos que o interpretador @code{python} tenha sido iniciado com a @ref{965,,-I}.

Use @ref{be0,,Py_DecodeLocale()} para decodificar uma string de bytes e obter uma string wchar_t*.

Veja também os membros @ref{898,,PyConfig.orig_argv} e @ref{3c3,,PyConfig.argv} da @ref{3a7,,Configuração de inicialização do Python}.


Alterado na versão 3.4: O valor `updatepath' depende de @ref{965,,-I}.



Descontinuado desde a versão 3.11.

@end deffn

@geindex Py_SetPythonHome (C function)
@anchor{c-api/init c Py_SetPythonHome}@anchor{172b}
@deffn {C Função} void Py_SetPythonHome (const wchar_t *home)
` Parte da @ref{553,,ABI Estável}.'
Esta API é mantida para retrocompatibilidade: em vez disso, deve-se usar a configuração @ref{3bb,,PyConfig.home}, consulte a @ref{3a7,,Configuração de inicialização do Python}.

Define o diretório pessoal (“home”) padrão, ou seja, o local das bibliotecas padrão do Python. Consulte 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} para obter o significado da string do argumento.

O argumento deve apontar para uma string terminada em zero em um armazenamento estático, cujo conteúdo não será alterado durante a execução do programa. Nenhum código no interpretador Python alterará o conteúdo desse armazenamento.

Use @ref{be0,,Py_DecodeLocale()} para decodificar uma string de bytes e obter uma string wchar_t*.


Descontinuado desde a versão 3.11.

@end deffn

@geindex Py_GetPythonHome (C function)
@anchor{c-api/init c Py_GetPythonHome}@anchor{3ba}
@deffn {C Função} wchar_t *Py_GetPythonHome ()
` Parte da @ref{553,,ABI Estável}.'
Retorna o “home” padrão, ou seja, o valor definido por @ref{3bb,,PyConfig.home}, ou o valor da variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} se estiver definida.

Esta função não deve ser chamada antes de @ref{8b1,,Py_Initialize()}, caso contrário ela retorna @code{NULL}.


Alterado na versão 3.10: Agora retorna @code{NULL} se for chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.13, será removido na versão 3.15: Get @ref{3bb,,PyConfig.home} or 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} environment
variable instead.

@end deffn

@node Estado de thread e a trava global do interpretador,Sub-interpreter support,Parâmetros de todo o processo,Inicialização finalização e threads
@anchor{c-api/init thread-state-and-the-global-interpreter-lock}@anchor{5192}@anchor{c-api/init threads}@anchor{5193}
@subsection Estado de thread e a trava global do interpretador


@geindex trava global do interpretador
@geindex interpreter lock
@geindex lock@comma{} interpreter

The Python interpreter is not fully thread-safe.  In order to support
multi-threaded Python programs, there’s a global lock, called the @ref{148,,global interpreter lock} or @ref{159,,GIL}, that must be held by the current thread before
it can safely access Python objects. Without the lock, even the simplest
operations could cause problems in a multi-threaded program: for example, when
two threads simultaneously increment the reference count of the same object, the
reference count could end up being incremented only once instead of twice.

@geindex setswitchinterval (in module sys)

Portanto, existe a regra de que somente a thread que adquiriu a @ref{159,,GIL} pode operar em objetos Python ou chamar funções da API C/Python. Para emular a simultaneidade de execução, o interpretador tenta alternar threads regularmente (consulte @ref{951,,sys.setswitchinterval()}). A trava também é liberada em operações de E/S potencialmente bloqueantes, como ler ou escrever um arquivo, para que outras threads Python possam ser executadas enquanto isso.

@geindex PyThreadState (C type)

The Python interpreter keeps some thread-specific bookkeeping information
inside a data structure called @ref{78d,,PyThreadState}.  There’s also one
global variable pointing to the current @ref{78d,,PyThreadState}: it can
be retrieved using @ref{372,,PyThreadState_Get()}.

@menu
* Releasing the GIL from extension code:: 
* Threads não-Python criadas:: 
* Cuidados com o uso de fork(): Cuidados com o uso de fork. 
* Cautions regarding runtime finalization:: 
* High-level API:: 
* Low-level API:: 

@end menu

@node Releasing the GIL from extension code,Threads não-Python criadas,,Estado de thread e a trava global do interpretador
@anchor{c-api/init releasing-the-gil-from-extension-code}@anchor{5194}
@subsubsection Releasing the GIL from extension code


A maioria dos códigos de extensão que manipulam a @ref{159,,GIL} tem a seguinte estrutura:

@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

Isso é tão comum que existe um par de macros para simplificá-lo:

@example
Py_BEGIN_ALLOW_THREADS
... Faça alguma operação de E/S com bloqueio...
Py_END_ALLOW_THREADS
@end example

@geindex Py_BEGIN_ALLOW_THREADS (C macro)
@geindex Py_END_ALLOW_THREADS (C macro)

A macro @ref{4b67,,Py_BEGIN_ALLOW_THREADS} abre um novo bloco e declara uma variável local oculta; a macro @ref{a98,,Py_END_ALLOW_THREADS} fecha o bloco.

O bloco acima se expande para o seguinte código:

@example
PyThreadState *_save;

_save = PyEval_SaveThread();
... Faça alguma operação de E/S com bloqueio...
PyEval_RestoreThread(_save);
@end example

@geindex PyEval_RestoreThread (C function)
@geindex PyEval_SaveThread (C function)

Here is how these functions work: the global interpreter lock is used to protect the pointer to the
current thread state.  When releasing the lock and saving the thread state,
the current thread state pointer must be retrieved before the lock is released
(since another thread could immediately acquire the lock and store its own thread
state in the global variable). Conversely, when acquiring the lock and restoring
the thread state, the lock must be acquired before storing the thread state
pointer.

@cartouche
@quotation Nota 
Calling system I/O functions is the most common use case for releasing
the GIL, but it can also be useful before calling long-running computations
which don’t need access to Python objects, such as compression or
cryptographic functions operating over memory buffers.  For example, the
standard @ref{133,,zlib} and @ref{68,,hashlib} modules release the GIL when
compressing or hashing data.
@end quotation
@end cartouche

@node Threads não-Python criadas,Cuidados com o uso de fork,Releasing the GIL from extension code,Estado de thread e a trava global do interpretador
@anchor{c-api/init gilstate}@anchor{5195}@anchor{c-api/init non-python-created-threads}@anchor{5196}
@subsubsection Threads não-Python criadas


When threads are created using the dedicated Python APIs (such as the
@ref{ed,,threading} module), a thread state is automatically associated to them
and the code showed above is therefore correct.  However, when threads are
created from C (for example by a third-party library with its own thread
management), they don’t hold the GIL, nor is there a thread state structure
for them.

If you need to call Python code from these threads (often this will be part
of a callback API provided by the aforementioned third-party library),
you must first register these threads with the interpreter by
creating a thread state data structure, then acquiring the GIL, and finally
storing their thread state pointer, before you can start using the Python/C
API.  When you are done, you should reset the thread state pointer, release
the GIL, and finally free the thread state data structure.

As funções @ref{3ab,,PyGILState_Ensure()} e @ref{3ac,,PyGILState_Release()} fazem tudo isso automaticamente. O padrão típico para chamar o Python a partir de uma thread C é:

@example
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();

/* Executa ações do Python aqui. */
result = ChamaAlgumaFunção();
/* avalia resultado ou trata de exceção */

/* Libera a thread. Na API do Python permitida além deste ponto. */
PyGILState_Release(gstate);
@end example

Note that the @code{PyGILState_*} functions assume there is only one global
interpreter (created automatically by @ref{8b1,,Py_Initialize()}).  Python
supports the creation of additional interpreters (using
@ref{18b9,,Py_NewInterpreter()}), but mixing multiple interpreters and the
@code{PyGILState_*} API is unsupported.

@node Cuidados com o uso de fork,Cautions regarding runtime finalization,Threads não-Python criadas,Estado de thread e a trava global do interpretador
@anchor{c-api/init cautions-about-fork}@anchor{5197}@anchor{c-api/init fork-and-threads}@anchor{4ea8}
@subsubsection Cuidados com o uso de fork()


Outro aspecto importante a observar sobre threads é o seu comportamento diante da chamada de @code{fork()} da linguagem C. Na maioria dos sistemas com @code{fork()}, após um processo ser criado (“fork”), apenas a thread que emitiu o fork continuará existindo. Isso tem um impacto concreto tanto na forma como as travas devem ser gerenciados quanto em todo o estado armazenado no ambiente de execução do 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{197,,os.fork()} by acquiring the locks it uses internally before
the fork, and releasing them afterwards. In addition, it resets any
@ref{3304,,Lock objects} 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{197,,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{3fb,,PyOS_AfterFork_Child()} tries to reset the necessary locks, but is not
always able to.

The fact that all other threads go away also means that CPython’s
runtime state there must be cleaned up properly, which @ref{197,,os.fork()}
does.  This means finalizing all other @ref{78d,,PyThreadState} objects
belonging to the current interpreter and all other
@ref{8c2,,PyInterpreterState} objects.  Due to this and the special
nature of the @ref{587,,“main” interpreter},
@code{fork()} should only be called in that interpreter’s “main”
thread, where the CPython global runtime was originally initialized.
The only exception is if @code{exec()} will be called immediately
after.

@node Cautions regarding runtime finalization,High-level API,Cuidados com o uso de fork,Estado de thread e a trava global do interpretador
@anchor{c-api/init cautions-regarding-runtime-finalization}@anchor{5198}@anchor{c-api/init id1}@anchor{5199}
@subsubsection Cautions regarding runtime finalization


In the late stage of @ref{14e,,interpreter shutdown}, after attempting to wait for
non-daemon threads to exit (though this can be interrupted by
@ref{9d9,,KeyboardInterrupt}) and running the @ref{c,,atexit} functions, the runtime
is marked as `finalizing': @ref{358,,Py_IsFinalizing()} and
@ref{a99,,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{159,,GIL}.

If any thread, other than the finalization thread, attempts to acquire the GIL
during finalization, either explicitly via @ref{3ab,,PyGILState_Ensure()},
@ref{a98,,Py_END_ALLOW_THREADS}, @ref{3aa,,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.7 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 High-level API,Low-level API,Cautions regarding runtime finalization,Estado de thread e a trava global do interpretador
@anchor{c-api/init high-level-api}@anchor{519a}
@subsubsection High-level API


Estes são os tipos e as funções mais comumente usados na escrita de um código de extensão em C, ou ao incorporar o interpretador Python:

@geindex PyInterpreterState (C type)
@anchor{c-api/init c PyInterpreterState}@anchor{8c2}
@deffn {C Tipo} type PyInterpreterState
` Parte da @ref{553,,API Limitada} (como uma estrutura opaca).'
This data structure represents the state shared by a number of cooperating
threads.  Threads belonging to the same interpreter share their module
administration and a few other internal items. There are no public members in
this structure.

Threads belonging to different interpreters initially share nothing, except
process state like available memory, open file descriptors and such.  The global
interpreter lock is also shared by all threads, regardless of to which
interpreter they belong.


Alterado na versão 3.12: 
@geindex Propostas de Melhorias do Python; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/} introduced the possibility
of a @ref{519b,,per-interpreter GIL}.
See @ref{45c,,Py_NewInterpreterFromConfig()}.

@end deffn

@geindex PyThreadState (C type)
@anchor{c-api/init c PyThreadState}@anchor{78d}
@deffn {C Tipo} type PyThreadState
` Parte da @ref{553,,API Limitada} (como uma estrutura opaca).'
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{519c}
@deffn {C Membro} @ref{8c2,,PyInterpreterState} *interp

This thread’s interpreter state.
@end deffn
@end deffn

@geindex PyEval_InitThreads (C function)
@anchor{c-api/init c PyEval_InitThreads}@anchor{172f}
@deffn {C Função} void PyEval_InitThreads ()
` Parte da @ref{553,,ABI Estável}.'
@geindex PyEval_AcquireThread()
@geindex PyEval_ReleaseThread()
@geindex PyEval_SaveThread()
@geindex PyEval_RestoreThread()

Função descontinuada que não faz nada.

In Python 3.6 and older, this function created the GIL if it didn’t exist.


Alterado na versão 3.9: The function now does nothing.



Alterado na versão 3.7: Esta função agora é chamada por @ref{8b1,,Py_Initialize()}, então não há mais necessidade de você chamá-la.



Alterado na versão 3.2: Esta função não pode mais ser chamada antes de @ref{8b1,,Py_Initialize()}.



Descontinuado desde a versão 3.9.


@geindex módulo;_thread
@end deffn

@geindex PyEval_SaveThread (C function)
@anchor{c-api/init c PyEval_SaveThread}@anchor{3a8}
@deffn {C Função} @ref{78d,,PyThreadState} *PyEval_SaveThread ()
` Parte da @ref{553,,ABI Estável}.'
Release the global interpreter lock (if it has been created) and reset the
thread state to @code{NULL}, returning the previous thread state (which is not
@code{NULL}).  If the lock has been created, the current thread must have
acquired it.
@end deffn

@geindex PyEval_RestoreThread (C function)
@anchor{c-api/init c PyEval_RestoreThread}@anchor{3a9}
@deffn {C Função} void PyEval_RestoreThread (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Acquire the global interpreter lock (if it has been created) and set the
thread state to `tstate', which must not be @code{NULL}.  If the lock has been
created, the current thread must not have acquired it, otherwise deadlock
ensues.

@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{5198,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Alterado na versão 3.13.8: 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{372}
@deffn {C Função} @ref{78d,,PyThreadState} *PyThreadState_Get ()
` Parte da @ref{553,,ABI Estável}.'
Return the current thread state.  The global interpreter lock must be held.
When the current thread state is @code{NULL}, this issues a fatal error (so that
the caller needn’t check for @code{NULL}).

See also @ref{371,,PyThreadState_GetUnchecked()}.
@end deffn

@geindex PyThreadState_GetUnchecked (C function)
@anchor{c-api/init c PyThreadState_GetUnchecked}@anchor{371}
@deffn {C Função} @ref{78d,,PyThreadState} *PyThreadState_GetUnchecked ()

Similar to @ref{372,,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.


Adicionado na versão 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{4d63}
@deffn {C Função} @ref{78d,,PyThreadState} *PyThreadState_Swap (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Swap the current thread state with the thread state given by the argument
`tstate', which may be @code{NULL}.

The @ref{159,,GIL} does not need to be held, but will be held upon returning
if `tstate' is non-@code{NULL}.
@end deffn

The following functions use thread-local storage, and are not compatible
with sub-interpreters:

@geindex PyGILState_STATE (C type)
@anchor{c-api/init c PyGILState_STATE}@anchor{4cc7}
@deffn {C Tipo} type PyGILState_STATE
` Parte da @ref{553,,ABI Estável}.'
The type of the value returned by @ref{3ab,,PyGILState_Ensure()} and passed to
@ref{3ac,,PyGILState_Release()}.

@geindex PyGILState_STATE.PyGILState_LOCKED (C enumerator)
@anchor{c-api/init c PyGILState_STATE PyGILState_LOCKED}@anchor{519d}
@deffn {C Enumerador} enumerator PyGILState_LOCKED

The GIL was already held when @ref{3ab,,PyGILState_Ensure()} was called.
@end deffn

@geindex PyGILState_STATE.PyGILState_UNLOCKED (C enumerator)
@anchor{c-api/init c PyGILState_STATE PyGILState_UNLOCKED}@anchor{519e}
@deffn {C Enumerador} enumerator PyGILState_UNLOCKED

The GIL was not held when @ref{3ab,,PyGILState_Ensure()} was called.
@end deffn
@end deffn

@geindex PyGILState_Ensure (C function)
@anchor{c-api/init c PyGILState_Ensure}@anchor{3ab}
@deffn {C Função} @ref{4cc7,,PyGILState_STATE} PyGILState_Ensure ()
` Parte da @ref{553,,ABI Estável}.'
Certifique-se de que a thread atual esteja pronta para chamar a API Python C, independentemente do estado atual do Python ou da trava global do interpretador (GIL). Isso pode ser chamado quantas vezes desejar por uma thread, desde que cada chamada corresponda a uma chamada para @ref{3ac,,PyGILState_Release()}. Em geral, outras APIs relacionadas a threads podem ser usadas entre chamadas @ref{3ab,,PyGILState_Ensure()} e @ref{3ac,,PyGILState_Release()} desde que o estado da thread seja restaurado ao seu estado anterior antes de Release(). Por exemplo, o uso normal das macros @ref{4b67,,Py_BEGIN_ALLOW_THREADS} e @ref{a98,,Py_END_ALLOW_THREADS} é aceitável.

The return value is an opaque “handle” to the thread state when
@ref{3ab,,PyGILState_Ensure()} was called, and must be passed to
@ref{3ac,,PyGILState_Release()} to ensure Python is left in the same state. Even
though recursive calls are allowed, these handles `cannot' be shared - each
unique call to @ref{3ab,,PyGILState_Ensure()} must save the handle for its call
to @ref{3ac,,PyGILState_Release()}.

When the function returns, the current thread will hold the GIL and be able
to call arbitrary Python code.  Failure is a fatal error.

@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{5198,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Alterado na versão 3.13.8: 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{3ac}
@deffn {C Função} void PyGILState_Release (PyGILState_STATE)
` Parte da @ref{553,,ABI Estável}.'
Release any resources previously acquired.  After this call, Python’s state will
be the same as it was prior to the corresponding @ref{3ab,,PyGILState_Ensure()} call
(but generally this state will be unknown to the caller, hence the use of the
GILState API).

Every call to @ref{3ab,,PyGILState_Ensure()} must be matched by a call to
@ref{3ac,,PyGILState_Release()} on the same thread.
@end deffn

@geindex PyGILState_GetThisThreadState (C function)
@anchor{c-api/init c PyGILState_GetThisThreadState}@anchor{4cc6}
@deffn {C Função} @ref{78d,,PyThreadState} *PyGILState_GetThisThreadState ()
` Parte da @ref{553,,ABI Estável}.'
Get the current thread state for this thread.  May return @code{NULL} if no
GILState API has been used on the current thread.  Note that the main thread
always has such a thread-state, even if no auto-thread-state call has been
made on the main thread.  This is mainly a helper/diagnostic function.
@end deffn

@geindex PyGILState_Check (C function)
@anchor{c-api/init c PyGILState_Check}@anchor{519f}
@deffn {C Função} int PyGILState_Check ()

Return @code{1} if the current thread is holding the GIL and @code{0} otherwise.
This function can be called from any thread at any time.
Only if it has had its Python thread state initialized and currently is
holding the GIL will it return @code{1}.
This is mainly a helper/diagnostic function.  It can be useful
for example in callback contexts or memory allocation functions when
knowing that the GIL is locked can allow the caller to perform sensitive
actions or otherwise behave differently.


Adicionado na versão 3.4.

@end deffn

The following macros are normally used without a trailing semicolon; look for
example usage in the Python source distribution.

@geindex Py_BEGIN_ALLOW_THREADS (C macro)
@anchor{c-api/init c Py_BEGIN_ALLOW_THREADS}@anchor{4b67}
@deffn {C Macro} Py_BEGIN_ALLOW_THREADS
` Parte da @ref{553,,ABI Estável}.'
Esta macro se expande para @code{@{ PyThreadState *_save; _save = PyEval_SaveThread();}. Observe que ele contém uma chave de abertura; ele deve ser combinado com a seguinte macro @ref{a98,,Py_END_ALLOW_THREADS}. Veja acima para uma discussão mais aprofundada desta macro.
@end deffn

@geindex Py_END_ALLOW_THREADS (C macro)
@anchor{c-api/init c Py_END_ALLOW_THREADS}@anchor{a98}
@deffn {C Macro} Py_END_ALLOW_THREADS
` Parte da @ref{553,,ABI Estável}.'
Esta macro se expande para @code{PyEval_RestoreThread(_save); @}}. Observe que ele contém uma chave de fechamento; ele deve ser combinado com uma macro @ref{4b67,,Py_BEGIN_ALLOW_THREADS} anterior. Veja acima para uma discussão mais aprofundada desta macro.
@end deffn

@geindex Py_BLOCK_THREADS (C macro)
@anchor{c-api/init c Py_BLOCK_THREADS}@anchor{4dc0}
@deffn {C Macro} Py_BLOCK_THREADS
` Parte da @ref{553,,ABI Estável}.'
Esta macro se expande para @code{PyEval_RestoreThread(_save);}: é equivalente a @ref{a98,,Py_END_ALLOW_THREADS} sem a chave de fechamento.
@end deffn

@geindex Py_UNBLOCK_THREADS (C macro)
@anchor{c-api/init c Py_UNBLOCK_THREADS}@anchor{4ddf}
@deffn {C Macro} Py_UNBLOCK_THREADS
` Parte da @ref{553,,ABI Estável}.'
Esta macro se expande para @code{_save = PyEval_SaveThread();}: é equivalente a @ref{4b67,,Py_BEGIN_ALLOW_THREADS} sem a chave de abertura e declaração de variável.
@end deffn

@node Low-level API,,High-level API,Estado de thread e a trava global do interpretador
@anchor{c-api/init low-level-api}@anchor{51a0}
@subsubsection Low-level API


All of the following functions must be called after @ref{8b1,,Py_Initialize()}.


Alterado na versão 3.7: @ref{8b1,,Py_Initialize()} now initializes the @ref{159,,GIL}.


@geindex PyInterpreterState_New (C function)
@anchor{c-api/init c PyInterpreterState_New}@anchor{4400}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyInterpreterState_New ()
` Parte da @ref{553,,ABI Estável}.'
Create a new interpreter state object.  The global interpreter lock need not
be held, but may be held if it is necessary to serialize calls to this
function.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.PyInterpreterState_New} sem argumentos.
@end deffn

@geindex PyInterpreterState_Clear (C function)
@anchor{c-api/init c PyInterpreterState_Clear}@anchor{43ff}
@deffn {C Função} void PyInterpreterState_Clear (PyInterpreterState *interp)
` Parte da @ref{553,,ABI Estável}.'
Reset all information in an interpreter state object.  The global interpreter
lock must be held.

Levanta um @ref{19fa,,evento de auditoria} @code{cpython.PyInterpreterState_Clear} sem argumentos.
@end deffn

@geindex PyInterpreterState_Delete (C function)
@anchor{c-api/init c PyInterpreterState_Delete}@anchor{4cd4}
@deffn {C Função} void PyInterpreterState_Delete (PyInterpreterState *interp)
` Parte da @ref{553,,ABI Estável}.'
Destroy an interpreter state object.  The global interpreter lock need not be
held.  The interpreter state must have been reset with a previous call to
@ref{43ff,,PyInterpreterState_Clear()}.
@end deffn

@geindex PyThreadState_New (C function)
@anchor{c-api/init c PyThreadState_New}@anchor{4d62}
@deffn {C Função} @ref{78d,,PyThreadState} *PyThreadState_New (PyInterpreterState *interp)
` Parte da @ref{553,,ABI Estável}.'
Create a new thread state object belonging to the given interpreter object.
The global interpreter lock need not be held, but may be held if it is
necessary to serialize calls to this function.
@end deffn

@geindex PyThreadState_Clear (C function)
@anchor{c-api/init c PyThreadState_Clear}@anchor{170b}
@deffn {C Função} void PyThreadState_Clear (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Reset all information in a thread state object.  The global interpreter lock
must be held.


Alterado na versão 3.9: This function now calls the @code{PyThreadState.on_delete} callback.
Previously, that happened in @ref{1b18,,PyThreadState_Delete()}.



Alterado na versão 3.13: The @code{PyThreadState.on_delete} callback was removed.

@end deffn

@geindex PyThreadState_Delete (C function)
@anchor{c-api/init c PyThreadState_Delete}@anchor{1b18}
@deffn {C Função} void PyThreadState_Delete (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Destroy a thread state object.  The global interpreter lock need not be held.
The thread state must have been reset with a previous call to
@ref{170b,,PyThreadState_Clear()}.
@end deffn

@geindex PyThreadState_DeleteCurrent (C function)
@anchor{c-api/init c PyThreadState_DeleteCurrent}@anchor{1b4a}
@deffn {C Função} void PyThreadState_DeleteCurrent (void)

Destroy the current thread state and release the global interpreter lock.
Like @ref{1b18,,PyThreadState_Delete()}, the global interpreter lock must
be held. The thread state must have been reset with a previous call
to @ref{170b,,PyThreadState_Clear()}.
@end deffn

@geindex PyThreadState_GetFrame (C function)
@anchor{c-api/init c PyThreadState_GetFrame}@anchor{78e}
@deffn {C Função} @ref{789,,PyFrameObject} *PyThreadState_GetFrame (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Get the current frame of the Python thread state `tstate'.

Return a @ref{33d,,strong reference}. Return @code{NULL} if no frame is currently
executing.

See also @ref{18c1,,PyEval_GetFrame()}.

`tstate' must not be @code{NULL}.


Adicionado na versão 3.9.

@end deffn

@geindex PyThreadState_GetID (C function)
@anchor{c-api/init c PyThreadState_GetID}@anchor{979}
@deffn {C Função} uint64_t PyThreadState_GetID (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Get the unique thread state identifier of the Python thread state `tstate'.

`tstate' must not be @code{NULL}.


Adicionado na versão 3.9.

@end deffn

@geindex PyThreadState_GetInterpreter (C function)
@anchor{c-api/init c PyThreadState_GetInterpreter}@anchor{978}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyThreadState_GetInterpreter (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Get the interpreter of the Python thread state `tstate'.

`tstate' must not be @code{NULL}.


Adicionado na versão 3.9.

@end deffn

@geindex PyThreadState_EnterTracing (C function)
@anchor{c-api/init c PyThreadState_EnterTracing}@anchor{754}
@deffn {C Função} void PyThreadState_EnterTracing (PyThreadState *tstate)

Suspend tracing and profiling in the Python thread state `tstate'.

Resume them using the @ref{755,,PyThreadState_LeaveTracing()} function.


Adicionado na versão 3.11.

@end deffn

@geindex PyThreadState_LeaveTracing (C function)
@anchor{c-api/init c PyThreadState_LeaveTracing}@anchor{755}
@deffn {C Função} void PyThreadState_LeaveTracing (PyThreadState *tstate)

Resume tracing and profiling in the Python thread state `tstate' suspended
by the @ref{754,,PyThreadState_EnterTracing()} function.

See also @ref{421,,PyEval_SetTrace()} and @ref{1545,,PyEval_SetProfile()}
functions.


Adicionado na versão 3.11.

@end deffn

@geindex PyInterpreterState_Get (C function)
@anchor{c-api/init c PyInterpreterState_Get}@anchor{3ad}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyInterpreterState_Get (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Get the current interpreter.

Issue a fatal error if there no current Python thread state or no current
interpreter. It cannot return NULL.

The caller must hold the GIL.


Adicionado na versão 3.9.

@end deffn

@geindex PyInterpreterState_GetID (C function)
@anchor{c-api/init c PyInterpreterState_GetID}@anchor{bdf}
@deffn {C Função} int64_t PyInterpreterState_GetID (PyInterpreterState *interp)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return the interpreter’s unique ID.  If there was any error in doing
so then @code{-1} is returned and an error is set.

The caller must hold the GIL.


Adicionado na versão 3.7.

@end deffn

@geindex PyInterpreterState_GetDict (C function)
@anchor{c-api/init c PyInterpreterState_GetDict}@anchor{4cd5}
@deffn {C Função} @ref{339,,PyObject} *PyInterpreterState_GetDict (PyInterpreterState *interp)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
Return a dictionary in which interpreter-specific data may be stored.
If this function returns @code{NULL} then no exception has been raised and
the caller should assume no interpreter-specific dict is available.

This is not a replacement for @ref{987,,PyModule_GetState()}, which
extensions should use to store interpreter-specific state information.

The returned dictionary is borrowed from the interpreter and is valid until
interpreter shutdown.


Adicionado na versão 3.8.

@end deffn

@geindex PyUnstable_InterpreterState_GetMainModule (C function)
@anchor{c-api/init c PyUnstable_InterpreterState_GetMainModule}@anchor{51a1}
@deffn {C Função} @ref{339,,PyObject} *PyUnstable_InterpreterState_GetMainModule (PyInterpreterState *interp)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Return a @ref{33d,,strong reference} to the @code{__main__} @ref{50b3,,module object}
for the given interpreter.

The caller must hold the GIL.


Adicionado na versão 3.13.

@end deffn

@geindex _PyFrameEvalFunction (C type)
@anchor{c-api/init c _PyFrameEvalFunction}@anchor{776}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*_PyFrameEvalFunction)(@ref{78d,,PyThreadState} *tstate, @ref{510f,,_PyInterpreterFrame} *frame, int throwflag)

Type of a frame evaluation function.

The `throwflag' parameter is used by the @code{throw()} method of generators:
if non-zero, handle the current exception.


Alterado na versão 3.9: The function now takes a `tstate' parameter.



Alterado na versão 3.11: The `frame' parameter changed from @code{PyFrameObject*} to @code{_PyInterpreterFrame*}.

@end deffn

@geindex _PyInterpreterState_GetEvalFrameFunc (C function)
@anchor{c-api/init c _PyInterpreterState_GetEvalFrameFunc}@anchor{1b06}
@deffn {C Função} @ref{776,,_PyFrameEvalFunction} _PyInterpreterState_GetEvalFrameFunc (PyInterpreterState *interp)

Get the frame evaluation function.

See the 
@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} “Adding a frame evaluation API to CPython”.


Adicionado na versão 3.9.

@end deffn

@geindex _PyInterpreterState_SetEvalFrameFunc (C function)
@anchor{c-api/init c _PyInterpreterState_SetEvalFrameFunc}@anchor{1b07}
@deffn {C Função} void _PyInterpreterState_SetEvalFrameFunc (PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)

Set the frame evaluation function.

See the 
@geindex Propostas de Melhorias do Python; PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} “Adding a frame evaluation API to CPython”.


Adicionado na versão 3.9.

@end deffn

@geindex PyThreadState_GetDict (C function)
@anchor{c-api/init c PyThreadState_GetDict}@anchor{4d61}
@deffn {C Função} @ref{339,,PyObject} *PyThreadState_GetDict ()
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Return a dictionary in which extensions can store thread-specific state
information.  Each extension should use a unique key to use to store state in
the dictionary.  It is okay to call this function when no current thread state
is available. If this function returns @code{NULL}, no exception has been raised and
the caller should assume no current thread state is available.
@end deffn

@geindex PyThreadState_SetAsyncExc (C function)
@anchor{c-api/init c PyThreadState_SetAsyncExc}@anchor{bdd}
@deffn {C Função} int PyThreadState_SetAsyncExc (unsigned long id, PyObject *exc)
` Parte da @ref{553,,ABI Estável}.'
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.


Alterado na versão 3.7: The type of the `id' parameter changed from long to
unsigned long.

@end deffn

@geindex PyEval_AcquireThread (C function)
@anchor{c-api/init c PyEval_AcquireThread}@anchor{3aa}
@deffn {C Função} void PyEval_AcquireThread (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Acquire the global interpreter lock and set the current thread state to
`tstate', which must not be @code{NULL}.  The lock must have been created earlier.
If this thread already has the lock, deadlock ensues.

@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{5198,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


Alterado na versão 3.8: Updated to be consistent with @ref{3a9,,PyEval_RestoreThread()},
@ref{a98,,Py_END_ALLOW_THREADS()}, and @ref{3ab,,PyGILState_Ensure()},
and terminate the current thread if called while the interpreter is finalizing.



Alterado na versão 3.13.8: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.


@ref{3a9,,PyEval_RestoreThread()} is a higher-level function which is always
available (even when threads have not been initialized).
@end deffn

@geindex PyEval_ReleaseThread (C function)
@anchor{c-api/init c PyEval_ReleaseThread}@anchor{4c77}
@deffn {C Função} void PyEval_ReleaseThread (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
Reset the current thread state to @code{NULL} and release the global interpreter
lock.  The lock must have been created earlier and must be held by the current
thread.  The `tstate' argument, which must not be @code{NULL}, is only used to check
that it represents the current thread state — if it isn’t, a fatal error is
reported.

@ref{3a8,,PyEval_SaveThread()} is a higher-level function which is always
available (even when threads have not been initialized).
@end deffn

@node Sub-interpreter support,Notificações assíncronas,Estado de thread e a trava global do interpretador,Inicialização finalização e threads
@anchor{c-api/init id2}@anchor{51a2}@anchor{c-api/init sub-interpreter-support}@anchor{587}
@subsection Sub-interpreter support


While in most uses, you will only embed a single Python interpreter, there
are cases where you need to create several independent interpreters in the
same process and perhaps even in the same thread. Sub-interpreters allow
you to do that.

The “main” interpreter is the first one created when the runtime initializes.
It is usually the only Python interpreter in a process.  Unlike sub-interpreters,
the main interpreter has unique process-global responsibilities like signal
handling.  It is also responsible for execution during runtime initialization and
is usually the active interpreter during runtime finalization.  The
@ref{51a3,,PyInterpreterState_Main()} function returns a pointer to its state.

You can switch between sub-interpreters using the @ref{4d63,,PyThreadState_Swap()}
function. You can create and destroy them using the following functions:

@geindex PyInterpreterConfig (C type)
@anchor{c-api/init c PyInterpreterConfig}@anchor{56d}
@deffn {C Tipo} type PyInterpreterConfig

Structure containing most parameters to configure a sub-interpreter.
Its values are used only in @ref{45c,,Py_NewInterpreterFromConfig()} and
never modified by the runtime.


Adicionado na versão 3.12.


Campos de estrutura:

@geindex PyInterpreterConfig.use_main_obmalloc (C member)
@anchor{c-api/init c PyInterpreterConfig use_main_obmalloc}@anchor{45bc}
@deffn {C Membro} 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{51a4,,check_multi_interp_extensions}
must be @code{1} (non-zero).
If this is @code{1} then @ref{51a5,,gil}
must not be @ref{51a6,,PyInterpreterConfig_OWN_GIL}.
@end deffn

@geindex PyInterpreterConfig.allow_fork (C member)
@anchor{c-api/init c PyInterpreterConfig allow_fork}@anchor{51a7}
@deffn {C Membro} 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{51a8}
@deffn {C Membro} int allow_exec

If this is @code{0} then the runtime will not support replacing the
current process via exec (e.g. @ref{2cf9,,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{51a9}
@deffn {C Membro} 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{51aa}
@deffn {C Membro} 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{51a9,,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{51a4}
@deffn {C Membro} 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 Propostas de Melhorias do Python; PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) may be imported.
(Also see @ref{4de8,,Py_mod_multiple_interpreters}.)

This must be @code{1} (non-zero) if
@ref{45bc,,use_main_obmalloc} is @code{0}.
@end deffn

@geindex PyInterpreterConfig.gil (C member)
@anchor{c-api/init c PyInterpreterConfig gil}@anchor{51a5}
@deffn {C Membro} 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{51ab}
@deffn {C Macro} PyInterpreterConfig_DEFAULT_GIL

Use the default selection (@ref{51ac,,PyInterpreterConfig_SHARED_GIL}).
@end deffn

@geindex PyInterpreterConfig_SHARED_GIL (C macro)
@anchor{c-api/init c PyInterpreterConfig_SHARED_GIL}@anchor{51ac}
@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{51a6}
@deffn {C Macro} PyInterpreterConfig_OWN_GIL

Use the sub-interpreter’s own GIL.
@end deffn

If this is @ref{51a6,,PyInterpreterConfig_OWN_GIL} then
@ref{45bc,,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{45c}
@deffn {C Função} @ref{9b5,,PyStatus} Py_NewInterpreterFromConfig (PyThreadState **tstate_p, const PyInterpreterConfig *config)

@geindex módulo;builtins
@geindex módulo;__main__
@geindex módulo;sys
@geindex stdout (no módulo sys)
@geindex stderr (no módulo sys)
@geindex stdin (no módulo sys)

Create a new sub-interpreter.  This is an (almost) totally separate environment
for the execution of Python code.  In particular, the new interpreter has
separate, independent versions of all imported modules, including the
fundamental modules @ref{12,,builtins}, @ref{1,,__main__} and @ref{d9,,sys}.  The
table of loaded modules (@code{sys.modules}) and the module search path
(@code{sys.path}) are also separate.  The new environment has no @code{sys.argv}
variable.  It has new standard I/O stream file objects @code{sys.stdin},
@code{sys.stdout} and @code{sys.stderr} (however these refer to the same underlying
file descriptors).

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.


Adicionado na versão 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 = NULL;
PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config);
if (PyStatus_Exception(status)) @{
    Py_ExitStatusException(status);
@}
@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{8c2,,PyInterpreterState} values.  A read-only copy of the config
may be stored internally on the @ref{8c2,,PyInterpreterState}.

@geindex Py_FinalizeEx (função C)
@geindex Py_Initialize (função C)

Extension modules are shared between (sub-)interpreters as follows:


@itemize *

@item 
For modules using multi-phase initialization,
e.g. @ref{ee2,,PyModule_FromDefAndSpec()}, a separate module object is
created and initialized for each interpreter.
Only C-level static and global variables are shared between these
module objects.

@item 
For modules using single-phase initialization,
e.g. @ref{50b8,,PyModule_Create()}, the first time a particular extension
is imported, it is initialized normally, and a (shallow) copy of its
module’s dictionary is squirreled away.
When the same extension is imported by another (sub-)interpreter, a new
module is initialized and filled with the contents of this copy; the
extension’s @code{init} function is not called.
Objects in the module’s dictionary thus end up shared across
(sub-)interpreters, which might cause unwanted behavior (see
@ref{51ad,,Bugs and caveats} below).

Note that this is different from what happens when an extension is
imported after the interpreter has been completely re-initialized by
calling @ref{d37,,Py_FinalizeEx()} and @ref{8b1,,Py_Initialize()}; in that
case, the extension’s @code{initmodule} function `is' called again.
As with multi-phase initialization, this means that only C-level static
and global variables are shared between these modules.
@end itemize

@geindex close (in module os)
@end deffn

@geindex Py_NewInterpreter (C function)
@anchor{c-api/init c Py_NewInterpreter}@anchor{18b9}
@deffn {C Função} @ref{78d,,PyThreadState} *Py_NewInterpreter (void)
` Parte da @ref{553,,ABI Estável}.'
@geindex módulo;builtins
@geindex módulo;__main__
@geindex módulo;sys
@geindex stdout (no módulo sys)
@geindex stderr (no módulo sys)
@geindex stdin (no módulo sys)

Create a new sub-interpreter.  This is essentially just a wrapper
around @ref{45c,,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{1985}
@deffn {C Função} void Py_EndInterpreter (PyThreadState *tstate)
` Parte da @ref{553,,ABI Estável}.'
@geindex Py_FinalizeEx (função C)

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{d37,,Py_FinalizeEx()} will destroy all sub-interpreters that
haven’t been explicitly destroyed at that point.
@end deffn

@menu
* A Per-Interpreter GIL:: 
* Bugs and caveats:: 

@end menu

@node A Per-Interpreter GIL,Bugs and caveats,,Sub-interpreter support
@anchor{c-api/init a-per-interpreter-gil}@anchor{51ae}@anchor{c-api/init per-interpreter-gil}@anchor{519b}
@subsubsection A Per-Interpreter GIL


Using @ref{45c,,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 Propostas de Melhorias do Python; PEP 554
PEP 554@footnote{https://peps.python.org/pep-0554/} and 
@geindex Propostas de Melhorias do Python; PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}.)

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{45bb,,immortal}.
In fact, this has been done for the builtin singletons, small integers,
and a number of other builtin objects.

Se você preservar o isolamento, terá acesso à computação multi-core adequada, sem as complicações que acompanham o uso de threads livres. A falha em preservar o isolamento traz a exposição a todas as consequências de threads livres, incluindo corridas e travamentos difíceis de depurar.

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.


Adicionado na versão 3.12.


@node Bugs and caveats,,A Per-Interpreter GIL,Sub-interpreter support
@anchor{c-api/init bugs-and-caveats}@anchor{51ad}
@subsubsection Bugs and caveats


Because sub-interpreters (and the main interpreter) are part of the same
process, the insulation between them isn’t perfect — for example, using
low-level file operations like  @ref{b8a,,os.close()} they can
(accidentally or maliciously) affect each other’s open files.  Because of the
way extensions are shared between (sub-)interpreters, some extensions may not
work properly; this is especially likely when using single-phase initialization
or (static) global variables.
It is possible to insert objects created in one sub-interpreter into
a namespace of another (sub-)interpreter; this should be avoided if possible.

Special care should be taken to avoid sharing user-defined functions,
methods, instances or classes between sub-interpreters, since import
operations executed by such objects may affect the wrong (sub-)interpreter’s
dictionary of loaded modules. It is equally important to avoid sharing
objects from which the above are reachable.

Also note that combining this functionality with @code{PyGILState_*} APIs
is delicate, because these APIs assume a bijection between Python thread states
and OS-level threads, an assumption broken by the presence of sub-interpreters.
It is highly recommended that you don’t switch sub-interpreters between a pair
of matching @ref{3ab,,PyGILState_Ensure()} and @ref{3ac,,PyGILState_Release()} calls.
Furthermore, extensions (such as @ref{2a,,ctypes}) using these APIs to allow calling
of Python code from non-Python created threads will probably be broken when using
sub-interpreters.

@node Notificações assíncronas,Profiling and Tracing,Sub-interpreter support,Inicialização finalização e threads
@anchor{c-api/init asynchronous-notifications}@anchor{51af}
@subsection Notificações assíncronas


A mechanism is provided to make asynchronous notifications to the main
interpreter thread.  These notifications take the form of a function
pointer and a void pointer argument.

@geindex Py_AddPendingCall (C function)
@anchor{c-api/init c Py_AddPendingCall}@anchor{988}
@deffn {C Função} int Py_AddPendingCall (int (*func)(void*), void *arg)
` Parte da @ref{553,,ABI Estável}.'
Schedule a function to be called from the main interpreter thread.  On
success, @code{0} is returned and `func' is queued for being called in the
main thread.  On failure, @code{-1} is returned without setting any exception.

When successfully queued, `func' will be `eventually' called from the
main interpreter thread with the argument `arg'.  It will be called
asynchronously with respect to normally running Python code, but with
both these conditions met:


@itemize *

@item 
on a @ref{187,,bytecode} boundary;

@item 
with the main thread holding the @ref{148,,global interpreter lock}
(`func' can therefore use the full C API).
@end itemize

`func' must return @code{0} on success, or @code{-1} on failure with an exception
set.  `func' won’t be interrupted to perform another asynchronous
notification recursively, but it can still be interrupted to switch
threads if the global interpreter lock is released.

This function doesn’t need a current thread state to run, and it doesn’t
need the global interpreter lock.

To call this function in a subinterpreter, the caller must hold the GIL.
Otherwise, the function `func' can be scheduled to be called from the wrong
interpreter.

@cartouche
@quotation Aviso 
This is a low-level function, only useful for very special cases.
There is no guarantee that `func' will be called as quick as
possible.  If the main thread is busy executing a system call,
`func' won’t be called before the system call returns.  This
function is generally `not' suitable for calling Python code from
arbitrary C threads.  Instead, use the @ref{5195,,PyGILState API}.
@end quotation
@end cartouche


Adicionado na versão 3.1.



Alterado na versão 3.9: If this function is called in a subinterpreter, the function `func' 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.



Alterado na versão 3.12: This function now always schedules `func' to be run in the main
interpreter.

@end deffn

@geindex Py_MakePendingCalls (C function)
@anchor{c-api/init c Py_MakePendingCalls}@anchor{4dcb}
@deffn {C Função} int Py_MakePendingCalls (void)
` Parte da @ref{553,,ABI Estável}.'
Execute all pending calls. This is usually executed automatically by the
interpreter.

Esta função retorna @code{0} em caso de sucesso e retorna @code{-1} com uma exceção definida em caso de falha.

If this is not called in the main thread of the main
interpreter, this function does nothing and returns @code{0}.
The caller must hold the @ref{159,,GIL}.


Adicionado na versão 3.1.



Alterado na versão 3.12: This function only runs pending calls in the main interpreter.

@end deffn

@node Profiling and Tracing,Reference tracing,Notificações assíncronas,Inicialização finalização e threads
@anchor{c-api/init profiling}@anchor{51b0}@anchor{c-api/init profiling-and-tracing}@anchor{51b1}
@subsection Profiling and Tracing


The Python interpreter provides some low-level support for attaching profiling
and execution tracing facilities.  These are used for profiling, debugging, and
coverage analysis tools.

This C interface allows the profiling or tracing code to avoid the overhead of
calling through Python-level callable objects, making a direct C function call
instead.  The essential attributes of the facility have not changed; the
interface allows trace functions to be installed per-thread, and the basic
events reported to the trace function are the same as had been reported to the
Python-level trace functions in previous versions.

@geindex Py_tracefunc (C type)
@anchor{c-api/init c Py_tracefunc}@anchor{51b2}
@deffn {C Tipo} typedef int (*Py_tracefunc)(@ref{339,,PyObject} *obj, @ref{789,,PyFrameObject} *frame, int what, @ref{339,,PyObject} *arg)

The type of the trace function registered using @ref{1545,,PyEval_SetProfile()} and
@ref{421,,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{51b3,,PyTrace_CALL},
@ref{51b4,,PyTrace_EXCEPTION}, @ref{51b5,,PyTrace_LINE}, @ref{51b6,,PyTrace_RETURN},
@ref{51b7,,PyTrace_C_CALL}, @ref{51b8,,PyTrace_C_EXCEPTION}, @ref{51b9,,PyTrace_C_RETURN},
or @ref{51ba,,PyTrace_OPCODE}, and `arg' depends on the value of `what':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Value of `what'

@tab

Meaning of `arg'

@item

@ref{51b3,,PyTrace_CALL}

@tab

Always @ref{4b48,,Py_None}.

@item

@ref{51b4,,PyTrace_EXCEPTION}

@tab

Exception information as returned by
@ref{68a,,sys.exc_info()}.

@item

@ref{51b5,,PyTrace_LINE}

@tab

Always @ref{4b48,,Py_None}.

@item

@ref{51b6,,PyTrace_RETURN}

@tab

Value being returned to the caller,
or @code{NULL} if caused by an exception.

@item

@ref{51b7,,PyTrace_C_CALL}

@tab

Function object being called.

@item

@ref{51b8,,PyTrace_C_EXCEPTION}

@tab

Function object being called.

@item

@ref{51b9,,PyTrace_C_RETURN}

@tab

Function object being called.

@item

@ref{51ba,,PyTrace_OPCODE}

@tab

Always @ref{4b48,,Py_None}.

@end multitable

@end deffn

@geindex PyTrace_CALL (C var)
@anchor{c-api/init c PyTrace_CALL}@anchor{51b3}
@deffn {C Variável} int PyTrace_CALL

The value of the `what' parameter to a @ref{51b2,,Py_tracefunc} function when a new
call to a function or method is being reported, or a new entry into a generator.
Note that the creation of the iterator for a generator function is not reported
as there is no control transfer to the Python bytecode in the corresponding
frame.
@end deffn

@geindex PyTrace_EXCEPTION (C var)
@anchor{c-api/init c PyTrace_EXCEPTION}@anchor{51b4}
@deffn {C Variável} int PyTrace_EXCEPTION

The value of the `what' parameter to a @ref{51b2,,Py_tracefunc} function when an
exception has been raised.  The callback function is called with this value for
`what' when after any bytecode is processed after which the exception becomes
set within the frame being executed.  The effect of this is that as exception
propagation causes the Python stack to unwind, the callback is called upon
return to each frame as the exception propagates.  Only trace functions receives
these events; they are not needed by the profiler.
@end deffn

@geindex PyTrace_LINE (C var)
@anchor{c-api/init c PyTrace_LINE}@anchor{51b5}
@deffn {C Variável} int PyTrace_LINE

The value passed as the `what' parameter to a @ref{51b2,,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{bf6,,f_trace_lines} to
`0' on that frame.
@end deffn

@geindex PyTrace_RETURN (C var)
@anchor{c-api/init c PyTrace_RETURN}@anchor{51b6}
@deffn {C Variável} int PyTrace_RETURN

The value for the `what' parameter to @ref{51b2,,Py_tracefunc} functions when a
call is about to return.
@end deffn

@geindex PyTrace_C_CALL (C var)
@anchor{c-api/init c PyTrace_C_CALL}@anchor{51b7}
@deffn {C Variável} int PyTrace_C_CALL

The value for the `what' parameter to @ref{51b2,,Py_tracefunc} functions when a C
function is about to be called.
@end deffn

@geindex PyTrace_C_EXCEPTION (C var)
@anchor{c-api/init c PyTrace_C_EXCEPTION}@anchor{51b8}
@deffn {C Variável} int PyTrace_C_EXCEPTION

The value for the `what' parameter to @ref{51b2,,Py_tracefunc} functions when a C
function has raised an exception.
@end deffn

@geindex PyTrace_C_RETURN (C var)
@anchor{c-api/init c PyTrace_C_RETURN}@anchor{51b9}
@deffn {C Variável} int PyTrace_C_RETURN

The value for the `what' parameter to @ref{51b2,,Py_tracefunc} functions when a C
function has returned.
@end deffn

@geindex PyTrace_OPCODE (C var)
@anchor{c-api/init c PyTrace_OPCODE}@anchor{51ba}
@deffn {C Variável} int PyTrace_OPCODE

The value for the `what' parameter to @ref{51b2,,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{bf7,,f_trace_opcodes} to `1' on the frame.
@end deffn

@geindex PyEval_SetProfile (C function)
@anchor{c-api/init c PyEval_SetProfile}@anchor{1545}
@deffn {C Função} 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{51b5,,PyTrace_LINE}
@ref{51ba,,PyTrace_OPCODE} and @ref{51b4,,PyTrace_EXCEPTION}.

See also the @ref{1546,,sys.setprofile()} function.

The caller must hold the @ref{159,,GIL}.
@end deffn

@geindex PyEval_SetProfileAllThreads (C function)
@anchor{c-api/init c PyEval_SetProfileAllThreads}@anchor{55f}
@deffn {C Função} void PyEval_SetProfileAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{1545,,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.

The caller must hold the @ref{159,,GIL}.

As @ref{1545,,PyEval_SetProfile()}, this function ignores any exceptions raised while
setting the profile functions in all threads.
@end deffn


Adicionado na versão 3.12.


@geindex PyEval_SetTrace (C function)
@anchor{c-api/init c PyEval_SetTrace}@anchor{421}
@deffn {C Função} void PyEval_SetTrace (Py_tracefunc func, PyObject *obj)

Set the tracing function to `func'.  This is similar to
@ref{1545,,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{421,,PyEval_SetTrace()}
will not receive @ref{51b7,,PyTrace_C_CALL}, @ref{51b8,,PyTrace_C_EXCEPTION} or
@ref{51b9,,PyTrace_C_RETURN} as a value for the `what' parameter.

See also the @ref{1547,,sys.settrace()} function.

The caller must hold the @ref{159,,GIL}.
@end deffn

@geindex PyEval_SetTraceAllThreads (C function)
@anchor{c-api/init c PyEval_SetTraceAllThreads}@anchor{422}
@deffn {C Função} void PyEval_SetTraceAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{421,,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.

The caller must hold the @ref{159,,GIL}.

As @ref{421,,PyEval_SetTrace()}, this function ignores any exceptions raised while
setting the trace functions in all threads.
@end deffn


Adicionado na versão 3.12.


@node Reference tracing,Advanced Debugger Support,Profiling and Tracing,Inicialização finalização e threads
@anchor{c-api/init reference-tracing}@anchor{51bb}
@subsection Reference tracing



Adicionado na versão 3.13.


@geindex PyRefTracer (C type)
@anchor{c-api/init c PyRefTracer}@anchor{51bc}
@deffn {C Tipo} typedef int (*PyRefTracer)(@ref{339,,PyObject}*, int event, void *data)

The type of the trace function registered using @ref{36c,,PyRefTracer_SetTracer()}.
The first parameter is a Python object that has been just created (when `event'
is set to @ref{51bd,,PyRefTracer_CREATE}) or about to be destroyed (when `event'
is set to @ref{51be,,PyRefTracer_DESTROY}). The `data' argument is the opaque pointer
that was provided when @ref{36c,,PyRefTracer_SetTracer()} was called.
@end deffn


Adicionado na versão 3.13.


@geindex PyRefTracer_CREATE (C var)
@anchor{c-api/init c PyRefTracer_CREATE}@anchor{51bd}
@deffn {C Variável} int PyRefTracer_CREATE

The value for the `event' parameter to @ref{51bc,,PyRefTracer} functions when a Python
object has been created.
@end deffn

@geindex PyRefTracer_DESTROY (C var)
@anchor{c-api/init c PyRefTracer_DESTROY}@anchor{51be}
@deffn {C Variável} int PyRefTracer_DESTROY

The value for the `event' parameter to @ref{51bc,,PyRefTracer} functions when a Python
object has been destroyed.
@end deffn

@geindex PyRefTracer_SetTracer (C function)
@anchor{c-api/init c PyRefTracer_SetTracer}@anchor{36c}
@deffn {C Função} 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


Adicionado na versão 3.13.


@geindex PyRefTracer_GetTracer (C function)
@anchor{c-api/init c PyRefTracer_GetTracer}@anchor{36d}
@deffn {C Função} @ref{51bc,,PyRefTracer} PyRefTracer_GetTracer (void **data)

Get the registered reference tracer function and the value of the opaque data
pointer that was registered when @ref{36c,,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


Adicionado na versão 3.13.


@node Advanced Debugger Support,Thread Local Storage Support,Reference tracing,Inicialização finalização e threads
@anchor{c-api/init advanced-debugger-support}@anchor{51bf}@anchor{c-api/init advanced-debugging}@anchor{51c0}
@subsection Advanced Debugger Support


These functions are only intended to be used by advanced debugging tools.

@geindex PyInterpreterState_Head (C function)
@anchor{c-api/init c PyInterpreterState_Head}@anchor{1548}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyInterpreterState_Head ()

Return the interpreter state object at the head of the list of all such objects.
@end deffn

@geindex PyInterpreterState_Main (C function)
@anchor{c-api/init c PyInterpreterState_Main}@anchor{51a3}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyInterpreterState_Main ()

Return the main interpreter state object.
@end deffn

@geindex PyInterpreterState_Next (C function)
@anchor{c-api/init c PyInterpreterState_Next}@anchor{1549}
@deffn {C Função} @ref{8c2,,PyInterpreterState} *PyInterpreterState_Next (PyInterpreterState *interp)

Return the next interpreter state object after `interp' from the list of all
such objects.
@end deffn

@geindex PyInterpreterState_ThreadHead (C function)
@anchor{c-api/init c PyInterpreterState_ThreadHead}@anchor{154a}
@deffn {C Função} @ref{78d,,PyThreadState} *PyInterpreterState_ThreadHead (PyInterpreterState *interp)

Return the pointer to the first @ref{78d,,PyThreadState} object in the list of
threads associated with the interpreter `interp'.
@end deffn

@geindex PyThreadState_Next (C function)
@anchor{c-api/init c PyThreadState_Next}@anchor{154b}
@deffn {C Função} @ref{78d,,PyThreadState} *PyThreadState_Next (PyThreadState *tstate)

Return the next thread state object after `tstate' from the list of all such
objects belonging to the same @ref{8c2,,PyInterpreterState} object.
@end deffn

@node Thread Local Storage Support,Synchronization Primitives<2>,Advanced Debugger Support,Inicialização finalização e threads
@anchor{c-api/init thread-local-storage}@anchor{51c1}@anchor{c-api/init thread-local-storage-support}@anchor{51c2}
@subsection Thread Local Storage Support


The Python interpreter provides low-level support for thread-local storage
(TLS) which wraps the underlying native TLS implementation to support the
Python-level thread local storage API (@ref{1631,,threading.local}).  The
CPython C level APIs are similar to those offered by pthreads and Windows:
use a thread key and functions to associate a void* value per
thread.

The GIL does `not' need to be held when calling these functions; they supply
their own locking.

Note that @code{Python.h} does not include the declaration of the TLS APIs,
you need to include @code{pythread.h} to use thread-local storage.

@cartouche
@quotation Nota 
None of these API functions handle memory management on behalf of the
void* values.  You need to allocate and deallocate them yourself.
If the void* values happen to be @ref{339,,PyObject}*, these
functions don’t do refcount operations on them either.
@end quotation
@end cartouche

@menu
* Thread Specific Storage (TSS) API: Thread Specific Storage TSS API. 
* Thread Local Storage (TLS) API: Thread Local Storage TLS API. 

@end menu

@node Thread Specific Storage TSS API,Thread Local Storage TLS API,,Thread Local Storage Support
@anchor{c-api/init thread-specific-storage-api}@anchor{aee}@anchor{c-api/init thread-specific-storage-tss-api}@anchor{51c3}
@subsubsection Thread Specific Storage (TSS) API


TSS API is introduced to supersede the use of the existing TLS API within the
CPython interpreter.  This API uses a new type @ref{aef,,Py_tss_t} instead of
int to represent thread keys.


Adicionado na versão 3.7.



@subsubheading Ver também


“A New C-API for Thread-Local Storage in CPython” (
@geindex Propostas de Melhorias do Python; 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{aef}
@deffn {C Tipo} type Py_tss_t

This data structure represents the state of a thread key, the definition of
which may depend on the underlying TLS implementation, and it has an
internal field representing the key’s initialization state.  There are no
public members in this structure.

Quando @ref{553,,Py_LIMITED_API} não é definido, a alocação estática deste tipo por @ref{51c4,,Py_tss_NEEDS_INIT} é permitida.
@end deffn

@geindex Py_tss_NEEDS_INIT (C macro)
@anchor{c-api/init c Py_tss_NEEDS_INIT}@anchor{51c4}
@deffn {C Macro} Py_tss_NEEDS_INIT

This macro expands to the initializer for @ref{aef,,Py_tss_t} variables.
Note that this macro won’t be defined with @ref{553,,Py_LIMITED_API}.
@end deffn

@menu
* Alocação dinâmica:: 
* Métodos: Métodos<2>. 

@end menu

@node Alocação dinâmica,Métodos<2>,,Thread Specific Storage TSS API
@anchor{c-api/init dynamic-allocation}@anchor{51c5}
@subsubsection Alocação dinâmica


Dynamic allocation of the @ref{aef,,Py_tss_t}, required in extension modules
built with @ref{553,,Py_LIMITED_API}, where static allocation of this type
is not possible due to its implementation being opaque at build time.

@geindex PyThread_tss_alloc (C function)
@anchor{c-api/init c PyThread_tss_alloc}@anchor{405}
@deffn {C Função} @ref{aef,,Py_tss_t} *PyThread_tss_alloc ()
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Retorna um valor que é o mesmo estado de um valor inicializado com @ref{51c4,,Py_tss_NEEDS_INIT}, ou @code{NULL} no caso de falha de alocação dinâmica.
@end deffn

@geindex PyThread_tss_free (C function)
@anchor{c-api/init c PyThread_tss_free}@anchor{407}
@deffn {C Função} void PyThread_tss_free (Py_tss_t *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Free the given `key' allocated by @ref{405,,PyThread_tss_alloc()}, after
first calling @ref{40d,,PyThread_tss_delete()} to ensure any associated
thread locals have been unassigned. This is a no-op if the `key'
argument is @code{NULL}.

@cartouche
@quotation Nota 
A freed key becomes a dangling pointer. You should reset the key to
@code{NULL}.
@end quotation
@end cartouche
@end deffn

@node Métodos<2>,,Alocação dinâmica,Thread Specific Storage TSS API
@anchor{c-api/init methods}@anchor{51c6}
@subsubsection Métodos


The parameter `key' of these functions must not be @code{NULL}.  Moreover, the
behaviors of @ref{409,,PyThread_tss_set()} and @ref{40b,,PyThread_tss_get()} are
undefined if the given @ref{aef,,Py_tss_t} has not been initialized by
@ref{4d6f,,PyThread_tss_create()}.

@geindex PyThread_tss_is_created (C function)
@anchor{c-api/init c PyThread_tss_is_created}@anchor{4d70}
@deffn {C Função} int PyThread_tss_is_created (Py_tss_t *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return a non-zero value if the given @ref{aef,,Py_tss_t} has been initialized
by @ref{4d6f,,PyThread_tss_create()}.
@end deffn

@geindex PyThread_tss_create (C function)
@anchor{c-api/init c PyThread_tss_create}@anchor{4d6f}
@deffn {C Função} int PyThread_tss_create (Py_tss_t *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Retorna um valor zero na inicialização bem-sucedida de uma chave TSS. O comportamento é indefinido se o valor apontado pelo argumento `key' não for inicializado por @ref{51c4,,Py_tss_NEEDS_INIT}. Essa função pode ser chamada repetidamente na mesma tecla – chamá-la em uma tecla já inicializada não funciona e retorna imediatamente com sucesso.
@end deffn

@geindex PyThread_tss_delete (C function)
@anchor{c-api/init c PyThread_tss_delete}@anchor{40d}
@deffn {C Função} void PyThread_tss_delete (Py_tss_t *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Destroy a TSS key to forget the values associated with the key across all
threads, and change the key’s initialization state to uninitialized.  A
destroyed key is able to be initialized again by
@ref{4d6f,,PyThread_tss_create()}. This function can be called repeatedly on
the same key – calling it on an already destroyed key is a no-op.
@end deffn

@geindex PyThread_tss_set (C function)
@anchor{c-api/init c PyThread_tss_set}@anchor{409}
@deffn {C Função} int PyThread_tss_set (Py_tss_t *key, void *value)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return a zero value to indicate successfully associating a void*
value with a TSS key in the current thread.  Each thread has a distinct
mapping of the key to a void* value.
@end deffn

@geindex PyThread_tss_get (C function)
@anchor{c-api/init c PyThread_tss_get}@anchor{40b}
@deffn {C Função} void *PyThread_tss_get (Py_tss_t *key)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Return the void* value associated with a TSS key in the current
thread.  This returns @code{NULL} if no value is associated with the key in the
current thread.
@end deffn

@node Thread Local Storage TLS API,,Thread Specific Storage TSS API,Thread Local Storage Support
@anchor{c-api/init thread-local-storage-api}@anchor{aed}@anchor{c-api/init thread-local-storage-tls-api}@anchor{51c7}
@subsubsection Thread Local Storage (TLS) API



Descontinuado desde a versão 3.7: This API is superseded by
@ref{aee,,Thread Specific Storage (TSS) API}.


@cartouche
@quotation Nota 
This version of the API does not support platforms where the native TLS key
is defined in a way that cannot be safely cast to @code{int}.  On such platforms,
@ref{404,,PyThread_create_key()} will return immediately with a failure status,
and the other TLS functions will all be no-ops on such platforms.
@end quotation
@end cartouche

Due to the compatibility problem noted above, this version of the API should not
be used in new code.

@geindex PyThread_create_key (C function)
@anchor{c-api/init c PyThread_create_key}@anchor{404}
@deffn {C Função} int PyThread_create_key ()
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyThread_delete_key (C function)
@anchor{c-api/init c PyThread_delete_key}@anchor{406}
@deffn {C Função} void PyThread_delete_key (int key)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyThread_set_key_value (C function)
@anchor{c-api/init c PyThread_set_key_value}@anchor{408}
@deffn {C Função} int PyThread_set_key_value (int key, void *value)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyThread_get_key_value (C function)
@anchor{c-api/init c PyThread_get_key_value}@anchor{40a}
@deffn {C Função} void *PyThread_get_key_value (int key)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyThread_delete_key_value (C function)
@anchor{c-api/init c PyThread_delete_key_value}@anchor{40c}
@deffn {C Função} void PyThread_delete_key_value (int key)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex PyThread_ReInitTLS (C function)
@anchor{c-api/init c PyThread_ReInitTLS}@anchor{40e}
@deffn {C Função} void PyThread_ReInitTLS ()
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@node Synchronization Primitives<2>,Operating System Thread APIs,Thread Local Storage Support,Inicialização finalização e threads
@anchor{c-api/init synchronization-primitives}@anchor{51c8}
@subsection Synchronization Primitives


The C-API provides a basic mutual exclusion lock.

@geindex PyMutex (C type)
@anchor{c-api/init c PyMutex}@anchor{15b}
@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


Adicionado na versão 3.13.

@end deffn

@geindex PyMutex_Lock (C function)
@anchor{c-api/init c PyMutex_Lock}@anchor{32b}
@deffn {C Função} 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{159,,GIL} if it is held.


Adicionado na versão 3.13.

@end deffn

@geindex PyMutex_Unlock (C function)
@anchor{c-api/init c PyMutex_Unlock}@anchor{32c}
@deffn {C Função} void PyMutex_Unlock (PyMutex *m)

Unlock mutex `m'. The mutex must be locked — otherwise, the function will
issue a fatal error.


Adicionado na versão 3.13.

@end deffn

@menu
* Python Critical Section API:: 
* Legacy Locking APIs:: 

@end menu

@node Python Critical Section API,Legacy Locking APIs,,Synchronization Primitives<2>
@anchor{c-api/init id3}@anchor{51c9}@anchor{c-api/init python-critical-section-api}@anchor{51ca}
@subsubsection Python Critical Section API


The critical section API provides a deadlock avoidance layer on top of
per-object locks for @ref{15e4,,free-threaded} CPython.  They are
intended to replace reliance on the @ref{148,,global interpreter lock}, and are
no-ops in versions of Python with the global interpreter lock.

Critical sections are intended to be used for custom types implemented
in C-API extensions. They should generally not be used with built-in types like
@ref{611,,list} and @ref{256,,dict} because their public C-APIs
already use critical sections internally, with the notable
exception of @ref{16fd,,PyDict_Next()}, which requires critical section
to be acquired externally.

Critical sections avoid deadlocks by implicitly suspending active critical
sections, hence, they do not provide exclusive access such as provided by
traditional locks like @ref{15b,,PyMutex}.  When a critical section is started,
the per-object lock for the object is acquired. If the code executed inside the
critical section calls C-API functions then it can suspend the critical section thereby
releasing the per-object lock, so other threads can acquire the per-object lock
for the same object.

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{51cb,,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

Exemplo de uso:

@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{579,,Py_SETREF} calls @ref{56f,,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{3a8,,PyEval_SaveThread()}.

@geindex Py_BEGIN_CRITICAL_SECTION (C macro)
@anchor{c-api/init c Py_BEGIN_CRITICAL_SECTION}@anchor{5028}
@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{@{}.


Adicionado na versão 3.13.

@end deffn

@geindex Py_END_CRITICAL_SECTION (C macro)
@anchor{c-api/init c Py_END_CRITICAL_SECTION}@anchor{51cc}
@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{@}}.


Adicionado na versão 3.13.

@end deffn

@geindex Py_BEGIN_CRITICAL_SECTION2 (C macro)
@anchor{c-api/init c Py_BEGIN_CRITICAL_SECTION2}@anchor{51cb}
@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;
    PyCriticalSection2_Begin(&_py_cs2, (PyObject*)(a), (PyObject*)(b))
@end example

In the default build, this macro expands to @code{@{}.


Adicionado na versão 3.13.

@end deffn

@geindex Py_END_CRITICAL_SECTION2 (C macro)
@anchor{c-api/init c Py_END_CRITICAL_SECTION2}@anchor{51cd}
@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
    PyCriticalSection2_End(&_py_cs2);
@}
@end example

In the default build, this macro expands to @code{@}}.


Adicionado na versão 3.13.

@end deffn

@node Legacy Locking APIs,,Python Critical Section API,Synchronization Primitives<2>
@anchor{c-api/init legacy-locking-apis}@anchor{51ce}
@subsubsection Legacy Locking APIs


These APIs are obsolete since Python 3.13 with the introduction of
@ref{15b,,PyMutex}.


Alterado na versão 3.15: These APIs are now a simple wrapper around @code{PyMutex}.


@geindex PyThread_type_lock (C type)
@anchor{c-api/init c PyThread_type_lock}@anchor{51cf}
@deffn {C Tipo} type PyThread_type_lock

A pointer to a mutual exclusion lock.
@end deffn

@geindex PyLockStatus (C type)
@anchor{c-api/init c PyLockStatus}@anchor{51d0}
@deffn {C Tipo} type PyLockStatus

The result of acquiring a lock with a timeout.

@geindex PY_LOCK_FAILURE (C enumerator)
@anchor{c-api/init c PY_LOCK_FAILURE}@anchor{51d1}
@deffn {C Enumerador} enumerator PY_LOCK_FAILURE

Failed to acquire the lock.
@end deffn

@geindex PY_LOCK_ACQUIRED (C enumerator)
@anchor{c-api/init c PY_LOCK_ACQUIRED}@anchor{51d2}
@deffn {C Enumerador} enumerator PY_LOCK_ACQUIRED

The lock was successfully acquired.
@end deffn

@geindex PY_LOCK_INTR (C enumerator)
@anchor{c-api/init c PY_LOCK_INTR}@anchor{51d3}
@deffn {C Enumerador} enumerator PY_LOCK_INTR

The lock was interrupted by a signal.
@end deffn
@end deffn

@geindex PyThread_allocate_lock (C function)
@anchor{c-api/init c PyThread_allocate_lock}@anchor{4d67}
@deffn {C Função} @ref{51cf,,PyThread_type_lock} PyThread_allocate_lock (void)
` Parte da @ref{553,,ABI Estável}.'
Allocate a new lock.

On success, this function returns a lock; on failure, this
function returns @code{0} without an exception set.

The caller does not need to hold the @ref{159,,GIL}.


Alterado na versão 3.15: This function now always uses @ref{15b,,PyMutex}. In prior versions, this
would use a lock provided by the operating system.

@end deffn

@geindex PyThread_free_lock (C function)
@anchor{c-api/init c PyThread_free_lock}@anchor{4d69}
@deffn {C Função} void PyThread_free_lock (PyThread_type_lock lock)
` Parte da @ref{553,,ABI Estável}.'
Destroy `lock'. The lock should not be held by any thread when calling
this.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@geindex PyThread_acquire_lock_timed (C function)
@anchor{c-api/init c PyThread_acquire_lock_timed}@anchor{4d66}
@deffn {C Função} @ref{51d0,,PyLockStatus} PyThread_acquire_lock_timed (PyThread_type_lock lock, long long microseconds, int intr_flag)
` Parte da @ref{553,,ABI Estável}.'
Acquire `lock' with a timeout.

This will wait for `microseconds' microseconds to acquire the lock. If the
timeout expires, this function returns @ref{51d1,,PY_LOCK_FAILURE}.
If `microseconds' is @code{-1}, this will wait indefinitely until the lock has
been released.

If `intr_flag' is @code{1}, acquiring the lock may be interrupted by a signal,
in which case this function returns @ref{51d3,,PY_LOCK_INTR}. Upon
interruption, it’s generally expected that the caller makes a call to
@ref{4dcb,,Py_MakePendingCalls()} to propagate an exception to Python code.

If the lock is successfully acquired, this function returns
@ref{51d2,,PY_LOCK_ACQUIRED}.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@geindex PyThread_acquire_lock (C function)
@anchor{c-api/init c PyThread_acquire_lock}@anchor{4d65}
@deffn {C Função} int PyThread_acquire_lock (PyThread_type_lock lock, int waitflag)
` Parte da @ref{553,,ABI Estável}.'
Acquire `lock'.

If `waitflag' is @code{1} and another thread currently holds the lock, this
function will wait until the lock can be acquired and will always return
@code{1}.

If `waitflag' is @code{0} and another thread holds the lock, this function will
not wait and instead return @code{0}. If the lock is not held by any other
thread, then this function will acquire it and return @code{1}.

Unlike @ref{4d66,,PyThread_acquire_lock_timed()}, acquiring the lock cannot be
interrupted by a signal.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@geindex PyThread_release_lock (C function)
@anchor{c-api/init c PyThread_release_lock}@anchor{4d6d}
@deffn {C Função} int PyThread_release_lock (PyThread_type_lock lock)
` Parte da @ref{553,,ABI Estável}.'
Release `lock'. If `lock' is not held, then this function issues a
fatal error.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@node Operating System Thread APIs,,Synchronization Primitives<2>,Inicialização finalização e threads
@anchor{c-api/init operating-system-thread-apis}@anchor{51d4}
@subsection Operating System Thread APIs


@geindex PYTHREAD_INVALID_THREAD_ID (C macro)
@anchor{c-api/init c PYTHREAD_INVALID_THREAD_ID}@anchor{51d5}
@deffn {C Macro} PYTHREAD_INVALID_THREAD_ID

Sentinel value for an invalid thread ID.

This is currently equivalent to @code{(unsigned long)-1}.
@end deffn

@geindex PyThread_start_new_thread (C function)
@anchor{c-api/init c PyThread_start_new_thread}@anchor{1bc4}
@deffn {C Função} unsigned long PyThread_start_new_thread (void (*func)(void*), void *arg)
` Parte da @ref{553,,ABI Estável}.'
Start function `func' in a new thread with argument `arg'.
The resulting thread is not intended to be joined.

`func' must not be @code{NULL}, but `arg' may be @code{NULL}.

On success, this function returns the identifier of the new thread; on failure,
this returns @ref{51d5,,PYTHREAD_INVALID_THREAD_ID}.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@geindex PyThread_get_thread_ident (C function)
@anchor{c-api/init c PyThread_get_thread_ident}@anchor{4d6b}
@deffn {C Função} unsigned long PyThread_get_thread_ident (void)
` Parte da @ref{553,,ABI Estável}.'
Return the identifier of the current thread, which will never be zero.

This function cannot fail, and the caller does not need to hold the
@ref{159,,GIL}.


@subsubheading Ver também


@ref{1199,,threading.get_ident()}

@end deffn

@geindex PyThread_GetInfo (C function)
@anchor{c-api/init c PyThread_GetInfo}@anchor{4d64}
@deffn {C Função} @ref{339,,PyObject} *PyThread_GetInfo (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.3.'
Get general information about the current thread in the form of a
@ref{11ff,,struct sequence} object. This information is
accessible as @ref{118f,,sys.thread_info} in Python.

On success, this returns a new @ref{33d,,strong reference} to the thread
information; on failure, this returns @code{NULL} with an exception set.

The caller must hold the @ref{159,,GIL}.
@end deffn

@geindex PY_HAVE_THREAD_NATIVE_ID (C macro)
@anchor{c-api/init c PY_HAVE_THREAD_NATIVE_ID}@anchor{51d6}
@deffn {C Macro} PY_HAVE_THREAD_NATIVE_ID

This macro is defined when the system supports native thread IDs.
@end deffn

@geindex PyThread_get_thread_native_id (C function)
@anchor{c-api/init c PyThread_get_thread_native_id}@anchor{192d}
@deffn {C Função} unsigned long PyThread_get_thread_native_id (void)
` Parte da @ref{553,,ABI Estável} on platforms with native thread IDs.'
Get the native identifier of the current thread as it was assigned by the operating
system’s kernel, which will never be less than zero.

This function is only available when @ref{51d6,,PY_HAVE_THREAD_NATIVE_ID} is
defined.

This function cannot fail, and the caller does not need to hold the
@ref{159,,GIL}.


@subsubheading Ver também


@ref{a47,,threading.get_native_id()}

@end deffn

@geindex PyThread_exit_thread (C function)
@anchor{c-api/init c PyThread_exit_thread}@anchor{4d68}
@deffn {C Função} void PyThread_exit_thread (void)
` Parte da @ref{553,,ABI Estável}.'
Terminate the current thread. This function is generally considered unsafe
and should be avoided. It is kept solely for backwards compatibility.

This function is only safe to call if all functions in the full call
stack are written to safely allow it.

@cartouche
@quotation Aviso 
If the current system uses POSIX threads (also known as “pthreads”),
this calls @code{pthread_exit(3)@footnote{https://manpages.debian.org/pthread_exit(3)}}, which attempts to unwind the stack
and call C++ destructors on some libc implementations. However, if a
@code{noexcept} function is reached, it may terminate the process.
Other systems, such as macOS, do unwinding.

On Windows, this function calls @code{_endthreadex()}, which kills the thread
without calling C++ destructors.

In any case, there is a risk of corruption on the thread’s stack.
@end quotation
@end cartouche
@end deffn

@geindex PyThread_init_thread (C function)
@anchor{c-api/init c PyThread_init_thread}@anchor{4d6c}
@deffn {C Função} void PyThread_init_thread (void)
` Parte da @ref{553,,ABI Estável}.'
Initialize @code{PyThread*} APIs. Python executes this function automatically,
so there’s little need to call it from an extension module.
@end deffn

@geindex PyThread_set_stacksize (C function)
@anchor{c-api/init c PyThread_set_stacksize}@anchor{4d6e}
@deffn {C Função} int PyThread_set_stacksize (size_t size)
` Parte da @ref{553,,ABI Estável}.'
Set the stack size of the current thread to `size' bytes.

This function returns @code{0} on success, @code{-1} if `size' is invalid, or
@code{-2} if the system does not support changing the stack size. This function
does not set exceptions.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@geindex PyThread_get_stacksize (C function)
@anchor{c-api/init c PyThread_get_stacksize}@anchor{4d6a}
@deffn {C Função} size_t PyThread_get_stacksize (void)
` Parte da @ref{553,,ABI Estável}.'
Return the stack size of the current thread in bytes, or @code{0} if the system’s
default stack size is in use.

The caller does not need to hold the @ref{159,,GIL}.
@end deffn

@node Configuração de inicialização do Python,Gerenciamento de Memória,Inicialização finalização e threads,Manual de referência da API Python/C
@anchor{c-api/init_config doc}@anchor{51d7}@anchor{c-api/init_config init-config}@anchor{3a7}@anchor{c-api/init_config python-initialization-configuration}@anchor{51d8}@anchor{c-api/init_config translation-repo}@anchor{51d9}
@section Configuração de inicialização do Python



Adicionado na versão 3.8.


Python pode ser inicializado com @ref{3c5,,Py_InitializeFromConfig()} e a estrutura @ref{3a6,,PyConfig}. Pode ser pré-inicializado com @ref{3eb,,Py_PreInitialize()} e a estrutura @ref{9b4,,PyPreConfig}.

Existem dois tipos de configuração:


@itemize *

@item 
A @ref{5190,,Python Configuration} pode ser usada para construir um Python personalizado que se comporta como um Python comum. Por exemplo, variáveis de ambiente e argumento de linha de comando são usados para configurar Python.

@item 
A @ref{51da,,Configuração isolada} pode ser usada para incorporar Python em uma aplicação. Isso isola Python de um sistema. Por exemplo, variáveis de ambiente são ignoradas, a variável local LC_CTYPE fica inalterada e nenhum manipulador de sinal é registrado.
@end itemize

A função @ref{9cd,,Py_RunMain()} pode ser usada para escrever um programa Python personalizado.

Veja também @ref{5182,,Inicialização@comma{} Finalização e Threads}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} “Configuração da inicialização do Python”.


@menu
* Exemplo: Exemplo<17>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* Pré-inicializar Python com PyPreConfig:: 
* PyConfig:: 
* Initialization with PyConfig:: 
* Isolated Configuration:: 
* Configuração do Python:: 
* Python Path Configuration:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* Multi-Phase Initialization Private Provisional API:: 

@end menu

@node Exemplo<17>,PyWideStringList,,Configuração de inicialização do Python
@anchor{c-api/init_config example}@anchor{51db}
@subsection Exemplo


Exemplo de Python personalizado sendo executado sempre em um modo isolado:

@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,Exemplo<17>,Configuração de inicialização do Python
@anchor{c-api/init_config pywidestringlist}@anchor{51dc}
@subsection PyWideStringList


@geindex PyWideStringList (C type)
@anchor{c-api/init_config c PyWideStringList}@anchor{9b6}
@deffn {C Tipo} type PyWideStringList

Lista de strings @code{wchar_t*}.

Se `length' é diferente de zero, `items' deve ser diferente de @code{NULL} e todas as strings devem ser diferentes de @code{NULL}.

Métodos:

@geindex PyWideStringList_Append (C function)
@anchor{c-api/init_config c PyWideStringList_Append}@anchor{9c7}
@deffn {C Função} @ref{9b5,,PyStatus} PyWideStringList_Append (PyWideStringList *list, const wchar_t *item)

Anexa `item' a `list'.

Python deve ser inicializado previamente antes de chamar essa função.
@end deffn

@geindex PyWideStringList_Insert (C function)
@anchor{c-api/init_config c PyWideStringList_Insert}@anchor{9c8}
@deffn {C Função} @ref{9b5,,PyStatus} PyWideStringList_Insert (PyWideStringList *list, Py_ssize_t index, const wchar_t *item)

Insere `item' na `list' na posição `index'.

Se `index' for maior ou igual ao comprimento da `list', anexa o `item' a `list'.

`index' deve ser maior que ou igual a @code{0}.

Python deve ser inicializado previamente antes de chamar essa função.
@end deffn

Campos de estrutura:

@geindex PyWideStringList.length (C member)
@anchor{c-api/init_config c PyWideStringList length}@anchor{51dd}
@deffn {C Membro} @ref{a69,,Py_ssize_t} length

Comprimento da lista.
@end deffn

@geindex PyWideStringList.items (C member)
@anchor{c-api/init_config c PyWideStringList items}@anchor{51de}
@deffn {C Membro} wchar_t **items

Itens da lista.
@end deffn
@end deffn

@node PyStatus,PyPreConfig,PyWideStringList,Configuração de inicialização do Python
@anchor{c-api/init_config pystatus}@anchor{51df}
@subsection PyStatus


@geindex PyStatus (C type)
@anchor{c-api/init_config c PyStatus}@anchor{9b5}
@deffn {C Tipo} type PyStatus

Estrutura para armazenar o status de uma função de inicialização: sucesso, erro ou saída.

Para um erro, ela pode armazenar o nome da função C que criou o erro.

Campos de estrutura:

@geindex PyStatus.exitcode (C member)
@anchor{c-api/init_config c PyStatus exitcode}@anchor{51e0}
@deffn {C Membro} int exitcode

Código de saída. Argumento passado para @code{exit()}.
@end deffn

@geindex PyStatus.err_msg (C member)
@anchor{c-api/init_config c PyStatus err_msg}@anchor{51e1}
@deffn {C Membro} const char *err_msg

Mensagem de erro.
@end deffn

@geindex PyStatus.func (C member)
@anchor{c-api/init_config c PyStatus func}@anchor{51e2}
@deffn {C Membro} const char *func

Nome da função que criou um erro. Pode ser @code{NULL}.
@end deffn

Funções para criar um status:

@geindex PyStatus_Ok (C function)
@anchor{c-api/init_config c PyStatus_Ok}@anchor{9c6}
@deffn {C Função} @ref{9b5,,PyStatus} PyStatus_Ok (void)

Sucesso.
@end deffn

@geindex PyStatus_Error (C function)
@anchor{c-api/init_config c PyStatus_Error}@anchor{9c0}
@deffn {C Função} @ref{9b5,,PyStatus} PyStatus_Error (const char *err_msg)

Erro de inicialização com uma mensagem.

`err_msg' não deve ser @code{NULL}.
@end deffn

@geindex PyStatus_NoMemory (C function)
@anchor{c-api/init_config c PyStatus_NoMemory}@anchor{9c5}
@deffn {C Função} @ref{9b5,,PyStatus} PyStatus_NoMemory (void)

Falha de alocação de memória (sem memória).
@end deffn

@geindex PyStatus_Exit (C function)
@anchor{c-api/init_config c PyStatus_Exit}@anchor{9c2}
@deffn {C Função} @ref{9b5,,PyStatus} PyStatus_Exit (int exitcode)

Sai do Python com o código de saída especificado.
@end deffn

Funções para manipular um status:

@geindex PyStatus_Exception (C function)
@anchor{c-api/init_config c PyStatus_Exception}@anchor{9c1}
@deffn {C Função} int PyStatus_Exception (PyStatus status)

O status é um erro ou uma saída? Se verdadeiro, a exceção deve ser tratada; chamando @ref{9ca,,Py_ExitStatusException()}, por exemplo.
@end deffn

@geindex PyStatus_IsError (C function)
@anchor{c-api/init_config c PyStatus_IsError}@anchor{9c3}
@deffn {C Função} int PyStatus_IsError (PyStatus status)

O resultado é um erro?
@end deffn

@geindex PyStatus_IsExit (C function)
@anchor{c-api/init_config c PyStatus_IsExit}@anchor{9c4}
@deffn {C Função} int PyStatus_IsExit (PyStatus status)

O resultado é uma saída?
@end deffn

@geindex Py_ExitStatusException (C function)
@anchor{c-api/init_config c Py_ExitStatusException}@anchor{9ca}
@deffn {C Função} void Py_ExitStatusException (PyStatus status)

Chama @code{exit(exitcode)} se `status' for uma saída. Exibe a mensagem de erro e sai com um código de saída diferente de zero se `status' for um erro. Deve ser chamado apenas se @code{PyStatus_Exception(status)} for diferente de zero.
@end deffn
@end deffn

@cartouche
@quotation Nota 
Internamente, Python usa macros que definem @code{PyStatus.func}, enquanto funções para criar um status definem @code{func} para @code{NULL}.
@end quotation
@end cartouche

Exemplo:

@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,Pré-inicializar Python com PyPreConfig,PyStatus,Configuração de inicialização do Python
@anchor{c-api/init_config pypreconfig}@anchor{51e3}
@subsection PyPreConfig


@geindex PyPreConfig (C type)
@anchor{c-api/init_config c PyPreConfig}@anchor{9b4}
@deffn {C Tipo} type PyPreConfig

Estrutura usada para pré-inicializar o Python.

A função para inicializar uma pré-configuração:

@geindex PyPreConfig_InitPythonConfig (C function)
@anchor{c-api/init_config c PyPreConfig_InitPythonConfig}@anchor{9bf}
@deffn {C Função} void PyPreConfig_InitPythonConfig (PyPreConfig *preconfig)

Inicializa a pré-configuração com @ref{5190,,Configuração do Python}.
@end deffn

@geindex PyPreConfig_InitIsolatedConfig (C function)
@anchor{c-api/init_config c PyPreConfig_InitIsolatedConfig}@anchor{9be}
@deffn {C Função} void PyPreConfig_InitIsolatedConfig (PyPreConfig *preconfig)

Inicializa a pré-configuração com @ref{51da,,Configuração isolada}.
@end deffn

Campos de estrutura:

@geindex PyPreConfig.allocator (C member)
@anchor{c-api/init_config c PyPreConfig allocator}@anchor{51e4}
@deffn {C Membro} int allocator

Nome de alocadores de memória em Python:


@itemize *

@item 
@code{PYMEM_ALLOCATOR_NOT_SET} (@code{0}): não altera os alocadores de memória (usa o padrão).

@item 
@code{PYMEM_ALLOCATOR_DEFAULT} (@code{1}): @ref{1ed4,,alocadores de memória padrão}.

@item 
@code{PYMEM_ALLOCATOR_DEBUG} (@code{2}): @ref{1ed4,,alocadores de memória padrão} com @ref{1ed7,,ganchos de depuração}.

@item 
@code{PYMEM_ALLOCATOR_MALLOC} (@code{3}): usa @code{malloc()} da biblioteca C.

@item 
@code{PYMEM_ALLOCATOR_MALLOC_DEBUG} (@code{4}): força uso de @code{malloc()} com @ref{1ed7,,ganchos de depuração}.

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC} (@code{5}): @ref{d31,,alocador de memória do Python pymalloc}.

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} (@code{6}): @ref{d31,,alocador de memória deo Python pymalloc} com @ref{1ed7,,ganchos de depuração}.

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC} (@code{6}): usa @code{mimalloc}, um substituto rápido do malloc.

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} (@code{7}): use @code{mimalloc}, um substituto rápido do malloc com @ref{1ed7,,ganchos de depuração}.
@end itemize

@code{PYMEM_ALLOCATOR_PYMALLOC} e @code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} não são suportados se o Python estiver @ref{1f36,,configurado usando --without-pymalloc}.

@code{PYMEM_ALLOCATOR_MIMALLOC} e @code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} não são suportados se o Python estiver @ref{1f35,,configurado usando --without-mimalloc} ou se suporte atômico subjacente não estiver disponível.

Veja @ref{51e5,,Gerenciamento de memória}.

Padrão: @code{PYMEM_ALLOCATOR_NOT_SET}.
@end deffn

@geindex PyPreConfig.configure_locale (C member)
@anchor{c-api/init_config c PyPreConfig configure_locale}@anchor{51e6}
@deffn {C Membro} int configure_locale

Define a localidade LC_CTYPE para a localidade preferida do usuário.

Se igual a @code{0}, define os membros @ref{51e7,,coerce_c_locale} e @ref{51e8,,coerce_c_locale_warn} para @code{0}.

Veja a @ref{242,,codificação da localidade}.

Padrão: @code{1} na configuração do Python, @code{0} na configuração isolada.
@end deffn

@geindex PyPreConfig.coerce_c_locale (C member)
@anchor{c-api/init_config c PyPreConfig coerce_c_locale}@anchor{51e7}
@deffn {C Membro} int coerce_c_locale

Se igual a @code{2}, força a localidade para C.

Se for igual a @code{1}, lê a localidade LC_CTYPE para decidir se deve ser forçado.

Veja a @ref{242,,codificação da localidade}.

Padrão: @code{-1} na configuração do Python, @code{0} na configuração isolada.
@end deffn

@geindex PyPreConfig.coerce_c_locale_warn (C member)
@anchor{c-api/init_config c PyPreConfig coerce_c_locale_warn}@anchor{51e8}
@deffn {C Membro} int coerce_c_locale_warn

Se diferente de zero, emite um aviso se a localidade C for forçada.

Padrão: @code{-1} na configuração do Python, @code{0} na configuração isolada.
@end deffn

@geindex PyPreConfig.dev_mode (C member)
@anchor{c-api/init_config c PyPreConfig dev_mode}@anchor{51e9}
@deffn {C Membro} int dev_mode

@ref{1f8,,Modo de desenvolvimento do Python}: veja @ref{51ea,,PyConfig.dev_mode}.

Padrão: @code{-1} no modo do Python, @code{0} no modo isolado.
@end deffn

@geindex PyPreConfig.isolated (C member)
@anchor{c-api/init_config c PyPreConfig isolated}@anchor{51eb}
@deffn {C Membro} int isolated

Modo isolado: veja @ref{3e4,,PyConfig.isolated}.

Padrão: @code{0} no modo do Python, @code{1} no modo isolado.
@end deffn

@geindex PyPreConfig.legacy_windows_fs_encoding (C member)
@anchor{c-api/init_config c PyPreConfig legacy_windows_fs_encoding}@anchor{3e6}
@deffn {C Membro} int legacy_windows_fs_encoding

Se não zero:


@itemize *

@item 
Define @ref{3ea,,PyPreConfig.utf8_mode} para @code{0},

@item 
Define @ref{3e8,,PyConfig.filesystem_encoding} para @code{"mbcs"},

@item 
Define @ref{3e9,,PyConfig.filesystem_errors} para @code{"replace"}.
@end itemize

Initialized from the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING} environment
variable value.

Disponível apenas no Windows. A macro @code{#ifdef MS_WINDOWS} pode ser usada para código específico do Windows.

Padrão: @code{0}.
@end deffn

@geindex PyPreConfig.parse_argv (C member)
@anchor{c-api/init_config c PyPreConfig parse_argv}@anchor{51ec}
@deffn {C Membro} int parse_argv

Se diferente de zero, @ref{9cb,,Py_PreInitializeFromArgs()} e @ref{9cc,,Py_PreInitializeFromBytesArgs()} analisam seu argumento @code{argv} da mesma forma que o Python regular analisa argumentos de linha de comando: veja @ref{103d,,Argumentos de linha de comando}.

Padrão: @code{1} na configuração do Python, @code{0} na configuração isolada.
@end deffn

@geindex PyPreConfig.use_environment (C member)
@anchor{c-api/init_config c PyPreConfig use_environment}@anchor{51ed}
@deffn {C Membro} int use_environment

Usar @ref{5f1,,variáveis de ambiente}? Veja @ref{3d9,,PyConfig.use_environment}.

Padrão: @code{1} na configuração do Python e @code{0} na configuração isolada.
@end deffn

@geindex PyPreConfig.utf8_mode (C member)
@anchor{c-api/init_config c PyPreConfig utf8_mode}@anchor{3ea}
@deffn {C Membro} int utf8_mode

Se não zero, habilita o @ref{656,,modo UTF-8 do Python}.

Define para @code{0} ou @code{1} pela opção de linha de comando @ref{176,,-X utf8} e a variável de ambiente 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8}.

Também define como @code{1} se a localidade @code{LC_CTYPE} for @code{C} ou @code{POSIX}.

Padrão: @code{-1} na configuração do Python e @code{0} na configuração isolada.
@end deffn
@end deffn

@node Pré-inicializar Python com PyPreConfig,PyConfig,PyPreConfig,Configuração de inicialização do Python
@anchor{c-api/init_config c-preinit}@anchor{3f80}@anchor{c-api/init_config preinitialize-python-with-pypreconfig}@anchor{51ee}
@subsection Pré-inicializar Python com PyPreConfig


A pré-inicialização do Python:


@itemize *

@item 
Define os alocadores de memória Python (@ref{51e4,,PyPreConfig.allocator})

@item 
Configura a localidade LC_CTYPE (@ref{242,,codificação da localidade})

@item 
Define o @ref{656,,Modo UTF-8 do Python} (@ref{3ea,,PyPreConfig.utf8_mode})
@end itemize

A pré-configuração atual (tipo @code{PyPreConfig}) é armazenada em @code{_PyRuntime.preconfig}.

Funções para pré-inicializar Python:

@geindex Py_PreInitialize (C function)
@anchor{c-api/init_config c Py_PreInitialize}@anchor{3eb}
@deffn {C Função} @ref{9b5,,PyStatus} Py_PreInitialize (const PyPreConfig *preconfig)

Pré-inicializa o Python a partir da pré-configuração `preconfig'.

`preconfig' não pode ser @code{NULL}..
@end deffn

@geindex Py_PreInitializeFromBytesArgs (C function)
@anchor{c-api/init_config c Py_PreInitializeFromBytesArgs}@anchor{9cc}
@deffn {C Função} @ref{9b5,,PyStatus} Py_PreInitializeFromBytesArgs (const PyPreConfig *preconfig, int argc, char *const *argv)

Pré-inicializa o Python a partir da pré-configuração `preconfig'.

Analisa argumentos de linha de comando `argv' (strings de bytes) se @ref{51ec,,parse_argv} de `preconfig' for diferente de zero.

`preconfig' não pode ser @code{NULL}..
@end deffn

@geindex Py_PreInitializeFromArgs (C function)
@anchor{c-api/init_config c Py_PreInitializeFromArgs}@anchor{9cb}
@deffn {C Função} @ref{9b5,,PyStatus} Py_PreInitializeFromArgs (const PyPreConfig *preconfig, int argc, wchar_t *const *argv)

Pré-inicializa o Python a partir da pré-configuração `preconfig'.

Analisa argumentos de linha de comando `argv' (strings largas) se @ref{51ec,,parse_argv} de `preconfig' for diferente de zero.

`preconfig' não pode ser @code{NULL}..
@end deffn

O chamador é responsável por manipular exceções (erro ou saída) usando @ref{9c1,,PyStatus_Exception()} e @ref{9ca,,Py_ExitStatusException()}.

Para @ref{5190,,configuração do Python} (@ref{9bf,,PyPreConfig_InitPythonConfig()}), se o Python for inicializado com argumentos de linha de comando, os argumentos de linha de comando também devem ser passados para pré-inicializar o Python, pois eles têm um efeito na pré-configuração como codificações. Por exemplo, a opção de linha de comando @ref{176,,-X utf8} habilita o @ref{656,,Modo UTF-8 do Python}.

@code{PyMem_SetAllocator()} pode ser chamado depois de @ref{3eb,,Py_PreInitialize()} e antes de @ref{3c5,,Py_InitializeFromConfig()} para instalar um alocador de memória personalizado. Ele pode ser chamado antes de @ref{3eb,,Py_PreInitialize()} se @ref{51e4,,PyPreConfig.allocator} estiver definido como @code{PYMEM_ALLOCATOR_NOT_SET}.

Funções de alocação de memória do Python como @ref{390,,PyMem_RawMalloc()} não devem ser usadas antes da pré-inicialização do Python, enquanto chamar diretamente @code{malloc()} e @code{free()} é sempre seguro. @ref{be0,,Py_DecodeLocale()} não deve ser chamado antes da pré-inicialização do Python.

Exemplo usando a pré-inicialização para habilitar o @ref{656,,modo UTF-8 do Python}.

@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,Initialization with PyConfig,Pré-inicializar Python com PyPreConfig,Configuração de inicialização do Python
@anchor{c-api/init_config pyconfig}@anchor{51ef}
@subsection PyConfig


@geindex PyConfig (C type)
@anchor{c-api/init_config c PyConfig}@anchor{3a6}
@deffn {C Tipo} type PyConfig

Estrutura contendo a maioria dos parâmetros para configurar o Python.

Ao terminar, a função @ref{9b7,,PyConfig_Clear()} deve ser usada para liberar a memória de configuração.

Structure methods:

@geindex PyConfig_InitPythonConfig (C function)
@anchor{c-api/init_config c PyConfig_InitPythonConfig}@anchor{9b9}
@deffn {C Função} void PyConfig_InitPythonConfig (PyConfig *config)

Initialize configuration with the @ref{5190,,Python Configuration}.
@end deffn

@geindex PyConfig_InitIsolatedConfig (C function)
@anchor{c-api/init_config c PyConfig_InitIsolatedConfig}@anchor{9b8}
@deffn {C Função} void PyConfig_InitIsolatedConfig (PyConfig *config)

Initialize configuration with the @ref{51da,,Isolated Configuration}.
@end deffn

@geindex PyConfig_SetString (C function)
@anchor{c-api/init_config c PyConfig_SetString}@anchor{9bd}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_SetString (PyConfig *config, wchar_t *const *config_str, const wchar_t *str)

Copy the wide character string `str' into @code{*config_str}.

@ref{3f80,,Preinitialize Python} if needed.
@end deffn

@geindex PyConfig_SetBytesString (C function)
@anchor{c-api/init_config c PyConfig_SetBytesString}@anchor{9bc}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_SetBytesString (PyConfig *config, wchar_t *const *config_str, const char *str)

Decode `str' using @ref{be0,,Py_DecodeLocale()} and set the result into
@code{*config_str}.

@ref{3f80,,Preinitialize Python} if needed.
@end deffn

@geindex PyConfig_SetArgv (C function)
@anchor{c-api/init_config c PyConfig_SetArgv}@anchor{9ba}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_SetArgv (PyConfig *config, int argc, wchar_t *const *argv)

Set command line arguments (@ref{3c3,,argv} member of
`config') from the `argv' list of wide character strings.

@ref{3f80,,Preinitialize Python} if needed.
@end deffn

@geindex PyConfig_SetBytesArgv (C function)
@anchor{c-api/init_config c PyConfig_SetBytesArgv}@anchor{9bb}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_SetBytesArgv (PyConfig *config, int argc, char *const *argv)

Set command line arguments (@ref{3c3,,argv} member of
`config') from the `argv' list of bytes strings. Decode bytes using
@ref{be0,,Py_DecodeLocale()}.

@ref{3f80,,Preinitialize Python} if needed.
@end deffn

@geindex PyConfig_SetWideStringList (C function)
@anchor{c-api/init_config c PyConfig_SetWideStringList}@anchor{1b5c}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_SetWideStringList (PyConfig *config, PyWideStringList *list, Py_ssize_t length, wchar_t **items)

Set the list of wide strings `list' to `length' and `items'.

@ref{3f80,,Preinitialize Python} if needed.
@end deffn

@geindex PyConfig_Read (C function)
@anchor{c-api/init_config c PyConfig_Read}@anchor{790}
@deffn {C Função} @ref{9b5,,PyStatus} PyConfig_Read (PyConfig *config)

Lê toda a configuração do Python.

Campos que já estão inicializados permanecem inalterados.

Fields for @ref{8b2,,path configuration} are no longer
calculated or modified when calling this function, as of Python 3.11.

The @ref{790,,PyConfig_Read()} function only parses
@ref{3c3,,PyConfig.argv} arguments once: @ref{1a7e,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
stripped from @ref{3c3,,PyConfig.argv}, parsing arguments twice would
parse the application options as Python options.

@ref{3f80,,Preinitialize Python} if needed.


Alterado na versão 3.10: The @ref{3c3,,PyConfig.argv} arguments are now only parsed once,
@ref{1a7e,,PyConfig.parse_argv} is set to @code{2} after arguments are
parsed, and arguments are only parsed if
@ref{1a7e,,PyConfig.parse_argv} equals @code{1}.



Alterado na versão 3.11: @ref{790,,PyConfig_Read()} no longer calculates all paths, and so fields
listed under @ref{8b2,,Python Path Configuration} may
no longer be updated until @ref{3c5,,Py_InitializeFromConfig()} is
called.

@end deffn

@geindex PyConfig_Clear (C function)
@anchor{c-api/init_config c PyConfig_Clear}@anchor{9b7}
@deffn {C Função} void PyConfig_Clear (PyConfig *config)

Libera memória de configuração.
@end deffn

Most @code{PyConfig} methods @ref{3f80,,preinitialize Python} if needed.
In that case, the Python preinitialization configuration
(@ref{9b4,,PyPreConfig}) in based on the @ref{3a6,,PyConfig}. If configuration
fields which are in common with @ref{9b4,,PyPreConfig} are tuned, they must
be set before calling a @ref{3a6,,PyConfig} method:


@itemize *

@item 
@ref{51ea,,PyConfig.dev_mode}

@item 
@ref{3e4,,PyConfig.isolated}

@item 
@ref{1a7e,,PyConfig.parse_argv}

@item 
@ref{3d9,,PyConfig.use_environment}
@end itemize

Moreover, if @ref{9ba,,PyConfig_SetArgv()} or @ref{9bb,,PyConfig_SetBytesArgv()}
is used, this method must be called before other methods, since the
preinitialization configuration depends on command line arguments (if
@ref{1a7e,,parse_argv} is non-zero).

The caller of these methods is responsible to handle exceptions (error or
exit) using @code{PyStatus_Exception()} and @code{Py_ExitStatusException()}.

Campos de estrutura:

@geindex PyConfig.argv (C member)
@anchor{c-api/init_config c PyConfig argv}@anchor{3c3}
@deffn {C Membro} @ref{9b6,,PyWideStringList} argv

@geindex main()
@geindex argv (in module sys)

Set @ref{12a6,,sys.argv} command line arguments based on
@ref{3c3,,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{3c3,,argv} can be an
empty string.

Set @ref{1a7e,,parse_argv} to @code{1} to parse
@ref{3c3,,argv} the same way the regular Python parses Python
command line arguments and then to strip Python arguments from
@ref{3c3,,argv}.

If @ref{3c3,,argv} is empty, an empty string is added to
ensure that @ref{12a6,,sys.argv} always exists and is never empty.

Padrão: @code{NULL}.

See also the @ref{898,,orig_argv} member.
@end deffn

@geindex PyConfig.safe_path (C member)
@anchor{c-api/init_config c PyConfig safe_path}@anchor{773}
@deffn {C Membro} int safe_path

If equals to zero, @code{Py_RunMain()} prepends a potentially unsafe path to
@ref{3b4,,sys.path} at startup:


@itemize *

@item 
If @ref{3c3,,argv[0]} is equal to @code{L"-m"}
(@code{python -m module}), prepend the current working directory.

@item 
If running a script (@code{python script.py}), prepend the script’s
directory.  If it’s a symbolic link, resolve symbolic links.

@item 
Otherwise (@code{python -c code} and @code{python}), prepend an empty string,
which means the current working directory.
@end itemize

Set to @code{1} by the @ref{5a4,,-P} command line option and the
@geindex PYTHONSAFEPATH
@geindex variável de ambiente; PYTHONSAFEPATH
@ref{5a5,,PYTHONSAFEPATH} environment variable.

Default: @code{0} in Python config, @code{1} in isolated config.


Adicionado na versão 3.11.

@end deffn

@geindex PyConfig.base_exec_prefix (C member)
@anchor{c-api/init_config c PyConfig base_exec_prefix}@anchor{51f0}
@deffn {C Membro} wchar_t *base_exec_prefix

@ref{3ee,,sys.base_exec_prefix}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

Veja também @ref{51f1,,PyConfig.exec_prefix}.
@end deffn

@geindex PyConfig.base_executable (C member)
@anchor{c-api/init_config c PyConfig base_executable}@anchor{51f2}
@deffn {C Membro} wchar_t *base_executable

Python base executable: @code{sys._base_executable}.

Set by the 
@geindex __PYVENV_LAUNCHER__
@geindex variável de ambiente; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__} environment variable.

Set from @ref{3a5,,PyConfig.executable} if @code{NULL}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

See also @ref{3a5,,PyConfig.executable}.
@end deffn

@geindex PyConfig.base_prefix (C member)
@anchor{c-api/init_config c PyConfig base_prefix}@anchor{51f3}
@deffn {C Membro} wchar_t *base_prefix

@ref{3ef,,sys.base_prefix}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

See also @ref{51f4,,PyConfig.prefix}.
@end deffn

@geindex PyConfig.buffered_stdio (C member)
@anchor{c-api/init_config c PyConfig buffered_stdio}@anchor{3df}
@deffn {C Membro} int buffered_stdio

If equals to @code{0} and @ref{51f5,,configure_c_stdio} is non-zero,
disable buffering on the C streams stdout and stderr.

Set to @code{0} by the @ref{1b1c,,-u} command line option and the
@geindex PYTHONUNBUFFERED
@geindex variável de ambiente; PYTHONUNBUFFERED
@ref{1b1d,,PYTHONUNBUFFERED} environment variable.

stdin is always opened in buffered mode.

Padrão: @code{1}.
@end deffn

@geindex PyConfig.bytes_warning (C member)
@anchor{c-api/init_config c PyConfig bytes_warning}@anchor{3d5}
@deffn {C Membro} int bytes_warning

If equals to @code{1}, issue a warning when comparing @ref{1c2,,bytes} or
@ref{2ea,,bytearray} with @ref{44c,,str}, or comparing @ref{1c2,,bytes} with
@ref{257,,int}.

If equal or greater to @code{2}, raise a @ref{c3d,,BytesWarning} exception in these
cases.

Incremented by the @ref{5e3,,-b} command line option.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.warn_default_encoding (C member)
@anchor{c-api/init_config c PyConfig warn_default_encoding}@anchor{51f6}
@deffn {C Membro} int warn_default_encoding

If non-zero, emit a @ref{1ec5,,EncodingWarning} warning when @ref{7bc,,io.TextIOWrapper}
uses its default encoding. See @ref{1ed9,,Ativar EncodingWarning} for details.

Padrão: @code{0}.


Adicionado na versão 3.10.

@end deffn

@geindex PyConfig.code_debug_ranges (C member)
@anchor{c-api/init_config c PyConfig code_debug_ranges}@anchor{51f7}
@deffn {C Membro} 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 variável de ambiente; PYTHONNODEBUGRANGES
@ref{5b6,,PYTHONNODEBUGRANGES} environment variable
and by the @ref{176,,-X no_debug_ranges} command line option.

Padrão: @code{1}.


Adicionado na versão 3.11.

@end deffn

@geindex PyConfig.check_hash_pycs_mode (C member)
@anchor{c-api/init_config c PyConfig check_hash_pycs_mode}@anchor{51f8}
@deffn {C Membro} wchar_t *check_hash_pycs_mode

Control the validation behavior of hash-based @code{.pyc} files:
value of the @ref{1eba,,--check-hash-based-pycs} command line option.

Valores válidos:


@itemize -

@item 
@code{L"always"}: Hash the source file for invalidation regardless of
value of the ‘check_source’ flag.

@item 
@code{L"never"}: Assume that hash-based pycs always are valid.

@item 
@code{L"default"}: The ‘check_source’ flag in hash-based pycs
determines invalidation.
@end itemize

Default: @code{L"default"}.

See also 
@geindex Propostas de Melhorias do Python; PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} “Deterministic pycs”.
@end deffn

@geindex PyConfig.configure_c_stdio (C member)
@anchor{c-api/init_config c PyConfig configure_c_stdio}@anchor{51f5}
@deffn {C Membro} int configure_c_stdio

If non-zero, configure C standard streams:


@itemize *

@item 
On Windows, set the binary mode (@code{O_BINARY}) on stdin, stdout and
stderr.

@item 
If @ref{3df,,buffered_stdio} equals zero, disable buffering
of stdin, stdout and stderr streams.

@item 
If @ref{3cd,,interactive} is non-zero, enable stream
buffering on stdin and stdout (only stdout on Windows).
@end itemize

Padrão: @code{1} na configuração do Python, @code{0} na configuração isolada.
@end deffn

@geindex PyConfig.dev_mode (C member)
@anchor{c-api/init_config c PyConfig dev_mode}@anchor{51ea}
@deffn {C Membro} int dev_mode

If non-zero, enable the @ref{1f8,,Python Development Mode}.

Set to @code{1} by the @ref{176,,-X dev} option and the
@geindex PYTHONDEVMODE
@geindex variável de ambiente; PYTHONDEVMODE
@ref{b00,,PYTHONDEVMODE} environment variable.

Padrão: @code{-1} no modo do Python, @code{0} no modo isolado.
@end deffn

@geindex PyConfig.dump_refs (C member)
@anchor{c-api/init_config c PyConfig dump_refs}@anchor{51f9}
@deffn {C Membro} int dump_refs

Dump Python references?

If non-zero, dump all objects which are still alive at exit.

Set to @code{1} by the 
@geindex PYTHONDUMPREFS
@geindex variável de ambiente; PYTHONDUMPREFS
@ref{9ae,,PYTHONDUMPREFS} environment variable.

Needs a special build of Python with the @code{Py_TRACE_REFS} macro defined:
see the @ref{395,,configure --with-trace-refs option}.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.exec_prefix (C member)
@anchor{c-api/init_config c PyConfig exec_prefix}@anchor{51f1}
@deffn {C Membro} wchar_t *exec_prefix

The site-specific directory prefix where the platform-dependent Python
files are installed: @ref{3b2,,sys.exec_prefix}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

See also @ref{51f0,,PyConfig.base_exec_prefix}.
@end deffn

@geindex PyConfig.executable (C member)
@anchor{c-api/init_config c PyConfig executable}@anchor{3a5}
@deffn {C Membro} wchar_t *executable

The absolute path of the executable binary for the Python interpreter:
@ref{3b8,,sys.executable}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

See also @ref{51f2,,PyConfig.base_executable}.
@end deffn

@geindex PyConfig.faulthandler (C member)
@anchor{c-api/init_config c PyConfig faulthandler}@anchor{51fa}
@deffn {C Membro} int faulthandler

Enable faulthandler?

If non-zero, call @ref{cbe,,faulthandler.enable()} at startup.

Set to @code{1} by @ref{176,,-X faulthandler} and the
@geindex PYTHONFAULTHANDLER
@geindex variável de ambiente; PYTHONFAULTHANDLER
@ref{10be,,PYTHONFAULTHANDLER} environment variable.

Padrão: @code{-1} no modo do Python, @code{0} no modo isolado.
@end deffn

@geindex PyConfig.filesystem_encoding (C member)
@anchor{c-api/init_config c PyConfig filesystem_encoding}@anchor{3e8}
@deffn {C Membro} wchar_t *filesystem_encoding

@ref{53b,,Filesystem encoding}:
@ref{c74,,sys.getfilesystemencoding()}.

On macOS, Android and VxWorks: use @code{"utf-8"} by default.

On Windows: use @code{"utf-8"} by default, or @code{"mbcs"} if
@ref{3e6,,legacy_windows_fs_encoding} of
@ref{9b4,,PyPreConfig} is non-zero.

Default encoding on other platforms:


@itemize *

@item 
@code{"utf-8"} if @ref{3ea,,PyPreConfig.utf8_mode} is non-zero.

@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"} if @code{nl_langinfo(CODESET)} returns an empty string.

@item 
Otherwise, use the @ref{242,,locale encoding}:
@code{nl_langinfo(CODESET)} result.
@end itemize

At Python startup, the encoding name is normalized to the Python codec
name. For example, @code{"ANSI_X3.4-1968"} is replaced with @code{"ascii"}.

See also the @ref{3e9,,filesystem_errors} member.
@end deffn

@geindex PyConfig.filesystem_errors (C member)
@anchor{c-api/init_config c PyConfig filesystem_errors}@anchor{3e9}
@deffn {C Membro} wchar_t *filesystem_errors

@ref{53b,,Filesystem error handler}:
@ref{d07,,sys.getfilesystemencodeerrors()}.

On Windows: use @code{"surrogatepass"} by default, or @code{"replace"}  if
@ref{3e6,,legacy_windows_fs_encoding} of
@ref{9b4,,PyPreConfig} is non-zero.

On other platforms: use @code{"surrogateescape"} by default.

Supported error handlers:


@itemize *

@item 
@code{"strict"}

@item 
@code{"surrogateescape"}

@item 
@code{"surrogatepass"} (only supported with the UTF-8 encoding)
@end itemize

See also the @ref{3e8,,filesystem_encoding} member.
@end deffn

@geindex PyConfig.hash_seed (C member)
@anchor{c-api/init_config c PyConfig hash_seed}@anchor{3e2}
@deffn {C Membro} unsigned long hash_seed
@end deffn

@geindex PyConfig.use_hash_seed (C member)
@anchor{c-api/init_config c PyConfig use_hash_seed}@anchor{3e1}
@deffn {C Membro} int use_hash_seed

Randomized hash function seed.

If @ref{3e1,,use_hash_seed} is zero, a seed is chosen randomly
at Python startup, and @ref{3e2,,hash_seed} is ignored.

Set by the 
@geindex PYTHONHASHSEED
@geindex variável de ambiente; PYTHONHASHSEED
@ref{10b6,,PYTHONHASHSEED} environment variable.

Default `use_hash_seed' value: @code{-1} in Python mode, @code{0} in isolated
mode.
@end deffn

@geindex PyConfig.home (C member)
@anchor{c-api/init_config c PyConfig home}@anchor{3bb}
@deffn {C Membro} wchar_t *home

Set the default Python “home” directory, that is, the location of the
standard Python libraries (see 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}).

Set by the 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME} environment variable.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} input.
@end deffn

@geindex PyConfig.import_time (C member)
@anchor{c-api/init_config c PyConfig import_time}@anchor{51fb}
@deffn {C Membro} int import_time

If non-zero, profile import time.

Set the @code{1} by the @ref{176,,-X importtime} option and the
@geindex PYTHONPROFILEIMPORTTIME
@geindex variável de ambiente; PYTHONPROFILEIMPORTTIME
@ref{b08,,PYTHONPROFILEIMPORTTIME} environment variable.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.inspect (C member)
@anchor{c-api/init_config c PyConfig inspect}@anchor{3cf}
@deffn {C Membro} int inspect

Enter interactive mode after executing a script or a command.

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{53d,,sys.stdin} does not appear to
be a terminal.

Incremented by the @ref{1523,,-i} command line option. Set to @code{1} if the
@geindex PYTHONINSPECT
@geindex variável de ambiente; PYTHONINSPECT
@ref{1522,,PYTHONINSPECT} environment variable is non-empty.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.install_signal_handlers (C member)
@anchor{c-api/init_config c PyConfig install_signal_handlers}@anchor{8c3}
@deffn {C Membro} int install_signal_handlers

Install Python signal handlers?

Default: @code{1} in Python mode, @code{0} in isolated mode.
@end deffn

@geindex PyConfig.interactive (C member)
@anchor{c-api/init_config c PyConfig interactive}@anchor{3cd}
@deffn {C Membro} int interactive

If greater than @code{0}, enable the interactive mode (REPL).

Incremented by the @ref{1523,,-i} command line option.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.int_max_str_digits (C member)
@anchor{c-api/init_config c PyConfig int_max_str_digits}@anchor{51fc}
@deffn {C Membro} int int_max_str_digits

Configures the @ref{5f5,,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{2411,,sys.int_info.default_max_str_digits}).  A value of @code{0}
disables the limitation.  Values greater than zero but less than 640
(@ref{45ca,,sys.int_info.str_digits_check_threshold}) are unsupported and
will produce an error.

Configured by the @ref{176,,-X int_max_str_digits} command line
flag or the 
@geindex PYTHONINTMAXSTRDIGITS
@geindex variável de ambiente; PYTHONINTMAXSTRDIGITS
@ref{18c2,,PYTHONINTMAXSTRDIGITS} environment variable.

Default: @code{-1} in Python mode.  4300
(@ref{2411,,sys.int_info.default_max_str_digits}) in isolated mode.


Adicionado na versão 3.12.

@end deffn

@geindex PyConfig.cpu_count (C member)
@anchor{c-api/init_config c PyConfig cpu_count}@anchor{51fd}
@deffn {C Membro} int cpu_count

If the value of @ref{51fd,,cpu_count} is not @code{-1} then it will
override the return values of @ref{1c5,,os.cpu_count()},
@ref{1c4,,os.process_cpu_count()}, and @ref{fa3,,multiprocessing.cpu_count()}.

Configured by the @code{-X cpu_count=@var{n|default}} command line
flag or the 
@geindex PYTHON_CPU_COUNT
@geindex variável de ambiente; PYTHON_CPU_COUNT
@ref{210,,PYTHON_CPU_COUNT} environment variable.

Default: @code{-1}.


Adicionado na versão 3.13.

@end deffn

@geindex PyConfig.isolated (C member)
@anchor{c-api/init_config c PyConfig isolated}@anchor{3e4}
@deffn {C Membro} int isolated

If greater than @code{0}, enable isolated mode:


@itemize *

@item 
Set @ref{773,,safe_path} to @code{1}:
don’t prepend a potentially unsafe path to @ref{3b4,,sys.path} at Python
startup, such as the current directory, the script’s directory or an
empty string.

@item 
Set @ref{3d9,,use_environment} to @code{0}: ignore @code{PYTHON}
environment variables.

@item 
Set @ref{3dd,,user_site_directory} to @code{0}: don’t add the user
site directory to @ref{3b4,,sys.path}.

@item 
Python REPL doesn’t import @ref{ba,,readline} nor enable default readline
configuration on interactive prompts.
@end itemize

Set to @code{1} by the @ref{965,,-I} command line option.

Padrão: @code{0} no modo do Python, @code{1} no modo isolado.

See also the @ref{51da,,Isolated Configuration} and
@ref{51eb,,PyPreConfig.isolated}.
@end deffn

@geindex PyConfig.legacy_windows_stdio (C member)
@anchor{c-api/init_config c PyConfig legacy_windows_stdio}@anchor{3a4}
@deffn {C Membro} int legacy_windows_stdio

If non-zero, use @ref{1354,,io.FileIO} instead of
@code{io._WindowsConsoleIO} for @ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout}
and @ref{940,,sys.stderr}.

Definida como @code{1} se a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex variável de ambiente; PYTHONLEGACYWINDOWSSTDIO
@ref{c76,,PYTHONLEGACYWINDOWSSTDIO} estiver definida como uma string não vazia.

Disponível apenas no Windows. A macro @code{#ifdef MS_WINDOWS} pode ser usada para código específico do Windows.

Padrão: @code{0}.

See also the 
@geindex Propostas de Melhorias do Python; PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} (Change Windows console encoding to UTF-8).
@end deffn

@geindex PyConfig.malloc_stats (C member)
@anchor{c-api/init_config c PyConfig malloc_stats}@anchor{51fe}
@deffn {C Membro} int malloc_stats

If non-zero, dump statistics on @ref{d31,,Python pymalloc memory allocator} at exit.

Set to @code{1} by the 
@geindex PYTHONMALLOCSTATS
@geindex variável de ambiente; PYTHONMALLOCSTATS
@ref{1cd0,,PYTHONMALLOCSTATS} environment variable.

The option is ignored if Python is @ref{1f36,,configured using the --without-pymalloc option}.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.platlibdir (C member)
@anchor{c-api/init_config c PyConfig platlibdir}@anchor{1aae}
@deffn {C Membro} wchar_t *platlibdir

Platform library directory name: @ref{93f,,sys.platlibdir}.

Set by the 
@geindex PYTHONPLATLIBDIR
@geindex variável de ambiente; PYTHONPLATLIBDIR
@ref{1ab0,,PYTHONPLATLIBDIR} environment variable.

Default: value of the @code{PLATLIBDIR} macro which is set by the
@ref{1efe,,configure --with-platlibdir option}
(default: @code{"lib"}, or @code{"DLLs"} on Windows).

Part of the @ref{8b2,,Python Path Configuration} input.


Adicionado na versão 3.9.



Alterado na versão 3.11: This macro is now used on Windows to locate the standard
library extension modules, typically under @code{DLLs}. However,
for compatibility, note that this value is ignored for any
non-standard layouts, including in-tree builds and virtual
environments.

@end deffn

@geindex PyConfig.pythonpath_env (C member)
@anchor{c-api/init_config c PyConfig pythonpath_env}@anchor{51ff}
@deffn {C Membro} wchar_t *pythonpath_env

Module search paths (@ref{3b4,,sys.path}) as a string separated by @code{DELIM}
(@ref{1ecc,,os.pathsep}).

Set by the 
@geindex PYTHONPATH
@geindex variável de ambiente; PYTHONPATH
@ref{1053,,PYTHONPATH} environment variable.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} input.
@end deffn

@geindex PyConfig.module_search_paths (C member)
@anchor{c-api/init_config c PyConfig module_search_paths}@anchor{3a2}
@deffn {C Membro} @ref{9b6,,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{5ef}
@deffn {C Membro} int module_search_paths_set

Module search paths: @ref{3b4,,sys.path}.

If @ref{5ef,,module_search_paths_set} is equal to @code{0},
@ref{3c5,,Py_InitializeFromConfig()} will replace
@ref{3a2,,module_search_paths} and sets
@ref{5ef,,module_search_paths_set} to @code{1}.

Default: empty list (@code{module_search_paths}) and @code{0}
(@code{module_search_paths_set}).

Part of the @ref{8b2,,Python Path Configuration} output.
@end deffn

@geindex PyConfig.optimization_level (C member)
@anchor{c-api/init_config c PyConfig optimization_level}@anchor{3d1}
@deffn {C Membro} int optimization_level

Compilation optimization level:


@itemize *

@item 
@code{0}: Peephole optimizer, set @code{__debug__} to @code{True}.

@item 
@code{1}: Level 0, remove assertions, set @code{__debug__} to @code{False}.

@item 
@code{2}: Level 1, strip docstrings.
@end itemize

Incremented by the @ref{ddd,,-O} command line option. Set to the
@geindex PYTHONOPTIMIZE
@geindex variável de ambiente; PYTHONOPTIMIZE
@ref{1ebd,,PYTHONOPTIMIZE} environment variable value.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.orig_argv (C member)
@anchor{c-api/init_config c PyConfig orig_argv}@anchor{898}
@deffn {C Membro} @ref{9b6,,PyWideStringList} orig_argv

The list of the original command line arguments passed to the Python
executable: @ref{843,,sys.orig_argv}.

If @ref{898,,orig_argv} list is empty and
@ref{3c3,,argv} is not a list only containing an empty
string, @ref{790,,PyConfig_Read()} copies @ref{3c3,,argv} into
@ref{898,,orig_argv} before modifying
@ref{3c3,,argv} (if @ref{1a7e,,parse_argv} is
non-zero).

See also the @ref{3c3,,argv} member and the
@ref{1ace,,Py_GetArgcArgv()} function.

Padrão: lista vazia.


Adicionado na versão 3.10.

@end deffn

@geindex PyConfig.parse_argv (C member)
@anchor{c-api/init_config c PyConfig parse_argv}@anchor{1a7e}
@deffn {C Membro} int parse_argv

Parse command line arguments?

If equals to @code{1}, parse @ref{3c3,,argv} the same way the regular
Python parses @ref{103d,,command line arguments}, and strip
Python arguments from @ref{3c3,,argv}.

The @ref{790,,PyConfig_Read()} function only parses
@ref{3c3,,PyConfig.argv} arguments once: @ref{1a7e,,PyConfig.parse_argv}
is set to @code{2} after arguments are parsed. Since Python arguments are
stripped from @ref{3c3,,PyConfig.argv}, parsing arguments twice would
parse the application options as Python options.

Default: @code{1} in Python mode, @code{0} in isolated mode.


Alterado na versão 3.10: The @ref{3c3,,PyConfig.argv} arguments are now only parsed if
@ref{1a7e,,PyConfig.parse_argv} equals to @code{1}.

@end deffn

@geindex PyConfig.parser_debug (C member)
@anchor{c-api/init_config c PyConfig parser_debug}@anchor{3c7}
@deffn {C Membro} int parser_debug

Parser debug mode. If greater than @code{0}, turn on parser debugging output (for expert only, depending
on compilation options).

Incremented by the @ref{1ebb,,-d} command line option. Set to the
@geindex PYTHONDEBUG
@geindex variável de ambiente; PYTHONDEBUG
@ref{1ebc,,PYTHONDEBUG} environment variable value.

Needs a @ref{1f9,,debug build of Python} (the @code{Py_DEBUG} macro
must be defined).

Padrão: @code{0}.
@end deffn

@geindex PyConfig.pathconfig_warnings (C member)
@anchor{c-api/init_config c PyConfig pathconfig_warnings}@anchor{3d7}
@deffn {C Membro} 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.

Default: @code{1} in Python mode, @code{0} in isolated mode.

Part of the @ref{8b2,,Python Path Configuration} input.


Alterado na versão 3.11: Now also applies on Windows.

@end deffn

@geindex PyConfig.prefix (C member)
@anchor{c-api/init_config c PyConfig prefix}@anchor{51f4}
@deffn {C Membro} wchar_t *prefix

The site-specific directory prefix where the platform independent Python
files are installed: @ref{3b6,,sys.prefix}.

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} output.

See also @ref{51f3,,PyConfig.base_prefix}.
@end deffn

@geindex PyConfig.program_name (C member)
@anchor{c-api/init_config c PyConfig program_name}@anchor{3c4}
@deffn {C Membro} wchar_t *program_name

Program name used to initialize @ref{3a5,,executable} and in
early error messages during Python initialization.


@itemize *

@item 
On macOS, use 
@geindex PYTHONEXECUTABLE
@geindex variável de ambiente; PYTHONEXECUTABLE
@ref{1ed1,,PYTHONEXECUTABLE} environment variable if set.

@item 
If the @code{WITH_NEXT_FRAMEWORK} macro is defined, use
@geindex __PYVENV_LAUNCHER__
@geindex variável de ambiente; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__} environment variable if set.

@item 
Use @code{argv[0]} of @ref{3c3,,argv} if available and
non-empty.

@item 
Otherwise, use @code{L"python"} on Windows, or @code{L"python3"} on other
platforms.
@end itemize

Padrão: @code{NULL}.

Part of the @ref{8b2,,Python Path Configuration} input.
@end deffn

@geindex PyConfig.pycache_prefix (C member)
@anchor{c-api/init_config c PyConfig pycache_prefix}@anchor{5200}
@deffn {C Membro} wchar_t *pycache_prefix

Directory where cached @code{.pyc} files are written:
@ref{9ac,,sys.pycache_prefix}.

Set by the @ref{176,,-X pycache_prefix=PATH} command line option and
the 
@geindex PYTHONPYCACHEPREFIX
@geindex variável de ambiente; PYTHONPYCACHEPREFIX
@ref{9ab,,PYTHONPYCACHEPREFIX} environment variable.
The command-line option takes precedence.

If @code{NULL}, @ref{9ac,,sys.pycache_prefix} is set to @code{None}.

Padrão: @code{NULL}.
@end deffn

@geindex PyConfig.quiet (C member)
@anchor{c-api/init_config c PyConfig quiet}@anchor{3cb}
@deffn {C Membro} int quiet

Quiet mode. If greater than @code{0}, don’t display the copyright and version at
Python startup in interactive mode.

Incremented by the @ref{15a5,,-q} command line option.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.run_command (C member)
@anchor{c-api/init_config c PyConfig run_command}@anchor{518d}
@deffn {C Membro} wchar_t *run_command

Value of the @ref{5e0,,-c} command line option.

Used by @ref{9cd,,Py_RunMain()}.

Padrão: @code{NULL}.
@end deffn

@geindex PyConfig.run_filename (C member)
@anchor{c-api/init_config c PyConfig run_filename}@anchor{518e}
@deffn {C Membro} wchar_t *run_filename

Filename passed on the command line: trailing command line argument
without @ref{5e0,,-c} or @ref{5e1,,-m}. It is used by the
@ref{9cd,,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{5201,,PyConfig.skip_source_first_line} option.

Padrão: @code{NULL}.
@end deffn

@geindex PyConfig.run_module (C member)
@anchor{c-api/init_config c PyConfig run_module}@anchor{518f}
@deffn {C Membro} wchar_t *run_module

Value of the @ref{5e1,,-m} command line option.

Used by @ref{9cd,,Py_RunMain()}.

Padrão: @code{NULL}.
@end deffn

@geindex PyConfig.run_presite (C member)
@anchor{c-api/init_config c PyConfig run_presite}@anchor{5202}
@deffn {C Membro} wchar_t *run_presite

@code{package.module} path to module that should be imported before
@code{site.py} is run.

Set by the @ref{176,,-X presite=package.module} command-line
option and the 
@geindex PYTHON_PRESITE
@geindex variável de ambiente; PYTHON_PRESITE
@ref{1ec6,,PYTHON_PRESITE} environment variable.
The command-line option takes precedence.

Needs a @ref{1f9,,debug build of Python} (the @code{Py_DEBUG} macro
must be defined).

Padrão: @code{NULL}.
@end deffn

@geindex PyConfig.show_ref_count (C member)
@anchor{c-api/init_config c PyConfig show_ref_count}@anchor{5203}
@deffn {C Membro} int show_ref_count

Show total reference count at exit (excluding @ref{45bb,,immortal} objects)?

Set to @code{1} by @ref{176,,-X showrefcount} command line option.

Needs a @ref{1f9,,debug build of Python} (the @code{Py_REF_DEBUG}
macro must be defined).

Padrão: @code{0}.
@end deffn

@geindex PyConfig.site_import (C member)
@anchor{c-api/init_config c PyConfig site_import}@anchor{3d3}
@deffn {C Membro} int site_import

Import the @ref{c7,,site} module at startup?

If equal to zero, disable the import of the module site and the
site-dependent manipulations of @ref{3b4,,sys.path} that it entails.

Also disable these manipulations if the @ref{c7,,site} module is explicitly
imported later (call @ref{1ebe,,site.main()} if you want them to be triggered).

Set to @code{0} by the @ref{11e7,,-S} command line option.

@ref{68c,,sys.flags.no_site} is set to the inverted value of
@ref{3d3,,site_import}.

Padrão: @code{1}.
@end deffn

@geindex PyConfig.skip_source_first_line (C member)
@anchor{c-api/init_config c PyConfig skip_source_first_line}@anchor{5201}
@deffn {C Membro} int skip_source_first_line

If non-zero, skip the first line of the @ref{518e,,PyConfig.run_filename}
source.

It allows the usage of non-Unix forms of @code{#!cmd}. This is intended for
a DOS specific hack only.

Set to @code{1} by the @ref{1ec2,,-x} command line option.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.stdio_encoding (C member)
@anchor{c-api/init_config c PyConfig stdio_encoding}@anchor{3a3}
@deffn {C Membro} wchar_t *stdio_encoding
@end deffn

@geindex PyConfig.stdio_errors (C member)
@anchor{c-api/init_config c PyConfig stdio_errors}@anchor{45cc}
@deffn {C Membro} wchar_t *stdio_errors

Encoding and encoding errors of @ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout} and
@ref{940,,sys.stderr} (but @ref{940,,sys.stderr} always uses
@code{"backslashreplace"} error handler).

Use the 
@geindex PYTHONIOENCODING
@geindex variável de ambiente; PYTHONIOENCODING
@ref{1040,,PYTHONIOENCODING} environment variable if it is
non-empty.

Codificação padrão:


@itemize *

@item 
@code{"UTF-8"} if @ref{3ea,,PyPreConfig.utf8_mode} is non-zero.

@item 
Otherwise, use the @ref{242,,locale encoding}.
@end itemize

Tratador de erros padrão:


@itemize *

@item 
On Windows: use @code{"surrogateescape"}.

@item 
@code{"surrogateescape"} if @ref{3ea,,PyPreConfig.utf8_mode} is non-zero,
or if the LC_CTYPE locale is “C” or “POSIX”.

@item 
@code{"strict"} otherwise.
@end itemize

See also @ref{3a4,,PyConfig.legacy_windows_stdio}.
@end deffn

@geindex PyConfig.tracemalloc (C member)
@anchor{c-api/init_config c PyConfig tracemalloc}@anchor{5204}
@deffn {C Membro} int tracemalloc

Enable tracemalloc?

If non-zero, call @ref{1ec3,,tracemalloc.start()} at startup.

Set by @ref{176,,-X tracemalloc=N} command line option and by the
@geindex PYTHONTRACEMALLOC
@geindex variável de ambiente; PYTHONTRACEMALLOC
@ref{1ec4,,PYTHONTRACEMALLOC} environment variable.

Padrão: @code{-1} no modo do Python, @code{0} no modo isolado.
@end deffn

@geindex PyConfig.perf_profiling (C member)
@anchor{c-api/init_config c PyConfig perf_profiling}@anchor{5205}
@deffn {C Membro} int perf_profiling

Enable compatibility mode with the perf profiler?

If non-zero, initialize the perf trampoline. See @ref{18f,,Suporte do Python ao perfilador perf do Linux}
for more information.

Set by @ref{176,,-X perf} command-line option and by the
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@ref{190,,PYTHON_PERF_JIT_SUPPORT} environment variable for perf support
with stack pointers and @ref{176,,-X perf_jit} command-line option
and by the 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@ref{190,,PYTHON_PERF_JIT_SUPPORT} environment variable for perf
support with DWARF JIT information.

Default: @code{-1}.


Adicionado na versão 3.12.

@end deffn

@geindex PyConfig.use_environment (C member)
@anchor{c-api/init_config c PyConfig use_environment}@anchor{3d9}
@deffn {C Membro} int use_environment

Use @ref{5f1,,environment variables}?

If equals to zero, ignore the @ref{5f1,,environment variables}.

Set to @code{0} by the @ref{964,,-E} environment variable.

Padrão: @code{1} na configuração do Python e @code{0} na configuração isolada.
@end deffn

@geindex PyConfig.user_site_directory (C member)
@anchor{c-api/init_config c PyConfig user_site_directory}@anchor{3dd}
@deffn {C Membro} int user_site_directory

If non-zero, add the user site directory to @ref{3b4,,sys.path}.

Set to @code{0} by the @ref{13d5,,-s} and @ref{965,,-I} command line options.

Set to @code{0} by the 
@geindex PYTHONNOUSERSITE
@geindex variável de ambiente; PYTHONNOUSERSITE
@ref{13d6,,PYTHONNOUSERSITE} environment variable.

Default: @code{1} in Python mode, @code{0} in isolated mode.
@end deffn

@geindex PyConfig.verbose (C member)
@anchor{c-api/init_config c PyConfig verbose}@anchor{3c9}
@deffn {C Membro} 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.

Incremented by the @ref{146c,,-v} command line option.

Set by the 
@geindex PYTHONVERBOSE
@geindex variável de ambiente; PYTHONVERBOSE
@ref{1ebf,,PYTHONVERBOSE} environment variable value.

Padrão: @code{0}.
@end deffn

@geindex PyConfig.warnoptions (C member)
@anchor{c-api/init_config c PyConfig warnoptions}@anchor{3a0}
@deffn {C Membro} @ref{9b6,,PyWideStringList} warnoptions

Options of the @ref{112,,warnings} module to build warnings filters, lowest
to highest priority: @ref{3b0,,sys.warnoptions}.

The @ref{112,,warnings} module adds @ref{3b0,,sys.warnoptions} in the reverse
order: the last @ref{3a0,,PyConfig.warnoptions} item becomes the first
item of @code{warnings.filters} which is checked first (highest
priority).

The @ref{8cd,,-W} command line options adds its value to
@ref{3a0,,warnoptions}, it can be used multiple times.

The 
@geindex PYTHONWARNINGS
@geindex variável de ambiente; PYTHONWARNINGS
@ref{bc2,,PYTHONWARNINGS} environment variable can also be used to add
warning options. Multiple options can be specified, separated by commas
(@code{,}).

Padrão: lista vazia.
@end deffn

@geindex PyConfig.write_bytecode (C member)
@anchor{c-api/init_config c PyConfig write_bytecode}@anchor{3db}
@deffn {C Membro} int write_bytecode

If equal to @code{0}, Python won’t try to write @code{.pyc} files on the import of
source modules.

Set to @code{0} by the @ref{1414,,-B} command line option and the
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE} environment variable.

@ref{4595,,sys.dont_write_bytecode} is initialized to the inverted value of
@ref{3db,,write_bytecode}.

Padrão: @code{1}.
@end deffn

@geindex PyConfig.xoptions (C member)
@anchor{c-api/init_config c PyConfig xoptions}@anchor{3a1}
@deffn {C Membro} @ref{9b6,,PyWideStringList} xoptions

Values of the @ref{176,,-X} command line options: @ref{1ec7,,sys._xoptions}.

Padrão: lista vazia.
@end deffn
@end deffn

If @ref{1a7e,,parse_argv} is non-zero, @ref{3c3,,argv}
arguments are parsed the same way the regular Python parses @ref{103d,,command line arguments}, and Python arguments are stripped from
@ref{3c3,,argv}.

The @ref{3a1,,xoptions} options are parsed to set other options: see
the @ref{176,,-X} command line option.


Alterado na versão 3.9: The @code{show_alloc_count} field has been removed.


@node Initialization with PyConfig,Isolated Configuration,PyConfig,Configuração de inicialização do Python
@anchor{c-api/init_config init-from-config}@anchor{518c}@anchor{c-api/init_config initialization-with-pyconfig}@anchor{5206}
@subsection Initialization with PyConfig


Initializing the interpreter from a populated configuration struct is handled
by calling @ref{3c5,,Py_InitializeFromConfig()}.

O chamador é responsável por manipular exceções (erro ou saída) usando @ref{9c1,,PyStatus_Exception()} e @ref{9ca,,Py_ExitStatusException()}.

If @ref{3000,,PyImport_FrozenModules()}, @ref{18a4,,PyImport_AppendInittab()} or
@ref{18a5,,PyImport_ExtendInittab()} are used, they must be set or called after
Python preinitialization and before the Python initialization. If Python is
initialized multiple times, @ref{18a4,,PyImport_AppendInittab()} or
@ref{18a5,,PyImport_ExtendInittab()} must be called before each Python
initialization.

The current configuration (@code{PyConfig} type) is stored in
@code{PyInterpreterState.config}.

Example setting the program name:

@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 Isolated Configuration,Configuração do Python,Initialization with PyConfig,Configuração de inicialização do Python
@anchor{c-api/init_config init-isolated-conf}@anchor{51da}@anchor{c-api/init_config isolated-configuration}@anchor{5207}
@subsection Isolated Configuration


@ref{9be,,PyPreConfig_InitIsolatedConfig()} and
@ref{9b8,,PyConfig_InitIsolatedConfig()} functions create a configuration to
isolate Python from the system. For example, to embed Python into an
application.

This configuration ignores global configuration variables, environment
variables, command line arguments (@ref{3c3,,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.

Configuration files are still used with this configuration to determine
paths that are unspecified. Ensure @ref{3bb,,PyConfig.home} is specified
to avoid computing the default path configuration.

@node Configuração do Python,Python Path Configuration,Isolated Configuration,Configuração de inicialização do Python
@anchor{c-api/init_config init-python-config}@anchor{5190}@anchor{c-api/init_config python-configuration}@anchor{5208}
@subsection Configuração do Python


@ref{9bf,,PyPreConfig_InitPythonConfig()} and @ref{9b9,,PyConfig_InitPythonConfig()}
functions create a configuration to build a customized Python which behaves as
the regular Python.

Environments variables and command line arguments are used to configure
Python, whereas global configuration variables are ignored.

This function enables C locale coercion (
@geindex Propostas de Melhorias do Python; PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/})
and @ref{656,,Python UTF-8 Mode}
(
@geindex Propostas de Melhorias do Python; PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/}) depending on the LC_CTYPE locale, 
@geindex PYTHONUTF8
@geindex variável de ambiente; PYTHONUTF8
@ref{ae8,,PYTHONUTF8} and
@geindex PYTHONCOERCECLOCALE
@geindex variável de ambiente; PYTHONCOERCECLOCALE
@ref{ae5,,PYTHONCOERCECLOCALE} environment variables.

@node Python Path Configuration,Py_GetArgcArgv,Configuração do Python,Configuração de inicialização do Python
@anchor{c-api/init_config init-path-config}@anchor{8b2}@anchor{c-api/init_config python-path-configuration}@anchor{5209}
@subsection Python Path Configuration


@ref{3a6,,PyConfig} contains multiple fields for the path configuration:


@itemize *

@item 
Path configuration inputs:


@itemize *

@item 
@ref{3bb,,PyConfig.home}

@item 
@ref{1aae,,PyConfig.platlibdir}

@item 
@ref{3d7,,PyConfig.pathconfig_warnings}

@item 
@ref{3c4,,PyConfig.program_name}

@item 
@ref{51ff,,PyConfig.pythonpath_env}

@item 
current working directory: to get absolute paths

@item 
@code{PATH} environment variable to get the program full path
(from @ref{3c4,,PyConfig.program_name})

@item 
@code{__PYVENV_LAUNCHER__} environment variable

@item 
(Windows only) Application paths in the registry under
“SoftwarePythonPythonCoreX.YPythonPath” of HKEY_CURRENT_USER and
HKEY_LOCAL_MACHINE (where X.Y is the Python version).
@end itemize

@item 
Path configuration output fields:


@itemize *

@item 
@ref{51f0,,PyConfig.base_exec_prefix}

@item 
@ref{51f2,,PyConfig.base_executable}

@item 
@ref{51f3,,PyConfig.base_prefix}

@item 
@ref{51f1,,PyConfig.exec_prefix}

@item 
@ref{3a5,,PyConfig.executable}

@item 
@ref{5ef,,PyConfig.module_search_paths_set},
@ref{3a2,,PyConfig.module_search_paths}

@item 
@ref{51f4,,PyConfig.prefix}
@end itemize
@end itemize

If at least one “output field” is not set, Python calculates the path
configuration to fill unset fields. If
@ref{5ef,,module_search_paths_set} is equal to @code{0},
@ref{3a2,,module_search_paths} is overridden and
@ref{5ef,,module_search_paths_set} is set to @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{3d7,,pathconfig_warnings} to @code{0} to suppress warnings when
calculating the path configuration (Unix only, Windows does not log any warning).

If @ref{51f3,,base_prefix} or @ref{51f0,,base_exec_prefix}
fields are not set, they inherit their value from @ref{51f4,,prefix}
and @ref{51f1,,exec_prefix} respectively.

@ref{9cd,,Py_RunMain()} and @ref{c3f,,Py_Main()} modify @ref{3b4,,sys.path}:


@itemize *

@item 
If @ref{518e,,run_filename} is set and is a directory which contains a
@code{__main__.py} script, prepend @ref{518e,,run_filename} to
@ref{3b4,,sys.path}.

@item 
If @ref{3e4,,isolated} is zero:


@itemize *

@item 
If @ref{518f,,run_module} is set, prepend the current directory
to @ref{3b4,,sys.path}. Do nothing if the current directory cannot be read.

@item 
If @ref{518e,,run_filename} is set, prepend the directory of the
filename to @ref{3b4,,sys.path}.

@item 
Otherwise, prepend an empty string to @ref{3b4,,sys.path}.
@end itemize
@end itemize

If @ref{3d3,,site_import} is non-zero, @ref{3b4,,sys.path} can be
modified by the @ref{c7,,site} module. If
@ref{3dd,,user_site_directory} is non-zero and the user’s
site-package directory exists, the @ref{c7,,site} module appends the user’s
site-package directory to @ref{3b4,,sys.path}.

The following configuration files are used by the path configuration:


@itemize *

@item 
@code{pyvenv.cfg}

@item 
@code{._pth} file (ex: @code{python._pth})

@item 
@code{pybuilddir.txt} (Unix only)
@end itemize

If a @code{._pth} file is present:


@itemize *

@item 
Set @ref{3e4,,isolated} to @code{1}.

@item 
Set @ref{3d9,,use_environment} to @code{0}.

@item 
Set @ref{3d3,,site_import} to @code{0}.

@item 
Set @ref{773,,safe_path} to @code{1}.
@end itemize

The @code{__PYVENV_LAUNCHER__} environment variable is used to set
@ref{51f2,,PyConfig.base_executable}.

@node Py_GetArgcArgv,Multi-Phase Initialization Private Provisional API,Python Path Configuration,Configuração de inicialização do Python
@anchor{c-api/init_config py-getargcargv}@anchor{520a}
@subsection Py_GetArgcArgv()


@geindex Py_GetArgcArgv (C function)
@anchor{c-api/init_config c Py_GetArgcArgv}@anchor{1ace}
@deffn {C Função} void Py_GetArgcArgv (int *argc, wchar_t ***argv)

Get the original command line arguments, before Python modified them.

See also @ref{898,,PyConfig.orig_argv} member.
@end deffn

@node Multi-Phase Initialization Private Provisional API,,Py_GetArgcArgv,Configuração de inicialização do Python
@anchor{c-api/init_config multi-phase-initialization-private-provisional-api}@anchor{520b}
@subsection Multi-Phase Initialization Private Provisional API


This section is a private provisional API introducing multi-phase
initialization, the core feature of 
@geindex Propostas de Melhorias do Python; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/}:


@itemize *

@item 
“Core” initialization phase, “bare minimum Python”:


@itemize *

@item 
Builtin types;

@item 
Builtin exceptions;

@item 
Builtin and frozen modules;

@item 
The @ref{d9,,sys} module is only partially initialized
(ex: @ref{3b4,,sys.path} doesn’t exist yet).
@end itemize

@item 
“Main” initialization phase, Python is fully initialized:


@itemize *

@item 
Install and configure @ref{77,,importlib};

@item 
Apply the @ref{8b2,,Path Configuration};

@item 
Install signal handlers;

@item 
Finish @ref{d9,,sys} module initialization (ex: create @ref{ae6,,sys.stdout}
and @ref{3b4,,sys.path});

@item 
Enable optional features like @ref{58,,faulthandler} and @ref{ff,,tracemalloc};

@item 
Import the @ref{c7,,site} module;

@item 
etc.
@end itemize
@end itemize

Private provisional API:


@itemize *

@item 
@code{PyConfig._init_main}: if set to @code{0},
@ref{3c5,,Py_InitializeFromConfig()} stops at the “Core” initialization phase.
@end itemize

@geindex _Py_InitializeMain (C function)
@anchor{c-api/init_config c _Py_InitializeMain}@anchor{520c}
@deffn {C Função} @ref{9b5,,PyStatus} _Py_InitializeMain (void)

Move to the “Main” initialization phase, finish the Python initialization.
@end deffn

No module is imported during the “Core” phase and the @code{importlib} module is
not configured: the @ref{8b2,,Path Configuration} is only
applied during the “Main” phase. It may allow to customize Python in Python to
override or tune the @ref{8b2,,Path Configuration}, maybe
install a custom @ref{d4d,,sys.meta_path} importer or an import hook, etc.

It may become possible to calculate the @ref{8b2,,Path Configuration} in Python, after the Core phase and before the Main phase,
which is one of the 
@geindex Propostas de Melhorias do Python; PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/} motivation.

The “Core” phase is not properly defined: what should be and what should
not be available at this phase is not specified yet. The API is marked
as private and provisional: the API can be modified or even be removed
anytime until a proper public API is designed.

Example running Python code between “Core” and “Main” initialization
phases:

@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 Gerenciamento de Memória,Suporte a implementação de Objetos,Configuração de inicialização do Python,Manual de referência da API Python/C
@anchor{c-api/memory doc}@anchor{520d}@anchor{c-api/memory memory}@anchor{51e5}@anchor{c-api/memory memory-management}@anchor{520e}@anchor{c-api/memory translation-repo}@anchor{520f}
@section Gerenciamento de Memória


@menu
* Visão Geral: Visão Geral<4>. 
* Allocator Domains:: 
* Raw Memory Interface:: 
* Interface da Memória:: 
* Alocadores de objeto:: 
* Alocadores de memória padrão:: 
* Alocadores de memória:: 
* Debug hooks on the Python memory allocators:: 
* The pymalloc allocator:: 
* The mimalloc allocator:: 
* tracemalloc C API:: 
* Exemplos: Exemplos<37>. 

@end menu

@node Visão Geral<4>,Allocator Domains,,Gerenciamento de Memória
@anchor{c-api/memory memoryoverview}@anchor{5210}@anchor{c-api/memory overview}@anchor{5211}
@subsection Visão Geral


O gerenciamento de memória em Python envolve um heap privado contendo todos os objetos e estruturas de dados Python. O gerenciamento desse heap privado é garantido internamente pelo `gerenciador de memória do Python'. O gerenciador de memória do Python possui diferentes componentes que lidam com diversos aspectos dinâmicos do gerenciamento de armazenamento, como compartilhamento, segmentação, pré-alocação ou cache.

No nível mais baixo, um alocador de memória bruta garante que haja espaço suficiente no heap privado para armazenar todos os dados relacionados ao Python, interagindo com o gerenciador de memória do sistema operacional. Além do alocador de memória bruta, vários alocadores específicos de objeto operam no mesmo heap e implementam políticas distintas de gerenciamento de memória, adaptadas às peculiaridades de cada tipo de objeto. Por exemplo, objetos inteiros são gerenciados dentro do heap de forma diferente de strings, tuplas ou dicionários, pois inteiros implicam diferentes requisitos de armazenamento e compensações entre velocidade e espaço. O gerenciador de memória do Python, portanto, delega parte do trabalho aos alocadores específicos de objeto, mas garante que estes operem dentro dos limites do heap privado.

It is important to understand that the management of the Python heap is
performed by the interpreter itself and that the user has no control over it,
even if they regularly manipulate object pointers to memory blocks inside that
heap.  The allocation of heap space for Python objects and other internal
buffers is performed on demand by the Python memory manager through the Python/C
API functions listed in this document.

@geindex malloc (C function)
@geindex calloc (C function)
@geindex realloc (C function)
@geindex free (C function)

To avoid memory corruption, extension writers should never try to operate on
Python objects with the functions exported by the C library: @code{malloc()},
@code{calloc()}, @code{realloc()} and @code{free()}.  This will result in  mixed
calls between the C allocator and the Python memory manager with fatal
consequences, because they implement different algorithms and operate on
different heaps.  However, one may safely allocate and release memory blocks
with the C library allocator for individual purposes, as shown in the following
example:

@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

In this example, the memory request for the I/O buffer is handled by the C
library allocator. The Python memory manager is involved only in the allocation
of the bytes object returned as a result.

In most situations, however, it is recommended to allocate memory from the
Python heap specifically because the latter is under control of the Python
memory manager. For example, this is required when the interpreter is extended
with new object types written in C. Another reason for using the Python heap is
the desire to `inform' the Python memory manager about the memory needs of the
extension module. Even when the requested memory is used exclusively for
internal, highly specific purposes, delegating all memory requests to the Python
memory manager causes the interpreter to have a more accurate image of its
memory footprint as a whole. Consequently, under certain circumstances, the
Python memory manager may or may not trigger appropriate actions, like garbage
collection, memory compaction or other preventive procedures. Note that by using
the C library allocator as shown in the previous example, the allocated memory
for the I/O buffer escapes completely the Python memory manager.


@subsubheading Ver também


The 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable can be used to configure
the memory allocators used by Python.

The 
@geindex PYTHONMALLOCSTATS
@geindex variável de ambiente; PYTHONMALLOCSTATS
@ref{1cd0,,PYTHONMALLOCSTATS} environment variable can be used to print
statistics of the @ref{d31,,pymalloc memory allocator} every time a
new pymalloc object arena is created, and on shutdown.


@node Allocator Domains,Raw Memory Interface,Visão Geral<4>,Gerenciamento de Memória
@anchor{c-api/memory allocator-domains}@anchor{5212}
@subsection Allocator Domains

@anchor{c-api/memory id1}@anchor{5213}
All allocating functions belong to one of three different “domains” (see also
@ref{5214,,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{1ed4,,Alocadores de memória padrão}.
The APIs used to allocate and free a block of memory must be from the same domain.
For example, @ref{148a,,PyMem_Free()} must be used to free memory allocated using @ref{c81,,PyMem_Malloc()}.

The three allocation domains are:


@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{159,,GIL}. The memory is requested directly
from the system. See @ref{5215,,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{159,,GIL} held. The memory is taken from the Python private heap.
See @ref{5216,,Memory Interface}.

@item 
Object domain: intended for allocating memory for Python objects. The
memory is taken from the Python private heap. See @ref{5217,,Object allocators}.
@end itemize

@cartouche
@quotation Nota 
The @ref{15e4,,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{c81,,PyMem_Malloc()},
@ref{390,,PyMem_RawMalloc()}, or @code{malloc()}, but not @ref{c83,,PyObject_Malloc()}.

See @ref{5218,,Memory Allocation APIs}.
@end quotation
@end cartouche

@node Raw Memory Interface,Interface da Memória,Allocator Domains,Gerenciamento de Memória
@anchor{c-api/memory raw-memory-interface}@anchor{5219}@anchor{c-api/memory raw-memoryinterface}@anchor{5215}
@subsection Raw Memory Interface


The following function sets are wrappers to the system allocator. These
functions are thread-safe, the @ref{148,,GIL} does not
need to be held.

The @ref{1ed4,,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.


Adicionado na versão 3.4.


@geindex PyMem_RawMalloc (C function)
@anchor{c-api/memory c PyMem_RawMalloc}@anchor{390}
@deffn {C Função} void *PyMem_RawMalloc (size_t n)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Allocates `n' bytes and returns a pointer of type void* to the
allocated memory, or @code{NULL} if the request fails.

Requesting zero bytes returns a distinct non-@code{NULL} pointer if possible, as
if @code{PyMem_RawMalloc(1)} had been called instead. The memory will not have
been initialized in any way.
@end deffn

@geindex PyMem_RawCalloc (C function)
@anchor{c-api/memory c PyMem_RawCalloc}@anchor{391}
@deffn {C Função} void *PyMem_RawCalloc (size_t nelem, size_t elsize)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Allocates `nelem' elements each whose size in bytes is `elsize' and returns
a pointer of type void* to the allocated memory, or @code{NULL} if the
request fails. The memory is initialized to zeros.

Requesting zero elements or elements of size zero bytes returns a distinct
non-@code{NULL} pointer if possible, as if @code{PyMem_RawCalloc(1, 1)} had been
called instead.


Adicionado na versão 3.5.

@end deffn

@geindex PyMem_RawRealloc (C function)
@anchor{c-api/memory c PyMem_RawRealloc}@anchor{392}
@deffn {C Função} void *PyMem_RawRealloc (void *p, size_t n)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Resizes the memory block pointed to by `p' to `n' bytes. The contents will
be unchanged to the minimum of the old and the new sizes.

If `p' is @code{NULL}, the call is equivalent to @code{PyMem_RawMalloc(n)}; else if
`n' is equal to zero, the memory block is resized but is not freed, and the
returned pointer is non-@code{NULL}.

Unless `p' is @code{NULL}, it must have been returned by a previous call to
@ref{390,,PyMem_RawMalloc()}, @ref{392,,PyMem_RawRealloc()} or
@ref{391,,PyMem_RawCalloc()}.

If the request fails, @ref{392,,PyMem_RawRealloc()} returns @code{NULL} and `p'
remains a valid pointer to the previous memory area.
@end deffn

@geindex PyMem_RawFree (C function)
@anchor{c-api/memory c PyMem_RawFree}@anchor{393}
@deffn {C Função} void PyMem_RawFree (void *p)
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Frees the memory block pointed to by `p', which must have been returned by a
previous call to @ref{390,,PyMem_RawMalloc()}, @ref{392,,PyMem_RawRealloc()} or
@ref{391,,PyMem_RawCalloc()}.  Otherwise, or if @code{PyMem_RawFree(p)} has been
called before, undefined behavior occurs.

If `p' is @code{NULL}, no operation is performed.
@end deffn

@node Interface da Memória,Alocadores de objeto,Raw Memory Interface,Gerenciamento de Memória
@anchor{c-api/memory memory-interface}@anchor{521a}@anchor{c-api/memory memoryinterface}@anchor{5216}
@subsection Interface da Memória


The following function sets, modeled after the ANSI C standard, but specifying
behavior when requesting zero bytes, are available for allocating and releasing
memory from the Python heap.

The @ref{1ed4,,default memory allocator} uses the
@ref{d31,,pymalloc memory allocator}.

@cartouche
@quotation Aviso 
The @ref{148,,GIL} must be held when using these
functions.
@end quotation
@end cartouche


Alterado na versão 3.6: The default allocator is now pymalloc instead of system @code{malloc()}.


@geindex PyMem_Malloc (C function)
@anchor{c-api/memory c PyMem_Malloc}@anchor{c81}
@deffn {C Função} void *PyMem_Malloc (size_t n)
` Parte da @ref{553,,ABI Estável}.'
Allocates `n' bytes and returns a pointer of type void* to the
allocated memory, or @code{NULL} if the request fails.

Requesting zero bytes returns a distinct non-@code{NULL} pointer if possible, as
if @code{PyMem_Malloc(1)} had been called instead. The memory will not have
been initialized in any way.
@end deffn

@geindex PyMem_Calloc (C function)
@anchor{c-api/memory c PyMem_Calloc}@anchor{edc}
@deffn {C Função} void *PyMem_Calloc (size_t nelem, size_t elsize)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Allocates `nelem' elements each whose size in bytes is `elsize' and returns
a pointer of type void* to the allocated memory, or @code{NULL} if the
request fails. The memory is initialized to zeros.

Requesting zero elements or elements of size zero bytes returns a distinct
non-@code{NULL} pointer if possible, as if @code{PyMem_Calloc(1, 1)} had been called
instead.


Adicionado na versão 3.5.

@end deffn

@geindex PyMem_Realloc (C function)
@anchor{c-api/memory c PyMem_Realloc}@anchor{106a}
@deffn {C Função} void *PyMem_Realloc (void *p, size_t n)
` Parte da @ref{553,,ABI Estável}.'
Resizes the memory block pointed to by `p' to `n' bytes. The contents will be
unchanged to the minimum of the old and the new sizes.

If `p' is @code{NULL}, the call is equivalent to @code{PyMem_Malloc(n)}; else if `n'
is equal to zero, the memory block is resized but is not freed, and the
returned pointer is non-@code{NULL}.

Unless `p' is @code{NULL}, it must have been returned by a previous call to
@ref{c81,,PyMem_Malloc()}, @ref{106a,,PyMem_Realloc()} or @ref{edc,,PyMem_Calloc()}.

If the request fails, @ref{106a,,PyMem_Realloc()} returns @code{NULL} and `p' remains
a valid pointer to the previous memory area.
@end deffn

@geindex PyMem_Free (C function)
@anchor{c-api/memory c PyMem_Free}@anchor{148a}
@deffn {C Função} void PyMem_Free (void *p)
` Parte da @ref{553,,ABI Estável}.'
Frees the memory block pointed to by `p', which must have been returned by a
previous call to @ref{c81,,PyMem_Malloc()}, @ref{106a,,PyMem_Realloc()} or
@ref{edc,,PyMem_Calloc()}.  Otherwise, or if @code{PyMem_Free(p)} has been called
before, undefined behavior occurs.

If `p' is @code{NULL}, no operation is performed.
@end deffn

The following type-oriented macros are provided for convenience.  Note  that
`TYPE' refers to any C type.

@geindex PyMem_New (C macro)
@anchor{c-api/memory c PyMem_New}@anchor{156d}
@deffn {C Macro} PyMem_New (TYPE, n)

Same as @ref{c81,,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{521b}
@deffn {C Macro} PyMem_Resize (p, TYPE, n)

Same as @ref{106a,,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.

This is a C preprocessor macro; `p' is always reassigned.  Save the original
value of `p' to avoid losing memory when handling errors.
@end deffn

@geindex PyMem_Del (C function)
@anchor{c-api/memory c PyMem_Del}@anchor{156e}
@deffn {C Função} void PyMem_Del (void *p)

Same as @ref{148a,,PyMem_Free()}.
@end deffn

@menu
* Apelidos descontinuados: Apelidos descontinuados<2>. 

@end menu

@node Apelidos descontinuados<2>,,,Interface da Memória
@anchor{c-api/memory deprecated-aliases}@anchor{521c}
@subsubsection Apelidos descontinuados


Esses são apelidos @ref{209,,suavemente descontinuados} para funções e macros existentes. Eles existem unicamente para fins de retrocompatibilidade.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Apelido descontinuado

@tab

Corresponding function or macro

@item

@geindex PyMem_MALLOC (C macro)
@anchor{c-api/memory c PyMem_MALLOC}@anchor{521d}
@deffn {C Macro} PyMem_MALLOC (size)
@end deffn

@tab

@ref{c81,,PyMem_Malloc()}

@item

@geindex PyMem_NEW (C macro)
@anchor{c-api/memory c PyMem_NEW}@anchor{521e}
@deffn {C Macro} PyMem_NEW (type, size)
@end deffn

@tab

@ref{156d,,PyMem_New}

@item

@geindex PyMem_REALLOC (C macro)
@anchor{c-api/memory c PyMem_REALLOC}@anchor{521f}
@deffn {C Macro} PyMem_REALLOC (ptr, size)
@end deffn

@tab

@ref{106a,,PyMem_Realloc()}

@item

@geindex PyMem_RESIZE (C macro)
@anchor{c-api/memory c PyMem_RESIZE}@anchor{5220}
@deffn {C Macro} PyMem_RESIZE (ptr, type, size)
@end deffn

@tab

@ref{521b,,PyMem_Resize}

@item

@geindex PyMem_FREE (C macro)
@anchor{c-api/memory c PyMem_FREE}@anchor{5221}
@deffn {C Macro} PyMem_FREE (ptr)
@end deffn

@tab

@ref{148a,,PyMem_Free()}

@item

@geindex PyMem_DEL (C macro)
@anchor{c-api/memory c PyMem_DEL}@anchor{5222}
@deffn {C Macro} PyMem_DEL (ptr)
@end deffn

@tab

@ref{148a,,PyMem_Free()}

@end multitable



Alterado na versão 3.4: The macros are now aliases of the corresponding functions and macros.
Previously, their behavior was the same, but their use did not necessarily
preserve binary compatibility across Python versions.



Descontinuado desde a versão 2.0.


@node Alocadores de objeto,Alocadores de memória padrão,Interface da Memória,Gerenciamento de Memória
@anchor{c-api/memory object-allocators}@anchor{5223}@anchor{c-api/memory objectinterface}@anchor{5217}
@subsection Alocadores de objeto


The following function sets, modeled after the ANSI C standard, but specifying
behavior when requesting zero bytes, are available for allocating and releasing
memory from the Python heap.

@cartouche
@quotation Nota 
There is no guarantee that the memory returned by these allocators can be
successfully cast to a Python object when intercepting the allocating
functions in this domain by the methods described in
the @ref{5224,,Customize Memory Allocators} section.
@end quotation
@end cartouche

The @ref{1ed4,,default object allocator} uses the
@ref{d31,,pymalloc memory allocator}.

@cartouche
@quotation Aviso 
The @ref{148,,GIL} must be held when using these
functions.
@end quotation
@end cartouche

@geindex PyObject_Malloc (C function)
@anchor{c-api/memory c PyObject_Malloc}@anchor{c83}
@deffn {C Função} void *PyObject_Malloc (size_t n)
` Parte da @ref{553,,ABI Estável}.'
Allocates `n' bytes and returns a pointer of type void* to the
allocated memory, or @code{NULL} if the request fails.

Requesting zero bytes returns a distinct non-@code{NULL} pointer if possible, as
if @code{PyObject_Malloc(1)} had been called instead. The memory will not have
been initialized in any way.
@end deffn

@geindex PyObject_Calloc (C function)
@anchor{c-api/memory c PyObject_Calloc}@anchor{edd}
@deffn {C Função} void *PyObject_Calloc (size_t nelem, size_t elsize)
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Allocates `nelem' elements each whose size in bytes is `elsize' and returns
a pointer of type void* to the allocated memory, or @code{NULL} if the
request fails. The memory is initialized to zeros.

Requesting zero elements or elements of size zero bytes returns a distinct
non-@code{NULL} pointer if possible, as if @code{PyObject_Calloc(1, 1)} had been called
instead.


Adicionado na versão 3.5.

@end deffn

@geindex PyObject_Realloc (C function)
@anchor{c-api/memory c PyObject_Realloc}@anchor{148b}
@deffn {C Função} void *PyObject_Realloc (void *p, size_t n)
` Parte da @ref{553,,ABI Estável}.'
Resizes the memory block pointed to by `p' to `n' bytes. The contents will be
unchanged to the minimum of the old and the new sizes.

If `p' is @code{NULL}, the call is equivalent to @code{PyObject_Malloc(n)}; else if `n'
is equal to zero, the memory block is resized but is not freed, and the
returned pointer is non-@code{NULL}.

Unless `p' is @code{NULL}, it must have been returned by a previous call to
@ref{c83,,PyObject_Malloc()}, @ref{148b,,PyObject_Realloc()} or @ref{edd,,PyObject_Calloc()}.

If the request fails, @ref{148b,,PyObject_Realloc()} returns @code{NULL} and `p' remains
a valid pointer to the previous memory area.
@end deffn

@geindex PyObject_Free (C function)
@anchor{c-api/memory c PyObject_Free}@anchor{c80}
@deffn {C Função} void PyObject_Free (void *p)
` Parte da @ref{553,,ABI Estável}.'
Frees the memory block pointed to by `p', which must have been returned by a
previous call to @ref{c83,,PyObject_Malloc()}, @ref{148b,,PyObject_Realloc()} or
@ref{edd,,PyObject_Calloc()}.  Otherwise, or if @code{PyObject_Free(p)} has been called
before, undefined behavior occurs.

If `p' is @code{NULL}, no operation is performed.
@end deffn

@node Alocadores de memória padrão,Alocadores de memória,Alocadores de objeto,Gerenciamento de Memória
@anchor{c-api/memory default-memory-allocators}@anchor{1ed4}@anchor{c-api/memory id2}@anchor{5225}
@subsection Alocadores de memória padrão


Alocadores de memória padrão:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Configuração

@tab

Nome

@tab

PyMem_RawMalloc

@tab

PyMem_Malloc

@tab

PyObject_Malloc

@item

Release build

@tab

@code{"pymalloc"}

@tab

@code{malloc}

@tab

@code{pymalloc}

@tab

@code{pymalloc}

@item

Debug build

@tab

@code{"pymalloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{pymalloc} + debug

@tab

@code{pymalloc} + debug

@item

Release build, without pymalloc

@tab

@code{"malloc"}

@tab

@code{malloc}

@tab

@code{malloc}

@tab

@code{malloc}

@item

Debug build, without pymalloc

@tab

@code{"malloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@end multitable


Legenda:


@itemize *

@item 
Name: value for 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable.

@item 
@code{malloc}: system allocators from the standard C library, C functions:
@code{malloc()}, @code{calloc()}, @code{realloc()} and @code{free()}.

@item 
@code{pymalloc}: @ref{d31,,pymalloc memory allocator}.

@item 
@code{mimalloc}: @ref{1ed6,,mimalloc memory allocator}.  The pymalloc
allocator will be used if mimalloc support isn’t available.

@item 
“+ debug”: with @ref{1ed7,,debug hooks on the Python memory allocators}.

@item 
“Debug build”: @ref{1f9,,Python build in debug mode}.
@end itemize

@node Alocadores de memória,Debug hooks on the Python memory allocators,Alocadores de memória padrão,Gerenciamento de Memória
@anchor{c-api/memory customize-memory-allocators}@anchor{5224}@anchor{c-api/memory id3}@anchor{5226}
@subsection Alocadores de memória



Adicionado na versão 3.4.


@geindex PyMemAllocatorEx (C type)
@anchor{c-api/memory c PyMemAllocatorEx}@anchor{efd}
@deffn {C Tipo} type PyMemAllocatorEx

Structure used to describe a memory block allocator. The structure has
the following fields:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Campo

@tab

Significado

@item

@code{void *ctx}

@tab

user context passed as first argument

@item

@code{void* malloc(void *ctx, size_t size)}

@tab

allocate a memory block

@item

@code{void* calloc(void *ctx, size_t nelem, size_t elsize)}

@tab

allocate a memory block initialized
with zeros

@item

@code{void* realloc(void *ctx, void *ptr, size_t new_size)}

@tab

allocate or resize a memory block

@item

@code{void free(void *ctx, void *ptr)}

@tab

free a memory block

@end multitable



Alterado na versão 3.5: The @code{PyMemAllocator} structure was renamed to
@ref{efd,,PyMemAllocatorEx} and a new @code{calloc} field was added.

@end deffn

@geindex PyMemAllocatorDomain (C type)
@anchor{c-api/memory c PyMemAllocatorDomain}@anchor{5214}
@deffn {C Tipo} type PyMemAllocatorDomain

Enum used to identify an allocator domain. Domains:

@geindex PYMEM_DOMAIN_RAW (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_RAW}@anchor{1ed5}
@deffn {C Macro} PYMEM_DOMAIN_RAW

Funções:


@itemize *

@item 
@ref{390,,PyMem_RawMalloc()}

@item 
@ref{392,,PyMem_RawRealloc()}

@item 
@ref{391,,PyMem_RawCalloc()}

@item 
@ref{393,,PyMem_RawFree()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_MEM (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_MEM}@anchor{c84}
@deffn {C Macro} PYMEM_DOMAIN_MEM

Funções:


@itemize *

@item 
@ref{c81,,PyMem_Malloc()},

@item 
@ref{106a,,PyMem_Realloc()}

@item 
@ref{edc,,PyMem_Calloc()}

@item 
@ref{148a,,PyMem_Free()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_OBJ (C macro)
@anchor{c-api/memory c PYMEM_DOMAIN_OBJ}@anchor{c82}
@deffn {C Macro} PYMEM_DOMAIN_OBJ

Funções:


@itemize *

@item 
@ref{c83,,PyObject_Malloc()}

@item 
@ref{148b,,PyObject_Realloc()}

@item 
@ref{edd,,PyObject_Calloc()}

@item 
@ref{c80,,PyObject_Free()}
@end itemize
@end deffn
@end deffn

@geindex PyMem_GetAllocator (C function)
@anchor{c-api/memory c PyMem_GetAllocator}@anchor{5188}
@deffn {C Função} void PyMem_GetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

Get the memory block allocator of the specified domain.
@end deffn

@geindex PyMem_SetAllocator (C function)
@anchor{c-api/memory c PyMem_SetAllocator}@anchor{58b}
@deffn {C Função} void PyMem_SetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

Set the memory block allocator of the specified domain.

The new allocator must return a distinct non-@code{NULL} pointer when requesting
zero bytes.

For the @ref{1ed5,,PYMEM_DOMAIN_RAW} domain, the allocator must be
thread-safe: the @ref{148,,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}.

If the new allocator is not a hook (does not call the previous allocator),
the @ref{c85,,PyMem_SetupDebugHooks()} function must be called to reinstall the
debug hooks on top on the new allocator.

See also @ref{51e4,,PyPreConfig.allocator} and @ref{3f80,,Preinitialize Python with PyPreConfig}.

@cartouche
@quotation Aviso 
@ref{58b,,PyMem_SetAllocator()} does have the following contract:


@itemize *

@item 
It can be called after @ref{3eb,,Py_PreInitialize()} and before
@ref{3c5,,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{5213,,the section on allocator domains} for more
information.

@item 
If called after Python has finish initializing (after
@ref{3c5,,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


Alterado na versão 3.12: All allocators must be thread-safe.

@end deffn

@geindex PyMem_SetupDebugHooks (C function)
@anchor{c-api/memory c PyMem_SetupDebugHooks}@anchor{c85}
@deffn {C Função} void PyMem_SetupDebugHooks (void)

Setup @ref{1ed7,,debug hooks in the Python memory allocators}
to detect memory errors.
@end deffn

@node Debug hooks on the Python memory allocators,The pymalloc allocator,Alocadores de memória,Gerenciamento de Memória
@anchor{c-api/memory debug-hooks-on-the-python-memory-allocators}@anchor{5227}@anchor{c-api/memory pymem-debug-hooks}@anchor{1ed7}
@subsection Debug hooks on the Python memory allocators


When @ref{1f9,,Python is built in debug mode}, the
@ref{c85,,PyMem_SetupDebugHooks()} function is called at the @ref{3f80,,Python preinitialization} to setup debug hooks on Python memory allocators
to detect memory errors.

The 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable can be used to install debug
hooks on a Python compiled in release mode (ex: @code{PYTHONMALLOC=debug}).

The @ref{c85,,PyMem_SetupDebugHooks()} function can be used to set debug hooks
after calling @ref{58b,,PyMem_SetAllocator()}.

These debug hooks fill dynamically allocated memory blocks with special,
recognizable bit patterns. Newly allocated memory is filled with the byte
@code{0xCD} (@code{PYMEM_CLEANBYTE}), freed memory is filled with the byte @code{0xDD}
(@code{PYMEM_DEADBYTE}). Memory blocks are surrounded by “forbidden bytes”
filled with the byte @code{0xFD} (@code{PYMEM_FORBIDDENBYTE}). Strings of these bytes
are unlikely to be valid addresses, floats, or ASCII strings.

Checagens em Tempo de Execução:


@itemize -

@item 
Detect API violations. For example, detect if @ref{c80,,PyObject_Free()} is
called on a memory block allocated by @ref{c81,,PyMem_Malloc()}.

@item 
Detect write before the start of the buffer (buffer underflow).

@item 
Detect write after the end of the buffer (buffer overflow).

@item 
Check that the @ref{148,,GIL} is held when
allocator functions of @ref{c82,,PYMEM_DOMAIN_OBJ} (ex:
@ref{c83,,PyObject_Malloc()}) and @ref{c84,,PYMEM_DOMAIN_MEM} (ex:
@ref{c81,,PyMem_Malloc()}) domains are called.
@end itemize

On error, the debug hooks use the @ref{ff,,tracemalloc} module to get the
traceback where a memory block was allocated. The traceback is only displayed
if @ref{ff,,tracemalloc} is tracing Python memory allocations and the memory block
was traced.

Let `S' = @code{sizeof(size_t)}. @code{2*S} bytes are added at each end of each block
of `N' bytes requested.  The memory layout is like so, where p represents the
address returned by a malloc-like or realloc-like function (@code{p[i:j]} means
the slice of bytes from @code{*(p+i)} inclusive up to @code{*(p+j)} exclusive; note
that the treatment of negative indices differs from a Python slice):


@table @asis

@item @code{p[-2*S:-S]}

Number of bytes originally asked for.  This is a size_t, big-endian (easier
to read in a memory dump).

@item @code{p[-S]}

API identifier (ASCII character):


@itemize *

@item 
@code{'r'} for @ref{1ed5,,PYMEM_DOMAIN_RAW}.

@item 
@code{'m'} for @ref{c84,,PYMEM_DOMAIN_MEM}.

@item 
@code{'o'} for @ref{c82,,PYMEM_DOMAIN_OBJ}.
@end itemize

@item @code{p[-S+1:0]}

Copies of PYMEM_FORBIDDENBYTE.  Used to catch under- writes and reads.

@item @code{p[0:N]}

The requested memory, filled with copies of PYMEM_CLEANBYTE, used to catch
reference to uninitialized memory.  When a realloc-like function is called
requesting a larger memory block, the new excess bytes are also filled with
PYMEM_CLEANBYTE.  When a free-like function is called, these are
overwritten with PYMEM_DEADBYTE, to catch reference to freed memory.  When
a realloc- like function is called requesting a smaller memory block, the
excess old bytes are also filled with PYMEM_DEADBYTE.

@item @code{p[N:N+S]}

Copies of PYMEM_FORBIDDENBYTE.  Used to catch over- writes and reads.

@item @code{p[N+S:N+2*S]}

Only used if the @code{PYMEM_DEBUG_SERIALNO} macro is defined (not defined by
default).

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

A realloc-like or free-like function first checks that the PYMEM_FORBIDDENBYTE
bytes at each end are intact.  If they’ve been altered, diagnostic output is
written to stderr, and the program is aborted via Py_FatalError().  The other
main failure mode is provoking a memory error when a program reads up one of
the special bit patterns and tries to use it as an address.  If you get in a
debugger then and look at the object, you’re likely to see that it’s entirely
filled with PYMEM_DEADBYTE (meaning freed memory is getting used) or
PYMEM_CLEANBYTE (meaning uninitialized memory is getting used).


Alterado na versão 3.6: The @ref{c85,,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{c82,,PYMEM_DOMAIN_OBJ} and @ref{c84,,PYMEM_DOMAIN_MEM} domains are
called.



Alterado na versão 3.8: Byte patterns @code{0xCB} (@code{PYMEM_CLEANBYTE}), @code{0xDB} (@code{PYMEM_DEADBYTE})
and @code{0xFB} (@code{PYMEM_FORBIDDENBYTE}) 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()}.


@node The pymalloc allocator,The mimalloc allocator,Debug hooks on the Python memory allocators,Gerenciamento de Memória
@anchor{c-api/memory pymalloc}@anchor{d31}@anchor{c-api/memory the-pymalloc-allocator}@anchor{5228}
@subsection The pymalloc allocator


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{390,,PyMem_RawMalloc()} and
@ref{392,,PyMem_RawRealloc()} for allocations larger than 512 bytes.

`pymalloc' is the @ref{1ed4,,default allocator} of the
@ref{c84,,PYMEM_DOMAIN_MEM} (ex: @ref{c81,,PyMem_Malloc()}) and
@ref{c82,,PYMEM_DOMAIN_OBJ} (ex: @ref{c83,,PyObject_Malloc()}) domains.

The arena allocator uses the following functions:


@itemize *

@item 
@code{VirtualAlloc()} and @code{VirtualFree()} on Windows,

@item 
@code{mmap()} and @code{munmap()} if available,

@item 
@code{malloc()} e @code{free()} do contrário.
@end itemize

This allocator is disabled if Python is configured with the
@ref{1f36,,--without-pymalloc} option. It can also be disabled at runtime using
the 
@geindex PYTHONMALLOC
@geindex variável de ambiente; PYTHONMALLOC
@ref{c7f,,PYTHONMALLOC} environment variable (ex: @code{PYTHONMALLOC=malloc}).

Typically, it makes sense to disable the pymalloc allocator when building
Python with AddressSanitizer (@ref{1f3e,,--with-address-sanitizer}) which helps
uncover low level bugs within the C code.

@menu
* Customize pymalloc Arena Allocator:: 

@end menu

@node Customize pymalloc Arena Allocator,,,The pymalloc allocator
@anchor{c-api/memory customize-pymalloc-arena-allocator}@anchor{5229}
@subsubsection Customize pymalloc Arena Allocator



Adicionado na versão 3.4.


@geindex PyObjectArenaAllocator (C type)
@anchor{c-api/memory c PyObjectArenaAllocator}@anchor{522a}
@deffn {C Tipo} type PyObjectArenaAllocator

Structure used to describe an arena allocator. The structure has
three fields:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Campo

@tab

Significado

@item

@code{void *ctx}

@tab

user context passed as first argument

@item

@code{void* alloc(void *ctx, size_t size)}

@tab

allocate an arena of size bytes

@item

@code{void free(void *ctx, void *ptr, size_t size)}

@tab

free an arena

@end multitable

@end deffn

@geindex PyObject_GetArenaAllocator (C function)
@anchor{c-api/memory c PyObject_GetArenaAllocator}@anchor{5189}
@deffn {C Função} void PyObject_GetArenaAllocator (PyObjectArenaAllocator *allocator)

Get the arena allocator.
@end deffn

@geindex PyObject_SetArenaAllocator (C function)
@anchor{c-api/memory c PyObject_SetArenaAllocator}@anchor{5187}
@deffn {C Função} void PyObject_SetArenaAllocator (PyObjectArenaAllocator *allocator)

Set the arena allocator.
@end deffn

@node The mimalloc allocator,tracemalloc C API,The pymalloc allocator,Gerenciamento de Memória
@anchor{c-api/memory mimalloc}@anchor{1ed6}@anchor{c-api/memory the-mimalloc-allocator}@anchor{522b}
@subsection The mimalloc allocator



Adicionado na versão 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,Exemplos<37>,The mimalloc allocator,Gerenciamento de Memória
@anchor{c-api/memory tracemalloc-c-api}@anchor{522c}
@subsection tracemalloc C API



Adicionado na versão 3.7.


@geindex PyTraceMalloc_Track (C function)
@anchor{c-api/memory c PyTraceMalloc_Track}@anchor{bce}
@deffn {C Função} int PyTraceMalloc_Track (unsigned int domain, uintptr_t ptr, size_t size)

Track an allocated memory block in the @ref{ff,,tracemalloc} module.

Return @code{0} on success, return @code{-1} on error (failed to allocate memory to
store the trace). Return @code{-2} if tracemalloc is disabled.

If memory block is already tracked, update the existing trace.
@end deffn

@geindex PyTraceMalloc_Untrack (C function)
@anchor{c-api/memory c PyTraceMalloc_Untrack}@anchor{bcf}
@deffn {C Função} int PyTraceMalloc_Untrack (unsigned int domain, uintptr_t ptr)

Untrack an allocated memory block in the @ref{ff,,tracemalloc} module.
Do nothing if the block was not tracked.

Return @code{-2} if tracemalloc is disabled, otherwise return @code{0}.
@end deffn

@node Exemplos<37>,,tracemalloc C API,Gerenciamento de Memória
@anchor{c-api/memory examples}@anchor{522d}@anchor{c-api/memory memoryexamples}@anchor{522e}
@subsection Exemplos


Here is the example from section @ref{5210,,Visão Geral}, rewritten so that the
I/O buffer is allocated from the Python heap by using the first function set:

@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

The same code using the type-oriented function set:

@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_Del(buf); /* allocated with PyMem_New */
return res;
@end example

Note that in the two examples above, the buffer is always manipulated via
functions belonging to the same set. Indeed, it is required to use the same
memory API family for a given memory block, so that the risk of mixing different
allocators is reduced to a minimum. The following code sequence contains two
errors, one of which is labeled as `fatal' because it mixes two different
allocators operating on different heaps.

@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_Del()  */
@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{98c,,PyObject_New},
@ref{98d,,PyObject_NewVar} and @ref{1519,,PyObject_Del()}.

These will be explained in the next chapter on defining and implementing new
object types in C.

@node Suporte a implementação de Objetos,API e Versionamento de ABI,Gerenciamento de Memória,Manual de referência da API Python/C
@anchor{c-api/objimpl doc}@anchor{522f}@anchor{c-api/objimpl newtypes}@anchor{5230}@anchor{c-api/objimpl object-implementation-support}@anchor{5231}@anchor{c-api/objimpl translation-repo}@anchor{5232}
@section Suporte a implementação de Objetos


Este capítulo descreve as funções, tipos e macros usados ao definir novos tipos de objeto.

@menu
* Alocando objetos na heap:: 
* Estruturas comuns de objetos:: 
* Estruturas de objetos tipo:: 
* Suporte a Coleta Cíclica de Lixo:: 

@end menu

@node Alocando objetos na heap,Estruturas comuns de objetos,,Suporte a implementação de Objetos
@anchor{c-api/allocation doc}@anchor{5233}@anchor{c-api/allocation allocating-objects}@anchor{5234}@anchor{c-api/allocation allocating-objects-on-the-heap}@anchor{5235}
@subsection Alocando objetos na heap


@geindex _PyObject_New (C function)
@anchor{c-api/allocation c _PyObject_New}@anchor{5236}
@deffn {C Função} @ref{339,,PyObject} *_PyObject_New (PyTypeObject *type)
`Retorna valor: Nova referência.'
@end deffn

@geindex _PyObject_NewVar (C function)
@anchor{c-api/allocation c _PyObject_NewVar}@anchor{5237}
@deffn {C Função} @ref{4384,,PyVarObject} *_PyObject_NewVar (PyTypeObject *type, Py_ssize_t size)
`Retorna valor: Nova referência.'
@end deffn

@geindex PyObject_Init (C function)
@anchor{c-api/allocation c PyObject_Init}@anchor{a74}
@deffn {C Função} @ref{339,,PyObject} *PyObject_Init (PyObject *op, PyTypeObject *type)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Inicializa um objeto `op' recém-alocado com seu tipo e referência inicial.  Retorna o objeto inicializado. Outros campos do objeto não são afetados.
@end deffn

@geindex PyObject_InitVar (C function)
@anchor{c-api/allocation c PyObject_InitVar}@anchor{1acd}
@deffn {C Função} @ref{4384,,PyVarObject} *PyObject_InitVar (PyVarObject *op, PyTypeObject *type, Py_ssize_t size)
`Retorna valor: Referência emprestada.'` Parte da @ref{553,,ABI Estável}.'
Isto faz tudo que o @ref{a74,,PyObject_Init()} faz e também inicializa a informação de comprimento para um objeto de tamanho variável.
@end deffn

@geindex PyObject_New (C macro)
@anchor{c-api/allocation c PyObject_New}@anchor{98c}
@deffn {C Macro} PyObject_New (TYPE, typeobj)

Aloca um novo objeto Python usando o tipo de estrutura do C `TYPE' e o objeto Python do tipo `typeobj' (@code{PyTypeObject*}). Campos não definidos pelo cabeçalho do objeto Python não são inicializados. O chamador será dono da apenas a referência ao objeto (isto é, sua contagem de referências será uma). O tamanho da alocação de memória é determinado do campo @ref{98e,,tp_basicsize} do objeto tipo.

Note que esta função não é adequada se `typeobj' tiver @ref{77d,,Py_TPFLAGS_HAVE_GC} definido. Para tais objetos, use @ref{ab1,,PyObject_GC_New()} em vez disso.
@end deffn

@geindex PyObject_NewVar (C macro)
@anchor{c-api/allocation c PyObject_NewVar}@anchor{98d}
@deffn {C Macro} PyObject_NewVar (TYPE, typeobj, size)

Aloca um novo objeto Python usando o tipo de estrutura do C `TYPE' e o objeto Python do tipo `typeobj' (@code{PyTypeObject*}). Campos não definidos pelo cabeçalho do objeto Python não são inicializados. A memória alocada permite a estrutura `TYPE' e os campos `size' (@code{Py_ssize_t}) do tamanho dado pelo campo @ref{20fd,,tp_itemsize} do tipo `typeobj'. Isto é útil para implementar objetos como tuplas, as quais são capazes de determinar seu tamanho no tempo da construção. Incorporando o vetor de campos dentro da mesma alocação diminuindo o numero de alocações, melhorando a eficiência do gerenciamento de memória.

Note que esta função não é adequada se `typeobj' tiver @ref{77d,,Py_TPFLAGS_HAVE_GC} definido. Para tais objetos, use @ref{ab2,,PyObject_GC_NewVar()} em vez disso.
@end deffn

@geindex _Py_NoneStruct (C var)
@anchor{c-api/allocation c _Py_NoneStruct}@anchor{5238}
@deffn {C Variável} @ref{339,,PyObject} _Py_NoneStruct

Objeto o qual é visível no Python como @code{None}. Isto só deve ser acessado usando a macro @ref{4b48,,Py_None}, o qual avalia como um ponteiro para este objeto.
@end deffn


@subsubheading Ver também



@table @asis

@item @ref{50b3,,Objetos do Módulo}

Para alocar e criar módulos de extensão.
@end table


@menu
* Apelidos descontinuados: Apelidos descontinuados<3>. 

@end menu

@node Apelidos descontinuados<3>,,,Alocando objetos na heap
@anchor{c-api/allocation deprecated-aliases}@anchor{5239}
@subsubsection Apelidos descontinuados


Esses são apelidos @ref{209,,suavemente descontinuados} para funções e macros existentes. Eles existem unicamente para fins de retrocompatibilidade.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Apelido descontinuado

@tab

Função

@item

@geindex PyObject_NEW (C macro)
@anchor{c-api/allocation c PyObject_NEW}@anchor{523a}
@deffn {C Macro} PyObject_NEW (type, typeobj)
@end deffn

@tab

@ref{98c,,PyObject_New}

@item

@geindex PyObject_NEW_VAR (C macro)
@anchor{c-api/allocation c PyObject_NEW_VAR}@anchor{523b}
@deffn {C Macro} PyObject_NEW_VAR (type, typeobj, n)
@end deffn

@tab

@ref{98d,,PyObject_NewVar}

@item

@geindex PyObject_INIT (C macro)
@anchor{c-api/allocation c PyObject_INIT}@anchor{1acb}
@deffn {C Macro} PyObject_INIT (op, typeobj)
@end deffn

@tab

@ref{a74,,PyObject_Init()}

@item

@geindex PyObject_INIT_VAR (C macro)
@anchor{c-api/allocation c PyObject_INIT_VAR}@anchor{1acc}
@deffn {C Macro} PyObject_INIT_VAR (op, typeobj, n)
@end deffn

@tab

@ref{1acd,,PyObject_InitVar()}

@item

@geindex PyObject_MALLOC (C macro)
@anchor{c-api/allocation c PyObject_MALLOC}@anchor{523c}
@deffn {C Macro} PyObject_MALLOC (n)
@end deffn

@tab

@ref{c83,,PyObject_Malloc()}

@item

@geindex PyObject_REALLOC (C macro)
@anchor{c-api/allocation c PyObject_REALLOC}@anchor{523d}
@deffn {C Macro} PyObject_REALLOC (p, n)
@end deffn

@tab

@ref{148b,,PyObject_Realloc()}

@item

@geindex PyObject_FREE (C macro)
@anchor{c-api/allocation c PyObject_FREE}@anchor{523e}
@deffn {C Macro} PyObject_FREE (p)
@end deffn

@tab

@ref{c80,,PyObject_Free()}

@item

@geindex PyObject_DEL (C macro)
@anchor{c-api/allocation c PyObject_DEL}@anchor{523f}
@deffn {C Macro} PyObject_DEL (p)
@end deffn

@tab

@ref{c80,,PyObject_Free()}

@item

@geindex PyObject_Del (C macro)
@anchor{c-api/allocation c PyObject_Del}@anchor{1519}
@deffn {C Macro} PyObject_Del (p)
@end deffn

@tab

@ref{c80,,PyObject_Free()}

@end multitable


@node Estruturas comuns de objetos,Estruturas de objetos tipo,Alocando objetos na heap,Suporte a implementação de Objetos
@anchor{c-api/structures doc}@anchor{5240}@anchor{c-api/structures common-object-structures}@anchor{5241}@anchor{c-api/structures common-structs}@anchor{5242}@anchor{c-api/structures translation-repo}@anchor{5243}
@subsection Estruturas comuns de objetos


Existe um grande número de estruturas usadas para a definição de tipos objeto para o Python. Esta seção descreve essas estruturas e como são usadas.

@menu
* Macros e tipos de objetos base:: 
* Implementing functions and methods:: 
* Accessing attributes of extension types:: 

@end menu

@node Macros e tipos de objetos base,Implementing functions and methods,,Estruturas comuns de objetos
@anchor{c-api/structures base-object-types-and-macros}@anchor{5244}
@subsubsection Macros e tipos de objetos base


Todos os objetos Python por fim compartilham um pequeno número de campos no começo da representação o objeto na memória. Esses são representados pelos tipos @ref{339,,PyObject} e @ref{4384,,PyVarObject}, que são definidos, por sua vez, pelas expansões de alguns macros também, utilizados, direta ou indiretamente, na definição de todos outros objetos Python. Macros adicionais podem ser encontrados em @ref{4e7c,,contagem de referências}.

@geindex PyObject (C type)
@anchor{c-api/structures c PyObject}@anchor{339}
@deffn {C Tipo} type PyObject
` Parte da @ref{553,,API Limitada}. (Somente alguns membros são parte da ABI estável.)'
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{339,,PyObject}, but every pointer
to a Python object can be cast to a @ref{339,,PyObject}*.  Access to the
members must be done by using the macros @ref{8ae,,Py_REFCNT} and
@ref{780,,Py_TYPE}.
@end deffn

@geindex PyVarObject (C type)
@anchor{c-api/structures c PyVarObject}@anchor{4384}
@deffn {C Tipo} type PyVarObject
` Parte da @ref{553,,API Limitada}. (Somente alguns membros são parte da ABI estável.)'
Esta é uma extensão de @ref{339,,PyObject} que adiciona o campo @ref{4dba,,ob_size}. Isso é usado apenas para objetos que têm alguma noção de `comprimento'. Esse tipo não costuma aparecer na API Python/C. O acesso aos membros deve ser feito através das macros @ref{8ae,,Py_REFCNT}, @ref{780,,Py_TYPE}, e @ref{782,,Py_SIZE}.
@end deffn

@geindex PyObject_HEAD (C macro)
@anchor{c-api/structures c PyObject_HEAD}@anchor{1321}
@deffn {C Macro} PyObject_HEAD

Este é um macro usado ao declarar novos tipos que representam objetos sem comprimento variável. O macro PyObject_HEAD se expande para:

@example
PyObject ob_base;
@end example

Veja documentação de @ref{339,,PyObject} acima.
@end deffn

@geindex PyObject_VAR_HEAD (C macro)
@anchor{c-api/structures c PyObject_VAR_HEAD}@anchor{5245}
@deffn {C Macro} PyObject_VAR_HEAD

Esta é uma macro usada ao declarar novos tipos que representam objetos com um comprimento que varia de instância para instância. A macro PyObject_VAR_HEAD se expande para:

@example
PyVarObject ob_base;
@end example

Veja documentação de @ref{4384,,PyVarObject} acima.
@end deffn

@geindex PyBaseObject_Type (C var)
@anchor{c-api/structures c PyBaseObject_Type}@anchor{4c0e}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyBaseObject_Type
` Parte da @ref{553,,ABI Estável}.'
A classe base de todos os outros objetos, equivalente a @ref{a96,,object} em Python.
@end deffn

@geindex Py_Is (C function)
@anchor{c-api/structures c Py_Is}@anchor{8a4}
@deffn {C Função} int Py_Is (PyObject *x, PyObject *y)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Testa se o objeto `x' é o objeto `y', o mesmo que @code{x is y} em Python.


Adicionado na versão 3.10.

@end deffn

@geindex Py_IsNone (C function)
@anchor{c-api/structures c Py_IsNone}@anchor{8a5}
@deffn {C Função} int Py_IsNone (PyObject *x)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Test if an object is the @code{None} singleton,
the same as @code{x is None} in Python.


Adicionado na versão 3.10.

@end deffn

@geindex Py_IsTrue (C function)
@anchor{c-api/structures c Py_IsTrue}@anchor{8a6}
@deffn {C Função} int Py_IsTrue (PyObject *x)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Test if an object is the @code{True} singleton,
the same as @code{x is True} in Python.


Adicionado na versão 3.10.

@end deffn

@geindex Py_IsFalse (C function)
@anchor{c-api/structures c Py_IsFalse}@anchor{8a7}
@deffn {C Função} int Py_IsFalse (PyObject *x)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Test if an object is the @code{False} singleton,
the same as @code{x is False} in Python.


Adicionado na versão 3.10.

@end deffn

@geindex Py_TYPE (C function)
@anchor{c-api/structures c Py_TYPE}@anchor{780}
@deffn {C Função} @ref{ab4,,PyTypeObject} *Py_TYPE (PyObject *o)
`Retorna valor: Referência emprestada.'
Get the type of the Python object `o'.

Return a @ref{33e,,borrowed reference}.

Use the @ref{781,,Py_SET_TYPE()} function to set an object type.


Alterado na versão 3.11: @ref{780,,Py_TYPE()} is changed to an inline static function.
The parameter type is no longer const @ref{339,,PyObject}*.

@end deffn

@geindex Py_IS_TYPE (C function)
@anchor{c-api/structures c Py_IS_TYPE}@anchor{192b}
@deffn {C Função} int Py_IS_TYPE (PyObject *o, PyTypeObject *type)

Return non-zero if the object `o' type is `type'. Return zero otherwise.
Equivalent to: @code{Py_TYPE(o) == type}.


Adicionado na versão 3.9.

@end deffn

@geindex Py_SET_TYPE (C function)
@anchor{c-api/structures c Py_SET_TYPE}@anchor{781}
@deffn {C Função} void Py_SET_TYPE (PyObject *o, PyTypeObject *type)

Set the object `o' type to `type'.


Adicionado na versão 3.9.

@end deffn

@geindex Py_SIZE (C function)
@anchor{c-api/structures c Py_SIZE}@anchor{782}
@deffn {C Função} @ref{a69,,Py_ssize_t} Py_SIZE (PyVarObject *o)

Get the size of the Python object `o'.

Use the @ref{783,,Py_SET_SIZE()} function to set an object size.


Alterado na versão 3.11: @ref{782,,Py_SIZE()} is changed to an inline static function.
The parameter type is no longer const @ref{4384,,PyVarObject}*.

@end deffn

@geindex Py_SET_SIZE (C function)
@anchor{c-api/structures c Py_SET_SIZE}@anchor{783}
@deffn {C Função} void Py_SET_SIZE (PyVarObject *o, Py_ssize_t size)

Set the object `o' size to `size'.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_HEAD_INIT (C macro)
@anchor{c-api/structures c PyObject_HEAD_INIT}@anchor{5246}
@deffn {C Macro} PyObject_HEAD_INIT (type)

This is a macro which expands to initialization values for a new
@ref{339,,PyObject} type.  This macro expands to:

@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{5247}
@deffn {C Macro} PyVarObject_HEAD_INIT (type, size)

This is a macro which expands to initialization values for a new
@ref{4384,,PyVarObject} type, including the @ref{4dba,,ob_size} field.
This macro expands to:

@example
_PyObject_EXTRA_INIT
1, type, size,
@end example
@end deffn

@node Implementing functions and methods,Accessing attributes of extension types,Macros e tipos de objetos base,Estruturas comuns de objetos
@anchor{c-api/structures implementing-functions-and-methods}@anchor{5248}
@subsubsection Implementing functions and methods


@geindex PyCFunction (C type)
@anchor{c-api/structures c PyCFunction}@anchor{14c0}
@deffn {C Tipo} type PyCFunction
` Parte da @ref{553,,ABI Estável}.'
Type of the functions used to implement most Python callables in C.
Functions of this type take two @ref{339,,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.

A assinatura da função é:

@example
PyObject *PyCFunction(PyObject *self,
                      PyObject *args);
@end example
@end deffn

@geindex PyCFunctionWithKeywords (C type)
@anchor{c-api/structures c PyCFunctionWithKeywords}@anchor{4c24}
@deffn {C Tipo} type PyCFunctionWithKeywords
` Parte da @ref{553,,ABI Estável}.'
Type of the functions used to implement Python callables in C
with signature @ref{5249,,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{4c22}
@deffn {C Tipo} type PyCFunctionFast
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Type of the functions used to implement Python callables in C
with signature @ref{1713,,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{4c23}
@deffn {C Tipo} type PyCFunctionFastWithKeywords
` Parte da @ref{553,,ABI Estável} desde a versão 3.13.'
Type of the functions used to implement Python callables in C
with signature @ref{524a,,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{764}
@deffn {C Tipo} type PyCMethod

Type of the functions used to implement Python callables in C
with signature @ref{1784,,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


Adicionado na versão 3.9.

@end deffn

@geindex PyMethodDef (C type)
@anchor{c-api/structures c PyMethodDef}@anchor{151f}
@deffn {C Tipo} type PyMethodDef
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Structure used to describe a method of an extension type.  This structure has
four fields:

@geindex PyMethodDef.ml_name (C member)
@anchor{c-api/structures c PyMethodDef ml_name}@anchor{4b92}
@deffn {C Membro} const char *ml_name

Nome do método.
@end deffn

@geindex PyMethodDef.ml_meth (C member)
@anchor{c-api/structures c PyMethodDef ml_meth}@anchor{524b}
@deffn {C Membro} @ref{14c0,,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{524c}
@deffn {C Membro} 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{524d}
@deffn {C Membro} const char *ml_doc

Points to the contents of the docstring.
@end deffn
@end deffn

The @ref{524b,,ml_meth} is a C function pointer.
The functions may be of different
types, but they always return @ref{339,,PyObject}*.  If the function is not of
the @ref{14c0,,PyCFunction}, the compiler will require a cast in the method table.
Even though @ref{14c0,,PyCFunction} defines the first parameter as
@ref{339,,PyObject}*, it is common that the method implementation uses the
specific C type of the `self' object.

The @ref{524c,,ml_flags} field is a bitfield which can include
the following flags.
The individual flags indicate either a calling convention or a binding
convention.

There are these calling conventions:

@geindex METH_VARARGS (C macro)
@anchor{c-api/structures c METH_VARARGS}@anchor{1551}
@deffn {C Macro} METH_VARARGS
` Parte da @ref{553,,ABI Estável}.'
This is the typical calling convention, where the methods have the type
@ref{14c0,,PyCFunction}. The function expects two @ref{339,,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{571,,PyArg_ParseTuple()} or @ref{154f,,PyArg_UnpackTuple()}.
@end deffn

@geindex METH_KEYWORDS (C macro)
@anchor{c-api/structures c METH_KEYWORDS}@anchor{4b4b}
@deffn {C Macro} METH_KEYWORDS

Can only be used in certain combinations with other flags:
@ref{5249,,METH_VARARGS | METH_KEYWORDS},
@ref{524a,,METH_FASTCALL | METH_KEYWORDS} and
@ref{1784,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-varargs-meth-keywords}@anchor{5249}

@table @asis

@item @ref{1551,,METH_VARARGS} | @ref{4b4b,,METH_KEYWORDS}

Methods with these flags must be of type @ref{4c24,,PyCFunctionWithKeywords}.
The function expects three parameters: `self', `args', `kwargs' where
`kwargs' is a dictionary of all the keyword arguments or possibly @code{NULL}
if there are no keyword arguments.  The parameters are typically processed
using @ref{383,,PyArg_ParseTupleAndKeywords()}.
@end table

@geindex METH_FASTCALL (C macro)
@anchor{c-api/structures c METH_FASTCALL}@anchor{1713}
@deffn {C Macro} METH_FASTCALL
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Fast calling convention supporting only positional arguments.
The methods have the type @ref{4c22,,PyCFunctionFast}.
The first parameter is `self', the second parameter is a C array
of @ref{339,,PyObject}* values indicating the arguments and the third
parameter is the number of arguments (the length of the array).


Adicionado na versão 3.7.



Alterado na versão 3.10: @code{METH_FASTCALL} is now part of the @ref{4bf6,,stable ABI}.

@end deffn
@anchor{c-api/structures meth-fastcall-meth-keywords}@anchor{524a}

@table @asis

@item @ref{1713,,METH_FASTCALL} | @ref{4b4b,,METH_KEYWORDS}

Extension of @ref{1713,,METH_FASTCALL} supporting also keyword arguments,
with methods of type @ref{4c23,,PyCFunctionFastWithKeywords}.
Keyword arguments are passed the same way as in the
@ref{552,,vectorcall protocol}:
there is an additional fourth @ref{339,,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.


Adicionado na versão 3.7.

@end table

@geindex METH_METHOD (C macro)
@anchor{c-api/structures c METH_METHOD}@anchor{977}
@deffn {C Macro} METH_METHOD
` Parte da @ref{553,,ABI Estável} desde a versão 3.7.'
Can only be used in the combination with other flags:
@ref{1784,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-method-meth-fastcall-meth-keywords}@anchor{1784}

@table @asis

@item @ref{977,,METH_METHOD} | @ref{1713,,METH_FASTCALL} | @ref{4b4b,,METH_KEYWORDS}

Extension of @ref{524a,,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)}.

The method needs to be of type @ref{764,,PyCMethod}, the same as for
@code{METH_FASTCALL | METH_KEYWORDS} with @code{defining_class} argument added after
@code{self}.


Adicionado na versão 3.9.

@end table

@geindex METH_NOARGS (C macro)
@anchor{c-api/structures c METH_NOARGS}@anchor{151c}
@deffn {C Macro} METH_NOARGS
` Parte da @ref{553,,ABI Estável}.'
Methods without parameters don’t need to check whether arguments are given if
they are listed with the @ref{151c,,METH_NOARGS} flag.  They need to be of type
@ref{14c0,,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}.

The function must have 2 parameters. Since the second parameter is unused,
@ref{180c,,Py_UNUSED} can be used to prevent a compiler warning.
@end deffn

@geindex METH_O (C macro)
@anchor{c-api/structures c METH_O}@anchor{1550}
@deffn {C Macro} METH_O
` Parte da @ref{553,,ABI Estável}.'
Methods with a single object argument can be listed with the @ref{1550,,METH_O}
flag, instead of invoking @ref{571,,PyArg_ParseTuple()} with a @code{"O"} argument.
They have the type @ref{14c0,,PyCFunction}, with the `self' parameter, and a
@ref{339,,PyObject}* parameter representing the single argument.
@end deffn

These two constants are not used to indicate the calling convention but the
binding when use with methods of classes.  These may not be used for functions
defined for modules.  At most one of these flags may be set for any given
method.

@geindex METH_CLASS (C macro)
@anchor{c-api/structures c METH_CLASS}@anchor{151d}
@deffn {C Macro} METH_CLASS
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;classmethod

The method will be passed the type object as the first parameter rather
than an instance of the type.  This is used to create `class methods',
similar to what is created when using the @ref{166,,classmethod()} built-in
function.
@end deffn

@geindex METH_STATIC (C macro)
@anchor{c-api/structures c METH_STATIC}@anchor{151e}
@deffn {C Macro} METH_STATIC
` Parte da @ref{553,,ABI Estável}.'
@geindex função embutida;staticmethod

The method will be passed @code{NULL} as the first parameter rather than an
instance of the type.  This is used to create `static methods', similar to
what is created when using the @ref{416,,staticmethod()} built-in function.
@end deffn

One other constant controls whether a method is loaded in place of another
definition with the same method name.

@geindex METH_COEXIST (C macro)
@anchor{c-api/structures c METH_COEXIST}@anchor{14bf}
@deffn {C Macro} METH_COEXIST
` Parte da @ref{553,,ABI Estável}.'
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{1400,,__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_Type (C var)
@anchor{c-api/structures c PyCMethod_Type}@anchor{524e}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCMethod_Type

The type object corresponding to Python C method objects. This is
available as @ref{271a,,types.BuiltinMethodType} in the Python layer.
@end deffn

@geindex PyCMethod_Check (C function)
@anchor{c-api/structures c PyCMethod_Check}@anchor{524f}
@deffn {C Função} int PyCMethod_Check (PyObject *op)

Return true if `op' is an instance of the @ref{524e,,PyCMethod_Type} type
or a subtype of it. This function always succeeds.
@end deffn

@geindex PyCMethod_CheckExact (C function)
@anchor{c-api/structures c PyCMethod_CheckExact}@anchor{5250}
@deffn {C Função} int PyCMethod_CheckExact (PyObject *op)

This is the same as @ref{524f,,PyCMethod_Check()}, but does not account for
subtypes.
@end deffn

@geindex PyCMethod_New (C function)
@anchor{c-api/structures c PyCMethod_New}@anchor{1a37}
@deffn {C Função} @ref{339,,PyObject} *PyCMethod_New (PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Turn `ml' into a Python @ref{2aaf,,callable} object.
The caller must ensure that `ml' outlives the @ref{2aaf,,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{2aaf,,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{675,,None} or @code{NULL}.


@subsubheading Ver também


@ref{208e,,function.__module__}


The `cls' parameter will be passed as the `defining_class'
argument to the C function.
Must be set if @ref{977,,METH_METHOD} is set on @code{ml->ml_flags}.


Adicionado na versão 3.9.

@end deffn

@geindex PyCFunction_Type (C var)
@anchor{c-api/structures c PyCFunction_Type}@anchor{4c28}
@deffn {C Variável} @ref{ab4,,PyTypeObject} PyCFunction_Type
` Parte da @ref{553,,ABI Estável}.'
The type object corresponding to Python C function objects. This is
available as @ref{2719,,types.BuiltinFunctionType} in the Python layer.
@end deffn

@geindex PyCFunction_Check (C function)
@anchor{c-api/structures c PyCFunction_Check}@anchor{5251}
@deffn {C Função} int PyCFunction_Check (PyObject *op)

Return true if `op' is an instance of the @ref{4c28,,PyCFunction_Type} type
or a subtype of it. This function always succeeds.
@end deffn

@geindex PyCFunction_CheckExact (C function)
@anchor{c-api/structures c PyCFunction_CheckExact}@anchor{5252}
@deffn {C Função} int PyCFunction_CheckExact (PyObject *op)

This is the same as @ref{5251,,PyCFunction_Check()}, but does not account for
subtypes.
@end deffn

@geindex PyCFunction_NewEx (C function)
@anchor{c-api/structures c PyCFunction_NewEx}@anchor{1b05}
@deffn {C Função} @ref{339,,PyObject} *PyCFunction_NewEx (PyMethodDef *ml, PyObject *self, PyObject *module)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável}.'
Equivalente a @code{PyCMethod_New(ml, self, module, NULL)}.
@end deffn

@geindex PyCFunction_New (C function)
@anchor{c-api/structures c PyCFunction_New}@anchor{1a3d}
@deffn {C Função} @ref{339,,PyObject} *PyCFunction_New (PyMethodDef *ml, PyObject *self)
`Retorna valor: Nova referência.'` Parte da @ref{553,,ABI Estável} desde a versão 3.4.'
Equivalente a @code{PyCMethod_New(ml, self, NULL, NULL)}.
@end deffn

@geindex PyCFunction_GetFlags (C function)
@anchor{c-api/structures c PyCFunction_GetFlags}@anchor{4c25}
@deffn {C Função} int PyCFunction_GetFlags (PyObject *func)
` Parte da @ref{553,,ABI Estável}.'
Get the function’s flags on `func' as they were passed to
@ref{524c,,ml_flags}.

If `func' is not a C function object, this fails with an exception.
`func' must not be @code{NULL}.

This function returns the function’s flags on success, and @code{-1} with an
exception set on failure.
@end deffn

@geindex PyCFunction_GET_FLAGS (C function)
@anchor{c-api/structures c PyCFunction_GET_FLAGS}@anchor{5253}
@deffn {C Função} int PyCFunction_GET_FLAGS (PyObject *func)

This is the same as @ref{4c25,,PyCFunction_GetFlags()}, but without error
or type checking.
@end deffn

@geindex PyCFunction_GetFunction (C function)
@anchor{c-api/structures c PyCFunction_GetFunction}@anchor{4c26}
@deffn {C Função} @ref{14c0,,PyCFunction} PyCFunction_GetFunction (PyObject *func)
` Parte da @ref{553,,ABI Estável}.'
Get the function pointer on `func' as it was passed to
@ref{524b,,ml_meth}.

If `func' is not a C function object, this fails with an exception.
`func' must not be @code{NULL}.

This function returns the function pointer on success, and @code{NULL} with an
exception set on failure.
@end deffn

@geindex PyCFunction_GET_FUNCTION (C function)
@anchor{c-api/structures c PyCFunction_GET_FUNCTION}@anchor{5254}
@deffn {C Função} int PyCFunction_GET_FUNCTION (PyObject *func)

This is the same as @ref{4c26,,PyCFunction_GetFunction()}, but without error
or type checking.
@end deffn

@geindex PyCFunction_GetSelf (C function)
@anchor{c-api/structures c PyCFunction_GetSelf}@anchor{4c27}
@deffn {C Função} @ref{339,,PyObject} *PyCFunction_GetSelf (PyObject *func)
` Parte da @ref{553,,ABI Estável}.'
Get the “self” object on `func'. This is the object that would be passed
to the first argument of a @ref{14c0,,PyCFunction}. For C function objects
created through a @ref{151f,,PyMethodDef} on a @ref{984,,PyModuleDef}, this
is the resulting module object.

If `func' is not a C function object, this fails with an exception.
`func' must not be @code{NULL}.

This function returns a @ref{33e,,borrowed reference} to the “self” object
on success, and @code{NULL} with an exception set on failure.
@end deffn

@geindex PyCFunction_GET_SELF (C function)
@anchor{c-api/structures c PyCFunction_GET_SELF}@anchor{5255}
@deffn {C Função} @ref{339,,PyObject} *PyCFunction_GET_SELF (PyObject *func)

This is the same as @ref{4c27,,PyCFunction_GetSelf()}, but without error or
type checking.
@end deffn

@node Accessing attributes of extension types,,Implementing functions and methods,Estruturas comuns de objetos
@anchor{c-api/structures accessing-attributes-of-extension-types}@anchor{5256}
@subsubsection Accessing attributes of extension types


@geindex PyMemberDef (C type)
@anchor{c-api/structures c PyMemberDef}@anchor{54f}
@deffn {C Tipo} type PyMemberDef
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
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{4b7b,,tp_members} slot.

Its fields are, in order:

@geindex PyMemberDef.name (C member)
@anchor{c-api/structures c PyMemberDef name}@anchor{5257}
@deffn {C Membro} 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{4b93}
@deffn {C Membro} int type

The type of the member in the C struct.
See @ref{1769,,Member types} for the possible values.
@end deffn

@geindex PyMemberDef.offset (C member)
@anchor{c-api/structures c PyMemberDef offset}@anchor{5258}
@deffn {C Membro} @ref{a69,,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{4b94}
@deffn {C Membro} int flags

Zero or more of the @ref{5259,,Member flags}, combined using bitwise OR.
@end deffn

@geindex PyMemberDef.doc (C member)
@anchor{c-api/structures c PyMemberDef doc}@anchor{525a}
@deffn {C Membro} const char *doc

The docstring, or NULL.
The string should be static, no copy is made of it.
Typically, it is defined using @ref{1921,,PyDoc_STR}.
@end deffn

By default (when @ref{4b94,,flags} is @code{0}), members allow
both read and write access.
Use the @ref{591,,Py_READONLY} flag for read-only access.
Certain types, like @ref{4dd8,,Py_T_STRING}, imply @ref{591,,Py_READONLY}.
Only @ref{594,,Py_T_OBJECT_EX} (and legacy @ref{593,,T_OBJECT}) members can
be deleted.
@anchor{c-api/structures pymemberdef-offsets}@anchor{4f7a}
For heap-allocated types (created using @ref{57d,,PyType_FromSpec()} or similar),
@code{PyMemberDef} may contain a definition for the special member
@code{"__vectorcalloffset__"}, corresponding to
@ref{4f1e,,tp_vectorcall_offset} in type objects.
These must be defined with @code{Py_T_PYSSIZET} and @code{Py_READONLY}, 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{4f79,,tp_dictoffset} and
@ref{98f,,tp_weaklistoffset} can be defined similarly using
@code{"__dictoffset__"} and @code{"__weaklistoffset__"} members, but extensions
are strongly encouraged to use @ref{36b,,Py_TPFLAGS_MANAGED_DICT} and
@ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} instead.


Alterado na versão 3.12: @code{PyMemberDef} is always available.
Previously, it required including @code{"structmember.h"}.

@end deffn

@geindex PyMember_GetOne (C function)
@anchor{c-api/structures c PyMember_GetOne}@anchor{58d}
@deffn {C Função} @ref{339,,PyObject} *PyMember_GetOne (const char *obj_addr, struct PyMemberDef *m)
` Parte da @ref{553,,ABI Estável}.'
Get an attribute belonging to the object at address `obj_addr'.  The
attribute is described by @code{PyMemberDef} `m'.  Returns @code{NULL}
on error.


Alterado na versão 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{58e}
@deffn {C Função} int PyMember_SetOne (char *obj_addr, struct PyMemberDef *m, PyObject *o)
` Parte da @ref{553,,ABI Estável}.'
Set an attribute belonging to the object at address `obj_addr' to object `o'.
The attribute to set is described by @code{PyMemberDef} `m'.  Returns @code{0}
if successful and a negative value on failure.


Alterado na versão 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,,Accessing attributes of extension types
@anchor{c-api/structures member-flags}@anchor{525b}@anchor{c-api/structures pymemberdef-flags}@anchor{5259}
@subsubsection Member flags


The following flags can be used with @ref{4b94,,PyMemberDef.flags}:

@geindex Py_READONLY (C macro)
@anchor{c-api/structures c Py_READONLY}@anchor{591}
@deffn {C Macro} Py_READONLY
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Not writable.
@end deffn

@geindex Py_AUDIT_READ (C macro)
@anchor{c-api/structures c Py_AUDIT_READ}@anchor{592}
@deffn {C Macro} Py_AUDIT_READ
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Emit an @code{object.__getattr__} @ref{199c,,audit event}
before reading.
@end deffn

@geindex Py_RELATIVE_OFFSET (C macro)
@anchor{c-api/structures c Py_RELATIVE_OFFSET}@anchor{54e}
@deffn {C Macro} Py_RELATIVE_OFFSET
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Indicates that the @ref{5258,,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{4b7b,,Py_tp_members}
@ref{4d7b,,slot} when creating a class using negative
@ref{548,,basicsize}.
It is mandatory in that case.

This flag is only used in @ref{4d7b,,PyType_Slot}.
When setting @ref{4b7b,,tp_members} during
class creation, Python clears it and sets
@ref{5258,,PyMemberDef.offset} to the offset from the @code{PyObject} struct.
@end deffn

@geindex READ_RESTRICTED (macro C)
@geindex WRITE_RESTRICTED (macro C)
@geindex RESTRICTED (macro C)


Alterado na versão 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{592,,Py_AUDIT_READ}; @code{WRITE_RESTRICTED} does nothing.


@geindex READONLY (macro C)


Alterado na versão 3.12: The @code{READONLY} macro was renamed to @ref{591,,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,Accessing attributes of extension types
@anchor{c-api/structures member-types}@anchor{525c}@anchor{c-api/structures pymemberdef-types}@anchor{1769}
@subsubsection Member types


@ref{4b93,,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{2c3,,TypeError} or
@ref{202,,ValueError} is raised.

Unless marked (D), attributes defined this way cannot be deleted
using e.g. @ref{18a7,,del} or @ref{22ec,,delattr()}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Macro name

@tab

Tipo em C

@tab

Tipo em Python

@item

@geindex Py_T_BYTE (C macro)
@anchor{c-api/structures c Py_T_BYTE}@anchor{4dd1}
@deffn {C Macro} Py_T_BYTE
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

char

@tab

@ref{257,,int}

@item

@geindex Py_T_SHORT (C macro)
@anchor{c-api/structures c Py_T_SHORT}@anchor{4dd7}
@deffn {C Macro} Py_T_SHORT
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

short

@tab

@ref{257,,int}

@item

@geindex Py_T_INT (C macro)
@anchor{c-api/structures c Py_T_INT}@anchor{58f}
@deffn {C Macro} Py_T_INT
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

int

@tab

@ref{257,,int}

@item

@geindex Py_T_LONG (C macro)
@anchor{c-api/structures c Py_T_LONG}@anchor{4dd4}
@deffn {C Macro} Py_T_LONG
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

long

@tab

@ref{257,,int}

@item

@geindex Py_T_LONGLONG (C macro)
@anchor{c-api/structures c Py_T_LONGLONG}@anchor{4dd5}
@deffn {C Macro} Py_T_LONGLONG
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

long long

@tab

@ref{257,,int}

@item

@geindex Py_T_UBYTE (C macro)
@anchor{c-api/structures c Py_T_UBYTE}@anchor{4dda}
@deffn {C Macro} Py_T_UBYTE
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

unsigned char

@tab

@ref{257,,int}

@item

@geindex Py_T_UINT (C macro)
@anchor{c-api/structures c Py_T_UINT}@anchor{4ddb}
@deffn {C Macro} Py_T_UINT
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

unsigned int

@tab

@ref{257,,int}

@item

@geindex Py_T_USHORT (C macro)
@anchor{c-api/structures c Py_T_USHORT}@anchor{4dde}
@deffn {C Macro} Py_T_USHORT
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

unsigned short

@tab

@ref{257,,int}

@item

@geindex Py_T_ULONG (C macro)
@anchor{c-api/structures c Py_T_ULONG}@anchor{4ddc}
@deffn {C Macro} Py_T_ULONG
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

unsigned long

@tab

@ref{257,,int}

@item

@geindex Py_T_ULONGLONG (C macro)
@anchor{c-api/structures c Py_T_ULONGLONG}@anchor{4ddd}
@deffn {C Macro} Py_T_ULONGLONG
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

unsigned long long

@tab

@ref{257,,int}

@item

@geindex Py_T_PYSSIZET (C macro)
@anchor{c-api/structures c Py_T_PYSSIZET}@anchor{4dd6}
@deffn {C Macro} Py_T_PYSSIZET
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

@ref{a69,,Py_ssize_t}

@tab

@ref{257,,int}

@item

@geindex Py_T_FLOAT (C macro)
@anchor{c-api/structures c Py_T_FLOAT}@anchor{4dd3}
@deffn {C Macro} Py_T_FLOAT
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

float

@tab

@ref{2f7,,float}

@item

@geindex Py_T_DOUBLE (C macro)
@anchor{c-api/structures c Py_T_DOUBLE}@anchor{590}
@deffn {C Macro} Py_T_DOUBLE
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

double

@tab

@ref{2f7,,float}

@item

@geindex Py_T_BOOL (C macro)
@anchor{c-api/structures c Py_T_BOOL}@anchor{4dd0}
@deffn {C Macro} Py_T_BOOL
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

char (escrito como 0 ou 1)

@tab

@ref{468,,bool}

@item

@geindex Py_T_STRING (C macro)
@anchor{c-api/structures c Py_T_STRING}@anchor{4dd8}
@deffn {C Macro} Py_T_STRING
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

const char* (*)

@tab

@ref{44c,,str} (RO)

@item

@geindex Py_T_STRING_INPLACE (C macro)
@anchor{c-api/structures c Py_T_STRING_INPLACE}@anchor{4dd9}
@deffn {C Macro} Py_T_STRING_INPLACE
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

const char[] (*)

@tab

@ref{44c,,str} (RO)

@item

@geindex Py_T_CHAR (C macro)
@anchor{c-api/structures c Py_T_CHAR}@anchor{4dd2}
@deffn {C Macro} Py_T_CHAR
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

char (0-127)

@tab

@ref{44c,,str} (**)

@item

@geindex Py_T_OBJECT_EX (C macro)
@anchor{c-api/structures c Py_T_OBJECT_EX}@anchor{594}
@deffn {C Macro} Py_T_OBJECT_EX
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@tab

@ref{339,,PyObject}*

@tab

@ref{a96,,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): implica @ref{591,,Py_READONLY}.

(D): pode ser deletado, neste caso o ponteiro é definido para @code{NULL}. Ler um ponteiro @code{NULL} levanta uma exceção @ref{34b,,AttributeError}.
@end quotation

@geindex T_BYTE (macro C)
@geindex T_SHORT (macro C)
@geindex T_INT (macro C)
@geindex T_LONG (macro C)
@geindex T_LONGLONG (macro C)
@geindex T_UBYTE (macro C)
@geindex T_USHORT (macro C)
@geindex T_UINT (macro C)
@geindex T_ULONG (macro C)
@geindex T_ULONGULONG (macro C)
@geindex T_PYSSIZET (macro C)
@geindex T_FLOAT (macro C)
@geindex T_DOUBLE (macro C)
@geindex T_BOOL (macro C)
@geindex T_CHAR (macro C)
@geindex T_STRING (macro C)
@geindex T_STRING_INPLACE (macro C)
@geindex T_OBJECT_EX (macro C)
@geindex structmember.h


Adicionado na versão 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{593}
@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{595}
@deffn {C Macro} T_NONE

Sempre @code{None}. Deve ser usado com  @ref{591,,Py_READONLY}.
@end deffn


@node Defining Getters and Setters,,Member types,Accessing attributes of extension types
@anchor{c-api/structures defining-getters-and-setters}@anchor{525d}
@subsubsection Defining Getters and Setters


@geindex PyGetSetDef (C type)
@anchor{c-api/structures c PyGetSetDef}@anchor{bd1}
@deffn {C Tipo} type PyGetSetDef
` Parte da @ref{553,,ABI Estável} (incluindo todos os membros).'
Structure to define property-like access for a type. See also description of
the @ref{4b80,,PyTypeObject.tp_getset} slot.

@geindex PyGetSetDef.name (C member)
@anchor{c-api/structures c PyGetSetDef name}@anchor{525e}
@deffn {C Membro} const char *name

attribute name
@end deffn

@geindex PyGetSetDef.get (C member)
@anchor{c-api/structures c PyGetSetDef get}@anchor{525f}
@deffn {C Membro} @ref{4e3d,,getter} get

C function to get the attribute.
@end deffn

@geindex PyGetSetDef.set (C member)
@anchor{c-api/structures c PyGetSetDef set}@anchor{5260}
@deffn {C Membro} @ref{4e4b,,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{5261}
@deffn {C Membro} const char *doc

optional docstring
@end deffn

@geindex PyGetSetDef.closure (C member)
@anchor{c-api/structures c PyGetSetDef closure}@anchor{5262}
@deffn {C Membro} 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{4e3d}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*getter)(@ref{339,,PyObject}*, void*)
` Parte da @ref{553,,ABI Estável}.'
The @code{get} function takes one @ref{339,,PyObject}* parameter (the
instance) and a user data pointer (the associated @code{closure}):

It should return a new reference on success or @code{NULL} with a set exception
on failure.
@end deffn

@geindex setter (C type)
@anchor{c-api/structures c setter}@anchor{4e4b}
@deffn {C Tipo} typedef int (*setter)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, void*)
` Parte da @ref{553,,ABI Estável}.'
@code{set} functions take two @ref{339,,PyObject}* parameters (the instance and
the value to be set) and a user data pointer (the associated @code{closure}):

In case the attribute should be deleted the second parameter is @code{NULL}.
Should return @code{0} on success or @code{-1} with a set exception on failure.
@end deffn

@node Estruturas de objetos tipo,Suporte a Coleta Cíclica de Lixo,Estruturas comuns de objetos,Suporte a implementação de Objetos
@anchor{c-api/typeobj doc}@anchor{5263}@anchor{c-api/typeobj translation-repo}@anchor{5264}@anchor{c-api/typeobj type-object-structures}@anchor{5265}@anchor{c-api/typeobj type-structs}@anchor{994}
@subsection Estruturas de objetos tipo


Talvez uma das estruturas mais importantes do sistema de objetos Python seja a estrutura que define um novo tipo: a estrutura @ref{ab4,,PyTypeObject}. Objetos tipo podem ser manipulados usando qualquer uma das funções @code{PyObject_*} ou @code{PyType_*}, mas não oferecem muito de interessante para a maioria das aplicações Python. Esses objetos são fundamentais para o comportamento dos objetos, portanto, são muito importantes para o próprio interpretador e para qualquer módulo de extensão que implemente novos tipos.

Os objetos tipo são bastante grandes em comparação com a maioria dos tipos padrão. A razão para o tamanho é que cada objeto de tipo armazena um grande número de valores, principalmente indicadores de função C, cada um dos quais implementa uma pequena parte da funcionalidade do tipo. Os campos do objeto de tipo são examinados em detalhes nesta seção. Os campos serão descritos na ordem em que ocorrem na estrutura.

Além da referência rápida a seguir, a seção @ref{5266,,Exemplos} fornece uma visão geral do significado e uso de @ref{ab4,,PyTypeObject}.

@menu
* Referências rápidas:: 
* PyTypeObject Definition:: 
* PyObject Slots:: 
* PyVarObject Slots:: 
* PyTypeObject Slots:: 
* Static Types:: 
* Tipos no heap:: 
* Number Object Structures:: 
* Mapping Object Structures:: 
* Sequence Object Structures:: 
* Buffer Object Structures:: 
* Async Object Structures:: 
* Slot Type typedefs:: 
* Exemplos: Exemplos<38>. 

@end menu

@node Referências rápidas,PyTypeObject Definition,,Estruturas de objetos tipo
@anchor{c-api/typeobj quick-reference}@anchor{5267}
@subsubsection Referências rápidas


@menu
* “slots tp”:: 
* sub-slots:: 
* slot typedefs:: 

@end menu

@node “slots tp”,sub-slots,,Referências rápidas
@anchor{c-api/typeobj tp-slots}@anchor{5268}@anchor{c-api/typeobj tp-slots-table}@anchor{5269}
@subsubsection “slots tp”



@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxx} {xxx} {xxx} {xxx} 
@headitem

Slot de PyTypeObject @footnote{
`()': Um nome de slot entre parênteses indica que está (efetivamente) descontinuado.

`<>': 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{526a,,Tipo}

@tab

métodos/atributos especiais

@tab

Info @footnote{
Columns:

`“O”':  set on @ref{4c0e,,PyBaseObject_Type}

`“T”':  set on @ref{54d,,PyType_Type}

`“D”':  default (if slot is set to @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”':  inheritance

@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

Note that some slots are effectively inherited through the normal
attribute lookup chain.
}

@tab

@tab

@tab

@item

O

@tab

T

@tab

D

@tab

I

@item

<R> @ref{1a3c,,tp_name}

@tab

const char *

@tab

__name__

@tab

X

@tab

X

@tab

@tab

@item

@ref{98e,,tp_basicsize}

@tab

@ref{a69,,Py_ssize_t}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{20fd,,tp_itemsize}

@tab

@ref{a69,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

@ref{4b66,,tp_dealloc}

@tab

@ref{4e38,,destructor}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{4f1e,,tp_vectorcall_offset}

@tab

@ref{a69,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

(@ref{4b96,,tp_getattr})

@tab

@ref{4e39,,getattrfunc}

@tab

__getattribute__,
__getattr__

@tab

@tab

@tab

@tab

G

@item

(@ref{4b97,,tp_setattr})

@tab

@ref{4e49,,setattrfunc}

@tab

__setattr__,
__delattr__

@tab

@tab

@tab

@tab

G

@item

@ref{efe,,tp_as_async}

@tab

@ref{4f77,,PyAsyncMethods} *

@tab

@ref{526b,,sub-slots}

@tab

@tab

@tab

@tab

%

@item

@ref{4b8d,,tp_repr}

@tab

@ref{4e47,,reprfunc}

@tab

__repr__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{992,,tp_as_number}

@tab

@ref{1465,,PyNumberMethods} *

@tab

@ref{526b,,sub-slots}

@tab

@tab

@tab

@tab

%

@item

@ref{526c,,tp_as_sequence}

@tab

@ref{4b9d,,PySequenceMethods} *

@tab

@ref{526b,,sub-slots}

@tab

@tab

@tab

@tab

%

@item

@ref{526d,,tp_as_mapping}

@tab

@ref{4b9e,,PyMappingMethods} *

@tab

@ref{526b,,sub-slots}

@tab

@tab

@tab

@tab

%

@item

@ref{4b9f,,tp_hash}

@tab

@ref{4e3e,,hashfunc}

@tab

__hash__

@tab

X

@tab

@tab

@tab

G

@item

@ref{559,,tp_call}

@tab

@ref{4e4e,,ternaryfunc}

@tab

__call__

@tab

@tab

X

@tab

@tab

X

@item

@ref{4b8e,,tp_str}

@tab

@ref{4e47,,reprfunc}

@tab

__str__

@tab

X

@tab

@tab

@tab

X

@item

@ref{17e6,,tp_getattro}

@tab

@ref{4e3a,,getattrofunc}

@tab

__getattribute__,
__getattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{4b91,,tp_setattro}

@tab

@ref{4e4a,,setattrofunc}

@tab

__setattr__,
__delattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{990,,tp_as_buffer}

@tab

@ref{4f7f,,PyBufferProcs} *

@tab

@ref{526b,,sub-slots}

@tab

@tab

@tab

@tab

%

@item

@ref{19fd,,tp_flags}

@tab

unsigned long

@tab

@tab

X

@tab

X

@tab

@tab

?

@item

@ref{4b75,,tp_doc}

@tab

const char *

@tab

__doc__

@tab

X

@tab

X

@tab

@tab

@item

@ref{77e,,tp_traverse}

@tab

@ref{4e4f,,traverseproc}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4b8b,,tp_clear}

@tab

@ref{4e40,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4b99,,tp_richcompare}

@tab

@ref{4e48,,richcmpfunc}

@tab

__lt__,
__le__,
__eq__,
__ne__,
__gt__,
__ge__

@tab

X

@tab

@tab

@tab

G

@item

(@ref{98f,,tp_weaklistoffset})

@tab

@ref{a69,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{1537,,tp_iter}

@tab

@ref{4e3c,,getiterfunc}

@tab

__iter__

@tab

@tab

@tab

@tab

X

@item

@ref{1538,,tp_iternext}

@tab

@ref{4e41,,iternextfunc}

@tab

__next__

@tab

@tab

@tab

@tab

X

@item

@ref{4b7d,,tp_methods}

@tab

@ref{151f,,PyMethodDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{4b7b,,tp_members}

@tab

@ref{54f,,PyMemberDef} []

@tab

@tab

@tab

X

@tab

@tab

@item

@ref{4b80,,tp_getset}

@tab

@ref{bd1,,PyGetSetDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{20b8,,tp_base}

@tab

@ref{ab4,,PyTypeObject} *

@tab

__base__

@tab

@tab

@tab

X

@tab

@item

@ref{180e,,tp_dict}

@tab

@ref{339,,PyObject} *

@tab

__dict__

@tab

@tab

@tab

?

@tab

@item

@ref{526e,,tp_descr_get}

@tab

@ref{4e36,,descrgetfunc}

@tab

__get__

@tab

@tab

@tab

@tab

X

@item

@ref{1a40,,tp_descr_set}

@tab

@ref{4e37,,descrsetfunc}

@tab

__set__,
__delete__

@tab

@tab

@tab

@tab

X

@item

(@ref{4f79,,tp_dictoffset})

@tab

@ref{a69,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{581,,tp_init}

@tab

@ref{4e3f,,initproc}

@tab

__init__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{4b7a,,tp_alloc}

@tab

@ref{4e34,,allocfunc}

@tab

@tab

X

@tab

@tab

?

@tab

?

@item

@ref{57f,,tp_new}

@tab

@ref{4e43,,newfunc}

@tab

__new__

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{4b79,,tp_free}

@tab

@ref{50bf,,freefunc}

@tab

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{526f,,tp_is_gc}

@tab

@ref{4e40,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

X

@item

<@ref{5270,,tp_bases}>

@tab

@ref{339,,PyObject} *

@tab

__bases__

@tab

@tab

@tab

~

@tab

@item

<@ref{4f7c,,tp_mro}>

@tab

@ref{339,,PyObject} *

@tab

__mro__

@tab

@tab

@tab

~

@tab

@item

[@ref{4f7d,,tp_cache}]

@tab

@ref{339,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

[@ref{572,,tp_subclasses}]

@tab

void *

@tab

__subclasses__

@tab

@tab

@tab

@tab

@item

[@ref{4f7e,,tp_weaklist}]

@tab

@ref{339,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

(@ref{5271,,tp_del})

@tab

@ref{4e38,,destructor}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{5272,,tp_version_tag}]

@tab

unsigned int

@tab

@tab

@tab

@tab

@tab

@item

@ref{ab5,,tp_finalize}

@tab

@ref{4e38,,destructor}

@tab

__del__

@tab

@tab

@tab

@tab

X

@item

@ref{4f7b,,tp_vectorcall}

@tab

@ref{557,,vectorcallfunc}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{5273,,tp_watched}]

@tab

unsigned char

@tab

@tab

@tab

@tab

@tab

@end multitable


@node sub-slots,slot typedefs,“slots tp”,Referências rápidas
@anchor{c-api/typeobj id3}@anchor{5274}@anchor{c-api/typeobj sub-slots}@anchor{526b}
@subsubsection sub-slots



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Slot

@tab

@ref{526a,,Tipo}

@tab

special
methods

@item

@ref{5275,,am_await}

@tab

@ref{4e50,,unaryfunc}

@tab

__await__

@item

@ref{5276,,am_aiter}

@tab

@ref{4e50,,unaryfunc}

@tab

__aiter__

@item

@ref{5277,,am_anext}

@tab

@ref{4e50,,unaryfunc}

@tab

__anext__

@item

@ref{5278,,am_send}

@tab

@ref{5279,,sendfunc}

@tab

@item

@tab

@tab

@item

@ref{4f6e,,nb_add}

@tab

@ref{4e35,,binaryfunc}

@tab

__add__
__radd__

@item

@ref{527a,,nb_inplace_add}

@tab

@ref{4e35,,binaryfunc}

@tab

__iadd__

@item

@ref{527b,,nb_subtract}

@tab

@ref{4e35,,binaryfunc}

@tab

__sub__
__rsub__

@item

@ref{527c,,nb_inplace_subtract}

@tab

@ref{4e35,,binaryfunc}

@tab

__isub__

@item

@ref{527d,,nb_multiply}

@tab

@ref{4e35,,binaryfunc}

@tab

__mul__
__rmul__

@item

@ref{527e,,nb_inplace_multiply}

@tab

@ref{4e35,,binaryfunc}

@tab

__imul__

@item

@ref{527f,,nb_remainder}

@tab

@ref{4e35,,binaryfunc}

@tab

__mod__
__rmod__

@item

@ref{5280,,nb_inplace_remainder}

@tab

@ref{4e35,,binaryfunc}

@tab

__imod__

@item

@ref{5281,,nb_divmod}

@tab

@ref{4e35,,binaryfunc}

@tab

__divmod__
__rdivmod__

@item

@ref{5282,,nb_power}

@tab

@ref{4e4e,,ternaryfunc}

@tab

__pow__
__rpow__

@item

@ref{5283,,nb_inplace_power}

@tab

@ref{4e4e,,ternaryfunc}

@tab

__ipow__

@item

@ref{5284,,nb_negative}

@tab

@ref{4e50,,unaryfunc}

@tab

__neg__

@item

@ref{5285,,nb_positive}

@tab

@ref{4e50,,unaryfunc}

@tab

__pos__

@item

@ref{5286,,nb_absolute}

@tab

@ref{4e50,,unaryfunc}

@tab

__abs__

@item

@ref{5287,,nb_bool}

@tab

@ref{4e40,,inquiry}

@tab

__bool__

@item

@ref{5288,,nb_invert}

@tab

@ref{4e50,,unaryfunc}

@tab

__invert__

@item

@ref{5289,,nb_lshift}

@tab

@ref{4e35,,binaryfunc}

@tab

__lshift__
__rlshift__

@item

@ref{528a,,nb_inplace_lshift}

@tab

@ref{4e35,,binaryfunc}

@tab

__ilshift__

@item

@ref{528b,,nb_rshift}

@tab

@ref{4e35,,binaryfunc}

@tab

__rshift__
__rrshift__

@item

@ref{528c,,nb_inplace_rshift}

@tab

@ref{4e35,,binaryfunc}

@tab

__irshift__

@item

@ref{528d,,nb_and}

@tab

@ref{4e35,,binaryfunc}

@tab

__and__
__rand__

@item

@ref{528e,,nb_inplace_and}

@tab

@ref{4e35,,binaryfunc}

@tab

__iand__

@item

@ref{528f,,nb_xor}

@tab

@ref{4e35,,binaryfunc}

@tab

__xor__
__rxor__

@item

@ref{5290,,nb_inplace_xor}

@tab

@ref{4e35,,binaryfunc}

@tab

__ixor__

@item

@ref{5291,,nb_or}

@tab

@ref{4e35,,binaryfunc}

@tab

__or__
__ror__

@item

@ref{5292,,nb_inplace_or}

@tab

@ref{4e35,,binaryfunc}

@tab

__ior__

@item

@ref{5293,,nb_int}

@tab

@ref{4e50,,unaryfunc}

@tab

__int__

@item

@ref{5294,,nb_reserved}

@tab

void *

@tab

@item

@ref{5295,,nb_float}

@tab

@ref{4e50,,unaryfunc}

@tab

__float__

@item

@ref{5296,,nb_floor_divide}

@tab

@ref{4e35,,binaryfunc}

@tab

__floordiv__

@item

@ref{5297,,nb_inplace_floor_divide}

@tab

@ref{4e35,,binaryfunc}

@tab

__ifloordiv__

@item

@ref{5298,,nb_true_divide}

@tab

@ref{4e35,,binaryfunc}

@tab

__truediv__

@item

@ref{5299,,nb_inplace_true_divide}

@tab

@ref{4e35,,binaryfunc}

@tab

__itruediv__

@item

@ref{1464,,nb_index}

@tab

@ref{4e50,,unaryfunc}

@tab

__index__

@item

@ref{529a,,nb_matrix_multiply}

@tab

@ref{4e35,,binaryfunc}

@tab

__matmul__
__rmatmul__

@item

@ref{529b,,nb_inplace_matrix_multiply}

@tab

@ref{4e35,,binaryfunc}

@tab

__imatmul__

@item

@tab

@tab

@item

@ref{529c,,mp_length}

@tab

@ref{4e42,,lenfunc}

@tab

__len__

@item

@ref{1a83,,mp_subscript}

@tab

@ref{4e35,,binaryfunc}

@tab

__getitem__

@item

@ref{529d,,mp_ass_subscript}

@tab

@ref{4e44,,objobjargproc}

@tab

__setitem__,
__delitem__

@item

@tab

@tab

@item

@ref{4f78,,sq_length}

@tab

@ref{4e42,,lenfunc}

@tab

__len__

@item

@ref{529e,,sq_concat}

@tab

@ref{4e35,,binaryfunc}

@tab

__add__

@item

@ref{529f,,sq_repeat}

@tab

@ref{4e4c,,ssizeargfunc}

@tab

__mul__

@item

@ref{1a82,,sq_item}

@tab

@ref{4e4c,,ssizeargfunc}

@tab

__getitem__

@item

@ref{52a0,,sq_ass_item}

@tab

@ref{4e4d,,ssizeobjargproc}

@tab

__setitem__
__delitem__

@item

@ref{52a1,,sq_contains}

@tab

@ref{4e45,,objobjproc}

@tab

__contains__

@item

@ref{52a2,,sq_inplace_concat}

@tab

@ref{4e35,,binaryfunc}

@tab

__iadd__

@item

@ref{52a3,,sq_inplace_repeat}

@tab

@ref{4e4c,,ssizeargfunc}

@tab

__imul__

@item

@tab

@tab

@item

@ref{762,,bf_getbuffer}

@tab

@ref{4e3b,,getbufferproc()}

@tab

__buffer__

@item

@ref{763,,bf_releasebuffer}

@tab

@ref{4e46,,releasebufferproc()}

@tab

__release_buffer__

@end multitable


@node slot typedefs,,sub-slots,Referências rápidas
@anchor{c-api/typeobj slot-typedefs}@anchor{52a4}@anchor{c-api/typeobj slot-typedefs-table}@anchor{526a}
@subsubsection slot typedefs



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

typedef

@tab

Parameter Types

@tab

Return Type

@item

@ref{4e34,,allocfunc}

@tab


@display
@ref{ab4,,PyTypeObject} *@w{ }
@ref{a69,,Py_ssize_t}@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e38,,destructor}

@tab

@ref{339,,PyObject} *

@tab

void

@item

@ref{50bf,,freefunc}

@tab

void *

@tab

void

@item

@ref{4e4f,,traverseproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{4e51,,visitproc}@w{ }
void *@w{ }
@end display



@tab

int

@item

@ref{4e43,,newfunc}

@tab


@display
@ref{ab4,,PyTypeObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e3f,,initproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e47,,reprfunc}

@tab

@ref{339,,PyObject} *

@tab

@ref{339,,PyObject} *

@item

@ref{4e39,,getattrfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
const char *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e49,,setattrfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
const char *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e3a,,getattrofunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e4a,,setattrofunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e36,,descrgetfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e37,,descrsetfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e3e,,hashfunc}

@tab

@ref{339,,PyObject} *

@tab

Py_hash_t

@item

@ref{4e48,,richcmpfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
int@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e3c,,getiterfunc}

@tab

@ref{339,,PyObject} *

@tab

@ref{339,,PyObject} *

@item

@ref{4e41,,iternextfunc}

@tab

@ref{339,,PyObject} *

@tab

@ref{339,,PyObject} *

@item

@ref{4e42,,lenfunc}

@tab

@ref{339,,PyObject} *

@tab

@ref{a69,,Py_ssize_t}

@item

@ref{4e3b,,getbufferproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{758,,Py_buffer} *@w{ }
int@w{ }
@end display



@tab

int

@item

@ref{4e46,,releasebufferproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{758,,Py_buffer} *@w{ }
@end display



@tab

void

@item

@ref{4e40,,inquiry}

@tab

@ref{339,,PyObject} *

@tab

int

@item

@ref{4e50,,unaryfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e35,,binaryfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e4e,,ternaryfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e4c,,ssizeargfunc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{a69,,Py_ssize_t}@w{ }
@end display



@tab

@ref{339,,PyObject} *

@item

@ref{4e4d,,ssizeobjargproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{a69,,Py_ssize_t}@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e45,,objobjproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{4e44,,objobjargproc}

@tab


@display
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@ref{339,,PyObject} *@w{ }
@end display



@tab

int

@end multitable


See @ref{52a5,,Slot Type typedefs} below for more detail.

@node PyTypeObject Definition,PyObject Slots,Referências rápidas,Estruturas de objetos tipo
@anchor{c-api/typeobj pytypeobject-definition}@anchor{52a6}
@subsubsection PyTypeObject Definition


The structure definition for @ref{ab4,,PyTypeObject} can be found in
@code{Include/cpython/object.h}.  For convenience of reference, this repeats the
definition found there:

@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 PyObject Slots,PyVarObject Slots,PyTypeObject Definition,Estruturas de objetos tipo
@anchor{c-api/typeobj pyobject-slots}@anchor{52a7}
@subsubsection PyObject Slots


The type object structure extends the @ref{4384,,PyVarObject} structure. The
@ref{4dba,,ob_size} field is used for dynamic types (created by @code{type_new()},
usually called from a class statement). Note that @ref{54d,,PyType_Type} (the
metatype) initializes @ref{20fd,,tp_itemsize}, which means that its instances (i.e.
type objects) `must' have the @ref{4dba,,ob_size} field.

@geindex PyObject.ob_refcnt (C member)
@anchor{c-api/typeobj c PyObject ob_refcnt}@anchor{8a3}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{339,,PyObject}.ob_refcnt
` Parte da @ref{553,,ABI Estável}.'
This is the type object’s reference count, initialized to @code{1} by the
@code{PyObject_HEAD_INIT} macro.  Note that for @ref{77f,,statically allocated type objects}, the type’s instances (objects whose @ref{4b77,,ob_type}
points back to the type) do `not' count as references.  But for
@ref{96c,,dynamically allocated type objects}, the instances `do'
count as references.

`Inheritance:'

This field is not inherited by subtypes.
@end deffn

@geindex PyObject.ob_type (C member)
@anchor{c-api/typeobj c PyObject ob_type}@anchor{4b77}
@deffn {C Membro} @ref{ab4,,PyTypeObject} *@ref{339,,PyObject}.ob_type
` Parte da @ref{553,,ABI Estável}.'
This is the type’s type, in other words its metatype.  It is initialized by the
argument to the @code{PyObject_HEAD_INIT} macro, and its value should normally be
@code{&PyType_Type}.  However, for dynamically loadable extension modules that must
be usable on Windows (at least), the compiler complains that this is not a valid
initializer.  Therefore, the convention is to pass @code{NULL} to the
@code{PyObject_HEAD_INIT} macro and to initialize this field explicitly at the
start of the module’s initialization function, before doing anything else.  This
is typically done like this:

@example
Foo_Type.ob_type = &PyType_Type;
@end example

This should be done before any instances of the type are created.
@ref{77c,,PyType_Ready()} checks if @ref{4b77,,ob_type} is @code{NULL}, and if so,
initializes it to the @ref{4b77,,ob_type} field of the base class.
@ref{77c,,PyType_Ready()} will not change this field if it is non-zero.

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@node PyVarObject Slots,PyTypeObject Slots,PyObject Slots,Estruturas de objetos tipo
@anchor{c-api/typeobj pyvarobject-slots}@anchor{52a8}
@subsubsection PyVarObject Slots


@geindex PyVarObject.ob_size (C member)
@anchor{c-api/typeobj c PyVarObject ob_size}@anchor{4dba}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{4384,,PyVarObject}.ob_size
` Parte da @ref{553,,ABI Estável}.'
For @ref{77f,,statically allocated type objects}, this should be
initialized to zero. For @ref{96c,,dynamically allocated type objects}, this field has a special internal meaning.

This field should be accessed using the @ref{782,,Py_SIZE()} and
@ref{783,,Py_SET_SIZE()} macros.

`Inheritance:'

This field is not inherited by subtypes.
@end deffn

@node PyTypeObject Slots,Static Types,PyVarObject Slots,Estruturas de objetos tipo
@anchor{c-api/typeobj pytypeobject-slots}@anchor{52a9}
@subsubsection PyTypeObject Slots


Each slot has a section describing inheritance.  If @ref{77c,,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 @ref{4c0e,,PyBaseObject_Type}
and @ref{54d,,PyType_Type} effectively act as defaults.)

@geindex PyTypeObject.tp_name (C member)
@anchor{c-api/typeobj c PyTypeObject tp_name}@anchor{1a3c}
@deffn {C Membro} const char *@ref{ab4,,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{1a3c,,tp_name} initializer @code{"P.Q.M.T"}.

For @ref{96c,,dynamically allocated type objects},
this should just be the type name, and
the module name explicitly stored in the type dict as the value for key
@code{'__module__'}.

For @ref{77f,,statically allocated type objects},
the `tp_name' field should contain a dot.
Everything before the last dot is made accessible as the @ref{374,,__module__}
attribute, and everything after the last dot is made accessible as the
@ref{14f3,,__name__} attribute.

If no dot is present, the entire @ref{1a3c,,tp_name} field is made accessible as the
@ref{14f3,,__name__} attribute, and the @ref{374,,__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.

This field must not be @code{NULL}.  It is the only required field
in @ref{ab4,,PyTypeObject()} (other than potentially
@ref{20fd,,tp_itemsize}).

`Inheritance:'

This field is not inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_basicsize (C member)
@geindex PyTypeObject.tp_itemsize (C member)
@anchor{c-api/typeobj c PyTypeObject tp_basicsize}@anchor{98e}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{ab4,,PyTypeObject}.tp_basicsize
@anchor{c-api/typeobj c PyTypeObject tp_itemsize}@anchor{20fd}
@deffnx {C Membro} @ref{a69,,Py_ssize_t} @ref{ab4,,PyTypeObject}.tp_itemsize

These fields allow calculating the size in bytes of instances of the type.

There are two kinds of types: types with fixed-length instances have a zero
@code{tp_itemsize} field, types with variable-length instances have a non-zero
@code{tp_itemsize} field.  For a type with fixed-length instances, all
instances have the same size, given in @code{tp_basicsize}.
(Exceptions to this rule can be made using
@ref{182d,,PyUnstable_Object_GC_NewWithExtraData()}.)

For a type with variable-length instances, the instances must have an
@ref{4dba,,ob_size} field, and the instance size is
@code{tp_basicsize} plus N times @code{tp_itemsize},
where N is the “length” of the object.

Functions like @ref{98d,,PyObject_NewVar()} will take the value of N as an
argument, and store in the instance’s @ref{4dba,,ob_size} field.
Note that the @ref{4dba,,ob_size} field may later be used for
other purposes. For example, @ref{257,,int} instances use the bits of
@ref{4dba,,ob_size} in an implementation-defined
way; the underlying storage and its size should be accessed using
@code{PyLong_Export()}.

@cartouche
@quotation Nota 
The @ref{4dba,,ob_size} field should be accessed using
the @ref{782,,Py_SIZE()} and @ref{783,,Py_SET_SIZE()} macros.
@end quotation
@end cartouche

Also, the presence of an @ref{4dba,,ob_size} field in the
instance layout doesn’t mean that the instance structure is variable-length.
For example, the @ref{611,,list} type has fixed-length instances, yet those
instances have a @ref{4dba,,ob_size} field.
(As with @ref{257,,int}, avoid reading lists’ @code{ob_size} directly.
Call @ref{1461,,PyList_Size()} instead.)

The @code{tp_basicsize} includes size needed for data of the type’s
@ref{20b8,,tp_base}, plus any extra data needed
by each instance.

The  correct way to set @code{tp_basicsize} is to use the
@code{sizeof} operator on the struct used to declare the instance layout.
This struct must include the struct used to declare the base type.
In other words, @code{tp_basicsize} must be greater than or equal
to the base’s @code{tp_basicsize}.

Since every type is a subtype of @ref{a96,,object}, this struct must
include @ref{339,,PyObject} or @ref{4384,,PyVarObject} (depending on
whether @ref{4dba,,ob_size} should be included). These are
usually defined by the macro @ref{1321,,PyObject_HEAD} or
@ref{5245,,PyObject_VAR_HEAD}, respectively.

The basic size does not include the GC header size, as that header is not
part of @ref{1321,,PyObject_HEAD}.

For cases where struct used to declare the base type is unknown,
see @ref{548,,PyType_Spec.basicsize} and @ref{550,,PyType_FromMetaclass()}.

Notes about alignment:


@itemize -

@item 
@code{tp_basicsize} must be a multiple of @code{_Alignof(PyObject)}.
When using @code{sizeof} on a @code{struct} that includes
@ref{1321,,PyObject_HEAD}, as recommended, the compiler ensures this.
When not using a C @code{struct}, or when using compiler
extensions like @code{__attribute__((packed))}, it is up to you.

@item 
If the variable items require a particular alignment,
@code{tp_basicsize} and @code{tp_itemsize} must each be a
multiple of that alignment.
For example, if a type’s variable part stores a @code{double}, it is
your responsibility that both fields are a multiple of
@code{_Alignof(double)}.
@end itemize

`Inheritance:'

These fields are inherited separately by subtypes.
(That is, if the field is set to zero, @ref{77c,,PyType_Ready()} will copy
the value from the base type, indicating that the instances do not
need additional storage.)

If the base type has a non-zero @ref{20fd,,tp_itemsize}, it is generally not safe to set
@ref{20fd,,tp_itemsize} to a different non-zero value in a subtype (though this
depends on the implementation of the base type).
@end deffn

@geindex PyTypeObject.tp_dealloc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dealloc}@anchor{4b66}
@deffn {C Membro} @ref{4e38,,destructor} @ref{ab4,,PyTypeObject}.tp_dealloc

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_dealloc} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_dealloc (C macro)
@anchor{c-api/typeobj c Py_tp_dealloc}@anchor{4e1c}

A pointer to the instance destructor function.  This function must be defined
unless the type guarantees that its instances will never be deallocated (as is
the case for the singletons @code{None} and @code{Ellipsis}).  The function signature is:

@example
void tp_dealloc(PyObject *self);
@end example

The destructor function is called by the @ref{56f,,Py_DECREF()} and
@ref{78f,,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{4b79,,tp_free} function.  If the type is not subtypable
(doesn’t have the @ref{4b7e,,Py_TPFLAGS_BASETYPE} flag bit set), it is
permissible to call the object deallocator directly instead of via
@ref{4b79,,tp_free}.  The object deallocator should be the one used to allocate the
instance; this is normally @ref{1519,,PyObject_Del()} if the instance was allocated
using @ref{98c,,PyObject_New} or @ref{98d,,PyObject_NewVar}, or
@ref{154c,,PyObject_GC_Del()} if the instance was allocated using
@ref{ab1,,PyObject_GC_New} or @ref{ab2,,PyObject_GC_NewVar}.

If the type supports garbage collection (has the @ref{77d,,Py_TPFLAGS_HAVE_GC}
flag bit set), the destructor should call @ref{154e,,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{8b4,,Py_TPFLAGS_HEAPTYPE}), the
deallocator should release the owned reference to its type object
(via @ref{56f,,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 Aviso 
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

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_vectorcall_offset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_vectorcall_offset}@anchor{4f1e}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{ab4,,PyTypeObject}.tp_vectorcall_offset

An optional offset to a per-instance function that implements calling
the object using the @ref{552,,vectorcall protocol},
a more efficient alternative
of the simpler @ref{559,,tp_call}.

This field is only used if the flag @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL}
is set. If so, this must be a positive integer containing the offset in the
instance of a @ref{557,,vectorcallfunc} pointer.

The `vectorcallfunc' pointer may be @code{NULL}, in which case the instance behaves
as if @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} was not set: calling the instance
falls back to @ref{559,,tp_call}.

Any class that sets @code{Py_TPFLAGS_HAVE_VECTORCALL} must also set
@ref{559,,tp_call} and make sure its behaviour is consistent
with the `vectorcallfunc' function.
This can be done by setting `tp_call' to @ref{556,,PyVectorcall_Call()}.


Alterado na versão 3.8: Before version 3.8, this slot was named @code{tp_print}.
In Python 2.x, it was used for printing to a file.
In Python 3.0 to 3.7, it was unused.



Alterado na versão 3.12: Before version 3.12, it was not recommended for
@ref{96c,,mutable heap types} to implement the vectorcall
protocol.
When a user sets @ref{558,,__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{554,,Py_TPFLAGS_HAVE_VECTORCALL} flag.


`Inheritance:'

This field is always inherited.
However, the @ref{554,,Py_TPFLAGS_HAVE_VECTORCALL} flag is not
always inherited. If it’s not set, then the subclass won’t use
@ref{552,,vectorcall}, except when
@ref{556,,PyVectorcall_Call()} is explicitly called.
@end deffn

@geindex PyTypeObject.tp_getattr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getattr}@anchor{4b96}
@deffn {C Membro} @ref{4e39,,getattrfunc} @ref{ab4,,PyTypeObject}.tp_getattr

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_getattr} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_getattr (C macro)
@anchor{c-api/typeobj c Py_tp_getattr}@anchor{4e23}

An optional pointer to the get-attribute-string function.

This field is deprecated.  When it is defined, it should point to a function
that acts the same as the @ref{17e6,,tp_getattro} function, but taking a C string
instead of a Python string object to give the attribute name.

`Inheritance:'

Group: @ref{4b96,,tp_getattr}, @ref{17e6,,tp_getattro}

This field is inherited by subtypes together with @ref{17e6,,tp_getattro}: a subtype
inherits both @ref{4b96,,tp_getattr} and @ref{17e6,,tp_getattro} from its base type when
the subtype’s @ref{4b96,,tp_getattr} and @ref{17e6,,tp_getattro} are both @code{NULL}.
@end deffn

@geindex PyTypeObject.tp_setattr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_setattr}@anchor{4b97}
@deffn {C Membro} @ref{4e49,,setattrfunc} @ref{ab4,,PyTypeObject}.tp_setattr

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_setattr} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_setattr (C macro)
@anchor{c-api/typeobj c Py_tp_setattr}@anchor{4e30}

An optional pointer to the function for setting and deleting attributes.

This field is deprecated.  When it is defined, it should point to a function
that acts the same as the @ref{4b91,,tp_setattro} function, but taking a C string
instead of a Python string object to give the attribute name.

`Inheritance:'

Group: @ref{4b97,,tp_setattr}, @ref{4b91,,tp_setattro}

This field is inherited by subtypes together with @ref{4b91,,tp_setattro}: a subtype
inherits both @ref{4b97,,tp_setattr} and @ref{4b91,,tp_setattro} from its base type when
the subtype’s @ref{4b97,,tp_setattr} and @ref{4b91,,tp_setattro} are both @code{NULL}.
@end deffn

@geindex PyTypeObject.tp_as_async (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_async}@anchor{efe}
@deffn {C Membro} @ref{4f77,,PyAsyncMethods} *@ref{ab4,,PyTypeObject}.tp_as_async

Pointer to an additional structure that contains fields relevant only to
objects which implement @ref{1ad,,awaitable} and @ref{1ab,,asynchronous iterator}
protocols at the C-level.  See @ref{52aa,,Async Object Structures} for details.


Adicionado na versão 3.5: Formerly known as @code{tp_compare} and @code{tp_reserved}.


`Inheritance:'

The @ref{efe,,tp_as_async} field is not inherited,
but the contained fields are inherited individually.
@end deffn

@geindex PyTypeObject.tp_repr (C member)
@anchor{c-api/typeobj c PyTypeObject tp_repr}@anchor{4b8d}
@deffn {C Membro} @ref{4e47,,reprfunc} @ref{ab4,,PyTypeObject}.tp_repr

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_repr} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_repr (C macro)
@anchor{c-api/typeobj c Py_tp_repr}@anchor{4e2e}

@geindex função embutida;repr

An optional pointer to a function that implements the built-in function
@ref{800,,repr()}.

The signature is the same as for @ref{1067,,PyObject_Repr()}:

@example
PyObject *tp_repr(PyObject *self);
@end example

The function must return a string or a Unicode object.  Ideally,
this function should return a string that, when passed to
@ref{180,,eval()}, given a suitable environment, returns an object with the
same value.  If this is not feasible, it should return a string starting with
@code{'<'} and ending with @code{'>'} from which both the type and the value of the
object can be deduced.

`Inheritance:'

This field is inherited by subtypes.

`Padrão:'

When this field is not set, a string of the form @code{<%s object at %p>} is
returned, where @code{%s} is replaced by the type name, and @code{%p} by the object’s
memory address.
@end deffn

@geindex PyTypeObject.tp_as_number (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_number}@anchor{992}
@deffn {C Membro} @ref{1465,,PyNumberMethods} *@ref{ab4,,PyTypeObject}.tp_as_number

Pointer to an additional structure that contains fields relevant only to
objects which implement the number protocol.  These fields are documented in
@ref{52ab,,Number Object Structures}.

`Inheritance:'

The @ref{992,,tp_as_number} field is not inherited, but the contained fields are
inherited individually.
@end deffn

@geindex PyTypeObject.tp_as_sequence (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_sequence}@anchor{526c}
@deffn {C Membro} @ref{4b9d,,PySequenceMethods} *@ref{ab4,,PyTypeObject}.tp_as_sequence

Pointer to an additional structure that contains fields relevant only to
objects which implement the sequence protocol.  These fields are documented
in @ref{52ac,,Sequence Object Structures}.

`Inheritance:'

The @ref{526c,,tp_as_sequence} field is not inherited, but the contained fields
are inherited individually.
@end deffn

@geindex PyTypeObject.tp_as_mapping (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_mapping}@anchor{526d}
@deffn {C Membro} @ref{4b9e,,PyMappingMethods} *@ref{ab4,,PyTypeObject}.tp_as_mapping

Pointer to an additional structure that contains fields relevant only to
objects which implement the mapping protocol.  These fields are documented in
@ref{52ad,,Mapping Object Structures}.

`Inheritance:'

The @ref{526d,,tp_as_mapping} field is not inherited, but the contained fields
are inherited individually.
@end deffn

@geindex PyTypeObject.tp_hash (C member)
@anchor{c-api/typeobj c PyTypeObject tp_hash}@anchor{4b9f}
@deffn {C Membro} @ref{4e3e,,hashfunc} @ref{ab4,,PyTypeObject}.tp_hash

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_hash} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_hash (C macro)
@anchor{c-api/typeobj c Py_tp_hash}@anchor{4e26}

@geindex função embutida;hash

An optional pointer to a function that implements the built-in function
@ref{5eb,,hash()}.

The signature is the same as for @ref{403,,PyObject_Hash()}:

@example
Py_hash_t tp_hash(PyObject *);
@end example

The value @code{-1} should not be returned as a
normal return value; when an error occurs during the computation of the hash
value, the function should set an exception and return @code{-1}.

When this field is not set (`and' @ref{4b99,,tp_richcompare} is not set),
an attempt to take the hash of the object raises @ref{2c3,,TypeError}.
This is the same as setting it to @ref{140d,,PyObject_HashNotImplemented()}.

This field can be set explicitly to @ref{140d,,PyObject_HashNotImplemented()} to
block inheritance of the hash method from a parent type. This is interpreted
as the equivalent of @code{__hash__ = None} at the Python level, causing
@code{isinstance(o, collections.Hashable)} to correctly return @code{False}. Note
that the converse is also true - setting @code{__hash__ = None} on a class at
the Python level will result in the @code{tp_hash} slot being set to
@ref{140d,,PyObject_HashNotImplemented()}.

`Inheritance:'

Group: @ref{4b9f,,tp_hash}, @ref{4b99,,tp_richcompare}

This field is inherited by subtypes together with
@ref{4b99,,tp_richcompare}: a subtype inherits both of
@ref{4b99,,tp_richcompare} and @ref{4b9f,,tp_hash}, when the subtype’s
@ref{4b99,,tp_richcompare} and @ref{4b9f,,tp_hash} are both @code{NULL}.

`Padrão:'

@ref{4c0e,,PyBaseObject_Type} uses @ref{367,,PyObject_GenericHash()}.
@end deffn

@geindex PyTypeObject.tp_call (C member)
@anchor{c-api/typeobj c PyTypeObject tp_call}@anchor{559}
@deffn {C Membro} @ref{4e4e,,ternaryfunc} @ref{ab4,,PyTypeObject}.tp_call

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_call} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_call (C macro)
@anchor{c-api/typeobj c Py_tp_call}@anchor{4e1a}

An optional pointer to a function that implements calling the object.  This
should be @code{NULL} if the object is not callable.  The signature is the same as
for @ref{39c,,PyObject_Call()}:

@example
PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);
@end example

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_str (C member)
@anchor{c-api/typeobj c PyTypeObject tp_str}@anchor{4b8e}
@deffn {C Membro} @ref{4e47,,reprfunc} @ref{ab4,,PyTypeObject}.tp_str

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_str} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_str (C macro)
@anchor{c-api/typeobj c Py_tp_str}@anchor{4e32}

An optional pointer to a function that implements the built-in operation
@ref{44c,,str()}.  (Note that @ref{44c,,str} is a type now, and @ref{44c,,str()} calls the
constructor for that type.  This constructor calls @ref{1068,,PyObject_Str()} to do
the actual work, and @ref{1068,,PyObject_Str()} will call this handler.)

The signature is the same as for @ref{1068,,PyObject_Str()}:

@example
PyObject *tp_str(PyObject *self);
@end example

The function must return a string or a Unicode object.  It should be a “friendly” string
representation of the object, as this is the representation that will be used,
among other things, by the @ref{fa9,,print()} function.

`Inheritance:'

This field is inherited by subtypes.

`Padrão:'

When this field is not set, @ref{1067,,PyObject_Repr()} is called to return a string
representation.
@end deffn

@geindex PyTypeObject.tp_getattro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getattro}@anchor{17e6}
@deffn {C Membro} @ref{4e3a,,getattrofunc} @ref{ab4,,PyTypeObject}.tp_getattro

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_getattro} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_getattro (C macro)
@anchor{c-api/typeobj c Py_tp_getattro}@anchor{4e24}

An optional pointer to the get-attribute function.

The signature is the same as for @ref{347,,PyObject_GetAttr()}:

@example
PyObject *tp_getattro(PyObject *self, PyObject *attr);
@end example

It is usually convenient to set this field to @ref{4d2b,,PyObject_GenericGetAttr()},
which implements the normal way of looking for object attributes.

`Inheritance:'

Group: @ref{4b96,,tp_getattr}, @ref{17e6,,tp_getattro}

This field is inherited by subtypes together with @ref{4b96,,tp_getattr}: a subtype
inherits both @ref{4b96,,tp_getattr} and @ref{17e6,,tp_getattro} from its base type when
the subtype’s @ref{4b96,,tp_getattr} and @ref{17e6,,tp_getattro} are both @code{NULL}.

`Padrão:'

@ref{4c0e,,PyBaseObject_Type} uses @ref{4d2b,,PyObject_GenericGetAttr()}.
@end deffn

@geindex PyTypeObject.tp_setattro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_setattro}@anchor{4b91}
@deffn {C Membro} @ref{4e4a,,setattrofunc} @ref{ab4,,PyTypeObject}.tp_setattro

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_setattro} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_setattro (C macro)
@anchor{c-api/typeobj c Py_tp_setattro}@anchor{4e31}

An optional pointer to the function for setting and deleting attributes.

The signature is the same as for @ref{4d34,,PyObject_SetAttr()}:

@example
int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);
@end example

In addition, setting `value' to @code{NULL} to delete an attribute must be
supported.  It is usually convenient to set this field to
@ref{4d2c,,PyObject_GenericSetAttr()}, which implements the normal
way of setting object attributes.

`Inheritance:'

Group: @ref{4b97,,tp_setattr}, @ref{4b91,,tp_setattro}

This field is inherited by subtypes together with @ref{4b97,,tp_setattr}: a subtype
inherits both @ref{4b97,,tp_setattr} and @ref{4b91,,tp_setattro} from its base type when
the subtype’s @ref{4b97,,tp_setattr} and @ref{4b91,,tp_setattro} are both @code{NULL}.

`Padrão:'

@ref{4c0e,,PyBaseObject_Type} uses @ref{4d2c,,PyObject_GenericSetAttr()}.
@end deffn

@geindex PyTypeObject.tp_as_buffer (C member)
@anchor{c-api/typeobj c PyTypeObject tp_as_buffer}@anchor{990}
@deffn {C Membro} @ref{4f7f,,PyBufferProcs} *@ref{ab4,,PyTypeObject}.tp_as_buffer

Pointer to an additional structure that contains fields relevant only to objects
which implement the buffer interface.  These fields are documented in
@ref{4f43,,Buffer Object Structures}.

`Inheritance:'

The @ref{990,,tp_as_buffer} field is not inherited,
but the contained fields are inherited individually.
@end deffn

@geindex PyTypeObject.tp_flags (C member)
@anchor{c-api/typeobj c PyTypeObject tp_flags}@anchor{19fd}
@deffn {C Membro} unsigned long @ref{ab4,,PyTypeObject}.tp_flags

This field is a bit mask of various flags.  Some flags indicate variant
semantics for certain situations; others are used to indicate that certain
fields in the type object (or in the extension structures referenced via
@ref{992,,tp_as_number}, @ref{526c,,tp_as_sequence}, @ref{526d,,tp_as_mapping}, and
@ref{990,,tp_as_buffer}) that were historically not always present are valid; if
such a flag bit is clear, the type fields it guards must not be accessed and
must be considered to have a zero or @code{NULL} value instead.

`Inheritance:'

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{77d,,Py_TPFLAGS_HAVE_GC} flag bit is inherited together with
the @ref{77e,,tp_traverse} and @ref{4b8b,,tp_clear} fields, i.e. if the
@ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit is clear in the subtype and the
@ref{77e,,tp_traverse} and @ref{4b8b,,tp_clear} fields in the subtype exist and have
@code{NULL} values.
.. XXX are most flag bits `really' inherited individually?

`Padrão:'

@ref{4c0e,,PyBaseObject_Type} uses
@code{Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE}.

`Bit Masks:'

The following bit masks are currently defined; these can be ORed together using
the @code{|} operator to form the value of the @ref{19fd,,tp_flags} field.  The macro
@ref{1ac9,,PyType_HasFeature()} takes a type and a flags value, `tp' and `f', and
checks whether @code{tp->tp_flags & f} is non-zero.

@geindex Py_TPFLAGS_HEAPTYPE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HEAPTYPE}@anchor{8b4}
@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{57d,,PyType_FromSpec()}.  In this
case, the @ref{4b77,,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{52ae,,support garbage collection}
as they can form a reference cycle with their own module object.

`Inheritance:'

???
@end deffn

@geindex Py_TPFLAGS_BASETYPE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_BASETYPE}@anchor{4b7e}
@deffn {C Macro} Py_TPFLAGS_BASETYPE
` Parte da @ref{553,,ABI Estável}.'
This bit is set when the type can be used as the base type of another type.  If
this bit is clear, the type cannot be subtyped (similar to a “final” class in
Java).

`Inheritance:'

???
@end deffn

@geindex Py_TPFLAGS_READY (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_READY}@anchor{52af}
@deffn {C Macro} Py_TPFLAGS_READY

This bit is set when the type object has been fully initialized by
@ref{77c,,PyType_Ready()}.

`Inheritance:'

???
@end deffn

@geindex Py_TPFLAGS_READYING (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_READYING}@anchor{52b0}
@deffn {C Macro} Py_TPFLAGS_READYING

This bit is set while @ref{77c,,PyType_Ready()} is in the process of initializing
the type object.

`Inheritance:'

???
@end deffn

@geindex Py_TPFLAGS_HAVE_GC (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_GC}@anchor{77d}
@deffn {C Macro} Py_TPFLAGS_HAVE_GC
` Parte da @ref{553,,ABI Estável}.'
This bit is set when the object supports garbage collection.  If this bit
is set, instances must be created using @ref{ab1,,PyObject_GC_New} and
destroyed using @ref{154c,,PyObject_GC_Del()}.  More information in section
@ref{52ae,,Suporte a Coleta Cíclica de Lixo}.  This bit also implies that the
GC-related fields @ref{77e,,tp_traverse} and @ref{4b8b,,tp_clear} are present in
the type object.

`Inheritance:'

Group: @ref{77d,,Py_TPFLAGS_HAVE_GC}, @ref{77e,,tp_traverse}, @ref{4b8b,,tp_clear}

The @ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit is inherited
together with the @ref{77e,,tp_traverse} and @ref{4b8b,,tp_clear}
fields, i.e.  if the @ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit is
clear in the subtype and the @ref{77e,,tp_traverse} and
@ref{4b8b,,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{4b74}
@deffn {C Macro} Py_TPFLAGS_DEFAULT
` Parte da @ref{553,,ABI Estável}.'
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}.

`Inheritance:'

???
@end deffn

@geindex Py_TPFLAGS_METHOD_DESCRIPTOR (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_METHOD_DESCRIPTOR}@anchor{4dcf}
@deffn {C Macro} Py_TPFLAGS_METHOD_DESCRIPTOR
` Parte da @ref{553,,ABI Estável} desde a versão 3.8.'
This bit indicates that objects behave like unbound methods.

If this flag is set for @code{type(meth)}, then:


@itemize -

@item 
@code{meth.__get__(obj, cls)(*args, **kwds)} (with @code{obj} not None)
must be equivalent to @code{meth(obj, *args, **kwds)}.

@item 
@code{meth.__get__(None, cls)(*args, **kwds)}
must be equivalent to @code{meth(*args, **kwds)}.
@end itemize

This flag enables an optimization for typical method calls like
@code{obj.meth()}: it avoids creating a temporary “bound method” object for
@code{obj.meth}.


Adicionado na versão 3.8.


`Inheritance:'

This flag is never inherited by types without the
@ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} flag set.  For extension types, it is
inherited whenever @ref{526e,,tp_descr_get} is inherited.
@end deffn

@geindex Py_TPFLAGS_MANAGED_DICT (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_MANAGED_DICT}@anchor{36b}
@deffn {C Macro} Py_TPFLAGS_MANAGED_DICT

This bit indicates that instances of the class have a @ref{55b,,__dict__}
attribute, and that the space for the dictionary is managed by the VM.

If this flag is set, @ref{77d,,Py_TPFLAGS_HAVE_GC} should also be set.

The type traverse function must call @ref{369,,PyObject_VisitManagedDict()}
and its clear function must call @ref{36a,,PyObject_ClearManagedDict()}.


Adicionado na versão 3.12.


`Inheritance:'

This flag is inherited unless the
@ref{4f79,,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{55a}
@deffn {C Macro} Py_TPFLAGS_MANAGED_WEAKREF

This bit indicates that instances of the class should be weakly
referenceable.


Adicionado na versão 3.12.


`Inheritance:'

This flag is inherited unless the
@ref{98f,,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{54b}
@deffn {C Macro} Py_TPFLAGS_ITEMS_AT_END
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
Only usable with variable-size types, i.e. ones with non-zero
@ref{20fd,,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.


Adicionado na versão 3.12.


`Inheritance:'

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{4f6b}
@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{52b1}
@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{52b2}
@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{52b3}
@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{52b4}
@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{52b5}
@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{52b6}
@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{52b7}
@deffn {C Macro} Py_TPFLAGS_TYPE_SUBCLASS

Functions such as @ref{4f8a,,PyLong_Check()} will call @ref{4f6a,,PyType_FastSubclass()}
with one of these flags to quickly determine if a type is a subclass
of a built-in type; such specific checks are faster than a generic
check, like @ref{ed5,,PyObject_IsInstance()}. Custom types that inherit
from built-ins should have their @ref{19fd,,tp_flags}
set appropriately, or the code that interacts with such types
will behave differently depending on what kind of check is used.
@end deffn

@geindex Py_TPFLAGS_HAVE_FINALIZE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_FINALIZE}@anchor{3f2}
@deffn {C Macro} Py_TPFLAGS_HAVE_FINALIZE

This bit is set when the @ref{ab5,,tp_finalize} slot is present in the
type structure.


Adicionado na versão 3.4.



Descontinuado desde a versão 3.8: This flag isn’t necessary anymore, as the interpreter assumes the
@ref{ab5,,tp_finalize} slot is always present in the
type structure.

@end deffn

@geindex _Py_TPFLAGS_HAVE_VECTORCALL (C macro)

@geindex Py_TPFLAGS_HAVE_VECTORCALL (C macro)
@anchor{c-api/typeobj c _Py_TPFLAGS_HAVE_VECTORCALL}@anchor{52b8}@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_VECTORCALL}@anchor{554}
@deffn {C Macro} Py_TPFLAGS_HAVE_VECTORCALL
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
This bit is set when the class implements
the @ref{552,,vectorcall protocol}.
See @ref{4f1e,,tp_vectorcall_offset} for details.

`Inheritance:'

This bit is inherited if @ref{559,,tp_call} is also
inherited.


Adicionado na versão 3.8: as @code{_Py_TPFLAGS_HAVE_VECTORCALL}



Alterado na versão 3.9.


Renamed to the current name, without the leading underscore.
The old provisional name is @ref{209,,soft deprecated}.


Alterado na versão 3.12: This flag is now removed from a class when the class’s
@ref{558,,__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{3c2}
@deffn {C Macro} Py_TPFLAGS_IMMUTABLETYPE

This bit is set for type objects that are immutable: type attributes cannot be set nor deleted.

@ref{77c,,PyType_Ready()} automatically applies this flag to
@ref{77f,,static types}.

`Inheritance:'

This flag is not inherited.


Adicionado na versão 3.10.

@end deffn

@geindex Py_TPFLAGS_DISALLOW_INSTANTIATION (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_DISALLOW_INSTANTIATION}@anchor{582}
@deffn {C Macro} Py_TPFLAGS_DISALLOW_INSTANTIATION

Disallow creating instances of the type: set
@ref{57f,,tp_new} to NULL and don’t create the @code{__new__}
key in the type dictionary.

The flag must be set before creating the type, not after. For example, it
must be set before @ref{77c,,PyType_Ready()} is called on the type.

The flag is set automatically on @ref{77f,,static types} if
@ref{20b8,,tp_base} is NULL or @code{&PyBaseObject_Type} and
@ref{57f,,tp_new} is NULL.

`Inheritance:'

This flag is not inherited.
However, subclasses will not be instantiable unless they provide a
non-NULL @ref{57f,,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{11f5,,abstract base class}),
do not use this flag.
Instead, make @ref{57f,,tp_new} only succeed for
subclasses.
@end quotation
@end cartouche


Adicionado na versão 3.10.

@end deffn

@geindex Py_TPFLAGS_MAPPING (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_MAPPING}@anchor{19e3}
@deffn {C Macro} Py_TPFLAGS_MAPPING

This bit indicates that instances of the class may match mapping patterns
when used as the subject of a @ref{810,,match} block. It is automatically
set when registering or subclassing @ref{8d0,,collections.abc.Mapping}, and
unset when registering @ref{1204,,collections.abc.Sequence}.

@cartouche
@quotation Nota 
@ref{19e3,,Py_TPFLAGS_MAPPING} and @ref{19e4,,Py_TPFLAGS_SEQUENCE} are
mutually exclusive; it is an error to enable both flags simultaneously.
@end quotation
@end cartouche

`Inheritance:'

This flag is inherited by types that do not already set
@ref{19e4,,Py_TPFLAGS_SEQUENCE}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Structural Pattern Matching: Specification



Adicionado na versão 3.10.

@end deffn

@geindex Py_TPFLAGS_SEQUENCE (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_SEQUENCE}@anchor{19e4}
@deffn {C Macro} Py_TPFLAGS_SEQUENCE

This bit indicates that instances of the class may match sequence patterns
when used as the subject of a @ref{810,,match} block. It is automatically
set when registering or subclassing @ref{1204,,collections.abc.Sequence}, and
unset when registering @ref{8d0,,collections.abc.Mapping}.

@cartouche
@quotation Nota 
@ref{19e3,,Py_TPFLAGS_MAPPING} and @ref{19e4,,Py_TPFLAGS_SEQUENCE} are
mutually exclusive; it is an error to enable both flags simultaneously.
@end quotation
@end cartouche

`Inheritance:'

This flag is inherited by types that do not already set
@ref{19e3,,Py_TPFLAGS_MAPPING}.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} – Structural Pattern Matching: Specification



Adicionado na versão 3.10.

@end deffn

@geindex Py_TPFLAGS_VALID_VERSION_TAG (C macro)
@anchor{c-api/typeobj c Py_TPFLAGS_VALID_VERSION_TAG}@anchor{52b9}
@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{1906,,PyType_Modified()}

@cartouche
@quotation Aviso 
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{4b75}
@deffn {C Membro} const char *@ref{ab4,,PyTypeObject}.tp_doc

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_doc} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_doc (C macro)
@anchor{c-api/typeobj c Py_tp_doc}@anchor{4e20}

An optional pointer to a NUL-terminated C string giving the docstring for this
type object.  This is exposed as the @ref{1e35,,__doc__} attribute on the
type and instances of the type.

`Inheritance:'

This field is `not' inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_traverse (C member)
@anchor{c-api/typeobj c PyTypeObject tp_traverse}@anchor{77e}
@deffn {C Membro} @ref{4e4f,,traverseproc} @ref{ab4,,PyTypeObject}.tp_traverse

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_traverse} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_traverse (C macro)
@anchor{c-api/typeobj c Py_tp_traverse}@anchor{4e33}

An optional pointer to a traversal function for the garbage collector.  This is
only used if the @ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit is set.  The signature is:

@example
int tp_traverse(PyObject *self, visitproc visit, void *arg);
@end example

More information about Python’s garbage collection scheme can be found
in section @ref{52ae,,Suporte a Coleta Cíclica de Lixo}.

The @ref{77e,,tp_traverse} pointer is used by the garbage collector to detect
reference cycles. A typical implementation of a @ref{77e,,tp_traverse} function
simply calls @ref{4b82,,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

Note that @ref{4b82,,Py_VISIT()} is called only on those members that can participate
in reference cycles.  Although there is also a @code{self->key} member, it can only
be @code{NULL} or a Python string and therefore cannot be part of a reference cycle.

On the other hand, even if you know a member can never be part of a cycle, as a
debugging aid you may want to visit it anyway just so the @ref{60,,gc} module’s
@ref{808,,get_referents()} function will include it.

Heap types (@ref{8b4,,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{36b,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{19fd,,tp_flags} field, the traverse function must call
@ref{369,,PyObject_VisitManagedDict()} like this:

@example
PyObject_VisitManagedDict((PyObject*)self, visit, arg);
@end example

@cartouche
@quotation Aviso 
When implementing @ref{77e,,tp_traverse}, only the
members that the instance `owns' (by having @ref{33d,,strong references} to them) must be
visited. For instance, if an object supports weak references via the
@ref{4f7e,,tp_weaklist} slot, the pointer supporting
the linked list (what `tp_weaklist' points to) must `not' be
visited as the instance does not directly own the weak references to itself
(the weakreference list is there to support the weak reference machinery,
but the instance has no strong reference to the elements inside it, as they
are allowed to be removed even if the instance is still alive).
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
The traversal function must not have any side effects.  It must not
modify the reference counts of any Python objects nor create or destroy
any Python objects.
@end quotation
@end cartouche

Note that @ref{4b82,,Py_VISIT()} requires the `visit' and `arg' parameters to
@code{local_traverse()} to have these specific names; don’t name them just
anything.

Instances of @ref{96c,,heap-allocated types} hold a reference to
their type. Their traversal function must therefore either visit
@ref{780,,Py_TYPE(self)}, or delegate this responsibility by
calling @code{tp_traverse} of another heap-allocated type (such as a
heap-allocated superclass).
If they do not, the type object may not be garbage-collected.


Alterado na versão 3.9: Heap-allocated types are expected to visit @code{Py_TYPE(self)} in
@code{tp_traverse}.  In earlier versions of Python, due to
bug 40217@footnote{https://bugs.python.org/issue40217}, doing this
may lead to crashes in subclasses.


`Inheritance:'

Group: @ref{77d,,Py_TPFLAGS_HAVE_GC}, @ref{77e,,tp_traverse}, @ref{4b8b,,tp_clear}

This field is inherited by subtypes together with @ref{4b8b,,tp_clear} and the
@ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit: the flag bit, @ref{77e,,tp_traverse}, and
@ref{4b8b,,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{4b8b}
@deffn {C Membro} @ref{4e40,,inquiry} @ref{ab4,,PyTypeObject}.tp_clear

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_clear} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_clear (C macro)
@anchor{c-api/typeobj c Py_tp_clear}@anchor{4e1b}

An optional pointer to a clear function for the garbage collector. This is only
used if the @ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit is set.  The signature is:

@example
int tp_clear(PyObject *);
@end example

The @ref{4b8b,,tp_clear} member function is used to break reference cycles in cyclic
garbage detected by the garbage collector.  Taken together, all @ref{4b8b,,tp_clear}
functions in the system must combine to break all reference cycles.  This is
subtle, and if in any doubt supply a @ref{4b8b,,tp_clear} function.  For example,
the tuple type does not implement a @ref{4b8b,,tp_clear} function, because it’s
possible to prove that no reference cycle can be composed entirely of tuples.
Therefore the @ref{4b8b,,tp_clear} functions of other types must be sufficient to
break any cycle containing a tuple.  This isn’t immediately obvious, and there’s
rarely a good reason to avoid implementing @ref{4b8b,,tp_clear}.

Implementations of @ref{4b8b,,tp_clear} should drop the instance’s references to
those of its members that may be Python objects, and set its pointers to those
members to @code{NULL}, as in the following example:

@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{578,,Py_CLEAR()} macro should be used, because clearing references is
delicate:  the reference to the contained object must not be released
(via @ref{56f,,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{578,,Py_CLEAR()} macro performs the operations in a safe order.

If the @ref{36b,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{19fd,,tp_flags} field, the clear function must call
@ref{36a,,PyObject_ClearManagedDict()} like this:

@example
PyObject_ClearManagedDict((PyObject*)self);
@end example

Note that @ref{4b8b,,tp_clear} is not `always' called
before an instance is deallocated. For example, when reference counting
is enough to determine that an object is no longer used, the cyclic garbage
collector is not involved and @ref{4b66,,tp_dealloc} is
called directly.

Because the goal of @ref{4b8b,,tp_clear} functions is to break reference cycles,
it’s not necessary to clear contained objects like Python strings or Python
integers, which can’t participate in reference cycles. On the other hand, it may
be convenient to clear all contained Python objects, and write the type’s
@ref{4b66,,tp_dealloc} function to invoke @ref{4b8b,,tp_clear}.

More information about Python’s garbage collection scheme can be found in
section @ref{52ae,,Suporte a Coleta Cíclica de Lixo}.

`Inheritance:'

Group: @ref{77d,,Py_TPFLAGS_HAVE_GC}, @ref{77e,,tp_traverse}, @ref{4b8b,,tp_clear}

This field is inherited by subtypes together with @ref{77e,,tp_traverse} and the
@ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit: the flag bit, @ref{77e,,tp_traverse}, and
@ref{4b8b,,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{4b99}
@deffn {C Membro} @ref{4e48,,richcmpfunc} @ref{ab4,,PyTypeObject}.tp_richcompare

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_richcompare} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_richcompare (C macro)
@anchor{c-api/typeobj c Py_tp_richcompare}@anchor{4e2f}

An optional pointer to the rich comparison function, whose signature is:

@example
PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);
@end example

The first parameter is guaranteed to be an instance of the type
that is defined by @ref{ab4,,PyTypeObject}.

The function should return the result of the comparison (usually @code{Py_True}
or @code{Py_False}).  If the comparison is undefined, it must return
@code{Py_NotImplemented}, if another error occurred it must return @code{NULL} and
set an exception condition.

The following constants are defined to be used as the third argument for
@ref{4b99,,tp_richcompare} and for @ref{4b9a,,PyObject_RichCompare()}:


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

Constante

@tab

Comparação

@item

@geindex Py_LT (C macro)
@anchor{c-api/typeobj c Py_LT}@anchor{4f12}
@deffn {C Macro} Py_LT
@end deffn

@tab

@code{<}

@item

@geindex Py_LE (C macro)
@anchor{c-api/typeobj c Py_LE}@anchor{4f13}
@deffn {C Macro} Py_LE
@end deffn

@tab

@code{<=}

@item

@geindex Py_EQ (C macro)
@anchor{c-api/typeobj c Py_EQ}@anchor{4f14}
@deffn {C Macro} Py_EQ
@end deffn

@tab

@code{==}

@item

@geindex Py_NE (C macro)
@anchor{c-api/typeobj c Py_NE}@anchor{4f15}
@deffn {C Macro} Py_NE
@end deffn

@tab

@code{!=}

@item

@geindex Py_GT (C macro)
@anchor{c-api/typeobj c Py_GT}@anchor{4f16}
@deffn {C Macro} Py_GT
@end deffn

@tab

@code{>}

@item

@geindex Py_GE (C macro)
@anchor{c-api/typeobj c Py_GE}@anchor{4f17}
@deffn {C Macro} Py_GE
@end deffn

@tab

@code{>=}

@end multitable


The following macro is defined to ease writing rich comparison functions:

@geindex Py_RETURN_RICHCOMPARE (C macro)
@anchor{c-api/typeobj c Py_RETURN_RICHCOMPARE}@anchor{bcc}
@deffn {C Macro} Py_RETURN_RICHCOMPARE (VAL_A, VAL_B, op)

Return @code{Py_True} or @code{Py_False} from the function, depending on the
result of a comparison.
VAL_A and VAL_B must be orderable by C comparison operators (for example,
they may be C ints or floats). The third argument specifies the requested
operation, as for @ref{4b9a,,PyObject_RichCompare()}.

The returned value is a new @ref{33d,,strong reference}.

On error, sets an exception and returns @code{NULL} from the function.


Adicionado na versão 3.7.

@end deffn

`Inheritance:'

Group: @ref{4b9f,,tp_hash}, @ref{4b99,,tp_richcompare}

This field is inherited by subtypes together with @ref{4b9f,,tp_hash}:
a subtype inherits @ref{4b99,,tp_richcompare} and @ref{4b9f,,tp_hash} when
the subtype’s @ref{4b99,,tp_richcompare} and @ref{4b9f,,tp_hash} are both
@code{NULL}.

`Padrão:'

@ref{4c0e,,PyBaseObject_Type} provides a @ref{4b99,,tp_richcompare}
implementation, which may be inherited.  However, if only
@ref{4b9f,,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{98f}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{ab4,,PyTypeObject}.tp_weaklistoffset

While this field is still supported, @ref{55a,,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{576,,PyObject_ClearWeakRefs()} and the @code{PyWeakref_*} functions.  The
instance structure needs to include a field of type @ref{339,,PyObject}* which is
initialized to @code{NULL}.

Do not confuse this field with @ref{4f7e,,tp_weaklist}; that is the list head for
weak references to the type object itself.

It is an error to set both the @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} bit and
@ref{98f,,tp_weaklistoffset}.

`Inheritance:'

This field is inherited by subtypes, but see the rules listed below. A subtype
may override this offset; this means that the subtype uses a different weak
reference list head than the base type.  Since the list head is always found via
@ref{98f,,tp_weaklistoffset}, this should not be a problem.

`Padrão:'

If the @ref{55a,,Py_TPFLAGS_MANAGED_WEAKREF} bit is set in the
@ref{19fd,,tp_flags} field, then
@ref{98f,,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{1537}
@deffn {C Membro} @ref{4e3c,,getiterfunc} @ref{ab4,,PyTypeObject}.tp_iter

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_iter} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_iter (C macro)
@anchor{c-api/typeobj c Py_tp_iter}@anchor{4e29}

An optional pointer to a function that returns an @ref{1ac,,iterator} for the
object.  Its presence normally signals that the instances of this type are
@ref{1268,,iterable} (although sequences may be iterable without this function).

This function has the same signature as @ref{4d2f,,PyObject_GetIter()}:

@example
PyObject *tp_iter(PyObject *self);
@end example

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_iternext (C member)
@anchor{c-api/typeobj c PyTypeObject tp_iternext}@anchor{1538}
@deffn {C Membro} @ref{4e41,,iternextfunc} @ref{ab4,,PyTypeObject}.tp_iternext

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_iternext} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_iternext (C macro)
@anchor{c-api/typeobj c Py_tp_iternext}@anchor{4e2a}

An optional pointer to a function that returns the next item in an
@ref{1ac,,iterator}. The signature is:

@example
PyObject *tp_iternext(PyObject *self);
@end example

When the iterator is exhausted, it must return @code{NULL}; a @ref{c15,,StopIteration}
exception may or may not be set.  When another error occurs, it must return
@code{NULL} too.  Its presence signals that the instances of this type are
iterators.

Iterator types should also define the @ref{1537,,tp_iter} function, and that
function should return the iterator instance itself (not a new iterator
instance).

This function has the same signature as @ref{4cd6,,PyIter_Next()}.

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_methods (C member)
@anchor{c-api/typeobj c PyTypeObject tp_methods}@anchor{4b7d}
@deffn {C Membro} struct @ref{151f,,PyMethodDef} *@ref{ab4,,PyTypeObject}.tp_methods

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_methods} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_methods (C macro)
@anchor{c-api/typeobj c Py_tp_methods}@anchor{4e2c}

An optional pointer to a static @code{NULL}-terminated array of @ref{151f,,PyMethodDef}
structures, declaring regular methods of this type.

For each entry in the array, an entry is added to the type’s dictionary (see
@ref{180e,,tp_dict} below) containing a method descriptor.

`Inheritance:'

This field is not inherited by subtypes (methods are inherited through a
different mechanism).
@end deffn

@geindex PyTypeObject.tp_members (C member)
@anchor{c-api/typeobj c PyTypeObject tp_members}@anchor{4b7b}
@deffn {C Membro} struct @ref{54f,,PyMemberDef} *@ref{ab4,,PyTypeObject}.tp_members

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_members} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_members (C macro)
@anchor{c-api/typeobj c Py_tp_members}@anchor{4e2b}

An optional pointer to a static @code{NULL}-terminated array of @ref{54f,,PyMemberDef}
structures, declaring regular data members (fields or slots) of instances of
this type.

For each entry in the array, an entry is added to the type’s dictionary (see
@ref{180e,,tp_dict} below) containing a member descriptor.

`Inheritance:'

This field is not inherited by subtypes (members are inherited through a
different mechanism).
@end deffn

@geindex PyTypeObject.tp_getset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_getset}@anchor{4b80}
@deffn {C Membro} struct @ref{bd1,,PyGetSetDef} *@ref{ab4,,PyTypeObject}.tp_getset

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_getset} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_getset (C macro)
@anchor{c-api/typeobj c Py_tp_getset}@anchor{4e25}

An optional pointer to a static @code{NULL}-terminated array of @ref{bd1,,PyGetSetDef}
structures, declaring computed attributes of instances of this type.

For each entry in the array, an entry is added to the type’s dictionary (see
@ref{180e,,tp_dict} below) containing a getset descriptor.

`Inheritance:'

This field is not inherited by subtypes (computed attributes are inherited
through a different mechanism).
@end deffn

@geindex PyTypeObject.tp_base (C member)
@anchor{c-api/typeobj c PyTypeObject tp_base}@anchor{20b8}
@deffn {C Membro} @ref{ab4,,PyTypeObject} *@ref{ab4,,PyTypeObject}.tp_base

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_base} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_base (C macro)
@anchor{c-api/typeobj c Py_tp_base}@anchor{4e18}

An optional pointer to a base type from which type properties are inherited.  At
this level, only single inheritance is supported; multiple inheritance require
dynamically creating a type object by calling the metatype.

@cartouche
@quotation Nota 
@c from Modules/xxmodule.c

Slot initialization is subject to the rules of initializing globals.
C99 requires the initializers to be “address constants”.  Function
designators like @ref{4b76,,PyType_GenericNew()}, with implicit conversion
to a pointer, are valid C99 address constants.

However, the unary ‘&’ operator applied to a non-static variable
like @ref{4c0e,,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.

Consequently, @ref{20b8,,tp_base} should be set in
the extension module’s init function.
@end quotation
@end cartouche

`Inheritance:'

This field is not inherited by subtypes (obviously).

`Padrão:'

This field defaults to @code{&PyBaseObject_Type} (which to Python
programmers is known as the type @ref{a96,,object}).
@end deffn

@geindex PyTypeObject.tp_dict (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dict}@anchor{180e}
@deffn {C Membro} @ref{339,,PyObject} *@ref{ab4,,PyTypeObject}.tp_dict

The type’s dictionary is stored here by @ref{77c,,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{77c,,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{2121,,__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{180d,,PyType_GetDict()} to retrieve the dictionary for an arbitrary
type.


Alterado na versão 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{180d,,PyType_GetDict()} to get the dict for an arbitrary type.


`Inheritance:'

This field is not inherited by subtypes (though the attributes defined in here
are inherited through a different mechanism).

`Padrão:'

If this field is @code{NULL}, @ref{77c,,PyType_Ready()} will assign a new
dictionary to it.

@cartouche
@quotation Aviso 
It is not safe to use @ref{4b63,,PyDict_SetItem()} on or otherwise modify
@ref{180e,,tp_dict} with the dictionary 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{526e}
@deffn {C Membro} @ref{4e36,,descrgetfunc} @ref{ab4,,PyTypeObject}.tp_descr_get

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_descr_get} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_descr_get (C macro)
@anchor{c-api/typeobj c Py_tp_descr_get}@anchor{4e1e}

An optional pointer to a “descriptor get” function.

A assinatura da função é:

@example
PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
@end example

@c XXX explain more?

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_descr_set (C member)
@anchor{c-api/typeobj c PyTypeObject tp_descr_set}@anchor{1a40}
@deffn {C Membro} @ref{4e37,,descrsetfunc} @ref{ab4,,PyTypeObject}.tp_descr_set

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_descr_set} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_descr_set (C macro)
@anchor{c-api/typeobj c Py_tp_descr_set}@anchor{4e1f}

An optional pointer to a function for setting and deleting
a descriptor’s value.

A assinatura da função é:

@example
int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);
@end example

The `value' argument is set to @code{NULL} to delete the value.

@c XXX explain more?

`Inheritance:'

This field is inherited by subtypes.
@end deffn

@geindex PyTypeObject.tp_dictoffset (C member)
@anchor{c-api/typeobj c PyTypeObject tp_dictoffset}@anchor{4f79}
@deffn {C Membro} @ref{a69,,Py_ssize_t} @ref{ab4,,PyTypeObject}.tp_dictoffset

While this field is still supported, @ref{36b,,Py_TPFLAGS_MANAGED_DICT} should be
used instead, if at all possible.

If the instances of this type have a dictionary containing instance variables,
this field is non-zero and contains the offset in the instances of the type of
the instance variable dictionary; this offset is used by
@ref{4d2b,,PyObject_GenericGetAttr()}.

Do not confuse this field with @ref{180e,,tp_dict}; that is the dictionary for
attributes of the type object itself.

The value specifies the offset of the dictionary from the start of the instance structure.

The @ref{4f79,,tp_dictoffset} should be regarded as write-only.
To get the pointer to the dictionary call @ref{1a92,,PyObject_GenericGetDict()}.
Calling @ref{1a92,,PyObject_GenericGetDict()} may need to allocate memory for the
dictionary, so it is may be more efficient to call @ref{347,,PyObject_GetAttr()}
when accessing an attribute on the object.

It is an error to set both the @ref{36b,,Py_TPFLAGS_MANAGED_DICT} bit and
@ref{4f79,,tp_dictoffset}.

`Inheritance:'

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{36b,,Py_TPFLAGS_MANAGED_DICT}.

`Padrão:'

This slot has no default.  For @ref{77f,,static types}, if the
field is @code{NULL} then no @ref{55b,,__dict__} gets created for instances.

If the @ref{36b,,Py_TPFLAGS_MANAGED_DICT} bit is set in the
@ref{19fd,,tp_flags} field, then
@ref{4f79,,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{581}
@deffn {C Membro} @ref{4e3f,,initproc} @ref{ab4,,PyTypeObject}.tp_init

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_init} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_init (C macro)
@anchor{c-api/typeobj c Py_tp_init}@anchor{4e27}

An optional pointer to an instance initialization function.

This function corresponds to the @ref{6b0,,__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.

A assinatura da função é:

@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{6b0,,__init__()}.

The @ref{581,,tp_init} function, if not @code{NULL}, is called when an instance is
created normally by calling its type, after the type’s @ref{57f,,tp_new} function
has returned an instance of the type.  If the @ref{57f,,tp_new} function returns an
instance of some other type that is not a subtype of the original type, no
@ref{581,,tp_init} function is called; if @ref{57f,,tp_new} returns an instance of a
subtype of the original type, the subtype’s @ref{581,,tp_init} is called.

Returns @code{0} on success, @code{-1} and sets an exception on error.

`Inheritance:'

This field is inherited by subtypes.

`Padrão:'

For @ref{77f,,static types} this field does not have a default.
@end deffn

@geindex PyTypeObject.tp_alloc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_alloc}@anchor{4b7a}
@deffn {C Membro} @ref{4e34,,allocfunc} @ref{ab4,,PyTypeObject}.tp_alloc

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_alloc} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_alloc (C macro)
@anchor{c-api/typeobj c Py_tp_alloc}@anchor{4e17}

An optional pointer to an instance allocation function.

A assinatura da função é:

@example
PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);
@end example

`Inheritance:'

This field is inherited by static subtypes, but not by dynamic
subtypes (subtypes created by a class statement).

`Padrão:'

For dynamic subtypes, this field is always set to
@ref{a75,,PyType_GenericAlloc()}, to force a standard heap
allocation strategy.

For static subtypes, @ref{4c0e,,PyBaseObject_Type} uses
@ref{a75,,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{57f}
@deffn {C Membro} @ref{4e43,,newfunc} @ref{ab4,,PyTypeObject}.tp_new

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_new} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_new (C macro)
@anchor{c-api/typeobj c Py_tp_new}@anchor{4e2d}

An optional pointer to an instance creation function.

A assinatura da função é:

@example
PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);
@end example

The `subtype' argument is the type of the object being created; the `args' and
`kwds' arguments represent positional and keyword arguments of the call to the
type.  Note that `subtype' doesn’t have to equal the type whose @ref{57f,,tp_new}
function is called; it may be a subtype of that type (but not an unrelated
type).

The @ref{57f,,tp_new} function should call @code{subtype->tp_alloc(subtype, nitems)}
to allocate space for the object, and then do only as much further
initialization as is absolutely necessary.  Initialization that can safely be
ignored or repeated should be placed in the @ref{581,,tp_init} handler.  A good
rule of thumb is that for immutable types, all initialization should take place
in @ref{57f,,tp_new}, while for mutable types, most initialization should be
deferred to @ref{581,,tp_init}.

Set the @ref{582,,Py_TPFLAGS_DISALLOW_INSTANTIATION} flag to disallow creating
instances of the type in Python.

`Inheritance:'

This field is inherited by subtypes, except it is not inherited by
@ref{77f,,static types} whose @ref{20b8,,tp_base}
is @code{NULL} or @code{&PyBaseObject_Type}.

`Padrão:'

For @ref{77f,,static types} this field has no default.
This means if the slot is defined as @code{NULL}, the type cannot be called
to create new instances; presumably there is some other way to create
instances, like a factory function.
@end deffn

@geindex PyTypeObject.tp_free (C member)
@anchor{c-api/typeobj c PyTypeObject tp_free}@anchor{4b79}
@deffn {C Membro} @ref{50bf,,freefunc} @ref{ab4,,PyTypeObject}.tp_free

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_free} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_free (C macro)
@anchor{c-api/typeobj c Py_tp_free}@anchor{4e22}

An optional pointer to an instance deallocation function.  Its signature is:

@example
void tp_free(void *self);
@end example

An initializer that is compatible with this signature is @ref{c80,,PyObject_Free()}.

`Inheritance:'

This field is inherited by static subtypes, but not by dynamic
subtypes (subtypes created by a class statement)

`Padrão:'

In dynamic subtypes, this field is set to a deallocator suitable to
match @ref{a75,,PyType_GenericAlloc()} and the value of the
@ref{77d,,Py_TPFLAGS_HAVE_GC} flag bit.

For static subtypes, @ref{4c0e,,PyBaseObject_Type} uses @ref{1519,,PyObject_Del()}.
@end deffn

@geindex PyTypeObject.tp_is_gc (C member)
@anchor{c-api/typeobj c PyTypeObject tp_is_gc}@anchor{526f}
@deffn {C Membro} @ref{4e40,,inquiry} @ref{ab4,,PyTypeObject}.tp_is_gc

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_is_gc} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_is_gc (C macro)
@anchor{c-api/typeobj c Py_tp_is_gc}@anchor{4e28}

An optional pointer to a function called by the garbage collector.

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{19fd,,tp_flags} field, and check the @ref{77d,,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

(The only example of this are types themselves.  The metatype,
@ref{54d,,PyType_Type}, defines this function to distinguish between statically
and @ref{96c,,dynamically allocated types}.)

`Inheritance:'

This field is inherited by subtypes.

`Padrão:'

This slot has no default.  If this field is @code{NULL},
@ref{77d,,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{5270}
@deffn {C Membro} @ref{339,,PyObject} *@ref{ab4,,PyTypeObject}.tp_bases

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_bases} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_bases (C macro)
@anchor{c-api/typeobj c Py_tp_bases}@anchor{4e19}

Tuple of base types.

This field should be set to @code{NULL} and treated as read-only.
Python will fill it in when the type is @ref{77c,,initialized}.

For dynamically created classes, the @code{Py_tp_bases}
@ref{4d7b,,slot} can be used instead of the `bases' argument
of @ref{57e,,PyType_FromSpecWithBases()}.
The argument form is preferred.

@cartouche
@quotation Aviso 
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

`Inheritance:'

This field is not inherited.
@end deffn

@geindex PyTypeObject.tp_mro (C member)
@anchor{c-api/typeobj c PyTypeObject tp_mro}@anchor{4f7c}
@deffn {C Membro} @ref{339,,PyObject} *@ref{ab4,,PyTypeObject}.tp_mro

Tuple containing the expanded set of base types, starting with the type itself
and ending with @ref{a96,,object}, in Method Resolution Order.

This field should be set to @code{NULL} and treated as read-only.
Python will fill it in when the type is @ref{77c,,initialized}.

`Inheritance:'

This field is not inherited; it is calculated fresh by
@ref{77c,,PyType_Ready()}.
@end deffn

@geindex PyTypeObject.tp_cache (C member)
@anchor{c-api/typeobj c PyTypeObject tp_cache}@anchor{4f7d}
@deffn {C Membro} @ref{339,,PyObject} *@ref{ab4,,PyTypeObject}.tp_cache

Unused.  Internal use only.

`Inheritance:'

This field is not inherited.
@end deffn

@geindex PyTypeObject.tp_subclasses (C member)
@anchor{c-api/typeobj c PyTypeObject tp_subclasses}@anchor{572}
@deffn {C Membro} void *@ref{ab4,,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{573,,__subclasses__()}.


Alterado na versão 3.12: For some types, this field does not hold a valid @ref{339,,PyObject}*.
The type was changed to void* to indicate this.


`Inheritance:'

This field is not inherited.
@end deffn

@geindex PyTypeObject.tp_weaklist (C member)
@anchor{c-api/typeobj c PyTypeObject tp_weaklist}@anchor{4f7e}
@deffn {C Membro} @ref{339,,PyObject} *@ref{ab4,,PyTypeObject}.tp_weaklist

Weak reference list head, for weak references to this type object.  Not
inherited.  Internal use only.


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


`Inheritance:'

This field is not inherited.
@end deffn

@geindex PyTypeObject.tp_del (C member)
@anchor{c-api/typeobj c PyTypeObject tp_del}@anchor{5271}
@deffn {C Membro} @ref{4e38,,destructor} @ref{ab4,,PyTypeObject}.tp_del

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_del} is part of the @ref{553,,ABI Estável}.'
@geindex Py_tp_del (C macro)
@anchor{c-api/typeobj c Py_tp_del}@anchor{4e1d}

This field is deprecated.  Use @ref{ab5,,tp_finalize} instead.
@end deffn

@geindex PyTypeObject.tp_version_tag (C member)
@anchor{c-api/typeobj c PyTypeObject tp_version_tag}@anchor{5272}
@deffn {C Membro} unsigned int @ref{ab4,,PyTypeObject}.tp_version_tag

Used to index into the method cache.  Internal use only.

`Inheritance:'

This field is not inherited.
@end deffn

@geindex PyTypeObject.tp_finalize (C member)
@anchor{c-api/typeobj c PyTypeObject tp_finalize}@anchor{ab5}
@deffn {C Membro} @ref{4e38,,destructor} @ref{ab4,,PyTypeObject}.tp_finalize

` The corresponding @ref{4d7b,,slot ID} @code{Py_tp_finalize} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_tp_finalize (C macro)
@anchor{c-api/typeobj c Py_tp_finalize}@anchor{4e21}

An optional pointer to an instance finalization function.  This is the C
implementation of the @ref{1033,,__del__()} special method.  Its signature
is:

@example
void tp_finalize(PyObject *self);
@end example

If @ref{ab5,,tp_finalize} is set, the interpreter calls it once when
finalizing an instance.  It is called either from the garbage
collector (if the instance is part of an isolated reference cycle) or
just before the object is deallocated.  Either way, it is guaranteed
to be called before attempting to break reference cycles, ensuring
that it finds the object in a sane state.

@ref{ab5,,tp_finalize} should not mutate the current exception status;
therefore, a recommended way to write a non-trivial finalizer is:

@example
static void
local_finalize(PyObject *self)
@{
    /* Save the current exception, if any. */
    PyObject *exc = PyErr_GetRaisedException();

    /* ... */

    /* Restore the saved exception. */
    PyErr_SetRaisedException(exc);
@}
@end example

`Inheritance:'

This field is inherited by subtypes.


Adicionado na versão 3.4.



Alterado na versão 3.8: Before version 3.8 it was necessary to set the
@ref{3f2,,Py_TPFLAGS_HAVE_FINALIZE} flags bit in order for this field to be
used.  This is no longer required.



@subsubheading Ver também


“Finalização segura de objetos” (
@geindex Propostas de Melhorias do Python; 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{4f7b}
@deffn {C Membro} @ref{557,,vectorcallfunc} @ref{ab4,,PyTypeObject}.tp_vectorcall

Vectorcall function to use for calls of this type object.
In other words, it is used to implement
@ref{552,,vectorcall} for @code{type.__call__}.
If @code{tp_vectorcall} is @code{NULL}, the default call implementation
using @ref{580,,__new__()} and @ref{6b0,,__init__()} is used.

`Inheritance:'

This field is never inherited.


Adicionado na versão 3.9: (the field exists since 3.8 but it’s only used since 3.9)

@end deffn

@geindex PyTypeObject.tp_watched (C member)
@anchor{c-api/typeobj c PyTypeObject tp_watched}@anchor{5273}
@deffn {C Membro} unsigned char @ref{ab4,,PyTypeObject}.tp_watched

Internal. Do not use.


Adicionado na versão 3.12.

@end deffn

@node Static Types,Tipos no heap,PyTypeObject Slots,Estruturas de objetos tipo
@anchor{c-api/typeobj id4}@anchor{52ba}@anchor{c-api/typeobj static-types}@anchor{77f}
@subsubsection Static Types


Traditionally, types defined in C code are `static', that is,
a static @ref{ab4,,PyTypeObject} structure is defined directly in code
and initialized using @ref{77c,,PyType_Ready()}.

This results in types that are limited relative to types defined in Python:


@itemize *

@item 
Static types are limited to one base, i.e. they cannot use multiple
inheritance.

@item 
Static type objects (but not necessarily their instances) are immutable.
It is not possible to add or modify the type object’s attributes from Python.

@item 
Static type objects are shared across
@ref{587,,sub-interpreters}, so they should not
include any subinterpreter-specific state.
@end itemize

Also, since @ref{ab4,,PyTypeObject} is only part of the @ref{396,,Limited API} as an opaque struct, any extension modules using static types must be
compiled for a specific Python minor version.

@node Tipos no heap,Number Object Structures,Static Types,Estruturas de objetos tipo
@anchor{c-api/typeobj heap-types}@anchor{96c}@anchor{c-api/typeobj id5}@anchor{52bb}
@subsubsection Tipos no heap


An alternative to @ref{77f,,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{8b4,,Py_TPFLAGS_HEAPTYPE}
flag set.

This is done by filling a @ref{180b,,PyType_Spec} structure and calling
@ref{57d,,PyType_FromSpec()}, @ref{57e,,PyType_FromSpecWithBases()},
@ref{551,,PyType_FromModuleAndSpec()}, or @ref{550,,PyType_FromMetaclass()}.

@node Number Object Structures,Mapping Object Structures,Tipos no heap,Estruturas de objetos tipo
@anchor{c-api/typeobj number-object-structures}@anchor{52bc}@anchor{c-api/typeobj number-structs}@anchor{52ab}
@subsubsection Number Object Structures


@geindex PyNumberMethods (C type)
@anchor{c-api/typeobj c PyNumberMethods}@anchor{1465}
@deffn {C Tipo} type PyNumberMethods

This structure holds pointers to the functions which an object uses to
implement the number protocol.  Each function is used by the function of
similar name documented in the @ref{4f29,,Protocolo de número} section.

@c XXX Drop the definition?

Here is the structure definition:

@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 
Binary and ternary functions must check the type of all their operands,
and implement the necessary conversions (at least one of the operands is
an instance of the defined type).  If the operation is not defined for the
given operands, binary and ternary functions must return
@code{Py_NotImplemented}, if another error occurred they must return @code{NULL}
and set an exception.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
The @ref{5294,,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{4f6e}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_add

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_add} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_add (C macro)
@anchor{c-api/typeobj c Py_nb_add}@anchor{4ded}
@end deffn

@geindex PyNumberMethods.nb_subtract (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_subtract}@anchor{527b}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_subtract

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_subtract} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_subtract (C macro)
@anchor{c-api/typeobj c Py_nb_subtract}@anchor{4e0c}
@end deffn

@geindex PyNumberMethods.nb_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_multiply}@anchor{527d}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_multiply

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_multiply} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_multiply (C macro)
@anchor{c-api/typeobj c Py_nb_multiply}@anchor{4e05}
@end deffn

@geindex PyNumberMethods.nb_remainder (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_remainder}@anchor{527f}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_remainder

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_remainder} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_remainder (C macro)
@anchor{c-api/typeobj c Py_nb_remainder}@anchor{4e0a}
@end deffn

@geindex PyNumberMethods.nb_divmod (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_divmod}@anchor{5281}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_divmod

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_divmod} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_divmod (C macro)
@anchor{c-api/typeobj c Py_nb_divmod}@anchor{4df0}
@end deffn

@geindex PyNumberMethods.nb_power (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_power}@anchor{5282}
@deffn {C Membro} @ref{4e4e,,ternaryfunc} @ref{1465,,PyNumberMethods}.nb_power

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_power} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_power (C macro)
@anchor{c-api/typeobj c Py_nb_power}@anchor{4e09}
@end deffn

@geindex PyNumberMethods.nb_negative (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_negative}@anchor{5284}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_negative

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_negative} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_negative (C macro)
@anchor{c-api/typeobj c Py_nb_negative}@anchor{4e06}
@end deffn

@geindex PyNumberMethods.nb_positive (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_positive}@anchor{5285}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_positive

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_positive} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_positive (C macro)
@anchor{c-api/typeobj c Py_nb_positive}@anchor{4e08}
@end deffn

@geindex PyNumberMethods.nb_absolute (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_absolute}@anchor{5286}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_absolute

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_absolute} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_absolute (C macro)
@anchor{c-api/typeobj c Py_nb_absolute}@anchor{4dec}
@end deffn

@geindex PyNumberMethods.nb_bool (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_bool}@anchor{5287}
@deffn {C Membro} @ref{4e40,,inquiry} @ref{1465,,PyNumberMethods}.nb_bool

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_bool} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_bool (C macro)
@anchor{c-api/typeobj c Py_nb_bool}@anchor{4def}
@end deffn

@geindex PyNumberMethods.nb_invert (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_invert}@anchor{5288}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_invert

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_invert} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_invert (C macro)
@anchor{c-api/typeobj c Py_nb_invert}@anchor{4e02}
@end deffn

@geindex PyNumberMethods.nb_lshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_lshift}@anchor{5289}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_lshift

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_lshift} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_lshift (C macro)
@anchor{c-api/typeobj c Py_nb_lshift}@anchor{4e03}
@end deffn

@geindex PyNumberMethods.nb_rshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_rshift}@anchor{528b}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_rshift

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_rshift} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_rshift (C macro)
@anchor{c-api/typeobj c Py_nb_rshift}@anchor{4e0b}
@end deffn

@geindex PyNumberMethods.nb_and (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_and}@anchor{528d}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_and

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_and} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_and (C macro)
@anchor{c-api/typeobj c Py_nb_and}@anchor{4dee}
@end deffn

@geindex PyNumberMethods.nb_xor (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_xor}@anchor{528f}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_xor

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_xor} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_xor (C macro)
@anchor{c-api/typeobj c Py_nb_xor}@anchor{4e0e}
@end deffn

@geindex PyNumberMethods.nb_or (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_or}@anchor{5291}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_or

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_or} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_or (C macro)
@anchor{c-api/typeobj c Py_nb_or}@anchor{4e07}
@end deffn

@geindex PyNumberMethods.nb_int (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_int}@anchor{5293}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_int

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_int} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_int (C macro)
@anchor{c-api/typeobj c Py_nb_int}@anchor{4e01}
@end deffn

@geindex PyNumberMethods.nb_reserved (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_reserved}@anchor{5294}
@deffn {C Membro} void *@ref{1465,,PyNumberMethods}.nb_reserved
@end deffn

@geindex PyNumberMethods.nb_float (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_float}@anchor{5295}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_float

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_float} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_float (C macro)
@anchor{c-api/typeobj c Py_nb_float}@anchor{4df1}
@end deffn

@geindex PyNumberMethods.nb_inplace_add (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_add}@anchor{527a}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_add

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_add} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_add (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_add}@anchor{4df4}
@end deffn

@geindex PyNumberMethods.nb_inplace_subtract (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_subtract}@anchor{527c}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_subtract

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_subtract} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_subtract (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_subtract}@anchor{4dfe}
@end deffn

@geindex PyNumberMethods.nb_inplace_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_multiply}@anchor{527e}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_multiply

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_multiply} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_multiply (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_multiply}@anchor{4df9}
@end deffn

@geindex PyNumberMethods.nb_inplace_remainder (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_remainder}@anchor{5280}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_remainder

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_remainder} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_remainder (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_remainder}@anchor{4dfc}
@end deffn

@geindex PyNumberMethods.nb_inplace_power (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_power}@anchor{5283}
@deffn {C Membro} @ref{4e4e,,ternaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_power

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_power} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_power (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_power}@anchor{4dfb}
@end deffn

@geindex PyNumberMethods.nb_inplace_lshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_lshift}@anchor{528a}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_lshift

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_lshift} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_lshift (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_lshift}@anchor{4df7}
@end deffn

@geindex PyNumberMethods.nb_inplace_rshift (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_rshift}@anchor{528c}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_rshift

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_rshift} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_rshift (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_rshift}@anchor{4dfd}
@end deffn

@geindex PyNumberMethods.nb_inplace_and (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_and}@anchor{528e}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_and

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_and} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_and (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_and}@anchor{4df5}
@end deffn

@geindex PyNumberMethods.nb_inplace_xor (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_xor}@anchor{5290}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_xor

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_xor} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_xor (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_xor}@anchor{4e00}
@end deffn

@geindex PyNumberMethods.nb_inplace_or (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_or}@anchor{5292}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_or

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_or} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_or (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_or}@anchor{4dfa}
@end deffn

@geindex PyNumberMethods.nb_floor_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_floor_divide}@anchor{5296}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_floor_divide

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_floor_divide} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_floor_divide (C macro)
@anchor{c-api/typeobj c Py_nb_floor_divide}@anchor{4df2}
@end deffn

@geindex PyNumberMethods.nb_true_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_true_divide}@anchor{5298}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_true_divide

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_true_divide} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_true_divide (C macro)
@anchor{c-api/typeobj c Py_nb_true_divide}@anchor{4e0d}
@end deffn

@geindex PyNumberMethods.nb_inplace_floor_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_floor_divide}@anchor{5297}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_floor_divide

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_floor_divide} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_floor_divide (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_floor_divide}@anchor{4df6}
@end deffn

@geindex PyNumberMethods.nb_inplace_true_divide (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_true_divide}@anchor{5299}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_true_divide

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_true_divide} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_inplace_true_divide (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_true_divide}@anchor{4dff}
@end deffn

@geindex PyNumberMethods.nb_index (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_index}@anchor{1464}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{1465,,PyNumberMethods}.nb_index

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_index} is part of the @ref{553,,ABI Estável}.'
@geindex Py_nb_index (C macro)
@anchor{c-api/typeobj c Py_nb_index}@anchor{4df3}
@end deffn

@geindex PyNumberMethods.nb_matrix_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_matrix_multiply}@anchor{529a}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_matrix_multiply

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_matrix_multiply} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_nb_matrix_multiply (C macro)
@anchor{c-api/typeobj c Py_nb_matrix_multiply}@anchor{4e04}
@end deffn

@geindex PyNumberMethods.nb_inplace_matrix_multiply (C member)
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_matrix_multiply}@anchor{529b}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{1465,,PyNumberMethods}.nb_inplace_matrix_multiply

` The corresponding @ref{4d7b,,slot ID} @code{Py_nb_inplace_matrix_multiply} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_nb_inplace_matrix_multiply (C macro)
@anchor{c-api/typeobj c Py_nb_inplace_matrix_multiply}@anchor{4df8}
@end deffn

@node Mapping Object Structures,Sequence Object Structures,Number Object Structures,Estruturas de objetos tipo
@anchor{c-api/typeobj mapping-object-structures}@anchor{52bd}@anchor{c-api/typeobj mapping-structs}@anchor{52ad}
@subsubsection Mapping Object Structures


@geindex PyMappingMethods (C type)
@anchor{c-api/typeobj c PyMappingMethods}@anchor{4b9e}
@deffn {C Tipo} type PyMappingMethods

This structure holds pointers to the functions which an object uses to
implement the mapping protocol.  It has three members:
@end deffn

@geindex PyMappingMethods.mp_length (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_length}@anchor{529c}
@deffn {C Membro} @ref{4e42,,lenfunc} @ref{4b9e,,PyMappingMethods}.mp_length

` The corresponding @ref{4d7b,,slot ID} @code{Py_mp_length} is part of the @ref{553,,ABI Estável}.'
@geindex Py_mp_length (C macro)
@anchor{c-api/typeobj c Py_mp_length}@anchor{4dea}

This function is used by @ref{1bd0,,PyMapping_Size()} and
@ref{4d35,,PyObject_Size()}, and has the same signature.  This slot may be set to
@code{NULL} if the object has no defined length.
@end deffn

@geindex PyMappingMethods.mp_subscript (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_subscript}@anchor{1a83}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{4b9e,,PyMappingMethods}.mp_subscript

` The corresponding @ref{4d7b,,slot ID} @code{Py_mp_subscript} is part of the @ref{553,,ABI Estável}.'
@geindex Py_mp_subscript (C macro)
@anchor{c-api/typeobj c Py_mp_subscript}@anchor{4deb}

This function is used by @ref{4be2,,PyObject_GetItem()} and
@ref{4d43,,PySequence_GetSlice()}, and has the same signature as
@code{PyObject_GetItem()}.  This slot must be filled for the
@ref{4ced,,PyMapping_Check()} function to return @code{1}, it can be @code{NULL}
otherwise.
@end deffn

@geindex PyMappingMethods.mp_ass_subscript (C member)
@anchor{c-api/typeobj c PyMappingMethods mp_ass_subscript}@anchor{529d}
@deffn {C Membro} @ref{4e44,,objobjargproc} @ref{4b9e,,PyMappingMethods}.mp_ass_subscript

` The corresponding @ref{4d7b,,slot ID} @code{Py_mp_ass_subscript} is part of the @ref{553,,ABI Estável}.'
@geindex Py_mp_ass_subscript (C macro)
@anchor{c-api/typeobj c Py_mp_ass_subscript}@anchor{4de9}

This function is used by @ref{4be0,,PyObject_SetItem()},
@ref{4d27,,PyObject_DelItem()}, @ref{4d4a,,PySequence_SetSlice()} and
@ref{4d41,,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 Sequence Object Structures,Buffer Object Structures,Mapping Object Structures,Estruturas de objetos tipo
@anchor{c-api/typeobj sequence-object-structures}@anchor{52be}@anchor{c-api/typeobj sequence-structs}@anchor{52ac}
@subsubsection Sequence Object Structures


@geindex PySequenceMethods (C type)
@anchor{c-api/typeobj c PySequenceMethods}@anchor{4b9d}
@deffn {C Tipo} type PySequenceMethods

This structure holds pointers to the functions which an object uses to
implement the sequence protocol.
@end deffn

@geindex PySequenceMethods.sq_length (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_length}@anchor{4f78}
@deffn {C Membro} @ref{4e42,,lenfunc} @ref{4b9d,,PySequenceMethods}.sq_length

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_length} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_length (C macro)
@anchor{c-api/typeobj c Py_sq_length}@anchor{4e15}

This function is used by @ref{1bcc,,PySequence_Size()} and
@ref{4d35,,PyObject_Size()}, and has the same signature.  It is also used for
handling negative indices via the @ref{1a82,,sq_item}
and the @ref{52a0,,sq_ass_item} slots.
@end deffn

@geindex PySequenceMethods.sq_concat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_concat}@anchor{529e}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{4b9d,,PySequenceMethods}.sq_concat

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_concat} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_concat (C macro)
@anchor{c-api/typeobj c Py_sq_concat}@anchor{4e10}

This function is used by @ref{4d3e,,PySequence_Concat()} and has the same
signature.  It is also used by the @code{+} operator, after trying the numeric
addition via the @ref{4f6e,,nb_add} slot.
@end deffn

@geindex PySequenceMethods.sq_repeat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_repeat}@anchor{529f}
@deffn {C Membro} @ref{4e4c,,ssizeargfunc} @ref{4b9d,,PySequenceMethods}.sq_repeat

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_repeat} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_repeat (C macro)
@anchor{c-api/typeobj c Py_sq_repeat}@anchor{4e16}

This function is used by @ref{4d49,,PySequence_Repeat()} and has the same
signature.  It is also used by the @code{*} operator, after trying numeric
multiplication via the @ref{527d,,nb_multiply} slot.
@end deffn

@geindex PySequenceMethods.sq_item (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_item}@anchor{1a82}
@deffn {C Membro} @ref{4e4c,,ssizeargfunc} @ref{4b9d,,PySequenceMethods}.sq_item

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_item} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_item (C macro)
@anchor{c-api/typeobj c Py_sq_item}@anchor{4e14}

This function is used by @ref{1bcd,,PySequence_GetItem()} and has the same
signature.  It is also used by @ref{4be2,,PyObject_GetItem()}, after trying
the subscription via the @ref{1a83,,mp_subscript} slot.
This slot must be filled for the @ref{4d3d,,PySequence_Check()}
function to return @code{1}, it can be @code{NULL} otherwise.

Negative indexes are handled as follows: if the @ref{4f78,,sq_length} slot is
filled, it is called and the sequence length is used to compute a positive
index which is passed to  @ref{1a82,,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{52a0}
@deffn {C Membro} @ref{4e4d,,ssizeobjargproc} @ref{4b9d,,PySequenceMethods}.sq_ass_item

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_ass_item} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_ass_item (C macro)
@anchor{c-api/typeobj c Py_sq_ass_item}@anchor{4e0f}

This function is used by @ref{1bce,,PySequence_SetItem()} and has the same
signature.  It is also used by @ref{4be0,,PyObject_SetItem()} and
@ref{4d27,,PyObject_DelItem()}, after trying the item assignment and deletion
via the @ref{529d,,mp_ass_subscript} slot.
This slot may be left to @code{NULL} if the object does not support
item assignment and deletion.
@end deffn

@geindex PySequenceMethods.sq_contains (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_contains}@anchor{52a1}
@deffn {C Membro} @ref{4e45,,objobjproc} @ref{4b9d,,PySequenceMethods}.sq_contains

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_contains} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_contains (C macro)
@anchor{c-api/typeobj c Py_sq_contains}@anchor{4e11}

This function may be used by @ref{4d3f,,PySequence_Contains()} and has the same
signature.  This slot may be left to @code{NULL}, in this case
@code{PySequence_Contains()} simply traverses the sequence until it
finds a match.
@end deffn

@geindex PySequenceMethods.sq_inplace_concat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_concat}@anchor{52a2}
@deffn {C Membro} @ref{4e35,,binaryfunc} @ref{4b9d,,PySequenceMethods}.sq_inplace_concat

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_inplace_concat} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_inplace_concat (C macro)
@anchor{c-api/typeobj c Py_sq_inplace_concat}@anchor{4e12}

This function is used by @ref{4d44,,PySequence_InPlaceConcat()} and has the same
signature.  It should modify its first operand, and return it.  This slot
may be left to @code{NULL}, in this case @code{PySequence_InPlaceConcat()}
will fall back to @ref{4d3e,,PySequence_Concat()}.  It is also used by the
augmented assignment @code{+=}, after trying numeric in-place addition
via the @ref{527a,,nb_inplace_add} slot.
@end deffn

@geindex PySequenceMethods.sq_inplace_repeat (C member)
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_repeat}@anchor{52a3}
@deffn {C Membro} @ref{4e4c,,ssizeargfunc} @ref{4b9d,,PySequenceMethods}.sq_inplace_repeat

` The corresponding @ref{4d7b,,slot ID} @code{Py_sq_inplace_repeat} is part of the @ref{553,,ABI Estável}.'
@geindex Py_sq_inplace_repeat (C macro)
@anchor{c-api/typeobj c Py_sq_inplace_repeat}@anchor{4e13}

This function is used by @ref{4d45,,PySequence_InPlaceRepeat()} and has the same
signature.  It should modify its first operand, and return it.  This slot
may be left to @code{NULL}, in this case @code{PySequence_InPlaceRepeat()}
will fall back to @ref{4d49,,PySequence_Repeat()}.  It is also used by the
augmented assignment @code{*=}, after trying numeric in-place multiplication
via the @ref{527e,,nb_inplace_multiply} slot.
@end deffn

@node Buffer Object Structures,Async Object Structures,Sequence Object Structures,Estruturas de objetos tipo
@anchor{c-api/typeobj buffer-object-structures}@anchor{52bf}@anchor{c-api/typeobj buffer-structs}@anchor{4f43}
@subsubsection Buffer Object Structures


@geindex PyBufferProcs (C type)
@anchor{c-api/typeobj c PyBufferProcs}@anchor{4f7f}
@deffn {C Tipo} type PyBufferProcs

This structure holds pointers to the functions required by the
@ref{2e8,,Buffer protocol}. The protocol defines how
an exporter object can expose its internal data to consumer objects.
@end deffn

@geindex PyBufferProcs.bf_getbuffer (C member)
@anchor{c-api/typeobj c PyBufferProcs bf_getbuffer}@anchor{762}
@deffn {C Membro} @ref{4e3b,,getbufferproc} @ref{4f7f,,PyBufferProcs}.bf_getbuffer

` The corresponding @ref{4d7b,,slot ID} @code{Py_bf_getbuffer} is part of the @ref{553,,ABI Estável} desde a versão 3.11.'
@geindex Py_bf_getbuffer (C macro)
@anchor{c-api/typeobj c Py_bf_getbuffer}@anchor{4de5}

The signature of this function is:

@example
int (PyObject *exporter, Py_buffer *view, int flags);
@end example

Handle a request to `exporter' to fill in `view' as specified by `flags'.
Except for point (3), an implementation of this function MUST take these
steps:


@enumerate 

@item 
Check if the request can be met. If not, raise @ref{15bd,,BufferError},
set view->obj to @code{NULL} and return @code{-1}.

@item 
Fill in the requested fields.

@item 
Increment an internal counter for the number of exports.

@item 
Set view->obj to `exporter' and increment view->obj.

@item 
Retorna @code{0}.
@end enumerate

If `exporter' is part of a chain or tree of buffer providers, two main
schemes can be used:


@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

The individual fields of `view' are described in section
@ref{4f44,,Buffer structure}, the rules how an exporter
must react to specific requests are in section
@ref{4705,,Buffer request types}.

All memory pointed to in the @ref{758,,Py_buffer} structure belongs to
the exporter and must remain valid until there are no consumers left.
@ref{4f4d,,format}, @ref{4f4e,,shape},
@ref{4f48,,strides}, @ref{4f50,,suboffsets}
and @ref{4f52,,internal}
are read-only for the consumer.

@ref{760,,PyBuffer_FillInfo()} provides an easy way of exposing a simple
bytes buffer while dealing correctly with all request types.

@ref{399,,PyObject_GetBuffer()} is the interface for the consumer that
wraps this function.
@end deffn

@geindex PyBufferProcs.bf_releasebuffer (C member)
@anchor{c-api/typeobj c PyBufferProcs bf_releasebuffer}@anchor{763}
@deffn {C Membro} @ref{4e46,,releasebufferproc} @ref{4f7f,,PyBufferProcs}.bf_releasebuffer

` The corresponding @ref{4d7b,,slot ID} @code{Py_bf_releasebuffer} is part of the @ref{553,,ABI Estável} desde a versão 3.11.'
@geindex Py_bf_releasebuffer (C macro)
@anchor{c-api/typeobj c Py_bf_releasebuffer}@anchor{4de6}

The signature of this function is:

@example
void (PyObject *exporter, Py_buffer *view);
@end example

Handle a request to release the resources of the buffer. If no resources
need to be released, @ref{763,,PyBufferProcs.bf_releasebuffer} may be
@code{NULL}. Otherwise, a standard implementation of this function will take
these optional steps:


@enumerate 

@item 
Decrement an internal counter for the number of exports.

@item 
If the counter is @code{0}, free all memory associated with `view'.
@end enumerate

The exporter MUST use the @ref{4f52,,internal} field to keep
track of buffer-specific resources. This field is guaranteed to remain
constant, while a consumer MAY pass a copy of the original buffer as the
`view' argument.

This function MUST NOT decrement view->obj, since that is
done automatically in @ref{39a,,PyBuffer_Release()} (this scheme is
useful for breaking reference cycles).

@ref{39a,,PyBuffer_Release()} is the interface for the consumer that
wraps this function.
@end deffn

@node Async Object Structures,Slot Type typedefs,Buffer Object Structures,Estruturas de objetos tipo
@anchor{c-api/typeobj async-object-structures}@anchor{52c0}@anchor{c-api/typeobj async-structs}@anchor{52aa}
@subsubsection Async Object Structures



Adicionado na versão 3.5.


@geindex PyAsyncMethods (C type)
@anchor{c-api/typeobj c PyAsyncMethods}@anchor{4f77}
@deffn {C Tipo} type PyAsyncMethods

This structure holds pointers to the functions required to implement
@ref{1ad,,awaitable} and @ref{1ab,,asynchronous iterator} objects.

Here is the structure definition:

@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{5275}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{4f77,,PyAsyncMethods}.am_await

` The corresponding @ref{4d7b,,slot ID} @code{Py_am_await} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_am_await (C macro)
@anchor{c-api/typeobj c Py_am_await}@anchor{4de3}

The signature of this function is:

@example
PyObject *am_await(PyObject *self);
@end example

The returned object must be an @ref{1ac,,iterator}, i.e. @ref{1a3e,,PyIter_Check()}
must return @code{1} for it.

This slot may be set to @code{NULL} if an object is not an @ref{1ad,,awaitable}.
@end deffn

@geindex PyAsyncMethods.am_aiter (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_aiter}@anchor{5276}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{4f77,,PyAsyncMethods}.am_aiter

` The corresponding @ref{4d7b,,slot ID} @code{Py_am_aiter} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_am_aiter (C macro)
@anchor{c-api/typeobj c Py_am_aiter}@anchor{4de1}

The signature of this function is:

@example
PyObject *am_aiter(PyObject *self);
@end example

Must return an @ref{1ab,,asynchronous iterator} object.
See @ref{1659,,__anext__()} for details.

This slot may be set to @code{NULL} if an object does not implement
asynchronous iteration protocol.
@end deffn

@geindex PyAsyncMethods.am_anext (C member)
@anchor{c-api/typeobj c PyAsyncMethods am_anext}@anchor{5277}
@deffn {C Membro} @ref{4e50,,unaryfunc} @ref{4f77,,PyAsyncMethods}.am_anext

` The corresponding @ref{4d7b,,slot ID} @code{Py_am_anext} is part of the @ref{553,,ABI Estável} desde a versão 3.5.'
@geindex Py_am_anext (C macro)
@anchor{c-api/typeobj c Py_am_anext}@anchor{4de2}

The signature of this function is:

@example
PyObject *am_anext(PyObject *self);
@end example

Must return an @ref{1ad,,awaitable} object.
See @ref{1659,,__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{5278}
@deffn {C Membro} @ref{5279,,sendfunc} @ref{4f77,,PyAsyncMethods}.am_send

` The corresponding @ref{4d7b,,slot ID} @code{Py_am_send} is part of the @ref{553,,ABI Estável} desde a versão 3.10.'
@geindex Py_am_send (C macro)
@anchor{c-api/typeobj c Py_am_send}@anchor{4de4}

The signature of this function is:

@example
PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);
@end example

See @ref{89c,,PyIter_Send()} for details.
This slot may be set to @code{NULL}.


Adicionado na versão 3.10.

@end deffn

@node Slot Type typedefs,Exemplos<38>,Async Object Structures,Estruturas de objetos tipo
@anchor{c-api/typeobj id6}@anchor{52a5}@anchor{c-api/typeobj slot-type-typedefs}@anchor{52c1}
@subsubsection Slot Type typedefs


@geindex allocfunc (C type)
@anchor{c-api/typeobj c allocfunc}@anchor{4e34}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*allocfunc)(@ref{ab4,,PyTypeObject} *cls, @ref{a69,,Py_ssize_t} nitems)
` Parte da @ref{553,,ABI Estável}.'
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{8a3,,ob_refcnt} set to @code{1} and @ref{4b77,,ob_type} set to the type argument.  If
the type’s @ref{20fd,,tp_itemsize} is non-zero, the object’s @ref{4dba,,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{98e,,tp_basicsize}.

This function should not do any other instance initialization, not even to
allocate additional memory; that should be done by @ref{57f,,tp_new}.
@end deffn

@geindex destructor (C type)
@anchor{c-api/typeobj c destructor}@anchor{4e38}
@deffn {C Tipo} typedef void (*destructor)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex freefunc (C type)
@anchor{c-api/typeobj c freefunc}@anchor{50bf}
@deffn {C Tipo} typedef void (*freefunc)(void*)

See @ref{4b79,,tp_free}.
@end deffn

@geindex newfunc (C type)
@anchor{c-api/typeobj c newfunc}@anchor{4e43}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*newfunc)(@ref{ab4,,PyTypeObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{57f,,tp_new}.
@end deffn

@geindex initproc (C type)
@anchor{c-api/typeobj c initproc}@anchor{4e3f}
@deffn {C Tipo} typedef int (*initproc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{581,,tp_init}.
@end deffn

@geindex reprfunc (C type)
@anchor{c-api/typeobj c reprfunc}@anchor{4e47}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*reprfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{4b8d,,tp_repr}.
@end deffn

@geindex getattrfunc (C type)
@anchor{c-api/typeobj c getattrfunc}@anchor{4e39}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*getattrfunc)(@ref{339,,PyObject} *self, char *attr)
` Parte da @ref{553,,ABI Estável}.'
Return the value of the named attribute for the object.
@end deffn

@geindex setattrfunc (C type)
@anchor{c-api/typeobj c setattrfunc}@anchor{4e49}
@deffn {C Tipo} typedef int (*setattrfunc)(@ref{339,,PyObject} *self, char *attr, @ref{339,,PyObject} *value)
` Parte da @ref{553,,ABI Estável}.'
Set the value of the named attribute for the object.
The value argument is set to @code{NULL} to delete the attribute.
@end deffn

@geindex getattrofunc (C type)
@anchor{c-api/typeobj c getattrofunc}@anchor{4e3a}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*getattrofunc)(@ref{339,,PyObject} *self, @ref{339,,PyObject} *attr)
` Parte da @ref{553,,ABI Estável}.'
Return the value of the named attribute for the object.

See @ref{17e6,,tp_getattro}.
@end deffn

@geindex setattrofunc (C type)
@anchor{c-api/typeobj c setattrofunc}@anchor{4e4a}
@deffn {C Tipo} typedef int (*setattrofunc)(@ref{339,,PyObject} *self, @ref{339,,PyObject} *attr, @ref{339,,PyObject} *value)
` Parte da @ref{553,,ABI Estável}.'
Set the value of the named attribute for the object.
The value argument is set to @code{NULL} to delete the attribute.

See @ref{4b91,,tp_setattro}.
@end deffn

@geindex descrgetfunc (C type)
@anchor{c-api/typeobj c descrgetfunc}@anchor{4e36}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*descrgetfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{526e,,tp_descr_get}.
@end deffn

@geindex descrsetfunc (C type)
@anchor{c-api/typeobj c descrsetfunc}@anchor{4e37}
@deffn {C Tipo} typedef int (*descrsetfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{1a40,,tp_descr_set}.
@end deffn

@geindex hashfunc (C type)
@anchor{c-api/typeobj c hashfunc}@anchor{4e3e}
@deffn {C Tipo} typedef @ref{12a5,,Py_hash_t} (*hashfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{4b9f,,tp_hash}.
@end deffn

@geindex richcmpfunc (C type)
@anchor{c-api/typeobj c richcmpfunc}@anchor{4e48}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*richcmpfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, int)
` Parte da @ref{553,,ABI Estável}.'
See @ref{4b99,,tp_richcompare}.
@end deffn

@geindex getiterfunc (C type)
@anchor{c-api/typeobj c getiterfunc}@anchor{4e3c}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*getiterfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{1537,,tp_iter}.
@end deffn

@geindex iternextfunc (C type)
@anchor{c-api/typeobj c iternextfunc}@anchor{4e41}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*iternextfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
See @ref{1538,,tp_iternext}.
@end deffn

@geindex lenfunc (C type)
@anchor{c-api/typeobj c lenfunc}@anchor{4e42}
@deffn {C Tipo} typedef @ref{a69,,Py_ssize_t} (*lenfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex getbufferproc (C type)
@anchor{c-api/typeobj c getbufferproc}@anchor{4e3b}
@deffn {C Tipo} typedef int (*getbufferproc)(@ref{339,,PyObject}*, @ref{758,,Py_buffer}*, int)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@geindex releasebufferproc (C type)
@anchor{c-api/typeobj c releasebufferproc}@anchor{4e46}
@deffn {C Tipo} typedef void (*releasebufferproc)(@ref{339,,PyObject}*, @ref{758,,Py_buffer}*)
` Parte da @ref{553,,ABI Estável} desde a versão 3.12.'
@end deffn

@geindex unaryfunc (C type)
@anchor{c-api/typeobj c unaryfunc}@anchor{4e50}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*unaryfunc)(@ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex binaryfunc (C type)
@anchor{c-api/typeobj c binaryfunc}@anchor{4e35}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*binaryfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex sendfunc (C type)
@anchor{c-api/typeobj c sendfunc}@anchor{5279}
@deffn {C Tipo} typedef @ref{4f3f,,PySendResult} (*sendfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}**)

See @ref{5278,,am_send}.
@end deffn

@geindex ternaryfunc (C type)
@anchor{c-api/typeobj c ternaryfunc}@anchor{4e4e}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*ternaryfunc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex ssizeargfunc (C type)
@anchor{c-api/typeobj c ssizeargfunc}@anchor{4e4c}
@deffn {C Tipo} typedef @ref{339,,PyObject} *(*ssizeargfunc)(@ref{339,,PyObject}*, @ref{a69,,Py_ssize_t})
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex ssizeobjargproc (C type)
@anchor{c-api/typeobj c ssizeobjargproc}@anchor{4e4d}
@deffn {C Tipo} typedef int (*ssizeobjargproc)(@ref{339,,PyObject}*, @ref{a69,,Py_ssize_t}, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex objobjproc (C type)
@anchor{c-api/typeobj c objobjproc}@anchor{4e45}
@deffn {C Tipo} typedef int (*objobjproc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@geindex objobjargproc (C type)
@anchor{c-api/typeobj c objobjargproc}@anchor{4e44}
@deffn {C Tipo} typedef int (*objobjargproc)(@ref{339,,PyObject}*, @ref{339,,PyObject}*, @ref{339,,PyObject}*)
` Parte da @ref{553,,ABI Estável}.'
@end deffn

@node Exemplos<38>,,Slot Type typedefs,Estruturas de objetos tipo
@anchor{c-api/typeobj examples}@anchor{52c2}@anchor{c-api/typeobj typedef-examples}@anchor{5266}
@subsubsection Exemplos


The following are simple examples of Python type definitions.  They
include common usage you may encounter.  Some demonstrate tricky corner
cases.  For more examples, practical info, and a tutorial, see
@ref{4b6f,,Definindo Tipos de Extensão; Tutorial} and @ref{4b87,,Defining Extension Types; Assorted Topics}.

A basic @ref{77f,,static type}:

@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

You may also find older code (especially in the CPython code base)
with a more verbose initializer:

@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

A type that supports weakrefs, instance dicts, and 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{582,,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

The simplest @ref{77f,,static type} with fixed-length instances:

@example
typedef struct @{
    PyObject_HEAD
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
@};
@end example

The simplest @ref{77f,,static type} with variable-length instances:

@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 Suporte a Coleta Cíclica de Lixo,,Estruturas de objetos tipo,Suporte a implementação de Objetos
@anchor{c-api/gcsupport doc}@anchor{52c3}@anchor{c-api/gcsupport supporting-cycle-detection}@anchor{52ae}@anchor{c-api/gcsupport supporting-cyclic-garbage-collection}@anchor{52c4}@anchor{c-api/gcsupport translation-repo}@anchor{52c5}
@subsection Suporte a Coleta Cíclica de Lixo


O suporte do Python para detectar e coletar o lixo, que envolve referencias circulares, requer suporte dos tipos de objetos que são “contêineres” para outros objetos que também podem ser contêineres. Tipos que não armazenam referências a outros tipos de objetos, ou que apenas armazenam referências a tipos atômicos (como números ou strings), não precisam fornecer nenhum suporte explicito para coleta de lixo.

To create a container type, the @ref{19fd,,tp_flags} field of the type object must
include the @ref{77d,,Py_TPFLAGS_HAVE_GC} and provide an implementation of the
@ref{77e,,tp_traverse} handler.  If instances of the type are mutable, a
@ref{4b8b,,tp_clear} implementation must also be provided.


@table @asis

@item @ref{77d,,Py_TPFLAGS_HAVE_GC}

Objetos com esse tipo de sinalizador definido devem estar em conformidade com regras documentadas aqui. Por conveniência esses objetos serão referenciados como objetos de contêiner.
@end table

Construtores para tipos de contêiner devem obedecer a duas regras:


@enumerate 

@item 
The memory for the object must be allocated using @ref{ab1,,PyObject_GC_New}
or @ref{ab2,,PyObject_GC_NewVar}.

@item 
Uma vez que todos os campos que podem conter referências a outros contêineres foram inicializados, deve-se chamar  @ref{154d,,PyObject_GC_Track()}.
@end enumerate

Da mesma forma, o desalocador para o objeto deve estar em conformidade com regras semelhantes:


@enumerate 

@item 
Antes que os campos que fazer referência a outros contêineres sejam invalidados,  @ref{154e,,PyObject_GC_UnTrack()} deve ser chamado.

@item 
A memória destinada ao objeto deve ser desalocada usando @ref{154c,,PyObject_GC_Del()}.

@cartouche
@quotation Aviso 
If a type adds the Py_TPFLAGS_HAVE_GC, then it `must' implement at least
a @ref{77e,,tp_traverse} handler or explicitly use one
from its subclass or subclasses.

When calling @ref{77c,,PyType_Ready()} or some of the APIs that indirectly
call it like @ref{57e,,PyType_FromSpecWithBases()} or
@ref{57d,,PyType_FromSpec()} the interpreter will automatically populate the
@ref{19fd,,tp_flags}, @ref{77e,,tp_traverse}
and @ref{4b8b,,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{77d,,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{ab1}
@deffn {C Macro} PyObject_GC_New (TYPE, typeobj)

Analogous to @ref{98c,,PyObject_New} but for container objects with the
@ref{77d,,Py_TPFLAGS_HAVE_GC} flag set.
@end deffn

@geindex PyObject_GC_NewVar (C macro)
@anchor{c-api/gcsupport c PyObject_GC_NewVar}@anchor{ab2}
@deffn {C Macro} PyObject_GC_NewVar (TYPE, typeobj, size)

Analogous to @ref{98d,,PyObject_NewVar} but for container objects with the
@ref{77d,,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{182d}
@deffn {C Função} @ref{339,,PyObject} *PyUnstable_Object_GC_NewWithExtraData (PyTypeObject *type, size_t extra_size)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Analogous to @ref{ab1,,PyObject_GC_New} but allocates `extra_size'
bytes at the end of the object (at offset
@ref{98e,,tp_basicsize}).
The allocated memory is initialized to zeros,
except for the @ref{339,,Python object header}.

The extra data will be deallocated with the object, but otherwise it is
not managed by Python.

@cartouche
@quotation Aviso 
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{4384,,PyVarObject} and @ref{20fd,,tp_itemsize}
instead.
@end quotation
@end cartouche


Adicionado na versão 3.12.

@end deffn

@geindex PyObject_GC_Resize (C macro)
@anchor{c-api/gcsupport c PyObject_GC_Resize}@anchor{1832}
@deffn {C Macro} PyObject_GC_Resize (TYPE, op, newsize)

Resize an object allocated by @ref{98d,,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{4384,,PyVarObject}*
and must not be tracked by the collector yet.
`newsize' must be of type @ref{a69,,Py_ssize_t}.
@end deffn

@geindex PyObject_GC_Track (C function)
@anchor{c-api/gcsupport c PyObject_GC_Track}@anchor{154d}
@deffn {C Função} void PyObject_GC_Track (PyObject *op)
` Parte da @ref{553,,ABI Estável}.'
Adds the object `op' to the set of container objects tracked by the
collector.  The collector can run at unexpected times so objects must be
valid while being tracked.  This should be called once all the fields
followed by the @ref{77e,,tp_traverse} handler become valid, usually near the
end of the constructor.
@end deffn

@geindex PyObject_IS_GC (C function)
@anchor{c-api/gcsupport c PyObject_IS_GC}@anchor{98b}
@deffn {C Função} int PyObject_IS_GC (PyObject *obj)

Returns non-zero if the object implements the garbage collector protocol,
otherwise returns 0.

The object cannot be tracked by the garbage collector if this function returns 0.
@end deffn

@geindex PyObject_GC_IsTracked (C function)
@anchor{c-api/gcsupport c PyObject_GC_IsTracked}@anchor{97d}
@deffn {C Função} int PyObject_GC_IsTracked (PyObject *op)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Returns 1 if the object type of `op' implements the GC protocol and `op' is being
currently tracked by the garbage collector and 0 otherwise.

This is analogous to the Python function @ref{1352,,gc.is_tracked()}.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_GC_IsFinalized (C function)
@anchor{c-api/gcsupport c PyObject_GC_IsFinalized}@anchor{97e}
@deffn {C Função} int PyObject_GC_IsFinalized (PyObject *op)
` Parte da @ref{553,,ABI Estável} desde a versão 3.9.'
Returns 1 if the object type of `op' implements the GC protocol and `op' has been
already finalized by the garbage collector and 0 otherwise.

This is analogous to the Python function @ref{903,,gc.is_finalized()}.


Adicionado na versão 3.9.

@end deffn

@geindex PyObject_GC_Del (C function)
@anchor{c-api/gcsupport c PyObject_GC_Del}@anchor{154c}
@deffn {C Função} void PyObject_GC_Del (void *op)
` Parte da @ref{553,,ABI Estável}.'
Releases memory allocated to an object using @ref{ab1,,PyObject_GC_New} or
@ref{ab2,,PyObject_GC_NewVar}.
@end deffn

@geindex PyObject_GC_UnTrack (C function)
@anchor{c-api/gcsupport c PyObject_GC_UnTrack}@anchor{154e}
@deffn {C Função} void PyObject_GC_UnTrack (void *op)
` Parte da @ref{553,,ABI Estável}.'
Remove the object `op' from the set of container objects tracked by the
collector.  Note that @ref{154d,,PyObject_GC_Track()} can be called again on
this object to add it back to the set of tracked objects.  The deallocator
(@ref{4b66,,tp_dealloc} handler) should call this for the object before any of
the fields used by the @ref{77e,,tp_traverse} handler become invalid.
@end deffn


Alterado na versão 3.8: The @code{_PyObject_GC_TRACK()} and @code{_PyObject_GC_UNTRACK()} macros
have been removed from the public C API.


The @ref{77e,,tp_traverse} handler accepts a function parameter of this type:

@geindex visitproc (C type)
@anchor{c-api/gcsupport c visitproc}@anchor{4e51}
@deffn {C Tipo} typedef int (*visitproc)(@ref{339,,PyObject} *object, void *arg)
` Parte da @ref{553,,ABI Estável}.'
Type of the visitor function passed to the @ref{77e,,tp_traverse} handler.
The function should be called with an object to traverse as `object' and
the third parameter to the @ref{77e,,tp_traverse} handler as `arg'.  The
Python core uses several visitor functions to implement cyclic garbage
detection; it’s not expected that users will need to write their own
visitor functions.
@end deffn

The @ref{77e,,tp_traverse} handler must have the following type:

@geindex traverseproc (C type)
@anchor{c-api/gcsupport c traverseproc}@anchor{4e4f}
@deffn {C Tipo} typedef int (*traverseproc)(@ref{339,,PyObject} *self, @ref{4e51,,visitproc} visit, void *arg)
` Parte da @ref{553,,ABI Estável}.'
Traversal function for a container object.  Implementations must call the
`visit' function for each object directly contained by `self', with the
parameters to `visit' being the contained object and the `arg' value passed
to the handler.  The `visit' function must not be called with a @code{NULL}
object argument.  If `visit' returns a non-zero value that value should be
returned immediately.

The traversal function must not have any side effects.  Implementations
may not modify the reference counts of any Python objects nor create or
destroy any Python objects.
@end deffn

To simplify writing @ref{77e,,tp_traverse} handlers, a @ref{4b82,,Py_VISIT()} macro is
provided.  In order to use this macro, the @ref{77e,,tp_traverse} implementation
must name its arguments exactly `visit' and `arg':

@geindex Py_VISIT (C macro)
@anchor{c-api/gcsupport c Py_VISIT}@anchor{4b82}
@deffn {C Macro} Py_VISIT (o)

If the @ref{339,,PyObject}* `o' is not @code{NULL}, call the `visit' callback, with arguments `o'
and `arg'.  If `visit' returns a non-zero value, then return it.
Using this macro, @ref{77e,,tp_traverse} handlers
look like:

@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

The @ref{4b8b,,tp_clear} handler must be of the @ref{4e40,,inquiry} type, or @code{NULL}
if the object is immutable.

@geindex inquiry (C type)
@anchor{c-api/gcsupport c inquiry}@anchor{4e40}
@deffn {C Tipo} typedef int (*inquiry)(@ref{339,,PyObject} *self)
` Parte da @ref{553,,ABI Estável}.'
Drop references that may have created reference cycles.  Immutable objects
do not have to define this method since they can never directly create
reference cycles.  Note that the object must still be valid after calling
this method (don’t just call @ref{56f,,Py_DECREF()} on a reference).  The
collector will call this method if it detects that this object is involved
in a reference cycle.
@end deffn

@menu
* Controlando o estado do coletor de lixo:: 
* Querying Garbage Collector State:: 

@end menu

@node Controlando o estado do coletor de lixo,Querying Garbage Collector State,,Suporte a Coleta Cíclica de Lixo
@anchor{c-api/gcsupport controlling-the-garbage-collector-state}@anchor{52c6}
@subsubsection Controlando o estado do coletor de lixo


The C-API provides the following functions for controlling
garbage collection runs.

@geindex PyGC_Collect (C function)
@anchor{c-api/gcsupport c PyGC_Collect}@anchor{995}
@deffn {C Função} @ref{a69,,Py_ssize_t} PyGC_Collect (void)
` Parte da @ref{553,,ABI Estável}.'
Perform a full garbage collection, if the garbage collector is enabled.
(Note that @ref{a43,,gc.collect()} runs it unconditionally.)

Returns the number of collected + unreachable objects which cannot
be collected.
If the garbage collector is disabled or already collecting,
returns @code{0} immediately.
Errors during garbage collection are passed to @ref{1f7,,sys.unraisablehook}.
This function does not raise exceptions.
@end deffn

@geindex PyGC_Enable (C function)
@anchor{c-api/gcsupport c PyGC_Enable}@anchor{8a8}
@deffn {C Função} int PyGC_Enable (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Enable the garbage collector: similar to @ref{46b1,,gc.enable()}.
Returns the previous state, 0 for disabled and 1 for enabled.


Adicionado na versão 3.10.

@end deffn

@geindex PyGC_Disable (C function)
@anchor{c-api/gcsupport c PyGC_Disable}@anchor{8a9}
@deffn {C Função} int PyGC_Disable (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Disable the garbage collector: similar to @ref{46b2,,gc.disable()}.
Returns the previous state, 0 for disabled and 1 for enabled.


Adicionado na versão 3.10.

@end deffn

@geindex PyGC_IsEnabled (C function)
@anchor{c-api/gcsupport c PyGC_IsEnabled}@anchor{8aa}
@deffn {C Função} int PyGC_IsEnabled (void)
` Parte da @ref{553,,ABI Estável} desde a versão 3.10.'
Query the state of the garbage collector: similar to @ref{46b3,,gc.isenabled()}.
Returns the current state, 0 for disabled and 1 for enabled.


Adicionado na versão 3.10.

@end deffn

@node Querying Garbage Collector State,,Controlando o estado do coletor de lixo,Suporte a Coleta Cíclica de Lixo
@anchor{c-api/gcsupport querying-garbage-collector-state}@anchor{52c7}
@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{52c8}
@deffn {C Função} void PyUnstable_GC_VisitObjects (gcvisitobjects_t callback, void *arg)

@cartouche
@quotation Esta é uma API Instável. Isso pode se alterado sem aviso em lançamentos menores. `Esta é uma @ref{547,,API Instável}. Isso pode se alterado sem aviso em lançamentos menores.'
@end quotation
@end cartouche

Run supplied `callback' on all live GC-capable objects. `arg' is passed through to
all invocations of `callback'.

@cartouche
@quotation Aviso 
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


Adicionado na versão 3.12.

@end deffn

@geindex gcvisitobjects_t (C type)
@anchor{c-api/gcsupport c gcvisitobjects_t}@anchor{52c9}
@deffn {C Tipo} typedef int (*gcvisitobjects_t)(@ref{339,,PyObject} *object, void *arg)

Type of the visitor function to be passed to @ref{52c8,,PyUnstable_GC_VisitObjects()}.
`arg' is the same as the `arg' passed to @code{PyUnstable_GC_VisitObjects}.
Return @code{1} to continue iteration, return @code{0} to stop iteration. Other return
values are reserved for now so behavior on returning anything else is undefined.


Adicionado na versão 3.12.

@end deffn

@node API e Versionamento de ABI,API C de monitoramento,Suporte a implementação de Objetos,Manual de referência da API Python/C
@anchor{c-api/apiabiversion doc}@anchor{52ca}@anchor{c-api/apiabiversion api-and-abi-versioning}@anchor{52cb}@anchor{c-api/apiabiversion apiabiversion}@anchor{45c7}@anchor{c-api/apiabiversion translation-repo}@anchor{52cc}
@section API e Versionamento de ABI


O CPython expõe seu número de versão nas seguintes macros. Note que estes correspondem com o código da versão que está `construída', não necessariamente a versão usada no `run time'.

Veja @ref{553,,Estabilidade da API C} para uma discussão da estabilidade da API e ABI através das versões.

@geindex PY_MAJOR_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MAJOR_VERSION}@anchor{52cd}
@deffn {C Macro} PY_MAJOR_VERSION

O @code{3} em @code{3.4.1a2}.
@end deffn

@geindex PY_MINOR_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MINOR_VERSION}@anchor{52ce}
@deffn {C Macro} PY_MINOR_VERSION

O @code{4} em @code{3.4.1a2}.
@end deffn

@geindex PY_MICRO_VERSION (C macro)
@anchor{c-api/apiabiversion c PY_MICRO_VERSION}@anchor{52cf}
@deffn {C Macro} PY_MICRO_VERSION

O @code{1} em @code{3.4.1a2}.
@end deffn

@geindex PY_RELEASE_LEVEL (C macro)
@anchor{c-api/apiabiversion c PY_RELEASE_LEVEL}@anchor{52d0}
@deffn {C Macro} PY_RELEASE_LEVEL

O @code{a} em @code{3.4.1a2}. Isto pode ser @code{0xA} para alfa, @code{0xB} para beta, @code{0xC} para o candidato a lançamento ou @code{0xF} para final.
@end deffn

@geindex PY_RELEASE_SERIAL (C macro)
@anchor{c-api/apiabiversion c PY_RELEASE_SERIAL}@anchor{52d1}
@deffn {C Macro} PY_RELEASE_SERIAL

O @code{2} em @code{3.4.1a2}. Zero para os lançamentos finais.
@end deffn

@geindex PY_VERSION_HEX (C macro)
@anchor{c-api/apiabiversion c PY_VERSION_HEX}@anchor{757}
@deffn {C Macro} PY_VERSION_HEX

O número da versão do Python codificado em um único inteiro.

As informações da versão subjacente podem ser achadas tratando-as como um número de 32 bits da seguinte maneira:


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Bytes

@tab

Bits (big endian order)

@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


Assim @code{3.4.1a2} é a versão hex @code{0x030401a2} e @code{3.10.0} é a versãos hex @code{0x030a00f0}.

Use isso para comparações numéricas como, por exemplo, @code{#if PY_VERSION_HEX >= ...}.

Esta versão também está disponível através do símbolo @ref{756,,Py_Version}.
@end deffn

@geindex Py_Version (C var)
@anchor{c-api/apiabiversion c Py_Version}@anchor{756}
@deffn {C Variável} const unsigned long Py_Version
` Parte da @ref{553,,ABI Estável} desde a versão 3.11.'
O número da versão do runtime do Python codificado em um único inteiro constante, com o mesmo formato da macro @ref{757,,PY_VERSION_HEX}. Ele contém a versão do Python usada em tempo de execução.


Adicionado na versão 3.11.

@end deffn

Todas as macros dadas estão definidas em Include/patchlevel.h@footnote{https://github.com/python/cpython/tree/3.13/Include/patchlevel.h}.

@node API C de monitoramento,Gerando eventos de execução,API e Versionamento de ABI,Manual de referência da API Python/C
@anchor{c-api/monitoring doc}@anchor{52d2}@anchor{c-api/monitoring c-api-monitoring}@anchor{15c}@anchor{c-api/monitoring monitoring-c-api}@anchor{52d3}@anchor{c-api/monitoring translation-repo}@anchor{52d4}
@section API C de monitoramento


Adicionada na versão 3.13.

Uma extensão pode precisar interagir com o sistema de monitoramento de eventos. É possível registrar funções de retorno e se inscrever para receber eventos através da API Python exposta em @ref{da,,sys.monitoring}.

@node Gerando eventos de execução,,API C de monitoramento,Manual de referência da API Python/C
@anchor{c-api/monitoring generating-execution-events}@anchor{52d5}
@section Gerando eventos de execução


As funções abaixo permitem que extensões dispararem eventos de monitoramento emulando a execução de código Python. Cada uma dessas funções recebe uma estrutura @code{PyMonitoringState} que contém informação concisa sobre o estado de ativação de eventos, bem como os argumentos dos eventos, que incluem um @code{PyObject*} representando o objeto de código, a posição da instrução no bytecode, e, em alguns casos, argumentos adicionais específicos para o evento (veja @ref{da,,sys.monitoring} para detalhes sobre as assinaturas das funções de retorno de diferentes eventos). O argumento @code{codelike} deve ser uma instância da classe @ref{2df,,types.CodeType} ou de um tipo que a emule.

A VM desabilita o rastreamento quando dispara um evento, de forma que não há necessidade do código do usuário fazer isso.

Funções de monitoramento não devem ser chamadas com uma exceção definida, exceto as marcadas abaixo como funções que trabalham com a exceção atual.

@geindex PyMonitoringState (C type)
@anchor{c-api/monitoring c PyMonitoringState}@anchor{318}
@deffn {C Tipo} type PyMonitoringState

Representação do estado de um tipo de evento. Alocada pelo usuário, enquanto o seu conteúdo é mantido pelas funções da API de monitoramento descritas abaixo.
@end deffn

Todas as funções abaixo retornam 0 para indicar sucesso e -1 (com uma exceção definida) para indicar erro.

Veja @ref{da,,sys.monitoring} para descrições dos eventos.

@geindex PyMonitoring_FirePyStartEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyStartEvent}@anchor{319}
@deffn {C Função} int PyMonitoring_FirePyStartEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{PY_START}.
@end deffn

@geindex PyMonitoring_FirePyResumeEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyResumeEvent}@anchor{31a}
@deffn {C Função} int PyMonitoring_FirePyResumeEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{PY_RESUME}.
@end deffn

@geindex PyMonitoring_FirePyReturnEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyReturnEvent}@anchor{31b}
@deffn {C Função} int PyMonitoring_FirePyReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Dispara um evento @code{PY_RETURN}.
@end deffn

@geindex PyMonitoring_FirePyYieldEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyYieldEvent}@anchor{31c}
@deffn {C Função} int PyMonitoring_FirePyYieldEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Dispara um evento @code{PY_YIELD}.
@end deffn

@geindex PyMonitoring_FireCallEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCallEvent}@anchor{31d}
@deffn {C Função} int PyMonitoring_FireCallEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *callable, PyObject *arg0)

Dispara um evento @code{CALL}.
@end deffn

@geindex PyMonitoring_FireLineEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireLineEvent}@anchor{31e}
@deffn {C Função} int PyMonitoring_FireLineEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, int lineno)

Dispara um evento @code{LINE}.
@end deffn

@geindex PyMonitoring_FireJumpEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireJumpEvent}@anchor{31f}
@deffn {C Função} int PyMonitoring_FireJumpEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

Dispara um evento @code{JUMP}.
@end deffn

@geindex PyMonitoring_FireBranchEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireBranchEvent}@anchor{320}
@deffn {C Função} int PyMonitoring_FireBranchEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

Dispara um evento @code{BRANCH}.
@end deffn

@geindex PyMonitoring_FireCReturnEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCReturnEvent}@anchor{321}
@deffn {C Função} int PyMonitoring_FireCReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

Dispara um evento @code{C_RETURN}.
@end deffn

@geindex PyMonitoring_FirePyThrowEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyThrowEvent}@anchor{322}
@deffn {C Função} int PyMonitoring_FirePyThrowEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{PY_THROW} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireRaiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireRaiseEvent}@anchor{323}
@deffn {C Função} int PyMonitoring_FireRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{RAISE} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireCRaiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireCRaiseEvent}@anchor{324}
@deffn {C Função} int PyMonitoring_FireCRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{C_RAISE} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireReraiseEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireReraiseEvent}@anchor{325}
@deffn {C Função} int PyMonitoring_FireReraiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{RERAISE} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireExceptionHandledEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireExceptionHandledEvent}@anchor{326}
@deffn {C Função} int PyMonitoring_FireExceptionHandledEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{EXCEPTION_HANDLED} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FirePyUnwindEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FirePyUnwindEvent}@anchor{327}
@deffn {C Função} int PyMonitoring_FirePyUnwindEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

Dispara um evento @code{PY_UNWIND} com a exceção atual (conforme retornada por @ref{3f4,,PyErr_GetRaisedException()}).
@end deffn

@geindex PyMonitoring_FireStopIterationEvent (C function)
@anchor{c-api/monitoring c PyMonitoring_FireStopIterationEvent}@anchor{328}
@deffn {C Função} int PyMonitoring_FireStopIterationEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *value)

Dispara um evento @code{STOP_ITERATION}. Se @code{value} for uma instância de @ref{c15,,StopIteration}, ele é usado. Caso contrário, uma nova instância de @ref{c15,,StopIteration} é criada com @code{value} como o argumento.
@end deffn

@menu
* Gerenciando o Estado de um Monitoramento:: 

@end menu

@node Gerenciando o Estado de um Monitoramento,,,Gerando eventos de execução
@anchor{c-api/monitoring managing-the-monitoring-state}@anchor{52d6}
@subsection Gerenciando o Estado de um Monitoramento


Estados de monitoramento podem ser gerenciados com a ajuda de escopos de monitoramento. Um escopo corresponderia tipicamente a um função Python.

@geindex PyMonitoring_EnterScope (C function)
@anchor{c-api/monitoring c PyMonitoring_EnterScope}@anchor{329}
@deffn {C Função} int PyMonitoring_EnterScope (PyMonitoringState *state_array, uint64_t *version, const uint8_t *event_types, Py_ssize_t length)

Insere um escopo monitorado. @code{event_types} é um vetor de IDs de eventos para eventos que podem ser disparados do escopo. Por exemplo, a ID de um evento @code{PY_START} é o valor @code{PY_MONITORING_EVENT_PY_START}, que é numericamente igual ao logaritmo de base 2 de @code{sys.monitoring.events.PY_START}. @code{state_array} é um vetor com uma entrada de estado de monitoramento para cada evento em @code{event_types}, é alocado pelo usuário, mas preenchido por @code{PyMonitoring_EnterScope()} com informações sobre o estado de ativação do evento. O tamanho de @code{event_types} (e, portanto, também de @code{state_array}) é fornecido em @code{length}.

O argumento @code{version} é um ponteiro para um valor que deve ser alocado pelo usuário junto com @code{state_array} e inicializado como 0, e então definido somente pelo próprio @code{PyMonitoring_EnterScope()}. Ele permite que esta função determine se os estados de eventos mudaram desde a chamada anterior, e retorne rapidamente se não mudaram.

Os escopos mencionados aqui são escopos lexicais: uma função, classe ou método. @code{PyMonitoring_EnterScope()} deve ser chamada sempre que o escopo lexical for inserido. Os escopos podem ser inseridos novamente, reutilizando o mesmo `state_array' e `version', em situações como ao emular uma função Python recursiva. Quando a execução de um código semelhante é pausada, como ao emular um gerador, o escopo precisa ser encerrado e inserido novamente.

As macros para `event_types' são:

@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

Evento

@item

@geindex PY_MONITORING_EVENT_BRANCH (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_BRANCH}@anchor{52d7}
@deffn {C Macro} PY_MONITORING_EVENT_BRANCH
@end deffn

@tab

@ref{45dd,,BRANCH}

@item

@geindex PY_MONITORING_EVENT_CALL (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_CALL}@anchor{52d8}
@deffn {C Macro} PY_MONITORING_EVENT_CALL
@end deffn

@tab

@ref{1734,,CALL}

@item

@geindex PY_MONITORING_EVENT_C_RAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RAISE}@anchor{52d9}
@deffn {C Macro} PY_MONITORING_EVENT_C_RAISE
@end deffn

@tab

@ref{45de,,C_RAISE}

@item

@geindex PY_MONITORING_EVENT_C_RETURN (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RETURN}@anchor{52da}
@deffn {C Macro} PY_MONITORING_EVENT_C_RETURN
@end deffn

@tab

@ref{45df,,C_RETURN}

@item

@geindex PY_MONITORING_EVENT_EXCEPTION_HANDLED (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_EXCEPTION_HANDLED}@anchor{52db}
@deffn {C Macro} PY_MONITORING_EVENT_EXCEPTION_HANDLED
@end deffn

@tab

@ref{45e0,,EXCEPTION_HANDLED}

@item

@geindex PY_MONITORING_EVENT_INSTRUCTION (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_INSTRUCTION}@anchor{52dc}
@deffn {C Macro} PY_MONITORING_EVENT_INSTRUCTION
@end deffn

@tab

@ref{45e1,,INSTRUCTION}

@item

@geindex PY_MONITORING_EVENT_JUMP (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_JUMP}@anchor{52dd}
@deffn {C Macro} PY_MONITORING_EVENT_JUMP
@end deffn

@tab

@ref{45e2,,JUMP}

@item

@geindex PY_MONITORING_EVENT_LINE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_LINE}@anchor{52de}
@deffn {C Macro} PY_MONITORING_EVENT_LINE
@end deffn

@tab

@ref{45e3,,LINE}

@item

@geindex PY_MONITORING_EVENT_PY_RESUME (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RESUME}@anchor{52df}
@deffn {C Macro} PY_MONITORING_EVENT_PY_RESUME
@end deffn

@tab

@ref{45e4,,PY_RESUME}

@item

@geindex PY_MONITORING_EVENT_PY_RETURN (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RETURN}@anchor{52e0}
@deffn {C Macro} PY_MONITORING_EVENT_PY_RETURN
@end deffn

@tab

@ref{45e5,,PY_RETURN}

@item

@geindex PY_MONITORING_EVENT_PY_START (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_START}@anchor{52e1}
@deffn {C Macro} PY_MONITORING_EVENT_PY_START
@end deffn

@tab

@ref{45e6,,PY_START}

@item

@geindex PY_MONITORING_EVENT_PY_THROW (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_THROW}@anchor{52e2}
@deffn {C Macro} PY_MONITORING_EVENT_PY_THROW
@end deffn

@tab

@ref{45e7,,PY_THROW}

@item

@geindex PY_MONITORING_EVENT_PY_UNWIND (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_UNWIND}@anchor{52e3}
@deffn {C Macro} PY_MONITORING_EVENT_PY_UNWIND
@end deffn

@tab

@ref{45e8,,PY_UNWIND}

@item

@geindex PY_MONITORING_EVENT_PY_YIELD (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_YIELD}@anchor{52e4}
@deffn {C Macro} PY_MONITORING_EVENT_PY_YIELD
@end deffn

@tab

@ref{45e9,,PY_YIELD}

@item

@geindex PY_MONITORING_EVENT_RAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RAISE}@anchor{52e5}
@deffn {C Macro} PY_MONITORING_EVENT_RAISE
@end deffn

@tab

@ref{16da,,RAISE}

@item

@geindex PY_MONITORING_EVENT_RERAISE (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RERAISE}@anchor{52e6}
@deffn {C Macro} PY_MONITORING_EVENT_RERAISE
@end deffn

@tab

@ref{45eb,,RERAISE}

@item

@geindex PY_MONITORING_EVENT_STOP_ITERATION (C macro)
@anchor{c-api/monitoring c PY_MONITORING_EVENT_STOP_ITERATION}@anchor{52e7}
@deffn {C Macro} PY_MONITORING_EVENT_STOP_ITERATION
@end deffn

@tab

@ref{45ea,,STOP_ITERATION}

@end multitable

@end deffn

@geindex PyMonitoring_ExitScope (C function)
@anchor{c-api/monitoring c PyMonitoring_ExitScope}@anchor{32a}
@deffn {C Função} int PyMonitoring_ExitScope (void)

Sai do último escopo no qual se entrou com @code{PyMonitoring_EnterScope()}.
@end deffn

@geindex PY_MONITORING_IS_INSTRUMENTED_EVENT (C function)
@anchor{c-api/monitoring c PY_MONITORING_IS_INSTRUMENTED_EVENT}@anchor{52e8}
@deffn {C Função} int PY_MONITORING_IS_INSTRUMENTED_EVENT (uint8_t ev)

Retorna verdadeiro se o evento correspondente ao ID do evento `ev' for um @ref{45ef,,evento local}.


Adicionado na versão 3.13.



Descontinuado desde a versão 3.13.3: Esta função está @ref{209,,suavemente descontinuada}.

@end deffn

@node Instalando módulos Python,Python HOWTOs,Manual de referência da API Python/C,Top
@anchor{installing/index doc}@anchor{52e9}@anchor{installing/index installing-index}@anchor{f27}@anchor{installing/index installing-python-modules}@anchor{52ea}@anchor{installing/index translation-repo}@anchor{52eb}
@chapter Instalando módulos Python


@*E-mail: 
@email{distutils-sig@@python.org}


Como um projeto popular de desenvolvimento de código aberto, Python tem uma comunidade de apoio ativa de colaboradores e usuários, que também fazem o seu software disponível para outros desenvolvedores de Python para usar sob os termos da licença de código aberto.

Isso permite aos usuários Python compartilhar e colaborar efetivamente, se beneficiando das soluções que outros já tenham criado para os problemas mais comuns (em alguns casos até mesmo os raros), bem como potencialmente contribuindo com suas próprias soluções para o conjunto de soluções comuns.

Este guia cobre a parte do processo de instalação. Para um guia sobre criar e compartilhar seus próprios projetos Python, confira o Guia de Usuário para Empacotamento de Python@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}.

@cartouche
@quotation Nota 
Para corporações e outros usuários institucionais, esteja ciente que muitas organizações têm suas próprias políticas em relação ao uso e contribuição para o software de código aberto. Por favor, leve em conta essas políticas ao usar as ferramentas de distribuição e instalação fornecidas com o Python.
@end quotation
@end cartouche

@menu
* Termos chave:: 
* Uso básico: Uso básico<3>. 
* Como eu …?:: 
* Problemas comuns de instalação:: 

@end menu

@node Termos chave,Uso básico<3>,,Instalando módulos Python
@anchor{installing/index key-terms}@anchor{52ec}
@section Termos chave



@itemize *

@item 
@code{pip} é o programa de instalação preferido. A partir do Python 3.4, ele é incluído por padrão com os instaladores binários do Python.

@item 
Um `ambiente virtual' é um ambiente Python semi-isolado que permite que pacotes sejam instalados para uso por uma aplicação específica, em vez de serem instaladas em todo o sistema.

@item 
@code{venv} é a ferramenta padrão para criar ambientes virtuais e faz parte do Python desde o Python 3.3. A partir do Python 3.4, o padrão é instalar @code{pip} em todos os ambientes virtuais criados.

@item 
@code{virtualenv} é uma alternativa de terceiros (e predecessora) ao @code{venv}. Ele permite que ambientes virtuais sejam usados em versões do Python anteriores a 3.4, que não fornecem @code{venv} de forma alguma, ou não são capazes de instalar automaticamente o @code{pip} nos ambientes criados.

@item 
O Python Package Index@footnote{https://pypi.org} é um repositório público de pacotes licenciados como código aberto e disponíveis para uso de outros usuários Python

@item 
o Python Packaging Authority@footnote{https://www.pypa.io/} é o grupo de desenvolvedores e autores de documentação responsáveis pela manutenção e evolução das ferramentas de empacotamento padrão e os metadados associados e padrões de formato de arquivo. Eles mantêm uma variedade de ferramentas, documentação e rastreadores de problemas no GitHub@footnote{https://github.com/pypa}.

@item 
@code{distutils} é o sistema original de construção e distribuição adicionado pela primeira vez à biblioteca padrão Python em 1998. Embora o uso direto de @code{distutils} esteja sendo eliminado, ele ainda estabeleceu a base para a infraestrutura de distribuição e empacotamento atual, e não apenas permanece da biblioteca padrão, mas seu nome sobrevive de outras maneiras (como o nome da lista de e-mails usada para coordenar o desenvolvimento de padrões de empacotamento Python).
@end itemize


Alterado na versão 3.5: O uso de @code{venv} agora é recomendado para a criação de ambientes virtuais.



@subsubheading Ver também


Guia de Usuário para Empacotamento de Python: Criando e usando ambientes virtuais@footnote{https://packaging.python.org/pt-br/latest/tutorials/installing-packages/#creating-virtual-environments}


@node Uso básico<3>,Como eu …?,Termos chave,Instalando módulos Python
@anchor{installing/index basic-usage}@anchor{52ed}
@section Uso básico


As ferramentas de empacotamento padrão são todas projetadas para serem usadas na linha de comando.

O comando a seguir instalará a versão mais recente de um módulo e suas dependências do Python Package Index:

@example
python -m pip install AlgumPacote
@end example

@cartouche
@quotation Nota 
Para usuários POSIX (incluindo usuários macOS e Linux), os exemplos neste guia presumem o uso de um @ref{1e86,,ambiente virtual}.

Para usuários do Windows, os exemplos neste guia presumem que a opção de ajustar a variável de ambiente PATH do sistema foi selecionada durante a instalação do Python.
@end quotation
@end cartouche

Também é possível especificar uma versão exata ou mínima diretamente na linha de comando. Ao usar operadores de comparação como @code{>}, @code{<} ou algum outro caractere especial que é interpretado pelo shell, o nome do pacote e a versão devem ser colocados entre aspas duplas:

@example
python -m pip install AlgumPacote==1.0.4    # versão específica
python -m pip install "AlgumPacote>=1.0.4"  # versão mínima
@end example

Normalmente, se um módulo adequado já estiver instalado, tentar instalá-lo novamente não terá efeito. A atualização de módulos existentes deve ser solicitada explicitamente:

@example
python -m pip install --upgrade AlgumPacote
@end example

Mais informações e recursos sobre o @code{pip} e seus recursos podem ser encontrados no Python Packaging User Guide@footnote{https://packaging.python.org}.

A criação de ambientes virtuais é feita através do módulo @ref{111,,venv}. A instalação de pacotes em um ambiente virtual ativo usa os comandos mostrados acima.


@subsubheading Ver também


Guia de Usuário para Empacotamento de Python: Instalando pacotes Python de distribuição@footnote{https://packaging.python.org/pt-br/latest/tutorials/installing-packages/}


@node Como eu …?,Problemas comuns de instalação,Uso básico<3>,Instalando módulos Python
@anchor{installing/index how-do-i}@anchor{52ee}
@section Como eu …?


Estas são respostas rápidas ou links para algumas tarefas comuns.

@menu
* … instalo pip em versões do Python anteriores ao Python 3.4?: … instalo pip em versões do Python anteriores ao Python 3 4?. 
* … instalo pacotes apenas para o usuário atual?:: 
* … instalo pacotes científicos do Python?:: 
* … trabalho com várias versões do Python instaladas em paralelo?:: 

@end menu

@node … instalo pip em versões do Python anteriores ao Python 3 4?,… instalo pacotes apenas para o usuário atual?,,Como eu …?
@anchor{installing/index install-pip-in-versions-of-python-prior-to-python-3-4}@anchor{52ef}
@subsection … instalo @code{pip} em versões do Python anteriores ao Python 3.4?


Python apenas começou a empacotar @code{pip} com Python 3.4. Para versões anteriores, o @code{pip} precisa ser “inicializado” conforme descrito no Python Packaging User Guide.


@subsubheading Ver também


Python Packaging User Guide: Requisitos para instalar pacotes@footnote{https://packaging.python.org/pt-br/latest/tutorials/installing-packages/#requirements-for-installing-packages}


@c installing-per-user-installation:

@node … instalo pacotes apenas para o usuário atual?,… instalo pacotes científicos do Python?,… instalo pip em versões do Python anteriores ao Python 3 4?,Como eu …?
@anchor{installing/index install-packages-just-for-the-current-user}@anchor{52f0}
@subsection … instalo pacotes apenas para o usuário atual?


Passar a opção @code{--user} para @code{python -m pip install} irá instalar um pacote apenas para o usuário atual, ao invés de para todos os usuários do sistema.

@node … instalo pacotes científicos do Python?,… trabalho com várias versões do Python instaladas em paralelo?,… instalo pacotes apenas para o usuário atual?,Como eu …?
@anchor{installing/index install-scientific-python-packages}@anchor{52f1}
@subsection … instalo pacotes científicos do Python?


Vários pacotes científicos do Python têm dependências binárias complexas e atualmente não são fáceis de instalar usando o @code{pip} diretamente. Neste ponto, frequentemente será mais fácil para os usuários instalarem esses pacotes por outros meios@footnote{https://packaging.python.org/science/} ao invés de tentar instalá-los com @code{pip}.


@subsubheading Ver também


Guia de Usuário para Empacotamento de Python: Instalando pacotes científicos@footnote{https://packaging.python.org/pt-br/latest/guides/installing-scientific-packages//}


@node … trabalho com várias versões do Python instaladas em paralelo?,,… instalo pacotes científicos do Python?,Como eu …?
@anchor{installing/index work-with-multiple-versions-of-python-installed-in-parallel}@anchor{52f2}
@subsection … trabalho com várias versões do Python instaladas em paralelo?


No Linux, macOS e outros sistemas POSIX, use os comandos Python com versão em combinação com a opção @code{-m} para executar a cópia apropriada de @code{pip}

@example
python2   -m pip install AlgumPacote  # Python 2 padrão
python2.7 -m pip install AlgumPacote  # Python 2.7 especificamente
python3   -m pip install AlgumPacote  # Python 3 padrão
python3.4 -m pip install AlgumPacote  # Python 3.4 especificamente
@end example

Comandos @code{pip} com versão apropriada também podem estar disponíveis.

No Windows, use o iniciador Python @code{py} em combinação com a opção @code{-m}:

@example
py -2   -m pip install AlgumPacote  # Python 2 padrão
py -2.7 -m pip install AlgumPacote  # Python 2.7 especificamente
py -3   -m pip install AlgumPacote  # Python 3 padrão
py -3.4 -m pip install AlgumPacote  # Python 3.4 especificamente
@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/guides/index-mirrors-and-caches/)

@node Problemas comuns de instalação,,Como eu …?,Instalando módulos Python
@anchor{installing/index common-installation-issues}@anchor{52f3}
@section Problemas comuns de instalação


@menu
* Instalando no sistema Python no Linux:: 
* Pip não instalado:: 
* Instalando extensões binárias:: 

@end menu

@node Instalando no sistema Python no Linux,Pip não instalado,,Problemas comuns de instalação
@anchor{installing/index installing-into-the-system-python-on-linux}@anchor{52f4}
@subsection Instalando no sistema Python no Linux


Em sistemas Linux, uma instalação Python normalmente será incluída como parte da distribuição. A instalação nesta instalação Python requer acesso root ao sistema, e pode interferir na operação do gerenciador de pacotes do sistema e outros componentes do sistema se um componente for atualizado inesperadamente usando @code{pip}.

Em tais sistemas, geralmente é melhor usar um ambiente virtual ou uma instalação por usuário ao instalar pacotes com @code{pip}.

@node Pip não instalado,Instalando extensões binárias,Instalando no sistema Python no Linux,Problemas comuns de instalação
@anchor{installing/index pip-not-installed}@anchor{52f5}
@subsection Pip não instalado


É possível que o @code{pip} não seja instalado por padrão. Uma solução potencial é:

@example
python -m ensurepip --default-pip
@end example

Existem também recursos adicionais para instalar pip.@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/#ensure-pip-setuptools-and-wheel-are-up-to-date}

@node Instalando extensões binárias,,Pip não instalado,Problemas comuns de instalação
@anchor{installing/index installing-binary-extensions}@anchor{52f6}
@subsection Instalando extensões binárias


O Python normalmente depende fortemente da distribuição baseada na fonte, com os usuários finais sendo esperados para compilar os módulos de extensão da fonte como parte do processo de instalação.

Com a introdução do suporte para o formato binário @code{wheel} e a capacidade de publicar wheels para pelo menos Windows e macOS através do Python Package Index, espera-se que este problema diminua com o tempo, à medida que os usuários são mais capazes para instalar extensões pré-construídas em vez de precisar construí-las eles próprios.

Algumas das soluções para instalar softwares científicos@footnote{https://packaging.python.org/science/} que ainda não estão disponíveis como arquivos @code{wheel} pré-construídos também podem ajudar a obter outras extensões binárias sem a necessidade para construí-los localmente.


@subsubheading Ver também


Guia de Usuário para Empacotamento de Python: Extensões binárias@footnote{https://packaging.python.org/pt-br/latest/guides/packaging-binary-extensions/}


@node Python HOWTOs,Perguntas Frequentes Sobre Python,Instalando módulos Python,Top
@anchor{howto/index doc}@anchor{52f7}@anchor{howto/index how-tos}@anchor{52f8}@anchor{howto/index python-howtos}@anchor{52f9}@anchor{howto/index translation-repo}@anchor{52fa}
@chapter Python HOWTOs


Python HOWTOs (COMOFAZER) são documentos que cobrem um tópico específico em profundidade. Modelada na coleção HOWTO do Linux Documentation Project, esta coleção é um esforço para promover uma documentação mais detalhada do que a Referência da Biblioteca do Python.

@menu
* Uma visão geral conceitual de asyncio:: 
* Portando módulos de extensão para o Python 3:: 
* Programação em Curses com Python:: 
* Guia de descritores:: 
* Depurando extensões de API C e internos do CPython com GDB:: 
* Enum:: 
* Programação Funcional:: 
* Logging:: 
* Livro de receitas do logging:: 
* Expressões Regulares:: 
* Programação de Soquetes:: 
* Técnicas de ordenação:: 
* Unicode: Unicode<3>. 
* Como buscar recursos da Internet usando o pacote urllib:: 
* Uma introdução ao módulo ipaddress:: 
* Instrumentando o CPython com DTrace e SystemTap:: 
* Suporte do Python ao perfilador perf do Linux:: 
* Boas práticas para anotações:: 
* Isolando módulos de extensão:: 
* Descritor de arquivo de temporizador:: 
* A Ordem de Resolução de Métodos do Python 2.3: A Ordem de Resolução de Métodos do Python 2 3. 
* Suporte experimental do Python para threads livres:: 
* Suporte a extensões da API C para threads livres:: 

@end menu

@node Uma visão geral conceitual de asyncio,Portando módulos de extensão para o Python 3,,Python HOWTOs
@anchor{howto/a-conceptual-overview-of-asyncio doc}@anchor{52fb}@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-of-asyncio}@anchor{3475}@anchor{howto/a-conceptual-overview-of-asyncio id1}@anchor{52fc}
@section Uma visão geral conceitual de @code{asyncio}


Este artigo @ref{52f8,,COMOFAZER} tem como objetivo ajudá-lo a construir um modelo mental sólido de como @ref{a,,asyncio} funciona fundamentalmente, ajudando-lhe a compreender o como e o porquê por trás dos padrões recomendados.

Você pode estar curioso sobre alguns conceitos-chave de @code{asyncio}. Ao final deste artigo, você será capaz de responder confortavelmente a estas perguntas:


@itemize -

@item 
O que acontece nos bastidores quando um objeto é aguardado?

@item 
Como o @code{asyncio} diferencia uma tarefa que não precisa de tempo de CPU (como uma solicitação de rede ou leitura de arquivo) de uma tarefa que precisa (como calcular n-fatorial)?

@item 
Como escrever uma variante assíncrona de uma operação, como uma suspensão assíncrona ou uma solicitação de banco de dados.
@end itemize


@subsubheading Ver também



@itemize *

@item 
O guia@footnote{https://github.com/anordin95/a-conceptual-overview-of-asyncio/tree/main} que inspirou este artigo COMOFAZER, por Alexander Nordin.

@item 
Esta série de tutoriais detalhados do YouTube@footnote{https://www.youtube.com/watch?v=Xbl7XjFYsN4&list=PLhNSoGM2ik6SIkVGXWBwerucXjgP1rHmB} sobre @code{asyncio} foi criada pelo membro da equipe principal do Python, Łukasz Langa.

@item 
500 linhas ou menos: um rastreador da Web com corrotinas asyncio@footnote{https://aosabook.org/en/500L/a-web-crawler-with-asyncio-coroutines.html} (em inglês) por A. Jesse Jiryu Davis e Guido van Rossum.
@end itemize


@menu
* Uma visão geral conceitual parte 1; o alto nível: Uma visão geral conceitual parte 1 o alto nível. 
* Uma visão geral conceitual@comma{} parte 2; os detalhes: Uma visão geral conceitual parte 2 os detalhes. 

@end menu

@node Uma visão geral conceitual parte 1 o alto nível,Uma visão geral conceitual parte 2 os detalhes,,Uma visão geral conceitual de asyncio
@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-part-1-the-high-level}@anchor{52fd}
@subsection Uma visão geral conceitual parte 1: o alto nível


Na parte 1, abordaremos os principais blocos de construção de alto nível de @code{asyncio}: o laço de eventos, funções de corrotina, objetos de corrotina, tarefas e @code{await}.

@menu
* Laço de eventos: Laço de eventos<2>. 
* Funções assíncronas e corrotinas:: 
* Tarefas: Tarefas<2>. 
* await:: 

@end menu

@node Laço de eventos<2>,Funções assíncronas e corrotinas,,Uma visão geral conceitual parte 1 o alto nível
@anchor{howto/a-conceptual-overview-of-asyncio event-loop}@anchor{52fe}
@subsubsection Laço de eventos


Tudo em @code{asyncio} acontece em relação ao laço de eventos. Ele é a estrela do show. É como um maestro de orquestra. Está nos bastidores, gerenciando recursos. Algum poder lhe é explicitamente concedido, mas grande parte de sua capacidade de realizar tarefas advém do respeito e da cooperação de seus operários.

Em termos mais técnicos, o laço de eventos contém uma coleção de tarefas a serem executadas. Algumas tarefas são adicionadas diretamente por você e outras indiretamente por @code{asyncio}. O laço de eventos pega uma tarefa do seu backlog de tarefas e a invoca (ou “dá a ela o controle”), semelhante a chamar uma função, e então essa tarefa é executada. Uma vez pausada ou concluída, ela retorna o controle para o laço de eventos. O laço de eventos então seleciona outra tarefa do seu pool e a invoca. Você pode `aproximadamente' pensar na coleção de tarefas como uma fila: as tarefas são adicionadas e processadas uma de cada vez, geralmente (mas nem sempre) em ordem. Esse processo se repete indefinidamente, com o laço de eventos em ciclos infinitos. Se não houver mais tarefas pendentes de execução, o laço de eventos é inteligente o suficiente para descansar e evitar o desperdício desnecessário de ciclos de CPU, e retornará quando houver mais trabalho a ser feito.

A execução eficaz depende do bom compartilhamento e da cooperação entre as tarefas; uma tarefa gananciosa pode monopolizar o controle e deixar as outras tarefas na miséria, tornando a abordagem geral do laço de eventos inútil.

@example
import asyncio

# Isso cria um laço de eventos e percorre indefinidamente
# sua coleção de trabalhos
event_loop = asyncio.new_event_loop()
event_loop.run_forever()
@end example

@node Funções assíncronas e corrotinas,Tarefas<2>,Laço de eventos<2>,Uma visão geral conceitual parte 1 o alto nível
@anchor{howto/a-conceptual-overview-of-asyncio asynchronous-functions-and-coroutines}@anchor{52ff}
@subsubsection Funções assíncronas e corrotinas


Esta é uma função básica e chata do Python:

@example
def hello_printer():
    print(
        "Olá, sou uma impressora humilde e simples, embora tenha tudo "
        "que preciso na vida: -- \npapel novo e meu querido e amado "
        "parceiro no crime, o polvo."
    )
@end example

Chamar uma função regular invoca sua lógica ou corpo:

@example
>>> hello_printer()
Olá, sou uma impressora humilde e simples, embora tenha tudo o que preciso na vida:
papel novo e meu querido e amado parceiro no crime, o polvo.
@end example

O @ref{5d1,,async def}, em oposição a um simples @code{def}, torna esta uma função assíncrona (ou “função de corrotina”). Chamá-la cria e retorna um objeto @ref{3476,,corrotina}.

@example
async def loudmouth_penguin(magic_number: int):
    print(
     "Eu sou um pinguim falante superespecial. Muito mais legal que aquela impressora. "
     f"Aliás, meu número da sorte é: @{magic_number@}."
    )
@end example

Chamar a função assíncrona, @code{loudmouth_penguin}, não executa a instrução de impressão; em vez disso, cria um objeto corrotina:

@example
>>> loudmouth_penguin(magic_number=3)
<coroutine object loudmouth_penguin at 0x104ed2740>
@end example

Os termos “função de corrotina” e “objeto corrotina” são frequentemente confundidos com corrotina. Isso pode ser confuso! Neste artigo, corrotina se refere especificamente a um objeto corrotina, ou mais precisamente, a uma instância de @ref{eb8,,types.CoroutineType} (corrotina nativa). Observe que corrotinas também podem existir como instâncias de @ref{e07,,collections.abc.Coroutine} — uma distinção importante para a verificação de tipos.

Uma corrotina representa o corpo ou a lógica da função. Uma corrotina precisa ser iniciada explicitamente; novamente, a mera criação da corrotina não a inicia. Notavelmente, a corrotina pode ser pausada e retomada em vários pontos do corpo da função. Essa capacidade de pausar e retomar é o que permite o comportamento assíncrono!

Corrotinas e funções de corrotina foram criadas aproveitando a funcionalidade de @ref{bf9,,geradores} e @ref{109a,,funções geradoras}. Lembre-se: uma função geradora é uma função que executa @ref{9d5,,yield}, como esta:

@example
def get_random_number():
    # Este seria um gerador de número aleatório ruim!
    print("Oi")
    yield 1
    print("Olá")
    yield 7
    print("E aí")
    yield 4
    ...
@end example

Semelhante a uma função de corrotina, chamar uma função geradora não a executa. Em vez disso, ela cria um objeto gerador:

@example
>>> get_random_number()
<generator object get_random_number at 0x1048671c0>
@end example

Você pode prosseguir para o próximo @code{yield} de um gerador usando a função embutida @ref{7d9,,next()}. Em outras palavras, o gerador é executado e, em seguida, pausado. Por exemplo:

@example
>>> generator = get_random_number()
>>> next(generator)
Oi
1
>>> next(generator)
Olá
7
@end example

@node Tarefas<2>,await,Funções assíncronas e corrotinas,Uma visão geral conceitual parte 1 o alto nível
@anchor{howto/a-conceptual-overview-of-asyncio tasks}@anchor{5300}
@subsubsection Tarefas


Em termos gerais, @ref{34a8,,tarefas} são corrotinas (não funções de corrotina) vinculadas a um laço de eventos. Uma tarefa também mantém uma lista de funções de retorno de chamada cuja importância ficará clara em breve, quando discutirmos @ref{1b9,,await}. A maneira recomendada de criar tarefas é via @ref{1bf,,asyncio.create_task()}.

A criação de uma tarefa a agenda automaticamente para execução (adicionando um retorno de chamada para executá-la na lista de tarefas do laço de eventos, ou seja, coleção de tarefas).

@code{asyncio} associa automaticamente as tarefas ao laço de eventos. Essa associação automática foi propositalmente incorporada ao @code{asyncio} para simplificar o processo. Sem ela, você teria que controlar o objeto laço de eventos e passá-lo para qualquer função de corrotina que queira criar tarefas, adicionando código redundante ao seu projeto.

@example
coroutine = loudmouth_penguin(magic_number=5)
# Isso cria um objeto Task e agenda sua execução por meio do laço de eventos.
task = asyncio.create_task(coroutine)
@end example

Anteriormente, criamos manualmente o laço de eventos e o configuramos para ser executado indefinidamente. Na prática, é recomendado (e comum) usar @ref{47c,,asyncio.run()}, que gerencia o laço de eventos e garante que a corrotina fornecida termine antes de avançar. Por exemplo, muitos programas assíncronos seguem esta configuração:

@example
import asyncio

async def main():
    # Faz todo tipo de coisas malucas, selvagens e assíncronas...
    ...

if __name__ == "__main__":
    asyncio.run(main())
    # O programa não alcançará a seguinte instrução de exibição
    # até que o main() da corrotina seja finalizado.
    print("main() da corrotina concluiu!")
@end example

É importante estar ciente de que a tarefa em si não é adicionada ao laço de eventos, apenas um retorno de chamada para a tarefa. Isso é importante se o objeto de tarefa que você criou for coletado como lixo antes de ser chamado pelo laço de eventos. Por exemplo, considere este programa:

@example
async def hello():
    print("hello!")

async def main():
    asyncio.create_task(hello())
    # Outras instruções assíncronas que são executadas por
    # um tempo e cedem o controle ao laço de eventos...
    ...

asyncio.run(main())
@end example

Como não há referência ao objeto tarefa criado na linha 5, ele `pode' ser coletado como lixo antes que o laço de eventos o invoque. Instruções posteriores na corrotina @code{main()} transferem o controle de volta para o laço de eventos para que ele possa invocar outras tarefas. Quando o laço de eventos eventualmente tenta executar a tarefa, pode falhar e descobrir que o objeto task não existe! Isso também pode acontecer mesmo que uma corrotina mantenha uma referência a uma tarefa, mas seja concluída antes que ela termine. Quando a corrotina termina, as variáveis locais saem do escopo e podem estar sujeitas à coleta de lixo. Na prática, @code{asyncio} e o coletor de lixo do Python trabalham arduamente para garantir que esse tipo de coisa não aconteça. Mas isso não é motivo para ser imprudente!

@node await,,Tarefas<2>,Uma visão geral conceitual parte 1 o alto nível
@anchor{howto/a-conceptual-overview-of-asyncio await}@anchor{5301}
@subsubsection await


@ref{1b9,,await} é uma palavra reservada do Python comumente usada de duas maneiras diferentes:

@example
await task
await coroutine
@end example

De maneira crucial, o comportamento de @code{await} depende do tipo de objeto que está sendo aguardado.

Aguardar uma tarefa cederá o controle da tarefa ou corrotina atual para o laço de eventos. No processo de cessão de controle, algumas coisas importantes acontecem. Usaremos o seguinte exemplo de código para ilustrar:

@example
async def plant_a_tree():
    dig_the_hole_task = asyncio.create_task(dig_the_hole())
    await dig_the_hole_task

    # Outras instruções associadas com plantar uma árvore.
    ...
@end example

Neste exemplo, imagine que o laço de eventos passou o controle para o início da corrotina @code{plant_a_tree()}. Como visto acima, a corrotina cria uma tarefa e a aguarda. A instrução @code{await dig_the_hole_task} adiciona um retorno de chamada (que retomará @code{plant_a_tree()}) à lista de retornos de chamada do objeto @code{dig_the_hole_task}. E então, a instrução cede o controle para o laço de eventos. Algum tempo depois, o laço de eventos passará o controle para @code{dig_the_hole_task} e a tarefa concluirá o que for necessário. Assim que a tarefa for concluída, ela adicionará seus vários retornos de chamada ao laço de eventos, neste caso, uma chamada para retomar @code{plant_a_tree()}.

De modo geral, quando a tarefa aguardada termina (@code{dig_the_hole_task}), a tarefa original ou corrotina (@code{plant_a_tree()}) é adicionada novamente à lista de tarefas do laço de eventos para ser retomada.

Este é um modelo mental básico, porém confiável. Na prática, as transferências de controle são um pouco mais complexas, mas não muito. Na parte 2, abordaremos os detalhes que tornam isso possível.

`Ao contrário de tarefas, aguardar uma corrotina não devolve o controle ao laço de eventos!' Envolver uma corrotina em uma tarefa primeiro e depois aguardar isso cederia o controle. O comportamento de @code{await coroutine} é efetivamente o mesmo que invocar uma função Python síncrona comum. Considere este programa:

@example
import asyncio

async def coro_a():
   print("Sou coro_a(). Oi!")

async def coro_b():
   print("Sou coro_b(). Espero que ninguém monopolize o laço de eventos...")

async def main():
   task_b = asyncio.create_task(coro_b())
   num_repeats = 3
   for _ in range(num_repeats):
      await coro_a()
   await task_b

asyncio.run(main())
@end example

A primeira instrução na corrotina @code{main()} cria @code{task_b} e a agenda para execução via laço de eventos. Em seguida, @code{coro_a()} é aguardado repetidamente. O controle nunca cede ao laço de eventos, e é por isso que vemos a saída de todas as três invocações de @code{coro_a()} antes da saída de @code{coro_b()}:

@example
Sou coro_a(). Oi!
Sou coro_a(). Oi!
Sou coro_a(). Oi!
Sou coro_b(). Espero que ninguém monopolize o laço de eventos...
@end example

Se alterarmos @code{await coro_a()} para @code{await asyncio.create_task(coro_a())}, o comportamento muda. A corrotina @code{main()} cede o controle ao laço de eventos com essa instrução. O laço de eventos então prossegue com seu backlog de trabalho, chamando @code{task_b} e, em seguida, a tarefa que encerra @code{coro_a()} antes de retomar a corrotina @code{main()}.

@example
Sou coro_b(). Espero que ninguém monopolize o laço de eventos...
Sou coro_a(). Oi!
Sou coro_a(). Oi!
Sou coro_a(). Oi!
@end example

Esse comportamento de @code{await coroutine} pode confundir muita gente! Este exemplo destaca como usar apenas @code{await coroutine} pode, involuntariamente, monopolizar o controle de outras tarefas e efetivamente paralisar o laço de eventos. @ref{47c,,asyncio.run()} pode ajudar a detectar tais ocorrências por meio do sinalizador @code{debug=True}, que habilita o @ref{1ed3,,modo de depuração}. Entre outras coisas, ele registrará quaisquer corrotinas que monopolizem a execução por 100 ms ou mais.

O design intencionalmente troca alguma clareza conceitual em torno do uso de @code{await} por melhor desempenho. Cada vez que uma tarefa é aguardada, o controle precisa ser passado por toda a pilha de chamadas até o laço de eventos. Isso pode parecer insignificante, mas em um programa grande com muitas instruções @code{await} e uma pilha de chamadas extensa, essa sobrecarga pode representar um significativo prejuízo ao desempenho.

@node Uma visão geral conceitual parte 2 os detalhes,,Uma visão geral conceitual parte 1 o alto nível,Uma visão geral conceitual de asyncio
@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-part-2-the-nuts-and-bolts}@anchor{5302}
@subsection Uma visão geral conceitual, parte 2: os detalhes


A parte 2 detalha os mecanismos que @code{asyncio} usa para gerenciar o fluxo de controle. É aqui que a mágica acontece. Você sairá desta seção sabendo o que @code{await} faz nos bastidores e como criar seus próprios operadores assíncronos.

@menu
* O funcionamento interno das corrotinas:: 
* Futuros: Futuros<2>. 
* Um asyncio.sleep caseiro: Um asyncio sleep caseiro. 

@end menu

@node O funcionamento interno das corrotinas,Futuros<2>,,Uma visão geral conceitual parte 2 os detalhes
@anchor{howto/a-conceptual-overview-of-asyncio the-inner-workings-of-coroutines}@anchor{5303}
@subsubsection O funcionamento interno das corrotinas


@code{asyncio} utiliza quatro componentes para passar o controle.

@ref{215a,,coroutine.send(arg)} é o método usado para iniciar ou retomar uma corrotina. Se a corrotina foi pausada e agora está sendo retomada, o argumento @code{arg} será enviado como valor de retorno da instrução @code{yield} que a pausou originalmente. Se a corrotina estiver sendo usada pela primeira vez (em vez de ser retomada), @code{arg} deve ser @code{None}.

@example
class Rock:
    def __await__(self):
        value_sent_in = yield 7
        print(f"Rock.__await__ resumindo com o valor: @{value_sent_in@}.")
        return value_sent_in

async def main():
    print("Iniciando main() da corrotina.")
    rock = Rock()
    print("Aguardando rock...")
    value_from_rock = await rock
    print(f"Corrotina recebeu valor: @{value_from_rock@} de rock.")
    return 23

coroutine = main()
intermediate_result = coroutine.send(None)
print(f"Corrotina pausou e retornou o valor intermediário: @{intermediate_result@}.")

print(f"Resumindo corrotina e enviando o valor: 42.")
try:
    coroutine.send(42)
except StopIteration as e:
    returned_value = e.value
print(f"O main() da corrotina finalizou e forneceu o valor: @{returned_value@}.")
@end example

@ref{21cc,,yield}, como de costume, pausa a execução e retorna o controle ao chamador. No exemplo acima, @code{yield}, na linha 3, é chamado por @code{... = await rock} na linha 11. Em termos mais gerais, @code{await} chama o método @ref{d9d,,__await__()} do objeto fornecido. @code{await} também faz algo muito especial: ele propaga (ou “repassa”) quaisquer @code{yield}s que recebe na cadeia de chamadas. Neste caso, voltamos a @code{... = coroutine.send(None)} na linha 16.

A corrotina é retomada por meio da chamada @code{coroutine.send(42)} na linha 21. A corrotina continua de onde foi executada (ou pausada) com @code{yield} na linha 3 e executa as instruções restantes em seu corpo. Quando uma corrotina termina, ela levanta uma exceção @ref{c15,,StopIteration} com o valor de retorno anexado ao atributo @ref{2157,,value}.

Esse trecho de código produz esta saída:

@example
Iniciando main() da corrotina.
Aguardando rock...
Corrotina pausou e retornou o valor intermediário: 7.
Resumindo coroutine e enviando o valor: 42.
Rock.__await__ resumindo com o valor: 42.
Corrotina recebeu valor: 42 de rock.
O main() da corrotina finalizou e forneceu o valor: 23.
@end example

Vale a pena parar um momento aqui e certificar-se de que você seguiu as diversas maneiras pelas quais o fluxo de controle e os valores foram passados. Muitas ideias importantes foram abordadas e vale a pena garantir que seu entendimento esteja firme.

A única maneira de ceder (ou efetivamente ceder o controle) de uma corrotina é @code{await} um objeto que @code{yield} está em seu método @code{__await__}. Isso pode parecer estranho para você. Você pode estar pensando:

@quotation

1. What about a @code{yield} directly within the coroutine function? The
coroutine function becomes an
@ref{21d0,,async generator function}, a
different beast entirely.

2. What about a @ref{21cc,,yield from} within the coroutine function to a (plain)
generator?
That causes the error: @code{SyntaxError: yield from not allowed in a coroutine.}
This was intentionally designed for the sake of simplicity – mandating only
one way of using coroutines.
Initially @code{yield} was barred as well, but was re-accepted to allow for
async generators.
Despite that, @code{yield from} and @code{await} effectively do the same thing.
@end quotation

@node Futuros<2>,Um asyncio sleep caseiro,O funcionamento interno das corrotinas,Uma visão geral conceitual parte 2 os detalhes
@anchor{howto/a-conceptual-overview-of-asyncio futures}@anchor{5304}
@subsubsection Futuros


Um @ref{357c,,future} é um objeto que representa o status e o resultado de uma computação. O termo é uma referência à ideia de algo que ainda está por vir ou que ainda não aconteceu, e o objeto é uma forma de ficar de olho nesse algo.

Um future possui alguns atributos importantes. Um deles é o seu estado, que pode ser “pending”, “cancelled”, or “done” (“pendente”, “cancelado” ou “concluído”, respectivamente). Outro é o seu resultado, que é definido quando o estado transita para concluído. Ao contrário de uma corrotina, um future não representa a computação real a ser realizada; em vez disso, representa o status e o resultado dessa computação, como uma espécie de luz de status (vermelha, amarela ou verde) ou indicador.

@ref{1be,,asyncio.Task} estende @ref{be6,,asyncio.Future} para obter esses vários recursos. A seção anterior dizia que as tarefas armazenam uma lista de retornos de chamada, o que não era totalmente preciso. Na verdade, é a classe @code{Future} que implementa essa lógica, que @code{Task} herda.

Instruções future também podem ser usados diretamente (não por meio de tarefas). As tarefas se marcam como concluídas quando sua corrotina é concluída. Instruções future são muito mais versáteis e serão marcados como concluídos quando você informar. Dessa forma, eles são a interface flexível para você definir suas próprias condições de espera e retomada.

@node Um asyncio sleep caseiro,,Futuros<2>,Uma visão geral conceitual parte 2 os detalhes
@anchor{howto/a-conceptual-overview-of-asyncio a-homemade-asyncio-sleep}@anchor{5305}
@subsubsection Um asyncio.sleep caseiro


Veremos um exemplo de como você pode aproveitar um future para criar sua própria variante de suspensão assíncrona (@code{async_sleep}) que imita @ref{a79,,asyncio.sleep()}.

Este trecho de código registra algumas tarefas no laço de eventos e, em seguida, aguarda a tarefa criada por @code{asyncio.create_task}, que envolve a corrotina @code{async_sleep(3)}. Queremos que essa tarefa termine somente após três segundos, mas sem impedir a execução de outras tarefas.

@example
async def other_work():
    print("Eu gosto de trabalhar. Trabalhar, trabalhar.")

async def main():
    # Adiciona algumas tarefas ao laço de eventos, de forma que
    # haja algo para fazer durante a suspensão assíncrona.
    work_tasks = [
        asyncio.create_task(other_work()),
        asyncio.create_task(other_work()),
        asyncio.create_task(other_work())
    ]
    print(
        "Começando a suspensão assíncrona no horário: "
        f"@{datetime.datetime.now().strftime("%H:%M:%S")@}."
    )
    await asyncio.create_task(async_sleep(3))
    print(
        "Concluí a suspensão assíncrona no horário: "
        f"@{datetime.datetime.now().strftime("%H:%M:%S")@}."
    )
    # asyncio.gather efetivamente espera cada tarefa na coleção.
    await asyncio.gather(*work_tasks)
@end example

A seguir, usamos um future para permitir o controle personalizado sobre quando essa tarefa será marcada como concluída. Se @ref{34ab,,future.set_result()} (o método responsável por marcar o future como concluído) nunca for chamado, essa tarefa nunca terminará. Também contamos com a ajuda de outra tarefa, que veremos em breve, que monitorará o tempo decorrido e, consequentemente, chamará @code{future.set_result()}.

@example
async def async_sleep(seconds: float):
    future = asyncio.Future()
    time_to_wake = time.time() + seconds
    # Adiciona uma tarefa de monitoramento ao laço de eventos.
    watcher_task = asyncio.create_task(_sleep_watcher(future, time_to_wake))
    # Bloqueia até future ser marcado como concluído.
    await future
@end example

A seguir, usamos um objeto @code{YieldToEventLoop()} bastante simples para @code{yield} do seu método @code{__await__}, cedendo o controle ao laço de eventos. Isso é efetivamente o mesmo que chamar @code{asyncio.sleep(0)}, mas essa abordagem oferece mais clareza, sem mencionar que é um tanto quanto trapaça usar @code{asyncio.sleep} ao demonstrar como implementá-lo!

Como de costume, o laço de eventos percorre suas tarefas, concedendo-lhes o controle e recebendo-o de volta quando elas pausam ou terminam. A tarefa @code{watcher_task}, que executa a corrotina @code{_sleep_watcher(...)}, será invocada uma vez por ciclo completo do laço de eventos. A cada retomada, ela verificará o tempo e, se não tiver decorrido tempo suficiente, pausará novamente e devolverá o controle ao laço de eventos. Assim que o tempo suficiente tiver decorrido, @code{_sleep_watcher(...)} marcará o futuro como concluído e finalizará, saindo de seu laço @code{while} infinito. Dado que essa tarefa auxiliar é invocada apenas uma vez por ciclo do laço de eventos, você está correto ao observar que essa suspensão assíncrona durará `pelo menos' três segundos, em vez de exatamente três segundos. Observe que isso também se aplica a @code{asyncio.sleep}.

@example
class YieldToEventLoop:
    def __await__(self):
        yield

async def _sleep_watcher(future, time_to_wake):
    while True:
        if time.time() >= time_to_wake:
            # Isso marca future como concluído.
            future.set_result(None)
            break
        else:
            await YieldToEventLoop()
@end example

Aqui está a saída completa do programa:

@example
$ python custom-async-sleep.py
Começando a suspensão assíncrona no horário: 14:52:22.
Eu gosto de trabalhar. Trabalhar, trabalhar.
Eu gosto de trabalhar. Trabalhar, trabalhar.
Eu gosto de trabalhar. Trabalhar, trabalhar.
Concluí a suspensão assíncrona no horário: 14:52:25.
@end example

Você pode achar que esta implementação de suspensão assíncrona foi desnecessariamente complexa. E, bem, foi mesmo. O exemplo tinha como objetivo demonstrar a versatilidade dos futures com um exemplo simples que poderia ser replicado para necessidades mais complexas. Para referência, você poderia implementá-lo sem futures, assim:

@example
async def simpler_async_sleep(seconds):
    time_to_wake = time.time() + seconds
    while True:
        if time.time() >= time_to_wake:
            return
        else:
            await YieldToEventLoop()
@end example

Mas por agora é tudo. Espero que agora esteja pronto para mergulhar com mais confiança na programação assíncrona ou consultar tópicos avançados no @ref{a,,restante da documentação}.

@node Portando módulos de extensão para o Python 3,Programação em Curses com Python,Uma visão geral conceitual de asyncio,Python HOWTOs
@anchor{howto/cporting doc}@anchor{5306}@anchor{howto/cporting cporting-howto}@anchor{1324}@anchor{howto/cporting porting-extension-modules-to-python-3}@anchor{5307}@anchor{howto/cporting translation-repo}@anchor{5308}
@section Portando módulos de extensão para o Python 3


Recomendamos os seguintes recursos para portar módulos de extensão para o Python 3:


@itemize *

@item 
O capítulo Migrating C extensions@footnote{http://python3porting.com/cextensions.html} de `Supporting Python 3: An in-depth guide', um livro sobre a migração do Python 2 para o Python 3 em geral, orienta o leitor na portabilidade de um módulo de extensão.

@item 
O Porting guide@footnote{https://py3c.readthedocs.io/en/latest/guide.html} do projeto `py3c' fornece sugestões opinativas com código de suporte.

@item 
@ref{4b37,,Ferramentas recomendadas de terceiros} oferecem abstrações sobre a API C do Python. As extensões geralmente precisam ser reescritas para usar uma delas, mas a biblioteca lida com diferenças entre várias versões e implementações do Python.
@end itemize

@node Programação em Curses com Python,Guia de descritores,Portando módulos de extensão para o Python 3,Python HOWTOs
@anchor{howto/curses doc}@anchor{5309}@anchor{howto/curses curses-howto}@anchor{313d}@anchor{howto/curses curses-programming-with-python}@anchor{530a}@anchor{howto/curses translation-repo}@anchor{530b}
@section Programação em Curses com Python


@*Autor: 
A.M. Kuchling, Eric S. Raymond


@*Versão: 
2.04


@subsubheading Resumo



Este documento descreve como usar o módulo de extensão @ref{2b,,curses} para controlar visualizações em modo texto.

@menu
* O que é curses?:: 
* Começando e terminando uma aplicação curses:: 
* Janelas e Pads:: 
* Exibindo texto:: 
* Entrada de usuário:: 
* Para mais informações:: 

@end menu

@node O que é curses?,Começando e terminando uma aplicação curses,,Programação em Curses com Python
@anchor{howto/curses what-is-curses}@anchor{530c}
@subsection O que é curses?


A biblioteca curses fornece formas que facilitam a impressão no terminal e o tratamento de entrada via teclado para interfaces de terminal baseadas em texto, tais como VT100s, o console Linux, e emuladores de terminais fornecidos por vários programas. Terminais visuais suportam vários códigos de controle para executar várias operações comuns como mover o cursor, apagar áreas e rolagem de tela. Diferentes terminais usam uma gama de diferentes códigos, e frequentemente têm suas próprias peculiaridades.

No mundo dos displays gráficos, uma pergunta pode vir à tona “por que isso, jovem?”. É verdade que os terminais de exibição de caracteres são uma tecnologia obsoleta, mas há nichos nos quais a capacidade de fazer coisas sofisticadas com eles continua sendo valorizada. Um nicho são os Unixes de baixa pegada de recursos ou embarcados, que não rodam um servidor X, ou seja, não possuem interface gráfica. Outro nicho é o de ferramentas como instaladores de sistemas operacionais e configurações de kernels que podem precisar rodar antes que qualquer suporte a interfaces gráficas esteja disponível.

A biblioteca curses fornece funcionalidades bastante básicas, proporcionando ao programador uma abstração de um monitor contendo janelas de texto não sobrepostas. Os conteúdos de uma janela podem ser modificados de diversas formas—adicionando texto, apagando-o, modificando sua aparência—e a biblioteca curses irá descobrir quais códigos de controle precisam ser enviados ao terminal para produzir a saída correta. A biblioteca curses não fornece muitos conceitos de interface de usuário como botões, caixas de seleção ou diálogos; se você precisar desses recursos, considere uma biblioteca de interface de usuário como Urwid@footnote{https://pypi.org/project/Urwid/}.

A biblioteca curses foi originalmente escrita para o BSD Unix; as versões mais recentes do System V do Unix da AT&T adicionaram muitos aprimoramentos e novas funções. A BSD curses não é mais mantida, tendo sido substituída pela ncursess, que é uma implementação de código aberto da interface da AT&T. Se você estiver usando um sistema operacional de código aberto baseado em Unix, tal como Linux ou FreeBSD, seu sistema provavelmente usa ncurses. Uma vez que a maioria das versões comerciais do Unix são baseadas no código do System V, todas as funções descritas aqui provavelmente estarão disponíveis. No entanto, as versões antigas de curses carregadas por alguns Unixes proprietários podem não prover tudo.

A versão do Python para Windows não inclui o módulo @ref{2b,,curses}. Uma versão portada chamada UniCurses@footnote{https://pypi.org/project/UniCurses/} está disponível.

@menu
* O módulo curses de Python:: 

@end menu

@node O módulo curses de Python,,,O que é curses?
@anchor{howto/curses the-python-curses-module}@anchor{530d}
@subsubsection O módulo curses de Python


O módulo Python é um invólucro razoavelmente simples sobre as funções C disponibilizadas pela curses; Se você já estiver familiarizado com programação curses em C, é bem fácil transmitir esse conhecimento para o Python. A maior diferença é que a interface Python simplifica as coisas ao juntar diferentes funções C como @code{addstr()}, @code{mvaddstr()} e @code{mvwaddstr()} em um único método @ref{3153,,addstr()}. Veremos isso mais adiante.

Este documento é uma introdução à escrita de programas em modo texto com curses e Python. Isto não pretende ser um guia completo da API curses; para isso, veja a seção ncurses no guia da biblioteca Python, e o manual de ncurses. Isto, no entanto, lhe dará uma ideia básica.

@node Começando e terminando uma aplicação curses,Janelas e Pads,O que é curses?,Programação em Curses com Python
@anchor{howto/curses starting-and-ending-a-curses-application}@anchor{530e}
@subsection Começando e terminando uma aplicação curses


Antes de qualquer coisas, a curses precisa ser inicializada. Para isso, chame a função @ref{1689,,initscr()}, que vai determinar o tipo do terminal, enviar para ele quaisquer códigos de inicialização necessários, e criar várias estruturas de dados internas. Se bem-sucedida, a @code{initscr()} retorna um objeto de janela representando a tela inteira; ele é comumente chamado @code{stdscr} por causa da variável C correspondente.

@example
import curses
stdscr = curses.initscr()
@end example

Geralmente aplicações curses desativam o envio automático de teclas para a tela, para que seja possível ler teclas e exibi-las somente sob certas circunstâncias. Isto requer a chamada da função @ref{317c,,noecho()}.

@example
curses.noecho()
@end example

Aplicações também irão comumente precisar reagir a teclas instantaneamente, sem requisitar que a tecla Enter seja pressionada; isto é chamado de modo cbreak, ao contrário do modo de entrada buferizada usual.

@example
curses.cbreak()
@end example

Terminais geralmente retornam teclas especiais, como as teclas de cursor ou de navegação como Page Up e Home, como uma sequência de escape mutibyte. Enquanto você poderia escrever sua aplicação para esperar essas sequências e processá-las de acordo, curses pode fazer isto para você, retornando um valor especial como @ref{31f5,,curses.KEY_LEFT}. Para permitir que curses faça esse trabalho, você precisará habilitar o modo keypad.

@example
stdscr.keypad(True)
@end example

Finalizar uma aplicação curses é mais fácil do que iniciar uma. Você precisará executar:

@example
curses.nocbreak()
stdscr.keypad(False)
curses.echo()
@end example

para reverter as configurações de terminal usadas pela biblioteca curses. Então, chame a função @ref{3156,,endwin()} para restaurar o terminal para seu modo de operação original.

@example
curses.endwin()
@end example

Um problema comum ao depurar uma aplicação curses é deixar seu terminal bagunçado quando a aplicação para sem restaurar o terminal ao seu estado anterior. Em Python isto comumente acontece quando seu código está com problemas e levanta uma exceção não capturada. As teclas não são mais enviadas para a tela quando você as digita, por exemplo, o que torna difícil utilizar o shell.

No Python você pode evitar essas complicações e fazer depurações de forma mais simples importando a função @ref{a8a,,curses.wrapper()} e utilizando-a desta forma:

@example
from curses import wrapper

def main(stdscr):
    # Limpa a tela
    stdscr.clear()

    # Levanta ZeroDivisionError quando i == 10.
    for i in range(0, 11):
        v = i-10
        stdscr.addstr(i, 0, '10 dividido por @{@} é @{@}'.format(v, 10/v))

        stdscr.refresh()
        stdscr.getkey()

wrapper(main)
@end example

A função @ref{a8a,,wrapper()} leva um objeto chamável e faz as inicializações descritas acima, inicializando também as cores se o terminal as prover. A @code{wrapper()} então roda o chamável. Quando ele retornar, a @code{wrapper()} vai restaurar o estado original do terminal. O chamável é chamado dentro de um bloco @ref{6e9,,try}…@ref{18b,,except} que captura exceções, restaura o estado do terminal, e então as levanta novamente. Dessa forma, o seu terminal não vai ser deixado em nenhum estado engraçadinho caso haja qualquer erro, e você poderá ler a mensagem e o traceback da exceção.

@node Janelas e Pads,Exibindo texto,Começando e terminando uma aplicação curses,Programação em Curses com Python
@anchor{howto/curses windows-and-pads}@anchor{530f}
@subsection Janelas e Pads


Janelas são a abstração mais básica em curses. Uma objeto janela representa uma área retangular da tela, e provê métodos para exibir texto, apagá-lo, e permitir ao usuário inserir strings, e assim por diante.

O objeto @code{stdscr} retornado pela função @ref{1689,,initscr()} é um objeto janela que cobre a tela inteira. Muitos programas podem precisar apenas desta janela única, mas você poderia desejar dividir a tela em janelas menores, a fim de redefini-las ou limpá-las separadamente. A função @ref{317a,,newwin()} cria uma nova janela de um dado tamanho, retornando o novo objeto janela.

@example
begin_x = 20; begin_y = 7
height = 5; width = 40
win = curses.newwin(height, width, begin_y, begin_x)
@end example

Note que o sistema de coordenadas utilizado na curses é incomum. Coordenadas geralmente são passadas na ordem `y,x', e o canto superior-esquerdo da janela é a coordenada (0,0). Isto quebra a convenção normal para tratar coordenadas onde a coordenada `x' vem primeiro. Isto é uma diferença infeliz da maioria das aplicações computacionais, mas tem sido parte da curses desde que ela foi inicialmente escrita, e agora é tarde demais para mudar isso.

Sua aplicação pode determinar o tamanho da tela usando as variáveis @ref{e17,,curses.LINES} e @ref{e18,,curses.COLS} para obter os tamanhos `y' e `x'. Coordenadas válidas vão variar de @code{(0,0)} até @code{(curses.LINES - 1, curses.COLS - 1)}.

Quando você chamar um método para exibir ou apagar texto, o efeito não é exibido imediatamente na tela. Em vez disso você deve chamar o método @ref{3154,,refresh()} dos objetos janela para atualizar a tela.

Isso é porque a curses foi desenvolvida originalmente no contexto de conexões lentas de até 300 Bauds com o terminal; para esses terminais, minimizar o tempo necessário para redesenhar a tela era importantíssimo. No lugar disso, a curses acumula mudanças na tela, e as exibe da forma mais eficiente possível quando você chama @code{refresh()}. Por exemplo, se o seu programa mostra um texto em uma janela e então limpa a janela, não tem porque enviar o texto original já que ele nunca seria visível.

Na prática, ficar pedindo ao curses explicitamente para redesenhar a tela não torna a programação com ele tão complicada assim. A maioria dos programas faz uma enxurrada de atividades, e então pausa esperando uma tecla digitada ou alguma outra ação por parte do usuário. Tudo que você deve fazer é garantir que a tela foi redesenhada antes de pausar esperando pela entrada do usuário, chamando antes a @code{stdscr.refresh()} ou o método @code{refresh()} de alguma outra janela apropriada.

Um pad é um caso especial de janela; ele pode ser mais largo que a tela atual, e apenas uma porção do pad exibido por vez. Criar um pad requer sua altura e largura, enquanto atualizar o pad requer dar as coordenadas da área na tela onde uma subseção do pad será exibida.

@example
pad = curses.newpad(100, 100)
# Estes laços preenchem o pad com letras; a addch()
# é explicada na seção a seguir.
for y in range(0, 99):
    for x in range(0, 99):
        pad.addch(y,x, ord('a') + (x*x+y*y) % 26)

# Exibe um pedaço de um pad no meio da tela.
# (0,0) : coordenada do canto superior esquerdo da área do pad a ser
#         exibida.
# (5,5) : coordenada do canto superior esquerdo da área da janela a ser
#         preenchida com o conteúdo do pad.
# (20, 75) : coordenada inferior direita da área da janela a ser
#          : preenchida com o conteúdo do pad.
pad.refresh( 0,0, 5,5, 20,75)
@end example

A chamada da @code{refresh()} exibe um pedaço do pad no retângulo que vai da coordenada (5,5) à coordenada (20,75) da tela; o canto superior esquerdo do pedaço exibido corresponde à coordenada (0,0) do pad. Fora essa diferença, pads são exatamente como janelas comuns, e provêm os mesmos métodos.

Se você tem múltiplas janelas e pads na tela, existe um modo mais eficiente de atualizar a tela que evita as cintilações irritantes que ocorrem à medida que cada parte da tela vai sendo atualizada. O @code{refresh()} na verdade faz duas coisas:


@enumerate 

@item 
Chama o método @ref{3152,,noutrefresh()} de cada janela para atualizar uma estrutura de dados subjacente representando o estado desejado da tela.

@item 
Chama a função @ref{3151,,doupdate()} para modificar a tela física para corresponder com o estado desejado presente na estrutura de dados.
@end enumerate

Em vez disso você pode chamar @code{noutrefresh()} em várias janelas para atualizar a estrutura de dados, e então chamar @code{doupdate()} para atualizar a tela.

@node Exibindo texto,Entrada de usuário,Janelas e Pads,Programação em Curses com Python
@anchor{howto/curses displaying-text}@anchor{5310}
@subsection Exibindo texto


Do ponto de vista de um programador C, a curses à vezes pode parecer como um labirinto sinuoso de funções, todas ligeiramente diferentes. Por exemplo, @code{addstr()} exibe uma string na posição atual do cursor na janela @code{stdscr}, enquanto @code{mvaddstr()} primeiro move o cursor para uma dada coordenada y,x antes de exibir a string. A @code{waddstr()} é como a @code{addstr()}, mas permite especificar uma janela para utilizar em vez de usar a @code{stdscr} por padrão. A @code{mvwaddstr()} permite especificar tanto uma janela quanto uma coordenada.

Felizmente, a interface do Python oculta todos estes detalhes. @code{stdscr} é um objeto de janela como qualquer outro, e métodos como @ref{3153,,addstr()} aceitam múltiplas formas de argumentos.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Forma

@tab

Descrição

@item

`str' ou `ch'

@tab

Mostra a string `str' ou caractere `ch' na posição atual.

@item

`str' ou `ch', `attr'

@tab

Mostra a string `str' ou caractere `ch', usando o atributo `attr' na posição atual.

@item

`y', `x', `str' ou `ch'

@tab

Move para a posição `y,x' dentro da janela, e exibe `str' ou `ch'

@item

`y', `x', `str' ou `ch', `attr'

@tab

Mover para a posição `y,x' dentro da janela, e exibir `str' ou `ch', usando o atributo `attr'

@end multitable


Atributos permitem exibir texto de formas destacadas como negrito, sublinhado, código invertido, ou colorido. Elas serão explicadas em mais detalhes na próxima subseção.

O método @ref{3153,,addstr()} recebe uma string ou bytestring Python como valor a ser exibido. os conteúdos de bytestrings são enviados ao terminal tais como estão. Strings são codificadas em bytes usando o valor do atributo @ref{10d5,,encoding} da janela; o valor padrão usado é a codificação padrão do sistema como retornado por @ref{2dc,,locale.getencoding()}.

Os métodos @ref{3195,,addch()} pegam um caractere, que pode ser tanto uma string de comprimento 1, um bytestring de comprimento 1, ou um inteiro.

Constantes são providas para caracteres de extensão; estas constantes são inteiros maiores que 255. Por exemplo, @ref{3262,,ACS_PLMINUS} é um símbolo de +/-, e @ref{319f,,ACS_ULCORNER} é o canto superior esquerdo de uma caixa (útil para desenhar bordas). Você pode usar o caractere Unicode apropriado.

Janelas lembram onde o cursor estava após a última operação, então se você omitir as coordenadas `y,x', a string ou caractere serão exibidos onde quer que a última operação foi deixada. Você também pode mover o cursos com o método @code{move(y,x)}. Porque alguns terminais sempre exibem um cursos piscando, você pode querer garantir que o cursor está posicionado em algum local onde ele não será uma distração; pode ser confuso ter o cursor piscando em um local aparentemente aleatório.

Se sua aplicação não necessita de forma alguma de um cursor piscando, você pode chamar @code{curs_set(False)} para torná-lo invisível. Para compatibilidade com versões anteriores de curses, há a função @code{leaveok(bool)} que é um sinônimo para @ref{314b,,curs_set()}. Quando `bool' é verdadeiro, a biblioteca curses tentará suprimir o cursor piscando, e você não precisará se preocupar ao deixá-lo em localizações incomuns.

@menu
* Atributos e Cor:: 

@end menu

@node Atributos e Cor,,,Exibindo texto
@anchor{howto/curses attributes-and-color}@anchor{5311}
@subsubsection Atributos e Cor


Caracteres podem ser exibidos de diferentes formas. Linhas de status em aplicações baseadas em texto são tradicionalmente exibidas em vídeo reverso, ou um visualizador de texto pode precisar destacar certas palavras. Para isso, a curses permite que você especifique um atributo para cada célula na tela.

Um atributo é um inteiro em que cada bit representa um atributo diferente. Você sempre pode tentar exibir texto com múltiplos bits de atributo ligados ao mesmo tempo, mas a curses não garante que todas as combinações possíveis estarão disponíveis, ou que elas são todas visualmente distintas. Isso depende da habilidade do terminal sendo usado, de forma que é mais seguro se ater aos atributos mais comumente disponíveis, listados aqui.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Atributo

@tab

Descrição

@item

@ref{31e1,,A_BLINK}

@tab

Texto piscante

@item

@ref{31e2,,A_BOLD}

@tab

Texto em negrito ou brilho extra

@item

@ref{31e3,,A_DIM}

@tab

Texto em brilho médio

@item

@ref{3149,,A_REVERSE}

@tab

Texto em vídeo reverso

@item

@ref{3148,,A_STANDOUT}

@tab

O modo mais destacado disponível

@item

@ref{31e7,,A_UNDERLINE}

@tab

Texto sublinhado

@end multitable


Assim, pra exibir uma linha de status em vídeo reverso na linha no topo da tela, você poderia escrever:

@example
stdscr.addstr(0, 0, "Modo atual: Modo de digitação",
              curses.A_REVERSE)
stdscr.refresh()
@end example

A biblioteca curses também permite o uso de cores nos terminais que as provêm. Destes, o terminal mais comum é provavelmente o console Linux, seguido pelos xterms com cores.

Para usar cores, você deve chamar a função @ref{3186,,start_color()} logo depois de chamar @ref{1689,,initscr()}, para inicializar a paleta de cores padrão (a função @ref{a8a,,curses.wrapper()} faz isso automaticamente.) Uma vez feito isso, a função @ref{3169,,has_colors()} retorna True se o terminal em uso de fato suportar cores. (Nota: a curses usa a grafia Americana ‘color’ ao invés da grafia Britânica/Canadense ‘colour.’ Se você estiver acostumado com a grafia Britânica, você terá que se resignar a escrever com a grafia trocada ao chamar essas funções.)

A biblioteca curses mantém uma quantidade finita de pares de cores, contendo uma cor de primeiro plano (ou de texto) e uma de fundo. Você pode obter o valor do atributo correspondente a um par de cores com a função @ref{3147,,color_pair()}; esse valor pode ser combinado com OU (OR) bit a bit com outros atributos como @ref{3149,,A_REVERSE}, mas, novamente, não é garantido que tais combinações vão funcionar em todos os terminais.

Um exemplo, exibindo uma linha de texto com o par de cores 1:

@example
stdscr.addstr("Texto colorido", curses.color_pair(1))
stdscr.refresh()
@end example

Como dito anteriormente, um par de cores consiste de uma cor de primeiro plano e uma cor de fundo. A função @code{init_pair(n, f, b)} muda a definição do par de cores `n' para a cor de primeiro plano `f' e cor de fundo `b'. O par 0 é pré-definido como branco sobre preto, e não pode ser mudado.

As cores são numeradas, e a @ref{3186,,start_color()} inicializa 8 cores básicas ao ativar o modo colorido. São elas: 0:preto, 1:vermelho, 2:verde, 3:amarelo, 4:azul, 5:magenta, 6:ciano e 7:branco. O módulo @ref{2b,,curses} define constantes nomeadas para cada uma dessas cores: @ref{3274,,curses.COLOR_BLACK}, @ref{3279,,curses.COLOR_RED}, e assim por diante.

Vamos juntar tudo isso. Para redefinir a cor 1 como texto vermelho sobre fundo branco, você chamaria:

@example
curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)
@end example

Quando você redefine um par de cores, qualquer texto que já tenha sido exibido usando esse par de cores vai mudar para a nova definição. Você pode também exibir mais texto nessa nova cor com:

@example
stdscr.addstr(0,0, "ALERTA VERMELHO!", curses.color_pair(1))
@end example

Terminais super sofisticados podem trocar as definições das cores em si para um dado valor RGB. Isso permite que você troque a cor 1, que geralmente é vermelha, para roxo ou azul ou qualquer outra cor que você queira. Infelizmente, o terminal Linux não provê essa funcionalidade, de forma que eu não consigo testá-la para fornecer exemplos. Você pode verificar se o seu terminal tem esse recurso chamando a função @ref{3144,,can_change_color()}, que retorna @code{True} se o recurso existir. Se por ventura o seu terminal for talentoso assim, consulte as páginas man do seu sistema para mais informações.

@node Entrada de usuário,Para mais informações,Exibindo texto,Programação em Curses com Python
@anchor{howto/curses user-input}@anchor{5312}
@subsection Entrada de usuário


A biblioteca curses em C oferece somente mecanismos de entrada muito simples. O módulo @ref{2b,,curses} do Python adiciona um componente básico de entrada de texto. (Outras bibliotecas como Urwid@footnote{https://pypi.org/project/Urwid/} têm coleções mais extensas de componentes.)

Há dois métodos para capturar entrada de uma janela:


@itemize *

@item 
O @ref{1627,,getch()} atualiza a tela e então espera o usuário apertar alguma tecla, exibindo o valor dela caso @ref{3155,,echo()} tenha sido chamada anteriormente. Opcionalmente, você pode especificar a coordenada onde o cursor deve ser posicionado antes de pausar.

@item 
O @ref{31b3,,getkey()} faz a mesma coisa, mas converte o inteiro para string. Caracteres individuais são retorndos como strings de 1 caractere, e teclas especiais como teclas funcionais retornam strings maiores contendo nomes de teclas como @code{KEY_UP} ou @code{^G}.
@end itemize

É possível não esperar pelo usuário usando o método @ref{31c9,,nodelay()} das janelas. Após @code{nodelay(True)}, os métodos @code{getch()} e @code{getkey()} da janela viram não-bloqueantes. Para sinalizar que não há entrada disponível, o @code{getch()} retorna @code{curses.ERR} (com valor de -1) e o @code{getkey()} levanta uma exceção. Também há uma função @ref{316d,,halfdelay()}, que pode ser usada para (efetivamente) definit um temporizador em cada @code{getch()}; se nenhuma entrada estiver disponível após um intervalo de espera especificado (medido em décimos de segundo), a curses levanta uma exceção.

O método @code{getch()} retorna um inteiro. Se ele estiver entre 0 e 255, ele representa o código ASCII da tecla digitada. Valores maiores que 255 são teclas especiais como Page Up, Home, ou as teclas de seta. Você pode comparar o valor retornado com constantes como @ref{3206,,curses.KEY_PPAGE}, @ref{31f7,,curses.KEY_HOME} ou @ref{31f5,,curses.KEY_LEFT}. O laço principal do seu programa pode ser algo como:

@example
while True:
    c = stdscr.getch()
    if c == ord('p'):
        PrintDocument()
    elif c == ord('q'):
        break  # Interrompe o laço while
    elif c == curses.KEY_HOME:
        x = y = 0
@end example

O módulo @ref{2c,,curses.ascii} fornece funções de teste de pertencimento que levam como argumento tanto inteiros quanto strings de 1 caractere; elas podem ser úteis para escrever testes mais legíveis para tais laços. Ele também fornece funções de conversão que levam como argumento tanto inteiros quanto strings de 1 caractere, e retornam objetos do mesmo tipo. Por exemplo, @ref{32bc,,curses.ascii.ctrl()} retorna o caractere de controle correspondente ao argumento.

Também há um método para pegar uma string inteira, @ref{31b6,,getstr()}. Ele não costuma ser usado porque a sua funcionalidade é um pouco limitada: as únicas teclas de edição disponíveis são o Backspace e o Enter, que termina a string. Ele pode opcionalmente limitado a um número fixo de caracteres.

@example
curses.echo()            # Abilita visualização dos caracteres

# Lê uma string de 15 caracteres, com o cursor na linha do topo
s = stdscr.getstr(0,0, 15)
@end example

O módulo @ref{2e,,curses.textpad} fornece uma caixa de texto que provê um conjunto de atalhos de teclado estilo Emacs. Vários métodos da classe @ref{327d,,Textbox} provêm edição com validação de entrada e recuperação dos resultados da edição com ou sem espaços em branco no final.

@example
import curses
from curses.textpad import Textbox, rectangle

def main(stdscr):
    stdscr.addstr(
        0, 0,
        "Digite a mensagem instantânea: (aperte Ctrl-G para enviar)")

    editwin = curses.newwin(5,30, 2,1)
    rectangle(stdscr, 1,0, 1+5+1, 1+30+1)
    stdscr.refresh()

    box = Textbox(editwin)

    # Deixa o usuário editar até apertar Ctrl-G.
    box.edit()

    # Recupera o conteúdo resultante.
    message = box.gather()
@end example

Consulte a documentação de biblioteca do @ref{2e,,curses.textpad} para mais detalhes.

@node Para mais informações,,Entrada de usuário,Programação em Curses com Python
@anchor{howto/curses for-more-information}@anchor{5313}
@subsection Para mais informações


Este COMOFAZER não cobre alguns tópicos avançados, como ler o conteúdo da tela ou capturar eventos de mouse de uma instância xterm, mas a página de biblioteca Python para o módulo @ref{2b,,curses} está agora razoavelmente completa. Ela deve ser o seu próximo destino.

Se estiver em dúvida quanto aos detalhes do comportamento das funções curses, consulte as páginas de manual para a sua implementação curses, seja ela o ncurses ou de algum fornecedor Unix proprietário. As páginas de manual vão documentar quaisquer peculiaridades, e prover listas completas de todas as funções, atributos e caracteres @ref{324e,,ACS_*} disponíveis para você.

Devido à API da curses ser tão grande, algumas funções não são providas pela interface Python. Muitas vezes isso não é por dificuldade de implementação, e sim porque ninguém precisou delas ainda. Além disso, o Python ainda não suporta a biblioteca de menus associada à ncurses. Patches que adicionem suporte a essas funcionalidades seriam bem-vindos; veja o Guia do Desenvolvedor do Python@footnote{https://devguide.python.org/} para aprender melhor sobre como submeter patches ao Python.


@itemize *

@item 
Writing Programs with NCURSES@footnote{https://invisible-island.net/ncurses/ncurses-intro.html}: um tutorial comprido para programadores C.

@item 
Página man do ncurses@footnote{https://linux.die.net/man/3/ncurses}

@item 
FAQ do ncurses@footnote{https://invisible-island.net/ncurses/ncurses.faq.html}

@item 
"Use curses... don't swear"@footnote{https://www.youtube.com/watch?v=eN1eZtjLEnU}: vídeo de uma palestra na PyCon 2013 sobre controle de terminais usando curses ou Urwid.

@item 
"Console Applications with Urwid"@footnote{https://pyvideo.org/video/1568/console-applications-with-urwid}: vídeo de uma palestra na PyCon CA 2012 demonstrando algumas aplicações escritas com Urwid.
@end itemize

@node Guia de descritores,Depurando extensões de API C e internos do CPython com GDB,Programação em Curses com Python,Python HOWTOs
@anchor{howto/descriptor doc}@anchor{5314}@anchor{howto/descriptor descriptor-guide}@anchor{5315}@anchor{howto/descriptor descriptorhowto}@anchor{1535}@anchor{howto/descriptor translation-repo}@anchor{5316}
@section Guia de descritores


@*Autor: 
Raymond Hettinger


@*Contato: 
<python at rcn dot com>


@ref{1658,,Descritores} permitem que os objetos personalizem a consulta, o armazenamento e a exclusão de atributos.

Este guia tem quatro seções principais:


@enumerate 

@item 
A “introdução” oferece uma visão geral básica, movendo-se suavemente a partir de exemplos simples, adicionando um recurso de cada vez. Comece aqui se você for novo em descritores.

@item 
A segunda seção mostra um exemplo de descritor prático completo. Se você já conhece o básico, comece por aí.

@item 
A terceira seção fornece um tutorial mais técnico que aborda a mecânica detalhada de como os descritores funcionam. A maioria das pessoas não precisa desse nível de detalhe.

@item 
A última seção tem equivalentes puros de Python para descritores embutidos que são escritos em C. Leia isto se estiver curioso sobre como as funções se transformam em métodos vinculados ou sobre a implementação de ferramentas comuns como @ref{166,,classmethod()}, @ref{416,,staticmethod()}, @ref{194,,property()} e @ref{5df,,__slots__}.
@end enumerate

@menu
* Introdução: Introdução<14>. 
* Exemplo completamente prático:: 
* Tutorial técnico:: 
* Equivalentes de Python puro:: 

@end menu

@node Introdução<14>,Exemplo completamente prático,,Guia de descritores
@anchor{howto/descriptor primer}@anchor{5317}
@subsection Introdução


Nesta introdução, começamos com o exemplo mais básico possível e, em seguida, adicionaremos novos recursos um por um.

@menu
* Exemplo simples; um descritor que retorna uma constante: Exemplo simples um descritor que retorna uma constante. 
* Pesquisas dinâmicas:: 
* Atributos gerenciados:: 
* Nomes personalizados:: 
* Pensamentos finais:: 

@end menu

@node Exemplo simples um descritor que retorna uma constante,Pesquisas dinâmicas,,Introdução<14>
@anchor{howto/descriptor simple-example-a-descriptor-that-returns-a-constant}@anchor{5318}
@subsubsection Exemplo simples: um descritor que retorna uma constante


A classe @code{Ten} é um descritor cujo método @ref{1530,,__get__()} sempre retorna a constante @code{10}:

@example
class Ten:
    def __get__(self, obj, objtype=None):
        return 10
@end example

Para usar o descritor, ele deve ser armazenado como uma variável de classe em outra classe:

@example
class A:
    x = 5                       # Atributo de classe comum
    y = Ten()                   # Instância de descritor
@end example

Uma sessão interativa mostra a diferença entre a pesquisa de atributo normal e a pesquisa de descritor:

@example
>>> a = A()                     # Cria uma instância da classeA
>>> a.x                         # Pesquisa de atributo normal
5
>>> a.y                         # Pesquisa de descritor
10
@end example

Na pesquisa de atributo @code{a.x}, o operador ponto encontra @code{'x': 5} no dicionário de classe. Na pesquisa @code{a.y}, o operador ponto encontra uma instância de descritor, reconhecida por seu método @code{__get__}. Chamar esse método retorna @code{10}.

Observe que o valor @code{10} não é armazenado no dicionário da classe ou no dicionário da instância. Em vez disso, o valor @code{10} é calculado sob demanda.

Este exemplo mostra como funciona um descritor simples, mas não é muito útil. Para recuperar constantes, a pesquisa de atributo normal seria melhor.

Na próxima seção, criaremos algo mais útil, uma pesquisa dinâmica.

@node Pesquisas dinâmicas,Atributos gerenciados,Exemplo simples um descritor que retorna uma constante,Introdução<14>
@anchor{howto/descriptor dynamic-lookups}@anchor{5319}
@subsubsection Pesquisas dinâmicas


Descritores interessantes normalmente executam cálculos em 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()              # Instância de descritor

    def __init__(self, dirname):
        self.dirname = dirname          # Atributo de instância regular
@end example

Uma sessão interativa mostra que a pesquisa é dinâmica – calcula respostas diferentes e atualizadas a cada vez:

@example
>>> s = Directory('songs')
>>> g = Directory('games')
>>> s.size                              # O jogo de músicas tem vinte arquivos
20
>>> g.size                              # O diretório de jogos tem três arquivos
3
>>> os.remove('games/chess')            # Exclui um jogo
>>> g.size                              # Contagem de arquivos é atualizada automaticamente
2
@end example

Além de mostrar como os descritores podem executar cálculos, este exemplo também revela o propósito dos parâmetros para @ref{1530,,__get__()}. O parâmetro `self' é `size', uma instância de `DirectorySize'. O parâmetro `obj' é `g' ou `s', uma instância de `Directory'. É o parâmetro `obj' que permite ao método @ref{1530,,__get__()} aprender o diretório de destino. O parâmetro `objtype' é a classe `Directory'.

@node Atributos gerenciados,Nomes personalizados,Pesquisas dinâmicas,Introdução<14>
@anchor{howto/descriptor managed-attributes}@anchor{531a}
@subsubsection Atributos gerenciados


Um uso popular para descritores é gerenciar o acesso aos dados da instância. O descritor é atribuído a um atributo público no dicionário da classe, enquanto os dados reais são armazenados como um atributo privado no dicionário da instância. Os métodos @ref{1530,,__get__()} e @ref{20f7,,__set__()} do descritor são disparados quando o atributo público é acessado.

No exemplo a seguir, `age' é o atributo público e `_age' é o atributo privado. Quando o atributo público é acessado, o descritor registra a pesquisa ou atualização:

@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()             # Instância de descritor

    def __init__(self, name, age):
        self.name = name                # Atributo de instância regular
        self.age = age                  # Chama __set__()

    def birthday(self):
        self.age += 1                   # Chama __get__() e __set__()
@end example

Uma sessão interativa mostra que todo o acesso ao atributo gerenciado `age' é registrado, mas que o atributo regular `name' não é registrado:

@c import logging, sys
@c logging.basicConfig(level=logging.INFO, stream=sys.stdout, force=True)

@example
>>> mary = Person('Mary M', 30)         # A atualização inicial de idade é registrada
INFO:root:Updating 'age' to 30
>>> dave = Person('David D', 40)
INFO:root:Updating 'age' to 40

>>> vars(mary)                          # Os dados estão em um atributo privado
@{'name': 'Mary M', '_age': 30@}
>>> vars(dave)
@{'name': 'David D', '_age': 40@}

>>> mary.age                            # Acessa os dados e registra a pesquisa
INFO:root:Accessing 'age' giving 30
30
>>> mary.birthday()                     # Atualizações são registradas também
INFO:root:Accessing 'age' giving 30
INFO:root:Updating 'age' to 31

>>> dave.name                           # Pesquisa de atributo regular não é registrada
'David D'
>>> dave.age                            # Apenas o atributo gerenciado é registrado
INFO:root:Accessing 'age' giving 40
40
@end example

Um grande problema com este exemplo é que o nome privado `_age' está conectado na classe `LoggedAgeAccess'. Isso significa que cada instância pode ter apenas um atributo registrado e que seu nome é imutável. No próximo exemplo, vamos corrigir esse problema.

@node Nomes personalizados,Pensamentos finais,Atributos gerenciados,Introdução<14>
@anchor{howto/descriptor customized-names}@anchor{531b}
@subsubsection Nomes personalizados


Quando uma classe usa descritores, ela pode informar a cada descritor sobre qual nome de variável foi usado.

Neste exemplo, a classe @code{Person} tem duas instâncias de descritor, `name' e `age'. Quando a classe @code{Person} é definida, ela faz uma função de retorno para @ref{c69,,__set_name__()} em `LoggedAccess' para que os nomes dos campos possam ser registrados, dando a cada descritor o seu próprio `public_name' e `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()                # Primeira instância de descritor
    age = LoggedAccess()                 # Segunda instância de descritor

    def __init__(self, name, age):
        self.name = name                 # Chama o primeiro descritor
        self.age = age                   # Chama o segundo descritor

    def birthday(self):
        self.age += 1
@end example

Uma sessão interativa mostra que a classe @code{Person} chamou @ref{c69,,__set_name__()} para que os nomes dos campos fossem registrados. Aqui chamamos @ref{1bba,,vars()} para pesquisar o descritor sem acioná-lo:

@example
>>> vars(vars(Person)['name'])
@{'public_name': 'name', 'private_name': '_name'@}
>>> vars(vars(Person)['age'])
@{'public_name': 'age', 'private_name': '_age'@}
@end example

A nova classe agora registra acesso a `name' e `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

As duas instâncias `Person' contêm apenas os nomes privados:

@example
>>> vars(pete)
@{'_name': 'Peter P', '_age': 10@}
>>> vars(kate)
@{'_name': 'Catherine C', '_age': 20@}
@end example

@node Pensamentos finais,,Nomes personalizados,Introdução<14>
@anchor{howto/descriptor closing-thoughts}@anchor{531c}
@subsubsection Pensamentos finais


Um @ref{1658,,descritor} é o que chamamos de qualquer objeto que define @ref{1530,,__get__()}, @ref{20f7,,__set__()} ou @ref{16f5,,__delete__()}.

Opcionalmente, os descritores podem ter um método @ref{c69,,__set_name__()}. Isso é usado somente em casos em que um descritor precisa saber a classe onde foi criado ou o nome da variável de classe à qual foi atribuído. (Este método, se presente, é chamado mesmo se a classe não for um descritor.)

Descritores são invocados pelo operador ponto durante a pesquisa de atributos. Se um descritor for acessado indiretamente com @code{vars(some_class)[descriptor_name]}, a instância do descritor é retornada sem invocá-lo.

Descritores só funcionam quando usados como variáveis de classe. Quando colocados em instâncias, eles não têm efeito.

A principal motivação para descritores é fornecer um gancho permitindo que objetos armazenados em variáveis de classe controlem o que acontece durante a pesquisa de atributos.

Tradicionalmente, a classe de chamada controla o que acontece durante a pesquisa. Descritores invertem esse relacionamento e permitem que os dados pesquisados tenham uma palavra a dizer sobre o assunto.

Descritores são usados em toda a linguagem. É como funções se transformam em métodos vinculados. Ferramentas comuns como @ref{166,,classmethod()}, @ref{416,,staticmethod()}, @ref{194,,property()} e @ref{541,,functools.cached_property()} são todas implementadas como descritores.

@node Exemplo completamente prático,Tutorial técnico,Introdução<14>,Guia de descritores
@anchor{howto/descriptor complete-practical-example}@anchor{531d}
@subsection Exemplo completamente prático


Neste exemplo, criamos uma ferramenta prática e poderosa para localizar bugs de corrupção de dados notoriamente difíceis de encontrar.

@menu
* Classe Validator:: 
* Validadores personalizados:: 
* Aplicação prática:: 

@end menu

@node Classe Validator,Validadores personalizados,,Exemplo completamente prático
@anchor{howto/descriptor validator-class}@anchor{531e}
@subsubsection Classe Validator


Um validador é um descritor para acesso de atributo gerenciado. Antes de armazenar quaisquer dados, ele verifica se o novo valor atende a várias restrições de tipo e intervalo. Se essas restrições não forem atendidas, ele levanta uma exceção para evitar corrupção de dados em sua origem.

Esta classe @code{Validator} é uma @ref{11f5,,classe base abstrata} e um descritor de atributo gerenciado:

@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 precisam herdar de @code{Validator} e devem fornecer um método @code{validate()} para testar várias restrições conforme necessário.

@node Validadores personalizados,Aplicação prática,Classe Validator,Exemplo completamente prático
@anchor{howto/descriptor custom-validators}@anchor{531f}
@subsubsection Validadores personalizados


Vemos aqui três utilitários práticos de validação de dados:


@enumerate 

@item 
@code{OneOf} verifica se um valor é um de um conjunto restrito de opções.

@item 
@code{Number} verifica se um valor é um @ref{257,,int} ou @ref{2f7,,float}. Opcionalmente, ele verifica se um valor está entre um mínimo ou máximo dado.

@item 
@code{String} verifica se um valor é um @ref{44c,,str}. Opcionalmente, ele valida um comprimento mínimo ou máximo dado. Ele pode validar um predicado@footnote{https://pt.wikipedia.org/wiki/Predicado_(lógica_matemática)} definido pelo usuário também.
@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 a 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 Aplicação prática,,Validadores personalizados,Exemplo completamente prático
@anchor{howto/descriptor practical-application}@anchor{5320}
@subsubsection Aplicação prática


Veja como os validadores de dados podem ser usados em uma classe 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

Os descritores impedem que instâncias inválidas sejam criadas:

@example
>>> Component('Widget', 'metal', 5)      # Bloqueado: 'Widget' não está todo em letras maiúsculas
Traceback (most recent call last):
    ...
ValueError: Expected <method 'isupper' of 'str' objects> to be true for 'Widget'

>>> Component('WIDGET', 'metle', 5)      # Bloqueado: 'metle' contém um erro de escrita
Traceback (most recent call last):
    ...
ValueError: Expected 'metle' to be one of @{'metal', 'plastic', 'wood'@}

>>> Component('WIDGET', 'metal', -5)     # Bloqueado: -5 é negativo
Traceback (most recent call last):
    ...
ValueError: Expected -5 to be at least 0

>>> Component('WIDGET', 'metal', 'V')    # Bloqueado: 'V' não é um número
Traceback (most recent call last):
    ...
TypeError: Expected 'V' to be an int or float

>>> c = Component('WIDGET', 'metal', 5)  # Permitido:  As entradas são válidas
@end example

@node Tutorial técnico,Equivalentes de Python puro,Exemplo completamente prático,Guia de descritores
@anchor{howto/descriptor technical-tutorial}@anchor{5321}
@subsection Tutorial técnico


O que se segue é um tutorial mais técnico sobre a mecânica e os detalhes de como os descritores funcionam.

@menu
* Resumo:: 
* Definição e introdução:: 
* Protocolo Descriptor:: 
* Visão geral da invocação do descritor:: 
* Invocação de uma instância:: 
* Invocação de uma classe:: 
* Invocação de super:: 
* Resumo da lógica de invocação:: 
* Notificação automática de nome:: 
* Exemplo de ORM:: 

@end menu

@node Resumo,Definição e introdução,,Tutorial técnico
@anchor{howto/descriptor abstract}@anchor{5322}
@subsubsection Resumo


Define descritores, resume o protocolo e mostra como os descritores são chamados. Fornece um exemplo mostrando como mapeamentos relacionais de objetos funcionam.

Aprender sobre descritores não apenas fornece acesso a um conjunto de ferramentas maior, mas também cria uma compreensão mais profunda de como o Python funciona.

@node Definição e introdução,Protocolo Descriptor,Resumo,Tutorial técnico
@anchor{howto/descriptor definition-and-introduction}@anchor{5323}
@subsubsection Definição e introdução


Em geral, um descritor é um valor de atributo que tem um dos métodos no protocolo do descritor. Esses métodos são @ref{1530,,__get__()}, @ref{20f7,,__set__()} e @ref{16f5,,__delete__()}. Se qualquer um desses métodos for definido para um atributo, ele é dito ser um @ref{1658,,descritor}.

O comportamento padrão para acesso a atributos é obter, definir ou excluir o atributo do dicionário de um objeto. Por exemplo, @code{a.x} tem uma cadeia de pesquisa começando com @code{a.__dict__['x']}, depois @code{type(a).__dict__['x']} e continuando pela ordem de resolução de métodos de @code{type(a)}. Se o valor pesquisado for um objeto que define um dos métodos descritores, o Python pode substituir o comportamento padrão e invocar o método descritor. Onde isso ocorre na cadeia de precedência depende de quais métodos descritores foram definidos.

Descritores são um protocolo poderoso de propósito geral. Eles são o mecanismo por trás de propriedades, métodos, métodos estáticos, métodos de classe e @ref{4db,,super()}. Eles são usados em todo o Python. Descritores simplificam o código C subjacente e oferecem um conjunto flexível de novas ferramentas para programas Python do dia a dia.

@node Protocolo Descriptor,Visão geral da invocação do descritor,Definição e introdução,Tutorial técnico
@anchor{howto/descriptor descriptor-protocol}@anchor{5324}
@subsubsection Protocolo Descriptor


@code{descr.__get__(self, obj, type=None)}

@code{descr.__set__(self, obj, value)}

@code{descr.__delete__(self, obj)}

É só isso. Defina qualquer um desses métodos e um objeto é considerado um descritor e pode substituir o comportamento padrão ao ser pesquisado como um atributo.

Se um objeto define @ref{20f7,,__set__()} ou @ref{16f5,,__delete__()}, ele é considerado um descritor de dados. Descritores que definem apenas @ref{1530,,__get__()} são chamados de descritores não-dados (eles são frequentemente usados para métodos, mas outros usos são possíveis).

Descritores de dados e não dados diferem em como as substituições são calculadas com relação às entradas no dicionário de uma instância. Se o dicionário de uma instância tiver uma entrada com o mesmo nome de um descritor de dados, o descritor de dados terá precedência. Se o dicionário de uma instância tiver uma entrada com o mesmo nome de um descritor não dados, a entrada do dicionário terá precedência.

Para criar um descritor de dados somente leitura, defina @ref{1530,,__get__()} e @ref{20f7,,__set__()} com o @ref{20f7,,__set__()} levantando @ref{34b,,AttributeError} quando chamado. Definir o método @ref{20f7,,__set__()} com um espaço reservado levantando uma exceção é o suficiente para torná-lo um descritor de dados.

@node Visão geral da invocação do descritor,Invocação de uma instância,Protocolo Descriptor,Tutorial técnico
@anchor{howto/descriptor overview-of-descriptor-invocation}@anchor{5325}
@subsubsection Visão geral da invocação do descritor


Um descritor pode ser chamado diretamente com @code{desc.__get__(obj)} ou @code{desc.__get__(None, cls)}.

Mas é mais comum que um descritor seja invocado automaticamente a partir do acesso ao atributo.

A expressão @code{obj.x} procura o atributo @code{x} na cadeia de espaços de nomes para @code{obj}. Se a busca encontrar um descritor fora da instância @ref{55b,,__dict__}, seu método @ref{1530,,__get__()} é invocado de acordo com as regras de precedência listadas abaixo.

Os detalhes da invocação dependem se @code{obj} é um objeto, classe ou instância de super.

@node Invocação de uma instância,Invocação de uma classe,Visão geral da invocação do descritor,Tutorial técnico
@anchor{howto/descriptor invocation-from-an-instance}@anchor{5326}
@subsubsection Invocação de uma instância


A pesquisa de instância verifica uma cadeia de espaços de nomes, dando aos descritores de dados a maior prioridade, seguidos por variáveis de instância, depois descritores que não são de dados, depois variáveis de classe e, por último, @ref{4d3,,__getattr__()}, se fornecido.

Se um descritor for encontrado para @code{a.x}, ele será invocado com: @code{desc.__get__(a, type(a))}.

A lógica para uma pesquisa pontilhada está em @ref{beb,,object.__getattribute__()}. Aqui está um equivalente 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)     # descritor de dados
    if hasattr(obj, '__dict__') and name in vars(obj):
        return vars(obj)[name]                          # variável de instância
    if descr_get is not null:
        return descr_get(cls_var, obj, objtype)         # descritor de não dados
    if cls_var is not null:
        return cls_var                                  # variável de classe
    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

Note que não há nenhum gancho @ref{4d3,,__getattr__()} no código @ref{beb,,__getattribute__()}. É por isso que chamar @ref{beb,,__getattribute__()} diretamente ou com @code{super().__getattribute__} ignorará @ref{4d3,,__getattr__()} completamente.

Em vez disso, é o operador ponto e a função @ref{bea,,getattr()} que são responsáveis por invocar @ref{4d3,,__getattr__()} sempre que @ref{beb,,__getattribute__()} levanta um @ref{34b,,AttributeError}. A lógica deles é encapsulada em uma função 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 Invocação de uma classe,Invocação de super,Invocação de uma instância,Tutorial técnico
@anchor{howto/descriptor invocation-from-a-class}@anchor{5327}
@subsubsection Invocação de uma classe


A lógica para uma pesquisa pontilhada como @code{A.x} está em @code{type.__getattribute__()}. Os passos são similares aos de @code{object.__getattribute__()} mas a pesquisa do dicionário de instância é substituída por uma pesquisa através da @ref{2316,,ordem de resolução de métodos} da classe.

Se um descritor for encontrado, ele será invocado com @code{desc.__get__(None, A)}.

A implementação completa em C pode ser encontrada em @code{type_getattro()} e @code{_PyType_Lookup()} em Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.13/Objects/typeobject.c}.

@node Invocação de super,Resumo da lógica de invocação,Invocação de uma classe,Tutorial técnico
@anchor{howto/descriptor invocation-from-super}@anchor{5328}
@subsubsection Invocação de super


A lógica para a pesquisa pontilhada de super está no método @ref{beb,,__getattribute__()} para o objeto retornado por @ref{4db,,super()}.

Uma pesquisa pontilhada como @code{super(A, obj).m} pesquisa @code{obj.__class__.__mro__} para a classe base @code{B} imediatamente após @code{A} e então retorna @code{B.__dict__['m'].__get__(obj, A)}. Se não for um descritor, @code{m} é retornado inalterado.

A implementação completa em C pode ser encontrada em @code{super_getattro()} em Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.13/Objects/typeobject.c}. Um equivalente em Python puro pode ser encontrado no Tutorial do Guido@footnote{https://www.python.org/download/releases/2.2.3/descrintro/#cooperation}.

@node Resumo da lógica de invocação,Notificação automática de nome,Invocação de super,Tutorial técnico
@anchor{howto/descriptor summary-of-invocation-logic}@anchor{5329}
@subsubsection Resumo da lógica de invocação


O mecanismo para descritores está incorporado nos métodos @ref{beb,,__getattribute__()} para @ref{a96,,object}, @ref{d6b,,type} e @ref{4db,,super()}.

Os pontos importantes para lembrar são:


@itemize *

@item 
Descritores são invocados pelo método @ref{beb,,__getattribute__()}.

@item 
As classes herdam esse maquinário de @ref{a96,,object}, @ref{d6b,,type} ou @ref{4db,,super()}.

@item 
Substituir @ref{beb,,__getattribute__()} impede chamadas automáticas do descritor porque toda a lógica do descritor está nesse método.

@item 
@code{object.__getattribute__()} e @code{type.__getattribute__()} fazem chamadas diferentes para @ref{1530,,__get__()}. O primeiro inclui a instância e pode incluir a classe. O segundo coloca @code{None} para a instância e sempre inclui a classe.

@item 
Os descritores de dados sempre substituem os dicionários de instância.

@item 
Descritores de não-dados podem ser substituídos pelos dicionários de instância.
@end itemize

@node Notificação automática de nome,Exemplo de ORM,Resumo da lógica de invocação,Tutorial técnico
@anchor{howto/descriptor automatic-name-notification}@anchor{532a}
@subsubsection Notificação automática de nome


Às vezes, é desejável que um descritor saiba a qual nome de variável de classe ele foi atribuído. Quando uma nova classe é criada, a metaclasse @ref{d6b,,type} varre o dicionário da nova classe. Se qualquer uma das entradas for descritor e se eles definirem @ref{c69,,__set_name__()}, esse método será chamado com dois argumentos. O `owner' é a classe onde o descritor é usado, e o `name' é a variável de classe à qual o descritor foi atribuído.

Os detalhes de implementações estão em @code{type_new()} e @code{set_names()} em Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.13/Objects/typeobject.c}.

Como a lógica de atualização está em @code{type.__new__()}, as notificações só ocorrem no momento da criação da classe. Se descritores forem adicionados à classe posteriormente, @ref{c69,,__set_name__()} precisará ser chamado manualmente.

@node Exemplo de ORM,,Notificação automática de nome,Tutorial técnico
@anchor{howto/descriptor orm-example}@anchor{532b}
@subsubsection Exemplo de ORM


O código a seguir é um esqueleto simplificado que mostra como os descritores de dados podem ser usados para implementar um mapeamento relacional de objetos@footnote{https://pt.wikipedia.org/wiki/Mapeamento_objeto-relacional}.

A ideia essencial é que os dados sejam armazenados em um banco de dados externo. As instâncias do Python só guardam chaves para as tabelas do banco de dados. Descritores cuidam de pesquisas ou atualizações:

@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 a classe @code{Field} para definir modelos@footnote{https://en.wikipedia.org/wiki/Database_model} que descrevem o esquema de cada tabela em um banco de dados:

@example
class Movie:
    table = 'Movies'                    # Nome da tabela
    key = 'title'                       # Chave primária
    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 os modelos, primeiro conecte ao banco de dados:

@example
>>> import sqlite3
>>> conn = sqlite3.connect('entertainment.db')
@end example

Uma sessão interativa mostra como os dados são recuperados do banco de dados e como eles podem ser atualizados:

@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 de Python puro,,Tutorial técnico,Guia de descritores
@anchor{howto/descriptor pure-python-equivalents}@anchor{532c}
@subsection Equivalentes de Python puro


O protocolo descritor é simples e oferece possibilidades interessantes. Vários casos de uso são tão comuns que foram pré-empacotados em ferramentas embutidas. Propriedades, métodos vinculados, métodos estáticos, métodos de classe e __slots__ são todos baseados no protocolo descritor.

@menu
* Propriedades:: 
* Funções e métodos:: 
* Tipos de métodos:: 
* Métodos estáticos:: 
* Métodos de classe:: 
* Member objects and __slots__:: 

@end menu

@node Propriedades,Funções e métodos,,Equivalentes de Python puro
@anchor{howto/descriptor properties}@anchor{532d}
@subsubsection Propriedades


Chamar @ref{194,,property()} é uma maneira sucinta de construir um descritor de dados que dispara uma chamada de função ao acessar um atributo. Sua assinatura é:

@example
property(fget=None, fset=None, fdel=None, doc=None) -> property
@end example

A documentação mostra um uso típico para definir um atributo gerenciado @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'

Para ver como @ref{194,,property()} é implementada em termos do protocolo descritor, aqui está um equivalente Python puro que implementa a maior parte da funcionalidade principal:

@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

O recurso embutido @ref{194,,property()} ajuda sempre que uma interface de usuário concede acesso a atributos e alterações subsequentes exigem a intervenção de um método.

Por exemplo, uma classe de planilha pode conceder acesso a um valor de célula por meio de @code{Cell('b10').value}. Melhorias subsequentes no programa exigem que a célula seja recalculada em cada acesso; no entanto, o programador não quer afetar o código do cliente existente acessando o atributo diretamente. A solução é encapsular o acesso ao atributo de valor em um descritor de dados de propriedade:

@example
class Cell:
    ...

    @@property
    def value(self):
        "Recalculate the cell before returning value"
        self.recalc()
        return self._value
@end example

Tanto o @ref{194,,property()} embutida quanto nosso equivalente @code{Property()} funcionariam neste exemplo.

@node Funções e métodos,Tipos de métodos,Propriedades,Equivalentes de Python puro
@anchor{howto/descriptor functions-and-methods}@anchor{532e}
@subsubsection Funções e métodos


Os recursos orientados a objetos do Python são construídos sobre um ambiente baseado em funções. Usando descritores de não-dados, os dois são mesclados perfeitamente.

Funções armazenadas em dicionários de classe são transformadas em métodos quando invocadas. Métodos diferem de funções regulares apenas porque a instância do objeto é prefixada aos outros argumentos. Por convenção, a instância é chamada `self', mas poderia ser chamada `this' ou qualquer outro nome de variável.trabalhar

Os métodos podem ser criados manualmente com @ref{190e,,types.MethodType}, que é 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 dar suporte à criação automática de métodos, as funções incluem o método @ref{1530,,__get__()} para vincular métodos durante o acesso ao atributo. Isso significa que as funções são descritores de não-dados que retornam métodos vinculados durante a pesquisa pontilhada de uma instância. Veja 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

A execução da classe a seguir no interpretador mostra como o descritor de função funciona na prática:

@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

A função tem um atributo @ref{1ab1,,nome qualificado} para dar suporte à introspecção:

@example
>>> D.f.__qualname__
'D.f'
@end example

Acessar a função por meio do dicionário de classes não invoca @ref{1530,,__get__()}. Em vez disso, ele apenas retorna o objeto da função subjacente:

@example
>>> D.__dict__['f']
<function D.f at 0x00C45070>
@end example

O acesso pontilhado de uma classe chama @ref{1530,,__get__()} que apenas retorna a função subjacente inalterada:

@example
>>> D.f
<function D.f at 0x00C45070>
@end example

O comportamento interessante ocorre durante o acesso pontuado de uma instância. A pesquisa pontilhada chama @ref{1530,,__get__()} que retorna um objeto do método vinculado:

@example
>>> d = D()
>>> d.f
<bound method D.f of <__main__.D object at 0x00B18C90>>
@end example

Internamente, o método vinculado armazena a função subjacente e a instância vinculada:

@example
>>> d.f.__func__
<function D.f at 0x00C45070>

>>> d.f.__self__
<__main__.D object at 0x00B18C90>
@end example

Se você já se perguntou de onde vem `self' em métodos regulares ou de onde vem `cls' em métodos de classe, é isso!

@node Tipos de métodos,Métodos estáticos,Funções e métodos,Equivalentes de Python puro
@anchor{howto/descriptor kinds-of-methods}@anchor{532f}
@subsubsection Tipos de métodos


Descritores de não-dados fornecem um mecanismo simples para variações nos padrões usuais de vinculação de funções em métodos.

To recap, functions have a @ref{1530,,__get__()} method so that they can be converted
to a method when accessed as attributes.  The non-data descriptor transforms an
@code{obj.f(*args)} call into @code{f(obj, *args)}.  Calling @code{cls.f(*args)}
becomes @code{f(*args)}.

Este gráfico resume a ligação e suas duas variantes mais úteis:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

Transformação

@tab

Chamada de um objeto

@tab

Chamada de uma classe

@item

função

@tab

f(obj, *args)

@tab

f(*args)

@item

staticmethod

@tab

f(*args)

@tab

f(*args)

@item

classmethod

@tab

f(type(obj), *args)

@tab

f(cls, *args)

@end multitable

@end quotation

@node Métodos estáticos,Métodos de classe,Tipos de métodos,Equivalentes de Python puro
@anchor{howto/descriptor static-methods}@anchor{5330}
@subsubsection Métodos estáticos


Static methods return the underlying function without changes.  Calling either
@code{c.f} or @code{C.f} is the equivalent of a direct lookup into
@code{object.__getattribute__(c, "f")} or @code{object.__getattribute__(C, "f")}. As a
result, the function becomes identically accessible from either an object or a
class.

Good candidates for static methods are methods that do not reference the
@code{self} variable.

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

Since static methods return the underlying function with no changes, the
example calls are unexciting:

@example
class E:
    @@staticmethod
    def f(x):
        return x * 10
@end example

@example
>>> E.f(3)
30
>>> E().f(3)
30
@end example

Using the non-data descriptor protocol, a pure Python version of
@ref{416,,staticmethod()} would look like this:

@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)
@end example

The @ref{1058,,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: @ref{1317,,__name__}, @ref{208d,,__qualname__},
@ref{1219,,__doc__}, and @ref{1218,,__annotations__}.

@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 classe,Member objects and __slots__,Métodos estáticos,Equivalentes de Python puro
@anchor{howto/descriptor class-methods}@anchor{5331}
@subsubsection Métodos de classe


Unlike static methods, class methods prepend the class reference to the
argument list before calling the function.  This format is the same
for whether the caller is an object or a class:

@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

This behavior is useful whenever the method only needs to have a class
reference and does not rely on data stored in a specific instance.  One use for
class methods is to create alternate class constructors.  For example, the
classmethod @ref{1637,,dict.fromkeys()} creates a new dictionary from a list of
keys.  The pure Python equivalent is:

@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

Now a new dictionary of unique keys can be constructed like this:

@example
>>> d = Dict.fromkeys('abracadabra')
>>> type(d) is Dict
True
>>> d
@{'a': None, 'b': None, 'r': None, 'c': None, 'd': None@}
@end example

Using the non-data descriptor protocol, a pure Python version of
@ref{166,,classmethod()} would look like this:

@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{1058,,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{1317,,__name__},
@ref{208d,,__qualname__}, @ref{1219,,__doc__},
and @ref{1218,,__annotations__}.

@node Member objects and __slots__,,Métodos de classe,Equivalentes de Python puro
@anchor{howto/descriptor member-objects-and-slots}@anchor{5332}
@subsubsection Member objects and __slots__


When a class defines @code{__slots__}, it replaces instance dictionaries with a
fixed-length array of slot values.  From a user point of view that has
several effects:

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{541,,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

It is not possible to create an exact drop-in pure Python version of
@code{__slots__} because it requires direct access to C structures and control
over object memory allocation.  However, we can build a mostly faithful
simulation where the actual C structure for slots is emulated by a private
@code{_slotvalues} list.  Reads and writes to that private structure are managed
by member descriptors:

@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

The @code{type.__new__()} method takes care of adding member objects to class
variables:

@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

The @ref{580,,object.__new__()} method takes care of creating instances that have
slots instead of an instance dictionary.  Here is a rough simulation in pure
Python:

@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

To use the simulation in a real class, just inherit from @code{Object} and
set the @ref{2112,,metaclass} to @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

At this point, the metaclass has loaded member objects for `x' and `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

When instances are created, they have a @code{slot_values} list where the
attributes are stored:

@example
>>> h = H(10, 20)
>>> vars(h)
@{'_slotvalues': [10, 20]@}
>>> h.x = 55
>>> vars(h)
@{'_slotvalues': [55, 20]@}
@end example

Misspelled or unassigned attributes will raise an exception:

@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 Depurando extensões de API C e internos do CPython com GDB,Enum,Guia de descritores,Python HOWTOs
@anchor{howto/gdb_helpers doc}@anchor{5333}@anchor{howto/gdb_helpers debugging-c-api-extensions-and-cpython-internals-with-gdb}@anchor{5334}@anchor{howto/gdb_helpers gdb}@anchor{5335}@anchor{howto/gdb_helpers translation-repo}@anchor{5336}
@section Depurando extensões de API C e internos do CPython com GDB


Este documento explica como a extensão GDB do Python, @code{python-gdb.py}, pode ser usada com o depurador GDB para depurar extensões CPython e o próprio interpretador CPython.

Ao depurar problemas de baixo nível, como falhas ou impasses, um depurador de baixo nível, como o GDB, é útil para diagnosticar e corrigir o problema. Por padrão, o GDB (ou qualquer uma de suas interfaces) não oferece suporte a informações de alto nível específicas do interpretador CPython.

A extensão @code{python-gdb.py} adiciona informações do interpretador CPython ao GDB. A extensão ajuda a inspecionar a pilha de funções Python atualmente em execução. Dado um objeto Python representado por um ponteiro @ref{339,,PyObject}*, a extensão mostra o tipo e o valor do objeto.

Desenvolvedores que estão trabalhando em extensões CPython ou mexendo com partes do CPython escritas em C podem usar este documento para aprender como usar a extensão @code{python-gdb.py} com o GDB.

@cartouche
@quotation Nota 
Este documento pressupõe que você esteja familiarizado com o básico do GDB e da API C do CPython. Ele consolida orientações do devguide@footnote{https://devguide.python.org} e da wiki do Python@footnote{https://wiki.python.org/moin/DebuggingWithGdb}.
@end quotation
@end cartouche

@menu
* Pré-requisitos:: 
* Usando a compilação de depuração e o modo de desenvolvimento:: 
* Usando a extensão python-gdb:: 
* Uso com comandos do GDB:: 

@end menu

@node Pré-requisitos,Usando a compilação de depuração e o modo de desenvolvimento,,Depurando extensões de API C e internos do CPython com GDB
@anchor{howto/gdb_helpers prerequisites}@anchor{5337}
@subsection Pré-requisitos


Você precisa ter:


@itemize -

@item 
GDB 7 ou posterior. (Para versões anteriores do GDB, consulte @code{Misc/gdbinit} nas fontes do Python 3.11 ou anterior.)

@item 
Informações de depuração compatíveis com GDB para Python e qualquer extensão que você esteja depurando.

@item 
A extensão @code{python-gdb.py}.
@end itemize

A extensão é construída com Python, mas pode ser distribuída separadamente ou não ser distribuída. Abaixo, incluímos dicas para alguns sistemas comuns como exemplos. Note que mesmo se as instruções corresponderem ao seu sistema, elas podem estar desatualizadas.

@menu
* Configuração com Python construído a partir do código-fonte:: 
* Configuração para Python a partir de uma distribuição Linux:: 

@end menu

@node Configuração com Python construído a partir do código-fonte,Configuração para Python a partir de uma distribuição Linux,,Pré-requisitos
@anchor{howto/gdb_helpers setup-with-python-built-from-source}@anchor{5338}
@subsubsection Configuração com Python construído a partir do código-fonte


Quando você compila o CPython a partir do código-fonte, as informações de depuração devem estar disponíveis, e a compilação deve adicionar um arquivo @code{python-gdb.py} ao diretório raiz do seu repositório.

Para ativar o suporte, você deve adicionar o diretório que contém @code{python-gdb.py} ao “auto-load-safe-path” do GDB. Se você ainda não fez isso, as versões recentes do GDB imprimirão um aviso com instruções sobre como fazer isso.

@cartouche
@quotation Nota 
Se você não encontrar instruções para a sua versão do GDB, coloque isso no seu arquivo de configuração (@code{~/.gdbinit} ou @code{~/.config/gdb/gdbinit}):

@example
add-auto-load-safe-path /caminho/para/cpython
@end example

Você também pode adicionar vários caminhos, separados por @code{:}.
@end quotation
@end cartouche

@node Configuração para Python a partir de uma distribuição Linux,,Configuração com Python construído a partir do código-fonte,Pré-requisitos
@anchor{howto/gdb_helpers setup-for-python-from-a-linux-distro}@anchor{5339}
@subsubsection Configuração para Python a partir de uma distribuição Linux


A maioria dos sistemas Linux fornece informações de depuração para o Python do sistema em um pacote chamado @code{python-debuginfo}, @code{python-dbg} ou similar. Por exemplo:


@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

Em vários sistemas Linux recentes, o GDB pode baixar automaticamente símbolos de depuração usando `debuginfod'. No entanto, isso não instalará a extensão @code{python-gdb.py}; geralmente é necessário instalar separadamente o pacote de informações de depuração.

@node Usando a compilação de depuração e o modo de desenvolvimento,Usando a extensão python-gdb,Pré-requisitos,Depurando extensões de API C e internos do CPython com GDB
@anchor{howto/gdb_helpers using-the-debug-build-and-development-mode}@anchor{533a}
@subsection Usando a compilação de depuração e o modo de desenvolvimento


Para facilitar a depuração, você pode querer:


@itemize -

@item 
Use a @ref{1f9,,compilação de depuração} do Python. (Ao compilar a partir do código-fonte, use @code{configure --with-pydebug}. Em distribuições Linux, instale e execute um pacote como @code{python-debug} ou @code{python-dbg}, se disponível.)

@item 
Use o @ref{1f8,,modo de desenvolvimento} de tempo de execução (@code{-X dev}).
@end itemize

Ambos habilitam assertivas extras e desabilitam algumas otimizações. Às vezes isso esconde o bug que você está tentando encontrar, mas na maioria dos casos eles facilitam o processo.

@node Usando a extensão python-gdb,Uso com comandos do GDB,Usando a compilação de depuração e o modo de desenvolvimento,Depurando extensões de API C e internos do CPython com GDB
@anchor{howto/gdb_helpers using-the-python-gdb-extension}@anchor{533b}
@subsection Usando a extensão @code{python-gdb}


Quando a extensão é carregada, ela fornece duas principais funcionalidades: impressões bonitas para valores Python e comandos adicionais.

@menu
* Pretty-printers:: 
* py-list:: 
* py-up e py-down:: 
* py-bt:: 
* py-print:: 
* py-locals:: 

@end menu

@node Pretty-printers,py-list,,Usando a extensão python-gdb
@anchor{howto/gdb_helpers pretty-printers}@anchor{533c}
@subsubsection Pretty-printers


Este é o aspecto de um backtrace do GDB (truncado) quando esta extensão está habilitada:

@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

Observe como o argumento do dicionário para @code{PyDict_GetItemString} é exibido como seu @code{repr()}, em vez de um ponteiro @code{PyObject *} opaco.

A extensão funciona fornecendo uma rotina de impressão personalizada para valores do tipo @code{PyObject *}. Se você precisar acessar detalhes de nível inferior de um objeto, então converta o valor para um ponteiro do tipo apropriado. Por exemplo:

@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

Observe que os pretty-printers não chamam realmente @code{repr()}. Para tipos básicos, eles tentam corresponder ao seu resultado de perto.

Uma área que pode ser confusa é que a impressão personalizada para alguns tipos se parece muito com a impressão embutida do GDB para tipos padrão. Por exemplo, a impressora bonita para um @code{int} do Python (@ref{588,,PyLongObject}*) fornece uma representação que não é distinguível de um inteiro de nível de máquina regular.

@example
(gdb) p some_machine_integer
$3 = 42

(gdb) p some_python_integer
$4 = 42
@end example

A estrutura interna pode ser revelada com um elenco para @ref{588,,PyLongObject}*:

@example
(gdb) p *(PyLongObject*)algum_inteiro_python $5 = @{ob_base = @{ob_base = @{ob_refcnt = 8, ob_type = 0x3dad39f5e0@}, ob_size = 1@}, ob_digit = @{42@}@}
@end example

Uma confusão semelhante pode surgir com o tipo @code{str}, onde a saída se parece muito com a a impressão embutida do gdb para @code{char *}.

@example
(gdb) p ptr_to_python_str
$6 = '__builtins__'
@end example

O pretty-printer para instâncias de @code{str} tem como padrão o uso de aspas simples (assim como o @code{repr} do Python para strings), enquanto o printer padrão para valores de @code{char *} usa aspas duplas e contém um endereço hexadecimal.

@example
(gdb) p ptr_to_char_star
$7 = 0x6d72c0 "hello world"
@end example

Novamente, os detalhes de implementação podem ser revelados com um chamada a @ref{794,,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 e py-down,Pretty-printers,Usando a extensão python-gdb
@anchor{howto/gdb_helpers py-list}@anchor{533d}
@subsubsection @code{py-list}


@quotation

A extensão adiciona um comando @code{py-list}, que lista o código-fonte Python (se houver) para o quadro atual na thread selecionada. A linha atual é marcada com um “>”:

@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} para listar em um número de linha diferente dentro do código Python, e @code{py-list START,END} para listar um intervalo específico de linhas dentro do código Python.
@end quotation

@node py-up e py-down,py-bt,py-list,Usando a extensão python-gdb
@anchor{howto/gdb_helpers py-up-and-py-down}@anchor{533e}
@subsubsection @code{py-up} e @code{py-down}


@quotation

Os comandos @code{py-up} e @code{py-down} são análogos aos comandos regulares @code{up} e @code{down} do GDB, mas tentam se mover no nível dos quadros do CPython, em vez dos quadros do C.

GDB nem sempre consegue ler as informações relevantes do quadro, dependendo do nível de otimização com o qual o CPython foi compilado. Internamente, os comandos procuram por quadros C que estão executando a função de avaliação de quadro padrão (ou seja, o laço do interpretador de bytecode principal dentro do CPython) e procuram o valor do @code{PyFrameObject *} relacionado.

Eles emitem o número do quadro (no nível C) dentro da thread.

Por exemplo:

@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

de forma estamos no topo da pilha do Python.

Os números de quadro correspondem aos exibidos pelo comando padrão @code{backtrace} do GDB. O comando ignora os quadros C que não estão executando código Python.

Voltando para baixo:

@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

e estamos na parte inferior da pilha do Python.

Observe que no Python 3.12 e versões mais recentes, o mesmo quadro de pilha C pode ser usado para vários quadros de pilha Python. Isso significa que @code{py-up} e @code{py-down} podem mover vários quadros Python de uma vez. Por exemplo:

@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 e py-down,Usando a extensão python-gdb
@anchor{howto/gdb_helpers py-bt}@anchor{533f}
@subsubsection @code{py-bt}


@quotation

O comando @code{py-bt} tenta mostrar uma rastreabilidade em nível Python da thread atual.

Por exemplo:

@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

Os números de quadro correspondem aos exibidos pelo comando padrão @code{backtrace} do GDB.
@end quotation

@node py-print,py-locals,py-bt,Usando a extensão python-gdb
@anchor{howto/gdb_helpers py-print}@anchor{5340}
@subsubsection @code{py-print}


@quotation

O comando @code{py-print} procura um nome em Python e tenta imprimi-lo. Ele procura em locais dentro da thread atual, depois em globais e, finalmente, em embutidos:

@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

Se o quadro C atual corresponder a vários quadros Python, @code{py-print} considera apenas o primeiro.
@end quotation

@node py-locals,,py-print,Usando a extensão python-gdb
@anchor{howto/gdb_helpers py-locals}@anchor{5341}
@subsubsection @code{py-locals}


@quotation

O comando @code{py-locals} busca todas as variáveis locais do Python no quadro Python atual na thread selecionada e imprime suas representações:

@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

Se o quadro C atual corresponder a vários quadros Python, serão mostrados os locais de todos eles:

@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 Uso com comandos do GDB,,Usando a extensão python-gdb,Depurando extensões de API C e internos do CPython com GDB
@anchor{howto/gdb_helpers use-with-gdb-commands}@anchor{5342}
@subsection Uso com comandos do GDB


Os comandos de extensão complementam os comandos embutidos do GDB. Por exemplo, você pode usar os números de quadro mostrados por @code{py-bt} com o comando @code{frame} para ir a um quadro específico dentro da thread selecionada, assim:

@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

O comando @code{info threads} fornecerá uma lista das threads dentro do processo, e você pode usar o comando @code{thread} para selecionar uma diferente:

@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

Você pode usar @code{thread apply all COMANDO} ou (@code{t a a COMANDO} para abreviar) para executar um comando em todas as threads. Com @code{py-bt}, isso permite que você veja o que cada thread está fazendo no nível do Python:

@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 Enum,Programação Funcional,Depurando extensões de API C e internos do CPython com GDB,Python HOWTOs
@anchor{howto/enum doc}@anchor{5343}@anchor{howto/enum enum-howto}@anchor{5344}@anchor{howto/enum id1}@anchor{5345}@anchor{howto/enum translation-repo}@anchor{5346}
@section Enum

@anchor{howto/enum enum-basic-tutorial}@anchor{2756}
Uma @ref{630,,Enum} é um conjunto de nomes simbólicos vinculados a valores únicos. São similares a variáveis globais, mas eles oferecem uma @ref{800,,repr()} mais útil, agrupamento, segurança de tipo e alguns outros recursos.

Eles são mais úteis quando você tem uma variável que pode ter uma seleção limitada de valores. Por exemplo, os dias da semana:

@example
>>> from enum import Enum
>>> class DiaDaSemana(Enum):
...     SEGUNDA = 1
...     TERÇA = 2
...     QUARTA = 3
...     QUINTA = 4
...     SEXTA = 5
...     SÁBADO = 6
...     DOMINGO = 7
@end example

Ou talvez as cores primárias RGB:

@example
>>> from enum import Enum
>>> class Cor(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
@end example

Como você pode ver, criar um @ref{630,,Enum} é tão simples quanto escrever uma classe que herda do próprio @ref{630,,Enum}.

@cartouche
@quotation Nota 
Maiúsculas em membros de Enums

Como os Enums são usados para representar constantes, e para ajudar a evitar problemas com nomes conflitando entre métodos/atributos de classes mixin e nomes enum, nós fortemente recomendamos o uso de nomes em UPPER_CASE (em caixa alta) para membros, e usaremos esse estilo em nossos exemplos.
@end quotation
@end cartouche

Dependendo da natureza do enum, o valor de um membro pode ou não ser importante. Mas, de qualquer forma, esse valor pode ser usado para obter o membro correspondente:

@example
>>> DiaDaSemana(3)
<DiaDaSemana.QUARTA: 3>
@end example

Como você pode ver, o @code{repr()} de um membro mostra o nome do enum, o nome do membro e o valor. O @code{str()} de um membro mostra apenas o nome do enum e o nome do membro:

@example
>>> print(DiaDaSemana.QUINTA)
DiaDaSemana.QUINTA
@end example

O `tipo' de um membro de enumeração é o enum ao qual ele pertence:

@example
>>> type(DiaDaSemana.SEGUNDA)
<enum 'DiaDaSemana'>
>>> isinstance(DiaDaSemana.SEXTA, DiaDaSemana)
True
@end example

Os membros do Enum têm um atributo que contém apenas seu @code{name}:

@example
>>> print(DiaDaSemana.TERÇA.name)
TERÇA
@end example

Da mesma forma, eles têm um atributo para seu @code{value}:

@example
>>> DiaDaSemana.QUARTA.value
3
@end example

Ao contrário de muitas linguagens que tratam enumerações apenas como pares de nome/valor, Enums do Python podem ter comportamento adicionado. Por exemplo, @ref{1cd,,datetime.date} tem dois métodos para retornar o dia da semana: @ref{25ef,,weekday()} e @ref{25f0,,isoweekday()}. A diferença é que um deles conta de 0 a 6 e o outro de 1 a 7. Em vez de tomar conta disso nós mesmos, podemos adicionar um método ao enum de @code{DiaDaSemana} para extrair o dia da instância de @ref{1cd,,date} e retornar o membro enum correspondente:

@example
@@classmethod
def from_date(cls, date):
    return cls(date.isoweekday())
@end example

A enum @code{DiaDaSemana} completa fica então assim:

@example
>>> class DiaDaSemana(Enum):
...     SEGUNDA = 1
...     TERÇA = 2
...     QUARTA = 3
...     QUINTA = 4
...     SEXTA = 5
...     SÁBADO = 6
...     DOMINGO = 7
...     #
...     @@classmethod
...     def from_date(cls, date):
...         return cls(date.isoweekday())
@end example

Agora podemos descobrir que dia é hoje! Observe:

@example
>>> from datetime import date
>>> Weekday.from_date(date.today())
<Weekday.TUESDAY: 2>
@end example

Claro, se você estiver lendo isso em outro dia da semana, você verá esse respectivo dia.

Essa enum @code{DiaDaSemana} é ótima se a nossa variável precisar somente de um único dia, mas e se precisarmos de vários? Talvez estejamos escrevendo uma função para organizar tarefas ao longo da semana, e não queremos usar uma @ref{611,,list} – poderíamos ao invés disso usar um tipo diferente de @ref{630,,Enum}:

@example
>>> from enum import Flag
>>> class DiaDaSemana(Flag):
...     SEGUNDA = 1
...     TERÇA = 2
...     QUARTA = 4
...     QUINTA = 8
...     SEXTA = 16
...     SÁBADO = 32
...     DOMINGO = 64
@end example

Nós mudamos duas coisas: estamos herdando de @ref{623,,Flag} (sinalizador), e os valores são todos potências de 2.

Assim como a enum @code{DiaDaSemana} original acima, podemos selecionar um item de cada vez:

@example
>>> primeiro_dia_útil = DiaDaSemana.SEGUNDA
>>> primeiro_dia_útil
<DiaDaSemana.SEGUNDA: 1>
@end example

Porém, a @ref{623,,Flag} também nos permite combinar vários membros em uma única variável:

@example
>>> fim_de_semana = DiaDaSemana.SÁBADO | DiaDaSemana.DOMINGO
>>> fim_de_semana
<DiaDaSemana.SÁBADO|DOMINGO: 96>
@end example

Você pode até mesmo iterar sobre uma variável @ref{623,,Flag}:

@example
>>> for dia in fim_de_semana:
...     print(dia)
DiaDaSemana.SÁBADO
DiaDaSemana.DOMINGO
@end example

Certo, vamos configurar algumas tarefas domésticas:

@example
>>> tarefas_do_joão = @{
...     'alimentar o gato': DiaDaSemana.SEGUNDA | DiaDaSemana.QUARTA | DiaDaSemana.SEXTA,
...     'lavar a louça': DiaDaSemana.TERÇA | DiaDaSemana.QUINTA,
...     'responder perguntas no SO': DiaDaSemana.SÁBADO,
...     @}
@end example

E a função para mostrar as tarefas domésticas para um determinado dia:

@example
>>> def mostrar_tarefas(tarefas, dia):
...     for tarefa, dias in tarefas.items():
...         if dia in dias:
...             print(tarefa)
...
>>> mostrar_tarefas(tarefas_do_joão, DiaDaSemana.SÁBADO)
responder perguntas no SO
@end example

Quando os valores em si dos membros não forem importantes, você pode economizar trabalho e usar @ref{cbc,,auto()} para eles:

@example
>>> from enum import auto
>>> class DiaDaSemana(Flag):
...     SEGUNDA = auto()
...     TERÇA = auto()
...     QUARTA = auto()
...     QUINTA = auto()
...     SEXTA = auto()
...     SÁBADO = auto()
...     DOMINGO = auto()
...     FIM_DE_SEMANA = SÁBADO | DOMINGO
@end example

@menu
* Acesso programático aos membros da enumeração e seus atributos.: Acesso programático aos membros da enumeração e seus atributos. 
* Membros e valores duplicados em enums:: 
* Garantindo valores únicos na enumeração:: 
* Usando valores automáticos:: 
* Iteração: Iteração<2>. 
* Comparações: Comparações<3>. 
* Membros e atributos permitidos em enumerações:: 
* Herança restrita de Enum:: 
* Suporte a dataclass:: 
* Pickling:: 
* API funcional: API funcional<3>. 
* Derived Enumerations:: 
* When to use __new__() vs. __init__(): When to use __new__ vs __init__. 
* How are Enums and Flags different?:: 
* Enum Cookbook:: 
* Subclassing EnumType:: 

@end menu

@node Acesso programático aos membros da enumeração e seus atributos,Membros e valores duplicados em enums,,Enum
@anchor{howto/enum enum-advanced-tutorial}@anchor{2757}@anchor{howto/enum programmatic-access-to-enumeration-members-and-their-attributes}@anchor{5347}
@subsection Acesso programático aos membros da enumeração e seus atributos.


Em alguns momentos, é util ter acesso aos membros na enumeração de forma programática (ou seja, em situações em que @code{Cor.RED} não é adequado porque a cor exata não é conhecida no momento da escrita do programa). Classes @code{Enum} permitem esse tipo de acesso:

@example
>>> Cor(1)
<Cor.RED: 1>
>>> Cor(3)
<Cor.BLUE: 3>
@end example

Se você deseja ter acesso aos membros do enum pelo `nome', use o acesso por itens:

@example
>>> Cor['VERMELHO']
<Cor.VERMELHO: 1>
>>> Color['VERDE']
<Cor.VERDE: 2>
@end example

Dado um membro de um enum, se você precisar do seu @code{name} ou @code{value}:

@example
>>> membro = Cor.VERMELHO
>>> membro.name
'VERMELHO'
>>> membro.value
1
@end example

@node Membros e valores duplicados em enums,Garantindo valores únicos na enumeração,Acesso programático aos membros da enumeração e seus atributos,Enum
@anchor{howto/enum duplicating-enum-members-and-values}@anchor{5348}
@subsection Membros e valores duplicados em enums


Ter dois membros de um enum com o mesmo nome é inválido:

@example
>>> class Forma(Enum):
...     QUADRADO = 2
...     QUADRADO = 3
...
Traceback (most recent call last):
...
TypeError: 'QUADRADO' already defined as 2
@end example

Porém, um membro do enum pode ter outros nomes associados a ele. Dados dois membros @code{A} e @code{B} com o mesmo valor (e @code{A} definido primeiro), @code{B} é um apelido para o membro @code{A}. A busca pelo membro associado ao valor de @code{A} retorna o membro @code{A}. A busca pelo membro com o nome de @code{A} retorna o membro @code{A}. A busca pelo membro com o nome de @code{B} também retorna o membro @code{A}:

@example
>>> class Forma(Enum):
...     QUADRADO = 2
...     DIAMANTE = 1
...     CÍRCULO = 3
...     APELIDO_PARA_O_QUADRADO = 2
...
>>> Forma.QUADRADO
<Forma.QUADRADO: 2>
>>> Forma.APELIDO_PARA_O_QUADRADO
<Forma.QUADRADO: 2>
>>> Forma(2)
<Forma.QUADRADO: 2>
@end example

@cartouche
@quotation Nota 
Tentar criar um membro com o mesmo nome de um atributo já definido (outro membro, um método, etc.) ou tentar criar um atributo com o mesmo nome de um membro não é permitido.
@end quotation
@end cartouche

@node Garantindo valores únicos na enumeração,Usando valores automáticos,Membros e valores duplicados em enums,Enum
@anchor{howto/enum ensuring-unique-enumeration-values}@anchor{5349}
@subsection Garantindo valores únicos na enumeração


Por padrão, enumerações permitem múltiplos nomes como apelidos para o mesmo valor. Quando esse comportamento não é desejado, você pode usar o decorador @ref{275c,,unique()}:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Errado(Enum):
...     UM = 1
...     DOIS = 2
...     TRES = 3
...     QUATRO = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Errado'>: QUATRO -> TRES
@end example

@node Usando valores automáticos,Iteração<2>,Garantindo valores únicos na enumeração,Enum
@anchor{howto/enum using-automatic-values}@anchor{534a}
@subsection Usando valores automáticos


Se o valor em si não é importante, você pode usar @ref{cbc,,auto}:

@example
>>> from enum import Enum, auto
>>> class Cor(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> [membro.value for membro in Cor]
[1, 2, 3]
@end example

Os valores são escolhidos pelo @ref{2770,,_generate_next_value_()}, que pode ser substituído:

@example
>>> class AutoName(Enum):
...     @@staticmethod
...     def _generate_next_value_(name, start, count, last_values):
...         return name
...
>>> class Ordinal(AutoName):
...     NORTE = auto()
...     SUL = auto()
...     LESTE = auto()
...     OESTE = auto()
...
>>> [membro.value for membro in Ordinal]
['NORTE', 'SUL', 'LESTE', 'OESTE']
@end example

@cartouche
@quotation Nota 
O método @ref{2770,,_generate_next_value_()} deve ser definido antes de qualquer membro.
@end quotation
@end cartouche

@node Iteração<2>,Comparações<3>,Usando valores automáticos,Enum
@anchor{howto/enum iteration}@anchor{534b}
@subsection Iteração


Iterar sobre os membros de um enum não fornece os apelidos:

@example
>>> list(Forma)
[<Forma.QUADRADO: 2>, <Forma.DIAMANTE: 1>, <Forma.CÍRCULO: 3>]
>>> list(DiaDaSemana)
[<DiaDaSemana.SEGUNDA: 1>, <DiaDaSemana.TERÇA: 2>, <DiaDaSemana.QUARTA: 4>, <DiaDaSemana.QUINTA: 8>, <DiaDaSemana.SEXTA: 16>, <DiaDaSemana.SÁBADO: 32>, <DiaDaSemana.DOMINGO: 64>]
@end example

Note que os apelidos @code{Forma.APELIDO_PARA_O_QUADRADO} e @code{DiaDaSemana.FIM_DE_SEMANA} não são mostrados.

O atributo especial @code{__members__} é um mapeamento ordenado de somente leitura dos nomes para os membros. Isso inclui todos os nomes definidos na enumeração, incluindo os apelidos:

@example
>>> for nome, membroin Forma.__members__.items():
...     nome, membro
...
('QUADRADO', <Forma.QUADRADO: 2>)
('DIAMANTE', <Forma.DIAMANTE: 1>)
('CÍRCULO', <Forma.CÍRCULO: 3>)
('APELIDO_PARA_O_QUADRADO', <Forma.QUADRADO: 2>)
@end example

O atributo @code{__members__} pode ser usado para um acesso programático detalhado aos membros da enumeração. Por exemplo, achar todos os apelidos:

@example
>>> [nome for nome, membro in Forma.__members__.items() if membro.name != nome]
['APELIDO_PARA_O_QUADRADO']
@end example

@cartouche
@quotation Nota 
Apelidos em sinalizadores incluem valores com múltiplos itens ao mesmo tempo, como @code{3}, e nenhum item definido, isto é, @code{0}.
@end quotation
@end cartouche

@node Comparações<3>,Membros e atributos permitidos em enumerações,Iteração<2>,Enum
@anchor{howto/enum comparisons}@anchor{534c}
@subsection Comparações


Membros de uma enumeração são comparados por identidade:

@example
>>> Color.VERMELHO is Color.VERMELHO
True
>>> Color.VERMELHO is Color.AZUL
False
>>> Color.VERMELHO is not Color.AZUL
True
@end example

Comparações ordenadas entre valores de enumerações `não' são suportadas. Membros Enum não são inteiros (porém, veja @ref{534d,,IntEnum} abaixo):

@example
>>> Color.VERMELHO < Color.AZUL
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'Color' and 'Color'
@end example

Entretanto, comparações de igualdade são definidas:

@example
>>> Color.AZUL == Color.VERMELHO
False
>>> Color.AZUL != Color.VERMELHO
True
>>> Color.AZUL == Color.AZUL
True
@end example

Comparações com valores que não sejam de enumeração sempre resultarão em “não igual” (novamente, @ref{d00,,IntEnum} foi explicitamente projetado para se comportar de maneira diferente, veja abaixo):

@example
>>> Color.AZUL == 2
False
@end example

@cartouche
@quotation Aviso 
É possivel recarregar módulos – se um módulo recarregado contém enums, eles serão recriados, e os novos membros não podem ser comparados de forma identifica/igual a membros originais.
@end quotation
@end cartouche

@node Membros e atributos permitidos em enumerações,Herança restrita de Enum,Comparações<3>,Enum
@anchor{howto/enum allowed-members-and-attributes-of-enumerations}@anchor{534e}
@subsection Membros e atributos permitidos em enumerações


A maioria dos exemplos acima usa inteiros como valores para os enums. Usar inteiros é simples e prático (isso é disponibilizado como padrão pela @ref{534f,,API funcional}), mas não é a única aplicação. Na grande maioria dos caso de uso, não importa o valor de fato que um enum possui. Mas se o valor `é' importante, enums podem ser valores arbitrários.

Enumerações são classes Python, e podem ter métodos e até mesmo métodos especiais como de usual. Se temos essa enumeração:

@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

Então:

@example
>>> Mood.favorite_mood()
<Mood.HAPPY: 3>
>>> Mood.HAPPY.describe()
('HAPPY', 3)
>>> str(Mood.FUNKY)
'my custom str! 1'
@end example

As regras para o que é permitido são: nomes que começam e terminam com underline único são reservados para enum e não podem ser usados; todos os outros atributos definidos dentro de uma enumeração irão se tornar membros dessa enumeração, com exceção dos métodos especiais ( @ref{61d,,__str__()}, @ref{2121,,__add__()}, etc.), descritores (métodos também são descritores), e nomes de variáveis listadas em @ref{276e,,_ignore_}.

Nota: se a sua enumeração define @ref{580,,__new__()} e/ou @ref{6b0,,__init__()}, qualquer valor(es) dado ao membro da enum será passado para esses métodos. Veja @ref{5350,,Planet}, por exemplo.

@cartouche
@quotation Nota 
O método @ref{580,,__new__()}, se definido, é usado durante a criação dos membros do Enum; em seguida, ele é substituído pelo @ref{580,,__new__()} do Enum, que é usado após a criação da classe para buscar por membros existentes. Consulte @ref{5351,,When to use __new__() vs. __init__()} para mais detalhes.
@end quotation
@end cartouche

@node Herança restrita de Enum,Suporte a dataclass,Membros e atributos permitidos em enumerações,Enum
@anchor{howto/enum restricted-enum-subclassing}@anchor{5352}
@subsection Herança restrita de Enum


Uma nova classe @ref{630,,Enum} deve ter uma classe enum base, até um tipo de dado concreto, e quantas classes mixin baseadas em @ref{a96,,object} forem necessárias. A ordem dessas classes base é:

@example
class EnumName([mix-in, ...,] [data-type,] base-enum):
    pass
@end example

Além disso, criar uma subclasse de uma enumeração é permitido apenas se a enumeração não define nenhum membro. Portanto is,so é proibido:

@example
>>> class MoreColor(Color):
...     PINK = 17
...
Traceback (most recent call last):
...
TypeError: <enum 'MoreColor'> cannot extend <enum 'Color'>
@end example

Mas isso é permitido:

@example
>>> class Foo(Enum):
...     def some_behavior(self):
...         pass
...
>>> class Bar(Foo):
...     HAPPY = 1
...     SAD = 2
...
@end example

Permitir a criação de subclasses de enums que definem membros levaria a violação de alguns invariantes importantes de tipos e instâncias. Por outro lado, faz sentido permitir o compartilhamento de algum comportamento comum entre um grupo de enumerações. (Veja @ref{5353,,OrderedEnum}, por exemplo.)

@node Suporte a dataclass,Pickling,Herança restrita de Enum,Enum
@anchor{howto/enum dataclass-support}@anchor{5354}@anchor{howto/enum enum-dataclass-support}@anchor{1881}
@subsection Suporte a dataclass


Ao herdar de uma @ref{1cb,,dataclass}, o @ref{1882,,__repr__()} omite o nome da classe herdada. Por exemplo:

@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 o argumento @code{repr=False} de @ref{1cb,,dataclass()} para utilizar o @ref{800,,repr()} padrão.


Alterado na versão 3.12: Somente os campos da dataclass são exibidos na área de valor, e não o nome da dataclass.


@cartouche
@quotation Nota 
Não há suporte a adicionar o decorador @ref{1cb,,dataclass()} a @ref{630,,Enum} e suas subclasses. Isso não irá levantar erros, mas poderá produzir resultados muito estranhos em tempo de execução, como membros sendo considerados iguais entre si.

@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 Pickling,API funcional<3>,Suporte a dataclass,Enum
@anchor{howto/enum pickling}@anchor{5355}
@subsection Pickling


Enumerações podem ser serializadas e desserializadas.

@example
>>> from test.test_enum import Fruit
>>> from pickle import dumps, loads
>>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
True
@end example

As restrições usuais para serialização se aplicam: enums serializáveis devem ser definidas no nível mais alto de um módulo, já que para fazer a desserialização eles devem ser importados daquele módulo.

@cartouche
@quotation Nota 
With pickle protocol version 4 it is possible to easily pickle enums
nested in other classes.
@end quotation
@end cartouche

It is possible to modify how enum members are pickled/unpickled by defining
@ref{16a1,,__reduce_ex__()} in the enumeration class.  The default method is by-value,
but enums with complicated values may want to use by-name:

@example
>>> import enum
>>> class MyEnum(enum.Enum):
...     __reduce_ex__ = enum.pickle_by_enum_name
@end example

@cartouche
@quotation Nota 
Using by-name for flags is not recommended, as unnamed aliases will
not unpickle.
@end quotation
@end cartouche

@node API funcional<3>,Derived Enumerations,Pickling,Enum
@anchor{howto/enum functional-api}@anchor{534f}
@subsection API funcional


A classe @ref{630,,Enum} é chamável, fornecendo a API funcional a seguir:

@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

The semantics of this API resemble @ref{1ca,,namedtuple}. The first
argument of the call to @ref{630,,Enum} is the name of the enumeration.

The second argument is the `source' of enumeration member names.  It can be a
whitespace-separated string of names, a sequence of names, a sequence of
2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to
values.  The last two options enable assigning arbitrary values to
enumerations; the others auto-assign increasing integers starting with 1 (use
the @code{start} parameter to specify a different starting value).  A
new class derived from @ref{630,,Enum} is returned.  In other words, the above
assignment to @code{Animal} is equivalent to:

@example
>>> class Animal(Enum):
...     ANT = 1
...     BEE = 2
...     CAT = 3
...     DOG = 4
...
@end example

The reason for defaulting to @code{1} as the starting number and not @code{0} is
that @code{0} is @code{False} in a boolean sense, but by default enum members all
evaluate to @code{True}.

Pickling enums created with the functional API can be tricky as frame stack
implementation details are used to try and figure out which module the
enumeration is being created in (e.g. it will fail if you use a utility
function in a separate module, and also may not work on IronPython or Jython).
The solution is to specify the module name explicitly as follows:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)
@end example

@cartouche
@quotation Aviso 
If @code{module} is not supplied, and Enum cannot determine what it is,
the new Enum members will not be unpicklable; to keep errors closer to
the source, pickling will be disabled.
@end quotation
@end cartouche

The new pickle protocol 4 also, in some circumstances, relies on
@ref{20b6,,__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

A assinatura completa é:

@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

or an iterator of names:

@example
['VERMELHO', 'VERDE', 'AZUL']
@end example

or an iterator of (name, value) pairs:

@example
[('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]
@end example

or a mapping:

@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


Alterado na versão 3.5: The `start' parameter was added.


@node Derived Enumerations,When to use __new__ vs __init__,API funcional<3>,Enum
@anchor{howto/enum derived-enumerations}@anchor{5356}
@subsection Derived Enumerations


@menu
* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Sinalizador:: 
* Outros: Outros<2>. 

@end menu

@node IntEnum,StrEnum,,Derived Enumerations
@anchor{howto/enum intenum}@anchor{534d}
@subsubsection IntEnum


The first variation of @ref{630,,Enum} that is provided is also a subclass of
@ref{257,,int}.  Members of an @ref{d00,,IntEnum} can be compared to integers;
by extension, integer enumerations of different types can also be compared
to each other:

@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

However, they still can’t be compared to standard @ref{630,,Enum} enumerations:

@example
>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...
>>> Shape.CIRCLE == Color.RED
False
@end example

@ref{d00,,IntEnum} values behave like integers in other ways you’d expect:

@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,Derived Enumerations
@anchor{howto/enum strenum}@anchor{5357}
@subsubsection StrEnum


The second variation of @ref{630,,Enum} that is provided is also a subclass of
@ref{44c,,str}.  Members of a @ref{61a,,StrEnum} can be compared to strings;
by extension, string enumerations of different types can also be compared
to each other.


Adicionado na versão 3.11.


@node IntFlag,Sinalizador,StrEnum,Derived Enumerations
@anchor{howto/enum intflag}@anchor{5358}
@subsubsection IntFlag


The next variation of @ref{630,,Enum} provided, @ref{cbb,,IntFlag}, is also based
on @ref{257,,int}.  The difference being @ref{cbb,,IntFlag} members can be combined
using the bitwise operators (&, |, ^, ~) and the result is still an
@ref{cbb,,IntFlag} member, if possible.  Like @ref{d00,,IntEnum}, @ref{cbb,,IntFlag}
members are also integers and can be used wherever an @ref{257,,int} is used.

@cartouche
@quotation Nota 
Any operation on an @ref{cbb,,IntFlag} member besides the bit-wise operations will
lose the @ref{cbb,,IntFlag} membership.

Bit-wise operations that result in invalid @ref{cbb,,IntFlag} values will lose the
@ref{cbb,,IntFlag} membership.  See @ref{624,,FlagBoundary} for
details.
@end quotation
@end cartouche


Adicionado na versão 3.6.



Alterado na versão 3.11.


Sample @ref{cbb,,IntFlag} class:

@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

It is also possible to name the combinations:

@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 
Combinações nomeadas são consideradas apelidos. Apelidos não aparecem durante uma iteração, mas podem ser retornados por pesquisas por valor.
@end quotation
@end cartouche


Alterado na versão 3.11.


Another important difference between @ref{cbb,,IntFlag} and @ref{630,,Enum} is that
if no flags are set (the value is 0), its boolean evaluation is @ref{b49,,False}:

@example
>>> Perm.R & Perm.X
<Perm: 0>
>>> bool(Perm.R & Perm.X)
False
@end example

Because @ref{cbb,,IntFlag} members are also subclasses of @ref{257,,int} they can
be combined with them (but may lose @ref{cbb,,IntFlag} membership:

@example
>>> Perm.X | 4
<Perm.R|X: 5>

>>> Perm.X + 8
9
@end example

@cartouche
@quotation Nota 
The negation operator, @code{~}, always returns an @ref{cbb,,IntFlag} member with a
positive value:

@example
>>> (~Perm.X).value == (Perm.R|Perm.W).value == 6
True
@end example
@end quotation
@end cartouche

@ref{cbb,,IntFlag} members can also be iterated over:

@example
>>> list(RW)
[<Perm.R: 4>, <Perm.W: 2>]
@end example


Adicionado na versão 3.11.


@node Sinalizador,Outros<2>,IntFlag,Derived Enumerations
@anchor{howto/enum flag}@anchor{5359}
@subsubsection Sinalizador


The last variation is @ref{623,,Flag}.  Like @ref{cbb,,IntFlag}, @ref{623,,Flag}
members can be combined using the bitwise operators (&, |, ^, ~).  Unlike
@ref{cbb,,IntFlag}, they cannot be combined with, nor compared against, any
other @ref{623,,Flag} enumeration, nor @ref{257,,int}.  While it is possible to
specify the values directly it is recommended to use @ref{cbc,,auto} as the
value and let @ref{623,,Flag} select an appropriate value.


Adicionado na versão 3.6.


Like @ref{cbb,,IntFlag}, if a combination of @ref{623,,Flag} members results in no
flags being set, the boolean evaluation is @ref{b49,,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

Individual flags should have values that are powers of two (1, 2, 4, 8, …),
while combinations of flags will not:

@example
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...     WHITE = RED | BLUE | GREEN
...
>>> Color.WHITE
<Color.WHITE: 7>
@end example

Giving a name to the “no flags set” condition does not change its boolean
value:

@example
>>> class Color(Flag):
...     BLACK = 0
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.BLACK
<Color.BLACK: 0>
>>> bool(Color.BLACK)
False
@end example

@ref{623,,Flag} members can also be iterated over:

@example
>>> purple = Color.RED | Color.BLUE
>>> list(purple)
[<Color.RED: 1>, <Color.BLUE: 2>]
@end example


Adicionado na versão 3.11.


@cartouche
@quotation Nota 
For the majority of new code, @ref{630,,Enum} and @ref{623,,Flag} are strongly
recommended, since @ref{d00,,IntEnum} and @ref{cbb,,IntFlag} break some
semantic promises of an enumeration (by being comparable to integers, and
thus by transitivity to other unrelated enumerations).  @ref{d00,,IntEnum}
and @ref{cbb,,IntFlag} should be used only in cases where @ref{630,,Enum} and
@ref{623,,Flag} will not do; for example, when integer constants are replaced
with enumerations, or for interoperability with other systems.
@end quotation
@end cartouche

@node Outros<2>,,Sinalizador,Derived Enumerations
@anchor{howto/enum others}@anchor{535a}
@subsubsection Outros


While @ref{d00,,IntEnum} is part of the @ref{56,,enum} module, it would be very
simple to implement independently:

@example
class IntEnum(int, ReprEnum):   # or Enum instead of ReprEnum
    pass
@end example

This demonstrates how similar derived enumerations can be defined; for example
a @code{FloatEnum} that mixes in @ref{2f7,,float} instead of @ref{257,,int}.

Algumas regras:


@enumerate 

@item 
When subclassing @ref{630,,Enum}, mix-in types must appear before the
@ref{630,,Enum} class itself in the sequence of bases, as in the @ref{d00,,IntEnum}
example above.

@item 
Mix-in types must be subclassable. For example, @ref{468,,bool} and
@ref{94a,,range} are not subclassable and will throw an error during Enum
creation if used as the mix-in type.

@item 
While @ref{630,,Enum} can have members of any type, once you mix in an
additional type, all the members must have values of that type, e.g.
@ref{257,,int} above.  This restriction does not apply to mix-ins which only
add methods and don’t specify another type.

@item 
When another data type is mixed in, the @ref{2769,,value} attribute is `not the
same' as the enum member itself, although it is equivalent and will compare
equal.

@item 
A @code{data type} is a mixin that defines @ref{580,,__new__()}, or a
@ref{1cb,,dataclass}

@item 
%-style formatting:  @code{%s} and @code{%r} call the @ref{630,,Enum} class’s
@ref{61d,,__str__()} and @ref{61c,,__repr__()} respectively; other codes (such as
@code{%i} or @code{%h} for IntEnum) treat the enum member as its mixed-in type.

@item 
@ref{9b1,,Formatted string literals}, @ref{621,,str.format()},
and @ref{61f,,format()} will use the enum’s @ref{61d,,__str__()} method.
@end enumerate

@cartouche
@quotation Nota 
Because @ref{d00,,IntEnum}, @ref{cbb,,IntFlag}, and @ref{61a,,StrEnum} are
designed to be drop-in replacements for existing constants, their
@ref{61d,,__str__()} method has been reset to their data types’
@ref{61d,,__str__()} method.
@end quotation
@end cartouche

@node When to use __new__ vs __init__,How are Enums and Flags different?,Derived Enumerations,Enum
@anchor{howto/enum new-vs-init}@anchor{5351}@anchor{howto/enum when-to-use-new-vs-init}@anchor{535b}
@subsection When to use @code{__new__()} vs. @code{__init__()}


@ref{580,,__new__()} must be used whenever you want to customize the actual value of
the @ref{630,,Enum} member.  Any other modifications may go in either
@ref{580,,__new__()} or @ref{6b0,,__init__()}, with @ref{6b0,,__init__()} being preferred.

For example, if you want to pass several items to the constructor, but only
want one of them to be the value:

@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 Aviso 
`Do not' call @code{super().__new__()}, as the lookup-only @code{__new__} is the one
that is found; instead, use the data type directly.
@end quotation
@end cartouche

@menu
* Finer Points:: 

@end menu

@node Finer Points,,,When to use __new__ vs __init__
@anchor{howto/enum finer-points}@anchor{535c}
@subsubsection Finer Points


@menu
* Nomes __dunder__ suportados: Nomes __dunder__ suportados<2>. 
* Nomes _sunder_ suportados: Nomes _sunder_ suportados<2>. 
* _Private__names:: 
* Enum member type:: 
* Creating members that are mixed with other data types:: 
* Boolean value of Enum classes and members:: 
* Enum classes with methods:: 
* Combining members of Flag:: 
* Flag and IntFlag minutia:: 

@end menu

@node Nomes __dunder__ suportados<2>,Nomes _sunder_ suportados<2>,,Finer Points
@anchor{howto/enum supported-dunder-names}@anchor{535d}
@subsubsection Nomes @code{__dunder__} suportados


@ref{2766,,__members__} is a read-only ordered mapping of @code{member_name}:@code{member}
items.  It is only available on the class.

@ref{580,,__new__()}, if specified, must create and return the enum members; it is
also a very good idea to set the member’s @ref{276c,,_value_} appropriately.  Once
all the members are created it is no longer used.

@node Nomes _sunder_ suportados<2>,_Private__names,Nomes __dunder__ suportados<2>,Finer Points
@anchor{howto/enum supported-sunder-names}@anchor{535e}
@subsubsection Nomes @code{_sunder_} suportados



@itemize -

@item 
@ref{276b,,_name_} – name of the member

@item 
@ref{276c,,_value_} – value of the member; can be set in @code{__new__}

@item 
@ref{2773,,_missing_()} – a lookup function used when a value is not found;
may be overridden

@item 
@ref{276e,,_ignore_} – a list of names, either as a @ref{611,,list} or a
@ref{44c,,str}, that will not be transformed into members, and will be removed
from the final class

@item 
@ref{2770,,_generate_next_value_()} – used to get an appropriate value for
an enum member; may be overridden

@item 
@ref{2774,,_add_alias_()} – adds a new name as an alias to an existing
member.

@item 
@ref{2775,,_add_value_alias_()} – adds a new value as an alias to an
existing member.  See @ref{535f,,MultiValueEnum} for an example.

@cartouche
@quotation Nota 
For standard @ref{630,,Enum} classes the next value chosen is the highest
value seen incremented by one.

For @ref{623,,Flag} classes the next value chosen will be the next highest
power-of-two.
@end quotation
@end cartouche


Alterado na versão 3.13: Versões anteriores usariam o último valor visualizado em vez do maior valor.

@end itemize


Adicionado na versão 3.6: @code{_missing_}, @code{_order_}, @code{_generate_next_value_}



Adicionado na versão 3.7: @code{_ignore_}



Adicionado na versão 3.13: @code{_add_alias_}, @code{_add_value_alias_}


To help keep Python 2 / Python 3 code in sync an @ref{276d,,_order_} attribute can
be provided.  It will be checked against the actual order of the enumeration
and raise an error if the two do not match:

@example
>>> class Color(Enum):
...     _order_ = 'VERMELHO VERDE AZUL'
...     VERMELHO = 1
...     AZUL = 3
...     VERDE = 2
...
Traceback (most recent call last):
...
TypeError: member order does not match _order_:
  ['VERMELHO', 'AZUL', 'VERDE']
  ['VERMELHO', 'VERDE', 'AZUL']
@end example

@cartouche
@quotation Nota 
In Python 2 code the @ref{276d,,_order_} attribute is necessary as definition
order is lost before it can be recorded.
@end quotation
@end cartouche

@node _Private__names,Enum member type,Nomes _sunder_ suportados<2>,Finer Points
@anchor{howto/enum private-names}@anchor{5360}
@subsubsection _Private__names


@ref{1e43,,Private names} are not converted to enum members,
but remain normal attributes.


Alterado na versão 3.11.


@node Enum member type,Creating members that are mixed with other data types,_Private__names,Finer Points
@anchor{howto/enum enum-member-type}@anchor{5361}
@subsubsection @code{Enum} member type


Enum members are instances of their enum class, and are normally accessed as
@code{EnumClass.member}.  In certain situations, such as writing custom enum
behavior, being able to access one member directly from another is useful,
and is supported; however, in order to avoid name clashes between member names
and attributes/methods from mixed-in classes, upper-case names are strongly
recommended.


Alterado na versão 3.5.


@node Creating members that are mixed with other data types,Boolean value of Enum classes and members,Enum member type,Finer Points
@anchor{howto/enum creating-members-that-are-mixed-with-other-data-types}@anchor{5362}
@subsubsection Creating members that are mixed with other data types


When subclassing other data types, such as @ref{257,,int} or @ref{44c,,str}, with
an @ref{630,,Enum}, all values after the @code{=} are passed to that data type’s
constructor.  For example:

@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 Boolean value of Enum classes and members,Enum classes with methods,Creating members that are mixed with other data types,Finer Points
@anchor{howto/enum boolean-value-of-enum-classes-and-members}@anchor{5363}
@subsubsection Boolean value of @code{Enum} classes and members


Enum classes that are mixed with non-@ref{630,,Enum} types (such as
@ref{257,,int}, @ref{44c,,str}, etc.) are evaluated according to the mixed-in
type’s rules; otherwise, all members evaluate as @ref{c27,,True}.  To make your
own enum’s boolean evaluation depend on the member’s value add the following to
your class:

@example
def __bool__(self):
    return bool(self.value)
@end example

Plain @ref{630,,Enum} classes always evaluate as @ref{c27,,True}.

@node Enum classes with methods,Combining members of Flag,Boolean value of Enum classes and members,Finer Points
@anchor{howto/enum enum-classes-with-methods}@anchor{5364}
@subsubsection @code{Enum} classes with methods


If you give your enum subclass extra methods, like the @ref{5350,,Planet}
class below, those methods will show up in a @ref{632,,dir()} of the member,
but not of the class:

@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 Combining members of Flag,Flag and IntFlag minutia,Enum classes with methods,Finer Points
@anchor{howto/enum combining-members-of-flag}@anchor{5365}
@subsubsection Combining members of @code{Flag}


Iterating over a combination of @ref{623,,Flag} members will only return the members that
are comprised of a single 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 Flag and IntFlag minutia,,Combining members of Flag,Finer Points
@anchor{howto/enum flag-and-intflag-minutia}@anchor{5366}
@subsubsection @code{Flag} and @code{IntFlag} minutia


Using the following snippet for our examples:

@example
>>> class Color(IntFlag):
...     BLACK = 0
...     RED = 1
...     GREEN = 2
...     BLUE = 4
...     PURPLE = RED | BLUE
...     WHITE = RED | GREEN | BLUE
...
@end example

the following are true:


@itemize -

@item 
single-bit flags are canonical

@item 
multi-bit and zero-bit flags are aliases

@item 
only canonical flags are returned during iteration:

@example
>>> list(Color.WHITE)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

@item 
negating a flag or flag set returns a new flag/flag set with the
corresponding positive integer value:

@example
>>> Color.BLUE
<Color.BLUE: 4>

>>> ~Color.BLUE
<Color.RED|GREEN: 3>
@end example

@item 
names of pseudo-flags are constructed from their members’ names:

@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 
multi-bit flags, aka aliases, can be returned from operations:

@example
>>> Color.RED | Color.BLUE
<Color.PURPLE: 5>

>>> Color(7)  # or Color(-1)
<Color.WHITE: 7>

>>> Color(0)
<Color.BLACK: 0>
@end example

@item 
membership / containment checking: zero-valued flags are always considered
to be contained:

@example
>>> Color.BLACK in Color.WHITE
True
@end example

otherwise, only if all bits of one flag are in the other flag will True
be returned:

@example
>>> Color.PURPLE in Color.WHITE
True

>>> Color.GREEN in Color.PURPLE
False
@end example
@end itemize

There is a new boundary mechanism that controls how out-of-range / invalid
bits are handled: @code{STRICT}, @code{CONFORM}, @code{EJECT}, and @code{KEEP}:


@itemize *

@item 
STRICT –> raises an exception when presented with invalid values

@item 
CONFORM –> discards any invalid bits

@item 
EJECT –> lose Flag status and become a normal int with the given value

@item 
KEEP –> keep the extra bits


@itemize -

@item 
keeps Flag status and extra bits

@item 
extra bits do not show up in iteration

@item 
extra bits do show up in repr() and str()
@end itemize
@end itemize

The default for Flag is @code{STRICT}, the default for @code{IntFlag} is @code{EJECT},
and the default for @code{_convert_} is @code{KEEP} (see @code{ssl.Options} for an
example of when @code{KEEP} is needed).

@node How are Enums and Flags different?,Enum Cookbook,When to use __new__ vs __init__,Enum
@anchor{howto/enum enum-class-differences}@anchor{2759}@anchor{howto/enum how-are-enums-and-flags-different}@anchor{5367}
@subsection How are Enums and Flags different?


Enums have a custom metaclass that affects many aspects of both derived @ref{630,,Enum}
classes and their instances (members).

@menu
* Enum Classes:: 
* Flag Classes:: 
* Enum Members (aka instances): Enum Members aka instances. 
* Flag Members:: 

@end menu

@node Enum Classes,Flag Classes,,How are Enums and Flags different?
@anchor{howto/enum enum-classes}@anchor{5368}
@subsubsection Enum Classes


The @ref{1e5,,EnumType} metaclass is responsible for providing the
@ref{1400,,__contains__()}, @ref{15fe,,__dir__()}, @ref{c8a,,__iter__()} and other methods that
allow one to do things with an @ref{630,,Enum} class that fail on a typical
class, such as @code{list(Color)} or @code{some_enum_var in Color}.  @ref{1e5,,EnumType} is
responsible for ensuring that various other methods on the final @ref{630,,Enum}
class are correct (such as @ref{580,,__new__()}, @ref{dfe,,__getnewargs__()},
@ref{61d,,__str__()} and @ref{61c,,__repr__()}).

@node Flag Classes,Enum Members aka instances,Enum Classes,How are Enums and Flags different?
@anchor{howto/enum flag-classes}@anchor{5369}
@subsubsection Flag Classes


Flags have an expanded view of aliasing: to be canonical, the value of a flag
needs to be a power-of-two value, and not a duplicate name.  So, in addition to the
@ref{630,,Enum} definition of alias, a flag with no value (a.k.a. @code{0}) or with more than one
power-of-two value (e.g. @code{3}) is considered an alias.

@node Enum Members aka instances,Flag Members,Flag Classes,How are Enums and Flags different?
@anchor{howto/enum enum-members-aka-instances}@anchor{536a}
@subsubsection Enum Members (aka instances)


The most interesting thing about enum members is that they are singletons.
@ref{1e5,,EnumType} creates them all while it is creating the enum class itself,
and then puts a custom @ref{580,,__new__()} in place to ensure that no new ones are
ever instantiated by returning only the existing member instances.

@node Flag Members,,Enum Members aka instances,How are Enums and Flags different?
@anchor{howto/enum flag-members}@anchor{536b}
@subsubsection Flag Members


Flag members can be iterated over just like the @ref{623,,Flag} class, and only the
canonical members will be returned.  For example:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

(Note that @code{BLACK}, @code{PURPLE}, and @code{WHITE} do not show up.)

Inverting a flag member returns the corresponding positive value,
rather than a negative value — for example:

@example
>>> ~Color.RED
<Color.GREEN|BLUE: 6>
@end example

Flag members have a length corresponding to the number of power-of-two values
they contain.  For example:

@example
>>> len(Color.PURPLE)
2
@end example

@node Enum Cookbook,Subclassing EnumType,How are Enums and Flags different?,Enum
@anchor{howto/enum enum-cookbook}@anchor{2758}@anchor{howto/enum id2}@anchor{536c}
@subsection Enum Cookbook


While @ref{630,,Enum}, @ref{d00,,IntEnum}, @ref{61a,,StrEnum}, @ref{623,,Flag}, and
@ref{cbb,,IntFlag} are expected to cover the majority of use-cases, they cannot
cover them all.  Here are recipes for some different types of enumerations
that can be used directly, or as examples for creating one’s own.

@menu
* Omitting values:: 
* OrderedEnum:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planet:: 
* TimePeriod:: 

@end menu

@node Omitting values,OrderedEnum,,Enum Cookbook
@anchor{howto/enum omitting-values}@anchor{536d}
@subsubsection Omitting values


In many use-cases, one doesn’t care what the actual value of an enumeration
is. There are several ways to define this type of simple enumeration:


@itemize -

@item 
use instances of @ref{cbc,,auto} for the value

@item 
use instances of @ref{a96,,object} as the value

@item 
use a descriptive string as the value

@item 
use a tuple as the value and a custom @ref{580,,__new__()} to replace the
tuple with an @ref{257,,int} value
@end itemize

Using any of these methods signifies to the user that these values are not
important, and also enables one to add, remove, or reorder members without
having to renumber the remaining members.

@menu
* Using auto:: 
* Using object:: 
* Using a descriptive string:: 
* Using a custom __new__(): Using a custom __new__. 

@end menu

@node Using auto,Using object,,Omitting values
@anchor{howto/enum using-auto}@anchor{536e}
@subsubsection Using @code{auto}


Using @ref{cbc,,auto} would look like:

@example
>>> class Color(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.GREEN
<Color.GREEN: 3>
@end example

@node Using object,Using a descriptive string,Using auto,Omitting values
@anchor{howto/enum using-object}@anchor{536f}
@subsubsection Using @code{object}


Using @ref{a96,,object} would look like:

@example
>>> class Color(Enum):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...
>>> Color.GREEN
<Color.GREEN: <object object at 0x...>>
@end example

This is also a good example of why you might want to write your own
@ref{61c,,__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 Using a descriptive string,Using a custom __new__,Using object,Omitting values
@anchor{howto/enum using-a-descriptive-string}@anchor{5370}
@subsubsection Using a descriptive string


Using a string as the value would look like:

@example
>>> class Color(Enum):
...     RED = 'stop'
...     GREEN = 'go'
...     BLUE = 'too fast!'
...
>>> Color.GREEN
<Color.GREEN: 'go'>
@end example

@node Using a custom __new__,,Using a descriptive string,Omitting values
@anchor{howto/enum using-a-custom-new}@anchor{5371}
@subsubsection Using a custom @code{__new__()}


Using an auto-numbering @ref{580,,__new__()} would look like:

@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

To make a more general purpose @code{AutoNumber}, add @code{*args} to the signature:

@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

Then when you inherit from @code{AutoNumber} you can write your own @code{__init__}
to handle any extra arguments:

@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 
The @ref{580,,__new__()} method, if defined, is used during creation of the Enum
members; it is then replaced by Enum’s @ref{580,,__new__()} which is used after
class creation for lookup of existing members.
@end quotation
@end cartouche

@cartouche
@quotation Aviso 
`Do not' call @code{super().__new__()}, as the lookup-only @code{__new__} is the one
that is found; instead, use the data type directly – e.g.:

@example
obj = int.__new__(cls, value)
@end example
@end quotation
@end cartouche

@node OrderedEnum,DuplicateFreeEnum,Omitting values,Enum Cookbook
@anchor{howto/enum orderedenum}@anchor{5353}
@subsubsection OrderedEnum


An ordered enumeration that is not based on @ref{d00,,IntEnum} and so maintains
the normal @ref{630,,Enum} invariants (such as not being comparable to other
enumerations):

@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,OrderedEnum,Enum Cookbook
@anchor{howto/enum duplicatefreeenum}@anchor{5372}
@subsubsection DuplicateFreeEnum


Raises an error if a duplicate member value is found instead of creating an
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 
This is a useful example for subclassing Enum to add or change other
behaviors as well as disallowing aliases.  If the only desired change is
disallowing aliases, the @ref{275c,,unique()} decorator can be used instead.
@end quotation
@end cartouche

@node MultiValueEnum,Planet,DuplicateFreeEnum,Enum Cookbook
@anchor{howto/enum multivalueenum}@anchor{535f}
@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 Planet,TimePeriod,MultiValueEnum,Enum Cookbook
@anchor{howto/enum planet}@anchor{5350}
@subsubsection Planet


If @ref{580,,__new__()} or @ref{6b0,,__init__()} is defined, the value of the enum member
will be passed to those methods:

@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 TimePeriod,,Planet,Enum Cookbook
@anchor{howto/enum enum-time-period}@anchor{276f}@anchor{howto/enum timeperiod}@anchor{5373}
@subsubsection TimePeriod


An example to show the @ref{276e,,_ignore_} attribute in use:

@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 Subclassing EnumType,,Enum Cookbook,Enum
@anchor{howto/enum enumtype-examples}@anchor{275f}@anchor{howto/enum subclassing-enumtype}@anchor{5374}
@subsection Subclassing EnumType


While most enum needs can be met by customizing @ref{630,,Enum} subclasses,
either with class decorators or custom functions, @ref{1e5,,EnumType} can be
subclassed to provide a different Enum experience.

@node Programação Funcional,Logging,Enum,Python HOWTOs
@anchor{howto/functional doc}@anchor{5375}@anchor{howto/functional functional-howto}@anchor{5376}@anchor{howto/functional functional-programming-howto}@anchor{5377}@anchor{howto/functional translation-repo}@anchor{5378}
@section Programação Funcional


@*Autor: 
A. M. Kuchling


@*Versão: 
0.32


Nesse documento, nós vamos passear pelos recursos do Python que servem para implementar programas de forma funcional. Após uma introdução dos conceitos da programação funcional, nós veremos as propriedades da linguagem como @ref{1ac,,iteradores} e @ref{109a,,geradores} e bibliotecas de módulos relevantes como um @ref{81,,itertools} e @ref{5f,,functools}.

@menu
* Introdução: Introdução<15>. 
* Iteradores: Iteradores<2>. 
* Expressões do gerador e compreensões de lista:: 
* Geradores: Geradores<2>. 
* Funções embutidas: Funções embutidas<4>. 
* O módulo itertools:: 
* O módulo functools:: 
* Pequenas funções e as expressões lambda:: 
* Histórico de Revisão e Reconhecimentos:: 
* Referências: Referências<2>. 

@end menu

@node Introdução<15>,Iteradores<2>,,Programação Funcional
@anchor{howto/functional introduction}@anchor{5379}
@subsection Introdução


Essa seção explica o conceito básico da programação funcional; se você está interessado em aprender sobre os recursos da linguagem Python, pule essa etapa para a seção @ref{537a,,Iteradores}.

As linguagens de programação permitem decompor problemas de diversas maneiras diferentes:


@itemize *

@item 
A Maioria das linguagens de programação são `procedurais': os programas são listas de instruções que dizem ao computador o que fazer com as entradas do programa. C, Pascal, e mesmo o Unix shells são linguagens procedurais.

@item 
Em linguagens `declarativas', você escreve uma especificação que descreve o problema a ser resolvido, e a implementação do idioma descreve como executar a computação de forma eficiente. O SQL é o idioma declarativo com o qual provavelmente você está familiarizado; Uma consulta SQL descreve o conjunto de dados que deseja recuperar e o mecanismo SQL decide se deseja escanear tabelas ou usar índices, quais subcláusulas devem ser realizadas primeiro, etc.

@item 
Os programas `orientados a objetos' manipulam coleções de objetos. Os objetos têm estado interno e métodos de suporte que consultam ou modificam esse estado interno de alguma forma. Smalltalk e Java são linguagens orientadas a objetos. C++ e Python são idiomas que suportam programação orientada a objetos, mas não forçam o uso de recursos de orientação a objetos.

@item 
A programação `funcional' decompõe um problema em um conjunto de funções. Idealmente, as funções apenas recebem entradas e produzem saídas, e não têm nenhum estado interno que afete a saída produzida para uma determinada entrada. Linguagens funcionais bem conhecidos incluem a família ML (Standard ML, OCaml e outras variantes) e Haskell.
@end itemize

Os designers de algumas linguagens de computadores escolhem enfatizar uma abordagem particular da programação. Isso muitas vezes torna difícil escrever programas que usam uma abordagem diferente. Outros idiomas são linguagens com multiparadigmas que suportam várias abordagens diferentes. Lisp, C++ e Python são multiparadigmas; Você pode escrever programas ou bibliotecas que são em grande parte processuais, orientadas a objetos ou funcionais em todos esses idiomas. Em um grande programa, diferentes seções podem ser escritas usando diferentes abordagens; A GUI pode ser orientada a objetos enquanto a lógica de processamento é processual ou funcional, por exemplo.

Em um programa funcional, a entrada flui através de um conjunto de funções. Cada função opera em sua entrada e produz alguma saída. O estilo funcional desencoraja funções com efeitos colaterais que modificam o estado interno ou fazem outras alterações que não são visíveis no valor de retorno da função. As funções que não têm efeitos colaterais são chamadas `puramente funcionais'. Evitar efeitos colaterais significa não usar estruturas de dados que sejam atualizadas à medida que um programa é executado; A saída de cada função só deve depender da sua entrada.

Algumas linguagens são muito estritas a respeito da pureza e não tem nem instruções de atribuição como, por exemplo, @code{a=3} ou @code{c = a + b}, mas é difícil evitar todos os efeitos colaterais, como exibir valores na tela ou escrever em um arquivo em disco. Um outro exemplo é a chamada da função @ref{fa9,,print()} ou da função @ref{69d,,time.sleep()}, nenhuma das quais retorna um valor útil. Ambas são chamadas apenas por conta do efeito colateral de mandar algum texto para a tela ou pausar a execução por um segundo.

Os programas Python escritos em estilo funcional geralmente não irão ao extremo de evitar todas as I/O ou todas as atribuições; Em vez disso, eles fornecerão uma interface de aparência funcional, mas usarão recursos não funcionais internamente. Por exemplo, a implementação de uma função ainda usará atribuições para variáveis locais, mas não modificará variáveis globais ou terá outros efeitos colaterais.

A programação funcional pode ser considerada o oposto da programação orientada a objetos. Os objetos são pequenas cápsulas contendo algum estado interno, juntamente com uma coleção de chamadas de método que permitem modificar este estado, e os programas consistem em fazer o conjunto correto de mudanças de estado. A programação funcional quer evitar as mudanças de estado tanto quanto possível e funciona com o fluxo de dados entre as funções. Em Python você pode combinar as duas abordagens escrevendo funções que levam e retornam instâncias que representam objetos em seu aplicativo (mensagens de e-mail, transações, etc.).

O design funcional pode parecer uma restrição estranha para trabalhar por baixo. Por que você deve evitar objetos e efeitos colaterais? Existem vantagens teóricas e práticas para o estilo funcional:


@itemize *

@item 
Probabilidade formal.

@item 
Modularidade.

@item 
Componibilidade.

@item 
Fácil de depurar e testar.
@end itemize

@menu
* Probabilidade formal:: 
* Modularidade:: 
* Fácil de depurar e testar:: 
* Componibilidade:: 

@end menu

@node Probabilidade formal,Modularidade,,Introdução<15>
@anchor{howto/functional formal-provability}@anchor{537b}
@subsubsection Probabilidade formal


Um benefício teórico é que é mais fácil construir uma prova matemática de que um programa funcional é correto.

Durante muito tempo os pesquisadores estiveram interessados em encontrar maneiras de provar matematicamente programas corretos. Isso é diferente de testar um programa em inúmeras entradas e concluir que sua saída geralmente é correta, ou ler o código-fonte de um programa e concluir que o código parece certo; O objetivo é uma prova rigorosa de que um programa produz o resultado certo para todas as entradas possíveis.

A técnica usada para comprovar os programas corretos é escrever `invariantes', propriedades dos dados de entrada e das variáveis do programa que são sempre verdadeiras. Para cada linha de código, você mostra que se os invariantes X e Y forem verdadeiros `antes' da linha ser executada, os invariantes X’ e Y’ ligeiramente diferentes são verdadeiros `após' a linha ser executada. Isso continua até chegar ao final do programa, em que ponto as invariantes devem corresponder às condições desejadas na saída do programa.

A evitação das tarefas funcionais ocorreu porque as tarefas são difíceis de tratar com esta técnica; As atribuições podem invadir invariantes que eram verdadeiras antes da atribuição sem produzir novos invariantes que possam ser propagados para a frente.

Infelizmente, prpvar que os programas estão corretos são praticamente impraticáveis e não relevantes para o software Python. Mesmo os programas triviais exigem provas de várias páginas; A prova de correção para um programa moderadamente complicado seria enorme, e poucos ou nenhum dos programas que você usa diariamente (o interpretador Python, seu analisador XML, seu navegador) poderia ser comprovado correto. Mesmo que você tenha anotado ou gerado uma prova, então haveria a questão de verificar a prova; Talvez haja um erro nisso, e você acredita erroneamente que você provou o programa corretamente.

@node Modularidade,Fácil de depurar e testar,Probabilidade formal,Introdução<15>
@anchor{howto/functional modularity}@anchor{537c}
@subsubsection Modularidade


Um benefício mais prático da programação funcional é que isso força você a quebrar seu problema em pequenos pedaços. Os programas são mais modulares como resultado. É mais fácil especificar e escrever uma pequena função que faz uma coisa do que uma grande função que realiza uma transformação complicada. Pequenas funções também são mais fáceis de ler e verificar erros.

@node Fácil de depurar e testar,Componibilidade,Modularidade,Introdução<15>
@anchor{howto/functional ease-of-debugging-and-testing}@anchor{537d}
@subsubsection Fácil de depurar e testar


Testar e depurar um programa de estilo funcional é mais fácil.

A depuração é simplificada porque as funções são geralmente pequenas e claramente especificadas. Quando um programa não funciona, cada função é um ponto de interface onde você pode verificar se os dados estão corretos. Você pode observar as entradas e saídas intermediárias para isolar rapidamente a função responsável por um erro.

O teste é mais fácil porque cada função é um assunto potencial para um teste unitário. As funções não dependem do estado do sistema que precisa ser replicado antes de executar um teste; Em vez disso, você só precisa sintetizar a entrada certa e depois verificar se o resultado corresponde às expectativas.

@node Componibilidade,,Fácil de depurar e testar,Introdução<15>
@anchor{howto/functional composability}@anchor{537e}
@subsubsection Componibilidade


À medida que você trabalha em um programa de estilo funcional, você escreverá várias funções com diferentes entradas e saídas. Algumas dessas funções serão inevitavelmente especializadas em um aplicativo particular, mas outras serão úteis em uma grande variedade de programas. Por exemplo, uma função que leva um caminho de diretório e retorna todos os arquivos XML no diretório, ou uma função que leva um nome de arquivo e retorna seu conteúdo, pode ser aplicada em muitas situações diferentes.

Com o tempo você formará uma biblioteca pessoal de utilitários. Muitas vezes você montará novos programas organizando funções existentes em uma nova configuração e escrevendo algumas funções especializadas para a tarefa atual.

@node Iteradores<2>,Expressões do gerador e compreensões de lista,Introdução<15>,Programação Funcional
@anchor{howto/functional functional-howto-iterators}@anchor{537a}@anchor{howto/functional iterators}@anchor{537f}
@subsection Iteradores


Começarei por olhar para um recurso de linguagem Python que é uma base importante para escrever programas de estilo funcional: iteradores.

Um iterador é um objeto que representa um fluxo de dados; este objeto retorna os dados um elemento por vez. Um iterador Python deve suportar um método chamado @ref{1310,,iterator.__next__()} que não leva argumentos e sempre retorna o próximo elemento do fluxo. Se não houver mais elementos no fluxo, @ref{1310,,iterator.__next__()} deve aumentar a exceção @ref{c15,,StopIteration}. Os iteradores não precisam ser finitos; no entanto, é perfeitamente razoável escrever um iterador que produza um fluxo infinito de dados.

A função embutida @ref{7d8,,iter()} leva um objeto arbitrário e tenta retornar um iterador que retornará os conteúdos ou elementos do objeto, caso o contrario retorna @ref{2c3,,TypeError} se o objeto não suportar a iteração. Vários dos tipos de dados embutidos do Python suportam a iteração, sendo as listas e os dicionários mais comuns. Um objeto é chamado @ref{1268,,iterable} se você pode obter um iterador para ele.

Você pode experimentar a interface de iteração 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 iteráveis em vários contextos diferentes, sendo o mais importante a instrução @ref{2f2,,for}. Na declaração @code{for X in Y}, Y deve ser um iterador ou algum objeto para o qual @ref{7d8,,iter()} pode criar um iterador. Estas duas declarações são equivalentes:

@example
for i in iter(obj):
    print(i)

for i in obj:
    print(i)
@end example

Iteradores também podem ser materializados como listas ou tuplas, utilizando funções de construção @ref{611,,list()} ou @ref{370,,tuple()}:

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> t = tuple(iterator)
>>> t
(1, 2, 3)
@end example

O desempacotamento de sequência também suporta iteradores: se você sabe que um iterador retornará N elementos, você pode desempacotá-los em uma N-tupla:

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> a, b, c = iterator
>>> a, b, c
(1, 2, 3)
@end example

Funções embutidas, tais como @ref{f3b,,max()} e @ref{f3a,,min()} podem ter um único argumento de iterador e retornarão o elemento maior ou menor. Os operadores @code{"in"} e @code{"not in"} também aceitam iteradores: @code{X in iterator} é verdadeiro se X for encontrado no fluxo retornado pelo iterador. Você enfrentará problemas óbvios se o iterador for infinito; @ref{f3b,,max()}, @ref{f3a,,min()} nunca retornará, e se o elemento X nunca aparecer no fluxo, os operadores @code{"in"} e @code{"not in"} não retornarão também.

Observe que você só pode avançar em um iterador; não há como obter o elemento anterior, redefinir o iterador ou fazer uma cópia dele. Os objetos iteradores podem opcionalmente fornecer esses recursos adicionais, mas o protocolo do iterador especifica apenas o método @ref{1310,,iterator.__next__()}. As funções podem, portanto, consumir toda a saída do iterador, e se você precisa fazer algo diferente com o mesmo fluxo, você terá que criar um novo iterador.

@menu
* Tipos de Dados que Suportam Iteradores:: 

@end menu

@node Tipos de Dados que Suportam Iteradores,,,Iteradores<2>
@anchor{howto/functional data-types-that-support-iterators}@anchor{5380}
@subsubsection Tipos de Dados que Suportam Iteradores


Já vimos como listas e tuplas suportam iteradores. De fato, qualquer tipo de sequência de Python, como strings, suportará automaticamente a criação de um iterador.

Chamar @ref{7d8,,iter()} em um dicionário retorna um iterador que irá percorrer as chaves do dicionário:

@example
>>> m = @{'Jan': 1, 'Fev': 2, 'Mar': 3, 'Abr': 4, 'Mai': 5, 'Jun': 6,
...      'Jul': 7, 'Ago': 8, 'Set': 9, 'Out': 10, 'Nov': 11, 'Dez': 12@}
>>> for key in m:
...     print(key, m[key])
Jan 1
Fev 2
Mar 3
Abr 4
Mai 5
Jun 6
Jul 7
Ago 8
Set 9
Out 10
Nov 11
Dez 12
@end example

Note que a partir de Python 3.7, a ordem de iteração em um dicionário é garantidamente a mesma que a ordem de inserção. Em versões anteriores, o comportamento não era especificado e podia variar entre implementações.

Aplicando @ref{7d8,,iter()} para um dicionário sempre percorre as teclas, mas os dicionários têm métodos que retornam outros iteradores. Se você deseja iterar sobre valores ou pares de chave/valor, você pode chamar explicitamente os métodos @ref{7cf,,values()} ou @ref{7d0,,items()} para obter um iterador apropriado.

O construtor @ref{256,,dict()} pode aceitar um iterador que retorna um fluxo finito de tuplas @code{(chave, valor)}:

@example
>>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')]
>>> dict(iter(L))
@{'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'@}
@end example

Os arquivos também suportam a iteração chamando o método @ref{1e46,,readline()} até que não haja mais linhas no arquivo. Isso significa que você pode ler cada linha de um arquivo como este:

@example
for line in file:
    # do something for each line
    ...
@end example

Os conjuntos podem tirar seus conteúdos de uma iterável e permitir que você faça uma iteração sobre os elementos do conjunto:

@example
>>> S = @{2, 3, 5, 7, 11, 13@}
>>> for i in S:
...     print(i)
2
3
5
7
11
13
@end example

@node Expressões do gerador e compreensões de lista,Geradores<2>,Iteradores<2>,Programação Funcional
@anchor{howto/functional generator-expressions-and-list-comprehensions}@anchor{5381}
@subsection Expressões do gerador e compreensões de lista


Duas operações comuns na saída de um iterador são 1) executando alguma operação para cada elemento, 2) selecionando um subconjunto de elementos que atendam a alguma condição. Por exemplo, com uma lista de cadeias de caracteres, você pode querer retirar o espaço em branco de cada linha ou extrair todas as sequências de caracteres que contenham uma determinada substring.

As compreensões de lista e as expressões do gerador (forma curta: “listcomps” e “genexps”) são uma notação concisa para tais operações, emprestado da linguagem de programação funcional Haskell (@indicateurl{https://www.haskell.org/}). Você pode tirar todos os espaços em branco de um fluxo de strings com o seguinte código:

@example
>>> line_list = ['  line 1\n', 'line 2  \n', ' \n', '@w{'}]

>>> # Expressão geradora -- retorna iterador
>>> stripped_iter = (line.strip() for line in line_list)

>>> # Compreensão de lista -- retorna uma lista
>>> stripped_list = [line.strip() for line in line_list]
@end example

Você pode selecionar apenas determinados elementos adicionando uma condição @code{"if"}:

@example
>>> stripped_list = [line.strip() for line in line_list
...                  if line != ""]
@end example

Com uma compreensão de lista, você recebe uma lista Python; @code{Stripped_list} é uma lista contendo as linhas resultantes, e não um iterador. As expressões do gerador retornam um iterador que calcula os valores conforme necessário, não precisando materializar todos os valores ao mesmo tempo. Isso significa que as compreensões da lista não são úteis se você estiver trabalhando com iteradores que retornam um fluxo infinito ou uma quantidade muito grande de dados. As expressões do gerador são preferíveis nessas situações.

As expressões do gerador são cercadas por parênteses (“()”) e as compreensões da lista são cercadas por colchetes (“[]”). As expressões do gerador têm a 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

Novamente, para uma compreensão de lista, apenas os suportes externos são diferentes (colchetes em vez de parênteses).

Os elementos do resultado gerado serão os valores sucessivos de @code{expression}. As cláusulas @code{if} são todas opcionais; Se presente, @code{expression} só é avaliado e adicionado ao resultado quando @code{condition} é verdadeiro.

As expressões do gerador sempre devem ser escritas dentro de parênteses, mas os parênteses que sinalizam uma chamada de função também contam. Se você quiser criar um iterador que será imediatamente passado para uma função, você pode escrever:

@example
obj_total = sum(obj.count for obj in list_all_objects())
@end example

As cláusulas @code{for...in} contêm as sequências a serem repetidas. As sequências não precisam ser do mesmo comprimento, porque são iteradas da esquerda para a direita, `não' em paralelo. Para cada elemento em @code{sequence1}, @code{sequence2} é enrolado desde o início. @code{sequence3} é então percorrido para cada par resultante de elementos de @code{sequence1} e @code{sequence2}.

Em outras palavras, uma lista de compreensão ou expressão do gerador é equivalente ao seguinte código Python:

@example
for expr1 in sequence1:
    if not (condition1):
        continue   # Ignora este elemento
    for expr2 in sequence2:
        if not (condition2):
            continue   # Ignora este elemento
        ...
        for exprN in sequenceN:
            if not (conditionN):
                continue   # Ignora este elemento

            # Emite o valor da expressão,
@end example

Isso significa que, quando existem várias cláusulas @code{for...in}, mas não @code{if}, o comprimento da saída resultante será igual ao produto dos comprimentos de todas as sequências. Se você tiver duas listas de comprimento 3, a lista de saída tem 9 elementos de comprimento:

@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 a introdução de uma ambiguidade na gramática de Python, se @code{expression} estiver criando uma tupla, ela deve estar cercada de parênteses. A primeira lista de compreensão abaixo é um erro de sintaxe, enquanto o segundo está correto:

@example
# Erro de sintaxe
[x, y for x in seq1 for y in seq2]
# Correto
[(x, y) for x in seq1 for y in seq2]
@end example

@node Geradores<2>,Funções embutidas<4>,Expressões do gerador e compreensões de lista,Programação Funcional
@anchor{howto/functional generators}@anchor{5382}
@subsection Geradores


Os geradores são uma classe especial de funções que simplificam a tarefa de escrever iteradores. As funções convencionais calculam um valor e o retornam, mas os geradores retornam um iterador que retorna um fluxo de valores.

Você está sem dúvida familiarizado com o funcionamento das funções convencionais em Python ou C. Quando você chama uma função, ela recebe um espaço de nome privado onde suas variáveis locais são criadas. Quando a função atinge uma instrução @code{return}, as variáveis locais são destruídas e o valor retornado ao chamador. Uma chamada posterior para a mesma função cria um novo espaço de nome privado e um novo conjunto de variáveis locais. Mas, e se as variáveis locais não fossem descartadas ao sair de uma função? E se você pudesse retomar a função onde ele deixou? Isto é o que os geradores fornecem; Eles podem ser pensados como funções resumíveis.

Aqui está um exemplo simples de uma função geradora:

@example
>>> def generate_ints(N):
...    for i in range(N):
...        yield i
@end example

Qualquer função contendo um argumento nomeado @ref{9d5,,yield} é uma função de gerador; isso é detectado pelo compilador de @ref{187,,bytecode} do Python, que compila a função especialmente como resultado.

Quando você chama uma função de gerador, não retorna um único valor; em vez disso, ele retorna um objeto gerador que suporte o protocolo do iterador. Ao executar a expressão @code{yield}, o gerador exibe o valor de @code{i}, semelhante a uma instrução @code{return}. A grande diferença entre @code{yield} e uma declaração @code{return} é que, ao atingir um @code{yield}, o estado de execução do gerador é suspenso e as variáveis locais são preservadas. Na próxima chamada ao método do gerador @ref{1e4e,,__next__()}, a função irá continuar a ser executada.

Aqui está um uso simples do gerador @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

Você pode igualmente escrever @code{for i in generate_ints(5)}, ou @code{a, b, c = generate_ints(3)}.

Dentro de uma função de gerador, @code{return value} faz com que @code{StopIteration(value)} seja gerado a partir do método @ref{1e4e,,__next__()}. Uma vez que isso acontece, ou a parte inferior da função é alcançada, a procissão dos valores termina e o gerador não pode render mais valores.

Você pode conseguir o efeito de geradores manualmente, escrevendo sua própria classe e armazenando todas as variáveis locais do gerador como variáveis de instância. Por exemplo, retornar uma lista de inteiros pode ser feito configurando @code{self.count} para 0, e tendo o @ref{1310,,iterator.__next__()} incrementar o método @code{self.count} e devolvê-lo. No entanto, para um gerador moderadamente complicado, escrever uma classe correspondente pode ser muito mais complicado.

O conjunto de teste incluído na biblioteca do Python, lib/test/test_generators.py@footnote{https://github.com/python/cpython/tree/3.13/lib/test/test_generators.py}, contém vários exemplos mais interessantes. Aqui está um gerador que implementa uma passagem em ordem de uma árvore usando geradores de forma recursiva.

@example
# Um gerador recursivo que gera folhas da árvore em ordem.
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

Dois outros exemplos no @code{test_generators.py} produzem soluções para o problema N-Queens (colocando N rainhas em um tabuleiro de xadrez NxN para que nenhuma rainha ameace a outra) e o Passeio do Cavalo (encontrando uma rota que leva um cavalo para cada quadrado de um tabuleiro de xadrez NxN sem visitar nenhum quadrado duas vezes).

@menu
* Passando valores para um gerador:: 

@end menu

@node Passando valores para um gerador,,,Geradores<2>
@anchor{howto/functional passing-values-into-a-generator}@anchor{5383}
@subsubsection Passando valores para um gerador


No Python 2.4 e anteriores, os geradores apenas produziram saída. Uma vez que o código de um gerador foi invocado para criar um iterador, não havia como passar qualquer nova informação na função quando sua execução foi retomada. Você pode cortar essa habilidade fazendo com que o gerador olhe para uma variável global ou passando em algum objeto mutável que os chamadores então modifiquem, mas essas abordagens são desordenadas.

No Python 2.5 há uma maneira simples de passar valores para um gerador. @ref{9d5,,yield} tornou-se uma expressão, retornando um valor que pode ser atribuído a uma variável ou operado de outra forma:

@example
val = (yield i)
@end example

Eu recomendo que você `sempre' coloque parênteses em torno de uma expressão @code{yield} quando você está fazendo algo com o valor retornado, como no exemplo acima. Os parênteses nem sempre são necessários, mas é mais fácil adicioná-los sempre em vez de ter que lembrar quando são necessários.

(
@geindex Propostas de Melhorias do Python; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} explica as regras exatas, é que uma expressão @code{yield} deve sempre ser entre parênteses, exceto quando ocorre na expressão de nível superior no lado direito de uma atribuição. Isso significa que você pode escrever @code{val = yield i}, mas tem que usar parênteses quando há uma operação, como em @code{val = (yield i) + 12}.)

Os valores são enviados para um gerador chamando seu método @ref{215a,,send(value)}. Este método retoma o código do gerador e a expressão @code{yield} retorna o valor especificado. Se o método regular @ref{1e4e,,__next__()} for chamado, o @code{yield} retorna @code{None}.

Aqui está um contador simples que aumenta em 1 e permite alterar o valor do contador interno.

@example
def counter(maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # Se o valor foi fornecido, altera o contador
        if val is not None:
            i = val
        else:
            i += 1
@end example

E aqui um exemplo de mudança de 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

Porque @code{yield} retornará frequentemente @code{None}, você deve verificar sempre este caso. Não use apenas seu valor em expressões, a menos que tenha certeza de que o método @ref{215a,,send()} será o único método usado para retomar a função do gerador.

Além de @ref{215a,,send()}, há dois outros métodos em geradores:


@itemize *

@item 
@ref{4f8,,throw(value)} é usado para gerar uma exceção dentro do gerador; a exceção é levantada pela expressão @code{yield} onde a execução do gerador é pausada.

@item 
@ref{15b9,,close()} envia uma exceção @ref{140e,,GeneratorExit} ao gerador para encerrar a iteração. Ao receber essa exceção, o código do gerador deve levantar @ref{140e,,GeneratorExit} ou @ref{c15,,StopIteration}; capturar a exceção e fazer qualquer outra coisa é ilegal e disparará um @ref{195,,RuntimeError}. @ref{15b9,,close()} também será chamado pelo coletor de lixo do Python quando o gerador for coletado como lixo.

Se você precisar executar um código de limpeza quando ocorrer um @ref{140e,,GeneratorExit}, sugiro usar um conjunto @code{try: ... finally:} em vez de capturar @ref{140e,,GeneratorExit}.
@end itemize

The cumulative effect of these changes is to turn generators from one-way
producers of information into both producers and consumers.

Geradores também se tornam `corrotinas', uma forma mais generalizada de subrotinas. As subrotinas são inseridas em um ponto e encerradas em outro (o topo da função e uma instrução @code{return}), mas as corrotinas podem ser inseridas, encerradas e retomadas em muitos pontos diferentes (as instruções @code{yield}).

@node Funções embutidas<4>,O módulo itertools,Geradores<2>,Programação Funcional
@anchor{howto/functional built-in-functions}@anchor{5384}
@subsection Funções embutidas


Vamos ver com maiores detalhes as funções embutidas que são comumente usadas com iteradores.

Duas das funções embutidas do Python, @ref{867,,map()} e @ref{868,,filter()} duplicam os recursos das expressões geradoras:


@table @asis

@item @ref{867,,map(f@comma{} iterA@comma{} iterB@comma{} ...)} retorna um iterador sobre a sequência

@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

É claro que você pode alcançar o mesmo efeito com uma compreensão de lista.

@ref{868,,filter(predicate@comma{} iter)} retorna um iterador sobre todos os elementos da sequência que atendem a uma determinada condição, e é similarmente duplicada por compreensões de lista. Um `predicate' é uma função que retorna o valor lógico de alguma condição; para uso com @ref{868,,filter()}, o predicado deve receber um único 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

isso também pode ser escrito como uma compreensão de lista:

@example
>>> list(x for x in range(10) if is_even(x))
[0, 2, 4, 6, 8]
@end example

@ref{14c9,,enumerate(iter@comma{} start=0)} counts off the elements in the
iterable returning 2-tuples containing the count (from `start') and
each element.

@example
>>> for item in enumerate(['subject', 'verb', 'object']):
...     print(item)
(0, 'subject')
(1, 'verb')
(2, 'object')
@end example

@ref{14c9,,enumerate()} is often used when looping through a list and recording the
indexes at which certain conditions are met:

@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{be7,,sorted(iterable@comma{} key=None@comma{} reverse=False)} collects all the
elements of the iterable into a list, sorts the list, and returns the sorted
result.  The `key' and `reverse' arguments are passed through to the
constructed list’s @ref{be8,,sort()} method.

@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

(For a more detailed discussion of sorting, see the @ref{2314,,Técnicas de ordenação}.)

The @ref{1468,,any(iter)} and @ref{1469,,all(iter)} built-ins look at the
truth values of an iterable’s contents.  @ref{1468,,any()} returns @code{True} if any element
in the iterable is a true value, and @ref{1469,,all()} returns @code{True} if all of the
elements are true values:

@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{7d1,,zip(iterA@comma{} iterB@comma{} ...)} takes one element from each iterable and
returns them in a tuple:

@example
zip(['a', 'b', 'c'], (1, 2, 3)) =>
  ('a', 1), ('b', 2), ('c', 3)
@end example

It doesn’t construct an in-memory list and exhaust all the input iterators
before returning; instead tuples are constructed and returned only if they’re
requested.  (The technical term for this behaviour is lazy evaluation@footnote{https://en.wikipedia.org/wiki/Lazy_evaluation}.)

This iterator is intended to be used with iterables that are all of the same
length.  If the iterables are of different lengths, the resulting stream will be
the same length as the shortest iterable.

@example
zip(['a', 'b'], (1, 2, 3)) =>
  ('a', 1), ('b', 2)
@end example

You should avoid doing this, though, because an element may be taken from the
longer iterators and discarded.  This means you can’t go on to use the iterators
further because you risk skipping a discarded element.

@node O módulo itertools,O módulo functools,Funções embutidas<4>,Programação Funcional
@anchor{howto/functional the-itertools-module}@anchor{5385}
@subsection O 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.

The module’s functions fall into a few broad classes:


@itemize *

@item 
Funções que criam um novo iterador com base em um iterador existente.

@item 
Funções para tratar os elementos de um iterador como argumentos de funções.

@item 
Funções para selecionar partes da saída de um iterador.

@item 
A function for grouping an iterator’s output.
@end itemize

@menu
* Criando novos iteradores:: 
* Calling functions on elements:: 
* Selecionando elementos:: 
* Combinatoric functions:: 
* Agrupando elementos:: 

@end menu

@node Criando novos iteradores,Calling functions on elements,,O módulo itertools
@anchor{howto/functional creating-new-iterators}@anchor{5386}
@subsubsection Criando novos iteradores


@ref{12c5,,itertools.count(start@comma{} step)} returns an infinite
stream of evenly spaced values.  You can optionally supply the starting number,
which defaults to 0, and the interval between numbers, which defaults to 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{28d9,,itertools.cycle(iter)} saves a copy of the contents of
a provided iterable and returns a new iterator that returns its elements from
first to last.  The new iterator will repeat these elements infinitely.

@example
itertools.cycle([1, 2, 3, 4, 5]) =>
  1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...
@end example

@ref{28da,,itertools.repeat(elem@comma{} [n])} returns the provided
element `n' times, or returns the element endlessly if `n' is not provided.

@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{2315,,itertools.chain(iterA@comma{} iterB@comma{} ...)} takes an arbitrary
number of iterables as input, and returns all the elements of the first
iterator, then all the elements of the second, and so on, until all of the
iterables have been exhausted.

@example
itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>
  a, b, c, 1, 2, 3
@end example

@ref{b61,,itertools.islice(iter@comma{} [start]@comma{} stop@comma{} [step])} returns
a stream that’s a slice of the iterator.  With a single `stop' argument, it
will return the first `stop' elements.  If you supply a starting index, you’ll
get `stop-start' elements, and if you supply a value for `step', elements
will be skipped accordingly.  Unlike Python’s string and list slicing, you can’t
use negative values for `start', `stop', or `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{28df,,itertools.tee(iter@comma{} [n])} replicates an iterator; it
returns `n' independent iterators that will all return the contents of the
source iterator.
If you don’t supply a value for `n', the default is 2.  Replicating iterators
requires saving some of the contents of the source iterator, so this can consume
significant memory if the iterator is large and one of the new iterators is
consumed more than the others.

@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 Calling functions on elements,Selecionando elementos,Criando novos iteradores,O módulo itertools
@anchor{howto/functional calling-functions-on-elements}@anchor{5387}
@subsubsection Calling functions on elements


The @ref{9f,,operator} module contains a set of functions corresponding to Python’s
operators.  Some examples are @ref{2907,,operator.add(a@comma{} b)} (adds
two values), @ref{28f7,,operator.ne(a@comma{} b)} (same as @code{a != b}), and
@ref{e60,,operator.attrgetter('id')}
(returns a callable that fetches the @code{.id} attribute).

@ref{1123,,itertools.starmap(func@comma{} iter)} assumes that the
iterable will return a stream of tuples, and calls `func' using these tuples as
the arguments:

@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 Selecionando elementos,Combinatoric functions,Calling functions on elements,O módulo itertools
@anchor{howto/functional selecting-elements}@anchor{5388}
@subsubsection Selecionando elementos


Another group of functions chooses a subset of an iterator’s elements based on a
predicate.

@ref{2303,,itertools.filterfalse(predicate@comma{} iter)} is the
opposite of @ref{868,,filter()}, returning all elements for which the predicate
returns false:

@example
itertools.filterfalse(is_even, itertools.count()) =>
  1, 3, 5, 7, 9, 11, 13, 15, ...
@end example

@ref{28de,,itertools.takewhile(predicate@comma{} iter)} returns
elements for as long as the predicate returns true.  Once the predicate returns
false, the iterator will signal the end of its results.

@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{28dc,,itertools.dropwhile(predicate@comma{} iter)} discards
elements while the predicate returns true, and then returns the rest of the
iterable’s results.

@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{12c4,,itertools.compress(data@comma{} selectors)} takes two
iterators and returns only those elements of `data' for which the corresponding
element of `selectors' is true, stopping whenever either one is exhausted:

@example
itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>
   1, 2, 5
@end example

@node Combinatoric functions,Agrupando elementos,Selecionando elementos,O módulo itertools
@anchor{howto/functional combinatoric-functions}@anchor{5389}
@subsubsection Combinatoric functions


The @ref{1356,,itertools.combinations(iterable@comma{} r)}
returns an iterator giving all possible `r'-tuple combinations of the
elements contained in `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

The elements within each tuple remain in the same order as
`iterable' returned them.  For example, the number 1 is always before
2, 3, 4, or 5 in the examples above.  A similar function,
@ref{1a6a,,itertools.permutations(iterable@comma{} r=None)},
removes this constraint on the order, returning all possible
arrangements of length `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

If you don’t supply a value for `r' the length of the iterable is used,
meaning that all the elements are permuted.

Note that these functions produce all of the possible combinations by
position and don’t require that the contents of `iterable' are unique:

@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

The identical tuple @code{('a', 'a', 'b')} occurs twice, but the two ‘a’
strings came from different positions.

The @ref{12c3,,itertools.combinations_with_replacement(iterable@comma{} r)}
function relaxes a different constraint: elements can be repeated
within a single tuple.  Conceptually an element is selected for the
first position of each tuple and then is replaced before the second
element is selected.

@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 Agrupando elementos,,Combinatoric functions,O módulo itertools
@anchor{howto/functional grouping-elements}@anchor{538a}
@subsubsection Agrupando elementos


The last function I’ll discuss, @ref{28dd,,itertools.groupby(iter@comma{} key_func=None)}, is the most complicated.  @code{key_func(elem)} is a function
that can compute a key value for each element returned by the iterable.  If you
don’t supply a key function, the key is simply each element itself.

@ref{28dd,,groupby()} collects all the consecutive elements from the
underlying iterable that have the same key value, and returns a stream of
2-tuples containing a key value and an iterator for the elements with that key.

@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{28dd,,groupby()} assumes that the underlying iterable’s contents will
already be sorted based on the key.  Note that the returned iterators also use
the underlying iterable, so you have to consume the results of iterator-1 before
requesting iterator-2 and its corresponding key.

@node O módulo functools,Pequenas funções e as expressões lambda,O módulo itertools,Programação Funcional
@anchor{howto/functional the-functools-module}@anchor{538b}
@subsection O 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{414,,functools.partial()} function.

For programs written in a functional style, you’ll sometimes want to construct
variants of existing functions that have some of the parameters filled in.
Consider a Python function @code{f(a, b, c)}; you may wish to create a new function
@code{g(b, c)} that’s equivalent to @code{f(1, b, c)}; you’re filling in a value for
one of @code{f()}’s parameters.  This is called “partial function application”.

The constructor for @ref{414,,partial()} takes the arguments
@code{(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)}.  The resulting
object is callable, so you can just call it to invoke @code{function} with the
filled-in arguments.

Aqui está um pequeno mas bem realístico exemplo:

@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{131f,,functools.reduce(func@comma{} iter@comma{} [initial_value])}
cumulatively performs an operation on all the iterable’s elements and,
therefore, can’t be applied to infinite iterables. `func' must be a function
that takes two elements and returns a single value.  @ref{131f,,functools.reduce()}
takes the first two elements A and B returned by the iterator and calculates
@code{func(A, B)}.  It then requests the third element, C, calculates
@code{func(func(A, B), C)}, combines this result with the fourth element returned,
and continues until the iterable is exhausted.  If the iterable returns no
values at all, a @ref{2c3,,TypeError} exception is raised.  If the initial value is
supplied, it’s used as a starting point and @code{func(initial_value, A)} is the
first calculation.

@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

If you use @ref{2907,,operator.add()} with @ref{131f,,functools.reduce()}, you’ll add up all the
elements of the iterable.  This case is so common that there’s a special
built-in called @ref{46a,,sum()} to compute it:

@example
>>> import functools, operator
>>> functools.reduce(operator.add, [1, 2, 3, 4], 0)
10
>>> sum([1, 2, 3, 4])
10
>>> sum([])
0
@end example

For many uses of @ref{131f,,functools.reduce()}, though, it can be clearer to just
write the obvious @ref{2f2,,for} loop:

@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{a05,,itertools.accumulate(iterable@comma{} func=operator.add)}.  It performs the same calculation, but instead of
returning only the final result, @ref{a05,,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
* O módulo operator:: 

@end menu

@node O módulo operator,,,O módulo functools
@anchor{howto/functional the-operator-module}@anchor{538c}
@subsubsection O módulo operator


The @ref{9f,,operator} module was mentioned earlier.  It contains a set of
functions corresponding to Python’s operators.  These functions are often useful
in functional-style code because they save you from writing trivial functions
that perform a single operation.

Algumas funcionalidades desse módulo são:


@itemize *

@item 
Math operations: @code{add()}, @code{sub()}, @code{mul()}, @code{floordiv()}, @code{abs()}, …

@item 
Logical operations: @code{not_()}, @code{truth()}.

@item 
Bitwise operations: @code{and_()}, @code{or_()}, @code{invert()}.

@item 
Comparisons: @code{eq()}, @code{ne()}, @code{lt()}, @code{le()}, @code{gt()}, and @code{ge()}.

@item 
Object identity: @code{is_()}, @code{is_not()}.
@end itemize

Consult the operator module’s documentation for a complete list.

@node Pequenas funções e as expressões lambda,Histórico de Revisão e Reconhecimentos,O módulo functools,Programação Funcional
@anchor{howto/functional small-functions-and-the-lambda-expression}@anchor{538d}
@subsection Pequenas funções e as expressões lambda


When writing functional-style programs, you’ll often need little functions that
act as predicates or that combine elements in some way.

If there’s a Python built-in or a module function that’s suitable, you don’t
need to define a new function at all:

@example
stripped_lines = [line.strip() for line in lines]
existing_files = filter(os.path.exists, file_list)
@end example

If the function you need doesn’t exist, you need to write it.  One way to write
small functions is to use the @ref{12df,,lambda} expression.  @code{lambda} takes a
number of parameters and an expression combining these parameters, and creates
an anonymous function that returns the value of the expression:

@example
adder = lambda x, y: x+y

print_assign = lambda name, value: name + '=' + str(value)
@end example

An alternative is to just use the @code{def} statement and define a function in the
usual way:

@example
def adder(x, y):
    return x + y

def print_assign(name, value):
    return name + '=' + str(value)
@end example

Which alternative is preferable?  That’s a style question; my usual course is to
avoid using @code{lambda}.

Um dos motivos da minha preferência é que @code{lambda} é bastante limitado nas funções que pode definir. O resultado deve ser computável como uma única expressão, o que significa que você não pode ter comparações multi-canais @code{if ... elif ... else} ou @code{try ... except}. Se você tentar fazer muito em uma declaração @code{lambda}, você acabará com uma expressão excessivamente complicada que é difícil de ler. Rápido, o que o seguinte código está fazendo?

@example
import functools
total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]
@end example

Você pode descobrir isso, mas leva tempo para desenredar a expressão para descobrir o que está acontecendo. Usar uma breve instrução de @code{def} aninhada torna as coisas um pouco melhor:

@example
import functools
def combine(a, b):
    return 0, a[1] + b[1]

total = functools.reduce(combine, items)[1]
@end example

Mas seria o melhor de tudo se eu tivesse usado simplesmente um bucle @code{for}:

@example
total = 0
for a, b in items:
    total += b
@end example

Ou o @ref{46a,,sum()} embutida e uma expressão do gerador:

@example
total = sum(b for a, b in items)
@end example

Muitas utilizações de @ref{131f,,functools.reduce()} são mais claras quando escritas como laços @code{for}.

Fredrik Lundh sugeriu uma vez o seguinte conjunto de regras para refatoração de usos de @code{lambda}:


@enumerate 

@item 
Escrever uma função lambda.

@item 
Escreva um comentário explicando o que o lambda faz.

@item 
Estude o comentário por um tempo e pense em um nome que capture a essência do comentário.

@item 
Converta a lambda para uma declaração de definição, usando esse nome.

@item 
Remover o comentário.
@end enumerate

Eu realmente gosto dessas regras, mas você está livre para discordar sobre se esse estilo sem lambda é melhor.

@node Histórico de Revisão e Reconhecimentos,Referências<2>,Pequenas funções e as expressões lambda,Programação Funcional
@anchor{howto/functional revision-history-and-acknowledgements}@anchor{538e}
@subsection Histórico de Revisão e Reconhecimentos


O autor agradece as seguintes pessoas por oferecer sugestões, correções e assistência com vários rascunhos deste artigo: Ian Bicking, Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell, Leandro Lameiro, Jussi Salmela, Collin Winter, Blake Winton.

Versão 0.1: publicado em 30 de junho de 2006.

Versão 0.11: publicado em 1º de julho de 2006. Correções de erros de escrita.

Versão 0.2: publicado em 10 de julho de 2006. Incorporou as seções genexp e listcomp em uma. Correções de erros de escrita.

Versão 0.21: adicionou mais referências sugeridas na lista de correspondência do tutor.

Versão 0.30: Adiciona uma seção no módulo @code{functional} escrito por Collin Winter; Adiciona seção curta no módulo do operador; Algumas outras edições.

@node Referências<2>,,Histórico de Revisão e Reconhecimentos,Programação Funcional
@anchor{howto/functional references}@anchor{538f}
@subsection Referências


@menu
* Geral:: 
* Python-specific:: 
* Documentação do Python:: 

@end menu

@node Geral,Python-specific,,Referências<2>
@anchor{howto/functional general}@anchor{5390}
@subsubsection Geral


`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://defmacro.org/2006/06/19/fp.html}: A general introduction to functional
programming that uses Java examples and has a lengthy historical introduction.

@indicateurl{https://pt.wikipedia.org/wiki}/Programação_funcional: Informação geral do Wikipédia para descrever programação funcional.

@indicateurl{https://pt.wikipedia.org/wiki/Corrotina}: Entrada para corrotinas.

@indicateurl{https://en.wikipedia.org/wiki/Partial_application}: Entry for the concept of partial function application.

@indicateurl{https://pt.wikipedia.org/wiki/Currying}: Entrada para o conceito de currying.

@node Python-specific,Documentação do Python,Geral,Referências<2>
@anchor{howto/functional python-specific}@anchor{5391}
@subsubsection Python-specific


@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 also wrote a 3-part series of articles on functional programming
for IBM’s DeveloperWorks site; see
part 1@footnote{https://developer.ibm.com/articles/l-prog/},
part 2@footnote{https://developer.ibm.com/tutorials/l-prog2/}, and
part 3@footnote{https://developer.ibm.com/tutorials/l-prog3/},

@node Documentação do Python,,Python-specific,Referências<2>
@anchor{howto/functional python-documentation}@anchor{5392}
@subsubsection Documentação do Python


Documentação para o módulo @ref{81,,itertools}.

Documentation for the @ref{5f,,functools} module.

Documentação para o módulo @ref{9f,,operator}.

@geindex Propostas de Melhorias do Python; PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/}: “Gerador de Expressões”

@geindex Propostas de Melhorias do Python; PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/}: “Coroutines via Enhanced Generators” descreve os novos recursos do gerador no 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 Logging,Livro de receitas do logging,Programação Funcional,Python HOWTOs
@anchor{howto/logging doc}@anchor{5393}@anchor{howto/logging id1}@anchor{5394}@anchor{howto/logging logging-howto}@anchor{5395}@anchor{howto/logging translation-repo}@anchor{5396}
@section Logging


@*Autor: 
Vinay Sajip <vinay_sajip at red-dove dot com>

@anchor{howto/logging logging-basic-tutorial}@anchor{1235}
Essa página contém informações relativas a tutoriais. Para links de informações de referência e livro de receitas de logging, por favor veja @ref{5397,,Outros recursos}.

@menu
* Tutorial Básico de Logging:: 
* Tutorial Avançado do Logging:: 
* Níveis de Logging: Níveis de Logging<2>. 
* Handlers úteis:: 
* Exceções levantadas durante logging:: 
* Usando objetos arbitrários como mensagens:: 
* Optimização:: 
* Outros recursos: Outros recursos<2>. 

@end menu

@node Tutorial Básico de Logging,Tutorial Avançado do Logging,,Logging
@anchor{howto/logging basic-logging-tutorial}@anchor{5398}
@subsection Tutorial Básico de Logging


Logging é uma maneira de rastrear eventos que acontecem quando algum software é executado. O desenvolvedor de software adiciona chamadas de logging no código para indicar que determinado evento ocorreu. Um evento é definido por uma mensagem descritiva que pode opcionalmente conter o valor de uma variável (ex.: um dado que é potencialmente diferente pra cada ocorrência do evento). Eventos também possuem importâncias atribuídas pelo desenvolvedor; esta importância pode ser chamada de `nível' ou `severidade'.

@menu
* Quando usar logging:: 
* Um exemplo simples:: 
* Logging em um arquivo:: 
* Logging de variáveis dinâmicas:: 
* Alterar o formato das mensagens exibidas:: 
* Exibindo data/hora em mensagens:: 
* Próximos Passos:: 

@end menu

@node Quando usar logging,Um exemplo simples,,Tutorial Básico de Logging
@anchor{howto/logging when-to-use-logging}@anchor{5399}
@subsubsection Quando usar logging


Você pode instanciar loggers com @code{logger = getLogger(__name__)} e, em seguida, chamar os métodos @ref{e57,,debug()}, @ref{2e3f,,info()}, @ref{17f6,,warning()}, @ref{2e41,,error()} e @ref{e56,,critical()}. Para determinar a necessidade ou não de usar logging, e escolher o método adequado, consulte a tabela abaixo. Ela indica, para cada conjunto de tarefas comuns, a melhor ferramenta a ser usada.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tarefa que você deseja executar

@tab

A melhor ferramenta para a tarefa

@item

Exibir uma mensagem na saída do console para uso ordinário de um script de linha de comando (CLI) ou programa.

@tab

@ref{fa9,,print()}

@item

Expor eventos que possam ocorrer durante a operação normal de um programa (por exemplo, para monitorar o estado atual de execução ou poder investigar falhas)

@tab

Utilize o método @ref{2e3f,,info()} de um logger (ou o método @ref{e57,,debug()}, no caso de mensagens mais detalhadas para diagnóstico e investigação de erros)

@item

Emitir um aviso sobre um evento que ocorre em um tempo de execução específico

@tab

Utilize a função @ref{1562,,warnings.warn()} da biblioteca padrão se o problema for evitável, e caso a aplicação deva ser modificada pelo usuário para eliminar o alerta.

Utilize o método @ref{17f6,,warning()} de um logger, caso não haja nada que o usuário possa fazer na aplicação, mas o evento ainda deva ser registrado

@item

Expor um erro sobre um evento em um tempo de execução específico

@tab

Levantando uma exceção

@item

Expor a supressão de um erro sem levantar uma exceção (por exemplo, ao utilizar um tratador de erro em um processo de longa execução)

@tab

Um método @ref{2e41,,error()}, @ref{e55,,exception()} ou @ref{e56,,critical()} do logger, conforme apropriado para o erro específico e domínio da aplicação

@end multitable


Os métodos de logger são nomeados de acordo com o nível ou severidade dos eventos que eles são usados para rastrear. Os níveis padrão e sua aplicabilidade são descritos abaixo (em ordem crescente de severidade):


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Nível

@tab

Quando é usado

@item

@code{DEBUG}

@tab

Informação detalhada, tipicamente utilizáveis apenas para diagnosticar problemas.

@item

@code{INFO}

@tab

Confirmação de que as coisas estão funcionando como esperado.

@item

@code{WARNING}

@tab

Uma indicação que algo inesperado aconteceu, ou um indicativo de que poderá haver algum problema em um futuro próximo (por exemplo: ‘pouco espaço em disco’). O software está ainda funcionando como esperado.

@item

@code{ERROR}

@tab

Por conta de um problema mais grave, o software não conseguiu executar alguma função.

@item

@code{CRITICAL}

@tab

Um erro grave, indicando que o programa pode não conseguir continuar rodando.

@end multitable


O nível padrão é @code{WARNING}, o que significa que somente os eventos desse nível de severidade e superiores serão registrados, a menos que o logger do pacote esteja configurado para fazer o contrário.

Eventos que são rastreados podem ser tratados de diferentes formas. O jeito mais simples de lidar com eventos rastreados é exibi-los no console. Outra maneira comum é gravá-los em um arquivo de disco.

@node Um exemplo simples,Logging em um arquivo,Quando usar logging,Tutorial Básico de Logging
@anchor{howto/logging a-simple-example}@anchor{539a}@anchor{howto/logging howto-minimal-example}@anchor{539b}
@subsubsection Um exemplo simples


Um exemplo bastante simples é:

@example
import logging
logging.warning('Cuidado!')  # exibirá uma mensagem no console
logging.info('Eu te avisei')  # não exibirá nada
@end example

Se você colocar essas linhas no script e executá-lo, você verá:

@example
WARNING:root:Cuidado!
@end example

no console. A mensagem @code{INFO} não aparece porque o nível padrão de logging é @code{WARNING} . A mensagem exibida inclui a indicação do nível e a descrição do evento fornecido na chamada de logging. Ou seja, ‘Cuidado!’. A saída pode ser formatada de maneira bastante flexível, se necessário; as opções de formatação também serão explicadas mais tarde.

Observe que neste exemplo, usamos funções diretamente no módulo @code{logging}, como @code{logging.debug}, ao invés de criar um logger e chamar funções nele. Essas funções operam no logger raiz, mas podem ser úteis, pois chamarão @ref{a08,,basicConfig()} para você se ele ainda não tiver sido chamado, como neste exemplo. Em programas maiores, você geralmente desejará controlar explicitamente a configuração de logging, no entanto - então, por esse motivo, assim como por outros, é melhor criar loggers e chamar seus métodos.

@node Logging em um arquivo,Logging de variáveis dinâmicas,Um exemplo simples,Tutorial Básico de Logging
@anchor{howto/logging logging-to-a-file}@anchor{539c}
@subsubsection Logging em um arquivo


Uma situação muito comum é a de registrar eventos de log em um arquivo, então vamos dar uma olhada nisso a seguir. Teste o código a seguir em um interpretador Python recém-iniciado. Não continue a partir da sessão usada para o código anterior.

@example
import logging
logger = logging.getLogger(__name__)
logging.basicConfig(filename='exemplo.log', encoding='utf-8', level=logging.DEBUG)
logger.debug('Esta mensagem aparecerá no arquivo de log')
logger.info('Esta também')
logger.warning('E também essa')
logger.error('Além de palavras com caracteres não-ASCII, como Øresund e Malmö')
@end example


Alterado na versão 3.9: O argumento de codificação  `encoding' foi adicionado. Em versões anteriores do Python, a codificação utilizada por padrão seria definida em @ref{51c,,open()}. Embora não seja mostrado no exemplo acima, um argumento de `erro' pode ser utilizado, o que determina como o codificação de erros são tratadas. Para saber mais sobre essas possibilidades, consulte a documentação de @ref{51c,,open()}.


E agora se nós abrirmos o arquivo e olharmos o que temos, deveremos encontrar essas mensagens de log:

@example
DEBUG:__main__:Esta mensagem aparecerá no arquivo de log
INFO:__main__:Esta também
WARNING:__main__:E também essa
ERROR:__main__:Além de palavras com caracteres não-ASCII, como Øresund e Malmö
@end example

Este exemplo também mostra como você pode configurar o nível do logging , que funcionará como um limite para o rastreamento. Neste caso, como definimos o nível limite como @code{DEBUG}, todas as mensagens foram exibidas.

Você também pode definir o nível de logging a partir de um parâmetro pela linha de comando (CLI):

@example
--log=INFO
@end example

e se você quiser obter o valor do parâmetro @code{--log} em algum ponto do código, você pode usar:

@example
getattr(logging, loglevel.upper())
@end example

para obter o valor que você passará para a @ref{a08,,basicConfig()} pelo argumento de nível `level'. Isso pode ser útil para verificar erros introduzidos pelo usuário, como no exemplo a seguir:

@example
# presumindo que a variável loglevel está atrelada ao valor da string obtida
# pelo argumento de linha de comando; Converter para caixa alta permite ao usuário
# declarar tanto --log=DEBUG quanto--log=debug
nivel_numerico = getattr(logging, loglevel.upper(), None)
if not isinstance(nivel_numerico , int):
    raise ValueError('Nível de log invalido: %s' % loglevel)
logging.basicConfig(level=nivel_numerico, ...)
@end example

A chamada para @ref{a08,,basicConfig()} deve vir `antes' de qualquer chamada para métodos de um logger, como @ref{e57,,debug()}, @ref{2e3f,,info()}, etc. Caso contrário, o logging deste evento pode não ser tratado da forma desejada.

Se você executar o script acima diversas vezes, as mensagens das sucessivas execuções serão acrescentadas ao arquivo `exemplo.log'. Se você quiser que cada execução seja iniciada novamente, não guardando as mensagens das execuções anteriores, você pode definir o argumento `filemode', mudando a chamada no exemplo acima para:

@example
logging.basicConfig(filename='exemplo.log', filemode='w', level=logging.DEBUG)
@end example

A saída será a mesma de antes, mas o arquivo de log não será mais incrementado. Desta forma, as mensagens de execuções anteriores serão perdidas.

@node Logging de variáveis dinâmicas,Alterar o formato das mensagens exibidas,Logging em um arquivo,Tutorial Básico de Logging
@anchor{howto/logging logging-variable-data}@anchor{539d}
@subsubsection Logging de variáveis dinâmicas


Para logar o dado de uma variável, use o formato string para a mensagem descritiva do evento e adicione a variável como argumento. Exemplo:

@example
import logging
logging.warning('%s onde você %s', 'Olhe', 'anda!')
@end example

exibirá:

@example
WARNING:root:Olhe onde você anda!
@end example

Como você pode ver, para combinar uma variável de dados na mensagem descritiva do evento usamos o velho operador %, formatador de strings. Isto é usado para garantir compatibilidade com as versões anteriores: os pacotes logging mais recentes contam com opções de formatação como @ref{621,,str.format()} e @ref{687,,string.Template}. Mas explorar estes métodos está fora do escopo deste tutorial. Veja @ref{2e60,,Using particular formatting styles throughout your application} para mais informações.

@node Alterar o formato das mensagens exibidas,Exibindo data/hora em mensagens,Logging de variáveis dinâmicas,Tutorial Básico de Logging
@anchor{howto/logging changing-the-format-of-displayed-messages}@anchor{539e}
@subsubsection Alterar o formato das mensagens exibidas


Para mudar o formato usado para exibir mensagens, você precisa especificar o formato que quer usar:

@example
import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('Esta mensagem aparecerá no console')
logging.info('Esta também')
logging.warning('E também essa')
@end example

que vai exibir:

@example
DEBUG:Esta mensagem aparecerá no console
INFO:Esta também
WARNING:E também essa
@end example

Note que a palavra ‘root’ que apareceu nos exemplos anteriores desapareceu. Para todas as configurações que possam aparecer na formatação de strings, você pode consultar a documentação @ref{2e3e,,Atributos LogRecord}, mas para uso simples, você só precisa do `levelname' (severidade), `message' (descrição do evento, incluindo a variável com dados) e talvez exibir quando o evento ocorreu. Isto esta descrito na próxima seção.

@node Exibindo data/hora em mensagens,Próximos Passos,Alterar o formato das mensagens exibidas,Tutorial Básico de Logging
@anchor{howto/logging displaying-the-date-time-in-messages}@anchor{539f}
@subsubsection Exibindo data/hora em mensagens


Para exibir a data e hora de um evento, você pode colocar @cite{%(asctime)s} na sua string de formato:

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s')
logging.warning('foi quando este evento foi registrado.')
@end example

que deve exibir algo assim:

@example
2010-12-12 11:41:42,612 foi quando este evento foi registrado.
@end example

O formato padrão para data/hora (mostrado abaixo) é a ISO8601 ou a 
@geindex RFC; RFC 3339
RFC 3339@footnote{https://datatracker.ietf.org/doc/html/rfc3339.html}. Se você precisar de mais controle sobre a formatação de data/hora, defina o argumento `datefmt' na função @code{basicConfig}, como neste exemplo:

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
logging.warning('foi quando este evento foi registrado.')
@end example

que deve exibir algo assim:

@example
12/12/2010 11:46:36 AM foi quando este evento foi registrado.
@end example

O formato do argumento `datefmt' é o mesmo suportado por @ref{1229,,time.strftime()}.

@node Próximos Passos,,Exibindo data/hora em mensagens,Tutorial Básico de Logging
@anchor{howto/logging next-steps}@anchor{53a0}
@subsubsection Próximos Passos


Concluímos aqui o tutorial básico. Isto deve ser o bastante para você começar a trabalhar com logging. Existe muito mais que o pacote de logging pode oferecer, mas para ter o melhor disto, você precisará investir um pouco mais do seu tempo lendo as próximas seções. Se você está pronto para isso, pegue sua bebida favorita e continue.

Se as suas necessidades de logging forem simples, use os exemplos acima para incorporar o registro em seus próprios scripts e, se tiver problemas ou não entender alguma coisa, publique uma pergunta na categoria Help do fórum de discussão Python@footnote{https://discuss.python.org/c/help/7}. Você deverá receber ajuda em breve.

Ainda por aqui? Você pode continuar lendo as seções seguintes, que tem um tutorial mais avançado que o básico acima. Depois disso, você pode dar uma olhada no @ref{1237,,Livro de receitas do logging}.

@node Tutorial Avançado do Logging,Níveis de Logging<2>,Tutorial Básico de Logging,Logging
@anchor{howto/logging advanced-logging-tutorial}@anchor{53a1}@anchor{howto/logging logging-advanced-tutorial}@anchor{1236}
@subsection Tutorial Avançado do Logging


A biblioteca de logging tem uma abordagem modular e oferece algumas categorias de componentes: loggers, manipuladores, filtros, e formatadores.


@itemize *

@item 
Loggers expõem a interface que o código da aplicação usa diretamente.

@item 
Handlers enviam os registros do evento (criados por loggers) aos destinos apropriados.

@item 
Filters fornecem uma facilidade granular para determinar quais registros de eventos enviar à saída.

@item 
Formatters especificam o layout dos registros de eventos na saída final.
@end itemize

Um evento, quando registrado, passa por loggers, manipuladores, filtros e formatadores através de uma instância de @ref{101c,,LogRecord}

Para executar uma ação de logging, é necessário criar instâncias da classe @ref{b64,,Logger} (também chamadas de `loggers'), e invocar seus métodos. Cada instância tem um nome, e elas são conceitualmente organizadas em uma hierarquia de espaço de nomes utilizando pontos como separadores. Por exemplo, um logger nomeado como ‘leitor’ é o pai do logger ‘leitor.texto’, ‘leitor.html’ e ‘leitor.pdf’. Você pode nomear o logger do jeito que preferir, e indicar o trecho da aplicação que origina a mensagem de log.

Uma boa prática ao nomear loggers é criar, em cada módulo que usa logging, um logger definido no mesmo nível do módulo. Como no exemplo abaixo:

@example
logger = logging.getLogger(__name__)
@end example

Isso significa que os nomes dos loggers acompanham a hierarquia de pacotes e módulos, tornando intuitivo saber de onde os eventos foram registrados apenas olhando o nome do logger.

O início da hierarquia de loggers é chamado de logger raiz. É ele que é usado pelas funções @ref{2e40,,debug()}, @ref{2e6b,,info()}, @ref{2ff,,warning()}, @ref{2e7f,,error()} e @ref{2e80,,critical()}, que apenas chamam o método de mesmo nome dentro do logger raiz. Essas funções, e seus métodos correspondentes, têm a mesma assinatura (mesmos parâmetros aceitos). Na saída do log, o nome do logger raiz aparece como ‘root’.

É possível registrar mensagens de log em diferentes destinos. O pacote já traz suporte para enviar logs para arquivos, URLs via HTTP GET/POST, e-mails via SMTP, soquetes genéricos, filas ou mecanismos de log específicos do sistema operacional, como o syslog no Unix/Linux ou o Event Log do Windows NT. Esses destinos são gerenciados por classes chamadas manipuladores. Se precisar de um destino especial que não seja atendido pelos manipuladores embutidos, você poderá criar sua própria classe manipuladora para destinar corretamente o log.

Por padrão, nenhum destino é definido para nenhuma mensagem de registro. É possível especificar um destino (como console, ou arquivo) usando @ref{a08,,basicConfig()}, como nos exemplos do tutorial. Se você chamar as funções @ref{2e40,,debug()} , @ref{2e6b,,info()}, @ref{2ff,,warning()}, @ref{2e7f,,error()} e @ref{2e80,,critical()}, elas verificarão se o destino está definido; e, caso não esteja, elas definirão o console como o destino (@code{sys.stderr}) e definirão o formato utilizando um formato padrão. Só então, enviarão a mensagem ao logger raiz, para que seja registrada na saída.

O formato padrão definido por @ref{a08,,basicConfig()} para mensagens é:

@example
severity:logger name:message
@end example

Você pode alterar isso passando uma string de formato para @ref{a08,,basicConfig()}, através do argumento nomeado `format'. Para sobre como uma string de formato é construída, consulte @ref{2e5d,,Formatter Objects}.

@menu
* Fluxo de Logging:: 
* Registradores:: 
* Manipuladores:: 
* Formatadores:: 
* Configurando Logging:: 
* O que acontece se nenhuma configuração é fornecida:: 
* Configurando logging para uma biblioteca:: 

@end menu

@node Fluxo de Logging,Registradores,,Tutorial Avançado do Logging
@anchor{howto/logging logging-flow}@anchor{53a2}
@subsubsection Fluxo de Logging


O fluxo dos eventos de log em loggers e manipuladores é ilustrado no diagrama a seguir.

@image{python-figures/logging_flow,,,,png}

@node Registradores,Manipuladores,Fluxo de Logging,Tutorial Avançado do Logging
@anchor{howto/logging loggers}@anchor{53a3}
@subsubsection Registradores


Objetos @ref{b64,,Logger} têm três funções principais. Primeiro, eles expõem vários métodos para que o código da aplicação possa registrar mensagens durante a execução. Segundo, eles decidem quais mensagens de log devem ser processadas, com base no nível de severidade (é o filtro padrão) ou em objetos filtro. Terceiro, eles encaminham as mensagens de log relevantes para todos os manipuladores de log interessados.

Os métodos mais utilizados em objetos logger se enquadram em duas categorias: configuração e envio de mensagem.

Esses são os métodos de configuração mais comuns:


@itemize *

@item 
@ref{14db,,Logger.setLevel()} especifica o nível mínimo de severidade que um logger vai lidar. O nível DEBUG é o mais baixo, e o CRITICAL é o mais alto entre os níveis padrão. Por exemplo, se o nível do logger for INFO, ele vai processar apenas mensagens de nível INFO, WARNING, ERROR e CRITICAL, e vai ignorar mensagens DEBUG.

@item 
@ref{2e36,,Logger.addHandler()} e @ref{2e37,,Logger.removeHandler()} adicionam e removem objetos manipuladores do objeto logger. Manipuladores serão aprofundados em @ref{53a4,,Manipuladores}.

@item 
@ref{2e44,,Logger.addFilter()} e @ref{2e45,,Logger.removeFilter()} adicionam e removem objetos filtros do objeto logger. Filtros serão aprofundados em @ref{2e68,,Filter Objects}.
@end itemize

Você não precisa sempre invocar esses métodos em cada logger que criar. Consulte os últimos dois paragrafos nessa mesma seção.

Com o objeto logger configurado, os seguintes métodos criam mensagens de log:


@itemize *

@item 
@ref{e57,,Logger.debug()}, @ref{2e3f,,Logger.info()}, @ref{17f6,,Logger.warning()}, @ref{2e41,,Logger.error()} e @ref{e56,,Logger.critical()} criam logs com uma mensagem em um nível correspondente ao respectivo nome do método. A mensagem é uma string de formato, que pode conter a sintaxe padrão de substituições como @code{%s}, @code{%d} e @code{%f}. O restante dos argumentos são uma lista de objetos que correspondem aos campos de substituição da mensagem. No caso do parâmetro @code{**kwargs}, os métodos de logging cuidam apenas da chave @code{exc_info}. É essa chave que eles usam para decidir se devem ou não registrar os detalhes de uma exceção.

@item 
@ref{e55,,Logger.exception()} cria uma mensagem de log parecida com @ref{2e41,,Logger.error()}. A diferença é que, além da mensagem, @ref{e55,,Logger.exception()} também registra o stack trace (situação da pilha de execução). Chame este método apenas a partir de um manipulador de exceção.

@item 
@ref{e54,,Logger.log()} recebe o nível de log como um argumento explícito. Isso torna o registro de mensagens um pouco mais verboso do que usar os métodos prontos para cada nível, com os métodos listados anteriormente, mas é uma forma de registrar mensagens em níveis de log personalizados.
@end itemize

@ref{967,,getLogger()} retorna uma referência para uma instância de um logger com o nome especificado, caso informado, ou para o logger raiz (caso nenhum nome seja passado). Os nomes seguem uma estrutura hierárquica separada por pontos. Chamadas repetidas a @ref{967,,getLogger()} com o mesmo nome retornam sempre uma referência para a mesma instância do objeto logger. Loggers que aparecem mais embaixo na hierarquia são filhos dos loggers que estão mais acima nessa lista. Por exemplo, dado um logger com nome @code{foo}, loggers com os nomes @code{foo.bar}, @code{foo.bar.baz} e @code{foo.bam} serão todos descendentes de @code{foo}.

Loggers têm o conceito de nível efetivo. Se um logger não tiver um nível definido explicitamente, ele herdará o nível do seu logger pai. Caso o pai também não tenha um nível definido, o processo continua subindo na hierarquia, examinando cada ancestral, até encontrar um logger com nível configurado. O logger raiz sempre terá um nível explícito configurado (por padrão, @code{WARNING}). Ao decidir se um evento será processado, o logger usa o seu nível efetivo para determinar se o evento deve ser repassado para os manipuladores responsáveis.

Loggers filhos propagam suas mensagens para os manipuladores associados aos seus loggers ancestrais. Por causa disso, não é necessário definir e configurar manipuladores para todos os loggers usados em uma aplicação. Basta configurar os manipuladores em um logger de nível superior, e criar loggers filhos conforme a necessidade. No entanto, é possível desativar essa propagação definindo o atributo `propagate' do logger como @code{False}.

@node Manipuladores,Formatadores,Registradores,Tutorial Avançado do Logging
@anchor{howto/logging handler-basic}@anchor{53a4}@anchor{howto/logging handlers}@anchor{53a5}
@subsubsection Manipuladores


Objetos @ref{14de,,Handler} são responsáveis por enviar as mensagens de log apropriadas (com base na severidade de cada mensagem) para o destino especificado do manipulador. Objetos @ref{b64,,Logger} podem adicionar um ou mais manipuladores a si mesmos usando o método @ref{2e36,,addHandler()}. Em um cenário hipotético, uma aplicação pode querer “enviar todas as mensagens de log para um arquivo”, “enviar apenas mensagens de erro ou mais graves para o @cite{stdout}” e “enviar apenas mensagens críticas para um endereço de e-mail”. Esse cenário exigiria três manipuladores diferentes, cada um responsável por encaminhar mensagens de uma determinada gravidade para um destino específico.

A biblioteca padrão possui alguns tipos de manipuladores (veja @ref{53a6,,Handlers úteis}); os tutoriais usam principalmente @ref{1238,,StreamHandler} e @ref{19de,,FileHandler} em seus exemplos.

Existem pouquíssimos métodos em um manipulador com os quais desenvolvedores de aplicações precisam se preocupar. Para quem está usando manipuladores já inclusos na biblioteca (ou seja, sem criar manipuladores personalizados), os únicos métodos realmente relevantes são os métodos de configuração a seguir:


@itemize *

@item 
O método @ref{2e52,,setLevel()}, assim como acontece nos objetos logger, , define o menor nível de severidade das mensagens que serão encaminhadas para o destino adequado. Mas por que existem dois métodos @ref{2e52,,setLevel()}? Isso acontece porque o nível configurado no logger define quais mensagens ele vai repassar para seus manipuladores.  Já o nível configurado em cada manipulador define, entre as mensagens recebidas, quais realmente serão enviadas adiante.

@item 
@ref{2e53,,setFormatter()} define um objeto Formatador para que o manipulador utilize.

@item 
@ref{2e54,,addFilter()} e @ref{2e55,,removeFilter()}, respectivamente, adicionam e removem objetos filtros nos manipuladores.
@end itemize

O código da aplicação não deve instanciar nem usar diretamente objetos da classe @ref{14de,,Handler}. Na verdade, @ref{14de,,Handler} é uma classe base que define a interface que todos os manipuladores devem implementar e estabelece um comportamento padrão que pode ser aproveitado (ou sobrescrito) pelas classes filhas.

@node Formatadores,Configurando Logging,Manipuladores,Tutorial Avançado do Logging
@anchor{howto/logging formatters}@anchor{53a7}
@subsubsection Formatadores


Objetos Formatadores definem a ordem, a estrutura e o conteúdo final da mensagem de log. Diferentemente da classe base @ref{14de,,logging.Handler}, o código da aplicação pode instanciar classes de formatadores — embora também seja possível criar subclasses, caso sua aplicação precise de um comportamento específico. O construtor aceita três argumentos opcionais: uma string de formato da mensagem, uma string de formatação da data e um indicador de estilo.

@geindex __init__() (método logging.logging.Formatter)
@anchor{howto/logging logging logging Formatter __init__}@anchor{53a8}
@deffn {Método} logging.Formatter.__init__ (fmt=None, datefmt=None, style='%')
@end deffn

Se nenhuma string de formato for fornecida na mensagem, o padrão é usar a mensagem bruta. Se nenhuma string de formato de data for definida, o formato de data padrão será:

@example
%Y-%m-%d %H:%M:%S
@end example

com os milissegundos acrescentados ao final. O parâmetro @code{style} pode ser @code{'%'}, @code{'@{'} ou @code{'$'}. Se nenhum deles for especificado, o padrão utilizado será @code{'%'}.

Se o o parâmetro @code{style} for @code{'%'}, a string de formato da mensagem substituirá a string usando o estilo @code{%(<chave de dicionário>)s}; as chaves possíveis estão documentadas em @ref{2e3e,,Atributos LogRecord}. Se o estilo for @code{'@{'}, a string de formato é presumida como compatível com @ref{621,,str.format()} (usando argumentos nomeados). Já se o estilo for @code{'$'}, a string de formato deverá seguir o que é esperado por @ref{247e,,string.Template.substitute()}.


Alterado na versão 3.2: Adicionado o parâmetro @code{style}.


A string de formato a seguir vai escrever o tempo em um formato legível para humanos, a severidade da mensagem, e o conteúdo da mensagem, nessa ordem:

@example
'%(asctime)s - %(levelname)s - %(message)s'
@end example

Formatadores usam uma função configurável pelo usuário para converter o horário de criação de um registro em uma tupla. Por padrão, é utilizada a função @ref{1541,,time.localtime()};  Se você quiser alterar isso apenas para uma instância específica de formatador, basta definir o atributo @code{converter} dessa instância para uma função com a mesma assinatura de @ref{1541,,time.localtime()} ou @ref{1200,,time.gmtime()}. Já se a ideia for alterar o comportamento para todos os formatadores (por exemplo, para exibir todos os horários de log em GMT), defina o atributo @code{converter} diretamente na classe Formatadora (usando, por exemplo, @code{time.gmtime} para exibição em GMT).

@node Configurando Logging,O que acontece se nenhuma configuração é fornecida,Formatadores,Tutorial Avançado do Logging
@anchor{howto/logging configuring-logging}@anchor{53a9}
@subsubsection Configurando Logging


Programadores podem configurar logging de três formas:


@enumerate 

@item 
Criando loggers, manipuladores e formatadores de forma explícita, usando código Python que invoca os métodos de configuração mencionados acima.

@item 
Criando um arquivo de configuração de logging e lendo-o usando a função @ref{b66,,fileConfig()}.

@item 
Criando um dicionário com as informações de configuração e passando-o para a função @ref{11ef,,dictConfig()}.
@end enumerate

Para a documentação de referência sobre as duas últimas opções, consulte @ref{1335,,Funções de configuração}. O exemplo a seguir configura um logger bem simples, um manipulador de console e um formatador simples utilizando código Python:

@example
import logging

# cria o logger
logger = logging.getLogger('exemplo_simples')
logger.setLevel(logging.DEBUG)

# cria o manipulador de console e configura o nível para depuração
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# cria o formatador
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# adiciona o formatador ao manipulador
ch.setFormatter(formatter)

# adiciona o manipulador ao logger
logger.addHandler(ch)

# 'código' da aplicação
logger.debug('mensagem de depuração')
logger.info('mensagem informativa')
logger.warning('mensagem de alerta')
logger.error('mensagem de erro')
logger.critical('mensagem crítica')
@end example

A execução deste módulo pela linha de comando produz a seguinte saída:

@example
$ python simple_logging_module.py
2005-03-19 15:10:26,618 - exemplo_simples - DEBUG - mensagem de depuração
2005-03-19 15:10:26,620 - exemplo_simples - INFO - mensagem informativa
2005-03-19 15:10:26,695 - exemplo_simples - WARNING - mensagem de alerta
2005-03-19 15:10:26,697 - exemplo_simples - ERROR - mensagem de erro
2005-03-19 15:10:26,773 - exemplo_simples - CRITICAL - mensagem crítica
@end example

O módulo Python a seguir cria um logger, um manipulador e um formatador quase idênticos aos do exemplo mostrado acima, sendo a única diferença os nomes dos objetos:

@example
import logging
import logging.config

logging.config.fileConfig('logging.conf')

# criação do logger
logger = logging.getLogger('simpleExample')

# código da 'aplicação'
logger.debug('mensagem de debug')
logger.info('mensagem informativa')
logger.warning('mensagem de cuidado')
logger.error('mensagem de erro')
logger.critical('mensagem crítica')
@end example

Aqui está o arquivo logging.conf:

@example
[loggers]
keys=root,exemploSimples

[handlers]
keys=manipuladorConsole

[formatters]
keys=formatadorSimples

[logger_root]
level=DEBUG
handlers=manipuladorConsole

[logger_exemploSimples]
level=DEBUG
handlers=manipuladorConsole
qualname=exemploSimples
propagate=0

[handler_manipuladorConsole]
class=StreamHandler
level=DEBUG
formatter=formatadorSimples
args=(sys.stdout,)

[formatter_formatadorSimples]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
@end example

A saída é quase idêntica à do exemplo não baseado em arquivo de configuração:

@example
$ python simple_logging_config.py
2005-03-19 15:38:55,977 - exemploSimples - DEBUG - mensagem de depuração
2005-03-19 15:38:55,979 - exemploSimples - INFO - mensagem informativa
2005-03-19 15:38:56,054 - exemploSimples - WARNING - mensagem de alerta
2005-03-19 15:38:56,055 - exemploSimples - ERROR - mensagem de erro
2005-03-19 15:38:56,130 - exemploSimples - CRITICAL - mensagem crítica
@end example

A abordagem de usar um arquivo de configuração oferece algumas vantagens em relação ao uso direto de código Python. Ela permite separar a configuração do código, facilitando a manutenção, e também possibilita que pessoas sem conhecimentos de programação modifiquem facilmente as propriedades de logging apenas editando o arquivo de configuração.

@cartouche
@quotation Aviso 
A função @ref{b66,,fileConfig()} possui um parâmetro chamado @code{disable_existing_loggers}, que por padrão é definido como @code{True} por questões de retrocompatibilidade. No entanto, esse comportamento pode não ser o desejado, pois todos os loggers que não o raiz que já existiam antes da chamada de @ref{b66,,fileConfig()} serão desativados, a menos que eles (ou algum de seus ancestrais) sejam explicitamente nomeados na configuração. Caso queira manter os loggers preexistentes ativos, basta definir esse parâmetro como @code{False}. Para maiores detalhes, consulte a documentação oficial de referência.

O dicionário passado para @ref{11ef,,dictConfig()} também pode especificar um valor booleano com a chave @code{disable_existing_loggers}. Se essa chave não for definida explicitamente no dicionário, o valor padrão será interpretado como @code{True}. Isso resulta no mesmo comportamento de desativação de loggers descrito anteriormente, o que pode não ser o desejado. Nesse caso, basta informar a chave no dicionário com o valor @code{False}.
@end quotation
@end cartouche

Observe que os nomes de classe referenciados em arquivos de configuração precisam ser relativos ao módulo logging, ou valores absolutos que possam ser resolvidos pelos mecanismos normais de importação do Python. Por exemplo, você pode usar @ref{2ec0,,WatchedFileHandler} (relativo ao módulo logging) ou @code{mypackage.mymodule.MyHandler} (para uma classe definida no pacote @code{mypackage} e no módulo @code{mymodule}, desde que @code{mypackage} esteja disponível no caminho de importação do Python).

A partir do Python 3.2, foi introduzida uma nova forma de configurar o logging, utilizando dicionários para armazenar as informações de configuração. Essa abordagem oferece um conjunto ampliado de funcionalidades em relação ao método baseado em arquivos de configuração mencionado anteriormente, sendo, portanto, a forma recomendada de configuração para novas aplicações e implantações. Como a configuração é mantida em um dicionário Python, há maior flexibilidade sobre as opções de como esse dicionário pode ser construído. É possível, por exemplo, utilizar um arquivo em formato JSON ou YAML, construir o dicionário diretamente em código Python, recebê-lo em forma serializada com pickle por meio de um soquete, ou ainda empregar qualquer outro método que faça sentido para a aplicação em questão.

Aqui está um exemplo da mesma configuração acima, em formato YAML, para a nova abordagem baseada em dicionário:

@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 mais informações sobre logging com dicionário, consulte @ref{1335,,Funções de configuração}.

@node O que acontece se nenhuma configuração é fornecida,Configurando logging para uma biblioteca,Configurando Logging,Tutorial Avançado do Logging
@anchor{howto/logging what-happens-if-no-configuration-is-provided}@anchor{53aa}
@subsubsection O que acontece se nenhuma configuração é fornecida


Se nenhuma configuração de logging for fornecida, pode ocorrer uma situação em que um evento de logging precise ser registrado, mas nenhum manipulador esteja disponível para processar e exibir esse evento.

O evento é exibido utilizando um “manipulador de último recurso”, armazenado em @ref{123a,,lastResort}. Esse manipulador interno não está associado a nenhum logger e funciona como um @ref{1238,,StreamHandler}, enviando a mensagem de descrição do evento para o valor atual de @code{sys.stderr} (espeitando, portanto, quaisquer redirecionamentos que estejam em vigor). Nenhuma formatação é aplicada à mensagem — apenas a descrição bruta do evento é impressa. O nível desse manipulador é definido como @code{WARNING}, de forma que todos os eventos nesse nível ou em níveis mais severos serão exibidos.


Alterado na versão 3.2: Para versões do Python anteriores à 3.2, o comportamento é o seguinte:


@itemize *

@item 
Se @ref{1239,,raiseExceptions} for @code{False} (modo em produção), o evento será silenciosamente descartado.

@item 
Se @ref{1239,,raiseExceptions} for definido como @code{True} (modo de desenvolvimento), a mensagem ‘No handlers could be found for logger X.Y.Z’ será exibida uma vez.
@end itemize

Para obter o comportamento pré-versão-3.2, @ref{123a,,lastResort} pode ser definido como @code{None}.


@node Configurando logging para uma biblioteca,,O que acontece se nenhuma configuração é fornecida,Tutorial Avançado do Logging
@anchor{howto/logging configuring-logging-for-a-library}@anchor{53ab}@anchor{howto/logging library-config}@anchor{2ebd}
@subsubsection Configurando logging para uma biblioteca


Ao desenvolver um biblioteca que usa logging, é importante documentar como a biblioteca usa o recurso - por exemplo, os nomes dos loggers usados. Também é necessário levar em consideração a configuração de logging. Caso a aplicação que utiliza a biblioteca não faça uso de logging e o código da biblioteca execute chamadas de logging, então os eventos de severidade @code{WARNING} e níveis mais severos serão impressos em @code{sys.stderr} .(conforme descrito na seção anterior). Isso garante que mensagens importantes não sejam perdidas, como comportamento padrão, mesmo que a aplicação principal não configure explicitamente o sistema de logging.

Se, por algum motivo, você `não' quiser que essas mensagens sejam exibidas na ausência de qualquer configuração de logging, pode anexar um manipulador que não faz nada ao logger de nível superior da sua biblioteca. Dessa forma, evita-se que a mensagem seja impressa, já que sempre haverá um manipulador associado aos eventos da biblioteca — apenas não produzirá saída. Caso o usuário da biblioteca configure o logging para uso na aplicação, essa configuração provavelmente incluirá alguns manipuladores adicionais e, se os níveis forem configurados adequadamente, as chamadas de logging feitas no código da biblioteca enviarão a saída para esses manipuladores, funcionando normalmente.

Um manipulador-que-não-faz-nada já está incluso no pacote @ref{12c6,,NullHandler} (desde Python 3.1). Uma instância desse manipulador poderia ser adicionado ao logger de nível superior do espaço de nomes  de logging usado pelo biblioteca (`se' você quiser evitar que os eventos registrados do biblioteca sejam enviados para @code{sys.stderr}, na ausência de configuração de logging). Se todo registro em log de uma biblioteca `foo' for feito usando loggers com nomes correspondente ‘foo.x’, ‘foo.x.y’ etc., então o código:

@example
import logging
logging.getLogger('foo').addHandler(logging.NullHandler())
@end example

deve resultar no efeito desejado. Se uma organização produzir vários bibliotecas, o nome do logger especificado poderá ser ‘orgname.foo’ em vez de apenas ‘foo’.

@cartouche
@quotation Nota 
É altamente recomendável que você `não registre logs no logger raiz' do seu biblioteca. Em vez disso, use um logger com um nome exclusivo e facilmente identificável, como o @code{__name__} do nível superior do seu pacote/módulo da biblioteca. O registro em log no logger raiz dificultará, ou mesmo tornará impossível que o desenvolvedor da aplicação personalize o manipulador e a verbosidade de logging.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
É altamente recomendável que você `não adicione outros manipuladores além de' @ref{12c6,,NullHandler} `nos loggers da sua biblioteca'. Isso porque a configuração de manipuladores é responsabilidade do desenvolvedor da aplicação que utilizará ela. O desenvolvedor sabe o público-alvo da aplicação final, e, portanto, sabe também quais são os manipuladores mais adequados para o caso. Se você adicionar manipuladores ‘ocultos’, poderá interferir na criação de testes unitários e na entrega de logs úteis.
@end quotation
@end cartouche

@node Níveis de Logging<2>,Handlers úteis,Tutorial Avançado do Logging,Logging
@anchor{howto/logging logging-levels}@anchor{53ac}
@subsection Níveis de Logging


Os valores numéricos dos níveis de logging estão listados na tabela abaixo. Eles são principalmente de interesse se você quiser definir seus próprios níveis, e precisa deles para definir seus valores específicos relativos aos níveis predefinidos. Se você define um nível com o mesmo valor numérico, ele sobrescreve o valor predefinido; o nome predefinido é perdido.


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Nível

@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


Os níveis também podem ser associados aos registradores, sendo definidos pelo desenvolvedor ou por meio do carregamento de uma configuração salva. Quando um método de logging é invocado em um logger, o logger compara o seu próprio nível com o nível associado à chamada do método. Se o nível do logger for maior do que o da chamada do método, nenhuma mensagem será gerada. Esse é o mecanismo básico que controla a verbosidade da saída de logging.

As mensagens de logging são representadas como instâncias da classe @ref{101c,,LogRecord}. Quando um logger decide registrar um evento, uma instância de @ref{101c,,LogRecord} é criada a partir da mensagem de logging.

As mensagens de logging passam por um mecanismo de despacho que utiliza `manipuladores', que são instâncias de subclasses da classe @ref{14de,,Handler}. Manipuladores são responsáveis por assegurar que uma mensagem registrada em log (na forma de @ref{101c,,LogRecord}) seja encaminhada para um determinado destino (ou conjunto de destinos) que serão úteis para o público-alvo daquela mensagem (como usuários finais, equipe de suporte, administradores do sistema e desenvolvedores). Manipuladores transmitem @ref{101c,,LogRecord} para destinos específicos. Cada logger pode ter zero, um ou mais manipuladores associados à ele (através do método @ref{2e36,,addHandler()} de @ref{b64,,Logger}). Além disso, não são apenas os manipuladores diretamente associados a um logger que processam a mensagem. Por padrão, os manipuladores de todos os loggers ancestrais também participam do despacho. Essa propagação só é interrompida se o atributo `propagate' do logger estiver definido como @code{False}.

Assim como os loggers, os manipuladores também podem ter níveis associados. O nível de um manipulador funciona como um filtro, do mesmo modo que o nível de um logger. Quando um manipulador decide processar um evento, ele utiliza o método @ref{2e5b,,emit()} para enviar a mensagem ao seu destino. Na maioria dos casos, subclasses personalizadas de @ref{14de,,Handler} precisarão substituir esse método @ref{2e5b,,emit()}.

@menu
* Níveis personalizados:: 

@end menu

@node Níveis personalizados,,,Níveis de Logging<2>
@anchor{howto/logging custom-levels}@anchor{2e84}@anchor{howto/logging id2}@anchor{53ad}
@subsubsection Níveis personalizados


Criar seus próprios níveis é possível, mas não deve ser necessário, pois os níveis existentes foram escolhidos com base na experiência prática. No entanto, se for estritamente necessário, tome cuidado para fazer. E se você está `desenvolvendo uma biblioteca, não é recomendado que defina níveis personalizados'. Isso porque, se vários autores de biblioteca definirem seus próprios níveis personalizados, as saídas de logging das bibliotecas em conjunto serão orquestradas com maior dificuldade pelo desenvolvedor, pois um determinado valor numérico poderá significar coisas diferentes para diferentes bibliotecas.

@node Handlers úteis,Exceções levantadas durante logging,Níveis de Logging<2>,Logging
@anchor{howto/logging id3}@anchor{53ae}@anchor{howto/logging useful-handlers}@anchor{53a6}
@subsection Handlers úteis


Em adição à classe base @ref{14de,,Handler}, muitas subclasses úteis são fornecidas:


@enumerate 

@item 
@ref{1238,,StreamHandler}, quando instanciadas, enviam mensagens para streams (objeto arquivo ou similar).

@item 
@ref{19de,,FileHandler}, quando instanciadas, enviam mensagens para arquivos locais de disco.

@item 
@ref{2ec4,,BaseRotatingHandler} é a classe base para objetos handler que rotacionam os arquivos de logging em um determinado ponto. Não é feita para ser instanciada diretamente. Em vez disso, use @ref{16c2,,RotatingFileHandler} ou @ref{f95,,TimedRotatingFileHandler}.

@item 
@ref{16c2,,RotatingFileHandler}, quando instanciadas, enviam mensagens para arquivos locais de disco. Permite definir o tamanho máximo do arquivo de log e configurar rotação.

@item 
@ref{f95,,TimedRotatingFileHandler}, quando instanciadas, enviam mensagens para arquivos locais de disco, rotacionando o arquivo de log em certos intervalos de tempo.

@item 
@ref{f96,,SocketHandler}, quando instanciadas, enviam mensagens para soquetes TCP/IP. Desde a versão 3.4, os soquetes de domínio Unix também são suportados.

@item 
@ref{f97,,DatagramHandler}, quando instanciadas, enviam mensagens para soquetes UDP. Desde a versão 3.4, os soquetes de domínio Unix também são suportados.

@item 
@ref{164e,,SMTPHandler}, quando instanciadas, enviam mensagens para endereços de e-mail pré-definidos.

@item 
@ref{65c,,SysLogHandler}, quando instanciadas, enviam mensagens para um daemon syslog Unix, normalmente em um computador remoto.

@item 
@ref{2eea,,NTEventLogHandler}, quando instanciadas, enviam mensagens para um registro de log do Windows NT/2000/XP.

@item 
@ref{2ea3,,MemoryHandler}, quando instanciadas, enviam mensagens para um buffer na memória, que é liberado sempre que alguns critérios específicos são atendidos.

@item 
@ref{e58,,HTTPHandler}, quando instanciadas, enviam mensagens para um servidor HTTP, utilizando os métodos @code{GET} ou @code{POST}.

@item 
@ref{2ec0,,WatchedFileHandler}, quando instanciadas, observam o arquivo que estão fazendo logging. Se o arquivo for alterado, ele será fechado e reaberto com o mesmo nome. Este manipulador só é funcional em sistemas Unix ou similares; o Windows não oferece suporte ao mecanismo subjacente utilizado.

@item 
@ref{18ec,,QueueHandler}, quando instanciadas, enviam mensagem para uma fila, que pode ser implementada com o módulo @ref{b6,,queue} ou com o módulo @ref{94,,multiprocessing}.

@item 
@ref{12c6,,NullHandler}, quando instanciadas, não fazem nada com as mensagens de erro. Elas são usadas por desenvolvedores da biblioteca que precisam usar o logging, mas querem evitar o aviso ‘No handlers could be found for logger `XXX'’, que pode ser exibido quando o logging não é configurado. Veja @ref{2ebd,,Configurando logging para uma biblioteca} para mais informações.
@end enumerate


Adicionado na versão 3.1: A classe @ref{12c6,,NullHandler}.



Adicionado na versão 3.2: A classe @ref{18ec,,QueueHandler}.


As subclasses @ref{12c6,,NullHandler}, @ref{1238,,StreamHandler} e @ref{19de,,FileHandler} são definidas no pacote base de logging. Os outros manipuladores são definidos no submódulo @ref{89,,logging.handlers}. (Existe também outro submódulo, @ref{88,,logging.config}, para configurar as funcionalidades).

As mensagens de log são formatadas por meio de instâncias da classe @ref{14df,,Formatter}. Elas são inicializadas com uma string de formato, que pode ser usada junto com o operador % e um dicionário para substituir os valores na mensagem.

Para formatar várias mensagens em um lote, podem ser usadas instâncias de @ref{2e64,,BufferingFormatter}. Além de aplicar string de formato em cada mensagem do lote, é possível definir strings de formato para o cabeçalho e o rodapé do lote.

Quando não for suficiente fazer a filtragem baseada no nível do logger e/ou no nível de manipulador, instâncias de @ref{123b,,Filter} poderão ser adicionadas às instâncias de @ref{b64,,Logger} e @ref{14de,,Handler} (por meio do método @ref{2e54,,addFilter()}). Antes de processar uma mensagem, os loggers e manipuladores consultam todos os seus filtros para obter permissão. Se algum filtro retornar um valor falso, a mensagem não é processada.

A funcionalidade básica do @ref{123b,,Filter} permite a filtragem por um nome específico de logger. Se este recurso for usado, as mensagens enviadas para o logger com esse nome, ou seus descendentes, serão permitidas pelo filtro. E todas as outras são descartadas.

@node Exceções levantadas durante logging,Usando objetos arbitrários como mensagens,Handlers úteis,Logging
@anchor{howto/logging exceptions-raised-during-logging}@anchor{53af}@anchor{howto/logging logging-exceptions}@anchor{53b0}
@subsection Exceções levantadas durante logging


O pacote de logging foi projetado para inibir exceções que possam ocorrer quando os registros forem feitos em produção. Desta forma, a aplicação que está utilizando logging não encerrará abruptamente caso hajam erros nos eventos de logging  - devido a problemas como má configuração, rede ou outros.

As exceções @ref{d63,,SystemExit} e @ref{9d9,,KeyboardInterrupt} nunca são inibidas. Outras exceções que possam ocorrem durante o método @ref{2e5b,,emit()} de uma subclasse de @ref{14de,,Handler} são passadas para seus respectivos métodos @ref{2e5a,,handleError()}.

A implementação padrão de @ref{2e5a,,handleError()} em @ref{14de,,Handler} verifica se uma variável de módulo, @ref{1239,,raiseExceptions}, está definida. Caso esteja, um traceback (situação da pilha de execução) é exibido em @ref{940,,sys.stderr}. Se não, a exceção é inibida.

@cartouche
@quotation Nota 
O valor padrão de @ref{1239,,raiseExceptions} é @code{verdadeiro}. Isso ocorre porque, durante o desenvolvimento, você normalmente desejará ser notificado sobre qualquer exceção que ocorra. É recomendável que você defina @ref{1239,,raiseExceptions} como @code{falso} para usos em produção.
@end quotation
@end cartouche

@node Usando objetos arbitrários como mensagens,Optimização,Exceções levantadas durante logging,Logging
@anchor{howto/logging arbitrary-object-messages}@anchor{2e70}@anchor{howto/logging using-arbitrary-objects-as-messages}@anchor{53b1}
@subsection Usando objetos arbitrários como mensagens


Nas seções e exemplos anteriores, todas as mensagens criadas ao realizar o logging de um evento foram instanciadas como string. No entanto, essa não é a única possibilidade. Você pode passar um objeto arbitrário como mensagem, e seu método @ref{61d,,__str__()} será chamado quando o sistema de logging precisar convertê-lo em uma string. Inclusive, é possível evitar totalmente o uso de uma representação em string - por exemplo, a classe @ref{f96,,SocketHandler} emite a mensagem enviando pela rede sua respectiva serialização com pickle.

@node Optimização,Outros recursos<2>,Usando objetos arbitrários como mensagens,Logging
@anchor{howto/logging optimization}@anchor{53b2}
@subsection Optimização


A formatação dos argumentos das mensagem é adiada até o quanto for possível. No entanto, o processamento dos argumentos para o método de logging pode ser custoso,  e talvez você queira evitar fazê-lo, se o logging for descartar o evento. Para decidir o que fazer, você pode chamar o método @ref{133a,,isEnabledFor()}, que recebe um nível como argumento e retorna verdadeiro apenas se o evento tiver sido criado pelo logger para esse nível em específico. Desta forma, você pode escrever algo como:

@example
if logger.isEnabledFor(logging.DEBUG):
    logger.debug('Mensagem com %s, %s', func_custosa1(),
                                        func_custosa2())
@end example

desta forma, se o limite do logger for definido acima de @code{DEBUG}, as chamadas para @code{func_custosa1}  e @code{func_custosa2} nunca serão feitas.

@cartouche
@quotation Nota 
Em alguns casos, o próprio @ref{133a,,isEnabledFor()} pode ser mais custoso do que você gostaria (por exemplo, para loggers profundamente aninhados, em que um nível explícito só é definido no logger mais alto da hierarquia). Nesses casos (ou se você quiser evitar chamar um método em um laço), é possível cachear o resultado de uma chamada para @ref{133a,,isEnabledFor()} em uma variável local ou instância, e usá-lo em vez de chamar o método todas as vezes. Este valor armazenado só precisaria ser recalculado se a configuração do logger fosse alterada dinamicamente, com a aplicação em execução (o que não é comum).
@end quotation
@end cartouche

Existem outras otimizações que podem ser feitas para aplicação específicas que precisam de um controle mais preciso sobre quais informações de logging são registradas. Abaixo encontra-se uma lista de coisas que você pode fazer para evitar o processamento desnecessário para loggings que serão descartados:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

O que você não quer registrar

@tab

Como evitar o registro

@item

Informações sobre o ponto em que as chamadas foram feitas.

@tab

Defina @code{logging._srcfile} como @code{None}. Isso evita chamar @ref{6e1,,sys._getframe()}, o que pode acelerar seu código em ambientes como o PyPy (que não consegue acelerar códigos que usam @ref{6e1,,sys._getframe()}).

@item

Informações sobre threading.

@tab

Defina @code{logging.logThreads} como @code{False}.

@item

ID do processo atual (@ref{2ce1,,os.getpid()})

@tab

Defina @code{logging.logProcesses} como @code{False}.

@item

Nome do processo atual, ao utilizar o módulo @code{multiprocessing} para gerenciar múltiplos processamentos.

@tab

Defina @code{logging.logMultiprocessing} como @code{False}.

@item

Nome da tarefa @ref{1be,,asyncio.Task} atual, ao utilizar o módulo @code{asyncio}.

@tab

Defina @code{logging.logAsyncioTasks} como @code{False}.

@end multitable


Observe também que o módulo base de logging inclui apenas o manipulador básico. Se você não importar @ref{89,,logging.handlers} e @ref{88,,logging.config}, eles não ocuparão nenhum espaço da memória.

@node Outros recursos<2>,,Optimização,Logging
@anchor{howto/logging other-resources}@anchor{53b3}@anchor{howto/logging tutorial-ref-links}@anchor{5397}
@subsection Outros recursos



@subsubheading Ver também



@table @asis

@item Módulo @ref{87,,logging}

Referência da API para o módulo de logging.

@item Módulo @ref{88,,logging.config}

API de configuração para o módulo logging.

@item Módulo @ref{89,,logging.handlers}

Tratadores úteis incluídos no módulo logging.
@end table

@ref{1237,,Um livro de receitas do logging}


@node Livro de receitas do logging,Expressões Regulares,Logging,Python HOWTOs
@anchor{howto/logging-cookbook doc}@anchor{53b4}@anchor{howto/logging-cookbook id1}@anchor{53b5}@anchor{howto/logging-cookbook logging-cookbook}@anchor{1237}@anchor{howto/logging-cookbook translation-repo}@anchor{53b6}
@section Livro de receitas do logging


@*Autor: 
Vinay Sajip <vinay_sajip at red-dove dot com>


Esta página contém uma série de receitas relacionadas ao registro de eventos, que foram considerados úteis no passado. Para obter links para tutoriais e outras referências, veja @ref{53b7,,Outros recursos}

@menu
* Usando logging em vários módulos:: 
* Registro de eventos de várias threads:: 
* Múltiplos manipuladores e formatadores:: 
* Logging to multiple destinations:: 
* Custom handling of levels:: 
* Configuration server example:: 
* Dealing with handlers that block:: 
* Sending and receiving logging events across a network:: 
* Adding contextual information to your logging output:: 
* Use of contextvars:: 
* Imparting contextual information in handlers:: 
* Logging to a single file from multiple processes:: 
* Using file rotation:: 
* Use of alternative formatting styles:: 
* Personalizando o LogRecord:: 
* Subclassing QueueHandler and QueueListener- a ZeroMQ example:: 
* Subclassing QueueHandler and QueueListener- a pynng example:: 
* An example dictionary-based configuration:: 
* Using a rotator and namer to customize log rotation processing:: 
* A more elaborate multiprocessing example:: 
* Inserting a BOM into messages sent to a SysLogHandler:: 
* Implementing structured logging:: 
* Customizing handlers with dictConfig(): Customizing handlers with dictConfig. 
* Using particular formatting styles throughout your application:: 
* Configuring filters with dictConfig(): Configuring filters with dictConfig. 
* Customized exception formatting:: 
* Speaking logging messages:: 
* Buffering logging messages and outputting them conditionally:: 
* Sending logging messages to email@comma{} with buffering: Sending logging messages to email with buffering. 
* Formatting times using UTC (GMT) via configuration: Formatting times using UTC GMT via configuration. 
* Using a context manager for selective logging:: 
* A CLI application starter template:: 
* A Qt GUI for logging:: 
* Logging to syslog with RFC5424 support:: 
* How to treat a logger like an output stream:: 
* How to uniformly handle newlines in logging output:: 
* Patterns to avoid:: 
* Outros recursos: Outros recursos<3>. 

@end menu

@node Usando logging em vários módulos,Registro de eventos de várias threads,,Livro de receitas do logging
@anchor{howto/logging-cookbook using-logging-in-multiple-modules}@anchor{53b8}
@subsection Usando logging em vários módulos


Várias chamadas para @code{logging.getLogger('someLogger')} retorna a referência para o mesmo objeto logger.  Isso é verdadeiro não apenas dentro do mesmo módulo, mas também entre módulo, desde que esteja no mesmo processo do interpretador Python. Isso é verdadeiro para referências do mesmo objeto; além disso, o código da aplicação pode definir e configurar um logger pai em um módulo e criar (mas não configurar) um logger filho em um módulo separado, e todas as chamadas de logger para o filho passarão para o pai.  Aqui está um módulo principal:

@example
import logging
import auxiliary_module

# cria objeto logger com 'spam_application'
logger = logging.getLogger('spam_application')
logger.setLevel(logging.DEBUG)
# cria manipulador de arquivo que registra até mesmo mensagens de debug
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# cria manipulador de console com um nível de registro mais alto
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# cria formatador  e adiciona aos manipuladores
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# adiciona os manipuladores ao 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

Aqui está o módulo auxiliar:

@example
import logging

# cria 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

O resultado deve ser algo assim:

@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 Registro de eventos de várias threads,Múltiplos manipuladores e formatadores,Usando logging em vários módulos,Livro de receitas do logging
@anchor{howto/logging-cookbook logging-from-multiple-threads}@anchor{53b9}
@subsection Registro de eventos de várias threads


O registro de eventos de várias threads não requer nenhum esforço especial. O exemplo a seguir mostra o registro de eventos da thread principal (inicial) thread e de outra thread:

@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

Quando executado, o script deve exibir algo como o seguinte:

@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

Isso mostra a saída de registro intercalada, como seria de se esperar. Essa abordagem funciona para mais thread do que o mostrado aqui, é claro.

@node Múltiplos manipuladores e formatadores,Logging to multiple destinations,Registro de eventos de várias threads,Livro de receitas do logging
@anchor{howto/logging-cookbook multiple-handlers-and-formatters}@anchor{53ba}
@subsection Múltiplos manipuladores e formatadores


Registradores (loggers) são objetos Python simples.  O método @ref{2e36,,addHandler()} não tem cota mínima ou máxima para o número de manipuladores que podem ser adicionados.  Às vezes, é vantajoso para um aplicação registrar todas as mensagens de todas as gravidades em um arquivo texto e, ao mesmo tempo, registrar erro ou superior no console.  Para definir isso, basta configurar os manipuladores apropriados.  As chamadas de registro no código da aplicação permanecerão inalteradas.  Aqui está uma pequena modificação no exemplo anterior de configuração simples baseada em módulo:

@example
import logging

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# cria manipulador de arquivo que regitra até mensagens de depuração
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# cria manipulador de console com um nível de gravidade mais alto
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# cria formatador e adiciona-o ao manipulador
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# adiciona os manipuladores ao registrador
logger.addHandler(ch)
logger.addHandler(fh)

# código da 'aplicação'
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

Observe que o código da ‘aplicação’ não se preocupa com vários manipuladores.  Tudo o que mudou foi a adição e a configuração de um novo manipulador nomeado `fh'.

A capacidade de criar novos manipuladores com filtros de severidade superiores ou inferiores pode ser muito útil ao escrever e testar um aplicação. Em vez de usar muitas instruções   instrução para depuração, use @code{logger.debug}: diferentemente da instrução print, que você terá de excluir ou comentar posteriormente, a instrução  logger.debug pode permanecer intacta no código-fonte e ficar inativo até que você precise dela novamente. Nesse momento, a única alteração que precisa ser feita é modificar o nível de severidade do registrador e/ou manipulador para depuração.

@node Logging to multiple destinations,Custom handling of levels,Múltiplos manipuladores e formatadores,Livro de receitas do logging
@anchor{howto/logging-cookbook logging-to-multiple-destinations}@anchor{53bb}@anchor{howto/logging-cookbook multiple-destinations}@anchor{53bc}
@subsection Logging to multiple destinations


Let’s say you want to log to console and file with different message formats and
in differing circumstances. Say you want to log messages with levels of DEBUG
and higher to file, and those messages at level INFO and higher to the console.
Let’s also assume that the file should contain timestamps, but the console
messages should not. Here’s how you can achieve this:

@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

When you run this, on the console you will see

@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

and in the file you will see something like

@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

As you can see, the DEBUG message only shows up in the file. The other messages
are sent to both destinations.

This example uses console and file handlers, but you can use any number and
combination of handlers you choose.

Note that the above choice of log filename @code{/tmp/myapp.log} implies use of a
standard location for temporary files on POSIX systems. On Windows, you may need to
choose a different directory name for the log - just ensure that the directory exists
and that you have the permissions to create and update files in it.

@node Custom handling of levels,Configuration server example,Logging to multiple destinations,Livro de receitas do logging
@anchor{howto/logging-cookbook custom-handling-of-levels}@anchor{53bd}@anchor{howto/logging-cookbook custom-level-handling}@anchor{53be}
@subsection Custom handling of levels


Sometimes, you might want to do something slightly different from the standard
handling of levels in handlers, where all levels above a threshold get
processed by a handler. To do this, you need to use filters. Let’s look at a
scenario where you want to arrange things as follows:


@itemize *

@item 
Send messages of severity @code{INFO} and @code{WARNING} to @code{sys.stdout}

@item 
Send messages of severity @code{ERROR} and above to @code{sys.stderr}

@item 
Send messages of severity @code{DEBUG} and above to file @code{app.log}
@end itemize

Suppose you configure logging with the following 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

and changing the section on the @code{stdout} handler to add it:

@example
@{
    "stdout": @{
        "class": "logging.StreamHandler",
        "level": "INFO",
        "formatter": "simple",
        "stream": "ext://sys.stdout",
        "filters": ["warnings_and_below"]
    @}
@}
@end example

A filter is just a function, so we can define the @code{filter_maker} (a factory
function) as follows:

@example
def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter
@end example

This converts the string argument passed in to a numeric level, and returns a
function which only returns @code{True} if the level of the passed in record is
at or below the specified level. Note that in this example I have defined the
@code{filter_maker} in a test script @code{main.py} that I run from the command line,
so its module will be @code{__main__} - hence the @code{__main__.filter_maker} in the
filter configuration. You will need to change that if you define it in a
different module.

With the filter added, we can run @code{main.py}, which in full is:

@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

And after running it like this:

@example
python main.py 2>stderr.log >stdout.log
@end example

We can see the results are as expected:

@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 Configuration server example,Dealing with handlers that block,Custom handling of levels,Livro de receitas do logging
@anchor{howto/logging-cookbook configuration-server-example}@anchor{53bf}
@subsection Configuration server example


Here is an example of a module using the logging configuration server:

@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

And here is a script that takes a filename and sends that file to the server,
properly preceded with the binary-encoded length, as the new logging
configuration:

@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 Dealing with handlers that block,Sending and receiving logging events across a network,Configuration server example,Livro de receitas do logging
@anchor{howto/logging-cookbook blocking-handlers}@anchor{3601}@anchor{howto/logging-cookbook dealing-with-handlers-that-block}@anchor{53c0}
@subsection Dealing with handlers that block


Sometimes you have to get your logging handlers to do their work without
blocking the thread you’re logging from. This is common in web applications,
though of course it also occurs in other scenarios.

A common culprit which demonstrates sluggish behaviour is the
@ref{164e,,SMTPHandler}: sending emails can take a long time, for a
number of reasons outside the developer’s control (for example, a poorly
performing mail or network infrastructure). But almost any network-based
handler can block: Even a @ref{f96,,SocketHandler} operation may do a
DNS query under the hood which is too slow (and this query can be deep in the
socket library code, below the Python layer, and outside your control).

One solution is to use a two-part approach. For the first part, attach only a
@ref{18ec,,QueueHandler} to those loggers which are accessed from
performance-critical threads. They simply write to their queue, which can be
sized to a large enough capacity or initialized with no upper bound to their
size. The write to the queue will typically be accepted quickly, though you
will probably need to catch the @ref{3351,,queue.Full} exception as a precaution
in your code. If you are a library developer who has performance-critical
threads in their code, be sure to document this (together with a suggestion to
attach only @code{QueueHandlers} to your loggers) for the benefit of other
developers who will use your code.

The second part of the solution is @ref{e59,,QueueListener}, which has been
designed as the counterpart to @ref{18ec,,QueueHandler}.  A
@ref{e59,,QueueListener} is very simple: it’s passed a queue and some handlers,
and it fires up an internal thread which listens to its queue for LogRecords
sent from @code{QueueHandlers} (or any other source of @code{LogRecords}, for that
matter). The @code{LogRecords} are removed from the queue and passed to the
handlers for processing.

The advantage of having a separate @ref{e59,,QueueListener} class is that you
can use the same instance to service multiple @code{QueueHandlers}. This is more
resource-friendly than, say, having threaded versions of the existing handler
classes, which would eat up one thread per handler for no particular benefit.

An example of using these two classes follows (imports omitted):

@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

which, when run, will produce:

@example
MainThread: Look out!
@end example

@cartouche
@quotation Nota 
Although the earlier discussion wasn’t specifically talking about
async code, but rather about slow logging handlers, it should be noted that
when logging from async code, network and even file handlers could lead to
problems (blocking the event loop) because some logging is done from
@ref{a,,asyncio} internals. It might be best, if any async code is used in an
application, to use the above approach for logging, so that any blocking code
runs only in the @code{QueueListener} thread.
@end quotation
@end cartouche


Alterado na versão 3.5: Prior to Python 3.5, the @ref{e59,,QueueListener} always passed every message
received from the queue to every handler it was initialized with. (This was
because it was assumed that level filtering was all done on the other side,
where the queue is filled.) From 3.5 onwards, this behaviour can be changed
by passing a keyword argument @code{respect_handler_level=True} to the
listener’s constructor. When this is done, the listener compares the level
of each message with the handler’s level, and only passes a message to a
handler if it’s appropriate to do so.


@node Sending and receiving logging events across a network,Adding contextual information to your logging output,Dealing with handlers that block,Livro de receitas do logging
@anchor{howto/logging-cookbook network-logging}@anchor{53c1}@anchor{howto/logging-cookbook sending-and-receiving-logging-events-across-a-network}@anchor{53c2}
@subsection Sending and receiving logging events across a network


Let’s say you want to send logging events across a network, and handle them at
the receiving end. A simple way of doing this is attaching a
@ref{f96,,SocketHandler} instance to the root logger at the sending end:

@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

At the receiving end, you can set up a receiver using the @ref{cd,,socketserver}
module. Here is a basic working example:

@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

First run the server, and then the client. On the client side, nothing is
printed on the console; on the server side, you should see something like:

@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{2edb,,makePickle()} method and implementing your
alternative there, as well as adapting the above script to use your alternative
serialization.

@menu
* Running a logging socket listener in production:: 

@end menu

@node Running a logging socket listener in production,,,Sending and receiving logging events across a network
@anchor{howto/logging-cookbook running-a-logging-socket-listener-in-production}@anchor{53c3}
@subsubsection Running a logging socket listener in production


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

Arquivo

@tab

Propósito

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

The default configuration uses a TCP socket on port 9020. You can use a Unix
Domain socket instead of a TCP socket by doing the following:


@enumerate 

@item 
In @code{listener.json}, add a @code{socket} key with the path to the domain
socket you want to use. If this key is present, the listener listens on the
corresponding domain socket and not on a TCP socket (the @code{port} key is
ignored).

@item 
In @code{webapp.json}, change the socket handler configuration dictionary
so that the @code{host} value is the path to the domain socket, and set the
@code{port} value to @code{null}.
@end enumerate

@node Adding contextual information to your logging output,Use of contextvars,Sending and receiving logging events across a network,Livro de receitas do logging
@anchor{howto/logging-cookbook adding-contextual-information-to-your-logging-output}@anchor{53c4}@anchor{howto/logging-cookbook context-info}@anchor{2e77}
@subsection Adding contextual information to your logging output


Sometimes you want logging output to contain contextual information in
addition to the parameters passed to the logging call. For example, in a
networked application, it may be desirable to log client-specific information
in the log (e.g. remote client’s username, or IP address). Although you could
use the `extra' parameter to achieve this, it’s not always convenient to pass
the information in this way. While it might be tempting to create
@ref{b64,,Logger} instances on a per-connection basis, this is not a good idea
because these instances are not garbage collected. While this is not a problem
in practice, when the number of @ref{b64,,Logger} instances is dependent on the
level of granularity you want to use in logging an application, it could
be hard to manage if the number of @ref{b64,,Logger} instances becomes
effectively unbounded.

@menu
* Using LoggerAdapters to impart contextual information:: 
* Using Filters to impart contextual information:: 

@end menu

@node Using LoggerAdapters to impart contextual information,Using Filters to impart contextual information,,Adding contextual information to your logging output
@anchor{howto/logging-cookbook using-loggeradapters-to-impart-contextual-information}@anchor{53c5}
@subsubsection Using LoggerAdapters to impart contextual information


An easy way in which you can pass contextual information to be output along
with logging event information is to use the @ref{1339,,LoggerAdapter} class.
This class is designed to look like a @ref{b64,,Logger}, so that you can call
@ref{2e40,,debug()}, @ref{2e6b,,info()}, @ref{2ff,,warning()}, @ref{2e7f,,error()},
@ref{14dc,,exception()}, @ref{2e80,,critical()} and @ref{2e81,,log()}. These methods have the
same signatures as their counterparts in @ref{b64,,Logger}, so you can use the
two types of instances interchangeably.

When you create an instance of @ref{1339,,LoggerAdapter}, you pass it a
@ref{b64,,Logger} instance and a dict-like object which contains your contextual
information. When you call one of the logging methods on an instance of
@ref{1339,,LoggerAdapter}, it delegates the call to the underlying instance of
@ref{b64,,Logger} passed to its constructor, and arranges to pass the contextual
information in the delegated call. Here’s a snippet from the code of
@ref{1339,,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

The @ref{2e78,,process()} method of @ref{1339,,LoggerAdapter} is where the
contextual information is added to the logging output. It’s passed the message
and keyword arguments of the logging call, and it passes back (potentially)
modified versions of these to use in the call to the underlying logger. The
default implementation of this method leaves the message alone, but inserts
an ‘extra’ key in the keyword argument whose value is the dict-like object
passed to the constructor. Of course, if you had passed an ‘extra’ keyword
argument in the call to the adapter, it will be silently overwritten.

The advantage of using ‘extra’ is that the values in the dict-like object are
merged into the @ref{101c,,LogRecord} instance’s __dict__, allowing you to use
customized strings with your @ref{14df,,Formatter} instances which know about
the keys of the dict-like object. If you need a different method, e.g. if you
want to prepend or append the contextual information to the message string,
you just need to subclass @ref{1339,,LoggerAdapter} and override
@ref{2e78,,process()} to do what you need. Here is a simple example:

@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

which you can use like this:

@example
logger = logging.getLogger(__name__)
adapter = CustomAdapter(logger, @{'connid': some_conn_id@})
@end example

Then any events that you log to the adapter will have the value of
@code{some_conn_id} prepended to the log messages.

@menu
* Using objects other than dicts to pass contextual information:: 

@end menu

@node Using objects other than dicts to pass contextual information,,,Using LoggerAdapters to impart contextual information
@anchor{howto/logging-cookbook using-objects-other-than-dicts-to-pass-contextual-information}@anchor{53c6}
@subsubsection Using objects other than dicts to pass contextual information


You don’t need to pass an actual dict to a @ref{1339,,LoggerAdapter} - you could
pass an instance of a class which implements @code{__getitem__} and @code{__iter__} so
that it looks like a dict to logging. This would be useful if you want to
generate values dynamically (whereas the values in a dict would be constant).

@node Using Filters to impart contextual information,,Using LoggerAdapters to impart contextual information,Adding contextual information to your logging output
@anchor{howto/logging-cookbook filters-contextual}@anchor{2e6c}@anchor{howto/logging-cookbook using-filters-to-impart-contextual-information}@anchor{53c7}
@subsubsection Using Filters to impart contextual information


You can also add contextual information to log output using a user-defined
@ref{123b,,Filter}. @code{Filter} instances are allowed to modify the @code{LogRecords}
passed to them, including adding additional attributes which can then be output
using a suitable format string, or if needed a custom @ref{14df,,Formatter}.

For example in a web application, the request being processed (or at least,
the interesting parts of it) can be stored in a threadlocal
(@ref{1631,,threading.local}) variable, and then accessed from a @code{Filter} to
add, say, information from the request - say, the remote IP address and remote
user’s username - to the @code{LogRecord}, using the attribute names ‘ip’ and
‘user’ as in the @code{LoggerAdapter} example above. In that case, the same format
string can be used to get similar output to that shown above. Here’s an example
script:

@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

which, when run, produces something like:

@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 Use of contextvars,Imparting contextual information in handlers,Adding contextual information to your logging output,Livro de receitas do logging
@anchor{howto/logging-cookbook use-of-contextvars}@anchor{53c8}
@subsection Use of @code{contextvars}


Since Python 3.7, the @ref{24,,contextvars} module has provided context-local storage
which works for both @ref{ed,,threading} and @ref{a,,asyncio} processing needs. This type
of storage may thus be generally preferable to thread-locals. The following example
shows how, in a multi-threaded environment, logs can populated with contextual
information such as, for example, request attributes handled by web applications.

For the purposes of illustration, say that you have different web applications, each
independent of the other but running in the same Python process and using a library
common to them. How can each of these applications have their own log, where all
logging messages from the library (and other request processing code) are directed to
the appropriate application’s log file, while including in the log additional
contextual information such as client IP, HTTP request method and client username?

Let’s assume that the library can be simulated by the following code:

@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

We can simulate the multiple web applications by means of two simple classes,
@code{Request} and @code{WebApp}. These simulate how real threaded web applications work -
each request is handled by a thread:

@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

If you run the above, you should find that roughly half the requests go
into @code{app1.log} and the rest into @code{app2.log}, and the all the requests are
logged to @code{app.log}. Each webapp-specific log will contain only log entries for
only that webapp, and the request information will be displayed consistently in the
log (i.e. the information in each dummy request will always appear together in a log
line). This is illustrated by the following shell output:

@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 Imparting contextual information in handlers,Logging to a single file from multiple processes,Use of contextvars,Livro de receitas do logging
@anchor{howto/logging-cookbook imparting-contextual-information-in-handlers}@anchor{53c9}
@subsection Imparting contextual information in handlers


Each @ref{14de,,Handler} has its own chain of filters.
If you want to add contextual information to a @ref{101c,,LogRecord} without leaking
it to other handlers, you can use a filter that returns
a new @ref{101c,,LogRecord} instead of modifying it in-place, as shown in the following 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 to a single file from multiple processes,Using file rotation,Imparting contextual information in handlers,Livro de receitas do logging
@anchor{howto/logging-cookbook logging-to-a-single-file-from-multiple-processes}@anchor{53ca}@anchor{howto/logging-cookbook multiple-processes}@anchor{53cb}
@subsection Logging to a single file from multiple processes


Although logging is thread-safe, and logging to a single file from multiple
threads in a single process `is' supported, logging to a single file from
`multiple processes' is `not' supported, because there is no standard way to
serialize access to a single file across multiple processes in Python. If you
need to log to a single file from multiple processes, one way of doing this is
to have all the processes log to a @ref{f96,,SocketHandler}, and have a
separate process which implements a socket server which reads from the socket
and logs to file. (If you prefer, you can dedicate one thread in one of the
existing processes to perform this function.)
@ref{53c1,,This section} documents this approach in more detail and
includes a working socket receiver which can be used as a starting point for you
to adapt in your own applications.

You could also write your own handler which uses the @ref{1683,,Lock}
class from the @ref{94,,multiprocessing} module to serialize access to the
file from your processes. The stdlib @ref{19de,,FileHandler} and subclasses do
not make use of @ref{94,,multiprocessing}.

Alternatively, you can use a @code{Queue} and a @ref{18ec,,QueueHandler} to send
all logging events to one of the processes in your multi-process application.
The following example script demonstrates how you can do this; in the example
a separate listener process listens for events sent by other processes and logs
them according to its own logging configuration. Although the example only
demonstrates one way of doing it (for example, you may want to use a listener
thread rather than a separate listener process – the implementation would be
analogous) it does allow for completely different logging configurations for
the listener and the other processes in your application, and can be used as
the basis for code meeting your own specific requirements:

@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

A variant of the above script keeps the logging in the main process, in a
separate thread:

@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

This variant shows how you can e.g. apply configuration for particular loggers
- e.g. the @code{foo} logger has a special handler which stores all events in the
@code{foo} subsystem in a file @code{mplog-foo.log}. This will be used by the logging
machinery in the main process (even though the logging events are generated in
the worker processes) to direct the messages to the appropriate destinations.

@menu
* Using concurrent.futures.ProcessPoolExecutor: Using concurrent futures ProcessPoolExecutor. 
* Deploying Web applications using Gunicorn and uWSGI:: 

@end menu

@node Using concurrent futures ProcessPoolExecutor,Deploying Web applications using Gunicorn and uWSGI,,Logging to a single file from multiple processes
@anchor{howto/logging-cookbook using-concurrent-futures-processpoolexecutor}@anchor{53cc}
@subsubsection Using concurrent.futures.ProcessPoolExecutor


If you want to use @ref{8f4,,concurrent.futures.ProcessPoolExecutor} to start
your worker processes, you need to create the queue slightly differently.
Instead of

@example
queue = multiprocessing.Queue(-1)
@end example

you should use

@example
queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above
@end example

and you can then replace the worker creation from this:

@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

to this (remembering to first import @ref{21,,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 Deploying Web applications using Gunicorn and uWSGI,,Using concurrent futures ProcessPoolExecutor,Logging to a single file from multiple processes
@anchor{howto/logging-cookbook deploying-web-applications-using-gunicorn-and-uwsgi}@anchor{53cd}
@subsubsection Deploying Web applications using Gunicorn and uWSGI


When deploying Web applications using Gunicorn@footnote{https://gunicorn.org/} or uWSGI@footnote{https://uwsgi-docs.readthedocs.io/en/latest/} (or similar), multiple worker
processes are created to handle client requests. In such environments, avoid creating
file-based handlers directly in your web application. Instead, use a
@ref{f96,,SocketHandler} to log from the web application to a listener in a separate
process. This can be set up using a process management tool such as Supervisor - see
@ref{53c3,,Running a logging socket listener in production} for more details.

@node Using file rotation,Use of alternative formatting styles,Logging to a single file from multiple processes,Livro de receitas do logging
@anchor{howto/logging-cookbook using-file-rotation}@anchor{53ce}
@subsection Using file rotation


@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{16c2,,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

The result should be 6 separate files, each with part of the log history for the
application:

@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

The most current file is always @code{logging_rotatingfile_example.out},
and each time it reaches the size limit it is renamed with the suffix
@code{.1}. Each of the existing backup files is renamed to increment the suffix
(@code{.1} becomes @code{.2}, etc.)  and the @code{.6} file is erased.

Obviously this example sets the log length much too small as an extreme
example.  You would want to set `maxBytes' to an appropriate value.

@node Use of alternative formatting styles,Personalizando o LogRecord,Using file rotation,Livro de receitas do logging
@anchor{howto/logging-cookbook format-styles}@anchor{53cf}@anchor{howto/logging-cookbook use-of-alternative-formatting-styles}@anchor{53d0}
@subsection Use of alternative formatting styles


When logging was added to the Python standard library, the only way of
formatting messages with variable content was to use the %-formatting
method. Since then, Python has gained two new formatting approaches:
@ref{687,,string.Template} (added in Python 2.4) and @ref{621,,str.format()}
(added in Python 2.6).

Logging (as of 3.2) provides improved support for these two additional
formatting styles. The @ref{14df,,Formatter} class been enhanced to take an
additional, optional keyword parameter named @code{style}. This defaults to
@code{'%'}, but other possible values are @code{'@{'} and @code{'$'}, which correspond
to the other two formatting styles. Backwards compatibility is maintained by
default (as you would expect), but by explicitly specifying a style parameter,
you get the ability to specify format strings which work with
@ref{621,,str.format()} or @ref{687,,string.Template}. Here’s an example console
session to show the possibilities:

@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

Note that the formatting of logging messages for final output to logs is
completely independent of how an individual logging message is constructed.
That can still use %-formatting, as shown here:

@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

Logging calls (@code{logger.debug()}, @code{logger.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 actual
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{621,,str.format()} or
@ref{687,,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.

There is, however, a way that you can use @{@}- and $- formatting to construct
your individual log messages. Recall that for a message you can use an
arbitrary object as a message format string, and that the logging package will
call @code{str()} on that object to get the actual format string. Consider the
following two classes:

@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

Either of these can be used in place of a format string, to allow @{@}- or
$-formatting to be used to build the actual “message” part which appears in the
formatted log output in place of “%(message)s” or “@{message@}” or “$message”.
It’s a little unwieldy to use the class names whenever you want to log
something, but it’s quite palatable if you use an alias such as __ (double
underscore — not to be confused with _, the single underscore used as a
synonym/alias for @ref{14b1,,gettext.gettext()} or its brethren).

The above classes are not included in Python, though they’re easy enough to
copy and paste into your own code. They can be used as follows (assuming that
they’re declared in a module called @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

While the above examples use @code{print()} to show how the formatting works, you
would of course use @code{logger.debug()} or similar to actually log using this
approach.

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.

If you prefer, you can use a @ref{1339,,LoggerAdapter} to achieve a similar effect
to the above, as in the following example:

@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 Personalizando o LogRecord,Subclassing QueueHandler and QueueListener- a ZeroMQ example,Use of alternative formatting styles,Livro de receitas do logging
@anchor{howto/logging-cookbook custom-logrecord}@anchor{53d1}@anchor{howto/logging-cookbook customizing-logrecord}@anchor{53d2}
@subsection Personalizando o @code{LogRecord}


Every logging event is represented by a @ref{101c,,LogRecord} instance.
When an event is logged and not filtered out by a logger’s level, a
@ref{101c,,LogRecord} is created, populated with information about the event and
then passed to the handlers for that logger (and its ancestors, up to and
including the logger where further propagation up the hierarchy is disabled).
Before Python 3.2, there were only two places where this creation was done:


@itemize *

@item 
@ref{2e49,,Logger.makeRecord()}, which is called in the normal process of
logging an event. This invoked @ref{101c,,LogRecord} directly to create an
instance.

@item 
@ref{2e6f,,makeLogRecord()}, which is called with a dictionary containing
attributes to be added to the LogRecord. This is typically invoked when a
suitable dictionary has been received over the network (e.g. in pickle form
via a @ref{f96,,SocketHandler}, or in JSON form via an
@ref{e58,,HTTPHandler}).
@end itemize

This has usually meant that if you need to do anything special with a
@ref{101c,,LogRecord}, you’ve had to do one of the following.


@itemize *

@item 
Create your own @ref{b64,,Logger} subclass, which overrides
@ref{2e49,,Logger.makeRecord()}, and set it using @ref{2e7e,,setLoggerClass()}
before any loggers that you care about are instantiated.

@item 
Add a @ref{123b,,Filter} to a logger or handler, which does the
necessary special manipulation you need when its
@ref{2e6a,,filter()} method is called.
@end itemize

The first approach would be a little unwieldy in the scenario where (say)
several different libraries wanted to do different things. Each would attempt
to set its own @ref{b64,,Logger} subclass, and the one which did this last would
win.

The second approach works reasonably well for many cases, but does not allow
you to e.g. use a specialized subclass of @ref{101c,,LogRecord}. Library
developers can set a suitable filter on their loggers, but they would have to
remember to do this every time they introduced a new logger (which they would
do simply by adding new packages or modules and doing

@example
logger = logging.getLogger(__name__)
@end example

at module level). It’s probably one too many things to think about. Developers
could also add the filter to a @ref{12c6,,NullHandler} attached to their
top-level logger, but this would not be invoked if an application developer
attached a handler to a lower-level library logger — so output from that
handler would not reflect the intentions of the library developer.

In Python 3.2 and later, @ref{101c,,LogRecord} creation is done through a
factory, which you can specify. The factory is just a callable you can set with
@ref{2e73,,setLogRecordFactory()}, and interrogate with
@ref{2e72,,getLogRecordFactory()}. The factory is invoked with the same
signature as the @ref{101c,,LogRecord} constructor, as @ref{101c,,LogRecord}
is the default setting for the factory.

This approach allows a custom factory to control all aspects of LogRecord
creation. For example, you could return a subclass, or just add some additional
attributes to the record once created, using a pattern similar to this:

@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

This pattern allows different libraries to chain factories together, and as
long as they don’t overwrite each other’s attributes or unintentionally
overwrite the attributes provided as standard, there should be no surprises.
However, it should be borne in mind that each link in the chain adds run-time
overhead to all logging operations, and the technique should only be used when
the use of a @ref{123b,,Filter} does not provide the desired result.

@node Subclassing QueueHandler and QueueListener- a ZeroMQ example,Subclassing QueueHandler and QueueListener- a pynng example,Personalizando o LogRecord,Livro de receitas do logging
@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-zeromq-example}@anchor{53d3}@anchor{howto/logging-cookbook zeromq-handlers}@anchor{53d4}
@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{53d5}
@subsubsection Subclass @code{QueueHandler}


You can use a @ref{18ec,,QueueHandler} subclass to send messages to other kinds
of queues, for example a ZeroMQ ‘publish’ socket. In the example below,the
socket is created separately and passed to the handler (as its ‘queue’):

@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

Of course there are other ways of organizing this, for example passing in the
data needed by the handler to create the 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{53d6}
@subsubsection Subclass @code{QueueListener}


You can also subclass @ref{e59,,QueueListener} to get messages from other kinds
of queues, for example a ZeroMQ ‘subscribe’ socket. Here’s an example:

@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,An example dictionary-based configuration,Subclassing QueueHandler and QueueListener- a ZeroMQ example,Livro de receitas do logging
@anchor{howto/logging-cookbook pynng-handlers}@anchor{53d7}@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-pynng-example}@anchor{53d8}
@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{53d9}
@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{53da}
@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 An example dictionary-based configuration,Using a rotator and namer to customize log rotation processing,Subclassing QueueHandler and QueueListener- a pynng example,Livro de receitas do logging
@anchor{howto/logging-cookbook an-example-dictionary-based-configuration}@anchor{53db}
@subsection An example dictionary-based configuration


Below is an example of a logging configuration dictionary - it’s taken from
the documentation on the Django project@footnote{https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging}.
This dictionary is passed to @ref{11ef,,dictConfig()} to put the configuration into effect:

@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

For more information about this configuration, you can see the relevant section@footnote{https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging}
of the Django documentation.

@node Using a rotator and namer to customize log rotation processing,A more elaborate multiprocessing example,An example dictionary-based configuration,Livro de receitas do logging
@anchor{howto/logging-cookbook cookbook-rotator-namer}@anchor{2eca}@anchor{howto/logging-cookbook using-a-rotator-and-namer-to-customize-log-rotation-processing}@anchor{53dc}
@subsection Using a rotator and namer to customize log rotation processing


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 A more elaborate multiprocessing example,Inserting a BOM into messages sent to a SysLogHandler,Using a rotator and namer to customize log rotation processing,Livro de receitas do logging
@anchor{howto/logging-cookbook a-more-elaborate-multiprocessing-example}@anchor{53dd}
@subsection A more elaborate multiprocessing example


The following working example shows how logging can be used with multiprocessing
using configuration files. The configurations are fairly simple, but serve to
illustrate how more complex ones could be implemented in a real multiprocessing
scenario.

In the example, the main process spawns a listener process and some worker
processes. Each of the main process, the listener and the workers have three
separate configurations (the workers all share the same configuration). We can
see logging in the main process, how the workers log to a QueueHandler and how
the listener implements a QueueListener and a more complex logging
configuration, and arranges to dispatch events received via the queue to the
handlers specified in the configuration. Note that these configurations are
purely illustrative, but you should be able to adapt this example to your own
scenario.

Here’s the script - the docstrings and the comments hopefully explain how it
works:

@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 Inserting a BOM into messages sent to a SysLogHandler,Implementing structured logging,A more elaborate multiprocessing example,Livro de receitas do logging
@anchor{howto/logging-cookbook inserting-a-bom-into-messages-sent-to-a-sysloghandler}@anchor{53de}
@subsection Inserting a BOM into messages sent to a SysLogHandler


@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} requires that a
Unicode message be sent to a syslog daemon as a set of bytes which have the
following structure: an optional pure-ASCII component, followed by a UTF-8 Byte
Order Mark (BOM), followed by Unicode encoded using UTF-8. (See the
@geindex RFC; RFC 5424 Section 6
relevant section of the specification@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html#section-6}.)

In Python 3.1, code was added to
@ref{65c,,SysLogHandler} to insert a BOM into the message, but
unfortunately, it was implemented incorrectly, with the BOM appearing at the
beginning of the message and hence not allowing any pure-ASCII component to
appear before it.

As this behaviour is broken, the incorrect BOM insertion code is being removed
from Python 3.2.4 and later. However, it is not being replaced, and if you
want to produce 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html}-compliant messages which include a BOM, an optional
pure-ASCII sequence before it and arbitrary Unicode after it, encoded using
UTF-8, then you need to do the following:


@enumerate 

@item 
Attach a @ref{14df,,Formatter} instance to your
@ref{65c,,SysLogHandler} instance, with a format string
such as:

@example
'ASCII section\ufeffUnicode section'
@end example

The Unicode code point U+FEFF, when encoded using UTF-8, will be
encoded as a UTF-8 BOM – the byte-string @code{b'\xef\xbb\xbf'}.

@item 
Replace the ASCII section with whatever placeholders you like, but make sure
that the data that appears in there after substitution is always ASCII (that
way, it will remain unchanged after UTF-8 encoding).

@item 
Replace the Unicode section with whatever placeholders you like; if the data
which appears there after substitution contains characters outside the ASCII
range, that’s fine – it will be encoded using UTF-8.
@end enumerate

The formatted message `will' be encoded using UTF-8 encoding by
@code{SysLogHandler}. If you follow the above rules, you should be able to produce
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html}-compliant messages. If you don’t, logging may not complain, but your
messages will not be RFC 5424-compliant, and your syslog daemon may complain.

@node Implementing structured logging,Customizing handlers with dictConfig,Inserting a BOM into messages sent to a SysLogHandler,Livro de receitas do logging
@anchor{howto/logging-cookbook implementing-structured-logging}@anchor{53df}
@subsection Implementing structured logging


Although most logging messages are intended for reading by humans, and thus not
readily machine-parseable, there might be circumstances where you want to output
messages in a structured format which `is' capable of being parsed by a program
(without needing complex regular expressions to parse the log message). This is
straightforward to achieve using the logging package. There are a number of
ways in which this could be achieved, but the following is a simple approach
which uses JSON to serialise the event in a machine-parseable manner:

@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

If the above script is run, it prints:

@example
message 1 >>> @{"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"@}
@end example

Note that the order of items might be different according to the version of
Python used.

If you need more specialised processing, you can use a custom JSON encoder,
as in the following complete example:

@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

When the above script is run, it prints:

@example
message 1 >>> @{"snowman": "\u2603", "set_value": [1, 2, 3]@}
@end example

Note that the order of items might be different according to the version of
Python used.

@node Customizing handlers with dictConfig,Using particular formatting styles throughout your application,Implementing structured logging,Livro de receitas do logging
@anchor{howto/logging-cookbook custom-handlers}@anchor{53e0}@anchor{howto/logging-cookbook customizing-handlers-with-dictconfig}@anchor{53e1}
@subsection Customizing handlers with @code{dictConfig()}


There are times when you want to customize logging handlers in particular ways,
and if you use @ref{11ef,,dictConfig()} you may be able to do this without
subclassing. As an example, consider that you may want to set the ownership of a
log file. On POSIX, this is easily done using @ref{240,,shutil.chown()}, but the file
handlers in the stdlib don’t offer built-in support. You can customize handler
creation using a plain function such as:

@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

You can then specify, in a logging configuration passed to @ref{11ef,,dictConfig()},
that a logging handler be created by calling this function:

@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

In this example I am setting the ownership using the @code{pulse} user and group,
just for the purposes of illustration. Putting it together into a working
script, @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

To run this, you will probably need to run as @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

Note that this example uses Python 3.3 because that’s where @ref{240,,shutil.chown()}
makes an appearance. This approach should work with any Python version that
supports @ref{11ef,,dictConfig()} - namely, Python 2.7, 3.2 or later. With pre-3.3
versions, you would need to implement the actual ownership change using e.g.
@ref{112d,,os.chown()}.

In practice, the handler-creating function may be in a utility module somewhere
in your project. Instead of the line in the configuration:

@example
'()': owned_file_handler,
@end example

you could use e.g.:

@example
'()': 'ext://project.util.owned_file_handler',
@end example

where @code{project.util} can be replaced with the actual name of the package
where the function resides. In the above working script, using
@code{'ext://__main__.owned_file_handler'} should work. Here, the actual callable
is resolved by @ref{11ef,,dictConfig()} from the @code{ext://} specification.

This example hopefully also points the way to how you could implement other
types of file change - e.g. setting specific POSIX permission bits - in the
same way, using @ref{21b,,os.chmod()}.

Of course, the approach could also be extended to types of handler other than a
@ref{19de,,FileHandler} - for example, one of the rotating file handlers,
or a different type of handler altogether.

@node Using particular formatting styles throughout your application,Configuring filters with dictConfig,Customizing handlers with dictConfig,Livro de receitas do logging
@anchor{howto/logging-cookbook formatting-styles}@anchor{2e60}@anchor{howto/logging-cookbook using-particular-formatting-styles-throughout-your-application}@anchor{53e2}
@subsection Using particular formatting styles throughout your application


In Python 3.2, the @ref{14df,,Formatter} gained a @code{style} keyword
parameter which, while defaulting to @code{%} for backward compatibility, allowed
the specification of @code{@{} or @code{$} to support the formatting approaches
supported by @ref{621,,str.format()} and @ref{687,,string.Template}. Note that this
governs the formatting of logging messages for final output to logs, and is
completely orthogonal to how an individual logging message is constructed.

Logging calls (@ref{e57,,debug()}, @ref{2e3f,,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{621,,str.format()} or @ref{687,,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.

There have been suggestions to associate format styles with specific loggers,
but that approach also runs into backward compatibility problems because any
existing code could be using a given logger name and using %-formatting.

For logging to work interoperably between any third-party libraries and your
code, decisions about formatting need to be made at the level of the
individual logging call. This opens up a couple of ways in which alternative
formatting styles can be accommodated.

@menu
* Using LogRecord factories:: 
* Using custom message objects:: 

@end menu

@node Using LogRecord factories,Using custom message objects,,Using particular formatting styles throughout your application
@anchor{howto/logging-cookbook using-logrecord-factories}@anchor{53e3}
@subsubsection Using LogRecord factories


In Python 3.2, along with the @ref{14df,,Formatter} changes mentioned
above, the logging package gained the ability to allow users to set their own
@ref{101c,,LogRecord} subclasses, using the @ref{2e73,,setLogRecordFactory()} function.
You can use this to set your own subclass of @ref{101c,,LogRecord}, which does the
Right Thing by overriding the @ref{2e71,,getMessage()} method. The base
class implementation of this method is where the @code{msg % args} formatting
happens, and where you can substitute your alternate formatting; however, you
should be careful to support all formatting styles and allow %-formatting as
the default, to ensure interoperability with other code. Care should also be
taken to call @code{str(self.msg)}, just as the base implementation does.

Refer to the reference documentation on @ref{2e73,,setLogRecordFactory()} and
@ref{101c,,LogRecord} for more information.

@node Using custom message objects,,Using LogRecord factories,Using particular formatting styles throughout your application
@anchor{howto/logging-cookbook using-custom-message-objects}@anchor{53e4}
@subsubsection Using custom message objects


There is another, perhaps simpler way that you can use @{@}- and $- formatting to
construct your individual log messages. You may recall (from
@ref{2e70,,Usando objetos arbitrários como mensagens}) that when logging you can use an arbitrary
object as a message format string, and that the logging package will call
@ref{44c,,str()} on that object to get the actual format string. Consider the
following two classes:

@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

Either of these can be used in place of a format string, to allow @{@}- or
$-formatting to be used to build the actual “message” part which appears in the
formatted log output in place of “%(message)s” or “@{message@}” or “$message”.
If you find it a little unwieldy to use the class names whenever you want to log
something, you can make it more palatable if you use an alias such as @code{M} or
@code{_} for the message (or perhaps @code{__}, if you are using @code{_} for
localization).

Examples of this approach are given below. Firstly, formatting with
@ref{621,,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

Secondly, formatting with @ref{687,,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 Configuring filters with dictConfig,Customized exception formatting,Using particular formatting styles throughout your application,Livro de receitas do logging
@anchor{howto/logging-cookbook configuring-filters-with-dictconfig}@anchor{53e5}@anchor{howto/logging-cookbook filters-dictconfig}@anchor{53e6}
@subsection Configuring filters with @code{dictConfig()}


You `can' configure filters using @ref{11ef,,dictConfig()}, though it
might not be obvious at first glance how to do it (hence this recipe). Since
@ref{123b,,Filter} is the only filter class included in the standard
library, and it is unlikely to cater to many requirements (it’s only there as a
base class), you will typically need to define your own @ref{123b,,Filter}
subclass with an overridden @ref{2e6a,,filter()} method. To do this,
specify the @code{()} key in the configuration dictionary for the filter,
specifying a callable which will be used to create the filter (a class is the
most obvious, but you can provide any callable which returns a
@ref{123b,,Filter} instance). Here is a complete example:

@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

This example shows how you can pass configuration data to the callable which
constructs the instance, in the form of keyword parameters. When run, the above
script will print:

@example
changed: hello
@end example

which shows that the filter is working as configured.

A couple of extra points to note:


@itemize *

@item 
If you can’t refer to the callable directly in the configuration (e.g. if it
lives in a different module, and you can’t import it directly where the
configuration dictionary is), you can use the form @code{ext://...} as described
in @ref{2ea0,,Acesso a objetos externos}. For example, you could have used
the text @code{'ext://__main__.MyFilter'} instead of @code{MyFilter} in the above
example.

@item 
As well as for filters, this technique can also be used to configure custom
handlers and formatters. See @ref{2e94,,Objetos definidos pelo usuário} for more
information on how logging supports using user-defined objects in its
configuration, and see the other cookbook recipe @ref{53e0,,Customizing handlers with dictConfig()} above.
@end itemize

@node Customized exception formatting,Speaking logging messages,Configuring filters with dictConfig,Livro de receitas do logging
@anchor{howto/logging-cookbook custom-format-exception}@anchor{53e7}@anchor{howto/logging-cookbook customized-exception-formatting}@anchor{53e8}
@subsection Customized exception formatting


There might be times when you want to do customized exception formatting - for
argument’s sake, let’s say you want exactly one line per logged event, even
when exception information is present. You can do this with a custom formatter
class, as shown in the following example:

@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

When run, this produces a file with exactly two lines:

@example
28/01/2015 07:21:23|INFO|Sample message|
28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|
@end example

While the above treatment is simplistic, it points the way to how exception
information can be formatted to your liking. The @ref{fe,,traceback} module may be
helpful for more specialized needs.

@node Speaking logging messages,Buffering logging messages and outputting them conditionally,Customized exception formatting,Livro de receitas do logging
@anchor{howto/logging-cookbook speaking-logging-messages}@anchor{53e9}@anchor{howto/logging-cookbook spoken-messages}@anchor{53ea}
@subsection Speaking logging messages


There might be situations when it is desirable to have logging messages rendered
in an audible rather than a visible format. This is easy to do if you have
text-to-speech (TTS) functionality available in your system, even if it doesn’t have
a Python binding. Most TTS systems have a command line program you can run, and
this can be invoked from a handler using @ref{d6,,subprocess}. It’s assumed here
that TTS command line programs won’t expect to interact with users or take a
long time to complete, and that the frequency of logged messages will be not so
high as to swamp the user with messages, and that it’s acceptable to have the
messages spoken one at a time rather than concurrently, The example implementation
below waits for one message to be spoken before the next is processed, and this
might cause other handlers to be kept waiting. Here is a short example showing
the approach, which assumes that the @code{espeak} TTS package is available:

@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

When run, this script should say “Hello” and then “Goodbye” in a female voice.

The above approach can, of course, be adapted to other TTS systems and even
other systems altogether which can process messages via external programs run
from a command line.

@node Buffering logging messages and outputting them conditionally,Sending logging messages to email with buffering,Speaking logging messages,Livro de receitas do logging
@anchor{howto/logging-cookbook buffered-logging}@anchor{53eb}@anchor{howto/logging-cookbook buffering-logging-messages-and-outputting-them-conditionally}@anchor{53ec}
@subsection Buffering logging messages and outputting them conditionally


There might be situations where you want to log messages in a temporary area
and only output them if a certain condition occurs. For example, you may want to
start logging debug events in a function, and if the function completes without
errors, you don’t want to clutter the log with the collected debug information,
but if there is an error, you want all the debug information to be output as well
as the error.

Here is an example which shows how you could do this using a decorator for your
functions where you want logging to behave this way. It makes use of the
@ref{2ea3,,logging.handlers.MemoryHandler}, which allows buffering of logged events
until some condition occurs, at which point the buffered events are @code{flushed}
- passed to another handler (the @code{target} handler) for processing. By default,
the @code{MemoryHandler} flushed when its buffer gets filled up or an event whose
level is greater than or equal to a specified threshold is seen. You can use this
recipe with a more specialised subclass of @code{MemoryHandler} if you want custom
flushing behavior.

The example script has a simple function, @code{foo}, which just cycles through
all the logging levels, writing to @code{sys.stderr} to say what level it’s about
to log at, and then actually logging a message at that level. You can pass a
parameter to @code{foo} which, if true, will log at ERROR and CRITICAL levels -
otherwise, it only logs at DEBUG, INFO and WARNING levels.

The script just arranges to decorate @code{foo} with a decorator which will do the
conditional logging that’s required. The decorator takes a logger as a parameter
and attaches a memory handler for the duration of the call to the decorated
function. The decorator can be additionally parameterised using a target handler,
a level at which flushing should occur, and a capacity for the buffer (number of
records buffered). These default to a @ref{1238,,StreamHandler} which
writes to @code{sys.stderr}, @code{logging.ERROR} and @code{100} respectively.

Here’s the 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

When this script is run, the following output should be observed:

@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

As you can see, actual logging output only occurs when an event is logged whose
severity is ERROR or greater, but in that case, any previous events at lower
severities are also logged.

You can of course use the conventional means of decoration:

@example
@@log_if_errors(logger)
def foo(fail=False):
    ...
@end example

@node Sending logging messages to email with buffering,Formatting times using UTC GMT via configuration,Buffering logging messages and outputting them conditionally,Livro de receitas do logging
@anchor{howto/logging-cookbook buffered-smtp}@anchor{53ed}@anchor{howto/logging-cookbook sending-logging-messages-to-email-with-buffering}@anchor{53ee}
@subsection Sending logging messages to email, with buffering


To illustrate how you can send log messages via email, so that a set number of
messages are sent per email, you can subclass
@ref{2ef6,,BufferingHandler}. In the following  example, which you can
adapt to suit your specific needs, a simple test harness is provided which allows you
to run the script with command line arguments specifying what you typically need to
send things via SMTP. (Run the downloaded script with the @code{-h} argument to see the
required and optional arguments.)

@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

If you run this script and your SMTP server is correctly set up, you should find that
it sends eleven emails to the addressee you specify. The first ten emails will each
have ten log messages, and the eleventh will have two messages. That makes up 102
messages as specified in the script.

@node Formatting times using UTC GMT via configuration,Using a context manager for selective logging,Sending logging messages to email with buffering,Livro de receitas do logging
@anchor{howto/logging-cookbook formatting-times-using-utc-gmt-via-configuration}@anchor{53ef}@anchor{howto/logging-cookbook utc-formatting}@anchor{53f0}
@subsection Formatting times using UTC (GMT) via configuration


Sometimes you want to format times using UTC, which can be done using a class
such as @code{UTCFormatter}, shown below:

@example
import logging
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime
@end example

and you can then use the @code{UTCFormatter} in your code instead of
@ref{14df,,Formatter}. If you want to do that via configuration, you can
use the @ref{11ef,,dictConfig()} API with an approach illustrated by
the following complete example:

@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

When this script is run, it should print something like:

@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

showing how the time is formatted both as local time and UTC, one for each
handler.

@node Using a context manager for selective logging,A CLI application starter template,Formatting times using UTC GMT via configuration,Livro de receitas do logging
@anchor{howto/logging-cookbook context-manager}@anchor{53f1}@anchor{howto/logging-cookbook using-a-context-manager-for-selective-logging}@anchor{53f2}
@subsection Using a context manager for selective logging


There are times when it would be useful to temporarily change the logging
configuration and revert it back after doing something. For this, a context
manager is the most obvious way of saving and restoring the logging context.
Here is a simple example of such a context manager, which allows you to
optionally change the logging level and add a logging handler purely in the
scope of the context manager:

@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

If you specify a level value, the logger’s level is set to that value in the
scope of the with block covered by the context manager. If you specify a
handler, it is added to the logger on entry to the block and removed on exit
from the block. You can also ask the manager to close the handler for you on
block exit - you could do this if you don’t need the handler any more.

To illustrate how it works, we can add the following block of code to the
above:

@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

We initially set the logger’s level to @code{INFO}, so message #1 appears and
message #2 doesn’t. We then change the level to @code{DEBUG} temporarily in the
following @code{with} block, and so message #3 appears. After the block exits, the
logger’s level is restored to @code{INFO} and so message #4 doesn’t appear. In the
next @code{with} block, we set the level to @code{DEBUG} again but also add a handler
writing to @code{sys.stdout}. Thus, message #5 appears twice on the console (once
via @code{stderr} and once via @code{stdout}). After the @code{with} statement’s
completion, the status is as it was before so message #6 appears (like message
#1) whereas message #7 doesn’t (just like message #2).

If we run the resulting script, the result is as follows:

@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

If we run it again, but pipe @code{stderr} to @code{/dev/null}, we see the following,
which is the only message written to @code{stdout}:

@example
$ python logctx.py 2>/dev/null
5. This should appear twice - once on stderr and once on stdout.
@end example

Once again, but piping @code{stdout} to @code{/dev/null}, we get:

@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

In this case, the message #5 printed to @code{stdout} doesn’t appear, as expected.

Of course, the approach described here can be generalised, for example to attach
logging filters temporarily. Note that the above code works in Python 2 as well
as Python 3.

@node A CLI application starter template,A Qt GUI for logging,Using a context manager for selective logging,Livro de receitas do logging
@anchor{howto/logging-cookbook a-cli-application-starter-template}@anchor{53f3}@anchor{howto/logging-cookbook starter-template}@anchor{53f4}
@subsection A CLI application starter template


Here’s an example which shows how you can:


@itemize *

@item 
Use a logging level based on command-line arguments

@item 
Dispatch to multiple subcommands in separate files, all logging at the same
level in a consistent way

@item 
Make use of simple, minimal configuration
@end itemize

Suppose we have a command-line application whose job is to stop, start or
restart some services. This could be organised for the purposes of illustration
as a file @code{app.py} that is the main script for the application, with individual
commands implemented in @code{start.py}, @code{stop.py} and @code{restart.py}. Suppose
further that we want to control the verbosity of the application via a
command-line argument, defaulting to @code{logging.INFO}. Here’s one way that
@code{app.py} could be written:

@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

And the @code{start}, @code{stop} and @code{restart} commands can be implemented in
separate modules, like so for starting:

@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

and thus for stopping:

@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

and similarly for restarting:

@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

If we run this application with the default log level, we get output like this:

@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

The first word is the logging level, and the second word is the module or
package name of the place where the event was logged.

If we change the logging level, then we can change the information sent to the
log. For example, if we want more information:

@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

And if we want less:

@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

In this case, the commands don’t print anything to the console, since nothing
at @code{WARNING} level or above is logged by them.

@node A Qt GUI for logging,Logging to syslog with RFC5424 support,A CLI application starter template,Livro de receitas do logging
@anchor{howto/logging-cookbook a-qt-gui-for-logging}@anchor{53f5}@anchor{howto/logging-cookbook qt-gui}@anchor{53f6}
@subsection A Qt GUI for 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.

The following example shows how to log to a Qt GUI. This introduces a simple
@code{QtHandler} class which takes a callable, which should be a slot in the main
thread that does GUI updates. A worker thread is also created to show how you
can log to the GUI from both the UI itself (via a button for manual logging)
as well as a worker thread doing work in the background (here, just logging
messages at random levels with random short delays in between).

The worker thread is implemented using Qt’s @code{QThread} class rather than the
@ref{ed,,threading} module, as there are circumstances where one has to use
@code{QThread}, which offers better integration with other @code{Qt} components.

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 to syslog with RFC5424 support,How to treat a logger like an output stream,A Qt GUI for logging,Livro de receitas do logging
@anchor{howto/logging-cookbook logging-to-syslog-with-rfc5424-support}@anchor{53f7}
@subsection Logging to syslog with RFC5424 support


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{65c,,SysLogHandler} functionality has not been
updated.

RFC 5424 contains some useful features such as support for structured data, and if you
need to be able to log to a syslog server with support for it, you can do so with a
subclassed handler which looks something like this:

@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

You’ll need to be familiar with RFC 5424 to fully understand the above code, and it
may be that you have slightly different needs (e.g. for how you pass structural data
to the log). Nevertheless, the above should be adaptable to your speciric needs. With
the above handler, you’d pass structured data using something like this:

@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 How to treat a logger like an output stream,How to uniformly handle newlines in logging output,Logging to syslog with RFC5424 support,Livro de receitas do logging
@anchor{howto/logging-cookbook how-to-treat-a-logger-like-an-output-stream}@anchor{53f8}
@subsection How to treat a logger like an output stream


Sometimes, you need to interface to a third-party API which expects a file-like
object to write to, but you want to direct the API’s output to a logger. You
can do this using a class which wraps a logger with a file-like API.
Here’s a short script illustrating such a class:

@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

When this script is run, it prints

@example
INFO:demo:An INFO message
DEBUG:demo:A DEBUG message
@end example

You could also use @code{LoggerWriter} to redirect @code{sys.stdout} and
@code{sys.stderr} by doing something like this:

@example
import sys

sys.stdout = LoggerWriter(logger, logging.INFO)
sys.stderr = LoggerWriter(logger, logging.WARNING)
@end example

You should do this `after' configuring logging for your needs. In the above
example, the @ref{a08,,basicConfig()} call does this (using the
@code{sys.stderr} value `before' it is overwritten by a @code{LoggerWriter}
instance). Then, you’d get this kind of result:

@example
>>> print('Foo')
INFO:demo:Foo
>>> print('Bar', file=sys.stderr)
WARNING:demo:Bar
>>>
@end example

Of course, the examples above show output according to the format used by
@ref{a08,,basicConfig()}, but you can use a different formatter when you
configure logging.

Note that with the above scheme, you are somewhat at the mercy of buffering and
the sequence of write calls which you are intercepting. For example, with the
definition of @code{LoggerWriter} above, if you have the snippet

@example
sys.stderr = LoggerWriter(logger, logging.WARNING)
1 / 0
@end example

then running the script results in

@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

This just buffers up stuff until a newline is seen, and then logs complete
lines. With this approach, you get better output:

@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

@node How to uniformly handle newlines in logging output,Patterns to avoid,How to treat a logger like an output stream,Livro de receitas do logging
@anchor{howto/logging-cookbook how-to-uniformly-handle-newlines-in-logging-output}@anchor{53f9}
@subsection How to uniformly handle newlines in logging output


Usually, messages that are logged (say to console or file) consist of a single
line of text. However, sometimes there is a need to handle messages with
multiple lines - whether because a logging format string contains newlines, or
logged data contains newlines. If you want to handle such messages uniformly, so
that each line in the logged message appears uniformly formatted as if it was
logged separately, you can do this using a handler mixin, as in the following
snippet:

@example
# Assume this is in a module mymixins.py
import copy

class MultilineMixin:
    def emit(self, record):
        s = record.getMessage()
        if '\n' not in s:
            super().emit(record)
        else:
            lines = s.splitlines()
            rec = copy.copy(record)
            rec.args = None
            for line in lines:
                rec.msg = line
                super().emit(rec)
@end example

You can use the mixin as in the following script:

@example
import logging

from mymixins import MultilineMixin

logger = logging.getLogger(__name__)

class StreamHandler(MultilineMixin, logging.StreamHandler):
    pass

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(levelname)-9s %(message)s',
                        handlers = [StreamHandler()])
    logger.debug('Single line')
    logger.debug('Multiple lines:\nfool me once ...')
    logger.debug('Another single line')
    logger.debug('Multiple lines:\n%s', 'fool me ...\ncan\'t get fooled again')
@end example

The script, when run, prints something like:

@example
2025-07-02 13:54:47,234 DEBUG     Single line
2025-07-02 13:54:47,234 DEBUG     Multiple lines:
2025-07-02 13:54:47,234 DEBUG     fool me once ...
2025-07-02 13:54:47,234 DEBUG     Another single line
2025-07-02 13:54:47,234 DEBUG     Multiple lines:
2025-07-02 13:54:47,234 DEBUG     fool me ...
2025-07-02 13:54:47,234 DEBUG     can't get fooled again
@end example

If, on the other hand, you are concerned about log injection@footnote{https://owasp.org/www-community/attacks/Log_Injection}, you can use a
formatter which escapes newlines, as per the following example:

@example
import logging

logger = logging.getLogger(__name__)

class EscapingFormatter(logging.Formatter):
    def format(self, record):
        s = super().format(record)
        return s.replace('\n', r'\n')

if __name__ == '__main__':
    h = logging.StreamHandler()
    h.setFormatter(EscapingFormatter('%(asctime)s %(levelname)-9s %(message)s'))
    logging.basicConfig(level=logging.DEBUG, handlers = [h])
    logger.debug('Single line')
    logger.debug('Multiple lines:\nfool me once ...')
    logger.debug('Another single line')
    logger.debug('Multiple lines:\n%s', 'fool me ...\ncan\'t get fooled again')
@end example

You can, of course, use whatever escaping scheme makes the most sense for you.
The script, when run, should produce output like this:

@example
2025-07-09 06:47:33,783 DEBUG     Single line
2025-07-09 06:47:33,783 DEBUG     Multiple lines:\nfool me once ...
2025-07-09 06:47:33,783 DEBUG     Another single line
2025-07-09 06:47:33,783 DEBUG     Multiple lines:\nfool me ...\ncan't get fooled again
@end example

Escaping behaviour can’t be the stdlib default , as it would break backwards
compatibility.

@c patterns-to-avoid:

@node Patterns to avoid,Outros recursos<3>,How to uniformly handle newlines in logging output,Livro de receitas do logging
@anchor{howto/logging-cookbook patterns-to-avoid}@anchor{53fa}
@subsection Patterns to avoid


Although the preceding sections have described ways of doing things you might
need to do or deal with, it is worth mentioning some usage patterns which are
`unhelpful', and which should therefore be avoided in most cases. The following
sections are in no particular order.

@menu
* Opening the same log file multiple times:: 
* Using loggers as attributes in a class or passing them as parameters:: 
* Adding handlers other than NullHandler to a logger in a library:: 
* Creating a lot of loggers:: 

@end menu

@node Opening the same log file multiple times,Using loggers as attributes in a class or passing them as parameters,,Patterns to avoid
@anchor{howto/logging-cookbook opening-the-same-log-file-multiple-times}@anchor{53fb}
@subsubsection Opening the same log file multiple times


On Windows, you will generally not be able to open the same file multiple times
as this will lead to a “file is in use by another process” error. However, on
POSIX platforms you’ll not get any errors if you open the same file multiple
times. This could be done accidentally, for example by:


@itemize *

@item 
Adding a file handler more than once which references the same file (e.g. by
a copy/paste/forget-to-change error).

@item 
Opening two files that look different, as they have different names, but are
the same because one is a symbolic link to the other.

@item 
Forking a process, following which both parent and child have a reference to
the same file. This might be through use of the @ref{94,,multiprocessing} module,
for example.
@end itemize

Opening a file multiple times might `appear' to work most of the time, but can
lead to a number of problems in practice:


@itemize *

@item 
Logging output can be garbled because multiple threads or processes try to
write to the same file. Although logging guards against concurrent use of the
same handler instance by multiple threads, there is no such protection if
concurrent writes are attempted by two different threads using two different
handler instances which happen to point to the same file.

@item 
An attempt to delete a file (e.g. during file rotation) silently fails,
because there is another reference pointing to it. This can lead to confusion
and wasted debugging time - log entries end up in unexpected places, or are
lost altogether. Or a file that was supposed to be moved remains in place,
and grows in size unexpectedly despite size-based rotation being supposedly
in place.
@end itemize

Use the techniques outlined in @ref{53cb,,Logging to a single file from multiple processes} to circumvent such
issues.

@node Using loggers as attributes in a class or passing them as parameters,Adding handlers other than NullHandler to a logger in a library,Opening the same log file multiple times,Patterns to avoid
@anchor{howto/logging-cookbook using-loggers-as-attributes-in-a-class-or-passing-them-as-parameters}@anchor{53fc}
@subsubsection Using loggers as attributes in a class or passing them as parameters


While there might be unusual cases where you’ll need to do this, in general
there is no point because loggers are singletons. Code can always access a
given logger instance by name using @code{logging.getLogger(name)}, so passing
instances around and holding them as instance attributes is pointless. Note
that in other languages such as Java and C#, loggers are often static class
attributes. However, this pattern doesn’t make sense in Python, where the
module (and not the class) is the unit of software decomposition.

@node Adding handlers other than NullHandler to a logger in a library,Creating a lot of loggers,Using loggers as attributes in a class or passing them as parameters,Patterns to avoid
@anchor{howto/logging-cookbook adding-handlers-other-than-nullhandler-to-a-logger-in-a-library}@anchor{53fd}
@subsubsection Adding handlers other than @code{NullHandler} to a logger in a library


Configuring logging by adding handlers, formatters and filters is the
responsibility of the application developer, not the library developer. If you
are maintaining a library, ensure that you don’t add handlers to any of your
loggers other than a @ref{12c6,,NullHandler} instance.

@node Creating a lot of loggers,,Adding handlers other than NullHandler to a logger in a library,Patterns to avoid
@anchor{howto/logging-cookbook creating-a-lot-of-loggers}@anchor{53fe}
@subsubsection Creating a lot of loggers


Loggers are singletons that are never freed during a script execution, and so
creating lots of loggers will use up memory which can’t then be freed. Rather
than create a logger per e.g. file processed or network connection made, use
the @ref{2e77,,existing mechanisms} for passing contextual
information into your logs and restrict the loggers created to those describing
areas within your application (generally modules, but occasionally slightly
more fine-grained than that).

@node Outros recursos<3>,,Patterns to avoid,Livro de receitas do logging
@anchor{howto/logging-cookbook cookbook-ref-links}@anchor{53b7}@anchor{howto/logging-cookbook other-resources}@anchor{53ff}
@subsection Outros recursos



@subsubheading Ver também



@table @asis

@item Módulo @ref{87,,logging}

Referência da API para o módulo de logging.

@item Módulo @ref{88,,logging.config}

API de configuração para o módulo logging.

@item Módulo @ref{89,,logging.handlers}

Tratadores úteis incluídos no módulo logging.
@end table

@ref{1235,,Tutorial básico}

@ref{1236,,Tutorial avançado}


@node Expressões Regulares,Programação de Soquetes,Livro de receitas do logging,Python HOWTOs
@anchor{howto/regex doc}@anchor{5400}@anchor{howto/regex regex-howto}@anchor{2487}@anchor{howto/regex regular-expression-howto}@anchor{5401}@anchor{howto/regex translation-repo}@anchor{5402}
@section Expressões Regulares


@*Autor: 
A.M. Kuchling <@email{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 Resumo



Este documento é um tutorial introdutório sobre expressões regulares em Python com o módulo @ref{b9,,re}. Ele provê uma introdução mais tranquila que a seção correspondente à documentação do módulo.

@menu
* Introdução: Introdução<16>. 
* Padrões simples:: 
* Usando expressões regulares:: 
* Mais poder dos padrões:: 
* Modificando strings:: 
* Problemas comuns:: 
* Comentários: Comentários<2>. 

@end menu

@node Introdução<16>,Padrões simples,,Expressões Regulares
@anchor{howto/regex introduction}@anchor{5403}
@subsection Introdução


Expressões regulares (chamadas REs, ou regexes ou padrões regex) são essencialmente uma mini linguagem de programação altamente especializada incluída dentro do Python e disponível através do módulo @ref{b9,,re}. Usando esta pequena linguagem, você especifica as regras para o conjunto de strings possíveis que você quer corresponder; esse conjunto pode conter sentenças em português, endereços de e-mail, comandos TeX ou qualquer coisa que você queira. Você poderá então perguntar coisas como “Essa string se enquadra dentro do padrão?” ou “Existe alguma parte da string que se enquadra nesse padrão?”. Você também pode usar as REs para modificar uma string ou dividi-la de diversas formas.

Os padrões das expressões regulares são compilados em uma série de bytecodes que são então executadas por um mecanismo de correspondência escrito em C. Para usos avançados, talvez seja necessário prestar atenção em como o mecanismo irá executar uma dada RE, e escrever a RE de forma que os bytecodes executem de forma mais rápida. Otimização é um tema que não será visto neste documento, porque ele requer que você tenha um bom entendimento dos mecanismos de combinação internos.

A linguagem de expressão regular é relativamente pequena e restrita, por isso nem todas as tarefas de processamento de strings possíveis podem ser feitas usando expressões regulares. Existem também tarefas que podem ser feitas com expressões regulares, mas as expressões acabam por se tornarem muito complicadas. Nestes casos, pode ser melhor para você escrever um código Python para fazer o processamento; embora um código Python seja mais lento do que uma expressão regular elaborada, ele provavelmente será mais compreensível.

@node Padrões simples,Usando expressões regulares,Introdução<16>,Expressões Regulares
@anchor{howto/regex simple-patterns}@anchor{5404}
@subsection Padrões simples


Vamos começar por aprender sobre as expressões regulares mais simples possíveis.
Como as expressões regulares são usadas para operar em strings, vamos começar
com a tarefa mais comum: correspondência de caracteres.

Para uma explicação detalhada da ciência da computação referente a expressões regulares (autômatos finitos determinísticos e não determinístico), você pode consultara praticamente qualquer livro sobre a escrita de compiladores.

@menu
* Correspondendo caracteres:: 
* Repetindo coisas:: 

@end menu

@node Correspondendo caracteres,Repetindo coisas,,Padrões simples
@anchor{howto/regex matching-characters}@anchor{5405}
@subsubsection Correspondendo caracteres


A maioria das letras e caracteres simplesmente irão corresponder entre si. Por exemplo, a expressão regular @code{teste} irá combinar totalmente com a string @code{teste}. (Você pode habilitar o modo de maiúsculas e minúsculas que faria a RE corresponder com @code{Test} ou @code{TEST} também; veremos mais sobre isso mais adiante.)

Há exceções a essa regra, alguns caracteres são metacaracteres especiais, e não se correspondem. Em vez disso, eles sinalizam que alguma coisa fora do normal deve ser correspondida, ou eles afetam outras partes da RE, repetindo-as ou alterando seus significados. Grande parte deste documento é dedicada à discussão de vários metacaracteres e o que eles fazem.

Aqui está a lista completa de metacaracteres; seus significados serão discutidos ao longo deste documento.

@example
. ^ $ * + ? @{ @} [ ] \ | ( )
@end example

O primeiro metacaractere que vamos estudar é o @code{[} e o @code{]}. Eles são usados para especificar uma classe de caracteres, que é um conjunto de caracteres que você deseja combinar. Caracteres podem ser listados individualmente ou um intervalo de caracteres pode ser indicado fornecendo dois caracteres e separando-os por um @code{'-'}. Por exemplo, @code{[abc]} irá encontrar qualquer caractere @code{a}, @code{b}, ou @code{c}; isso é o mesmo que escrever @code{[a-c]}, que usa um intervalo para expressar o mesmo conjunto de caracteres. Se você deseja encontrar apenas letras minúsculas, sua RE seria @code{[a-z]}.

Metacaracteres (exceto @code{\}) não são ativos dentro de classes. Por exemplo, @code{[akm$]} irá corresponder com qualquer dos caracteres @code{'a'}, @code{'k'}, @code{'m'} ou @code{'$'}; @code{'$'} é normalmente um metacaractere, mas dentro de uma classe de caracteres ele perde sua natureza especial.

Você pode combinar os caracteres não listados na classe `complementando' o conjunto. Isso é indicado pela inclusão de um @code{'^'} como o primeiro caractere da classe. Por exemplo, @code{[^5]} combinará a qualquer caractere, exceto @code{'5'}. Se o sinal de intercalação aparecer em outro lugar da classe de caracteres, ele não terá um significado especial. Por exemplo: @code{[5^]} corresponderá a um @code{'5'} ou a @code{'^'}.

Talvez o metacaractere mais importante seja a contrabarra, @code{\}. Como as strings literais em Python, a barra invertida pode ser seguida por vários caracteres para sinalizar várias sequências especiais. Ela também é usada para `escapar' todos os metacaracteres, e assim, você poder combiná-los em padrões; por exemplo, se você precisa fazer correspondência a um @code{[} ou @code{\}, você pode precedê-los com uma barra invertida para remover seu significado especial: @code{\[} ou @code{\\}.

Algumas das sequências especiais que começam com @code{'\'} representam conjuntos de caracteres predefinidos que são frequentemente úteis, como o conjunto de dígitos, o conjunto de letras ou o conjunto de qualquer coisa que não seja espaço em branco.

Vejamos um exemplo: @code{\w} corresponde a qualquer caractere alfanumérico. Se o padrão regex for expresso em bytes, isso é equivalente à classe @code{[a-zA-Z0-9_]}. Se o padrão regex for uma string, @code{\w} combinará todos os caracteres marcados como letras no banco de dados Unicode fornecido pelo módulo @ref{105,,unicodedata}. Você pode usar a definição mais restrita de @code{\w} em um padrão de string, fornecendo o sinalizador @ref{62c,,re.ASCII} ao compilar a expressão regular.

A lista a seguir de sequências especiais não está completa. Para obter uma lista completa das sequências e definições de classe expandidas para padrões de strings Unicode, veja a última parte de @ref{724,,Sintaxe de Expressão Regular} na referência da Biblioteca Padrão. Em geral, as versões Unicode correspondem a qualquer caractere que esteja na categoria apropriada do banco de dados Unicode.


@table @asis

@item @code{\d}

corresponde a qualquer @code{dígito decimal}, que é equivalente à classe @code{[0-9]}.

@item @code{\D}

corresponde a qualquer caractere @code{não-dígito}, o que é equivalente à classe @code{[^0-9]}.

@item @code{\s}

corresponde a qualquer caractere @code{espaço-em-branco}, o que é equivalente à classe @code{[\t\n\r\f\v]}.

@item @code{\S}

corresponde a qualquer caractere @code{não-espaço-branco}, o que é equivalente à classe @code{[^\t\n\r\f\v].}

@item @code{\w}

corresponde a qualquer caractere @code{alfanumérico}, o que é equivalente à classe @code{[azA-Z0-9_]}.

@item @code{\W}

corresponde a qualquer caractere @code{não-alfanumérico}, o que é equivalente à classe @code{[^a-zA-Z0-9_]}.
@end table

Estas sequências podem ser incluídas dentro de uma classe de caractere. Por exemplo, @code{[\s,.]} É uma classe de caractere que irá corresponder a qualquer caractere @code{espaço-em-branco}, ou @code{,} ou @code{.}.

O metacaractere final desta seção é o @code{.}. Ele encontra tudo, exceto um caractere de nova linha, e existe um modo alternativo (@ref{2488,,re.DOTALL}), onde ele irá corresponder até mesmo a um caractere de nova linha. @code{.} é frequentemente usado quando você quer corresponder com “qualquer caractere”.

@node Repetindo coisas,,Correspondendo caracteres,Padrões simples
@anchor{howto/regex repeating-things}@anchor{5406}
@subsubsection Repetindo coisas


Ser capaz de corresponder com variados conjuntos de caracteres é a primeira coisa que as expressões regulares podem fazer que ainda não é possível com os métodos disponíveis para strings. No entanto, se essa fosse a única capacidade adicional das expressões regulares, elas não seriam um avanço relevante. Outro recurso que você pode especificar é que partes do RE devem ser repetidas um certo número de vezes.

O primeiro metacaractere para repetir coisas que veremos é @code{*}. @code{*} não corresponde ao caractere literal @code{'*'}; em vez disso, ele especifica que o caractere anterior pode ser correspondido zero ou mais vezes, em vez de exatamente uma vez.

Por exemplo, @code{ca*t} vai corresponder @code{'ct'} (0 caracteres @code{'a'}), @code{'cat'} (1 @code{'a'}), @code{'caaat'} (3 caracteres @code{'a'}), e assim por diante.

Repetições tais como @code{*} são gulosas; ao repetir a RE, o motor de correspondência vai tentar repeti-la tantas vezes quanto possível. Se porções posteriores do padrão não corresponderem, o motor de correspondência, em seguida, volta e tenta novamente com menos repetições.

Um exemplo passo a passo fará isso mais óbvio. Vamos considerar a expressão “a[bcd]*b”. Isto corresponde à letra “a”, zero ou mais letras da classe “[bcd]” e, finalmente, termina com “b”.  Agora, imagine corresponder este RE com a string “abcbd”.


@multitable {xxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Passo

@tab

Correspondência

@tab

Explicação

@item

1

@tab

@code{a}

@tab

O caractere @code{a} na RE tem correspondência.

@item

2

@tab

@code{abcbd}

@tab

O motor corresponde com @code{[bcd]*}, indo tão longe quanto possível, que é o fim do string.

@item

3

@tab

`Falha'

@tab

O motor tenta corresponder com @code{b}, mas a posição corrente está no final da string, então ele falha.

@item

4

@tab

@code{abcb}

@tab

Voltando, de modo que @code{[bcd]*} corresponde a um caractere a menos.

@item

5

@tab

`Falha'

@tab

Tenta @code{b} novamente, mas a posição corrente é a do último caractere, que é um @code{'d'}.

@item

6

@tab

@code{abc}

@tab

Voltando novamente, de modo que @code{[bcd]*} está correspondendo com @code{bc} somente.

@item

6

@tab

@code{abcb}

@tab

Tenta @code{b} novamente. Desta vez, o caractere na posição corrente é @code{'b'}, por isso sucesso.

@end multitable


O final da RE foi atingido e correspondeu a @code{'abcb'}. Isso demonstra como o mecanismo de correspondência vai tão longe quanto pode no início e, se nenhuma correspondência for encontrada, ele fará a volta progressivamente e tentará novamente o restante da RE. Ele fará voltas até que tenha tentado zero correspondências para @code{[bcd]*}, e se isso falhar subsequentemente, o mecanismo concluirá que a string não corresponde a RE de forma alguma.

Outro metacaractere de repetição é o @code{+}, que corresponde a uma ou mais vezes. Preste muita atenção para a diferença entre @code{*} e @code{+}; @code{*} corresponde com zero ou mais vezes, assim, o que quer que esteja sendo repetido pode não estar presente, enquanto que @code{+} requer pelo menos uma ocorrência. Para usar um exemplo similar, @code{ca+t} vai corresponder a @code{'cat'}, (1 @code{'a'}), @code{'caaat'} (3 @code{'a'}s), mas não corresponde com @code{'ct'}.

Existem mais dois quantificadores ou operadores de repetição. O caractere de ponto de interrogação, @code{?}, corresponde a uma ou zero vez; você pode pensar nisso como a marcação de algo sendo opcional. Por exemplo, @code{home-?brew} corresponde tanto a @code{'homebrew'} quanto a @code{'home-brew'}.

O qualificador mais complicado é o @code{@{m,n@}}, no qual `m' e `n' são números inteiros decimais. Este qualificador significa que deve haver pelo menos `m' repetições, e no máximo `n'. Por exemplo, @code{a/@{1,3@}b} irá corresponder a @code{'a/b'}, @code{'a//b'} e @code{'a///b'}. Não vai corresponder a @code{'ab'}, que não tem barras ou a @code{'a////b'}, que tem quatro.

Você pode omitir tanto `m' quanto `n'; nesse caso, um valor razoável é presumido para o valor em falta. A omissão de `m' é interpretada como o limite inferior de 0, enquanto a omissão de `n' resulta como limite superior o infinito.

O caso mais simples @code{@{m@}} corresponde ao item precedente exatamente `m' vezes. Por exemplo, @code{a/@{2@}b} corresponderá somente a @code{'a//b'}.

Os leitores de uma inclinação reducionista podem notar que os três outros quantificadores podem todos serem expressos utilizando esta notação. @code{@{0,@}} é o mesmo que @code{*}, @code{@{1,@}} é equivalente a @code{+}, e @code{@{0,1@}} é o mesmo que @code{?}. É melhor usar @code{*}, @code{+} ou @code{?} quando puder, simplesmente porque eles são mais curtos e fáceis de ler.

@node Usando expressões regulares,Mais poder dos padrões,Padrões simples,Expressões Regulares
@anchor{howto/regex using-regular-expressions}@anchor{5407}
@subsection Usando expressões regulares


Agora que nós vimos algumas expressões regulares simples, como nós realmente as usamos em Python? O módulo @ref{b9,,re} fornece uma interface para o mecanismo de expressão regular, permitindo compilar REs em objetos e, em seguida, executar comparações com eles.

@menu
* Compilando expressões regulares:: 
* A praga da contrabarra:: 
* Executando correspondências:: 
* Funções de nível de módulo: Funções de nível de módulo<3>. 
* Sinalizadores de compilação:: 

@end menu

@node Compilando expressões regulares,A praga da contrabarra,,Usando expressões regulares
@anchor{howto/regex compiling-regular-expressions}@anchor{5408}
@subsubsection Compilando expressões regulares


As expressões regulares são compiladas em objetos padrão, que têm métodos para várias operações, tais como a procura por padrões de correspondência ou realizar substituições de strings.

@example
>>> import re
>>> p = re.compile('ab*')
>>> p
re.compile('ab*')
@end example

@ref{bee,,re.compile()} também aceita um argumento opcional `flags', utilizado para habilitar vários recursos especiais e variações de sintaxe. Nós vamos ver todas as configurações disponíveis mais tarde, mas por agora, um único exemplo vai servir:

@example
>>> p = re.compile('ab*', re.IGNORECASE)
@end example

A RE é passada para @ref{bee,,re.compile()} como uma string. REs são tratadas como strings porque as expressões regulares não são parte do núcleo da linguagem Python, e nenhuma sintaxe especial foi criada para expressá-las. (Existem aplicações que não necessitam de REs nenhuma, por isso não há necessidade de inchar a especificação da linguagem, incluindo-as.) Em vez disso, o módulo @ref{b9,,re} é simplesmente um módulo de extensão C incluído no Python, assim como os módulos de @ref{cc,,socket} ou @ref{133,,zlib}.

Colocando REs em strings mantém a linguagem Python mais simples, mas tem uma desvantagem, que é o tema da próxima seção.

@node A praga da contrabarra,Executando correspondências,Compilando expressões regulares,Usando expressões regulares
@anchor{howto/regex id1}@anchor{5409}@anchor{howto/regex the-backslash-plague}@anchor{540a}
@subsubsection A praga da contrabarra


Como afirmado anteriormente, expressões regulares usam o caractere de contrabarra (@code{\}) para indicar formas especiais ou para permitir que caracteres especiais sejam usados sem invocar o seu significado especial. Isso entra em conflito com o uso pelo Python do mesmo caractere para o mesmo propósito nas strings literais.

Vamos dizer que você quer escrever uma RE que corresponde com a string @code{\section}, que pode ser encontrada em um arquivo LaTeX. Para descobrir o que escrever no código do programa, comece com a string que se deseja corresponder. Em seguida, você deve preceder qualquer contrabarra e outros metacaracteres com uma contrabarra, tendo como resultado a string @code{\\section}. A string resultante que deve ser passada para @ref{bee,,re.compile()} deve ser @code{\\section}. No entanto, para expressar isso como uma string literal Python, ambas as contrabarras devem ser precedidas com uma contrabarra novamente.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Caracteres

@tab

Etapa

@item

@code{\section}

@tab

String de texto a ser correspondida

@item

@code{\\section}

@tab

Preceder com contrabarra para @ref{bee,,re.compile()}

@item

@code{"\\\\section"}

@tab

Contrabarras precedidas novamente para uma string literal

@end multitable


Em suma, para corresponder com uma contrabarra literal, tem de se escrever @code{'\\\\'} como a string da RE, porque a expressão regular deve ser @code{\\}, e cada contrabarra deve ser expressa como @code{\\} dentro de uma string literal Python normal. Em REs que apresentam contrabarras repetidas vezes, isso leva a um monte de contrabarras repetidas e faz as strings resultantes difíceis de entender.

A solução é usar a notação de string bruta (raw) do Python para expressões regulares; contrabarras não são tratadas de nenhuma forma especial em uma string literal se prefixada com @code{r}, então @code{r"\n"} é uma string de dois caracteres contendo @code{\} e @code{n}, enquanto @code{"\n"} é uma string de um único caractere contendo uma nova linha. As expressões regulares, muitas vezes, são escritas no código Python usando esta notação de string bruta (raw).

Além disso, sequências de escape especiais que são válidas em expressões regulares, mas não válidas como literais de string do Python, agora resultam em uma @ref{1a5,,DeprecationWarning} e eventualmente se tornarão uma @ref{18d,,SyntaxError}, o que significa que as sequências serão inválidas se a notação de string bruta ou o escape das contrabarras não forem usados.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

String regular

@tab

`String bruta'

@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 Executando correspondências,Funções de nível de módulo<3>,A praga da contrabarra,Usando expressões regulares
@anchor{howto/regex performing-matches}@anchor{540b}
@subsubsection Executando correspondências


Uma vez que você tem um objeto que representa uma expressão regular compilada, o que você faz com ele? Objetos Pattern têm vários métodos e atributos. Apenas os mais significativos serão vistos aqui; consulte a documentação do módulo @ref{b9,,re} para uma lista completa.


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/Atributo

@tab

Propósito

@item

@code{match()}

@tab

Determina se a RE combina com o início da string.

@item

@code{search()}

@tab

Varre toda a string, procurando qualquer local onde esta RE tem correspondência.

@item

@code{findall()}

@tab

Encontra todas as substrings onde a RE corresponde, e as retorna como uma lista.

@item

@code{finditer()}

@tab

Encontra todas as substrings onde a RE corresponde, e as retorna como um @ref{1ac,,iterador}.

@end multitable


@ref{2499,,match()} e @ref{249a,,search()} retornam @code{None} se não existir nenhuma correspondência encontrada. Se tiveram sucesso, uma instância de @ref{fbc,,objeto correspondência} é retornada, contendo informações sobre a correspondência: onde ela começa e termina, a substring com a qual ela teve correspondência, e mais.

Você pode aprender mais sobre isso experimentando interativamente com o módulo @ref{b9,,re}.

Este documento usa o interpretador Python padrão para seus exemplos. Primeiro, execute o interpretador Python, importe o módulo @ref{b9,,re}, e compile uma RE:

@example
>>> import re
>>> p = re.compile('[a-z]+')
>>> p
re.compile('[a-z]+')
@end example

Agora, você pode tentar corresponder várias strings com a RE @code{[a-z]+}. Mas uma string vazia não deveria corresponder com nada, uma vez que @code{+} significa ‘uma ou mais repetições’. @ref{2499,,match()} deve retornar @code{None} neste caso, o que fará com que o interpretador não imprima nenhuma saída. Você pode imprimir explicitamente o resultado de @code{match()} para deixar isso claro.

@example
>>> p.match("")
>>> print(p.match(""))
None
@end example

Agora, vamos experimentá-la em uma string que ela deve corresponder, como @code{tempo}. Neste caso, @ref{2499,,match()} irá retornar um @ref{fbc,,objeto correspondência}, assim você deve armazenar o resultado em uma variável para uso posterior.

@example
>>> m = p.match('tempo')
>>> m
<re.Match object; span=(0, 5), match='tempo'>
@end example

Agora você pode consultar o @ref{fbc,,objeto correspondência} para obter informações sobre a string correspondente. Instâncias do objeto correspondência também tem vários métodos e atributos; os mais importantes são os seguintes:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/Atributo

@tab

Propósito

@item

@code{group()}

@tab

Retorna a string que corresponde com a RE

@item

@code{start()}

@tab

Retorna a posição inicial da string correspondente

@item

@code{end()}

@tab

Retorna a posição final da string correspondente

@item

@code{span()}

@tab

Retorna uma tupla contendo as posições (inicial, final) da string correspondente

@end multitable


Experimentando estes métodos teremos seus significado esclarecidos:

@example
>>> m.group()
'tempo'
>>> m.start(), m.end()
(0, 5)
>>> m.span()
(0, 5)
@end example

@ref{1061,,group()} retorna a substring que correspondeu com a RE.  @ref{24ac,,start()} e @ref{24ad,,end()} retornam os índices inicial e o final da substring correspondente. @ref{24ae,,span()} retorna tanto os índices inicial e final em uma única tupla. Como o método @ref{2499,,match()} somente verifica se a RE corresponde ao início de uma string, @code{start()} será sempre zero. No entanto, o método @ref{249a,,search()} dos objetos padrão, varre toda a string, de modo que a substring correspondente pode não iniciar em zero nesse 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

Nos programas reais, o estilo mais comum é armazenar o @ref{fbc,,objeto correspondência} em uma variável e, em seguida, verificar se ela é @code{None}. Isso geralmente se parece com:

@example
p = re.compile( ... )
m = p.match( 'string vai aqui' )
if m:
    print('Correspondência encontrada: ', m.group())
else:
    print('Sem correspondência')
@end example

Dois métodos padrão retornam todas as correspondências de um padrão. @ref{24a0,,findall()} retorna uma lista de strings correspondentes:

@example
>>> p = re.compile(r'\d+')
>>> p.findall('12 percussionistas tocando tambores, 11 flautistas tocando flautas, 10  lordes saltando')
['12', '11', '10']
@end example

O prefixo @code{r}, tornando literal uma literal de string bruta, é necessário neste exemplo porque sequências de escape em uma literal de string “cozida” normal que não são reconhecidas pelo Python, ao contrário de expressões regulares, agora resultam em uma @ref{1a5,,DeprecationWarning} e eventualmente se tornarão uma @ref{18d,,SyntaxError}. Veja @ref{540a,,A praga da contrabarra}.

@ref{24a0,,findall()} tem que criar a lista inteira antes de poder devolvê-la como resultado. O método @ref{24a1,,finditer()} retorna uma sequência de instâncias @ref{fbc,,objeto correspondência} como um @ref{1ac,,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 Funções de nível de módulo<3>,Sinalizadores de compilação,Executando correspondências,Usando expressões regulares
@anchor{howto/regex module-level-functions}@anchor{540c}
@subsubsection Funções de nível de módulo


Você não tem que criar um objeto padrão e chamar seus métodos; o módulo @ref{b9,,re} também fornece funções de nível superior chamadas @ref{126e,,match()}, @ref{126d,,search()}, @ref{1060,,findall()}, @ref{2a3,,sub()}, e assim por diante. Estas funções recebem os mesmos argumentos que o método correspondente do objeto padrão, com a string RE adicionada como o primeiro argumento, e ainda retornam @code{None} ou uma instância @ref{fbc,,objeto correspondência}.

@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

Sob o capô, estas funções simplesmente criam um objeto padrão para você e chamam o método apropriado para ele. Elas também armazenam o objeto compilado em um cache, para que futuras chamadas usando a mesma RE não precisem analisar o padrão de novo e de novo.

Você deve usar essas funções de nível de módulo ou deve obter o padrão e chamar seus métodos você mesmo? Se estiver acessando uma expressão regular dentro de um laço de repetição, pré-compilá-la economizará algumas chamadas de função. Fora dos laços, não há muita diferença graças ao cache interno.

@node Sinalizadores de compilação,,Funções de nível de módulo<3>,Usando expressões regulares
@anchor{howto/regex compilation-flags}@anchor{540d}
@subsubsection Sinalizadores de compilação


Sinalizadores de compilação permitem modificar alguns aspectos de como as expressões regulares funcionam. Sinalizadores estão disponíveis no módulo @ref{b9,,re} sob dois nomes, um nome longo, tal como @ref{181a,,IGNORECASE} e um curto, na forma de uma letra, como @ref{248b,,I}. (Se você estiver familiarizado com o padrão dos modificadores do Perl, o nome curto usa as mesmas letras; o forma abreviada de @ref{2497,,re.VERBOSE} é @ref{2490,,re.X}, por exemplo). Vários sinalizadores podem ser especificados aplicando um @code{OU} bit a bit nelas; @code{re.I | re.M} define os sinalizadores @ref{248b,,I} e @ref{248d,,M}, por exemplo.

Aqui está uma tabela dos sinalizadores disponíveis, seguida por uma explicação mais detalhada de cada um:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Sinalizador

@tab

Significado

@item

@ref{62c,,ASCII}, @ref{248a,,A}

@tab

Faz com que vários escapes como @code{\w}, @code{\b}, @code{\s} e @code{\d} correspondam apenas a caracteres ASCII com a respectiva propriedade.

@item

@ref{2488,,DOTALL}, @ref{248e,,S}

@tab

Faz o @code{.} corresponder a qualquer caractere, incluindo novas linhas.

@item

@ref{181a,,IGNORECASE}, @ref{248b,,I}

@tab

Faz combinações sem diferenciar maiúsculo de minúsculo.

@item

@ref{b82,,LOCALE}, @ref{248c,,L}

@tab

Faz uma correspondência considerando a localidade.

@item

@ref{2489,,MULTILINE}, @ref{248d,,M}

@tab

Correspondência multilinha, afetando @code{^} e @code{$}.

@item

@ref{2497,,VERBOSE}, @ref{2490,,X} (de ‘extended’; estendido em inglês)

@tab

Habilita REs detalhadas, que podem ser organizadas de forma mais clara e compreensível.

@end multitable



@deffn {Dado} re.I

@deffnx {Dado} re.IGNORECASE

Faz correspondência sem distinção entre maiúsculas e minúsculas; a classe de caracteres e as strings literais corresponderão às letras ignorando maiúsculas e minúsculas. Por exemplo, @code{[A-Z]} corresponderá às letras minúsculas também. A correspondência Unicode completa também funciona, a menos que o sinalizador @ref{62c,,ASCII} seja usado para desabilitar correspondências não ASCII. Quando os padrões Unicode @code{[a-z]} ou @code{[A-Z]} são usados em combinação com o sinalizador @ref{181a,,IGNORECASE}, eles corresponderão às 52 letras ASCII e 4 letras não ASCII adicionais: ‘İ’ (U+0130, letra maiúscula latina I com ponto acima), ‘ı’ (U+0131, letra minúscula latina i sem ponto), ‘ſ’ (U+017F, letra minúscula latina s longo) e ‘K’ (U+212A, sinal Kelvin). @code{Spam} corresponderá a @code{'Spam'}, @code{'spam'}, @code{'spAM'} ou @code{'ſpam'} (o último é correspondido apenas no modo Unicode). Essa capitalização em minúsculas não leva em conta a localidade atual; levará se você também definir o sinalizador @ref{b82,,LOCALE}.
@end deffn


@deffn {Dado} re.L

@deffnx {Dado} re.LOCALE

Faz com que @code{\w}, @code{\W}, @code{\b}, @code{\B} e a correspondência sem diferenciação de maiúsculas e minúsculas dependam da localidade atual em vez do banco de dados Unicode.

Localidades são um recurso da biblioteca C destinado a ajudar na escrita de programas que levam em conta as diferenças de idioma. Por exemplo, se você estiver processando texto codificado em francês, você gostaria de ser capaz de escrever @code{\w+} para corresponder a palavras, mas @code{\w} corresponde apenas à classe de caracteres @code{[A-Za-z]} em padrões de bytes; ele não corresponderá a bytes correspondentes a @code{é} ou @code{ç}. Se seu sistema estiver configurado corretamente e uma localidade francesa for selecionada, certas funções C dirão ao programa que o byte correspondente a @code{é} também deve ser considerado uma letra. Definir o sinalizador @ref{b82,,LOCALE} ao compilar uma expressão regular fará com que o objeto compilado resultante use essas funções C para @code{\w}; isso é mais lento, mas também permite que @code{\w+} corresponda a palavras francesas como você esperaria. O uso deste sinalizador é desencorajado no Python 3, pois o mecanismo de localidade é muito pouco confiável, ele só manipula uma “cultura” por vez e só funciona com localidades de 8 bits. A correspondência Unicode já está habilitada por padrão no Python 3 para padrões Unicode (str), e é capaz de manipular diferentes localidades/idiomas.
@end deffn


@deffn {Dado} re.M

@deffnx {Dado} re.MULTILINE

(@code{^} e @code{$} ainda não foram explicados, eles serão comentados na seção @ref{540e,,Mais metacaracteres}.)

Normalmente @code{^} corresponde apenas ao início da string e @code{$} corresponde apenas ao final da string, e imediatamente antes da nova linha (se existir) no final da string. Quando este sinalizador é especificada, o @code{^} corresponde ao início da string e ao início de cada linha dentro da string, imediatamente após cada nova linha. Da mesma forma, o metacaractere @code{$} corresponde tanto ao final da string e ao final de cada linha (imediatamente antes de cada nova linha).
@end deffn


@deffn {Dado} re.S

@deffnx {Dado} re.DOTALL

Faz o caractere especial @code{.} corresponder com qualquer caractere que seja, incluindo uma nova linha; sem este sinalizador, @code{.} irá corresponder a qualquer coisa, exceto uma nova linha.
@end deffn


@deffn {Dado} re.A

@deffnx {Dado} re.ASCII

Faz com que @code{\w}, @code{\W}, @code{\b}, @code{\B},  @code{\s} e @code{\S} executem a correspondência somente ASCII em vez da correspondência Unicode completa. Isso é significativo apenas para padrões Unicode e é ignorado para padrões de bytes.
@end deffn


@deffn {Dado} re.X

@deffnx {Dado} re.VERBOSE

Este sinalizador permite escrever expressões regulares mais legíveis, permitindo mais flexibilidade na maneira de formatá-la. Quando este sinalizador é especificado, o espaço em branco dentro da string RE é ignorado, exceto quando o espaço em branco está em uma classe de caracteres ou precedido por uma barra invertida não “escapada”; isto permite organizar e formatar a RE de maneira mais clara. Este sinalizador também permite que se coloque comentários dentro de uma RE que serão ignorados pelo mecanismo; os comentários são marcados por um “#” que não está nem em uma classe de caracteres nem precedido por uma barra invertida não “escapada”.

Por exemplo, aqui está uma RE que usa @ref{2497,,re.VERBOSE}; consegue ver o quanto mais fácil de ler é?

@example
charref = re.compile(r"""
 &[#]                # Início de uma referência à entidade numérica
 (
     0[0-7]+         # Forma octal
   | [0-9]+          # Forma decimal
   | x[0-9a-fA-F]+   # Forma hexadecimal
 )
 ;                   # Ponto e vírgula ao final
""", re.VERBOSE)
@end example

Sem o “verbose” definido, A RE iria se parecer como isto:

@example
charref = re.compile("&#(0[0-7]+"
                     "|[0-9]+"
                     "|x[0-9a-fA-F]+);")
@end example

No exemplo acima, a concatenação automática de strings literais em Python foi usada para quebrar a RE em partes menores, mas ainda é mais difícil de entender do que a versão que usa @ref{2497,,re.VERBOSE}.
@end deffn

@node Mais poder dos padrões,Modificando strings,Usando expressões regulares,Expressões Regulares
@anchor{howto/regex more-pattern-power}@anchor{540f}
@subsection Mais poder dos padrões


Até agora, cobrimos apenas uma parte dos recursos das expressões regulares. Nesta seção, vamos abordar alguns metacaracteres novos, e como usar grupos para recuperar partes do texto que teve correspondência.

@menu
* Mais metacaracteres:: 
* Agrupamento:: 
* Não captura e grupos nomeados:: 
* Asserções lookahead:: 

@end menu

@node Mais metacaracteres,Agrupamento,,Mais poder dos padrões
@anchor{howto/regex id2}@anchor{5410}@anchor{howto/regex more-metacharacters}@anchor{540e}
@subsubsection Mais metacaracteres


Existem alguns metacaracteres que nós ainda não vimos. A maioria deles serão referenciados nesta seção.

Alguns dos metacaracteres restantes a serem discutidos são como uma asserção de @code{largura zero} (zero-width assertions). Eles não fazem com que o mecanismo avance pela string; ao contrário, eles não consomem nenhum caractere, e simplesmente tem sucesso ou falha. Por exemplo, @code{\b} é uma afirmação de que a posição atual está localizada nas bordas de uma palavra; a posição não é alterada de nenhuma maneira por @code{\b}. Isto significa que afirmações de @code{largura zero} nunca devem ser repetidas, porque se elas combinam uma vez em um determinado local, elas podem, obviamente, combinar um número infinito de vezes.


@table @asis

@item @code{|}

Alternância, ou operador “or”. Se `A' e `B' são expressões regulares, @code{A|B} irá corresponder com qualquer string que corresponder com `A' ou `B'. @code{|} tem uma prioridade muito baixa, a fim de fazê-lo funcionar razoavelmente quando você está alternando entre strings de vários caracteres. @code{Crow|Servo} irá corresponder tanto com @code{'Crow'} quanto com @code{'Servo'}, e não com @code{'Cro'}, @code{'w'} ou @code{'S'}, e @code{'ervo'}.

Para corresponder com um @code{'|'} literal, use @code{\|}, ou coloque ele dentro de uma classe de caracteres, como em @code{[|]}.

@item @code{^}

Corresponde ao início de linha. A menos que o sinalizador @ref{2489,,MULTILINE} tenha sido definido, isso só irá corresponder ao início da string. No modo @ref{2489,,MULTILINE}, isso também corresponde imediatamente após cada nova linha de dentro da string.

Por exemplo, para ter correspondência com a palavra @code{From} apenas no início de uma linha, a RE a ser usada é @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 corresponder a um @code{'^'} literal, use @code{\^}.

@item @code{$}

Corresponde ao fim de uma linha, que tanto é definido como o fim de uma string, ou qualquer local seguido por um caractere de nova linha.

@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 corresponder com um @code{'$'} literal, use @code{\$} ou coloque-o dentro de uma classe de caracteres, como em @code{[$]}.

@item @code{\A}

Corresponde apenas com o início da string. Quando não estiver em modo @ref{2489,,MULTILINE}, @code{\A} e @code{^} são efetivamente a mesma coisa. No modo @ref{2489,,MULTILINE}, eles são diferentes: @code{\A} continua a corresponder apenas com o início da string, mas @code{^} pode corresponder com qualquer localização de dentro da string, que seja posterior a um caractere nova linha.

@item @code{\Z}

Corresponde apenas ao final da string.

@item @code{\b}

Borda de palavra. Esta é uma asserção de largura zero que corresponde apenas ao início ou ao fim de uma palavra. Uma palavra é definida como uma sequência de caracteres alfanuméricos, então o fim de uma palavra é indicado por espaço em branco ou um caractere não alfanumérico.

O exemplo a seguir corresponde a @code{class} apenas quando é a palavra exata; ele não irá corresponder quando for contido dentro de uma outra palavra.

@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

Há duas sutilezas que você deve lembrar ao usar essa sequência especial. Em primeiro lugar, esta é a pior colisão entre strings literais do Python e sequências de expressão regular. Nas strings literais do Python, @code{\b} é o caractere backspace, o valor ASCII 8. Se você não estiver usando strings brutas, então Python irá converter o @code{\b} em um backspace e sua RE não irá funcionar da maneira que você espera. O exemplo a seguir parece igual a nossa RE anterior, mas omite o @code{'r'} na frente da string 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

Além disso, dentro de uma classe de caracteres, onde não há nenhum uso para esta asserção, @code{\b} representa o caractere backspace, para compatibilidade com strings literais do Python

@item @code{\B}

Outra asserção de largura zero; isto é o oposto de @code{\b}, correspondendo apenas quando a posição corrente não é de uma borda de palavra.
@end table

@node Agrupamento,Não captura e grupos nomeados,Mais metacaracteres,Mais poder dos padrões
@anchor{howto/regex grouping}@anchor{5411}
@subsubsection Agrupamento


Frequentemente é necessário obter mais informações do que apenas se a RE teve correspondência ou não. As expressões regulares são muitas vezes utilizadas para dissecar strings escrevendo uma RE dividida em vários subgrupos que correspondem a diferentes componentes de interesse. Por exemplo, uma linha de cabeçalho RFC-822 é dividida em um nome de cabeçalho e um valor, separados por um @code{':'}, como essa:

@example
From: author@@example.com
User-Agent: Thunderbird 1.5.0.9 (X11/20061227)
MIME-Version: 1.0
To: editor@@example.com
@end example

Isto pode ser tratado escrevendo uma expressão regular que corresponde com uma linha inteira de cabeçalho, e tem um grupo que corresponde ao nome do cabeçalho, e um outro grupo, que corresponde ao valor do cabeçalho.

Os grupos são marcados pelos metacaracteres @code{'('} e @code{')'}. @code{'('} e @code{')'} têm muito do mesmo significado que eles têm em expressões matemáticas; eles agrupam as expressões contidas dentro deles, e você pode repetir o conteúdo de um grupo com um qualificador de repetição, como @code{*}, @code{+}, @code{?}, ou @code{@{m,n@}}. Por exemplo, @code{(ab)*} irá corresponder a zero ou mais repetições de @code{ab}.

@example
>>> p = re.compile('(ab)*')
>>> print(p.match('ababababab').span())
(0, 10)
@end example

Grupos indicados com @code{'('} e @code{')'} também capturam o índice inicial e final do texto que eles correspondem; isso pode ser obtido por meio da passagem de um argumento para @ref{1061,,group()}, @ref{24ac,,start()}, @ref{24ad,,end()} e @ref{24ae,,span()}. Os grupos são numerados começando com 0. O grupo 0 está sempre presente; é toda a RE, de forma que os métodos de @ref{fbc,,objeto de correspondência} têm todos o grupo 0 como seu argumento padrão. Mais tarde veremos como expressar grupos que não capturam a extensão de texto com a qual eles correspondem.

@example
>>> p = re.compile('(a)b')
>>> m = p.match('ab')
>>> m.group()
'ab'
>>> m.group(0)
'ab'
@end example

Subgrupos são numerados a partir da esquerda para a direita, de forma crescente a partir de 1. Os grupos podem ser aninhados; para determinar o número, basta contar os caracteres de abertura de parêntese @code{(}, indo da esquerda para a direita.

@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{1061,,group()} pode receber vários números de grupos de uma vez, e nesse caso ele irá retornar uma tupla contendo os valores correspondentes desses grupos.

@example
>>> m.group(2,1,2)
('b', 'abc', 'b')
@end example

O método @ref{1062,,groups()} retorna uma tupla contendo as strings de todos os subgrupos, de 1 até o último.

@example
>>> m.groups()
('abc', 'b')
@end example

Referências anteriores em um padrão permitem que você especifique que o conteúdo de um grupo capturado anteriormente também deve ser encontrado na posição atual na sequência. Por exemplo, @code{\1} terá sucesso se o conteúdo exato do grupo 1 puder ser encontrado na posição atual, e falha caso contrário. Lembre-se que as strings literais do Python também usam a contrabarra seguida por números para permitir a inclusão de caracteres arbitrários em uma string, por isso certifique-se de usar strings brutas ao incorporar referências anteriores em uma RE.

Por exemplo, a seguinte RE detecta palavras duplicadas em uma string.

@example
>>> p = re.compile(r'\b(\w+)\s+\1\b')
>>> p.search('Paris in the the spring').group()
'the the'
@end example

Referências anteriores como esta não são, geralmente, muito úteis apenas para fazer pesquisa em uma string — existem alguns formatos de texto que repetem dados dessa forma — mas em breve você irá descobrir que elas são muito úteis para realizar substituições de strings.

@node Não captura e grupos nomeados,Asserções lookahead,Agrupamento,Mais poder dos padrões
@anchor{howto/regex non-capturing-and-named-groups}@anchor{5412}
@subsubsection Não captura e grupos nomeados


REs elaboradas podem usar muitos grupos, tanto para capturar substrings de interesse, quanto para agrupar e estruturar a própria RE. Em REs complexas, torna-se difícil manter o controle dos números dos grupos. Existem dois recursos que ajudam a lidar com esse problema. Ambos usam uma sintaxe comum para extensões de expressão regular, então vamos olhar primeiro para isso.

O Perl 5 é bem conhecido por suas poderosas adições às expressões regulares padrão. Para esses novos recursos, os desenvolvedores do Perl não podiam escolher novos metacaracteres de um único caractere ou novas sequências especiais começando com @code{\} sem tornar as expressões regulares do Perl confusamente diferentes das REs padrão. Se eles escolhessem @code{&} como um novo metacaractere, por exemplo, as expressões antigas estariam presumindo que @code{&} era um caractere regular e não teriam escapado dele escrevendo @code{\&} ou @code{[&]}.

A solução escolhida pelos desenvolvedores do Perl foi usar @code{(?...)} como uma sintaxe de extensão. Um @code{?} imediatamente após um parêntese era um erro de sintaxe porque o @code{?} não teria nada a repetir, de modo que isso não introduz quaisquer problemas de compatibilidade. Os caracteres imediatamente após um @code{?} indicam que a extensão está sendo usada, então @code{(?=foo)} é uma coisa (uma asserção @code{lookahead} positiva) e @code{(?:foo)} é outra coisa (um grupo de não-captura contendo a subexpressão @code{foo}).

Python oferece suporte a diversas extensões do Perl e adiciona uma sintaxe de extensão à sintaxe de extensão do Perl. Se o primeiro caractere após o ponto de interrogação for um @code{P}, você sabe que se trata de uma extensão específica do Python.

Agora que vimos a sintaxe geral da extensão, podemos retornar aos recursos que simplificam o trabalho com grupos em REs complexas.

Às vezes você vai querer usar um grupo para representar uma parte de uma expressão regular, mas não está interessado em recuperar o conteúdo do grupo. Você pode tornar isso explícito usando um grupo de não-captura: @code{(?:...)}, onde você pode substituir o @code{...} por qualquer outra expressão regular.

@example
>>> m = re.match("([abc])+", "abc")
>>> m.groups()
('c',)
>>> m = re.match("(?:[abc])+", "abc")
>>> m.groups()
()
@end example

Exceto pelo fato de que não é possível recuperar o conteúdo sobre o qual o grupo corresponde, um grupo de não-captura se comporta exatamente da mesma forma que um grupo de captura; você pode colocar qualquer coisa dentro dele, repeti-lo com um metacaractere de repetição, como o @code{*}, e aninhá-lo dentro de outros grupos (de captura ou não-captura). @code{(?:...)} é particularmente útil para modificar um padrão existente, já que você pode adicionar novos grupos sem alterar a forma como todos os outros grupos estão numerados. Deve ser mencionado que não há diferença de desempenho na busca entre grupos de captura e grupos de não-captura; uma forma não é mais rápida que outra.

Uma característica mais significativa são os grupos nomeados: em vez de se referir a eles por números, os grupos podem ser referenciados por um nome.

A sintaxe de um grupo nomeado é uma das extensões específicas do Python: @code{(?P<name>...)}. `name' é, obviamente, o nome do grupo. Os grupos nomeados se comportam exatamente como os grupos de captura, e, adicionalmente, associam um nome a um grupo. Todos os métodos de @ref{fbc,,objeto correspondência} que lidam com grupos de captura aceitam tanto inteiros que se referem ao grupo por número ou strings que contêm o nome do grupo desejado. Os grupos nomeados ainda recebem números, então você pode recuperar informações sobre um grupo de duas maneiras:

@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

Além disso, você pode recuperar grupos nomeados como um dicionário com @ref{24ab,,groupdict()}:

@example
>>> m = re.match(r'(?P<first>\w+) (?P<last>\w+)', 'Jane Doe')
>>> m.groupdict()
@{'first': 'Jane', 'last': 'Doe'@}
@end example

Os grupos nomeados são úteis porque eles permitem que você use nomes de fácil lembrança, em vez de ter que lembrar de números. Aqui está um exemplo de RE usando o 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 muito mais fácil fazer referência a @code{m.group('zonem')}, do que ter que se lembrar de capturar o grupo 9.

A sintaxe para referências anteriores em uma expressão, tal como @code{(...)\1}, faz referência ao número do grupo. Existe, naturalmente, uma variante que usa o nome do grupo em vez do número. Isto é outra extensão Python: @code{(?P=name)} indica que o conteúdo do grupo chamado `name' deve, novamente, ser correspondido no ponto atual. A expressão regular para encontrar palavras duplicadas, @code{(\b\w+)\s+\1}, também pode ser escrita como @code{(?P<word>\b\w+)\s+(?P=word)}:

@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 Asserções lookahead,,Não captura e grupos nomeados,Mais poder dos padrões
@anchor{howto/regex lookahead-assertions}@anchor{5413}
@subsubsection Asserções lookahead


Outra asserção de “largura zero” é a asserção lookahead. Asserções lookahead estão disponíveis tanto na forma positiva quanto na negativa, e se parece com isto:


@table @asis

@item @code{(?=...)}

Asserção lookahead positiva. É bem-sucedida se a expressão regular informada, aqui representada por @code{...}, corresponde com o conteúdo da localização atual, e falha caso contrário. Mas, uma vez que a expressão informada tenha sido testada, o mecanismo de correspondência não faz qualquer avanço; o resto do padrão é tentado no mesmo local de onde a asserção foi iniciada.

@item @code{(?!...)}

Asserção lookahead negativa. É o oposto da asserção positiva; será bem-sucedida se a expressão informada não corresponder com o conteúdo da posição atual na string.
@end table

Para tornar isto concreto, vamos olhar para um caso em que uma lookahead é útil. Considere um padrão simples para corresponder com um nome de arquivo e dividi-lo em pedaços, um nome base e uma extensão, separados por um @code{.}. Por exemplo, em @code{news.rc}, @code{news} é o nome base, e @code{rc} é a extensão do nome de arquivo.

O padrão para corresponder com isso é muito simples:

@code{.*[.].*$}

Observe que o @code{.} precisa ser tratado de forma especial, pois é um metacaractere e, portanto, está dentro de uma classe de caracteres para corresponder apenas a esse caractere específico. Observe também o @code{$} ao final; ele é adicionado para garantir que todo o restante da string seja incluído na extensão. Esta expressão regular corresponde a @code{foo.bar}, @code{autoexec.bat}, @code{sendmail.cf} e @code{printers.conf}.

Agora, considere complicar um pouco o problema; e se você desejar corresponder com nomes de arquivos onde a extensão não é @code{bat}? Algumas tentativas incorretas:

@code{.*[.][^b].*$}

A primeira tentativa acima tenta excluir @code{bat}, exigindo que o primeiro caractere da extensão não seja um @code{b}. Isso é errado, porque o padrão também não corresponde a @code{foo.bar}.

@code{.*[.]([^b]..|.[^a].|..[^t])$}

A expressão fica mais confusa se você tentar remendar a primeira solução, exigindo que uma das seguintes situações corresponda: o primeiro caractere da extensão não é @code{b}; o segundo caractere não é @code{a}; ou o terceiro caractere não é @code{t}. Isso aceita @code{foo.bar} e rejeita @code{autoexec.bat}, mas requer uma extensão de três letras e não aceitará um nome de arquivo com uma extensão de duas letras, tal como @code{sendmail.cf}. Nós iremos complicar o padrão novamente em um esforço para corrigi-lo.

@code{.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$}

Na terceira tentativa, a segunda e terceira letras são todas consideradas opcionais, a fim de permitir correspondência com as extensões mais curtas do que três caracteres, tais como @code{sendmail.cf}.

Agora, o padrão está ficando realmente muito complicado, o que faz com que seja difícil de ler e compreender. Pior ainda, se o problema mudar e você quiser excluir tanto @code{bat} quanto @code{exe} como extensões, o padrão iria ficar ainda mais complicado e confuso.

Uma lookahead negativo elimina toda esta confusão:

@code{.*[.](?!bat$)[^.]*$}

A lookahead negativa significa: se a expressão @code{bat} não corresponder até este momento, tente o resto do padrão; se @code{bat$} tem correspondência, todo o padrão irá falhar. O final @code{$} é necessário para garantir que algo como @code{sample.batch}, onde a extensão só começa com o @code{bat}, será permitido.

Excluir uma outra extensão de nome de arquivo agora é fácil; basta fazer a adição de uma alternativa dentro da asserção. O padrão a seguir exclui os nomes de arquivos que terminam com @code{bat} ou @code{exe}:

@code{.*[.](?!bat$|exe$)[^.]*$}

@node Modificando strings,Problemas comuns,Mais poder dos padrões,Expressões Regulares
@anchor{howto/regex modifying-strings}@anchor{5414}
@subsection Modificando strings


Até este ponto, nós simplesmente realizamos pesquisas em uma string estática. As expressões regulares também são comumente usadas para modificar strings através de várias maneiras, usando os seguintes métodos padrão:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Método/Atributo

@tab

Propósito

@item

@code{split()}

@tab

Divide a string em uma lista, dividindo-a onde quer que haja correspondência com a RE

@item

@code{sub()}

@tab

Encontra todas as substrings que correspondem com a RE e faz a substituição por uma string diferente

@item

@code{subn()}

@tab

Faz a mesma coisa que @code{sub()}, mas retorna a nova string e o número de substituições

@end multitable


@menu
* Dividindo as strings:: 
* Busca e Substituição: Busca e Substituição<2>. 

@end menu

@node Dividindo as strings,Busca e Substituição<2>,,Modificando strings
@anchor{howto/regex splitting-strings}@anchor{5415}
@subsubsection Dividindo as strings


O método @ref{249f,,split()} de um padrão divide uma string em pedaços onde quer que a RE corresponda, retornando uma lista formada por esses pedaços. É semelhante ao método @ref{ed9,,split()} de strings, mas oferece muito mais generalidade nos delimitadores que pode usar para fazer a divisão; @code{split()} só implementa a divisão por espaço em branco ou por uma string fixa. Como você deve deduzir, existe também uma função a nível de módulo @ref{2a2,,re.split()}.


@deffn {Método} .split (string[, maxsplit=0])

Divide `string' usando a correspondência com uma expressão regular. Se os parênteses de captura forem utilizados na RE, então seu conteúdo também será retornado como parte da lista resultante. Se `maxsplit' é diferente de zero, serão feitas no máximo `maxplit' divisões.
@end deffn

Você pode limitar o número de divisões feitas, passando um valor para `maxsplit'. Quando `maxsplit' é diferente de zero, serão feita no máximo @code{maxsplit} divisões, e o restante da string é retornado como o elemento final da lista. No exemplo a seguir, o delimitador é qualquer sequência de caracteres não 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

Às vezes, você não está interessado apenas no texto que está entre os delimitadores, mas também precisa saber qual o delimitador foi usado. Se os parênteses de captura são utilizados na RE, então os respectivos valores são também retornados como parte da lista. Compare as seguintes chamadas:

@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

A função de nível de módulo @ref{2a2,,re.split()} adiciona a RE a ser utilizada como o primeiro argumento, mas, fora isso, é a mesma.

@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 Busca e Substituição<2>,,Dividindo as strings,Modificando strings
@anchor{howto/regex search-and-replace}@anchor{5416}
@subsubsection Busca e Substituição


Outra tarefa comum é encontrar todas as combinações para um padrão e substituí-las por uma string diferente. O método @ref{24a2,,sub()} recebe um valor de substituição, que pode ser uma string ou uma função, e a string a ser processada.


@deffn {Método} .sub (replacement, string[, count=0])

Retorna a string obtida substituindo as ocorrências mais à esquerda não sobrepostas da RE em @code{string} pelo valor de substituição @code{replacement}. Se o padrão não for encontrado, a @code{string} é retornada inalterada.

O argumento opcional `count' é o número máximo de ocorrências do padrão a ser substituído; `count' deve ser um número inteiro não negativo. O valor padrão 0 significa substituir todas as ocorrências.
@end deffn

Aqui está um exemplo simples do uso do método @ref{24a2,,sub()}. Ele substitui nomes de cores pela palavra @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

O método @ref{24a3,,subn()} faz o mesmo trabalho, mas retorna uma tupla com duas informações: uma string com novo valor e o número de substituições que foram realizadas:

@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

Correspondências vazias somente são substituídas quando não estão adjacente (próxima) a uma correspondência vazia anterior.

@example
>>> p = re.compile('x*')
>>> p.sub('-', 'abxd')
'-a-b--d-'
@end example

Se o valor de substituição (`replacement') é uma string, qualquer barra invertida é interpretada e processada. Isto é, @code{\n} é convertido a um único caractere de nova linha, @code{\r} é convertido em um retorno do carro, e assim por diante. Casos desconhecidos, como @code{\&} são ignorados. Referências anteriores, como @code{\6}, são substituídas com a substring correspondida pelo grupo correspondente na RE. Isso permite que você incorpore partes do texto original na string de substituição resultante.

Este exemplo corresponde com a palavra @code{section}, seguida por uma string colocada entre @code{@{}, @code{@}}, e altera @code{section} para @code{subsection}:

@example
>>> p = re.compile('section@{ ( [^@}]* ) @}', re.VERBOSE)
>>> p.sub(r'subsection@{\1@}','section@{First@} section@{second@}')
'subsection@{First@} subsection@{second@}'
@end example

Há também uma sintaxe para se referir a grupos nomeados como definido pela sintaxe @code{(?P<name>...)}. @code{\g<name>} usará a substring correspondida pelo grupo com nome @code{name} e @code{\g<number>} utiliza o número do grupo correspondente. @code{\g<2>} é, portanto, equivalente a @code{\2}, mas não é ambígua em uma string de substituição, tal como @code{\g<2>0}. (@code{\20} seria interpretado como uma referência ao grupo de 20, e não uma referência ao grupo 2 seguido pelo caractere literal @code{'0'}). As substituições a seguir são todas equivalentes, mas usam todas as três variações da string de substituição.

@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' também pode ser uma função, que lhe dá ainda mais controle. Se `replacement' for uma função, a função será chamada para todas as ocorrências não sobrepostas de `pattern'. Em cada chamada, a função recebe um argumento de @ref{fbc,,objeto Match} para a correspondência e pode usar essas informações para calcular a string de substituição desejada e retorná-la.

No exemplo a seguir, a função de substituição traduz decimais em hexadecimal:

@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

Ao utilizar a função de nível de módulo @ref{2a3,,re.sub()}, o padrão é passado como o primeiro argumento. O padrão pode ser fornecido como um objeto ou como uma string; se você precisa especificar sinalizadores de expressões regulares, você deve usar um objeto padrão como o primeiro parâmetro, ou usar modificadores embutidos na string padrão, por exemplo, @code{sub("(?i)b+", "x", "bbbb BBBB")} retorna @code{'x x'}.

@node Problemas comuns,Comentários<2>,Modificando strings,Expressões Regulares
@anchor{howto/regex common-problems}@anchor{5417}
@subsection Problemas comuns


Expressões regulares são uma ferramenta poderosa para algumas aplicações, mas de certa forma o seu comportamento não é intuitivo, e às vezes, as RE não se comportam da maneira que você espera que elas se comportem. Esta seção irá apontar algumas das armadilhas mais comuns.

@menu
* Usando métodos de string:: 
* match() versus search(): match versus search. 
* Gulosos versus não-gulosos:: 
* Usando re.VERBOSE: Usando re VERBOSE. 

@end menu

@node Usando métodos de string,match versus search,,Problemas comuns
@anchor{howto/regex use-string-methods}@anchor{5418}
@subsubsection Usando métodos de string


Às vezes, usar o módulo @ref{b9,,re} é um equívoco. Se você está fazendo correspondência com uma string fixa, ou uma classe de caractere única, e você não está usando nenhum recurso de @ref{b9,,re} como o sinalizador @ref{181a,,IGNORECASE}, então pode não ser necessário todo o poder das expressões regulares. Strings possuem vários métodos para executar operações com strings fixas e eles são, geralmente, muito mais rápidos, porque a implementação é um único e pequeno laço de repetição em C que foi otimizado para esse propósito, em vez do grande e mais generalizado mecanismo das expressões regulares.

Um exemplo pode ser a substituição de uma string fixa única por outra; por exemplo, você pode substituir @code{word} por @code{deed}. @ref{2a3,,re.sub()} parece ser a função a ser usada para isso, mas considere o método @ref{19a,,replace()}. Note que @code{replace()} também irá substituir @code{word} dentro de palavras, transformando @code{swordfish} em @code{sdeedfish}, mas uma RE ingênua teria feito isso também. (Para evitar a realização da substituição de partes de palavras, o padrão teria que ser @code{\bword\b}, a fim de exigir que @code{word} tenha um delimitador de palavra em ambos os lados. Isso leva a tarefa para além da capacidade de @code{replace()}.)

Outra tarefa comum é apagar todas as ocorrências de um único caractere de uma string ou substituí-lo por um outro caractere único. Você pode fazer isso com algo como @code{re.sub('\n', ' ', S)}, mas @ref{2364,,translate()} é capaz de fazer ambas as tarefas e será mais rápida do que qualquer operação de expressão regular pode ser.

Em suma, antes de recorrer ao o módulo @ref{b9,,re}, considere se o seu problema pode ser resolvido com um método de string mais rápido e mais simples.

@node match versus search,Gulosos versus não-gulosos,Usando métodos de string,Problemas comuns
@anchor{howto/regex match-versus-search}@anchor{5419}
@subsubsection match() versus search()


A função @ref{126e,,match()} somente verifica se a  RE corresponde ao início da string, enquanto @ref{126d,,search()} fará a varredura percorrendo a string procurando por uma correspondência. É importante manter esta distinção em mente. Lembre-se, @code{match()} só irá relatar uma correspondência bem-sucedida que começa em 0; se a correspondência não começar em zero, @code{match()} `não' vai reportá-la.

@example
>>> print(re.match('super', 'superstition').span())
(0, 5)
>>> print(re.match('super', 'insuperable'))
None
@end example

Por outro lado, @ref{126d,,search()} fará a varredura percorrendo a string e relatando a primeira correspondência que encontrar.

@example
>>> print(re.search('super', 'superstition').span())
(0, 5)
>>> print(re.search('super', 'insuperable').span())
(2, 7)
@end example

Às vezes, você vai ficar tentado a continuar usando @ref{126e,,re.match()}, e apenas adicionar @code{.*} ao início de sua RE. Resista a essa tentação e use @ref{126d,,re.search()} em vez disso. O compilador de expressão regular faz alguma análise das REs, a fim de acelerar o processo de procura de uma correspondência. Tal análise descobre o que o primeiro caractere de uma string deve ser; por exemplo, um padrão começando com @code{Crow} deve corresponder com algo iniciando com @code{'C'}. A análise permite que o mecanismo faça a varredura rapidamente através da string a procura do caractere inicial, apenas tentando a combinação completa se um @code{'C'} for encontrado.

Adicionar um @code{.*} evita essa otimização, sendo necessário a varredura até o final da string e, em seguida, retroceder para encontrar uma correspondência para o resto da RE. Use @ref{126d,,re.search()} em vez disso.

@node Gulosos versus não-gulosos,Usando re VERBOSE,match versus search,Problemas comuns
@anchor{howto/regex greedy-versus-non-greedy}@anchor{541a}
@subsubsection Gulosos versus não-gulosos


Ao repetir uma expressão regular, como em @code{a*}, a ação resultante é consumir o tanto do padrão quanto possível. Este fato, muitas vezes derruba você quando você está tentando corresponder com um par de delimitadores balanceados, tal como os colchetes que cercam uma tag HTML. O padrão ingênuo para combinar uma única tag HTML não funciona por causa da natureza gulosa 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

A RE corresponde a @code{'<'} em @code{'<html>'}, e o @code{.*} consome o resto da string. Existe ainda mais coisa existente na RE, no entanto, e o @code{>} pode não corresponder com o final da string, de modo que o mecanismo de expressão regular tem que recuar caractere por caractere até encontrar uma correspondência para @code{>}. A correspondência final se estende do @code{'<'} em @code{'<html>'} ao @code{'>'} em @code{'</title>'}, que não é o que você quer.

Neste caso, a solução é usar os quantificadores não-gulosos @code{*?}, @code{+?}, @code{??} ou @code{@{m,n@}?}, que corresponde com o mínimo de texto possível. No exemplo acima, o @code{'>'} é tentado imediatamente após a primeira correspondência de @code{'<'}, e quando ele falhar, o mecanismo avança um caractere de cada vez, experimentado @code{'>'} a cada passo. Isso produz justamente o resultado correto:

@example
>>> print(re.match('<.*?>', s).group())
<html>
@end example

(Note que a análise de HTML ou XML com expressões regulares é dolorosa. Padrões “sujos e rápidos” irão lidar com casos comuns, mas HTML e XML tem casos especiais que irão quebrar expressões regulares óbvias; com o tempo, expressões regulares que você venha a escrever para lidar com todos os casos possíveis, se tornarão um padrão muito complicado. Use um módulo de análise de HTML ou XML para tais tarefas.)

@node Usando re VERBOSE,,Gulosos versus não-gulosos,Problemas comuns
@anchor{howto/regex using-re-verbose}@anchor{541b}
@subsubsection Usando re.VERBOSE


Nesse momento, você provavelmente deve ter notado que as expressões regulares são de uma notação muito compacta, mas não é possível dizer que são legíveis. REs de complexidade moderada podem se tornar longas coleções de barras invertidas, parênteses e metacaracteres, fazendo com que se tornem difíceis de ler e compreender.

Para tais REs, especificar a flag @ref{2497,,re.VERBOSE} ao compilar a expressão regular pode ser útil, porque permite que você formate a expressão regular de forma mais clara.

O sinalizador @code{re.VERBOSE} produz vários efeitos. Espaço em branco na expressão regular que não está dentro de uma classe de caracteres é ignorado. Isto significa que uma expressão como @code{dog | cat} é equivalente ao menos legível @code{dog|cat}, mas @code{[a b]} ainda vai coincidir com os caracteres @code{a}, @code{b}, ou um @code{espaço}. Além disso, você também pode colocar comentários dentro de uma RE, que se estendem de um caractere @code{#} até a próxima nova linha. Quando usados junto com strings de aspas triplas, isso permite as REs serem formatadas mais ordenadamente:

@example
pat = re.compile(r"""
 \s*                 # Ignora espaços em branco no início
 (?P<header>[^:]+)   # Nome do cabeçalho
 \s* :               # Espaço em branco e caractere de dois pontos
 (?P<value>.*?)      # O valor do cabeçalho -- o *? costumava
                     # perder o seguinte espaço em branco ao final
 \s*$                # Espaço em branco no final até o fim da linha
""", re.VERBOSE)
@end example

Isso é muito mais legível do que:

@example
pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
@end example

@node Comentários<2>,,Problemas comuns,Expressões Regulares
@anchor{howto/regex feedback}@anchor{541c}
@subsection Comentários


Expressões regulares são um tópico complicado. Esse documento ajudou você a compreendê-las? Existem partes que foram pouco claras, ou situações que você vivenciou que não foram abordadas aqui? Se assim for, por favor, envie sugestões de melhorias para o autor.

O livro mais completo sobre expressões regulares é quase certamente o Mastering Regular Expressions de Jeffrey Friedl’s, publicado pela O’Reilly. Infelizmente, ele se concentra exclusivamente em sabores de expressões regulares do Perl e do Java, e não contém qualquer material relativo a Python, por isso não vai ser útil como uma referência para a programação em Python. (A primeira edição cobre o módulo @code{regex} agora removido do Python, o que não vai te ajudar muito.) Considere removê-lo de sua biblioteca.

@node Programação de Soquetes,Técnicas de ordenação,Expressões Regulares,Python HOWTOs
@anchor{howto/sockets doc}@anchor{541d}@anchor{howto/sockets socket-howto}@anchor{3653}@anchor{howto/sockets socket-programming-howto}@anchor{541e}@anchor{howto/sockets translation-repo}@anchor{541f}
@section Programação de Soquetes


@*Autor: 
Gordon McMillan


@subsubheading Resumo



Os soquetes são usados em quase todos os lugares, mas são uma das tecnologias mais mal compreendidas. Esta é uma visão geral contendo 10.000 pontos a respeitos dos soquetes. Não é realmente um tutorial - ainda terás o trabalho para tornar tudo operacionais. Não abrange os pontos finos (e há muitos deles), mas espero que lhe dê uma base suficiente para começar a utilizar de maneira correta.

@menu
* Soquetes:: 
* Criando um Soquete:: 
* Usando um Soquete:: 
* Desconectando:: 
* Soquetes não-bloqueantes:: 

@end menu

@node Soquetes,Criando um Soquete,,Programação de Soquetes
@anchor{howto/sockets sockets}@anchor{5420}
@subsection Soquetes


Só trataremos dos soquetes INET (ou seja, IPv4), no entanto, os mesmos representam ao menos 99% dos soquetes que estão atualmente em uso. Só estudaremos os soquetes STREAM (ou seja, TCP) - a menos que você realmente saiba o que está fazendo (nesse caso, este documento não é para você!), terás um melhor conhecimento sobre o comportamento e o desempenho dos soquetes STREAM do que qualquer outra coisa. Tentarei aclarar o mistério sobre o que realmente é um soquete, bem como, apresentarei dicas de como trabalhar com soquetes bloqueantes e os não bloqueantes. Começaremos o estudo falando da razão pela qual bloquear um soquete. Precisas saber como os mesmos (os soquetes bloqueantes) antes de estudar os não bloqueantes

Parte do problema em compreender o funcionamento se dá pelo fato de que o “soquete” pode ter significados que são sutilmente diferentes, dependendo do contexto. Então, primeiro, vamos fazer uma distinção entre um soquete “cliente” - o ponto final de uma conversa e um soquete “servidor”, que mais parece como um operador de painel. O aplicativo Cliente (seu navegador, por exemplo) usa soquetes “cliente” exclusivos; O servidor Web com o qual conversamos faz uso de soquetes “servidor” e soquetes de “cliente”.

@menu
* História:: 

@end menu

@node História,,,Soquetes
@anchor{howto/sockets history}@anchor{5421}
@subsubsection História


Das várias formas de @abbr{IPC,Inter Process Communication}, os soquetes são, de longe, os mais populares. Em qualquer plataforma, muito provável existirão outras formas de IPC que sejam mais rápidas, porém, para a comunicação entre plataformas, os soquetes são sobre o único jogo na cidade.

They were invented in Berkeley as part of the BSD flavor of Unix. They spread
like wildfire with the internet. With good reason — the combination of sockets
with INET makes talking to arbitrary machines around the world unbelievably easy
(at least compared to other schemes).

@node Criando um Soquete,Usando um Soquete,Soquetes,Programação de Soquetes
@anchor{howto/sockets creating-a-socket}@anchor{5422}
@subsection Criando um Soquete


De forma geral, quando clicastes no link que te trouxe até esta página (documentação do Python), o que o teu navegador fez, foi o seguinte:

@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

Quando a @code{connect} (conexão) foi estabelecida, o soquete @code{s} pode ser utilizado para enviar uma solicitação de texto para a página. O mesmo soquete é que irá ler a resposta e, em seguida, o mesmo será destruído. Isso mesmo, será destruído. Os soquetes de Clientes normalmente são usados apenas numa única transação (troca) (ou um pequeno conjunto sequencial de transações).

O que acontece no lado do servidor Web é um pouco mais complexo. Primeiro, o Servidor Web cria um “soquete tipo 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

Algumas coisas que deves observar: usamos @code{socket.gethostname()} para que o soquete esteja visível ao mundo exterior. Se tivéssemos usado @code{s.bind(('localhost', 80))} ou @code{s.bind(('127.0.0.1', 80))} ainda teríamos um soquete do tipo “servidor”, mas o mesmo só estaria visível dentro do computador em que está sendo executado. @code{s.bind(('@w{'}, 80))} determina que o soquete estará acessível por qualquer computador que possuas o endereço IP do computador.

Uma segunda coisa que precisas observar é: as portas baixas, normalmente estão reservadas para serviços “bem conhecidos”, tais como (HTTP, SNMP etc). Caso estejas brincando, utilize um número alto (números contendo 4 dígitos).

Por fim, o argumento “listen” diz à biblioteca de soquetes que queremos enfileirar no máximo 5 requisições de conexão (normalmente o máximo) antes de recusar começar a recusar conexões externas. Caso o resto do código esteja escrito corretamente, isso deverá ser o suficiente.

Agora que temos um soquete tipo “servidor”, que está ouvindo a porta 80, podemos entrar no laço de repetição principal do 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 = client_thread(clientsocket)
    ct.run()
@end example

Na verdade, existem 3 formas gerais nas quais este loop pode ser implementado - despachando um handle que lide com o @code{clientsocket}, criando um novo processo que funcione com o @code{clientsocket}, ou reestruture o aplicativo para trabalhar com soquetes não bloqueáveis e multiplexar entre os nossos soquetes tipo “servidor” e qualquer @code{cliente} ativo que faça uso do @code{select}. Trataremos mais sobre isso posteriormente. O importante que temos que saber neste momento é isso: isso é `tudo' o que um soquete tipo “Servidor” irá fazer. O mesmo não enviar quaisquer dado. Não recebe dados. Apenas produz soquetes “cliente”. Cada @code{clientsocket} será criado em resposta a algum `outro' soquete “cliente” que fará uma @code{connect()} ao um determinado host numa determinada porta que estamos vinculados. Será dessa forma que criamos aquele “cliente”, voltaremos a ouvir mais conexões. Os dois “clientes” são livres para conversar - eles estão usando uma porta alocada dinamicamente que será descartada quando a conversa terminar.

@menu
* IPC:: 

@end menu

@node IPC,,,Criando um Soquete
@anchor{howto/sockets ipc}@anchor{5423}
@subsubsection IPC


Se precisas que o IPC seja rápido entre dois processos numa máquina, deverás procurar por pipes ou compartilhamento de memória. Se decidires usar os soquetes AF_INET, vincule o soquete “servidor” a @code{'localhost'`}. Na maioria das plataformas, isso levará um atalho em torno de algumas camadas de código de rede e funcionará um pouco mais rápido.


@subsubheading Ver também


A módulo @ref{94,,multiprocessing} faz a integração do IPC de forma multiplataforma numa API de nível mais alto.


@node Usando um Soquete,Desconectando,Criando um Soquete,Programação de Soquetes
@anchor{howto/sockets using-a-socket}@anchor{5424}
@subsection Usando um Soquete


A primeira coisa que precisamos observar, é que o soquete “cliente” do navegador e o soquete “cliente” do servidor Web são “animais” idênticos. Ou seja, esta é uma conversa “peer to peer”. Ou, em outras palavras, `como designer, terás que decidir quais são as regras da etiqueta para uma conversa'. Normalmente, o soquete @code{connect}ando inicia a conversa, enviando uma solicitação ou talvez um sinal. Mas essa é uma decisão de design - não é uma regra de soquetes.

Agora, há dois conjuntos de verbos que podemos usar na comunicação. Podemos usar @code{send} e @code{recv}, ou podemos transformar o seu soquete cliente numa “besta” semelhante a um arquivo e usar @code{read} e @code{write}. O último é o modo como Java apresenta seus soquetes. Não tratarei disso aqui, exceto para avisar que precisas usar o @code{flush} com soquetes. Estes são “arquivos” em buffer e um erro comum é “escrever” algo e, em seguida, “ler” uma resposta. Sem que haja um @code{flush} lá dentro, poderás esperar eternamente pela resposta, porque o pedido ainda poderá estar no buffer de saída.

Agora, chegamos ao principal obstáculo no uso dos soquetes - @code{send} e @code{recv} operam nos buffers de rede. Eles não lidam necessariamente com todos os bytes que você os entrega (ou esperam deles), porque o foco principal deles é lidar com os buffers de rede. Em geral, os mesmos retornam quando os buffers de rede associados foram preenchidos (@code{send}) ou esvaziados (@code{recv}). Eles então lhe dizem quantos bytes eles trataram. É `sua' responsabilidade chamá-los novamente até que a sua mensagem tenha sido completamente tratada.

Quando um @code{recv} retornar 0 bytes, significa que o outro lado finalizou a conexão (ou está no processo de fechamento) da conexão. Não receberás mais dados nesta conexão. Pra sempre. Poderás enviar dados com sucesso; Falaremos mais sobre isso posteriormente.

Um protocolo como o HTTP utiliza um soquete para apenas uma transferência. O cliente envia uma solicitação e depois lê uma resposta. É isso aí. O soquete é descartado. Isso significa que um cliente pode detectar o final da resposta ao receber 0 bytes.

But if you plan to reuse your socket for further transfers, you need to realize
that `there is no' @abbr{EOT,End of Transfer} `on a socket.' I repeat: if a socket
@code{send} or @code{recv} returns after handling 0 bytes, the connection has been
broken.  If the connection has `not' been broken, you may wait on a @code{recv}
forever, because the socket will `not' tell you that there’s nothing more to
read (for now).  Now if you think about that a bit, you’ll come to realize a
fundamental truth of sockets: `messages must either be fixed length' (yuck), `or
be delimited' (shrug), `or indicate how long they are' (much better), `or end by
shutting down the connection'. The choice is entirely yours, (but some ways are
righter than others).

Assuming you don’t want to end the connection, the simplest solution is a fixed
length message:

@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

The sending code here is usable for almost any messaging scheme - in Python you
send strings, and you can use @code{len()} to determine its length (even if it has
embedded @code{\0} characters). It’s mostly the receiving code that gets more
complex. (And in C, it’s not much worse, except you can’t use @code{strlen} if the
message has embedded @code{\0}s.)

The easiest enhancement is to make the first character of the message an
indicator of message type, and have the type determine the length. Now you have
two @code{recv}s - the first to get (at least) that first character so you can
look up the length, and the second in a loop to get the rest. If you decide to
go the delimited route, you’ll be receiving in some arbitrary chunk size, (4096
or 8192 is frequently a good match for network buffer sizes), and scanning what
you’ve received for a delimiter.

Uma complicação a ter em conta: se o seu protocolo de conversa permitir que várias mensagens sejam enviadas de volta para trás (sem algum tipo de resposta) e você passar @code{recv} um tamanho arbitrário de bloco, você pode acabar lendo o início de uma mensagem seguinte. Você precisará deixar isso de lado e segurá-lo até que seja necessário.

Prefixing the message with its length (say, as 5 numeric characters) gets more
complex, because (believe it or not), you may not get all 5 characters in one
@code{recv}. In playing around, you’ll get away with it; but in high network loads,
your code will very quickly break unless you use two @code{recv} loops - the first
to determine the length, the second to get the data part of the message. Nasty.
This is also when you’ll discover that @code{send} does not always manage to get
rid of everything in one pass. And despite having read this, you will eventually
get bit by it!

In the interests of space, building your character, (and preserving my
competitive position), these enhancements are left as an exercise for the
reader. Lets move on to cleaning up.

@menu
* Dados Binários:: 

@end menu

@node Dados Binários,,,Usando um Soquete
@anchor{howto/sockets binary-data}@anchor{5425}
@subsubsection Dados Binários


It is perfectly possible to send binary data over a socket. The major problem is
that not all machines use the same formats for binary data. For example,
network byte order@footnote{https://en.wikipedia.org/wiki/Endianness#Networking}
is big-endian, with the most significant byte first,
so a 16 bit integer with the value @code{1} would be the two hex bytes @code{00 01}.
However, most common processors (x86/AMD64, ARM, RISC-V), are little-endian,
with the least significant byte first - that same @code{1} would be @code{01 00}.

Socket libraries have calls for converting 16 and 32 bit integers - @code{ntohl,
htonl, ntohs, htons} where “n” means `network' and “h” means `host', “s” means
`short' and “l” means `long'. Where network order is host order, these do
nothing, but where the machine is byte-reversed, these swap the bytes around
appropriately.

In these days of 64-bit machines, the ASCII representation of binary data is
frequently smaller than the binary representation. That’s because a surprising
amount of the time, most integers have the value 0, or maybe 1.
The string @code{"0"} would be two bytes, while a full 64-bit integer would be 8.
Of course, this doesn’t fit well with fixed-length messages.
Decisions, decisions.

@node Desconectando,Soquetes não-bloqueantes,Usando um Soquete,Programação de Soquetes
@anchor{howto/sockets disconnecting}@anchor{5426}
@subsection Desconectando


Strictly speaking, you’re supposed to use @code{shutdown} on a socket before you
@code{close} it.  The @code{shutdown} is an advisory to the socket at the other end.
Depending on the argument you pass it, it can mean “I’m not going to send
anymore, but I’ll still listen”, or “I’m not listening, good riddance!”.  Most
socket libraries, however, are so used to programmers neglecting to use this
piece of etiquette that normally a @code{close} is the same as @code{shutdown();
close()}.  So in most situations, an explicit @code{shutdown} is not needed.

One way to use @code{shutdown} effectively is in an HTTP-like exchange. The client
sends a request and then does a @code{shutdown(1)}. This tells the server “This
client is done sending, but can still receive.”  The server can detect “EOF” by
a receive of 0 bytes. It can assume it has the complete request.  The server
sends a reply. If the @code{send} completes successfully then, indeed, the client
was still receiving.

Python takes the automatic shutdown a step further, and says that when a socket
is garbage collected, it will automatically do a @code{close} if it’s needed. But
relying on this is a very bad habit. If your socket just disappears without
doing a @code{close}, the socket at the other end may hang indefinitely, thinking
you’re just being slow. `Please' @code{close} your sockets when you’re done.

@menu
* Quando o Soquete Morre:: 

@end menu

@node Quando o Soquete Morre,,,Desconectando
@anchor{howto/sockets when-sockets-die}@anchor{5427}
@subsubsection Quando o Soquete Morre


Probably the worst thing about using blocking sockets is what happens when the
other side comes down hard (without doing a @code{close}). Your socket is likely to
hang. TCP is a reliable protocol, and it will wait a long, long time
before giving up on a connection. If you’re using threads, the entire thread is
essentially dead. There’s not much you can do about it. As long as you aren’t
doing something dumb, like holding a lock while doing a blocking read, the
thread isn’t really consuming much in the way of resources. Do `not' try to kill
the thread - part of the reason that threads are more efficient than processes
is that they avoid the overhead associated with the automatic recycling of
resources. In other words, if you do manage to kill the thread, your whole
process is likely to be screwed up.

@node Soquetes não-bloqueantes,,Desconectando,Programação de Soquetes
@anchor{howto/sockets non-blocking-sockets}@anchor{5428}
@subsection Soquetes não-bloqueantes


If you’ve understood the preceding, you already know most of what you need to
know about the mechanics of using sockets. You’ll still use the same calls, in
much the same ways. It’s just that, if you do it right, your app will be almost
inside-out.

In Python, you use @code{socket.setblocking(False)} to make it non-blocking. In C, it’s
more complex, (for one thing, you’ll need to choose between the BSD flavor
@code{O_NONBLOCK} and the almost indistinguishable POSIX flavor @code{O_NDELAY}, which
is completely different from @code{TCP_NODELAY}), but it’s the exact same idea. You
do this after creating the socket, but before using it. (Actually, if you’re
nuts, you can switch back and forth.)

A principal diferença mecânica é que @code{send}, @code{recv}, @code{connect} e @code{accept} podem retornar sem terem feito nada. Terás (claro) uma série de escolhas. Poderás verificar o código de retorno e os códigos de erro que geralmente nos deixam loucos. Se não acreditas em mim, tente alguma vez. Seu aplicativo vai crescendo, buggy e sugam CPU. Então, vamos ignorar as soluções mortas no cérebro e fazê-lo direito.

Utilize @code{select}.

In C, coding @code{select} is fairly complex. In Python, it’s a piece of cake, but
it’s close enough to the C version that if you understand @code{select} in Python,
you’ll have little trouble with it in C:

@example
ready_to_read, ready_to_write, in_error = \
               select.select(
                  potential_readers,
                  potential_writers,
                  potential_errs,
                  timeout)
@end example

You pass @code{select} three lists: the first contains all sockets that you might
want to try reading; the second all the sockets you might want to try writing
to, and the last (normally left empty) those that you want to check for errors.
You should note that a socket can go into more than one list. The @code{select}
call is blocking, but you can give it a timeout. This is generally a sensible
thing to do - give it a nice long timeout (say a minute) unless you have good
reason to do otherwise.

In return, you will get three lists. They contain the sockets that are actually
readable, writable and in error. Each of these lists is a subset (possibly
empty) of the corresponding list you passed in.

If a socket is in the output readable list, you can be
as-close-to-certain-as-we-ever-get-in-this-business that a @code{recv} on that
socket will return `something'. Same idea for the writable list. You’ll be able
to send `something'. Maybe not all you want to, but `something' is better than
nothing.  (Actually, any reasonably healthy socket will return as writable - it
just means outbound network buffer space is available.)

If you have a “server” socket, put it in the potential_readers list. If it comes
out in the readable list, your @code{accept} will (almost certainly) work. If you
have created a new socket to @code{connect} to someone else, put it in the
potential_writers list. If it shows up in the writable list, you have a decent
chance that it has connected.

Actually, @code{select} can be handy even with blocking sockets. It’s one way of
determining whether you will block - the socket returns as readable when there’s
something in the buffers.  However, this still doesn’t help with the problem of
determining whether the other end is done, or just busy with something else.

`Portability alert': On Unix, @code{select} works both with the sockets and
files. Don’t try this on Windows. On Windows, @code{select} works with sockets
only. Also note that in C, many of the more advanced socket options are done
differently on Windows. In fact, on Windows I usually use threads (which work
very, very well) with my sockets.

@node Técnicas de ordenação,Unicode<3>,Programação de Soquetes,Python HOWTOs
@anchor{howto/sorting doc}@anchor{5429}@anchor{howto/sorting sorting-techniques}@anchor{542a}@anchor{howto/sorting sortinghowto}@anchor{2314}@anchor{howto/sorting translation-repo}@anchor{542b}
@section Técnicas de ordenação


@*Autor: 
Andrew Dalke e Raymond Hettinger


As listas em Python possuem um método embutido @ref{be8,,list.sort()} que modifica a lista em si. Há também a função embutida @ref{be7,,sorted()} que constrói uma nova lista ordenada à partir de um iterável.

Neste documento, exploramos várias técnicas para ordenar dados utilizando Python.

@menu
* Básico de ordenação:: 
* Funções chave:: 
* Operator Module Functions and Partial Function Evaluation:: 
* Ascendente e descendente:: 
* Estabilidade de Ordenação e Ordenações Complexas:: 
* Decorate-Sort-Undecorate:: 
* Funções de comparação:: 
* Curiosidades e conclusões: Curiosidades e conclusões<2>. 
* Ordenações parciais:: 

@end menu

@node Básico de ordenação,Funções chave,,Técnicas de ordenação
@anchor{howto/sorting sorting-basics}@anchor{542c}
@subsection Básico de ordenação


Uma ordenação ascendente simples é muito fácil: apenas chame a função @ref{be7,,sorted()}. Você terá como retorno uma nova lista ordenada:

@example
>>> sorted([5, 2, 3, 1, 4])
[1, 2, 3, 4, 5]
@end example

Você também pode utilizar o método @ref{be8,,list.sort()}. Ele modificará a lista localmente (e retornará @code{None} para evitar confusão). Usualmente este método é menos conveniente que a função @ref{be7,,sorted()} - mas, se a lista original não for posteriormente útil, esta maneira será levemente mais eficiente.

@example
>>> a = [5, 2, 3, 1, 4]
>>> a.sort()
>>> a
[1, 2, 3, 4, 5]
@end example

Outra diferença é que o método @ref{be8,,list.sort()} é aplicável apenas às listas. Em contrapartida, a função @ref{be7,,sorted()} aceita qualquer iterável.

@example
>>> sorted(@{1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'@})
[1, 2, 3, 4, 5]
@end example

@node Funções chave,Operator Module Functions and Partial Function Evaluation,Básico de ordenação,Técnicas de ordenação
@anchor{howto/sorting key-functions}@anchor{542d}
@subsection Funções chave


Tanto o método @ref{be8,,list.sort()} quanto a função @ref{be7,,sorted()} possuem um parâmetro `key' que especifica uma função (ou outro chamável) a ser chamada para cada elemento da lista antes de ser realizada a comparação.

Por exemplo, aqui há uma comparação case-insensitive de strings.

@example
>>> sorted("Essa é uma string de teste do Andrew".split(), key=str.casefold)
['Andrew', 'de', 'do', 'Essa', 'string', 'teste', 'uma', 'é']
@end example

O valor do parâmetro `key' deve ser uma função (ou outro chamável) que recebe um único argumento e retorna uma chave à ser utilizada na ordenação. Como a função chave é chamada exatamente uma vez para cada elemento, esta técnica é rápida.

Um padrão comum é ordenar objetos complexos utilizando um dos índices do objeto como chave. Por exemplo:

@example
>>> tuplas_alunos = [
...     ('joão', 'A', 15),
...     ('joana', 'B', 12),
...     ('davi', 'B', 10),
... ]
>>> sorted(tuplas_alunos, key=lambda aluno: aluno[2])   # ordena por idade
[('davi', 'B', 10), ('joana', 'B', 12), ('joão', 'A', 15)]
@end example

A mesma técnica funciona com objetos que possuem atributos nomeados. Por exemplo:

@example
>>> class Aluno:
...     def __init__(self, nome, nota, idade):
...         self.nome = nome
...         self.nota = nota
...         self.idade = idade
...     def __repr__(self):
...         return repr((self.nome, self.nota, self.idade))

>>> objetos_alunos = [
...     Aluno('john', 'A', 15),
...     Aluno('jane', 'B', 12),
...     Aluno('dave', 'B', 10),
... ]
>>> sorted(objetos_alunos, key=lambda aluno: aluno.idade)   # ordena por idade
[('davi', 'B', 10), ('joana', 'B', 12), ('joão', 'A', 15)]
@end example

Objetos com atríbutos nomeados podem ser criados como uma classe padrão, igual ao exemplo acima, podem ser instâncias de @ref{1cb,,dataclass} ou mesmo uma @ref{64e,,named tuple}.

@node Operator Module Functions and Partial Function Evaluation,Ascendente e descendente,Funções chave,Técnicas de ordenação
@anchor{howto/sorting operator-module-functions-and-partial-function-evaluation}@anchor{542e}
@subsection Operator Module Functions and Partial Function Evaluation


O padrão de @ref{e31,,função chave} mostrado acima é muito comum, por isso, Python provê funções convenientes para tornar as funções de acesso mais fáceis e rápidas. O módulo @ref{9f,,operator} tem as funções @ref{a6b,,itemgetter()}, @ref{e60,,attrgetter()} e @ref{e61,,methodcaller()}

Usando estas funções, os exemplos acima se tornam mais simples e mais 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

As funções do módulo operator permite múltiplos níveis de ordenação. Por exemplo, ordenar por `grade' e então 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{414,,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 e descendente,Estabilidade de Ordenação e Ordenações Complexas,Operator Module Functions and Partial Function Evaluation,Técnicas de ordenação
@anchor{howto/sorting ascending-and-descending}@anchor{542f}
@subsection Ascendente e descendente


Tanto o método @ref{be8,,list.sort()} quanto a função @ref{be7,,sorted()} aceitam um valor booleano para o parâmetro `reverse'. Essa flag é utilizada para ordenações descendentes. Por exemplo, para retornar os dados de estudantes pela ordem inversa de `age':

@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 Estabilidade de Ordenação e Ordenações Complexas,Decorate-Sort-Undecorate,Ascendente e descendente,Técnicas de ordenação
@anchor{howto/sorting sort-stability-and-complex-sorts}@anchor{5430}
@subsection Estabilidade de Ordenação e Ordenações Complexas


Ordenações são garantidas de serem estáveis@footnote{https://en.wikipedia.org/wiki/Sorting_algorithm#Stability}. Isso significa que quando múltiplos registros possuem a mesma chave, eles terão sua ordem original preservada.

@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 como os dois registros de `blue' permanecem em sua ordem original de forma que @code{('blue',1)} é garantido de preceder @code{('blue',2)}.

Esta maravilhosa propriedade permite que você construa ordenações complexas em uma série de passos de ordenação. Por exemplo, para ordenar os registros de estudante por ordem descendente de `grade' e então ascendente de `age', primeiro ordene `age' e depois ordene novamente utilizando `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

Isso pode ser abstrato no caso das funções invólucros que podem receber uma lista e uma tupla com o campos e então ordená-los em múltiplos passos.

@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

O algoritmo Timsort@footnote{https://en.wikipedia.org/wiki/Timsort} utilizado no Python realiza múltiplas ordenações de maneira eficiente, pois se aproveita de qualquer ordenação já presente no conjunto de dados.

@node Decorate-Sort-Undecorate,Funções de comparação,Estabilidade de Ordenação e Ordenações Complexas,Técnicas de ordenação
@anchor{howto/sorting decorate-sort-undecorate}@anchor{5431}
@subsection Decorate-Sort-Undecorate


Esse item idiomático, chamado de Decorate-Sort-Undecorate, é realizado em três passos:


@itemize *

@item 
Primeiro, a lista inicial é decorada com novos valores que controlarão a ordem em que ocorrerá a ordenação

@item 
Segundo, a lista decorada é ordenada.

@item 
Finalmente, os valores decorados são removidos, criando uma lista que contém apenas os valores iniciais na nova ordenação.
@end itemize

Por exemplo, para ordenar os dados dos estudantes por `grade' usando a abordagem 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

Esse padrão idiomático funciona porque tuplas são comparadas lexicograficamente; os primeiros itens são comparados; se eles são semelhantes, então os segundos itens são comparados e assim sucessivamente.

Não é estritamente necessário incluir o índice `i' em todos os casos de listas decoradas, mas fazer assim traz dois benefícios:


@itemize *

@item 
A ordenação é estável - se dois itens tem a mesma chave, suas ordens serão preservadas na lista ordenada

@item 
Os itens originais não precisarão ser comparados porque a ordenação de tuplas decoradas será determinada por no máximo os primeiros dois itens. Então, por exemplo, a lista original poderia conter números complexos que não poderão ser ordenados diretamente.
@end itemize

Outro nome para este padrão idiomático é Schwartzian transform@footnote{https://en.wikipedia.org/wiki/Schwartzian_transform} de Randal L. Schwartz, que popularizou isto entre os programadores Perl.

Agora que a ordenação do Python prevê funções-chave, essa técnica não se faz mais necessária.

@node Funções de comparação,Curiosidades e conclusões<2>,Decorate-Sort-Undecorate,Técnicas de ordenação
@anchor{howto/sorting comparison-functions}@anchor{5432}
@subsection Funções de comparação


Unlike key functions that return an absolute value for sorting, a comparison
function computes the relative ordering for two inputs.

For example, a balance scale@footnote{https://upload.wikimedia.org/wikipedia/commons/1/17/Balance_à_tabac_1850.JPG}
compares two samples giving a relative ordering: lighter, equal, or heavier.
Likewise, a comparison function such as @code{cmp(a, b)} will return a negative
value for less-than, zero if the inputs are equal, or a positive value for
greater-than.

It is common to encounter comparison functions when translating algorithms from
other languages.  Also, some libraries provide comparison functions as part of
their API.  For example, @ref{3f82,,locale.strcoll()} is a comparison function.

To accommodate those situations, Python provides
@ref{121a,,functools.cmp_to_key} to wrap the comparison function
to make it usable as a key function:

@example
sorted(words, key=cmp_to_key(strcoll))  # locale-aware sort order
@end example

@node Curiosidades e conclusões<2>,Ordenações parciais,Funções de comparação,Técnicas de ordenação
@anchor{howto/sorting odds-and-ends}@anchor{5433}
@subsection Curiosidades e conclusões



@itemize *

@item 
For locale aware sorting, use @ref{15f3,,locale.strxfrm()} for a key function or
@ref{3f82,,locale.strcoll()} for a comparison function.  This is necessary
because “alphabetical” sort orderings can vary across cultures even
if the underlying alphabet is the same.

@item 
O parâmetro `reverse' ainda mantém a estabilidade da ordenação (para que os registros com chaves iguais mantenham a ordem original). Curiosamente, esse efeito pode ser simulado sem o parâmetro usando a função embutida @ref{869,,reversed()} duas vezes:

@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 
As rotinas de classificação usam @code{<} ao fazer comparações entre dois objetos. Portanto, é fácil adicionar uma ordem de classificação padrão a uma classe definindo um método @ref{12e2,,__lt__()}:

@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{1350,,__gt__()} if
@ref{12e2,,__lt__()} is not implemented (see @ref{12e2,,object.__lt__()}
for details on the mechanics).  To avoid surprises, 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}
recommends that all six comparison methods be implemented.
The @ref{f75,,total_ordering()} decorator is provided to make that
task easier.

@item 
As funções principais não precisam depender diretamente dos objetos que estão sendo ordenados. Uma função chave também pode acessar recursos externos. Por exemplo, se as notas dos alunos estiverem armazenadas em um dicionário, elas poderão ser usadas para ordenar uma lista separada de nomes de alunos:

@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 Ordenações parciais,,Curiosidades e conclusões<2>,Técnicas de ordenação
@anchor{howto/sorting partial-sorts}@anchor{5434}
@subsection Ordenações parciais


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{f3a,,min()} and @ref{f3b,,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{26d7,,heapq.nsmallest()} and @ref{26d6,,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{1504,,heapq.heappush()} and @ref{1505,,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 Unicode<3>,Como buscar recursos da Internet usando o pacote urllib,Técnicas de ordenação,Python HOWTOs
@anchor{howto/unicode doc}@anchor{5435}@anchor{howto/unicode id1}@anchor{5436}@anchor{howto/unicode translation-repo}@anchor{5437}@anchor{howto/unicode unicode-howto}@anchor{12e7}
@section Unicode


@*Versão: 
1.12


Este documento fala sobre o suporte do Python para a especificação Unicode de representação de dados textuais e explica diversos problemas que as pessoas costumam encontrar quando tentam trabalhar com Unicode.

@menu
* Introdução ao Unicode:: 
* Suporte a Unicode no Python:: 
* Reading and Writing Unicode Data:: 
* Reconhecimentos: Reconhecimentos<10>. 

@end menu

@node Introdução ao Unicode,Suporte a Unicode no Python,,Unicode<3>
@anchor{howto/unicode introduction-to-unicode}@anchor{5438}
@subsection Introdução ao Unicode


@menu
* Definições:: 
* Codificações:: 
* Referências: Referências<3>. 

@end menu

@node Definições,Codificações,,Introdução ao Unicode
@anchor{howto/unicode definitions}@anchor{5439}
@subsubsection Definições


Os programas de hoje precisam lidar com uma grande variedade de caracteres. Aplicações são frequentemente internacionalizadas para mostrar mensagens e gerar saídas em uma variedade de idiomas selecionáveis por usuários; o mesmo programa precisar apresentar mensagens de erro em inglês, francês, japonês, hebraico ou russo. Conteúdo da web pode ser escrito em qualquer um desses idiomas e ainda incluir uma variedade de emojis. O tipo string do Python usa o padrão Unicode para representação de caracteres, o que permite aos programas em Python funcionar com todos estes diferentes caracteres.

Unicode (@indicateurl{https://www.unicode.org/}) é a especificação que visa listar cada caractere utilizado pelos idiomas humanos e dar a cada caractere um código único. As especificações Unicode são continuamente revisadas e atualizadas para adicionar novos idiomas e símbolos.

A `character' is the smallest possible component of a text.  ‘A’, ‘B’, ‘C’,
etc., are all different characters.  So are ‘È’ and ‘Í’.  Characters vary
depending on the language or context you’re talking
about.  For example, there’s a character for “Roman Numeral One”, ‘Ⅰ’, that’s
separate from the uppercase letter ‘I’.  They’ll usually look the same,
but these are two different characters that have different meanings.

The Unicode standard describes how characters are represented by
`code points'.  A code point value is an integer in the range 0 to
0x10FFFF (about 1.1 million values, the
actual number assigned@footnote{https://www.unicode.org/versions/latest/#Summary}
is less than that). In the standard and in this document, a code point is written
using the notation @code{U+265E} to mean the character with value
@code{0x265e} (9,822 in decimal).

O padrão Unicode contém várias tabelas listando caracteres e seus pontos de código:

@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

Strictly, these definitions imply that it’s meaningless to say ‘this is
character @code{U+265E}’.  @code{U+265E} is a code point, which represents some particular
character; in this case, it represents the character ‘BLACK CHESS KNIGHT’,
‘♞’.  In
informal contexts, this distinction between code points and characters will
sometimes be forgotten.

Um caractere é representado na tela ou no papel como um conjunto de elementos gráficos que é chamado de `glifo'. O glifo para o A maiúsculo, por exemplo, são dois traços diagonais e um traço horizontal, embora os detalhes exatos dependem da fonte utilizada. Na maior parte do código Python não é preciso se preocupar com glifos; descobrir qual o glifo correto a ser mostrado é normalmente parte do trabalho da ferramenta GUI ou do responsável pela renderização de fontes no terminal.

@node Codificações,Referências<3>,Definições,Introdução ao Unicode
@anchor{howto/unicode encodings}@anchor{543a}
@subsubsection Codificações


To summarize the previous section: a Unicode string is a sequence of
code points, which are numbers from 0 through @code{0x10FFFF} (1,114,111
decimal).  This sequence of code points needs to be represented in
memory as a set of `code units', and `code units' are then mapped
to 8-bit bytes.  The rules for translating a Unicode string into a
sequence of bytes are called a `character encoding', or just
an `encoding'.

The first encoding you might think of is using 32-bit integers as the
code unit, and then using the CPU’s representation of 32-bit integers.
In this representation, the string “Python” might look like this:

@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 representação é direta, mas usá-la gera uma série de problemas.


@enumerate 

@item 
Ela não é portátil; diferentes processadores ordenam os bytes de forma diferente.

@item 
Ela gera desperdício de espaço. Na maior parte dos textos, a maioria dos pontos de código são menores que 127 ou menores que 255, então muito do espaço é ocupado por bytes @code{0x00} . A string acima necessita 24 bytes comparado com os 6 bytes necessários em uma representação ASCII. O aumento de uso da memória RAM normalmente não importa tanto (computadores desktop possuem gigabytes de RAM e strings normalmente não são tão grandes), mas expandir o uso de disco ou de banda por um fator de 4 é inaceitável.

@item 
Ela não é compatível com as funções de C existentes, como @code{strlen()}, então uma série de novas funções de string serão necessárias.
@end enumerate

Therefore this encoding isn’t used very much, and people instead choose other
encodings that are more efficient and convenient, such as UTF-8.

UTF-8 is one of the most commonly used encodings, and Python often
defaults to using it.  UTF stands for “Unicode Transformation Format”,
and the ‘8’ means that 8-bit values are used in the encoding.  (There
are also UTF-16 and UTF-32 encodings, but they are less frequently
used than UTF-8.)  UTF-8 uses the following rules:


@enumerate 

@item 
If the code point is < 128, it’s represented by the corresponding byte value.

@item 
If the code point is >= 128, it’s turned into a sequence of two, three, or
four bytes, where each byte of the sequence is between 128 and 255.
@end enumerate

UTF-8 tem muitas propriedades convenientes:


@enumerate 

@item 
Ela pode lidar com qualquer ponto de código Unicode.

@item 
A Unicode string is turned into a sequence of bytes that contains embedded
zero bytes only where they represent the null character (U+0000). This means
that UTF-8 strings can be processed by C functions such as @code{strcpy()} and sent
through protocols that can’t handle zero bytes for anything other than
end-of-string markers.

@item 
Uma string de texto ASCII é também um texto UTF-8 válido.

@item 
UTF-8 is fairly compact; the majority of commonly used characters can be
represented with one or two bytes.

@item 
If bytes are corrupted or lost, it’s possible to determine the start of the
next UTF-8-encoded code point and resynchronize.  It’s also unlikely that
random 8-bit data will look like valid UTF-8.

@item 
UTF-8 is a byte oriented encoding. The encoding specifies that each
character is represented by a specific sequence of one or more bytes. This
avoids the byte-ordering issues that can occur with integer and word oriented
encodings, like UTF-16 and UTF-32, where the sequence of bytes varies depending
on the hardware on which the string was encoded.
@end enumerate

@node Referências<3>,,Codificações,Introdução ao Unicode
@anchor{howto/unicode references}@anchor{543b}
@subsubsection Referências


The Unicode Consortium site@footnote{https://www.unicode.org} has character charts, a
glossary, and PDF versions of the Unicode specification.  Be prepared for some
difficult reading.  A chronology@footnote{https://www.unicode.org/history/} of the
origin and development of Unicode is also available on the site.

On the Computerphile Youtube channel, Tom Scott briefly
discusses the history of Unicode and UTF-8@footnote{https://www.youtube.com/watch?v=MijmeoH9LT4}
(9 minutes 36 seconds).

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.

Another good introductory article@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/}
was written by Joel Spolsky.
If this introduction didn’t make things clear to you, you should try
reading this alternate article before continuing.

Wikipedia entries are often helpful; see the entries for “character encoding@footnote{https://en.wikipedia.org/wiki/Character_encoding}” and UTF-8@footnote{https://en.wikipedia.org/wiki/UTF-8}, for example.

@node Suporte a Unicode no Python,Reading and Writing Unicode Data,Introdução ao Unicode,Unicode<3>
@anchor{howto/unicode python-s-unicode-support}@anchor{543c}
@subsection Suporte a Unicode no Python


Now that you’ve learned the rudiments of Unicode, we can look at Python’s
Unicode features.

@menu
* O Tipo String:: 
* Convertendo para Bytes:: 
* Unicode Literals in Python Source Code:: 
* Propriedades Unicode:: 
* Comparando Strings:: 
* Expressões Regulares Unicode:: 
* Referências: Referências<4>. 

@end menu

@node O Tipo String,Convertendo para Bytes,,Suporte a Unicode no Python
@anchor{howto/unicode the-string-type}@anchor{543d}
@subsubsection O Tipo String


Since Python 3.0, the language’s @ref{44c,,str} type contains Unicode
characters, meaning any string created using @code{"unicode rocks!"}, @code{'unicode
rocks!'}, or the triple-quoted string syntax is stored as Unicode.

The default encoding for Python source code is UTF-8, so you can simply
include a Unicode character in a string literal:

@example
try:
    with open('/tmp/input.txt', 'r') as f:
        ...
except OSError:
    # 'File not found' error message.
    print("Fichier non trouvé")
@end example

Side note: Python 3 also supports using Unicode characters in identifiers:

@example
répertoire = "/tmp/records.log"
with open(répertoire, "w") as f:
    f.write("test\n")
@end example

If you can’t enter a particular character in your editor or want to
keep the source code ASCII-only for some reason, you can also use
escape sequences in string literals. (Depending on your system,
you may see the actual capital-delta glyph instead of a u escape.)

@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

In addition, one can create a string using the @ref{8dc,,decode()} method of
@ref{1c2,,bytes}.  This method takes an `encoding' argument, such as @code{UTF-8},
and optionally an `errors' argument.

The `errors' argument specifies the response when the input string can’t be
converted according to the encoding’s rules.  Legal values for this argument are
@code{'strict'} (raise a @ref{a1d,,UnicodeDecodeError} exception), @code{'replace'} (use
@code{U+FFFD}, @code{REPLACEMENT CHARACTER}), @code{'ignore'} (just leave the
character out of the Unicode result), or @code{'backslashreplace'} (inserts a
@code{\xNN} escape sequence).
The following examples show the differences:

@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

Encodings are specified as strings containing the encoding’s name.  Python
comes with roughly 100 different encodings; see the Python Library Reference at
@ref{de1,,Standard Encodings} for a list.  Some encodings have multiple names; for
example, @code{'latin-1'}, @code{'iso_8859_1'} and @code{'8859}’ are all synonyms for
the same encoding.

One-character Unicode strings can also be created with the @ref{1768,,chr()}
built-in function, which takes integers and returns a Unicode string of length 1
that contains the corresponding code point.  The reverse operation is the
built-in @ref{2080,,ord()} function that takes a one-character Unicode string and
returns the code point value:

@example
>>> chr(57344)
'\ue000'
>>> ord('\ue000')
57344
@end example

@node Convertendo para Bytes,Unicode Literals in Python Source Code,O Tipo String,Suporte a Unicode no Python
@anchor{howto/unicode converting-to-bytes}@anchor{543e}
@subsubsection Convertendo para Bytes


The opposite method of @ref{8dc,,bytes.decode()} is @ref{8db,,str.encode()},
which returns a @ref{1c2,,bytes} representation of the Unicode string, encoded in the
requested `encoding'.

The `errors' parameter is the same as the parameter of the
@ref{8dc,,decode()} method but supports a few more possible handlers. As well as
@code{'strict'}, @code{'ignore'}, and @code{'replace'} (which in this case
inserts a question mark instead of the unencodable character), there is
also @code{'xmlcharrefreplace'} (inserts an XML character reference),
@code{backslashreplace} (inserts a @code{\uNNNN} escape sequence) and
@code{namereplace} (inserts a @code{\N@{...@}} escape sequence).

The following example shows the different results:

@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

The low-level routines for registering and accessing the available
encodings are found in the @ref{1b,,codecs} module.  Implementing new
encodings also requires understanding the @ref{1b,,codecs} module.
However, the encoding and decoding functions returned by this module
are usually more low-level than is comfortable, and writing new encodings
is a specialized task, so the module won’t be covered in this HOWTO.

@node Unicode Literals in Python Source Code,Propriedades Unicode,Convertendo para Bytes,Suporte a Unicode no Python
@anchor{howto/unicode unicode-literals-in-python-source-code}@anchor{543f}
@subsubsection Unicode Literals in Python Source Code


In Python source code, specific Unicode code points can be written using the
@code{\u} escape sequence, which is followed by four hex digits giving the code
point.  The @code{\U} escape sequence is similar, but expects eight hex digits,
not four:

@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

Using escape sequences for code points greater than 127 is fine in small doses,
but becomes an annoyance if you’re using many accented characters, as you would
in a program with messages in French or some other accent-using language.  You
can also assemble strings using the @ref{1768,,chr()} built-in function, but this is
even more tedious.

Ideally, you’d want to be able to write literals in your language’s natural
encoding.  You could then edit Python source code with your favorite editor
which would display the accented characters naturally, and have the right
characters used at runtime.

Python supports writing source code in UTF-8 by default, but you can use almost
any encoding if you declare the encoding being used.  This is done by including
a special comment as either the first or second line of the source file:

@example
#!/usr/bin/env python
# -*- coding: latin-1 -*-

u = 'abcdé'
print(ord(u[-1]))
@end example

The syntax is inspired by Emacs’s notation for specifying variables local to a
file.  Emacs supports many different variables, but Python only supports
‘coding’.  The @code{-*-} symbols indicate to Emacs that the comment is special;
they have no significance to Python but are a convention.  Python looks for
@code{coding: name} or @code{coding=name} in the comment.

If you don’t include such a comment, the default encoding used will be UTF-8 as
already mentioned.  See also 
@geindex Propostas de Melhorias do Python; PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} for more information.

@node Propriedades Unicode,Comparando Strings,Unicode Literals in Python Source Code,Suporte a Unicode no Python
@anchor{howto/unicode id2}@anchor{5440}@anchor{howto/unicode unicode-properties}@anchor{2359}
@subsubsection Propriedades Unicode


The Unicode specification includes a database of information about
code points.  For each defined code point, the information includes
the character’s name, its category, the numeric value if applicable
(for characters representing numeric concepts such as the Roman
numerals, fractions such as one-third and four-fifths, etc.).  There
are also display-related properties, such as how to use the code point
in bidirectional text.

O programa a seguir exibe alguma informação sobre diversos caracteres e imprime o valor numérico de um caractere em 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

Quando executado, isso 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

The category codes are abbreviations describing the nature of the character.
These are grouped into categories such as “Letter”, “Number”, “Punctuation”, or
“Symbol”, which in turn are broken up into subcategories.  To take the codes
from the above output, @code{'Ll'} means ‘Letter, lowercase’, @code{'No'} means
“Number, other”, @code{'Mn'} is “Mark, nonspacing”, and @code{'So'} is “Symbol,
other”.  See
the General Category Values section of the Unicode Character Database documentation@footnote{https://www.unicode.org/reports/tr44/#General_Category_Values} for a
list of category codes.

@node Comparando Strings,Expressões Regulares Unicode,Propriedades Unicode,Suporte a Unicode no Python
@anchor{howto/unicode comparing-strings}@anchor{5441}
@subsubsection Comparando Strings


Unicode adds some complication to comparing strings, because the same
set of characters can be represented by different sequences of code
points.  For example, a letter like ‘ê’ can be represented as a single
code point U+00EA, or as U+0065 U+0302, which is the code point for
‘e’ followed by a code point for ‘COMBINING CIRCUMFLEX ACCENT’.  These
will produce the same output when printed, but one is a string of
length 1 and the other is of length 2.

One tool for a case-insensitive comparison is the
@ref{e00,,casefold()} string method that converts a string to a
case-insensitive form following an algorithm described by the Unicode
Standard.  This algorithm has special handling for characters such as
the German letter ‘ß’ (code point U+00DF), which becomes the pair of
lowercase letters ‘ss’.

@example
>>> street = 'Gürzenichstraße'
>>> street.casefold()
'gürzenichstrasse'
@end example

A second tool is the @ref{105,,unicodedata} module’s
@ref{6d5,,normalize()} function that converts strings to one
of several normal forms, where letters followed by a combining character are
replaced with single characters.  @ref{6d5,,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

When run, this outputs:

@example
$ python compare-strs.py
length of first string= 1
length of second string= 2
True
@end example

The first argument to the @ref{6d5,,normalize()} function is a
string giving the desired normalization form, which can be one of
‘NFC’, ‘NFKC’, ‘NFD’, and ‘NFKD’.

The Unicode Standard also specifies how to do caseless comparisons:

@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{e00,,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 Expressões Regulares Unicode,Referências<4>,Comparando Strings,Suporte a Unicode no Python
@anchor{howto/unicode unicode-regular-expressions}@anchor{5442}
@subsubsection Expressões Regulares Unicode


The regular expressions supported by the @ref{b9,,re} module can be provided
either as bytes or strings.  Some of the special character sequences such as
@code{\d} and @code{\w} have different meanings depending on whether
the pattern is supplied as bytes or a string.  For example,
@code{\d} will match the characters @code{[0-9]} in bytes but
in strings will match any character that’s in the @code{'Nd'} category.

The string in this example has the number 57 written in both Thai and
Arabic numerals:

@example
import re
p = re.compile(r'\d+')

s = "Over \u0e55\u0e57 57 flavours"
m = p.search(s)
print(repr(m.group()))
@end example

When executed, @code{\d+} will match the Thai numerals and print them
out.  If you supply the @ref{62c,,re.ASCII} flag to
@ref{bee,,compile()}, @code{\d+} will match the substring “57” instead.

Similarly, @code{\w} matches a wide variety of Unicode characters but
only @code{[a-zA-Z0-9_]} in bytes or if @ref{62c,,re.ASCII} is supplied,
and @code{\s} will match either Unicode whitespace characters or
@code{[ \t\n\r\f\v]}.

@node Referências<4>,,Expressões Regulares Unicode,Suporte a Unicode no Python
@anchor{howto/unicode id3}@anchor{5443}
@subsubsection Referências


@c comment should these be mentioned earlier, e.g. at the start of the "introduction to Unicode" first section?

Some good alternative discussions of Python’s Unicode support are:


@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}, a PyCon 2012 presentation by Ned Batchelder.
@end itemize

The @ref{44c,,str} type is described in the Python library reference at
@ref{1d7a,,Tipo sequência de texto — str}.

The documentation for the @ref{105,,unicodedata} module.

The documentation for the @ref{1b,,codecs} module.

Marc-André Lemburg gave a presentation titled "Python and Unicode" (PDF slides)@footnote{https://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf} at
EuroPython 2002.  The slides are an excellent overview of the design of Python
2’s Unicode features (where the Unicode string type is called @code{unicode} and
literals start with @code{u}).

@node Reading and Writing Unicode Data,Reconhecimentos<10>,Suporte a Unicode no Python,Unicode<3>
@anchor{howto/unicode reading-and-writing-unicode-data}@anchor{5444}
@subsection Reading and Writing Unicode Data


Once you’ve written some code that works with Unicode data, the next problem is
input/output.  How do you get Unicode strings into your program, and how do you
convert Unicode into a form suitable for storage or transmission?

It’s possible that you may not need to do anything depending on your input
sources and output destinations; you should check whether the libraries used in
your application support Unicode natively.  XML parsers often return Unicode
data, for example.  Many relational databases also support Unicode-valued
columns and can return Unicode values from an SQL query.

Unicode data is usually converted to a particular encoding before it gets
written to disk or sent over a socket.  It’s possible to do all the work
yourself: open a file, read an 8-bit bytes object from it, and convert the bytes
with @code{bytes.decode(encoding)}.  However, the manual approach is not recommended.

One problem is the multi-byte nature of encodings; one Unicode character can be
represented by several bytes.  If you want to read the file in arbitrary-sized
chunks (say, 1024 or 4096 bytes), you need to write error-handling code to catch the case
where only part of the bytes encoding a single Unicode character are read at the
end of a chunk.  One solution would be to read the entire file into memory and
then perform the decoding, but that prevents you from working with files that
are extremely large; if you need to read a 2 GiB file, you need 2 GiB of RAM.
(More, really, since for at least a moment you’d need to have both the encoded
string and its Unicode version in memory.)

The solution would be to use the low-level decoding interface to catch the case
of partial coding sequences.  The work of implementing this has already been
done for you: the built-in @ref{51c,,open()} function can return a file-like object
that assumes the file’s contents are in a specified encoding and accepts Unicode
parameters for methods such as @ref{1e0c,,read()} and
@ref{1dfb,,write()}.  This works through @ref{51c,,open()}'s `encoding' and
`errors' parameters which are interpreted just like those in @ref{8db,,str.encode()}
and @ref{8dc,,bytes.decode()}.

Reading Unicode from a file is therefore simple:

@example
with open('unicode.txt', encoding='utf-8') as f:
    for line in f:
        print(repr(line))
@end example

It’s also possible to open files in update mode, allowing both reading and
writing:

@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

The Unicode character @code{U+FEFF} is used as a byte-order mark (BOM), and is often
written as the first character of a file in order to assist with autodetection
of the file’s byte ordering.  Some encodings, such as UTF-16, expect a BOM to be
present at the start of a file; when such an encoding is used, the BOM will be
automatically written as the first character and will be silently dropped when
the file is read.  There are variants of these encodings, such as ‘utf-16-le’
and ‘utf-16-be’ for little-endian and big-endian encodings, that specify one
particular byte ordering and don’t skip the BOM.

In some areas, it is also convention to use a “BOM” at the start of UTF-8
encoded files; the name is misleading since UTF-8 is not byte-order dependent.
The mark simply announces that the file is encoded in UTF-8.  For reading such
files, use the ‘utf-8-sig’ codec to automatically skip the mark if present.

@menu
* Nomes de arquivos Unicode:: 
* Tips for Writing Unicode-aware Programs:: 
* Referências: Referências<5>. 

@end menu

@node Nomes de arquivos Unicode,Tips for Writing Unicode-aware Programs,,Reading and Writing Unicode Data
@anchor{howto/unicode unicode-filenames}@anchor{5445}
@subsubsection Nomes de arquivos Unicode


Most of the operating systems in common use today support filenames
that contain arbitrary Unicode characters.  Usually this is
implemented by converting the Unicode string into some encoding that
varies depending on the system.  Today Python is converging on using
UTF-8: Python on MacOS has used UTF-8 for several versions, and Python
3.6 switched to using UTF-8 on Windows as well.  On Unix systems,
there will only be a @ref{53b,,filesystem encoding}. if you’ve set the @code{LANG} or @code{LC_CTYPE} environment variables; if
you haven’t, the default encoding is again UTF-8.

The @ref{c74,,sys.getfilesystemencoding()} function returns the encoding to use on
your current system, in case you want to do the encoding manually, but there’s
not much reason to bother.  When opening a file for reading or writing, you can
usually just provide the Unicode string as the filename, and it will be
automatically converted to the right encoding for you:

@example
filename = 'filename\u4500abc'
with open(filename, 'w') as f:
    f.write('blah\n')
@end example

Functions in the @ref{a1,,os} module such as @ref{4a0,,os.stat()} will also accept Unicode
filenames.

The @ref{1139,,os.listdir()} function returns filenames, which raises an issue: should it return
the Unicode version of filenames, or should it return bytes containing
the encoded versions?  @ref{1139,,os.listdir()} can do both, depending on whether you
provided the directory path as bytes or a Unicode string.  If you pass a
Unicode string as the path, filenames will be decoded using the filesystem’s
encoding and a list of Unicode strings will be returned, while passing a byte
path will return the filenames as bytes.  For example,
assuming the default @ref{53b,,filesystem encoding} is UTF-8, running the following program:

@example
fn = 'filename\u4500abc'
f = open(fn, 'w')
f.close()

import os
print(os.listdir(b'.'))
print(os.listdir('.'))
@end example

will produce the following output:

@example
$ python listdir-test.py
[b'filename\xe4\x94\x80abc', ...]
['filename\u4500abc', ...]
@end example

The first list contains UTF-8-encoded filenames, and the second list contains
the Unicode versions.

Note that on most occasions, you should can just stick with using
Unicode with these APIs.  The bytes APIs should only be used on
systems where undecodable file names can be present; that’s
pretty much only Unix systems now.

@node Tips for Writing Unicode-aware Programs,Referências<5>,Nomes de arquivos Unicode,Reading and Writing Unicode Data
@anchor{howto/unicode tips-for-writing-unicode-aware-programs}@anchor{5446}
@subsubsection Tips for Writing Unicode-aware Programs


This section provides some suggestions on writing software that deals with
Unicode.

A dica mais importante é:

@quotation

Software should only work with Unicode strings internally, decoding the input
data as soon as possible and encoding the output only at the end.
@end quotation

If you attempt to write processing functions that accept both Unicode and byte
strings, you will find your program vulnerable to bugs wherever you combine the
two different kinds of strings.  There is no automatic encoding or decoding: if
you do e.g. @code{str + bytes}, a @ref{2c3,,TypeError} will be raised.

When using data coming from a web browser or some other untrusted source, a
common technique is to check for illegal characters in a string before using the
string in a generated command line or storing it in a database.  If you’re doing
this, be careful to check the decoded string, not the encoded bytes data;
some encodings may have interesting properties, such as not being bijective
or not being fully ASCII-compatible.  This is especially true if the input
data also specifies the encoding, since the attacker can then choose a
clever way to hide malicious text in the encoded bytestream.

@menu
* Converting Between File Encodings:: 
* Files in an Unknown Encoding:: 

@end menu

@node Converting Between File Encodings,Files in an Unknown Encoding,,Tips for Writing Unicode-aware Programs
@anchor{howto/unicode converting-between-file-encodings}@anchor{5447}
@subsubsection Converting Between File Encodings


The @ref{1b68,,StreamRecoder} class can transparently convert between
encodings, taking a stream that returns data in encoding #1
and behaving like a stream returning data in encoding #2.

For example, if you have an input file `f' that’s in Latin-1, you
can wrap it with a @ref{1b68,,StreamRecoder} to return bytes encoded in
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 Files in an Unknown Encoding,,Converting Between File Encodings,Tips for Writing Unicode-aware Programs
@anchor{howto/unicode files-in-an-unknown-encoding}@anchor{5448}
@subsubsection Files in an Unknown Encoding


What can you do if you need to make a change to a file, but don’t know
the file’s encoding?  If you know the encoding is ASCII-compatible and
only want to examine or modify the ASCII parts, you can open the file
with the @code{surrogateescape} error handler:

@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

The @code{surrogateescape} error handler will decode any non-ASCII bytes
as code points in a special range running from U+DC80 to
U+DCFF.  These code points will then turn back into the
same bytes when the @code{surrogateescape} error handler is used to
encode the data and write it back out.

@node Referências<5>,,Tips for Writing Unicode-aware Programs,Reading and Writing Unicode Data
@anchor{howto/unicode id4}@anchor{5449}
@subsubsection Referências


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.

The 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}
discuss questions of character encodings as well as how to internationalize
and localize an application.  These slides cover Python 2.x only.

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 Reconhecimentos<10>,,Reading and Writing Unicode Data,Unicode<3>
@anchor{howto/unicode acknowledgements}@anchor{544a}
@subsection Reconhecimentos


The initial draft of this document was written by Andrew Kuchling.
It has since been revised further by Alexander Belopolsky, Georg Brandl,
Andrew Kuchling, and Ezio Melotti.

Thanks to the following people who have noted errors or offered
suggestions on this article: É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 Como buscar recursos da Internet usando o pacote urllib,Uma introdução ao módulo ipaddress,Unicode<3>,Python HOWTOs
@anchor{howto/urllib2 doc}@anchor{544b}@anchor{howto/urllib2 howto-fetch-internet-resources-using-the-urllib-package}@anchor{544c}@anchor{howto/urllib2 translation-repo}@anchor{544d}@anchor{howto/urllib2 urllib-howto}@anchor{3c3e}
@section Como buscar recursos da Internet usando o pacote urllib


@*Autor: 
Michael Foord@footnote{https://agileabstractions.com/}


@menu
* Introdução: Introdução<17>. 
* Acessando URLs:: 
* Tratamento de exceções: Tratamento de exceções<3>. 
* info e geturl:: 
* Abridores e tratadores:: 
* Autenticação básica:: 
* Proxies:: 
* Socekts e camadas:: 
* Notas de rodapé:: 

@end menu

@node Introdução<17>,Acessando URLs,,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 introduction}@anchor{544e}
@subsection Introdução


@subsubheading Related Articles



Você também pode achar útil o seguinte artigo na busca de recursos da web com Python:


@itemize *

@item 
Autenticação Básica@footnote{https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml}

@quotation

Um tutorial sobre `Autenticação Básica', com exemplos em Python.
@end quotation
@end itemize

`urllib.request' é um modulo Python para buscar URLs (Uniform Resource Locators). Ele oferece uma interface muito simples, na forma da função `urlopen'. Este é capaz de buscar URLs usando uma variedade de diferentes protocolos. Ele também oferece uma interface um pouco mais complexa para lidar com situações comuns - como autenticação básica, cookies, proxies e assim por diante. Estes são fornecidos por objetos chamados handlers (manipuladores) e openers (abridores).

urllib.request suporta o acesso a URLs por meio de vários “esquemas de URL” (identificados pela string antes de @code{":"} na URL - por exemplo @code{"ftp"} é o esquema de URL em @code{"ftp://python.org/"}) usando o protocolo de rede associado a ele (como FTP e HTTP). Este tutorial foca no caso mais comum, HTTP.

Para situações simples “urlopen” é muito fácil de usar. Mas assim que você se depara com erros ou casos não triviais ao abrir URLs HTTP, você vai precisar entender um pouco mais do HyperText Transfer Protocol. A literatura de referência mais reconhecida e compreensível para o HTTP é 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. Ela é um documento técnico e não foi feita para ser fácil de ler. Este documento busca ilustrar o uso de `urllib' com detalhes suficientes sobre HTTP para te permitir seguir adiante. Ele não tem a intenção de substituir a documentação do @ref{10b,,urllib.request}, mas é suplementar a ela.

@node Acessando URLs,Tratamento de exceções<3>,Introdução<17>,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 fetching-urls}@anchor{544f}
@subsection Acessando URLs


O modo mais simples de usar urllib.request é o seguinte:

@example
import urllib.request
with urllib.request.urlopen('http://python.org/') as response:
   html = response.read()
@end example

Se você deseja obter um recurso via URL e guardá-lo em uma localização temporária, você pode fazê-lo com as funções @ref{a66,,shutil.copyfileobj()} e @ref{4c6,,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

Muitos usos de urllib são simples assim (repare que ao invés de uma URL ‘http:’ nós poderíamos ter usado uma string URL começando com ‘ftp:’, ‘file:’, etc.).. No entanto, o propósito deste tutorial é explicar casos mais complicados, concentrando em HTTP.

HTTP é baseado em solicitações (requests) e respostas (responses) - o cliente faz solicitações e os servidores mandam respostas. urllib.request espelha isto com um objeto @code{Request} que representa a solicitação HTTP que você está fazendo. Na sua forma mais simples, você cria um objeto Request que especifica a URL que você quer acessar. Chamar @code{urlopen} com este objeto Request retorna um objeto de resposta para a URL solicitada. Essa resposta é um objeto arquivo ou similar, o que significa que você pode, por exemplo, chamar @code{.read()} na resposta:

@example
import urllib.request

req = urllib.request.Request('http://python.org/')
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

Note que urllib.request usa a mesma interface Request para tratar todos os esquemas URL. Por exemplo, você pode fazer uma solicitação FTP da seguinte forma:

@example
req = urllib.request.Request('ftp://example.com/')
@end example

No caso do HTTP, há duas coisas extras que os objetos Request permitem que você faça: primeiro, você pode passar dados a serem enviados ao servidor. Segundo, você pode passar informações extras (“metadados”) `sobre' os dados ou sobre a própria solicitação para o servidor — essas informações são enviadas como “cabeçalhos” HTTP. Vamos analisar cada um deles separadamente.

@menu
* Dados:: 
* Cabeçalhos:: 

@end menu

@node Dados,Cabeçalhos,,Acessando URLs
@anchor{howto/urllib2 data}@anchor{5450}
@subsubsection Dados


Às vezes, você deseja enviar dados para uma URL (geralmente a URL se refere a um script CGI (Common Gateway Interface) ou outra aplicação web). Com HTTP, isso geralmente é feito usando o que é conhecido como uma solicitação `POST'. Isso geralmente é o que seu navegador faz quando você envia um formulário HTML preenchido na web. Nem todos os POSTs precisam vir de formulários: você pode usar um POST para transmitir dados arbitrários para sua própria aplicação. No caso comum de formulários HTML, os dados precisam ser codificados de forma padrão e, em seguida, passados para o objeto Request como o argumento @code{data}. A codificação é feita usando uma função da biblioteca @ref{10a,,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

Observe que outras codificações às vezes são necessárias (por exemplo, para envio de arquivos de formulários HTML - consulte HTML Specification@comma{} Form Submission@footnote{https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13} para mais detalhes).

Se você não passar o argumento @code{data}, o urllib usará uma requisição `GET'. Uma diferença entre requisições GET e POST é que as requisições POST frequentemente têm “efeitos colaterais”: elas alteram o estado do sistema de alguma forma (por exemplo, ao fazer um pedido ao site para que cem libras de spam enlatado sejam entregues em sua porta). Embora o padrão HTTP deixe claro que os POSTs devem `sempre' causar efeitos colaterais, e as requisições GET `nunca' causar efeitos colaterais, nada impede que uma requisição GET tenha efeitos colaterais, nem que uma requisição POST não tenha efeitos colaterais. Dados também podem ser passados em uma requisição HTTP GET codificando-os na própria URL.

Isso é feito como abaixo:

@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

Observe que o URL completo é criado adicionando um @code{?} ao URL, seguido pelos valores codificados.

@node Cabeçalhos,,Dados,Acessando URLs
@anchor{howto/urllib2 headers}@anchor{5451}
@subsubsection Cabeçalhos


Discutiremos aqui um cabeçalho HTTP específico para ilustrar como adicionar cabeçalhos à sua solicitação HTTP.

Alguns sites @footnote{
Google, por exemplo.
} não gostam de ser navegados por programas ou enviam versões diferentes para navegadores diferentes @footnote{
A detecção de navegadores é uma prática muito ruim para o design de sites; construir sites usando padrões web é muito mais sensato. Infelizmente, muitos sites ainda enviam versões diferentes para navegadores diferentes.
}. Por padrão, urllib se identifica como @code{Python-urllib/x.y} (onde @code{x} e @code{y} são os números de versão principal e secundária da versão do Python, por exemplo, @code{Python-urllib/2.5}), o que pode confundir o site ou simplesmente não funcionar. A forma como um navegador se identifica é através do cabeçalho @code{User-Agent} @footnote{
O user agent para MSIE 6 é `‘Mozilla/4.0 (compatível; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)’'
}. Ao criar um objeto Request, você pode passar um dicionário de cabeçalhos. O exemplo a seguir faz a mesma solicitação acima, mas se identifica como uma versão do Internet Explorer @footnote{
Para obter detalhes sobre mais cabeçalhos de solicitação HTTP, consulte @ref{5452,,Referência rápida para cabeçalhos HTTP}.
}.

@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

A resposta também possui dois métodos úteis. Veja a seção sobre @ref{5453,,info e geturl}, que vem depois de analisarmos o que acontece quando as coisas dão errado.

@node Tratamento de exceções<3>,info e geturl,Acessando URLs,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 handling-exceptions}@anchor{5454}
@subsection Tratamento de exceções


`urlopen' levanta @ref{3bca,,URLError} quando não consegue tratar uma resposta (embora, como de costume com APIs Python, exceções embutidas como @ref{202,,ValueError}, @ref{2c3,,TypeError} etc. também possam ser levantadas).

@ref{1014,,HTTPError} é a subclasse de @ref{3bca,,URLError} levantada no caso específico de URLs HTTP.

As classes de exceção são exportadas do módulo @ref{109,,urllib.error}.

@menu
* URLError:: 
* HTTPError:: 
* Resumindo:: 

@end menu

@node URLError,HTTPError,,Tratamento de exceções<3>
@anchor{howto/urllib2 urlerror}@anchor{5455}
@subsubsection URLError


Frequentemente, URLError é levantada porque não há conexão de rede (nenhuma rota para o servidor especificado) ou o servidor especificado não existe. Nesse caso, a exceção gerada terá um atributo “reason”, que é uma tupla contendo um código de erro e uma mensagem de erro em texto.

Por exemplo

@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,Resumindo,URLError,Tratamento de exceções<3>
@anchor{howto/urllib2 httperror}@anchor{5456}
@subsubsection HTTPError


Cada resposta HTTP do servidor contém um “código de status” numérico. Às vezes, o código de status indica que o servidor não consegue atender à solicitação. Os manipuladores padrão lidarão com algumas dessas respostas para você (por exemplo, se a resposta for um “redirecionamento” que solicita que o cliente busque o documento de uma URL diferente, o urllib cuidará disso para você). Para aquelas que ele não consegue tratar, o urlopen lançará um @ref{1014,,HTTPError}. Erros típicos incluem ‘404’ (página não encontrada), ‘403’ (solicitação proibida) e ‘401’ (autenticação necessária).

Veja a seção 10 de 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} para uma referência sobre todos os códigos de erro HTTP.

A instância @ref{1014,,HTTPError} levantada terá um atributo inteiro ‘code’, que corresponde ao erro enviado pelo servidor.

@menu
* Códigos de erro:: 

@end menu

@node Códigos de erro,,,HTTPError
@anchor{howto/urllib2 error-codes}@anchor{5457}
@subsubsection Códigos de erro


Como os tratadores padrão controlam redirecionamentos (códigos no intervalo 300) e códigos no intervalo 100-299 indicam sucesso, normalmente você verá apenas códigos de erro no intervalo 400-599.

@ref{3c69,,http.server.BaseHTTPRequestHandler.responses} é um dicionário útil de códigos de resposta que mostra todos os códigos de resposta usados por 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}. Um trecho do dicionário é mostrado abaixo

@example
responses = @{
    ...
    <HTTPStatus.OK: 200>: ('OK', 'Request fulfilled, document follows'),
    ...
    <HTTPStatus.FORBIDDEN: 403>: ('Forbidden',
                                  'Request forbidden -- authorization will '
                                  'not help'),
    <HTTPStatus.NOT_FOUND: 404>: ('Not Found',
                                  'Nothing matches the given URI'),
    ...
    <HTTPStatus.IM_A_TEAPOT: 418>: ("I'm a Teapot",
                                    'Server refuses to brew coffee because '
                                    'it is a teapot'),
    ...
    <HTTPStatus.SERVICE_UNAVAILABLE: 503>: ('Service Unavailable',
                                            'The server cannot process the '
                                            'request due to a high load'),
    ...
    @}
@end example

Quando um erro é levantado, o servidor responde retornando um código de erro HTTP `e' uma página de erro. Você pode usar a instância @ref{1014,,HTTPError} como resposta na página retornada. Isso significa que, além do atributo code, ela também possui os métodos read, geturl e info, conforme retornados pelo módulo @code{urllib.response}:

@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 Resumindo,,HTTPError,Tratamento de exceções<3>
@anchor{howto/urllib2 wrapping-it-up}@anchor{5458}
@subsubsection Resumindo


Então, se você quiser se preparar para @ref{1014,,HTTPError} `ou' @ref{3bca,,URLError}, existem duas abordagens básicas. Eu prefiro a segunda.

@menu
* Número 1:: 
* Número 2:: 

@end menu

@node Número 1,Número 2,,Resumindo
@anchor{howto/urllib2 number-1}@anchor{5459}
@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:
    # tudo certo
@end example

@cartouche
@quotation Nota 
O @code{except HTTPError} `deve' vir primeiro, caso contrário, @code{except URLError} `também' capturará uma @ref{1014,,HTTPError}.
@end quotation
@end cartouche

@node Número 2,,Número 1,Resumindo
@anchor{howto/urllib2 number-2}@anchor{545a}
@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:
    # tudo certo
@end example

@node info e geturl,Abridores e tratadores,Tratamento de exceções<3>,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 info-and-geturl}@anchor{5453}
@subsection info e geturl


A resposta retornada por urlopen (ou a instância @ref{1014,,HTTPError}) tem dois métodos úteis @code{info()} e @code{geturl()} e é definida no módulo @ref{10c,,urllib.response}.


@itemize *

@item 
`geturl' - Isso retorna a URL real da página recuperada. Isso é útil porque @code{urlopen} (ou o objeto de abertura utilizado) pode ter seguido um redirecionamento. A URL da página recuperada pode não ser a mesma que a URL solicitada.

@item 
`info' - Isso retorna um objeto semelhante a um dicionário que descreve a página recuperada, particularmente os cabeçalhos enviados pelo servidor. Atualmente, é uma instância de @ref{3c83,,http.client.HTTPMessage}.
@end itemize

Cabeçalhos típicos incluem ‘Content-length’, ‘Content-type’ e assim por diante. Consulte a “Referência rápida para cabeçalhos HTTP <@indicateurl{https://jkorpela.fi/http.html}>” para obter uma lista útil de cabeçalhos HTTP com breves explicações sobre seu significado e uso.

@node Abridores e tratadores,Autenticação básica,info e geturl,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 openers-and-handlers}@anchor{545b}
@subsection Abridores e tratadores


Ao buscar uma URL, você usa um abridor (uma instância do talvez confuso nome @ref{3bcb,,urllib.request.OpenerDirector}). Normalmente, usamos o abridor padrão - via @code{urlopen} -, mas você pode criar abridores personalizados. Os abridores usam manipuladores. Todo o “trabalho pesado” é feito pelos manipuladores. Cada manipulador sabe como abrir URLs para um esquema de URL específico (http, ftp, etc.) ou como lidar com um aspecto da abertura de URL, por exemplo, redirecionamentos HTTP ou cookies HTTP.

Você vai querer criar abridores se quiser buscar URLs com manipuladores específicos instalados, por exemplo, para obter um abridor que manipule cookies ou para obter um abridor que não manipule redirecionamentos.

Para criar um abridor, instancie um @code{OpenerDirector} e então chame @code{.add_handler(some_handler_instance)} repetidamente.

Como alternativa, você pode usar @code{build_opener}, que é uma função conveniente para criar objetos de abertura com uma única chamada de função. @code{build_opener} adiciona vários tratadores por padrão, mas fornece uma maneira rápida de adicionar mais e/ou substituir os tratadores padrão.

Outros tipos de manipuladores que você pode querer podem lidar com proxies, autenticação e outras situações comuns, mas um pouco especializadas.

@code{install_opener} pode ser usado para tornar um objeto @code{opener} o abridor padrão (global). Isso significa que chamadas para @code{urlopen} usarão o abridor que você instalou.

Objetos abridores têm um método @code{open}, que pode ser chamado diretamente para buscar URLs da mesma forma que a função @code{urlopen}: não há necessidade de chamar @code{install_opener}, exceto por conveniência.

@node Autenticação básica,Proxies,Abridores e tratadores,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 basic-authentication}@anchor{545c}
@subsection Autenticação básica


Para ilustrar a criação e instalação de um manipulador, usaremos o @code{HTTPBasicAuthHandler}. Para uma discussão mais detalhada sobre este assunto — incluindo uma explicação de como funciona a autenticação básica — consulte este tutorial de autenticação básica@footnote{https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml}.

Quando a autenticação é necessária, o servidor envia um cabeçalho (e o código de erro 401) solicitando autenticação. Isso especifica o esquema de autenticação e um “domínio”. O cabeçalho se parece com: @code{WWW-Authenticate: SCHEME realm="REALM"}.

Por exemplo:

@example
WWW-Authenticate: Basic realm="cPanel Users"
@end example

O cliente deve então tentar a solicitação novamente com o nome e a senha apropriados para o domínio incluídos como cabeçalho na solicitação. Isso é “autenticação básica”. Para simplificar esse processo, podemos criar uma instância de @code{HTTPBasicAuthHandler} e um opener para usar esse manipulador.

O @code{HTTPBasicAuthHandler} usa um objeto chamado gerenciador de senhas para manipular o mapeamento de URLs e domínios para senhas e nomes de usuário. Se você souber qual é o domínio (a partir do cabeçalho de autenticação enviado pelo servidor), poderá usar um @code{HTTPPasswordMgr}. Frequentemente, não importa qual seja o domínio. Nesse caso, é conveniente usar @code{HTTPPasswordMgrWithDefaultRealm}. Isso permite que você especifique um nome de usuário e uma senha padrão para uma URL. Isso será fornecido caso você não forneça uma combinação alternativa para um domínio específico. Indicamos isso fornecendo @code{None} como argumento de domínio para o método @code{add_password}.

A URL de nível superior é a primeira URL que requer autenticação. URLs “mais profundas” que a URL que você passa para .add_password() também corresponderão.

@example
# cria um gerenciador de senhas
password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()

# Adiciona o nome de usuário e senha.
# Se soubéssemos o realm, poderíamos usá-lo em vez de None.
top_level_url = "http://example.com/foo/"
password_mgr.add_password(None, top_level_url, username, password)

handler = urllib.request.HTTPBasicAuthHandler(password_mgr)

# cria um "opener" (OpenerDirector instance)
opener = urllib.request.build_opener(handler)

# usa o opener para obter uma URL
opener.open(a_url)

# Instala o opener.
# Agora, todas as chamadas a urllib.request.urlopen usam nosso opener.
urllib.request.install_opener(opener)
@end example

@cartouche
@quotation Nota 
No exemplo acima, fornecemos apenas nosso @code{HTTPBasicAuthHandler} para @code{build_opener}. Por padrão, os “openers” possuem os manipuladores para situações normais: @code{ProxyHandler} (se uma configuração de proxy, como uma variável de ambiente @code{http_proxy}, estiver definida), @code{UnknownHandler}, @code{HTTPHandler}, @code{HTTPDefaultErrorHandler}, @code{HTTPRedirectHandler}, @code{FTPHandler}, @code{FileHandler}, @code{DataHandler}, @code{HTTPErrorProcessor}.
@end quotation
@end cartouche

@code{top_level_url} é, na verdade, `ou' uma URL completa (incluindo o componente do esquema ‘http:’, o nome do host e, opcionalmente, o número da porta), por exemplo, @code{"http://example.com/"}, `ou' uma “autoridade” (ou seja, o nome do host, incluindo, opcionalmente, o número da porta), por exemplo, @code{"example.com"} ou @code{"example.com:8080"} (este último exemplo inclui um número de porta). A autoridade, se presente, NÃO deve conter o componente “userinfo” - por exemplo, @code{"joe:senha@@example.com"} não está correto.

@node Proxies,Socekts e camadas,Autenticação básica,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 proxies}@anchor{545d}
@subsection Proxies


`urllib' detectará automaticamente suas configurações de proxy e as utilizará. Isso ocorre por meio do @code{ProxyHandler}, que faz parte da cadeia de manipuladores normal quando uma configuração de proxy é detectada. Normalmente, isso é bom, mas há ocasiões em que pode não ser útil @footnote{
No meu caso, preciso usar um proxy para acessar a internet no trabalho. Se você tentar buscar URLs `localhost' por meio desse proxy, ele as bloqueia. O IE está configurado para usar o proxy, que o urllib detecta. Para testar scripts com um servidor localhost, preciso impedir que o urllib use o proxy.
}. Uma maneira de fazer isso é configurar nosso próprio @code{ProxyHandler}, sem proxies definidos. Isso é feito seguindo etapas semelhantes à configuração de um manipulador de @ref{545c,,autenticação básica}:

@example
>>> proxy_support = urllib.request.ProxyHandler(@{@})
>>> opener = urllib.request.build_opener(proxy_support)
>>> urllib.request.install_opener(opener)
@end example

@cartouche
@quotation Nota 
Atualmente, @code{urllib.request} `não' oferece suporte à busca de locais @code{https} por meio de um proxy. No entanto, isso pode ser habilitado estendendo urllib.request, conforme mostrado na receita @footnote{
Abridor urllib para proxy SSL (método CONNECT): @uref{https://code.activestate.com/recipes/456195-urrlib2-opener-for-ssl-proxy-connect-method/,Receita do livro de receitas ASPN}.
}.
@end quotation
@end cartouche

@cartouche
@quotation Nota 
@code{HTTP_PROXY} será ignorado se uma variável @code{REQUEST_METHOD} estiver definida; veja a documentação em @ref{3bc7,,getproxies()}.
@end quotation
@end cartouche

@node Socekts e camadas,Notas de rodapé,Proxies,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 sockets-and-layers}@anchor{545e}
@subsection Socekts e camadas


O suporte do Python para buscar recursos web é em camadas. urllib usa a biblioteca @ref{6f,,http.client}, que por sua vez usa a biblioteca de sockets.

A partir do Python 2.3, você pode especificar quanto tempo um soquete deve aguardar por uma resposta antes de atingir o tempo limite. Isso pode ser útil em aplicações que precisam buscar páginas web. Por padrão, o módulo socket `não tem tempo limite' e pode travar. Atualmente, o tempo limite do soquete não é exposto nos níveis http.client ou urllib.request. No entanto, você pode definir o tempo limite padrão globalmente para todos os soquetes usando

@example
import socket
import urllib.request

# tempo limite em secungos
timeout = 10
socket.setdefaulttimeout(timeout)

# isso chamada a urllib.request.urlopen agora usa o tempo limite padrão
# que nós definidos no módulo socket
req = urllib.request.Request('http://www.voidspace.org.uk')
response = urllib.request.urlopen(req)
@end example


__________________________________________________________________


@node Notas de rodapé,,Socekts e camadas,Como buscar recursos da Internet usando o pacote urllib
@anchor{howto/urllib2 footnotes}@anchor{545f}
@subsection Notas de rodapé


Este documento foi revisado e revisado por John Lee.

@c import ipaddress

@node Uma introdução ao módulo ipaddress,Instrumentando o CPython com DTrace e SystemTap,Como buscar recursos da Internet usando o pacote urllib,Python HOWTOs
@anchor{howto/ipaddress doc}@anchor{5460}@anchor{howto/ipaddress an-introduction-to-the-ipaddress-module}@anchor{5461}@anchor{howto/ipaddress ipaddress-howto}@anchor{3e7f}@anchor{howto/ipaddress translation-repo}@anchor{5462}
@section Uma introdução ao módulo ipaddress


@*autor: 
Peter Moody


@*autor: 
Nick Coghlan


@subsubheading Visão Geral



Este documento tem como objetivo prover uma suave introdução ao módulo @ref{80,,ipaddress}. Ele é direcionado primeiramente para usuários que ainda não são familiarizados com a terminologia de rede IP, mas também pode ser útil para engenheiros de rede que querem uma visão geral de como @ref{80,,ipaddress} representa os conceitos de endereçamento de rede IP.

@menu
* Criando objetos de Endereço/Rede/Interface:: 
* Inspecionando objetos endereço/rede/interface:: 
* Redes como listas de Addresses:: 
* Comparações: Comparações<4>. 
* Usando endereços IP com outros módulos:: 
* Obtendo mais detalhes quando a criação da instância falha:: 

@end menu

@node Criando objetos de Endereço/Rede/Interface,Inspecionando objetos endereço/rede/interface,,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress creating-address-network-interface-objects}@anchor{5463}
@subsection Criando objetos de Endereço/Rede/Interface


Como @ref{80,,ipaddress} é um módulo para inspecionar e manipular endereços IP, a primeira coisa que você deseja fazer é criar alguns objetos. Você pode usar @ref{80,,ipaddress} para criar objetos a partir de strings e inteiros.

@menu
* Uma observação sobre versões do IP:: 
* Endereços IP de host:: 
* Definindo redes:: 
* Interfaces do host:: 

@end menu

@node Uma observação sobre versões do IP,Endereços IP de host,,Criando objetos de Endereço/Rede/Interface
@anchor{howto/ipaddress a-note-on-ip-versions}@anchor{5464}
@subsubsection Uma observação sobre versões do IP


Para leitores que não estão particularmente familiarizados com o endereçamento IP, é importante saber que o Protocolo de Internet (IP) está atualmente em processo de mudança da versão 4 do protocolo para a versão 6. Esta transição está ocorrendo em grande parte porque a versão 4 do protocolo não fornece endereços suficientes para atender às necessidades do mundo inteiro, principalmente devido ao crescente número de dispositivos com conexões diretas à Internet.

Explicar os detalhes das diferenças entre as duas versões do protocolo está além do escopo desta introdução, mas os leitores precisam pelo menos estar cientes de que essas duas versões existem, e às vezes será necessário forçar o uso de uma versão ou do outro.

@node Endereços IP de host,Definindo redes,Uma observação sobre versões do IP,Criando objetos de Endereço/Rede/Interface
@anchor{howto/ipaddress ip-host-addresses}@anchor{5465}
@subsubsection Endereços IP de host


Os endereços, muitas vezes chamados de “endereços de host”, são a unidade mais básica ao trabalhar com endereçamento IP. A maneira mais simples de criar endereços é usar a função de fábrica @ref{3e81,,ipaddress.ip_address()}, que determina automaticamente se deve ser criado um endereço IPv4 ou IPv6 com base no valor passado:

@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

Os endereços também podem ser criados diretamente a partir de números inteiros. Os valores que cabem em 32 bits são considerados endereços IPv4:

@example
>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address(42540766411282592856903984951653826561)
IPv6Address('2001:db8::1')
@end example

Para forçar o uso de endereços IPv4 ou IPv6, as classes relevantes podem ser invocadas diretamente. Isto é particularmente útil para forçar a criação de endereços IPv6 para números inteiros pequenos:

@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 Definindo redes,Interfaces do host,Endereços IP de host,Criando objetos de Endereço/Rede/Interface
@anchor{howto/ipaddress defining-networks}@anchor{5466}
@subsubsection Definindo redes


Endereços de host geralmente são agrupados em redes IP, então @ref{80,,ipaddress} fornece uma maneira de criar, inspecionar e manipular definições de rede. Os objetos de rede IP são construídos a partir de strings que definem o intervalo de endereços de host que fazem parte dessa rede. A forma mais simples para essa informação é um par de “endereço de rede/prefixo de rede”, onde o prefixo define o número de bits iniciais que são comparados para determinar se um endereço faz ou não parte da rede e o endereço de rede define o valor esperado daqueles bits.

Quanto aos endereços, é fornecida uma função de fábrica que determina automaticamente a versão correta do IP:

@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

Os objetos de rede não podem ter nenhum bit de host definido. O efeito prático disso é que @code{192.0.2.1/24} não descreve uma rede. Tais definições são chamadas de objetos interface, uma vez que a notação “ip-em-uma-rede” é comumente usada para descrever interfaces de rede de um computador em uma determinada rede e é descrita mais detalhadamente na próxima seção.

Por padrão, tentar criar um objeto rede com bits de host definidos resultará na exceção @ref{202,,ValueError} ser levantada. Para solicitar que os bits adicionais sejam forçados a zero, o sinalizador @code{strict=False} pode ser passada para o construtor:

@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

Embora o formato string ofereça significativamente mais flexibilidade, as redes também podem ser definidas com números inteiros, assim como os endereços de host. Neste caso, considera-se que a rede contém apenas o endereço único identificado pelo número inteiro, portanto o prefixo da rede inclui todo o endereço da rede:

@example
>>> ipaddress.ip_network(3221225984)
IPv4Network('192.0.2.0/32')
>>> ipaddress.ip_network(42540766411282592856903984951653826560)
IPv6Network('2001:db8::/128')
@end example

Tal como acontece com os endereços, a criação de um tipo específico de rede pode ser forçada chamando diretamente o construtor da classe em vez de usar a função de fábrica.

@node Interfaces do host,,Definindo redes,Criando objetos de Endereço/Rede/Interface
@anchor{howto/ipaddress host-interfaces}@anchor{5467}
@subsubsection Interfaces do host


Conforme mencionado acima, se você precisar descrever um endereço em uma rede específica, nem o endereço nem as classes de rede serão suficientes. Notação como @code{192.0.2.1/24} é comumente usada por engenheiros de rede e pessoas que escrevem ferramentas para firewalls e roteadores como uma abreviação para “o host @code{192.0.2.1} na rede @code{192.0.2.0/24}”, Consequentemente, @ref{80,,ipaddress} fornece um conjunto de classes híbridas que associam um endereço a uma rede específica. A interface para criação é idêntica àquela para definição de objetos de rede, exceto que a parte do endereço não está restrita a ser um endereço de rede.

@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

Entradas de inteiros são aceitas (como acontece com redes), e o uso de uma versão IP específica pode ser forçado chamando diretamente o construtor relevante.

@node Inspecionando objetos endereço/rede/interface,Redes como listas de Addresses,Criando objetos de Endereço/Rede/Interface,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress inspecting-address-network-interface-objects}@anchor{5468}
@subsection Inspecionando objetos endereço/rede/interface


Você se deu ao trabalho de criar um objeto IPv(4|6)(Address|Network|Interface) e provavelmente deseja obter informações sobre ele. @ref{80,,ipaddress} tenta tornar isso fácil e intuitivo.

Extraindo a versão do 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

Obtendo a rede de uma interface:

@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

Descobrindo quantos endereços individuais estão em uma rede:

@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 através dos endereços “utilizáveis” em uma rede:

@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

Obtendo a máscara de rede (ou seja, definir bits correspondentes ao prefixo da rede) ou a máscara de host (qualquer bit que não faça parte da máscara de rede):

@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

Explodindo ou compactando o endereço:

@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

Embora o IPv4 não tenha suporte a explosão ou compactação, os objetos associados ainda fornecem as propriedades relevantes para que o código de versão neutra possa facilmente garantir que o formato mais conciso ou mais detalhado seja usado para endereços IPv6, ao mesmo tempo que manipula corretamente os endereços IPv4.

@node Redes como listas de Addresses,Comparações<4>,Inspecionando objetos endereço/rede/interface,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress networks-as-lists-of-addresses}@anchor{5469}
@subsection Redes como listas de Addresses


Às vezes é útil tratar redes como listas. Isso significa que é possível indexá-las assim:

@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

Isso também significa que os objetos de rede se prestam ao uso da sintaxe de teste de pertinência de lista como esta:

@example
if endereço in rede:
    # faz algo
@end example

O teste de contenção é feito de forma eficiente com base no prefixo de rede:

@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 Comparações<4>,Usando endereços IP com outros módulos,Redes como listas de Addresses,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress comparisons}@anchor{546a}
@subsection Comparações


@ref{80,,ipaddress} fornece algumas maneiras simples e, esperançosamente, intuitivas de comparar objetos, onde faz sentido:

@example
>>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
True
@end example

Uma exceção @ref{2c3,,TypeError} é levantada se você tentar comparar objetos de versões ou tipos diferentes.

@node Usando endereços IP com outros módulos,Obtendo mais detalhes quando a criação da instância falha,Comparações<4>,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress using-ip-addresses-with-other-modules}@anchor{546b}
@subsection Usando endereços IP com outros módulos


Outros módulos que usam endereços IP (como @ref{cc,,socket}) geralmente não aceitam objetos deste módulo diretamente. Em vez disso, eles devem ser convertidos para um inteiro ou string que o outro módulo aceitará:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> str(addr4)
'192.0.2.1'
>>> int(addr4)
3221225985
@end example

@node Obtendo mais detalhes quando a criação da instância falha,,Usando endereços IP com outros módulos,Uma introdução ao módulo ipaddress
@anchor{howto/ipaddress getting-more-detail-when-instance-creation-fails}@anchor{546c}
@subsection Obtendo mais detalhes quando a criação da instância falha


Ao criar objetos de endereço/rede/interface usando as funções de fábrica agnósticas de versão, quaisquer erros serão relatados como @ref{202,,ValueError} com uma mensagem de erro genérica que simplesmente diz que o valor passado não foi reconhecido como um objeto daquele tipo. A falta de um erro específico é porque é necessário saber se o valor `supõe' ser IPv4 ou IPv6 para fornecer mais detalhes sobre o motivo de sua rejeição.

Para dar suporte a casos de uso em que é útil ter acesso a esse detalhe adicional, os construtores de classe individuais na verdade geram as subclasses @ref{202,,ValueError} @ref{3e86,,ipaddress.AddressValueError} e @ref{3ea7,,ipaddress.NetmaskValueError} para indicar exatamente qual parte da definição falhou ao ser analisada corretamente.

As mensagens de erro são significativamente mais detalhadas ao usar os construtores de classe diretamente. Por exemplo:

@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

Entretanto, ambas as exceções específicas do módulo têm @ref{202,,ValueError} como classe pai, então se você não estiver preocupado com o tipo específico de erro, você ainda pode escrever código como o seguinte:

@example
try:
    network = ipaddress.IPv4Network(address)
except ValueError:
    print('endereço/máscara de rede é inválida para IPv4:', address)
@end example

@node Instrumentando o CPython com DTrace e SystemTap,Suporte do Python ao perfilador perf do Linux,Uma introdução ao módulo ipaddress,Python HOWTOs
@anchor{howto/instrumentation doc}@anchor{546d}@anchor{howto/instrumentation instrumentation}@anchor{c87}@anchor{howto/instrumentation instrumenting-cpython-with-dtrace-and-systemtap}@anchor{546e}@anchor{howto/instrumentation translation-repo}@anchor{546f}
@section Instrumentando o CPython com DTrace e SystemTap


@*autor: 
David Malcolm


@*autor: 
Łukasz Langa


DTrace e SystemTap são ferramentas de monitoramento, cada uma fornecendo uma maneira de inspecionar o que os processos em um sistema de computador estão fazendo. Ambas usam linguagens específicas de domínio, permitindo que um usuário escreva scripts que:


@itemize -

@item 
filtrar quais processos devem ser observados

@item 
coletem dados dos processos de interesse

@item 
gerem relatórios sobre os dados
@end itemize

A partir do Python 3.6, o CPython pode ser criado com “marcadores” incorporados, também conhecidos como “sondas” (`probes'), que podem ser observados por um script DTrace ou SystemTap, facilitando o monitoramento do que os processos CPython em um sistema estão fazendo.

Os marcadores DTrace são detalhes de implementação do interpretador CPython. Não há garantias sobre a compatibilidade de sondas entre versões do CPython. Os scripts DTrace podem parar de funcionar ou funcionar incorretamente sem aviso ao alterar as versões do CPython.

@menu
* Habilitando os marcadores estáticos:: 
* Sondas estáticas do DTtrace:: 
* Marcadores estáticos do SystemTap:: 
* Marcadores estáticos disponíveis:: 
* Tapsets de SystemTap:: 
* Exemplos: Exemplos<39>. 

@end menu

@node Habilitando os marcadores estáticos,Sondas estáticas do DTtrace,,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation enabling-the-static-markers}@anchor{5470}
@subsection Habilitando os marcadores estáticos


O macOS vem com suporte embutido para DTrace. No Linux, para construir o CPython com os marcadores incorporados para SystemTap, as ferramentas de desenvolvimento SystemTap devem ser instaladas.

Em uma máquina Linux, isso pode ser feito via:

@example
$ yum install systemtap-sdt-devel
@end example

ou:

@example
$ sudo apt-get install systemtap-sdt-dev
@end example

O CPython deve então ser @ref{1f3d,,configurado com a opção --with-dtrace}:

@example
checking for --with-dtrace... yes
@end example

No macOS, você pode listar as sondas DTrace disponíveis executando um processo Python em segundo plano e listando todas as sondas disponibilizadas pelo provedor 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

No Linux, você pode verificar se os marcadores estáticos do SystemTap estão presentes no binário compilado, observando se ele contém uma seção “.note.stapsdt”.

@example
$ readelf -S ./python | grep .note.stapsdt
[30] .note.stapsdt        NOTE         0000000000000000 00308d78
@end example

Se você construiu o Python como uma biblioteca compartilhada (com a opção de configuração @ref{866,,--enable-shared}), você precisa procurar dentro da biblioteca compartilhada. Por exemplo:

@example
$ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
[29] .note.stapsdt        NOTE         0000000000000000 00365b68
@end example

Um readelf moderno o suficiente pode exibir os metadados:

@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

Os metadados acima contêm informações sobre o SystemTap descrevendo como ele pode corrigir instruções de código de máquina estrategicamente posicionadas para habilitar os ganchos de rastreamento usados por um script do SystemTap.

@node Sondas estáticas do DTtrace,Marcadores estáticos do SystemTap,Habilitando os marcadores estáticos,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation static-dtrace-probes}@anchor{5471}
@subsection Sondas estáticas do DTtrace


O script DTrace de exemplo a seguir pode ser usado para mostrar a hierarquia de chamada/retorno de um script Python, rastreando apenas dentro da invocação de uma função chamada “start”. Em outras palavras, invocações de função em tempo de importação não serão listadas:

@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

Pode ser invocado assim:

@example
$ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"
@end example

O resultado deve ser algo assim:

@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 do SystemTap,Marcadores estáticos disponíveis,Sondas estáticas do DTtrace,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation static-systemtap-markers}@anchor{5472}
@subsection Marcadores estáticos do SystemTap


A maneira de baixo nível de usar a integração do SystemTap é usar os marcadores estáticos diretamente. Isso requer que você declare explicitamente o arquivo binário que os contém.

Por exemplo, este script SystemTap pode ser usado para mostrar a hierarquia de chamada/retorno de um script 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

Pode ser invocado assim:

@example
$ stap \
  show-call-hierarchy.stp \
  -c "./python test.py"
@end example

O resultado deve ser algo assim:

@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

sendo as colunas:


@itemize -

@item 
tempo em microssegundos desde o início do script

@item 
nome do executável

@item 
PID do processo
@end itemize

e o restante indica a hierarquia de chamada/retorno conforme o script é executado.

Para uma construção com @ref{866,,--enable-shared} do CPython, os marcadores estão contidos na biblioteca compartilhada libpython, e o caminho pontilhado da sonda precisa refletir isso. Por exemplo, esta linha do exemplo acima:

@example
probe process("python").mark("function__entry") @{
@end example

deve ler-se em vez disso:

@example
probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") @{
@end example

(presumindo uma @ref{1f9,,construção de depuração} do CPython 3.6)

@node Marcadores estáticos disponíveis,Tapsets de SystemTap,Marcadores estáticos do SystemTap,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation available-static-markers}@anchor{5473}@anchor{howto/instrumentation static-markers}@anchor{bd0}
@subsection Marcadores estáticos disponíveis



@deffn {Object} function__entry(str filename, str funcname, int lineno)

Este marcador indica que a execução de uma função Python começou. Ele é acionado somente para funções Python puro (bytecode).

O nome do arquivo, o nome da função e o número da linha são fornecidos de volta ao script de rastreamento como argumentos posicionais, que devem ser acessados usando @code{$arg1}, @code{$arg2}, @code{$arg3}:

@quotation


@itemize *

@item 
@code{$arg1} : nome de arquivo como @code{(const char *)}, acessível usando @code{user_string($arg1)}

@item 
@code{$arg2} : nome da função como @code{(const char *)}, acessível usando @code{user_string($arg2)}

@item 
@code{$arg3} : número da linha como @code{int}
@end itemize
@end quotation
@end deffn


@deffn {Object} function__return(str filename, str funcname, int lineno)

Este marcador é o inverso de @code{function__entry()}, e indica que a execução de uma função Python terminou (seja via @code{return}, ou via uma exceção). Ele é acionado somente para funções Python puro (bytecode).

Os argumentos são os mesmos de @code{function__entry()}
@end deffn


@deffn {Object} line(str filename, str funcname, int lineno)

Este marcador indica que uma linha Python está prestes a ser executada. É o equivalente ao rastreamento linha por linha com um perfilador Python. Ele não é acionado dentro de funções C.

Os argumentos são os mesmos de @code{function__entry()}.
@end deffn


@deffn {Object} gc__start(int generation)

Dispara quando o interpretador Python inicia um ciclo de coleta de lixo. @code{arg0} é a geração a ser percurrida, como @ref{a43,,gc.collect()}.
@end deffn


@deffn {Object} gc__done(long collected)

Dispara quando o interpretador Python termina um ciclo de coleta de lixo. @code{arg0} é o número de objetos coletados.
@end deffn


@deffn {Object} import__find__load__start(str modulename)

Dispara antes de @ref{77,,importlib} tentar encontrar e carregar o módulo. @code{arg0} é o nome do módulo.


Adicionado na versão 3.7.

@end deffn


@deffn {Object} import__find__load__done(str modulename, int found)

Dispara após a função find_and_load do @ref{77,,importlib} ser chamada. @code{arg0} é o nome do módulo, @code{arg1} indica se o módulo foi carregado com sucesso.


Adicionado na versão 3.7.

@end deffn


@deffn {Object} audit(str event, void *tuple)

Dispara quando @ref{16a0,,sys.audit()} ou @ref{36f,,PySys_Audit()} é chamada. @code{arg0} é o nome do evento como string C, @code{arg1} é um ponteiro @ref{339,,PyObject} para um objeto tupla.


Adicionado na versão 3.8.

@end deffn

@node Tapsets de SystemTap,Exemplos<39>,Marcadores estáticos disponíveis,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation systemtap-tapsets}@anchor{5474}
@subsection Tapsets de SystemTap


A maneira mais avançada de usar a integração do SystemTap é usar um “tapset”: o equivalente do SystemTap a uma biblioteca, que oculta alguns dos detalhes de nível inferior dos marcadores estáticos.

Aqui está um arquivo tapset, baseado em uma construção não compartilhada do CPython:

@example
/*
   Fornece um envólucro de mais alto nível em volta dos marcadores
   function__entry e function__return:
 \*/
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

Se este arquivo for instalado no diretório de tapsets do SystemTap (por exemplo, @code{/usr/share/systemtap/tapset}), estes pontos de sondagem adicionais ficarão disponíveis:


@deffn {Object} python.function.entry(str filename, str funcname, int lineno, frameptr)

Este ponto de sondagem indica que a execução de uma função Python começou. Ele é acionado somente para funções Python puro (bytecode).
@end deffn


@deffn {Object} python.function.return(str filename, str funcname, int lineno, frameptr)

Este ponto de sondagem é o inverso de @code{python.function.return}, e indica que a execução de uma função Python terminou (seja via @code{return}, ou via uma exceção). Ele é acionado somente para funções Python puro (bytecode).
@end deffn

@node Exemplos<39>,,Tapsets de SystemTap,Instrumentando o CPython com DTrace e SystemTap
@anchor{howto/instrumentation examples}@anchor{5475}
@subsection Exemplos


Este script SystemTap usa o tapset acima para implementar de forma mais limpa o exemplo dado acima de rastreamento da hierarquia de chamada de função Python, sem precisar na diretamente

@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

O script a seguir usa o tapset acima para fornecer uma visão geral de todo o código CPython em execução, mostrando os 20 quadros de bytecode mais frequentemente inseridos, a cada segundo, em todo o sistema:

@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 Suporte do Python ao perfilador perf do Linux,Boas práticas para anotações,Instrumentando o CPython com DTrace e SystemTap,Python HOWTOs
@anchor{howto/perf_profiling doc}@anchor{1831}@anchor{howto/perf_profiling perf-profiling}@anchor{18f}@anchor{howto/perf_profiling python-support-for-the-linux-perf-profiler}@anchor{5476}@anchor{howto/perf_profiling translation-repo}@anchor{5477}
@section Suporte do Python ao perfilador @code{perf} do Linux


@*autor: 
Pablo Galindo


O perfilador perf do Linux@footnote{https://perf.wiki.kernel.org} é uma ferramenta muito poderosa que permite criar perfis e obter informações sobre o desempenho da sua aplicação. @code{perf} também possui um ecossistema muito vibrante de ferramentas que auxiliam na análise dos dados que produz.

O principal problema de usar o perfilador @code{perf} com aplicações Python é que @code{perf} apenas obtém informações sobre símbolos nativos, ou seja, os nomes de funções e procedimentos escritos em C. Isso significa que os nomes de funções Python e seus nomes de arquivos em seu código não aparecerão na saída de @code{perf}.

Desde o Python 3.12, o interpretador pode ser executado em um modo especial que permite que funções do Python apareçam na saída do criador de perfilador @code{perf}. Quando este modo está habilitado, o interpretador interporá um pequeno pedaço de código compilado instantaneamente antes da execução de cada função Python e ensinará @code{perf} a relação entre este pedaço de código e a função Python associada usando @ref{4efb,,arquivos de mapa perf}.

@cartouche
@quotation Nota 
O suporte para o perfilador @code{perf} está atualmente disponível apenas para Linux em arquiteturas selecionadas. Verifique a saída da etapa de construção @code{configure} ou verifique a saída de @code{python -m sysconfig | grep HAVE_PERF_TRAMPOLINE} para ver se o seu sistema é compatível.
@end quotation
@end cartouche

Por exemplo, considere o seguinte 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 executar @code{perf} para obter amostras de rastreamentos de pilha da CPU em 9999 hertz:

@example
$ perf record -F 9999 -g -o perf.data python meu_script.py
@end example

Então podemos usar @code{perf report} para analisar os dados:

@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

Como você pode ver, as funções Python não são mostradas na saída, apenas @code{_PyEval_EvalFrameDefault} (a função que avalia o bytecode Python) aparece. Infelizmente isso não é muito útil porque todas as funções Python usam a mesma função C para avaliar bytecode, portanto não podemos saber qual função Python corresponde a qual função de avaliação de bytecode.

Em vez disso, se executarmos o mesmo experimento com o suporte @code{perf} ativado, obteremos:

@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
* Como habilitar o suporte a perfilação com perf:: 
* Como obter os melhores resultados:: 
* Como trabalhar sem ponteiros de quadro:: 

@end menu

@node Como habilitar o suporte a perfilação com perf,Como obter os melhores resultados,,Suporte do Python ao perfilador perf do Linux
@anchor{howto/perf_profiling how-to-enable-perf-profiling-support}@anchor{5478}
@subsection Como habilitar o suporte a perfilação com @code{perf}


O suporte à perfilação com @code{perf} pode ser habilitado desde o início usando a variável de ambiente 
@geindex PYTHONPERFSUPPORT
@geindex variável de ambiente; PYTHONPERFSUPPORT
@ref{46e,,PYTHONPERFSUPPORT} ou a opção @ref{176,,-X perf}, ou dinamicamente usando @ref{46f,,sys.activate_stack_trampoline()} e @ref{470,,sys.deactivate_stack_trampoline()}.

As funções @code{sys} têm precedência sobre a opção @code{-X}, a opção @code{-X} tem precedência sobre a variável de ambiente.

Exemplo usando a variável de ambiente:

@example
$ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python meu_script.py
$ perf report -g -i perf.data
@end example

Exemplo usando a opção @code{-X}:

@example
$ perf record -F 9999 -g -o perf.data python -X perf meu_script.py
$ perf report -g -i perf.data
@end example

Exemplo usando as APIs de @ref{d9,,sys} em @code{example.py}:

@example
import sys

sys.activate_stack_trampoline("perf")
do_profiled_stuff()
sys.deactivate_stack_trampoline()

non_profiled_stuff()
@end example

… então:

@example
$ perf record -F 9999 -g -o perf.data python ./example.py
$ perf report -g -i perf.data
@end example

@node Como obter os melhores resultados,Como trabalhar sem ponteiros de quadro,Como habilitar o suporte a perfilação com perf,Suporte do Python ao perfilador perf do Linux
@anchor{howto/perf_profiling how-to-obtain-the-best-results}@anchor{5479}
@subsection Como obter os melhores resultados


Para melhores resultados, Python deve ser compilado com @code{CFLAGS="-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer"}, pois isso permite que os perfiladores façam o desenrolamento de pilha (ou `stack unwinding') usando apenas o ponteiro de quadro e não no DWARF informações de depuração. Isso ocorre porque como o código interposto para permitir o suporte @code{perf} é gerado dinamicamente, ele não possui nenhuma informação de depuração DWARF disponível.

Você pode verificar se o seu sistema foi compilado com este sinalizador executando:

@example
$ python -m sysconfig | grep 'no-omit-frame-pointer'
@end example

Se você não vir nenhuma saída, significa que seu interpretador não foi compilado com ponteiros de quadro e, portanto, pode não ser capaz de mostrar funções Python na saída de @code{perf}.

@node Como trabalhar sem ponteiros de quadro,,Como obter os melhores resultados,Suporte do Python ao perfilador perf do Linux
@anchor{howto/perf_profiling how-to-work-without-frame-pointers}@anchor{547a}
@subsection Como trabalhar sem ponteiros de quadro


Se você estiver trabalhando com um interpretador Python que foi compilado sem ponteiros de quadro, você ainda pode usar o perfilador @code{perf}, mas a sobrecarga será um pouco maior porque o Python precisa gerar informações de desenrolamento para cada chamada de função Python em tempo real. Além disso, @code{perf} levará mais tempo para processar os dados porque precisará usar as informações de depuração DWARF para desenrolar a pilha e este é um processo lento.

Para habilitar esse modo, você pode usar a variável de ambiente 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex variável de ambiente; PYTHON_PERF_JIT_SUPPORT
@ref{190,,PYTHON_PERF_JIT_SUPPORT} ou a opção @ref{176,,-X perf_jit}, que habilitará o modo JIT para o perfilador @code{perf}.

@cartouche
@quotation Nota 
Devido a um bug na ferramenta @code{perf}, apenas versões @code{perf} superiores à v6.8 funcionarão com o modo JIT. A correção também foi portada para a versão v6.7.2 da ferramenta.

Note que ao verificar a versão da ferramenta @code{perf} (o que pode ser feito executando @code{perf version}) você deve levar em conta que algumas distros adicionam alguns números de versão personalizados, incluindo um caractere @code{-}. Isso significa que @code{perf 6.7-3} não é necessariamente @code{perf 6.7.3}.
@end quotation
@end cartouche

Ao usar o modo JIT do perf, você precisa de uma etapa extra antes de poder executar @code{perf report}. Você precisa chamar o comando @code{perf inject} para injetar as informações JIT no arquivo @code{perf.data}.:

@example
$ perf record -F 9999 -g -k 1 --call-graph dwarf -o perf.data python -Xperf_jit meu_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

ou usando a variável de ambiente:

@example
$ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python meu_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

O comando @code{perf inject --jit} lerá @code{perf.data}, pegará automaticamente o arquivo de dump perf que o Python cria (em @code{/tmp/perf-$PID.dump}) e, em seguida, criará @code{perf.jit.data} que mescla todas as informações JIT. Ele também deve criar muitos arquivos @code{jitted-XXXX-N.so} no diretório atual, que são imagens ELF para todos os trampolins JIT que foram criados pelo Python.

@cartouche
@quotation Aviso 
Ao usar @code{--call-graph dwarf}, a ferramenta @code{perf} fará snapshots da pilha do processo que está sendo perfilado e salvará as informações no arquivo @code{perf.data}. Por padrão, o tamanho do dump da pilha é de 8192 bytes, mas você pode alterar o tamanho passando-o após uma vírgula, como @code{--call-graph dwarf,16384}.

O tamanho do dump da pilha é importante porque, se for muito pequeno, o @code{perf} não conseguirá desfazer o descompasso da pilha e a saída será incompleta. Por outro lado, se for muito grande, o @code{perf} não conseguirá amostrar o processo com a frequência desejada, pois a sobrecarga será maior.

O tamanho da pilha é particularmente importante ao criar perfis de código Python compilado com níveis de otimização baixos (como @code{-O0}), pois essas construções tendem a ter quadros de pilha maiores. Se você estiver compilando Python com @code{-O0} e não estiver vendo funções Python na saída do perfil, tente aumentar o tamanho do despejo de pilha para 65528 bytes (o máximo):

@example
$ perf record -F 9999 -g -k 1 --call-graph dwarf,65528 -o perf.data python -Xperf_jit meu_script.py
@end example

Diferentes sinalizadores de compilação podem impactar significativamente os tamanhos de pilha:


@itemize -

@item 
Construções com @code{-O0} geralmente têm quadros de pilha muito maiores do que aquelas com @code{-O1} ou superior

@item 
Adiciona otimizações (@code{-O1}, @code{-O2}, etc.) normalmente reduz o tamanho da pilha

@item 
Os ponteiros de quadro (@code{-fno-omit-frame-pointer}) geralmente fornecem um desenrolamento de pilha mais confiável
@end itemize
@end quotation
@end cartouche

@node Boas práticas para anotações,Isolando módulos de extensão,Suporte do Python ao perfilador perf do Linux,Python HOWTOs
@anchor{howto/annotations doc}@anchor{547b}@anchor{howto/annotations annotations-best-practices}@anchor{547c}@anchor{howto/annotations annotations-howto}@anchor{7da}@anchor{howto/annotations translation-repo}@anchor{547d}
@section Boas práticas para anotações


@*autor: 
Larry Hastings


@subsubheading Resumo



Este documento foi projetado para encapsular as melhores práticas para trabalhar com anotações. Se você escrever um código Python que examina @code{__annotations__} nos objetos Python, nós o encorajamos a seguir as diretrizes descritas abaixo.

Este documento está dividido em quatro seções: melhores práticas para acessar as anotações de um objeto no Python  na versão 3.10 e versões mais recente, melhores práticas para acessar as anotações de um objeto no Python na versão 3.9 e versões mais antiga, outras melhores práticas para @code{__annotations__} para qualquer versão do Python e peculiaridades do @code{__annotations__}.

Note que este documento é específico sobre trabalhar com @code{__annotations__}, não para o uso `de' anotações. Se você está procurando por informações sobre como usar “type hints” no seu código, por favor veja o módulo @ref{104,,typing}

@menu
* Acessando o dicionário de anotações de um objeto no Python 3.10 e nas versões mais recentes: Acessando o dicionário de anotações de um objeto no Python 3 10 e nas versões mais recentes. 
* Acessando o dicionário de anotações de um objeto no Python 3.9 e nas versões mais antigas: Acessando o dicionário de anotações de um objeto no Python 3 9 e nas versões mais antigas. 
* Recuperando manualmente anotações transformadas em strings:: 
* Melhores práticas para __annotations__ em qualquer versão Python:: 
* Peculiaridades de __annotations__:: 

@end menu

@node Acessando o dicionário de anotações de um objeto no Python 3 10 e nas versões mais recentes,Acessando o dicionário de anotações de um objeto no Python 3 9 e nas versões mais antigas,,Boas práticas para anotações
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-10-and-newer}@anchor{547e}
@subsection Acessando o dicionário de anotações de um objeto no Python 3.10 e nas versões mais recentes


O Python 3.10 adicionou uma nova função para a biblioteca padrão: @ref{816,,inspect.get_annotations()}. No Python 3.10 e nas versões mais recentes, chamar esta função é a melhor prática para acessar o dicionário de anotações de qualquer objeto com suporte a anotações. Esta função pode até “destextualizar” anotações textualizadas para você.

Se por alguma razão @ref{816,,inspect.get_annotations()} não for viável para o seu caso de uso, você pode acessar o membro de dados @code{__annotations__} manualmente. As melhores práticas para isto também mudaram no Python 3.10: a partir do Python 3.10, @code{o.__annotations__} é garantido `sempre' funcionar em funções, classes e módulos Python. Se você tem certeza que o objeto que você está examinando é um desses três `exatos' objetos, pode simplesmente usar @code{o.__annotations__} para chegar no dicionário de anotações do objeto.

Contudo, outros tipos de chamáveis – por exemplo, chamáveis criados por @ref{414,,functools.partial()} – podem não ter um atributo @code{__annotations__} definido. Ao acessar o @code{__annotations__} de um objeto possivelmente desconhecido, as melhores práticas nas versões de Python 3.10 e mais novas é chamar @ref{bea,,getattr()} com três argumentos, por exemplo @code{getattr(o, '__annotations__', None)}.

Antes de Python 3.10, acessar @code{__annotations__} numa classe que não define anotações mas que possui uma classe base com anotações retorna o @code{__annotations__} da classe pai. A partir do Python 3.10, a anotação da classe filha será um dicionário vazio.

@node Acessando o dicionário de anotações de um objeto no Python 3 9 e nas versões mais antigas,Recuperando manualmente anotações transformadas em strings,Acessando o dicionário de anotações de um objeto no Python 3 10 e nas versões mais recentes,Boas práticas para anotações
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-9-and-older}@anchor{547f}
@subsection Acessando o dicionário de anotações de um objeto no Python 3.9 e nas versões mais antigas


Em Python 3.9 e versões mais antigas, acessar o dicionário de anotações de um objeto é muito mais complicado que em versões mais novas. O problema é uma falha de design em versões mais antigas do Python, especificamente a respeito de anotações de classe.

As melhores práticas para acessar os dicionários de anotações de outros objetos, funções, outros chamáveis e módulos - são as mesmas melhores práticas para 3.10, supondo que você não esteja chamando @ref{816,,inspect.get_annotations()}: você deve usar a função @ref{bea,,getattr()} com três argumentos para acessar os atributos do objeto @code{__annotations__}.

Infelizmente, essas não são as melhores práticas para classes. O problema é que, como @code{__annotations__} é opcional nas classes, e posto que classes podem herdar atributos das suas classes base, acessar o atributo @code{__annotations__} de uma classe pode inesperadamente retornar o dicionário de anotações de uma `classe base.'  Por exemplo:

@example
class Base:
    a: int = 3
    b: str = 'abc'

class Derived(Base):
    pass

print(Derived.__annotations__)
@end example

Isso mostrará o dicionário de anotações de @code{Base}, não de @code{Derived}.

Seu código terá que ter um caminho de código separado se o objeto que você está examinando for uma classe (@code{isinstance(o, type)}). Nesse caso, a melhor prática depende de um detalhe de implementação do Python 3.9 e anteriores: se uma classe tiver anotações definidas, elas serão armazenadas no dicionário @ref{c78,,__dict__} da classe. Como a classe pode ou não ter anotações definidas, a melhor prática é chamar o método @ref{1dd2,,get()} no dict da classe.

Considerando tudo isso, aqui está um exemplo de código que acessa de forma segura o atributo @code{__annotations__} em um objeto arbitrário em Python 3.9 e anteriores:

@example
if isinstance(o, type):
    ann = o.__dict__.get('__annotations__', None)
else:
    ann = getattr(o, '__annotations__', None)
@end example

Após executar este código, @code{ann} deve ser um dicionário ou @code{None}. Você é encorajado a fazer uma checagem dupla do tipo de @code{ann} utilizando @ref{442,,isinstance()} antes de uma análise mais aprofundada.

Observe que alguns objetos de tipos exóticos ou malformados podem não ter atributo um @ref{c78,,__dict__}, portanto, para maior segurança, talvez você também queira usar @ref{bea,,getattr()} para acessar @code{__dict__}.

@node Recuperando manualmente anotações transformadas em strings,Melhores práticas para __annotations__ em qualquer versão Python,Acessando o dicionário de anotações de um objeto no Python 3 9 e nas versões mais antigas,Boas práticas para anotações
@anchor{howto/annotations manually-un-stringizing-stringized-annotations}@anchor{5480}
@subsection Recuperando manualmente anotações transformadas em strings


Em situações em que as anotações podem ter sido transformadas em strings, e caso queira avaliar essas strings para produzir os valores de Python que elas representam, é melhor chamar @ref{816,,inspect.get_annotations()} para fazer isto por você.

Se estiver usando Python 3.9 ou anterior, ou por algum motivo não puder usar @ref{816,,inspect.get_annotations()}, será necessário replicar sua lógica. Considere examinar a implementação de @ref{816,,inspect.get_annotations()} na versão de Python atual e seguir uma abordagem similar.

Resumindo, caso deseje avaliar uma anotação transformada em string em um objeto arbitrário @code{o}:


@itemize *

@item 
Se @code{o} for um módulo, use @code{o.__dict__} como @code{globals} ao chamar @ref{180,,eval()}.

@item 
Se @code{o} for uma classe, use @code{sys.modules[o.__module__].__dict__} como @code{globals}, e @code{dict(vars(o))} como @code{locals}, quando chamar @ref{180,,eval()}.

@item 
Se @code{o} for um chamável envolto em um invólucro usando @ref{1058,,functools.update_wrapper()}, @ref{f91,,functools.wraps()} ou @ref{414,,functools.partial()}, desenvolva-o iterativamente acessando @code{o.__wrapped__} ou @code{o.func} conforme apropriado, até encontrar a função raiz.

@item 
Caso @code{o} seja chamável (mas não uma classe), use @ref{1316,,o.__globals__} como globals quando chamar @ref{180,,eval()}.
@end itemize

Contudo, nem todas strings usadas como anotações podem ser convertidas em valores de Python utilizando @ref{180,,eval()}. Valores de string poderiam teoricamente conter qualquer string válida, e na prática existem casos válidos para dicas de tipo que requerem anotar com valores de strings que `não' podem ser executados. Por exemplo:


@itemize *

@item 
Tipos de união 
@geindex Propostas de Melhorias do Python; PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} usando @code{|}, antes do suporte a isso ser adicionado em Python 3.10.

@item 
Definições que não são necessárias no ambiente de execução, apenas importadas quando @ref{d15,,typing.TYPE_CHECKING} é verdadeiro.
@end itemize

Caso @ref{180,,eval()} tente executar tais valores, levantará uma exceção. Então, quando projetar uma biblioteca API que trabalha com anotações, é recomendado que tente executar os valores das strings apenas quando for solicitado explicitamente.

@node Melhores práticas para __annotations__ em qualquer versão Python,Peculiaridades de __annotations__,Recuperando manualmente anotações transformadas em strings,Boas práticas para anotações
@anchor{howto/annotations best-practices-for-annotations-in-any-python-version}@anchor{5481}
@subsection Melhores práticas para @code{__annotations__} em qualquer versão Python



@itemize *

@item 
Evite atribuir diretamente ao membro @code{__annotations__} dos objetos. Deixe que Python gerenciar a configuração de @code{__annotations__}.

@item 
Se você atribuir diretamente ao membro @code{__annotations__} do objeto, sempre o defina como um objeto @code{dict}.

@item 
Caso acesse diretamente o membro @code{__annotations__} de um objeto, certifique-se de que ele é um dicionário antes de tentar examinar seu conteúdo.

@item 
Evite modificar o dicionário @code{__annotations__}.

@item 
Evite deletar o atributo @code{__annotations__} de um objeto.
@end itemize

@node Peculiaridades de __annotations__,,Melhores práticas para __annotations__ em qualquer versão Python,Boas práticas para anotações
@anchor{howto/annotations annotations-quirks}@anchor{5482}
@subsection Peculiaridades de @code{__annotations__}


Em todas as versões de Python 3, objetos de função criam preguiçosamente um dicionário de anotações caso nenhuma anotação seja definida nesse objeto. Você pode deletar o atributo @code{__annotations__} utilizando @code{del fn.__annotations__}, mas ao acessar @code{fn.__annotations__} o objeto criará um novo dicionário vazio que será armazenado e retornado como suas anotações.
Apagar as anotações de uma função antes que ela tenha criado preguiçosamente seu dicionário de anotações irá produzir um @code{AttributeError}; ao utilizar @code{del fn.__annotations__} duas vezes em sequência, é garantido que será produzido um @code{AttributeError}.

O citado no parágrafo acima também se aplica para classes e objetos de módulo em Python 3.10 e posteriores.

Em todas as versões de Python 3, você pode definir @code{__annotations__} como @code{None} em um objeto de função. Contudo, acessar em sequência as anotações nesse objeto utilizando @code{fn.__annotations__} irá criar preguiçosamente um dicionário vazio como descrito no primeiro parágrafo dessa seção. Isso `não' é válido para módulos e classes, em qualquer versão de Python; esses objetos permitem atribuir @code{__annotations__} a qualquer valor de Python, e armazenam qualquer valor atribuído.

Se Python transformar sua anotação em string (utilizando @code{from __future__ import annotations}), e você especificar uma string como anotação, essa string será posta entre aspas. Na prática a anotação receberá aspas `duplas'. Por exemplo:

@example
from __future__ import annotations
def foo(a: "str"): pass

print(foo.__annotations__)
@end example

Isso exibe @code{@{'a': "'str'"@}}. Não considere isso como uma “peculiaridade”; foi mencionado aqui simplesmente porque pode ser surpreendente.

@node Isolando módulos de extensão,Descritor de arquivo de temporizador,Boas práticas para anotações,Python HOWTOs
@anchor{howto/isolating-extensions doc}@anchor{5483}@anchor{howto/isolating-extensions isolating-extension-modules}@anchor{5484}@anchor{howto/isolating-extensions isolating-extensions-howto}@anchor{4b4d}@anchor{howto/isolating-extensions translation-repo}@anchor{5485}
@section Isolando módulos de extensão


@subsubheading Resumo



Tradicionalmente, o estado que pertence a módulos de extensão do Python era mantido em variáveis @code{static} em C, que têm escopo em todo o processo. Este documento descreve problemas de tal estado por processo e apresenta um modo mais seguro: o estado por módulo.

O documento também descreve como migrar para o uso do estado por módulo onde for possível. Essa transição envolve alocar espaço para este estado, potencialmente trocar tipos estáticos por tipos no heap, e—talvez o mais importante—acessar o estado por módulo a partir do código.

@menu
* Quem deveria ler isto:: 
* Contexto: Contexto<2>. 
* Fazendo módulos seguros com múltiplos interpretadores:: 
* Tipos no heap: Tipos no heap<2>. 
* Problemas em aberto:: 

@end menu

@node Quem deveria ler isto,Contexto<2>,,Isolando módulos de extensão
@anchor{howto/isolating-extensions who-should-read-this}@anchor{5486}
@subsection Quem deveria ler isto


Este guia é escrito para mantenedores de extensões que usam a @ref{1d57,,API C} que desejam torná-las mais seguras para o uso em aplicações onde o Python em si é usado como uma biblioteca.

@node Contexto<2>,Fazendo módulos seguros com múltiplos interpretadores,Quem deveria ler isto,Isolando módulos de extensão
@anchor{howto/isolating-extensions background}@anchor{5487}
@subsection Contexto


Um `interpretador' é o contexto no qual o código Python é executado. Ele contém estado de configuração (por exemplo o caminho de importação) e de tempo de execução (por exemplo o conjunto de módulos importados).

O Python provê suporte para executar múltiplos interpretadores em um processo. Dois casos devem ser considerados—usuários podem executar interpretadores:


@itemize -

@item 
em sequência, com vários ciclos de @ref{4dca,,Py_InitializeEx()}/@ref{d37,,Py_FinalizeEx()}, e

@item 
em paralelo, gerenciando “sub-interpretadores” usando @ref{18b9,,Py_NewInterpreter()}/@ref{1985,,Py_EndInterpreter()}.
@end itemize

Ambos os casos (e combinações deles) são muito úteis ao embutir o Python em uma biblioteca. Bibliotecas geralmente não devem fazer suposições sobre a aplicação que as usa, o que inclui supor um “interpretador Python principal” para o processo inteiro.

Historicamente, módulos de extensão do Python não lidam bem com este caso de uso. Muitos módulos de extensão (e até alguns módulos da biblioteca padrão) usam estado global `por processo', uma vez que variáveis @code{static} do C são extremamente fáceis de se usar. Assim, dados que deveriam ser específicos para um interpretador acabam sendo compartilhados entre interpretadores. A menos que o desenvolvedor da extensão tenha cuidado, é muito fácil criar casos particulares que acabam quebrando o processo quando um módulo é carregado em mais de um interpretador no mesmo processo.

Infelizmente, não é fácil fazer o estado por interpretador. Autores de extensões tendem a não ter múltiplos interpretadores em mente ao desenvolver, e no momento é complicado testar este comportamento.

@menu
* Entra o estado por módulo:: 
* Objetos de módulo isolados:: 
* Casos particulares surpreendentes:: 

@end menu

@node Entra o estado por módulo,Objetos de módulo isolados,,Contexto<2>
@anchor{howto/isolating-extensions enter-per-module-state}@anchor{5488}
@subsubsection Entra o estado por módulo


Ao invés de focar no estado por interpretador, a API C do Python está evoluindo para melhor suportar o estado `por módulo', que é mais granular. Isso significa que dados a nível do C devem estar atrelados a um `objeto de módulo'. Cada interpretador cria o seu próprio objeto de módulo, garantindo assim a separação dos dados. Para testar o isolamento, múltiplos objetos de módulo correspondentes a uma única extensão podem até ser carregados em um único interpretador.

O estado por módulo fornece um modo fácil de pensar sobre tempos de vida e posse de recursos: o módulo de extensão será inicializado quando um objeto de módulo for criado, e limpado quando ele for liberado. Nesse sentido, um módulo funciona como qualquer outro @ref{339,,PyObject}*; não há ganchos “de desligamento do interpretador” a serem considerados—ou esquecidos.

Note que há casos de uso para diferentes tipos de “objetos globais”: estado por processo, por interpretador, por thread, ou por tarefa. Com o estado por módulo como padrão, as outras formas ainda são possíveis, mas devem ser tratadas como casos excepcionais: se você precisar delas, você deve tomar cuidados adicionais e escrever mais testes. (Note que este guia não cobre tais medidas.)

@node Objetos de módulo isolados,Casos particulares surpreendentes,Entra o estado por módulo,Contexto<2>
@anchor{howto/isolating-extensions isolated-module-objects}@anchor{5489}
@subsubsection Objetos de módulo isolados


O ponto chave de se manter em mente ao desenvolver um módulo de extensão é que vários objetos de módulo podem ser criados a partir de uma única biblioteca compartilhada. Por exemplo:

@example
>>> import sys
>>> import binascii
>>> old_binascii = binascii
>>> del sys.modules['binascii']
>>> import binascii  # cria um novo objeto do módulo
>>> old_binascii == binascii
False
@end example

Como regra geral, os dois módulos devem ser completamente independentes. Todos os objetos e o estado específicos do módulo devem ser encapsulados no objeto de módulo, não devem ser compartilhados com outros objetos de módulo, e devem ser limpados quando o objeto de módulo for desalocado. Uma vez que esta é somente uma regra geral, exceções são possíveis (veja @ref{548a,,Gerenciando estado global}), mas elas necessitam mais cuidado e atenção a casos especiais.

Enquanto alguns módulos funcionariam bem com restrições menos rigorosas, isolar os módulos torna mais fácil definir expectativas claras e diretrizes que dão certo em uma variedade de casos de uso.

@node Casos particulares surpreendentes,,Objetos de módulo isolados,Contexto<2>
@anchor{howto/isolating-extensions surprising-edge-cases}@anchor{548b}
@subsubsection Casos particulares surpreendentes


Note que módulos isolados criam alguns casos particulares que podem acabar surpreendendo. O mais notável é que, tipicamente, cada objeto de módulo não vai compartilhar as suas classes e exceções com outros módulos similares. Continuando o @ref{5489,,exemplo acima}, note @code{old_binascii.Error} e @code{binascii.Error} são objetos separados. No código a seguir, a exceção `não' é capturada:

@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

Isso é esperado. Repare que módulos Python-puro se comportam do mesmo jeito: isso é parte de como o Python funciona.

O objetivo é fazer módulos de extensão seguros no nível do C, e não fazer gambiarras se comportarem de forma intuitiva. Modificar o @code{sys.modules} “manualmente” conta como uma gambiarra.

@node Fazendo módulos seguros com múltiplos interpretadores,Tipos no heap<2>,Contexto<2>,Isolando módulos de extensão
@anchor{howto/isolating-extensions making-modules-safe-with-multiple-interpreters}@anchor{548c}
@subsection Fazendo módulos seguros com múltiplos interpretadores


@menu
* Gerenciando estado global:: 
* Gerenciando estado por módulo:: 
* Exclusão voluntária; limitando a um objeto de módulo por processo: Exclusão voluntária limitando a um objeto de módulo por processo. 
* Acesso ao estado de módulo a partir de funções:: 

@end menu

@node Gerenciando estado global,Gerenciando estado por módulo,,Fazendo módulos seguros com múltiplos interpretadores
@anchor{howto/isolating-extensions managing-global-state}@anchor{548a}
@subsubsection Gerenciando estado global


Às vezes, o estado associado a um módulo Python não é específico àquele módulo, mas ao processo inteiro (ou a alguma outra coisa “mais global” que um módulo). Por exemplo:


@itemize -

@item 
O módulo @code{readline} gerencia `o' terminal.

@item 
Um módulo executando em uma placa de circuito quer controlar `o' componente LED.
@end itemize

Nestes casos, o módulo Python deve prover `acesso' ao estado global, ao invés de `possuí-lo'. Se possível, escreva o módulo de forma que múltiplas cópias dele possam acessar o estado independentemente (junto com outras bibliotecas, sejam elas do Python ou de outras linguagens). Se isso não for possível, considere usar travas explícitas.

Se for necessário usar estado global para o processo, o jeito mais simples de evitar problemas com múltiplos interpretadores é prevenir explicitamente que o módulo seja carregado mais de uma vez por processo — veja @ref{50c2,,Exclusão voluntária; limitando a um objeto de módulo por processo}.

@node Gerenciando estado por módulo,Exclusão voluntária limitando a um objeto de módulo por processo,Gerenciando estado global,Fazendo módulos seguros com múltiplos interpretadores
@anchor{howto/isolating-extensions managing-per-module-state}@anchor{548d}
@subsubsection Gerenciando estado por módulo


Para usar estado por módulo, use @ref{4ba7,,inicialização multifásica de módulos de extensão}. Assim, você sinaliza que o seu módulo suporta múltiplos interpretadores corretamente.

Defina @code{PyModuleDef.m_size} como um número positivo `N' para requerer `N' bytes de armazenamento local para o módulo. Geralmente, `N' será o tamanho de alguma @code{struct} específica para o módulo, a qual pode guardar todo o estado a nível de C do módulo. Em particular, é nela que você deve colocar ponteiros para classes (incluindo exceções, mas excluindo tipos estáticos) e configurações (por exemplo, @ref{191c,,field_size_limit} no módulo @code{csv}) que o código C precisa para funcionar.

@cartouche
@quotation Nota 
Outra opção é guardar estado no @code{__dict__} do módulo, mas você deve evitar quebrar quando usuários modificarem o @code{__dict__} a partir do código Python. Isso geralmente significa verificar tipos e erros no nível do C, o que é fácil de ser feito incorretamente e difícil de se testar suficientemente.

Entretanto, se o estado do módulo não for necessário para o código C, guardá-lo somente no @code{__dict__} é uma boa ideia.
@end quotation
@end cartouche

Se o estado do módulo inclui ponteiros para @code{PyObject}, o objeto de módulo deve conter referências a tais objetos e implementar os ganchos a nível de módulo @code{m_traverse}, @code{m_clear} e @code{m_free}. Eles funcionam como os @code{tp_traverse}, @code{tp_clear} e @code{tp_free} de uma classe. Adicioná-los requer algum trabalho e torna o código mais longo; é o preço de módulos que podem ser descarregados de forma limpa.

Um exemplo de módulo com estado por módulo está disponível atualmente como xxlimited@footnote{https://github.com/python/cpython/blob/master/Modules/xxlimited.c}; há um exemplo de inicialização do módulo no final do arquivo.

@node Exclusão voluntária limitando a um objeto de módulo por processo,Acesso ao estado de módulo a partir de funções,Gerenciando estado por módulo,Fazendo módulos seguros com múltiplos interpretadores
@anchor{howto/isolating-extensions isolating-extensions-optout}@anchor{50c2}@anchor{howto/isolating-extensions opt-out-limiting-to-one-module-object-per-process}@anchor{548e}
@subsubsection Exclusão voluntária: limitando a um objeto de módulo por processo


Um @code{PyModuleDef.m_size} não-negativo sinaliza que um módulo admite múltiplos interpretadores corretamente. Se este ainda não é o caso para o seu módulo, you pode explicitamente torná-lo carregável somente uma vez por processo. Por exemplo:

@example
// Um sinalizador para todo o processo
static int loaded = 0;

// Mutex para fornecer segurança para a thread (só necessário para Python de threads livres)
static PyMutex modinit_mutex = @{0@};

static int
exec_module(PyObject* module)
@{
    PyMutex_Lock(&modinit_mutex);
    if (loaded) @{
        PyMutex_Unlock(&modinit_mutex);
        PyErr_SetString(PyExc_ImportError,
                        "cannot load module more than once per process");
        return -1;
    @}
    loaded = 1;
    PyMutex_Unlock(&modinit_mutex);
    // ... rest of initialization
@}
@end example

Se a função @ref{982,,PyModuleDef.m_clear} do seu módulo for capaz de se preparar para reinicializações futuras, ela deverá limpar o sinalizador @code{loaded}. Nesse caso, seu módulo não suportará múltiplas instâncias existentes `simultaneamente', mas suportará, por exemplo, o carregamento após o desligamento do tempo de execução do Python (@ref{d37,,Py_FinalizeEx()}) e a reinicialização (@ref{8b1,,Py_Initialize()}).

@node Acesso ao estado de módulo a partir de funções,,Exclusão voluntária limitando a um objeto de módulo por processo,Fazendo módulos seguros com múltiplos interpretadores
@anchor{howto/isolating-extensions module-state-access-from-functions}@anchor{548f}
@subsubsection Acesso ao estado de módulo a partir de funções


É trivial acessar o estado a partir de funções a nível do módulo. Funções recebem o objeto de módulo como o primeiro argumento; para extrair o estado, você pode 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;
    @}
    // ... o resto da lógica
@}
@end example

@cartouche
@quotation Nota 
@code{PyModule_GetState} pode retornar @code{NULL} sem definir uma exceção se não houver estado de módulo, ou seja se @code{PyModuleDef.m_size} for zero. No seu próprio módulo, você controla o @code{m_size}, de forma que isso é fácil de prevenir.
@end quotation
@end cartouche

@node Tipos no heap<2>,Problemas em aberto,Fazendo módulos seguros com múltiplos interpretadores,Isolando módulos de extensão
@anchor{howto/isolating-extensions heap-types}@anchor{5490}
@subsection Tipos no heap


Tradicionalmente, tipos definidos em C são `estáticos'; isto é, estruturas @code{static PyTypeObject} definidas diretamente em código e inicializadas usando @code{PyType_Ready()}.

Tais tipos são necessariamente compartilhados pelo processo inteiro. Compartilhá-los entre objetos de módulo requer atenção a qualquer estado que eles possuam ou acessem. Para limitar potenciais problemas, tipos estáticos são imutáveis a nível do Python: por exemplo, você não pode atribuir @code{str.meuatributo = 123}.

Não há problema em compartilhar objetos verdadeiramente imutáveis entre interpretadores, desde que através deles não seja possível acessar outros objetos mutáveis. De toda forma, no CPython, todo objeto Python tem um detalhe de implementação mutável: o contador de referências. Mudanças no refcount são protegidas pelo GIL. Logo, todo código que compartilha um objeto Python entre interpretadores depende implicitamente do atual GIL do CPython (que é global a nível de processo).

Por ser imutável e global no processo, um tipo estático não pode acessar o estado do “seu” módulo. Se um método de tal tipo precisar de acesso ao estado do módulo, o tipo precisa ser convertido para um `tipo alocado no heap', ou, abreviando, `tipo no heap'. Tipos no heap correspondem mais fielmente a classes criadas pela instrução @code{class} do Python.

Para módulos novos, usar tipos no heap por padrão é uma boa regra geral.

@menu
* Mudando tipos estáticos para tipos no heap:: 
* Definindo tipos no heap:: 
* Protocolo de recolhimento de lixo:: 
* Acessando o estado do módulo a partir de classes:: 
* Acesso ao estado do módulo a partir de métodos regulares:: 
* Acesso ao estado do módulo a partir de métodos slot@comma{} getters e setters: Acesso ao estado do módulo a partir de métodos slot getters e setters. 
* Tempo de vida do estado do módulo:: 

@end menu

@node Mudando tipos estáticos para tipos no heap,Definindo tipos no heap,,Tipos no heap<2>
@anchor{howto/isolating-extensions changing-static-types-to-heap-types}@anchor{5491}
@subsubsection Mudando tipos estáticos para tipos no heap


Tipos estáticos podem ser convertidos para tipos no heap, mas note que a API de tipos no heap não foi projetada para conversão “sem perda” de tipos estáticos—isto é, para criar um tipo que funciona exatamente como um dado tipo estático. Então, ao reescrever a definição de classe em uma nova API, é provável que você altere alguns detalhes sem querer (por exemplo, se o tipo é serializável em pickle ou não, ou slots herdados). Sempre teste os detalhes que são importantes para você.

Fique atento em particular aos dois pontos a seguir (mas note the esta não é uma lista completa):


@itemize *

@item 
Ao contrário de tipos estáticos, tipos no heap são mutáveis por padrão. Use o sinalizador @ref{3c2,,Py_TPFLAGS_IMMUTABLETYPE} para impedir a mutabilidade.

@item 
Tipos no heap herdam @ref{57f,,tp_new} por padrão, e portanto eles podem passar a ser instanciáveis a partir de código Python. Você pode impedir isso com o sinalizador @ref{582,,Py_TPFLAGS_DISALLOW_INSTANTIATION}.
@end itemize

@node Definindo tipos no heap,Protocolo de recolhimento de lixo,Mudando tipos estáticos para tipos no heap,Tipos no heap<2>
@anchor{howto/isolating-extensions defining-heap-types}@anchor{5492}
@subsubsection Definindo tipos no heap


Tipos no heap podem ser criados preenchendo uma estrutura @ref{180b,,PyType_Spec}, uma descrição ou “diagrama” de uma classe, e chamando @ref{551,,PyType_FromModuleAndSpec()} para construir um novo objeto classe.

@cartouche
@quotation Nota 
Outras funções, como @ref{57d,,PyType_FromSpec()}, também podem criar tipos no heap, mas @ref{551,,PyType_FromModuleAndSpec()} associa a classe ao módulo, permitindo acesso ao estado do módulo a partir dos métodos.
@end quotation
@end cartouche

A classe deve em geral ser guardada `tanto' no estado do módulo (para acesso seguro a partir do C) `quanto' no @code{__dict__} do módulo (para acesso a partir de código Python).

@node Protocolo de recolhimento de lixo,Acessando o estado do módulo a partir de classes,Definindo tipos no heap,Tipos no heap<2>
@anchor{howto/isolating-extensions garbage-collection-protocol}@anchor{5493}
@subsubsection Protocolo de recolhimento de lixo


Instâncias de tipos no heap contêm referências aos seus tipos. Isso garante que o tipo não é destruído antes que todas as suas instâncias sejam, mas pode resultar em ciclos de referência que precisam ser quebrados pelo coletor de lixo.

Para evitar vazamentos de memória, instâncias de tipos no heap precisam implementar o protocolo de recolhimento de lixo. Isto é, tipos no heap devem:


@itemize -

@item 
Ter o sinalizador @ref{77d,,Py_TPFLAGS_HAVE_GC}.

@item 
Definir uma função de travessia usando @code{Py_tp_traverse}, que visita o tipo (por exemplo, usando @code{Py_VISIT(Py_TYPE(self))}).
@end itemize

Por favor, veja a documentação de @ref{77d,,Py_TPFLAGS_HAVE_GC} e de @ref{77e,,tp_traverse} para considerações adicionais.

A API para definir tipos no heap cresceu organicamente, o que resultou em um status quo no qual usá-la pode ser um pouco confuso. As seções a seguir vão lhe guiar pelos problemas mais comuns.

@menu
* tp_traverse no Python 3.8 e anteriores: tp_traverse no Python 3 8 e anteriores. 
* Delegando a função tp_traverse:: 
* Definindo tp_dealloc:: 
* Evitar substituir tp_free:: 
* Evitar PyObject_New:: 

@end menu

@node tp_traverse no Python 3 8 e anteriores,Delegando a função tp_traverse,,Protocolo de recolhimento de lixo
@anchor{howto/isolating-extensions tp-traverse-in-python-3-8-and-lower}@anchor{5494}
@subsubsection @code{tp_traverse} no Python 3.8 e anteriores


O requerimento de o @code{tp_traverse} visitar o tipo foi adicionado no Python 3.9. Se você suporta Python 3.8 e anteriores, a função de travessia `não' deve visitar o tipo, de forma que ela precisa ser mais complicada:

@example
static int my_traverse(PyObject *self, visitproc visit, void *arg)
@{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
    return 0;
@}
@end example

Infelizmente, o símbolo @ref{756,,Py_Version} foi adicionado somente no Python 3.11. Para substituí-lo, use:


@itemize *

@item 
@ref{757,,PY_VERSION_HEX}, caso não esteja usando a ABI estável, ou

@item 
@ref{6a0,,sys.version_info} (via @ref{389,,PySys_GetObject()} e @ref{571,,PyArg_ParseTuple()}).
@end itemize

@node Delegando a função tp_traverse,Definindo tp_dealloc,tp_traverse no Python 3 8 e anteriores,Protocolo de recolhimento de lixo
@anchor{howto/isolating-extensions delegating-tp-traverse}@anchor{5495}
@subsubsection Delegando a função @code{tp_traverse}


Se a sua função de travessia delega para a @ref{77e,,tp_traverse} da sua classe base (ou de outro tipo), certifique-se de que @code{Py_TYPE(self)} seja visitado apenas uma vez. Observe que somente tipos no heap devem visitar o tipo em @code{tp_traverse}.

Por exemplo, se a sua função de travessia incluir:

@example
base->tp_traverse(self, visit, arg)
@end example

…e @code{base} puder ser um tipo estático, então ela também precisa incluir:

@example
if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
    // uma tp_traverse do tipo heap já visitou Py_TYPE(self)
@} else @{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
@}
@end example

Não é necessário mexer na contagem de referências do tipo em @ref{57f,,tp_new} e @ref{4b8b,,tp_clear}.

@node Definindo tp_dealloc,Evitar substituir tp_free,Delegando a função tp_traverse,Protocolo de recolhimento de lixo
@anchor{howto/isolating-extensions defining-tp-dealloc}@anchor{5496}
@subsubsection Definindo @code{tp_dealloc}


Se o seu tipo tem uma função @ref{4b66,,tp_dealloc} customizada, ele precisa:


@itemize -

@item 
chamar @ref{154e,,PyObject_GC_UnTrack()} antes que quaisquer campos sejam invalidados, e

@item 
decrementar o contador de referências do tipo.
@end itemize

Para que o tipo permaneça válido durante o @code{tp_free}, o refcount do tipo precisa ser decrementado `depois' de a instância ser liberada. Por exemplo:

@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

A função @code{tp_dealloc} padrão faz isso, de forma que se o seu tipo `não' a substitui você não precisa se preocupar.

@node Evitar substituir tp_free,Evitar PyObject_New,Definindo tp_dealloc,Protocolo de recolhimento de lixo
@anchor{howto/isolating-extensions not-overriding-tp-free}@anchor{5497}
@subsubsection Evitar substituir @code{tp_free}


O slot @ref{4b79,,tp_free} de um tipo no heap deve ser @ref{154c,,PyObject_GC_Del()}. Este é o padráo; não o substitua.

@node Evitar PyObject_New,,Evitar substituir tp_free,Protocolo de recolhimento de lixo
@anchor{howto/isolating-extensions avoiding-pyobject-new}@anchor{5498}
@subsubsection Evitar @code{PyObject_New}


Objetos rastreados pelo GC precisam ser alocados usando funções que reconheçam o GC.

Se você usa @ref{98c,,PyObject_New()} ou @ref{98d,,PyObject_NewVar()}:


@itemize -

@item 
Se possível, chame o slot @ref{4b7a,,tp_alloc} do tipo. Isto é, troque @code{TYPE *o = PyObject_New(TYPE, typeobj)} por:

@example
TYPE *o = typeobj->tp_alloc(typeobj, 0);
@end example

No lugar de @code{o = PyObject_NewVar(TYPE, typeobj, size)}, use também a forma acima, mas com @code{size} ao invés do @code{0}.

@item 
Se isso não for possível (por exemplo, dentro de um @code{tp_alloc} customizado), chame @ref{ab1,,PyObject_GC_New()} or @ref{ab2,,PyObject_GC_NewVar()}:

@example
TYPE *o = PyObject_GC_New(TYPE, typeobj);

TYPE *o = PyObject_GC_NewVar(TYPE, typeobj, size);
@end example
@end itemize

@node Acessando o estado do módulo a partir de classes,Acesso ao estado do módulo a partir de métodos regulares,Protocolo de recolhimento de lixo,Tipos no heap<2>
@anchor{howto/isolating-extensions module-state-access-from-classes}@anchor{5499}
@subsubsection Acessando o estado do módulo a partir de classes


Dado um objeto de tipo definido com @ref{551,,PyType_FromModuleAndSpec()}, você pode chamar @ref{975,,PyType_GetModule()} para acessar o módulo associado, e então @ref{987,,PyModule_GetState()} para acessar o estado do módulo.

Para evitar o tedioso código de tratamento de erros de sempre, você pode combinar essas duas etapas com o @ref{976,,PyType_GetModuleState()} assim:

@example
my_struct *state = (my_struct*)PyType_GetModuleState(type);
if (state == NULL) @{
    return NULL;
@}
@end example

@node Acesso ao estado do módulo a partir de métodos regulares,Acesso ao estado do módulo a partir de métodos slot getters e setters,Acessando o estado do módulo a partir de classes,Tipos no heap<2>
@anchor{howto/isolating-extensions module-state-access-from-regular-methods}@anchor{549a}
@subsubsection Acesso ao estado do módulo a partir de métodos regulares


Acessar o estado do módulo a partir de métodos de uma classe já é um pouco mais complicado, mas passou a ser possível graças à API introduzida no Python 3.9. Para conseguir o estado, é necessário primeiro acessar a `classe definidora', e então obter o estado do módulo a partir dela.

O maior obstáculo é encontrar `a classe na qual um método foi definido', ou, abreviando, a `classe definidora' desse método. A classe definidora pode guardar uma referência para o módulo do qual ela é parte.

Não confunda a classe definidora com @code{Py_TYPE(self)}. Se o método for chamado em uma `subclasse' do seu tipo, @code{Py_TYPE(self)} será uma referência àquela subclasse, a qual pode ter sido definida em um módulo diferente do seu.

@cartouche
@quotation Nota 
O código Python a seguir ilustra esse conceito. @code{Base.get_defining_class} retorna @code{Base} mesmo quando @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

Para um método acessar a sua “classe definidora”, ele precisa usar a @ref{151f,,convenção de chamada} @ref{1784,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS} e a assinatura @ref{764,,PyCMethod} correspondente:

@example
PyObject *PyCMethod(
    PyObject *self,               // objeto onde o módulo foi chamado
    PyTypeObject *defining_class, // classe definidora
    PyObject *const *args,        // vetor C de argumentos
    Py_ssize_t nargs,             // comprimento de "args"
    PyObject *kwnames)            // NULL, ou dicionário de argumentos nomeados
@end example

Uma vez que vc tem a classe definidora, chame @ref{976,,PyType_GetModuleState()} para obter o estado do módulo associado a ela.

Por exemplo:

@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 Acesso ao estado do módulo a partir de métodos slot getters e setters,Tempo de vida do estado do módulo,Acesso ao estado do módulo a partir de métodos regulares,Tipos no heap<2>
@anchor{howto/isolating-extensions module-state-access-from-slot-methods-getters-and-setters}@anchor{549b}
@subsubsection Acesso ao estado do módulo a partir de métodos slot, getters e setters


@cartouche
@quotation Nota 
Adicionado na versão 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

Métodos slot—os métodos rápidos em C equivalentes aos métodos especiais, como @ref{4f6e,,nb_add} para @ref{2121,,__add__} ou @ref{57f,,tp_new} para inicialização—têm uma API muito simples que não permite passar a classe definidora, ao contrário do @ref{764,,PyCMethod}. O mesmo vale para getters e setters definidos com @ref{bd1,,PyGetSetDef}.

Para acessar o estado do módulo nesses casos, use a função @ref{394,,PyType_GetModuleByDef()}, e passe a definição do módulo. Uma vez encontrado o módulo, chame @ref{987,,PyModule_GetState()} para obter o 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

Essa função @code{PyType_GetModuleByDef()} funciona procurando na @ref{2316,,ordem de resolução de métodos} (isto é, todas as superclasses) a primeira superclasse que tem um módulo correspondente.

@cartouche
@quotation Nota 
Em casos muito exóticos (cadeias hereditárias espalhadas através de múltiplos módulos criados a partir da mesma definição), a @code{PyType_GetModuleByDef()} pode não retornar o módulo da classe definidora correta. De todo modo, essa função sempre vai retornar um módulo com a mesma definição, garantindo um layout de memória C compatível.
@end quotation
@end cartouche

@node Tempo de vida do estado do módulo,,Acesso ao estado do módulo a partir de métodos slot getters e setters,Tipos no heap<2>
@anchor{howto/isolating-extensions lifetime-of-the-module-state}@anchor{549c}
@subsubsection Tempo de vida do estado do módulo


Quando um objeto de módulo é coletado como lixo, o seu estado de módulo é liberado. Para cada ponteiro para o estado do módulo (ou uma parte dele), é necessário possuir uma referência ao objeto de módulo.

Isso não costuma ser um problema, dado que tipos criados com @ref{551,,PyType_FromModuleAndSpec()}, bem como suas instâncias, guardam referências ao módulo. Mesmo assim, é necessário tomar cuidado com a contagem de referências ao referenciar o estado do módulo a partir de outros lugares, como funções de retorno para bibliotecas externas.

@node Problemas em aberto,,Tipos no heap<2>,Isolando módulos de extensão
@anchor{howto/isolating-extensions open-issues}@anchor{549d}
@subsection Problemas em aberto


Vários problemas relacionados aos estados por módulo e aos tipos no heap ainda estão em aberto.

Discussões sobre como melhorar a situação são melhor realizadas no fórum de discussão na tag c-api@footnote{https://discuss.python.org/c/core-dev/c-api/30}.

@menu
* Escopo por classe:: 
* Conversão sem perdas para tipos no heap:: 

@end menu

@node Escopo por classe,Conversão sem perdas para tipos no heap,,Problemas em aberto
@anchor{howto/isolating-extensions per-class-scope}@anchor{549e}
@subsubsection Escopo por classe


Atualmente (desde o Python 3.11) não é possível anexar estado a `tipos' individuais sem depender de detalhes de implementação do CPython (os quais podem mudar no futuro—talvez, ironicamente, para possibilitar uma solução adequada para o escopo por classe).

@node Conversão sem perdas para tipos no heap,,Escopo por classe,Problemas em aberto
@anchor{howto/isolating-extensions lossless-conversion-to-heap-types}@anchor{549f}
@subsubsection Conversão sem perdas para tipos no heap


A API de tipos no heap não foi projetada para conversão “sem perdas” de tipos estáticos. isto é, para criar um tipo que funciona exatamente como um dado tipo estático.

@node Descritor de arquivo de temporizador,A Ordem de Resolução de Métodos do Python 2 3,Isolando módulos de extensão,Python HOWTOs
@anchor{howto/timerfd doc}@anchor{54a0}@anchor{howto/timerfd timer-file-descriptor-howto}@anchor{54a1}@anchor{howto/timerfd timerfd-howto}@anchor{54a2}@anchor{howto/timerfd translation-repo}@anchor{54a3}
@section Descritor de arquivo de temporizador


@*Versão: 
1.13


Este documento discute o suporte do Python para o descritor de arquivo de temporizador do Linux.

@menu
* Exemplos: Exemplos<40>. 

@end menu

@node Exemplos<40>,,,Descritor de arquivo de temporizador
@anchor{howto/timerfd examples}@anchor{54a4}
@subsection Exemplos


O exemplo a seguir mostra como usar um descritor de arquivo de temporizador para executar uma função duas vezes por segundo:

@example
# Scripts práticos devem realmente usar um timer sem bloqueio.
# Usamos um timer com bloqueio aqui para simplificar.
import os, time

# Cria um descritor de arquivo de temporizador
fd = os.timerfd_create(time.CLOCK_REALTIME)

# Inicia o temporizador em 1 segundo, com um intervalo de meio segundo
os.timerfd_settime(fd, initial=1, interval=0.5)

try:
    # Processa eventos do temporizador quatro vezes.
    for _ in range(4):
        # read() ser bloqueado até o temporizador expirar
        _ = os.read(fd, 8)
        print("Timer expired")
finally:
    # Lembre-se de fechar o descritor de arquivo de temporizador!
    os.close(fd)
@end example

Para evitar a perda de precisão causada pelo tipo @ref{2f7,,float}, os descritores de arquivos de temporizador permitem especificar a expiração inicial e o intervalo em nanossegundos inteiros com variantes @code{_ns} das funções.

Este exemplo mostra como @ref{fc8,,epoll()} pode ser usado com descritores de arquivo de temporizador para esperar até que o descritor de arquivo esteja pronto para leitura:

@example
import os, time, select, socket, sys

# Cria um objeto epoll
ep = select.epoll()

# Neste exemplo, usa o endereço de loopback para enviar o comando "stop" ao servidor.
#
# $ 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)

# Cria descritores de arquivo de temporizador no modo não bloqueante.
num = 3
fds = []
for _ in range(num):
    fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
    fds.append(fd)
    # Registra o descritor de arquivo do temporizador para eventos de leitura
    ep.register(fd, select.EPOLLIN)

# Inicia o temporizador com os.timerfd_settime_ns() em nanossegundos.
# O temporizador 1 dispara a cada 0,25 segundos; o timer 2 a cada 0,5 segundos; 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:
        # Aguarda o temporizador expirar por 3 segundos.
        # epoll.poll() retorna uma lista de pares (fd, event).
        # fd é um descritor de arquivo.
        # sock e conn[=valor retornado de socket.accept()] são objetos de socket, não descritores de arquivo.
        # Então use sock.fileno() e conn.fileno() para obter os descritores de arquivo.
        events = ep.poll(timeout)

        # Se mais de um descritor de arquivo de timer estiver pronto para leitura ao mesmo tempo,
        # epoll.poll() retorna uma lista de pares (fd, event).
        #
        # Neste exemplo de configurações,
        #    O 1º temporizador dispara a cada 0,25 segundos em 0,25 segundos. (0,25, 0,5, 0,75, 1,0, ...)
        #    O 2º temporizador dispara a cada 0,5 segundos em 0,5 segundos. (0,5, 1,0, 1,5, 2,0, ...)
        #    O 3º temporizador dispara a cada 0,75 segundos em 0,75 segundos. (0,75, 1,5, 2,25, 3,0, ...)
        #
        #    Em 0,25 segundos, apenas o 1º temporizador dispara.
        #    Em 0,5 segundos, o 1º temporizador e o 2º temporizador disparam ao mesmo tempo.
        #    Em 0,75 segundos, o 1º temporizador e o 3º temporizador disparam ao mesmo tempo.
        #    Em 1,5 segundos, o 1º temporizador, o 2º temporizador e o 3º temporizador disparam ao mesmo tempo.
        #
        # Se um descritor de arquivo de temporizador for sinalizado mais de uma vez desde
        # a última chamada de os.read(), os.read() retornará o número de sinalizados
        # como ordem de host de bytes de classe.
        print(f"Signaled events=@{events@}")
        for fd, event in events:
            if event & select.EPOLLIN:
                if fd == sock.fileno():
                    # Verifica se há uma requisição de conexão.
                    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():
                    # Verifica se há dados para ler.
                    print(f"Reading data @{fd@}")
                    data = conn.recv(1024)
                    if data:
                        # Você deveria capturar exceção UnicodeDecodeError por segurança.
                        cmd = data.decode()
                        if cmd.startswith("stop"):
                            print(f"Stopping server")
                            is_active = False
                        else:
                            print(f"Unknown command: @{cmd@}")
                    else:
                        # Acabaram os dados, fecha a conexão
                        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

Este exemplo mostra como @ref{dc8,,select()} pode ser usado com descritores de arquivo de temporizador para esperar até que o descritor de arquivo esteja pronto para leitura:

@example
import os, time, select, socket, sys

# Neste exemplo, usa o endereço de loopback para enviar o comando "stop" ao servidor.
#
# $ 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)

# Cria descritores de arquivo de temporizador no modo não bloqueante.
num = 3
fds = [os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
       for _ in range(num)]
select_fds = fds + [sock]

# Inicia o temporizador com os.timerfd_settime() em segundos.
# O temporizador 1 dispara a cada 0,25 segundos; o timer 2 a cada 0,5 segundos; 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:
       # Aguarda o temporizador expirar por 3 segundos.
       # select.select() retorna uma lista de objetos ou descritores de arquivos.
       rfd, wfd, xfd = select.select(select_fds, select_fds, select_fds, timeout)
       for fd in rfd:
           if fd == sock:
               # Verifica se há uma requisição de conexão.
               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:
               # Verifica se há dados para ler.
               print(f"Reading data @{fd@}")
               data = conn.recv(1024)
               if data:
                   # Você deveria capturar exceção UnicodeDecodeError por segurança.
                   cmd = data.decode()
                   if cmd.startswith("stop"):
                       print(f"Stopping server")
                       is_active = False
                   else:
                       print(f"Unknown command: @{cmd@}")
               else:
                   # Acabaram os dados, fecha a conexão
                   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 A Ordem de Resolução de Métodos do Python 2 3,Suporte experimental do Python para threads livres,Descritor de arquivo de temporizador,Python HOWTOs
@anchor{howto/mro doc}@anchor{54a5}@anchor{howto/mro python-2-3-mro}@anchor{14f2}@anchor{howto/mro the-python-2-3-method-resolution-order}@anchor{54a6}@anchor{howto/mro translation-repo}@anchor{54a7}
@section A Ordem de Resolução de Métodos do Python 2.3


@cartouche
@quotation Nota 
Este é um documento histórico, fornecido como apêndice à documentação oficial. A ordem de resolução de métodos discutida aqui foi `introduzida' no Python 2.3, mas ainda é usada em versões posteriores – incluindo o Python 3.
@end quotation
@end cartouche

por Michele Simionato@footnote{https://www.phyast.pitt.edu/~micheles/}.

@*Resumo: 
`Este documento é destinado a programadores Python que desejam entender a ordem de resolução de métodos C3 usada no Python 2.3. Embora não seja destinado a iniciantes, é bastante pedagógico com muitos exemplos elaborados. Não tenho conhecimento de outros documentos publicamente disponíveis com o mesmo escopo, portanto devem ser úteis.'


Aviso:

@quotation

`Eu doo este documento para a Python Software Foundation, sob a licença Python 2.3. Como de costume nestas circunstâncias, aviso o leitor que o que se segue' deve `estar correto, mas não dou nenhuma garantia. Use-o por sua própria conta e risco!'
@end quotation

Reconhecimentos:

@quotation

`Todas as pessoas da lista de discussão do Python que me enviaram seu apoio. Paul Foley, que apontou várias imprecisões e me fez acrescentar a parte sobre ordem de precedência local. David Goodger pela ajuda com a formatação em reStructuredText. David Mertz pela ajuda com a edição. Finalmente, Guido van Rossum que adicionou com entusiasmo este documento à página inicial oficial do Python 2.3.'
@end quotation

@menu
* O início:: 
* A ordem de resolução de métodos C3:: 
* Exemplos: Exemplos<41>. 
* Ordens de resolução de métodos ruins:: 
* O fim:: 
* Recursos: Recursos<3>. 

@end menu

@node O início,A ordem de resolução de métodos C3,,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro the-beginning}@anchor{54a8}
@subsection O início


@quotation

`Felix qui potuit rerum cognoscere causas' – Virgilius
@end quotation

Tudo começou com uma postagem de Samuele Pedroni na lista de discussão de desenvolvimento Python @footnote{
O tópico no python-dev iniciado por Samuele Pedroni: @indicateurl{https://mail.python.org/pipermail/python-dev/2002-October/029035.html}
}. Em sua postagem, Samuele mostrou que a ordem de resolução de métodos do Python 2.2 não é monotônica e propôs substituí-la pela ordem de resolução de métodos C3. Guido concordou com seus argumentos e, portanto, agora o Python 2.3 usa C3. O método C3 em si não tem nada a ver com Python, pois foi inventado por pessoas que trabalharam em Dylan e está descrito em um artigo destinado a lispers @footnote{
O artigo `Uma Linearização Monotônica de Superclasses para Dylan', em inglês: @indicateurl{https://doi.org/10.1145/236337.236343}
}. O presente artigo fornece uma discussão (espero) legível do algoritmo C3 para Pythonistas que desejam entender os motivos da mudança.

Primeiro de tudo, deixe-me salientar que o que vou dizer se aplica apenas às `classes no novo estilo' introduzidas no Python 2.2: `classes clássicas' mantêm sua antiga ordem de resolução de métodos, profundidade primeiro e depois da esquerda para a direita. Portanto, não há quebra de código antigo para classes clássicas; e mesmo que em princípio pudesse haver quebra de código para novas classes de estilo do Python 2.2, na prática os casos em que a ordem de resolução C3 difere da ordem de resolução de métodos do Python 2.2 são tão raros que nenhuma quebra real de código é esperada. Portanto:

@quotation

`Não tenha medo!'
@end quotation

Além disso, a menos que você faça uso intenso de herança múltipla e tenha hierarquias não triviais, você não precisa entender o algoritmo C3 e pode facilmente pular este artigo. Por outro lado, se você realmente deseja saber como funciona a herança múltipla, este artigo é para você. A boa notícia é que as coisas não são tão complicadas quanto você imagina.

Deixe-me começar com algumas definições básicas.


@enumerate 

@item 
Dada uma classe C em uma complicada hierarquia de herança múltipla, não é uma tarefa trivial especificar a ordem na qual os métodos são substituídos, ou seja, especificar a ordem dos ancestrais de C.

@item 
A lista dos ancestrais de uma classe C, incluindo a própria classe, ordenada do ancestral mais próximo ao mais distante, é chamada de lista de precedência de classe ou `linearização' de C.

@item 
A `Ordem de Resolução de Métodos' (em inglês Method Resolution Order, MRO) é o conjunto de regras que constroem a linearização. Na literatura Python, a expressão “a MRO de C” também é usada como sinônimo de linearização da classe C.

@item 
Por exemplo, no caso de hierarquia de herança única, se C é uma subclasse de C1 e C1 é uma subclasse de C2, então a linearização de C é simplesmente a lista [C, C1, C2]. No entanto, com múltiplas hierarquias de herança, a construção da linearização é mais complicada, pois é mais difícil construir uma linearização que respeite a `ordem de precedência local' e a `monotonicidade'.

@item 
Discutirei a ordem de precedência local mais tarde, mas posso dar aqui a definição de monotonicidade. Uma MRO é monotônico quando o seguinte é verdadeiro: `se C1 precede C2 na linearização de C, então C1 precede C2 na linearização de qualquer subclasse de C'. Caso contrário, a operação inócua de derivar uma nova classe poderia alterar a ordem de resolução dos métodos, potencialmente introduzindo bugs muito sutis. Exemplos onde isso acontece serão mostrados posteriormente.

@item 
Nem todas as classes admitem uma linearização. Existem casos, em hierarquias complicadas, em que não é possível derivar uma classe tal que a sua linearização respeite todas as propriedades desejadas.
@end enumerate

Aqui dou um exemplo desta situação. Considere a hierarquia

@example
>>> O = object
>>> class X(O): pass
>>> class Y(O): pass
>>> class A(X,Y): pass
>>> class B(Y,X): pass
@end example

que pode ser representada com o seguinte grafo de herança, onde denotamos com O a classe @code{object}, que é o início de qualquer hierarquia para classes de novo estilo:

@quotation

@example
 -----------
|           |
|    O      |
|  /   \    |
 - X    Y  /
   |  / | /
   | /  |/
   A    B
   \   /
     ?
@end example
@end quotation

Neste caso, não é possível derivar uma nova classe C de A e B, pois X precede Y em A, mas Y precede X em B, portanto a ordem de resolução de métodos seria ambígua em C.

Python 2.3 levanta uma exceção nesta situação (TypeError: MRO conflict among bases Y, X) proibindo o programador ingênuo de criar hierarquias ambíguas. Em vez disso, o Python 2.2 não levanta uma exceção, mas escolhe uma ordem `ad hoc' (CABXYO neste caso).

@node A ordem de resolução de métodos C3,Exemplos<41>,O início,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro the-c3-method-resolution-order}@anchor{54a9}
@subsection A ordem de resolução de métodos C3


Deixe-me apresentar algumas notações simples que serão úteis para a discussão a seguir. Usarei a notação de atalho:

@example
C1 C2 ... CN
@end example

para indicar a lista de classes [C1, C2, … , CN].

`head' da lista é o seu primeiro elemento:

@example
head = C1
@end example

enquanto `tail' é o resto da lista:

@example
tail = C2 ... CN.
@end example

Também usarei a notação:

@example
C + (C1 C2 ... CN) = C C1 C2 ... CN
@end example

para denotar a soma das listas [C] + [C1, C2, …, CN].

Agora posso explicar como funciona a MRO no Python 2.3.

Considere uma classe C em uma hierarquia de herança múltipla, com C herdando das classes base B1, B2, …, BN. Queremos calcular a linearização L[C] da classe C. A regra é a seguinte:

@quotation

`a linearização de C é a soma de C mais a mesclagem das linearizações dos pais e da lista dos pais.'
@end quotation

Em notação simbólica:

@example
L[C(B1 ... BN)] = C + merge(L[B1] ... L[BN], B1 ... BN)
@end example

Em particular, se C é a classe @code{object}, que não tem pais, a linearização é trivial:

@example
L[object] = object.
@end example

Contudo, em geral, deve-se calcular a mesclagem de acordo com a seguinte prescrição:

@quotation

`considere o topo da primeira lista, ou seja, L[B1][0]; se esse head não estiver no final de nenhuma das outras listas, então adicione-o à linearização de C e remova-o das listas na mesclagem, caso contrário olhe para o head da próxima lista e pegue-o, se for um bom head. Em seguida, repita a operação até que todas as classes sejam removidas ou seja impossível encontrar boas cabeças. Neste caso, é impossível construir a mesclagem, o Python 2.3 se recusará a criar a classe C e vai levantar uma exceção.'
@end quotation

Esta prescrição garante que a operação de mesclagem `preserva' a ordem, se a ordem puder ser preservada. Por outro lado, se a ordem não puder ser preservada (como no exemplo de desacordo sério sobre ordem discutido acima), então a mesclagem não poderá ser calculada.

O cálculo da mesclagem é trivial se C tiver apenas um pai (herança única); nesse caso:

@example
L[C(B)] = C + merge(L[B],B) = C + L[B]
@end example

No entanto, no caso de herança múltipla, as coisas são mais complicadas e não espero que você consiga entender a regra sem alguns exemplos ;-)

@node Exemplos<41>,Ordens de resolução de métodos ruins,A ordem de resolução de métodos C3,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro examples}@anchor{54aa}
@subsection Exemplos


Primeiro exemplo. Considere a seguinte hierarquia:

@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

Neste caso, o grafo de herança pode ser desenhado como:

@quotation

@example
                          6
                         ---
Nível 3                 | O |                  (mais geral)
                      /  ---  \
                     /    |    \                      |
                    /     |     \                     |
                   /      |      \                    |
                  ---    ---    ---                   |
Nível 2        3 | D | 4| E |  | F | 5                |
                  ---    ---    ---                   |
                   \  \ _ /       |                   |
                    \    / \ _    |                   |
                     \  /      \  |                   |
                      ---      ---                    |
Nível 1            1 | B |    | C | 2                 |
                      ---      ---                    |
                        \      /                      |
                         \    /                      \ /
                           ---
Nível 0                 0 | A |                (mais especializada)
                           ---
@end example
@end quotation

As linearizações de O,D,E e F são triviais:

@example
L[O] = O
L[D] = D O
L[E] = E O
L[F] = F O
@end example

A linearização de B pode ser calculada como:

@example
L[B] = B + merge(DO, EO, DE)
@end example

Vemos que D é um bom `head', portanto pegamos ele e ficamos reduzidos a calcular @code{merge(O,EO,E)}. Agora O não é um bom `head', pois está no `tail' da sequência EO. Neste caso a regra diz que temos que pular para a próxima sequência. Então vemos que E é um bom `head'; nós pegamos isso e somos reduzidos a calcular @code{merge(O,O)} que dá O. Portanto:

@example
L[B] =  B D E O
@end example

Usando o mesmo procedimento encontra-se:

@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

Agora podemos calcular:

@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

Neste exemplo, a linearização é ordenada de maneira bastante agradável de acordo com o nível de herança, no sentido de que níveis mais baixos (ou seja, classes mais especializadas) têm precedência mais alta (veja o grafo de herança). No entanto, este não é o caso geral.

Deixo como exercício para o leitor calcular a linearização do meu segundo exemplo:

@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

A única diferença com o exemplo anterior é a mudança B(D,E) –> B(E,D); no entanto, mesmo uma pequena modificação muda completamente a ordem da hierarquia:

@quotation

@example
                           6
                          ---
Nível 3                  | O |
                       /  ---  \
                      /    |    \
                     /     |     \
                    /      |      \
                  ---     ---    ---
Nível 2        2 | E | 4 | D |  | F | 5
                  ---     ---    ---
                   \      / \     /
                    \    /   \   /
                     \  /     \ /
                      ---     ---
Nível 1            1 | B |   | C | 3
                      ---     ---
                       \       /
                        \     /
                          ---
Nível 0                0 | A |
                          ---
@end example
@end quotation

Observe que a classe E, que está no segundo nível da hierarquia, precede a classe C, que está no primeiro nível da hierarquia, ou seja, E é mais especializado que C, mesmo que esteja em um nível mais alto.

Um programador preguiçoso pode obter a MRO diretamente do Python 2.2, pois neste caso ela coincide com a linearização do Python 2.3. Basta invocar o método @ref{20bd,,mro()} da classe A:

@example
>>> A.mro()
[<class 'A'>, <class 'B'>, <class 'E'>,
<class 'C'>, <class 'D'>, <class 'F'>,
<class 'object'>]
@end example

Finalmente, deixe-me considerar o exemplo discutido na primeira seção, envolvendo um sério desacordo de ordem. Neste caso, é simples calcular as linearizações de O, X, Y, A e 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

Porém, é impossível calcular a linearização para uma classe C que herda de A e B:

@example
L[C] = C + merge(AXYO, BYXO, AB)
     = C + A + merge(XYO, BYXO, B)
     = C + A + B + merge(XYO, YXO)
@end example

Neste ponto não podemos mesclar as listas XYO e YXO, uma vez que X está no `tail' de YXO enquanto Y está no `tail' de XYO: portanto não há bons `head' e o algoritmo C3 para. Python 2.3 levanta um erro e se recusa a criar a classe C.

@node Ordens de resolução de métodos ruins,O fim,Exemplos<41>,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro bad-method-resolution-orders}@anchor{54ab}
@subsection Ordens de resolução de métodos ruins


Uma MRO é `ruim' quando quebra propriedades fundamentais como ordem de precedência local e monotonicidade. Nesta seção, mostrarei que tanto a MRO para classes clássicas quanto a MRO para classes de novo estilo em Python 2.2 são ruins.

É mais fácil começar com a ordem de precedência local. Considere o seguinte exemplo:

@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

com diagrama de herança

@quotation

@example
                 O
                 |
(comprar spam)   F
                 | \
                 | E   (comprar ovos)
                 | /
                 G

        (comprar ovos ou spam ?)
@end example
@end quotation

Vemos que a classe G herda de F e E, com F `antes' de E: portanto, esperaríamos que o atributo `G.remember2buy' fosse herdado por `F.remember2buy' e não por `E.remember2buy': no entanto, Python 2.2 dá

@example
>>> G.remember2buy
'eggs'
@end example

Isto é uma quebra da ordem de precedência local, uma vez que a ordem na lista de precedência local, ou seja, a lista dos pais de G, não é preservada na linearização de G em Python 2.2:

@example
L[G,P22]= G E F object   # F *segue* E
@end example

Pode-se argumentar que a razão pela qual F segue E na linearização do Python 2.2 é que F é menos especializado que E, uma vez que F é a superclasse de E; no entanto, a quebra da ordem de precedência local é bastante não intuitiva e sujeita a erros. Isto é particularmente verdadeiro porque é diferente das classes de estilo antigo:

@example
>>> class F: remember2buy='spam'
>>> class E(F): remember2buy='eggs'
>>> class G(F,E): pass
>>> G.remember2buy
'spam'
@end example

Neste caso a MRO é GFEF e a ordem de precedência local é preservada.

Como regra geral, hierarquias como a anterior devem ser evitadas, uma vez que não está claro se F deve substituir E ou vice-versa. O Python 2.3 resolve a ambiguidade levantando uma exceção na criação da classe G, impedindo efetivamente o programador de gerar hierarquias ambíguas. A razão para isso é que o algoritmo C3 falha quando a mesclagem:

@example
merge(FO,EFO,FE)
@end example

não puder ser calculada, porque F está no `tail' de EFO e E está no `tail' de FE.

A verdadeira solução é conceber uma hierarquia não ambígua, ou seja, derivar G de E e F (o mais específico primeiro) e não de F e E; neste caso a MRO é GEF, sem dúvida.

@quotation

@example
           O
           |
           F (spam)
         / |
(ovos)   E |
         \ |
           G
             (ovos, sem dúvida)
@end example
@end quotation

Python 2.3 força o programador a escrever boas hierarquias (ou, pelo menos, menos propensas a erros).

Falando nisso, deixe-me salientar que o algoritmo Python 2.3 é inteligente o suficiente para reconhecer erros óbvios, como a duplicação de classes na lista de pais:

@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 (tanto para classes clássicas quanto para classes de novo estilo) nesta situação, não levantaria nenhuma exceção.

Por fim, gostaria de destacar duas lições que aprendemos com este exemplo:


@enumerate 

@item 
apesar do nome, a MRO determina a ordem de resolução dos atributos, não apenas dos métodos;

@item 
o alimento padrão para Pythonistas é spam! (mas você já sabia disso ;-)
@end enumerate

Tendo discutido a questão da ordem de precedência local, deixe-me agora considerar a questão da monotonicidade. Meu objetivo é mostrar que nem a MRO para classes clássicas nem para o novo estilo de classes do Python 2.2 são monotônicas.

Para provar que a MRO para classes clássicas não é monotônica é bastante trivial, basta olhar o diagrama em losango:

@quotation

@example
   C
  / \
 /   \
A     B
 \   /
  \ /
   D
@end example
@end quotation

Percebe-se facilmente a inconsistência:

@example
L[B,P21] = B C        # B precede C : métodos de B venceram
L[D,P21] = D A C B C  # B segue C  : métodos de B venceram!
@end example

Por outro lado, não há problemas com as MROs do Python 2.2 e do 2.3, elas fornecem ambos:

@example
L[D] = D A B C
@end example

Guido ressalta em seu ensaio @footnote{
Ensaio de Guido van Rossum, `Unificando tipos e classes em Python 2.2', em inglês: @indicateurl{https://web.archive.org/web/20140210194412/http://www.python.org/download/releases/2.2.2/descrintro}
} que a MRO clássica não é tão ruim na prática, já que normalmente se pode evitar losangos para classes clássicas. Mas todas as classes de novo estilo herdam de @code{object}, portanto os diamantes são inevitáveis e inconsistências aparecem em cada grafo de herança múltipla.

A MRO do Python 2.2 torna difícil quebrar a monotonicidade, mas não impossível. O exemplo a seguir, fornecido originalmente por Samuele Pedroni, mostra que a MRO do Python 2.2 não é monotônica:

@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

Aqui estão as linearizações de acordo com a MRO C3 (o leitor deverá verificar essas linearizações como exercício e desenhar o diagrama de herança ;-)

@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 fornece exatamente as mesmas linearizações para A, B, C, D, E, K1, K2 e K3, mas uma linearização diferente para Z:

@example
L[Z,P22] = Z K1 K3 A K2 D B C E O
@end example

É claro que esta linearização está `errada', uma vez que A vem antes de D, enquanto na linearização de K3 A vem `depois' de D. Em outras palavras, em métodos K3 derivados de D substituem os métodos derivados de A, mas em Z, que ainda é uma subclasse de K3, os métodos derivados de A substituem os métodos derivados de D! Isto é uma violação da monotonicidade. Além disso, a linearização de Z do Python 2.2 também é inconsistente com a ordem de precedência local, uma vez que a lista de precedência local da classe Z é [K1, K2, K3] (K2 precede K3), enquanto na linearização de Z K2 `segue' K3 . Estes problemas explicam porque é que a regra do 2.2 foi rejeitada em favor da regra C3.

@node O fim,Recursos<3>,Ordens de resolução de métodos ruins,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro the-end}@anchor{54ac}
@subsection O fim


Esta seção é para o leitor impaciente, que passou direto por todas as seções anteriores e pulou imediatamente para o final. Esta seção também é para o programador preguiçoso, que não quer exercitar seu cérebro. Finalmente, é para o programador com alguma arrogância, caso contrário ele/ela não estaria lendo um artigo sobre a ordem de resolução de métodos C3 em múltiplas hierarquias de herança ;-) Essas três virtudes tomadas em conjunto (e `não' separadamente) merecem um prêmio: o prêmio é um pequeno script em Python 2.2 que permite calcular a MRO do 2.3 sem risco para o seu cérebro. Basta alterar a última linha para brincar com os vários exemplos que discuti neste artigo.:

@example
#<mro.py>

"""Algoritmo C3 por Samuele Pedroni (com legibilidade melhorada por mim)."""

class __metaclass__(type):
    "Todas as classes são modificadas metamagicamente para serem impressas com aparência amigável"
    __repr__ = lambda cls: cls.__name__

class ex_2:
    "Desacordo de ordem grave" #por 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 #cria Z(A,B) no Python 2.2
    except TypeError:
        pass # Z(A,B) não pode ser criado no Python 2.3

class ex_5:
    "Meu primeiro exemplo"
    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:
    "Meu segundo exemplo"
    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:
    "Diferença entre MRO do Python 2.2 e o C3" #por 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: # encontra candidatos a mesclagem entre os heads da sequência
          cand = seq[0]; print ' ',cand,
          nothead=[s for s in nonemptyseqs if cand in s[1:]]
          if nothead: cand=None #rejeita candidato
          else: break
      if not cand: raise "Hierarquia inconsistente"
      res.append(cand)
      for seq in nonemptyseqs: # remove candidato
          if seq[0] == cand: del seq[0]

def mro(C):
    "Calcula a lista de precedência da classe (mro) conforme 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

Isso é tudo, pessoal!

@quotation

Divirtam-se !
@end quotation

@node Recursos<3>,,O fim,A Ordem de Resolução de Métodos do Python 2 3
@anchor{howto/mro resources}@anchor{54ad}
@subsection Recursos


@node Suporte experimental do Python para threads livres,Suporte a extensões da API C para threads livres,A Ordem de Resolução de Métodos do Python 2 3,Python HOWTOs
@anchor{howto/free-threading-python doc}@anchor{54ae}@anchor{howto/free-threading-python freethreading-python-howto}@anchor{54af}@anchor{howto/free-threading-python python-experimental-support-for-free-threading}@anchor{54b0}@anchor{howto/free-threading-python translation-repo}@anchor{54b1}
@section Suporte experimental do Python para threads livres


A partir da versão 3.13, o CPython tem suporte experimental para uma compilação do Python chamada @ref{15e4,,threads livres} (em inglês, free threading), onde a @ref{148,,trava global do interpretador} (GIL) está desabilitada. A execução com threads livres permite a utilização total do poder de processamento disponível, executando threads em paralelo nos núcleos de CPU disponíveis. Embora nem todos os softwares se beneficiem disso automaticamente, os programas projetados com uso de threads em mente serão executados mais rapidamente em hardware com vários núcleos.

`O modo de threads livres é experimental' e há um trabalho contínuo para melhorá-lo: espere alguns bugs e uma perda substancial no desempenho da thread única.

Este documento descreve as implicações de threads livres para o código Python. Veja @ref{54b2,,Suporte a extensões da API C para threads livres} para informações sobre como escrever extensões C que oferecem suporte à construção com threads livres.


@subsubheading Ver também


@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} – Tornando a trava global do interpretador opcional no CPython para uma descrição geral do Python com threads livres.


@menu
* Instalação:: 
* Identificando um Python com threads livres:: 
* A trava global do interpretador no Python com threads livres:: 
* Segurança nas threads:: 
* Limitações conhecidas:: 

@end menu

@node Instalação,Identificando um Python com threads livres,,Suporte experimental do Python para threads livres
@anchor{howto/free-threading-python installation}@anchor{54b3}
@subsection Instalação


A partir do Python 3.13, os instaladores oficiais do macOS e do Windows oferecem suporte opcional à instalação de binários Python com threads livres. Os instaladores estão disponíveis em @indicateurl{https://www.python.org/downloads/}.

Para obter informações sobre outras plataformas, consulte Instalando um Python com threads livres@footnote{https://py-free-threading.github.io/installing_cpython/}, um guia de instalação mantido pela comunidade para instalar o Python com threads livres.

Ao construir o CPython a partir do código-fonte, a opção de configuração @ref{174,,--disable-gil} deve ser usada para construir um interpretador Python com threads livres.

@node Identificando um Python com threads livres,A trava global do interpretador no Python com threads livres,Instalação,Suporte experimental do Python para threads livres
@anchor{howto/free-threading-python identifying-free-threaded-python}@anchor{54b4}
@subsection Identificando um Python com threads livres


Para verificar se o interpretador atual oferece suporte a threads livres, @ref{177,,python -VV} e @ref{178,,sys.version} contêm “experimental free-threading build”. A nova função @ref{45cb,,sys._is_gil_enabled()} pode ser usada para verificar se a GIL está realmente desabilitada no processo em execução.

A variável de configuração @code{sysconfig.get_config_var("Py_GIL_DISABLED")} pode ser usada para determinar se a compilação tem suporte a threads livres. Se a variável for definida como @code{1}, a compilação tem suporte a threads livres. Este é o mecanismo recomendado para decisões relacionadas à configuração da construção.

@node A trava global do interpretador no Python com threads livres,Segurança nas threads,Identificando um Python com threads livres,Suporte experimental do Python para threads livres
@anchor{howto/free-threading-python the-global-interpreter-lock-in-free-threaded-python}@anchor{54b5}
@subsection A trava global do interpretador no Python com threads livres


Construções com threads livres do CPython oferecem suporte a opcionalmente executar com a GIL habilitada em tempo de execução usando a variável de ambiente 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL} ou a opção de linha de comando @ref{176,,-X gil}.

A GIL também pode ser habilitada automaticamente ao importar um módulo de extensão da API C que não esteja explicitamente marcado como oferecendo suporte a threads livres. Um aviso será impresso neste caso.

Além da documentação de pacotes individuais, os seguintes sites rastreiam o status do suporte de pacotes populares para threads livres:


@itemize *

@item 
@indicateurl{https://py-free-threading.github.io/tracking/}

@item 
@indicateurl{https://hugovk.github.io/free-threaded-wheels/}
@end itemize

@node Segurança nas threads,Limitações conhecidas,A trava global do interpretador no Python com threads livres,Suporte experimental do Python para threads livres
@anchor{howto/free-threading-python thread-safety}@anchor{54b6}
@subsection Segurança nas threads


A construção com threads livres do CPython visa fornecer comportamento de segurança às threads semelhante no nível do Python à construção padrão com GIL habilitada. Tipos embutidos como @ref{256,,dict}, @ref{611,,list} e @ref{5d9,,set} usam travas internas para proteger contra modificações simultâneas de maneiras que se comportam de forma semelhante à GIL. No entanto, o Python não garantiu historicamente um comportamento específico para modificações simultâneas a esses tipos embutidos, portanto, isso deve ser tratado como uma descrição da implementação atual, não uma garantia de comportamento atual ou futuro.

@cartouche
@quotation Nota 
É recomendável usar @ref{176d,,threading.Lock} ou outras primitivas de sincronização em vez de depender de travas internas de tipos embutidos, quando possível.
@end quotation
@end cartouche

@node Limitações conhecidas,,Segurança nas threads,Suporte experimental do Python para threads livres
@anchor{howto/free-threading-python known-limitations}@anchor{54b7}
@subsection Limitações conhecidas


Esta seção descreve as limitações conhecidas da construção do Python com threads livres.

@menu
* Imortalização:: 
* Objetos quadro: Objetos quadro<2>. 
* Iteradores: Iteradores<3>. 
* Desempenho com thread única:: 

@end menu

@node Imortalização,Objetos quadro<2>,,Limitações conhecidas
@anchor{howto/free-threading-python immortalization}@anchor{54b8}
@subsubsection Imortalização


A construção com threads livres da versão 3.13 torna alguns objetos @ref{45bb,,imortais}. Objetos imortais não são desalocados e têm contagens de referência que nunca são modificadas. Isso é feito para evitar contenção de contagem de referências que impediria o dimensionamento multithread eficiente.

Um objeto será tornado imortal quando um novo thread for iniciado pela primeira vez após o thread principal estar em execução. Os seguintes objetos são imortalizados:


@itemize *

@item 
objetos @ref{299,,função} declarados no nível de módulo

@item 
descritores de @ref{1e47,,métodos}

@item 
objetos @ref{1d2,,código}

@item 
objetos @ref{1755,,módulo} e seus dicionários

@item 
@ref{209e,,classes} (objetos de tipo)
@end itemize

Como objetos imortais nunca são desalocados, aplicações que criam muitos objetos desses tipos podem ver aumento no uso de memória. Espera-se que isso seja resolvido na versão 3.14.

Além disso, literais numéricos e de string no código, bem como strings retornadas por @ref{131e,,sys.intern()} também são imortalizados. Espera-se que esse comportamento permaneça na construção com threads livres do 3.14.

@node Objetos quadro<2>,Iteradores<3>,Imortalização,Limitações conhecidas
@anchor{howto/free-threading-python frame-objects}@anchor{54b9}
@subsubsection Objetos quadro


Não é seguro acessar objetos @ref{6e0,,quadro} de outros threads e fazer isso pode fazer com que seu programa trave. Isso significa que @ref{147a,,sys._current_frames()} geralmente não é seguro para uso em uma construção com threads livres. Funções como @ref{6e2,,inspect.currentframe()} e @ref{6e1,,sys._getframe()} são geralmente seguras, desde que o objeto quadro resultante não seja passado para outro thread.

@node Iteradores<3>,Desempenho com thread única,Objetos quadro<2>,Limitações conhecidas
@anchor{howto/free-threading-python iterators}@anchor{54ba}
@subsubsection Iteradores


Compartilhar o mesmo objeto iterador entre vários threads geralmente não é seguro e os threads podem ver elementos duplicados ou ausentes ao iterar ou travar o interpretador.

@node Desempenho com thread única,,Iteradores<3>,Limitações conhecidas
@anchor{howto/free-threading-python single-threaded-performance}@anchor{54bb}
@subsubsection Desempenho com thread única


A construção com threads livres tem sobrecarga adicional ao executar código Python em comparação com a construção padrão com GIL habilitada. Na versão 3.13, essa sobrecarga é de cerca de 40% no conjunto de ferramentas pyperformance@footnote{https://pyperformance.readthedocs.io/}. Programas que passam a maior parte do tempo em extensões C ou E/S verão menos impacto. O maior impacto é porque o interpretador adaptativo especializado (
@geindex Propostas de Melhorias do Python; PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/}) está desabilitado na construção com threads livres. Esperamos reabilitá-lo de forma segura para threads na versão 3.14. Espera-se que essa sobrecarga seja reduzida na próxima versão do Python. Estamos buscando uma sobrecarga de 10% ou menos no conjunto de ferramentas pyperformance em comparação com a construção padrão com GIL habilitada.

@node Suporte a extensões da API C para threads livres,,Suporte experimental do Python para threads livres,Python HOWTOs
@anchor{howto/free-threading-extensions doc}@anchor{54bc}@anchor{howto/free-threading-extensions c-api-extension-support-for-free-threading}@anchor{54bd}@anchor{howto/free-threading-extensions freethreading-extensions-howto}@anchor{54b2}@anchor{howto/free-threading-extensions translation-repo}@anchor{54be}
@section Suporte a extensões da API C para threads livres


A partir da versão 3.13, o CPython tem suporte experimental para execução com a @ref{148,,trava global do interpretador} (GIL) desabilitada em uma configuração chamada @ref{15e4,,threads livres}. Este documento descreve como adaptar extensões da API C para ter suporte a threads livres.

@menu
* Identificando a construção com threads livres em C:: 
* Inicialização de módulo:: 
* Diretrizes gerais de API:: 
* Referências emprestadas:: 
* APIs de alocação de memória:: 
* APIs da GIL e de estado de threads:: 
* Protegendo o estado interno das extensões:: 
* Construindo extensões para a construção com threads livres:: 

@end menu

@node Identificando a construção com threads livres em C,Inicialização de módulo,,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions identifying-the-free-threaded-build-in-c}@anchor{54bf}
@subsection Identificando a construção com threads livres em C


A API C do CPython expõe a macro @code{Py_GIL_DISABLED}: na construção com threads livres ela está definida como @code{1}, e na construção regular ela não está definida. Você pode usá-la para ativar o código que é executado apenas na construção com threads livres:

@example
#ifdef Py_GIL_DISABLED
/* código que só vai ser executado na construção com threads livres */
#endif
@end example

@cartouche
@quotation Nota 
No Windows, esta macro não é definida automaticamente, mas deve ser especificada ao compilador durante a compilação. A função @ref{1063,,sysconfig.get_config_var()} pode ser usada para determinar se o interpretador em execução tinha a macro definida.
@end quotation
@end cartouche

@node Inicialização de módulo,Diretrizes gerais de API,Identificando a construção com threads livres em C,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions module-initialization}@anchor{54c0}
@subsection Inicialização de módulo


Os módulos de extensão precisam indicar explicitamente que têm suporte à execução com a GIL desabilitada; caso contrário, importar a extensão levantará um aviso e ativará a GIL em tempo de execução.

Há duas maneiras de indicar que um módulo de extensão tem suporte à execução com a GIL desabilitada, dependendo se a extensão usa inicialização monofásica ou multifásica.

@menu
* Inicialização multifásica: Inicialização multifásica<2>. 
* Inicialização monofásica:: 

@end menu

@node Inicialização multifásica<2>,Inicialização monofásica,,Inicialização de módulo
@anchor{howto/free-threading-extensions multi-phase-initialization}@anchor{54c1}
@subsubsection Inicialização multifásica


Extensões que usam inicialização multifásica (ou seja, @ref{4b4c,,PyModuleDef_Init()}) devem adicionar um slot @ref{158,,Py_mod_gil} na definição do módulo. Se sua extensão tem suporte a versões mais antigas do CPython, você deve proteger o slot com uma verificação de @ref{757,,PY_VERSION_HEX}.

@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 Inicialização monofásica,,Inicialização multifásica<2>,Inicialização de módulo
@anchor{howto/free-threading-extensions single-phase-initialization}@anchor{54c2}
@subsubsection Inicialização monofásica


Extensões que usam inicialização monofásica (ou seja, @ref{50b8,,PyModule_Create()}) devem chamar @ref{179,,PyUnstable_Module_SetGIL()} para indicar que têm suporte à execução com a GIL desabilitada. A função é definida apenas na construção com threads livres, então você deve proteger a chamada com @code{#ifdef Py_GIL_DISABLED} para evitar erros de compilação na construção regular.

@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 Diretrizes gerais de API,Referências emprestadas,Inicialização de módulo,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions general-api-guidelines}@anchor{54c3}
@subsection Diretrizes gerais de API


A maior parte da API C é segura para thread, mas há algumas exceções.


@itemize *

@item 
`Campos de structs': acessar campos em objetos ou structs da API C do Python diretamente não é seguro para thread se o campo puder ser modificado simultaneamente.

@item 
`Macros': Macros de acesso como @ref{4bf8,,PyList_GET_ITEM} e @ref{38e,,PyList_SET_ITEM} não executam nenhuma verificação por erros e nenhum travamento. Essas macros não são seguras para thread se o objeto contêiner puder ser modificado simultaneamente.

@item 
`Referências emprestadas': as funções da API C que retornam @ref{33e,,referências emprestadas} podem não ser seguras para thread se o objeto que as contêm for modificado simultaneamente. Veja a seção sobre @ref{54c4,,referências emprestadas} para mais informações.
@end itemize

@menu
* Segurança de threads de contêineres:: 

@end menu

@node Segurança de threads de contêineres,,,Diretrizes gerais de API
@anchor{howto/free-threading-extensions container-thread-safety}@anchor{54c5}
@subsubsection Segurança de threads de contêineres


Contêineres como @ref{4f30,,PyListObject}, @ref{3c1,,PyDictObject} e @ref{5046,,PySetObject} executam uma trava interna na construção com threads livres. Por exemplo, @ref{4cd9,,PyList_Append()} irá travar a lista antes de anexar um item.

@menu
* PyDict_Next:: 

@end menu

@node PyDict_Next,,,Segurança de threads de contêineres
@anchor{howto/free-threading-extensions id1}@anchor{54c6}@anchor{howto/free-threading-extensions pydict-next}@anchor{54c7}
@subsubsection @code{PyDict_Next}


Uma exceção notável é @ref{16fd,,PyDict_Next()}, que não trava o dicionário. Você deve usar @ref{5028,,Py_BEGIN_CRITICAL_SECTION} para proteger o dicionário enquanto itera sobre ele se o dicionário puder ser modificado simultaneamente:

@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 Referências emprestadas,APIs de alocação de memória,Diretrizes gerais de API,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions borrowed-references}@anchor{54c8}
@subsection Referências emprestadas

@anchor{howto/free-threading-extensions id2}@anchor{54c4}
Algumas funções da API C retornam @ref{33e,,referências emprestadas}. Essas APIs não são seguras para thread se o objeto que as contém for modificado simultaneamente. Por exemplo, não é seguro usar @ref{35a,,PyList_GetItem()} se a lista puder ser modificada simultaneamente.

A tabela a seguir lista algumas APIs de referências emprestadas e suas substituições que retornam @ref{33d,,referências fortes}.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

API de referências emprestadas

@tab

API de referências fortes

@item

@ref{35a,,PyList_GetItem()}

@tab

@ref{359,,PyList_GetItemRef()}

@item

@ref{4bf8,,PyList_GET_ITEM()}

@tab

@ref{359,,PyList_GetItemRef()}

@item

@ref{387,,PyDict_GetItem()}

@tab

@ref{33a,,PyDict_GetItemRef()}

@item

@ref{33c,,PyDict_GetItemWithError()}

@tab

@ref{33a,,PyDict_GetItemRef()}

@item

@ref{388,,PyDict_GetItemString()}

@tab

@ref{33b,,PyDict_GetItemStringRef()}

@item

@ref{340,,PyDict_SetDefault()}

@tab

@ref{33f,,PyDict_SetDefaultRef()}

@item

@ref{16fd,,PyDict_Next()}

@tab

nenhuma (veja @ref{54c7,,PyDict_Next})

@item

@ref{379,,PyWeakref_GetObject()}

@tab

@ref{378,,PyWeakref_GetRef()}

@item

@ref{3bf,,PyWeakref_GET_OBJECT()}

@tab

@ref{378,,PyWeakref_GetRef()}

@item

@ref{357,,PyImport_AddModule()}

@tab

@ref{356,,PyImport_AddModuleRef()}

@end multitable


Nem todas as APIs que retornam referências emprestadas são problemáticas. Por exemplo, @ref{4b61,,PyTuple_GetItem()} é segura porque as tuplas são imutáveis. Da mesma forma, nem todos os usos das APIs acima são problemáticos. Por exemplo, @ref{387,,PyDict_GetItem()} é frequentemente usado para analisar dicionários de argumentos nomeados em chamadas de função; esses dicionários de argumentos nomeados efetivamente privados (não acessíveis por outros threads), portanto, usar referências emprestadas nesse contexto é seguro.

Algumas dessas funções foram adicionadas no Python 3.13. Você pode usar o pacote pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat} para fornecer implementações dessas funções para versões mais antigas do Python.

@node APIs de alocação de memória,APIs da GIL e de estado de threads,Referências emprestadas,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions free-threaded-memory-allocation}@anchor{5218}@anchor{howto/free-threading-extensions memory-allocation-apis}@anchor{54c9}
@subsection APIs de alocação de memória


A API C de gerenciamento de memória do Python fornece funções em três @ref{5213,,domínios de alocação} diferentes: “raw”, “mem” e “object”. Para segurança de thread, a construção com threads livres requer que apenas objetos Python sejam alocados usando o domínio do objeto e que todos os objetos Python sejam alocados usando esse domínio. Isso difere das versões anteriores do Python, onde era apenas uma melhor prática e não um requisito estrito.

@cartouche
@quotation Nota 
Procure usos de @ref{c83,,PyObject_Malloc()} em sua extensão e verifique se a memória alocada é usada para objetos Python. Use @ref{c81,,PyMem_Malloc()} para alocar buffers em vez de @ref{c83,,PyObject_Malloc()}.
@end quotation
@end cartouche

@node APIs da GIL e de estado de threads,Protegendo o estado interno das extensões,APIs de alocação de memória,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions thread-state-and-gil-apis}@anchor{54ca}
@subsection APIs da GIL e de estado de threads


Python fornece um conjunto de funções e macros para gerenciar o estado de threads e a GIL, como:


@itemize *

@item 
@ref{3ab,,PyGILState_Ensure()} e @ref{3ac,,PyGILState_Release()}

@item 
@ref{3a8,,PyEval_SaveThread()} e @ref{3a9,,PyEval_RestoreThread()}

@item 
@ref{4b67,,Py_BEGIN_ALLOW_THREADS} e @ref{a98,,Py_END_ALLOW_THREADS}
@end itemize

Estas funções ainda devem ser usadas na construção com threads livres para gerenciar o estado de threads mesmo quando a @ref{159,,GIL} está desabilitada. Por exemplo, se você criar uma thread fora do Python, você deve chamar @ref{3ab,,PyGILState_Ensure()} antes de chamar a API Python para garantir que a thread tenha um estado de thread válido para o Python.

Você deve continuar a chamar @ref{3a8,,PyEval_SaveThread()} ou @ref{4b67,,Py_BEGIN_ALLOW_THREADS} em torno de operações de travamento, como E/S ou aquisições de trava, para permitir que outras threads executem o @ref{1a69,,coletor de lixo cíclico}.

@node Protegendo o estado interno das extensões,Construindo extensões para a construção com threads livres,APIs da GIL e de estado de threads,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions protecting-internal-extension-state}@anchor{54cb}
@subsection Protegendo o estado interno das extensões


Sua extensão pode ter um estado interno que foi previamente protegido pela GIL. Talvez seja necessário adicionar uma trava para proteger esse estado. A abordagem dependerá da sua extensão, mas alguns padrões comuns incluem:


@itemize *

@item 
`Caches': caches globais são uma fonte comum de estado compartilhado. Considere usar uma trava para proteger o cache ou desativá-lo na construção com threads livres se o cache não for crítico para o desempenho.

@item 
`Estado global': o estado global pode precisar ser protegido por uma trava ou movido para o armazenamento local do thread. C11 e C++11 fornecem @code{thread_local} ou @code{_Thread_local} para armazenamento local de thread@footnote{https://en.cppreference.com/w/c/language/storage_duration}.
@end itemize

@node Construindo extensões para a construção com threads livres,,Protegendo o estado interno das extensões,Suporte a extensões da API C para threads livres
@anchor{howto/free-threading-extensions building-extensions-for-the-free-threaded-build}@anchor{54cc}
@subsection Construindo extensões para a construção com threads livres


As extensões da API C precisam ser construídas especificamente para a construção com threads livres. As wheels, bibliotecas compartilhadas e binários são indicados por um sufixo @code{t}.


@itemize *

@item 
pypa/manylinux@footnote{https://github.com/pypa/manylinux} oferece suporte à construção com threads livres, com o sufixo @code{t}, como @code{python3.13t}.

@item 
pypa/cibuildwheel@footnote{https://github.com/pypa/cibuildwheel} oferece suporte a construção com threads livres se você definir CIBW_ENABLE com cpython-freethreading@footnote{https://cibuildwheel.pypa.io/en/stable/options/#enable}.
@end itemize

@menu
* API C limitada e ABI estável:: 
* Windows: Windows<82>. 

@end menu

@node API C limitada e ABI estável,Windows<82>,,Construindo extensões para a construção com threads livres
@anchor{howto/free-threading-extensions limited-c-api-and-stable-abi}@anchor{54cd}
@subsubsection API C limitada e ABI estável


A construção com threads livres não tem suporte atualmente à @ref{396,,API C limitada} ou à ABI estável. Se você usar setuptools@footnote{https://setuptools.pypa.io/en/latest/setuptools.html} para construir sua extensão e atualmente definir @code{py_limited_api=True}, você pode usar @code{py_limited_api=not sysconfig.get_config_var("Py_GIL_DISABLED")} para não usar a API limitada ao construir com a construção com threads livres.

@cartouche
@quotation Nota 
Você precisará construir wheels separadas especificamente para a construção com threads livres. Se você usa atualmente a ABI estável, poderá continuar a construir uma única wheel para várias versões do Python sem threads livres.
@end quotation
@end cartouche

@node Windows<82>,,API C limitada e ABI estável,Construindo extensões para a construção com threads livres
@anchor{howto/free-threading-extensions windows}@anchor{54ce}
@subsubsection Windows


Devido a uma limitação do instalador oficial do Windows, você precisará definir manualmente @code{Py_GIL_DISABLED=1} ao construir extensões a partir do código-fonte.


@subsubheading Ver também


Portando módulos de extensão para oferecer suporte a threads livres@footnote{https://py-free-threading.github.io/porting/}: um guia de portabilidade mantido pela comunidade para autores de extensões.


Geral:


@itemize *

@item 
@ref{3475,,Uma visão geral conceitual de asyncio}

@item 
@ref{7da,,Boas práticas para anotações}

@item 
@ref{3045,,Tutorial de Argparse}

@item 
@ref{1535,,Guia de descritores}

@item 
@ref{5344,,Enum}

@item 
@ref{5376,,Programação Funcional}

@item 
@ref{3e7f,,Uma introdução ao módulo ipaddress}

@item 
@ref{5395,,Logging}

@item 
@ref{1237,,Livro de receitas do logging}

@item 
@ref{2487,,Expressões Regulares}

@item 
@ref{2314,,Técnicas de ordenação}

@item 
@ref{12e7,,Unicode}

@item 
@ref{3c3e,,Como buscar recursos da Internet usando o pacote urllib}
@end itemize

Desenvolvimento avançado:


@itemize *

@item 
@ref{313d,,Programação em Curses com Python}

@item 
@ref{54af,,Suporte experimental do Python para threads livres}

@item 
@ref{54b2,,Suporte a extensões da API C para threads livres}

@item 
@ref{4b4d,,Isolando módulos de extensão}

@item 
@ref{14f2,,A Ordem de Resolução de Métodos do Python 2.3}

@item 
@ref{3653,,Programação de Soquetes}

@item 
@ref{54a2,,Descritor de arquivo de temporizador}

@item 
@ref{1324,,Portando módulos de extensão para o Python 3}
@end itemize

Depuração e perfilação:


@itemize *

@item 
@ref{5335,,Depurando extensões de API C e internos do CPython com GDB}

@item 
@ref{c87,,Instrumentando o CPython com DTrace e SystemTap}

@item 
@ref{18f,,Suporte do Python ao perfilador perf do Linux}
@end itemize

@node Perguntas Frequentes Sobre Python,Descontinuações,Python HOWTOs,Top
@anchor{faq/index doc}@anchor{54cf}@anchor{faq/index faq-index}@anchor{1e8d}@anchor{faq/index python-frequently-asked-questions}@anchor{54d0}@anchor{faq/index translation-repo}@anchor{54d1}
@chapter Perguntas Frequentes Sobre Python


@menu
* Python Geral:: 
* FAQ sobre programação:: 
* FAQ sobre design e histórico:: 
* FAQ de Bibliotecas e Extensões:: 
* FAQ sobre Extensão/Incorporação:: 
* Python no Windows:: 
* FAQ da Interface Gráfica do Usuário:: 
* FAD de “Por que o Python está instalado em meu computador?”:: 

@end menu

@node Python Geral,FAQ sobre programação,,Perguntas Frequentes Sobre Python
@anchor{faq/general doc}@anchor{54d2}@anchor{faq/general general-python-faq}@anchor{54d3}
@section Python Geral



@menu
* Informações gerais:: 
* Python no mundo real:: 

@end menu

@node Informações gerais,Python no mundo real,,Python Geral
@anchor{faq/general general-information}@anchor{54d4}
@subsection Informações gerais


@menu
* O que é Python?:: 
* O que é a Python Software Foundation?:: 
* Existem restrições de direitos autorais sobre o uso de Python?:: 
* Em primeiro lugar@comma{} por que o Python foi desenvolvido?: Em primeiro lugar por que o Python foi desenvolvido?. 
* Para o que Python é excelente?:: 
* Como funciona o esquema de numeração de versões do Python?:: 
* Como faço para obter uma cópia dos fonte do Python?:: 
* Como faço para obter a documentação do Python?:: 
* Eu nunca programei antes. Existe um tutorial básico do Python?: Eu nunca programei antes Existe um tutorial básico do Python?. 
* Existe um grupo de discussão ou lista de discussão dedicada ao Python?:: 
* Como faço para obter uma versão de teste beta do Python?:: 
* Como eu envio um relatório de erros e correções para o Python?:: 
* Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?:: 
* Existem alguns livros sobre o Python?:: 
* Onde está armazenado o site www.python.org?: Onde está armazenado o site www python org?. 
* Por que o nome Python?:: 
* Eu tenho que gostar de “Monty Python’s Flying Circus”?:: 

@end menu

@node O que é Python?,O que é a Python Software Foundation?,,Informações gerais
@anchor{faq/general what-is-python}@anchor{54d5}
@subsubsection O que é Python?


O Python é uma linguagem de programação interpretada, interativa e orientada a objetos. O mesmo incorporou módulos, exceções, tipagem dinâmica, tipos de dados dinâmicos de alto nível e classes. Há suporte a vários paradigmas de programação além da programação orientada a objetos, tal como programação procedural e funcional. O Python fornece ao desenvolvedor um poder notável aliado a uma sintaxe simples de clara. Possui interfaces para muitas chamadas e bibliotecas do sistema, bem como para vários sistemas de janelas, e é extensível através de linguagem como o C ou C++. Também é utilizado como linguagem de extensão para aplicativos que precisam de uma interface programável. Finalmente, o Python é portátil: o mesmo pode ser executado em várias variantes do Unix, incluindo Linux e Mac, e no Windows.

Para saber mais, inicie pelo nosso tutorial @ref{1d55,,O tutorial do Python}. Os links do Beginner's Guide to Python@footnote{https://wiki.python.org/moin/BeginnersGuide} para outros tutoriais introdutórios e recursos da linguagem Python.

@node O que é a Python Software Foundation?,Existem restrições de direitos autorais sobre o uso de Python?,O que é Python?,Informações gerais
@anchor{faq/general what-is-the-python-software-foundation}@anchor{54d6}
@subsubsection O que é a Python Software Foundation?


O Python Software Foundation é uma organização independente e sem fins lucrativos que detém os direitos autorais sobre as versões 2.1 do Python e as mais recentes. A missão do PSF é avançar a tecnologia de código aberto relacionada à linguagem de programação Python e divulgar a utilização do Python. A página inicial do PSF pode ser acessada pelo link a seguir @indicateurl{https://www.python.org/psf/}.

Doações para o PSF estão isentas de impostos nos EUA. Se utilizares o Python e achares útil, contribua através da página de doação da PSF@footnote{https://www.python.org/psf/donations/}.

@node Existem restrições de direitos autorais sobre o uso de Python?,Em primeiro lugar por que o Python foi desenvolvido?,O que é a Python Software Foundation?,Informações gerais
@anchor{faq/general are-there-copyright-restrictions-on-the-use-of-python}@anchor{54d7}
@subsubsection Existem restrições de direitos autorais sobre o uso de Python?


Podemos fazer tudo o que quisermos com os fontes, desde que deixemos os direitos autorais e exibamos esses direitos em qualquer documentação sobre o Python que produzirmos. Se honrarmos as regras dos direitos autorais, não há quaisquer problema em utilizar o Python em versões comerciais, vendê-lo, copiá-lo na forma de código-fonte ou o seu binária (modificado ou não modificado), ou para vender produtos que incorporem o Python de alguma forma. Ainda gostaríamos de saber sobre todo o uso comercial de Python, é claro.

Veja a página da licença@footnote{https://docs.python.org/3/license.html} para encontrar mais explicações e um link para o texto completo da licença.

O logotipo do Python é marca registrada e, em certos casos, é necessária permissão para usá-la. Consulte a Política de Uso da Marca comercial@footnote{https://www.python.org/psf/trademarks/} para obter mais informações.

@node Em primeiro lugar por que o Python foi desenvolvido?,Para o que Python é excelente?,Existem restrições de direitos autorais sobre o uso de Python?,Informações gerais
@anchor{faq/general why-was-python-created-in-the-first-place}@anchor{54d8}
@subsubsection Em primeiro lugar, por que o Python foi desenvolvido?


Aqui está um resumo `muito' breve de como que tudo começou, escrito por Guido van Rossum:

@quotation

Eu tive vasta experiência na implementação de linguagens interpretada no grupo ABC da CWI e, ao trabalhar com esse grupo, aprendi muito sobre o design de linguagens. Esta é a origem de muitos recursos do Python, incluindo o uso do recuo para o agrupamento de instruções e a inclusão de tipos de dados de alto nível (embora existam diversos detalhes diferentes em Python).

Eu tinha uma série de queixas sobre a linguagem ABC, mas também havia gostado de muitos das suas características. Era impossível estender ABC (ou melhorar a implementação) para remediar minhas queixas – na verdade, a falta de extensibilidade era um dos maiores problemas. Eu tinha alguma experiência com o uso de Modula-2+ e conversei com os designers do Modula-3 e li o relatório do Modula-3. Modula-3 foi a origem da sintaxe e semântica usada nas exceções, e alguns outros recursos do Python.

Eu estava trabalhando no grupo de sistema operacional distribuído da Amoeba na CWI. Precisávamos de uma maneira melhor de administrar o sistema do que escrevendo programas em C ou scripts para a shell Bourne, uma vez que o Amoeba tinha a sua própria interface de chamada do sistema, que não era facilmente acessível a partir do shell Bourne. Minha experiência com o tratamento de erros em Amoeba me conscientizou da importância das exceções como um recurso das linguagens de programação.

Percebi que uma linguagem de script com uma sintaxe semelhante a da ABC, mas com acesso às chamadas do sistema Amoeba, preencheria a necessidade. Percebi também que seria uma boa escrever uma linguagem específica para o Amoeba, então, decidi que precisava de uma linguagem realmente extensível.

Durante as férias do Natal de 1989, tive bastante tempo disponível e então decidi tentar a construção de algo. Durante o ano seguinte, continuei trabalhando em minhas horas vagas, e o Python foi usado no projeto Amoeba com crescente sucesso, e o feedback dos colegas me fez implementar muitas melhorias.

Em fevereiro de 1991, depois de mais de um ano de desenvolvimento, decidi publicar na USENET. O resto está no arquivo @code{Misc/HISTORY}.
@end quotation

@node Para o que Python é excelente?,Como funciona o esquema de numeração de versões do Python?,Em primeiro lugar por que o Python foi desenvolvido?,Informações gerais
@anchor{faq/general what-is-python-good-for}@anchor{54d9}
@subsubsection Para o que Python é excelente?


Python é uma linguagem de programação de propósito geral, de alto nível e que pode ser aplicada em muitos tipos diferentes de problemas.

A linguagem vem com uma grande biblioteca padrão que abrange áreas como processamento de strings (expressões regulares, Unicode, cálculo de diferenças entre arquivos), protocolos de internet (HTTP, FTP, SMTP, XML-RPC, POP, IMAP), engenharia de software (testes de unidade , registro, criação de perfil, análise de código Python) e interfaces de sistema operacional (chamadas de sistema, sistemas de arquivos, soquetes TCP/IP). Veja o sumário de @ref{144,,A Biblioteca Padrão do Python} para ter uma ideia do que está disponível. Uma ampla variedade de extensões de terceiros também está disponível. Consulte o Python Package Index@footnote{https://pypi.org} para encontrar pacotes de seu interesse.

@node Como funciona o esquema de numeração de versões do Python?,Como faço para obter uma cópia dos fonte do Python?,Para o que Python é excelente?,Informações gerais
@anchor{faq/general faq-version-numbering-scheme}@anchor{54da}@anchor{faq/general how-does-the-python-version-numbering-scheme-work}@anchor{54db}
@subsubsection Como funciona o esquema de numeração de versões do Python?


As versões de Python são enumeradas como “A.B.C” ou “A.B”:


@itemize *

@item 
`A' é o número da versão principal - sendo incrementada apenas em grandes mudanças na linguagem.

@item 
`B' é o número da versão menor - sendo incrementada apenas para mudanças menos estruturais.

@item 
`C' é o número para micro versão – sendo incrementada apenas para lançamento com correção de bugs.
@end itemize

Nem todos as versões são lançamentos de correções de erros. Na corrida por um novo lançamento de funcionalidade, uma série de versões de desenvolvimento são feitas, denotadas como alfa, beta ou candidata. As versões alfa são lançamentos iniciais (early releases) em que as interfaces ainda não estão finalizadas; não é inesperado ver uma mudança de interface entre duas versões alfa. As betas são mais estáveis, preservando as interfaces existentes, mas possivelmente adicionando novos módulos, e as candidatas a lançamento são congeladas, sem alterações, exceto quando necessário para corrigir erros críticos.

As versões alpha, beta e candidata a lançamento possuem um sufixo adicional:


@itemize *

@item 
O sufixo para uma versão alfa é “aN” para algum número pequeno `N'.

@item 
O sufixo para uma versão beta é “bN” para algum número pequeno `N'.

@item 
O sufixo para um lançamento em versão candidata é “rcN” para algum número pequeno `N'.
@end itemize

Em outras palavras, todas as versões rotuladas como `2.0aN' precedem as versões rotuladas como `2.0bN', que por sua vez precedem versões rotuladas como `2.0rcN', e `estas' precedem 2.0.

Também podemos encontrar números de versão com um sufixo “+”, por exemplo, “2.2+”. Estas são versões não lançadas, construídas diretamente do repositório de desenvolvimento do CPython. Na prática, após uma última versão menor, a versão é incrementada para a próxima versão secundária, que se torna a versão “a0”, por exemplo, “2.4a0”.

Veja o Developer's Guide@footnote{https://devguide.python.org/developer-workflow/development-cycle/} para mais informações sobre o ciclo de desenvolvimento, e a 
@geindex Propostas de Melhorias do Python; PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} para aprender mais sobre a política de compatibilidade com versões anteriores do Python. Veja também a documentação para @ref{178,,sys.version}, @ref{45c6,,sys.hexversion}, e @ref{6a0,,sys.version_info}.

@node Como faço para obter uma cópia dos fonte do Python?,Como faço para obter a documentação do Python?,Como funciona o esquema de numeração de versões do Python?,Informações gerais
@anchor{faq/general how-do-i-obtain-a-copy-of-the-python-source}@anchor{54dc}
@subsubsection Como faço para obter uma cópia dos fonte do Python?


A última distribuição fonte do Python sempre está disponível no python.org, em @indicateurl{https://www.python.org/downloads/}. As últimas fontes de desenvolvimento podem ser obtidas em @indicateurl{https://github.com/python/cpython/}.

A distribuição fonte é um arquivo .tar com .gzip contendo o código-fonte C completo, a documentação formatada com o Sphinx, módulos de biblioteca Python, programas de exemplo e várias peças úteis de software livremente distribuível. A fonte compilará e executará sem a necessidade de configurações extras na maioria das plataformas UNIX.

Consulte a seção Introdução do Guia do Desenvolvedor Python@footnote{https://devguide.python.org/setup/} para obter mais informações sobre como obter o código-fonte e compilá-lo.

@node Como faço para obter a documentação do Python?,Eu nunca programei antes Existe um tutorial básico do Python?,Como faço para obter uma cópia dos fonte do Python?,Informações gerais
@anchor{faq/general how-do-i-get-documentation-on-python}@anchor{54dd}
@subsubsection Como faço para obter a documentação do Python?


A documentação padrão para a versão atualmente estável do Python está disponível em @indicateurl{https://docs.python.org/3/}. Em EPUB, texto simples e versões HTML para download também estão disponíveis em @indicateurl{https://docs.python.org/3/download.html}.

A documentação é escrita em reStructuredText e processada pela ferramenta de documentação Sphinx@footnote{https://www.sphinx-doc.org/}. Os fonte do reStructuredText para documentação fazem parte da distribuição fonte do Python.

@node Eu nunca programei antes Existe um tutorial básico do Python?,Existe um grupo de discussão ou lista de discussão dedicada ao Python?,Como faço para obter a documentação do Python?,Informações gerais
@anchor{faq/general i-ve-never-programmed-before-is-there-a-python-tutorial}@anchor{54de}
@subsubsection Eu nunca programei antes. Existe um tutorial básico do Python?


Existem inúmeros tutoriais e livros disponíveis. A documentação padrão inclui @ref{1d55,,O tutorial do Python}.

Consulte o Guia do Iniciante@footnote{https://wiki.python.org/moin/BeginnersGuide} para encontrar informações para quem está começando agora na programação Python, incluindo uma lista com tutoriais.

@node Existe um grupo de discussão ou lista de discussão dedicada ao Python?,Como faço para obter uma versão de teste beta do Python?,Eu nunca programei antes Existe um tutorial básico do Python?,Informações gerais
@anchor{faq/general is-there-a-newsgroup-or-mailing-list-devoted-to-python}@anchor{54df}
@subsubsection Existe um grupo de discussão ou lista de discussão dedicada ao Python?


Existe um grupo de notícias @code{comp.lang.python}, e uma lista de discussão, python-list@footnote{https://mail.python.org/mailman/listinfo/python-list}. O grupo notícias e a lista de discussão são conectados um ou outro – se poderes ler as notícias, não será necessário se inscrever na lista de discussão. @code{comp.lang.python} possui bastante postagem, recebendo centenas de postagens todos os dias, e os leitores do Usenet geralmente são mais capazes de lidar com esse volume.

Os anúncios de novas versões do software e eventos podem ser encontrados em comp.lang.python.announce, uma lista moderada de baixo tráfego que recebe cerca de cinco postagens por dia. Está disponível como a lista de discussão python-announce@footnote{https://mail.python.org/mailman3/lists/python-announce-list.python.org/}.

Mais informações sobre outras listas de discussão e grupos de notícias podem ser encontradas em @indicateurl{https://www.python.org/community/lists/}.

@node Como faço para obter uma versão de teste beta do Python?,Como eu envio um relatório de erros e correções para o Python?,Existe um grupo de discussão ou lista de discussão dedicada ao Python?,Informações gerais
@anchor{faq/general how-do-i-get-a-beta-test-version-of-python}@anchor{54e0}
@subsubsection Como faço para obter uma versão de teste beta do Python?


As versões alfa e beta estão disponíveis em @indicateurl{https://www.python.org/downloads/}. Todos os lançamentos são anunciados nos grupos de notícias comp.lang.python e comp.lang.python.announce e na página inicial do Python em @indicateurl{https://www.python.org/}; um feed RSS de notícias está disponível.

Você também pode acessar a versão de desenvolvimento do Python através do Git. Veja O Guia do Desenvolvedor Python@footnote{https://devguide.python.org/} para detalhes.

@node Como eu envio um relatório de erros e correções para o Python?,Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?,Como faço para obter uma versão de teste beta do Python?,Informações gerais
@anchor{faq/general how-do-i-submit-bug-reports-and-patches-for-python}@anchor{54e1}
@subsubsection Como eu envio um relatório de erros e correções para o Python?


Para relatar um bug ou enviar um patch, use o rastreador de problemas em @indicateurl{https://github.com/python/cpython/issues}.

Para mais informações sobre como o Python é desenvolvido, consulte o Guia do Desenvolvedor Python@footnote{https://devguide.python.org/}.

@node Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?,Existem alguns livros sobre o Python?,Como eu envio um relatório de erros e correções para o Python?,Informações gerais
@anchor{faq/general are-there-any-published-articles-about-python-that-i-can-reference}@anchor{54e2}
@subsubsection Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?


Provavelmente será melhor citar o seu livro favorito sobre o Python.

O primeiro artigo@footnote{https://ir.cwi.nl/pub/18204} sobre Python foi escrito em 1991 e atualmente se encontra bastante desatualizado.

@quotation

Guido van Rossum e Jelke de Boer, “Interactively Testing Remote Servers Using the Python Programming Language”, CWI Quarterly, Volume 4, Edição 4 (dezembro de 1991), Amsterdam, pp. 283–303.q
@end quotation

@node Existem alguns livros sobre o Python?,Onde está armazenado o site www python org?,Existem alguns artigos publicados sobre o Python para que eu possa fazer referência?,Informações gerais
@anchor{faq/general are-there-any-books-on-python}@anchor{54e3}
@subsubsection Existem alguns livros sobre o Python?


Sim, há muitos publicados e muitos outros que estão sendo nesse momento escritos!! Veja o wiki python.org em @indicateurl{https://wiki.python.org/moin/PythonBooks} para obter uma listagem.

Você também pode pesquisar livrarias online sobre “Python” e filtrar as referências a respeito do Monty Python; ou talvez procure por “Python” e “linguagem”.

@node Onde está armazenado o site www python org?,Por que o nome Python?,Existem alguns livros sobre o Python?,Informações gerais
@anchor{faq/general where-in-the-world-is-www-python-org-located}@anchor{54e4}
@subsubsection Onde está armazenado o site www.python.org?


A infraestrutura do projeto Python está localizada em todo o mundo e é gerenciada pela equipe de infraestrutura do Python. Detalhes aqui@footnote{https://infra.psf.io}.

@node Por que o nome Python?,Eu tenho que gostar de “Monty Python’s Flying Circus”?,Onde está armazenado o site www python org?,Informações gerais
@anchor{faq/general why-is-it-called-python}@anchor{54e5}
@subsubsection Por que o nome Python?


Quando o Guido van Rossum começou a implementar o Python, o mesmo também estava lendo os scripts publicados do "Monty Python's Flying Circus"@footnote{https://en.wikipedia.org/wiki/Monty_Python}, uma série de comédia da BBC da década de 1970. Van Rossum pensou que precisava de um nome curto, único e ligeiramente misterioso, então resolveu chamar a sua linguagem de Python.

@node Eu tenho que gostar de “Monty Python’s Flying Circus”?,,Por que o nome Python?,Informações gerais
@anchor{faq/general do-i-have-to-like-monty-python-s-flying-circus}@anchor{54e6}
@subsubsection Eu tenho que gostar de “Monty Python’s Flying Circus”?


Não, mas isso ajuda. :)

@node Python no mundo real,,Informações gerais,Python Geral
@anchor{faq/general python-in-the-real-world}@anchor{54e7}
@subsection Python no mundo real


@menu
* Quão estável é o Python?:: 
* Quantas pessoas usam o Python?:: 
* Existe algum projeto significativo feito em Python?:: 
* Quais são os novos desenvolvimentos esperados para o Python no futuro?:: 
* É razoável propor mudanças incompatíveis com o Python?:: 
* O Python é uma boa linguagem para quem está começando na programação agora?:: 

@end menu

@node Quão estável é o Python?,Quantas pessoas usam o Python?,,Python no mundo real
@anchor{faq/general how-stable-is-python}@anchor{54e8}
@subsubsection Quão estável é o Python?


Muito estável. Novos lançamentos estáveis são divulgados aproximadamente de 6 a 18 meses desde 1991, e isso provavelmente continuará. A partir da versão 3.9, o Python terá um novo grande lançamento a cada 12 meses (
@geindex Propostas de Melhorias do Python; PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/}).

Os desenvolvedores lançam versões bugfix de versões mais antigas, então a estabilidade dos lançamentos existentes melhora gradualmente. As liberações de correções de erros, indicadas por um terceiro componente do número da versão (por exemplo, 3.5.3, 3.6.2), são gerenciadas para estabilidade; somente correções para problemas conhecidos são incluídas em uma versão de correções de erros, e é garantido que as interfaces permanecerão as mesmas durante uma série de liberações de correções de erros.

As últimas versões estáveis podem sempre ser encontradas na página de download do Python@footnote{https://www.python.org/downloads/}. O Python 3.x é a versão recomendada e suportada pela maioria das bibliotecas amplamente utilizadas. Python 2.x 
@geindex Propostas de Melhorias do Python; PEP 373
não é mais mantido@footnote{https://peps.python.org/pep-0373/}.

@node Quantas pessoas usam o Python?,Existe algum projeto significativo feito em Python?,Quão estável é o Python?,Python no mundo real
@anchor{faq/general how-many-people-are-using-python}@anchor{54e9}
@subsubsection Quantas pessoas usam o Python?


Provavelmente existem milhões de usuários, embora seja difícil obter uma contagem exata.

O Python está disponível para download gratuito, portanto, não há números de vendas, e o mesmo está disponível em vários diferentes sites e é empacotado em muitas distribuições Linux, portanto, utilizar as estatísticas de downloads não seria a melhor forma para contabilizarmos a base de usuários.

O grupo de notícias comp.lang.python é bastante ativo, mas nem todos os usuários Python postam no grupo ou mesmo o leem regularmente.

@node Existe algum projeto significativo feito em Python?,Quais são os novos desenvolvimentos esperados para o Python no futuro?,Quantas pessoas usam o Python?,Python no mundo real
@anchor{faq/general have-any-significant-projects-been-done-in-python}@anchor{54ea}
@subsubsection Existe algum projeto significativo feito em Python?


Veja a lista em @indicateurl{https://www.python.org/about/success} para obter uma listagem de projetos que usam o Python. Consultar as conferências passadas do Python@footnote{https://www.python.org/community/workshops/} revelará as contribuições de várias empresas e de diferentes organizações.

Os projetos Python de alto perfil incluem o gerenciador de lista de e-mail Mailman@footnote{https://www.list.org} e o servidor de aplicativos Zope@footnote{https://www.zope.dev}. Várias distribuições Linux, mais notavelmente o Red Hat@footnote{https://www.redhat.com}, escreveram parte ou a totalidade dos seus instaladores e software de administração do sistema em Python. Empresas que usam Python internamente incluem Google, Yahoo e Lucasfilm Ltd.

@node Quais são os novos desenvolvimentos esperados para o Python no futuro?,É razoável propor mudanças incompatíveis com o Python?,Existe algum projeto significativo feito em Python?,Python no mundo real
@anchor{faq/general what-new-developments-are-expected-for-python-in-the-future}@anchor{54eb}
@subsubsection Quais são os novos desenvolvimentos esperados para o Python no futuro?


Consulte @indicateurl{https://peps.python.org/} para ver a lista de propostas de aprimoramento do python (PEPs). As PEPs são documentos de design que descrevem novos recursos que foram sugeridos para o Python, fornecendo uma especificação técnica concisa e a sua lógica. Procure uma PEP intitulado de “Python X.Y Release Schedule”, onde X.Y é uma versão que ainda não foi lançada publicamente.

Novos desenvolvimentos são discutidos na lista de discussão python-dev@footnote{https://mail.python.org/mailman3/lists/python-dev.python.org/}.

@node É razoável propor mudanças incompatíveis com o Python?,O Python é uma boa linguagem para quem está começando na programação agora?,Quais são os novos desenvolvimentos esperados para o Python no futuro?,Python no mundo real
@anchor{faq/general is-it-reasonable-to-propose-incompatible-changes-to-python}@anchor{54ec}
@subsubsection É razoável propor mudanças incompatíveis com o Python?


Normalmente não. Já existem milhões de linhas de código Python em todo o mundo, de modo que qualquer alteração na linguagem que invalide mais de uma fração muito pequena dos programas existentes deverá ser desaprovada. Mesmo que possamos fornecer um programa de conversão, ainda haverá o problema de atualizar toda a documentação; muitos livros foram escritos sobre o Python, e não queremos invalidá-los todos de uma vez só.

Fornecer um caminho de atualização gradual será necessário se um recurso precisar ser alterado. A 
@geindex Propostas de Melhorias do Python; PEP 5
PEP 5@footnote{https://peps.python.org/pep-0005/} descreve o procedimento e em seguida introduz alterações incompatíveis com versões anteriores ao mesmo tempo em que minimiza a interrupção dos usuários.

@node O Python é uma boa linguagem para quem está começando na programação agora?,,É razoável propor mudanças incompatíveis com o Python?,Python no mundo real
@anchor{faq/general is-python-a-good-language-for-beginning-programmers}@anchor{54ed}
@subsubsection O Python é uma boa linguagem para quem está começando na programação agora?


Sim.

Ainda é bastante comum que os alunos iniciem com uma linguagem procedimental e estaticamente tipada como Pascal e o C ou um subconjunto do C++ ou do Java. Os alunos podem ser melhor atendidos ao aprender Python como sua primeira linguagem. Python possui uma sintaxe muito simples e consistente e uma grande quantidade de bibliotecas padrão e, o mais importante, o uso do Python em um curso de programação para iniciantes permite aos alunos se concentrarem em habilidades de programação importantes, como a decomposição do problema e o design do tipo de dados. Com Python, os alunos podem ser introduzidos rapidamente em conceitos básicos, como repetições e procedimentos. Provavelmente os mesmos até poderão trabalhar com objetos definidos por ele mesmos logo em seu primeiro curso.

Para um aluno que nunca programou antes, usar uma linguagem estaticamente tipado parece não que não é natural. Isso apresenta uma complexidade adicional que o aluno deverá dominar e geralmente retarda o ritmo do curso. Os alunos estão tentando aprender a pensar como um computador, decompor problemas, projetar interfaces consistentes e encapsular dados. Embora aprender a usar uma linguagem tipicamente estática seja importante a longo prazo, não é necessariamente o melhor tópico a ser abordado no primeiro momento de um curso de programação.

Muitos outros aspectos do Python fazem do mesmo uma excelente linguagem para quem está aprendendo a programar. Como Java, Python possui uma biblioteca padrão grande para que os estudantes possam receber projetos de programação muito cedo no curso e que possam `fazer' trabalhos úteis. As atribuições não estão restritas à calculadora padrão de quatro funções e os programas para verificar o peso. Ao usar a biblioteca padrão, os alunos podem ter a satisfação de trabalhar em aplicações reais à medida que aprendem os fundamentos da programação. O uso da biblioteca padrão também ensina os alunos sobre a reutilização de código. Os módulos de terceiros, como o PyGame, também são úteis para ampliar o alcance dos estudantes.

O interpretador interativo do Python permite aos alunos testarem recursos da linguagem enquanto estão programando. Os mesmos podem manter uma janela com o interpretador executado enquanto digitam o fonte do seu programa numa outra janela. Se eles não conseguirem se lembrar dos métodos de uma lista, eles podem fazer algo assim:

@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

Com o interpretador, a documentação nunca está longe do aluno quando estão programando.

Há também boas IDEs para o Python. O IDLE é uma IDE multiplataforma para o Python e que foi escrito em Python usando o Tkinter. Os usuários do Emacs estarão felizes em saber que existe um ótimo modo Python para Emacs. Todos esses ambientes de programação fornecem destaque de sintaxe, recuo automático e acesso ao interpretador interativo durante o tempo de desenvolvimento. Consulte o wiki do Python@footnote{https://wiki.python.org/moin/PythonEditors} para obter uma lista completa dos ambientes de desenvolvimento para o Python.

Se você quiser discutir o uso do Python na educação, poderás estar interessado em se juntar à lista de discussão edu-sig@footnote{https://www.python.org/community/sigs/current/edu-sig}.

@node FAQ sobre programação,FAQ sobre design e histórico,Python Geral,Perguntas Frequentes Sobre Python
@anchor{faq/programming doc}@anchor{54ee}@anchor{faq/programming programming-faq}@anchor{54ef}@anchor{faq/programming translation-repo}@anchor{54f0}
@section FAQ sobre programação



@menu
* Perguntas gerais:: 
* Núcleo da linguagem:: 
* Números e strings:: 
* Desempenho: Desempenho<4>. 
* Sequencias (Tuplas/Listas): Sequencias Tuplas/Listas. 
* Objetos:: 
* Módulos: Módulos<5>. 

@end menu

@node Perguntas gerais,Núcleo da linguagem,,FAQ sobre programação
@anchor{faq/programming general-questions}@anchor{54f1}
@subsection Perguntas gerais


@menu
* Existe um depurador a nível de código-fonte que possua pontos de interrupção (breakpoints)@comma{} single-stepping@comma{} etc.?: Existe um depurador a nível de código-fonte que possua pontos de interrupção breakpoints single-stepping etc ?. 
* Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?:: 
* Como posso criar um binário independente a partir de um script Python?:: 
* Existem padrões para a codificação ou um guia de estilo utilizado pela comunidade Python?:: 

@end menu

@node Existe um depurador a nível de código-fonte que possua pontos de interrupção breakpoints single-stepping etc ?,Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?,,Perguntas gerais
@anchor{faq/programming is-there-a-source-code-level-debugger-with-breakpoints-single-stepping-etc}@anchor{54f2}
@subsubsection Existe um depurador a nível de código-fonte que possua pontos de interrupção (`breakpoints'), single-stepping, etc.?


Sim.

Vários depuradores para Python estão descritos abaixo, e a função embutida @ref{234,,breakpoint()} permite que você caia em qualquer um desses pontos.

O módulo pdb é um depurador em modo Console simples, mas adequado, para o Python. Faz parte da biblioteca padrão do Python e está documentado no @ref{a5,,manual de referencia da biblioteca}. Você também pode construir do seu próprio depurador usando o código do pdb como um exemplo.

O IDLE é um ambiente interativo de desenvolvimento que faz parte da distribuição padrão do Python (normalmente acessível como Tools/scripts/idle3@footnote{https://github.com/python/cpython/blob/main/Tools/scripts/idle3}), e inclui um depurador gráfico.

O PythonWin é uma IDE feita para o Python que inclui um depurador gráfico baseado no pdb. O depurador do PythonWin colore os pontos de interrupção e tem alguns recursos legais, como a depuração de programas que não são PythonWin. O PythonWin está disponível como parte do projeto pywin32@footnote{https://github.com/mhammond/pywin32} e como parte da distribuição ActivePython@footnote{https://www.activestate.com/products/python/}.

Eric@footnote{https://eric-ide.python-projects.org/} é uma IDE construída com PyQt e o componente de edição Scintilla.

trepan3k@footnote{https://github.com/rocky/python3-trepan/} é um depurador similar ao gdb.

Visual Studio Code@footnote{https://code.visualstudio.com/} é uma IDE com ferramentas de depuração integrada com softwares de controle de versão.

Há uma série de IDE comerciais para desenvolvimento com o Python que inclui depuradores gráficos. Dentre tantas temos:


@itemize *

@item 
Wing IDE@footnote{https://wingware.com/}

@item 
Komodo IDE@footnote{https://www.activestate.com/products/komodo-ide/}

@item 
PyCharm@footnote{https://www.jetbrains.com/pycharm/}
@end itemize

@node Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?,Como posso criar um binário independente a partir de um script Python?,Existe um depurador a nível de código-fonte que possua pontos de interrupção breakpoints single-stepping etc ?,Perguntas gerais
@anchor{faq/programming are-there-tools-to-help-find-bugs-or-perform-static-analysis}@anchor{54f3}
@subsubsection Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?


Sim.

Pylint@footnote{https://pylint.pycqa.org/en/latest/index.html} e Pyflakes@footnote{https://github.com/PyCQA/pyflakes} fazem verificações básicas que te ajudarão a encontrar erros mais cedo.

Verificadores de tipo estático como Mypy@footnote{https://mypy-lang.org/}, Pyre@footnote{https://pyre-check.org/} e Pytype@footnote{https://github.com/google/pytype} conseguem verificar dicas de tipo em código-fonte Python.

@node Como posso criar um binário independente a partir de um script Python?,Existem padrões para a codificação ou um guia de estilo utilizado pela comunidade Python?,Existem ferramentas para ajudar a encontrar bugs ou fazer análise estática de desempenho?,Perguntas gerais
@anchor{faq/programming faq-create-standalone-binary}@anchor{54f4}@anchor{faq/programming how-can-i-create-a-stand-alone-binary-from-a-python-script}@anchor{54f5}
@subsubsection Como posso criar um binário independente a partir de um script Python?


Você não precisa possuir a capacidade de compilar o código Python para C se o que deseja é um programa autônomo que os usuários possam baixar e executar sem ter que instalar a distribuição Python primeiro. Existem várias ferramentas que determinam o conjunto de módulos exigidos por um programa e vinculam esses módulos ao binário do Python para produzir um único executável.

Uma delas é usar a ferramenta `freeze', que está incluída na árvore de código-fonte Python como Tools/freeze@footnote{https://github.com/python/cpython/tree/main/Tools/freeze}. Ela converte o `bytecode' de Python em vetores de C. Com um compilador de C, você consegue incorporar todos os seus módulos em um novo programa, que é então vinculado aos módulos-padrão de Python.

A `freeze' trabalha percorrendo seu código recursivamente, procurando por instruções de importação (ambas as formas), e procurando por módulos tanto no caminho padrão do Python, quanto por módulos embutidos no diretório fonte. Ela então transforma o `bytecode' de módulos Python em código C (inicializadores de vetor que podem ser transformados em objetos código usando o módulo @cite{marshal}), e depois cria um arquivo de configurações personalizado que só contém os módulos embutidos usados no programa. A ferramenta então compila os códigos C e os vincula como o resto do interpretador Python, formando um binário autônomo que funciona exatamente como seu `script'.

Os pacotes a seguir podem ajudar com a criação dos executáveis do console e da GUI:


@itemize *

@item 
Nuitka@footnote{https://nuitka.net/} (Multiplataforma)

@item 
PyInstaller@footnote{https://pyinstaller.org/} (Multiplataforma)

@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} (somente macOS)

@item 
py2exe@footnote{https://www.py2exe.org/} (somente Windows)
@end itemize

@node Existem padrões para a codificação ou um guia de estilo utilizado pela comunidade Python?,,Como posso criar um binário independente a partir de um script Python?,Perguntas gerais
@anchor{faq/programming are-there-coding-standards-or-a-style-guide-for-python-programs}@anchor{54f6}
@subsubsection Existem padrões para a codificação ou um guia de estilo utilizado pela comunidade Python?


Sim. O guia de estilo esperado para módulos e biblioteca padrão possui o nome de PEP8 e você pode acessar a sua documentação em 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}.

@node Núcleo da linguagem,Números e strings,Perguntas gerais,FAQ sobre programação
@anchor{faq/programming core-language}@anchor{54f7}
@subsection Núcleo da linguagem


@menu
* Porque recebo o erro UnboundLocalError quando a variável possui um valor associado?:: 
* Quais são as regras para variáveis locais e globais em Python?:: 
* Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?:: 
* Como definir variáveis globais dentro de módulos?:: 
* Quais são as “melhores práticas” quando fazemos uso da importação de módulos?:: 
* Por que os valores padrão são compartilhados entre objetos?:: 
* Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?:: 
* Qual a diferença entre argumentos e parâmetros?:: 
* Por que ao alterar a lista ‘y’ também altera a lista ‘x’?:: 
* Como escrevo uma função com parâmetros de saída (chamada por referência)?: Como escrevo uma função com parâmetros de saída chamada por referência ?. 
* Como fazer uma função de ordem superior em Python?:: 
* Como faço para copiar um objeto no Python?:: 
* Como posso encontrar os métodos ou atributos de um objeto?:: 
* Como que o meu código pode descobrir o nome de um objeto?:: 
* O que há com a precedência do operador vírgula?:: 
* Existe um equivalente ao operador ternário “?;” do C?: Existe um equivalente ao operador ternário “? ” do C?. 
* É possível escrever instruções de uma só linha ofuscadas em Python?:: 
* O que a barra(/) na lista de parâmetros de uma função significa?: O que a barra / na lista de parâmetros de uma função significa?. 

@end menu

@node Porque recebo o erro UnboundLocalError quando a variável possui um valor associado?,Quais são as regras para variáveis locais e globais em Python?,,Núcleo da linguagem
@anchor{faq/programming faq-unboundlocalerror}@anchor{216c}@anchor{faq/programming why-am-i-getting-an-unboundlocalerror-when-the-variable-has-a-value}@anchor{54f8}
@subsubsection Porque recebo o erro UnboundLocalError quando a variável possui um valor associado?


Pode ser uma surpresa obter a exceção @ref{157f,,UnboundLocalError} em um código previamente funcional quando adicionamos uma instrução de atribuição em algum lugar no corpo de uma função.

Este código:

@example
>>> x = 10
>>> def bar():
...     print(x)
...
>>> bar()
10
@end example

funciona, mas este código:

@example
>>> x = 10
>>> def foo():
...     print(x)
...     x += 1
@end example

resulta em uma @code{UnboundLocalError}:

@example
>>> foo()
Traceback (most recent call last):
  ...
UnboundLocalError: local variable 'x' referenced before assignment
@end example

Isso acontece porque, quando atribuímos um valor a uma variável em determinado escopo, essa variável torna-se local desse escopo, acabando por esconder qualquer outra variável de mesmo nome no escopo externo. Como a última instrução em foo atribui um novo valor a @code{x}, o interpretador a reconhece como uma variável local. Consequentemente, quando o @code{print(x)} anterior tentar exibir a variável local não inicializada, um erro aparece.

No exemplo acima, podemos acessar a variável do escopo externo declarando-a como global:

@example
>>> x = 10
>>> def foobar():
...     global x
...     print(x)
...     x += 1
...
>>> foobar()
10
@end example

Esta declaração explícita é necessária para lembrarmos que estamos modificando o valor da variável no escopo externo (ao contrário da situação superficialmente análoga com variáveis de classe e instância):

@example
>>> print(x)
11
@end example

Podemos fazer algo parecido num escopo aninhado usando a palavra reservada @ref{12ea,,nonlocal}:

@example
>>> def foo():
...    x = 10
...    def bar():
...        nonlocal x
...        print(x)
...        x += 1
...    bar()
...    print(x)
...
>>> foo()
10
11
@end example

@node Quais são as regras para variáveis locais e globais em Python?,Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?,Porque recebo o erro UnboundLocalError quando a variável possui um valor associado?,Núcleo da linguagem
@anchor{faq/programming what-are-the-rules-for-local-and-global-variables-in-python}@anchor{54f9}
@subsubsection Quais são as regras para variáveis locais e globais em Python?


Em Python, as variáveis que são apenas utilizadas (referenciadas) dentro de uma função são implicitamente globais. Se uma variável for associada a um valor em qualquer lugar dentro do corpo da função, presume-se que a mesma seja local, a menos que seja explicitamente declarada como global.

Embora um pouco surpreendente no início, um momento de consideração explica isso. Por um lado, exigir @ref{18a,,global} para variáveis atribuídas fornece uma barreira contra efeitos colaterais indesejados. Por outro lado, se @code{global} fosse necessário para todas as referências globais, você estaria usando @code{global} o tempo todo. Você teria que declarar como global todas as referências a uma função embutida ou a um componente de um módulo importado. Essa desordem anularia a utilidade da declaração de @code{global} para identificar efeitos colaterais.

@node Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?,Como definir variáveis globais dentro de módulos?,Quais são as regras para variáveis locais e globais em Python?,Núcleo da linguagem
@anchor{faq/programming why-do-lambdas-defined-in-a-loop-with-different-values-all-return-the-same-result}@anchor{54fa}
@subsubsection Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?


Suponha que se utilize um laço @cite{for} para definir algumas funções lambdas (ou mesmo funções simples), por exemplo.:

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda: x**2)
@end example

Isso oferece uma lista que contém 5 lambdas que calculam @code{x**2}. Você pensar que, quando invocado, os mesmos retornam, respectivamente, @code{0}, @code{1}, @code{4}, @code{9}, e @code{16}. No entanto, quando realmente tentar, vai ver que todos retornam @code{16}:

@example
>>> squares[2]()
16
>>> squares[4]()
16
@end example

Isso acontece porque @code{x} não é local para os lambdas, mas é definido no escopo externo, e é acessado quando o lambda for chamado — não quando é definido. No final do laço, o valor de @code{x} será @code{4}, e então, todas as funções agora retornarão @code{4**2}, ou seja, @code{16}. Também é possível verificar isso alterando o valor de @code{x} e vendo como os resultados dos lambdas mudam:

@example
>>> x = 8
>>> squares[2]()
64
@end example

Para evitar isso, é necessário salvar os valores nas variáveis locais para os lambdas, para que eles não dependam do valor de @code{x} global:

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda n=x: n**2)
@end example

Aqui, @code{n=x} cria uma nova variável @code{n} local para o lambda e é calculada quando o lambda é definido para que ele tenha o mesmo valor que @code{x} tem nesse ponto no laço. Isso significa que o valor de @code{n} será @code{0} no primeiro “ciclo” do lambda, @code{1} no segundo “ciclo”, @code{2} no terceiro, e assim por diante. Portanto, cada lambda agora retornará o resultado correto:

@example
>>> squares[2]()
4
>>> squares[4]()
16
@end example

Observe que esse comportamento não é peculiar dos lambdas, o mesmo também ocorre com as funções regulares.

@node Como definir variáveis globais dentro de módulos?,Quais são as “melhores práticas” quando fazemos uso da importação de módulos?,Por que os lambdas definidos em um laço com valores diferentes retornam o mesmo resultado?,Núcleo da linguagem
@anchor{faq/programming how-do-i-share-global-variables-across-modules}@anchor{54fb}
@subsubsection Como definir variáveis globais dentro de módulos?


A maneira canônica de compartilhar informações entre módulos dentro de um único programa é criando um módulo especial (geralmente chamado de config ou cfg). Basta importar o módulo de configuração em todos os módulos da sua aplicação; o módulo ficará disponível como um nome global. Como há apenas uma instância de cada módulo, todas as alterações feitas no objeto do módulo se refletem em todos os lugares. Por exemplo:

config.py:

@example
x = 0   # Valor padrão para a configuração de 'x'
@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 que usar um módulo também é a base para a implementação do padrão de projeto Singleton, pela mesma razão.

@node Quais são as “melhores práticas” quando fazemos uso da importação de módulos?,Por que os valores padrão são compartilhados entre objetos?,Como definir variáveis globais dentro de módulos?,Núcleo da linguagem
@anchor{faq/programming what-are-the-best-practices-for-using-import-in-a-module}@anchor{54fc}
@subsubsection Quais são as “melhores práticas” quando fazemos uso da importação de módulos?


Em geral, não use @code{from nomemódulo import *}. Isso desorganiza o espaço de nomes do importador e torna muito mais difícil para as ferramentas de análise estática detectarem nomes indefinidos.

Faça a importação de módulos na parte superior do arquivo. Isso deixa claro quais outros módulos nosso código necessita e evita dúvidas sobre, por exemplo, se o nome do módulo está no escopo. Usar uma importação por linha facilita a adição e exclusão de importações de módulos, porém, usar várias importações num única linha, ocupa menos espaço da tela.

É uma boa prática importar os módulos na seguinte ordem:


@enumerate 

@item 
módulos da biblioteca padrão – por exemplo: @ref{d9,,sys}, @ref{a1,,os}, @ref{6,,argparse} e @ref{b9,,re}

@item 
módulos de biblioteca de terceiros (qualquer instalação feita contida no repositório de códigos na pasta site-packages) – por exemplo: @code{dateutil}, @code{requests} e @code{PIL.Image}

@item 
módulos desenvolvidos localmente
@end enumerate

Às vezes, é necessário transferir as importações para uma função ou classe para evitar problemas com importação circular. Gordon McMillan diz:

@quotation

As importações circulares vão bem onde ambos os módulos utilizam a forma de importação “import <módulo>”. Elas falham quando o 2º módulo quer pegar um nome do primeiro (“from módulo import nome”) e a importação está no nível superior. Isso porque os nomes no primeiro ainda não estão disponíveis, porque o 1º módulo está ocupado importando o 2º.
@end quotation

Nesse caso, se o segundo módulo for usado apenas numa função, a importação pode ser facilmente movida para dentro do escopo dessa função. No momento em que a importação for chamada, o primeiro módulo terá finalizado a inicialização e o segundo módulo poderá ser importado sem maiores complicações.

Também poderá ser necessário mover as importações para fora do nível superior do código se alguns dos módulos forem específicos de uma determinada plataforma (SO). Nesse caso, talvez nem seja possível importar todos os módulos na parte superior do arquivo. Nessas situações devemos importar os módulos que são específicos de cada plataforma antes de necessitar utilizar os mesmos.

Apenas mova as importações para um escopo local, como dentro da definição de função, se for necessário resolver algum tipo de problema, como, por exemplo, evitar importações circulares ou tentar reduzir o tempo de inicialização do módulo. Esta técnica é especialmente útil se muitas das importações forem desnecessárias, dependendo de como o programa é executado. Também podemos desejar mover as importações para uma função se os módulos forem usados somente nessa função. Note que carregar um módulo pela primeira vez pode ser demorado devido ao tempo de inicialização de cada módulo, no entanto, carregar um módulo várias vezes é praticamente imperceptível, tendo somente o custo de processamento de pesquisas no dicionário de nomes. Mesmo que o nome do módulo tenha saído do escopo, o módulo provavelmente estará disponível em @ref{1636,,sys.modules}.

@node Por que os valores padrão são compartilhados entre objetos?,Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?,Quais são as “melhores práticas” quando fazemos uso da importação de módulos?,Núcleo da linguagem
@anchor{faq/programming why-are-default-values-shared-between-objects}@anchor{54fd}
@subsubsection Por que os valores padrão são compartilhados entre objetos?


Este tipo de erro geralmente pega programadores neófitos. Considere esta função:

@example
def foo(meudict=@{@}):  # Perigo: referência compartilhada a um dicionário para todas as chamadas
    ... faz alguma coisa ...
    meudict[chave] = valor
    return meudict
@end example

Na primeira vez que chamar essa função, @code{meudict} vai conter um único item. Na segunda vez, @code{meudict} vai conter dois itens porque, quando @code{foo()} começar a ser executado, @code{meudict} começará com um item já existente.

Muitas vezes, espera-se que ao invocar uma função sejam criados novos objetos referente aos valores padrão. Isso não é o que acontece. Os valores padrão são criados exatamente uma vez, quando a função está sendo definida. Se esse objeto for alterado, como o dicionário neste exemplo, as chamadas subsequentes para a essa função se referirão a este objeto alterado.

Por definição, objetos imutáveis, como números, strings, tuplas e o @code{None}, estão protegidos de sofrerem alteração. Alterações em objetos mutáveis, como dicionários, listas e instâncias de classe, podem levar à confusão.

Por causa desse recurso, é uma boa prática de programação para evitar o uso de objetos mutáveis contendo valores padrão. Em vez disso, utilize @code{None} como o valor padrão e dentro da função, verifique se o parâmetro é @code{None} e crie uma nova lista, dicionário ou o que quer que seja. Por exemplo, escreva o seguinte código:

@example
def foo(meudict=@{@}):
    ...
@end example

mas:

@example
def foo(meudict=None):
    if meudict is None:
        meudict = @{@}  # cria um novo dicionário para o espaço de nomes local
@end example

Esse recurso pode ser útil. Quando se tem uma função que consome muito tempo para calcular, uma técnica comum é armazenar em cache os parâmetros e o valor resultante de cada chamada para a função e retornar o valor em cache se o mesmo valor for solicitado novamente. Isso se chama “memoizar”, e pode ser implementado da seguinte forma:

@example
# Chamadores só podem fornecer dois parâmetros e opcionalmente passar _cache como parâmetro nomeado
def expensive(arg1, arg2, *, _cache=@{@}):
    if (arg1, arg2) in _cache:
        return _cache[(arg1, arg2)]

    # Cacula o valor
    result = ... cálculo custoso ...
    _cache[(arg1, arg2)] = result           # Armazena o resultado no cache
    return result
@end example

Pode-se usar uma variável global contendo um dicionário ao invés do valor padrão; isso é uma questão de gosto.

@node Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?,Qual a diferença entre argumentos e parâmetros?,Por que os valores padrão são compartilhados entre objetos?,Núcleo da linguagem
@anchor{faq/programming how-can-i-pass-optional-or-keyword-parameters-from-one-function-to-another}@anchor{54fe}
@subsubsection Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?


Colete os argumentos usando os especificadores @code{*} ou @code{**} na lista de parâmetros da função. Isso faz com que os argumentos posicionais como tupla e os argumentos nomeados sejam passados como um dicionário. Você pode, também, passar esses argumentos ao invocar outra função usando @code{*} e @code{**}:

@example
def f(x, *args, **kwargs):
    ...
    kwargs['width'] = '14.3c'
    ...
    g(x, *args, **kwargs)
@end example

@geindex argumento;diferença de parâmetro
@geindex parâmetro;diferença de argumento

@node Qual a diferença entre argumentos e parâmetros?,Por que ao alterar a lista ‘y’ também altera a lista ‘x’?,Como passo parâmetros opcionais ou parâmetros nomeados de uma função para outra?,Núcleo da linguagem
@anchor{faq/programming faq-argument-vs-parameter}@anchor{54ff}@anchor{faq/programming what-is-the-difference-between-arguments-and-parameters}@anchor{5500}
@subsubsection Qual a diferença entre argumentos e parâmetros?


@ref{208f,,Parâmetros} são definidos pelos nomes que aparecem na definição da função, enquanto @ref{449,,argumentos} são os valores que serão passados para a função no momento em que esta estiver sendo invocada. Os parâmetros irão definir quais os @ref{208f,,tipos de argumentos} que uma função pode receber. Por exemplo, dada a definição da função:

@example
def func(foo, bar=None, **kwargs):
    pass
@end example

`foo', `bar' e `kwargs' são parâmetros de @code{func}. Dessa forma, ao invocar @code{func}, por exemplo:

@example
func(42, bar=314, extra=algumvalor)
@end example

os valores @code{42}, @code{314}, e @code{algumvalor} são os argumentos.

@node Por que ao alterar a lista ‘y’ também altera a lista ‘x’?,Como escrevo uma função com parâmetros de saída chamada por referência ?,Qual a diferença entre argumentos e parâmetros?,Núcleo da linguagem
@anchor{faq/programming why-did-changing-list-y-also-change-list-x}@anchor{5501}
@subsubsection Por que ao alterar a lista ‘y’ também altera a lista ‘x’?


Se você escreveu um código como:

@example
>>> x = []
>>> y = x
>>> y.append(10)
>>> y
[10]
>>> x
[10]
@end example

pode estar se perguntando por que acrescentar um elemento a @code{y} também mudou @code{x}.

Há dois fatores que produzem esse resultado:


@enumerate 

@item 
As variáveis são simplesmente nomes que referem-se a objetos. Usar @code{y = x} não cria uma cópia da lista. Isso cria uma nova variável @code{y} que faz referência ao mesmo objeto ao qual @code{x} está se referindo. Isso significa que existe apenas um objeto (a lista) e que ambos @code{x} e @code{y} fazem referência a ele.

@item 
Listas são objetos @ref{1d7e,,mutáveis}, o que significa que você pode alterar o seu conteúdo.
@end enumerate

Após a chamada para @ref{2118,,append()}, o conteúdo do objeto mutável mudou de @code{[]} para @code{[10]}. Uma vez que ambas as variáveis referem-se ao mesmo objeto, usar qualquer um dos nomes acessará o valor modificado @code{[10]}.

Se por acaso, atribuímos um objeto imutável a @code{x}:

@example
>>> x = 5  # ints são imutáveis
>>> y = x
>>> x = x + 1  # 5 não pode ser mutado, estamos criando um novo objeto aqui
>>> x
6
>>> y
5
@end example

podemos ver que nesse caso @code{x} e @code{y} não são mais iguais. Isso ocorre porque os números inteiros são @ref{1d79,,imutáveis}, e quando fazemos @code{x = x + 1} não estamos mudando o int @code{5} e incrementando o seu valor. Em vez disso, estamos criando um novo objeto (o int @code{6}) e atribuindo-o a @code{x} (isto é, mudando para o objeto no qual @code{x} se refere). Após esta atribuição, temos dois objetos (os ints @code{6} e @code{5}) e duas variáveis que referem-se a elas (@code{x} agora se refere a @code{6}, mas @code{y} ainda refere-se a @code{5}).

Algumas operações (por exemplo, @code{y.append(10)} e @code{y.sort()}) alteram o objeto, enquanto operações superficialmente semelhantes (por exemplo, @code{y = y + [10]} e @ref{be7,,sorted(y)}) criam um novo objeto. Em geral, em Python (e em todos os casos na biblioteca padrão) um método que causa mutação em um objeto retornará @code{None} para ajudar a evitar confundir os dois tipos de operações. Portanto, se você escrever por engano @code{y.sort()} pensando que lhe dará uma cópia ordenada de @code{y}, você terminará com @code{None}, o que provavelmente fará com que seu programa gere um erro facilmente diagnosticado.

No entanto, há uma classe de operações em que a mesma operação às vezes tem comportamentos diferentes com tipos diferentes: os operadores de atribuição aumentada. Por exemplo, @code{+=} transforma listas, mas não tuplas ou ints (@code{uma_lista += [1, 2, 3]} equivale a @code{uma_lista.extend([1, 2, 3])} a transforma @code{uma_lista}, sendo que @code{alguma_tupla += (1, 2, 3)} e @code{algum_int += 1} cria novos objetos).

Em outras palavras:


@itemize *

@item 
Se tivermos um objeto mutável (@ref{611,,list}, @ref{256,,dict}, @ref{5d9,,set}, etc.), podemos usar algumas operações específicas para alterá-lo e todas as variáveis que fazem referência a ele verão também a mudança.

@item 
Caso tenhamos um objeto imutável (@ref{44c,,str}, @ref{257,,int}, @ref{370,,tuple}, etc.), todas as variáveis que se referem a ele sempre verão o mesmo valor, mas as operações que transformam-se nesses valores sempre retornarão novos objetos.
@end itemize

Caso queira saber se duas variáveis fazem referência ao mesmo objeto ou não, pode-se usar o operador @ref{2f5,,is} ou a função embutida @ref{146a,,id()}.

@node Como escrevo uma função com parâmetros de saída chamada por referência ?,Como fazer uma função de ordem superior em Python?,Por que ao alterar a lista ‘y’ também altera a lista ‘x’?,Núcleo da linguagem
@anchor{faq/programming how-do-i-write-a-function-with-output-parameters-call-by-reference}@anchor{5502}
@subsubsection Como escrevo uma função com parâmetros de saída (chamada por referência)?


Lembre-se de que os argumentos são passados por atribuição em Python. Uma vez que a atribuição apenas cria referências a objetos, não existe apelido entre um nome de argumento no chamador e no chamado e, portanto, não há referência de chamada por si. É possível alcançar o efeito desejado de várias maneiras.


@enumerate 

@item 
Retornando um tupla com os resultados:

@example
>>> def func1(a, b):
...     a = 'valor-novo'       # a e b são nomes locais
...     b = b + 1              # atribuídos a novos objetos
...     return a, b            # retorna novos valores
...
>>> x, y = 'valor-antigo', 99
>>> func1(x, y)
('valor-novo', 100)
@end example

Esta é quase sempre a solução mais clara.

@item 
Utilizando variáveis globais. Essa forma não é segura para thread e, portanto, não é recomendada.

@item 
Pela passagem de um objeto mutável (que possa ser alterado internamente):

@example
>>> def func2(a):
...     a[0] = 'valor-novo'    # 'a' referencia uma lista mutável
...     a[1] = a[1] + 1        # altera um objeto compartilhado
...
>>> args = ['valor-antigo', 99]
>>> func2(args)
>>> args
['valor-novo', 100]
@end example

@item 
Pela passagem de um dicionário que sofra mutação:

@example
>>> def func3(args):
...     args['a'] = 'valor-novo'     # args é um dicionário mutável
...     args['b'] = args['b'] + 1   # alteração local, nele mesmo
...
>>> args = @{'a': 'valor-antigo', 'b': 99@}
>>> func3(args)
>>> args
@{'a': 'valor-novo', 'b': 100@}
@end example

@item 
Ou agrupando valores numa instância de classe:

@example
>>> class Namespace:
...     def __init__(self, /, **args):
...         for key, value in args.items():
...             setattr(self, key, value)
...
>>> def func4(args):
...     args.a = 'valor-novo'        # args é um Namespace mutável
...     args.b = args.b + 1         # alteração local do objeto, nele mesmo
...
>>> args = Namespace(a='valor-antigo', b=99)
>>> func4(args)
>>> vars(args)
@{'a': 'valor-novo', 'b': 100@}
@end example

Quase nunca existe uma boa razão para complicar isso.
@end enumerate

A sua melhor escolha será retornar uma tupla contendo os múltiplos resultados.

@node Como fazer uma função de ordem superior em Python?,Como faço para copiar um objeto no Python?,Como escrevo uma função com parâmetros de saída chamada por referência ?,Núcleo da linguagem
@anchor{faq/programming how-do-you-make-a-higher-order-function-in-python}@anchor{5503}
@subsubsection Como fazer uma função de ordem superior em Python?


Existem duas opções: pode-se usar escopos aninhados ou usar objetos chamáveis. Por exemplo, suponha que queira definir @code{linear(a,b)}, o qual retorna uma função @code{f(x)} que calcula o valor @code{a*x+b}. Usando escopos aninhados, temos:

@example
def linear(a, b):
    def result(x):
        return a * x + b
    return result
@end example

Ou utilizando um objeto chamável:

@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

Em ambos os casos:

@example
taxas = linear(0.3, 2)
@end example

resulta em um objeto chamável, onde @code{taxes(10e6) == 0.3 * 10e6 + 2}.

A abordagem do objeto chamável tem a desvantagem de que é um pouco mais lenta e resulta num código ligeiramente mais longo. No entanto, note que uma coleção de chamáveis pode compartilhar sua assinatura via herança:

@example
class exponential(linear):
    # __init__ herdado
    def __call__(self, x):
        return self.a * (x ** self.b)
@end example

Objetos podem encapsular o estado para vários 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

Aqui @code{inc()}, @code{dec()} e @code{reset()} funcionam como funções que compartilham a mesma variável contadora.

@node Como faço para copiar um objeto no Python?,Como posso encontrar os métodos ou atributos de um objeto?,Como fazer uma função de ordem superior em Python?,Núcleo da linguagem
@anchor{faq/programming how-do-i-copy-an-object-in-python}@anchor{5504}
@subsubsection Como faço para copiar um objeto no Python?


Basicamente, tente utilizar a função @ref{534,,copy.copy()} ou a função @ref{b84,,copy.deepcopy()} para casos gerais. Nem todos os objetos podem ser copiados, mas a maioria poderá.

Alguns objetos podem ser copiados com mais facilidade. Os dicionários têm um método @ref{be9,,copy()}:

@example
novodict = antigodict.copy()
@end example

As sequências podem ser copiadas através do uso de fatiamento:

@example
nova_l = l[:]
@end example

@node Como posso encontrar os métodos ou atributos de um objeto?,Como que o meu código pode descobrir o nome de um objeto?,Como faço para copiar um objeto no Python?,Núcleo da linguagem
@anchor{faq/programming how-can-i-find-the-methods-or-attributes-of-an-object}@anchor{5505}
@subsubsection Como posso encontrar os métodos ou atributos de um objeto?


Para uma instância @code{x} de uma classe definida pelo usuário, @ref{632,,dir(x)} retorna uma lista organizada alfabeticamente dos nomes contidos, os atributos da instância e os métodos e atributos definidos por sua classe.

@node Como que o meu código pode descobrir o nome de um objeto?,O que há com a precedência do operador vírgula?,Como posso encontrar os métodos ou atributos de um objeto?,Núcleo da linguagem
@anchor{faq/programming how-can-my-code-discover-the-name-of-an-object}@anchor{5506}
@subsubsection Como que o meu código pode descobrir o nome de um objeto?


De um modo geral, não pode, porque os objetos realmente não têm nomes. Essencialmente, a atribuição sempre liga um nome a um valor; o mesmo é verdade para as instruções @code{def} e @code{class}, mas nesse caso o valor é um chamável. Considere o seguinte 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

Provavelmente, a classe tem um nome: mesmo que seja vinculada a dois nomes e invocada através do nome @code{B}, a instância criada ainda é relatada como uma instância da classe @code{A}. No entanto, é impossível dizer se o nome da instância é @code{a} ou @code{b}, uma vez que ambos os nomes estão vinculados ao mesmo valor.

De um modo geral, não deveria ser necessário que o seu código “conheça os nomes” de valores específicos. A menos que se escreva deliberadamente programas introspectivos, isso geralmente é uma indicação de que uma mudança de abordagem pode ser benéfica.

Em comp.lang.python, Fredrik Lundh deu uma excelente analogia em resposta a esta pergunta:

@quotation

Da mesma forma que você pega o nome daquele gato que encontrou na sua varanda: o próprio gato (objeto) não pode lhe dizer o seu nome, e ele realmente não se importa – então, a única maneira de descobrir como ele se chama é perguntar a todos os seus vizinhos (espaços de nomes) se é o gato deles (objeto)…

….e não fique surpreso se você descobrir que é conhecido por muitos nomes, ou até mesmo nenhum nome.
@end quotation

@node O que há com a precedência do operador vírgula?,Existe um equivalente ao operador ternário “? ” do C?,Como que o meu código pode descobrir o nome de um objeto?,Núcleo da linguagem
@anchor{faq/programming what-s-up-with-the-comma-operator-s-precedence}@anchor{5507}
@subsubsection O que há com a precedência do operador vírgula?


A vírgula não é um operador em Python. Considere este código:

@example
>>> "a" in "b", "a"
(False, 'a')
@end example

Uma vez que a vírgula não seja um operador, mas um separador entre as expressões acima, o código será avaliado como se tivéssemos entrado:

@example
("a" in "b"), "a"
@end example

não:

@example
"a" in ("b", "a")
@end example

O mesmo é verdade para as várias operações de atribuição (@code{=}, @code{+=} etc). Eles não são operadores de verdade mas delimitadores sintáticos em instruções de atribuição.

@node Existe um equivalente ao operador ternário “? ” do C?,É possível escrever instruções de uma só linha ofuscadas em Python?,O que há com a precedência do operador vírgula?,Núcleo da linguagem
@anchor{faq/programming is-there-an-equivalent-of-c-s-ternary-operator}@anchor{5508}
@subsubsection Existe um equivalente ao operador ternário “?:” do C?


Sim, existe. A sintaxe é a seguinte:

@example
[quando_verdadeiro] if [expressão] else [quando_falso]

x, y = 50, 25
small = x if x < y else y
@end example

Antes que essa sintaxe fosse introduzida no Python 2.5, uma expressão comum era usar operadores lógicos:

@example
[expressão] and [quando_verdadeiro] or [quando_falso]
@end example

No entanto, essa forma não é segura, pois pode dar resultados inesperados quando `quando_verdadeiro' tiver um valor booleano falso. Portanto, é sempre melhor usar a forma @code{... if ... else ...}.

@node É possível escrever instruções de uma só linha ofuscadas em Python?,O que a barra / na lista de parâmetros de uma função significa?,Existe um equivalente ao operador ternário “? ” do C?,Núcleo da linguagem
@anchor{faq/programming is-it-possible-to-write-obfuscated-one-liners-in-python}@anchor{5509}
@subsubsection É possível escrever instruções de uma só linha ofuscadas em Python?


Sim. Normalmente, isso é feito aninhando @ref{12df,,lambda} dentro de @code{lambda}. Veja os três exemplos a seguir, ligeiramente adaptados de Ulf Bartelt:

@example
from functools import reduce

# Primos < 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)))))

# Primeiros 10 números de Fibonacci
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))))

# Conjunto de Mandelbrot
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))
#    \___ ___/  \___ ___/  |   |   |__ linhas na tela
#        V          V      |   |______ colunas na tela
#        |          |      |__________ máximo de "interações"
#        |          |_________________ faixa no eixo y
#        |____________________________ faixa no eixo x
@end example

Não tente isso em casa, crianças!

@node O que a barra / na lista de parâmetros de uma função significa?,,É possível escrever instruções de uma só linha ofuscadas em Python?,Núcleo da linguagem
@anchor{faq/programming faq-positional-only-arguments}@anchor{230b}@anchor{faq/programming what-does-the-slash-in-the-parameter-list-of-a-function-mean}@anchor{550a}
@subsubsection O que a barra(/) na lista de parâmetros de uma função significa?


Uma barra na lista de argumentos de uma função indica que os parâmetros anteriores a ela são somente-posicionais. Os parâmetros somente-posicionais são aqueles que não têm nome utilizável externamente. Ao chamar uma função que aceita parâmetros somente-posicionais, os argumentos são mapeados para parâmetros com base apenas em sua posição. Por exemplo, @ref{9a9,,divmod()} é uma função que aceita parâmetros somente-posicionais. Sua documentação tem esta forma:

@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

A barra no final da lista de parâmetros significa que ambos os parâmetros são somente-posicionais. Assim, chamar @ref{9a9,,divmod()} com argumentos nomeados levaria a um erro:

@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 e strings,Desempenho<4>,Núcleo da linguagem,FAQ sobre programação
@anchor{faq/programming numbers-and-strings}@anchor{550b}
@subsection Números e strings


@menu
* Como faço para especificar números inteiros hexadecimais e octais?:: 
* Por que -22 // 10 retorna -3?:: 
* Como obtenho um atributo de um literal int em vez de SyntaxError?:: 
* Como faço para converter uma string em um número?:: 
* Como faço para converter um número em uma string?:: 
* Como faço para modificar uma string internamente?:: 
* Como faço para invocar funções/métodos através de strings?:: 
* Existe um equivalente em Perl chomp() para remover linhas novas ao final de strings?: Existe um equivalente em Perl chomp para remover linhas novas ao final de strings?. 
* Existe uma função scanf() ou sscanf() ou algo equivalente?: Existe uma função scanf ou sscanf ou algo equivalente?. 
* O que significa o erro UnicodeDecodeError ou UnicodeEncodeError?:: 
* Posso terminar uma string bruta com um número ímpar de contrabarras?:: 

@end menu

@node Como faço para especificar números inteiros hexadecimais e octais?,Por que -22 // 10 retorna -3?,,Números e strings
@anchor{faq/programming how-do-i-specify-hexadecimal-and-octal-integers}@anchor{550c}
@subsubsection Como faço para especificar números inteiros hexadecimais e octais?


Para especificar um dígito no formato octal, preceda o valor octal com um zero e, em seguida, um “o” minúsculo ou maiúsculo. Por exemplo, para definir a variável “a” para o valor octal “10” (8 em decimal), digite:

@example
>>> a = 0o10
>>> a
8
@end example

Hexadecimal é bem fácil. Basta preceder o número hexadecimal com um zero e, em seguida, um “x” minúsculo ou maiúsculo. Os dígitos hexadecimais podem ser especificados em letras maiúsculas e minúsculas. Por exemplo, no interpretador Python:

@example
>>> a = 0xa5
>>> a
165
>>> b = 0XB2
>>> b
178
@end example

@node Por que -22 // 10 retorna -3?,Como obtenho um atributo de um literal int em vez de SyntaxError?,Como faço para especificar números inteiros hexadecimais e octais?,Números e strings
@anchor{faq/programming why-does-22-10-return-3}@anchor{550d}
@subsubsection Por que -22 // 10 retorna -3?


Esta dúvida é primariamente direcionado pelo desejo de que @code{i % j} tenha o mesmo sinal que @code{j}. Se quiser isso, e também quiser:

@example
i == (i // j) * j + (i % j)
@end example

então a divisão inteira deve retornar o piso. C também requer que essa identidade seja mantida, e então os compiladores que truncarem @code{i // j} precisam fazer com que @code{i % j} tenham o mesmo sinal que @code{i}.

Existem poucos casos de uso reais para @code{i % j} quando @code{j} é negativo. Quando @code{j} é positivo, existem muitos, e em virtualmente todos eles é mais útil para @code{i % j} ser @code{>= 0}. Se o relógio marca 10 agora, o que dizia há 200 horas? @code{-190 % 12 == 2} é útil, enquanto @code{-190 % 12 == -10} é um bug esperando para morder.

@node Como obtenho um atributo de um literal int em vez de SyntaxError?,Como faço para converter uma string em um número?,Por que -22 // 10 retorna -3?,Números e strings
@anchor{faq/programming how-do-i-get-int-literal-attribute-instead-of-syntaxerror}@anchor{550e}
@subsubsection Como obtenho um atributo de um literal int em vez de SyntaxError?


Tentar obter um atributo de um literal @code{int} da maneira normal retorna um @ref{18d,,SyntaxError} porque o ponto é visto como um ponto decimal:

@example
>>> 1.__class__
  File "<stdin>", line 1
  1.__class__
   ^
SyntaxError: invalid decimal literal
@end example

A solução é separar o literal do ponto com um espaço ou parênteses.

@example
>>> 1 .__class__
<class 'int'>
>>> (1).__class__
<class 'int'>
@end example

@node Como faço para converter uma string em um número?,Como faço para converter um número em uma string?,Como obtenho um atributo de um literal int em vez de SyntaxError?,Números e strings
@anchor{faq/programming how-do-i-convert-a-string-to-a-number}@anchor{550f}
@subsubsection Como faço para converter uma string em um número?


Para inteiros, use o construtor do tipo embutido @ref{257,,int()}, por exemplo, @code{int('144') == 144}. Da mesma forma, @ref{2f7,,float()} converterá para um número de ponto flutuante, por exemplo @code{float('144') == 144.0}.

Por padrão, eles interpretam o número como decimal, de modo que @code{int('0144') == 144} é verdadeiro e @code{int('0x144')} levanta @ref{202,,ValueError}. @code{int(string, base)} toma a base para converter como um segundo argumento opcional, então @code{int( '0x144', 16) == 324}. Se a base for especificada como 0, o número é interpretado usando as regras do Python: um “0o” à esquerda indica octal e “0x” indica um número hexadecimal.

Não use a função embutida @ref{180,,eval()} se tudo que você precisa é converter strings em números. @ref{180,,eval()} será significativamente mais lento e apresenta um risco de segurança: alguém pode passar a você uma expressão Python que pode ter efeitos colaterais indesejados. Por exemplo, alguém poderia passar @code{__import__('os').system("rm -rf $HOME")} que apagaria seu diretório pessoal.

@ref{180,,eval()} também tem o efeito de interpretar números como expressões Python, de forma que, por exemplo, @code{eval('09')} resulta em um erro de sintaxe porque Python não permite ‘0’ inicial em um número decimal (exceto ‘0’).

@node Como faço para converter um número em uma string?,Como faço para modificar uma string internamente?,Como faço para converter uma string em um número?,Números e strings
@anchor{faq/programming how-do-i-convert-a-number-to-a-string}@anchor{5510}
@subsubsection Como faço para converter um número em uma string?


Para converter, por exemplo, o número @code{144} para a string @code{'144'}, use o construtor do tipo embutido @ref{44c,,str()}. Caso queira uma representação hexadecimal ou octal, use as funções embutidas @ref{1312,,hex()} ou @ref{1311,,oct()}. Para a formatação sofisticada, veja as seções @ref{9b1,,f-strings} e @ref{13e2,,Sintaxe das strings de formato}, por exemplo, @code{"@{:04d@}".format(144)} produz @code{'0144'} e @code{"@{:.3f@}".format(1.0/3.0)} produz @code{'0.333'}.

@node Como faço para modificar uma string internamente?,Como faço para invocar funções/métodos através de strings?,Como faço para converter um número em uma string?,Números e strings
@anchor{faq/programming how-do-i-modify-a-string-in-place}@anchor{5511}
@subsubsection Como faço para modificar uma string internamente?


Você não pode fazer isso porque as strings são objetos imutáveis. Na maioria das situações, você simplesmente deve construir uma nova string a partir das várias partes das quais deseja montá-la. No entanto, caso precise de um objeto com a capacidade de modificar dados Unicode internamente, tente usar a classe @ref{f59,,io.StringIO} ou o módulo @ref{7,,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 Como faço para invocar funções/métodos através de strings?,Existe um equivalente em Perl chomp para remover linhas novas ao final de strings?,Como faço para modificar uma string internamente?,Números e strings
@anchor{faq/programming how-do-i-use-strings-to-call-functions-methods}@anchor{5512}
@subsubsection Como faço para invocar funções/métodos através de strings?


Existem várias técnicas.


@itemize *

@item 
A melhor forma é usar um dicionário que mapeie strings para funções. A principal vantagem desta técnica é que estas strings não precisam corresponder aos nomes das funções. Esta é também a principal técnica utilizada para emular uma construção de instrução estilo `case':

@example
def a():
    pass

def b():
    pass

dispatch = @{'go': a, 'stop': b@}  # Note a falta de parênteses para funções

dispatch[get_input()]()  # Note os parênteses ao final para chamar a função
@end example

@item 
Usar a função embutida @ref{bea,,getattr()}:

@example
import foo
getattr(foo, 'bar')()
@end example

Observe que a função @ref{bea,,getattr()} funciona com qualquer objeto, incluindo classes, instâncias de classe, módulos e assim por diante.

A mesma é usado em vários lugares na biblioteca padrão, como este:

@example
class Foo:
    def faz_foo(self):
        ...

    def faz_bar(self):
        ...

f = getattr(instancia_foo, 'faz_' + opname)
f()
@end example

@item 
Use @ref{141,,locals()} para determinar o nome da função:

@example
def minhaFunc():
    print("hello")

fname = "minhaFunc"

f = locals()[fname]
f()
@end example
@end itemize

@node Existe um equivalente em Perl chomp para remover linhas novas ao final de strings?,Existe uma função scanf ou sscanf ou algo equivalente?,Como faço para invocar funções/métodos através de strings?,Números e strings
@anchor{faq/programming is-there-an-equivalent-to-perl-s-chomp-for-removing-trailing-newlines-from-strings}@anchor{5513}
@subsubsection Existe um equivalente em Perl @code{chomp()} para remover linhas novas ao final de strings?


Pode-se utilizar @code{S.rstrip("\r\n")} para remover todas as ocorrência de qualquer terminador de linha que esteja no final da string @code{S} sem remover os espaços em branco. Se a string @code{S} representar mais de uma linha, contendo várias linhas vazias no final, os terminadores de linha de todas linhas em branco serão removidos:

@example
>>> linhas = ("linha 1 \r\n"
...          "\r\n"
...          "\r\n")
>>> linhas.rstrip("\n\r")
'linha 1 '
@end example

Geralmente isso só é desejado ao ler um texto linha por linha, usando @code{S.rstrip()} dessa maneira funciona bem.

@node Existe uma função scanf ou sscanf ou algo equivalente?,O que significa o erro UnicodeDecodeError ou UnicodeEncodeError?,Existe um equivalente em Perl chomp para remover linhas novas ao final de strings?,Números e strings
@anchor{faq/programming is-there-a-scanf-or-sscanf-equivalent}@anchor{5514}
@subsubsection Existe uma função @code{scanf()} ou @code{sscanf()} ou algo equivalente?


Não como tal.

Para a análise de entrada simples, a abordagem mais fácil geralmente é dividir a linha em palavras delimitadas por espaços em branco usando o método @ref{ed9,,split()} de objetos strings e, em seguida, converter as strings decimais para valores numéricos usando a função @ref{257,,int()} ou a função @ref{2f7,,float()}. O método @code{split()} aceita um parâmetro “sep” opcional que é útil se a linha utilizar algo diferente de espaço em branco como separador.

Para análise de entradas de textos mais complicadas, as expressões regulares são mais poderosas do que a @code{sscanf} do C e mais adequadas para essa tarefa.

@node O que significa o erro UnicodeDecodeError ou UnicodeEncodeError?,Posso terminar uma string bruta com um número ímpar de contrabarras?,Existe uma função scanf ou sscanf ou algo equivalente?,Números e strings
@anchor{faq/programming what-does-unicodedecodeerror-or-unicodeencodeerror-error-mean}@anchor{5515}
@subsubsection O que significa o erro @code{UnicodeDecodeError} ou @code{UnicodeEncodeError}?


Consulte @ref{12e7,,Unicode}.

@node Posso terminar uma string bruta com um número ímpar de contrabarras?,,O que significa o erro UnicodeDecodeError ou UnicodeEncodeError?,Números e strings
@anchor{faq/programming can-i-end-a-raw-string-with-an-odd-number-of-backslashes}@anchor{5516}@anchor{faq/programming faq-programming-raw-string-backslash}@anchor{1d78}
@subsubsection Posso terminar uma string bruta com um número ímpar de contrabarras?


Uma string bruta terminando com um número ímpar de contrabarras vai escapar as aspas da string:

@example
>>> r'C:\isso\não\vai\funcionar\'
  File "<stdin>", line 1
    r'C:\isso\não\vai\funcionar\'
    ^
SyntaxError: unterminated string literal (detected at line 1)
@end example

Há várias soluções alternativas para isso. Uma delas é usar strings regulares e duplicar as contrabarras:

@example
>>> 'C:\\isso\\vai\\funcionar\\'
'C:\\isso\\vai\\funcionar\\'
@end example

Outra é concatenar uma string regular contendo uma contrabarra de escape à string bruta:

@example
>>> r'C:\isso\vai\funcionar' '\\'
'C:\\isso\\vai\\funcionar\\'
@end example

Também é possível usar @ref{171f,,os.path.join()} para acrescentar uma contrabarra no Windows:

@example
>>> os.path.join(r'C:\isso\vai\funcionar', '@w{'})
'C:\\isso\\vai\\funcionar\\'
@end example

Note que, embora uma contrabarra vai “escapar” uma aspa para fins de determinar onde a string bruta termina, nenhum escape ocorre ao interpretar o valor da string bruta. Ou seja, a contrabarra permanece presente no valor da string bruta:

@example
>>> r'contrabarra\'preservada'
"contrabarra\\'preservada"
@end example

Veja também a especificação na @ref{2031,,referência da linguagem}.

@node Desempenho<4>,Sequencias Tuplas/Listas,Números e strings,FAQ sobre programação
@anchor{faq/programming performance}@anchor{5517}
@subsection Desempenho


@menu
* Meu programa está muito lento. Como faço para melhorar o desempenho?: Meu programa está muito lento Como faço para melhorar o desempenho?. 
* Qual é a maneira mais eficiente de concatenar muitas strings?:: 

@end menu

@node Meu programa está muito lento Como faço para melhorar o desempenho?,Qual é a maneira mais eficiente de concatenar muitas strings?,,Desempenho<4>
@anchor{faq/programming my-program-is-too-slow-how-do-i-speed-it-up}@anchor{5518}
@subsubsection Meu programa está muito lento. Como faço para melhorar o desempenho?


Isso geralmente é algo difícil de conseguir. Primeiro, aqui está uma lista de situações que devemos lembrar para melhorar o desempenho da nossa aplicação antes de buscarmos outras soluções:


@itemize *

@item 
As características da desempenho podem variar conforme a implementação do Python. Esse FAQ se concentra no @ref{6f6,,CPython}.

@item 
O comportamento pode variar em cada sistemas operacionais, especialmente quando estivermos tratando de E/S ou multi-threading.

@item 
Sempre devemos encontrar os hot spots em nosso programa `antes de' tentar otimizar qualquer código (veja o módulo @ref{af,,profile}).

@item 
Escrever scripts de benchmark permitirá iterar rapidamente buscando melhorias (veja o módulo @ref{ef,,timeit}).

@item 
É altamente recomendável ter boa cobertura de código (através de testes de unidade ou qualquer outra técnica) antes de potencialmente apresentar regressões escondidas em otimizações sofisticadas.
@end itemize

Dito isto, existem muitos truques para acelerar nossos códigos Python. Aqui estão alguns dos principais tópicos e que geralmente ajudam a atingir níveis de desempenho aceitáveis:


@itemize *

@item 
Fazer seus algoritmos rápidos (ou mudando para mais rápidos) podem produzir benefícios maiores que tentar encaixar várias micro-otimizações no seu código.

@item 
Usar as estruturas de dados corretas. Estude a documentação para @ref{2322,,Tipos embutidos} e o módulo @ref{1d,,collections}.

@item 
Quando a biblioteca padrão fornecer um tipo primitivo para fazer algo, é provável (embora não garantido) que isso seja mais rápido do que qualquer alternativa que possa surgir. Isso geralmente é verdade para os tipos primitivos escritos em C, como os embutidos e alguns tipos de extensão. Por exemplo, certifique-se de usar o método embutido @ref{be8,,list.sort()} ou a função relacionada @ref{be7,,sorted()} para fazer a ordenação (e veja @ref{2314,,Técnicas de ordenação} para exemplos de uso moderadamente avançado).

@item 
As abstrações tendem a criar indireções e forçar o interpretador a trabalhar mais. Se os níveis de indireção superarem a quantidade de trabalho útil feito, seu programa ficará mais lento. Você deve evitar a abstração excessiva, especialmente sob a forma de pequenas funções ou métodos (que também são muitas vezes prejudiciais à legibilidade).
@end itemize

Se você atingiu o limite do que Python puro pode permitir, existem ferramentas para levá-lo mais longe. Por exemplo, o Cython@footnote{https://cython.org} pode compilar uma versão ligeiramente modificada do código Python numa extensão C e pode ser usado em muitas plataformas diferentes. O Cython pode tirar proveito da compilação (e anotações tipo opcional) para tornar o seu código significativamente mais rápido do que quando interpretado. Se você está confiante em suas habilidades de programação C, também pode @ref{1d56,,escrever um módulo de extensão de C}.


@subsubheading Ver também


A página wiki dedicada a dicas de desempenho@footnote{https://wiki.python.org/moin/PythonSpeed/PerformanceTips}.


@node Qual é a maneira mais eficiente de concatenar muitas strings?,,Meu programa está muito lento Como faço para melhorar o desempenho?,Desempenho<4>
@anchor{faq/programming efficient-string-concatenation}@anchor{5519}@anchor{faq/programming what-is-the-most-efficient-way-to-concatenate-many-strings-together}@anchor{551a}
@subsubsection Qual é a maneira mais eficiente de concatenar muitas strings?


Objetos das classes @ref{44c,,str} e @ref{1c2,,bytes} são imutáveis e, portanto, concatenar muitas strings é ineficiente, pois cada concatenação criará um novo objeto. No caso geral, o custo total do tempo de execução é quadrático no comprimento total da string.

Para juntar vários objetos @ref{44c,,str}, a linguagem recomendada colocá-los numa lista e invocar o método @ref{2340,,str.join()}:

@example
chunks = []
for s in my_strings:
    chunks.append(s)
result = '@w{'}.join(chunks)
@end example

(outra forma razoavelmente eficiente é usar a classe @ref{f59,,io.StringIO})

Para juntar vários objetos @ref{1c2,,bytes}, a forma recomendada é estender uma classe @ref{2ea,,bytearray} usando a concatenação local (com o operador @code{+=}):

@example
result = bytearray()
for b in my_bytes_objects:
    result += b
@end example

@node Sequencias Tuplas/Listas,Objetos,Desempenho<4>,FAQ sobre programação
@anchor{faq/programming sequences-tuples-lists}@anchor{551b}
@subsection Sequencias (Tuplas/Listas)


@menu
* Como faço para converter tuplas em listas?:: 
* O que é um índice negativo?:: 
* Como que eu itero uma sequência na ordem inversa?:: 
* Como que removo itens duplicados de uma lista?:: 
* How do you remove multiple items from a list?:: 
* Como fazer um vetor em Python?:: 
* Como faço para criar uma lista multidimensional?:: 
* Como eu aplico um método ou função para uma sequência de objetos?:: 
* Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?:: 
* Quero fazer uma ordenação confusa; você pode fazer uma transformação schwartziana em Python?: Quero fazer uma ordenação confusa você pode fazer uma transformação schwartziana em Python?. 
* Como eu posso ordenar uma lista pelos valores de outra lista?:: 

@end menu

@node Como faço para converter tuplas em listas?,O que é um índice negativo?,,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-i-convert-between-tuples-and-lists}@anchor{551c}
@subsubsection Como faço para converter tuplas em listas?


O construtor de tipo @code{tuple(seq)} converte qualquer sequência (na verdade, qualquer iterável) numa tupla com os mesmos itens na mesma ordem.

Por exemplo, @code{tuple([1, 2, 3])} produz @code{(1, 2, 3)} e @code{tuple('abc')} produz @code{('a', 'b', 'c')}. Se o argumento for uma tupla, a mesma não faz uma cópia, mas retorna o mesmo objeto, por isso é barato invocar a função @ref{370,,tuple()} quando você não tiver certeza que determinado objeto já é uma tupla.

O construtor de tipos @code{list(seq)} converte qualquer sequência ou iterável em uma lista com os mesmos itens na mesma ordem. Por exemplo, @code{list((1, 2, 3))} produz @code{[1, 2, 3]} e @code{list('abc')} produz @code{['a', 'b', 'c']}. Se o argumento for uma lista, o meso fará uma cópia como em @code{seq[:]}.

@node O que é um índice negativo?,Como que eu itero uma sequência na ordem inversa?,Como faço para converter tuplas em listas?,Sequencias Tuplas/Listas
@anchor{faq/programming what-s-a-negative-index}@anchor{551d}
@subsubsection O que é um índice negativo?


Sequências em Python são indexadas com números positivos e números negativos. Para números positivos, 0 é o índice do primeiro elemento, 1 é o índice do segundo elemento e assim por diante. Para números negativos, -1 é índice do último elemento e -2 é o penúltimo (anterior ao último) índice e assim por diante. Pense em @code{seq[-n]} como o mesmo que @code{seq[len(seq)-n]}.

Usar índices negativos pode ser muito conveniente. Por exemplo, @code{S[:-1]} é a string inteira exceto pelo seu último caractere, o que é útil para remover o caractere de nova linha no final de uma string.

@node Como que eu itero uma sequência na ordem inversa?,Como que removo itens duplicados de uma lista?,O que é um índice negativo?,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-i-iterate-over-a-sequence-in-reverse-order}@anchor{551e}
@subsubsection Como que eu itero uma sequência na ordem inversa?


Use a função embutida @ref{869,,reversed()}:

@example
for x in reversed(sequence):
    ...  # faz alguma coisa com x ...
@end example

Isso não vai alterar sua sequência original, mas construir uma nova cópia com a ordem inversa para iteração.

@node Como que removo itens duplicados de uma lista?,How do you remove multiple items from a list?,Como que eu itero uma sequência na ordem inversa?,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-you-remove-duplicates-from-a-list}@anchor{551f}
@subsubsection Como que removo itens duplicados de uma lista?


Veja o Python Cookbook para uma longa discussão de várias formas de fazer isso:

@quotation

@indicateurl{https://code.activestate.com/recipes/52560/}
@end quotation

Se você não se importar em reordenar a lista, ordene-a e depois examine a partir do final da lista, excluindo duplicatas conforme avança:

@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

Se todos os elementos da lista podem ser usados como chaves de conjunto (isto é, eles são todos @ref{610,,hasheáveis}) isso é muitas vezes mais rápido

@example
mylist = list(set(mylist))
@end example

Isso converte a lista em um conjunto, deste modo removendo itens duplicados, e depois de volta em uma lista.

@node How do you remove multiple items from a list?,Como fazer um vetor em Python?,Como que removo itens duplicados de uma lista?,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-you-remove-multiple-items-from-a-list}@anchor{5520}
@subsubsection How do you remove multiple items from a list?


As with removing duplicates, explicitly iterating in reverse with a
delete condition is one possibility.  However, it is easier and faster
to use slice replacement with an implicit or explicit forward iteration.
Here are three variations:

@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

A compreensão de lista pode ser a mais rápida.

@node Como fazer um vetor em Python?,Como faço para criar uma lista multidimensional?,How do you remove multiple items from a list?,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-you-make-an-array-in-python}@anchor{5521}
@subsubsection Como fazer um vetor em Python?


Utilize uma lista:

@example
["isto", 1, "é", "um", "vetor"]
@end example

Listas são equivalentes aos vetores de C ou Pascal em termos de complexidade de tempo; a diferença primária é que uma lista em Python pode conter objetos de tipos diferentes.

O módulo @code{array} também provê métodos para criar vetores de tipos fixos com representações compactas, mas eles são mais lentos para indexar que listas.  Observe também que NumPy@footnote{https://numpy.org/} e outros pacotes de terceiros definem estruturas semelhantes a arrays com várias características.

Para obter listas ligadas no estilo Lisp, você pode emular `células cons' usando tuplas:

@example
lista_lisp = ("como",  ("este",  ("exemplo", None) ) )
@end example

Se mutabilidade é desejada, você pode usar listas no lugar de tuplas.  Aqui o análogo de um `car' Lisp é  @code{lista_lisp[0]} e o análogo de `cdr' é @code{lista_lisp[1]}.  Faça isso somente se você tem certeza que precisa disso, porque isso é usualmente muito mais lento que usar listas Python.

@node Como faço para criar uma lista multidimensional?,Como eu aplico um método ou função para uma sequência de objetos?,Como fazer um vetor em Python?,Sequencias Tuplas/Listas
@anchor{faq/programming faq-multidimensional-list}@anchor{233f}@anchor{faq/programming how-do-i-create-a-multidimensional-list}@anchor{5522}
@subsubsection Como faço para criar uma lista multidimensional?


Você provavelmente tentou fazer um vetor multidimensional assim:

@example
>>> A = [[None] * 2] * 3
@end example

Isso parece correto se você imprimir:

@c A = [[None] * 2] * 3

@example
>>> A
[[None, None], [None, None], [None, None]]
@end example

Mas quando atribuíres um valor, o mesmo aparecerá em vários lugares:

@c A = [[None] * 2] * 3

@example
>>> A[0][0] = 5
>>> A
[[5, None], [5, None], [5, None]]
@end example

A razão é que replicar uma lista com @code{*} não cria cópias, ela apenas cria referências aos objetos existentes. O @code{*3} cria uma lista contendo 3 referências para a mesma lista que contém 2 itens cada. Mudanças numa linha serão mostradas em todas as linhas, o que certamente não é o que você deseja.

A abordagem sugerida é criar uma lista com o comprimento desejado primeiro e, em seguida, preencher cada elemento com uma lista recém-criada:

@example
A = [None] * 3
for i in range(3):
    A[i] = [None] * 2
@end example

Isso gera uma lista contendo 3 listas diferentes contendo 2 itens cada. Você também pode usar uma compreensão de lista:

@example
w, h = 2, 3
A = [[None] * w for i in range(h)]
@end example

Ou você pode usar uma extensão que provê um tipo de dados matrix; NumPy@footnote{https://numpy.org/} é o mais conhecido.

@node Como eu aplico um método ou função para uma sequência de objetos?,Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?,Como faço para criar uma lista multidimensional?,Sequencias Tuplas/Listas
@anchor{faq/programming how-do-i-apply-a-method-or-function-to-a-sequence-of-objects}@anchor{5523}
@subsubsection Como eu aplico um método ou função para uma sequência de objetos?


Para chamar um método ou função e acumular os valores retornados como uma lista, uma @ref{6ce,,compreensão de lista} é uma solução elegante:

@example
result = [obj.method() for obj in mylist]

result = [function(obj) for obj in mylist]
@end example

Para apenas chamar o método ou função sem salvar os valores retornados, um laço @ref{2f2,,for} será o suficiente:

@example
for obj in mylist:
    obj.method()

for obj in mylist:
    function(obj)
@end example

@node Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?,Quero fazer uma ordenação confusa você pode fazer uma transformação schwartziana em Python?,Como eu aplico um método ou função para uma sequência de objetos?,Sequencias Tuplas/Listas
@anchor{faq/programming faq-augmented-assignment-tuple-error}@anchor{2143}@anchor{faq/programming why-does-a-tuple-i-item-raise-an-exception-when-the-addition-works}@anchor{5524}
@subsubsection Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?


Isso se deve a uma combinação do fato de que os operadores de atribuição aumentada são operadores de `atribuição' e à diferença entre objetos mutáveis e imutáveis no Python.

Essa discussão se aplica em geral quando operadores de atribuição aumentada são aplicados a elementos de uma tupla que aponta para objetos mutáveis, mas usaremos uma @code{lista}  e @code{+=} como exemplo.

Se você escrever:

@example
>>> a_tuple = (1, 2)
>>> a_tuple[0] += 1
Traceback (most recent call last):
   ...
TypeError: 'tuple' object does not support item assignment
@end example

O motivo da exceção deve ser imediatamente claro: @code{1} é adicionado ao objeto que @code{a_tuple[0]} aponta para (@code{1}), produzindo o objeto de resultado, @code{2}, mas quando tentamos atribuir o resultado do cálculo, @code{2}, ao elemento @code{0} da tupla, recebemos um erro porque não podemos alterar o que um elemento de uma tupla aponta.

Por baixo, o que a instrução de atribuição aumentada está fazendo é aproximadamente isso:

@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

Essa é a parte da atribuição da operação que produz o erro, já que a tupla é imutável.

Quando você escreve algo como:

@example
>>> a_tuple = (['foo'], 'bar')
>>> a_tuple[0] += ['item']
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

A exceção é um pouco mais surpreendente, e ainda mais surpreendente é o fato de que, embora tenha havido um erro, o acréscimo à lista funcionou:

@example
>>> a_tuple[0]
['foo', 'item']
@end example

Para entender por que isso acontece, você precisa saber que (a) se um objeto implementa um método mágico @ref{2123,,__iadd__()}, ele é chamado quando a atribuição aumentada @code{+=} é executada, e seu valor de retorno é o que é usado na instrução de atribuição; e (b) para listas, @code{__iadd__()} é equivalente a chamar @ref{211b,,extend()} na lista e retornar a lista. É por isso que dizemos que, para listas, @code{+=} é uma “abreviação” para @ref{35d,,list.extend()}:

@example
>>> a_list = []
>>> a_list += [1]
>>> a_list
[1]
@end example

Isso equivale a:

@example
>>> result = a_list.__iadd__([1])
>>> a_list = result
@end example

O objeto apontado por a_list foi alterado e o ponteiro para o objeto alterado é atribuído novamente a @code{a_list}. O resultado final da atribuição é um no-op, pois é um ponteiro para o mesmo objeto para o qual @code{a_list} estava apontando anteriormente, mas a atribuição ainda acontece.

Portanto, em nosso exemplo da tupla, o que está acontecendo é 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

O @code{__iadd__()} é bem-sucedido e, portanto, a lista é estendida, mas mesmo que @code{result} aponte para o mesmo objeto para o qual @code{a_tuple[0]} já aponta, essa atribuição final ainda resulta em um erro, pois as tuplas são imutáveis.

@node Quero fazer uma ordenação confusa você pode fazer uma transformação schwartziana em Python?,Como eu posso ordenar uma lista pelos valores de outra lista?,Porque uma_tupla[i] += [‘item’] levanta uma exceção quando a adição funciona?,Sequencias Tuplas/Listas
@anchor{faq/programming i-want-to-do-a-complicated-sort-can-you-do-a-schwartzian-transform-in-python}@anchor{5525}
@subsubsection Quero fazer uma ordenação confusa: você pode fazer uma transformação schwartziana em Python?


A técnica, atribuída a Randal Schwartz da comunidade Perl, ordena os elementos de uma lista por uma métrica que mapeia cada elemento para seu “valor de ordem”. Em Python, use o argumento @code{key} para o método @ref{be8,,list.sort()}:

@example
Isorted = L[:]
Isorted.sort(key=lambda s: int(s[10:15]))
@end example

@node Como eu posso ordenar uma lista pelos valores de outra lista?,,Quero fazer uma ordenação confusa você pode fazer uma transformação schwartziana em Python?,Sequencias Tuplas/Listas
@anchor{faq/programming how-can-i-sort-one-list-by-values-from-another-list}@anchor{5526}
@subsubsection Como eu posso ordenar uma lista pelos valores de outra lista?


Combine-as em um iterador de tuplas, ordene a lista resultante e, em seguida, escolha o elemento desejado:

@example
>>> list1 = ["lista", "usada", "na", "ordenação"]
>>> list2 = ["alguma", "coisa", "para", "ordenar"]
>>> pairs = zip(list1, list2)
>>> pairs = sorted(pairs)
>>> pairs
[('lista', 'alguma'), ('na', 'para'), ('ordenação', 'ordenar'), ('usada', 'coisa')]
>>> result = [x[1] for x in pairs]
>>> result
['alguma', 'para', 'ordenar', 'coisa']
@end example

@node Objetos,Módulos<5>,Sequencias Tuplas/Listas,FAQ sobre programação
@anchor{faq/programming objects}@anchor{5527}
@subsection Objetos


@menu
* O que é uma classe?:: 
* O que é um método?:: 
* O que é o self?:: 
* Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?:: 
* O que é delegação?:: 
* Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?:: 
* Como eu posso organizar meu código para facilitar a troca da classe base?:: 
* Como faço para criar dados de classe estáticos e métodos de classe estáticos?:: 
* Como eu posso sobrecarregar construtores (ou métodos) em Python?: Como eu posso sobrecarregar construtores ou métodos em Python?. 
* Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam.: Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam. 
* Minha classe define __del__@comma{} mas o mesmo não é chamado quando eu excluo o objeto.: Minha classe define __del__ mas o mesmo não é chamado quando eu excluo o objeto. 
* Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?:: 
* Por que o resultado de id() aparenta não ser único?: Por que o resultado de id aparenta não ser único?. 
* Quando eu posso depender dos testes de identidade com o operador is?:: 
* Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?:: 
* Como faço para armazenar em cache as chamadas de um método?:: 

@end menu

@node O que é uma classe?,O que é um método?,,Objetos
@anchor{faq/programming what-is-a-class}@anchor{5528}
@subsubsection O que é uma classe?


Uma classe é o tipo de objeto específico criado pela execução da instrução class. Os objetos classe são usados como modelos para criar objetos instância, que incorporam os dados (atributos) e o código (métodos) específicos de um tipo de dado.

Uma classe pode ser baseada em uma ou mais outras classes, chamadas de classe(s) base(s), herdando seus atributos e métodos. Isso permite que um modelo de objeto seja sucessivamente refinado por herança.  Você pode ter uma classe genérica @code{Mailbox} que fornece métodos básicos para uma caixa de correio e subclasses como @code{MboxMailbox}, @code{MaildirMailbox}, @code{OutlookMailbox} que manipula vários formatos específicos de caixa de correio.

@node O que é um método?,O que é o self?,O que é uma classe?,Objetos
@anchor{faq/programming what-is-a-method}@anchor{5529}
@subsubsection O que é um método?


Um método é uma função em algum objeto @code{x} que você normalmente chama com @code{x.name(arguments...)}. Métodos são definidos como funções dentro da definição da classe:

@example
class C:
    def meth(self, arg):
        return arg * 2 + self.attribute
@end example

@node O que é o self?,Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?,O que é um método?,Objetos
@anchor{faq/programming what-is-self}@anchor{552a}
@subsubsection O que é o self?


Self é apenas um nome convencional para o primeiro argumento de um método. Um método definido como @code{meth(self, a, b, c)} deve ser chamado com @code{x.meth(a, b, c)} para alguma instância @code{x} da classe em que a definição ocorre; o método chamado pensará que é chamado com @code{meth(x, a, b, c)}.

Veja também @ref{552b,,Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?}.

@node Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?,O que é delegação?,O que é o 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{552c}
@subsubsection Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?


Use a função embutida @ref{442,,isinstance(obj@comma{} cls)}.  Você pode verificar se um objeto é uma instância de qualquer uma de várias classes fornecendo um tupla em vez de uma única classe, por exemplo, @code{isinstance(obj, (class1, class2, ...))}, e também pode verificar se um objeto é de um dos tipos embutidos no Python, por exemplo, @code{isinstance(obj, str)} ou @code{isinstance(obj, (int, float, complex))}.

Observe que @ref{442,,isinstance()} também verifica se há herança virtual de uma @ref{11f5,,classe base abstrata}. Portanto, o teste retorna @code{True} para uma classe registrada, mesmo que não tenha herdado direta ou indiretamente dela. Para testar a “herança verdadeira”, verifique o @ref{15c0,,MRO} da classe:

@example
from collections.abc import Mapping

class P:
     pass

class C(P):
    pass

Mapping.register(P)
@end example

@example
>>> c = C()
>>> isinstance(c, C)        # direta
True
>>> isinstance(c, P)        # indireta
True
>>> isinstance(c, Mapping)  # virtual
True

# Cadeira de herança real
>>> type(c).__mro__
(<class 'C'>, <class 'P'>, <class 'object'>)

# Teste pela "herança verdadeira"
>>> Mapping in type(c).__mro__
False
@end example

Observe que a maioria dos programas não usa @ref{442,,isinstance()} em classes definidas pelo usuário com muita frequência. Se você estiver desenvolvendo as classes por conta própria, um estilo orientado a objetos mais adequado é definir métodos nas classes que encapsulam um comportamento específico, em vez de verificar a classe do objeto e fazer uma coisa diferente com base na classe que ele é. Por exemplo, se você tiver uma função que faz algo:

@example
def search(obj):
    if isinstance(obj, Mailbox):
        ...  # código para pesquisar uma caixa de correio
    elif isinstance(obj, documento):
        ...  # código para pesquisar um documento
    elif ...
@end example

Uma abordagem melhor é definir um método @code{search()} em todas as classes e apenas chamá-lo:

@example
class Mailbox:
    def search(self):
        ...  # código para pesquisar uma caixa de correio

class documento:
    def search(self):
        ...  # código para pesquisar um documento

obj.search()
@end example

@node O que é delegação?,Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?,Como eu verifico se um objeto é uma instância de uma dada classe ou de uma subclasse dela?,Objetos
@anchor{faq/programming what-is-delegation}@anchor{552d}
@subsubsection O que é delegação?


A delegação é uma técnica orientada a objetos (também chamada de padrão de projeto). Digamos que você tenha um objeto @code{x} e queira alterar o comportamento de apenas um de seus métodos. Você pode criar uma nova classe que forneça uma nova implementação do método que você está interessado em alterar e delegar todos os outros métodos ao método correspondente de @code{x}.

Com Python, você pode implementar delegação facilmente. Por exemplo, o trecho de código a seguir implementa uma classe que se comporta como um arquivo, mas converte todos os dados gravados em letras maiú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

Aqui, a classe @code{UpperOut} redefine o método @code{write()} para converter o argumento string em maiúsculas antes de chamar o método @code{self._outfile.write()} subjacente.  Todos os outros métodos são delegados ao objeto @code{self._outfile} subjacente.  A delegação é realizada por meio do método @ref{4d3,,__getattr__()}; consulte @ref{20f1,,a referência da linguagem} para obter mais informações sobre o controle de acesso a atributo.

Observe que, em casos mais gerais, a delegação pode se tornar mais complicada. Quando o atributo precisa ser definido e recuperado, a classe deve definir um método @ref{20bf,,__setattr__()}  também, e deve fazê-lo com cuidado.  A implementação básica do @code{__setattr__()} é aproximadamente equivalente ao seguinte:

@example
class X:
    ...
    def __setattr__(self, name, value):
        self.__dict__[name] = value
    ...
@end example

Muitas implementações do método @ref{20bf,,__setattr__()} chamam o @code{object.__setattr__()} para definir um atributo em si mesmo sem causar recursão infinita:

@example
class X:
    def __setattr__(self, name, value):
        # Lógica personalizada aqui...
        object.__setattr__(self, name, value)
@end example

Como alternativa, é possível definir atributos inserindo entradas em @ref{55b,,self.__dict__} diretamente.

@node Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?,Como eu posso organizar meu código para facilitar a troca da classe base?,O que é delegação?,Objetos
@anchor{faq/programming how-do-i-call-a-method-defined-in-a-base-class-from-a-derived-class-that-extends-it}@anchor{552e}
@subsubsection Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?


Use a função embutida @ref{4db,,super()}:

@example
class Derived(Base):
    def meth(self):
        super().meth()  # chama Base.meth
@end example

No exemplo, @ref{4db,,super()} determinará automaticamente a instância da qual foi chamado (o valor de @code{self}), procura a @ref{2316,,ordem de resolução de métodos} (MRO) com @code{type(self).__mro__} e então retorna o próximo na linha após @code{Derived} no MRO: @code{Base}.

@node Como eu posso organizar meu código para facilitar a troca da classe base?,Como faço para criar dados de classe estáticos e métodos de classe estáticos?,Como eu chamo um método definido em uma classe base a partir de uma classe derivada que a estende?,Objetos
@anchor{faq/programming how-can-i-organize-my-code-to-make-it-easier-to-change-the-base-class}@anchor{552f}
@subsubsection Como eu posso organizar meu código para facilitar a troca da classe base?


Você poderia atribuir a classe base a um apelido e derivar do apelido. Então, tudo o que você precisa alterar é o valor atribuído ao apelido. Aliás, esse truque também é útil se você quiser decidir dinamicamente (por exemplo, dependendo do disponibilidade de recursos) qual classe base usar.  Exemplo:

@example
class Base:
    ...

BaseAlias = Base

class Derived(BaseAlias):
    ...
@end example

@node Como faço para criar dados de classe estáticos e métodos de classe estáticos?,Como eu posso sobrecarregar construtores ou métodos em Python?,Como eu posso organizar meu código para facilitar a troca da classe base?,Objetos
@anchor{faq/programming how-do-i-create-static-class-data-and-static-class-methods}@anchor{5530}
@subsubsection Como faço para criar dados de classe estáticos e métodos de classe estáticos?


Tanto dados estáticos quanto métodos estáticos (no sentido de C++ ou Java) são possíveis com Python.

Para dados estáticos, basta definir um atributo de classe. Para atribuir um novo valor ao atributo, você precisa usar explicitamente o nome da classe na atribuição:

@example
class C:
    count = 0 # número de vezes que C.__init__ foi chamado

    def __init__(self):
        C.count = C.count + 1

    def getcount(self):
        return C.count # ou return self.count
@end example

@code{c.count} também se refere a @code{C.count} para qualquer @code{c} de modo que @code{isinstance(c, C)} seja válido, a menos que seja substituído pelo próprio @code{c} ou por alguma classe no caminho de busca da classe base de @code{c.__class__} até @code{C}.

Cuidado: em um método de C, uma atribuição como @code{self.count = 42} cria uma instância nova e não-relacionada chamada “count” no próprio dicionário de @code{self}.  A revinculação de um nome de dado de classe estático deve sempre especificar a classe, seja dentro de um método ou não:

@example
C.count = 314
@end example

Métodos estáticos são possíveis:

@example
class C:
    @@staticmethod
    def static(arg1, arg2, arg3):
        # Sem parâmetro 'self'!
        ...
@end example

No entanto, uma maneira muito mais direta de obter o efeito de um método estático é por meio de uma simples função em nível de módulo:

@example
def getcount():
    return C.count
@end example

Se o seu código está estruturado de modo a definir uma classe (ou uma hierarquia de classes estreitamente relacionada) por módulo, isso fornecerá o encapsulamento desejado.

@node Como eu posso sobrecarregar construtores ou métodos em Python?,Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam,Como faço para criar dados de classe estáticos e métodos de classe estáticos?,Objetos
@anchor{faq/programming how-can-i-overload-constructors-or-methods-in-python}@anchor{5531}
@subsubsection Como eu posso sobrecarregar construtores (ou métodos) em Python?


Essa resposta na verdade se aplica para todos os métodos, mas a pergunta normalmente aparece primeiro no contexto de construtores.

Em C++ escreveríamos

@example
class C @{
    C() @{ cout << "Sem argumentos\n"; @}
    C(int i) @{ cout << "Argumento é igual a " << i << "\n"; @}
@}
@end example

Em Python, você tem que escrever um único construtor que pega todos os casos usando argumentos padrão. Por exemplo:

@example
class C:
    def __init__(self, i=None):
        if i is None:
            print("Sem argumentos")
        else:
            print("Argumento é igual a", i)
@end example

Isso não é inteiramente equivalente, mas já está bem próximo.

Você também pode tentar uma lista de argumentos de comprimento variável, por exemplo:

@example
def __init__(self, *args):
    ...
@end example

A mesma abordagem funciona para todas as definições de métodos.

@node Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam,Minha classe define __del__ mas o mesmo não é chamado quando eu excluo o objeto,Como eu posso sobrecarregar construtores ou métodos em Python?,Objetos
@anchor{faq/programming i-try-to-use-spam-and-i-get-an-error-about-someclassname-spam}@anchor{5532}
@subsubsection Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam.


Os nomes de variáveis com dois sublinhados à esquerda são “manipulados” para fornecer uma maneira simples, mas eficaz, de definir variáveis privadas de classe.  Qualquer identificador no formato @code{__spam} (pelo menos dois sublinhados à esquerda, no máximo um sublinhado à direita) é textualmente substituído por @code{_classname__spam}, em que @code{classname} é o nome da classe atual sem nenhum sublinhado à esquerda.

O identificador pode ser usado normalmente dentro da classe, mas para acessá-lo fora da classe, deve ser usado o nome manipulado:

@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

Em particular, isso não garante a privacidade, pois um usuário externo ainda pode acessar deliberadamente o atributo privado; muitas pessoas que usam Python nunca se preocuparam em usar nomes de variáveis privadas.


@subsubheading Ver também


O @ref{1e43,,especificações de desfiguração de nome privado} para detalhes e casos especiais.


@node Minha classe define __del__ mas o mesmo não é chamado quando eu excluo o objeto,Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?,Eu tentei usar __spam e recebi um erro sobre _SomeClassName__spam,Objetos
@anchor{faq/programming my-class-defines-del-but-it-is-not-called-when-i-delete-the-object}@anchor{5533}
@subsubsection Minha classe define __del__, mas o mesmo não é chamado quando eu excluo o objeto.


Há várias razões possíveis para isto.

A instrução @ref{18a7,,del} não necessariamente chama o método @ref{1033,,__del__()} - ele simplesmente diminui o contagem de referências do objeto e, se ele chegar a zero, o @code{__del__()} é chamado.

Se suas estruturas de dados contiverem links circulares (por exemplo, uma árvore em que cada filho tem uma referência para o pai e cada pai tem uma lista de filhos), a contagem de referências nunca voltará a zero.  De vez em quando, o Python executa um algoritmo para detectar esses ciclos, mas o coletor de lixo pode ser executado algum tempo depois que a última referência da sua estrutura de dados desaparecer, de modo que o seu método @code{__del__()} pode ser chamado em um momento inconveniente e aleatório. Isso é inconveniente se você estiver tentando reproduzir um problema. Pior ainda, a ordem em quais objetos o métodos @code{__del__()} são executados é arbitrária.  Você pode executar @ref{a43,,gc.collect()} para forçar um coleção, mas `há' casos patológicos em que os objetos nunca serão coletados.

Apesar do coletor de ciclos, ainda é uma boa ideia definir um método @code{close()} explícito nos objetos a ser chamado sempre que você terminar de usá-los.  O método @code{close()} pode então remover o atributo que se refere a subobjetos.  Não chame @code{__del__()} diretamente - @code{__del__()} deve chamar @code{close()} e @code{close()} deve garantir que ele possa ser chamado mais de uma vez para o mesmo objeto.

Outra forma de evitar referências cíclicas é usar o módulo @ref{114,,weakref}, que permite apontar para objetos sem incrementar o contagem de referências. As estruturas de dados em árvore, por exemplo, devem usar o referência fraca para referenciar seus pais e irmãos (se precisarem deles!).

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

Por fim, se seu método @code{__del__()} levanta uma exceção, uma mensagem de alerta será enviada para @ref{940,,sys.stderr}.

@node Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?,Por que o resultado de id aparenta não ser único?,Minha classe define __del__ mas o mesmo não é chamado quando eu excluo o objeto,Objetos
@anchor{faq/programming how-do-i-get-a-list-of-all-instances-of-a-given-class}@anchor{5534}
@subsubsection Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?


Python não mantém o controle de todas as instâncias de uma classe (ou de um tipo embutido). Você pode programar o construtor da classe para manter o controle de todas as instâncias, mantendo uma lista de referências fracas para cada instância.

@node Por que o resultado de id aparenta não ser único?,Quando eu posso depender dos testes de identidade com o operador is?,Como eu consigo pegar uma lista de todas as instâncias de uma dada classe?,Objetos
@anchor{faq/programming why-does-the-result-of-id-appear-to-be-not-unique}@anchor{5535}
@subsubsection Por que o resultado de @code{id()} aparenta não ser único?


A função embutida @ref{146a,,id()} retorna um inteiro que é garantido ser único durante a vida útil do objeto.  Como em CPython esse número é o endereço de memória do objeto, acontece com frequência que, depois que um objeto é excluído da memória, o próximo objeto recém-criado é alocado na mesma posição na memória.  Isso é ilustrado por este exemplo:

@example
>>> id(1000)
13901272
>>> id(2000)
13901272
@end example

Os dois ids pertencem a diferentes objetos inteiros que são criados antes e excluídos imediatamente após a execução da chamada de @code{id()}.  Para ter certeza de que os objetos cujo id você deseja examinar ainda estão vivos, crie outra referencia para o objeto:

@example
>>> a = 1000; b = 2000
>>> id(a)
13901272
>>> id(b)
13891296
@end example

@node Quando eu posso depender dos testes de identidade com o operador is?,Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?,Por que o resultado de id aparenta não ser único?,Objetos
@anchor{faq/programming when-can-i-rely-on-identity-tests-with-the-is-operator}@anchor{5536}
@subsubsection Quando eu posso depender dos testes de identidade com o operador `is'?


O operador @code{is} testa a identidade do objeto. O teste @code{a is b} equivale a @code{id(a) == id(b)}.

A propriedade mais importante de um teste de identidade é que um objeto é sempre idêntico a si mesmo, @code{a is a} sempre retorna @code{True}. Testes de identidade são geralmente mais rápidos do que os testes de igualdade. E, ao contrário dos testes de igualdade, teste de identidade garante que retorno seja um booleano @code{True} ou @code{False}.

Entretanto, o teste de identidade `somente' pode ser substituído por testes de igualdade quando a identidade do objeto é garantida. Em geral, há três circunstâncias em que a identidade é garantida:


@enumerate 

@item 
Atribuições criam novos nomes, mas não alteram a identidade do objeto. Após a atribuição @code{new = old}, é garantido que @code{new is old}.

@item 
Colocar um objeto em um contêiner que armazena referências de objetos não altera a identidade do objeto. Após a lista atribuição @code{s[0] = x}, é garantido que @code{s[0] is x}.

@item 
Se um objeto for um Singleton, isso significa que só pode existir uma instância desse objeto. Depois de atribuição @code{a = None} e @code{b = None}, é garantido que @code{a is b} porque @code{None} é um Singleton.
@end enumerate

Na maioria das outras circunstâncias, o teste de identidade é desaconselhável e os testes de igualdade são preferíveis. Em particular, teste de identidade não deve ser usado para verificar constantes, como @ref{257,,int} e @ref{44c,,str}, que não têm garantia de serem 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

Do mesmo jeito, novas instâncias de contêineres mutáveis nunca são idênticas:

@example
>>> a = []
>>> b = []
>>> a is b
False
@end example

No código da biblioteca padrão, você encontrará vários padrões comuns para usar corretamente o teste de identidade:


@enumerate 

@item 
Conforme recomendado por 
@geindex Propostas de Melhorias do Python; PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}, um teste de identidade é a maneira preferida de verificar @code{None}.  Isso é lido como se fosse inglês simples no código e evita confusão com outros objetos que podem ter valor booleano avaliado para falso.

@item 
A detecção de argumento opcional pode ser complicada quando @code{None} é uma valor de entrada válido.  Nessas situações, você pode criar um objeto Singleton sinalizador com garantia de ser distinto de outros objetos. Por exemplo, veja como implementar um método que se comporta como @ref{343,,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

@item 
Implementações de contêiner às vezes precisam combinar testes de igualdade com testes de identidade. Isso evita que o código seja confundido por objetos como @code{float('NaN')} que não são iguais a si mesmos.
@end enumerate

Por exemplo, aqui está a implementação de @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 Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?,Como faço para armazenar em cache as chamadas de um método?,Quando eu posso depender dos testes de identidade com o operador is?,Objetos
@anchor{faq/programming how-can-a-subclass-control-what-data-is-stored-in-an-immutable-instance}@anchor{5537}
@subsubsection Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?


Quando estender um tipo imutável, sobrescreva o método @ref{580,,__new__()} em vez do método @ref{6b0,,__init__()}.  O último só é executado `depois' que uma instância é criada, o que é tarde demais para alterar os dados em uma instância imutável.

Todas essas classes imutáveis têm um assinatura diferente da sua classe base:

@example
from datetime import date

class FirstOfMonthDate(date):
    "Usa sempre o primeiro dia do mês"
    def __new__(cls, year, month, day):
        return super().__new__(cls, year, month, 1)

class NamedInt(int):
    "Permite o nome em texto para alguns números"
    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):
    "Converte string para um nome adequado para uma URL"
    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

As classes podem ser usadas da seguinte forma:

@example
>>> FirstOfMonthDate(2012, 2, 14)
FirstOfMonthDate(2012, 2, 1)
>>> NamedInt('ten')
10
>>> NamedInt(20)
20
>>> TitleStr('Blog: Porque Python domina')
'blog-porque-python-domina'
@end example

@node Como faço para armazenar em cache as chamadas de um método?,,Como uma subclasse pode controlar quais dados são armazenados em uma instância imutável?,Objetos
@anchor{faq/programming faq-cache-method-calls}@anchor{28e7}@anchor{faq/programming how-do-i-cache-method-calls}@anchor{5538}
@subsubsection Como faço para armazenar em cache as chamadas de um método?


As duas principais ferramentas para armazenamento em cache de métodos são @ref{541,,functools.cached_property()} e @ref{9f7,,functools.lru_cache()}.  A primeira armazena resultados no nível de instância e a segunda no nível de classe.

A abordagem `cached_property' funciona somente com métodos que não aceitam nenhum argumento.  Ela não cria uma referência para a instância. O resultado do método será mantido em cache somente enquanto a instância estiver ativa.

A vantagem é que, quando um instância não for mais usada, o resultado do método armazenado em cache será liberado imediatamente.  A desvantagem é que, se as instâncias se acumularem, os resultados do método também serão acumulados. Eles podem crescer sem limites.

A abordagem `lru_cache' funciona com métodos que têm argumento @ref{610,,hasheável}.  Ele cria uma referência para a instância, a menos que sejam feitos esforços especiais para passar referências fracas.

A vantagem do algoritmo menos recentemente usado é que o cache é limitado pelo `maxsize' especificado.  A desvantagem é que as instâncias são mantidas vivas até que saiam do cache ou até que o cache seja limpo.

Esse exemplo mostra as várias técnicas:

@example
class Weather:
    "Procura informações de tempo em sites governamentais"

    def __init__(self, station_id):
        self._station_id = station_id
        # O _station_id é privado e imutável

    def current_temperature(self):
        "Última observação horária"
        # Não armazena isso em cache porque os dados anteriores
        # podem estar desatualizados.

    @@cached_property
    def location(self):
        "Retornas as coordenadas longitude/latitude coordinates da estação"
        # Resultado depende apenas de station_id

    @@lru_cache(maxsize=20)
    def historic_rainfall(self, date, units='mm'):
        "Precipitação em uma determinada data"
        # Depende de station_id, date, e units.
@end example

O exemplo acima presume que o `station_id' nunca muda. Se os atributos relevantes da instância forem mutáveis, a abordagem `cached_property' não poderá usada porque não é capaz de detectar alterações no atributo.

Para que a abordagem `lru_cache' funcione quando `station_id' for mutável, a classe precisa definir os métodos @ref{b0d,,__eq__()} e @ref{b0e,,__hash__()} para que o cache possa detectar atualizações relevantes do atributo:

@example
class Weather:
    "Exemplo com um identificador de estação mutável"

    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'):
        "Precipitação em uma determinada data"
        # Depende de station_id, date, e units.
@end example

@node Módulos<5>,,Objetos,FAQ sobre programação
@anchor{faq/programming modules}@anchor{5539}
@subsection Módulos


@menu
* Como faço para criar um arquivo .pyc?: Como faço para criar um arquivo pyc?. 
* Como encontro o nome do módulo atual?:: 
* Como posso ter módulos que se importam mutuamente?:: 
* __import__(‘x.y.z’) retorna <módulo ‘x’>; como faço para obter z?: __import__ ‘x y z’ retorna <módulo ‘x’>; como faço para obter z?. 
* Quando eu edito um módulo importado e o reimporto@comma{} as mudanças não aparecem. Por que isso acontece?: Quando eu edito um módulo importado e o reimporto as mudanças não aparecem Por que isso acontece?. 

@end menu

@node Como faço para criar um arquivo pyc?,Como encontro o nome do módulo atual?,,Módulos<5>
@anchor{faq/programming how-do-i-create-a-pyc-file}@anchor{553a}
@subsubsection Como faço para criar um arquivo .pyc?


Quando um módulo é importado pela primeira vez (ou quando o arquivo de origem foi alterado desde que o arquivo compilado atual foi criado), um arquivo @code{.pyc} contendo o código compilado deve ser criado em um subdiretório @code{__pycache__} do diretório que contém o arquivo @code{.py}.  O arquivo @code{.pyc} terá um nome de arquivo que começa com o mesmo nome do arquivo @code{.py} e termina com @code{.pyc}, com um componente intermediário que depende do binário @code{python} específico que o criou.  (Consulte 
@geindex Propostas de Melhorias do Python; PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} para obter detalhes.)

Um dos motivos pelos quais um arquivo @code{.pyc} pode não ser criado é um problema de permissões no diretório que contém o arquivo de origem, o que significa que o subdiretório @code{__pycache__} não pode ser criado. Isso pode acontecer, por exemplo, se você desenvolver como um usuário, mas executar como outro, como se estivesse testando em um servidor web.

A menos que a variável de ambiente 
@geindex PYTHONDONTWRITEBYTECODE
@geindex variável de ambiente; PYTHONDONTWRITEBYTECODE
@ref{1415,,PYTHONDONTWRITEBYTECODE} esteja definida, a criação de um arquivo .pyc será automática se você estiver importando um módulo e o Python tiver a capacidade (permissões, espaço livre etc.) de criar um subdiretório @code{__pycache__} e gravar o módulo compilado nesse subdiretório.

A execução do Python em um script de nível superior não é considerada uma importação e nenhum @code{.pyc} será criado. Por exemplo, se você tiver um módulo de nível superior @code{foo.py} que importa outro módulo @code{xyz.py} , ao executar @code{foo} (digitando @code{python foo.py} no console do sistema operacional (SO)), um @code{.pyc} será criado para @code{xyz} porque @code{xyz} é importado, mas nenhum arquivo @code{.pyc} será criado para @code{foo}, pois @code{foo.py} não está sendo importado.

Se você precisar criar um arquivo @code{.pyc} para @code{foo}, ou seja, criar um arquivo @code{.pyc} para um módulo que não é importado, você pode usar os módulos @ref{b3,,py_compile} e @ref{20,,compileall}.

O módulo @ref{b3,,py_compile} pode compilar manualmente qualquer módulo.  Uma maneira é usar interativamente a função @code{compile()} nesse módulo:

@example
>>> import py_compile
>>> py_compile.compile('foo.py')
@end example

Isso gravará o @code{.pyc} em um subdiretório @code{__pycache__} no mesmo local que @code{foo.py} (ou você pode substituir isso com o parâmetro opcional @code{cfile} ).

Você também pode compilar automaticamente todos os arquivos em um diretório ou diretórios usando o módulo @ref{20,,compileall}.  Você pode fazer isso no console do SO executando @code{compileall.py} e fornecendo o caminho de um diretório que contenha os arquivos Python a serem compilados:

@example
python -m compileall .
@end example

@node Como encontro o nome do módulo atual?,Como posso ter módulos que se importam mutuamente?,Como faço para criar um arquivo pyc?,Módulos<5>
@anchor{faq/programming how-do-i-find-the-current-module-name}@anchor{553b}
@subsubsection Como encontro o nome do módulo atual?


Um módulo pode descobrir seu próprio nome consultando a variável global predefinida @code{__name__} .  Se ela tiver o valor @code{'__main__'} , o programa estará sendo executado como um script.  Muitos módulos que são normalmente usados ao serem importados também fornecem uma interface de linha de comando ou um autoteste, e só executam esse código depois de verificar @code{__name__}:

@example
def main():
    print('Executando teste...')
    ...

if __name__ == '__main__':
    main()
@end example

@node Como posso ter módulos que se importam mutuamente?,__import__ ‘x y z’ retorna <módulo ‘x’>; como faço para obter z?,Como encontro o nome do módulo atual?,Módulos<5>
@anchor{faq/programming how-can-i-have-modules-that-mutually-import-each-other}@anchor{553c}
@subsubsection Como posso ter módulos que se importam mutuamente?


Suponha que tenhas os seguintes módulos:

@code{foo.py}:

@example
from bar importar bar_var
foo_var = 1
@end example

@code{bar.py}:

@example
from foo import foo_var
bar_var = 2
@end example

O problema é que o interpretador vai realizar os seguintes passos:


@itemize *

@item 
Programa principal importa @code{foo}

@item 
São criados globais vazios para @code{foo}

@item 
@code{foo} é compilado e começa a ser executado

@item 
@code{foo} importa @code{bar}

@item 
São criados globais vazios para @code{bar}

@item 
@code{bar} é compilado e começa a ser executado

@item 
@code{bar} importa @code{foo} (o que não é executado de fato, pois já existe um módulo chamado @code{foo})

@item 
O mecanismo de importação tenta ler @code{foo_var} do @code{foo} em globais, para definir @code{bar.foo_var = foo.foo_var}
@end itemize

A última etapa falha, pois Python ainda não terminou de interpretar @code{foo} e o dicionário de símbolos global para @code{foo} ainda está vazio.

O mesmo acontece quando você usa @code{import foo} e, em seguida, tenta acessar @code{foo.foo_var} no código global.

Há (pelo menos) três possíveis soluções alternativas para esse problema.

Guido van Rossum recomenda evitar todos os usos de @code{from <module> import ...} e colocar todo o código dentro de funções.  As inicializações de variáveis globais e variáveis de classe devem usar apenas constantes ou funções embutidas.  Isso significa que tudo de um módulo importado é referenciado como @code{<module>.<name>}.

Jim Roskind sugere a execução das etapas na seguinte ordem em cada módulo:


@itemize *

@item 
exportações (globais, função e classes que não precisam de classes base importadas)

@item 
instruções @code{import}

@item 
código ativo (incluindo globais que são inicializadas de valores importados)
@end itemize

Van Rossum não gosta muito dessa abordagem porque a importação aparece em um lugar estranho, mas ela funciona.

Matthias Urlichs recomenda reestruturar seu código para que importação recursiva não seja necessária em primeiro lugar.

Essas soluções não são mutuamente exclusivas.

@node __import__ ‘x y z’ retorna <módulo ‘x’>; como faço para obter z?,Quando eu edito um módulo importado e o reimporto as mudanças não aparecem Por que isso acontece?,Como posso ter módulos que se importam mutuamente?,Módulos<5>
@anchor{faq/programming import-x-y-z-returns-module-x-how-do-i-get-z}@anchor{553d}
@subsubsection __import__(‘x.y.z’) retorna <módulo ‘x’>; como faço para obter z?


Em vez disso, considere usar a conveniente função @ref{518,,import_module()} de @ref{77,,importlib}:

@example
z = importlib.import_module('x.y.z')
@end example

@node Quando eu edito um módulo importado e o reimporto as mudanças não aparecem Por que isso acontece?,,__import__ ‘x y z’ retorna <módulo ‘x’>; como faço para obter 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{553e}
@subsubsection Quando eu edito um módulo importado e o reimporto, as mudanças não aparecem. Por que isso acontece?


Por motivos de eficiência e consistência, o Python só lê o arquivo do módulo na primeira vez em que um módulo é importado.  Caso contrário, em um programa que consiste em muitos módulos em que cada um importa o mesmo módulo básico, o módulo básico seria analisado e reanalisado várias vezes.  Para forçar a releitura de um módulo alterado, faça o seguinte:

@example
import importlib
import modname
importlib.reload(modname)
@end example

Aviso: essa técnica não é 100% à prova de falhas. Em particular, módulos contendo instruções como

@example
from modname import some_objects
@end example

continuará com a versão antiga dos objetos importados.  Se o módulo contiver definições de classe, as instâncias de classe existentes `não' serão atualizadas para usar a nova definição da classe.  Isso pode resultar no seguinte comportamento paradoxal:

@example
>>> import importlib
>>> import cls
>>> c = cls.C()                # Cria uma instância de C
>>> importlib.reload(cls)
<module 'cls' from 'cls.py'>
>>> isinstance(c, cls.C)       # isinstance é falso?!?
False
@end example

A natureza do problema fica clara se você exibir a “identidade” dos objetos da classe:

@example
>>> hex(id(c.__class__))
'0x7352a0'
>>> hex(id(cls.C))
'0x4198d0'
@end example

@node FAQ sobre design e histórico,FAQ de Bibliotecas e Extensões,FAQ sobre programação,Perguntas Frequentes Sobre Python
@anchor{faq/design doc}@anchor{553f}@anchor{faq/design design-and-history-faq}@anchor{5540}@anchor{faq/design translation-repo}@anchor{5541}
@section FAQ sobre design e histórico



@menu
* Por que o Python usa indentação para agrupamento de instruções?:: 
* Por que eu estou recebendo resultados estranhos com simples operações aritméticas?:: 
* Por que o cálculo de pontos flutuantes são tão imprecisos?:: 
* Por que strings do Python são imutáveis?:: 
* Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?:: 
* Por que não posso usar uma atribuição em uma expressão?:: 
* Por que o Python usa métodos para algumas funcionalidades (ex; lista.index()) mas funções para outras (ex; len(lista))?: Por que o Python usa métodos para algumas funcionalidades ex lista index mas funções para outras ex len lista ?. 
* Por que o join() é um método de string em vez de ser um método de lista ou tupla?: Por que o join é um método de string em vez de ser um método de lista ou tupla?. 
* Quão rápidas são as exceções?:: 
* Por que não existe uma instrução de switch ou case no Python?:: 
* Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?:: 
* Por que expressões lambda não podem conter instruções?:: 
* O Python pode ser compilado para linguagem de máquina@comma{} C ou alguma outra linguagem?: O Python pode ser compilado para linguagem de máquina C ou alguma outra linguagem?. 
* Como o Python gerencia memória?:: 
* Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?:: 
* Por que toda memória não é liberada quando o CPython fecha?:: 
* Por que existem tipos de dados separados para tuplas e listas?:: 
* Como as listas são implementadas no CPython?:: 
* Como são os dicionários implementados no CPython?:: 
* Por que chaves de dicionário devem ser imutáveis?:: 
* Por que lista.sort() não retorna a lista ordenada?: Por que lista sort não retorna a lista ordenada?. 
* Como você especifica e aplica um spec de interface no Python?:: 
* Por que não há goto?:: 
* Por que strings brutas (r-strings) não podem terminar com uma contrabarra?: Por que strings brutas r-strings não podem terminar com uma contrabarra?. 
* Por que o Python não tem uma instrução “with” para atribuição de atributos?:: 
* Por que os geradores não suportam a instrução with?:: 
* Por que dois pontos são necessários para as instruções de if/while/def/class?:: 
* Por que o Python permite vírgulas ao final de listas e tuplas?:: 

@end menu

@node Por que o Python usa indentação para agrupamento de instruções?,Por que eu estou recebendo resultados estranhos com simples operações aritméticas?,,FAQ sobre design e histórico
@anchor{faq/design why-does-python-use-indentation-for-grouping-of-statements}@anchor{5542}
@subsection Por que o Python usa indentação para agrupamento de instruções?


Guido van Rossum acredita que usar indentação para agrupamento é extremamente elegante e contribui muito para a clareza de programa Python mediano. Muitas pessoas aprendem a amar esta ferramenta depois de um tempo.

Uma vez que não há colchetes de início / fim, não pode haver um desacordo entre o agrupamento percebido pelo analisador sintático e pelo leitor humano. Ocasionalmente, programadores C irão encontrar um fragmento de código como este:

@example
if (x <= y)
        x++;
        y--;
z++;
@end example

Somente a instrução @code{x++} é executada se a condição for verdadeira, mas a indentação leva muitos a acreditarem no contrário. Com frequência, até programadores C experientes a observam fixamente por um longo tempo, perguntando-se por que @code{y} está sendo decrementada até mesmo para @code{x > y}.

Como não há chaves de início / fim, o Python é muito menos propenso a conflitos no estilo de codificação. Em C, existem muitas maneiras diferentes de colocar as chaves. Depois de se tornar habitual a leitura e escrita de código usando um estilo específico, é normal sentir-se um pouco receoso ao ler (ou precisar escrever) em um estilo diferente.

Muitos estilos de codificação colocam chaves de início / fim em uma linha sozinhos. Isto torna os programas consideravelmente mais longos e desperdiça espaço valioso na tela, dificultando a obtenção de uma boa visão geral de um programa. Idealmente, uma função deve caber em uma tela (digamos, 20 a 30 linhas). 20 linhas de Python podem fazer muito mais trabalho do que 20 linhas de C. Isso não se deve apenas à falta de colchetes de início/fim – a falta de declarações e os tipos de dados de alto nível também são responsáveis – mas a sintaxe baseada em indentação certamente ajuda.

@node Por que eu estou recebendo resultados estranhos com simples operações aritméticas?,Por que o cálculo de pontos flutuantes são tão imprecisos?,Por que o Python usa indentação para agrupamento de instruções?,FAQ sobre design e histórico
@anchor{faq/design why-am-i-getting-strange-results-with-simple-arithmetic-operations}@anchor{5543}
@subsection Por que eu estou recebendo resultados estranhos com simples operações aritméticas?


Veja a próxima questão.

@node Por que o cálculo de pontos flutuantes são tão imprecisos?,Por que strings do Python são imutáveis?,Por que eu estou recebendo resultados estranhos com simples operações aritméticas?,FAQ sobre design e histórico
@anchor{faq/design why-are-floating-point-calculations-so-inaccurate}@anchor{5544}
@subsection Por que o cálculo de pontos flutuantes são tão imprecisos?


Usuários são frequentemente surpreendidos por resultados como este:

@example
>>> 1.2 - 1.0
0.19999999999999996
@end example

e pensam que isto é um bug do Python. Não é não. Isto tem pouco a ver com o Python, e muito mais a ver com como a estrutura da plataforma lida com números em ponto flutuante.

O tipo @ref{2f7,,float} no CPython usa um @code{double} do C para armazenamento. O valor de um objeto @ref{2f7,,float} é armazenado em ponto flutuante binário com uma precisão fixa (normalmente 53 bits) e Python usa operações C, que por sua vez dependem da implementação de hardware no processador, para realizar operações de ponto flutuante. Isso significa que, no que diz respeito às operações de ponto flutuante, Python se comporta como muitas linguagens populares, incluindo C e Java.

Muitos números podem ser escritos facilmente em notação decimal, mas não podem ser expressados exatamente em ponto flutuante binário. Por exemplo, após:

@example
>>> x = 1.2
@end example

o valor armazenado para @code{x} é uma (ótima) aproximação para o valor decimal @code{1.2}, mas não é exatamente igual. Em uma máquina típica, o valor real armazenado é:

@example
1.0011001100110011001100110011001100110011001100110011 (binário)
@end example

que é exatamente:

@example
1.1999999999999999555910790149937383830547332763671875 (decimal)
@end example

A precisão típica de 53 bits fornece floats do Python com precisão de 15 a 16 dígitos decimais.

Para uma explicação mais completa, consulte o capítulo de @ref{1e99,,aritmética de ponto flutuante} no tutorial Python.

@node Por que strings do Python são imutáveis?,Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?,Por que o cálculo de pontos flutuantes são tão imprecisos?,FAQ sobre design e histórico
@anchor{faq/design why-are-python-strings-immutable}@anchor{5545}
@subsection Por que strings do Python são imutáveis?


Existem várias vantagens.

Uma delas é o desempenho: saber que uma string é imutável significa que podemos alocar espaço para ela no momento da criação, e os requisitos de armazenamento são fixos e imutáveis. Esta é também uma das razões para a distinção entre tuplas e listas.

Outra vantagem é que strings em Python são consideradas tão “elementares” quanto números. Nenhuma atividade alterará o valor 8 para qualquer outra coisa e, em Python, nenhuma atividade alterará a string “oito” para qualquer outra coisa.

@node Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?,Por que não posso usar uma atribuição em uma expressão?,Por que strings do Python são imutáveis?,FAQ sobre design e histórico
@anchor{faq/design why-must-self-be-used-explicitly-in-method-definitions-and-calls}@anchor{5546}@anchor{faq/design why-self}@anchor{552b}
@subsection Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?


A ideia foi emprestada do Modula-3. Acontece dela ser muito útil, por vários motivos.

Primeiro, é mais óbvio que você está usando um método ou atributo de instância em vez de uma variável local. Ler @code{self.x} ou @code{self.meth()} deixa absolutamente claro que uma variável de instância ou método é usado mesmo se você não souber a definição da classe de cor. Em C++, você pode perceber pela falta de uma declaração de variável local (presumindo que globais são raras ou facilmente reconhecíveis) – mas no Python não há declarações de variáveis locais, então você teria que procurar a definição de classe para tenha certeza. Alguns padrões de codificação C++ e Java exigem que atributos de instância tenham um prefixo @code{m_}, portanto, essa explicitação ainda é útil nessas linguagens também.

Segundo, significa que nenhuma sintaxe especial é necessária se você quiser referenciar ou chamar explicitamente o método de uma classe específica. Em C++, se você quiser usar um método de uma classe base que é substituído em uma classe derivada, você deve usar o operador @code{::} – no Python, você pode escrever @code{baseclass.methodname(self, <lista de argumentos>)}. Isto é particularmente útil para métodos @ref{6b0,,__init__()} e, em geral, em casos onde um método de classe derivada deseja estender o método da classe base de mesmo nome e, portanto, precisa chamar o método da classe base de alguma forma.

Finalmente, por exemplo, variáveis, ele resolve um problema sintático com atribuição: uma vez que variáveis locais em Python são (por definição!) aquelas variáveis às quais um valor é atribuído em um corpo de função (e que não são explicitamente declaradas globais), é necessário deve haver alguma forma de dizer ao interpretador que uma atribuição deveria ser atribuída a uma variável de instância em vez de a uma variável local, e deve ser preferencialmente sintática (por razões de eficiência). C++ faz isso através de declarações, mas Python não possui declarações e seria uma pena ter que introduzi-las apenas para esse fim. Usar o @code{self.var} explícito resolve isso muito bem. Da mesma forma, para usar variáveis de instância, ter que escrever @code{self.var} significa que referências a nomes não qualificados dentro de um método não precisam pesquisar nos diretórios da instância. Em outras palavras, variáveis locais e variáveis de instância residem em dois espaço de nomes diferentes, e você precisa informar ao Python qual espaço de nomes usar.

@node Por que não posso usar uma atribuição em uma expressão?,Por que o Python usa métodos para algumas funcionalidades ex lista index mas funções para outras ex len lista ?,Por que o ‘self’ deve ser usado explicitamente em definições de método e chamadas?,FAQ sobre design e histórico
@anchor{faq/design id1}@anchor{5547}@anchor{faq/design why-can-t-i-use-an-assignment-in-an-expression}@anchor{1dd6}
@subsection Por que não posso usar uma atribuição em uma expressão?


A partir do Python 3.8, você pode!

Expressões de atribuição usando o operador morsa @code{:=} atribuem uma variável em uma expressão:

@example
while chunk := fp.read(200):
   print(chunk)
@end example

Veja 
@geindex Propostas de Melhorias do Python; PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} para mais informações.

@node Por que o Python usa métodos para algumas funcionalidades ex lista index mas funções para outras ex len lista ?,Por que o join é um método de string em vez de ser um método de lista ou tupla?,Por que não posso usar uma atribuição em uma expressão?,FAQ sobre design e histórico
@anchor{faq/design why-does-python-use-methods-for-some-functionality-e-g-list-index-but-functions-for-other-e-g-len-list}@anchor{5548}
@subsection Por que o Python usa métodos para algumas funcionalidades (ex: lista.index()) mas funções para outras (ex: len(lista))?


Como Guido disse:

@quotation

(a) For some operations, prefix notation just reads better than
postfix – prefix (and infix!) operations have a long tradition in
mathematics which likes notations where the visuals help the
mathematician thinking about a problem. Compare the easy with which we
rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of
doing the same thing using a raw OO notation.

(b) When I read code that says len(x) I `know' that it is asking for
the length of something. This tells me two things: the result is an
integer, and the argument is some kind of container. To the contrary,
when I read x.len(), I have to already know that x is some kind of
container implementing an interface or inheriting from a class that
has a standard len(). Witness the confusion we occasionally have when
a class that is not implementing a mapping has a get() or keys()
method, or something that isn’t a file has a write() method.


@center --- @indicateurl{https://mail.python.org/pipermail/python-3000/2006-November/004643.html}

@end quotation

@node Por que o join é um método de string em vez de ser um método de lista ou tupla?,Quão rápidas são as exceções?,Por que o Python usa métodos para algumas funcionalidades ex lista index mas funções para outras ex len lista ?,FAQ sobre design e histórico
@anchor{faq/design why-is-join-a-string-method-instead-of-a-list-or-tuple-method}@anchor{5549}
@subsection Por que o join() é um método de string em vez de ser um método de lista ou tupla?


Strings se tornaram muito parecidas com outros tipos padrão a partir do Python 1.6, quando métodos que dão a mesma funcionalidade que sempre esteve disponível utilizando as funções do módulo de string foram adicionados. A maior parte desses novos métodos foram amplamente aceitos, mas o que parece deixar alguns programadores desconfortáveis é:

@example
", ".join(['1', '2', '4', '8', '16'])
@end example

que dá o resultado:

@example
"1, 2, 4, 8, 16"
@end example

Existem dois argumentos comuns contra esse uso.

O primeiro segue as linhas de: “Parece muito feio usar um método de uma string literal (constante de string)”, para o qual a resposta é que pode, mas uma string literal é apenas um valor fixo. Se os métodos devem ser permitidos em nomes vinculados a strings, não há razão lógica para torná-los indisponíveis em literais.

A segunda objeção é normalmente formulada como: “Na verdade, estou dizendo a uma sequência para unir seus membros com uma constante de string”. Infelizmente, você não está. Por alguma razão parece haver muito menos dificuldade em ter @ref{ed9,,split()} como um método string, já que nesse caso é fácil ver que

@example
"1, 2, 4, 8, 16".split(", ")
@end example

é uma instrução para uma string literal para retornar as substrings delimitadas pelo separador fornecido (ou, por padrão, execuções arbitrárias de espaço em branco).

@ref{2340,,join()} é um método de string porque ao usá-lo você está dizendo à string separadora para iterar sobre uma sequência de strings e se inserir entre elementos adjacentes. Este método pode ser usado com qualquer argumento que obedeça às regras para objetos sequência, incluindo quaisquer novas classes que você mesmo possa definir. Existem métodos semelhantes para bytes e objetos bytearray.

@node Quão rápidas são as exceções?,Por que não existe uma instrução de switch ou case no Python?,Por que o join é um método de string em vez de ser um método de lista ou tupla?,FAQ sobre design e histórico
@anchor{faq/design how-fast-are-exceptions}@anchor{554a}
@subsection Quão rápidas são as exceções?


Um bloco @ref{6e9,,try}/@ref{18b,,except} é extremamente eficiente se nenhuma exceção for levantada. Na verdade, capturar uma exceção é caro. Nas versões do Python anteriores à 2.0 era comum usar esta expressão:

@example
try:
    value = mydict[key]
except KeyError:
    mydict[key] = getvalue(key)
    value = mydict[key]
@end example

Isso somente fazia sentido quando você esperava que o dicionário tivesse uma chave quase que toda vez. Se esse não fosse o caso, você escrevia desta maneira:

@example
if key in mydict:
    value = mydict[key]
else:
    value = mydict[key] = getvalue(key)
@end example

Para este caso específico, você também pode usar @code{value = dict.setdefault(key, getvalue(key))}, mas apenas se a chamada @code{getvalue()} tiver pouco custosa o suficiente porque é avaliada em todos os casos.

@node Por que não existe uma instrução de switch ou case no Python?,Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?,Quão rápidas são as exceções?,FAQ sobre design e histórico
@anchor{faq/design why-isn-t-there-a-switch-or-case-statement-in-python}@anchor{554b}
@subsection Por que não existe uma instrução de switch ou case no Python?


Em geral, as instruções switch estruturadas executam um bloco de código quando uma expressão possui um valor ou conjunto de valores específico. Desde o Python 3.10 é possível combinar facilmente valores literais, ou constantes dentro de um espaço de nomes, com uma instrução @code{match ... case}. Uma alternativa mais antiga é uma sequência de @code{if... elif... elif... else}.

Para casos em que você precisa escolher entre um grande número de possibilidades, você pode criar um dicionário mapeando valores de caso para funções a serem chamadas. Por exemplo:

@example
functions = @{'a': function_1,
             'b': function_2,
             'c': self.method_1@}

func = functions[value]
func()
@end example

Para chamar métodos em objetos, você pode simplificar ainda mais usando olá função embutida @ref{bea,,getattr()} para recuperar métodos com um nome específico:

@example
class MyVisitor:
    def visit_a(self):
        ...

    def dispatch(self, value):
        method_name = 'visit_' + str(value)
        method = getattr(self, method_name)
        method()
@end example

É sugerido que você use um prefixo para os nomes dos métodos, como @code{visit_} neste exemplo. Sem esse prefixo, se os valores vierem de uma fonte não confiável, um invasor poderá chamar qualquer método no seu objeto.

Imitar o comportamento do switch no C, em que a execução atravessa as instruções de um case para outro caso não seja interrompida, é possível, mais difícil, e menos necessário.

@node Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?,Por que expressões lambda não podem conter instruções?,Por que não existe uma instrução de switch ou case no Python?,FAQ sobre design e histórico
@anchor{faq/design can-t-you-emulate-threads-in-the-interpreter-instead-of-relying-on-an-os-specific-thread-implementation}@anchor{554c}
@subsection Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?


Resposta 1: Infelizmente, o interpretador envia pelo menos um quadro de pilha C para cada quadro de pilha Python. Além disso, as extensões podem retornar ao Python em momentos quase aleatórios. Portanto, uma implementação completa de threads requer suporte de thread para C.

Resposta 2: Felizmente, existe o Stackless Python@footnote{https://github.com/stackless-dev/stackless/wiki}, que tem um laço de interpretador completamente redesenhado que evita a pilha C.

@node Por que expressões lambda não podem conter instruções?,O Python pode ser compilado para linguagem de máquina C ou alguma outra linguagem?,Você não pode emular threads no interpretador em vez de confiar em uma implementação de thread específica do sistema operacional?,FAQ sobre design e histórico
@anchor{faq/design why-can-t-lambda-expressions-contain-statements}@anchor{554d}
@subsection Por que expressões lambda não podem conter instruções?


Expressões lambda no Python não podem conter instruções porque o framework sintático do Python não consegue manipular instruções aninhadas dentro de expressões. No entanto, no Python, isso não é um problema sério. Diferentemente das formas de lambda em outras linguagens, onde elas adicionam funcionalidade, lambdas de Python são apenas notações simplificadas se você tiver muita preguiça de definir uma função.

Funções já são objetos de primeira classe em Python, e podem ser declaradas em um escopo local. Portanto a única vantagem de usar um lambda em vez de uma função definida localmente é que você não precisa inventar um nome para a função – mas esta só é uma variável local para a qual o objeto da função (que é exatamente do mesmo tipo de um objeto que uma expressão lambda carrega) é atribuído!

@node O Python pode ser compilado para linguagem de máquina C ou alguma outra linguagem?,Como o Python gerencia memória?,Por que expressões lambda não podem conter instruções?,FAQ sobre design e histórico
@anchor{faq/design can-python-be-compiled-to-machine-code-c-or-some-other-language}@anchor{554e}
@subsection O Python pode ser compilado para linguagem de máquina, C ou alguma outra linguagem?


O Cython@footnote{https://cython.org/} compila uma versão modificada do Python com anotações opcionais em extensões C. Nuitka@footnote{https://nuitka.net/} é um compilador emergente de Python em código C++, com o objetivo de oferecer suporte à linguagem Python completa.

@node Como o Python gerencia memória?,Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?,O Python pode ser compilado para linguagem de máquina C ou alguma outra linguagem?,FAQ sobre design e histórico
@anchor{faq/design how-does-python-manage-memory}@anchor{554f}
@subsection Como o Python gerencia memória?


Os detalhes do gerenciamento de memória Python dependem da implementação. A implementação padrão do Python, @ref{6f6,,CPython}, usa contagem de referências para detectar objetos inacessíveis, e outro mecanismo para coletar ciclos de referência, executando periodicamente um algoritmo de detecção de ciclo que procura por ciclos inacessíveis e exclui os objetos envolvidos. O módulo @ref{60,,gc} fornece funções para realizar uma coleta de lixo, obter estatísticas de depuração e ajustar os parâmetros do coletor.

Outras implementações (como Jython@footnote{https://www.jython.org} ou PyPy@footnote{https://pypy.org}), no entanto, podem contar com um mecanismo diferente, como um coletor de lixo maduro. Essa diferença pode causar alguns problemas sutis de portabilidade se o seu código Python depender do comportamento da implementação de contagem de referências.

Em algumas implementações do Python, o código a seguir (que funciona bem no CPython) provavelmente ficará sem descritores de arquivo:

@example
for file in very_long_list_of_files:
    f = open(file)
    c = f.read(1)
@end example

Na verdade, usando o esquema de contagem de referências e destrutor de referências do CPython, cada nova atribuição a @code{f} fecha o arquivo anterior. Com um GC tradicional, entretanto, esses objetos arquivo só serão coletados (e fechados) em intervalos variados e possivelmente longos.

Se você quiser escrever um código que funcione com qualquer implementação Python, você deve fechar explicitamente o arquivo ou usar a instrução @ref{5d2,,with}; isso funcionará independentemente do esquema de gerenciamento de memória:

@example
for file in very_long_list_of_files:
    with open(file) as f:
        c = f.read(1)
@end example

@node Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?,Por que toda memória não é liberada quando o CPython fecha?,Como o Python gerencia memória?,FAQ sobre design e histórico
@anchor{faq/design why-doesn-t-cpython-use-a-more-traditional-garbage-collection-scheme}@anchor{5550}
@subsection Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?


Por um lado, este não é um recurso padrão C e, portanto, não é portátil. (Sim, sabemos sobre a biblioteca Boehm GC. Ela possui pedaços de código assembler para a `maioria' das plataformas comuns, não para todas elas, e embora seja em sua maioria transparente, não é completamente transparente; são necessários patches para obter Python para trabalhar com isso.)

O GC tradicional também se torna um problema quando o Python é incorporado em outros aplicativos. Embora em um Python independente seja bom substituir o padrão @code{malloc()} e @code{free()} por versões fornecidas pela biblioteca GC, uma aplicação que incorpora Python pode querer ter seu `próprio' substituto para @code{malloc()} e @code{free()}, e podem não querer Python. No momento, CPython funciona com qualquer coisa que implemente @code{malloc()} e @code{free()} corretamente.

@node Por que toda memória não é liberada quando o CPython fecha?,Por que existem tipos de dados separados para tuplas e listas?,Por que o CPython não usa uma forma mais tradicional de esquema de coleta de lixo?,FAQ sobre design e histórico
@anchor{faq/design why-isn-t-all-memory-freed-when-cpython-exits}@anchor{5551}
@subsection Por que toda memória não é liberada quando o CPython fecha?


Os objetos referenciados nos espaço de nomes globais dos módulos Python nem sempre são desalocados quando o Python é encerrado. Isso pode acontecer se houver referências circulares. Existem também certos bits de memória alocados pela biblioteca C que são impossíveis de liberar (por exemplo, uma ferramenta como o Purify reclamará disso). Python é, no entanto, agressivo quanto à limpeza de memória na saída e tenta destruir todos os objetos.

Se você quiser forçar o Python a excluir certas coisas na desalocação, use o módulo @ref{c,,atexit} para executar uma função que forçará essas exclusões.

@node Por que existem tipos de dados separados para tuplas e listas?,Como as listas são implementadas no CPython?,Por que toda memória não é liberada quando o CPython fecha?,FAQ sobre design e histórico
@anchor{faq/design why-are-there-separate-tuple-and-list-data-types}@anchor{5552}
@subsection Por que existem tipos de dados separados para tuplas e listas?


Listas e tuplas, embora semelhantes em muitos aspectos, geralmente são usadas de maneiras fundamentalmente diferentes. Tuplas podem ser consideradas semelhantes a @code{records} de Pascal ou @code{structs} de C; são pequenas coleções de dados relacionados que podem ser de diferentes tipos e operados como um grupo. Por exemplo, uma coordenada cartesiana é representada apropriadamente como uma tupla de dois ou três números.

As listas, por outro lado, são mais parecidas com arrays em outras linguagens. Eles tendem a conter um número variável de objetos, todos do mesmo tipo e operados um por um. Por exemplo, @ref{1139,,os.listdir('.')} retorna uma lista de strings representando os arquivos no diretório atual. Funções que operam nesta saída geralmente não seriam interrompidas se você adicionasse outro arquivo ou dois ao diretório.

As tuplas são imutáveis, o que significa que, uma vez criada uma tupla, você não pode substituir nenhum de seus elementos por um novo valor. As listas são mutáveis, o que significa que você sempre pode alterar os elementos de uma lista. Somente elementos imutáveis podem ser usados como chaves de dicionário e, portanto, apenas tuplas e não listas podem ser usadas como chaves.

@node Como as listas são implementadas no CPython?,Como são os dicionários implementados no CPython?,Por que existem tipos de dados separados para tuplas e listas?,FAQ sobre design e histórico
@anchor{faq/design how-are-lists-implemented-in-cpython}@anchor{5553}
@subsection Como as listas são implementadas no CPython?


As listas do CPython são, na verdade, vetores de comprimento variável, listas vinculadas não no estilo Lisp. A implementação usa um vetor contíguo de referências a outros objetos e mantém um ponteiro para esse vetor e o comprimento de vetor em uma estrutura de cabeçalho de lista.

Isso torna a indexação de uma lista @code{a[i]} uma operação cujo custo é independente do tamanho da lista ou do valor do índice.

Quando itens são anexados ou inseridos, o vetor de referências é redimensionado. Alguma inteligência é aplicada para melhorar o desempenho de anexar itens repetidamente; quando o vetor precisa ser aumentado, algum espaço extra é alocado para que as próximas vezes não exijam um redimensionamento real.

@node Como são os dicionários implementados no CPython?,Por que chaves de dicionário devem ser imutáveis?,Como as listas são implementadas no CPython?,FAQ sobre design e histórico
@anchor{faq/design how-are-dictionaries-implemented-in-cpython}@anchor{5554}
@subsection Como são os dicionários implementados no CPython?


Os dicionários do CPython são implementados como tabelas hash redimensionáveis. Em comparação com árvores B, isso oferece melhor desempenho para pesquisa (de longe a operação mais comum) na maioria das circunstâncias, e a implementação é mais simples.

Os dicionários funcionam calculando um código hash para cada chave armazenada no dicionário usando a função embutida @ref{5eb,,hash()}. O código hash varia amplamente dependendo da chave e da semente por processo; por exemplo, @code{'Python'} poderia fazer hash para @code{-539294296} enquanto @code{'python'}, uma string que difere por um único bit, poderia fazer hash para @code{1142331976}. O código hash é então usado para calcular um local em um vetor interno onde o valor será armazenado. Supondo que você esteja armazenando chaves com valores de hash diferentes, isso significa que os dicionários levam um tempo constante – `O'(1), na notação Big-O – para recuperar uma chave.

@node Por que chaves de dicionário devem ser imutáveis?,Por que lista sort não retorna a lista ordenada?,Como são os dicionários implementados no CPython?,FAQ sobre design e histórico
@anchor{faq/design why-must-dictionary-keys-be-immutable}@anchor{5555}
@subsection Por que chaves de dicionário devem ser imutáveis?


A implementação da tabela hash de dicionários usa um valor hash calculado a partir do valor da chave para encontrar a chave. Se a chave fosse um objeto mutável, seu valor poderia mudar e, portanto, seu hash também poderia mudar. Mas como quem altera o objeto-chave não pode saber que ele estava sendo usado como chave de dicionário, ele não pode mover a entrada no dicionário. Então, quando você tentar procurar o mesmo objeto no dicionário, ele não será encontrado porque seu valor de hash é diferente. Se você tentasse procurar o valor antigo, ele também não seria encontrado, porque o valor do objeto encontrado naquele hash seria diferente.

Se você deseja que um dicionário seja indexado com uma lista, simplesmente converta primeiro a lista em uma tupla; a função @code{tuple(L)} cria uma tupla com as mesmas entradas da lista @code{L}. As tuplas são imutáveis e, portanto, podem ser usadas como chaves de dicionário.

Algumas soluções inaceitáveis que foram propostas:


@itemize -

@item 
Listas de hash por endereço (ID do objeto). Isto não funciona porque se você construir uma nova lista com o mesmo valor ela não será encontrada; por exemplo.:

@example
mydict = @{[1, 2]: '12'@}
print(mydict[[1, 2]])
@end example

levantaria uma exceção @ref{344,,KeyError} porque o id do @code{[1, 2]} usado na segunda linha difere daquele da primeira linha. Em outras palavras, as chaves de dicionário devem ser comparadas usando @code{==}, não usando @ref{2f5,,is}.

@item 
Fazer uma cópia ao usar uma lista como chave. Isso não funciona porque a lista, sendo um objeto mutável, poderia conter uma referência a si mesma e então o código copiado entraria em um laço infinito.

@item 
Permitir listas como chaves, mas dizer ao usuário para não modificá-las. Isso permitiria uma classe de bugs difíceis de rastrear em programas quando você esquecesse ou modificasse uma lista por acidente. Também invalida uma importante invariante dos dicionários: todo valor em @code{d.keys()} pode ser usado como chave do dicionário.

@item 
Marcar listas como somente leitura quando forem usadas como chave de dicionário. O problema é que não é apenas o objeto de nível superior que pode alterar seu valor; você poderia usar uma tupla contendo uma lista como chave. Inserir qualquer coisa como chave em um dicionário exigiria marcar todos os objetos acessíveis a partir daí como somente leitura – e, novamente, objetos autorreferenciais poderiam causar um laço infinito.
@end itemize

Existe um truque para contornar isso se você precisar, mas use-o por sua própria conta e risco: você pode agrupar uma estrutura mutável dentro de uma instância de classe que tenha um método @ref{b0d,,__eq__()} e um método @ref{b0e,,__hash__()}. Você deve então certificar-se de que o valor de hash para todos os objetos invólucros que residem em um dicionário (ou outra estrutura baseada em hash) permaneça fixo enquanto o objeto estiver no dicionário (ou outra estrutura).

@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

Observe que o cálculo do hash é complicado pela possibilidade de que alguns membros da lista possam ser não não-hasheável e também pela possibilidade de estouro aritmético.

Além disso, deve ser sempre o caso que se @code{o1 == o2} (ou seja, @code{o1.__eq__(o2) is True}) então @code{hash(o1) == hash(o2)} (ou seja, @code{o1.__hash__() == o2.__hash__()}), independentemente de o objeto estar em um dicionário ou não. Se você não cumprir essas restrições, os dicionários e outras estruturas baseadas em hash se comportarão mal.

No caso de @code{ListWrapper}, sempre que o objeto invólucro estiver em um dicionário, a lista agrupada não deve ser alterada para evitar anomalias. Não faça isso a menos que esteja preparado para pensar muito sobre os requisitos e as consequências de não atendê-los corretamente. Considere-se avisado.

@node Por que lista sort não retorna a lista ordenada?,Como você especifica e aplica um spec de interface no Python?,Por que chaves de dicionário devem ser imutáveis?,FAQ sobre design e histórico
@anchor{faq/design why-doesn-t-list-sort-return-the-sorted-list}@anchor{5556}
@subsection Por que lista.sort() não retorna a lista ordenada?


Em situações nas quais desempenho importa, fazer uma cópia da lista só para ordenar seria desperdício. Portanto, @code{lista.sort()} ordena a lista. De forma a lembrá-lo desse fato, isso não retorna a lista ordenada. Desta forma, você não vai ser confundido a acidentalmente sobrescrever uma lista quando você precisar de uma cópia ordenada mas também precisar manter a versão não ordenada.

Se você quiser retornar uma nova lista, use a função embutida @ref{be7,,sorted()} ao invés. Essa função cria uma nova lista a partir de um iterável provido, o ordena e retorna. Por exemplo, aqui é como se itera em cima das chaves de um dicionário de maneira ordenada:

@example
for key in sorted(mydict):
    ...  # use mydict[key] conforme quiser...
@end example

@node Como você especifica e aplica um spec de interface no Python?,Por que não há goto?,Por que lista sort não retorna a lista ordenada?,FAQ sobre design e histórico
@anchor{faq/design how-do-you-specify-and-enforce-an-interface-spec-in-python}@anchor{5557}
@subsection Como você especifica e aplica um spec de interface no Python?


Uma especificação de interface para um módulo fornecida por linguagens como C++ e Java descreve os protótipos para os métodos e funções do módulo. Muitos acham que a aplicação de especificações de interface em tempo de compilação ajuda na construção de programas grandes.

Python 2.6 adiciona um módulo @ref{4,,abc} que permite definir Classes Base Abstratas (ABCs). Você pode então usar @ref{442,,isinstance()} e @ref{7c2,,issubclass()} para verificar se uma instância ou classe implementa um ABC específico. O módulo @ref{1e,,collections.abc} define um conjunto de ABCs úteis como @ref{23e2,,Iterable}, @ref{23e4,,Container} e @ref{10eb,,MutableMapping}

Para Python, muitas das vantagens das especificações de interface podem ser obtidas por uma disciplina de teste apropriada para componentes.

Um bom conjunto de testes para um módulo pode fornecer um teste de regressão e servir como uma especificação de interface do módulo e um conjunto de exemplos. Muitos módulos Python podem ser executados como um script para fornecer um simples “autoteste”. Mesmo módulos que usam interfaces externas complexas muitas vezes podem ser testados isoladamente usando emulações triviais da interface externa. Os módulos @ref{3a,,doctest} e @ref{106,,unittest} ou estruturas de teste de terceiros podem ser usados para construir conjuntos de testes exaustivos que exercitam cada linha de código em um módulo.

Uma disciplina de teste apropriada pode ajudar a construir aplicações grandes e complexas no Python, assim como ter especificações de interface. Na verdade, pode ser melhor porque uma especificação de interface não pode testar certas propriedades de um programa. Por exemplo, espera-se que o método @ref{6cd,,list.append()} adicione novos elementos ao final de alguma lista interna; uma especificação de interface não pode testar se sua implementação @ref{6cd,,list.append()} realmente fará isso corretamente, mas é trivial verificar esta propriedade em um conjunto de testes.

Escrever conjuntos de testes é muito útil e você pode querer projetar seu código para torná-lo facilmente testável. Uma técnica cada vez mais popular, o desenvolvimento orientado a testes, exige a escrita de partes do conjunto de testes primeiro, antes de escrever qualquer parte do código real. É claro que o Python permite que você seja desleixado e nem escreva casos de teste.

@node Por que não há goto?,Por que strings brutas r-strings não podem terminar com uma contrabarra?,Como você especifica e aplica um spec de interface no Python?,FAQ sobre design e histórico
@anchor{faq/design why-is-there-no-goto}@anchor{5558}
@subsection Por que não há goto?


Na década de 1970, as pessoas perceberam que o goto irrestrito poderia levar a um código “espaguete” confuso, difícil de entender e revisar. Em uma linguagem de alto nível, também é desnecessário, desde que existam maneiras de ramificar (em Python, com instruções @ref{2f3,,if} e @ref{2f6,,or}, @ref{2f1,,and} e expressões @ref{2f3,,if}/@ref{18c,,else}) e iterar (com instruções @ref{1d82,,while} e @ref{2f2,,for}, possivelmente contendo @ref{9d1,,continue} e @ref{ab8,,break}).

Também é possível usar exceções para fornecer um “goto estruturado” que funcione mesmo em chamadas de função. Muitos acham que as exceções podem convenientemente emular todos os usos razoáveis das construções @code{go} ou @code{goto} de C, Fortran e outras linguagens. Por exemplo:

@example
class label(Exception): pass  # declara um label

try:
    ...
    if condition: raise label()  # goto label
    ...
except label:  # destino do goto
    pass
...
@end example

Isso não permite que você pule para o meio de um laço, mas isso geralmente é considerado um abuso de @code{goto} de qualquer maneira. Use com moderação.

@node Por que strings brutas r-strings não podem terminar com uma contrabarra?,Por que o Python não tem uma instrução “with” para atribuição de atributos?,Por que não há goto?,FAQ sobre design e histórico
@anchor{faq/design why-can-t-raw-strings-r-strings-end-with-a-backslash}@anchor{5559}
@subsection Por que strings brutas (r-strings) não podem terminar com uma contrabarra?


Mais precisamente, eles não podem terminar com um número ímpar de contrabarras: a contrabarra não pareada no final escapa do caractere de aspa de fechamento, deixando uma string não terminada.

Strings brutas foram projetadas para facilitar a criação de entrada para processadores (principalmente mecanismos de expressão regular) que desejam fazer seu próprio processamento de escape de contrabarra. De qualquer forma, esses processadores consideram uma contrabarra incomparável como um erro, portanto, as strings brutas não permitem isso. Em troca, eles permitem que você transmita o caractere de aspas da string escapando dele com uma contrabarra. Essas regras funcionam bem quando r-strings são usadas para a finalidade pretendida.

Se você estiver tentando criar nomes de caminho do Windows, observe que todas as chamadas do sistema do Windows também aceitam barras:

@example
f = open("/mydir/file.txt")  # funciona normalmente!
@end example

Se você estiver tentando construir um nome de caminho para um comando DOS, tente, por exemplo, algum desses

@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 que o Python não tem uma instrução “with” para atribuição de atributos?,Por que os geradores não suportam a instrução with?,Por que strings brutas r-strings não podem terminar com uma contrabarra?,FAQ sobre design e histórico
@anchor{faq/design why-doesn-t-python-have-a-with-statement-for-attribute-assignments}@anchor{555a}
@subsection Por que o Python não tem uma instrução “with” para atribuição de atributos?


Python tem uma instrução @ref{5d2,,with} que envolve a execução de um bloco, chamando o código na entrada e na saída do bloco. Algumas linguagens têm uma construção desta forma:

@example
with obj:
    a = 1               # equivalente a obj.a = 1
    total = total + 1   # obj.total = obj.total + 1
@end example

Em Python, tal construção seria ambígua.

Outras linguagens, como Object Pascal, Delphi, e C++, usam tipos estáticos, então é possível saber, de maneira não ambígua, que membro está sendo atribuído. Esse é o principal ponto da tipagem estática – o compilador `sempre' sabe o escopo de toda variável em tempo de compilação.

O Python usa tipos dinâmicos. É impossível saber com antecedência que atributo vai ser referenciado em tempo de execução. Atributos membro podem ser adicionados ou removidos de objetos dinamicamente. Isso torna impossível saber, de uma leitura simples, que atributo está sendo referenciado: um atributo local, um atributo global ou um atributo membro?

Por exemplo, pegue o seguinte trecho incompleto:

@example
def foo(a):
    with a:
        print(x)
@end example

O trecho presume que @code{a} deve ter um atributo de membro chamado @code{x}. No entanto, não há nada em Python que diga isso ao interpretador. O que deveria acontecer se @code{a} for, digamos, um número inteiro? Se houver uma variável global chamada @code{x}, ela será usada dentro do bloco @ref{5d2,,with}? Como você pode ver, a natureza dinâmica do Python torna essas escolhas muito mais difíceis.

O principal benefício de @ref{5d2,,with} e recursos de linguagem semelhantes (redução do volume de código) pode, no entanto, ser facilmente alcançado em Python por atribuição. Em 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

escreva isso:

@example
ref = function(args).mydict[index][index]
ref.a = 21
ref.b = 42
ref.c = 63
@end example

Isso também tem o efeito colateral de aumentar a velocidade de execução porque as ligações de nome são resolvidas a tempo de execução em Python, e a segunda versão só precisa performar a resolução uma vez.

Propostas semelhantes que introduziriam sintaxe para reduzir ainda mais o volume do código, como o uso de um ‘ponto inicial’, foram rejeitadas em favor da explicitação (consulte @indicateurl{https://mail.python.org/pipermail/python-ideas/2016-May/040070.html}).

@node Por que os geradores não suportam a instrução with?,Por que dois pontos são necessários para as instruções de if/while/def/class?,Por que o Python não tem uma instrução “with” para atribuição de atributos?,FAQ sobre design e histórico
@anchor{faq/design why-don-t-generators-support-the-with-statement}@anchor{555b}
@subsection Por que os geradores não suportam a instrução with?


Por razões técnicas, um gerador usado diretamente como gerenciador de contexto não funcionaria corretamente. Quando, como é mais comum, um gerador é usado como um iterador executado até a conclusão, nenhum fechamento é necessário. Quando estiver, envolva-o como @ref{13d0,,contextlib.closing(generator)} na instrução @ref{5d2,,with}.

@node Por que dois pontos são necessários para as instruções de if/while/def/class?,Por que o Python permite vírgulas ao final de listas e tuplas?,Por que os geradores não suportam a instrução with?,FAQ sobre design e histórico
@anchor{faq/design why-are-colons-required-for-the-if-while-def-class-statements}@anchor{555c}
@subsection Por que dois pontos são necessários para as instruções de if/while/def/class?


Os dois pontos são obrigatórios primeiramente para melhorar a leitura (um dos resultados da linguagem experimental ABC). Considere isso:

@example
if a == b
    print(a)
@end example

versus

@example
if a == b:
    print(a)
@end example

Note como a segunda é ligeiramente mais fácil de ler. Note com mais atenção como os dois pontos iniciam o exemplo nessa resposta de FAQ; é um uso padrão em inglês.

Outro motivo menor é que os dois pontos deixam mais fácil para os editores com realce de sintaxe; eles podem procurar por dois pontos para decidir quando a recuo precisa ser aumentada em vez de precisarem fazer uma análise mais elaborada do texto do programa.

@node Por que o Python permite vírgulas ao final de listas e tuplas?,,Por que dois pontos são necessários para as instruções de if/while/def/class?,FAQ sobre design e histórico
@anchor{faq/design why-does-python-allow-commas-at-the-end-of-lists-and-tuples}@anchor{555d}
@subsection Por que o Python permite vírgulas ao final de listas e tuplas?


O Python deixa você adicionar uma vírgula ao final de listas, tuplas e dicionários:

@example
[1, 2, 3,]
('a', 'b', 'c',)
d = @{
    "A": [1, 5],
    "B": [6, 7],  # a vírgula ao final é opcional, mas é bom estilo
@}
@end example

Existem várias razões para permitir isso.

Quando você possui um valor literal para uma lista, tupla, ou dicionário disposta através de múltiplas linhas, é mais fácil adicionar mais elementos porque você não precisa lembrar de adicionar uma vírgula na linha anterior. As linhas também podem ser reordenadas sem criar um erro de sintaxe.

Acidentalmente omitir a vírgula pode levar a erros que são difíceis de diagnosticar. Por exemplo:

@example
x = [
  "fee",
  "fie"
  "foo",
  "fum"
]
@end example

Essa lista parece ter quatro elementos, mas na verdade contém três: “fee”, “fiefoo” e “fum”. Sempre adicionar a vírgula evita essa fonte de erro.

Permitir a vírgula no final também pode deixar a geração de código programático mais fácil.

@node FAQ de Bibliotecas e Extensões,FAQ sobre Extensão/Incorporação,FAQ sobre design e histórico,Perguntas Frequentes Sobre Python
@anchor{faq/library doc}@anchor{555e}@anchor{faq/library library-and-extension-faq}@anchor{555f}@anchor{faq/library translation-repo}@anchor{5560}
@section FAQ de Bibliotecas e Extensões



@menu
* Questões gerais sobre bibliotecas:: 
* Tarefas comuns:: 
* Threads:: 
* Entrada e Saída: Entrada e Saída<2>. 
* Programação Rede / Internet:: 
* Base de Dados:: 
* Matemáticos e Numéricos:: 

@end menu

@node Questões gerais sobre bibliotecas,Tarefas comuns,,FAQ de Bibliotecas e Extensões
@anchor{faq/library general-library-questions}@anchor{5561}
@subsection Questões gerais sobre bibliotecas


@menu
* Como encontrar um módulo ou aplicação para realizar uma tarefa X?:: 
* Onde está o código-fonte do math.py (socket.py@comma{} regex.py@comma{} etc.)?: Onde está o código-fonte do math py socket py regex py etc ?. 
* Como tornar um script Python executável no Unix?:: 
* Existe um pacote de curses/termcap para Python?:: 
* Existe a função onexit() equivalente ao C no Python?: Existe a função onexit equivalente ao C no Python?. 
* Por que o meu manipulador de sinal não funciona?:: 

@end menu

@node Como encontrar um módulo ou aplicação para realizar uma tarefa X?,Onde está o código-fonte do math py socket py regex py etc ?,,Questões gerais sobre bibliotecas
@anchor{faq/library how-do-i-find-a-module-or-application-to-perform-task-x}@anchor{5562}
@subsubsection Como encontrar um módulo ou aplicação para realizar uma tarefa X?


Verifique @ref{144,,a Referência de Bibliotecas} para ver se há um módulo relevante da biblioteca padrão. (Eventualmente, você aprenderá o que está na biblioteca padrão e poderá pular esta etapa.)

Para pacotes de terceiros, pesquise no Python Package Index@footnote{https://pypi.org} ou tente no Google@footnote{https://www.google.com} ou outro buscador na web. Pesquisando por “Python” mais uma ou dois argumentos nomeados do seu tópico de interesse geralmente encontrará algo útil.

@node Onde está o código-fonte do math py socket py regex py etc ?,Como tornar um script Python executável no Unix?,Como encontrar um módulo ou aplicação para realizar uma tarefa X?,Questões gerais sobre bibliotecas
@anchor{faq/library where-is-the-math-py-socket-py-regex-py-etc-source-file}@anchor{5563}
@subsubsection Onde está o código-fonte do math.py (socket.py, regex.py, etc.)?


Se você não conseguir encontrar um arquivo de origem para um módulo, ele pode ser um módulo embutido ou carregado dinamicamente, implementado em C, C++ ou outra linguagem compilada. Nesse caso, você pode não ter o arquivo de origem ou pode ser algo como @code{mathmodule.c}, em algum lugar do diretório de origem C (não no caminho do Python).

Existem (pelo menos) três tipos de módulos no Python:


@enumerate 

@item 
módulos escritos em Python (.py)

@item 
módulos escritos em C e carregados dinamicamente (.dll, .pyd, .so, .sl, etc.);

@item 
módulos escritos em C e vinculados ao interpretador; para obter uma dessas listas, digite:

@example
import sys
print(sys.builtin_module_names)
@end example
@end enumerate

@node Como tornar um script Python executável no Unix?,Existe um pacote de curses/termcap para Python?,Onde está o código-fonte do math py socket py regex py etc ?,Questões gerais sobre bibliotecas
@anchor{faq/library how-do-i-make-a-python-script-executable-on-unix}@anchor{5564}
@subsubsection Como tornar um script Python executável no Unix?


Você precisa fazer duas coisas: o arquivo do script deve ser executável e a primeira linha deve começar com @code{#!} seguido do caminho do interpretador Python.

Inicialmente, execute o @code{chmod +x scriptfile} ou, talvez, o @code{chmod 755 scriptfile}.

A segunda coisa pode ser feita de várias maneiras. A maneira mais direta é escrever

@example
#!/usr/local/bin/python
@end example

como a primeira linha do seu arquivo, usando o endereço do caminho onde o interpretador Python está instalado.

Se você deseja que o script seja independente de onde o interpretador Python mora, você pode usar o programa @code{env}. Quase todas as variantes do Unix suportam o seguinte, presumindo que o interpretador Python esteja em um diretório no 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} do usuário:

@example
#!/usr/bin/env python
@end example

Não faça isso para CGI scripts. A variável 
@geindex PATH
@geindex variável de ambiente; PATH
@code{PATH} para CGI scripts é normalmente muito pequena, portanto, você precisa usar o caminho completo do interpretador.

Ocasionalmente, o ambiente de um usuário está tão cheio que o programa @code{/usr/bin/env} falha; ou não há nenhum programa env. Nesse caso, você pode tentar o seguinte hack (graças a Alex Rezinsky):

@example
#! /bin/sh
""":"
exec python $0 $@{1+"$@@"@}
"""
@end example

Uma pequena desvantagem é que isso define o script’s __doc__ string. Entretanto, você pode corrigir isso adicionando

@example
__doc__ = """...Alguma coisa..."""
@end example

@node Existe um pacote de curses/termcap para Python?,Existe a função onexit equivalente ao C no Python?,Como tornar um script Python executável no Unix?,Questões gerais sobre bibliotecas
@anchor{faq/library is-there-a-curses-termcap-package-for-python}@anchor{5565}
@subsubsection Existe um pacote de curses/termcap para Python?


@c XXX curses *is* built by default, isn't it?

Para variantes Unix: A distribuição fonte padrão do Python vem com um módulo do curses no subdiretório Modules@footnote{https://github.com/python/cpython/tree/3.13/Modules}, embora não seja compilado por padrão.  (Observe que isso não está disponível na distribuição do Windows – não há módulo curses para o Windows.)

O módulo @ref{2b,,curses} provê recursos básicos de curses, bem como muitas funções adicionais de ncurses e curses SYSV, como cor, suporte a conjuntos de caracteres alternativos, pads e suporte a mouse. Isso significa que o módulo não é compatível com sistemas operacionais que possuem apenas maldições BSD, mas não parece haver nenhum sistema operacional mantido atualmente que se enquadre nesta categoria.

@node Existe a função onexit equivalente ao C no Python?,Por que o meu manipulador de sinal não funciona?,Existe um pacote de curses/termcap para Python?,Questões gerais sobre bibliotecas
@anchor{faq/library is-there-an-equivalent-to-c-s-onexit-in-python}@anchor{5566}
@subsubsection Existe a função onexit() equivalente ao C no Python?


O módulo @ref{c,,atexit} fornece uma função de registro similar ao @code{onexit()} do C.

@node Por que o meu manipulador de sinal não funciona?,,Existe a função onexit equivalente ao C no Python?,Questões gerais sobre bibliotecas
@anchor{faq/library why-don-t-my-signal-handlers-work}@anchor{5567}
@subsubsection Por que o meu manipulador de sinal não funciona?


O maior problema é que o manipulador de sinal é declarado com uma lista de argumentos incorretos. Isso é chamado como

@example
manipulador(num_sinal, quadro)
@end example

portanto, isso deve ser declarado com dois parâmetros:

@example
def manipulador(num_sinal, quadro):
    ...
@end example

@node Tarefas comuns,Threads,Questões gerais sobre bibliotecas,FAQ de Bibliotecas e Extensões
@anchor{faq/library common-tasks}@anchor{5568}
@subsection Tarefas comuns


@menu
* Como testar um programa ou componente Python?:: 
* Como faço para criar uma documentação de doc strings?:: 
* Como faço para pressionar uma tecla de cada vez?:: 

@end menu

@node Como testar um programa ou componente Python?,Como faço para criar uma documentação de doc strings?,,Tarefas comuns
@anchor{faq/library how-do-i-test-a-python-program-or-component}@anchor{5569}
@subsubsection Como testar um programa ou componente Python?


A Python vem com dois frameworks de teste. O módulo @ref{3a,,doctest} busca por exemplos nas docstrings de um módulo e os executa, comparando o resultado com a saída esperada informada na docstring.

O módulo @ref{106,,unittest} é uma estrutura de teste mais sofisticada, modelada nas estruturas de teste do Java e do Smalltalk.

Para facilitar os testes, você deve usar um bom design modular em seu programa. Seu programa deve ter quase todas as funcionalidades encapsuladas em funções ou métodos de classe – e isso às vezes tem o efeito surpreendente e agradável de fazer o programa executar mais rápido (porque os acessos às variáveis locais são mais rápidos que os acessos globais). Além disso, o programa deve evitar depender de variáveis globais mutantes, pois isso torna os testes muito mais difíceis de serem realizados.

A lógica principal do seu programa pode tão simples quanto

@example
if __name__ == "__main__":
    main_logic()
@end example

no botão do módulo principal do seus programa.

Depois que seu programa estiver organizado como uma coleção tratável de comportamentos de funções e classes, você deverá escrever funções de teste que exercitem os comportamentos. Um conjunto de testes que automatiza uma sequência de testes pode ser associado a cada módulo. Parece muito trabalhoso, mas como o Python é tão conciso e flexível, é surpreendentemente fácil. Você pode tornar a codificação muito mais agradável e divertida escrevendo suas funções de teste em paralelo com o “código de produção”, pois isso torna mais fácil encontrar bugs e até mesmo falhas de design mais cedo.

Os “módulos de suporte” que não se destinam a ser o módulo principal de um programa podem incluir um autoteste do módulo.

@example
if __name__ == "__main__":
    self_test()
@end example

Mesmo quando as interfaces externas não estiverem disponíveis, os programas que interagem com interfaces externas complexas podem ser testados usando as interfaces “falsas” implementadas no Python.

@node Como faço para criar uma documentação de doc strings?,Como faço para pressionar uma tecla de cada vez?,Como testar um programa ou componente Python?,Tarefas comuns
@anchor{faq/library how-do-i-create-documentation-from-doc-strings}@anchor{556a}
@subsubsection Como faço para criar uma documentação de doc strings?


O módulo @ref{b5,,pydoc} pode criar HTML a partir das strings de documentos em seu código-fonte Python. Uma alternativa para criar documentação de API puramente a partir de docstrings é epydoc@footnote{https://epydoc.sourceforge.net/}. Sphinx@footnote{https://www.sphinx-doc.org} também pode incluir conteúdo docstring.

@node Como faço para pressionar uma tecla de cada vez?,,Como faço para criar uma documentação de doc strings?,Tarefas comuns
@anchor{faq/library how-do-i-get-a-single-keypress-at-a-time}@anchor{556b}
@subsubsection Como faço para pressionar uma tecla de cada vez?


Para variantes do Unix existem várias soluções. Apesar de ser um módulo grande para aprender, é simples fazer isso usando o módulo curses.

@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 Threads,Entrada e Saída<2>,Tarefas comuns,FAQ de Bibliotecas e Extensões
@anchor{faq/library threads}@anchor{556c}
@subsection Threads


@menu
* Como faço para programar usando threads?:: 
* Nenhuma de minhas threads parece funcionar@comma{} por que?: Nenhuma de minhas threads parece funcionar por que?. 
* Como distribuo o trabalho entre várias threads de trabalho?:: 
* Que tipos de variáveis globais mutáveis são seguras para thread?:: 
* Não podemos remover a Trava Global do interpretador?:: 

@end menu

@node Como faço para programar usando threads?,Nenhuma de minhas threads parece funcionar por que?,,Threads
@anchor{faq/library how-do-i-program-using-threads}@anchor{556d}
@subsubsection Como faço para programar usando threads?


Certifique-se de usar o módulo @ref{ed,,threading} e não o módulo @ref{2,,_thread}. O módulo @ref{ed,,threading} constrói abstrações convenientes sobre as primitivas de baixo nível fornecidas pelo módulo @ref{2,,_thread}.

@node Nenhuma de minhas threads parece funcionar por que?,Como distribuo o trabalho entre várias threads de trabalho?,Como faço para programar usando threads?,Threads
@anchor{faq/library none-of-my-threads-seem-to-run-why}@anchor{556e}
@subsubsection Nenhuma de minhas threads parece funcionar, por que?


Assim que a thread principal acaba, todas as threads são eliminadas. Sua thread principal está sendo executada tão rápida que não está dando tempo para realizar qualquer trabalho.

Uma solução simples é adicionar um tempo de espera no final do programa até que todos os threads sejam concluídos:

@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

Mas agora (em muitas plataformas) as threads não funcionam em paralelo, mas parecem funcionar sequencialmente, um de cada vez! O motivo é que o agendador de threads do sistema operacional não inicia uma nova thread até que a thread anterior seja bloqueada.

Uma solução simples é adicionar um pequeno tempo de espera no início da função:

@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

Em vez de tentar adivinhar um bom valor de atraso para @ref{69d,,time.sleep()}, é melhor usar algum tipo de mecanismo de semáforo. Uma ideia é usar o módulo @ref{b6,,queue} para criar um objeto fila, deixar cada thread anexar um token à fila quando terminar e deixar a thread principal ler tantos tokens da fila quantos threads houver.

@node Como distribuo o trabalho entre várias threads de trabalho?,Que tipos de variáveis globais mutáveis são seguras para thread?,Nenhuma de minhas threads parece funcionar por que?,Threads
@anchor{faq/library how-do-i-parcel-out-work-among-a-bunch-of-worker-threads}@anchor{556f}
@subsubsection Como distribuo o trabalho entre várias threads de trabalho?


A maneira mais fácil é usar o módulo @ref{21,,concurrent.futures}, especialmente a classe @ref{742,,ThreadPoolExecutor}.

Ou, se quiser um controle preciso sobre o algoritmo de despacho, você pode escrever sua própria lógica manualmente. Use o módulo @ref{b6,,queue} para criar uma fila contendo uma lista de tarefas. A classe @ref{13db,,Queue} mantém uma lista de objetos e possui um método @code{.put(obj)} que adiciona itens à fila e um método @code{.get()} para retorná-los. A classe cuidará da trava necessário para garantir que cada trabalho seja entregue exatamente uma vez.

Aqui está um exemplo simples:

@example
import threading, queue, time

# A thread do worker obtém a tarefa da fila. Quando a fila está vazia,
# ela presume que não haverá mais tarefas e encerra.
# (Realisticamente, workers trabalharão até serem encerrados.)
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)

# Cria a fila
q = queue.Queue()

# Inicia um pool de 5 workers
for i in range(5):
    t = threading.Thread(target=worker, name='worker %i' % (i+1))
    t.start()

# Começa a adicionar tarefa à fila
for i in range(50):
    q.put(i)

# Dá às threads tempo para executar
print('Main thread sleeping')
time.sleep(5)
@end example

Quando executado, isso produzirá a seguinte saída:

@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 a documentação do módulo para mais detalhes; a classe @ref{13db,,Queue} fornece uma interface com recursos.

@node Que tipos de variáveis globais mutáveis são seguras para thread?,Não podemos remover a Trava Global do interpretador?,Como distribuo o trabalho entre várias threads de trabalho?,Threads
@anchor{faq/library what-kinds-of-global-value-mutation-are-thread-safe}@anchor{5570}
@subsubsection Que tipos de variáveis globais mutáveis são seguras para thread?


Uma @ref{148,,trava global do interpretador} (GIL) é usada internamente para garantir que apenas um thread seja executado na VM Python por vez. Em geral, Python oferece alternar entre threads apenas entre instruções de bytecode; a frequência com que ele muda pode ser definida via @ref{951,,sys.setswitchinterval()}. Cada instrução de bytecode e, portanto, todo o código de implementação C alcançado por cada instrução é, portanto, atômico do ponto de vista de um programa Python.

Em teoria, isso significa que uma contabilidade exata requer um entendimento exato da implementação do bytecode PVM. Na prática, isso significa que as operações em variáveis compartilhadas de tipos de dados integrados (inteiros, listas, dicionários, etc.) que “parecem atômicas” realmente são.

Por exemplo, as seguintes operações são todas atômicas (L, L1, L2 são listas, D, D1, D2 são dicionários, x, y são objetos, i, j são inteiros):

@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

Esses não são:

@example
i = i+1
L.append(L[-1])
L[i] = L[j]
D[x] = D[x] + 1
@end example

Operações que substituem outros objetos podem invocar o método @ref{1033,,__del__()} desses outros objetos quando sua contagem de referências chega a zero, e isso pode afetar as coisas. Isto é especialmente verdadeiro para as atualizações em massa de dicionários e listas. Em caso de dúvida, use um mutex!

@node Não podemos remover a Trava Global do interpretador?,,Que tipos de variáveis globais mutáveis são seguras para thread?,Threads
@anchor{faq/library can-t-we-get-rid-of-the-global-interpreter-lock}@anchor{5571}
@subsubsection Não podemos remover a Trava Global do interpretador?


A @ref{148,,trava global do interpretador} (GIL) é frequentemente vista como um obstáculo para a implantação do Python em máquinas servidoras multiprocessadas de ponta, porque um programa Python multi-threaded efetivamente usa apenas uma CPU, devido à insistência de que (quase) todo código Python só pode ser executado enquanto a GIL é mantida.

Com a aprovação da 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}, o trabalho está em andamento para remover a GIL da implementação CPython do Python. Inicialmente, ele será implementado como um sinalizador opcional de compilador ao construir o interpretador, e assim construções separadas estarão disponíveis com e sem a GIL. A longo prazo, a esperança é estabelecer uma única construção, uma vez que as implicações de desempenho da remoção do GIL sejam totalmente compreendidas. O Python 3.13 provavelmente será a primeira versão contendo esse trabalho, embora possa não ser completamente funcional nesta versão.

O trabalho atual para remover a GIL é baseado em um fork do Python 3.9 com a GIL removida@footnote{https://github.com/colesbury/nogil} por Sam Gross. Antes disso, na época do Python 1.5, Greg Stein implementou um conjunto abrangente de patches (os patches de “threads livres”) que removeu a GIL e a substituiu por um travamento de granulação fina. Adam Olsen fez um experimento semelhante em seu projeto python-safethread@footnote{https://code.google.com/archive/p/python-safethread}. Infelizmente, ambos os experimentos iniciais exibiram uma queda acentuada no desempenho de thread único (pelo menos 30% mais lento), devido à quantidade de travamento de granulação fina necessária para compensar a remoção da GIL. O fork do Python 3.9 é a primeira tentativa de remover a GIL com um impacto aceitável no desempenho.

A presença da GIL nas versões atuais do Python não significa que você não pode fazer bom uso do Python em máquinas com várias CPUs! Você só precisa ser criativo ao dividir o trabalho entre vários `processos' em vez de vários `threads'. A classe @ref{8f4,,ProcessPoolExecutor} no novo módulo @ref{21,,concurrent.futures} fornece uma maneira fácil de fazer isso; o módulo @ref{94,,multiprocessing} fornece uma API de nível inferior, caso você queira mais controle sobre o despacho de tarefas.

O uso criterioso de extensões C também ajudará; se você usar uma extensão C para executar uma tarefa demorada, a extensão poderá liberar a GIL enquanto o thread de execução estiver no código C e permitir que outros threads realizem algum trabalho. Alguns módulos de biblioteca padrão como @ref{133,,zlib} e @ref{68,,hashlib} já fazem isso.

Uma abordagem alternativa para reduzir o impacto da GIL é fazer da GIL uma trava por estado do interpretador em vez de verdadeiramente global. Isso foi @ref{43c,,implementado pela primeira vez no Python 3.12} e está disponível na API C. Uma interface Python para ele é esperada no Python 3.13. A principal limitação para ele no momento provavelmente são módulos de extensão de terceiros, já que estes devem ser escritos com múltiplos interpretadores em mente para serem utilizáveis, então muitos módulos de extensão mais antigos não serão utilizáveis.

@node Entrada e Saída<2>,Programação Rede / Internet,Threads,FAQ de Bibliotecas e Extensões
@anchor{faq/library input-and-output}@anchor{5572}
@subsection Entrada e Saída


@menu
* Como faço para excluir um arquivo? (E outras perguntas sobre arquivos): Como faço para excluir um arquivo? E outras perguntas sobre arquivos. 
* Como eu copio um arquivo?:: 
* Como leio (ou escrevo) dados binários?: Como leio ou escrevo dados binários?. 
* Por que não consigo usar os.read() em um encadeamento com os.popen()?: Por que não consigo usar os read em um encadeamento com os popen ?. 
* Como acesso a porta serial (RS232)?: Como acesso a porta serial RS232 ?. 
* Por que o sys.stdout (stdin@comma{} stderr) não fecha?: Por que o sys stdout stdin stderr não fecha?. 

@end menu

@node Como faço para excluir um arquivo? E outras perguntas sobre arquivos,Como eu copio um arquivo?,,Entrada e Saída<2>
@anchor{faq/library how-do-i-delete-a-file-and-other-file-questions}@anchor{5573}
@subsubsection Como faço para excluir um arquivo? (E outras perguntas sobre arquivos)


Use @code{os.remove(arquivo)} ou @code{os.unlink(arquivo)}; para documentação, veja o módulo @ref{a1,,os}. As duas funções são idênticas; @ref{1134,,unlink()} é simplesmente o nome da chamada do sistema para esta função no Unix.

Para remover um diretório, use @ref{1132,,os.rmdir()}; use @ref{21d,,os.mkdir()} para criar um. @code{os.makedirs(caminho)} criará quaisquer diretórios intermediários em @code{path} que não existam. @code{os.removedirs(caminho)} removerá diretórios intermediários, desde que estejam vazios; se quiser excluir toda uma árvore de diretórios e seu conteúdo, use @ref{301,,shutil.rmtree()}.

Para renomear um arquivos, use @code{os.rename(caminho_antigo, caminho_novo)}.

Para truncar um arquivo, abra-o usando @code{f = open(arquivo, "rb+")}, e use @code{f.truncate(posição)}; a posição tem como padrão a posição atual de busca. Há também @code{os.ftruncate(fd, posição)} para arquivos abertos com @ref{dba,,os.open()}, onde `fd' é o descritor de arquivo (um pequeno inteiro).

O módulo @ref{c5,,shutil} também contém uma série de funções para trabalhar em arquivos, incluindo @ref{a63,,copyfile()}, @ref{a33,,copytree()} e @ref{301,,rmtree()}.

@node Como eu copio um arquivo?,Como leio ou escrevo dados binários?,Como faço para excluir um arquivo? E outras perguntas sobre arquivos,Entrada e Saída<2>
@anchor{faq/library how-do-i-copy-a-file}@anchor{5574}
@subsubsection Como eu copio um arquivo?


O módulo @ref{c5,,shutil} contém uma função @ref{a63,,copyfile()}. Observe que em volumes NTFS do Windows, ele não copia fluxos de dados alternativos@footnote{https://en.wikipedia.org/wiki/NTFS#Alternate_data_stream_(ADS)} nem forks de recursos@footnote{https://en.wikipedia.org/wiki/Resource_fork} em volumes HFS+ do macOS, embora ambos sejam raramente usados agora. Ele também não copia permissões de arquivo e metadados, embora usar @ref{a65,,shutil.copy2()} em vez disso preserve a maioria (embora não todos) deles.

@node Como leio ou escrevo dados binários?,Por que não consigo usar os read em um encadeamento com os popen ?,Como eu copio um arquivo?,Entrada e Saída<2>
@anchor{faq/library how-do-i-read-or-write-binary-data}@anchor{5575}
@subsubsection Como leio (ou escrevo) dados binários?


Para ler ou escrever formatos de dados binários complexos, é melhor usar o módulo @ref{d5,,struct}. Ele permite que você pegue uma string contendo dados binários (geralmente números) e a converta em objetos Python; e vice-versa.

Por exemplo, o código a seguir lê dois inteiros de 2 bytes e um inteiro de 4 bytes no formato big-endian de um arquivo:

@example
import struct

with open(filename, "rb") as f:
    s = f.read(8)
    x, y, z = struct.unpack(">hhl", s)
@end example

O ‘>’ na string de formato força dados big-endian; a letra ‘h’ lê um “inteiro curto” (2 bytes) e ‘l’ lê um “inteiro longo” (4 bytes) da string.

Para dados mais regulares (por exemplo, uma lista homogênea de ints ou floats), você também pode usar o módulo @ref{7,,array}.

@cartouche
@quotation Nota 
Para ler e escrever dados binários, é obrigatório abrir o arquivo no modo binário (aqui, passando @code{"rb"} para @ref{51c,,open()}). Se você usar @code{"r"} em vez disso (o padrão), o arquivo será aberto no modo texto e @code{f.read()} retornará objetos @ref{44c,,str} em vez de objetos @ref{1c2,,bytes}.
@end quotation
@end cartouche

@node Por que não consigo usar os read em um encadeamento com os popen ?,Como acesso a porta serial RS232 ?,Como leio ou escrevo dados binários?,Entrada e Saída<2>
@anchor{faq/library i-can-t-seem-to-use-os-read-on-a-pipe-created-with-os-popen-why}@anchor{5576}
@subsubsection Por que não consigo usar os.read() em um encadeamento com os.popen()?


@ref{dbd,,os.read()} é uma função de baixo nível que pega um descritor de arquivo, um pequeno inteiro representando o arquivo aberto. @ref{a91,,os.popen()} cria um objeto arquivo de alto nível, o mesmo tipo retornado pela função embutida @ref{51c,,open()}. Assim, para ler `n' bytes de um pipe `p' criado com @ref{a91,,os.popen()}, você precisa usar @code{p.read(n)}.

@c XXX update to use subprocess. See the :ref:`subprocess-replacements` section.
@c 
@c How do I run a subprocess with pipes connected to both input and output?
@c ------------------------------------------------------------------------
@c 
@c Use the :mod:`popen2` module.  For example::
@c 
@c    import popen2
@c    fromchild, tochild = popen2.popen2("command")
@c    tochild.write("input\n")
@c    tochild.flush()
@c    output = fromchild.readline()
@c 
@c Warning: in general it is unwise to do this because you can easily cause a
@c deadlock where your process is blocked waiting for output from the child
@c while the child is blocked waiting for input from you.  This can be caused
@c by the parent expecting the child to output more text than it does or
@c by data being stuck in stdio buffers due to lack of flushing.
@c The Python parent can of course explicitly flush the data it sends to the
@c child before it reads any output, but if the child is a naive C program it
@c may have been written to never explicitly flush its output, even if it is
@c interactive, since flushing is normally automatic.
@c 
@c Note that a deadlock is also possible if you use :func:`popen3` to read
@c stdout and stderr. If one of the two is too large for the internal buffer
@c (increasing the buffer size does not help) and you ``read()`` the other one
@c first, there is a deadlock, too.
@c 
@c Note on a bug in popen2: unless your program calls ``wait()`` or
@c ``waitpid()``, finished child processes are never removed, and eventually
@c calls to popen2 will fail because of a limit on the number of child
@c processes.  Calling :func:`os.waitpid` with the :const:`os.WNOHANG` option can
@c prevent this; a good place to insert such a call would be before calling
@c ``popen2`` again.
@c 
@c In many cases, all you really need is to run some data through a command and
@c get the result back.  Unless the amount of data is very large, the easiest
@c way to do this is to write it to a temporary file and run the command with
@c that temporary file as input.  The standard module :mod:`tempfile` exports a
@c :func:`~tempfile.mktemp` function to generate unique temporary file names. ::
@c 
@c    import tempfile
@c    import os
@c 
@c    class Popen3:
@c        """
@c        This is a deadlock-safe version of popen that returns
@c        an object with errorlevel, out (a string) and err (a string).
@c        (capturestderr may not work under windows.)
@c        Example: print(Popen3('grep spam','\n\nhere spam\n\n').out)
@c        """
@c        def __init__(self,command,input=None,capturestderr=None):
@c            outfile=tempfile.mktemp()
@c            command="( %s ) > %s" % (command,outfile)
@c            if input:
@c                infile=tempfile.mktemp()
@c                open(infile,"w").write(input)
@c                command=command+" <"+infile
@c            if capturestderr:
@c                errfile=tempfile.mktemp()
@c                command=command+" 2>"+errfile
@c            self.errorlevel=os.system(command) >> 8
@c            self.out=open(outfile,"r").read()
@c            os.remove(outfile)
@c            if input:
@c                os.remove(infile)
@c            if capturestderr:
@c                self.err=open(errfile,"r").read()
@c                os.remove(errfile)
@c 
@c Note that many interactive programs (e.g. vi) don't work well with pipes
@c substituted for standard input and output.  You will have to use pseudo ttys
@c ("ptys") instead of pipes. Or you can use a Python interface to Don Libes'
@c "expect" library.  A Python extension that interfaces to expect is called
@c "expy" and available from https://expectpy.sourceforge.net.  A pure Python
@c solution that works like expect is :pypi:`pexpect`.

@node Como acesso a porta serial RS232 ?,Por que o sys stdout stdin stderr não fecha?,Por que não consigo usar os read em um encadeamento com os popen ?,Entrada e Saída<2>
@anchor{faq/library how-do-i-access-the-serial-rs232-port}@anchor{5577}
@subsubsection Como acesso a porta serial (RS232)?


Para Win32, OSX, Linux, BSD, Jython, IronPython:

@quotation

pyserial@footnote{https://pypi.org/project/pyserial/}
@end quotation

Para Unix, veja uma postagem da Usenet de Mitch Chapman:

@quotation

@indicateurl{https://groups.google.com/groups?selm=34A04430.CF9@@ohioee.com}
@end quotation

@node Por que o sys stdout stdin stderr não fecha?,,Como acesso a porta serial RS232 ?,Entrada e Saída<2>
@anchor{faq/library why-doesn-t-closing-sys-stdout-stdin-stderr-really-close-it}@anchor{5578}
@subsubsection Por que o sys.stdout (stdin, stderr) não fecha?


Os @ref{1203,,objetos arquivos} do Python são uma camada de alto nível de abstração em descritores de arquivo C de baixo nível.

Para a maioria dos objetos arquivo que você cria em Python por meio da função embutida @ref{51c,,open()}, @code{f.close()} marca o objeto arquivo Python como fechado do ponto de vista do Python e também organiza o fechamento do descritor de arquivo C subjacente. Isso também acontece automaticamente no destrutor de @code{f}, quando @code{f} se torna lixo.

Mas stdin, stdout e stderr são tratados de forma especial pelo Python, devido ao status especial que também lhes é dado pelo C. Executar @code{sys.stdout.close()} marca o objeto arquivo de nível Python como fechado, mas `não' fecha o descritor de arquivo C associado.

Para fechar o descritor de arquivo C subjacente para um desses três, você deve primeiro ter certeza de que é isso que você realmente quer fazer (por exemplo, você pode confundir módulos de extensão tentando fazer E/S). Se for, use @ref{b8a,,os.close()}:

@example
os.close(stdin.fileno())
os.close(stdout.fileno())
os.close(stderr.fileno())
@end example

Ou você pode usar as constantes numéricas 0, 1 e 2, respectivamente.

@node Programação Rede / Internet,Base de Dados,Entrada e Saída<2>,FAQ de Bibliotecas e Extensões
@anchor{faq/library network-internet-programming}@anchor{5579}
@subsection Programação Rede / Internet


@menu
* Quais ferramentas para WWW existem no Python?:: 
* Qual módulo devo usar para ajudar na geração do HTML?:: 
* Como envio um e-mail de um script Python?:: 
* Como evito um bloqueio no método connect() de um soquete?: Como evito um bloqueio no método connect de um soquete?. 

@end menu

@node Quais ferramentas para WWW existem no Python?,Qual módulo devo usar para ajudar na geração do HTML?,,Programação Rede / Internet
@anchor{faq/library what-www-tools-are-there-for-python}@anchor{557a}
@subsubsection Quais ferramentas para WWW existem no Python?


Veja os capítulos intitulados @ref{3b6e,,Protocolos de Internet e Suporte} e @ref{3763,,Manuseio de Dados na Internet} no Manual de Referência da Biblioteca. Python tem muitos módulos que ajudarão você a construir sistemas web do lado do servidor e do lado do cliente.

@c XXX check if wiki page is still up to date

Um resumo dos frameworks disponíveis é disponibilizado por Paul Boddie em @indicateurl{https://wiki.python.org/moin/WebProgramming}.

@node Qual módulo devo usar para ajudar na geração do HTML?,Como envio um e-mail de um script Python?,Quais ferramentas para WWW existem no Python?,Programação Rede / Internet
@anchor{faq/library what-module-should-i-use-to-help-with-generating-html}@anchor{557b}
@subsubsection Qual módulo devo usar para ajudar na geração do HTML?


@c XXX add modern template languages

Você pode encontrar uma coleção de links úteis na página wiki WebProgramming@footnote{https://wiki.python.org/moin/WebProgramming}.

@node Como envio um e-mail de um script Python?,Como evito um bloqueio no método connect de um soquete?,Qual módulo devo usar para ajudar na geração do HTML?,Programação Rede / Internet
@anchor{faq/library how-do-i-send-mail-from-a-python-script}@anchor{557c}
@subsubsection Como envio um e-mail de um script Python?


Use a biblioteca padrão do módulo @ref{ca,,smtplib}.

Aqui está um remetente de e-mail interativo muito simples. Este método funcionará em qualquer host que suporte o protocolo 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

# O envio de e-mail real
server = smtplib.SMTP('localhost')
server.sendmail(fromaddr, toaddrs, msg)
server.quit()
@end example

Uma alternativa somente para Unix usa o sendmail. A localização do programa sendmail varia entre os sistemas; às vezes é @code{/usr/lib/sendmail}, às vezes @code{/usr/sbin/sendmail}. A página de manual do sendmail vai ajudar você. Aqui está um código de exemplo:

@example
import os

SENDMAIL = "/usr/sbin/sendmail"  # local do sendmail
p = os.popen("%s -t -i" % SENDMAIL, "w")
p.write("To: receiver@@example.com\n")
p.write("Subject: teste\n")
p.write("\n")  # linha vazia separando cabeçalho do corpo
p.write("Algum texto\n")
p.write("mais um pouco de texto\n")
sts = p.close()
if sts != 0:
    print("Status de saída do sendmail", sts)
@end example

@node Como evito um bloqueio no método connect de um soquete?,,Como envio um e-mail de um script Python?,Programação Rede / Internet
@anchor{faq/library how-do-i-avoid-blocking-in-the-connect-method-of-a-socket}@anchor{557d}
@subsubsection Como evito um bloqueio no método connect() de um soquete?


O módulo @ref{c1,,select} é normalmente usado para ajudar com E/S assíncrona nos soquetes.

Para evitar que a conexão TCP bloqueie, você pode definir o soquete para o modo sem bloqueio. Então, quando você fizer o @ref{dcb,,connect()}, você se conectará imediatamente (improvável) ou obterá uma exceção que contém o número de erro como @code{.errno}. @code{errno.EINPROGRESS} indica que a conexão está em andamento, mas ainda não terminou. Diferentes sistemas operacionais retornarão valores diferentes, então você terá que verificar o que é retornado no seu sistema.

Você pode usar o método @ref{1582,,connect_ex()} para evitar criar uma exceção. Ele retornará apenas o valor de errno. Para pesquisar, você pode chamar @ref{1582,,connect_ex()} novamente mais tarde – @code{0} ou @code{errno.EISCONN} indicam que você está conectado – ou você pode passar este soquete para @ref{dc8,,select.select()} para verificar se ele é gravável.

@cartouche
@quotation Nota 
O módulo @ref{a,,asyncio} fornece uma biblioteca assíncrona de thread única e concorrente de propósito geral, que pode ser usada para escrever código de rede não bloqueante. A biblioteca de terceiros Twisted@footnote{https://twisted.org/} é uma alternativa popular e rica em recursos.
@end quotation
@end cartouche

@node Base de Dados,Matemáticos e Numéricos,Programação Rede / Internet,FAQ de Bibliotecas e Extensões
@anchor{faq/library databases}@anchor{557e}
@subsection Base de Dados


@menu
* Existem interfaces para banco de dados em Python?:: 
* Como você implementa objetos persistentes no Python?:: 

@end menu

@node Existem interfaces para banco de dados em Python?,Como você implementa objetos persistentes no Python?,,Base de Dados
@anchor{faq/library are-there-any-interfaces-to-database-packages-in-python}@anchor{557f}
@subsubsection Existem interfaces para banco de dados em Python?


Sim.

Interfaces para hashes baseados em disco, como @ref{34,,DBM} e @ref{33,,GDBM} também estão incluídas no Python padrão. Há também o módulo @ref{cf,,sqlite3}, que fornece um banco de dados relacional baseado em disco leve.

Suporte para a maioria dos bancos de dados relacionais está disponível. Para mais detalhes, veja a página wiki DatabaseProgramming@footnote{https://wiki.python.org/moin/DatabaseProgramming} para detalhes.

@node Como você implementa objetos persistentes no Python?,,Existem interfaces para banco de dados em Python?,Base de Dados
@anchor{faq/library how-do-you-implement-persistent-objects-in-python}@anchor{5580}
@subsubsection Como você implementa objetos persistentes no Python?


O módulo de biblioteca @ref{a6,,pickle} resolve isso de uma maneira muito geral (embora você ainda não possa armazenar coisas como arquivos abertos, soquetes ou janelas), e o módulo de biblioteca @ref{c3,,shelve} usa pickle e (g)dbm para criar mapeamentos persistentes contendo objetos Python arbitrários.

@node Matemáticos e Numéricos,,Base de Dados,FAQ de Bibliotecas e Extensões
@anchor{faq/library mathematics-and-numerics}@anchor{5581}
@subsection Matemáticos e Numéricos


@menu
* Como gero número aleatórios no Python?:: 

@end menu

@node Como gero número aleatórios no Python?,,,Matemáticos e Numéricos
@anchor{faq/library how-do-i-generate-random-numbers-in-python}@anchor{5582}
@subsubsection Como gero número aleatórios no Python?


O módulo padrão @ref{b8,,random} implementa um gerador de números aleatórios. O uso é simples:

@example
import random
random.random()
@end example

Isso retorna um número flutuante aleatório no intervalo [0, 1).

Existem também muitos outros geradores aleatórios neste módulo, como:


@itemize *

@item 
@code{randrange(a, b)} escolhe um número inteiro no intervalo entre [a, b).

@item 
@code{uniform(a, b)} escolhe um número de ponto flutuante no intervalo [a, b).

@item 
@code{normalvariate(mean, sdev)} gera números pseudoaleatórios que seguem uma distribuição normal (Gaussiana).
@end itemize

Algumas funções de nível elevado operam diretamente em sequencia, como:


@itemize *

@item 
@code{choice(S)} escolhe um elemento aleatório de uma determinada sequência.

@item 
@code{shuffle(L)} embaralha uma lista internamente, ou seja permuta seus elementos aleatoriamente.
@end itemize

Existe também uma classe @code{Random} que você pode instanciar para criar vários geradores de números aleatórios independentes.

@node FAQ sobre Extensão/Incorporação,Python no Windows,FAQ de Bibliotecas e Extensões,Perguntas Frequentes Sobre Python
@anchor{faq/extending doc}@anchor{5583}@anchor{faq/extending extending-embedding-faq}@anchor{5584}@anchor{faq/extending translation-repo}@anchor{5585}
@section FAQ sobre Extensão/Incorporação



@c XXX need review for Python 3.

@menu
* Posso criar minhas próprias funções em C?:: 
* Posso criar minhas próprias funções em C++?:: 
* Escrever C é difícil; há alguma alternativa?:: 
* Como posso executar instruções arbitrárias de Python a partir de C?:: 
* Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?:: 
* Como extraio valores em C a partir de um objeto Python?:: 
* Como posso utilizar Py_BuildValue() para criar uma tupla de comprimento arbitrário?: Como posso utilizar Py_BuildValue para criar uma tupla de comprimento arbitrário?. 
* Como eu chamo um método de um objeto a partir do C?:: 
* Como posso capturar a saída da função PyErr_Print() (ou qualquer outra coisa que escreva para stdout/stderr)?: Como posso capturar a saída da função PyErr_Print ou qualquer outra coisa que escreva para stdout/stderr ?. 
* Como faço para acessar a partir do C um módulo escrito em Python?:: 
* Como posso interagir com objetos C++ a partir do Python?:: 
* Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?:: 
* Como eu depuro uma extensão?:: 
* Quero compilar um módulo Python no meu sistema Linux@comma{} mas alguns arquivos estão faltando. Por quê?: Quero compilar um módulo Python no meu sistema Linux mas alguns arquivos estão faltando Por quê?. 
* Como posso distinguir “entrada incompleta” de “entrada inválida”?:: 
* Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?:: 
* Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python (por exemplo@comma{} via herança)?: Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python por exemplo via herança ?. 

@end menu

@node Posso criar minhas próprias funções em C?,Posso criar minhas próprias funções em C++?,,FAQ sobre Extensão/Incorporação
@anchor{faq/extending can-i-create-my-own-functions-in-c}@anchor{5586}
@subsection Posso criar minhas próprias funções em C?


Sim, você pode construir módulos embutidos contendo funções, variáveis, exceções e até mesmo novos tipos em C. Isso é explicado no documento @ref{1d56,,Estendendo e incorporando o interpretador Python}.

A maioria dos livros intermediários ou avançados em Python também abordará esse tópico.

@node Posso criar minhas próprias funções em C++?,Escrever C é difícil; há alguma alternativa?,Posso criar minhas próprias funções em C?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending id1}@anchor{5587}
@subsection Posso criar minhas próprias funções em C++?


Sim, usando recursos de compatibilidade encontrados em C++. Coloque @code{extern "C" @{ ... @}} em torno dos arquivos de inclusão do Python e coloque @code{extern "C"} antes de cada função que será chamada pelo interpretador do Python. Objetos globais ou estáticos em C++ com construtores provavelmente não são uma boa ideia.

@node Escrever C é difícil; há alguma alternativa?,Como posso executar instruções arbitrárias de Python a partir de C?,Posso criar minhas próprias funções em C++?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending c-wrapper-software}@anchor{5588}@anchor{faq/extending writing-c-is-hard-are-there-any-alternatives}@anchor{5589}
@subsection Escrever C é difícil; há alguma alternativa?


Há diversas alternativas para escrever suas próprias extensões C, dependendo do que você está tentando fazer. @ref{4b37,,Ferramentas recomendadas de terceiros} oferecem abordagens mais simples e mais sofisticadas para criar extensões C e C++ para Python.

@node Como posso executar instruções arbitrárias de Python a partir de C?,Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?,Escrever C é difícil; há alguma alternativa?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-can-i-execute-arbitrary-python-statements-from-c}@anchor{558a}
@subsection Como posso executar instruções arbitrárias de Python a partir de C?


A função mais alto-nível para isso é a @ref{4bb5,,PyRun_SimpleString()}, que recebe como único argumento uma string a ser executada no contexto do módulo @code{__main__} e retorna @code{0} para sucesso e @code{-1} quando uma exceção ocorrer (incluindo @ref{18d,,SyntaxError}).  Se quiser mais controle, use @ref{1b52,,PyRun_String()}; veja o código-fonte de @ref{4bb5,,PyRun_SimpleString()} em @code{Python/pythonrun.c}.

@node Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?,Como extraio valores em C a partir de um objeto Python?,Como posso executar instruções arbitrárias de Python a partir de C?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-can-i-evaluate-an-arbitrary-python-expression-from-c}@anchor{558b}
@subsection Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?


Chame a função @ref{1b52,,PyRun_String()} da pergunta anterior passando @ref{4e56,,Py_eval_input} como o símbolo de início; ela faz a análise sintática de uma expressão, a executa, e retorna o seu valor.

@node Como extraio valores em C a partir de um objeto Python?,Como posso utilizar Py_BuildValue para criar uma tupla de comprimento arbitrário?,Como posso executar e obter o resultado de uma expressão Python arbitrária a partir de C?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-extract-c-values-from-a-python-object}@anchor{558c}
@subsection Como extraio valores em C a partir de um objeto Python?


Depende do tipo do objeto.  Se for uma tupla, a @ref{4d77,,PyTuple_Size()} retorna o seu comprimento e a @ref{4b61,,PyTuple_GetItem()} retorna o item em um determinado índice.  Listas têm funções similares, @ref{1461,,PyList_Size()} e @ref{35a,,PyList_GetItem()}.

Para bytes, a @ref{4c20,,PyBytes_Size()} retorna o comprimento e a @ref{4c18,,PyBytes_AsStringAndSize()} fornece um ponteiro para o seu valor e o seu comprimento. Note que objetos bytes em Python podem conter bytes nulos, de forma que a @code{strlen()} do C não deve ser usada.

Para testar o tipo de um objeto, primeiramente se certifique de que ele não é @code{NULL}, e então use @ref{13e6,,PyBytes_Check()}, @ref{500d,,PyTuple_Check()}, @ref{501e,,PyList_Check()}, etc.

Também existe uma API alto-nível para objetos Python fornecida pela chamada interface “abstrata” – leia @code{Include/abstract.h} para mais detalhes.  Ela permite interagir com qualquer tipo de sequência Python usando chamadas como @ref{4d47,,PySequence_Length()}, @ref{1bcd,,PySequence_GetItem()}, etc, além de vários outros protocolos úteis tais como números (@ref{897,,PyNumber_Index()} e outros) e mapeamentos nas APIs PyMapping.

@node Como posso utilizar Py_BuildValue para criar uma tupla de comprimento arbitrário?,Como eu chamo um método de um objeto a partir do C?,Como extraio valores em C a partir de um objeto Python?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length}@anchor{558d}
@subsection Como posso utilizar Py_BuildValue() para criar uma tupla de comprimento arbitrário?


Não é possível. Use a função @ref{4d76,,PyTuple_Pack()} para isso.

@node Como eu chamo um método de um objeto a partir do C?,Como posso capturar a saída da função PyErr_Print ou qualquer outra coisa que escreva para stdout/stderr ?,Como posso utilizar Py_BuildValue para criar uma tupla de comprimento arbitrário?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-call-an-object-s-method-from-c}@anchor{558e}
@subsection Como eu chamo um método de um objeto a partir do C?


A função @ref{39f,,PyObject_CallMethod()} pode ser usada para chamar um método arbitrário de um objeto.  Os parâmetros são o objeto, o nome do método a ser chamado, uma string de formato como a usada em @ref{8ac,,Py_BuildValue()}, e os valores dos argumentos:

@example
PyObject *
PyObject_CallMethod(PyObject *object, const char *method_name,
                    const char *arg_format, ...);
@end example

Isso funciona para qualquer objeto que tenha métodos – sejam eles embutidos ou definidos por usuário. Você fica então responsável por chamar @ref{56f,,Py_DECREF()} no valor de retorno.

Para chamar, por exemplo, o método “seek” de um objeto arquivo com argumentos 10, 0 (presumindo que “f” é o ponteiro para o objeto arquivo):

@example
res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);
if (res == NULL) @{
        ... ocorreu uma exceção ...
@}
else @{
        Py_DECREF(res);
@}
@end example

Note que a função @ref{4b56,,PyObject_CallObject()} `sempre' recebe os argumentos da chamada como uma tupla, de forma que para chamar uma função sem argumentos deve-se passar “()” como formato, e para chamar uma função com 1 argumento, coloque-o entre parênteses, por exemplo “(i)”.

@node Como posso capturar a saída da função PyErr_Print ou qualquer outra coisa que escreva para stdout/stderr ?,Como faço para acessar a partir do C um módulo escrito em Python?,Como eu chamo um método de um objeto a partir do C?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr}@anchor{558f}
@subsection Como posso capturar a saída da função PyErr_Print() (ou qualquer outra coisa que escreva para stdout/stderr)?


Com código Python, defina um objeto que suporte o método @code{write()}. Atribua esse objeto a @ref{ae6,,sys.stdout} e @ref{940,,sys.stderr}. Chame print_error, or simplesmente deixe o mecanismo padrão de traceback acontecer. Assim, a saída irá para onde quer que o seu método @code{write()} a envie.

O jeito mais fácil de fazer isso é usar a classe @ref{f59,,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

Um objeto personalizado para fazer a mesma coisa seria esse:

@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 Como faço para acessar a partir do C um módulo escrito em Python?,Como posso interagir com objetos C++ a partir do Python?,Como posso capturar a saída da função PyErr_Print ou qualquer outra coisa que escreva para stdout/stderr ?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-access-a-module-written-in-python-from-c}@anchor{5590}
@subsection Como faço para acessar a partir do C um módulo escrito em Python?


Você pode obter um pointeiro para o objeto de módulo da seguinte maneira:

@example
module = PyImport_ImportModule("<modulename>");
@end example

Se o módulo ainda não foi importado (isto é, ainda não aparece no @ref{1636,,sys.modules}), essa função vai inicializar o módulo; caso contrário, ela vai simplesmente retornar o valor de @code{sys.modules["<modulename>"]}.  Note que ela não adiciona o módulo a nenhum espaço de nomes – ela simplesmente garante que ele foi inicializado e colocado no @ref{1636,,sys.modules}.

Você pode então acessar os atributos do módulo (isto é, qualquer nome definido no módulo) assim:

@example
attr = PyObject_GetAttrString(module, "<attrname>");
@end example

Chamar @ref{16ec,,PyObject_SetAttrString()} para definir variáveis no módulo também funciona.

@node Como posso interagir com objetos C++ a partir do Python?,Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?,Como faço para acessar a partir do C um módulo escrito em Python?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-interface-to-c-objects-from-python}@anchor{5591}
@subsection Como posso interagir com objetos C++ a partir do Python?


Dependendo das suas necessidades, há diversas abordagens.  Para fazer isso manualmente, comece lendo @ref{1d56,,o documento “Estendendo e Incorporando”}.  Note que, para o sistema Python em tempo de execução, não há muita diferença entre C e C++ – de forma que a estratégia de construir um novo tipo Python ao redor de uma estrutura C (ou ponteiro para uma) também funciona para objetos C++.

Para bibliotecas C++, veja @ref{5588,,Escrever C é difícil; há alguma alternativa?}.

@node Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?,Como eu depuro uma extensão?,Como posso interagir com objetos C++ a partir do Python?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending i-added-a-module-using-the-setup-file-and-the-make-fails-why}@anchor{5592}
@subsection Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?


O Setup deve terminar com uma quebra de linha; se não houver uma quebra de linha no final, o processo de compilação falha.  (Consertar isso requer umas gambiarras feias em shell script, e esse bug é tão pequeno que o esforço não parece valer a pena.)

@node Como eu depuro uma extensão?,Quero compilar um módulo Python no meu sistema Linux mas alguns arquivos estão faltando Por quê?,Adicionei um módulo usando o arquivo de Setup e o make falha; por quê?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-debug-an-extension}@anchor{5593}
@subsection Como eu depuro uma extensão?


Ao usar o GDB com extensões carregadas dinamicamente, você não consegue definir um ponto de interrupção antes da sua extensão ser carregada.

No seu arquivo @code{.gdbinit} (ou então interativamente), adicione o comando:

@example
br _PyImport_LoadDynamicModule
@end example

Então, ao executar o GDB:

@example
$ gdb /local/bin/python
gdb) run myscript.py
gdb) continue # repita até que a sua extensão seja carregada
gdb) finish   # para que a sua extensão seja carregada
gdb) br myfunction.c:50
gdb) continue
@end example

@node Quero compilar um módulo Python no meu sistema Linux mas alguns arquivos estão faltando Por quê?,Como posso distinguir “entrada incompleta” de “entrada inválida”?,Como eu depuro uma extensão?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why}@anchor{5594}
@subsection Quero compilar um módulo Python no meu sistema Linux, mas alguns arquivos estão faltando. Por quê?


A maioria das versões empacotadas de Python omitem alguns arquivos necessários para compilar extensões do Python.

Em sistemas Red Hat, instale o RPM python3-devel para obter os arquivos necessários.

Para Debian, execute @code{apt-get install python3-dev}.

@node Como posso distinguir “entrada incompleta” de “entrada inválida”?,Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?,Quero compilar um módulo Python no meu sistema Linux mas alguns arquivos estão faltando Por quê?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-tell-incomplete-input-from-invalid-input}@anchor{5595}
@subsection Como posso distinguir “entrada incompleta” de “entrada inválida”?


Às vezes você quer emular o comportamento do interpretador interativo do Python, que te dá um prompt de continuação quando a entrada está incompleta (por exemplo, você digitou o início de uma instrução “if”, ou então não fechou os parênteses ou aspas triplas), mas que te dá um mensagem de erro de sintaxe imediatamente se a entrada for inválida.

Em Python você pode usar o módulo @ref{1c,,codeop}, que aproxima suficientemente o comportamento do analisador sintático.  Por exemplo, o IDLE o usa.

Em C, a forma mais fácil de fazer isso é chamar @ref{4e5e,,PyRun_InteractiveLoop()} (talvez em uma thread separada) e deixar o interpretador do Python tratar a entrada para você. Você também pode apontar o @ref{586,,PyOS_ReadlineFunctionPointer()} para a sua função de entrada personalizada. Consulte @code{Modules/readline.c} e @code{Parser/myreadline.c} para mais dicas.

@node Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?,Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python por exemplo via herança ?,Como posso distinguir “entrada incompleta” de “entrada inválida”?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual}@anchor{5596}
@subsection Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?


Para carregar dinamicamente módulos de extensão feitos com g++, você precisa recompilar o Python, usando o g++ como ligador (mude a constante LINKCC no Makefile dos módulos de extensão do Python), e use o g++ também como ligador do seu módulo (por exemplo, @code{g++ -shared -o mymodule.so mymodule.o}).

@node Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python por exemplo via herança ?,,Como encontro os símbolos __builtin_new ou __pure_virtual não-definidos no g++?,FAQ sobre Extensão/Incorporação
@anchor{faq/extending can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance}@anchor{5597}
@subsection Posso criar uma classe de objetos com alguns métodos implementados em C e outros em Python (por exemplo, via herança)?


Sim, você pode herdar de classes embutidas como @ref{257,,int}, @ref{611,,list}, @ref{256,,dict} etc.

A Boost Python Library (BPL, @indicateurl{https://www.boost.org/libs/python/doc/index.html}) fornece uma forma de fazer isso a partir do C++ (quer dizer, você consegue herdar de uma classe de extensão escrita em C++ usando a BPL).

@node Python no Windows,FAQ da Interface Gráfica do Usuário,FAQ sobre Extensão/Incorporação,Perguntas Frequentes Sobre Python
@anchor{faq/windows doc}@anchor{5598}@anchor{faq/windows python-on-windows-faq}@anchor{5599}@anchor{faq/windows translation-repo}@anchor{559a}@anchor{faq/windows windows-faq}@anchor{559b}
@section Python no Windows



@c XXX need review for Python 3.
@c XXX need review for Windows Vista/Seven?

@menu
* Como faço para executar um programa Python no Windows?:: 
* Como eu faço para criar programas Python executáveis?:: 
* Por que Python às vezes demora tanto para iniciar?:: 
* Como eu faço para criar um executável a partir de um código Python?:: 
* Um arquivo *.pyd é o mesmo que um DLL?: Um arquivo * pyd é o mesmo que um DLL?. 
* Como eu posso embutir Python dentro de uma aplicação do Windows?:: 
* Como eu impeço editores de adicionarem tabulações na minha source do Python?:: 
* Como faço para verificar uma tecla pressionada sem bloquear?:: 
* Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0.dll ausente?: Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0 dll ausente?. 

@end menu

@node Como faço para executar um programa Python no Windows?,Como eu faço para criar programas Python executáveis?,,Python no Windows
@anchor{faq/windows faq-run-program-under-windows}@anchor{559c}@anchor{faq/windows how-do-i-run-a-python-program-under-windows}@anchor{559d}
@subsection Como faço para executar um programa Python no Windows?


Esta não é necessariamente uma questão direta. Se você já está familiarizado com a execução de programas através das linha de comando do Windows, então tudo parecerá óbvio; caso contrário, poderá precisar de um pouco mais de orientação.

A menos que você use algum tipo de ambiente de desenvolvimento integrado, você vai acabar digitando os comandos do Windows no que é chamado “janela do DOS” ou “janela do prompt de comando”. Geralmente você pode abrir essas janelas procurando na barra de pesquisa por @code{cmd}. Você deverá reconhecer quando iniciar porque você verá um “Prompt de Comando do Windows”, que geralmente tem esta forma:

@example
C:\>
@end example

A letra pode ser diferente, e pode haver outras coisas depois, então você facilmente pode ver algo como:

@example
D:\SeuNome\Projetos\Python>
@end example

dependendo de como seu computador foi configurado e o que mais você tem feito com ele recentemente. Uma vez que você tenha iniciado a janela, você estará no caminho para executar os seus programas Python.

Você deve observar que seu código Python deve ser processado por outro programa chamado interpretador. O interpretador lê o seu código, compila em bytecodes, e depois executa os bytecodes para rodar o seu programa. Então, como você pode organizar o interpretador para lidar com seu Python?

Primeiro, você precisa ter certeza de que sua janela de comando reconhece a palavra “py” como uma instrução para iniciar o interpretador. Se você abriu a janela de comando, você deve tentar digitar o comando “py” e o observar o retorno:

@example
C:\Users\SeuNome> py
@end example

Você deve então ver algo como:

@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

Você iniciou o interpretador no “modo interativo”. Que significa que você pode inserir instruções ou expressões Python interativamente e executá-las ou calculá-las enquanto espera. Esta é uma das características mais fortes do Python. Verifique isso digitando algumas instruções de sua escolha e veja os resultados:

@example
>>> print("Olá")
Olá
>>> "Olá" * 3
'OláOláOlá'
@end example

Muitas pessoas usam o modo interativo como uma calculadora conveniente, mas altamente programável. Quando quiser encerrar sua sessão interativa do Python, chame a função @ref{2320,,exit()} ou mantenha pressionada a tecla @code{Ctrl} enquanto você digita a @code{Z} e pressione a tecla “@code{Enter}” para voltar ao prompt de comando do Windows.

Você também pode descobrir que você tem um item no Menu Iniciar como Iniciar ‣ Programas‣ Python 3.x ‣ Python (linha de comando) que resultará em você vendo o prompt @code{>>>} em uma nova janela. Se acontecer isso, a janela desaparecerá depois que você chamar a função @ref{2320,,exit()} ou inserir o caractere @code{Ctrl}-@code{Z}; o Windows está executando um único comando “python” na janela, e fecha quando você termina o interpretador.

Agora que sabemos que o comando @code{py} é reconhecido, você pode dar seu script Python para ele. Você terá que dar um caminho absoluto ou relativo para o script Python. Vamos dizer que seu script Python está localizado na sua área de trabalho e se chama @code{oi.py}, e seu prompt de comando está aberto no seu diretório raiz de forma que você está vendo algo similar a:

@example
C:\Users\SeuNome>
@end example

Então, agora você solicitará o comando @code{py} para fornecer seu script para Python, digitando @code{py} seguido pelo seu caminho de script:

@example
C:\Users\SeuNome> py Desktop\oi.py
oi
@end example

@node Como eu faço para criar programas Python executáveis?,Por que Python às vezes demora tanto para iniciar?,Como faço para executar um programa Python no Windows?,Python no Windows
@anchor{faq/windows how-do-i-make-python-scripts-executable}@anchor{559e}
@subsection Como eu faço para criar programas Python executáveis?


No Windows, o instalador padrão do Python já associa a extensão .py com o tipo de arquivo (Python.File) e dá àquele tipo de arquivo um comando aberto que executa o interpretador (@code{D:\Program Files\Python\python.exe "%1" %*}). Isso é o bastante para fazer scripts executáveis pelo prompt de comando como ‘foo.py’. Se você preferir executar o script simplesmente digitando ‘foo’ sem extensão você precisa adicionar .py à variável de ambiente PATHEXT.

@node Por que Python às vezes demora tanto para iniciar?,Como eu faço para criar um executável a partir de um código Python?,Como eu faço para criar programas Python executáveis?,Python no Windows
@anchor{faq/windows why-does-python-sometimes-take-so-long-to-start}@anchor{559f}
@subsection Por que Python às vezes demora tanto para iniciar?


Geralmente, Python inicia muito rapidamente no Windows, mas ocasionalmente há relatos de erros que, de repente, o Python começa a demorar muito tempo para iniciar. Isso é ainda mais intrigante, porque Python funciona bem em outros sistemas Windows que parecem estar configurados de forma idêntica.

O problema pode ser causado por uma desconfiguração de software antivírus na máquina problemática. Alguns antivírus são conhecidos por introduzir sobrecarga de duas ordens de magnitude no início quando estão configurados para monitorar todas as leituras do sistema de arquivos. Tente verificar a configuração do antivírus nos seus sistemas para assegurar que eles estão de fato configurados identicamente. O McAfee, quando configurado para escanear todo a atividade do sistema de arquivos, é um ofensor conhecido.

@node Como eu faço para criar um executável a partir de um código Python?,Um arquivo * pyd é o mesmo que um DLL?,Por que Python às vezes demora tanto para iniciar?,Python no Windows
@anchor{faq/windows how-do-i-make-an-executable-from-a-python-script}@anchor{55a0}
@subsection Como eu faço para criar um executável a partir de um código Python?


Consulte @ref{54f4,,Como posso criar um binário independente a partir de um script Python?} para uma lista de ferramentas que podem ser usada para criar executáveis.

@node Um arquivo * pyd é o mesmo que um DLL?,Como eu posso embutir Python dentro de uma aplicação do Windows?,Como eu faço para criar um executável a partir de um código Python?,Python no Windows
@anchor{faq/windows is-a-pyd-file-the-same-as-a-dll}@anchor{55a1}
@subsection Um arquivo @code{*.pyd} é o mesmo que um DLL?


Sim, os arquivos .pyd são dll, mas existem algumas diferenças. Se você possui uma DLL chamada @code{foo.pyd}, ela deve ter a função @code{PyInit_foo()}. Você pode escrever “import foo” do Python, e o Python procurará por foo.pyd (assim como foo.py, foo.pyc) e, se o encontrar, tentará chamar @code{PyInit_foo()} para inicializá-lo. Você não vincula seu arquivo .exe ao arquivo foo.lib, pois isso faria com que o Windows exigisse a presença da DLL.

Observe que o caminho de pesquisa para foo.pyd é PYTHONPATH, não o mesmo que o Windows usa para procurar por foo.dll. Além disso, foo.pyd não precisa estar presente para executar seu programa, enquanto que se você vinculou seu programa a uma dll, a dll será necessária. Obviamente, o foo.pyd é necessário se você quiser dizer @code{import foo}. Em uma DLL, o vínculo é declarado no código-fonte com @code{__declspec(dllexport)}. Em um .pyd, o vínculo é definido em uma lista de funções disponíveis.

@node Como eu posso embutir Python dentro de uma aplicação do Windows?,Como eu impeço editores de adicionarem tabulações na minha source do Python?,Um arquivo * pyd é o mesmo que um DLL?,Python no Windows
@anchor{faq/windows how-can-i-embed-python-into-a-windows-application}@anchor{55a2}
@subsection Como eu posso embutir Python dentro de uma aplicação do Windows?


A incorporação do interpretador Python em um aplicativo do Windows pode ser resumida da seguinte forma:


@enumerate 

@item 
`Não' compile o Python diretamente em seu arquivo .exe. No Windows, o Python deve ser uma DLL para manipular os módulos de importação que são eles próprios. (Este é o primeiro fato chave não documentado.) Em vez disso, vincule a @code{python`NN'.dll}; normalmente é instalado em @code{C:\Windows\System}. `NN' é a versão do Python, um número como “33” para o Python 3.3.

Você pode vincular ao Python de duas maneiras diferentes. A vinculação em tempo de carregamento significa vincular contra @code{python`NN'.lib}, enquanto a vinculação em tempo de execução significa vincular a @code{python`NN'.dll}. (Nota geral: @code{python`NN'.lib} é a chamada “import lib” correspondente a @code{python`NN'.dll}. Apenas define símbolos para o ligador.)

A vinculação em tempo de execução simplifica bastante as opções de vinculação; tudo acontece em tempo de execução. Seu código deve carregar @code{python`NN'.dll} usando a rotina @code{LoadLibraryEx()} do Windows. O código também deve usar rotinas de acesso e dados em @code{python`NN'.dll} (ou seja, as APIs C do Python) usando ponteiros obtidos pela rotina @code{GetProcAddress()} do Windows. As macros podem tornar o uso desses ponteiros transparente para qualquer código C que chama rotinas na API C do Python.

@c XXX what about static linking?

@item 
Se você usa SWIG, é fácil criar um “módulo de extensão” do Python que disponibilizará os dados e os métodos da aplicação para o Python. O SWIG cuidará de todos os detalhes obscuros para você. O resultado é o código C que você vincula `ao' arquivo.exe (!) Você `não' precisa criar um arquivo DLL, o que também simplifica a vinculação.

@item 
O SWIG criará uma função init (uma função C) cujo nome depende do nome do módulo de extensão. Por exemplo, se o nome do módulo for leo, a função init será chamada initleo(). Se você usa classes de sombra SWIG, como deveria, a função init será chamada initleoc(). Isso inicializa uma classe auxiliar principalmente oculta usada pela classe shadow.

O motivo pelo qual você pode vincular o código C na etapa 2 ao seu arquivo .exe é que chamar a função de inicialização equivale a importar o módulo para o Python! (Este é o segundo fato chave não documentado.)

@item 
Em suma, você pode utilizar o código a seguir para inicializar o interpretador Python com seu módulo de extensão.

@example
#include <Python.h>
...
Py_Initialize();  // Inicializa Python.
initmyAppc();  // Inicializa (importa) a classe auxiliar.
PyRun_SimpleString("import myApp");  // Importa a classe sombra.
@end example

@item 
Existem dois problemas com a API C do Python que se tornarão aparentes se você utiliza um compilador que não seja o MSVC, o compilador utilizado no pythonNN.dll.

Problema 1: As chamadas funções de “Nível Muito Alto” que recebem argumentos @code{FILE *} não funcionarão em um ambiente com vários compiladores porque a noção de cada @code{struct FILE} de um compilador será diferente. Do ponto de vista da implementação, essas são funções de nível muito baixo.

Problema 2: SWIG gera o seguinte código ao gerar invólucros para funções sem retorno:

@example
Py_INCREF(Py_None);
_resultobj = Py_None;
return _resultobj;
@end example

Infelizmente, Py_None é uma macro que se expande para uma referência a uma estrutura de dados complexa chamada _Py_NoneStruct dentro de pythonNN.dll. Novamente, esse código falhará em um ambiente com vários compiladores. Substitua esse código por:

@example
return Py_BuildValue("");
@end example

Pode ser possível usar o comando @code{%typemap} do SWIG para fazer a alteração automaticamente, embora eu não tenha conseguido fazer isso funcionar (eu sou um completo novato em SWIG).

@item 
Usar um script de shell do Python para criar uma janela do interpretador Python de dentro da aplicação do Windows não é uma boa ideia; a janela resultante será independente do sistema de janelas da sua aplicação. Em vez disso, você (ou a classe wxPythonWindow) deve criar uma janela “nativa” do interpretador. É fácil conectar essa janela ao interpretador Python. Você pode redirecionar a E/S do Python para qualquer objeto que suporte leitura e gravação; portanto, tudo que você precisa é de um objeto Python (definido no seu módulo de extensão) que contenha métodos read() e write().
@end enumerate

@node Como eu impeço editores de adicionarem tabulações na minha source do Python?,Como faço para verificar uma tecla pressionada sem bloquear?,Como eu posso embutir Python dentro de uma aplicação do Windows?,Python no Windows
@anchor{faq/windows how-do-i-keep-editors-from-inserting-tabs-into-my-python-source}@anchor{55a3}
@subsection Como eu impeço editores de adicionarem tabulações na minha source do Python?


As perguntas frequentes não recomendam a utilização de tabulações, e o guia de estilo Python, :pep:@cite{8}, recomenda 4 espaços para código de Python distribuído; esse também é o padrão do python-mode do Emacs.

Sob qualquer editor, misturar tabulações e espaços é uma má ideia. O MSVC não é diferente nesse aspecto e é facilmente configurado para usar espaços: Selecione Tools ‣ Options ‣ Tabs e, para o tipo de arquivo “Default”, defina “Tab size” e “Indent size” para 4 e selecione o botão de opção “Insert spaces”.

O Python levanta @ref{7a9,,IndentationError} ou @ref{543,,TabError} se tabulações e espaços misturados estiverem causando problemas no espaço em branco à esquerda. Você também pode executar o módulo @ref{dd,,tabnanny} para verificar uma árvore de diretórios no modo em lote.

@node Como faço para verificar uma tecla pressionada sem bloquear?,Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0 dll ausente?,Como eu impeço editores de adicionarem tabulações na minha source do Python?,Python no Windows
@anchor{faq/windows how-do-i-check-for-a-keypress-without-blocking}@anchor{55a4}
@subsection Como faço para verificar uma tecla pressionada sem bloquear?


Use o módulo @ref{93,,msvcrt}. Este é um módulo de extensão padrão específico do Windows. Ele define uma função @code{kbhit()} que verifica se um toque no teclado está presente, e @code{getch()} que recebe um caractere sem ecoá-lo.

@node Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0 dll ausente?,,Como faço para verificar uma tecla pressionada sem bloquear?,Python no Windows
@anchor{faq/windows how-do-i-solve-the-missing-api-ms-win-crt-runtime-l1-1-0-dll-error}@anchor{55a5}
@subsection Como resolvo o erro da api-ms-win-crt-runtime-l1-1-0.dll ausente?


Isso pode ocorrer no Python 3.5 e posterior ao usar o Windows 8.1 ou anterior sem que todas as atualizações tenham sido instaladas. Primeiro, certifique-se de que seu sistema operacional seja compatível e esteja atualizado e, se isso não resolver o problema, visite a página de suporte da Microsoft@footnote{https://support.microsoft.com/pt-br/help/3118401/} para obter orientação sobre como instalar manualmente a atualização do C Runtime.

@node FAQ da Interface Gráfica do Usuário,FAD de “Por que o Python está instalado em meu computador?”,Python no Windows,Perguntas Frequentes Sobre Python
@anchor{faq/gui doc}@anchor{55a6}@anchor{faq/gui graphic-user-interface-faq}@anchor{55a7}@anchor{faq/gui translation-repo}@anchor{55a8}
@section FAQ da Interface Gráfica do Usuário



@c XXX need review for Python 3.

@menu
* Perguntas Gerais sobre a GUI:: 
* Quais toolkits de GUI existem para o Python?:: 
* Perguntas do Tkinter:: 

@end menu

@node Perguntas Gerais sobre a GUI,Quais toolkits de GUI existem para o Python?,,FAQ da Interface Gráfica do Usuário
@anchor{faq/gui general-gui-questions}@anchor{55a9}
@subsection Perguntas Gerais sobre a GUI


@node Quais toolkits de GUI existem para o Python?,Perguntas do Tkinter,Perguntas Gerais sobre a GUI,FAQ da Interface Gráfica do Usuário
@anchor{faq/gui what-gui-toolkits-exist-for-python}@anchor{55aa}
@subsection Quais toolkits de GUI existem para o Python?


As versões padrão do Python incluem uma interface orientada a objetos para o conjunto de widgets Tcl/Tk, chamado @ref{3f99,,tkinter}. Este é provavelmente o mais fácil de instalar (uma vez que vem incluído na maioria das distribuições binárias@footnote{https://www.python.org/downloads/} do Python) e usar. Para obter mais informações sobre o Tk, incluindo ponteiros para a fonte, consulte a página inicial do Tcl/Tk@footnote{https://www.tcl.tk}. Tcl/Tk é totalmente portátil para as plataformas macOS, Windows e Unix.

Dependendo da(s) plataforma(s) que você está visando, também existem várias alternativas. Uma lista de frameworks GUI de plataformas cruzadas@footnote{https://wiki.python.org/moin/GuiProgramming#Cross-Platform_Frameworks} e frameworks GUI específicas de plataforma@footnote{https://wiki.python.org/moin/GuiProgramming#Platform-specific_Frameworks} podem ser encontradas na wiki do python.

@node Perguntas do Tkinter,,Quais toolkits de GUI existem para o Python?,FAQ da Interface Gráfica do Usuário
@anchor{faq/gui tkinter-questions}@anchor{55ab}
@subsection Perguntas do Tkinter


@menu
* Como eu congelo as aplicações Tkinter?:: 
* Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?:: 
* Não consigo fazer as ligações de tecla funcionarem no Tkinter; por que?: Não consigo fazer as ligações de tecla funcionarem no Tkinter por que?. 

@end menu

@node Como eu congelo as aplicações Tkinter?,Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?,,Perguntas do Tkinter
@anchor{faq/gui how-do-i-freeze-tkinter-applications}@anchor{55ac}
@subsubsection Como eu congelo as aplicações Tkinter?


Freeze é uma ferramenta para criar aplicativos autônomos. Ao congelar aplicativos Tkinter, os aplicativos não serão verdadeiramente autônomos, pois o aplicativo ainda precisará das bibliotecas Tcl e Tk.

Uma solução é enviar a aplicação com as bibliotecas Tcl e Tk e apontá-las em tempo de execução usando as variáveis de ambiente @code{TCL_LIBRARY} e @code{TK_LIBRARY}.

Várias bibliotecas de congelamento de terceiros, como py2exe e cx_Freeze, possuem manipulação embutida para aplicações Tkinter.

@node Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?,Não consigo fazer as ligações de tecla funcionarem no Tkinter por que?,Como eu congelo as aplicações Tkinter?,Perguntas do Tkinter
@anchor{faq/gui can-i-have-tk-events-handled-while-waiting-for-i-o}@anchor{55ad}
@subsubsection Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?


Em plataformas diferentes do Windows, sim, e você nem precisa de threads! Mas você terá que reestruturar seu código de E/S um pouco. O Tk tem o equivalente à chamada @code{XtAddInput()} do Xt, que permite que você registre uma função de retorno de chamada que será chamada a partir do laço de repetição principal do Tk quando E/S é possível em um descritor de arquivo. Consulte @ref{3fb7,,Tratadores de arquivos}.

@node Não consigo fazer as ligações de tecla funcionarem no Tkinter por que?,,Posso ter eventos Tk manipulados enquanto aguardo pelo E/S?,Perguntas do Tkinter
@anchor{faq/gui i-can-t-get-key-bindings-to-work-in-tkinter-why}@anchor{55ae}
@subsubsection Não consigo fazer as ligações de tecla funcionarem no Tkinter: por que?


Uma queixa frequentemente ouvida é que os manipuladores de eventos @ref{3fb2,,vinculados} a eventos com o método @code{bind()} não são manipulados mesmo quando a tecla apropriada é pressionada.

A causa mais comum é que o widget para o qual a ligação se aplica não possui “foco no teclado”. Confira a documentação do Tk para o comando de foco. Normalmente, um widget é dado o foco do teclado clicando nele (mas não para rótulos, veja a opção takefocus).

@node FAD de “Por que o Python está instalado em meu computador?”,,FAQ da Interface Gráfica do Usuário,Perguntas Frequentes Sobre Python
@anchor{faq/installed doc}@anchor{55af}@anchor{faq/installed translation-repo}@anchor{55b0}@anchor{faq/installed why-is-python-installed-on-my-computer-faq}@anchor{55b1}
@section FAD de “Por que o Python está instalado em meu computador?”


@menu
* O que é Python?: O que é Python?<2>. 
* Porque Python está instalado em minha máquina?:: 
* Eu posso apagar o Python?:: 

@end menu

@node O que é Python?<2>,Porque Python está instalado em minha máquina?,,FAD de “Por que o Python está instalado em meu computador?”
@anchor{faq/installed what-is-python}@anchor{55b2}
@subsection O que é Python?


Python é uma linguagem de programação. É usada para muitas e diversas aplicações. É usada em escolas e faculdades como uma linguagem de programação introdutória, porque Python é fácil de aprender, mas também é usada por desenvolvedores profissionais de software em lugares como Google, Nasa e Lucasfilm Ltd.

Se você quiser aprender mais sobre Python, comece com o Beginner's Guide to Python@footnote{https://wiki.python.org/moin/BeginnersGuide}.

@node Porque Python está instalado em minha máquina?,Eu posso apagar o Python?,O que é Python?<2>,FAD de “Por que o Python está instalado em meu computador?”
@anchor{faq/installed why-is-python-installed-on-my-machine}@anchor{55b3}
@subsection Porque Python está instalado em minha máquina?


Se você encontrar Python instalado em seu sistema, mas não se lembra de tê-lo instalado, então podem haver muitas maneiras diferentes dele ter ido parar lá


@itemize *

@item 
Possivelmente outro usuário do computador pretendia aprender programação e o instalou; você terá que descobrir quem estava usando a máquina e pode o ter instalado.

@item 
Um aplicativo de terceiros pode ter sido instalado na máquina e sido escrito em Python e incluído uma instalação do Python. Há muitos desses aplicativos, desde programas com interface gráfica até servidores de rede e scripts administrativos.

@item 
Algumas máquinas Windows já possuem o Python instalado. No presente momento nós temos conhecimento de computadores da Hewlett-Packard e da Compaq que incluem Python. Aparentemente algumas das ferramentas administrativas da HP/Compaq são escritas em Python.

@item 
Muitos sistemas operacionais derivados do Unix, como macOS e algumas distribuições Linux, possuem o python instalado por padrão; está incluído na instalação base.
@end itemize

@node Eu posso apagar o Python?,,Porque Python está instalado em minha máquina?,FAD de “Por que o Python está instalado em meu computador?”
@anchor{faq/installed can-i-delete-python}@anchor{55b4}
@subsection Eu posso apagar o Python?


Isso depende de como o Python veio.

Se alguém o instalou deliberadamente, você pode removê-lo sem machucar ninguém. No Windows use o Adicionar ou remover programas que se encontra no Painel de Controle.

Se o Python foi instalado por um aplicativo de terceiros, você pode removê-lo mas aquela aplicação não irá mais funcionar. Você deve usar o desinstalador daquele aplicativo para remover o Python diretamente.

Se o Python veio junto com seu sistema operacional, removê-lo não é recomendado. Se você o remover, qualquer ferramenta que tenha sido escrita em Python não vão mais funcionar, e algumas delas podem ser importantes para você. A reinstalação do sistema inteiro seria necessária para consertar as coisas de novo.

@node Descontinuações,Glossário,Perguntas Frequentes Sobre Python,Top
@anchor{deprecations/index doc}@anchor{55b5}@anchor{deprecations/index deprecations}@anchor{55b6}@anchor{deprecations/index translation-repo}@anchor{55b7}
@chapter Descontinuações


@menu
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<5>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<5>. 
* Remoção pendente no Python 3.16: Remoção pendente no Python 3 16<5>. 
* Remoção pendente no Python 3.17: Remoção pendente no Python 3 17<3>. 
* Remoção pendente no Python 3.18: Remoção pendente no Python 3 18<2>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<5>. 
* Descontinuações na API C:: 

@end menu

@node Remoção pendente no Python 3 14<5>,Remoção pendente no Python 3 15<5>,,Descontinuações
@anchor{deprecations/index pending-removal-in-python-3-14}@anchor{55b8}
@section Remoção pendente no Python 3.14



@itemize *

@item 
@ref{6,,argparse}: Os parâmetros `type', `choices' e `metavar' de @code{argparse.BooleanOptionalAction} foram descontinuados e serão removidos na versão 3.14. (Contribuição de Nikita Sobolev em gh-92248@footnote{https://github.com/python/cpython/issues/92248}.)

@item 
@ref{8,,ast}: os seguintes recursos foram descontinuados na documentação desde Python 3.8, agora fazem com que um @ref{1a5,,DeprecationWarning} seja emitido em tempo de execução quando eles são acessados ou usados, e serão removidos no 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

Em vez disso, use @ref{2b9,,ast.Constant}. (Contribuição de Serhiy Storchaka em gh-90953@footnote{https://github.com/python/cpython/issues/90953}.)

@item 
@ref{a,,asyncio}:


@itemize *

@item 
As classes filhas dos observadores @ref{2ba,,MultiLoopChildWatcher}, @ref{2bb,,FastChildWatcher}, @ref{2bc,,AbstractChildWatcher} e @ref{2bd,,SafeChildWatcher} foram descontinuadas e serão removidas no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
@ref{2be,,asyncio.set_child_watcher()}, @ref{2bf,,asyncio.get_child_watcher()}, @ref{2c0,,asyncio.AbstractEventLoopPolicy.set_child_watcher()} e @ref{2c1,,asyncio.AbstractEventLoopPolicy.get_child_watcher()} foram descontinuados e serão removidos no Python 3.14. (Contribuição de Kumar Aditya em gh-94597@footnote{https://github.com/python/cpython/issues/94597}.)

@item 
O método @ref{2c2,,get_event_loop()} da política de laço de eventos padrão agora emite um @ref{1a5,,DeprecationWarning} se não houver nenhum laço de eventos atual definido e decidir criar um. (Contribuição de Serhiy Storchaka e Guido van Rossum em gh-100160@footnote{https://github.com/python/cpython/issues/100160}.)
@end itemize

@item 
@ref{12,,builtins}: @code{bool(NotImplemented)} now emits a @ref{1a5,,DeprecationWarning}
and will raise a @ref{2c3,,TypeError} in Python 3.14.
(Contributed by Jelle Zijlstra in gh-118767@footnote{https://github.com/python/cpython/issues/118767}.)

@item 
@ref{3b,,email}: Descontinua o parâmetro `isdst' em @ref{2c4,,email.utils.localtime()}. (Contribuição de Alan Williams em gh-72346@footnote{https://github.com/python/cpython/issues/72346}.)

@item 
@ref{78,,importlib.abc} descontinuou as classes:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

Em vez disso, use classes de @ref{7c,,importlib.resources.abc}:


@itemize *

@item 
@ref{1f3,,importlib.resources.abc.Traversable}

@item 
@ref{2c5,,importlib.resources.abc.TraversableResources}
@end itemize

(Contribuição de Jason R. Coombs e Hugo van Kemenade em gh-93963@footnote{https://github.com/python/cpython/issues/93963}.)

@item 
@ref{81,,itertools} tinha suporte não documentado, ineficiente, historicamente cheio de bugs e inconsistente para operações de cópia, cópia profunda e serialização com pickle. Isso será removido na versão 3.14 para uma redução significativa no volume de código e na carga de manutenção. (Contribuição de Raymond Hettinger em gh-101588@footnote{https://github.com/python/cpython/issues/101588}.)

@item 
@ref{94,,multiprocessing}: o método de inicialização padrão será alterado para um mais seguro no Linux, BSDs e outras plataformas POSIX não-macOS onde @code{'fork'} é atualmente o padrão (gh-84559@footnote{https://github.com/python/cpython/issues/84559}). Adicionar um aviso de tempo de execução sobre isso foi considerado muito perturbador, pois não se espera que a maior parte do código se importe. Use as APIs @ref{2c6,,get_context()} ou @ref{2c7,,set_start_method()} para especificar explicitamente quando seu código `requer' @code{'fork'}. Veja @ref{2c8,,Contextos e métodos de inicialização}.

@item 
@ref{a4,,pathlib}: @ref{2c9,,is_relative_to()} e @ref{2ca,,relative_to()}: passar argumentos adicionais foi descontinuado.

@item 
@ref{a9,,pkgutil}: @ref{2cb,,find_loader()} e @ref{2cc,,get_loader()} agora levantam @ref{1a5,,DeprecationWarning}; use @ref{2cd,,importlib.util.find_spec()} em vez disto. (Contribuição de Nikita Sobolev em gh-97850@footnote{https://github.com/python/cpython/issues/97850}.)

@item 
@ref{b1,,pty}:


@itemize *

@item 
@code{master_open()}: use @ref{2ce,,pty.openpty()}.

@item 
@code{slave_open()}: use @ref{2ce,,pty.openpty()}.
@end itemize

@item 
@ref{cf,,sqlite3}:


@itemize *

@item 
@ref{2cf,,version} e @ref{2d0,,version_info}.

@item 
@ref{2d1,,execute()} e @ref{2d2,,executemany()} se @ref{2d3,,espaços reservados nomeados} forem usados e `parameters' for uma sequência em vez de um @ref{256,,dict} .
@end itemize

@item 
@ref{108,,urllib}: @code{urllib.parse.Quoter} está obsoleto: não foi planejado para ser uma API pública. (Contribuição de Gregory P. Smith em gh-88168@footnote{https://github.com/python/cpython/issues/88168}.)
@end itemize

@node Remoção pendente no Python 3 15<5>,Remoção pendente no Python 3 16<5>,Remoção pendente no Python 3 14<5>,Descontinuações
@anchor{deprecations/index pending-removal-in-python-3-15}@anchor{55b9}
@section Remoção pendente no Python 3.15



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2d5,,__cached__} em um módulo enquanto falha na definição de @ref{2d6,,__spec__.cached} está descontinuado. No Python 3.15, @code{__cached__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
A definição de @ref{2d7,,__package__} em um módulo enquanto falha na definição de @ref{2d8,,__spec__.parent} está descontinuado. No Python 3.15, @code{__package__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão. (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2a,,ctypes}:


@itemize *

@item 
A função não documentada @code{ctypes.SetPointerType()} foi descontinuada desde o Python 3.13.
@end itemize

@item 
@ref{72,,http.server}:


@itemize *

@item 
A classe obsoleta e raramente usada @ref{2a1,,CGIHTTPRequestHandler} foi descontinuada desde o Python 3.13. Não existe substituição direta. `Qualquer coisa' é melhor que CGI para fazer a interface de um servidor web com um manipulador de requisição.

@item 
O sinalizador @code{--cgi} para a interface de linha de comando @code{python -m http.server} foi descontinuado desde o Python 3.13.
@end itemize

@item 
@ref{77,,importlib}:


@itemize *

@item 
Método @code{load_module()}: use @code{exec_module()}.
@end itemize

@item 
@ref{86,,locale}:


@itemize *

@item 
A função @ref{2d9,,getdefaultlocale()} foi descontinuada desde o Python 3.11. Sua remoção foi planejada originalmente para o Python 3.13 (gh-90817@footnote{https://github.com/python/cpython/issues/90817}), mas foi adiada para o Python 3.15. Em vez disso, use @ref{2da,,getlocale()}, @ref{2db,,setlocale()} e @ref{2dc,,getencoding()}. (Contribuição de Hugo van Kemenade em gh-111187@footnote{https://github.com/python/cpython/issues/111187}.)
@end itemize

@item 
@ref{a4,,pathlib}:


@itemize *

@item 
@ref{2a6,,PurePath.is_reserved()} foi descontinuado desde o Python 3.13. Use @ref{223,,os.path.isreserved()} para detectar caminhos reservados no Windows.
@end itemize

@item 
@ref{aa,,platform}:


@itemize *

@item 
@ref{2a7,,java_ver()} foi descontinuada desde o Python 3.13. Esta função é útil apenas para suporte Jython, tem uma API confusa e é amplamente não testada.
@end itemize

@item 
@ref{db,,sysconfig}:


@itemize *

@item 
O argumento `check_home' de @ref{2dd,,sysconfig.is_python_build()} foi descontinuado desde o Python 3.12.
@end itemize

@item 
@ref{ed,,threading}:


@itemize *

@item 
@ref{2de,,RLock()} não aceitará argumentos no Python 3.15. A passagem quaisquer argumentos foi descontinuada desde o Python 3.14, pois a versão Python não permite nenhum argumento, mas a versão C permite qualquer número de argumentos posicionais ou nomeados, ignorando todos os argumentos.
@end itemize

@item 
@ref{103,,types}:


@itemize *

@item 
@ref{2df,,types.CodeType}: o acesso a @ref{2e0,,co_lnotab} foi descontinuado na 
@geindex Propostas de Melhorias do Python; PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} desde 3.10 e foi planejado para ser removido em 3.12, mas só recebeu uma @ref{1a5,,DeprecationWarning} adequada em 3.12. Pode ser removido em 3.15. (Contribuição de Nikita Sobolev em gh-101866@footnote{https://github.com/python/cpython/issues/101866}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize *

@item 
A sintaxe de argumento nomeado não documentada para criar classes @ref{2b0,,NamedTuple} (por exemplo, @code{Point = NamedTuple("Point", x=int, y=int)}) foi descontinuada desde o Python 3.13. Use a sintaxe baseada em classe ou a sintaxe funcional em vez disso.

@item 
Ao usar a sintaxe funcional de @ref{162,,TypedDict}s, não passar um valor para o parâmetro `fields' (@code{TD = TypedDict("TD")}) ou passar @code{None} (@code{TD = TypedDict("TD", None)}) foi está descontinuado desde o Python 3.13. Use @code{class TD(TypedDict): pass} ou @code{TD = TypedDict("TD", @{@})} para criar uma classe TypedDict com nenhum campo.

@item 
A função decoradora @ref{2b1,,typing.no_type_check_decorator()} foi descontinuada desde o Python 3.13. Após oito anos no módulo @ref{104,,typing}, ela ainda não foi suportada por nenhum verificador de tipo importante.
@end itemize

@item 
@ref{113,,wave}:


@itemize *

@item 
Os métodos @ref{2b4,,getmark()}, @code{setmark()} e @ref{2b5,,getmarkers()} das classes @ref{2b6,,Wave_read} e @ref{2b7,,Wave_write} foram descontinuados desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 16<5>,Remoção pendente no Python 3 17<3>,Remoção pendente no Python 3 15<5>,Descontinuações
@anchor{deprecations/index pending-removal-in-python-3-16}@anchor{55ba}
@section Remoção pendente no Python 3.16



@itemize *

@item 
O sistema de importação:


@itemize *

@item 
A definição de @ref{2e2,,__loader__} em um módulo enquanto falha na definição de @ref{2e3,,__spec__.loader} está descontinuado. No Python 3.16, @code{__loader__} deixará de ser definido ou levado em consideração pelo sistema de importação ou pela biblioteca padrão.
@end itemize

@item 
@ref{7,,array}:


@itemize *

@item 
O código de formato @code{'u'} (@code{wchar_t}) foi descontinuado na documentação desde o Python 3.3 e do ambiente de execução desde o Python 3.13. Em vez disso, use o código de formato @code{'w'} (@ref{29b,,Py_UCS4}) para caracteres Unicode.
@end itemize

@item 
@ref{a,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} foi descontinuado e será removido no Python 3.16, use @ref{2e4,,inspect.iscoroutinefunction()} em vez disso. (Contribuição de Jiahao Li e Kumar Aditya em gh-122875@footnote{https://github.com/python/cpython/issues/122875}.)
@end itemize

@item 
@ref{12,,builtins}:


@itemize *

@item 
A inversão bit a bit em tipos booleanos, @code{~True} ou @code{~False} foi descontinuada desde o Python 3.12, pois produz resultados surpreendentes e não intuitivos (@code{-2} e @code{-1}). Em vez disso, use @code{not x} para a negação lógica de um booleano. No caso raro de você precisar da inversão bit a bit do inteiro subjacente, converta para @code{int} explicitamente (@code{~int(x)}).
@end itemize

@item 
@ref{c5,,shutil}:


@itemize *

@item 
A exceção @code{ExecError} foi descontinuada desde o Python 3.14. Ela não foi usada por nenhuma função em @code{shutil} desde o Python 3.4, e agora é um alias de @ref{195,,RuntimeError}.
@end itemize

@item 
@ref{d8,,symtable}:


@itemize *

@item 
O método @ref{2e5,,Class.get_methods} foi descontinuado desde o Python 3.14.
@end itemize

@item 
@ref{d9,,sys}:


@itemize *

@item 
A função @ref{2ae,,_enablelegacywindowsfsencoding()} foi descontinuada desde o Python 3.13. Em vez disso, use a variável de ambiente 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex variável de ambiente; PYTHONLEGACYWINDOWSFSENCODING
@ref{2af,,PYTHONLEGACYWINDOWSFSENCODING}.
@end itemize

@item 
@ref{de,,tarfile}:


@itemize *

@item 
O atributo não documentado e não utilizado @code{TarFile.tarfile} foi descontinuado desde o Python 3.13.
@end itemize
@end itemize

@node Remoção pendente no Python 3 17<3>,Remoção pendente no Python 3 18<2>,Remoção pendente no Python 3 16<5>,Descontinuações
@anchor{deprecations/index pending-removal-in-python-3-17}@anchor{55bb}
@section Remoção pendente no Python 3.17



@itemize *

@item 
@ref{1e,,collections.abc}:


@itemize -

@item 
@ref{2e7,,collections.abc.ByteString} está agendado para remoção no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize

@item 
@ref{104,,typing}:


@itemize -

@item 
Antes do Python 3.14, as uniões antigas eram implementadas usando a classe privada @code{typing._UnionGenericAlias}. Essa classe não é mais necessária para a implementação, mas foi mantida para compatibilidade com versões anteriores, com remoção prevista para o Python 3.17. Os usuários devem usar auxiliares de introspecção documentados, como @ref{2ec,,typing.get_origin()} e @ref{2ed,,typing.get_args()}, em vez de depender de detalhes de implementação privada.

@item 
@ref{2ee,,typing.ByteString}, obsoleto desde o Python 3.9, está programado para ser removido no Python 3.17.

Use @code{isinstance(obj, collections.abc.Buffer)} para testar se @code{obj} implementa o @ref{2e8,,protocolo de buffer} em tempo de execução. Para uso em anotações de tipo, use @ref{2e9,,Buffer} ou uma união que especifique explicitamente os tipos suportados pelo seu código (por exemplo, @code{bytes | bytearray | memoryview}).

@code{ByteString} foi originalmente concebido para ser uma classe abstrata que serviria como um supertipo de @ref{1c2,,bytes} e @ref{2ea,,bytearray}. No entanto, como o ABC nunca teve métodos, saber que um objeto era uma instância de @code{ByteString} nunca lhe dizia nada de útil sobre o objeto. Outros tipos comuns de buffer, como @ref{2eb,,memoryview}, também nunca foram entendidos como subtipos de @code{ByteString} (seja em tempo de execução ou por verificadores de tipo estáticos).

Veja 
@geindex Propostas de Melhorias do Python; PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} para mais detalhes. (Contribuição de Shantanu Jain em gh-91896@footnote{https://github.com/python/cpython/issues/91896}.)
@end itemize
@end itemize

@node Remoção pendente no Python 3 18<2>,Remoção pendente em versões futuras<5>,Remoção pendente no Python 3 17<3>,Descontinuações
@anchor{deprecations/index pending-removal-in-python-3-18}@anchor{55bc}
@section Remoção pendente no Python 3.18



@itemize *

@item 
@ref{36,,decimal}:


@itemize *

@item 
O especificador de formato de @ref{29d,,Decimal} não padrão e não documentado @code{'N'}, que só é suportado na implementação C do módulo @code{decimal}, foi descontinuada desde o Python 3.13. (Contribuição de Serhiy Storchaka em gh-89902@footnote{https://github.com/python/cpython/issues/89902}.)
@end itemize
@end itemize

@node Remoção pendente em versões futuras<5>,Descontinuações na API C,Remoção pendente no Python 3 18<2>,Descontinuações
@anchor{deprecations/index pending-removal-in-future-versions}@anchor{55bd}
@section Remoção pendente em versões futuras


As APIs a seguir serão removidas no futuro, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{6,,argparse}: o aninhamento de grupos de argumentos e o aninhamento de grupos mutuamente exclusivos estão descontinuados.

@item 
@ref{12,,builtins}:


@itemize *

@item 
Geradores: a assinatura @code{throw(type, exc, tb)} e @code{athrow(type, exc, tb)} está descontinuada: use @code{throw(exc)} e @code{athrow(exc)}, a assinatura do argumento único.

@item 
Atualmente Python aceita literais numéricos imediatamente seguidos por palavras reservadas como, por exemplo, @code{0in x}, @code{1or x}, @code{0if 1else 2}. Ele permite expressões confusas e ambíguas como @code{[0x1for x in y]} (que pode ser interpretada como @code{[0x1 for x in y]} ou @code{[0x1f or x in y]}). Um aviso de sintaxe é levantado se o literal numérico for imediatamente seguido por uma das palavras reservadas @ref{2f1,,and}, @ref{18c,,else}, @ref{2f2,,for}, @ref{2f3,,if}, @ref{2f4,,in} , @ref{2f5,,is} e @ref{2f6,,or}. Em uma versão futura, será alterado para um erro de sintaxe. (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
Suporte para métodos @code{__index__()} e @code{__int__()} retornando tipo não-int: esses métodos serão necessários para retornar uma instância de uma subclasse estrita de @ref{257,,int}.

@item 
Suporte para o método @code{__float__()} retornando uma subclasse estrita de @ref{2f7,,float}: esses métodos serão necessários para retornar uma instância de @ref{2f7,,float}.

@item 
Suporte para o método @code{__complex__()} retornando uma subclasse estrita de @ref{2f8,,complex}: esses métodos serão necessários para retornar uma instância de @ref{2f8,,complex}.

@item 
Delegação do método @code{int()} para o @code{__trunc__()}.

@item 
Passar um número complexo como argumento `real' ou `imag' no construtor @ref{2f8,,complex()} agora está descontinuado; deve ser passado apenas como um único argumento posicional. (Contribuição de Serhiy Storchaka em gh-109218@footnote{https://github.com/python/cpython/issues/109218}.)
@end itemize

@item 
@ref{14,,calendar}: as constantes @code{calendar.January} e @code{calendar.February} foram descontinuadas e substituídas por @ref{2f9,,calendar.JANUARY} e @ref{2fa,,calendar.FEBRUARY}. (Contribuição de Prince Roshan em gh-103636@footnote{https://github.com/python/cpython/issues/103636}.)

@item 
@ref{2e0,,codeobject.co_lnotab}: use o método @ref{2fb,,codeobject.co_lines()}.

@item 
@ref{30,,datetime}:


@itemize *

@item 
@ref{2fc,,utcnow()}:
use @code{datetime.datetime.now(tz=datetime.UTC)}.

@item 
@ref{2fd,,utcfromtimestamp()}:
use @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}.
@end itemize

@item 
@ref{63,,gettext}: o valor de plural deve ser um número inteiro.

@item 
@ref{77,,importlib}:


@itemize *

@item 
O parâmetro `debug_override' de @ref{2fe,,cache_from_source()} foi descontinuado: use o parâmetro `optimization'.
@end itemize

@item 
@ref{7a,,importlib.metadata}:


@itemize *

@item 
Interface de tupla @code{EntryPoints}.

@item 
@code{None} implícito nos valores de retorno.
@end itemize

@item 
@ref{87,,logging}: o método @code{warn()} foi descontinuado desde o Python 3.3, use @ref{2ff,,warning()}.

@item 
@ref{8b,,mailbox}: o uso da entrada StringIO e do modo de texto foi descontinuado; em vez disso, use BytesIO e o modo binário.

@item 
@ref{a1,,os}: chame @ref{300,,os.register_at_fork()} em processo multithread.

@item 
@code{pydoc.ErrorDuringImport}: um valor de tupla para o parâmetro `exc_info' foi descontinuado, use uma instância de exceção.

@item 
@ref{b9,,re}: regras mais rigorosas agora são aplicadas para referências numéricas de grupos e nomes de grupos em expressões regulares. Apenas a sequência de dígitos ASCII agora é aceita como referência numérica. O nome do grupo em padrões de bytes e strings de substituição agora pode conter apenas letras e dígitos ASCII e sublinhado. (Contribuição de Serhiy Storchaka em gh-91760@footnote{https://github.com/python/cpython/issues/91760}.)

@item 
Módulos @code{sre_compile}, @code{sre_constants} e @code{sre_parse}.

@item 
@ref{c5,,shutil}: o parâmetro `onerror' de @ref{301,,rmtree()} foi descontinuado no Python 3.12; use o parâmetro `onexc'.

@item 
Protocolos e opções de @ref{d0,,ssl}


@itemize *

@item 
@ref{294,,ssl.SSLContext} sem argumento de protocolo foi descontinuado.

@item 
@ref{294,,ssl.SSLContext}: @ref{302,,set_npn_protocols()} e @code{selected_npn_protocol()} foram descontinuados, use ALPN.

@item 
Opções de @code{ssl.OP_NO_SSL*}

@item 
Opções de @code{ssl.OP_NO_TLS*}

@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 
Métodos de @ref{ed,,threading}:


@itemize *

@item 
@code{threading.Condition.notifyAll()}: use @ref{303,,notify_all()}.

@item 
@code{threading.Event.isSet()}: use @ref{304,,is_set()}.

@item 
@code{threading.Thread.isDaemon()}, @ref{305,,threading.Thread.setDaemon()}: use o atributo @ref{306,,threading.Thread.daemon}.

@item 
@code{threading.Thread.getName()}, @ref{307,,threading.Thread.setName()}: use o atributo @ref{308,,threading.Thread.name}.

@item 
@code{threading.currentThread()}: use @ref{309,,threading.current_thread()}.

@item 
@code{threading.activeCount()}: use @ref{30a,,threading.active_count()}.
@end itemize

@item 
@ref{30b,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
@ref{30c,,unittest.IsolatedAsyncioTestCase}: foi descontinuado retornar um valor que não seja @code{None} de um caso de teste.

@item 
Funções descontinuadas de @ref{10a,,urllib.parse}: use @ref{30d,,urlparse()}


@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}: o estilo de @ref{30e,,URLopener} e @ref{30f,,FancyURLopener} de invocar solicitações foi descontinuado. Use as mais novas funções e métodos @ref{293,,urlopen()}.

@item 
@ref{118,,wsgiref}: @code{SimpleHandler.stdout.write()} não deve fazer gravações parciais.

@item 
@ref{125,,xml.etree.ElementTree}: testar o valor verdade de um @ref{310,,Element} está descontinuado. Em um lançamento futuro isso sempre retornará @code{True}. Em vez disso, prefira os testes explícitos @code{len(elem)} ou @code{elem is not None}.

@item 
@ref{311,,zipimport.zipimporter.load_module()} foi descontinuado: use @ref{312,,exec_module()}.
@end itemize

@node Descontinuações na API C,,Remoção pendente em versões futuras<5>,Descontinuações
@anchor{deprecations/index c-api-deprecations}@anchor{55be}
@section Descontinuações na API C


@menu
* Remoção pendente no Python 3.14: Remoção pendente no Python 3 14<6>. 
* Remoção pendente no Python 3.15: Remoção pendente no Python 3 15<6>. 
* Remoção pendente em versões futuras: Remoção pendente em versões futuras<6>. 

@end menu

@node Remoção pendente no Python 3 14<6>,Remoção pendente no Python 3 15<6>,,Descontinuações na API C
@anchor{deprecations/index id1}@anchor{55bf}
@subsection Remoção pendente no Python 3.14



@itemize *

@item 
O campo @code{ma_version_tag} em @ref{3c1,,PyDictObject} para módulos de extensão (
@geindex Propostas de Melhorias do Python; PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}; gh-101193@footnote{https://github.com/python/cpython/issues/101193}).

@item 
A criação de @ref{3c2,,tipos imutáveis} com bases mutáveis (gh-95388@footnote{https://github.com/python/cpython/issues/95388}).

@item 
Funções para configurar a inicialização do Python, descontinuadas no Python 3.11:


@itemize *

@item 
@code{PySys_SetArgvEx()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{PySys_SetArgv()}: defina @ref{3c3,,PyConfig.argv}.

@item 
@code{Py_SetProgramName()}: defina @ref{3c4,,PyConfig.program_name}.

@item 
@code{Py_SetPythonHome()}: defina @ref{3bb,,PyConfig.home}.
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.

@item 
Variáveis de configuração globais


@itemize *

@item 
@ref{3c6,,Py_DebugFlag}: use @ref{3c7,,PyConfig.parser_debug}.

@item 
@ref{3c8,,Py_VerboseFlag}: use @ref{3c9,,PyConfig.verbose}.

@item 
@ref{3ca,,Py_QuietFlag}: use @ref{3cb,,PyConfig.quiet}.

@item 
@ref{3cc,,Py_InteractiveFlag}: use @ref{3cd,,PyConfig.interactive}.

@item 
@ref{3ce,,Py_InspectFlag}: use @ref{3cf,,PyConfig.inspect}.

@item 
@ref{3d0,,Py_OptimizeFlag}: use @ref{3d1,,PyConfig.optimization_level}.

@item 
@ref{3d2,,Py_NoSiteFlag}: use @ref{3d3,,PyConfig.site_import}.

@item 
@ref{3d4,,Py_BytesWarningFlag}: use @ref{3d5,,PyConfig.bytes_warning}.

@item 
@ref{3d6,,Py_FrozenFlag}: use @ref{3d7,,PyConfig.pathconfig_warnings}.

@item 
@ref{3d8,,Py_IgnoreEnvironmentFlag}: use @ref{3d9,,PyConfig.use_environment}.

@item 
@ref{3da,,Py_DontWriteBytecodeFlag}: use @ref{3db,,PyConfig.write_bytecode}.

@item 
@ref{3dc,,Py_NoUserSiteDirectory}: use @ref{3dd,,PyConfig.user_site_directory}.

@item 
@ref{3de,,Py_UnbufferedStdioFlag}: use @ref{3df,,PyConfig.buffered_stdio}.

@item 
@ref{3e0,,Py_HashRandomizationFlag}: use @ref{3e1,,PyConfig.use_hash_seed} e @ref{3e2,,PyConfig.hash_seed}.

@item 
@ref{3e3,,Py_IsolatedFlag}: use @ref{3e4,,PyConfig.isolated}.

@item 
@ref{3e5,,Py_LegacyWindowsFSEncodingFlag}: use @ref{3e6,,PyPreConfig.legacy_windows_fs_encoding}.

@item 
@ref{3e7,,Py_LegacyWindowsStdioFlag}: use @ref{3a4,,PyConfig.legacy_windows_stdio}.

@item 
@code{Py_FileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_HasFileSystemDefaultEncoding}: use @ref{3e8,,PyConfig.filesystem_encoding}.

@item 
@code{Py_FileSystemDefaultEncodeErrors}: use @ref{3e9,,PyConfig.filesystem_errors}.

@item 
@code{Py_UTF8Mode}: use @ref{3ea,,PyPreConfig.utf8_mode}. (veja @ref{3eb,,Py_PreInitialize()})
@end itemize

Em vez disso, a API @ref{3c5,,Py_InitializeFromConfig()} deve ser usada com @ref{3a6,,PyConfig}.
@end itemize

@node Remoção pendente no Python 3 15<6>,Remoção pendente em versões futuras<6>,Remoção pendente no Python 3 14<6>,Descontinuações na API C
@anchor{deprecations/index id2}@anchor{55c0}
@subsection Remoção pendente no Python 3.15



@itemize *

@item 
The @ref{3bd,,PyImport_ImportModuleNoBlock()}: use @ref{3be,,PyImport_ImportModule()}.

@item 
@ref{379,,PyWeakref_GetObject()} e @ref{3bf,,PyWeakref_GET_OBJECT()}: use @ref{378,,PyWeakref_GetRef()}.

@item 
O tipo @ref{3ed,,Py_UNICODE} e a macro @code{Py_UNICODE_WIDE}: use @code{wchar_t}.

@item 
Funções de inicialização do Python


@itemize *

@item 
@ref{3af,,PySys_ResetWarnOptions()}: apague @ref{3b0,,sys.warnoptions} e @code{warnings.filters}.

@item 
@ref{3b1,,Py_GetExecPrefix()}: obtenha @ref{3ee,,sys.base_exec_prefix} e @ref{3b2,,sys.exec_prefix}.

@item 
@ref{3b3,,Py_GetPath()}: leia @ref{3b4,,sys.path}.

@item 
@ref{3b5,,Py_GetPrefix()}: obtenha @ref{3ef,,sys.base_prefix} e @ref{3b6,,sys.prefix}.

@item 
@ref{3b7,,Py_GetProgramFullPath()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3b9,,Py_GetProgramName()}: leia @ref{3b8,,sys.executable}.

@item 
@ref{3ba,,Py_GetPythonHome()}: leia @ref{3bb,,PyConfig.home} ou a variável de ambiente 
@geindex PYTHONHOME
@geindex variável de ambiente; PYTHONHOME
@ref{3bc,,PYTHONHOME}.
@end itemize
@end itemize

@node Remoção pendente em versões futuras<6>,,Remoção pendente no Python 3 15<6>,Descontinuações na API C
@anchor{deprecations/index id3}@anchor{55c1}
@subsection Remoção pendente em versões futuras


As APIs a seguir foram descontinuadas e serão removidas, embora atualmente não haja uma data agendada para sua remoção.


@itemize *

@item 
@ref{3f2,,Py_TPFLAGS_HAVE_FINALIZE}: desnecessária desde o Python 3.8.

@item 
@ref{3f3,,PyErr_Fetch()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f5,,PyErr_NormalizeException()}: use @ref{3f4,,PyErr_GetRaisedException()}.

@item 
@ref{3f6,,PyErr_Restore()}: use @ref{3f7,,PyErr_SetRaisedException()}.

@item 
@ref{3f8,,PyModule_GetFilename()}: use @ref{3f9,,PyModule_GetFilenameObject()}.

@item 
@ref{3fa,,PyOS_AfterFork()}: use @ref{3fb,,PyOS_AfterFork_Child()}.

@item 
@ref{3fc,,PySlice_GetIndicesEx()}: use @ref{3fd,,PySlice_Unpack()} e @ref{3fe,,PySlice_AdjustIndices()}.

@item 
@code{PyUnicode_AsDecodedObject()}: use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsDecodedUnicode()}: use @ref{3ff,,PyCodec_Decode()}.

@item 
@code{PyUnicode_AsEncodedObject()}: use @ref{400,,PyCodec_Encode()}.

@item 
@code{PyUnicode_AsEncodedUnicode()}: use @ref{400,,PyCodec_Encode()}.

@item 
@ref{401,,PyUnicode_READY()}: desnecessário desde o Python 3.12

@item 
@code{PyErr_Display()}: use @ref{402,,PyErr_DisplayException()}.

@item 
@code{_PyErr_ChainExceptions()}: use @code{_PyErr_ChainExceptions1()}.

@item 
O membro @code{PyBytesObject.ob_shash}: chame @ref{403,,PyObject_Hash()}.

@item 
O membro @code{PyDictObject.ma_version_tag}.

@item 
API do Thread Local Storage (TLS):


@itemize *

@item 
@ref{404,,PyThread_create_key()}: use @ref{405,,PyThread_tss_alloc()}.

@item 
@ref{406,,PyThread_delete_key()}: use @ref{407,,PyThread_tss_free()}.

@item 
@ref{408,,PyThread_set_key_value()}: use @ref{409,,PyThread_tss_set()}.

@item 
@ref{40a,,PyThread_get_key_value()}: use @ref{40b,,PyThread_tss_get()}.

@item 
@ref{40c,,PyThread_delete_key_value()}: use @ref{40d,,PyThread_tss_delete()}.

@item 
@ref{40e,,PyThread_ReInitTLS()}: desnecessário desde o Python 3.7.
@end itemize
@end itemize

@node Glossário,Sobre esta documentação,Descontinuações,Top
@anchor{glossary doc}@anchor{55c2}@anchor{glossary glossary}@anchor{1d58}@anchor{glossary id1}@anchor{55c3}@anchor{glossary translation-repo}@anchor{55c4}
@chapter Glossário


@c if you add new entries, keep the alphabetical sorting!


@table @asis
@anchor{glossary term-0}@anchor{16c}
@geindex >>>

@item @code{>>>}

O prompt padrão do console @ref{169,,interativo} do Python. Normalmente visto em exemplos de código que podem ser executados interativamente no interpretador.
@anchor{glossary term-}@anchor{16d}
@geindex ...

@item @code{...}

Pode se referir a:


@itemize *

@item 
O prompt padrão do console @ref{169,,interativo} do Python ao inserir o código para um bloco de código recuado, quando dentro de um par de delimitadores correspondentes esquerdo e direito (parênteses, colchetes, chaves ou aspas triplas) ou após especificar um decorador.
@end itemize

@geindex ...;literal de reticências


@itemize *

@item 
Os três pontos formam o objeto @ref{1d9a,,Ellipsis} (reticências).
@end itemize
@anchor{glossary term-abstract-base-class}@anchor{11f5}
@geindex classe base abstrata

@item classe base abstrata

Classes bases abstratas (ABCs, do inglês `abstract base class') complementam a @ref{55c5,,tipagem pato}, fornecendo uma maneira de definir interfaces quando outras técnicas, como @ref{4d2,,hasattr()}, seriam desajeitadas ou sutilmente erradas (por exemplo, com @ref{20f3,,métodos mágicos}). ABCs introduzem subclasses virtuais, classes que não herdam de uma classe mas ainda são reconhecidas por @ref{442,,isinstance()} e @ref{7c2,,issubclass()}; veja a documentação do módulo @ref{4,,abc}. Python vem com muitas ABCs embutidas para estruturas de dados (no módulo @ref{1e,,collections.abc}), números (no módulo @ref{9e,,numbers}), fluxos (no módulo @ref{7f,,io}), localizadores e carregadores de importação (no módulo @ref{78,,importlib.abc}). Você pode criar suas próprias ABCs com o módulo @ref{4,,abc}.
@anchor{glossary term-annotation}@anchor{458}
@geindex anotação

@item anotação

Um rótulo associado a uma variável, um atributo de classe ou um parâmetro de função ou valor de retorno, usado por convenção como @ref{210d,,dica de tipo}.

Anotações de variáveis locais não podem ser acessadas em tempo de execução, mas anotações de variáveis globais, atributos de classe e funções são armazenadas no atributo especial @code{__annotations__} de módulos, classes e funções, respectivamente.

Veja @ref{d79,,anotação de variável}, @ref{1db7,,anotação de função}, 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, que descrevem esta funcionalidade. Veja também @ref{7da,,Boas práticas para anotações} para as melhores práticas sobre como trabalhar com anotações.
@anchor{glossary term-argument}@anchor{449}
@geindex argumento

@item argumento

Um valor passado para uma @ref{21ea,,função} (ou @ref{1638,,método}) ao chamar a função. Existem dois tipos de argumento:


@itemize *

@item 
`argumento nomeado': um argumento precedido por um identificador (por exemplo, @code{name=}) na chamada de uma função ou passado como um valor em um dicionário precedido por @code{**}. Por exemplo, @code{3} e @code{5} são ambos argumentos nomeados nas chamadas da função @ref{2f8,,complex()} a seguir:

@example
complex(real=3, imag=5)
complex(**@{'real': 3, 'imag': 5@})
@end example

@item 
`argumento posicional': um argumento que não é um argumento nomeado. Argumentos posicionais podem aparecer no início da lista de argumentos e/ou podem ser passados como elementos de um @ref{1268,,iterável} precedidos por @code{*}. Por exemplo, @code{3} e @code{5} são ambos argumentos posicionais nas chamadas a seguir:

@example
complex(3, 5)
complex(*(3, 5))
@end example
@end itemize

Argumentos são atribuídos às variáveis locais nomeadas no corpo da função. Veja a seção @ref{da5,,Chamadas} para as regras de atribuição. Sintaticamente, qualquer expressão pode ser usada para representar um argumento; após a expressão ser avaliada, o valor resultante é atribuído à variável local.

Veja também o termo @ref{208f,,parâmetro} no glossário, a pergunta no FAQ sobre @ref{54ff,,a diferença entre argumentos e parâmetros} e 
@geindex Propostas de Melhorias do Python; PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}.
@anchor{glossary term-asynchronous-context-manager}@anchor{5d7}
@geindex gerenciador de contexto assíncrono

@item gerenciador de contexto assíncrono

Um objeto que controla o ambiente envolto numa instrução @ref{5d5,,async with} por meio da definição dos métodos @ref{215e,,__aenter__()} e @ref{1716,,__aexit__()}. Introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-asynchronous-generator}@anchor{21cf}
@geindex gerador assíncrono

@item gerador assíncrono

Uma função que retorna um @ref{45bd,,iterador gerador assíncrono}. É parecida com uma função de corrotina definida com @ref{5d1,,async def} exceto pelo fato de conter instruções @ref{9d5,,yield} para produzir uma série de valores que podem ser usados em um laço @ref{aba,,async for}.

Normalmente se refere a uma função geradora assíncrona, mas pode se referir a um `iterador gerador assíncrono' em alguns contextos. Em casos em que o significado não esteja claro, usar o termo completo evita a ambiguidade.

Uma função geradora assíncrona pode conter expressões @ref{1b9,,await} e também as instruções @ref{aba,,async for} e @ref{5d5,,async with}.
@anchor{glossary term-asynchronous-generator-iterator}@anchor{45bd}
@geindex iterador gerador assíncrono

@item iterador gerador assíncrono

Um objeto criado por uma função @ref{21cf,,geradora assíncrona}.

Este é um @ref{1ab,,iterador assíncrono} que, quando chamado usando o método @ref{1659,,__anext__()}, retorna um objeto aguardável que executará o corpo da função geradora assíncrona até a próxima expressão @ref{9d5,,yield}.

Cada @ref{9d5,,yield} suspende temporariamente o processamento, lembrando o estado de execução (incluindo variáveis locais e instruções @code{try} pendentes). Quando o `iterador gerador assíncrono' é efetivamente retomado com outro aguardável retornado por @ref{1659,,__anext__()}, ele inicia de onde parou. Veja 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} e 
@geindex Propostas de Melhorias do Python; PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}.
@anchor{glossary term-asynchronous-iterable}@anchor{d9c}
@geindex iterável assíncrono

@item iterável assíncrono

Um objeto que pode ser usado em uma instrução @ref{aba,,async for}. Deve retornar um @ref{1ab,,iterador assíncrono} do seu método @ref{c16,,__aiter__()}. Introduzido por 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-asynchronous-iterator}@anchor{1ab}
@geindex iterador assíncrono

@item iterador assíncrono

Um objeto que implementa os métodos @ref{c16,,__aiter__()} e @ref{1659,,__anext__()}. @ref{1659,,__anext__()} deve retornar um objeto @ref{1ad,,aguardável}. @ref{aba,,async for} resolve os aguardáveis retornados por um método @ref{1659,,__anext__()} do iterador assíncrono até que ele levante uma exceção @ref{1ba5,,StopAsyncIteration}. Introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-atomic-operation}@anchor{55c6}
@geindex operação atômica

@item operação atômica

Uma operação que parece ser executada como uma única etapa indivisível: nenhuma outra thread pode observá-la pela metade, e os seus efeitos tornam-se visíveis de uma só vez. O Python não garante que as instruções de alto nível sejam atômicas (por exemplo, @code{x += 1} executa várias operações de bytecode e não é atômico). A atomicidade só é garantida quando explicitamente documentada. Veja também @ref{55c7,,condição de corrida} e @ref{55c8,,corrida de dados}.
@anchor{glossary term-attribute}@anchor{263b}
@geindex atributo

@item atributo

Um valor associado a um objeto que é geralmente referenciado pelo nome separado por um ponto. Por exemplo, se um objeto `o' tem um atributo `a' esse seria referenciado como `o.a'.

É possível dar a um objeto um atributo cujo nome não seja um identificador conforme definido por @ref{2021,,Identificadores e palavras-chave}, por exemplo usando @ref{22f3,,setattr()}, se o objeto permitir. Tal atributo não será acessível usando uma expressão pontilhada e, em vez disso, precisaria ser recuperado com @ref{bea,,getattr()}.
@anchor{glossary term-awaitable}@anchor{1ad}
@geindex aguardável

@item aguardável

Um objeto que pode ser usado em uma expressão @ref{1b9,,await}. Pode ser uma @ref{491,,corrotina} ou um objeto com um método @ref{d9d,,__await__()}. Veja também a 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-BDFL}@anchor{55c9}
@geindex BDFL

@item BDFL

Abreviação da expressão da língua inglesa “Benevolent Dictator for Life” (em português, “Ditador Benevolente Vitalício”), referindo-se a Guido van Rossum@footnote{https://gvanrossum.github.io/}, criador do Python.
@anchor{glossary term-binary-file}@anchor{1e0e}
@geindex arquivo binário

@item arquivo binário

Um @ref{1203,,objeto arquivo} capaz de ler e gravar em @ref{d4f,,objetos bytes ou similares}. Exemplos de arquivos binários são arquivos abertos no modo binário (@code{'rb'}, @code{'wb'} ou @code{'rb+'}), @ref{53d,,sys.stdin.buffer}, @ref{ae6,,sys.stdout.buffer}, e instâncias de @ref{ed3,,io.BytesIO} e @ref{41a,,gzip.GzipFile}.

Veja também @ref{1e0d,,arquivo texto} para um objeto arquivo capaz de ler e gravar em objetos @ref{44c,,str}.
@anchor{glossary term-borrowed-reference}@anchor{33e}
@geindex referência emprestada

@item referência emprestada

Na API C do Python, uma referência emprestada é uma referência a um objeto que não é dona da referência. Ela se torna um ponteiro solto se o objeto for destruído. Por exemplo, uma coleta de lixo pode remover a última @ref{33d,,referência forte} para o objeto e assim destruí-lo.

Chamar @ref{56e,,Py_INCREF()} na @ref{33e,,referência emprestada} é recomendado para convertê-lo, internamente, em uma @ref{33d,,referência forte}, exceto quando o objeto não pode ser destruído antes do último uso da referência emprestada. A função @ref{89e,,Py_NewRef()} pode ser usada para criar uma nova @ref{33d,,referência forte}.
@anchor{glossary term-bytes-like-object}@anchor{d4f}
@geindex objeto bytes ou similar

@item objeto bytes ou similar

Um objeto com suporte ao @ref{2e8,,Protocolo de buffer} e que pode exportar um buffer C @ref{23b9,,contíguo}. Isso inclui todos os objetos @ref{1c2,,bytes}, @ref{2ea,,bytearray} e @ref{1a0,,array.array}, além de muitos objetos @ref{2eb,,memoryview} comuns. Objetos bytes ou similares podem ser usados para várias operações que funcionam com dados binários; isso inclui compactação, salvamento em um arquivo binário e envio por um soquete.

Algumas operações precisam que os dados binários sejam mutáveis. A documentação geralmente se refere a eles como “objetos bytes ou similares para leitura e escrita”. Exemplos de objetos de buffer mutável incluem @ref{2ea,,bytearray} e um @ref{2eb,,memoryview} de um @ref{2ea,,bytearray}. Outras operações exigem que os dados binários sejam armazenados em objetos imutáveis (“objetos bytes ou similares para somente leitura”); exemplos disso incluem @ref{1c2,,bytes} e a @ref{2eb,,memoryview} de um objeto @ref{1c2,,bytes}.
@anchor{glossary term-bytecode}@anchor{187}
@geindex bytecode

@item bytecode

O código-fonte Python é compilado para bytecode, a representação interna de um programa em Python no interpretador CPython. O bytecode também é mantido em cache em arquivos @code{.pyc} e @code{.pyo}, de forma que executar um mesmo arquivo é mais rápido na segunda vez (a recompilação dos fontes para bytecode não é necessária). Esta “linguagem intermediária” é adequada para execução em uma @ref{370d,,máquina virtual}, que executa o código de máquina correspondente para cada bytecode. Tenha em mente que não se espera que bytecodes sejam executados entre máquinas virtuais Python diferentes, nem que se mantenham estáveis entre versões de Python.

Uma lista de instruções bytecode pode ser encontrada na documentação para @ref{5b2,,o módulo dis}.
@anchor{glossary term-callable}@anchor{2aaf}
@geindex chamável

@item chamável

Um chamável é um objeto que pode ser chamado, possivelmente com um conjunto de argumentos (veja @ref{449,,argumento}), com a seguinte sintaxe:

@example
chamavel(argumento1, argumento2, argumentoN)
@end example

Uma @ref{21ea,,função}, e por extensão um @ref{1638,,método}, é um chamável. Uma instância de uma classe que implementa o método @ref{558,,__call__()} também é um chamável.
@anchor{glossary term-callback}@anchor{2ad2}
@geindex função de retorno

@item função de retorno

Também conhecida como callback, é uma função sub-rotina que é passada como um argumento a ser executado em algum ponto no futuro.
@anchor{glossary term-class}@anchor{1a8a}
@geindex classe

@item classe

Um modelo para criação de objetos definidos pelo usuário. Definições de classe normalmente contém definições de métodos que operam sobre instâncias da classe.
@anchor{glossary term-class-variable}@anchor{55ca}
@geindex variável de classe

@item variável de classe

Uma variável definida em uma classe e destinada a ser modificada apenas no nível da classe (ou seja, não em uma instância da classe).
@anchor{glossary term-closure-variable}@anchor{20d1}
@geindex variável de clausura

@item variável de clausura

Uma @ref{2169,,variável livre} referenciada de um @ref{20d0,,escopo aninhado} que é definida em um escopo externo em vez de ser resolvida em tempo de execução a partir dos espaços de nomes embutido ou globais. Pode ser explicitamente definida com a palavra reservada @ref{12ea,,nonlocal} para permitir acesso de gravação, ou implicitamente definida se a variável estiver sendo somente lida.

Por exemplo, na função @code{interna} no código a seguir, tanto @code{x} quanto @code{print} são @ref{2169,,variáveis livres}, mas somente @code{x} é uma `variável de clausura':

@example
def externa():
    x = 0
    def interna():
        nonlocal x
        x += 1
        print(x)
    return interna
@end example

Devido ao atributo @ref{208b,,codeobject.co_freevars} (que, apesar do nome, inclui apenas os nomes das variáveis de clausura em vez de listar todas as variáveis livres referenciadas), o termo mais geral @ref{2169,,variável livre} às vezes é usado mesmo quando o significado pretendido é se referir especificamente às variáveis de clausura.
@anchor{glossary term-complex-number}@anchor{55cb}
@geindex número complexo

@item número complexo

Uma extensão ao familiar sistema de números reais em que todos os números são expressos como uma soma de uma parte real e uma parte imaginária. Números imaginários são múltiplos reais da unidade imaginária (a raiz quadrada de @code{-1}), normalmente escrita como @code{i} em matemática ou @code{j} em engenharia. O Python tem suporte nativo para números complexos, que são escritos com esta última notação; a parte imaginária escrita com um sufixo @code{j}, p.ex., @code{3+1j}. Para ter acesso aos equivalentes para números complexos do módulo @ref{8e,,math}, utilize @ref{18,,cmath}. O uso de números complexos é uma funcionalidade matemática bastante avançada. Se você não sabe se irá precisar deles, é quase certo que você pode ignorá-los sem problemas.
@anchor{glossary term-concurrency}@anchor{55cc}
@geindex concorrência

@item concorrência

A capacidade de um programa de computador executar múltiplas tarefas simultaneamente. Python fornece bibliotecas para escrever programas que utilizam diferentes formas de concorrência. O @ref{a,,asyncio} é uma biblioteca para lidar com tarefas assíncronas e corrotinas. O @ref{ed,,threading} fornece acesso a threads do sistema operacional e o @ref{94,,multiprocessing} a processos do sistema operacional. Processadores com vários núcleos podem executar threads e processos em diferentes núcleos da CPU ao mesmo tempo (veja o @ref{55cd,,paralelismo}).
@anchor{glossary term-concurrent-modification}@anchor{55ce}
@geindex modificação concorrente

@item modificação concorrente

Quando várias threads modificam dados compartilhados simultaneamente, a modificação concorrente sem a devida sincronização pode causar @ref{55c7,,condições de corrida} e também pode causar @ref{55c8,,corrida de dados}, corrupção de dados ou ambos.
@anchor{glossary term-context}@anchor{1696}
@geindex contexto

@item contexto

Este termo tem diferentes significados dependendo de onde e como ele é usado. Alguns significados comuns:


@itemize *

@item 
O estado ou ambiente temporário estabelecido por um @ref{5d4,,gerenciador de contexto} por meio de uma instrução @ref{5d2,,with}.

@item 
A coleção de ligações de chave-valor associadas a um objeto @ref{15b7,,contextvars.Context} específico e acessadas por meio de objetos @ref{1643,,ContextVar}. Veja também @ref{55cf,,variável de contexto}.

@item 
Um objeto @ref{15b7,,contextvars.Context}. Veja também @ref{1697,,contexto atual}.
@end itemize
@anchor{glossary term-context-management-protocol}@anchor{1698}
@geindex protocolo de gerenciamento de contexto

@item protocolo de gerenciamento de contexto

Os métodos @ref{5c8,,__enter__()} e @ref{1344,,__exit__()} chamados pela instrução @ref{5d2,,with}. Veja 
@geindex Propostas de Melhorias do Python; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.
@anchor{glossary term-context-manager}@anchor{5d4}
@geindex gerenciador de contexto

@item gerenciador de contexto

Um objeto que implementa o @ref{1698,,protocolo de gerenciamento de contexto} e controla o ambiente envolto em uma instrução @ref{5d2,,with}. Veja 
@geindex Propostas de Melhorias do Python; PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}.
@anchor{glossary term-context-variable}@anchor{55cf}
@geindex variável de contexto

@item variável de contexto

Uma variável cujo valor depende de qual contexto é o @ref{1697,,contexto atual}. Os valores são acessados por meio de objetos @ref{1643,,contextvars.ContextVar}. Variáveis de contexto são usadas principalmente para isolar o estado entre tarefas assíncronas simultâneas.
@anchor{glossary term-contiguous}@anchor{23b9}
@geindex contíguo

@item contíguo

@geindex contíguo C
@geindex contíguo Fortran

Um buffer é considerado contíguo exatamente se for `contíguo C' ou `contíguo Fortran'. Os buffers de dimensão zero são contíguos C e Fortran. Em vetores unidimensionais, os itens devem ser dispostos na memória próximos um do outro, em ordem crescente de índices, começando do zero. Em vetores multidimensionais contíguos C, o último índice varia mais rapidamente ao visitar itens em ordem de endereço de memória. No entanto, nos vetores contíguos do Fortran, o primeiro índice varia mais rapidamente.
@anchor{glossary term-coroutine}@anchor{491}
@geindex corrotina

@item corrotina

Corrotinas são uma forma mais generalizada de sub-rotinas. Sub-rotinas tem a entrada iniciada em um ponto, e a saída em outro ponto. Corrotinas podem entrar, sair, e continuar em muitos pontos diferentes. Elas podem ser implementadas com a instrução @ref{5d1,,async def}. Veja também 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-coroutine-function}@anchor{d9b}
@geindex função de corrotina

@item função de corrotina

Uma função que retorna um objeto do tipo @ref{491,,corrotina}. Uma função de corrotina pode ser definida com a instrução @ref{5d1,,async def}, e pode conter as palavras chaves @ref{1b9,,await}, @ref{aba,,async for}, e @ref{5d5,,async with}. Isso foi introduzido pela 
@geindex Propostas de Melhorias do Python; PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}.
@anchor{glossary term-CPython}@anchor{6f6}
@geindex CPython

@item CPython

A implementação canônica da linguagem de programação Python, como disponibilizada pelo python.org@footnote{https://www.python.org}. O termo “CPython” é usado quando necessário distinguir esta implementação de outras como Jython ou IronPython.
@anchor{glossary term-current-context}@anchor{1697}
@geindex contexto atual

@item contexto atual

O @ref{1696,,contexto} (objeto @ref{15b7,,contextvars.Context}) que é usado atualmente pelos objetos @ref{1643,,ContextVar} para acessar (obter ou definir) os valores de @ref{55cf,,variáveis de contexto}. Cada thread tem seu próprio contexto atual. Frameworks para executar tarefas assíncronas (veja @ref{a,,asyncio}) associam cada tarefa a um contexto que se torna o contexto atual sempre que a tarefa inicia ou retoma a execução.
@anchor{glossary term-data-race}@anchor{55c8}
@geindex corrida de dados

@item corrida de dados

A situation where multiple threads access the same memory location
concurrently, at least one of the accesses is a write, and the threads
do not use any synchronization to control their access.  Data races
lead to @ref{55d0,,non-deterministic} behavior and can cause data corruption.
Proper use of @ref{55d1,,locks} and other @ref{55d2,,synchronization primitives} prevents data races.  Note that data races
can only happen in native code, but that @ref{55d3,,native code} might be
exposed in a Python API.  See also @ref{55c7,,race condition} and
@ref{55d4,,thread-safe}.
@anchor{glossary term-deadlock}@anchor{55d5}
@geindex impasse

@item impasse

A situation in which two or more tasks (threads, processes, or coroutines)
wait indefinitely for each other to release resources or complete actions,
preventing any from making progress.  For example, if thread A holds lock
1 and waits for lock 2, while thread B holds lock 2 and waits for lock 1,
both threads will wait indefinitely.  In Python this often arises from
acquiring multiple locks in conflicting orders or from circular
join/await dependencies.  Deadlocks can be avoided by always acquiring
multiple @ref{55d1,,locks} in a consistent order.  See also
@ref{55d1,,lock} and @ref{55d6,,reentrant}.
@anchor{glossary term-decorator}@anchor{731}
@geindex decorador

@item decorador

Uma função que retorna outra função, geralmente aplicada como uma transformação de função usando a sintaxe @code{@@wrapper}. Exemplos comuns para decoradores são @ref{166,,classmethod()} e @ref{416,,staticmethod()}.

A sintaxe do decorador é meramente um açúcar sintático, as duas definições de funções a seguir são semanticamente equivalentes:

@example
def f(arg):
    ...
f = staticmethod(f)

@@staticmethod
def f(arg):
    ...
@end example

O mesmo conceito existe para as classes, mas não é comumente utilizado. Veja a documentação de @ref{1db6,,definições de função} e @ref{131a,,definições de classe} para obter mais informações sobre decoradores.
@anchor{glossary term-descriptor}@anchor{1658}
@geindex descritor

@item descritor

Qualquer objeto que define os métodos @ref{1530,,__get__()}, @ref{20f7,,__set__()} ou @ref{16f5,,__delete__()}. Quando um atributo de classe é um descritor, seu comportamento de associação especial é acionado no acesso a um atributo. Normalmente, ao se utilizar `a.b' para se obter, definir ou excluir, um atributo dispara uma busca no objeto chamado `b' no dicionário de classe de `a', mas se `b' for um descritor, o respectivo método descritor é chamado. Compreender descritores é a chave para um profundo entendimento de Python pois eles são a base de muitas funcionalidades incluindo funções, métodos, propriedades, métodos de classe, métodos estáticos e referências para superclasses.

Para obter mais informações sobre os métodos dos descritores, veja: @ref{c6a,,Implementando descritores} ou o @ref{1535,,Guia de Descritores}.
@anchor{glossary term-dictionary}@anchor{2117}
@geindex dicionário

@item dicionário

Um vetor associativo em que chaves arbitrárias são mapeadas para valores. As chaves podem ser quaisquer objetos que possuam os métodos @ref{b0e,,__hash__()} e @ref{b0d,,__eq__()}. Isso é chamado de hash em Perl.
@anchor{glossary term-dictionary-comprehension}@anchor{55d7}
@geindex compreensão de dicionário

@item compreensão de dicionário

Uma maneira compacta de processar todos ou parte dos elementos de um iterável e retornar um dicionário com os resultados. @code{results = @{n: n ** 2 for n in range(10)@}} gera um dicionário contendo a chave @code{n} mapeada para o valor @code{n ** 2}. Veja @ref{5d0,,Sintaxe de criação de listas@comma{} conjuntos e dicionários}.
@anchor{glossary term-dictionary-view}@anchor{26bf}
@geindex visão de dicionário

@item visão de dicionário

Os objetos retornados por @ref{7ce,,dict.keys()}, @ref{7cf,,dict.values()} e @ref{7d0,,dict.items()} são chamados de visões de dicionário. Eles fornecem uma visão dinâmica das entradas do dicionário, o que significa que quando o dicionário é alterado, a visão reflete essas alterações. Para forçar a visão de dicionário a se tornar uma lista completa use @code{list(dictview)}. Veja @ref{23d8,,Objetos de visão de dicionário}.
@anchor{glossary term-docstring}@anchor{22bd}
@geindex docstring

@item docstring

Abreviatura de “documentation string” (string de documentação). Uma string literal que aparece como primeira expressão numa classe, função ou módulo. Ainda que sejam ignoradas quando a suíte é executada, é reconhecida pelo compilador que a coloca no atributo @ref{92e,,__doc__} da classe, função ou módulo que a encapsula. Como ficam disponíveis por meio de introspecção, docstrings são o lugar canônico para documentação do objeto.
@anchor{glossary term-duck-typing}@anchor{55c5}
@geindex tipagem pato

@item tipagem pato

Também conhecida como `duck-typing', é um estilo de programação que não verifica o tipo do objeto para determinar se ele possui a interface correta; em vez disso, o método ou atributo é simplesmente chamado ou utilizado (“Se se parece com um pato e grasna como um pato, então deve ser um pato.”) Enfatizando interfaces ao invés de tipos específicos, o código bem desenvolvido aprimora sua flexibilidade por permitir substituição polimórfica. Tipagem pato evita necessidade de testes que usem @ref{d6b,,type()} ou @ref{442,,isinstance()}. (Note, porém, que a tipagem pato pode ser complementada com o uso de @ref{11f5,,classes base abstratas}.) Ao invés disso, são normalmente empregados testes @ref{4d2,,hasattr()} ou programação @ref{2d5a,,EAFP}.
@anchor{glossary term-dunder}@anchor{55d8}
@geindex dunder

@item dunder

Uma abreviação informal para “double underscore” (em português, sublinhado duplo), usada ao se referir a um @ref{19eb,,método especial}. Por exemplo, @code{__init__} é frequentemente pronunciado como “dunder init”.
@anchor{glossary term-EAFP}@anchor{2d5a}
@geindex EAFP

@item EAFP

Iniciais da expressão em inglês “easier to ask for forgiveness than permission” que significa “é mais fácil pedir perdão que permissão”. Este estilo de codificação comum no Python presume a existência de chaves ou atributos válidos e captura exceções caso essa premissa se prove falsa. Este estilo limpo e rápido se caracteriza pela presença de várias instruções @ref{6e9,,try} e @ref{18b,,except}. A técnica diverge do estilo @ref{55d9,,LBYL}, comum em outras linguagens como C, por exemplo.
@anchor{glossary term-expression}@anchor{2111}
@geindex expressão

@item expressão

Uma parte da sintaxe que pode ser avaliada para algum valor. Em outras palavras, uma expressão é a acumulação de elementos de expressão como literais, nomes, atributos de acesso, operadores ou chamadas de funções, todos os quais retornam um valor. Em contraste com muitas outras linguagens, nem todas as construções de linguagem são expressões. Também existem @ref{2935,,instruções}, as quais não podem ser usadas como expressões, como, por exemplo, @ref{1d82,,while}. Atribuições também são instruções, não expressões.
@anchor{glossary term-extension-module}@anchor{47eb}
@geindex módulo de extensão

@item módulo de extensão

Um módulo escrito em C ou C++, usando a API C do Python para interagir tanto com código de usuário quanto do núcleo.
@anchor{glossary term-f-string}@anchor{436}
@geindex f-string

@item f-string

Literais string prefixadas com @code{'f'} ou @code{'F'} são conhecidas como “f-strings” que é uma abreviação de @ref{9b1,,formatted string literals}. Veja também 
@geindex Propostas de Melhorias do Python; PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/}.
@anchor{glossary term-file-object}@anchor{1203}
@geindex objeto arquivo

@item objeto arquivo

Um objeto que expõe uma API orientada a arquivos (com métodos tais como @code{read()} ou @code{write()}) para um recurso subjacente. Dependendo da maneira como foi criado, um objeto arquivo pode mediar o acesso a um arquivo real no disco ou outro tipo de dispositivo de armazenamento ou de comunicação (por exemplo a entrada/saída padrão, buffers em memória, soquetes, pipes, etc.). Objetos arquivo também são chamados de `objetos arquivo ou similares' ou `fluxos'.

Atualmente há três categorias de objetos arquivo: @ref{1e0e,,arquivos binários} brutos, @ref{1e0e,,arquivos binários} em buffer e @ref{1e0d,,arquivos textos}. Suas interfaces estão definidas no módulo @ref{7f,,io}. A forma canônica para criar um objeto arquivo é usando a função @ref{51c,,open()}.
@anchor{glossary term-file-like-object}@anchor{15cf}
@geindex objeto arquivo ou similar

@item objeto arquivo ou similar

Um sinônimo do termo @ref{1203,,objeto arquivo}.
@anchor{glossary term-filesystem-encoding-and-error-handler}@anchor{53b}
@geindex tratador de erros e codificação do sistema de arquivos

@item tratador de erros e codificação do sistema de arquivos

Tratador de erros e codificação usado pelo Python para decodificar bytes do sistema operacional e codificar Unicode para o sistema operacional.

A codificação do sistema de arquivos deve garantir a decodificação bem-sucedida de todos os bytes abaixo de 128. Se a codificação do sistema de arquivos falhar em fornecer essa garantia, as funções da API podem levantar @ref{12e6,,UnicodeError}.

As funções @ref{c74,,sys.getfilesystemencoding()} e @ref{d07,,sys.getfilesystemencodeerrors()} podem ser usadas para obter o tratador de erros e codificação do sistema de arquivos.

O @ref{53b,,tratador de erros e codificação do sistema de arquivos} são configurados na inicialização do Python pela função @ref{790,,PyConfig_Read()}: veja os membros @ref{3e8,,filesystem_encoding} e @ref{3e9,,filesystem_errors} do @ref{3a6,,PyConfig}.

Veja também @ref{242,,codificação da localidade}.
@anchor{glossary term-finder}@anchor{20ae}
@geindex localizador

@item localizador

Um objeto que tenta encontrar o @ref{17a4,,carregador} para um módulo que está sendo importado.

Existem dois tipos de localizador: @ref{10a9,,localizadores de metacaminho} para uso com @ref{d4d,,sys.meta_path}, e @ref{10aa,,localizadores de entrada de caminho} para uso com @ref{105a,,sys.path_hooks}.

Veja @ref{2182,,Localizadores e carregadores} e @ref{77,,importlib} para muito mais detalhes.
@anchor{glossary term-floor-division}@anchor{94b}
@geindex divisão pelo piso

@item divisão pelo piso

Divisão matemática que arredonda para baixo para o inteiro mais próximo. O operador de divisão pelo piso é @code{//}. Por exemplo, a expressão @code{11 // 4} retorna o valor @code{2} ao invés de @code{2.75}, que seria retornado pela divisão de ponto flutuante. Note que @code{(-11) // 4} é @code{-3} porque é @code{-2.75} arredondado `para baixo'. Consulte a 
@geindex Propostas de Melhorias do Python; PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}.
@anchor{glossary term-free-threading}@anchor{15e4}
@geindex threads livres

@item threads livres

Um modelo de threads onde múltiplas threads podem simultaneamente executar bytecode Python no mesmo interpretador.  Isso está em contraste com a @ref{148,,trava global do interpretador} que permite apenas uma thread por vez executar bytecode Python. Veja 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.
@anchor{glossary term-free-variable}@anchor{2169}
@geindex variável livre

@item variável livre

Formalmente, conforme definido no @ref{2166,,modelo de execução de linguagem}, uma variável livre é qualquer variável usada em um espaço de nomes que não seja uma variável local naquele espaço de nomes. Veja @ref{20d1,,variável de clausura} para um exemplo. Pragmaticamente, devido ao nome do atributo @ref{208b,,codeobject.co_freevars}, o termo também é usado algumas vezes como sinônimo de @ref{20d1,,variável de clausura}.
@anchor{glossary term-function}@anchor{21ea}
@geindex função

@item função

Uma série de instruções que retorna algum valor para um chamador. Também pode ser passado zero ou mais @ref{449,,argumentos} que podem ser usados na execução do corpo. Veja também @ref{208f,,parâmetro}, @ref{1638,,método} e a seção @ref{1db6,,Definições de função}.
@anchor{glossary term-function-annotation}@anchor{1db7}
@geindex anotação de função

@item anotação de função

Uma @ref{458,,anotação} de um parâmetro de função ou valor de retorno.

Anotações de função são comumente usados por @ref{210d,,dicas de tipo}: por exemplo, essa função espera receber dois argumentos @ref{257,,int} e também é esperado que devolva um valor @ref{257,,int}:

@example
def soma_dois_numeros(a: int, b: int) -> int:
   return a + b
@end example

A sintaxe de anotação de função é explicada na seção @ref{1db6,,Definições de função}.

Veja @ref{d79,,anotação de variável} e 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, que descrevem esta funcionalidade. Veja também @ref{7da,,Boas práticas para anotações} para as melhores práticas sobre como trabalhar com anotações.
@anchor{glossary term-__future__}@anchor{dd5}
@geindex __future__

@item __future__

A @ref{189,,instrução future}, @code{from __future__ import <feature>}, direciona o compilador a compilar o módulo atual usando sintaxe ou semântica que será padrão em uma versão futura de Python. O módulo @ref{0,,__future__} documenta os possíveis valores de `feature'.  Importando esse módulo e avaliando suas variáveis, você pode ver quando um novo recurso foi inicialmente adicionado à linguagem e quando será (ou se já é) o padrão:

@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{1a69}
@geindex coleta de lixo

@item coleta de lixo

Também conhecido como `garbage collection', é o processo de liberar a memória quando ela não é mais utilizada. Python executa a liberação da memória através da contagem de referências e um coletor de lixo cíclico que é capaz de detectar e interromper referências cíclicas. O coletor de lixo pode ser controlado usando o módulo @ref{60,,gc}.

@geindex gerador
@anchor{glossary term-generator}@anchor{109a}
@geindex gerador

@item gerador

Uma função que retorna um @ref{bf9,,iterador gerador}. É parecida com uma função normal, exceto pelo fato de conter expressões @ref{9d5,,yield} para produzir uma série de valores que podem ser usados em um laço “for” ou que podem ser obtidos um de cada vez com a função @ref{7d9,,next()}.

Normalmente refere-se a uma função geradora, mas pode referir-se a um `iterador gerador' em alguns contextos. Em alguns casos onde o significado desejado não está claro, usar o termo completo evita ambiguidade.
@anchor{glossary term-generator-iterator}@anchor{bf9}
@geindex iterador gerador

@item iterador gerador

Um objeto criado por uma função @ref{109a,,geradora}.

Cada @ref{9d5,,yield} suspende temporariamente o processamento, memorizando o estado da execução (incluindo variáveis locais e instruções try pendentes). Quando o `iterador gerador' retorna, ele se recupera do último ponto onde estava (em contrapartida as funções que iniciam uma nova execução a cada vez que são invocadas).

@geindex expressão geradora
@anchor{glossary term-generator-expression}@anchor{55da}
@geindex expressão geradora

@item expressão geradora

Uma @ref{2111,,expressão} que retorna um @ref{1ac,,iterador}. Parece uma expressão normal, seguido de uma cláusula @code{for} definindo uma variável de laço, um intervalo, e uma cláusula @code{if} opcional. A expressão combinada gera valores para uma função encapsuladora:

@example
>>> sum(i*i for i in range(10))         # soma dos quadrados 0, 1, 4, ... 81
285
@end example
@anchor{glossary term-generic-function}@anchor{9f9}
@geindex função genérica

@item função genérica

Uma função composta por várias funções implementando a mesma operação para diferentes tipos. Qual implementação deverá ser usada durante a execução é determinada pelo algoritmo de despacho.

Veja também a entrada @ref{9fa,,despacho único} no glossário, o decorador @ref{639,,functools.singledispatch()}, e a 
@geindex Propostas de Melhorias do Python; PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/}.
@anchor{glossary term-generic-type}@anchor{439}
@geindex tipo genérico

@item tipo genérico

Um @ref{1a8b,,tipo} que pode ser parametrizado; tipicamente uma @ref{2116,,classe contêiner} tal como @ref{611,,list} ou @ref{256,,dict}. Usado para @ref{210d,,dicas de tipo} e @ref{458,,anotações}.

Para mais detalhes, veja @ref{6b2,,tipo apelido genérico}, 
@geindex Propostas de Melhorias do Python; PEP 483
PEP 483@footnote{https://peps.python.org/pep-0483/}, 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, 
@geindex Propostas de Melhorias do Python; PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}, e o módulo @ref{104,,typing}.
@anchor{glossary term-GIL}@anchor{159}
@geindex GIL

@item GIL

Veja @ref{148,,trava global do interpretador}.
@anchor{glossary term-global-interpreter-lock}@anchor{148}
@geindex trava global do interpretador

@item trava global do interpretador

O mecanismo utilizado pelo interpretador @ref{6f6,,CPython} para garantir que apenas uma thread execute o @ref{187,,bytecode} Python por vez. Isto simplifica a implementação do CPython ao fazer com que o modelo de objetos (incluindo tipos embutidos críticos como o @ref{256,,dict}) ganhem segurança implícita contra acesso concorrente. Travar todo o interpretador facilita que o interpretador em si seja multithread, às custas de muito do paralelismo já provido por máquinas com multiprocessadores.

No entanto, alguns módulos de extensão, tanto da biblioteca padrão quanto de terceiros, são desenvolvidos de forma a liberar a GIL ao realizar tarefas computacionalmente muito intensas, como compactação ou cálculos de hash. Além disso, a GIL é sempre liberada nas operações de E/S.

A partir de Python 3.13, o GIL pode ser desabilitado usando a configuração de construção @ref{174,,--disable-gil}. Depois de construir Python com essa opção, o código deve ser executado com a opção @ref{176,,-X gil=0} ou a variável de ambiente 
@geindex PYTHON_GIL
@geindex variável de ambiente; PYTHON_GIL
@ref{175,,PYTHON_GIL=0} deve estar definida. Esse recurso provê um desempenho melhor para aplicações com múltiplas threads e torna mais fácil o uso eficiente de CPUs com múltiplos núcleos. Para mais detalhes, veja 
@geindex Propostas de Melhorias do Python; PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}.
@anchor{glossary term-global-state}@anchor{55db}
@geindex estado global

@item estado global

Data that is accessible throughout a program, such as module-level
variables, class variables, or C static variables in @ref{47eb,,extension modules}.  In multi-threaded programs, global state shared
between threads typically requires synchronization to avoid
@ref{55c7,,race conditions} and
@ref{55c8,,data races}.
@anchor{glossary term-hash-based-pyc}@anchor{55dc}
@geindex pyc baseado em hash

@item pyc baseado em hash

Um arquivo de cache em bytecode que usa hash ao invés do tempo, no qual o arquivo de código-fonte foi modificado pela última vez, para determinar a sua validade. Veja @ref{5ec,,Invalidação de bytecode em cache}.
@anchor{glossary term-hashable}@anchor{610}
@geindex hasheável

@item hasheável

Um objeto é `hasheável' se tem um valor de hash que nunca muda durante seu ciclo de vida (precisa ter um método @ref{b0e,,__hash__()}) e pode ser comparado com outros objetos (precisa ter um método @ref{b0d,,__eq__()}). Objetos hasheáveis que são comparados como iguais devem ter o mesmo valor de hash.

A hasheabilidade faz com que um objeto possa ser usado como uma chave de dicionário e como um membro de conjunto, pois estas estruturas de dados utilizam os valores de hash internamente.

A maioria dos objetos embutidos imutáveis do Python são hasheáveis; contêineres mutáveis (tais como listas ou dicionários) não são; contêineres imutáveis (tais como tuplas e frozensets) são hasheáveis apenas se os seus elementos são hasheáveis. Objetos que são instâncias de classes definidas pelo usuário são hasheáveis por padrão. Todos eles comparam de forma desigual (exceto entre si mesmos), e o seu valor hash é derivado a partir do seu @ref{146a,,id()}.
@anchor{glossary term-IDLE}@anchor{55dd}
@geindex IDLE

@item IDLE

Um ambiente de desenvolvimento e aprendizado integrado para Python. @ref{104b,,IDLE — editor e console Python} é um editor básico e um ambiente interpretador que vem junto com a distribuição padrão do Python.
@anchor{glossary term-immortal}@anchor{45bb}
@geindex imortal

@item imortal

`Objetos imortais' são um detalhe da implementação do CPython introduzida na 
@geindex Propostas de Melhorias do Python; PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}.

Se um objeto é imortal, sua @ref{4b73,,contagem de referências} nunca é modificada e, portanto, nunca é desalocado enquanto o interpretador está em execução. Por exemplo, @ref{c27,,True} e @ref{675,,None} são imortais no CPython.
@anchor{glossary term-immutable}@anchor{1d79}
@geindex imutável

@item imutável

An object with a fixed value.  Immutable objects include numbers, strings and
tuples.  Such an object cannot be altered.  A new object has to
be created if a different value has to be stored.  They play an important
role in places where a constant hash value is needed, for example as a key
in a dictionary.  Immutable objects are inherently @ref{55d4,,thread-safe}
because their state cannot be modified after creation, eliminating concerns
about improperly synchronized @ref{55ce,,concurrent modification}.
@anchor{glossary term-import-path}@anchor{2185}
@geindex caminho de importação

@item caminho de importação

Uma lista de localizações (ou @ref{2193,,entradas de caminho}) que são buscadas pelo @ref{2188,,localizador baseado no caminho} por módulos para importar. Durante a importação, esta lista de localizações usualmente vem a partir de @ref{3b4,,sys.path}, mas para subpacotes ela também pode vir do atributo @code{__path__} de pacotes-pai.
@anchor{glossary term-importing}@anchor{2178}
@geindex importação

@item importação

O processo pelo qual o código Python em um módulo é disponibilizado para o código Python em outro módulo.
@anchor{glossary term-importer}@anchor{2184}
@geindex importador

@item importador

Um objeto que localiza e carrega um módulo; Tanto um @ref{20ae,,localizador} e o objeto @ref{17a4,,carregador}.
@anchor{glossary term-interactive}@anchor{169}
@geindex interativo

@item interativo

Python tem um interpretador interativo, o que significa que você pode digitar instruções e expressões no prompt do interpretador, executá-los imediatamente e ver seus resultados. Apenas execute @code{python} sem argumentos (possivelmente selecionando-o a partir do menu de aplicações de seu sistema operacional). O interpretador interativo é uma maneira poderosa de testar novas ideias ou aprender mais sobre módulos e pacotes (lembre-se do comando @code{help(x)}). Para saber mais sobre modo interativo, veja @ref{16f,,Modo interativo}.
@anchor{glossary term-interpreted}@anchor{55de}
@geindex interpretado

@item interpretado

Python é uma linguagem interpretada, em oposição àquelas que são compiladas, embora esta distinção possa ser nebulosa devido à presença do compilador de bytecode. Isto significa que os arquivos-fontes podem ser executados diretamente sem necessidade explícita de se criar um arquivo executável. Linguagens interpretadas normalmente têm um ciclo de desenvolvimento/depuração mais curto que as linguagens compiladas, apesar de seus programas geralmente serem executados mais lentamente. Veja também @ref{169,,interativo}.
@anchor{glossary term-interpreter-shutdown}@anchor{14e}
@geindex desligamento do interpretador

@item desligamento do interpretador

Quando solicitado para desligar, o interpretador Python entra em uma fase especial, onde ele gradualmente libera todos os recursos alocados, tais como módulos e várias estruturas internas críticas. Ele também faz diversas chamadas para o @ref{1a69,,coletor de lixo}. Isto pode disparar a execução de código em destrutores definidos pelo usuário ou função de retorno de referência fraca. Código executado durante a fase de desligamento pode encontrar diversas exceções, pois os recursos que ele depende podem não funcionar mais (exemplos comuns são os módulos de bibliotecas, ou os mecanismos de avisos).

A principal razão para o interpretador desligar, é que o módulo @code{__main__} ou o script sendo executado terminou sua execução.
@anchor{glossary term-iterable}@anchor{1268}
@geindex iterável

@item iterável

Um objeto capaz de retornar seus membros um de cada vez. Exemplos de iteráveis incluem todos os tipos de sequência (tais como @ref{611,,list}, @ref{44c,,str} e @ref{370,,tuple}) e alguns tipos de não-sequência, como o @ref{256,,dict} e @ref{1203,,objetos arquivo}, além dos objetos de quaisquer classes que você definir com um método @ref{c8a,,__iter__()} ou @ref{283,,__getitem__()} que implementam a semântica de @ref{4f1,,sequência}.

Iteráveis podem ser usados em um laço @ref{2f2,,for} e em vários outros lugares em que uma sequência é necessária (@ref{7d1,,zip()}, @ref{867,,map()}, …). Quando um objeto iterável é passado como argumento para a função embutida @ref{7d8,,iter()}, ela retorna um iterador para o objeto. Este iterador é adequado para se varrer todo o conjunto de valores. Ao usar iteráveis, normalmente não é necessário chamar @ref{7d8,,iter()} ou lidar com os objetos iteradores em si. A instrução @ref{2f2,,for} faz isso automaticamente para você, criando uma variável temporária para armazenar o iterador durante a execução do laço. Veja também @ref{1ac,,iterador}, @ref{4f1,,sequência}, e @ref{109a,,gerador}.
@anchor{glossary term-iterator}@anchor{1ac}
@geindex iterador

@item iterador

Um objeto que representa um fluxo de dados. Repetidas chamadas ao método @ref{1310,,__next__()} de um iterador (ou passando o objeto para a função embutida @ref{7d9,,next()}) vão retornar itens sucessivos do fluxo. Quando não houver mais dados disponíveis uma exceção @ref{c15,,StopIteration} será levantada. Neste ponto, o objeto iterador se esgotou e quaisquer chamadas subsequentes a seu método @code{__next__()} vão apenas levantar a exceção @ref{c15,,StopIteration} novamente. Iteradores precisam ter um método @ref{1e4d,,__iter__()} que retorne o objeto iterador em si, de forma que todo iterador também é iterável e pode ser usado na maioria dos lugares em que um iterável é requerido. Uma notável exceção é código que tenta realizar passagens em múltiplas iterações. Um objeto contêiner (como uma @ref{611,,list}) produz um novo iterador a cada vez que você passá-lo para a função @ref{7d8,,iter()} ou utilizá-lo em um laço @ref{2f2,,for}. Tentar isso com o mesmo iterador apenas iria retornar o mesmo objeto iterador esgotado já utilizado na iteração anterior, como se fosse um contêiner vazio.

Mais informações podem ser encontradas em @ref{230c,,Tipos iteradores}.

`Detalhes da implementação do CPython:' CPython does not consistently apply the requirement that an iterator
define @ref{1e4d,,__iter__()}.
And also please note that @ref{15e4,,free-threaded}
CPython does not guarantee @ref{55d4,,thread-safe} behavior of iterator
operations.
@anchor{glossary term-key-function}@anchor{e31}
@geindex função chave

@item função chave

Uma função chave ou função colação é um chamável que retorna um valor usado para ordenação ou classificação. Por exemplo, @ref{15f3,,locale.strxfrm()} é usada para produzir uma chave de ordenação que leva o locale em consideração para fins de ordenação.

Uma porção de ferramentas no Python aceitam funções chave para controlar como os elementos são ordenados ou agrupados. Algumas delas incluem @ref{f3a,,min()}, @ref{f3b,,max()}, @ref{be7,,sorted()}, @ref{be8,,list.sort()}, @ref{e30,,heapq.merge()}, @ref{26d7,,heapq.nsmallest()}, @ref{26d6,,heapq.nlargest()} e @ref{28dd,,itertools.groupby()}.

There are several ways to create a key function.  For example. the
@ref{e00,,str.casefold()} method can serve as a key function for case insensitive
sorts.  Alternatively, a key function can be built from a
@ref{12df,,lambda} expression such as @code{lambda r: (r[0], r[2])}.  Also,
@ref{e60,,operator.attrgetter()}, @ref{a6b,,operator.itemgetter()}, and
@ref{e61,,operator.methodcaller()} are three key function constructors.  See the @ref{2314,,Sorting HOW TO} for examples of how to create and use key functions.
@anchor{glossary term-keyword-argument}@anchor{d34}
@geindex argumento nomeado

@item argumento nomeado

Veja @ref{449,,argumento}.
@anchor{glossary term-lambda}@anchor{28ec}
@geindex lambda

@item lambda

Uma função de linha anônima consistindo de uma única @ref{2111,,expressão}, que é avaliada quando a função é chamada. A sintaxe para criar uma função lambda é @code{lambda [parameters]: expression}
@anchor{glossary term-LBYL}@anchor{55d9}
@geindex LBYL

@item LBYL

Iniciais da expressão em inglês “look before you leap”, que significa algo como “olhe antes de pisar”. Este estilo de codificação testa as pré-condições explicitamente antes de fazer chamadas ou buscas. Este estilo contrasta com a abordagem @ref{2d5a,,EAFP} e é caracterizada pela presença de muitas instruções @ref{2f3,,if}.

In a multi-threaded environment, the LBYL approach can risk introducing a
@ref{55c7,,race condition} between “the looking” and “the leaping”.  For example,
the code, @code{if key in mapping: return mapping[key]} can fail if another
thread removes `key' from `mapping' after the test, but before the lookup.
This issue can be solved with @ref{55d1,,locks} or by using the
@ref{2d5a,,EAFP} approach.  See also @ref{55d4,,thread-safe}.
@anchor{glossary term-lexical-analyzer}@anchor{55df}
@geindex analisador léxico

@item analisador léxico

Nome formal para o `tokenizador'; veja @ref{200a,,token}.
@anchor{glossary term-list}@anchor{55e0}
@geindex lista

@item lista

Uma @ref{4f1,,sequência} embutida no Python. Apesar do seu nome, é mais próximo de um vetor em outras linguagens do que uma lista encadeada, como o acesso aos elementos é da ordem `O'(1).
@anchor{glossary term-list-comprehension}@anchor{6ce}
@geindex compreensão de lista

@item compreensão de lista

Uma maneira compacta de processar todos ou parte dos elementos de uma sequência e retornar os resultados em uma lista. @code{result = ['@{:#04x@}'.format(x) for x in range(256) if x % 2 == 0]} gera uma lista de strings contendo números hexadecimais (0x..) no intervalo de 0 a 255. A cláusula @ref{2f3,,if} é opcional. Se omitida, todos os elementos no @code{range(256)} serão processados.
@anchor{glossary term-lock}@anchor{55d1}
@geindex trava

@item trava

A @ref{55d2,,synchronization primitive} that allows only one thread at a
time to access a shared resource.  A thread must acquire a lock before
accessing the protected resource and release it afterward.  If a thread
attempts to acquire a lock that is already held by another thread, it
will block until the lock becomes available.  Python’s @ref{ed,,threading}
module provides @ref{176d,,Lock} (a basic lock) and
@ref{2de,,RLock} (a @ref{55d6,,reentrant} lock).  Locks are used
to prevent @ref{55c7,,race conditions} and ensure
@ref{55d4,,thread-safe} access to shared data.  Alternative design patterns
to locks exist such as queues, producer/consumer patterns, and
thread-local state. See also @ref{55d5,,deadlock}, and @ref{55d6,,reentrant}.
@anchor{glossary term-loader}@anchor{17a4}
@geindex carregador

@item carregador

Um objeto que carrega um módulo. Ele deve definir os métodos @code{exec_module()} e @code{create_module()} para implementar a interface @ref{ef6,,Loader}. Um carregador é normalmente retornado por um @ref{20ae,,localizador}. Veja também:


@itemize *

@item 
@ref{2182,,Localizadores e carregadores}

@item 
@ref{ef6,,importlib.abc.Loader}

@item 
@geindex Propostas de Melhorias do Python; PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}
@end itemize
@anchor{glossary term-locale-encoding}@anchor{242}
@geindex codificação da localidade

@item codificação da localidade

No Unix, é a codificação da localidade do LC_CTYPE, que pode ser definida com @ref{2db,,locale.setlocale(locale.LC_CTYPE@comma{} new_locale)}.

No Windows, é a página de código ANSI (ex: @code{"cp1252"}).

No Android e no VxWorks, o Python usa @code{"utf-8"} como a codificação da localidade.

@ref{2dc,,locale.getencoding()} pode ser usado para obter a codificação da localidade.

Veja também @ref{53b,,tratador de erros e codificação do sistema de arquivos}.
@anchor{glossary term-magic-method}@anchor{4318}
@geindex método mágico

@item método mágico

@geindex mágico;método

Um sinônimo informal para um @ref{19eb,,método especial}.
@anchor{glossary term-mapping}@anchor{11fb}
@geindex mapeamento

@item mapeamento

Um objeto contêiner com suporte a pesquisas de chave arbitrária e que implementa os métodos especificados nas @ref{87c,,classes base abstratas} @ref{8d0,,collections.abc.Mapping} ou @ref{10eb,,collections.abc.MutableMapping}. Exemplos incluem @ref{256,,dict}, @ref{11fc,,collections.defaultdict}, @ref{5db,,collections.OrderedDict} e @ref{10d0,,collections.Counter}.
@anchor{glossary term-meta-path-finder}@anchor{10a9}
@geindex localizador de metacaminho

@item localizador de metacaminho

Um @ref{20ae,,localizador} retornado por uma busca de @ref{d4d,,sys.meta_path}. Localizadores de metacaminho são relacionados a, mas diferentes de, @ref{10aa,,localizadores de entrada de caminho}.

Veja @ref{872,,importlib.abc.MetaPathFinder} para os métodos que localizadores de metacaminho implementam.
@anchor{glossary term-metaclass}@anchor{2112}
@geindex metaclasse

@item metaclasse

A classe de uma classe. Definições de classe criam um nome de classe, um dicionário de classe e uma lista de classes base. A metaclasse é responsável por receber estes três argumentos e criar a classe. A maioria das linguagens de programação orientadas a objetos provê uma implementação default. O que torna o Python especial é o fato de ser possível criar metaclasses personalizadas. A maioria dos usuários nunca vai precisar deste recurso, mas quando houver necessidade, metaclasses possibilitam soluções poderosas e elegantes. Metaclasses têm sido utilizadas para gerar registros de acesso a atributos, para incluir proteção contra acesso concorrente, rastrear a criação de objetos, implementar singletons, dentre muitas outras tarefas.

Mais informações podem ser encontradas em @ref{2100,,Metaclasses}.
@anchor{glossary term-method}@anchor{1638}
@geindex método

@item método

Uma função que é definida dentro do corpo de uma classe. Se chamada como um atributo de uma instância daquela classe, o método receberá a instância do objeto como seu primeiro @ref{449,,argumento} (que comumente é chamado de @code{self}). Veja @ref{21ea,,função} e @ref{20d0,,escopo aninhado}.
@anchor{glossary term-method-resolution-order}@anchor{2316}
@geindex ordem de resolução de métodos

@item ordem de resolução de métodos

Ordem de resolução de métodos é a ordem em que os membros de uma classe base são buscados durante a pesquisa. Veja @ref{14f2,,A Ordem de Resolução de Métodos do Python 2.3} para detalhes do algoritmo usado pelo interpretador do Python desde a versão 2.3.
@anchor{glossary term-module}@anchor{1755}
@geindex módulo

@item módulo

Um objeto que serve como uma unidade organizacional de código Python. Os módulos têm um espaço de nomes contendo objetos Python arbitrários. Os módulos são carregados pelo Python através do processo de @ref{2178,,importação}.

Veja também @ref{20aa,,pacote}.
@anchor{glossary term-module-spec}@anchor{20a6}
@geindex spec de módulo

@item spec de módulo

Um espaço de nomes que contém as informações relacionadas à importação usadas para carregar um módulo. Uma instância de @ref{1fee,,importlib.machinery.ModuleSpec}.

Veja também @ref{20a9,,Especificações de módulo}.
@anchor{glossary term-MRO}@anchor{15c0}
@geindex MRO

@item MRO

Veja @ref{2316,,ordem de resolução de métodos}.
@anchor{glossary term-mutable}@anchor{1d7e}
@geindex mutável

@item mutável

An @ref{55e1,,object} with state that is allowed to change during the course
of the program.  In multi-threaded programs, mutable objects that are
shared between threads require careful synchronization to avoid
@ref{55c7,,race conditions}.  See also @ref{1d79,,immutable},
@ref{55d4,,thread-safe}, and @ref{55ce,,concurrent modification}.
@anchor{glossary term-named-tuple}@anchor{64e}
@geindex tupla nomeada

@item tupla nomeada

O termo “tupla nomeada” é aplicado a qualquer tipo ou classe que herda de tupla e cujos elementos indexáveis também são acessíveis usando atributos nomeados. O tipo ou classe pode ter outras funcionalidades também.

Diversos tipos embutidos são tuplas nomeadas, incluindo os valores retornados por @ref{1541,,time.localtime()} e @ref{4a0,,os.stat()}. Outro exemplo é @ref{1b62,,sys.float_info}:

@example
>>> sys.float_info[1]                   # acesso indexado
1024
>>> sys.float_info.max_exp              # acesso a campo nomeado
1024
>>> isinstance(sys.float_info, tuple)   # tipo de tupla
True
@end example

Algumas tuplas nomeadas são tipos embutidos (tal como os exemplos acima). Alternativamente, uma tupla nomeada pode ser criada a partir de uma definição de classe regular, que herde de @ref{370,,tuple} e que defina campos nomeados. Tal classe pode ser escrita a mão, ou ela pode ser criada herdando @ref{2b0,,typing.NamedTuple} ou com uma função fábrica @ref{1ca,,collections.namedtuple()}. As duas últimas técnicas também adicionam alguns métodos extras, que podem não ser encontrados quando foi escrita manualmente, ou em tuplas nomeadas embutidas.
@anchor{glossary term-namespace}@anchor{1ddd}
@geindex espaço de nomes

@item espaço de nomes

O lugar em que uma variável é armazenada. Espaços de nomes são implementados como dicionários. Existem os espaços de nomes local, global e nativo, bem como espaços de nomes aninhados em objetos (em métodos). Espaços de nomes suportam modularidade ao prevenir conflitos de nomes. Por exemplo, as funções @code{__builtin__.open()} e @ref{dba,,os.open()} são diferenciadas por seus espaços de nomes. Espaços de nomes também auxiliam na legibilidade e na manutenibilidade ao torar mais claro quais módulos implementam uma função. Escrever @ref{12b5,,random.seed()} ou @code{itertools.izip()}, por exemplo, deixa claro que estas funções são implementadas pelos módulos @ref{b8,,random} e @ref{81,,itertools} respectivamente.
@anchor{glossary term-namespace-package}@anchor{1dee}
@geindex pacote de espaço de nomes

@item pacote de espaço de nomes

Um @ref{20aa,,pacote} que serve apenas como contêiner para subpacotes. Pacotes de espaços de nomes podem não ter representação física, e especificamente não são como um @ref{217c,,pacote regular} porque eles não tem um arquivo @code{__init__.py}.

Pacotes de espaço de nomes permitem que vários pacotes instaláveis individualmente tenham um pacote pai comum. Caso contrário, é recomendado usar um @ref{217c,,pacote regular}.

Para mais informações, veja 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} e @ref{217e,,Pacotes de espaço de nomes}.

Veja também @ref{1755,,módulo}.
@anchor{glossary term-native-code}@anchor{55d3}
@geindex código nativo

@item código nativo

Code that is compiled to machine instructions and runs directly on the
processor, as opposed to code that is interpreted or runs in a virtual
machine.  In the context of Python, native code typically refers to
C, C++, Rust or Fortran code in @ref{47eb,,extension modules}
that can be called from Python.  See also @ref{47eb,,extension module}.
@anchor{glossary term-nested-scope}@anchor{20d0}
@geindex escopo aninhado

@item escopo aninhado

A habilidade de referir-se a uma variável em uma definição de fechamento. Por exemplo, uma função definida dentro de outra pode referenciar variáveis da função externa. Perceba que escopos aninhados por padrão funcionam apenas por referência e não por atribuição. Variáveis locais podem ler e escrever no escopo mais interno. De forma similar, variáveis globais podem ler e escrever para o espaço de nomes global. O @ref{12ea,,nonlocal} permite escrita para escopos externos.
@anchor{glossary term-new-style-class}@anchor{2a42}
@geindex classe estilo novo

@item classe estilo novo

Antigo nome para o tipo de classes agora usado para todos os objetos de classes. Em versões anteriores do Python, apenas classes estilo novo podiam usar recursos novos e versáteis do Python, tais como @ref{1533,,__slots__}, descritores, propriedades, @ref{beb,,__getattribute__()}, métodos de classe e métodos estáticos.
@anchor{glossary term-non-deterministic}@anchor{55d0}
@geindex não determinístico

@item não determinístico

Behavior where the outcome of a program can vary between executions with
the same inputs.  In multi-threaded programs, non-deterministic behavior
often results from @ref{55c7,,race conditions} where the
relative timing or interleaving of threads affects the result.
Proper synchronization using @ref{55d1,,locks} and other
@ref{55d2,,synchronization primitives} helps
ensure deterministic behavior.
@anchor{glossary term-object}@anchor{55e1}
@geindex objeto

@item objeto

Qualquer dado que tenha estado (atributos ou valores) e comportamento definidos (métodos). Também a última classe base de qualquer @ref{2a42,,classe estilo novo}.
@anchor{glossary term-optimized-scope}@anchor{17e}
@geindex escopo otimizado

@item escopo otimizado

Um escopo no qual os nomes das variáveis locais de destino são conhecidos de forma confiável pelo compilador quando o código é compilado, permitindo a otimização do acesso de leitura e gravação a esses nomes. Os espaços de nomes locais para funções, geradores, corrotinas, compreensões e expressões geradoras são otimizados desta forma. Nota: a maioria das otimizações de interpretador são aplicadas a todos os escopos, apenas aquelas que dependem de um conjunto conhecido de nomes de variáveis locais e não locais são restritas a escopos otimizados.
@anchor{glossary term-package}@anchor{20aa}
@geindex pacote

@item pacote

Um @ref{1755,,módulo} Python é capaz de conter submódulos ou recursivamente, subpacotes. Tecnicamente, um pacote é um módulo Python com um atributo @code{__path__}.

Veja também @ref{217c,,pacote regular} e @ref{1dee,,pacote de espaço de nomes}.
@anchor{glossary term-parallelism}@anchor{55cd}
@geindex paralelismo

@item paralelismo

Executing multiple operations at the same time (e.g. on multiple CPU
cores).  In Python builds with the
@ref{148,,global interpreter lock (GIL)}, only one
thread runs Python bytecode at a time, so taking advantage of multiple
CPU cores typically involves multiple processes
(e.g. @ref{94,,multiprocessing}) or native extensions that release the GIL.
In @ref{15e4,,free-threaded} Python, multiple Python threads
can run Python code simultaneously on different cores.
@anchor{glossary term-parameter}@anchor{208f}
@geindex parâmetro

@item parâmetro

Uma entidade nomeada na definição de uma @ref{21ea,,função} (ou método) que específica um @ref{449,,argumento} (ou em alguns casos, argumentos) que a função pode receber. Existem cinco tipos de parâmetros:


@itemize *

@item 
`posicional-ou-nomeado': especifica um argumento que pode ser tanto @ref{449,,posicional} quanto @ref{449,,nomeado}. Esse é o tipo padrão de parâmetro, por exemplo `foo' e `bar' a seguir:

@example
def func(foo, bar=None): ...
@end example
@end itemize
@anchor{glossary positional-only-parameter}@anchor{a8f}

@itemize *

@item 
`somente-posicional': especifica um argumento que pode ser fornecido apenas por posição. Parâmetros somente-posicionais podem ser definidos incluindo o caractere @code{/} na lista de parâmetros da definição da função após eles, por exemplo `somentepos1' e `somentepos2' a seguir:

@example
def func(somentepos1, somentepos2, /, posicional_ou_nomeado): ...
@end example
@end itemize
@anchor{glossary keyword-only-parameter}@anchor{2a5}

@itemize *

@item 
`somente-nomeado': especifica um argumento que pode ser passado para a função somente por nome. Parâmetros somente-nomeados podem ser definidos com um simples parâmetro var-posicional ou um @code{*} antes deles na lista de parâmetros na definição da função, por exemplo `somente_nom1' and `somente_nom2' a seguir:

@example
def func(arg, *, somente_nom1, somente_nom2): ...
@end example

@item 
`var-posicional': especifica que uma sequência arbitrária de argumentos posicionais pode ser fornecida (em adição a qualquer argumento posicional já aceito por outros parâmetros). Tal parâmetro pode ser definido colocando um @code{*} antes do nome do parâmetro, por exemplo `args' a seguir:

@example
def func(*args, **kwargs): ...
@end example

@item 
`var-nomeado': especifica que, arbitrariamente, muitos argumentos nomeados podem ser fornecidos (em adição a qualquer argumento nomeado já aceito por outros parâmetros). Tal parâmetro pode ser definido colocando-se @code{**} antes do nome, por exemplo, `kwargs' no exemplo acima.
@end itemize

Parâmetros podem especificar tanto argumentos opcionais quanto obrigatórios, assim como valores padrão para alguns argumentos opcionais.

Veja também o termo @ref{449,,argumento} no glossário, a pergunta do FAQ sobre @ref{54ff,,a diferença entre argumentos e parâmetros}, a classe @ref{1d0,,inspect.Parameter}, a seção @ref{1db6,,Definições de função} e a 
@geindex Propostas de Melhorias do Python; PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}.
@anchor{glossary term-path-entry}@anchor{2193}
@geindex entrada de caminho

@item entrada de caminho

Um local único no @ref{2185,,caminho de importação} que o @ref{2188,,localizador baseado no caminho} consulta para encontrar módulos a serem importados.
@anchor{glossary term-path-entry-finder}@anchor{10aa}
@geindex localizador de entrada de caminho

@item localizador de entrada de caminho

Um @ref{20ae,,localizador} retornado por um chamável em @ref{105a,,sys.path_hooks} (ou seja, um @ref{2195,,gancho de entrada de caminho}) que sabe como localizar os módulos @ref{2193,,entrada de caminho}.

Veja @ref{873,,importlib.abc.PathEntryFinder} para os métodos que localizadores de entrada de caminho implementam.
@anchor{glossary term-path-entry-hook}@anchor{2195}
@geindex gancho de entrada de caminho

@item gancho de entrada de caminho

Um chamável na lista @ref{105a,,sys.path_hooks} que retorna um @ref{10aa,,localizador de entrada de caminho} caso saiba como localizar módulos em uma @ref{2193,,entrada de caminho} específica.
@anchor{glossary term-path-based-finder}@anchor{2188}
@geindex localizador baseado no caminho

@item localizador baseado no caminho

Um dos @ref{10a9,,localizadores de metacaminho} padrão que procura por um @ref{2185,,caminho de importação} de módulos.
@anchor{glossary term-path-like-object}@anchor{2a0}
@geindex objeto caminho ou similar

@item objeto caminho ou similar

Um objeto representando um caminho de sistema de arquivos. Um objeto caminho ou similar é ou um objeto @ref{44c,,str} ou @ref{1c2,,bytes} representando um caminho, ou um objeto implementando o protocolo @ref{c6c,,os.PathLike}. Um objeto que suporta o protocolo @ref{c6c,,os.PathLike} pode ser convertido para um arquivo de caminho do sistema @ref{44c,,str} ou @ref{1c2,,bytes}, através da chamada da função @ref{c6e,,os.fspath()}; @ref{c6f,,os.fsdecode()} e @ref{c70,,os.fsencode()} podem ser usadas para garantir um @ref{44c,,str} ou @ref{1c2,,bytes} como resultado, respectivamente. Introduzido na 
@geindex Propostas de Melhorias do Python; PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}.
@anchor{glossary term-PEP}@anchor{55e2}
@geindex PEP

@item PEP

Proposta de melhoria do Python. Uma PEP é um documento de design que fornece informação para a comunidade Python, ou descreve uma nova funcionalidade para o Python ou seus predecessores ou ambientes. PEPs devem prover uma especificação técnica concisa e um racional para funcionalidades propostas.

PEPs têm a intenção de ser os mecanismos primários para propor novas funcionalidades significativas, para coletar opiniões da comunidade sobre um problema, e para documentar as decisões de design que foram adicionadas ao Python. O autor da PEP é responsável por construir um consenso dentro da comunidade e documentar opiniões dissidentes.

Veja 
@geindex Propostas de Melhorias do Python; PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/}.
@anchor{glossary term-portion}@anchor{217f}
@geindex porção

@item porção

Um conjunto de arquivos em um único diretório (possivelmente armazenado em um arquivo zip) que contribuem para um pacote de espaço de nomes, conforme definido em 
@geindex Propostas de Melhorias do Python; PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}.
@anchor{glossary term-positional-argument}@anchor{d35}
@geindex argumento posicional

@item argumento posicional

Veja @ref{449,,argumento}.
@anchor{glossary term-provisional-API}@anchor{b16}
@geindex API provisória

@item API provisória

Uma API provisória é uma API que foi deliberadamente excluída das bibliotecas padrões com compatibilidade retroativa garantida. Enquanto mudanças maiores para tais interfaces não são esperadas, contanto que elas sejam marcadas como provisórias, mudanças retroativas incompatíveis (até e incluindo a remoção da interface) podem ocorrer se consideradas necessárias pelos desenvolvedores principais. Tais mudanças não serão feitas gratuitamente – elas irão ocorrer apenas se sérias falhas fundamentais forem descobertas, que foram esquecidas anteriormente a inclusão da API.

Mesmo para APIs provisórias, mudanças retroativas incompatíveis são vistas como uma “solução em último caso” - cada tentativa ainda será feita para encontrar uma resolução retroativa compatível para quaisquer problemas encontrados.

Esse processo permite que a biblioteca padrão continue a evoluir com o passar do tempo, sem se prender em erros de design problemáticos por períodos de tempo prolongados. Veja 
@geindex Propostas de Melhorias do Python; PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/} para mais detalhes.
@anchor{glossary term-provisional-package}@anchor{107a}
@geindex pacote provisório

@item pacote provisório

Veja @ref{b16,,API provisória}.
@anchor{glossary term-Python-3000}@anchor{55e3}
@geindex Python 3000

@item Python 3000

Apelido para a linha de lançamento da versão do Python 3.x (cunhada há muito tempo, quando o lançamento da versão 3 era algo em um futuro muito distante.) Esse termo possui a seguinte abreviação: “Py3k”.
@anchor{glossary term-Pythonic}@anchor{55e4}
@geindex Pythônico

@item Pythônico

Uma ideia ou um pedaço de código que segue de perto as formas de escritas mais comuns da linguagem Python, ao invés de implementar códigos usando conceitos comuns a outras linguagens. Por exemplo, um formato comum em Python é fazer um laço sobre todos os elementos de uma iterável usando a instrução @ref{2f2,,for}. Muitas outras linguagens não têm esse tipo de construção, então as pessoas que não estão familiarizadas com o Python usam um contador numérico:

@example
for i in range(len(comida)):
    print(comida[i])
@end example

Ao contrário do método mais limpo, Pythônico:

@example
for parte in comida:
    print(parte)
@end example
@anchor{glossary term-qualified-name}@anchor{1ab1}
@geindex nome qualificado

@item nome qualificado

Um nome pontilhado (quando 2 termos são ligados por um ponto) que mostra o “path” do escopo global de um módulo para uma classe, função ou método definido num determinado módulo, conforme definido pela 
@geindex Propostas de Melhorias do Python; PEP 3155
PEP 3155@footnote{https://peps.python.org/pep-3155/}. Para funções e classes de nível superior, o nome qualificado é o mesmo que o nome do objeto:

@example
>>> class C:
...     class D:
...         def metodo(self):
...             pass
...
>>> C.__qualname__
'C'
>>> C.D.__qualname__
'C.D'
>>> C.D.metodo.__qualname__
'C.D.metodo'
@end example

Quando usado para se referir a módulos, o `nome totalmente qualificado' significa todo o caminho pontilhado para o módulo, incluindo quaisquer pacotes pai, por exemplo: @code{email.mime.text}:

@example
>>> import email.mime.text
>>> email.mime.text.__name__
'email.mime.text'
@end example
@anchor{glossary term-race-condition}@anchor{55c7}
@geindex condição de corrida

@item condição de corrida

A condition of a program where the its behavior
depends on the relative timing or ordering of events, particularly in
multi-threaded programs.  Race conditions can lead to
@ref{55d0,,non-deterministic} behavior and bugs that are difficult to
reproduce.  A @ref{55c8,,data race} is a specific type of race condition
involving unsynchronized access to shared memory.  The @ref{55d9,,LBYL}
coding style is particularly susceptible to race conditions in
multi-threaded code.  Using @ref{55d1,,locks} and other
@ref{55d2,,synchronization primitives}
helps prevent race conditions.
@anchor{glossary term-reference-count}@anchor{4b73}
@geindex contagem de referências

@item contagem de referências

O número de referências a um objeto. Quando a contagem de referências de um objeto cai para zero, ele é desalocado. Alguns objetos são @ref{45bb,,imortais} e têm contagens de referências que nunca são modificadas e, portanto, os objetos nunca são desalocados. A contagem de referências geralmente não é visível para o código Python, mas é um elemento-chave da implementação do @ref{6f6,,CPython}. Os programadores podem chamar a função @ref{45ba,,sys.getrefcount()} para retornar a contagem de referências para um objeto específico.

Em @ref{6f6,,CPython}, as contagens de referências não são consideradas valores estáveis ou bem definidos; o número de referências a um objeto e como esse número é afetado pelo código Python pode ser diferente entre as versões.
@anchor{glossary term-regular-package}@anchor{217c}
@geindex pacote regular

@item pacote regular

Um @ref{20aa,,pacote} tradicional, como um diretório contendo um arquivo @code{__init__.py}.

Veja também @ref{1dee,,pacote de espaço de nomes}.
@anchor{glossary term-reentrant}@anchor{55d6}
@geindex reentrant

@item reentrant

A property of a function or @ref{55d1,,lock} that allows it to be called or
acquired multiple times by the same thread without causing errors or a
@ref{55d5,,deadlock}.

For functions, reentrancy means the function can be safely called again
before a previous invocation has completed, which is important when
functions may be called recursively or from signal handlers. Thread-unsafe
functions may be @ref{55d0,,non-deterministic} if they’re called reentrantly in a
multithreaded program.

For locks, Python’s @ref{2de,,threading.RLock} (reentrant lock) is
reentrant, meaning a thread that already holds the lock can acquire it
again without blocking.  In contrast, @ref{176d,,threading.Lock} is not
reentrant - attempting to acquire it twice from the same thread will cause
a deadlock.

See also @ref{55d1,,lock} and @ref{55d5,,deadlock}.
@anchor{glossary term-REPL}@anchor{16a}
@geindex REPL

@item REPL

Um acrônimo para “read–eval–print loop”, outro nome para o console @ref{169,,interativo} do interpretador.
@anchor{glossary term-__slots__}@anchor{5df}
@geindex __slots__

@item __slots__

Uma declaração dentro de uma classe que economiza memória pré-declarando espaço para atributos de instâncias, e eliminando dicionários de instâncias. Apesar de popular, a técnica é um tanto quanto complicada de acertar, e é melhor se for reservada para casos raros, onde existe uma grande quantidade de instâncias em uma aplicação onde a memória é crítica.
@anchor{glossary term-sequence}@anchor{4f1}
@geindex sequência

@item sequência

Um @ref{1268,,iterável} com suporte para acesso eficiente a seus elementos através de índices inteiros via método especial @ref{283,,__getitem__()} e que define o método @ref{15b4,,__len__()} que devolve o tamanho da sequência. Alguns tipos de sequência embutidos são: @ref{611,,list}, @ref{44c,,str}, @ref{370,,tuple}, e @ref{1c2,,bytes}. Note que @ref{256,,dict} também tem suporte para @ref{283,,__getitem__()} e @code{__len__()}, mas é considerado um mapeamento e não uma sequência porque a busca usa uma chave @ref{610,,hasheável} arbitrária em vez de inteiros.

A classe base abstrata @ref{1204,,collections.abc.Sequence} define uma interface mais rica que vai além de apenas @ref{283,,__getitem__()} e @ref{15b4,,__len__()}, adicionando @ref{211a,,count()}, @ref{211c,,index()}, @ref{1400,,__contains__()}, e @ref{ca7,,__reversed__()}. Tipos que implementam essa interface podem ser explicitamente registrados usando @ref{10c7,,register()}. Para mais documentação sobre métodos de sequências em geral, veja @ref{233e,,Operações comuns de sequências}.
@anchor{glossary term-set-comprehension}@anchor{55e5}
@geindex compreensão de conjunto

@item compreensão de conjunto

Uma maneira compacta de processar todos ou parte dos elementos em iterável e retornar um conjunto com os resultados. @code{results = @{c for c in 'abracadabra' if c not in 'abc'@}} gera um conjunto de strings @code{@{'r', 'd'@}}.  Veja @ref{5d0,,Sintaxe de criação de listas@comma{} conjuntos e dicionários}.
@anchor{glossary term-single-dispatch}@anchor{9fa}
@geindex despacho único

@item despacho único

Uma forma de despacho de @ref{9f9,,função genérica} onde a implementação é escolhida com base no tipo de um único argumento.
@anchor{glossary term-slice}@anchor{2313}
@geindex fatia

@item fatia

Um objeto geralmente contendo uma parte de uma @ref{4f1,,sequência}. Uma fatia é criada usando a notação de subscrito @code{[]} pode conter também até dois pontos entre números, como em @code{variable_name[1:3:5]}. A notação de suporte (subscrito) utiliza objetos @ref{469,,slice} internamente.
@anchor{glossary term-soft-deprecated}@anchor{209}
@geindex suavemente descontinuado

@item suavemente descontinuado

Uma API suavemente descontinuada não deve ser usada em código novo, mas é seguro para código já existente usá-la. A API continua documentada e testada, mas não será melhorada.

A descontinuação suave, diferentemente da descontinuação normal, não planeja remover a API e não emitirá avisos.

Veja PEP 387: Descontinuação suave@footnote{https://peps.python.org/pep-0387/#soft-deprecation}.
@anchor{glossary term-special-method}@anchor{19eb}
@geindex método especial

@item método especial

@geindex especial;método

Um método que é chamado implicitamente pelo Python para executar uma certa operação em um tipo, como uma adição por exemplo. Tais métodos tem nomes iniciando e terminando com dois underscores. Métodos especiais estão documentados em @ref{c89,,Nomes de métodos especiais}.
@anchor{glossary term-standard-library}@anchor{55e6}
@geindex biblioteca padrão

@item biblioteca padrão

A coleção de @ref{20aa,,pacotes}, @ref{1755,,módulos} e @ref{47eb,,módulos de extensão} distribuída como parte do pacote do interpretador Python oficial. A relação exata de elementos da coleção pode variar de acordo com a plataforma, bibliotecas de sistema disponíveis ou outros critérios. A documentação pode ser encontrada em @ref{144,,A Biblioteca Padrão do Python}.

Veja também @ref{844,,sys.stdlib_module_names} para obter uma lista de todos os possíveis nomes de módulos da biblioteca padrão.
@anchor{glossary term-statement}@anchor{2935}
@geindex instrução

@item instrução

Uma instrução é parte de uma suíte (um “bloco” de código). Uma instrução é ou uma @ref{2111,,expressão} ou uma de várias construções com uma palavra reservada, tal como @ref{2f3,,if}, @ref{1d82,,while} ou @ref{2f2,,for}.
@anchor{glossary term-static-type-checker}@anchor{26d}
@geindex verificador de tipo estático

@item verificador de tipo estático

Uma ferramenta externa que lê código Python e o analisa, procurando por problemas como tipos incorretos. Consulte também @ref{210d,,dicas de tipo} e o módulo @ref{104,,typing}.
@anchor{glossary term-stdlib}@anchor{15ae}
@geindex stdlib

@item stdlib

Uma abreviação para o termo @ref{55e6,,biblioteca padrão} em inglês (standard library).
@anchor{glossary term-strong-reference}@anchor{33d}
@geindex referência forte

@item referência forte

Na API C do Python, uma referência forte é uma referência a um objeto que pertence ao código que contém a referência. A referência forte é obtida chamando @ref{56e,,Py_INCREF()} quando a referência é criada e liberada com @ref{56f,,Py_DECREF()} quando a referência é excluída.

A função @ref{89e,,Py_NewRef()} pode ser usada para criar uma referência forte para um objeto. Normalmente, a função @ref{56f,,Py_DECREF()} deve ser chamada na referência forte antes de sair do escopo da referência forte, para evitar o vazamento de uma referência.

Veja também @ref{33e,,referência emprestada}.
@anchor{glossary term-synchronization-primitive}@anchor{55d2}
@geindex synchronization primitive

@item synchronization primitive

A basic building block for coordinating (synchronizing) the execution of
multiple threads to ensure @ref{55d4,,thread-safe} access to shared resources.
Python’s @ref{ed,,threading} module provides several synchronization primitives
including @ref{176d,,Lock}, @ref{2de,,RLock},
@ref{1195,,Semaphore}, @ref{1194,,Condition},
@ref{1197,,Event}, and @ref{1223,,Barrier}.  Additionally,
the @ref{b6,,queue} module provides multi-producer, multi-consumer queues
that are especially useful in multithreaded programs. These
primitives help prevent @ref{55c7,,race conditions} and
coordinate thread execution.  See also @ref{55d1,,lock}.
@anchor{glossary term-text-encoding}@anchor{2310}
@geindex codificador de texto

@item codificador de texto

Uma string em Python é uma sequência de pontos de código Unicode (no intervalo @code{U+0000}–@code{U+10FFFF}). Para armazenar ou transferir uma string, ela precisa ser serializada como uma sequência de bytes.

A serialização de uma string em uma sequência de bytes é conhecida como “codificação” e a recriação da string a partir de uma sequência de bytes é conhecida como “decodificação”.

Há uma variedade de diferentes serializações de texto @ref{de1,,codecs}, que são coletivamente chamadas de “codificações de texto”.
@anchor{glossary term-text-file}@anchor{1e0d}
@geindex arquivo texto

@item arquivo texto

Um  @ref{1203,,objeto arquivo} apto a ler e escrever objetos @ref{44c,,str}. Geralmente, um arquivo texto, na verdade, acessa um fluxo de dados de bytes e captura o @ref{2310,,codificador de texto} automaticamente. Exemplos de arquivos texto são: arquivos abertos em modo texto (@code{'r'} or @code{'w'}), @ref{53d,,sys.stdin}, @ref{ae6,,sys.stdout}, e instâncias de @ref{f59,,io.StringIO}.

Veja também @ref{1e0e,,arquivo binário} para um objeto arquivo apto a ler e escrever @ref{d4f,,objetos bytes ou similares}.
@anchor{glossary term-thread-safe}@anchor{55d4}
@geindex seguro para thread

@item seguro para thread

A module, function, or class that behaves correctly when used by multiple
threads concurrently.  Thread-safe code uses appropriate
@ref{55d2,,synchronization primitives} like
@ref{55d1,,locks} to protect shared mutable state, or is designed
to avoid shared mutable state entirely.  In the
@ref{15e4,,free-threaded} build, built-in types like
@ref{256,,dict}, @ref{611,,list}, and @ref{5d9,,set} use internal locking
to make many operations thread-safe, although thread safety is not
necessarily guaranteed.  Code that is not thread-safe may experience
@ref{55c7,,race conditions} and @ref{55c8,,data races}
when used in multi-threaded programs.
@anchor{glossary term-token}@anchor{200a}
@geindex token

@item token

Uma pequena unidade de código-fonte, gerada pelo @ref{2007,,analisador léxico} (também chamado de `tokenizador'). Nomes, números, strings, operadores, quebras de linha e similares são representados por tokens.

O módulo @ref{fb,,tokenize} expõe o analisador léxico do Python. O módulo @ref{fa,,token} contém informações sobre os vários tipos de tokens.
@anchor{glossary term-triple-quoted-string}@anchor{55e7}
@geindex aspas triplas

@item aspas triplas

Uma string que está definida com três ocorrências de aspas duplas (”) ou apóstrofos (‘). Enquanto elas não fornecem nenhuma funcionalidade não disponível com strings de aspas simples, elas são úteis para inúmeras razões. Elas permitem que você inclua aspas simples e duplas não escapadas dentro de uma string, e elas podem utilizar múltiplas linhas sem o uso de caractere de continuação, fazendo-as especialmente úteis quando escrevemos documentação em docstrings.
@anchor{glossary term-type}@anchor{1a8b}
@geindex tipo

@item tipo

O tipo de um objeto Python determina qual classe de objeto ele é; cada objeto tem um tipo. Um tipo de objeto é acessível pelo atributo @ref{14f5,,__class__} ou pode ser recuperado com @code{type(obj)}.
@anchor{glossary term-type-alias}@anchor{43a}
@geindex apelido de tipo

@item apelido de tipo

Um sinônimo para um tipo, criado através da atribuição do tipo para um identificador.

Apelidos de tipo são úteis para simplificar @ref{210d,,dicas de tipo}. Por exemplo:

@example
def remove_tons_de_cinza(
        cores: list[tuple[int, int, int]]) -> list[tuple[int, int, int]]:
    pass
@end example

pode tornar-se mais legível desta forma:

@example
Cor = tuple[int, int, int]

def remove_tons_de_cinza(cores: list[Cor]) -> list[Cor]:
    pass
@end example

Veja @ref{104,,typing} e 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, a qual descreve esta funcionalidade.
@anchor{glossary term-type-hint}@anchor{210d}
@geindex dica de tipo

@item dica de tipo

Uma @ref{458,,anotação} que especifica o tipo esperado para uma variável, um atributo de classe, ou um parâmetro de função ou um valor de retorno.

Dicas de tipo são opcionais e não são forçadas pelo Python, mas elas são úteis para @ref{26d,,verificadores de tipo estático}. Eles também ajudam IDEs a completar e refatorar código.

Dicas de tipos de variáveis globais, atributos de classes, e funções, mas não de variáveis locais, podem ser acessadas usando @ref{6b1,,typing.get_type_hints()}.

Veja @ref{104,,typing} e 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, a qual descreve esta funcionalidade.
@anchor{glossary term-universal-newlines}@anchor{d5c}
@geindex novas linhas universais

@item novas linhas universais

Uma maneira de interpretar fluxos de textos, na qual todos estes são reconhecidos como caracteres de fim de linha: a convenção para fim de linha no Unix @code{'\n'}, a convenção no Windows @code{'\r\n'}, e a antiga convenção no Macintosh @code{'\r'}. Veja 
@geindex Propostas de Melhorias do Python; PEP 278
PEP 278@footnote{https://peps.python.org/pep-0278/} e 
@geindex Propostas de Melhorias do Python; PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/}, bem como @ref{23a7,,bytes.splitlines()} para uso adicional.
@anchor{glossary term-variable-annotation}@anchor{d79}
@geindex anotação de variável

@item anotação de variável

Uma @ref{458,,anotação} de uma variável ou um atributo de classe.

Ao fazer uma anotação de uma variável ou um atributo de classe, a atribuição é opcional:

@example
class C:
    campo: 'anotação'
@end example

Anotações de variáveis são normalmente usadas para @ref{210d,,dicas de tipo}: por exemplo, espera-se que esta variável receba valores do tipo @ref{257,,int}:

@example
contagem: int = 0
@end example

A sintaxe de anotação de variável é explicada na seção @ref{2241,,instruções de atribuição anotado}.

Veja @ref{1db7,,anotação de função}, 
@geindex Propostas de Melhorias do Python; PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} e 
@geindex Propostas de Melhorias do Python; PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}, que descrevem esta funcionalidade. Veja também @ref{7da,,Boas práticas para anotações} para as melhores práticas sobre como trabalhar com anotações.
@anchor{glossary term-virtual-environment}@anchor{1e86}
@geindex ambiente virtual

@item ambiente virtual

Um ambiente de execução isolado que permite usuários Python e aplicações instalarem e atualizarem pacotes Python sem interferir no comportamento de outras aplicações Python em execução no mesmo sistema.

Veja também @ref{111,,venv}.
@anchor{glossary term-virtual-machine}@anchor{370d}
@geindex máquina virtual

@item máquina virtual

Um computador definido inteiramente em software. A máquina virtual de Python executa o @ref{187,,bytecode} emitido pelo compilador de bytecode.
@anchor{glossary term-walrus-operator}@anchor{55e8}
@geindex operador morsa

@item operador morsa

Uma maneira bem-humorada de se referir ao operador da @ref{2212,,expressão de atribuição} @code{:=} porque ele se parece um pouco com uma morsa se você virar a cabeça.
@anchor{glossary term-Zen-of-Python}@anchor{55e9}
@geindex Zen do Python

@item Zen do Python

Lista de princípios de projeto e filosofias do Python que são úteis para a compreensão e uso da linguagem. A lista é exibida quando se digita “@code{import this}” no console interativo.
@end table

@node Sobre esta documentação,Lidando com bugs,Glossário,Top
@anchor{about doc}@anchor{55ea}@anchor{about about-this-documentation}@anchor{55eb}@anchor{about translation-repo}@anchor{55ec}
@chapter Sobre esta documentação


A documentação do Python é gerada a partir de fontes reStructuredText@footnote{https://docutils.sourceforge.io/rst.html} usando Sphinx@footnote{https://www.sphinx-doc.org/}, um gerador de documentação criado originalmente para Python e agora mantido como um projeto independente.

@c In the online version of these documents, you can submit comments and suggest
@c changes directly on the documentation pages.

O desenvolvimento da documentação e de suas ferramentas é um esforço totalmente voluntário, como Python em si. Se você quer contribuir, por favor dê uma olhada na página @ref{4bc3,,Lidando com bugs} para informações sobre como fazer. Novos voluntários são sempre bem-vindos!

Agradecimentos especiais para:


@itemize *

@item 
Fred L. Drake, Jr., o criador do primeiro conjunto de ferramentas para documentar Python e autor de boa parte do conteúdo;

@item 
O projeto Docutils@footnote{https://docutils.sourceforge.io/} por criar reStructuredText e o pacote Docutils;

@item 
Fredrik Lundh, pelo seu projeto de referência alternativa em Python, do qual Sphinx pegou muitas boas ideias.
@end itemize

@menu
* Contribuidores da documentação do Python:: 

@end menu

@node Contribuidores da documentação do Python,,,Sobre esta documentação
@anchor{about contributors-to-the-python-documentation}@anchor{55ed}
@section Contribuidores da documentação do Python


Muitas pessoas têm contribuído para a linguagem Python, sua biblioteca padrão e sua documentação. Veja Misc/ACKS@footnote{https://github.com/python/cpython/tree/3.13/Misc/ACKS} na distribuição do código do Python para ver uma lista parcial de contribuidores.

Tudo isso só foi possível com o esforço e a contribuição da comunidade Python, por isso temos essa maravilhosa documentação – Obrigado a todos!

@node Lidando com bugs,Direitos autorais,Sobre esta documentação,Top
@anchor{bugs doc}@anchor{55ee}@anchor{bugs dealing-with-bugs}@anchor{55ef}@anchor{bugs reporting-bugs}@anchor{4bc3}@anchor{bugs translation-repo}@anchor{55f0}
@chapter Lidando com bugs


O Python é uma linguagem de programação madura que estabeleceu uma reputação pela estabilidade. A fim de manter esta reputação os desenvolvedores gostariam de saber de quaisquer deficiências que você encontre no Python.

Às vezes, pode ser mais rápido consertar os bugs você mesmo e contribuir com patches para o Python uma vez que isso agiliza o processo e envolve menos pessoas. Veja aqui como @ref{55f1,,contribuir}.

@menu
* Bugs na documentação:: 
* Usando o rastreador de problemas do Python:: 
* Começando a contribuir com o Python por conta própria:: 

@end menu

@node Bugs na documentação,Usando o rastreador de problemas do Python,,Lidando com bugs
@anchor{bugs documentation-bugs}@anchor{55f2}
@section Bugs na documentação


Se você achar um bug nesta documentação ou gostaria de propor uma melhoria, por favor submeta um relatório no @ref{24e,,rastreador de problemas}. Se você tiver uma sugestão sobre como consertá-lo inclua isso também.

Se o bug ou a melhoria sugerida estiver relacionado à tradução desta documentação, envie o relatório para o repositório de tradução@footnote{https://github.com/python/python-docs-pt-br}.

Você também pode abrir um item de discussão em nosso fórum Discourse de documentação@footnote{https://discuss.python.org/c/documentation/26}.

Se você encontrar um bug no tema (HTML/CSS/JavaScript) da documentação, envie um relatório de bug no rastreador de problemas do python-doc-theme@footnote{https://github.com/python/python-docs-theme}.


@subsubheading Ver também



@table @asis

@item @ref{55f2,,Bugs na documentação}

Uma lista de bugs na documentação que foram submetidos no rastreador de problemas do Python.

@item Rastreando problemas@footnote{https://devguide.python.org/tracker/}

Visão geral do processo envolvido em reportar uma melhoria no rastreador.

@item Ajudando com a documentação@footnote{https://devguide.python.org/docquality/#helping-with-documentation}

Guia compreensivo para os indivíduos que estão interessados em contribuir com a documentação do Python.

@item Traduções da documentação@footnote{https://devguide.python.org/documentation/translating/}

Uma lista de páginas no GitHub relacionadas à tradução da documentação e respectivos contatos iniciais.
@end table


@node Usando o rastreador de problemas do Python,Começando a contribuir com o Python por conta própria,Bugs na documentação,Lidando com bugs
@anchor{bugs using-the-python-issue-tracker}@anchor{55f3}@anchor{bugs using-the-tracker}@anchor{24e}
@section Usando o rastreador de problemas do Python


Relatórios de problemas do Python em si devem ser submetidos ao rastreador de problemas do GitHub (@indicateurl{https://github.com/python/cpython/issues}). O rastreador de problemas do GitHub oferece um formulário web que permite informações pertinentes serem enviadas para os desenvolvedores.

O primeiro passo para preencher um relatório é determinar se o problema já foi reportado. A vantagem em fazê-lo além de poupar o tempo dos desenvolvedores é que você aprende o que foi feito para consertá-lo; pode ser que o problema já foi consertado para o próximo lançamento, ou que informação adicional seja necessária (nesse caso, você é bem-vindo para fornecê-la se você puder!). Para fazer isso, procure no rastreador usando a caixa de busca no topo da página.

Se o problema que você está relatando ainda não estiver na lista, faça login no GitHub. Se você ainda não tiver uma conta do GitHub, crie uma nova conta usando o link “Sign Up”. Não é possível enviar um relatório de bug anonimamente.

Estando agora autenticado, você pode submeter um relatório de problema. Clique no botão “New issue” na barra superior para relatar um novo problema.

O formulário de submissão tem dois campos, “Title” e “Comment”.

Para o campo “Title”, insira uma descrição `muito' curta do problema; menos de dez palavras é bom.

No campo “Comment”, descreva o problema com detalhes, incluindo o que você esperava que acontecesse e o que aconteceu. Certifique-se de incluir se quaisquer módulos de extensão estavam envolvidos, e qual hardware e plataforma de software você está usando (incluindo informações sobre a versão quando apropriado).

Cada relatório de problema será revisado por um desenvolvedor que irá determinar o que é necessário para solucionar o problema. Você receberá atualizações para cada ação tomada para o problema.


@subsubheading Ver também



@table @asis

@item Como relatar bugs eficientemente@footnote{https://www.chiark.greenend.org.uk/~sgtatham/bugs.html}

Artigo que entra em algum detalhe sobre como criar um relatório de bug útil. Isto descreve qual tipo de informação é útil e por quê é útil.

@item Diretrizes para relatar bugs@footnote{https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html}

Informação sobre como escrever um bom relatório de bug. Um pouco disto é específico do Projeto Mozilla, mas descreve boas práticas em geral.
@end table


@node Começando a contribuir com o Python por conta própria,,Usando o rastreador de problemas do Python,Lidando com bugs
@anchor{bugs contributing-to-python}@anchor{55f1}@anchor{bugs getting-started-contributing-to-python-yourself}@anchor{55f4}
@section Começando a contribuir com o Python por conta própria


Além de apenas reportar os bugs que você encontrar, você também é bem-vindo para submeter patches para consertá-los. Você pode achar mais informações sobre como começar a contribuir com patches para o Python no Python Developer's Guide@footnote{https://devguide.python.org/}. Se você tem mais perguntas, a lista de discussão core-mentorship@footnote{https://mail.python.org/mailman3/lists/core-mentorship.python.org/} é um lugar amigável para obter respostas para qualquer questão relativa ao processo de resolução de problemas no Python.

@node Direitos autorais,História e Licença,Lidando com bugs,Top
@anchor{copyright doc}@anchor{55f5}@anchor{copyright copyright}@anchor{55f6}@anchor{copyright translation-repo}@anchor{55f7}
@chapter Direitos autorais


Python e essa documentação é:

Copyright © 2001-2024 Python Software Foundation. Todos os direitos reservados.

Copyright © 2000 BeOpen.com. Todos os direitos reservados.

Copyright © 1995-2000 Corporation for National Research Initiatives. Todos os direitos reservados.

Copyright © 1991-1995 Stichting Mathematisch Centrum. Todos os direitos reservados.


__________________________________________________________________


Veja: @ref{55f8,,História e Licença} para informações completas de licença e permissões.

@node História e Licença,Índice de Módulos Python,Direitos autorais,Top
@anchor{license doc}@anchor{55f9}@anchor{license history-and-license}@anchor{55f8}@anchor{license id1}@anchor{55fa}@anchor{license translation-repo}@anchor{55fb}
@chapter História e Licença


@menu
* História do software:: 
* Termos e condições para acessar ou usar Python:: 
* Licenças e Reconhecimentos para Software Incorporado:: 

@end menu

@node História do software,Termos e condições para acessar ou usar Python,,História e Licença
@anchor{license history-of-the-software}@anchor{55fc}
@section História do software


Python foi criado no início dos anos 1990 por Guido van Rossum no Stichting Mathematisch Centrum (CWI, veja @indicateurl{https://www.cwi.nl}) na Holanda como sucessor de uma linguagem chamada ABC. Guido continua sendo o principal autor do Python, embora inclua muitas contribuições de outros.

Em 1995, Guido continuou seu trabalho em Python na Corporation for National Research Initiatives (CNRI, veja @indicateurl{https://www.cnri.reston.va.us}) em Reston, Virgínia, onde lançou várias versões do software.

Em maio de 2000, Guido e a equipe de desenvolvimento do núcleo Python mudaram-se para BeOpen.com para formar a equipe BeOpen PythonLabs. Em outubro do mesmo ano, a equipe PythonLabs mudou-se para a Digital Creations, que se tornou Zope Corporation. Em 2001, a Python Software Foundation (PSF, veja @indicateurl{https://www.python.org/psf/}) foi formada, uma organização sem fins lucrativos criada especificamente para possuir Propriedade Intelectual relacionada ao Python. A Zope Corporation era um membro patrocinador da PSF.

Todas as versões do Python são de código aberto (consulte @indicateurl{https://opensource.org} para a definição de código aberto). Historicamente, a maioria, mas não todas, versões do Python também são compatíveis com GPL; a tabela abaixo resume os vários lançamentos.


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Versão

@tab

Derivada de

@tab

Ano

@tab

Proprietário

@tab

Compatível com a GPL? (1)

@item

0.9.0 a 1.2

@tab

n/a

@tab

1991-1995

@tab

CWI

@tab

sim

@item

1.3 a 1.5.2

@tab

1.2

@tab

1995-1999

@tab

CNRI

@tab

sim

@item

1.6

@tab

1.5.2

@tab

2000

@tab

CNRI

@tab

não

@item

2.0

@tab

1.6

@tab

2000

@tab

BeOpen.com

@tab

não

@item

1.6.1

@tab

1.6

@tab

2001

@tab

CNRI

@tab

sim (2)

@item

2.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

não

@item

2.0.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

sim

@item

2.1.1

@tab

2.1+2.0.1

@tab

2001

@tab

PSF

@tab

sim

@item

2.1.2

@tab

2.1.1

@tab

2002

@tab

PSF

@tab

sim

@item

2.1.3

@tab

2.1.2

@tab

2002

@tab

PSF

@tab

sim

@item

2.2 e acima

@tab

2.1.1

@tab

2001-agora

@tab

PSF

@tab

sim

@end multitable


@cartouche
@quotation Nota 

@enumerate 

@item 
Compatível com a GPL não significa que estamos distribuindo Python sob a GPL. Todas as licenças do Python, ao contrário da GPL, permitem distribuir uma versão modificada sem fazer alterações em código aberto. As licenças compatíveis com a GPL possibilitam combinar o Python com outro software lançado sob a GPL; os outros não.

@item 
De acordo com Richard Stallman, 1.6.1 não é compatível com GPL, porque sua licença tem uma cláusula de escolha de lei. De acordo com a CNRI, no entanto, o advogado de Stallman disse ao advogado da CNRI que 1.6.1 “não é incompatível” com a GPL.
@end enumerate
@end quotation
@end cartouche

Graças aos muitos voluntários externos que trabalharam sob a direção de Guido para tornar esses lançamentos possíveis.

@node Termos e condições para acessar ou usar Python,Licenças e Reconhecimentos para Software Incorporado,História do software,História e Licença
@anchor{license terms-and-conditions-for-accessing-or-otherwise-using-python}@anchor{55fd}
@section Termos e condições para acessar ou usar Python


O software e a documentação do Python são licenciados sob a Python Software Foundation License Versão 2.

A partir do Python 3.8.6, exemplos, receitas e outros códigos na documentação são licenciados duplamente sob o Licença PSF versão 2 e a @ref{55fe,,Licença BSD de Zero Cláusula}.

Alguns softwares incorporados ao Python estão sob licenças diferentes. As licenças são listadas com o código abrangido por essa licença. Veja @ref{55ff,,Licenças e Reconhecimentos para Software Incorporado} para uma lista incompleta dessas licenças.

@menu
* PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2:: 
* ACORDO DE LICENCIAMENTO DA BEOPEN.COM PARA PYTHON 2.0: ACORDO DE LICENCIAMENTO DA BEOPEN COM PARA PYTHON 2 0. 
* CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1.6.1: CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1 6 1. 
* ACORDO DE LICENÇA DA CWI PARA PYTHON 0.9.0 A 1.2: ACORDO DE LICENÇA DA CWI PARA PYTHON 0 9 0 A 1 2. 
* ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION:: 

@end menu

@node PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2,ACORDO DE LICENCIAMENTO DA BEOPEN COM PARA PYTHON 2 0,,Termos e condições para acessar ou usar Python
@anchor{license psf-license}@anchor{5600}@anchor{license python-software-foundation-license-version-2}@anchor{5601}
@subsection PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2


@example
1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
   the Individual or Organization ("Licensee") accessing and otherwise using this
   software ("Python") 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 alone or in any derivative
   version, provided, however, that PSF's License Agreement and PSF's notice of
   copyright, i.e., "Copyright © 2001-2024 Python Software Foundation; All Rights
   Reserved" are retained in Python 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 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.

4. PSF is making Python 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 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, 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, Licensee agrees
   to be bound by the terms and conditions of this License Agreement.
@end example

@node ACORDO DE LICENCIAMENTO DA BEOPEN COM PARA PYTHON 2 0,CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1 6 1,PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2,Termos e condições para acessar ou usar Python
@anchor{license beopen-com-license-agreement-for-python-2-0}@anchor{5602}
@subsection ACORDO DE LICENCIAMENTO DA BEOPEN.COM PARA PYTHON 2.0


ACORDO DE LICENCIAMENTO DA BEOPEN DE FONTE ABERTA DO PYTHON VERSÃO 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 CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1 6 1,ACORDO DE LICENÇA DA CWI PARA PYTHON 0 9 0 A 1 2,ACORDO DE LICENCIAMENTO DA BEOPEN COM PARA PYTHON 2 0,Termos e condições para acessar ou usar Python
@anchor{license cnri-license-agreement-for-python-1-6-1}@anchor{5603}
@subsection CONTRATO DE LICENÇA DA CNRI PARA O 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 ACORDO DE LICENÇA DA CWI PARA PYTHON 0 9 0 A 1 2,ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION,CONTRATO DE LICENÇA DA CNRI PARA O PYTHON 1 6 1,Termos e condições para acessar ou usar Python
@anchor{license cwi-license-agreement-for-python-0-9-0-through-1-2}@anchor{5604}
@subsection ACORDO DE LICENÇA DA CWI PARA PYTHON 0.9.0 A 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 ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION,,ACORDO DE LICENÇA DA CWI PARA PYTHON 0 9 0 A 1 2,Termos e condições para acessar ou usar Python
@anchor{license bsd0}@anchor{55fe}@anchor{license zero-clause-bsd-license-for-code-in-the-python-documentation}@anchor{5605}
@subsection ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION


@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 Licenças e Reconhecimentos para Software Incorporado,,Termos e condições para acessar ou usar Python,História e Licença
@anchor{license licenses-and-acknowledgements-for-incorporated-software}@anchor{5606}@anchor{license otherlicenses}@anchor{55ff}
@section Licenças e Reconhecimentos para Software Incorporado


Esta seção é uma lista incompleta, mas crescente, de licenças e reconhecimentos para softwares de terceiros incorporados na distribuição do Python.

@menu
* Mersenne Twister:: 
* Soquetes: Soquetes<2>. 
* Serviços de soquete assíncrono:: 
* Gerenciamento de cookies:: 
* Rastreamento de execução:: 
* Funções UUencode e UUdecode:: 
* Chamadas de procedimento remoto XML:: 
* test_epoll:: 
* kqueue de seleção:: 
* SipHash24:: 
* strtod e dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<3>. 
* cfuhash:: 
* libmpdec:: 
* Conjunto de testes C14N do W3C:: 
* mimalloc:: 
* asyncio: asyncio<12>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 

@end menu

@node Mersenne Twister,Soquetes<2>,,Licenças e Reconhecimentos para Software Incorporado
@anchor{license mersenne-twister}@anchor{5607}
@subsection Mersenne Twister


A extensão C @code{_random} subjacente ao módulo @ref{b8,,random} inclui código baseado em um download de @indicateurl{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html}. A seguir estão os comentários literais do 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 Soquetes<2>,Serviços de soquete assíncrono,Mersenne Twister,Licenças e Reconhecimentos para Software Incorporado
@anchor{license sockets}@anchor{5608}
@subsection Soquetes


O módulo @ref{cc,,socket} usa as funções @code{getaddrinfo()} e @code{getnameinfo()}, que são codificadas em arquivos de origem separados do Projeto WIDE, @indicateurl{https://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 "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 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 Serviços de soquete assíncrono,Gerenciamento de cookies,Soquetes<2>,Licenças e Reconhecimentos para Software Incorporado
@anchor{license asynchronous-socket-services}@anchor{5609}
@subsection Serviços de soquete assíncrono


Os módulos @code{test.support.asynchat} e @code{test.support.asyncore} contêm o seguinte 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 Gerenciamento de cookies,Rastreamento de execução,Serviços de soquete assíncrono,Licenças e Reconhecimentos para Software Incorporado
@anchor{license cookie-management}@anchor{560a}
@subsection Gerenciamento de cookies


O módulo @ref{71,,http.cookies} contém o seguinte 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 Rastreamento de execução,Funções UUencode e UUdecode,Gerenciamento de cookies,Licenças e Reconhecimentos para Software Incorporado
@anchor{license execution-tracing}@anchor{560b}
@subsection Rastreamento de execução


O módulo @ref{fd,,trace} contém o seguinte 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 Funções UUencode e UUdecode,Chamadas de procedimento remoto XML,Rastreamento de execução,Licenças e Reconhecimentos para Software Incorporado
@anchor{license uuencode-and-uudecode-functions}@anchor{560c}
@subsection Funções UUencode e UUdecode


O codec @code{uu} contém o seguinte aviso:

@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 Chamadas de procedimento remoto XML,test_epoll,Funções UUencode e UUdecode,Licenças e Reconhecimentos para Software Incorporado
@anchor{license xml-remote-procedure-calls}@anchor{560d}
@subsection Chamadas de procedimento remoto XML


O módulo @ref{12e,,xmlrpc.client} contém o seguinte 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,kqueue de seleção,Chamadas de procedimento remoto XML,Licenças e Reconhecimentos para Software Incorporado
@anchor{license test-epoll}@anchor{560e}
@subsection test_epoll


O módulo @code{test.test_epoll} contém o seguinte 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 kqueue de seleção,SipHash24,test_epoll,Licenças e Reconhecimentos para Software Incorporado
@anchor{license select-kqueue}@anchor{560f}
@subsection kqueue de seleção


O módulo @ref{c1,,select} contém o seguinte aviso para a interface do 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 "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 SipHash24,strtod e dtoa,kqueue de seleção,Licenças e Reconhecimentos para Software Incorporado
@anchor{license siphash24}@anchor{5610}
@subsection SipHash24


O arquivo @code{Python/pyhash.c} contém a implementação de Marek Majkowski do algoritmo SipHash24 de Dan Bernstein. Contém a seguinte 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 e dtoa,OpenSSL<2>,SipHash24,Licenças e Reconhecimentos para Software Incorporado
@anchor{license strtod-and-dtoa}@anchor{5611}
@subsection strtod e dtoa


O arquivo @code{Python/dtoa.c}, que fornece as funções C dtoa e strtod para conversão de duplas de C para e de strings, é derivado do arquivo com o mesmo nome de David M. Gay, atualmente disponível em @indicateurl{https://web.archive.org/web/20220517033456/http://www.netlib.org/fp/dtoa.c}. O arquivo original, conforme recuperado em 16 de março de 2009, contém os seguintes avisos de direitos autorais e de licenciamento:

@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 e dtoa,Licenças e Reconhecimentos para Software Incorporado
@anchor{license openssl}@anchor{5612}
@subsection OpenSSL


Os módulos @ref{68,,hashlib}, @ref{ad,,posix} e @ref{d0,,ssl} usam a biblioteca OpenSSL para desempenho adicional se forem disponibilizados pelo sistema operacional. Além disso, os instaladores do Windows e do Mac OS X para Python podem incluir uma cópia das bibliotecas do OpenSSL, portanto incluímos uma cópia da licença do OpenSSL aqui: Para o lançamento do OpenSSL 3.0, e lançamentos posteriores derivados deste, se aplica a Apache License v2:

@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>,Licenças e Reconhecimentos para Software Incorporado
@anchor{license expat}@anchor{5613}
@subsection expat


A extensão @ref{126,,pyexpat} é construída usando uma cópia incluída das fontes de expatriadas, a menos que a compilação esteja 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,Licenças e Reconhecimentos para Software Incorporado
@anchor{license libffi}@anchor{5614}
@subsection libffi


A extensão C @code{_ctypes} subjacente ao módulo @ref{2a,,ctypes} é construída usando uma cópia incluída das fontes do libffi, a menos que a construção esteja configurada com @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
"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 zlib<3>,cfuhash,libffi,Licenças e Reconhecimentos para Software Incorporado
@anchor{license zlib}@anchor{5615}
@subsection zlib


A extensão @ref{133,,zlib} é construída usando uma cópia incluída das fontes zlib se a versão do zlib encontrada no sistema for muito antiga para ser usada na construção:

@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>,Licenças e Reconhecimentos para Software Incorporado
@anchor{license cfuhash}@anchor{5616}
@subsection cfuhash


A implementação da tabela de hash usada pelo @ref{ff,,tracemalloc} é baseada no projeto 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 testes C14N do W3C,cfuhash,Licenças e Reconhecimentos para Software Incorporado
@anchor{license libmpdec}@anchor{5617}
@subsection libmpdec


A extensão C @code{_decimal} subjacente ao módulo @ref{36,,decimal} é construída usando uma cópia incluída da biblioteca libmpdec, a menos que a construção esteja configurada com @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 testes C14N do W3C,mimalloc,libmpdec,Licenças e Reconhecimentos para Software Incorporado
@anchor{license w3c-c14n-test-suite}@anchor{5618}
@subsection Conjunto de testes C14N do W3C


O conjunto de testes C14N 2.0 no pacote @ref{e2,,test} (@code{Lib/test/xmltestdata/c14n-20/}) foi recuperado do site do W3C em @indicateurl{https://www.w3.org/TR/xml-c14n2-testcases/} e é distribuído sob a licença 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 testes C14N do W3C,Licenças e Reconhecimentos para Software Incorporado
@anchor{license mimalloc}@anchor{5619}@anchor{license mimalloc-license}@anchor{411}
@subsection mimalloc


Licença MIT:

@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,Licenças e Reconhecimentos para Software Incorporado
@anchor{license asyncio}@anchor{561a}
@subsection asyncio


Partes do módulo @ref{a,,asyncio} são incorporadas do uvloop 0.16@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0}, que é distribuído sob a licença MIT:

@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>,Licenças e Reconhecimentos para Software Incorporado
@anchor{license global-unbounded-sequences-gus}@anchor{561b}
@subsection Global Unbounded Sequences (GUS)


O arquivo @code{Python/qsbr.c} é adaptado do esquema de recuperação de memória segura “Global Unbounded Sequences” do FreeBSD em subr_smr.c@footnote{https://github.com/freebsd/freebsd-src/blob/main/sys/kern/subr_smr.c}. O arquivo é distribuído sob a licença BSD de 2 cláusulas:

@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 "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 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,História e Licença,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.
* argparse: 6. Command-line option and argument parsing library.
* array: 7. Space efficient arrays of uniformly typed numeric
                        values.
* ast: 8. Abstract Syntax Tree classes and manipulation.
* asynchat: 9. Removed in 3.12.
* asyncio: a. Asynchronous I/O.
* asyncore: b. Removed in 3.12.
* atexit: c. Register and execute cleanup functions.
* audioop: d. Removed in 3.13.
* base64: e. RFC 4648: Base16@comma{} Base32@comma{} Base64 Data
                        Encodings; Base85 and Ascii85
* bdb: f. Debugger framework.
* binascii: 10. Tools for converting between binary and various ASCII-
                        encoded binary representations.
* bisect: 11. Array bisection algorithms for binary searching.
* builtins: 12. The module that provides the built-in namespace.
* bz2: 13. Interfaces for bzip2 compression and decompression.
* calendar: 14. Functions for working with calendars@comma{} including
                        some emulation of the Unix cal program.
* cgi: 15. Removed in 3.13.
* cgitb: 16. Removed in 3.13.
* chunk: 17. Removed in 3.13.
* cmath: 18. Mathematical functions for complex numbers.
* cmd: 19. Build line-oriented command interpreters.
* code: 1a. Facilities to implement read-eval-print loops.
* codecs: 1b. Encode and decode data and streams.
* codeop: 1c. Compile (possibly incomplete) Python code.
* collections: 1d. Container datatypes
* collections.abc: 1e. Abstract base classes for containers
* colorsys: 1f. Conversion functions between RGB and other color
                        systems.
* compileall: 20. Tools for byte-compiling all Python source files in a
                        directory tree.
* concurrent.futures: 21. Execute computations concurrently using threads or
                        processes.
* configparser: 22. Configuration file parser.
* contextlib: 23. Utilities for with-statement contexts.
* contextvars: 24. Context Variables
* copy: 25. Shallow and deep copy operations.
* copyreg: 26. Register pickle support functions.
* cProfile: 27. 
* crypt: 28. Removed in 3.13.
* csv: 29. Write and read tabular data to and from delimited
                        files.
* ctypes: 2a. A foreign function library for Python.
* curses: 2b. An interface to the curses library@comma{} providing
                        portable terminal handling.
* curses.ascii: 2c. Constants and set-membership functions for ASCII
                        characters.
* curses.panel: 2d. A panel stack extension that adds depth to curses
                        windows.
* curses.textpad: 2e. Emacs-like input editing in a curses window.
* dataclasses: 2f. Generate special methods on user-defined classes.
* datetime: 30. Basic date and time types.
* dbm: 31. Interfaces to various Unix "database" formats.
* dbm.dumb: 32. Portable implementation of the simple DBM interface.
* dbm.gnu: 33. GNU database manager
* dbm.ndbm: 34. The New Database Manager
* dbm.sqlite3: 35. SQLite backend for dbm
* decimal: 36. Implementation of the General Decimal Arithmetic
                        Specification.
* difflib: 37. Helpers for computing differences between objects.
* dis: 38. Disassembler for Python bytecode.
* distutils: 39. Removed in 3.12.
* doctest: 3a. Test pieces of code within docstrings.
* email: 3b. Package supporting the parsing@comma{}
                        manipulating@comma{} and generating email messages.
* email.charset: 3c. Character Sets
* email.contentmanager: 3d. Storing and Retrieving Content from MIME Parts
* email.encoders: 3e. Encoders for email message payloads.
* email.errors: 3f. The exception classes used by the email package.
* email.generator: 40. Generate flat text email messages from a message
                        structure.
* email.header: 41. Representing non-ASCII headers
* email.headerregistry: 42. Automatic Parsing of headers based on the field name
* email.iterators: 43. Iterate over a message object tree.
* email.message: 44. The base class representing email messages.
* email.mime: 45. Build MIME messages.
* email.mime.application: 46. 
* email.mime.audio: 47. 
* email.mime.base: 48. 
* email.mime.image: 49. 
* email.mime.message: 4a. 
* email.mime.multipart: 4b. 
* email.mime.nonmultipart: 4c. 
* email.mime.text: 4d. 
* email.parser: 4e. Parse flat text email messages to produce a message
                        object structure.
* email.policy: 4f. Controlling the parsing and generating of messages
* email.utils: 50. Miscellaneous email package utilities.
* encodings: 51. Encodings package
* 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 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 4122
* 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: 12d. Server and client modules implementing XML-RPC.
* xmlrpc.client: 12e. XML-RPC client access.
* xmlrpc.server: 12f. Basic XML-RPC server implementations.
* zipapp: 130. Manage executable Python zip archives
* zipfile: 131. Read and write ZIP-format archive files.
* zipimport: 132. Support for importing Python modules from ZIP
                        archives.
* zlib: 133. Low-level interface to compression and decompression
                        routines compatible with gzip.
* zoneinfo: 134. IANA time zone support
@end menu


@node Índice,,Índice de Módulos Python,Top
@unnumbered Índice


@printindex ge

@anchor{howto/urllib2 quick-reference-to-http-headers}@w{                              }
@anchor{140a}@w{                              }
@anchor{library/stdtypes list clear}@w{                              }
@anchor{35d}@w{                              }
@anchor{17dd}@w{                              }
@anchor{library/stdtypes list remove}@w{                              }
@anchor{137b}@w{                              }
@anchor{1409}@w{                              }
@anchor{11d7}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_1}@w{                              }
@anchor{440c}@w{                              }
@anchor{library/stdtypes tuple count}@w{                              }
@anchor{library/stdtypes tuple index}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_file_0}@w{                              }
@anchor{4404}@w{                              }
@anchor{library/time audit_event_time_sleep_0}@w{                              }
@anchor{library/stdtypes list append}@w{                              }
@anchor{6cd}@w{                              }
@anchor{4402}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_0}@w{                              }
@anchor{library/stdtypes list extend}@w{                              }
@anchor{5452}@w{                              }
@anchor{library/asyncio audit_event_cpython_run_stdin_2}@w{                              }
@anchor{library/stdtypes list pop}@w{                              }
@anchor{library/unittest unittest tearDownModule}@w{                              }
@anchor{43fe}@w{                              }
@anchor{4403}@w{                              }
@anchor{library/stdtypes list insert}@w{                              }
@anchor{4401}@w{                              }
@anchor{35e}@w{                              }
@anchor{library/_thread start_new_thread}@w{                              }
@anchor{1dc3}@w{                              }

@c %**end of body
@bye
